From 75593521cbc7fe1979f464317cc80692c639e81e Mon Sep 17 00:00:00 2001 From: sbiscigl Date: Fri, 31 Jul 2026 14:25:24 -0400 Subject: [PATCH] fix unreleased services --- .../BCMPricingCalculatorClient.h | 6 +- .../BCMPricingCalculatorErrorMarshaller.h | 2 +- .../BCMPricingCalculatorRequest.h | 1 + .../model/AddReservedInstanceAction.h | 22 +- .../model/AddSavingsPlanAction.h | 14 +- ...eBillScenarioCommitmentModificationEntry.h | 16 +- ...eBillScenarioCommitmentModificationError.h | 16 +- ...teBillScenarioCommitmentModificationItem.h | 16 +- ...BillScenarioCommitmentModificationResult.h | 12 +- ...CreateBillScenarioUsageModificationEntry.h | 15 +- ...CreateBillScenarioUsageModificationError.h | 15 +- ...hCreateBillScenarioUsageModificationItem.h | 15 +- ...reateBillScenarioUsageModificationResult.h | 12 +- .../BatchCreateWorkloadEstimateUsageEntry.h | 15 +- .../BatchCreateWorkloadEstimateUsageError.h | 15 +- .../BatchCreateWorkloadEstimateUsageItem.h | 14 +- .../BatchCreateWorkloadEstimateUsageResult.h | 12 +- ...eBillScenarioCommitmentModificationError.h | 16 +- ...BillScenarioCommitmentModificationResult.h | 12 +- ...DeleteBillScenarioUsageModificationError.h | 15 +- ...eleteBillScenarioUsageModificationResult.h | 12 +- .../BatchDeleteWorkloadEstimateUsageError.h | 15 +- .../BatchDeleteWorkloadEstimateUsageResult.h | 12 +- ...eBillScenarioCommitmentModificationEntry.h | 16 +- ...eBillScenarioCommitmentModificationError.h | 16 +- ...BillScenarioCommitmentModificationResult.h | 12 +- ...UpdateBillScenarioUsageModificationEntry.h | 15 +- ...UpdateBillScenarioUsageModificationError.h | 15 +- ...pdateBillScenarioUsageModificationResult.h | 12 +- .../BatchUpdateWorkloadEstimateUsageEntry.h | 15 +- .../BatchUpdateWorkloadEstimateUsageError.h | 15 +- .../BatchUpdateWorkloadEstimateUsageResult.h | 12 +- .../model/BillEstimateCommitmentSummary.h | 14 +- .../model/BillEstimateCostSummary.h | 14 +- ...timateInputCommitmentModificationSummary.h | 15 +- ...illEstimateInputUsageModificationSummary.h | 15 +- .../model/BillEstimateLineItemSummary.h | 14 +- .../model/BillEstimateSummary.h | 14 +- .../model/BillInterval.h | 14 +- ...BillScenarioCommitmentModificationAction.h | 15 +- .../BillScenarioCommitmentModificationItem.h | 15 +- .../model/BillScenarioSummary.h | 14 +- .../model/BillScenarioUsageModificationItem.h | 14 +- .../model/ConflictException.h | 14 +- .../bcm-pricing-calculator/model/CostAmount.h | 14 +- .../model/CostDifference.h | 14 +- .../model/CreateBillEstimateResult.h | 12 +- .../model/CreateBillScenarioResult.h | 12 +- .../model/CreateWorkloadEstimateResult.h | 12 +- .../model/DeleteBillEstimateResult.h | 12 +- .../model/DeleteBillScenarioResult.h | 12 +- .../model/DeleteWorkloadEstimateResult.h | 12 +- .../bcm-pricing-calculator/model/Expression.h | 14 +- .../model/ExpressionFilter.h | 14 +- .../model/FilterTimestamp.h | 14 +- .../model/GetBillEstimateResult.h | 12 +- .../model/GetBillScenarioResult.h | 12 +- .../model/GetPreferencesResult.h | 12 +- .../model/GetWorkloadEstimateResult.h | 12 +- .../model/HistoricalUsageEntity.h | 14 +- .../model/InternalServerException.h | 22 +- .../model/ListBillEstimateCommitmentsResult.h | 12 +- ...timateInputCommitmentModificationsResult.h | 12 +- ...illEstimateInputUsageModificationsResult.h | 12 +- .../model/ListBillEstimateLineItemsFilter.h | 14 +- .../model/ListBillEstimateLineItemsResult.h | 12 +- .../model/ListBillEstimatesFilter.h | 14 +- .../model/ListBillEstimatesResult.h | 12 +- ...illScenarioCommitmentModificationsResult.h | 12 +- ...ListBillScenarioUsageModificationsResult.h | 12 +- .../model/ListBillScenariosFilter.h | 14 +- .../model/ListBillScenariosResult.h | 12 +- .../model/ListTagsForResourceResult.h | 12 +- .../model/ListUsageFilter.h | 14 +- .../model/ListWorkloadEstimateUsageResult.h | 12 +- .../model/ListWorkloadEstimatesFilter.h | 14 +- .../model/ListWorkloadEstimatesResult.h | 12 +- .../model/NegateReservedInstanceAction.h | 14 +- .../model/NegateSavingsPlanAction.h | 14 +- .../model/ResourceNotFoundException.h | 14 +- .../model/ServiceQuotaExceededException.h | 14 +- .../model/TagResourceResult.h | 12 +- .../model/ThrottlingException.h | 22 +- .../model/UntagResourceResult.h | 12 +- .../model/UpdateBillEstimateResult.h | 12 +- .../model/UpdateBillScenarioResult.h | 12 +- .../model/UpdatePreferencesResult.h | 12 +- .../model/UpdateWorkloadEstimateResult.h | 12 +- .../model/UsageAmount.h | 14 +- .../model/UsageQuantity.h | 14 +- .../model/UsageQuantityResult.h | 14 +- .../model/ValidationException.h | 14 +- .../model/ValidationExceptionField.h | 14 +- .../model/WorkloadEstimateSummary.h | 14 +- .../model/WorkloadEstimateUsageItem.h | 14 +- .../model/WorkloadEstimateUsageQuantity.h | 14 +- .../source/BCMPricingCalculatorClient.cpp | 3 - .../source/BCMPricingCalculatorErrors.cpp | 45 +- .../model/AddReservedInstanceAction.cpp | 178 +- .../source/model/AddSavingsPlanAction.cpp | 158 +- ...illScenarioCommitmentModificationEntry.cpp | 294 +- ...illScenarioCommitmentModificationError.cpp | 242 +- ...BillScenarioCommitmentModificationItem.cpp | 362 +- ...lScenarioCommitmentModificationRequest.cpp | 44 +- ...llScenarioCommitmentModificationResult.cpp | 188 +- ...eateBillScenarioUsageModificationEntry.cpp | 640 +- ...eateBillScenarioUsageModificationError.cpp | 241 +- ...reateBillScenarioUsageModificationItem.cpp | 776 +- ...teBillScenarioUsageModificationRequest.cpp | 43 +- ...ateBillScenarioUsageModificationResult.cpp | 188 +- .../BatchCreateWorkloadEstimateUsageEntry.cpp | 521 +- .../BatchCreateWorkloadEstimateUsageError.cpp | 236 +- .../BatchCreateWorkloadEstimateUsageItem.cpp | 728 +- ...atchCreateWorkloadEstimateUsageRequest.cpp | 42 +- ...BatchCreateWorkloadEstimateUsageResult.cpp | 189 +- ...illScenarioCommitmentModificationError.cpp | 242 +- ...lScenarioCommitmentModificationRequest.cpp | 36 +- ...llScenarioCommitmentModificationResult.cpp | 123 +- ...leteBillScenarioUsageModificationError.cpp | 241 +- ...teBillScenarioUsageModificationRequest.cpp | 36 +- ...eteBillScenarioUsageModificationResult.cpp | 123 +- .../BatchDeleteWorkloadEstimateUsageError.cpp | 236 +- ...atchDeleteWorkloadEstimateUsageRequest.cpp | 36 +- ...BatchDeleteWorkloadEstimateUsageResult.cpp | 124 +- ...illScenarioCommitmentModificationEntry.cpp | 206 +- ...illScenarioCommitmentModificationError.cpp | 242 +- ...lScenarioCommitmentModificationRequest.cpp | 38 +- ...llScenarioCommitmentModificationResult.cpp | 188 +- ...dateBillScenarioUsageModificationEntry.cpp | 280 +- ...dateBillScenarioUsageModificationError.cpp | 241 +- ...teBillScenarioUsageModificationRequest.cpp | 37 +- ...ateBillScenarioUsageModificationResult.cpp | 188 +- .../BatchUpdateWorkloadEstimateUsageEntry.cpp | 231 +- .../BatchUpdateWorkloadEstimateUsageError.cpp | 236 +- ...atchUpdateWorkloadEstimateUsageRequest.cpp | 36 +- ...BatchUpdateWorkloadEstimateUsageResult.cpp | 189 +- .../model/BillEstimateCommitmentSummary.cpp | 541 +- .../source/model/BillEstimateCostSummary.cpp | 171 +- ...mateInputCommitmentModificationSummary.cpp | 294 +- ...lEstimateInputUsageModificationSummary.cpp | 708 +- .../model/BillEstimateLineItemSummary.cpp | 998 +- .../source/model/BillEstimateSummary.cpp | 358 +- .../source/model/BillInterval.cpp | 176 +- ...llScenarioCommitmentModificationAction.cpp | 144 +- ...BillScenarioCommitmentModificationItem.cpp | 294 +- .../source/model/BillScenarioSummary.cpp | 524 +- .../BillScenarioUsageModificationItem.cpp | 707 +- .../source/model/ConflictException.cpp | 272 +- .../source/model/CostAmount.cpp | 116 +- .../source/model/CostDifference.cpp | 102 +- .../model/CreateBillEstimateRequest.cpp | 49 +- .../source/model/CreateBillEstimateResult.cpp | 542 +- .../model/CreateBillScenarioRequest.cpp | 57 +- .../source/model/CreateBillScenarioResult.cpp | 478 +- .../model/CreateWorkloadEstimateRequest.cpp | 50 +- .../model/CreateWorkloadEstimateResult.cpp | 491 +- .../model/DeleteBillEstimateRequest.cpp | 23 +- .../source/model/DeleteBillEstimateResult.cpp | 14 +- .../model/DeleteBillScenarioRequest.cpp | 23 +- .../source/model/DeleteBillScenarioResult.cpp | 14 +- .../model/DeleteWorkloadEstimateRequest.cpp | 23 +- .../model/DeleteWorkloadEstimateResult.cpp | 15 +- .../source/model/Expression.cpp | 286 +- .../source/model/ExpressionFilter.cpp | 490 +- .../source/model/FilterTimestamp.cpp | 176 +- .../source/model/GetBillEstimateRequest.cpp | 23 +- .../source/model/GetBillEstimateResult.cpp | 540 +- .../source/model/GetBillScenarioRequest.cpp | 23 +- .../source/model/GetBillScenarioResult.cpp | 476 +- .../source/model/GetPreferencesRequest.cpp | 20 +- .../source/model/GetPreferencesResult.cpp | 310 +- .../model/GetWorkloadEstimateRequest.cpp | 23 +- .../model/GetWorkloadEstimateResult.cpp | 490 +- .../source/model/HistoricalUsageEntity.cpp | 444 +- .../source/model/InternalServerException.cpp | 178 +- .../ListBillEstimateCommitmentsRequest.cpp | 37 +- .../ListBillEstimateCommitmentsResult.cpp | 189 +- ...ateInputCommitmentModificationsRequest.cpp | 37 +- ...mateInputCommitmentModificationsResult.cpp | 187 +- ...EstimateInputUsageModificationsRequest.cpp | 48 +- ...lEstimateInputUsageModificationsResult.cpp | 187 +- .../model/ListBillEstimateLineItemsFilter.cpp | 299 +- .../ListBillEstimateLineItemsRequest.cpp | 48 +- .../model/ListBillEstimateLineItemsResult.cpp | 190 +- .../source/model/ListBillEstimatesFilter.cpp | 297 +- .../source/model/ListBillEstimatesRequest.cpp | 54 +- .../source/model/ListBillEstimatesResult.cpp | 187 +- ...ScenarioCommitmentModificationsRequest.cpp | 37 +- ...lScenarioCommitmentModificationsResult.cpp | 187 +- ...tBillScenarioUsageModificationsRequest.cpp | 48 +- ...stBillScenarioUsageModificationsResult.cpp | 188 +- .../source/model/ListBillScenariosFilter.cpp | 297 +- .../source/model/ListBillScenariosRequest.cpp | 54 +- .../source/model/ListBillScenariosResult.cpp | 187 +- .../model/ListTagsForResourceRequest.cpp | 23 +- .../model/ListTagsForResourceResult.cpp | 243 +- .../source/model/ListUsageFilter.cpp | 296 +- .../ListWorkloadEstimateUsageRequest.cpp | 48 +- .../model/ListWorkloadEstimateUsageResult.cpp | 190 +- .../model/ListWorkloadEstimatesFilter.cpp | 297 +- .../model/ListWorkloadEstimatesRequest.cpp | 54 +- .../model/ListWorkloadEstimatesResult.cpp | 190 +- .../model/NegateReservedInstanceAction.cpp | 132 +- .../source/model/NegateSavingsPlanAction.cpp | 132 +- .../model/ResourceNotFoundException.cpp | 272 +- .../model/ServiceQuotaExceededException.cpp | 410 +- .../source/model/TagResourceRequest.cpp | 37 +- .../source/model/TagResourceResult.cpp | 12 +- .../source/model/ThrottlingException.cpp | 316 +- .../source/model/UntagResourceRequest.cpp | 36 +- .../source/model/UntagResourceResult.cpp | 12 +- .../model/UpdateBillEstimateRequest.cpp | 38 +- .../source/model/UpdateBillEstimateResult.cpp | 542 +- .../model/UpdateBillScenarioRequest.cpp | 52 +- .../source/model/UpdateBillScenarioResult.cpp | 478 +- .../source/model/UpdatePreferencesRequest.cpp | 61 +- .../source/model/UpdatePreferencesResult.cpp | 310 +- .../model/UpdateWorkloadEstimateRequest.cpp | 38 +- .../model/UpdateWorkloadEstimateResult.cpp | 491 +- .../source/model/UsageAmount.cpp | 145 +- .../source/model/UsageQuantity.cpp | 215 +- .../source/model/UsageQuantityResult.cpp | 158 +- .../source/model/ValidationException.cpp | 235 +- .../source/model/ValidationExceptionField.cpp | 202 +- .../source/model/WorkloadEstimateSummary.cpp | 540 +- .../model/WorkloadEstimateUsageItem.cpp | 657 +- .../model/WorkloadEstimateUsageQuantity.cpp | 160 +- .../BCMRecommendedActionsClient.h | 6 +- .../BCMRecommendedActionsErrorMarshaller.h | 2 +- .../BCMRecommendedActionsRequest.h | 1 + .../model/ActionFilter.h | 14 +- .../model/ListRecommendedActionsResult.h | 12 +- .../model/RecommendedAction.h | 14 +- .../model/RequestFilter.h | 14 +- .../model/ValidationException.h | 14 +- .../model/ValidationExceptionField.h | 14 +- .../source/BCMRecommendedActionsClient.cpp | 3 - .../source/BCMRecommendedActionsErrors.cpp | 10 +- .../source/model/ActionFilter.cpp | 296 +- .../model/ListRecommendedActionsRequest.cpp | 37 +- .../model/ListRecommendedActionsResult.cpp | 191 +- .../source/model/RecommendedAction.cpp | 720 +- .../source/model/RequestFilter.cpp | 136 +- .../source/model/ValidationException.cpp | 235 +- .../source/model/ValidationExceptionField.cpp | 202 +- .../model/EvaluatorModelConfig.h | 22 + .../model/OpenResponsesEvaluatorModelConfig.h | 143 + .../model/ReasoningConfiguration.h | 60 + .../source/model/EvaluatorModelConfig.cpp | 8 + .../OpenResponsesEvaluatorModelConfig.cpp | 72 + .../source/model/ReasoningConfiguration.cpp | 40 + .../include/aws/iam/IAMClient.h | 28 +- .../include/aws/iam/model/AttachmentType.h | 22 + .../include/aws/iam/model/EvaluationResult.h | 58 +- .../iam/model/InlinePolicyIdentifierType.h | 108 + .../iam/model/OrderedOrganizationPolicyType.h | 76 + .../include/aws/iam/model/PolicyIdentifier.h | 117 + .../iam/model/PolicyIdentifierPolicyType.h | 22 + .../iam/model/SimulateCustomPolicyRequest.h | 49 +- .../model/SimulatePrincipalPolicyRequest.h | 69 +- .../source/model/AttachmentType.cpp | 63 + .../model/InlinePolicyIdentifierType.cpp | 78 + .../model/OrderedOrganizationPolicyType.cpp | 65 + .../source/model/PolicyIdentifier.cpp | 81 + .../model/PolicyIdentifierPolicyType.cpp | 78 + .../model/SimulateCustomPolicyRequest.cpp | 12 + .../model/SimulatePrincipalPolicyRequest.cpp | 12 + .../include/aws/kafka/KafkaClient.h | 131 + .../aws/kafka/KafkaServiceClientModel.h | 35 + .../include/aws/kafka/model/Catalog.h | 83 + .../aws/kafka/model/ChannelDestinationType.h | 22 + .../include/aws/kafka/model/ChannelInfo.h | 169 + .../aws/kafka/model/ChannelLoggingInfo.h | 104 + .../aws/kafka/model/ChannelStateInfo.h | 80 + .../include/aws/kafka/model/ChannelStatus.h | 22 + .../aws/kafka/model/CreateChannelRequest.h | 231 + .../aws/kafka/model/CreateChannelResult.h | 106 + .../aws/kafka/model/DeadLetterQueueS3.h | 102 + .../aws/kafka/model/DeleteChannelRequest.h | 82 + .../aws/kafka/model/DeleteChannelResult.h | 106 + .../aws/kafka/model/DescribeChannelRequest.h | 82 + .../aws/kafka/model/DescribeChannelResult.h | 346 + .../aws/kafka/model/DestinationTable.h | 103 + .../aws/kafka/model/EncryptionConfiguration.h | 60 + .../aws/kafka/model/IcebergCompressionType.h | 22 + .../model/IcebergDestinationConfiguration.h | 243 + .../kafka/model/IcebergDestinationUpdate.h | 55 + .../aws/kafka/model/ListChannelsRequest.h | 134 + .../aws/kafka/model/ListChannelsResult.h | 109 + .../include/aws/kafka/model/PartitionSource.h | 61 + .../include/aws/kafka/model/PartitionSpec.h | 87 + .../aws/kafka/model/PartitionStrategy.h | 22 + .../include/aws/kafka/model/RecordConverter.h | 57 + .../include/aws/kafka/model/RecordSchema.h | 60 + .../aws/kafka/model/S3CompressionType.h | 22 + .../kafka/model/S3DestinationConfiguration.h | 125 + .../aws/kafka/model/S3DestinationUpdate.h | 54 + .../include/aws/kafka/model/S3Storage.h | 165 + .../include/aws/kafka/model/S3StorageClass.h | 22 + .../include/aws/kafka/model/SchemaEvolution.h | 55 + .../include/aws/kafka/model/TableCreation.h | 55 + .../aws/kafka/model/TopicConfiguration.h | 108 + .../aws/kafka/model/UpdateChannelRequest.h | 127 + .../aws/kafka/model/UpdateChannelResult.h | 103 + .../include/aws/kafka/model/ValueConverter.h | 22 + .../aws-cpp-sdk-kafka/source/KafkaClient.cpp | 114 + .../source/model/Catalog.cpp | 48 + .../source/model/ChannelDestinationType.cpp | 58 + .../source/model/ChannelInfo.cpp | 80 + .../source/model/ChannelLoggingInfo.cpp | 56 + .../source/model/ChannelStateInfo.cpp | 48 + .../source/model/ChannelStatus.cpp | 83 + .../source/model/CreateChannelRequest.cpp | 56 + .../source/model/CreateChannelResult.cpp | 42 + .../source/model/DeadLetterQueueS3.cpp | 56 + .../source/model/DeleteChannelRequest.cpp | 15 + .../source/model/DeleteChannelResult.cpp | 42 + .../source/model/DescribeChannelRequest.cpp | 15 + .../source/model/DescribeChannelResult.cpp | 93 + .../source/model/DestinationTable.cpp | 56 + .../source/model/EncryptionConfiguration.cpp | 40 + .../source/model/IcebergCompressionType.cpp | 58 + .../model/IcebergDestinationConfiguration.cpp | 113 + .../source/model/IcebergDestinationUpdate.cpp | 40 + .../source/model/ListChannelsRequest.cpp | 39 + .../source/model/ListChannelsResult.cpp | 45 + .../source/model/PartitionSource.cpp | 40 + .../source/model/PartitionSpec.cpp | 55 + .../source/model/PartitionStrategy.cpp | 53 + .../source/model/RecordConverter.cpp | 40 + .../source/model/RecordSchema.cpp | 40 + .../source/model/S3CompressionType.cpp | 63 + .../model/S3DestinationConfiguration.cpp | 64 + .../source/model/S3DestinationUpdate.cpp | 40 + .../source/model/S3Storage.cpp | 80 + .../source/model/S3StorageClass.cpp | 63 + .../source/model/SchemaEvolution.cpp | 40 + .../source/model/TableCreation.cpp | 40 + .../source/model/TopicConfiguration.cpp | 56 + .../source/model/UpdateChannelRequest.cpp | 27 + .../source/model/UpdateChannelResult.cpp | 42 + .../source/model/ValueConverter.cpp | 68 + .../include/aws/lambda/model/FunctionCode.h | 8 +- .../lambda/model/FunctionCodeLocationError.h | 10 +- .../lambda/model/LayerVersionContentInput.h | 7 +- .../lambda/model/LayerVersionContentOutput.h | 4 +- .../include/aws/lambda/model/Runtime.h | 2 + .../lambda/model/UpdateFunctionCodeRequest.h | 8 +- .../source/model/Runtime.cpp | 10 + .../CMakeLists.txt | 82 + .../PricingPlanManagerClient.h | 385 + .../PricingPlanManagerClientPagination.h | 19 + .../PricingPlanManagerEndpointProvider.h | 52 + .../PricingPlanManagerErrorMarshaller.h | 20 + .../PricingPlanManagerErrors.h | 71 + .../PricingPlanManagerPaginationBase.h | 33 + .../PricingPlanManagerRequest.h | 39 + .../PricingPlanManagerServiceClientModel.h | 136 + .../PricingPlanManagerWaiter.h | 21 + .../PricingPlanManager_EXPORTS.h | 38 + .../PricingPlanManagerEndpointRules.h | 21 + .../pricing-plan-manager/model/ApprovalMode.h | 22 + .../model/ApprovePaidSubscriptionRequest.h | 103 + .../model/ApprovePaidSubscriptionResult.h | 96 + .../AssociateResourcesToSubscriptionRequest.h | 130 + .../AssociateResourcesToSubscriptionResult.h | 96 + .../model/CancelSubscriptionChangeRequest.h | 102 + .../model/CancelSubscriptionChangeResult.h | 96 + .../model/CancelSubscriptionRequest.h | 102 + .../model/CancelSubscriptionResult.h | 97 + .../model/ConflictException.h | 80 + .../model/CreateSubscriptionRequest.h | 180 + .../model/CreateSubscriptionResult.h | 96 + ...ssociateResourcesFromSubscriptionRequest.h | 132 + ...associateResourcesFromSubscriptionResult.h | 97 + .../model/GetSubscriptionRequest.h | 55 + .../model/GetSubscriptionResult.h | 96 + .../model/ListSubscriptionsPaginationTraits.h | 32 + .../model/ListSubscriptionsRequest.h | 57 + .../model/ListSubscriptionsResult.h | 104 + .../model/ResourceNotFoundException.h | 78 + .../model/ScheduledChange.h | 127 + .../model/ScheduledChangeType.h | 22 + .../aws/pricing-plan-manager/model/Status.h | 22 + .../pricing-plan-manager/model/Subscription.h | 265 + .../model/SubscriptionSummary.h | 283 + .../model/UpdateSubscriptionRequest.h | 146 + .../model/UpdateSubscriptionResult.h | 97 + .../model/ValidationException.h | 80 + .../source/PricingPlanManagerClient.cpp | 326 + .../PricingPlanManagerEndpointProvider.cpp | 18 + .../PricingPlanManagerEndpointRules.cpp | 53 + .../PricingPlanManagerErrorMarshaller.cpp | 20 + .../source/PricingPlanManagerErrors.cpp | 59 + .../source/PricingPlanManagerRequest.cpp | 10 + .../source/model/ApprovalMode.cpp | 58 + .../model/ApprovePaidSubscriptionRequest.cpp | 40 + .../model/ApprovePaidSubscriptionResult.cpp | 42 + ...ssociateResourcesToSubscriptionRequest.cpp | 48 + ...AssociateResourcesToSubscriptionResult.cpp | 45 + .../model/CancelSubscriptionChangeRequest.cpp | 40 + .../model/CancelSubscriptionChangeResult.cpp | 42 + .../model/CancelSubscriptionRequest.cpp | 40 + .../source/model/CancelSubscriptionResult.cpp | 42 + .../source/model/ConflictException.cpp | 48 + .../model/CreateSubscriptionRequest.cpp | 47 + .../source/model/CreateSubscriptionResult.cpp | 42 + ...ociateResourcesFromSubscriptionRequest.cpp | 48 + ...sociateResourcesFromSubscriptionResult.cpp | 46 + .../source/model/GetSubscriptionRequest.cpp | 23 + .../source/model/GetSubscriptionResult.cpp | 42 + .../source/model/ListSubscriptionsRequest.cpp | 23 + .../source/model/ListSubscriptionsResult.cpp | 46 + .../model/ResourceNotFoundException.cpp | 48 + .../source/model/ScheduledChange.cpp | 64 + .../source/model/ScheduledChangeType.cpp | 58 + .../source/model/Status.cpp | 68 + .../source/model/Subscription.cpp | 119 + .../source/model/SubscriptionSummary.cpp | 127 + .../model/UpdateSubscriptionRequest.cpp | 48 + .../source/model/UpdateSubscriptionResult.cpp | 42 + .../source/model/ValidationException.cpp | 48 + .../model/AIRecommendationAdapterDetails.h | 6 +- .../AIRecommendationDeploymentConfiguration.h | 8 +- .../aws/sagemaker/model/AppInstanceType.h | 6 + .../model/CreateOptimizationJobRequest.h | 8 +- .../model/DescribeAIRecommendationJobResult.h | 4 +- .../source/model/AppInstanceType.cpp | 42 + .../model/IntegratedRepository.h | 21 + .../source/model/IntegratedRepository.cpp | 8 + .../BedrockAgentCoreControlIncludeTests.cpp | 2 + .../tests/iam-gen-tests/IAMIncludeTests.cpp | 5 + .../kafka-gen-tests/KafkaIncludeTests.cpp | 36 + .../CMakeLists.txt | 42 + ...ricingPlanManagerEndpointProviderTests.cpp | 251 + .../PricingPlanManagerIncludeTests.cpp | 55 + ...gPlanManagerPaginationCompilationTests.cpp | 23 + .../RunTests.cpp | 29 + ...-pricing-calculator-2024-06-19.normal.json | 36 +- .../2024-06-19/api-2.json | 2611 - .../2024-06-19/docs-2.json | 1666 - .../2024-06-19/endpoint-bdd-1.json | 118 - .../2024-06-19/endpoint-rule-set-1.json | 151 - .../2024-06-19/endpoint-tests-1.json | 153 - .../2024-06-19/examples-1.json | 4 - .../2024-06-19/paginators-1.json | 64 - .../2024-06-19/service-2.json | 4141 -- .../2024-06-19/smoke-2.json | 19 - .../2024-06-19/smoke.json | 6 - .../2024-06-19/waiters-2.json | 5 - ...recommended-actions-2024-11-14.normal.json | 20 +- .../2024-11-14/api-2.json | 257 - .../2024-11-14/docs-2.json | 175 - .../2024-11-14/endpoint-bdd-1.json | 118 - .../2024-11-14/endpoint-rule-set-1.json | 151 - .../2024-11-14/endpoint-tests-1.json | 153 - .../2024-11-14/examples-1.json | 4 - .../2024-11-14/paginators-1.json | 10 - .../2024-11-14/service-2.json | 330 - .../2024-11-14/smoke-2.json | 19 - .../2024-11-14/smoke.json | 6 - .../2024-11-14/waiters-2.json | 5 - ...k-agentcore-control-2023-06-05.normal.json | 63 + .../2023-06-05/api-2.json | 14969 ----- .../2023-06-05/docs-2.json | 8719 --- .../2023-06-05/endpoint-bdd-1.json | 188 - .../2023-06-05/endpoint-rule-set-1.json | 350 - .../2023-06-05/endpoint-tests-1.json | 270 - .../2023-06-05/examples-1.json | 4 - .../2023-06-05/paginators-1.json | 214 - .../2023-06-05/service-2.json | 22407 ------- .../2023-06-05/smoke.json | 6 - .../2023-06-05/waiters-2.json | 149 - .../custom-service-2017-11-03.normal.json | 232 - .../iam-2010-05-08.normal.json | 117 +- .../iam/2010-05-08/api-2.json | 7258 --- .../iam/2010-05-08/docs-2.json | 3809 -- .../iam/2010-05-08/endpoint-bdd-1.json | 544 - .../iam/2010-05-08/endpoint-rule-set-1.json | 1122 - .../iam/2010-05-08/endpoint-tests-1.json | 506 - .../iam/2010-05-08/examples-1.json | 1526 - .../iam/2010-05-08/paginators-1.json | 254 - .../iam/2010-05-08/resources-1.json | 1740 - .../iam/2010-05-08/service-2.json | 10366 ---- .../iam/2010-05-08/smoke-2.json | 29 - .../iam/2010-05-08/smoke.json | 18 - .../iam/2010-05-08/waiters-2.json | 73 - .../kafka-2018-11-14.normal.json | 1068 +- .../kafka/2018-11-14/api-2.json | 7975 --- .../kafka/2018-11-14/docs-2.json | 2086 - .../kafka/2018-11-14/endpoint-bdd-1.json | 266 - .../kafka/2018-11-14/endpoint-rule-set-1.json | 645 - .../kafka/2018-11-14/endpoint-tests-1.json | 330 - .../kafka/2018-11-14/examples-1.json | 224 - .../kafka/2018-11-14/paginators-1.json | 88 - .../kafka/2018-11-14/service-2.json | 9349 --- .../lambda-2015-03-31.normal.json | 24 +- .../lambda/2015-03-31/api-2.json | 7181 --- .../lambda/2015-03-31/docs-2.json | 3885 -- .../lambda/2015-03-31/endpoint-bdd-1.json | 188 - .../2015-03-31/endpoint-rule-set-1.json | 314 - .../lambda/2015-03-31/endpoint-tests-1.json | 920 - .../lambda/2015-03-31/examples-1.json | 1234 - .../lambda/2015-03-31/paginators-1.json | 100 - .../lambda/2015-03-31/service-2.json | 9943 --- .../lambda/2015-03-31/smoke-2.json | 34 - .../lambda/2015-03-31/waiters-2.json | 129 - .../network-firewall/2020-11-12/api-2.json | 4902 -- .../network-firewall/2020-11-12/docs-2.json | 3332 - .../2020-11-12/endpoint-bdd-1.json | 188 - .../2020-11-12/endpoint-rule-set-1.json | 314 - .../2020-11-12/endpoint-tests-1.json | 608 - .../2020-11-12/examples-1.json | 4 - .../2020-11-12/paginators-1.json | 88 - .../2020-11-12/service-2.json | 7783 --- ...icing-plan-manager-2025-08-05.normal.json} | 0 .../2025-08-05/api-2.json | 670 - .../2025-08-05/docs-2.json | 262 - .../2025-08-05/endpoint-bdd-1.json | 67 - .../2025-08-05/examples-1.json | 273 - .../2025-08-05/paginators-1.json | 9 - .../2025-08-05/smoke-2.json | 34 - .../sagemaker-2017-07-24.normal.json | 14 +- .../sagemaker/2017-07-24/api-2.json | 32462 ---------- .../sagemaker/2017-07-24/docs-2.json | 21576 ------- .../sagemaker/2017-07-24/endpoint-bdd-1.json | 227 - .../2017-07-24/endpoint-rule-set-1.json | 364 - .../2017-07-24/endpoint-tests-1.json | 608 - .../sagemaker/2017-07-24/examples-1.json | 4 - .../sagemaker/2017-07-24/paginators-1.json | 548 - .../sagemaker/2017-07-24/service-2.json | 51631 ---------------- .../sagemaker/2017-07-24/waiters-2.json | 260 - .../securityagent-2025-09-06.normal.json | 4 + .../securityagent/2025-09-06/api-2.json | 5456 -- .../securityagent/2025-09-06/docs-2.json | 3731 -- .../2025-09-06/endpoint-bdd-1.json | 104 - .../2025-09-06/endpoint-rule-set-1.json | 137 - .../2025-09-06/endpoint-tests-1.json | 105 - .../securityagent/2025-09-06/examples-1.json | 4 - .../2025-09-06/paginators-1.json | 136 - .../securityagent/2025-09-06/service-2.json | 9667 --- .../securityagent/2025-09-06/smoke-2.json | 17 - .../securityagent/2025-09-06/smoke.json | 6 - .../securityagent/2025-09-06/waiters-2.json | 5 - ...manager-2025-08-05.endpoint-rule-set.json} | 0 ...an-manager-2025-08-05.endpoint-tests.json} | 0 546 files changed, 18162 insertions(+), 303795 deletions(-) create mode 100644 generated/src/aws-cpp-sdk-bedrock-agentcore-control/include/aws/bedrock-agentcore-control/model/OpenResponsesEvaluatorModelConfig.h create mode 100644 generated/src/aws-cpp-sdk-bedrock-agentcore-control/include/aws/bedrock-agentcore-control/model/ReasoningConfiguration.h create mode 100644 generated/src/aws-cpp-sdk-bedrock-agentcore-control/source/model/OpenResponsesEvaluatorModelConfig.cpp create mode 100644 generated/src/aws-cpp-sdk-bedrock-agentcore-control/source/model/ReasoningConfiguration.cpp create mode 100644 generated/src/aws-cpp-sdk-iam/include/aws/iam/model/AttachmentType.h create mode 100644 generated/src/aws-cpp-sdk-iam/include/aws/iam/model/InlinePolicyIdentifierType.h create mode 100644 generated/src/aws-cpp-sdk-iam/include/aws/iam/model/OrderedOrganizationPolicyType.h create mode 100644 generated/src/aws-cpp-sdk-iam/include/aws/iam/model/PolicyIdentifier.h create mode 100644 generated/src/aws-cpp-sdk-iam/include/aws/iam/model/PolicyIdentifierPolicyType.h create mode 100644 generated/src/aws-cpp-sdk-iam/source/model/AttachmentType.cpp create mode 100644 generated/src/aws-cpp-sdk-iam/source/model/InlinePolicyIdentifierType.cpp create mode 100644 generated/src/aws-cpp-sdk-iam/source/model/OrderedOrganizationPolicyType.cpp create mode 100644 generated/src/aws-cpp-sdk-iam/source/model/PolicyIdentifier.cpp create mode 100644 generated/src/aws-cpp-sdk-iam/source/model/PolicyIdentifierPolicyType.cpp create mode 100644 generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/Catalog.h create mode 100644 generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/ChannelDestinationType.h create mode 100644 generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/ChannelInfo.h create mode 100644 generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/ChannelLoggingInfo.h create mode 100644 generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/ChannelStateInfo.h create mode 100644 generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/ChannelStatus.h create mode 100644 generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/CreateChannelRequest.h create mode 100644 generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/CreateChannelResult.h create mode 100644 generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/DeadLetterQueueS3.h create mode 100644 generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/DeleteChannelRequest.h create mode 100644 generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/DeleteChannelResult.h create mode 100644 generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/DescribeChannelRequest.h create mode 100644 generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/DescribeChannelResult.h create mode 100644 generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/DestinationTable.h create mode 100644 generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/EncryptionConfiguration.h create mode 100644 generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/IcebergCompressionType.h create mode 100644 generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/IcebergDestinationConfiguration.h create mode 100644 generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/IcebergDestinationUpdate.h create mode 100644 generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/ListChannelsRequest.h create mode 100644 generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/ListChannelsResult.h create mode 100644 generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/PartitionSource.h create mode 100644 generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/PartitionSpec.h create mode 100644 generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/PartitionStrategy.h create mode 100644 generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/RecordConverter.h create mode 100644 generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/RecordSchema.h create mode 100644 generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/S3CompressionType.h create mode 100644 generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/S3DestinationConfiguration.h create mode 100644 generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/S3DestinationUpdate.h create mode 100644 generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/S3Storage.h create mode 100644 generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/S3StorageClass.h create mode 100644 generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/SchemaEvolution.h create mode 100644 generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/TableCreation.h create mode 100644 generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/TopicConfiguration.h create mode 100644 generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/UpdateChannelRequest.h create mode 100644 generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/UpdateChannelResult.h create mode 100644 generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/ValueConverter.h create mode 100644 generated/src/aws-cpp-sdk-kafka/source/model/Catalog.cpp create mode 100644 generated/src/aws-cpp-sdk-kafka/source/model/ChannelDestinationType.cpp create mode 100644 generated/src/aws-cpp-sdk-kafka/source/model/ChannelInfo.cpp create mode 100644 generated/src/aws-cpp-sdk-kafka/source/model/ChannelLoggingInfo.cpp create mode 100644 generated/src/aws-cpp-sdk-kafka/source/model/ChannelStateInfo.cpp create mode 100644 generated/src/aws-cpp-sdk-kafka/source/model/ChannelStatus.cpp create mode 100644 generated/src/aws-cpp-sdk-kafka/source/model/CreateChannelRequest.cpp create mode 100644 generated/src/aws-cpp-sdk-kafka/source/model/CreateChannelResult.cpp create mode 100644 generated/src/aws-cpp-sdk-kafka/source/model/DeadLetterQueueS3.cpp create mode 100644 generated/src/aws-cpp-sdk-kafka/source/model/DeleteChannelRequest.cpp create mode 100644 generated/src/aws-cpp-sdk-kafka/source/model/DeleteChannelResult.cpp create mode 100644 generated/src/aws-cpp-sdk-kafka/source/model/DescribeChannelRequest.cpp create mode 100644 generated/src/aws-cpp-sdk-kafka/source/model/DescribeChannelResult.cpp create mode 100644 generated/src/aws-cpp-sdk-kafka/source/model/DestinationTable.cpp create mode 100644 generated/src/aws-cpp-sdk-kafka/source/model/EncryptionConfiguration.cpp create mode 100644 generated/src/aws-cpp-sdk-kafka/source/model/IcebergCompressionType.cpp create mode 100644 generated/src/aws-cpp-sdk-kafka/source/model/IcebergDestinationConfiguration.cpp create mode 100644 generated/src/aws-cpp-sdk-kafka/source/model/IcebergDestinationUpdate.cpp create mode 100644 generated/src/aws-cpp-sdk-kafka/source/model/ListChannelsRequest.cpp create mode 100644 generated/src/aws-cpp-sdk-kafka/source/model/ListChannelsResult.cpp create mode 100644 generated/src/aws-cpp-sdk-kafka/source/model/PartitionSource.cpp create mode 100644 generated/src/aws-cpp-sdk-kafka/source/model/PartitionSpec.cpp create mode 100644 generated/src/aws-cpp-sdk-kafka/source/model/PartitionStrategy.cpp create mode 100644 generated/src/aws-cpp-sdk-kafka/source/model/RecordConverter.cpp create mode 100644 generated/src/aws-cpp-sdk-kafka/source/model/RecordSchema.cpp create mode 100644 generated/src/aws-cpp-sdk-kafka/source/model/S3CompressionType.cpp create mode 100644 generated/src/aws-cpp-sdk-kafka/source/model/S3DestinationConfiguration.cpp create mode 100644 generated/src/aws-cpp-sdk-kafka/source/model/S3DestinationUpdate.cpp create mode 100644 generated/src/aws-cpp-sdk-kafka/source/model/S3Storage.cpp create mode 100644 generated/src/aws-cpp-sdk-kafka/source/model/S3StorageClass.cpp create mode 100644 generated/src/aws-cpp-sdk-kafka/source/model/SchemaEvolution.cpp create mode 100644 generated/src/aws-cpp-sdk-kafka/source/model/TableCreation.cpp create mode 100644 generated/src/aws-cpp-sdk-kafka/source/model/TopicConfiguration.cpp create mode 100644 generated/src/aws-cpp-sdk-kafka/source/model/UpdateChannelRequest.cpp create mode 100644 generated/src/aws-cpp-sdk-kafka/source/model/UpdateChannelResult.cpp create mode 100644 generated/src/aws-cpp-sdk-kafka/source/model/ValueConverter.cpp create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/CMakeLists.txt create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/PricingPlanManagerClient.h create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/PricingPlanManagerClientPagination.h create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/PricingPlanManagerEndpointProvider.h create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/PricingPlanManagerErrorMarshaller.h create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/PricingPlanManagerErrors.h create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/PricingPlanManagerPaginationBase.h create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/PricingPlanManagerRequest.h create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/PricingPlanManagerServiceClientModel.h create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/PricingPlanManagerWaiter.h create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/PricingPlanManager_EXPORTS.h create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/internal/PricingPlanManagerEndpointRules.h create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ApprovalMode.h create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ApprovePaidSubscriptionRequest.h create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ApprovePaidSubscriptionResult.h create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/AssociateResourcesToSubscriptionRequest.h create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/AssociateResourcesToSubscriptionResult.h create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/CancelSubscriptionChangeRequest.h create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/CancelSubscriptionChangeResult.h create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/CancelSubscriptionRequest.h create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/CancelSubscriptionResult.h create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ConflictException.h create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/CreateSubscriptionRequest.h create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/CreateSubscriptionResult.h create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/DisassociateResourcesFromSubscriptionRequest.h create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/DisassociateResourcesFromSubscriptionResult.h create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/GetSubscriptionRequest.h create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/GetSubscriptionResult.h create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ListSubscriptionsPaginationTraits.h create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ListSubscriptionsRequest.h create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ListSubscriptionsResult.h create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ResourceNotFoundException.h create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ScheduledChange.h create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ScheduledChangeType.h create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/Status.h create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/Subscription.h create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/SubscriptionSummary.h create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/UpdateSubscriptionRequest.h create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/UpdateSubscriptionResult.h create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ValidationException.h create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/source/PricingPlanManagerClient.cpp create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/source/PricingPlanManagerEndpointProvider.cpp create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/source/PricingPlanManagerEndpointRules.cpp create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/source/PricingPlanManagerErrorMarshaller.cpp create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/source/PricingPlanManagerErrors.cpp create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/source/PricingPlanManagerRequest.cpp create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/ApprovalMode.cpp create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/ApprovePaidSubscriptionRequest.cpp create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/ApprovePaidSubscriptionResult.cpp create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/AssociateResourcesToSubscriptionRequest.cpp create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/AssociateResourcesToSubscriptionResult.cpp create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/CancelSubscriptionChangeRequest.cpp create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/CancelSubscriptionChangeResult.cpp create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/CancelSubscriptionRequest.cpp create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/CancelSubscriptionResult.cpp create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/ConflictException.cpp create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/CreateSubscriptionRequest.cpp create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/CreateSubscriptionResult.cpp create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/DisassociateResourcesFromSubscriptionRequest.cpp create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/DisassociateResourcesFromSubscriptionResult.cpp create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/GetSubscriptionRequest.cpp create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/GetSubscriptionResult.cpp create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/ListSubscriptionsRequest.cpp create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/ListSubscriptionsResult.cpp create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/ResourceNotFoundException.cpp create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/ScheduledChange.cpp create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/ScheduledChangeType.cpp create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/Status.cpp create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/Subscription.cpp create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/SubscriptionSummary.cpp create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/UpdateSubscriptionRequest.cpp create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/UpdateSubscriptionResult.cpp create mode 100644 generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/ValidationException.cpp create mode 100644 generated/tests/pricing-plan-manager-gen-tests/CMakeLists.txt create mode 100644 generated/tests/pricing-plan-manager-gen-tests/PricingPlanManagerEndpointProviderTests.cpp create mode 100644 generated/tests/pricing-plan-manager-gen-tests/PricingPlanManagerIncludeTests.cpp create mode 100644 generated/tests/pricing-plan-manager-gen-tests/PricingPlanManagerPaginationCompilationTests.cpp create mode 100644 generated/tests/pricing-plan-manager-gen-tests/RunTests.cpp delete mode 100644 tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/api-2.json delete mode 100644 tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/docs-2.json delete mode 100644 tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/endpoint-bdd-1.json delete mode 100644 tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/endpoint-rule-set-1.json delete mode 100644 tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/endpoint-tests-1.json delete mode 100644 tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/examples-1.json delete mode 100644 tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/paginators-1.json delete mode 100644 tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/service-2.json delete mode 100644 tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/smoke-2.json delete mode 100644 tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/smoke.json delete mode 100644 tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/waiters-2.json delete mode 100644 tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/api-2.json delete mode 100644 tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/docs-2.json delete mode 100644 tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/endpoint-bdd-1.json delete mode 100644 tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/endpoint-rule-set-1.json delete mode 100644 tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/endpoint-tests-1.json delete mode 100644 tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/examples-1.json delete mode 100644 tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/paginators-1.json delete mode 100644 tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/service-2.json delete mode 100644 tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/smoke-2.json delete mode 100644 tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/smoke.json delete mode 100644 tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/waiters-2.json delete mode 100644 tools/code-generation/api-descriptions/bedrock-agentcore-control/2023-06-05/api-2.json delete mode 100644 tools/code-generation/api-descriptions/bedrock-agentcore-control/2023-06-05/docs-2.json delete mode 100644 tools/code-generation/api-descriptions/bedrock-agentcore-control/2023-06-05/endpoint-bdd-1.json delete mode 100644 tools/code-generation/api-descriptions/bedrock-agentcore-control/2023-06-05/endpoint-rule-set-1.json delete mode 100644 tools/code-generation/api-descriptions/bedrock-agentcore-control/2023-06-05/endpoint-tests-1.json delete mode 100644 tools/code-generation/api-descriptions/bedrock-agentcore-control/2023-06-05/examples-1.json delete mode 100644 tools/code-generation/api-descriptions/bedrock-agentcore-control/2023-06-05/paginators-1.json delete mode 100644 tools/code-generation/api-descriptions/bedrock-agentcore-control/2023-06-05/service-2.json delete mode 100644 tools/code-generation/api-descriptions/bedrock-agentcore-control/2023-06-05/smoke.json delete mode 100644 tools/code-generation/api-descriptions/bedrock-agentcore-control/2023-06-05/waiters-2.json delete mode 100644 tools/code-generation/api-descriptions/custom-service/custom-service-2017-11-03.normal.json delete mode 100644 tools/code-generation/api-descriptions/iam/2010-05-08/api-2.json delete mode 100644 tools/code-generation/api-descriptions/iam/2010-05-08/docs-2.json delete mode 100644 tools/code-generation/api-descriptions/iam/2010-05-08/endpoint-bdd-1.json delete mode 100644 tools/code-generation/api-descriptions/iam/2010-05-08/endpoint-rule-set-1.json delete mode 100644 tools/code-generation/api-descriptions/iam/2010-05-08/endpoint-tests-1.json delete mode 100644 tools/code-generation/api-descriptions/iam/2010-05-08/examples-1.json delete mode 100644 tools/code-generation/api-descriptions/iam/2010-05-08/paginators-1.json delete mode 100644 tools/code-generation/api-descriptions/iam/2010-05-08/resources-1.json delete mode 100644 tools/code-generation/api-descriptions/iam/2010-05-08/service-2.json delete mode 100644 tools/code-generation/api-descriptions/iam/2010-05-08/smoke-2.json delete mode 100644 tools/code-generation/api-descriptions/iam/2010-05-08/smoke.json delete mode 100644 tools/code-generation/api-descriptions/iam/2010-05-08/waiters-2.json delete mode 100644 tools/code-generation/api-descriptions/kafka/2018-11-14/api-2.json delete mode 100644 tools/code-generation/api-descriptions/kafka/2018-11-14/docs-2.json delete mode 100644 tools/code-generation/api-descriptions/kafka/2018-11-14/endpoint-bdd-1.json delete mode 100644 tools/code-generation/api-descriptions/kafka/2018-11-14/endpoint-rule-set-1.json delete mode 100644 tools/code-generation/api-descriptions/kafka/2018-11-14/endpoint-tests-1.json delete mode 100644 tools/code-generation/api-descriptions/kafka/2018-11-14/examples-1.json delete mode 100644 tools/code-generation/api-descriptions/kafka/2018-11-14/paginators-1.json delete mode 100644 tools/code-generation/api-descriptions/kafka/2018-11-14/service-2.json delete mode 100644 tools/code-generation/api-descriptions/lambda/2015-03-31/api-2.json delete mode 100644 tools/code-generation/api-descriptions/lambda/2015-03-31/docs-2.json delete mode 100644 tools/code-generation/api-descriptions/lambda/2015-03-31/endpoint-bdd-1.json delete mode 100644 tools/code-generation/api-descriptions/lambda/2015-03-31/endpoint-rule-set-1.json delete mode 100644 tools/code-generation/api-descriptions/lambda/2015-03-31/endpoint-tests-1.json delete mode 100644 tools/code-generation/api-descriptions/lambda/2015-03-31/examples-1.json delete mode 100644 tools/code-generation/api-descriptions/lambda/2015-03-31/paginators-1.json delete mode 100644 tools/code-generation/api-descriptions/lambda/2015-03-31/service-2.json delete mode 100644 tools/code-generation/api-descriptions/lambda/2015-03-31/smoke-2.json delete mode 100644 tools/code-generation/api-descriptions/lambda/2015-03-31/waiters-2.json delete mode 100644 tools/code-generation/api-descriptions/network-firewall/2020-11-12/api-2.json delete mode 100644 tools/code-generation/api-descriptions/network-firewall/2020-11-12/docs-2.json delete mode 100644 tools/code-generation/api-descriptions/network-firewall/2020-11-12/endpoint-bdd-1.json delete mode 100644 tools/code-generation/api-descriptions/network-firewall/2020-11-12/endpoint-rule-set-1.json delete mode 100644 tools/code-generation/api-descriptions/network-firewall/2020-11-12/endpoint-tests-1.json delete mode 100644 tools/code-generation/api-descriptions/network-firewall/2020-11-12/examples-1.json delete mode 100644 tools/code-generation/api-descriptions/network-firewall/2020-11-12/paginators-1.json delete mode 100644 tools/code-generation/api-descriptions/network-firewall/2020-11-12/service-2.json rename tools/code-generation/api-descriptions/{pricing-plan-manager/2025-08-05/service-2.json => pricing-plan-manager-2025-08-05.normal.json} (100%) delete mode 100644 tools/code-generation/api-descriptions/pricing-plan-manager/2025-08-05/api-2.json delete mode 100644 tools/code-generation/api-descriptions/pricing-plan-manager/2025-08-05/docs-2.json delete mode 100644 tools/code-generation/api-descriptions/pricing-plan-manager/2025-08-05/endpoint-bdd-1.json delete mode 100644 tools/code-generation/api-descriptions/pricing-plan-manager/2025-08-05/examples-1.json delete mode 100644 tools/code-generation/api-descriptions/pricing-plan-manager/2025-08-05/paginators-1.json delete mode 100644 tools/code-generation/api-descriptions/pricing-plan-manager/2025-08-05/smoke-2.json delete mode 100644 tools/code-generation/api-descriptions/sagemaker/2017-07-24/api-2.json delete mode 100644 tools/code-generation/api-descriptions/sagemaker/2017-07-24/docs-2.json delete mode 100644 tools/code-generation/api-descriptions/sagemaker/2017-07-24/endpoint-bdd-1.json delete mode 100644 tools/code-generation/api-descriptions/sagemaker/2017-07-24/endpoint-rule-set-1.json delete mode 100644 tools/code-generation/api-descriptions/sagemaker/2017-07-24/endpoint-tests-1.json delete mode 100644 tools/code-generation/api-descriptions/sagemaker/2017-07-24/examples-1.json delete mode 100644 tools/code-generation/api-descriptions/sagemaker/2017-07-24/paginators-1.json delete mode 100644 tools/code-generation/api-descriptions/sagemaker/2017-07-24/service-2.json delete mode 100644 tools/code-generation/api-descriptions/sagemaker/2017-07-24/waiters-2.json delete mode 100644 tools/code-generation/api-descriptions/securityagent/2025-09-06/api-2.json delete mode 100644 tools/code-generation/api-descriptions/securityagent/2025-09-06/docs-2.json delete mode 100644 tools/code-generation/api-descriptions/securityagent/2025-09-06/endpoint-bdd-1.json delete mode 100644 tools/code-generation/api-descriptions/securityagent/2025-09-06/endpoint-rule-set-1.json delete mode 100644 tools/code-generation/api-descriptions/securityagent/2025-09-06/endpoint-tests-1.json delete mode 100644 tools/code-generation/api-descriptions/securityagent/2025-09-06/examples-1.json delete mode 100644 tools/code-generation/api-descriptions/securityagent/2025-09-06/paginators-1.json delete mode 100644 tools/code-generation/api-descriptions/securityagent/2025-09-06/service-2.json delete mode 100644 tools/code-generation/api-descriptions/securityagent/2025-09-06/smoke-2.json delete mode 100644 tools/code-generation/api-descriptions/securityagent/2025-09-06/smoke.json delete mode 100644 tools/code-generation/api-descriptions/securityagent/2025-09-06/waiters-2.json rename tools/code-generation/{api-descriptions/pricing-plan-manager/2025-08-05/endpoint-rule-set-1.json => endpoints/pricing-plan-manager-2025-08-05.endpoint-rule-set.json} (100%) rename tools/code-generation/{api-descriptions/pricing-plan-manager/2025-08-05/endpoint-tests-1.json => endpoints/pricing-plan-manager-2025-08-05.endpoint-tests.json} (100%) diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/BCMPricingCalculatorClient.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/BCMPricingCalculatorClient.h index 289b1c160bb9..47b250ac90fc 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/BCMPricingCalculatorClient.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/BCMPricingCalculatorClient.h @@ -11,7 +11,7 @@ #include #include #include -#include +#include namespace Aws { namespace BCMPricingCalculator { @@ -24,12 +24,12 @@ namespace BCMPricingCalculator { * https://bcm-pricing-calculator.us-east-1.api.aws

*/ class AWS_BCMPRICINGCALCULATOR_API BCMPricingCalculatorClient - : public Aws::Client::AWSRpcV2CborClient, + : public Aws::Client::AWSJsonClient, public Aws::Client::ClientWithAsyncTemplateMethods, public BCMPricingCalculatorPaginationBase, public BCMPricingCalculatorWaiter { public: - typedef Aws::Client::AWSRpcV2CborClient BASECLASS; + typedef Aws::Client::AWSJsonClient BASECLASS; static const char* GetServiceName(); static const char* GetAllocationTag(); diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/BCMPricingCalculatorErrorMarshaller.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/BCMPricingCalculatorErrorMarshaller.h index 620a41e05760..bd438869487e 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/BCMPricingCalculatorErrorMarshaller.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/BCMPricingCalculatorErrorMarshaller.h @@ -11,7 +11,7 @@ namespace Aws { namespace Client { -class AWS_BCMPRICINGCALCULATOR_API BCMPricingCalculatorErrorMarshaller : public Aws::Client::RpcV2ErrorMarshaller { +class AWS_BCMPRICINGCALCULATOR_API BCMPricingCalculatorErrorMarshaller : public Aws::Client::JsonErrorMarshaller { public: Aws::Client::AWSError FindErrorByName(const char* exceptionName) const override; }; diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/BCMPricingCalculatorRequest.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/BCMPricingCalculatorRequest.h index d2abf83e6bbb..45b4bc7b70fb 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/BCMPricingCalculatorRequest.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/BCMPricingCalculatorRequest.h @@ -25,6 +25,7 @@ class AWS_BCMPRICINGCALCULATOR_API BCMPricingCalculatorRequest : public Aws::Ama auto headers = GetRequestSpecificHeaders(); if (headers.size() == 0 || (headers.size() > 0 && headers.count(Aws::Http::CONTENT_TYPE_HEADER) == 0)) { + headers.emplace(Aws::Http::HeaderValuePair(Aws::Http::CONTENT_TYPE_HEADER, Aws::AMZN_JSON_CONTENT_TYPE_1_0)); } headers.emplace(Aws::Http::HeaderValuePair(Aws::Http::API_VERSION_HEADER, "2024-06-19")); return headers; diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/AddReservedInstanceAction.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/AddReservedInstanceAction.h index 014da83da711..55588cbbf293 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/AddReservedInstanceAction.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/AddReservedInstanceAction.h @@ -6,15 +6,15 @@ #pragma once #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -28,9 +28,9 @@ namespace Model { class AddReservedInstanceAction { public: AWS_BCMPRICINGCALCULATOR_API AddReservedInstanceAction() = default; - AWS_BCMPRICINGCALCULATOR_API AddReservedInstanceAction(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API AddReservedInstanceAction& operator=(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API AddReservedInstanceAction(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API AddReservedInstanceAction& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** @@ -57,13 +57,13 @@ class AddReservedInstanceAction { /** *

The number of instances to add for this Reserved Instance offering.

*/ - inline int64_t GetInstanceCount() const { return m_instanceCount; } + inline int GetInstanceCount() const { return m_instanceCount; } inline bool InstanceCountHasBeenSet() const { return m_instanceCountHasBeenSet; } - inline void SetInstanceCount(int64_t value) { + inline void SetInstanceCount(int value) { m_instanceCountHasBeenSet = true; m_instanceCount = value; } - inline AddReservedInstanceAction& WithInstanceCount(int64_t value) { + inline AddReservedInstanceAction& WithInstanceCount(int value) { SetInstanceCount(value); return *this; } @@ -71,7 +71,7 @@ class AddReservedInstanceAction { private: Aws::String m_reservedInstancesOfferingId; - int64_t m_instanceCount{0}; + int m_instanceCount{0}; bool m_reservedInstancesOfferingIdHasBeenSet = false; bool m_instanceCountHasBeenSet = false; }; diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/AddSavingsPlanAction.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/AddSavingsPlanAction.h index ee7529d0608f..5afe40d7a924 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/AddSavingsPlanAction.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/AddSavingsPlanAction.h @@ -6,15 +6,15 @@ #pragma once #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -28,9 +28,9 @@ namespace Model { class AddSavingsPlanAction { public: AWS_BCMPRICINGCALCULATOR_API AddSavingsPlanAction() = default; - AWS_BCMPRICINGCALCULATOR_API AddSavingsPlanAction(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API AddSavingsPlanAction& operator=(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API AddSavingsPlanAction(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API AddSavingsPlanAction& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateBillScenarioCommitmentModificationEntry.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateBillScenarioCommitmentModificationEntry.h index 139dad7c26cf..da0886cf3b3f 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateBillScenarioCommitmentModificationEntry.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateBillScenarioCommitmentModificationEntry.h @@ -7,15 +7,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -29,11 +29,9 @@ namespace Model { class BatchCreateBillScenarioCommitmentModificationEntry { public: AWS_BCMPRICINGCALCULATOR_API BatchCreateBillScenarioCommitmentModificationEntry() = default; - AWS_BCMPRICINGCALCULATOR_API BatchCreateBillScenarioCommitmentModificationEntry( - const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API BatchCreateBillScenarioCommitmentModificationEntry& operator=( - const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API BatchCreateBillScenarioCommitmentModificationEntry(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API BatchCreateBillScenarioCommitmentModificationEntry& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateBillScenarioCommitmentModificationError.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateBillScenarioCommitmentModificationError.h index 60d64019d67a..d3a1aa5c2e39 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateBillScenarioCommitmentModificationError.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateBillScenarioCommitmentModificationError.h @@ -7,15 +7,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -29,11 +29,9 @@ namespace Model { class BatchCreateBillScenarioCommitmentModificationError { public: AWS_BCMPRICINGCALCULATOR_API BatchCreateBillScenarioCommitmentModificationError() = default; - AWS_BCMPRICINGCALCULATOR_API BatchCreateBillScenarioCommitmentModificationError( - const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API BatchCreateBillScenarioCommitmentModificationError& operator=( - const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API BatchCreateBillScenarioCommitmentModificationError(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API BatchCreateBillScenarioCommitmentModificationError& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateBillScenarioCommitmentModificationItem.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateBillScenarioCommitmentModificationItem.h index 1ea59a496032..a14e2893e3f8 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateBillScenarioCommitmentModificationItem.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateBillScenarioCommitmentModificationItem.h @@ -7,15 +7,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -29,11 +29,9 @@ namespace Model { class BatchCreateBillScenarioCommitmentModificationItem { public: AWS_BCMPRICINGCALCULATOR_API BatchCreateBillScenarioCommitmentModificationItem() = default; - AWS_BCMPRICINGCALCULATOR_API BatchCreateBillScenarioCommitmentModificationItem( - const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API BatchCreateBillScenarioCommitmentModificationItem& operator=( - const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API BatchCreateBillScenarioCommitmentModificationItem(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API BatchCreateBillScenarioCommitmentModificationItem& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateBillScenarioCommitmentModificationResult.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateBillScenarioCommitmentModificationResult.h index 518168635ae3..27a583c3ffb9 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateBillScenarioCommitmentModificationResult.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateBillScenarioCommitmentModificationResult.h @@ -10,17 +10,17 @@ #include #include #include -#include #include + namespace Aws { template class AmazonWebServiceResult; namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -28,9 +28,9 @@ class BatchCreateBillScenarioCommitmentModificationResult { public: AWS_BCMPRICINGCALCULATOR_API BatchCreateBillScenarioCommitmentModificationResult() = default; AWS_BCMPRICINGCALCULATOR_API BatchCreateBillScenarioCommitmentModificationResult( - const Aws::AmazonWebServiceResult& result); + const Aws::AmazonWebServiceResult& result); AWS_BCMPRICINGCALCULATOR_API BatchCreateBillScenarioCommitmentModificationResult& operator=( - const Aws::AmazonWebServiceResult& result); + const Aws::AmazonWebServiceResult& result); ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateBillScenarioUsageModificationEntry.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateBillScenarioUsageModificationEntry.h index 592cd87cf022..2eaea11e9fb5 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateBillScenarioUsageModificationEntry.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateBillScenarioUsageModificationEntry.h @@ -9,15 +9,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -31,10 +31,9 @@ namespace Model { class BatchCreateBillScenarioUsageModificationEntry { public: AWS_BCMPRICINGCALCULATOR_API BatchCreateBillScenarioUsageModificationEntry() = default; - AWS_BCMPRICINGCALCULATOR_API BatchCreateBillScenarioUsageModificationEntry(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API BatchCreateBillScenarioUsageModificationEntry& operator=( - const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API BatchCreateBillScenarioUsageModificationEntry(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API BatchCreateBillScenarioUsageModificationEntry& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateBillScenarioUsageModificationError.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateBillScenarioUsageModificationError.h index 9016e9df48d0..4904dfb65173 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateBillScenarioUsageModificationError.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateBillScenarioUsageModificationError.h @@ -7,15 +7,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -29,10 +29,9 @@ namespace Model { class BatchCreateBillScenarioUsageModificationError { public: AWS_BCMPRICINGCALCULATOR_API BatchCreateBillScenarioUsageModificationError() = default; - AWS_BCMPRICINGCALCULATOR_API BatchCreateBillScenarioUsageModificationError(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API BatchCreateBillScenarioUsageModificationError& operator=( - const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API BatchCreateBillScenarioUsageModificationError(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API BatchCreateBillScenarioUsageModificationError& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateBillScenarioUsageModificationItem.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateBillScenarioUsageModificationItem.h index 3ab1510d34a4..08564faeefb2 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateBillScenarioUsageModificationItem.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateBillScenarioUsageModificationItem.h @@ -9,15 +9,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -31,10 +31,9 @@ namespace Model { class BatchCreateBillScenarioUsageModificationItem { public: AWS_BCMPRICINGCALCULATOR_API BatchCreateBillScenarioUsageModificationItem() = default; - AWS_BCMPRICINGCALCULATOR_API BatchCreateBillScenarioUsageModificationItem(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API BatchCreateBillScenarioUsageModificationItem& operator=( - const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API BatchCreateBillScenarioUsageModificationItem(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API BatchCreateBillScenarioUsageModificationItem& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateBillScenarioUsageModificationResult.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateBillScenarioUsageModificationResult.h index 03c41468e932..eb65ffd03705 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateBillScenarioUsageModificationResult.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateBillScenarioUsageModificationResult.h @@ -10,17 +10,17 @@ #include #include #include -#include #include + namespace Aws { template class AmazonWebServiceResult; namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -28,9 +28,9 @@ class BatchCreateBillScenarioUsageModificationResult { public: AWS_BCMPRICINGCALCULATOR_API BatchCreateBillScenarioUsageModificationResult() = default; AWS_BCMPRICINGCALCULATOR_API BatchCreateBillScenarioUsageModificationResult( - const Aws::AmazonWebServiceResult& result); + const Aws::AmazonWebServiceResult& result); AWS_BCMPRICINGCALCULATOR_API BatchCreateBillScenarioUsageModificationResult& operator=( - const Aws::AmazonWebServiceResult& result); + const Aws::AmazonWebServiceResult& result); ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateWorkloadEstimateUsageEntry.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateWorkloadEstimateUsageEntry.h index e8dae6f0e33f..9c00988cccf5 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateWorkloadEstimateUsageEntry.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateWorkloadEstimateUsageEntry.h @@ -7,15 +7,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -29,10 +29,9 @@ namespace Model { class BatchCreateWorkloadEstimateUsageEntry { public: AWS_BCMPRICINGCALCULATOR_API BatchCreateWorkloadEstimateUsageEntry() = default; - AWS_BCMPRICINGCALCULATOR_API BatchCreateWorkloadEstimateUsageEntry(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API BatchCreateWorkloadEstimateUsageEntry& operator=( - const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API BatchCreateWorkloadEstimateUsageEntry(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API BatchCreateWorkloadEstimateUsageEntry& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateWorkloadEstimateUsageError.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateWorkloadEstimateUsageError.h index 200fe8091053..cce6ca8b3e9d 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateWorkloadEstimateUsageError.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateWorkloadEstimateUsageError.h @@ -7,15 +7,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -29,10 +29,9 @@ namespace Model { class BatchCreateWorkloadEstimateUsageError { public: AWS_BCMPRICINGCALCULATOR_API BatchCreateWorkloadEstimateUsageError() = default; - AWS_BCMPRICINGCALCULATOR_API BatchCreateWorkloadEstimateUsageError(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API BatchCreateWorkloadEstimateUsageError& operator=( - const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API BatchCreateWorkloadEstimateUsageError(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API BatchCreateWorkloadEstimateUsageError& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateWorkloadEstimateUsageItem.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateWorkloadEstimateUsageItem.h index e78df7e6543a..482837a0e63d 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateWorkloadEstimateUsageItem.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateWorkloadEstimateUsageItem.h @@ -10,15 +10,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -32,9 +32,9 @@ namespace Model { class BatchCreateWorkloadEstimateUsageItem { public: AWS_BCMPRICINGCALCULATOR_API BatchCreateWorkloadEstimateUsageItem() = default; - AWS_BCMPRICINGCALCULATOR_API BatchCreateWorkloadEstimateUsageItem(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API BatchCreateWorkloadEstimateUsageItem& operator=(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API BatchCreateWorkloadEstimateUsageItem(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API BatchCreateWorkloadEstimateUsageItem& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateWorkloadEstimateUsageResult.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateWorkloadEstimateUsageResult.h index bb48a314a2d2..4afc145a3ca5 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateWorkloadEstimateUsageResult.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchCreateWorkloadEstimateUsageResult.h @@ -10,17 +10,17 @@ #include #include #include -#include #include + namespace Aws { template class AmazonWebServiceResult; namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -28,9 +28,9 @@ class BatchCreateWorkloadEstimateUsageResult { public: AWS_BCMPRICINGCALCULATOR_API BatchCreateWorkloadEstimateUsageResult() = default; AWS_BCMPRICINGCALCULATOR_API BatchCreateWorkloadEstimateUsageResult( - const Aws::AmazonWebServiceResult& result); + const Aws::AmazonWebServiceResult& result); AWS_BCMPRICINGCALCULATOR_API BatchCreateWorkloadEstimateUsageResult& operator=( - const Aws::AmazonWebServiceResult& result); + const Aws::AmazonWebServiceResult& result); ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchDeleteBillScenarioCommitmentModificationError.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchDeleteBillScenarioCommitmentModificationError.h index 07bc07e1c6ca..3d425f1266e5 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchDeleteBillScenarioCommitmentModificationError.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchDeleteBillScenarioCommitmentModificationError.h @@ -7,15 +7,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -29,11 +29,9 @@ namespace Model { class BatchDeleteBillScenarioCommitmentModificationError { public: AWS_BCMPRICINGCALCULATOR_API BatchDeleteBillScenarioCommitmentModificationError() = default; - AWS_BCMPRICINGCALCULATOR_API BatchDeleteBillScenarioCommitmentModificationError( - const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API BatchDeleteBillScenarioCommitmentModificationError& operator=( - const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API BatchDeleteBillScenarioCommitmentModificationError(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API BatchDeleteBillScenarioCommitmentModificationError& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchDeleteBillScenarioCommitmentModificationResult.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchDeleteBillScenarioCommitmentModificationResult.h index 75ad261754fd..99fa611633ed 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchDeleteBillScenarioCommitmentModificationResult.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchDeleteBillScenarioCommitmentModificationResult.h @@ -9,17 +9,17 @@ #include #include #include -#include #include + namespace Aws { template class AmazonWebServiceResult; namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -27,9 +27,9 @@ class BatchDeleteBillScenarioCommitmentModificationResult { public: AWS_BCMPRICINGCALCULATOR_API BatchDeleteBillScenarioCommitmentModificationResult() = default; AWS_BCMPRICINGCALCULATOR_API BatchDeleteBillScenarioCommitmentModificationResult( - const Aws::AmazonWebServiceResult& result); + const Aws::AmazonWebServiceResult& result); AWS_BCMPRICINGCALCULATOR_API BatchDeleteBillScenarioCommitmentModificationResult& operator=( - const Aws::AmazonWebServiceResult& result); + const Aws::AmazonWebServiceResult& result); ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchDeleteBillScenarioUsageModificationError.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchDeleteBillScenarioUsageModificationError.h index edf50b9770e7..bc2059687b41 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchDeleteBillScenarioUsageModificationError.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchDeleteBillScenarioUsageModificationError.h @@ -7,15 +7,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -29,10 +29,9 @@ namespace Model { class BatchDeleteBillScenarioUsageModificationError { public: AWS_BCMPRICINGCALCULATOR_API BatchDeleteBillScenarioUsageModificationError() = default; - AWS_BCMPRICINGCALCULATOR_API BatchDeleteBillScenarioUsageModificationError(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API BatchDeleteBillScenarioUsageModificationError& operator=( - const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API BatchDeleteBillScenarioUsageModificationError(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API BatchDeleteBillScenarioUsageModificationError& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchDeleteBillScenarioUsageModificationResult.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchDeleteBillScenarioUsageModificationResult.h index 2303f58c52f2..293e674c8cee 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchDeleteBillScenarioUsageModificationResult.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchDeleteBillScenarioUsageModificationResult.h @@ -9,17 +9,17 @@ #include #include #include -#include #include + namespace Aws { template class AmazonWebServiceResult; namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -27,9 +27,9 @@ class BatchDeleteBillScenarioUsageModificationResult { public: AWS_BCMPRICINGCALCULATOR_API BatchDeleteBillScenarioUsageModificationResult() = default; AWS_BCMPRICINGCALCULATOR_API BatchDeleteBillScenarioUsageModificationResult( - const Aws::AmazonWebServiceResult& result); + const Aws::AmazonWebServiceResult& result); AWS_BCMPRICINGCALCULATOR_API BatchDeleteBillScenarioUsageModificationResult& operator=( - const Aws::AmazonWebServiceResult& result); + const Aws::AmazonWebServiceResult& result); ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchDeleteWorkloadEstimateUsageError.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchDeleteWorkloadEstimateUsageError.h index 6ef1b009ce50..4cc5014be790 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchDeleteWorkloadEstimateUsageError.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchDeleteWorkloadEstimateUsageError.h @@ -7,15 +7,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -29,10 +29,9 @@ namespace Model { class BatchDeleteWorkloadEstimateUsageError { public: AWS_BCMPRICINGCALCULATOR_API BatchDeleteWorkloadEstimateUsageError() = default; - AWS_BCMPRICINGCALCULATOR_API BatchDeleteWorkloadEstimateUsageError(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API BatchDeleteWorkloadEstimateUsageError& operator=( - const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API BatchDeleteWorkloadEstimateUsageError(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API BatchDeleteWorkloadEstimateUsageError& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchDeleteWorkloadEstimateUsageResult.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchDeleteWorkloadEstimateUsageResult.h index 81f6eff9c81d..b2145aae3944 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchDeleteWorkloadEstimateUsageResult.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchDeleteWorkloadEstimateUsageResult.h @@ -9,17 +9,17 @@ #include #include #include -#include #include + namespace Aws { template class AmazonWebServiceResult; namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -27,9 +27,9 @@ class BatchDeleteWorkloadEstimateUsageResult { public: AWS_BCMPRICINGCALCULATOR_API BatchDeleteWorkloadEstimateUsageResult() = default; AWS_BCMPRICINGCALCULATOR_API BatchDeleteWorkloadEstimateUsageResult( - const Aws::AmazonWebServiceResult& result); + const Aws::AmazonWebServiceResult& result); AWS_BCMPRICINGCALCULATOR_API BatchDeleteWorkloadEstimateUsageResult& operator=( - const Aws::AmazonWebServiceResult& result); + const Aws::AmazonWebServiceResult& result); ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchUpdateBillScenarioCommitmentModificationEntry.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchUpdateBillScenarioCommitmentModificationEntry.h index 51f1be006d97..bb2eb646577e 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchUpdateBillScenarioCommitmentModificationEntry.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchUpdateBillScenarioCommitmentModificationEntry.h @@ -6,15 +6,15 @@ #pragma once #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -28,11 +28,9 @@ namespace Model { class BatchUpdateBillScenarioCommitmentModificationEntry { public: AWS_BCMPRICINGCALCULATOR_API BatchUpdateBillScenarioCommitmentModificationEntry() = default; - AWS_BCMPRICINGCALCULATOR_API BatchUpdateBillScenarioCommitmentModificationEntry( - const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API BatchUpdateBillScenarioCommitmentModificationEntry& operator=( - const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API BatchUpdateBillScenarioCommitmentModificationEntry(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API BatchUpdateBillScenarioCommitmentModificationEntry& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchUpdateBillScenarioCommitmentModificationError.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchUpdateBillScenarioCommitmentModificationError.h index 8a3302ca06f3..dd6a291c8fee 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchUpdateBillScenarioCommitmentModificationError.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchUpdateBillScenarioCommitmentModificationError.h @@ -7,15 +7,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -29,11 +29,9 @@ namespace Model { class BatchUpdateBillScenarioCommitmentModificationError { public: AWS_BCMPRICINGCALCULATOR_API BatchUpdateBillScenarioCommitmentModificationError() = default; - AWS_BCMPRICINGCALCULATOR_API BatchUpdateBillScenarioCommitmentModificationError( - const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API BatchUpdateBillScenarioCommitmentModificationError& operator=( - const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API BatchUpdateBillScenarioCommitmentModificationError(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API BatchUpdateBillScenarioCommitmentModificationError& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchUpdateBillScenarioCommitmentModificationResult.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchUpdateBillScenarioCommitmentModificationResult.h index 80f239041886..d2600f97dca1 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchUpdateBillScenarioCommitmentModificationResult.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchUpdateBillScenarioCommitmentModificationResult.h @@ -10,17 +10,17 @@ #include #include #include -#include #include + namespace Aws { template class AmazonWebServiceResult; namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -28,9 +28,9 @@ class BatchUpdateBillScenarioCommitmentModificationResult { public: AWS_BCMPRICINGCALCULATOR_API BatchUpdateBillScenarioCommitmentModificationResult() = default; AWS_BCMPRICINGCALCULATOR_API BatchUpdateBillScenarioCommitmentModificationResult( - const Aws::AmazonWebServiceResult& result); + const Aws::AmazonWebServiceResult& result); AWS_BCMPRICINGCALCULATOR_API BatchUpdateBillScenarioCommitmentModificationResult& operator=( - const Aws::AmazonWebServiceResult& result); + const Aws::AmazonWebServiceResult& result); ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchUpdateBillScenarioUsageModificationEntry.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchUpdateBillScenarioUsageModificationEntry.h index c774c0f7a06d..7cc22cd09df5 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchUpdateBillScenarioUsageModificationEntry.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchUpdateBillScenarioUsageModificationEntry.h @@ -8,15 +8,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -30,10 +30,9 @@ namespace Model { class BatchUpdateBillScenarioUsageModificationEntry { public: AWS_BCMPRICINGCALCULATOR_API BatchUpdateBillScenarioUsageModificationEntry() = default; - AWS_BCMPRICINGCALCULATOR_API BatchUpdateBillScenarioUsageModificationEntry(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API BatchUpdateBillScenarioUsageModificationEntry& operator=( - const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API BatchUpdateBillScenarioUsageModificationEntry(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API BatchUpdateBillScenarioUsageModificationEntry& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchUpdateBillScenarioUsageModificationError.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchUpdateBillScenarioUsageModificationError.h index 1c7223e5e499..7a6a3d3b01bf 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchUpdateBillScenarioUsageModificationError.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchUpdateBillScenarioUsageModificationError.h @@ -7,15 +7,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -29,10 +29,9 @@ namespace Model { class BatchUpdateBillScenarioUsageModificationError { public: AWS_BCMPRICINGCALCULATOR_API BatchUpdateBillScenarioUsageModificationError() = default; - AWS_BCMPRICINGCALCULATOR_API BatchUpdateBillScenarioUsageModificationError(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API BatchUpdateBillScenarioUsageModificationError& operator=( - const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API BatchUpdateBillScenarioUsageModificationError(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API BatchUpdateBillScenarioUsageModificationError& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchUpdateBillScenarioUsageModificationResult.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchUpdateBillScenarioUsageModificationResult.h index 6478a31ac5bd..a3d27ee8deb4 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchUpdateBillScenarioUsageModificationResult.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchUpdateBillScenarioUsageModificationResult.h @@ -10,17 +10,17 @@ #include #include #include -#include #include + namespace Aws { template class AmazonWebServiceResult; namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -28,9 +28,9 @@ class BatchUpdateBillScenarioUsageModificationResult { public: AWS_BCMPRICINGCALCULATOR_API BatchUpdateBillScenarioUsageModificationResult() = default; AWS_BCMPRICINGCALCULATOR_API BatchUpdateBillScenarioUsageModificationResult( - const Aws::AmazonWebServiceResult& result); + const Aws::AmazonWebServiceResult& result); AWS_BCMPRICINGCALCULATOR_API BatchUpdateBillScenarioUsageModificationResult& operator=( - const Aws::AmazonWebServiceResult& result); + const Aws::AmazonWebServiceResult& result); ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchUpdateWorkloadEstimateUsageEntry.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchUpdateWorkloadEstimateUsageEntry.h index 22ce59387be0..6b9b20f9f829 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchUpdateWorkloadEstimateUsageEntry.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchUpdateWorkloadEstimateUsageEntry.h @@ -6,15 +6,15 @@ #pragma once #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -28,10 +28,9 @@ namespace Model { class BatchUpdateWorkloadEstimateUsageEntry { public: AWS_BCMPRICINGCALCULATOR_API BatchUpdateWorkloadEstimateUsageEntry() = default; - AWS_BCMPRICINGCALCULATOR_API BatchUpdateWorkloadEstimateUsageEntry(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API BatchUpdateWorkloadEstimateUsageEntry& operator=( - const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API BatchUpdateWorkloadEstimateUsageEntry(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API BatchUpdateWorkloadEstimateUsageEntry& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchUpdateWorkloadEstimateUsageError.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchUpdateWorkloadEstimateUsageError.h index 5f78afc543ca..ecff6de22260 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchUpdateWorkloadEstimateUsageError.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchUpdateWorkloadEstimateUsageError.h @@ -7,15 +7,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -29,10 +29,9 @@ namespace Model { class BatchUpdateWorkloadEstimateUsageError { public: AWS_BCMPRICINGCALCULATOR_API BatchUpdateWorkloadEstimateUsageError() = default; - AWS_BCMPRICINGCALCULATOR_API BatchUpdateWorkloadEstimateUsageError(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API BatchUpdateWorkloadEstimateUsageError& operator=( - const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API BatchUpdateWorkloadEstimateUsageError(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API BatchUpdateWorkloadEstimateUsageError& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchUpdateWorkloadEstimateUsageResult.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchUpdateWorkloadEstimateUsageResult.h index 9cd5f030496e..c1fad2f3a0cb 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchUpdateWorkloadEstimateUsageResult.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BatchUpdateWorkloadEstimateUsageResult.h @@ -10,17 +10,17 @@ #include #include #include -#include #include + namespace Aws { template class AmazonWebServiceResult; namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -28,9 +28,9 @@ class BatchUpdateWorkloadEstimateUsageResult { public: AWS_BCMPRICINGCALCULATOR_API BatchUpdateWorkloadEstimateUsageResult() = default; AWS_BCMPRICINGCALCULATOR_API BatchUpdateWorkloadEstimateUsageResult( - const Aws::AmazonWebServiceResult& result); + const Aws::AmazonWebServiceResult& result); AWS_BCMPRICINGCALCULATOR_API BatchUpdateWorkloadEstimateUsageResult& operator=( - const Aws::AmazonWebServiceResult& result); + const Aws::AmazonWebServiceResult& result); ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillEstimateCommitmentSummary.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillEstimateCommitmentSummary.h index fa951d488f4d..c4ace88689d8 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillEstimateCommitmentSummary.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillEstimateCommitmentSummary.h @@ -8,15 +8,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -30,9 +30,9 @@ namespace Model { class BillEstimateCommitmentSummary { public: AWS_BCMPRICINGCALCULATOR_API BillEstimateCommitmentSummary() = default; - AWS_BCMPRICINGCALCULATOR_API BillEstimateCommitmentSummary(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API BillEstimateCommitmentSummary& operator=(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API BillEstimateCommitmentSummary(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API BillEstimateCommitmentSummary& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillEstimateCostSummary.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillEstimateCostSummary.h index 34fa091fd7bd..f2fd2724e7c1 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillEstimateCostSummary.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillEstimateCostSummary.h @@ -8,15 +8,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -30,9 +30,9 @@ namespace Model { class BillEstimateCostSummary { public: AWS_BCMPRICINGCALCULATOR_API BillEstimateCostSummary() = default; - AWS_BCMPRICINGCALCULATOR_API BillEstimateCostSummary(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API BillEstimateCostSummary& operator=(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API BillEstimateCostSummary(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API BillEstimateCostSummary& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillEstimateInputCommitmentModificationSummary.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillEstimateInputCommitmentModificationSummary.h index cdd2e5f4d606..5a6ab8f86176 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillEstimateInputCommitmentModificationSummary.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillEstimateInputCommitmentModificationSummary.h @@ -7,15 +7,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -29,10 +29,9 @@ namespace Model { class BillEstimateInputCommitmentModificationSummary { public: AWS_BCMPRICINGCALCULATOR_API BillEstimateInputCommitmentModificationSummary() = default; - AWS_BCMPRICINGCALCULATOR_API BillEstimateInputCommitmentModificationSummary(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API BillEstimateInputCommitmentModificationSummary& operator=( - const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API BillEstimateInputCommitmentModificationSummary(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API BillEstimateInputCommitmentModificationSummary& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillEstimateInputUsageModificationSummary.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillEstimateInputUsageModificationSummary.h index a2e97b76d6cf..756425f415bd 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillEstimateInputUsageModificationSummary.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillEstimateInputUsageModificationSummary.h @@ -9,15 +9,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -31,10 +31,9 @@ namespace Model { class BillEstimateInputUsageModificationSummary { public: AWS_BCMPRICINGCALCULATOR_API BillEstimateInputUsageModificationSummary() = default; - AWS_BCMPRICINGCALCULATOR_API BillEstimateInputUsageModificationSummary(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API BillEstimateInputUsageModificationSummary& operator=( - const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API BillEstimateInputUsageModificationSummary(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API BillEstimateInputUsageModificationSummary& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillEstimateLineItemSummary.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillEstimateLineItemSummary.h index ed5200975208..64fa2905d2e9 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillEstimateLineItemSummary.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillEstimateLineItemSummary.h @@ -9,15 +9,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -31,9 +31,9 @@ namespace Model { class BillEstimateLineItemSummary { public: AWS_BCMPRICINGCALCULATOR_API BillEstimateLineItemSummary() = default; - AWS_BCMPRICINGCALCULATOR_API BillEstimateLineItemSummary(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API BillEstimateLineItemSummary& operator=(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API BillEstimateLineItemSummary(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API BillEstimateLineItemSummary& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillEstimateSummary.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillEstimateSummary.h index 6770c732b324..4c2039aa0570 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillEstimateSummary.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillEstimateSummary.h @@ -9,15 +9,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -30,9 +30,9 @@ namespace Model { class BillEstimateSummary { public: AWS_BCMPRICINGCALCULATOR_API BillEstimateSummary() = default; - AWS_BCMPRICINGCALCULATOR_API BillEstimateSummary(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API BillEstimateSummary& operator=(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API BillEstimateSummary(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API BillEstimateSummary& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillInterval.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillInterval.h index f725aa14c260..daf5ae7f3a62 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillInterval.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillInterval.h @@ -6,15 +6,15 @@ #pragma once #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -28,9 +28,9 @@ namespace Model { class BillInterval { public: AWS_BCMPRICINGCALCULATOR_API BillInterval() = default; - AWS_BCMPRICINGCALCULATOR_API BillInterval(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API BillInterval& operator=(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API BillInterval(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API BillInterval& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillScenarioCommitmentModificationAction.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillScenarioCommitmentModificationAction.h index e9106a9c078e..d34549397da9 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillScenarioCommitmentModificationAction.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillScenarioCommitmentModificationAction.h @@ -9,15 +9,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -31,10 +31,9 @@ namespace Model { class BillScenarioCommitmentModificationAction { public: AWS_BCMPRICINGCALCULATOR_API BillScenarioCommitmentModificationAction() = default; - AWS_BCMPRICINGCALCULATOR_API BillScenarioCommitmentModificationAction(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API BillScenarioCommitmentModificationAction& operator=( - const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API BillScenarioCommitmentModificationAction(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API BillScenarioCommitmentModificationAction& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillScenarioCommitmentModificationItem.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillScenarioCommitmentModificationItem.h index a732ef004190..b1766ed135ee 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillScenarioCommitmentModificationItem.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillScenarioCommitmentModificationItem.h @@ -7,15 +7,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -29,10 +29,9 @@ namespace Model { class BillScenarioCommitmentModificationItem { public: AWS_BCMPRICINGCALCULATOR_API BillScenarioCommitmentModificationItem() = default; - AWS_BCMPRICINGCALCULATOR_API BillScenarioCommitmentModificationItem(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API BillScenarioCommitmentModificationItem& operator=( - const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API BillScenarioCommitmentModificationItem(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API BillScenarioCommitmentModificationItem& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillScenarioSummary.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillScenarioSummary.h index 4a12ece16eeb..16ecb44b90a4 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillScenarioSummary.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillScenarioSummary.h @@ -10,15 +10,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -31,9 +31,9 @@ namespace Model { class BillScenarioSummary { public: AWS_BCMPRICINGCALCULATOR_API BillScenarioSummary() = default; - AWS_BCMPRICINGCALCULATOR_API BillScenarioSummary(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API BillScenarioSummary& operator=(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API BillScenarioSummary(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API BillScenarioSummary& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillScenarioUsageModificationItem.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillScenarioUsageModificationItem.h index fab872f9e95d..439e884f4930 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillScenarioUsageModificationItem.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/BillScenarioUsageModificationItem.h @@ -9,15 +9,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -31,9 +31,9 @@ namespace Model { class BillScenarioUsageModificationItem { public: AWS_BCMPRICINGCALCULATOR_API BillScenarioUsageModificationItem() = default; - AWS_BCMPRICINGCALCULATOR_API BillScenarioUsageModificationItem(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API BillScenarioUsageModificationItem& operator=(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API BillScenarioUsageModificationItem(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API BillScenarioUsageModificationItem& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ConflictException.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ConflictException.h index b9f2104142fd..6cae8453fabc 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ConflictException.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ConflictException.h @@ -6,15 +6,15 @@ #pragma once #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -28,9 +28,9 @@ namespace Model { class ConflictException { public: AWS_BCMPRICINGCALCULATOR_API ConflictException() = default; - AWS_BCMPRICINGCALCULATOR_API ConflictException(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API ConflictException& operator=(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API ConflictException(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API ConflictException& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/CostAmount.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/CostAmount.h index 0aaefc4fc757..9d0281a83374 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/CostAmount.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/CostAmount.h @@ -6,15 +6,15 @@ #pragma once #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -28,9 +28,9 @@ namespace Model { class CostAmount { public: AWS_BCMPRICINGCALCULATOR_API CostAmount() = default; - AWS_BCMPRICINGCALCULATOR_API CostAmount(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API CostAmount& operator=(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API CostAmount(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API CostAmount& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/CostDifference.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/CostDifference.h index a3536b1d4a22..6c58cd732432 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/CostDifference.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/CostDifference.h @@ -6,15 +6,15 @@ #pragma once #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -28,9 +28,9 @@ namespace Model { class CostDifference { public: AWS_BCMPRICINGCALCULATOR_API CostDifference() = default; - AWS_BCMPRICINGCALCULATOR_API CostDifference(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API CostDifference& operator=(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API CostDifference(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API CostDifference& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/CreateBillEstimateResult.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/CreateBillEstimateResult.h index 52b2a1da2e9e..33b29434cfa8 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/CreateBillEstimateResult.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/CreateBillEstimateResult.h @@ -12,25 +12,25 @@ #include #include #include -#include #include + namespace Aws { template class AmazonWebServiceResult; namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { class CreateBillEstimateResult { public: AWS_BCMPRICINGCALCULATOR_API CreateBillEstimateResult() = default; - AWS_BCMPRICINGCALCULATOR_API CreateBillEstimateResult(const Aws::AmazonWebServiceResult& result); - AWS_BCMPRICINGCALCULATOR_API CreateBillEstimateResult& operator=(const Aws::AmazonWebServiceResult& result); + AWS_BCMPRICINGCALCULATOR_API CreateBillEstimateResult(const Aws::AmazonWebServiceResult& result); + AWS_BCMPRICINGCALCULATOR_API CreateBillEstimateResult& operator=(const Aws::AmazonWebServiceResult& result); ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/CreateBillScenarioResult.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/CreateBillScenarioResult.h index 4c9ceab42c28..5c873c65dbc9 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/CreateBillScenarioResult.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/CreateBillScenarioResult.h @@ -11,25 +11,25 @@ #include #include #include -#include #include + namespace Aws { template class AmazonWebServiceResult; namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { class CreateBillScenarioResult { public: AWS_BCMPRICINGCALCULATOR_API CreateBillScenarioResult() = default; - AWS_BCMPRICINGCALCULATOR_API CreateBillScenarioResult(const Aws::AmazonWebServiceResult& result); - AWS_BCMPRICINGCALCULATOR_API CreateBillScenarioResult& operator=(const Aws::AmazonWebServiceResult& result); + AWS_BCMPRICINGCALCULATOR_API CreateBillScenarioResult(const Aws::AmazonWebServiceResult& result); + AWS_BCMPRICINGCALCULATOR_API CreateBillScenarioResult& operator=(const Aws::AmazonWebServiceResult& result); ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/CreateWorkloadEstimateResult.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/CreateWorkloadEstimateResult.h index a6c5ce8f6a07..03ad11b10183 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/CreateWorkloadEstimateResult.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/CreateWorkloadEstimateResult.h @@ -11,17 +11,17 @@ #include #include #include -#include #include + namespace Aws { template class AmazonWebServiceResult; namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -33,9 +33,9 @@ namespace Model { class CreateWorkloadEstimateResult { public: AWS_BCMPRICINGCALCULATOR_API CreateWorkloadEstimateResult() = default; - AWS_BCMPRICINGCALCULATOR_API CreateWorkloadEstimateResult(const Aws::AmazonWebServiceResult& result); + AWS_BCMPRICINGCALCULATOR_API CreateWorkloadEstimateResult(const Aws::AmazonWebServiceResult& result); AWS_BCMPRICINGCALCULATOR_API CreateWorkloadEstimateResult& operator=( - const Aws::AmazonWebServiceResult& result); + const Aws::AmazonWebServiceResult& result); ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/DeleteBillEstimateResult.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/DeleteBillEstimateResult.h index bfca3b2b4f92..3e29b9979b30 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/DeleteBillEstimateResult.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/DeleteBillEstimateResult.h @@ -7,25 +7,25 @@ #include #include #include -#include #include + namespace Aws { template class AmazonWebServiceResult; namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { class DeleteBillEstimateResult { public: AWS_BCMPRICINGCALCULATOR_API DeleteBillEstimateResult() = default; - AWS_BCMPRICINGCALCULATOR_API DeleteBillEstimateResult(const Aws::AmazonWebServiceResult& result); - AWS_BCMPRICINGCALCULATOR_API DeleteBillEstimateResult& operator=(const Aws::AmazonWebServiceResult& result); + AWS_BCMPRICINGCALCULATOR_API DeleteBillEstimateResult(const Aws::AmazonWebServiceResult& result); + AWS_BCMPRICINGCALCULATOR_API DeleteBillEstimateResult& operator=(const Aws::AmazonWebServiceResult& result); ///@{ diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/DeleteBillScenarioResult.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/DeleteBillScenarioResult.h index 2c1c96040df2..878604a32626 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/DeleteBillScenarioResult.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/DeleteBillScenarioResult.h @@ -7,25 +7,25 @@ #include #include #include -#include #include + namespace Aws { template class AmazonWebServiceResult; namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { class DeleteBillScenarioResult { public: AWS_BCMPRICINGCALCULATOR_API DeleteBillScenarioResult() = default; - AWS_BCMPRICINGCALCULATOR_API DeleteBillScenarioResult(const Aws::AmazonWebServiceResult& result); - AWS_BCMPRICINGCALCULATOR_API DeleteBillScenarioResult& operator=(const Aws::AmazonWebServiceResult& result); + AWS_BCMPRICINGCALCULATOR_API DeleteBillScenarioResult(const Aws::AmazonWebServiceResult& result); + AWS_BCMPRICINGCALCULATOR_API DeleteBillScenarioResult& operator=(const Aws::AmazonWebServiceResult& result); ///@{ diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/DeleteWorkloadEstimateResult.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/DeleteWorkloadEstimateResult.h index 14de127553b4..3ffda690675a 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/DeleteWorkloadEstimateResult.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/DeleteWorkloadEstimateResult.h @@ -7,26 +7,26 @@ #include #include #include -#include #include + namespace Aws { template class AmazonWebServiceResult; namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { class DeleteWorkloadEstimateResult { public: AWS_BCMPRICINGCALCULATOR_API DeleteWorkloadEstimateResult() = default; - AWS_BCMPRICINGCALCULATOR_API DeleteWorkloadEstimateResult(const Aws::AmazonWebServiceResult& result); + AWS_BCMPRICINGCALCULATOR_API DeleteWorkloadEstimateResult(const Aws::AmazonWebServiceResult& result); AWS_BCMPRICINGCALCULATOR_API DeleteWorkloadEstimateResult& operator=( - const Aws::AmazonWebServiceResult& result); + const Aws::AmazonWebServiceResult& result); ///@{ diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/Expression.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/Expression.h index e8ce99f8376c..5498402867de 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/Expression.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/Expression.h @@ -7,15 +7,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -29,9 +29,9 @@ namespace Model { class Expression { public: AWS_BCMPRICINGCALCULATOR_API Expression() = default; - AWS_BCMPRICINGCALCULATOR_API Expression(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API Expression& operator=(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API Expression(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Expression& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ExpressionFilter.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ExpressionFilter.h index eac5464fc091..6ff5034648a4 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ExpressionFilter.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ExpressionFilter.h @@ -7,15 +7,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -29,9 +29,9 @@ namespace Model { class ExpressionFilter { public: AWS_BCMPRICINGCALCULATOR_API ExpressionFilter() = default; - AWS_BCMPRICINGCALCULATOR_API ExpressionFilter(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API ExpressionFilter& operator=(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API ExpressionFilter(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API ExpressionFilter& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/FilterTimestamp.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/FilterTimestamp.h index f0ba840fb6f8..4052fb1485ba 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/FilterTimestamp.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/FilterTimestamp.h @@ -6,15 +6,15 @@ #pragma once #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -27,9 +27,9 @@ namespace Model { class FilterTimestamp { public: AWS_BCMPRICINGCALCULATOR_API FilterTimestamp() = default; - AWS_BCMPRICINGCALCULATOR_API FilterTimestamp(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API FilterTimestamp& operator=(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API FilterTimestamp(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API FilterTimestamp& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/GetBillEstimateResult.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/GetBillEstimateResult.h index 888748f0772f..62c91980efd0 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/GetBillEstimateResult.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/GetBillEstimateResult.h @@ -12,25 +12,25 @@ #include #include #include -#include #include + namespace Aws { template class AmazonWebServiceResult; namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { class GetBillEstimateResult { public: AWS_BCMPRICINGCALCULATOR_API GetBillEstimateResult() = default; - AWS_BCMPRICINGCALCULATOR_API GetBillEstimateResult(const Aws::AmazonWebServiceResult& result); - AWS_BCMPRICINGCALCULATOR_API GetBillEstimateResult& operator=(const Aws::AmazonWebServiceResult& result); + AWS_BCMPRICINGCALCULATOR_API GetBillEstimateResult(const Aws::AmazonWebServiceResult& result); + AWS_BCMPRICINGCALCULATOR_API GetBillEstimateResult& operator=(const Aws::AmazonWebServiceResult& result); ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/GetBillScenarioResult.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/GetBillScenarioResult.h index 6b8cc51bcd43..cc2a89252c67 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/GetBillScenarioResult.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/GetBillScenarioResult.h @@ -11,25 +11,25 @@ #include #include #include -#include #include + namespace Aws { template class AmazonWebServiceResult; namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { class GetBillScenarioResult { public: AWS_BCMPRICINGCALCULATOR_API GetBillScenarioResult() = default; - AWS_BCMPRICINGCALCULATOR_API GetBillScenarioResult(const Aws::AmazonWebServiceResult& result); - AWS_BCMPRICINGCALCULATOR_API GetBillScenarioResult& operator=(const Aws::AmazonWebServiceResult& result); + AWS_BCMPRICINGCALCULATOR_API GetBillScenarioResult(const Aws::AmazonWebServiceResult& result); + AWS_BCMPRICINGCALCULATOR_API GetBillScenarioResult& operator=(const Aws::AmazonWebServiceResult& result); ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/GetPreferencesResult.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/GetPreferencesResult.h index 6da39bd0808c..87520aae014e 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/GetPreferencesResult.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/GetPreferencesResult.h @@ -9,25 +9,25 @@ #include #include #include -#include #include + namespace Aws { template class AmazonWebServiceResult; namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { class GetPreferencesResult { public: AWS_BCMPRICINGCALCULATOR_API GetPreferencesResult() = default; - AWS_BCMPRICINGCALCULATOR_API GetPreferencesResult(const Aws::AmazonWebServiceResult& result); - AWS_BCMPRICINGCALCULATOR_API GetPreferencesResult& operator=(const Aws::AmazonWebServiceResult& result); + AWS_BCMPRICINGCALCULATOR_API GetPreferencesResult(const Aws::AmazonWebServiceResult& result); + AWS_BCMPRICINGCALCULATOR_API GetPreferencesResult& operator=(const Aws::AmazonWebServiceResult& result); ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/GetWorkloadEstimateResult.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/GetWorkloadEstimateResult.h index 697de9ac75f6..744f4e22f031 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/GetWorkloadEstimateResult.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/GetWorkloadEstimateResult.h @@ -11,17 +11,17 @@ #include #include #include -#include #include + namespace Aws { template class AmazonWebServiceResult; namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -33,8 +33,8 @@ namespace Model { class GetWorkloadEstimateResult { public: AWS_BCMPRICINGCALCULATOR_API GetWorkloadEstimateResult() = default; - AWS_BCMPRICINGCALCULATOR_API GetWorkloadEstimateResult(const Aws::AmazonWebServiceResult& result); - AWS_BCMPRICINGCALCULATOR_API GetWorkloadEstimateResult& operator=(const Aws::AmazonWebServiceResult& result); + AWS_BCMPRICINGCALCULATOR_API GetWorkloadEstimateResult(const Aws::AmazonWebServiceResult& result); + AWS_BCMPRICINGCALCULATOR_API GetWorkloadEstimateResult& operator=(const Aws::AmazonWebServiceResult& result); ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/HistoricalUsageEntity.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/HistoricalUsageEntity.h index 80763afea01c..39768c7d5baf 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/HistoricalUsageEntity.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/HistoricalUsageEntity.h @@ -8,15 +8,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -30,9 +30,9 @@ namespace Model { class HistoricalUsageEntity { public: AWS_BCMPRICINGCALCULATOR_API HistoricalUsageEntity() = default; - AWS_BCMPRICINGCALCULATOR_API HistoricalUsageEntity(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API HistoricalUsageEntity& operator=(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API HistoricalUsageEntity(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API HistoricalUsageEntity& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/InternalServerException.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/InternalServerException.h index d0934f7067e7..f07477c9f838 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/InternalServerException.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/InternalServerException.h @@ -6,15 +6,15 @@ #pragma once #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -28,9 +28,9 @@ namespace Model { class InternalServerException { public: AWS_BCMPRICINGCALCULATOR_API InternalServerException() = default; - AWS_BCMPRICINGCALCULATOR_API InternalServerException(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API InternalServerException& operator=(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API InternalServerException(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API InternalServerException& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ @@ -53,13 +53,13 @@ class InternalServerException { *

An internal error has occurred. Retry your request, but if the problem * persists, contact Amazon Web Services support.

*/ - inline int64_t GetRetryAfterSeconds() const { return m_retryAfterSeconds; } + inline int GetRetryAfterSeconds() const { return m_retryAfterSeconds; } inline bool RetryAfterSecondsHasBeenSet() const { return m_retryAfterSecondsHasBeenSet; } - inline void SetRetryAfterSeconds(int64_t value) { + inline void SetRetryAfterSeconds(int value) { m_retryAfterSecondsHasBeenSet = true; m_retryAfterSeconds = value; } - inline InternalServerException& WithRetryAfterSeconds(int64_t value) { + inline InternalServerException& WithRetryAfterSeconds(int value) { SetRetryAfterSeconds(value); return *this; } @@ -67,7 +67,7 @@ class InternalServerException { private: Aws::String m_message; - int64_t m_retryAfterSeconds{0}; + int m_retryAfterSeconds{0}; bool m_messageHasBeenSet = false; bool m_retryAfterSecondsHasBeenSet = false; }; diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillEstimateCommitmentsResult.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillEstimateCommitmentsResult.h index 53a363cc21e5..8d1d4c67c235 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillEstimateCommitmentsResult.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillEstimateCommitmentsResult.h @@ -9,26 +9,26 @@ #include #include #include -#include #include + namespace Aws { template class AmazonWebServiceResult; namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { class ListBillEstimateCommitmentsResult { public: AWS_BCMPRICINGCALCULATOR_API ListBillEstimateCommitmentsResult() = default; - AWS_BCMPRICINGCALCULATOR_API ListBillEstimateCommitmentsResult(const Aws::AmazonWebServiceResult& result); + AWS_BCMPRICINGCALCULATOR_API ListBillEstimateCommitmentsResult(const Aws::AmazonWebServiceResult& result); AWS_BCMPRICINGCALCULATOR_API ListBillEstimateCommitmentsResult& operator=( - const Aws::AmazonWebServiceResult& result); + const Aws::AmazonWebServiceResult& result); ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillEstimateInputCommitmentModificationsResult.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillEstimateInputCommitmentModificationsResult.h index 0c74c50c50ac..0f24ceb14960 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillEstimateInputCommitmentModificationsResult.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillEstimateInputCommitmentModificationsResult.h @@ -9,17 +9,17 @@ #include #include #include -#include #include + namespace Aws { template class AmazonWebServiceResult; namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -27,9 +27,9 @@ class ListBillEstimateInputCommitmentModificationsResult { public: AWS_BCMPRICINGCALCULATOR_API ListBillEstimateInputCommitmentModificationsResult() = default; AWS_BCMPRICINGCALCULATOR_API ListBillEstimateInputCommitmentModificationsResult( - const Aws::AmazonWebServiceResult& result); + const Aws::AmazonWebServiceResult& result); AWS_BCMPRICINGCALCULATOR_API ListBillEstimateInputCommitmentModificationsResult& operator=( - const Aws::AmazonWebServiceResult& result); + const Aws::AmazonWebServiceResult& result); ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillEstimateInputUsageModificationsResult.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillEstimateInputUsageModificationsResult.h index 9a7a873d8f62..aa30944c5f43 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillEstimateInputUsageModificationsResult.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillEstimateInputUsageModificationsResult.h @@ -9,17 +9,17 @@ #include #include #include -#include #include + namespace Aws { template class AmazonWebServiceResult; namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -27,9 +27,9 @@ class ListBillEstimateInputUsageModificationsResult { public: AWS_BCMPRICINGCALCULATOR_API ListBillEstimateInputUsageModificationsResult() = default; AWS_BCMPRICINGCALCULATOR_API ListBillEstimateInputUsageModificationsResult( - const Aws::AmazonWebServiceResult& result); + const Aws::AmazonWebServiceResult& result); AWS_BCMPRICINGCALCULATOR_API ListBillEstimateInputUsageModificationsResult& operator=( - const Aws::AmazonWebServiceResult& result); + const Aws::AmazonWebServiceResult& result); ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillEstimateLineItemsFilter.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillEstimateLineItemsFilter.h index 0658d7e7bac3..65cb724abf0c 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillEstimateLineItemsFilter.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillEstimateLineItemsFilter.h @@ -9,15 +9,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -31,9 +31,9 @@ namespace Model { class ListBillEstimateLineItemsFilter { public: AWS_BCMPRICINGCALCULATOR_API ListBillEstimateLineItemsFilter() = default; - AWS_BCMPRICINGCALCULATOR_API ListBillEstimateLineItemsFilter(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API ListBillEstimateLineItemsFilter& operator=(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API ListBillEstimateLineItemsFilter(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API ListBillEstimateLineItemsFilter& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillEstimateLineItemsResult.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillEstimateLineItemsResult.h index 4183f287f669..63be266069b9 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillEstimateLineItemsResult.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillEstimateLineItemsResult.h @@ -9,26 +9,26 @@ #include #include #include -#include #include + namespace Aws { template class AmazonWebServiceResult; namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { class ListBillEstimateLineItemsResult { public: AWS_BCMPRICINGCALCULATOR_API ListBillEstimateLineItemsResult() = default; - AWS_BCMPRICINGCALCULATOR_API ListBillEstimateLineItemsResult(const Aws::AmazonWebServiceResult& result); + AWS_BCMPRICINGCALCULATOR_API ListBillEstimateLineItemsResult(const Aws::AmazonWebServiceResult& result); AWS_BCMPRICINGCALCULATOR_API ListBillEstimateLineItemsResult& operator=( - const Aws::AmazonWebServiceResult& result); + const Aws::AmazonWebServiceResult& result); ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillEstimatesFilter.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillEstimatesFilter.h index c982ebda8e92..70731a7efd8e 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillEstimatesFilter.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillEstimatesFilter.h @@ -9,15 +9,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -31,9 +31,9 @@ namespace Model { class ListBillEstimatesFilter { public: AWS_BCMPRICINGCALCULATOR_API ListBillEstimatesFilter() = default; - AWS_BCMPRICINGCALCULATOR_API ListBillEstimatesFilter(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API ListBillEstimatesFilter& operator=(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API ListBillEstimatesFilter(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API ListBillEstimatesFilter& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillEstimatesResult.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillEstimatesResult.h index ff53170f8a9b..7aca721308a4 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillEstimatesResult.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillEstimatesResult.h @@ -9,25 +9,25 @@ #include #include #include -#include #include + namespace Aws { template class AmazonWebServiceResult; namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { class ListBillEstimatesResult { public: AWS_BCMPRICINGCALCULATOR_API ListBillEstimatesResult() = default; - AWS_BCMPRICINGCALCULATOR_API ListBillEstimatesResult(const Aws::AmazonWebServiceResult& result); - AWS_BCMPRICINGCALCULATOR_API ListBillEstimatesResult& operator=(const Aws::AmazonWebServiceResult& result); + AWS_BCMPRICINGCALCULATOR_API ListBillEstimatesResult(const Aws::AmazonWebServiceResult& result); + AWS_BCMPRICINGCALCULATOR_API ListBillEstimatesResult& operator=(const Aws::AmazonWebServiceResult& result); ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillScenarioCommitmentModificationsResult.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillScenarioCommitmentModificationsResult.h index 7954c8f3ecf9..125883f48438 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillScenarioCommitmentModificationsResult.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillScenarioCommitmentModificationsResult.h @@ -9,17 +9,17 @@ #include #include #include -#include #include + namespace Aws { template class AmazonWebServiceResult; namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -27,9 +27,9 @@ class ListBillScenarioCommitmentModificationsResult { public: AWS_BCMPRICINGCALCULATOR_API ListBillScenarioCommitmentModificationsResult() = default; AWS_BCMPRICINGCALCULATOR_API ListBillScenarioCommitmentModificationsResult( - const Aws::AmazonWebServiceResult& result); + const Aws::AmazonWebServiceResult& result); AWS_BCMPRICINGCALCULATOR_API ListBillScenarioCommitmentModificationsResult& operator=( - const Aws::AmazonWebServiceResult& result); + const Aws::AmazonWebServiceResult& result); ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillScenarioUsageModificationsResult.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillScenarioUsageModificationsResult.h index d44617634c9c..d7d096a07077 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillScenarioUsageModificationsResult.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillScenarioUsageModificationsResult.h @@ -9,17 +9,17 @@ #include #include #include -#include #include + namespace Aws { template class AmazonWebServiceResult; namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -27,9 +27,9 @@ class ListBillScenarioUsageModificationsResult { public: AWS_BCMPRICINGCALCULATOR_API ListBillScenarioUsageModificationsResult() = default; AWS_BCMPRICINGCALCULATOR_API ListBillScenarioUsageModificationsResult( - const Aws::AmazonWebServiceResult& result); + const Aws::AmazonWebServiceResult& result); AWS_BCMPRICINGCALCULATOR_API ListBillScenarioUsageModificationsResult& operator=( - const Aws::AmazonWebServiceResult& result); + const Aws::AmazonWebServiceResult& result); ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillScenariosFilter.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillScenariosFilter.h index 2de169e188f4..9efb1bf617ed 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillScenariosFilter.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillScenariosFilter.h @@ -9,15 +9,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -31,9 +31,9 @@ namespace Model { class ListBillScenariosFilter { public: AWS_BCMPRICINGCALCULATOR_API ListBillScenariosFilter() = default; - AWS_BCMPRICINGCALCULATOR_API ListBillScenariosFilter(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API ListBillScenariosFilter& operator=(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API ListBillScenariosFilter(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API ListBillScenariosFilter& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillScenariosResult.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillScenariosResult.h index e8696ba5bc9b..efe6d2042c83 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillScenariosResult.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListBillScenariosResult.h @@ -9,25 +9,25 @@ #include #include #include -#include #include + namespace Aws { template class AmazonWebServiceResult; namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { class ListBillScenariosResult { public: AWS_BCMPRICINGCALCULATOR_API ListBillScenariosResult() = default; - AWS_BCMPRICINGCALCULATOR_API ListBillScenariosResult(const Aws::AmazonWebServiceResult& result); - AWS_BCMPRICINGCALCULATOR_API ListBillScenariosResult& operator=(const Aws::AmazonWebServiceResult& result); + AWS_BCMPRICINGCALCULATOR_API ListBillScenariosResult(const Aws::AmazonWebServiceResult& result); + AWS_BCMPRICINGCALCULATOR_API ListBillScenariosResult& operator=(const Aws::AmazonWebServiceResult& result); ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListTagsForResourceResult.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListTagsForResourceResult.h index 00fb6d5cfaca..254808c6a732 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListTagsForResourceResult.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListTagsForResourceResult.h @@ -8,25 +8,25 @@ #include #include #include -#include #include + namespace Aws { template class AmazonWebServiceResult; namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { class ListTagsForResourceResult { public: AWS_BCMPRICINGCALCULATOR_API ListTagsForResourceResult() = default; - AWS_BCMPRICINGCALCULATOR_API ListTagsForResourceResult(const Aws::AmazonWebServiceResult& result); - AWS_BCMPRICINGCALCULATOR_API ListTagsForResourceResult& operator=(const Aws::AmazonWebServiceResult& result); + AWS_BCMPRICINGCALCULATOR_API ListTagsForResourceResult(const Aws::AmazonWebServiceResult& result); + AWS_BCMPRICINGCALCULATOR_API ListTagsForResourceResult& operator=(const Aws::AmazonWebServiceResult& result); ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListUsageFilter.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListUsageFilter.h index f64694f0af33..fc6bea7ba384 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListUsageFilter.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListUsageFilter.h @@ -9,15 +9,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -30,9 +30,9 @@ namespace Model { class ListUsageFilter { public: AWS_BCMPRICINGCALCULATOR_API ListUsageFilter() = default; - AWS_BCMPRICINGCALCULATOR_API ListUsageFilter(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API ListUsageFilter& operator=(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API ListUsageFilter(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API ListUsageFilter& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListWorkloadEstimateUsageResult.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListWorkloadEstimateUsageResult.h index f65195202f4a..9d6cedb19f3f 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListWorkloadEstimateUsageResult.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListWorkloadEstimateUsageResult.h @@ -9,26 +9,26 @@ #include #include #include -#include #include + namespace Aws { template class AmazonWebServiceResult; namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { class ListWorkloadEstimateUsageResult { public: AWS_BCMPRICINGCALCULATOR_API ListWorkloadEstimateUsageResult() = default; - AWS_BCMPRICINGCALCULATOR_API ListWorkloadEstimateUsageResult(const Aws::AmazonWebServiceResult& result); + AWS_BCMPRICINGCALCULATOR_API ListWorkloadEstimateUsageResult(const Aws::AmazonWebServiceResult& result); AWS_BCMPRICINGCALCULATOR_API ListWorkloadEstimateUsageResult& operator=( - const Aws::AmazonWebServiceResult& result); + const Aws::AmazonWebServiceResult& result); ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListWorkloadEstimatesFilter.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListWorkloadEstimatesFilter.h index 6457cd68e23e..a9379f1f46fa 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListWorkloadEstimatesFilter.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListWorkloadEstimatesFilter.h @@ -9,15 +9,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -31,9 +31,9 @@ namespace Model { class ListWorkloadEstimatesFilter { public: AWS_BCMPRICINGCALCULATOR_API ListWorkloadEstimatesFilter() = default; - AWS_BCMPRICINGCALCULATOR_API ListWorkloadEstimatesFilter(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API ListWorkloadEstimatesFilter& operator=(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API ListWorkloadEstimatesFilter(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API ListWorkloadEstimatesFilter& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListWorkloadEstimatesResult.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListWorkloadEstimatesResult.h index 23187a9aca61..3473784d5a27 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListWorkloadEstimatesResult.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ListWorkloadEstimatesResult.h @@ -9,26 +9,26 @@ #include #include #include -#include #include + namespace Aws { template class AmazonWebServiceResult; namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { class ListWorkloadEstimatesResult { public: AWS_BCMPRICINGCALCULATOR_API ListWorkloadEstimatesResult() = default; - AWS_BCMPRICINGCALCULATOR_API ListWorkloadEstimatesResult(const Aws::AmazonWebServiceResult& result); + AWS_BCMPRICINGCALCULATOR_API ListWorkloadEstimatesResult(const Aws::AmazonWebServiceResult& result); AWS_BCMPRICINGCALCULATOR_API ListWorkloadEstimatesResult& operator=( - const Aws::AmazonWebServiceResult& result); + const Aws::AmazonWebServiceResult& result); ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/NegateReservedInstanceAction.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/NegateReservedInstanceAction.h index 551af6e6eaaa..08e0e80b5279 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/NegateReservedInstanceAction.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/NegateReservedInstanceAction.h @@ -6,15 +6,15 @@ #pragma once #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -29,9 +29,9 @@ namespace Model { class NegateReservedInstanceAction { public: AWS_BCMPRICINGCALCULATOR_API NegateReservedInstanceAction() = default; - AWS_BCMPRICINGCALCULATOR_API NegateReservedInstanceAction(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API NegateReservedInstanceAction& operator=(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API NegateReservedInstanceAction(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API NegateReservedInstanceAction& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/NegateSavingsPlanAction.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/NegateSavingsPlanAction.h index 72cafca83716..e13768cfb507 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/NegateSavingsPlanAction.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/NegateSavingsPlanAction.h @@ -6,15 +6,15 @@ #pragma once #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -29,9 +29,9 @@ namespace Model { class NegateSavingsPlanAction { public: AWS_BCMPRICINGCALCULATOR_API NegateSavingsPlanAction() = default; - AWS_BCMPRICINGCALCULATOR_API NegateSavingsPlanAction(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API NegateSavingsPlanAction& operator=(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API NegateSavingsPlanAction(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API NegateSavingsPlanAction& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ResourceNotFoundException.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ResourceNotFoundException.h index caf1baa96faa..ac6ccb5c782b 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ResourceNotFoundException.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ResourceNotFoundException.h @@ -6,15 +6,15 @@ #pragma once #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -27,9 +27,9 @@ namespace Model { class ResourceNotFoundException { public: AWS_BCMPRICINGCALCULATOR_API ResourceNotFoundException() = default; - AWS_BCMPRICINGCALCULATOR_API ResourceNotFoundException(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API ResourceNotFoundException& operator=(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API ResourceNotFoundException(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API ResourceNotFoundException& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ServiceQuotaExceededException.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ServiceQuotaExceededException.h index 5fe883a1ac44..4b604700d819 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ServiceQuotaExceededException.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ServiceQuotaExceededException.h @@ -6,15 +6,15 @@ #pragma once #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -28,9 +28,9 @@ namespace Model { class ServiceQuotaExceededException { public: AWS_BCMPRICINGCALCULATOR_API ServiceQuotaExceededException() = default; - AWS_BCMPRICINGCALCULATOR_API ServiceQuotaExceededException(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API ServiceQuotaExceededException& operator=(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API ServiceQuotaExceededException(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API ServiceQuotaExceededException& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/TagResourceResult.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/TagResourceResult.h index 72267149e6da..622f90778818 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/TagResourceResult.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/TagResourceResult.h @@ -7,25 +7,25 @@ #include #include #include -#include #include + namespace Aws { template class AmazonWebServiceResult; namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { class TagResourceResult { public: AWS_BCMPRICINGCALCULATOR_API TagResourceResult() = default; - AWS_BCMPRICINGCALCULATOR_API TagResourceResult(const Aws::AmazonWebServiceResult& result); - AWS_BCMPRICINGCALCULATOR_API TagResourceResult& operator=(const Aws::AmazonWebServiceResult& result); + AWS_BCMPRICINGCALCULATOR_API TagResourceResult(const Aws::AmazonWebServiceResult& result); + AWS_BCMPRICINGCALCULATOR_API TagResourceResult& operator=(const Aws::AmazonWebServiceResult& result); ///@{ diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ThrottlingException.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ThrottlingException.h index 3899985f2276..0de2b261285f 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ThrottlingException.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ThrottlingException.h @@ -6,15 +6,15 @@ #pragma once #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -28,9 +28,9 @@ namespace Model { class ThrottlingException { public: AWS_BCMPRICINGCALCULATOR_API ThrottlingException() = default; - AWS_BCMPRICINGCALCULATOR_API ThrottlingException(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API ThrottlingException& operator=(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API ThrottlingException(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API ThrottlingException& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ @@ -89,13 +89,13 @@ class ThrottlingException { *

The service code that exceeded the throttling limit. Retry your request, but * if the problem persists, contact Amazon Web Services support.

*/ - inline int64_t GetRetryAfterSeconds() const { return m_retryAfterSeconds; } + inline int GetRetryAfterSeconds() const { return m_retryAfterSeconds; } inline bool RetryAfterSecondsHasBeenSet() const { return m_retryAfterSecondsHasBeenSet; } - inline void SetRetryAfterSeconds(int64_t value) { + inline void SetRetryAfterSeconds(int value) { m_retryAfterSecondsHasBeenSet = true; m_retryAfterSeconds = value; } - inline ThrottlingException& WithRetryAfterSeconds(int64_t value) { + inline ThrottlingException& WithRetryAfterSeconds(int value) { SetRetryAfterSeconds(value); return *this; } @@ -107,7 +107,7 @@ class ThrottlingException { Aws::String m_quotaCode; - int64_t m_retryAfterSeconds{0}; + int m_retryAfterSeconds{0}; bool m_messageHasBeenSet = false; bool m_serviceCodeHasBeenSet = false; bool m_quotaCodeHasBeenSet = false; diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/UntagResourceResult.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/UntagResourceResult.h index d2feafbf96ef..dbaa8c9c41df 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/UntagResourceResult.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/UntagResourceResult.h @@ -7,25 +7,25 @@ #include #include #include -#include #include + namespace Aws { template class AmazonWebServiceResult; namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { class UntagResourceResult { public: AWS_BCMPRICINGCALCULATOR_API UntagResourceResult() = default; - AWS_BCMPRICINGCALCULATOR_API UntagResourceResult(const Aws::AmazonWebServiceResult& result); - AWS_BCMPRICINGCALCULATOR_API UntagResourceResult& operator=(const Aws::AmazonWebServiceResult& result); + AWS_BCMPRICINGCALCULATOR_API UntagResourceResult(const Aws::AmazonWebServiceResult& result); + AWS_BCMPRICINGCALCULATOR_API UntagResourceResult& operator=(const Aws::AmazonWebServiceResult& result); ///@{ diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/UpdateBillEstimateResult.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/UpdateBillEstimateResult.h index 31d9ffea74de..affeb4b9d93f 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/UpdateBillEstimateResult.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/UpdateBillEstimateResult.h @@ -12,25 +12,25 @@ #include #include #include -#include #include + namespace Aws { template class AmazonWebServiceResult; namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { class UpdateBillEstimateResult { public: AWS_BCMPRICINGCALCULATOR_API UpdateBillEstimateResult() = default; - AWS_BCMPRICINGCALCULATOR_API UpdateBillEstimateResult(const Aws::AmazonWebServiceResult& result); - AWS_BCMPRICINGCALCULATOR_API UpdateBillEstimateResult& operator=(const Aws::AmazonWebServiceResult& result); + AWS_BCMPRICINGCALCULATOR_API UpdateBillEstimateResult(const Aws::AmazonWebServiceResult& result); + AWS_BCMPRICINGCALCULATOR_API UpdateBillEstimateResult& operator=(const Aws::AmazonWebServiceResult& result); ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/UpdateBillScenarioResult.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/UpdateBillScenarioResult.h index ce57c708c595..e1a91b830e3d 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/UpdateBillScenarioResult.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/UpdateBillScenarioResult.h @@ -11,25 +11,25 @@ #include #include #include -#include #include + namespace Aws { template class AmazonWebServiceResult; namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { class UpdateBillScenarioResult { public: AWS_BCMPRICINGCALCULATOR_API UpdateBillScenarioResult() = default; - AWS_BCMPRICINGCALCULATOR_API UpdateBillScenarioResult(const Aws::AmazonWebServiceResult& result); - AWS_BCMPRICINGCALCULATOR_API UpdateBillScenarioResult& operator=(const Aws::AmazonWebServiceResult& result); + AWS_BCMPRICINGCALCULATOR_API UpdateBillScenarioResult(const Aws::AmazonWebServiceResult& result); + AWS_BCMPRICINGCALCULATOR_API UpdateBillScenarioResult& operator=(const Aws::AmazonWebServiceResult& result); ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/UpdatePreferencesResult.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/UpdatePreferencesResult.h index f950c6945436..51920453a137 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/UpdatePreferencesResult.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/UpdatePreferencesResult.h @@ -9,25 +9,25 @@ #include #include #include -#include #include + namespace Aws { template class AmazonWebServiceResult; namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { class UpdatePreferencesResult { public: AWS_BCMPRICINGCALCULATOR_API UpdatePreferencesResult() = default; - AWS_BCMPRICINGCALCULATOR_API UpdatePreferencesResult(const Aws::AmazonWebServiceResult& result); - AWS_BCMPRICINGCALCULATOR_API UpdatePreferencesResult& operator=(const Aws::AmazonWebServiceResult& result); + AWS_BCMPRICINGCALCULATOR_API UpdatePreferencesResult(const Aws::AmazonWebServiceResult& result); + AWS_BCMPRICINGCALCULATOR_API UpdatePreferencesResult& operator=(const Aws::AmazonWebServiceResult& result); ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/UpdateWorkloadEstimateResult.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/UpdateWorkloadEstimateResult.h index b0f27f6e43c4..4be559a13dc3 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/UpdateWorkloadEstimateResult.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/UpdateWorkloadEstimateResult.h @@ -11,17 +11,17 @@ #include #include #include -#include #include + namespace Aws { template class AmazonWebServiceResult; namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -33,9 +33,9 @@ namespace Model { class UpdateWorkloadEstimateResult { public: AWS_BCMPRICINGCALCULATOR_API UpdateWorkloadEstimateResult() = default; - AWS_BCMPRICINGCALCULATOR_API UpdateWorkloadEstimateResult(const Aws::AmazonWebServiceResult& result); + AWS_BCMPRICINGCALCULATOR_API UpdateWorkloadEstimateResult(const Aws::AmazonWebServiceResult& result); AWS_BCMPRICINGCALCULATOR_API UpdateWorkloadEstimateResult& operator=( - const Aws::AmazonWebServiceResult& result); + const Aws::AmazonWebServiceResult& result); ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/UsageAmount.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/UsageAmount.h index 687547f0df79..e16368bfd88d 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/UsageAmount.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/UsageAmount.h @@ -6,15 +6,15 @@ #pragma once #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -28,9 +28,9 @@ namespace Model { class UsageAmount { public: AWS_BCMPRICINGCALCULATOR_API UsageAmount() = default; - AWS_BCMPRICINGCALCULATOR_API UsageAmount(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API UsageAmount& operator=(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API UsageAmount(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API UsageAmount& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/UsageQuantity.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/UsageQuantity.h index c639be54c6f2..45a138c79221 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/UsageQuantity.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/UsageQuantity.h @@ -7,15 +7,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -29,9 +29,9 @@ namespace Model { class UsageQuantity { public: AWS_BCMPRICINGCALCULATOR_API UsageQuantity() = default; - AWS_BCMPRICINGCALCULATOR_API UsageQuantity(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API UsageQuantity& operator=(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API UsageQuantity(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API UsageQuantity& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/UsageQuantityResult.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/UsageQuantityResult.h index 54e674b8d1ad..9ac0d6fd0a46 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/UsageQuantityResult.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/UsageQuantityResult.h @@ -6,15 +6,15 @@ #pragma once #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -28,9 +28,9 @@ namespace Model { class UsageQuantityResult { public: AWS_BCMPRICINGCALCULATOR_API UsageQuantityResult() = default; - AWS_BCMPRICINGCALCULATOR_API UsageQuantityResult(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API UsageQuantityResult& operator=(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API UsageQuantityResult(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API UsageQuantityResult& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ValidationException.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ValidationException.h index 4a2691c01f99..0cf0e0ae4f8d 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ValidationException.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ValidationException.h @@ -9,15 +9,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -31,9 +31,9 @@ namespace Model { class ValidationException { public: AWS_BCMPRICINGCALCULATOR_API ValidationException() = default; - AWS_BCMPRICINGCALCULATOR_API ValidationException(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API ValidationException& operator=(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API ValidationException(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API ValidationException& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ValidationExceptionField.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ValidationExceptionField.h index ad00425bd155..cd89643384b5 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ValidationExceptionField.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/ValidationExceptionField.h @@ -6,15 +6,15 @@ #pragma once #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -28,9 +28,9 @@ namespace Model { class ValidationExceptionField { public: AWS_BCMPRICINGCALCULATOR_API ValidationExceptionField() = default; - AWS_BCMPRICINGCALCULATOR_API ValidationExceptionField(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API ValidationExceptionField& operator=(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API ValidationExceptionField(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API ValidationExceptionField& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/WorkloadEstimateSummary.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/WorkloadEstimateSummary.h index 211de0296385..381d79ca4063 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/WorkloadEstimateSummary.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/WorkloadEstimateSummary.h @@ -10,15 +10,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -31,9 +31,9 @@ namespace Model { class WorkloadEstimateSummary { public: AWS_BCMPRICINGCALCULATOR_API WorkloadEstimateSummary() = default; - AWS_BCMPRICINGCALCULATOR_API WorkloadEstimateSummary(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API WorkloadEstimateSummary& operator=(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API WorkloadEstimateSummary(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API WorkloadEstimateSummary& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/WorkloadEstimateUsageItem.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/WorkloadEstimateUsageItem.h index a766d174ecec..ac4fb413885e 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/WorkloadEstimateUsageItem.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/WorkloadEstimateUsageItem.h @@ -10,15 +10,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -32,9 +32,9 @@ namespace Model { class WorkloadEstimateUsageItem { public: AWS_BCMPRICINGCALCULATOR_API WorkloadEstimateUsageItem() = default; - AWS_BCMPRICINGCALCULATOR_API WorkloadEstimateUsageItem(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API WorkloadEstimateUsageItem& operator=(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API WorkloadEstimateUsageItem(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API WorkloadEstimateUsageItem& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/WorkloadEstimateUsageQuantity.h b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/WorkloadEstimateUsageQuantity.h index 9186dc2f5997..2511127a947c 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/WorkloadEstimateUsageQuantity.h +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/include/aws/bcm-pricing-calculator/model/WorkloadEstimateUsageQuantity.h @@ -6,15 +6,15 @@ #pragma once #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMPricingCalculator { namespace Model { @@ -28,9 +28,9 @@ namespace Model { class WorkloadEstimateUsageQuantity { public: AWS_BCMPRICINGCALCULATOR_API WorkloadEstimateUsageQuantity() = default; - AWS_BCMPRICINGCALCULATOR_API WorkloadEstimateUsageQuantity(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API WorkloadEstimateUsageQuantity& operator=(const std::shared_ptr& decoder); - AWS_BCMPRICINGCALCULATOR_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMPRICINGCALCULATOR_API WorkloadEstimateUsageQuantity(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API WorkloadEstimateUsageQuantity& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMPRICINGCALCULATOR_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/BCMPricingCalculatorClient.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/BCMPricingCalculatorClient.cpp index 4d32efb3f102..ab6bbf1128d8 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/BCMPricingCalculatorClient.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/BCMPricingCalculatorClient.cpp @@ -210,9 +210,6 @@ BCMPricingCalculatorClient::InvokeOperationOutcome BCMPricingCalculatorClient::I AWS_OPERATION_CHECK_SUCCESS_DYNAMIC(endpointResolutionOutcome, operationName, CoreErrors, CoreErrors::ENDPOINT_RESOLUTION_FAILURE, endpointResolutionOutcome.GetError().GetMessage()); - endpointResolutionOutcome.GetResult().AddPathSegments("/service/AWSBCMPricingCalculator/operation/"); - endpointResolutionOutcome.GetResult().AddPathSegment(operationName); - return InvokeOperationOutcome{MakeRequest(request, endpointResolutionOutcome.GetResult(), httpMethod, Aws::Auth::SIGV4_SIGNER)}; }, TracingUtils::SMITHY_CLIENT_DURATION_METRIC, *meter, diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/BCMPricingCalculatorErrors.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/BCMPricingCalculatorErrors.cpp index 4c6635d07466..ddf75b486097 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/BCMPricingCalculatorErrors.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/BCMPricingCalculatorErrors.cpp @@ -4,15 +4,58 @@ */ #include +#include +#include +#include +#include +#include +#include #include #include using namespace Aws::Client; using namespace Aws::Utils; using namespace Aws::BCMPricingCalculator; +using namespace Aws::BCMPricingCalculator::Model; namespace Aws { namespace BCMPricingCalculator { +template <> +AWS_BCMPRICINGCALCULATOR_API ConflictException BCMPricingCalculatorError::GetModeledError() { + assert(this->GetErrorType() == BCMPricingCalculatorErrors::CONFLICT); + return ConflictException(this->GetJsonPayload().View()); +} + +template <> +AWS_BCMPRICINGCALCULATOR_API ThrottlingException BCMPricingCalculatorError::GetModeledError() { + assert(this->GetErrorType() == BCMPricingCalculatorErrors::THROTTLING); + return ThrottlingException(this->GetJsonPayload().View()); +} + +template <> +AWS_BCMPRICINGCALCULATOR_API ServiceQuotaExceededException BCMPricingCalculatorError::GetModeledError() { + assert(this->GetErrorType() == BCMPricingCalculatorErrors::SERVICE_QUOTA_EXCEEDED); + return ServiceQuotaExceededException(this->GetJsonPayload().View()); +} + +template <> +AWS_BCMPRICINGCALCULATOR_API InternalServerException BCMPricingCalculatorError::GetModeledError() { + assert(this->GetErrorType() == BCMPricingCalculatorErrors::INTERNAL_SERVER); + return InternalServerException(this->GetJsonPayload().View()); +} + +template <> +AWS_BCMPRICINGCALCULATOR_API ResourceNotFoundException BCMPricingCalculatorError::GetModeledError() { + assert(this->GetErrorType() == BCMPricingCalculatorErrors::RESOURCE_NOT_FOUND); + return ResourceNotFoundException(this->GetJsonPayload().View()); +} + +template <> +AWS_BCMPRICINGCALCULATOR_API ValidationException BCMPricingCalculatorError::GetModeledError() { + assert(this->GetErrorType() == BCMPricingCalculatorErrors::VALIDATION); + return ValidationException(this->GetJsonPayload().View()); +} + namespace BCMPricingCalculatorErrorMapper { static const int CONFLICT_HASH = HashingUtils::HashString("ConflictException"); @@ -28,7 +71,7 @@ AWSError GetErrorForName(const char* errorName) { } else if (hashCode == SERVICE_QUOTA_EXCEEDED_HASH) { return AWSError(static_cast(BCMPricingCalculatorErrors::SERVICE_QUOTA_EXCEEDED), RetryableType::NOT_RETRYABLE); } else if (hashCode == INTERNAL_SERVER_HASH) { - return AWSError(static_cast(BCMPricingCalculatorErrors::INTERNAL_SERVER), RetryableType::RETRYABLE); + return AWSError(static_cast(BCMPricingCalculatorErrors::INTERNAL_SERVER), RetryableType::NOT_RETRYABLE); } else if (hashCode == DATA_UNAVAILABLE_HASH) { return AWSError(static_cast(BCMPricingCalculatorErrors::DATA_UNAVAILABLE), RetryableType::NOT_RETRYABLE); } diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/AddReservedInstanceAction.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/AddReservedInstanceAction.cpp index 3f709f085b3c..881e24ff43ec 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/AddReservedInstanceAction.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/AddReservedInstanceAction.cpp @@ -4,187 +4,45 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -AddReservedInstanceAction::AddReservedInstanceAction(const std::shared_ptr& decoder) { *this = decoder; } +AddReservedInstanceAction::AddReservedInstanceAction(JsonView jsonValue) { *this = jsonValue; } -AddReservedInstanceAction& AddReservedInstanceAction::operator=(const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "reservedInstancesOfferingId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_reservedInstancesOfferingId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_reservedInstancesOfferingId = ss.str(); - } - } - m_reservedInstancesOfferingIdHasBeenSet = true; - } - - else if (initialKeyStr == "instanceCount") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::UInt) { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_instanceCount = static_cast(val.value()); - } - } else { - auto val = decoder->PopNextNegativeIntVal(); - if (val.has_value()) { - m_instanceCount = static_cast(1 - val.value()); - } - } - } - m_instanceCountHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("AddReservedInstanceAction", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "reservedInstancesOfferingId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_reservedInstancesOfferingId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_reservedInstancesOfferingId = ss.str(); - } - } - m_reservedInstancesOfferingIdHasBeenSet = true; - } - - else if (initialKeyStr == "instanceCount") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::UInt) { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_instanceCount = static_cast(val.value()); - } - } else { - auto val = decoder->PopNextNegativeIntVal(); - if (val.has_value()) { - m_instanceCount = static_cast(1 - val.value()); - } - } - } - m_instanceCountHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } +AddReservedInstanceAction& AddReservedInstanceAction::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("reservedInstancesOfferingId")) { + m_reservedInstancesOfferingId = jsonValue.GetString("reservedInstancesOfferingId"); + m_reservedInstancesOfferingIdHasBeenSet = true; + } + if (jsonValue.ValueExists("instanceCount")) { + m_instanceCount = jsonValue.GetInteger("instanceCount"); + m_instanceCountHasBeenSet = true; } - return *this; } -void AddReservedInstanceAction::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_reservedInstancesOfferingIdHasBeenSet) { - mapSize++; - } - if (m_instanceCountHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); +JsonValue AddReservedInstanceAction::Jsonize() const { + JsonValue payload; if (m_reservedInstancesOfferingIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("reservedInstancesOfferingId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_reservedInstancesOfferingId.c_str())); + payload.WithString("reservedInstancesOfferingId", m_reservedInstancesOfferingId); } if (m_instanceCountHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("instanceCount")); - (m_instanceCount >= 0) ? encoder.WriteUInt(m_instanceCount) : encoder.WriteNegInt(m_instanceCount); + payload.WithInteger("instanceCount", m_instanceCount); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/AddSavingsPlanAction.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/AddSavingsPlanAction.cpp index 45cb1ae77d43..76a8fb746ea6 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/AddSavingsPlanAction.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/AddSavingsPlanAction.cpp @@ -4,167 +4,45 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -AddSavingsPlanAction::AddSavingsPlanAction(const std::shared_ptr& decoder) { *this = decoder; } +AddSavingsPlanAction::AddSavingsPlanAction(JsonView jsonValue) { *this = jsonValue; } -AddSavingsPlanAction& AddSavingsPlanAction::operator=(const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "savingsPlanOfferingId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_savingsPlanOfferingId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_savingsPlanOfferingId = ss.str(); - } - } - m_savingsPlanOfferingIdHasBeenSet = true; - } - - else if (initialKeyStr == "commitment") { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_commitment = val.value(); - } - m_commitmentHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("AddSavingsPlanAction", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "savingsPlanOfferingId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_savingsPlanOfferingId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_savingsPlanOfferingId = ss.str(); - } - } - m_savingsPlanOfferingIdHasBeenSet = true; - } - - else if (initialKeyStr == "commitment") { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_commitment = val.value(); - } - m_commitmentHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } +AddSavingsPlanAction& AddSavingsPlanAction::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("savingsPlanOfferingId")) { + m_savingsPlanOfferingId = jsonValue.GetString("savingsPlanOfferingId"); + m_savingsPlanOfferingIdHasBeenSet = true; + } + if (jsonValue.ValueExists("commitment")) { + m_commitment = jsonValue.GetDouble("commitment"); + m_commitmentHasBeenSet = true; } - return *this; } -void AddSavingsPlanAction::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_savingsPlanOfferingIdHasBeenSet) { - mapSize++; - } - if (m_commitmentHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); +JsonValue AddSavingsPlanAction::Jsonize() const { + JsonValue payload; if (m_savingsPlanOfferingIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("savingsPlanOfferingId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_savingsPlanOfferingId.c_str())); + payload.WithString("savingsPlanOfferingId", m_savingsPlanOfferingId); } if (m_commitmentHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("commitment")); - encoder.WriteFloat(m_commitment); + payload.WithDouble("commitment", m_commitment); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateBillScenarioCommitmentModificationEntry.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateBillScenarioCommitmentModificationEntry.cpp index 454bd03a949b..4885f175aed8 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateBillScenarioCommitmentModificationEntry.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateBillScenarioCommitmentModificationEntry.cpp @@ -4,301 +4,63 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -BatchCreateBillScenarioCommitmentModificationEntry::BatchCreateBillScenarioCommitmentModificationEntry( - const std::shared_ptr& decoder) { - *this = decoder; +BatchCreateBillScenarioCommitmentModificationEntry::BatchCreateBillScenarioCommitmentModificationEntry(JsonView jsonValue) { + *this = jsonValue; } -BatchCreateBillScenarioCommitmentModificationEntry& BatchCreateBillScenarioCommitmentModificationEntry::operator=( - const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "key") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_key = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_key = ss.str(); - } - } - m_keyHasBeenSet = true; - } - - else if (initialKeyStr == "group") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_group = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_group = ss.str(); - } - } - m_groupHasBeenSet = true; - } - - else if (initialKeyStr == "usageAccountId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageAccountId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageAccountId = ss.str(); - } - } - m_usageAccountIdHasBeenSet = true; - } - - else if (initialKeyStr == "commitmentAction") { - m_commitmentAction = BillScenarioCommitmentModificationAction(decoder); - m_commitmentActionHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("BatchCreateBillScenarioCommitmentModificationEntry", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "key") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_key = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_key = ss.str(); - } - } - m_keyHasBeenSet = true; - } - - else if (initialKeyStr == "group") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_group = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_group = ss.str(); - } - } - m_groupHasBeenSet = true; - } - - else if (initialKeyStr == "usageAccountId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageAccountId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageAccountId = ss.str(); - } - } - m_usageAccountIdHasBeenSet = true; - } - - else if (initialKeyStr == "commitmentAction") { - m_commitmentAction = BillScenarioCommitmentModificationAction(decoder); - m_commitmentActionHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } +BatchCreateBillScenarioCommitmentModificationEntry& BatchCreateBillScenarioCommitmentModificationEntry::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("key")) { + m_key = jsonValue.GetString("key"); + m_keyHasBeenSet = true; } - - return *this; -} - -void BatchCreateBillScenarioCommitmentModificationEntry::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_keyHasBeenSet) { - mapSize++; - } - if (m_groupHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("group")) { + m_group = jsonValue.GetString("group"); + m_groupHasBeenSet = true; } - if (m_usageAccountIdHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("usageAccountId")) { + m_usageAccountId = jsonValue.GetString("usageAccountId"); + m_usageAccountIdHasBeenSet = true; } - if (m_commitmentActionHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("commitmentAction")) { + m_commitmentAction = jsonValue.GetObject("commitmentAction"); + m_commitmentActionHasBeenSet = true; } + return *this; +} - encoder.WriteMapStart(mapSize); +JsonValue BatchCreateBillScenarioCommitmentModificationEntry::Jsonize() const { + JsonValue payload; if (m_keyHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("key")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_key.c_str())); + payload.WithString("key", m_key); } if (m_groupHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("group")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_group.c_str())); + payload.WithString("group", m_group); } if (m_usageAccountIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("usageAccountId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_usageAccountId.c_str())); + payload.WithString("usageAccountId", m_usageAccountId); } if (m_commitmentActionHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("commitmentAction")); - m_commitmentAction.CborEncode(encoder); + payload.WithObject("commitmentAction", m_commitmentAction.Jsonize()); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateBillScenarioCommitmentModificationError.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateBillScenarioCommitmentModificationError.cpp index 72d8ce612203..09f4d05c07c4 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateBillScenarioCommitmentModificationError.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateBillScenarioCommitmentModificationError.cpp @@ -4,246 +4,60 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -BatchCreateBillScenarioCommitmentModificationError::BatchCreateBillScenarioCommitmentModificationError( - const std::shared_ptr& decoder) { - *this = decoder; +BatchCreateBillScenarioCommitmentModificationError::BatchCreateBillScenarioCommitmentModificationError(JsonView jsonValue) { + *this = jsonValue; } -BatchCreateBillScenarioCommitmentModificationError& BatchCreateBillScenarioCommitmentModificationError::operator=( - const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "key") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_key = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_key = ss.str(); - } - } - m_keyHasBeenSet = true; - } - - else if (initialKeyStr == "errorMessage") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_errorMessage = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_errorMessage = ss.str(); - } - } - m_errorMessageHasBeenSet = true; - } - - else if (initialKeyStr == "errorCode") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_errorCode = BatchCreateBillScenarioCommitmentModificationErrorCodeMapper:: - GetBatchCreateBillScenarioCommitmentModificationErrorCodeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_errorCodeHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("BatchCreateBillScenarioCommitmentModificationError", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "key") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_key = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_key = ss.str(); - } - } - m_keyHasBeenSet = true; - } - - else if (initialKeyStr == "errorMessage") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_errorMessage = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_errorMessage = ss.str(); - } - } - m_errorMessageHasBeenSet = true; - } - - else if (initialKeyStr == "errorCode") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_errorCode = BatchCreateBillScenarioCommitmentModificationErrorCodeMapper:: - GetBatchCreateBillScenarioCommitmentModificationErrorCodeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_errorCodeHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } - } - - return *this; -} - -void BatchCreateBillScenarioCommitmentModificationError::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_keyHasBeenSet) { - mapSize++; +BatchCreateBillScenarioCommitmentModificationError& BatchCreateBillScenarioCommitmentModificationError::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("key")) { + m_key = jsonValue.GetString("key"); + m_keyHasBeenSet = true; } - if (m_errorMessageHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("errorMessage")) { + m_errorMessage = jsonValue.GetString("errorMessage"); + m_errorMessageHasBeenSet = true; } - if (m_errorCodeHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("errorCode")) { + m_errorCode = + BatchCreateBillScenarioCommitmentModificationErrorCodeMapper::GetBatchCreateBillScenarioCommitmentModificationErrorCodeForName( + jsonValue.GetString("errorCode")); + m_errorCodeHasBeenSet = true; } + return *this; +} - encoder.WriteMapStart(mapSize); +JsonValue BatchCreateBillScenarioCommitmentModificationError::Jsonize() const { + JsonValue payload; if (m_keyHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("key")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_key.c_str())); + payload.WithString("key", m_key); } if (m_errorMessageHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("errorMessage")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_errorMessage.c_str())); + payload.WithString("errorMessage", m_errorMessage); } if (m_errorCodeHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("errorCode")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString( + payload.WithString( + "errorCode", BatchCreateBillScenarioCommitmentModificationErrorCodeMapper::GetNameForBatchCreateBillScenarioCommitmentModificationErrorCode( - m_errorCode) - .c_str())); + m_errorCode)); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateBillScenarioCommitmentModificationItem.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateBillScenarioCommitmentModificationItem.cpp index d3e3a1dd8321..85d33a339d6f 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateBillScenarioCommitmentModificationItem.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateBillScenarioCommitmentModificationItem.cpp @@ -4,369 +4,71 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -BatchCreateBillScenarioCommitmentModificationItem::BatchCreateBillScenarioCommitmentModificationItem( - const std::shared_ptr& decoder) { - *this = decoder; +BatchCreateBillScenarioCommitmentModificationItem::BatchCreateBillScenarioCommitmentModificationItem(JsonView jsonValue) { + *this = jsonValue; } -BatchCreateBillScenarioCommitmentModificationItem& BatchCreateBillScenarioCommitmentModificationItem::operator=( - const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "key") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_key = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_key = ss.str(); - } - } - m_keyHasBeenSet = true; - } - - else if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "group") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_group = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_group = ss.str(); - } - } - m_groupHasBeenSet = true; - } - - else if (initialKeyStr == "usageAccountId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageAccountId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageAccountId = ss.str(); - } - } - m_usageAccountIdHasBeenSet = true; - } - - else if (initialKeyStr == "commitmentAction") { - m_commitmentAction = BillScenarioCommitmentModificationAction(decoder); - m_commitmentActionHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("BatchCreateBillScenarioCommitmentModificationItem", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "key") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_key = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_key = ss.str(); - } - } - m_keyHasBeenSet = true; - } - - else if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "group") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_group = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_group = ss.str(); - } - } - m_groupHasBeenSet = true; - } - - else if (initialKeyStr == "usageAccountId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageAccountId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageAccountId = ss.str(); - } - } - m_usageAccountIdHasBeenSet = true; - } - - else if (initialKeyStr == "commitmentAction") { - m_commitmentAction = BillScenarioCommitmentModificationAction(decoder); - m_commitmentActionHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } - } - - return *this; -} - -void BatchCreateBillScenarioCommitmentModificationItem::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_keyHasBeenSet) { - mapSize++; +BatchCreateBillScenarioCommitmentModificationItem& BatchCreateBillScenarioCommitmentModificationItem::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("key")) { + m_key = jsonValue.GetString("key"); + m_keyHasBeenSet = true; } - if (m_idHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("id")) { + m_id = jsonValue.GetString("id"); + m_idHasBeenSet = true; } - if (m_groupHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("group")) { + m_group = jsonValue.GetString("group"); + m_groupHasBeenSet = true; } - if (m_usageAccountIdHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("usageAccountId")) { + m_usageAccountId = jsonValue.GetString("usageAccountId"); + m_usageAccountIdHasBeenSet = true; } - if (m_commitmentActionHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("commitmentAction")) { + m_commitmentAction = jsonValue.GetObject("commitmentAction"); + m_commitmentActionHasBeenSet = true; } + return *this; +} - encoder.WriteMapStart(mapSize); +JsonValue BatchCreateBillScenarioCommitmentModificationItem::Jsonize() const { + JsonValue payload; if (m_keyHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("key")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_key.c_str())); + payload.WithString("key", m_key); } if (m_idHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("id")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_id.c_str())); + payload.WithString("id", m_id); } if (m_groupHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("group")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_group.c_str())); + payload.WithString("group", m_group); } if (m_usageAccountIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("usageAccountId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_usageAccountId.c_str())); + payload.WithString("usageAccountId", m_usageAccountId); } if (m_commitmentActionHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("commitmentAction")); - m_commitmentAction.CborEncode(encoder); + payload.WithObject("commitmentAction", m_commitmentAction.Jsonize()); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateBillScenarioCommitmentModificationRequest.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateBillScenarioCommitmentModificationRequest.cpp index eb433fc75926..0f4a8891b6d0 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateBillScenarioCommitmentModificationRequest.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateBillScenarioCommitmentModificationRequest.cpp @@ -4,56 +4,40 @@ */ #include -#include +#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; Aws::String BatchCreateBillScenarioCommitmentModificationRequest::SerializePayload() const { - Aws::Crt::Cbor::CborEncoder encoder; + JsonValue payload; - // Calculate map size - size_t mapSize = 0; if (m_billScenarioIdHasBeenSet) { - mapSize++; - } - if (m_commitmentModificationsHasBeenSet) { - mapSize++; - } - if (m_clientTokenHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); - - if (m_billScenarioIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("billScenarioId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_billScenarioId.c_str())); + payload.WithString("billScenarioId", m_billScenarioId); } if (m_commitmentModificationsHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("commitmentModifications")); - encoder.WriteArrayStart(m_commitmentModifications.size()); - for (const auto& item_0 : m_commitmentModifications) { - item_0.CborEncode(encoder); + Aws::Utils::Array commitmentModificationsJsonList(m_commitmentModifications.size()); + for (unsigned commitmentModificationsIndex = 0; commitmentModificationsIndex < commitmentModificationsJsonList.GetLength(); + ++commitmentModificationsIndex) { + commitmentModificationsJsonList[commitmentModificationsIndex].AsObject( + m_commitmentModifications[commitmentModificationsIndex].Jsonize()); } + payload.WithArray("commitmentModifications", std::move(commitmentModificationsJsonList)); } if (m_clientTokenHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("clientToken")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_clientToken.c_str())); + payload.WithString("clientToken", m_clientToken); } - const auto str = Aws::String(reinterpret_cast(encoder.GetEncodedData().ptr), encoder.GetEncodedData().len); - return str; + + return payload.View().WriteReadable(); } Aws::Http::HeaderValueCollection BatchCreateBillScenarioCommitmentModificationRequest::GetRequestSpecificHeaders() const { Aws::Http::HeaderValueCollection headers; - headers.emplace(Aws::Http::CONTENT_TYPE_HEADER, Aws::CBOR_CONTENT_TYPE); - headers.emplace(Aws::Http::SMITHY_PROTOCOL_HEADER, Aws::RPC_V2_CBOR); - headers.emplace(Aws::Http::ACCEPT_HEADER, Aws::CBOR_CONTENT_TYPE); + headers.insert(Aws::Http::HeaderValuePair("X-Amz-Target", "AWSBCMPricingCalculator.BatchCreateBillScenarioCommitmentModification")); return headers; } diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateBillScenarioCommitmentModificationResult.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateBillScenarioCommitmentModificationResult.cpp index e1ecad5e4a88..c8115c5e52f9 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateBillScenarioCommitmentModificationResult.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateBillScenarioCommitmentModificationResult.cpp @@ -7,192 +7,38 @@ #include #include #include -#include +#include #include -#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; -using namespace Aws::Utils::Cbor; using namespace Aws; BatchCreateBillScenarioCommitmentModificationResult::BatchCreateBillScenarioCommitmentModificationResult( - const Aws::AmazonWebServiceResult& result) { + const Aws::AmazonWebServiceResult& result) { *this = result; } BatchCreateBillScenarioCommitmentModificationResult& BatchCreateBillScenarioCommitmentModificationResult::operator=( - const Aws::AmazonWebServiceResult& result) { + const Aws::AmazonWebServiceResult& result) { m_HttpResponseCode = result.GetResponseCode(); - - const auto& cborValue = result.GetPayload(); - const auto decoder = cborValue.GetDecoder(); - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "items") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_items.push_back(BatchCreateBillScenarioCommitmentModificationItem(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_items.push_back(BatchCreateBillScenarioCommitmentModificationItem(decoder)); - } - } - } - m_itemsHasBeenSet = true; - } - - else if (initialKeyStr == "errors") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_errors.push_back(BatchCreateBillScenarioCommitmentModificationError(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_errors.push_back(BatchCreateBillScenarioCommitmentModificationError(decoder)); - } - } - } - m_errorsHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("BatchCreateBillScenarioCommitmentModificationResult", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "items") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_items.push_back(BatchCreateBillScenarioCommitmentModificationItem(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_items.push_back(BatchCreateBillScenarioCommitmentModificationItem(decoder)); - } - } - } - m_itemsHasBeenSet = true; - } - - else if (initialKeyStr == "errors") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_errors.push_back(BatchCreateBillScenarioCommitmentModificationError(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_errors.push_back(BatchCreateBillScenarioCommitmentModificationError(decoder)); - } - } - } - m_errorsHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } + JsonView jsonValue = result.GetPayload().View(); + if (jsonValue.ValueExists("items")) { + Aws::Utils::Array itemsJsonList = jsonValue.GetArray("items"); + for (unsigned itemsIndex = 0; itemsIndex < itemsJsonList.GetLength(); ++itemsIndex) { + m_items.push_back(itemsJsonList[itemsIndex].AsObject()); + } + m_itemsHasBeenSet = true; + } + if (jsonValue.ValueExists("errors")) { + Aws::Utils::Array errorsJsonList = jsonValue.GetArray("errors"); + for (unsigned errorsIndex = 0; errorsIndex < errorsJsonList.GetLength(); ++errorsIndex) { + m_errors.push_back(errorsJsonList[errorsIndex].AsObject()); } + m_errorsHasBeenSet = true; } const auto& headers = result.GetHeaderValueCollection(); diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateBillScenarioUsageModificationEntry.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateBillScenarioUsageModificationEntry.cpp index 69efd386b43c..7f4076aed1ef 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateBillScenarioUsageModificationEntry.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateBillScenarioUsageModificationEntry.cpp @@ -4,642 +4,108 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -BatchCreateBillScenarioUsageModificationEntry::BatchCreateBillScenarioUsageModificationEntry( - const std::shared_ptr& decoder) { - *this = decoder; -} - -BatchCreateBillScenarioUsageModificationEntry& BatchCreateBillScenarioUsageModificationEntry::operator=( - const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "serviceCode") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_serviceCode = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_serviceCode = ss.str(); - } - } - m_serviceCodeHasBeenSet = true; - } - - else if (initialKeyStr == "usageType") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageType = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageType = ss.str(); - } - } - m_usageTypeHasBeenSet = true; - } - - else if (initialKeyStr == "operation") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_operation = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_operation = ss.str(); - } - } - m_operationHasBeenSet = true; - } - - else if (initialKeyStr == "availabilityZone") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_availabilityZone = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_availabilityZone = ss.str(); - } - } - m_availabilityZoneHasBeenSet = true; - } - - else if (initialKeyStr == "key") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_key = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_key = ss.str(); - } - } - m_keyHasBeenSet = true; - } - - else if (initialKeyStr == "group") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_group = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_group = ss.str(); - } - } - m_groupHasBeenSet = true; - } - - else if (initialKeyStr == "usageAccountId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageAccountId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageAccountId = ss.str(); - } - } - m_usageAccountIdHasBeenSet = true; - } - - else if (initialKeyStr == "amounts") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_amounts.push_back(UsageAmount(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_amounts.push_back(UsageAmount(decoder)); - } - } - } - m_amountsHasBeenSet = true; - } - - else if (initialKeyStr == "historicalUsage") { - m_historicalUsage = HistoricalUsageEntity(decoder); - m_historicalUsageHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("BatchCreateBillScenarioUsageModificationEntry", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "serviceCode") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_serviceCode = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_serviceCode = ss.str(); - } - } - m_serviceCodeHasBeenSet = true; - } - - else if (initialKeyStr == "usageType") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageType = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageType = ss.str(); - } - } - m_usageTypeHasBeenSet = true; - } - - else if (initialKeyStr == "operation") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_operation = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_operation = ss.str(); - } - } - m_operationHasBeenSet = true; - } - - else if (initialKeyStr == "availabilityZone") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_availabilityZone = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_availabilityZone = ss.str(); - } - } - m_availabilityZoneHasBeenSet = true; - } - - else if (initialKeyStr == "key") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_key = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_key = ss.str(); - } - } - m_keyHasBeenSet = true; - } - - else if (initialKeyStr == "group") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_group = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_group = ss.str(); - } - } - m_groupHasBeenSet = true; - } - - else if (initialKeyStr == "usageAccountId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageAccountId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageAccountId = ss.str(); - } - } - m_usageAccountIdHasBeenSet = true; - } - - else if (initialKeyStr == "amounts") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_amounts.push_back(UsageAmount(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_amounts.push_back(UsageAmount(decoder)); - } - } - } - m_amountsHasBeenSet = true; - } +BatchCreateBillScenarioUsageModificationEntry::BatchCreateBillScenarioUsageModificationEntry(JsonView jsonValue) { *this = jsonValue; } - else if (initialKeyStr == "historicalUsage") { - m_historicalUsage = HistoricalUsageEntity(decoder); - m_historicalUsageHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } +BatchCreateBillScenarioUsageModificationEntry& BatchCreateBillScenarioUsageModificationEntry::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("serviceCode")) { + m_serviceCode = jsonValue.GetString("serviceCode"); + m_serviceCodeHasBeenSet = true; } - - return *this; -} - -void BatchCreateBillScenarioUsageModificationEntry::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_serviceCodeHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("usageType")) { + m_usageType = jsonValue.GetString("usageType"); + m_usageTypeHasBeenSet = true; } - if (m_usageTypeHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("operation")) { + m_operation = jsonValue.GetString("operation"); + m_operationHasBeenSet = true; } - if (m_operationHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("availabilityZone")) { + m_availabilityZone = jsonValue.GetString("availabilityZone"); + m_availabilityZoneHasBeenSet = true; } - if (m_availabilityZoneHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("key")) { + m_key = jsonValue.GetString("key"); + m_keyHasBeenSet = true; } - if (m_keyHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("group")) { + m_group = jsonValue.GetString("group"); + m_groupHasBeenSet = true; } - if (m_groupHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("usageAccountId")) { + m_usageAccountId = jsonValue.GetString("usageAccountId"); + m_usageAccountIdHasBeenSet = true; } - if (m_usageAccountIdHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("amounts")) { + Aws::Utils::Array amountsJsonList = jsonValue.GetArray("amounts"); + for (unsigned amountsIndex = 0; amountsIndex < amountsJsonList.GetLength(); ++amountsIndex) { + m_amounts.push_back(amountsJsonList[amountsIndex].AsObject()); + } + m_amountsHasBeenSet = true; } - if (m_amountsHasBeenSet) { - mapSize++; - } - if (m_historicalUsageHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("historicalUsage")) { + m_historicalUsage = jsonValue.GetObject("historicalUsage"); + m_historicalUsageHasBeenSet = true; } + return *this; +} - encoder.WriteMapStart(mapSize); +JsonValue BatchCreateBillScenarioUsageModificationEntry::Jsonize() const { + JsonValue payload; if (m_serviceCodeHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("serviceCode")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_serviceCode.c_str())); + payload.WithString("serviceCode", m_serviceCode); } if (m_usageTypeHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("usageType")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_usageType.c_str())); + payload.WithString("usageType", m_usageType); } if (m_operationHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("operation")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_operation.c_str())); + payload.WithString("operation", m_operation); } if (m_availabilityZoneHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("availabilityZone")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_availabilityZone.c_str())); + payload.WithString("availabilityZone", m_availabilityZone); } if (m_keyHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("key")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_key.c_str())); + payload.WithString("key", m_key); } if (m_groupHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("group")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_group.c_str())); + payload.WithString("group", m_group); } if (m_usageAccountIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("usageAccountId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_usageAccountId.c_str())); + payload.WithString("usageAccountId", m_usageAccountId); } if (m_amountsHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("amounts")); - encoder.WriteArrayStart(m_amounts.size()); - for (const auto& item_0 : m_amounts) { - item_0.CborEncode(encoder); + Aws::Utils::Array amountsJsonList(m_amounts.size()); + for (unsigned amountsIndex = 0; amountsIndex < amountsJsonList.GetLength(); ++amountsIndex) { + amountsJsonList[amountsIndex].AsObject(m_amounts[amountsIndex].Jsonize()); } + payload.WithArray("amounts", std::move(amountsJsonList)); } if (m_historicalUsageHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("historicalUsage")); - m_historicalUsage.CborEncode(encoder); + payload.WithObject("historicalUsage", m_historicalUsage.Jsonize()); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateBillScenarioUsageModificationError.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateBillScenarioUsageModificationError.cpp index ac83ed94afaa..6a595cf2952d 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateBillScenarioUsageModificationError.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateBillScenarioUsageModificationError.cpp @@ -4,245 +4,56 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -BatchCreateBillScenarioUsageModificationError::BatchCreateBillScenarioUsageModificationError( - const std::shared_ptr& decoder) { - *this = decoder; -} - -BatchCreateBillScenarioUsageModificationError& BatchCreateBillScenarioUsageModificationError::operator=( - const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "key") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_key = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_key = ss.str(); - } - } - m_keyHasBeenSet = true; - } - - else if (initialKeyStr == "errorMessage") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_errorMessage = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_errorMessage = ss.str(); - } - } - m_errorMessageHasBeenSet = true; - } - - else if (initialKeyStr == "errorCode") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_errorCode = - BatchCreateBillScenarioUsageModificationErrorCodeMapper::GetBatchCreateBillScenarioUsageModificationErrorCodeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_errorCodeHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("BatchCreateBillScenarioUsageModificationError", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } +BatchCreateBillScenarioUsageModificationError::BatchCreateBillScenarioUsageModificationError(JsonView jsonValue) { *this = jsonValue; } - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "key") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_key = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_key = ss.str(); - } - } - m_keyHasBeenSet = true; - } - - else if (initialKeyStr == "errorMessage") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_errorMessage = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_errorMessage = ss.str(); - } - } - m_errorMessageHasBeenSet = true; - } - - else if (initialKeyStr == "errorCode") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_errorCode = - BatchCreateBillScenarioUsageModificationErrorCodeMapper::GetBatchCreateBillScenarioUsageModificationErrorCodeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_errorCodeHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } +BatchCreateBillScenarioUsageModificationError& BatchCreateBillScenarioUsageModificationError::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("key")) { + m_key = jsonValue.GetString("key"); + m_keyHasBeenSet = true; } - - return *this; -} - -void BatchCreateBillScenarioUsageModificationError::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_keyHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("errorMessage")) { + m_errorMessage = jsonValue.GetString("errorMessage"); + m_errorMessageHasBeenSet = true; } - if (m_errorMessageHasBeenSet) { - mapSize++; - } - if (m_errorCodeHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("errorCode")) { + m_errorCode = BatchCreateBillScenarioUsageModificationErrorCodeMapper::GetBatchCreateBillScenarioUsageModificationErrorCodeForName( + jsonValue.GetString("errorCode")); + m_errorCodeHasBeenSet = true; } + return *this; +} - encoder.WriteMapStart(mapSize); +JsonValue BatchCreateBillScenarioUsageModificationError::Jsonize() const { + JsonValue payload; if (m_keyHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("key")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_key.c_str())); + payload.WithString("key", m_key); } if (m_errorMessageHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("errorMessage")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_errorMessage.c_str())); + payload.WithString("errorMessage", m_errorMessage); } if (m_errorCodeHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("errorCode")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString( - BatchCreateBillScenarioUsageModificationErrorCodeMapper::GetNameForBatchCreateBillScenarioUsageModificationErrorCode(m_errorCode) - .c_str())); + payload.WithString( + "errorCode", + BatchCreateBillScenarioUsageModificationErrorCodeMapper::GetNameForBatchCreateBillScenarioUsageModificationErrorCode(m_errorCode)); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateBillScenarioUsageModificationItem.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateBillScenarioUsageModificationItem.cpp index 1a82ddc008ce..46dc93a0dc19 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateBillScenarioUsageModificationItem.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateBillScenarioUsageModificationItem.cpp @@ -4,778 +4,124 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -BatchCreateBillScenarioUsageModificationItem::BatchCreateBillScenarioUsageModificationItem( - const std::shared_ptr& decoder) { - *this = decoder; -} - -BatchCreateBillScenarioUsageModificationItem& BatchCreateBillScenarioUsageModificationItem::operator=( - const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "serviceCode") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_serviceCode = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_serviceCode = ss.str(); - } - } - m_serviceCodeHasBeenSet = true; - } - - else if (initialKeyStr == "usageType") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageType = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageType = ss.str(); - } - } - m_usageTypeHasBeenSet = true; - } - - else if (initialKeyStr == "operation") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_operation = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_operation = ss.str(); - } - } - m_operationHasBeenSet = true; - } - - else if (initialKeyStr == "location") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_location = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_location = ss.str(); - } - } - m_locationHasBeenSet = true; - } - - else if (initialKeyStr == "availabilityZone") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_availabilityZone = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_availabilityZone = ss.str(); - } - } - m_availabilityZoneHasBeenSet = true; - } - - else if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "group") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_group = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_group = ss.str(); - } - } - m_groupHasBeenSet = true; - } - - else if (initialKeyStr == "usageAccountId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageAccountId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageAccountId = ss.str(); - } - } - m_usageAccountIdHasBeenSet = true; - } - - else if (initialKeyStr == "quantities") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_quantities.push_back(UsageQuantity(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_quantities.push_back(UsageQuantity(decoder)); - } - } - } - m_quantitiesHasBeenSet = true; - } - - else if (initialKeyStr == "historicalUsage") { - m_historicalUsage = HistoricalUsageEntity(decoder); - m_historicalUsageHasBeenSet = true; - } - - else if (initialKeyStr == "key") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_key = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_key = ss.str(); - } - } - m_keyHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("BatchCreateBillScenarioUsageModificationItem", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "serviceCode") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_serviceCode = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_serviceCode = ss.str(); - } - } - m_serviceCodeHasBeenSet = true; - } - - else if (initialKeyStr == "usageType") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageType = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageType = ss.str(); - } - } - m_usageTypeHasBeenSet = true; - } - - else if (initialKeyStr == "operation") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_operation = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_operation = ss.str(); - } - } - m_operationHasBeenSet = true; - } - - else if (initialKeyStr == "location") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_location = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_location = ss.str(); - } - } - m_locationHasBeenSet = true; - } - - else if (initialKeyStr == "availabilityZone") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_availabilityZone = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_availabilityZone = ss.str(); - } - } - m_availabilityZoneHasBeenSet = true; - } - - else if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "group") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_group = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_group = ss.str(); - } - } - m_groupHasBeenSet = true; - } - - else if (initialKeyStr == "usageAccountId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageAccountId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageAccountId = ss.str(); - } - } - m_usageAccountIdHasBeenSet = true; - } - - else if (initialKeyStr == "quantities") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_quantities.push_back(UsageQuantity(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_quantities.push_back(UsageQuantity(decoder)); - } - } - } - m_quantitiesHasBeenSet = true; - } +BatchCreateBillScenarioUsageModificationItem::BatchCreateBillScenarioUsageModificationItem(JsonView jsonValue) { *this = jsonValue; } - else if (initialKeyStr == "historicalUsage") { - m_historicalUsage = HistoricalUsageEntity(decoder); - m_historicalUsageHasBeenSet = true; - } - - else if (initialKeyStr == "key") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_key = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_key = ss.str(); - } - } - m_keyHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } +BatchCreateBillScenarioUsageModificationItem& BatchCreateBillScenarioUsageModificationItem::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("serviceCode")) { + m_serviceCode = jsonValue.GetString("serviceCode"); + m_serviceCodeHasBeenSet = true; } - - return *this; -} - -void BatchCreateBillScenarioUsageModificationItem::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_serviceCodeHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("usageType")) { + m_usageType = jsonValue.GetString("usageType"); + m_usageTypeHasBeenSet = true; } - if (m_usageTypeHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("operation")) { + m_operation = jsonValue.GetString("operation"); + m_operationHasBeenSet = true; } - if (m_operationHasBeenSet) { - mapSize++; - } - if (m_locationHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("location")) { + m_location = jsonValue.GetString("location"); + m_locationHasBeenSet = true; } - if (m_availabilityZoneHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("availabilityZone")) { + m_availabilityZone = jsonValue.GetString("availabilityZone"); + m_availabilityZoneHasBeenSet = true; } - if (m_idHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("id")) { + m_id = jsonValue.GetString("id"); + m_idHasBeenSet = true; } - if (m_groupHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("group")) { + m_group = jsonValue.GetString("group"); + m_groupHasBeenSet = true; } - if (m_usageAccountIdHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("usageAccountId")) { + m_usageAccountId = jsonValue.GetString("usageAccountId"); + m_usageAccountIdHasBeenSet = true; } - if (m_quantitiesHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("quantities")) { + Aws::Utils::Array quantitiesJsonList = jsonValue.GetArray("quantities"); + for (unsigned quantitiesIndex = 0; quantitiesIndex < quantitiesJsonList.GetLength(); ++quantitiesIndex) { + m_quantities.push_back(quantitiesJsonList[quantitiesIndex].AsObject()); + } + m_quantitiesHasBeenSet = true; } - if (m_historicalUsageHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("historicalUsage")) { + m_historicalUsage = jsonValue.GetObject("historicalUsage"); + m_historicalUsageHasBeenSet = true; } - if (m_keyHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("key")) { + m_key = jsonValue.GetString("key"); + m_keyHasBeenSet = true; } + return *this; +} - encoder.WriteMapStart(mapSize); +JsonValue BatchCreateBillScenarioUsageModificationItem::Jsonize() const { + JsonValue payload; if (m_serviceCodeHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("serviceCode")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_serviceCode.c_str())); + payload.WithString("serviceCode", m_serviceCode); } if (m_usageTypeHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("usageType")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_usageType.c_str())); + payload.WithString("usageType", m_usageType); } if (m_operationHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("operation")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_operation.c_str())); + payload.WithString("operation", m_operation); } if (m_locationHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("location")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_location.c_str())); + payload.WithString("location", m_location); } if (m_availabilityZoneHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("availabilityZone")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_availabilityZone.c_str())); + payload.WithString("availabilityZone", m_availabilityZone); } if (m_idHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("id")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_id.c_str())); + payload.WithString("id", m_id); } if (m_groupHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("group")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_group.c_str())); + payload.WithString("group", m_group); } if (m_usageAccountIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("usageAccountId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_usageAccountId.c_str())); + payload.WithString("usageAccountId", m_usageAccountId); } if (m_quantitiesHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("quantities")); - encoder.WriteArrayStart(m_quantities.size()); - for (const auto& item_0 : m_quantities) { - item_0.CborEncode(encoder); + Aws::Utils::Array quantitiesJsonList(m_quantities.size()); + for (unsigned quantitiesIndex = 0; quantitiesIndex < quantitiesJsonList.GetLength(); ++quantitiesIndex) { + quantitiesJsonList[quantitiesIndex].AsObject(m_quantities[quantitiesIndex].Jsonize()); } + payload.WithArray("quantities", std::move(quantitiesJsonList)); } if (m_historicalUsageHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("historicalUsage")); - m_historicalUsage.CborEncode(encoder); + payload.WithObject("historicalUsage", m_historicalUsage.Jsonize()); } if (m_keyHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("key")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_key.c_str())); + payload.WithString("key", m_key); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateBillScenarioUsageModificationRequest.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateBillScenarioUsageModificationRequest.cpp index cf2758bc14c2..fa8e532137c9 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateBillScenarioUsageModificationRequest.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateBillScenarioUsageModificationRequest.cpp @@ -4,56 +4,39 @@ */ #include -#include +#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; Aws::String BatchCreateBillScenarioUsageModificationRequest::SerializePayload() const { - Aws::Crt::Cbor::CborEncoder encoder; + JsonValue payload; - // Calculate map size - size_t mapSize = 0; if (m_billScenarioIdHasBeenSet) { - mapSize++; - } - if (m_usageModificationsHasBeenSet) { - mapSize++; - } - if (m_clientTokenHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); - - if (m_billScenarioIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("billScenarioId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_billScenarioId.c_str())); + payload.WithString("billScenarioId", m_billScenarioId); } if (m_usageModificationsHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("usageModifications")); - encoder.WriteArrayStart(m_usageModifications.size()); - for (const auto& item_0 : m_usageModifications) { - item_0.CborEncode(encoder); + Aws::Utils::Array usageModificationsJsonList(m_usageModifications.size()); + for (unsigned usageModificationsIndex = 0; usageModificationsIndex < usageModificationsJsonList.GetLength(); + ++usageModificationsIndex) { + usageModificationsJsonList[usageModificationsIndex].AsObject(m_usageModifications[usageModificationsIndex].Jsonize()); } + payload.WithArray("usageModifications", std::move(usageModificationsJsonList)); } if (m_clientTokenHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("clientToken")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_clientToken.c_str())); + payload.WithString("clientToken", m_clientToken); } - const auto str = Aws::String(reinterpret_cast(encoder.GetEncodedData().ptr), encoder.GetEncodedData().len); - return str; + + return payload.View().WriteReadable(); } Aws::Http::HeaderValueCollection BatchCreateBillScenarioUsageModificationRequest::GetRequestSpecificHeaders() const { Aws::Http::HeaderValueCollection headers; - headers.emplace(Aws::Http::CONTENT_TYPE_HEADER, Aws::CBOR_CONTENT_TYPE); - headers.emplace(Aws::Http::SMITHY_PROTOCOL_HEADER, Aws::RPC_V2_CBOR); - headers.emplace(Aws::Http::ACCEPT_HEADER, Aws::CBOR_CONTENT_TYPE); + headers.insert(Aws::Http::HeaderValuePair("X-Amz-Target", "AWSBCMPricingCalculator.BatchCreateBillScenarioUsageModification")); return headers; } diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateBillScenarioUsageModificationResult.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateBillScenarioUsageModificationResult.cpp index 39eec0f50b78..57eafa2168a6 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateBillScenarioUsageModificationResult.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateBillScenarioUsageModificationResult.cpp @@ -7,192 +7,38 @@ #include #include #include -#include +#include #include -#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; -using namespace Aws::Utils::Cbor; using namespace Aws; BatchCreateBillScenarioUsageModificationResult::BatchCreateBillScenarioUsageModificationResult( - const Aws::AmazonWebServiceResult& result) { + const Aws::AmazonWebServiceResult& result) { *this = result; } BatchCreateBillScenarioUsageModificationResult& BatchCreateBillScenarioUsageModificationResult::operator=( - const Aws::AmazonWebServiceResult& result) { + const Aws::AmazonWebServiceResult& result) { m_HttpResponseCode = result.GetResponseCode(); - - const auto& cborValue = result.GetPayload(); - const auto decoder = cborValue.GetDecoder(); - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "items") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_items.push_back(BatchCreateBillScenarioUsageModificationItem(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_items.push_back(BatchCreateBillScenarioUsageModificationItem(decoder)); - } - } - } - m_itemsHasBeenSet = true; - } - - else if (initialKeyStr == "errors") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_errors.push_back(BatchCreateBillScenarioUsageModificationError(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_errors.push_back(BatchCreateBillScenarioUsageModificationError(decoder)); - } - } - } - m_errorsHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("BatchCreateBillScenarioUsageModificationResult", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "items") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_items.push_back(BatchCreateBillScenarioUsageModificationItem(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_items.push_back(BatchCreateBillScenarioUsageModificationItem(decoder)); - } - } - } - m_itemsHasBeenSet = true; - } - - else if (initialKeyStr == "errors") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_errors.push_back(BatchCreateBillScenarioUsageModificationError(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_errors.push_back(BatchCreateBillScenarioUsageModificationError(decoder)); - } - } - } - m_errorsHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } + JsonView jsonValue = result.GetPayload().View(); + if (jsonValue.ValueExists("items")) { + Aws::Utils::Array itemsJsonList = jsonValue.GetArray("items"); + for (unsigned itemsIndex = 0; itemsIndex < itemsJsonList.GetLength(); ++itemsIndex) { + m_items.push_back(itemsJsonList[itemsIndex].AsObject()); + } + m_itemsHasBeenSet = true; + } + if (jsonValue.ValueExists("errors")) { + Aws::Utils::Array errorsJsonList = jsonValue.GetArray("errors"); + for (unsigned errorsIndex = 0; errorsIndex < errorsJsonList.GetLength(); ++errorsIndex) { + m_errors.push_back(errorsJsonList[errorsIndex].AsObject()); } + m_errorsHasBeenSet = true; } const auto& headers = result.GetHeaderValueCollection(); diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateWorkloadEstimateUsageEntry.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateWorkloadEstimateUsageEntry.cpp index ec39bc2bfacd..cee5ec8e86f6 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateWorkloadEstimateUsageEntry.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateWorkloadEstimateUsageEntry.cpp @@ -4,528 +4,93 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -BatchCreateWorkloadEstimateUsageEntry::BatchCreateWorkloadEstimateUsageEntry(const std::shared_ptr& decoder) { - *this = decoder; -} - -BatchCreateWorkloadEstimateUsageEntry& BatchCreateWorkloadEstimateUsageEntry::operator=( - const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "serviceCode") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_serviceCode = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_serviceCode = ss.str(); - } - } - m_serviceCodeHasBeenSet = true; - } - - else if (initialKeyStr == "usageType") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageType = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageType = ss.str(); - } - } - m_usageTypeHasBeenSet = true; - } - - else if (initialKeyStr == "operation") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_operation = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_operation = ss.str(); - } - } - m_operationHasBeenSet = true; - } - - else if (initialKeyStr == "key") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_key = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_key = ss.str(); - } - } - m_keyHasBeenSet = true; - } - - else if (initialKeyStr == "group") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_group = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_group = ss.str(); - } - } - m_groupHasBeenSet = true; - } - - else if (initialKeyStr == "usageAccountId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageAccountId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageAccountId = ss.str(); - } - } - m_usageAccountIdHasBeenSet = true; - } - - else if (initialKeyStr == "amount") { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_amount = val.value(); - } - m_amountHasBeenSet = true; - } - - else if (initialKeyStr == "historicalUsage") { - m_historicalUsage = HistoricalUsageEntity(decoder); - m_historicalUsageHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("BatchCreateWorkloadEstimateUsageEntry", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "serviceCode") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_serviceCode = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_serviceCode = ss.str(); - } - } - m_serviceCodeHasBeenSet = true; - } - - else if (initialKeyStr == "usageType") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageType = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageType = ss.str(); - } - } - m_usageTypeHasBeenSet = true; - } - - else if (initialKeyStr == "operation") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_operation = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_operation = ss.str(); - } - } - m_operationHasBeenSet = true; - } - - else if (initialKeyStr == "key") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_key = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_key = ss.str(); - } - } - m_keyHasBeenSet = true; - } - - else if (initialKeyStr == "group") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_group = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_group = ss.str(); - } - } - m_groupHasBeenSet = true; - } - - else if (initialKeyStr == "usageAccountId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageAccountId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageAccountId = ss.str(); - } - } - m_usageAccountIdHasBeenSet = true; - } +BatchCreateWorkloadEstimateUsageEntry::BatchCreateWorkloadEstimateUsageEntry(JsonView jsonValue) { *this = jsonValue; } - else if (initialKeyStr == "amount") { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_amount = val.value(); - } - m_amountHasBeenSet = true; - } - - else if (initialKeyStr == "historicalUsage") { - m_historicalUsage = HistoricalUsageEntity(decoder); - m_historicalUsageHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } +BatchCreateWorkloadEstimateUsageEntry& BatchCreateWorkloadEstimateUsageEntry::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("serviceCode")) { + m_serviceCode = jsonValue.GetString("serviceCode"); + m_serviceCodeHasBeenSet = true; } - - return *this; -} - -void BatchCreateWorkloadEstimateUsageEntry::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_serviceCodeHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("usageType")) { + m_usageType = jsonValue.GetString("usageType"); + m_usageTypeHasBeenSet = true; } - if (m_usageTypeHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("operation")) { + m_operation = jsonValue.GetString("operation"); + m_operationHasBeenSet = true; } - if (m_operationHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("key")) { + m_key = jsonValue.GetString("key"); + m_keyHasBeenSet = true; } - if (m_keyHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("group")) { + m_group = jsonValue.GetString("group"); + m_groupHasBeenSet = true; } - if (m_groupHasBeenSet) { - mapSize++; - } - if (m_usageAccountIdHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("usageAccountId")) { + m_usageAccountId = jsonValue.GetString("usageAccountId"); + m_usageAccountIdHasBeenSet = true; } - if (m_amountHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("amount")) { + m_amount = jsonValue.GetDouble("amount"); + m_amountHasBeenSet = true; } - if (m_historicalUsageHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("historicalUsage")) { + m_historicalUsage = jsonValue.GetObject("historicalUsage"); + m_historicalUsageHasBeenSet = true; } + return *this; +} - encoder.WriteMapStart(mapSize); +JsonValue BatchCreateWorkloadEstimateUsageEntry::Jsonize() const { + JsonValue payload; if (m_serviceCodeHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("serviceCode")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_serviceCode.c_str())); + payload.WithString("serviceCode", m_serviceCode); } if (m_usageTypeHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("usageType")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_usageType.c_str())); + payload.WithString("usageType", m_usageType); } if (m_operationHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("operation")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_operation.c_str())); + payload.WithString("operation", m_operation); } if (m_keyHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("key")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_key.c_str())); + payload.WithString("key", m_key); } if (m_groupHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("group")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_group.c_str())); + payload.WithString("group", m_group); } if (m_usageAccountIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("usageAccountId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_usageAccountId.c_str())); + payload.WithString("usageAccountId", m_usageAccountId); } if (m_amountHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("amount")); - encoder.WriteFloat(m_amount); + payload.WithDouble("amount", m_amount); } if (m_historicalUsageHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("historicalUsage")); - m_historicalUsage.CborEncode(encoder); + payload.WithObject("historicalUsage", m_historicalUsage.Jsonize()); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateWorkloadEstimateUsageError.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateWorkloadEstimateUsageError.cpp index 212ec84aff54..9ab2df87b03a 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateWorkloadEstimateUsageError.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateWorkloadEstimateUsageError.cpp @@ -4,241 +4,55 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -BatchCreateWorkloadEstimateUsageError::BatchCreateWorkloadEstimateUsageError(const std::shared_ptr& decoder) { - *this = decoder; -} - -BatchCreateWorkloadEstimateUsageError& BatchCreateWorkloadEstimateUsageError::operator=( - const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "key") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_key = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_key = ss.str(); - } - } - m_keyHasBeenSet = true; - } - - else if (initialKeyStr == "errorCode") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_errorCode = BatchCreateWorkloadEstimateUsageCodeMapper::GetBatchCreateWorkloadEstimateUsageCodeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_errorCodeHasBeenSet = true; - } - - else if (initialKeyStr == "errorMessage") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_errorMessage = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_errorMessage = ss.str(); - } - } - m_errorMessageHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("BatchCreateWorkloadEstimateUsageError", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } +BatchCreateWorkloadEstimateUsageError::BatchCreateWorkloadEstimateUsageError(JsonView jsonValue) { *this = jsonValue; } - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "key") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_key = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_key = ss.str(); - } - } - m_keyHasBeenSet = true; - } - - else if (initialKeyStr == "errorCode") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_errorCode = BatchCreateWorkloadEstimateUsageCodeMapper::GetBatchCreateWorkloadEstimateUsageCodeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_errorCodeHasBeenSet = true; - } - - else if (initialKeyStr == "errorMessage") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_errorMessage = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_errorMessage = ss.str(); - } - } - m_errorMessageHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } +BatchCreateWorkloadEstimateUsageError& BatchCreateWorkloadEstimateUsageError::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("key")) { + m_key = jsonValue.GetString("key"); + m_keyHasBeenSet = true; } - - return *this; -} - -void BatchCreateWorkloadEstimateUsageError::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_keyHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("errorCode")) { + m_errorCode = + BatchCreateWorkloadEstimateUsageCodeMapper::GetBatchCreateWorkloadEstimateUsageCodeForName(jsonValue.GetString("errorCode")); + m_errorCodeHasBeenSet = true; } - if (m_errorCodeHasBeenSet) { - mapSize++; - } - if (m_errorMessageHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("errorMessage")) { + m_errorMessage = jsonValue.GetString("errorMessage"); + m_errorMessageHasBeenSet = true; } + return *this; +} - encoder.WriteMapStart(mapSize); +JsonValue BatchCreateWorkloadEstimateUsageError::Jsonize() const { + JsonValue payload; if (m_keyHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("key")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_key.c_str())); + payload.WithString("key", m_key); } if (m_errorCodeHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("errorCode")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString( - BatchCreateWorkloadEstimateUsageCodeMapper::GetNameForBatchCreateWorkloadEstimateUsageCode(m_errorCode).c_str())); + payload.WithString("errorCode", + BatchCreateWorkloadEstimateUsageCodeMapper::GetNameForBatchCreateWorkloadEstimateUsageCode(m_errorCode)); } if (m_errorMessageHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("errorMessage")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_errorMessage.c_str())); + payload.WithString("errorMessage", m_errorMessage); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateWorkloadEstimateUsageItem.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateWorkloadEstimateUsageItem.cpp index 95597c8a51e3..dd6f785982b0 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateWorkloadEstimateUsageItem.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateWorkloadEstimateUsageItem.cpp @@ -4,735 +4,133 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -BatchCreateWorkloadEstimateUsageItem::BatchCreateWorkloadEstimateUsageItem(const std::shared_ptr& decoder) { - *this = decoder; -} - -BatchCreateWorkloadEstimateUsageItem& BatchCreateWorkloadEstimateUsageItem::operator=( - const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "serviceCode") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_serviceCode = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_serviceCode = ss.str(); - } - } - m_serviceCodeHasBeenSet = true; - } - - else if (initialKeyStr == "usageType") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageType = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageType = ss.str(); - } - } - m_usageTypeHasBeenSet = true; - } - - else if (initialKeyStr == "operation") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_operation = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_operation = ss.str(); - } - } - m_operationHasBeenSet = true; - } - - else if (initialKeyStr == "location") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_location = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_location = ss.str(); - } - } - m_locationHasBeenSet = true; - } - - else if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "usageAccountId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageAccountId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageAccountId = ss.str(); - } - } - m_usageAccountIdHasBeenSet = true; - } - - else if (initialKeyStr == "group") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_group = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_group = ss.str(); - } - } - m_groupHasBeenSet = true; - } - - else if (initialKeyStr == "quantity") { - m_quantity = WorkloadEstimateUsageQuantity(decoder); - m_quantityHasBeenSet = true; - } - - else if (initialKeyStr == "cost") { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_cost = val.value(); - } - m_costHasBeenSet = true; - } - - else if (initialKeyStr == "currency") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_currency = CurrencyCodeMapper::GetCurrencyCodeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_currencyHasBeenSet = true; - } - - else if (initialKeyStr == "status") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_status = WorkloadEstimateCostStatusMapper::GetWorkloadEstimateCostStatusForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_statusHasBeenSet = true; - } - - else if (initialKeyStr == "historicalUsage") { - m_historicalUsage = HistoricalUsageEntity(decoder); - m_historicalUsageHasBeenSet = true; - } - - else if (initialKeyStr == "key") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_key = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_key = ss.str(); - } - } - m_keyHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("BatchCreateWorkloadEstimateUsageItem", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "serviceCode") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_serviceCode = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_serviceCode = ss.str(); - } - } - m_serviceCodeHasBeenSet = true; - } - - else if (initialKeyStr == "usageType") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageType = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageType = ss.str(); - } - } - m_usageTypeHasBeenSet = true; - } - - else if (initialKeyStr == "operation") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_operation = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_operation = ss.str(); - } - } - m_operationHasBeenSet = true; - } - - else if (initialKeyStr == "location") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_location = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_location = ss.str(); - } - } - m_locationHasBeenSet = true; - } - - else if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "usageAccountId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageAccountId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageAccountId = ss.str(); - } - } - m_usageAccountIdHasBeenSet = true; - } - - else if (initialKeyStr == "group") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_group = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_group = ss.str(); - } - } - m_groupHasBeenSet = true; - } - - else if (initialKeyStr == "quantity") { - m_quantity = WorkloadEstimateUsageQuantity(decoder); - m_quantityHasBeenSet = true; - } - - else if (initialKeyStr == "cost") { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_cost = val.value(); - } - m_costHasBeenSet = true; - } +BatchCreateWorkloadEstimateUsageItem::BatchCreateWorkloadEstimateUsageItem(JsonView jsonValue) { *this = jsonValue; } - else if (initialKeyStr == "currency") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_currency = CurrencyCodeMapper::GetCurrencyCodeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_currencyHasBeenSet = true; - } - - else if (initialKeyStr == "status") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_status = WorkloadEstimateCostStatusMapper::GetWorkloadEstimateCostStatusForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_statusHasBeenSet = true; - } - - else if (initialKeyStr == "historicalUsage") { - m_historicalUsage = HistoricalUsageEntity(decoder); - m_historicalUsageHasBeenSet = true; - } - - else if (initialKeyStr == "key") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_key = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_key = ss.str(); - } - } - m_keyHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } - } - - return *this; -} - -void BatchCreateWorkloadEstimateUsageItem::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_serviceCodeHasBeenSet) { - mapSize++; +BatchCreateWorkloadEstimateUsageItem& BatchCreateWorkloadEstimateUsageItem::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("serviceCode")) { + m_serviceCode = jsonValue.GetString("serviceCode"); + m_serviceCodeHasBeenSet = true; } - if (m_usageTypeHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("usageType")) { + m_usageType = jsonValue.GetString("usageType"); + m_usageTypeHasBeenSet = true; } - if (m_operationHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("operation")) { + m_operation = jsonValue.GetString("operation"); + m_operationHasBeenSet = true; } - if (m_locationHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("location")) { + m_location = jsonValue.GetString("location"); + m_locationHasBeenSet = true; } - if (m_idHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("id")) { + m_id = jsonValue.GetString("id"); + m_idHasBeenSet = true; } - if (m_usageAccountIdHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("usageAccountId")) { + m_usageAccountId = jsonValue.GetString("usageAccountId"); + m_usageAccountIdHasBeenSet = true; } - if (m_groupHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("group")) { + m_group = jsonValue.GetString("group"); + m_groupHasBeenSet = true; } - if (m_quantityHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("quantity")) { + m_quantity = jsonValue.GetObject("quantity"); + m_quantityHasBeenSet = true; } - if (m_costHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("cost")) { + m_cost = jsonValue.GetDouble("cost"); + m_costHasBeenSet = true; } - if (m_currencyHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("currency")) { + m_currency = CurrencyCodeMapper::GetCurrencyCodeForName(jsonValue.GetString("currency")); + m_currencyHasBeenSet = true; } - if (m_statusHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("status")) { + m_status = WorkloadEstimateCostStatusMapper::GetWorkloadEstimateCostStatusForName(jsonValue.GetString("status")); + m_statusHasBeenSet = true; } - if (m_historicalUsageHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("historicalUsage")) { + m_historicalUsage = jsonValue.GetObject("historicalUsage"); + m_historicalUsageHasBeenSet = true; } - if (m_keyHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("key")) { + m_key = jsonValue.GetString("key"); + m_keyHasBeenSet = true; } + return *this; +} - encoder.WriteMapStart(mapSize); +JsonValue BatchCreateWorkloadEstimateUsageItem::Jsonize() const { + JsonValue payload; if (m_serviceCodeHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("serviceCode")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_serviceCode.c_str())); + payload.WithString("serviceCode", m_serviceCode); } if (m_usageTypeHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("usageType")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_usageType.c_str())); + payload.WithString("usageType", m_usageType); } if (m_operationHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("operation")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_operation.c_str())); + payload.WithString("operation", m_operation); } if (m_locationHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("location")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_location.c_str())); + payload.WithString("location", m_location); } if (m_idHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("id")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_id.c_str())); + payload.WithString("id", m_id); } if (m_usageAccountIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("usageAccountId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_usageAccountId.c_str())); + payload.WithString("usageAccountId", m_usageAccountId); } if (m_groupHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("group")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_group.c_str())); + payload.WithString("group", m_group); } if (m_quantityHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("quantity")); - m_quantity.CborEncode(encoder); + payload.WithObject("quantity", m_quantity.Jsonize()); } if (m_costHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("cost")); - encoder.WriteFloat(m_cost); + payload.WithDouble("cost", m_cost); } if (m_currencyHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("currency")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(CurrencyCodeMapper::GetNameForCurrencyCode(m_currency).c_str())); + payload.WithString("currency", CurrencyCodeMapper::GetNameForCurrencyCode(m_currency)); } if (m_statusHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("status")); - encoder.WriteText( - Aws::Crt::ByteCursorFromCString(WorkloadEstimateCostStatusMapper::GetNameForWorkloadEstimateCostStatus(m_status).c_str())); + payload.WithString("status", WorkloadEstimateCostStatusMapper::GetNameForWorkloadEstimateCostStatus(m_status)); } if (m_historicalUsageHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("historicalUsage")); - m_historicalUsage.CborEncode(encoder); + payload.WithObject("historicalUsage", m_historicalUsage.Jsonize()); } if (m_keyHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("key")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_key.c_str())); + payload.WithString("key", m_key); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateWorkloadEstimateUsageRequest.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateWorkloadEstimateUsageRequest.cpp index 7f77636ec59b..6491d3efa2e3 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateWorkloadEstimateUsageRequest.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateWorkloadEstimateUsageRequest.cpp @@ -4,56 +4,38 @@ */ #include -#include +#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; Aws::String BatchCreateWorkloadEstimateUsageRequest::SerializePayload() const { - Aws::Crt::Cbor::CborEncoder encoder; + JsonValue payload; - // Calculate map size - size_t mapSize = 0; if (m_workloadEstimateIdHasBeenSet) { - mapSize++; - } - if (m_usageHasBeenSet) { - mapSize++; - } - if (m_clientTokenHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); - - if (m_workloadEstimateIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("workloadEstimateId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_workloadEstimateId.c_str())); + payload.WithString("workloadEstimateId", m_workloadEstimateId); } if (m_usageHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("usage")); - encoder.WriteArrayStart(m_usage.size()); - for (const auto& item_0 : m_usage) { - item_0.CborEncode(encoder); + Aws::Utils::Array usageJsonList(m_usage.size()); + for (unsigned usageIndex = 0; usageIndex < usageJsonList.GetLength(); ++usageIndex) { + usageJsonList[usageIndex].AsObject(m_usage[usageIndex].Jsonize()); } + payload.WithArray("usage", std::move(usageJsonList)); } if (m_clientTokenHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("clientToken")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_clientToken.c_str())); + payload.WithString("clientToken", m_clientToken); } - const auto str = Aws::String(reinterpret_cast(encoder.GetEncodedData().ptr), encoder.GetEncodedData().len); - return str; + + return payload.View().WriteReadable(); } Aws::Http::HeaderValueCollection BatchCreateWorkloadEstimateUsageRequest::GetRequestSpecificHeaders() const { Aws::Http::HeaderValueCollection headers; - headers.emplace(Aws::Http::CONTENT_TYPE_HEADER, Aws::CBOR_CONTENT_TYPE); - headers.emplace(Aws::Http::SMITHY_PROTOCOL_HEADER, Aws::RPC_V2_CBOR); - headers.emplace(Aws::Http::ACCEPT_HEADER, Aws::CBOR_CONTENT_TYPE); + headers.insert(Aws::Http::HeaderValuePair("X-Amz-Target", "AWSBCMPricingCalculator.BatchCreateWorkloadEstimateUsage")); return headers; } diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateWorkloadEstimateUsageResult.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateWorkloadEstimateUsageResult.cpp index 7f17775b745b..377d48170fce 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateWorkloadEstimateUsageResult.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchCreateWorkloadEstimateUsageResult.cpp @@ -7,192 +7,37 @@ #include #include #include -#include +#include #include -#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; -using namespace Aws::Utils::Cbor; using namespace Aws; -BatchCreateWorkloadEstimateUsageResult::BatchCreateWorkloadEstimateUsageResult( - const Aws::AmazonWebServiceResult& result) { +BatchCreateWorkloadEstimateUsageResult::BatchCreateWorkloadEstimateUsageResult(const Aws::AmazonWebServiceResult& result) { *this = result; } BatchCreateWorkloadEstimateUsageResult& BatchCreateWorkloadEstimateUsageResult::operator=( - const Aws::AmazonWebServiceResult& result) { + const Aws::AmazonWebServiceResult& result) { m_HttpResponseCode = result.GetResponseCode(); - - const auto& cborValue = result.GetPayload(); - const auto decoder = cborValue.GetDecoder(); - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "items") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_items.push_back(BatchCreateWorkloadEstimateUsageItem(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_items.push_back(BatchCreateWorkloadEstimateUsageItem(decoder)); - } - } - } - m_itemsHasBeenSet = true; - } - - else if (initialKeyStr == "errors") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_errors.push_back(BatchCreateWorkloadEstimateUsageError(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_errors.push_back(BatchCreateWorkloadEstimateUsageError(decoder)); - } - } - } - m_errorsHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("BatchCreateWorkloadEstimateUsageResult", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "items") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_items.push_back(BatchCreateWorkloadEstimateUsageItem(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_items.push_back(BatchCreateWorkloadEstimateUsageItem(decoder)); - } - } - } - m_itemsHasBeenSet = true; - } - - else if (initialKeyStr == "errors") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_errors.push_back(BatchCreateWorkloadEstimateUsageError(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_errors.push_back(BatchCreateWorkloadEstimateUsageError(decoder)); - } - } - } - m_errorsHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } + JsonView jsonValue = result.GetPayload().View(); + if (jsonValue.ValueExists("items")) { + Aws::Utils::Array itemsJsonList = jsonValue.GetArray("items"); + for (unsigned itemsIndex = 0; itemsIndex < itemsJsonList.GetLength(); ++itemsIndex) { + m_items.push_back(itemsJsonList[itemsIndex].AsObject()); + } + m_itemsHasBeenSet = true; + } + if (jsonValue.ValueExists("errors")) { + Aws::Utils::Array errorsJsonList = jsonValue.GetArray("errors"); + for (unsigned errorsIndex = 0; errorsIndex < errorsJsonList.GetLength(); ++errorsIndex) { + m_errors.push_back(errorsJsonList[errorsIndex].AsObject()); } + m_errorsHasBeenSet = true; } const auto& headers = result.GetHeaderValueCollection(); diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchDeleteBillScenarioCommitmentModificationError.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchDeleteBillScenarioCommitmentModificationError.cpp index 1c54c75d5711..629f6a18c7e7 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchDeleteBillScenarioCommitmentModificationError.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchDeleteBillScenarioCommitmentModificationError.cpp @@ -4,246 +4,60 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -BatchDeleteBillScenarioCommitmentModificationError::BatchDeleteBillScenarioCommitmentModificationError( - const std::shared_ptr& decoder) { - *this = decoder; +BatchDeleteBillScenarioCommitmentModificationError::BatchDeleteBillScenarioCommitmentModificationError(JsonView jsonValue) { + *this = jsonValue; } -BatchDeleteBillScenarioCommitmentModificationError& BatchDeleteBillScenarioCommitmentModificationError::operator=( - const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "errorCode") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_errorCode = BatchDeleteBillScenarioCommitmentModificationErrorCodeMapper:: - GetBatchDeleteBillScenarioCommitmentModificationErrorCodeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_errorCodeHasBeenSet = true; - } - - else if (initialKeyStr == "errorMessage") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_errorMessage = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_errorMessage = ss.str(); - } - } - m_errorMessageHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("BatchDeleteBillScenarioCommitmentModificationError", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "errorCode") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_errorCode = BatchDeleteBillScenarioCommitmentModificationErrorCodeMapper:: - GetBatchDeleteBillScenarioCommitmentModificationErrorCodeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_errorCodeHasBeenSet = true; - } - - else if (initialKeyStr == "errorMessage") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_errorMessage = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_errorMessage = ss.str(); - } - } - m_errorMessageHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } - } - - return *this; -} - -void BatchDeleteBillScenarioCommitmentModificationError::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_idHasBeenSet) { - mapSize++; +BatchDeleteBillScenarioCommitmentModificationError& BatchDeleteBillScenarioCommitmentModificationError::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("id")) { + m_id = jsonValue.GetString("id"); + m_idHasBeenSet = true; } - if (m_errorCodeHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("errorCode")) { + m_errorCode = + BatchDeleteBillScenarioCommitmentModificationErrorCodeMapper::GetBatchDeleteBillScenarioCommitmentModificationErrorCodeForName( + jsonValue.GetString("errorCode")); + m_errorCodeHasBeenSet = true; } - if (m_errorMessageHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("errorMessage")) { + m_errorMessage = jsonValue.GetString("errorMessage"); + m_errorMessageHasBeenSet = true; } + return *this; +} - encoder.WriteMapStart(mapSize); +JsonValue BatchDeleteBillScenarioCommitmentModificationError::Jsonize() const { + JsonValue payload; if (m_idHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("id")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_id.c_str())); + payload.WithString("id", m_id); } if (m_errorCodeHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("errorCode")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString( + payload.WithString( + "errorCode", BatchDeleteBillScenarioCommitmentModificationErrorCodeMapper::GetNameForBatchDeleteBillScenarioCommitmentModificationErrorCode( - m_errorCode) - .c_str())); + m_errorCode)); } if (m_errorMessageHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("errorMessage")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_errorMessage.c_str())); + payload.WithString("errorMessage", m_errorMessage); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchDeleteBillScenarioCommitmentModificationRequest.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchDeleteBillScenarioCommitmentModificationRequest.cpp index 1876a8ff63f8..a1b68276dfb4 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchDeleteBillScenarioCommitmentModificationRequest.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchDeleteBillScenarioCommitmentModificationRequest.cpp @@ -4,48 +4,34 @@ */ #include -#include +#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; Aws::String BatchDeleteBillScenarioCommitmentModificationRequest::SerializePayload() const { - Aws::Crt::Cbor::CborEncoder encoder; + JsonValue payload; - // Calculate map size - size_t mapSize = 0; if (m_billScenarioIdHasBeenSet) { - mapSize++; - } - if (m_idsHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); - - if (m_billScenarioIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("billScenarioId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_billScenarioId.c_str())); + payload.WithString("billScenarioId", m_billScenarioId); } if (m_idsHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("ids")); - encoder.WriteArrayStart(m_ids.size()); - for (const auto& item_0 : m_ids) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString(item_0.c_str())); + Aws::Utils::Array idsJsonList(m_ids.size()); + for (unsigned idsIndex = 0; idsIndex < idsJsonList.GetLength(); ++idsIndex) { + idsJsonList[idsIndex].AsString(m_ids[idsIndex]); } + payload.WithArray("ids", std::move(idsJsonList)); } - const auto str = Aws::String(reinterpret_cast(encoder.GetEncodedData().ptr), encoder.GetEncodedData().len); - return str; + + return payload.View().WriteReadable(); } Aws::Http::HeaderValueCollection BatchDeleteBillScenarioCommitmentModificationRequest::GetRequestSpecificHeaders() const { Aws::Http::HeaderValueCollection headers; - headers.emplace(Aws::Http::CONTENT_TYPE_HEADER, Aws::CBOR_CONTENT_TYPE); - headers.emplace(Aws::Http::SMITHY_PROTOCOL_HEADER, Aws::RPC_V2_CBOR); - headers.emplace(Aws::Http::ACCEPT_HEADER, Aws::CBOR_CONTENT_TYPE); + headers.insert(Aws::Http::HeaderValuePair("X-Amz-Target", "AWSBCMPricingCalculator.BatchDeleteBillScenarioCommitmentModification")); return headers; } diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchDeleteBillScenarioCommitmentModificationResult.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchDeleteBillScenarioCommitmentModificationResult.cpp index 51d7ac5da757..8a9d1ef1d3fe 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchDeleteBillScenarioCommitmentModificationResult.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchDeleteBillScenarioCommitmentModificationResult.cpp @@ -7,134 +7,31 @@ #include #include #include -#include +#include #include -#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; -using namespace Aws::Utils::Cbor; using namespace Aws; BatchDeleteBillScenarioCommitmentModificationResult::BatchDeleteBillScenarioCommitmentModificationResult( - const Aws::AmazonWebServiceResult& result) { + const Aws::AmazonWebServiceResult& result) { *this = result; } BatchDeleteBillScenarioCommitmentModificationResult& BatchDeleteBillScenarioCommitmentModificationResult::operator=( - const Aws::AmazonWebServiceResult& result) { + const Aws::AmazonWebServiceResult& result) { m_HttpResponseCode = result.GetResponseCode(); - - const auto& cborValue = result.GetPayload(); - const auto decoder = cborValue.GetDecoder(); - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "errors") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_errors.push_back(BatchDeleteBillScenarioCommitmentModificationError(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_errors.push_back(BatchDeleteBillScenarioCommitmentModificationError(decoder)); - } - } - } - m_errorsHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("BatchDeleteBillScenarioCommitmentModificationResult", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "errors") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_errors.push_back(BatchDeleteBillScenarioCommitmentModificationError(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_errors.push_back(BatchDeleteBillScenarioCommitmentModificationError(decoder)); - } - } - } - m_errorsHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } + JsonView jsonValue = result.GetPayload().View(); + if (jsonValue.ValueExists("errors")) { + Aws::Utils::Array errorsJsonList = jsonValue.GetArray("errors"); + for (unsigned errorsIndex = 0; errorsIndex < errorsJsonList.GetLength(); ++errorsIndex) { + m_errors.push_back(errorsJsonList[errorsIndex].AsObject()); } + m_errorsHasBeenSet = true; } const auto& headers = result.GetHeaderValueCollection(); diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchDeleteBillScenarioUsageModificationError.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchDeleteBillScenarioUsageModificationError.cpp index 08f1e6ac7113..cb313ce0a8ed 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchDeleteBillScenarioUsageModificationError.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchDeleteBillScenarioUsageModificationError.cpp @@ -4,245 +4,56 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -BatchDeleteBillScenarioUsageModificationError::BatchDeleteBillScenarioUsageModificationError( - const std::shared_ptr& decoder) { - *this = decoder; -} - -BatchDeleteBillScenarioUsageModificationError& BatchDeleteBillScenarioUsageModificationError::operator=( - const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "errorMessage") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_errorMessage = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_errorMessage = ss.str(); - } - } - m_errorMessageHasBeenSet = true; - } - - else if (initialKeyStr == "errorCode") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_errorCode = - BatchDeleteBillScenarioUsageModificationErrorCodeMapper::GetBatchDeleteBillScenarioUsageModificationErrorCodeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_errorCodeHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("BatchDeleteBillScenarioUsageModificationError", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } +BatchDeleteBillScenarioUsageModificationError::BatchDeleteBillScenarioUsageModificationError(JsonView jsonValue) { *this = jsonValue; } - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "errorMessage") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_errorMessage = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_errorMessage = ss.str(); - } - } - m_errorMessageHasBeenSet = true; - } - - else if (initialKeyStr == "errorCode") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_errorCode = - BatchDeleteBillScenarioUsageModificationErrorCodeMapper::GetBatchDeleteBillScenarioUsageModificationErrorCodeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_errorCodeHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } +BatchDeleteBillScenarioUsageModificationError& BatchDeleteBillScenarioUsageModificationError::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("id")) { + m_id = jsonValue.GetString("id"); + m_idHasBeenSet = true; } - - return *this; -} - -void BatchDeleteBillScenarioUsageModificationError::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_idHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("errorMessage")) { + m_errorMessage = jsonValue.GetString("errorMessage"); + m_errorMessageHasBeenSet = true; } - if (m_errorMessageHasBeenSet) { - mapSize++; - } - if (m_errorCodeHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("errorCode")) { + m_errorCode = BatchDeleteBillScenarioUsageModificationErrorCodeMapper::GetBatchDeleteBillScenarioUsageModificationErrorCodeForName( + jsonValue.GetString("errorCode")); + m_errorCodeHasBeenSet = true; } + return *this; +} - encoder.WriteMapStart(mapSize); +JsonValue BatchDeleteBillScenarioUsageModificationError::Jsonize() const { + JsonValue payload; if (m_idHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("id")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_id.c_str())); + payload.WithString("id", m_id); } if (m_errorMessageHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("errorMessage")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_errorMessage.c_str())); + payload.WithString("errorMessage", m_errorMessage); } if (m_errorCodeHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("errorCode")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString( - BatchDeleteBillScenarioUsageModificationErrorCodeMapper::GetNameForBatchDeleteBillScenarioUsageModificationErrorCode(m_errorCode) - .c_str())); + payload.WithString( + "errorCode", + BatchDeleteBillScenarioUsageModificationErrorCodeMapper::GetNameForBatchDeleteBillScenarioUsageModificationErrorCode(m_errorCode)); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchDeleteBillScenarioUsageModificationRequest.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchDeleteBillScenarioUsageModificationRequest.cpp index 29134257d92e..0d8dad50e044 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchDeleteBillScenarioUsageModificationRequest.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchDeleteBillScenarioUsageModificationRequest.cpp @@ -4,48 +4,34 @@ */ #include -#include +#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; Aws::String BatchDeleteBillScenarioUsageModificationRequest::SerializePayload() const { - Aws::Crt::Cbor::CborEncoder encoder; + JsonValue payload; - // Calculate map size - size_t mapSize = 0; if (m_billScenarioIdHasBeenSet) { - mapSize++; - } - if (m_idsHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); - - if (m_billScenarioIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("billScenarioId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_billScenarioId.c_str())); + payload.WithString("billScenarioId", m_billScenarioId); } if (m_idsHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("ids")); - encoder.WriteArrayStart(m_ids.size()); - for (const auto& item_0 : m_ids) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString(item_0.c_str())); + Aws::Utils::Array idsJsonList(m_ids.size()); + for (unsigned idsIndex = 0; idsIndex < idsJsonList.GetLength(); ++idsIndex) { + idsJsonList[idsIndex].AsString(m_ids[idsIndex]); } + payload.WithArray("ids", std::move(idsJsonList)); } - const auto str = Aws::String(reinterpret_cast(encoder.GetEncodedData().ptr), encoder.GetEncodedData().len); - return str; + + return payload.View().WriteReadable(); } Aws::Http::HeaderValueCollection BatchDeleteBillScenarioUsageModificationRequest::GetRequestSpecificHeaders() const { Aws::Http::HeaderValueCollection headers; - headers.emplace(Aws::Http::CONTENT_TYPE_HEADER, Aws::CBOR_CONTENT_TYPE); - headers.emplace(Aws::Http::SMITHY_PROTOCOL_HEADER, Aws::RPC_V2_CBOR); - headers.emplace(Aws::Http::ACCEPT_HEADER, Aws::CBOR_CONTENT_TYPE); + headers.insert(Aws::Http::HeaderValuePair("X-Amz-Target", "AWSBCMPricingCalculator.BatchDeleteBillScenarioUsageModification")); return headers; } diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchDeleteBillScenarioUsageModificationResult.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchDeleteBillScenarioUsageModificationResult.cpp index c61eff2c3b94..c726170fa9b1 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchDeleteBillScenarioUsageModificationResult.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchDeleteBillScenarioUsageModificationResult.cpp @@ -7,134 +7,31 @@ #include #include #include -#include +#include #include -#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; -using namespace Aws::Utils::Cbor; using namespace Aws; BatchDeleteBillScenarioUsageModificationResult::BatchDeleteBillScenarioUsageModificationResult( - const Aws::AmazonWebServiceResult& result) { + const Aws::AmazonWebServiceResult& result) { *this = result; } BatchDeleteBillScenarioUsageModificationResult& BatchDeleteBillScenarioUsageModificationResult::operator=( - const Aws::AmazonWebServiceResult& result) { + const Aws::AmazonWebServiceResult& result) { m_HttpResponseCode = result.GetResponseCode(); - - const auto& cborValue = result.GetPayload(); - const auto decoder = cborValue.GetDecoder(); - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "errors") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_errors.push_back(BatchDeleteBillScenarioUsageModificationError(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_errors.push_back(BatchDeleteBillScenarioUsageModificationError(decoder)); - } - } - } - m_errorsHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("BatchDeleteBillScenarioUsageModificationResult", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "errors") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_errors.push_back(BatchDeleteBillScenarioUsageModificationError(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_errors.push_back(BatchDeleteBillScenarioUsageModificationError(decoder)); - } - } - } - m_errorsHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } + JsonView jsonValue = result.GetPayload().View(); + if (jsonValue.ValueExists("errors")) { + Aws::Utils::Array errorsJsonList = jsonValue.GetArray("errors"); + for (unsigned errorsIndex = 0; errorsIndex < errorsJsonList.GetLength(); ++errorsIndex) { + m_errors.push_back(errorsJsonList[errorsIndex].AsObject()); } + m_errorsHasBeenSet = true; } const auto& headers = result.GetHeaderValueCollection(); diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchDeleteWorkloadEstimateUsageError.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchDeleteWorkloadEstimateUsageError.cpp index 9bf2066d64b1..7def06074c35 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchDeleteWorkloadEstimateUsageError.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchDeleteWorkloadEstimateUsageError.cpp @@ -4,241 +4,55 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -BatchDeleteWorkloadEstimateUsageError::BatchDeleteWorkloadEstimateUsageError(const std::shared_ptr& decoder) { - *this = decoder; -} - -BatchDeleteWorkloadEstimateUsageError& BatchDeleteWorkloadEstimateUsageError::operator=( - const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "errorMessage") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_errorMessage = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_errorMessage = ss.str(); - } - } - m_errorMessageHasBeenSet = true; - } - - else if (initialKeyStr == "errorCode") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_errorCode = WorkloadEstimateUpdateUsageErrorCodeMapper::GetWorkloadEstimateUpdateUsageErrorCodeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_errorCodeHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("BatchDeleteWorkloadEstimateUsageError", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } +BatchDeleteWorkloadEstimateUsageError::BatchDeleteWorkloadEstimateUsageError(JsonView jsonValue) { *this = jsonValue; } - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "errorMessage") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_errorMessage = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_errorMessage = ss.str(); - } - } - m_errorMessageHasBeenSet = true; - } - - else if (initialKeyStr == "errorCode") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_errorCode = WorkloadEstimateUpdateUsageErrorCodeMapper::GetWorkloadEstimateUpdateUsageErrorCodeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_errorCodeHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } +BatchDeleteWorkloadEstimateUsageError& BatchDeleteWorkloadEstimateUsageError::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("id")) { + m_id = jsonValue.GetString("id"); + m_idHasBeenSet = true; } - - return *this; -} - -void BatchDeleteWorkloadEstimateUsageError::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_idHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("errorMessage")) { + m_errorMessage = jsonValue.GetString("errorMessage"); + m_errorMessageHasBeenSet = true; } - if (m_errorMessageHasBeenSet) { - mapSize++; - } - if (m_errorCodeHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("errorCode")) { + m_errorCode = + WorkloadEstimateUpdateUsageErrorCodeMapper::GetWorkloadEstimateUpdateUsageErrorCodeForName(jsonValue.GetString("errorCode")); + m_errorCodeHasBeenSet = true; } + return *this; +} - encoder.WriteMapStart(mapSize); +JsonValue BatchDeleteWorkloadEstimateUsageError::Jsonize() const { + JsonValue payload; if (m_idHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("id")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_id.c_str())); + payload.WithString("id", m_id); } if (m_errorMessageHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("errorMessage")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_errorMessage.c_str())); + payload.WithString("errorMessage", m_errorMessage); } if (m_errorCodeHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("errorCode")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString( - WorkloadEstimateUpdateUsageErrorCodeMapper::GetNameForWorkloadEstimateUpdateUsageErrorCode(m_errorCode).c_str())); + payload.WithString("errorCode", + WorkloadEstimateUpdateUsageErrorCodeMapper::GetNameForWorkloadEstimateUpdateUsageErrorCode(m_errorCode)); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchDeleteWorkloadEstimateUsageRequest.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchDeleteWorkloadEstimateUsageRequest.cpp index 54e71debeeb6..d30f9da45c69 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchDeleteWorkloadEstimateUsageRequest.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchDeleteWorkloadEstimateUsageRequest.cpp @@ -4,48 +4,34 @@ */ #include -#include +#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; Aws::String BatchDeleteWorkloadEstimateUsageRequest::SerializePayload() const { - Aws::Crt::Cbor::CborEncoder encoder; + JsonValue payload; - // Calculate map size - size_t mapSize = 0; if (m_workloadEstimateIdHasBeenSet) { - mapSize++; - } - if (m_idsHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); - - if (m_workloadEstimateIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("workloadEstimateId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_workloadEstimateId.c_str())); + payload.WithString("workloadEstimateId", m_workloadEstimateId); } if (m_idsHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("ids")); - encoder.WriteArrayStart(m_ids.size()); - for (const auto& item_0 : m_ids) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString(item_0.c_str())); + Aws::Utils::Array idsJsonList(m_ids.size()); + for (unsigned idsIndex = 0; idsIndex < idsJsonList.GetLength(); ++idsIndex) { + idsJsonList[idsIndex].AsString(m_ids[idsIndex]); } + payload.WithArray("ids", std::move(idsJsonList)); } - const auto str = Aws::String(reinterpret_cast(encoder.GetEncodedData().ptr), encoder.GetEncodedData().len); - return str; + + return payload.View().WriteReadable(); } Aws::Http::HeaderValueCollection BatchDeleteWorkloadEstimateUsageRequest::GetRequestSpecificHeaders() const { Aws::Http::HeaderValueCollection headers; - headers.emplace(Aws::Http::CONTENT_TYPE_HEADER, Aws::CBOR_CONTENT_TYPE); - headers.emplace(Aws::Http::SMITHY_PROTOCOL_HEADER, Aws::RPC_V2_CBOR); - headers.emplace(Aws::Http::ACCEPT_HEADER, Aws::CBOR_CONTENT_TYPE); + headers.insert(Aws::Http::HeaderValuePair("X-Amz-Target", "AWSBCMPricingCalculator.BatchDeleteWorkloadEstimateUsage")); return headers; } diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchDeleteWorkloadEstimateUsageResult.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchDeleteWorkloadEstimateUsageResult.cpp index a0080e8a892f..dec7fbc960be 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchDeleteWorkloadEstimateUsageResult.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchDeleteWorkloadEstimateUsageResult.cpp @@ -7,134 +7,30 @@ #include #include #include -#include +#include #include -#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; -using namespace Aws::Utils::Cbor; using namespace Aws; -BatchDeleteWorkloadEstimateUsageResult::BatchDeleteWorkloadEstimateUsageResult( - const Aws::AmazonWebServiceResult& result) { +BatchDeleteWorkloadEstimateUsageResult::BatchDeleteWorkloadEstimateUsageResult(const Aws::AmazonWebServiceResult& result) { *this = result; } BatchDeleteWorkloadEstimateUsageResult& BatchDeleteWorkloadEstimateUsageResult::operator=( - const Aws::AmazonWebServiceResult& result) { + const Aws::AmazonWebServiceResult& result) { m_HttpResponseCode = result.GetResponseCode(); - - const auto& cborValue = result.GetPayload(); - const auto decoder = cborValue.GetDecoder(); - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "errors") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_errors.push_back(BatchDeleteWorkloadEstimateUsageError(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_errors.push_back(BatchDeleteWorkloadEstimateUsageError(decoder)); - } - } - } - m_errorsHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("BatchDeleteWorkloadEstimateUsageResult", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "errors") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_errors.push_back(BatchDeleteWorkloadEstimateUsageError(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_errors.push_back(BatchDeleteWorkloadEstimateUsageError(decoder)); - } - } - } - m_errorsHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } + JsonView jsonValue = result.GetPayload().View(); + if (jsonValue.ValueExists("errors")) { + Aws::Utils::Array errorsJsonList = jsonValue.GetArray("errors"); + for (unsigned errorsIndex = 0; errorsIndex < errorsJsonList.GetLength(); ++errorsIndex) { + m_errors.push_back(errorsJsonList[errorsIndex].AsObject()); } + m_errorsHasBeenSet = true; } const auto& headers = result.GetHeaderValueCollection(); diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateBillScenarioCommitmentModificationEntry.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateBillScenarioCommitmentModificationEntry.cpp index eea4776fccee..e2bc24bff8cd 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateBillScenarioCommitmentModificationEntry.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateBillScenarioCommitmentModificationEntry.cpp @@ -4,215 +4,47 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -BatchUpdateBillScenarioCommitmentModificationEntry::BatchUpdateBillScenarioCommitmentModificationEntry( - const std::shared_ptr& decoder) { - *this = decoder; +BatchUpdateBillScenarioCommitmentModificationEntry::BatchUpdateBillScenarioCommitmentModificationEntry(JsonView jsonValue) { + *this = jsonValue; } -BatchUpdateBillScenarioCommitmentModificationEntry& BatchUpdateBillScenarioCommitmentModificationEntry::operator=( - const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "group") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_group = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_group = ss.str(); - } - } - m_groupHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("BatchUpdateBillScenarioCommitmentModificationEntry", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "group") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_group = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_group = ss.str(); - } - } - m_groupHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } +BatchUpdateBillScenarioCommitmentModificationEntry& BatchUpdateBillScenarioCommitmentModificationEntry::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("id")) { + m_id = jsonValue.GetString("id"); + m_idHasBeenSet = true; + } + if (jsonValue.ValueExists("group")) { + m_group = jsonValue.GetString("group"); + m_groupHasBeenSet = true; } - return *this; } -void BatchUpdateBillScenarioCommitmentModificationEntry::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_idHasBeenSet) { - mapSize++; - } - if (m_groupHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); +JsonValue BatchUpdateBillScenarioCommitmentModificationEntry::Jsonize() const { + JsonValue payload; if (m_idHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("id")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_id.c_str())); + payload.WithString("id", m_id); } if (m_groupHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("group")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_group.c_str())); + payload.WithString("group", m_group); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateBillScenarioCommitmentModificationError.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateBillScenarioCommitmentModificationError.cpp index f403dfeb5141..65bdb57f0a80 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateBillScenarioCommitmentModificationError.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateBillScenarioCommitmentModificationError.cpp @@ -4,246 +4,60 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -BatchUpdateBillScenarioCommitmentModificationError::BatchUpdateBillScenarioCommitmentModificationError( - const std::shared_ptr& decoder) { - *this = decoder; +BatchUpdateBillScenarioCommitmentModificationError::BatchUpdateBillScenarioCommitmentModificationError(JsonView jsonValue) { + *this = jsonValue; } -BatchUpdateBillScenarioCommitmentModificationError& BatchUpdateBillScenarioCommitmentModificationError::operator=( - const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "errorCode") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_errorCode = BatchUpdateBillScenarioCommitmentModificationErrorCodeMapper:: - GetBatchUpdateBillScenarioCommitmentModificationErrorCodeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_errorCodeHasBeenSet = true; - } - - else if (initialKeyStr == "errorMessage") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_errorMessage = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_errorMessage = ss.str(); - } - } - m_errorMessageHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("BatchUpdateBillScenarioCommitmentModificationError", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "errorCode") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_errorCode = BatchUpdateBillScenarioCommitmentModificationErrorCodeMapper:: - GetBatchUpdateBillScenarioCommitmentModificationErrorCodeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_errorCodeHasBeenSet = true; - } - - else if (initialKeyStr == "errorMessage") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_errorMessage = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_errorMessage = ss.str(); - } - } - m_errorMessageHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } - } - - return *this; -} - -void BatchUpdateBillScenarioCommitmentModificationError::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_idHasBeenSet) { - mapSize++; +BatchUpdateBillScenarioCommitmentModificationError& BatchUpdateBillScenarioCommitmentModificationError::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("id")) { + m_id = jsonValue.GetString("id"); + m_idHasBeenSet = true; } - if (m_errorCodeHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("errorCode")) { + m_errorCode = + BatchUpdateBillScenarioCommitmentModificationErrorCodeMapper::GetBatchUpdateBillScenarioCommitmentModificationErrorCodeForName( + jsonValue.GetString("errorCode")); + m_errorCodeHasBeenSet = true; } - if (m_errorMessageHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("errorMessage")) { + m_errorMessage = jsonValue.GetString("errorMessage"); + m_errorMessageHasBeenSet = true; } + return *this; +} - encoder.WriteMapStart(mapSize); +JsonValue BatchUpdateBillScenarioCommitmentModificationError::Jsonize() const { + JsonValue payload; if (m_idHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("id")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_id.c_str())); + payload.WithString("id", m_id); } if (m_errorCodeHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("errorCode")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString( + payload.WithString( + "errorCode", BatchUpdateBillScenarioCommitmentModificationErrorCodeMapper::GetNameForBatchUpdateBillScenarioCommitmentModificationErrorCode( - m_errorCode) - .c_str())); + m_errorCode)); } if (m_errorMessageHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("errorMessage")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_errorMessage.c_str())); + payload.WithString("errorMessage", m_errorMessage); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateBillScenarioCommitmentModificationRequest.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateBillScenarioCommitmentModificationRequest.cpp index 7b4ed81eb180..2b9dab478cdc 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateBillScenarioCommitmentModificationRequest.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateBillScenarioCommitmentModificationRequest.cpp @@ -4,48 +4,36 @@ */ #include -#include +#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; Aws::String BatchUpdateBillScenarioCommitmentModificationRequest::SerializePayload() const { - Aws::Crt::Cbor::CborEncoder encoder; + JsonValue payload; - // Calculate map size - size_t mapSize = 0; if (m_billScenarioIdHasBeenSet) { - mapSize++; - } - if (m_commitmentModificationsHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); - - if (m_billScenarioIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("billScenarioId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_billScenarioId.c_str())); + payload.WithString("billScenarioId", m_billScenarioId); } if (m_commitmentModificationsHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("commitmentModifications")); - encoder.WriteArrayStart(m_commitmentModifications.size()); - for (const auto& item_0 : m_commitmentModifications) { - item_0.CborEncode(encoder); + Aws::Utils::Array commitmentModificationsJsonList(m_commitmentModifications.size()); + for (unsigned commitmentModificationsIndex = 0; commitmentModificationsIndex < commitmentModificationsJsonList.GetLength(); + ++commitmentModificationsIndex) { + commitmentModificationsJsonList[commitmentModificationsIndex].AsObject( + m_commitmentModifications[commitmentModificationsIndex].Jsonize()); } + payload.WithArray("commitmentModifications", std::move(commitmentModificationsJsonList)); } - const auto str = Aws::String(reinterpret_cast(encoder.GetEncodedData().ptr), encoder.GetEncodedData().len); - return str; + + return payload.View().WriteReadable(); } Aws::Http::HeaderValueCollection BatchUpdateBillScenarioCommitmentModificationRequest::GetRequestSpecificHeaders() const { Aws::Http::HeaderValueCollection headers; - headers.emplace(Aws::Http::CONTENT_TYPE_HEADER, Aws::CBOR_CONTENT_TYPE); - headers.emplace(Aws::Http::SMITHY_PROTOCOL_HEADER, Aws::RPC_V2_CBOR); - headers.emplace(Aws::Http::ACCEPT_HEADER, Aws::CBOR_CONTENT_TYPE); + headers.insert(Aws::Http::HeaderValuePair("X-Amz-Target", "AWSBCMPricingCalculator.BatchUpdateBillScenarioCommitmentModification")); return headers; } diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateBillScenarioCommitmentModificationResult.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateBillScenarioCommitmentModificationResult.cpp index 64ce66c165d2..af1527a14467 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateBillScenarioCommitmentModificationResult.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateBillScenarioCommitmentModificationResult.cpp @@ -7,192 +7,38 @@ #include #include #include -#include +#include #include -#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; -using namespace Aws::Utils::Cbor; using namespace Aws; BatchUpdateBillScenarioCommitmentModificationResult::BatchUpdateBillScenarioCommitmentModificationResult( - const Aws::AmazonWebServiceResult& result) { + const Aws::AmazonWebServiceResult& result) { *this = result; } BatchUpdateBillScenarioCommitmentModificationResult& BatchUpdateBillScenarioCommitmentModificationResult::operator=( - const Aws::AmazonWebServiceResult& result) { + const Aws::AmazonWebServiceResult& result) { m_HttpResponseCode = result.GetResponseCode(); - - const auto& cborValue = result.GetPayload(); - const auto decoder = cborValue.GetDecoder(); - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "items") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_items.push_back(BillScenarioCommitmentModificationItem(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_items.push_back(BillScenarioCommitmentModificationItem(decoder)); - } - } - } - m_itemsHasBeenSet = true; - } - - else if (initialKeyStr == "errors") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_errors.push_back(BatchUpdateBillScenarioCommitmentModificationError(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_errors.push_back(BatchUpdateBillScenarioCommitmentModificationError(decoder)); - } - } - } - m_errorsHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("BatchUpdateBillScenarioCommitmentModificationResult", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "items") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_items.push_back(BillScenarioCommitmentModificationItem(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_items.push_back(BillScenarioCommitmentModificationItem(decoder)); - } - } - } - m_itemsHasBeenSet = true; - } - - else if (initialKeyStr == "errors") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_errors.push_back(BatchUpdateBillScenarioCommitmentModificationError(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_errors.push_back(BatchUpdateBillScenarioCommitmentModificationError(decoder)); - } - } - } - m_errorsHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } + JsonView jsonValue = result.GetPayload().View(); + if (jsonValue.ValueExists("items")) { + Aws::Utils::Array itemsJsonList = jsonValue.GetArray("items"); + for (unsigned itemsIndex = 0; itemsIndex < itemsJsonList.GetLength(); ++itemsIndex) { + m_items.push_back(itemsJsonList[itemsIndex].AsObject()); + } + m_itemsHasBeenSet = true; + } + if (jsonValue.ValueExists("errors")) { + Aws::Utils::Array errorsJsonList = jsonValue.GetArray("errors"); + for (unsigned errorsIndex = 0; errorsIndex < errorsJsonList.GetLength(); ++errorsIndex) { + m_errors.push_back(errorsJsonList[errorsIndex].AsObject()); } + m_errorsHasBeenSet = true; } const auto& headers = result.GetHeaderValueCollection(); diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateBillScenarioUsageModificationEntry.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateBillScenarioUsageModificationEntry.cpp index 7da67ccc7491..90b9f62c83b6 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateBillScenarioUsageModificationEntry.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateBillScenarioUsageModificationEntry.cpp @@ -4,284 +4,60 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -BatchUpdateBillScenarioUsageModificationEntry::BatchUpdateBillScenarioUsageModificationEntry( - const std::shared_ptr& decoder) { - *this = decoder; -} - -BatchUpdateBillScenarioUsageModificationEntry& BatchUpdateBillScenarioUsageModificationEntry::operator=( - const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "group") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_group = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_group = ss.str(); - } - } - m_groupHasBeenSet = true; - } - - else if (initialKeyStr == "amounts") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_amounts.push_back(UsageAmount(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_amounts.push_back(UsageAmount(decoder)); - } - } - } - m_amountsHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("BatchUpdateBillScenarioUsageModificationEntry", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } +BatchUpdateBillScenarioUsageModificationEntry::BatchUpdateBillScenarioUsageModificationEntry(JsonView jsonValue) { *this = jsonValue; } - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "group") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_group = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_group = ss.str(); - } - } - m_groupHasBeenSet = true; - } - - else if (initialKeyStr == "amounts") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_amounts.push_back(UsageAmount(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_amounts.push_back(UsageAmount(decoder)); - } - } - } - m_amountsHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } +BatchUpdateBillScenarioUsageModificationEntry& BatchUpdateBillScenarioUsageModificationEntry::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("id")) { + m_id = jsonValue.GetString("id"); + m_idHasBeenSet = true; + } + if (jsonValue.ValueExists("group")) { + m_group = jsonValue.GetString("group"); + m_groupHasBeenSet = true; + } + if (jsonValue.ValueExists("amounts")) { + Aws::Utils::Array amountsJsonList = jsonValue.GetArray("amounts"); + for (unsigned amountsIndex = 0; amountsIndex < amountsJsonList.GetLength(); ++amountsIndex) { + m_amounts.push_back(amountsJsonList[amountsIndex].AsObject()); } + m_amountsHasBeenSet = true; } - return *this; } -void BatchUpdateBillScenarioUsageModificationEntry::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_idHasBeenSet) { - mapSize++; - } - if (m_groupHasBeenSet) { - mapSize++; - } - if (m_amountsHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); +JsonValue BatchUpdateBillScenarioUsageModificationEntry::Jsonize() const { + JsonValue payload; if (m_idHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("id")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_id.c_str())); + payload.WithString("id", m_id); } if (m_groupHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("group")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_group.c_str())); + payload.WithString("group", m_group); } if (m_amountsHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("amounts")); - encoder.WriteArrayStart(m_amounts.size()); - for (const auto& item_0 : m_amounts) { - item_0.CborEncode(encoder); + Aws::Utils::Array amountsJsonList(m_amounts.size()); + for (unsigned amountsIndex = 0; amountsIndex < amountsJsonList.GetLength(); ++amountsIndex) { + amountsJsonList[amountsIndex].AsObject(m_amounts[amountsIndex].Jsonize()); } + payload.WithArray("amounts", std::move(amountsJsonList)); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateBillScenarioUsageModificationError.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateBillScenarioUsageModificationError.cpp index 166e263a5740..f34f705475a2 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateBillScenarioUsageModificationError.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateBillScenarioUsageModificationError.cpp @@ -4,245 +4,56 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -BatchUpdateBillScenarioUsageModificationError::BatchUpdateBillScenarioUsageModificationError( - const std::shared_ptr& decoder) { - *this = decoder; -} - -BatchUpdateBillScenarioUsageModificationError& BatchUpdateBillScenarioUsageModificationError::operator=( - const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "errorMessage") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_errorMessage = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_errorMessage = ss.str(); - } - } - m_errorMessageHasBeenSet = true; - } - - else if (initialKeyStr == "errorCode") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_errorCode = - BatchUpdateBillScenarioUsageModificationErrorCodeMapper::GetBatchUpdateBillScenarioUsageModificationErrorCodeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_errorCodeHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("BatchUpdateBillScenarioUsageModificationError", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } +BatchUpdateBillScenarioUsageModificationError::BatchUpdateBillScenarioUsageModificationError(JsonView jsonValue) { *this = jsonValue; } - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "errorMessage") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_errorMessage = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_errorMessage = ss.str(); - } - } - m_errorMessageHasBeenSet = true; - } - - else if (initialKeyStr == "errorCode") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_errorCode = - BatchUpdateBillScenarioUsageModificationErrorCodeMapper::GetBatchUpdateBillScenarioUsageModificationErrorCodeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_errorCodeHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } +BatchUpdateBillScenarioUsageModificationError& BatchUpdateBillScenarioUsageModificationError::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("id")) { + m_id = jsonValue.GetString("id"); + m_idHasBeenSet = true; } - - return *this; -} - -void BatchUpdateBillScenarioUsageModificationError::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_idHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("errorMessage")) { + m_errorMessage = jsonValue.GetString("errorMessage"); + m_errorMessageHasBeenSet = true; } - if (m_errorMessageHasBeenSet) { - mapSize++; - } - if (m_errorCodeHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("errorCode")) { + m_errorCode = BatchUpdateBillScenarioUsageModificationErrorCodeMapper::GetBatchUpdateBillScenarioUsageModificationErrorCodeForName( + jsonValue.GetString("errorCode")); + m_errorCodeHasBeenSet = true; } + return *this; +} - encoder.WriteMapStart(mapSize); +JsonValue BatchUpdateBillScenarioUsageModificationError::Jsonize() const { + JsonValue payload; if (m_idHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("id")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_id.c_str())); + payload.WithString("id", m_id); } if (m_errorMessageHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("errorMessage")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_errorMessage.c_str())); + payload.WithString("errorMessage", m_errorMessage); } if (m_errorCodeHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("errorCode")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString( - BatchUpdateBillScenarioUsageModificationErrorCodeMapper::GetNameForBatchUpdateBillScenarioUsageModificationErrorCode(m_errorCode) - .c_str())); + payload.WithString( + "errorCode", + BatchUpdateBillScenarioUsageModificationErrorCodeMapper::GetNameForBatchUpdateBillScenarioUsageModificationErrorCode(m_errorCode)); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateBillScenarioUsageModificationRequest.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateBillScenarioUsageModificationRequest.cpp index 80ad84cced69..eab2df0681d4 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateBillScenarioUsageModificationRequest.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateBillScenarioUsageModificationRequest.cpp @@ -4,48 +4,35 @@ */ #include -#include +#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; Aws::String BatchUpdateBillScenarioUsageModificationRequest::SerializePayload() const { - Aws::Crt::Cbor::CborEncoder encoder; + JsonValue payload; - // Calculate map size - size_t mapSize = 0; if (m_billScenarioIdHasBeenSet) { - mapSize++; - } - if (m_usageModificationsHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); - - if (m_billScenarioIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("billScenarioId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_billScenarioId.c_str())); + payload.WithString("billScenarioId", m_billScenarioId); } if (m_usageModificationsHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("usageModifications")); - encoder.WriteArrayStart(m_usageModifications.size()); - for (const auto& item_0 : m_usageModifications) { - item_0.CborEncode(encoder); + Aws::Utils::Array usageModificationsJsonList(m_usageModifications.size()); + for (unsigned usageModificationsIndex = 0; usageModificationsIndex < usageModificationsJsonList.GetLength(); + ++usageModificationsIndex) { + usageModificationsJsonList[usageModificationsIndex].AsObject(m_usageModifications[usageModificationsIndex].Jsonize()); } + payload.WithArray("usageModifications", std::move(usageModificationsJsonList)); } - const auto str = Aws::String(reinterpret_cast(encoder.GetEncodedData().ptr), encoder.GetEncodedData().len); - return str; + + return payload.View().WriteReadable(); } Aws::Http::HeaderValueCollection BatchUpdateBillScenarioUsageModificationRequest::GetRequestSpecificHeaders() const { Aws::Http::HeaderValueCollection headers; - headers.emplace(Aws::Http::CONTENT_TYPE_HEADER, Aws::CBOR_CONTENT_TYPE); - headers.emplace(Aws::Http::SMITHY_PROTOCOL_HEADER, Aws::RPC_V2_CBOR); - headers.emplace(Aws::Http::ACCEPT_HEADER, Aws::CBOR_CONTENT_TYPE); + headers.insert(Aws::Http::HeaderValuePair("X-Amz-Target", "AWSBCMPricingCalculator.BatchUpdateBillScenarioUsageModification")); return headers; } diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateBillScenarioUsageModificationResult.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateBillScenarioUsageModificationResult.cpp index c8c363b3eba7..8f40843a819f 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateBillScenarioUsageModificationResult.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateBillScenarioUsageModificationResult.cpp @@ -7,192 +7,38 @@ #include #include #include -#include +#include #include -#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; -using namespace Aws::Utils::Cbor; using namespace Aws; BatchUpdateBillScenarioUsageModificationResult::BatchUpdateBillScenarioUsageModificationResult( - const Aws::AmazonWebServiceResult& result) { + const Aws::AmazonWebServiceResult& result) { *this = result; } BatchUpdateBillScenarioUsageModificationResult& BatchUpdateBillScenarioUsageModificationResult::operator=( - const Aws::AmazonWebServiceResult& result) { + const Aws::AmazonWebServiceResult& result) { m_HttpResponseCode = result.GetResponseCode(); - - const auto& cborValue = result.GetPayload(); - const auto decoder = cborValue.GetDecoder(); - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "items") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_items.push_back(BillScenarioUsageModificationItem(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_items.push_back(BillScenarioUsageModificationItem(decoder)); - } - } - } - m_itemsHasBeenSet = true; - } - - else if (initialKeyStr == "errors") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_errors.push_back(BatchUpdateBillScenarioUsageModificationError(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_errors.push_back(BatchUpdateBillScenarioUsageModificationError(decoder)); - } - } - } - m_errorsHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("BatchUpdateBillScenarioUsageModificationResult", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "items") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_items.push_back(BillScenarioUsageModificationItem(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_items.push_back(BillScenarioUsageModificationItem(decoder)); - } - } - } - m_itemsHasBeenSet = true; - } - - else if (initialKeyStr == "errors") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_errors.push_back(BatchUpdateBillScenarioUsageModificationError(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_errors.push_back(BatchUpdateBillScenarioUsageModificationError(decoder)); - } - } - } - m_errorsHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } + JsonView jsonValue = result.GetPayload().View(); + if (jsonValue.ValueExists("items")) { + Aws::Utils::Array itemsJsonList = jsonValue.GetArray("items"); + for (unsigned itemsIndex = 0; itemsIndex < itemsJsonList.GetLength(); ++itemsIndex) { + m_items.push_back(itemsJsonList[itemsIndex].AsObject()); + } + m_itemsHasBeenSet = true; + } + if (jsonValue.ValueExists("errors")) { + Aws::Utils::Array errorsJsonList = jsonValue.GetArray("errors"); + for (unsigned errorsIndex = 0; errorsIndex < errorsJsonList.GetLength(); ++errorsIndex) { + m_errors.push_back(errorsJsonList[errorsIndex].AsObject()); } + m_errorsHasBeenSet = true; } const auto& headers = result.GetHeaderValueCollection(); diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateWorkloadEstimateUsageEntry.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateWorkloadEstimateUsageEntry.cpp index 1bbaed42cf91..91b82c5f5fd1 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateWorkloadEstimateUsageEntry.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateWorkloadEstimateUsageEntry.cpp @@ -4,238 +4,53 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -BatchUpdateWorkloadEstimateUsageEntry::BatchUpdateWorkloadEstimateUsageEntry(const std::shared_ptr& decoder) { - *this = decoder; -} - -BatchUpdateWorkloadEstimateUsageEntry& BatchUpdateWorkloadEstimateUsageEntry::operator=( - const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "group") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_group = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_group = ss.str(); - } - } - m_groupHasBeenSet = true; - } - - else if (initialKeyStr == "amount") { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_amount = val.value(); - } - m_amountHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("BatchUpdateWorkloadEstimateUsageEntry", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } +BatchUpdateWorkloadEstimateUsageEntry::BatchUpdateWorkloadEstimateUsageEntry(JsonView jsonValue) { *this = jsonValue; } - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "group") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_group = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_group = ss.str(); - } - } - m_groupHasBeenSet = true; - } - - else if (initialKeyStr == "amount") { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_amount = val.value(); - } - m_amountHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } +BatchUpdateWorkloadEstimateUsageEntry& BatchUpdateWorkloadEstimateUsageEntry::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("id")) { + m_id = jsonValue.GetString("id"); + m_idHasBeenSet = true; } - - return *this; -} - -void BatchUpdateWorkloadEstimateUsageEntry::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_idHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("group")) { + m_group = jsonValue.GetString("group"); + m_groupHasBeenSet = true; } - if (m_groupHasBeenSet) { - mapSize++; - } - if (m_amountHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("amount")) { + m_amount = jsonValue.GetDouble("amount"); + m_amountHasBeenSet = true; } + return *this; +} - encoder.WriteMapStart(mapSize); +JsonValue BatchUpdateWorkloadEstimateUsageEntry::Jsonize() const { + JsonValue payload; if (m_idHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("id")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_id.c_str())); + payload.WithString("id", m_id); } if (m_groupHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("group")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_group.c_str())); + payload.WithString("group", m_group); } if (m_amountHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("amount")); - encoder.WriteFloat(m_amount); + payload.WithDouble("amount", m_amount); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateWorkloadEstimateUsageError.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateWorkloadEstimateUsageError.cpp index 046c60e4c98a..f7183acf68c1 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateWorkloadEstimateUsageError.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateWorkloadEstimateUsageError.cpp @@ -4,241 +4,55 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -BatchUpdateWorkloadEstimateUsageError::BatchUpdateWorkloadEstimateUsageError(const std::shared_ptr& decoder) { - *this = decoder; -} - -BatchUpdateWorkloadEstimateUsageError& BatchUpdateWorkloadEstimateUsageError::operator=( - const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "errorMessage") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_errorMessage = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_errorMessage = ss.str(); - } - } - m_errorMessageHasBeenSet = true; - } - - else if (initialKeyStr == "errorCode") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_errorCode = WorkloadEstimateUpdateUsageErrorCodeMapper::GetWorkloadEstimateUpdateUsageErrorCodeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_errorCodeHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("BatchUpdateWorkloadEstimateUsageError", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } +BatchUpdateWorkloadEstimateUsageError::BatchUpdateWorkloadEstimateUsageError(JsonView jsonValue) { *this = jsonValue; } - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "errorMessage") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_errorMessage = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_errorMessage = ss.str(); - } - } - m_errorMessageHasBeenSet = true; - } - - else if (initialKeyStr == "errorCode") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_errorCode = WorkloadEstimateUpdateUsageErrorCodeMapper::GetWorkloadEstimateUpdateUsageErrorCodeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_errorCodeHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } +BatchUpdateWorkloadEstimateUsageError& BatchUpdateWorkloadEstimateUsageError::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("id")) { + m_id = jsonValue.GetString("id"); + m_idHasBeenSet = true; } - - return *this; -} - -void BatchUpdateWorkloadEstimateUsageError::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_idHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("errorMessage")) { + m_errorMessage = jsonValue.GetString("errorMessage"); + m_errorMessageHasBeenSet = true; } - if (m_errorMessageHasBeenSet) { - mapSize++; - } - if (m_errorCodeHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("errorCode")) { + m_errorCode = + WorkloadEstimateUpdateUsageErrorCodeMapper::GetWorkloadEstimateUpdateUsageErrorCodeForName(jsonValue.GetString("errorCode")); + m_errorCodeHasBeenSet = true; } + return *this; +} - encoder.WriteMapStart(mapSize); +JsonValue BatchUpdateWorkloadEstimateUsageError::Jsonize() const { + JsonValue payload; if (m_idHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("id")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_id.c_str())); + payload.WithString("id", m_id); } if (m_errorMessageHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("errorMessage")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_errorMessage.c_str())); + payload.WithString("errorMessage", m_errorMessage); } if (m_errorCodeHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("errorCode")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString( - WorkloadEstimateUpdateUsageErrorCodeMapper::GetNameForWorkloadEstimateUpdateUsageErrorCode(m_errorCode).c_str())); + payload.WithString("errorCode", + WorkloadEstimateUpdateUsageErrorCodeMapper::GetNameForWorkloadEstimateUpdateUsageErrorCode(m_errorCode)); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateWorkloadEstimateUsageRequest.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateWorkloadEstimateUsageRequest.cpp index a87ad00c8219..79efab106381 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateWorkloadEstimateUsageRequest.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateWorkloadEstimateUsageRequest.cpp @@ -4,48 +4,34 @@ */ #include -#include +#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; Aws::String BatchUpdateWorkloadEstimateUsageRequest::SerializePayload() const { - Aws::Crt::Cbor::CborEncoder encoder; + JsonValue payload; - // Calculate map size - size_t mapSize = 0; if (m_workloadEstimateIdHasBeenSet) { - mapSize++; - } - if (m_usageHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); - - if (m_workloadEstimateIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("workloadEstimateId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_workloadEstimateId.c_str())); + payload.WithString("workloadEstimateId", m_workloadEstimateId); } if (m_usageHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("usage")); - encoder.WriteArrayStart(m_usage.size()); - for (const auto& item_0 : m_usage) { - item_0.CborEncode(encoder); + Aws::Utils::Array usageJsonList(m_usage.size()); + for (unsigned usageIndex = 0; usageIndex < usageJsonList.GetLength(); ++usageIndex) { + usageJsonList[usageIndex].AsObject(m_usage[usageIndex].Jsonize()); } + payload.WithArray("usage", std::move(usageJsonList)); } - const auto str = Aws::String(reinterpret_cast(encoder.GetEncodedData().ptr), encoder.GetEncodedData().len); - return str; + + return payload.View().WriteReadable(); } Aws::Http::HeaderValueCollection BatchUpdateWorkloadEstimateUsageRequest::GetRequestSpecificHeaders() const { Aws::Http::HeaderValueCollection headers; - headers.emplace(Aws::Http::CONTENT_TYPE_HEADER, Aws::CBOR_CONTENT_TYPE); - headers.emplace(Aws::Http::SMITHY_PROTOCOL_HEADER, Aws::RPC_V2_CBOR); - headers.emplace(Aws::Http::ACCEPT_HEADER, Aws::CBOR_CONTENT_TYPE); + headers.insert(Aws::Http::HeaderValuePair("X-Amz-Target", "AWSBCMPricingCalculator.BatchUpdateWorkloadEstimateUsage")); return headers; } diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateWorkloadEstimateUsageResult.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateWorkloadEstimateUsageResult.cpp index 20eb66ef9872..17875b777301 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateWorkloadEstimateUsageResult.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BatchUpdateWorkloadEstimateUsageResult.cpp @@ -7,192 +7,37 @@ #include #include #include -#include +#include #include -#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; -using namespace Aws::Utils::Cbor; using namespace Aws; -BatchUpdateWorkloadEstimateUsageResult::BatchUpdateWorkloadEstimateUsageResult( - const Aws::AmazonWebServiceResult& result) { +BatchUpdateWorkloadEstimateUsageResult::BatchUpdateWorkloadEstimateUsageResult(const Aws::AmazonWebServiceResult& result) { *this = result; } BatchUpdateWorkloadEstimateUsageResult& BatchUpdateWorkloadEstimateUsageResult::operator=( - const Aws::AmazonWebServiceResult& result) { + const Aws::AmazonWebServiceResult& result) { m_HttpResponseCode = result.GetResponseCode(); - - const auto& cborValue = result.GetPayload(); - const auto decoder = cborValue.GetDecoder(); - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "items") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_items.push_back(WorkloadEstimateUsageItem(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_items.push_back(WorkloadEstimateUsageItem(decoder)); - } - } - } - m_itemsHasBeenSet = true; - } - - else if (initialKeyStr == "errors") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_errors.push_back(BatchUpdateWorkloadEstimateUsageError(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_errors.push_back(BatchUpdateWorkloadEstimateUsageError(decoder)); - } - } - } - m_errorsHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("BatchUpdateWorkloadEstimateUsageResult", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "items") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_items.push_back(WorkloadEstimateUsageItem(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_items.push_back(WorkloadEstimateUsageItem(decoder)); - } - } - } - m_itemsHasBeenSet = true; - } - - else if (initialKeyStr == "errors") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_errors.push_back(BatchUpdateWorkloadEstimateUsageError(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_errors.push_back(BatchUpdateWorkloadEstimateUsageError(decoder)); - } - } - } - m_errorsHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } + JsonView jsonValue = result.GetPayload().View(); + if (jsonValue.ValueExists("items")) { + Aws::Utils::Array itemsJsonList = jsonValue.GetArray("items"); + for (unsigned itemsIndex = 0; itemsIndex < itemsJsonList.GetLength(); ++itemsIndex) { + m_items.push_back(itemsJsonList[itemsIndex].AsObject()); + } + m_itemsHasBeenSet = true; + } + if (jsonValue.ValueExists("errors")) { + Aws::Utils::Array errorsJsonList = jsonValue.GetArray("errors"); + for (unsigned errorsIndex = 0; errorsIndex < errorsJsonList.GetLength(); ++errorsIndex) { + m_errors.push_back(errorsJsonList[errorsIndex].AsObject()); } + m_errorsHasBeenSet = true; } const auto& headers = result.GetHeaderValueCollection(); diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillEstimateCommitmentSummary.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillEstimateCommitmentSummary.cpp index 286623a0ef72..f09ace20b0f2 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillEstimateCommitmentSummary.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillEstimateCommitmentSummary.cpp @@ -4,548 +4,101 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -BillEstimateCommitmentSummary::BillEstimateCommitmentSummary(const std::shared_ptr& decoder) { - *this = decoder; -} - -BillEstimateCommitmentSummary& BillEstimateCommitmentSummary::operator=(const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "purchaseAgreementType") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_purchaseAgreementType = PurchaseAgreementTypeMapper::GetPurchaseAgreementTypeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_purchaseAgreementTypeHasBeenSet = true; - } - - else if (initialKeyStr == "offeringId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_offeringId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_offeringId = ss.str(); - } - } - m_offeringIdHasBeenSet = true; - } - - else if (initialKeyStr == "usageAccountId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageAccountId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageAccountId = ss.str(); - } - } - m_usageAccountIdHasBeenSet = true; - } - - else if (initialKeyStr == "region") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_region = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_region = ss.str(); - } - } - m_regionHasBeenSet = true; - } - - else if (initialKeyStr == "termLength") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_termLength = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_termLength = ss.str(); - } - } - m_termLengthHasBeenSet = true; - } - - else if (initialKeyStr == "paymentOption") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_paymentOption = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_paymentOption = ss.str(); - } - } - m_paymentOptionHasBeenSet = true; - } - - else if (initialKeyStr == "upfrontPayment") { - m_upfrontPayment = CostAmount(decoder); - m_upfrontPaymentHasBeenSet = true; - } - - else if (initialKeyStr == "monthlyPayment") { - m_monthlyPayment = CostAmount(decoder); - m_monthlyPaymentHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("BillEstimateCommitmentSummary", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "purchaseAgreementType") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_purchaseAgreementType = PurchaseAgreementTypeMapper::GetPurchaseAgreementTypeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_purchaseAgreementTypeHasBeenSet = true; - } - - else if (initialKeyStr == "offeringId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_offeringId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_offeringId = ss.str(); - } - } - m_offeringIdHasBeenSet = true; - } - - else if (initialKeyStr == "usageAccountId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageAccountId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageAccountId = ss.str(); - } - } - m_usageAccountIdHasBeenSet = true; - } - - else if (initialKeyStr == "region") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_region = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_region = ss.str(); - } - } - m_regionHasBeenSet = true; - } - - else if (initialKeyStr == "termLength") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_termLength = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_termLength = ss.str(); - } - } - m_termLengthHasBeenSet = true; - } - - else if (initialKeyStr == "paymentOption") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_paymentOption = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_paymentOption = ss.str(); - } - } - m_paymentOptionHasBeenSet = true; - } +BillEstimateCommitmentSummary::BillEstimateCommitmentSummary(JsonView jsonValue) { *this = jsonValue; } - else if (initialKeyStr == "upfrontPayment") { - m_upfrontPayment = CostAmount(decoder); - m_upfrontPaymentHasBeenSet = true; - } - - else if (initialKeyStr == "monthlyPayment") { - m_monthlyPayment = CostAmount(decoder); - m_monthlyPaymentHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } +BillEstimateCommitmentSummary& BillEstimateCommitmentSummary::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("id")) { + m_id = jsonValue.GetString("id"); + m_idHasBeenSet = true; } - - return *this; -} - -void BillEstimateCommitmentSummary::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_idHasBeenSet) { - mapSize++; - } - if (m_purchaseAgreementTypeHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("purchaseAgreementType")) { + m_purchaseAgreementType = PurchaseAgreementTypeMapper::GetPurchaseAgreementTypeForName(jsonValue.GetString("purchaseAgreementType")); + m_purchaseAgreementTypeHasBeenSet = true; } - if (m_offeringIdHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("offeringId")) { + m_offeringId = jsonValue.GetString("offeringId"); + m_offeringIdHasBeenSet = true; } - if (m_usageAccountIdHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("usageAccountId")) { + m_usageAccountId = jsonValue.GetString("usageAccountId"); + m_usageAccountIdHasBeenSet = true; } - if (m_regionHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("region")) { + m_region = jsonValue.GetString("region"); + m_regionHasBeenSet = true; } - if (m_termLengthHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("termLength")) { + m_termLength = jsonValue.GetString("termLength"); + m_termLengthHasBeenSet = true; } - if (m_paymentOptionHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("paymentOption")) { + m_paymentOption = jsonValue.GetString("paymentOption"); + m_paymentOptionHasBeenSet = true; } - if (m_upfrontPaymentHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("upfrontPayment")) { + m_upfrontPayment = jsonValue.GetObject("upfrontPayment"); + m_upfrontPaymentHasBeenSet = true; } - if (m_monthlyPaymentHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("monthlyPayment")) { + m_monthlyPayment = jsonValue.GetObject("monthlyPayment"); + m_monthlyPaymentHasBeenSet = true; } + return *this; +} - encoder.WriteMapStart(mapSize); +JsonValue BillEstimateCommitmentSummary::Jsonize() const { + JsonValue payload; if (m_idHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("id")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_id.c_str())); + payload.WithString("id", m_id); } if (m_purchaseAgreementTypeHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("purchaseAgreementType")); - encoder.WriteText( - Aws::Crt::ByteCursorFromCString(PurchaseAgreementTypeMapper::GetNameForPurchaseAgreementType(m_purchaseAgreementType).c_str())); + payload.WithString("purchaseAgreementType", PurchaseAgreementTypeMapper::GetNameForPurchaseAgreementType(m_purchaseAgreementType)); } if (m_offeringIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("offeringId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_offeringId.c_str())); + payload.WithString("offeringId", m_offeringId); } if (m_usageAccountIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("usageAccountId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_usageAccountId.c_str())); + payload.WithString("usageAccountId", m_usageAccountId); } if (m_regionHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("region")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_region.c_str())); + payload.WithString("region", m_region); } if (m_termLengthHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("termLength")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_termLength.c_str())); + payload.WithString("termLength", m_termLength); } if (m_paymentOptionHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("paymentOption")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_paymentOption.c_str())); + payload.WithString("paymentOption", m_paymentOption); } if (m_upfrontPaymentHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("upfrontPayment")); - m_upfrontPayment.CborEncode(encoder); + payload.WithObject("upfrontPayment", m_upfrontPayment.Jsonize()); } if (m_monthlyPaymentHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("monthlyPayment")); - m_monthlyPayment.CborEncode(encoder); + payload.WithObject("monthlyPayment", m_monthlyPayment.Jsonize()); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillEstimateCostSummary.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillEstimateCostSummary.cpp index e80edb066846..bfc971ee4881 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillEstimateCostSummary.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillEstimateCostSummary.cpp @@ -4,177 +4,52 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -BillEstimateCostSummary::BillEstimateCostSummary(const std::shared_ptr& decoder) { *this = decoder; } +BillEstimateCostSummary::BillEstimateCostSummary(JsonView jsonValue) { *this = jsonValue; } -BillEstimateCostSummary& BillEstimateCostSummary::operator=(const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "totalCostDifference") { - m_totalCostDifference = CostDifference(decoder); - m_totalCostDifferenceHasBeenSet = true; - } - - else if (initialKeyStr == "serviceCostDifferences") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && (peekType_0.value() == CborType::MapStart || peekType_0.value() == CborType::IndefMapStart)) { - if (peekType_0.value() == CborType::MapStart) { - auto mapSize_0 = decoder->PopNextMapStart(); - if (mapSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < mapSize_0.value(); j_0++) { - auto key_1 = decoder->PopNextTextVal(); - if (key_1.has_value()) { - Aws::String keyStr_1 = Aws::String(reinterpret_cast(key_1.value().ptr), key_1.value().len); - m_serviceCostDifferences[keyStr_1] = CostDifference(decoder); - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto key_1 = decoder->PopNextTextVal(); - if (key_1.has_value()) { - Aws::String keyStr_1 = Aws::String(reinterpret_cast(key_1.value().ptr), key_1.value().len); - m_serviceCostDifferences[keyStr_1] = CostDifference(decoder); - } - } - } - } - m_serviceCostDifferencesHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("BillEstimateCostSummary", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "totalCostDifference") { - m_totalCostDifference = CostDifference(decoder); - m_totalCostDifferenceHasBeenSet = true; - } - - else if (initialKeyStr == "serviceCostDifferences") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && (peekType_0.value() == CborType::MapStart || peekType_0.value() == CborType::IndefMapStart)) { - if (peekType_0.value() == CborType::MapStart) { - auto mapSize_0 = decoder->PopNextMapStart(); - if (mapSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < mapSize_0.value(); j_0++) { - auto key_1 = decoder->PopNextTextVal(); - if (key_1.has_value()) { - Aws::String keyStr_1 = Aws::String(reinterpret_cast(key_1.value().ptr), key_1.value().len); - m_serviceCostDifferences[keyStr_1] = CostDifference(decoder); - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto key_1 = decoder->PopNextTextVal(); - if (key_1.has_value()) { - Aws::String keyStr_1 = Aws::String(reinterpret_cast(key_1.value().ptr), key_1.value().len); - m_serviceCostDifferences[keyStr_1] = CostDifference(decoder); - } - } - } - } - m_serviceCostDifferencesHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } +BillEstimateCostSummary& BillEstimateCostSummary::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("totalCostDifference")) { + m_totalCostDifference = jsonValue.GetObject("totalCostDifference"); + m_totalCostDifferenceHasBeenSet = true; + } + if (jsonValue.ValueExists("serviceCostDifferences")) { + Aws::Map serviceCostDifferencesJsonMap = jsonValue.GetObject("serviceCostDifferences").GetAllObjects(); + for (auto& serviceCostDifferencesItem : serviceCostDifferencesJsonMap) { + m_serviceCostDifferences[serviceCostDifferencesItem.first] = serviceCostDifferencesItem.second.AsObject(); } + m_serviceCostDifferencesHasBeenSet = true; } - return *this; } -void BillEstimateCostSummary::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_totalCostDifferenceHasBeenSet) { - mapSize++; - } - if (m_serviceCostDifferencesHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); +JsonValue BillEstimateCostSummary::Jsonize() const { + JsonValue payload; if (m_totalCostDifferenceHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("totalCostDifference")); - m_totalCostDifference.CborEncode(encoder); + payload.WithObject("totalCostDifference", m_totalCostDifference.Jsonize()); } if (m_serviceCostDifferencesHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("serviceCostDifferences")); - encoder.WriteMapStart(m_serviceCostDifferences.size()); - for (const auto& item_0 : m_serviceCostDifferences) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString(item_0.first.c_str())); - item_0.second.CborEncode(encoder); + JsonValue serviceCostDifferencesJsonMap; + for (auto& serviceCostDifferencesItem : m_serviceCostDifferences) { + serviceCostDifferencesJsonMap.WithObject(serviceCostDifferencesItem.first, serviceCostDifferencesItem.second.Jsonize()); } + payload.WithObject("serviceCostDifferences", std::move(serviceCostDifferencesJsonMap)); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillEstimateInputCommitmentModificationSummary.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillEstimateInputCommitmentModificationSummary.cpp index faeff899fb66..2820baf35ae9 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillEstimateInputCommitmentModificationSummary.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillEstimateInputCommitmentModificationSummary.cpp @@ -4,301 +4,61 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -BillEstimateInputCommitmentModificationSummary::BillEstimateInputCommitmentModificationSummary( - const std::shared_ptr& decoder) { - *this = decoder; -} - -BillEstimateInputCommitmentModificationSummary& BillEstimateInputCommitmentModificationSummary::operator=( - const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "group") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_group = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_group = ss.str(); - } - } - m_groupHasBeenSet = true; - } - - else if (initialKeyStr == "usageAccountId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageAccountId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageAccountId = ss.str(); - } - } - m_usageAccountIdHasBeenSet = true; - } - - else if (initialKeyStr == "commitmentAction") { - m_commitmentAction = BillScenarioCommitmentModificationAction(decoder); - m_commitmentActionHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("BillEstimateInputCommitmentModificationSummary", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "group") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_group = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_group = ss.str(); - } - } - m_groupHasBeenSet = true; - } - - else if (initialKeyStr == "usageAccountId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageAccountId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageAccountId = ss.str(); - } - } - m_usageAccountIdHasBeenSet = true; - } - - else if (initialKeyStr == "commitmentAction") { - m_commitmentAction = BillScenarioCommitmentModificationAction(decoder); - m_commitmentActionHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } - } - - return *this; -} +BillEstimateInputCommitmentModificationSummary::BillEstimateInputCommitmentModificationSummary(JsonView jsonValue) { *this = jsonValue; } -void BillEstimateInputCommitmentModificationSummary::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_idHasBeenSet) { - mapSize++; +BillEstimateInputCommitmentModificationSummary& BillEstimateInputCommitmentModificationSummary::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("id")) { + m_id = jsonValue.GetString("id"); + m_idHasBeenSet = true; } - if (m_groupHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("group")) { + m_group = jsonValue.GetString("group"); + m_groupHasBeenSet = true; } - if (m_usageAccountIdHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("usageAccountId")) { + m_usageAccountId = jsonValue.GetString("usageAccountId"); + m_usageAccountIdHasBeenSet = true; } - if (m_commitmentActionHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("commitmentAction")) { + m_commitmentAction = jsonValue.GetObject("commitmentAction"); + m_commitmentActionHasBeenSet = true; } + return *this; +} - encoder.WriteMapStart(mapSize); +JsonValue BillEstimateInputCommitmentModificationSummary::Jsonize() const { + JsonValue payload; if (m_idHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("id")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_id.c_str())); + payload.WithString("id", m_id); } if (m_groupHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("group")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_group.c_str())); + payload.WithString("group", m_group); } if (m_usageAccountIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("usageAccountId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_usageAccountId.c_str())); + payload.WithString("usageAccountId", m_usageAccountId); } if (m_commitmentActionHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("commitmentAction")); - m_commitmentAction.CborEncode(encoder); + payload.WithObject("commitmentAction", m_commitmentAction.Jsonize()); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillEstimateInputUsageModificationSummary.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillEstimateInputUsageModificationSummary.cpp index 207920cb4508..2a20f2ed402d 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillEstimateInputUsageModificationSummary.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillEstimateInputUsageModificationSummary.cpp @@ -4,710 +4,116 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -BillEstimateInputUsageModificationSummary::BillEstimateInputUsageModificationSummary( - const std::shared_ptr& decoder) { - *this = decoder; -} - -BillEstimateInputUsageModificationSummary& BillEstimateInputUsageModificationSummary::operator=( - const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "serviceCode") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_serviceCode = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_serviceCode = ss.str(); - } - } - m_serviceCodeHasBeenSet = true; - } - - else if (initialKeyStr == "usageType") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageType = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageType = ss.str(); - } - } - m_usageTypeHasBeenSet = true; - } - - else if (initialKeyStr == "operation") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_operation = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_operation = ss.str(); - } - } - m_operationHasBeenSet = true; - } - - else if (initialKeyStr == "location") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_location = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_location = ss.str(); - } - } - m_locationHasBeenSet = true; - } - - else if (initialKeyStr == "availabilityZone") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_availabilityZone = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_availabilityZone = ss.str(); - } - } - m_availabilityZoneHasBeenSet = true; - } - - else if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "group") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_group = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_group = ss.str(); - } - } - m_groupHasBeenSet = true; - } - - else if (initialKeyStr == "usageAccountId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageAccountId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageAccountId = ss.str(); - } - } - m_usageAccountIdHasBeenSet = true; - } - - else if (initialKeyStr == "quantities") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_quantities.push_back(UsageQuantity(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_quantities.push_back(UsageQuantity(decoder)); - } - } - } - m_quantitiesHasBeenSet = true; - } - - else if (initialKeyStr == "historicalUsage") { - m_historicalUsage = HistoricalUsageEntity(decoder); - m_historicalUsageHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("BillEstimateInputUsageModificationSummary", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "serviceCode") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_serviceCode = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_serviceCode = ss.str(); - } - } - m_serviceCodeHasBeenSet = true; - } - - else if (initialKeyStr == "usageType") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageType = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageType = ss.str(); - } - } - m_usageTypeHasBeenSet = true; - } - - else if (initialKeyStr == "operation") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_operation = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_operation = ss.str(); - } - } - m_operationHasBeenSet = true; - } - - else if (initialKeyStr == "location") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_location = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_location = ss.str(); - } - } - m_locationHasBeenSet = true; - } - - else if (initialKeyStr == "availabilityZone") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_availabilityZone = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_availabilityZone = ss.str(); - } - } - m_availabilityZoneHasBeenSet = true; - } - - else if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "group") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_group = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_group = ss.str(); - } - } - m_groupHasBeenSet = true; - } - - else if (initialKeyStr == "usageAccountId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageAccountId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageAccountId = ss.str(); - } - } - m_usageAccountIdHasBeenSet = true; - } +BillEstimateInputUsageModificationSummary::BillEstimateInputUsageModificationSummary(JsonView jsonValue) { *this = jsonValue; } - else if (initialKeyStr == "quantities") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_quantities.push_back(UsageQuantity(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_quantities.push_back(UsageQuantity(decoder)); - } - } - } - m_quantitiesHasBeenSet = true; - } - - else if (initialKeyStr == "historicalUsage") { - m_historicalUsage = HistoricalUsageEntity(decoder); - m_historicalUsageHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } +BillEstimateInputUsageModificationSummary& BillEstimateInputUsageModificationSummary::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("serviceCode")) { + m_serviceCode = jsonValue.GetString("serviceCode"); + m_serviceCodeHasBeenSet = true; } - - return *this; -} - -void BillEstimateInputUsageModificationSummary::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_serviceCodeHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("usageType")) { + m_usageType = jsonValue.GetString("usageType"); + m_usageTypeHasBeenSet = true; } - if (m_usageTypeHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("operation")) { + m_operation = jsonValue.GetString("operation"); + m_operationHasBeenSet = true; } - if (m_operationHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("location")) { + m_location = jsonValue.GetString("location"); + m_locationHasBeenSet = true; } - if (m_locationHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("availabilityZone")) { + m_availabilityZone = jsonValue.GetString("availabilityZone"); + m_availabilityZoneHasBeenSet = true; } - if (m_availabilityZoneHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("id")) { + m_id = jsonValue.GetString("id"); + m_idHasBeenSet = true; } - if (m_idHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("group")) { + m_group = jsonValue.GetString("group"); + m_groupHasBeenSet = true; } - if (m_groupHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("usageAccountId")) { + m_usageAccountId = jsonValue.GetString("usageAccountId"); + m_usageAccountIdHasBeenSet = true; } - if (m_usageAccountIdHasBeenSet) { - mapSize++; - } - if (m_quantitiesHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("quantities")) { + Aws::Utils::Array quantitiesJsonList = jsonValue.GetArray("quantities"); + for (unsigned quantitiesIndex = 0; quantitiesIndex < quantitiesJsonList.GetLength(); ++quantitiesIndex) { + m_quantities.push_back(quantitiesJsonList[quantitiesIndex].AsObject()); + } + m_quantitiesHasBeenSet = true; } - if (m_historicalUsageHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("historicalUsage")) { + m_historicalUsage = jsonValue.GetObject("historicalUsage"); + m_historicalUsageHasBeenSet = true; } + return *this; +} - encoder.WriteMapStart(mapSize); +JsonValue BillEstimateInputUsageModificationSummary::Jsonize() const { + JsonValue payload; if (m_serviceCodeHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("serviceCode")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_serviceCode.c_str())); + payload.WithString("serviceCode", m_serviceCode); } if (m_usageTypeHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("usageType")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_usageType.c_str())); + payload.WithString("usageType", m_usageType); } if (m_operationHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("operation")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_operation.c_str())); + payload.WithString("operation", m_operation); } if (m_locationHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("location")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_location.c_str())); + payload.WithString("location", m_location); } if (m_availabilityZoneHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("availabilityZone")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_availabilityZone.c_str())); + payload.WithString("availabilityZone", m_availabilityZone); } if (m_idHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("id")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_id.c_str())); + payload.WithString("id", m_id); } if (m_groupHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("group")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_group.c_str())); + payload.WithString("group", m_group); } if (m_usageAccountIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("usageAccountId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_usageAccountId.c_str())); + payload.WithString("usageAccountId", m_usageAccountId); } if (m_quantitiesHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("quantities")); - encoder.WriteArrayStart(m_quantities.size()); - for (const auto& item_0 : m_quantities) { - item_0.CborEncode(encoder); + Aws::Utils::Array quantitiesJsonList(m_quantities.size()); + for (unsigned quantitiesIndex = 0; quantitiesIndex < quantitiesJsonList.GetLength(); ++quantitiesIndex) { + quantitiesJsonList[quantitiesIndex].AsObject(m_quantities[quantitiesIndex].Jsonize()); } + payload.WithArray("quantities", std::move(quantitiesJsonList)); } if (m_historicalUsageHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("historicalUsage")); - m_historicalUsage.CborEncode(encoder); + payload.WithObject("historicalUsage", m_historicalUsage.Jsonize()); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillEstimateLineItemSummary.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillEstimateLineItemSummary.cpp index fb67df943805..7e8201e8a413 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillEstimateLineItemSummary.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillEstimateLineItemSummary.cpp @@ -4,1000 +4,156 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -BillEstimateLineItemSummary::BillEstimateLineItemSummary(const std::shared_ptr& decoder) { *this = decoder; } +BillEstimateLineItemSummary::BillEstimateLineItemSummary(JsonView jsonValue) { *this = jsonValue; } -BillEstimateLineItemSummary& BillEstimateLineItemSummary::operator=(const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "serviceCode") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_serviceCode = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_serviceCode = ss.str(); - } - } - m_serviceCodeHasBeenSet = true; - } - - else if (initialKeyStr == "usageType") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageType = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageType = ss.str(); - } - } - m_usageTypeHasBeenSet = true; - } - - else if (initialKeyStr == "operation") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_operation = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_operation = ss.str(); - } - } - m_operationHasBeenSet = true; - } - - else if (initialKeyStr == "location") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_location = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_location = ss.str(); - } - } - m_locationHasBeenSet = true; - } - - else if (initialKeyStr == "availabilityZone") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_availabilityZone = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_availabilityZone = ss.str(); - } - } - m_availabilityZoneHasBeenSet = true; - } - - else if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "lineItemId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_lineItemId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_lineItemId = ss.str(); - } - } - m_lineItemIdHasBeenSet = true; - } - - else if (initialKeyStr == "lineItemType") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_lineItemType = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_lineItemType = ss.str(); - } - } - m_lineItemTypeHasBeenSet = true; - } - - else if (initialKeyStr == "payerAccountId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_payerAccountId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_payerAccountId = ss.str(); - } - } - m_payerAccountIdHasBeenSet = true; - } - - else if (initialKeyStr == "usageAccountId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageAccountId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageAccountId = ss.str(); - } - } - m_usageAccountIdHasBeenSet = true; - } - - else if (initialKeyStr == "estimatedUsageQuantity") { - m_estimatedUsageQuantity = UsageQuantityResult(decoder); - m_estimatedUsageQuantityHasBeenSet = true; - } - - else if (initialKeyStr == "estimatedCost") { - m_estimatedCost = CostAmount(decoder); - m_estimatedCostHasBeenSet = true; - } - - else if (initialKeyStr == "historicalUsageQuantity") { - m_historicalUsageQuantity = UsageQuantityResult(decoder); - m_historicalUsageQuantityHasBeenSet = true; - } - - else if (initialKeyStr == "historicalCost") { - m_historicalCost = CostAmount(decoder); - m_historicalCostHasBeenSet = true; - } - - else if (initialKeyStr == "savingsPlanArns") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - auto peekType_1 = decoder->PeekType(); - if (peekType_1.has_value()) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_savingsPlanArns.push_back(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_savingsPlanArns.push_back(ss_1.str()); - ss_1.clear(); - } - } - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto peekType_1 = decoder->PeekType(); - if (peekType_1.has_value()) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_savingsPlanArns.push_back(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_savingsPlanArns.push_back(ss_1.str()); - ss_1.clear(); - } - } - } - } - } - m_savingsPlanArnsHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("BillEstimateLineItemSummary", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "serviceCode") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_serviceCode = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_serviceCode = ss.str(); - } - } - m_serviceCodeHasBeenSet = true; - } - - else if (initialKeyStr == "usageType") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageType = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageType = ss.str(); - } - } - m_usageTypeHasBeenSet = true; - } - - else if (initialKeyStr == "operation") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_operation = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_operation = ss.str(); - } - } - m_operationHasBeenSet = true; - } - - else if (initialKeyStr == "location") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_location = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_location = ss.str(); - } - } - m_locationHasBeenSet = true; - } - - else if (initialKeyStr == "availabilityZone") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_availabilityZone = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_availabilityZone = ss.str(); - } - } - m_availabilityZoneHasBeenSet = true; - } - - else if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "lineItemId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_lineItemId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_lineItemId = ss.str(); - } - } - m_lineItemIdHasBeenSet = true; - } - - else if (initialKeyStr == "lineItemType") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_lineItemType = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_lineItemType = ss.str(); - } - } - m_lineItemTypeHasBeenSet = true; - } - - else if (initialKeyStr == "payerAccountId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_payerAccountId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_payerAccountId = ss.str(); - } - } - m_payerAccountIdHasBeenSet = true; - } - - else if (initialKeyStr == "usageAccountId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageAccountId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageAccountId = ss.str(); - } - } - m_usageAccountIdHasBeenSet = true; - } - - else if (initialKeyStr == "estimatedUsageQuantity") { - m_estimatedUsageQuantity = UsageQuantityResult(decoder); - m_estimatedUsageQuantityHasBeenSet = true; - } - - else if (initialKeyStr == "estimatedCost") { - m_estimatedCost = CostAmount(decoder); - m_estimatedCostHasBeenSet = true; - } - - else if (initialKeyStr == "historicalUsageQuantity") { - m_historicalUsageQuantity = UsageQuantityResult(decoder); - m_historicalUsageQuantityHasBeenSet = true; - } - - else if (initialKeyStr == "historicalCost") { - m_historicalCost = CostAmount(decoder); - m_historicalCostHasBeenSet = true; - } - - else if (initialKeyStr == "savingsPlanArns") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - auto peekType_1 = decoder->PeekType(); - if (peekType_1.has_value()) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_savingsPlanArns.push_back(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_savingsPlanArns.push_back(ss_1.str()); - ss_1.clear(); - } - } - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto peekType_1 = decoder->PeekType(); - if (peekType_1.has_value()) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_savingsPlanArns.push_back(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_savingsPlanArns.push_back(ss_1.str()); - ss_1.clear(); - } - } - } - } - } - m_savingsPlanArnsHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } - } - - return *this; -} - -void BillEstimateLineItemSummary::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_serviceCodeHasBeenSet) { - mapSize++; +BillEstimateLineItemSummary& BillEstimateLineItemSummary::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("serviceCode")) { + m_serviceCode = jsonValue.GetString("serviceCode"); + m_serviceCodeHasBeenSet = true; } - if (m_usageTypeHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("usageType")) { + m_usageType = jsonValue.GetString("usageType"); + m_usageTypeHasBeenSet = true; } - if (m_operationHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("operation")) { + m_operation = jsonValue.GetString("operation"); + m_operationHasBeenSet = true; } - if (m_locationHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("location")) { + m_location = jsonValue.GetString("location"); + m_locationHasBeenSet = true; } - if (m_availabilityZoneHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("availabilityZone")) { + m_availabilityZone = jsonValue.GetString("availabilityZone"); + m_availabilityZoneHasBeenSet = true; } - if (m_idHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("id")) { + m_id = jsonValue.GetString("id"); + m_idHasBeenSet = true; } - if (m_lineItemIdHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("lineItemId")) { + m_lineItemId = jsonValue.GetString("lineItemId"); + m_lineItemIdHasBeenSet = true; } - if (m_lineItemTypeHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("lineItemType")) { + m_lineItemType = jsonValue.GetString("lineItemType"); + m_lineItemTypeHasBeenSet = true; } - if (m_payerAccountIdHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("payerAccountId")) { + m_payerAccountId = jsonValue.GetString("payerAccountId"); + m_payerAccountIdHasBeenSet = true; } - if (m_usageAccountIdHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("usageAccountId")) { + m_usageAccountId = jsonValue.GetString("usageAccountId"); + m_usageAccountIdHasBeenSet = true; } - if (m_estimatedUsageQuantityHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("estimatedUsageQuantity")) { + m_estimatedUsageQuantity = jsonValue.GetObject("estimatedUsageQuantity"); + m_estimatedUsageQuantityHasBeenSet = true; } - if (m_estimatedCostHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("estimatedCost")) { + m_estimatedCost = jsonValue.GetObject("estimatedCost"); + m_estimatedCostHasBeenSet = true; } - if (m_historicalUsageQuantityHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("historicalUsageQuantity")) { + m_historicalUsageQuantity = jsonValue.GetObject("historicalUsageQuantity"); + m_historicalUsageQuantityHasBeenSet = true; } - if (m_historicalCostHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("historicalCost")) { + m_historicalCost = jsonValue.GetObject("historicalCost"); + m_historicalCostHasBeenSet = true; } - if (m_savingsPlanArnsHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("savingsPlanArns")) { + Aws::Utils::Array savingsPlanArnsJsonList = jsonValue.GetArray("savingsPlanArns"); + for (unsigned savingsPlanArnsIndex = 0; savingsPlanArnsIndex < savingsPlanArnsJsonList.GetLength(); ++savingsPlanArnsIndex) { + m_savingsPlanArns.push_back(savingsPlanArnsJsonList[savingsPlanArnsIndex].AsString()); + } + m_savingsPlanArnsHasBeenSet = true; } + return *this; +} - encoder.WriteMapStart(mapSize); +JsonValue BillEstimateLineItemSummary::Jsonize() const { + JsonValue payload; if (m_serviceCodeHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("serviceCode")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_serviceCode.c_str())); + payload.WithString("serviceCode", m_serviceCode); } if (m_usageTypeHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("usageType")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_usageType.c_str())); + payload.WithString("usageType", m_usageType); } if (m_operationHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("operation")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_operation.c_str())); + payload.WithString("operation", m_operation); } if (m_locationHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("location")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_location.c_str())); + payload.WithString("location", m_location); } if (m_availabilityZoneHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("availabilityZone")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_availabilityZone.c_str())); + payload.WithString("availabilityZone", m_availabilityZone); } if (m_idHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("id")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_id.c_str())); + payload.WithString("id", m_id); } if (m_lineItemIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("lineItemId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_lineItemId.c_str())); + payload.WithString("lineItemId", m_lineItemId); } if (m_lineItemTypeHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("lineItemType")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_lineItemType.c_str())); + payload.WithString("lineItemType", m_lineItemType); } if (m_payerAccountIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("payerAccountId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_payerAccountId.c_str())); + payload.WithString("payerAccountId", m_payerAccountId); } if (m_usageAccountIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("usageAccountId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_usageAccountId.c_str())); + payload.WithString("usageAccountId", m_usageAccountId); } if (m_estimatedUsageQuantityHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("estimatedUsageQuantity")); - m_estimatedUsageQuantity.CborEncode(encoder); + payload.WithObject("estimatedUsageQuantity", m_estimatedUsageQuantity.Jsonize()); } if (m_estimatedCostHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("estimatedCost")); - m_estimatedCost.CborEncode(encoder); + payload.WithObject("estimatedCost", m_estimatedCost.Jsonize()); } if (m_historicalUsageQuantityHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("historicalUsageQuantity")); - m_historicalUsageQuantity.CborEncode(encoder); + payload.WithObject("historicalUsageQuantity", m_historicalUsageQuantity.Jsonize()); } if (m_historicalCostHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("historicalCost")); - m_historicalCost.CborEncode(encoder); + payload.WithObject("historicalCost", m_historicalCost.Jsonize()); } if (m_savingsPlanArnsHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("savingsPlanArns")); - encoder.WriteArrayStart(m_savingsPlanArns.size()); - for (const auto& item_0 : m_savingsPlanArns) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString(item_0.c_str())); + Aws::Utils::Array savingsPlanArnsJsonList(m_savingsPlanArns.size()); + for (unsigned savingsPlanArnsIndex = 0; savingsPlanArnsIndex < savingsPlanArnsJsonList.GetLength(); ++savingsPlanArnsIndex) { + savingsPlanArnsJsonList[savingsPlanArnsIndex].AsString(m_savingsPlanArns[savingsPlanArnsIndex]); } + payload.WithArray("savingsPlanArns", std::move(savingsPlanArnsJsonList)); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillEstimateSummary.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillEstimateSummary.cpp index 5805d397b64d..ad5944540dc5 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillEstimateSummary.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillEstimateSummary.cpp @@ -4,365 +4,77 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -BillEstimateSummary::BillEstimateSummary(const std::shared_ptr& decoder) { *this = decoder; } +BillEstimateSummary::BillEstimateSummary(JsonView jsonValue) { *this = jsonValue; } -BillEstimateSummary& BillEstimateSummary::operator=(const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "name") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_name = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_name = ss.str(); - } - } - m_nameHasBeenSet = true; - } - - else if (initialKeyStr == "status") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_status = BillEstimateStatusMapper::GetBillEstimateStatusForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_statusHasBeenSet = true; - } - - else if (initialKeyStr == "billInterval") { - m_billInterval = BillInterval(decoder); - m_billIntervalHasBeenSet = true; - } - - else if (initialKeyStr == "createdAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_createdAtHasBeenSet = true; - } - - else if (initialKeyStr == "expiresAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_expiresAtHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("BillEstimateSummary", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "name") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_name = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_name = ss.str(); - } - } - m_nameHasBeenSet = true; - } - - else if (initialKeyStr == "status") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_status = BillEstimateStatusMapper::GetBillEstimateStatusForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_statusHasBeenSet = true; - } - - else if (initialKeyStr == "billInterval") { - m_billInterval = BillInterval(decoder); - m_billIntervalHasBeenSet = true; - } - - else if (initialKeyStr == "createdAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_createdAtHasBeenSet = true; - } - - else if (initialKeyStr == "expiresAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_expiresAtHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } +BillEstimateSummary& BillEstimateSummary::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("id")) { + m_id = jsonValue.GetString("id"); + m_idHasBeenSet = true; } - - return *this; -} - -void BillEstimateSummary::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_idHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("name")) { + m_name = jsonValue.GetString("name"); + m_nameHasBeenSet = true; } - if (m_nameHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("status")) { + m_status = BillEstimateStatusMapper::GetBillEstimateStatusForName(jsonValue.GetString("status")); + m_statusHasBeenSet = true; } - if (m_statusHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("billInterval")) { + m_billInterval = jsonValue.GetObject("billInterval"); + m_billIntervalHasBeenSet = true; } - if (m_billIntervalHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("createdAt")) { + m_createdAt = jsonValue.GetDouble("createdAt"); + m_createdAtHasBeenSet = true; } - if (m_createdAtHasBeenSet) { - mapSize++; - } - if (m_expiresAtHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("expiresAt")) { + m_expiresAt = jsonValue.GetDouble("expiresAt"); + m_expiresAtHasBeenSet = true; } + return *this; +} - encoder.WriteMapStart(mapSize); +JsonValue BillEstimateSummary::Jsonize() const { + JsonValue payload; if (m_idHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("id")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_id.c_str())); + payload.WithString("id", m_id); } if (m_nameHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("name")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_name.c_str())); + payload.WithString("name", m_name); } if (m_statusHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("status")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(BillEstimateStatusMapper::GetNameForBillEstimateStatus(m_status).c_str())); + payload.WithString("status", BillEstimateStatusMapper::GetNameForBillEstimateStatus(m_status)); } if (m_billIntervalHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("billInterval")); - m_billInterval.CborEncode(encoder); + payload.WithObject("billInterval", m_billInterval.Jsonize()); } if (m_createdAtHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("createdAt")); - encoder.WriteTag(1); // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - encoder.WriteUInt(m_createdAt.Seconds()); + payload.WithDouble("createdAt", m_createdAt.SecondsWithMSPrecision()); } if (m_expiresAtHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("expiresAt")); - encoder.WriteTag(1); // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - encoder.WriteUInt(m_expiresAt.Seconds()); + payload.WithDouble("expiresAt", m_expiresAt.SecondsWithMSPrecision()); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillInterval.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillInterval.cpp index c1f6c12b0f24..3931fd234893 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillInterval.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillInterval.cpp @@ -4,185 +4,45 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -BillInterval::BillInterval(const std::shared_ptr& decoder) { *this = decoder; } +BillInterval::BillInterval(JsonView jsonValue) { *this = jsonValue; } -BillInterval& BillInterval::operator=(const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "start") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_start = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_start = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_startHasBeenSet = true; - } - - else if (initialKeyStr == "end") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_end = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_end = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_endHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("BillInterval", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "start") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_start = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_start = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_startHasBeenSet = true; - } - - else if (initialKeyStr == "end") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_end = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_end = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_endHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } +BillInterval& BillInterval::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("start")) { + m_start = jsonValue.GetDouble("start"); + m_startHasBeenSet = true; + } + if (jsonValue.ValueExists("end")) { + m_end = jsonValue.GetDouble("end"); + m_endHasBeenSet = true; } - return *this; } -void BillInterval::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_startHasBeenSet) { - mapSize++; - } - if (m_endHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); +JsonValue BillInterval::Jsonize() const { + JsonValue payload; if (m_startHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("start")); - encoder.WriteTag(1); // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - encoder.WriteUInt(m_start.Seconds()); + payload.WithDouble("start", m_start.SecondsWithMSPrecision()); } if (m_endHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("end")); - encoder.WriteTag(1); // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - encoder.WriteUInt(m_end.Seconds()); + payload.WithDouble("end", m_end.SecondsWithMSPrecision()); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillScenarioCommitmentModificationAction.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillScenarioCommitmentModificationAction.cpp index 729e3fab51e0..8d1552a5b36e 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillScenarioCommitmentModificationAction.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillScenarioCommitmentModificationAction.cpp @@ -4,151 +4,61 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -BillScenarioCommitmentModificationAction::BillScenarioCommitmentModificationAction( - const std::shared_ptr& decoder) { - *this = decoder; -} - -BillScenarioCommitmentModificationAction& BillScenarioCommitmentModificationAction::operator=( - const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "addReservedInstanceAction") { - m_addReservedInstanceAction = AddReservedInstanceAction(decoder); - m_addReservedInstanceActionHasBeenSet = true; - } - - else if (initialKeyStr == "addSavingsPlanAction") { - m_addSavingsPlanAction = AddSavingsPlanAction(decoder); - m_addSavingsPlanActionHasBeenSet = true; - } - - else if (initialKeyStr == "negateReservedInstanceAction") { - m_negateReservedInstanceAction = NegateReservedInstanceAction(decoder); - m_negateReservedInstanceActionHasBeenSet = true; - } - - else if (initialKeyStr == "negateSavingsPlanAction") { - m_negateSavingsPlanAction = NegateSavingsPlanAction(decoder); - m_negateSavingsPlanActionHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("BillScenarioCommitmentModificationAction", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "addReservedInstanceAction") { - m_addReservedInstanceAction = AddReservedInstanceAction(decoder); - m_addReservedInstanceActionHasBeenSet = true; - } - - else if (initialKeyStr == "addSavingsPlanAction") { - m_addSavingsPlanAction = AddSavingsPlanAction(decoder); - m_addSavingsPlanActionHasBeenSet = true; - } - - else if (initialKeyStr == "negateReservedInstanceAction") { - m_negateReservedInstanceAction = NegateReservedInstanceAction(decoder); - m_negateReservedInstanceActionHasBeenSet = true; - } - - else if (initialKeyStr == "negateSavingsPlanAction") { - m_negateSavingsPlanAction = NegateSavingsPlanAction(decoder); - m_negateSavingsPlanActionHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } - } - - return *this; -} +BillScenarioCommitmentModificationAction::BillScenarioCommitmentModificationAction(JsonView jsonValue) { *this = jsonValue; } -void BillScenarioCommitmentModificationAction::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_addReservedInstanceActionHasBeenSet) { - mapSize++; +BillScenarioCommitmentModificationAction& BillScenarioCommitmentModificationAction::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("addReservedInstanceAction")) { + m_addReservedInstanceAction = jsonValue.GetObject("addReservedInstanceAction"); + m_addReservedInstanceActionHasBeenSet = true; } - if (m_addSavingsPlanActionHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("addSavingsPlanAction")) { + m_addSavingsPlanAction = jsonValue.GetObject("addSavingsPlanAction"); + m_addSavingsPlanActionHasBeenSet = true; } - if (m_negateReservedInstanceActionHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("negateReservedInstanceAction")) { + m_negateReservedInstanceAction = jsonValue.GetObject("negateReservedInstanceAction"); + m_negateReservedInstanceActionHasBeenSet = true; } - if (m_negateSavingsPlanActionHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("negateSavingsPlanAction")) { + m_negateSavingsPlanAction = jsonValue.GetObject("negateSavingsPlanAction"); + m_negateSavingsPlanActionHasBeenSet = true; } + return *this; +} - encoder.WriteMapStart(mapSize); +JsonValue BillScenarioCommitmentModificationAction::Jsonize() const { + JsonValue payload; if (m_addReservedInstanceActionHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("addReservedInstanceAction")); - m_addReservedInstanceAction.CborEncode(encoder); + payload.WithObject("addReservedInstanceAction", m_addReservedInstanceAction.Jsonize()); } if (m_addSavingsPlanActionHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("addSavingsPlanAction")); - m_addSavingsPlanAction.CborEncode(encoder); + payload.WithObject("addSavingsPlanAction", m_addSavingsPlanAction.Jsonize()); } if (m_negateReservedInstanceActionHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("negateReservedInstanceAction")); - m_negateReservedInstanceAction.CborEncode(encoder); + payload.WithObject("negateReservedInstanceAction", m_negateReservedInstanceAction.Jsonize()); } if (m_negateSavingsPlanActionHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("negateSavingsPlanAction")); - m_negateSavingsPlanAction.CborEncode(encoder); + payload.WithObject("negateSavingsPlanAction", m_negateSavingsPlanAction.Jsonize()); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillScenarioCommitmentModificationItem.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillScenarioCommitmentModificationItem.cpp index 6f6bab4aeb9d..7c11f9a94034 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillScenarioCommitmentModificationItem.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillScenarioCommitmentModificationItem.cpp @@ -4,301 +4,61 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -BillScenarioCommitmentModificationItem::BillScenarioCommitmentModificationItem( - const std::shared_ptr& decoder) { - *this = decoder; -} - -BillScenarioCommitmentModificationItem& BillScenarioCommitmentModificationItem::operator=( - const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "usageAccountId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageAccountId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageAccountId = ss.str(); - } - } - m_usageAccountIdHasBeenSet = true; - } - - else if (initialKeyStr == "group") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_group = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_group = ss.str(); - } - } - m_groupHasBeenSet = true; - } - - else if (initialKeyStr == "commitmentAction") { - m_commitmentAction = BillScenarioCommitmentModificationAction(decoder); - m_commitmentActionHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("BillScenarioCommitmentModificationItem", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "usageAccountId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageAccountId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageAccountId = ss.str(); - } - } - m_usageAccountIdHasBeenSet = true; - } - - else if (initialKeyStr == "group") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_group = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_group = ss.str(); - } - } - m_groupHasBeenSet = true; - } - - else if (initialKeyStr == "commitmentAction") { - m_commitmentAction = BillScenarioCommitmentModificationAction(decoder); - m_commitmentActionHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } - } - - return *this; -} +BillScenarioCommitmentModificationItem::BillScenarioCommitmentModificationItem(JsonView jsonValue) { *this = jsonValue; } -void BillScenarioCommitmentModificationItem::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_idHasBeenSet) { - mapSize++; +BillScenarioCommitmentModificationItem& BillScenarioCommitmentModificationItem::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("id")) { + m_id = jsonValue.GetString("id"); + m_idHasBeenSet = true; } - if (m_usageAccountIdHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("usageAccountId")) { + m_usageAccountId = jsonValue.GetString("usageAccountId"); + m_usageAccountIdHasBeenSet = true; } - if (m_groupHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("group")) { + m_group = jsonValue.GetString("group"); + m_groupHasBeenSet = true; } - if (m_commitmentActionHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("commitmentAction")) { + m_commitmentAction = jsonValue.GetObject("commitmentAction"); + m_commitmentActionHasBeenSet = true; } + return *this; +} - encoder.WriteMapStart(mapSize); +JsonValue BillScenarioCommitmentModificationItem::Jsonize() const { + JsonValue payload; if (m_idHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("id")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_id.c_str())); + payload.WithString("id", m_id); } if (m_usageAccountIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("usageAccountId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_usageAccountId.c_str())); + payload.WithString("usageAccountId", m_usageAccountId); } if (m_groupHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("group")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_group.c_str())); + payload.WithString("group", m_group); } if (m_commitmentActionHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("commitmentAction")); - m_commitmentAction.CborEncode(encoder); + payload.WithObject("commitmentAction", m_commitmentAction.Jsonize()); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillScenarioSummary.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillScenarioSummary.cpp index 18c19adc7eaf..8b67d8d53419 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillScenarioSummary.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillScenarioSummary.cpp @@ -4,529 +4,103 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -BillScenarioSummary::BillScenarioSummary(const std::shared_ptr& decoder) { *this = decoder; } +BillScenarioSummary::BillScenarioSummary(JsonView jsonValue) { *this = jsonValue; } -BillScenarioSummary& BillScenarioSummary::operator=(const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "name") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_name = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_name = ss.str(); - } - } - m_nameHasBeenSet = true; - } - - else if (initialKeyStr == "billInterval") { - m_billInterval = BillInterval(decoder); - m_billIntervalHasBeenSet = true; - } - - else if (initialKeyStr == "status") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_status = BillScenarioStatusMapper::GetBillScenarioStatusForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_statusHasBeenSet = true; - } - - else if (initialKeyStr == "createdAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_createdAtHasBeenSet = true; - } - - else if (initialKeyStr == "expiresAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_expiresAtHasBeenSet = true; - } - - else if (initialKeyStr == "failureMessage") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_failureMessage = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_failureMessage = ss.str(); - } - } - m_failureMessageHasBeenSet = true; - } - - else if (initialKeyStr == "groupSharingPreference") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_groupSharingPreference = GroupSharingPreferenceEnumMapper::GetGroupSharingPreferenceEnumForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_groupSharingPreferenceHasBeenSet = true; - } - - else if (initialKeyStr == "costCategoryGroupSharingPreferenceArn") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_costCategoryGroupSharingPreferenceArn = - Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_costCategoryGroupSharingPreferenceArn = ss.str(); - } - } - m_costCategoryGroupSharingPreferenceArnHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("BillScenarioSummary", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "name") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_name = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_name = ss.str(); - } - } - m_nameHasBeenSet = true; - } - - else if (initialKeyStr == "billInterval") { - m_billInterval = BillInterval(decoder); - m_billIntervalHasBeenSet = true; - } - - else if (initialKeyStr == "status") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_status = BillScenarioStatusMapper::GetBillScenarioStatusForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_statusHasBeenSet = true; - } - - else if (initialKeyStr == "createdAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_createdAtHasBeenSet = true; - } - - else if (initialKeyStr == "expiresAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_expiresAtHasBeenSet = true; - } - - else if (initialKeyStr == "failureMessage") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_failureMessage = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_failureMessage = ss.str(); - } - } - m_failureMessageHasBeenSet = true; - } - - else if (initialKeyStr == "groupSharingPreference") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_groupSharingPreference = GroupSharingPreferenceEnumMapper::GetGroupSharingPreferenceEnumForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_groupSharingPreferenceHasBeenSet = true; - } - - else if (initialKeyStr == "costCategoryGroupSharingPreferenceArn") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_costCategoryGroupSharingPreferenceArn = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_costCategoryGroupSharingPreferenceArn = ss.str(); - } - } - m_costCategoryGroupSharingPreferenceArnHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } +BillScenarioSummary& BillScenarioSummary::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("id")) { + m_id = jsonValue.GetString("id"); + m_idHasBeenSet = true; } - - return *this; -} - -void BillScenarioSummary::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_idHasBeenSet) { - mapSize++; - } - if (m_nameHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("name")) { + m_name = jsonValue.GetString("name"); + m_nameHasBeenSet = true; } - if (m_billIntervalHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("billInterval")) { + m_billInterval = jsonValue.GetObject("billInterval"); + m_billIntervalHasBeenSet = true; } - if (m_statusHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("status")) { + m_status = BillScenarioStatusMapper::GetBillScenarioStatusForName(jsonValue.GetString("status")); + m_statusHasBeenSet = true; } - if (m_createdAtHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("createdAt")) { + m_createdAt = jsonValue.GetDouble("createdAt"); + m_createdAtHasBeenSet = true; } - if (m_expiresAtHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("expiresAt")) { + m_expiresAt = jsonValue.GetDouble("expiresAt"); + m_expiresAtHasBeenSet = true; } - if (m_failureMessageHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("failureMessage")) { + m_failureMessage = jsonValue.GetString("failureMessage"); + m_failureMessageHasBeenSet = true; } - if (m_groupSharingPreferenceHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("groupSharingPreference")) { + m_groupSharingPreference = + GroupSharingPreferenceEnumMapper::GetGroupSharingPreferenceEnumForName(jsonValue.GetString("groupSharingPreference")); + m_groupSharingPreferenceHasBeenSet = true; } - if (m_costCategoryGroupSharingPreferenceArnHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("costCategoryGroupSharingPreferenceArn")) { + m_costCategoryGroupSharingPreferenceArn = jsonValue.GetString("costCategoryGroupSharingPreferenceArn"); + m_costCategoryGroupSharingPreferenceArnHasBeenSet = true; } + return *this; +} - encoder.WriteMapStart(mapSize); +JsonValue BillScenarioSummary::Jsonize() const { + JsonValue payload; if (m_idHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("id")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_id.c_str())); + payload.WithString("id", m_id); } if (m_nameHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("name")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_name.c_str())); + payload.WithString("name", m_name); } if (m_billIntervalHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("billInterval")); - m_billInterval.CborEncode(encoder); + payload.WithObject("billInterval", m_billInterval.Jsonize()); } if (m_statusHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("status")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(BillScenarioStatusMapper::GetNameForBillScenarioStatus(m_status).c_str())); + payload.WithString("status", BillScenarioStatusMapper::GetNameForBillScenarioStatus(m_status)); } if (m_createdAtHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("createdAt")); - encoder.WriteTag(1); // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - encoder.WriteUInt(m_createdAt.Seconds()); + payload.WithDouble("createdAt", m_createdAt.SecondsWithMSPrecision()); } if (m_expiresAtHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("expiresAt")); - encoder.WriteTag(1); // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - encoder.WriteUInt(m_expiresAt.Seconds()); + payload.WithDouble("expiresAt", m_expiresAt.SecondsWithMSPrecision()); } if (m_failureMessageHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("failureMessage")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_failureMessage.c_str())); + payload.WithString("failureMessage", m_failureMessage); } if (m_groupSharingPreferenceHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("groupSharingPreference")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString( - GroupSharingPreferenceEnumMapper::GetNameForGroupSharingPreferenceEnum(m_groupSharingPreference).c_str())); + payload.WithString("groupSharingPreference", + GroupSharingPreferenceEnumMapper::GetNameForGroupSharingPreferenceEnum(m_groupSharingPreference)); } if (m_costCategoryGroupSharingPreferenceArnHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("costCategoryGroupSharingPreferenceArn")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_costCategoryGroupSharingPreferenceArn.c_str())); + payload.WithString("costCategoryGroupSharingPreferenceArn", m_costCategoryGroupSharingPreferenceArn); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillScenarioUsageModificationItem.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillScenarioUsageModificationItem.cpp index 9cea8e4d7fc6..419fc0a6831b 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillScenarioUsageModificationItem.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/BillScenarioUsageModificationItem.cpp @@ -4,709 +4,116 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -BillScenarioUsageModificationItem::BillScenarioUsageModificationItem(const std::shared_ptr& decoder) { - *this = decoder; -} - -BillScenarioUsageModificationItem& BillScenarioUsageModificationItem::operator=( - const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "serviceCode") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_serviceCode = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_serviceCode = ss.str(); - } - } - m_serviceCodeHasBeenSet = true; - } - - else if (initialKeyStr == "usageType") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageType = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageType = ss.str(); - } - } - m_usageTypeHasBeenSet = true; - } - - else if (initialKeyStr == "operation") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_operation = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_operation = ss.str(); - } - } - m_operationHasBeenSet = true; - } - - else if (initialKeyStr == "location") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_location = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_location = ss.str(); - } - } - m_locationHasBeenSet = true; - } - - else if (initialKeyStr == "availabilityZone") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_availabilityZone = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_availabilityZone = ss.str(); - } - } - m_availabilityZoneHasBeenSet = true; - } - - else if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "group") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_group = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_group = ss.str(); - } - } - m_groupHasBeenSet = true; - } - - else if (initialKeyStr == "usageAccountId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageAccountId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageAccountId = ss.str(); - } - } - m_usageAccountIdHasBeenSet = true; - } - - else if (initialKeyStr == "quantities") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_quantities.push_back(UsageQuantity(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_quantities.push_back(UsageQuantity(decoder)); - } - } - } - m_quantitiesHasBeenSet = true; - } - - else if (initialKeyStr == "historicalUsage") { - m_historicalUsage = HistoricalUsageEntity(decoder); - m_historicalUsageHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("BillScenarioUsageModificationItem", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "serviceCode") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_serviceCode = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_serviceCode = ss.str(); - } - } - m_serviceCodeHasBeenSet = true; - } - - else if (initialKeyStr == "usageType") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageType = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageType = ss.str(); - } - } - m_usageTypeHasBeenSet = true; - } - - else if (initialKeyStr == "operation") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_operation = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_operation = ss.str(); - } - } - m_operationHasBeenSet = true; - } - - else if (initialKeyStr == "location") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_location = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_location = ss.str(); - } - } - m_locationHasBeenSet = true; - } - - else if (initialKeyStr == "availabilityZone") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_availabilityZone = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_availabilityZone = ss.str(); - } - } - m_availabilityZoneHasBeenSet = true; - } - - else if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "group") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_group = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_group = ss.str(); - } - } - m_groupHasBeenSet = true; - } - - else if (initialKeyStr == "usageAccountId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageAccountId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageAccountId = ss.str(); - } - } - m_usageAccountIdHasBeenSet = true; - } +BillScenarioUsageModificationItem::BillScenarioUsageModificationItem(JsonView jsonValue) { *this = jsonValue; } - else if (initialKeyStr == "quantities") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_quantities.push_back(UsageQuantity(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_quantities.push_back(UsageQuantity(decoder)); - } - } - } - m_quantitiesHasBeenSet = true; - } - - else if (initialKeyStr == "historicalUsage") { - m_historicalUsage = HistoricalUsageEntity(decoder); - m_historicalUsageHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } +BillScenarioUsageModificationItem& BillScenarioUsageModificationItem::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("serviceCode")) { + m_serviceCode = jsonValue.GetString("serviceCode"); + m_serviceCodeHasBeenSet = true; } - - return *this; -} - -void BillScenarioUsageModificationItem::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_serviceCodeHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("usageType")) { + m_usageType = jsonValue.GetString("usageType"); + m_usageTypeHasBeenSet = true; } - if (m_usageTypeHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("operation")) { + m_operation = jsonValue.GetString("operation"); + m_operationHasBeenSet = true; } - if (m_operationHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("location")) { + m_location = jsonValue.GetString("location"); + m_locationHasBeenSet = true; } - if (m_locationHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("availabilityZone")) { + m_availabilityZone = jsonValue.GetString("availabilityZone"); + m_availabilityZoneHasBeenSet = true; } - if (m_availabilityZoneHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("id")) { + m_id = jsonValue.GetString("id"); + m_idHasBeenSet = true; } - if (m_idHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("group")) { + m_group = jsonValue.GetString("group"); + m_groupHasBeenSet = true; } - if (m_groupHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("usageAccountId")) { + m_usageAccountId = jsonValue.GetString("usageAccountId"); + m_usageAccountIdHasBeenSet = true; } - if (m_usageAccountIdHasBeenSet) { - mapSize++; - } - if (m_quantitiesHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("quantities")) { + Aws::Utils::Array quantitiesJsonList = jsonValue.GetArray("quantities"); + for (unsigned quantitiesIndex = 0; quantitiesIndex < quantitiesJsonList.GetLength(); ++quantitiesIndex) { + m_quantities.push_back(quantitiesJsonList[quantitiesIndex].AsObject()); + } + m_quantitiesHasBeenSet = true; } - if (m_historicalUsageHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("historicalUsage")) { + m_historicalUsage = jsonValue.GetObject("historicalUsage"); + m_historicalUsageHasBeenSet = true; } + return *this; +} - encoder.WriteMapStart(mapSize); +JsonValue BillScenarioUsageModificationItem::Jsonize() const { + JsonValue payload; if (m_serviceCodeHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("serviceCode")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_serviceCode.c_str())); + payload.WithString("serviceCode", m_serviceCode); } if (m_usageTypeHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("usageType")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_usageType.c_str())); + payload.WithString("usageType", m_usageType); } if (m_operationHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("operation")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_operation.c_str())); + payload.WithString("operation", m_operation); } if (m_locationHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("location")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_location.c_str())); + payload.WithString("location", m_location); } if (m_availabilityZoneHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("availabilityZone")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_availabilityZone.c_str())); + payload.WithString("availabilityZone", m_availabilityZone); } if (m_idHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("id")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_id.c_str())); + payload.WithString("id", m_id); } if (m_groupHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("group")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_group.c_str())); + payload.WithString("group", m_group); } if (m_usageAccountIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("usageAccountId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_usageAccountId.c_str())); + payload.WithString("usageAccountId", m_usageAccountId); } if (m_quantitiesHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("quantities")); - encoder.WriteArrayStart(m_quantities.size()); - for (const auto& item_0 : m_quantities) { - item_0.CborEncode(encoder); + Aws::Utils::Array quantitiesJsonList(m_quantities.size()); + for (unsigned quantitiesIndex = 0; quantitiesIndex < quantitiesJsonList.GetLength(); ++quantitiesIndex) { + quantitiesJsonList[quantitiesIndex].AsObject(m_quantities[quantitiesIndex].Jsonize()); } + payload.WithArray("quantities", std::move(quantitiesJsonList)); } if (m_historicalUsageHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("historicalUsage")); - m_historicalUsage.CborEncode(encoder); + payload.WithObject("historicalUsage", m_historicalUsage.Jsonize()); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ConflictException.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ConflictException.cpp index 3cf9cbd959b6..b4e613f4620c 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ConflictException.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ConflictException.cpp @@ -4,279 +4,53 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -ConflictException::ConflictException(const std::shared_ptr& decoder) { *this = decoder; } +ConflictException::ConflictException(JsonView jsonValue) { *this = jsonValue; } -ConflictException& ConflictException::operator=(const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "message") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_message = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_message = ss.str(); - } - } - m_messageHasBeenSet = true; - } - - else if (initialKeyStr == "resourceId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_resourceId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_resourceId = ss.str(); - } - } - m_resourceIdHasBeenSet = true; - } - - else if (initialKeyStr == "resourceType") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_resourceType = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_resourceType = ss.str(); - } - } - m_resourceTypeHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("ConflictException", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "message") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_message = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_message = ss.str(); - } - } - m_messageHasBeenSet = true; - } - - else if (initialKeyStr == "resourceId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_resourceId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_resourceId = ss.str(); - } - } - m_resourceIdHasBeenSet = true; - } - - else if (initialKeyStr == "resourceType") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_resourceType = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_resourceType = ss.str(); - } - } - m_resourceTypeHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } - } - - return *this; -} - -void ConflictException::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_messageHasBeenSet) { - mapSize++; +ConflictException& ConflictException::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("message")) { + m_message = jsonValue.GetString("message"); + m_messageHasBeenSet = true; } - if (m_resourceIdHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("resourceId")) { + m_resourceId = jsonValue.GetString("resourceId"); + m_resourceIdHasBeenSet = true; } - if (m_resourceTypeHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("resourceType")) { + m_resourceType = jsonValue.GetString("resourceType"); + m_resourceTypeHasBeenSet = true; } + return *this; +} - encoder.WriteMapStart(mapSize); +JsonValue ConflictException::Jsonize() const { + JsonValue payload; if (m_messageHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("message")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_message.c_str())); + payload.WithString("message", m_message); } if (m_resourceIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("resourceId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_resourceId.c_str())); + payload.WithString("resourceId", m_resourceId); } if (m_resourceTypeHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("resourceType")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_resourceType.c_str())); + payload.WithString("resourceType", m_resourceType); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/CostAmount.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/CostAmount.cpp index 7b4314a8135d..b3d2de03ba4b 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/CostAmount.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/CostAmount.cpp @@ -4,125 +4,45 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -CostAmount::CostAmount(const std::shared_ptr& decoder) { *this = decoder; } +CostAmount::CostAmount(JsonView jsonValue) { *this = jsonValue; } -CostAmount& CostAmount::operator=(const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "amount") { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_amount = val.value(); - } - m_amountHasBeenSet = true; - } - - else if (initialKeyStr == "currency") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_currency = CurrencyCodeMapper::GetCurrencyCodeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_currencyHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("CostAmount", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "amount") { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_amount = val.value(); - } - m_amountHasBeenSet = true; - } - - else if (initialKeyStr == "currency") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_currency = CurrencyCodeMapper::GetCurrencyCodeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_currencyHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } +CostAmount& CostAmount::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("amount")) { + m_amount = jsonValue.GetDouble("amount"); + m_amountHasBeenSet = true; + } + if (jsonValue.ValueExists("currency")) { + m_currency = CurrencyCodeMapper::GetCurrencyCodeForName(jsonValue.GetString("currency")); + m_currencyHasBeenSet = true; } - return *this; } -void CostAmount::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_amountHasBeenSet) { - mapSize++; - } - if (m_currencyHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); +JsonValue CostAmount::Jsonize() const { + JsonValue payload; if (m_amountHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("amount")); - encoder.WriteFloat(m_amount); + payload.WithDouble("amount", m_amount); } if (m_currencyHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("currency")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(CurrencyCodeMapper::GetNameForCurrencyCode(m_currency).c_str())); + payload.WithString("currency", CurrencyCodeMapper::GetNameForCurrencyCode(m_currency)); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/CostDifference.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/CostDifference.cpp index 4bb63efa6145..37d1b2471ef1 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/CostDifference.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/CostDifference.cpp @@ -4,111 +4,45 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -CostDifference::CostDifference(const std::shared_ptr& decoder) { *this = decoder; } +CostDifference::CostDifference(JsonView jsonValue) { *this = jsonValue; } -CostDifference& CostDifference::operator=(const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "historicalCost") { - m_historicalCost = CostAmount(decoder); - m_historicalCostHasBeenSet = true; - } - - else if (initialKeyStr == "estimatedCost") { - m_estimatedCost = CostAmount(decoder); - m_estimatedCostHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("CostDifference", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "historicalCost") { - m_historicalCost = CostAmount(decoder); - m_historicalCostHasBeenSet = true; - } - - else if (initialKeyStr == "estimatedCost") { - m_estimatedCost = CostAmount(decoder); - m_estimatedCostHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } +CostDifference& CostDifference::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("historicalCost")) { + m_historicalCost = jsonValue.GetObject("historicalCost"); + m_historicalCostHasBeenSet = true; + } + if (jsonValue.ValueExists("estimatedCost")) { + m_estimatedCost = jsonValue.GetObject("estimatedCost"); + m_estimatedCostHasBeenSet = true; } - return *this; } -void CostDifference::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_historicalCostHasBeenSet) { - mapSize++; - } - if (m_estimatedCostHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); +JsonValue CostDifference::Jsonize() const { + JsonValue payload; if (m_historicalCostHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("historicalCost")); - m_historicalCost.CborEncode(encoder); + payload.WithObject("historicalCost", m_historicalCost.Jsonize()); } if (m_estimatedCostHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("estimatedCost")); - m_estimatedCost.CborEncode(encoder); + payload.WithObject("estimatedCost", m_estimatedCost.Jsonize()); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/CreateBillEstimateRequest.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/CreateBillEstimateRequest.cpp index ebf76ebc540f..f453aefe9fa8 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/CreateBillEstimateRequest.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/CreateBillEstimateRequest.cpp @@ -4,65 +4,42 @@ */ #include -#include +#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; Aws::String CreateBillEstimateRequest::SerializePayload() const { - Aws::Crt::Cbor::CborEncoder encoder; + JsonValue payload; - // Calculate map size - size_t mapSize = 0; if (m_billScenarioIdHasBeenSet) { - mapSize++; - } - if (m_nameHasBeenSet) { - mapSize++; - } - if (m_clientTokenHasBeenSet) { - mapSize++; - } - if (m_tagsHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); - - if (m_billScenarioIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("billScenarioId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_billScenarioId.c_str())); + payload.WithString("billScenarioId", m_billScenarioId); } if (m_nameHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("name")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_name.c_str())); + payload.WithString("name", m_name); } if (m_clientTokenHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("clientToken")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_clientToken.c_str())); + payload.WithString("clientToken", m_clientToken); } if (m_tagsHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("tags")); - encoder.WriteMapStart(m_tags.size()); - for (const auto& item_0 : m_tags) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString(item_0.first.c_str())); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(item_0.second.c_str())); + JsonValue tagsJsonMap; + for (auto& tagsItem : m_tags) { + tagsJsonMap.WithString(tagsItem.first, tagsItem.second); } + payload.WithObject("tags", std::move(tagsJsonMap)); } - const auto str = Aws::String(reinterpret_cast(encoder.GetEncodedData().ptr), encoder.GetEncodedData().len); - return str; + + return payload.View().WriteReadable(); } Aws::Http::HeaderValueCollection CreateBillEstimateRequest::GetRequestSpecificHeaders() const { Aws::Http::HeaderValueCollection headers; - headers.emplace(Aws::Http::CONTENT_TYPE_HEADER, Aws::CBOR_CONTENT_TYPE); - headers.emplace(Aws::Http::SMITHY_PROTOCOL_HEADER, Aws::RPC_V2_CBOR); - headers.emplace(Aws::Http::ACCEPT_HEADER, Aws::CBOR_CONTENT_TYPE); + headers.insert(Aws::Http::HeaderValuePair("X-Amz-Target", "AWSBCMPricingCalculator.CreateBillEstimate")); return headers; } diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/CreateBillEstimateResult.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/CreateBillEstimateResult.cpp index 421d72299c54..2f8258663633 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/CreateBillEstimateResult.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/CreateBillEstimateResult.cpp @@ -7,509 +7,65 @@ #include #include #include -#include +#include #include -#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; -using namespace Aws::Utils::Cbor; using namespace Aws; -CreateBillEstimateResult::CreateBillEstimateResult(const Aws::AmazonWebServiceResult& result) { - *this = result; -} +CreateBillEstimateResult::CreateBillEstimateResult(const Aws::AmazonWebServiceResult& result) { *this = result; } -CreateBillEstimateResult& CreateBillEstimateResult::operator=(const Aws::AmazonWebServiceResult& result) { +CreateBillEstimateResult& CreateBillEstimateResult::operator=(const Aws::AmazonWebServiceResult& result) { m_HttpResponseCode = result.GetResponseCode(); - - const auto& cborValue = result.GetPayload(); - const auto decoder = cborValue.GetDecoder(); - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "name") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_name = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_name = ss.str(); - } - } - m_nameHasBeenSet = true; - } - - else if (initialKeyStr == "status") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_status = BillEstimateStatusMapper::GetBillEstimateStatusForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_statusHasBeenSet = true; - } - - else if (initialKeyStr == "failureMessage") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_failureMessage = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_failureMessage = ss.str(); - } - } - m_failureMessageHasBeenSet = true; - } - - else if (initialKeyStr == "billInterval") { - m_billInterval = BillInterval(decoder); - m_billIntervalHasBeenSet = true; - } - - else if (initialKeyStr == "costSummary") { - m_costSummary = BillEstimateCostSummary(decoder); - m_costSummaryHasBeenSet = true; - } - - else if (initialKeyStr == "createdAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_createdAtHasBeenSet = true; - } - - else if (initialKeyStr == "expiresAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_expiresAtHasBeenSet = true; - } - - else if (initialKeyStr == "groupSharingPreference") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_groupSharingPreference = GroupSharingPreferenceEnumMapper::GetGroupSharingPreferenceEnumForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_groupSharingPreferenceHasBeenSet = true; - } - - else if (initialKeyStr == "costCategoryGroupSharingPreferenceArn") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_costCategoryGroupSharingPreferenceArn = - Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_costCategoryGroupSharingPreferenceArn = ss.str(); - } - } - m_costCategoryGroupSharingPreferenceArnHasBeenSet = true; - } - - else if (initialKeyStr == "costCategoryGroupSharingPreferenceEffectiveDate") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_costCategoryGroupSharingPreferenceEffectiveDate = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_costCategoryGroupSharingPreferenceEffectiveDate = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_costCategoryGroupSharingPreferenceEffectiveDateHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("CreateBillEstimateResult", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "name") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_name = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_name = ss.str(); - } - } - m_nameHasBeenSet = true; - } - - else if (initialKeyStr == "status") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_status = BillEstimateStatusMapper::GetBillEstimateStatusForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_statusHasBeenSet = true; - } - - else if (initialKeyStr == "failureMessage") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_failureMessage = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_failureMessage = ss.str(); - } - } - m_failureMessageHasBeenSet = true; - } - - else if (initialKeyStr == "billInterval") { - m_billInterval = BillInterval(decoder); - m_billIntervalHasBeenSet = true; - } - - else if (initialKeyStr == "costSummary") { - m_costSummary = BillEstimateCostSummary(decoder); - m_costSummaryHasBeenSet = true; - } - - else if (initialKeyStr == "createdAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_createdAtHasBeenSet = true; - } - - else if (initialKeyStr == "expiresAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_expiresAtHasBeenSet = true; - } - - else if (initialKeyStr == "groupSharingPreference") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_groupSharingPreference = GroupSharingPreferenceEnumMapper::GetGroupSharingPreferenceEnumForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_groupSharingPreferenceHasBeenSet = true; - } - - else if (initialKeyStr == "costCategoryGroupSharingPreferenceArn") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_costCategoryGroupSharingPreferenceArn = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_costCategoryGroupSharingPreferenceArn = ss.str(); - } - } - m_costCategoryGroupSharingPreferenceArnHasBeenSet = true; - } - - else if (initialKeyStr == "costCategoryGroupSharingPreferenceEffectiveDate") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_costCategoryGroupSharingPreferenceEffectiveDate = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_costCategoryGroupSharingPreferenceEffectiveDate = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_costCategoryGroupSharingPreferenceEffectiveDateHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } + JsonView jsonValue = result.GetPayload().View(); + if (jsonValue.ValueExists("id")) { + m_id = jsonValue.GetString("id"); + m_idHasBeenSet = true; + } + if (jsonValue.ValueExists("name")) { + m_name = jsonValue.GetString("name"); + m_nameHasBeenSet = true; + } + if (jsonValue.ValueExists("status")) { + m_status = BillEstimateStatusMapper::GetBillEstimateStatusForName(jsonValue.GetString("status")); + m_statusHasBeenSet = true; + } + if (jsonValue.ValueExists("failureMessage")) { + m_failureMessage = jsonValue.GetString("failureMessage"); + m_failureMessageHasBeenSet = true; + } + if (jsonValue.ValueExists("billInterval")) { + m_billInterval = jsonValue.GetObject("billInterval"); + m_billIntervalHasBeenSet = true; + } + if (jsonValue.ValueExists("costSummary")) { + m_costSummary = jsonValue.GetObject("costSummary"); + m_costSummaryHasBeenSet = true; + } + if (jsonValue.ValueExists("createdAt")) { + m_createdAt = jsonValue.GetDouble("createdAt"); + m_createdAtHasBeenSet = true; + } + if (jsonValue.ValueExists("expiresAt")) { + m_expiresAt = jsonValue.GetDouble("expiresAt"); + m_expiresAtHasBeenSet = true; + } + if (jsonValue.ValueExists("groupSharingPreference")) { + m_groupSharingPreference = + GroupSharingPreferenceEnumMapper::GetGroupSharingPreferenceEnumForName(jsonValue.GetString("groupSharingPreference")); + m_groupSharingPreferenceHasBeenSet = true; + } + if (jsonValue.ValueExists("costCategoryGroupSharingPreferenceArn")) { + m_costCategoryGroupSharingPreferenceArn = jsonValue.GetString("costCategoryGroupSharingPreferenceArn"); + m_costCategoryGroupSharingPreferenceArnHasBeenSet = true; + } + if (jsonValue.ValueExists("costCategoryGroupSharingPreferenceEffectiveDate")) { + m_costCategoryGroupSharingPreferenceEffectiveDate = jsonValue.GetDouble("costCategoryGroupSharingPreferenceEffectiveDate"); + m_costCategoryGroupSharingPreferenceEffectiveDateHasBeenSet = true; } const auto& headers = result.GetHeaderValueCollection(); diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/CreateBillScenarioRequest.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/CreateBillScenarioRequest.cpp index 9051d211c4d9..792f57b155ae 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/CreateBillScenarioRequest.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/CreateBillScenarioRequest.cpp @@ -4,74 +4,47 @@ */ #include -#include +#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; Aws::String CreateBillScenarioRequest::SerializePayload() const { - Aws::Crt::Cbor::CborEncoder encoder; + JsonValue payload; - // Calculate map size - size_t mapSize = 0; if (m_nameHasBeenSet) { - mapSize++; - } - if (m_clientTokenHasBeenSet) { - mapSize++; - } - if (m_tagsHasBeenSet) { - mapSize++; - } - if (m_groupSharingPreferenceHasBeenSet) { - mapSize++; - } - if (m_costCategoryGroupSharingPreferenceArnHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); - - if (m_nameHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("name")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_name.c_str())); + payload.WithString("name", m_name); } if (m_clientTokenHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("clientToken")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_clientToken.c_str())); + payload.WithString("clientToken", m_clientToken); } if (m_tagsHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("tags")); - encoder.WriteMapStart(m_tags.size()); - for (const auto& item_0 : m_tags) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString(item_0.first.c_str())); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(item_0.second.c_str())); + JsonValue tagsJsonMap; + for (auto& tagsItem : m_tags) { + tagsJsonMap.WithString(tagsItem.first, tagsItem.second); } + payload.WithObject("tags", std::move(tagsJsonMap)); } if (m_groupSharingPreferenceHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("groupSharingPreference")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString( - GroupSharingPreferenceEnumMapper::GetNameForGroupSharingPreferenceEnum(m_groupSharingPreference).c_str())); + payload.WithString("groupSharingPreference", + GroupSharingPreferenceEnumMapper::GetNameForGroupSharingPreferenceEnum(m_groupSharingPreference)); } if (m_costCategoryGroupSharingPreferenceArnHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("costCategoryGroupSharingPreferenceArn")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_costCategoryGroupSharingPreferenceArn.c_str())); + payload.WithString("costCategoryGroupSharingPreferenceArn", m_costCategoryGroupSharingPreferenceArn); } - const auto str = Aws::String(reinterpret_cast(encoder.GetEncodedData().ptr), encoder.GetEncodedData().len); - return str; + + return payload.View().WriteReadable(); } Aws::Http::HeaderValueCollection CreateBillScenarioRequest::GetRequestSpecificHeaders() const { Aws::Http::HeaderValueCollection headers; - headers.emplace(Aws::Http::CONTENT_TYPE_HEADER, Aws::CBOR_CONTENT_TYPE); - headers.emplace(Aws::Http::SMITHY_PROTOCOL_HEADER, Aws::RPC_V2_CBOR); - headers.emplace(Aws::Http::ACCEPT_HEADER, Aws::CBOR_CONTENT_TYPE); + headers.insert(Aws::Http::HeaderValuePair("X-Amz-Target", "AWSBCMPricingCalculator.CreateBillScenario")); return headers; } diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/CreateBillScenarioResult.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/CreateBillScenarioResult.cpp index 1af0f627e8e5..a788c8e3b5e6 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/CreateBillScenarioResult.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/CreateBillScenarioResult.cpp @@ -7,453 +7,57 @@ #include #include #include -#include +#include #include -#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; -using namespace Aws::Utils::Cbor; using namespace Aws; -CreateBillScenarioResult::CreateBillScenarioResult(const Aws::AmazonWebServiceResult& result) { - *this = result; -} +CreateBillScenarioResult::CreateBillScenarioResult(const Aws::AmazonWebServiceResult& result) { *this = result; } -CreateBillScenarioResult& CreateBillScenarioResult::operator=(const Aws::AmazonWebServiceResult& result) { +CreateBillScenarioResult& CreateBillScenarioResult::operator=(const Aws::AmazonWebServiceResult& result) { m_HttpResponseCode = result.GetResponseCode(); - - const auto& cborValue = result.GetPayload(); - const auto decoder = cborValue.GetDecoder(); - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "name") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_name = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_name = ss.str(); - } - } - m_nameHasBeenSet = true; - } - - else if (initialKeyStr == "billInterval") { - m_billInterval = BillInterval(decoder); - m_billIntervalHasBeenSet = true; - } - - else if (initialKeyStr == "status") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_status = BillScenarioStatusMapper::GetBillScenarioStatusForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_statusHasBeenSet = true; - } - - else if (initialKeyStr == "createdAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_createdAtHasBeenSet = true; - } - - else if (initialKeyStr == "expiresAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_expiresAtHasBeenSet = true; - } - - else if (initialKeyStr == "failureMessage") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_failureMessage = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_failureMessage = ss.str(); - } - } - m_failureMessageHasBeenSet = true; - } - - else if (initialKeyStr == "groupSharingPreference") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_groupSharingPreference = GroupSharingPreferenceEnumMapper::GetGroupSharingPreferenceEnumForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_groupSharingPreferenceHasBeenSet = true; - } - - else if (initialKeyStr == "costCategoryGroupSharingPreferenceArn") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_costCategoryGroupSharingPreferenceArn = - Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_costCategoryGroupSharingPreferenceArn = ss.str(); - } - } - m_costCategoryGroupSharingPreferenceArnHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("CreateBillScenarioResult", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "name") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_name = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_name = ss.str(); - } - } - m_nameHasBeenSet = true; - } - - else if (initialKeyStr == "billInterval") { - m_billInterval = BillInterval(decoder); - m_billIntervalHasBeenSet = true; - } - - else if (initialKeyStr == "status") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_status = BillScenarioStatusMapper::GetBillScenarioStatusForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_statusHasBeenSet = true; - } - - else if (initialKeyStr == "createdAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_createdAtHasBeenSet = true; - } - - else if (initialKeyStr == "expiresAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_expiresAtHasBeenSet = true; - } - - else if (initialKeyStr == "failureMessage") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_failureMessage = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_failureMessage = ss.str(); - } - } - m_failureMessageHasBeenSet = true; - } - - else if (initialKeyStr == "groupSharingPreference") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_groupSharingPreference = GroupSharingPreferenceEnumMapper::GetGroupSharingPreferenceEnumForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_groupSharingPreferenceHasBeenSet = true; - } - - else if (initialKeyStr == "costCategoryGroupSharingPreferenceArn") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_costCategoryGroupSharingPreferenceArn = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_costCategoryGroupSharingPreferenceArn = ss.str(); - } - } - m_costCategoryGroupSharingPreferenceArnHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } + JsonView jsonValue = result.GetPayload().View(); + if (jsonValue.ValueExists("id")) { + m_id = jsonValue.GetString("id"); + m_idHasBeenSet = true; + } + if (jsonValue.ValueExists("name")) { + m_name = jsonValue.GetString("name"); + m_nameHasBeenSet = true; + } + if (jsonValue.ValueExists("billInterval")) { + m_billInterval = jsonValue.GetObject("billInterval"); + m_billIntervalHasBeenSet = true; + } + if (jsonValue.ValueExists("status")) { + m_status = BillScenarioStatusMapper::GetBillScenarioStatusForName(jsonValue.GetString("status")); + m_statusHasBeenSet = true; + } + if (jsonValue.ValueExists("createdAt")) { + m_createdAt = jsonValue.GetDouble("createdAt"); + m_createdAtHasBeenSet = true; + } + if (jsonValue.ValueExists("expiresAt")) { + m_expiresAt = jsonValue.GetDouble("expiresAt"); + m_expiresAtHasBeenSet = true; + } + if (jsonValue.ValueExists("failureMessage")) { + m_failureMessage = jsonValue.GetString("failureMessage"); + m_failureMessageHasBeenSet = true; + } + if (jsonValue.ValueExists("groupSharingPreference")) { + m_groupSharingPreference = + GroupSharingPreferenceEnumMapper::GetGroupSharingPreferenceEnumForName(jsonValue.GetString("groupSharingPreference")); + m_groupSharingPreferenceHasBeenSet = true; + } + if (jsonValue.ValueExists("costCategoryGroupSharingPreferenceArn")) { + m_costCategoryGroupSharingPreferenceArn = jsonValue.GetString("costCategoryGroupSharingPreferenceArn"); + m_costCategoryGroupSharingPreferenceArnHasBeenSet = true; } const auto& headers = result.GetHeaderValueCollection(); diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/CreateWorkloadEstimateRequest.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/CreateWorkloadEstimateRequest.cpp index 8c685495441e..51beb0046196 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/CreateWorkloadEstimateRequest.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/CreateWorkloadEstimateRequest.cpp @@ -4,66 +4,42 @@ */ #include -#include +#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; Aws::String CreateWorkloadEstimateRequest::SerializePayload() const { - Aws::Crt::Cbor::CborEncoder encoder; + JsonValue payload; - // Calculate map size - size_t mapSize = 0; if (m_nameHasBeenSet) { - mapSize++; - } - if (m_clientTokenHasBeenSet) { - mapSize++; - } - if (m_rateTypeHasBeenSet) { - mapSize++; - } - if (m_tagsHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); - - if (m_nameHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("name")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_name.c_str())); + payload.WithString("name", m_name); } if (m_clientTokenHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("clientToken")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_clientToken.c_str())); + payload.WithString("clientToken", m_clientToken); } if (m_rateTypeHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("rateType")); - encoder.WriteText( - Aws::Crt::ByteCursorFromCString(WorkloadEstimateRateTypeMapper::GetNameForWorkloadEstimateRateType(m_rateType).c_str())); + payload.WithString("rateType", WorkloadEstimateRateTypeMapper::GetNameForWorkloadEstimateRateType(m_rateType)); } if (m_tagsHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("tags")); - encoder.WriteMapStart(m_tags.size()); - for (const auto& item_0 : m_tags) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString(item_0.first.c_str())); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(item_0.second.c_str())); + JsonValue tagsJsonMap; + for (auto& tagsItem : m_tags) { + tagsJsonMap.WithString(tagsItem.first, tagsItem.second); } + payload.WithObject("tags", std::move(tagsJsonMap)); } - const auto str = Aws::String(reinterpret_cast(encoder.GetEncodedData().ptr), encoder.GetEncodedData().len); - return str; + + return payload.View().WriteReadable(); } Aws::Http::HeaderValueCollection CreateWorkloadEstimateRequest::GetRequestSpecificHeaders() const { Aws::Http::HeaderValueCollection headers; - headers.emplace(Aws::Http::CONTENT_TYPE_HEADER, Aws::CBOR_CONTENT_TYPE); - headers.emplace(Aws::Http::SMITHY_PROTOCOL_HEADER, Aws::RPC_V2_CBOR); - headers.emplace(Aws::Http::ACCEPT_HEADER, Aws::CBOR_CONTENT_TYPE); + headers.insert(Aws::Http::HeaderValuePair("X-Amz-Target", "AWSBCMPricingCalculator.CreateWorkloadEstimate")); return headers; } diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/CreateWorkloadEstimateResult.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/CreateWorkloadEstimateResult.cpp index 6b1375ff1ea4..93d54c223e7e 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/CreateWorkloadEstimateResult.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/CreateWorkloadEstimateResult.cpp @@ -7,463 +7,60 @@ #include #include #include -#include +#include #include -#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; -using namespace Aws::Utils::Cbor; using namespace Aws; -CreateWorkloadEstimateResult::CreateWorkloadEstimateResult(const Aws::AmazonWebServiceResult& result) { - *this = result; -} +CreateWorkloadEstimateResult::CreateWorkloadEstimateResult(const Aws::AmazonWebServiceResult& result) { *this = result; } -CreateWorkloadEstimateResult& CreateWorkloadEstimateResult::operator=( - const Aws::AmazonWebServiceResult& result) { +CreateWorkloadEstimateResult& CreateWorkloadEstimateResult::operator=(const Aws::AmazonWebServiceResult& result) { m_HttpResponseCode = result.GetResponseCode(); - - const auto& cborValue = result.GetPayload(); - const auto decoder = cborValue.GetDecoder(); - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "name") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_name = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_name = ss.str(); - } - } - m_nameHasBeenSet = true; - } - - else if (initialKeyStr == "createdAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_createdAtHasBeenSet = true; - } - - else if (initialKeyStr == "expiresAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_expiresAtHasBeenSet = true; - } - - else if (initialKeyStr == "rateType") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_rateType = WorkloadEstimateRateTypeMapper::GetWorkloadEstimateRateTypeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_rateTypeHasBeenSet = true; - } - - else if (initialKeyStr == "rateTimestamp") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_rateTimestamp = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_rateTimestamp = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_rateTimestampHasBeenSet = true; - } - - else if (initialKeyStr == "status") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_status = WorkloadEstimateStatusMapper::GetWorkloadEstimateStatusForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_statusHasBeenSet = true; - } - - else if (initialKeyStr == "totalCost") { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_totalCost = val.value(); - } - m_totalCostHasBeenSet = true; - } - - else if (initialKeyStr == "costCurrency") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_costCurrency = CurrencyCodeMapper::GetCurrencyCodeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_costCurrencyHasBeenSet = true; - } - - else if (initialKeyStr == "failureMessage") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_failureMessage = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_failureMessage = ss.str(); - } - } - m_failureMessageHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("CreateWorkloadEstimateResult", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "name") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_name = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_name = ss.str(); - } - } - m_nameHasBeenSet = true; - } - - else if (initialKeyStr == "createdAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_createdAtHasBeenSet = true; - } - - else if (initialKeyStr == "expiresAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_expiresAtHasBeenSet = true; - } - - else if (initialKeyStr == "rateType") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_rateType = WorkloadEstimateRateTypeMapper::GetWorkloadEstimateRateTypeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_rateTypeHasBeenSet = true; - } - - else if (initialKeyStr == "rateTimestamp") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_rateTimestamp = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_rateTimestamp = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_rateTimestampHasBeenSet = true; - } - - else if (initialKeyStr == "status") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_status = WorkloadEstimateStatusMapper::GetWorkloadEstimateStatusForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_statusHasBeenSet = true; - } - - else if (initialKeyStr == "totalCost") { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_totalCost = val.value(); - } - m_totalCostHasBeenSet = true; - } - - else if (initialKeyStr == "costCurrency") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_costCurrency = CurrencyCodeMapper::GetCurrencyCodeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_costCurrencyHasBeenSet = true; - } - - else if (initialKeyStr == "failureMessage") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_failureMessage = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_failureMessage = ss.str(); - } - } - m_failureMessageHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } + JsonView jsonValue = result.GetPayload().View(); + if (jsonValue.ValueExists("id")) { + m_id = jsonValue.GetString("id"); + m_idHasBeenSet = true; + } + if (jsonValue.ValueExists("name")) { + m_name = jsonValue.GetString("name"); + m_nameHasBeenSet = true; + } + if (jsonValue.ValueExists("createdAt")) { + m_createdAt = jsonValue.GetDouble("createdAt"); + m_createdAtHasBeenSet = true; + } + if (jsonValue.ValueExists("expiresAt")) { + m_expiresAt = jsonValue.GetDouble("expiresAt"); + m_expiresAtHasBeenSet = true; + } + if (jsonValue.ValueExists("rateType")) { + m_rateType = WorkloadEstimateRateTypeMapper::GetWorkloadEstimateRateTypeForName(jsonValue.GetString("rateType")); + m_rateTypeHasBeenSet = true; + } + if (jsonValue.ValueExists("rateTimestamp")) { + m_rateTimestamp = jsonValue.GetDouble("rateTimestamp"); + m_rateTimestampHasBeenSet = true; + } + if (jsonValue.ValueExists("status")) { + m_status = WorkloadEstimateStatusMapper::GetWorkloadEstimateStatusForName(jsonValue.GetString("status")); + m_statusHasBeenSet = true; + } + if (jsonValue.ValueExists("totalCost")) { + m_totalCost = jsonValue.GetDouble("totalCost"); + m_totalCostHasBeenSet = true; + } + if (jsonValue.ValueExists("costCurrency")) { + m_costCurrency = CurrencyCodeMapper::GetCurrencyCodeForName(jsonValue.GetString("costCurrency")); + m_costCurrencyHasBeenSet = true; + } + if (jsonValue.ValueExists("failureMessage")) { + m_failureMessage = jsonValue.GetString("failureMessage"); + m_failureMessageHasBeenSet = true; } const auto& headers = result.GetHeaderValueCollection(); diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/DeleteBillEstimateRequest.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/DeleteBillEstimateRequest.cpp index af255d9a482a..deb85f364879 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/DeleteBillEstimateRequest.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/DeleteBillEstimateRequest.cpp @@ -4,37 +4,26 @@ */ #include -#include +#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; Aws::String DeleteBillEstimateRequest::SerializePayload() const { - Aws::Crt::Cbor::CborEncoder encoder; + JsonValue payload; - // Calculate map size - size_t mapSize = 0; if (m_identifierHasBeenSet) { - mapSize++; + payload.WithString("identifier", m_identifier); } - encoder.WriteMapStart(mapSize); - - if (m_identifierHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("identifier")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_identifier.c_str())); - } - const auto str = Aws::String(reinterpret_cast(encoder.GetEncodedData().ptr), encoder.GetEncodedData().len); - return str; + return payload.View().WriteReadable(); } Aws::Http::HeaderValueCollection DeleteBillEstimateRequest::GetRequestSpecificHeaders() const { Aws::Http::HeaderValueCollection headers; - headers.emplace(Aws::Http::CONTENT_TYPE_HEADER, Aws::CBOR_CONTENT_TYPE); - headers.emplace(Aws::Http::SMITHY_PROTOCOL_HEADER, Aws::RPC_V2_CBOR); - headers.emplace(Aws::Http::ACCEPT_HEADER, Aws::CBOR_CONTENT_TYPE); + headers.insert(Aws::Http::HeaderValuePair("X-Amz-Target", "AWSBCMPricingCalculator.DeleteBillEstimate")); return headers; } diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/DeleteBillEstimateResult.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/DeleteBillEstimateResult.cpp index d38148af2fe5..15face8d4d16 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/DeleteBillEstimateResult.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/DeleteBillEstimateResult.cpp @@ -7,25 +7,21 @@ #include #include #include -#include +#include #include -#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; -using namespace Aws::Utils::Cbor; using namespace Aws; -DeleteBillEstimateResult::DeleteBillEstimateResult(const Aws::AmazonWebServiceResult& result) { - *this = result; -} +DeleteBillEstimateResult::DeleteBillEstimateResult(const Aws::AmazonWebServiceResult& result) { *this = result; } -DeleteBillEstimateResult& DeleteBillEstimateResult::operator=(const Aws::AmazonWebServiceResult& result) { +DeleteBillEstimateResult& DeleteBillEstimateResult::operator=(const Aws::AmazonWebServiceResult& result) { m_HttpResponseCode = result.GetResponseCode(); + AWS_UNREFERENCED_PARAM(result); const auto& headers = result.GetHeaderValueCollection(); const auto& requestIdIter = headers.find("x-amzn-requestid"); diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/DeleteBillScenarioRequest.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/DeleteBillScenarioRequest.cpp index 041aeaab8238..bbeca3408119 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/DeleteBillScenarioRequest.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/DeleteBillScenarioRequest.cpp @@ -4,37 +4,26 @@ */ #include -#include +#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; Aws::String DeleteBillScenarioRequest::SerializePayload() const { - Aws::Crt::Cbor::CborEncoder encoder; + JsonValue payload; - // Calculate map size - size_t mapSize = 0; if (m_identifierHasBeenSet) { - mapSize++; + payload.WithString("identifier", m_identifier); } - encoder.WriteMapStart(mapSize); - - if (m_identifierHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("identifier")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_identifier.c_str())); - } - const auto str = Aws::String(reinterpret_cast(encoder.GetEncodedData().ptr), encoder.GetEncodedData().len); - return str; + return payload.View().WriteReadable(); } Aws::Http::HeaderValueCollection DeleteBillScenarioRequest::GetRequestSpecificHeaders() const { Aws::Http::HeaderValueCollection headers; - headers.emplace(Aws::Http::CONTENT_TYPE_HEADER, Aws::CBOR_CONTENT_TYPE); - headers.emplace(Aws::Http::SMITHY_PROTOCOL_HEADER, Aws::RPC_V2_CBOR); - headers.emplace(Aws::Http::ACCEPT_HEADER, Aws::CBOR_CONTENT_TYPE); + headers.insert(Aws::Http::HeaderValuePair("X-Amz-Target", "AWSBCMPricingCalculator.DeleteBillScenario")); return headers; } diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/DeleteBillScenarioResult.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/DeleteBillScenarioResult.cpp index 8158810fec63..5f80c5686aa9 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/DeleteBillScenarioResult.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/DeleteBillScenarioResult.cpp @@ -7,25 +7,21 @@ #include #include #include -#include +#include #include -#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; -using namespace Aws::Utils::Cbor; using namespace Aws; -DeleteBillScenarioResult::DeleteBillScenarioResult(const Aws::AmazonWebServiceResult& result) { - *this = result; -} +DeleteBillScenarioResult::DeleteBillScenarioResult(const Aws::AmazonWebServiceResult& result) { *this = result; } -DeleteBillScenarioResult& DeleteBillScenarioResult::operator=(const Aws::AmazonWebServiceResult& result) { +DeleteBillScenarioResult& DeleteBillScenarioResult::operator=(const Aws::AmazonWebServiceResult& result) { m_HttpResponseCode = result.GetResponseCode(); + AWS_UNREFERENCED_PARAM(result); const auto& headers = result.GetHeaderValueCollection(); const auto& requestIdIter = headers.find("x-amzn-requestid"); diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/DeleteWorkloadEstimateRequest.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/DeleteWorkloadEstimateRequest.cpp index b4bfcace3955..6536ffc1291e 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/DeleteWorkloadEstimateRequest.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/DeleteWorkloadEstimateRequest.cpp @@ -4,37 +4,26 @@ */ #include -#include +#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; Aws::String DeleteWorkloadEstimateRequest::SerializePayload() const { - Aws::Crt::Cbor::CborEncoder encoder; + JsonValue payload; - // Calculate map size - size_t mapSize = 0; if (m_identifierHasBeenSet) { - mapSize++; + payload.WithString("identifier", m_identifier); } - encoder.WriteMapStart(mapSize); - - if (m_identifierHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("identifier")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_identifier.c_str())); - } - const auto str = Aws::String(reinterpret_cast(encoder.GetEncodedData().ptr), encoder.GetEncodedData().len); - return str; + return payload.View().WriteReadable(); } Aws::Http::HeaderValueCollection DeleteWorkloadEstimateRequest::GetRequestSpecificHeaders() const { Aws::Http::HeaderValueCollection headers; - headers.emplace(Aws::Http::CONTENT_TYPE_HEADER, Aws::CBOR_CONTENT_TYPE); - headers.emplace(Aws::Http::SMITHY_PROTOCOL_HEADER, Aws::RPC_V2_CBOR); - headers.emplace(Aws::Http::ACCEPT_HEADER, Aws::CBOR_CONTENT_TYPE); + headers.insert(Aws::Http::HeaderValuePair("X-Amz-Target", "AWSBCMPricingCalculator.DeleteWorkloadEstimate")); return headers; } diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/DeleteWorkloadEstimateResult.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/DeleteWorkloadEstimateResult.cpp index 1812aff85e00..c7ca6de000df 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/DeleteWorkloadEstimateResult.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/DeleteWorkloadEstimateResult.cpp @@ -7,26 +7,21 @@ #include #include #include -#include +#include #include -#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; -using namespace Aws::Utils::Cbor; using namespace Aws; -DeleteWorkloadEstimateResult::DeleteWorkloadEstimateResult(const Aws::AmazonWebServiceResult& result) { - *this = result; -} +DeleteWorkloadEstimateResult::DeleteWorkloadEstimateResult(const Aws::AmazonWebServiceResult& result) { *this = result; } -DeleteWorkloadEstimateResult& DeleteWorkloadEstimateResult::operator=( - const Aws::AmazonWebServiceResult& result) { +DeleteWorkloadEstimateResult& DeleteWorkloadEstimateResult::operator=(const Aws::AmazonWebServiceResult& result) { m_HttpResponseCode = result.GetResponseCode(); + AWS_UNREFERENCED_PARAM(result); const auto& headers = result.GetHeaderValueCollection(); const auto& requestIdIter = headers.find("x-amzn-requestid"); diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/Expression.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/Expression.cpp index 6d868cb7b7f3..f0f37d1359de 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/Expression.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/Expression.cpp @@ -4,285 +4,91 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -Expression::Expression(const std::shared_ptr& decoder) { *this = decoder; } +Expression::Expression(JsonView jsonValue) { *this = jsonValue; } -Expression& Expression::operator=(const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "and") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_and.push_back(Expression(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_and.push_back(Expression(decoder)); - } - } - } - m_andHasBeenSet = true; - } - - else if (initialKeyStr == "or") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_or.push_back(Expression(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_or.push_back(Expression(decoder)); - } - } - } - m_orHasBeenSet = true; - } - - else if (initialKeyStr == "not") { - m_not = Aws::MakeShared("Expression", Expression(decoder)); - m_notHasBeenSet = true; - } - - else if (initialKeyStr == "costCategories") { - m_costCategories = ExpressionFilter(decoder); - m_costCategoriesHasBeenSet = true; - } - - else if (initialKeyStr == "dimensions") { - m_dimensions = ExpressionFilter(decoder); - m_dimensionsHasBeenSet = true; - } - - else if (initialKeyStr == "tags") { - m_tags = ExpressionFilter(decoder); - m_tagsHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("Expression", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "and") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_and.push_back(Expression(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_and.push_back(Expression(decoder)); - } - } - } - m_andHasBeenSet = true; - } - - else if (initialKeyStr == "or") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_or.push_back(Expression(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_or.push_back(Expression(decoder)); - } - } - } - m_orHasBeenSet = true; - } - - else if (initialKeyStr == "not") { - m_not = Aws::MakeShared("Expression", Expression(decoder)); - m_notHasBeenSet = true; - } - - else if (initialKeyStr == "costCategories") { - m_costCategories = ExpressionFilter(decoder); - m_costCategoriesHasBeenSet = true; - } - - else if (initialKeyStr == "dimensions") { - m_dimensions = ExpressionFilter(decoder); - m_dimensionsHasBeenSet = true; - } - - else if (initialKeyStr == "tags") { - m_tags = ExpressionFilter(decoder); - m_tagsHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } +Expression& Expression::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("and")) { + Aws::Utils::Array andJsonList = jsonValue.GetArray("and"); + for (unsigned andIndex = 0; andIndex < andJsonList.GetLength(); ++andIndex) { + m_and.push_back(andJsonList[andIndex].AsObject()); } + m_andHasBeenSet = true; } - - return *this; -} - -void Expression::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_andHasBeenSet) { - mapSize++; - } - if (m_orHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("or")) { + Aws::Utils::Array orJsonList = jsonValue.GetArray("or"); + for (unsigned orIndex = 0; orIndex < orJsonList.GetLength(); ++orIndex) { + m_or.push_back(orJsonList[orIndex].AsObject()); + } + m_orHasBeenSet = true; } - if (m_notHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("not")) { + m_not = Aws::MakeShared("Expression", jsonValue.GetObject("not")); + m_notHasBeenSet = true; } - if (m_costCategoriesHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("costCategories")) { + m_costCategories = jsonValue.GetObject("costCategories"); + m_costCategoriesHasBeenSet = true; } - if (m_dimensionsHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("dimensions")) { + m_dimensions = jsonValue.GetObject("dimensions"); + m_dimensionsHasBeenSet = true; } - if (m_tagsHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("tags")) { + m_tags = jsonValue.GetObject("tags"); + m_tagsHasBeenSet = true; } + return *this; +} - encoder.WriteMapStart(mapSize); +JsonValue Expression::Jsonize() const { + JsonValue payload; if (m_andHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("and")); - encoder.WriteArrayStart(m_and.size()); - for (const auto& item_0 : m_and) { - item_0.CborEncode(encoder); + Aws::Utils::Array andJsonList(m_and.size()); + for (unsigned andIndex = 0; andIndex < andJsonList.GetLength(); ++andIndex) { + andJsonList[andIndex].AsObject(m_and[andIndex].Jsonize()); } + payload.WithArray("and", std::move(andJsonList)); } if (m_orHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("or")); - encoder.WriteArrayStart(m_or.size()); - for (const auto& item_0 : m_or) { - item_0.CborEncode(encoder); + Aws::Utils::Array orJsonList(m_or.size()); + for (unsigned orIndex = 0; orIndex < orJsonList.GetLength(); ++orIndex) { + orJsonList[orIndex].AsObject(m_or[orIndex].Jsonize()); } + payload.WithArray("or", std::move(orJsonList)); } if (m_notHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("not")); - m_not->CborEncode(encoder); + payload.WithObject("not", m_not->Jsonize()); } if (m_costCategoriesHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("costCategories")); - m_costCategories.CborEncode(encoder); + payload.WithObject("costCategories", m_costCategories.Jsonize()); } if (m_dimensionsHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("dimensions")); - m_dimensions.CborEncode(encoder); + payload.WithObject("dimensions", m_dimensions.Jsonize()); } if (m_tagsHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("tags")); - m_tags.CborEncode(encoder); + payload.WithObject("tags", m_tags.Jsonize()); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ExpressionFilter.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ExpressionFilter.cpp index e55b913be8bd..9f4825aed66c 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ExpressionFilter.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ExpressionFilter.cpp @@ -4,489 +4,67 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -ExpressionFilter::ExpressionFilter(const std::shared_ptr& decoder) { *this = decoder; } +ExpressionFilter::ExpressionFilter(JsonView jsonValue) { *this = jsonValue; } -ExpressionFilter& ExpressionFilter::operator=(const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "key") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_key = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_key = ss.str(); - } - } - m_keyHasBeenSet = true; - } - - else if (initialKeyStr == "matchOptions") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - auto peekType_1 = decoder->PeekType(); - if (peekType_1.has_value()) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_matchOptions.push_back(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_matchOptions.push_back(ss_1.str()); - ss_1.clear(); - } - } - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto peekType_1 = decoder->PeekType(); - if (peekType_1.has_value()) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_matchOptions.push_back(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_matchOptions.push_back(ss_1.str()); - ss_1.clear(); - } - } - } - } - } - m_matchOptionsHasBeenSet = true; - } - - else if (initialKeyStr == "values") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - auto peekType_1 = decoder->PeekType(); - if (peekType_1.has_value()) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_values.push_back(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_values.push_back(ss_1.str()); - ss_1.clear(); - } - } - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto peekType_1 = decoder->PeekType(); - if (peekType_1.has_value()) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_values.push_back(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_values.push_back(ss_1.str()); - ss_1.clear(); - } - } - } - } - } - m_valuesHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("ExpressionFilter", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "key") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_key = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_key = ss.str(); - } - } - m_keyHasBeenSet = true; - } - - else if (initialKeyStr == "matchOptions") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - auto peekType_1 = decoder->PeekType(); - if (peekType_1.has_value()) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_matchOptions.push_back(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_matchOptions.push_back(ss_1.str()); - ss_1.clear(); - } - } - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto peekType_1 = decoder->PeekType(); - if (peekType_1.has_value()) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_matchOptions.push_back(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_matchOptions.push_back(ss_1.str()); - ss_1.clear(); - } - } - } - } - } - m_matchOptionsHasBeenSet = true; - } - - else if (initialKeyStr == "values") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - auto peekType_1 = decoder->PeekType(); - if (peekType_1.has_value()) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_values.push_back(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_values.push_back(ss_1.str()); - ss_1.clear(); - } - } - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto peekType_1 = decoder->PeekType(); - if (peekType_1.has_value()) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_values.push_back(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_values.push_back(ss_1.str()); - ss_1.clear(); - } - } - } - } - } - m_valuesHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } +ExpressionFilter& ExpressionFilter::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("key")) { + m_key = jsonValue.GetString("key"); + m_keyHasBeenSet = true; + } + if (jsonValue.ValueExists("matchOptions")) { + Aws::Utils::Array matchOptionsJsonList = jsonValue.GetArray("matchOptions"); + for (unsigned matchOptionsIndex = 0; matchOptionsIndex < matchOptionsJsonList.GetLength(); ++matchOptionsIndex) { + m_matchOptions.push_back(matchOptionsJsonList[matchOptionsIndex].AsString()); } + m_matchOptionsHasBeenSet = true; + } + if (jsonValue.ValueExists("values")) { + Aws::Utils::Array valuesJsonList = jsonValue.GetArray("values"); + for (unsigned valuesIndex = 0; valuesIndex < valuesJsonList.GetLength(); ++valuesIndex) { + m_values.push_back(valuesJsonList[valuesIndex].AsString()); + } + m_valuesHasBeenSet = true; } - return *this; } -void ExpressionFilter::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_keyHasBeenSet) { - mapSize++; - } - if (m_matchOptionsHasBeenSet) { - mapSize++; - } - if (m_valuesHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); +JsonValue ExpressionFilter::Jsonize() const { + JsonValue payload; if (m_keyHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("key")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_key.c_str())); + payload.WithString("key", m_key); } if (m_matchOptionsHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("matchOptions")); - encoder.WriteArrayStart(m_matchOptions.size()); - for (const auto& item_0 : m_matchOptions) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString(item_0.c_str())); + Aws::Utils::Array matchOptionsJsonList(m_matchOptions.size()); + for (unsigned matchOptionsIndex = 0; matchOptionsIndex < matchOptionsJsonList.GetLength(); ++matchOptionsIndex) { + matchOptionsJsonList[matchOptionsIndex].AsString(m_matchOptions[matchOptionsIndex]); } + payload.WithArray("matchOptions", std::move(matchOptionsJsonList)); } if (m_valuesHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("values")); - encoder.WriteArrayStart(m_values.size()); - for (const auto& item_0 : m_values) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString(item_0.c_str())); + Aws::Utils::Array valuesJsonList(m_values.size()); + for (unsigned valuesIndex = 0; valuesIndex < valuesJsonList.GetLength(); ++valuesIndex) { + valuesJsonList[valuesIndex].AsString(m_values[valuesIndex]); } + payload.WithArray("values", std::move(valuesJsonList)); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/FilterTimestamp.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/FilterTimestamp.cpp index 00f5c6698dc0..c1e45d83f809 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/FilterTimestamp.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/FilterTimestamp.cpp @@ -4,185 +4,45 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -FilterTimestamp::FilterTimestamp(const std::shared_ptr& decoder) { *this = decoder; } +FilterTimestamp::FilterTimestamp(JsonView jsonValue) { *this = jsonValue; } -FilterTimestamp& FilterTimestamp::operator=(const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "afterTimestamp") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_afterTimestamp = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_afterTimestamp = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_afterTimestampHasBeenSet = true; - } - - else if (initialKeyStr == "beforeTimestamp") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_beforeTimestamp = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_beforeTimestamp = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_beforeTimestampHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("FilterTimestamp", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "afterTimestamp") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_afterTimestamp = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_afterTimestamp = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_afterTimestampHasBeenSet = true; - } - - else if (initialKeyStr == "beforeTimestamp") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_beforeTimestamp = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_beforeTimestamp = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_beforeTimestampHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } +FilterTimestamp& FilterTimestamp::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("afterTimestamp")) { + m_afterTimestamp = jsonValue.GetDouble("afterTimestamp"); + m_afterTimestampHasBeenSet = true; + } + if (jsonValue.ValueExists("beforeTimestamp")) { + m_beforeTimestamp = jsonValue.GetDouble("beforeTimestamp"); + m_beforeTimestampHasBeenSet = true; } - return *this; } -void FilterTimestamp::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_afterTimestampHasBeenSet) { - mapSize++; - } - if (m_beforeTimestampHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); +JsonValue FilterTimestamp::Jsonize() const { + JsonValue payload; if (m_afterTimestampHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("afterTimestamp")); - encoder.WriteTag(1); // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - encoder.WriteUInt(m_afterTimestamp.Seconds()); + payload.WithDouble("afterTimestamp", m_afterTimestamp.SecondsWithMSPrecision()); } if (m_beforeTimestampHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("beforeTimestamp")); - encoder.WriteTag(1); // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - encoder.WriteUInt(m_beforeTimestamp.Seconds()); + payload.WithDouble("beforeTimestamp", m_beforeTimestamp.SecondsWithMSPrecision()); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/GetBillEstimateRequest.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/GetBillEstimateRequest.cpp index 184c77968086..658022666ce4 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/GetBillEstimateRequest.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/GetBillEstimateRequest.cpp @@ -4,37 +4,26 @@ */ #include -#include +#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; Aws::String GetBillEstimateRequest::SerializePayload() const { - Aws::Crt::Cbor::CborEncoder encoder; + JsonValue payload; - // Calculate map size - size_t mapSize = 0; if (m_identifierHasBeenSet) { - mapSize++; + payload.WithString("identifier", m_identifier); } - encoder.WriteMapStart(mapSize); - - if (m_identifierHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("identifier")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_identifier.c_str())); - } - const auto str = Aws::String(reinterpret_cast(encoder.GetEncodedData().ptr), encoder.GetEncodedData().len); - return str; + return payload.View().WriteReadable(); } Aws::Http::HeaderValueCollection GetBillEstimateRequest::GetRequestSpecificHeaders() const { Aws::Http::HeaderValueCollection headers; - headers.emplace(Aws::Http::CONTENT_TYPE_HEADER, Aws::CBOR_CONTENT_TYPE); - headers.emplace(Aws::Http::SMITHY_PROTOCOL_HEADER, Aws::RPC_V2_CBOR); - headers.emplace(Aws::Http::ACCEPT_HEADER, Aws::CBOR_CONTENT_TYPE); + headers.insert(Aws::Http::HeaderValuePair("X-Amz-Target", "AWSBCMPricingCalculator.GetBillEstimate")); return headers; } diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/GetBillEstimateResult.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/GetBillEstimateResult.cpp index f97d8cebd761..753ecb071d3c 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/GetBillEstimateResult.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/GetBillEstimateResult.cpp @@ -7,507 +7,65 @@ #include #include #include -#include +#include #include -#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; -using namespace Aws::Utils::Cbor; using namespace Aws; -GetBillEstimateResult::GetBillEstimateResult(const Aws::AmazonWebServiceResult& result) { *this = result; } +GetBillEstimateResult::GetBillEstimateResult(const Aws::AmazonWebServiceResult& result) { *this = result; } -GetBillEstimateResult& GetBillEstimateResult::operator=(const Aws::AmazonWebServiceResult& result) { +GetBillEstimateResult& GetBillEstimateResult::operator=(const Aws::AmazonWebServiceResult& result) { m_HttpResponseCode = result.GetResponseCode(); - - const auto& cborValue = result.GetPayload(); - const auto decoder = cborValue.GetDecoder(); - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "name") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_name = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_name = ss.str(); - } - } - m_nameHasBeenSet = true; - } - - else if (initialKeyStr == "status") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_status = BillEstimateStatusMapper::GetBillEstimateStatusForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_statusHasBeenSet = true; - } - - else if (initialKeyStr == "failureMessage") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_failureMessage = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_failureMessage = ss.str(); - } - } - m_failureMessageHasBeenSet = true; - } - - else if (initialKeyStr == "billInterval") { - m_billInterval = BillInterval(decoder); - m_billIntervalHasBeenSet = true; - } - - else if (initialKeyStr == "costSummary") { - m_costSummary = BillEstimateCostSummary(decoder); - m_costSummaryHasBeenSet = true; - } - - else if (initialKeyStr == "createdAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_createdAtHasBeenSet = true; - } - - else if (initialKeyStr == "expiresAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_expiresAtHasBeenSet = true; - } - - else if (initialKeyStr == "groupSharingPreference") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_groupSharingPreference = GroupSharingPreferenceEnumMapper::GetGroupSharingPreferenceEnumForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_groupSharingPreferenceHasBeenSet = true; - } - - else if (initialKeyStr == "costCategoryGroupSharingPreferenceArn") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_costCategoryGroupSharingPreferenceArn = - Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_costCategoryGroupSharingPreferenceArn = ss.str(); - } - } - m_costCategoryGroupSharingPreferenceArnHasBeenSet = true; - } - - else if (initialKeyStr == "costCategoryGroupSharingPreferenceEffectiveDate") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_costCategoryGroupSharingPreferenceEffectiveDate = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_costCategoryGroupSharingPreferenceEffectiveDate = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_costCategoryGroupSharingPreferenceEffectiveDateHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("GetBillEstimateResult", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "name") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_name = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_name = ss.str(); - } - } - m_nameHasBeenSet = true; - } - - else if (initialKeyStr == "status") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_status = BillEstimateStatusMapper::GetBillEstimateStatusForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_statusHasBeenSet = true; - } - - else if (initialKeyStr == "failureMessage") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_failureMessage = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_failureMessage = ss.str(); - } - } - m_failureMessageHasBeenSet = true; - } - - else if (initialKeyStr == "billInterval") { - m_billInterval = BillInterval(decoder); - m_billIntervalHasBeenSet = true; - } - - else if (initialKeyStr == "costSummary") { - m_costSummary = BillEstimateCostSummary(decoder); - m_costSummaryHasBeenSet = true; - } - - else if (initialKeyStr == "createdAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_createdAtHasBeenSet = true; - } - - else if (initialKeyStr == "expiresAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_expiresAtHasBeenSet = true; - } - - else if (initialKeyStr == "groupSharingPreference") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_groupSharingPreference = GroupSharingPreferenceEnumMapper::GetGroupSharingPreferenceEnumForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_groupSharingPreferenceHasBeenSet = true; - } - - else if (initialKeyStr == "costCategoryGroupSharingPreferenceArn") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_costCategoryGroupSharingPreferenceArn = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_costCategoryGroupSharingPreferenceArn = ss.str(); - } - } - m_costCategoryGroupSharingPreferenceArnHasBeenSet = true; - } - - else if (initialKeyStr == "costCategoryGroupSharingPreferenceEffectiveDate") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_costCategoryGroupSharingPreferenceEffectiveDate = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_costCategoryGroupSharingPreferenceEffectiveDate = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_costCategoryGroupSharingPreferenceEffectiveDateHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } + JsonView jsonValue = result.GetPayload().View(); + if (jsonValue.ValueExists("id")) { + m_id = jsonValue.GetString("id"); + m_idHasBeenSet = true; + } + if (jsonValue.ValueExists("name")) { + m_name = jsonValue.GetString("name"); + m_nameHasBeenSet = true; + } + if (jsonValue.ValueExists("status")) { + m_status = BillEstimateStatusMapper::GetBillEstimateStatusForName(jsonValue.GetString("status")); + m_statusHasBeenSet = true; + } + if (jsonValue.ValueExists("failureMessage")) { + m_failureMessage = jsonValue.GetString("failureMessage"); + m_failureMessageHasBeenSet = true; + } + if (jsonValue.ValueExists("billInterval")) { + m_billInterval = jsonValue.GetObject("billInterval"); + m_billIntervalHasBeenSet = true; + } + if (jsonValue.ValueExists("costSummary")) { + m_costSummary = jsonValue.GetObject("costSummary"); + m_costSummaryHasBeenSet = true; + } + if (jsonValue.ValueExists("createdAt")) { + m_createdAt = jsonValue.GetDouble("createdAt"); + m_createdAtHasBeenSet = true; + } + if (jsonValue.ValueExists("expiresAt")) { + m_expiresAt = jsonValue.GetDouble("expiresAt"); + m_expiresAtHasBeenSet = true; + } + if (jsonValue.ValueExists("groupSharingPreference")) { + m_groupSharingPreference = + GroupSharingPreferenceEnumMapper::GetGroupSharingPreferenceEnumForName(jsonValue.GetString("groupSharingPreference")); + m_groupSharingPreferenceHasBeenSet = true; + } + if (jsonValue.ValueExists("costCategoryGroupSharingPreferenceArn")) { + m_costCategoryGroupSharingPreferenceArn = jsonValue.GetString("costCategoryGroupSharingPreferenceArn"); + m_costCategoryGroupSharingPreferenceArnHasBeenSet = true; + } + if (jsonValue.ValueExists("costCategoryGroupSharingPreferenceEffectiveDate")) { + m_costCategoryGroupSharingPreferenceEffectiveDate = jsonValue.GetDouble("costCategoryGroupSharingPreferenceEffectiveDate"); + m_costCategoryGroupSharingPreferenceEffectiveDateHasBeenSet = true; } const auto& headers = result.GetHeaderValueCollection(); diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/GetBillScenarioRequest.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/GetBillScenarioRequest.cpp index a5a436809346..5882c47c004a 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/GetBillScenarioRequest.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/GetBillScenarioRequest.cpp @@ -4,37 +4,26 @@ */ #include -#include +#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; Aws::String GetBillScenarioRequest::SerializePayload() const { - Aws::Crt::Cbor::CborEncoder encoder; + JsonValue payload; - // Calculate map size - size_t mapSize = 0; if (m_identifierHasBeenSet) { - mapSize++; + payload.WithString("identifier", m_identifier); } - encoder.WriteMapStart(mapSize); - - if (m_identifierHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("identifier")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_identifier.c_str())); - } - const auto str = Aws::String(reinterpret_cast(encoder.GetEncodedData().ptr), encoder.GetEncodedData().len); - return str; + return payload.View().WriteReadable(); } Aws::Http::HeaderValueCollection GetBillScenarioRequest::GetRequestSpecificHeaders() const { Aws::Http::HeaderValueCollection headers; - headers.emplace(Aws::Http::CONTENT_TYPE_HEADER, Aws::CBOR_CONTENT_TYPE); - headers.emplace(Aws::Http::SMITHY_PROTOCOL_HEADER, Aws::RPC_V2_CBOR); - headers.emplace(Aws::Http::ACCEPT_HEADER, Aws::CBOR_CONTENT_TYPE); + headers.insert(Aws::Http::HeaderValuePair("X-Amz-Target", "AWSBCMPricingCalculator.GetBillScenario")); return headers; } diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/GetBillScenarioResult.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/GetBillScenarioResult.cpp index 587dc9053cf3..6e783fea8be3 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/GetBillScenarioResult.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/GetBillScenarioResult.cpp @@ -7,451 +7,57 @@ #include #include #include -#include +#include #include -#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; -using namespace Aws::Utils::Cbor; using namespace Aws; -GetBillScenarioResult::GetBillScenarioResult(const Aws::AmazonWebServiceResult& result) { *this = result; } +GetBillScenarioResult::GetBillScenarioResult(const Aws::AmazonWebServiceResult& result) { *this = result; } -GetBillScenarioResult& GetBillScenarioResult::operator=(const Aws::AmazonWebServiceResult& result) { +GetBillScenarioResult& GetBillScenarioResult::operator=(const Aws::AmazonWebServiceResult& result) { m_HttpResponseCode = result.GetResponseCode(); - - const auto& cborValue = result.GetPayload(); - const auto decoder = cborValue.GetDecoder(); - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "name") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_name = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_name = ss.str(); - } - } - m_nameHasBeenSet = true; - } - - else if (initialKeyStr == "billInterval") { - m_billInterval = BillInterval(decoder); - m_billIntervalHasBeenSet = true; - } - - else if (initialKeyStr == "status") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_status = BillScenarioStatusMapper::GetBillScenarioStatusForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_statusHasBeenSet = true; - } - - else if (initialKeyStr == "createdAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_createdAtHasBeenSet = true; - } - - else if (initialKeyStr == "expiresAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_expiresAtHasBeenSet = true; - } - - else if (initialKeyStr == "failureMessage") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_failureMessage = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_failureMessage = ss.str(); - } - } - m_failureMessageHasBeenSet = true; - } - - else if (initialKeyStr == "groupSharingPreference") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_groupSharingPreference = GroupSharingPreferenceEnumMapper::GetGroupSharingPreferenceEnumForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_groupSharingPreferenceHasBeenSet = true; - } - - else if (initialKeyStr == "costCategoryGroupSharingPreferenceArn") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_costCategoryGroupSharingPreferenceArn = - Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_costCategoryGroupSharingPreferenceArn = ss.str(); - } - } - m_costCategoryGroupSharingPreferenceArnHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("GetBillScenarioResult", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "name") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_name = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_name = ss.str(); - } - } - m_nameHasBeenSet = true; - } - - else if (initialKeyStr == "billInterval") { - m_billInterval = BillInterval(decoder); - m_billIntervalHasBeenSet = true; - } - - else if (initialKeyStr == "status") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_status = BillScenarioStatusMapper::GetBillScenarioStatusForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_statusHasBeenSet = true; - } - - else if (initialKeyStr == "createdAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_createdAtHasBeenSet = true; - } - - else if (initialKeyStr == "expiresAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_expiresAtHasBeenSet = true; - } - - else if (initialKeyStr == "failureMessage") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_failureMessage = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_failureMessage = ss.str(); - } - } - m_failureMessageHasBeenSet = true; - } - - else if (initialKeyStr == "groupSharingPreference") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_groupSharingPreference = GroupSharingPreferenceEnumMapper::GetGroupSharingPreferenceEnumForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_groupSharingPreferenceHasBeenSet = true; - } - - else if (initialKeyStr == "costCategoryGroupSharingPreferenceArn") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_costCategoryGroupSharingPreferenceArn = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_costCategoryGroupSharingPreferenceArn = ss.str(); - } - } - m_costCategoryGroupSharingPreferenceArnHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } + JsonView jsonValue = result.GetPayload().View(); + if (jsonValue.ValueExists("id")) { + m_id = jsonValue.GetString("id"); + m_idHasBeenSet = true; + } + if (jsonValue.ValueExists("name")) { + m_name = jsonValue.GetString("name"); + m_nameHasBeenSet = true; + } + if (jsonValue.ValueExists("billInterval")) { + m_billInterval = jsonValue.GetObject("billInterval"); + m_billIntervalHasBeenSet = true; + } + if (jsonValue.ValueExists("status")) { + m_status = BillScenarioStatusMapper::GetBillScenarioStatusForName(jsonValue.GetString("status")); + m_statusHasBeenSet = true; + } + if (jsonValue.ValueExists("createdAt")) { + m_createdAt = jsonValue.GetDouble("createdAt"); + m_createdAtHasBeenSet = true; + } + if (jsonValue.ValueExists("expiresAt")) { + m_expiresAt = jsonValue.GetDouble("expiresAt"); + m_expiresAtHasBeenSet = true; + } + if (jsonValue.ValueExists("failureMessage")) { + m_failureMessage = jsonValue.GetString("failureMessage"); + m_failureMessageHasBeenSet = true; + } + if (jsonValue.ValueExists("groupSharingPreference")) { + m_groupSharingPreference = + GroupSharingPreferenceEnumMapper::GetGroupSharingPreferenceEnumForName(jsonValue.GetString("groupSharingPreference")); + m_groupSharingPreferenceHasBeenSet = true; + } + if (jsonValue.ValueExists("costCategoryGroupSharingPreferenceArn")) { + m_costCategoryGroupSharingPreferenceArn = jsonValue.GetString("costCategoryGroupSharingPreferenceArn"); + m_costCategoryGroupSharingPreferenceArnHasBeenSet = true; } const auto& headers = result.GetHeaderValueCollection(); diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/GetPreferencesRequest.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/GetPreferencesRequest.cpp index 9a2029cd155f..b1f1fc49dd53 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/GetPreferencesRequest.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/GetPreferencesRequest.cpp @@ -4,30 +4,18 @@ */ #include -#include +#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; -Aws::String GetPreferencesRequest::SerializePayload() const { - Aws::Crt::Cbor::CborEncoder encoder; - - // Calculate map size - size_t mapSize = 0; - - encoder.WriteMapStart(mapSize); - - const auto str = Aws::String(reinterpret_cast(encoder.GetEncodedData().ptr), encoder.GetEncodedData().len); - return str; -} +Aws::String GetPreferencesRequest::SerializePayload() const { return "{}"; } Aws::Http::HeaderValueCollection GetPreferencesRequest::GetRequestSpecificHeaders() const { Aws::Http::HeaderValueCollection headers; - headers.emplace(Aws::Http::CONTENT_TYPE_HEADER, Aws::CBOR_CONTENT_TYPE); - headers.emplace(Aws::Http::SMITHY_PROTOCOL_HEADER, Aws::RPC_V2_CBOR); - headers.emplace(Aws::Http::ACCEPT_HEADER, Aws::CBOR_CONTENT_TYPE); + headers.insert(Aws::Http::HeaderValuePair("X-Amz-Target", "AWSBCMPricingCalculator.GetPreferences")); return headers; } diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/GetPreferencesResult.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/GetPreferencesResult.cpp index edac6f5b1cac..8f915bb6cb33 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/GetPreferencesResult.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/GetPreferencesResult.cpp @@ -7,294 +7,50 @@ #include #include #include -#include +#include #include -#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; -using namespace Aws::Utils::Cbor; using namespace Aws; -GetPreferencesResult::GetPreferencesResult(const Aws::AmazonWebServiceResult& result) { *this = result; } +GetPreferencesResult::GetPreferencesResult(const Aws::AmazonWebServiceResult& result) { *this = result; } -GetPreferencesResult& GetPreferencesResult::operator=(const Aws::AmazonWebServiceResult& result) { +GetPreferencesResult& GetPreferencesResult::operator=(const Aws::AmazonWebServiceResult& result) { m_HttpResponseCode = result.GetResponseCode(); - - const auto& cborValue = result.GetPayload(); - const auto decoder = cborValue.GetDecoder(); - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "managementAccountRateTypeSelections") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_managementAccountRateTypeSelections.push_back(RateTypeMapper::GetRateTypeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len))); - } - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_managementAccountRateTypeSelections.push_back(RateTypeMapper::GetRateTypeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len))); - } - } - } - } - m_managementAccountRateTypeSelectionsHasBeenSet = true; - } - - else if (initialKeyStr == "memberAccountRateTypeSelections") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_memberAccountRateTypeSelections.push_back(RateTypeMapper::GetRateTypeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len))); - } - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_memberAccountRateTypeSelections.push_back(RateTypeMapper::GetRateTypeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len))); - } - } - } - } - m_memberAccountRateTypeSelectionsHasBeenSet = true; - } - - else if (initialKeyStr == "standaloneAccountRateTypeSelections") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_standaloneAccountRateTypeSelections.push_back(RateTypeMapper::GetRateTypeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len))); - } - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_standaloneAccountRateTypeSelections.push_back(RateTypeMapper::GetRateTypeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len))); - } - } - } - } - m_standaloneAccountRateTypeSelectionsHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("GetPreferencesResult", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "managementAccountRateTypeSelections") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_managementAccountRateTypeSelections.push_back(RateTypeMapper::GetRateTypeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len))); - } - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_managementAccountRateTypeSelections.push_back( - RateTypeMapper::GetRateTypeForName(Aws::String(reinterpret_cast(val.value().ptr), val.value().len))); - } - } - } - } - m_managementAccountRateTypeSelectionsHasBeenSet = true; - } - - else if (initialKeyStr == "memberAccountRateTypeSelections") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_memberAccountRateTypeSelections.push_back(RateTypeMapper::GetRateTypeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len))); - } - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_memberAccountRateTypeSelections.push_back( - RateTypeMapper::GetRateTypeForName(Aws::String(reinterpret_cast(val.value().ptr), val.value().len))); - } - } - } - } - m_memberAccountRateTypeSelectionsHasBeenSet = true; - } - - else if (initialKeyStr == "standaloneAccountRateTypeSelections") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_standaloneAccountRateTypeSelections.push_back(RateTypeMapper::GetRateTypeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len))); - } - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_standaloneAccountRateTypeSelections.push_back( - RateTypeMapper::GetRateTypeForName(Aws::String(reinterpret_cast(val.value().ptr), val.value().len))); - } - } - } - } - m_standaloneAccountRateTypeSelectionsHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } + JsonView jsonValue = result.GetPayload().View(); + if (jsonValue.ValueExists("managementAccountRateTypeSelections")) { + Aws::Utils::Array managementAccountRateTypeSelectionsJsonList = jsonValue.GetArray("managementAccountRateTypeSelections"); + for (unsigned managementAccountRateTypeSelectionsIndex = 0; + managementAccountRateTypeSelectionsIndex < managementAccountRateTypeSelectionsJsonList.GetLength(); + ++managementAccountRateTypeSelectionsIndex) { + m_managementAccountRateTypeSelections.push_back(RateTypeMapper::GetRateTypeForName( + managementAccountRateTypeSelectionsJsonList[managementAccountRateTypeSelectionsIndex].AsString())); + } + m_managementAccountRateTypeSelectionsHasBeenSet = true; + } + if (jsonValue.ValueExists("memberAccountRateTypeSelections")) { + Aws::Utils::Array memberAccountRateTypeSelectionsJsonList = jsonValue.GetArray("memberAccountRateTypeSelections"); + for (unsigned memberAccountRateTypeSelectionsIndex = 0; + memberAccountRateTypeSelectionsIndex < memberAccountRateTypeSelectionsJsonList.GetLength(); + ++memberAccountRateTypeSelectionsIndex) { + m_memberAccountRateTypeSelections.push_back( + RateTypeMapper::GetRateTypeForName(memberAccountRateTypeSelectionsJsonList[memberAccountRateTypeSelectionsIndex].AsString())); + } + m_memberAccountRateTypeSelectionsHasBeenSet = true; + } + if (jsonValue.ValueExists("standaloneAccountRateTypeSelections")) { + Aws::Utils::Array standaloneAccountRateTypeSelectionsJsonList = jsonValue.GetArray("standaloneAccountRateTypeSelections"); + for (unsigned standaloneAccountRateTypeSelectionsIndex = 0; + standaloneAccountRateTypeSelectionsIndex < standaloneAccountRateTypeSelectionsJsonList.GetLength(); + ++standaloneAccountRateTypeSelectionsIndex) { + m_standaloneAccountRateTypeSelections.push_back(RateTypeMapper::GetRateTypeForName( + standaloneAccountRateTypeSelectionsJsonList[standaloneAccountRateTypeSelectionsIndex].AsString())); } + m_standaloneAccountRateTypeSelectionsHasBeenSet = true; } const auto& headers = result.GetHeaderValueCollection(); diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/GetWorkloadEstimateRequest.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/GetWorkloadEstimateRequest.cpp index f56aab97feeb..3c3efee11d38 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/GetWorkloadEstimateRequest.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/GetWorkloadEstimateRequest.cpp @@ -4,37 +4,26 @@ */ #include -#include +#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; Aws::String GetWorkloadEstimateRequest::SerializePayload() const { - Aws::Crt::Cbor::CborEncoder encoder; + JsonValue payload; - // Calculate map size - size_t mapSize = 0; if (m_identifierHasBeenSet) { - mapSize++; + payload.WithString("identifier", m_identifier); } - encoder.WriteMapStart(mapSize); - - if (m_identifierHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("identifier")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_identifier.c_str())); - } - const auto str = Aws::String(reinterpret_cast(encoder.GetEncodedData().ptr), encoder.GetEncodedData().len); - return str; + return payload.View().WriteReadable(); } Aws::Http::HeaderValueCollection GetWorkloadEstimateRequest::GetRequestSpecificHeaders() const { Aws::Http::HeaderValueCollection headers; - headers.emplace(Aws::Http::CONTENT_TYPE_HEADER, Aws::CBOR_CONTENT_TYPE); - headers.emplace(Aws::Http::SMITHY_PROTOCOL_HEADER, Aws::RPC_V2_CBOR); - headers.emplace(Aws::Http::ACCEPT_HEADER, Aws::CBOR_CONTENT_TYPE); + headers.insert(Aws::Http::HeaderValuePair("X-Amz-Target", "AWSBCMPricingCalculator.GetWorkloadEstimate")); return headers; } diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/GetWorkloadEstimateResult.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/GetWorkloadEstimateResult.cpp index 3deee3beb573..50edc0433658 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/GetWorkloadEstimateResult.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/GetWorkloadEstimateResult.cpp @@ -7,462 +7,60 @@ #include #include #include -#include +#include #include -#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; -using namespace Aws::Utils::Cbor; using namespace Aws; -GetWorkloadEstimateResult::GetWorkloadEstimateResult(const Aws::AmazonWebServiceResult& result) { - *this = result; -} +GetWorkloadEstimateResult::GetWorkloadEstimateResult(const Aws::AmazonWebServiceResult& result) { *this = result; } -GetWorkloadEstimateResult& GetWorkloadEstimateResult::operator=(const Aws::AmazonWebServiceResult& result) { +GetWorkloadEstimateResult& GetWorkloadEstimateResult::operator=(const Aws::AmazonWebServiceResult& result) { m_HttpResponseCode = result.GetResponseCode(); - - const auto& cborValue = result.GetPayload(); - const auto decoder = cborValue.GetDecoder(); - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "name") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_name = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_name = ss.str(); - } - } - m_nameHasBeenSet = true; - } - - else if (initialKeyStr == "createdAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_createdAtHasBeenSet = true; - } - - else if (initialKeyStr == "expiresAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_expiresAtHasBeenSet = true; - } - - else if (initialKeyStr == "rateType") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_rateType = WorkloadEstimateRateTypeMapper::GetWorkloadEstimateRateTypeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_rateTypeHasBeenSet = true; - } - - else if (initialKeyStr == "rateTimestamp") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_rateTimestamp = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_rateTimestamp = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_rateTimestampHasBeenSet = true; - } - - else if (initialKeyStr == "status") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_status = WorkloadEstimateStatusMapper::GetWorkloadEstimateStatusForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_statusHasBeenSet = true; - } - - else if (initialKeyStr == "totalCost") { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_totalCost = val.value(); - } - m_totalCostHasBeenSet = true; - } - - else if (initialKeyStr == "costCurrency") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_costCurrency = CurrencyCodeMapper::GetCurrencyCodeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_costCurrencyHasBeenSet = true; - } - - else if (initialKeyStr == "failureMessage") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_failureMessage = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_failureMessage = ss.str(); - } - } - m_failureMessageHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("GetWorkloadEstimateResult", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "name") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_name = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_name = ss.str(); - } - } - m_nameHasBeenSet = true; - } - - else if (initialKeyStr == "createdAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_createdAtHasBeenSet = true; - } - - else if (initialKeyStr == "expiresAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_expiresAtHasBeenSet = true; - } - - else if (initialKeyStr == "rateType") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_rateType = WorkloadEstimateRateTypeMapper::GetWorkloadEstimateRateTypeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_rateTypeHasBeenSet = true; - } - - else if (initialKeyStr == "rateTimestamp") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_rateTimestamp = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_rateTimestamp = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_rateTimestampHasBeenSet = true; - } - - else if (initialKeyStr == "status") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_status = WorkloadEstimateStatusMapper::GetWorkloadEstimateStatusForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_statusHasBeenSet = true; - } - - else if (initialKeyStr == "totalCost") { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_totalCost = val.value(); - } - m_totalCostHasBeenSet = true; - } - - else if (initialKeyStr == "costCurrency") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_costCurrency = CurrencyCodeMapper::GetCurrencyCodeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_costCurrencyHasBeenSet = true; - } - - else if (initialKeyStr == "failureMessage") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_failureMessage = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_failureMessage = ss.str(); - } - } - m_failureMessageHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } + JsonView jsonValue = result.GetPayload().View(); + if (jsonValue.ValueExists("id")) { + m_id = jsonValue.GetString("id"); + m_idHasBeenSet = true; + } + if (jsonValue.ValueExists("name")) { + m_name = jsonValue.GetString("name"); + m_nameHasBeenSet = true; + } + if (jsonValue.ValueExists("createdAt")) { + m_createdAt = jsonValue.GetDouble("createdAt"); + m_createdAtHasBeenSet = true; + } + if (jsonValue.ValueExists("expiresAt")) { + m_expiresAt = jsonValue.GetDouble("expiresAt"); + m_expiresAtHasBeenSet = true; + } + if (jsonValue.ValueExists("rateType")) { + m_rateType = WorkloadEstimateRateTypeMapper::GetWorkloadEstimateRateTypeForName(jsonValue.GetString("rateType")); + m_rateTypeHasBeenSet = true; + } + if (jsonValue.ValueExists("rateTimestamp")) { + m_rateTimestamp = jsonValue.GetDouble("rateTimestamp"); + m_rateTimestampHasBeenSet = true; + } + if (jsonValue.ValueExists("status")) { + m_status = WorkloadEstimateStatusMapper::GetWorkloadEstimateStatusForName(jsonValue.GetString("status")); + m_statusHasBeenSet = true; + } + if (jsonValue.ValueExists("totalCost")) { + m_totalCost = jsonValue.GetDouble("totalCost"); + m_totalCostHasBeenSet = true; + } + if (jsonValue.ValueExists("costCurrency")) { + m_costCurrency = CurrencyCodeMapper::GetCurrencyCodeForName(jsonValue.GetString("costCurrency")); + m_costCurrencyHasBeenSet = true; + } + if (jsonValue.ValueExists("failureMessage")) { + m_failureMessage = jsonValue.GetString("failureMessage"); + m_failureMessageHasBeenSet = true; } const auto& headers = result.GetHeaderValueCollection(); diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/HistoricalUsageEntity.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/HistoricalUsageEntity.cpp index 3ca209b2f2bf..287b56e955a2 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/HistoricalUsageEntity.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/HistoricalUsageEntity.cpp @@ -4,451 +4,85 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -HistoricalUsageEntity::HistoricalUsageEntity(const std::shared_ptr& decoder) { *this = decoder; } +HistoricalUsageEntity::HistoricalUsageEntity(JsonView jsonValue) { *this = jsonValue; } -HistoricalUsageEntity& HistoricalUsageEntity::operator=(const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "serviceCode") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_serviceCode = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_serviceCode = ss.str(); - } - } - m_serviceCodeHasBeenSet = true; - } - - else if (initialKeyStr == "usageType") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageType = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageType = ss.str(); - } - } - m_usageTypeHasBeenSet = true; - } - - else if (initialKeyStr == "operation") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_operation = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_operation = ss.str(); - } - } - m_operationHasBeenSet = true; - } - - else if (initialKeyStr == "location") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_location = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_location = ss.str(); - } - } - m_locationHasBeenSet = true; - } - - else if (initialKeyStr == "usageAccountId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageAccountId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageAccountId = ss.str(); - } - } - m_usageAccountIdHasBeenSet = true; - } - - else if (initialKeyStr == "billInterval") { - m_billInterval = BillInterval(decoder); - m_billIntervalHasBeenSet = true; - } - - else if (initialKeyStr == "filterExpression") { - m_filterExpression = Expression(decoder); - m_filterExpressionHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("HistoricalUsageEntity", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "serviceCode") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_serviceCode = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_serviceCode = ss.str(); - } - } - m_serviceCodeHasBeenSet = true; - } - - else if (initialKeyStr == "usageType") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageType = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageType = ss.str(); - } - } - m_usageTypeHasBeenSet = true; - } - - else if (initialKeyStr == "operation") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_operation = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_operation = ss.str(); - } - } - m_operationHasBeenSet = true; - } - - else if (initialKeyStr == "location") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_location = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_location = ss.str(); - } - } - m_locationHasBeenSet = true; - } - - else if (initialKeyStr == "usageAccountId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageAccountId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageAccountId = ss.str(); - } - } - m_usageAccountIdHasBeenSet = true; - } - - else if (initialKeyStr == "billInterval") { - m_billInterval = BillInterval(decoder); - m_billIntervalHasBeenSet = true; - } - - else if (initialKeyStr == "filterExpression") { - m_filterExpression = Expression(decoder); - m_filterExpressionHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } +HistoricalUsageEntity& HistoricalUsageEntity::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("serviceCode")) { + m_serviceCode = jsonValue.GetString("serviceCode"); + m_serviceCodeHasBeenSet = true; } - - return *this; -} - -void HistoricalUsageEntity::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_serviceCodeHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("usageType")) { + m_usageType = jsonValue.GetString("usageType"); + m_usageTypeHasBeenSet = true; } - if (m_usageTypeHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("operation")) { + m_operation = jsonValue.GetString("operation"); + m_operationHasBeenSet = true; } - if (m_operationHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("location")) { + m_location = jsonValue.GetString("location"); + m_locationHasBeenSet = true; } - if (m_locationHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("usageAccountId")) { + m_usageAccountId = jsonValue.GetString("usageAccountId"); + m_usageAccountIdHasBeenSet = true; } - if (m_usageAccountIdHasBeenSet) { - mapSize++; - } - if (m_billIntervalHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("billInterval")) { + m_billInterval = jsonValue.GetObject("billInterval"); + m_billIntervalHasBeenSet = true; } - if (m_filterExpressionHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("filterExpression")) { + m_filterExpression = jsonValue.GetObject("filterExpression"); + m_filterExpressionHasBeenSet = true; } + return *this; +} - encoder.WriteMapStart(mapSize); +JsonValue HistoricalUsageEntity::Jsonize() const { + JsonValue payload; if (m_serviceCodeHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("serviceCode")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_serviceCode.c_str())); + payload.WithString("serviceCode", m_serviceCode); } if (m_usageTypeHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("usageType")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_usageType.c_str())); + payload.WithString("usageType", m_usageType); } if (m_operationHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("operation")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_operation.c_str())); + payload.WithString("operation", m_operation); } if (m_locationHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("location")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_location.c_str())); + payload.WithString("location", m_location); } if (m_usageAccountIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("usageAccountId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_usageAccountId.c_str())); + payload.WithString("usageAccountId", m_usageAccountId); } if (m_billIntervalHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("billInterval")); - m_billInterval.CborEncode(encoder); + payload.WithObject("billInterval", m_billInterval.Jsonize()); } if (m_filterExpressionHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("filterExpression")); - m_filterExpression.CborEncode(encoder); + payload.WithObject("filterExpression", m_filterExpression.Jsonize()); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/InternalServerException.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/InternalServerException.cpp index b1ff2c94f476..192f44ead58e 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/InternalServerException.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/InternalServerException.cpp @@ -4,187 +4,45 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -InternalServerException::InternalServerException(const std::shared_ptr& decoder) { *this = decoder; } +InternalServerException::InternalServerException(JsonView jsonValue) { *this = jsonValue; } -InternalServerException& InternalServerException::operator=(const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "message") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_message = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_message = ss.str(); - } - } - m_messageHasBeenSet = true; - } - - else if (initialKeyStr == "retryAfterSeconds") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::UInt) { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_retryAfterSeconds = static_cast(val.value()); - } - } else { - auto val = decoder->PopNextNegativeIntVal(); - if (val.has_value()) { - m_retryAfterSeconds = static_cast(1 - val.value()); - } - } - } - m_retryAfterSecondsHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("InternalServerException", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "message") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_message = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_message = ss.str(); - } - } - m_messageHasBeenSet = true; - } - - else if (initialKeyStr == "retryAfterSeconds") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::UInt) { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_retryAfterSeconds = static_cast(val.value()); - } - } else { - auto val = decoder->PopNextNegativeIntVal(); - if (val.has_value()) { - m_retryAfterSeconds = static_cast(1 - val.value()); - } - } - } - m_retryAfterSecondsHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } +InternalServerException& InternalServerException::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("message")) { + m_message = jsonValue.GetString("message"); + m_messageHasBeenSet = true; + } + if (jsonValue.ValueExists("retryAfterSeconds")) { + m_retryAfterSeconds = jsonValue.GetInteger("retryAfterSeconds"); + m_retryAfterSecondsHasBeenSet = true; } - return *this; } -void InternalServerException::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_messageHasBeenSet) { - mapSize++; - } - if (m_retryAfterSecondsHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); +JsonValue InternalServerException::Jsonize() const { + JsonValue payload; if (m_messageHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("message")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_message.c_str())); + payload.WithString("message", m_message); } if (m_retryAfterSecondsHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("retryAfterSeconds")); - (m_retryAfterSeconds >= 0) ? encoder.WriteUInt(m_retryAfterSeconds) : encoder.WriteNegInt(m_retryAfterSeconds); + payload.WithInteger("retryAfterSeconds", m_retryAfterSeconds); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimateCommitmentsRequest.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimateCommitmentsRequest.cpp index 33610bd26582..d6283fa8db51 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimateCommitmentsRequest.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimateCommitmentsRequest.cpp @@ -4,53 +4,34 @@ */ #include -#include +#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; Aws::String ListBillEstimateCommitmentsRequest::SerializePayload() const { - Aws::Crt::Cbor::CborEncoder encoder; + JsonValue payload; - // Calculate map size - size_t mapSize = 0; if (m_billEstimateIdHasBeenSet) { - mapSize++; - } - if (m_nextTokenHasBeenSet) { - mapSize++; - } - if (m_maxResultsHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); - - if (m_billEstimateIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("billEstimateId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_billEstimateId.c_str())); + payload.WithString("billEstimateId", m_billEstimateId); } if (m_nextTokenHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("nextToken")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_nextToken.c_str())); + payload.WithString("nextToken", m_nextToken); } if (m_maxResultsHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("maxResults")); - (m_maxResults >= 0) ? encoder.WriteUInt(m_maxResults) : encoder.WriteNegInt(m_maxResults); + payload.WithInteger("maxResults", m_maxResults); } - const auto str = Aws::String(reinterpret_cast(encoder.GetEncodedData().ptr), encoder.GetEncodedData().len); - return str; + + return payload.View().WriteReadable(); } Aws::Http::HeaderValueCollection ListBillEstimateCommitmentsRequest::GetRequestSpecificHeaders() const { Aws::Http::HeaderValueCollection headers; - headers.emplace(Aws::Http::CONTENT_TYPE_HEADER, Aws::CBOR_CONTENT_TYPE); - headers.emplace(Aws::Http::SMITHY_PROTOCOL_HEADER, Aws::RPC_V2_CBOR); - headers.emplace(Aws::Http::ACCEPT_HEADER, Aws::CBOR_CONTENT_TYPE); + headers.insert(Aws::Http::HeaderValuePair("X-Amz-Target", "AWSBCMPricingCalculator.ListBillEstimateCommitments")); return headers; } diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimateCommitmentsResult.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimateCommitmentsResult.cpp index 275a8b0d0e67..474907ffddbe 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimateCommitmentsResult.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimateCommitmentsResult.cpp @@ -7,194 +7,33 @@ #include #include #include -#include +#include #include -#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; -using namespace Aws::Utils::Cbor; using namespace Aws; -ListBillEstimateCommitmentsResult::ListBillEstimateCommitmentsResult( - const Aws::AmazonWebServiceResult& result) { +ListBillEstimateCommitmentsResult::ListBillEstimateCommitmentsResult(const Aws::AmazonWebServiceResult& result) { *this = result; } -ListBillEstimateCommitmentsResult& ListBillEstimateCommitmentsResult::operator=( - const Aws::AmazonWebServiceResult& result) { +ListBillEstimateCommitmentsResult& ListBillEstimateCommitmentsResult::operator=(const Aws::AmazonWebServiceResult& result) { m_HttpResponseCode = result.GetResponseCode(); - - const auto& cborValue = result.GetPayload(); - const auto decoder = cborValue.GetDecoder(); - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "items") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_items.push_back(BillEstimateCommitmentSummary(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_items.push_back(BillEstimateCommitmentSummary(decoder)); - } - } - } - m_itemsHasBeenSet = true; - } - - else if (initialKeyStr == "nextToken") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_nextToken = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_nextToken = ss.str(); - } - } - m_nextTokenHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("ListBillEstimateCommitmentsResult", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "items") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_items.push_back(BillEstimateCommitmentSummary(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_items.push_back(BillEstimateCommitmentSummary(decoder)); - } - } - } - m_itemsHasBeenSet = true; - } - - else if (initialKeyStr == "nextToken") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_nextToken = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_nextToken = ss.str(); - } - } - m_nextTokenHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } + JsonView jsonValue = result.GetPayload().View(); + if (jsonValue.ValueExists("items")) { + Aws::Utils::Array itemsJsonList = jsonValue.GetArray("items"); + for (unsigned itemsIndex = 0; itemsIndex < itemsJsonList.GetLength(); ++itemsIndex) { + m_items.push_back(itemsJsonList[itemsIndex].AsObject()); } + m_itemsHasBeenSet = true; + } + if (jsonValue.ValueExists("nextToken")) { + m_nextToken = jsonValue.GetString("nextToken"); + m_nextTokenHasBeenSet = true; } const auto& headers = result.GetHeaderValueCollection(); diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimateInputCommitmentModificationsRequest.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimateInputCommitmentModificationsRequest.cpp index 0ace0cbb3763..de173163f785 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimateInputCommitmentModificationsRequest.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimateInputCommitmentModificationsRequest.cpp @@ -4,53 +4,34 @@ */ #include -#include +#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; Aws::String ListBillEstimateInputCommitmentModificationsRequest::SerializePayload() const { - Aws::Crt::Cbor::CborEncoder encoder; + JsonValue payload; - // Calculate map size - size_t mapSize = 0; if (m_billEstimateIdHasBeenSet) { - mapSize++; - } - if (m_nextTokenHasBeenSet) { - mapSize++; - } - if (m_maxResultsHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); - - if (m_billEstimateIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("billEstimateId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_billEstimateId.c_str())); + payload.WithString("billEstimateId", m_billEstimateId); } if (m_nextTokenHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("nextToken")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_nextToken.c_str())); + payload.WithString("nextToken", m_nextToken); } if (m_maxResultsHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("maxResults")); - (m_maxResults >= 0) ? encoder.WriteUInt(m_maxResults) : encoder.WriteNegInt(m_maxResults); + payload.WithInteger("maxResults", m_maxResults); } - const auto str = Aws::String(reinterpret_cast(encoder.GetEncodedData().ptr), encoder.GetEncodedData().len); - return str; + + return payload.View().WriteReadable(); } Aws::Http::HeaderValueCollection ListBillEstimateInputCommitmentModificationsRequest::GetRequestSpecificHeaders() const { Aws::Http::HeaderValueCollection headers; - headers.emplace(Aws::Http::CONTENT_TYPE_HEADER, Aws::CBOR_CONTENT_TYPE); - headers.emplace(Aws::Http::SMITHY_PROTOCOL_HEADER, Aws::RPC_V2_CBOR); - headers.emplace(Aws::Http::ACCEPT_HEADER, Aws::CBOR_CONTENT_TYPE); + headers.insert(Aws::Http::HeaderValuePair("X-Amz-Target", "AWSBCMPricingCalculator.ListBillEstimateInputCommitmentModifications")); return headers; } diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimateInputCommitmentModificationsResult.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimateInputCommitmentModificationsResult.cpp index 9841c94e87c2..e0024d3f56f1 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimateInputCommitmentModificationsResult.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimateInputCommitmentModificationsResult.cpp @@ -7,194 +7,35 @@ #include #include #include -#include +#include #include -#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; -using namespace Aws::Utils::Cbor; using namespace Aws; ListBillEstimateInputCommitmentModificationsResult::ListBillEstimateInputCommitmentModificationsResult( - const Aws::AmazonWebServiceResult& result) { + const Aws::AmazonWebServiceResult& result) { *this = result; } ListBillEstimateInputCommitmentModificationsResult& ListBillEstimateInputCommitmentModificationsResult::operator=( - const Aws::AmazonWebServiceResult& result) { + const Aws::AmazonWebServiceResult& result) { m_HttpResponseCode = result.GetResponseCode(); - - const auto& cborValue = result.GetPayload(); - const auto decoder = cborValue.GetDecoder(); - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "items") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_items.push_back(BillEstimateInputCommitmentModificationSummary(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_items.push_back(BillEstimateInputCommitmentModificationSummary(decoder)); - } - } - } - m_itemsHasBeenSet = true; - } - - else if (initialKeyStr == "nextToken") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_nextToken = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_nextToken = ss.str(); - } - } - m_nextTokenHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("ListBillEstimateInputCommitmentModificationsResult", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "items") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_items.push_back(BillEstimateInputCommitmentModificationSummary(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_items.push_back(BillEstimateInputCommitmentModificationSummary(decoder)); - } - } - } - m_itemsHasBeenSet = true; - } - - else if (initialKeyStr == "nextToken") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_nextToken = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_nextToken = ss.str(); - } - } - m_nextTokenHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } + JsonView jsonValue = result.GetPayload().View(); + if (jsonValue.ValueExists("items")) { + Aws::Utils::Array itemsJsonList = jsonValue.GetArray("items"); + for (unsigned itemsIndex = 0; itemsIndex < itemsJsonList.GetLength(); ++itemsIndex) { + m_items.push_back(itemsJsonList[itemsIndex].AsObject()); } + m_itemsHasBeenSet = true; + } + if (jsonValue.ValueExists("nextToken")) { + m_nextToken = jsonValue.GetString("nextToken"); + m_nextTokenHasBeenSet = true; } const auto& headers = result.GetHeaderValueCollection(); diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimateInputUsageModificationsRequest.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimateInputUsageModificationsRequest.cpp index 9185ea5fe3c4..4ab8f7ac5bc2 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimateInputUsageModificationsRequest.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimateInputUsageModificationsRequest.cpp @@ -4,64 +4,42 @@ */ #include -#include +#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; Aws::String ListBillEstimateInputUsageModificationsRequest::SerializePayload() const { - Aws::Crt::Cbor::CborEncoder encoder; + JsonValue payload; - // Calculate map size - size_t mapSize = 0; if (m_billEstimateIdHasBeenSet) { - mapSize++; - } - if (m_filtersHasBeenSet) { - mapSize++; - } - if (m_nextTokenHasBeenSet) { - mapSize++; - } - if (m_maxResultsHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); - - if (m_billEstimateIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("billEstimateId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_billEstimateId.c_str())); + payload.WithString("billEstimateId", m_billEstimateId); } if (m_filtersHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("filters")); - encoder.WriteArrayStart(m_filters.size()); - for (const auto& item_0 : m_filters) { - item_0.CborEncode(encoder); + Aws::Utils::Array filtersJsonList(m_filters.size()); + for (unsigned filtersIndex = 0; filtersIndex < filtersJsonList.GetLength(); ++filtersIndex) { + filtersJsonList[filtersIndex].AsObject(m_filters[filtersIndex].Jsonize()); } + payload.WithArray("filters", std::move(filtersJsonList)); } if (m_nextTokenHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("nextToken")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_nextToken.c_str())); + payload.WithString("nextToken", m_nextToken); } if (m_maxResultsHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("maxResults")); - (m_maxResults >= 0) ? encoder.WriteUInt(m_maxResults) : encoder.WriteNegInt(m_maxResults); + payload.WithInteger("maxResults", m_maxResults); } - const auto str = Aws::String(reinterpret_cast(encoder.GetEncodedData().ptr), encoder.GetEncodedData().len); - return str; + + return payload.View().WriteReadable(); } Aws::Http::HeaderValueCollection ListBillEstimateInputUsageModificationsRequest::GetRequestSpecificHeaders() const { Aws::Http::HeaderValueCollection headers; - headers.emplace(Aws::Http::CONTENT_TYPE_HEADER, Aws::CBOR_CONTENT_TYPE); - headers.emplace(Aws::Http::SMITHY_PROTOCOL_HEADER, Aws::RPC_V2_CBOR); - headers.emplace(Aws::Http::ACCEPT_HEADER, Aws::CBOR_CONTENT_TYPE); + headers.insert(Aws::Http::HeaderValuePair("X-Amz-Target", "AWSBCMPricingCalculator.ListBillEstimateInputUsageModifications")); return headers; } diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimateInputUsageModificationsResult.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimateInputUsageModificationsResult.cpp index f9babf826f18..5c6e0a2b30ec 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimateInputUsageModificationsResult.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimateInputUsageModificationsResult.cpp @@ -7,194 +7,35 @@ #include #include #include -#include +#include #include -#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; -using namespace Aws::Utils::Cbor; using namespace Aws; ListBillEstimateInputUsageModificationsResult::ListBillEstimateInputUsageModificationsResult( - const Aws::AmazonWebServiceResult& result) { + const Aws::AmazonWebServiceResult& result) { *this = result; } ListBillEstimateInputUsageModificationsResult& ListBillEstimateInputUsageModificationsResult::operator=( - const Aws::AmazonWebServiceResult& result) { + const Aws::AmazonWebServiceResult& result) { m_HttpResponseCode = result.GetResponseCode(); - - const auto& cborValue = result.GetPayload(); - const auto decoder = cborValue.GetDecoder(); - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "items") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_items.push_back(BillEstimateInputUsageModificationSummary(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_items.push_back(BillEstimateInputUsageModificationSummary(decoder)); - } - } - } - m_itemsHasBeenSet = true; - } - - else if (initialKeyStr == "nextToken") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_nextToken = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_nextToken = ss.str(); - } - } - m_nextTokenHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("ListBillEstimateInputUsageModificationsResult", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "items") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_items.push_back(BillEstimateInputUsageModificationSummary(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_items.push_back(BillEstimateInputUsageModificationSummary(decoder)); - } - } - } - m_itemsHasBeenSet = true; - } - - else if (initialKeyStr == "nextToken") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_nextToken = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_nextToken = ss.str(); - } - } - m_nextTokenHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } + JsonView jsonValue = result.GetPayload().View(); + if (jsonValue.ValueExists("items")) { + Aws::Utils::Array itemsJsonList = jsonValue.GetArray("items"); + for (unsigned itemsIndex = 0; itemsIndex < itemsJsonList.GetLength(); ++itemsIndex) { + m_items.push_back(itemsJsonList[itemsIndex].AsObject()); } + m_itemsHasBeenSet = true; + } + if (jsonValue.ValueExists("nextToken")) { + m_nextToken = jsonValue.GetString("nextToken"); + m_nextTokenHasBeenSet = true; } const auto& headers = result.GetHeaderValueCollection(); diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimateLineItemsFilter.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimateLineItemsFilter.cpp index 1d5174b4af2c..d630268f7d1c 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimateLineItemsFilter.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimateLineItemsFilter.cpp @@ -4,303 +4,60 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -ListBillEstimateLineItemsFilter::ListBillEstimateLineItemsFilter(const std::shared_ptr& decoder) { - *this = decoder; -} - -ListBillEstimateLineItemsFilter& ListBillEstimateLineItemsFilter::operator=(const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "name") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_name = ListBillEstimateLineItemsFilterNameMapper::GetListBillEstimateLineItemsFilterNameForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_nameHasBeenSet = true; - } - - else if (initialKeyStr == "values") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - auto peekType_1 = decoder->PeekType(); - if (peekType_1.has_value()) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_values.push_back(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_values.push_back(ss_1.str()); - ss_1.clear(); - } - } - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto peekType_1 = decoder->PeekType(); - if (peekType_1.has_value()) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_values.push_back(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_values.push_back(ss_1.str()); - ss_1.clear(); - } - } - } - } - } - m_valuesHasBeenSet = true; - } - - else if (initialKeyStr == "matchOption") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_matchOption = MatchOptionMapper::GetMatchOptionForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_matchOptionHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("ListBillEstimateLineItemsFilter", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } +ListBillEstimateLineItemsFilter::ListBillEstimateLineItemsFilter(JsonView jsonValue) { *this = jsonValue; } - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "name") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_name = ListBillEstimateLineItemsFilterNameMapper::GetListBillEstimateLineItemsFilterNameForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_nameHasBeenSet = true; - } - - else if (initialKeyStr == "values") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - auto peekType_1 = decoder->PeekType(); - if (peekType_1.has_value()) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_values.push_back(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_values.push_back(ss_1.str()); - ss_1.clear(); - } - } - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto peekType_1 = decoder->PeekType(); - if (peekType_1.has_value()) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_values.push_back(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_values.push_back(ss_1.str()); - ss_1.clear(); - } - } - } - } - } - m_valuesHasBeenSet = true; - } - - else if (initialKeyStr == "matchOption") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_matchOption = - MatchOptionMapper::GetMatchOptionForName(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_matchOptionHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } +ListBillEstimateLineItemsFilter& ListBillEstimateLineItemsFilter::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("name")) { + m_name = ListBillEstimateLineItemsFilterNameMapper::GetListBillEstimateLineItemsFilterNameForName(jsonValue.GetString("name")); + m_nameHasBeenSet = true; + } + if (jsonValue.ValueExists("values")) { + Aws::Utils::Array valuesJsonList = jsonValue.GetArray("values"); + for (unsigned valuesIndex = 0; valuesIndex < valuesJsonList.GetLength(); ++valuesIndex) { + m_values.push_back(valuesJsonList[valuesIndex].AsString()); } + m_valuesHasBeenSet = true; + } + if (jsonValue.ValueExists("matchOption")) { + m_matchOption = MatchOptionMapper::GetMatchOptionForName(jsonValue.GetString("matchOption")); + m_matchOptionHasBeenSet = true; } - return *this; } -void ListBillEstimateLineItemsFilter::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_nameHasBeenSet) { - mapSize++; - } - if (m_valuesHasBeenSet) { - mapSize++; - } - if (m_matchOptionHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); +JsonValue ListBillEstimateLineItemsFilter::Jsonize() const { + JsonValue payload; if (m_nameHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("name")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString( - ListBillEstimateLineItemsFilterNameMapper::GetNameForListBillEstimateLineItemsFilterName(m_name).c_str())); + payload.WithString("name", ListBillEstimateLineItemsFilterNameMapper::GetNameForListBillEstimateLineItemsFilterName(m_name)); } if (m_valuesHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("values")); - encoder.WriteArrayStart(m_values.size()); - for (const auto& item_0 : m_values) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString(item_0.c_str())); + Aws::Utils::Array valuesJsonList(m_values.size()); + for (unsigned valuesIndex = 0; valuesIndex < valuesJsonList.GetLength(); ++valuesIndex) { + valuesJsonList[valuesIndex].AsString(m_values[valuesIndex]); } + payload.WithArray("values", std::move(valuesJsonList)); } if (m_matchOptionHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("matchOption")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(MatchOptionMapper::GetNameForMatchOption(m_matchOption).c_str())); + payload.WithString("matchOption", MatchOptionMapper::GetNameForMatchOption(m_matchOption)); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimateLineItemsRequest.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimateLineItemsRequest.cpp index 57c403058d39..79bdb847b5fd 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimateLineItemsRequest.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimateLineItemsRequest.cpp @@ -4,64 +4,42 @@ */ #include -#include +#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; Aws::String ListBillEstimateLineItemsRequest::SerializePayload() const { - Aws::Crt::Cbor::CborEncoder encoder; + JsonValue payload; - // Calculate map size - size_t mapSize = 0; if (m_billEstimateIdHasBeenSet) { - mapSize++; - } - if (m_filtersHasBeenSet) { - mapSize++; - } - if (m_nextTokenHasBeenSet) { - mapSize++; - } - if (m_maxResultsHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); - - if (m_billEstimateIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("billEstimateId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_billEstimateId.c_str())); + payload.WithString("billEstimateId", m_billEstimateId); } if (m_filtersHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("filters")); - encoder.WriteArrayStart(m_filters.size()); - for (const auto& item_0 : m_filters) { - item_0.CborEncode(encoder); + Aws::Utils::Array filtersJsonList(m_filters.size()); + for (unsigned filtersIndex = 0; filtersIndex < filtersJsonList.GetLength(); ++filtersIndex) { + filtersJsonList[filtersIndex].AsObject(m_filters[filtersIndex].Jsonize()); } + payload.WithArray("filters", std::move(filtersJsonList)); } if (m_nextTokenHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("nextToken")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_nextToken.c_str())); + payload.WithString("nextToken", m_nextToken); } if (m_maxResultsHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("maxResults")); - (m_maxResults >= 0) ? encoder.WriteUInt(m_maxResults) : encoder.WriteNegInt(m_maxResults); + payload.WithInteger("maxResults", m_maxResults); } - const auto str = Aws::String(reinterpret_cast(encoder.GetEncodedData().ptr), encoder.GetEncodedData().len); - return str; + + return payload.View().WriteReadable(); } Aws::Http::HeaderValueCollection ListBillEstimateLineItemsRequest::GetRequestSpecificHeaders() const { Aws::Http::HeaderValueCollection headers; - headers.emplace(Aws::Http::CONTENT_TYPE_HEADER, Aws::CBOR_CONTENT_TYPE); - headers.emplace(Aws::Http::SMITHY_PROTOCOL_HEADER, Aws::RPC_V2_CBOR); - headers.emplace(Aws::Http::ACCEPT_HEADER, Aws::CBOR_CONTENT_TYPE); + headers.insert(Aws::Http::HeaderValuePair("X-Amz-Target", "AWSBCMPricingCalculator.ListBillEstimateLineItems")); return headers; } diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimateLineItemsResult.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimateLineItemsResult.cpp index 84b82eabcefa..f0ff065c8f65 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimateLineItemsResult.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimateLineItemsResult.cpp @@ -7,193 +7,31 @@ #include #include #include -#include +#include #include -#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; -using namespace Aws::Utils::Cbor; using namespace Aws; -ListBillEstimateLineItemsResult::ListBillEstimateLineItemsResult(const Aws::AmazonWebServiceResult& result) { - *this = result; -} +ListBillEstimateLineItemsResult::ListBillEstimateLineItemsResult(const Aws::AmazonWebServiceResult& result) { *this = result; } -ListBillEstimateLineItemsResult& ListBillEstimateLineItemsResult::operator=( - const Aws::AmazonWebServiceResult& result) { +ListBillEstimateLineItemsResult& ListBillEstimateLineItemsResult::operator=(const Aws::AmazonWebServiceResult& result) { m_HttpResponseCode = result.GetResponseCode(); - - const auto& cborValue = result.GetPayload(); - const auto decoder = cborValue.GetDecoder(); - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "items") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_items.push_back(BillEstimateLineItemSummary(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_items.push_back(BillEstimateLineItemSummary(decoder)); - } - } - } - m_itemsHasBeenSet = true; - } - - else if (initialKeyStr == "nextToken") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_nextToken = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_nextToken = ss.str(); - } - } - m_nextTokenHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("ListBillEstimateLineItemsResult", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "items") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_items.push_back(BillEstimateLineItemSummary(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_items.push_back(BillEstimateLineItemSummary(decoder)); - } - } - } - m_itemsHasBeenSet = true; - } - - else if (initialKeyStr == "nextToken") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_nextToken = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_nextToken = ss.str(); - } - } - m_nextTokenHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } + JsonView jsonValue = result.GetPayload().View(); + if (jsonValue.ValueExists("items")) { + Aws::Utils::Array itemsJsonList = jsonValue.GetArray("items"); + for (unsigned itemsIndex = 0; itemsIndex < itemsJsonList.GetLength(); ++itemsIndex) { + m_items.push_back(itemsJsonList[itemsIndex].AsObject()); } + m_itemsHasBeenSet = true; + } + if (jsonValue.ValueExists("nextToken")) { + m_nextToken = jsonValue.GetString("nextToken"); + m_nextTokenHasBeenSet = true; } const auto& headers = result.GetHeaderValueCollection(); diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimatesFilter.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimatesFilter.cpp index 80c224d1f684..234c1d785d3d 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimatesFilter.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimatesFilter.cpp @@ -4,301 +4,60 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -ListBillEstimatesFilter::ListBillEstimatesFilter(const std::shared_ptr& decoder) { *this = decoder; } +ListBillEstimatesFilter::ListBillEstimatesFilter(JsonView jsonValue) { *this = jsonValue; } -ListBillEstimatesFilter& ListBillEstimatesFilter::operator=(const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "name") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_name = ListBillEstimatesFilterNameMapper::GetListBillEstimatesFilterNameForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_nameHasBeenSet = true; - } - - else if (initialKeyStr == "values") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - auto peekType_1 = decoder->PeekType(); - if (peekType_1.has_value()) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_values.push_back(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_values.push_back(ss_1.str()); - ss_1.clear(); - } - } - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto peekType_1 = decoder->PeekType(); - if (peekType_1.has_value()) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_values.push_back(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_values.push_back(ss_1.str()); - ss_1.clear(); - } - } - } - } - } - m_valuesHasBeenSet = true; - } - - else if (initialKeyStr == "matchOption") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_matchOption = MatchOptionMapper::GetMatchOptionForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_matchOptionHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("ListBillEstimatesFilter", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "name") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_name = ListBillEstimatesFilterNameMapper::GetListBillEstimatesFilterNameForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_nameHasBeenSet = true; - } - - else if (initialKeyStr == "values") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - auto peekType_1 = decoder->PeekType(); - if (peekType_1.has_value()) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_values.push_back(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_values.push_back(ss_1.str()); - ss_1.clear(); - } - } - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto peekType_1 = decoder->PeekType(); - if (peekType_1.has_value()) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_values.push_back(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_values.push_back(ss_1.str()); - ss_1.clear(); - } - } - } - } - } - m_valuesHasBeenSet = true; - } - - else if (initialKeyStr == "matchOption") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_matchOption = - MatchOptionMapper::GetMatchOptionForName(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_matchOptionHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } +ListBillEstimatesFilter& ListBillEstimatesFilter::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("name")) { + m_name = ListBillEstimatesFilterNameMapper::GetListBillEstimatesFilterNameForName(jsonValue.GetString("name")); + m_nameHasBeenSet = true; + } + if (jsonValue.ValueExists("values")) { + Aws::Utils::Array valuesJsonList = jsonValue.GetArray("values"); + for (unsigned valuesIndex = 0; valuesIndex < valuesJsonList.GetLength(); ++valuesIndex) { + m_values.push_back(valuesJsonList[valuesIndex].AsString()); } + m_valuesHasBeenSet = true; + } + if (jsonValue.ValueExists("matchOption")) { + m_matchOption = MatchOptionMapper::GetMatchOptionForName(jsonValue.GetString("matchOption")); + m_matchOptionHasBeenSet = true; } - return *this; } -void ListBillEstimatesFilter::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_nameHasBeenSet) { - mapSize++; - } - if (m_valuesHasBeenSet) { - mapSize++; - } - if (m_matchOptionHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); +JsonValue ListBillEstimatesFilter::Jsonize() const { + JsonValue payload; if (m_nameHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("name")); - encoder.WriteText( - Aws::Crt::ByteCursorFromCString(ListBillEstimatesFilterNameMapper::GetNameForListBillEstimatesFilterName(m_name).c_str())); + payload.WithString("name", ListBillEstimatesFilterNameMapper::GetNameForListBillEstimatesFilterName(m_name)); } if (m_valuesHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("values")); - encoder.WriteArrayStart(m_values.size()); - for (const auto& item_0 : m_values) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString(item_0.c_str())); + Aws::Utils::Array valuesJsonList(m_values.size()); + for (unsigned valuesIndex = 0; valuesIndex < valuesJsonList.GetLength(); ++valuesIndex) { + valuesJsonList[valuesIndex].AsString(m_values[valuesIndex]); } + payload.WithArray("values", std::move(valuesJsonList)); } if (m_matchOptionHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("matchOption")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(MatchOptionMapper::GetNameForMatchOption(m_matchOption).c_str())); + payload.WithString("matchOption", MatchOptionMapper::GetNameForMatchOption(m_matchOption)); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimatesRequest.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimatesRequest.cpp index b337d2e64401..5981ec9ac131 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimatesRequest.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimatesRequest.cpp @@ -4,72 +4,46 @@ */ #include -#include +#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; Aws::String ListBillEstimatesRequest::SerializePayload() const { - Aws::Crt::Cbor::CborEncoder encoder; + JsonValue payload; - // Calculate map size - size_t mapSize = 0; if (m_filtersHasBeenSet) { - mapSize++; - } - if (m_createdAtFilterHasBeenSet) { - mapSize++; - } - if (m_expiresAtFilterHasBeenSet) { - mapSize++; - } - if (m_nextTokenHasBeenSet) { - mapSize++; - } - if (m_maxResultsHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); - - if (m_filtersHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("filters")); - encoder.WriteArrayStart(m_filters.size()); - for (const auto& item_0 : m_filters) { - item_0.CborEncode(encoder); + Aws::Utils::Array filtersJsonList(m_filters.size()); + for (unsigned filtersIndex = 0; filtersIndex < filtersJsonList.GetLength(); ++filtersIndex) { + filtersJsonList[filtersIndex].AsObject(m_filters[filtersIndex].Jsonize()); } + payload.WithArray("filters", std::move(filtersJsonList)); } if (m_createdAtFilterHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("createdAtFilter")); - m_createdAtFilter.CborEncode(encoder); + payload.WithObject("createdAtFilter", m_createdAtFilter.Jsonize()); } if (m_expiresAtFilterHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("expiresAtFilter")); - m_expiresAtFilter.CborEncode(encoder); + payload.WithObject("expiresAtFilter", m_expiresAtFilter.Jsonize()); } if (m_nextTokenHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("nextToken")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_nextToken.c_str())); + payload.WithString("nextToken", m_nextToken); } if (m_maxResultsHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("maxResults")); - (m_maxResults >= 0) ? encoder.WriteUInt(m_maxResults) : encoder.WriteNegInt(m_maxResults); + payload.WithInteger("maxResults", m_maxResults); } - const auto str = Aws::String(reinterpret_cast(encoder.GetEncodedData().ptr), encoder.GetEncodedData().len); - return str; + + return payload.View().WriteReadable(); } Aws::Http::HeaderValueCollection ListBillEstimatesRequest::GetRequestSpecificHeaders() const { Aws::Http::HeaderValueCollection headers; - headers.emplace(Aws::Http::CONTENT_TYPE_HEADER, Aws::CBOR_CONTENT_TYPE); - headers.emplace(Aws::Http::SMITHY_PROTOCOL_HEADER, Aws::RPC_V2_CBOR); - headers.emplace(Aws::Http::ACCEPT_HEADER, Aws::CBOR_CONTENT_TYPE); + headers.insert(Aws::Http::HeaderValuePair("X-Amz-Target", "AWSBCMPricingCalculator.ListBillEstimates")); return headers; } diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimatesResult.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimatesResult.cpp index 9ed3102981ef..5097b6685cce 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimatesResult.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillEstimatesResult.cpp @@ -7,190 +7,31 @@ #include #include #include -#include +#include #include -#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; -using namespace Aws::Utils::Cbor; using namespace Aws; -ListBillEstimatesResult::ListBillEstimatesResult(const Aws::AmazonWebServiceResult& result) { *this = result; } +ListBillEstimatesResult::ListBillEstimatesResult(const Aws::AmazonWebServiceResult& result) { *this = result; } -ListBillEstimatesResult& ListBillEstimatesResult::operator=(const Aws::AmazonWebServiceResult& result) { +ListBillEstimatesResult& ListBillEstimatesResult::operator=(const Aws::AmazonWebServiceResult& result) { m_HttpResponseCode = result.GetResponseCode(); - - const auto& cborValue = result.GetPayload(); - const auto decoder = cborValue.GetDecoder(); - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "items") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_items.push_back(BillEstimateSummary(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_items.push_back(BillEstimateSummary(decoder)); - } - } - } - m_itemsHasBeenSet = true; - } - - else if (initialKeyStr == "nextToken") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_nextToken = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_nextToken = ss.str(); - } - } - m_nextTokenHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("ListBillEstimatesResult", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "items") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_items.push_back(BillEstimateSummary(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_items.push_back(BillEstimateSummary(decoder)); - } - } - } - m_itemsHasBeenSet = true; - } - - else if (initialKeyStr == "nextToken") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_nextToken = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_nextToken = ss.str(); - } - } - m_nextTokenHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } + JsonView jsonValue = result.GetPayload().View(); + if (jsonValue.ValueExists("items")) { + Aws::Utils::Array itemsJsonList = jsonValue.GetArray("items"); + for (unsigned itemsIndex = 0; itemsIndex < itemsJsonList.GetLength(); ++itemsIndex) { + m_items.push_back(itemsJsonList[itemsIndex].AsObject()); } + m_itemsHasBeenSet = true; + } + if (jsonValue.ValueExists("nextToken")) { + m_nextToken = jsonValue.GetString("nextToken"); + m_nextTokenHasBeenSet = true; } const auto& headers = result.GetHeaderValueCollection(); diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillScenarioCommitmentModificationsRequest.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillScenarioCommitmentModificationsRequest.cpp index 8ae5c68c7818..92377c10b95c 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillScenarioCommitmentModificationsRequest.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillScenarioCommitmentModificationsRequest.cpp @@ -4,53 +4,34 @@ */ #include -#include +#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; Aws::String ListBillScenarioCommitmentModificationsRequest::SerializePayload() const { - Aws::Crt::Cbor::CborEncoder encoder; + JsonValue payload; - // Calculate map size - size_t mapSize = 0; if (m_billScenarioIdHasBeenSet) { - mapSize++; - } - if (m_nextTokenHasBeenSet) { - mapSize++; - } - if (m_maxResultsHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); - - if (m_billScenarioIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("billScenarioId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_billScenarioId.c_str())); + payload.WithString("billScenarioId", m_billScenarioId); } if (m_nextTokenHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("nextToken")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_nextToken.c_str())); + payload.WithString("nextToken", m_nextToken); } if (m_maxResultsHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("maxResults")); - (m_maxResults >= 0) ? encoder.WriteUInt(m_maxResults) : encoder.WriteNegInt(m_maxResults); + payload.WithInteger("maxResults", m_maxResults); } - const auto str = Aws::String(reinterpret_cast(encoder.GetEncodedData().ptr), encoder.GetEncodedData().len); - return str; + + return payload.View().WriteReadable(); } Aws::Http::HeaderValueCollection ListBillScenarioCommitmentModificationsRequest::GetRequestSpecificHeaders() const { Aws::Http::HeaderValueCollection headers; - headers.emplace(Aws::Http::CONTENT_TYPE_HEADER, Aws::CBOR_CONTENT_TYPE); - headers.emplace(Aws::Http::SMITHY_PROTOCOL_HEADER, Aws::RPC_V2_CBOR); - headers.emplace(Aws::Http::ACCEPT_HEADER, Aws::CBOR_CONTENT_TYPE); + headers.insert(Aws::Http::HeaderValuePair("X-Amz-Target", "AWSBCMPricingCalculator.ListBillScenarioCommitmentModifications")); return headers; } diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillScenarioCommitmentModificationsResult.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillScenarioCommitmentModificationsResult.cpp index a1222ded95e2..7ea5e5e9ff64 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillScenarioCommitmentModificationsResult.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillScenarioCommitmentModificationsResult.cpp @@ -7,194 +7,35 @@ #include #include #include -#include +#include #include -#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; -using namespace Aws::Utils::Cbor; using namespace Aws; ListBillScenarioCommitmentModificationsResult::ListBillScenarioCommitmentModificationsResult( - const Aws::AmazonWebServiceResult& result) { + const Aws::AmazonWebServiceResult& result) { *this = result; } ListBillScenarioCommitmentModificationsResult& ListBillScenarioCommitmentModificationsResult::operator=( - const Aws::AmazonWebServiceResult& result) { + const Aws::AmazonWebServiceResult& result) { m_HttpResponseCode = result.GetResponseCode(); - - const auto& cborValue = result.GetPayload(); - const auto decoder = cborValue.GetDecoder(); - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "items") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_items.push_back(BillScenarioCommitmentModificationItem(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_items.push_back(BillScenarioCommitmentModificationItem(decoder)); - } - } - } - m_itemsHasBeenSet = true; - } - - else if (initialKeyStr == "nextToken") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_nextToken = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_nextToken = ss.str(); - } - } - m_nextTokenHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("ListBillScenarioCommitmentModificationsResult", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "items") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_items.push_back(BillScenarioCommitmentModificationItem(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_items.push_back(BillScenarioCommitmentModificationItem(decoder)); - } - } - } - m_itemsHasBeenSet = true; - } - - else if (initialKeyStr == "nextToken") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_nextToken = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_nextToken = ss.str(); - } - } - m_nextTokenHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } + JsonView jsonValue = result.GetPayload().View(); + if (jsonValue.ValueExists("items")) { + Aws::Utils::Array itemsJsonList = jsonValue.GetArray("items"); + for (unsigned itemsIndex = 0; itemsIndex < itemsJsonList.GetLength(); ++itemsIndex) { + m_items.push_back(itemsJsonList[itemsIndex].AsObject()); } + m_itemsHasBeenSet = true; + } + if (jsonValue.ValueExists("nextToken")) { + m_nextToken = jsonValue.GetString("nextToken"); + m_nextTokenHasBeenSet = true; } const auto& headers = result.GetHeaderValueCollection(); diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillScenarioUsageModificationsRequest.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillScenarioUsageModificationsRequest.cpp index 9c5dbd36f6b7..8ed1488461d6 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillScenarioUsageModificationsRequest.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillScenarioUsageModificationsRequest.cpp @@ -4,64 +4,42 @@ */ #include -#include +#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; Aws::String ListBillScenarioUsageModificationsRequest::SerializePayload() const { - Aws::Crt::Cbor::CborEncoder encoder; + JsonValue payload; - // Calculate map size - size_t mapSize = 0; if (m_billScenarioIdHasBeenSet) { - mapSize++; - } - if (m_filtersHasBeenSet) { - mapSize++; - } - if (m_nextTokenHasBeenSet) { - mapSize++; - } - if (m_maxResultsHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); - - if (m_billScenarioIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("billScenarioId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_billScenarioId.c_str())); + payload.WithString("billScenarioId", m_billScenarioId); } if (m_filtersHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("filters")); - encoder.WriteArrayStart(m_filters.size()); - for (const auto& item_0 : m_filters) { - item_0.CborEncode(encoder); + Aws::Utils::Array filtersJsonList(m_filters.size()); + for (unsigned filtersIndex = 0; filtersIndex < filtersJsonList.GetLength(); ++filtersIndex) { + filtersJsonList[filtersIndex].AsObject(m_filters[filtersIndex].Jsonize()); } + payload.WithArray("filters", std::move(filtersJsonList)); } if (m_nextTokenHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("nextToken")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_nextToken.c_str())); + payload.WithString("nextToken", m_nextToken); } if (m_maxResultsHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("maxResults")); - (m_maxResults >= 0) ? encoder.WriteUInt(m_maxResults) : encoder.WriteNegInt(m_maxResults); + payload.WithInteger("maxResults", m_maxResults); } - const auto str = Aws::String(reinterpret_cast(encoder.GetEncodedData().ptr), encoder.GetEncodedData().len); - return str; + + return payload.View().WriteReadable(); } Aws::Http::HeaderValueCollection ListBillScenarioUsageModificationsRequest::GetRequestSpecificHeaders() const { Aws::Http::HeaderValueCollection headers; - headers.emplace(Aws::Http::CONTENT_TYPE_HEADER, Aws::CBOR_CONTENT_TYPE); - headers.emplace(Aws::Http::SMITHY_PROTOCOL_HEADER, Aws::RPC_V2_CBOR); - headers.emplace(Aws::Http::ACCEPT_HEADER, Aws::CBOR_CONTENT_TYPE); + headers.insert(Aws::Http::HeaderValuePair("X-Amz-Target", "AWSBCMPricingCalculator.ListBillScenarioUsageModifications")); return headers; } diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillScenarioUsageModificationsResult.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillScenarioUsageModificationsResult.cpp index a1dc9efed3ed..1b3ff885ae81 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillScenarioUsageModificationsResult.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillScenarioUsageModificationsResult.cpp @@ -7,194 +7,34 @@ #include #include #include -#include +#include #include -#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; -using namespace Aws::Utils::Cbor; using namespace Aws; -ListBillScenarioUsageModificationsResult::ListBillScenarioUsageModificationsResult( - const Aws::AmazonWebServiceResult& result) { +ListBillScenarioUsageModificationsResult::ListBillScenarioUsageModificationsResult(const Aws::AmazonWebServiceResult& result) { *this = result; } ListBillScenarioUsageModificationsResult& ListBillScenarioUsageModificationsResult::operator=( - const Aws::AmazonWebServiceResult& result) { + const Aws::AmazonWebServiceResult& result) { m_HttpResponseCode = result.GetResponseCode(); - - const auto& cborValue = result.GetPayload(); - const auto decoder = cborValue.GetDecoder(); - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "items") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_items.push_back(BillScenarioUsageModificationItem(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_items.push_back(BillScenarioUsageModificationItem(decoder)); - } - } - } - m_itemsHasBeenSet = true; - } - - else if (initialKeyStr == "nextToken") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_nextToken = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_nextToken = ss.str(); - } - } - m_nextTokenHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("ListBillScenarioUsageModificationsResult", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "items") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_items.push_back(BillScenarioUsageModificationItem(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_items.push_back(BillScenarioUsageModificationItem(decoder)); - } - } - } - m_itemsHasBeenSet = true; - } - - else if (initialKeyStr == "nextToken") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_nextToken = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_nextToken = ss.str(); - } - } - m_nextTokenHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } + JsonView jsonValue = result.GetPayload().View(); + if (jsonValue.ValueExists("items")) { + Aws::Utils::Array itemsJsonList = jsonValue.GetArray("items"); + for (unsigned itemsIndex = 0; itemsIndex < itemsJsonList.GetLength(); ++itemsIndex) { + m_items.push_back(itemsJsonList[itemsIndex].AsObject()); } + m_itemsHasBeenSet = true; + } + if (jsonValue.ValueExists("nextToken")) { + m_nextToken = jsonValue.GetString("nextToken"); + m_nextTokenHasBeenSet = true; } const auto& headers = result.GetHeaderValueCollection(); diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillScenariosFilter.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillScenariosFilter.cpp index 7e555a286c9e..c53b23f34a76 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillScenariosFilter.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillScenariosFilter.cpp @@ -4,301 +4,60 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -ListBillScenariosFilter::ListBillScenariosFilter(const std::shared_ptr& decoder) { *this = decoder; } +ListBillScenariosFilter::ListBillScenariosFilter(JsonView jsonValue) { *this = jsonValue; } -ListBillScenariosFilter& ListBillScenariosFilter::operator=(const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "name") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_name = ListBillScenariosFilterNameMapper::GetListBillScenariosFilterNameForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_nameHasBeenSet = true; - } - - else if (initialKeyStr == "values") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - auto peekType_1 = decoder->PeekType(); - if (peekType_1.has_value()) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_values.push_back(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_values.push_back(ss_1.str()); - ss_1.clear(); - } - } - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto peekType_1 = decoder->PeekType(); - if (peekType_1.has_value()) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_values.push_back(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_values.push_back(ss_1.str()); - ss_1.clear(); - } - } - } - } - } - m_valuesHasBeenSet = true; - } - - else if (initialKeyStr == "matchOption") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_matchOption = MatchOptionMapper::GetMatchOptionForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_matchOptionHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("ListBillScenariosFilter", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "name") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_name = ListBillScenariosFilterNameMapper::GetListBillScenariosFilterNameForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_nameHasBeenSet = true; - } - - else if (initialKeyStr == "values") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - auto peekType_1 = decoder->PeekType(); - if (peekType_1.has_value()) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_values.push_back(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_values.push_back(ss_1.str()); - ss_1.clear(); - } - } - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto peekType_1 = decoder->PeekType(); - if (peekType_1.has_value()) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_values.push_back(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_values.push_back(ss_1.str()); - ss_1.clear(); - } - } - } - } - } - m_valuesHasBeenSet = true; - } - - else if (initialKeyStr == "matchOption") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_matchOption = - MatchOptionMapper::GetMatchOptionForName(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_matchOptionHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } +ListBillScenariosFilter& ListBillScenariosFilter::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("name")) { + m_name = ListBillScenariosFilterNameMapper::GetListBillScenariosFilterNameForName(jsonValue.GetString("name")); + m_nameHasBeenSet = true; + } + if (jsonValue.ValueExists("values")) { + Aws::Utils::Array valuesJsonList = jsonValue.GetArray("values"); + for (unsigned valuesIndex = 0; valuesIndex < valuesJsonList.GetLength(); ++valuesIndex) { + m_values.push_back(valuesJsonList[valuesIndex].AsString()); } + m_valuesHasBeenSet = true; + } + if (jsonValue.ValueExists("matchOption")) { + m_matchOption = MatchOptionMapper::GetMatchOptionForName(jsonValue.GetString("matchOption")); + m_matchOptionHasBeenSet = true; } - return *this; } -void ListBillScenariosFilter::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_nameHasBeenSet) { - mapSize++; - } - if (m_valuesHasBeenSet) { - mapSize++; - } - if (m_matchOptionHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); +JsonValue ListBillScenariosFilter::Jsonize() const { + JsonValue payload; if (m_nameHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("name")); - encoder.WriteText( - Aws::Crt::ByteCursorFromCString(ListBillScenariosFilterNameMapper::GetNameForListBillScenariosFilterName(m_name).c_str())); + payload.WithString("name", ListBillScenariosFilterNameMapper::GetNameForListBillScenariosFilterName(m_name)); } if (m_valuesHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("values")); - encoder.WriteArrayStart(m_values.size()); - for (const auto& item_0 : m_values) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString(item_0.c_str())); + Aws::Utils::Array valuesJsonList(m_values.size()); + for (unsigned valuesIndex = 0; valuesIndex < valuesJsonList.GetLength(); ++valuesIndex) { + valuesJsonList[valuesIndex].AsString(m_values[valuesIndex]); } + payload.WithArray("values", std::move(valuesJsonList)); } if (m_matchOptionHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("matchOption")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(MatchOptionMapper::GetNameForMatchOption(m_matchOption).c_str())); + payload.WithString("matchOption", MatchOptionMapper::GetNameForMatchOption(m_matchOption)); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillScenariosRequest.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillScenariosRequest.cpp index b6a45b4fd7b7..a3e05c2ed84e 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillScenariosRequest.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillScenariosRequest.cpp @@ -4,72 +4,46 @@ */ #include -#include +#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; Aws::String ListBillScenariosRequest::SerializePayload() const { - Aws::Crt::Cbor::CborEncoder encoder; + JsonValue payload; - // Calculate map size - size_t mapSize = 0; if (m_filtersHasBeenSet) { - mapSize++; - } - if (m_createdAtFilterHasBeenSet) { - mapSize++; - } - if (m_expiresAtFilterHasBeenSet) { - mapSize++; - } - if (m_nextTokenHasBeenSet) { - mapSize++; - } - if (m_maxResultsHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); - - if (m_filtersHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("filters")); - encoder.WriteArrayStart(m_filters.size()); - for (const auto& item_0 : m_filters) { - item_0.CborEncode(encoder); + Aws::Utils::Array filtersJsonList(m_filters.size()); + for (unsigned filtersIndex = 0; filtersIndex < filtersJsonList.GetLength(); ++filtersIndex) { + filtersJsonList[filtersIndex].AsObject(m_filters[filtersIndex].Jsonize()); } + payload.WithArray("filters", std::move(filtersJsonList)); } if (m_createdAtFilterHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("createdAtFilter")); - m_createdAtFilter.CborEncode(encoder); + payload.WithObject("createdAtFilter", m_createdAtFilter.Jsonize()); } if (m_expiresAtFilterHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("expiresAtFilter")); - m_expiresAtFilter.CborEncode(encoder); + payload.WithObject("expiresAtFilter", m_expiresAtFilter.Jsonize()); } if (m_nextTokenHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("nextToken")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_nextToken.c_str())); + payload.WithString("nextToken", m_nextToken); } if (m_maxResultsHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("maxResults")); - (m_maxResults >= 0) ? encoder.WriteUInt(m_maxResults) : encoder.WriteNegInt(m_maxResults); + payload.WithInteger("maxResults", m_maxResults); } - const auto str = Aws::String(reinterpret_cast(encoder.GetEncodedData().ptr), encoder.GetEncodedData().len); - return str; + + return payload.View().WriteReadable(); } Aws::Http::HeaderValueCollection ListBillScenariosRequest::GetRequestSpecificHeaders() const { Aws::Http::HeaderValueCollection headers; - headers.emplace(Aws::Http::CONTENT_TYPE_HEADER, Aws::CBOR_CONTENT_TYPE); - headers.emplace(Aws::Http::SMITHY_PROTOCOL_HEADER, Aws::RPC_V2_CBOR); - headers.emplace(Aws::Http::ACCEPT_HEADER, Aws::CBOR_CONTENT_TYPE); + headers.insert(Aws::Http::HeaderValuePair("X-Amz-Target", "AWSBCMPricingCalculator.ListBillScenarios")); return headers; } diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillScenariosResult.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillScenariosResult.cpp index 77187521a9bb..10ad22da6f59 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillScenariosResult.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListBillScenariosResult.cpp @@ -7,190 +7,31 @@ #include #include #include -#include +#include #include -#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; -using namespace Aws::Utils::Cbor; using namespace Aws; -ListBillScenariosResult::ListBillScenariosResult(const Aws::AmazonWebServiceResult& result) { *this = result; } +ListBillScenariosResult::ListBillScenariosResult(const Aws::AmazonWebServiceResult& result) { *this = result; } -ListBillScenariosResult& ListBillScenariosResult::operator=(const Aws::AmazonWebServiceResult& result) { +ListBillScenariosResult& ListBillScenariosResult::operator=(const Aws::AmazonWebServiceResult& result) { m_HttpResponseCode = result.GetResponseCode(); - - const auto& cborValue = result.GetPayload(); - const auto decoder = cborValue.GetDecoder(); - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "items") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_items.push_back(BillScenarioSummary(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_items.push_back(BillScenarioSummary(decoder)); - } - } - } - m_itemsHasBeenSet = true; - } - - else if (initialKeyStr == "nextToken") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_nextToken = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_nextToken = ss.str(); - } - } - m_nextTokenHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("ListBillScenariosResult", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "items") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_items.push_back(BillScenarioSummary(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_items.push_back(BillScenarioSummary(decoder)); - } - } - } - m_itemsHasBeenSet = true; - } - - else if (initialKeyStr == "nextToken") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_nextToken = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_nextToken = ss.str(); - } - } - m_nextTokenHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } + JsonView jsonValue = result.GetPayload().View(); + if (jsonValue.ValueExists("items")) { + Aws::Utils::Array itemsJsonList = jsonValue.GetArray("items"); + for (unsigned itemsIndex = 0; itemsIndex < itemsJsonList.GetLength(); ++itemsIndex) { + m_items.push_back(itemsJsonList[itemsIndex].AsObject()); } + m_itemsHasBeenSet = true; + } + if (jsonValue.ValueExists("nextToken")) { + m_nextToken = jsonValue.GetString("nextToken"); + m_nextTokenHasBeenSet = true; } const auto& headers = result.GetHeaderValueCollection(); diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListTagsForResourceRequest.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListTagsForResourceRequest.cpp index 37a484e24509..9abe2defd570 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListTagsForResourceRequest.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListTagsForResourceRequest.cpp @@ -4,37 +4,26 @@ */ #include -#include +#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; Aws::String ListTagsForResourceRequest::SerializePayload() const { - Aws::Crt::Cbor::CborEncoder encoder; + JsonValue payload; - // Calculate map size - size_t mapSize = 0; if (m_arnHasBeenSet) { - mapSize++; + payload.WithString("arn", m_arn); } - encoder.WriteMapStart(mapSize); - - if (m_arnHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("arn")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_arn.c_str())); - } - const auto str = Aws::String(reinterpret_cast(encoder.GetEncodedData().ptr), encoder.GetEncodedData().len); - return str; + return payload.View().WriteReadable(); } Aws::Http::HeaderValueCollection ListTagsForResourceRequest::GetRequestSpecificHeaders() const { Aws::Http::HeaderValueCollection headers; - headers.emplace(Aws::Http::CONTENT_TYPE_HEADER, Aws::CBOR_CONTENT_TYPE); - headers.emplace(Aws::Http::SMITHY_PROTOCOL_HEADER, Aws::RPC_V2_CBOR); - headers.emplace(Aws::Http::ACCEPT_HEADER, Aws::CBOR_CONTENT_TYPE); + headers.insert(Aws::Http::HeaderValuePair("X-Amz-Target", "AWSBCMPricingCalculator.ListTagsForResource")); return headers; } diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListTagsForResourceResult.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListTagsForResourceResult.cpp index 895137e9140f..e77f4160cf5e 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListTagsForResourceResult.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListTagsForResourceResult.cpp @@ -7,250 +7,27 @@ #include #include #include -#include +#include #include -#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; -using namespace Aws::Utils::Cbor; using namespace Aws; -ListTagsForResourceResult::ListTagsForResourceResult(const Aws::AmazonWebServiceResult& result) { - *this = result; -} +ListTagsForResourceResult::ListTagsForResourceResult(const Aws::AmazonWebServiceResult& result) { *this = result; } -ListTagsForResourceResult& ListTagsForResourceResult::operator=(const Aws::AmazonWebServiceResult& result) { +ListTagsForResourceResult& ListTagsForResourceResult::operator=(const Aws::AmazonWebServiceResult& result) { m_HttpResponseCode = result.GetResponseCode(); - - const auto& cborValue = result.GetPayload(); - const auto decoder = cborValue.GetDecoder(); - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "tags") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && (peekType_0.value() == CborType::MapStart || peekType_0.value() == CborType::IndefMapStart)) { - if (peekType_0.value() == CborType::MapStart) { - auto mapSize_0 = decoder->PopNextMapStart(); - if (mapSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < mapSize_0.value(); j_0++) { - auto key_1 = decoder->PopNextTextVal(); - if (key_1.has_value()) { - Aws::String keyStr_1 = Aws::String(reinterpret_cast(key_1.value().ptr), key_1.value().len); - auto peekType_1 = decoder->PeekType(); - if (peekType_1) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_tags[keyStr_1] = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_tags[keyStr_1] = ss_1.str(); - ss_1.clear(); - } - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto key_1 = decoder->PopNextTextVal(); - if (key_1.has_value()) { - Aws::String keyStr_1 = Aws::String(reinterpret_cast(key_1.value().ptr), key_1.value().len); - auto peekType_1 = decoder->PeekType(); - if (peekType_1) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_tags[keyStr_1] = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_tags[keyStr_1] = ss_1.str(); - ss_1.clear(); - } - } - } - } - } - } - m_tagsHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("ListTagsForResourceResult", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "tags") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && (peekType_0.value() == CborType::MapStart || peekType_0.value() == CborType::IndefMapStart)) { - if (peekType_0.value() == CborType::MapStart) { - auto mapSize_0 = decoder->PopNextMapStart(); - if (mapSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < mapSize_0.value(); j_0++) { - auto key_1 = decoder->PopNextTextVal(); - if (key_1.has_value()) { - Aws::String keyStr_1 = Aws::String(reinterpret_cast(key_1.value().ptr), key_1.value().len); - auto peekType_1 = decoder->PeekType(); - if (peekType_1) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_tags[keyStr_1] = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_tags[keyStr_1] = ss_1.str(); - ss_1.clear(); - } - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto key_1 = decoder->PopNextTextVal(); - if (key_1.has_value()) { - Aws::String keyStr_1 = Aws::String(reinterpret_cast(key_1.value().ptr), key_1.value().len); - auto peekType_1 = decoder->PeekType(); - if (peekType_1) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_tags[keyStr_1] = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_tags[keyStr_1] = ss_1.str(); - ss_1.clear(); - } - } - } - } - } - } - m_tagsHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } + JsonView jsonValue = result.GetPayload().View(); + if (jsonValue.ValueExists("tags")) { + Aws::Map tagsJsonMap = jsonValue.GetObject("tags").GetAllObjects(); + for (auto& tagsItem : tagsJsonMap) { + m_tags[tagsItem.first] = tagsItem.second.AsString(); } + m_tagsHasBeenSet = true; } const auto& headers = result.GetHeaderValueCollection(); diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListUsageFilter.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListUsageFilter.cpp index f74184f280de..548ae264de7d 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListUsageFilter.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListUsageFilter.cpp @@ -4,300 +4,60 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -ListUsageFilter::ListUsageFilter(const std::shared_ptr& decoder) { *this = decoder; } +ListUsageFilter::ListUsageFilter(JsonView jsonValue) { *this = jsonValue; } -ListUsageFilter& ListUsageFilter::operator=(const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "name") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_name = ListUsageFilterNameMapper::GetListUsageFilterNameForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_nameHasBeenSet = true; - } - - else if (initialKeyStr == "values") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - auto peekType_1 = decoder->PeekType(); - if (peekType_1.has_value()) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_values.push_back(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_values.push_back(ss_1.str()); - ss_1.clear(); - } - } - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto peekType_1 = decoder->PeekType(); - if (peekType_1.has_value()) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_values.push_back(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_values.push_back(ss_1.str()); - ss_1.clear(); - } - } - } - } - } - m_valuesHasBeenSet = true; - } - - else if (initialKeyStr == "matchOption") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_matchOption = MatchOptionMapper::GetMatchOptionForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_matchOptionHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("ListUsageFilter", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "name") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_name = ListUsageFilterNameMapper::GetListUsageFilterNameForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_nameHasBeenSet = true; - } - - else if (initialKeyStr == "values") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - auto peekType_1 = decoder->PeekType(); - if (peekType_1.has_value()) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_values.push_back(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_values.push_back(ss_1.str()); - ss_1.clear(); - } - } - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto peekType_1 = decoder->PeekType(); - if (peekType_1.has_value()) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_values.push_back(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_values.push_back(ss_1.str()); - ss_1.clear(); - } - } - } - } - } - m_valuesHasBeenSet = true; - } - - else if (initialKeyStr == "matchOption") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_matchOption = - MatchOptionMapper::GetMatchOptionForName(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_matchOptionHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } +ListUsageFilter& ListUsageFilter::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("name")) { + m_name = ListUsageFilterNameMapper::GetListUsageFilterNameForName(jsonValue.GetString("name")); + m_nameHasBeenSet = true; + } + if (jsonValue.ValueExists("values")) { + Aws::Utils::Array valuesJsonList = jsonValue.GetArray("values"); + for (unsigned valuesIndex = 0; valuesIndex < valuesJsonList.GetLength(); ++valuesIndex) { + m_values.push_back(valuesJsonList[valuesIndex].AsString()); } + m_valuesHasBeenSet = true; + } + if (jsonValue.ValueExists("matchOption")) { + m_matchOption = MatchOptionMapper::GetMatchOptionForName(jsonValue.GetString("matchOption")); + m_matchOptionHasBeenSet = true; } - return *this; } -void ListUsageFilter::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_nameHasBeenSet) { - mapSize++; - } - if (m_valuesHasBeenSet) { - mapSize++; - } - if (m_matchOptionHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); +JsonValue ListUsageFilter::Jsonize() const { + JsonValue payload; if (m_nameHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("name")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(ListUsageFilterNameMapper::GetNameForListUsageFilterName(m_name).c_str())); + payload.WithString("name", ListUsageFilterNameMapper::GetNameForListUsageFilterName(m_name)); } if (m_valuesHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("values")); - encoder.WriteArrayStart(m_values.size()); - for (const auto& item_0 : m_values) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString(item_0.c_str())); + Aws::Utils::Array valuesJsonList(m_values.size()); + for (unsigned valuesIndex = 0; valuesIndex < valuesJsonList.GetLength(); ++valuesIndex) { + valuesJsonList[valuesIndex].AsString(m_values[valuesIndex]); } + payload.WithArray("values", std::move(valuesJsonList)); } if (m_matchOptionHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("matchOption")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(MatchOptionMapper::GetNameForMatchOption(m_matchOption).c_str())); + payload.WithString("matchOption", MatchOptionMapper::GetNameForMatchOption(m_matchOption)); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListWorkloadEstimateUsageRequest.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListWorkloadEstimateUsageRequest.cpp index 410b8e9f091b..2c1d87a17a2d 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListWorkloadEstimateUsageRequest.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListWorkloadEstimateUsageRequest.cpp @@ -4,64 +4,42 @@ */ #include -#include +#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; Aws::String ListWorkloadEstimateUsageRequest::SerializePayload() const { - Aws::Crt::Cbor::CborEncoder encoder; + JsonValue payload; - // Calculate map size - size_t mapSize = 0; if (m_workloadEstimateIdHasBeenSet) { - mapSize++; - } - if (m_filtersHasBeenSet) { - mapSize++; - } - if (m_nextTokenHasBeenSet) { - mapSize++; - } - if (m_maxResultsHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); - - if (m_workloadEstimateIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("workloadEstimateId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_workloadEstimateId.c_str())); + payload.WithString("workloadEstimateId", m_workloadEstimateId); } if (m_filtersHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("filters")); - encoder.WriteArrayStart(m_filters.size()); - for (const auto& item_0 : m_filters) { - item_0.CborEncode(encoder); + Aws::Utils::Array filtersJsonList(m_filters.size()); + for (unsigned filtersIndex = 0; filtersIndex < filtersJsonList.GetLength(); ++filtersIndex) { + filtersJsonList[filtersIndex].AsObject(m_filters[filtersIndex].Jsonize()); } + payload.WithArray("filters", std::move(filtersJsonList)); } if (m_nextTokenHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("nextToken")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_nextToken.c_str())); + payload.WithString("nextToken", m_nextToken); } if (m_maxResultsHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("maxResults")); - (m_maxResults >= 0) ? encoder.WriteUInt(m_maxResults) : encoder.WriteNegInt(m_maxResults); + payload.WithInteger("maxResults", m_maxResults); } - const auto str = Aws::String(reinterpret_cast(encoder.GetEncodedData().ptr), encoder.GetEncodedData().len); - return str; + + return payload.View().WriteReadable(); } Aws::Http::HeaderValueCollection ListWorkloadEstimateUsageRequest::GetRequestSpecificHeaders() const { Aws::Http::HeaderValueCollection headers; - headers.emplace(Aws::Http::CONTENT_TYPE_HEADER, Aws::CBOR_CONTENT_TYPE); - headers.emplace(Aws::Http::SMITHY_PROTOCOL_HEADER, Aws::RPC_V2_CBOR); - headers.emplace(Aws::Http::ACCEPT_HEADER, Aws::CBOR_CONTENT_TYPE); + headers.insert(Aws::Http::HeaderValuePair("X-Amz-Target", "AWSBCMPricingCalculator.ListWorkloadEstimateUsage")); return headers; } diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListWorkloadEstimateUsageResult.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListWorkloadEstimateUsageResult.cpp index 1a6c6400a24f..42d85e024f24 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListWorkloadEstimateUsageResult.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListWorkloadEstimateUsageResult.cpp @@ -7,193 +7,31 @@ #include #include #include -#include +#include #include -#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; -using namespace Aws::Utils::Cbor; using namespace Aws; -ListWorkloadEstimateUsageResult::ListWorkloadEstimateUsageResult(const Aws::AmazonWebServiceResult& result) { - *this = result; -} +ListWorkloadEstimateUsageResult::ListWorkloadEstimateUsageResult(const Aws::AmazonWebServiceResult& result) { *this = result; } -ListWorkloadEstimateUsageResult& ListWorkloadEstimateUsageResult::operator=( - const Aws::AmazonWebServiceResult& result) { +ListWorkloadEstimateUsageResult& ListWorkloadEstimateUsageResult::operator=(const Aws::AmazonWebServiceResult& result) { m_HttpResponseCode = result.GetResponseCode(); - - const auto& cborValue = result.GetPayload(); - const auto decoder = cborValue.GetDecoder(); - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "items") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_items.push_back(WorkloadEstimateUsageItem(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_items.push_back(WorkloadEstimateUsageItem(decoder)); - } - } - } - m_itemsHasBeenSet = true; - } - - else if (initialKeyStr == "nextToken") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_nextToken = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_nextToken = ss.str(); - } - } - m_nextTokenHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("ListWorkloadEstimateUsageResult", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "items") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_items.push_back(WorkloadEstimateUsageItem(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_items.push_back(WorkloadEstimateUsageItem(decoder)); - } - } - } - m_itemsHasBeenSet = true; - } - - else if (initialKeyStr == "nextToken") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_nextToken = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_nextToken = ss.str(); - } - } - m_nextTokenHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } + JsonView jsonValue = result.GetPayload().View(); + if (jsonValue.ValueExists("items")) { + Aws::Utils::Array itemsJsonList = jsonValue.GetArray("items"); + for (unsigned itemsIndex = 0; itemsIndex < itemsJsonList.GetLength(); ++itemsIndex) { + m_items.push_back(itemsJsonList[itemsIndex].AsObject()); } + m_itemsHasBeenSet = true; + } + if (jsonValue.ValueExists("nextToken")) { + m_nextToken = jsonValue.GetString("nextToken"); + m_nextTokenHasBeenSet = true; } const auto& headers = result.GetHeaderValueCollection(); diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListWorkloadEstimatesFilter.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListWorkloadEstimatesFilter.cpp index 1994eb4dcf71..c3fe2ebf2e18 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListWorkloadEstimatesFilter.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListWorkloadEstimatesFilter.cpp @@ -4,301 +4,60 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -ListWorkloadEstimatesFilter::ListWorkloadEstimatesFilter(const std::shared_ptr& decoder) { *this = decoder; } +ListWorkloadEstimatesFilter::ListWorkloadEstimatesFilter(JsonView jsonValue) { *this = jsonValue; } -ListWorkloadEstimatesFilter& ListWorkloadEstimatesFilter::operator=(const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "name") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_name = ListWorkloadEstimatesFilterNameMapper::GetListWorkloadEstimatesFilterNameForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_nameHasBeenSet = true; - } - - else if (initialKeyStr == "values") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - auto peekType_1 = decoder->PeekType(); - if (peekType_1.has_value()) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_values.push_back(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_values.push_back(ss_1.str()); - ss_1.clear(); - } - } - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto peekType_1 = decoder->PeekType(); - if (peekType_1.has_value()) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_values.push_back(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_values.push_back(ss_1.str()); - ss_1.clear(); - } - } - } - } - } - m_valuesHasBeenSet = true; - } - - else if (initialKeyStr == "matchOption") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_matchOption = MatchOptionMapper::GetMatchOptionForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_matchOptionHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("ListWorkloadEstimatesFilter", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "name") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_name = ListWorkloadEstimatesFilterNameMapper::GetListWorkloadEstimatesFilterNameForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_nameHasBeenSet = true; - } - - else if (initialKeyStr == "values") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - auto peekType_1 = decoder->PeekType(); - if (peekType_1.has_value()) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_values.push_back(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_values.push_back(ss_1.str()); - ss_1.clear(); - } - } - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto peekType_1 = decoder->PeekType(); - if (peekType_1.has_value()) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_values.push_back(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_values.push_back(ss_1.str()); - ss_1.clear(); - } - } - } - } - } - m_valuesHasBeenSet = true; - } - - else if (initialKeyStr == "matchOption") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_matchOption = - MatchOptionMapper::GetMatchOptionForName(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_matchOptionHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } +ListWorkloadEstimatesFilter& ListWorkloadEstimatesFilter::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("name")) { + m_name = ListWorkloadEstimatesFilterNameMapper::GetListWorkloadEstimatesFilterNameForName(jsonValue.GetString("name")); + m_nameHasBeenSet = true; + } + if (jsonValue.ValueExists("values")) { + Aws::Utils::Array valuesJsonList = jsonValue.GetArray("values"); + for (unsigned valuesIndex = 0; valuesIndex < valuesJsonList.GetLength(); ++valuesIndex) { + m_values.push_back(valuesJsonList[valuesIndex].AsString()); } + m_valuesHasBeenSet = true; + } + if (jsonValue.ValueExists("matchOption")) { + m_matchOption = MatchOptionMapper::GetMatchOptionForName(jsonValue.GetString("matchOption")); + m_matchOptionHasBeenSet = true; } - return *this; } -void ListWorkloadEstimatesFilter::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_nameHasBeenSet) { - mapSize++; - } - if (m_valuesHasBeenSet) { - mapSize++; - } - if (m_matchOptionHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); +JsonValue ListWorkloadEstimatesFilter::Jsonize() const { + JsonValue payload; if (m_nameHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("name")); - encoder.WriteText( - Aws::Crt::ByteCursorFromCString(ListWorkloadEstimatesFilterNameMapper::GetNameForListWorkloadEstimatesFilterName(m_name).c_str())); + payload.WithString("name", ListWorkloadEstimatesFilterNameMapper::GetNameForListWorkloadEstimatesFilterName(m_name)); } if (m_valuesHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("values")); - encoder.WriteArrayStart(m_values.size()); - for (const auto& item_0 : m_values) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString(item_0.c_str())); + Aws::Utils::Array valuesJsonList(m_values.size()); + for (unsigned valuesIndex = 0; valuesIndex < valuesJsonList.GetLength(); ++valuesIndex) { + valuesJsonList[valuesIndex].AsString(m_values[valuesIndex]); } + payload.WithArray("values", std::move(valuesJsonList)); } if (m_matchOptionHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("matchOption")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(MatchOptionMapper::GetNameForMatchOption(m_matchOption).c_str())); + payload.WithString("matchOption", MatchOptionMapper::GetNameForMatchOption(m_matchOption)); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListWorkloadEstimatesRequest.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListWorkloadEstimatesRequest.cpp index 7cda6fa7f790..aeef4fbca651 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListWorkloadEstimatesRequest.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListWorkloadEstimatesRequest.cpp @@ -4,72 +4,46 @@ */ #include -#include +#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; Aws::String ListWorkloadEstimatesRequest::SerializePayload() const { - Aws::Crt::Cbor::CborEncoder encoder; + JsonValue payload; - // Calculate map size - size_t mapSize = 0; if (m_createdAtFilterHasBeenSet) { - mapSize++; - } - if (m_expiresAtFilterHasBeenSet) { - mapSize++; - } - if (m_filtersHasBeenSet) { - mapSize++; - } - if (m_nextTokenHasBeenSet) { - mapSize++; - } - if (m_maxResultsHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); - - if (m_createdAtFilterHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("createdAtFilter")); - m_createdAtFilter.CborEncode(encoder); + payload.WithObject("createdAtFilter", m_createdAtFilter.Jsonize()); } if (m_expiresAtFilterHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("expiresAtFilter")); - m_expiresAtFilter.CborEncode(encoder); + payload.WithObject("expiresAtFilter", m_expiresAtFilter.Jsonize()); } if (m_filtersHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("filters")); - encoder.WriteArrayStart(m_filters.size()); - for (const auto& item_0 : m_filters) { - item_0.CborEncode(encoder); + Aws::Utils::Array filtersJsonList(m_filters.size()); + for (unsigned filtersIndex = 0; filtersIndex < filtersJsonList.GetLength(); ++filtersIndex) { + filtersJsonList[filtersIndex].AsObject(m_filters[filtersIndex].Jsonize()); } + payload.WithArray("filters", std::move(filtersJsonList)); } if (m_nextTokenHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("nextToken")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_nextToken.c_str())); + payload.WithString("nextToken", m_nextToken); } if (m_maxResultsHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("maxResults")); - (m_maxResults >= 0) ? encoder.WriteUInt(m_maxResults) : encoder.WriteNegInt(m_maxResults); + payload.WithInteger("maxResults", m_maxResults); } - const auto str = Aws::String(reinterpret_cast(encoder.GetEncodedData().ptr), encoder.GetEncodedData().len); - return str; + + return payload.View().WriteReadable(); } Aws::Http::HeaderValueCollection ListWorkloadEstimatesRequest::GetRequestSpecificHeaders() const { Aws::Http::HeaderValueCollection headers; - headers.emplace(Aws::Http::CONTENT_TYPE_HEADER, Aws::CBOR_CONTENT_TYPE); - headers.emplace(Aws::Http::SMITHY_PROTOCOL_HEADER, Aws::RPC_V2_CBOR); - headers.emplace(Aws::Http::ACCEPT_HEADER, Aws::CBOR_CONTENT_TYPE); + headers.insert(Aws::Http::HeaderValuePair("X-Amz-Target", "AWSBCMPricingCalculator.ListWorkloadEstimates")); return headers; } diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListWorkloadEstimatesResult.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListWorkloadEstimatesResult.cpp index 8a01600c6f5e..1fbe20b02815 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListWorkloadEstimatesResult.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ListWorkloadEstimatesResult.cpp @@ -7,193 +7,31 @@ #include #include #include -#include +#include #include -#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; -using namespace Aws::Utils::Cbor; using namespace Aws; -ListWorkloadEstimatesResult::ListWorkloadEstimatesResult(const Aws::AmazonWebServiceResult& result) { - *this = result; -} +ListWorkloadEstimatesResult::ListWorkloadEstimatesResult(const Aws::AmazonWebServiceResult& result) { *this = result; } -ListWorkloadEstimatesResult& ListWorkloadEstimatesResult::operator=( - const Aws::AmazonWebServiceResult& result) { +ListWorkloadEstimatesResult& ListWorkloadEstimatesResult::operator=(const Aws::AmazonWebServiceResult& result) { m_HttpResponseCode = result.GetResponseCode(); - - const auto& cborValue = result.GetPayload(); - const auto decoder = cborValue.GetDecoder(); - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "items") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_items.push_back(WorkloadEstimateSummary(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_items.push_back(WorkloadEstimateSummary(decoder)); - } - } - } - m_itemsHasBeenSet = true; - } - - else if (initialKeyStr == "nextToken") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_nextToken = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_nextToken = ss.str(); - } - } - m_nextTokenHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("ListWorkloadEstimatesResult", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "items") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_items.push_back(WorkloadEstimateSummary(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_items.push_back(WorkloadEstimateSummary(decoder)); - } - } - } - m_itemsHasBeenSet = true; - } - - else if (initialKeyStr == "nextToken") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_nextToken = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_nextToken = ss.str(); - } - } - m_nextTokenHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } + JsonView jsonValue = result.GetPayload().View(); + if (jsonValue.ValueExists("items")) { + Aws::Utils::Array itemsJsonList = jsonValue.GetArray("items"); + for (unsigned itemsIndex = 0; itemsIndex < itemsJsonList.GetLength(); ++itemsIndex) { + m_items.push_back(itemsJsonList[itemsIndex].AsObject()); } + m_itemsHasBeenSet = true; + } + if (jsonValue.ValueExists("nextToken")) { + m_nextToken = jsonValue.GetString("nextToken"); + m_nextTokenHasBeenSet = true; } const auto& headers = result.GetHeaderValueCollection(); diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/NegateReservedInstanceAction.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/NegateReservedInstanceAction.cpp index 9cf5f0fa688f..0a0701e73742 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/NegateReservedInstanceAction.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/NegateReservedInstanceAction.cpp @@ -4,143 +4,37 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -NegateReservedInstanceAction::NegateReservedInstanceAction(const std::shared_ptr& decoder) { *this = decoder; } +NegateReservedInstanceAction::NegateReservedInstanceAction(JsonView jsonValue) { *this = jsonValue; } -NegateReservedInstanceAction& NegateReservedInstanceAction::operator=(const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "reservedInstancesId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_reservedInstancesId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_reservedInstancesId = ss.str(); - } - } - m_reservedInstancesIdHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("NegateReservedInstanceAction", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "reservedInstancesId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_reservedInstancesId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_reservedInstancesId = ss.str(); - } - } - m_reservedInstancesIdHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } +NegateReservedInstanceAction& NegateReservedInstanceAction::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("reservedInstancesId")) { + m_reservedInstancesId = jsonValue.GetString("reservedInstancesId"); + m_reservedInstancesIdHasBeenSet = true; } - return *this; } -void NegateReservedInstanceAction::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_reservedInstancesIdHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); +JsonValue NegateReservedInstanceAction::Jsonize() const { + JsonValue payload; if (m_reservedInstancesIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("reservedInstancesId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_reservedInstancesId.c_str())); + payload.WithString("reservedInstancesId", m_reservedInstancesId); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/NegateSavingsPlanAction.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/NegateSavingsPlanAction.cpp index c7b897ad7be3..4b1dd1100249 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/NegateSavingsPlanAction.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/NegateSavingsPlanAction.cpp @@ -4,143 +4,37 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -NegateSavingsPlanAction::NegateSavingsPlanAction(const std::shared_ptr& decoder) { *this = decoder; } +NegateSavingsPlanAction::NegateSavingsPlanAction(JsonView jsonValue) { *this = jsonValue; } -NegateSavingsPlanAction& NegateSavingsPlanAction::operator=(const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "savingsPlanId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_savingsPlanId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_savingsPlanId = ss.str(); - } - } - m_savingsPlanIdHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("NegateSavingsPlanAction", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "savingsPlanId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_savingsPlanId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_savingsPlanId = ss.str(); - } - } - m_savingsPlanIdHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } +NegateSavingsPlanAction& NegateSavingsPlanAction::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("savingsPlanId")) { + m_savingsPlanId = jsonValue.GetString("savingsPlanId"); + m_savingsPlanIdHasBeenSet = true; } - return *this; } -void NegateSavingsPlanAction::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_savingsPlanIdHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); +JsonValue NegateSavingsPlanAction::Jsonize() const { + JsonValue payload; if (m_savingsPlanIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("savingsPlanId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_savingsPlanId.c_str())); + payload.WithString("savingsPlanId", m_savingsPlanId); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ResourceNotFoundException.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ResourceNotFoundException.cpp index 23e7042cbdc6..f7359b39ef79 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ResourceNotFoundException.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ResourceNotFoundException.cpp @@ -4,279 +4,53 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -ResourceNotFoundException::ResourceNotFoundException(const std::shared_ptr& decoder) { *this = decoder; } +ResourceNotFoundException::ResourceNotFoundException(JsonView jsonValue) { *this = jsonValue; } -ResourceNotFoundException& ResourceNotFoundException::operator=(const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "message") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_message = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_message = ss.str(); - } - } - m_messageHasBeenSet = true; - } - - else if (initialKeyStr == "resourceId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_resourceId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_resourceId = ss.str(); - } - } - m_resourceIdHasBeenSet = true; - } - - else if (initialKeyStr == "resourceType") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_resourceType = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_resourceType = ss.str(); - } - } - m_resourceTypeHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("ResourceNotFoundException", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "message") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_message = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_message = ss.str(); - } - } - m_messageHasBeenSet = true; - } - - else if (initialKeyStr == "resourceId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_resourceId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_resourceId = ss.str(); - } - } - m_resourceIdHasBeenSet = true; - } - - else if (initialKeyStr == "resourceType") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_resourceType = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_resourceType = ss.str(); - } - } - m_resourceTypeHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } - } - - return *this; -} - -void ResourceNotFoundException::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_messageHasBeenSet) { - mapSize++; +ResourceNotFoundException& ResourceNotFoundException::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("message")) { + m_message = jsonValue.GetString("message"); + m_messageHasBeenSet = true; } - if (m_resourceIdHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("resourceId")) { + m_resourceId = jsonValue.GetString("resourceId"); + m_resourceIdHasBeenSet = true; } - if (m_resourceTypeHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("resourceType")) { + m_resourceType = jsonValue.GetString("resourceType"); + m_resourceTypeHasBeenSet = true; } + return *this; +} - encoder.WriteMapStart(mapSize); +JsonValue ResourceNotFoundException::Jsonize() const { + JsonValue payload; if (m_messageHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("message")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_message.c_str())); + payload.WithString("message", m_message); } if (m_resourceIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("resourceId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_resourceId.c_str())); + payload.WithString("resourceId", m_resourceId); } if (m_resourceTypeHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("resourceType")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_resourceType.c_str())); + payload.WithString("resourceType", m_resourceType); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ServiceQuotaExceededException.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ServiceQuotaExceededException.cpp index 1a2775aa7c27..b8f9066d44ec 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ServiceQuotaExceededException.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ServiceQuotaExceededException.cpp @@ -4,417 +4,69 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -ServiceQuotaExceededException::ServiceQuotaExceededException(const std::shared_ptr& decoder) { - *this = decoder; -} - -ServiceQuotaExceededException& ServiceQuotaExceededException::operator=(const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "message") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_message = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_message = ss.str(); - } - } - m_messageHasBeenSet = true; - } - - else if (initialKeyStr == "resourceId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_resourceId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_resourceId = ss.str(); - } - } - m_resourceIdHasBeenSet = true; - } - - else if (initialKeyStr == "resourceType") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_resourceType = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_resourceType = ss.str(); - } - } - m_resourceTypeHasBeenSet = true; - } - - else if (initialKeyStr == "serviceCode") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_serviceCode = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_serviceCode = ss.str(); - } - } - m_serviceCodeHasBeenSet = true; - } - - else if (initialKeyStr == "quotaCode") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_quotaCode = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_quotaCode = ss.str(); - } - } - m_quotaCodeHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("ServiceQuotaExceededException", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } +ServiceQuotaExceededException::ServiceQuotaExceededException(JsonView jsonValue) { *this = jsonValue; } - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "message") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_message = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_message = ss.str(); - } - } - m_messageHasBeenSet = true; - } - - else if (initialKeyStr == "resourceId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_resourceId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_resourceId = ss.str(); - } - } - m_resourceIdHasBeenSet = true; - } - - else if (initialKeyStr == "resourceType") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_resourceType = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_resourceType = ss.str(); - } - } - m_resourceTypeHasBeenSet = true; - } - - else if (initialKeyStr == "serviceCode") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_serviceCode = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_serviceCode = ss.str(); - } - } - m_serviceCodeHasBeenSet = true; - } - - else if (initialKeyStr == "quotaCode") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_quotaCode = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_quotaCode = ss.str(); - } - } - m_quotaCodeHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } +ServiceQuotaExceededException& ServiceQuotaExceededException::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("message")) { + m_message = jsonValue.GetString("message"); + m_messageHasBeenSet = true; } - - return *this; -} - -void ServiceQuotaExceededException::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_messageHasBeenSet) { - mapSize++; - } - if (m_resourceIdHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("resourceId")) { + m_resourceId = jsonValue.GetString("resourceId"); + m_resourceIdHasBeenSet = true; } - if (m_resourceTypeHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("resourceType")) { + m_resourceType = jsonValue.GetString("resourceType"); + m_resourceTypeHasBeenSet = true; } - if (m_serviceCodeHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("serviceCode")) { + m_serviceCode = jsonValue.GetString("serviceCode"); + m_serviceCodeHasBeenSet = true; } - if (m_quotaCodeHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("quotaCode")) { + m_quotaCode = jsonValue.GetString("quotaCode"); + m_quotaCodeHasBeenSet = true; } + return *this; +} - encoder.WriteMapStart(mapSize); +JsonValue ServiceQuotaExceededException::Jsonize() const { + JsonValue payload; if (m_messageHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("message")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_message.c_str())); + payload.WithString("message", m_message); } if (m_resourceIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("resourceId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_resourceId.c_str())); + payload.WithString("resourceId", m_resourceId); } if (m_resourceTypeHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("resourceType")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_resourceType.c_str())); + payload.WithString("resourceType", m_resourceType); } if (m_serviceCodeHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("serviceCode")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_serviceCode.c_str())); + payload.WithString("serviceCode", m_serviceCode); } if (m_quotaCodeHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("quotaCode")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_quotaCode.c_str())); + payload.WithString("quotaCode", m_quotaCode); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/TagResourceRequest.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/TagResourceRequest.cpp index 317aa32371fb..733c27fb9dc9 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/TagResourceRequest.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/TagResourceRequest.cpp @@ -4,49 +4,34 @@ */ #include -#include +#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; Aws::String TagResourceRequest::SerializePayload() const { - Aws::Crt::Cbor::CborEncoder encoder; + JsonValue payload; - // Calculate map size - size_t mapSize = 0; if (m_arnHasBeenSet) { - mapSize++; - } - if (m_tagsHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); - - if (m_arnHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("arn")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_arn.c_str())); + payload.WithString("arn", m_arn); } if (m_tagsHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("tags")); - encoder.WriteMapStart(m_tags.size()); - for (const auto& item_0 : m_tags) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString(item_0.first.c_str())); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(item_0.second.c_str())); + JsonValue tagsJsonMap; + for (auto& tagsItem : m_tags) { + tagsJsonMap.WithString(tagsItem.first, tagsItem.second); } + payload.WithObject("tags", std::move(tagsJsonMap)); } - const auto str = Aws::String(reinterpret_cast(encoder.GetEncodedData().ptr), encoder.GetEncodedData().len); - return str; + + return payload.View().WriteReadable(); } Aws::Http::HeaderValueCollection TagResourceRequest::GetRequestSpecificHeaders() const { Aws::Http::HeaderValueCollection headers; - headers.emplace(Aws::Http::CONTENT_TYPE_HEADER, Aws::CBOR_CONTENT_TYPE); - headers.emplace(Aws::Http::SMITHY_PROTOCOL_HEADER, Aws::RPC_V2_CBOR); - headers.emplace(Aws::Http::ACCEPT_HEADER, Aws::CBOR_CONTENT_TYPE); + headers.insert(Aws::Http::HeaderValuePair("X-Amz-Target", "AWSBCMPricingCalculator.TagResource")); return headers; } diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/TagResourceResult.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/TagResourceResult.cpp index 77f155d3f38e..d385e130ec3c 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/TagResourceResult.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/TagResourceResult.cpp @@ -7,23 +7,21 @@ #include #include #include -#include +#include #include -#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; -using namespace Aws::Utils::Cbor; using namespace Aws; -TagResourceResult::TagResourceResult(const Aws::AmazonWebServiceResult& result) { *this = result; } +TagResourceResult::TagResourceResult(const Aws::AmazonWebServiceResult& result) { *this = result; } -TagResourceResult& TagResourceResult::operator=(const Aws::AmazonWebServiceResult& result) { +TagResourceResult& TagResourceResult::operator=(const Aws::AmazonWebServiceResult& result) { m_HttpResponseCode = result.GetResponseCode(); + AWS_UNREFERENCED_PARAM(result); const auto& headers = result.GetHeaderValueCollection(); const auto& requestIdIter = headers.find("x-amzn-requestid"); diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ThrottlingException.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ThrottlingException.cpp index 6c1eb46a4bac..2730b7fb2d45 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ThrottlingException.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ThrottlingException.cpp @@ -4,323 +4,61 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -ThrottlingException::ThrottlingException(const std::shared_ptr& decoder) { *this = decoder; } +ThrottlingException::ThrottlingException(JsonView jsonValue) { *this = jsonValue; } -ThrottlingException& ThrottlingException::operator=(const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "message") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_message = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_message = ss.str(); - } - } - m_messageHasBeenSet = true; - } - - else if (initialKeyStr == "serviceCode") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_serviceCode = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_serviceCode = ss.str(); - } - } - m_serviceCodeHasBeenSet = true; - } - - else if (initialKeyStr == "quotaCode") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_quotaCode = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_quotaCode = ss.str(); - } - } - m_quotaCodeHasBeenSet = true; - } - - else if (initialKeyStr == "retryAfterSeconds") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::UInt) { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_retryAfterSeconds = static_cast(val.value()); - } - } else { - auto val = decoder->PopNextNegativeIntVal(); - if (val.has_value()) { - m_retryAfterSeconds = static_cast(1 - val.value()); - } - } - } - m_retryAfterSecondsHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("ThrottlingException", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "message") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_message = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_message = ss.str(); - } - } - m_messageHasBeenSet = true; - } - - else if (initialKeyStr == "serviceCode") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_serviceCode = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_serviceCode = ss.str(); - } - } - m_serviceCodeHasBeenSet = true; - } - - else if (initialKeyStr == "quotaCode") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_quotaCode = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_quotaCode = ss.str(); - } - } - m_quotaCodeHasBeenSet = true; - } - - else if (initialKeyStr == "retryAfterSeconds") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::UInt) { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_retryAfterSeconds = static_cast(val.value()); - } - } else { - auto val = decoder->PopNextNegativeIntVal(); - if (val.has_value()) { - m_retryAfterSeconds = static_cast(1 - val.value()); - } - } - } - m_retryAfterSecondsHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } +ThrottlingException& ThrottlingException::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("message")) { + m_message = jsonValue.GetString("message"); + m_messageHasBeenSet = true; } - - return *this; -} - -void ThrottlingException::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_messageHasBeenSet) { - mapSize++; - } - if (m_serviceCodeHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("serviceCode")) { + m_serviceCode = jsonValue.GetString("serviceCode"); + m_serviceCodeHasBeenSet = true; } - if (m_quotaCodeHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("quotaCode")) { + m_quotaCode = jsonValue.GetString("quotaCode"); + m_quotaCodeHasBeenSet = true; } - if (m_retryAfterSecondsHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("retryAfterSeconds")) { + m_retryAfterSeconds = jsonValue.GetInteger("retryAfterSeconds"); + m_retryAfterSecondsHasBeenSet = true; } + return *this; +} - encoder.WriteMapStart(mapSize); +JsonValue ThrottlingException::Jsonize() const { + JsonValue payload; if (m_messageHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("message")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_message.c_str())); + payload.WithString("message", m_message); } if (m_serviceCodeHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("serviceCode")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_serviceCode.c_str())); + payload.WithString("serviceCode", m_serviceCode); } if (m_quotaCodeHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("quotaCode")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_quotaCode.c_str())); + payload.WithString("quotaCode", m_quotaCode); } if (m_retryAfterSecondsHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("retryAfterSeconds")); - (m_retryAfterSeconds >= 0) ? encoder.WriteUInt(m_retryAfterSeconds) : encoder.WriteNegInt(m_retryAfterSeconds); + payload.WithInteger("retryAfterSeconds", m_retryAfterSeconds); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UntagResourceRequest.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UntagResourceRequest.cpp index 1098c78a0910..fb75b7417d1c 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UntagResourceRequest.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UntagResourceRequest.cpp @@ -4,48 +4,34 @@ */ #include -#include +#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; Aws::String UntagResourceRequest::SerializePayload() const { - Aws::Crt::Cbor::CborEncoder encoder; + JsonValue payload; - // Calculate map size - size_t mapSize = 0; if (m_arnHasBeenSet) { - mapSize++; - } - if (m_tagKeysHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); - - if (m_arnHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("arn")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_arn.c_str())); + payload.WithString("arn", m_arn); } if (m_tagKeysHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("tagKeys")); - encoder.WriteArrayStart(m_tagKeys.size()); - for (const auto& item_0 : m_tagKeys) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString(item_0.c_str())); + Aws::Utils::Array tagKeysJsonList(m_tagKeys.size()); + for (unsigned tagKeysIndex = 0; tagKeysIndex < tagKeysJsonList.GetLength(); ++tagKeysIndex) { + tagKeysJsonList[tagKeysIndex].AsString(m_tagKeys[tagKeysIndex]); } + payload.WithArray("tagKeys", std::move(tagKeysJsonList)); } - const auto str = Aws::String(reinterpret_cast(encoder.GetEncodedData().ptr), encoder.GetEncodedData().len); - return str; + + return payload.View().WriteReadable(); } Aws::Http::HeaderValueCollection UntagResourceRequest::GetRequestSpecificHeaders() const { Aws::Http::HeaderValueCollection headers; - headers.emplace(Aws::Http::CONTENT_TYPE_HEADER, Aws::CBOR_CONTENT_TYPE); - headers.emplace(Aws::Http::SMITHY_PROTOCOL_HEADER, Aws::RPC_V2_CBOR); - headers.emplace(Aws::Http::ACCEPT_HEADER, Aws::CBOR_CONTENT_TYPE); + headers.insert(Aws::Http::HeaderValuePair("X-Amz-Target", "AWSBCMPricingCalculator.UntagResource")); return headers; } diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UntagResourceResult.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UntagResourceResult.cpp index 9559232814f5..f49abc4f5edd 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UntagResourceResult.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UntagResourceResult.cpp @@ -7,23 +7,21 @@ #include #include #include -#include +#include #include -#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; -using namespace Aws::Utils::Cbor; using namespace Aws; -UntagResourceResult::UntagResourceResult(const Aws::AmazonWebServiceResult& result) { *this = result; } +UntagResourceResult::UntagResourceResult(const Aws::AmazonWebServiceResult& result) { *this = result; } -UntagResourceResult& UntagResourceResult::operator=(const Aws::AmazonWebServiceResult& result) { +UntagResourceResult& UntagResourceResult::operator=(const Aws::AmazonWebServiceResult& result) { m_HttpResponseCode = result.GetResponseCode(); + AWS_UNREFERENCED_PARAM(result); const auto& headers = result.GetHeaderValueCollection(); const auto& requestIdIter = headers.find("x-amzn-requestid"); diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UpdateBillEstimateRequest.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UpdateBillEstimateRequest.cpp index ba5976e5ba98..f38da0628d5f 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UpdateBillEstimateRequest.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UpdateBillEstimateRequest.cpp @@ -4,54 +4,34 @@ */ #include -#include +#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; Aws::String UpdateBillEstimateRequest::SerializePayload() const { - Aws::Crt::Cbor::CborEncoder encoder; + JsonValue payload; - // Calculate map size - size_t mapSize = 0; if (m_identifierHasBeenSet) { - mapSize++; - } - if (m_nameHasBeenSet) { - mapSize++; - } - if (m_expiresAtHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); - - if (m_identifierHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("identifier")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_identifier.c_str())); + payload.WithString("identifier", m_identifier); } if (m_nameHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("name")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_name.c_str())); + payload.WithString("name", m_name); } if (m_expiresAtHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("expiresAt")); - encoder.WriteTag(1); // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - encoder.WriteUInt(m_expiresAt.Seconds()); + payload.WithDouble("expiresAt", m_expiresAt.SecondsWithMSPrecision()); } - const auto str = Aws::String(reinterpret_cast(encoder.GetEncodedData().ptr), encoder.GetEncodedData().len); - return str; + + return payload.View().WriteReadable(); } Aws::Http::HeaderValueCollection UpdateBillEstimateRequest::GetRequestSpecificHeaders() const { Aws::Http::HeaderValueCollection headers; - headers.emplace(Aws::Http::CONTENT_TYPE_HEADER, Aws::CBOR_CONTENT_TYPE); - headers.emplace(Aws::Http::SMITHY_PROTOCOL_HEADER, Aws::RPC_V2_CBOR); - headers.emplace(Aws::Http::ACCEPT_HEADER, Aws::CBOR_CONTENT_TYPE); + headers.insert(Aws::Http::HeaderValuePair("X-Amz-Target", "AWSBCMPricingCalculator.UpdateBillEstimate")); return headers; } diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UpdateBillEstimateResult.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UpdateBillEstimateResult.cpp index c98120ef498f..dea3b954d667 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UpdateBillEstimateResult.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UpdateBillEstimateResult.cpp @@ -7,509 +7,65 @@ #include #include #include -#include +#include #include -#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; -using namespace Aws::Utils::Cbor; using namespace Aws; -UpdateBillEstimateResult::UpdateBillEstimateResult(const Aws::AmazonWebServiceResult& result) { - *this = result; -} +UpdateBillEstimateResult::UpdateBillEstimateResult(const Aws::AmazonWebServiceResult& result) { *this = result; } -UpdateBillEstimateResult& UpdateBillEstimateResult::operator=(const Aws::AmazonWebServiceResult& result) { +UpdateBillEstimateResult& UpdateBillEstimateResult::operator=(const Aws::AmazonWebServiceResult& result) { m_HttpResponseCode = result.GetResponseCode(); - - const auto& cborValue = result.GetPayload(); - const auto decoder = cborValue.GetDecoder(); - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "name") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_name = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_name = ss.str(); - } - } - m_nameHasBeenSet = true; - } - - else if (initialKeyStr == "status") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_status = BillEstimateStatusMapper::GetBillEstimateStatusForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_statusHasBeenSet = true; - } - - else if (initialKeyStr == "failureMessage") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_failureMessage = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_failureMessage = ss.str(); - } - } - m_failureMessageHasBeenSet = true; - } - - else if (initialKeyStr == "billInterval") { - m_billInterval = BillInterval(decoder); - m_billIntervalHasBeenSet = true; - } - - else if (initialKeyStr == "costSummary") { - m_costSummary = BillEstimateCostSummary(decoder); - m_costSummaryHasBeenSet = true; - } - - else if (initialKeyStr == "createdAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_createdAtHasBeenSet = true; - } - - else if (initialKeyStr == "expiresAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_expiresAtHasBeenSet = true; - } - - else if (initialKeyStr == "groupSharingPreference") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_groupSharingPreference = GroupSharingPreferenceEnumMapper::GetGroupSharingPreferenceEnumForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_groupSharingPreferenceHasBeenSet = true; - } - - else if (initialKeyStr == "costCategoryGroupSharingPreferenceArn") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_costCategoryGroupSharingPreferenceArn = - Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_costCategoryGroupSharingPreferenceArn = ss.str(); - } - } - m_costCategoryGroupSharingPreferenceArnHasBeenSet = true; - } - - else if (initialKeyStr == "costCategoryGroupSharingPreferenceEffectiveDate") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_costCategoryGroupSharingPreferenceEffectiveDate = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_costCategoryGroupSharingPreferenceEffectiveDate = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_costCategoryGroupSharingPreferenceEffectiveDateHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("UpdateBillEstimateResult", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "name") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_name = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_name = ss.str(); - } - } - m_nameHasBeenSet = true; - } - - else if (initialKeyStr == "status") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_status = BillEstimateStatusMapper::GetBillEstimateStatusForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_statusHasBeenSet = true; - } - - else if (initialKeyStr == "failureMessage") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_failureMessage = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_failureMessage = ss.str(); - } - } - m_failureMessageHasBeenSet = true; - } - - else if (initialKeyStr == "billInterval") { - m_billInterval = BillInterval(decoder); - m_billIntervalHasBeenSet = true; - } - - else if (initialKeyStr == "costSummary") { - m_costSummary = BillEstimateCostSummary(decoder); - m_costSummaryHasBeenSet = true; - } - - else if (initialKeyStr == "createdAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_createdAtHasBeenSet = true; - } - - else if (initialKeyStr == "expiresAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_expiresAtHasBeenSet = true; - } - - else if (initialKeyStr == "groupSharingPreference") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_groupSharingPreference = GroupSharingPreferenceEnumMapper::GetGroupSharingPreferenceEnumForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_groupSharingPreferenceHasBeenSet = true; - } - - else if (initialKeyStr == "costCategoryGroupSharingPreferenceArn") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_costCategoryGroupSharingPreferenceArn = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_costCategoryGroupSharingPreferenceArn = ss.str(); - } - } - m_costCategoryGroupSharingPreferenceArnHasBeenSet = true; - } - - else if (initialKeyStr == "costCategoryGroupSharingPreferenceEffectiveDate") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_costCategoryGroupSharingPreferenceEffectiveDate = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_costCategoryGroupSharingPreferenceEffectiveDate = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_costCategoryGroupSharingPreferenceEffectiveDateHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } + JsonView jsonValue = result.GetPayload().View(); + if (jsonValue.ValueExists("id")) { + m_id = jsonValue.GetString("id"); + m_idHasBeenSet = true; + } + if (jsonValue.ValueExists("name")) { + m_name = jsonValue.GetString("name"); + m_nameHasBeenSet = true; + } + if (jsonValue.ValueExists("status")) { + m_status = BillEstimateStatusMapper::GetBillEstimateStatusForName(jsonValue.GetString("status")); + m_statusHasBeenSet = true; + } + if (jsonValue.ValueExists("failureMessage")) { + m_failureMessage = jsonValue.GetString("failureMessage"); + m_failureMessageHasBeenSet = true; + } + if (jsonValue.ValueExists("billInterval")) { + m_billInterval = jsonValue.GetObject("billInterval"); + m_billIntervalHasBeenSet = true; + } + if (jsonValue.ValueExists("costSummary")) { + m_costSummary = jsonValue.GetObject("costSummary"); + m_costSummaryHasBeenSet = true; + } + if (jsonValue.ValueExists("createdAt")) { + m_createdAt = jsonValue.GetDouble("createdAt"); + m_createdAtHasBeenSet = true; + } + if (jsonValue.ValueExists("expiresAt")) { + m_expiresAt = jsonValue.GetDouble("expiresAt"); + m_expiresAtHasBeenSet = true; + } + if (jsonValue.ValueExists("groupSharingPreference")) { + m_groupSharingPreference = + GroupSharingPreferenceEnumMapper::GetGroupSharingPreferenceEnumForName(jsonValue.GetString("groupSharingPreference")); + m_groupSharingPreferenceHasBeenSet = true; + } + if (jsonValue.ValueExists("costCategoryGroupSharingPreferenceArn")) { + m_costCategoryGroupSharingPreferenceArn = jsonValue.GetString("costCategoryGroupSharingPreferenceArn"); + m_costCategoryGroupSharingPreferenceArnHasBeenSet = true; + } + if (jsonValue.ValueExists("costCategoryGroupSharingPreferenceEffectiveDate")) { + m_costCategoryGroupSharingPreferenceEffectiveDate = jsonValue.GetDouble("costCategoryGroupSharingPreferenceEffectiveDate"); + m_costCategoryGroupSharingPreferenceEffectiveDateHasBeenSet = true; } const auto& headers = result.GetHeaderValueCollection(); diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UpdateBillScenarioRequest.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UpdateBillScenarioRequest.cpp index ba24ba405d8b..2db0c5036cce 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UpdateBillScenarioRequest.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UpdateBillScenarioRequest.cpp @@ -4,71 +4,43 @@ */ #include -#include +#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; Aws::String UpdateBillScenarioRequest::SerializePayload() const { - Aws::Crt::Cbor::CborEncoder encoder; + JsonValue payload; - // Calculate map size - size_t mapSize = 0; if (m_identifierHasBeenSet) { - mapSize++; - } - if (m_nameHasBeenSet) { - mapSize++; - } - if (m_expiresAtHasBeenSet) { - mapSize++; - } - if (m_groupSharingPreferenceHasBeenSet) { - mapSize++; - } - if (m_costCategoryGroupSharingPreferenceArnHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); - - if (m_identifierHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("identifier")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_identifier.c_str())); + payload.WithString("identifier", m_identifier); } if (m_nameHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("name")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_name.c_str())); + payload.WithString("name", m_name); } if (m_expiresAtHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("expiresAt")); - encoder.WriteTag(1); // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - encoder.WriteUInt(m_expiresAt.Seconds()); + payload.WithDouble("expiresAt", m_expiresAt.SecondsWithMSPrecision()); } if (m_groupSharingPreferenceHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("groupSharingPreference")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString( - GroupSharingPreferenceEnumMapper::GetNameForGroupSharingPreferenceEnum(m_groupSharingPreference).c_str())); + payload.WithString("groupSharingPreference", + GroupSharingPreferenceEnumMapper::GetNameForGroupSharingPreferenceEnum(m_groupSharingPreference)); } if (m_costCategoryGroupSharingPreferenceArnHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("costCategoryGroupSharingPreferenceArn")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_costCategoryGroupSharingPreferenceArn.c_str())); + payload.WithString("costCategoryGroupSharingPreferenceArn", m_costCategoryGroupSharingPreferenceArn); } - const auto str = Aws::String(reinterpret_cast(encoder.GetEncodedData().ptr), encoder.GetEncodedData().len); - return str; + + return payload.View().WriteReadable(); } Aws::Http::HeaderValueCollection UpdateBillScenarioRequest::GetRequestSpecificHeaders() const { Aws::Http::HeaderValueCollection headers; - headers.emplace(Aws::Http::CONTENT_TYPE_HEADER, Aws::CBOR_CONTENT_TYPE); - headers.emplace(Aws::Http::SMITHY_PROTOCOL_HEADER, Aws::RPC_V2_CBOR); - headers.emplace(Aws::Http::ACCEPT_HEADER, Aws::CBOR_CONTENT_TYPE); + headers.insert(Aws::Http::HeaderValuePair("X-Amz-Target", "AWSBCMPricingCalculator.UpdateBillScenario")); return headers; } diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UpdateBillScenarioResult.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UpdateBillScenarioResult.cpp index b0844edb99bb..54e86ae490bc 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UpdateBillScenarioResult.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UpdateBillScenarioResult.cpp @@ -7,453 +7,57 @@ #include #include #include -#include +#include #include -#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; -using namespace Aws::Utils::Cbor; using namespace Aws; -UpdateBillScenarioResult::UpdateBillScenarioResult(const Aws::AmazonWebServiceResult& result) { - *this = result; -} +UpdateBillScenarioResult::UpdateBillScenarioResult(const Aws::AmazonWebServiceResult& result) { *this = result; } -UpdateBillScenarioResult& UpdateBillScenarioResult::operator=(const Aws::AmazonWebServiceResult& result) { +UpdateBillScenarioResult& UpdateBillScenarioResult::operator=(const Aws::AmazonWebServiceResult& result) { m_HttpResponseCode = result.GetResponseCode(); - - const auto& cborValue = result.GetPayload(); - const auto decoder = cborValue.GetDecoder(); - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "name") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_name = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_name = ss.str(); - } - } - m_nameHasBeenSet = true; - } - - else if (initialKeyStr == "billInterval") { - m_billInterval = BillInterval(decoder); - m_billIntervalHasBeenSet = true; - } - - else if (initialKeyStr == "status") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_status = BillScenarioStatusMapper::GetBillScenarioStatusForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_statusHasBeenSet = true; - } - - else if (initialKeyStr == "createdAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_createdAtHasBeenSet = true; - } - - else if (initialKeyStr == "expiresAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_expiresAtHasBeenSet = true; - } - - else if (initialKeyStr == "failureMessage") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_failureMessage = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_failureMessage = ss.str(); - } - } - m_failureMessageHasBeenSet = true; - } - - else if (initialKeyStr == "groupSharingPreference") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_groupSharingPreference = GroupSharingPreferenceEnumMapper::GetGroupSharingPreferenceEnumForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_groupSharingPreferenceHasBeenSet = true; - } - - else if (initialKeyStr == "costCategoryGroupSharingPreferenceArn") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_costCategoryGroupSharingPreferenceArn = - Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_costCategoryGroupSharingPreferenceArn = ss.str(); - } - } - m_costCategoryGroupSharingPreferenceArnHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("UpdateBillScenarioResult", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "name") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_name = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_name = ss.str(); - } - } - m_nameHasBeenSet = true; - } - - else if (initialKeyStr == "billInterval") { - m_billInterval = BillInterval(decoder); - m_billIntervalHasBeenSet = true; - } - - else if (initialKeyStr == "status") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_status = BillScenarioStatusMapper::GetBillScenarioStatusForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_statusHasBeenSet = true; - } - - else if (initialKeyStr == "createdAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_createdAtHasBeenSet = true; - } - - else if (initialKeyStr == "expiresAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_expiresAtHasBeenSet = true; - } - - else if (initialKeyStr == "failureMessage") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_failureMessage = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_failureMessage = ss.str(); - } - } - m_failureMessageHasBeenSet = true; - } - - else if (initialKeyStr == "groupSharingPreference") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_groupSharingPreference = GroupSharingPreferenceEnumMapper::GetGroupSharingPreferenceEnumForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_groupSharingPreferenceHasBeenSet = true; - } - - else if (initialKeyStr == "costCategoryGroupSharingPreferenceArn") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_costCategoryGroupSharingPreferenceArn = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_costCategoryGroupSharingPreferenceArn = ss.str(); - } - } - m_costCategoryGroupSharingPreferenceArnHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } + JsonView jsonValue = result.GetPayload().View(); + if (jsonValue.ValueExists("id")) { + m_id = jsonValue.GetString("id"); + m_idHasBeenSet = true; + } + if (jsonValue.ValueExists("name")) { + m_name = jsonValue.GetString("name"); + m_nameHasBeenSet = true; + } + if (jsonValue.ValueExists("billInterval")) { + m_billInterval = jsonValue.GetObject("billInterval"); + m_billIntervalHasBeenSet = true; + } + if (jsonValue.ValueExists("status")) { + m_status = BillScenarioStatusMapper::GetBillScenarioStatusForName(jsonValue.GetString("status")); + m_statusHasBeenSet = true; + } + if (jsonValue.ValueExists("createdAt")) { + m_createdAt = jsonValue.GetDouble("createdAt"); + m_createdAtHasBeenSet = true; + } + if (jsonValue.ValueExists("expiresAt")) { + m_expiresAt = jsonValue.GetDouble("expiresAt"); + m_expiresAtHasBeenSet = true; + } + if (jsonValue.ValueExists("failureMessage")) { + m_failureMessage = jsonValue.GetString("failureMessage"); + m_failureMessageHasBeenSet = true; + } + if (jsonValue.ValueExists("groupSharingPreference")) { + m_groupSharingPreference = + GroupSharingPreferenceEnumMapper::GetGroupSharingPreferenceEnumForName(jsonValue.GetString("groupSharingPreference")); + m_groupSharingPreferenceHasBeenSet = true; + } + if (jsonValue.ValueExists("costCategoryGroupSharingPreferenceArn")) { + m_costCategoryGroupSharingPreferenceArn = jsonValue.GetString("costCategoryGroupSharingPreferenceArn"); + m_costCategoryGroupSharingPreferenceArnHasBeenSet = true; } const auto& headers = result.GetHeaderValueCollection(); diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UpdatePreferencesRequest.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UpdatePreferencesRequest.cpp index 69b75715ddc3..3b4a9302f69a 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UpdatePreferencesRequest.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UpdatePreferencesRequest.cpp @@ -4,62 +4,55 @@ */ #include -#include +#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; Aws::String UpdatePreferencesRequest::SerializePayload() const { - Aws::Crt::Cbor::CborEncoder encoder; + JsonValue payload; - // Calculate map size - size_t mapSize = 0; if (m_managementAccountRateTypeSelectionsHasBeenSet) { - mapSize++; - } - if (m_memberAccountRateTypeSelectionsHasBeenSet) { - mapSize++; - } - if (m_standaloneAccountRateTypeSelectionsHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); - - if (m_managementAccountRateTypeSelectionsHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("managementAccountRateTypeSelections")); - encoder.WriteArrayStart(m_managementAccountRateTypeSelections.size()); - for (const auto& item_0 : m_managementAccountRateTypeSelections) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString(RateTypeMapper::GetNameForRateType(item_0).c_str())); + Aws::Utils::Array managementAccountRateTypeSelectionsJsonList(m_managementAccountRateTypeSelections.size()); + for (unsigned managementAccountRateTypeSelectionsIndex = 0; + managementAccountRateTypeSelectionsIndex < managementAccountRateTypeSelectionsJsonList.GetLength(); + ++managementAccountRateTypeSelectionsIndex) { + managementAccountRateTypeSelectionsJsonList[managementAccountRateTypeSelectionsIndex].AsString( + RateTypeMapper::GetNameForRateType(m_managementAccountRateTypeSelections[managementAccountRateTypeSelectionsIndex])); } + payload.WithArray("managementAccountRateTypeSelections", std::move(managementAccountRateTypeSelectionsJsonList)); } if (m_memberAccountRateTypeSelectionsHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("memberAccountRateTypeSelections")); - encoder.WriteArrayStart(m_memberAccountRateTypeSelections.size()); - for (const auto& item_0 : m_memberAccountRateTypeSelections) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString(RateTypeMapper::GetNameForRateType(item_0).c_str())); + Aws::Utils::Array memberAccountRateTypeSelectionsJsonList(m_memberAccountRateTypeSelections.size()); + for (unsigned memberAccountRateTypeSelectionsIndex = 0; + memberAccountRateTypeSelectionsIndex < memberAccountRateTypeSelectionsJsonList.GetLength(); + ++memberAccountRateTypeSelectionsIndex) { + memberAccountRateTypeSelectionsJsonList[memberAccountRateTypeSelectionsIndex].AsString( + RateTypeMapper::GetNameForRateType(m_memberAccountRateTypeSelections[memberAccountRateTypeSelectionsIndex])); } + payload.WithArray("memberAccountRateTypeSelections", std::move(memberAccountRateTypeSelectionsJsonList)); } if (m_standaloneAccountRateTypeSelectionsHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("standaloneAccountRateTypeSelections")); - encoder.WriteArrayStart(m_standaloneAccountRateTypeSelections.size()); - for (const auto& item_0 : m_standaloneAccountRateTypeSelections) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString(RateTypeMapper::GetNameForRateType(item_0).c_str())); + Aws::Utils::Array standaloneAccountRateTypeSelectionsJsonList(m_standaloneAccountRateTypeSelections.size()); + for (unsigned standaloneAccountRateTypeSelectionsIndex = 0; + standaloneAccountRateTypeSelectionsIndex < standaloneAccountRateTypeSelectionsJsonList.GetLength(); + ++standaloneAccountRateTypeSelectionsIndex) { + standaloneAccountRateTypeSelectionsJsonList[standaloneAccountRateTypeSelectionsIndex].AsString( + RateTypeMapper::GetNameForRateType(m_standaloneAccountRateTypeSelections[standaloneAccountRateTypeSelectionsIndex])); } + payload.WithArray("standaloneAccountRateTypeSelections", std::move(standaloneAccountRateTypeSelectionsJsonList)); } - const auto str = Aws::String(reinterpret_cast(encoder.GetEncodedData().ptr), encoder.GetEncodedData().len); - return str; + + return payload.View().WriteReadable(); } Aws::Http::HeaderValueCollection UpdatePreferencesRequest::GetRequestSpecificHeaders() const { Aws::Http::HeaderValueCollection headers; - headers.emplace(Aws::Http::CONTENT_TYPE_HEADER, Aws::CBOR_CONTENT_TYPE); - headers.emplace(Aws::Http::SMITHY_PROTOCOL_HEADER, Aws::RPC_V2_CBOR); - headers.emplace(Aws::Http::ACCEPT_HEADER, Aws::CBOR_CONTENT_TYPE); + headers.insert(Aws::Http::HeaderValuePair("X-Amz-Target", "AWSBCMPricingCalculator.UpdatePreferences")); return headers; } diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UpdatePreferencesResult.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UpdatePreferencesResult.cpp index 57d660026eab..15c91332aa71 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UpdatePreferencesResult.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UpdatePreferencesResult.cpp @@ -7,294 +7,50 @@ #include #include #include -#include +#include #include -#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; -using namespace Aws::Utils::Cbor; using namespace Aws; -UpdatePreferencesResult::UpdatePreferencesResult(const Aws::AmazonWebServiceResult& result) { *this = result; } +UpdatePreferencesResult::UpdatePreferencesResult(const Aws::AmazonWebServiceResult& result) { *this = result; } -UpdatePreferencesResult& UpdatePreferencesResult::operator=(const Aws::AmazonWebServiceResult& result) { +UpdatePreferencesResult& UpdatePreferencesResult::operator=(const Aws::AmazonWebServiceResult& result) { m_HttpResponseCode = result.GetResponseCode(); - - const auto& cborValue = result.GetPayload(); - const auto decoder = cborValue.GetDecoder(); - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "managementAccountRateTypeSelections") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_managementAccountRateTypeSelections.push_back(RateTypeMapper::GetRateTypeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len))); - } - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_managementAccountRateTypeSelections.push_back(RateTypeMapper::GetRateTypeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len))); - } - } - } - } - m_managementAccountRateTypeSelectionsHasBeenSet = true; - } - - else if (initialKeyStr == "memberAccountRateTypeSelections") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_memberAccountRateTypeSelections.push_back(RateTypeMapper::GetRateTypeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len))); - } - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_memberAccountRateTypeSelections.push_back(RateTypeMapper::GetRateTypeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len))); - } - } - } - } - m_memberAccountRateTypeSelectionsHasBeenSet = true; - } - - else if (initialKeyStr == "standaloneAccountRateTypeSelections") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_standaloneAccountRateTypeSelections.push_back(RateTypeMapper::GetRateTypeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len))); - } - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_standaloneAccountRateTypeSelections.push_back(RateTypeMapper::GetRateTypeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len))); - } - } - } - } - m_standaloneAccountRateTypeSelectionsHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("UpdatePreferencesResult", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "managementAccountRateTypeSelections") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_managementAccountRateTypeSelections.push_back(RateTypeMapper::GetRateTypeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len))); - } - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_managementAccountRateTypeSelections.push_back( - RateTypeMapper::GetRateTypeForName(Aws::String(reinterpret_cast(val.value().ptr), val.value().len))); - } - } - } - } - m_managementAccountRateTypeSelectionsHasBeenSet = true; - } - - else if (initialKeyStr == "memberAccountRateTypeSelections") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_memberAccountRateTypeSelections.push_back(RateTypeMapper::GetRateTypeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len))); - } - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_memberAccountRateTypeSelections.push_back( - RateTypeMapper::GetRateTypeForName(Aws::String(reinterpret_cast(val.value().ptr), val.value().len))); - } - } - } - } - m_memberAccountRateTypeSelectionsHasBeenSet = true; - } - - else if (initialKeyStr == "standaloneAccountRateTypeSelections") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_standaloneAccountRateTypeSelections.push_back(RateTypeMapper::GetRateTypeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len))); - } - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_standaloneAccountRateTypeSelections.push_back( - RateTypeMapper::GetRateTypeForName(Aws::String(reinterpret_cast(val.value().ptr), val.value().len))); - } - } - } - } - m_standaloneAccountRateTypeSelectionsHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } + JsonView jsonValue = result.GetPayload().View(); + if (jsonValue.ValueExists("managementAccountRateTypeSelections")) { + Aws::Utils::Array managementAccountRateTypeSelectionsJsonList = jsonValue.GetArray("managementAccountRateTypeSelections"); + for (unsigned managementAccountRateTypeSelectionsIndex = 0; + managementAccountRateTypeSelectionsIndex < managementAccountRateTypeSelectionsJsonList.GetLength(); + ++managementAccountRateTypeSelectionsIndex) { + m_managementAccountRateTypeSelections.push_back(RateTypeMapper::GetRateTypeForName( + managementAccountRateTypeSelectionsJsonList[managementAccountRateTypeSelectionsIndex].AsString())); + } + m_managementAccountRateTypeSelectionsHasBeenSet = true; + } + if (jsonValue.ValueExists("memberAccountRateTypeSelections")) { + Aws::Utils::Array memberAccountRateTypeSelectionsJsonList = jsonValue.GetArray("memberAccountRateTypeSelections"); + for (unsigned memberAccountRateTypeSelectionsIndex = 0; + memberAccountRateTypeSelectionsIndex < memberAccountRateTypeSelectionsJsonList.GetLength(); + ++memberAccountRateTypeSelectionsIndex) { + m_memberAccountRateTypeSelections.push_back( + RateTypeMapper::GetRateTypeForName(memberAccountRateTypeSelectionsJsonList[memberAccountRateTypeSelectionsIndex].AsString())); + } + m_memberAccountRateTypeSelectionsHasBeenSet = true; + } + if (jsonValue.ValueExists("standaloneAccountRateTypeSelections")) { + Aws::Utils::Array standaloneAccountRateTypeSelectionsJsonList = jsonValue.GetArray("standaloneAccountRateTypeSelections"); + for (unsigned standaloneAccountRateTypeSelectionsIndex = 0; + standaloneAccountRateTypeSelectionsIndex < standaloneAccountRateTypeSelectionsJsonList.GetLength(); + ++standaloneAccountRateTypeSelectionsIndex) { + m_standaloneAccountRateTypeSelections.push_back(RateTypeMapper::GetRateTypeForName( + standaloneAccountRateTypeSelectionsJsonList[standaloneAccountRateTypeSelectionsIndex].AsString())); } + m_standaloneAccountRateTypeSelectionsHasBeenSet = true; } const auto& headers = result.GetHeaderValueCollection(); diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UpdateWorkloadEstimateRequest.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UpdateWorkloadEstimateRequest.cpp index f579936d88b3..ad77b958e7de 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UpdateWorkloadEstimateRequest.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UpdateWorkloadEstimateRequest.cpp @@ -4,54 +4,34 @@ */ #include -#include +#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; Aws::String UpdateWorkloadEstimateRequest::SerializePayload() const { - Aws::Crt::Cbor::CborEncoder encoder; + JsonValue payload; - // Calculate map size - size_t mapSize = 0; if (m_identifierHasBeenSet) { - mapSize++; - } - if (m_nameHasBeenSet) { - mapSize++; - } - if (m_expiresAtHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); - - if (m_identifierHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("identifier")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_identifier.c_str())); + payload.WithString("identifier", m_identifier); } if (m_nameHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("name")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_name.c_str())); + payload.WithString("name", m_name); } if (m_expiresAtHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("expiresAt")); - encoder.WriteTag(1); // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - encoder.WriteUInt(m_expiresAt.Seconds()); + payload.WithDouble("expiresAt", m_expiresAt.SecondsWithMSPrecision()); } - const auto str = Aws::String(reinterpret_cast(encoder.GetEncodedData().ptr), encoder.GetEncodedData().len); - return str; + + return payload.View().WriteReadable(); } Aws::Http::HeaderValueCollection UpdateWorkloadEstimateRequest::GetRequestSpecificHeaders() const { Aws::Http::HeaderValueCollection headers; - headers.emplace(Aws::Http::CONTENT_TYPE_HEADER, Aws::CBOR_CONTENT_TYPE); - headers.emplace(Aws::Http::SMITHY_PROTOCOL_HEADER, Aws::RPC_V2_CBOR); - headers.emplace(Aws::Http::ACCEPT_HEADER, Aws::CBOR_CONTENT_TYPE); + headers.insert(Aws::Http::HeaderValuePair("X-Amz-Target", "AWSBCMPricingCalculator.UpdateWorkloadEstimate")); return headers; } diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UpdateWorkloadEstimateResult.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UpdateWorkloadEstimateResult.cpp index 8b24981a0e0a..23c65383a059 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UpdateWorkloadEstimateResult.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UpdateWorkloadEstimateResult.cpp @@ -7,463 +7,60 @@ #include #include #include -#include +#include #include -#include #include using namespace Aws::BCMPricingCalculator::Model; -using namespace Aws::Crt; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; -using namespace Aws::Utils::Cbor; using namespace Aws; -UpdateWorkloadEstimateResult::UpdateWorkloadEstimateResult(const Aws::AmazonWebServiceResult& result) { - *this = result; -} +UpdateWorkloadEstimateResult::UpdateWorkloadEstimateResult(const Aws::AmazonWebServiceResult& result) { *this = result; } -UpdateWorkloadEstimateResult& UpdateWorkloadEstimateResult::operator=( - const Aws::AmazonWebServiceResult& result) { +UpdateWorkloadEstimateResult& UpdateWorkloadEstimateResult::operator=(const Aws::AmazonWebServiceResult& result) { m_HttpResponseCode = result.GetResponseCode(); - - const auto& cborValue = result.GetPayload(); - const auto decoder = cborValue.GetDecoder(); - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "name") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_name = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_name = ss.str(); - } - } - m_nameHasBeenSet = true; - } - - else if (initialKeyStr == "createdAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_createdAtHasBeenSet = true; - } - - else if (initialKeyStr == "expiresAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_expiresAtHasBeenSet = true; - } - - else if (initialKeyStr == "rateType") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_rateType = WorkloadEstimateRateTypeMapper::GetWorkloadEstimateRateTypeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_rateTypeHasBeenSet = true; - } - - else if (initialKeyStr == "rateTimestamp") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_rateTimestamp = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_rateTimestamp = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_rateTimestampHasBeenSet = true; - } - - else if (initialKeyStr == "status") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_status = WorkloadEstimateStatusMapper::GetWorkloadEstimateStatusForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_statusHasBeenSet = true; - } - - else if (initialKeyStr == "totalCost") { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_totalCost = val.value(); - } - m_totalCostHasBeenSet = true; - } - - else if (initialKeyStr == "costCurrency") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_costCurrency = CurrencyCodeMapper::GetCurrencyCodeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_costCurrencyHasBeenSet = true; - } - - else if (initialKeyStr == "failureMessage") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_failureMessage = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_failureMessage = ss.str(); - } - } - m_failureMessageHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("UpdateWorkloadEstimateResult", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "name") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_name = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_name = ss.str(); - } - } - m_nameHasBeenSet = true; - } - - else if (initialKeyStr == "createdAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_createdAtHasBeenSet = true; - } - - else if (initialKeyStr == "expiresAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_expiresAtHasBeenSet = true; - } - - else if (initialKeyStr == "rateType") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_rateType = WorkloadEstimateRateTypeMapper::GetWorkloadEstimateRateTypeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_rateTypeHasBeenSet = true; - } - - else if (initialKeyStr == "rateTimestamp") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_rateTimestamp = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_rateTimestamp = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_rateTimestampHasBeenSet = true; - } - - else if (initialKeyStr == "status") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_status = WorkloadEstimateStatusMapper::GetWorkloadEstimateStatusForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_statusHasBeenSet = true; - } - - else if (initialKeyStr == "totalCost") { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_totalCost = val.value(); - } - m_totalCostHasBeenSet = true; - } - - else if (initialKeyStr == "costCurrency") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_costCurrency = CurrencyCodeMapper::GetCurrencyCodeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_costCurrencyHasBeenSet = true; - } - - else if (initialKeyStr == "failureMessage") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_failureMessage = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_failureMessage = ss.str(); - } - } - m_failureMessageHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } + JsonView jsonValue = result.GetPayload().View(); + if (jsonValue.ValueExists("id")) { + m_id = jsonValue.GetString("id"); + m_idHasBeenSet = true; + } + if (jsonValue.ValueExists("name")) { + m_name = jsonValue.GetString("name"); + m_nameHasBeenSet = true; + } + if (jsonValue.ValueExists("createdAt")) { + m_createdAt = jsonValue.GetDouble("createdAt"); + m_createdAtHasBeenSet = true; + } + if (jsonValue.ValueExists("expiresAt")) { + m_expiresAt = jsonValue.GetDouble("expiresAt"); + m_expiresAtHasBeenSet = true; + } + if (jsonValue.ValueExists("rateType")) { + m_rateType = WorkloadEstimateRateTypeMapper::GetWorkloadEstimateRateTypeForName(jsonValue.GetString("rateType")); + m_rateTypeHasBeenSet = true; + } + if (jsonValue.ValueExists("rateTimestamp")) { + m_rateTimestamp = jsonValue.GetDouble("rateTimestamp"); + m_rateTimestampHasBeenSet = true; + } + if (jsonValue.ValueExists("status")) { + m_status = WorkloadEstimateStatusMapper::GetWorkloadEstimateStatusForName(jsonValue.GetString("status")); + m_statusHasBeenSet = true; + } + if (jsonValue.ValueExists("totalCost")) { + m_totalCost = jsonValue.GetDouble("totalCost"); + m_totalCostHasBeenSet = true; + } + if (jsonValue.ValueExists("costCurrency")) { + m_costCurrency = CurrencyCodeMapper::GetCurrencyCodeForName(jsonValue.GetString("costCurrency")); + m_costCurrencyHasBeenSet = true; + } + if (jsonValue.ValueExists("failureMessage")) { + m_failureMessage = jsonValue.GetString("failureMessage"); + m_failureMessageHasBeenSet = true; } const auto& headers = result.GetHeaderValueCollection(); diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UsageAmount.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UsageAmount.cpp index c590aa888109..0bf339e51ac6 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UsageAmount.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UsageAmount.cpp @@ -4,154 +4,45 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -UsageAmount::UsageAmount(const std::shared_ptr& decoder) { *this = decoder; } +UsageAmount::UsageAmount(JsonView jsonValue) { *this = jsonValue; } -UsageAmount& UsageAmount::operator=(const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "startHour") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_startHour = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_startHour = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_startHourHasBeenSet = true; - } - - else if (initialKeyStr == "amount") { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_amount = val.value(); - } - m_amountHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("UsageAmount", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "startHour") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_startHour = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_startHour = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_startHourHasBeenSet = true; - } - - else if (initialKeyStr == "amount") { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_amount = val.value(); - } - m_amountHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } +UsageAmount& UsageAmount::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("startHour")) { + m_startHour = jsonValue.GetDouble("startHour"); + m_startHourHasBeenSet = true; + } + if (jsonValue.ValueExists("amount")) { + m_amount = jsonValue.GetDouble("amount"); + m_amountHasBeenSet = true; } - return *this; } -void UsageAmount::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_startHourHasBeenSet) { - mapSize++; - } - if (m_amountHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); +JsonValue UsageAmount::Jsonize() const { + JsonValue payload; if (m_startHourHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("startHour")); - encoder.WriteTag(1); // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - encoder.WriteUInt(m_startHour.Seconds()); + payload.WithDouble("startHour", m_startHour.SecondsWithMSPrecision()); } if (m_amountHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("amount")); - encoder.WriteFloat(m_amount); + payload.WithDouble("amount", m_amount); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UsageQuantity.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UsageQuantity.cpp index 6b45de74fab8..d8337cbc98ef 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UsageQuantity.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UsageQuantity.cpp @@ -4,222 +4,53 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -UsageQuantity::UsageQuantity(const std::shared_ptr& decoder) { *this = decoder; } +UsageQuantity::UsageQuantity(JsonView jsonValue) { *this = jsonValue; } -UsageQuantity& UsageQuantity::operator=(const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "startHour") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_startHour = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_startHour = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_startHourHasBeenSet = true; - } - - else if (initialKeyStr == "unit") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_unit = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_unit = ss.str(); - } - } - m_unitHasBeenSet = true; - } - - else if (initialKeyStr == "amount") { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_amount = val.value(); - } - m_amountHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("UsageQuantity", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "startHour") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_startHour = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_startHour = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_startHourHasBeenSet = true; - } - - else if (initialKeyStr == "unit") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_unit = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_unit = ss.str(); - } - } - m_unitHasBeenSet = true; - } - - else if (initialKeyStr == "amount") { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_amount = val.value(); - } - m_amountHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } - } - - return *this; -} - -void UsageQuantity::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_startHourHasBeenSet) { - mapSize++; +UsageQuantity& UsageQuantity::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("startHour")) { + m_startHour = jsonValue.GetDouble("startHour"); + m_startHourHasBeenSet = true; } - if (m_unitHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("unit")) { + m_unit = jsonValue.GetString("unit"); + m_unitHasBeenSet = true; } - if (m_amountHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("amount")) { + m_amount = jsonValue.GetDouble("amount"); + m_amountHasBeenSet = true; } + return *this; +} - encoder.WriteMapStart(mapSize); +JsonValue UsageQuantity::Jsonize() const { + JsonValue payload; if (m_startHourHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("startHour")); - encoder.WriteTag(1); // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - encoder.WriteUInt(m_startHour.Seconds()); + payload.WithDouble("startHour", m_startHour.SecondsWithMSPrecision()); } if (m_unitHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("unit")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_unit.c_str())); + payload.WithString("unit", m_unit); } if (m_amountHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("amount")); - encoder.WriteFloat(m_amount); + payload.WithDouble("amount", m_amount); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UsageQuantityResult.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UsageQuantityResult.cpp index bb6ac7fe6d92..9e9d79a8d307 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UsageQuantityResult.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/UsageQuantityResult.cpp @@ -4,167 +4,45 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -UsageQuantityResult::UsageQuantityResult(const std::shared_ptr& decoder) { *this = decoder; } +UsageQuantityResult::UsageQuantityResult(JsonView jsonValue) { *this = jsonValue; } -UsageQuantityResult& UsageQuantityResult::operator=(const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "amount") { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_amount = val.value(); - } - m_amountHasBeenSet = true; - } - - else if (initialKeyStr == "unit") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_unit = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_unit = ss.str(); - } - } - m_unitHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("UsageQuantityResult", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "amount") { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_amount = val.value(); - } - m_amountHasBeenSet = true; - } - - else if (initialKeyStr == "unit") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_unit = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_unit = ss.str(); - } - } - m_unitHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } +UsageQuantityResult& UsageQuantityResult::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("amount")) { + m_amount = jsonValue.GetDouble("amount"); + m_amountHasBeenSet = true; + } + if (jsonValue.ValueExists("unit")) { + m_unit = jsonValue.GetString("unit"); + m_unitHasBeenSet = true; } - return *this; } -void UsageQuantityResult::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_amountHasBeenSet) { - mapSize++; - } - if (m_unitHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); +JsonValue UsageQuantityResult::Jsonize() const { + JsonValue payload; if (m_amountHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("amount")); - encoder.WriteFloat(m_amount); + payload.WithDouble("amount", m_amount); } if (m_unitHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("unit")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_unit.c_str())); + payload.WithString("unit", m_unit); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ValidationException.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ValidationException.cpp index 9282633cc155..2dce24aa3e60 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ValidationException.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ValidationException.cpp @@ -4,239 +4,60 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -ValidationException::ValidationException(const std::shared_ptr& decoder) { *this = decoder; } +ValidationException::ValidationException(JsonView jsonValue) { *this = jsonValue; } -ValidationException& ValidationException::operator=(const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "message") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_message = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_message = ss.str(); - } - } - m_messageHasBeenSet = true; - } - - else if (initialKeyStr == "reason") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_reason = ValidationExceptionReasonMapper::GetValidationExceptionReasonForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_reasonHasBeenSet = true; - } - - else if (initialKeyStr == "fieldList") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_fieldList.push_back(ValidationExceptionField(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_fieldList.push_back(ValidationExceptionField(decoder)); - } - } - } - m_fieldListHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("ValidationException", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "message") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_message = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_message = ss.str(); - } - } - m_messageHasBeenSet = true; - } - - else if (initialKeyStr == "reason") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_reason = ValidationExceptionReasonMapper::GetValidationExceptionReasonForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_reasonHasBeenSet = true; - } - - else if (initialKeyStr == "fieldList") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_fieldList.push_back(ValidationExceptionField(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_fieldList.push_back(ValidationExceptionField(decoder)); - } - } - } - m_fieldListHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } +ValidationException& ValidationException::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("message")) { + m_message = jsonValue.GetString("message"); + m_messageHasBeenSet = true; + } + if (jsonValue.ValueExists("reason")) { + m_reason = ValidationExceptionReasonMapper::GetValidationExceptionReasonForName(jsonValue.GetString("reason")); + m_reasonHasBeenSet = true; + } + if (jsonValue.ValueExists("fieldList")) { + Aws::Utils::Array fieldListJsonList = jsonValue.GetArray("fieldList"); + for (unsigned fieldListIndex = 0; fieldListIndex < fieldListJsonList.GetLength(); ++fieldListIndex) { + m_fieldList.push_back(fieldListJsonList[fieldListIndex].AsObject()); } + m_fieldListHasBeenSet = true; } - return *this; } -void ValidationException::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_messageHasBeenSet) { - mapSize++; - } - if (m_reasonHasBeenSet) { - mapSize++; - } - if (m_fieldListHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); +JsonValue ValidationException::Jsonize() const { + JsonValue payload; if (m_messageHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("message")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_message.c_str())); + payload.WithString("message", m_message); } if (m_reasonHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("reason")); - encoder.WriteText( - Aws::Crt::ByteCursorFromCString(ValidationExceptionReasonMapper::GetNameForValidationExceptionReason(m_reason).c_str())); + payload.WithString("reason", ValidationExceptionReasonMapper::GetNameForValidationExceptionReason(m_reason)); } if (m_fieldListHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("fieldList")); - encoder.WriteArrayStart(m_fieldList.size()); - for (const auto& item_0 : m_fieldList) { - item_0.CborEncode(encoder); + Aws::Utils::Array fieldListJsonList(m_fieldList.size()); + for (unsigned fieldListIndex = 0; fieldListIndex < fieldListJsonList.GetLength(); ++fieldListIndex) { + fieldListJsonList[fieldListIndex].AsObject(m_fieldList[fieldListIndex].Jsonize()); } + payload.WithArray("fieldList", std::move(fieldListJsonList)); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ValidationExceptionField.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ValidationExceptionField.cpp index 700af1eb8027..2074e29c7a9c 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ValidationExceptionField.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/ValidationExceptionField.cpp @@ -4,211 +4,45 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -ValidationExceptionField::ValidationExceptionField(const std::shared_ptr& decoder) { *this = decoder; } +ValidationExceptionField::ValidationExceptionField(JsonView jsonValue) { *this = jsonValue; } -ValidationExceptionField& ValidationExceptionField::operator=(const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "name") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_name = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_name = ss.str(); - } - } - m_nameHasBeenSet = true; - } - - else if (initialKeyStr == "message") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_message = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_message = ss.str(); - } - } - m_messageHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("ValidationExceptionField", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "name") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_name = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_name = ss.str(); - } - } - m_nameHasBeenSet = true; - } - - else if (initialKeyStr == "message") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_message = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_message = ss.str(); - } - } - m_messageHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } +ValidationExceptionField& ValidationExceptionField::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("name")) { + m_name = jsonValue.GetString("name"); + m_nameHasBeenSet = true; + } + if (jsonValue.ValueExists("message")) { + m_message = jsonValue.GetString("message"); + m_messageHasBeenSet = true; } - return *this; } -void ValidationExceptionField::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_nameHasBeenSet) { - mapSize++; - } - if (m_messageHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); +JsonValue ValidationExceptionField::Jsonize() const { + JsonValue payload; if (m_nameHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("name")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_name.c_str())); + payload.WithString("name", m_name); } if (m_messageHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("message")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_message.c_str())); + payload.WithString("message", m_message); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/WorkloadEstimateSummary.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/WorkloadEstimateSummary.cpp index 48455b4e6834..539a94b6d49a 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/WorkloadEstimateSummary.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/WorkloadEstimateSummary.cpp @@ -4,547 +4,109 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -WorkloadEstimateSummary::WorkloadEstimateSummary(const std::shared_ptr& decoder) { *this = decoder; } +WorkloadEstimateSummary::WorkloadEstimateSummary(JsonView jsonValue) { *this = jsonValue; } -WorkloadEstimateSummary& WorkloadEstimateSummary::operator=(const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "name") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_name = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_name = ss.str(); - } - } - m_nameHasBeenSet = true; - } - - else if (initialKeyStr == "createdAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_createdAtHasBeenSet = true; - } - - else if (initialKeyStr == "expiresAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_expiresAtHasBeenSet = true; - } - - else if (initialKeyStr == "rateType") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_rateType = WorkloadEstimateRateTypeMapper::GetWorkloadEstimateRateTypeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_rateTypeHasBeenSet = true; - } - - else if (initialKeyStr == "rateTimestamp") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_rateTimestamp = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_rateTimestamp = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_rateTimestampHasBeenSet = true; - } - - else if (initialKeyStr == "status") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_status = WorkloadEstimateStatusMapper::GetWorkloadEstimateStatusForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_statusHasBeenSet = true; - } - - else if (initialKeyStr == "totalCost") { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_totalCost = val.value(); - } - m_totalCostHasBeenSet = true; - } - - else if (initialKeyStr == "costCurrency") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_costCurrency = CurrencyCodeMapper::GetCurrencyCodeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_costCurrencyHasBeenSet = true; - } - - else if (initialKeyStr == "failureMessage") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_failureMessage = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_failureMessage = ss.str(); - } - } - m_failureMessageHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("WorkloadEstimateSummary", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "name") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_name = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_name = ss.str(); - } - } - m_nameHasBeenSet = true; - } - - else if (initialKeyStr == "createdAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_createdAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_createdAtHasBeenSet = true; - } - - else if (initialKeyStr == "expiresAt") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_expiresAt = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_expiresAtHasBeenSet = true; - } - - else if (initialKeyStr == "rateType") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_rateType = WorkloadEstimateRateTypeMapper::GetWorkloadEstimateRateTypeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_rateTypeHasBeenSet = true; - } - - else if (initialKeyStr == "rateTimestamp") { - auto tag = decoder->PopNextTagVal(); - if (tag.has_value() && - tag.value() == 1) // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - { - auto dateType = decoder->PeekType(); - if (dateType.has_value()) { - if (dateType.value() == Aws::Crt::Cbor::CborType::Float) { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_rateTimestamp = Aws::Utils::DateTime(val.value()); - } - } else { - auto val = decoder->PopNextUnsignedIntVal(); - if (val.has_value()) { - m_rateTimestamp = Aws::Utils::DateTime(val.value()); - } - } - } - } - m_rateTimestampHasBeenSet = true; - } - - else if (initialKeyStr == "status") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_status = WorkloadEstimateStatusMapper::GetWorkloadEstimateStatusForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_statusHasBeenSet = true; - } - - else if (initialKeyStr == "totalCost") { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_totalCost = val.value(); - } - m_totalCostHasBeenSet = true; - } - - else if (initialKeyStr == "costCurrency") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_costCurrency = CurrencyCodeMapper::GetCurrencyCodeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_costCurrencyHasBeenSet = true; - } - - else if (initialKeyStr == "failureMessage") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_failureMessage = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_failureMessage = ss.str(); - } - } - m_failureMessageHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } +WorkloadEstimateSummary& WorkloadEstimateSummary::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("id")) { + m_id = jsonValue.GetString("id"); + m_idHasBeenSet = true; } - - return *this; -} - -void WorkloadEstimateSummary::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_idHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("name")) { + m_name = jsonValue.GetString("name"); + m_nameHasBeenSet = true; } - if (m_nameHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("createdAt")) { + m_createdAt = jsonValue.GetDouble("createdAt"); + m_createdAtHasBeenSet = true; } - if (m_createdAtHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("expiresAt")) { + m_expiresAt = jsonValue.GetDouble("expiresAt"); + m_expiresAtHasBeenSet = true; } - if (m_expiresAtHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("rateType")) { + m_rateType = WorkloadEstimateRateTypeMapper::GetWorkloadEstimateRateTypeForName(jsonValue.GetString("rateType")); + m_rateTypeHasBeenSet = true; } - if (m_rateTypeHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("rateTimestamp")) { + m_rateTimestamp = jsonValue.GetDouble("rateTimestamp"); + m_rateTimestampHasBeenSet = true; } - if (m_rateTimestampHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("status")) { + m_status = WorkloadEstimateStatusMapper::GetWorkloadEstimateStatusForName(jsonValue.GetString("status")); + m_statusHasBeenSet = true; } - if (m_statusHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("totalCost")) { + m_totalCost = jsonValue.GetDouble("totalCost"); + m_totalCostHasBeenSet = true; } - if (m_totalCostHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("costCurrency")) { + m_costCurrency = CurrencyCodeMapper::GetCurrencyCodeForName(jsonValue.GetString("costCurrency")); + m_costCurrencyHasBeenSet = true; } - if (m_costCurrencyHasBeenSet) { - mapSize++; - } - if (m_failureMessageHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("failureMessage")) { + m_failureMessage = jsonValue.GetString("failureMessage"); + m_failureMessageHasBeenSet = true; } + return *this; +} - encoder.WriteMapStart(mapSize); +JsonValue WorkloadEstimateSummary::Jsonize() const { + JsonValue payload; if (m_idHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("id")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_id.c_str())); + payload.WithString("id", m_id); } if (m_nameHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("name")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_name.c_str())); + payload.WithString("name", m_name); } if (m_createdAtHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("createdAt")); - encoder.WriteTag(1); // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - encoder.WriteUInt(m_createdAt.Seconds()); + payload.WithDouble("createdAt", m_createdAt.SecondsWithMSPrecision()); } if (m_expiresAtHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("expiresAt")); - encoder.WriteTag(1); // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - encoder.WriteUInt(m_expiresAt.Seconds()); + payload.WithDouble("expiresAt", m_expiresAt.SecondsWithMSPrecision()); } if (m_rateTypeHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("rateType")); - encoder.WriteText( - Aws::Crt::ByteCursorFromCString(WorkloadEstimateRateTypeMapper::GetNameForWorkloadEstimateRateType(m_rateType).c_str())); + payload.WithString("rateType", WorkloadEstimateRateTypeMapper::GetNameForWorkloadEstimateRateType(m_rateType)); } if (m_rateTimestampHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("rateTimestamp")); - encoder.WriteTag(1); // 1 represents Epoch-based date/time. See https://www.rfc-editor.org/rfc/rfc8949.html#tags - encoder.WriteUInt(m_rateTimestamp.Seconds()); + payload.WithDouble("rateTimestamp", m_rateTimestamp.SecondsWithMSPrecision()); } if (m_statusHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("status")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(WorkloadEstimateStatusMapper::GetNameForWorkloadEstimateStatus(m_status).c_str())); + payload.WithString("status", WorkloadEstimateStatusMapper::GetNameForWorkloadEstimateStatus(m_status)); } if (m_totalCostHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("totalCost")); - encoder.WriteFloat(m_totalCost); + payload.WithDouble("totalCost", m_totalCost); } if (m_costCurrencyHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("costCurrency")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(CurrencyCodeMapper::GetNameForCurrencyCode(m_costCurrency).c_str())); + payload.WithString("costCurrency", CurrencyCodeMapper::GetNameForCurrencyCode(m_costCurrency)); } if (m_failureMessageHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("failureMessage")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_failureMessage.c_str())); + payload.WithString("failureMessage", m_failureMessage); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/WorkloadEstimateUsageItem.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/WorkloadEstimateUsageItem.cpp index 13f9e20a0347..43290de2d700 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/WorkloadEstimateUsageItem.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/WorkloadEstimateUsageItem.cpp @@ -4,664 +4,125 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -WorkloadEstimateUsageItem::WorkloadEstimateUsageItem(const std::shared_ptr& decoder) { *this = decoder; } +WorkloadEstimateUsageItem::WorkloadEstimateUsageItem(JsonView jsonValue) { *this = jsonValue; } -WorkloadEstimateUsageItem& WorkloadEstimateUsageItem::operator=(const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "serviceCode") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_serviceCode = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_serviceCode = ss.str(); - } - } - m_serviceCodeHasBeenSet = true; - } - - else if (initialKeyStr == "usageType") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageType = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageType = ss.str(); - } - } - m_usageTypeHasBeenSet = true; - } - - else if (initialKeyStr == "operation") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_operation = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_operation = ss.str(); - } - } - m_operationHasBeenSet = true; - } - - else if (initialKeyStr == "location") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_location = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_location = ss.str(); - } - } - m_locationHasBeenSet = true; - } - - else if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "usageAccountId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageAccountId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageAccountId = ss.str(); - } - } - m_usageAccountIdHasBeenSet = true; - } - - else if (initialKeyStr == "group") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_group = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_group = ss.str(); - } - } - m_groupHasBeenSet = true; - } - - else if (initialKeyStr == "quantity") { - m_quantity = WorkloadEstimateUsageQuantity(decoder); - m_quantityHasBeenSet = true; - } - - else if (initialKeyStr == "cost") { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_cost = val.value(); - } - m_costHasBeenSet = true; - } - - else if (initialKeyStr == "currency") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_currency = CurrencyCodeMapper::GetCurrencyCodeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_currencyHasBeenSet = true; - } - - else if (initialKeyStr == "status") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_status = WorkloadEstimateCostStatusMapper::GetWorkloadEstimateCostStatusForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_statusHasBeenSet = true; - } - - else if (initialKeyStr == "historicalUsage") { - m_historicalUsage = HistoricalUsageEntity(decoder); - m_historicalUsageHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("WorkloadEstimateUsageItem", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "serviceCode") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_serviceCode = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_serviceCode = ss.str(); - } - } - m_serviceCodeHasBeenSet = true; - } - - else if (initialKeyStr == "usageType") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageType = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageType = ss.str(); - } - } - m_usageTypeHasBeenSet = true; - } - - else if (initialKeyStr == "operation") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_operation = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_operation = ss.str(); - } - } - m_operationHasBeenSet = true; - } - - else if (initialKeyStr == "location") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_location = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_location = ss.str(); - } - } - m_locationHasBeenSet = true; - } - - else if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "usageAccountId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_usageAccountId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_usageAccountId = ss.str(); - } - } - m_usageAccountIdHasBeenSet = true; - } - - else if (initialKeyStr == "group") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_group = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_group = ss.str(); - } - } - m_groupHasBeenSet = true; - } - - else if (initialKeyStr == "quantity") { - m_quantity = WorkloadEstimateUsageQuantity(decoder); - m_quantityHasBeenSet = true; - } - - else if (initialKeyStr == "cost") { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_cost = val.value(); - } - m_costHasBeenSet = true; - } - - else if (initialKeyStr == "currency") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_currency = CurrencyCodeMapper::GetCurrencyCodeForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_currencyHasBeenSet = true; - } - - else if (initialKeyStr == "status") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_status = WorkloadEstimateCostStatusMapper::GetWorkloadEstimateCostStatusForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_statusHasBeenSet = true; - } - - else if (initialKeyStr == "historicalUsage") { - m_historicalUsage = HistoricalUsageEntity(decoder); - m_historicalUsageHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } +WorkloadEstimateUsageItem& WorkloadEstimateUsageItem::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("serviceCode")) { + m_serviceCode = jsonValue.GetString("serviceCode"); + m_serviceCodeHasBeenSet = true; } - - return *this; -} - -void WorkloadEstimateUsageItem::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_serviceCodeHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("usageType")) { + m_usageType = jsonValue.GetString("usageType"); + m_usageTypeHasBeenSet = true; } - if (m_usageTypeHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("operation")) { + m_operation = jsonValue.GetString("operation"); + m_operationHasBeenSet = true; } - if (m_operationHasBeenSet) { - mapSize++; - } - if (m_locationHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("location")) { + m_location = jsonValue.GetString("location"); + m_locationHasBeenSet = true; } - if (m_idHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("id")) { + m_id = jsonValue.GetString("id"); + m_idHasBeenSet = true; } - if (m_usageAccountIdHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("usageAccountId")) { + m_usageAccountId = jsonValue.GetString("usageAccountId"); + m_usageAccountIdHasBeenSet = true; } - if (m_groupHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("group")) { + m_group = jsonValue.GetString("group"); + m_groupHasBeenSet = true; } - if (m_quantityHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("quantity")) { + m_quantity = jsonValue.GetObject("quantity"); + m_quantityHasBeenSet = true; } - if (m_costHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("cost")) { + m_cost = jsonValue.GetDouble("cost"); + m_costHasBeenSet = true; } - if (m_currencyHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("currency")) { + m_currency = CurrencyCodeMapper::GetCurrencyCodeForName(jsonValue.GetString("currency")); + m_currencyHasBeenSet = true; } - if (m_statusHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("status")) { + m_status = WorkloadEstimateCostStatusMapper::GetWorkloadEstimateCostStatusForName(jsonValue.GetString("status")); + m_statusHasBeenSet = true; } - if (m_historicalUsageHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("historicalUsage")) { + m_historicalUsage = jsonValue.GetObject("historicalUsage"); + m_historicalUsageHasBeenSet = true; } + return *this; +} - encoder.WriteMapStart(mapSize); +JsonValue WorkloadEstimateUsageItem::Jsonize() const { + JsonValue payload; if (m_serviceCodeHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("serviceCode")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_serviceCode.c_str())); + payload.WithString("serviceCode", m_serviceCode); } if (m_usageTypeHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("usageType")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_usageType.c_str())); + payload.WithString("usageType", m_usageType); } if (m_operationHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("operation")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_operation.c_str())); + payload.WithString("operation", m_operation); } if (m_locationHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("location")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_location.c_str())); + payload.WithString("location", m_location); } if (m_idHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("id")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_id.c_str())); + payload.WithString("id", m_id); } if (m_usageAccountIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("usageAccountId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_usageAccountId.c_str())); + payload.WithString("usageAccountId", m_usageAccountId); } if (m_groupHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("group")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_group.c_str())); + payload.WithString("group", m_group); } if (m_quantityHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("quantity")); - m_quantity.CborEncode(encoder); + payload.WithObject("quantity", m_quantity.Jsonize()); } if (m_costHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("cost")); - encoder.WriteFloat(m_cost); + payload.WithDouble("cost", m_cost); } if (m_currencyHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("currency")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(CurrencyCodeMapper::GetNameForCurrencyCode(m_currency).c_str())); + payload.WithString("currency", CurrencyCodeMapper::GetNameForCurrencyCode(m_currency)); } if (m_statusHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("status")); - encoder.WriteText( - Aws::Crt::ByteCursorFromCString(WorkloadEstimateCostStatusMapper::GetNameForWorkloadEstimateCostStatus(m_status).c_str())); + payload.WithString("status", WorkloadEstimateCostStatusMapper::GetNameForWorkloadEstimateCostStatus(m_status)); } if (m_historicalUsageHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("historicalUsage")); - m_historicalUsage.CborEncode(encoder); + payload.WithObject("historicalUsage", m_historicalUsage.Jsonize()); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/WorkloadEstimateUsageQuantity.cpp b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/WorkloadEstimateUsageQuantity.cpp index 5f3e705e7e09..f70f27d5a539 100644 --- a/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/WorkloadEstimateUsageQuantity.cpp +++ b/generated/src/aws-cpp-sdk-bcm-pricing-calculator/source/model/WorkloadEstimateUsageQuantity.cpp @@ -4,169 +4,45 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMPricingCalculator { namespace Model { -WorkloadEstimateUsageQuantity::WorkloadEstimateUsageQuantity(const std::shared_ptr& decoder) { - *this = decoder; -} - -WorkloadEstimateUsageQuantity& WorkloadEstimateUsageQuantity::operator=(const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "unit") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_unit = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_unit = ss.str(); - } - } - m_unitHasBeenSet = true; - } - - else if (initialKeyStr == "amount") { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_amount = val.value(); - } - m_amountHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("WorkloadEstimateUsageQuantity", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } +WorkloadEstimateUsageQuantity::WorkloadEstimateUsageQuantity(JsonView jsonValue) { *this = jsonValue; } - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "unit") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_unit = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_unit = ss.str(); - } - } - m_unitHasBeenSet = true; - } - - else if (initialKeyStr == "amount") { - auto val = decoder->PopNextFloatVal(); - if (val.has_value()) { - m_amount = val.value(); - } - m_amountHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } +WorkloadEstimateUsageQuantity& WorkloadEstimateUsageQuantity::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("unit")) { + m_unit = jsonValue.GetString("unit"); + m_unitHasBeenSet = true; + } + if (jsonValue.ValueExists("amount")) { + m_amount = jsonValue.GetDouble("amount"); + m_amountHasBeenSet = true; } - return *this; } -void WorkloadEstimateUsageQuantity::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_unitHasBeenSet) { - mapSize++; - } - if (m_amountHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); +JsonValue WorkloadEstimateUsageQuantity::Jsonize() const { + JsonValue payload; if (m_unitHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("unit")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_unit.c_str())); + payload.WithString("unit", m_unit); } if (m_amountHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("amount")); - encoder.WriteFloat(m_amount); + payload.WithDouble("amount", m_amount); } + + return payload; } } // namespace Model } // namespace BCMPricingCalculator -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-recommended-actions/include/aws/bcm-recommended-actions/BCMRecommendedActionsClient.h b/generated/src/aws-cpp-sdk-bcm-recommended-actions/include/aws/bcm-recommended-actions/BCMRecommendedActionsClient.h index ba0e16631dd8..dd9f825c08d9 100644 --- a/generated/src/aws-cpp-sdk-bcm-recommended-actions/include/aws/bcm-recommended-actions/BCMRecommendedActionsClient.h +++ b/generated/src/aws-cpp-sdk-bcm-recommended-actions/include/aws/bcm-recommended-actions/BCMRecommendedActionsClient.h @@ -11,7 +11,7 @@ #include #include #include -#include +#include namespace Aws { namespace BCMRecommendedActions { @@ -23,12 +23,12 @@ namespace BCMRecommendedActions { * https://bcm-recommended-actions.us-east-1.api.aws

*/ class AWS_BCMRECOMMENDEDACTIONS_API BCMRecommendedActionsClient - : public Aws::Client::AWSRpcV2CborClient, + : public Aws::Client::AWSJsonClient, public Aws::Client::ClientWithAsyncTemplateMethods, public BCMRecommendedActionsPaginationBase, public BCMRecommendedActionsWaiter { public: - typedef Aws::Client::AWSRpcV2CborClient BASECLASS; + typedef Aws::Client::AWSJsonClient BASECLASS; static const char* GetServiceName(); static const char* GetAllocationTag(); diff --git a/generated/src/aws-cpp-sdk-bcm-recommended-actions/include/aws/bcm-recommended-actions/BCMRecommendedActionsErrorMarshaller.h b/generated/src/aws-cpp-sdk-bcm-recommended-actions/include/aws/bcm-recommended-actions/BCMRecommendedActionsErrorMarshaller.h index a6c416331ad6..0ed9f2ec1a4d 100644 --- a/generated/src/aws-cpp-sdk-bcm-recommended-actions/include/aws/bcm-recommended-actions/BCMRecommendedActionsErrorMarshaller.h +++ b/generated/src/aws-cpp-sdk-bcm-recommended-actions/include/aws/bcm-recommended-actions/BCMRecommendedActionsErrorMarshaller.h @@ -11,7 +11,7 @@ namespace Aws { namespace Client { -class AWS_BCMRECOMMENDEDACTIONS_API BCMRecommendedActionsErrorMarshaller : public Aws::Client::RpcV2ErrorMarshaller { +class AWS_BCMRECOMMENDEDACTIONS_API BCMRecommendedActionsErrorMarshaller : public Aws::Client::JsonErrorMarshaller { public: Aws::Client::AWSError FindErrorByName(const char* exceptionName) const override; }; diff --git a/generated/src/aws-cpp-sdk-bcm-recommended-actions/include/aws/bcm-recommended-actions/BCMRecommendedActionsRequest.h b/generated/src/aws-cpp-sdk-bcm-recommended-actions/include/aws/bcm-recommended-actions/BCMRecommendedActionsRequest.h index 7eddb1af085d..f0e737b51b8f 100644 --- a/generated/src/aws-cpp-sdk-bcm-recommended-actions/include/aws/bcm-recommended-actions/BCMRecommendedActionsRequest.h +++ b/generated/src/aws-cpp-sdk-bcm-recommended-actions/include/aws/bcm-recommended-actions/BCMRecommendedActionsRequest.h @@ -25,6 +25,7 @@ class AWS_BCMRECOMMENDEDACTIONS_API BCMRecommendedActionsRequest : public Aws::A auto headers = GetRequestSpecificHeaders(); if (headers.size() == 0 || (headers.size() > 0 && headers.count(Aws::Http::CONTENT_TYPE_HEADER) == 0)) { + headers.emplace(Aws::Http::HeaderValuePair(Aws::Http::CONTENT_TYPE_HEADER, Aws::AMZN_JSON_CONTENT_TYPE_1_0)); } headers.emplace(Aws::Http::HeaderValuePair(Aws::Http::API_VERSION_HEADER, "2024-11-14")); return headers; diff --git a/generated/src/aws-cpp-sdk-bcm-recommended-actions/include/aws/bcm-recommended-actions/model/ActionFilter.h b/generated/src/aws-cpp-sdk-bcm-recommended-actions/include/aws/bcm-recommended-actions/model/ActionFilter.h index 370d2da8803c..a3ab6616ddd2 100644 --- a/generated/src/aws-cpp-sdk-bcm-recommended-actions/include/aws/bcm-recommended-actions/model/ActionFilter.h +++ b/generated/src/aws-cpp-sdk-bcm-recommended-actions/include/aws/bcm-recommended-actions/model/ActionFilter.h @@ -9,15 +9,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMRecommendedActions { namespace Model { @@ -31,9 +31,9 @@ namespace Model { class ActionFilter { public: AWS_BCMRECOMMENDEDACTIONS_API ActionFilter() = default; - AWS_BCMRECOMMENDEDACTIONS_API ActionFilter(const std::shared_ptr& decoder); - AWS_BCMRECOMMENDEDACTIONS_API ActionFilter& operator=(const std::shared_ptr& decoder); - AWS_BCMRECOMMENDEDACTIONS_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMRECOMMENDEDACTIONS_API ActionFilter(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMRECOMMENDEDACTIONS_API ActionFilter& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMRECOMMENDEDACTIONS_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-recommended-actions/include/aws/bcm-recommended-actions/model/ListRecommendedActionsResult.h b/generated/src/aws-cpp-sdk-bcm-recommended-actions/include/aws/bcm-recommended-actions/model/ListRecommendedActionsResult.h index 0f4332631664..8e397375954f 100644 --- a/generated/src/aws-cpp-sdk-bcm-recommended-actions/include/aws/bcm-recommended-actions/model/ListRecommendedActionsResult.h +++ b/generated/src/aws-cpp-sdk-bcm-recommended-actions/include/aws/bcm-recommended-actions/model/ListRecommendedActionsResult.h @@ -9,26 +9,26 @@ #include #include #include -#include #include + namespace Aws { template class AmazonWebServiceResult; namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +} // namespace Json } // namespace Utils namespace BCMRecommendedActions { namespace Model { class ListRecommendedActionsResult { public: AWS_BCMRECOMMENDEDACTIONS_API ListRecommendedActionsResult() = default; - AWS_BCMRECOMMENDEDACTIONS_API ListRecommendedActionsResult(const Aws::AmazonWebServiceResult& result); + AWS_BCMRECOMMENDEDACTIONS_API ListRecommendedActionsResult(const Aws::AmazonWebServiceResult& result); AWS_BCMRECOMMENDEDACTIONS_API ListRecommendedActionsResult& operator=( - const Aws::AmazonWebServiceResult& result); + const Aws::AmazonWebServiceResult& result); ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-recommended-actions/include/aws/bcm-recommended-actions/model/RecommendedAction.h b/generated/src/aws-cpp-sdk-bcm-recommended-actions/include/aws/bcm-recommended-actions/model/RecommendedAction.h index 71fcfdbc614b..5075a1d04943 100644 --- a/generated/src/aws-cpp-sdk-bcm-recommended-actions/include/aws/bcm-recommended-actions/model/RecommendedAction.h +++ b/generated/src/aws-cpp-sdk-bcm-recommended-actions/include/aws/bcm-recommended-actions/model/RecommendedAction.h @@ -11,15 +11,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMRecommendedActions { namespace Model { @@ -32,9 +32,9 @@ namespace Model { class RecommendedAction { public: AWS_BCMRECOMMENDEDACTIONS_API RecommendedAction() = default; - AWS_BCMRECOMMENDEDACTIONS_API RecommendedAction(const std::shared_ptr& decoder); - AWS_BCMRECOMMENDEDACTIONS_API RecommendedAction& operator=(const std::shared_ptr& decoder); - AWS_BCMRECOMMENDEDACTIONS_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMRECOMMENDEDACTIONS_API RecommendedAction(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMRECOMMENDEDACTIONS_API RecommendedAction& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMRECOMMENDEDACTIONS_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-recommended-actions/include/aws/bcm-recommended-actions/model/RequestFilter.h b/generated/src/aws-cpp-sdk-bcm-recommended-actions/include/aws/bcm-recommended-actions/model/RequestFilter.h index 407cde64353a..5afb215d6311 100644 --- a/generated/src/aws-cpp-sdk-bcm-recommended-actions/include/aws/bcm-recommended-actions/model/RequestFilter.h +++ b/generated/src/aws-cpp-sdk-bcm-recommended-actions/include/aws/bcm-recommended-actions/model/RequestFilter.h @@ -7,15 +7,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMRecommendedActions { namespace Model { @@ -30,9 +30,9 @@ namespace Model { class RequestFilter { public: AWS_BCMRECOMMENDEDACTIONS_API RequestFilter() = default; - AWS_BCMRECOMMENDEDACTIONS_API RequestFilter(const std::shared_ptr& decoder); - AWS_BCMRECOMMENDEDACTIONS_API RequestFilter& operator=(const std::shared_ptr& decoder); - AWS_BCMRECOMMENDEDACTIONS_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMRECOMMENDEDACTIONS_API RequestFilter(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMRECOMMENDEDACTIONS_API RequestFilter& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMRECOMMENDEDACTIONS_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-recommended-actions/include/aws/bcm-recommended-actions/model/ValidationException.h b/generated/src/aws-cpp-sdk-bcm-recommended-actions/include/aws/bcm-recommended-actions/model/ValidationException.h index a9b64a08dce4..1a067718b5fc 100644 --- a/generated/src/aws-cpp-sdk-bcm-recommended-actions/include/aws/bcm-recommended-actions/model/ValidationException.h +++ b/generated/src/aws-cpp-sdk-bcm-recommended-actions/include/aws/bcm-recommended-actions/model/ValidationException.h @@ -9,15 +9,15 @@ #include #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMRecommendedActions { namespace Model { @@ -31,9 +31,9 @@ namespace Model { class ValidationException { public: AWS_BCMRECOMMENDEDACTIONS_API ValidationException() = default; - AWS_BCMRECOMMENDEDACTIONS_API ValidationException(const std::shared_ptr& decoder); - AWS_BCMRECOMMENDEDACTIONS_API ValidationException& operator=(const std::shared_ptr& decoder); - AWS_BCMRECOMMENDEDACTIONS_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMRECOMMENDEDACTIONS_API ValidationException(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMRECOMMENDEDACTIONS_API ValidationException& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMRECOMMENDEDACTIONS_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ diff --git a/generated/src/aws-cpp-sdk-bcm-recommended-actions/include/aws/bcm-recommended-actions/model/ValidationExceptionField.h b/generated/src/aws-cpp-sdk-bcm-recommended-actions/include/aws/bcm-recommended-actions/model/ValidationExceptionField.h index d24b66a39ae9..943e5fd636c8 100644 --- a/generated/src/aws-cpp-sdk-bcm-recommended-actions/include/aws/bcm-recommended-actions/model/ValidationExceptionField.h +++ b/generated/src/aws-cpp-sdk-bcm-recommended-actions/include/aws/bcm-recommended-actions/model/ValidationExceptionField.h @@ -6,15 +6,15 @@ #pragma once #include #include -#include #include namespace Aws { namespace Utils { -namespace Cbor { -class CborValue; -} // namespace Cbor +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json } // namespace Utils namespace BCMRecommendedActions { namespace Model { @@ -28,9 +28,9 @@ namespace Model { class ValidationExceptionField { public: AWS_BCMRECOMMENDEDACTIONS_API ValidationExceptionField() = default; - AWS_BCMRECOMMENDEDACTIONS_API ValidationExceptionField(const std::shared_ptr& decoder); - AWS_BCMRECOMMENDEDACTIONS_API ValidationExceptionField& operator=(const std::shared_ptr& decoder); - AWS_BCMRECOMMENDEDACTIONS_API void CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const; + AWS_BCMRECOMMENDEDACTIONS_API ValidationExceptionField(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMRECOMMENDEDACTIONS_API ValidationExceptionField& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BCMRECOMMENDEDACTIONS_API Aws::Utils::Json::JsonValue Jsonize() const; ///@{ /** diff --git a/generated/src/aws-cpp-sdk-bcm-recommended-actions/source/BCMRecommendedActionsClient.cpp b/generated/src/aws-cpp-sdk-bcm-recommended-actions/source/BCMRecommendedActionsClient.cpp index 0dae5c1779cb..6396b637651d 100644 --- a/generated/src/aws-cpp-sdk-bcm-recommended-actions/source/BCMRecommendedActionsClient.cpp +++ b/generated/src/aws-cpp-sdk-bcm-recommended-actions/source/BCMRecommendedActionsClient.cpp @@ -175,9 +175,6 @@ BCMRecommendedActionsClient::InvokeOperationOutcome BCMRecommendedActionsClient: AWS_OPERATION_CHECK_SUCCESS_DYNAMIC(endpointResolutionOutcome, operationName, CoreErrors, CoreErrors::ENDPOINT_RESOLUTION_FAILURE, endpointResolutionOutcome.GetError().GetMessage()); - endpointResolutionOutcome.GetResult().AddPathSegments("/service/AWSBillingAndCostManagementRecommendedActions/operation/"); - endpointResolutionOutcome.GetResult().AddPathSegment(operationName); - return InvokeOperationOutcome{MakeRequest(request, endpointResolutionOutcome.GetResult(), httpMethod, Aws::Auth::SIGV4_SIGNER)}; }, TracingUtils::SMITHY_CLIENT_DURATION_METRIC, *meter, diff --git a/generated/src/aws-cpp-sdk-bcm-recommended-actions/source/BCMRecommendedActionsErrors.cpp b/generated/src/aws-cpp-sdk-bcm-recommended-actions/source/BCMRecommendedActionsErrors.cpp index e65b95f07f64..3401f1901e9b 100644 --- a/generated/src/aws-cpp-sdk-bcm-recommended-actions/source/BCMRecommendedActionsErrors.cpp +++ b/generated/src/aws-cpp-sdk-bcm-recommended-actions/source/BCMRecommendedActionsErrors.cpp @@ -4,15 +4,23 @@ */ #include +#include #include #include using namespace Aws::Client; using namespace Aws::Utils; using namespace Aws::BCMRecommendedActions; +using namespace Aws::BCMRecommendedActions::Model; namespace Aws { namespace BCMRecommendedActions { +template <> +AWS_BCMRECOMMENDEDACTIONS_API ValidationException BCMRecommendedActionsError::GetModeledError() { + assert(this->GetErrorType() == BCMRecommendedActionsErrors::VALIDATION); + return ValidationException(this->GetJsonPayload().View()); +} + namespace BCMRecommendedActionsErrorMapper { static const int INTERNAL_SERVER_HASH = HashingUtils::HashString("InternalServerException"); @@ -21,7 +29,7 @@ AWSError GetErrorForName(const char* errorName) { int hashCode = HashingUtils::HashString(errorName); if (hashCode == INTERNAL_SERVER_HASH) { - return AWSError(static_cast(BCMRecommendedActionsErrors::INTERNAL_SERVER), RetryableType::RETRYABLE); + return AWSError(static_cast(BCMRecommendedActionsErrors::INTERNAL_SERVER), RetryableType::NOT_RETRYABLE); } return AWSError(CoreErrors::UNKNOWN, false); } diff --git a/generated/src/aws-cpp-sdk-bcm-recommended-actions/source/model/ActionFilter.cpp b/generated/src/aws-cpp-sdk-bcm-recommended-actions/source/model/ActionFilter.cpp index caa45d19ab41..3fd29be982af 100644 --- a/generated/src/aws-cpp-sdk-bcm-recommended-actions/source/model/ActionFilter.cpp +++ b/generated/src/aws-cpp-sdk-bcm-recommended-actions/source/model/ActionFilter.cpp @@ -4,300 +4,60 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMRecommendedActions { namespace Model { -ActionFilter::ActionFilter(const std::shared_ptr& decoder) { *this = decoder; } +ActionFilter::ActionFilter(JsonView jsonValue) { *this = jsonValue; } -ActionFilter& ActionFilter::operator=(const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "key") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_key = - FilterNameMapper::GetFilterNameForName(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_keyHasBeenSet = true; - } - - else if (initialKeyStr == "matchOption") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_matchOption = MatchOptionMapper::GetMatchOptionForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_matchOptionHasBeenSet = true; - } - - else if (initialKeyStr == "values") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - auto peekType_1 = decoder->PeekType(); - if (peekType_1.has_value()) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_values.push_back(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_values.push_back(ss_1.str()); - ss_1.clear(); - } - } - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto peekType_1 = decoder->PeekType(); - if (peekType_1.has_value()) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_values.push_back(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_values.push_back(ss_1.str()); - ss_1.clear(); - } - } - } - } - } - m_valuesHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("ActionFilter", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "key") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_key = - FilterNameMapper::GetFilterNameForName(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_keyHasBeenSet = true; - } - - else if (initialKeyStr == "matchOption") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_matchOption = - MatchOptionMapper::GetMatchOptionForName(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_matchOptionHasBeenSet = true; - } - - else if (initialKeyStr == "values") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - auto peekType_1 = decoder->PeekType(); - if (peekType_1.has_value()) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_values.push_back(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_values.push_back(ss_1.str()); - ss_1.clear(); - } - } - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto peekType_1 = decoder->PeekType(); - if (peekType_1.has_value()) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_values.push_back(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_values.push_back(ss_1.str()); - ss_1.clear(); - } - } - } - } - } - m_valuesHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } +ActionFilter& ActionFilter::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("key")) { + m_key = FilterNameMapper::GetFilterNameForName(jsonValue.GetString("key")); + m_keyHasBeenSet = true; + } + if (jsonValue.ValueExists("matchOption")) { + m_matchOption = MatchOptionMapper::GetMatchOptionForName(jsonValue.GetString("matchOption")); + m_matchOptionHasBeenSet = true; + } + if (jsonValue.ValueExists("values")) { + Aws::Utils::Array valuesJsonList = jsonValue.GetArray("values"); + for (unsigned valuesIndex = 0; valuesIndex < valuesJsonList.GetLength(); ++valuesIndex) { + m_values.push_back(valuesJsonList[valuesIndex].AsString()); } + m_valuesHasBeenSet = true; } - return *this; } -void ActionFilter::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_keyHasBeenSet) { - mapSize++; - } - if (m_matchOptionHasBeenSet) { - mapSize++; - } - if (m_valuesHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); +JsonValue ActionFilter::Jsonize() const { + JsonValue payload; if (m_keyHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("key")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(FilterNameMapper::GetNameForFilterName(m_key).c_str())); + payload.WithString("key", FilterNameMapper::GetNameForFilterName(m_key)); } if (m_matchOptionHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("matchOption")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(MatchOptionMapper::GetNameForMatchOption(m_matchOption).c_str())); + payload.WithString("matchOption", MatchOptionMapper::GetNameForMatchOption(m_matchOption)); } if (m_valuesHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("values")); - encoder.WriteArrayStart(m_values.size()); - for (const auto& item_0 : m_values) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString(item_0.c_str())); + Aws::Utils::Array valuesJsonList(m_values.size()); + for (unsigned valuesIndex = 0; valuesIndex < valuesJsonList.GetLength(); ++valuesIndex) { + valuesJsonList[valuesIndex].AsString(m_values[valuesIndex]); } + payload.WithArray("values", std::move(valuesJsonList)); } + + return payload; } } // namespace Model } // namespace BCMRecommendedActions -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-recommended-actions/source/model/ListRecommendedActionsRequest.cpp b/generated/src/aws-cpp-sdk-bcm-recommended-actions/source/model/ListRecommendedActionsRequest.cpp index ad0606c01fca..7bbec35a781a 100644 --- a/generated/src/aws-cpp-sdk-bcm-recommended-actions/source/model/ListRecommendedActionsRequest.cpp +++ b/generated/src/aws-cpp-sdk-bcm-recommended-actions/source/model/ListRecommendedActionsRequest.cpp @@ -4,53 +4,34 @@ */ #include -#include +#include #include using namespace Aws::BCMRecommendedActions::Model; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; Aws::String ListRecommendedActionsRequest::SerializePayload() const { - Aws::Crt::Cbor::CborEncoder encoder; + JsonValue payload; - // Calculate map size - size_t mapSize = 0; if (m_filterHasBeenSet) { - mapSize++; - } - if (m_maxResultsHasBeenSet) { - mapSize++; - } - if (m_nextTokenHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); - - if (m_filterHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("filter")); - m_filter.CborEncode(encoder); + payload.WithObject("filter", m_filter.Jsonize()); } if (m_maxResultsHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("maxResults")); - (m_maxResults >= 0) ? encoder.WriteUInt(m_maxResults) : encoder.WriteNegInt(m_maxResults); + payload.WithInteger("maxResults", m_maxResults); } if (m_nextTokenHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("nextToken")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_nextToken.c_str())); + payload.WithString("nextToken", m_nextToken); } - const auto str = Aws::String(reinterpret_cast(encoder.GetEncodedData().ptr), encoder.GetEncodedData().len); - return str; + + return payload.View().WriteReadable(); } Aws::Http::HeaderValueCollection ListRecommendedActionsRequest::GetRequestSpecificHeaders() const { Aws::Http::HeaderValueCollection headers; - headers.emplace(Aws::Http::CONTENT_TYPE_HEADER, Aws::CBOR_CONTENT_TYPE); - headers.emplace(Aws::Http::SMITHY_PROTOCOL_HEADER, Aws::RPC_V2_CBOR); - headers.emplace(Aws::Http::ACCEPT_HEADER, Aws::CBOR_CONTENT_TYPE); + headers.insert(Aws::Http::HeaderValuePair("X-Amz-Target", "AWSBillingAndCostManagementRecommendedActions.ListRecommendedActions")); return headers; } diff --git a/generated/src/aws-cpp-sdk-bcm-recommended-actions/source/model/ListRecommendedActionsResult.cpp b/generated/src/aws-cpp-sdk-bcm-recommended-actions/source/model/ListRecommendedActionsResult.cpp index d6ec0df72605..c12081fab861 100644 --- a/generated/src/aws-cpp-sdk-bcm-recommended-actions/source/model/ListRecommendedActionsResult.cpp +++ b/generated/src/aws-cpp-sdk-bcm-recommended-actions/source/model/ListRecommendedActionsResult.cpp @@ -7,193 +7,32 @@ #include #include #include -#include +#include #include -#include #include using namespace Aws::BCMRecommendedActions::Model; -using namespace Aws::Crt; -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; -using namespace Aws::Utils::Cbor; using namespace Aws; -ListRecommendedActionsResult::ListRecommendedActionsResult(const Aws::AmazonWebServiceResult& result) { - *this = result; -} +ListRecommendedActionsResult::ListRecommendedActionsResult(const Aws::AmazonWebServiceResult& result) { *this = result; } -ListRecommendedActionsResult& ListRecommendedActionsResult::operator=( - const Aws::AmazonWebServiceResult& result) { +ListRecommendedActionsResult& ListRecommendedActionsResult::operator=(const Aws::AmazonWebServiceResult& result) { m_HttpResponseCode = result.GetResponseCode(); - - const auto& cborValue = result.GetPayload(); - const auto decoder = cborValue.GetDecoder(); - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "recommendedActions") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_recommendedActions.push_back(RecommendedAction(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_recommendedActions.push_back(RecommendedAction(decoder)); - } - } - } - m_recommendedActionsHasBeenSet = true; - } - - else if (initialKeyStr == "nextToken") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_nextToken = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_nextToken = ss.str(); - } - } - m_nextTokenHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("ListRecommendedActionsResult", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "recommendedActions") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_recommendedActions.push_back(RecommendedAction(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_recommendedActions.push_back(RecommendedAction(decoder)); - } - } - } - m_recommendedActionsHasBeenSet = true; - } - - else if (initialKeyStr == "nextToken") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_nextToken = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_nextToken = ss.str(); - } - } - m_nextTokenHasBeenSet = true; - } - - else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } + JsonView jsonValue = result.GetPayload().View(); + if (jsonValue.ValueExists("recommendedActions")) { + Aws::Utils::Array recommendedActionsJsonList = jsonValue.GetArray("recommendedActions"); + for (unsigned recommendedActionsIndex = 0; recommendedActionsIndex < recommendedActionsJsonList.GetLength(); + ++recommendedActionsIndex) { + m_recommendedActions.push_back(recommendedActionsJsonList[recommendedActionsIndex].AsObject()); } + m_recommendedActionsHasBeenSet = true; + } + if (jsonValue.ValueExists("nextToken")) { + m_nextToken = jsonValue.GetString("nextToken"); + m_nextTokenHasBeenSet = true; } const auto& headers = result.GetHeaderValueCollection(); diff --git a/generated/src/aws-cpp-sdk-bcm-recommended-actions/source/model/RecommendedAction.cpp b/generated/src/aws-cpp-sdk-bcm-recommended-actions/source/model/RecommendedAction.cpp index 98b419b0d3a9..8eff9ea03767 100644 --- a/generated/src/aws-cpp-sdk-bcm-recommended-actions/source/model/RecommendedAction.cpp +++ b/generated/src/aws-cpp-sdk-bcm-recommended-actions/source/model/RecommendedAction.cpp @@ -4,717 +4,107 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMRecommendedActions { namespace Model { -RecommendedAction::RecommendedAction(const std::shared_ptr& decoder) { *this = decoder; } +RecommendedAction::RecommendedAction(JsonView jsonValue) { *this = jsonValue; } -RecommendedAction& RecommendedAction::operator=(const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "type") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_type = - ActionTypeMapper::GetActionTypeForName(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_typeHasBeenSet = true; - } - - else if (initialKeyStr == "accountId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_accountId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_accountId = ss.str(); - } - } - m_accountIdHasBeenSet = true; - } - - else if (initialKeyStr == "severity") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_severity = - SeverityMapper::GetSeverityForName(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_severityHasBeenSet = true; - } - - else if (initialKeyStr == "feature") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_feature = - FeatureMapper::GetFeatureForName(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_featureHasBeenSet = true; - } - - else if (initialKeyStr == "context") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && (peekType_0.value() == CborType::MapStart || peekType_0.value() == CborType::IndefMapStart)) { - if (peekType_0.value() == CborType::MapStart) { - auto mapSize_0 = decoder->PopNextMapStart(); - if (mapSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < mapSize_0.value(); j_0++) { - auto key_1 = decoder->PopNextTextVal(); - if (key_1.has_value()) { - Aws::String keyStr_1 = Aws::String(reinterpret_cast(key_1.value().ptr), key_1.value().len); - auto peekType_1 = decoder->PeekType(); - if (peekType_1) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_context[keyStr_1] = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_context[keyStr_1] = ss_1.str(); - ss_1.clear(); - } - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto key_1 = decoder->PopNextTextVal(); - if (key_1.has_value()) { - Aws::String keyStr_1 = Aws::String(reinterpret_cast(key_1.value().ptr), key_1.value().len); - auto peekType_1 = decoder->PeekType(); - if (peekType_1) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_context[keyStr_1] = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_context[keyStr_1] = ss_1.str(); - ss_1.clear(); - } - } - } - } - } - } - m_contextHasBeenSet = true; - } - - else if (initialKeyStr == "nextSteps") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - auto peekType_1 = decoder->PeekType(); - if (peekType_1.has_value()) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_nextSteps.push_back(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_nextSteps.push_back(ss_1.str()); - ss_1.clear(); - } - } - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto peekType_1 = decoder->PeekType(); - if (peekType_1.has_value()) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_nextSteps.push_back(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_nextSteps.push_back(ss_1.str()); - ss_1.clear(); - } - } - } - } - } - m_nextStepsHasBeenSet = true; - } - - else if (initialKeyStr == "lastUpdatedTimeStamp") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_lastUpdatedTimeStamp = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_lastUpdatedTimeStamp = ss.str(); - } - } - m_lastUpdatedTimeStampHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("RecommendedAction", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "id") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_id = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_id = ss.str(); - } - } - m_idHasBeenSet = true; - } - - else if (initialKeyStr == "type") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_type = - ActionTypeMapper::GetActionTypeForName(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_typeHasBeenSet = true; - } - - else if (initialKeyStr == "accountId") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_accountId = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_accountId = ss.str(); - } - } - m_accountIdHasBeenSet = true; - } - - else if (initialKeyStr == "severity") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_severity = - SeverityMapper::GetSeverityForName(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_severityHasBeenSet = true; - } - - else if (initialKeyStr == "feature") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_feature = FeatureMapper::GetFeatureForName(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_featureHasBeenSet = true; - } - - else if (initialKeyStr == "context") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && (peekType_0.value() == CborType::MapStart || peekType_0.value() == CborType::IndefMapStart)) { - if (peekType_0.value() == CborType::MapStart) { - auto mapSize_0 = decoder->PopNextMapStart(); - if (mapSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < mapSize_0.value(); j_0++) { - auto key_1 = decoder->PopNextTextVal(); - if (key_1.has_value()) { - Aws::String keyStr_1 = Aws::String(reinterpret_cast(key_1.value().ptr), key_1.value().len); - auto peekType_1 = decoder->PeekType(); - if (peekType_1) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_context[keyStr_1] = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_context[keyStr_1] = ss_1.str(); - ss_1.clear(); - } - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto key_1 = decoder->PopNextTextVal(); - if (key_1.has_value()) { - Aws::String keyStr_1 = Aws::String(reinterpret_cast(key_1.value().ptr), key_1.value().len); - auto peekType_1 = decoder->PeekType(); - if (peekType_1) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_context[keyStr_1] = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_context[keyStr_1] = ss_1.str(); - ss_1.clear(); - } - } - } - } - } - } - m_contextHasBeenSet = true; - } - - else if (initialKeyStr == "nextSteps") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - auto peekType_1 = decoder->PeekType(); - if (peekType_1.has_value()) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_nextSteps.push_back(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_nextSteps.push_back(ss_1.str()); - ss_1.clear(); - } - } - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto peekType_1 = decoder->PeekType(); - if (peekType_1.has_value()) { - if (peekType_1.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_nextSteps.push_back(Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss_1; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_1 = decoder->PeekType(); - if (!nextType_1.has_value() || nextType_1.value() == CborType::Break) { - if (nextType_1.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss_1 << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_nextSteps.push_back(ss_1.str()); - ss_1.clear(); - } - } - } - } - } - m_nextStepsHasBeenSet = true; - } - - else if (initialKeyStr == "lastUpdatedTimeStamp") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_lastUpdatedTimeStamp = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_lastUpdatedTimeStamp = ss.str(); - } - } - m_lastUpdatedTimeStampHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } +RecommendedAction& RecommendedAction::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("id")) { + m_id = jsonValue.GetString("id"); + m_idHasBeenSet = true; } - - return *this; -} - -void RecommendedAction::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_idHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("type")) { + m_type = ActionTypeMapper::GetActionTypeForName(jsonValue.GetString("type")); + m_typeHasBeenSet = true; } - if (m_typeHasBeenSet) { - mapSize++; - } - if (m_accountIdHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("accountId")) { + m_accountId = jsonValue.GetString("accountId"); + m_accountIdHasBeenSet = true; } - if (m_severityHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("severity")) { + m_severity = SeverityMapper::GetSeverityForName(jsonValue.GetString("severity")); + m_severityHasBeenSet = true; } - if (m_featureHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("feature")) { + m_feature = FeatureMapper::GetFeatureForName(jsonValue.GetString("feature")); + m_featureHasBeenSet = true; } - if (m_contextHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("context")) { + Aws::Map contextJsonMap = jsonValue.GetObject("context").GetAllObjects(); + for (auto& contextItem : contextJsonMap) { + m_context[contextItem.first] = contextItem.second.AsString(); + } + m_contextHasBeenSet = true; } - if (m_nextStepsHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("nextSteps")) { + Aws::Utils::Array nextStepsJsonList = jsonValue.GetArray("nextSteps"); + for (unsigned nextStepsIndex = 0; nextStepsIndex < nextStepsJsonList.GetLength(); ++nextStepsIndex) { + m_nextSteps.push_back(nextStepsJsonList[nextStepsIndex].AsString()); + } + m_nextStepsHasBeenSet = true; } - if (m_lastUpdatedTimeStampHasBeenSet) { - mapSize++; + if (jsonValue.ValueExists("lastUpdatedTimeStamp")) { + m_lastUpdatedTimeStamp = jsonValue.GetString("lastUpdatedTimeStamp"); + m_lastUpdatedTimeStampHasBeenSet = true; } + return *this; +} - encoder.WriteMapStart(mapSize); +JsonValue RecommendedAction::Jsonize() const { + JsonValue payload; if (m_idHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("id")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_id.c_str())); + payload.WithString("id", m_id); } if (m_typeHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("type")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(ActionTypeMapper::GetNameForActionType(m_type).c_str())); + payload.WithString("type", ActionTypeMapper::GetNameForActionType(m_type)); } if (m_accountIdHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("accountId")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_accountId.c_str())); + payload.WithString("accountId", m_accountId); } if (m_severityHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("severity")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(SeverityMapper::GetNameForSeverity(m_severity).c_str())); + payload.WithString("severity", SeverityMapper::GetNameForSeverity(m_severity)); } if (m_featureHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("feature")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(FeatureMapper::GetNameForFeature(m_feature).c_str())); + payload.WithString("feature", FeatureMapper::GetNameForFeature(m_feature)); } if (m_contextHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("context")); - encoder.WriteMapStart(m_context.size()); - for (const auto& item_0 : m_context) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString(item_0.first.c_str())); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(item_0.second.c_str())); + JsonValue contextJsonMap; + for (auto& contextItem : m_context) { + contextJsonMap.WithString(contextItem.first, contextItem.second); } + payload.WithObject("context", std::move(contextJsonMap)); } if (m_nextStepsHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("nextSteps")); - encoder.WriteArrayStart(m_nextSteps.size()); - for (const auto& item_0 : m_nextSteps) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString(item_0.c_str())); + Aws::Utils::Array nextStepsJsonList(m_nextSteps.size()); + for (unsigned nextStepsIndex = 0; nextStepsIndex < nextStepsJsonList.GetLength(); ++nextStepsIndex) { + nextStepsJsonList[nextStepsIndex].AsString(m_nextSteps[nextStepsIndex]); } + payload.WithArray("nextSteps", std::move(nextStepsJsonList)); } if (m_lastUpdatedTimeStampHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("lastUpdatedTimeStamp")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_lastUpdatedTimeStamp.c_str())); + payload.WithString("lastUpdatedTimeStamp", m_lastUpdatedTimeStamp); } + + return payload; } } // namespace Model } // namespace BCMRecommendedActions -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-recommended-actions/source/model/RequestFilter.cpp b/generated/src/aws-cpp-sdk-bcm-recommended-actions/source/model/RequestFilter.cpp index c1b1c4e6b68c..aedb6c7e49a0 100644 --- a/generated/src/aws-cpp-sdk-bcm-recommended-actions/source/model/RequestFilter.cpp +++ b/generated/src/aws-cpp-sdk-bcm-recommended-actions/source/model/RequestFilter.cpp @@ -4,144 +4,44 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMRecommendedActions { namespace Model { -RequestFilter::RequestFilter(const std::shared_ptr& decoder) { *this = decoder; } +RequestFilter::RequestFilter(JsonView jsonValue) { *this = jsonValue; } -RequestFilter& RequestFilter::operator=(const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "actions") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_actions.push_back(ActionFilter(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_actions.push_back(ActionFilter(decoder)); - } - } - } - m_actionsHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("RequestFilter", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "actions") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_actions.push_back(ActionFilter(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_actions.push_back(ActionFilter(decoder)); - } - } - } - m_actionsHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } +RequestFilter& RequestFilter::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("actions")) { + Aws::Utils::Array actionsJsonList = jsonValue.GetArray("actions"); + for (unsigned actionsIndex = 0; actionsIndex < actionsJsonList.GetLength(); ++actionsIndex) { + m_actions.push_back(actionsJsonList[actionsIndex].AsObject()); } + m_actionsHasBeenSet = true; } - return *this; } -void RequestFilter::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_actionsHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); +JsonValue RequestFilter::Jsonize() const { + JsonValue payload; if (m_actionsHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("actions")); - encoder.WriteArrayStart(m_actions.size()); - for (const auto& item_0 : m_actions) { - item_0.CborEncode(encoder); + Aws::Utils::Array actionsJsonList(m_actions.size()); + for (unsigned actionsIndex = 0; actionsIndex < actionsJsonList.GetLength(); ++actionsIndex) { + actionsJsonList[actionsIndex].AsObject(m_actions[actionsIndex].Jsonize()); } + payload.WithArray("actions", std::move(actionsJsonList)); } + + return payload; } } // namespace Model } // namespace BCMRecommendedActions -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-recommended-actions/source/model/ValidationException.cpp b/generated/src/aws-cpp-sdk-bcm-recommended-actions/source/model/ValidationException.cpp index 1dad1283e0d4..b528d539899c 100644 --- a/generated/src/aws-cpp-sdk-bcm-recommended-actions/source/model/ValidationException.cpp +++ b/generated/src/aws-cpp-sdk-bcm-recommended-actions/source/model/ValidationException.cpp @@ -4,239 +4,60 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMRecommendedActions { namespace Model { -ValidationException::ValidationException(const std::shared_ptr& decoder) { *this = decoder; } +ValidationException::ValidationException(JsonView jsonValue) { *this = jsonValue; } -ValidationException& ValidationException::operator=(const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "message") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_message = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_message = ss.str(); - } - } - m_messageHasBeenSet = true; - } - - else if (initialKeyStr == "reason") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_reason = ValidationExceptionReasonMapper::GetValidationExceptionReasonForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_reasonHasBeenSet = true; - } - - else if (initialKeyStr == "fieldList") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_fieldList.push_back(ValidationExceptionField(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_fieldList.push_back(ValidationExceptionField(decoder)); - } - } - } - m_fieldListHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("ValidationException", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "message") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_message = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_message = ss.str(); - } - } - m_messageHasBeenSet = true; - } - - else if (initialKeyStr == "reason") { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_reason = ValidationExceptionReasonMapper::GetValidationExceptionReasonForName( - Aws::String(reinterpret_cast(val.value().ptr), val.value().len)); - } - m_reasonHasBeenSet = true; - } - - else if (initialKeyStr == "fieldList") { - auto peekType_0 = decoder->PeekType(); - if (peekType_0.has_value() && - (peekType_0.value() == CborType::ArrayStart || peekType_0.value() == CborType::IndefArrayStart)) { - if (peekType_0.value() == CborType::ArrayStart) { - auto listSize_0 = decoder->PopNextArrayStart(); - if (listSize_0.has_value()) { - for (size_t j_0 = 0; j_0 < listSize_0.value(); j_0++) { - m_fieldList.push_back(ValidationExceptionField(decoder)); - } - } - } else // IndefArrayStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefArrayStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType_0 = decoder->PeekType(); - if (!nextType_0.has_value() || nextType_0.value() == CborType::Break) { - if (nextType_0.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - m_fieldList.push_back(ValidationExceptionField(decoder)); - } - } - } - m_fieldListHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } +ValidationException& ValidationException::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("message")) { + m_message = jsonValue.GetString("message"); + m_messageHasBeenSet = true; + } + if (jsonValue.ValueExists("reason")) { + m_reason = ValidationExceptionReasonMapper::GetValidationExceptionReasonForName(jsonValue.GetString("reason")); + m_reasonHasBeenSet = true; + } + if (jsonValue.ValueExists("fieldList")) { + Aws::Utils::Array fieldListJsonList = jsonValue.GetArray("fieldList"); + for (unsigned fieldListIndex = 0; fieldListIndex < fieldListJsonList.GetLength(); ++fieldListIndex) { + m_fieldList.push_back(fieldListJsonList[fieldListIndex].AsObject()); } + m_fieldListHasBeenSet = true; } - return *this; } -void ValidationException::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_messageHasBeenSet) { - mapSize++; - } - if (m_reasonHasBeenSet) { - mapSize++; - } - if (m_fieldListHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); +JsonValue ValidationException::Jsonize() const { + JsonValue payload; if (m_messageHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("message")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_message.c_str())); + payload.WithString("message", m_message); } if (m_reasonHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("reason")); - encoder.WriteText( - Aws::Crt::ByteCursorFromCString(ValidationExceptionReasonMapper::GetNameForValidationExceptionReason(m_reason).c_str())); + payload.WithString("reason", ValidationExceptionReasonMapper::GetNameForValidationExceptionReason(m_reason)); } if (m_fieldListHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("fieldList")); - encoder.WriteArrayStart(m_fieldList.size()); - for (const auto& item_0 : m_fieldList) { - item_0.CborEncode(encoder); + Aws::Utils::Array fieldListJsonList(m_fieldList.size()); + for (unsigned fieldListIndex = 0; fieldListIndex < fieldListJsonList.GetLength(); ++fieldListIndex) { + fieldListJsonList[fieldListIndex].AsObject(m_fieldList[fieldListIndex].Jsonize()); } + payload.WithArray("fieldList", std::move(fieldListJsonList)); } + + return payload; } } // namespace Model } // namespace BCMRecommendedActions -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bcm-recommended-actions/source/model/ValidationExceptionField.cpp b/generated/src/aws-cpp-sdk-bcm-recommended-actions/source/model/ValidationExceptionField.cpp index 5599de4ee423..53d85badd495 100644 --- a/generated/src/aws-cpp-sdk-bcm-recommended-actions/source/model/ValidationExceptionField.cpp +++ b/generated/src/aws-cpp-sdk-bcm-recommended-actions/source/model/ValidationExceptionField.cpp @@ -4,211 +4,45 @@ */ #include -#include -#include +#include #include -using namespace Aws::Crt::Cbor; +using namespace Aws::Utils::Json; using namespace Aws::Utils; namespace Aws { namespace BCMRecommendedActions { namespace Model { -ValidationExceptionField::ValidationExceptionField(const std::shared_ptr& decoder) { *this = decoder; } +ValidationExceptionField::ValidationExceptionField(JsonView jsonValue) { *this = jsonValue; } -ValidationExceptionField& ValidationExceptionField::operator=(const std::shared_ptr& decoder) { - if (decoder != nullptr) { - auto initialMapType = decoder->PeekType(); - if (initialMapType.has_value() && (initialMapType.value() == CborType::MapStart || initialMapType.value() == CborType::IndefMapStart)) { - if (initialMapType.value() == CborType::MapStart) { - auto mapSize = decoder->PopNextMapStart(); - if (mapSize.has_value()) { - for (size_t i = 0; i < mapSize.value(); ++i) { - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "name") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_name = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_name = ss.str(); - } - } - m_nameHasBeenSet = true; - } - - else if (initialKeyStr == "message") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_message = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_message = ss.str(); - } - } - m_messageHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - if ((decoder->LastError() != AWS_ERROR_UNKNOWN)) { - AWS_LOG_ERROR("ValidationExceptionField", "Invalid data received for %s", initialKeyStr.c_str()); - break; - } - } - } - } - } else // IndefMapStart - { - decoder->ConsumeNextSingleElement(); // consume the IndefMapStart - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto outerMapNextType = decoder->PeekType(); - if (!outerMapNextType.has_value() || outerMapNextType.value() == CborType::Break) { - if (outerMapNextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - - auto initialKey = decoder->PopNextTextVal(); - if (initialKey.has_value()) { - Aws::String initialKeyStr(reinterpret_cast(initialKey.value().ptr), initialKey.value().len); - - if (initialKeyStr == "name") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_name = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_name = ss.str(); - } - } - m_nameHasBeenSet = true; - } - - else if (initialKeyStr == "message") { - auto peekType = decoder->PeekType(); - if (peekType.has_value()) { - if (peekType.value() == Aws::Crt::Cbor::CborType::Text) { - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - m_message = Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } else { - decoder->ConsumeNextSingleElement(); - Aws::StringStream ss; - while (decoder->LastError() == AWS_ERROR_UNKNOWN) { - auto nextType = decoder->PeekType(); - if (!nextType.has_value() || nextType.value() == CborType::Break) { - if (nextType.has_value()) { - decoder->ConsumeNextSingleElement(); // consume the Break - } - break; - } - auto val = decoder->PopNextTextVal(); - if (val.has_value()) { - ss << Aws::String(reinterpret_cast(val.value().ptr), val.value().len); - } - } - m_message = ss.str(); - } - } - m_messageHasBeenSet = true; - } else { - // Unknown key, skip the value - decoder->ConsumeNextWholeDataItem(); - } - } - } - } - } +ValidationExceptionField& ValidationExceptionField::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("name")) { + m_name = jsonValue.GetString("name"); + m_nameHasBeenSet = true; + } + if (jsonValue.ValueExists("message")) { + m_message = jsonValue.GetString("message"); + m_messageHasBeenSet = true; } - return *this; } -void ValidationExceptionField::CborEncode(Aws::Crt::Cbor::CborEncoder& encoder) const { - // Calculate map size - size_t mapSize = 0; - if (m_nameHasBeenSet) { - mapSize++; - } - if (m_messageHasBeenSet) { - mapSize++; - } - - encoder.WriteMapStart(mapSize); +JsonValue ValidationExceptionField::Jsonize() const { + JsonValue payload; if (m_nameHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("name")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_name.c_str())); + payload.WithString("name", m_name); } if (m_messageHasBeenSet) { - encoder.WriteText(Aws::Crt::ByteCursorFromCString("message")); - encoder.WriteText(Aws::Crt::ByteCursorFromCString(m_message.c_str())); + payload.WithString("message", m_message); } + + return payload; } } // namespace Model } // namespace BCMRecommendedActions -} // namespace Aws \ No newline at end of file +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bedrock-agentcore-control/include/aws/bedrock-agentcore-control/model/EvaluatorModelConfig.h b/generated/src/aws-cpp-sdk-bedrock-agentcore-control/include/aws/bedrock-agentcore-control/model/EvaluatorModelConfig.h index 0523421567a4..ccf5323d66ea 100644 --- a/generated/src/aws-cpp-sdk-bedrock-agentcore-control/include/aws/bedrock-agentcore-control/model/EvaluatorModelConfig.h +++ b/generated/src/aws-cpp-sdk-bedrock-agentcore-control/include/aws/bedrock-agentcore-control/model/EvaluatorModelConfig.h @@ -6,6 +6,7 @@ #pragma once #include #include +#include #include @@ -49,9 +50,30 @@ class EvaluatorModelConfig { return *this; } ///@} + + ///@{ + /** + *

The OpenResponses model configuration for evaluation.

+ */ + inline const OpenResponsesEvaluatorModelConfig& GetResponsesEvaluatorModelConfig() const { return m_responsesEvaluatorModelConfig; } + inline bool ResponsesEvaluatorModelConfigHasBeenSet() const { return m_responsesEvaluatorModelConfigHasBeenSet; } + template + void SetResponsesEvaluatorModelConfig(ResponsesEvaluatorModelConfigT&& value) { + m_responsesEvaluatorModelConfigHasBeenSet = true; + m_responsesEvaluatorModelConfig = std::forward(value); + } + template + EvaluatorModelConfig& WithResponsesEvaluatorModelConfig(ResponsesEvaluatorModelConfigT&& value) { + SetResponsesEvaluatorModelConfig(std::forward(value)); + return *this; + } + ///@} private: BedrockEvaluatorModelConfig m_bedrockEvaluatorModelConfig; + + OpenResponsesEvaluatorModelConfig m_responsesEvaluatorModelConfig; bool m_bedrockEvaluatorModelConfigHasBeenSet = false; + bool m_responsesEvaluatorModelConfigHasBeenSet = false; }; } // namespace Model diff --git a/generated/src/aws-cpp-sdk-bedrock-agentcore-control/include/aws/bedrock-agentcore-control/model/OpenResponsesEvaluatorModelConfig.h b/generated/src/aws-cpp-sdk-bedrock-agentcore-control/include/aws/bedrock-agentcore-control/model/OpenResponsesEvaluatorModelConfig.h new file mode 100644 index 000000000000..dde39c82e5ad --- /dev/null +++ b/generated/src/aws-cpp-sdk-bedrock-agentcore-control/include/aws/bedrock-agentcore-control/model/OpenResponsesEvaluatorModelConfig.h @@ -0,0 +1,143 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include + +#include + +namespace Aws { +namespace Utils { +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json +} // namespace Utils +namespace BedrockAgentCoreControl { +namespace Model { + +/** + *

The configuration for using models served through the OpenResponses API in + * evaluator assessments, including model selection and inference parameters. + *

See Also:

AWS + * API Reference

+ */ +class OpenResponsesEvaluatorModelConfig { + public: + AWS_BEDROCKAGENTCORECONTROL_API OpenResponsesEvaluatorModelConfig() = default; + AWS_BEDROCKAGENTCORECONTROL_API OpenResponsesEvaluatorModelConfig(Aws::Utils::Json::JsonView jsonValue); + AWS_BEDROCKAGENTCORECONTROL_API OpenResponsesEvaluatorModelConfig& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BEDROCKAGENTCORECONTROL_API Aws::Utils::Json::JsonValue Jsonize() const; + + ///@{ + /** + *

The identifier of the model to use for evaluation.

+ */ + inline const Aws::String& GetModelId() const { return m_modelId; } + inline bool ModelIdHasBeenSet() const { return m_modelIdHasBeenSet; } + template + void SetModelId(ModelIdT&& value) { + m_modelIdHasBeenSet = true; + m_modelId = std::forward(value); + } + template + OpenResponsesEvaluatorModelConfig& WithModelId(ModelIdT&& value) { + SetModelId(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The maximum number of tokens to generate in the model response, including + * visible output and reasoning tokens.

+ */ + inline int GetMaxOutputTokens() const { return m_maxOutputTokens; } + inline bool MaxOutputTokensHasBeenSet() const { return m_maxOutputTokensHasBeenSet; } + inline void SetMaxOutputTokens(int value) { + m_maxOutputTokensHasBeenSet = true; + m_maxOutputTokens = value; + } + inline OpenResponsesEvaluatorModelConfig& WithMaxOutputTokens(int value) { + SetMaxOutputTokens(value); + return *this; + } + ///@} + + ///@{ + /** + *

The temperature value that controls randomness in the model's responses. + * Lower values produce more deterministic outputs.

+ */ + inline double GetTemperature() const { return m_temperature; } + inline bool TemperatureHasBeenSet() const { return m_temperatureHasBeenSet; } + inline void SetTemperature(double value) { + m_temperatureHasBeenSet = true; + m_temperature = value; + } + inline OpenResponsesEvaluatorModelConfig& WithTemperature(double value) { + SetTemperature(value); + return *this; + } + ///@} + + ///@{ + /** + *

The top-p sampling parameter that controls the diversity of the model's + * responses by limiting the cumulative probability of token choices.

+ */ + inline double GetTopP() const { return m_topP; } + inline bool TopPHasBeenSet() const { return m_topPHasBeenSet; } + inline void SetTopP(double value) { + m_topPHasBeenSet = true; + m_topP = value; + } + inline OpenResponsesEvaluatorModelConfig& WithTopP(double value) { + SetTopP(value); + return *this; + } + ///@} + + ///@{ + /** + *

The reasoning configuration for reasoning models. Non-reasoning models + * ignore this configuration.

+ */ + inline const ReasoningConfiguration& GetReasoning() const { return m_reasoning; } + inline bool ReasoningHasBeenSet() const { return m_reasoningHasBeenSet; } + template + void SetReasoning(ReasoningT&& value) { + m_reasoningHasBeenSet = true; + m_reasoning = std::forward(value); + } + template + OpenResponsesEvaluatorModelConfig& WithReasoning(ReasoningT&& value) { + SetReasoning(std::forward(value)); + return *this; + } + ///@} + private: + Aws::String m_modelId; + + int m_maxOutputTokens{0}; + + double m_temperature{0.0}; + + double m_topP{0.0}; + + ReasoningConfiguration m_reasoning; + bool m_modelIdHasBeenSet = false; + bool m_maxOutputTokensHasBeenSet = false; + bool m_temperatureHasBeenSet = false; + bool m_topPHasBeenSet = false; + bool m_reasoningHasBeenSet = false; +}; + +} // namespace Model +} // namespace BedrockAgentCoreControl +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bedrock-agentcore-control/include/aws/bedrock-agentcore-control/model/ReasoningConfiguration.h b/generated/src/aws-cpp-sdk-bedrock-agentcore-control/include/aws/bedrock-agentcore-control/model/ReasoningConfiguration.h new file mode 100644 index 000000000000..a87991f49706 --- /dev/null +++ b/generated/src/aws-cpp-sdk-bedrock-agentcore-control/include/aws/bedrock-agentcore-control/model/ReasoningConfiguration.h @@ -0,0 +1,60 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include + +#include + +namespace Aws { +namespace Utils { +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json +} // namespace Utils +namespace BedrockAgentCoreControl { +namespace Model { + +/** + *

The reasoning configuration that controls how a reasoning model allocates + * effort during evaluation.

See Also:

AWS + * API Reference

+ */ +class ReasoningConfiguration { + public: + AWS_BEDROCKAGENTCORECONTROL_API ReasoningConfiguration() = default; + AWS_BEDROCKAGENTCORECONTROL_API ReasoningConfiguration(Aws::Utils::Json::JsonView jsonValue); + AWS_BEDROCKAGENTCORECONTROL_API ReasoningConfiguration& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_BEDROCKAGENTCORECONTROL_API Aws::Utils::Json::JsonValue Jsonize() const; + + ///@{ + /** + *

The level of reasoning effort the model applies when generating a response. + * For supported values, see the model provider's documentation.

+ */ + inline const Aws::String& GetEffort() const { return m_effort; } + inline bool EffortHasBeenSet() const { return m_effortHasBeenSet; } + template + void SetEffort(EffortT&& value) { + m_effortHasBeenSet = true; + m_effort = std::forward(value); + } + template + ReasoningConfiguration& WithEffort(EffortT&& value) { + SetEffort(std::forward(value)); + return *this; + } + ///@} + private: + Aws::String m_effort; + bool m_effortHasBeenSet = false; +}; + +} // namespace Model +} // namespace BedrockAgentCoreControl +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bedrock-agentcore-control/source/model/EvaluatorModelConfig.cpp b/generated/src/aws-cpp-sdk-bedrock-agentcore-control/source/model/EvaluatorModelConfig.cpp index 59ca30cf6a82..07d34e9c6f79 100644 --- a/generated/src/aws-cpp-sdk-bedrock-agentcore-control/source/model/EvaluatorModelConfig.cpp +++ b/generated/src/aws-cpp-sdk-bedrock-agentcore-control/source/model/EvaluatorModelConfig.cpp @@ -22,6 +22,10 @@ EvaluatorModelConfig& EvaluatorModelConfig::operator=(JsonView jsonValue) { m_bedrockEvaluatorModelConfig = jsonValue.GetObject("bedrockEvaluatorModelConfig"); m_bedrockEvaluatorModelConfigHasBeenSet = true; } + if (jsonValue.ValueExists("responsesEvaluatorModelConfig")) { + m_responsesEvaluatorModelConfig = jsonValue.GetObject("responsesEvaluatorModelConfig"); + m_responsesEvaluatorModelConfigHasBeenSet = true; + } return *this; } @@ -32,6 +36,10 @@ JsonValue EvaluatorModelConfig::Jsonize() const { payload.WithObject("bedrockEvaluatorModelConfig", m_bedrockEvaluatorModelConfig.Jsonize()); } + if (m_responsesEvaluatorModelConfigHasBeenSet) { + payload.WithObject("responsesEvaluatorModelConfig", m_responsesEvaluatorModelConfig.Jsonize()); + } + return payload; } diff --git a/generated/src/aws-cpp-sdk-bedrock-agentcore-control/source/model/OpenResponsesEvaluatorModelConfig.cpp b/generated/src/aws-cpp-sdk-bedrock-agentcore-control/source/model/OpenResponsesEvaluatorModelConfig.cpp new file mode 100644 index 000000000000..2984dd436d49 --- /dev/null +++ b/generated/src/aws-cpp-sdk-bedrock-agentcore-control/source/model/OpenResponsesEvaluatorModelConfig.cpp @@ -0,0 +1,72 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include + +#include + +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +namespace Aws { +namespace BedrockAgentCoreControl { +namespace Model { + +OpenResponsesEvaluatorModelConfig::OpenResponsesEvaluatorModelConfig(JsonView jsonValue) { *this = jsonValue; } + +OpenResponsesEvaluatorModelConfig& OpenResponsesEvaluatorModelConfig::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("modelId")) { + m_modelId = jsonValue.GetString("modelId"); + m_modelIdHasBeenSet = true; + } + if (jsonValue.ValueExists("maxOutputTokens")) { + m_maxOutputTokens = jsonValue.GetInteger("maxOutputTokens"); + m_maxOutputTokensHasBeenSet = true; + } + if (jsonValue.ValueExists("temperature")) { + m_temperature = jsonValue.GetDouble("temperature"); + m_temperatureHasBeenSet = true; + } + if (jsonValue.ValueExists("topP")) { + m_topP = jsonValue.GetDouble("topP"); + m_topPHasBeenSet = true; + } + if (jsonValue.ValueExists("reasoning")) { + m_reasoning = jsonValue.GetObject("reasoning"); + m_reasoningHasBeenSet = true; + } + return *this; +} + +JsonValue OpenResponsesEvaluatorModelConfig::Jsonize() const { + JsonValue payload; + + if (m_modelIdHasBeenSet) { + payload.WithString("modelId", m_modelId); + } + + if (m_maxOutputTokensHasBeenSet) { + payload.WithInteger("maxOutputTokens", m_maxOutputTokens); + } + + if (m_temperatureHasBeenSet) { + payload.WithDouble("temperature", m_temperature); + } + + if (m_topPHasBeenSet) { + payload.WithDouble("topP", m_topP); + } + + if (m_reasoningHasBeenSet) { + payload.WithObject("reasoning", m_reasoning.Jsonize()); + } + + return payload; +} + +} // namespace Model +} // namespace BedrockAgentCoreControl +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-bedrock-agentcore-control/source/model/ReasoningConfiguration.cpp b/generated/src/aws-cpp-sdk-bedrock-agentcore-control/source/model/ReasoningConfiguration.cpp new file mode 100644 index 000000000000..c089292ca82a --- /dev/null +++ b/generated/src/aws-cpp-sdk-bedrock-agentcore-control/source/model/ReasoningConfiguration.cpp @@ -0,0 +1,40 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include + +#include + +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +namespace Aws { +namespace BedrockAgentCoreControl { +namespace Model { + +ReasoningConfiguration::ReasoningConfiguration(JsonView jsonValue) { *this = jsonValue; } + +ReasoningConfiguration& ReasoningConfiguration::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("effort")) { + m_effort = jsonValue.GetString("effort"); + m_effortHasBeenSet = true; + } + return *this; +} + +JsonValue ReasoningConfiguration::Jsonize() const { + JsonValue payload; + + if (m_effortHasBeenSet) { + payload.WithString("effort", m_effort); + } + + return payload; +} + +} // namespace Model +} // namespace BedrockAgentCoreControl +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-iam/include/aws/iam/IAMClient.h b/generated/src/aws-cpp-sdk-iam/include/aws/iam/IAMClient.h index dd6259cc48b0..f9426138ee5b 100644 --- a/generated/src/aws-cpp-sdk-iam/include/aws/iam/IAMClient.h +++ b/generated/src/aws-cpp-sdk-iam/include/aws/iam/IAMClient.h @@ -2661,8 +2661,11 @@ class AWS_IAM_API IAMClient : public Aws::Client::AWSXMLClient, * GetContextKeysForPrincipalPolicy * to understand what key names and values you must supply when you call SimulatePrincipalPolicy.

See - * Also:

SimulatePrincipalPolicy. + * This operation doesn't return context keys referenced by service control + * policies (SCPs). Only context keys referenced by the identity-based policies + * attached to the specified entity, and any additional policies that you provide, + * are included.

See Also:

AWS * API Reference

*/ @@ -5383,8 +5386,9 @@ class AWS_IAM_API IAMClient : public Aws::Client::AWSXMLClient, * href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_GetContextKeysForCustomPolicy.html">GetContextKeysForCustomPolicy.

*

If the output is long, you can use MaxItems and * Marker parameters to paginate the results.

The IAM - * policy simulator evaluates statements in the identity-based policy and the - * inputs that you provide during simulation. The policy simulator results can + * policy simulator evaluates statements in identity-based policies, service + * control policies (SCPs) including their condition keys and resource scoping, and + * the inputs that you provide during simulation. The policy simulator results can * differ from your live Amazon Web Services environment. We recommend that you * check your policies against your live Amazon Web Services environment after * testing using the policy simulator to confirm that you have the desired results. @@ -5430,9 +5434,14 @@ class AWS_IAM_API IAMClient : public Aws::Client::AWSXMLClient, * evaluated with each of the resources included in the simulation for IAM users * only.

The simulation does not perform the API operations; it only checks * the authorization to determine if the simulated policies allow or deny the - * operations.

Note: This operation discloses information about the - * permissions granted to other users. If you do not want users to see other user's - * permissions, then consider allowing them to use

For cross-account simulations, + * EvalDecisionDetails returns the decision for each policy type + * (identity-based policy, resource-based policy, and permissions boundary). This + * helps you identify which policy type is responsible for an allow or deny + * decision when policies span multiple accounts.

Note: This + * operation discloses information about the permissions granted to other users. If + * you do not want users to see other user's permissions, then consider allowing + * them to use SimulateCustomPolicy * instead.

Context keys are variables maintained by Amazon Web Services and * its services that provide details about the context of an API query request. You @@ -5442,8 +5451,9 @@ class AWS_IAM_API IAMClient : public Aws::Client::AWSXMLClient, * href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_GetContextKeysForPrincipalPolicy.html">GetContextKeysForPrincipalPolicy.

*

If the output is long, you can use the MaxItems and * Marker parameters to paginate the results.

The IAM - * policy simulator evaluates statements in the identity-based policy and the - * inputs that you provide during simulation. The policy simulator results can + * policy simulator evaluates statements in identity-based policies, service + * control policies (SCPs) including their condition keys and resource scoping, and + * the inputs that you provide during simulation. The policy simulator results can * differ from your live Amazon Web Services environment. We recommend that you * check your policies against your live Amazon Web Services environment after * testing using the policy simulator to confirm that you have the desired results. diff --git a/generated/src/aws-cpp-sdk-iam/include/aws/iam/model/AttachmentType.h b/generated/src/aws-cpp-sdk-iam/include/aws/iam/model/AttachmentType.h new file mode 100644 index 000000000000..b90acb077915 --- /dev/null +++ b/generated/src/aws-cpp-sdk-iam/include/aws/iam/model/AttachmentType.h @@ -0,0 +1,22 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include + +namespace Aws { +namespace IAM { +namespace Model { +enum class AttachmentType { NOT_SET, user, group, role }; + +namespace AttachmentTypeMapper { +AWS_IAM_API AttachmentType GetAttachmentTypeForName(const Aws::String& name); + +AWS_IAM_API Aws::String GetNameForAttachmentType(AttachmentType value); +} // namespace AttachmentTypeMapper +} // namespace Model +} // namespace IAM +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-iam/include/aws/iam/model/EvaluationResult.h b/generated/src/aws-cpp-sdk-iam/include/aws/iam/model/EvaluationResult.h index 33442e7dcc18..655ca6f4b4e2 100644 --- a/generated/src/aws-cpp-sdk-iam/include/aws/iam/model/EvaluationResult.h +++ b/generated/src/aws-cpp-sdk-iam/include/aws/iam/model/EvaluationResult.h @@ -32,7 +32,21 @@ namespace Model { * href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_SimulateCustomPolicy.html">SimulateCustomPolicy * and SimulatePrincipalPolicy - * .

See Also:

.

The simulator now returns a single + * EvaluationResult per action, regardless of how many resource ARNs + * are provided. Previously, simulating one action against N resources returned N + * evaluation results, each containing the same aggregate decision. The top-level + * fields (EvalDecision, MatchedStatements, + * MissingContextValues, EvalDecisionDetails) now + * represent the aggregate decision across all requested resources. The + * top-level EvalDecision reflects the most restrictive decision + * across all resources (for example, if any resource produces + * explicitDeny, the top-level decision is + * explicitDeny).

To see the decision for each individual + * resource, use ResourceSpecificResults. If your application parses + * evaluation results per resource ARN, update your code to read per-resource + * decisions from ResourceSpecificResults rather than from the + * top-level result.

See Also:

AWS * API Reference

*/ @@ -65,7 +79,14 @@ class EvaluationResult { ///@{ /** - *

The ARN of the resource that the indicated API operation was tested on.

+ *

The ARN template for the simulated resource type (for example, + * arn:${Partition}:s3:::${BucketName}/${KeyName}), or * + * if no ARN format is defined for the action. This is not a specific + * customer-provided resource ARN. To find the decision for a specific resource, + * use ResourceSpecificResults.

If you previously relied + * on EvalResourceName to identify which specific resource a result + * applies to, you must now use the EvalResourceName field within + * individual entries in ResourceSpecificResults instead.

*/ inline const Aws::String& GetEvalResourceName() const { return m_evalResourceName; } inline bool EvalResourceNameHasBeenSet() const { return m_evalResourceNameHasBeenSet; } @@ -103,7 +124,12 @@ class EvaluationResult { * this scenario. Remember that even if multiple statements allow the operation on * the resource, if only one statement denies that operation, then the explicit * deny overrides any allow. In addition, the deny statement is the only entry - * included in the result.

+ * included in the result.

In the top-level result, this field contains the + * union of matched statements across all requested resources. Only statements that + * contributed to the reported decision are included. For per-resource matched + * statements, see ResourceSpecificResults. This field doesn't include + * statements from service control policies (SCPs). Only statements from + * identity-based and resource-based policies appear here.

*/ inline const Aws::Vector& GetMatchedStatements() const { return m_matchedStatements; } inline bool MatchedStatementsHasBeenSet() const { return m_matchedStatementsHasBeenSet; } @@ -137,6 +163,10 @@ class EvaluationResult { * href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_GetContextKeysForCustomPolicy.html">GetContextKeysForCustomPolicy * or GetContextKeysForPrincipalPolicy.

+ *

In the top-level result, this field contains the deduplicated set of missing + * context values across all requested resources. This field doesn't include + * context keys referenced by service control policies (SCPs). Only context keys + * referenced by identity-based and resource-based policies appear here.

*/ inline const Aws::Vector& GetMissingContextValues() const { return m_missingContextValues; } inline bool MissingContextValuesHasBeenSet() const { return m_missingContextValuesHasBeenSet; } @@ -162,7 +192,9 @@ class EvaluationResult { /** *

A structure that details how Organizations and its service control policies * affect the results of the simulation. Only applies if the simulated user's - * account is part of an organization.

+ * account is part of an organization.

For resources that don't support + * organization-level evaluation, this field is omitted from the top-level result. + * For per-resource details, see ResourceSpecificResults.

*/ inline const OrganizationsDecisionDetail& GetOrganizationsDecisionDetail() const { return m_organizationsDecisionDetail; } inline bool OrganizationsDecisionDetailHasBeenSet() const { return m_organizationsDecisionDetailHasBeenSet; } @@ -204,14 +236,16 @@ class EvaluationResult { *

Additional details about the results of the cross-account evaluation * decision. This parameter is populated for only cross-account simulations. It * contains a brief summary of how each policy type contributes to the final - * evaluation decision.

If the simulation evaluates policies within the same - * account and includes a resource ARN, then the parameter is present but the - * response is empty. If the simulation evaluates policies within the same account - * and specifies all resources (*), then the parameter is not - * returned.

When you make a cross-account request, Amazon Web Services - * evaluates the request in the trusting account and the trusted account. The - * request is allowed only if both evaluations return true. For more - * information about how policies are evaluated, see

In the top-level result, this map reports the most + * restrictive decision per policy type across all requested resources.

If + * the simulation evaluates policies within the same account and includes a + * resource ARN, then the parameter is present but the response is empty. If the + * simulation evaluates policies within the same account and specifies all + * resources (*), then the parameter is not returned.

When you + * make a cross-account request, Amazon Web Services evaluates the request in the + * trusting account and the trusted account. The request is allowed only if both + * evaluations return true. For more information about how policies + * are evaluated, see Evaluating * policies within a single account.

If an Organizations SCP included in * the evaluation denies access, the simulation ends. In this case, policy diff --git a/generated/src/aws-cpp-sdk-iam/include/aws/iam/model/InlinePolicyIdentifierType.h b/generated/src/aws-cpp-sdk-iam/include/aws/iam/model/InlinePolicyIdentifierType.h new file mode 100644 index 000000000000..c7b61f146125 --- /dev/null +++ b/generated/src/aws-cpp-sdk-iam/include/aws/iam/model/InlinePolicyIdentifierType.h @@ -0,0 +1,108 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include +#include + +#include + +namespace Aws { +namespace Utils { +namespace Xml { +class XmlNode; +} // namespace Xml +} // namespace Utils +namespace IAM { +namespace Model { + +/** + *

Identifies one or more inline policies that are embedded in IAM users, + * groups, or roles, by the name of the policy together with the type and name of + * the entity that it is attached to. Wildcard characters in the entity name can + * match multiple entities, so a single identifier can select more than one + * attached inline policy.

See Also:

AWS + * API Reference

+ */ +class InlinePolicyIdentifierType { + public: + AWS_IAM_API InlinePolicyIdentifierType() = default; + AWS_IAM_API InlinePolicyIdentifierType(const Aws::Utils::Xml::XmlNode& xmlNode); + AWS_IAM_API InlinePolicyIdentifierType& operator=(const Aws::Utils::Xml::XmlNode& xmlNode); + + AWS_IAM_API void OutputToStream(Aws::OStream& ostream, const char* location, unsigned index, const char* locationValue) const; + AWS_IAM_API void OutputToStream(Aws::OStream& oStream, const char* location) const; + + ///@{ + /** + *

The name of the inline policy.

+ */ + inline const Aws::String& GetPolicyName() const { return m_policyName; } + inline bool PolicyNameHasBeenSet() const { return m_policyNameHasBeenSet; } + template + void SetPolicyName(PolicyNameT&& value) { + m_policyNameHasBeenSet = true; + m_policyName = std::forward(value); + } + template + InlinePolicyIdentifierType& WithPolicyName(PolicyNameT&& value) { + SetPolicyName(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The type of IAM entity that the inline policy is attached to.

+ */ + inline AttachmentType GetAttachmentType() const { return m_attachmentType; } + inline bool AttachmentTypeHasBeenSet() const { return m_attachmentTypeHasBeenSet; } + inline void SetAttachmentType(AttachmentType value) { + m_attachmentTypeHasBeenSet = true; + m_attachmentType = value; + } + inline InlinePolicyIdentifierType& WithAttachmentType(AttachmentType value) { + SetAttachmentType(value); + return *this; + } + ///@} + + ///@{ + /** + *

The name of the IAM user, group, or role that the inline policy is attached + * to. Wildcard characters are supported to match multiple entities: use at most + * one * (matches any sequence of characters, including none), and any + * number of ? (each matches exactly one character).

+ */ + inline const Aws::String& GetAttachmentName() const { return m_attachmentName; } + inline bool AttachmentNameHasBeenSet() const { return m_attachmentNameHasBeenSet; } + template + void SetAttachmentName(AttachmentNameT&& value) { + m_attachmentNameHasBeenSet = true; + m_attachmentName = std::forward(value); + } + template + InlinePolicyIdentifierType& WithAttachmentName(AttachmentNameT&& value) { + SetAttachmentName(std::forward(value)); + return *this; + } + ///@} + private: + Aws::String m_policyName; + + AttachmentType m_attachmentType{AttachmentType::NOT_SET}; + + Aws::String m_attachmentName; + bool m_policyNameHasBeenSet = false; + bool m_attachmentTypeHasBeenSet = false; + bool m_attachmentNameHasBeenSet = false; +}; + +} // namespace Model +} // namespace IAM +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-iam/include/aws/iam/model/OrderedOrganizationPolicyType.h b/generated/src/aws-cpp-sdk-iam/include/aws/iam/model/OrderedOrganizationPolicyType.h new file mode 100644 index 000000000000..486cd2fc4c0e --- /dev/null +++ b/generated/src/aws-cpp-sdk-iam/include/aws/iam/model/OrderedOrganizationPolicyType.h @@ -0,0 +1,76 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include +#include + +#include + +namespace Aws { +namespace Utils { +namespace Xml { +class XmlNode; +} // namespace Xml +} // namespace Utils +namespace IAM { +namespace Model { + +/** + *

Represents one level of an Organizations hierarchy—the organization root, an + * organizational unit (OU), or an account—together with the service control + * policies (SCPs) that apply at that level. Each element in the list represents + * one level of the hierarchy, ordered from the organization root down to the + * account.

For more information about SCPs, see Service + * control policies (SCPs) in the Organizations User + * Guide.

See Also:

AWS + * API Reference

+ */ +class OrderedOrganizationPolicyType { + public: + AWS_IAM_API OrderedOrganizationPolicyType() = default; + AWS_IAM_API OrderedOrganizationPolicyType(const Aws::Utils::Xml::XmlNode& xmlNode); + AWS_IAM_API OrderedOrganizationPolicyType& operator=(const Aws::Utils::Xml::XmlNode& xmlNode); + + AWS_IAM_API void OutputToStream(Aws::OStream& ostream, const char* location, unsigned index, const char* locationValue) const; + AWS_IAM_API void OutputToStream(Aws::OStream& oStream, const char* location) const; + + ///@{ + /** + *

A list of SCP documents that apply at this level of the Organizations + * hierarchy. Each document is specified as a string containing the complete, valid + * JSON text of an SCP.

+ */ + inline const Aws::Vector& GetServiceControlPolicyInputList() const { return m_serviceControlPolicyInputList; } + inline bool ServiceControlPolicyInputListHasBeenSet() const { return m_serviceControlPolicyInputListHasBeenSet; } + template > + void SetServiceControlPolicyInputList(ServiceControlPolicyInputListT&& value) { + m_serviceControlPolicyInputListHasBeenSet = true; + m_serviceControlPolicyInputList = std::forward(value); + } + template > + OrderedOrganizationPolicyType& WithServiceControlPolicyInputList(ServiceControlPolicyInputListT&& value) { + SetServiceControlPolicyInputList(std::forward(value)); + return *this; + } + template + OrderedOrganizationPolicyType& AddServiceControlPolicyInputList(ServiceControlPolicyInputListT&& value) { + m_serviceControlPolicyInputListHasBeenSet = true; + m_serviceControlPolicyInputList.emplace_back(std::forward(value)); + return *this; + } + ///@} + private: + Aws::Vector m_serviceControlPolicyInputList; + bool m_serviceControlPolicyInputListHasBeenSet = false; +}; + +} // namespace Model +} // namespace IAM +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-iam/include/aws/iam/model/PolicyIdentifier.h b/generated/src/aws-cpp-sdk-iam/include/aws/iam/model/PolicyIdentifier.h new file mode 100644 index 000000000000..1f34db823bdc --- /dev/null +++ b/generated/src/aws-cpp-sdk-iam/include/aws/iam/model/PolicyIdentifier.h @@ -0,0 +1,117 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include +#include +#include + +#include + +namespace Aws { +namespace Utils { +namespace Xml { +class XmlNode; +} // namespace Xml +} // namespace Utils +namespace IAM { +namespace Model { + +/** + *

Identifies one or more policies as a union type. Specify exactly one of + * PolicyType, PolicyArn, or + * InlinePolicyIdentifier to identify policies by their type, by + * Amazon Resource Name (ARN), or by the name of an inline policy and the entity it + * is attached to.

See Also:

AWS + * API Reference

+ */ +class PolicyIdentifier { + public: + AWS_IAM_API PolicyIdentifier() = default; + AWS_IAM_API PolicyIdentifier(const Aws::Utils::Xml::XmlNode& xmlNode); + AWS_IAM_API PolicyIdentifier& operator=(const Aws::Utils::Xml::XmlNode& xmlNode); + + AWS_IAM_API void OutputToStream(Aws::OStream& ostream, const char* location, unsigned index, const char* locationValue) const; + AWS_IAM_API void OutputToStream(Aws::OStream& oStream, const char* location) const; + + ///@{ + /** + *

The policy type to identify. All policies of the specified type are + * matched.

+ */ + inline PolicyIdentifierPolicyType GetPolicyType() const { return m_policyType; } + inline bool PolicyTypeHasBeenSet() const { return m_policyTypeHasBeenSet; } + inline void SetPolicyType(PolicyIdentifierPolicyType value) { + m_policyTypeHasBeenSet = true; + m_policyType = value; + } + inline PolicyIdentifier& WithPolicyType(PolicyIdentifierPolicyType value) { + SetPolicyType(value); + return *this; + } + ///@} + + ///@{ + /** + *

The Amazon Resource Name (ARN) of an Amazon Web Services managed policy or a + * customer managed policy that is attached to an IAM user, group, or role. + * Wildcard characters are supported in the resource name portion of the ARN to + * match multiple managed policies: use at most one * (matches any + * sequence of characters, including none), and any number of ? (each + * matches exactly one character).

For more information about ARNs, see Amazon + * Resource Names (ARNs) in the Amazon Web Services General + * Reference.

+ */ + inline const Aws::String& GetPolicyArn() const { return m_policyArn; } + inline bool PolicyArnHasBeenSet() const { return m_policyArnHasBeenSet; } + template + void SetPolicyArn(PolicyArnT&& value) { + m_policyArnHasBeenSet = true; + m_policyArn = std::forward(value); + } + template + PolicyIdentifier& WithPolicyArn(PolicyArnT&& value) { + SetPolicyArn(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

An inline policy identifier consisting of a policy name and the entity it is + * attached to. Wildcard characters (* and ?) in the + * entity name can match multiple entities.

+ */ + inline const InlinePolicyIdentifierType& GetInlinePolicyIdentifier() const { return m_inlinePolicyIdentifier; } + inline bool InlinePolicyIdentifierHasBeenSet() const { return m_inlinePolicyIdentifierHasBeenSet; } + template + void SetInlinePolicyIdentifier(InlinePolicyIdentifierT&& value) { + m_inlinePolicyIdentifierHasBeenSet = true; + m_inlinePolicyIdentifier = std::forward(value); + } + template + PolicyIdentifier& WithInlinePolicyIdentifier(InlinePolicyIdentifierT&& value) { + SetInlinePolicyIdentifier(std::forward(value)); + return *this; + } + ///@} + private: + PolicyIdentifierPolicyType m_policyType{PolicyIdentifierPolicyType::NOT_SET}; + + Aws::String m_policyArn; + + InlinePolicyIdentifierType m_inlinePolicyIdentifier; + bool m_policyTypeHasBeenSet = false; + bool m_policyArnHasBeenSet = false; + bool m_inlinePolicyIdentifierHasBeenSet = false; +}; + +} // namespace Model +} // namespace IAM +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-iam/include/aws/iam/model/PolicyIdentifierPolicyType.h b/generated/src/aws-cpp-sdk-iam/include/aws/iam/model/PolicyIdentifierPolicyType.h new file mode 100644 index 000000000000..21b194829d99 --- /dev/null +++ b/generated/src/aws-cpp-sdk-iam/include/aws/iam/model/PolicyIdentifierPolicyType.h @@ -0,0 +1,22 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include + +namespace Aws { +namespace IAM { +namespace Model { +enum class PolicyIdentifierPolicyType { NOT_SET, inline_, aws_managed, user_managed, permission_boundary, scp, rcp }; + +namespace PolicyIdentifierPolicyTypeMapper { +AWS_IAM_API PolicyIdentifierPolicyType GetPolicyIdentifierPolicyTypeForName(const Aws::String& name); + +AWS_IAM_API Aws::String GetNameForPolicyIdentifierPolicyType(PolicyIdentifierPolicyType value); +} // namespace PolicyIdentifierPolicyTypeMapper +} // namespace Model +} // namespace IAM +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-iam/include/aws/iam/model/SimulateCustomPolicyRequest.h b/generated/src/aws-cpp-sdk-iam/include/aws/iam/model/SimulateCustomPolicyRequest.h index 6bd73e695a07..049143e37986 100644 --- a/generated/src/aws-cpp-sdk-iam/include/aws/iam/model/SimulateCustomPolicyRequest.h +++ b/generated/src/aws-cpp-sdk-iam/include/aws/iam/model/SimulateCustomPolicyRequest.h @@ -9,6 +9,7 @@ #include #include #include +#include #include @@ -125,6 +126,40 @@ class SimulateCustomPolicyRequest : public IAMRequest { } ///@} + ///@{ + /** + *

An ordered list of service control policies (SCPs) to include in the + * simulation. Each element represents one level of an Organizations hierarchy, + * from the organization root to the account.

The simulator evaluates SCPs + * in the order that you provide, consistent with how Organizations enforces SCPs. + * The first element must represent the organization root, and the last element + * must represent the account. Any elements between them represent organizational + * units (OUs) in descending order.

Use this parameter to simulate the + * effect of an SCP hierarchy without calling SimulatePrincipalPolicy.

+ */ + inline const Aws::Vector& GetOrderedOrganizationPolicyInputList() const { + return m_orderedOrganizationPolicyInputList; + } + inline bool OrderedOrganizationPolicyInputListHasBeenSet() const { return m_orderedOrganizationPolicyInputListHasBeenSet; } + template > + void SetOrderedOrganizationPolicyInputList(OrderedOrganizationPolicyInputListT&& value) { + m_orderedOrganizationPolicyInputListHasBeenSet = true; + m_orderedOrganizationPolicyInputList = std::forward(value); + } + template > + SimulateCustomPolicyRequest& WithOrderedOrganizationPolicyInputList(OrderedOrganizationPolicyInputListT&& value) { + SetOrderedOrganizationPolicyInputList(std::forward(value)); + return *this; + } + template + SimulateCustomPolicyRequest& AddOrderedOrganizationPolicyInputList(OrderedOrganizationPolicyInputListT&& value) { + m_orderedOrganizationPolicyInputListHasBeenSet = true; + m_orderedOrganizationPolicyInputList.emplace_back(std::forward(value)); + return *this; + } + ///@} + ///@{ /** *

A list of names of API operations to evaluate in the simulation. Each @@ -258,12 +293,11 @@ class SimulateCustomPolicyRequest : public IAMRequest { ///@{ /** - *

The ARN of the IAM user that you want to use as the simulated caller of the - * API operations. CallerArn is required if you include a - * ResourcePolicy so that the policy's Principal element - * has a value to use in evaluating the policy.

You can specify only the ARN - * of an IAM user. You cannot specify the ARN of an assumed role, federated user, - * or a service principal.

+ *

The ARN of the IAM user, group, or role that you want to use as the simulated + * caller of the API operations. CallerArn is required if you include + * a ResourcePolicy so that the policy's Principal + * element has a value to use in evaluating the policy.

You cannot specify + * the ARN of an assumed role, federated user, or a service principal.

*/ inline const Aws::String& GetCallerArn() const { return m_callerArn; } inline bool CallerArnHasBeenSet() const { return m_callerArnHasBeenSet; } @@ -391,6 +425,8 @@ class SimulateCustomPolicyRequest : public IAMRequest { Aws::Vector m_permissionsBoundaryPolicyInputList; + Aws::Vector m_orderedOrganizationPolicyInputList; + Aws::Vector m_actionNames; Aws::Vector m_resourceArns; @@ -410,6 +446,7 @@ class SimulateCustomPolicyRequest : public IAMRequest { Aws::String m_marker; bool m_policyInputListHasBeenSet = false; bool m_permissionsBoundaryPolicyInputListHasBeenSet = false; + bool m_orderedOrganizationPolicyInputListHasBeenSet = false; bool m_actionNamesHasBeenSet = false; bool m_resourceArnsHasBeenSet = false; bool m_resourcePolicyHasBeenSet = false; diff --git a/generated/src/aws-cpp-sdk-iam/include/aws/iam/model/SimulatePrincipalPolicyRequest.h b/generated/src/aws-cpp-sdk-iam/include/aws/iam/model/SimulatePrincipalPolicyRequest.h index d7c1cb3fceaf..87e8f20224d0 100644 --- a/generated/src/aws-cpp-sdk-iam/include/aws/iam/model/SimulatePrincipalPolicyRequest.h +++ b/generated/src/aws-cpp-sdk-iam/include/aws/iam/model/SimulatePrincipalPolicyRequest.h @@ -9,6 +9,7 @@ #include #include #include +#include #include @@ -145,6 +146,41 @@ class SimulatePrincipalPolicyRequest : public IAMRequest { } ///@} + ///@{ + /** + *

A list of policies to exclude from the simulation. Use this parameter to test + * what the simulation result would be if a policy were removed, without changing + * which policies are actually attached to the principal identified by + * PolicySourceArn.

Each entry is a PolicyIdentifier + * that identifies one or more policies to exclude by policy type, by Amazon + * Resource Name (ARN), or by the name of an inline policy and the entity it is + * attached to.

Syntactically invalid identifiers, such as malformed ARNs or + * wildcards in disallowed positions, cause the request to fail with an + * InvalidInput error. Syntactically valid identifiers that don't + * match any attached policy are ignored. Resource control policies (RCPs) are not + * supported in this release; identifiers that target RCPs are also ignored.

+ */ + inline const Aws::Vector& GetPolicyExclusionList() const { return m_policyExclusionList; } + inline bool PolicyExclusionListHasBeenSet() const { return m_policyExclusionListHasBeenSet; } + template > + void SetPolicyExclusionList(PolicyExclusionListT&& value) { + m_policyExclusionListHasBeenSet = true; + m_policyExclusionList = std::forward(value); + } + template > + SimulatePrincipalPolicyRequest& WithPolicyExclusionList(PolicyExclusionListT&& value) { + SetPolicyExclusionList(std::forward(value)); + return *this; + } + template + SimulatePrincipalPolicyRequest& AddPolicyExclusionList(PolicyExclusionListT&& value) { + m_policyExclusionListHasBeenSet = true; + m_policyExclusionList.emplace_back(std::forward(value)); + return *this; + } + ///@} + ///@{ /** *

A list of names of API operations to evaluate in the simulation. Each @@ -272,21 +308,21 @@ class SimulatePrincipalPolicyRequest : public IAMRequest { ///@{ /** - *

The ARN of the IAM user that you want to specify as the simulated caller of - * the API operations. If you do not specify a CallerArn, it defaults - * to the ARN of the user that you specify in PolicySourceArn, if you - * specified a user. If you include both a PolicySourceArn (for - * example, arn:aws:iam::123456789012:user/David) and a - * CallerArn (for example, - * arn:aws:iam::123456789012:user/Bob), the result is that you - * simulate calling the API operations as Bob, as if Bob had David's policies.

- *

You can specify only the ARN of an IAM user. You cannot specify the ARN of an - * assumed role, federated user, or a service principal.

- * CallerArn is required if you include a ResourcePolicy - * and the PolicySourceArn is not the ARN for an IAM user. This is - * required so that the resource-based policy's Principal element has - * a value to use in evaluating the policy.

For more information about ARNs, - * see The ARN of the IAM user, group, or role that you want to specify as the + * simulated caller of the API operations. If you do not specify a + * CallerArn, it defaults to the ARN of the user, group, or role that + * you specify in PolicySourceArn. If you include both a + * PolicySourceArn (for example, + * arn:aws:iam::123456789012:user/David) and a CallerArn + * (for example, arn:aws:iam::123456789012:user/Bob), the result is + * that you simulate calling the API operations as Bob, as if Bob had David's + * policies.

You can specify the ARN of an IAM user, group, or role. You + * cannot specify the ARN of an assumed role, federated user, or a service + * principal.

CallerArn is required if you include a + * ResourcePolicy and the PolicySourceArn is not the ARN + * for an IAM user, group, or role. This is required so that the resource-based + * policy's Principal element has a value to use in evaluating the + * policy.

For more information about ARNs, see Amazon * Resource Names (ARNs) in the Amazon Web Services General * Reference.

@@ -419,6 +455,8 @@ class SimulatePrincipalPolicyRequest : public IAMRequest { Aws::Vector m_permissionsBoundaryPolicyInputList; + Aws::Vector m_policyExclusionList; + Aws::Vector m_actionNames; Aws::Vector m_resourceArns; @@ -439,6 +477,7 @@ class SimulatePrincipalPolicyRequest : public IAMRequest { bool m_policySourceArnHasBeenSet = false; bool m_policyInputListHasBeenSet = false; bool m_permissionsBoundaryPolicyInputListHasBeenSet = false; + bool m_policyExclusionListHasBeenSet = false; bool m_actionNamesHasBeenSet = false; bool m_resourceArnsHasBeenSet = false; bool m_resourcePolicyHasBeenSet = false; diff --git a/generated/src/aws-cpp-sdk-iam/source/model/AttachmentType.cpp b/generated/src/aws-cpp-sdk-iam/source/model/AttachmentType.cpp new file mode 100644 index 000000000000..489d2d613336 --- /dev/null +++ b/generated/src/aws-cpp-sdk-iam/source/model/AttachmentType.cpp @@ -0,0 +1,63 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include +#include +#include + +using namespace Aws::Utils; + +namespace Aws { +namespace IAM { +namespace Model { +namespace AttachmentTypeMapper { + +static const int user_HASH = HashingUtils::HashString("user"); +static const int group_HASH = HashingUtils::HashString("group"); +static const int role_HASH = HashingUtils::HashString("role"); + +AttachmentType GetAttachmentTypeForName(const Aws::String& name) { + int hashCode = HashingUtils::HashString(name.c_str()); + if (hashCode == user_HASH) { + return AttachmentType::user; + } else if (hashCode == group_HASH) { + return AttachmentType::group; + } else if (hashCode == role_HASH) { + return AttachmentType::role; + } + EnumParseOverflowContainer* overflowContainer = Aws::GetEnumOverflowContainer(); + if (overflowContainer) { + overflowContainer->StoreOverflow(hashCode, name); + return static_cast(hashCode); + } + + return AttachmentType::NOT_SET; +} + +Aws::String GetNameForAttachmentType(AttachmentType enumValue) { + switch (enumValue) { + case AttachmentType::NOT_SET: + return {}; + case AttachmentType::user: + return "user"; + case AttachmentType::group: + return "group"; + case AttachmentType::role: + return "role"; + default: + EnumParseOverflowContainer* overflowContainer = Aws::GetEnumOverflowContainer(); + if (overflowContainer) { + return overflowContainer->RetrieveOverflow(static_cast(enumValue)); + } + + return {}; + } +} + +} // namespace AttachmentTypeMapper +} // namespace Model +} // namespace IAM +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-iam/source/model/InlinePolicyIdentifierType.cpp b/generated/src/aws-cpp-sdk-iam/source/model/InlinePolicyIdentifierType.cpp new file mode 100644 index 000000000000..56bf81e99b9a --- /dev/null +++ b/generated/src/aws-cpp-sdk-iam/source/model/InlinePolicyIdentifierType.cpp @@ -0,0 +1,78 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include +#include +#include + +#include + +using namespace Aws::Utils::Xml; +using namespace Aws::Utils; + +namespace Aws { +namespace IAM { +namespace Model { + +InlinePolicyIdentifierType::InlinePolicyIdentifierType(const XmlNode& xmlNode) { *this = xmlNode; } + +InlinePolicyIdentifierType& InlinePolicyIdentifierType::operator=(const XmlNode& xmlNode) { + XmlNode resultNode = xmlNode; + + if (!resultNode.IsNull()) { + XmlNode policyNameNode = resultNode.FirstChild("PolicyName"); + if (!policyNameNode.IsNull()) { + m_policyName = Aws::Utils::Xml::DecodeEscapedXmlText(policyNameNode.GetText()); + m_policyNameHasBeenSet = true; + } + XmlNode attachmentTypeNode = resultNode.FirstChild("AttachmentType"); + if (!attachmentTypeNode.IsNull()) { + m_attachmentType = AttachmentTypeMapper::GetAttachmentTypeForName( + StringUtils::Trim(Aws::Utils::Xml::DecodeEscapedXmlText(attachmentTypeNode.GetText()).c_str())); + m_attachmentTypeHasBeenSet = true; + } + XmlNode attachmentNameNode = resultNode.FirstChild("AttachmentName"); + if (!attachmentNameNode.IsNull()) { + m_attachmentName = Aws::Utils::Xml::DecodeEscapedXmlText(attachmentNameNode.GetText()); + m_attachmentNameHasBeenSet = true; + } + } + + return *this; +} + +void InlinePolicyIdentifierType::OutputToStream(Aws::OStream& oStream, const char* location, unsigned index, + const char* locationValue) const { + if (m_policyNameHasBeenSet) { + oStream << location << index << locationValue << ".PolicyName=" << StringUtils::URLEncode(m_policyName.c_str()) << "&"; + } + + if (m_attachmentTypeHasBeenSet) { + oStream << location << index << locationValue + << ".AttachmentType=" << StringUtils::URLEncode(AttachmentTypeMapper::GetNameForAttachmentType(m_attachmentType)) << "&"; + } + + if (m_attachmentNameHasBeenSet) { + oStream << location << index << locationValue << ".AttachmentName=" << StringUtils::URLEncode(m_attachmentName.c_str()) << "&"; + } +} + +void InlinePolicyIdentifierType::OutputToStream(Aws::OStream& oStream, const char* location) const { + if (m_policyNameHasBeenSet) { + oStream << location << ".PolicyName=" << StringUtils::URLEncode(m_policyName.c_str()) << "&"; + } + if (m_attachmentTypeHasBeenSet) { + oStream << location << ".AttachmentType=" << StringUtils::URLEncode(AttachmentTypeMapper::GetNameForAttachmentType(m_attachmentType)) + << "&"; + } + if (m_attachmentNameHasBeenSet) { + oStream << location << ".AttachmentName=" << StringUtils::URLEncode(m_attachmentName.c_str()) << "&"; + } +} + +} // namespace Model +} // namespace IAM +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-iam/source/model/OrderedOrganizationPolicyType.cpp b/generated/src/aws-cpp-sdk-iam/source/model/OrderedOrganizationPolicyType.cpp new file mode 100644 index 000000000000..a1f956a97860 --- /dev/null +++ b/generated/src/aws-cpp-sdk-iam/source/model/OrderedOrganizationPolicyType.cpp @@ -0,0 +1,65 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include +#include +#include + +#include + +using namespace Aws::Utils::Xml; +using namespace Aws::Utils; + +namespace Aws { +namespace IAM { +namespace Model { + +OrderedOrganizationPolicyType::OrderedOrganizationPolicyType(const XmlNode& xmlNode) { *this = xmlNode; } + +OrderedOrganizationPolicyType& OrderedOrganizationPolicyType::operator=(const XmlNode& xmlNode) { + XmlNode resultNode = xmlNode; + + if (!resultNode.IsNull()) { + XmlNode serviceControlPolicyInputListNode = resultNode.FirstChild("ServiceControlPolicyInputList"); + if (!serviceControlPolicyInputListNode.IsNull()) { + XmlNode serviceControlPolicyInputListMember = serviceControlPolicyInputListNode.FirstChild("member"); + m_serviceControlPolicyInputListHasBeenSet = !serviceControlPolicyInputListMember.IsNull(); + while (!serviceControlPolicyInputListMember.IsNull()) { + m_serviceControlPolicyInputList.push_back(serviceControlPolicyInputListMember.GetText()); + serviceControlPolicyInputListMember = serviceControlPolicyInputListMember.NextNode("member"); + } + + m_serviceControlPolicyInputListHasBeenSet = true; + } + } + + return *this; +} + +void OrderedOrganizationPolicyType::OutputToStream(Aws::OStream& oStream, const char* location, unsigned index, + const char* locationValue) const { + if (m_serviceControlPolicyInputListHasBeenSet) { + unsigned serviceControlPolicyInputListIdx = 1; + for (auto& item : m_serviceControlPolicyInputList) { + oStream << location << index << locationValue << ".ServiceControlPolicyInputList.member." << serviceControlPolicyInputListIdx++ << "=" + << StringUtils::URLEncode(item.c_str()) << "&"; + } + } +} + +void OrderedOrganizationPolicyType::OutputToStream(Aws::OStream& oStream, const char* location) const { + if (m_serviceControlPolicyInputListHasBeenSet) { + unsigned serviceControlPolicyInputListIdx = 1; + for (auto& item : m_serviceControlPolicyInputList) { + oStream << location << ".ServiceControlPolicyInputList.member." << serviceControlPolicyInputListIdx++ << "=" + << StringUtils::URLEncode(item.c_str()) << "&"; + } + } +} + +} // namespace Model +} // namespace IAM +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-iam/source/model/PolicyIdentifier.cpp b/generated/src/aws-cpp-sdk-iam/source/model/PolicyIdentifier.cpp new file mode 100644 index 000000000000..2f72d68e31b5 --- /dev/null +++ b/generated/src/aws-cpp-sdk-iam/source/model/PolicyIdentifier.cpp @@ -0,0 +1,81 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include +#include +#include + +#include + +using namespace Aws::Utils::Xml; +using namespace Aws::Utils; + +namespace Aws { +namespace IAM { +namespace Model { + +PolicyIdentifier::PolicyIdentifier(const XmlNode& xmlNode) { *this = xmlNode; } + +PolicyIdentifier& PolicyIdentifier::operator=(const XmlNode& xmlNode) { + XmlNode resultNode = xmlNode; + + if (!resultNode.IsNull()) { + XmlNode policyTypeNode = resultNode.FirstChild("PolicyType"); + if (!policyTypeNode.IsNull()) { + m_policyType = PolicyIdentifierPolicyTypeMapper::GetPolicyIdentifierPolicyTypeForName( + StringUtils::Trim(Aws::Utils::Xml::DecodeEscapedXmlText(policyTypeNode.GetText()).c_str())); + m_policyTypeHasBeenSet = true; + } + XmlNode policyArnNode = resultNode.FirstChild("PolicyArn"); + if (!policyArnNode.IsNull()) { + m_policyArn = Aws::Utils::Xml::DecodeEscapedXmlText(policyArnNode.GetText()); + m_policyArnHasBeenSet = true; + } + XmlNode inlinePolicyIdentifierNode = resultNode.FirstChild("InlinePolicyIdentifier"); + if (!inlinePolicyIdentifierNode.IsNull()) { + m_inlinePolicyIdentifier = inlinePolicyIdentifierNode; + m_inlinePolicyIdentifierHasBeenSet = true; + } + } + + return *this; +} + +void PolicyIdentifier::OutputToStream(Aws::OStream& oStream, const char* location, unsigned index, const char* locationValue) const { + if (m_policyTypeHasBeenSet) { + oStream << location << index << locationValue << ".PolicyType=" + << StringUtils::URLEncode(PolicyIdentifierPolicyTypeMapper::GetNameForPolicyIdentifierPolicyType(m_policyType)) << "&"; + } + + if (m_policyArnHasBeenSet) { + oStream << location << index << locationValue << ".PolicyArn=" << StringUtils::URLEncode(m_policyArn.c_str()) << "&"; + } + + if (m_inlinePolicyIdentifierHasBeenSet) { + Aws::StringStream inlinePolicyIdentifierLocationAndMemberSs; + inlinePolicyIdentifierLocationAndMemberSs << location << index << locationValue << ".InlinePolicyIdentifier"; + m_inlinePolicyIdentifier.OutputToStream(oStream, inlinePolicyIdentifierLocationAndMemberSs.str().c_str()); + } +} + +void PolicyIdentifier::OutputToStream(Aws::OStream& oStream, const char* location) const { + if (m_policyTypeHasBeenSet) { + oStream << location << ".PolicyType=" + << StringUtils::URLEncode(PolicyIdentifierPolicyTypeMapper::GetNameForPolicyIdentifierPolicyType(m_policyType)) << "&"; + } + if (m_policyArnHasBeenSet) { + oStream << location << ".PolicyArn=" << StringUtils::URLEncode(m_policyArn.c_str()) << "&"; + } + if (m_inlinePolicyIdentifierHasBeenSet) { + Aws::String inlinePolicyIdentifierLocationAndMember(location); + inlinePolicyIdentifierLocationAndMember += ".InlinePolicyIdentifier"; + m_inlinePolicyIdentifier.OutputToStream(oStream, inlinePolicyIdentifierLocationAndMember.c_str()); + } +} + +} // namespace Model +} // namespace IAM +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-iam/source/model/PolicyIdentifierPolicyType.cpp b/generated/src/aws-cpp-sdk-iam/source/model/PolicyIdentifierPolicyType.cpp new file mode 100644 index 000000000000..6a5b7977a1c0 --- /dev/null +++ b/generated/src/aws-cpp-sdk-iam/source/model/PolicyIdentifierPolicyType.cpp @@ -0,0 +1,78 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include +#include +#include + +using namespace Aws::Utils; + +namespace Aws { +namespace IAM { +namespace Model { +namespace PolicyIdentifierPolicyTypeMapper { + +static const int inline__HASH = HashingUtils::HashString("inline"); +static const int aws_managed_HASH = HashingUtils::HashString("aws-managed"); +static const int user_managed_HASH = HashingUtils::HashString("user-managed"); +static const int permission_boundary_HASH = HashingUtils::HashString("permission-boundary"); +static const int scp_HASH = HashingUtils::HashString("scp"); +static const int rcp_HASH = HashingUtils::HashString("rcp"); + +PolicyIdentifierPolicyType GetPolicyIdentifierPolicyTypeForName(const Aws::String& name) { + int hashCode = HashingUtils::HashString(name.c_str()); + if (hashCode == inline__HASH) { + return PolicyIdentifierPolicyType::inline_; + } else if (hashCode == aws_managed_HASH) { + return PolicyIdentifierPolicyType::aws_managed; + } else if (hashCode == user_managed_HASH) { + return PolicyIdentifierPolicyType::user_managed; + } else if (hashCode == permission_boundary_HASH) { + return PolicyIdentifierPolicyType::permission_boundary; + } else if (hashCode == scp_HASH) { + return PolicyIdentifierPolicyType::scp; + } else if (hashCode == rcp_HASH) { + return PolicyIdentifierPolicyType::rcp; + } + EnumParseOverflowContainer* overflowContainer = Aws::GetEnumOverflowContainer(); + if (overflowContainer) { + overflowContainer->StoreOverflow(hashCode, name); + return static_cast(hashCode); + } + + return PolicyIdentifierPolicyType::NOT_SET; +} + +Aws::String GetNameForPolicyIdentifierPolicyType(PolicyIdentifierPolicyType enumValue) { + switch (enumValue) { + case PolicyIdentifierPolicyType::NOT_SET: + return {}; + case PolicyIdentifierPolicyType::inline_: + return "inline"; + case PolicyIdentifierPolicyType::aws_managed: + return "aws-managed"; + case PolicyIdentifierPolicyType::user_managed: + return "user-managed"; + case PolicyIdentifierPolicyType::permission_boundary: + return "permission-boundary"; + case PolicyIdentifierPolicyType::scp: + return "scp"; + case PolicyIdentifierPolicyType::rcp: + return "rcp"; + default: + EnumParseOverflowContainer* overflowContainer = Aws::GetEnumOverflowContainer(); + if (overflowContainer) { + return overflowContainer->RetrieveOverflow(static_cast(enumValue)); + } + + return {}; + } +} + +} // namespace PolicyIdentifierPolicyTypeMapper +} // namespace Model +} // namespace IAM +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-iam/source/model/SimulateCustomPolicyRequest.cpp b/generated/src/aws-cpp-sdk-iam/source/model/SimulateCustomPolicyRequest.cpp index 10c33e625ee4..938bf20da99e 100644 --- a/generated/src/aws-cpp-sdk-iam/source/model/SimulateCustomPolicyRequest.cpp +++ b/generated/src/aws-cpp-sdk-iam/source/model/SimulateCustomPolicyRequest.cpp @@ -38,6 +38,18 @@ Aws::String SimulateCustomPolicyRequest::SerializePayload() const { } } + if (m_orderedOrganizationPolicyInputListHasBeenSet) { + if (m_orderedOrganizationPolicyInputList.empty()) { + ss << "OrderedOrganizationPolicyInputList=&"; + } else { + unsigned orderedOrganizationPolicyInputListCount = 1; + for (auto& item : m_orderedOrganizationPolicyInputList) { + item.OutputToStream(ss, "OrderedOrganizationPolicyInputList.member.", orderedOrganizationPolicyInputListCount, ""); + orderedOrganizationPolicyInputListCount++; + } + } + } + if (m_actionNamesHasBeenSet) { if (m_actionNames.empty()) { ss << "ActionNames=&"; diff --git a/generated/src/aws-cpp-sdk-iam/source/model/SimulatePrincipalPolicyRequest.cpp b/generated/src/aws-cpp-sdk-iam/source/model/SimulatePrincipalPolicyRequest.cpp index 5593367943cf..4c5e7a8d438b 100644 --- a/generated/src/aws-cpp-sdk-iam/source/model/SimulatePrincipalPolicyRequest.cpp +++ b/generated/src/aws-cpp-sdk-iam/source/model/SimulatePrincipalPolicyRequest.cpp @@ -42,6 +42,18 @@ Aws::String SimulatePrincipalPolicyRequest::SerializePayload() const { } } + if (m_policyExclusionListHasBeenSet) { + if (m_policyExclusionList.empty()) { + ss << "PolicyExclusionList=&"; + } else { + unsigned policyExclusionListCount = 1; + for (auto& item : m_policyExclusionList) { + item.OutputToStream(ss, "PolicyExclusionList.member.", policyExclusionListCount, ""); + policyExclusionListCount++; + } + } + } + if (m_actionNamesHasBeenSet) { if (m_actionNames.empty()) { ss << "ActionNames=&"; diff --git a/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/KafkaClient.h b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/KafkaClient.h index 2e125e8f8396..1ca999f1e269 100644 --- a/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/KafkaClient.h +++ b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/KafkaClient.h @@ -141,6 +141,32 @@ class AWS_KAFKA_API KafkaClient : public Aws::Client::AWSJsonClient, return SubmitAsync(&KafkaClient::BatchDisassociateScramSecret, request, handler, context); } + /** + *

Creates a Channel that streams records from an Amazon MSK Express cluster + * topic to Amazon S3 or Apache Iceberg.

See Also:

AWS + * API Reference

+ */ + virtual Model::CreateChannelOutcome CreateChannel(const Model::CreateChannelRequest& request) const; + + /** + * A Callable wrapper for CreateChannel that returns a future to the operation so that it can be executed in parallel to other requests. + */ + template + Model::CreateChannelOutcomeCallable CreateChannelCallable(const CreateChannelRequestT& request) const { + return SubmitCallable(&KafkaClient::CreateChannel, request); + } + + /** + * An Async wrapper for CreateChannel that queues the request into a thread executor and triggers associated callback when operation has + * finished. + */ + template + void CreateChannelAsync(const CreateChannelRequestT& request, const CreateChannelResponseReceivedHandler& handler, + const std::shared_ptr& context = nullptr) const { + return SubmitAsync(&KafkaClient::CreateChannel, request, handler, context); + } + /** *

Creates a new MSK cluster.

@@ -309,6 +335,33 @@ class AWS_KAFKA_API KafkaClient : public Aws::Client::AWSJsonClient, return SubmitAsync(&KafkaClient::CreateVpcConnection, request, handler, context); } + /** + *

Deletes the channel specified by channelArn from the cluster specified by + * clusterArn. The channel transitions through DELETING and is removed when the + * asynchronous delete completes.

See Also:

AWS + * API Reference

+ */ + virtual Model::DeleteChannelOutcome DeleteChannel(const Model::DeleteChannelRequest& request) const; + + /** + * A Callable wrapper for DeleteChannel that returns a future to the operation so that it can be executed in parallel to other requests. + */ + template + Model::DeleteChannelOutcomeCallable DeleteChannelCallable(const DeleteChannelRequestT& request) const { + return SubmitCallable(&KafkaClient::DeleteChannel, request); + } + + /** + * An Async wrapper for DeleteChannel that queues the request into a thread executor and triggers associated callback when operation has + * finished. + */ + template + void DeleteChannelAsync(const DeleteChannelRequestT& request, const DeleteChannelResponseReceivedHandler& handler, + const std::shared_ptr& context = nullptr) const { + return SubmitAsync(&KafkaClient::DeleteChannel, request, handler, context); + } + /** *

Deletes the MSK cluster specified by the Amazon Resource Name @@ -478,6 +531,32 @@ class AWS_KAFKA_API KafkaClient : public Aws::Client::AWSJsonClient, return SubmitAsync(&KafkaClient::DeleteVpcConnection, request, handler, context); } + /** + *

Returns the current configuration and state of a channel.

See + * Also:

AWS + * API Reference

+ */ + virtual Model::DescribeChannelOutcome DescribeChannel(const Model::DescribeChannelRequest& request) const; + + /** + * A Callable wrapper for DescribeChannel that returns a future to the operation so that it can be executed in parallel to other requests. + */ + template + Model::DescribeChannelOutcomeCallable DescribeChannelCallable(const DescribeChannelRequestT& request) const { + return SubmitCallable(&KafkaClient::DescribeChannel, request); + } + + /** + * An Async wrapper for DescribeChannel that queues the request into a thread executor and triggers associated callback when operation has + * finished. + */ + template + void DescribeChannelAsync(const DescribeChannelRequestT& request, const DescribeChannelResponseReceivedHandler& handler, + const std::shared_ptr& context = nullptr) const { + return SubmitAsync(&KafkaClient::DescribeChannel, request, handler, context); + } + /** *

Returns a description of the MSK cluster whose Amazon Resource @@ -866,6 +945,31 @@ class AWS_KAFKA_API KafkaClient : public Aws::Client::AWSJsonClient, return SubmitAsync(&KafkaClient::GetCompatibleKafkaVersions, request, handler, context); } + /** + *

Returns the list of channels in a cluster.

See Also:

AWS + * API Reference

+ */ + virtual Model::ListChannelsOutcome ListChannels(const Model::ListChannelsRequest& request) const; + + /** + * A Callable wrapper for ListChannels that returns a future to the operation so that it can be executed in parallel to other requests. + */ + template + Model::ListChannelsOutcomeCallable ListChannelsCallable(const ListChannelsRequestT& request) const { + return SubmitCallable(&KafkaClient::ListChannels, request); + } + + /** + * An Async wrapper for ListChannels that queues the request into a thread executor and triggers associated callback when operation has + * finished. + */ + template + void ListChannelsAsync(const ListChannelsRequestT& request, const ListChannelsResponseReceivedHandler& handler, + const std::shared_ptr& context = nullptr) const { + return SubmitAsync(&KafkaClient::ListChannels, request, handler, context); + } + /** *

Returns a list of all the VPC connections in this Region.

@@ -1502,6 +1606,33 @@ class AWS_KAFKA_API KafkaClient : public Aws::Client::AWSJsonClient, return SubmitAsync(&KafkaClient::UpdateBrokerType, request, handler, context); } + /** + *

Updates the destination configuration of an existing channel. Exactly one of + * icebergDestinationUpdate or s3DestinationUpdate must be supplied.

See + * Also:

AWS + * API Reference

+ */ + virtual Model::UpdateChannelOutcome UpdateChannel(const Model::UpdateChannelRequest& request) const; + + /** + * A Callable wrapper for UpdateChannel that returns a future to the operation so that it can be executed in parallel to other requests. + */ + template + Model::UpdateChannelOutcomeCallable UpdateChannelCallable(const UpdateChannelRequestT& request) const { + return SubmitCallable(&KafkaClient::UpdateChannel, request); + } + + /** + * An Async wrapper for UpdateChannel that queues the request into a thread executor and triggers associated callback when operation has + * finished. + */ + template + void UpdateChannelAsync(const UpdateChannelRequestT& request, const UpdateChannelResponseReceivedHandler& handler, + const std::shared_ptr& context = nullptr) const { + return SubmitAsync(&KafkaClient::UpdateChannel, request, handler, context); + } + /** *

Updates the cluster with the configuration that is specified in diff --git a/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/KafkaServiceClientModel.h b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/KafkaServiceClientModel.h index f166b33ce0eb..c6a0a6dfc08e 100644 --- a/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/KafkaServiceClientModel.h +++ b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/KafkaServiceClientModel.h @@ -22,18 +22,21 @@ #include #include #include +#include #include #include #include #include #include #include +#include #include #include #include #include #include #include +#include #include #include #include @@ -48,6 +51,7 @@ #include #include #include +#include #include #include #include @@ -74,6 +78,7 @@ #include #include #include +#include #include #include #include @@ -119,18 +124,21 @@ namespace Model { /* Service model forward declarations required in KafkaClient header */ class BatchAssociateScramSecretRequest; class BatchDisassociateScramSecretRequest; +class CreateChannelRequest; class CreateClusterRequest; class CreateClusterV2Request; class CreateConfigurationRequest; class CreateReplicatorRequest; class CreateTopicRequest; class CreateVpcConnectionRequest; +class DeleteChannelRequest; class DeleteClusterRequest; class DeleteClusterPolicyRequest; class DeleteConfigurationRequest; class DeleteReplicatorRequest; class DeleteTopicRequest; class DeleteVpcConnectionRequest; +class DescribeChannelRequest; class DescribeClusterRequest; class DescribeClusterOperationRequest; class DescribeClusterOperationV2Request; @@ -144,6 +152,7 @@ class DescribeVpcConnectionRequest; class GetBootstrapBrokersRequest; class GetClusterPolicyRequest; class GetCompatibleKafkaVersionsRequest; +class ListChannelsRequest; class ListClientVpcConnectionsRequest; class ListClusterOperationsRequest; class ListClusterOperationsV2Request; @@ -166,6 +175,7 @@ class UntagResourceRequest; class UpdateBrokerCountRequest; class UpdateBrokerStorageRequest; class UpdateBrokerTypeRequest; +class UpdateChannelRequest; class UpdateClusterConfigurationRequest; class UpdateClusterKafkaVersionRequest; class UpdateConfigurationRequest; @@ -181,18 +191,21 @@ class UpdateTopicRequest; /* Service model Outcome class definitions */ typedef Aws::Utils::Outcome BatchAssociateScramSecretOutcome; typedef Aws::Utils::Outcome BatchDisassociateScramSecretOutcome; +typedef Aws::Utils::Outcome CreateChannelOutcome; typedef Aws::Utils::Outcome CreateClusterOutcome; typedef Aws::Utils::Outcome CreateClusterV2Outcome; typedef Aws::Utils::Outcome CreateConfigurationOutcome; typedef Aws::Utils::Outcome CreateReplicatorOutcome; typedef Aws::Utils::Outcome CreateTopicOutcome; typedef Aws::Utils::Outcome CreateVpcConnectionOutcome; +typedef Aws::Utils::Outcome DeleteChannelOutcome; typedef Aws::Utils::Outcome DeleteClusterOutcome; typedef Aws::Utils::Outcome DeleteClusterPolicyOutcome; typedef Aws::Utils::Outcome DeleteConfigurationOutcome; typedef Aws::Utils::Outcome DeleteReplicatorOutcome; typedef Aws::Utils::Outcome DeleteTopicOutcome; typedef Aws::Utils::Outcome DeleteVpcConnectionOutcome; +typedef Aws::Utils::Outcome DescribeChannelOutcome; typedef Aws::Utils::Outcome DescribeClusterOutcome; typedef Aws::Utils::Outcome DescribeClusterOperationOutcome; typedef Aws::Utils::Outcome DescribeClusterOperationV2Outcome; @@ -206,6 +219,7 @@ typedef Aws::Utils::Outcome DescribeVpc typedef Aws::Utils::Outcome GetBootstrapBrokersOutcome; typedef Aws::Utils::Outcome GetClusterPolicyOutcome; typedef Aws::Utils::Outcome GetCompatibleKafkaVersionsOutcome; +typedef Aws::Utils::Outcome ListChannelsOutcome; typedef Aws::Utils::Outcome ListClientVpcConnectionsOutcome; typedef Aws::Utils::Outcome ListClusterOperationsOutcome; typedef Aws::Utils::Outcome ListClusterOperationsV2Outcome; @@ -228,6 +242,7 @@ typedef Aws::Utils::Outcome UntagResourceOutcome; typedef Aws::Utils::Outcome UpdateBrokerCountOutcome; typedef Aws::Utils::Outcome UpdateBrokerStorageOutcome; typedef Aws::Utils::Outcome UpdateBrokerTypeOutcome; +typedef Aws::Utils::Outcome UpdateChannelOutcome; typedef Aws::Utils::Outcome UpdateClusterConfigurationOutcome; typedef Aws::Utils::Outcome UpdateClusterKafkaVersionOutcome; typedef Aws::Utils::Outcome UpdateConfigurationOutcome; @@ -243,18 +258,21 @@ typedef Aws::Utils::Outcome UpdateTopicOutcome; /* Service model Outcome callable definitions */ typedef std::future BatchAssociateScramSecretOutcomeCallable; typedef std::future BatchDisassociateScramSecretOutcomeCallable; +typedef std::future CreateChannelOutcomeCallable; typedef std::future CreateClusterOutcomeCallable; typedef std::future CreateClusterV2OutcomeCallable; typedef std::future CreateConfigurationOutcomeCallable; typedef std::future CreateReplicatorOutcomeCallable; typedef std::future CreateTopicOutcomeCallable; typedef std::future CreateVpcConnectionOutcomeCallable; +typedef std::future DeleteChannelOutcomeCallable; typedef std::future DeleteClusterOutcomeCallable; typedef std::future DeleteClusterPolicyOutcomeCallable; typedef std::future DeleteConfigurationOutcomeCallable; typedef std::future DeleteReplicatorOutcomeCallable; typedef std::future DeleteTopicOutcomeCallable; typedef std::future DeleteVpcConnectionOutcomeCallable; +typedef std::future DescribeChannelOutcomeCallable; typedef std::future DescribeClusterOutcomeCallable; typedef std::future DescribeClusterOperationOutcomeCallable; typedef std::future DescribeClusterOperationV2OutcomeCallable; @@ -268,6 +286,7 @@ typedef std::future DescribeVpcConnectionOutcomeCa typedef std::future GetBootstrapBrokersOutcomeCallable; typedef std::future GetClusterPolicyOutcomeCallable; typedef std::future GetCompatibleKafkaVersionsOutcomeCallable; +typedef std::future ListChannelsOutcomeCallable; typedef std::future ListClientVpcConnectionsOutcomeCallable; typedef std::future ListClusterOperationsOutcomeCallable; typedef std::future ListClusterOperationsV2OutcomeCallable; @@ -290,6 +309,7 @@ typedef std::future UntagResourceOutcomeCallable; typedef std::future UpdateBrokerCountOutcomeCallable; typedef std::future UpdateBrokerStorageOutcomeCallable; typedef std::future UpdateBrokerTypeOutcomeCallable; +typedef std::future UpdateChannelOutcomeCallable; typedef std::future UpdateClusterConfigurationOutcomeCallable; typedef std::future UpdateClusterKafkaVersionOutcomeCallable; typedef std::future UpdateConfigurationOutcomeCallable; @@ -313,6 +333,9 @@ typedef std::function&)> BatchDisassociateScramSecretResponseReceivedHandler; +typedef std::function&)> + CreateChannelResponseReceivedHandler; typedef std::function&)> CreateClusterResponseReceivedHandler; @@ -331,6 +354,9 @@ typedef std::function&)> CreateVpcConnectionResponseReceivedHandler; +typedef std::function&)> + DeleteChannelResponseReceivedHandler; typedef std::function&)> DeleteClusterResponseReceivedHandler; @@ -349,6 +375,9 @@ typedef std::function&)> DeleteVpcConnectionResponseReceivedHandler; +typedef std::function&)> + DescribeChannelResponseReceivedHandler; typedef std::function&)> DescribeClusterResponseReceivedHandler; @@ -389,6 +418,9 @@ typedef std::function&)> GetCompatibleKafkaVersionsResponseReceivedHandler; +typedef std::function&)> + ListChannelsResponseReceivedHandler; typedef std::function&)> ListClientVpcConnectionsResponseReceivedHandler; @@ -455,6 +487,9 @@ typedef std::function&)> UpdateBrokerTypeResponseReceivedHandler; +typedef std::function&)> + UpdateChannelResponseReceivedHandler; typedef std::function&)> UpdateClusterConfigurationResponseReceivedHandler; diff --git a/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/Catalog.h b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/Catalog.h new file mode 100644 index 000000000000..8c256dc5e9e7 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/Catalog.h @@ -0,0 +1,83 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include + +#include + +namespace Aws { +namespace Utils { +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json +} // namespace Utils +namespace Kafka { +namespace Model { + +/** + *

Configuration of the AWS Glue Data Catalog and S3 Tables warehouse used by + * the Apache Iceberg destination.

See Also:

AWS API + * Reference

+ */ +class Catalog { + public: + AWS_KAFKA_API Catalog() = default; + AWS_KAFKA_API Catalog(Aws::Utils::Json::JsonView jsonValue); + AWS_KAFKA_API Catalog& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_KAFKA_API Aws::Utils::Json::JsonValue Jsonize() const; + + ///@{ + /** + *

The Amazon Resource Name (ARN) of the federated AWS Glue Data Catalog that + * projects the S3 Tables bucket. If omitted, MSK derives the catalog ARN from + * warehouseLocation.

+ */ + inline const Aws::String& GetCatalogArn() const { return m_catalogArn; } + inline bool CatalogArnHasBeenSet() const { return m_catalogArnHasBeenSet; } + template + void SetCatalogArn(CatalogArnT&& value) { + m_catalogArnHasBeenSet = true; + m_catalogArn = std::forward(value); + } + template + Catalog& WithCatalogArn(CatalogArnT&& value) { + SetCatalogArn(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The Amazon Resource Name (ARN) of the S3 Tables bucket that backs the Apache + * Iceberg warehouse.

+ */ + inline const Aws::String& GetWarehouseLocation() const { return m_warehouseLocation; } + inline bool WarehouseLocationHasBeenSet() const { return m_warehouseLocationHasBeenSet; } + template + void SetWarehouseLocation(WarehouseLocationT&& value) { + m_warehouseLocationHasBeenSet = true; + m_warehouseLocation = std::forward(value); + } + template + Catalog& WithWarehouseLocation(WarehouseLocationT&& value) { + SetWarehouseLocation(std::forward(value)); + return *this; + } + ///@} + private: + Aws::String m_catalogArn; + + Aws::String m_warehouseLocation; + bool m_catalogArnHasBeenSet = false; + bool m_warehouseLocationHasBeenSet = false; +}; + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/ChannelDestinationType.h b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/ChannelDestinationType.h new file mode 100644 index 000000000000..d0fb49e68f82 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/ChannelDestinationType.h @@ -0,0 +1,22 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include + +namespace Aws { +namespace Kafka { +namespace Model { +enum class ChannelDestinationType { NOT_SET, ICEBERG, S3 }; + +namespace ChannelDestinationTypeMapper { +AWS_KAFKA_API ChannelDestinationType GetChannelDestinationTypeForName(const Aws::String& name); + +AWS_KAFKA_API Aws::String GetNameForChannelDestinationType(ChannelDestinationType value); +} // namespace ChannelDestinationTypeMapper +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/ChannelInfo.h b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/ChannelInfo.h new file mode 100644 index 000000000000..17fc43a2db91 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/ChannelInfo.h @@ -0,0 +1,169 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include +#include +#include + +#include + +namespace Aws { +namespace Utils { +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json +} // namespace Utils +namespace Kafka { +namespace Model { + +/** + *

Summary information about a channel returned by ListChannels.

See + * Also:

AWS + * API Reference

+ */ +class ChannelInfo { + public: + AWS_KAFKA_API ChannelInfo() = default; + AWS_KAFKA_API ChannelInfo(Aws::Utils::Json::JsonView jsonValue); + AWS_KAFKA_API ChannelInfo& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_KAFKA_API Aws::Utils::Json::JsonValue Jsonize() const; + + ///@{ + /** + * +

The Amazon Resource Name (ARN) that uniquely identifies the + * channel.

+ + */ + inline const Aws::String& GetChannelArn() const { return m_channelArn; } + inline bool ChannelArnHasBeenSet() const { return m_channelArnHasBeenSet; } + template + void SetChannelArn(ChannelArnT&& value) { + m_channelArnHasBeenSet = true; + m_channelArn = std::forward(value); + } + template + ChannelInfo& WithChannelArn(ChannelArnT&& value) { + SetChannelArn(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The name of the channel.

+ */ + inline const Aws::String& GetChannelName() const { return m_channelName; } + inline bool ChannelNameHasBeenSet() const { return m_channelNameHasBeenSet; } + template + void SetChannelName(ChannelNameT&& value) { + m_channelNameHasBeenSet = true; + m_channelName = std::forward(value); + } + template + ChannelInfo& WithChannelName(ChannelNameT&& value) { + SetChannelName(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The current lifecycle state of the channel.

+ */ + inline ChannelStatus GetStatus() const { return m_status; } + inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; } + inline void SetStatus(ChannelStatus value) { + m_statusHasBeenSet = true; + m_status = value; + } + inline ChannelInfo& WithStatus(ChannelStatus value) { + SetStatus(value); + return *this; + } + ///@} + + ///@{ + /** + * +

The time when the channel was created.

+ + */ + inline const Aws::Utils::DateTime& GetCreationTime() const { return m_creationTime; } + inline bool CreationTimeHasBeenSet() const { return m_creationTimeHasBeenSet; } + template + void SetCreationTime(CreationTimeT&& value) { + m_creationTimeHasBeenSet = true; + m_creationTime = std::forward(value); + } + template + ChannelInfo& WithCreationTime(CreationTimeT&& value) { + SetCreationTime(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The type of destination configured for the channel.

+ */ + inline ChannelDestinationType GetDestinationType() const { return m_destinationType; } + inline bool DestinationTypeHasBeenSet() const { return m_destinationTypeHasBeenSet; } + inline void SetDestinationType(ChannelDestinationType value) { + m_destinationTypeHasBeenSet = true; + m_destinationType = value; + } + inline ChannelInfo& WithDestinationType(ChannelDestinationType value) { + SetDestinationType(value); + return *this; + } + ///@} + + ///@{ + /** + *

The Amazon Resource Name (ARN) of the in-flight cluster operation. Returned + * only while the channel is in CREATING, UPDATING, or DELETING.

+ */ + inline const Aws::String& GetClusterOperationArn() const { return m_clusterOperationArn; } + inline bool ClusterOperationArnHasBeenSet() const { return m_clusterOperationArnHasBeenSet; } + template + void SetClusterOperationArn(ClusterOperationArnT&& value) { + m_clusterOperationArnHasBeenSet = true; + m_clusterOperationArn = std::forward(value); + } + template + ChannelInfo& WithClusterOperationArn(ClusterOperationArnT&& value) { + SetClusterOperationArn(std::forward(value)); + return *this; + } + ///@} + private: + Aws::String m_channelArn; + + Aws::String m_channelName; + + ChannelStatus m_status{ChannelStatus::NOT_SET}; + + Aws::Utils::DateTime m_creationTime{}; + + ChannelDestinationType m_destinationType{ChannelDestinationType::NOT_SET}; + + Aws::String m_clusterOperationArn; + bool m_channelArnHasBeenSet = false; + bool m_channelNameHasBeenSet = false; + bool m_statusHasBeenSet = false; + bool m_creationTimeHasBeenSet = false; + bool m_destinationTypeHasBeenSet = false; + bool m_clusterOperationArnHasBeenSet = false; +}; + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/ChannelLoggingInfo.h b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/ChannelLoggingInfo.h new file mode 100644 index 000000000000..4676bb9f58e2 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/ChannelLoggingInfo.h @@ -0,0 +1,104 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include +#include + +#include + +namespace Aws { +namespace Utils { +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json +} // namespace Utils +namespace Kafka { +namespace Model { + +/** + *

Configuration for the destinations to which the channel publishes operational + * logs.

See Also:

AWS + * API Reference

+ */ +class ChannelLoggingInfo { + public: + AWS_KAFKA_API ChannelLoggingInfo() = default; + AWS_KAFKA_API ChannelLoggingInfo(Aws::Utils::Json::JsonView jsonValue); + AWS_KAFKA_API ChannelLoggingInfo& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_KAFKA_API Aws::Utils::Json::JsonValue Jsonize() const; + + ///@{ + /** + *

Details of the CloudWatch Logs destination for Channel logs.

+ */ + inline const CloudWatchLogs& GetCloudWatchLogs() const { return m_cloudWatchLogs; } + inline bool CloudWatchLogsHasBeenSet() const { return m_cloudWatchLogsHasBeenSet; } + template + void SetCloudWatchLogs(CloudWatchLogsT&& value) { + m_cloudWatchLogsHasBeenSet = true; + m_cloudWatchLogs = std::forward(value); + } + template + ChannelLoggingInfo& WithCloudWatchLogs(CloudWatchLogsT&& value) { + SetCloudWatchLogs(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

Details of the Kinesis Data Firehose delivery stream that is the destination + * for Channel logs.

+ */ + inline const Firehose& GetFirehose() const { return m_firehose; } + inline bool FirehoseHasBeenSet() const { return m_firehoseHasBeenSet; } + template + void SetFirehose(FirehoseT&& value) { + m_firehoseHasBeenSet = true; + m_firehose = std::forward(value); + } + template + ChannelLoggingInfo& WithFirehose(FirehoseT&& value) { + SetFirehose(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

Details of the Amazon S3 destination for Channel logs.

+ */ + inline const S3& GetS3() const { return m_s3; } + inline bool S3HasBeenSet() const { return m_s3HasBeenSet; } + template + void SetS3(S3T&& value) { + m_s3HasBeenSet = true; + m_s3 = std::forward(value); + } + template + ChannelLoggingInfo& WithS3(S3T&& value) { + SetS3(std::forward(value)); + return *this; + } + ///@} + private: + CloudWatchLogs m_cloudWatchLogs; + + Firehose m_firehose; + + S3 m_s3; + bool m_cloudWatchLogsHasBeenSet = false; + bool m_firehoseHasBeenSet = false; + bool m_s3HasBeenSet = false; +}; + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/ChannelStateInfo.h b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/ChannelStateInfo.h new file mode 100644 index 000000000000..3211ad27c549 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/ChannelStateInfo.h @@ -0,0 +1,80 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include + +#include + +namespace Aws { +namespace Utils { +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json +} // namespace Utils +namespace Kafka { +namespace Model { + +/** + *

Additional context for the current channel state, populated when the channel + * is in FAILED.

See Also:

AWS + * API Reference

+ */ +class ChannelStateInfo { + public: + AWS_KAFKA_API ChannelStateInfo() = default; + AWS_KAFKA_API ChannelStateInfo(Aws::Utils::Json::JsonView jsonValue); + AWS_KAFKA_API ChannelStateInfo& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_KAFKA_API Aws::Utils::Json::JsonValue Jsonize() const; + + ///@{ + /** + *

A short, machine-readable code identifying the failure cause.

+ */ + inline const Aws::String& GetCode() const { return m_code; } + inline bool CodeHasBeenSet() const { return m_codeHasBeenSet; } + template + void SetCode(CodeT&& value) { + m_codeHasBeenSet = true; + m_code = std::forward(value); + } + template + ChannelStateInfo& WithCode(CodeT&& value) { + SetCode(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

A human-readable message describing the failure.

+ */ + inline const Aws::String& GetMessage() const { return m_message; } + inline bool MessageHasBeenSet() const { return m_messageHasBeenSet; } + template + void SetMessage(MessageT&& value) { + m_messageHasBeenSet = true; + m_message = std::forward(value); + } + template + ChannelStateInfo& WithMessage(MessageT&& value) { + SetMessage(std::forward(value)); + return *this; + } + ///@} + private: + Aws::String m_code; + + Aws::String m_message; + bool m_codeHasBeenSet = false; + bool m_messageHasBeenSet = false; +}; + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/ChannelStatus.h b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/ChannelStatus.h new file mode 100644 index 000000000000..b9adc016d87f --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/ChannelStatus.h @@ -0,0 +1,22 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include + +namespace Aws { +namespace Kafka { +namespace Model { +enum class ChannelStatus { NOT_SET, CREATING, ACTIVE, UPDATING, DELETING, FAILED, SUSPENDING, SUSPENDED }; + +namespace ChannelStatusMapper { +AWS_KAFKA_API ChannelStatus GetChannelStatusForName(const Aws::String& name); + +AWS_KAFKA_API Aws::String GetNameForChannelStatus(ChannelStatus value); +} // namespace ChannelStatusMapper +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/CreateChannelRequest.h b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/CreateChannelRequest.h new file mode 100644 index 000000000000..f4714f898632 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/CreateChannelRequest.h @@ -0,0 +1,231 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include + +namespace Aws { +namespace Kafka { +namespace Model { + +/** + *

Creates a Channel that streams records from an Amazon MSK Express cluster + * topic to Amazon S3 or Apache Iceberg.

See Also:

AWS + * API Reference

+ */ +class CreateChannelRequest : public KafkaRequest { + public: + AWS_KAFKA_API CreateChannelRequest() = default; + + // Service request name is the Operation name which will send this request out, + // each operation should has unique request name, so that we can get operation's name from this request. + // Note: this is not true for response, multiple operations may have the same response name, + // so we can not get operation's name from response. + inline virtual const char* GetServiceRequestName() const override { return "CreateChannel"; } + + AWS_KAFKA_API Aws::String SerializePayload() const override; + + ///@{ + /** + *

The name of the channel. Must be unique within the cluster.

+ */ + inline const Aws::String& GetChannelName() const { return m_channelName; } + inline bool ChannelNameHasBeenSet() const { return m_channelNameHasBeenSet; } + template + void SetChannelName(ChannelNameT&& value) { + m_channelNameHasBeenSet = true; + m_channelName = std::forward(value); + } + template + CreateChannelRequest& WithChannelName(ChannelNameT&& value) { + SetChannelName(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + * +

The Amazon Resource Name (ARN) that uniquely identifies the + * cluster.

+ + */ + inline const Aws::String& GetClusterArn() const { return m_clusterArn; } + inline bool ClusterArnHasBeenSet() const { return m_clusterArnHasBeenSet; } + template + void SetClusterArn(ClusterArnT&& value) { + m_clusterArnHasBeenSet = true; + m_clusterArn = std::forward(value); + } + template + CreateChannelRequest& WithClusterArn(ClusterArnT&& value) { + SetClusterArn(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The encryption configuration applied to the channel.

+ */ + inline const EncryptionConfiguration& GetEncryptionConfiguration() const { return m_encryptionConfiguration; } + inline bool EncryptionConfigurationHasBeenSet() const { return m_encryptionConfigurationHasBeenSet; } + template + void SetEncryptionConfiguration(EncryptionConfigurationT&& value) { + m_encryptionConfigurationHasBeenSet = true; + m_encryptionConfiguration = std::forward(value); + } + template + CreateChannelRequest& WithEncryptionConfiguration(EncryptionConfigurationT&& value) { + SetEncryptionConfiguration(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The Apache Iceberg destination for the channel. Mutually exclusive with + * s3DestinationConfiguration.

+ */ + inline const IcebergDestinationConfiguration& GetIcebergDestinationConfiguration() const { return m_icebergDestinationConfiguration; } + inline bool IcebergDestinationConfigurationHasBeenSet() const { return m_icebergDestinationConfigurationHasBeenSet; } + template + void SetIcebergDestinationConfiguration(IcebergDestinationConfigurationT&& value) { + m_icebergDestinationConfigurationHasBeenSet = true; + m_icebergDestinationConfiguration = std::forward(value); + } + template + CreateChannelRequest& WithIcebergDestinationConfiguration(IcebergDestinationConfigurationT&& value) { + SetIcebergDestinationConfiguration(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The Amazon S3 destination for the channel. Mutually exclusive with + * icebergDestinationConfiguration.

+ */ + inline const S3DestinationConfiguration& GetS3DestinationConfiguration() const { return m_s3DestinationConfiguration; } + inline bool S3DestinationConfigurationHasBeenSet() const { return m_s3DestinationConfigurationHasBeenSet; } + template + void SetS3DestinationConfiguration(S3DestinationConfigurationT&& value) { + m_s3DestinationConfigurationHasBeenSet = true; + m_s3DestinationConfiguration = std::forward(value); + } + template + CreateChannelRequest& WithS3DestinationConfiguration(S3DestinationConfigurationT&& value) { + SetS3DestinationConfiguration(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The tags attached to the channel.

+ */ + inline const Aws::Map& GetTags() const { return m_tags; } + inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; } + template > + void SetTags(TagsT&& value) { + m_tagsHasBeenSet = true; + m_tags = std::forward(value); + } + template > + CreateChannelRequest& WithTags(TagsT&& value) { + SetTags(std::forward(value)); + return *this; + } + template + CreateChannelRequest& AddTags(TagsKeyT&& key, TagsValueT&& value) { + m_tagsHasBeenSet = true; + m_tags.emplace(std::forward(key), std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The list of topic configurations for the channel. Currently exactly one topic + * must be specified.

+ */ + inline const Aws::Vector& GetTopicConfigurationList() const { return m_topicConfigurationList; } + inline bool TopicConfigurationListHasBeenSet() const { return m_topicConfigurationListHasBeenSet; } + template > + void SetTopicConfigurationList(TopicConfigurationListT&& value) { + m_topicConfigurationListHasBeenSet = true; + m_topicConfigurationList = std::forward(value); + } + template > + CreateChannelRequest& WithTopicConfigurationList(TopicConfigurationListT&& value) { + SetTopicConfigurationList(std::forward(value)); + return *this; + } + template + CreateChannelRequest& AddTopicConfigurationList(TopicConfigurationListT&& value) { + m_topicConfigurationListHasBeenSet = true; + m_topicConfigurationList.emplace_back(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The destinations to which the channel publishes operational logs.

+ */ + inline const ChannelLoggingInfo& GetLoggingInfo() const { return m_loggingInfo; } + inline bool LoggingInfoHasBeenSet() const { return m_loggingInfoHasBeenSet; } + template + void SetLoggingInfo(LoggingInfoT&& value) { + m_loggingInfoHasBeenSet = true; + m_loggingInfo = std::forward(value); + } + template + CreateChannelRequest& WithLoggingInfo(LoggingInfoT&& value) { + SetLoggingInfo(std::forward(value)); + return *this; + } + ///@} + private: + Aws::String m_channelName; + + Aws::String m_clusterArn; + + EncryptionConfiguration m_encryptionConfiguration; + + IcebergDestinationConfiguration m_icebergDestinationConfiguration; + + S3DestinationConfiguration m_s3DestinationConfiguration; + + Aws::Map m_tags; + + Aws::Vector m_topicConfigurationList; + + ChannelLoggingInfo m_loggingInfo; + bool m_channelNameHasBeenSet = false; + bool m_clusterArnHasBeenSet = false; + bool m_encryptionConfigurationHasBeenSet = false; + bool m_icebergDestinationConfigurationHasBeenSet = false; + bool m_s3DestinationConfigurationHasBeenSet = false; + bool m_tagsHasBeenSet = false; + bool m_topicConfigurationListHasBeenSet = false; + bool m_loggingInfoHasBeenSet = false; +}; + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/CreateChannelResult.h b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/CreateChannelResult.h new file mode 100644 index 000000000000..d680e891aef7 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/CreateChannelResult.h @@ -0,0 +1,106 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include + +#include + +namespace Aws { +template +class AmazonWebServiceResult; + +namespace Utils { +namespace Json { +class JsonValue; +} // namespace Json +} // namespace Utils +namespace Kafka { +namespace Model { +/** + *

Returns the channel ARN and the cluster-operation ARN that tracks the + * asynchronous create.

See Also:

AWS + * API Reference

+ */ +class CreateChannelResult { + public: + AWS_KAFKA_API CreateChannelResult() = default; + AWS_KAFKA_API CreateChannelResult(const Aws::AmazonWebServiceResult& result); + AWS_KAFKA_API CreateChannelResult& operator=(const Aws::AmazonWebServiceResult& result); + + ///@{ + /** + * +

The Amazon Resource Name (ARN) that uniquely identifies the + * channel.

+ + */ + inline const Aws::String& GetChannelArn() const { return m_channelArn; } + template + void SetChannelArn(ChannelArnT&& value) { + m_channelArnHasBeenSet = true; + m_channelArn = std::forward(value); + } + template + CreateChannelResult& WithChannelArn(ChannelArnT&& value) { + SetChannelArn(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + * +

The Amazon Resource Name (ARN) of the cluster operation.

+ + * + */ + inline const Aws::String& GetClusterOperationArn() const { return m_clusterOperationArn; } + template + void SetClusterOperationArn(ClusterOperationArnT&& value) { + m_clusterOperationArnHasBeenSet = true; + m_clusterOperationArn = std::forward(value); + } + template + CreateChannelResult& WithClusterOperationArn(ClusterOperationArnT&& value) { + SetClusterOperationArn(std::forward(value)); + return *this; + } + ///@} + + ///@{ + + inline const Aws::String& GetRequestId() const { return m_requestId; } + template + void SetRequestId(RequestIdT&& value) { + m_requestIdHasBeenSet = true; + m_requestId = std::forward(value); + } + template + CreateChannelResult& WithRequestId(RequestIdT&& value) { + SetRequestId(std::forward(value)); + return *this; + } + ///@} + inline Aws::Http::HttpResponseCode GetHttpResponseCode() const { return m_HttpResponseCode; } + + private: + Aws::String m_channelArn; + + Aws::String m_clusterOperationArn; + + Aws::String m_requestId; + Aws::Http::HttpResponseCode m_HttpResponseCode; + bool m_channelArnHasBeenSet = false; + bool m_clusterOperationArnHasBeenSet = false; + bool m_requestIdHasBeenSet = false; +}; + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/DeadLetterQueueS3.h b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/DeadLetterQueueS3.h new file mode 100644 index 000000000000..17a32746dad5 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/DeadLetterQueueS3.h @@ -0,0 +1,102 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include + +#include + +namespace Aws { +namespace Utils { +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json +} // namespace Utils +namespace Kafka { +namespace Model { + +/** + *

Configuration of the Amazon S3 bucket where records that fail to deliver are + * stored.

See Also:

AWS + * API Reference

+ */ +class DeadLetterQueueS3 { + public: + AWS_KAFKA_API DeadLetterQueueS3() = default; + AWS_KAFKA_API DeadLetterQueueS3(Aws::Utils::Json::JsonView jsonValue); + AWS_KAFKA_API DeadLetterQueueS3& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_KAFKA_API Aws::Utils::Json::JsonValue Jsonize() const; + + ///@{ + /** + *

The Amazon Resource Name (ARN) of the dead-letter Amazon S3 bucket.

+ */ + inline const Aws::String& GetBucketArn() const { return m_bucketArn; } + inline bool BucketArnHasBeenSet() const { return m_bucketArnHasBeenSet; } + template + void SetBucketArn(BucketArnT&& value) { + m_bucketArnHasBeenSet = true; + m_bucketArn = std::forward(value); + } + template + DeadLetterQueueS3& WithBucketArn(BucketArnT&& value) { + SetBucketArn(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

An optional prefix prepended to every dead-letter Amazon S3 object key.

+ */ + inline const Aws::String& GetErrorOutputPrefix() const { return m_errorOutputPrefix; } + inline bool ErrorOutputPrefixHasBeenSet() const { return m_errorOutputPrefixHasBeenSet; } + template + void SetErrorOutputPrefix(ErrorOutputPrefixT&& value) { + m_errorOutputPrefixHasBeenSet = true; + m_errorOutputPrefix = std::forward(value); + } + template + DeadLetterQueueS3& WithErrorOutputPrefix(ErrorOutputPrefixT&& value) { + SetErrorOutputPrefix(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

Optional 12-digit AWS account ID expected to own the dead-letter Amazon S3 + * bucket.

+ */ + inline const Aws::String& GetExpectedBucketOwner() const { return m_expectedBucketOwner; } + inline bool ExpectedBucketOwnerHasBeenSet() const { return m_expectedBucketOwnerHasBeenSet; } + template + void SetExpectedBucketOwner(ExpectedBucketOwnerT&& value) { + m_expectedBucketOwnerHasBeenSet = true; + m_expectedBucketOwner = std::forward(value); + } + template + DeadLetterQueueS3& WithExpectedBucketOwner(ExpectedBucketOwnerT&& value) { + SetExpectedBucketOwner(std::forward(value)); + return *this; + } + ///@} + private: + Aws::String m_bucketArn; + + Aws::String m_errorOutputPrefix; + + Aws::String m_expectedBucketOwner; + bool m_bucketArnHasBeenSet = false; + bool m_errorOutputPrefixHasBeenSet = false; + bool m_expectedBucketOwnerHasBeenSet = false; +}; + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/DeleteChannelRequest.h b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/DeleteChannelRequest.h new file mode 100644 index 000000000000..3c963be1f100 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/DeleteChannelRequest.h @@ -0,0 +1,82 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include + +#include + +namespace Aws { +namespace Kafka { +namespace Model { + +/** + */ +class DeleteChannelRequest : public KafkaRequest { + public: + AWS_KAFKA_API DeleteChannelRequest() = default; + + // Service request name is the Operation name which will send this request out, + // each operation should has unique request name, so that we can get operation's name from this request. + // Note: this is not true for response, multiple operations may have the same response name, + // so we can not get operation's name from response. + inline virtual const char* GetServiceRequestName() const override { return "DeleteChannel"; } + + AWS_KAFKA_API Aws::String SerializePayload() const override; + + ///@{ + /** + * +

The Amazon Resource Name (ARN) that uniquely identifies the + * channel.

+ + */ + inline const Aws::String& GetChannelArn() const { return m_channelArn; } + inline bool ChannelArnHasBeenSet() const { return m_channelArnHasBeenSet; } + template + void SetChannelArn(ChannelArnT&& value) { + m_channelArnHasBeenSet = true; + m_channelArn = std::forward(value); + } + template + DeleteChannelRequest& WithChannelArn(ChannelArnT&& value) { + SetChannelArn(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + * +

The Amazon Resource Name (ARN) that uniquely identifies the + * cluster.

+ + */ + inline const Aws::String& GetClusterArn() const { return m_clusterArn; } + inline bool ClusterArnHasBeenSet() const { return m_clusterArnHasBeenSet; } + template + void SetClusterArn(ClusterArnT&& value) { + m_clusterArnHasBeenSet = true; + m_clusterArn = std::forward(value); + } + template + DeleteChannelRequest& WithClusterArn(ClusterArnT&& value) { + SetClusterArn(std::forward(value)); + return *this; + } + ///@} + private: + Aws::String m_channelArn; + + Aws::String m_clusterArn; + bool m_channelArnHasBeenSet = false; + bool m_clusterArnHasBeenSet = false; +}; + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/DeleteChannelResult.h b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/DeleteChannelResult.h new file mode 100644 index 000000000000..7f04a24b4885 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/DeleteChannelResult.h @@ -0,0 +1,106 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include + +#include + +namespace Aws { +template +class AmazonWebServiceResult; + +namespace Utils { +namespace Json { +class JsonValue; +} // namespace Json +} // namespace Utils +namespace Kafka { +namespace Model { +/** + *

Returns the channel ARN and the cluster-operation ARN that tracks the + * asynchronous delete.

See Also:

AWS + * API Reference

+ */ +class DeleteChannelResult { + public: + AWS_KAFKA_API DeleteChannelResult() = default; + AWS_KAFKA_API DeleteChannelResult(const Aws::AmazonWebServiceResult& result); + AWS_KAFKA_API DeleteChannelResult& operator=(const Aws::AmazonWebServiceResult& result); + + ///@{ + /** + * +

The Amazon Resource Name (ARN) that uniquely identifies the + * channel.

+ + */ + inline const Aws::String& GetChannelArn() const { return m_channelArn; } + template + void SetChannelArn(ChannelArnT&& value) { + m_channelArnHasBeenSet = true; + m_channelArn = std::forward(value); + } + template + DeleteChannelResult& WithChannelArn(ChannelArnT&& value) { + SetChannelArn(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + * +

The Amazon Resource Name (ARN) of the cluster operation.

+ + * + */ + inline const Aws::String& GetClusterOperationArn() const { return m_clusterOperationArn; } + template + void SetClusterOperationArn(ClusterOperationArnT&& value) { + m_clusterOperationArnHasBeenSet = true; + m_clusterOperationArn = std::forward(value); + } + template + DeleteChannelResult& WithClusterOperationArn(ClusterOperationArnT&& value) { + SetClusterOperationArn(std::forward(value)); + return *this; + } + ///@} + + ///@{ + + inline const Aws::String& GetRequestId() const { return m_requestId; } + template + void SetRequestId(RequestIdT&& value) { + m_requestIdHasBeenSet = true; + m_requestId = std::forward(value); + } + template + DeleteChannelResult& WithRequestId(RequestIdT&& value) { + SetRequestId(std::forward(value)); + return *this; + } + ///@} + inline Aws::Http::HttpResponseCode GetHttpResponseCode() const { return m_HttpResponseCode; } + + private: + Aws::String m_channelArn; + + Aws::String m_clusterOperationArn; + + Aws::String m_requestId; + Aws::Http::HttpResponseCode m_HttpResponseCode; + bool m_channelArnHasBeenSet = false; + bool m_clusterOperationArnHasBeenSet = false; + bool m_requestIdHasBeenSet = false; +}; + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/DescribeChannelRequest.h b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/DescribeChannelRequest.h new file mode 100644 index 000000000000..b1311e4e2e5b --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/DescribeChannelRequest.h @@ -0,0 +1,82 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include + +#include + +namespace Aws { +namespace Kafka { +namespace Model { + +/** + */ +class DescribeChannelRequest : public KafkaRequest { + public: + AWS_KAFKA_API DescribeChannelRequest() = default; + + // Service request name is the Operation name which will send this request out, + // each operation should has unique request name, so that we can get operation's name from this request. + // Note: this is not true for response, multiple operations may have the same response name, + // so we can not get operation's name from response. + inline virtual const char* GetServiceRequestName() const override { return "DescribeChannel"; } + + AWS_KAFKA_API Aws::String SerializePayload() const override; + + ///@{ + /** + * +

The Amazon Resource Name (ARN) that uniquely identifies the + * channel.

+ + */ + inline const Aws::String& GetChannelArn() const { return m_channelArn; } + inline bool ChannelArnHasBeenSet() const { return m_channelArnHasBeenSet; } + template + void SetChannelArn(ChannelArnT&& value) { + m_channelArnHasBeenSet = true; + m_channelArn = std::forward(value); + } + template + DescribeChannelRequest& WithChannelArn(ChannelArnT&& value) { + SetChannelArn(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + * +

The Amazon Resource Name (ARN) that uniquely identifies the + * cluster.

+ + */ + inline const Aws::String& GetClusterArn() const { return m_clusterArn; } + inline bool ClusterArnHasBeenSet() const { return m_clusterArnHasBeenSet; } + template + void SetClusterArn(ClusterArnT&& value) { + m_clusterArnHasBeenSet = true; + m_clusterArn = std::forward(value); + } + template + DescribeChannelRequest& WithClusterArn(ClusterArnT&& value) { + SetClusterArn(std::forward(value)); + return *this; + } + ///@} + private: + Aws::String m_channelArn; + + Aws::String m_clusterArn; + bool m_channelArnHasBeenSet = false; + bool m_clusterArnHasBeenSet = false; +}; + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/DescribeChannelResult.h b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/DescribeChannelResult.h new file mode 100644 index 000000000000..27001389b989 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/DescribeChannelResult.h @@ -0,0 +1,346 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include + +namespace Aws { +template +class AmazonWebServiceResult; + +namespace Utils { +namespace Json { +class JsonValue; +} // namespace Json +} // namespace Utils +namespace Kafka { +namespace Model { +/** + *

Contains the current configuration and state of a channel.

See + * Also:

AWS + * API Reference

+ */ +class DescribeChannelResult { + public: + AWS_KAFKA_API DescribeChannelResult() = default; + AWS_KAFKA_API DescribeChannelResult(const Aws::AmazonWebServiceResult& result); + AWS_KAFKA_API DescribeChannelResult& operator=(const Aws::AmazonWebServiceResult& result); + + ///@{ + /** + * +

The Amazon Resource Name (ARN) that uniquely identifies the + * channel.

+ + */ + inline const Aws::String& GetChannelArn() const { return m_channelArn; } + template + void SetChannelArn(ChannelArnT&& value) { + m_channelArnHasBeenSet = true; + m_channelArn = std::forward(value); + } + template + DescribeChannelResult& WithChannelArn(ChannelArnT&& value) { + SetChannelArn(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The name of the channel.

+ */ + inline const Aws::String& GetChannelName() const { return m_channelName; } + template + void SetChannelName(ChannelNameT&& value) { + m_channelNameHasBeenSet = true; + m_channelName = std::forward(value); + } + template + DescribeChannelResult& WithChannelName(ChannelNameT&& value) { + SetChannelName(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The encryption configuration applied to the channel.

+ */ + inline const EncryptionConfiguration& GetEncryptionConfiguration() const { return m_encryptionConfiguration; } + template + void SetEncryptionConfiguration(EncryptionConfigurationT&& value) { + m_encryptionConfigurationHasBeenSet = true; + m_encryptionConfiguration = std::forward(value); + } + template + DescribeChannelResult& WithEncryptionConfiguration(EncryptionConfigurationT&& value) { + SetEncryptionConfiguration(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The Apache Iceberg destination for the channel, if configured.

+ */ + inline const IcebergDestinationConfiguration& GetIcebergDestinationConfiguration() const { return m_icebergDestinationConfiguration; } + template + void SetIcebergDestinationConfiguration(IcebergDestinationConfigurationT&& value) { + m_icebergDestinationConfigurationHasBeenSet = true; + m_icebergDestinationConfiguration = std::forward(value); + } + template + DescribeChannelResult& WithIcebergDestinationConfiguration(IcebergDestinationConfigurationT&& value) { + SetIcebergDestinationConfiguration(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The Amazon S3 destination for the channel, if configured.

+ */ + inline const S3DestinationConfiguration& GetS3DestinationConfiguration() const { return m_s3DestinationConfiguration; } + template + void SetS3DestinationConfiguration(S3DestinationConfigurationT&& value) { + m_s3DestinationConfigurationHasBeenSet = true; + m_s3DestinationConfiguration = std::forward(value); + } + template + DescribeChannelResult& WithS3DestinationConfiguration(S3DestinationConfigurationT&& value) { + SetS3DestinationConfiguration(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The current lifecycle state of the channel.

+ */ + inline ChannelStatus GetStatus() const { return m_status; } + inline void SetStatus(ChannelStatus value) { + m_statusHasBeenSet = true; + m_status = value; + } + inline DescribeChannelResult& WithStatus(ChannelStatus value) { + SetStatus(value); + return *this; + } + ///@} + + ///@{ + /** + *

The type of destination configured for the channel.

+ */ + inline ChannelDestinationType GetDestinationType() const { return m_destinationType; } + inline void SetDestinationType(ChannelDestinationType value) { + m_destinationTypeHasBeenSet = true; + m_destinationType = value; + } + inline DescribeChannelResult& WithDestinationType(ChannelDestinationType value) { + SetDestinationType(value); + return *this; + } + ///@} + + ///@{ + /** + * +

The time when the channel was created.

+ + */ + inline const Aws::Utils::DateTime& GetCreationTime() const { return m_creationTime; } + template + void SetCreationTime(CreationTimeT&& value) { + m_creationTimeHasBeenSet = true; + m_creationTime = std::forward(value); + } + template + DescribeChannelResult& WithCreationTime(CreationTimeT&& value) { + SetCreationTime(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The list of topic configurations for the channel.

+ */ + inline const Aws::Vector& GetTopicConfigurationList() const { return m_topicConfigurationList; } + template > + void SetTopicConfigurationList(TopicConfigurationListT&& value) { + m_topicConfigurationListHasBeenSet = true; + m_topicConfigurationList = std::forward(value); + } + template > + DescribeChannelResult& WithTopicConfigurationList(TopicConfigurationListT&& value) { + SetTopicConfigurationList(std::forward(value)); + return *this; + } + template + DescribeChannelResult& AddTopicConfigurationList(TopicConfigurationListT&& value) { + m_topicConfigurationListHasBeenSet = true; + m_topicConfigurationList.emplace_back(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The destinations to which the channel publishes operational logs.

+ */ + inline const ChannelLoggingInfo& GetLoggingInfo() const { return m_loggingInfo; } + template + void SetLoggingInfo(LoggingInfoT&& value) { + m_loggingInfoHasBeenSet = true; + m_loggingInfo = std::forward(value); + } + template + DescribeChannelResult& WithLoggingInfo(LoggingInfoT&& value) { + SetLoggingInfo(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

Additional context for the current channel state, populated when the channel + * is in FAILED.

+ */ + inline const ChannelStateInfo& GetStateInfo() const { return m_stateInfo; } + template + void SetStateInfo(StateInfoT&& value) { + m_stateInfoHasBeenSet = true; + m_stateInfo = std::forward(value); + } + template + DescribeChannelResult& WithStateInfo(StateInfoT&& value) { + SetStateInfo(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The Amazon Resource Name (ARN) of the in-flight cluster operation. Returned + * only while the channel is in CREATING, UPDATING, or DELETING.

+ */ + inline const Aws::String& GetClusterOperationArn() const { return m_clusterOperationArn; } + template + void SetClusterOperationArn(ClusterOperationArnT&& value) { + m_clusterOperationArnHasBeenSet = true; + m_clusterOperationArn = std::forward(value); + } + template + DescribeChannelResult& WithClusterOperationArn(ClusterOperationArnT&& value) { + SetClusterOperationArn(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The tags attached to the channel.

+ */ + inline const Aws::Map& GetTags() const { return m_tags; } + template > + void SetTags(TagsT&& value) { + m_tagsHasBeenSet = true; + m_tags = std::forward(value); + } + template > + DescribeChannelResult& WithTags(TagsT&& value) { + SetTags(std::forward(value)); + return *this; + } + template + DescribeChannelResult& AddTags(TagsKeyT&& key, TagsValueT&& value) { + m_tagsHasBeenSet = true; + m_tags.emplace(std::forward(key), std::forward(value)); + return *this; + } + ///@} + + ///@{ + + inline const Aws::String& GetRequestId() const { return m_requestId; } + template + void SetRequestId(RequestIdT&& value) { + m_requestIdHasBeenSet = true; + m_requestId = std::forward(value); + } + template + DescribeChannelResult& WithRequestId(RequestIdT&& value) { + SetRequestId(std::forward(value)); + return *this; + } + ///@} + inline Aws::Http::HttpResponseCode GetHttpResponseCode() const { return m_HttpResponseCode; } + + private: + Aws::String m_channelArn; + + Aws::String m_channelName; + + EncryptionConfiguration m_encryptionConfiguration; + + IcebergDestinationConfiguration m_icebergDestinationConfiguration; + + S3DestinationConfiguration m_s3DestinationConfiguration; + + ChannelStatus m_status{ChannelStatus::NOT_SET}; + + ChannelDestinationType m_destinationType{ChannelDestinationType::NOT_SET}; + + Aws::Utils::DateTime m_creationTime{}; + + Aws::Vector m_topicConfigurationList; + + ChannelLoggingInfo m_loggingInfo; + + ChannelStateInfo m_stateInfo; + + Aws::String m_clusterOperationArn; + + Aws::Map m_tags; + + Aws::String m_requestId; + Aws::Http::HttpResponseCode m_HttpResponseCode; + bool m_channelArnHasBeenSet = false; + bool m_channelNameHasBeenSet = false; + bool m_encryptionConfigurationHasBeenSet = false; + bool m_icebergDestinationConfigurationHasBeenSet = false; + bool m_s3DestinationConfigurationHasBeenSet = false; + bool m_statusHasBeenSet = false; + bool m_destinationTypeHasBeenSet = false; + bool m_creationTimeHasBeenSet = false; + bool m_topicConfigurationListHasBeenSet = false; + bool m_loggingInfoHasBeenSet = false; + bool m_stateInfoHasBeenSet = false; + bool m_clusterOperationArnHasBeenSet = false; + bool m_tagsHasBeenSet = false; + bool m_requestIdHasBeenSet = false; +}; + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/DestinationTable.h b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/DestinationTable.h new file mode 100644 index 000000000000..646d5e6c794b --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/DestinationTable.h @@ -0,0 +1,103 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include + +#include + +namespace Aws { +namespace Utils { +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json +} // namespace Utils +namespace Kafka { +namespace Model { + +/** + *

Configuration of an Apache Iceberg destination table.

See + * Also:

AWS + * API Reference

+ */ +class DestinationTable { + public: + AWS_KAFKA_API DestinationTable() = default; + AWS_KAFKA_API DestinationTable(Aws::Utils::Json::JsonView jsonValue); + AWS_KAFKA_API DestinationTable& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_KAFKA_API Aws::Utils::Json::JsonValue Jsonize() const; + + ///@{ + /** + *

The name of the destination namespace (database) in the AWS Glue Data + * Catalog.

+ */ + inline const Aws::String& GetDestinationDatabaseName() const { return m_destinationDatabaseName; } + inline bool DestinationDatabaseNameHasBeenSet() const { return m_destinationDatabaseNameHasBeenSet; } + template + void SetDestinationDatabaseName(DestinationDatabaseNameT&& value) { + m_destinationDatabaseNameHasBeenSet = true; + m_destinationDatabaseName = std::forward(value); + } + template + DestinationTable& WithDestinationDatabaseName(DestinationDatabaseNameT&& value) { + SetDestinationDatabaseName(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The name of the destination Apache Iceberg table.

+ */ + inline const Aws::String& GetDestinationTableName() const { return m_destinationTableName; } + inline bool DestinationTableNameHasBeenSet() const { return m_destinationTableNameHasBeenSet; } + template + void SetDestinationTableName(DestinationTableNameT&& value) { + m_destinationTableNameHasBeenSet = true; + m_destinationTableName = std::forward(value); + } + template + DestinationTable& WithDestinationTableName(DestinationTableNameT&& value) { + SetDestinationTableName(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The partition specification for the destination table.

+ */ + inline const PartitionSpec& GetPartitionSpec() const { return m_partitionSpec; } + inline bool PartitionSpecHasBeenSet() const { return m_partitionSpecHasBeenSet; } + template + void SetPartitionSpec(PartitionSpecT&& value) { + m_partitionSpecHasBeenSet = true; + m_partitionSpec = std::forward(value); + } + template + DestinationTable& WithPartitionSpec(PartitionSpecT&& value) { + SetPartitionSpec(std::forward(value)); + return *this; + } + ///@} + private: + Aws::String m_destinationDatabaseName; + + Aws::String m_destinationTableName; + + PartitionSpec m_partitionSpec; + bool m_destinationDatabaseNameHasBeenSet = false; + bool m_destinationTableNameHasBeenSet = false; + bool m_partitionSpecHasBeenSet = false; +}; + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/EncryptionConfiguration.h b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/EncryptionConfiguration.h new file mode 100644 index 000000000000..39ebbd3bb720 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/EncryptionConfiguration.h @@ -0,0 +1,60 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include + +#include + +namespace Aws { +namespace Utils { +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json +} // namespace Utils +namespace Kafka { +namespace Model { + +/** + *

The AWS KMS encryption configuration applied to data at rest.

See + * Also:

AWS + * API Reference

+ */ +class EncryptionConfiguration { + public: + AWS_KAFKA_API EncryptionConfiguration() = default; + AWS_KAFKA_API EncryptionConfiguration(Aws::Utils::Json::JsonView jsonValue); + AWS_KAFKA_API EncryptionConfiguration& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_KAFKA_API Aws::Utils::Json::JsonValue Jsonize() const; + + ///@{ + /** + *

The Amazon Resource Name (ARN) of the AWS KMS key used to encrypt the + * data.

+ */ + inline const Aws::String& GetKmsKeyArn() const { return m_kmsKeyArn; } + inline bool KmsKeyArnHasBeenSet() const { return m_kmsKeyArnHasBeenSet; } + template + void SetKmsKeyArn(KmsKeyArnT&& value) { + m_kmsKeyArnHasBeenSet = true; + m_kmsKeyArn = std::forward(value); + } + template + EncryptionConfiguration& WithKmsKeyArn(KmsKeyArnT&& value) { + SetKmsKeyArn(std::forward(value)); + return *this; + } + ///@} + private: + Aws::String m_kmsKeyArn; + bool m_kmsKeyArnHasBeenSet = false; +}; + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/IcebergCompressionType.h b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/IcebergCompressionType.h new file mode 100644 index 000000000000..c2075fdd2bcf --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/IcebergCompressionType.h @@ -0,0 +1,22 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include + +namespace Aws { +namespace Kafka { +namespace Model { +enum class IcebergCompressionType { NOT_SET, ZSTD, SNAPPY }; + +namespace IcebergCompressionTypeMapper { +AWS_KAFKA_API IcebergCompressionType GetIcebergCompressionTypeForName(const Aws::String& name); + +AWS_KAFKA_API Aws::String GetNameForIcebergCompressionType(IcebergCompressionType value); +} // namespace IcebergCompressionTypeMapper +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/IcebergDestinationConfiguration.h b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/IcebergDestinationConfiguration.h new file mode 100644 index 000000000000..5918e3d3d11b --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/IcebergDestinationConfiguration.h @@ -0,0 +1,243 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include + +namespace Aws { +namespace Utils { +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json +} // namespace Utils +namespace Kafka { +namespace Model { + +/** + *

Configuration of an Apache Iceberg destination for a channel.

See + * Also:

AWS + * API Reference

+ */ +class IcebergDestinationConfiguration { + public: + AWS_KAFKA_API IcebergDestinationConfiguration() = default; + AWS_KAFKA_API IcebergDestinationConfiguration(Aws::Utils::Json::JsonView jsonValue); + AWS_KAFKA_API IcebergDestinationConfiguration& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_KAFKA_API Aws::Utils::Json::JsonValue Jsonize() const; + + ///@{ + /** + *

Whether the destination is append-only. Must be true; updates and deletes are + * not supported.

+ */ + inline bool GetAppendOnly() const { return m_appendOnly; } + inline bool AppendOnlyHasBeenSet() const { return m_appendOnlyHasBeenSet; } + inline void SetAppendOnly(bool value) { + m_appendOnlyHasBeenSet = true; + m_appendOnly = value; + } + inline IcebergDestinationConfiguration& WithAppendOnly(bool value) { + SetAppendOnly(value); + return *this; + } + ///@} + + ///@{ + /** + *

The AWS Glue Data Catalog and S3 Tables warehouse used by the + * destination.

+ */ + inline const Catalog& GetCatalog() const { return m_catalog; } + inline bool CatalogHasBeenSet() const { return m_catalogHasBeenSet; } + template + void SetCatalog(CatalogT&& value) { + m_catalogHasBeenSet = true; + m_catalog = std::forward(value); + } + template + IcebergDestinationConfiguration& WithCatalog(CatalogT&& value) { + SetCatalog(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The maximum time, in seconds, that records buffer in MSK before being flushed + * to the destination. Allowed range: 300 to 900. Default: 600.

+ */ + inline int GetDataFreshnessInSeconds() const { return m_dataFreshnessInSeconds; } + inline bool DataFreshnessInSecondsHasBeenSet() const { return m_dataFreshnessInSecondsHasBeenSet; } + inline void SetDataFreshnessInSeconds(int value) { + m_dataFreshnessInSecondsHasBeenSet = true; + m_dataFreshnessInSeconds = value; + } + inline IcebergDestinationConfiguration& WithDataFreshnessInSeconds(int value) { + SetDataFreshnessInSeconds(value); + return *this; + } + ///@} + + ///@{ + /** + *

The Amazon S3 bucket and prefix where MSK writes records that fail to + * deliver.

+ */ + inline const DeadLetterQueueS3& GetDeadLetterQueueS3() const { return m_deadLetterQueueS3; } + inline bool DeadLetterQueueS3HasBeenSet() const { return m_deadLetterQueueS3HasBeenSet; } + template + void SetDeadLetterQueueS3(DeadLetterQueueS3T&& value) { + m_deadLetterQueueS3HasBeenSet = true; + m_deadLetterQueueS3 = std::forward(value); + } + template + IcebergDestinationConfiguration& WithDeadLetterQueueS3(DeadLetterQueueS3T&& value) { + SetDeadLetterQueueS3(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The destination Iceberg tables. Currently exactly one table must be + * specified.

+ */ + inline const Aws::Vector& GetDestinationTableList() const { return m_destinationTableList; } + inline bool DestinationTableListHasBeenSet() const { return m_destinationTableListHasBeenSet; } + template > + void SetDestinationTableList(DestinationTableListT&& value) { + m_destinationTableListHasBeenSet = true; + m_destinationTableList = std::forward(value); + } + template > + IcebergDestinationConfiguration& WithDestinationTableList(DestinationTableListT&& value) { + SetDestinationTableList(std::forward(value)); + return *this; + } + template + IcebergDestinationConfiguration& AddDestinationTableList(DestinationTableListT&& value) { + m_destinationTableListHasBeenSet = true; + m_destinationTableList.emplace_back(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

Configuration controlling whether the destination table's schema is evolved + * to match incoming records.

+ */ + inline const SchemaEvolution& GetSchemaEvolution() const { return m_schemaEvolution; } + inline bool SchemaEvolutionHasBeenSet() const { return m_schemaEvolutionHasBeenSet; } + template + void SetSchemaEvolution(SchemaEvolutionT&& value) { + m_schemaEvolutionHasBeenSet = true; + m_schemaEvolution = std::forward(value); + } + template + IcebergDestinationConfiguration& WithSchemaEvolution(SchemaEvolutionT&& value) { + SetSchemaEvolution(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The Amazon Resource Name (ARN) of the IAM role that MSK assumes to access the + * destination table, the AWS Glue Data Catalog, and the dead-letter Amazon S3 + * bucket.

+ */ + inline const Aws::String& GetServiceExecutionRoleArn() const { return m_serviceExecutionRoleArn; } + inline bool ServiceExecutionRoleArnHasBeenSet() const { return m_serviceExecutionRoleArnHasBeenSet; } + template + void SetServiceExecutionRoleArn(ServiceExecutionRoleArnT&& value) { + m_serviceExecutionRoleArnHasBeenSet = true; + m_serviceExecutionRoleArn = std::forward(value); + } + template + IcebergDestinationConfiguration& WithServiceExecutionRoleArn(ServiceExecutionRoleArnT&& value) { + SetServiceExecutionRoleArn(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

Configuration controlling whether MSK creates the destination table if it + * does not already exist.

+ */ + inline const TableCreation& GetTableCreation() const { return m_tableCreation; } + inline bool TableCreationHasBeenSet() const { return m_tableCreationHasBeenSet; } + template + void SetTableCreation(TableCreationT&& value) { + m_tableCreationHasBeenSet = true; + m_tableCreation = std::forward(value); + } + template + IcebergDestinationConfiguration& WithTableCreation(TableCreationT&& value) { + SetTableCreation(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The compression codec for Iceberg table data files. Defaults to ZSTD.

+ */ + inline IcebergCompressionType GetCompressionType() const { return m_compressionType; } + inline bool CompressionTypeHasBeenSet() const { return m_compressionTypeHasBeenSet; } + inline void SetCompressionType(IcebergCompressionType value) { + m_compressionTypeHasBeenSet = true; + m_compressionType = value; + } + inline IcebergDestinationConfiguration& WithCompressionType(IcebergCompressionType value) { + SetCompressionType(value); + return *this; + } + ///@} + private: + bool m_appendOnly{false}; + + Catalog m_catalog; + + int m_dataFreshnessInSeconds{0}; + + DeadLetterQueueS3 m_deadLetterQueueS3; + + Aws::Vector m_destinationTableList; + + SchemaEvolution m_schemaEvolution; + + Aws::String m_serviceExecutionRoleArn; + + TableCreation m_tableCreation; + + IcebergCompressionType m_compressionType{IcebergCompressionType::NOT_SET}; + bool m_appendOnlyHasBeenSet = false; + bool m_catalogHasBeenSet = false; + bool m_dataFreshnessInSecondsHasBeenSet = false; + bool m_deadLetterQueueS3HasBeenSet = false; + bool m_destinationTableListHasBeenSet = false; + bool m_schemaEvolutionHasBeenSet = false; + bool m_serviceExecutionRoleArnHasBeenSet = false; + bool m_tableCreationHasBeenSet = false; + bool m_compressionTypeHasBeenSet = false; +}; + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/IcebergDestinationUpdate.h b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/IcebergDestinationUpdate.h new file mode 100644 index 000000000000..04a8f5633bbf --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/IcebergDestinationUpdate.h @@ -0,0 +1,55 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include + +namespace Aws { +namespace Utils { +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json +} // namespace Utils +namespace Kafka { +namespace Model { + +/** + *

Update payload for an Apache Iceberg destination.

See Also:

+ * AWS + * API Reference

+ */ +class IcebergDestinationUpdate { + public: + AWS_KAFKA_API IcebergDestinationUpdate() = default; + AWS_KAFKA_API IcebergDestinationUpdate(Aws::Utils::Json::JsonView jsonValue); + AWS_KAFKA_API IcebergDestinationUpdate& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_KAFKA_API Aws::Utils::Json::JsonValue Jsonize() const; + + ///@{ + /** + *

The maximum time, in seconds, that records buffer in MSK before being flushed + * to the destination. Allowed range: 300 to 900.

+ */ + inline int GetDataFreshnessInSeconds() const { return m_dataFreshnessInSeconds; } + inline bool DataFreshnessInSecondsHasBeenSet() const { return m_dataFreshnessInSecondsHasBeenSet; } + inline void SetDataFreshnessInSeconds(int value) { + m_dataFreshnessInSecondsHasBeenSet = true; + m_dataFreshnessInSeconds = value; + } + inline IcebergDestinationUpdate& WithDataFreshnessInSeconds(int value) { + SetDataFreshnessInSeconds(value); + return *this; + } + ///@} + private: + int m_dataFreshnessInSeconds{0}; + bool m_dataFreshnessInSecondsHasBeenSet = false; +}; + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/ListChannelsRequest.h b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/ListChannelsRequest.h new file mode 100644 index 000000000000..badb7c95aa02 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/ListChannelsRequest.h @@ -0,0 +1,134 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include + +#include + +namespace Aws { +namespace Http { +class URI; +} // namespace Http +namespace Kafka { +namespace Model { + +/** + */ +class ListChannelsRequest : public KafkaRequest { + public: + AWS_KAFKA_API ListChannelsRequest() = default; + + // Service request name is the Operation name which will send this request out, + // each operation should has unique request name, so that we can get operation's name from this request. + // Note: this is not true for response, multiple operations may have the same response name, + // so we can not get operation's name from response. + inline virtual const char* GetServiceRequestName() const override { return "ListChannels"; } + + AWS_KAFKA_API Aws::String SerializePayload() const override; + + AWS_KAFKA_API void AddQueryStringParameters(Aws::Http::URI& uri) const override; + + ///@{ + /** + * +

The Amazon Resource Name (ARN) that uniquely identifies the + * cluster.

+ + */ + inline const Aws::String& GetClusterArn() const { return m_clusterArn; } + inline bool ClusterArnHasBeenSet() const { return m_clusterArnHasBeenSet; } + template + void SetClusterArn(ClusterArnT&& value) { + m_clusterArnHasBeenSet = true; + m_clusterArn = std::forward(value); + } + template + ListChannelsRequest& WithClusterArn(ClusterArnT&& value) { + SetClusterArn(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + * +

Maximum number of channels to return in a single response.

+ + * + */ + inline int GetMaxResults() const { return m_maxResults; } + inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; } + inline void SetMaxResults(int value) { + m_maxResultsHasBeenSet = true; + m_maxResults = value; + } + inline ListChannelsRequest& WithMaxResults(int value) { + SetMaxResults(value); + return *this; + } + ///@} + + ///@{ + /** + * +

If the response of ListChannels is truncated, it returns a + * nextToken in the response. This nextToken should be sent in the subsequent + * request to ListChannels.

+ + */ + inline const Aws::String& GetNextToken() const { return m_nextToken; } + inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } + template + void SetNextToken(NextTokenT&& value) { + m_nextTokenHasBeenSet = true; + m_nextToken = std::forward(value); + } + template + ListChannelsRequest& WithNextToken(NextTokenT&& value) { + SetNextToken(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + * +

Filters results to channels whose topic name matches the + * specified value.

+ + */ + inline const Aws::String& GetTopicNameFilter() const { return m_topicNameFilter; } + inline bool TopicNameFilterHasBeenSet() const { return m_topicNameFilterHasBeenSet; } + template + void SetTopicNameFilter(TopicNameFilterT&& value) { + m_topicNameFilterHasBeenSet = true; + m_topicNameFilter = std::forward(value); + } + template + ListChannelsRequest& WithTopicNameFilter(TopicNameFilterT&& value) { + SetTopicNameFilter(std::forward(value)); + return *this; + } + ///@} + private: + Aws::String m_clusterArn; + + int m_maxResults{0}; + + Aws::String m_nextToken; + + Aws::String m_topicNameFilter; + bool m_clusterArnHasBeenSet = false; + bool m_maxResultsHasBeenSet = false; + bool m_nextTokenHasBeenSet = false; + bool m_topicNameFilterHasBeenSet = false; +}; + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/ListChannelsResult.h b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/ListChannelsResult.h new file mode 100644 index 000000000000..208a449c1e4c --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/ListChannelsResult.h @@ -0,0 +1,109 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include +#include +#include + +#include + +namespace Aws { +template +class AmazonWebServiceResult; + +namespace Utils { +namespace Json { +class JsonValue; +} // namespace Json +} // namespace Utils +namespace Kafka { +namespace Model { +/** + *

Returns the list of channels in the cluster.

See Also:

AWS + * API Reference

+ */ +class ListChannelsResult { + public: + AWS_KAFKA_API ListChannelsResult() = default; + AWS_KAFKA_API ListChannelsResult(const Aws::AmazonWebServiceResult& result); + AWS_KAFKA_API ListChannelsResult& operator=(const Aws::AmazonWebServiceResult& result); + + ///@{ + /** + *

The list of channels in the cluster.

+ */ + inline const Aws::Vector& GetChannels() const { return m_channels; } + template > + void SetChannels(ChannelsT&& value) { + m_channelsHasBeenSet = true; + m_channels = std::forward(value); + } + template > + ListChannelsResult& WithChannels(ChannelsT&& value) { + SetChannels(std::forward(value)); + return *this; + } + template + ListChannelsResult& AddChannels(ChannelsT&& value) { + m_channelsHasBeenSet = true; + m_channels.emplace_back(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

If the response from ListChannels is truncated, this token is included. Send + * it as the nextToken parameter on a subsequent ListChannels call to retrieve the + * next page.

+ */ + inline const Aws::String& GetNextToken() const { return m_nextToken; } + template + void SetNextToken(NextTokenT&& value) { + m_nextTokenHasBeenSet = true; + m_nextToken = std::forward(value); + } + template + ListChannelsResult& WithNextToken(NextTokenT&& value) { + SetNextToken(std::forward(value)); + return *this; + } + ///@} + + ///@{ + + inline const Aws::String& GetRequestId() const { return m_requestId; } + template + void SetRequestId(RequestIdT&& value) { + m_requestIdHasBeenSet = true; + m_requestId = std::forward(value); + } + template + ListChannelsResult& WithRequestId(RequestIdT&& value) { + SetRequestId(std::forward(value)); + return *this; + } + ///@} + inline Aws::Http::HttpResponseCode GetHttpResponseCode() const { return m_HttpResponseCode; } + + private: + Aws::Vector m_channels; + + Aws::String m_nextToken; + + Aws::String m_requestId; + Aws::Http::HttpResponseCode m_HttpResponseCode; + bool m_channelsHasBeenSet = false; + bool m_nextTokenHasBeenSet = false; + bool m_requestIdHasBeenSet = false; +}; + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/PartitionSource.h b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/PartitionSource.h new file mode 100644 index 000000000000..8ce9413af20d --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/PartitionSource.h @@ -0,0 +1,61 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include + +#include + +namespace Aws { +namespace Utils { +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json +} // namespace Utils +namespace Kafka { +namespace Model { + +/** + *

A source column used by an Apache Iceberg destination table's partition + * specification.

See Also:

AWS + * API Reference

+ */ +class PartitionSource { + public: + AWS_KAFKA_API PartitionSource() = default; + AWS_KAFKA_API PartitionSource(Aws::Utils::Json::JsonView jsonValue); + AWS_KAFKA_API PartitionSource& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_KAFKA_API Aws::Utils::Json::JsonValue Jsonize() const; + + ///@{ + /** + * +

Source name.

+ + */ + inline const Aws::String& GetSourceName() const { return m_sourceName; } + inline bool SourceNameHasBeenSet() const { return m_sourceNameHasBeenSet; } + template + void SetSourceName(SourceNameT&& value) { + m_sourceNameHasBeenSet = true; + m_sourceName = std::forward(value); + } + template + PartitionSource& WithSourceName(SourceNameT&& value) { + SetSourceName(std::forward(value)); + return *this; + } + ///@} + private: + Aws::String m_sourceName; + bool m_sourceNameHasBeenSet = false; +}; + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/PartitionSpec.h b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/PartitionSpec.h new file mode 100644 index 000000000000..f844d8ef8f5c --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/PartitionSpec.h @@ -0,0 +1,87 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include +#include + +#include + +namespace Aws { +namespace Utils { +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json +} // namespace Utils +namespace Kafka { +namespace Model { + +/** + *

Partition specification for an Apache Iceberg destination + * table.

See Also:

AWS + * API Reference

+ */ +class PartitionSpec { + public: + AWS_KAFKA_API PartitionSpec() = default; + AWS_KAFKA_API PartitionSpec(Aws::Utils::Json::JsonView jsonValue); + AWS_KAFKA_API PartitionSpec& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_KAFKA_API Aws::Utils::Json::JsonValue Jsonize() const; + + ///@{ + /** + *

The partitioning strategy applied to records written to the table.

+ */ + inline PartitionStrategy GetPartitionStrategy() const { return m_partitionStrategy; } + inline bool PartitionStrategyHasBeenSet() const { return m_partitionStrategyHasBeenSet; } + inline void SetPartitionStrategy(PartitionStrategy value) { + m_partitionStrategyHasBeenSet = true; + m_partitionStrategy = value; + } + inline PartitionSpec& WithPartitionStrategy(PartitionStrategy value) { + SetPartitionStrategy(value); + return *this; + } + ///@} + + ///@{ + /** + *

The source columns used by the partitioning strategy. For TIME_HOUR, must + * contain exactly one source column whose value is a timestamp.

+ */ + inline const Aws::Vector& GetSourceList() const { return m_sourceList; } + inline bool SourceListHasBeenSet() const { return m_sourceListHasBeenSet; } + template > + void SetSourceList(SourceListT&& value) { + m_sourceListHasBeenSet = true; + m_sourceList = std::forward(value); + } + template > + PartitionSpec& WithSourceList(SourceListT&& value) { + SetSourceList(std::forward(value)); + return *this; + } + template + PartitionSpec& AddSourceList(SourceListT&& value) { + m_sourceListHasBeenSet = true; + m_sourceList.emplace_back(std::forward(value)); + return *this; + } + ///@} + private: + PartitionStrategy m_partitionStrategy{PartitionStrategy::NOT_SET}; + + Aws::Vector m_sourceList; + bool m_partitionStrategyHasBeenSet = false; + bool m_sourceListHasBeenSet = false; +}; + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/PartitionStrategy.h b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/PartitionStrategy.h new file mode 100644 index 000000000000..c56a4fb47433 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/PartitionStrategy.h @@ -0,0 +1,22 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include + +namespace Aws { +namespace Kafka { +namespace Model { +enum class PartitionStrategy { NOT_SET, TIME_HOUR }; + +namespace PartitionStrategyMapper { +AWS_KAFKA_API PartitionStrategy GetPartitionStrategyForName(const Aws::String& name); + +AWS_KAFKA_API Aws::String GetNameForPartitionStrategy(PartitionStrategy value); +} // namespace PartitionStrategyMapper +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/RecordConverter.h b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/RecordConverter.h new file mode 100644 index 000000000000..776d23b2a9b8 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/RecordConverter.h @@ -0,0 +1,57 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include + +#include + +namespace Aws { +namespace Utils { +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json +} // namespace Utils +namespace Kafka { +namespace Model { + +/** + *

Configuration that controls how Apache Kafka record values are deserialized + * for the destination.

See Also:

AWS + * API Reference

+ */ +class RecordConverter { + public: + AWS_KAFKA_API RecordConverter() = default; + AWS_KAFKA_API RecordConverter(Aws::Utils::Json::JsonView jsonValue); + AWS_KAFKA_API RecordConverter& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_KAFKA_API Aws::Utils::Json::JsonValue Jsonize() const; + + ///@{ + /** + *

The deserialization format applied to Apache Kafka record values.

+ */ + inline ValueConverter GetValueConverter() const { return m_valueConverter; } + inline bool ValueConverterHasBeenSet() const { return m_valueConverterHasBeenSet; } + inline void SetValueConverter(ValueConverter value) { + m_valueConverterHasBeenSet = true; + m_valueConverter = value; + } + inline RecordConverter& WithValueConverter(ValueConverter value) { + SetValueConverter(value); + return *this; + } + ///@} + private: + ValueConverter m_valueConverter{ValueConverter::NOT_SET}; + bool m_valueConverterHasBeenSet = false; +}; + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/RecordSchema.h b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/RecordSchema.h new file mode 100644 index 000000000000..adafa93921f4 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/RecordSchema.h @@ -0,0 +1,60 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include + +#include + +namespace Aws { +namespace Utils { +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json +} // namespace Utils +namespace Kafka { +namespace Model { + +/** + *

Schema configuration that controls how Apache Kafka record values are + * validated.

See Also:

AWS + * API Reference

+ */ +class RecordSchema { + public: + AWS_KAFKA_API RecordSchema() = default; + AWS_KAFKA_API RecordSchema(Aws::Utils::Json::JsonView jsonValue); + AWS_KAFKA_API RecordSchema& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_KAFKA_API Aws::Utils::Json::JsonValue Jsonize() const; + + ///@{ + /** + *

The Amazon Resource Name (ARN) of the AWS Glue Schema Registry schema (not + * registry) used to validate records for the destination Apache Iceberg table.

+ */ + inline const Aws::String& GetGsrArn() const { return m_gsrArn; } + inline bool GsrArnHasBeenSet() const { return m_gsrArnHasBeenSet; } + template + void SetGsrArn(GsrArnT&& value) { + m_gsrArnHasBeenSet = true; + m_gsrArn = std::forward(value); + } + template + RecordSchema& WithGsrArn(GsrArnT&& value) { + SetGsrArn(std::forward(value)); + return *this; + } + ///@} + private: + Aws::String m_gsrArn; + bool m_gsrArnHasBeenSet = false; +}; + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/S3CompressionType.h b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/S3CompressionType.h new file mode 100644 index 000000000000..4ed4d42077d9 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/S3CompressionType.h @@ -0,0 +1,22 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include + +namespace Aws { +namespace Kafka { +namespace Model { +enum class S3CompressionType { NOT_SET, NONE, GZIP, ZSTD }; + +namespace S3CompressionTypeMapper { +AWS_KAFKA_API S3CompressionType GetS3CompressionTypeForName(const Aws::String& name); + +AWS_KAFKA_API Aws::String GetNameForS3CompressionType(S3CompressionType value); +} // namespace S3CompressionTypeMapper +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/S3DestinationConfiguration.h b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/S3DestinationConfiguration.h new file mode 100644 index 000000000000..377b7e36b3a4 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/S3DestinationConfiguration.h @@ -0,0 +1,125 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include +#include + +#include + +namespace Aws { +namespace Utils { +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json +} // namespace Utils +namespace Kafka { +namespace Model { + +/** + *

Configuration of an Amazon S3 destination for a channel.

See + * Also:

AWS + * API Reference

+ */ +class S3DestinationConfiguration { + public: + AWS_KAFKA_API S3DestinationConfiguration() = default; + AWS_KAFKA_API S3DestinationConfiguration(Aws::Utils::Json::JsonView jsonValue); + AWS_KAFKA_API S3DestinationConfiguration& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_KAFKA_API Aws::Utils::Json::JsonValue Jsonize() const; + + ///@{ + /** + *

The maximum time, in seconds, that records buffer in MSK before being flushed + * to the destination. Allowed range: 300 to 900. Default: 600.

+ */ + inline int GetDataFreshnessInSeconds() const { return m_dataFreshnessInSeconds; } + inline bool DataFreshnessInSecondsHasBeenSet() const { return m_dataFreshnessInSecondsHasBeenSet; } + inline void SetDataFreshnessInSeconds(int value) { + m_dataFreshnessInSecondsHasBeenSet = true; + m_dataFreshnessInSeconds = value; + } + inline S3DestinationConfiguration& WithDataFreshnessInSeconds(int value) { + SetDataFreshnessInSeconds(value); + return *this; + } + ///@} + + ///@{ + /** + *

The Amazon S3 bucket and prefix where MSK writes records that fail to + * deliver.

+ */ + inline const DeadLetterQueueS3& GetDeadLetterQueueS3() const { return m_deadLetterQueueS3; } + inline bool DeadLetterQueueS3HasBeenSet() const { return m_deadLetterQueueS3HasBeenSet; } + template + void SetDeadLetterQueueS3(DeadLetterQueueS3T&& value) { + m_deadLetterQueueS3HasBeenSet = true; + m_deadLetterQueueS3 = std::forward(value); + } + template + S3DestinationConfiguration& WithDeadLetterQueueS3(DeadLetterQueueS3T&& value) { + SetDeadLetterQueueS3(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The Amazon Resource Name (ARN) of the IAM role that MSK assumes to write to + * the destination Amazon S3 bucket and the dead-letter bucket.

+ */ + inline const Aws::String& GetServiceExecutionRoleArn() const { return m_serviceExecutionRoleArn; } + inline bool ServiceExecutionRoleArnHasBeenSet() const { return m_serviceExecutionRoleArnHasBeenSet; } + template + void SetServiceExecutionRoleArn(ServiceExecutionRoleArnT&& value) { + m_serviceExecutionRoleArnHasBeenSet = true; + m_serviceExecutionRoleArn = std::forward(value); + } + template + S3DestinationConfiguration& WithServiceExecutionRoleArn(ServiceExecutionRoleArnT&& value) { + SetServiceExecutionRoleArn(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The Amazon S3 bucket, prefix, and storage class for delivered records.

+ */ + inline const S3Storage& GetStorage() const { return m_storage; } + inline bool StorageHasBeenSet() const { return m_storageHasBeenSet; } + template + void SetStorage(StorageT&& value) { + m_storageHasBeenSet = true; + m_storage = std::forward(value); + } + template + S3DestinationConfiguration& WithStorage(StorageT&& value) { + SetStorage(std::forward(value)); + return *this; + } + ///@} + private: + int m_dataFreshnessInSeconds{0}; + + DeadLetterQueueS3 m_deadLetterQueueS3; + + Aws::String m_serviceExecutionRoleArn; + + S3Storage m_storage; + bool m_dataFreshnessInSecondsHasBeenSet = false; + bool m_deadLetterQueueS3HasBeenSet = false; + bool m_serviceExecutionRoleArnHasBeenSet = false; + bool m_storageHasBeenSet = false; +}; + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/S3DestinationUpdate.h b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/S3DestinationUpdate.h new file mode 100644 index 000000000000..276e182eae0e --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/S3DestinationUpdate.h @@ -0,0 +1,54 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include + +namespace Aws { +namespace Utils { +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json +} // namespace Utils +namespace Kafka { +namespace Model { + +/** + *

Update payload for an Amazon S3 destination.

See Also:

AWS + * API Reference

+ */ +class S3DestinationUpdate { + public: + AWS_KAFKA_API S3DestinationUpdate() = default; + AWS_KAFKA_API S3DestinationUpdate(Aws::Utils::Json::JsonView jsonValue); + AWS_KAFKA_API S3DestinationUpdate& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_KAFKA_API Aws::Utils::Json::JsonValue Jsonize() const; + + ///@{ + /** + *

The maximum time, in seconds, that records buffer in MSK before being flushed + * to the destination. Allowed range: 300 to 900.

+ */ + inline int GetDataFreshnessInSeconds() const { return m_dataFreshnessInSeconds; } + inline bool DataFreshnessInSecondsHasBeenSet() const { return m_dataFreshnessInSecondsHasBeenSet; } + inline void SetDataFreshnessInSeconds(int value) { + m_dataFreshnessInSecondsHasBeenSet = true; + m_dataFreshnessInSeconds = value; + } + inline S3DestinationUpdate& WithDataFreshnessInSeconds(int value) { + SetDataFreshnessInSeconds(value); + return *this; + } + ///@} + private: + int m_dataFreshnessInSeconds{0}; + bool m_dataFreshnessInSecondsHasBeenSet = false; +}; + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/S3Storage.h b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/S3Storage.h new file mode 100644 index 000000000000..d20faccba666 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/S3Storage.h @@ -0,0 +1,165 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include +#include + +#include + +namespace Aws { +namespace Utils { +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json +} // namespace Utils +namespace Kafka { +namespace Model { + +/** + *

Storage configuration for an Amazon S3 destination bucket.

See + * Also:

AWS API + * Reference

+ */ +class S3Storage { + public: + AWS_KAFKA_API S3Storage() = default; + AWS_KAFKA_API S3Storage(Aws::Utils::Json::JsonView jsonValue); + AWS_KAFKA_API S3Storage& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_KAFKA_API Aws::Utils::Json::JsonValue Jsonize() const; + + ///@{ + /** + *

The Amazon Resource Name (ARN) of the destination Amazon S3 bucket.

+ */ + inline const Aws::String& GetBucketArn() const { return m_bucketArn; } + inline bool BucketArnHasBeenSet() const { return m_bucketArnHasBeenSet; } + template + void SetBucketArn(BucketArnT&& value) { + m_bucketArnHasBeenSet = true; + m_bucketArn = std::forward(value); + } + template + S3Storage& WithBucketArn(BucketArnT&& value) { + SetBucketArn(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The compression codec applied to delivered Amazon S3 objects.

+ */ + inline S3CompressionType GetCompressionType() const { return m_compressionType; } + inline bool CompressionTypeHasBeenSet() const { return m_compressionTypeHasBeenSet; } + inline void SetCompressionType(S3CompressionType value) { + m_compressionTypeHasBeenSet = true; + m_compressionType = value; + } + inline S3Storage& WithCompressionType(S3CompressionType value) { + SetCompressionType(value); + return *this; + } + ///@} + + ///@{ + /** + *

An optional prefix prepended to every Amazon S3 object key written by the + * channel.

+ */ + inline const Aws::String& GetOutputPrefix() const { return m_outputPrefix; } + inline bool OutputPrefixHasBeenSet() const { return m_outputPrefixHasBeenSet; } + template + void SetOutputPrefix(OutputPrefixT&& value) { + m_outputPrefixHasBeenSet = true; + m_outputPrefix = std::forward(value); + } + template + S3Storage& WithOutputPrefix(OutputPrefixT&& value) { + SetOutputPrefix(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

An optional template that controls the Amazon S3 object key for each + * delivered record. Supports the placeholders !{partition-id}, !{sequence-number}, + * and !{kafka-offset}.

+ */ + inline const Aws::String& GetOutputKeyTemplate() const { return m_outputKeyTemplate; } + inline bool OutputKeyTemplateHasBeenSet() const { return m_outputKeyTemplateHasBeenSet; } + template + void SetOutputKeyTemplate(OutputKeyTemplateT&& value) { + m_outputKeyTemplateHasBeenSet = true; + m_outputKeyTemplate = std::forward(value); + } + template + S3Storage& WithOutputKeyTemplate(OutputKeyTemplateT&& value) { + SetOutputKeyTemplate(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The Amazon S3 storage class for delivered objects.

+ */ + inline S3StorageClass GetStorageClass() const { return m_storageClass; } + inline bool StorageClassHasBeenSet() const { return m_storageClassHasBeenSet; } + inline void SetStorageClass(S3StorageClass value) { + m_storageClassHasBeenSet = true; + m_storageClass = value; + } + inline S3Storage& WithStorageClass(S3StorageClass value) { + SetStorageClass(value); + return *this; + } + ///@} + + ///@{ + /** + *

Optional 12-digit AWS account ID expected to own the Amazon S3 bucket.

+ */ + inline const Aws::String& GetExpectedBucketOwner() const { return m_expectedBucketOwner; } + inline bool ExpectedBucketOwnerHasBeenSet() const { return m_expectedBucketOwnerHasBeenSet; } + template + void SetExpectedBucketOwner(ExpectedBucketOwnerT&& value) { + m_expectedBucketOwnerHasBeenSet = true; + m_expectedBucketOwner = std::forward(value); + } + template + S3Storage& WithExpectedBucketOwner(ExpectedBucketOwnerT&& value) { + SetExpectedBucketOwner(std::forward(value)); + return *this; + } + ///@} + private: + Aws::String m_bucketArn; + + S3CompressionType m_compressionType{S3CompressionType::NOT_SET}; + + Aws::String m_outputPrefix; + + Aws::String m_outputKeyTemplate; + + S3StorageClass m_storageClass{S3StorageClass::NOT_SET}; + + Aws::String m_expectedBucketOwner; + bool m_bucketArnHasBeenSet = false; + bool m_compressionTypeHasBeenSet = false; + bool m_outputPrefixHasBeenSet = false; + bool m_outputKeyTemplateHasBeenSet = false; + bool m_storageClassHasBeenSet = false; + bool m_expectedBucketOwnerHasBeenSet = false; +}; + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/S3StorageClass.h b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/S3StorageClass.h new file mode 100644 index 000000000000..ab1d55507500 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/S3StorageClass.h @@ -0,0 +1,22 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include + +namespace Aws { +namespace Kafka { +namespace Model { +enum class S3StorageClass { NOT_SET, STANDARD, INTELLIGENT_TIERING, GLACIER_IR }; + +namespace S3StorageClassMapper { +AWS_KAFKA_API S3StorageClass GetS3StorageClassForName(const Aws::String& name); + +AWS_KAFKA_API Aws::String GetNameForS3StorageClass(S3StorageClass value); +} // namespace S3StorageClassMapper +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/SchemaEvolution.h b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/SchemaEvolution.h new file mode 100644 index 000000000000..9fb86a461ce7 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/SchemaEvolution.h @@ -0,0 +1,55 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include + +namespace Aws { +namespace Utils { +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json +} // namespace Utils +namespace Kafka { +namespace Model { + +/** + *

Configuration controlling whether the Apache Iceberg destination table's + * schema is evolved as incoming records change.

See Also:

AWS + * API Reference

+ */ +class SchemaEvolution { + public: + AWS_KAFKA_API SchemaEvolution() = default; + AWS_KAFKA_API SchemaEvolution(Aws::Utils::Json::JsonView jsonValue); + AWS_KAFKA_API SchemaEvolution& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_KAFKA_API Aws::Utils::Json::JsonValue Jsonize() const; + + ///@{ + /** + *

Whether to allow MSK to evolve the destination table's schema. Must be false + * for the current release.

+ */ + inline bool GetEnableSchemaEvolution() const { return m_enableSchemaEvolution; } + inline bool EnableSchemaEvolutionHasBeenSet() const { return m_enableSchemaEvolutionHasBeenSet; } + inline void SetEnableSchemaEvolution(bool value) { + m_enableSchemaEvolutionHasBeenSet = true; + m_enableSchemaEvolution = value; + } + inline SchemaEvolution& WithEnableSchemaEvolution(bool value) { + SetEnableSchemaEvolution(value); + return *this; + } + ///@} + private: + bool m_enableSchemaEvolution{false}; + bool m_enableSchemaEvolutionHasBeenSet = false; +}; + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/TableCreation.h b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/TableCreation.h new file mode 100644 index 000000000000..5663be09beb1 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/TableCreation.h @@ -0,0 +1,55 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include + +namespace Aws { +namespace Utils { +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json +} // namespace Utils +namespace Kafka { +namespace Model { + +/** + *

Configuration controlling whether MSK creates the destination Apache Iceberg + * table if it does not already exist.

See Also:

AWS + * API Reference

+ */ +class TableCreation { + public: + AWS_KAFKA_API TableCreation() = default; + AWS_KAFKA_API TableCreation(Aws::Utils::Json::JsonView jsonValue); + AWS_KAFKA_API TableCreation& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_KAFKA_API Aws::Utils::Json::JsonValue Jsonize() const; + + ///@{ + /** + *

Whether MSK creates the destination table on the customer's behalf. Must be + * true for the current release.

+ */ + inline bool GetEnableTableCreation() const { return m_enableTableCreation; } + inline bool EnableTableCreationHasBeenSet() const { return m_enableTableCreationHasBeenSet; } + inline void SetEnableTableCreation(bool value) { + m_enableTableCreationHasBeenSet = true; + m_enableTableCreation = value; + } + inline TableCreation& WithEnableTableCreation(bool value) { + SetEnableTableCreation(value); + return *this; + } + ///@} + private: + bool m_enableTableCreation{false}; + bool m_enableTableCreationHasBeenSet = false; +}; + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/TopicConfiguration.h b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/TopicConfiguration.h new file mode 100644 index 000000000000..f8682fd0d2c5 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/TopicConfiguration.h @@ -0,0 +1,108 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include +#include + +#include + +namespace Aws { +namespace Utils { +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json +} // namespace Utils +namespace Kafka { +namespace Model { + +/** + *

Configuration of an Apache Kafka topic that feeds a channel.

See + * Also:

AWS + * API Reference

+ */ +class TopicConfiguration { + public: + AWS_KAFKA_API TopicConfiguration() = default; + AWS_KAFKA_API TopicConfiguration(Aws::Utils::Json::JsonView jsonValue); + AWS_KAFKA_API TopicConfiguration& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_KAFKA_API Aws::Utils::Json::JsonValue Jsonize() const; + + ///@{ + /** + *

Configuration that controls how Apache Kafka record values are deserialized + * for the destination.

+ */ + inline const RecordConverter& GetRecordConverter() const { return m_recordConverter; } + inline bool RecordConverterHasBeenSet() const { return m_recordConverterHasBeenSet; } + template + void SetRecordConverter(RecordConverterT&& value) { + m_recordConverterHasBeenSet = true; + m_recordConverter = std::forward(value); + } + template + TopicConfiguration& WithRecordConverter(RecordConverterT&& value) { + SetRecordConverter(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The schema used to validate records when the value converter requires one + * (for example, JSON_SCHEMA_GSR).

+ */ + inline const RecordSchema& GetRecordSchema() const { return m_recordSchema; } + inline bool RecordSchemaHasBeenSet() const { return m_recordSchemaHasBeenSet; } + template + void SetRecordSchema(RecordSchemaT&& value) { + m_recordSchemaHasBeenSet = true; + m_recordSchema = std::forward(value); + } + template + TopicConfiguration& WithRecordSchema(RecordSchemaT&& value) { + SetRecordSchema(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + * +

The Amazon Resource Name (ARN) that uniquely identifies the + * topic.

+ + */ + inline const Aws::String& GetTopicArn() const { return m_topicArn; } + inline bool TopicArnHasBeenSet() const { return m_topicArnHasBeenSet; } + template + void SetTopicArn(TopicArnT&& value) { + m_topicArnHasBeenSet = true; + m_topicArn = std::forward(value); + } + template + TopicConfiguration& WithTopicArn(TopicArnT&& value) { + SetTopicArn(std::forward(value)); + return *this; + } + ///@} + private: + RecordConverter m_recordConverter; + + RecordSchema m_recordSchema; + + Aws::String m_topicArn; + bool m_recordConverterHasBeenSet = false; + bool m_recordSchemaHasBeenSet = false; + bool m_topicArnHasBeenSet = false; +}; + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/UpdateChannelRequest.h b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/UpdateChannelRequest.h new file mode 100644 index 000000000000..754bb3e03975 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/UpdateChannelRequest.h @@ -0,0 +1,127 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include +#include +#include + +#include + +namespace Aws { +namespace Kafka { +namespace Model { + +/** + *

Updates an existing channel's destination configuration. You must update the + * same destination type the channel was created with; the destination type cannot + * be changed.

See Also:

AWS + * API Reference

+ */ +class UpdateChannelRequest : public KafkaRequest { + public: + AWS_KAFKA_API UpdateChannelRequest() = default; + + // Service request name is the Operation name which will send this request out, + // each operation should has unique request name, so that we can get operation's name from this request. + // Note: this is not true for response, multiple operations may have the same response name, + // so we can not get operation's name from response. + inline virtual const char* GetServiceRequestName() const override { return "UpdateChannel"; } + + AWS_KAFKA_API Aws::String SerializePayload() const override; + + ///@{ + /** + *

The Amazon Resource Name (ARN) that uniquely identifies the channel.

+ */ + inline const Aws::String& GetChannelArn() const { return m_channelArn; } + inline bool ChannelArnHasBeenSet() const { return m_channelArnHasBeenSet; } + template + void SetChannelArn(ChannelArnT&& value) { + m_channelArnHasBeenSet = true; + m_channelArn = std::forward(value); + } + template + UpdateChannelRequest& WithChannelArn(ChannelArnT&& value) { + SetChannelArn(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

+ */ + inline const Aws::String& GetClusterArn() const { return m_clusterArn; } + inline bool ClusterArnHasBeenSet() const { return m_clusterArnHasBeenSet; } + template + void SetClusterArn(ClusterArnT&& value) { + m_clusterArnHasBeenSet = true; + m_clusterArn = std::forward(value); + } + template + UpdateChannelRequest& WithClusterArn(ClusterArnT&& value) { + SetClusterArn(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

Updates fields on an Apache Iceberg destination. Use only when the channel + * was created with an Iceberg destination.

+ */ + inline const IcebergDestinationUpdate& GetIcebergDestinationUpdate() const { return m_icebergDestinationUpdate; } + inline bool IcebergDestinationUpdateHasBeenSet() const { return m_icebergDestinationUpdateHasBeenSet; } + template + void SetIcebergDestinationUpdate(IcebergDestinationUpdateT&& value) { + m_icebergDestinationUpdateHasBeenSet = true; + m_icebergDestinationUpdate = std::forward(value); + } + template + UpdateChannelRequest& WithIcebergDestinationUpdate(IcebergDestinationUpdateT&& value) { + SetIcebergDestinationUpdate(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

Updates fields on an Amazon S3 destination. Use only when the channel was + * created with an Amazon S3 destination.

+ */ + inline const S3DestinationUpdate& GetS3DestinationUpdate() const { return m_s3DestinationUpdate; } + inline bool S3DestinationUpdateHasBeenSet() const { return m_s3DestinationUpdateHasBeenSet; } + template + void SetS3DestinationUpdate(S3DestinationUpdateT&& value) { + m_s3DestinationUpdateHasBeenSet = true; + m_s3DestinationUpdate = std::forward(value); + } + template + UpdateChannelRequest& WithS3DestinationUpdate(S3DestinationUpdateT&& value) { + SetS3DestinationUpdate(std::forward(value)); + return *this; + } + ///@} + private: + Aws::String m_channelArn; + + Aws::String m_clusterArn; + + IcebergDestinationUpdate m_icebergDestinationUpdate; + + S3DestinationUpdate m_s3DestinationUpdate; + bool m_channelArnHasBeenSet = false; + bool m_clusterArnHasBeenSet = false; + bool m_icebergDestinationUpdateHasBeenSet = false; + bool m_s3DestinationUpdateHasBeenSet = false; +}; + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/UpdateChannelResult.h b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/UpdateChannelResult.h new file mode 100644 index 000000000000..6882f1f0e323 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/UpdateChannelResult.h @@ -0,0 +1,103 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include + +#include + +namespace Aws { +template +class AmazonWebServiceResult; + +namespace Utils { +namespace Json { +class JsonValue; +} // namespace Json +} // namespace Utils +namespace Kafka { +namespace Model { +/** + *

Returns the channel ARN and the cluster-operation ARN that tracks the + * asynchronous update.

See Also:

AWS + * API Reference

+ */ +class UpdateChannelResult { + public: + AWS_KAFKA_API UpdateChannelResult() = default; + AWS_KAFKA_API UpdateChannelResult(const Aws::AmazonWebServiceResult& result); + AWS_KAFKA_API UpdateChannelResult& operator=(const Aws::AmazonWebServiceResult& result); + + ///@{ + /** + *

The Amazon Resource Name (ARN) that uniquely identifies the channel.

+ */ + inline const Aws::String& GetChannelArn() const { return m_channelArn; } + template + void SetChannelArn(ChannelArnT&& value) { + m_channelArnHasBeenSet = true; + m_channelArn = std::forward(value); + } + template + UpdateChannelResult& WithChannelArn(ChannelArnT&& value) { + SetChannelArn(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + * +

The Amazon Resource Name (ARN) of the cluster operation.

+ + * + */ + inline const Aws::String& GetClusterOperationArn() const { return m_clusterOperationArn; } + template + void SetClusterOperationArn(ClusterOperationArnT&& value) { + m_clusterOperationArnHasBeenSet = true; + m_clusterOperationArn = std::forward(value); + } + template + UpdateChannelResult& WithClusterOperationArn(ClusterOperationArnT&& value) { + SetClusterOperationArn(std::forward(value)); + return *this; + } + ///@} + + ///@{ + + inline const Aws::String& GetRequestId() const { return m_requestId; } + template + void SetRequestId(RequestIdT&& value) { + m_requestIdHasBeenSet = true; + m_requestId = std::forward(value); + } + template + UpdateChannelResult& WithRequestId(RequestIdT&& value) { + SetRequestId(std::forward(value)); + return *this; + } + ///@} + inline Aws::Http::HttpResponseCode GetHttpResponseCode() const { return m_HttpResponseCode; } + + private: + Aws::String m_channelArn; + + Aws::String m_clusterOperationArn; + + Aws::String m_requestId; + Aws::Http::HttpResponseCode m_HttpResponseCode; + bool m_channelArnHasBeenSet = false; + bool m_clusterOperationArnHasBeenSet = false; + bool m_requestIdHasBeenSet = false; +}; + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/ValueConverter.h b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/ValueConverter.h new file mode 100644 index 000000000000..f81027df2839 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/include/aws/kafka/model/ValueConverter.h @@ -0,0 +1,22 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include + +namespace Aws { +namespace Kafka { +namespace Model { +enum class ValueConverter { NOT_SET, BYTE_ARRAY, JSON, JSON_SCHEMA_GSR, STRING }; + +namespace ValueConverterMapper { +AWS_KAFKA_API ValueConverter GetValueConverterForName(const Aws::String& name); + +AWS_KAFKA_API Aws::String GetNameForValueConverter(ValueConverter value); +} // namespace ValueConverterMapper +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/source/KafkaClient.cpp b/generated/src/aws-cpp-sdk-kafka/source/KafkaClient.cpp index 7664461f0c10..342b57cbf178 100644 --- a/generated/src/aws-cpp-sdk-kafka/source/KafkaClient.cpp +++ b/generated/src/aws-cpp-sdk-kafka/source/KafkaClient.cpp @@ -22,18 +22,21 @@ #include #include #include +#include #include #include #include #include #include #include +#include #include #include #include #include #include #include +#include #include #include #include @@ -47,6 +50,7 @@ #include #include #include +#include #include #include #include @@ -69,6 +73,7 @@ #include #include #include +#include #include #include #include @@ -271,6 +276,24 @@ BatchDisassociateScramSecretOutcome KafkaClient::BatchDisassociateScramSecret(co : BatchDisassociateScramSecretOutcome(std::move(result.GetError())); } +CreateChannelOutcome KafkaClient::CreateChannel(const CreateChannelRequest& request) const { + if (!request.ClusterArnHasBeenSet()) { + AWS_LOGSTREAM_ERROR("CreateChannel", "Required field: ClusterArn, is not set"); + return CreateChannelOutcome(Aws::Client::AWSError(KafkaErrors::MISSING_PARAMETER, "MISSING_PARAMETER", + "Missing required field [ClusterArn]", false)); + } + + auto uriResolver = [&](Aws::Endpoint::ResolveEndpointOutcome& endpointResolutionOutcome) { + (void)endpointResolutionOutcome; + endpointResolutionOutcome.GetResult().AddPathSegments("/v1/clusters/"); + endpointResolutionOutcome.GetResult().AddPathSegment(request.GetClusterArn()); + endpointResolutionOutcome.GetResult().AddPathSegments("/channels"); + }; + + auto result = InvokeServiceOperation(request, uriResolver, Aws::Http::HttpMethod::HTTP_POST); + return result.IsSuccess() ? CreateChannelOutcome(result.GetResultWithOwnership()) : CreateChannelOutcome(std::move(result.GetError())); +} + CreateClusterOutcome KafkaClient::CreateCluster(const CreateClusterRequest& request) const { auto uriResolver = [&](Aws::Endpoint::ResolveEndpointOutcome& endpointResolutionOutcome) { (void)endpointResolutionOutcome; @@ -343,6 +366,30 @@ CreateVpcConnectionOutcome KafkaClient::CreateVpcConnection(const CreateVpcConne : CreateVpcConnectionOutcome(std::move(result.GetError())); } +DeleteChannelOutcome KafkaClient::DeleteChannel(const DeleteChannelRequest& request) const { + if (!request.ChannelArnHasBeenSet()) { + AWS_LOGSTREAM_ERROR("DeleteChannel", "Required field: ChannelArn, is not set"); + return DeleteChannelOutcome(Aws::Client::AWSError(KafkaErrors::MISSING_PARAMETER, "MISSING_PARAMETER", + "Missing required field [ChannelArn]", false)); + } + if (!request.ClusterArnHasBeenSet()) { + AWS_LOGSTREAM_ERROR("DeleteChannel", "Required field: ClusterArn, is not set"); + return DeleteChannelOutcome(Aws::Client::AWSError(KafkaErrors::MISSING_PARAMETER, "MISSING_PARAMETER", + "Missing required field [ClusterArn]", false)); + } + + auto uriResolver = [&](Aws::Endpoint::ResolveEndpointOutcome& endpointResolutionOutcome) { + (void)endpointResolutionOutcome; + endpointResolutionOutcome.GetResult().AddPathSegments("/v1/clusters/"); + endpointResolutionOutcome.GetResult().AddPathSegment(request.GetClusterArn()); + endpointResolutionOutcome.GetResult().AddPathSegments("/channels/"); + endpointResolutionOutcome.GetResult().AddPathSegment(request.GetChannelArn()); + }; + + auto result = InvokeServiceOperation(request, uriResolver, Aws::Http::HttpMethod::HTTP_DELETE); + return result.IsSuccess() ? DeleteChannelOutcome(result.GetResultWithOwnership()) : DeleteChannelOutcome(std::move(result.GetError())); +} + DeleteClusterOutcome KafkaClient::DeleteCluster(const DeleteClusterRequest& request) const { if (!request.ClusterArnHasBeenSet()) { AWS_LOGSTREAM_ERROR("DeleteCluster", "Required field: ClusterArn, is not set"); @@ -457,6 +504,31 @@ DeleteVpcConnectionOutcome KafkaClient::DeleteVpcConnection(const DeleteVpcConne : DeleteVpcConnectionOutcome(std::move(result.GetError())); } +DescribeChannelOutcome KafkaClient::DescribeChannel(const DescribeChannelRequest& request) const { + if (!request.ChannelArnHasBeenSet()) { + AWS_LOGSTREAM_ERROR("DescribeChannel", "Required field: ChannelArn, is not set"); + return DescribeChannelOutcome(Aws::Client::AWSError(KafkaErrors::MISSING_PARAMETER, "MISSING_PARAMETER", + "Missing required field [ChannelArn]", false)); + } + if (!request.ClusterArnHasBeenSet()) { + AWS_LOGSTREAM_ERROR("DescribeChannel", "Required field: ClusterArn, is not set"); + return DescribeChannelOutcome(Aws::Client::AWSError(KafkaErrors::MISSING_PARAMETER, "MISSING_PARAMETER", + "Missing required field [ClusterArn]", false)); + } + + auto uriResolver = [&](Aws::Endpoint::ResolveEndpointOutcome& endpointResolutionOutcome) { + (void)endpointResolutionOutcome; + endpointResolutionOutcome.GetResult().AddPathSegments("/v1/clusters/"); + endpointResolutionOutcome.GetResult().AddPathSegment(request.GetClusterArn()); + endpointResolutionOutcome.GetResult().AddPathSegments("/channels/"); + endpointResolutionOutcome.GetResult().AddPathSegment(request.GetChannelArn()); + }; + + auto result = InvokeServiceOperation(request, uriResolver, Aws::Http::HttpMethod::HTTP_GET); + return result.IsSuccess() ? DescribeChannelOutcome(result.GetResultWithOwnership()) + : DescribeChannelOutcome(std::move(result.GetError())); +} + DescribeClusterOutcome KafkaClient::DescribeCluster(const DescribeClusterRequest& request) const { if (!request.ClusterArnHasBeenSet()) { AWS_LOGSTREAM_ERROR("DescribeCluster", "Required field: ClusterArn, is not set"); @@ -707,6 +779,24 @@ GetCompatibleKafkaVersionsOutcome KafkaClient::GetCompatibleKafkaVersions(const : GetCompatibleKafkaVersionsOutcome(std::move(result.GetError())); } +ListChannelsOutcome KafkaClient::ListChannels(const ListChannelsRequest& request) const { + if (!request.ClusterArnHasBeenSet()) { + AWS_LOGSTREAM_ERROR("ListChannels", "Required field: ClusterArn, is not set"); + return ListChannelsOutcome(Aws::Client::AWSError(KafkaErrors::MISSING_PARAMETER, "MISSING_PARAMETER", + "Missing required field [ClusterArn]", false)); + } + + auto uriResolver = [&](Aws::Endpoint::ResolveEndpointOutcome& endpointResolutionOutcome) { + (void)endpointResolutionOutcome; + endpointResolutionOutcome.GetResult().AddPathSegments("/v1/clusters/"); + endpointResolutionOutcome.GetResult().AddPathSegment(request.GetClusterArn()); + endpointResolutionOutcome.GetResult().AddPathSegments("/channels"); + }; + + auto result = InvokeServiceOperation(request, uriResolver, Aws::Http::HttpMethod::HTTP_GET); + return result.IsSuccess() ? ListChannelsOutcome(result.GetResultWithOwnership()) : ListChannelsOutcome(std::move(result.GetError())); +} + ListClientVpcConnectionsOutcome KafkaClient::ListClientVpcConnections(const ListClientVpcConnectionsRequest& request) const { if (!request.ClusterArnHasBeenSet()) { AWS_LOGSTREAM_ERROR("ListClientVpcConnections", "Required field: ClusterArn, is not set"); @@ -1072,6 +1162,30 @@ UpdateBrokerTypeOutcome KafkaClient::UpdateBrokerType(const UpdateBrokerTypeRequ : UpdateBrokerTypeOutcome(std::move(result.GetError())); } +UpdateChannelOutcome KafkaClient::UpdateChannel(const UpdateChannelRequest& request) const { + if (!request.ChannelArnHasBeenSet()) { + AWS_LOGSTREAM_ERROR("UpdateChannel", "Required field: ChannelArn, is not set"); + return UpdateChannelOutcome(Aws::Client::AWSError(KafkaErrors::MISSING_PARAMETER, "MISSING_PARAMETER", + "Missing required field [ChannelArn]", false)); + } + if (!request.ClusterArnHasBeenSet()) { + AWS_LOGSTREAM_ERROR("UpdateChannel", "Required field: ClusterArn, is not set"); + return UpdateChannelOutcome(Aws::Client::AWSError(KafkaErrors::MISSING_PARAMETER, "MISSING_PARAMETER", + "Missing required field [ClusterArn]", false)); + } + + auto uriResolver = [&](Aws::Endpoint::ResolveEndpointOutcome& endpointResolutionOutcome) { + (void)endpointResolutionOutcome; + endpointResolutionOutcome.GetResult().AddPathSegments("/v1/clusters/"); + endpointResolutionOutcome.GetResult().AddPathSegment(request.GetClusterArn()); + endpointResolutionOutcome.GetResult().AddPathSegments("/channels/"); + endpointResolutionOutcome.GetResult().AddPathSegment(request.GetChannelArn()); + }; + + auto result = InvokeServiceOperation(request, uriResolver, Aws::Http::HttpMethod::HTTP_PUT); + return result.IsSuccess() ? UpdateChannelOutcome(result.GetResultWithOwnership()) : UpdateChannelOutcome(std::move(result.GetError())); +} + UpdateClusterConfigurationOutcome KafkaClient::UpdateClusterConfiguration(const UpdateClusterConfigurationRequest& request) const { if (!request.ClusterArnHasBeenSet()) { AWS_LOGSTREAM_ERROR("UpdateClusterConfiguration", "Required field: ClusterArn, is not set"); diff --git a/generated/src/aws-cpp-sdk-kafka/source/model/Catalog.cpp b/generated/src/aws-cpp-sdk-kafka/source/model/Catalog.cpp new file mode 100644 index 000000000000..febcb0c1bf54 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/source/model/Catalog.cpp @@ -0,0 +1,48 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include + +#include + +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +namespace Aws { +namespace Kafka { +namespace Model { + +Catalog::Catalog(JsonView jsonValue) { *this = jsonValue; } + +Catalog& Catalog::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("catalogArn")) { + m_catalogArn = jsonValue.GetString("catalogArn"); + m_catalogArnHasBeenSet = true; + } + if (jsonValue.ValueExists("warehouseLocation")) { + m_warehouseLocation = jsonValue.GetString("warehouseLocation"); + m_warehouseLocationHasBeenSet = true; + } + return *this; +} + +JsonValue Catalog::Jsonize() const { + JsonValue payload; + + if (m_catalogArnHasBeenSet) { + payload.WithString("catalogArn", m_catalogArn); + } + + if (m_warehouseLocationHasBeenSet) { + payload.WithString("warehouseLocation", m_warehouseLocation); + } + + return payload; +} + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/source/model/ChannelDestinationType.cpp b/generated/src/aws-cpp-sdk-kafka/source/model/ChannelDestinationType.cpp new file mode 100644 index 000000000000..94fdaab7765a --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/source/model/ChannelDestinationType.cpp @@ -0,0 +1,58 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include +#include +#include + +using namespace Aws::Utils; + +namespace Aws { +namespace Kafka { +namespace Model { +namespace ChannelDestinationTypeMapper { + +static const int ICEBERG_HASH = HashingUtils::HashString("ICEBERG"); +static const int S3_HASH = HashingUtils::HashString("S3"); + +ChannelDestinationType GetChannelDestinationTypeForName(const Aws::String& name) { + int hashCode = HashingUtils::HashString(name.c_str()); + if (hashCode == ICEBERG_HASH) { + return ChannelDestinationType::ICEBERG; + } else if (hashCode == S3_HASH) { + return ChannelDestinationType::S3; + } + EnumParseOverflowContainer* overflowContainer = Aws::GetEnumOverflowContainer(); + if (overflowContainer) { + overflowContainer->StoreOverflow(hashCode, name); + return static_cast(hashCode); + } + + return ChannelDestinationType::NOT_SET; +} + +Aws::String GetNameForChannelDestinationType(ChannelDestinationType enumValue) { + switch (enumValue) { + case ChannelDestinationType::NOT_SET: + return {}; + case ChannelDestinationType::ICEBERG: + return "ICEBERG"; + case ChannelDestinationType::S3: + return "S3"; + default: + EnumParseOverflowContainer* overflowContainer = Aws::GetEnumOverflowContainer(); + if (overflowContainer) { + return overflowContainer->RetrieveOverflow(static_cast(enumValue)); + } + + return {}; + } +} + +} // namespace ChannelDestinationTypeMapper +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/source/model/ChannelInfo.cpp b/generated/src/aws-cpp-sdk-kafka/source/model/ChannelInfo.cpp new file mode 100644 index 000000000000..b3a0b9c2dd30 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/source/model/ChannelInfo.cpp @@ -0,0 +1,80 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include + +#include + +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +namespace Aws { +namespace Kafka { +namespace Model { + +ChannelInfo::ChannelInfo(JsonView jsonValue) { *this = jsonValue; } + +ChannelInfo& ChannelInfo::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("channelArn")) { + m_channelArn = jsonValue.GetString("channelArn"); + m_channelArnHasBeenSet = true; + } + if (jsonValue.ValueExists("channelName")) { + m_channelName = jsonValue.GetString("channelName"); + m_channelNameHasBeenSet = true; + } + if (jsonValue.ValueExists("status")) { + m_status = ChannelStatusMapper::GetChannelStatusForName(jsonValue.GetString("status")); + m_statusHasBeenSet = true; + } + if (jsonValue.ValueExists("creationTime")) { + m_creationTime = jsonValue.GetString("creationTime"); + m_creationTimeHasBeenSet = true; + } + if (jsonValue.ValueExists("destinationType")) { + m_destinationType = ChannelDestinationTypeMapper::GetChannelDestinationTypeForName(jsonValue.GetString("destinationType")); + m_destinationTypeHasBeenSet = true; + } + if (jsonValue.ValueExists("clusterOperationArn")) { + m_clusterOperationArn = jsonValue.GetString("clusterOperationArn"); + m_clusterOperationArnHasBeenSet = true; + } + return *this; +} + +JsonValue ChannelInfo::Jsonize() const { + JsonValue payload; + + if (m_channelArnHasBeenSet) { + payload.WithString("channelArn", m_channelArn); + } + + if (m_channelNameHasBeenSet) { + payload.WithString("channelName", m_channelName); + } + + if (m_statusHasBeenSet) { + payload.WithString("status", ChannelStatusMapper::GetNameForChannelStatus(m_status)); + } + + if (m_creationTimeHasBeenSet) { + payload.WithString("creationTime", m_creationTime.ToGmtString(Aws::Utils::DateFormat::ISO_8601)); + } + + if (m_destinationTypeHasBeenSet) { + payload.WithString("destinationType", ChannelDestinationTypeMapper::GetNameForChannelDestinationType(m_destinationType)); + } + + if (m_clusterOperationArnHasBeenSet) { + payload.WithString("clusterOperationArn", m_clusterOperationArn); + } + + return payload; +} + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/source/model/ChannelLoggingInfo.cpp b/generated/src/aws-cpp-sdk-kafka/source/model/ChannelLoggingInfo.cpp new file mode 100644 index 000000000000..76398a3d63e9 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/source/model/ChannelLoggingInfo.cpp @@ -0,0 +1,56 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include + +#include + +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +namespace Aws { +namespace Kafka { +namespace Model { + +ChannelLoggingInfo::ChannelLoggingInfo(JsonView jsonValue) { *this = jsonValue; } + +ChannelLoggingInfo& ChannelLoggingInfo::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("cloudWatchLogs")) { + m_cloudWatchLogs = jsonValue.GetObject("cloudWatchLogs"); + m_cloudWatchLogsHasBeenSet = true; + } + if (jsonValue.ValueExists("firehose")) { + m_firehose = jsonValue.GetObject("firehose"); + m_firehoseHasBeenSet = true; + } + if (jsonValue.ValueExists("s3")) { + m_s3 = jsonValue.GetObject("s3"); + m_s3HasBeenSet = true; + } + return *this; +} + +JsonValue ChannelLoggingInfo::Jsonize() const { + JsonValue payload; + + if (m_cloudWatchLogsHasBeenSet) { + payload.WithObject("cloudWatchLogs", m_cloudWatchLogs.Jsonize()); + } + + if (m_firehoseHasBeenSet) { + payload.WithObject("firehose", m_firehose.Jsonize()); + } + + if (m_s3HasBeenSet) { + payload.WithObject("s3", m_s3.Jsonize()); + } + + return payload; +} + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/source/model/ChannelStateInfo.cpp b/generated/src/aws-cpp-sdk-kafka/source/model/ChannelStateInfo.cpp new file mode 100644 index 000000000000..3a741b9f6ae6 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/source/model/ChannelStateInfo.cpp @@ -0,0 +1,48 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include + +#include + +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +namespace Aws { +namespace Kafka { +namespace Model { + +ChannelStateInfo::ChannelStateInfo(JsonView jsonValue) { *this = jsonValue; } + +ChannelStateInfo& ChannelStateInfo::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("code")) { + m_code = jsonValue.GetString("code"); + m_codeHasBeenSet = true; + } + if (jsonValue.ValueExists("message")) { + m_message = jsonValue.GetString("message"); + m_messageHasBeenSet = true; + } + return *this; +} + +JsonValue ChannelStateInfo::Jsonize() const { + JsonValue payload; + + if (m_codeHasBeenSet) { + payload.WithString("code", m_code); + } + + if (m_messageHasBeenSet) { + payload.WithString("message", m_message); + } + + return payload; +} + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/source/model/ChannelStatus.cpp b/generated/src/aws-cpp-sdk-kafka/source/model/ChannelStatus.cpp new file mode 100644 index 000000000000..20f5c5f8ce5f --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/source/model/ChannelStatus.cpp @@ -0,0 +1,83 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include +#include +#include + +using namespace Aws::Utils; + +namespace Aws { +namespace Kafka { +namespace Model { +namespace ChannelStatusMapper { + +static const int CREATING_HASH = HashingUtils::HashString("CREATING"); +static const int ACTIVE_HASH = HashingUtils::HashString("ACTIVE"); +static const int UPDATING_HASH = HashingUtils::HashString("UPDATING"); +static const int DELETING_HASH = HashingUtils::HashString("DELETING"); +static const int FAILED_HASH = HashingUtils::HashString("FAILED"); +static const int SUSPENDING_HASH = HashingUtils::HashString("SUSPENDING"); +static const int SUSPENDED_HASH = HashingUtils::HashString("SUSPENDED"); + +ChannelStatus GetChannelStatusForName(const Aws::String& name) { + int hashCode = HashingUtils::HashString(name.c_str()); + if (hashCode == CREATING_HASH) { + return ChannelStatus::CREATING; + } else if (hashCode == ACTIVE_HASH) { + return ChannelStatus::ACTIVE; + } else if (hashCode == UPDATING_HASH) { + return ChannelStatus::UPDATING; + } else if (hashCode == DELETING_HASH) { + return ChannelStatus::DELETING; + } else if (hashCode == FAILED_HASH) { + return ChannelStatus::FAILED; + } else if (hashCode == SUSPENDING_HASH) { + return ChannelStatus::SUSPENDING; + } else if (hashCode == SUSPENDED_HASH) { + return ChannelStatus::SUSPENDED; + } + EnumParseOverflowContainer* overflowContainer = Aws::GetEnumOverflowContainer(); + if (overflowContainer) { + overflowContainer->StoreOverflow(hashCode, name); + return static_cast(hashCode); + } + + return ChannelStatus::NOT_SET; +} + +Aws::String GetNameForChannelStatus(ChannelStatus enumValue) { + switch (enumValue) { + case ChannelStatus::NOT_SET: + return {}; + case ChannelStatus::CREATING: + return "CREATING"; + case ChannelStatus::ACTIVE: + return "ACTIVE"; + case ChannelStatus::UPDATING: + return "UPDATING"; + case ChannelStatus::DELETING: + return "DELETING"; + case ChannelStatus::FAILED: + return "FAILED"; + case ChannelStatus::SUSPENDING: + return "SUSPENDING"; + case ChannelStatus::SUSPENDED: + return "SUSPENDED"; + default: + EnumParseOverflowContainer* overflowContainer = Aws::GetEnumOverflowContainer(); + if (overflowContainer) { + return overflowContainer->RetrieveOverflow(static_cast(enumValue)); + } + + return {}; + } +} + +} // namespace ChannelStatusMapper +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/source/model/CreateChannelRequest.cpp b/generated/src/aws-cpp-sdk-kafka/source/model/CreateChannelRequest.cpp new file mode 100644 index 000000000000..3c82b017e11f --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/source/model/CreateChannelRequest.cpp @@ -0,0 +1,56 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include + +#include + +using namespace Aws::Kafka::Model; +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +Aws::String CreateChannelRequest::SerializePayload() const { + JsonValue payload; + + if (m_channelNameHasBeenSet) { + payload.WithString("channelName", m_channelName); + } + + if (m_encryptionConfigurationHasBeenSet) { + payload.WithObject("encryptionConfiguration", m_encryptionConfiguration.Jsonize()); + } + + if (m_icebergDestinationConfigurationHasBeenSet) { + payload.WithObject("icebergDestinationConfiguration", m_icebergDestinationConfiguration.Jsonize()); + } + + if (m_s3DestinationConfigurationHasBeenSet) { + payload.WithObject("s3DestinationConfiguration", m_s3DestinationConfiguration.Jsonize()); + } + + if (m_tagsHasBeenSet) { + JsonValue tagsJsonMap; + for (auto& tagsItem : m_tags) { + tagsJsonMap.WithString(tagsItem.first, tagsItem.second); + } + payload.WithObject("tags", std::move(tagsJsonMap)); + } + + if (m_topicConfigurationListHasBeenSet) { + Aws::Utils::Array topicConfigurationListJsonList(m_topicConfigurationList.size()); + for (unsigned topicConfigurationListIndex = 0; topicConfigurationListIndex < topicConfigurationListJsonList.GetLength(); + ++topicConfigurationListIndex) { + topicConfigurationListJsonList[topicConfigurationListIndex].AsObject(m_topicConfigurationList[topicConfigurationListIndex].Jsonize()); + } + payload.WithArray("topicConfigurationList", std::move(topicConfigurationListJsonList)); + } + + if (m_loggingInfoHasBeenSet) { + payload.WithObject("loggingInfo", m_loggingInfo.Jsonize()); + } + + return payload.View().WriteReadable(); +} diff --git a/generated/src/aws-cpp-sdk-kafka/source/model/CreateChannelResult.cpp b/generated/src/aws-cpp-sdk-kafka/source/model/CreateChannelResult.cpp new file mode 100644 index 000000000000..aa09bd0cd65a --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/source/model/CreateChannelResult.cpp @@ -0,0 +1,42 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include +#include +#include +#include +#include + +#include + +using namespace Aws::Kafka::Model; +using namespace Aws::Utils::Json; +using namespace Aws::Utils; +using namespace Aws; + +CreateChannelResult::CreateChannelResult(const Aws::AmazonWebServiceResult& result) { *this = result; } + +CreateChannelResult& CreateChannelResult::operator=(const Aws::AmazonWebServiceResult& result) { + m_HttpResponseCode = result.GetResponseCode(); + JsonView jsonValue = result.GetPayload().View(); + if (jsonValue.ValueExists("channelArn")) { + m_channelArn = jsonValue.GetString("channelArn"); + m_channelArnHasBeenSet = true; + } + if (jsonValue.ValueExists("clusterOperationArn")) { + m_clusterOperationArn = jsonValue.GetString("clusterOperationArn"); + m_clusterOperationArnHasBeenSet = true; + } + + const auto& headers = result.GetHeaderValueCollection(); + const auto& requestIdIter = headers.find("x-amzn-requestid"); + if (requestIdIter != headers.end()) { + m_requestId = requestIdIter->second; + m_requestIdHasBeenSet = true; + } + + return *this; +} diff --git a/generated/src/aws-cpp-sdk-kafka/source/model/DeadLetterQueueS3.cpp b/generated/src/aws-cpp-sdk-kafka/source/model/DeadLetterQueueS3.cpp new file mode 100644 index 000000000000..09268de1b650 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/source/model/DeadLetterQueueS3.cpp @@ -0,0 +1,56 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include + +#include + +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +namespace Aws { +namespace Kafka { +namespace Model { + +DeadLetterQueueS3::DeadLetterQueueS3(JsonView jsonValue) { *this = jsonValue; } + +DeadLetterQueueS3& DeadLetterQueueS3::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("bucketArn")) { + m_bucketArn = jsonValue.GetString("bucketArn"); + m_bucketArnHasBeenSet = true; + } + if (jsonValue.ValueExists("errorOutputPrefix")) { + m_errorOutputPrefix = jsonValue.GetString("errorOutputPrefix"); + m_errorOutputPrefixHasBeenSet = true; + } + if (jsonValue.ValueExists("expectedBucketOwner")) { + m_expectedBucketOwner = jsonValue.GetString("expectedBucketOwner"); + m_expectedBucketOwnerHasBeenSet = true; + } + return *this; +} + +JsonValue DeadLetterQueueS3::Jsonize() const { + JsonValue payload; + + if (m_bucketArnHasBeenSet) { + payload.WithString("bucketArn", m_bucketArn); + } + + if (m_errorOutputPrefixHasBeenSet) { + payload.WithString("errorOutputPrefix", m_errorOutputPrefix); + } + + if (m_expectedBucketOwnerHasBeenSet) { + payload.WithString("expectedBucketOwner", m_expectedBucketOwner); + } + + return payload; +} + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/source/model/DeleteChannelRequest.cpp b/generated/src/aws-cpp-sdk-kafka/source/model/DeleteChannelRequest.cpp new file mode 100644 index 000000000000..074f0df4ff0c --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/source/model/DeleteChannelRequest.cpp @@ -0,0 +1,15 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include + +#include + +using namespace Aws::Kafka::Model; +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +Aws::String DeleteChannelRequest::SerializePayload() const { return {}; } diff --git a/generated/src/aws-cpp-sdk-kafka/source/model/DeleteChannelResult.cpp b/generated/src/aws-cpp-sdk-kafka/source/model/DeleteChannelResult.cpp new file mode 100644 index 000000000000..8808c64dd425 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/source/model/DeleteChannelResult.cpp @@ -0,0 +1,42 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include +#include +#include +#include +#include + +#include + +using namespace Aws::Kafka::Model; +using namespace Aws::Utils::Json; +using namespace Aws::Utils; +using namespace Aws; + +DeleteChannelResult::DeleteChannelResult(const Aws::AmazonWebServiceResult& result) { *this = result; } + +DeleteChannelResult& DeleteChannelResult::operator=(const Aws::AmazonWebServiceResult& result) { + m_HttpResponseCode = result.GetResponseCode(); + JsonView jsonValue = result.GetPayload().View(); + if (jsonValue.ValueExists("channelArn")) { + m_channelArn = jsonValue.GetString("channelArn"); + m_channelArnHasBeenSet = true; + } + if (jsonValue.ValueExists("clusterOperationArn")) { + m_clusterOperationArn = jsonValue.GetString("clusterOperationArn"); + m_clusterOperationArnHasBeenSet = true; + } + + const auto& headers = result.GetHeaderValueCollection(); + const auto& requestIdIter = headers.find("x-amzn-requestid"); + if (requestIdIter != headers.end()) { + m_requestId = requestIdIter->second; + m_requestIdHasBeenSet = true; + } + + return *this; +} diff --git a/generated/src/aws-cpp-sdk-kafka/source/model/DescribeChannelRequest.cpp b/generated/src/aws-cpp-sdk-kafka/source/model/DescribeChannelRequest.cpp new file mode 100644 index 000000000000..4d63bea08c1f --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/source/model/DescribeChannelRequest.cpp @@ -0,0 +1,15 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include + +#include + +using namespace Aws::Kafka::Model; +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +Aws::String DescribeChannelRequest::SerializePayload() const { return {}; } diff --git a/generated/src/aws-cpp-sdk-kafka/source/model/DescribeChannelResult.cpp b/generated/src/aws-cpp-sdk-kafka/source/model/DescribeChannelResult.cpp new file mode 100644 index 000000000000..cca861d252cf --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/source/model/DescribeChannelResult.cpp @@ -0,0 +1,93 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include +#include +#include +#include +#include + +#include + +using namespace Aws::Kafka::Model; +using namespace Aws::Utils::Json; +using namespace Aws::Utils; +using namespace Aws; + +DescribeChannelResult::DescribeChannelResult(const Aws::AmazonWebServiceResult& result) { *this = result; } + +DescribeChannelResult& DescribeChannelResult::operator=(const Aws::AmazonWebServiceResult& result) { + m_HttpResponseCode = result.GetResponseCode(); + JsonView jsonValue = result.GetPayload().View(); + if (jsonValue.ValueExists("channelArn")) { + m_channelArn = jsonValue.GetString("channelArn"); + m_channelArnHasBeenSet = true; + } + if (jsonValue.ValueExists("channelName")) { + m_channelName = jsonValue.GetString("channelName"); + m_channelNameHasBeenSet = true; + } + if (jsonValue.ValueExists("encryptionConfiguration")) { + m_encryptionConfiguration = jsonValue.GetObject("encryptionConfiguration"); + m_encryptionConfigurationHasBeenSet = true; + } + if (jsonValue.ValueExists("icebergDestinationConfiguration")) { + m_icebergDestinationConfiguration = jsonValue.GetObject("icebergDestinationConfiguration"); + m_icebergDestinationConfigurationHasBeenSet = true; + } + if (jsonValue.ValueExists("s3DestinationConfiguration")) { + m_s3DestinationConfiguration = jsonValue.GetObject("s3DestinationConfiguration"); + m_s3DestinationConfigurationHasBeenSet = true; + } + if (jsonValue.ValueExists("status")) { + m_status = ChannelStatusMapper::GetChannelStatusForName(jsonValue.GetString("status")); + m_statusHasBeenSet = true; + } + if (jsonValue.ValueExists("destinationType")) { + m_destinationType = ChannelDestinationTypeMapper::GetChannelDestinationTypeForName(jsonValue.GetString("destinationType")); + m_destinationTypeHasBeenSet = true; + } + if (jsonValue.ValueExists("creationTime")) { + m_creationTime = jsonValue.GetString("creationTime"); + m_creationTimeHasBeenSet = true; + } + if (jsonValue.ValueExists("topicConfigurationList")) { + Aws::Utils::Array topicConfigurationListJsonList = jsonValue.GetArray("topicConfigurationList"); + for (unsigned topicConfigurationListIndex = 0; topicConfigurationListIndex < topicConfigurationListJsonList.GetLength(); + ++topicConfigurationListIndex) { + m_topicConfigurationList.push_back(topicConfigurationListJsonList[topicConfigurationListIndex].AsObject()); + } + m_topicConfigurationListHasBeenSet = true; + } + if (jsonValue.ValueExists("loggingInfo")) { + m_loggingInfo = jsonValue.GetObject("loggingInfo"); + m_loggingInfoHasBeenSet = true; + } + if (jsonValue.ValueExists("stateInfo")) { + m_stateInfo = jsonValue.GetObject("stateInfo"); + m_stateInfoHasBeenSet = true; + } + if (jsonValue.ValueExists("clusterOperationArn")) { + m_clusterOperationArn = jsonValue.GetString("clusterOperationArn"); + m_clusterOperationArnHasBeenSet = true; + } + if (jsonValue.ValueExists("tags")) { + Aws::Map tagsJsonMap = jsonValue.GetObject("tags").GetAllObjects(); + for (auto& tagsItem : tagsJsonMap) { + m_tags[tagsItem.first] = tagsItem.second.AsString(); + } + m_tagsHasBeenSet = true; + } + + const auto& headers = result.GetHeaderValueCollection(); + const auto& requestIdIter = headers.find("x-amzn-requestid"); + if (requestIdIter != headers.end()) { + m_requestId = requestIdIter->second; + m_requestIdHasBeenSet = true; + } + + return *this; +} diff --git a/generated/src/aws-cpp-sdk-kafka/source/model/DestinationTable.cpp b/generated/src/aws-cpp-sdk-kafka/source/model/DestinationTable.cpp new file mode 100644 index 000000000000..807f3df3d3b0 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/source/model/DestinationTable.cpp @@ -0,0 +1,56 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include + +#include + +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +namespace Aws { +namespace Kafka { +namespace Model { + +DestinationTable::DestinationTable(JsonView jsonValue) { *this = jsonValue; } + +DestinationTable& DestinationTable::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("destinationDatabaseName")) { + m_destinationDatabaseName = jsonValue.GetString("destinationDatabaseName"); + m_destinationDatabaseNameHasBeenSet = true; + } + if (jsonValue.ValueExists("destinationTableName")) { + m_destinationTableName = jsonValue.GetString("destinationTableName"); + m_destinationTableNameHasBeenSet = true; + } + if (jsonValue.ValueExists("partitionSpec")) { + m_partitionSpec = jsonValue.GetObject("partitionSpec"); + m_partitionSpecHasBeenSet = true; + } + return *this; +} + +JsonValue DestinationTable::Jsonize() const { + JsonValue payload; + + if (m_destinationDatabaseNameHasBeenSet) { + payload.WithString("destinationDatabaseName", m_destinationDatabaseName); + } + + if (m_destinationTableNameHasBeenSet) { + payload.WithString("destinationTableName", m_destinationTableName); + } + + if (m_partitionSpecHasBeenSet) { + payload.WithObject("partitionSpec", m_partitionSpec.Jsonize()); + } + + return payload; +} + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/source/model/EncryptionConfiguration.cpp b/generated/src/aws-cpp-sdk-kafka/source/model/EncryptionConfiguration.cpp new file mode 100644 index 000000000000..d8467e11c756 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/source/model/EncryptionConfiguration.cpp @@ -0,0 +1,40 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include + +#include + +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +namespace Aws { +namespace Kafka { +namespace Model { + +EncryptionConfiguration::EncryptionConfiguration(JsonView jsonValue) { *this = jsonValue; } + +EncryptionConfiguration& EncryptionConfiguration::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("kmsKeyArn")) { + m_kmsKeyArn = jsonValue.GetString("kmsKeyArn"); + m_kmsKeyArnHasBeenSet = true; + } + return *this; +} + +JsonValue EncryptionConfiguration::Jsonize() const { + JsonValue payload; + + if (m_kmsKeyArnHasBeenSet) { + payload.WithString("kmsKeyArn", m_kmsKeyArn); + } + + return payload; +} + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/source/model/IcebergCompressionType.cpp b/generated/src/aws-cpp-sdk-kafka/source/model/IcebergCompressionType.cpp new file mode 100644 index 000000000000..7cf3c7395b30 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/source/model/IcebergCompressionType.cpp @@ -0,0 +1,58 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include +#include +#include + +using namespace Aws::Utils; + +namespace Aws { +namespace Kafka { +namespace Model { +namespace IcebergCompressionTypeMapper { + +static const int ZSTD_HASH = HashingUtils::HashString("ZSTD"); +static const int SNAPPY_HASH = HashingUtils::HashString("SNAPPY"); + +IcebergCompressionType GetIcebergCompressionTypeForName(const Aws::String& name) { + int hashCode = HashingUtils::HashString(name.c_str()); + if (hashCode == ZSTD_HASH) { + return IcebergCompressionType::ZSTD; + } else if (hashCode == SNAPPY_HASH) { + return IcebergCompressionType::SNAPPY; + } + EnumParseOverflowContainer* overflowContainer = Aws::GetEnumOverflowContainer(); + if (overflowContainer) { + overflowContainer->StoreOverflow(hashCode, name); + return static_cast(hashCode); + } + + return IcebergCompressionType::NOT_SET; +} + +Aws::String GetNameForIcebergCompressionType(IcebergCompressionType enumValue) { + switch (enumValue) { + case IcebergCompressionType::NOT_SET: + return {}; + case IcebergCompressionType::ZSTD: + return "ZSTD"; + case IcebergCompressionType::SNAPPY: + return "SNAPPY"; + default: + EnumParseOverflowContainer* overflowContainer = Aws::GetEnumOverflowContainer(); + if (overflowContainer) { + return overflowContainer->RetrieveOverflow(static_cast(enumValue)); + } + + return {}; + } +} + +} // namespace IcebergCompressionTypeMapper +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/source/model/IcebergDestinationConfiguration.cpp b/generated/src/aws-cpp-sdk-kafka/source/model/IcebergDestinationConfiguration.cpp new file mode 100644 index 000000000000..caa205274f5d --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/source/model/IcebergDestinationConfiguration.cpp @@ -0,0 +1,113 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include + +#include + +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +namespace Aws { +namespace Kafka { +namespace Model { + +IcebergDestinationConfiguration::IcebergDestinationConfiguration(JsonView jsonValue) { *this = jsonValue; } + +IcebergDestinationConfiguration& IcebergDestinationConfiguration::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("appendOnly")) { + m_appendOnly = jsonValue.GetBool("appendOnly"); + m_appendOnlyHasBeenSet = true; + } + if (jsonValue.ValueExists("catalog")) { + m_catalog = jsonValue.GetObject("catalog"); + m_catalogHasBeenSet = true; + } + if (jsonValue.ValueExists("dataFreshnessInSeconds")) { + m_dataFreshnessInSeconds = jsonValue.GetInteger("dataFreshnessInSeconds"); + m_dataFreshnessInSecondsHasBeenSet = true; + } + if (jsonValue.ValueExists("deadLetterQueueS3")) { + m_deadLetterQueueS3 = jsonValue.GetObject("deadLetterQueueS3"); + m_deadLetterQueueS3HasBeenSet = true; + } + if (jsonValue.ValueExists("destinationTableList")) { + Aws::Utils::Array destinationTableListJsonList = jsonValue.GetArray("destinationTableList"); + for (unsigned destinationTableListIndex = 0; destinationTableListIndex < destinationTableListJsonList.GetLength(); + ++destinationTableListIndex) { + m_destinationTableList.push_back(destinationTableListJsonList[destinationTableListIndex].AsObject()); + } + m_destinationTableListHasBeenSet = true; + } + if (jsonValue.ValueExists("schemaEvolution")) { + m_schemaEvolution = jsonValue.GetObject("schemaEvolution"); + m_schemaEvolutionHasBeenSet = true; + } + if (jsonValue.ValueExists("serviceExecutionRoleArn")) { + m_serviceExecutionRoleArn = jsonValue.GetString("serviceExecutionRoleArn"); + m_serviceExecutionRoleArnHasBeenSet = true; + } + if (jsonValue.ValueExists("tableCreation")) { + m_tableCreation = jsonValue.GetObject("tableCreation"); + m_tableCreationHasBeenSet = true; + } + if (jsonValue.ValueExists("compressionType")) { + m_compressionType = IcebergCompressionTypeMapper::GetIcebergCompressionTypeForName(jsonValue.GetString("compressionType")); + m_compressionTypeHasBeenSet = true; + } + return *this; +} + +JsonValue IcebergDestinationConfiguration::Jsonize() const { + JsonValue payload; + + if (m_appendOnlyHasBeenSet) { + payload.WithBool("appendOnly", m_appendOnly); + } + + if (m_catalogHasBeenSet) { + payload.WithObject("catalog", m_catalog.Jsonize()); + } + + if (m_dataFreshnessInSecondsHasBeenSet) { + payload.WithInteger("dataFreshnessInSeconds", m_dataFreshnessInSeconds); + } + + if (m_deadLetterQueueS3HasBeenSet) { + payload.WithObject("deadLetterQueueS3", m_deadLetterQueueS3.Jsonize()); + } + + if (m_destinationTableListHasBeenSet) { + Aws::Utils::Array destinationTableListJsonList(m_destinationTableList.size()); + for (unsigned destinationTableListIndex = 0; destinationTableListIndex < destinationTableListJsonList.GetLength(); + ++destinationTableListIndex) { + destinationTableListJsonList[destinationTableListIndex].AsObject(m_destinationTableList[destinationTableListIndex].Jsonize()); + } + payload.WithArray("destinationTableList", std::move(destinationTableListJsonList)); + } + + if (m_schemaEvolutionHasBeenSet) { + payload.WithObject("schemaEvolution", m_schemaEvolution.Jsonize()); + } + + if (m_serviceExecutionRoleArnHasBeenSet) { + payload.WithString("serviceExecutionRoleArn", m_serviceExecutionRoleArn); + } + + if (m_tableCreationHasBeenSet) { + payload.WithObject("tableCreation", m_tableCreation.Jsonize()); + } + + if (m_compressionTypeHasBeenSet) { + payload.WithString("compressionType", IcebergCompressionTypeMapper::GetNameForIcebergCompressionType(m_compressionType)); + } + + return payload; +} + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/source/model/IcebergDestinationUpdate.cpp b/generated/src/aws-cpp-sdk-kafka/source/model/IcebergDestinationUpdate.cpp new file mode 100644 index 000000000000..ed189e301999 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/source/model/IcebergDestinationUpdate.cpp @@ -0,0 +1,40 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include + +#include + +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +namespace Aws { +namespace Kafka { +namespace Model { + +IcebergDestinationUpdate::IcebergDestinationUpdate(JsonView jsonValue) { *this = jsonValue; } + +IcebergDestinationUpdate& IcebergDestinationUpdate::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("dataFreshnessInSeconds")) { + m_dataFreshnessInSeconds = jsonValue.GetInteger("dataFreshnessInSeconds"); + m_dataFreshnessInSecondsHasBeenSet = true; + } + return *this; +} + +JsonValue IcebergDestinationUpdate::Jsonize() const { + JsonValue payload; + + if (m_dataFreshnessInSecondsHasBeenSet) { + payload.WithInteger("dataFreshnessInSeconds", m_dataFreshnessInSeconds); + } + + return payload; +} + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/source/model/ListChannelsRequest.cpp b/generated/src/aws-cpp-sdk-kafka/source/model/ListChannelsRequest.cpp new file mode 100644 index 000000000000..c8c54eb3e356 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/source/model/ListChannelsRequest.cpp @@ -0,0 +1,39 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include +#include +#include + +#include + +using namespace Aws::Kafka::Model; +using namespace Aws::Utils::Json; +using namespace Aws::Utils; +using namespace Aws::Http; + +Aws::String ListChannelsRequest::SerializePayload() const { return {}; } + +void ListChannelsRequest::AddQueryStringParameters(URI& uri) const { + Aws::StringStream ss; + if (m_maxResultsHasBeenSet) { + ss << m_maxResults; + uri.AddQueryStringParameter("maxResults", ss.str()); + ss.str(""); + } + + if (m_nextTokenHasBeenSet) { + ss << m_nextToken; + uri.AddQueryStringParameter("nextToken", ss.str()); + ss.str(""); + } + + if (m_topicNameFilterHasBeenSet) { + ss << m_topicNameFilter; + uri.AddQueryStringParameter("topicNameFilter", ss.str()); + ss.str(""); + } +} diff --git a/generated/src/aws-cpp-sdk-kafka/source/model/ListChannelsResult.cpp b/generated/src/aws-cpp-sdk-kafka/source/model/ListChannelsResult.cpp new file mode 100644 index 000000000000..55829088934e --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/source/model/ListChannelsResult.cpp @@ -0,0 +1,45 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include +#include +#include +#include +#include + +#include + +using namespace Aws::Kafka::Model; +using namespace Aws::Utils::Json; +using namespace Aws::Utils; +using namespace Aws; + +ListChannelsResult::ListChannelsResult(const Aws::AmazonWebServiceResult& result) { *this = result; } + +ListChannelsResult& ListChannelsResult::operator=(const Aws::AmazonWebServiceResult& result) { + m_HttpResponseCode = result.GetResponseCode(); + JsonView jsonValue = result.GetPayload().View(); + if (jsonValue.ValueExists("channels")) { + Aws::Utils::Array channelsJsonList = jsonValue.GetArray("channels"); + for (unsigned channelsIndex = 0; channelsIndex < channelsJsonList.GetLength(); ++channelsIndex) { + m_channels.push_back(channelsJsonList[channelsIndex].AsObject()); + } + m_channelsHasBeenSet = true; + } + if (jsonValue.ValueExists("nextToken")) { + m_nextToken = jsonValue.GetString("nextToken"); + m_nextTokenHasBeenSet = true; + } + + const auto& headers = result.GetHeaderValueCollection(); + const auto& requestIdIter = headers.find("x-amzn-requestid"); + if (requestIdIter != headers.end()) { + m_requestId = requestIdIter->second; + m_requestIdHasBeenSet = true; + } + + return *this; +} diff --git a/generated/src/aws-cpp-sdk-kafka/source/model/PartitionSource.cpp b/generated/src/aws-cpp-sdk-kafka/source/model/PartitionSource.cpp new file mode 100644 index 000000000000..fd9b719aa94c --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/source/model/PartitionSource.cpp @@ -0,0 +1,40 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include + +#include + +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +namespace Aws { +namespace Kafka { +namespace Model { + +PartitionSource::PartitionSource(JsonView jsonValue) { *this = jsonValue; } + +PartitionSource& PartitionSource::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("sourceName")) { + m_sourceName = jsonValue.GetString("sourceName"); + m_sourceNameHasBeenSet = true; + } + return *this; +} + +JsonValue PartitionSource::Jsonize() const { + JsonValue payload; + + if (m_sourceNameHasBeenSet) { + payload.WithString("sourceName", m_sourceName); + } + + return payload; +} + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/source/model/PartitionSpec.cpp b/generated/src/aws-cpp-sdk-kafka/source/model/PartitionSpec.cpp new file mode 100644 index 000000000000..a9edebc199d1 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/source/model/PartitionSpec.cpp @@ -0,0 +1,55 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include + +#include + +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +namespace Aws { +namespace Kafka { +namespace Model { + +PartitionSpec::PartitionSpec(JsonView jsonValue) { *this = jsonValue; } + +PartitionSpec& PartitionSpec::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("partitionStrategy")) { + m_partitionStrategy = PartitionStrategyMapper::GetPartitionStrategyForName(jsonValue.GetString("partitionStrategy")); + m_partitionStrategyHasBeenSet = true; + } + if (jsonValue.ValueExists("sourceList")) { + Aws::Utils::Array sourceListJsonList = jsonValue.GetArray("sourceList"); + for (unsigned sourceListIndex = 0; sourceListIndex < sourceListJsonList.GetLength(); ++sourceListIndex) { + m_sourceList.push_back(sourceListJsonList[sourceListIndex].AsObject()); + } + m_sourceListHasBeenSet = true; + } + return *this; +} + +JsonValue PartitionSpec::Jsonize() const { + JsonValue payload; + + if (m_partitionStrategyHasBeenSet) { + payload.WithString("partitionStrategy", PartitionStrategyMapper::GetNameForPartitionStrategy(m_partitionStrategy)); + } + + if (m_sourceListHasBeenSet) { + Aws::Utils::Array sourceListJsonList(m_sourceList.size()); + for (unsigned sourceListIndex = 0; sourceListIndex < sourceListJsonList.GetLength(); ++sourceListIndex) { + sourceListJsonList[sourceListIndex].AsObject(m_sourceList[sourceListIndex].Jsonize()); + } + payload.WithArray("sourceList", std::move(sourceListJsonList)); + } + + return payload; +} + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/source/model/PartitionStrategy.cpp b/generated/src/aws-cpp-sdk-kafka/source/model/PartitionStrategy.cpp new file mode 100644 index 000000000000..3db21be035e4 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/source/model/PartitionStrategy.cpp @@ -0,0 +1,53 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include +#include +#include + +using namespace Aws::Utils; + +namespace Aws { +namespace Kafka { +namespace Model { +namespace PartitionStrategyMapper { + +static const int TIME_HOUR_HASH = HashingUtils::HashString("TIME_HOUR"); + +PartitionStrategy GetPartitionStrategyForName(const Aws::String& name) { + int hashCode = HashingUtils::HashString(name.c_str()); + if (hashCode == TIME_HOUR_HASH) { + return PartitionStrategy::TIME_HOUR; + } + EnumParseOverflowContainer* overflowContainer = Aws::GetEnumOverflowContainer(); + if (overflowContainer) { + overflowContainer->StoreOverflow(hashCode, name); + return static_cast(hashCode); + } + + return PartitionStrategy::NOT_SET; +} + +Aws::String GetNameForPartitionStrategy(PartitionStrategy enumValue) { + switch (enumValue) { + case PartitionStrategy::NOT_SET: + return {}; + case PartitionStrategy::TIME_HOUR: + return "TIME_HOUR"; + default: + EnumParseOverflowContainer* overflowContainer = Aws::GetEnumOverflowContainer(); + if (overflowContainer) { + return overflowContainer->RetrieveOverflow(static_cast(enumValue)); + } + + return {}; + } +} + +} // namespace PartitionStrategyMapper +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/source/model/RecordConverter.cpp b/generated/src/aws-cpp-sdk-kafka/source/model/RecordConverter.cpp new file mode 100644 index 000000000000..d1225438b72b --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/source/model/RecordConverter.cpp @@ -0,0 +1,40 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include + +#include + +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +namespace Aws { +namespace Kafka { +namespace Model { + +RecordConverter::RecordConverter(JsonView jsonValue) { *this = jsonValue; } + +RecordConverter& RecordConverter::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("valueConverter")) { + m_valueConverter = ValueConverterMapper::GetValueConverterForName(jsonValue.GetString("valueConverter")); + m_valueConverterHasBeenSet = true; + } + return *this; +} + +JsonValue RecordConverter::Jsonize() const { + JsonValue payload; + + if (m_valueConverterHasBeenSet) { + payload.WithString("valueConverter", ValueConverterMapper::GetNameForValueConverter(m_valueConverter)); + } + + return payload; +} + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/source/model/RecordSchema.cpp b/generated/src/aws-cpp-sdk-kafka/source/model/RecordSchema.cpp new file mode 100644 index 000000000000..6e587d83346f --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/source/model/RecordSchema.cpp @@ -0,0 +1,40 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include + +#include + +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +namespace Aws { +namespace Kafka { +namespace Model { + +RecordSchema::RecordSchema(JsonView jsonValue) { *this = jsonValue; } + +RecordSchema& RecordSchema::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("gsrArn")) { + m_gsrArn = jsonValue.GetString("gsrArn"); + m_gsrArnHasBeenSet = true; + } + return *this; +} + +JsonValue RecordSchema::Jsonize() const { + JsonValue payload; + + if (m_gsrArnHasBeenSet) { + payload.WithString("gsrArn", m_gsrArn); + } + + return payload; +} + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/source/model/S3CompressionType.cpp b/generated/src/aws-cpp-sdk-kafka/source/model/S3CompressionType.cpp new file mode 100644 index 000000000000..f1373e7b2178 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/source/model/S3CompressionType.cpp @@ -0,0 +1,63 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include +#include +#include + +using namespace Aws::Utils; + +namespace Aws { +namespace Kafka { +namespace Model { +namespace S3CompressionTypeMapper { + +static const int NONE_HASH = HashingUtils::HashString("NONE"); +static const int GZIP_HASH = HashingUtils::HashString("GZIP"); +static const int ZSTD_HASH = HashingUtils::HashString("ZSTD"); + +S3CompressionType GetS3CompressionTypeForName(const Aws::String& name) { + int hashCode = HashingUtils::HashString(name.c_str()); + if (hashCode == NONE_HASH) { + return S3CompressionType::NONE; + } else if (hashCode == GZIP_HASH) { + return S3CompressionType::GZIP; + } else if (hashCode == ZSTD_HASH) { + return S3CompressionType::ZSTD; + } + EnumParseOverflowContainer* overflowContainer = Aws::GetEnumOverflowContainer(); + if (overflowContainer) { + overflowContainer->StoreOverflow(hashCode, name); + return static_cast(hashCode); + } + + return S3CompressionType::NOT_SET; +} + +Aws::String GetNameForS3CompressionType(S3CompressionType enumValue) { + switch (enumValue) { + case S3CompressionType::NOT_SET: + return {}; + case S3CompressionType::NONE: + return "NONE"; + case S3CompressionType::GZIP: + return "GZIP"; + case S3CompressionType::ZSTD: + return "ZSTD"; + default: + EnumParseOverflowContainer* overflowContainer = Aws::GetEnumOverflowContainer(); + if (overflowContainer) { + return overflowContainer->RetrieveOverflow(static_cast(enumValue)); + } + + return {}; + } +} + +} // namespace S3CompressionTypeMapper +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/source/model/S3DestinationConfiguration.cpp b/generated/src/aws-cpp-sdk-kafka/source/model/S3DestinationConfiguration.cpp new file mode 100644 index 000000000000..7a06348f0699 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/source/model/S3DestinationConfiguration.cpp @@ -0,0 +1,64 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include + +#include + +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +namespace Aws { +namespace Kafka { +namespace Model { + +S3DestinationConfiguration::S3DestinationConfiguration(JsonView jsonValue) { *this = jsonValue; } + +S3DestinationConfiguration& S3DestinationConfiguration::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("dataFreshnessInSeconds")) { + m_dataFreshnessInSeconds = jsonValue.GetInteger("dataFreshnessInSeconds"); + m_dataFreshnessInSecondsHasBeenSet = true; + } + if (jsonValue.ValueExists("deadLetterQueueS3")) { + m_deadLetterQueueS3 = jsonValue.GetObject("deadLetterQueueS3"); + m_deadLetterQueueS3HasBeenSet = true; + } + if (jsonValue.ValueExists("serviceExecutionRoleArn")) { + m_serviceExecutionRoleArn = jsonValue.GetString("serviceExecutionRoleArn"); + m_serviceExecutionRoleArnHasBeenSet = true; + } + if (jsonValue.ValueExists("storage")) { + m_storage = jsonValue.GetObject("storage"); + m_storageHasBeenSet = true; + } + return *this; +} + +JsonValue S3DestinationConfiguration::Jsonize() const { + JsonValue payload; + + if (m_dataFreshnessInSecondsHasBeenSet) { + payload.WithInteger("dataFreshnessInSeconds", m_dataFreshnessInSeconds); + } + + if (m_deadLetterQueueS3HasBeenSet) { + payload.WithObject("deadLetterQueueS3", m_deadLetterQueueS3.Jsonize()); + } + + if (m_serviceExecutionRoleArnHasBeenSet) { + payload.WithString("serviceExecutionRoleArn", m_serviceExecutionRoleArn); + } + + if (m_storageHasBeenSet) { + payload.WithObject("storage", m_storage.Jsonize()); + } + + return payload; +} + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/source/model/S3DestinationUpdate.cpp b/generated/src/aws-cpp-sdk-kafka/source/model/S3DestinationUpdate.cpp new file mode 100644 index 000000000000..a169333b581c --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/source/model/S3DestinationUpdate.cpp @@ -0,0 +1,40 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include + +#include + +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +namespace Aws { +namespace Kafka { +namespace Model { + +S3DestinationUpdate::S3DestinationUpdate(JsonView jsonValue) { *this = jsonValue; } + +S3DestinationUpdate& S3DestinationUpdate::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("dataFreshnessInSeconds")) { + m_dataFreshnessInSeconds = jsonValue.GetInteger("dataFreshnessInSeconds"); + m_dataFreshnessInSecondsHasBeenSet = true; + } + return *this; +} + +JsonValue S3DestinationUpdate::Jsonize() const { + JsonValue payload; + + if (m_dataFreshnessInSecondsHasBeenSet) { + payload.WithInteger("dataFreshnessInSeconds", m_dataFreshnessInSeconds); + } + + return payload; +} + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/source/model/S3Storage.cpp b/generated/src/aws-cpp-sdk-kafka/source/model/S3Storage.cpp new file mode 100644 index 000000000000..253bf0800d4c --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/source/model/S3Storage.cpp @@ -0,0 +1,80 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include + +#include + +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +namespace Aws { +namespace Kafka { +namespace Model { + +S3Storage::S3Storage(JsonView jsonValue) { *this = jsonValue; } + +S3Storage& S3Storage::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("bucketArn")) { + m_bucketArn = jsonValue.GetString("bucketArn"); + m_bucketArnHasBeenSet = true; + } + if (jsonValue.ValueExists("compressionType")) { + m_compressionType = S3CompressionTypeMapper::GetS3CompressionTypeForName(jsonValue.GetString("compressionType")); + m_compressionTypeHasBeenSet = true; + } + if (jsonValue.ValueExists("outputPrefix")) { + m_outputPrefix = jsonValue.GetString("outputPrefix"); + m_outputPrefixHasBeenSet = true; + } + if (jsonValue.ValueExists("outputKeyTemplate")) { + m_outputKeyTemplate = jsonValue.GetString("outputKeyTemplate"); + m_outputKeyTemplateHasBeenSet = true; + } + if (jsonValue.ValueExists("storageClass")) { + m_storageClass = S3StorageClassMapper::GetS3StorageClassForName(jsonValue.GetString("storageClass")); + m_storageClassHasBeenSet = true; + } + if (jsonValue.ValueExists("expectedBucketOwner")) { + m_expectedBucketOwner = jsonValue.GetString("expectedBucketOwner"); + m_expectedBucketOwnerHasBeenSet = true; + } + return *this; +} + +JsonValue S3Storage::Jsonize() const { + JsonValue payload; + + if (m_bucketArnHasBeenSet) { + payload.WithString("bucketArn", m_bucketArn); + } + + if (m_compressionTypeHasBeenSet) { + payload.WithString("compressionType", S3CompressionTypeMapper::GetNameForS3CompressionType(m_compressionType)); + } + + if (m_outputPrefixHasBeenSet) { + payload.WithString("outputPrefix", m_outputPrefix); + } + + if (m_outputKeyTemplateHasBeenSet) { + payload.WithString("outputKeyTemplate", m_outputKeyTemplate); + } + + if (m_storageClassHasBeenSet) { + payload.WithString("storageClass", S3StorageClassMapper::GetNameForS3StorageClass(m_storageClass)); + } + + if (m_expectedBucketOwnerHasBeenSet) { + payload.WithString("expectedBucketOwner", m_expectedBucketOwner); + } + + return payload; +} + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/source/model/S3StorageClass.cpp b/generated/src/aws-cpp-sdk-kafka/source/model/S3StorageClass.cpp new file mode 100644 index 000000000000..46ecf0a96de7 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/source/model/S3StorageClass.cpp @@ -0,0 +1,63 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include +#include +#include + +using namespace Aws::Utils; + +namespace Aws { +namespace Kafka { +namespace Model { +namespace S3StorageClassMapper { + +static const int STANDARD_HASH = HashingUtils::HashString("STANDARD"); +static const int INTELLIGENT_TIERING_HASH = HashingUtils::HashString("INTELLIGENT_TIERING"); +static const int GLACIER_IR_HASH = HashingUtils::HashString("GLACIER_IR"); + +S3StorageClass GetS3StorageClassForName(const Aws::String& name) { + int hashCode = HashingUtils::HashString(name.c_str()); + if (hashCode == STANDARD_HASH) { + return S3StorageClass::STANDARD; + } else if (hashCode == INTELLIGENT_TIERING_HASH) { + return S3StorageClass::INTELLIGENT_TIERING; + } else if (hashCode == GLACIER_IR_HASH) { + return S3StorageClass::GLACIER_IR; + } + EnumParseOverflowContainer* overflowContainer = Aws::GetEnumOverflowContainer(); + if (overflowContainer) { + overflowContainer->StoreOverflow(hashCode, name); + return static_cast(hashCode); + } + + return S3StorageClass::NOT_SET; +} + +Aws::String GetNameForS3StorageClass(S3StorageClass enumValue) { + switch (enumValue) { + case S3StorageClass::NOT_SET: + return {}; + case S3StorageClass::STANDARD: + return "STANDARD"; + case S3StorageClass::INTELLIGENT_TIERING: + return "INTELLIGENT_TIERING"; + case S3StorageClass::GLACIER_IR: + return "GLACIER_IR"; + default: + EnumParseOverflowContainer* overflowContainer = Aws::GetEnumOverflowContainer(); + if (overflowContainer) { + return overflowContainer->RetrieveOverflow(static_cast(enumValue)); + } + + return {}; + } +} + +} // namespace S3StorageClassMapper +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/source/model/SchemaEvolution.cpp b/generated/src/aws-cpp-sdk-kafka/source/model/SchemaEvolution.cpp new file mode 100644 index 000000000000..de43ab39f5aa --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/source/model/SchemaEvolution.cpp @@ -0,0 +1,40 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include + +#include + +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +namespace Aws { +namespace Kafka { +namespace Model { + +SchemaEvolution::SchemaEvolution(JsonView jsonValue) { *this = jsonValue; } + +SchemaEvolution& SchemaEvolution::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("enableSchemaEvolution")) { + m_enableSchemaEvolution = jsonValue.GetBool("enableSchemaEvolution"); + m_enableSchemaEvolutionHasBeenSet = true; + } + return *this; +} + +JsonValue SchemaEvolution::Jsonize() const { + JsonValue payload; + + if (m_enableSchemaEvolutionHasBeenSet) { + payload.WithBool("enableSchemaEvolution", m_enableSchemaEvolution); + } + + return payload; +} + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/source/model/TableCreation.cpp b/generated/src/aws-cpp-sdk-kafka/source/model/TableCreation.cpp new file mode 100644 index 000000000000..f24b49e64c22 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/source/model/TableCreation.cpp @@ -0,0 +1,40 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include + +#include + +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +namespace Aws { +namespace Kafka { +namespace Model { + +TableCreation::TableCreation(JsonView jsonValue) { *this = jsonValue; } + +TableCreation& TableCreation::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("enableTableCreation")) { + m_enableTableCreation = jsonValue.GetBool("enableTableCreation"); + m_enableTableCreationHasBeenSet = true; + } + return *this; +} + +JsonValue TableCreation::Jsonize() const { + JsonValue payload; + + if (m_enableTableCreationHasBeenSet) { + payload.WithBool("enableTableCreation", m_enableTableCreation); + } + + return payload; +} + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/source/model/TopicConfiguration.cpp b/generated/src/aws-cpp-sdk-kafka/source/model/TopicConfiguration.cpp new file mode 100644 index 000000000000..ac0d4278ddf6 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/source/model/TopicConfiguration.cpp @@ -0,0 +1,56 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include + +#include + +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +namespace Aws { +namespace Kafka { +namespace Model { + +TopicConfiguration::TopicConfiguration(JsonView jsonValue) { *this = jsonValue; } + +TopicConfiguration& TopicConfiguration::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("recordConverter")) { + m_recordConverter = jsonValue.GetObject("recordConverter"); + m_recordConverterHasBeenSet = true; + } + if (jsonValue.ValueExists("recordSchema")) { + m_recordSchema = jsonValue.GetObject("recordSchema"); + m_recordSchemaHasBeenSet = true; + } + if (jsonValue.ValueExists("topicArn")) { + m_topicArn = jsonValue.GetString("topicArn"); + m_topicArnHasBeenSet = true; + } + return *this; +} + +JsonValue TopicConfiguration::Jsonize() const { + JsonValue payload; + + if (m_recordConverterHasBeenSet) { + payload.WithObject("recordConverter", m_recordConverter.Jsonize()); + } + + if (m_recordSchemaHasBeenSet) { + payload.WithObject("recordSchema", m_recordSchema.Jsonize()); + } + + if (m_topicArnHasBeenSet) { + payload.WithString("topicArn", m_topicArn); + } + + return payload; +} + +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-kafka/source/model/UpdateChannelRequest.cpp b/generated/src/aws-cpp-sdk-kafka/source/model/UpdateChannelRequest.cpp new file mode 100644 index 000000000000..0a95b6692fc0 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/source/model/UpdateChannelRequest.cpp @@ -0,0 +1,27 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include + +#include + +using namespace Aws::Kafka::Model; +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +Aws::String UpdateChannelRequest::SerializePayload() const { + JsonValue payload; + + if (m_icebergDestinationUpdateHasBeenSet) { + payload.WithObject("icebergDestinationUpdate", m_icebergDestinationUpdate.Jsonize()); + } + + if (m_s3DestinationUpdateHasBeenSet) { + payload.WithObject("s3DestinationUpdate", m_s3DestinationUpdate.Jsonize()); + } + + return payload.View().WriteReadable(); +} diff --git a/generated/src/aws-cpp-sdk-kafka/source/model/UpdateChannelResult.cpp b/generated/src/aws-cpp-sdk-kafka/source/model/UpdateChannelResult.cpp new file mode 100644 index 000000000000..66f08eb0219b --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/source/model/UpdateChannelResult.cpp @@ -0,0 +1,42 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include +#include +#include +#include +#include + +#include + +using namespace Aws::Kafka::Model; +using namespace Aws::Utils::Json; +using namespace Aws::Utils; +using namespace Aws; + +UpdateChannelResult::UpdateChannelResult(const Aws::AmazonWebServiceResult& result) { *this = result; } + +UpdateChannelResult& UpdateChannelResult::operator=(const Aws::AmazonWebServiceResult& result) { + m_HttpResponseCode = result.GetResponseCode(); + JsonView jsonValue = result.GetPayload().View(); + if (jsonValue.ValueExists("channelArn")) { + m_channelArn = jsonValue.GetString("channelArn"); + m_channelArnHasBeenSet = true; + } + if (jsonValue.ValueExists("clusterOperationArn")) { + m_clusterOperationArn = jsonValue.GetString("clusterOperationArn"); + m_clusterOperationArnHasBeenSet = true; + } + + const auto& headers = result.GetHeaderValueCollection(); + const auto& requestIdIter = headers.find("x-amzn-requestid"); + if (requestIdIter != headers.end()) { + m_requestId = requestIdIter->second; + m_requestIdHasBeenSet = true; + } + + return *this; +} diff --git a/generated/src/aws-cpp-sdk-kafka/source/model/ValueConverter.cpp b/generated/src/aws-cpp-sdk-kafka/source/model/ValueConverter.cpp new file mode 100644 index 000000000000..7d48c1165845 --- /dev/null +++ b/generated/src/aws-cpp-sdk-kafka/source/model/ValueConverter.cpp @@ -0,0 +1,68 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include +#include +#include + +using namespace Aws::Utils; + +namespace Aws { +namespace Kafka { +namespace Model { +namespace ValueConverterMapper { + +static const int BYTE_ARRAY_HASH = HashingUtils::HashString("BYTE_ARRAY"); +static const int JSON_HASH = HashingUtils::HashString("JSON"); +static const int JSON_SCHEMA_GSR_HASH = HashingUtils::HashString("JSON_SCHEMA_GSR"); +static const int STRING_HASH = HashingUtils::HashString("STRING"); + +ValueConverter GetValueConverterForName(const Aws::String& name) { + int hashCode = HashingUtils::HashString(name.c_str()); + if (hashCode == BYTE_ARRAY_HASH) { + return ValueConverter::BYTE_ARRAY; + } else if (hashCode == JSON_HASH) { + return ValueConverter::JSON; + } else if (hashCode == JSON_SCHEMA_GSR_HASH) { + return ValueConverter::JSON_SCHEMA_GSR; + } else if (hashCode == STRING_HASH) { + return ValueConverter::STRING; + } + EnumParseOverflowContainer* overflowContainer = Aws::GetEnumOverflowContainer(); + if (overflowContainer) { + overflowContainer->StoreOverflow(hashCode, name); + return static_cast(hashCode); + } + + return ValueConverter::NOT_SET; +} + +Aws::String GetNameForValueConverter(ValueConverter enumValue) { + switch (enumValue) { + case ValueConverter::NOT_SET: + return {}; + case ValueConverter::BYTE_ARRAY: + return "BYTE_ARRAY"; + case ValueConverter::JSON: + return "JSON"; + case ValueConverter::JSON_SCHEMA_GSR: + return "JSON_SCHEMA_GSR"; + case ValueConverter::STRING: + return "STRING"; + default: + EnumParseOverflowContainer* overflowContainer = Aws::GetEnumOverflowContainer(); + if (overflowContainer) { + return overflowContainer->RetrieveOverflow(static_cast(enumValue)); + } + + return {}; + } +} + +} // namespace ValueConverterMapper +} // namespace Model +} // namespace Kafka +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-lambda/include/aws/lambda/model/FunctionCode.h b/generated/src/aws-cpp-sdk-lambda/include/aws/lambda/model/FunctionCode.h index ec9b862803ca..7d97d13aa275 100644 --- a/generated/src/aws-cpp-sdk-lambda/include/aws/lambda/model/FunctionCode.h +++ b/generated/src/aws-cpp-sdk-lambda/include/aws/lambda/model/FunctionCode.h @@ -112,10 +112,10 @@ class FunctionCode { ///@{ /** - *

Specifies how the deployment package is stored. Use COPY - * (default) to upload a copy of your deployment package to Lambda. Use - * REFERENCE to have Lambda reference the deployment package from the - * specified Amazon S3 bucket.

+ *

Specifies how the deployment package is stored. Valid values:

  • + *

    COPY (default) – Uploads a copy of your deployment package to + * Lambda.

  • REFERENCE – Lambda references the + * deployment package from the specified Amazon S3 bucket.

*/ inline S3ObjectStorageMode GetS3ObjectStorageMode() const { return m_s3ObjectStorageMode; } inline bool S3ObjectStorageModeHasBeenSet() const { return m_s3ObjectStorageModeHasBeenSet; } diff --git a/generated/src/aws-cpp-sdk-lambda/include/aws/lambda/model/FunctionCodeLocationError.h b/generated/src/aws-cpp-sdk-lambda/include/aws/lambda/model/FunctionCodeLocationError.h index 785096a2bc33..d48e3281bae6 100644 --- a/generated/src/aws-cpp-sdk-lambda/include/aws/lambda/model/FunctionCodeLocationError.h +++ b/generated/src/aws-cpp-sdk-lambda/include/aws/lambda/model/FunctionCodeLocationError.h @@ -20,8 +20,8 @@ namespace Lambda { namespace Model { /** - *

Details about an error related to retrieving a function's deployment - * package.

See Also:

Contains details about an error that occurred when Lambda attempted to + * retrieve a function's deployment package.

See Also:

AWS * API Reference

*/ @@ -34,7 +34,8 @@ class FunctionCodeLocationError { ///@{ /** - *

The error code for the failed retrieval.

+ *

The error code that identifies why Lambda failed to retrieve the deployment + * package.

*/ inline const Aws::String& GetErrorCode() const { return m_errorCode; } inline bool ErrorCodeHasBeenSet() const { return m_errorCodeHasBeenSet; } @@ -52,7 +53,8 @@ class FunctionCodeLocationError { ///@{ /** - *

A description of the error.

+ *

The human-readable message that describes why Lambda failed to retrieve the + * deployment package.

*/ inline const Aws::String& GetMessage() const { return m_message; } inline bool MessageHasBeenSet() const { return m_messageHasBeenSet; } diff --git a/generated/src/aws-cpp-sdk-lambda/include/aws/lambda/model/LayerVersionContentInput.h b/generated/src/aws-cpp-sdk-lambda/include/aws/lambda/model/LayerVersionContentInput.h index 103c32145fd7..1b23aaf18917 100644 --- a/generated/src/aws-cpp-sdk-lambda/include/aws/lambda/model/LayerVersionContentInput.h +++ b/generated/src/aws-cpp-sdk-lambda/include/aws/lambda/model/LayerVersionContentInput.h @@ -91,7 +91,12 @@ class LayerVersionContentInput { ///@} ///@{ - + /** + *

Specifies how the layer archive is stored. Valid values:

  • + * COPY (default) – Uploads a copy of your layer archive to + * Lambda.

  • REFERENCE – Lambda references the layer + * archive from the specified Amazon S3 bucket.

+ */ inline S3ObjectStorageMode GetS3ObjectStorageMode() const { return m_s3ObjectStorageMode; } inline bool S3ObjectStorageModeHasBeenSet() const { return m_s3ObjectStorageModeHasBeenSet; } inline void SetS3ObjectStorageMode(S3ObjectStorageMode value) { diff --git a/generated/src/aws-cpp-sdk-lambda/include/aws/lambda/model/LayerVersionContentOutput.h b/generated/src/aws-cpp-sdk-lambda/include/aws/lambda/model/LayerVersionContentOutput.h index b4eb3257c04b..a0201fe32a52 100644 --- a/generated/src/aws-cpp-sdk-lambda/include/aws/lambda/model/LayerVersionContentOutput.h +++ b/generated/src/aws-cpp-sdk-lambda/include/aws/lambda/model/LayerVersionContentOutput.h @@ -123,7 +123,9 @@ class LayerVersionContentOutput { ///@} ///@{ - + /** + *

The resolved Amazon S3 object that contains the layer archive.

+ */ inline const ResolvedS3Object& GetResolvedS3Object() const { return m_resolvedS3Object; } inline bool ResolvedS3ObjectHasBeenSet() const { return m_resolvedS3ObjectHasBeenSet; } template diff --git a/generated/src/aws-cpp-sdk-lambda/include/aws/lambda/model/Runtime.h b/generated/src/aws-cpp-sdk-lambda/include/aws/lambda/model/Runtime.h index a92f6c78d2c3..5015ca4e135a 100644 --- a/generated/src/aws-cpp-sdk-lambda/include/aws/lambda/model/Runtime.h +++ b/generated/src/aws-cpp-sdk-lambda/include/aws/lambda/model/Runtime.h @@ -58,6 +58,8 @@ enum class Runtime { provided, provided_al2, provided_al2023, + nodejs26_x, + python3_15, java8_al2023, java11_al2023, java17_al2023 diff --git a/generated/src/aws-cpp-sdk-lambda/include/aws/lambda/model/UpdateFunctionCodeRequest.h b/generated/src/aws-cpp-sdk-lambda/include/aws/lambda/model/UpdateFunctionCodeRequest.h index 218192ee555b..b5e27fb0e9ba 100644 --- a/generated/src/aws-cpp-sdk-lambda/include/aws/lambda/model/UpdateFunctionCodeRequest.h +++ b/generated/src/aws-cpp-sdk-lambda/include/aws/lambda/model/UpdateFunctionCodeRequest.h @@ -138,10 +138,10 @@ class UpdateFunctionCodeRequest : public LambdaRequest { ///@{ /** - *

Specifies how the deployment package is stored. Use COPY - * (default) to upload a copy of your deployment package to Lambda. Use - * REFERENCE to have Lambda reference the deployment package from the - * specified Amazon S3 bucket.

+ *

Specifies how the deployment package is stored. Valid values:

  • + *

    COPY (default) – Uploads a copy of your deployment package to + * Lambda.

  • REFERENCE – Lambda references the + * deployment package from the specified Amazon S3 bucket.

*/ inline S3ObjectStorageMode GetS3ObjectStorageMode() const { return m_s3ObjectStorageMode; } inline bool S3ObjectStorageModeHasBeenSet() const { return m_s3ObjectStorageModeHasBeenSet; } diff --git a/generated/src/aws-cpp-sdk-lambda/source/model/Runtime.cpp b/generated/src/aws-cpp-sdk-lambda/source/model/Runtime.cpp index a90fb164e923..33b3083c645a 100644 --- a/generated/src/aws-cpp-sdk-lambda/source/model/Runtime.cpp +++ b/generated/src/aws-cpp-sdk-lambda/source/model/Runtime.cpp @@ -61,6 +61,8 @@ static const int ruby4_0_HASH = HashingUtils::HashString("ruby4.0"); static const int provided_HASH = HashingUtils::HashString("provided"); static const int provided_al2_HASH = HashingUtils::HashString("provided.al2"); static const int provided_al2023_HASH = HashingUtils::HashString("provided.al2023"); +static const int nodejs26_x_HASH = HashingUtils::HashString("nodejs26.x"); +static const int python3_15_HASH = HashingUtils::HashString("python3.15"); static const int java8_al2023_HASH = HashingUtils::HashString("java8.al2023"); static const int java11_al2023_HASH = HashingUtils::HashString("java11.al2023"); static const int java17_al2023_HASH = HashingUtils::HashString("java17.al2023"); @@ -159,6 +161,10 @@ Runtime GetRuntimeForName(const Aws::String& name) { return Runtime::provided_al2; } else if (hashCode == provided_al2023_HASH) { return Runtime::provided_al2023; + } else if (hashCode == nodejs26_x_HASH) { + return Runtime::nodejs26_x; + } else if (hashCode == python3_15_HASH) { + return Runtime::python3_15; } else if (hashCode == java8_al2023_HASH) { return Runtime::java8_al2023; } else if (hashCode == java11_al2023_HASH) { @@ -271,6 +277,10 @@ Aws::String GetNameForRuntime(Runtime enumValue) { return "provided.al2"; case Runtime::provided_al2023: return "provided.al2023"; + case Runtime::nodejs26_x: + return "nodejs26.x"; + case Runtime::python3_15: + return "python3.15"; case Runtime::java8_al2023: return "java8.al2023"; case Runtime::java11_al2023: diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/CMakeLists.txt b/generated/src/aws-cpp-sdk-pricing-plan-manager/CMakeLists.txt new file mode 100644 index 000000000000..31a409b0e0fa --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/CMakeLists.txt @@ -0,0 +1,82 @@ +add_project(aws-cpp-sdk-pricing-plan-manager "C++ SDK for the AWS pricing-plan-manager service" aws-cpp-sdk-core) + +file(GLOB AWS_PRICING-PLAN-MANAGER_HEADERS + "include/aws/pricing-plan-manager/*.h" +) + +file(GLOB AWS_PRICING-PLAN-MANAGER_MODEL_HEADERS + "include/aws/pricing-plan-manager/model/*.h" +) + +file(GLOB AWS_PRICING-PLAN-MANAGER_INTERNAL_HEADERS + "include/aws/pricing-plan-manager/internal/*.h" +) + +file(GLOB AWS_PRICING-PLAN-MANAGER_SOURCE + "source/*.cpp" +) + +file(GLOB AWS_PRICING-PLAN-MANAGER_MODEL_SOURCE + "source/model/*.cpp" +) + +file(GLOB PRICING-PLAN-MANAGER_UNIFIED_HEADERS + ${AWS_PRICING-PLAN-MANAGER_HEADERS} + ${AWS_PRICING-PLAN-MANAGER_INTERNAL_HEADERS} + ${AWS_PRICING-PLAN-MANAGER_MODEL_HEADERS} +) + +file(GLOB PRICING-PLAN-MANAGER_UNITY_SRC + ${AWS_PRICING-PLAN-MANAGER_SOURCE} + ${AWS_PRICING-PLAN-MANAGER_MODEL_SOURCE} +) + +if(ENABLE_UNITY_BUILD) + enable_unity_build("PRICING-PLAN-MANAGER" PRICING-PLAN-MANAGER_UNITY_SRC) +endif() + +file(GLOB PRICING-PLAN-MANAGER_SRC + ${PRICING-PLAN-MANAGER_UNIFIED_HEADERS} + ${PRICING-PLAN-MANAGER_UNITY_SRC} +) + +if(WIN32) + #if we are compiling for visual studio, create a sane directory tree. + if(MSVC) + source_group("Header Files\\aws\\pricing-plan-manager" FILES ${AWS_PRICING-PLAN-MANAGER_HEADERS}) + source_group("Header Files\\aws\\pricing-plan-manager\\internal" FILES ${AWS_PRICING-PLAN-MANAGER_INTERNAL_HEADERS}) + source_group("Header Files\\aws\\pricing-plan-manager\\model" FILES ${AWS_PRICING-PLAN-MANAGER_MODEL_HEADERS}) + source_group("Source Files" FILES ${AWS_PRICING-PLAN-MANAGER_SOURCE}) + source_group("Source Files\\model" FILES ${AWS_PRICING-PLAN-MANAGER_MODEL_SOURCE}) + endif(MSVC) +endif() + +set(PRICING-PLAN-MANAGER_INCLUDES + "${CMAKE_CURRENT_SOURCE_DIR}/include/" +) + +add_library(${PROJECT_NAME} ${PRICING-PLAN-MANAGER_SRC}) +add_library(AWS::${PROJECT_NAME} ALIAS ${PROJECT_NAME}) + +set_compiler_flags(${PROJECT_NAME}) +set_compiler_warnings(${PROJECT_NAME}) + +if(USE_WINDOWS_DLL_SEMANTICS AND BUILD_SHARED_LIBS) + target_compile_definitions(${PROJECT_NAME} PRIVATE "AWS_PRICINGPLANMANAGER_EXPORTS") +endif() + +target_include_directories(${PROJECT_NAME} PUBLIC + $ + $) + +target_link_libraries(${PROJECT_NAME} PRIVATE ${PLATFORM_DEP_LIBS} ${PROJECT_LIBS}) + + +setup_install() + +install (FILES ${AWS_PRICING-PLAN-MANAGER_HEADERS} DESTINATION ${INCLUDE_DIRECTORY}/aws/pricing-plan-manager) +install (FILES ${AWS_PRICING-PLAN-MANAGER_MODEL_HEADERS} DESTINATION ${INCLUDE_DIRECTORY}/aws/pricing-plan-manager/model) + +do_packaging() + + diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/PricingPlanManagerClient.h b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/PricingPlanManagerClient.h new file mode 100644 index 000000000000..affc6d003289 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/PricingPlanManagerClient.h @@ -0,0 +1,385 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include +#include +#include +#include +#include +#include + +namespace Aws { +namespace PricingPlanManager { +/** + *

Manages flat-rate pricing subscriptions for supported AWS services. Use this + * API to create, approve, update, and cancel subscriptions; associate and + * disassociate resources; and retrieve subscription details. With a flat-rate + * pricing subscription, you pay a fixed recurring fee for eligible resources + * instead of usage-based pricing.

+ */ +class AWS_PRICINGPLANMANAGER_API PricingPlanManagerClient : public Aws::Client::AWSJsonClient, + public Aws::Client::ClientWithAsyncTemplateMethods, + public PricingPlanManagerPaginationBase, + public PricingPlanManagerWaiter { + public: + typedef Aws::Client::AWSJsonClient BASECLASS; + static const char* GetServiceName(); + static const char* GetAllocationTag(); + + typedef PricingPlanManagerClientConfiguration ClientConfigurationType; + typedef PricingPlanManagerEndpointProvider EndpointProviderType; + + /** + * Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client + * config is not specified, it will be initialized to default values. + */ + PricingPlanManagerClient(const Aws::PricingPlanManager::PricingPlanManagerClientConfiguration& clientConfiguration = + Aws::PricingPlanManager::PricingPlanManagerClientConfiguration(), + std::shared_ptr endpointProvider = nullptr); + + /** + * Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config + * is not specified, it will be initialized to default values. + */ + PricingPlanManagerClient(const Aws::Auth::AWSCredentials& credentials, + std::shared_ptr endpointProvider = nullptr, + const Aws::PricingPlanManager::PricingPlanManagerClientConfiguration& clientConfiguration = + Aws::PricingPlanManager::PricingPlanManagerClientConfiguration()); + + /** + * Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, + * the default http client factory will be used + */ + PricingPlanManagerClient(const std::shared_ptr& credentialsProvider, + std::shared_ptr endpointProvider = nullptr, + const Aws::PricingPlanManager::PricingPlanManagerClientConfiguration& clientConfiguration = + Aws::PricingPlanManager::PricingPlanManagerClientConfiguration()); + + /* Legacy constructors due deprecation */ + /** + * Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client + * config is not specified, it will be initialized to default values. + */ + PricingPlanManagerClient(const Aws::Client::ClientConfiguration& clientConfiguration); + + /** + * Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config + * is not specified, it will be initialized to default values. + */ + PricingPlanManagerClient(const Aws::Auth::AWSCredentials& credentials, const Aws::Client::ClientConfiguration& clientConfiguration); + + /** + * Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, + * the default http client factory will be used + */ + PricingPlanManagerClient(const std::shared_ptr& credentialsProvider, + const Aws::Client::ClientConfiguration& clientConfiguration); + + /* End of legacy constructors due deprecation */ + virtual ~PricingPlanManagerClient(); + + /** + *

Approves a subscription that is in PENDING_APPROVAL status, + * activating it and starting billing.

This operation requires the + * current ETag value for concurrency control. Retrieve it from a + * previous GetSubscription or ListSubscriptions + * response.

See Also:

AWS + * API Reference

+ */ + virtual Model::ApprovePaidSubscriptionOutcome ApprovePaidSubscription(const Model::ApprovePaidSubscriptionRequest& request) const; + + /** + * A Callable wrapper for ApprovePaidSubscription that returns a future to the operation so that it can be executed in parallel to other + * requests. + */ + template + Model::ApprovePaidSubscriptionOutcomeCallable ApprovePaidSubscriptionCallable(const ApprovePaidSubscriptionRequestT& request) const { + return SubmitCallable(&PricingPlanManagerClient::ApprovePaidSubscription, request); + } + + /** + * An Async wrapper for ApprovePaidSubscription that queues the request into a thread executor and triggers associated callback when + * operation has finished. + */ + template + void ApprovePaidSubscriptionAsync(const ApprovePaidSubscriptionRequestT& request, + const ApprovePaidSubscriptionResponseReceivedHandler& handler, + const std::shared_ptr& context = nullptr) const { + return SubmitAsync(&PricingPlanManagerClient::ApprovePaidSubscription, request, handler, context); + } + + /** + *

Adds one or more resources to an existing subscription. The subscription must + * be in an active state that is not pending other changes.

For + * subscriptions in the CloudFront plan family, the associated resources must + * include exactly one Amazon CloudFront distribution and one AWS WAF web ACL. You + * can also include other supported resources, such as Amazon Route 53 hosted + * zones, and CloudFront KeyValueStores.

See Also:

AWS + * API Reference

+ */ + virtual Model::AssociateResourcesToSubscriptionOutcome AssociateResourcesToSubscription( + const Model::AssociateResourcesToSubscriptionRequest& request) const; + + /** + * A Callable wrapper for AssociateResourcesToSubscription that returns a future to the operation so that it can be executed in parallel + * to other requests. + */ + template + Model::AssociateResourcesToSubscriptionOutcomeCallable AssociateResourcesToSubscriptionCallable( + const AssociateResourcesToSubscriptionRequestT& request) const { + return SubmitCallable(&PricingPlanManagerClient::AssociateResourcesToSubscription, request); + } + + /** + * An Async wrapper for AssociateResourcesToSubscription that queues the request into a thread executor and triggers associated callback + * when operation has finished. + */ + template + void AssociateResourcesToSubscriptionAsync(const AssociateResourcesToSubscriptionRequestT& request, + const AssociateResourcesToSubscriptionResponseReceivedHandler& handler, + const std::shared_ptr& context = nullptr) const { + return SubmitAsync(&PricingPlanManagerClient::AssociateResourcesToSubscription, request, handler, context); + } + + /** + *

Cancels a flat-rate pricing subscription.

For active + * subscriptions, the cancellation is scheduled to take effect at the end of the + * current billing period. The subscription remains active until that date. To + * revert a pending cancellation, use CancelSubscriptionChange.

+ *

For subscriptions in PENDING_APPROVAL status, the subscription + * is deleted immediately without scheduling.

See Also:

AWS + * API Reference

+ */ + virtual Model::CancelSubscriptionOutcome CancelSubscription(const Model::CancelSubscriptionRequest& request) const; + + /** + * A Callable wrapper for CancelSubscription that returns a future to the operation so that it can be executed in parallel to other + * requests. + */ + template + Model::CancelSubscriptionOutcomeCallable CancelSubscriptionCallable(const CancelSubscriptionRequestT& request) const { + return SubmitCallable(&PricingPlanManagerClient::CancelSubscription, request); + } + + /** + * An Async wrapper for CancelSubscription that queues the request into a thread executor and triggers associated callback when operation + * has finished. + */ + template + void CancelSubscriptionAsync(const CancelSubscriptionRequestT& request, const CancelSubscriptionResponseReceivedHandler& handler, + const std::shared_ptr& context = nullptr) const { + return SubmitAsync(&PricingPlanManagerClient::CancelSubscription, request, handler, context); + } + + /** + *

Cancels a pending scheduled change on a subscription, such as a pending + * downgrade or cancellation. The subscription returns to its state before the + * change was scheduled.

You cannot cancel a scheduled change close + * to its effective date. If the change is within the processing window, this + * operation returns an error.

See Also:

AWS + * API Reference

+ */ + virtual Model::CancelSubscriptionChangeOutcome CancelSubscriptionChange(const Model::CancelSubscriptionChangeRequest& request) const; + + /** + * A Callable wrapper for CancelSubscriptionChange that returns a future to the operation so that it can be executed in parallel to other + * requests. + */ + template + Model::CancelSubscriptionChangeOutcomeCallable CancelSubscriptionChangeCallable(const CancelSubscriptionChangeRequestT& request) const { + return SubmitCallable(&PricingPlanManagerClient::CancelSubscriptionChange, request); + } + + /** + * An Async wrapper for CancelSubscriptionChange that queues the request into a thread executor and triggers associated callback when + * operation has finished. + */ + template + void CancelSubscriptionChangeAsync(const CancelSubscriptionChangeRequestT& request, + const CancelSubscriptionChangeResponseReceivedHandler& handler, + const std::shared_ptr& context = nullptr) const { + return SubmitAsync(&PricingPlanManagerClient::CancelSubscriptionChange, request, handler, context); + } + + /** + *

Creates a flat-rate pricing subscription for the specified resources.

+ *

When approvalMode is set to MANUAL, + * paid-tier subscriptions are created in PENDING_APPROVAL status and + * require a separate ApprovePaidSubscription call before billing + * starts. Free-tier subscriptions are always activated immediately regardless of + * approval mode.

When approvalMode is set to + * IMMEDIATE or is not specified, the subscription is activated + * immediately.

See Also:

AWS + * API Reference

+ */ + virtual Model::CreateSubscriptionOutcome CreateSubscription(const Model::CreateSubscriptionRequest& request) const; + + /** + * A Callable wrapper for CreateSubscription that returns a future to the operation so that it can be executed in parallel to other + * requests. + */ + template + Model::CreateSubscriptionOutcomeCallable CreateSubscriptionCallable(const CreateSubscriptionRequestT& request) const { + return SubmitCallable(&PricingPlanManagerClient::CreateSubscription, request); + } + + /** + * An Async wrapper for CreateSubscription that queues the request into a thread executor and triggers associated callback when operation + * has finished. + */ + template + void CreateSubscriptionAsync(const CreateSubscriptionRequestT& request, const CreateSubscriptionResponseReceivedHandler& handler, + const std::shared_ptr& context = nullptr) const { + return SubmitAsync(&PricingPlanManagerClient::CreateSubscription, request, handler, context); + } + + /** + *

Removes one or more resources from an existing subscription.

+ *

For subscriptions in the CloudFront plan family, the associated resources + * must always include exactly one Amazon CloudFront distribution and exactly one + * AWS WAF web ACL. You cannot remove these required resources.

+ *

See Also:

AWS + * API Reference

+ */ + virtual Model::DisassociateResourcesFromSubscriptionOutcome DisassociateResourcesFromSubscription( + const Model::DisassociateResourcesFromSubscriptionRequest& request) const; + + /** + * A Callable wrapper for DisassociateResourcesFromSubscription that returns a future to the operation so that it can be executed in + * parallel to other requests. + */ + template + Model::DisassociateResourcesFromSubscriptionOutcomeCallable DisassociateResourcesFromSubscriptionCallable( + const DisassociateResourcesFromSubscriptionRequestT& request) const { + return SubmitCallable(&PricingPlanManagerClient::DisassociateResourcesFromSubscription, request); + } + + /** + * An Async wrapper for DisassociateResourcesFromSubscription that queues the request into a thread executor and triggers associated + * callback when operation has finished. + */ + template + void DisassociateResourcesFromSubscriptionAsync(const DisassociateResourcesFromSubscriptionRequestT& request, + const DisassociateResourcesFromSubscriptionResponseReceivedHandler& handler, + const std::shared_ptr& context = nullptr) const { + return SubmitAsync(&PricingPlanManagerClient::DisassociateResourcesFromSubscription, request, handler, context); + } + + /** + *

Returns the details of a flat-rate pricing subscription, including its + * current status, associated resources, and any pending scheduled + * changes.

See Also:

AWS + * API Reference

+ */ + virtual Model::GetSubscriptionOutcome GetSubscription(const Model::GetSubscriptionRequest& request) const; + + /** + * A Callable wrapper for GetSubscription that returns a future to the operation so that it can be executed in parallel to other requests. + */ + template + Model::GetSubscriptionOutcomeCallable GetSubscriptionCallable(const GetSubscriptionRequestT& request) const { + return SubmitCallable(&PricingPlanManagerClient::GetSubscription, request); + } + + /** + * An Async wrapper for GetSubscription that queues the request into a thread executor and triggers associated callback when operation has + * finished. + */ + template + void GetSubscriptionAsync(const GetSubscriptionRequestT& request, const GetSubscriptionResponseReceivedHandler& handler, + const std::shared_ptr& context = nullptr) const { + return SubmitAsync(&PricingPlanManagerClient::GetSubscription, request, handler, context); + } + + /** + *

Returns a summary of all flat-rate pricing subscriptions in the calling + * account.

See Also:

AWS + * API Reference

+ */ + virtual Model::ListSubscriptionsOutcome ListSubscriptions(const Model::ListSubscriptionsRequest& request = {}) const; + + /** + * A Callable wrapper for ListSubscriptions that returns a future to the operation so that it can be executed in parallel to other + * requests. + */ + template + Model::ListSubscriptionsOutcomeCallable ListSubscriptionsCallable(const ListSubscriptionsRequestT& request = {}) const { + return SubmitCallable(&PricingPlanManagerClient::ListSubscriptions, request); + } + + /** + * An Async wrapper for ListSubscriptions that queues the request into a thread executor and triggers associated callback when operation + * has finished. + */ + template + void ListSubscriptionsAsync(const ListSubscriptionsResponseReceivedHandler& handler, + const std::shared_ptr& context = nullptr, + const ListSubscriptionsRequestT& request = {}) const { + return SubmitAsync(&PricingPlanManagerClient::ListSubscriptions, request, handler, context); + } + + /** + *

Changes the plan tier of an existing subscription.

Upgrades + * take effect immediately. Downgrades are scheduled and the current tier remains + * unchanged until the end of the billing cycle (calendar month). You cannot update + * a subscription while a scheduled change is pending. To make a new change, first + * cancel the pending change using CancelSubscriptionChange.

+ *

This operation replaces the plan tier value. If you omit the optional + * usageLevel field, it is reset to the default.

See + * Also:

AWS + * API Reference

+ */ + virtual Model::UpdateSubscriptionOutcome UpdateSubscription(const Model::UpdateSubscriptionRequest& request) const; + + /** + * A Callable wrapper for UpdateSubscription that returns a future to the operation so that it can be executed in parallel to other + * requests. + */ + template + Model::UpdateSubscriptionOutcomeCallable UpdateSubscriptionCallable(const UpdateSubscriptionRequestT& request) const { + return SubmitCallable(&PricingPlanManagerClient::UpdateSubscription, request); + } + + /** + * An Async wrapper for UpdateSubscription that queues the request into a thread executor and triggers associated callback when operation + * has finished. + */ + template + void UpdateSubscriptionAsync(const UpdateSubscriptionRequestT& request, const UpdateSubscriptionResponseReceivedHandler& handler, + const std::shared_ptr& context = nullptr) const { + return SubmitAsync(&PricingPlanManagerClient::UpdateSubscription, request, handler, context); + } + + virtual void OverrideEndpoint(const Aws::String& endpoint); + virtual std::shared_ptr& accessEndpointProvider(); + + private: + friend class Aws::Client::ClientWithAsyncTemplateMethods; + void init(const PricingPlanManagerClientConfiguration& clientConfiguration); + + typedef Aws::Utils::Outcome, PricingPlanManagerError> InvokeOperationOutcome; + + InvokeOperationOutcome InvokeServiceOperation(const AmazonWebServiceRequest& request, + const std::function& resolveUri, + Aws::Http::HttpMethod httpMethod) const; + + PricingPlanManagerClientConfiguration m_clientConfiguration; + std::shared_ptr m_endpointProvider; +}; + +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/PricingPlanManagerClientPagination.h b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/PricingPlanManagerClientPagination.h new file mode 100644 index 000000000000..0ed0e66469c7 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/PricingPlanManagerClientPagination.h @@ -0,0 +1,19 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include + +namespace Aws { +namespace PricingPlanManager { + +using ListSubscriptionsPaginator = + Aws::Utils::Pagination::Paginator>; + +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/PricingPlanManagerEndpointProvider.h b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/PricingPlanManagerEndpointProvider.h new file mode 100644 index 000000000000..3a7faf0db68a --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/PricingPlanManagerEndpointProvider.h @@ -0,0 +1,52 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include +#include +#include +#include + +namespace Aws { +namespace PricingPlanManager { +namespace Endpoint { +using EndpointParameters = Aws::Endpoint::EndpointParameters; +using Aws::Endpoint::DefaultEndpointProvider; +using Aws::Endpoint::EndpointProviderBase; + +using PricingPlanManagerClientContextParameters = Aws::Endpoint::ClientContextParameters; + +using PricingPlanManagerClientConfiguration = Aws::Client::GenericClientConfiguration; +using PricingPlanManagerBuiltInParameters = Aws::Endpoint::BuiltInParameters; + +/** + * The type for the PricingPlanManager Client Endpoint Provider. + * Inherit from this Base class / "Interface" should you want to provide a custom endpoint provider. + * The SDK must use service-specific type for each service per specification. + */ +using PricingPlanManagerEndpointProviderBase = + EndpointProviderBase; + +using PricingPlanManagerDefaultEpProviderBase = + DefaultEndpointProvider; + +/** + * Default endpoint provider used for this service + */ +class AWS_PRICINGPLANMANAGER_API PricingPlanManagerEndpointProvider : public PricingPlanManagerDefaultEpProviderBase { + public: + using PricingPlanManagerResolveEndpointOutcome = Aws::Endpoint::ResolveEndpointOutcome; + + PricingPlanManagerEndpointProvider(); + + ~PricingPlanManagerEndpointProvider() {} +}; +} // namespace Endpoint +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/PricingPlanManagerErrorMarshaller.h b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/PricingPlanManagerErrorMarshaller.h new file mode 100644 index 000000000000..8070768e65cc --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/PricingPlanManagerErrorMarshaller.h @@ -0,0 +1,20 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once + +#include +#include + +namespace Aws { +namespace Client { + +class AWS_PRICINGPLANMANAGER_API PricingPlanManagerErrorMarshaller : public Aws::Client::JsonErrorMarshaller { + public: + Aws::Client::AWSError FindErrorByName(const char* exceptionName) const override; +}; + +} // namespace Client +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/PricingPlanManagerErrors.h b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/PricingPlanManagerErrors.h new file mode 100644 index 000000000000..00a54c40efb5 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/PricingPlanManagerErrors.h @@ -0,0 +1,71 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once + +#include +#include +#include + +namespace Aws { +namespace PricingPlanManager { +enum class PricingPlanManagerErrors { + // From Core// + ////////////////////////////////////////////////////////////////////////////////////////// + INCOMPLETE_SIGNATURE = 0, + INTERNAL_FAILURE = 1, + INVALID_ACTION = 2, + INVALID_CLIENT_TOKEN_ID = 3, + INVALID_PARAMETER_COMBINATION = 4, + INVALID_QUERY_PARAMETER = 5, + INVALID_PARAMETER_VALUE = 6, + MISSING_ACTION = 7, // SDK should never allow + MISSING_AUTHENTICATION_TOKEN = 8, // SDK should never allow + MISSING_PARAMETER = 9, // SDK should never allow + OPT_IN_REQUIRED = 10, + REQUEST_EXPIRED = 11, + SERVICE_UNAVAILABLE = 12, + THROTTLING = 13, + VALIDATION = 14, + ACCESS_DENIED = 15, + RESOURCE_NOT_FOUND = 16, + UNRECOGNIZED_CLIENT = 17, + MALFORMED_QUERY_STRING = 18, + SLOW_DOWN = 19, + REQUEST_TIME_TOO_SKEWED = 20, + INVALID_SIGNATURE = 21, + SIGNATURE_DOES_NOT_MATCH = 22, + INVALID_ACCESS_KEY_ID = 23, + REQUEST_TIMEOUT = 24, + NETWORK_CONNECTION = 99, + + UNKNOWN = 100, + /////////////////////////////////////////////////////////////////////////////////////////// + + CONFLICT = static_cast(Aws::Client::CoreErrors::SERVICE_EXTENSION_START_RANGE) + 1, + INTERNAL_SERVER, + SERVICE_QUOTA_EXCEEDED +}; + +class AWS_PRICINGPLANMANAGER_API PricingPlanManagerError : public Aws::Client::AWSError { + public: + PricingPlanManagerError() {} + PricingPlanManagerError(const Aws::Client::AWSError& rhs) + : Aws::Client::AWSError(rhs) {} + PricingPlanManagerError(Aws::Client::AWSError&& rhs) : Aws::Client::AWSError(rhs) {} + PricingPlanManagerError(const Aws::Client::AWSError& rhs) + : Aws::Client::AWSError(rhs) {} + PricingPlanManagerError(Aws::Client::AWSError&& rhs) : Aws::Client::AWSError(rhs) {} + + template + T GetModeledError(); +}; + +namespace PricingPlanManagerErrorMapper { +AWS_PRICINGPLANMANAGER_API Aws::Client::AWSError GetErrorForName(const char* errorName); +} + +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/PricingPlanManagerPaginationBase.h b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/PricingPlanManagerPaginationBase.h new file mode 100644 index 000000000000..cb36fd9ef2d9 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/PricingPlanManagerPaginationBase.h @@ -0,0 +1,33 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once + +#include +#include +#include + +#include + +namespace Aws { +namespace PricingPlanManager { + +template +class PricingPlanManagerPaginationBase { + public: + /** + * Create a paginator for ListSubscriptions operation + */ + Aws::Utils::Pagination::Paginator> + ListSubscriptionsPaginator(const Model::ListSubscriptionsRequest& request) { + request.AddUserAgentFeature(Aws::Client::UserAgentFeature::PAGINATOR); + return Aws::Utils::Pagination::Paginator>{ + static_cast(this), request}; + } +}; +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/PricingPlanManagerRequest.h b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/PricingPlanManagerRequest.h new file mode 100644 index 000000000000..7d3fdcf96e52 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/PricingPlanManagerRequest.h @@ -0,0 +1,39 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include +#include +#include + +namespace Aws { +namespace PricingPlanManager { +class AWS_PRICINGPLANMANAGER_API PricingPlanManagerRequest : public Aws::AmazonSerializableWebServiceRequest { + public: + using EndpointParameter = Aws::Endpoint::EndpointParameter; + using EndpointParameters = Aws::Endpoint::EndpointParameters; + + virtual ~PricingPlanManagerRequest() {} + + void AddParametersToRequest(Aws::Http::HttpRequest& httpRequest) const { AWS_UNREFERENCED_PARAM(httpRequest); } + + inline Aws::Http::HeaderValueCollection GetHeaders() const override { + auto headers = GetRequestSpecificHeaders(); + + if (headers.size() == 0 || (headers.size() > 0 && headers.count(Aws::Http::CONTENT_TYPE_HEADER) == 0)) { + headers.emplace(Aws::Http::HeaderValuePair(Aws::Http::CONTENT_TYPE_HEADER, Aws::JSON_CONTENT_TYPE)); + } + headers.emplace(Aws::Http::HeaderValuePair(Aws::Http::API_VERSION_HEADER, "2025-08-05")); + return headers; + } + + protected: + virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const { return Aws::Http::HeaderValueCollection(); } +}; + +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/PricingPlanManagerServiceClientModel.h b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/PricingPlanManagerServiceClientModel.h new file mode 100644 index 000000000000..af95f4436b7b --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/PricingPlanManagerServiceClientModel.h @@ -0,0 +1,136 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once + +/* Generic header includes */ +#include +#include +#include +#include +#include +#include +#include + +#include +#include +/* End of generic header includes */ + +/* Service model headers required in PricingPlanManagerClient header */ +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +/* End of service model headers required in PricingPlanManagerClient header */ + +namespace Aws { +namespace Http { +class HttpClient; +class HttpClientFactory; +} // namespace Http + +namespace Utils { +template +class Outcome; + +namespace Threading { +class Executor; +} // namespace Threading +} // namespace Utils + +namespace Auth { +class AWSCredentials; +class AWSCredentialsProvider; +} // namespace Auth + +namespace Client { +class RetryStrategy; +} // namespace Client + +namespace PricingPlanManager { +using PricingPlanManagerClientConfiguration = Aws::Client::GenericClientConfiguration; +using PricingPlanManagerEndpointProviderBase = Aws::PricingPlanManager::Endpoint::PricingPlanManagerEndpointProviderBase; +using PricingPlanManagerEndpointProvider = Aws::PricingPlanManager::Endpoint::PricingPlanManagerEndpointProvider; + +namespace Model { +/* Service model forward declarations required in PricingPlanManagerClient header */ +class ApprovePaidSubscriptionRequest; +class AssociateResourcesToSubscriptionRequest; +class CancelSubscriptionRequest; +class CancelSubscriptionChangeRequest; +class CreateSubscriptionRequest; +class DisassociateResourcesFromSubscriptionRequest; +class GetSubscriptionRequest; +class ListSubscriptionsRequest; +class UpdateSubscriptionRequest; +/* End of service model forward declarations required in PricingPlanManagerClient header */ + +/* Service model Outcome class definitions */ +typedef Aws::Utils::Outcome ApprovePaidSubscriptionOutcome; +typedef Aws::Utils::Outcome AssociateResourcesToSubscriptionOutcome; +typedef Aws::Utils::Outcome CancelSubscriptionOutcome; +typedef Aws::Utils::Outcome CancelSubscriptionChangeOutcome; +typedef Aws::Utils::Outcome CreateSubscriptionOutcome; +typedef Aws::Utils::Outcome + DisassociateResourcesFromSubscriptionOutcome; +typedef Aws::Utils::Outcome GetSubscriptionOutcome; +typedef Aws::Utils::Outcome ListSubscriptionsOutcome; +typedef Aws::Utils::Outcome UpdateSubscriptionOutcome; +/* End of service model Outcome class definitions */ + +/* Service model Outcome callable definitions */ +typedef std::future ApprovePaidSubscriptionOutcomeCallable; +typedef std::future AssociateResourcesToSubscriptionOutcomeCallable; +typedef std::future CancelSubscriptionOutcomeCallable; +typedef std::future CancelSubscriptionChangeOutcomeCallable; +typedef std::future CreateSubscriptionOutcomeCallable; +typedef std::future DisassociateResourcesFromSubscriptionOutcomeCallable; +typedef std::future GetSubscriptionOutcomeCallable; +typedef std::future ListSubscriptionsOutcomeCallable; +typedef std::future UpdateSubscriptionOutcomeCallable; +/* End of service model Outcome callable definitions */ +} // namespace Model + +class PricingPlanManagerClient; + +/* Service model async handlers definitions */ +typedef std::function&)> + ApprovePaidSubscriptionResponseReceivedHandler; +typedef std::function&)> + AssociateResourcesToSubscriptionResponseReceivedHandler; +typedef std::function&)> + CancelSubscriptionResponseReceivedHandler; +typedef std::function&)> + CancelSubscriptionChangeResponseReceivedHandler; +typedef std::function&)> + CreateSubscriptionResponseReceivedHandler; +typedef std::function&)> + DisassociateResourcesFromSubscriptionResponseReceivedHandler; +typedef std::function&)> + GetSubscriptionResponseReceivedHandler; +typedef std::function&)> + ListSubscriptionsResponseReceivedHandler; +typedef std::function&)> + UpdateSubscriptionResponseReceivedHandler; +/* End of service model async handlers definitions */ +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/PricingPlanManagerWaiter.h b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/PricingPlanManagerWaiter.h new file mode 100644 index 000000000000..2440d2800cc9 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/PricingPlanManagerWaiter.h @@ -0,0 +1,21 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include + +#include + +namespace Aws { +namespace PricingPlanManager { + +template +class PricingPlanManagerWaiter { + public: +}; +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/PricingPlanManager_EXPORTS.h b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/PricingPlanManager_EXPORTS.h new file mode 100644 index 000000000000..d9f04f1c9a5e --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/PricingPlanManager_EXPORTS.h @@ -0,0 +1,38 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once + +#ifdef _MSC_VER +// disable windows complaining about max template size. +#pragma warning(disable : 4503) +#endif // _MSC_VER + +#if defined(USE_WINDOWS_DLL_SEMANTICS) || defined(_WIN32) +#ifdef _MSC_VER +#pragma warning(disable : 4251) +#endif // _MSC_VER + +#ifdef USE_IMPORT_EXPORT +#ifdef AWS_PRICINGPLANMANAGER_EXPORTS +#define AWS_PRICINGPLANMANAGER_API __declspec(dllexport) +#else +#define AWS_PRICINGPLANMANAGER_API __declspec(dllimport) +#endif /* AWS_PRICINGPLANMANAGER_EXPORTS */ +#define AWS_PRICINGPLANMANAGER_EXTERN +#else +#define AWS_PRICINGPLANMANAGER_API +#define AWS_PRICINGPLANMANAGER_EXTERN extern +#endif // USE_IMPORT_EXPORT +#define AWS_PRICINGPLANMANAGER_LOCAL +#else // defined (USE_WINDOWS_DLL_SEMANTICS) || defined (WIN32) +#define AWS_PRICINGPLANMANAGER_API +#define AWS_PRICINGPLANMANAGER_EXTERN extern +#if __GNUC__ >= 4 +#define AWS_PRICINGPLANMANAGER_LOCAL __attribute__((visibility("hidden"))) +#else +#define AWS_PRICINGPLANMANAGER_LOCAL +#endif +#endif // defined (USE_WINDOWS_DLL_SEMANTICS) || defined (WIN32) diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/internal/PricingPlanManagerEndpointRules.h b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/internal/PricingPlanManagerEndpointRules.h new file mode 100644 index 000000000000..ee3356abebd6 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/internal/PricingPlanManagerEndpointRules.h @@ -0,0 +1,21 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include + +#include + +namespace Aws { +namespace PricingPlanManager { +class AWS_PRICINGPLANMANAGER_LOCAL PricingPlanManagerEndpointRules { + public: + static const size_t RulesBlobStrLen; + static const size_t RulesBlobSize; + + static const char* GetRulesBlob(); +}; +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ApprovalMode.h b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ApprovalMode.h new file mode 100644 index 000000000000..53b5d3afd520 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ApprovalMode.h @@ -0,0 +1,22 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include + +namespace Aws { +namespace PricingPlanManager { +namespace Model { +enum class ApprovalMode { NOT_SET, MANUAL, IMMEDIATE }; + +namespace ApprovalModeMapper { +AWS_PRICINGPLANMANAGER_API ApprovalMode GetApprovalModeForName(const Aws::String& name); + +AWS_PRICINGPLANMANAGER_API Aws::String GetNameForApprovalMode(ApprovalMode value); +} // namespace ApprovalModeMapper +} // namespace Model +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ApprovePaidSubscriptionRequest.h b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ApprovePaidSubscriptionRequest.h new file mode 100644 index 000000000000..762e7ec19814 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ApprovePaidSubscriptionRequest.h @@ -0,0 +1,103 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include +#include + +#include + +namespace Aws { +namespace PricingPlanManager { +namespace Model { + +/** + */ +class ApprovePaidSubscriptionRequest : public PricingPlanManagerRequest { + public: + AWS_PRICINGPLANMANAGER_API ApprovePaidSubscriptionRequest() = default; + + // Service request name is the Operation name which will send this request out, + // each operation should has unique request name, so that we can get operation's name from this request. + // Note: this is not true for response, multiple operations may have the same response name, + // so we can not get operation's name from response. + inline virtual const char* GetServiceRequestName() const override { return "ApprovePaidSubscription"; } + + AWS_PRICINGPLANMANAGER_API Aws::String SerializePayload() const override; + + AWS_PRICINGPLANMANAGER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; + + ///@{ + /** + *

The ARN of the subscription to approve.

+ */ + inline const Aws::String& GetArn() const { return m_arn; } + inline bool ArnHasBeenSet() const { return m_arnHasBeenSet; } + template + void SetArn(ArnT&& value) { + m_arnHasBeenSet = true; + m_arn = std::forward(value); + } + template + ApprovePaidSubscriptionRequest& WithArn(ArnT&& value) { + SetArn(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The ETag value from a previous GetSubscription or + * ListSubscriptions response. This ensures you are approving the + * expected version of the subscription.

+ */ + inline const Aws::String& GetIfMatch() const { return m_ifMatch; } + inline bool IfMatchHasBeenSet() const { return m_ifMatchHasBeenSet; } + template + void SetIfMatch(IfMatchT&& value) { + m_ifMatchHasBeenSet = true; + m_ifMatch = std::forward(value); + } + template + ApprovePaidSubscriptionRequest& WithIfMatch(IfMatchT&& value) { + SetIfMatch(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

A unique, case-sensitive identifier that you provide to ensure the request is + * handled only once.

+ */ + inline const Aws::String& GetClientToken() const { return m_clientToken; } + inline bool ClientTokenHasBeenSet() const { return m_clientTokenHasBeenSet; } + template + void SetClientToken(ClientTokenT&& value) { + m_clientTokenHasBeenSet = true; + m_clientToken = std::forward(value); + } + template + ApprovePaidSubscriptionRequest& WithClientToken(ClientTokenT&& value) { + SetClientToken(std::forward(value)); + return *this; + } + ///@} + private: + Aws::String m_arn; + + Aws::String m_ifMatch; + + Aws::String m_clientToken{Aws::Utils::UUID::PseudoRandomUUID()}; + bool m_arnHasBeenSet = false; + bool m_ifMatchHasBeenSet = false; + bool m_clientTokenHasBeenSet = true; +}; + +} // namespace Model +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ApprovePaidSubscriptionResult.h b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ApprovePaidSubscriptionResult.h new file mode 100644 index 000000000000..9398acda1609 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ApprovePaidSubscriptionResult.h @@ -0,0 +1,96 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include +#include + +#include + +namespace Aws { +template +class AmazonWebServiceResult; + +namespace Utils { +namespace Json { +class JsonValue; +} // namespace Json +} // namespace Utils +namespace PricingPlanManager { +namespace Model { +class ApprovePaidSubscriptionResult { + public: + AWS_PRICINGPLANMANAGER_API ApprovePaidSubscriptionResult() = default; + AWS_PRICINGPLANMANAGER_API ApprovePaidSubscriptionResult(const Aws::AmazonWebServiceResult& result); + AWS_PRICINGPLANMANAGER_API ApprovePaidSubscriptionResult& operator=( + const Aws::AmazonWebServiceResult& result); + + ///@{ + /** + *

The details of the approved subscription.

+ */ + inline const Subscription& GetSubscription() const { return m_subscription; } + template + void SetSubscription(SubscriptionT&& value) { + m_subscriptionHasBeenSet = true; + m_subscription = std::forward(value); + } + template + ApprovePaidSubscriptionResult& WithSubscription(SubscriptionT&& value) { + SetSubscription(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The updated entity tag for concurrency control.

+ */ + inline const Aws::String& GetETag() const { return m_eTag; } + template + void SetETag(ETagT&& value) { + m_eTagHasBeenSet = true; + m_eTag = std::forward(value); + } + template + ApprovePaidSubscriptionResult& WithETag(ETagT&& value) { + SetETag(std::forward(value)); + return *this; + } + ///@} + + ///@{ + + inline const Aws::String& GetRequestId() const { return m_requestId; } + template + void SetRequestId(RequestIdT&& value) { + m_requestIdHasBeenSet = true; + m_requestId = std::forward(value); + } + template + ApprovePaidSubscriptionResult& WithRequestId(RequestIdT&& value) { + SetRequestId(std::forward(value)); + return *this; + } + ///@} + inline Aws::Http::HttpResponseCode GetHttpResponseCode() const { return m_HttpResponseCode; } + + private: + Subscription m_subscription; + + Aws::String m_eTag; + + Aws::String m_requestId; + Aws::Http::HttpResponseCode m_HttpResponseCode; + bool m_subscriptionHasBeenSet = false; + bool m_eTagHasBeenSet = false; + bool m_requestIdHasBeenSet = false; +}; + +} // namespace Model +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/AssociateResourcesToSubscriptionRequest.h b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/AssociateResourcesToSubscriptionRequest.h new file mode 100644 index 000000000000..c8e05b818cb8 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/AssociateResourcesToSubscriptionRequest.h @@ -0,0 +1,130 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include +#include +#include + +#include + +namespace Aws { +namespace PricingPlanManager { +namespace Model { + +/** + */ +class AssociateResourcesToSubscriptionRequest : public PricingPlanManagerRequest { + public: + AWS_PRICINGPLANMANAGER_API AssociateResourcesToSubscriptionRequest() = default; + + // Service request name is the Operation name which will send this request out, + // each operation should has unique request name, so that we can get operation's name from this request. + // Note: this is not true for response, multiple operations may have the same response name, + // so we can not get operation's name from response. + inline virtual const char* GetServiceRequestName() const override { return "AssociateResourcesToSubscription"; } + + AWS_PRICINGPLANMANAGER_API Aws::String SerializePayload() const override; + + AWS_PRICINGPLANMANAGER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; + + ///@{ + /** + *

The ARN of the subscription to add resources to.

+ */ + inline const Aws::String& GetArn() const { return m_arn; } + inline bool ArnHasBeenSet() const { return m_arnHasBeenSet; } + template + void SetArn(ArnT&& value) { + m_arnHasBeenSet = true; + m_arn = std::forward(value); + } + template + AssociateResourcesToSubscriptionRequest& WithArn(ArnT&& value) { + SetArn(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The ARNs of the resources to add to the subscription.

+ */ + inline const Aws::Vector& GetResourceArns() const { return m_resourceArns; } + inline bool ResourceArnsHasBeenSet() const { return m_resourceArnsHasBeenSet; } + template > + void SetResourceArns(ResourceArnsT&& value) { + m_resourceArnsHasBeenSet = true; + m_resourceArns = std::forward(value); + } + template > + AssociateResourcesToSubscriptionRequest& WithResourceArns(ResourceArnsT&& value) { + SetResourceArns(std::forward(value)); + return *this; + } + template + AssociateResourcesToSubscriptionRequest& AddResourceArns(ResourceArnsT&& value) { + m_resourceArnsHasBeenSet = true; + m_resourceArns.emplace_back(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The ETag value from a previous GetSubscription or + * ListSubscriptions response.

+ */ + inline const Aws::String& GetIfMatch() const { return m_ifMatch; } + inline bool IfMatchHasBeenSet() const { return m_ifMatchHasBeenSet; } + template + void SetIfMatch(IfMatchT&& value) { + m_ifMatchHasBeenSet = true; + m_ifMatch = std::forward(value); + } + template + AssociateResourcesToSubscriptionRequest& WithIfMatch(IfMatchT&& value) { + SetIfMatch(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

A unique, case-sensitive identifier that you provide to ensure the request is + * handled only once.

+ */ + inline const Aws::String& GetClientToken() const { return m_clientToken; } + inline bool ClientTokenHasBeenSet() const { return m_clientTokenHasBeenSet; } + template + void SetClientToken(ClientTokenT&& value) { + m_clientTokenHasBeenSet = true; + m_clientToken = std::forward(value); + } + template + AssociateResourcesToSubscriptionRequest& WithClientToken(ClientTokenT&& value) { + SetClientToken(std::forward(value)); + return *this; + } + ///@} + private: + Aws::String m_arn; + + Aws::Vector m_resourceArns; + + Aws::String m_ifMatch; + + Aws::String m_clientToken{Aws::Utils::UUID::PseudoRandomUUID()}; + bool m_arnHasBeenSet = false; + bool m_resourceArnsHasBeenSet = false; + bool m_ifMatchHasBeenSet = false; + bool m_clientTokenHasBeenSet = true; +}; + +} // namespace Model +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/AssociateResourcesToSubscriptionResult.h b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/AssociateResourcesToSubscriptionResult.h new file mode 100644 index 000000000000..8120c1e88d76 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/AssociateResourcesToSubscriptionResult.h @@ -0,0 +1,96 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include +#include + +#include + +namespace Aws { +template +class AmazonWebServiceResult; + +namespace Utils { +namespace Json { +class JsonValue; +} // namespace Json +} // namespace Utils +namespace PricingPlanManager { +namespace Model { +class AssociateResourcesToSubscriptionResult { + public: + AWS_PRICINGPLANMANAGER_API AssociateResourcesToSubscriptionResult() = default; + AWS_PRICINGPLANMANAGER_API AssociateResourcesToSubscriptionResult(const Aws::AmazonWebServiceResult& result); + AWS_PRICINGPLANMANAGER_API AssociateResourcesToSubscriptionResult& operator=( + const Aws::AmazonWebServiceResult& result); + + ///@{ + /** + *

The details of the subscription with the newly added resources.

+ */ + inline const Subscription& GetSubscription() const { return m_subscription; } + template + void SetSubscription(SubscriptionT&& value) { + m_subscriptionHasBeenSet = true; + m_subscription = std::forward(value); + } + template + AssociateResourcesToSubscriptionResult& WithSubscription(SubscriptionT&& value) { + SetSubscription(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The updated entity tag for concurrency control.

+ */ + inline const Aws::String& GetETag() const { return m_eTag; } + template + void SetETag(ETagT&& value) { + m_eTagHasBeenSet = true; + m_eTag = std::forward(value); + } + template + AssociateResourcesToSubscriptionResult& WithETag(ETagT&& value) { + SetETag(std::forward(value)); + return *this; + } + ///@} + + ///@{ + + inline const Aws::String& GetRequestId() const { return m_requestId; } + template + void SetRequestId(RequestIdT&& value) { + m_requestIdHasBeenSet = true; + m_requestId = std::forward(value); + } + template + AssociateResourcesToSubscriptionResult& WithRequestId(RequestIdT&& value) { + SetRequestId(std::forward(value)); + return *this; + } + ///@} + inline Aws::Http::HttpResponseCode GetHttpResponseCode() const { return m_HttpResponseCode; } + + private: + Subscription m_subscription; + + Aws::String m_eTag; + + Aws::String m_requestId; + Aws::Http::HttpResponseCode m_HttpResponseCode; + bool m_subscriptionHasBeenSet = false; + bool m_eTagHasBeenSet = false; + bool m_requestIdHasBeenSet = false; +}; + +} // namespace Model +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/CancelSubscriptionChangeRequest.h b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/CancelSubscriptionChangeRequest.h new file mode 100644 index 000000000000..ae582cb35c00 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/CancelSubscriptionChangeRequest.h @@ -0,0 +1,102 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include +#include + +#include + +namespace Aws { +namespace PricingPlanManager { +namespace Model { + +/** + */ +class CancelSubscriptionChangeRequest : public PricingPlanManagerRequest { + public: + AWS_PRICINGPLANMANAGER_API CancelSubscriptionChangeRequest() = default; + + // Service request name is the Operation name which will send this request out, + // each operation should has unique request name, so that we can get operation's name from this request. + // Note: this is not true for response, multiple operations may have the same response name, + // so we can not get operation's name from response. + inline virtual const char* GetServiceRequestName() const override { return "CancelSubscriptionChange"; } + + AWS_PRICINGPLANMANAGER_API Aws::String SerializePayload() const override; + + AWS_PRICINGPLANMANAGER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; + + ///@{ + /** + *

The ARN of the subscription whose pending change you want to cancel.

+ */ + inline const Aws::String& GetArn() const { return m_arn; } + inline bool ArnHasBeenSet() const { return m_arnHasBeenSet; } + template + void SetArn(ArnT&& value) { + m_arnHasBeenSet = true; + m_arn = std::forward(value); + } + template + CancelSubscriptionChangeRequest& WithArn(ArnT&& value) { + SetArn(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The ETag value from a previous GetSubscription or + * ListSubscriptions response.

+ */ + inline const Aws::String& GetIfMatch() const { return m_ifMatch; } + inline bool IfMatchHasBeenSet() const { return m_ifMatchHasBeenSet; } + template + void SetIfMatch(IfMatchT&& value) { + m_ifMatchHasBeenSet = true; + m_ifMatch = std::forward(value); + } + template + CancelSubscriptionChangeRequest& WithIfMatch(IfMatchT&& value) { + SetIfMatch(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

A unique, case-sensitive identifier that you provide to ensure the request is + * handled only once.

+ */ + inline const Aws::String& GetClientToken() const { return m_clientToken; } + inline bool ClientTokenHasBeenSet() const { return m_clientTokenHasBeenSet; } + template + void SetClientToken(ClientTokenT&& value) { + m_clientTokenHasBeenSet = true; + m_clientToken = std::forward(value); + } + template + CancelSubscriptionChangeRequest& WithClientToken(ClientTokenT&& value) { + SetClientToken(std::forward(value)); + return *this; + } + ///@} + private: + Aws::String m_arn; + + Aws::String m_ifMatch; + + Aws::String m_clientToken{Aws::Utils::UUID::PseudoRandomUUID()}; + bool m_arnHasBeenSet = false; + bool m_ifMatchHasBeenSet = false; + bool m_clientTokenHasBeenSet = true; +}; + +} // namespace Model +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/CancelSubscriptionChangeResult.h b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/CancelSubscriptionChangeResult.h new file mode 100644 index 000000000000..98f731781654 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/CancelSubscriptionChangeResult.h @@ -0,0 +1,96 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include +#include + +#include + +namespace Aws { +template +class AmazonWebServiceResult; + +namespace Utils { +namespace Json { +class JsonValue; +} // namespace Json +} // namespace Utils +namespace PricingPlanManager { +namespace Model { +class CancelSubscriptionChangeResult { + public: + AWS_PRICINGPLANMANAGER_API CancelSubscriptionChangeResult() = default; + AWS_PRICINGPLANMANAGER_API CancelSubscriptionChangeResult(const Aws::AmazonWebServiceResult& result); + AWS_PRICINGPLANMANAGER_API CancelSubscriptionChangeResult& operator=( + const Aws::AmazonWebServiceResult& result); + + ///@{ + /** + *

The details of the subscription with the pending change removed.

+ */ + inline const Subscription& GetSubscription() const { return m_subscription; } + template + void SetSubscription(SubscriptionT&& value) { + m_subscriptionHasBeenSet = true; + m_subscription = std::forward(value); + } + template + CancelSubscriptionChangeResult& WithSubscription(SubscriptionT&& value) { + SetSubscription(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The updated entity tag for concurrency control.

+ */ + inline const Aws::String& GetETag() const { return m_eTag; } + template + void SetETag(ETagT&& value) { + m_eTagHasBeenSet = true; + m_eTag = std::forward(value); + } + template + CancelSubscriptionChangeResult& WithETag(ETagT&& value) { + SetETag(std::forward(value)); + return *this; + } + ///@} + + ///@{ + + inline const Aws::String& GetRequestId() const { return m_requestId; } + template + void SetRequestId(RequestIdT&& value) { + m_requestIdHasBeenSet = true; + m_requestId = std::forward(value); + } + template + CancelSubscriptionChangeResult& WithRequestId(RequestIdT&& value) { + SetRequestId(std::forward(value)); + return *this; + } + ///@} + inline Aws::Http::HttpResponseCode GetHttpResponseCode() const { return m_HttpResponseCode; } + + private: + Subscription m_subscription; + + Aws::String m_eTag; + + Aws::String m_requestId; + Aws::Http::HttpResponseCode m_HttpResponseCode; + bool m_subscriptionHasBeenSet = false; + bool m_eTagHasBeenSet = false; + bool m_requestIdHasBeenSet = false; +}; + +} // namespace Model +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/CancelSubscriptionRequest.h b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/CancelSubscriptionRequest.h new file mode 100644 index 000000000000..e29c7eccb4a4 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/CancelSubscriptionRequest.h @@ -0,0 +1,102 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include +#include + +#include + +namespace Aws { +namespace PricingPlanManager { +namespace Model { + +/** + */ +class CancelSubscriptionRequest : public PricingPlanManagerRequest { + public: + AWS_PRICINGPLANMANAGER_API CancelSubscriptionRequest() = default; + + // Service request name is the Operation name which will send this request out, + // each operation should has unique request name, so that we can get operation's name from this request. + // Note: this is not true for response, multiple operations may have the same response name, + // so we can not get operation's name from response. + inline virtual const char* GetServiceRequestName() const override { return "CancelSubscription"; } + + AWS_PRICINGPLANMANAGER_API Aws::String SerializePayload() const override; + + AWS_PRICINGPLANMANAGER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; + + ///@{ + /** + *

The ARN of the subscription to cancel.

+ */ + inline const Aws::String& GetArn() const { return m_arn; } + inline bool ArnHasBeenSet() const { return m_arnHasBeenSet; } + template + void SetArn(ArnT&& value) { + m_arnHasBeenSet = true; + m_arn = std::forward(value); + } + template + CancelSubscriptionRequest& WithArn(ArnT&& value) { + SetArn(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The ETag value from a previous GetSubscription or + * ListSubscriptions response.

+ */ + inline const Aws::String& GetIfMatch() const { return m_ifMatch; } + inline bool IfMatchHasBeenSet() const { return m_ifMatchHasBeenSet; } + template + void SetIfMatch(IfMatchT&& value) { + m_ifMatchHasBeenSet = true; + m_ifMatch = std::forward(value); + } + template + CancelSubscriptionRequest& WithIfMatch(IfMatchT&& value) { + SetIfMatch(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

A unique, case-sensitive identifier that you provide to ensure the request is + * handled only once.

+ */ + inline const Aws::String& GetClientToken() const { return m_clientToken; } + inline bool ClientTokenHasBeenSet() const { return m_clientTokenHasBeenSet; } + template + void SetClientToken(ClientTokenT&& value) { + m_clientTokenHasBeenSet = true; + m_clientToken = std::forward(value); + } + template + CancelSubscriptionRequest& WithClientToken(ClientTokenT&& value) { + SetClientToken(std::forward(value)); + return *this; + } + ///@} + private: + Aws::String m_arn; + + Aws::String m_ifMatch; + + Aws::String m_clientToken{Aws::Utils::UUID::PseudoRandomUUID()}; + bool m_arnHasBeenSet = false; + bool m_ifMatchHasBeenSet = false; + bool m_clientTokenHasBeenSet = true; +}; + +} // namespace Model +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/CancelSubscriptionResult.h b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/CancelSubscriptionResult.h new file mode 100644 index 000000000000..ed24b795b430 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/CancelSubscriptionResult.h @@ -0,0 +1,97 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include +#include + +#include + +namespace Aws { +template +class AmazonWebServiceResult; + +namespace Utils { +namespace Json { +class JsonValue; +} // namespace Json +} // namespace Utils +namespace PricingPlanManager { +namespace Model { +class CancelSubscriptionResult { + public: + AWS_PRICINGPLANMANAGER_API CancelSubscriptionResult() = default; + AWS_PRICINGPLANMANAGER_API CancelSubscriptionResult(const Aws::AmazonWebServiceResult& result); + AWS_PRICINGPLANMANAGER_API CancelSubscriptionResult& operator=(const Aws::AmazonWebServiceResult& result); + + ///@{ + /** + *

The details of the subscription with the pending cancellation. For active + * subscriptions, a scheduledChange of type CANCELLATION + * is included.

+ */ + inline const Subscription& GetSubscription() const { return m_subscription; } + template + void SetSubscription(SubscriptionT&& value) { + m_subscriptionHasBeenSet = true; + m_subscription = std::forward(value); + } + template + CancelSubscriptionResult& WithSubscription(SubscriptionT&& value) { + SetSubscription(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The updated entity tag for concurrency control.

+ */ + inline const Aws::String& GetETag() const { return m_eTag; } + template + void SetETag(ETagT&& value) { + m_eTagHasBeenSet = true; + m_eTag = std::forward(value); + } + template + CancelSubscriptionResult& WithETag(ETagT&& value) { + SetETag(std::forward(value)); + return *this; + } + ///@} + + ///@{ + + inline const Aws::String& GetRequestId() const { return m_requestId; } + template + void SetRequestId(RequestIdT&& value) { + m_requestIdHasBeenSet = true; + m_requestId = std::forward(value); + } + template + CancelSubscriptionResult& WithRequestId(RequestIdT&& value) { + SetRequestId(std::forward(value)); + return *this; + } + ///@} + inline Aws::Http::HttpResponseCode GetHttpResponseCode() const { return m_HttpResponseCode; } + + private: + Subscription m_subscription; + + Aws::String m_eTag; + + Aws::String m_requestId; + Aws::Http::HttpResponseCode m_HttpResponseCode; + bool m_subscriptionHasBeenSet = false; + bool m_eTagHasBeenSet = false; + bool m_requestIdHasBeenSet = false; +}; + +} // namespace Model +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ConflictException.h b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ConflictException.h new file mode 100644 index 000000000000..f2fa3e001833 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ConflictException.h @@ -0,0 +1,80 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include + +#include + +namespace Aws { +namespace Utils { +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json +} // namespace Utils +namespace PricingPlanManager { +namespace Model { + +/** + *

The request conflicts with the current state of the resource. This typically + * occurs when the ETag value in the If-Match header does + * not match the current version of the subscription. Retrieve the latest version + * and retry.

See Also:

AWS + * API Reference

+ */ +class ConflictException { + public: + AWS_PRICINGPLANMANAGER_API ConflictException() = default; + AWS_PRICINGPLANMANAGER_API ConflictException(Aws::Utils::Json::JsonView jsonValue); + AWS_PRICINGPLANMANAGER_API ConflictException& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_PRICINGPLANMANAGER_API Aws::Utils::Json::JsonValue Jsonize() const; + + ///@{ + + inline const Aws::String& GetMessage() const { return m_message; } + inline bool MessageHasBeenSet() const { return m_messageHasBeenSet; } + template + void SetMessage(MessageT&& value) { + m_messageHasBeenSet = true; + m_message = std::forward(value); + } + template + ConflictException& WithMessage(MessageT&& value) { + SetMessage(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The identifier of the resource that has a conflicting state.

+ */ + inline const Aws::String& GetResourceId() const { return m_resourceId; } + inline bool ResourceIdHasBeenSet() const { return m_resourceIdHasBeenSet; } + template + void SetResourceId(ResourceIdT&& value) { + m_resourceIdHasBeenSet = true; + m_resourceId = std::forward(value); + } + template + ConflictException& WithResourceId(ResourceIdT&& value) { + SetResourceId(std::forward(value)); + return *this; + } + ///@} + private: + Aws::String m_message; + + Aws::String m_resourceId; + bool m_messageHasBeenSet = false; + bool m_resourceIdHasBeenSet = false; +}; + +} // namespace Model +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/CreateSubscriptionRequest.h b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/CreateSubscriptionRequest.h new file mode 100644 index 000000000000..1c4260949ebd --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/CreateSubscriptionRequest.h @@ -0,0 +1,180 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include +#include +#include +#include + +#include + +namespace Aws { +namespace PricingPlanManager { +namespace Model { + +/** + */ +class CreateSubscriptionRequest : public PricingPlanManagerRequest { + public: + AWS_PRICINGPLANMANAGER_API CreateSubscriptionRequest() = default; + + // Service request name is the Operation name which will send this request out, + // each operation should has unique request name, so that we can get operation's name from this request. + // Note: this is not true for response, multiple operations may have the same response name, + // so we can not get operation's name from response. + inline virtual const char* GetServiceRequestName() const override { return "CreateSubscription"; } + + AWS_PRICINGPLANMANAGER_API Aws::String SerializePayload() const override; + + ///@{ + /** + *

The pricing plan family to subscribe to, such as CloudFront.

+ */ + inline const Aws::String& GetPlanFamily() const { return m_planFamily; } + inline bool PlanFamilyHasBeenSet() const { return m_planFamilyHasBeenSet; } + template + void SetPlanFamily(PlanFamilyT&& value) { + m_planFamilyHasBeenSet = true; + m_planFamily = std::forward(value); + } + template + CreateSubscriptionRequest& WithPlanFamily(PlanFamilyT&& value) { + SetPlanFamily(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The tier level for the subscription, such as FREE, + * PRO, BUSINESS, or PREMIUM.

+ */ + inline const Aws::String& GetPlanTier() const { return m_planTier; } + inline bool PlanTierHasBeenSet() const { return m_planTierHasBeenSet; } + template + void SetPlanTier(PlanTierT&& value) { + m_planTierHasBeenSet = true; + m_planTier = std::forward(value); + } + template + CreateSubscriptionRequest& WithPlanTier(PlanTierT&& value) { + SetPlanTier(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The usage level within the plan tier. Specify DEFAULT for the + * base configuration, or a higher level if your plan tier supports it.

+ */ + inline const Aws::String& GetUsageLevel() const { return m_usageLevel; } + inline bool UsageLevelHasBeenSet() const { return m_usageLevelHasBeenSet; } + template + void SetUsageLevel(UsageLevelT&& value) { + m_usageLevelHasBeenSet = true; + m_usageLevel = std::forward(value); + } + template + CreateSubscriptionRequest& WithUsageLevel(UsageLevelT&& value) { + SetUsageLevel(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The ARNs of the AWS resources to include in the subscription. Specify one or + * more supported resources.

For subscriptions in the CloudFront plan + * family, the resources must include exactly one Amazon CloudFront distribution + * and exactly one AWS WAF web ACL. You can also include other supported resources, + * such as Amazon Route 53 hosted zones and CloudFront KeyValueStores.

+ */ + inline const Aws::Vector& GetResourceArns() const { return m_resourceArns; } + inline bool ResourceArnsHasBeenSet() const { return m_resourceArnsHasBeenSet; } + template > + void SetResourceArns(ResourceArnsT&& value) { + m_resourceArnsHasBeenSet = true; + m_resourceArns = std::forward(value); + } + template > + CreateSubscriptionRequest& WithResourceArns(ResourceArnsT&& value) { + SetResourceArns(std::forward(value)); + return *this; + } + template + CreateSubscriptionRequest& AddResourceArns(ResourceArnsT&& value) { + m_resourceArnsHasBeenSet = true; + m_resourceArns.emplace_back(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

Determines whether the subscription requires explicit approval before billing + * starts. Set to MANUAL to require a separate + * ApprovePaidSubscription call, or IMMEDIATE to activate + * the subscription right away. Defaults to IMMEDIATE if not + * specified.

+ */ + inline ApprovalMode GetApprovalMode() const { return m_approvalMode; } + inline bool ApprovalModeHasBeenSet() const { return m_approvalModeHasBeenSet; } + inline void SetApprovalMode(ApprovalMode value) { + m_approvalModeHasBeenSet = true; + m_approvalMode = value; + } + inline CreateSubscriptionRequest& WithApprovalMode(ApprovalMode value) { + SetApprovalMode(value); + return *this; + } + ///@} + + ///@{ + /** + *

A unique, case-sensitive identifier that you provide to ensure that the + * request is handled only once. If you send the same request with the same client + * token, the API returns the original response without creating a duplicate + * subscription.

+ */ + inline const Aws::String& GetClientToken() const { return m_clientToken; } + inline bool ClientTokenHasBeenSet() const { return m_clientTokenHasBeenSet; } + template + void SetClientToken(ClientTokenT&& value) { + m_clientTokenHasBeenSet = true; + m_clientToken = std::forward(value); + } + template + CreateSubscriptionRequest& WithClientToken(ClientTokenT&& value) { + SetClientToken(std::forward(value)); + return *this; + } + ///@} + private: + Aws::String m_planFamily; + + Aws::String m_planTier; + + Aws::String m_usageLevel; + + Aws::Vector m_resourceArns; + + ApprovalMode m_approvalMode{ApprovalMode::NOT_SET}; + + Aws::String m_clientToken{Aws::Utils::UUID::PseudoRandomUUID()}; + bool m_planFamilyHasBeenSet = false; + bool m_planTierHasBeenSet = false; + bool m_usageLevelHasBeenSet = false; + bool m_resourceArnsHasBeenSet = false; + bool m_approvalModeHasBeenSet = false; + bool m_clientTokenHasBeenSet = true; +}; + +} // namespace Model +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/CreateSubscriptionResult.h b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/CreateSubscriptionResult.h new file mode 100644 index 000000000000..25a560a4032a --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/CreateSubscriptionResult.h @@ -0,0 +1,96 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include +#include + +#include + +namespace Aws { +template +class AmazonWebServiceResult; + +namespace Utils { +namespace Json { +class JsonValue; +} // namespace Json +} // namespace Utils +namespace PricingPlanManager { +namespace Model { +class CreateSubscriptionResult { + public: + AWS_PRICINGPLANMANAGER_API CreateSubscriptionResult() = default; + AWS_PRICINGPLANMANAGER_API CreateSubscriptionResult(const Aws::AmazonWebServiceResult& result); + AWS_PRICINGPLANMANAGER_API CreateSubscriptionResult& operator=(const Aws::AmazonWebServiceResult& result); + + ///@{ + /** + *

The details of the newly created subscription.

+ */ + inline const Subscription& GetSubscription() const { return m_subscription; } + template + void SetSubscription(SubscriptionT&& value) { + m_subscriptionHasBeenSet = true; + m_subscription = std::forward(value); + } + template + CreateSubscriptionResult& WithSubscription(SubscriptionT&& value) { + SetSubscription(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The entity tag for concurrency control. Use this value in the + * If-Match header for subsequent operations on this subscription.

+ */ + inline const Aws::String& GetETag() const { return m_eTag; } + template + void SetETag(ETagT&& value) { + m_eTagHasBeenSet = true; + m_eTag = std::forward(value); + } + template + CreateSubscriptionResult& WithETag(ETagT&& value) { + SetETag(std::forward(value)); + return *this; + } + ///@} + + ///@{ + + inline const Aws::String& GetRequestId() const { return m_requestId; } + template + void SetRequestId(RequestIdT&& value) { + m_requestIdHasBeenSet = true; + m_requestId = std::forward(value); + } + template + CreateSubscriptionResult& WithRequestId(RequestIdT&& value) { + SetRequestId(std::forward(value)); + return *this; + } + ///@} + inline Aws::Http::HttpResponseCode GetHttpResponseCode() const { return m_HttpResponseCode; } + + private: + Subscription m_subscription; + + Aws::String m_eTag; + + Aws::String m_requestId; + Aws::Http::HttpResponseCode m_HttpResponseCode; + bool m_subscriptionHasBeenSet = false; + bool m_eTagHasBeenSet = false; + bool m_requestIdHasBeenSet = false; +}; + +} // namespace Model +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/DisassociateResourcesFromSubscriptionRequest.h b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/DisassociateResourcesFromSubscriptionRequest.h new file mode 100644 index 000000000000..fa20931946eb --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/DisassociateResourcesFromSubscriptionRequest.h @@ -0,0 +1,132 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include +#include +#include + +#include + +namespace Aws { +namespace PricingPlanManager { +namespace Model { + +/** + */ +class DisassociateResourcesFromSubscriptionRequest : public PricingPlanManagerRequest { + public: + AWS_PRICINGPLANMANAGER_API DisassociateResourcesFromSubscriptionRequest() = default; + + // Service request name is the Operation name which will send this request out, + // each operation should has unique request name, so that we can get operation's name from this request. + // Note: this is not true for response, multiple operations may have the same response name, + // so we can not get operation's name from response. + inline virtual const char* GetServiceRequestName() const override { return "DisassociateResourcesFromSubscription"; } + + AWS_PRICINGPLANMANAGER_API Aws::String SerializePayload() const override; + + AWS_PRICINGPLANMANAGER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; + + ///@{ + /** + *

The ARN of the subscription to remove resources from.

+ */ + inline const Aws::String& GetArn() const { return m_arn; } + inline bool ArnHasBeenSet() const { return m_arnHasBeenSet; } + template + void SetArn(ArnT&& value) { + m_arnHasBeenSet = true; + m_arn = std::forward(value); + } + template + DisassociateResourcesFromSubscriptionRequest& WithArn(ArnT&& value) { + SetArn(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The ARNs of the resources to remove from the subscription. For subscriptions + * in the CloudFront plan family, you cannot remove the required CloudFront + * distribution or WAF web ACL.

+ */ + inline const Aws::Vector& GetResourceArns() const { return m_resourceArns; } + inline bool ResourceArnsHasBeenSet() const { return m_resourceArnsHasBeenSet; } + template > + void SetResourceArns(ResourceArnsT&& value) { + m_resourceArnsHasBeenSet = true; + m_resourceArns = std::forward(value); + } + template > + DisassociateResourcesFromSubscriptionRequest& WithResourceArns(ResourceArnsT&& value) { + SetResourceArns(std::forward(value)); + return *this; + } + template + DisassociateResourcesFromSubscriptionRequest& AddResourceArns(ResourceArnsT&& value) { + m_resourceArnsHasBeenSet = true; + m_resourceArns.emplace_back(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The ETag value from a previous GetSubscription or + * ListSubscriptions response.

+ */ + inline const Aws::String& GetIfMatch() const { return m_ifMatch; } + inline bool IfMatchHasBeenSet() const { return m_ifMatchHasBeenSet; } + template + void SetIfMatch(IfMatchT&& value) { + m_ifMatchHasBeenSet = true; + m_ifMatch = std::forward(value); + } + template + DisassociateResourcesFromSubscriptionRequest& WithIfMatch(IfMatchT&& value) { + SetIfMatch(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

A unique, case-sensitive identifier that you provide to ensure the request is + * handled only once.

+ */ + inline const Aws::String& GetClientToken() const { return m_clientToken; } + inline bool ClientTokenHasBeenSet() const { return m_clientTokenHasBeenSet; } + template + void SetClientToken(ClientTokenT&& value) { + m_clientTokenHasBeenSet = true; + m_clientToken = std::forward(value); + } + template + DisassociateResourcesFromSubscriptionRequest& WithClientToken(ClientTokenT&& value) { + SetClientToken(std::forward(value)); + return *this; + } + ///@} + private: + Aws::String m_arn; + + Aws::Vector m_resourceArns; + + Aws::String m_ifMatch; + + Aws::String m_clientToken{Aws::Utils::UUID::PseudoRandomUUID()}; + bool m_arnHasBeenSet = false; + bool m_resourceArnsHasBeenSet = false; + bool m_ifMatchHasBeenSet = false; + bool m_clientTokenHasBeenSet = true; +}; + +} // namespace Model +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/DisassociateResourcesFromSubscriptionResult.h b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/DisassociateResourcesFromSubscriptionResult.h new file mode 100644 index 000000000000..a690ddc52674 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/DisassociateResourcesFromSubscriptionResult.h @@ -0,0 +1,97 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include +#include + +#include + +namespace Aws { +template +class AmazonWebServiceResult; + +namespace Utils { +namespace Json { +class JsonValue; +} // namespace Json +} // namespace Utils +namespace PricingPlanManager { +namespace Model { +class DisassociateResourcesFromSubscriptionResult { + public: + AWS_PRICINGPLANMANAGER_API DisassociateResourcesFromSubscriptionResult() = default; + AWS_PRICINGPLANMANAGER_API DisassociateResourcesFromSubscriptionResult( + const Aws::AmazonWebServiceResult& result); + AWS_PRICINGPLANMANAGER_API DisassociateResourcesFromSubscriptionResult& operator=( + const Aws::AmazonWebServiceResult& result); + + ///@{ + /** + *

The details of the subscription with the specified resources removed.

+ */ + inline const Subscription& GetSubscription() const { return m_subscription; } + template + void SetSubscription(SubscriptionT&& value) { + m_subscriptionHasBeenSet = true; + m_subscription = std::forward(value); + } + template + DisassociateResourcesFromSubscriptionResult& WithSubscription(SubscriptionT&& value) { + SetSubscription(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The updated entity tag for concurrency control.

+ */ + inline const Aws::String& GetETag() const { return m_eTag; } + template + void SetETag(ETagT&& value) { + m_eTagHasBeenSet = true; + m_eTag = std::forward(value); + } + template + DisassociateResourcesFromSubscriptionResult& WithETag(ETagT&& value) { + SetETag(std::forward(value)); + return *this; + } + ///@} + + ///@{ + + inline const Aws::String& GetRequestId() const { return m_requestId; } + template + void SetRequestId(RequestIdT&& value) { + m_requestIdHasBeenSet = true; + m_requestId = std::forward(value); + } + template + DisassociateResourcesFromSubscriptionResult& WithRequestId(RequestIdT&& value) { + SetRequestId(std::forward(value)); + return *this; + } + ///@} + inline Aws::Http::HttpResponseCode GetHttpResponseCode() const { return m_HttpResponseCode; } + + private: + Subscription m_subscription; + + Aws::String m_eTag; + + Aws::String m_requestId; + Aws::Http::HttpResponseCode m_HttpResponseCode; + bool m_subscriptionHasBeenSet = false; + bool m_eTagHasBeenSet = false; + bool m_requestIdHasBeenSet = false; +}; + +} // namespace Model +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/GetSubscriptionRequest.h b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/GetSubscriptionRequest.h new file mode 100644 index 000000000000..960d1ee037bd --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/GetSubscriptionRequest.h @@ -0,0 +1,55 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include + +#include + +namespace Aws { +namespace PricingPlanManager { +namespace Model { + +/** + */ +class GetSubscriptionRequest : public PricingPlanManagerRequest { + public: + AWS_PRICINGPLANMANAGER_API GetSubscriptionRequest() = default; + + // Service request name is the Operation name which will send this request out, + // each operation should has unique request name, so that we can get operation's name from this request. + // Note: this is not true for response, multiple operations may have the same response name, + // so we can not get operation's name from response. + inline virtual const char* GetServiceRequestName() const override { return "GetSubscription"; } + + AWS_PRICINGPLANMANAGER_API Aws::String SerializePayload() const override; + + ///@{ + /** + *

The ARN of the subscription to retrieve.

+ */ + inline const Aws::String& GetArn() const { return m_arn; } + inline bool ArnHasBeenSet() const { return m_arnHasBeenSet; } + template + void SetArn(ArnT&& value) { + m_arnHasBeenSet = true; + m_arn = std::forward(value); + } + template + GetSubscriptionRequest& WithArn(ArnT&& value) { + SetArn(std::forward(value)); + return *this; + } + ///@} + private: + Aws::String m_arn; + bool m_arnHasBeenSet = false; +}; + +} // namespace Model +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/GetSubscriptionResult.h b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/GetSubscriptionResult.h new file mode 100644 index 000000000000..1c5779680136 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/GetSubscriptionResult.h @@ -0,0 +1,96 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include +#include + +#include + +namespace Aws { +template +class AmazonWebServiceResult; + +namespace Utils { +namespace Json { +class JsonValue; +} // namespace Json +} // namespace Utils +namespace PricingPlanManager { +namespace Model { +class GetSubscriptionResult { + public: + AWS_PRICINGPLANMANAGER_API GetSubscriptionResult() = default; + AWS_PRICINGPLANMANAGER_API GetSubscriptionResult(const Aws::AmazonWebServiceResult& result); + AWS_PRICINGPLANMANAGER_API GetSubscriptionResult& operator=(const Aws::AmazonWebServiceResult& result); + + ///@{ + /** + *

The details of the requested subscription.

+ */ + inline const Subscription& GetSubscription() const { return m_subscription; } + template + void SetSubscription(SubscriptionT&& value) { + m_subscriptionHasBeenSet = true; + m_subscription = std::forward(value); + } + template + GetSubscriptionResult& WithSubscription(SubscriptionT&& value) { + SetSubscription(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The entity tag for concurrency control. Use this value in the + * If-Match header for subsequent operations on this subscription.

+ */ + inline const Aws::String& GetETag() const { return m_eTag; } + template + void SetETag(ETagT&& value) { + m_eTagHasBeenSet = true; + m_eTag = std::forward(value); + } + template + GetSubscriptionResult& WithETag(ETagT&& value) { + SetETag(std::forward(value)); + return *this; + } + ///@} + + ///@{ + + inline const Aws::String& GetRequestId() const { return m_requestId; } + template + void SetRequestId(RequestIdT&& value) { + m_requestIdHasBeenSet = true; + m_requestId = std::forward(value); + } + template + GetSubscriptionResult& WithRequestId(RequestIdT&& value) { + SetRequestId(std::forward(value)); + return *this; + } + ///@} + inline Aws::Http::HttpResponseCode GetHttpResponseCode() const { return m_HttpResponseCode; } + + private: + Subscription m_subscription; + + Aws::String m_eTag; + + Aws::String m_requestId; + Aws::Http::HttpResponseCode m_HttpResponseCode; + bool m_subscriptionHasBeenSet = false; + bool m_eTagHasBeenSet = false; + bool m_requestIdHasBeenSet = false; +}; + +} // namespace Model +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ListSubscriptionsPaginationTraits.h b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ListSubscriptionsPaginationTraits.h new file mode 100644 index 000000000000..7745c3ed9a71 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ListSubscriptionsPaginationTraits.h @@ -0,0 +1,32 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include +#include + +namespace Aws { +namespace PricingPlanManager { +namespace Pagination { + +template +struct ListSubscriptionsPaginationTraits { + using RequestType = Model::ListSubscriptionsRequest; + using ResultType = Model::ListSubscriptionsResult; + using OutcomeType = Model::ListSubscriptionsOutcome; + using ClientType = Client; + + static OutcomeType Invoke(Client* client, const RequestType& request) { return client->ListSubscriptions(request); } + + static bool HasMoreResults(const ResultType& result) { return !result.GetNextToken().empty(); } + + static void SetNextRequest(const ResultType& result, RequestType& request) { request.SetNextToken(result.GetNextToken()); } +}; + +} // namespace Pagination +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ListSubscriptionsRequest.h b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ListSubscriptionsRequest.h new file mode 100644 index 000000000000..fedc7b0dfd7f --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ListSubscriptionsRequest.h @@ -0,0 +1,57 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include + +#include + +namespace Aws { +namespace PricingPlanManager { +namespace Model { + +/** + */ +class ListSubscriptionsRequest : public PricingPlanManagerRequest { + public: + AWS_PRICINGPLANMANAGER_API ListSubscriptionsRequest() = default; + + // Service request name is the Operation name which will send this request out, + // each operation should has unique request name, so that we can get operation's name from this request. + // Note: this is not true for response, multiple operations may have the same response name, + // so we can not get operation's name from response. + inline virtual const char* GetServiceRequestName() const override { return "ListSubscriptions"; } + + AWS_PRICINGPLANMANAGER_API Aws::String SerializePayload() const override; + + ///@{ + /** + *

A token from a previous ListSubscriptions response. If the + * response included a nextToken, there are more results available. + * Pass this value to retrieve the next page of results.

+ */ + inline const Aws::String& GetNextToken() const { return m_nextToken; } + inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } + template + void SetNextToken(NextTokenT&& value) { + m_nextTokenHasBeenSet = true; + m_nextToken = std::forward(value); + } + template + ListSubscriptionsRequest& WithNextToken(NextTokenT&& value) { + SetNextToken(std::forward(value)); + return *this; + } + ///@} + private: + Aws::String m_nextToken; + bool m_nextTokenHasBeenSet = false; +}; + +} // namespace Model +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ListSubscriptionsResult.h b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ListSubscriptionsResult.h new file mode 100644 index 000000000000..51f2661d76c9 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ListSubscriptionsResult.h @@ -0,0 +1,104 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include +#include +#include + +#include + +namespace Aws { +template +class AmazonWebServiceResult; + +namespace Utils { +namespace Json { +class JsonValue; +} // namespace Json +} // namespace Utils +namespace PricingPlanManager { +namespace Model { +class ListSubscriptionsResult { + public: + AWS_PRICINGPLANMANAGER_API ListSubscriptionsResult() = default; + AWS_PRICINGPLANMANAGER_API ListSubscriptionsResult(const Aws::AmazonWebServiceResult& result); + AWS_PRICINGPLANMANAGER_API ListSubscriptionsResult& operator=(const Aws::AmazonWebServiceResult& result); + + ///@{ + /** + *

The list of subscription summaries for the calling account.

+ */ + inline const Aws::Vector& GetSubscriptionSummaries() const { return m_subscriptionSummaries; } + template > + void SetSubscriptionSummaries(SubscriptionSummariesT&& value) { + m_subscriptionSummariesHasBeenSet = true; + m_subscriptionSummaries = std::forward(value); + } + template > + ListSubscriptionsResult& WithSubscriptionSummaries(SubscriptionSummariesT&& value) { + SetSubscriptionSummaries(std::forward(value)); + return *this; + } + template + ListSubscriptionsResult& AddSubscriptionSummaries(SubscriptionSummariesT&& value) { + m_subscriptionSummariesHasBeenSet = true; + m_subscriptionSummaries.emplace_back(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

A token that indicates there are more results available. Pass this value in a + * subsequent ListSubscriptions request to retrieve the next page of + * results.

+ */ + inline const Aws::String& GetNextToken() const { return m_nextToken; } + template + void SetNextToken(NextTokenT&& value) { + m_nextTokenHasBeenSet = true; + m_nextToken = std::forward(value); + } + template + ListSubscriptionsResult& WithNextToken(NextTokenT&& value) { + SetNextToken(std::forward(value)); + return *this; + } + ///@} + + ///@{ + + inline const Aws::String& GetRequestId() const { return m_requestId; } + template + void SetRequestId(RequestIdT&& value) { + m_requestIdHasBeenSet = true; + m_requestId = std::forward(value); + } + template + ListSubscriptionsResult& WithRequestId(RequestIdT&& value) { + SetRequestId(std::forward(value)); + return *this; + } + ///@} + inline Aws::Http::HttpResponseCode GetHttpResponseCode() const { return m_HttpResponseCode; } + + private: + Aws::Vector m_subscriptionSummaries; + + Aws::String m_nextToken; + + Aws::String m_requestId; + Aws::Http::HttpResponseCode m_HttpResponseCode; + bool m_subscriptionSummariesHasBeenSet = false; + bool m_nextTokenHasBeenSet = false; + bool m_requestIdHasBeenSet = false; +}; + +} // namespace Model +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ResourceNotFoundException.h b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ResourceNotFoundException.h new file mode 100644 index 000000000000..2278d865aa37 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ResourceNotFoundException.h @@ -0,0 +1,78 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include + +#include + +namespace Aws { +namespace Utils { +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json +} // namespace Utils +namespace PricingPlanManager { +namespace Model { + +/** + *

The specified subscription was not found. Verify that the ARN is correct and + * that the subscription belongs to your account.

See Also:

AWS + * API Reference

+ */ +class ResourceNotFoundException { + public: + AWS_PRICINGPLANMANAGER_API ResourceNotFoundException() = default; + AWS_PRICINGPLANMANAGER_API ResourceNotFoundException(Aws::Utils::Json::JsonView jsonValue); + AWS_PRICINGPLANMANAGER_API ResourceNotFoundException& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_PRICINGPLANMANAGER_API Aws::Utils::Json::JsonValue Jsonize() const; + + ///@{ + + inline const Aws::String& GetMessage() const { return m_message; } + inline bool MessageHasBeenSet() const { return m_messageHasBeenSet; } + template + void SetMessage(MessageT&& value) { + m_messageHasBeenSet = true; + m_message = std::forward(value); + } + template + ResourceNotFoundException& WithMessage(MessageT&& value) { + SetMessage(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The identifier of the resource that was not found.

+ */ + inline const Aws::String& GetResourceId() const { return m_resourceId; } + inline bool ResourceIdHasBeenSet() const { return m_resourceIdHasBeenSet; } + template + void SetResourceId(ResourceIdT&& value) { + m_resourceIdHasBeenSet = true; + m_resourceId = std::forward(value); + } + template + ResourceNotFoundException& WithResourceId(ResourceIdT&& value) { + SetResourceId(std::forward(value)); + return *this; + } + ///@} + private: + Aws::String m_message; + + Aws::String m_resourceId; + bool m_messageHasBeenSet = false; + bool m_resourceIdHasBeenSet = false; +}; + +} // namespace Model +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ScheduledChange.h b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ScheduledChange.h new file mode 100644 index 000000000000..395fa9068ceb --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ScheduledChange.h @@ -0,0 +1,127 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include +#include + +#include + +namespace Aws { +namespace Utils { +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json +} // namespace Utils +namespace PricingPlanManager { +namespace Model { + +/** + *

A pending change on a subscription that takes effect at the end of the + * current billing period, such as a tier downgrade or cancellation.

See + * Also:

AWS + * API Reference

+ */ +class ScheduledChange { + public: + AWS_PRICINGPLANMANAGER_API ScheduledChange() = default; + AWS_PRICINGPLANMANAGER_API ScheduledChange(Aws::Utils::Json::JsonView jsonValue); + AWS_PRICINGPLANMANAGER_API ScheduledChange& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_PRICINGPLANMANAGER_API Aws::Utils::Json::JsonValue Jsonize() const; + + ///@{ + /** + *

The type of pending change. Possible values are DOWNGRADE (a + * tier change to a lower level) and CANCELLATION (subscription + * termination).

+ */ + inline ScheduledChangeType GetChangeType() const { return m_changeType; } + inline bool ChangeTypeHasBeenSet() const { return m_changeTypeHasBeenSet; } + inline void SetChangeType(ScheduledChangeType value) { + m_changeTypeHasBeenSet = true; + m_changeType = value; + } + inline ScheduledChange& WithChangeType(ScheduledChangeType value) { + SetChangeType(value); + return *this; + } + ///@} + + ///@{ + /** + *

The date and time when the change takes effect, in ISO 8601 format. This + * value is populated after the change is confirmed by the billing system.

+ */ + inline const Aws::Utils::DateTime& GetEffectiveDate() const { return m_effectiveDate; } + inline bool EffectiveDateHasBeenSet() const { return m_effectiveDateHasBeenSet; } + template + void SetEffectiveDate(EffectiveDateT&& value) { + m_effectiveDateHasBeenSet = true; + m_effectiveDate = std::forward(value); + } + template + ScheduledChange& WithEffectiveDate(EffectiveDateT&& value) { + SetEffectiveDate(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

For downgrades, the tier level that the subscription will change to. Not + * present for cancellations.

+ */ + inline const Aws::String& GetPlanTier() const { return m_planTier; } + inline bool PlanTierHasBeenSet() const { return m_planTierHasBeenSet; } + template + void SetPlanTier(PlanTierT&& value) { + m_planTierHasBeenSet = true; + m_planTier = std::forward(value); + } + template + ScheduledChange& WithPlanTier(PlanTierT&& value) { + SetPlanTier(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

For downgrades, the target usage level after the change takes effect.

+ */ + inline const Aws::String& GetUsageLevel() const { return m_usageLevel; } + inline bool UsageLevelHasBeenSet() const { return m_usageLevelHasBeenSet; } + template + void SetUsageLevel(UsageLevelT&& value) { + m_usageLevelHasBeenSet = true; + m_usageLevel = std::forward(value); + } + template + ScheduledChange& WithUsageLevel(UsageLevelT&& value) { + SetUsageLevel(std::forward(value)); + return *this; + } + ///@} + private: + ScheduledChangeType m_changeType{ScheduledChangeType::NOT_SET}; + + Aws::Utils::DateTime m_effectiveDate{}; + + Aws::String m_planTier; + + Aws::String m_usageLevel; + bool m_changeTypeHasBeenSet = false; + bool m_effectiveDateHasBeenSet = false; + bool m_planTierHasBeenSet = false; + bool m_usageLevelHasBeenSet = false; +}; + +} // namespace Model +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ScheduledChangeType.h b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ScheduledChangeType.h new file mode 100644 index 000000000000..290f97519e92 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ScheduledChangeType.h @@ -0,0 +1,22 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include + +namespace Aws { +namespace PricingPlanManager { +namespace Model { +enum class ScheduledChangeType { NOT_SET, DOWNGRADE, CANCELLATION }; + +namespace ScheduledChangeTypeMapper { +AWS_PRICINGPLANMANAGER_API ScheduledChangeType GetScheduledChangeTypeForName(const Aws::String& name); + +AWS_PRICINGPLANMANAGER_API Aws::String GetNameForScheduledChangeType(ScheduledChangeType value); +} // namespace ScheduledChangeTypeMapper +} // namespace Model +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/Status.h b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/Status.h new file mode 100644 index 000000000000..51dfe1988a69 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/Status.h @@ -0,0 +1,22 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include + +namespace Aws { +namespace PricingPlanManager { +namespace Model { +enum class Status { NOT_SET, PENDING_APPROVAL, ACTIVE, SYNC_IN_PROGRESS, FAILED }; + +namespace StatusMapper { +AWS_PRICINGPLANMANAGER_API Status GetStatusForName(const Aws::String& name); + +AWS_PRICINGPLANMANAGER_API Aws::String GetNameForStatus(Status value); +} // namespace StatusMapper +} // namespace Model +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/Subscription.h b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/Subscription.h new file mode 100644 index 000000000000..9066b69a7003 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/Subscription.h @@ -0,0 +1,265 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include +#include +#include +#include + +#include + +namespace Aws { +namespace Utils { +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json +} // namespace Utils +namespace PricingPlanManager { +namespace Model { + +/** + *

The full details of a flat-rate pricing subscription, including its current + * configuration, status, and associated resources.

See Also:

AWS + * API Reference

+ */ +class Subscription { + public: + AWS_PRICINGPLANMANAGER_API Subscription() = default; + AWS_PRICINGPLANMANAGER_API Subscription(Aws::Utils::Json::JsonView jsonValue); + AWS_PRICINGPLANMANAGER_API Subscription& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_PRICINGPLANMANAGER_API Aws::Utils::Json::JsonValue Jsonize() const; + + ///@{ + /** + *

The Amazon Resource Name (ARN) that uniquely identifies this + * subscription.

+ */ + inline const Aws::String& GetArn() const { return m_arn; } + inline bool ArnHasBeenSet() const { return m_arnHasBeenSet; } + template + void SetArn(ArnT&& value) { + m_arnHasBeenSet = true; + m_arn = std::forward(value); + } + template + Subscription& WithArn(ArnT&& value) { + SetArn(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The pricing plan family for the subscription, such as + * CloudFront.

+ */ + inline const Aws::String& GetPlanFamily() const { return m_planFamily; } + inline bool PlanFamilyHasBeenSet() const { return m_planFamilyHasBeenSet; } + template + void SetPlanFamily(PlanFamilyT&& value) { + m_planFamilyHasBeenSet = true; + m_planFamily = std::forward(value); + } + template + Subscription& WithPlanFamily(PlanFamilyT&& value) { + SetPlanFamily(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The current tier level of the pricing plan, such as FREE, + * PRO, BUSINESS, or PREMIUM.

+ */ + inline const Aws::String& GetPlanTier() const { return m_planTier; } + inline bool PlanTierHasBeenSet() const { return m_planTierHasBeenSet; } + template + void SetPlanTier(PlanTierT&& value) { + m_planTierHasBeenSet = true; + m_planTier = std::forward(value); + } + template + Subscription& WithPlanTier(PlanTierT&& value) { + SetPlanTier(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The usage level within the plan tier. When present, indicates a specific + * capacity configuration beyond the base tier.

+ */ + inline const Aws::String& GetUsageLevel() const { return m_usageLevel; } + inline bool UsageLevelHasBeenSet() const { return m_usageLevelHasBeenSet; } + template + void SetUsageLevel(UsageLevelT&& value) { + m_usageLevelHasBeenSet = true; + m_usageLevel = std::forward(value); + } + template + Subscription& WithUsageLevel(UsageLevelT&& value) { + SetUsageLevel(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

A pending change that will take effect at the end of the current billing + * period. This field is present only when a downgrade or cancellation is + * scheduled.

+ */ + inline const ScheduledChange& GetScheduledChange() const { return m_scheduledChange; } + inline bool ScheduledChangeHasBeenSet() const { return m_scheduledChangeHasBeenSet; } + template + void SetScheduledChange(ScheduledChangeT&& value) { + m_scheduledChangeHasBeenSet = true; + m_scheduledChange = std::forward(value); + } + template + Subscription& WithScheduledChange(ScheduledChangeT&& value) { + SetScheduledChange(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The current status of the subscription. For the list of possible values, see + * the Status type.

+ */ + inline Status GetStatus() const { return m_status; } + inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; } + inline void SetStatus(Status value) { + m_statusHasBeenSet = true; + m_status = value; + } + inline Subscription& WithStatus(Status value) { + SetStatus(value); + return *this; + } + ///@} + + ///@{ + /** + *

A human-readable explanation of the current status, present when additional + * context is available.

+ */ + inline const Aws::String& GetStatusReason() const { return m_statusReason; } + inline bool StatusReasonHasBeenSet() const { return m_statusReasonHasBeenSet; } + template + void SetStatusReason(StatusReasonT&& value) { + m_statusReasonHasBeenSet = true; + m_statusReason = std::forward(value); + } + template + Subscription& WithStatusReason(StatusReasonT&& value) { + SetStatusReason(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The ARNs of the AWS resources covered by this subscription.

+ */ + inline const Aws::Vector& GetResourceArns() const { return m_resourceArns; } + inline bool ResourceArnsHasBeenSet() const { return m_resourceArnsHasBeenSet; } + template > + void SetResourceArns(ResourceArnsT&& value) { + m_resourceArnsHasBeenSet = true; + m_resourceArns = std::forward(value); + } + template > + Subscription& WithResourceArns(ResourceArnsT&& value) { + SetResourceArns(std::forward(value)); + return *this; + } + template + Subscription& AddResourceArns(ResourceArnsT&& value) { + m_resourceArnsHasBeenSet = true; + m_resourceArns.emplace_back(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The date and time when the subscription was created, in ISO 8601 format.

+ */ + inline const Aws::Utils::DateTime& GetCreatedAt() const { return m_createdAt; } + inline bool CreatedAtHasBeenSet() const { return m_createdAtHasBeenSet; } + template + void SetCreatedAt(CreatedAtT&& value) { + m_createdAtHasBeenSet = true; + m_createdAt = std::forward(value); + } + template + Subscription& WithCreatedAt(CreatedAtT&& value) { + SetCreatedAt(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The date and time when the subscription was last modified, in ISO 8601 + * format.

+ */ + inline const Aws::Utils::DateTime& GetUpdatedAt() const { return m_updatedAt; } + inline bool UpdatedAtHasBeenSet() const { return m_updatedAtHasBeenSet; } + template + void SetUpdatedAt(UpdatedAtT&& value) { + m_updatedAtHasBeenSet = true; + m_updatedAt = std::forward(value); + } + template + Subscription& WithUpdatedAt(UpdatedAtT&& value) { + SetUpdatedAt(std::forward(value)); + return *this; + } + ///@} + private: + Aws::String m_arn; + + Aws::String m_planFamily; + + Aws::String m_planTier; + + Aws::String m_usageLevel; + + ScheduledChange m_scheduledChange; + + Status m_status{Status::NOT_SET}; + + Aws::String m_statusReason; + + Aws::Vector m_resourceArns; + + Aws::Utils::DateTime m_createdAt{}; + + Aws::Utils::DateTime m_updatedAt{}; + bool m_arnHasBeenSet = false; + bool m_planFamilyHasBeenSet = false; + bool m_planTierHasBeenSet = false; + bool m_usageLevelHasBeenSet = false; + bool m_scheduledChangeHasBeenSet = false; + bool m_statusHasBeenSet = false; + bool m_statusReasonHasBeenSet = false; + bool m_resourceArnsHasBeenSet = false; + bool m_createdAtHasBeenSet = false; + bool m_updatedAtHasBeenSet = false; +}; + +} // namespace Model +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/SubscriptionSummary.h b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/SubscriptionSummary.h new file mode 100644 index 000000000000..93e937ec2e44 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/SubscriptionSummary.h @@ -0,0 +1,283 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include +#include +#include +#include + +#include + +namespace Aws { +namespace Utils { +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json +} // namespace Utils +namespace PricingPlanManager { +namespace Model { + +/** + *

Summary information for a flat-rate pricing subscription, as returned by list + * operations.

See Also:

AWS + * API Reference

+ */ +class SubscriptionSummary { + public: + AWS_PRICINGPLANMANAGER_API SubscriptionSummary() = default; + AWS_PRICINGPLANMANAGER_API SubscriptionSummary(Aws::Utils::Json::JsonView jsonValue); + AWS_PRICINGPLANMANAGER_API SubscriptionSummary& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_PRICINGPLANMANAGER_API Aws::Utils::Json::JsonValue Jsonize() const; + + ///@{ + /** + *

The Amazon Resource Name (ARN) that uniquely identifies this + * subscription.

+ */ + inline const Aws::String& GetArn() const { return m_arn; } + inline bool ArnHasBeenSet() const { return m_arnHasBeenSet; } + template + void SetArn(ArnT&& value) { + m_arnHasBeenSet = true; + m_arn = std::forward(value); + } + template + SubscriptionSummary& WithArn(ArnT&& value) { + SetArn(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The pricing plan family for the subscription, such as + * CloudFront.

+ */ + inline const Aws::String& GetPlanFamily() const { return m_planFamily; } + inline bool PlanFamilyHasBeenSet() const { return m_planFamilyHasBeenSet; } + template + void SetPlanFamily(PlanFamilyT&& value) { + m_planFamilyHasBeenSet = true; + m_planFamily = std::forward(value); + } + template + SubscriptionSummary& WithPlanFamily(PlanFamilyT&& value) { + SetPlanFamily(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The current tier level of the pricing plan.

+ */ + inline const Aws::String& GetPlanTier() const { return m_planTier; } + inline bool PlanTierHasBeenSet() const { return m_planTierHasBeenSet; } + template + void SetPlanTier(PlanTierT&& value) { + m_planTierHasBeenSet = true; + m_planTier = std::forward(value); + } + template + SubscriptionSummary& WithPlanTier(PlanTierT&& value) { + SetPlanTier(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The usage level within the plan tier.

+ */ + inline const Aws::String& GetUsageLevel() const { return m_usageLevel; } + inline bool UsageLevelHasBeenSet() const { return m_usageLevelHasBeenSet; } + template + void SetUsageLevel(UsageLevelT&& value) { + m_usageLevelHasBeenSet = true; + m_usageLevel = std::forward(value); + } + template + SubscriptionSummary& WithUsageLevel(UsageLevelT&& value) { + SetUsageLevel(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

A pending change that will take effect at the end of the current billing + * period, if any.

+ */ + inline const ScheduledChange& GetScheduledChange() const { return m_scheduledChange; } + inline bool ScheduledChangeHasBeenSet() const { return m_scheduledChangeHasBeenSet; } + template + void SetScheduledChange(ScheduledChangeT&& value) { + m_scheduledChangeHasBeenSet = true; + m_scheduledChange = std::forward(value); + } + template + SubscriptionSummary& WithScheduledChange(ScheduledChangeT&& value) { + SetScheduledChange(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The current status of the subscription.

+ */ + inline Status GetStatus() const { return m_status; } + inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; } + inline void SetStatus(Status value) { + m_statusHasBeenSet = true; + m_status = value; + } + inline SubscriptionSummary& WithStatus(Status value) { + SetStatus(value); + return *this; + } + ///@} + + ///@{ + /** + *

A human-readable explanation of the current status, present when additional + * context is available.

+ */ + inline const Aws::String& GetStatusReason() const { return m_statusReason; } + inline bool StatusReasonHasBeenSet() const { return m_statusReasonHasBeenSet; } + template + void SetStatusReason(StatusReasonT&& value) { + m_statusReasonHasBeenSet = true; + m_statusReason = std::forward(value); + } + template + SubscriptionSummary& WithStatusReason(StatusReasonT&& value) { + SetStatusReason(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The ARNs of the AWS resources covered by this subscription.

+ */ + inline const Aws::Vector& GetResourceArns() const { return m_resourceArns; } + inline bool ResourceArnsHasBeenSet() const { return m_resourceArnsHasBeenSet; } + template > + void SetResourceArns(ResourceArnsT&& value) { + m_resourceArnsHasBeenSet = true; + m_resourceArns = std::forward(value); + } + template > + SubscriptionSummary& WithResourceArns(ResourceArnsT&& value) { + SetResourceArns(std::forward(value)); + return *this; + } + template + SubscriptionSummary& AddResourceArns(ResourceArnsT&& value) { + m_resourceArnsHasBeenSet = true; + m_resourceArns.emplace_back(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The date and time when the subscription was created, in ISO 8601 format.

+ */ + inline const Aws::Utils::DateTime& GetCreatedAt() const { return m_createdAt; } + inline bool CreatedAtHasBeenSet() const { return m_createdAtHasBeenSet; } + template + void SetCreatedAt(CreatedAtT&& value) { + m_createdAtHasBeenSet = true; + m_createdAt = std::forward(value); + } + template + SubscriptionSummary& WithCreatedAt(CreatedAtT&& value) { + SetCreatedAt(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The date and time when the subscription was last modified, in ISO 8601 + * format.

+ */ + inline const Aws::Utils::DateTime& GetUpdatedAt() const { return m_updatedAt; } + inline bool UpdatedAtHasBeenSet() const { return m_updatedAtHasBeenSet; } + template + void SetUpdatedAt(UpdatedAtT&& value) { + m_updatedAtHasBeenSet = true; + m_updatedAt = std::forward(value); + } + template + SubscriptionSummary& WithUpdatedAt(UpdatedAtT&& value) { + SetUpdatedAt(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The entity tag for concurrency control. Pass this value in the + * If-Match header when making changes to this subscription.

+ */ + inline const Aws::String& GetETag() const { return m_eTag; } + inline bool ETagHasBeenSet() const { return m_eTagHasBeenSet; } + template + void SetETag(ETagT&& value) { + m_eTagHasBeenSet = true; + m_eTag = std::forward(value); + } + template + SubscriptionSummary& WithETag(ETagT&& value) { + SetETag(std::forward(value)); + return *this; + } + ///@} + private: + Aws::String m_arn; + + Aws::String m_planFamily; + + Aws::String m_planTier; + + Aws::String m_usageLevel; + + ScheduledChange m_scheduledChange; + + Status m_status{Status::NOT_SET}; + + Aws::String m_statusReason; + + Aws::Vector m_resourceArns; + + Aws::Utils::DateTime m_createdAt{}; + + Aws::Utils::DateTime m_updatedAt{}; + + Aws::String m_eTag; + bool m_arnHasBeenSet = false; + bool m_planFamilyHasBeenSet = false; + bool m_planTierHasBeenSet = false; + bool m_usageLevelHasBeenSet = false; + bool m_scheduledChangeHasBeenSet = false; + bool m_statusHasBeenSet = false; + bool m_statusReasonHasBeenSet = false; + bool m_resourceArnsHasBeenSet = false; + bool m_createdAtHasBeenSet = false; + bool m_updatedAtHasBeenSet = false; + bool m_eTagHasBeenSet = false; +}; + +} // namespace Model +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/UpdateSubscriptionRequest.h b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/UpdateSubscriptionRequest.h new file mode 100644 index 000000000000..8739886a5243 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/UpdateSubscriptionRequest.h @@ -0,0 +1,146 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include +#include + +#include + +namespace Aws { +namespace PricingPlanManager { +namespace Model { + +/** + */ +class UpdateSubscriptionRequest : public PricingPlanManagerRequest { + public: + AWS_PRICINGPLANMANAGER_API UpdateSubscriptionRequest() = default; + + // Service request name is the Operation name which will send this request out, + // each operation should has unique request name, so that we can get operation's name from this request. + // Note: this is not true for response, multiple operations may have the same response name, + // so we can not get operation's name from response. + inline virtual const char* GetServiceRequestName() const override { return "UpdateSubscription"; } + + AWS_PRICINGPLANMANAGER_API Aws::String SerializePayload() const override; + + AWS_PRICINGPLANMANAGER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; + + ///@{ + /** + *

The ARN of the subscription to update.

+ */ + inline const Aws::String& GetArn() const { return m_arn; } + inline bool ArnHasBeenSet() const { return m_arnHasBeenSet; } + template + void SetArn(ArnT&& value) { + m_arnHasBeenSet = true; + m_arn = std::forward(value); + } + template + UpdateSubscriptionRequest& WithArn(ArnT&& value) { + SetArn(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The new tier level for the subscription.

+ */ + inline const Aws::String& GetPlanTier() const { return m_planTier; } + inline bool PlanTierHasBeenSet() const { return m_planTierHasBeenSet; } + template + void SetPlanTier(PlanTierT&& value) { + m_planTierHasBeenSet = true; + m_planTier = std::forward(value); + } + template + UpdateSubscriptionRequest& WithPlanTier(PlanTierT&& value) { + SetPlanTier(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The usage level within the plan tier. Specify DEFAULT for the + * base configuration. If omitted, the usage level is reset to the default.

+ */ + inline const Aws::String& GetUsageLevel() const { return m_usageLevel; } + inline bool UsageLevelHasBeenSet() const { return m_usageLevelHasBeenSet; } + template + void SetUsageLevel(UsageLevelT&& value) { + m_usageLevelHasBeenSet = true; + m_usageLevel = std::forward(value); + } + template + UpdateSubscriptionRequest& WithUsageLevel(UsageLevelT&& value) { + SetUsageLevel(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The ETag value from a previous GetSubscription or + * ListSubscriptions response. This ensures you are updating the + * expected version of the subscription.

+ */ + inline const Aws::String& GetIfMatch() const { return m_ifMatch; } + inline bool IfMatchHasBeenSet() const { return m_ifMatchHasBeenSet; } + template + void SetIfMatch(IfMatchT&& value) { + m_ifMatchHasBeenSet = true; + m_ifMatch = std::forward(value); + } + template + UpdateSubscriptionRequest& WithIfMatch(IfMatchT&& value) { + SetIfMatch(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

A unique, case-sensitive identifier that you provide to ensure the request is + * handled only once.

+ */ + inline const Aws::String& GetClientToken() const { return m_clientToken; } + inline bool ClientTokenHasBeenSet() const { return m_clientTokenHasBeenSet; } + template + void SetClientToken(ClientTokenT&& value) { + m_clientTokenHasBeenSet = true; + m_clientToken = std::forward(value); + } + template + UpdateSubscriptionRequest& WithClientToken(ClientTokenT&& value) { + SetClientToken(std::forward(value)); + return *this; + } + ///@} + private: + Aws::String m_arn; + + Aws::String m_planTier; + + Aws::String m_usageLevel; + + Aws::String m_ifMatch; + + Aws::String m_clientToken{Aws::Utils::UUID::PseudoRandomUUID()}; + bool m_arnHasBeenSet = false; + bool m_planTierHasBeenSet = false; + bool m_usageLevelHasBeenSet = false; + bool m_ifMatchHasBeenSet = false; + bool m_clientTokenHasBeenSet = true; +}; + +} // namespace Model +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/UpdateSubscriptionResult.h b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/UpdateSubscriptionResult.h new file mode 100644 index 000000000000..9bb4a2802499 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/UpdateSubscriptionResult.h @@ -0,0 +1,97 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include +#include +#include + +#include + +namespace Aws { +template +class AmazonWebServiceResult; + +namespace Utils { +namespace Json { +class JsonValue; +} // namespace Json +} // namespace Utils +namespace PricingPlanManager { +namespace Model { +class UpdateSubscriptionResult { + public: + AWS_PRICINGPLANMANAGER_API UpdateSubscriptionResult() = default; + AWS_PRICINGPLANMANAGER_API UpdateSubscriptionResult(const Aws::AmazonWebServiceResult& result); + AWS_PRICINGPLANMANAGER_API UpdateSubscriptionResult& operator=(const Aws::AmazonWebServiceResult& result); + + ///@{ + /** + *

The details of the updated subscription. For downgrades, the current tier + * remains unchanged and a scheduledChange indicates the pending + * change.

+ */ + inline const Subscription& GetSubscription() const { return m_subscription; } + template + void SetSubscription(SubscriptionT&& value) { + m_subscriptionHasBeenSet = true; + m_subscription = std::forward(value); + } + template + UpdateSubscriptionResult& WithSubscription(SubscriptionT&& value) { + SetSubscription(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The updated entity tag for concurrency control.

+ */ + inline const Aws::String& GetETag() const { return m_eTag; } + template + void SetETag(ETagT&& value) { + m_eTagHasBeenSet = true; + m_eTag = std::forward(value); + } + template + UpdateSubscriptionResult& WithETag(ETagT&& value) { + SetETag(std::forward(value)); + return *this; + } + ///@} + + ///@{ + + inline const Aws::String& GetRequestId() const { return m_requestId; } + template + void SetRequestId(RequestIdT&& value) { + m_requestIdHasBeenSet = true; + m_requestId = std::forward(value); + } + template + UpdateSubscriptionResult& WithRequestId(RequestIdT&& value) { + SetRequestId(std::forward(value)); + return *this; + } + ///@} + inline Aws::Http::HttpResponseCode GetHttpResponseCode() const { return m_HttpResponseCode; } + + private: + Subscription m_subscription; + + Aws::String m_eTag; + + Aws::String m_requestId; + Aws::Http::HttpResponseCode m_HttpResponseCode; + bool m_subscriptionHasBeenSet = false; + bool m_eTagHasBeenSet = false; + bool m_requestIdHasBeenSet = false; +}; + +} // namespace Model +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ValidationException.h b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ValidationException.h new file mode 100644 index 000000000000..1bc5d5bfa6e7 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/include/aws/pricing-plan-manager/model/ValidationException.h @@ -0,0 +1,80 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include +#include + +#include + +namespace Aws { +namespace Utils { +namespace Json { +class JsonValue; +class JsonView; +} // namespace Json +} // namespace Utils +namespace PricingPlanManager { +namespace Model { + +/** + *

The request failed a business rule validation. For example, the specified + * resource might already be associated with another subscription, or the + * subscription might not be in the required state for this + * operation.

See Also:

AWS + * API Reference

+ */ +class ValidationException { + public: + AWS_PRICINGPLANMANAGER_API ValidationException() = default; + AWS_PRICINGPLANMANAGER_API ValidationException(Aws::Utils::Json::JsonView jsonValue); + AWS_PRICINGPLANMANAGER_API ValidationException& operator=(Aws::Utils::Json::JsonView jsonValue); + AWS_PRICINGPLANMANAGER_API Aws::Utils::Json::JsonValue Jsonize() const; + + ///@{ + + inline const Aws::String& GetMessage() const { return m_message; } + inline bool MessageHasBeenSet() const { return m_messageHasBeenSet; } + template + void SetMessage(MessageT&& value) { + m_messageHasBeenSet = true; + m_message = std::forward(value); + } + template + ValidationException& WithMessage(MessageT&& value) { + SetMessage(std::forward(value)); + return *this; + } + ///@} + + ///@{ + /** + *

The identifier of the resource that failed validation.

+ */ + inline const Aws::String& GetResourceId() const { return m_resourceId; } + inline bool ResourceIdHasBeenSet() const { return m_resourceIdHasBeenSet; } + template + void SetResourceId(ResourceIdT&& value) { + m_resourceIdHasBeenSet = true; + m_resourceId = std::forward(value); + } + template + ValidationException& WithResourceId(ResourceIdT&& value) { + SetResourceId(std::forward(value)); + return *this; + } + ///@} + private: + Aws::String m_message; + + Aws::String m_resourceId; + bool m_messageHasBeenSet = false; + bool m_resourceIdHasBeenSet = false; +}; + +} // namespace Model +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/source/PricingPlanManagerClient.cpp b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/PricingPlanManagerClient.cpp new file mode 100644 index 000000000000..31179d910f98 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/PricingPlanManagerClient.cpp @@ -0,0 +1,326 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +using namespace Aws; +using namespace Aws::Auth; +using namespace Aws::Client; +using namespace Aws::PricingPlanManager; +using namespace Aws::PricingPlanManager::Model; +using namespace Aws::Http; +using namespace Aws::Utils::Json; +using namespace smithy::components::tracing; +using ResolveEndpointOutcome = Aws::Endpoint::ResolveEndpointOutcome; + +namespace Aws { +namespace PricingPlanManager { +const char SERVICE_NAME[] = "pricingplanmanager"; +const char ALLOCATION_TAG[] = "PricingPlanManagerClient"; +} // namespace PricingPlanManager +} // namespace Aws +const char* PricingPlanManagerClient::GetServiceName() { return SERVICE_NAME; } +const char* PricingPlanManagerClient::GetAllocationTag() { return ALLOCATION_TAG; } + +PricingPlanManagerClient::PricingPlanManagerClient(const PricingPlanManager::PricingPlanManagerClientConfiguration& clientConfiguration, + std::shared_ptr endpointProvider) + : BASECLASS(clientConfiguration, + Aws::MakeShared(ALLOCATION_TAG, + Aws::MakeShared( + ALLOCATION_TAG, clientConfiguration.ResolveCredentialProviderConfig()), + SERVICE_NAME, Aws::Region::ComputeSignerRegion(clientConfiguration.region)), + Aws::MakeShared(ALLOCATION_TAG)), + m_clientConfiguration(clientConfiguration), + m_endpointProvider(endpointProvider ? std::move(endpointProvider) + : Aws::MakeShared(ALLOCATION_TAG)) { + init(m_clientConfiguration); +} + +PricingPlanManagerClient::PricingPlanManagerClient(const AWSCredentials& credentials, + std::shared_ptr endpointProvider, + const PricingPlanManager::PricingPlanManagerClientConfiguration& clientConfiguration) + : BASECLASS(clientConfiguration, + Aws::MakeShared(ALLOCATION_TAG, Aws::MakeShared(ALLOCATION_TAG, credentials), + SERVICE_NAME, Aws::Region::ComputeSignerRegion(clientConfiguration.region)), + Aws::MakeShared(ALLOCATION_TAG)), + m_clientConfiguration(clientConfiguration), + m_endpointProvider(endpointProvider ? std::move(endpointProvider) + : Aws::MakeShared(ALLOCATION_TAG)) { + init(m_clientConfiguration); +} + +PricingPlanManagerClient::PricingPlanManagerClient(const std::shared_ptr& credentialsProvider, + std::shared_ptr endpointProvider, + const PricingPlanManager::PricingPlanManagerClientConfiguration& clientConfiguration) + : BASECLASS(clientConfiguration, + Aws::MakeShared(ALLOCATION_TAG, credentialsProvider, SERVICE_NAME, + Aws::Region::ComputeSignerRegion(clientConfiguration.region)), + Aws::MakeShared(ALLOCATION_TAG)), + m_clientConfiguration(clientConfiguration), + m_endpointProvider(endpointProvider ? std::move(endpointProvider) + : Aws::MakeShared(ALLOCATION_TAG)) { + init(m_clientConfiguration); +} + +/* Legacy constructors due deprecation */ +PricingPlanManagerClient::PricingPlanManagerClient(const Aws::Client::ClientConfiguration& clientConfiguration) + : BASECLASS(clientConfiguration, + Aws::MakeShared(ALLOCATION_TAG, + Aws::MakeShared( + ALLOCATION_TAG, clientConfiguration.ResolveCredentialProviderConfig()), + SERVICE_NAME, Aws::Region::ComputeSignerRegion(clientConfiguration.region)), + Aws::MakeShared(ALLOCATION_TAG)), + m_clientConfiguration(clientConfiguration), + m_endpointProvider(Aws::MakeShared(ALLOCATION_TAG)) { + init(m_clientConfiguration); +} + +PricingPlanManagerClient::PricingPlanManagerClient(const AWSCredentials& credentials, + const Aws::Client::ClientConfiguration& clientConfiguration) + : BASECLASS(clientConfiguration, + Aws::MakeShared(ALLOCATION_TAG, Aws::MakeShared(ALLOCATION_TAG, credentials), + SERVICE_NAME, Aws::Region::ComputeSignerRegion(clientConfiguration.region)), + Aws::MakeShared(ALLOCATION_TAG)), + m_clientConfiguration(clientConfiguration), + m_endpointProvider(Aws::MakeShared(ALLOCATION_TAG)) { + init(m_clientConfiguration); +} + +PricingPlanManagerClient::PricingPlanManagerClient(const std::shared_ptr& credentialsProvider, + const Aws::Client::ClientConfiguration& clientConfiguration) + : BASECLASS(clientConfiguration, + Aws::MakeShared(ALLOCATION_TAG, credentialsProvider, SERVICE_NAME, + Aws::Region::ComputeSignerRegion(clientConfiguration.region)), + Aws::MakeShared(ALLOCATION_TAG)), + m_clientConfiguration(clientConfiguration), + m_endpointProvider(Aws::MakeShared(ALLOCATION_TAG)) { + init(m_clientConfiguration); +} + +/* End of legacy constructors due deprecation */ +PricingPlanManagerClient::~PricingPlanManagerClient() { ShutdownSdkClient(this, -1); } + +std::shared_ptr& PricingPlanManagerClient::accessEndpointProvider() { return m_endpointProvider; } + +void PricingPlanManagerClient::init(const PricingPlanManager::PricingPlanManagerClientConfiguration& config) { + AWSClient::SetServiceClientName("Pricing Plan Manager"); + if (!m_clientConfiguration.executor) { + if (!m_clientConfiguration.configFactories.executorCreateFn()) { + AWS_LOGSTREAM_FATAL(ALLOCATION_TAG, "Failed to initialize client: config is missing Executor or executorCreateFn"); + m_isInitialized = false; + return; + } + m_clientConfiguration.executor = m_clientConfiguration.configFactories.executorCreateFn(); + } + AWS_CHECK_PTR(SERVICE_NAME, m_endpointProvider); + m_endpointProvider->InitBuiltInParameters(config, "pricingplanmanager"); +} + +void PricingPlanManagerClient::OverrideEndpoint(const Aws::String& endpoint) { + AWS_CHECK_PTR(SERVICE_NAME, m_endpointProvider); + m_clientConfiguration.endpointOverride = endpoint; + m_endpointProvider->OverrideEndpoint(endpoint); +} +PricingPlanManagerClient::InvokeOperationOutcome PricingPlanManagerClient::InvokeServiceOperation( + const AmazonWebServiceRequest& request, const std::function& resolveUri, + Aws::Http::HttpMethod httpMethod) const { + auto operationName = request.GetServiceRequestName(); + auto serviceName = GetServiceClientName(); + + AWS_OPERATION_GUARD_DYNAMIC(operationName); + + AWS_OPERATION_CHECK_PTR_DYNAMIC(m_endpointProvider, operationName, CoreErrors, CoreErrors::ENDPOINT_RESOLUTION_FAILURE); + AWS_OPERATION_CHECK_PTR_DYNAMIC(m_telemetryProvider, operationName, CoreErrors, CoreErrors::NOT_INITIALIZED); + + auto tracer = m_telemetryProvider->getTracer(serviceName, {}); + auto meter = m_telemetryProvider->getMeter(serviceName, {}); + AWS_OPERATION_CHECK_PTR_DYNAMIC(meter, operationName, CoreErrors, CoreErrors::NOT_INITIALIZED); + + auto span = tracer->CreateSpan(Aws::String(serviceName) + "." + operationName, + {{TracingUtils::SMITHY_METHOD_DIMENSION, operationName}, + {TracingUtils::SMITHY_SERVICE_DIMENSION, serviceName}, + {TracingUtils::SMITHY_SYSTEM_DIMENSION, TracingUtils::SMITHY_METHOD_AWS_VALUE}}, + smithy::components::tracing::SpanKind::CLIENT); + + return TracingUtils::MakeCallWithTiming( + [&]() -> InvokeOperationOutcome { + auto endpointResolutionOutcome = TracingUtils::MakeCallWithTiming( + [&]() -> ResolveEndpointOutcome { return m_endpointProvider->ResolveEndpoint(request.GetEndpointContextParams()); }, + TracingUtils::SMITHY_CLIENT_ENDPOINT_RESOLUTION_METRIC, *meter, + {{TracingUtils::SMITHY_METHOD_DIMENSION, operationName}, {TracingUtils::SMITHY_SERVICE_DIMENSION, serviceName}}); + + AWS_OPERATION_CHECK_SUCCESS_DYNAMIC(endpointResolutionOutcome, operationName, CoreErrors, CoreErrors::ENDPOINT_RESOLUTION_FAILURE, + endpointResolutionOutcome.GetError().GetMessage()); + + resolveUri(endpointResolutionOutcome); + + return InvokeOperationOutcome{MakeRequest(request, endpointResolutionOutcome.GetResult(), httpMethod, Aws::Auth::SIGV4_SIGNER)}; + }, + TracingUtils::SMITHY_CLIENT_DURATION_METRIC, *meter, + {{TracingUtils::SMITHY_METHOD_DIMENSION, operationName}, {TracingUtils::SMITHY_SERVICE_DIMENSION, serviceName}}); +} + +ApprovePaidSubscriptionOutcome PricingPlanManagerClient::ApprovePaidSubscription(const ApprovePaidSubscriptionRequest& request) const { + if (!request.IfMatchHasBeenSet()) { + AWS_LOGSTREAM_ERROR("ApprovePaidSubscription", "Required field: IfMatch, is not set"); + return ApprovePaidSubscriptionOutcome(Aws::Client::AWSError( + PricingPlanManagerErrors::MISSING_PARAMETER, "MISSING_PARAMETER", "Missing required field [IfMatch]", false)); + } + + auto uriResolver = [&](Aws::Endpoint::ResolveEndpointOutcome& endpointResolutionOutcome) { + (void)endpointResolutionOutcome; + endpointResolutionOutcome.GetResult().AddPathSegments("/v1/ApprovePaidSubscription"); + }; + + auto result = InvokeServiceOperation(request, uriResolver, Aws::Http::HttpMethod::HTTP_POST); + return result.IsSuccess() ? ApprovePaidSubscriptionOutcome(result.GetResultWithOwnership()) + : ApprovePaidSubscriptionOutcome(std::move(result.GetError())); +} + +AssociateResourcesToSubscriptionOutcome PricingPlanManagerClient::AssociateResourcesToSubscription( + const AssociateResourcesToSubscriptionRequest& request) const { + if (!request.IfMatchHasBeenSet()) { + AWS_LOGSTREAM_ERROR("AssociateResourcesToSubscription", "Required field: IfMatch, is not set"); + return AssociateResourcesToSubscriptionOutcome(Aws::Client::AWSError( + PricingPlanManagerErrors::MISSING_PARAMETER, "MISSING_PARAMETER", "Missing required field [IfMatch]", false)); + } + + auto uriResolver = [&](Aws::Endpoint::ResolveEndpointOutcome& endpointResolutionOutcome) { + (void)endpointResolutionOutcome; + endpointResolutionOutcome.GetResult().AddPathSegments("/v1/AssociateResourcesToSubscription"); + }; + + auto result = InvokeServiceOperation(request, uriResolver, Aws::Http::HttpMethod::HTTP_POST); + return result.IsSuccess() ? AssociateResourcesToSubscriptionOutcome(result.GetResultWithOwnership()) + : AssociateResourcesToSubscriptionOutcome(std::move(result.GetError())); +} + +CancelSubscriptionOutcome PricingPlanManagerClient::CancelSubscription(const CancelSubscriptionRequest& request) const { + if (!request.IfMatchHasBeenSet()) { + AWS_LOGSTREAM_ERROR("CancelSubscription", "Required field: IfMatch, is not set"); + return CancelSubscriptionOutcome(Aws::Client::AWSError( + PricingPlanManagerErrors::MISSING_PARAMETER, "MISSING_PARAMETER", "Missing required field [IfMatch]", false)); + } + + auto uriResolver = [&](Aws::Endpoint::ResolveEndpointOutcome& endpointResolutionOutcome) { + (void)endpointResolutionOutcome; + endpointResolutionOutcome.GetResult().AddPathSegments("/v1/CancelSubscription"); + }; + + auto result = InvokeServiceOperation(request, uriResolver, Aws::Http::HttpMethod::HTTP_POST); + return result.IsSuccess() ? CancelSubscriptionOutcome(result.GetResultWithOwnership()) + : CancelSubscriptionOutcome(std::move(result.GetError())); +} + +CancelSubscriptionChangeOutcome PricingPlanManagerClient::CancelSubscriptionChange(const CancelSubscriptionChangeRequest& request) const { + if (!request.IfMatchHasBeenSet()) { + AWS_LOGSTREAM_ERROR("CancelSubscriptionChange", "Required field: IfMatch, is not set"); + return CancelSubscriptionChangeOutcome(Aws::Client::AWSError( + PricingPlanManagerErrors::MISSING_PARAMETER, "MISSING_PARAMETER", "Missing required field [IfMatch]", false)); + } + + auto uriResolver = [&](Aws::Endpoint::ResolveEndpointOutcome& endpointResolutionOutcome) { + (void)endpointResolutionOutcome; + endpointResolutionOutcome.GetResult().AddPathSegments("/v1/CancelSubscriptionChange"); + }; + + auto result = InvokeServiceOperation(request, uriResolver, Aws::Http::HttpMethod::HTTP_POST); + return result.IsSuccess() ? CancelSubscriptionChangeOutcome(result.GetResultWithOwnership()) + : CancelSubscriptionChangeOutcome(std::move(result.GetError())); +} + +CreateSubscriptionOutcome PricingPlanManagerClient::CreateSubscription(const CreateSubscriptionRequest& request) const { + auto uriResolver = [&](Aws::Endpoint::ResolveEndpointOutcome& endpointResolutionOutcome) { + (void)endpointResolutionOutcome; + endpointResolutionOutcome.GetResult().AddPathSegments("/v1/CreateSubscription"); + }; + + auto result = InvokeServiceOperation(request, uriResolver, Aws::Http::HttpMethod::HTTP_POST); + return result.IsSuccess() ? CreateSubscriptionOutcome(result.GetResultWithOwnership()) + : CreateSubscriptionOutcome(std::move(result.GetError())); +} + +DisassociateResourcesFromSubscriptionOutcome PricingPlanManagerClient::DisassociateResourcesFromSubscription( + const DisassociateResourcesFromSubscriptionRequest& request) const { + if (!request.IfMatchHasBeenSet()) { + AWS_LOGSTREAM_ERROR("DisassociateResourcesFromSubscription", "Required field: IfMatch, is not set"); + return DisassociateResourcesFromSubscriptionOutcome(Aws::Client::AWSError( + PricingPlanManagerErrors::MISSING_PARAMETER, "MISSING_PARAMETER", "Missing required field [IfMatch]", false)); + } + + auto uriResolver = [&](Aws::Endpoint::ResolveEndpointOutcome& endpointResolutionOutcome) { + (void)endpointResolutionOutcome; + endpointResolutionOutcome.GetResult().AddPathSegments("/v1/DisassociateResourcesFromSubscription"); + }; + + auto result = InvokeServiceOperation(request, uriResolver, Aws::Http::HttpMethod::HTTP_POST); + return result.IsSuccess() ? DisassociateResourcesFromSubscriptionOutcome(result.GetResultWithOwnership()) + : DisassociateResourcesFromSubscriptionOutcome(std::move(result.GetError())); +} + +GetSubscriptionOutcome PricingPlanManagerClient::GetSubscription(const GetSubscriptionRequest& request) const { + auto uriResolver = [&](Aws::Endpoint::ResolveEndpointOutcome& endpointResolutionOutcome) { + (void)endpointResolutionOutcome; + endpointResolutionOutcome.GetResult().AddPathSegments("/v1/GetSubscription"); + }; + + auto result = InvokeServiceOperation(request, uriResolver, Aws::Http::HttpMethod::HTTP_POST); + return result.IsSuccess() ? GetSubscriptionOutcome(result.GetResultWithOwnership()) + : GetSubscriptionOutcome(std::move(result.GetError())); +} + +ListSubscriptionsOutcome PricingPlanManagerClient::ListSubscriptions(const ListSubscriptionsRequest& request) const { + auto uriResolver = [&](Aws::Endpoint::ResolveEndpointOutcome& endpointResolutionOutcome) { + (void)endpointResolutionOutcome; + endpointResolutionOutcome.GetResult().AddPathSegments("/v1/ListSubscriptions"); + }; + + auto result = InvokeServiceOperation(request, uriResolver, Aws::Http::HttpMethod::HTTP_POST); + return result.IsSuccess() ? ListSubscriptionsOutcome(result.GetResultWithOwnership()) + : ListSubscriptionsOutcome(std::move(result.GetError())); +} + +UpdateSubscriptionOutcome PricingPlanManagerClient::UpdateSubscription(const UpdateSubscriptionRequest& request) const { + if (!request.IfMatchHasBeenSet()) { + AWS_LOGSTREAM_ERROR("UpdateSubscription", "Required field: IfMatch, is not set"); + return UpdateSubscriptionOutcome(Aws::Client::AWSError( + PricingPlanManagerErrors::MISSING_PARAMETER, "MISSING_PARAMETER", "Missing required field [IfMatch]", false)); + } + + auto uriResolver = [&](Aws::Endpoint::ResolveEndpointOutcome& endpointResolutionOutcome) { + (void)endpointResolutionOutcome; + endpointResolutionOutcome.GetResult().AddPathSegments("/v1/UpdateSubscription"); + }; + + auto result = InvokeServiceOperation(request, uriResolver, Aws::Http::HttpMethod::HTTP_POST); + return result.IsSuccess() ? UpdateSubscriptionOutcome(result.GetResultWithOwnership()) + : UpdateSubscriptionOutcome(std::move(result.GetError())); +} diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/source/PricingPlanManagerEndpointProvider.cpp b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/PricingPlanManagerEndpointProvider.cpp new file mode 100644 index 000000000000..fe1915f923ae --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/PricingPlanManagerEndpointProvider.cpp @@ -0,0 +1,18 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include + +namespace Aws { +namespace PricingPlanManager { +namespace Endpoint { +PricingPlanManagerEndpointProvider::PricingPlanManagerEndpointProvider() + : PricingPlanManagerDefaultEpProviderBase(Aws::PricingPlanManager::PricingPlanManagerEndpointRules::GetRulesBlob(), + Aws::PricingPlanManager::PricingPlanManagerEndpointRules::RulesBlobSize) {} + +} // namespace Endpoint +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/source/PricingPlanManagerEndpointRules.cpp b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/PricingPlanManagerEndpointRules.cpp new file mode 100644 index 000000000000..5d9844177279 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/PricingPlanManagerEndpointRules.cpp @@ -0,0 +1,53 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include + +namespace Aws { +namespace PricingPlanManager { +const size_t PricingPlanManagerEndpointRules::RulesBlobStrLen = 871; +const size_t PricingPlanManagerEndpointRules::RulesBlobSize = 872; + +using RulesBlobT = Aws::Array; +static constexpr RulesBlobT RulesBlob = { + {'{', '"', 'v', 'e', 'r', 's', 'i', 'o', 'n', '"', ':', '"', '1', '.', '0', '"', ',', '"', 'p', 'a', 'r', 'a', 'm', 'e', 't', 'e', 'r', + 's', '"', ':', '{', '"', 'E', 'n', 'd', 'p', 'o', 'i', 'n', 't', '"', ':', '{', '"', 't', 'y', 'p', 'e', '"', ':', '"', 'S', 't', 'r', + 'i', 'n', 'g', '"', ',', '"', 'b', 'u', 'i', 'l', 't', 'I', 'n', '"', ':', '"', 'S', 'D', 'K', ':', ':', 'E', 'n', 'd', 'p', 'o', 'i', + 'n', 't', '"', ',', '"', 'r', 'e', 'q', 'u', 'i', 'r', 'e', 'd', '"', ':', 'f', 'a', 'l', 's', 'e', ',', '"', 'd', 'o', 'c', 'u', 'm', + 'e', 'n', 't', 'a', 't', 'i', 'o', 'n', '"', ':', '"', 'O', 'v', 'e', 'r', 'r', 'i', 'd', 'e', ' ', 't', 'h', 'e', ' ', 'e', 'n', 'd', + 'p', 'o', 'i', 'n', 't', ' ', 'U', 'R', 'L', '"', '}', ',', '"', 'R', 'e', 'g', 'i', 'o', 'n', '"', ':', '{', '"', 't', 'y', 'p', 'e', + '"', ':', '"', 'S', 't', 'r', 'i', 'n', 'g', '"', ',', '"', 'b', 'u', 'i', 'l', 't', 'I', 'n', '"', ':', '"', 'A', 'W', 'S', ':', ':', + 'R', 'e', 'g', 'i', 'o', 'n', '"', ',', '"', 'r', 'e', 'q', 'u', 'i', 'r', 'e', 'd', '"', ':', 't', 'r', 'u', 'e', ',', '"', 'd', 'o', + 'c', 'u', 'm', 'e', 'n', 't', 'a', 't', 'i', 'o', 'n', '"', ':', '"', 'T', 'h', 'e', ' ', 'A', 'W', 'S', ' ', 'r', 'e', 'g', 'i', 'o', + 'n', '"', '}', '}', ',', '"', 'r', 'u', 'l', 'e', 's', '"', ':', '[', '{', '"', 'd', 'o', 'c', 'u', 'm', 'e', 'n', 't', 'a', 't', 'i', + 'o', 'n', '"', ':', '"', 'U', 's', 'e', ' ', 't', 'h', 'e', ' ', 'c', 'u', 's', 't', 'o', 'm', ' ', 'e', 'n', 'd', 'p', 'o', 'i', 'n', + 't', ' ', 'i', 'f', ' ', 'o', 'n', 'e', ' ', 'i', 's', ' ', 'p', 'r', 'o', 'v', 'i', 'd', 'e', 'd', ',', ' ', 's', 'i', 'g', 'n', 'i', + 'n', 'g', ' ', 'f', 'o', 'r', ' ', 'u', 's', '-', 'e', 'a', 's', 't', '-', '1', '.', '"', ',', '"', 't', 'y', 'p', 'e', '"', ':', '"', + 'e', 'n', 'd', 'p', 'o', 'i', 'n', 't', '"', ',', '"', 'c', 'o', 'n', 'd', 'i', 't', 'i', 'o', 'n', 's', '"', ':', '[', '{', '"', 'f', + 'n', '"', ':', '"', 'i', 's', 'S', 'e', 't', '"', ',', '"', 'a', 'r', 'g', 'v', '"', ':', '[', '{', '"', 'r', 'e', 'f', '"', ':', '"', + 'E', 'n', 'd', 'p', 'o', 'i', 'n', 't', '"', '}', ']', '}', ']', ',', '"', 'e', 'n', 'd', 'p', 'o', 'i', 'n', 't', '"', ':', '{', '"', + 'u', 'r', 'l', '"', ':', '"', '{', 'E', 'n', 'd', 'p', 'o', 'i', 'n', 't', '}', '"', ',', '"', 'p', 'r', 'o', 'p', 'e', 'r', 't', 'i', + 'e', 's', '"', ':', '{', '"', 'a', 'u', 't', 'h', 'S', 'c', 'h', 'e', 'm', 'e', 's', '"', ':', '[', '{', '"', 'n', 'a', 'm', 'e', '"', + ':', '"', 's', 'i', 'g', 'v', '4', '"', ',', '"', 's', 'i', 'g', 'n', 'i', 'n', 'g', 'N', 'a', 'm', 'e', '"', ':', '"', 'p', 'r', 'i', + 'c', 'i', 'n', 'g', 'p', 'l', 'a', 'n', 'm', 'a', 'n', 'a', 'g', 'e', 'r', '"', ',', '"', 's', 'i', 'g', 'n', 'i', 'n', 'g', 'R', 'e', + 'g', 'i', 'o', 'n', '"', ':', '"', 'u', 's', '-', 'e', 'a', 's', 't', '-', '1', '"', '}', ']', '}', '}', '}', ',', '{', '"', 'd', 'o', + 'c', 'u', 'm', 'e', 'n', 't', 'a', 't', 'i', 'o', 'n', '"', ':', '"', 'R', 'o', 'u', 't', 'e', ' ', 'e', 'v', 'e', 'r', 'y', ' ', 'r', + 'e', 'g', 'i', 'o', 'n', ' ', 't', 'o', ' ', 't', 'h', 'e', ' ', 's', 'i', 'n', 'g', 'l', 'e', ' ', 'u', 's', '-', 'e', 'a', 's', 't', + '-', '1', ' ', 'e', 'n', 'd', 'p', 'o', 'i', 'n', 't', ',', ' ', 's', 'i', 'g', 'n', 'i', 'n', 'g', ' ', 'f', 'o', 'r', ' ', 'u', 's', + '-', 'e', 'a', 's', 't', '-', '1', '.', '"', ',', '"', 't', 'y', 'p', 'e', '"', ':', '"', 'e', 'n', 'd', 'p', 'o', 'i', 'n', 't', '"', + ',', '"', 'c', 'o', 'n', 'd', 'i', 't', 'i', 'o', 'n', 's', '"', ':', '[', ']', ',', '"', 'e', 'n', 'd', 'p', 'o', 'i', 'n', 't', '"', + ':', '{', '"', 'u', 'r', 'l', '"', ':', '"', 'h', 't', 't', 'p', 's', ':', '/', '/', 'p', 'r', 'i', 'c', 'i', 'n', 'g', 'p', 'l', 'a', + 'n', 'm', 'a', 'n', 'a', 'g', 'e', 'r', '.', 'u', 's', '-', 'e', 'a', 's', 't', '-', '1', '.', 'a', 'p', 'i', '.', 'a', 'w', 's', '"', + ',', '"', 'p', 'r', 'o', 'p', 'e', 'r', 't', 'i', 'e', 's', '"', ':', '{', '"', 'a', 'u', 't', 'h', 'S', 'c', 'h', 'e', 'm', 'e', 's', + '"', ':', '[', '{', '"', 'n', 'a', 'm', 'e', '"', ':', '"', 's', 'i', 'g', 'v', '4', '"', ',', '"', 's', 'i', 'g', 'n', 'i', 'n', 'g', + 'N', 'a', 'm', 'e', '"', ':', '"', 'p', 'r', 'i', 'c', 'i', 'n', 'g', 'p', 'l', 'a', 'n', 'm', 'a', 'n', 'a', 'g', 'e', 'r', '"', ',', + '"', 's', 'i', 'g', 'n', 'i', 'n', 'g', 'R', 'e', 'g', 'i', 'o', 'n', '"', ':', '"', 'u', 's', '-', 'e', 'a', 's', 't', '-', '1', '"', + '}', ']', '}', '}', '}', ']', '}', '\0'}}; + +const char* PricingPlanManagerEndpointRules::GetRulesBlob() { return RulesBlob.data(); } + +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/source/PricingPlanManagerErrorMarshaller.cpp b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/PricingPlanManagerErrorMarshaller.cpp new file mode 100644 index 000000000000..acbb9866f5d2 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/PricingPlanManagerErrorMarshaller.cpp @@ -0,0 +1,20 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include +#include + +using namespace Aws::Client; +using namespace Aws::PricingPlanManager; + +AWSError PricingPlanManagerErrorMarshaller::FindErrorByName(const char* errorName) const { + AWSError error = PricingPlanManagerErrorMapper::GetErrorForName(errorName); + if (error.GetErrorType() != CoreErrors::UNKNOWN) { + return error; + } + + return AWSErrorMarshaller::FindErrorByName(errorName); +} \ No newline at end of file diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/source/PricingPlanManagerErrors.cpp b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/PricingPlanManagerErrors.cpp new file mode 100644 index 000000000000..1907b5b2cb58 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/PricingPlanManagerErrors.cpp @@ -0,0 +1,59 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include +#include +#include +#include +#include + +using namespace Aws::Client; +using namespace Aws::Utils; +using namespace Aws::PricingPlanManager; +using namespace Aws::PricingPlanManager::Model; + +namespace Aws { +namespace PricingPlanManager { +template <> +AWS_PRICINGPLANMANAGER_API ConflictException PricingPlanManagerError::GetModeledError() { + assert(this->GetErrorType() == PricingPlanManagerErrors::CONFLICT); + return ConflictException(this->GetJsonPayload().View()); +} + +template <> +AWS_PRICINGPLANMANAGER_API ResourceNotFoundException PricingPlanManagerError::GetModeledError() { + assert(this->GetErrorType() == PricingPlanManagerErrors::RESOURCE_NOT_FOUND); + return ResourceNotFoundException(this->GetJsonPayload().View()); +} + +template <> +AWS_PRICINGPLANMANAGER_API ValidationException PricingPlanManagerError::GetModeledError() { + assert(this->GetErrorType() == PricingPlanManagerErrors::VALIDATION); + return ValidationException(this->GetJsonPayload().View()); +} + +namespace PricingPlanManagerErrorMapper { + +static const int CONFLICT_HASH = HashingUtils::HashString("ConflictException"); +static const int SERVICE_QUOTA_EXCEEDED_HASH = HashingUtils::HashString("ServiceQuotaExceededException"); +static const int INTERNAL_SERVER_HASH = HashingUtils::HashString("InternalServerException"); + +AWSError GetErrorForName(const char* errorName) { + int hashCode = HashingUtils::HashString(errorName); + + if (hashCode == CONFLICT_HASH) { + return AWSError(static_cast(PricingPlanManagerErrors::CONFLICT), RetryableType::NOT_RETRYABLE); + } else if (hashCode == SERVICE_QUOTA_EXCEEDED_HASH) { + return AWSError(static_cast(PricingPlanManagerErrors::SERVICE_QUOTA_EXCEEDED), RetryableType::NOT_RETRYABLE); + } else if (hashCode == INTERNAL_SERVER_HASH) { + return AWSError(static_cast(PricingPlanManagerErrors::INTERNAL_SERVER), RetryableType::RETRYABLE); + } + return AWSError(CoreErrors::UNKNOWN, false); +} + +} // namespace PricingPlanManagerErrorMapper +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/source/PricingPlanManagerRequest.cpp b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/PricingPlanManagerRequest.cpp new file mode 100644 index 000000000000..8ec584767f43 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/PricingPlanManagerRequest.cpp @@ -0,0 +1,10 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include + +namespace Aws { +namespace PricingPlanManager {} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/ApprovalMode.cpp b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/ApprovalMode.cpp new file mode 100644 index 000000000000..e6e243acbc35 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/ApprovalMode.cpp @@ -0,0 +1,58 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include +#include +#include + +using namespace Aws::Utils; + +namespace Aws { +namespace PricingPlanManager { +namespace Model { +namespace ApprovalModeMapper { + +static const int MANUAL_HASH = HashingUtils::HashString("MANUAL"); +static const int IMMEDIATE_HASH = HashingUtils::HashString("IMMEDIATE"); + +ApprovalMode GetApprovalModeForName(const Aws::String& name) { + int hashCode = HashingUtils::HashString(name.c_str()); + if (hashCode == MANUAL_HASH) { + return ApprovalMode::MANUAL; + } else if (hashCode == IMMEDIATE_HASH) { + return ApprovalMode::IMMEDIATE; + } + EnumParseOverflowContainer* overflowContainer = Aws::GetEnumOverflowContainer(); + if (overflowContainer) { + overflowContainer->StoreOverflow(hashCode, name); + return static_cast(hashCode); + } + + return ApprovalMode::NOT_SET; +} + +Aws::String GetNameForApprovalMode(ApprovalMode enumValue) { + switch (enumValue) { + case ApprovalMode::NOT_SET: + return {}; + case ApprovalMode::MANUAL: + return "MANUAL"; + case ApprovalMode::IMMEDIATE: + return "IMMEDIATE"; + default: + EnumParseOverflowContainer* overflowContainer = Aws::GetEnumOverflowContainer(); + if (overflowContainer) { + return overflowContainer->RetrieveOverflow(static_cast(enumValue)); + } + + return {}; + } +} + +} // namespace ApprovalModeMapper +} // namespace Model +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/ApprovePaidSubscriptionRequest.cpp b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/ApprovePaidSubscriptionRequest.cpp new file mode 100644 index 000000000000..464cd5f1c254 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/ApprovePaidSubscriptionRequest.cpp @@ -0,0 +1,40 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include +#include + +#include + +using namespace Aws::PricingPlanManager::Model; +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +Aws::String ApprovePaidSubscriptionRequest::SerializePayload() const { + JsonValue payload; + + if (m_arnHasBeenSet) { + payload.WithString("arn", m_arn); + } + + if (m_clientTokenHasBeenSet) { + payload.WithString("clientToken", m_clientToken); + } + + return payload.View().WriteReadable(); +} + +Aws::Http::HeaderValueCollection ApprovePaidSubscriptionRequest::GetRequestSpecificHeaders() const { + Aws::Http::HeaderValueCollection headers; + Aws::StringStream ss; + if (m_ifMatchHasBeenSet) { + ss << m_ifMatch; + headers.emplace("if-match", ss.str()); + ss.str(""); + } + + return headers; +} diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/ApprovePaidSubscriptionResult.cpp b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/ApprovePaidSubscriptionResult.cpp new file mode 100644 index 000000000000..f9fcd2e2086d --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/ApprovePaidSubscriptionResult.cpp @@ -0,0 +1,42 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include +#include +#include +#include +#include + +#include + +using namespace Aws::PricingPlanManager::Model; +using namespace Aws::Utils::Json; +using namespace Aws::Utils; +using namespace Aws; + +ApprovePaidSubscriptionResult::ApprovePaidSubscriptionResult(const Aws::AmazonWebServiceResult& result) { *this = result; } + +ApprovePaidSubscriptionResult& ApprovePaidSubscriptionResult::operator=(const Aws::AmazonWebServiceResult& result) { + m_HttpResponseCode = result.GetResponseCode(); + JsonView jsonValue = result.GetPayload().View(); + m_subscription = jsonValue; + m_subscriptionHasBeenSet = true; + + const auto& headers = result.GetHeaderValueCollection(); + const auto& eTagIter = headers.find("etag"); + if (eTagIter != headers.end()) { + m_eTag = eTagIter->second; + m_eTagHasBeenSet = true; + } + + const auto& requestIdIter = headers.find("x-amzn-requestid"); + if (requestIdIter != headers.end()) { + m_requestId = requestIdIter->second; + m_requestIdHasBeenSet = true; + } + + return *this; +} diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/AssociateResourcesToSubscriptionRequest.cpp b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/AssociateResourcesToSubscriptionRequest.cpp new file mode 100644 index 000000000000..e7f2c18d882f --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/AssociateResourcesToSubscriptionRequest.cpp @@ -0,0 +1,48 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include +#include + +#include + +using namespace Aws::PricingPlanManager::Model; +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +Aws::String AssociateResourcesToSubscriptionRequest::SerializePayload() const { + JsonValue payload; + + if (m_arnHasBeenSet) { + payload.WithString("arn", m_arn); + } + + if (m_resourceArnsHasBeenSet) { + Aws::Utils::Array resourceArnsJsonList(m_resourceArns.size()); + for (unsigned resourceArnsIndex = 0; resourceArnsIndex < resourceArnsJsonList.GetLength(); ++resourceArnsIndex) { + resourceArnsJsonList[resourceArnsIndex].AsString(m_resourceArns[resourceArnsIndex]); + } + payload.WithArray("resourceArns", std::move(resourceArnsJsonList)); + } + + if (m_clientTokenHasBeenSet) { + payload.WithString("clientToken", m_clientToken); + } + + return payload.View().WriteReadable(); +} + +Aws::Http::HeaderValueCollection AssociateResourcesToSubscriptionRequest::GetRequestSpecificHeaders() const { + Aws::Http::HeaderValueCollection headers; + Aws::StringStream ss; + if (m_ifMatchHasBeenSet) { + ss << m_ifMatch; + headers.emplace("if-match", ss.str()); + ss.str(""); + } + + return headers; +} diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/AssociateResourcesToSubscriptionResult.cpp b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/AssociateResourcesToSubscriptionResult.cpp new file mode 100644 index 000000000000..04dead101412 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/AssociateResourcesToSubscriptionResult.cpp @@ -0,0 +1,45 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include +#include +#include +#include +#include + +#include + +using namespace Aws::PricingPlanManager::Model; +using namespace Aws::Utils::Json; +using namespace Aws::Utils; +using namespace Aws; + +AssociateResourcesToSubscriptionResult::AssociateResourcesToSubscriptionResult(const Aws::AmazonWebServiceResult& result) { + *this = result; +} + +AssociateResourcesToSubscriptionResult& AssociateResourcesToSubscriptionResult::operator=( + const Aws::AmazonWebServiceResult& result) { + m_HttpResponseCode = result.GetResponseCode(); + JsonView jsonValue = result.GetPayload().View(); + m_subscription = jsonValue; + m_subscriptionHasBeenSet = true; + + const auto& headers = result.GetHeaderValueCollection(); + const auto& eTagIter = headers.find("etag"); + if (eTagIter != headers.end()) { + m_eTag = eTagIter->second; + m_eTagHasBeenSet = true; + } + + const auto& requestIdIter = headers.find("x-amzn-requestid"); + if (requestIdIter != headers.end()) { + m_requestId = requestIdIter->second; + m_requestIdHasBeenSet = true; + } + + return *this; +} diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/CancelSubscriptionChangeRequest.cpp b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/CancelSubscriptionChangeRequest.cpp new file mode 100644 index 000000000000..99c1b85d5704 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/CancelSubscriptionChangeRequest.cpp @@ -0,0 +1,40 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include +#include + +#include + +using namespace Aws::PricingPlanManager::Model; +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +Aws::String CancelSubscriptionChangeRequest::SerializePayload() const { + JsonValue payload; + + if (m_arnHasBeenSet) { + payload.WithString("arn", m_arn); + } + + if (m_clientTokenHasBeenSet) { + payload.WithString("clientToken", m_clientToken); + } + + return payload.View().WriteReadable(); +} + +Aws::Http::HeaderValueCollection CancelSubscriptionChangeRequest::GetRequestSpecificHeaders() const { + Aws::Http::HeaderValueCollection headers; + Aws::StringStream ss; + if (m_ifMatchHasBeenSet) { + ss << m_ifMatch; + headers.emplace("if-match", ss.str()); + ss.str(""); + } + + return headers; +} diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/CancelSubscriptionChangeResult.cpp b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/CancelSubscriptionChangeResult.cpp new file mode 100644 index 000000000000..653bc8674fb4 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/CancelSubscriptionChangeResult.cpp @@ -0,0 +1,42 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include +#include +#include +#include +#include + +#include + +using namespace Aws::PricingPlanManager::Model; +using namespace Aws::Utils::Json; +using namespace Aws::Utils; +using namespace Aws; + +CancelSubscriptionChangeResult::CancelSubscriptionChangeResult(const Aws::AmazonWebServiceResult& result) { *this = result; } + +CancelSubscriptionChangeResult& CancelSubscriptionChangeResult::operator=(const Aws::AmazonWebServiceResult& result) { + m_HttpResponseCode = result.GetResponseCode(); + JsonView jsonValue = result.GetPayload().View(); + m_subscription = jsonValue; + m_subscriptionHasBeenSet = true; + + const auto& headers = result.GetHeaderValueCollection(); + const auto& eTagIter = headers.find("etag"); + if (eTagIter != headers.end()) { + m_eTag = eTagIter->second; + m_eTagHasBeenSet = true; + } + + const auto& requestIdIter = headers.find("x-amzn-requestid"); + if (requestIdIter != headers.end()) { + m_requestId = requestIdIter->second; + m_requestIdHasBeenSet = true; + } + + return *this; +} diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/CancelSubscriptionRequest.cpp b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/CancelSubscriptionRequest.cpp new file mode 100644 index 000000000000..5493e181a5b9 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/CancelSubscriptionRequest.cpp @@ -0,0 +1,40 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include +#include + +#include + +using namespace Aws::PricingPlanManager::Model; +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +Aws::String CancelSubscriptionRequest::SerializePayload() const { + JsonValue payload; + + if (m_arnHasBeenSet) { + payload.WithString("arn", m_arn); + } + + if (m_clientTokenHasBeenSet) { + payload.WithString("clientToken", m_clientToken); + } + + return payload.View().WriteReadable(); +} + +Aws::Http::HeaderValueCollection CancelSubscriptionRequest::GetRequestSpecificHeaders() const { + Aws::Http::HeaderValueCollection headers; + Aws::StringStream ss; + if (m_ifMatchHasBeenSet) { + ss << m_ifMatch; + headers.emplace("if-match", ss.str()); + ss.str(""); + } + + return headers; +} diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/CancelSubscriptionResult.cpp b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/CancelSubscriptionResult.cpp new file mode 100644 index 000000000000..b6ced812753f --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/CancelSubscriptionResult.cpp @@ -0,0 +1,42 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include +#include +#include +#include +#include + +#include + +using namespace Aws::PricingPlanManager::Model; +using namespace Aws::Utils::Json; +using namespace Aws::Utils; +using namespace Aws; + +CancelSubscriptionResult::CancelSubscriptionResult(const Aws::AmazonWebServiceResult& result) { *this = result; } + +CancelSubscriptionResult& CancelSubscriptionResult::operator=(const Aws::AmazonWebServiceResult& result) { + m_HttpResponseCode = result.GetResponseCode(); + JsonView jsonValue = result.GetPayload().View(); + m_subscription = jsonValue; + m_subscriptionHasBeenSet = true; + + const auto& headers = result.GetHeaderValueCollection(); + const auto& eTagIter = headers.find("etag"); + if (eTagIter != headers.end()) { + m_eTag = eTagIter->second; + m_eTagHasBeenSet = true; + } + + const auto& requestIdIter = headers.find("x-amzn-requestid"); + if (requestIdIter != headers.end()) { + m_requestId = requestIdIter->second; + m_requestIdHasBeenSet = true; + } + + return *this; +} diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/ConflictException.cpp b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/ConflictException.cpp new file mode 100644 index 000000000000..15fa57db6f1a --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/ConflictException.cpp @@ -0,0 +1,48 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include + +#include + +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +namespace Aws { +namespace PricingPlanManager { +namespace Model { + +ConflictException::ConflictException(JsonView jsonValue) { *this = jsonValue; } + +ConflictException& ConflictException::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("message")) { + m_message = jsonValue.GetString("message"); + m_messageHasBeenSet = true; + } + if (jsonValue.ValueExists("resourceId")) { + m_resourceId = jsonValue.GetString("resourceId"); + m_resourceIdHasBeenSet = true; + } + return *this; +} + +JsonValue ConflictException::Jsonize() const { + JsonValue payload; + + if (m_messageHasBeenSet) { + payload.WithString("message", m_message); + } + + if (m_resourceIdHasBeenSet) { + payload.WithString("resourceId", m_resourceId); + } + + return payload; +} + +} // namespace Model +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/CreateSubscriptionRequest.cpp b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/CreateSubscriptionRequest.cpp new file mode 100644 index 000000000000..a6050a2a89b5 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/CreateSubscriptionRequest.cpp @@ -0,0 +1,47 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include + +#include + +using namespace Aws::PricingPlanManager::Model; +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +Aws::String CreateSubscriptionRequest::SerializePayload() const { + JsonValue payload; + + if (m_planFamilyHasBeenSet) { + payload.WithString("planFamily", m_planFamily); + } + + if (m_planTierHasBeenSet) { + payload.WithString("planTier", m_planTier); + } + + if (m_usageLevelHasBeenSet) { + payload.WithString("usageLevel", m_usageLevel); + } + + if (m_resourceArnsHasBeenSet) { + Aws::Utils::Array resourceArnsJsonList(m_resourceArns.size()); + for (unsigned resourceArnsIndex = 0; resourceArnsIndex < resourceArnsJsonList.GetLength(); ++resourceArnsIndex) { + resourceArnsJsonList[resourceArnsIndex].AsString(m_resourceArns[resourceArnsIndex]); + } + payload.WithArray("resourceArns", std::move(resourceArnsJsonList)); + } + + if (m_approvalModeHasBeenSet) { + payload.WithString("approvalMode", ApprovalModeMapper::GetNameForApprovalMode(m_approvalMode)); + } + + if (m_clientTokenHasBeenSet) { + payload.WithString("clientToken", m_clientToken); + } + + return payload.View().WriteReadable(); +} diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/CreateSubscriptionResult.cpp b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/CreateSubscriptionResult.cpp new file mode 100644 index 000000000000..b6225851f68a --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/CreateSubscriptionResult.cpp @@ -0,0 +1,42 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include +#include +#include +#include +#include + +#include + +using namespace Aws::PricingPlanManager::Model; +using namespace Aws::Utils::Json; +using namespace Aws::Utils; +using namespace Aws; + +CreateSubscriptionResult::CreateSubscriptionResult(const Aws::AmazonWebServiceResult& result) { *this = result; } + +CreateSubscriptionResult& CreateSubscriptionResult::operator=(const Aws::AmazonWebServiceResult& result) { + m_HttpResponseCode = result.GetResponseCode(); + JsonView jsonValue = result.GetPayload().View(); + m_subscription = jsonValue; + m_subscriptionHasBeenSet = true; + + const auto& headers = result.GetHeaderValueCollection(); + const auto& eTagIter = headers.find("etag"); + if (eTagIter != headers.end()) { + m_eTag = eTagIter->second; + m_eTagHasBeenSet = true; + } + + const auto& requestIdIter = headers.find("x-amzn-requestid"); + if (requestIdIter != headers.end()) { + m_requestId = requestIdIter->second; + m_requestIdHasBeenSet = true; + } + + return *this; +} diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/DisassociateResourcesFromSubscriptionRequest.cpp b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/DisassociateResourcesFromSubscriptionRequest.cpp new file mode 100644 index 000000000000..30194021d450 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/DisassociateResourcesFromSubscriptionRequest.cpp @@ -0,0 +1,48 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include +#include + +#include + +using namespace Aws::PricingPlanManager::Model; +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +Aws::String DisassociateResourcesFromSubscriptionRequest::SerializePayload() const { + JsonValue payload; + + if (m_arnHasBeenSet) { + payload.WithString("arn", m_arn); + } + + if (m_resourceArnsHasBeenSet) { + Aws::Utils::Array resourceArnsJsonList(m_resourceArns.size()); + for (unsigned resourceArnsIndex = 0; resourceArnsIndex < resourceArnsJsonList.GetLength(); ++resourceArnsIndex) { + resourceArnsJsonList[resourceArnsIndex].AsString(m_resourceArns[resourceArnsIndex]); + } + payload.WithArray("resourceArns", std::move(resourceArnsJsonList)); + } + + if (m_clientTokenHasBeenSet) { + payload.WithString("clientToken", m_clientToken); + } + + return payload.View().WriteReadable(); +} + +Aws::Http::HeaderValueCollection DisassociateResourcesFromSubscriptionRequest::GetRequestSpecificHeaders() const { + Aws::Http::HeaderValueCollection headers; + Aws::StringStream ss; + if (m_ifMatchHasBeenSet) { + ss << m_ifMatch; + headers.emplace("if-match", ss.str()); + ss.str(""); + } + + return headers; +} diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/DisassociateResourcesFromSubscriptionResult.cpp b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/DisassociateResourcesFromSubscriptionResult.cpp new file mode 100644 index 000000000000..6d064beb4096 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/DisassociateResourcesFromSubscriptionResult.cpp @@ -0,0 +1,46 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include +#include +#include +#include +#include + +#include + +using namespace Aws::PricingPlanManager::Model; +using namespace Aws::Utils::Json; +using namespace Aws::Utils; +using namespace Aws; + +DisassociateResourcesFromSubscriptionResult::DisassociateResourcesFromSubscriptionResult( + const Aws::AmazonWebServiceResult& result) { + *this = result; +} + +DisassociateResourcesFromSubscriptionResult& DisassociateResourcesFromSubscriptionResult::operator=( + const Aws::AmazonWebServiceResult& result) { + m_HttpResponseCode = result.GetResponseCode(); + JsonView jsonValue = result.GetPayload().View(); + m_subscription = jsonValue; + m_subscriptionHasBeenSet = true; + + const auto& headers = result.GetHeaderValueCollection(); + const auto& eTagIter = headers.find("etag"); + if (eTagIter != headers.end()) { + m_eTag = eTagIter->second; + m_eTagHasBeenSet = true; + } + + const auto& requestIdIter = headers.find("x-amzn-requestid"); + if (requestIdIter != headers.end()) { + m_requestId = requestIdIter->second; + m_requestIdHasBeenSet = true; + } + + return *this; +} diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/GetSubscriptionRequest.cpp b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/GetSubscriptionRequest.cpp new file mode 100644 index 000000000000..678c6225fa4e --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/GetSubscriptionRequest.cpp @@ -0,0 +1,23 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include + +#include + +using namespace Aws::PricingPlanManager::Model; +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +Aws::String GetSubscriptionRequest::SerializePayload() const { + JsonValue payload; + + if (m_arnHasBeenSet) { + payload.WithString("arn", m_arn); + } + + return payload.View().WriteReadable(); +} diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/GetSubscriptionResult.cpp b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/GetSubscriptionResult.cpp new file mode 100644 index 000000000000..4f049d7d9c49 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/GetSubscriptionResult.cpp @@ -0,0 +1,42 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include +#include +#include +#include +#include + +#include + +using namespace Aws::PricingPlanManager::Model; +using namespace Aws::Utils::Json; +using namespace Aws::Utils; +using namespace Aws; + +GetSubscriptionResult::GetSubscriptionResult(const Aws::AmazonWebServiceResult& result) { *this = result; } + +GetSubscriptionResult& GetSubscriptionResult::operator=(const Aws::AmazonWebServiceResult& result) { + m_HttpResponseCode = result.GetResponseCode(); + JsonView jsonValue = result.GetPayload().View(); + m_subscription = jsonValue; + m_subscriptionHasBeenSet = true; + + const auto& headers = result.GetHeaderValueCollection(); + const auto& eTagIter = headers.find("etag"); + if (eTagIter != headers.end()) { + m_eTag = eTagIter->second; + m_eTagHasBeenSet = true; + } + + const auto& requestIdIter = headers.find("x-amzn-requestid"); + if (requestIdIter != headers.end()) { + m_requestId = requestIdIter->second; + m_requestIdHasBeenSet = true; + } + + return *this; +} diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/ListSubscriptionsRequest.cpp b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/ListSubscriptionsRequest.cpp new file mode 100644 index 000000000000..1dab32a3720a --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/ListSubscriptionsRequest.cpp @@ -0,0 +1,23 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include + +#include + +using namespace Aws::PricingPlanManager::Model; +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +Aws::String ListSubscriptionsRequest::SerializePayload() const { + JsonValue payload; + + if (m_nextTokenHasBeenSet) { + payload.WithString("nextToken", m_nextToken); + } + + return payload.View().WriteReadable(); +} diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/ListSubscriptionsResult.cpp b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/ListSubscriptionsResult.cpp new file mode 100644 index 000000000000..691571061b1f --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/ListSubscriptionsResult.cpp @@ -0,0 +1,46 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include +#include +#include +#include +#include + +#include + +using namespace Aws::PricingPlanManager::Model; +using namespace Aws::Utils::Json; +using namespace Aws::Utils; +using namespace Aws; + +ListSubscriptionsResult::ListSubscriptionsResult(const Aws::AmazonWebServiceResult& result) { *this = result; } + +ListSubscriptionsResult& ListSubscriptionsResult::operator=(const Aws::AmazonWebServiceResult& result) { + m_HttpResponseCode = result.GetResponseCode(); + JsonView jsonValue = result.GetPayload().View(); + if (jsonValue.ValueExists("subscriptionSummaries")) { + Aws::Utils::Array subscriptionSummariesJsonList = jsonValue.GetArray("subscriptionSummaries"); + for (unsigned subscriptionSummariesIndex = 0; subscriptionSummariesIndex < subscriptionSummariesJsonList.GetLength(); + ++subscriptionSummariesIndex) { + m_subscriptionSummaries.push_back(subscriptionSummariesJsonList[subscriptionSummariesIndex].AsObject()); + } + m_subscriptionSummariesHasBeenSet = true; + } + if (jsonValue.ValueExists("nextToken")) { + m_nextToken = jsonValue.GetString("nextToken"); + m_nextTokenHasBeenSet = true; + } + + const auto& headers = result.GetHeaderValueCollection(); + const auto& requestIdIter = headers.find("x-amzn-requestid"); + if (requestIdIter != headers.end()) { + m_requestId = requestIdIter->second; + m_requestIdHasBeenSet = true; + } + + return *this; +} diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/ResourceNotFoundException.cpp b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/ResourceNotFoundException.cpp new file mode 100644 index 000000000000..6498d9a13b67 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/ResourceNotFoundException.cpp @@ -0,0 +1,48 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include + +#include + +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +namespace Aws { +namespace PricingPlanManager { +namespace Model { + +ResourceNotFoundException::ResourceNotFoundException(JsonView jsonValue) { *this = jsonValue; } + +ResourceNotFoundException& ResourceNotFoundException::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("message")) { + m_message = jsonValue.GetString("message"); + m_messageHasBeenSet = true; + } + if (jsonValue.ValueExists("resourceId")) { + m_resourceId = jsonValue.GetString("resourceId"); + m_resourceIdHasBeenSet = true; + } + return *this; +} + +JsonValue ResourceNotFoundException::Jsonize() const { + JsonValue payload; + + if (m_messageHasBeenSet) { + payload.WithString("message", m_message); + } + + if (m_resourceIdHasBeenSet) { + payload.WithString("resourceId", m_resourceId); + } + + return payload; +} + +} // namespace Model +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/ScheduledChange.cpp b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/ScheduledChange.cpp new file mode 100644 index 000000000000..e4ec20d7564c --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/ScheduledChange.cpp @@ -0,0 +1,64 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include + +#include + +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +namespace Aws { +namespace PricingPlanManager { +namespace Model { + +ScheduledChange::ScheduledChange(JsonView jsonValue) { *this = jsonValue; } + +ScheduledChange& ScheduledChange::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("changeType")) { + m_changeType = ScheduledChangeTypeMapper::GetScheduledChangeTypeForName(jsonValue.GetString("changeType")); + m_changeTypeHasBeenSet = true; + } + if (jsonValue.ValueExists("effectiveDate")) { + m_effectiveDate = jsonValue.GetString("effectiveDate"); + m_effectiveDateHasBeenSet = true; + } + if (jsonValue.ValueExists("planTier")) { + m_planTier = jsonValue.GetString("planTier"); + m_planTierHasBeenSet = true; + } + if (jsonValue.ValueExists("usageLevel")) { + m_usageLevel = jsonValue.GetString("usageLevel"); + m_usageLevelHasBeenSet = true; + } + return *this; +} + +JsonValue ScheduledChange::Jsonize() const { + JsonValue payload; + + if (m_changeTypeHasBeenSet) { + payload.WithString("changeType", ScheduledChangeTypeMapper::GetNameForScheduledChangeType(m_changeType)); + } + + if (m_effectiveDateHasBeenSet) { + payload.WithString("effectiveDate", m_effectiveDate.ToGmtString(Aws::Utils::DateFormat::ISO_8601)); + } + + if (m_planTierHasBeenSet) { + payload.WithString("planTier", m_planTier); + } + + if (m_usageLevelHasBeenSet) { + payload.WithString("usageLevel", m_usageLevel); + } + + return payload; +} + +} // namespace Model +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/ScheduledChangeType.cpp b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/ScheduledChangeType.cpp new file mode 100644 index 000000000000..42afba301fe0 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/ScheduledChangeType.cpp @@ -0,0 +1,58 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include +#include +#include + +using namespace Aws::Utils; + +namespace Aws { +namespace PricingPlanManager { +namespace Model { +namespace ScheduledChangeTypeMapper { + +static const int DOWNGRADE_HASH = HashingUtils::HashString("DOWNGRADE"); +static const int CANCELLATION_HASH = HashingUtils::HashString("CANCELLATION"); + +ScheduledChangeType GetScheduledChangeTypeForName(const Aws::String& name) { + int hashCode = HashingUtils::HashString(name.c_str()); + if (hashCode == DOWNGRADE_HASH) { + return ScheduledChangeType::DOWNGRADE; + } else if (hashCode == CANCELLATION_HASH) { + return ScheduledChangeType::CANCELLATION; + } + EnumParseOverflowContainer* overflowContainer = Aws::GetEnumOverflowContainer(); + if (overflowContainer) { + overflowContainer->StoreOverflow(hashCode, name); + return static_cast(hashCode); + } + + return ScheduledChangeType::NOT_SET; +} + +Aws::String GetNameForScheduledChangeType(ScheduledChangeType enumValue) { + switch (enumValue) { + case ScheduledChangeType::NOT_SET: + return {}; + case ScheduledChangeType::DOWNGRADE: + return "DOWNGRADE"; + case ScheduledChangeType::CANCELLATION: + return "CANCELLATION"; + default: + EnumParseOverflowContainer* overflowContainer = Aws::GetEnumOverflowContainer(); + if (overflowContainer) { + return overflowContainer->RetrieveOverflow(static_cast(enumValue)); + } + + return {}; + } +} + +} // namespace ScheduledChangeTypeMapper +} // namespace Model +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/Status.cpp b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/Status.cpp new file mode 100644 index 000000000000..ca56fd330921 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/Status.cpp @@ -0,0 +1,68 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include +#include +#include + +using namespace Aws::Utils; + +namespace Aws { +namespace PricingPlanManager { +namespace Model { +namespace StatusMapper { + +static const int PENDING_APPROVAL_HASH = HashingUtils::HashString("PENDING_APPROVAL"); +static const int ACTIVE_HASH = HashingUtils::HashString("ACTIVE"); +static const int SYNC_IN_PROGRESS_HASH = HashingUtils::HashString("SYNC_IN_PROGRESS"); +static const int FAILED_HASH = HashingUtils::HashString("FAILED"); + +Status GetStatusForName(const Aws::String& name) { + int hashCode = HashingUtils::HashString(name.c_str()); + if (hashCode == PENDING_APPROVAL_HASH) { + return Status::PENDING_APPROVAL; + } else if (hashCode == ACTIVE_HASH) { + return Status::ACTIVE; + } else if (hashCode == SYNC_IN_PROGRESS_HASH) { + return Status::SYNC_IN_PROGRESS; + } else if (hashCode == FAILED_HASH) { + return Status::FAILED; + } + EnumParseOverflowContainer* overflowContainer = Aws::GetEnumOverflowContainer(); + if (overflowContainer) { + overflowContainer->StoreOverflow(hashCode, name); + return static_cast(hashCode); + } + + return Status::NOT_SET; +} + +Aws::String GetNameForStatus(Status enumValue) { + switch (enumValue) { + case Status::NOT_SET: + return {}; + case Status::PENDING_APPROVAL: + return "PENDING_APPROVAL"; + case Status::ACTIVE: + return "ACTIVE"; + case Status::SYNC_IN_PROGRESS: + return "SYNC_IN_PROGRESS"; + case Status::FAILED: + return "FAILED"; + default: + EnumParseOverflowContainer* overflowContainer = Aws::GetEnumOverflowContainer(); + if (overflowContainer) { + return overflowContainer->RetrieveOverflow(static_cast(enumValue)); + } + + return {}; + } +} + +} // namespace StatusMapper +} // namespace Model +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/Subscription.cpp b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/Subscription.cpp new file mode 100644 index 000000000000..38cf0a8b73dd --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/Subscription.cpp @@ -0,0 +1,119 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include + +#include + +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +namespace Aws { +namespace PricingPlanManager { +namespace Model { + +Subscription::Subscription(JsonView jsonValue) { *this = jsonValue; } + +Subscription& Subscription::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("arn")) { + m_arn = jsonValue.GetString("arn"); + m_arnHasBeenSet = true; + } + if (jsonValue.ValueExists("planFamily")) { + m_planFamily = jsonValue.GetString("planFamily"); + m_planFamilyHasBeenSet = true; + } + if (jsonValue.ValueExists("planTier")) { + m_planTier = jsonValue.GetString("planTier"); + m_planTierHasBeenSet = true; + } + if (jsonValue.ValueExists("usageLevel")) { + m_usageLevel = jsonValue.GetString("usageLevel"); + m_usageLevelHasBeenSet = true; + } + if (jsonValue.ValueExists("scheduledChange")) { + m_scheduledChange = jsonValue.GetObject("scheduledChange"); + m_scheduledChangeHasBeenSet = true; + } + if (jsonValue.ValueExists("status")) { + m_status = StatusMapper::GetStatusForName(jsonValue.GetString("status")); + m_statusHasBeenSet = true; + } + if (jsonValue.ValueExists("statusReason")) { + m_statusReason = jsonValue.GetString("statusReason"); + m_statusReasonHasBeenSet = true; + } + if (jsonValue.ValueExists("resourceArns")) { + Aws::Utils::Array resourceArnsJsonList = jsonValue.GetArray("resourceArns"); + for (unsigned resourceArnsIndex = 0; resourceArnsIndex < resourceArnsJsonList.GetLength(); ++resourceArnsIndex) { + m_resourceArns.push_back(resourceArnsJsonList[resourceArnsIndex].AsString()); + } + m_resourceArnsHasBeenSet = true; + } + if (jsonValue.ValueExists("createdAt")) { + m_createdAt = jsonValue.GetString("createdAt"); + m_createdAtHasBeenSet = true; + } + if (jsonValue.ValueExists("updatedAt")) { + m_updatedAt = jsonValue.GetString("updatedAt"); + m_updatedAtHasBeenSet = true; + } + return *this; +} + +JsonValue Subscription::Jsonize() const { + JsonValue payload; + + if (m_arnHasBeenSet) { + payload.WithString("arn", m_arn); + } + + if (m_planFamilyHasBeenSet) { + payload.WithString("planFamily", m_planFamily); + } + + if (m_planTierHasBeenSet) { + payload.WithString("planTier", m_planTier); + } + + if (m_usageLevelHasBeenSet) { + payload.WithString("usageLevel", m_usageLevel); + } + + if (m_scheduledChangeHasBeenSet) { + payload.WithObject("scheduledChange", m_scheduledChange.Jsonize()); + } + + if (m_statusHasBeenSet) { + payload.WithString("status", StatusMapper::GetNameForStatus(m_status)); + } + + if (m_statusReasonHasBeenSet) { + payload.WithString("statusReason", m_statusReason); + } + + if (m_resourceArnsHasBeenSet) { + Aws::Utils::Array resourceArnsJsonList(m_resourceArns.size()); + for (unsigned resourceArnsIndex = 0; resourceArnsIndex < resourceArnsJsonList.GetLength(); ++resourceArnsIndex) { + resourceArnsJsonList[resourceArnsIndex].AsString(m_resourceArns[resourceArnsIndex]); + } + payload.WithArray("resourceArns", std::move(resourceArnsJsonList)); + } + + if (m_createdAtHasBeenSet) { + payload.WithString("createdAt", m_createdAt.ToGmtString(Aws::Utils::DateFormat::ISO_8601)); + } + + if (m_updatedAtHasBeenSet) { + payload.WithString("updatedAt", m_updatedAt.ToGmtString(Aws::Utils::DateFormat::ISO_8601)); + } + + return payload; +} + +} // namespace Model +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/SubscriptionSummary.cpp b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/SubscriptionSummary.cpp new file mode 100644 index 000000000000..66d5c7ce9449 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/SubscriptionSummary.cpp @@ -0,0 +1,127 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include + +#include + +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +namespace Aws { +namespace PricingPlanManager { +namespace Model { + +SubscriptionSummary::SubscriptionSummary(JsonView jsonValue) { *this = jsonValue; } + +SubscriptionSummary& SubscriptionSummary::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("arn")) { + m_arn = jsonValue.GetString("arn"); + m_arnHasBeenSet = true; + } + if (jsonValue.ValueExists("planFamily")) { + m_planFamily = jsonValue.GetString("planFamily"); + m_planFamilyHasBeenSet = true; + } + if (jsonValue.ValueExists("planTier")) { + m_planTier = jsonValue.GetString("planTier"); + m_planTierHasBeenSet = true; + } + if (jsonValue.ValueExists("usageLevel")) { + m_usageLevel = jsonValue.GetString("usageLevel"); + m_usageLevelHasBeenSet = true; + } + if (jsonValue.ValueExists("scheduledChange")) { + m_scheduledChange = jsonValue.GetObject("scheduledChange"); + m_scheduledChangeHasBeenSet = true; + } + if (jsonValue.ValueExists("status")) { + m_status = StatusMapper::GetStatusForName(jsonValue.GetString("status")); + m_statusHasBeenSet = true; + } + if (jsonValue.ValueExists("statusReason")) { + m_statusReason = jsonValue.GetString("statusReason"); + m_statusReasonHasBeenSet = true; + } + if (jsonValue.ValueExists("resourceArns")) { + Aws::Utils::Array resourceArnsJsonList = jsonValue.GetArray("resourceArns"); + for (unsigned resourceArnsIndex = 0; resourceArnsIndex < resourceArnsJsonList.GetLength(); ++resourceArnsIndex) { + m_resourceArns.push_back(resourceArnsJsonList[resourceArnsIndex].AsString()); + } + m_resourceArnsHasBeenSet = true; + } + if (jsonValue.ValueExists("createdAt")) { + m_createdAt = jsonValue.GetString("createdAt"); + m_createdAtHasBeenSet = true; + } + if (jsonValue.ValueExists("updatedAt")) { + m_updatedAt = jsonValue.GetString("updatedAt"); + m_updatedAtHasBeenSet = true; + } + if (jsonValue.ValueExists("eTag")) { + m_eTag = jsonValue.GetString("eTag"); + m_eTagHasBeenSet = true; + } + return *this; +} + +JsonValue SubscriptionSummary::Jsonize() const { + JsonValue payload; + + if (m_arnHasBeenSet) { + payload.WithString("arn", m_arn); + } + + if (m_planFamilyHasBeenSet) { + payload.WithString("planFamily", m_planFamily); + } + + if (m_planTierHasBeenSet) { + payload.WithString("planTier", m_planTier); + } + + if (m_usageLevelHasBeenSet) { + payload.WithString("usageLevel", m_usageLevel); + } + + if (m_scheduledChangeHasBeenSet) { + payload.WithObject("scheduledChange", m_scheduledChange.Jsonize()); + } + + if (m_statusHasBeenSet) { + payload.WithString("status", StatusMapper::GetNameForStatus(m_status)); + } + + if (m_statusReasonHasBeenSet) { + payload.WithString("statusReason", m_statusReason); + } + + if (m_resourceArnsHasBeenSet) { + Aws::Utils::Array resourceArnsJsonList(m_resourceArns.size()); + for (unsigned resourceArnsIndex = 0; resourceArnsIndex < resourceArnsJsonList.GetLength(); ++resourceArnsIndex) { + resourceArnsJsonList[resourceArnsIndex].AsString(m_resourceArns[resourceArnsIndex]); + } + payload.WithArray("resourceArns", std::move(resourceArnsJsonList)); + } + + if (m_createdAtHasBeenSet) { + payload.WithString("createdAt", m_createdAt.ToGmtString(Aws::Utils::DateFormat::ISO_8601)); + } + + if (m_updatedAtHasBeenSet) { + payload.WithString("updatedAt", m_updatedAt.ToGmtString(Aws::Utils::DateFormat::ISO_8601)); + } + + if (m_eTagHasBeenSet) { + payload.WithString("eTag", m_eTag); + } + + return payload; +} + +} // namespace Model +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/UpdateSubscriptionRequest.cpp b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/UpdateSubscriptionRequest.cpp new file mode 100644 index 000000000000..dffdcbf3a504 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/UpdateSubscriptionRequest.cpp @@ -0,0 +1,48 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include +#include + +#include + +using namespace Aws::PricingPlanManager::Model; +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +Aws::String UpdateSubscriptionRequest::SerializePayload() const { + JsonValue payload; + + if (m_arnHasBeenSet) { + payload.WithString("arn", m_arn); + } + + if (m_planTierHasBeenSet) { + payload.WithString("planTier", m_planTier); + } + + if (m_usageLevelHasBeenSet) { + payload.WithString("usageLevel", m_usageLevel); + } + + if (m_clientTokenHasBeenSet) { + payload.WithString("clientToken", m_clientToken); + } + + return payload.View().WriteReadable(); +} + +Aws::Http::HeaderValueCollection UpdateSubscriptionRequest::GetRequestSpecificHeaders() const { + Aws::Http::HeaderValueCollection headers; + Aws::StringStream ss; + if (m_ifMatchHasBeenSet) { + ss << m_ifMatch; + headers.emplace("if-match", ss.str()); + ss.str(""); + } + + return headers; +} diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/UpdateSubscriptionResult.cpp b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/UpdateSubscriptionResult.cpp new file mode 100644 index 000000000000..8745857352e0 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/UpdateSubscriptionResult.cpp @@ -0,0 +1,42 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include +#include +#include +#include +#include + +#include + +using namespace Aws::PricingPlanManager::Model; +using namespace Aws::Utils::Json; +using namespace Aws::Utils; +using namespace Aws; + +UpdateSubscriptionResult::UpdateSubscriptionResult(const Aws::AmazonWebServiceResult& result) { *this = result; } + +UpdateSubscriptionResult& UpdateSubscriptionResult::operator=(const Aws::AmazonWebServiceResult& result) { + m_HttpResponseCode = result.GetResponseCode(); + JsonView jsonValue = result.GetPayload().View(); + m_subscription = jsonValue; + m_subscriptionHasBeenSet = true; + + const auto& headers = result.GetHeaderValueCollection(); + const auto& eTagIter = headers.find("etag"); + if (eTagIter != headers.end()) { + m_eTag = eTagIter->second; + m_eTagHasBeenSet = true; + } + + const auto& requestIdIter = headers.find("x-amzn-requestid"); + if (requestIdIter != headers.end()) { + m_requestId = requestIdIter->second; + m_requestIdHasBeenSet = true; + } + + return *this; +} diff --git a/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/ValidationException.cpp b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/ValidationException.cpp new file mode 100644 index 000000000000..1e2ef666e7f7 --- /dev/null +++ b/generated/src/aws-cpp-sdk-pricing-plan-manager/source/model/ValidationException.cpp @@ -0,0 +1,48 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include + +#include + +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +namespace Aws { +namespace PricingPlanManager { +namespace Model { + +ValidationException::ValidationException(JsonView jsonValue) { *this = jsonValue; } + +ValidationException& ValidationException::operator=(JsonView jsonValue) { + if (jsonValue.ValueExists("message")) { + m_message = jsonValue.GetString("message"); + m_messageHasBeenSet = true; + } + if (jsonValue.ValueExists("resourceId")) { + m_resourceId = jsonValue.GetString("resourceId"); + m_resourceIdHasBeenSet = true; + } + return *this; +} + +JsonValue ValidationException::Jsonize() const { + JsonValue payload; + + if (m_messageHasBeenSet) { + payload.WithString("message", m_message); + } + + if (m_resourceIdHasBeenSet) { + payload.WithString("resourceId", m_resourceId); + } + + return payload; +} + +} // namespace Model +} // namespace PricingPlanManager +} // namespace Aws diff --git a/generated/src/aws-cpp-sdk-sagemaker/include/aws/sagemaker/model/AIRecommendationAdapterDetails.h b/generated/src/aws-cpp-sdk-sagemaker/include/aws/sagemaker/model/AIRecommendationAdapterDetails.h index 27aaf77d39af..a9b3e882f12d 100644 --- a/generated/src/aws-cpp-sdk-sagemaker/include/aws/sagemaker/model/AIRecommendationAdapterDetails.h +++ b/generated/src/aws-cpp-sdk-sagemaker/include/aws/sagemaker/model/AIRecommendationAdapterDetails.h @@ -24,9 +24,9 @@ namespace Model { /** *

The per-recommendation LoRA adapter details. Contains both the model package * ARNs and Amazon S3 URIs for each adapter, regardless of which form was - * originally supplied in the request. When the customer supplies only Amazon S3 - * URIs, Amazon SageMaker AI creates model packages on their behalf.

See - * Also:

See Also:

+ * AWS * API Reference

*/ diff --git a/generated/src/aws-cpp-sdk-sagemaker/include/aws/sagemaker/model/AIRecommendationDeploymentConfiguration.h b/generated/src/aws-cpp-sdk-sagemaker/include/aws/sagemaker/model/AIRecommendationDeploymentConfiguration.h index 3fee0deaad74..b97cea2f9cc1 100644 --- a/generated/src/aws-cpp-sdk-sagemaker/include/aws/sagemaker/model/AIRecommendationDeploymentConfiguration.h +++ b/generated/src/aws-cpp-sdk-sagemaker/include/aws/sagemaker/model/AIRecommendationDeploymentConfiguration.h @@ -152,12 +152,10 @@ class AIRecommendationDeploymentConfiguration { ///@{ /** - *

The minimum host (CPU) memory, in MiB, to reserve per model copy when + *

The minimum host (CPU) memory, in MiB, to reserve for each model copy when * deploying the recommendation as an Inference Component. This value maps to the - * base Inference Component's - * ComputeResourceRequirements$MinMemoryRequiredInMb and is sized so - * that CopyCountPerInstance copies co-place within the instance's - * allocatable host memory.

+ * Inference Component's + * ComputeResourceRequirements$MinMemoryRequiredInMb field.

*/ inline int GetMinCpuMemoryRequiredInMb() const { return m_minCpuMemoryRequiredInMb; } inline bool MinCpuMemoryRequiredInMbHasBeenSet() const { return m_minCpuMemoryRequiredInMbHasBeenSet; } diff --git a/generated/src/aws-cpp-sdk-sagemaker/include/aws/sagemaker/model/AppInstanceType.h b/generated/src/aws-cpp-sdk-sagemaker/include/aws/sagemaker/model/AppInstanceType.h index 166a957555df..6c98fd0e8eca 100644 --- a/generated/src/aws-cpp-sdk-sagemaker/include/aws/sagemaker/model/AppInstanceType.h +++ b/generated/src/aws-cpp-sdk-sagemaker/include/aws/sagemaker/model/AppInstanceType.h @@ -176,6 +176,12 @@ enum class AppInstanceType { ml_r6id_24xlarge, ml_r6id_32xlarge, ml_p5_4xlarge, + ml_g7_2xlarge, + ml_g7_4xlarge, + ml_g7_8xlarge, + ml_g7_12xlarge, + ml_g7_24xlarge, + ml_g7_48xlarge, ml_g7e_2xlarge, ml_g7e_4xlarge, ml_g7e_8xlarge, diff --git a/generated/src/aws-cpp-sdk-sagemaker/include/aws/sagemaker/model/CreateOptimizationJobRequest.h b/generated/src/aws-cpp-sdk-sagemaker/include/aws/sagemaker/model/CreateOptimizationJobRequest.h index 52c8f7280f33..c6fef7fd9978 100644 --- a/generated/src/aws-cpp-sdk-sagemaker/include/aws/sagemaker/model/CreateOptimizationJobRequest.h +++ b/generated/src/aws-cpp-sdk-sagemaker/include/aws/sagemaker/model/CreateOptimizationJobRequest.h @@ -270,10 +270,10 @@ class CreateOptimizationJobRequest : public SageMakerRequest { *

The Amazon Resource Name (ARN) of the training plan to use for this * optimization job.

When you use reserved capacity from a training plan, * the optimization job runs on that reserved capacity instead of on-demand - * capacity. If you omit this field, the job uses on-demand capacity. Currently, - * you can specify at most one training plan.

For more information about how - * to reserve GPU capacity for your optimization jobs using Amazon SageMaker - * Training Plans, see

For more information about how to + * reserve GPU capacity for your optimization jobs using Amazon SageMaker Training + * Plans, see Reserve * capacity with training plans.

*/ diff --git a/generated/src/aws-cpp-sdk-sagemaker/include/aws/sagemaker/model/DescribeAIRecommendationJobResult.h b/generated/src/aws-cpp-sdk-sagemaker/include/aws/sagemaker/model/DescribeAIRecommendationJobResult.h index 17edc5d993a6..a3e23f2496f5 100644 --- a/generated/src/aws-cpp-sdk-sagemaker/include/aws/sagemaker/model/DescribeAIRecommendationJobResult.h +++ b/generated/src/aws-cpp-sdk-sagemaker/include/aws/sagemaker/model/DescribeAIRecommendationJobResult.h @@ -267,8 +267,8 @@ class DescribeAIRecommendationJobResult { ///@{ /** - *

The LoRA adapter source that was specified when the recommendation job was - * created. This field is absent when the job was created without LoRA + *

The LoRA adapter source that you specified when you created the + * recommendation job. This field is absent when you created the job without LoRA * adapters.

*/ inline const AIAdapterSource& GetAdapterSource() const { return m_adapterSource; } diff --git a/generated/src/aws-cpp-sdk-sagemaker/source/model/AppInstanceType.cpp b/generated/src/aws-cpp-sdk-sagemaker/source/model/AppInstanceType.cpp index b48a854032b4..5aa46535d77b 100644 --- a/generated/src/aws-cpp-sdk-sagemaker/source/model/AppInstanceType.cpp +++ b/generated/src/aws-cpp-sdk-sagemaker/source/model/AppInstanceType.cpp @@ -179,6 +179,12 @@ static const int ml_r6id_16xlarge_HASH = HashingUtils::HashString("ml.r6id.16xla static const int ml_r6id_24xlarge_HASH = HashingUtils::HashString("ml.r6id.24xlarge"); static const int ml_r6id_32xlarge_HASH = HashingUtils::HashString("ml.r6id.32xlarge"); static const int ml_p5_4xlarge_HASH = HashingUtils::HashString("ml.p5.4xlarge"); +static const int ml_g7_2xlarge_HASH = HashingUtils::HashString("ml.g7.2xlarge"); +static const int ml_g7_4xlarge_HASH = HashingUtils::HashString("ml.g7.4xlarge"); +static const int ml_g7_8xlarge_HASH = HashingUtils::HashString("ml.g7.8xlarge"); +static const int ml_g7_12xlarge_HASH = HashingUtils::HashString("ml.g7.12xlarge"); +static const int ml_g7_24xlarge_HASH = HashingUtils::HashString("ml.g7.24xlarge"); +static const int ml_g7_48xlarge_HASH = HashingUtils::HashString("ml.g7.48xlarge"); static const int ml_g7e_2xlarge_HASH = HashingUtils::HashString("ml.g7e.2xlarge"); static const int ml_g7e_4xlarge_HASH = HashingUtils::HashString("ml.g7e.4xlarge"); static const int ml_g7e_8xlarge_HASH = HashingUtils::HashString("ml.g7e.8xlarge"); @@ -688,6 +694,24 @@ static bool GetEnumForNameHelper1(int hashCode, AppInstanceType& enumValue) { } else if (hashCode == ml_p5_4xlarge_HASH) { enumValue = AppInstanceType::ml_p5_4xlarge; return true; + } else if (hashCode == ml_g7_2xlarge_HASH) { + enumValue = AppInstanceType::ml_g7_2xlarge; + return true; + } else if (hashCode == ml_g7_4xlarge_HASH) { + enumValue = AppInstanceType::ml_g7_4xlarge; + return true; + } else if (hashCode == ml_g7_8xlarge_HASH) { + enumValue = AppInstanceType::ml_g7_8xlarge; + return true; + } else if (hashCode == ml_g7_12xlarge_HASH) { + enumValue = AppInstanceType::ml_g7_12xlarge; + return true; + } else if (hashCode == ml_g7_24xlarge_HASH) { + enumValue = AppInstanceType::ml_g7_24xlarge; + return true; + } else if (hashCode == ml_g7_48xlarge_HASH) { + enumValue = AppInstanceType::ml_g7_48xlarge; + return true; } else if (hashCode == ml_g7e_2xlarge_HASH) { enumValue = AppInstanceType::ml_g7e_2xlarge; return true; @@ -1210,6 +1234,24 @@ static bool GetNameForEnumHelper1(AppInstanceType enumValue, Aws::String& value) case AppInstanceType::ml_p5_4xlarge: value = "ml.p5.4xlarge"; return true; + case AppInstanceType::ml_g7_2xlarge: + value = "ml.g7.2xlarge"; + return true; + case AppInstanceType::ml_g7_4xlarge: + value = "ml.g7.4xlarge"; + return true; + case AppInstanceType::ml_g7_8xlarge: + value = "ml.g7.8xlarge"; + return true; + case AppInstanceType::ml_g7_12xlarge: + value = "ml.g7.12xlarge"; + return true; + case AppInstanceType::ml_g7_24xlarge: + value = "ml.g7.24xlarge"; + return true; + case AppInstanceType::ml_g7_48xlarge: + value = "ml.g7.48xlarge"; + return true; case AppInstanceType::ml_g7e_2xlarge: value = "ml.g7e.2xlarge"; return true; diff --git a/generated/src/aws-cpp-sdk-securityagent/include/aws/securityagent/model/IntegratedRepository.h b/generated/src/aws-cpp-sdk-securityagent/include/aws/securityagent/model/IntegratedRepository.h index e3c1a690d085..004edc1350d4 100644 --- a/generated/src/aws-cpp-sdk-securityagent/include/aws/securityagent/model/IntegratedRepository.h +++ b/generated/src/aws-cpp-sdk-securityagent/include/aws/securityagent/model/IntegratedRepository.h @@ -68,12 +68,33 @@ class IntegratedRepository { return *this; } ///@} + + ///@{ + /** + *

An optional override for the repository branch.

+ */ + inline const Aws::String& GetBranch() const { return m_branch; } + inline bool BranchHasBeenSet() const { return m_branchHasBeenSet; } + template + void SetBranch(BranchT&& value) { + m_branchHasBeenSet = true; + m_branch = std::forward(value); + } + template + IntegratedRepository& WithBranch(BranchT&& value) { + SetBranch(std::forward(value)); + return *this; + } + ///@} private: Aws::String m_integrationId; Aws::String m_providerResourceId; + + Aws::String m_branch; bool m_integrationIdHasBeenSet = false; bool m_providerResourceIdHasBeenSet = false; + bool m_branchHasBeenSet = false; }; } // namespace Model diff --git a/generated/src/aws-cpp-sdk-securityagent/source/model/IntegratedRepository.cpp b/generated/src/aws-cpp-sdk-securityagent/source/model/IntegratedRepository.cpp index 2ad6468a05bb..fc9a4a611ec2 100644 --- a/generated/src/aws-cpp-sdk-securityagent/source/model/IntegratedRepository.cpp +++ b/generated/src/aws-cpp-sdk-securityagent/source/model/IntegratedRepository.cpp @@ -26,6 +26,10 @@ IntegratedRepository& IntegratedRepository::operator=(JsonView jsonValue) { m_providerResourceId = jsonValue.GetString("providerResourceId"); m_providerResourceIdHasBeenSet = true; } + if (jsonValue.ValueExists("branch")) { + m_branch = jsonValue.GetString("branch"); + m_branchHasBeenSet = true; + } return *this; } @@ -40,6 +44,10 @@ JsonValue IntegratedRepository::Jsonize() const { payload.WithString("providerResourceId", m_providerResourceId); } + if (m_branchHasBeenSet) { + payload.WithString("branch", m_branch); + } + return payload; } diff --git a/generated/tests/bedrock-agentcore-control-gen-tests/BedrockAgentCoreControlIncludeTests.cpp b/generated/tests/bedrock-agentcore-control-gen-tests/BedrockAgentCoreControlIncludeTests.cpp index 55af0c045913..345f2d83e6fc 100644 --- a/generated/tests/bedrock-agentcore-control-gen-tests/BedrockAgentCoreControlIncludeTests.cpp +++ b/generated/tests/bedrock-agentcore-control-gen-tests/BedrockAgentCoreControlIncludeTests.cpp @@ -545,6 +545,7 @@ #include #include #include +#include #include #include #include @@ -584,6 +585,7 @@ #include #include #include +#include #include #include #include diff --git a/generated/tests/iam-gen-tests/IAMIncludeTests.cpp b/generated/tests/iam-gen-tests/IAMIncludeTests.cpp index e93966d71524..4e13c06e2e79 100644 --- a/generated/tests/iam-gen-tests/IAMIncludeTests.cpp +++ b/generated/tests/iam-gen-tests/IAMIncludeTests.cpp @@ -31,6 +31,7 @@ #include #include #include +#include #include #include #include @@ -181,6 +182,7 @@ #include #include #include +#include #include #include #include @@ -260,6 +262,7 @@ #include #include #include +#include #include #include #include @@ -271,6 +274,8 @@ #include #include #include +#include +#include #include #include #include diff --git a/generated/tests/kafka-gen-tests/KafkaIncludeTests.cpp b/generated/tests/kafka-gen-tests/KafkaIncludeTests.cpp index c6d9c9388df3..01a85bb844c3 100644 --- a/generated/tests/kafka-gen-tests/KafkaIncludeTests.cpp +++ b/generated/tests/kafka-gen-tests/KafkaIncludeTests.cpp @@ -28,6 +28,12 @@ #include #include #include +#include +#include +#include +#include +#include +#include #include #include #include @@ -56,6 +62,8 @@ #include #include #include +#include +#include #include #include #include @@ -69,6 +77,9 @@ #include #include #include +#include +#include +#include #include #include #include @@ -81,6 +92,8 @@ #include #include #include +#include +#include #include #include #include @@ -101,8 +114,10 @@ #include #include #include +#include #include #include +#include #include #include #include @@ -117,6 +132,9 @@ #include #include #include +#include +#include +#include #include #include #include @@ -134,6 +152,8 @@ #include #include #include +#include +#include #include #include #include @@ -174,6 +194,9 @@ #include #include #include +#include +#include +#include #include #include #include @@ -187,6 +210,8 @@ #include #include #include +#include +#include #include #include #include @@ -204,7 +229,13 @@ #include #include #include +#include +#include +#include +#include +#include #include +#include #include #include #include @@ -215,10 +246,12 @@ #include #include #include +#include #include #include #include #include +#include #include #include #include @@ -236,6 +269,8 @@ #include #include #include +#include +#include #include #include #include @@ -258,6 +293,7 @@ #include #include #include +#include #include #include #include diff --git a/generated/tests/pricing-plan-manager-gen-tests/CMakeLists.txt b/generated/tests/pricing-plan-manager-gen-tests/CMakeLists.txt new file mode 100644 index 000000000000..9b2598db30a7 --- /dev/null +++ b/generated/tests/pricing-plan-manager-gen-tests/CMakeLists.txt @@ -0,0 +1,42 @@ +add_project(pricing-plan-manager-gen-tests + "Tests for the AWS PRICING-PLAN-MANAGER C++ SDK" + testing-resources + aws-cpp-sdk-pricing-plan-manager + aws-cpp-sdk-core) + +file(GLOB AWS_PRICING-PLAN-MANAGER_GENERATED_TEST_SRC + "${CMAKE_CURRENT_SOURCE_DIR}/*.cpp" +) + +if(MSVC AND BUILD_SHARED_LIBS) + add_definitions(-DGTEST_LINKED_AS_SHARED_LIBRARY=1) +endif() + +if (CMAKE_CROSSCOMPILING) + set(AUTORUN_UNIT_TESTS OFF) +endif() + +if (AUTORUN_UNIT_TESTS) + enable_testing() +endif() + +if(PLATFORM_ANDROID AND BUILD_SHARED_LIBS) + add_library(${PROJECT_NAME} "${AWS_PRICING-PLAN-MANAGER_GENERATED_TEST_SRC}") +else() + add_executable(${PROJECT_NAME} "${AWS_PRICING-PLAN-MANAGER_GENERATED_TEST_SRC}") +endif() + +set_compiler_flags(${PROJECT_NAME}) +set_compiler_warnings(${PROJECT_NAME}) + +target_link_libraries(${PROJECT_NAME} ${PROJECT_LIBS}) + +if (AUTORUN_UNIT_TESTS) + ADD_CUSTOM_COMMAND( TARGET ${PROJECT_NAME} POST_BUILD + COMMAND ${CMAKE_COMMAND} -E env LD_LIBRARY_PATH=${AWS_AUTORUN_LD_LIBRARY_PATH}:$ENV{LD_LIBRARY_PATH} $ + ARGS "--gtest_brief=1") +endif() + +if(NOT CMAKE_CROSSCOMPILING) + SET_TARGET_PROPERTIES(${PROJECT_NAME} PROPERTIES OUTPUT_NAME ${PROJECT_NAME}) +endif() \ No newline at end of file diff --git a/generated/tests/pricing-plan-manager-gen-tests/PricingPlanManagerEndpointProviderTests.cpp b/generated/tests/pricing-plan-manager-gen-tests/PricingPlanManagerEndpointProviderTests.cpp new file mode 100644 index 000000000000..a1ee68b0538f --- /dev/null +++ b/generated/tests/pricing-plan-manager-gen-tests/PricingPlanManagerEndpointProviderTests.cpp @@ -0,0 +1,251 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include + +#include + + +static const char* ALLOCATION_TAG = "AWSPricingPlanManagerEndpointProviderTests"; +using PricingPlanManagerEndpointProvider = Aws::PricingPlanManager::Endpoint::PricingPlanManagerEndpointProvider; +using EndpointParameters = Aws::Vector; +using ResolveEndpointOutcome = Aws::Endpoint::ResolveEndpointOutcome; + +using EpParam = Aws::Endpoint::EndpointParameter; +using EpProp = Aws::Endpoint::EndpointParameter; // just a container to store test expectations +using ExpEpProps = Aws::UnorderedMap>>; +using ExpEpAuthScheme = Aws::Vector; +using ExpEpHeaders = Aws::UnorderedMap>; + +struct PricingPlanManagerEndpointProviderEndpointTestCase +{ + using OperationParamsFromTest = EndpointParameters; + + struct Expect + { + struct Endpoint + { + Aws::String url; + ExpEpAuthScheme authScheme; + ExpEpProps properties; + ExpEpHeaders headers; + } endpoint; + Aws::String error; + }; + struct OperationInput + { + Aws::String operationName; + OperationParamsFromTest operationParams; + OperationParamsFromTest builtinParams; + OperationParamsFromTest clientParams; + }; + + Aws::String documentation; + // Specification tells us it is Client Initialization parameters + // At the same time, specification tells us to test EndpointProvider not the client itself + // Hence params here will be set as a client params (just like a dedicated field above). + Aws::Vector params; + Aws::Vector tags; + Expect expect; + // Aws::Vector operationInput; +}; + +class PricingPlanManagerEndpointProviderTests : public ::testing::TestWithParam +{ +public: + static const size_t TEST_CASES_SZ; +protected: + static Aws::Vector getTestCase(); + static Aws::UniquePtrSafeDeleted> TEST_CASES; + static void SetUpTestSuite() + { + TEST_CASES = Aws::MakeUniqueSafeDeleted>(ALLOCATION_TAG, getTestCase()); + ASSERT_TRUE(TEST_CASES) << "Failed to allocate TEST_CASES table"; + assert(TEST_CASES->size() == TEST_CASES_SZ); + } + + static void TearDownTestSuite() + { + TEST_CASES.reset(); + } +}; + +Aws::UniquePtrSafeDeleted> PricingPlanManagerEndpointProviderTests::TEST_CASES; +const size_t PricingPlanManagerEndpointProviderTests::TEST_CASES_SZ = 3; + +Aws::Vector PricingPlanManagerEndpointProviderTests::getTestCase() { + + Aws::Vector test_cases = { + /*TEST CASE 0*/ + {"Resolves the us-east-1 endpoint and signs for us-east-1.", // documentation + {EpParam("Region", "us-east-1")}, // params + {}, // tags + {{/*epUrl*/"https://pricingplanmanager.us-east-1.api.aws", + {/*authScheme*/}, + {/*properties*/}, + {/*headers*/}}, {/*No error*/}} // expect + }, + /*TEST CASE 1*/ + {"Routes any other region to the us-east-1 endpoint and still signs for us-east-1.", // documentation + {EpParam("Region", "us-west-2")}, // params + {}, // tags + {{/*epUrl*/"https://pricingplanmanager.us-east-1.api.aws", + {/*authScheme*/}, + {/*properties*/}, + {/*headers*/}}, {/*No error*/}} // expect + }, + /*TEST CASE 2*/ + {"A custom endpoint override wins over region resolution and signs for us-east-1.", // documentation + {EpParam("Endpoint", "https://pricingplanmanager.us-east-1.api.aws"), EpParam("Region", "us-west-2")}, // params + {}, // tags + {{/*epUrl*/"https://pricingplanmanager.us-east-1.api.aws", + {/*authScheme*/}, + {/*properties*/}, + {/*headers*/}}, {/*No error*/}} // expect + } + }; + return test_cases; +} + +Aws::String RulesToSdkSignerName(const Aws::String& rulesSignerName) +{ + Aws::String sdkSigner = "NullSigner"; + if (rulesSignerName == "sigv4") { + sdkSigner = "SignatureV4"; + } else if (rulesSignerName == "sigv4a") { + sdkSigner = "AsymmetricSignatureV4"; + } else if (rulesSignerName == "none") { + sdkSigner = "NullSigner"; + } else if (rulesSignerName == "bearer") { + sdkSigner = "Bearer"; + } else if (rulesSignerName == "s3Express") { + sdkSigner = "S3ExpressSigner"; + } else { + sdkSigner = rulesSignerName; + } + + return sdkSigner; +} + +void ValidateOutcome(const ResolveEndpointOutcome& outcome, const PricingPlanManagerEndpointProviderEndpointTestCase::Expect& expect) +{ + if(!expect.error.empty()) + { + ASSERT_FALSE(outcome.IsSuccess()) << "Expected failure with message:\n" << expect.error; + ASSERT_EQ(outcome.GetError().GetMessage(), expect.error); + } + else + { + AWS_ASSERT_SUCCESS(outcome); + ASSERT_EQ(outcome.GetResult().GetURL(), expect.endpoint.url); + const auto expAuthSchemesIt = expect.endpoint.properties.find("authSchemes"); + if (expAuthSchemesIt != expect.endpoint.properties.end()) + { + // in the list of AuthSchemes, select the one with a highest priority + const Aws::Vector priotityList = {"s3Express", "sigv4a", "sigv4", "bearer", "none", ""}; + const auto expectedAuthSchemePropsIt = std::find_first_of(expAuthSchemesIt->second.begin(), expAuthSchemesIt->second.end(), + priotityList.begin(), priotityList.end(), [](const Aws::Vector& props, const Aws::String& expName) + { + const auto& propNameIt = std::find_if(props.begin(), props.end(), [](const EpProp& prop) + { + return prop.GetName() == "name"; + }); + assert(propNameIt != props.end()); + return propNameIt->GetStrValueNoCheck() == expName; + }); + assert(expectedAuthSchemePropsIt != expAuthSchemesIt->second.end()); + + const auto& endpointResultAttrs = outcome.GetResult().GetAttributes(); + ASSERT_TRUE(endpointResultAttrs) << "Expected non-empty EndpointAttributes (authSchemes)"; + for (const auto& expProperty : *expectedAuthSchemePropsIt) + { + if (expProperty.GetName() == "name") { + ASSERT_TRUE(!endpointResultAttrs->authScheme.GetName().empty()); + ASSERT_EQ(RulesToSdkSignerName(expProperty.GetStrValueNoCheck()), endpointResultAttrs->authScheme.GetName()); + } else if (expProperty.GetName() == "signingName") { + ASSERT_TRUE(endpointResultAttrs->authScheme.GetSigningName()); + ASSERT_EQ(expProperty.GetStrValueNoCheck(), endpointResultAttrs->authScheme.GetSigningName().value()); + } else if (expProperty.GetName() == "signingRegion") { + ASSERT_TRUE(endpointResultAttrs->authScheme.GetSigningRegion()); + ASSERT_EQ(expProperty.GetStrValueNoCheck(), endpointResultAttrs->authScheme.GetSigningRegion().value()); + } else if (expProperty.GetName() == "signingRegionSet") { + ASSERT_TRUE(endpointResultAttrs->authScheme.GetSigningRegionSet()); + ASSERT_EQ(expProperty.GetStrValueNoCheck(), endpointResultAttrs->authScheme.GetSigningRegionSet().value()); + } else if (expProperty.GetName() == "disableDoubleEncoding") { + ASSERT_TRUE(endpointResultAttrs->authScheme.GetDisableDoubleEncoding()); + ASSERT_EQ(expProperty.GetBoolValueNoCheck(), endpointResultAttrs->authScheme.GetDisableDoubleEncoding().value()); + } else { + FAIL() << "Unsupported Auth type property " << expProperty.GetName() << ". Need to update test."; + } + } + } + + EXPECT_EQ(expect.endpoint.headers.empty(), outcome.GetResult().GetHeaders().empty()); + for(const auto& expHeaderVec : expect.endpoint.headers) + { + const auto& retHeaderIt = outcome.GetResult().GetHeaders().find(expHeaderVec.first); + ASSERT_TRUE(retHeaderIt != outcome.GetResult().GetHeaders().end()); + + auto retHeaderVec = Aws::Utils::StringUtils::Split(retHeaderIt->second, ';'); + std::sort(retHeaderVec.begin(), retHeaderVec.end()); + + auto expHeaderVecSorted = expHeaderVec.second; + std::sort(expHeaderVecSorted.begin(), expHeaderVecSorted.end()); + + ASSERT_EQ(expHeaderVecSorted, retHeaderVec); + } + } +} + +TEST_P(PricingPlanManagerEndpointProviderTests, EndpointProviderTest) +{ + const size_t TEST_CASE_IDX = GetParam(); + ASSERT_LT(TEST_CASE_IDX, TEST_CASES->size()) << "Something is wrong with the test fixture itself."; + const PricingPlanManagerEndpointProviderEndpointTestCase& TEST_CASE = TEST_CASES->at(TEST_CASE_IDX); + SCOPED_TRACE(Aws::String("\nTEST CASE # ") + Aws::Utils::StringUtils::to_string(TEST_CASE_IDX) + ": " + TEST_CASE.documentation); + SCOPED_TRACE(Aws::String("\n--gtest_filter=EndpointTestsFromModel/PricingPlanManagerEndpointProviderTests.EndpointProviderTest/") + Aws::Utils::StringUtils::to_string(TEST_CASE_IDX)); + + std::shared_ptr endpointProvider = Aws::MakeShared(ALLOCATION_TAG); + ASSERT_TRUE(endpointProvider) << "Failed to allocate/initialize PricingPlanManagerEndpointProvider"; + + EndpointParameters endpointParameters; + for(const auto& param : TEST_CASE.params) + { + endpointParameters.emplace(endpointParameters.end(), Aws::Endpoint::EndpointParameter(param)); + } + auto resolvedEndpointOutcome = endpointProvider->ResolveEndpoint(endpointParameters); + ValidateOutcome(resolvedEndpointOutcome, TEST_CASE.expect); + +#if 0 // temporarily disabled + for(const auto& operation : TEST_CASE.operationInput) + { + /* + * Most specific to least specific value locations: + staticContextParams + contextParam + clientContextParams + Built-In Bindings + Built-in binding default values + */ + const Aws::Vector> + operationInputParams = {std::cref(operation.builtinParams), std::cref(operation.clientParams), std::cref(operation.operationParams)}; + + for(const auto& paramSource : operationInputParams) + { + for(const auto& param : paramSource.get()) + { + endpointParameters.emplace(endpointParameters.end(), Aws::Endpoint::EndpointParameter(param)); + } + } + auto resolvedEndpointOutcomePerOperation = endpointProvider->ResolveEndpoint(endpointParameters); + ValidateOutcome(resolvedEndpointOutcomePerOperation, TEST_CASE.expect); + } +#endif +} + +INSTANTIATE_TEST_SUITE_P(EndpointTestsFromModel, + PricingPlanManagerEndpointProviderTests, + ::testing::Range((size_t) 0u, PricingPlanManagerEndpointProviderTests::TEST_CASES_SZ)); diff --git a/generated/tests/pricing-plan-manager-gen-tests/PricingPlanManagerIncludeTests.cpp b/generated/tests/pricing-plan-manager-gen-tests/PricingPlanManagerIncludeTests.cpp new file mode 100644 index 000000000000..496054398fbc --- /dev/null +++ b/generated/tests/pricing-plan-manager-gen-tests/PricingPlanManagerIncludeTests.cpp @@ -0,0 +1,55 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +using PricingPlanManagerIncludeTest = ::testing::Test; + +TEST_F(PricingPlanManagerIncludeTest, TestClientCompiles) +{ + Aws::Client::ClientConfigurationInitValues cfgInit; + cfgInit.shouldDisableIMDS = true; + Aws::Client::ClientConfiguration config(cfgInit); + AWS_UNREFERENCED_PARAM(config); + // auto pClient = Aws::MakeUnique("PricingPlanManagerIncludeTest", config); + // ASSERT_TRUE(pClient.get()); +} diff --git a/generated/tests/pricing-plan-manager-gen-tests/PricingPlanManagerPaginationCompilationTests.cpp b/generated/tests/pricing-plan-manager-gen-tests/PricingPlanManagerPaginationCompilationTests.cpp new file mode 100644 index 000000000000..26324a1fdf56 --- /dev/null +++ b/generated/tests/pricing-plan-manager-gen-tests/PricingPlanManagerPaginationCompilationTests.cpp @@ -0,0 +1,23 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +// Header compilation test for PricingPlanManager pagination headers +// This test ensures all generated pagination headers compile successfully + +#include +#include +#include + +#include + +class PricingPlanManagerPaginationCompilationTest : public Aws::Testing::AwsCppSdkGTestSuite +{ +}; + +TEST_F(PricingPlanManagerPaginationCompilationTest, PricingPlanManagerPaginationHeadersCompile) +{ + // Test passes if compilation succeeds + SUCCEED(); +} diff --git a/generated/tests/pricing-plan-manager-gen-tests/RunTests.cpp b/generated/tests/pricing-plan-manager-gen-tests/RunTests.cpp new file mode 100644 index 000000000000..f2f10a7c7892 --- /dev/null +++ b/generated/tests/pricing-plan-manager-gen-tests/RunTests.cpp @@ -0,0 +1,29 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#include +#include +#include +#include +#include + +int main(int argc, char** argv) +{ + Aws::SDKOptions options; + options.loggingOptions.logLevel = Aws::Utils::Logging::LogLevel::Trace; + + AWS_BEGIN_MEMORY_TEST_EX(options, 1024, 128); + Aws::Testing::InitPlatformTest(options); + Aws::Testing::ParseArgs(argc, argv); + + Aws::InitAPI(options); + ::testing::InitGoogleTest(&argc, argv); + int exitCode = RUN_ALL_TESTS(); + Aws::ShutdownAPI(options); + + AWS_END_MEMORY_TEST_EX; + Aws::Testing::ShutdownPlatformTest(options); + return exitCode; +} diff --git a/tools/code-generation/api-descriptions/bcm-pricing-calculator-2024-06-19.normal.json b/tools/code-generation/api-descriptions/bcm-pricing-calculator-2024-06-19.normal.json index 9f7cb42e363b..bd4d9a52827f 100644 --- a/tools/code-generation/api-descriptions/bcm-pricing-calculator-2024-06-19.normal.json +++ b/tools/code-generation/api-descriptions/bcm-pricing-calculator-2024-06-19.normal.json @@ -5,11 +5,8 @@ "auth":["aws.auth#sigv4"], "endpointPrefix":"bcm-pricing-calculator", "jsonVersion":"1.0", - "protocol":"smithy-rpc-v2-cbor", - "protocols":[ - "smithy-rpc-v2-cbor", - "json" - ], + "protocol":"json", + "protocols":["json"], "serviceFullName":"AWS Billing and Cost Management Pricing Calculator", "serviceId":"BCM Pricing Calculator", "signatureVersion":"v4", @@ -721,10 +718,6 @@ "message":{"shape":"String"} }, "documentation":"

You do not have sufficient access to perform this action.

", - "error":{ - "httpStatusCode":403, - "senderFault":true - }, "exception":true }, "AccountId":{ @@ -2159,10 +2152,6 @@ } }, "documentation":"

The request could not be processed because of conflict in the current state of the resource.

", - "error":{ - "httpStatusCode":409, - "senderFault":true - }, "exception":true }, "CostAmount":{ @@ -2425,10 +2414,6 @@ "message":{"shape":"String"} }, "documentation":"

The requested data is currently unavailable.

", - "error":{ - "httpStatusCode":400, - "senderFault":true - }, "exception":true }, "DeleteBillEstimateRequest":{ @@ -2798,7 +2783,6 @@ } }, "documentation":"

An internal error has occurred. Retry your request, but if the problem persists, contact Amazon Web Services support.

", - "error":{"httpStatusCode":500}, "exception":true, "fault":true }, @@ -3471,10 +3455,6 @@ } }, "documentation":"

The specified resource was not found.

", - "error":{ - "httpStatusCode":404, - "senderFault":true - }, "exception":true }, "ResourceTagKey":{ @@ -3543,10 +3523,6 @@ } }, "documentation":"

The request would cause you to exceed your service quota.

", - "error":{ - "httpStatusCode":402, - "senderFault":true - }, "exception":true }, "String":{"type":"string"}, @@ -3601,10 +3577,6 @@ } }, "documentation":"

The request was denied due to request throttling.

", - "error":{ - "httpStatusCode":429, - "senderFault":true - }, "exception":true }, "Timestamp":{"type":"timestamp"}, @@ -3955,10 +3927,6 @@ } }, "documentation":"

The input provided fails to satisfy the constraints specified by an Amazon Web Services service.

", - "error":{ - "httpStatusCode":400, - "senderFault":true - }, "exception":true }, "ValidationExceptionField":{ diff --git a/tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/api-2.json b/tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/api-2.json deleted file mode 100644 index 083e218a6788..000000000000 --- a/tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/api-2.json +++ /dev/null @@ -1,2611 +0,0 @@ -{ - "version":"2.0", - "metadata":{ - "apiVersion":"2024-06-19", - "auth":["aws.auth#sigv4"], - "endpointPrefix":"bcm-pricing-calculator", - "jsonVersion":"1.0", - "protocol":"json", - "protocols":["json"], - "serviceFullName":"AWS Billing and Cost Management Pricing Calculator", - "serviceId":"BCM Pricing Calculator", - "signatureVersion":"v4", - "signingName":"bcm-pricing-calculator", - "targetPrefix":"AWSBCMPricingCalculator", - "uid":"bcm-pricing-calculator-2024-06-19" - }, - "operations":{ - "BatchCreateBillScenarioCommitmentModification":{ - "name":"BatchCreateBillScenarioCommitmentModification", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"BatchCreateBillScenarioCommitmentModificationRequest"}, - "output":{"shape":"BatchCreateBillScenarioCommitmentModificationResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "idempotent":true - }, - "BatchCreateBillScenarioUsageModification":{ - "name":"BatchCreateBillScenarioUsageModification", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"BatchCreateBillScenarioUsageModificationRequest"}, - "output":{"shape":"BatchCreateBillScenarioUsageModificationResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"ServiceQuotaExceededException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "idempotent":true - }, - "BatchCreateWorkloadEstimateUsage":{ - "name":"BatchCreateWorkloadEstimateUsage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"BatchCreateWorkloadEstimateUsageRequest"}, - "output":{"shape":"BatchCreateWorkloadEstimateUsageResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"ServiceQuotaExceededException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "idempotent":true - }, - "BatchDeleteBillScenarioCommitmentModification":{ - "name":"BatchDeleteBillScenarioCommitmentModification", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"BatchDeleteBillScenarioCommitmentModificationRequest"}, - "output":{"shape":"BatchDeleteBillScenarioCommitmentModificationResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "idempotent":true - }, - "BatchDeleteBillScenarioUsageModification":{ - "name":"BatchDeleteBillScenarioUsageModification", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"BatchDeleteBillScenarioUsageModificationRequest"}, - "output":{"shape":"BatchDeleteBillScenarioUsageModificationResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"ServiceQuotaExceededException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "idempotent":true - }, - "BatchDeleteWorkloadEstimateUsage":{ - "name":"BatchDeleteWorkloadEstimateUsage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"BatchDeleteWorkloadEstimateUsageRequest"}, - "output":{"shape":"BatchDeleteWorkloadEstimateUsageResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"ServiceQuotaExceededException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "idempotent":true - }, - "BatchUpdateBillScenarioCommitmentModification":{ - "name":"BatchUpdateBillScenarioCommitmentModification", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"BatchUpdateBillScenarioCommitmentModificationRequest"}, - "output":{"shape":"BatchUpdateBillScenarioCommitmentModificationResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "idempotent":true - }, - "BatchUpdateBillScenarioUsageModification":{ - "name":"BatchUpdateBillScenarioUsageModification", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"BatchUpdateBillScenarioUsageModificationRequest"}, - "output":{"shape":"BatchUpdateBillScenarioUsageModificationResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"ServiceQuotaExceededException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "idempotent":true - }, - "BatchUpdateWorkloadEstimateUsage":{ - "name":"BatchUpdateWorkloadEstimateUsage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"BatchUpdateWorkloadEstimateUsageRequest"}, - "output":{"shape":"BatchUpdateWorkloadEstimateUsageResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"ServiceQuotaExceededException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "idempotent":true - }, - "CreateBillEstimate":{ - "name":"CreateBillEstimate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateBillEstimateRequest"}, - "output":{"shape":"CreateBillEstimateResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "idempotent":true - }, - "CreateBillScenario":{ - "name":"CreateBillScenario", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateBillScenarioRequest"}, - "output":{"shape":"CreateBillScenarioResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"ServiceQuotaExceededException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "idempotent":true - }, - "CreateWorkloadEstimate":{ - "name":"CreateWorkloadEstimate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateWorkloadEstimateRequest"}, - "output":{"shape":"CreateWorkloadEstimateResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"ServiceQuotaExceededException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "idempotent":true - }, - "DeleteBillEstimate":{ - "name":"DeleteBillEstimate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteBillEstimateRequest"}, - "output":{"shape":"DeleteBillEstimateResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "idempotent":true - }, - "DeleteBillScenario":{ - "name":"DeleteBillScenario", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteBillScenarioRequest"}, - "output":{"shape":"DeleteBillScenarioResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "idempotent":true - }, - "DeleteWorkloadEstimate":{ - "name":"DeleteWorkloadEstimate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteWorkloadEstimateRequest"}, - "output":{"shape":"DeleteWorkloadEstimateResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "idempotent":true - }, - "GetBillEstimate":{ - "name":"GetBillEstimate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetBillEstimateRequest"}, - "output":{"shape":"GetBillEstimateResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "readonly":true - }, - "GetBillScenario":{ - "name":"GetBillScenario", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetBillScenarioRequest"}, - "output":{"shape":"GetBillScenarioResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "readonly":true - }, - "GetPreferences":{ - "name":"GetPreferences", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetPreferencesRequest"}, - "output":{"shape":"GetPreferencesResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "readonly":true - }, - "GetWorkloadEstimate":{ - "name":"GetWorkloadEstimate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetWorkloadEstimateRequest"}, - "output":{"shape":"GetWorkloadEstimateResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "readonly":true - }, - "ListBillEstimateCommitments":{ - "name":"ListBillEstimateCommitments", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListBillEstimateCommitmentsRequest"}, - "output":{"shape":"ListBillEstimateCommitmentsResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "readonly":true - }, - "ListBillEstimateInputCommitmentModifications":{ - "name":"ListBillEstimateInputCommitmentModifications", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListBillEstimateInputCommitmentModificationsRequest"}, - "output":{"shape":"ListBillEstimateInputCommitmentModificationsResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "readonly":true - }, - "ListBillEstimateInputUsageModifications":{ - "name":"ListBillEstimateInputUsageModifications", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListBillEstimateInputUsageModificationsRequest"}, - "output":{"shape":"ListBillEstimateInputUsageModificationsResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "readonly":true - }, - "ListBillEstimateLineItems":{ - "name":"ListBillEstimateLineItems", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListBillEstimateLineItemsRequest"}, - "output":{"shape":"ListBillEstimateLineItemsResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "readonly":true - }, - "ListBillEstimates":{ - "name":"ListBillEstimates", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListBillEstimatesRequest"}, - "output":{"shape":"ListBillEstimatesResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "readonly":true - }, - "ListBillScenarioCommitmentModifications":{ - "name":"ListBillScenarioCommitmentModifications", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListBillScenarioCommitmentModificationsRequest"}, - "output":{"shape":"ListBillScenarioCommitmentModificationsResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "readonly":true - }, - "ListBillScenarioUsageModifications":{ - "name":"ListBillScenarioUsageModifications", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListBillScenarioUsageModificationsRequest"}, - "output":{"shape":"ListBillScenarioUsageModificationsResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "readonly":true - }, - "ListBillScenarios":{ - "name":"ListBillScenarios", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListBillScenariosRequest"}, - "output":{"shape":"ListBillScenariosResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "readonly":true - }, - "ListTagsForResource":{ - "name":"ListTagsForResource", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListTagsForResourceRequest"}, - "output":{"shape":"ListTagsForResourceResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "readonly":true - }, - "ListWorkloadEstimateUsage":{ - "name":"ListWorkloadEstimateUsage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListWorkloadEstimateUsageRequest"}, - "output":{"shape":"ListWorkloadEstimateUsageResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "readonly":true - }, - "ListWorkloadEstimates":{ - "name":"ListWorkloadEstimates", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListWorkloadEstimatesRequest"}, - "output":{"shape":"ListWorkloadEstimatesResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "readonly":true - }, - "TagResource":{ - "name":"TagResource", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"TagResourceRequest"}, - "output":{"shape":"TagResourceResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"ServiceQuotaExceededException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ] - }, - "UntagResource":{ - "name":"UntagResource", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UntagResourceRequest"}, - "output":{"shape":"UntagResourceResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ] - }, - "UpdateBillEstimate":{ - "name":"UpdateBillEstimate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateBillEstimateRequest"}, - "output":{"shape":"UpdateBillEstimateResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "idempotent":true - }, - "UpdateBillScenario":{ - "name":"UpdateBillScenario", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateBillScenarioRequest"}, - "output":{"shape":"UpdateBillScenarioResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "idempotent":true - }, - "UpdatePreferences":{ - "name":"UpdatePreferences", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdatePreferencesRequest"}, - "output":{"shape":"UpdatePreferencesResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"ServiceQuotaExceededException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "idempotent":true - }, - "UpdateWorkloadEstimate":{ - "name":"UpdateWorkloadEstimate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateWorkloadEstimateRequest"}, - "output":{"shape":"UpdateWorkloadEstimateResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "idempotent":true - } - }, - "shapes":{ - "AccessDeniedException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"} - }, - "exception":true - }, - "AccountId":{ - "type":"string", - "max":12, - "min":12, - "pattern":"\\d{12}" - }, - "AddReservedInstanceAction":{ - "type":"structure", - "members":{ - "reservedInstancesOfferingId":{"shape":"Uuid"}, - "instanceCount":{"shape":"ReservedInstanceInstanceCount"} - } - }, - "AddSavingsPlanAction":{ - "type":"structure", - "members":{ - "savingsPlanOfferingId":{"shape":"Uuid"}, - "commitment":{"shape":"SavingsPlanCommitment"} - } - }, - "Arn":{ - "type":"string", - "max":2048, - "min":20, - "pattern":"arn:aws[-a-z0-9]*:bcm-pricing-calculator:[-a-z0-9]*:[0-9]{12}:[-a-z0-9/:_]+" - }, - "AvailabilityZone":{ - "type":"string", - "max":32, - "min":0, - "pattern":"[-a-zA-Z0-9\\.\\-_:, \\/()]*" - }, - "BatchCreateBillScenarioCommitmentModificationEntries":{ - "type":"list", - "member":{"shape":"BatchCreateBillScenarioCommitmentModificationEntry"}, - "max":25, - "min":1 - }, - "BatchCreateBillScenarioCommitmentModificationEntry":{ - "type":"structure", - "required":[ - "key", - "usageAccountId", - "commitmentAction" - ], - "members":{ - "key":{"shape":"Key"}, - "group":{"shape":"UsageGroup"}, - "usageAccountId":{"shape":"AccountId"}, - "commitmentAction":{"shape":"BillScenarioCommitmentModificationAction"} - } - }, - "BatchCreateBillScenarioCommitmentModificationError":{ - "type":"structure", - "members":{ - "key":{"shape":"Key"}, - "errorMessage":{"shape":"String"}, - "errorCode":{"shape":"BatchCreateBillScenarioCommitmentModificationErrorCode"} - } - }, - "BatchCreateBillScenarioCommitmentModificationErrorCode":{ - "type":"string", - "enum":[ - "CONFLICT", - "INTERNAL_SERVER_ERROR", - "INVALID_ACCOUNT" - ] - }, - "BatchCreateBillScenarioCommitmentModificationErrors":{ - "type":"list", - "member":{"shape":"BatchCreateBillScenarioCommitmentModificationError"} - }, - "BatchCreateBillScenarioCommitmentModificationItem":{ - "type":"structure", - "members":{ - "key":{"shape":"Key"}, - "id":{"shape":"ResourceId"}, - "group":{"shape":"UsageGroup"}, - "usageAccountId":{"shape":"AccountId"}, - "commitmentAction":{"shape":"BillScenarioCommitmentModificationAction"} - } - }, - "BatchCreateBillScenarioCommitmentModificationItems":{ - "type":"list", - "member":{"shape":"BatchCreateBillScenarioCommitmentModificationItem"} - }, - "BatchCreateBillScenarioCommitmentModificationRequest":{ - "type":"structure", - "required":[ - "billScenarioId", - "commitmentModifications" - ], - "members":{ - "billScenarioId":{"shape":"ResourceId"}, - "commitmentModifications":{"shape":"BatchCreateBillScenarioCommitmentModificationEntries"}, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - } - } - }, - "BatchCreateBillScenarioCommitmentModificationResponse":{ - "type":"structure", - "members":{ - "items":{"shape":"BatchCreateBillScenarioCommitmentModificationItems"}, - "errors":{"shape":"BatchCreateBillScenarioCommitmentModificationErrors"} - } - }, - "BatchCreateBillScenarioUsageModificationEntries":{ - "type":"list", - "member":{"shape":"BatchCreateBillScenarioUsageModificationEntry"}, - "max":25, - "min":1 - }, - "BatchCreateBillScenarioUsageModificationEntry":{ - "type":"structure", - "required":[ - "serviceCode", - "usageType", - "operation", - "key", - "usageAccountId" - ], - "members":{ - "serviceCode":{"shape":"ServiceCode"}, - "usageType":{"shape":"UsageType"}, - "operation":{"shape":"Operation"}, - "availabilityZone":{"shape":"AvailabilityZone"}, - "key":{"shape":"Key"}, - "group":{"shape":"UsageGroup"}, - "usageAccountId":{"shape":"AccountId"}, - "amounts":{"shape":"UsageAmounts"}, - "historicalUsage":{"shape":"HistoricalUsageEntity"} - } - }, - "BatchCreateBillScenarioUsageModificationError":{ - "type":"structure", - "members":{ - "key":{"shape":"Key"}, - "errorMessage":{"shape":"String"}, - "errorCode":{"shape":"BatchCreateBillScenarioUsageModificationErrorCode"} - } - }, - "BatchCreateBillScenarioUsageModificationErrorCode":{ - "type":"string", - "enum":[ - "BAD_REQUEST", - "NOT_FOUND", - "CONFLICT", - "INTERNAL_SERVER_ERROR" - ] - }, - "BatchCreateBillScenarioUsageModificationErrors":{ - "type":"list", - "member":{"shape":"BatchCreateBillScenarioUsageModificationError"} - }, - "BatchCreateBillScenarioUsageModificationItem":{ - "type":"structure", - "required":[ - "serviceCode", - "usageType", - "operation" - ], - "members":{ - "serviceCode":{"shape":"ServiceCode"}, - "usageType":{"shape":"UsageType"}, - "operation":{"shape":"Operation"}, - "location":{"shape":"String"}, - "availabilityZone":{"shape":"AvailabilityZone"}, - "id":{"shape":"ResourceId"}, - "group":{"shape":"UsageGroup"}, - "usageAccountId":{"shape":"AccountId"}, - "quantities":{"shape":"UsageQuantities"}, - "historicalUsage":{"shape":"HistoricalUsageEntity"}, - "key":{"shape":"Key"} - } - }, - "BatchCreateBillScenarioUsageModificationItems":{ - "type":"list", - "member":{"shape":"BatchCreateBillScenarioUsageModificationItem"} - }, - "BatchCreateBillScenarioUsageModificationRequest":{ - "type":"structure", - "required":[ - "billScenarioId", - "usageModifications" - ], - "members":{ - "billScenarioId":{"shape":"ResourceId"}, - "usageModifications":{"shape":"BatchCreateBillScenarioUsageModificationEntries"}, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - } - } - }, - "BatchCreateBillScenarioUsageModificationResponse":{ - "type":"structure", - "members":{ - "items":{"shape":"BatchCreateBillScenarioUsageModificationItems"}, - "errors":{"shape":"BatchCreateBillScenarioUsageModificationErrors"} - } - }, - "BatchCreateWorkloadEstimateUsageCode":{ - "type":"string", - "enum":[ - "BAD_REQUEST", - "NOT_FOUND", - "CONFLICT", - "INTERNAL_SERVER_ERROR" - ] - }, - "BatchCreateWorkloadEstimateUsageEntries":{ - "type":"list", - "member":{"shape":"BatchCreateWorkloadEstimateUsageEntry"}, - "max":25, - "min":1 - }, - "BatchCreateWorkloadEstimateUsageEntry":{ - "type":"structure", - "required":[ - "serviceCode", - "usageType", - "operation", - "key", - "usageAccountId", - "amount" - ], - "members":{ - "serviceCode":{"shape":"ServiceCode"}, - "usageType":{"shape":"UsageType"}, - "operation":{"shape":"Operation"}, - "key":{"shape":"Key"}, - "group":{"shape":"UsageGroup"}, - "usageAccountId":{"shape":"AccountId"}, - "amount":{"shape":"Double"}, - "historicalUsage":{"shape":"HistoricalUsageEntity"} - } - }, - "BatchCreateWorkloadEstimateUsageError":{ - "type":"structure", - "members":{ - "key":{"shape":"Key"}, - "errorCode":{"shape":"BatchCreateWorkloadEstimateUsageCode"}, - "errorMessage":{"shape":"String"} - } - }, - "BatchCreateWorkloadEstimateUsageErrors":{ - "type":"list", - "member":{"shape":"BatchCreateWorkloadEstimateUsageError"} - }, - "BatchCreateWorkloadEstimateUsageItem":{ - "type":"structure", - "required":[ - "serviceCode", - "usageType", - "operation" - ], - "members":{ - "serviceCode":{"shape":"ServiceCode"}, - "usageType":{"shape":"UsageType"}, - "operation":{"shape":"Operation"}, - "location":{"shape":"String"}, - "id":{"shape":"ResourceId"}, - "usageAccountId":{"shape":"AccountId"}, - "group":{"shape":"UsageGroup"}, - "quantity":{"shape":"WorkloadEstimateUsageQuantity"}, - "cost":{"shape":"Double"}, - "currency":{"shape":"CurrencyCode"}, - "status":{"shape":"WorkloadEstimateCostStatus"}, - "historicalUsage":{"shape":"HistoricalUsageEntity"}, - "key":{"shape":"Key"} - } - }, - "BatchCreateWorkloadEstimateUsageItems":{ - "type":"list", - "member":{"shape":"BatchCreateWorkloadEstimateUsageItem"} - }, - "BatchCreateWorkloadEstimateUsageRequest":{ - "type":"structure", - "required":[ - "workloadEstimateId", - "usage" - ], - "members":{ - "workloadEstimateId":{"shape":"ResourceId"}, - "usage":{"shape":"BatchCreateWorkloadEstimateUsageEntries"}, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - } - } - }, - "BatchCreateWorkloadEstimateUsageResponse":{ - "type":"structure", - "members":{ - "items":{"shape":"BatchCreateWorkloadEstimateUsageItems"}, - "errors":{"shape":"BatchCreateWorkloadEstimateUsageErrors"} - } - }, - "BatchDeleteBillScenarioCommitmentModificationEntries":{ - "type":"list", - "member":{"shape":"ResourceId"}, - "max":25, - "min":1 - }, - "BatchDeleteBillScenarioCommitmentModificationError":{ - "type":"structure", - "members":{ - "id":{"shape":"ResourceId"}, - "errorCode":{"shape":"BatchDeleteBillScenarioCommitmentModificationErrorCode"}, - "errorMessage":{"shape":"String"} - } - }, - "BatchDeleteBillScenarioCommitmentModificationErrorCode":{ - "type":"string", - "enum":[ - "BAD_REQUEST", - "CONFLICT", - "INTERNAL_SERVER_ERROR" - ] - }, - "BatchDeleteBillScenarioCommitmentModificationErrors":{ - "type":"list", - "member":{"shape":"BatchDeleteBillScenarioCommitmentModificationError"} - }, - "BatchDeleteBillScenarioCommitmentModificationRequest":{ - "type":"structure", - "required":[ - "billScenarioId", - "ids" - ], - "members":{ - "billScenarioId":{"shape":"ResourceId"}, - "ids":{"shape":"BatchDeleteBillScenarioCommitmentModificationEntries"} - } - }, - "BatchDeleteBillScenarioCommitmentModificationResponse":{ - "type":"structure", - "members":{ - "errors":{"shape":"BatchDeleteBillScenarioCommitmentModificationErrors"} - } - }, - "BatchDeleteBillScenarioUsageModificationEntries":{ - "type":"list", - "member":{"shape":"ResourceId"}, - "max":25, - "min":1 - }, - "BatchDeleteBillScenarioUsageModificationError":{ - "type":"structure", - "members":{ - "id":{"shape":"ResourceId"}, - "errorMessage":{"shape":"String"}, - "errorCode":{"shape":"BatchDeleteBillScenarioUsageModificationErrorCode"} - } - }, - "BatchDeleteBillScenarioUsageModificationErrorCode":{ - "type":"string", - "enum":[ - "BAD_REQUEST", - "CONFLICT", - "INTERNAL_SERVER_ERROR" - ] - }, - "BatchDeleteBillScenarioUsageModificationErrors":{ - "type":"list", - "member":{"shape":"BatchDeleteBillScenarioUsageModificationError"} - }, - "BatchDeleteBillScenarioUsageModificationRequest":{ - "type":"structure", - "required":[ - "billScenarioId", - "ids" - ], - "members":{ - "billScenarioId":{"shape":"ResourceId"}, - "ids":{"shape":"BatchDeleteBillScenarioUsageModificationEntries"} - } - }, - "BatchDeleteBillScenarioUsageModificationResponse":{ - "type":"structure", - "members":{ - "errors":{"shape":"BatchDeleteBillScenarioUsageModificationErrors"} - } - }, - "BatchDeleteWorkloadEstimateUsageEntries":{ - "type":"list", - "member":{"shape":"ResourceId"}, - "max":25, - "min":1 - }, - "BatchDeleteWorkloadEstimateUsageError":{ - "type":"structure", - "members":{ - "id":{"shape":"ResourceId"}, - "errorMessage":{"shape":"String"}, - "errorCode":{"shape":"WorkloadEstimateUpdateUsageErrorCode"} - } - }, - "BatchDeleteWorkloadEstimateUsageErrors":{ - "type":"list", - "member":{"shape":"BatchDeleteWorkloadEstimateUsageError"} - }, - "BatchDeleteWorkloadEstimateUsageRequest":{ - "type":"structure", - "required":[ - "workloadEstimateId", - "ids" - ], - "members":{ - "workloadEstimateId":{"shape":"ResourceId"}, - "ids":{"shape":"BatchDeleteWorkloadEstimateUsageEntries"} - } - }, - "BatchDeleteWorkloadEstimateUsageResponse":{ - "type":"structure", - "members":{ - "errors":{"shape":"BatchDeleteWorkloadEstimateUsageErrors"} - } - }, - "BatchUpdateBillScenarioCommitmentModificationEntries":{ - "type":"list", - "member":{"shape":"BatchUpdateBillScenarioCommitmentModificationEntry"}, - "max":25, - "min":1 - }, - "BatchUpdateBillScenarioCommitmentModificationEntry":{ - "type":"structure", - "required":["id"], - "members":{ - "id":{"shape":"ResourceId"}, - "group":{"shape":"UsageGroup"} - } - }, - "BatchUpdateBillScenarioCommitmentModificationError":{ - "type":"structure", - "members":{ - "id":{"shape":"ResourceId"}, - "errorCode":{"shape":"BatchUpdateBillScenarioCommitmentModificationErrorCode"}, - "errorMessage":{"shape":"String"} - } - }, - "BatchUpdateBillScenarioCommitmentModificationErrorCode":{ - "type":"string", - "enum":[ - "BAD_REQUEST", - "NOT_FOUND", - "CONFLICT", - "INTERNAL_SERVER_ERROR" - ] - }, - "BatchUpdateBillScenarioCommitmentModificationErrors":{ - "type":"list", - "member":{"shape":"BatchUpdateBillScenarioCommitmentModificationError"} - }, - "BatchUpdateBillScenarioCommitmentModificationRequest":{ - "type":"structure", - "required":[ - "billScenarioId", - "commitmentModifications" - ], - "members":{ - "billScenarioId":{"shape":"ResourceId"}, - "commitmentModifications":{"shape":"BatchUpdateBillScenarioCommitmentModificationEntries"} - } - }, - "BatchUpdateBillScenarioCommitmentModificationResponse":{ - "type":"structure", - "members":{ - "items":{"shape":"BillScenarioCommitmentModificationItems"}, - "errors":{"shape":"BatchUpdateBillScenarioCommitmentModificationErrors"} - } - }, - "BatchUpdateBillScenarioUsageModificationEntries":{ - "type":"list", - "member":{"shape":"BatchUpdateBillScenarioUsageModificationEntry"}, - "max":25, - "min":1 - }, - "BatchUpdateBillScenarioUsageModificationEntry":{ - "type":"structure", - "required":["id"], - "members":{ - "id":{"shape":"ResourceId"}, - "group":{"shape":"UsageGroup"}, - "amounts":{"shape":"UsageAmounts"} - } - }, - "BatchUpdateBillScenarioUsageModificationError":{ - "type":"structure", - "members":{ - "id":{"shape":"ResourceId"}, - "errorMessage":{"shape":"String"}, - "errorCode":{"shape":"BatchUpdateBillScenarioUsageModificationErrorCode"} - } - }, - "BatchUpdateBillScenarioUsageModificationErrorCode":{ - "type":"string", - "enum":[ - "BAD_REQUEST", - "NOT_FOUND", - "CONFLICT", - "INTERNAL_SERVER_ERROR" - ] - }, - "BatchUpdateBillScenarioUsageModificationErrors":{ - "type":"list", - "member":{"shape":"BatchUpdateBillScenarioUsageModificationError"} - }, - "BatchUpdateBillScenarioUsageModificationRequest":{ - "type":"structure", - "required":[ - "billScenarioId", - "usageModifications" - ], - "members":{ - "billScenarioId":{"shape":"ResourceId"}, - "usageModifications":{"shape":"BatchUpdateBillScenarioUsageModificationEntries"} - } - }, - "BatchUpdateBillScenarioUsageModificationResponse":{ - "type":"structure", - "members":{ - "items":{"shape":"BillScenarioUsageModificationItems"}, - "errors":{"shape":"BatchUpdateBillScenarioUsageModificationErrors"} - } - }, - "BatchUpdateWorkloadEstimateUsageEntries":{ - "type":"list", - "member":{"shape":"BatchUpdateWorkloadEstimateUsageEntry"}, - "max":25, - "min":1 - }, - "BatchUpdateWorkloadEstimateUsageEntry":{ - "type":"structure", - "required":["id"], - "members":{ - "id":{"shape":"ResourceId"}, - "group":{"shape":"UsageGroup"}, - "amount":{"shape":"Double"} - } - }, - "BatchUpdateWorkloadEstimateUsageError":{ - "type":"structure", - "members":{ - "id":{"shape":"ResourceId"}, - "errorMessage":{"shape":"String"}, - "errorCode":{"shape":"WorkloadEstimateUpdateUsageErrorCode"} - } - }, - "BatchUpdateWorkloadEstimateUsageErrors":{ - "type":"list", - "member":{"shape":"BatchUpdateWorkloadEstimateUsageError"} - }, - "BatchUpdateWorkloadEstimateUsageRequest":{ - "type":"structure", - "required":[ - "workloadEstimateId", - "usage" - ], - "members":{ - "workloadEstimateId":{"shape":"ResourceId"}, - "usage":{"shape":"BatchUpdateWorkloadEstimateUsageEntries"} - } - }, - "BatchUpdateWorkloadEstimateUsageResponse":{ - "type":"structure", - "members":{ - "items":{"shape":"WorkloadEstimateUsageItems"}, - "errors":{"shape":"BatchUpdateWorkloadEstimateUsageErrors"} - } - }, - "BillEstimateCommitmentSummaries":{ - "type":"list", - "member":{"shape":"BillEstimateCommitmentSummary"} - }, - "BillEstimateCommitmentSummary":{ - "type":"structure", - "members":{ - "id":{"shape":"ResourceId"}, - "purchaseAgreementType":{"shape":"PurchaseAgreementType"}, - "offeringId":{"shape":"Uuid"}, - "usageAccountId":{"shape":"AccountId"}, - "region":{"shape":"String"}, - "termLength":{"shape":"String"}, - "paymentOption":{"shape":"String"}, - "upfrontPayment":{"shape":"CostAmount"}, - "monthlyPayment":{"shape":"CostAmount"} - } - }, - "BillEstimateCostSummary":{ - "type":"structure", - "members":{ - "totalCostDifference":{"shape":"CostDifference"}, - "serviceCostDifferences":{"shape":"ServiceCostDifferenceMap"} - } - }, - "BillEstimateInputCommitmentModificationSummaries":{ - "type":"list", - "member":{"shape":"BillEstimateInputCommitmentModificationSummary"} - }, - "BillEstimateInputCommitmentModificationSummary":{ - "type":"structure", - "members":{ - "id":{"shape":"ResourceId"}, - "group":{"shape":"UsageGroup"}, - "usageAccountId":{"shape":"AccountId"}, - "commitmentAction":{"shape":"BillScenarioCommitmentModificationAction"} - } - }, - "BillEstimateInputUsageModificationSummaries":{ - "type":"list", - "member":{"shape":"BillEstimateInputUsageModificationSummary"} - }, - "BillEstimateInputUsageModificationSummary":{ - "type":"structure", - "required":[ - "serviceCode", - "usageType", - "operation" - ], - "members":{ - "serviceCode":{"shape":"ServiceCode"}, - "usageType":{"shape":"UsageType"}, - "operation":{"shape":"Operation"}, - "location":{"shape":"String"}, - "availabilityZone":{"shape":"AvailabilityZone"}, - "id":{"shape":"ResourceId"}, - "group":{"shape":"UsageGroup"}, - "usageAccountId":{"shape":"AccountId"}, - "quantities":{"shape":"UsageQuantities"}, - "historicalUsage":{"shape":"HistoricalUsageEntity"} - } - }, - "BillEstimateLineItemSummaries":{ - "type":"list", - "member":{"shape":"BillEstimateLineItemSummary"} - }, - "BillEstimateLineItemSummary":{ - "type":"structure", - "required":[ - "serviceCode", - "usageType", - "operation" - ], - "members":{ - "serviceCode":{"shape":"ServiceCode"}, - "usageType":{"shape":"UsageType"}, - "operation":{"shape":"Operation"}, - "location":{"shape":"String"}, - "availabilityZone":{"shape":"AvailabilityZone"}, - "id":{"shape":"ResourceId"}, - "lineItemId":{"shape":"String"}, - "lineItemType":{"shape":"String"}, - "payerAccountId":{"shape":"AccountId"}, - "usageAccountId":{"shape":"AccountId"}, - "estimatedUsageQuantity":{"shape":"UsageQuantityResult"}, - "estimatedCost":{"shape":"CostAmount"}, - "historicalUsageQuantity":{"shape":"UsageQuantityResult"}, - "historicalCost":{"shape":"CostAmount"}, - "savingsPlanArns":{"shape":"SavingsPlanArns"} - } - }, - "BillEstimateName":{ - "type":"string", - "max":64, - "min":0, - "pattern":"[a-zA-Z0-9-]+" - }, - "BillEstimateStatus":{ - "type":"string", - "enum":[ - "IN_PROGRESS", - "COMPLETE", - "FAILED" - ] - }, - "BillEstimateSummaries":{ - "type":"list", - "member":{"shape":"BillEstimateSummary"} - }, - "BillEstimateSummary":{ - "type":"structure", - "required":["id"], - "members":{ - "id":{"shape":"ResourceId"}, - "name":{"shape":"BillEstimateName"}, - "status":{"shape":"BillEstimateStatus"}, - "billInterval":{"shape":"BillInterval"}, - "createdAt":{"shape":"Timestamp"}, - "expiresAt":{"shape":"Timestamp"} - } - }, - "BillInterval":{ - "type":"structure", - "members":{ - "start":{"shape":"Timestamp"}, - "end":{"shape":"Timestamp"} - } - }, - "BillScenarioCommitmentModificationAction":{ - "type":"structure", - "members":{ - "addReservedInstanceAction":{"shape":"AddReservedInstanceAction"}, - "addSavingsPlanAction":{"shape":"AddSavingsPlanAction"}, - "negateReservedInstanceAction":{"shape":"NegateReservedInstanceAction"}, - "negateSavingsPlanAction":{"shape":"NegateSavingsPlanAction"} - }, - "union":true - }, - "BillScenarioCommitmentModificationItem":{ - "type":"structure", - "members":{ - "id":{"shape":"ResourceId"}, - "usageAccountId":{"shape":"AccountId"}, - "group":{"shape":"UsageGroup"}, - "commitmentAction":{"shape":"BillScenarioCommitmentModificationAction"} - } - }, - "BillScenarioCommitmentModificationItems":{ - "type":"list", - "member":{"shape":"BillScenarioCommitmentModificationItem"} - }, - "BillScenarioName":{ - "type":"string", - "max":64, - "min":0, - "pattern":"[a-zA-Z0-9-]+" - }, - "BillScenarioStatus":{ - "type":"string", - "enum":[ - "READY", - "LOCKED", - "FAILED", - "STALE" - ] - }, - "BillScenarioSummaries":{ - "type":"list", - "member":{"shape":"BillScenarioSummary"} - }, - "BillScenarioSummary":{ - "type":"structure", - "required":["id"], - "members":{ - "id":{"shape":"ResourceId"}, - "name":{"shape":"BillScenarioName"}, - "billInterval":{"shape":"BillInterval"}, - "status":{"shape":"BillScenarioStatus"}, - "createdAt":{"shape":"Timestamp"}, - "expiresAt":{"shape":"Timestamp"}, - "failureMessage":{"shape":"String"}, - "groupSharingPreference":{"shape":"GroupSharingPreferenceEnum"}, - "costCategoryGroupSharingPreferenceArn":{"shape":"CostCategoryArn"} - } - }, - "BillScenarioUsageModificationItem":{ - "type":"structure", - "required":[ - "serviceCode", - "usageType", - "operation" - ], - "members":{ - "serviceCode":{"shape":"ServiceCode"}, - "usageType":{"shape":"UsageType"}, - "operation":{"shape":"Operation"}, - "location":{"shape":"String"}, - "availabilityZone":{"shape":"AvailabilityZone"}, - "id":{"shape":"ResourceId"}, - "group":{"shape":"UsageGroup"}, - "usageAccountId":{"shape":"AccountId"}, - "quantities":{"shape":"UsageQuantities"}, - "historicalUsage":{"shape":"HistoricalUsageEntity"} - } - }, - "BillScenarioUsageModificationItems":{ - "type":"list", - "member":{"shape":"BillScenarioUsageModificationItem"} - }, - "ClientToken":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[\\u0021-\\u007E]+" - }, - "ConflictException":{ - "type":"structure", - "required":[ - "message", - "resourceId", - "resourceType" - ], - "members":{ - "message":{"shape":"String"}, - "resourceId":{"shape":"String"}, - "resourceType":{"shape":"String"} - }, - "exception":true - }, - "CostAmount":{ - "type":"structure", - "members":{ - "amount":{"shape":"Double"}, - "currency":{"shape":"CurrencyCode"} - } - }, - "CostCategoryArn":{ - "type":"string", - "max":2048, - "min":20, - "pattern":"arn:aws[-a-z0-9]*:ce::[0-9]{12}:costcategory/[a-f0-9-]{36}" - }, - "CostDifference":{ - "type":"structure", - "members":{ - "historicalCost":{"shape":"CostAmount"}, - "estimatedCost":{"shape":"CostAmount"} - } - }, - "CreateBillEstimateRequest":{ - "type":"structure", - "required":[ - "billScenarioId", - "name" - ], - "members":{ - "billScenarioId":{"shape":"ResourceId"}, - "name":{"shape":"BillEstimateName"}, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - }, - "tags":{"shape":"Tags"} - } - }, - "CreateBillEstimateResponse":{ - "type":"structure", - "required":["id"], - "members":{ - "id":{"shape":"ResourceId"}, - "name":{"shape":"BillEstimateName"}, - "status":{"shape":"BillEstimateStatus"}, - "failureMessage":{"shape":"String"}, - "billInterval":{"shape":"BillInterval"}, - "costSummary":{"shape":"BillEstimateCostSummary"}, - "createdAt":{"shape":"Timestamp"}, - "expiresAt":{"shape":"Timestamp"}, - "groupSharingPreference":{"shape":"GroupSharingPreferenceEnum"}, - "costCategoryGroupSharingPreferenceArn":{"shape":"CostCategoryArn"}, - "costCategoryGroupSharingPreferenceEffectiveDate":{"shape":"Timestamp"} - } - }, - "CreateBillScenarioRequest":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{"shape":"BillScenarioName"}, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - }, - "tags":{"shape":"Tags"}, - "groupSharingPreference":{"shape":"GroupSharingPreferenceEnum"}, - "costCategoryGroupSharingPreferenceArn":{"shape":"CostCategoryArn"} - } - }, - "CreateBillScenarioResponse":{ - "type":"structure", - "required":["id"], - "members":{ - "id":{"shape":"ResourceId"}, - "name":{"shape":"BillScenarioName"}, - "billInterval":{"shape":"BillInterval"}, - "status":{"shape":"BillScenarioStatus"}, - "createdAt":{"shape":"Timestamp"}, - "expiresAt":{"shape":"Timestamp"}, - "failureMessage":{"shape":"String"}, - "groupSharingPreference":{"shape":"GroupSharingPreferenceEnum"}, - "costCategoryGroupSharingPreferenceArn":{"shape":"CostCategoryArn"} - } - }, - "CreateWorkloadEstimateRequest":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{"shape":"WorkloadEstimateName"}, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - }, - "rateType":{"shape":"WorkloadEstimateRateType"}, - "tags":{"shape":"Tags"} - } - }, - "CreateWorkloadEstimateResponse":{ - "type":"structure", - "required":["id"], - "members":{ - "id":{"shape":"ResourceId"}, - "name":{"shape":"WorkloadEstimateName"}, - "createdAt":{"shape":"Timestamp"}, - "expiresAt":{"shape":"Timestamp"}, - "rateType":{"shape":"WorkloadEstimateRateType"}, - "rateTimestamp":{"shape":"Timestamp"}, - "status":{"shape":"WorkloadEstimateStatus"}, - "totalCost":{"shape":"Double"}, - "costCurrency":{"shape":"CurrencyCode"}, - "failureMessage":{"shape":"String"} - } - }, - "CurrencyCode":{ - "type":"string", - "enum":["USD"] - }, - "DataUnavailableException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"} - }, - "exception":true - }, - "DeleteBillEstimateRequest":{ - "type":"structure", - "required":["identifier"], - "members":{ - "identifier":{"shape":"ResourceId"} - } - }, - "DeleteBillEstimateResponse":{ - "type":"structure", - "members":{} - }, - "DeleteBillScenarioRequest":{ - "type":"structure", - "required":["identifier"], - "members":{ - "identifier":{"shape":"ResourceId"} - } - }, - "DeleteBillScenarioResponse":{ - "type":"structure", - "members":{} - }, - "DeleteWorkloadEstimateRequest":{ - "type":"structure", - "required":["identifier"], - "members":{ - "identifier":{"shape":"ResourceId"} - } - }, - "DeleteWorkloadEstimateResponse":{ - "type":"structure", - "members":{} - }, - "Double":{ - "type":"double", - "box":true - }, - "Expression":{ - "type":"structure", - "members":{ - "and":{"shape":"ExpressionList"}, - "or":{"shape":"ExpressionList"}, - "not":{"shape":"Expression"}, - "costCategories":{"shape":"ExpressionFilter"}, - "dimensions":{"shape":"ExpressionFilter"}, - "tags":{"shape":"ExpressionFilter"} - } - }, - "ExpressionFilter":{ - "type":"structure", - "members":{ - "key":{"shape":"String"}, - "matchOptions":{"shape":"StringList"}, - "values":{"shape":"StringList"} - } - }, - "ExpressionList":{ - "type":"list", - "member":{"shape":"Expression"} - }, - "FilterTimestamp":{ - "type":"structure", - "members":{ - "afterTimestamp":{"shape":"Timestamp"}, - "beforeTimestamp":{"shape":"Timestamp"} - } - }, - "GetBillEstimateRequest":{ - "type":"structure", - "required":["identifier"], - "members":{ - "identifier":{"shape":"ResourceId"} - } - }, - "GetBillEstimateResponse":{ - "type":"structure", - "required":["id"], - "members":{ - "id":{"shape":"ResourceId"}, - "name":{"shape":"BillEstimateName"}, - "status":{"shape":"BillEstimateStatus"}, - "failureMessage":{"shape":"String"}, - "billInterval":{"shape":"BillInterval"}, - "costSummary":{"shape":"BillEstimateCostSummary"}, - "createdAt":{"shape":"Timestamp"}, - "expiresAt":{"shape":"Timestamp"}, - "groupSharingPreference":{"shape":"GroupSharingPreferenceEnum"}, - "costCategoryGroupSharingPreferenceArn":{"shape":"CostCategoryArn"}, - "costCategoryGroupSharingPreferenceEffectiveDate":{"shape":"Timestamp"} - } - }, - "GetBillScenarioRequest":{ - "type":"structure", - "required":["identifier"], - "members":{ - "identifier":{"shape":"ResourceId"} - } - }, - "GetBillScenarioResponse":{ - "type":"structure", - "required":["id"], - "members":{ - "id":{"shape":"ResourceId"}, - "name":{"shape":"BillScenarioName"}, - "billInterval":{"shape":"BillInterval"}, - "status":{"shape":"BillScenarioStatus"}, - "createdAt":{"shape":"Timestamp"}, - "expiresAt":{"shape":"Timestamp"}, - "failureMessage":{"shape":"String"}, - "groupSharingPreference":{"shape":"GroupSharingPreferenceEnum"}, - "costCategoryGroupSharingPreferenceArn":{"shape":"CostCategoryArn"} - } - }, - "GetPreferencesRequest":{ - "type":"structure", - "members":{} - }, - "GetPreferencesResponse":{ - "type":"structure", - "members":{ - "managementAccountRateTypeSelections":{"shape":"RateTypes"}, - "memberAccountRateTypeSelections":{"shape":"RateTypes"}, - "standaloneAccountRateTypeSelections":{"shape":"RateTypes"} - } - }, - "GetWorkloadEstimateRequest":{ - "type":"structure", - "required":["identifier"], - "members":{ - "identifier":{"shape":"ResourceId"} - } - }, - "GetWorkloadEstimateResponse":{ - "type":"structure", - "required":["id"], - "members":{ - "id":{"shape":"ResourceId"}, - "name":{"shape":"WorkloadEstimateName"}, - "createdAt":{"shape":"Timestamp"}, - "expiresAt":{"shape":"Timestamp"}, - "rateType":{"shape":"WorkloadEstimateRateType"}, - "rateTimestamp":{"shape":"Timestamp"}, - "status":{"shape":"WorkloadEstimateStatus"}, - "totalCost":{"shape":"Double"}, - "costCurrency":{"shape":"CurrencyCode"}, - "failureMessage":{"shape":"String"} - } - }, - "GroupSharingPreferenceEnum":{ - "type":"string", - "enum":[ - "OPEN", - "PRIORITIZED", - "RESTRICTED" - ] - }, - "HistoricalUsageEntity":{ - "type":"structure", - "required":[ - "serviceCode", - "usageType", - "operation", - "usageAccountId", - "billInterval", - "filterExpression" - ], - "members":{ - "serviceCode":{"shape":"ServiceCode"}, - "usageType":{"shape":"UsageType"}, - "operation":{"shape":"Operation"}, - "location":{"shape":"String"}, - "usageAccountId":{"shape":"AccountId"}, - "billInterval":{"shape":"BillInterval"}, - "filterExpression":{"shape":"Expression"} - } - }, - "Integer":{ - "type":"integer", - "box":true - }, - "InternalServerException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"}, - "retryAfterSeconds":{"shape":"Integer"} - }, - "exception":true, - "fault":true - }, - "Key":{ - "type":"string", - "max":10, - "min":0, - "pattern":"[a-zA-Z0-9]*" - }, - "ListBillEstimateCommitmentsRequest":{ - "type":"structure", - "required":["billEstimateId"], - "members":{ - "billEstimateId":{"shape":"ResourceId"}, - "nextToken":{"shape":"NextPageToken"}, - "maxResults":{"shape":"MaxResults"} - } - }, - "ListBillEstimateCommitmentsResponse":{ - "type":"structure", - "members":{ - "items":{"shape":"BillEstimateCommitmentSummaries"}, - "nextToken":{"shape":"NextPageToken"} - } - }, - "ListBillEstimateInputCommitmentModificationsRequest":{ - "type":"structure", - "required":["billEstimateId"], - "members":{ - "billEstimateId":{"shape":"ResourceId"}, - "nextToken":{"shape":"NextPageToken"}, - "maxResults":{"shape":"MaxResults"} - } - }, - "ListBillEstimateInputCommitmentModificationsResponse":{ - "type":"structure", - "members":{ - "items":{"shape":"BillEstimateInputCommitmentModificationSummaries"}, - "nextToken":{"shape":"NextPageToken"} - } - }, - "ListBillEstimateInputUsageModificationsRequest":{ - "type":"structure", - "required":["billEstimateId"], - "members":{ - "billEstimateId":{"shape":"ResourceId"}, - "filters":{"shape":"ListUsageFilters"}, - "nextToken":{"shape":"NextPageToken"}, - "maxResults":{"shape":"MaxResults"} - } - }, - "ListBillEstimateInputUsageModificationsResponse":{ - "type":"structure", - "members":{ - "items":{"shape":"BillEstimateInputUsageModificationSummaries"}, - "nextToken":{"shape":"NextPageToken"} - } - }, - "ListBillEstimateLineItemsFilter":{ - "type":"structure", - "required":[ - "name", - "values" - ], - "members":{ - "name":{"shape":"ListBillEstimateLineItemsFilterName"}, - "values":{"shape":"ListBillEstimateLineItemsFilterValues"}, - "matchOption":{"shape":"MatchOption"} - } - }, - "ListBillEstimateLineItemsFilterName":{ - "type":"string", - "enum":[ - "USAGE_ACCOUNT_ID", - "SERVICE_CODE", - "USAGE_TYPE", - "OPERATION", - "LOCATION", - "LINE_ITEM_TYPE" - ] - }, - "ListBillEstimateLineItemsFilterValues":{ - "type":"list", - "member":{"shape":"String"} - }, - "ListBillEstimateLineItemsFilters":{ - "type":"list", - "member":{"shape":"ListBillEstimateLineItemsFilter"} - }, - "ListBillEstimateLineItemsRequest":{ - "type":"structure", - "required":["billEstimateId"], - "members":{ - "billEstimateId":{"shape":"ResourceId"}, - "filters":{"shape":"ListBillEstimateLineItemsFilters"}, - "nextToken":{"shape":"NextPageToken"}, - "maxResults":{"shape":"MaxResults"} - } - }, - "ListBillEstimateLineItemsResponse":{ - "type":"structure", - "members":{ - "items":{"shape":"BillEstimateLineItemSummaries"}, - "nextToken":{"shape":"NextPageToken"} - } - }, - "ListBillEstimatesFilter":{ - "type":"structure", - "required":[ - "name", - "values" - ], - "members":{ - "name":{"shape":"ListBillEstimatesFilterName"}, - "values":{"shape":"ListBillEstimatesFilterValues"}, - "matchOption":{"shape":"MatchOption"} - } - }, - "ListBillEstimatesFilterName":{ - "type":"string", - "enum":[ - "STATUS", - "NAME" - ] - }, - "ListBillEstimatesFilterValues":{ - "type":"list", - "member":{"shape":"String"} - }, - "ListBillEstimatesFilters":{ - "type":"list", - "member":{"shape":"ListBillEstimatesFilter"} - }, - "ListBillEstimatesRequest":{ - "type":"structure", - "members":{ - "filters":{"shape":"ListBillEstimatesFilters"}, - "createdAtFilter":{"shape":"FilterTimestamp"}, - "expiresAtFilter":{"shape":"FilterTimestamp"}, - "nextToken":{"shape":"NextPageToken"}, - "maxResults":{"shape":"MaxResults"} - } - }, - "ListBillEstimatesResponse":{ - "type":"structure", - "members":{ - "items":{"shape":"BillEstimateSummaries"}, - "nextToken":{"shape":"NextPageToken"} - } - }, - "ListBillScenarioCommitmentModificationsRequest":{ - "type":"structure", - "required":["billScenarioId"], - "members":{ - "billScenarioId":{"shape":"ResourceId"}, - "nextToken":{"shape":"NextPageToken"}, - "maxResults":{"shape":"MaxResults"} - } - }, - "ListBillScenarioCommitmentModificationsResponse":{ - "type":"structure", - "members":{ - "items":{"shape":"BillScenarioCommitmentModificationItems"}, - "nextToken":{"shape":"NextPageToken"} - } - }, - "ListBillScenarioUsageModificationsRequest":{ - "type":"structure", - "required":["billScenarioId"], - "members":{ - "billScenarioId":{"shape":"ResourceId"}, - "filters":{"shape":"ListUsageFilters"}, - "nextToken":{"shape":"NextPageToken"}, - "maxResults":{"shape":"MaxResults"} - } - }, - "ListBillScenarioUsageModificationsResponse":{ - "type":"structure", - "members":{ - "items":{"shape":"BillScenarioUsageModificationItems"}, - "nextToken":{"shape":"NextPageToken"} - } - }, - "ListBillScenariosFilter":{ - "type":"structure", - "required":[ - "name", - "values" - ], - "members":{ - "name":{"shape":"ListBillScenariosFilterName"}, - "values":{"shape":"ListBillScenariosFilterValues"}, - "matchOption":{"shape":"MatchOption"} - } - }, - "ListBillScenariosFilterName":{ - "type":"string", - "enum":[ - "STATUS", - "NAME", - "GROUP_SHARING_PREFERENCE", - "COST_CATEGORY_ARN" - ] - }, - "ListBillScenariosFilterValues":{ - "type":"list", - "member":{"shape":"String"} - }, - "ListBillScenariosFilters":{ - "type":"list", - "member":{"shape":"ListBillScenariosFilter"} - }, - "ListBillScenariosRequest":{ - "type":"structure", - "members":{ - "filters":{"shape":"ListBillScenariosFilters"}, - "createdAtFilter":{"shape":"FilterTimestamp"}, - "expiresAtFilter":{"shape":"FilterTimestamp"}, - "nextToken":{"shape":"NextPageToken"}, - "maxResults":{"shape":"MaxResults"} - } - }, - "ListBillScenariosResponse":{ - "type":"structure", - "members":{ - "items":{"shape":"BillScenarioSummaries"}, - "nextToken":{"shape":"NextPageToken"} - } - }, - "ListTagsForResourceRequest":{ - "type":"structure", - "required":["arn"], - "members":{ - "arn":{"shape":"Arn"} - } - }, - "ListTagsForResourceResponse":{ - "type":"structure", - "members":{ - "tags":{"shape":"Tags"} - } - }, - "ListUsageFilter":{ - "type":"structure", - "required":[ - "name", - "values" - ], - "members":{ - "name":{"shape":"ListUsageFilterName"}, - "values":{"shape":"ListUsageFilterValues"}, - "matchOption":{"shape":"MatchOption"} - } - }, - "ListUsageFilterName":{ - "type":"string", - "enum":[ - "USAGE_ACCOUNT_ID", - "SERVICE_CODE", - "USAGE_TYPE", - "OPERATION", - "LOCATION", - "USAGE_GROUP", - "HISTORICAL_USAGE_ACCOUNT_ID", - "HISTORICAL_SERVICE_CODE", - "HISTORICAL_USAGE_TYPE", - "HISTORICAL_OPERATION", - "HISTORICAL_LOCATION" - ] - }, - "ListUsageFilterValues":{ - "type":"list", - "member":{"shape":"String"} - }, - "ListUsageFilters":{ - "type":"list", - "member":{"shape":"ListUsageFilter"} - }, - "ListWorkloadEstimateUsageRequest":{ - "type":"structure", - "required":["workloadEstimateId"], - "members":{ - "workloadEstimateId":{"shape":"ResourceId"}, - "filters":{"shape":"ListUsageFilters"}, - "nextToken":{"shape":"NextPageToken"}, - "maxResults":{"shape":"WorkloadEstimateUsageMaxResults"} - } - }, - "ListWorkloadEstimateUsageResponse":{ - "type":"structure", - "members":{ - "items":{"shape":"WorkloadEstimateUsageItems"}, - "nextToken":{"shape":"NextPageToken"} - } - }, - "ListWorkloadEstimatesFilter":{ - "type":"structure", - "required":[ - "name", - "values" - ], - "members":{ - "name":{"shape":"ListWorkloadEstimatesFilterName"}, - "values":{"shape":"ListWorkloadEstimatesFilterValues"}, - "matchOption":{"shape":"MatchOption"} - } - }, - "ListWorkloadEstimatesFilterName":{ - "type":"string", - "enum":[ - "STATUS", - "NAME" - ] - }, - "ListWorkloadEstimatesFilterValues":{ - "type":"list", - "member":{"shape":"String"} - }, - "ListWorkloadEstimatesFilters":{ - "type":"list", - "member":{"shape":"ListWorkloadEstimatesFilter"} - }, - "ListWorkloadEstimatesRequest":{ - "type":"structure", - "members":{ - "createdAtFilter":{"shape":"FilterTimestamp"}, - "expiresAtFilter":{"shape":"FilterTimestamp"}, - "filters":{"shape":"ListWorkloadEstimatesFilters"}, - "nextToken":{"shape":"NextPageToken"}, - "maxResults":{"shape":"MaxResults"} - } - }, - "ListWorkloadEstimatesResponse":{ - "type":"structure", - "members":{ - "items":{"shape":"WorkloadEstimateSummaries"}, - "nextToken":{"shape":"NextPageToken"} - } - }, - "MatchOption":{ - "type":"string", - "enum":[ - "EQUALS", - "STARTS_WITH", - "CONTAINS" - ] - }, - "MaxResults":{ - "type":"integer", - "box":true, - "max":25, - "min":1 - }, - "NegateReservedInstanceAction":{ - "type":"structure", - "members":{ - "reservedInstancesId":{"shape":"Uuid"} - } - }, - "NegateSavingsPlanAction":{ - "type":"structure", - "members":{ - "savingsPlanId":{"shape":"Uuid"} - } - }, - "NextPageToken":{ - "type":"string", - "max":2048, - "min":0, - "pattern":"[\\S\\s]*" - }, - "Operation":{ - "type":"string", - "max":32, - "min":0, - "pattern":"[-a-zA-Z0-9\\.\\-_:, \\/()]*" - }, - "PurchaseAgreementType":{ - "type":"string", - "enum":[ - "SAVINGS_PLANS", - "RESERVED_INSTANCE" - ] - }, - "RateType":{ - "type":"string", - "enum":[ - "BEFORE_DISCOUNTS", - "AFTER_DISCOUNTS", - "AFTER_DISCOUNTS_AND_COMMITMENTS" - ] - }, - "RateTypes":{ - "type":"list", - "member":{"shape":"RateType"}, - "max":3, - "min":1 - }, - "ReservedInstanceInstanceCount":{ - "type":"integer", - "box":true, - "min":1 - }, - "ResourceId":{ - "type":"string", - "max":36, - "min":36, - "pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" - }, - "ResourceNotFoundException":{ - "type":"structure", - "required":[ - "message", - "resourceId", - "resourceType" - ], - "members":{ - "message":{"shape":"String"}, - "resourceId":{"shape":"String"}, - "resourceType":{"shape":"String"} - }, - "exception":true - }, - "ResourceTagKey":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[\\w\\s:+=@/-]+" - }, - "ResourceTagKeys":{ - "type":"list", - "member":{"shape":"ResourceTagKey"}, - "max":200, - "min":0 - }, - "ResourceTagValue":{ - "type":"string", - "max":256, - "min":0, - "pattern":"[\\w\\s:+=@/-]*" - }, - "SavingsPlanArns":{ - "type":"list", - "member":{"shape":"String"} - }, - "SavingsPlanCommitment":{ - "type":"double", - "box":true, - "max":1000000, - "min":0.001 - }, - "ServiceCode":{ - "type":"string", - "max":32, - "min":0, - "pattern":"[-a-zA-Z0-9\\.\\-_:, \\/()]*" - }, - "ServiceCostDifferenceMap":{ - "type":"map", - "key":{"shape":"String"}, - "value":{"shape":"CostDifference"} - }, - "ServiceQuotaExceededException":{ - "type":"structure", - "required":[ - "message", - "resourceId", - "resourceType" - ], - "members":{ - "message":{"shape":"String"}, - "resourceId":{"shape":"String"}, - "resourceType":{"shape":"String"}, - "serviceCode":{"shape":"String"}, - "quotaCode":{"shape":"String"} - }, - "exception":true - }, - "String":{"type":"string"}, - "StringList":{ - "type":"list", - "member":{"shape":"String"} - }, - "TagResourceRequest":{ - "type":"structure", - "required":[ - "arn", - "tags" - ], - "members":{ - "arn":{"shape":"Arn"}, - "tags":{"shape":"Tags"} - } - }, - "TagResourceResponse":{ - "type":"structure", - "members":{} - }, - "Tags":{ - "type":"map", - "key":{"shape":"ResourceTagKey"}, - "value":{"shape":"ResourceTagValue"}, - "max":200, - "min":0 - }, - "ThrottlingException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"}, - "serviceCode":{"shape":"String"}, - "quotaCode":{"shape":"String"}, - "retryAfterSeconds":{"shape":"Integer"} - }, - "exception":true - }, - "Timestamp":{"type":"timestamp"}, - "UntagResourceRequest":{ - "type":"structure", - "required":[ - "arn", - "tagKeys" - ], - "members":{ - "arn":{"shape":"Arn"}, - "tagKeys":{"shape":"ResourceTagKeys"} - } - }, - "UntagResourceResponse":{ - "type":"structure", - "members":{} - }, - "UpdateBillEstimateRequest":{ - "type":"structure", - "required":["identifier"], - "members":{ - "identifier":{"shape":"ResourceId"}, - "name":{"shape":"BillEstimateName"}, - "expiresAt":{"shape":"Timestamp"} - } - }, - "UpdateBillEstimateResponse":{ - "type":"structure", - "required":["id"], - "members":{ - "id":{"shape":"ResourceId"}, - "name":{"shape":"BillEstimateName"}, - "status":{"shape":"BillEstimateStatus"}, - "failureMessage":{"shape":"String"}, - "billInterval":{"shape":"BillInterval"}, - "costSummary":{"shape":"BillEstimateCostSummary"}, - "createdAt":{"shape":"Timestamp"}, - "expiresAt":{"shape":"Timestamp"}, - "groupSharingPreference":{"shape":"GroupSharingPreferenceEnum"}, - "costCategoryGroupSharingPreferenceArn":{"shape":"CostCategoryArn"}, - "costCategoryGroupSharingPreferenceEffectiveDate":{"shape":"Timestamp"} - } - }, - "UpdateBillScenarioRequest":{ - "type":"structure", - "required":["identifier"], - "members":{ - "identifier":{"shape":"ResourceId"}, - "name":{"shape":"BillScenarioName"}, - "expiresAt":{"shape":"Timestamp"}, - "groupSharingPreference":{"shape":"GroupSharingPreferenceEnum"}, - "costCategoryGroupSharingPreferenceArn":{"shape":"CostCategoryArn"} - } - }, - "UpdateBillScenarioResponse":{ - "type":"structure", - "required":["id"], - "members":{ - "id":{"shape":"ResourceId"}, - "name":{"shape":"BillScenarioName"}, - "billInterval":{"shape":"BillInterval"}, - "status":{"shape":"BillScenarioStatus"}, - "createdAt":{"shape":"Timestamp"}, - "expiresAt":{"shape":"Timestamp"}, - "failureMessage":{"shape":"String"}, - "groupSharingPreference":{"shape":"GroupSharingPreferenceEnum"}, - "costCategoryGroupSharingPreferenceArn":{"shape":"CostCategoryArn"} - } - }, - "UpdatePreferencesRequest":{ - "type":"structure", - "members":{ - "managementAccountRateTypeSelections":{"shape":"RateTypes"}, - "memberAccountRateTypeSelections":{"shape":"RateTypes"}, - "standaloneAccountRateTypeSelections":{"shape":"RateTypes"} - } - }, - "UpdatePreferencesResponse":{ - "type":"structure", - "members":{ - "managementAccountRateTypeSelections":{"shape":"RateTypes"}, - "memberAccountRateTypeSelections":{"shape":"RateTypes"}, - "standaloneAccountRateTypeSelections":{"shape":"RateTypes"} - } - }, - "UpdateWorkloadEstimateRequest":{ - "type":"structure", - "required":["identifier"], - "members":{ - "identifier":{"shape":"ResourceId"}, - "name":{"shape":"WorkloadEstimateName"}, - "expiresAt":{"shape":"Timestamp"} - } - }, - "UpdateWorkloadEstimateResponse":{ - "type":"structure", - "required":["id"], - "members":{ - "id":{"shape":"ResourceId"}, - "name":{"shape":"WorkloadEstimateName"}, - "createdAt":{"shape":"Timestamp"}, - "expiresAt":{"shape":"Timestamp"}, - "rateType":{"shape":"WorkloadEstimateRateType"}, - "rateTimestamp":{"shape":"Timestamp"}, - "status":{"shape":"WorkloadEstimateStatus"}, - "totalCost":{"shape":"Double"}, - "costCurrency":{"shape":"CurrencyCode"}, - "failureMessage":{"shape":"String"} - } - }, - "UsageAmount":{ - "type":"structure", - "required":[ - "startHour", - "amount" - ], - "members":{ - "startHour":{"shape":"Timestamp"}, - "amount":{"shape":"Double"} - } - }, - "UsageAmounts":{ - "type":"list", - "member":{"shape":"UsageAmount"} - }, - "UsageGroup":{ - "type":"string", - "max":30, - "min":0, - "pattern":"[a-zA-Z0-9-]*" - }, - "UsageQuantities":{ - "type":"list", - "member":{"shape":"UsageQuantity"} - }, - "UsageQuantity":{ - "type":"structure", - "members":{ - "startHour":{"shape":"Timestamp"}, - "unit":{"shape":"String"}, - "amount":{"shape":"Double"} - } - }, - "UsageQuantityResult":{ - "type":"structure", - "members":{ - "amount":{"shape":"Double"}, - "unit":{"shape":"String"} - } - }, - "UsageType":{ - "type":"string", - "max":128, - "min":0, - "pattern":"[-a-zA-Z0-9\\.\\-_:, \\/()]*" - }, - "Uuid":{ - "type":"string", - "max":36, - "min":36, - "pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" - }, - "ValidationException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"}, - "reason":{"shape":"ValidationExceptionReason"}, - "fieldList":{"shape":"ValidationExceptionFieldList"} - }, - "exception":true - }, - "ValidationExceptionField":{ - "type":"structure", - "required":[ - "name", - "message" - ], - "members":{ - "name":{"shape":"String"}, - "message":{"shape":"String"} - } - }, - "ValidationExceptionFieldList":{ - "type":"list", - "member":{"shape":"ValidationExceptionField"} - }, - "ValidationExceptionReason":{ - "type":"string", - "enum":[ - "unknownOperation", - "cannotParse", - "fieldValidationFailed", - "invalidRequestFromMember", - "disallowedRate", - "other" - ] - }, - "WorkloadEstimateCostStatus":{ - "type":"string", - "enum":[ - "VALID", - "INVALID", - "STALE" - ] - }, - "WorkloadEstimateName":{ - "type":"string", - "max":64, - "min":0, - "pattern":"[a-zA-Z0-9-]+" - }, - "WorkloadEstimateRateType":{ - "type":"string", - "enum":[ - "BEFORE_DISCOUNTS", - "AFTER_DISCOUNTS", - "AFTER_DISCOUNTS_AND_COMMITMENTS" - ] - }, - "WorkloadEstimateStatus":{ - "type":"string", - "enum":[ - "UPDATING", - "VALID", - "INVALID", - "ACTION_NEEDED" - ] - }, - "WorkloadEstimateSummaries":{ - "type":"list", - "member":{"shape":"WorkloadEstimateSummary"} - }, - "WorkloadEstimateSummary":{ - "type":"structure", - "required":["id"], - "members":{ - "id":{"shape":"ResourceId"}, - "name":{"shape":"WorkloadEstimateName"}, - "createdAt":{"shape":"Timestamp"}, - "expiresAt":{"shape":"Timestamp"}, - "rateType":{"shape":"WorkloadEstimateRateType"}, - "rateTimestamp":{"shape":"Timestamp"}, - "status":{"shape":"WorkloadEstimateStatus"}, - "totalCost":{"shape":"Double"}, - "costCurrency":{"shape":"CurrencyCode"}, - "failureMessage":{"shape":"String"} - } - }, - "WorkloadEstimateUpdateUsageErrorCode":{ - "type":"string", - "enum":[ - "BAD_REQUEST", - "NOT_FOUND", - "CONFLICT", - "INTERNAL_SERVER_ERROR" - ] - }, - "WorkloadEstimateUsageItem":{ - "type":"structure", - "required":[ - "serviceCode", - "usageType", - "operation" - ], - "members":{ - "serviceCode":{"shape":"ServiceCode"}, - "usageType":{"shape":"UsageType"}, - "operation":{"shape":"Operation"}, - "location":{"shape":"String"}, - "id":{"shape":"ResourceId"}, - "usageAccountId":{"shape":"AccountId"}, - "group":{"shape":"UsageGroup"}, - "quantity":{"shape":"WorkloadEstimateUsageQuantity"}, - "cost":{"shape":"Double"}, - "currency":{"shape":"CurrencyCode"}, - "status":{"shape":"WorkloadEstimateCostStatus"}, - "historicalUsage":{"shape":"HistoricalUsageEntity"} - } - }, - "WorkloadEstimateUsageItems":{ - "type":"list", - "member":{"shape":"WorkloadEstimateUsageItem"} - }, - "WorkloadEstimateUsageMaxResults":{ - "type":"integer", - "box":true, - "max":300, - "min":1 - }, - "WorkloadEstimateUsageQuantity":{ - "type":"structure", - "members":{ - "unit":{"shape":"String"}, - "amount":{"shape":"Double"} - } - } - } -} diff --git a/tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/docs-2.json b/tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/docs-2.json deleted file mode 100644 index 89aae2615176..000000000000 --- a/tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/docs-2.json +++ /dev/null @@ -1,1666 +0,0 @@ -{ - "version": "2.0", - "service": "

You can use the Pricing Calculator API to programmatically create estimates for your planned cloud use. You can model usage and commitments such as Savings Plans and Reserved Instances, and generate estimated costs using your discounts and benefit sharing preferences.

The Pricing Calculator API provides the following endpoint:

  • https://bcm-pricing-calculator.us-east-1.api.aws

", - "operations": { - "BatchCreateBillScenarioCommitmentModification": "

Create Compute Savings Plans, EC2 Instance Savings Plans, or EC2 Reserved Instances commitments that you want to model in a Bill Scenario.

The BatchCreateBillScenarioCommitmentModification operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission bcm-pricing-calculator:CreateBillScenarioCommitmentModification in your policies.

", - "BatchCreateBillScenarioUsageModification": "

Create Amazon Web Services service usage that you want to model in a Bill Scenario.

The BatchCreateBillScenarioUsageModification operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission bcm-pricing-calculator:CreateBillScenarioUsageModification in your policies.

", - "BatchCreateWorkloadEstimateUsage": "

Create Amazon Web Services service usage that you want to model in a Workload Estimate.

The BatchCreateWorkloadEstimateUsage operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission bcm-pricing-calculator:CreateWorkloadEstimateUsage in your policies.

", - "BatchDeleteBillScenarioCommitmentModification": "

Delete commitment that you have created in a Bill Scenario. You can only delete a commitment that you had added and cannot model deletion (or removal) of a existing commitment. If you want model deletion of an existing commitment, see the negate BillScenarioCommitmentModificationAction of BatchCreateBillScenarioCommitmentModification operation.

The BatchDeleteBillScenarioCommitmentModification operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission bcm-pricing-calculator:DeleteBillScenarioCommitmentModification in your policies.

", - "BatchDeleteBillScenarioUsageModification": "

Delete usage that you have created in a Bill Scenario. You can only delete usage that you had added and cannot model deletion (or removal) of a existing usage. If you want model removal of an existing usage, see BatchUpdateBillScenarioUsageModification.

The BatchDeleteBillScenarioUsageModification operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission bcm-pricing-calculator:DeleteBillScenarioUsageModification in your policies.

", - "BatchDeleteWorkloadEstimateUsage": "

Delete usage that you have created in a Workload estimate. You can only delete usage that you had added and cannot model deletion (or removal) of a existing usage. If you want model removal of an existing usage, see BatchUpdateWorkloadEstimateUsage.

The BatchDeleteWorkloadEstimateUsage operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission bcm-pricing-calculator:DeleteWorkloadEstimateUsage in your policies.

", - "BatchUpdateBillScenarioCommitmentModification": "

Update a newly added or existing commitment. You can update the commitment group based on a commitment ID and a Bill scenario ID.

The BatchUpdateBillScenarioCommitmentModification operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission bcm-pricing-calculator:UpdateBillScenarioCommitmentModification in your policies.

", - "BatchUpdateBillScenarioUsageModification": "

Update a newly added or existing usage lines. You can update the usage amounts, usage hour, and usage group based on a usage ID and a Bill scenario ID.

The BatchUpdateBillScenarioUsageModification operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission bcm-pricing-calculator:UpdateBillScenarioUsageModification in your policies.

", - "BatchUpdateWorkloadEstimateUsage": "

Update a newly added or existing usage lines. You can update the usage amounts and usage group based on a usage ID and a Workload estimate ID.

The BatchUpdateWorkloadEstimateUsage operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission bcm-pricing-calculator:UpdateWorkloadEstimateUsage in your policies.

", - "CreateBillEstimate": "

Create a Bill estimate from a Bill scenario. In the Bill scenario you can model usage addition, usage changes, and usage removal. You can also model commitment addition and commitment removal. After all changes in a Bill scenario is made satisfactorily, you can call this API with a Bill scenario ID to generate the Bill estimate. Bill estimate calculates the pre-tax cost for your consolidated billing family, incorporating all modeled usage and commitments alongside existing usage and commitments from your most recent completed anniversary bill, with any applicable discounts applied.

", - "CreateBillScenario": "

Creates a new bill scenario to model potential changes to Amazon Web Services usage and costs.

", - "CreateWorkloadEstimate": "

Creates a new workload estimate to model costs for a specific workload.

", - "DeleteBillEstimate": "

Deletes an existing bill estimate.

", - "DeleteBillScenario": "

Deletes an existing bill scenario.

", - "DeleteWorkloadEstimate": "

Deletes an existing workload estimate.

", - "GetBillEstimate": "

Retrieves details of a specific bill estimate.

", - "GetBillScenario": "

Retrieves details of a specific bill scenario.

", - "GetPreferences": "

Retrieves the current preferences for Pricing Calculator.

", - "GetWorkloadEstimate": "

Retrieves details of a specific workload estimate.

", - "ListBillEstimateCommitments": "

Lists the commitments associated with a bill estimate.

", - "ListBillEstimateInputCommitmentModifications": "

Lists the input commitment modifications associated with a bill estimate.

", - "ListBillEstimateInputUsageModifications": "

Lists the input usage modifications associated with a bill estimate.

", - "ListBillEstimateLineItems": "

Lists the line items associated with a bill estimate.

", - "ListBillEstimates": "

Lists all bill estimates for the account.

", - "ListBillScenarioCommitmentModifications": "

Lists the commitment modifications associated with a bill scenario.

", - "ListBillScenarioUsageModifications": "

Lists the usage modifications associated with a bill scenario.

", - "ListBillScenarios": "

Lists all bill scenarios for the account.

", - "ListTagsForResource": "

Lists all tags associated with a specified resource.

", - "ListWorkloadEstimateUsage": "

Lists the usage associated with a workload estimate.

", - "ListWorkloadEstimates": "

Lists all workload estimates for the account.

", - "TagResource": "

Adds one or more tags to a specified resource.

", - "UntagResource": "

Removes one or more tags from a specified resource.

", - "UpdateBillEstimate": "

Updates an existing bill estimate.

", - "UpdateBillScenario": "

Updates an existing bill scenario.

", - "UpdatePreferences": "

Updates the preferences for Pricing Calculator.

", - "UpdateWorkloadEstimate": "

Updates an existing workload estimate.

" - }, - "shapes": { - "AccessDeniedException": { - "base": "

You do not have sufficient access to perform this action.

", - "refs": {} - }, - "AccountId": { - "base": null, - "refs": { - "BatchCreateBillScenarioCommitmentModificationEntry$usageAccountId": "

The Amazon Web Services account ID to which this commitment will be applied to.

", - "BatchCreateBillScenarioCommitmentModificationItem$usageAccountId": "

The Amazon Web Services account ID associated with the created commitment modification.

", - "BatchCreateBillScenarioUsageModificationEntry$usageAccountId": "

The Amazon Web Services account ID to which this usage will be applied to.

", - "BatchCreateBillScenarioUsageModificationItem$usageAccountId": "

The Amazon Web Services account ID associated with the created usage modification.

", - "BatchCreateWorkloadEstimateUsageEntry$usageAccountId": "

The Amazon Web Services account ID associated with this usage estimate.

", - "BatchCreateWorkloadEstimateUsageItem$usageAccountId": "

The Amazon Web Services account ID associated with the created usage estimate.

", - "BillEstimateCommitmentSummary$usageAccountId": "

The Amazon Web Services account ID associated with this commitment.

", - "BillEstimateInputCommitmentModificationSummary$usageAccountId": "

The Amazon Web Services account ID associated with this commitment modification.

", - "BillEstimateInputUsageModificationSummary$usageAccountId": "

The Amazon Web Services account ID associated with this usage modification.

", - "BillEstimateLineItemSummary$payerAccountId": "

The Amazon Web Services account ID of the payer for this line item.

", - "BillEstimateLineItemSummary$usageAccountId": "

The Amazon Web Services account ID associated with the usage for this line item.

", - "BillScenarioCommitmentModificationItem$usageAccountId": "

The Amazon Web Services account ID associated with this commitment modification.

", - "BillScenarioUsageModificationItem$usageAccountId": "

The Amazon Web Services account ID associated with this usage modification.

", - "HistoricalUsageEntity$usageAccountId": "

The Amazon Web Services account ID associated with the usage.

", - "WorkloadEstimateUsageItem$usageAccountId": "

The Amazon Web Services account ID associated with this usage item.

" - } - }, - "AddReservedInstanceAction": { - "base": "

Represents an action to add a Reserved Instance to a bill scenario.

", - "refs": { - "BillScenarioCommitmentModificationAction$addReservedInstanceAction": "

Action to add a Reserved Instance to the scenario.

" - } - }, - "AddSavingsPlanAction": { - "base": "

Represents an action to add a Savings Plan to a bill scenario.

", - "refs": { - "BillScenarioCommitmentModificationAction$addSavingsPlanAction": "

Action to add a Savings Plan to the scenario.

" - } - }, - "Arn": { - "base": null, - "refs": { - "ListTagsForResourceRequest$arn": "

The Amazon Resource Name (ARN) of the resource to list tags for.

", - "TagResourceRequest$arn": "

The Amazon Resource Name (ARN) of the resource to add tags to.

", - "UntagResourceRequest$arn": "

The Amazon Resource Name (ARN) of the resource to remove tags from.

" - } - }, - "AvailabilityZone": { - "base": null, - "refs": { - "BatchCreateBillScenarioUsageModificationEntry$availabilityZone": "

The Availability Zone that this usage line uses.

", - "BatchCreateBillScenarioUsageModificationItem$availabilityZone": "

The availability zone associated with this usage modification, if applicable.

", - "BillEstimateInputUsageModificationSummary$availabilityZone": "

The availability zone associated with this usage modification, if applicable.

", - "BillEstimateLineItemSummary$availabilityZone": "

The availability zone associated with this line item, if applicable.

", - "BillScenarioUsageModificationItem$availabilityZone": "

The availability zone associated with this usage modification, if applicable.

" - } - }, - "BatchCreateBillScenarioCommitmentModificationEntries": { - "base": null, - "refs": { - "BatchCreateBillScenarioCommitmentModificationRequest$commitmentModifications": "

List of commitments that you want to model in the Bill Scenario.

" - } - }, - "BatchCreateBillScenarioCommitmentModificationEntry": { - "base": "

Represents an entry object in the batch operation to create bill scenario commitment modifications.

", - "refs": { - "BatchCreateBillScenarioCommitmentModificationEntries$member": null - } - }, - "BatchCreateBillScenarioCommitmentModificationError": { - "base": "

Represents an error that occurred during a batch create operation for bill scenario commitment modifications.

", - "refs": { - "BatchCreateBillScenarioCommitmentModificationErrors$member": null - } - }, - "BatchCreateBillScenarioCommitmentModificationErrorCode": { - "base": null, - "refs": { - "BatchCreateBillScenarioCommitmentModificationError$errorCode": "

The error code associated with the failed operation.

" - } - }, - "BatchCreateBillScenarioCommitmentModificationErrors": { - "base": null, - "refs": { - "BatchCreateBillScenarioCommitmentModificationResponse$errors": "

Returns the list of errors reason and the commitment item keys that cannot be created in the Bill Scenario.

" - } - }, - "BatchCreateBillScenarioCommitmentModificationItem": { - "base": "

Represents a successfully created item in a batch operation for bill scenario commitment modifications.

", - "refs": { - "BatchCreateBillScenarioCommitmentModificationItems$member": null - } - }, - "BatchCreateBillScenarioCommitmentModificationItems": { - "base": null, - "refs": { - "BatchCreateBillScenarioCommitmentModificationResponse$items": "

Returns the list of successful commitment line items that were created for the Bill Scenario.

" - } - }, - "BatchCreateBillScenarioCommitmentModificationRequest": { - "base": null, - "refs": {} - }, - "BatchCreateBillScenarioCommitmentModificationResponse": { - "base": null, - "refs": {} - }, - "BatchCreateBillScenarioUsageModificationEntries": { - "base": null, - "refs": { - "BatchCreateBillScenarioUsageModificationRequest$usageModifications": "

List of usage that you want to model in the Bill Scenario.

" - } - }, - "BatchCreateBillScenarioUsageModificationEntry": { - "base": "

Represents an entry in a batch operation to create bill scenario usage modifications.

", - "refs": { - "BatchCreateBillScenarioUsageModificationEntries$member": null - } - }, - "BatchCreateBillScenarioUsageModificationError": { - "base": "

Represents an error that occurred during a batch create operation for bill scenario usage modifications.

", - "refs": { - "BatchCreateBillScenarioUsageModificationErrors$member": null - } - }, - "BatchCreateBillScenarioUsageModificationErrorCode": { - "base": null, - "refs": { - "BatchCreateBillScenarioUsageModificationError$errorCode": "

The error code associated with the failed operation.

" - } - }, - "BatchCreateBillScenarioUsageModificationErrors": { - "base": null, - "refs": { - "BatchCreateBillScenarioUsageModificationResponse$errors": "

Returns the list of errors reason and the usage item keys that cannot be created in the Bill Scenario.

" - } - }, - "BatchCreateBillScenarioUsageModificationItem": { - "base": "

Represents a successfully created item in a batch operation for bill scenario usage modifications.

", - "refs": { - "BatchCreateBillScenarioUsageModificationItems$member": null - } - }, - "BatchCreateBillScenarioUsageModificationItems": { - "base": null, - "refs": { - "BatchCreateBillScenarioUsageModificationResponse$items": "

Returns the list of successful usage line items that were created for the Bill Scenario.

" - } - }, - "BatchCreateBillScenarioUsageModificationRequest": { - "base": null, - "refs": {} - }, - "BatchCreateBillScenarioUsageModificationResponse": { - "base": null, - "refs": {} - }, - "BatchCreateWorkloadEstimateUsageCode": { - "base": null, - "refs": { - "BatchCreateWorkloadEstimateUsageError$errorCode": "

The error code associated with the failed operation.

" - } - }, - "BatchCreateWorkloadEstimateUsageEntries": { - "base": null, - "refs": { - "BatchCreateWorkloadEstimateUsageRequest$usage": "

List of usage that you want to model in the Workload estimate.

" - } - }, - "BatchCreateWorkloadEstimateUsageEntry": { - "base": "

Represents an entry in a batch operation to create workload estimate usage.

", - "refs": { - "BatchCreateWorkloadEstimateUsageEntries$member": null - } - }, - "BatchCreateWorkloadEstimateUsageError": { - "base": "

Represents an error that occurred during a batch create operation for workload estimate usage.

", - "refs": { - "BatchCreateWorkloadEstimateUsageErrors$member": null - } - }, - "BatchCreateWorkloadEstimateUsageErrors": { - "base": null, - "refs": { - "BatchCreateWorkloadEstimateUsageResponse$errors": "

Returns the list of errors reason and the usage item keys that cannot be created in the Workload estimate.

" - } - }, - "BatchCreateWorkloadEstimateUsageItem": { - "base": "

Represents a successfully created item in a batch operation for workload estimate usage.

", - "refs": { - "BatchCreateWorkloadEstimateUsageItems$member": null - } - }, - "BatchCreateWorkloadEstimateUsageItems": { - "base": null, - "refs": { - "BatchCreateWorkloadEstimateUsageResponse$items": "

Returns the list of successful usage line items that were created for the Workload estimate.

" - } - }, - "BatchCreateWorkloadEstimateUsageRequest": { - "base": null, - "refs": {} - }, - "BatchCreateWorkloadEstimateUsageResponse": { - "base": null, - "refs": {} - }, - "BatchDeleteBillScenarioCommitmentModificationEntries": { - "base": null, - "refs": { - "BatchDeleteBillScenarioCommitmentModificationRequest$ids": "

List of commitments that you want to delete from the Bill Scenario.

" - } - }, - "BatchDeleteBillScenarioCommitmentModificationError": { - "base": "

Represents an error that occurred when deleting a commitment in a Bill Scenario.

", - "refs": { - "BatchDeleteBillScenarioCommitmentModificationErrors$member": null - } - }, - "BatchDeleteBillScenarioCommitmentModificationErrorCode": { - "base": null, - "refs": { - "BatchDeleteBillScenarioCommitmentModificationError$errorCode": "

The code associated with the error.

" - } - }, - "BatchDeleteBillScenarioCommitmentModificationErrors": { - "base": null, - "refs": { - "BatchDeleteBillScenarioCommitmentModificationResponse$errors": "

Returns the list of errors reason and the commitment item keys that cannot be deleted from the Bill Scenario.

" - } - }, - "BatchDeleteBillScenarioCommitmentModificationRequest": { - "base": null, - "refs": {} - }, - "BatchDeleteBillScenarioCommitmentModificationResponse": { - "base": null, - "refs": {} - }, - "BatchDeleteBillScenarioUsageModificationEntries": { - "base": null, - "refs": { - "BatchDeleteBillScenarioUsageModificationRequest$ids": "

List of usage that you want to delete from the Bill Scenario.

" - } - }, - "BatchDeleteBillScenarioUsageModificationError": { - "base": "

Represents an error that occurred when deleting usage in a Bill Scenario.

", - "refs": { - "BatchDeleteBillScenarioUsageModificationErrors$member": null - } - }, - "BatchDeleteBillScenarioUsageModificationErrorCode": { - "base": null, - "refs": { - "BatchDeleteBillScenarioUsageModificationError$errorCode": "

The code associated with the error.

" - } - }, - "BatchDeleteBillScenarioUsageModificationErrors": { - "base": null, - "refs": { - "BatchDeleteBillScenarioUsageModificationResponse$errors": "

Returns the list of errors reason and the usage item keys that cannot be deleted from the Bill Scenario.

" - } - }, - "BatchDeleteBillScenarioUsageModificationRequest": { - "base": null, - "refs": {} - }, - "BatchDeleteBillScenarioUsageModificationResponse": { - "base": null, - "refs": {} - }, - "BatchDeleteWorkloadEstimateUsageEntries": { - "base": null, - "refs": { - "BatchDeleteWorkloadEstimateUsageRequest$ids": "

List of usage that you want to delete from the Workload estimate.

" - } - }, - "BatchDeleteWorkloadEstimateUsageError": { - "base": "

Represents an error that occurred when deleting usage in a workload estimate.

", - "refs": { - "BatchDeleteWorkloadEstimateUsageErrors$member": null - } - }, - "BatchDeleteWorkloadEstimateUsageErrors": { - "base": null, - "refs": { - "BatchDeleteWorkloadEstimateUsageResponse$errors": "

Returns the list of errors reason and the usage item keys that cannot be deleted from the Workload estimate.

" - } - }, - "BatchDeleteWorkloadEstimateUsageRequest": { - "base": null, - "refs": {} - }, - "BatchDeleteWorkloadEstimateUsageResponse": { - "base": null, - "refs": {} - }, - "BatchUpdateBillScenarioCommitmentModificationEntries": { - "base": null, - "refs": { - "BatchUpdateBillScenarioCommitmentModificationRequest$commitmentModifications": "

List of commitments that you want to update in a Bill Scenario.

" - } - }, - "BatchUpdateBillScenarioCommitmentModificationEntry": { - "base": "

Represents an entry in a batch operation to update bill scenario commitment modifications.

", - "refs": { - "BatchUpdateBillScenarioCommitmentModificationEntries$member": null - } - }, - "BatchUpdateBillScenarioCommitmentModificationError": { - "base": "

Represents an error that occurred when updating a commitment in a Bill Scenario.

", - "refs": { - "BatchUpdateBillScenarioCommitmentModificationErrors$member": null - } - }, - "BatchUpdateBillScenarioCommitmentModificationErrorCode": { - "base": null, - "refs": { - "BatchUpdateBillScenarioCommitmentModificationError$errorCode": "

The code associated with the error.

" - } - }, - "BatchUpdateBillScenarioCommitmentModificationErrors": { - "base": null, - "refs": { - "BatchUpdateBillScenarioCommitmentModificationResponse$errors": "

Returns the list of error reasons and commitment line item IDs that could not be updated for the Bill Scenario.

" - } - }, - "BatchUpdateBillScenarioCommitmentModificationRequest": { - "base": null, - "refs": {} - }, - "BatchUpdateBillScenarioCommitmentModificationResponse": { - "base": null, - "refs": {} - }, - "BatchUpdateBillScenarioUsageModificationEntries": { - "base": null, - "refs": { - "BatchUpdateBillScenarioUsageModificationRequest$usageModifications": "

List of usage lines that you want to update in a Bill Scenario identified by the usage ID.

" - } - }, - "BatchUpdateBillScenarioUsageModificationEntry": { - "base": "

Represents an entry in a batch operation to update bill scenario usage modifications.

", - "refs": { - "BatchUpdateBillScenarioUsageModificationEntries$member": null - } - }, - "BatchUpdateBillScenarioUsageModificationError": { - "base": "

Represents an error that occurred when updating usage in a Bill Scenario.

", - "refs": { - "BatchUpdateBillScenarioUsageModificationErrors$member": null - } - }, - "BatchUpdateBillScenarioUsageModificationErrorCode": { - "base": null, - "refs": { - "BatchUpdateBillScenarioUsageModificationError$errorCode": "

The code associated with the error.

" - } - }, - "BatchUpdateBillScenarioUsageModificationErrors": { - "base": null, - "refs": { - "BatchUpdateBillScenarioUsageModificationResponse$errors": "

Returns the list of error reasons and usage line item IDs that could not be updated for the Bill Scenario.

" - } - }, - "BatchUpdateBillScenarioUsageModificationRequest": { - "base": null, - "refs": {} - }, - "BatchUpdateBillScenarioUsageModificationResponse": { - "base": null, - "refs": {} - }, - "BatchUpdateWorkloadEstimateUsageEntries": { - "base": null, - "refs": { - "BatchUpdateWorkloadEstimateUsageRequest$usage": "

List of usage line amounts and usage group that you want to update in a Workload estimate identified by the usage ID.

" - } - }, - "BatchUpdateWorkloadEstimateUsageEntry": { - "base": "

Represents an entry in a batch operation to update workload estimate usage.

", - "refs": { - "BatchUpdateWorkloadEstimateUsageEntries$member": null - } - }, - "BatchUpdateWorkloadEstimateUsageError": { - "base": "

Represents an error that occurred when updating usage in a workload estimate.

", - "refs": { - "BatchUpdateWorkloadEstimateUsageErrors$member": null - } - }, - "BatchUpdateWorkloadEstimateUsageErrors": { - "base": null, - "refs": { - "BatchUpdateWorkloadEstimateUsageResponse$errors": "

Returns the list of error reasons and usage line item IDs that could not be updated for the Workload estimate.

" - } - }, - "BatchUpdateWorkloadEstimateUsageRequest": { - "base": null, - "refs": {} - }, - "BatchUpdateWorkloadEstimateUsageResponse": { - "base": null, - "refs": {} - }, - "BillEstimateCommitmentSummaries": { - "base": null, - "refs": { - "ListBillEstimateCommitmentsResponse$items": "

The list of commitments associated with the bill estimate.

" - } - }, - "BillEstimateCommitmentSummary": { - "base": "

Provides a summary of commitment-related information for a bill estimate.

", - "refs": { - "BillEstimateCommitmentSummaries$member": null - } - }, - "BillEstimateCostSummary": { - "base": "

Provides a summary of cost-related information for a bill estimate.

", - "refs": { - "CreateBillEstimateResponse$costSummary": "

Returns summary-level cost information once a Bill estimate is successfully generated. This summary includes: 1) the total cost difference, showing the pre-tax cost change for the consolidated billing family between the completed anniversary bill and the estimated bill, and 2) total cost differences per service, detailing the pre-tax cost of each service, comparing the completed anniversary bill to the estimated bill on a per-service basis.

", - "GetBillEstimateResponse$costSummary": "

A summary of the estimated costs.

", - "UpdateBillEstimateResponse$costSummary": "

A summary of the updated estimated costs.

" - } - }, - "BillEstimateInputCommitmentModificationSummaries": { - "base": null, - "refs": { - "ListBillEstimateInputCommitmentModificationsResponse$items": "

The list of input commitment modifications associated with the bill estimate.

" - } - }, - "BillEstimateInputCommitmentModificationSummary": { - "base": "

Summarizes an input commitment modification for a bill estimate.

", - "refs": { - "BillEstimateInputCommitmentModificationSummaries$member": null - } - }, - "BillEstimateInputUsageModificationSummaries": { - "base": null, - "refs": { - "ListBillEstimateInputUsageModificationsResponse$items": "

The list of input usage modifications associated with the bill estimate.

" - } - }, - "BillEstimateInputUsageModificationSummary": { - "base": "

Summarizes an input usage modification for a bill estimate.

", - "refs": { - "BillEstimateInputUsageModificationSummaries$member": null - } - }, - "BillEstimateLineItemSummaries": { - "base": null, - "refs": { - "ListBillEstimateLineItemsResponse$items": "

The list of line items associated with the bill estimate.

" - } - }, - "BillEstimateLineItemSummary": { - "base": "

Provides a summary of a line item in a bill estimate.

", - "refs": { - "BillEstimateLineItemSummaries$member": null - } - }, - "BillEstimateName": { - "base": null, - "refs": { - "BillEstimateSummary$name": "

The name of the bill estimate.

", - "CreateBillEstimateRequest$name": "

The name of the Bill estimate that will be created. Names must be unique for an account.

", - "CreateBillEstimateResponse$name": "

The name of your newly created Bill estimate.

", - "GetBillEstimateResponse$name": "

The name of the retrieved bill estimate.

", - "UpdateBillEstimateRequest$name": "

The new name for the bill estimate.

", - "UpdateBillEstimateResponse$name": "

The updated name of the bill estimate.

" - } - }, - "BillEstimateStatus": { - "base": null, - "refs": { - "BillEstimateSummary$status": "

The current status of the bill estimate.

", - "CreateBillEstimateResponse$status": "

The status of your newly created Bill estimate. Bill estimate creation can take anywhere between 8 to 12 hours. The status will allow you to identify when the Bill estimate is complete or has failed.

", - "GetBillEstimateResponse$status": "

The current status of the bill estimate.

", - "UpdateBillEstimateResponse$status": "

The current status of the updated bill estimate.

" - } - }, - "BillEstimateSummaries": { - "base": null, - "refs": { - "ListBillEstimatesResponse$items": "

The list of bill estimates for the account.

" - } - }, - "BillEstimateSummary": { - "base": "

Provides a summary of a bill estimate.

", - "refs": { - "BillEstimateSummaries$member": null - } - }, - "BillInterval": { - "base": "

Represents a time interval for a bill or estimate.

", - "refs": { - "BillEstimateSummary$billInterval": "

The time period covered by the bill estimate.

", - "BillScenarioSummary$billInterval": "

The time period covered by the bill scenario.

", - "CreateBillEstimateResponse$billInterval": "

The bill month start and end timestamp that was used to create the Bill estimate. This is set to the last complete anniversary bill month start and end timestamp.

", - "CreateBillScenarioResponse$billInterval": "

The time period covered by the bill scenario.

", - "GetBillEstimateResponse$billInterval": "

The time period covered by the bill estimate.

", - "GetBillScenarioResponse$billInterval": "

The time period covered by the bill scenario.

", - "HistoricalUsageEntity$billInterval": "

The time interval for the historical usage data.

", - "UpdateBillEstimateResponse$billInterval": "

The time period covered by the updated bill estimate.

", - "UpdateBillScenarioResponse$billInterval": "

The time period covered by the updated bill scenario.

" - } - }, - "BillScenarioCommitmentModificationAction": { - "base": "

Represents an action to modify commitments in a bill scenario.

", - "refs": { - "BatchCreateBillScenarioCommitmentModificationEntry$commitmentAction": "

The specific commitment action to be taken (e.g., adding a Reserved Instance or Savings Plan).

", - "BatchCreateBillScenarioCommitmentModificationItem$commitmentAction": "

The specific commitment action that was taken.

", - "BillEstimateInputCommitmentModificationSummary$commitmentAction": "

The specific commitment action taken in this modification.

", - "BillScenarioCommitmentModificationItem$commitmentAction": "

The specific commitment action taken in this modification.

" - } - }, - "BillScenarioCommitmentModificationItem": { - "base": "

Represents a commitment modification item in a bill scenario.

", - "refs": { - "BillScenarioCommitmentModificationItems$member": null - } - }, - "BillScenarioCommitmentModificationItems": { - "base": null, - "refs": { - "BatchUpdateBillScenarioCommitmentModificationResponse$items": "

Returns the list of successful commitment line items that were updated for a Bill Scenario.

", - "ListBillScenarioCommitmentModificationsResponse$items": "

The list of commitment modifications associated with the bill scenario.

" - } - }, - "BillScenarioName": { - "base": null, - "refs": { - "BillScenarioSummary$name": "

The name of the bill scenario.

", - "CreateBillScenarioRequest$name": "

A descriptive name for the bill scenario.

", - "CreateBillScenarioResponse$name": "

The name of the created bill scenario.

", - "GetBillScenarioResponse$name": "

The name of the retrieved bill scenario.

", - "UpdateBillScenarioRequest$name": "

The new name for the bill scenario.

", - "UpdateBillScenarioResponse$name": "

The updated name of the bill scenario.

" - } - }, - "BillScenarioStatus": { - "base": null, - "refs": { - "BillScenarioSummary$status": "

The current status of the bill scenario.

", - "CreateBillScenarioResponse$status": "

The current status of the bill scenario.

", - "GetBillScenarioResponse$status": "

The current status of the bill scenario.

", - "UpdateBillScenarioResponse$status": "

The current status of the updated bill scenario.

" - } - }, - "BillScenarioSummaries": { - "base": null, - "refs": { - "ListBillScenariosResponse$items": "

The list of bill scenarios for the account.

" - } - }, - "BillScenarioSummary": { - "base": "

Provides a summary of a bill scenario.

", - "refs": { - "BillScenarioSummaries$member": null - } - }, - "BillScenarioUsageModificationItem": { - "base": "

Represents a usage modification item in a bill scenario.

", - "refs": { - "BillScenarioUsageModificationItems$member": null - } - }, - "BillScenarioUsageModificationItems": { - "base": null, - "refs": { - "BatchUpdateBillScenarioUsageModificationResponse$items": "

Returns the list of successful usage line items that were updated for a Bill Scenario.

", - "ListBillScenarioUsageModificationsResponse$items": "

The list of usage modifications associated with the bill scenario.

" - } - }, - "ClientToken": { - "base": null, - "refs": { - "BatchCreateBillScenarioCommitmentModificationRequest$clientToken": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", - "BatchCreateBillScenarioUsageModificationRequest$clientToken": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", - "BatchCreateWorkloadEstimateUsageRequest$clientToken": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", - "CreateBillEstimateRequest$clientToken": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", - "CreateBillScenarioRequest$clientToken": "

A unique, case-sensitive identifier to ensure idempotency of the request.

", - "CreateWorkloadEstimateRequest$clientToken": "

A unique, case-sensitive identifier to ensure idempotency of the request.

" - } - }, - "ConflictException": { - "base": "

The request could not be processed because of conflict in the current state of the resource.

", - "refs": {} - }, - "CostAmount": { - "base": "

Represents a monetary amount with associated currency.

", - "refs": { - "BillEstimateCommitmentSummary$upfrontPayment": "

The upfront payment amount for this commitment, if applicable.

", - "BillEstimateCommitmentSummary$monthlyPayment": "

The monthly payment amount for this commitment, if applicable.

", - "BillEstimateLineItemSummary$estimatedCost": "

The estimated cost for this line item.

", - "BillEstimateLineItemSummary$historicalCost": "

The historical cost for this line item.

", - "CostDifference$historicalCost": "

The historical cost amount.

", - "CostDifference$estimatedCost": "

The estimated cost amount.

" - } - }, - "CostCategoryArn": { - "base": null, - "refs": { - "BillScenarioSummary$costCategoryGroupSharingPreferenceArn": "

The arn of the cost category used in the reserved and prioritized group sharing.

", - "CreateBillEstimateResponse$costCategoryGroupSharingPreferenceArn": "

The arn of the cost category used in the reserved and prioritized group sharing.

", - "CreateBillScenarioRequest$costCategoryGroupSharingPreferenceArn": "

The arn of the cost category used in the reserved and prioritized group sharing.

", - "CreateBillScenarioResponse$costCategoryGroupSharingPreferenceArn": "

The arn of the cost category used in the reserved and prioritized group sharing.

", - "GetBillEstimateResponse$costCategoryGroupSharingPreferenceArn": "

The arn of the cost category used in the reserved and prioritized group sharing.

", - "GetBillScenarioResponse$costCategoryGroupSharingPreferenceArn": "

The arn of the cost category used in the reserved and prioritized group sharing.

", - "UpdateBillEstimateResponse$costCategoryGroupSharingPreferenceArn": "

The arn of the cost category used in the reserved and prioritized group sharing.

", - "UpdateBillScenarioRequest$costCategoryGroupSharingPreferenceArn": "

The arn of the cost category used in the reserved and prioritized group sharing.

", - "UpdateBillScenarioResponse$costCategoryGroupSharingPreferenceArn": "

The arn of the cost category used in the reserved and prioritized group sharing.

" - } - }, - "CostDifference": { - "base": "

Represents the difference between historical and estimated costs.

", - "refs": { - "BillEstimateCostSummary$totalCostDifference": "

The total difference in cost between the estimated and historical costs.

", - "ServiceCostDifferenceMap$value": null - } - }, - "CreateBillEstimateRequest": { - "base": null, - "refs": {} - }, - "CreateBillEstimateResponse": { - "base": null, - "refs": {} - }, - "CreateBillScenarioRequest": { - "base": null, - "refs": {} - }, - "CreateBillScenarioResponse": { - "base": null, - "refs": {} - }, - "CreateWorkloadEstimateRequest": { - "base": null, - "refs": {} - }, - "CreateWorkloadEstimateResponse": { - "base": "

Mixin for common fields returned by CRUD APIs

", - "refs": {} - }, - "CurrencyCode": { - "base": null, - "refs": { - "BatchCreateWorkloadEstimateUsageItem$currency": "

The currency of the estimated cost.

", - "CostAmount$currency": "

The currency code for the cost amount.

", - "CreateWorkloadEstimateResponse$costCurrency": "

The currency of the estimated cost.

", - "GetWorkloadEstimateResponse$costCurrency": "

The currency of the estimated cost.

", - "UpdateWorkloadEstimateResponse$costCurrency": "

The currency of the updated estimated cost.

", - "WorkloadEstimateSummary$costCurrency": "

The currency of the estimated cost.

", - "WorkloadEstimateUsageItem$currency": "

The currency of the estimated cost.

" - } - }, - "DataUnavailableException": { - "base": "

The requested data is currently unavailable.

", - "refs": {} - }, - "DeleteBillEstimateRequest": { - "base": null, - "refs": {} - }, - "DeleteBillEstimateResponse": { - "base": null, - "refs": {} - }, - "DeleteBillScenarioRequest": { - "base": null, - "refs": {} - }, - "DeleteBillScenarioResponse": { - "base": null, - "refs": {} - }, - "DeleteWorkloadEstimateRequest": { - "base": null, - "refs": {} - }, - "DeleteWorkloadEstimateResponse": { - "base": null, - "refs": {} - }, - "Double": { - "base": null, - "refs": { - "BatchCreateWorkloadEstimateUsageEntry$amount": "

The estimated usage amount.

", - "BatchCreateWorkloadEstimateUsageItem$cost": "

The estimated cost associated with this usage.

", - "BatchUpdateWorkloadEstimateUsageEntry$amount": "

The updated estimated usage amount.

", - "CostAmount$amount": "

The numeric value of the cost.

", - "CreateWorkloadEstimateResponse$totalCost": "

The total estimated cost for the workload.

", - "GetWorkloadEstimateResponse$totalCost": "

The total estimated cost for the workload.

", - "UpdateWorkloadEstimateResponse$totalCost": "

The updated total estimated cost for the workload.

", - "UsageAmount$amount": "

The usage amount for the period.

", - "UsageQuantity$amount": "

The numeric value of the usage quantity.

", - "UsageQuantityResult$amount": "

The numeric value of the usage quantity result.

", - "WorkloadEstimateSummary$totalCost": "

The total estimated cost for the workload.

", - "WorkloadEstimateUsageItem$cost": "

The estimated cost for this usage item.

", - "WorkloadEstimateUsageQuantity$amount": "

The numeric value of the usage quantity.

" - } - }, - "Expression": { - "base": "

Represents a complex filtering expression for cost and usage data.

", - "refs": { - "Expression$not": "

An expression to be negated.

", - "ExpressionList$member": null, - "HistoricalUsageEntity$filterExpression": "

An optional filter expression to apply to the historical usage data.

" - } - }, - "ExpressionFilter": { - "base": "

Represents a filter used within an expression.

", - "refs": { - "Expression$costCategories": "

Filters based on cost categories.

", - "Expression$dimensions": "

Filters based on dimensions (e.g., service, operation).

", - "Expression$tags": "

Filters based on resource tags.

" - } - }, - "ExpressionList": { - "base": null, - "refs": { - "Expression$and": "

A list of expressions to be combined with AND logic.

", - "Expression$or": "

A list of expressions to be combined with OR logic.

" - } - }, - "FilterTimestamp": { - "base": "

Represents a time-based filter.

", - "refs": { - "ListBillEstimatesRequest$createdAtFilter": "

Filter bill estimates based on the creation date.

", - "ListBillEstimatesRequest$expiresAtFilter": "

Filter bill estimates based on the expiration date.

", - "ListBillScenariosRequest$createdAtFilter": "

Filter bill scenarios based on the creation date.

", - "ListBillScenariosRequest$expiresAtFilter": "

Filter bill scenarios based on the expiration date.

", - "ListWorkloadEstimatesRequest$createdAtFilter": "

Filter workload estimates based on the creation date.

", - "ListWorkloadEstimatesRequest$expiresAtFilter": "

Filter workload estimates based on the expiration date.

" - } - }, - "GetBillEstimateRequest": { - "base": null, - "refs": {} - }, - "GetBillEstimateResponse": { - "base": null, - "refs": {} - }, - "GetBillScenarioRequest": { - "base": null, - "refs": {} - }, - "GetBillScenarioResponse": { - "base": null, - "refs": {} - }, - "GetPreferencesRequest": { - "base": null, - "refs": {} - }, - "GetPreferencesResponse": { - "base": null, - "refs": {} - }, - "GetWorkloadEstimateRequest": { - "base": null, - "refs": {} - }, - "GetWorkloadEstimateResponse": { - "base": "

Mixin for common fields returned by CRUD APIs

", - "refs": {} - }, - "GroupSharingPreferenceEnum": { - "base": null, - "refs": { - "BillScenarioSummary$groupSharingPreference": "

The setting for the reserved instance and savings plan group sharing used in this estimate.

", - "CreateBillEstimateResponse$groupSharingPreference": "

The setting for the reserved instance and savings plan group sharing used in this estimate.

", - "CreateBillScenarioRequest$groupSharingPreference": "

The setting for the reserved instance and savings plan group sharing used in this estimate.

", - "CreateBillScenarioResponse$groupSharingPreference": "

The setting for the reserved instance and savings plan group sharing used in this estimate.

", - "GetBillEstimateResponse$groupSharingPreference": "

The setting for the reserved instance and savings plan group sharing used in this estimate.

", - "GetBillScenarioResponse$groupSharingPreference": "

The setting for the reserved instance and savings plan group sharing used in this estimate.

", - "UpdateBillEstimateResponse$groupSharingPreference": "

The setting for the reserved instance and savings plan group sharing used in this estimate.

", - "UpdateBillScenarioRequest$groupSharingPreference": "

The setting for the reserved instance and savings plan group sharing used in this estimate.

", - "UpdateBillScenarioResponse$groupSharingPreference": "

The setting for the reserved instance and savings plan group sharing used in this estimate.

" - } - }, - "HistoricalUsageEntity": { - "base": "

Represents historical usage data for a specific entity.

", - "refs": { - "BatchCreateBillScenarioUsageModificationEntry$historicalUsage": "

Historical usage data associated with this modification, if available.

", - "BatchCreateBillScenarioUsageModificationItem$historicalUsage": "

Historical usage data associated with this modification, if available.

", - "BatchCreateWorkloadEstimateUsageEntry$historicalUsage": "

Historical usage data associated with this estimate, if available.

", - "BatchCreateWorkloadEstimateUsageItem$historicalUsage": "

Historical usage data associated with this estimate, if available.

", - "BillEstimateInputUsageModificationSummary$historicalUsage": "

Historical usage data associated with this modification, if available.

", - "BillScenarioUsageModificationItem$historicalUsage": "

Historical usage data associated with this modification, if available.

", - "WorkloadEstimateUsageItem$historicalUsage": "

Historical usage data associated with this item, if available.

" - } - }, - "Integer": { - "base": null, - "refs": { - "InternalServerException$retryAfterSeconds": "

An internal error has occurred. Retry your request, but if the problem persists, contact Amazon Web Services support.

", - "ThrottlingException$retryAfterSeconds": "

The service code that exceeded the throttling limit. Retry your request, but if the problem persists, contact Amazon Web Services support.

" - } - }, - "InternalServerException": { - "base": "

An internal error has occurred. Retry your request, but if the problem persists, contact Amazon Web Services support.

", - "refs": {} - }, - "Key": { - "base": null, - "refs": { - "BatchCreateBillScenarioCommitmentModificationEntry$key": "

A unique identifier for this entry in the batch operation. This can be any valid string. This key is useful to identify errors associated with any commitment entry as any error is returned with this key.

", - "BatchCreateBillScenarioCommitmentModificationError$key": "

The key of the entry that caused the error.

", - "BatchCreateBillScenarioCommitmentModificationItem$key": "

The key of the successfully created entry. This can be any valid string. This key is useful to identify errors associated with any commitment entry as any error is returned with this key.

", - "BatchCreateBillScenarioUsageModificationEntry$key": "

A unique identifier for this entry in the batch operation. This can be any valid string. This key is useful to identify errors associated with any usage entry as any error is returned with this key.

", - "BatchCreateBillScenarioUsageModificationError$key": "

The key of the entry that caused the error.

", - "BatchCreateBillScenarioUsageModificationItem$key": "

The key of the successfully created entry.

", - "BatchCreateWorkloadEstimateUsageEntry$key": "

A unique identifier for this entry in the batch operation.

", - "BatchCreateWorkloadEstimateUsageError$key": "

The key of the entry that caused the error.

", - "BatchCreateWorkloadEstimateUsageItem$key": "

The key of the successfully created entry.

" - } - }, - "ListBillEstimateCommitmentsRequest": { - "base": null, - "refs": {} - }, - "ListBillEstimateCommitmentsResponse": { - "base": null, - "refs": {} - }, - "ListBillEstimateInputCommitmentModificationsRequest": { - "base": null, - "refs": {} - }, - "ListBillEstimateInputCommitmentModificationsResponse": { - "base": null, - "refs": {} - }, - "ListBillEstimateInputUsageModificationsRequest": { - "base": null, - "refs": {} - }, - "ListBillEstimateInputUsageModificationsResponse": { - "base": null, - "refs": {} - }, - "ListBillEstimateLineItemsFilter": { - "base": "

Represents a filter for listing bill estimate line items.

", - "refs": { - "ListBillEstimateLineItemsFilters$member": null - } - }, - "ListBillEstimateLineItemsFilterName": { - "base": null, - "refs": { - "ListBillEstimateLineItemsFilter$name": "

The name of the filter attribute.

" - } - }, - "ListBillEstimateLineItemsFilterValues": { - "base": null, - "refs": { - "ListBillEstimateLineItemsFilter$values": "

The values to filter by.

" - } - }, - "ListBillEstimateLineItemsFilters": { - "base": null, - "refs": { - "ListBillEstimateLineItemsRequest$filters": "

Filters to apply to the list of line items.

" - } - }, - "ListBillEstimateLineItemsRequest": { - "base": null, - "refs": {} - }, - "ListBillEstimateLineItemsResponse": { - "base": null, - "refs": {} - }, - "ListBillEstimatesFilter": { - "base": "

Represents a filter for listing bill estimates.

", - "refs": { - "ListBillEstimatesFilters$member": null - } - }, - "ListBillEstimatesFilterName": { - "base": null, - "refs": { - "ListBillEstimatesFilter$name": "

The name of the filter attribute.

" - } - }, - "ListBillEstimatesFilterValues": { - "base": null, - "refs": { - "ListBillEstimatesFilter$values": "

The values to filter by.

" - } - }, - "ListBillEstimatesFilters": { - "base": null, - "refs": { - "ListBillEstimatesRequest$filters": "

Filters to apply to the list of bill estimates.

" - } - }, - "ListBillEstimatesRequest": { - "base": null, - "refs": {} - }, - "ListBillEstimatesResponse": { - "base": null, - "refs": {} - }, - "ListBillScenarioCommitmentModificationsRequest": { - "base": null, - "refs": {} - }, - "ListBillScenarioCommitmentModificationsResponse": { - "base": null, - "refs": {} - }, - "ListBillScenarioUsageModificationsRequest": { - "base": null, - "refs": {} - }, - "ListBillScenarioUsageModificationsResponse": { - "base": null, - "refs": {} - }, - "ListBillScenariosFilter": { - "base": "

Represents a filter for listing bill scenarios.

", - "refs": { - "ListBillScenariosFilters$member": null - } - }, - "ListBillScenariosFilterName": { - "base": null, - "refs": { - "ListBillScenariosFilter$name": "

The name of the filter attribute.

" - } - }, - "ListBillScenariosFilterValues": { - "base": null, - "refs": { - "ListBillScenariosFilter$values": "

The values to filter by.

" - } - }, - "ListBillScenariosFilters": { - "base": null, - "refs": { - "ListBillScenariosRequest$filters": "

Filters to apply to the list of bill scenarios.

" - } - }, - "ListBillScenariosRequest": { - "base": null, - "refs": {} - }, - "ListBillScenariosResponse": { - "base": null, - "refs": {} - }, - "ListTagsForResourceRequest": { - "base": null, - "refs": {} - }, - "ListTagsForResourceResponse": { - "base": null, - "refs": {} - }, - "ListUsageFilter": { - "base": "

Represents a filter for listing usage data.

", - "refs": { - "ListUsageFilters$member": null - } - }, - "ListUsageFilterName": { - "base": null, - "refs": { - "ListUsageFilter$name": "

The name of the filter attribute.

" - } - }, - "ListUsageFilterValues": { - "base": null, - "refs": { - "ListUsageFilter$values": "

The values to filter by.

" - } - }, - "ListUsageFilters": { - "base": null, - "refs": { - "ListBillEstimateInputUsageModificationsRequest$filters": "

Filters to apply to the list of input usage modifications.

", - "ListBillScenarioUsageModificationsRequest$filters": "

Filters to apply to the list of usage modifications.

", - "ListWorkloadEstimateUsageRequest$filters": "

Filters to apply to the list of usage items.

" - } - }, - "ListWorkloadEstimateUsageRequest": { - "base": null, - "refs": {} - }, - "ListWorkloadEstimateUsageResponse": { - "base": null, - "refs": {} - }, - "ListWorkloadEstimatesFilter": { - "base": "

Represents a filter for listing workload estimates.

", - "refs": { - "ListWorkloadEstimatesFilters$member": null - } - }, - "ListWorkloadEstimatesFilterName": { - "base": null, - "refs": { - "ListWorkloadEstimatesFilter$name": "

The name of the filter attribute.

" - } - }, - "ListWorkloadEstimatesFilterValues": { - "base": null, - "refs": { - "ListWorkloadEstimatesFilter$values": "

The values to filter by.

" - } - }, - "ListWorkloadEstimatesFilters": { - "base": null, - "refs": { - "ListWorkloadEstimatesRequest$filters": "

Filters to apply to the list of workload estimates.

" - } - }, - "ListWorkloadEstimatesRequest": { - "base": null, - "refs": {} - }, - "ListWorkloadEstimatesResponse": { - "base": null, - "refs": {} - }, - "MatchOption": { - "base": null, - "refs": { - "ListBillEstimateLineItemsFilter$matchOption": "

The match option for the filter (e.g., equals, contains).

", - "ListBillEstimatesFilter$matchOption": "

The match option for the filter (e.g., equals, contains).

", - "ListBillScenariosFilter$matchOption": "

The match option for the filter (e.g., equals, contains).

", - "ListUsageFilter$matchOption": "

The match option for the filter (e.g., equals, contains).

", - "ListWorkloadEstimatesFilter$matchOption": "

The match option for the filter (e.g., equals, contains).

" - } - }, - "MaxResults": { - "base": null, - "refs": { - "ListBillEstimateCommitmentsRequest$maxResults": "

The maximum number of results to return per page.

", - "ListBillEstimateInputCommitmentModificationsRequest$maxResults": "

The maximum number of results to return per page.

", - "ListBillEstimateInputUsageModificationsRequest$maxResults": "

The maximum number of results to return per page.

", - "ListBillEstimateLineItemsRequest$maxResults": "

The maximum number of results to return per page.

", - "ListBillEstimatesRequest$maxResults": "

The maximum number of results to return per page.

", - "ListBillScenarioCommitmentModificationsRequest$maxResults": "

The maximum number of results to return per page.

", - "ListBillScenarioUsageModificationsRequest$maxResults": "

The maximum number of results to return per page.

", - "ListBillScenariosRequest$maxResults": "

The maximum number of results to return per page.

", - "ListWorkloadEstimatesRequest$maxResults": "

The maximum number of results to return per page.

" - } - }, - "NegateReservedInstanceAction": { - "base": "

Represents an action to remove a Reserved Instance from a bill scenario.

This is the ID of an existing Reserved Instance in your account.

", - "refs": { - "BillScenarioCommitmentModificationAction$negateReservedInstanceAction": "

Action to remove a Reserved Instance from the scenario.

" - } - }, - "NegateSavingsPlanAction": { - "base": "

Represents an action to remove a Savings Plan from a bill scenario.

This is the ID of an existing Savings Plan in your account.

", - "refs": { - "BillScenarioCommitmentModificationAction$negateSavingsPlanAction": "

Action to remove a Savings Plan from the scenario.

" - } - }, - "NextPageToken": { - "base": null, - "refs": { - "ListBillEstimateCommitmentsRequest$nextToken": "

A token to retrieve the next page of results.

", - "ListBillEstimateCommitmentsResponse$nextToken": "

A token to retrieve the next page of results, if any.

", - "ListBillEstimateInputCommitmentModificationsRequest$nextToken": "

A token to retrieve the next page of results.

", - "ListBillEstimateInputCommitmentModificationsResponse$nextToken": "

A token to retrieve the next page of results, if any.

", - "ListBillEstimateInputUsageModificationsRequest$nextToken": "

A token to retrieve the next page of results.

", - "ListBillEstimateInputUsageModificationsResponse$nextToken": "

A token to retrieve the next page of results, if any.

", - "ListBillEstimateLineItemsRequest$nextToken": "

A token to retrieve the next page of results.

", - "ListBillEstimateLineItemsResponse$nextToken": "

A token to retrieve the next page of results, if any.

", - "ListBillEstimatesRequest$nextToken": "

A token to retrieve the next page of results.

", - "ListBillEstimatesResponse$nextToken": "

A token to retrieve the next page of results, if any.

", - "ListBillScenarioCommitmentModificationsRequest$nextToken": "

A token to retrieve the next page of results.

", - "ListBillScenarioCommitmentModificationsResponse$nextToken": "

A token to retrieve the next page of results, if any.

", - "ListBillScenarioUsageModificationsRequest$nextToken": "

A token to retrieve the next page of results.

", - "ListBillScenarioUsageModificationsResponse$nextToken": "

A token to retrieve the next page of results, if any.

", - "ListBillScenariosRequest$nextToken": "

A token to retrieve the next page of results.

", - "ListBillScenariosResponse$nextToken": "

A token to retrieve the next page of results, if any.

", - "ListWorkloadEstimateUsageRequest$nextToken": "

A token to retrieve the next page of results.

", - "ListWorkloadEstimateUsageResponse$nextToken": "

A token to retrieve the next page of results, if any.

", - "ListWorkloadEstimatesRequest$nextToken": "

A token to retrieve the next page of results.

", - "ListWorkloadEstimatesResponse$nextToken": "

A token to retrieve the next page of results, if any.

" - } - }, - "Operation": { - "base": null, - "refs": { - "BatchCreateBillScenarioUsageModificationEntry$operation": "

The specific operation associated with this usage modification. Describes the specific Amazon Web Services operation that this usage line models. For example, RunInstances indicates the operation of an Amazon EC2 instance.

", - "BatchCreateBillScenarioUsageModificationItem$operation": "

The specific operation associated with this usage modification.

", - "BatchCreateWorkloadEstimateUsageEntry$operation": "

The specific operation associated with this usage estimate.

", - "BatchCreateWorkloadEstimateUsageItem$operation": "

The specific operation associated with this usage estimate.

", - "BillEstimateInputUsageModificationSummary$operation": "

The specific operation associated with this usage modification.

", - "BillEstimateLineItemSummary$operation": "

The specific operation associated with this line item.

", - "BillScenarioUsageModificationItem$operation": "

The specific operation associated with this usage modification.

", - "HistoricalUsageEntity$operation": "

The specific operation associated with the usage.

", - "WorkloadEstimateUsageItem$operation": "

The specific operation associated with this usage item.

" - } - }, - "PurchaseAgreementType": { - "base": null, - "refs": { - "BillEstimateCommitmentSummary$purchaseAgreementType": "

The type of purchase agreement (e.g., Reserved Instance, Savings Plan).

" - } - }, - "RateType": { - "base": null, - "refs": { - "RateTypes$member": null - } - }, - "RateTypes": { - "base": null, - "refs": { - "GetPreferencesResponse$managementAccountRateTypeSelections": "

The preferred rate types for the management account.

", - "GetPreferencesResponse$memberAccountRateTypeSelections": "

The preferred rate types for member accounts.

", - "GetPreferencesResponse$standaloneAccountRateTypeSelections": "

The preferred rate types for a standalone account.

", - "UpdatePreferencesRequest$managementAccountRateTypeSelections": "

The updated preferred rate types for the management account.

", - "UpdatePreferencesRequest$memberAccountRateTypeSelections": "

The updated preferred rate types for member accounts.

", - "UpdatePreferencesRequest$standaloneAccountRateTypeSelections": "

The updated preferred rate types for a standalone account.

", - "UpdatePreferencesResponse$managementAccountRateTypeSelections": "

The updated preferred rate types for the management account.

", - "UpdatePreferencesResponse$memberAccountRateTypeSelections": "

The updated preferred rate types for member accounts.

", - "UpdatePreferencesResponse$standaloneAccountRateTypeSelections": "

The updated preferred rate types for a standalone account.

" - } - }, - "ReservedInstanceInstanceCount": { - "base": null, - "refs": { - "AddReservedInstanceAction$instanceCount": "

The number of instances to add for this Reserved Instance offering.

" - } - }, - "ResourceId": { - "base": null, - "refs": { - "BatchCreateBillScenarioCommitmentModificationItem$id": "

The unique identifier assigned to the created commitment modification.

", - "BatchCreateBillScenarioCommitmentModificationRequest$billScenarioId": "

The ID of the Bill Scenario for which you want to create the modeled commitment.

", - "BatchCreateBillScenarioUsageModificationItem$id": "

The unique identifier assigned to the created usage modification.

", - "BatchCreateBillScenarioUsageModificationRequest$billScenarioId": "

The ID of the Bill Scenario for which you want to create the modeled usage.

", - "BatchCreateWorkloadEstimateUsageItem$id": "

The unique identifier assigned to the created usage estimate.

", - "BatchCreateWorkloadEstimateUsageRequest$workloadEstimateId": "

The ID of the Workload estimate for which you want to create the modeled usage.

", - "BatchDeleteBillScenarioCommitmentModificationEntries$member": null, - "BatchDeleteBillScenarioCommitmentModificationError$id": "

The ID of the error.

", - "BatchDeleteBillScenarioCommitmentModificationRequest$billScenarioId": "

The ID of the Bill Scenario for which you want to delete the modeled commitment.

", - "BatchDeleteBillScenarioUsageModificationEntries$member": null, - "BatchDeleteBillScenarioUsageModificationError$id": "

The ID of the error.

", - "BatchDeleteBillScenarioUsageModificationRequest$billScenarioId": "

The ID of the Bill Scenario for which you want to delete the modeled usage.

", - "BatchDeleteWorkloadEstimateUsageEntries$member": null, - "BatchDeleteWorkloadEstimateUsageError$id": "

The ID of the error.

", - "BatchDeleteWorkloadEstimateUsageRequest$workloadEstimateId": "

The ID of the Workload estimate for which you want to delete the modeled usage.

", - "BatchUpdateBillScenarioCommitmentModificationEntry$id": "

The unique identifier of the commitment modification to update.

", - "BatchUpdateBillScenarioCommitmentModificationError$id": "

The ID of the error.

", - "BatchUpdateBillScenarioCommitmentModificationRequest$billScenarioId": "

The ID of the Bill Scenario for which you want to modify the commitment group of a modeled commitment.

", - "BatchUpdateBillScenarioUsageModificationEntry$id": "

The unique identifier of the usage modification to update.

", - "BatchUpdateBillScenarioUsageModificationError$id": "

The ID of the error.

", - "BatchUpdateBillScenarioUsageModificationRequest$billScenarioId": "

The ID of the Bill Scenario for which you want to modify the usage lines.

", - "BatchUpdateWorkloadEstimateUsageEntry$id": "

The unique identifier of the usage estimate to update.

", - "BatchUpdateWorkloadEstimateUsageError$id": "

The ID of the error.

", - "BatchUpdateWorkloadEstimateUsageRequest$workloadEstimateId": "

The ID of the Workload estimate for which you want to modify the usage lines.

", - "BillEstimateCommitmentSummary$id": "

The unique identifier of the commitment.

", - "BillEstimateInputCommitmentModificationSummary$id": "

The unique identifier of the commitment modification.

", - "BillEstimateInputUsageModificationSummary$id": "

The unique identifier of the usage modification.

", - "BillEstimateLineItemSummary$id": "

The unique identifier of this line item.

", - "BillEstimateSummary$id": "

The unique identifier of the bill estimate.

", - "BillScenarioCommitmentModificationItem$id": "

The unique identifier of the commitment modification.

", - "BillScenarioSummary$id": "

The unique identifier of the bill scenario.

", - "BillScenarioUsageModificationItem$id": "

The unique identifier of the usage modification.

", - "CreateBillEstimateRequest$billScenarioId": "

The ID of the Bill Scenario for which you want to create a Bill estimate.

", - "CreateBillEstimateResponse$id": "

The unique identifier of your newly created Bill estimate.

", - "CreateBillScenarioResponse$id": "

The unique identifier for the created bill scenario.

", - "CreateWorkloadEstimateResponse$id": "

The unique identifier for the created workload estimate.

", - "DeleteBillEstimateRequest$identifier": "

The unique identifier of the bill estimate to delete.

", - "DeleteBillScenarioRequest$identifier": "

The unique identifier of the bill scenario to delete.

", - "DeleteWorkloadEstimateRequest$identifier": "

The unique identifier of the workload estimate to delete.

", - "GetBillEstimateRequest$identifier": "

The unique identifier of the bill estimate to retrieve.

", - "GetBillEstimateResponse$id": "

The unique identifier of the retrieved bill estimate.

", - "GetBillScenarioRequest$identifier": "

The unique identifier of the bill scenario to retrieve.

", - "GetBillScenarioResponse$id": "

The unique identifier of the retrieved bill scenario.

", - "GetWorkloadEstimateRequest$identifier": "

The unique identifier of the workload estimate to retrieve.

", - "GetWorkloadEstimateResponse$id": "

The unique identifier of the retrieved workload estimate.

", - "ListBillEstimateCommitmentsRequest$billEstimateId": "

The unique identifier of the bill estimate to list commitments for.

", - "ListBillEstimateInputCommitmentModificationsRequest$billEstimateId": "

The unique identifier of the bill estimate to list input commitment modifications for.

", - "ListBillEstimateInputUsageModificationsRequest$billEstimateId": "

The unique identifier of the bill estimate to list input usage modifications for.

", - "ListBillEstimateLineItemsRequest$billEstimateId": "

The unique identifier of the bill estimate to list line items for.

", - "ListBillScenarioCommitmentModificationsRequest$billScenarioId": "

The unique identifier of the bill scenario to list commitment modifications for.

", - "ListBillScenarioUsageModificationsRequest$billScenarioId": "

The unique identifier of the bill scenario to list usage modifications for.

", - "ListWorkloadEstimateUsageRequest$workloadEstimateId": "

The unique identifier of the workload estimate to list usage for.

", - "UpdateBillEstimateRequest$identifier": "

The unique identifier of the bill estimate to update.

", - "UpdateBillEstimateResponse$id": "

The unique identifier of the updated bill estimate.

", - "UpdateBillScenarioRequest$identifier": "

The unique identifier of the bill scenario to update.

", - "UpdateBillScenarioResponse$id": "

The unique identifier of the updated bill scenario.

", - "UpdateWorkloadEstimateRequest$identifier": "

The unique identifier of the workload estimate to update.

", - "UpdateWorkloadEstimateResponse$id": "

The unique identifier of the updated workload estimate.

", - "WorkloadEstimateSummary$id": "

The unique identifier of the workload estimate.

", - "WorkloadEstimateUsageItem$id": "

The unique identifier of this usage item.

" - } - }, - "ResourceNotFoundException": { - "base": "

The specified resource was not found.

", - "refs": {} - }, - "ResourceTagKey": { - "base": null, - "refs": { - "ResourceTagKeys$member": null, - "Tags$key": null - } - }, - "ResourceTagKeys": { - "base": null, - "refs": { - "UntagResourceRequest$tagKeys": "

The keys of the tags to remove from the resource.

" - } - }, - "ResourceTagValue": { - "base": null, - "refs": { - "Tags$value": null - } - }, - "SavingsPlanArns": { - "base": null, - "refs": { - "BillEstimateLineItemSummary$savingsPlanArns": "

The Amazon Resource Names (ARNs) of any Savings Plans applied to this line item.

" - } - }, - "SavingsPlanCommitment": { - "base": null, - "refs": { - "AddSavingsPlanAction$commitment": "

The hourly commitment, in the same currency of the savingsPlanOfferingId. This is a value between 0.001 and 1 million. You cannot specify more than five digits after the decimal point.

" - } - }, - "ServiceCode": { - "base": null, - "refs": { - "BatchCreateBillScenarioUsageModificationEntry$serviceCode": "

The Amazon Web Services service code for this usage modification. This identifies the specific Amazon Web Services service to the customer as a unique short abbreviation. For example, AmazonEC2 and AWSKMS.

", - "BatchCreateBillScenarioUsageModificationItem$serviceCode": "

The Amazon Web Services service code for this usage modification.

", - "BatchCreateWorkloadEstimateUsageEntry$serviceCode": "

The Amazon Web Services service code for this usage estimate.

", - "BatchCreateWorkloadEstimateUsageItem$serviceCode": "

The Amazon Web Services service code for this usage estimate.

", - "BillEstimateInputUsageModificationSummary$serviceCode": "

The Amazon Web Services service code for this usage modification.

", - "BillEstimateLineItemSummary$serviceCode": "

The Amazon Web Services service code associated with this line item.

", - "BillScenarioUsageModificationItem$serviceCode": "

The Amazon Web Services service code for this usage modification.

", - "HistoricalUsageEntity$serviceCode": "

The Amazon Web Services service code associated with the usage.

", - "WorkloadEstimateUsageItem$serviceCode": "

The Amazon Web Services service code associated with this usage item.

" - } - }, - "ServiceCostDifferenceMap": { - "base": null, - "refs": { - "BillEstimateCostSummary$serviceCostDifferences": "

A breakdown of cost differences by Amazon Web Services service.

" - } - }, - "ServiceQuotaExceededException": { - "base": "

The request would cause you to exceed your service quota.

", - "refs": {} - }, - "String": { - "base": null, - "refs": { - "AccessDeniedException$message": null, - "BatchCreateBillScenarioCommitmentModificationError$errorMessage": "

A descriptive message for the error that occurred.

", - "BatchCreateBillScenarioUsageModificationError$errorMessage": "

A descriptive message for the error that occurred.

", - "BatchCreateBillScenarioUsageModificationItem$location": "

The location associated with this usage modification.

", - "BatchCreateWorkloadEstimateUsageError$errorMessage": "

A descriptive message for the error that occurred.

", - "BatchCreateWorkloadEstimateUsageItem$location": "

The location associated with this usage estimate.

", - "BatchDeleteBillScenarioCommitmentModificationError$errorMessage": "

The message that describes the error.

", - "BatchDeleteBillScenarioUsageModificationError$errorMessage": "

The message that describes the error.

", - "BatchDeleteWorkloadEstimateUsageError$errorMessage": "

The message that describes the error.

", - "BatchUpdateBillScenarioCommitmentModificationError$errorMessage": "

The message that describes the error.

", - "BatchUpdateBillScenarioUsageModificationError$errorMessage": "

The message that describes the error.

", - "BatchUpdateWorkloadEstimateUsageError$errorMessage": "

The message that describes the error.

", - "BillEstimateCommitmentSummary$region": "

The Amazon Web Services region associated with this commitment.

", - "BillEstimateCommitmentSummary$termLength": "

The length of the commitment term.

", - "BillEstimateCommitmentSummary$paymentOption": "

The payment option chosen for this commitment (e.g., All Upfront, Partial Upfront, No Upfront).

", - "BillEstimateInputUsageModificationSummary$location": "

The location associated with this usage modification.

", - "BillEstimateLineItemSummary$location": "

The location associated with this line item.

", - "BillEstimateLineItemSummary$lineItemId": "

The line item identifier from the original bill.

", - "BillEstimateLineItemSummary$lineItemType": "

The type of this line item (e.g., Usage, Tax, Credit).

", - "BillScenarioSummary$failureMessage": "

An error message if the bill scenario creation or processing failed.

", - "BillScenarioUsageModificationItem$location": "

The location associated with this usage modification.

", - "ConflictException$message": null, - "ConflictException$resourceId": "

The identifier of the resource that was not found.

", - "ConflictException$resourceType": "

The type of the resource that was not found.

", - "CreateBillEstimateResponse$failureMessage": "

This attribute provides the reason if a Bill estimate result generation fails.

", - "CreateBillScenarioResponse$failureMessage": "

An error message if the bill scenario creation failed.

", - "CreateWorkloadEstimateResponse$failureMessage": "

An error message if the workload estimate creation failed.

", - "DataUnavailableException$message": null, - "ExpressionFilter$key": "

The key or attribute to filter on.

", - "GetBillEstimateResponse$failureMessage": "

An error message if the bill estimate retrieval failed.

", - "GetBillScenarioResponse$failureMessage": "

An error message if the bill scenario retrieval failed.

", - "GetWorkloadEstimateResponse$failureMessage": "

An error message if the workload estimate retrieval failed.

", - "HistoricalUsageEntity$location": "

The location associated with the usage.

", - "InternalServerException$message": null, - "ListBillEstimateLineItemsFilterValues$member": null, - "ListBillEstimatesFilterValues$member": null, - "ListBillScenariosFilterValues$member": null, - "ListUsageFilterValues$member": null, - "ListWorkloadEstimatesFilterValues$member": null, - "ResourceNotFoundException$message": null, - "ResourceNotFoundException$resourceId": "

The identifier of the resource that was not found.

", - "ResourceNotFoundException$resourceType": "

The type of the resource that was not found.

", - "SavingsPlanArns$member": null, - "ServiceCostDifferenceMap$key": null, - "ServiceQuotaExceededException$message": null, - "ServiceQuotaExceededException$resourceId": "

The identifier of the resource that exceeded quota.

", - "ServiceQuotaExceededException$resourceType": "

The type of the resource that exceeded quota.

", - "ServiceQuotaExceededException$serviceCode": "

The service code that exceeded quota.

", - "ServiceQuotaExceededException$quotaCode": "

The quota code that was exceeded.

", - "StringList$member": null, - "ThrottlingException$message": null, - "ThrottlingException$serviceCode": "

The service code that exceeded the throttling limit.

", - "ThrottlingException$quotaCode": "

The quota code that exceeded the throttling limit.

", - "UpdateBillEstimateResponse$failureMessage": "

An error message if the bill estimate update failed.

", - "UpdateBillScenarioResponse$failureMessage": "

An error message if the bill scenario update failed.

", - "UpdateWorkloadEstimateResponse$failureMessage": "

An error message if the workload estimate update failed.

", - "UsageQuantity$unit": "

The unit of measurement for the usage quantity.

", - "UsageQuantityResult$unit": "

The unit of measurement for the usage quantity result.

", - "ValidationException$message": null, - "ValidationExceptionField$name": "

The name of the field that failed validation.

", - "ValidationExceptionField$message": "

The error message describing why the field failed validation.

", - "WorkloadEstimateSummary$failureMessage": "

An error message if the workload estimate creation or processing failed.

", - "WorkloadEstimateUsageItem$location": "

The location associated with this usage item.

", - "WorkloadEstimateUsageQuantity$unit": "

The unit of measurement for the usage quantity.

" - } - }, - "StringList": { - "base": null, - "refs": { - "ExpressionFilter$matchOptions": "

The match options for the filter (e.g., equals, contains).

", - "ExpressionFilter$values": "

The values to match against.

" - } - }, - "TagResourceRequest": { - "base": null, - "refs": {} - }, - "TagResourceResponse": { - "base": null, - "refs": {} - }, - "Tags": { - "base": null, - "refs": { - "CreateBillEstimateRequest$tags": "

An optional list of tags to associate with the specified BillEstimate. You can use resource tags to control access to your BillEstimate using IAM policies. Each tag consists of a key and a value, and each key must be unique for the resource. The following restrictions apply to resource tags:

  • Although the maximum number of array members is 200, you can assign a maximum of 50 user-tags to one resource. The remaining are reserved for Amazon Web Services.

  • The maximum length of a key is 128 characters.

  • The maximum length of a value is 256 characters.

  • Keys and values can only contain alphanumeric characters, spaces, and any of the following: _.:/=+@-.

  • Keys and values are case sensitive.

  • Keys and values are trimmed for any leading or trailing whitespaces.

  • Don't use aws: as a prefix for your keys. This prefix is reserved for Amazon Web Services.

", - "CreateBillScenarioRequest$tags": "

The tags to apply to the bill scenario.

", - "CreateWorkloadEstimateRequest$tags": "

The tags to apply to the workload estimate.

", - "ListTagsForResourceResponse$tags": "

The list of tags associated with the specified resource.

", - "TagResourceRequest$tags": "

The tags to add to the resource.

" - } - }, - "ThrottlingException": { - "base": "

The request was denied due to request throttling.

", - "refs": {} - }, - "Timestamp": { - "base": null, - "refs": { - "BillEstimateSummary$createdAt": "

The timestamp when the bill estimate was created.

", - "BillEstimateSummary$expiresAt": "

The timestamp when the bill estimate will expire.

", - "BillInterval$start": "

The start date and time of the interval.

", - "BillInterval$end": "

The end date and time of the interval.

", - "BillScenarioSummary$createdAt": "

The timestamp when the bill scenario was created.

", - "BillScenarioSummary$expiresAt": "

The timestamp when the bill scenario will expire.

", - "CreateBillEstimateResponse$createdAt": "

The timestamp of when the Bill estimate create process was started (not when it successfully completed or failed).

", - "CreateBillEstimateResponse$expiresAt": "

The timestamp of when the Bill estimate will expire. A Bill estimate becomes inaccessible after expiration.

", - "CreateBillEstimateResponse$costCategoryGroupSharingPreferenceEffectiveDate": "

Timestamp of the effective date of the cost category used in the group sharing settings.

", - "CreateBillScenarioResponse$createdAt": "

The timestamp when the bill scenario was created.

", - "CreateBillScenarioResponse$expiresAt": "

The timestamp when the bill scenario will expire.

", - "CreateWorkloadEstimateResponse$createdAt": "

The timestamp when the workload estimate was created.

", - "CreateWorkloadEstimateResponse$expiresAt": "

The timestamp when the workload estimate will expire.

", - "CreateWorkloadEstimateResponse$rateTimestamp": "

The timestamp of the pricing rates used for the estimate.

", - "FilterTimestamp$afterTimestamp": "

Include results after this timestamp.

", - "FilterTimestamp$beforeTimestamp": "

Include results before this timestamp.

", - "GetBillEstimateResponse$createdAt": "

The timestamp when the bill estimate was created.

", - "GetBillEstimateResponse$expiresAt": "

The timestamp when the bill estimate will expire.

", - "GetBillEstimateResponse$costCategoryGroupSharingPreferenceEffectiveDate": "

Timestamp of the effective date of the cost category used in the group sharing settings.

", - "GetBillScenarioResponse$createdAt": "

The timestamp when the bill scenario was created.

", - "GetBillScenarioResponse$expiresAt": "

The timestamp when the bill scenario will expire.

", - "GetWorkloadEstimateResponse$createdAt": "

The timestamp when the workload estimate was created.

", - "GetWorkloadEstimateResponse$expiresAt": "

The timestamp when the workload estimate will expire.

", - "GetWorkloadEstimateResponse$rateTimestamp": "

The timestamp of the pricing rates used for the estimate.

", - "UpdateBillEstimateRequest$expiresAt": "

The new expiration date for the bill estimate.

", - "UpdateBillEstimateResponse$createdAt": "

The timestamp when the bill estimate was originally created.

", - "UpdateBillEstimateResponse$expiresAt": "

The updated expiration timestamp for the bill estimate.

", - "UpdateBillEstimateResponse$costCategoryGroupSharingPreferenceEffectiveDate": "

Timestamp of the effective date of the cost category used in the group sharing settings.

", - "UpdateBillScenarioRequest$expiresAt": "

The new expiration date for the bill scenario.

", - "UpdateBillScenarioResponse$createdAt": "

The timestamp when the bill scenario was originally created.

", - "UpdateBillScenarioResponse$expiresAt": "

The updated expiration timestamp for the bill scenario.

", - "UpdateWorkloadEstimateRequest$expiresAt": "

The new expiration date for the workload estimate.

", - "UpdateWorkloadEstimateResponse$createdAt": "

The timestamp when the workload estimate was originally created.

", - "UpdateWorkloadEstimateResponse$expiresAt": "

The updated expiration timestamp for the workload estimate.

", - "UpdateWorkloadEstimateResponse$rateTimestamp": "

The timestamp of the pricing rates used for the updated estimate.

", - "UsageAmount$startHour": "

The start hour of the usage period.

", - "UsageQuantity$startHour": "

The start hour of the usage period.

", - "WorkloadEstimateSummary$createdAt": "

The timestamp when the workload estimate was created.

", - "WorkloadEstimateSummary$expiresAt": "

The timestamp when the workload estimate will expire.

", - "WorkloadEstimateSummary$rateTimestamp": "

The timestamp of the pricing rates used for the estimate.

" - } - }, - "UntagResourceRequest": { - "base": null, - "refs": {} - }, - "UntagResourceResponse": { - "base": null, - "refs": {} - }, - "UpdateBillEstimateRequest": { - "base": null, - "refs": {} - }, - "UpdateBillEstimateResponse": { - "base": null, - "refs": {} - }, - "UpdateBillScenarioRequest": { - "base": null, - "refs": {} - }, - "UpdateBillScenarioResponse": { - "base": null, - "refs": {} - }, - "UpdatePreferencesRequest": { - "base": null, - "refs": {} - }, - "UpdatePreferencesResponse": { - "base": null, - "refs": {} - }, - "UpdateWorkloadEstimateRequest": { - "base": null, - "refs": {} - }, - "UpdateWorkloadEstimateResponse": { - "base": "

Mixin for common fields returned by CRUD APIs

", - "refs": {} - }, - "UsageAmount": { - "base": "

Represents a usage amount for a specific time period.

", - "refs": { - "UsageAmounts$member": null - } - }, - "UsageAmounts": { - "base": null, - "refs": { - "BatchCreateBillScenarioUsageModificationEntry$amounts": "

The amount of usage you want to create for the service use you are modeling.

", - "BatchUpdateBillScenarioUsageModificationEntry$amounts": "

The updated usage amounts for the modification.

" - } - }, - "UsageGroup": { - "base": null, - "refs": { - "BatchCreateBillScenarioCommitmentModificationEntry$group": "

An optional group identifier for the commitment modification.

", - "BatchCreateBillScenarioCommitmentModificationItem$group": "

The group identifier for the created commitment modification.

", - "BatchCreateBillScenarioUsageModificationEntry$group": "

An optional group identifier for the usage modification.

", - "BatchCreateBillScenarioUsageModificationItem$group": "

The group identifier for the created usage modification.

", - "BatchCreateWorkloadEstimateUsageEntry$group": "

An optional group identifier for the usage estimate.

", - "BatchCreateWorkloadEstimateUsageItem$group": "

The group identifier for the created usage estimate.

", - "BatchUpdateBillScenarioCommitmentModificationEntry$group": "

The updated group identifier for the commitment modification.

", - "BatchUpdateBillScenarioUsageModificationEntry$group": "

The updated group identifier for the usage modification.

", - "BatchUpdateWorkloadEstimateUsageEntry$group": "

The updated group identifier for the usage estimate.

", - "BillEstimateInputCommitmentModificationSummary$group": "

The group identifier for the commitment modification.

", - "BillEstimateInputUsageModificationSummary$group": "

The group identifier for the usage modification.

", - "BillScenarioCommitmentModificationItem$group": "

The group identifier for the commitment modification.

", - "BillScenarioUsageModificationItem$group": "

The group identifier for the usage modification.

", - "WorkloadEstimateUsageItem$group": "

The group identifier for this usage item.

" - } - }, - "UsageQuantities": { - "base": null, - "refs": { - "BatchCreateBillScenarioUsageModificationItem$quantities": "

The modified usage quantities.

", - "BillEstimateInputUsageModificationSummary$quantities": "

The modified usage quantities.

", - "BillScenarioUsageModificationItem$quantities": "

The modified usage quantities.

" - } - }, - "UsageQuantity": { - "base": "

Represents a usage quantity with associated unit and time period.

", - "refs": { - "UsageQuantities$member": null - } - }, - "UsageQuantityResult": { - "base": "

Represents the result of a usage quantity calculation.

", - "refs": { - "BillEstimateLineItemSummary$estimatedUsageQuantity": "

The estimated usage quantity for this line item.

", - "BillEstimateLineItemSummary$historicalUsageQuantity": "

The historical usage quantity for this line item.

" - } - }, - "UsageType": { - "base": null, - "refs": { - "BatchCreateBillScenarioUsageModificationEntry$usageType": "

Describes the usage details of the usage line item.

", - "BatchCreateBillScenarioUsageModificationItem$usageType": "

The type of usage that was modified.

", - "BatchCreateWorkloadEstimateUsageEntry$usageType": "

The type of usage being estimated.

", - "BatchCreateWorkloadEstimateUsageItem$usageType": "

The type of usage that was estimated.

", - "BillEstimateInputUsageModificationSummary$usageType": "

The type of usage being modified.

", - "BillEstimateLineItemSummary$usageType": "

The type of usage for this line item.

", - "BillScenarioUsageModificationItem$usageType": "

The type of usage being modified.

", - "HistoricalUsageEntity$usageType": "

The type of usage.

", - "WorkloadEstimateUsageItem$usageType": "

The type of usage for this item.

" - } - }, - "Uuid": { - "base": null, - "refs": { - "AddReservedInstanceAction$reservedInstancesOfferingId": "

The ID of the Reserved Instance offering to add. For more information, see DescribeReservedInstancesOfferings.

", - "AddSavingsPlanAction$savingsPlanOfferingId": "

The ID of the Savings Plan offering to add. For more information, see DescribeSavingsPlansOfferings.

", - "BillEstimateCommitmentSummary$offeringId": "

The identifier of the specific offering associated with this commitment.

", - "NegateReservedInstanceAction$reservedInstancesId": "

The ID of the Reserved Instance to remove.

", - "NegateSavingsPlanAction$savingsPlanId": "

The ID of the Savings Plan to remove.

" - } - }, - "ValidationException": { - "base": "

The input provided fails to satisfy the constraints specified by an Amazon Web Services service.

", - "refs": {} - }, - "ValidationExceptionField": { - "base": "

Represents a field that failed validation in a request.

", - "refs": { - "ValidationExceptionFieldList$member": null - } - }, - "ValidationExceptionFieldList": { - "base": null, - "refs": { - "ValidationException$fieldList": "

The list of fields that are invalid.

" - } - }, - "ValidationExceptionReason": { - "base": null, - "refs": { - "ValidationException$reason": "

The reason for the validation exception.

" - } - }, - "WorkloadEstimateCostStatus": { - "base": null, - "refs": { - "BatchCreateWorkloadEstimateUsageItem$status": "

The current status of the created usage estimate.

", - "WorkloadEstimateUsageItem$status": "

The current status of this usage item.

" - } - }, - "WorkloadEstimateName": { - "base": null, - "refs": { - "CreateWorkloadEstimateRequest$name": "

A descriptive name for the workload estimate.

", - "CreateWorkloadEstimateResponse$name": "

The name of the created workload estimate.

", - "GetWorkloadEstimateResponse$name": "

The name of the retrieved workload estimate.

", - "UpdateWorkloadEstimateRequest$name": "

The new name for the workload estimate.

", - "UpdateWorkloadEstimateResponse$name": "

The updated name of the workload estimate.

", - "WorkloadEstimateSummary$name": "

The name of the workload estimate.

" - } - }, - "WorkloadEstimateRateType": { - "base": null, - "refs": { - "CreateWorkloadEstimateRequest$rateType": "

The type of pricing rates to use for the estimate.

", - "CreateWorkloadEstimateResponse$rateType": "

The type of pricing rates used for the estimate.

", - "GetWorkloadEstimateResponse$rateType": "

The type of pricing rates used for the estimate.

", - "UpdateWorkloadEstimateResponse$rateType": "

The type of pricing rates used for the updated estimate.

", - "WorkloadEstimateSummary$rateType": "

The type of pricing rates used for the estimate.

" - } - }, - "WorkloadEstimateStatus": { - "base": null, - "refs": { - "CreateWorkloadEstimateResponse$status": "

The current status of the workload estimate.

", - "GetWorkloadEstimateResponse$status": "

The current status of the workload estimate.

", - "UpdateWorkloadEstimateResponse$status": "

The current status of the updated workload estimate.

", - "WorkloadEstimateSummary$status": "

The current status of the workload estimate.

" - } - }, - "WorkloadEstimateSummaries": { - "base": null, - "refs": { - "ListWorkloadEstimatesResponse$items": "

The list of workload estimates for the account.

" - } - }, - "WorkloadEstimateSummary": { - "base": "

Provides a summary of a workload estimate.

", - "refs": { - "WorkloadEstimateSummaries$member": null - } - }, - "WorkloadEstimateUpdateUsageErrorCode": { - "base": null, - "refs": { - "BatchDeleteWorkloadEstimateUsageError$errorCode": "

The code associated with the error.

", - "BatchUpdateWorkloadEstimateUsageError$errorCode": "

The code associated with the error.

" - } - }, - "WorkloadEstimateUsageItem": { - "base": "

Represents a usage item in a workload estimate.

", - "refs": { - "WorkloadEstimateUsageItems$member": null - } - }, - "WorkloadEstimateUsageItems": { - "base": null, - "refs": { - "BatchUpdateWorkloadEstimateUsageResponse$items": "

Returns the list of successful usage line items that were updated for a Workload estimate.

", - "ListWorkloadEstimateUsageResponse$items": "

The list of usage items associated with the workload estimate.

" - } - }, - "WorkloadEstimateUsageMaxResults": { - "base": null, - "refs": { - "ListWorkloadEstimateUsageRequest$maxResults": "

The maximum number of results to return per page.

" - } - }, - "WorkloadEstimateUsageQuantity": { - "base": "

Represents a usage quantity for a workload estimate.

", - "refs": { - "BatchCreateWorkloadEstimateUsageItem$quantity": "

The estimated usage quantity.

", - "WorkloadEstimateUsageItem$quantity": "

The estimated usage quantity for this item.

" - } - } - } -} diff --git a/tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/endpoint-bdd-1.json b/tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/endpoint-bdd-1.json deleted file mode 100644 index e8831bcf49b1..000000000000 --- a/tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/endpoint-bdd-1.json +++ /dev/null @@ -1,118 +0,0 @@ -{ - "version": "1.1", - "parameters": { - "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" - }, - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "string" - } - }, - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - }, - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - }, - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "results": [ - { - "conditions": [], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://bcm-pricing-calculator-fips.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dualStackDnsSuffix}", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "{PartitionResult#implicitGlobalRegion}" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://bcm-pricing-calculator.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dualStackDnsSuffix}", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "{PartitionResult#implicitGlobalRegion}" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ], - "root": 2, - "nodeCount": 6, - "nodes": "/////wAAAAH/////AAAAAAAAAAYAAAADAAAAAQAAAAQF9eEFAAAAAgAAAAUF9eEFAAAAAwX14QMF9eEEAAAAAwX14QEF9eEC" -} \ No newline at end of file diff --git a/tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/endpoint-rule-set-1.json b/tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/endpoint-rule-set-1.json deleted file mode 100644 index 5fa8c9c9edd8..000000000000 --- a/tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/endpoint-rule-set-1.json +++ /dev/null @@ -1,151 +0,0 @@ -{ - "version": "1.0", - "parameters": { - "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" - }, - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the 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": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "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 - ] - } - ], - "endpoint": { - "url": "https://bcm-pricing-calculator-fips.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dualStackDnsSuffix}", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "{PartitionResult#implicitGlobalRegion}" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://bcm-pricing-calculator.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dualStackDnsSuffix}", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "{PartitionResult#implicitGlobalRegion}" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ], - "type": "tree" - } - ] -} \ No newline at end of file diff --git a/tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/endpoint-tests-1.json b/tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/endpoint-tests-1.json deleted file mode 100644 index cc5446d58040..000000000000 --- a/tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/endpoint-tests-1.json +++ /dev/null @@ -1,153 +0,0 @@ -{ - "testCases": [ - { - "documentation": "For custom endpoint with region not set and fips disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Endpoint": "https://example.com", - "UseFIPS": false - } - }, - { - "documentation": "For custom endpoint with fips enabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Endpoint": "https://example.com", - "UseFIPS": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-east-1" - } - ] - }, - "url": "https://bcm-pricing-calculator-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-east-1" - } - ] - }, - "url": "https://bcm-pricing-calculator.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "cn-northwest-1" - } - ] - }, - "url": "https://bcm-pricing-calculator-fips.cn-northwest-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-northwest-1", - "UseFIPS": true - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "cn-northwest-1" - } - ] - }, - "url": "https://bcm-pricing-calculator.cn-northwest-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-northwest-1", - "UseFIPS": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-gov-west-1" - } - ] - }, - "url": "https://bcm-pricing-calculator-fips.us-gov-west-1.api.aws" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": true - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-gov-west-1" - } - ] - }, - "url": "https://bcm-pricing-calculator.us-gov-west-1.api.aws" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": false - } - }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } - } - ], - "version": "1.0" -} \ No newline at end of file diff --git a/tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/examples-1.json b/tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/examples-1.json deleted file mode 100644 index 2fb77604d1be..000000000000 --- a/tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/examples-1.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "version": "1.0", - "examples": {} -} diff --git a/tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/paginators-1.json b/tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/paginators-1.json deleted file mode 100644 index 678b04a93dc2..000000000000 --- a/tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/paginators-1.json +++ /dev/null @@ -1,64 +0,0 @@ -{ - "pagination": { - "ListBillEstimateCommitments": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "items" - }, - "ListBillEstimateInputCommitmentModifications": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "items" - }, - "ListBillEstimateInputUsageModifications": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "items" - }, - "ListBillEstimateLineItems": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "items" - }, - "ListBillEstimates": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "items" - }, - "ListBillScenarioCommitmentModifications": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "items" - }, - "ListBillScenarioUsageModifications": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "items" - }, - "ListBillScenarios": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "items" - }, - "ListWorkloadEstimateUsage": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "items" - }, - "ListWorkloadEstimates": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "items" - } - } -} diff --git a/tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/service-2.json b/tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/service-2.json deleted file mode 100644 index bd4d9a52827f..000000000000 --- a/tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/service-2.json +++ /dev/null @@ -1,4141 +0,0 @@ -{ - "version":"2.0", - "metadata":{ - "apiVersion":"2024-06-19", - "auth":["aws.auth#sigv4"], - "endpointPrefix":"bcm-pricing-calculator", - "jsonVersion":"1.0", - "protocol":"json", - "protocols":["json"], - "serviceFullName":"AWS Billing and Cost Management Pricing Calculator", - "serviceId":"BCM Pricing Calculator", - "signatureVersion":"v4", - "signingName":"bcm-pricing-calculator", - "targetPrefix":"AWSBCMPricingCalculator", - "uid":"bcm-pricing-calculator-2024-06-19" - }, - "operations":{ - "BatchCreateBillScenarioCommitmentModification":{ - "name":"BatchCreateBillScenarioCommitmentModification", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"BatchCreateBillScenarioCommitmentModificationRequest"}, - "output":{"shape":"BatchCreateBillScenarioCommitmentModificationResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Create Compute Savings Plans, EC2 Instance Savings Plans, or EC2 Reserved Instances commitments that you want to model in a Bill Scenario.

The BatchCreateBillScenarioCommitmentModification operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission bcm-pricing-calculator:CreateBillScenarioCommitmentModification in your policies.

", - "idempotent":true - }, - "BatchCreateBillScenarioUsageModification":{ - "name":"BatchCreateBillScenarioUsageModification", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"BatchCreateBillScenarioUsageModificationRequest"}, - "output":{"shape":"BatchCreateBillScenarioUsageModificationResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"ServiceQuotaExceededException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Create Amazon Web Services service usage that you want to model in a Bill Scenario.

The BatchCreateBillScenarioUsageModification operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission bcm-pricing-calculator:CreateBillScenarioUsageModification in your policies.

", - "idempotent":true - }, - "BatchCreateWorkloadEstimateUsage":{ - "name":"BatchCreateWorkloadEstimateUsage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"BatchCreateWorkloadEstimateUsageRequest"}, - "output":{"shape":"BatchCreateWorkloadEstimateUsageResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"ServiceQuotaExceededException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Create Amazon Web Services service usage that you want to model in a Workload Estimate.

The BatchCreateWorkloadEstimateUsage operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission bcm-pricing-calculator:CreateWorkloadEstimateUsage in your policies.

", - "idempotent":true - }, - "BatchDeleteBillScenarioCommitmentModification":{ - "name":"BatchDeleteBillScenarioCommitmentModification", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"BatchDeleteBillScenarioCommitmentModificationRequest"}, - "output":{"shape":"BatchDeleteBillScenarioCommitmentModificationResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Delete commitment that you have created in a Bill Scenario. You can only delete a commitment that you had added and cannot model deletion (or removal) of a existing commitment. If you want model deletion of an existing commitment, see the negate BillScenarioCommitmentModificationAction of BatchCreateBillScenarioCommitmentModification operation.

The BatchDeleteBillScenarioCommitmentModification operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission bcm-pricing-calculator:DeleteBillScenarioCommitmentModification in your policies.

", - "idempotent":true - }, - "BatchDeleteBillScenarioUsageModification":{ - "name":"BatchDeleteBillScenarioUsageModification", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"BatchDeleteBillScenarioUsageModificationRequest"}, - "output":{"shape":"BatchDeleteBillScenarioUsageModificationResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"ServiceQuotaExceededException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Delete usage that you have created in a Bill Scenario. You can only delete usage that you had added and cannot model deletion (or removal) of a existing usage. If you want model removal of an existing usage, see BatchUpdateBillScenarioUsageModification.

The BatchDeleteBillScenarioUsageModification operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission bcm-pricing-calculator:DeleteBillScenarioUsageModification in your policies.

", - "idempotent":true - }, - "BatchDeleteWorkloadEstimateUsage":{ - "name":"BatchDeleteWorkloadEstimateUsage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"BatchDeleteWorkloadEstimateUsageRequest"}, - "output":{"shape":"BatchDeleteWorkloadEstimateUsageResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"ServiceQuotaExceededException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Delete usage that you have created in a Workload estimate. You can only delete usage that you had added and cannot model deletion (or removal) of a existing usage. If you want model removal of an existing usage, see BatchUpdateWorkloadEstimateUsage.

The BatchDeleteWorkloadEstimateUsage operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission bcm-pricing-calculator:DeleteWorkloadEstimateUsage in your policies.

", - "idempotent":true - }, - "BatchUpdateBillScenarioCommitmentModification":{ - "name":"BatchUpdateBillScenarioCommitmentModification", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"BatchUpdateBillScenarioCommitmentModificationRequest"}, - "output":{"shape":"BatchUpdateBillScenarioCommitmentModificationResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Update a newly added or existing commitment. You can update the commitment group based on a commitment ID and a Bill scenario ID.

The BatchUpdateBillScenarioCommitmentModification operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission bcm-pricing-calculator:UpdateBillScenarioCommitmentModification in your policies.

", - "idempotent":true - }, - "BatchUpdateBillScenarioUsageModification":{ - "name":"BatchUpdateBillScenarioUsageModification", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"BatchUpdateBillScenarioUsageModificationRequest"}, - "output":{"shape":"BatchUpdateBillScenarioUsageModificationResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"ServiceQuotaExceededException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Update a newly added or existing usage lines. You can update the usage amounts, usage hour, and usage group based on a usage ID and a Bill scenario ID.

The BatchUpdateBillScenarioUsageModification operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission bcm-pricing-calculator:UpdateBillScenarioUsageModification in your policies.

", - "idempotent":true - }, - "BatchUpdateWorkloadEstimateUsage":{ - "name":"BatchUpdateWorkloadEstimateUsage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"BatchUpdateWorkloadEstimateUsageRequest"}, - "output":{"shape":"BatchUpdateWorkloadEstimateUsageResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"ServiceQuotaExceededException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Update a newly added or existing usage lines. You can update the usage amounts and usage group based on a usage ID and a Workload estimate ID.

The BatchUpdateWorkloadEstimateUsage operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission bcm-pricing-calculator:UpdateWorkloadEstimateUsage in your policies.

", - "idempotent":true - }, - "CreateBillEstimate":{ - "name":"CreateBillEstimate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateBillEstimateRequest"}, - "output":{"shape":"CreateBillEstimateResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Create a Bill estimate from a Bill scenario. In the Bill scenario you can model usage addition, usage changes, and usage removal. You can also model commitment addition and commitment removal. After all changes in a Bill scenario is made satisfactorily, you can call this API with a Bill scenario ID to generate the Bill estimate. Bill estimate calculates the pre-tax cost for your consolidated billing family, incorporating all modeled usage and commitments alongside existing usage and commitments from your most recent completed anniversary bill, with any applicable discounts applied.

", - "idempotent":true - }, - "CreateBillScenario":{ - "name":"CreateBillScenario", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateBillScenarioRequest"}, - "output":{"shape":"CreateBillScenarioResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"ServiceQuotaExceededException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Creates a new bill scenario to model potential changes to Amazon Web Services usage and costs.

", - "idempotent":true - }, - "CreateWorkloadEstimate":{ - "name":"CreateWorkloadEstimate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateWorkloadEstimateRequest"}, - "output":{"shape":"CreateWorkloadEstimateResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"ServiceQuotaExceededException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Creates a new workload estimate to model costs for a specific workload.

", - "idempotent":true - }, - "DeleteBillEstimate":{ - "name":"DeleteBillEstimate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteBillEstimateRequest"}, - "output":{"shape":"DeleteBillEstimateResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Deletes an existing bill estimate.

", - "idempotent":true - }, - "DeleteBillScenario":{ - "name":"DeleteBillScenario", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteBillScenarioRequest"}, - "output":{"shape":"DeleteBillScenarioResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Deletes an existing bill scenario.

", - "idempotent":true - }, - "DeleteWorkloadEstimate":{ - "name":"DeleteWorkloadEstimate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteWorkloadEstimateRequest"}, - "output":{"shape":"DeleteWorkloadEstimateResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Deletes an existing workload estimate.

", - "idempotent":true - }, - "GetBillEstimate":{ - "name":"GetBillEstimate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetBillEstimateRequest"}, - "output":{"shape":"GetBillEstimateResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Retrieves details of a specific bill estimate.

", - "readonly":true - }, - "GetBillScenario":{ - "name":"GetBillScenario", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetBillScenarioRequest"}, - "output":{"shape":"GetBillScenarioResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Retrieves details of a specific bill scenario.

", - "readonly":true - }, - "GetPreferences":{ - "name":"GetPreferences", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetPreferencesRequest"}, - "output":{"shape":"GetPreferencesResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Retrieves the current preferences for Pricing Calculator.

", - "readonly":true - }, - "GetWorkloadEstimate":{ - "name":"GetWorkloadEstimate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetWorkloadEstimateRequest"}, - "output":{"shape":"GetWorkloadEstimateResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Retrieves details of a specific workload estimate.

", - "readonly":true - }, - "ListBillEstimateCommitments":{ - "name":"ListBillEstimateCommitments", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListBillEstimateCommitmentsRequest"}, - "output":{"shape":"ListBillEstimateCommitmentsResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Lists the commitments associated with a bill estimate.

", - "readonly":true - }, - "ListBillEstimateInputCommitmentModifications":{ - "name":"ListBillEstimateInputCommitmentModifications", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListBillEstimateInputCommitmentModificationsRequest"}, - "output":{"shape":"ListBillEstimateInputCommitmentModificationsResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Lists the input commitment modifications associated with a bill estimate.

", - "readonly":true - }, - "ListBillEstimateInputUsageModifications":{ - "name":"ListBillEstimateInputUsageModifications", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListBillEstimateInputUsageModificationsRequest"}, - "output":{"shape":"ListBillEstimateInputUsageModificationsResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Lists the input usage modifications associated with a bill estimate.

", - "readonly":true - }, - "ListBillEstimateLineItems":{ - "name":"ListBillEstimateLineItems", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListBillEstimateLineItemsRequest"}, - "output":{"shape":"ListBillEstimateLineItemsResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Lists the line items associated with a bill estimate.

", - "readonly":true - }, - "ListBillEstimates":{ - "name":"ListBillEstimates", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListBillEstimatesRequest"}, - "output":{"shape":"ListBillEstimatesResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Lists all bill estimates for the account.

", - "readonly":true - }, - "ListBillScenarioCommitmentModifications":{ - "name":"ListBillScenarioCommitmentModifications", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListBillScenarioCommitmentModificationsRequest"}, - "output":{"shape":"ListBillScenarioCommitmentModificationsResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Lists the commitment modifications associated with a bill scenario.

", - "readonly":true - }, - "ListBillScenarioUsageModifications":{ - "name":"ListBillScenarioUsageModifications", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListBillScenarioUsageModificationsRequest"}, - "output":{"shape":"ListBillScenarioUsageModificationsResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Lists the usage modifications associated with a bill scenario.

", - "readonly":true - }, - "ListBillScenarios":{ - "name":"ListBillScenarios", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListBillScenariosRequest"}, - "output":{"shape":"ListBillScenariosResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Lists all bill scenarios for the account.

", - "readonly":true - }, - "ListTagsForResource":{ - "name":"ListTagsForResource", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListTagsForResourceRequest"}, - "output":{"shape":"ListTagsForResourceResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Lists all tags associated with a specified resource.

", - "readonly":true - }, - "ListWorkloadEstimateUsage":{ - "name":"ListWorkloadEstimateUsage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListWorkloadEstimateUsageRequest"}, - "output":{"shape":"ListWorkloadEstimateUsageResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Lists the usage associated with a workload estimate.

", - "readonly":true - }, - "ListWorkloadEstimates":{ - "name":"ListWorkloadEstimates", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListWorkloadEstimatesRequest"}, - "output":{"shape":"ListWorkloadEstimatesResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Lists all workload estimates for the account.

", - "readonly":true - }, - "TagResource":{ - "name":"TagResource", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"TagResourceRequest"}, - "output":{"shape":"TagResourceResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"ServiceQuotaExceededException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Adds one or more tags to a specified resource.

" - }, - "UntagResource":{ - "name":"UntagResource", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UntagResourceRequest"}, - "output":{"shape":"UntagResourceResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Removes one or more tags from a specified resource.

" - }, - "UpdateBillEstimate":{ - "name":"UpdateBillEstimate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateBillEstimateRequest"}, - "output":{"shape":"UpdateBillEstimateResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Updates an existing bill estimate.

", - "idempotent":true - }, - "UpdateBillScenario":{ - "name":"UpdateBillScenario", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateBillScenarioRequest"}, - "output":{"shape":"UpdateBillScenarioResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Updates an existing bill scenario.

", - "idempotent":true - }, - "UpdatePreferences":{ - "name":"UpdatePreferences", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdatePreferencesRequest"}, - "output":{"shape":"UpdatePreferencesResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"ServiceQuotaExceededException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Updates the preferences for Pricing Calculator.

", - "idempotent":true - }, - "UpdateWorkloadEstimate":{ - "name":"UpdateWorkloadEstimate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateWorkloadEstimateRequest"}, - "output":{"shape":"UpdateWorkloadEstimateResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"DataUnavailableException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Updates an existing workload estimate.

", - "idempotent":true - } - }, - "shapes":{ - "AccessDeniedException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"} - }, - "documentation":"

You do not have sufficient access to perform this action.

", - "exception":true - }, - "AccountId":{ - "type":"string", - "max":12, - "min":12, - "pattern":"\\d{12}" - }, - "AddReservedInstanceAction":{ - "type":"structure", - "members":{ - "reservedInstancesOfferingId":{ - "shape":"Uuid", - "documentation":"

The ID of the Reserved Instance offering to add. For more information, see DescribeReservedInstancesOfferings.

" - }, - "instanceCount":{ - "shape":"ReservedInstanceInstanceCount", - "documentation":"

The number of instances to add for this Reserved Instance offering.

" - } - }, - "documentation":"

Represents an action to add a Reserved Instance to a bill scenario.

" - }, - "AddSavingsPlanAction":{ - "type":"structure", - "members":{ - "savingsPlanOfferingId":{ - "shape":"Uuid", - "documentation":"

The ID of the Savings Plan offering to add. For more information, see DescribeSavingsPlansOfferings.

" - }, - "commitment":{ - "shape":"SavingsPlanCommitment", - "documentation":"

The hourly commitment, in the same currency of the savingsPlanOfferingId. This is a value between 0.001 and 1 million. You cannot specify more than five digits after the decimal point.

" - } - }, - "documentation":"

Represents an action to add a Savings Plan to a bill scenario.

" - }, - "Arn":{ - "type":"string", - "max":2048, - "min":20, - "pattern":"arn:aws[-a-z0-9]*:bcm-pricing-calculator:[-a-z0-9]*:[0-9]{12}:[-a-z0-9/:_]+" - }, - "AvailabilityZone":{ - "type":"string", - "max":32, - "min":0, - "pattern":"[-a-zA-Z0-9\\.\\-_:, \\/()]*" - }, - "BatchCreateBillScenarioCommitmentModificationEntries":{ - "type":"list", - "member":{"shape":"BatchCreateBillScenarioCommitmentModificationEntry"}, - "max":25, - "min":1 - }, - "BatchCreateBillScenarioCommitmentModificationEntry":{ - "type":"structure", - "required":[ - "key", - "usageAccountId", - "commitmentAction" - ], - "members":{ - "key":{ - "shape":"Key", - "documentation":"

A unique identifier for this entry in the batch operation. This can be any valid string. This key is useful to identify errors associated with any commitment entry as any error is returned with this key.

" - }, - "group":{ - "shape":"UsageGroup", - "documentation":"

An optional group identifier for the commitment modification.

" - }, - "usageAccountId":{ - "shape":"AccountId", - "documentation":"

The Amazon Web Services account ID to which this commitment will be applied to.

" - }, - "commitmentAction":{ - "shape":"BillScenarioCommitmentModificationAction", - "documentation":"

The specific commitment action to be taken (e.g., adding a Reserved Instance or Savings Plan).

" - } - }, - "documentation":"

Represents an entry object in the batch operation to create bill scenario commitment modifications.

" - }, - "BatchCreateBillScenarioCommitmentModificationError":{ - "type":"structure", - "members":{ - "key":{ - "shape":"Key", - "documentation":"

The key of the entry that caused the error.

" - }, - "errorMessage":{ - "shape":"String", - "documentation":"

A descriptive message for the error that occurred.

" - }, - "errorCode":{ - "shape":"BatchCreateBillScenarioCommitmentModificationErrorCode", - "documentation":"

The error code associated with the failed operation.

" - } - }, - "documentation":"

Represents an error that occurred during a batch create operation for bill scenario commitment modifications.

" - }, - "BatchCreateBillScenarioCommitmentModificationErrorCode":{ - "type":"string", - "enum":[ - "CONFLICT", - "INTERNAL_SERVER_ERROR", - "INVALID_ACCOUNT" - ] - }, - "BatchCreateBillScenarioCommitmentModificationErrors":{ - "type":"list", - "member":{"shape":"BatchCreateBillScenarioCommitmentModificationError"} - }, - "BatchCreateBillScenarioCommitmentModificationItem":{ - "type":"structure", - "members":{ - "key":{ - "shape":"Key", - "documentation":"

The key of the successfully created entry. This can be any valid string. This key is useful to identify errors associated with any commitment entry as any error is returned with this key.

" - }, - "id":{ - "shape":"ResourceId", - "documentation":"

The unique identifier assigned to the created commitment modification.

" - }, - "group":{ - "shape":"UsageGroup", - "documentation":"

The group identifier for the created commitment modification.

" - }, - "usageAccountId":{ - "shape":"AccountId", - "documentation":"

The Amazon Web Services account ID associated with the created commitment modification.

" - }, - "commitmentAction":{ - "shape":"BillScenarioCommitmentModificationAction", - "documentation":"

The specific commitment action that was taken.

" - } - }, - "documentation":"

Represents a successfully created item in a batch operation for bill scenario commitment modifications.

" - }, - "BatchCreateBillScenarioCommitmentModificationItems":{ - "type":"list", - "member":{"shape":"BatchCreateBillScenarioCommitmentModificationItem"} - }, - "BatchCreateBillScenarioCommitmentModificationRequest":{ - "type":"structure", - "required":[ - "billScenarioId", - "commitmentModifications" - ], - "members":{ - "billScenarioId":{ - "shape":"ResourceId", - "documentation":"

The ID of the Bill Scenario for which you want to create the modeled commitment.

" - }, - "commitmentModifications":{ - "shape":"BatchCreateBillScenarioCommitmentModificationEntries", - "documentation":"

List of commitments that you want to model in the Bill Scenario.

" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", - "idempotencyToken":true - } - } - }, - "BatchCreateBillScenarioCommitmentModificationResponse":{ - "type":"structure", - "members":{ - "items":{ - "shape":"BatchCreateBillScenarioCommitmentModificationItems", - "documentation":"

Returns the list of successful commitment line items that were created for the Bill Scenario.

" - }, - "errors":{ - "shape":"BatchCreateBillScenarioCommitmentModificationErrors", - "documentation":"

Returns the list of errors reason and the commitment item keys that cannot be created in the Bill Scenario.

" - } - } - }, - "BatchCreateBillScenarioUsageModificationEntries":{ - "type":"list", - "member":{"shape":"BatchCreateBillScenarioUsageModificationEntry"}, - "max":25, - "min":1 - }, - "BatchCreateBillScenarioUsageModificationEntry":{ - "type":"structure", - "required":[ - "serviceCode", - "usageType", - "operation", - "key", - "usageAccountId" - ], - "members":{ - "serviceCode":{ - "shape":"ServiceCode", - "documentation":"

The Amazon Web Services service code for this usage modification. This identifies the specific Amazon Web Services service to the customer as a unique short abbreviation. For example, AmazonEC2 and AWSKMS.

" - }, - "usageType":{ - "shape":"UsageType", - "documentation":"

Describes the usage details of the usage line item.

" - }, - "operation":{ - "shape":"Operation", - "documentation":"

The specific operation associated with this usage modification. Describes the specific Amazon Web Services operation that this usage line models. For example, RunInstances indicates the operation of an Amazon EC2 instance.

" - }, - "availabilityZone":{ - "shape":"AvailabilityZone", - "documentation":"

The Availability Zone that this usage line uses.

" - }, - "key":{ - "shape":"Key", - "documentation":"

A unique identifier for this entry in the batch operation. This can be any valid string. This key is useful to identify errors associated with any usage entry as any error is returned with this key.

" - }, - "group":{ - "shape":"UsageGroup", - "documentation":"

An optional group identifier for the usage modification.

" - }, - "usageAccountId":{ - "shape":"AccountId", - "documentation":"

The Amazon Web Services account ID to which this usage will be applied to.

" - }, - "amounts":{ - "shape":"UsageAmounts", - "documentation":"

The amount of usage you want to create for the service use you are modeling.

" - }, - "historicalUsage":{ - "shape":"HistoricalUsageEntity", - "documentation":"

Historical usage data associated with this modification, if available.

" - } - }, - "documentation":"

Represents an entry in a batch operation to create bill scenario usage modifications.

" - }, - "BatchCreateBillScenarioUsageModificationError":{ - "type":"structure", - "members":{ - "key":{ - "shape":"Key", - "documentation":"

The key of the entry that caused the error.

" - }, - "errorMessage":{ - "shape":"String", - "documentation":"

A descriptive message for the error that occurred.

" - }, - "errorCode":{ - "shape":"BatchCreateBillScenarioUsageModificationErrorCode", - "documentation":"

The error code associated with the failed operation.

" - } - }, - "documentation":"

Represents an error that occurred during a batch create operation for bill scenario usage modifications.

" - }, - "BatchCreateBillScenarioUsageModificationErrorCode":{ - "type":"string", - "enum":[ - "BAD_REQUEST", - "NOT_FOUND", - "CONFLICT", - "INTERNAL_SERVER_ERROR" - ] - }, - "BatchCreateBillScenarioUsageModificationErrors":{ - "type":"list", - "member":{"shape":"BatchCreateBillScenarioUsageModificationError"} - }, - "BatchCreateBillScenarioUsageModificationItem":{ - "type":"structure", - "required":[ - "serviceCode", - "usageType", - "operation" - ], - "members":{ - "serviceCode":{ - "shape":"ServiceCode", - "documentation":"

The Amazon Web Services service code for this usage modification.

" - }, - "usageType":{ - "shape":"UsageType", - "documentation":"

The type of usage that was modified.

" - }, - "operation":{ - "shape":"Operation", - "documentation":"

The specific operation associated with this usage modification.

" - }, - "location":{ - "shape":"String", - "documentation":"

The location associated with this usage modification.

" - }, - "availabilityZone":{ - "shape":"AvailabilityZone", - "documentation":"

The availability zone associated with this usage modification, if applicable.

" - }, - "id":{ - "shape":"ResourceId", - "documentation":"

The unique identifier assigned to the created usage modification.

" - }, - "group":{ - "shape":"UsageGroup", - "documentation":"

The group identifier for the created usage modification.

" - }, - "usageAccountId":{ - "shape":"AccountId", - "documentation":"

The Amazon Web Services account ID associated with the created usage modification.

" - }, - "quantities":{ - "shape":"UsageQuantities", - "documentation":"

The modified usage quantities.

" - }, - "historicalUsage":{ - "shape":"HistoricalUsageEntity", - "documentation":"

Historical usage data associated with this modification, if available.

" - }, - "key":{ - "shape":"Key", - "documentation":"

The key of the successfully created entry.

" - } - }, - "documentation":"

Represents a successfully created item in a batch operation for bill scenario usage modifications.

" - }, - "BatchCreateBillScenarioUsageModificationItems":{ - "type":"list", - "member":{"shape":"BatchCreateBillScenarioUsageModificationItem"} - }, - "BatchCreateBillScenarioUsageModificationRequest":{ - "type":"structure", - "required":[ - "billScenarioId", - "usageModifications" - ], - "members":{ - "billScenarioId":{ - "shape":"ResourceId", - "documentation":"

The ID of the Bill Scenario for which you want to create the modeled usage.

" - }, - "usageModifications":{ - "shape":"BatchCreateBillScenarioUsageModificationEntries", - "documentation":"

List of usage that you want to model in the Bill Scenario.

" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", - "idempotencyToken":true - } - } - }, - "BatchCreateBillScenarioUsageModificationResponse":{ - "type":"structure", - "members":{ - "items":{ - "shape":"BatchCreateBillScenarioUsageModificationItems", - "documentation":"

Returns the list of successful usage line items that were created for the Bill Scenario.

" - }, - "errors":{ - "shape":"BatchCreateBillScenarioUsageModificationErrors", - "documentation":"

Returns the list of errors reason and the usage item keys that cannot be created in the Bill Scenario.

" - } - } - }, - "BatchCreateWorkloadEstimateUsageCode":{ - "type":"string", - "enum":[ - "BAD_REQUEST", - "NOT_FOUND", - "CONFLICT", - "INTERNAL_SERVER_ERROR" - ] - }, - "BatchCreateWorkloadEstimateUsageEntries":{ - "type":"list", - "member":{"shape":"BatchCreateWorkloadEstimateUsageEntry"}, - "max":25, - "min":1 - }, - "BatchCreateWorkloadEstimateUsageEntry":{ - "type":"structure", - "required":[ - "serviceCode", - "usageType", - "operation", - "key", - "usageAccountId", - "amount" - ], - "members":{ - "serviceCode":{ - "shape":"ServiceCode", - "documentation":"

The Amazon Web Services service code for this usage estimate.

" - }, - "usageType":{ - "shape":"UsageType", - "documentation":"

The type of usage being estimated.

" - }, - "operation":{ - "shape":"Operation", - "documentation":"

The specific operation associated with this usage estimate.

" - }, - "key":{ - "shape":"Key", - "documentation":"

A unique identifier for this entry in the batch operation.

" - }, - "group":{ - "shape":"UsageGroup", - "documentation":"

An optional group identifier for the usage estimate.

" - }, - "usageAccountId":{ - "shape":"AccountId", - "documentation":"

The Amazon Web Services account ID associated with this usage estimate.

" - }, - "amount":{ - "shape":"Double", - "documentation":"

The estimated usage amount.

" - }, - "historicalUsage":{ - "shape":"HistoricalUsageEntity", - "documentation":"

Historical usage data associated with this estimate, if available.

" - } - }, - "documentation":"

Represents an entry in a batch operation to create workload estimate usage.

" - }, - "BatchCreateWorkloadEstimateUsageError":{ - "type":"structure", - "members":{ - "key":{ - "shape":"Key", - "documentation":"

The key of the entry that caused the error.

" - }, - "errorCode":{ - "shape":"BatchCreateWorkloadEstimateUsageCode", - "documentation":"

The error code associated with the failed operation.

" - }, - "errorMessage":{ - "shape":"String", - "documentation":"

A descriptive message for the error that occurred.

" - } - }, - "documentation":"

Represents an error that occurred during a batch create operation for workload estimate usage.

" - }, - "BatchCreateWorkloadEstimateUsageErrors":{ - "type":"list", - "member":{"shape":"BatchCreateWorkloadEstimateUsageError"} - }, - "BatchCreateWorkloadEstimateUsageItem":{ - "type":"structure", - "required":[ - "serviceCode", - "usageType", - "operation" - ], - "members":{ - "serviceCode":{ - "shape":"ServiceCode", - "documentation":"

The Amazon Web Services service code for this usage estimate.

" - }, - "usageType":{ - "shape":"UsageType", - "documentation":"

The type of usage that was estimated.

" - }, - "operation":{ - "shape":"Operation", - "documentation":"

The specific operation associated with this usage estimate.

" - }, - "location":{ - "shape":"String", - "documentation":"

The location associated with this usage estimate.

" - }, - "id":{ - "shape":"ResourceId", - "documentation":"

The unique identifier assigned to the created usage estimate.

" - }, - "usageAccountId":{ - "shape":"AccountId", - "documentation":"

The Amazon Web Services account ID associated with the created usage estimate.

" - }, - "group":{ - "shape":"UsageGroup", - "documentation":"

The group identifier for the created usage estimate.

" - }, - "quantity":{ - "shape":"WorkloadEstimateUsageQuantity", - "documentation":"

The estimated usage quantity.

" - }, - "cost":{ - "shape":"Double", - "documentation":"

The estimated cost associated with this usage.

" - }, - "currency":{ - "shape":"CurrencyCode", - "documentation":"

The currency of the estimated cost.

" - }, - "status":{ - "shape":"WorkloadEstimateCostStatus", - "documentation":"

The current status of the created usage estimate.

" - }, - "historicalUsage":{ - "shape":"HistoricalUsageEntity", - "documentation":"

Historical usage data associated with this estimate, if available.

" - }, - "key":{ - "shape":"Key", - "documentation":"

The key of the successfully created entry.

" - } - }, - "documentation":"

Represents a successfully created item in a batch operation for workload estimate usage.

" - }, - "BatchCreateWorkloadEstimateUsageItems":{ - "type":"list", - "member":{"shape":"BatchCreateWorkloadEstimateUsageItem"} - }, - "BatchCreateWorkloadEstimateUsageRequest":{ - "type":"structure", - "required":[ - "workloadEstimateId", - "usage" - ], - "members":{ - "workloadEstimateId":{ - "shape":"ResourceId", - "documentation":"

The ID of the Workload estimate for which you want to create the modeled usage.

" - }, - "usage":{ - "shape":"BatchCreateWorkloadEstimateUsageEntries", - "documentation":"

List of usage that you want to model in the Workload estimate.

" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", - "idempotencyToken":true - } - } - }, - "BatchCreateWorkloadEstimateUsageResponse":{ - "type":"structure", - "members":{ - "items":{ - "shape":"BatchCreateWorkloadEstimateUsageItems", - "documentation":"

Returns the list of successful usage line items that were created for the Workload estimate.

" - }, - "errors":{ - "shape":"BatchCreateWorkloadEstimateUsageErrors", - "documentation":"

Returns the list of errors reason and the usage item keys that cannot be created in the Workload estimate.

" - } - } - }, - "BatchDeleteBillScenarioCommitmentModificationEntries":{ - "type":"list", - "member":{"shape":"ResourceId"}, - "max":25, - "min":1 - }, - "BatchDeleteBillScenarioCommitmentModificationError":{ - "type":"structure", - "members":{ - "id":{ - "shape":"ResourceId", - "documentation":"

The ID of the error.

" - }, - "errorCode":{ - "shape":"BatchDeleteBillScenarioCommitmentModificationErrorCode", - "documentation":"

The code associated with the error.

" - }, - "errorMessage":{ - "shape":"String", - "documentation":"

The message that describes the error.

" - } - }, - "documentation":"

Represents an error that occurred when deleting a commitment in a Bill Scenario.

" - }, - "BatchDeleteBillScenarioCommitmentModificationErrorCode":{ - "type":"string", - "enum":[ - "BAD_REQUEST", - "CONFLICT", - "INTERNAL_SERVER_ERROR" - ] - }, - "BatchDeleteBillScenarioCommitmentModificationErrors":{ - "type":"list", - "member":{"shape":"BatchDeleteBillScenarioCommitmentModificationError"} - }, - "BatchDeleteBillScenarioCommitmentModificationRequest":{ - "type":"structure", - "required":[ - "billScenarioId", - "ids" - ], - "members":{ - "billScenarioId":{ - "shape":"ResourceId", - "documentation":"

The ID of the Bill Scenario for which you want to delete the modeled commitment.

" - }, - "ids":{ - "shape":"BatchDeleteBillScenarioCommitmentModificationEntries", - "documentation":"

List of commitments that you want to delete from the Bill Scenario.

" - } - } - }, - "BatchDeleteBillScenarioCommitmentModificationResponse":{ - "type":"structure", - "members":{ - "errors":{ - "shape":"BatchDeleteBillScenarioCommitmentModificationErrors", - "documentation":"

Returns the list of errors reason and the commitment item keys that cannot be deleted from the Bill Scenario.

" - } - } - }, - "BatchDeleteBillScenarioUsageModificationEntries":{ - "type":"list", - "member":{"shape":"ResourceId"}, - "max":25, - "min":1 - }, - "BatchDeleteBillScenarioUsageModificationError":{ - "type":"structure", - "members":{ - "id":{ - "shape":"ResourceId", - "documentation":"

The ID of the error.

" - }, - "errorMessage":{ - "shape":"String", - "documentation":"

The message that describes the error.

" - }, - "errorCode":{ - "shape":"BatchDeleteBillScenarioUsageModificationErrorCode", - "documentation":"

The code associated with the error.

" - } - }, - "documentation":"

Represents an error that occurred when deleting usage in a Bill Scenario.

" - }, - "BatchDeleteBillScenarioUsageModificationErrorCode":{ - "type":"string", - "enum":[ - "BAD_REQUEST", - "CONFLICT", - "INTERNAL_SERVER_ERROR" - ] - }, - "BatchDeleteBillScenarioUsageModificationErrors":{ - "type":"list", - "member":{"shape":"BatchDeleteBillScenarioUsageModificationError"} - }, - "BatchDeleteBillScenarioUsageModificationRequest":{ - "type":"structure", - "required":[ - "billScenarioId", - "ids" - ], - "members":{ - "billScenarioId":{ - "shape":"ResourceId", - "documentation":"

The ID of the Bill Scenario for which you want to delete the modeled usage.

" - }, - "ids":{ - "shape":"BatchDeleteBillScenarioUsageModificationEntries", - "documentation":"

List of usage that you want to delete from the Bill Scenario.

" - } - } - }, - "BatchDeleteBillScenarioUsageModificationResponse":{ - "type":"structure", - "members":{ - "errors":{ - "shape":"BatchDeleteBillScenarioUsageModificationErrors", - "documentation":"

Returns the list of errors reason and the usage item keys that cannot be deleted from the Bill Scenario.

" - } - } - }, - "BatchDeleteWorkloadEstimateUsageEntries":{ - "type":"list", - "member":{"shape":"ResourceId"}, - "max":25, - "min":1 - }, - "BatchDeleteWorkloadEstimateUsageError":{ - "type":"structure", - "members":{ - "id":{ - "shape":"ResourceId", - "documentation":"

The ID of the error.

" - }, - "errorMessage":{ - "shape":"String", - "documentation":"

The message that describes the error.

" - }, - "errorCode":{ - "shape":"WorkloadEstimateUpdateUsageErrorCode", - "documentation":"

The code associated with the error.

" - } - }, - "documentation":"

Represents an error that occurred when deleting usage in a workload estimate.

" - }, - "BatchDeleteWorkloadEstimateUsageErrors":{ - "type":"list", - "member":{"shape":"BatchDeleteWorkloadEstimateUsageError"} - }, - "BatchDeleteWorkloadEstimateUsageRequest":{ - "type":"structure", - "required":[ - "workloadEstimateId", - "ids" - ], - "members":{ - "workloadEstimateId":{ - "shape":"ResourceId", - "documentation":"

The ID of the Workload estimate for which you want to delete the modeled usage.

" - }, - "ids":{ - "shape":"BatchDeleteWorkloadEstimateUsageEntries", - "documentation":"

List of usage that you want to delete from the Workload estimate.

" - } - } - }, - "BatchDeleteWorkloadEstimateUsageResponse":{ - "type":"structure", - "members":{ - "errors":{ - "shape":"BatchDeleteWorkloadEstimateUsageErrors", - "documentation":"

Returns the list of errors reason and the usage item keys that cannot be deleted from the Workload estimate.

" - } - } - }, - "BatchUpdateBillScenarioCommitmentModificationEntries":{ - "type":"list", - "member":{"shape":"BatchUpdateBillScenarioCommitmentModificationEntry"}, - "max":25, - "min":1 - }, - "BatchUpdateBillScenarioCommitmentModificationEntry":{ - "type":"structure", - "required":["id"], - "members":{ - "id":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the commitment modification to update.

" - }, - "group":{ - "shape":"UsageGroup", - "documentation":"

The updated group identifier for the commitment modification.

" - } - }, - "documentation":"

Represents an entry in a batch operation to update bill scenario commitment modifications.

" - }, - "BatchUpdateBillScenarioCommitmentModificationError":{ - "type":"structure", - "members":{ - "id":{ - "shape":"ResourceId", - "documentation":"

The ID of the error.

" - }, - "errorCode":{ - "shape":"BatchUpdateBillScenarioCommitmentModificationErrorCode", - "documentation":"

The code associated with the error.

" - }, - "errorMessage":{ - "shape":"String", - "documentation":"

The message that describes the error.

" - } - }, - "documentation":"

Represents an error that occurred when updating a commitment in a Bill Scenario.

" - }, - "BatchUpdateBillScenarioCommitmentModificationErrorCode":{ - "type":"string", - "enum":[ - "BAD_REQUEST", - "NOT_FOUND", - "CONFLICT", - "INTERNAL_SERVER_ERROR" - ] - }, - "BatchUpdateBillScenarioCommitmentModificationErrors":{ - "type":"list", - "member":{"shape":"BatchUpdateBillScenarioCommitmentModificationError"} - }, - "BatchUpdateBillScenarioCommitmentModificationRequest":{ - "type":"structure", - "required":[ - "billScenarioId", - "commitmentModifications" - ], - "members":{ - "billScenarioId":{ - "shape":"ResourceId", - "documentation":"

The ID of the Bill Scenario for which you want to modify the commitment group of a modeled commitment.

" - }, - "commitmentModifications":{ - "shape":"BatchUpdateBillScenarioCommitmentModificationEntries", - "documentation":"

List of commitments that you want to update in a Bill Scenario.

" - } - } - }, - "BatchUpdateBillScenarioCommitmentModificationResponse":{ - "type":"structure", - "members":{ - "items":{ - "shape":"BillScenarioCommitmentModificationItems", - "documentation":"

Returns the list of successful commitment line items that were updated for a Bill Scenario.

" - }, - "errors":{ - "shape":"BatchUpdateBillScenarioCommitmentModificationErrors", - "documentation":"

Returns the list of error reasons and commitment line item IDs that could not be updated for the Bill Scenario.

" - } - } - }, - "BatchUpdateBillScenarioUsageModificationEntries":{ - "type":"list", - "member":{"shape":"BatchUpdateBillScenarioUsageModificationEntry"}, - "max":25, - "min":1 - }, - "BatchUpdateBillScenarioUsageModificationEntry":{ - "type":"structure", - "required":["id"], - "members":{ - "id":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the usage modification to update.

" - }, - "group":{ - "shape":"UsageGroup", - "documentation":"

The updated group identifier for the usage modification.

" - }, - "amounts":{ - "shape":"UsageAmounts", - "documentation":"

The updated usage amounts for the modification.

" - } - }, - "documentation":"

Represents an entry in a batch operation to update bill scenario usage modifications.

" - }, - "BatchUpdateBillScenarioUsageModificationError":{ - "type":"structure", - "members":{ - "id":{ - "shape":"ResourceId", - "documentation":"

The ID of the error.

" - }, - "errorMessage":{ - "shape":"String", - "documentation":"

The message that describes the error.

" - }, - "errorCode":{ - "shape":"BatchUpdateBillScenarioUsageModificationErrorCode", - "documentation":"

The code associated with the error.

" - } - }, - "documentation":"

Represents an error that occurred when updating usage in a Bill Scenario.

" - }, - "BatchUpdateBillScenarioUsageModificationErrorCode":{ - "type":"string", - "enum":[ - "BAD_REQUEST", - "NOT_FOUND", - "CONFLICT", - "INTERNAL_SERVER_ERROR" - ] - }, - "BatchUpdateBillScenarioUsageModificationErrors":{ - "type":"list", - "member":{"shape":"BatchUpdateBillScenarioUsageModificationError"} - }, - "BatchUpdateBillScenarioUsageModificationRequest":{ - "type":"structure", - "required":[ - "billScenarioId", - "usageModifications" - ], - "members":{ - "billScenarioId":{ - "shape":"ResourceId", - "documentation":"

The ID of the Bill Scenario for which you want to modify the usage lines.

" - }, - "usageModifications":{ - "shape":"BatchUpdateBillScenarioUsageModificationEntries", - "documentation":"

List of usage lines that you want to update in a Bill Scenario identified by the usage ID.

" - } - } - }, - "BatchUpdateBillScenarioUsageModificationResponse":{ - "type":"structure", - "members":{ - "items":{ - "shape":"BillScenarioUsageModificationItems", - "documentation":"

Returns the list of successful usage line items that were updated for a Bill Scenario.

" - }, - "errors":{ - "shape":"BatchUpdateBillScenarioUsageModificationErrors", - "documentation":"

Returns the list of error reasons and usage line item IDs that could not be updated for the Bill Scenario.

" - } - } - }, - "BatchUpdateWorkloadEstimateUsageEntries":{ - "type":"list", - "member":{"shape":"BatchUpdateWorkloadEstimateUsageEntry"}, - "max":25, - "min":1 - }, - "BatchUpdateWorkloadEstimateUsageEntry":{ - "type":"structure", - "required":["id"], - "members":{ - "id":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the usage estimate to update.

" - }, - "group":{ - "shape":"UsageGroup", - "documentation":"

The updated group identifier for the usage estimate.

" - }, - "amount":{ - "shape":"Double", - "documentation":"

The updated estimated usage amount.

" - } - }, - "documentation":"

Represents an entry in a batch operation to update workload estimate usage.

" - }, - "BatchUpdateWorkloadEstimateUsageError":{ - "type":"structure", - "members":{ - "id":{ - "shape":"ResourceId", - "documentation":"

The ID of the error.

" - }, - "errorMessage":{ - "shape":"String", - "documentation":"

The message that describes the error.

" - }, - "errorCode":{ - "shape":"WorkloadEstimateUpdateUsageErrorCode", - "documentation":"

The code associated with the error.

" - } - }, - "documentation":"

Represents an error that occurred when updating usage in a workload estimate.

" - }, - "BatchUpdateWorkloadEstimateUsageErrors":{ - "type":"list", - "member":{"shape":"BatchUpdateWorkloadEstimateUsageError"} - }, - "BatchUpdateWorkloadEstimateUsageRequest":{ - "type":"structure", - "required":[ - "workloadEstimateId", - "usage" - ], - "members":{ - "workloadEstimateId":{ - "shape":"ResourceId", - "documentation":"

The ID of the Workload estimate for which you want to modify the usage lines.

" - }, - "usage":{ - "shape":"BatchUpdateWorkloadEstimateUsageEntries", - "documentation":"

List of usage line amounts and usage group that you want to update in a Workload estimate identified by the usage ID.

" - } - } - }, - "BatchUpdateWorkloadEstimateUsageResponse":{ - "type":"structure", - "members":{ - "items":{ - "shape":"WorkloadEstimateUsageItems", - "documentation":"

Returns the list of successful usage line items that were updated for a Workload estimate.

" - }, - "errors":{ - "shape":"BatchUpdateWorkloadEstimateUsageErrors", - "documentation":"

Returns the list of error reasons and usage line item IDs that could not be updated for the Workload estimate.

" - } - } - }, - "BillEstimateCommitmentSummaries":{ - "type":"list", - "member":{"shape":"BillEstimateCommitmentSummary"} - }, - "BillEstimateCommitmentSummary":{ - "type":"structure", - "members":{ - "id":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the commitment.

" - }, - "purchaseAgreementType":{ - "shape":"PurchaseAgreementType", - "documentation":"

The type of purchase agreement (e.g., Reserved Instance, Savings Plan).

" - }, - "offeringId":{ - "shape":"Uuid", - "documentation":"

The identifier of the specific offering associated with this commitment.

" - }, - "usageAccountId":{ - "shape":"AccountId", - "documentation":"

The Amazon Web Services account ID associated with this commitment.

" - }, - "region":{ - "shape":"String", - "documentation":"

The Amazon Web Services region associated with this commitment.

" - }, - "termLength":{ - "shape":"String", - "documentation":"

The length of the commitment term.

" - }, - "paymentOption":{ - "shape":"String", - "documentation":"

The payment option chosen for this commitment (e.g., All Upfront, Partial Upfront, No Upfront).

" - }, - "upfrontPayment":{ - "shape":"CostAmount", - "documentation":"

The upfront payment amount for this commitment, if applicable.

" - }, - "monthlyPayment":{ - "shape":"CostAmount", - "documentation":"

The monthly payment amount for this commitment, if applicable.

" - } - }, - "documentation":"

Provides a summary of commitment-related information for a bill estimate.

" - }, - "BillEstimateCostSummary":{ - "type":"structure", - "members":{ - "totalCostDifference":{ - "shape":"CostDifference", - "documentation":"

The total difference in cost between the estimated and historical costs.

" - }, - "serviceCostDifferences":{ - "shape":"ServiceCostDifferenceMap", - "documentation":"

A breakdown of cost differences by Amazon Web Services service.

" - } - }, - "documentation":"

Provides a summary of cost-related information for a bill estimate.

" - }, - "BillEstimateInputCommitmentModificationSummaries":{ - "type":"list", - "member":{"shape":"BillEstimateInputCommitmentModificationSummary"} - }, - "BillEstimateInputCommitmentModificationSummary":{ - "type":"structure", - "members":{ - "id":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the commitment modification.

" - }, - "group":{ - "shape":"UsageGroup", - "documentation":"

The group identifier for the commitment modification.

" - }, - "usageAccountId":{ - "shape":"AccountId", - "documentation":"

The Amazon Web Services account ID associated with this commitment modification.

" - }, - "commitmentAction":{ - "shape":"BillScenarioCommitmentModificationAction", - "documentation":"

The specific commitment action taken in this modification.

" - } - }, - "documentation":"

Summarizes an input commitment modification for a bill estimate.

" - }, - "BillEstimateInputUsageModificationSummaries":{ - "type":"list", - "member":{"shape":"BillEstimateInputUsageModificationSummary"} - }, - "BillEstimateInputUsageModificationSummary":{ - "type":"structure", - "required":[ - "serviceCode", - "usageType", - "operation" - ], - "members":{ - "serviceCode":{ - "shape":"ServiceCode", - "documentation":"

The Amazon Web Services service code for this usage modification.

" - }, - "usageType":{ - "shape":"UsageType", - "documentation":"

The type of usage being modified.

" - }, - "operation":{ - "shape":"Operation", - "documentation":"

The specific operation associated with this usage modification.

" - }, - "location":{ - "shape":"String", - "documentation":"

The location associated with this usage modification.

" - }, - "availabilityZone":{ - "shape":"AvailabilityZone", - "documentation":"

The availability zone associated with this usage modification, if applicable.

" - }, - "id":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the usage modification.

" - }, - "group":{ - "shape":"UsageGroup", - "documentation":"

The group identifier for the usage modification.

" - }, - "usageAccountId":{ - "shape":"AccountId", - "documentation":"

The Amazon Web Services account ID associated with this usage modification.

" - }, - "quantities":{ - "shape":"UsageQuantities", - "documentation":"

The modified usage quantities.

" - }, - "historicalUsage":{ - "shape":"HistoricalUsageEntity", - "documentation":"

Historical usage data associated with this modification, if available.

" - } - }, - "documentation":"

Summarizes an input usage modification for a bill estimate.

" - }, - "BillEstimateLineItemSummaries":{ - "type":"list", - "member":{"shape":"BillEstimateLineItemSummary"} - }, - "BillEstimateLineItemSummary":{ - "type":"structure", - "required":[ - "serviceCode", - "usageType", - "operation" - ], - "members":{ - "serviceCode":{ - "shape":"ServiceCode", - "documentation":"

The Amazon Web Services service code associated with this line item.

" - }, - "usageType":{ - "shape":"UsageType", - "documentation":"

The type of usage for this line item.

" - }, - "operation":{ - "shape":"Operation", - "documentation":"

The specific operation associated with this line item.

" - }, - "location":{ - "shape":"String", - "documentation":"

The location associated with this line item.

" - }, - "availabilityZone":{ - "shape":"AvailabilityZone", - "documentation":"

The availability zone associated with this line item, if applicable.

" - }, - "id":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of this line item.

" - }, - "lineItemId":{ - "shape":"String", - "documentation":"

The line item identifier from the original bill.

" - }, - "lineItemType":{ - "shape":"String", - "documentation":"

The type of this line item (e.g., Usage, Tax, Credit).

" - }, - "payerAccountId":{ - "shape":"AccountId", - "documentation":"

The Amazon Web Services account ID of the payer for this line item.

" - }, - "usageAccountId":{ - "shape":"AccountId", - "documentation":"

The Amazon Web Services account ID associated with the usage for this line item.

" - }, - "estimatedUsageQuantity":{ - "shape":"UsageQuantityResult", - "documentation":"

The estimated usage quantity for this line item.

" - }, - "estimatedCost":{ - "shape":"CostAmount", - "documentation":"

The estimated cost for this line item.

" - }, - "historicalUsageQuantity":{ - "shape":"UsageQuantityResult", - "documentation":"

The historical usage quantity for this line item.

" - }, - "historicalCost":{ - "shape":"CostAmount", - "documentation":"

The historical cost for this line item.

" - }, - "savingsPlanArns":{ - "shape":"SavingsPlanArns", - "documentation":"

The Amazon Resource Names (ARNs) of any Savings Plans applied to this line item.

" - } - }, - "documentation":"

Provides a summary of a line item in a bill estimate.

" - }, - "BillEstimateName":{ - "type":"string", - "max":64, - "min":0, - "pattern":"[a-zA-Z0-9-]+" - }, - "BillEstimateStatus":{ - "type":"string", - "enum":[ - "IN_PROGRESS", - "COMPLETE", - "FAILED" - ] - }, - "BillEstimateSummaries":{ - "type":"list", - "member":{"shape":"BillEstimateSummary"} - }, - "BillEstimateSummary":{ - "type":"structure", - "required":["id"], - "members":{ - "id":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the bill estimate.

" - }, - "name":{ - "shape":"BillEstimateName", - "documentation":"

The name of the bill estimate.

" - }, - "status":{ - "shape":"BillEstimateStatus", - "documentation":"

The current status of the bill estimate.

" - }, - "billInterval":{ - "shape":"BillInterval", - "documentation":"

The time period covered by the bill estimate.

" - }, - "createdAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the bill estimate was created.

" - }, - "expiresAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the bill estimate will expire.

" - } - }, - "documentation":"

Provides a summary of a bill estimate.

" - }, - "BillInterval":{ - "type":"structure", - "members":{ - "start":{ - "shape":"Timestamp", - "documentation":"

The start date and time of the interval.

" - }, - "end":{ - "shape":"Timestamp", - "documentation":"

The end date and time of the interval.

" - } - }, - "documentation":"

Represents a time interval for a bill or estimate.

" - }, - "BillScenarioCommitmentModificationAction":{ - "type":"structure", - "members":{ - "addReservedInstanceAction":{ - "shape":"AddReservedInstanceAction", - "documentation":"

Action to add a Reserved Instance to the scenario.

" - }, - "addSavingsPlanAction":{ - "shape":"AddSavingsPlanAction", - "documentation":"

Action to add a Savings Plan to the scenario.

" - }, - "negateReservedInstanceAction":{ - "shape":"NegateReservedInstanceAction", - "documentation":"

Action to remove a Reserved Instance from the scenario.

" - }, - "negateSavingsPlanAction":{ - "shape":"NegateSavingsPlanAction", - "documentation":"

Action to remove a Savings Plan from the scenario.

" - } - }, - "documentation":"

Represents an action to modify commitments in a bill scenario.

", - "union":true - }, - "BillScenarioCommitmentModificationItem":{ - "type":"structure", - "members":{ - "id":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the commitment modification.

" - }, - "usageAccountId":{ - "shape":"AccountId", - "documentation":"

The Amazon Web Services account ID associated with this commitment modification.

" - }, - "group":{ - "shape":"UsageGroup", - "documentation":"

The group identifier for the commitment modification.

" - }, - "commitmentAction":{ - "shape":"BillScenarioCommitmentModificationAction", - "documentation":"

The specific commitment action taken in this modification.

" - } - }, - "documentation":"

Represents a commitment modification item in a bill scenario.

" - }, - "BillScenarioCommitmentModificationItems":{ - "type":"list", - "member":{"shape":"BillScenarioCommitmentModificationItem"} - }, - "BillScenarioName":{ - "type":"string", - "max":64, - "min":0, - "pattern":"[a-zA-Z0-9-]+" - }, - "BillScenarioStatus":{ - "type":"string", - "enum":[ - "READY", - "LOCKED", - "FAILED", - "STALE" - ] - }, - "BillScenarioSummaries":{ - "type":"list", - "member":{"shape":"BillScenarioSummary"} - }, - "BillScenarioSummary":{ - "type":"structure", - "required":["id"], - "members":{ - "id":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the bill scenario.

" - }, - "name":{ - "shape":"BillScenarioName", - "documentation":"

The name of the bill scenario.

" - }, - "billInterval":{ - "shape":"BillInterval", - "documentation":"

The time period covered by the bill scenario.

" - }, - "status":{ - "shape":"BillScenarioStatus", - "documentation":"

The current status of the bill scenario.

" - }, - "createdAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the bill scenario was created.

" - }, - "expiresAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the bill scenario will expire.

" - }, - "failureMessage":{ - "shape":"String", - "documentation":"

An error message if the bill scenario creation or processing failed.

" - }, - "groupSharingPreference":{ - "shape":"GroupSharingPreferenceEnum", - "documentation":"

The setting for the reserved instance and savings plan group sharing used in this estimate.

" - }, - "costCategoryGroupSharingPreferenceArn":{ - "shape":"CostCategoryArn", - "documentation":"

The arn of the cost category used in the reserved and prioritized group sharing.

" - } - }, - "documentation":"

Provides a summary of a bill scenario.

" - }, - "BillScenarioUsageModificationItem":{ - "type":"structure", - "required":[ - "serviceCode", - "usageType", - "operation" - ], - "members":{ - "serviceCode":{ - "shape":"ServiceCode", - "documentation":"

The Amazon Web Services service code for this usage modification.

" - }, - "usageType":{ - "shape":"UsageType", - "documentation":"

The type of usage being modified.

" - }, - "operation":{ - "shape":"Operation", - "documentation":"

The specific operation associated with this usage modification.

" - }, - "location":{ - "shape":"String", - "documentation":"

The location associated with this usage modification.

" - }, - "availabilityZone":{ - "shape":"AvailabilityZone", - "documentation":"

The availability zone associated with this usage modification, if applicable.

" - }, - "id":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the usage modification.

" - }, - "group":{ - "shape":"UsageGroup", - "documentation":"

The group identifier for the usage modification.

" - }, - "usageAccountId":{ - "shape":"AccountId", - "documentation":"

The Amazon Web Services account ID associated with this usage modification.

" - }, - "quantities":{ - "shape":"UsageQuantities", - "documentation":"

The modified usage quantities.

" - }, - "historicalUsage":{ - "shape":"HistoricalUsageEntity", - "documentation":"

Historical usage data associated with this modification, if available.

" - } - }, - "documentation":"

Represents a usage modification item in a bill scenario.

" - }, - "BillScenarioUsageModificationItems":{ - "type":"list", - "member":{"shape":"BillScenarioUsageModificationItem"} - }, - "ClientToken":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[\\u0021-\\u007E]+" - }, - "ConflictException":{ - "type":"structure", - "required":[ - "message", - "resourceId", - "resourceType" - ], - "members":{ - "message":{"shape":"String"}, - "resourceId":{ - "shape":"String", - "documentation":"

The identifier of the resource that was not found.

" - }, - "resourceType":{ - "shape":"String", - "documentation":"

The type of the resource that was not found.

" - } - }, - "documentation":"

The request could not be processed because of conflict in the current state of the resource.

", - "exception":true - }, - "CostAmount":{ - "type":"structure", - "members":{ - "amount":{ - "shape":"Double", - "documentation":"

The numeric value of the cost.

" - }, - "currency":{ - "shape":"CurrencyCode", - "documentation":"

The currency code for the cost amount.

" - } - }, - "documentation":"

Represents a monetary amount with associated currency.

" - }, - "CostCategoryArn":{ - "type":"string", - "max":2048, - "min":20, - "pattern":"arn:aws[-a-z0-9]*:ce::[0-9]{12}:costcategory/[a-f0-9-]{36}" - }, - "CostDifference":{ - "type":"structure", - "members":{ - "historicalCost":{ - "shape":"CostAmount", - "documentation":"

The historical cost amount.

" - }, - "estimatedCost":{ - "shape":"CostAmount", - "documentation":"

The estimated cost amount.

" - } - }, - "documentation":"

Represents the difference between historical and estimated costs.

" - }, - "CreateBillEstimateRequest":{ - "type":"structure", - "required":[ - "billScenarioId", - "name" - ], - "members":{ - "billScenarioId":{ - "shape":"ResourceId", - "documentation":"

The ID of the Bill Scenario for which you want to create a Bill estimate.

" - }, - "name":{ - "shape":"BillEstimateName", - "documentation":"

The name of the Bill estimate that will be created. Names must be unique for an account.

" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", - "idempotencyToken":true - }, - "tags":{ - "shape":"Tags", - "documentation":"

An optional list of tags to associate with the specified BillEstimate. You can use resource tags to control access to your BillEstimate using IAM policies. Each tag consists of a key and a value, and each key must be unique for the resource. The following restrictions apply to resource tags:

  • Although the maximum number of array members is 200, you can assign a maximum of 50 user-tags to one resource. The remaining are reserved for Amazon Web Services.

  • The maximum length of a key is 128 characters.

  • The maximum length of a value is 256 characters.

  • Keys and values can only contain alphanumeric characters, spaces, and any of the following: _.:/=+@-.

  • Keys and values are case sensitive.

  • Keys and values are trimmed for any leading or trailing whitespaces.

  • Don't use aws: as a prefix for your keys. This prefix is reserved for Amazon Web Services.

" - } - } - }, - "CreateBillEstimateResponse":{ - "type":"structure", - "required":["id"], - "members":{ - "id":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of your newly created Bill estimate.

" - }, - "name":{ - "shape":"BillEstimateName", - "documentation":"

The name of your newly created Bill estimate.

" - }, - "status":{ - "shape":"BillEstimateStatus", - "documentation":"

The status of your newly created Bill estimate. Bill estimate creation can take anywhere between 8 to 12 hours. The status will allow you to identify when the Bill estimate is complete or has failed.

" - }, - "failureMessage":{ - "shape":"String", - "documentation":"

This attribute provides the reason if a Bill estimate result generation fails.

" - }, - "billInterval":{ - "shape":"BillInterval", - "documentation":"

The bill month start and end timestamp that was used to create the Bill estimate. This is set to the last complete anniversary bill month start and end timestamp.

" - }, - "costSummary":{ - "shape":"BillEstimateCostSummary", - "documentation":"

Returns summary-level cost information once a Bill estimate is successfully generated. This summary includes: 1) the total cost difference, showing the pre-tax cost change for the consolidated billing family between the completed anniversary bill and the estimated bill, and 2) total cost differences per service, detailing the pre-tax cost of each service, comparing the completed anniversary bill to the estimated bill on a per-service basis.

" - }, - "createdAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp of when the Bill estimate create process was started (not when it successfully completed or failed).

" - }, - "expiresAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp of when the Bill estimate will expire. A Bill estimate becomes inaccessible after expiration.

" - }, - "groupSharingPreference":{ - "shape":"GroupSharingPreferenceEnum", - "documentation":"

The setting for the reserved instance and savings plan group sharing used in this estimate.

" - }, - "costCategoryGroupSharingPreferenceArn":{ - "shape":"CostCategoryArn", - "documentation":"

The arn of the cost category used in the reserved and prioritized group sharing.

" - }, - "costCategoryGroupSharingPreferenceEffectiveDate":{ - "shape":"Timestamp", - "documentation":"

Timestamp of the effective date of the cost category used in the group sharing settings.

" - } - } - }, - "CreateBillScenarioRequest":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{ - "shape":"BillScenarioName", - "documentation":"

A descriptive name for the bill scenario.

" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure idempotency of the request.

", - "idempotencyToken":true - }, - "tags":{ - "shape":"Tags", - "documentation":"

The tags to apply to the bill scenario.

" - }, - "groupSharingPreference":{ - "shape":"GroupSharingPreferenceEnum", - "documentation":"

The setting for the reserved instance and savings plan group sharing used in this estimate.

" - }, - "costCategoryGroupSharingPreferenceArn":{ - "shape":"CostCategoryArn", - "documentation":"

The arn of the cost category used in the reserved and prioritized group sharing.

" - } - } - }, - "CreateBillScenarioResponse":{ - "type":"structure", - "required":["id"], - "members":{ - "id":{ - "shape":"ResourceId", - "documentation":"

The unique identifier for the created bill scenario.

" - }, - "name":{ - "shape":"BillScenarioName", - "documentation":"

The name of the created bill scenario.

" - }, - "billInterval":{ - "shape":"BillInterval", - "documentation":"

The time period covered by the bill scenario.

" - }, - "status":{ - "shape":"BillScenarioStatus", - "documentation":"

The current status of the bill scenario.

" - }, - "createdAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the bill scenario was created.

" - }, - "expiresAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the bill scenario will expire.

" - }, - "failureMessage":{ - "shape":"String", - "documentation":"

An error message if the bill scenario creation failed.

" - }, - "groupSharingPreference":{ - "shape":"GroupSharingPreferenceEnum", - "documentation":"

The setting for the reserved instance and savings plan group sharing used in this estimate.

" - }, - "costCategoryGroupSharingPreferenceArn":{ - "shape":"CostCategoryArn", - "documentation":"

The arn of the cost category used in the reserved and prioritized group sharing.

" - } - } - }, - "CreateWorkloadEstimateRequest":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{ - "shape":"WorkloadEstimateName", - "documentation":"

A descriptive name for the workload estimate.

" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure idempotency of the request.

", - "idempotencyToken":true - }, - "rateType":{ - "shape":"WorkloadEstimateRateType", - "documentation":"

The type of pricing rates to use for the estimate.

" - }, - "tags":{ - "shape":"Tags", - "documentation":"

The tags to apply to the workload estimate.

" - } - } - }, - "CreateWorkloadEstimateResponse":{ - "type":"structure", - "required":["id"], - "members":{ - "id":{ - "shape":"ResourceId", - "documentation":"

The unique identifier for the created workload estimate.

" - }, - "name":{ - "shape":"WorkloadEstimateName", - "documentation":"

The name of the created workload estimate.

" - }, - "createdAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the workload estimate was created.

" - }, - "expiresAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the workload estimate will expire.

" - }, - "rateType":{ - "shape":"WorkloadEstimateRateType", - "documentation":"

The type of pricing rates used for the estimate.

" - }, - "rateTimestamp":{ - "shape":"Timestamp", - "documentation":"

The timestamp of the pricing rates used for the estimate.

" - }, - "status":{ - "shape":"WorkloadEstimateStatus", - "documentation":"

The current status of the workload estimate.

" - }, - "totalCost":{ - "shape":"Double", - "documentation":"

The total estimated cost for the workload.

" - }, - "costCurrency":{ - "shape":"CurrencyCode", - "documentation":"

The currency of the estimated cost.

" - }, - "failureMessage":{ - "shape":"String", - "documentation":"

An error message if the workload estimate creation failed.

" - } - }, - "documentation":"

Mixin for common fields returned by CRUD APIs

" - }, - "CurrencyCode":{ - "type":"string", - "enum":["USD"] - }, - "DataUnavailableException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"} - }, - "documentation":"

The requested data is currently unavailable.

", - "exception":true - }, - "DeleteBillEstimateRequest":{ - "type":"structure", - "required":["identifier"], - "members":{ - "identifier":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the bill estimate to delete.

" - } - } - }, - "DeleteBillEstimateResponse":{ - "type":"structure", - "members":{} - }, - "DeleteBillScenarioRequest":{ - "type":"structure", - "required":["identifier"], - "members":{ - "identifier":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the bill scenario to delete.

" - } - } - }, - "DeleteBillScenarioResponse":{ - "type":"structure", - "members":{} - }, - "DeleteWorkloadEstimateRequest":{ - "type":"structure", - "required":["identifier"], - "members":{ - "identifier":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the workload estimate to delete.

" - } - } - }, - "DeleteWorkloadEstimateResponse":{ - "type":"structure", - "members":{} - }, - "Double":{ - "type":"double", - "box":true - }, - "Expression":{ - "type":"structure", - "members":{ - "and":{ - "shape":"ExpressionList", - "documentation":"

A list of expressions to be combined with AND logic.

" - }, - "or":{ - "shape":"ExpressionList", - "documentation":"

A list of expressions to be combined with OR logic.

" - }, - "not":{ - "shape":"Expression", - "documentation":"

An expression to be negated.

" - }, - "costCategories":{ - "shape":"ExpressionFilter", - "documentation":"

Filters based on cost categories.

" - }, - "dimensions":{ - "shape":"ExpressionFilter", - "documentation":"

Filters based on dimensions (e.g., service, operation).

" - }, - "tags":{ - "shape":"ExpressionFilter", - "documentation":"

Filters based on resource tags.

" - } - }, - "documentation":"

Represents a complex filtering expression for cost and usage data.

" - }, - "ExpressionFilter":{ - "type":"structure", - "members":{ - "key":{ - "shape":"String", - "documentation":"

The key or attribute to filter on.

" - }, - "matchOptions":{ - "shape":"StringList", - "documentation":"

The match options for the filter (e.g., equals, contains).

" - }, - "values":{ - "shape":"StringList", - "documentation":"

The values to match against.

" - } - }, - "documentation":"

Represents a filter used within an expression.

" - }, - "ExpressionList":{ - "type":"list", - "member":{"shape":"Expression"} - }, - "FilterTimestamp":{ - "type":"structure", - "members":{ - "afterTimestamp":{ - "shape":"Timestamp", - "documentation":"

Include results after this timestamp.

" - }, - "beforeTimestamp":{ - "shape":"Timestamp", - "documentation":"

Include results before this timestamp.

" - } - }, - "documentation":"

Represents a time-based filter.

" - }, - "GetBillEstimateRequest":{ - "type":"structure", - "required":["identifier"], - "members":{ - "identifier":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the bill estimate to retrieve.

" - } - } - }, - "GetBillEstimateResponse":{ - "type":"structure", - "required":["id"], - "members":{ - "id":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the retrieved bill estimate.

" - }, - "name":{ - "shape":"BillEstimateName", - "documentation":"

The name of the retrieved bill estimate.

" - }, - "status":{ - "shape":"BillEstimateStatus", - "documentation":"

The current status of the bill estimate.

" - }, - "failureMessage":{ - "shape":"String", - "documentation":"

An error message if the bill estimate retrieval failed.

" - }, - "billInterval":{ - "shape":"BillInterval", - "documentation":"

The time period covered by the bill estimate.

" - }, - "costSummary":{ - "shape":"BillEstimateCostSummary", - "documentation":"

A summary of the estimated costs.

" - }, - "createdAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the bill estimate was created.

" - }, - "expiresAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the bill estimate will expire.

" - }, - "groupSharingPreference":{ - "shape":"GroupSharingPreferenceEnum", - "documentation":"

The setting for the reserved instance and savings plan group sharing used in this estimate.

" - }, - "costCategoryGroupSharingPreferenceArn":{ - "shape":"CostCategoryArn", - "documentation":"

The arn of the cost category used in the reserved and prioritized group sharing.

" - }, - "costCategoryGroupSharingPreferenceEffectiveDate":{ - "shape":"Timestamp", - "documentation":"

Timestamp of the effective date of the cost category used in the group sharing settings.

" - } - } - }, - "GetBillScenarioRequest":{ - "type":"structure", - "required":["identifier"], - "members":{ - "identifier":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the bill scenario to retrieve.

" - } - } - }, - "GetBillScenarioResponse":{ - "type":"structure", - "required":["id"], - "members":{ - "id":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the retrieved bill scenario.

" - }, - "name":{ - "shape":"BillScenarioName", - "documentation":"

The name of the retrieved bill scenario.

" - }, - "billInterval":{ - "shape":"BillInterval", - "documentation":"

The time period covered by the bill scenario.

" - }, - "status":{ - "shape":"BillScenarioStatus", - "documentation":"

The current status of the bill scenario.

" - }, - "createdAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the bill scenario was created.

" - }, - "expiresAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the bill scenario will expire.

" - }, - "failureMessage":{ - "shape":"String", - "documentation":"

An error message if the bill scenario retrieval failed.

" - }, - "groupSharingPreference":{ - "shape":"GroupSharingPreferenceEnum", - "documentation":"

The setting for the reserved instance and savings plan group sharing used in this estimate.

" - }, - "costCategoryGroupSharingPreferenceArn":{ - "shape":"CostCategoryArn", - "documentation":"

The arn of the cost category used in the reserved and prioritized group sharing.

" - } - } - }, - "GetPreferencesRequest":{ - "type":"structure", - "members":{} - }, - "GetPreferencesResponse":{ - "type":"structure", - "members":{ - "managementAccountRateTypeSelections":{ - "shape":"RateTypes", - "documentation":"

The preferred rate types for the management account.

" - }, - "memberAccountRateTypeSelections":{ - "shape":"RateTypes", - "documentation":"

The preferred rate types for member accounts.

" - }, - "standaloneAccountRateTypeSelections":{ - "shape":"RateTypes", - "documentation":"

The preferred rate types for a standalone account.

" - } - } - }, - "GetWorkloadEstimateRequest":{ - "type":"structure", - "required":["identifier"], - "members":{ - "identifier":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the workload estimate to retrieve.

" - } - } - }, - "GetWorkloadEstimateResponse":{ - "type":"structure", - "required":["id"], - "members":{ - "id":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the retrieved workload estimate.

" - }, - "name":{ - "shape":"WorkloadEstimateName", - "documentation":"

The name of the retrieved workload estimate.

" - }, - "createdAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the workload estimate was created.

" - }, - "expiresAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the workload estimate will expire.

" - }, - "rateType":{ - "shape":"WorkloadEstimateRateType", - "documentation":"

The type of pricing rates used for the estimate.

" - }, - "rateTimestamp":{ - "shape":"Timestamp", - "documentation":"

The timestamp of the pricing rates used for the estimate.

" - }, - "status":{ - "shape":"WorkloadEstimateStatus", - "documentation":"

The current status of the workload estimate.

" - }, - "totalCost":{ - "shape":"Double", - "documentation":"

The total estimated cost for the workload.

" - }, - "costCurrency":{ - "shape":"CurrencyCode", - "documentation":"

The currency of the estimated cost.

" - }, - "failureMessage":{ - "shape":"String", - "documentation":"

An error message if the workload estimate retrieval failed.

" - } - }, - "documentation":"

Mixin for common fields returned by CRUD APIs

" - }, - "GroupSharingPreferenceEnum":{ - "type":"string", - "enum":[ - "OPEN", - "PRIORITIZED", - "RESTRICTED" - ] - }, - "HistoricalUsageEntity":{ - "type":"structure", - "required":[ - "serviceCode", - "usageType", - "operation", - "usageAccountId", - "billInterval", - "filterExpression" - ], - "members":{ - "serviceCode":{ - "shape":"ServiceCode", - "documentation":"

The Amazon Web Services service code associated with the usage.

" - }, - "usageType":{ - "shape":"UsageType", - "documentation":"

The type of usage.

" - }, - "operation":{ - "shape":"Operation", - "documentation":"

The specific operation associated with the usage.

" - }, - "location":{ - "shape":"String", - "documentation":"

The location associated with the usage.

" - }, - "usageAccountId":{ - "shape":"AccountId", - "documentation":"

The Amazon Web Services account ID associated with the usage.

" - }, - "billInterval":{ - "shape":"BillInterval", - "documentation":"

The time interval for the historical usage data.

" - }, - "filterExpression":{ - "shape":"Expression", - "documentation":"

An optional filter expression to apply to the historical usage data.

" - } - }, - "documentation":"

Represents historical usage data for a specific entity.

" - }, - "Integer":{ - "type":"integer", - "box":true - }, - "InternalServerException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"}, - "retryAfterSeconds":{ - "shape":"Integer", - "documentation":"

An internal error has occurred. Retry your request, but if the problem persists, contact Amazon Web Services support.

" - } - }, - "documentation":"

An internal error has occurred. Retry your request, but if the problem persists, contact Amazon Web Services support.

", - "exception":true, - "fault":true - }, - "Key":{ - "type":"string", - "max":10, - "min":0, - "pattern":"[a-zA-Z0-9]*" - }, - "ListBillEstimateCommitmentsRequest":{ - "type":"structure", - "required":["billEstimateId"], - "members":{ - "billEstimateId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the bill estimate to list commitments for.

" - }, - "nextToken":{ - "shape":"NextPageToken", - "documentation":"

A token to retrieve the next page of results.

" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return per page.

" - } - } - }, - "ListBillEstimateCommitmentsResponse":{ - "type":"structure", - "members":{ - "items":{ - "shape":"BillEstimateCommitmentSummaries", - "documentation":"

The list of commitments associated with the bill estimate.

" - }, - "nextToken":{ - "shape":"NextPageToken", - "documentation":"

A token to retrieve the next page of results, if any.

" - } - } - }, - "ListBillEstimateInputCommitmentModificationsRequest":{ - "type":"structure", - "required":["billEstimateId"], - "members":{ - "billEstimateId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the bill estimate to list input commitment modifications for.

" - }, - "nextToken":{ - "shape":"NextPageToken", - "documentation":"

A token to retrieve the next page of results.

" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return per page.

" - } - } - }, - "ListBillEstimateInputCommitmentModificationsResponse":{ - "type":"structure", - "members":{ - "items":{ - "shape":"BillEstimateInputCommitmentModificationSummaries", - "documentation":"

The list of input commitment modifications associated with the bill estimate.

" - }, - "nextToken":{ - "shape":"NextPageToken", - "documentation":"

A token to retrieve the next page of results, if any.

" - } - } - }, - "ListBillEstimateInputUsageModificationsRequest":{ - "type":"structure", - "required":["billEstimateId"], - "members":{ - "billEstimateId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the bill estimate to list input usage modifications for.

" - }, - "filters":{ - "shape":"ListUsageFilters", - "documentation":"

Filters to apply to the list of input usage modifications.

" - }, - "nextToken":{ - "shape":"NextPageToken", - "documentation":"

A token to retrieve the next page of results.

" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return per page.

" - } - } - }, - "ListBillEstimateInputUsageModificationsResponse":{ - "type":"structure", - "members":{ - "items":{ - "shape":"BillEstimateInputUsageModificationSummaries", - "documentation":"

The list of input usage modifications associated with the bill estimate.

" - }, - "nextToken":{ - "shape":"NextPageToken", - "documentation":"

A token to retrieve the next page of results, if any.

" - } - } - }, - "ListBillEstimateLineItemsFilter":{ - "type":"structure", - "required":[ - "name", - "values" - ], - "members":{ - "name":{ - "shape":"ListBillEstimateLineItemsFilterName", - "documentation":"

The name of the filter attribute.

" - }, - "values":{ - "shape":"ListBillEstimateLineItemsFilterValues", - "documentation":"

The values to filter by.

" - }, - "matchOption":{ - "shape":"MatchOption", - "documentation":"

The match option for the filter (e.g., equals, contains).

" - } - }, - "documentation":"

Represents a filter for listing bill estimate line items.

" - }, - "ListBillEstimateLineItemsFilterName":{ - "type":"string", - "enum":[ - "USAGE_ACCOUNT_ID", - "SERVICE_CODE", - "USAGE_TYPE", - "OPERATION", - "LOCATION", - "LINE_ITEM_TYPE" - ] - }, - "ListBillEstimateLineItemsFilterValues":{ - "type":"list", - "member":{"shape":"String"} - }, - "ListBillEstimateLineItemsFilters":{ - "type":"list", - "member":{"shape":"ListBillEstimateLineItemsFilter"} - }, - "ListBillEstimateLineItemsRequest":{ - "type":"structure", - "required":["billEstimateId"], - "members":{ - "billEstimateId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the bill estimate to list line items for.

" - }, - "filters":{ - "shape":"ListBillEstimateLineItemsFilters", - "documentation":"

Filters to apply to the list of line items.

" - }, - "nextToken":{ - "shape":"NextPageToken", - "documentation":"

A token to retrieve the next page of results.

" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return per page.

" - } - } - }, - "ListBillEstimateLineItemsResponse":{ - "type":"structure", - "members":{ - "items":{ - "shape":"BillEstimateLineItemSummaries", - "documentation":"

The list of line items associated with the bill estimate.

" - }, - "nextToken":{ - "shape":"NextPageToken", - "documentation":"

A token to retrieve the next page of results, if any.

" - } - } - }, - "ListBillEstimatesFilter":{ - "type":"structure", - "required":[ - "name", - "values" - ], - "members":{ - "name":{ - "shape":"ListBillEstimatesFilterName", - "documentation":"

The name of the filter attribute.

" - }, - "values":{ - "shape":"ListBillEstimatesFilterValues", - "documentation":"

The values to filter by.

" - }, - "matchOption":{ - "shape":"MatchOption", - "documentation":"

The match option for the filter (e.g., equals, contains).

" - } - }, - "documentation":"

Represents a filter for listing bill estimates.

" - }, - "ListBillEstimatesFilterName":{ - "type":"string", - "enum":[ - "STATUS", - "NAME" - ] - }, - "ListBillEstimatesFilterValues":{ - "type":"list", - "member":{"shape":"String"} - }, - "ListBillEstimatesFilters":{ - "type":"list", - "member":{"shape":"ListBillEstimatesFilter"} - }, - "ListBillEstimatesRequest":{ - "type":"structure", - "members":{ - "filters":{ - "shape":"ListBillEstimatesFilters", - "documentation":"

Filters to apply to the list of bill estimates.

" - }, - "createdAtFilter":{ - "shape":"FilterTimestamp", - "documentation":"

Filter bill estimates based on the creation date.

" - }, - "expiresAtFilter":{ - "shape":"FilterTimestamp", - "documentation":"

Filter bill estimates based on the expiration date.

" - }, - "nextToken":{ - "shape":"NextPageToken", - "documentation":"

A token to retrieve the next page of results.

" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return per page.

" - } - } - }, - "ListBillEstimatesResponse":{ - "type":"structure", - "members":{ - "items":{ - "shape":"BillEstimateSummaries", - "documentation":"

The list of bill estimates for the account.

" - }, - "nextToken":{ - "shape":"NextPageToken", - "documentation":"

A token to retrieve the next page of results, if any.

" - } - } - }, - "ListBillScenarioCommitmentModificationsRequest":{ - "type":"structure", - "required":["billScenarioId"], - "members":{ - "billScenarioId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the bill scenario to list commitment modifications for.

" - }, - "nextToken":{ - "shape":"NextPageToken", - "documentation":"

A token to retrieve the next page of results.

" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return per page.

" - } - } - }, - "ListBillScenarioCommitmentModificationsResponse":{ - "type":"structure", - "members":{ - "items":{ - "shape":"BillScenarioCommitmentModificationItems", - "documentation":"

The list of commitment modifications associated with the bill scenario.

" - }, - "nextToken":{ - "shape":"NextPageToken", - "documentation":"

A token to retrieve the next page of results, if any.

" - } - } - }, - "ListBillScenarioUsageModificationsRequest":{ - "type":"structure", - "required":["billScenarioId"], - "members":{ - "billScenarioId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the bill scenario to list usage modifications for.

" - }, - "filters":{ - "shape":"ListUsageFilters", - "documentation":"

Filters to apply to the list of usage modifications.

" - }, - "nextToken":{ - "shape":"NextPageToken", - "documentation":"

A token to retrieve the next page of results.

" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return per page.

" - } - } - }, - "ListBillScenarioUsageModificationsResponse":{ - "type":"structure", - "members":{ - "items":{ - "shape":"BillScenarioUsageModificationItems", - "documentation":"

The list of usage modifications associated with the bill scenario.

" - }, - "nextToken":{ - "shape":"NextPageToken", - "documentation":"

A token to retrieve the next page of results, if any.

" - } - } - }, - "ListBillScenariosFilter":{ - "type":"structure", - "required":[ - "name", - "values" - ], - "members":{ - "name":{ - "shape":"ListBillScenariosFilterName", - "documentation":"

The name of the filter attribute.

" - }, - "values":{ - "shape":"ListBillScenariosFilterValues", - "documentation":"

The values to filter by.

" - }, - "matchOption":{ - "shape":"MatchOption", - "documentation":"

The match option for the filter (e.g., equals, contains).

" - } - }, - "documentation":"

Represents a filter for listing bill scenarios.

" - }, - "ListBillScenariosFilterName":{ - "type":"string", - "enum":[ - "STATUS", - "NAME", - "GROUP_SHARING_PREFERENCE", - "COST_CATEGORY_ARN" - ] - }, - "ListBillScenariosFilterValues":{ - "type":"list", - "member":{"shape":"String"} - }, - "ListBillScenariosFilters":{ - "type":"list", - "member":{"shape":"ListBillScenariosFilter"} - }, - "ListBillScenariosRequest":{ - "type":"structure", - "members":{ - "filters":{ - "shape":"ListBillScenariosFilters", - "documentation":"

Filters to apply to the list of bill scenarios.

" - }, - "createdAtFilter":{ - "shape":"FilterTimestamp", - "documentation":"

Filter bill scenarios based on the creation date.

" - }, - "expiresAtFilter":{ - "shape":"FilterTimestamp", - "documentation":"

Filter bill scenarios based on the expiration date.

" - }, - "nextToken":{ - "shape":"NextPageToken", - "documentation":"

A token to retrieve the next page of results.

" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return per page.

" - } - } - }, - "ListBillScenariosResponse":{ - "type":"structure", - "members":{ - "items":{ - "shape":"BillScenarioSummaries", - "documentation":"

The list of bill scenarios for the account.

" - }, - "nextToken":{ - "shape":"NextPageToken", - "documentation":"

A token to retrieve the next page of results, if any.

" - } - } - }, - "ListTagsForResourceRequest":{ - "type":"structure", - "required":["arn"], - "members":{ - "arn":{ - "shape":"Arn", - "documentation":"

The Amazon Resource Name (ARN) of the resource to list tags for.

" - } - } - }, - "ListTagsForResourceResponse":{ - "type":"structure", - "members":{ - "tags":{ - "shape":"Tags", - "documentation":"

The list of tags associated with the specified resource.

" - } - } - }, - "ListUsageFilter":{ - "type":"structure", - "required":[ - "name", - "values" - ], - "members":{ - "name":{ - "shape":"ListUsageFilterName", - "documentation":"

The name of the filter attribute.

" - }, - "values":{ - "shape":"ListUsageFilterValues", - "documentation":"

The values to filter by.

" - }, - "matchOption":{ - "shape":"MatchOption", - "documentation":"

The match option for the filter (e.g., equals, contains).

" - } - }, - "documentation":"

Represents a filter for listing usage data.

" - }, - "ListUsageFilterName":{ - "type":"string", - "enum":[ - "USAGE_ACCOUNT_ID", - "SERVICE_CODE", - "USAGE_TYPE", - "OPERATION", - "LOCATION", - "USAGE_GROUP", - "HISTORICAL_USAGE_ACCOUNT_ID", - "HISTORICAL_SERVICE_CODE", - "HISTORICAL_USAGE_TYPE", - "HISTORICAL_OPERATION", - "HISTORICAL_LOCATION" - ] - }, - "ListUsageFilterValues":{ - "type":"list", - "member":{"shape":"String"} - }, - "ListUsageFilters":{ - "type":"list", - "member":{"shape":"ListUsageFilter"} - }, - "ListWorkloadEstimateUsageRequest":{ - "type":"structure", - "required":["workloadEstimateId"], - "members":{ - "workloadEstimateId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the workload estimate to list usage for.

" - }, - "filters":{ - "shape":"ListUsageFilters", - "documentation":"

Filters to apply to the list of usage items.

" - }, - "nextToken":{ - "shape":"NextPageToken", - "documentation":"

A token to retrieve the next page of results.

" - }, - "maxResults":{ - "shape":"WorkloadEstimateUsageMaxResults", - "documentation":"

The maximum number of results to return per page.

" - } - } - }, - "ListWorkloadEstimateUsageResponse":{ - "type":"structure", - "members":{ - "items":{ - "shape":"WorkloadEstimateUsageItems", - "documentation":"

The list of usage items associated with the workload estimate.

" - }, - "nextToken":{ - "shape":"NextPageToken", - "documentation":"

A token to retrieve the next page of results, if any.

" - } - } - }, - "ListWorkloadEstimatesFilter":{ - "type":"structure", - "required":[ - "name", - "values" - ], - "members":{ - "name":{ - "shape":"ListWorkloadEstimatesFilterName", - "documentation":"

The name of the filter attribute.

" - }, - "values":{ - "shape":"ListWorkloadEstimatesFilterValues", - "documentation":"

The values to filter by.

" - }, - "matchOption":{ - "shape":"MatchOption", - "documentation":"

The match option for the filter (e.g., equals, contains).

" - } - }, - "documentation":"

Represents a filter for listing workload estimates.

" - }, - "ListWorkloadEstimatesFilterName":{ - "type":"string", - "enum":[ - "STATUS", - "NAME" - ] - }, - "ListWorkloadEstimatesFilterValues":{ - "type":"list", - "member":{"shape":"String"} - }, - "ListWorkloadEstimatesFilters":{ - "type":"list", - "member":{"shape":"ListWorkloadEstimatesFilter"} - }, - "ListWorkloadEstimatesRequest":{ - "type":"structure", - "members":{ - "createdAtFilter":{ - "shape":"FilterTimestamp", - "documentation":"

Filter workload estimates based on the creation date.

" - }, - "expiresAtFilter":{ - "shape":"FilterTimestamp", - "documentation":"

Filter workload estimates based on the expiration date.

" - }, - "filters":{ - "shape":"ListWorkloadEstimatesFilters", - "documentation":"

Filters to apply to the list of workload estimates.

" - }, - "nextToken":{ - "shape":"NextPageToken", - "documentation":"

A token to retrieve the next page of results.

" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return per page.

" - } - } - }, - "ListWorkloadEstimatesResponse":{ - "type":"structure", - "members":{ - "items":{ - "shape":"WorkloadEstimateSummaries", - "documentation":"

The list of workload estimates for the account.

" - }, - "nextToken":{ - "shape":"NextPageToken", - "documentation":"

A token to retrieve the next page of results, if any.

" - } - } - }, - "MatchOption":{ - "type":"string", - "enum":[ - "EQUALS", - "STARTS_WITH", - "CONTAINS" - ] - }, - "MaxResults":{ - "type":"integer", - "box":true, - "max":25, - "min":1 - }, - "NegateReservedInstanceAction":{ - "type":"structure", - "members":{ - "reservedInstancesId":{ - "shape":"Uuid", - "documentation":"

The ID of the Reserved Instance to remove.

" - } - }, - "documentation":"

Represents an action to remove a Reserved Instance from a bill scenario.

This is the ID of an existing Reserved Instance in your account.

" - }, - "NegateSavingsPlanAction":{ - "type":"structure", - "members":{ - "savingsPlanId":{ - "shape":"Uuid", - "documentation":"

The ID of the Savings Plan to remove.

" - } - }, - "documentation":"

Represents an action to remove a Savings Plan from a bill scenario.

This is the ID of an existing Savings Plan in your account.

" - }, - "NextPageToken":{ - "type":"string", - "max":2048, - "min":0, - "pattern":"[\\S\\s]*" - }, - "Operation":{ - "type":"string", - "max":32, - "min":0, - "pattern":"[-a-zA-Z0-9\\.\\-_:, \\/()]*" - }, - "PurchaseAgreementType":{ - "type":"string", - "enum":[ - "SAVINGS_PLANS", - "RESERVED_INSTANCE" - ] - }, - "RateType":{ - "type":"string", - "enum":[ - "BEFORE_DISCOUNTS", - "AFTER_DISCOUNTS", - "AFTER_DISCOUNTS_AND_COMMITMENTS" - ] - }, - "RateTypes":{ - "type":"list", - "member":{"shape":"RateType"}, - "max":3, - "min":1 - }, - "ReservedInstanceInstanceCount":{ - "type":"integer", - "box":true, - "min":1 - }, - "ResourceId":{ - "type":"string", - "max":36, - "min":36, - "pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" - }, - "ResourceNotFoundException":{ - "type":"structure", - "required":[ - "message", - "resourceId", - "resourceType" - ], - "members":{ - "message":{"shape":"String"}, - "resourceId":{ - "shape":"String", - "documentation":"

The identifier of the resource that was not found.

" - }, - "resourceType":{ - "shape":"String", - "documentation":"

The type of the resource that was not found.

" - } - }, - "documentation":"

The specified resource was not found.

", - "exception":true - }, - "ResourceTagKey":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[\\w\\s:+=@/-]+" - }, - "ResourceTagKeys":{ - "type":"list", - "member":{"shape":"ResourceTagKey"}, - "max":200, - "min":0 - }, - "ResourceTagValue":{ - "type":"string", - "max":256, - "min":0, - "pattern":"[\\w\\s:+=@/-]*" - }, - "SavingsPlanArns":{ - "type":"list", - "member":{"shape":"String"} - }, - "SavingsPlanCommitment":{ - "type":"double", - "box":true, - "max":1000000, - "min":0.001 - }, - "ServiceCode":{ - "type":"string", - "max":32, - "min":0, - "pattern":"[-a-zA-Z0-9\\.\\-_:, \\/()]*" - }, - "ServiceCostDifferenceMap":{ - "type":"map", - "key":{"shape":"String"}, - "value":{"shape":"CostDifference"} - }, - "ServiceQuotaExceededException":{ - "type":"structure", - "required":[ - "message", - "resourceId", - "resourceType" - ], - "members":{ - "message":{"shape":"String"}, - "resourceId":{ - "shape":"String", - "documentation":"

The identifier of the resource that exceeded quota.

" - }, - "resourceType":{ - "shape":"String", - "documentation":"

The type of the resource that exceeded quota.

" - }, - "serviceCode":{ - "shape":"String", - "documentation":"

The service code that exceeded quota.

" - }, - "quotaCode":{ - "shape":"String", - "documentation":"

The quota code that was exceeded.

" - } - }, - "documentation":"

The request would cause you to exceed your service quota.

", - "exception":true - }, - "String":{"type":"string"}, - "StringList":{ - "type":"list", - "member":{"shape":"String"} - }, - "TagResourceRequest":{ - "type":"structure", - "required":[ - "arn", - "tags" - ], - "members":{ - "arn":{ - "shape":"Arn", - "documentation":"

The Amazon Resource Name (ARN) of the resource to add tags to.

" - }, - "tags":{ - "shape":"Tags", - "documentation":"

The tags to add to the resource.

" - } - } - }, - "TagResourceResponse":{ - "type":"structure", - "members":{} - }, - "Tags":{ - "type":"map", - "key":{"shape":"ResourceTagKey"}, - "value":{"shape":"ResourceTagValue"}, - "max":200, - "min":0 - }, - "ThrottlingException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"}, - "serviceCode":{ - "shape":"String", - "documentation":"

The service code that exceeded the throttling limit.

" - }, - "quotaCode":{ - "shape":"String", - "documentation":"

The quota code that exceeded the throttling limit.

" - }, - "retryAfterSeconds":{ - "shape":"Integer", - "documentation":"

The service code that exceeded the throttling limit. Retry your request, but if the problem persists, contact Amazon Web Services support.

" - } - }, - "documentation":"

The request was denied due to request throttling.

", - "exception":true - }, - "Timestamp":{"type":"timestamp"}, - "UntagResourceRequest":{ - "type":"structure", - "required":[ - "arn", - "tagKeys" - ], - "members":{ - "arn":{ - "shape":"Arn", - "documentation":"

The Amazon Resource Name (ARN) of the resource to remove tags from.

" - }, - "tagKeys":{ - "shape":"ResourceTagKeys", - "documentation":"

The keys of the tags to remove from the resource.

" - } - } - }, - "UntagResourceResponse":{ - "type":"structure", - "members":{} - }, - "UpdateBillEstimateRequest":{ - "type":"structure", - "required":["identifier"], - "members":{ - "identifier":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the bill estimate to update.

" - }, - "name":{ - "shape":"BillEstimateName", - "documentation":"

The new name for the bill estimate.

" - }, - "expiresAt":{ - "shape":"Timestamp", - "documentation":"

The new expiration date for the bill estimate.

" - } - } - }, - "UpdateBillEstimateResponse":{ - "type":"structure", - "required":["id"], - "members":{ - "id":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the updated bill estimate.

" - }, - "name":{ - "shape":"BillEstimateName", - "documentation":"

The updated name of the bill estimate.

" - }, - "status":{ - "shape":"BillEstimateStatus", - "documentation":"

The current status of the updated bill estimate.

" - }, - "failureMessage":{ - "shape":"String", - "documentation":"

An error message if the bill estimate update failed.

" - }, - "billInterval":{ - "shape":"BillInterval", - "documentation":"

The time period covered by the updated bill estimate.

" - }, - "costSummary":{ - "shape":"BillEstimateCostSummary", - "documentation":"

A summary of the updated estimated costs.

" - }, - "createdAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the bill estimate was originally created.

" - }, - "expiresAt":{ - "shape":"Timestamp", - "documentation":"

The updated expiration timestamp for the bill estimate.

" - }, - "groupSharingPreference":{ - "shape":"GroupSharingPreferenceEnum", - "documentation":"

The setting for the reserved instance and savings plan group sharing used in this estimate.

" - }, - "costCategoryGroupSharingPreferenceArn":{ - "shape":"CostCategoryArn", - "documentation":"

The arn of the cost category used in the reserved and prioritized group sharing.

" - }, - "costCategoryGroupSharingPreferenceEffectiveDate":{ - "shape":"Timestamp", - "documentation":"

Timestamp of the effective date of the cost category used in the group sharing settings.

" - } - } - }, - "UpdateBillScenarioRequest":{ - "type":"structure", - "required":["identifier"], - "members":{ - "identifier":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the bill scenario to update.

" - }, - "name":{ - "shape":"BillScenarioName", - "documentation":"

The new name for the bill scenario.

" - }, - "expiresAt":{ - "shape":"Timestamp", - "documentation":"

The new expiration date for the bill scenario.

" - }, - "groupSharingPreference":{ - "shape":"GroupSharingPreferenceEnum", - "documentation":"

The setting for the reserved instance and savings plan group sharing used in this estimate.

" - }, - "costCategoryGroupSharingPreferenceArn":{ - "shape":"CostCategoryArn", - "documentation":"

The arn of the cost category used in the reserved and prioritized group sharing.

" - } - } - }, - "UpdateBillScenarioResponse":{ - "type":"structure", - "required":["id"], - "members":{ - "id":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the updated bill scenario.

" - }, - "name":{ - "shape":"BillScenarioName", - "documentation":"

The updated name of the bill scenario.

" - }, - "billInterval":{ - "shape":"BillInterval", - "documentation":"

The time period covered by the updated bill scenario.

" - }, - "status":{ - "shape":"BillScenarioStatus", - "documentation":"

The current status of the updated bill scenario.

" - }, - "createdAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the bill scenario was originally created.

" - }, - "expiresAt":{ - "shape":"Timestamp", - "documentation":"

The updated expiration timestamp for the bill scenario.

" - }, - "failureMessage":{ - "shape":"String", - "documentation":"

An error message if the bill scenario update failed.

" - }, - "groupSharingPreference":{ - "shape":"GroupSharingPreferenceEnum", - "documentation":"

The setting for the reserved instance and savings plan group sharing used in this estimate.

" - }, - "costCategoryGroupSharingPreferenceArn":{ - "shape":"CostCategoryArn", - "documentation":"

The arn of the cost category used in the reserved and prioritized group sharing.

" - } - } - }, - "UpdatePreferencesRequest":{ - "type":"structure", - "members":{ - "managementAccountRateTypeSelections":{ - "shape":"RateTypes", - "documentation":"

The updated preferred rate types for the management account.

" - }, - "memberAccountRateTypeSelections":{ - "shape":"RateTypes", - "documentation":"

The updated preferred rate types for member accounts.

" - }, - "standaloneAccountRateTypeSelections":{ - "shape":"RateTypes", - "documentation":"

The updated preferred rate types for a standalone account.

" - } - } - }, - "UpdatePreferencesResponse":{ - "type":"structure", - "members":{ - "managementAccountRateTypeSelections":{ - "shape":"RateTypes", - "documentation":"

The updated preferred rate types for the management account.

" - }, - "memberAccountRateTypeSelections":{ - "shape":"RateTypes", - "documentation":"

The updated preferred rate types for member accounts.

" - }, - "standaloneAccountRateTypeSelections":{ - "shape":"RateTypes", - "documentation":"

The updated preferred rate types for a standalone account.

" - } - } - }, - "UpdateWorkloadEstimateRequest":{ - "type":"structure", - "required":["identifier"], - "members":{ - "identifier":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the workload estimate to update.

" - }, - "name":{ - "shape":"WorkloadEstimateName", - "documentation":"

The new name for the workload estimate.

" - }, - "expiresAt":{ - "shape":"Timestamp", - "documentation":"

The new expiration date for the workload estimate.

" - } - } - }, - "UpdateWorkloadEstimateResponse":{ - "type":"structure", - "required":["id"], - "members":{ - "id":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the updated workload estimate.

" - }, - "name":{ - "shape":"WorkloadEstimateName", - "documentation":"

The updated name of the workload estimate.

" - }, - "createdAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the workload estimate was originally created.

" - }, - "expiresAt":{ - "shape":"Timestamp", - "documentation":"

The updated expiration timestamp for the workload estimate.

" - }, - "rateType":{ - "shape":"WorkloadEstimateRateType", - "documentation":"

The type of pricing rates used for the updated estimate.

" - }, - "rateTimestamp":{ - "shape":"Timestamp", - "documentation":"

The timestamp of the pricing rates used for the updated estimate.

" - }, - "status":{ - "shape":"WorkloadEstimateStatus", - "documentation":"

The current status of the updated workload estimate.

" - }, - "totalCost":{ - "shape":"Double", - "documentation":"

The updated total estimated cost for the workload.

" - }, - "costCurrency":{ - "shape":"CurrencyCode", - "documentation":"

The currency of the updated estimated cost.

" - }, - "failureMessage":{ - "shape":"String", - "documentation":"

An error message if the workload estimate update failed.

" - } - }, - "documentation":"

Mixin for common fields returned by CRUD APIs

" - }, - "UsageAmount":{ - "type":"structure", - "required":[ - "startHour", - "amount" - ], - "members":{ - "startHour":{ - "shape":"Timestamp", - "documentation":"

The start hour of the usage period.

" - }, - "amount":{ - "shape":"Double", - "documentation":"

The usage amount for the period.

" - } - }, - "documentation":"

Represents a usage amount for a specific time period.

" - }, - "UsageAmounts":{ - "type":"list", - "member":{"shape":"UsageAmount"} - }, - "UsageGroup":{ - "type":"string", - "max":30, - "min":0, - "pattern":"[a-zA-Z0-9-]*" - }, - "UsageQuantities":{ - "type":"list", - "member":{"shape":"UsageQuantity"} - }, - "UsageQuantity":{ - "type":"structure", - "members":{ - "startHour":{ - "shape":"Timestamp", - "documentation":"

The start hour of the usage period.

" - }, - "unit":{ - "shape":"String", - "documentation":"

The unit of measurement for the usage quantity.

" - }, - "amount":{ - "shape":"Double", - "documentation":"

The numeric value of the usage quantity.

" - } - }, - "documentation":"

Represents a usage quantity with associated unit and time period.

" - }, - "UsageQuantityResult":{ - "type":"structure", - "members":{ - "amount":{ - "shape":"Double", - "documentation":"

The numeric value of the usage quantity result.

" - }, - "unit":{ - "shape":"String", - "documentation":"

The unit of measurement for the usage quantity result.

" - } - }, - "documentation":"

Represents the result of a usage quantity calculation.

" - }, - "UsageType":{ - "type":"string", - "max":128, - "min":0, - "pattern":"[-a-zA-Z0-9\\.\\-_:, \\/()]*" - }, - "Uuid":{ - "type":"string", - "max":36, - "min":36, - "pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" - }, - "ValidationException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"}, - "reason":{ - "shape":"ValidationExceptionReason", - "documentation":"

The reason for the validation exception.

" - }, - "fieldList":{ - "shape":"ValidationExceptionFieldList", - "documentation":"

The list of fields that are invalid.

" - } - }, - "documentation":"

The input provided fails to satisfy the constraints specified by an Amazon Web Services service.

", - "exception":true - }, - "ValidationExceptionField":{ - "type":"structure", - "required":[ - "name", - "message" - ], - "members":{ - "name":{ - "shape":"String", - "documentation":"

The name of the field that failed validation.

" - }, - "message":{ - "shape":"String", - "documentation":"

The error message describing why the field failed validation.

" - } - }, - "documentation":"

Represents a field that failed validation in a request.

" - }, - "ValidationExceptionFieldList":{ - "type":"list", - "member":{"shape":"ValidationExceptionField"} - }, - "ValidationExceptionReason":{ - "type":"string", - "enum":[ - "unknownOperation", - "cannotParse", - "fieldValidationFailed", - "invalidRequestFromMember", - "disallowedRate", - "other" - ] - }, - "WorkloadEstimateCostStatus":{ - "type":"string", - "enum":[ - "VALID", - "INVALID", - "STALE" - ] - }, - "WorkloadEstimateName":{ - "type":"string", - "max":64, - "min":0, - "pattern":"[a-zA-Z0-9-]+" - }, - "WorkloadEstimateRateType":{ - "type":"string", - "enum":[ - "BEFORE_DISCOUNTS", - "AFTER_DISCOUNTS", - "AFTER_DISCOUNTS_AND_COMMITMENTS" - ] - }, - "WorkloadEstimateStatus":{ - "type":"string", - "enum":[ - "UPDATING", - "VALID", - "INVALID", - "ACTION_NEEDED" - ] - }, - "WorkloadEstimateSummaries":{ - "type":"list", - "member":{"shape":"WorkloadEstimateSummary"} - }, - "WorkloadEstimateSummary":{ - "type":"structure", - "required":["id"], - "members":{ - "id":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the workload estimate.

" - }, - "name":{ - "shape":"WorkloadEstimateName", - "documentation":"

The name of the workload estimate.

" - }, - "createdAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the workload estimate was created.

" - }, - "expiresAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the workload estimate will expire.

" - }, - "rateType":{ - "shape":"WorkloadEstimateRateType", - "documentation":"

The type of pricing rates used for the estimate.

" - }, - "rateTimestamp":{ - "shape":"Timestamp", - "documentation":"

The timestamp of the pricing rates used for the estimate.

" - }, - "status":{ - "shape":"WorkloadEstimateStatus", - "documentation":"

The current status of the workload estimate.

" - }, - "totalCost":{ - "shape":"Double", - "documentation":"

The total estimated cost for the workload.

" - }, - "costCurrency":{ - "shape":"CurrencyCode", - "documentation":"

The currency of the estimated cost.

" - }, - "failureMessage":{ - "shape":"String", - "documentation":"

An error message if the workload estimate creation or processing failed.

" - } - }, - "documentation":"

Provides a summary of a workload estimate.

" - }, - "WorkloadEstimateUpdateUsageErrorCode":{ - "type":"string", - "enum":[ - "BAD_REQUEST", - "NOT_FOUND", - "CONFLICT", - "INTERNAL_SERVER_ERROR" - ] - }, - "WorkloadEstimateUsageItem":{ - "type":"structure", - "required":[ - "serviceCode", - "usageType", - "operation" - ], - "members":{ - "serviceCode":{ - "shape":"ServiceCode", - "documentation":"

The Amazon Web Services service code associated with this usage item.

" - }, - "usageType":{ - "shape":"UsageType", - "documentation":"

The type of usage for this item.

" - }, - "operation":{ - "shape":"Operation", - "documentation":"

The specific operation associated with this usage item.

" - }, - "location":{ - "shape":"String", - "documentation":"

The location associated with this usage item.

" - }, - "id":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of this usage item.

" - }, - "usageAccountId":{ - "shape":"AccountId", - "documentation":"

The Amazon Web Services account ID associated with this usage item.

" - }, - "group":{ - "shape":"UsageGroup", - "documentation":"

The group identifier for this usage item.

" - }, - "quantity":{ - "shape":"WorkloadEstimateUsageQuantity", - "documentation":"

The estimated usage quantity for this item.

" - }, - "cost":{ - "shape":"Double", - "documentation":"

The estimated cost for this usage item.

" - }, - "currency":{ - "shape":"CurrencyCode", - "documentation":"

The currency of the estimated cost.

" - }, - "status":{ - "shape":"WorkloadEstimateCostStatus", - "documentation":"

The current status of this usage item.

" - }, - "historicalUsage":{ - "shape":"HistoricalUsageEntity", - "documentation":"

Historical usage data associated with this item, if available.

" - } - }, - "documentation":"

Represents a usage item in a workload estimate.

" - }, - "WorkloadEstimateUsageItems":{ - "type":"list", - "member":{"shape":"WorkloadEstimateUsageItem"} - }, - "WorkloadEstimateUsageMaxResults":{ - "type":"integer", - "box":true, - "max":300, - "min":1 - }, - "WorkloadEstimateUsageQuantity":{ - "type":"structure", - "members":{ - "unit":{ - "shape":"String", - "documentation":"

The unit of measurement for the usage quantity.

" - }, - "amount":{ - "shape":"Double", - "documentation":"

The numeric value of the usage quantity.

" - } - }, - "documentation":"

Represents a usage quantity for a workload estimate.

" - } - }, - "documentation":"

You can use the Pricing Calculator API to programmatically create estimates for your planned cloud use. You can model usage and commitments such as Savings Plans and Reserved Instances, and generate estimated costs using your discounts and benefit sharing preferences.

The Pricing Calculator API provides the following endpoint:

  • https://bcm-pricing-calculator.us-east-1.api.aws

" -} diff --git a/tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/smoke-2.json b/tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/smoke-2.json deleted file mode 100644 index 47501367aad8..000000000000 --- a/tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/smoke-2.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "version" : 2, - "testCases" : [ { - "id" : "GetWorkloadEstimate", - "operationName" : "GetWorkloadEstimate", - "input" : { - "identifier" : "9bb1df8b-5978-4fcb-9c5c-99f5b2670076" - }, - "expectation" : { - "failure" : { } - }, - "config" : { - "region" : "us-west-2", - "useFips" : false, - "useDualstack" : false, - "useAccountIdRouting" : true - } - } ] -} \ No newline at end of file diff --git a/tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/smoke.json b/tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/smoke.json deleted file mode 100644 index a9756813e4af..000000000000 --- a/tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/smoke.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "version": 1, - "defaultRegion": "us-west-2", - "testCases": [ - ] -} diff --git a/tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/waiters-2.json b/tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/waiters-2.json deleted file mode 100644 index 13f60ee66be6..000000000000 --- a/tools/code-generation/api-descriptions/bcm-pricing-calculator/2024-06-19/waiters-2.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "version": 2, - "waiters": { - } -} diff --git a/tools/code-generation/api-descriptions/bcm-recommended-actions-2024-11-14.normal.json b/tools/code-generation/api-descriptions/bcm-recommended-actions-2024-11-14.normal.json index 4a30b8b3f4e8..48636249423b 100644 --- a/tools/code-generation/api-descriptions/bcm-recommended-actions-2024-11-14.normal.json +++ b/tools/code-generation/api-descriptions/bcm-recommended-actions-2024-11-14.normal.json @@ -5,11 +5,8 @@ "auth":["aws.auth#sigv4"], "endpointPrefix":"bcm-recommended-actions", "jsonVersion":"1.0", - "protocol":"smithy-rpc-v2-cbor", - "protocols":[ - "smithy-rpc-v2-cbor", - "json" - ], + "protocol":"json", + "protocols":["json"], "serviceFullName":"AWS Billing and Cost Management Recommended Actions", "serviceId":"BCM Recommended Actions", "signatureVersion":"v4", @@ -43,10 +40,6 @@ "message":{"shape":"String"} }, "documentation":"

You do not have sufficient access to perform this action.

", - "error":{ - "httpStatusCode":403, - "senderFault":true - }, "exception":true }, "AccountId":{ @@ -153,7 +146,6 @@ "message":{"shape":"String"} }, "documentation":"

An unexpected error occurred during the processing of your request.

", - "error":{"httpStatusCode":500}, "exception":true, "fault":true }, @@ -280,10 +272,6 @@ "message":{"shape":"String"} }, "documentation":"

The request was denied due to request throttling.

", - "error":{ - "httpStatusCode":429, - "senderFault":true - }, "exception":true }, "ValidationException":{ @@ -304,10 +292,6 @@ } }, "documentation":"

The input fails to satisfy the constraints specified by an Amazon Web Services service.

", - "error":{ - "httpStatusCode":400, - "senderFault":true - }, "exception":true }, "ValidationExceptionField":{ diff --git a/tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/api-2.json b/tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/api-2.json deleted file mode 100644 index a3eb9131fc40..000000000000 --- a/tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/api-2.json +++ /dev/null @@ -1,257 +0,0 @@ -{ - "version":"2.0", - "metadata":{ - "apiVersion":"2024-11-14", - "auth":["aws.auth#sigv4"], - "endpointPrefix":"bcm-recommended-actions", - "jsonVersion":"1.0", - "protocol":"json", - "protocols":["json"], - "serviceFullName":"AWS Billing and Cost Management Recommended Actions", - "serviceId":"BCM Recommended Actions", - "signatureVersion":"v4", - "signingName":"bcm-recommended-actions", - "targetPrefix":"AWSBillingAndCostManagementRecommendedActions", - "uid":"bcm-recommended-actions-2024-11-14" - }, - "operations":{ - "ListRecommendedActions":{ - "name":"ListRecommendedActions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListRecommendedActionsRequest"}, - "output":{"shape":"ListRecommendedActionsResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"} - ] - } - }, - "shapes":{ - "AccessDeniedException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"} - }, - "exception":true - }, - "AccountId":{ - "type":"string", - "max":12, - "min":12, - "pattern":"[0-9]{12}" - }, - "ActionFilter":{ - "type":"structure", - "required":[ - "key", - "matchOption", - "values" - ], - "members":{ - "key":{"shape":"FilterName"}, - "matchOption":{"shape":"MatchOption"}, - "values":{"shape":"FilterValues"} - } - }, - "ActionFilterList":{ - "type":"list", - "member":{"shape":"ActionFilter"} - }, - "ActionType":{ - "type":"string", - "enum":[ - "ADD_ALTERNATE_BILLING_CONTACT", - "CREATE_ANOMALY_MONITOR", - "CREATE_BUDGET", - "ENABLE_COST_OPTIMIZATION_HUB", - "MIGRATE_TO_GRANULAR_PERMISSIONS", - "PAYMENTS_DUE", - "PAYMENTS_PAST_DUE", - "REVIEW_ANOMALIES", - "REVIEW_BUDGET_ALERTS", - "REVIEW_BUDGETS_EXCEEDED", - "REVIEW_EXPIRING_RI", - "REVIEW_EXPIRING_SP", - "REVIEW_FREETIER_USAGE_ALERTS", - "REVIEW_FREETIER_CREDITS_REMAINING", - "REVIEW_FREETIER_DAYS_REMAINING", - "REVIEW_SAVINGS_OPPORTUNITY_RECOMMENDATIONS", - "UPDATE_EXPIRED_PAYMENT_METHOD", - "UPDATE_INVALID_PAYMENT_METHOD", - "UPDATE_TAX_EXEMPTION_CERTIFICATE", - "UPDATE_TAX_REGISTRATION_NUMBER" - ] - }, - "Context":{ - "type":"map", - "key":{"shape":"String"}, - "value":{"shape":"String"} - }, - "Feature":{ - "type":"string", - "enum":[ - "ACCOUNT", - "BUDGETS", - "COST_ANOMALY_DETECTION", - "COST_OPTIMIZATION_HUB", - "FREE_TIER", - "IAM", - "PAYMENTS", - "RESERVATIONS", - "SAVINGS_PLANS", - "TAX_SETTINGS" - ] - }, - "FilterName":{ - "type":"string", - "enum":[ - "FEATURE", - "SEVERITY", - "TYPE" - ] - }, - "FilterValue":{ - "type":"string", - "max":1024, - "min":1, - "pattern":".*[\\S\\s]*.*" - }, - "FilterValues":{ - "type":"list", - "member":{"shape":"FilterValue"}, - "min":1 - }, - "InternalServerException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"} - }, - "exception":true, - "fault":true - }, - "ListRecommendedActionsRequest":{ - "type":"structure", - "members":{ - "filter":{"shape":"RequestFilter"}, - "maxResults":{"shape":"MaxResults"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListRecommendedActionsResponse":{ - "type":"structure", - "required":["recommendedActions"], - "members":{ - "recommendedActions":{"shape":"RecommendedActions"}, - "nextToken":{"shape":"NextToken"} - } - }, - "MatchOption":{ - "type":"string", - "enum":[ - "EQUALS", - "NOT_EQUALS" - ] - }, - "MaxResults":{ - "type":"integer", - "box":true, - "max":1000, - "min":1 - }, - "NextStep":{"type":"string"}, - "NextSteps":{ - "type":"list", - "member":{"shape":"NextStep"} - }, - "NextToken":{ - "type":"string", - "max":8192, - "min":1, - "pattern":"[\\S\\s]*" - }, - "RecommendedAction":{ - "type":"structure", - "members":{ - "id":{"shape":"String"}, - "type":{"shape":"ActionType"}, - "accountId":{"shape":"AccountId"}, - "severity":{"shape":"Severity"}, - "feature":{"shape":"Feature"}, - "context":{"shape":"Context"}, - "nextSteps":{"shape":"NextSteps"}, - "lastUpdatedTimeStamp":{"shape":"String"} - } - }, - "RecommendedActions":{ - "type":"list", - "member":{"shape":"RecommendedAction"} - }, - "RequestFilter":{ - "type":"structure", - "members":{ - "actions":{"shape":"ActionFilterList"} - } - }, - "Severity":{ - "type":"string", - "enum":[ - "INFO", - "WARNING", - "CRITICAL" - ] - }, - "String":{"type":"string"}, - "ThrottlingException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"} - }, - "exception":true - }, - "ValidationException":{ - "type":"structure", - "required":[ - "message", - "reason" - ], - "members":{ - "message":{"shape":"String"}, - "reason":{"shape":"ValidationExceptionReason"}, - "fieldList":{"shape":"ValidationExceptionFieldList"} - }, - "exception":true - }, - "ValidationExceptionField":{ - "type":"structure", - "required":[ - "name", - "message" - ], - "members":{ - "name":{"shape":"String"}, - "message":{"shape":"String"} - } - }, - "ValidationExceptionFieldList":{ - "type":"list", - "member":{"shape":"ValidationExceptionField"} - }, - "ValidationExceptionReason":{ - "type":"string", - "enum":[ - "unknownOperation", - "cannotParse", - "fieldValidationFailed", - "other" - ] - } - } -} diff --git a/tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/docs-2.json b/tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/docs-2.json deleted file mode 100644 index 1a8fcc9382d5..000000000000 --- a/tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/docs-2.json +++ /dev/null @@ -1,175 +0,0 @@ -{ - "version": "2.0", - "service": "

You can use the Billing and Cost Management Recommended Actions API to programmatically query your best practices and recommendations to optimize your costs.

The Billing and Cost Management Recommended Actions API provides the following endpoint:

  • https://bcm-recommended-actions.us-east-1.api.aws

", - "operations": { - "ListRecommendedActions": "

Returns a list of recommended actions that match the filter criteria.

" - }, - "shapes": { - "AccessDeniedException": { - "base": "

You do not have sufficient access to perform this action.

", - "refs": {} - }, - "AccountId": { - "base": null, - "refs": { - "RecommendedAction$accountId": "

The account that the recommended action is for.

" - } - }, - "ActionFilter": { - "base": "

Describes a filter that returns a more specific list of recommended actions.

", - "refs": { - "ActionFilterList$member": null - } - }, - "ActionFilterList": { - "base": null, - "refs": { - "RequestFilter$actions": "

A list of action filters that define criteria for filtering results. Each filter specifies a key, match option, and corresponding values to filter on.

" - } - }, - "ActionType": { - "base": null, - "refs": { - "RecommendedAction$type": "

The type of action you can take by adopting the recommended action.

" - } - }, - "Context": { - "base": null, - "refs": { - "RecommendedAction$context": "

Context that applies to the recommended action.

" - } - }, - "Feature": { - "base": null, - "refs": { - "RecommendedAction$feature": "

The feature associated with the recommended action.

" - } - }, - "FilterName": { - "base": null, - "refs": { - "ActionFilter$key": "

The category to filter on. Valid values are FEATURE for feature type, SEVERITY for severity level, and TYPE for recommendation type.

" - } - }, - "FilterValue": { - "base": null, - "refs": { - "FilterValues$member": null - } - }, - "FilterValues": { - "base": null, - "refs": { - "ActionFilter$values": "

One or more values to match against the specified key.

" - } - }, - "InternalServerException": { - "base": "

An unexpected error occurred during the processing of your request.

", - "refs": {} - }, - "ListRecommendedActionsRequest": { - "base": null, - "refs": {} - }, - "ListRecommendedActionsResponse": { - "base": null, - "refs": {} - }, - "MatchOption": { - "base": null, - "refs": { - "ActionFilter$matchOption": "

Specifies how to apply the filter. Use EQUALS to include matching results or NOT_EQUALS to exclude matching results.

" - } - }, - "MaxResults": { - "base": null, - "refs": { - "ListRecommendedActionsRequest$maxResults": "

The maximum number of results to return in the response.

" - } - }, - "NextStep": { - "base": null, - "refs": { - "NextSteps$member": null - } - }, - "NextSteps": { - "base": null, - "refs": { - "RecommendedAction$nextSteps": "

The possible next steps to execute the recommended action.

" - } - }, - "NextToken": { - "base": null, - "refs": { - "ListRecommendedActionsRequest$nextToken": "

The pagination token that indicates the next set of results that you want to retrieve.

", - "ListRecommendedActionsResponse$nextToken": "

The pagination token that indicates the next set of results that you want to retrieve.

" - } - }, - "RecommendedAction": { - "base": "

Describes a specific recommended action.

", - "refs": { - "RecommendedActions$member": null - } - }, - "RecommendedActions": { - "base": null, - "refs": { - "ListRecommendedActionsResponse$recommendedActions": "

The list of recommended actions that satisfy the filter criteria.

" - } - }, - "RequestFilter": { - "base": "

Enables filtering of results based on specified action criteria. You can define multiple action filters to refine results using combinations of feature type, severity level, and recommendation type.

", - "refs": { - "ListRecommendedActionsRequest$filter": "

The criteria that you want all returned recommended actions to match.

" - } - }, - "Severity": { - "base": null, - "refs": { - "RecommendedAction$severity": "

The severity associated with the recommended action.

" - } - }, - "String": { - "base": null, - "refs": { - "AccessDeniedException$message": null, - "Context$key": null, - "Context$value": null, - "InternalServerException$message": null, - "RecommendedAction$id": "

The ID for the recommended action.

", - "RecommendedAction$lastUpdatedTimeStamp": "

The time when the recommended action status was last updated.

", - "ThrottlingException$message": null, - "ValidationException$message": null, - "ValidationExceptionField$name": "

Provides the name of the field that failed validation.

", - "ValidationExceptionField$message": "

Provides a message explaining why the field failed validation.

" - } - }, - "ThrottlingException": { - "base": "

The request was denied due to request throttling.

", - "refs": {} - }, - "ValidationException": { - "base": "

The input fails to satisfy the constraints specified by an Amazon Web Services service.

", - "refs": {} - }, - "ValidationExceptionField": { - "base": "

Provides specific details about why a particular field failed validation.

", - "refs": { - "ValidationExceptionFieldList$member": null - } - }, - "ValidationExceptionFieldList": { - "base": null, - "refs": { - "ValidationException$fieldList": "

Lists each problematic field and why it failed validation.

" - } - }, - "ValidationExceptionReason": { - "base": null, - "refs": { - "ValidationException$reason": "

Provides a single, overarching explanation for the validation failure.

" - } - } - } -} diff --git a/tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/endpoint-bdd-1.json b/tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/endpoint-bdd-1.json deleted file mode 100644 index fe9b2c5d46ad..000000000000 --- a/tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/endpoint-bdd-1.json +++ /dev/null @@ -1,118 +0,0 @@ -{ - "version": "1.1", - "parameters": { - "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" - }, - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "string" - } - }, - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - }, - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - }, - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "results": [ - { - "conditions": [], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://bcm-recommended-actions-fips.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dualStackDnsSuffix}", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "{PartitionResult#implicitGlobalRegion}" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://bcm-recommended-actions.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dualStackDnsSuffix}", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "{PartitionResult#implicitGlobalRegion}" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ], - "root": 2, - "nodeCount": 6, - "nodes": "/////wAAAAH/////AAAAAAAAAAYAAAADAAAAAQAAAAQF9eEFAAAAAgAAAAUF9eEFAAAAAwX14QMF9eEEAAAAAwX14QEF9eEC" -} \ No newline at end of file diff --git a/tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/endpoint-rule-set-1.json b/tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/endpoint-rule-set-1.json deleted file mode 100644 index 8f88d8031d22..000000000000 --- a/tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/endpoint-rule-set-1.json +++ /dev/null @@ -1,151 +0,0 @@ -{ - "version": "1.0", - "parameters": { - "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" - }, - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the 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": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "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 - ] - } - ], - "endpoint": { - "url": "https://bcm-recommended-actions-fips.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dualStackDnsSuffix}", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "{PartitionResult#implicitGlobalRegion}" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://bcm-recommended-actions.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dualStackDnsSuffix}", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "{PartitionResult#implicitGlobalRegion}" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ], - "type": "tree" - } - ] -} \ No newline at end of file diff --git a/tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/endpoint-tests-1.json b/tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/endpoint-tests-1.json deleted file mode 100644 index 53d49782703b..000000000000 --- a/tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/endpoint-tests-1.json +++ /dev/null @@ -1,153 +0,0 @@ -{ - "testCases": [ - { - "documentation": "For custom endpoint with region not set and fips disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Endpoint": "https://example.com", - "UseFIPS": false - } - }, - { - "documentation": "For custom endpoint with fips enabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Endpoint": "https://example.com", - "UseFIPS": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-east-1" - } - ] - }, - "url": "https://bcm-recommended-actions-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-east-1" - } - ] - }, - "url": "https://bcm-recommended-actions.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "cn-northwest-1" - } - ] - }, - "url": "https://bcm-recommended-actions-fips.cn-northwest-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-northwest-1", - "UseFIPS": true - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "cn-northwest-1" - } - ] - }, - "url": "https://bcm-recommended-actions.cn-northwest-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-northwest-1", - "UseFIPS": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-gov-west-1" - } - ] - }, - "url": "https://bcm-recommended-actions-fips.us-gov-west-1.api.aws" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": true - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-gov-west-1" - } - ] - }, - "url": "https://bcm-recommended-actions.us-gov-west-1.api.aws" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": false - } - }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } - } - ], - "version": "1.0" -} \ No newline at end of file diff --git a/tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/examples-1.json b/tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/examples-1.json deleted file mode 100644 index 2fb77604d1be..000000000000 --- a/tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/examples-1.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "version": "1.0", - "examples": {} -} diff --git a/tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/paginators-1.json b/tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/paginators-1.json deleted file mode 100644 index 11c6a2dad6cc..000000000000 --- a/tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/paginators-1.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "pagination": { - "ListRecommendedActions": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "recommendedActions" - } - } -} diff --git a/tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/service-2.json b/tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/service-2.json deleted file mode 100644 index 48636249423b..000000000000 --- a/tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/service-2.json +++ /dev/null @@ -1,330 +0,0 @@ -{ - "version":"2.0", - "metadata":{ - "apiVersion":"2024-11-14", - "auth":["aws.auth#sigv4"], - "endpointPrefix":"bcm-recommended-actions", - "jsonVersion":"1.0", - "protocol":"json", - "protocols":["json"], - "serviceFullName":"AWS Billing and Cost Management Recommended Actions", - "serviceId":"BCM Recommended Actions", - "signatureVersion":"v4", - "signingName":"bcm-recommended-actions", - "targetPrefix":"AWSBillingAndCostManagementRecommendedActions", - "uid":"bcm-recommended-actions-2024-11-14" - }, - "operations":{ - "ListRecommendedActions":{ - "name":"ListRecommendedActions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListRecommendedActionsRequest"}, - "output":{"shape":"ListRecommendedActionsResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Returns a list of recommended actions that match the filter criteria.

" - } - }, - "shapes":{ - "AccessDeniedException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"} - }, - "documentation":"

You do not have sufficient access to perform this action.

", - "exception":true - }, - "AccountId":{ - "type":"string", - "max":12, - "min":12, - "pattern":"[0-9]{12}" - }, - "ActionFilter":{ - "type":"structure", - "required":[ - "key", - "matchOption", - "values" - ], - "members":{ - "key":{ - "shape":"FilterName", - "documentation":"

The category to filter on. Valid values are FEATURE for feature type, SEVERITY for severity level, and TYPE for recommendation type.

" - }, - "matchOption":{ - "shape":"MatchOption", - "documentation":"

Specifies how to apply the filter. Use EQUALS to include matching results or NOT_EQUALS to exclude matching results.

" - }, - "values":{ - "shape":"FilterValues", - "documentation":"

One or more values to match against the specified key.

" - } - }, - "documentation":"

Describes a filter that returns a more specific list of recommended actions.

" - }, - "ActionFilterList":{ - "type":"list", - "member":{"shape":"ActionFilter"} - }, - "ActionType":{ - "type":"string", - "enum":[ - "ADD_ALTERNATE_BILLING_CONTACT", - "CREATE_ANOMALY_MONITOR", - "CREATE_BUDGET", - "ENABLE_COST_OPTIMIZATION_HUB", - "MIGRATE_TO_GRANULAR_PERMISSIONS", - "PAYMENTS_DUE", - "PAYMENTS_PAST_DUE", - "REVIEW_ANOMALIES", - "REVIEW_BUDGET_ALERTS", - "REVIEW_BUDGETS_EXCEEDED", - "REVIEW_EXPIRING_RI", - "REVIEW_EXPIRING_SP", - "REVIEW_FREETIER_USAGE_ALERTS", - "REVIEW_FREETIER_CREDITS_REMAINING", - "REVIEW_FREETIER_DAYS_REMAINING", - "REVIEW_SAVINGS_OPPORTUNITY_RECOMMENDATIONS", - "UPDATE_EXPIRED_PAYMENT_METHOD", - "UPDATE_INVALID_PAYMENT_METHOD", - "UPDATE_TAX_EXEMPTION_CERTIFICATE", - "UPDATE_TAX_REGISTRATION_NUMBER" - ] - }, - "Context":{ - "type":"map", - "key":{"shape":"String"}, - "value":{"shape":"String"} - }, - "Feature":{ - "type":"string", - "enum":[ - "ACCOUNT", - "BUDGETS", - "COST_ANOMALY_DETECTION", - "COST_OPTIMIZATION_HUB", - "FREE_TIER", - "IAM", - "PAYMENTS", - "RESERVATIONS", - "SAVINGS_PLANS", - "TAX_SETTINGS" - ] - }, - "FilterName":{ - "type":"string", - "enum":[ - "FEATURE", - "SEVERITY", - "TYPE" - ] - }, - "FilterValue":{ - "type":"string", - "max":1024, - "min":1, - "pattern":".*[\\S\\s]*.*" - }, - "FilterValues":{ - "type":"list", - "member":{"shape":"FilterValue"}, - "min":1 - }, - "InternalServerException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"} - }, - "documentation":"

An unexpected error occurred during the processing of your request.

", - "exception":true, - "fault":true - }, - "ListRecommendedActionsRequest":{ - "type":"structure", - "members":{ - "filter":{ - "shape":"RequestFilter", - "documentation":"

The criteria that you want all returned recommended actions to match.

" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return in the response.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

The pagination token that indicates the next set of results that you want to retrieve.

" - } - } - }, - "ListRecommendedActionsResponse":{ - "type":"structure", - "required":["recommendedActions"], - "members":{ - "recommendedActions":{ - "shape":"RecommendedActions", - "documentation":"

The list of recommended actions that satisfy the filter criteria.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

The pagination token that indicates the next set of results that you want to retrieve.

" - } - } - }, - "MatchOption":{ - "type":"string", - "enum":[ - "EQUALS", - "NOT_EQUALS" - ] - }, - "MaxResults":{ - "type":"integer", - "box":true, - "max":1000, - "min":1 - }, - "NextStep":{"type":"string"}, - "NextSteps":{ - "type":"list", - "member":{"shape":"NextStep"} - }, - "NextToken":{ - "type":"string", - "max":8192, - "min":1, - "pattern":"[\\S\\s]*" - }, - "RecommendedAction":{ - "type":"structure", - "members":{ - "id":{ - "shape":"String", - "documentation":"

The ID for the recommended action.

" - }, - "type":{ - "shape":"ActionType", - "documentation":"

The type of action you can take by adopting the recommended action.

" - }, - "accountId":{ - "shape":"AccountId", - "documentation":"

The account that the recommended action is for.

" - }, - "severity":{ - "shape":"Severity", - "documentation":"

The severity associated with the recommended action.

" - }, - "feature":{ - "shape":"Feature", - "documentation":"

The feature associated with the recommended action.

" - }, - "context":{ - "shape":"Context", - "documentation":"

Context that applies to the recommended action.

" - }, - "nextSteps":{ - "shape":"NextSteps", - "documentation":"

The possible next steps to execute the recommended action.

" - }, - "lastUpdatedTimeStamp":{ - "shape":"String", - "documentation":"

The time when the recommended action status was last updated.

" - } - }, - "documentation":"

Describes a specific recommended action.

" - }, - "RecommendedActions":{ - "type":"list", - "member":{"shape":"RecommendedAction"} - }, - "RequestFilter":{ - "type":"structure", - "members":{ - "actions":{ - "shape":"ActionFilterList", - "documentation":"

A list of action filters that define criteria for filtering results. Each filter specifies a key, match option, and corresponding values to filter on.

" - } - }, - "documentation":"

Enables filtering of results based on specified action criteria. You can define multiple action filters to refine results using combinations of feature type, severity level, and recommendation type.

" - }, - "Severity":{ - "type":"string", - "enum":[ - "INFO", - "WARNING", - "CRITICAL" - ] - }, - "String":{"type":"string"}, - "ThrottlingException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"} - }, - "documentation":"

The request was denied due to request throttling.

", - "exception":true - }, - "ValidationException":{ - "type":"structure", - "required":[ - "message", - "reason" - ], - "members":{ - "message":{"shape":"String"}, - "reason":{ - "shape":"ValidationExceptionReason", - "documentation":"

Provides a single, overarching explanation for the validation failure.

" - }, - "fieldList":{ - "shape":"ValidationExceptionFieldList", - "documentation":"

Lists each problematic field and why it failed validation.

" - } - }, - "documentation":"

The input fails to satisfy the constraints specified by an Amazon Web Services service.

", - "exception":true - }, - "ValidationExceptionField":{ - "type":"structure", - "required":[ - "name", - "message" - ], - "members":{ - "name":{ - "shape":"String", - "documentation":"

Provides the name of the field that failed validation.

" - }, - "message":{ - "shape":"String", - "documentation":"

Provides a message explaining why the field failed validation.

" - } - }, - "documentation":"

Provides specific details about why a particular field failed validation.

" - }, - "ValidationExceptionFieldList":{ - "type":"list", - "member":{"shape":"ValidationExceptionField"} - }, - "ValidationExceptionReason":{ - "type":"string", - "enum":[ - "unknownOperation", - "cannotParse", - "fieldValidationFailed", - "other" - ] - } - }, - "documentation":"

You can use the Billing and Cost Management Recommended Actions API to programmatically query your best practices and recommendations to optimize your costs.

The Billing and Cost Management Recommended Actions API provides the following endpoint:

  • https://bcm-recommended-actions.us-east-1.api.aws

" -} diff --git a/tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/smoke-2.json b/tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/smoke-2.json deleted file mode 100644 index 41674e76d514..000000000000 --- a/tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/smoke-2.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "version" : 2, - "testCases" : [ { - "id" : "ListRecommendedActionsSuccess", - "operationName" : "ListRecommendedActions", - "input" : { - "maxResults" : 5 - }, - "expectation" : { - "success" : { } - }, - "config" : { - "region" : "us-west-2", - "useFips" : false, - "useDualstack" : false, - "useAccountIdRouting" : true - } - } ] -} \ No newline at end of file diff --git a/tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/smoke.json b/tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/smoke.json deleted file mode 100644 index a9756813e4af..000000000000 --- a/tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/smoke.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "version": 1, - "defaultRegion": "us-west-2", - "testCases": [ - ] -} diff --git a/tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/waiters-2.json b/tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/waiters-2.json deleted file mode 100644 index 13f60ee66be6..000000000000 --- a/tools/code-generation/api-descriptions/bcm-recommended-actions/2024-11-14/waiters-2.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "version": 2, - "waiters": { - } -} diff --git a/tools/code-generation/api-descriptions/bedrock-agentcore-control-2023-06-05.normal.json b/tools/code-generation/api-descriptions/bedrock-agentcore-control-2023-06-05.normal.json index 812a2975c43e..05b1536f6749 100644 --- a/tools/code-generation/api-descriptions/bedrock-agentcore-control-2023-06-05.normal.json +++ b/tools/code-generation/api-descriptions/bedrock-agentcore-control-2023-06-05.normal.json @@ -8913,6 +8913,10 @@ "bedrockEvaluatorModelConfig":{ "shape":"BedrockEvaluatorModelConfig", "documentation":"

The Amazon Bedrock model configuration for evaluation.

" + }, + "responsesEvaluatorModelConfig":{ + "shape":"OpenResponsesEvaluatorModelConfig", + "documentation":"

The OpenResponses model configuration for evaluation.

" } }, "documentation":"

The model configuration that specifies which foundation model to use for evaluation and how to configure it.

", @@ -16387,6 +16391,50 @@ "DISABLED" ] }, + "OpenResponsesEvaluatorModelConfig":{ + "type":"structure", + "required":["modelId"], + "members":{ + "modelId":{ + "shape":"ModelId", + "documentation":"

The identifier of the model to use for evaluation.

" + }, + "maxOutputTokens":{ + "shape":"OpenResponsesEvaluatorModelConfigMaxOutputTokensInteger", + "documentation":"

The maximum number of tokens to generate in the model response, including visible output and reasoning tokens.

" + }, + "temperature":{ + "shape":"OpenResponsesEvaluatorModelConfigTemperatureFloat", + "documentation":"

The temperature value that controls randomness in the model's responses. Lower values produce more deterministic outputs.

" + }, + "topP":{ + "shape":"OpenResponsesEvaluatorModelConfigTopPFloat", + "documentation":"

The top-p sampling parameter that controls the diversity of the model's responses by limiting the cumulative probability of token choices.

" + }, + "reasoning":{ + "shape":"ReasoningConfiguration", + "documentation":"

The reasoning configuration for reasoning models. Non-reasoning models ignore this configuration.

" + } + }, + "documentation":"

The configuration for using models served through the OpenResponses API in evaluator assessments, including model selection and inference parameters.

" + }, + "OpenResponsesEvaluatorModelConfigMaxOutputTokensInteger":{ + "type":"integer", + "box":true, + "min":1 + }, + "OpenResponsesEvaluatorModelConfigTemperatureFloat":{ + "type":"float", + "box":true, + "max":2, + "min":0 + }, + "OpenResponsesEvaluatorModelConfigTopPFloat":{ + "type":"float", + "box":true, + "max":1, + "min":0 + }, "OutputConfig":{ "type":"structure", "required":["cloudWatchConfig"], @@ -17383,6 +17431,21 @@ "sensitive":true, "union":true }, + "ReasoningConfiguration":{ + "type":"structure", + "members":{ + "effort":{ + "shape":"ReasoningConfigurationEffortString", + "documentation":"

The level of reasoning effort the model applies when generating a response. For supported values, see the model provider's documentation.

" + } + }, + "documentation":"

The reasoning configuration that controls how a reasoning model allocates effort during evaluation.

" + }, + "ReasoningConfigurationEffortString":{ + "type":"string", + "max":64, + "min":1 + }, "RecordIdentifier":{ "type":"string", "max":2048, diff --git a/tools/code-generation/api-descriptions/bedrock-agentcore-control/2023-06-05/api-2.json b/tools/code-generation/api-descriptions/bedrock-agentcore-control/2023-06-05/api-2.json deleted file mode 100644 index 40a5ff82f147..000000000000 --- a/tools/code-generation/api-descriptions/bedrock-agentcore-control/2023-06-05/api-2.json +++ /dev/null @@ -1,14969 +0,0 @@ -{ - "version":"2.0", - "metadata":{ - "apiVersion":"2023-06-05", - "auth":["aws.auth#sigv4"], - "endpointPrefix":"bedrock-agentcore-control", - "protocol":"rest-json", - "protocols":["rest-json"], - "serviceFullName":"Amazon Bedrock AgentCore Control", - "serviceId":"Bedrock AgentCore Control", - "signatureVersion":"v4", - "signingName":"bedrock-agentcore", - "uid":"bedrock-agentcore-control-2023-06-05" - }, - "operations":{ - "AddDatasetExamples":{ - "name":"AddDatasetExamples", - "http":{ - "method":"POST", - "requestUri":"/datasets/{datasetId}/examples/add", - "responseCode":202 - }, - "input":{"shape":"AddDatasetExamplesRequest"}, - "output":{"shape":"AddDatasetExamplesResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ] - }, - "CreateAgentRuntime":{ - "name":"CreateAgentRuntime", - "http":{ - "method":"PUT", - "requestUri":"/runtimes/", - "responseCode":202 - }, - "input":{"shape":"CreateAgentRuntimeRequest"}, - "output":{"shape":"CreateAgentRuntimeResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "CreateAgentRuntimeEndpoint":{ - "name":"CreateAgentRuntimeEndpoint", - "http":{ - "method":"PUT", - "requestUri":"/runtimes/{agentRuntimeId}/runtime-endpoints/", - "responseCode":202 - }, - "input":{"shape":"CreateAgentRuntimeEndpointRequest"}, - "output":{"shape":"CreateAgentRuntimeEndpointResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "CreateApiKeyCredentialProvider":{ - "name":"CreateApiKeyCredentialProvider", - "http":{ - "method":"POST", - "requestUri":"/identities/CreateApiKeyCredentialProvider", - "responseCode":201 - }, - "input":{"shape":"CreateApiKeyCredentialProviderRequest"}, - "output":{"shape":"CreateApiKeyCredentialProviderResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"UnauthorizedException"}, - {"shape":"ResourceLimitExceededException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"AccessDeniedException"}, - {"shape":"DecryptionFailure"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"}, - {"shape":"EncryptionFailure"} - ], - "idempotent":true - }, - "CreateBrowser":{ - "name":"CreateBrowser", - "http":{ - "method":"PUT", - "requestUri":"/browsers", - "responseCode":202 - }, - "input":{"shape":"CreateBrowserRequest"}, - "output":{"shape":"CreateBrowserResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "CreateBrowserProfile":{ - "name":"CreateBrowserProfile", - "http":{ - "method":"PUT", - "requestUri":"/browser-profiles", - "responseCode":200 - }, - "input":{"shape":"CreateBrowserProfileRequest"}, - "output":{"shape":"CreateBrowserProfileResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "CreateCodeInterpreter":{ - "name":"CreateCodeInterpreter", - "http":{ - "method":"PUT", - "requestUri":"/code-interpreters", - "responseCode":202 - }, - "input":{"shape":"CreateCodeInterpreterRequest"}, - "output":{"shape":"CreateCodeInterpreterResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "CreateConfigurationBundle":{ - "name":"CreateConfigurationBundle", - "http":{ - "method":"POST", - "requestUri":"/configuration-bundles/create", - "responseCode":201 - }, - "input":{"shape":"CreateConfigurationBundleRequest"}, - "output":{"shape":"CreateConfigurationBundleResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ] - }, - "CreateDataset":{ - "name":"CreateDataset", - "http":{ - "method":"POST", - "requestUri":"/datasets", - "responseCode":202 - }, - "input":{"shape":"CreateDatasetRequest"}, - "output":{"shape":"CreateDatasetResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ] - }, - "CreateDatasetVersion":{ - "name":"CreateDatasetVersion", - "http":{ - "method":"POST", - "requestUri":"/datasets/{datasetId}/versions", - "responseCode":202 - }, - "input":{"shape":"CreateDatasetVersionRequest"}, - "output":{"shape":"CreateDatasetVersionResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ] - }, - "CreateEvaluator":{ - "name":"CreateEvaluator", - "http":{ - "method":"POST", - "requestUri":"/evaluators/create", - "responseCode":202 - }, - "input":{"shape":"CreateEvaluatorRequest"}, - "output":{"shape":"CreateEvaluatorResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ] - }, - "CreateGateway":{ - "name":"CreateGateway", - "http":{ - "method":"POST", - "requestUri":"/gateways/", - "responseCode":202 - }, - "input":{"shape":"CreateGatewayRequest"}, - "output":{"shape":"CreateGatewayResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "CreateGatewayRule":{ - "name":"CreateGatewayRule", - "http":{ - "method":"POST", - "requestUri":"/gateways/{gatewayIdentifier}/rules", - "responseCode":202 - }, - "input":{"shape":"CreateGatewayRuleRequest"}, - "output":{"shape":"CreateGatewayRuleResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "CreateGatewayTarget":{ - "name":"CreateGatewayTarget", - "http":{ - "method":"POST", - "requestUri":"/gateways/{gatewayIdentifier}/targets/", - "responseCode":202 - }, - "input":{"shape":"CreateGatewayTargetRequest"}, - "output":{"shape":"CreateGatewayTargetResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "CreateHarness":{ - "name":"CreateHarness", - "http":{ - "method":"POST", - "requestUri":"/harnesses", - "responseCode":201 - }, - "input":{"shape":"CreateHarnessRequest"}, - "output":{"shape":"CreateHarnessResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "CreateHarnessEndpoint":{ - "name":"CreateHarnessEndpoint", - "http":{ - "method":"POST", - "requestUri":"/harnesses/{harnessId}/endpoints", - "responseCode":201 - }, - "input":{"shape":"CreateHarnessEndpointRequest"}, - "output":{"shape":"CreateHarnessEndpointResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "CreateMemory":{ - "name":"CreateMemory", - "http":{ - "method":"POST", - "requestUri":"/memories/create", - "responseCode":202 - }, - "input":{"shape":"CreateMemoryInput"}, - "output":{"shape":"CreateMemoryOutput"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ServiceException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottledException"} - ], - "idempotent":true - }, - "CreateOauth2CredentialProvider":{ - "name":"CreateOauth2CredentialProvider", - "http":{ - "method":"POST", - "requestUri":"/identities/CreateOauth2CredentialProvider", - "responseCode":201 - }, - "input":{"shape":"CreateOauth2CredentialProviderRequest"}, - "output":{"shape":"CreateOauth2CredentialProviderResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"UnauthorizedException"}, - {"shape":"ResourceLimitExceededException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"AccessDeniedException"}, - {"shape":"DecryptionFailure"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"}, - {"shape":"EncryptionFailure"} - ], - "idempotent":true - }, - "CreateOnlineEvaluationConfig":{ - "name":"CreateOnlineEvaluationConfig", - "http":{ - "method":"POST", - "requestUri":"/online-evaluation-configs/create", - "responseCode":202 - }, - "input":{"shape":"CreateOnlineEvaluationConfigRequest"}, - "output":{"shape":"CreateOnlineEvaluationConfigResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ] - }, - "CreatePaymentConnector":{ - "name":"CreatePaymentConnector", - "http":{ - "method":"POST", - "requestUri":"/payments/managers/{paymentManagerId}/connectors", - "responseCode":202 - }, - "input":{"shape":"CreatePaymentConnectorRequest"}, - "output":{"shape":"CreatePaymentConnectorResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "CreatePaymentCredentialProvider":{ - "name":"CreatePaymentCredentialProvider", - "http":{ - "method":"POST", - "requestUri":"/identities/CreatePaymentCredentialProvider", - "responseCode":201 - }, - "input":{"shape":"CreatePaymentCredentialProviderRequest"}, - "output":{"shape":"CreatePaymentCredentialProviderResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"UnauthorizedException"}, - {"shape":"ResourceLimitExceededException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"AccessDeniedException"}, - {"shape":"DecryptionFailure"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"}, - {"shape":"EncryptionFailure"} - ], - "idempotent":true - }, - "CreatePaymentManager":{ - "name":"CreatePaymentManager", - "http":{ - "method":"POST", - "requestUri":"/payments/managers", - "responseCode":202 - }, - "input":{"shape":"CreatePaymentManagerRequest"}, - "output":{"shape":"CreatePaymentManagerResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "CreatePolicy":{ - "name":"CreatePolicy", - "http":{ - "method":"POST", - "requestUri":"/policy-engines/{policyEngineId}/policies", - "responseCode":202 - }, - "input":{"shape":"CreatePolicyRequest"}, - "output":{"shape":"CreatePolicyResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ] - }, - "CreatePolicyEngine":{ - "name":"CreatePolicyEngine", - "http":{ - "method":"POST", - "requestUri":"/policy-engines", - "responseCode":202 - }, - "input":{"shape":"CreatePolicyEngineRequest"}, - "output":{"shape":"CreatePolicyEngineResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ] - }, - "CreateRegistry":{ - "name":"CreateRegistry", - "http":{ - "method":"POST", - "requestUri":"/registries", - "responseCode":202 - }, - "input":{"shape":"CreateRegistryRequest"}, - "output":{"shape":"CreateRegistryResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "CreateRegistryRecord":{ - "name":"CreateRegistryRecord", - "http":{ - "method":"POST", - "requestUri":"/registries/{registryId}/records", - "responseCode":202 - }, - "input":{"shape":"CreateRegistryRecordRequest"}, - "output":{"shape":"CreateRegistryRecordResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "CreateWorkloadIdentity":{ - "name":"CreateWorkloadIdentity", - "http":{ - "method":"POST", - "requestUri":"/identities/CreateWorkloadIdentity", - "responseCode":201 - }, - "input":{"shape":"CreateWorkloadIdentityRequest"}, - "output":{"shape":"CreateWorkloadIdentityResponse"}, - "errors":[ - {"shape":"UnauthorizedException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "DeleteAgentRuntime":{ - "name":"DeleteAgentRuntime", - "http":{ - "method":"DELETE", - "requestUri":"/runtimes/{agentRuntimeId}/", - "responseCode":202 - }, - "input":{"shape":"DeleteAgentRuntimeRequest"}, - "output":{"shape":"DeleteAgentRuntimeResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "DeleteAgentRuntimeEndpoint":{ - "name":"DeleteAgentRuntimeEndpoint", - "http":{ - "method":"DELETE", - "requestUri":"/runtimes/{agentRuntimeId}/runtime-endpoints/{endpointName}/", - "responseCode":202 - }, - "input":{"shape":"DeleteAgentRuntimeEndpointRequest"}, - "output":{"shape":"DeleteAgentRuntimeEndpointResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "DeleteApiKeyCredentialProvider":{ - "name":"DeleteApiKeyCredentialProvider", - "http":{ - "method":"POST", - "requestUri":"/identities/DeleteApiKeyCredentialProvider", - "responseCode":204 - }, - "input":{"shape":"DeleteApiKeyCredentialProviderRequest"}, - "output":{"shape":"DeleteApiKeyCredentialProviderResponse"}, - "errors":[ - {"shape":"UnauthorizedException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "DeleteBrowser":{ - "name":"DeleteBrowser", - "http":{ - "method":"DELETE", - "requestUri":"/browsers/{browserId}", - "responseCode":202 - }, - "input":{"shape":"DeleteBrowserRequest"}, - "output":{"shape":"DeleteBrowserResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "DeleteBrowserProfile":{ - "name":"DeleteBrowserProfile", - "http":{ - "method":"DELETE", - "requestUri":"/browser-profiles/{profileId}", - "responseCode":200 - }, - "input":{"shape":"DeleteBrowserProfileRequest"}, - "output":{"shape":"DeleteBrowserProfileResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "DeleteCodeInterpreter":{ - "name":"DeleteCodeInterpreter", - "http":{ - "method":"DELETE", - "requestUri":"/code-interpreters/{codeInterpreterId}", - "responseCode":202 - }, - "input":{"shape":"DeleteCodeInterpreterRequest"}, - "output":{"shape":"DeleteCodeInterpreterResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "DeleteConfigurationBundle":{ - "name":"DeleteConfigurationBundle", - "http":{ - "method":"DELETE", - "requestUri":"/configuration-bundles/{bundleId}", - "responseCode":202 - }, - "input":{"shape":"DeleteConfigurationBundleRequest"}, - "output":{"shape":"DeleteConfigurationBundleResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "DeleteDataset":{ - "name":"DeleteDataset", - "http":{ - "method":"DELETE", - "requestUri":"/datasets/{datasetId}", - "responseCode":202 - }, - "input":{"shape":"DeleteDatasetRequest"}, - "output":{"shape":"DeleteDatasetResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "DeleteDatasetExamples":{ - "name":"DeleteDatasetExamples", - "http":{ - "method":"POST", - "requestUri":"/datasets/{datasetId}/examples/delete", - "responseCode":202 - }, - "input":{"shape":"DeleteDatasetExamplesRequest"}, - "output":{"shape":"DeleteDatasetExamplesResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ] - }, - "DeleteEvaluator":{ - "name":"DeleteEvaluator", - "http":{ - "method":"DELETE", - "requestUri":"/evaluators/{evaluatorId}", - "responseCode":202 - }, - "input":{"shape":"DeleteEvaluatorRequest"}, - "output":{"shape":"DeleteEvaluatorResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "DeleteGateway":{ - "name":"DeleteGateway", - "http":{ - "method":"DELETE", - "requestUri":"/gateways/{gatewayIdentifier}/", - "responseCode":202 - }, - "input":{"shape":"DeleteGatewayRequest"}, - "output":{"shape":"DeleteGatewayResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "DeleteGatewayRule":{ - "name":"DeleteGatewayRule", - "http":{ - "method":"DELETE", - "requestUri":"/gateways/{gatewayIdentifier}/rules/{ruleId}", - "responseCode":202 - }, - "input":{"shape":"DeleteGatewayRuleRequest"}, - "output":{"shape":"DeleteGatewayRuleResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "DeleteGatewayTarget":{ - "name":"DeleteGatewayTarget", - "http":{ - "method":"DELETE", - "requestUri":"/gateways/{gatewayIdentifier}/targets/{targetId}/", - "responseCode":202 - }, - "input":{"shape":"DeleteGatewayTargetRequest"}, - "output":{"shape":"DeleteGatewayTargetResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "DeleteHarness":{ - "name":"DeleteHarness", - "http":{ - "method":"DELETE", - "requestUri":"/harnesses/{harnessId}", - "responseCode":200 - }, - "input":{"shape":"DeleteHarnessRequest"}, - "output":{"shape":"DeleteHarnessResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "DeleteHarnessEndpoint":{ - "name":"DeleteHarnessEndpoint", - "http":{ - "method":"DELETE", - "requestUri":"/harnesses/{harnessId}/endpoints/{endpointName}", - "responseCode":200 - }, - "input":{"shape":"DeleteHarnessEndpointRequest"}, - "output":{"shape":"DeleteHarnessEndpointResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "DeleteMemory":{ - "name":"DeleteMemory", - "http":{ - "method":"DELETE", - "requestUri":"/memories/{memoryId}/delete", - "responseCode":202 - }, - "input":{"shape":"DeleteMemoryInput"}, - "output":{"shape":"DeleteMemoryOutput"}, - "errors":[ - {"shape":"ServiceException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottledException"} - ], - "idempotent":true - }, - "DeleteOauth2CredentialProvider":{ - "name":"DeleteOauth2CredentialProvider", - "http":{ - "method":"POST", - "requestUri":"/identities/DeleteOauth2CredentialProvider", - "responseCode":204 - }, - "input":{"shape":"DeleteOauth2CredentialProviderRequest"}, - "output":{"shape":"DeleteOauth2CredentialProviderResponse"}, - "errors":[ - {"shape":"UnauthorizedException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "DeleteOnlineEvaluationConfig":{ - "name":"DeleteOnlineEvaluationConfig", - "http":{ - "method":"DELETE", - "requestUri":"/online-evaluation-configs/{onlineEvaluationConfigId}", - "responseCode":202 - }, - "input":{"shape":"DeleteOnlineEvaluationConfigRequest"}, - "output":{"shape":"DeleteOnlineEvaluationConfigResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "DeletePaymentConnector":{ - "name":"DeletePaymentConnector", - "http":{ - "method":"DELETE", - "requestUri":"/payments/managers/{paymentManagerId}/connectors/{paymentConnectorId}", - "responseCode":202 - }, - "input":{"shape":"DeletePaymentConnectorRequest"}, - "output":{"shape":"DeletePaymentConnectorResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "DeletePaymentCredentialProvider":{ - "name":"DeletePaymentCredentialProvider", - "http":{ - "method":"POST", - "requestUri":"/identities/DeletePaymentCredentialProvider", - "responseCode":204 - }, - "input":{"shape":"DeletePaymentCredentialProviderRequest"}, - "output":{"shape":"DeletePaymentCredentialProviderResponse"}, - "errors":[ - {"shape":"UnauthorizedException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "DeletePaymentManager":{ - "name":"DeletePaymentManager", - "http":{ - "method":"DELETE", - "requestUri":"/payments/managers/{paymentManagerId}", - "responseCode":202 - }, - "input":{"shape":"DeletePaymentManagerRequest"}, - "output":{"shape":"DeletePaymentManagerResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "DeletePolicy":{ - "name":"DeletePolicy", - "http":{ - "method":"DELETE", - "requestUri":"/policy-engines/{policyEngineId}/policies/{policyId}", - "responseCode":202 - }, - "input":{"shape":"DeletePolicyRequest"}, - "output":{"shape":"DeletePolicyResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "DeletePolicyEngine":{ - "name":"DeletePolicyEngine", - "http":{ - "method":"DELETE", - "requestUri":"/policy-engines/{policyEngineId}", - "responseCode":202 - }, - "input":{"shape":"DeletePolicyEngineRequest"}, - "output":{"shape":"DeletePolicyEngineResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "DeleteRegistry":{ - "name":"DeleteRegistry", - "http":{ - "method":"DELETE", - "requestUri":"/registries/{registryId}", - "responseCode":202 - }, - "input":{"shape":"DeleteRegistryRequest"}, - "output":{"shape":"DeleteRegistryResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "DeleteRegistryRecord":{ - "name":"DeleteRegistryRecord", - "http":{ - "method":"DELETE", - "requestUri":"/registries/{registryId}/records/{recordId}", - "responseCode":200 - }, - "input":{"shape":"DeleteRegistryRecordRequest"}, - "output":{"shape":"DeleteRegistryRecordResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "DeleteResourcePolicy":{ - "name":"DeleteResourcePolicy", - "http":{ - "method":"DELETE", - "requestUri":"/resourcepolicy/{resourceArn}", - "responseCode":204 - }, - "input":{"shape":"DeleteResourcePolicyRequest"}, - "output":{"shape":"DeleteResourcePolicyResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "DeleteWorkloadIdentity":{ - "name":"DeleteWorkloadIdentity", - "http":{ - "method":"POST", - "requestUri":"/identities/DeleteWorkloadIdentity", - "responseCode":204 - }, - "input":{"shape":"DeleteWorkloadIdentityRequest"}, - "output":{"shape":"DeleteWorkloadIdentityResponse"}, - "errors":[ - {"shape":"UnauthorizedException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "GetAgentRuntime":{ - "name":"GetAgentRuntime", - "http":{ - "method":"GET", - "requestUri":"/runtimes/{agentRuntimeId}/", - "responseCode":200 - }, - "input":{"shape":"GetAgentRuntimeRequest"}, - "output":{"shape":"GetAgentRuntimeResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "GetAgentRuntimeEndpoint":{ - "name":"GetAgentRuntimeEndpoint", - "http":{ - "method":"GET", - "requestUri":"/runtimes/{agentRuntimeId}/runtime-endpoints/{endpointName}/", - "responseCode":200 - }, - "input":{"shape":"GetAgentRuntimeEndpointRequest"}, - "output":{"shape":"GetAgentRuntimeEndpointResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "GetApiKeyCredentialProvider":{ - "name":"GetApiKeyCredentialProvider", - "http":{ - "method":"POST", - "requestUri":"/identities/GetApiKeyCredentialProvider", - "responseCode":200 - }, - "input":{"shape":"GetApiKeyCredentialProviderRequest"}, - "output":{"shape":"GetApiKeyCredentialProviderResponse"}, - "errors":[ - {"shape":"UnauthorizedException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"DecryptionFailure"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "GetBrowser":{ - "name":"GetBrowser", - "http":{ - "method":"GET", - "requestUri":"/browsers/{browserId}", - "responseCode":200 - }, - "input":{"shape":"GetBrowserRequest"}, - "output":{"shape":"GetBrowserResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "GetBrowserProfile":{ - "name":"GetBrowserProfile", - "http":{ - "method":"GET", - "requestUri":"/browser-profiles/{profileId}", - "responseCode":200 - }, - "input":{"shape":"GetBrowserProfileRequest"}, - "output":{"shape":"GetBrowserProfileResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "GetCodeInterpreter":{ - "name":"GetCodeInterpreter", - "http":{ - "method":"GET", - "requestUri":"/code-interpreters/{codeInterpreterId}", - "responseCode":200 - }, - "input":{"shape":"GetCodeInterpreterRequest"}, - "output":{"shape":"GetCodeInterpreterResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "GetConfigurationBundle":{ - "name":"GetConfigurationBundle", - "http":{ - "method":"GET", - "requestUri":"/configuration-bundles/{bundleId}", - "responseCode":200 - }, - "input":{"shape":"GetConfigurationBundleRequest"}, - "output":{"shape":"GetConfigurationBundleResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "GetConfigurationBundleVersion":{ - "name":"GetConfigurationBundleVersion", - "http":{ - "method":"GET", - "requestUri":"/configuration-bundles/{bundleId}/versions/{versionId}", - "responseCode":200 - }, - "input":{"shape":"GetConfigurationBundleVersionRequest"}, - "output":{"shape":"GetConfigurationBundleVersionResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "GetDataset":{ - "name":"GetDataset", - "http":{ - "method":"GET", - "requestUri":"/datasets/{datasetId}", - "responseCode":200 - }, - "input":{"shape":"GetDatasetRequest"}, - "output":{"shape":"GetDatasetResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "GetEvaluator":{ - "name":"GetEvaluator", - "http":{ - "method":"GET", - "requestUri":"/evaluators/{evaluatorId}", - "responseCode":200 - }, - "input":{"shape":"GetEvaluatorRequest"}, - "output":{"shape":"GetEvaluatorResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "GetGateway":{ - "name":"GetGateway", - "http":{ - "method":"GET", - "requestUri":"/gateways/{gatewayIdentifier}/", - "responseCode":200 - }, - "input":{"shape":"GetGatewayRequest"}, - "output":{"shape":"GetGatewayResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "GetGatewayRule":{ - "name":"GetGatewayRule", - "http":{ - "method":"GET", - "requestUri":"/gateways/{gatewayIdentifier}/rules/{ruleId}", - "responseCode":200 - }, - "input":{"shape":"GetGatewayRuleRequest"}, - "output":{"shape":"GetGatewayRuleResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "GetGatewayTarget":{ - "name":"GetGatewayTarget", - "http":{ - "method":"GET", - "requestUri":"/gateways/{gatewayIdentifier}/targets/{targetId}/", - "responseCode":200 - }, - "input":{"shape":"GetGatewayTargetRequest"}, - "output":{"shape":"GetGatewayTargetResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "GetHarness":{ - "name":"GetHarness", - "http":{ - "method":"GET", - "requestUri":"/harnesses/{harnessId}", - "responseCode":200 - }, - "input":{"shape":"GetHarnessRequest"}, - "output":{"shape":"GetHarnessResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "GetHarnessEndpoint":{ - "name":"GetHarnessEndpoint", - "http":{ - "method":"GET", - "requestUri":"/harnesses/{harnessId}/endpoints/{endpointName}", - "responseCode":200 - }, - "input":{"shape":"GetHarnessEndpointRequest"}, - "output":{"shape":"GetHarnessEndpointResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "GetMemory":{ - "name":"GetMemory", - "http":{ - "method":"GET", - "requestUri":"/memories/{memoryId}/details", - "responseCode":200 - }, - "input":{"shape":"GetMemoryInput"}, - "output":{"shape":"GetMemoryOutput"}, - "errors":[ - {"shape":"ServiceException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottledException"} - ], - "readonly":true - }, - "GetOauth2CredentialProvider":{ - "name":"GetOauth2CredentialProvider", - "http":{ - "method":"POST", - "requestUri":"/identities/GetOauth2CredentialProvider", - "responseCode":200 - }, - "input":{"shape":"GetOauth2CredentialProviderRequest"}, - "output":{"shape":"GetOauth2CredentialProviderResponse"}, - "errors":[ - {"shape":"UnauthorizedException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"DecryptionFailure"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "GetOnlineEvaluationConfig":{ - "name":"GetOnlineEvaluationConfig", - "http":{ - "method":"GET", - "requestUri":"/online-evaluation-configs/{onlineEvaluationConfigId}", - "responseCode":200 - }, - "input":{"shape":"GetOnlineEvaluationConfigRequest"}, - "output":{"shape":"GetOnlineEvaluationConfigResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "GetPaymentConnector":{ - "name":"GetPaymentConnector", - "http":{ - "method":"GET", - "requestUri":"/payments/managers/{paymentManagerId}/connectors/{paymentConnectorId}", - "responseCode":200 - }, - "input":{"shape":"GetPaymentConnectorRequest"}, - "output":{"shape":"GetPaymentConnectorResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "GetPaymentCredentialProvider":{ - "name":"GetPaymentCredentialProvider", - "http":{ - "method":"POST", - "requestUri":"/identities/GetPaymentCredentialProvider", - "responseCode":200 - }, - "input":{"shape":"GetPaymentCredentialProviderRequest"}, - "output":{"shape":"GetPaymentCredentialProviderResponse"}, - "errors":[ - {"shape":"UnauthorizedException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"DecryptionFailure"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "GetPaymentManager":{ - "name":"GetPaymentManager", - "http":{ - "method":"GET", - "requestUri":"/payments/managers/{paymentManagerId}", - "responseCode":200 - }, - "input":{"shape":"GetPaymentManagerRequest"}, - "output":{"shape":"GetPaymentManagerResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "GetPolicy":{ - "name":"GetPolicy", - "http":{ - "method":"GET", - "requestUri":"/policy-engines/{policyEngineId}/policies/{policyId}", - "responseCode":200 - }, - "input":{"shape":"GetPolicyRequest"}, - "output":{"shape":"GetPolicyResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "GetPolicyEngine":{ - "name":"GetPolicyEngine", - "http":{ - "method":"GET", - "requestUri":"/policy-engines/{policyEngineId}", - "responseCode":200 - }, - "input":{"shape":"GetPolicyEngineRequest"}, - "output":{"shape":"GetPolicyEngineResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "GetPolicyEngineSummary":{ - "name":"GetPolicyEngineSummary", - "http":{ - "method":"GET", - "requestUri":"/policy-engine-summaries/{policyEngineId}", - "responseCode":200 - }, - "input":{"shape":"GetPolicyEngineSummaryRequest"}, - "output":{"shape":"GetPolicyEngineSummaryResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "GetPolicyGeneration":{ - "name":"GetPolicyGeneration", - "http":{ - "method":"GET", - "requestUri":"/policy-engines/{policyEngineId}/policy-generations/{policyGenerationId}", - "responseCode":200 - }, - "input":{"shape":"GetPolicyGenerationRequest"}, - "output":{"shape":"GetPolicyGenerationResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "GetPolicyGenerationSummary":{ - "name":"GetPolicyGenerationSummary", - "http":{ - "method":"GET", - "requestUri":"/policy-engines/{policyEngineId}/policy-generation-summaries/{policyGenerationId}", - "responseCode":200 - }, - "input":{"shape":"GetPolicyGenerationSummaryRequest"}, - "output":{"shape":"GetPolicyGenerationSummaryResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "GetPolicySummary":{ - "name":"GetPolicySummary", - "http":{ - "method":"GET", - "requestUri":"/policy-engines/{policyEngineId}/policy-summaries/{policyId}", - "responseCode":200 - }, - "input":{"shape":"GetPolicySummaryRequest"}, - "output":{"shape":"GetPolicySummaryResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "GetRegistry":{ - "name":"GetRegistry", - "http":{ - "method":"GET", - "requestUri":"/registries/{registryId}", - "responseCode":200 - }, - "input":{"shape":"GetRegistryRequest"}, - "output":{"shape":"GetRegistryResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "GetRegistryRecord":{ - "name":"GetRegistryRecord", - "http":{ - "method":"GET", - "requestUri":"/registries/{registryId}/records/{recordId}", - "responseCode":200 - }, - "input":{"shape":"GetRegistryRecordRequest"}, - "output":{"shape":"GetRegistryRecordResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "GetResourcePolicy":{ - "name":"GetResourcePolicy", - "http":{ - "method":"GET", - "requestUri":"/resourcepolicy/{resourceArn}", - "responseCode":200 - }, - "input":{"shape":"GetResourcePolicyRequest"}, - "output":{"shape":"GetResourcePolicyResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "GetTokenVault":{ - "name":"GetTokenVault", - "http":{ - "method":"POST", - "requestUri":"/identities/get-token-vault", - "responseCode":200 - }, - "input":{"shape":"GetTokenVaultRequest"}, - "output":{"shape":"GetTokenVaultResponse"}, - "errors":[ - {"shape":"UnauthorizedException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "GetWorkloadIdentity":{ - "name":"GetWorkloadIdentity", - "http":{ - "method":"POST", - "requestUri":"/identities/GetWorkloadIdentity", - "responseCode":200 - }, - "input":{"shape":"GetWorkloadIdentityRequest"}, - "output":{"shape":"GetWorkloadIdentityResponse"}, - "errors":[ - {"shape":"UnauthorizedException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "ListAgentRuntimeEndpoints":{ - "name":"ListAgentRuntimeEndpoints", - "http":{ - "method":"POST", - "requestUri":"/runtimes/{agentRuntimeId}/runtime-endpoints/", - "responseCode":200 - }, - "input":{"shape":"ListAgentRuntimeEndpointsRequest"}, - "output":{"shape":"ListAgentRuntimeEndpointsResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "ListAgentRuntimeVersions":{ - "name":"ListAgentRuntimeVersions", - "http":{ - "method":"POST", - "requestUri":"/runtimes/{agentRuntimeId}/versions/", - "responseCode":200 - }, - "input":{"shape":"ListAgentRuntimeVersionsRequest"}, - "output":{"shape":"ListAgentRuntimeVersionsResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "ListAgentRuntimes":{ - "name":"ListAgentRuntimes", - "http":{ - "method":"POST", - "requestUri":"/runtimes/", - "responseCode":200 - }, - "input":{"shape":"ListAgentRuntimesRequest"}, - "output":{"shape":"ListAgentRuntimesResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "ListApiKeyCredentialProviders":{ - "name":"ListApiKeyCredentialProviders", - "http":{ - "method":"POST", - "requestUri":"/identities/ListApiKeyCredentialProviders", - "responseCode":200 - }, - "input":{"shape":"ListApiKeyCredentialProvidersRequest"}, - "output":{"shape":"ListApiKeyCredentialProvidersResponse"}, - "errors":[ - {"shape":"UnauthorizedException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "ListBrowserProfiles":{ - "name":"ListBrowserProfiles", - "http":{ - "method":"POST", - "requestUri":"/browser-profiles", - "responseCode":200 - }, - "input":{"shape":"ListBrowserProfilesRequest"}, - "output":{"shape":"ListBrowserProfilesResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "ListBrowsers":{ - "name":"ListBrowsers", - "http":{ - "method":"POST", - "requestUri":"/browsers", - "responseCode":200 - }, - "input":{"shape":"ListBrowsersRequest"}, - "output":{"shape":"ListBrowsersResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "ListCodeInterpreters":{ - "name":"ListCodeInterpreters", - "http":{ - "method":"POST", - "requestUri":"/code-interpreters", - "responseCode":200 - }, - "input":{"shape":"ListCodeInterpretersRequest"}, - "output":{"shape":"ListCodeInterpretersResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "ListConfigurationBundleVersions":{ - "name":"ListConfigurationBundleVersions", - "http":{ - "method":"POST", - "requestUri":"/configuration-bundles/{bundleId}/versions", - "responseCode":200 - }, - "input":{"shape":"ListConfigurationBundleVersionsRequest"}, - "output":{"shape":"ListConfigurationBundleVersionsResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "ListConfigurationBundles":{ - "name":"ListConfigurationBundles", - "http":{ - "method":"POST", - "requestUri":"/configuration-bundles", - "responseCode":200 - }, - "input":{"shape":"ListConfigurationBundlesRequest"}, - "output":{"shape":"ListConfigurationBundlesResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "ListDatasetExamples":{ - "name":"ListDatasetExamples", - "http":{ - "method":"GET", - "requestUri":"/datasets/{datasetId}/examples", - "responseCode":200 - }, - "input":{"shape":"ListDatasetExamplesRequest"}, - "output":{"shape":"ListDatasetExamplesResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "ListDatasetVersions":{ - "name":"ListDatasetVersions", - "http":{ - "method":"GET", - "requestUri":"/datasets/{datasetId}/versions", - "responseCode":200 - }, - "input":{"shape":"ListDatasetVersionsRequest"}, - "output":{"shape":"ListDatasetVersionsResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "ListDatasets":{ - "name":"ListDatasets", - "http":{ - "method":"GET", - "requestUri":"/datasets", - "responseCode":200 - }, - "input":{"shape":"ListDatasetsRequest"}, - "output":{"shape":"ListDatasetsResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "ListEvaluators":{ - "name":"ListEvaluators", - "http":{ - "method":"POST", - "requestUri":"/evaluators", - "responseCode":200 - }, - "input":{"shape":"ListEvaluatorsRequest"}, - "output":{"shape":"ListEvaluatorsResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "ListGatewayRules":{ - "name":"ListGatewayRules", - "http":{ - "method":"GET", - "requestUri":"/gateways/{gatewayIdentifier}/rules", - "responseCode":200 - }, - "input":{"shape":"ListGatewayRulesRequest"}, - "output":{"shape":"ListGatewayRulesResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "ListGatewayTargets":{ - "name":"ListGatewayTargets", - "http":{ - "method":"GET", - "requestUri":"/gateways/{gatewayIdentifier}/targets/", - "responseCode":200 - }, - "input":{"shape":"ListGatewayTargetsRequest"}, - "output":{"shape":"ListGatewayTargetsResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "ListGateways":{ - "name":"ListGateways", - "http":{ - "method":"GET", - "requestUri":"/gateways/", - "responseCode":200 - }, - "input":{"shape":"ListGatewaysRequest"}, - "output":{"shape":"ListGatewaysResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "ListHarnessEndpoints":{ - "name":"ListHarnessEndpoints", - "http":{ - "method":"GET", - "requestUri":"/harnesses/{harnessId}/endpoints", - "responseCode":200 - }, - "input":{"shape":"ListHarnessEndpointsRequest"}, - "output":{"shape":"ListHarnessEndpointsResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "ListHarnessVersions":{ - "name":"ListHarnessVersions", - "http":{ - "method":"GET", - "requestUri":"/harnesses/{harnessId}/versions", - "responseCode":200 - }, - "input":{"shape":"ListHarnessVersionsRequest"}, - "output":{"shape":"ListHarnessVersionsResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "ListHarnesses":{ - "name":"ListHarnesses", - "http":{ - "method":"GET", - "requestUri":"/harnesses", - "responseCode":200 - }, - "input":{"shape":"ListHarnessesRequest"}, - "output":{"shape":"ListHarnessesResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "ListMemories":{ - "name":"ListMemories", - "http":{ - "method":"POST", - "requestUri":"/memories/", - "responseCode":200 - }, - "input":{"shape":"ListMemoriesInput"}, - "output":{"shape":"ListMemoriesOutput"}, - "errors":[ - {"shape":"ServiceException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottledException"} - ], - "readonly":true - }, - "ListOauth2CredentialProviders":{ - "name":"ListOauth2CredentialProviders", - "http":{ - "method":"POST", - "requestUri":"/identities/ListOauth2CredentialProviders", - "responseCode":200 - }, - "input":{"shape":"ListOauth2CredentialProvidersRequest"}, - "output":{"shape":"ListOauth2CredentialProvidersResponse"}, - "errors":[ - {"shape":"UnauthorizedException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "ListOnlineEvaluationConfigs":{ - "name":"ListOnlineEvaluationConfigs", - "http":{ - "method":"POST", - "requestUri":"/online-evaluation-configs", - "responseCode":200 - }, - "input":{"shape":"ListOnlineEvaluationConfigsRequest"}, - "output":{"shape":"ListOnlineEvaluationConfigsResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "ListPaymentConnectors":{ - "name":"ListPaymentConnectors", - "http":{ - "method":"POST", - "requestUri":"/payments/managers/{paymentManagerId}/connectors-list", - "responseCode":200 - }, - "input":{"shape":"ListPaymentConnectorsRequest"}, - "output":{"shape":"ListPaymentConnectorsResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "ListPaymentCredentialProviders":{ - "name":"ListPaymentCredentialProviders", - "http":{ - "method":"POST", - "requestUri":"/identities/ListPaymentCredentialProviders", - "responseCode":200 - }, - "input":{"shape":"ListPaymentCredentialProvidersRequest"}, - "output":{"shape":"ListPaymentCredentialProvidersResponse"}, - "errors":[ - {"shape":"UnauthorizedException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "ListPaymentManagers":{ - "name":"ListPaymentManagers", - "http":{ - "method":"POST", - "requestUri":"/payments/managers-list", - "responseCode":200 - }, - "input":{"shape":"ListPaymentManagersRequest"}, - "output":{"shape":"ListPaymentManagersResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "ListPolicies":{ - "name":"ListPolicies", - "http":{ - "method":"GET", - "requestUri":"/policy-engines/{policyEngineId}/policies", - "responseCode":200 - }, - "input":{"shape":"ListPoliciesRequest"}, - "output":{"shape":"ListPoliciesResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "ListPolicyEngineSummaries":{ - "name":"ListPolicyEngineSummaries", - "http":{ - "method":"GET", - "requestUri":"/policy-engine-summaries", - "responseCode":200 - }, - "input":{"shape":"ListPolicyEngineSummariesRequest"}, - "output":{"shape":"ListPolicyEngineSummariesResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "ListPolicyEngines":{ - "name":"ListPolicyEngines", - "http":{ - "method":"GET", - "requestUri":"/policy-engines", - "responseCode":200 - }, - "input":{"shape":"ListPolicyEnginesRequest"}, - "output":{"shape":"ListPolicyEnginesResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "ListPolicyGenerationAssets":{ - "name":"ListPolicyGenerationAssets", - "http":{ - "method":"GET", - "requestUri":"/policy-engines/{policyEngineId}/policy-generations/{policyGenerationId}/assets", - "responseCode":200 - }, - "input":{"shape":"ListPolicyGenerationAssetsRequest"}, - "output":{"shape":"ListPolicyGenerationAssetsResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "ListPolicyGenerationSummaries":{ - "name":"ListPolicyGenerationSummaries", - "http":{ - "method":"GET", - "requestUri":"/policy-engines/{policyEngineId}/policy-generation-summaries", - "responseCode":200 - }, - "input":{"shape":"ListPolicyGenerationSummariesRequest"}, - "output":{"shape":"ListPolicyGenerationSummariesResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "ListPolicyGenerations":{ - "name":"ListPolicyGenerations", - "http":{ - "method":"GET", - "requestUri":"/policy-engines/{policyEngineId}/policy-generations", - "responseCode":200 - }, - "input":{"shape":"ListPolicyGenerationsRequest"}, - "output":{"shape":"ListPolicyGenerationsResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "ListPolicySummaries":{ - "name":"ListPolicySummaries", - "http":{ - "method":"GET", - "requestUri":"/policy-engines/{policyEngineId}/policy-summaries", - "responseCode":200 - }, - "input":{"shape":"ListPolicySummariesRequest"}, - "output":{"shape":"ListPolicySummariesResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "ListRegistries":{ - "name":"ListRegistries", - "http":{ - "method":"GET", - "requestUri":"/registries", - "responseCode":200 - }, - "input":{"shape":"ListRegistriesRequest"}, - "output":{"shape":"ListRegistriesResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "ListRegistryRecords":{ - "name":"ListRegistryRecords", - "http":{ - "method":"GET", - "requestUri":"/registries/{registryId}/records", - "responseCode":200 - }, - "input":{"shape":"ListRegistryRecordsRequest"}, - "output":{"shape":"ListRegistryRecordsResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "ListTagsForResource":{ - "name":"ListTagsForResource", - "http":{ - "method":"GET", - "requestUri":"/tags/{resourceArn}", - "responseCode":200 - }, - "input":{"shape":"ListTagsForResourceRequest"}, - "output":{"shape":"ListTagsForResourceResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "ListWorkloadIdentities":{ - "name":"ListWorkloadIdentities", - "http":{ - "method":"POST", - "requestUri":"/identities/ListWorkloadIdentities", - "responseCode":200 - }, - "input":{"shape":"ListWorkloadIdentitiesRequest"}, - "output":{"shape":"ListWorkloadIdentitiesResponse"}, - "errors":[ - {"shape":"UnauthorizedException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "readonly":true - }, - "PutResourcePolicy":{ - "name":"PutResourcePolicy", - "http":{ - "method":"PUT", - "requestUri":"/resourcepolicy/{resourceArn}", - "responseCode":201 - }, - "input":{"shape":"PutResourcePolicyRequest"}, - "output":{"shape":"PutResourcePolicyResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "SetTokenVaultCMK":{ - "name":"SetTokenVaultCMK", - "http":{ - "method":"POST", - "requestUri":"/identities/set-token-vault-cmk", - "responseCode":200 - }, - "input":{"shape":"SetTokenVaultCMKRequest"}, - "output":{"shape":"SetTokenVaultCMKResponse"}, - "errors":[ - {"shape":"UnauthorizedException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ] - }, - "StartPolicyGeneration":{ - "name":"StartPolicyGeneration", - "http":{ - "method":"POST", - "requestUri":"/policy-engines/{policyEngineId}/policy-generations", - "responseCode":202 - }, - "input":{"shape":"StartPolicyGenerationRequest"}, - "output":{"shape":"StartPolicyGenerationResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ] - }, - "SubmitRegistryRecordForApproval":{ - "name":"SubmitRegistryRecordForApproval", - "http":{ - "method":"POST", - "requestUri":"/registries/{registryId}/records/{recordId}/submit-for-approval", - "responseCode":202 - }, - "input":{"shape":"SubmitRegistryRecordForApprovalRequest"}, - "output":{"shape":"SubmitRegistryRecordForApprovalResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ] - }, - "SynchronizeGatewayTargets":{ - "name":"SynchronizeGatewayTargets", - "http":{ - "method":"PUT", - "requestUri":"/gateways/{gatewayIdentifier}/synchronizeTargets", - "responseCode":202 - }, - "input":{"shape":"SynchronizeGatewayTargetsRequest"}, - "output":{"shape":"SynchronizeGatewayTargetsResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "TagResource":{ - "name":"TagResource", - "http":{ - "method":"POST", - "requestUri":"/tags/{resourceArn}", - "responseCode":204 - }, - "input":{"shape":"TagResourceRequest"}, - "output":{"shape":"TagResourceResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ] - }, - "UntagResource":{ - "name":"UntagResource", - "http":{ - "method":"DELETE", - "requestUri":"/tags/{resourceArn}", - "responseCode":204 - }, - "input":{"shape":"UntagResourceRequest"}, - "output":{"shape":"UntagResourceResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "UpdateAgentRuntime":{ - "name":"UpdateAgentRuntime", - "http":{ - "method":"PUT", - "requestUri":"/runtimes/{agentRuntimeId}/", - "responseCode":202 - }, - "input":{"shape":"UpdateAgentRuntimeRequest"}, - "output":{"shape":"UpdateAgentRuntimeResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "UpdateAgentRuntimeEndpoint":{ - "name":"UpdateAgentRuntimeEndpoint", - "http":{ - "method":"PUT", - "requestUri":"/runtimes/{agentRuntimeId}/runtime-endpoints/{endpointName}/", - "responseCode":202 - }, - "input":{"shape":"UpdateAgentRuntimeEndpointRequest"}, - "output":{"shape":"UpdateAgentRuntimeEndpointResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "UpdateApiKeyCredentialProvider":{ - "name":"UpdateApiKeyCredentialProvider", - "http":{ - "method":"POST", - "requestUri":"/identities/UpdateApiKeyCredentialProvider", - "responseCode":200 - }, - "input":{"shape":"UpdateApiKeyCredentialProviderRequest"}, - "output":{"shape":"UpdateApiKeyCredentialProviderResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"UnauthorizedException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"DecryptionFailure"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"}, - {"shape":"EncryptionFailure"} - ], - "idempotent":true - }, - "UpdateConfigurationBundle":{ - "name":"UpdateConfigurationBundle", - "http":{ - "method":"PUT", - "requestUri":"/configuration-bundles/{bundleId}", - "responseCode":200 - }, - "input":{"shape":"UpdateConfigurationBundleRequest"}, - "output":{"shape":"UpdateConfigurationBundleResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ] - }, - "UpdateDataset":{ - "name":"UpdateDataset", - "http":{ - "method":"PUT", - "requestUri":"/datasets/{datasetId}", - "responseCode":200 - }, - "input":{"shape":"UpdateDatasetRequest"}, - "output":{"shape":"UpdateDatasetResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "UpdateDatasetExamples":{ - "name":"UpdateDatasetExamples", - "http":{ - "method":"POST", - "requestUri":"/datasets/{datasetId}/examples/update", - "responseCode":202 - }, - "input":{"shape":"UpdateDatasetExamplesRequest"}, - "output":{"shape":"UpdateDatasetExamplesResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ] - }, - "UpdateEvaluator":{ - "name":"UpdateEvaluator", - "http":{ - "method":"PUT", - "requestUri":"/evaluators/{evaluatorId}", - "responseCode":202 - }, - "input":{"shape":"UpdateEvaluatorRequest"}, - "output":{"shape":"UpdateEvaluatorResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "UpdateGateway":{ - "name":"UpdateGateway", - "http":{ - "method":"PUT", - "requestUri":"/gateways/{gatewayIdentifier}/", - "responseCode":202 - }, - "input":{"shape":"UpdateGatewayRequest"}, - "output":{"shape":"UpdateGatewayResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "UpdateGatewayRule":{ - "name":"UpdateGatewayRule", - "http":{ - "method":"PATCH", - "requestUri":"/gateways/{gatewayIdentifier}/rules/{ruleId}", - "responseCode":202 - }, - "input":{"shape":"UpdateGatewayRuleRequest"}, - "output":{"shape":"UpdateGatewayRuleResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "UpdateGatewayTarget":{ - "name":"UpdateGatewayTarget", - "http":{ - "method":"PUT", - "requestUri":"/gateways/{gatewayIdentifier}/targets/{targetId}/", - "responseCode":202 - }, - "input":{"shape":"UpdateGatewayTargetRequest"}, - "output":{"shape":"UpdateGatewayTargetResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "UpdateHarness":{ - "name":"UpdateHarness", - "http":{ - "method":"PATCH", - "requestUri":"/harnesses/{harnessId}", - "responseCode":200 - }, - "input":{"shape":"UpdateHarnessRequest"}, - "output":{"shape":"UpdateHarnessResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "UpdateHarnessEndpoint":{ - "name":"UpdateHarnessEndpoint", - "http":{ - "method":"PATCH", - "requestUri":"/harnesses/{harnessId}/endpoints/{endpointName}", - "responseCode":200 - }, - "input":{"shape":"UpdateHarnessEndpointRequest"}, - "output":{"shape":"UpdateHarnessEndpointResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "UpdateMemory":{ - "name":"UpdateMemory", - "http":{ - "method":"PUT", - "requestUri":"/memories/{memoryId}/update", - "responseCode":202 - }, - "input":{"shape":"UpdateMemoryInput"}, - "output":{"shape":"UpdateMemoryOutput"}, - "errors":[ - {"shape":"ServiceException"}, - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottledException"} - ], - "idempotent":true - }, - "UpdateOauth2CredentialProvider":{ - "name":"UpdateOauth2CredentialProvider", - "http":{ - "method":"POST", - "requestUri":"/identities/UpdateOauth2CredentialProvider", - "responseCode":200 - }, - "input":{"shape":"UpdateOauth2CredentialProviderRequest"}, - "output":{"shape":"UpdateOauth2CredentialProviderResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"UnauthorizedException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"DecryptionFailure"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"}, - {"shape":"EncryptionFailure"} - ] - }, - "UpdateOnlineEvaluationConfig":{ - "name":"UpdateOnlineEvaluationConfig", - "http":{ - "method":"PUT", - "requestUri":"/online-evaluation-configs/{onlineEvaluationConfigId}", - "responseCode":202 - }, - "input":{"shape":"UpdateOnlineEvaluationConfigRequest"}, - "output":{"shape":"UpdateOnlineEvaluationConfigResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "UpdatePaymentConnector":{ - "name":"UpdatePaymentConnector", - "http":{ - "method":"PATCH", - "requestUri":"/payments/managers/{paymentManagerId}/connectors/{paymentConnectorId}", - "responseCode":202 - }, - "input":{"shape":"UpdatePaymentConnectorRequest"}, - "output":{"shape":"UpdatePaymentConnectorResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "UpdatePaymentCredentialProvider":{ - "name":"UpdatePaymentCredentialProvider", - "http":{ - "method":"POST", - "requestUri":"/identities/UpdatePaymentCredentialProvider", - "responseCode":200 - }, - "input":{"shape":"UpdatePaymentCredentialProviderRequest"}, - "output":{"shape":"UpdatePaymentCredentialProviderResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"UnauthorizedException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"DecryptionFailure"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"}, - {"shape":"EncryptionFailure"} - ] - }, - "UpdatePaymentManager":{ - "name":"UpdatePaymentManager", - "http":{ - "method":"PATCH", - "requestUri":"/payments/managers/{paymentManagerId}", - "responseCode":202 - }, - "input":{"shape":"UpdatePaymentManagerRequest"}, - "output":{"shape":"UpdatePaymentManagerResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "UpdatePolicy":{ - "name":"UpdatePolicy", - "http":{ - "method":"PATCH", - "requestUri":"/policy-engines/{policyEngineId}/policies/{policyId}", - "responseCode":202 - }, - "input":{"shape":"UpdatePolicyRequest"}, - "output":{"shape":"UpdatePolicyResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "UpdatePolicyEngine":{ - "name":"UpdatePolicyEngine", - "http":{ - "method":"PATCH", - "requestUri":"/policy-engines/{policyEngineId}", - "responseCode":202 - }, - "input":{"shape":"UpdatePolicyEngineRequest"}, - "output":{"shape":"UpdatePolicyEngineResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - }, - "UpdateRegistry":{ - "name":"UpdateRegistry", - "http":{ - "method":"PATCH", - "requestUri":"/registries/{registryId}", - "responseCode":202 - }, - "input":{"shape":"UpdateRegistryRequest"}, - "output":{"shape":"UpdateRegistryResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ] - }, - "UpdateRegistryRecord":{ - "name":"UpdateRegistryRecord", - "http":{ - "method":"PATCH", - "requestUri":"/registries/{registryId}/records/{recordId}", - "responseCode":202 - }, - "input":{"shape":"UpdateRegistryRecordRequest"}, - "output":{"shape":"UpdateRegistryRecordResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ] - }, - "UpdateRegistryRecordStatus":{ - "name":"UpdateRegistryRecordStatus", - "http":{ - "method":"PATCH", - "requestUri":"/registries/{registryId}/records/{recordId}/status", - "responseCode":202 - }, - "input":{"shape":"UpdateRegistryRecordStatusRequest"}, - "output":{"shape":"UpdateRegistryRecordStatusResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ] - }, - "UpdateWorkloadIdentity":{ - "name":"UpdateWorkloadIdentity", - "http":{ - "method":"POST", - "requestUri":"/identities/UpdateWorkloadIdentity", - "responseCode":200 - }, - "input":{"shape":"UpdateWorkloadIdentityRequest"}, - "output":{"shape":"UpdateWorkloadIdentityResponse"}, - "errors":[ - {"shape":"UnauthorizedException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "idempotent":true - } - }, - "shapes":{ - "A2aDescriptor":{ - "type":"structure", - "members":{ - "agentCard":{"shape":"AgentCardDefinition"} - } - }, - "AccessDeniedException":{ - "type":"structure", - "members":{ - "message":{"shape":"NonBlankString"} - }, - "error":{ - "httpStatusCode":403, - "senderFault":true - }, - "exception":true - }, - "Action":{ - "type":"structure", - "members":{ - "configurationBundle":{"shape":"ConfigurationBundleAction"}, - "routeToTarget":{"shape":"RouteToTargetAction"} - }, - "union":true - }, - "Actions":{ - "type":"list", - "member":{"shape":"Action"}, - "max":2, - "min":1 - }, - "ActorTokenContentType":{ - "type":"string", - "enum":[ - "NONE", - "M2M", - "AWS_IAM_ID_TOKEN_JWT" - ] - }, - "AddDatasetExamplesRequest":{ - "type":"structure", - "required":[ - "datasetId", - "source" - ], - "members":{ - "datasetId":{ - "shape":"DatasetId", - "location":"uri", - "locationName":"datasetId" - }, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - }, - "source":{"shape":"DataSourceType"} - } - }, - "AddDatasetExamplesResponse":{ - "type":"structure", - "required":[ - "datasetArn", - "datasetId", - "status", - "addedCount", - "updatedAt", - "exampleIds" - ], - "members":{ - "datasetArn":{"shape":"DatasetArn"}, - "datasetId":{"shape":"DatasetId"}, - "status":{"shape":"DatasetStatus"}, - "addedCount":{"shape":"Long"}, - "updatedAt":{"shape":"Timestamp"}, - "exampleIds":{"shape":"ExampleIdList"} - } - }, - "AdditionalClaimName":{ - "type":"string", - "max":255, - "min":1, - "pattern":"[A-Za-z0-9_.:#-]+" - }, - "AdditionalClaimValue":{ - "type":"string", - "max":2048, - "min":1, - "sensitive":true - }, - "AdditionalClaims":{ - "type":"map", - "key":{"shape":"AdditionalClaimName"}, - "value":{"shape":"AdditionalClaimValue"}, - "max":10, - "min":1 - }, - "AdditionalModelRequestFields":{ - "type":"structure", - "members":{}, - "document":true - }, - "AdvertisedScopeMappingType":{ - "type":"map", - "key":{"shape":"AllowedScopeType"}, - "value":{"shape":"AllowedScopeType"}, - "max":50, - "min":1 - }, - "AgentCardDefinition":{ - "type":"structure", - "members":{ - "schemaVersion":{"shape":"SchemaVersion"}, - "inlineContent":{"shape":"InlineContent"} - } - }, - "AgentEndpointDescription":{ - "type":"string", - "max":256, - "min":1 - }, - "AgentManagedRuntimeType":{ - "type":"string", - "enum":[ - "PYTHON_3_10", - "PYTHON_3_11", - "PYTHON_3_12", - "PYTHON_3_13", - "PYTHON_3_14", - "NODE_22" - ] - }, - "AgentRuntime":{ - "type":"structure", - "required":[ - "agentRuntimeArn", - "agentRuntimeId", - "agentRuntimeVersion", - "agentRuntimeName", - "description", - "lastUpdatedAt", - "status" - ], - "members":{ - "agentRuntimeArn":{"shape":"AgentRuntimeArn"}, - "agentRuntimeId":{"shape":"AgentRuntimeId"}, - "agentRuntimeVersion":{"shape":"AgentRuntimeVersion"}, - "agentRuntimeName":{"shape":"AgentRuntimeName"}, - "description":{"shape":"Description"}, - "lastUpdatedAt":{"shape":"DateTimestamp"}, - "status":{"shape":"AgentRuntimeStatus"} - } - }, - "AgentRuntimeArn":{ - "type":"string", - "pattern":"arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:runtime/[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10}" - }, - "AgentRuntimeArtifact":{ - "type":"structure", - "members":{ - "containerConfiguration":{"shape":"ContainerConfiguration"}, - "codeConfiguration":{"shape":"CodeConfiguration"} - }, - "union":true - }, - "AgentRuntimeEndpoint":{ - "type":"structure", - "required":[ - "name", - "agentRuntimeEndpointArn", - "agentRuntimeArn", - "status", - "id", - "createdAt", - "lastUpdatedAt" - ], - "members":{ - "name":{"shape":"EndpointName"}, - "liveVersion":{"shape":"AgentRuntimeVersion"}, - "targetVersion":{"shape":"AgentRuntimeVersion"}, - "agentRuntimeEndpointArn":{"shape":"AgentRuntimeEndpointArn"}, - "agentRuntimeArn":{"shape":"AgentRuntimeArn"}, - "status":{"shape":"AgentRuntimeEndpointStatus"}, - "id":{"shape":"AgentRuntimeEndpointId"}, - "description":{"shape":"AgentEndpointDescription"}, - "createdAt":{"shape":"DateTimestamp"}, - "lastUpdatedAt":{"shape":"DateTimestamp"} - } - }, - "AgentRuntimeEndpointArn":{ - "type":"string", - "pattern":"arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:runtime/[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10}/runtime-endpoint/[a-zA-Z][a-zA-Z0-9_]{0,47}" - }, - "AgentRuntimeEndpointId":{ - "type":"string", - "pattern":"[a-zA-Z][a-zA-Z0-9_]{0,99}-[a-zA-Z0-9]{10}" - }, - "AgentRuntimeEndpointStatus":{ - "type":"string", - "enum":[ - "CREATING", - "CREATE_FAILED", - "UPDATING", - "UPDATE_FAILED", - "READY", - "DELETING" - ] - }, - "AgentRuntimeEndpoints":{ - "type":"list", - "member":{"shape":"AgentRuntimeEndpoint"} - }, - "AgentRuntimeId":{ - "type":"string", - "pattern":"[a-zA-Z][a-zA-Z0-9_]{0,99}-[a-zA-Z0-9]{10}" - }, - "AgentRuntimeName":{ - "type":"string", - "pattern":"[a-zA-Z][a-zA-Z0-9_]{0,47}" - }, - "AgentRuntimeStatus":{ - "type":"string", - "enum":[ - "CREATING", - "CREATE_FAILED", - "UPDATING", - "UPDATE_FAILED", - "READY", - "DELETING" - ] - }, - "AgentRuntimeVersion":{ - "type":"string", - "max":5, - "min":1, - "pattern":"([1-9][0-9]{0,4})" - }, - "AgentRuntimes":{ - "type":"list", - "member":{"shape":"AgentRuntime"} - }, - "AgentSkillsDescriptor":{ - "type":"structure", - "members":{ - "skillMd":{"shape":"SkillMdDefinition"}, - "skillDefinition":{"shape":"SkillDefinition"} - } - }, - "AllowedAudience":{"type":"string"}, - "AllowedAudienceList":{ - "type":"list", - "member":{"shape":"AllowedAudience"}, - "min":1 - }, - "AllowedClient":{"type":"string"}, - "AllowedClientsList":{ - "type":"list", - "member":{"shape":"AllowedClient"}, - "min":1 - }, - "AllowedQueryParameters":{ - "type":"list", - "member":{"shape":"HttpQueryParameterName"}, - "max":10, - "min":1 - }, - "AllowedRequestHeaders":{ - "type":"list", - "member":{"shape":"HttpHeaderName"}, - "max":10, - "min":1 - }, - "AllowedResponseHeaders":{ - "type":"list", - "member":{"shape":"HttpHeaderName"}, - "max":10, - "min":1 - }, - "AllowedScopeType":{ - "type":"string", - "max":255, - "min":1, - "pattern":"[\\x21\\x23-\\x5B\\x5D-\\x7E]+" - }, - "AllowedScopesType":{ - "type":"list", - "member":{"shape":"AllowedScopeType"}, - "min":1 - }, - "AllowedStringListValue":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[a-zA-Z0-9\\s._:/=+@-]*" - }, - "AllowedStringListValuesList":{ - "type":"list", - "member":{"shape":"AllowedStringListValue"}, - "max":10, - "min":1 - }, - "AllowedStringValue":{ - "type":"string", - "max":256, - "min":1, - "pattern":"[a-zA-Z0-9\\s._:/=+@-]*" - }, - "AllowedStringValuesList":{ - "type":"list", - "member":{"shape":"AllowedStringValue"}, - "max":10, - "min":1 - }, - "AllowedWorkloadConfiguration":{ - "type":"structure", - "members":{ - "hostingEnvironments":{"shape":"HostingEnvironmentListType"}, - "workloadIdentities":{"shape":"WorkloadIdentityNameListType"} - } - }, - "ApiGatewayTargetConfiguration":{ - "type":"structure", - "required":[ - "restApiId", - "stage", - "apiGatewayToolConfiguration" - ], - "members":{ - "restApiId":{"shape":"String"}, - "stage":{"shape":"String"}, - "apiGatewayToolConfiguration":{"shape":"ApiGatewayToolConfiguration"} - } - }, - "ApiGatewayToolConfiguration":{ - "type":"structure", - "required":["toolFilters"], - "members":{ - "toolOverrides":{"shape":"ApiGatewayToolOverrides"}, - "toolFilters":{"shape":"ApiGatewayToolFilters"} - } - }, - "ApiGatewayToolFilter":{ - "type":"structure", - "required":[ - "filterPath", - "methods" - ], - "members":{ - "filterPath":{"shape":"String"}, - "methods":{"shape":"RestApiMethods"} - } - }, - "ApiGatewayToolFilters":{ - "type":"list", - "member":{"shape":"ApiGatewayToolFilter"} - }, - "ApiGatewayToolOverride":{ - "type":"structure", - "required":[ - "name", - "path", - "method" - ], - "members":{ - "name":{"shape":"String"}, - "description":{"shape":"String"}, - "path":{"shape":"String"}, - "method":{"shape":"RestApiMethod"} - } - }, - "ApiGatewayToolOverrides":{ - "type":"list", - "member":{"shape":"ApiGatewayToolOverride"} - }, - "ApiKeyArn":{ - "type":"string", - "pattern":"arn:aws:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:token-vault/[a-zA-Z0-9-.]+/apikeycredentialprovider/[a-zA-Z0-9-.]+" - }, - "ApiKeyCredentialLocation":{ - "type":"string", - "enum":[ - "HEADER", - "QUERY_PARAMETER" - ] - }, - "ApiKeyCredentialParameterName":{ - "type":"string", - "max":64, - "min":1 - }, - "ApiKeyCredentialPrefix":{ - "type":"string", - "max":64, - "min":1 - }, - "ApiKeyCredentialProvider":{ - "type":"structure", - "required":["providerArn"], - "members":{ - "providerArn":{"shape":"ApiKeyCredentialProviderArn"}, - "credentialParameterName":{"shape":"ApiKeyCredentialParameterName"}, - "credentialPrefix":{"shape":"ApiKeyCredentialPrefix"}, - "credentialLocation":{"shape":"ApiKeyCredentialLocation"} - } - }, - "ApiKeyCredentialProviderArn":{ - "type":"string", - "pattern":"arn:([^:]*):([^:]*):([^:]*):([0-9]{12})?:(.+)" - }, - "ApiKeyCredentialProviderArnType":{ - "type":"string", - "pattern":"arn:(aws|aws-us-gov):acps:[A-Za-z0-9-]{1,64}:[0-9]{12}:token-vault/[a-zA-Z0-9-.]+/apikeycredentialprovider/[a-zA-Z0-9-.]+" - }, - "ApiKeyCredentialProviderItem":{ - "type":"structure", - "required":[ - "name", - "credentialProviderArn", - "createdTime", - "lastUpdatedTime" - ], - "members":{ - "name":{"shape":"CredentialProviderName"}, - "credentialProviderArn":{"shape":"ApiKeyCredentialProviderArnType"}, - "createdTime":{"shape":"Timestamp"}, - "lastUpdatedTime":{"shape":"Timestamp"} - } - }, - "ApiKeyCredentialProviders":{ - "type":"list", - "member":{"shape":"ApiKeyCredentialProviderItem"} - }, - "ApiSchemaConfiguration":{ - "type":"structure", - "members":{ - "s3":{"shape":"S3Configuration"}, - "inlinePayload":{"shape":"InlinePayload"} - }, - "union":true - }, - "ApprovalConfiguration":{ - "type":"structure", - "members":{ - "autoApproval":{"shape":"Boolean"} - } - }, - "Arn":{ - "type":"string", - "pattern":"arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}" - }, - "AtlassianOauth2ProviderConfigInput":{ - "type":"structure", - "required":["clientId"], - "members":{ - "clientId":{"shape":"ClientIdType"}, - "clientSecret":{"shape":"DefaultClientSecretType"}, - "clientSecretConfig":{"shape":"SecretReference"}, - "clientSecretSource":{"shape":"SecretSourceType"} - } - }, - "AtlassianOauth2ProviderConfigOutput":{ - "type":"structure", - "required":["oauthDiscovery"], - "members":{ - "oauthDiscovery":{"shape":"Oauth2Discovery"}, - "clientId":{"shape":"ClientIdType"} - } - }, - "AuthorizationData":{ - "type":"structure", - "members":{ - "oauth2":{"shape":"OAuth2AuthorizationData"} - }, - "union":true - }, - "AuthorizationEndpointType":{"type":"string"}, - "AuthorizerConfiguration":{ - "type":"structure", - "members":{ - "customJWTAuthorizer":{"shape":"CustomJWTAuthorizerConfiguration"} - }, - "union":true - }, - "AuthorizerType":{ - "type":"string", - "enum":[ - "CUSTOM_JWT", - "AWS_IAM", - "NONE", - "AUTHENTICATE_ONLY" - ] - }, - "AuthorizingClaimMatchValueType":{ - "type":"structure", - "required":[ - "claimMatchValue", - "claimMatchOperator" - ], - "members":{ - "claimMatchValue":{"shape":"ClaimMatchValueType"}, - "claimMatchOperator":{"shape":"ClaimMatchOperatorType"} - } - }, - "AwsAccountId":{ - "type":"string", - "pattern":"[0-9]{12}" - }, - "BedrockAgentcoreResourceArn":{ - "type":"string", - "max":1011, - "min":20 - }, - "BedrockEvaluatorModelConfig":{ - "type":"structure", - "required":["modelId"], - "members":{ - "modelId":{"shape":"ModelId"}, - "inferenceConfig":{"shape":"InferenceConfiguration"}, - "additionalModelRequestFields":{"shape":"AdditionalModelRequestFields"} - } - }, - "Boolean":{ - "type":"boolean", - "box":true - }, - "BranchName":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[a-zA-Z][a-zA-Z0-9_/-]{0,127}" - }, - "BrowserArn":{ - "type":"string", - "pattern":"arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:(aws|[0-9]{12}):browser(-custom)?/(aws\\.browser\\.v1|[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10})" - }, - "BrowserEnterprisePolicies":{ - "type":"list", - "member":{"shape":"BrowserEnterprisePolicy"}, - "max":100, - "min":0 - }, - "BrowserEnterprisePolicy":{ - "type":"structure", - "required":["location"], - "members":{ - "location":{"shape":"ResourceLocation"}, - "type":{"shape":"BrowserEnterprisePolicyType"} - } - }, - "BrowserEnterprisePolicyType":{ - "type":"string", - "enum":[ - "MANAGED", - "RECOMMENDED" - ] - }, - "BrowserId":{ - "type":"string", - "pattern":"(aws\\.browser\\.v1|[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10})" - }, - "BrowserNetworkConfiguration":{ - "type":"structure", - "required":["networkMode"], - "members":{ - "networkMode":{"shape":"BrowserNetworkMode"}, - "vpcConfig":{"shape":"VpcConfig"} - } - }, - "BrowserNetworkMode":{ - "type":"string", - "enum":[ - "PUBLIC", - "VPC" - ] - }, - "BrowserProfileArn":{ - "type":"string", - "pattern":"arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:browser-profile/[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10}" - }, - "BrowserProfileId":{ - "type":"string", - "pattern":"[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10}" - }, - "BrowserProfileName":{ - "type":"string", - "pattern":"[a-zA-Z][a-zA-Z0-9_]{0,47}" - }, - "BrowserProfileStatus":{ - "type":"string", - "enum":[ - "READY", - "DELETING", - "DELETED", - "SAVING" - ] - }, - "BrowserProfileSummaries":{ - "type":"list", - "member":{"shape":"BrowserProfileSummary"} - }, - "BrowserProfileSummary":{ - "type":"structure", - "required":[ - "profileId", - "profileArn", - "name", - "status", - "createdAt", - "lastUpdatedAt" - ], - "members":{ - "profileId":{"shape":"BrowserProfileId"}, - "profileArn":{"shape":"BrowserProfileArn"}, - "name":{"shape":"BrowserProfileName"}, - "description":{"shape":"Description"}, - "status":{"shape":"BrowserProfileStatus"}, - "createdAt":{"shape":"DateTimestamp"}, - "lastUpdatedAt":{"shape":"DateTimestamp"}, - "lastSavedAt":{"shape":"DateTimestamp"}, - "lastSavedBrowserSessionId":{"shape":"BrowserSessionId"}, - "lastSavedBrowserId":{"shape":"BrowserId"} - } - }, - "BrowserSessionId":{ - "type":"string", - "pattern":"[0-9a-zA-Z]{1,40}" - }, - "BrowserSigningConfigInput":{ - "type":"structure", - "required":["enabled"], - "members":{ - "enabled":{"shape":"Boolean"} - } - }, - "BrowserSigningConfigOutput":{ - "type":"structure", - "required":["enabled"], - "members":{ - "enabled":{"shape":"Boolean"} - } - }, - "BrowserStatus":{ - "type":"string", - "enum":[ - "CREATING", - "CREATE_FAILED", - "READY", - "DELETING", - "DELETE_FAILED", - "DELETED" - ] - }, - "BrowserSummaries":{ - "type":"list", - "member":{"shape":"BrowserSummary"} - }, - "BrowserSummary":{ - "type":"structure", - "required":[ - "browserId", - "browserArn", - "status", - "createdAt" - ], - "members":{ - "browserId":{"shape":"BrowserId"}, - "browserArn":{"shape":"BrowserArn"}, - "name":{"shape":"SandboxName"}, - "description":{"shape":"Description"}, - "status":{"shape":"BrowserStatus"}, - "createdAt":{"shape":"DateTimestamp"}, - "lastUpdatedAt":{"shape":"DateTimestamp"} - } - }, - "CategoricalScaleDefinition":{ - "type":"structure", - "required":[ - "definition", - "label" - ], - "members":{ - "definition":{"shape":"String"}, - "label":{"shape":"CategoricalScaleDefinitionLabelString"} - } - }, - "CategoricalScaleDefinitionLabelString":{ - "type":"string", - "max":100, - "min":1 - }, - "CategoricalScaleDefinitions":{ - "type":"list", - "member":{"shape":"CategoricalScaleDefinition"} - }, - "CedarPolicy":{ - "type":"structure", - "required":["statement"], - "members":{ - "statement":{"shape":"Statement"} - } - }, - "Certificate":{ - "type":"structure", - "required":["location"], - "members":{ - "location":{"shape":"CertificateLocation"} - } - }, - "CertificateLocation":{ - "type":"structure", - "members":{ - "secretsManager":{"shape":"SecretsManagerLocation"} - }, - "union":true - }, - "Certificates":{ - "type":"list", - "member":{"shape":"Certificate"}, - "max":200, - "min":1 - }, - "ClaimMatchOperatorType":{ - "type":"string", - "enum":[ - "EQUALS", - "CONTAINS", - "CONTAINS_ANY" - ] - }, - "ClaimMatchValueType":{ - "type":"structure", - "members":{ - "matchValueString":{"shape":"MatchValueString"}, - "matchValueStringList":{"shape":"MatchValueStringList"} - }, - "union":true - }, - "ClientAuthenticationMethodType":{ - "type":"string", - "enum":[ - "CLIENT_SECRET_BASIC", - "CLIENT_SECRET_POST", - "AWS_IAM_ID_TOKEN_JWT", - "PRIVATE_KEY_JWT" - ] - }, - "ClientIdType":{ - "type":"string", - "max":256, - "min":1 - }, - "ClientToken":{ - "type":"string", - "max":256, - "min":33, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}" - }, - "CloudWatchLogsInputConfig":{ - "type":"structure", - "required":[ - "logGroupNames", - "serviceNames" - ], - "members":{ - "logGroupNames":{"shape":"CloudWatchLogsInputConfigLogGroupNamesList"}, - "serviceNames":{"shape":"CloudWatchLogsInputConfigServiceNamesList"} - } - }, - "CloudWatchLogsInputConfigLogGroupNamesList":{ - "type":"list", - "member":{"shape":"LogGroupName"}, - "max":5, - "min":1 - }, - "CloudWatchLogsInputConfigServiceNamesList":{ - "type":"list", - "member":{"shape":"ServiceName"}, - "max":1, - "min":1 - }, - "CloudWatchOutputConfig":{ - "type":"structure", - "required":["logGroupName"], - "members":{ - "logGroupName":{"shape":"LogGroupName"} - } - }, - "ClusteringConfig":{ - "type":"structure", - "required":["frequencies"], - "members":{ - "frequencies":{"shape":"ClusteringFrequencyList"} - } - }, - "ClusteringFrequency":{ - "type":"string", - "enum":[ - "DAILY", - "WEEKLY", - "MONTHLY" - ] - }, - "ClusteringFrequencyList":{ - "type":"list", - "member":{"shape":"ClusteringFrequency"}, - "max":3, - "min":0 - }, - "Code":{ - "type":"structure", - "members":{ - "s3":{"shape":"S3Location"} - }, - "union":true - }, - "CodeBasedEvaluatorConfig":{ - "type":"structure", - "members":{ - "lambdaConfig":{"shape":"LambdaEvaluatorConfig"} - }, - "union":true - }, - "CodeConfiguration":{ - "type":"structure", - "required":[ - "code", - "runtime", - "entryPoint" - ], - "members":{ - "code":{"shape":"Code"}, - "runtime":{"shape":"AgentManagedRuntimeType"}, - "entryPoint":{"shape":"CodeConfigurationEntryPointList"} - } - }, - "CodeConfigurationEntryPointList":{ - "type":"list", - "member":{"shape":"entryPoint"}, - "max":2, - "min":1 - }, - "CodeInterpreterArn":{ - "type":"string", - "pattern":"arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:(aws|[0-9]{12}):code-interpreter(-custom)?/(aws\\.codeinterpreter\\.v1|[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10})" - }, - "CodeInterpreterId":{ - "type":"string", - "pattern":"(aws\\.codeinterpreter\\.v1|[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10})" - }, - "CodeInterpreterNetworkConfiguration":{ - "type":"structure", - "required":["networkMode"], - "members":{ - "networkMode":{"shape":"CodeInterpreterNetworkMode"}, - "vpcConfig":{"shape":"VpcConfig"} - } - }, - "CodeInterpreterNetworkMode":{ - "type":"string", - "enum":[ - "PUBLIC", - "SANDBOX", - "VPC" - ] - }, - "CodeInterpreterStatus":{ - "type":"string", - "enum":[ - "CREATING", - "CREATE_FAILED", - "READY", - "DELETING", - "DELETE_FAILED", - "DELETED" - ] - }, - "CodeInterpreterSummaries":{ - "type":"list", - "member":{"shape":"CodeInterpreterSummary"} - }, - "CodeInterpreterSummary":{ - "type":"structure", - "required":[ - "codeInterpreterId", - "codeInterpreterArn", - "status", - "createdAt" - ], - "members":{ - "codeInterpreterId":{"shape":"CodeInterpreterId"}, - "codeInterpreterArn":{"shape":"CodeInterpreterArn"}, - "name":{"shape":"SandboxName"}, - "description":{"shape":"Description"}, - "status":{"shape":"CodeInterpreterStatus"}, - "createdAt":{"shape":"DateTimestamp"}, - "lastUpdatedAt":{"shape":"DateTimestamp"} - } - }, - "CoinbaseCdpApiKeyIdType":{ - "type":"string", - "max":512, - "min":1, - "pattern":"[a-zA-Z0-9\\-_]+" - }, - "CoinbaseCdpConfigurationInput":{ - "type":"structure", - "required":["apiKeyId"], - "members":{ - "apiKeyId":{"shape":"CoinbaseCdpApiKeyIdType"}, - "apiKeySecret":{"shape":"DefaultCoinbaseCdpApiKeySecretType"}, - "apiKeySecretSource":{"shape":"SecretSourceType"}, - "apiKeySecretConfig":{"shape":"SecretReference"}, - "walletSecret":{"shape":"DefaultCoinbaseCdpWalletSecretType"}, - "walletSecretSource":{"shape":"SecretSourceType"}, - "walletSecretConfig":{"shape":"SecretReference"} - } - }, - "CoinbaseCdpConfigurationOutput":{ - "type":"structure", - "required":[ - "apiKeyId", - "apiKeySecretArn", - "walletSecretArn" - ], - "members":{ - "apiKeyId":{"shape":"CoinbaseCdpApiKeyIdType"}, - "apiKeySecretArn":{"shape":"Secret"}, - "apiKeySecretJsonKey":{"shape":"SecretJsonKeyType"}, - "apiKeySecretSource":{"shape":"SecretSourceType"}, - "walletSecretArn":{"shape":"Secret"}, - "walletSecretJsonKey":{"shape":"SecretJsonKeyType"}, - "walletSecretSource":{"shape":"SecretSourceType"} - } - }, - "ComponentConfiguration":{ - "type":"structure", - "required":["configuration"], - "members":{ - "configuration":{"shape":"Document"} - }, - "sensitive":true - }, - "ComponentConfigurationMap":{ - "type":"map", - "key":{"shape":"ComponentIdentifier"}, - "value":{"shape":"ComponentConfiguration"} - }, - "ComponentIdentifier":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"[a-zA-Z][a-zA-Z0-9_:/.\\-]{0,2047}" - }, - "ConcurrentModificationException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"} - }, - "error":{ - "httpStatusCode":409, - "senderFault":true - }, - "exception":true - }, - "Condition":{ - "type":"structure", - "members":{ - "matchPrincipals":{"shape":"MatchPrincipals"}, - "matchPaths":{"shape":"MatchPaths"} - }, - "union":true - }, - "Conditions":{ - "type":"list", - "member":{"shape":"Condition"}, - "max":2, - "min":0 - }, - "ConfigurationBundleAction":{ - "type":"structure", - "members":{ - "staticOverride":{"shape":"StaticOverride"}, - "weightedOverride":{"shape":"WeightedOverride"} - }, - "union":true - }, - "ConfigurationBundleArn":{ - "type":"string", - "pattern":"arn:aws[a-zA-Z-]*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:configuration-bundle/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}" - }, - "ConfigurationBundleDescription":{ - "type":"string", - "max":500, - "min":1, - "pattern":".+", - "sensitive":true - }, - "ConfigurationBundleId":{ - "type":"string", - "pattern":"[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}" - }, - "ConfigurationBundleName":{ - "type":"string", - "pattern":"[a-zA-Z][a-zA-Z0-9_]{0,99}" - }, - "ConfigurationBundleReference":{ - "type":"structure", - "required":[ - "bundleArn", - "bundleVersion" - ], - "members":{ - "bundleArn":{"shape":"GatewayConfigurationBundleArn"}, - "bundleVersion":{"shape":"ConfigurationBundleReferenceBundleVersionString"} - } - }, - "ConfigurationBundleReferenceBundleVersionString":{ - "type":"string", - "pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" - }, - "ConfigurationBundleStatus":{ - "type":"string", - "enum":[ - "ACTIVE", - "CREATING", - "CREATE_FAILED", - "UPDATING", - "UPDATE_FAILED", - "DELETING", - "DELETE_FAILED" - ] - }, - "ConfigurationBundleSummary":{ - "type":"structure", - "required":[ - "bundleArn", - "bundleId", - "bundleName" - ], - "members":{ - "bundleArn":{"shape":"ConfigurationBundleArn"}, - "bundleId":{"shape":"ConfigurationBundleId"}, - "bundleName":{"shape":"ConfigurationBundleName"}, - "description":{"shape":"ConfigurationBundleDescription"}, - "createdAt":{"shape":"Timestamp"} - } - }, - "ConfigurationBundleSummaryList":{ - "type":"list", - "member":{"shape":"ConfigurationBundleSummary"} - }, - "ConfigurationBundleVersion":{ - "type":"string", - "pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" - }, - "ConfigurationBundleVersionList":{ - "type":"list", - "member":{"shape":"ConfigurationBundleVersion"} - }, - "ConfigurationBundleVersionSummary":{ - "type":"structure", - "required":[ - "bundleArn", - "bundleId", - "versionId", - "versionCreatedAt" - ], - "members":{ - "bundleArn":{"shape":"ConfigurationBundleArn"}, - "bundleId":{"shape":"ConfigurationBundleId"}, - "versionId":{"shape":"ConfigurationBundleVersion"}, - "lineageMetadata":{"shape":"VersionLineageMetadata"}, - "versionCreatedAt":{"shape":"Timestamp"} - } - }, - "ConfigurationBundleVersionSummaryList":{ - "type":"list", - "member":{"shape":"ConfigurationBundleVersionSummary"} - }, - "ConflictException":{ - "type":"structure", - "members":{ - "message":{"shape":"NonBlankString"} - }, - "error":{ - "httpStatusCode":409, - "senderFault":true - }, - "exception":true - }, - "ConnectorConfiguration":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{"shape":"ConnectorConfigurationNameString"}, - "description":{"shape":"ConnectorConfigurationDescriptionString"}, - "parameterValues":{"shape":"Document"}, - "parameterOverrides":{"shape":"ConnectorParameterOverrides"} - } - }, - "ConnectorConfigurationDescriptionString":{ - "type":"string", - "max":2000, - "min":0 - }, - "ConnectorConfigurationNameString":{ - "type":"string", - "max":64, - "min":0, - "pattern":"[a-zA-Z][a-zA-Z0-9_-]*" - }, - "ConnectorConfigurations":{ - "type":"list", - "member":{"shape":"ConnectorConfiguration"} - }, - "ConnectorId":{ - "type":"string", - "max":256, - "min":1 - }, - "ConnectorParameterOverride":{ - "type":"structure", - "required":["path"], - "members":{ - "path":{"shape":"String"}, - "description":{"shape":"String"}, - "visible":{"shape":"Boolean"} - } - }, - "ConnectorParameterOverrides":{ - "type":"list", - "member":{"shape":"ConnectorParameterOverride"} - }, - "ConnectorSource":{ - "type":"structure", - "required":["connectorId"], - "members":{ - "connectorId":{"shape":"ConnectorId"}, - "version":{"shape":"ConnectorVersion"} - } - }, - "ConnectorTargetConfiguration":{ - "type":"structure", - "required":["source"], - "members":{ - "source":{"shape":"ConnectorSource"}, - "enabled":{"shape":"EnabledConnectors"}, - "configurations":{"shape":"ConnectorConfigurations"} - } - }, - "ConnectorVersion":{ - "type":"string", - "max":32, - "min":5, - "pattern":"(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)" - }, - "ConsolidationConfiguration":{ - "type":"structure", - "members":{ - "customConsolidationConfiguration":{"shape":"CustomConsolidationConfiguration"} - }, - "union":true - }, - "ContainerConfiguration":{ - "type":"structure", - "required":["containerUri"], - "members":{ - "containerUri":{"shape":"RuntimeContainerUri"} - } - }, - "Content":{ - "type":"structure", - "members":{ - "rawText":{"shape":"NaturalLanguage"} - }, - "union":true - }, - "ContentConfiguration":{ - "type":"structure", - "required":["type"], - "members":{ - "type":{"shape":"ContentType"}, - "level":{"shape":"ContentLevel"} - } - }, - "ContentLevel":{ - "type":"string", - "enum":[ - "METADATA_ONLY", - "FULL_CONTENT" - ] - }, - "ContentType":{ - "type":"string", - "enum":["MEMORY_RECORDS"] - }, - "CreateAgentRuntimeEndpointRequest":{ - "type":"structure", - "required":[ - "agentRuntimeId", - "name" - ], - "members":{ - "agentRuntimeId":{ - "shape":"AgentRuntimeId", - "location":"uri", - "locationName":"agentRuntimeId" - }, - "name":{"shape":"EndpointName"}, - "agentRuntimeVersion":{"shape":"AgentRuntimeVersion"}, - "description":{"shape":"AgentEndpointDescription"}, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - }, - "tags":{"shape":"TagsMap"} - } - }, - "CreateAgentRuntimeEndpointResponse":{ - "type":"structure", - "required":[ - "targetVersion", - "agentRuntimeEndpointArn", - "agentRuntimeArn", - "status", - "createdAt" - ], - "members":{ - "targetVersion":{"shape":"AgentRuntimeVersion"}, - "agentRuntimeEndpointArn":{"shape":"AgentRuntimeEndpointArn"}, - "agentRuntimeArn":{"shape":"AgentRuntimeArn"}, - "agentRuntimeId":{"shape":"AgentRuntimeId"}, - "endpointName":{"shape":"EndpointName"}, - "status":{"shape":"AgentRuntimeEndpointStatus"}, - "createdAt":{"shape":"DateTimestamp"} - } - }, - "CreateAgentRuntimeRequest":{ - "type":"structure", - "required":[ - "agentRuntimeName", - "agentRuntimeArtifact", - "roleArn", - "networkConfiguration" - ], - "members":{ - "agentRuntimeName":{"shape":"AgentRuntimeName"}, - "agentRuntimeArtifact":{"shape":"AgentRuntimeArtifact"}, - "roleArn":{"shape":"RoleArn"}, - "networkConfiguration":{"shape":"NetworkConfiguration"}, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - }, - "description":{"shape":"Description"}, - "authorizerConfiguration":{"shape":"AuthorizerConfiguration"}, - "requestHeaderConfiguration":{"shape":"RequestHeaderConfiguration"}, - "protocolConfiguration":{"shape":"ProtocolConfiguration"}, - "lifecycleConfiguration":{"shape":"LifecycleConfiguration"}, - "environmentVariables":{"shape":"EnvironmentVariablesMap"}, - "filesystemConfigurations":{"shape":"FilesystemConfigurations"}, - "tags":{"shape":"TagsMap"} - } - }, - "CreateAgentRuntimeResponse":{ - "type":"structure", - "required":[ - "agentRuntimeArn", - "agentRuntimeId", - "agentRuntimeVersion", - "createdAt", - "status" - ], - "members":{ - "agentRuntimeArn":{"shape":"AgentRuntimeArn"}, - "workloadIdentityDetails":{"shape":"WorkloadIdentityDetails"}, - "agentRuntimeId":{"shape":"AgentRuntimeId"}, - "agentRuntimeVersion":{"shape":"AgentRuntimeVersion"}, - "createdAt":{"shape":"DateTimestamp"}, - "status":{"shape":"AgentRuntimeStatus"} - } - }, - "CreateApiKeyCredentialProviderRequest":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{"shape":"CredentialProviderName"}, - "apiKey":{"shape":"DefaultApiKeyType"}, - "apiKeySecretConfig":{"shape":"SecretReference"}, - "apiKeySecretSource":{"shape":"SecretSourceType"}, - "tags":{"shape":"TagsMap"} - } - }, - "CreateApiKeyCredentialProviderResponse":{ - "type":"structure", - "required":[ - "apiKeySecretArn", - "name", - "credentialProviderArn" - ], - "members":{ - "apiKeySecretArn":{"shape":"Secret"}, - "apiKeySecretJsonKey":{"shape":"SecretJsonKeyType"}, - "apiKeySecretSource":{"shape":"SecretSourceType"}, - "name":{"shape":"CredentialProviderName"}, - "credentialProviderArn":{"shape":"ApiKeyCredentialProviderArnType"} - } - }, - "CreateBrowserProfileRequest":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{"shape":"BrowserProfileName"}, - "description":{"shape":"Description"}, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - }, - "tags":{"shape":"TagsMap"} - } - }, - "CreateBrowserProfileResponse":{ - "type":"structure", - "required":[ - "profileId", - "profileArn", - "createdAt", - "status" - ], - "members":{ - "profileId":{"shape":"BrowserProfileId"}, - "profileArn":{"shape":"BrowserProfileArn"}, - "createdAt":{"shape":"DateTimestamp"}, - "status":{"shape":"BrowserProfileStatus"} - } - }, - "CreateBrowserRequest":{ - "type":"structure", - "required":[ - "name", - "networkConfiguration" - ], - "members":{ - "name":{"shape":"SandboxName"}, - "description":{"shape":"Description"}, - "executionRoleArn":{"shape":"RoleArn"}, - "networkConfiguration":{"shape":"BrowserNetworkConfiguration"}, - "recording":{"shape":"RecordingConfig"}, - "browserSigning":{"shape":"BrowserSigningConfigInput"}, - "enterprisePolicies":{"shape":"BrowserEnterprisePolicies"}, - "certificates":{"shape":"Certificates"}, - "filesystemConfigurations":{"shape":"ToolsFileSystemConfigurations"}, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - }, - "tags":{"shape":"TagsMap"} - } - }, - "CreateBrowserResponse":{ - "type":"structure", - "required":[ - "browserId", - "browserArn", - "createdAt", - "status" - ], - "members":{ - "browserId":{"shape":"BrowserId"}, - "browserArn":{"shape":"BrowserArn"}, - "createdAt":{"shape":"DateTimestamp"}, - "status":{"shape":"BrowserStatus"} - } - }, - "CreateCodeInterpreterRequest":{ - "type":"structure", - "required":[ - "name", - "networkConfiguration" - ], - "members":{ - "name":{"shape":"SandboxName"}, - "description":{"shape":"Description"}, - "executionRoleArn":{"shape":"RoleArn"}, - "networkConfiguration":{"shape":"CodeInterpreterNetworkConfiguration"}, - "certificates":{"shape":"Certificates"}, - "filesystemConfigurations":{"shape":"ToolsFileSystemConfigurations"}, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - }, - "tags":{"shape":"TagsMap"} - } - }, - "CreateCodeInterpreterResponse":{ - "type":"structure", - "required":[ - "codeInterpreterId", - "codeInterpreterArn", - "createdAt", - "status" - ], - "members":{ - "codeInterpreterId":{"shape":"CodeInterpreterId"}, - "codeInterpreterArn":{"shape":"CodeInterpreterArn"}, - "createdAt":{"shape":"DateTimestamp"}, - "status":{"shape":"CodeInterpreterStatus"} - } - }, - "CreateConfigurationBundleRequest":{ - "type":"structure", - "required":[ - "bundleName", - "components" - ], - "members":{ - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - }, - "bundleName":{"shape":"ConfigurationBundleName"}, - "description":{"shape":"ConfigurationBundleDescription"}, - "components":{"shape":"ComponentConfigurationMap"}, - "branchName":{"shape":"BranchName"}, - "commitMessage":{"shape":"CreateConfigurationBundleRequestCommitMessageString"}, - "createdBy":{"shape":"VersionCreatedBySource"}, - "kmsKeyArn":{"shape":"KmsKeyArn"}, - "tags":{"shape":"TagsMap"} - } - }, - "CreateConfigurationBundleRequestCommitMessageString":{ - "type":"string", - "max":500, - "min":1 - }, - "CreateConfigurationBundleResponse":{ - "type":"structure", - "required":[ - "bundleArn", - "bundleId", - "versionId", - "createdAt" - ], - "members":{ - "bundleArn":{"shape":"ConfigurationBundleArn"}, - "bundleId":{"shape":"ConfigurationBundleId"}, - "versionId":{"shape":"ConfigurationBundleVersion"}, - "createdAt":{"shape":"Timestamp"} - } - }, - "CreateDatasetRequest":{ - "type":"structure", - "required":[ - "datasetName", - "source", - "schemaType" - ], - "members":{ - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - }, - "datasetName":{"shape":"DatasetName"}, - "description":{"shape":"CreateDatasetRequestDescriptionString"}, - "source":{"shape":"DataSourceType"}, - "schemaType":{"shape":"DatasetSchemaType"}, - "kmsKeyArn":{"shape":"KmsKeyArn"}, - "tags":{"shape":"TagsMap"} - } - }, - "CreateDatasetRequestDescriptionString":{ - "type":"string", - "max":200, - "min":0 - }, - "CreateDatasetResponse":{ - "type":"structure", - "required":[ - "datasetArn", - "datasetId", - "status", - "createdAt" - ], - "members":{ - "datasetArn":{"shape":"DatasetArn"}, - "datasetId":{"shape":"DatasetId"}, - "status":{"shape":"DatasetStatus"}, - "createdAt":{"shape":"Timestamp"} - } - }, - "CreateDatasetVersionRequest":{ - "type":"structure", - "required":["datasetId"], - "members":{ - "datasetId":{ - "shape":"DatasetId", - "location":"uri", - "locationName":"datasetId" - }, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - } - } - }, - "CreateDatasetVersionResponse":{ - "type":"structure", - "required":[ - "datasetArn", - "datasetId", - "status", - "datasetVersion", - "createdAt" - ], - "members":{ - "datasetArn":{"shape":"DatasetArn"}, - "datasetId":{"shape":"DatasetId"}, - "status":{"shape":"DatasetStatus"}, - "datasetVersion":{"shape":"DatasetVersion"}, - "createdAt":{"shape":"Timestamp"} - } - }, - "CreateEvaluatorRequest":{ - "type":"structure", - "required":[ - "evaluatorName", - "evaluatorConfig", - "level" - ], - "members":{ - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - }, - "evaluatorName":{"shape":"CustomEvaluatorName"}, - "description":{"shape":"EvaluatorDescription"}, - "evaluatorConfig":{"shape":"EvaluatorConfig"}, - "level":{"shape":"EvaluatorLevel"}, - "kmsKeyArn":{"shape":"KmsKeyArn"}, - "tags":{"shape":"TagsMap"} - } - }, - "CreateEvaluatorResponse":{ - "type":"structure", - "required":[ - "evaluatorArn", - "evaluatorId", - "createdAt", - "status" - ], - "members":{ - "evaluatorArn":{"shape":"CustomEvaluatorArn"}, - "evaluatorId":{"shape":"EvaluatorId"}, - "createdAt":{"shape":"Timestamp"}, - "status":{"shape":"EvaluatorStatus"} - } - }, - "CreateGatewayRequest":{ - "type":"structure", - "required":[ - "name", - "roleArn", - "authorizerType" - ], - "members":{ - "name":{"shape":"GatewayName"}, - "description":{"shape":"GatewayDescription"}, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - }, - "roleArn":{"shape":"RoleArn"}, - "protocolType":{"shape":"GatewayProtocolType"}, - "protocolConfiguration":{"shape":"GatewayProtocolConfiguration"}, - "authorizerType":{"shape":"AuthorizerType"}, - "authorizerConfiguration":{"shape":"AuthorizerConfiguration"}, - "kmsKeyArn":{"shape":"KmsKeyArn"}, - "interceptorConfigurations":{"shape":"GatewayInterceptorConfigurations"}, - "policyEngineConfiguration":{"shape":"GatewayPolicyEngineConfiguration"}, - "exceptionLevel":{"shape":"ExceptionLevel"}, - "tags":{"shape":"TagsMap"} - } - }, - "CreateGatewayResponse":{ - "type":"structure", - "required":[ - "gatewayArn", - "gatewayId", - "createdAt", - "updatedAt", - "status", - "name", - "authorizerType" - ], - "members":{ - "gatewayArn":{"shape":"GatewayArn"}, - "gatewayId":{"shape":"GatewayId"}, - "gatewayUrl":{"shape":"GatewayUrl"}, - "createdAt":{"shape":"DateTimestamp"}, - "updatedAt":{"shape":"DateTimestamp"}, - "status":{"shape":"GatewayStatus"}, - "statusReasons":{"shape":"StatusReasons"}, - "name":{"shape":"GatewayName"}, - "description":{"shape":"GatewayDescription"}, - "roleArn":{"shape":"RoleArn"}, - "protocolType":{"shape":"GatewayProtocolType"}, - "protocolConfiguration":{"shape":"GatewayProtocolConfiguration"}, - "authorizerType":{"shape":"AuthorizerType"}, - "authorizerConfiguration":{"shape":"AuthorizerConfiguration"}, - "kmsKeyArn":{"shape":"KmsKeyArn"}, - "customTransformConfiguration":{"shape":"CustomTransformConfiguration"}, - "interceptorConfigurations":{"shape":"GatewayInterceptorConfigurations"}, - "policyEngineConfiguration":{"shape":"GatewayPolicyEngineConfiguration"}, - "workloadIdentityDetails":{"shape":"WorkloadIdentityDetails"}, - "exceptionLevel":{"shape":"ExceptionLevel"}, - "webAclArn":{"shape":"WebAclArn"}, - "wafConfiguration":{"shape":"WafConfiguration"} - } - }, - "CreateGatewayRuleRequest":{ - "type":"structure", - "required":[ - "gatewayIdentifier", - "priority", - "actions" - ], - "members":{ - "gatewayIdentifier":{ - "shape":"GatewayIdentifier", - "location":"uri", - "locationName":"gatewayIdentifier" - }, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - }, - "priority":{"shape":"GatewayRulePriority"}, - "conditions":{"shape":"Conditions"}, - "actions":{"shape":"Actions"}, - "description":{"shape":"GatewayRuleDescription"} - } - }, - "CreateGatewayRuleResponse":{ - "type":"structure", - "required":[ - "ruleId", - "gatewayArn", - "priority", - "actions", - "createdAt", - "status" - ], - "members":{ - "ruleId":{"shape":"GatewayRuleId"}, - "gatewayArn":{"shape":"GatewayArn"}, - "priority":{"shape":"GatewayRulePriority"}, - "conditions":{"shape":"Conditions"}, - "actions":{"shape":"Actions"}, - "description":{"shape":"GatewayRuleDescription"}, - "createdAt":{"shape":"DateTimestamp"}, - "status":{"shape":"GatewayRuleStatus"}, - "system":{"shape":"SystemManagedBlock"} - } - }, - "CreateGatewayTargetRequest":{ - "type":"structure", - "required":[ - "gatewayIdentifier", - "targetConfiguration" - ], - "members":{ - "gatewayIdentifier":{ - "shape":"GatewayIdentifier", - "location":"uri", - "locationName":"gatewayIdentifier" - }, - "name":{"shape":"TargetName"}, - "description":{"shape":"TargetDescription"}, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - }, - "targetConfiguration":{"shape":"TargetConfiguration"}, - "credentialProviderConfigurations":{"shape":"CredentialProviderConfigurations"}, - "metadataConfiguration":{"shape":"MetadataConfiguration"}, - "privateEndpoint":{"shape":"PrivateEndpoint"} - } - }, - "CreateGatewayTargetResponse":{ - "type":"structure", - "required":[ - "gatewayArn", - "targetId", - "createdAt", - "updatedAt", - "status", - "name", - "targetConfiguration", - "credentialProviderConfigurations" - ], - "members":{ - "gatewayArn":{"shape":"GatewayArn"}, - "targetId":{"shape":"TargetId"}, - "createdAt":{"shape":"DateTimestamp"}, - "updatedAt":{"shape":"DateTimestamp"}, - "status":{"shape":"TargetStatus"}, - "statusReasons":{"shape":"StatusReasons"}, - "name":{"shape":"TargetName"}, - "description":{"shape":"TargetDescription"}, - "targetConfiguration":{"shape":"TargetConfiguration"}, - "credentialProviderConfigurations":{"shape":"CredentialProviderConfigurations"}, - "lastSynchronizedAt":{"shape":"DateTimestamp"}, - "metadataConfiguration":{"shape":"MetadataConfiguration"}, - "privateEndpoint":{"shape":"PrivateEndpoint"}, - "privateEndpointManagedResources":{"shape":"PrivateEndpointManagedResources"}, - "authorizationData":{"shape":"AuthorizationData"}, - "protocolType":{"shape":"TargetProtocolType"} - } - }, - "CreateHarnessEndpointRequest":{ - "type":"structure", - "required":[ - "harnessId", - "endpointName" - ], - "members":{ - "harnessId":{ - "shape":"HarnessId", - "location":"uri", - "locationName":"harnessId" - }, - "endpointName":{"shape":"HarnessEndpointName"}, - "targetVersion":{"shape":"HarnessVersion"}, - "description":{"shape":"HarnessEndpointDescription"}, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - }, - "tags":{"shape":"TagsMap"} - } - }, - "CreateHarnessEndpointResponse":{ - "type":"structure", - "required":["endpoint"], - "members":{ - "endpoint":{"shape":"HarnessEndpoint"} - } - }, - "CreateHarnessRequest":{ - "type":"structure", - "required":[ - "harnessName", - "executionRoleArn" - ], - "members":{ - "harnessName":{"shape":"HarnessName"}, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - }, - "executionRoleArn":{"shape":"RoleArn"}, - "environment":{"shape":"HarnessEnvironmentProviderRequest"}, - "environmentArtifact":{"shape":"HarnessEnvironmentArtifact"}, - "environmentVariables":{"shape":"EnvironmentVariablesMap"}, - "authorizerConfiguration":{"shape":"AuthorizerConfiguration"}, - "model":{"shape":"HarnessModelConfiguration"}, - "systemPrompt":{"shape":"HarnessSystemPrompt"}, - "tools":{"shape":"HarnessTools"}, - "skills":{"shape":"HarnessSkills"}, - "allowedTools":{"shape":"HarnessAllowedTools"}, - "memory":{"shape":"HarnessMemoryConfiguration"}, - "truncation":{"shape":"HarnessTruncationConfiguration"}, - "maxIterations":{"shape":"Integer"}, - "maxTokens":{"shape":"Integer"}, - "timeoutSeconds":{"shape":"Integer"}, - "tags":{"shape":"TagsMap"} - } - }, - "CreateHarnessResponse":{ - "type":"structure", - "required":["harness"], - "members":{ - "harness":{"shape":"Harness"} - } - }, - "CreateMemoryInput":{ - "type":"structure", - "required":[ - "name", - "eventExpiryDuration" - ], - "members":{ - "clientToken":{ - "shape":"CreateMemoryInputClientTokenString", - "idempotencyToken":true - }, - "name":{"shape":"Name"}, - "description":{"shape":"Description"}, - "encryptionKeyArn":{"shape":"Arn"}, - "memoryExecutionRoleArn":{"shape":"Arn"}, - "eventExpiryDuration":{"shape":"CreateMemoryInputEventExpiryDurationInteger"}, - "memoryStrategies":{"shape":"MemoryStrategyInputList"}, - "indexedKeys":{"shape":"IndexedKeysList"}, - "streamDeliveryResources":{"shape":"StreamDeliveryResources"}, - "tags":{"shape":"TagsMap"} - } - }, - "CreateMemoryInputClientTokenString":{ - "type":"string", - "max":500, - "min":0 - }, - "CreateMemoryInputEventExpiryDurationInteger":{ - "type":"integer", - "box":true, - "max":365, - "min":3 - }, - "CreateMemoryOutput":{ - "type":"structure", - "members":{ - "memory":{"shape":"Memory"} - } - }, - "CreateOauth2CredentialProviderRequest":{ - "type":"structure", - "required":[ - "name", - "credentialProviderVendor", - "oauth2ProviderConfigInput" - ], - "members":{ - "name":{"shape":"CredentialProviderName"}, - "credentialProviderVendor":{"shape":"CredentialProviderVendorType"}, - "oauth2ProviderConfigInput":{"shape":"Oauth2ProviderConfigInput"}, - "tags":{"shape":"TagsMap"} - } - }, - "CreateOauth2CredentialProviderResponse":{ - "type":"structure", - "required":[ - "clientSecretArn", - "name", - "credentialProviderArn" - ], - "members":{ - "clientSecretArn":{"shape":"Secret"}, - "clientSecretJsonKey":{"shape":"SecretJsonKeyType"}, - "clientSecretSource":{"shape":"SecretSourceType"}, - "name":{"shape":"CredentialProviderName"}, - "credentialProviderArn":{"shape":"CredentialProviderArnType"}, - "callbackUrl":{"shape":"String"}, - "oauth2ProviderConfigOutput":{"shape":"Oauth2ProviderConfigOutput"}, - "status":{"shape":"Status"} - } - }, - "CreateOnlineEvaluationConfigRequest":{ - "type":"structure", - "required":[ - "onlineEvaluationConfigName", - "rule", - "dataSourceConfig", - "evaluationExecutionRoleArn", - "enableOnCreate" - ], - "members":{ - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - }, - "onlineEvaluationConfigName":{"shape":"EvaluationConfigName"}, - "description":{"shape":"EvaluationConfigDescription"}, - "rule":{"shape":"Rule"}, - "dataSourceConfig":{"shape":"DataSourceConfig"}, - "evaluators":{"shape":"EvaluatorList"}, - "insights":{"shape":"InsightList"}, - "clusteringConfig":{"shape":"ClusteringConfig"}, - "evaluationExecutionRoleArn":{"shape":"RoleArn"}, - "enableOnCreate":{"shape":"Boolean"}, - "tags":{"shape":"TagsMap"} - } - }, - "CreateOnlineEvaluationConfigResponse":{ - "type":"structure", - "required":[ - "onlineEvaluationConfigArn", - "onlineEvaluationConfigId", - "createdAt", - "status", - "executionStatus" - ], - "members":{ - "onlineEvaluationConfigArn":{"shape":"OnlineEvaluationConfigArn"}, - "onlineEvaluationConfigId":{"shape":"OnlineEvaluationConfigId"}, - "createdAt":{"shape":"Timestamp"}, - "outputConfig":{"shape":"OutputConfig"}, - "status":{"shape":"OnlineEvaluationConfigStatus"}, - "executionStatus":{"shape":"OnlineEvaluationExecutionStatus"}, - "failureReason":{"shape":"String"} - } - }, - "CreatePaymentConnectorRequest":{ - "type":"structure", - "required":[ - "paymentManagerId", - "name", - "type", - "credentialProviderConfigurations" - ], - "members":{ - "paymentManagerId":{ - "shape":"PaymentManagerId", - "location":"uri", - "locationName":"paymentManagerId" - }, - "name":{"shape":"PaymentConnectorName"}, - "description":{"shape":"PaymentsDescription"}, - "type":{"shape":"PaymentConnectorType"}, - "credentialProviderConfigurations":{"shape":"CredentialsProviderConfigurations"}, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - } - } - }, - "CreatePaymentConnectorResponse":{ - "type":"structure", - "required":[ - "paymentConnectorId", - "paymentManagerId", - "name", - "type", - "credentialProviderConfigurations", - "createdAt", - "status" - ], - "members":{ - "paymentConnectorId":{"shape":"PaymentConnectorId"}, - "paymentManagerId":{"shape":"PaymentManagerId"}, - "name":{"shape":"PaymentConnectorName"}, - "type":{"shape":"PaymentConnectorType"}, - "credentialProviderConfigurations":{"shape":"CredentialsProviderConfigurations"}, - "createdAt":{"shape":"DateTimestamp"}, - "status":{"shape":"PaymentConnectorStatus"} - } - }, - "CreatePaymentCredentialProviderRequest":{ - "type":"structure", - "required":[ - "name", - "credentialProviderVendor", - "providerConfigurationInput" - ], - "members":{ - "name":{"shape":"CredentialProviderName"}, - "credentialProviderVendor":{"shape":"PaymentCredentialProviderVendorType"}, - "providerConfigurationInput":{"shape":"PaymentProviderConfigurationInput"}, - "tags":{"shape":"TagsMap"} - } - }, - "CreatePaymentCredentialProviderResponse":{ - "type":"structure", - "required":[ - "name", - "credentialProviderVendor", - "credentialProviderArn", - "providerConfigurationOutput" - ], - "members":{ - "name":{"shape":"CredentialProviderName"}, - "credentialProviderVendor":{"shape":"PaymentCredentialProviderVendorType"}, - "credentialProviderArn":{"shape":"PaymentCredentialProviderArnType"}, - "providerConfigurationOutput":{"shape":"PaymentProviderConfigurationOutput"} - } - }, - "CreatePaymentManagerRequest":{ - "type":"structure", - "required":[ - "name", - "authorizerType", - "roleArn" - ], - "members":{ - "name":{"shape":"PaymentManagerName"}, - "description":{"shape":"PaymentsDescription"}, - "authorizerType":{"shape":"PaymentsAuthorizerType"}, - "authorizerConfiguration":{"shape":"AuthorizerConfiguration"}, - "roleArn":{"shape":"RoleArn"}, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - }, - "tags":{"shape":"TagsMap"} - } - }, - "CreatePaymentManagerResponse":{ - "type":"structure", - "required":[ - "paymentManagerArn", - "paymentManagerId", - "name", - "authorizerType", - "roleArn", - "createdAt", - "status" - ], - "members":{ - "paymentManagerArn":{"shape":"PaymentManagerArn"}, - "paymentManagerId":{"shape":"PaymentManagerId"}, - "name":{"shape":"PaymentManagerName"}, - "authorizerType":{"shape":"PaymentsAuthorizerType"}, - "authorizerConfiguration":{"shape":"AuthorizerConfiguration"}, - "roleArn":{"shape":"RoleArn"}, - "workloadIdentityDetails":{"shape":"WorkloadIdentityDetails"}, - "createdAt":{"shape":"DateTimestamp"}, - "status":{"shape":"PaymentManagerStatus"}, - "tags":{"shape":"TagsMap"} - } - }, - "CreatePolicyEngineRequest":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{"shape":"PolicyEngineName"}, - "description":{"shape":"Description"}, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - }, - "encryptionKeyArn":{"shape":"KmsKeyArn"}, - "tags":{"shape":"TagsMap"} - } - }, - "CreatePolicyEngineResponse":{ - "type":"structure", - "required":[ - "policyEngineId", - "name", - "createdAt", - "updatedAt", - "policyEngineArn", - "status", - "statusReasons" - ], - "members":{ - "policyEngineId":{"shape":"ResourceId"}, - "name":{"shape":"PolicyEngineName"}, - "createdAt":{"shape":"DateTimestamp"}, - "updatedAt":{"shape":"DateTimestamp"}, - "policyEngineArn":{"shape":"PolicyEngineArn"}, - "status":{"shape":"PolicyEngineStatus"}, - "encryptionKeyArn":{"shape":"KmsKeyArn"}, - "description":{"shape":"Description"}, - "statusReasons":{"shape":"PolicyStatusReasons"} - } - }, - "CreatePolicyRequest":{ - "type":"structure", - "required":[ - "name", - "definition", - "policyEngineId" - ], - "members":{ - "name":{"shape":"PolicyName"}, - "definition":{"shape":"PolicyDefinition"}, - "description":{"shape":"Description"}, - "validationMode":{"shape":"PolicyValidationMode"}, - "enforcementMode":{"shape":"EnforcementMode"}, - "policyEngineId":{ - "shape":"ResourceId", - "location":"uri", - "locationName":"policyEngineId" - }, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - } - } - }, - "CreatePolicyResponse":{ - "type":"structure", - "required":[ - "policyId", - "name", - "policyEngineId", - "createdAt", - "updatedAt", - "policyArn", - "status", - "definition", - "statusReasons" - ], - "members":{ - "policyId":{"shape":"ResourceId"}, - "name":{"shape":"PolicyName"}, - "policyEngineId":{"shape":"ResourceId"}, - "createdAt":{"shape":"DateTimestamp"}, - "updatedAt":{"shape":"DateTimestamp"}, - "policyArn":{"shape":"PolicyArn"}, - "status":{"shape":"PolicyStatus"}, - "enforcementMode":{"shape":"EnforcementMode"}, - "definition":{"shape":"PolicyDefinition"}, - "description":{"shape":"Description"}, - "statusReasons":{"shape":"PolicyStatusReasons"} - } - }, - "CreateRegistryRecordRequest":{ - "type":"structure", - "required":[ - "registryId", - "name", - "descriptorType" - ], - "members":{ - "registryId":{ - "shape":"RegistryIdentifier", - "location":"uri", - "locationName":"registryId" - }, - "name":{"shape":"RegistryRecordName"}, - "description":{"shape":"Description"}, - "descriptorType":{"shape":"DescriptorType"}, - "descriptors":{"shape":"Descriptors"}, - "recordVersion":{"shape":"RegistryRecordVersion"}, - "synchronizationType":{"shape":"SynchronizationType"}, - "synchronizationConfiguration":{"shape":"SynchronizationConfiguration"}, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - } - } - }, - "CreateRegistryRecordResponse":{ - "type":"structure", - "required":[ - "recordArn", - "status" - ], - "members":{ - "recordArn":{"shape":"RegistryRecordArn"}, - "status":{"shape":"RegistryRecordStatus"} - } - }, - "CreateRegistryRequest":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{"shape":"RegistryName"}, - "description":{"shape":"Description"}, - "authorizerType":{"shape":"RegistryAuthorizerType"}, - "authorizerConfiguration":{"shape":"AuthorizerConfiguration"}, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - }, - "approvalConfiguration":{"shape":"ApprovalConfiguration"} - } - }, - "CreateRegistryResponse":{ - "type":"structure", - "required":["registryArn"], - "members":{ - "registryArn":{"shape":"RegistryArn"} - } - }, - "CreateWorkloadIdentityRequest":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{"shape":"WorkloadIdentityNameType"}, - "allowedResourceOauth2ReturnUrls":{"shape":"ResourceOauth2ReturnUrlListType"}, - "tags":{"shape":"TagsMap"} - } - }, - "CreateWorkloadIdentityResponse":{ - "type":"structure", - "required":[ - "name", - "workloadIdentityArn" - ], - "members":{ - "name":{"shape":"WorkloadIdentityNameType"}, - "workloadIdentityArn":{"shape":"WorkloadIdentityArnType"}, - "allowedResourceOauth2ReturnUrls":{"shape":"ResourceOauth2ReturnUrlListType"} - } - }, - "CredentialProvider":{ - "type":"structure", - "members":{ - "oauthCredentialProvider":{"shape":"OAuthCredentialProvider"}, - "apiKeyCredentialProvider":{"shape":"ApiKeyCredentialProvider"}, - "iamCredentialProvider":{"shape":"IamCredentialProvider"} - }, - "union":true - }, - "CredentialProviderArn":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:.*" - }, - "CredentialProviderArnType":{ - "type":"string", - "pattern":"arn:(aws|aws-us-gov):acps:[A-Za-z0-9-]{1,64}:[0-9]{12}:token-vault/[a-zA-Z0-9-.]+/oauth2credentialprovider/[a-zA-Z0-9-.]+" - }, - "CredentialProviderConfiguration":{ - "type":"structure", - "required":["credentialProviderType"], - "members":{ - "credentialProviderType":{"shape":"CredentialProviderType"}, - "credentialProvider":{"shape":"CredentialProvider"} - } - }, - "CredentialProviderConfigurations":{ - "type":"list", - "member":{"shape":"CredentialProviderConfiguration"}, - "max":1, - "min":1 - }, - "CredentialProviderName":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[a-zA-Z0-9\\-_]+" - }, - "CredentialProviderType":{ - "type":"string", - "enum":[ - "GATEWAY_IAM_ROLE", - "OAUTH", - "API_KEY", - "CALLER_IAM_CREDENTIALS", - "JWT_PASSTHROUGH" - ] - }, - "CredentialProviderVendorType":{ - "type":"string", - "enum":[ - "GoogleOauth2", - "GithubOauth2", - "SlackOauth2", - "SalesforceOauth2", - "MicrosoftOauth2", - "CustomOauth2", - "AtlassianOauth2", - "LinkedinOauth2", - "XOauth2", - "OktaOauth2", - "OneLoginOauth2", - "PingOneOauth2", - "FacebookOauth2", - "YandexOauth2", - "RedditOauth2", - "ZoomOauth2", - "TwitchOauth2", - "SpotifyOauth2", - "DropboxOauth2", - "NotionOauth2", - "HubspotOauth2", - "CyberArkOauth2", - "FusionAuthOauth2", - "Auth0Oauth2", - "CognitoOauth2" - ] - }, - "CredentialsProviderConfiguration":{ - "type":"structure", - "members":{ - "coinbaseCDP":{"shape":"PaymentCredentialProviderConfiguration"}, - "stripePrivy":{"shape":"PaymentCredentialProviderConfiguration"} - }, - "union":true - }, - "CredentialsProviderConfigurations":{ - "type":"list", - "member":{"shape":"CredentialsProviderConfiguration"}, - "max":1, - "min":1 - }, - "CustomClaimValidationType":{ - "type":"structure", - "required":[ - "inboundTokenClaimName", - "inboundTokenClaimValueType", - "authorizingClaimMatchValue" - ], - "members":{ - "inboundTokenClaimName":{"shape":"InboundTokenClaimNameType"}, - "inboundTokenClaimValueType":{"shape":"InboundTokenClaimValueType"}, - "authorizingClaimMatchValue":{"shape":"AuthorizingClaimMatchValueType"} - } - }, - "CustomClaimValidationsType":{ - "type":"list", - "member":{"shape":"CustomClaimValidationType"}, - "min":1 - }, - "CustomConfigurationInput":{ - "type":"structure", - "members":{ - "semanticOverride":{"shape":"SemanticOverrideConfigurationInput"}, - "summaryOverride":{"shape":"SummaryOverrideConfigurationInput"}, - "userPreferenceOverride":{"shape":"UserPreferenceOverrideConfigurationInput"}, - "episodicOverride":{"shape":"EpisodicOverrideConfigurationInput"}, - "selfManagedConfiguration":{"shape":"SelfManagedConfigurationInput"} - }, - "union":true - }, - "CustomConsolidationConfiguration":{ - "type":"structure", - "members":{ - "semanticConsolidationOverride":{"shape":"SemanticConsolidationOverride"}, - "summaryConsolidationOverride":{"shape":"SummaryConsolidationOverride"}, - "userPreferenceConsolidationOverride":{"shape":"UserPreferenceConsolidationOverride"}, - "episodicConsolidationOverride":{"shape":"EpisodicConsolidationOverride"} - }, - "union":true - }, - "CustomConsolidationConfigurationInput":{ - "type":"structure", - "members":{ - "semanticConsolidationOverride":{"shape":"SemanticOverrideConsolidationConfigurationInput"}, - "summaryConsolidationOverride":{"shape":"SummaryOverrideConsolidationConfigurationInput"}, - "userPreferenceConsolidationOverride":{"shape":"UserPreferenceOverrideConsolidationConfigurationInput"}, - "episodicConsolidationOverride":{"shape":"EpisodicOverrideConsolidationConfigurationInput"} - }, - "union":true - }, - "CustomDescriptor":{ - "type":"structure", - "members":{ - "inlineContent":{"shape":"InlineContent"} - } - }, - "CustomEvaluatorArn":{ - "type":"string", - "pattern":"arn:aws[a-zA-Z-]*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:evaluator\\/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}" - }, - "CustomEvaluatorName":{ - "type":"string", - "pattern":"[a-zA-Z][a-zA-Z0-9_]{0,47}" - }, - "CustomExtractionConfiguration":{ - "type":"structure", - "members":{ - "semanticExtractionOverride":{"shape":"SemanticExtractionOverride"}, - "userPreferenceExtractionOverride":{"shape":"UserPreferenceExtractionOverride"}, - "episodicExtractionOverride":{"shape":"EpisodicExtractionOverride"} - }, - "union":true - }, - "CustomExtractionConfigurationInput":{ - "type":"structure", - "members":{ - "semanticExtractionOverride":{"shape":"SemanticOverrideExtractionConfigurationInput"}, - "userPreferenceExtractionOverride":{"shape":"UserPreferenceOverrideExtractionConfigurationInput"}, - "episodicExtractionOverride":{"shape":"EpisodicOverrideExtractionConfigurationInput"} - }, - "union":true - }, - "CustomJWTAuthorizerConfiguration":{ - "type":"structure", - "required":["discoveryUrl"], - "members":{ - "discoveryUrl":{"shape":"DiscoveryUrl"}, - "allowedAudience":{"shape":"AllowedAudienceList"}, - "allowedClients":{"shape":"AllowedClientsList"}, - "allowedScopes":{"shape":"AllowedScopesType"}, - "advertisedScopeMapping":{"shape":"AdvertisedScopeMappingType"}, - "customClaims":{"shape":"CustomClaimValidationsType"}, - "privateEndpoint":{"shape":"PrivateEndpoint"}, - "privateEndpointOverrides":{"shape":"PrivateEndpointOverrides"}, - "allowedWorkloadConfiguration":{"shape":"AllowedWorkloadConfiguration"} - } - }, - "CustomMemoryStrategyInput":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{"shape":"Name"}, - "description":{"shape":"Description"}, - "namespaces":{ - "shape":"NamespacesList", - "deprecated":true, - "deprecatedMessage":"Use namespaceTemplates instead", - "deprecatedSince":"2026-03-02" - }, - "namespaceTemplates":{"shape":"NamespacesList"}, - "configuration":{"shape":"CustomConfigurationInput"}, - "memoryRecordSchema":{"shape":"MemoryRecordSchema"} - } - }, - "CustomOauth2ProviderConfigInput":{ - "type":"structure", - "required":["oauthDiscovery"], - "members":{ - "oauthDiscovery":{"shape":"Oauth2Discovery"}, - "clientId":{"shape":"DefaultClientIdType"}, - "clientSecret":{"shape":"DefaultClientSecretType"}, - "clientSecretConfig":{"shape":"SecretReference"}, - "clientSecretSource":{"shape":"SecretSourceType"}, - "onBehalfOfTokenExchangeConfig":{"shape":"OnBehalfOfTokenExchangeConfigType"}, - "clientAuthenticationMethod":{"shape":"ClientAuthenticationMethodType"}, - "privateKeyJwtConfig":{"shape":"PrivateKeyJwtConfig"}, - "privateEndpoint":{"shape":"PrivateEndpoint"}, - "privateEndpointOverrides":{"shape":"PrivateEndpointOverrides"} - } - }, - "CustomOauth2ProviderConfigOutput":{ - "type":"structure", - "required":["oauthDiscovery"], - "members":{ - "oauthDiscovery":{"shape":"Oauth2Discovery"}, - "clientId":{"shape":"ClientIdType"}, - "onBehalfOfTokenExchangeConfig":{"shape":"OnBehalfOfTokenExchangeConfigType"}, - "clientAuthenticationMethod":{"shape":"ClientAuthenticationMethodType"}, - "privateEndpoint":{"shape":"PrivateEndpoint"}, - "privateEndpointOverrides":{"shape":"PrivateEndpointOverrides"}, - "privateKeyJwtConfig":{"shape":"PrivateKeyJwtConfig"} - } - }, - "CustomParameterMap":{ - "type":"map", - "key":{"shape":"String"}, - "value":{"shape":"String"} - }, - "CustomReflectionConfiguration":{ - "type":"structure", - "members":{ - "episodicReflectionOverride":{"shape":"EpisodicReflectionOverride"} - }, - "union":true - }, - "CustomReflectionConfigurationInput":{ - "type":"structure", - "members":{ - "episodicReflectionOverride":{"shape":"EpisodicOverrideReflectionConfigurationInput"} - }, - "union":true - }, - "CustomTransformConfiguration":{ - "type":"structure", - "members":{ - "lambda":{"shape":"LambdaTransformConfiguration"} - } - }, - "DataSourceConfig":{ - "type":"structure", - "members":{ - "cloudWatchLogs":{"shape":"CloudWatchLogsInputConfig"} - }, - "union":true - }, - "DataSourceType":{ - "type":"structure", - "members":{ - "inlineExamples":{"shape":"InlineExamplesSource"}, - "s3Source":{"shape":"S3Source"} - }, - "union":true - }, - "DatasetArn":{ - "type":"string", - "pattern":"arn:aws(-[a-z]+)*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:dataset/[a-zA-Z0-9_-]{1,110}" - }, - "DatasetExampleList":{ - "type":"list", - "member":{"shape":"SensitiveJson"} - }, - "DatasetId":{ - "type":"string", - "pattern":"[a-zA-Z0-9_-]{1,110}" - }, - "DatasetName":{ - "type":"string", - "pattern":"[a-zA-Z][a-zA-Z0-9_]{0,47}" - }, - "DatasetSchemaType":{ - "type":"string", - "enum":[ - "AGENTCORE_EVALUATION_PREDEFINED_V1", - "AGENTCORE_EVALUATION_SIMULATED_V1" - ] - }, - "DatasetStatus":{ - "type":"string", - "enum":[ - "CREATING", - "UPDATING", - "DELETING", - "ACTIVE", - "CREATE_FAILED", - "UPDATE_FAILED", - "DELETE_FAILED" - ] - }, - "DatasetSummary":{ - "type":"structure", - "required":[ - "datasetArn", - "datasetId", - "datasetName", - "status", - "schemaType", - "exampleCount", - "createdAt", - "updatedAt" - ], - "members":{ - "datasetArn":{"shape":"DatasetArn"}, - "datasetId":{"shape":"DatasetId"}, - "datasetName":{"shape":"DatasetName"}, - "description":{"shape":"String"}, - "status":{"shape":"DatasetStatus"}, - "draftStatus":{"shape":"DraftStatus"}, - "schemaType":{"shape":"DatasetSchemaType"}, - "exampleCount":{"shape":"Long"}, - "createdAt":{"shape":"Timestamp"}, - "updatedAt":{"shape":"Timestamp"} - } - }, - "DatasetSummaryList":{ - "type":"list", - "member":{"shape":"DatasetSummary"} - }, - "DatasetVersion":{ - "type":"string", - "pattern":"(DRAFT|[0-9]+)" - }, - "DatasetVersionSummary":{ - "type":"structure", - "required":[ - "datasetVersion", - "exampleCount", - "createdAt" - ], - "members":{ - "datasetVersion":{"shape":"DatasetVersion"}, - "exampleCount":{"shape":"Long"}, - "createdAt":{"shape":"Timestamp"} - } - }, - "DatasetVersionSummaryList":{ - "type":"list", - "member":{"shape":"DatasetVersionSummary"} - }, - "DateTimestamp":{ - "type":"timestamp", - "timestampFormat":"iso8601" - }, - "DecryptionFailure":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"} - }, - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "DefaultApiKeyType":{ - "type":"string", - "max":65536, - "min":0, - "sensitive":true - }, - "DefaultClientIdType":{ - "type":"string", - "max":256, - "min":0 - }, - "DefaultClientSecretType":{ - "type":"string", - "max":2048, - "min":0, - "sensitive":true - }, - "DefaultCoinbaseCdpApiKeySecretType":{ - "type":"string", - "max":2048, - "min":0, - "pattern":"[a-zA-Z0-9+/=\\-_\\s]*", - "sensitive":true - }, - "DefaultCoinbaseCdpWalletSecretType":{ - "type":"string", - "max":2048, - "min":0, - "pattern":"[a-zA-Z0-9+/=\\-_\\s]*", - "sensitive":true - }, - "DefaultStripePrivyAppSecretType":{ - "type":"string", - "max":2048, - "min":0, - "pattern":"[a-zA-Z0-9+/=\\-_\\s]*", - "sensitive":true - }, - "DefaultStripePrivyAuthorizationPrivateKeyType":{ - "type":"string", - "max":2048, - "min":0, - "pattern":"(wallet-auth:)?[a-zA-Z0-9+/=\\-_\\s]*", - "sensitive":true - }, - "Definition":{ - "type":"string", - "max":1000, - "min":1, - "sensitive":true - }, - "DeleteAgentRuntimeEndpointRequest":{ - "type":"structure", - "required":[ - "agentRuntimeId", - "endpointName" - ], - "members":{ - "agentRuntimeId":{ - "shape":"AgentRuntimeId", - "location":"uri", - "locationName":"agentRuntimeId" - }, - "endpointName":{ - "shape":"EndpointName", - "location":"uri", - "locationName":"endpointName" - }, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true, - "location":"querystring", - "locationName":"clientToken" - } - } - }, - "DeleteAgentRuntimeEndpointResponse":{ - "type":"structure", - "required":["status"], - "members":{ - "status":{"shape":"AgentRuntimeEndpointStatus"}, - "agentRuntimeId":{"shape":"AgentRuntimeId"}, - "endpointName":{"shape":"EndpointName"} - } - }, - "DeleteAgentRuntimeRequest":{ - "type":"structure", - "required":["agentRuntimeId"], - "members":{ - "agentRuntimeId":{ - "shape":"AgentRuntimeId", - "location":"uri", - "locationName":"agentRuntimeId" - }, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true, - "location":"querystring", - "locationName":"clientToken" - } - } - }, - "DeleteAgentRuntimeResponse":{ - "type":"structure", - "required":["status"], - "members":{ - "status":{"shape":"AgentRuntimeStatus"}, - "agentRuntimeId":{"shape":"AgentRuntimeId"} - } - }, - "DeleteApiKeyCredentialProviderRequest":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{"shape":"CredentialProviderName"} - } - }, - "DeleteApiKeyCredentialProviderResponse":{ - "type":"structure", - "members":{} - }, - "DeleteBrowserProfileRequest":{ - "type":"structure", - "required":["profileId"], - "members":{ - "profileId":{ - "shape":"BrowserProfileId", - "location":"uri", - "locationName":"profileId" - }, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true, - "location":"querystring", - "locationName":"clientToken" - } - } - }, - "DeleteBrowserProfileResponse":{ - "type":"structure", - "required":[ - "profileId", - "profileArn", - "status", - "lastUpdatedAt" - ], - "members":{ - "profileId":{"shape":"BrowserProfileId"}, - "profileArn":{"shape":"BrowserProfileArn"}, - "status":{"shape":"BrowserProfileStatus"}, - "lastUpdatedAt":{"shape":"DateTimestamp"}, - "lastSavedAt":{"shape":"DateTimestamp"} - } - }, - "DeleteBrowserRequest":{ - "type":"structure", - "required":["browserId"], - "members":{ - "browserId":{ - "shape":"BrowserId", - "location":"uri", - "locationName":"browserId" - }, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true, - "location":"querystring", - "locationName":"clientToken" - } - } - }, - "DeleteBrowserResponse":{ - "type":"structure", - "required":[ - "browserId", - "status", - "lastUpdatedAt" - ], - "members":{ - "browserId":{"shape":"BrowserId"}, - "status":{"shape":"BrowserStatus"}, - "lastUpdatedAt":{"shape":"DateTimestamp"} - } - }, - "DeleteCodeInterpreterRequest":{ - "type":"structure", - "required":["codeInterpreterId"], - "members":{ - "codeInterpreterId":{ - "shape":"CodeInterpreterId", - "location":"uri", - "locationName":"codeInterpreterId" - }, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true, - "location":"querystring", - "locationName":"clientToken" - } - } - }, - "DeleteCodeInterpreterResponse":{ - "type":"structure", - "required":[ - "codeInterpreterId", - "status", - "lastUpdatedAt" - ], - "members":{ - "codeInterpreterId":{"shape":"CodeInterpreterId"}, - "status":{"shape":"CodeInterpreterStatus"}, - "lastUpdatedAt":{"shape":"DateTimestamp"} - } - }, - "DeleteConfigurationBundleRequest":{ - "type":"structure", - "required":["bundleId"], - "members":{ - "bundleId":{ - "shape":"ConfigurationBundleId", - "location":"uri", - "locationName":"bundleId" - } - } - }, - "DeleteConfigurationBundleResponse":{ - "type":"structure", - "required":[ - "bundleId", - "status" - ], - "members":{ - "bundleId":{"shape":"ConfigurationBundleId"}, - "status":{"shape":"ConfigurationBundleStatus"} - } - }, - "DeleteDatasetExamplesRequest":{ - "type":"structure", - "required":[ - "datasetId", - "exampleIds" - ], - "members":{ - "datasetId":{ - "shape":"DatasetId", - "location":"uri", - "locationName":"datasetId" - }, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - }, - "exampleIds":{"shape":"DeleteDatasetExamplesRequestExampleIdsList"} - } - }, - "DeleteDatasetExamplesRequestExampleIdsList":{ - "type":"list", - "member":{"shape":"ExampleId"}, - "max":1000, - "min":1 - }, - "DeleteDatasetExamplesResponse":{ - "type":"structure", - "required":[ - "datasetArn", - "datasetId", - "status", - "deletedCount", - "updatedAt" - ], - "members":{ - "datasetArn":{"shape":"DatasetArn"}, - "datasetId":{"shape":"DatasetId"}, - "status":{"shape":"DatasetStatus"}, - "deletedCount":{"shape":"Long"}, - "updatedAt":{"shape":"Timestamp"} - } - }, - "DeleteDatasetRequest":{ - "type":"structure", - "required":["datasetId"], - "members":{ - "datasetId":{ - "shape":"DatasetId", - "location":"uri", - "locationName":"datasetId" - }, - "datasetVersion":{ - "shape":"DatasetVersion", - "location":"querystring", - "locationName":"datasetVersion" - } - } - }, - "DeleteDatasetResponse":{ - "type":"structure", - "required":[ - "datasetArn", - "datasetId", - "status", - "datasetVersion", - "updatedAt" - ], - "members":{ - "datasetArn":{"shape":"DatasetArn"}, - "datasetId":{"shape":"DatasetId"}, - "status":{"shape":"DatasetStatus"}, - "datasetVersion":{"shape":"DatasetVersion"}, - "updatedAt":{"shape":"Timestamp"} - } - }, - "DeleteEvaluatorRequest":{ - "type":"structure", - "required":["evaluatorId"], - "members":{ - "evaluatorId":{ - "shape":"EvaluatorId", - "location":"uri", - "locationName":"evaluatorId" - } - } - }, - "DeleteEvaluatorResponse":{ - "type":"structure", - "required":[ - "evaluatorArn", - "evaluatorId", - "status" - ], - "members":{ - "evaluatorArn":{"shape":"EvaluatorArn"}, - "evaluatorId":{"shape":"EvaluatorId"}, - "status":{"shape":"EvaluatorStatus"} - } - }, - "DeleteGatewayRequest":{ - "type":"structure", - "required":["gatewayIdentifier"], - "members":{ - "gatewayIdentifier":{ - "shape":"GatewayIdentifier", - "location":"uri", - "locationName":"gatewayIdentifier" - } - } - }, - "DeleteGatewayResponse":{ - "type":"structure", - "required":[ - "gatewayId", - "status" - ], - "members":{ - "gatewayId":{"shape":"GatewayId"}, - "status":{"shape":"GatewayStatus"}, - "statusReasons":{"shape":"StatusReasons"} - } - }, - "DeleteGatewayRuleRequest":{ - "type":"structure", - "required":[ - "gatewayIdentifier", - "ruleId" - ], - "members":{ - "gatewayIdentifier":{ - "shape":"GatewayIdentifier", - "location":"uri", - "locationName":"gatewayIdentifier" - }, - "ruleId":{ - "shape":"GatewayRuleId", - "location":"uri", - "locationName":"ruleId" - } - } - }, - "DeleteGatewayRuleResponse":{ - "type":"structure", - "required":[ - "ruleId", - "status" - ], - "members":{ - "ruleId":{"shape":"GatewayRuleId"}, - "status":{"shape":"GatewayRuleStatus"} - } - }, - "DeleteGatewayTargetRequest":{ - "type":"structure", - "required":[ - "gatewayIdentifier", - "targetId" - ], - "members":{ - "gatewayIdentifier":{ - "shape":"GatewayIdentifier", - "location":"uri", - "locationName":"gatewayIdentifier" - }, - "targetId":{ - "shape":"TargetId", - "location":"uri", - "locationName":"targetId" - } - } - }, - "DeleteGatewayTargetResponse":{ - "type":"structure", - "required":[ - "gatewayArn", - "targetId", - "status" - ], - "members":{ - "gatewayArn":{"shape":"GatewayArn"}, - "targetId":{"shape":"TargetId"}, - "status":{"shape":"TargetStatus"}, - "statusReasons":{"shape":"StatusReasons"} - } - }, - "DeleteHarnessEndpointRequest":{ - "type":"structure", - "required":[ - "harnessId", - "endpointName" - ], - "members":{ - "harnessId":{ - "shape":"HarnessId", - "location":"uri", - "locationName":"harnessId" - }, - "endpointName":{ - "shape":"HarnessEndpointName", - "location":"uri", - "locationName":"endpointName" - }, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true, - "location":"querystring", - "locationName":"clientToken" - } - } - }, - "DeleteHarnessEndpointResponse":{ - "type":"structure", - "required":["endpoint"], - "members":{ - "endpoint":{"shape":"HarnessEndpoint"} - } - }, - "DeleteHarnessRequest":{ - "type":"structure", - "required":["harnessId"], - "members":{ - "harnessId":{ - "shape":"HarnessId", - "location":"uri", - "locationName":"harnessId" - }, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true, - "location":"querystring", - "locationName":"clientToken" - }, - "deleteManagedMemory":{ - "shape":"Boolean", - "location":"querystring", - "locationName":"deleteManagedMemory" - } - } - }, - "DeleteHarnessResponse":{ - "type":"structure", - "members":{ - "harness":{"shape":"Harness"} - } - }, - "DeleteMemoryInput":{ - "type":"structure", - "required":["memoryId"], - "members":{ - "clientToken":{ - "shape":"DeleteMemoryInputClientTokenString", - "idempotencyToken":true, - "location":"querystring", - "locationName":"clientToken" - }, - "memoryId":{ - "shape":"MemoryId", - "location":"uri", - "locationName":"memoryId" - } - } - }, - "DeleteMemoryInputClientTokenString":{ - "type":"string", - "max":500, - "min":0 - }, - "DeleteMemoryOutput":{ - "type":"structure", - "required":["memoryId"], - "members":{ - "memoryId":{"shape":"MemoryId"}, - "status":{"shape":"MemoryStatus"} - } - }, - "DeleteMemoryStrategiesList":{ - "type":"list", - "member":{"shape":"DeleteMemoryStrategyInput"} - }, - "DeleteMemoryStrategyInput":{ - "type":"structure", - "required":["memoryStrategyId"], - "members":{ - "memoryStrategyId":{"shape":"String"} - } - }, - "DeleteOauth2CredentialProviderRequest":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{"shape":"CredentialProviderName"} - } - }, - "DeleteOauth2CredentialProviderResponse":{ - "type":"structure", - "members":{} - }, - "DeleteOnlineEvaluationConfigRequest":{ - "type":"structure", - "required":["onlineEvaluationConfigId"], - "members":{ - "onlineEvaluationConfigId":{ - "shape":"OnlineEvaluationConfigId", - "location":"uri", - "locationName":"onlineEvaluationConfigId" - } - } - }, - "DeleteOnlineEvaluationConfigResponse":{ - "type":"structure", - "required":[ - "onlineEvaluationConfigArn", - "onlineEvaluationConfigId", - "status" - ], - "members":{ - "onlineEvaluationConfigArn":{"shape":"OnlineEvaluationConfigArn"}, - "onlineEvaluationConfigId":{"shape":"OnlineEvaluationConfigId"}, - "status":{"shape":"OnlineEvaluationConfigStatus"} - } - }, - "DeletePaymentConnectorRequest":{ - "type":"structure", - "required":[ - "paymentManagerId", - "paymentConnectorId" - ], - "members":{ - "paymentManagerId":{ - "shape":"PaymentManagerId", - "location":"uri", - "locationName":"paymentManagerId" - }, - "paymentConnectorId":{ - "shape":"PaymentConnectorId", - "location":"uri", - "locationName":"paymentConnectorId" - }, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true, - "location":"querystring", - "locationName":"clientToken" - } - } - }, - "DeletePaymentConnectorResponse":{ - "type":"structure", - "required":["status"], - "members":{ - "status":{"shape":"PaymentConnectorStatus"}, - "paymentConnectorId":{"shape":"PaymentConnectorId"} - } - }, - "DeletePaymentCredentialProviderRequest":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{"shape":"CredentialProviderName"} - } - }, - "DeletePaymentCredentialProviderResponse":{ - "type":"structure", - "members":{} - }, - "DeletePaymentManagerRequest":{ - "type":"structure", - "required":["paymentManagerId"], - "members":{ - "paymentManagerId":{ - "shape":"PaymentManagerId", - "location":"uri", - "locationName":"paymentManagerId" - }, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true, - "location":"querystring", - "locationName":"clientToken" - } - } - }, - "DeletePaymentManagerResponse":{ - "type":"structure", - "required":["status"], - "members":{ - "status":{"shape":"PaymentManagerStatus"}, - "paymentManagerId":{"shape":"PaymentManagerId"} - } - }, - "DeletePolicyEngineRequest":{ - "type":"structure", - "required":["policyEngineId"], - "members":{ - "policyEngineId":{ - "shape":"ResourceId", - "location":"uri", - "locationName":"policyEngineId" - } - } - }, - "DeletePolicyEngineResponse":{ - "type":"structure", - "required":[ - "policyEngineId", - "name", - "createdAt", - "updatedAt", - "policyEngineArn", - "status", - "statusReasons" - ], - "members":{ - "policyEngineId":{"shape":"ResourceId"}, - "name":{"shape":"PolicyEngineName"}, - "createdAt":{"shape":"DateTimestamp"}, - "updatedAt":{"shape":"DateTimestamp"}, - "policyEngineArn":{"shape":"PolicyEngineArn"}, - "status":{"shape":"PolicyEngineStatus"}, - "encryptionKeyArn":{"shape":"KmsKeyArn"}, - "description":{"shape":"Description"}, - "statusReasons":{"shape":"PolicyStatusReasons"} - } - }, - "DeletePolicyRequest":{ - "type":"structure", - "required":[ - "policyEngineId", - "policyId" - ], - "members":{ - "policyEngineId":{ - "shape":"ResourceId", - "location":"uri", - "locationName":"policyEngineId" - }, - "policyId":{ - "shape":"ResourceId", - "location":"uri", - "locationName":"policyId" - } - } - }, - "DeletePolicyResponse":{ - "type":"structure", - "required":[ - "policyId", - "name", - "policyEngineId", - "createdAt", - "updatedAt", - "policyArn", - "status", - "definition", - "statusReasons" - ], - "members":{ - "policyId":{"shape":"ResourceId"}, - "name":{"shape":"PolicyName"}, - "policyEngineId":{"shape":"ResourceId"}, - "createdAt":{"shape":"DateTimestamp"}, - "updatedAt":{"shape":"DateTimestamp"}, - "policyArn":{"shape":"PolicyArn"}, - "status":{"shape":"PolicyStatus"}, - "enforcementMode":{"shape":"EnforcementMode"}, - "definition":{"shape":"PolicyDefinition"}, - "description":{"shape":"Description"}, - "statusReasons":{"shape":"PolicyStatusReasons"} - } - }, - "DeleteRegistryRecordRequest":{ - "type":"structure", - "required":[ - "registryId", - "recordId" - ], - "members":{ - "registryId":{ - "shape":"RegistryIdentifier", - "location":"uri", - "locationName":"registryId" - }, - "recordId":{ - "shape":"RecordIdentifier", - "location":"uri", - "locationName":"recordId" - } - } - }, - "DeleteRegistryRecordResponse":{ - "type":"structure", - "members":{} - }, - "DeleteRegistryRequest":{ - "type":"structure", - "required":["registryId"], - "members":{ - "registryId":{ - "shape":"RegistryIdentifier", - "location":"uri", - "locationName":"registryId" - } - } - }, - "DeleteRegistryResponse":{ - "type":"structure", - "required":["status"], - "members":{ - "status":{"shape":"RegistryStatus"} - } - }, - "DeleteResourcePolicyRequest":{ - "type":"structure", - "required":["resourceArn"], - "members":{ - "resourceArn":{ - "shape":"BedrockAgentcoreResourceArn", - "location":"uri", - "locationName":"resourceArn" - } - } - }, - "DeleteResourcePolicyResponse":{ - "type":"structure", - "members":{} - }, - "DeleteWorkloadIdentityRequest":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{"shape":"WorkloadIdentityNameType"} - } - }, - "DeleteWorkloadIdentityResponse":{ - "type":"structure", - "members":{} - }, - "Description":{ - "type":"string", - "max":4096, - "min":1, - "sensitive":true - }, - "DescriptorType":{ - "type":"string", - "enum":[ - "MCP", - "A2A", - "CUSTOM", - "AGENT_SKILLS" - ] - }, - "Descriptors":{ - "type":"structure", - "members":{ - "mcp":{"shape":"McpDescriptor"}, - "a2a":{"shape":"A2aDescriptor"}, - "custom":{"shape":"CustomDescriptor"}, - "agentSkills":{"shape":"AgentSkillsDescriptor"} - } - }, - "DiscoveryUrl":{ - "type":"string", - "pattern":".+/\\.well-known/openid-configuration" - }, - "DiscoveryUrlType":{ - "type":"string", - "pattern":".+/\\.well-known/(openid-configuration|oauth-authorization-server)" - }, - "Document":{ - "type":"structure", - "members":{}, - "document":true - }, - "DomainName":{"type":"string"}, - "Double":{ - "type":"double", - "box":true - }, - "DownloadUrl":{ - "type":"string", - "sensitive":true - }, - "DraftStatus":{ - "type":"string", - "enum":[ - "MODIFIED", - "UNMODIFIED" - ] - }, - "EfsAccessPointArn":{ - "type":"string", - "max":128, - "min":0, - "pattern":"arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:access-point/fsap-[0-9a-f]{8,40}" - }, - "EfsAccessPointConfiguration":{ - "type":"structure", - "required":[ - "accessPointArn", - "mountPath" - ], - "members":{ - "accessPointArn":{"shape":"EfsAccessPointArn"}, - "mountPath":{"shape":"MountPath"} - } - }, - "EfsConfiguration":{ - "type":"structure", - "required":[ - "accessPointArn", - "mountPath", - "fileSystemArn" - ], - "members":{ - "accessPointArn":{"shape":"EfsAccessPointArn"}, - "mountPath":{"shape":"MountPath"}, - "fileSystemArn":{"shape":"EfsFileSystemArn"} - } - }, - "EfsFileSystemArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[-a-z]*:elasticfilesystem:[a-z0-9-]+:[0-9]{12}:file-system/fs-[0-9a-f]{8,40}" - }, - "EnabledConnectors":{ - "type":"list", - "member":{"shape":"String"}, - "max":50, - "min":1 - }, - "EncryptionFailure":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"} - }, - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "EndpointIpAddressType":{ - "type":"string", - "enum":[ - "IPV4", - "IPV6" - ] - }, - "EndpointName":{ - "type":"string", - "pattern":"[a-zA-Z][a-zA-Z0-9_]{0,47}", - "sensitive":true - }, - "EnforcementMode":{ - "type":"string", - "enum":[ - "ACTIVE", - "LOG_ONLY" - ] - }, - "EnvironmentVariableKey":{ - "type":"string", - "max":100, - "min":1 - }, - "EnvironmentVariableValue":{ - "type":"string", - "max":5000, - "min":0 - }, - "EnvironmentVariablesMap":{ - "type":"map", - "key":{"shape":"EnvironmentVariableKey"}, - "value":{"shape":"EnvironmentVariableValue"}, - "max":50, - "min":0, - "sensitive":true - }, - "EpisodicConsolidationOverride":{ - "type":"structure", - "required":[ - "appendToPrompt", - "modelId" - ], - "members":{ - "appendToPrompt":{"shape":"Prompt"}, - "modelId":{"shape":"String"} - } - }, - "EpisodicExtractionOverride":{ - "type":"structure", - "required":[ - "appendToPrompt", - "modelId" - ], - "members":{ - "appendToPrompt":{"shape":"Prompt"}, - "modelId":{"shape":"String"} - } - }, - "EpisodicMemoryStrategyInput":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{"shape":"Name"}, - "description":{"shape":"Description"}, - "namespaces":{ - "shape":"NamespacesList", - "deprecated":true, - "deprecatedMessage":"Use namespaceTemplates instead", - "deprecatedSince":"2026-03-02" - }, - "namespaceTemplates":{"shape":"NamespacesList"}, - "reflectionConfiguration":{"shape":"EpisodicReflectionConfigurationInput"}, - "memoryRecordSchema":{"shape":"MemoryRecordSchema"} - } - }, - "EpisodicOverrideConfigurationInput":{ - "type":"structure", - "members":{ - "extraction":{"shape":"EpisodicOverrideExtractionConfigurationInput"}, - "consolidation":{"shape":"EpisodicOverrideConsolidationConfigurationInput"}, - "reflection":{"shape":"EpisodicOverrideReflectionConfigurationInput"} - } - }, - "EpisodicOverrideConsolidationConfigurationInput":{ - "type":"structure", - "required":[ - "appendToPrompt", - "modelId" - ], - "members":{ - "appendToPrompt":{"shape":"Prompt"}, - "modelId":{"shape":"String"} - } - }, - "EpisodicOverrideExtractionConfigurationInput":{ - "type":"structure", - "required":[ - "appendToPrompt", - "modelId" - ], - "members":{ - "appendToPrompt":{"shape":"Prompt"}, - "modelId":{"shape":"String"} - } - }, - "EpisodicOverrideReflectionConfigurationInput":{ - "type":"structure", - "required":[ - "appendToPrompt", - "modelId" - ], - "members":{ - "appendToPrompt":{"shape":"Prompt"}, - "modelId":{"shape":"String"}, - "namespaces":{ - "shape":"NamespacesList", - "deprecated":true, - "deprecatedMessage":"Use namespaceTemplates instead", - "deprecatedSince":"2026-03-02" - }, - "namespaceTemplates":{"shape":"NamespacesList"}, - "memoryRecordSchema":{"shape":"MemoryRecordSchema"} - } - }, - "EpisodicReflectionConfiguration":{ - "type":"structure", - "members":{ - "namespaces":{ - "shape":"NamespacesList", - "deprecated":true, - "deprecatedMessage":"Use namespaceTemplates instead", - "deprecatedSince":"2026-03-02" - }, - "namespaceTemplates":{"shape":"NamespacesList"}, - "memoryRecordSchema":{"shape":"MemoryRecordSchema"} - } - }, - "EpisodicReflectionConfigurationInput":{ - "type":"structure", - "members":{ - "namespaces":{ - "shape":"NamespacesList", - "deprecated":true, - "deprecatedMessage":"Use namespaceTemplates instead", - "deprecatedSince":"2026-03-02" - }, - "namespaceTemplates":{"shape":"NamespacesList"}, - "memoryRecordSchema":{"shape":"MemoryRecordSchema"} - } - }, - "EpisodicReflectionOverride":{ - "type":"structure", - "required":[ - "appendToPrompt", - "modelId" - ], - "members":{ - "appendToPrompt":{"shape":"Prompt"}, - "modelId":{"shape":"String"}, - "namespaces":{ - "shape":"NamespacesList", - "deprecated":true, - "deprecatedMessage":"Use namespaceTemplates instead", - "deprecatedSince":"2026-03-02" - }, - "namespaceTemplates":{"shape":"NamespacesList"}, - "memoryRecordSchema":{"shape":"MemoryRecordSchema"} - } - }, - "EvaluationConfigDescription":{ - "type":"string", - "max":200, - "min":1, - "pattern":".+", - "sensitive":true - }, - "EvaluationConfigName":{ - "type":"string", - "pattern":"[a-zA-Z][a-zA-Z0-9_]{0,47}" - }, - "EvaluatorArn":{ - "type":"string", - "pattern":"arn:aws[a-zA-Z-]*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:evaluator\\/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}$|^arn:aws[a-zA-Z-]*:bedrock-agentcore:::evaluator/Builtin.[a-zA-Z0-9_-]+" - }, - "EvaluatorConfig":{ - "type":"structure", - "members":{ - "llmAsAJudge":{"shape":"LlmAsAJudgeEvaluatorConfig"}, - "codeBased":{"shape":"CodeBasedEvaluatorConfig"} - }, - "union":true - }, - "EvaluatorDescription":{ - "type":"string", - "max":200, - "min":1, - "sensitive":true - }, - "EvaluatorId":{ - "type":"string", - "pattern":"(Builtin.[a-zA-Z0-9_-]+|[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10})" - }, - "EvaluatorInstructions":{ - "type":"string", - "sensitive":true - }, - "EvaluatorLevel":{ - "type":"string", - "enum":[ - "TOOL_CALL", - "TRACE", - "SESSION" - ] - }, - "EvaluatorList":{ - "type":"list", - "member":{"shape":"EvaluatorReference"}, - "max":10, - "min":0 - }, - "EvaluatorModelConfig":{ - "type":"structure", - "members":{ - "bedrockEvaluatorModelConfig":{"shape":"BedrockEvaluatorModelConfig"}, - "responsesEvaluatorModelConfig":{"shape":"OpenResponsesEvaluatorModelConfig"} - }, - "union":true - }, - "EvaluatorName":{ - "type":"string", - "pattern":"(Builtin.[a-zA-Z0-9_-]+|[a-zA-Z][a-zA-Z0-9_]{0,47})" - }, - "EvaluatorReference":{ - "type":"structure", - "members":{ - "evaluatorId":{"shape":"EvaluatorId"} - }, - "union":true - }, - "EvaluatorStatus":{ - "type":"string", - "enum":[ - "ACTIVE", - "CREATING", - "CREATE_FAILED", - "UPDATING", - "UPDATE_FAILED", - "DELETING" - ] - }, - "EvaluatorSummary":{ - "type":"structure", - "required":[ - "evaluatorArn", - "evaluatorId", - "evaluatorName", - "evaluatorType", - "status", - "createdAt", - "updatedAt" - ], - "members":{ - "evaluatorArn":{"shape":"EvaluatorArn"}, - "evaluatorId":{"shape":"EvaluatorId"}, - "evaluatorName":{"shape":"EvaluatorName"}, - "description":{"shape":"EvaluatorDescription"}, - "evaluatorType":{"shape":"EvaluatorType"}, - "level":{"shape":"EvaluatorLevel"}, - "status":{"shape":"EvaluatorStatus"}, - "createdAt":{"shape":"Timestamp"}, - "updatedAt":{"shape":"Timestamp"}, - "lockedForModification":{"shape":"Boolean"}, - "kmsKeyArn":{"shape":"KmsKeyArn"} - } - }, - "EvaluatorSummaryList":{ - "type":"list", - "member":{"shape":"EvaluatorSummary"} - }, - "EvaluatorType":{ - "type":"string", - "enum":[ - "Builtin", - "Custom", - "CustomCode" - ] - }, - "ExampleId":{ - "type":"string", - "max":256, - "min":0, - "pattern":"[a-zA-Z0-9_.:-]+" - }, - "ExampleIdList":{ - "type":"list", - "member":{"shape":"ExampleId"} - }, - "ExceptionLevel":{ - "type":"string", - "enum":["DEBUG"] - }, - "ExtractionConfig":{ - "type":"structure", - "members":{ - "llmExtractionConfig":{"shape":"LlmExtractionConfig"} - }, - "union":true - }, - "ExtractionConfiguration":{ - "type":"structure", - "members":{ - "customExtractionConfiguration":{"shape":"CustomExtractionConfiguration"} - }, - "union":true - }, - "ExtractionType":{ - "type":"string", - "enum":[ - "LLM_INFERRED", - "STRICTLY_CONSISTENT" - ] - }, - "FilesystemConfiguration":{ - "type":"structure", - "members":{ - "sessionStorage":{"shape":"SessionStorageConfiguration"}, - "s3FilesAccessPoint":{"shape":"S3FilesAccessPointConfiguration"}, - "efsAccessPoint":{"shape":"EfsAccessPointConfiguration"} - }, - "union":true - }, - "FilesystemConfigurations":{ - "type":"list", - "member":{"shape":"FilesystemConfiguration"}, - "max":5, - "min":0 - }, - "Filter":{ - "type":"structure", - "required":[ - "key", - "operator", - "value" - ], - "members":{ - "key":{"shape":"FilterKeyString"}, - "operator":{"shape":"FilterOperator"}, - "value":{"shape":"FilterValue"} - } - }, - "FilterKeyString":{ - "type":"string", - "max":256, - "min":1, - "pattern":"[a-zA-Z0-9._-]+" - }, - "FilterList":{ - "type":"list", - "member":{"shape":"Filter"}, - "max":5, - "min":0 - }, - "FilterOperator":{ - "type":"string", - "enum":[ - "Equals", - "NotEquals", - "GreaterThan", - "LessThan", - "GreaterThanOrEqual", - "LessThanOrEqual", - "Contains", - "NotContains" - ] - }, - "FilterValue":{ - "type":"structure", - "members":{ - "stringValue":{"shape":"FilterValueStringValueString"}, - "doubleValue":{"shape":"Double"}, - "booleanValue":{"shape":"Boolean"} - }, - "union":true - }, - "FilterValueStringValueString":{ - "type":"string", - "max":1024, - "min":1 - }, - "Finding":{ - "type":"structure", - "members":{ - "type":{"shape":"FindingType"}, - "description":{"shape":"String"} - } - }, - "FindingType":{ - "type":"string", - "enum":[ - "VALID", - "INVALID", - "NOT_TRANSLATABLE", - "ALLOW_ALL", - "ALLOW_NONE", - "DENY_ALL", - "DENY_NONE" - ] - }, - "Findings":{ - "type":"list", - "member":{"shape":"Finding"} - }, - "Float":{ - "type":"float", - "box":true - }, - "FromUrlSynchronizationConfiguration":{ - "type":"structure", - "required":["url"], - "members":{ - "url":{"shape":"McpServerUrl"}, - "credentialProviderConfigurations":{"shape":"RegistryRecordCredentialProviderConfigurationList"} - } - }, - "GatewayArn":{ - "type":"string", - "pattern":"arn:aws(|-cn|-us-gov):bedrock-agentcore:[a-z0-9-]{1,20}:[0-9]{12}:gateway/([0-9a-z][-]?){1,48}-[a-z0-9]{10}" - }, - "GatewayConfigurationBundleArn":{ - "type":"string", - "pattern":"arn:aws[a-zA-Z-]*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:configuration-bundle/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}" - }, - "GatewayDescription":{ - "type":"string", - "max":200, - "min":1, - "sensitive":true - }, - "GatewayId":{ - "type":"string", - "pattern":"([0-9a-z][-]?){1,100}-[0-9a-z]{10}" - }, - "GatewayIdentifier":{ - "type":"string", - "pattern":"([0-9a-z][-]?){1,100}-[0-9a-z]{10}" - }, - "GatewayInterceptionPoint":{ - "type":"string", - "enum":[ - "REQUEST", - "RESPONSE" - ] - }, - "GatewayInterceptionPoints":{ - "type":"list", - "member":{"shape":"GatewayInterceptionPoint"}, - "max":2, - "min":1 - }, - "GatewayInterceptorConfiguration":{ - "type":"structure", - "required":[ - "interceptor", - "interceptionPoints" - ], - "members":{ - "interceptor":{"shape":"InterceptorConfiguration"}, - "interceptionPoints":{"shape":"GatewayInterceptionPoints"}, - "inputConfiguration":{"shape":"InterceptorInputConfiguration"} - } - }, - "GatewayInterceptorConfigurations":{ - "type":"list", - "member":{"shape":"GatewayInterceptorConfiguration"}, - "max":2, - "min":1 - }, - "GatewayMaxResults":{ - "type":"integer", - "box":true, - "max":1000, - "min":1 - }, - "GatewayName":{ - "type":"string", - "pattern":"([0-9a-zA-Z][-]?){1,48}" - }, - "GatewayNextToken":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"\\S*" - }, - "GatewayPolicyEngineArn":{ - "type":"string", - "max":170, - "min":1, - "pattern":"arn:aws:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:policy-engine\\/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9_]{10}" - }, - "GatewayPolicyEngineConfiguration":{ - "type":"structure", - "required":[ - "arn", - "mode" - ], - "members":{ - "arn":{"shape":"GatewayPolicyEngineArn"}, - "mode":{"shape":"GatewayPolicyEngineMode"} - } - }, - "GatewayPolicyEngineMode":{ - "type":"string", - "enum":[ - "LOG_ONLY", - "ENFORCE" - ] - }, - "GatewayProtocolConfiguration":{ - "type":"structure", - "members":{ - "mcp":{"shape":"MCPGatewayConfiguration"} - }, - "union":true - }, - "GatewayProtocolType":{ - "type":"string", - "enum":["MCP"] - }, - "GatewayRuleDescription":{ - "type":"string", - "max":256, - "min":1 - }, - "GatewayRuleDetail":{ - "type":"structure", - "required":[ - "ruleId", - "gatewayArn", - "priority", - "actions", - "createdAt", - "status" - ], - "members":{ - "ruleId":{"shape":"GatewayRuleId"}, - "gatewayArn":{"shape":"GatewayArn"}, - "priority":{"shape":"GatewayRulePriority"}, - "conditions":{"shape":"Conditions"}, - "actions":{"shape":"Actions"}, - "description":{"shape":"GatewayRuleDescription"}, - "createdAt":{"shape":"DateTimestamp"}, - "status":{"shape":"GatewayRuleStatus"}, - "system":{"shape":"SystemManagedBlock"}, - "updatedAt":{"shape":"DateTimestamp"} - } - }, - "GatewayRuleId":{ - "type":"string", - "max":36, - "min":36, - "pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" - }, - "GatewayRuleMaxResults":{ - "type":"integer", - "box":true, - "max":100, - "min":1 - }, - "GatewayRuleNextToken":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"\\S*" - }, - "GatewayRulePriority":{ - "type":"integer", - "box":true, - "max":1000000, - "min":1 - }, - "GatewayRuleStatus":{ - "type":"string", - "enum":[ - "CREATING", - "ACTIVE", - "UPDATING", - "DELETING" - ] - }, - "GatewayRules":{ - "type":"list", - "member":{"shape":"GatewayRuleDetail"} - }, - "GatewayStatus":{ - "type":"string", - "enum":[ - "CREATING", - "UPDATING", - "UPDATE_UNSUCCESSFUL", - "DELETING", - "READY", - "FAILED" - ] - }, - "GatewaySummaries":{ - "type":"list", - "member":{"shape":"GatewaySummary"} - }, - "GatewaySummary":{ - "type":"structure", - "required":[ - "gatewayId", - "name", - "status", - "createdAt", - "updatedAt", - "authorizerType" - ], - "members":{ - "gatewayId":{"shape":"GatewayId"}, - "name":{"shape":"GatewayName"}, - "status":{"shape":"GatewayStatus"}, - "description":{"shape":"GatewayDescription"}, - "createdAt":{"shape":"DateTimestamp"}, - "updatedAt":{"shape":"DateTimestamp"}, - "authorizerType":{"shape":"AuthorizerType"}, - "protocolType":{"shape":"GatewayProtocolType"} - } - }, - "GatewayTarget":{ - "type":"structure", - "required":[ - "gatewayArn", - "targetId", - "createdAt", - "updatedAt", - "status", - "name", - "targetConfiguration", - "credentialProviderConfigurations" - ], - "members":{ - "gatewayArn":{"shape":"GatewayArn"}, - "targetId":{"shape":"TargetId"}, - "createdAt":{"shape":"DateTimestamp"}, - "updatedAt":{"shape":"DateTimestamp"}, - "status":{"shape":"TargetStatus"}, - "statusReasons":{"shape":"StatusReasons"}, - "name":{"shape":"TargetName"}, - "description":{"shape":"TargetDescription"}, - "targetConfiguration":{"shape":"TargetConfiguration"}, - "credentialProviderConfigurations":{"shape":"CredentialProviderConfigurations"}, - "lastSynchronizedAt":{"shape":"DateTimestamp"}, - "metadataConfiguration":{"shape":"MetadataConfiguration"}, - "privateEndpoint":{"shape":"PrivateEndpoint"}, - "privateEndpointManagedResources":{"shape":"PrivateEndpointManagedResources"}, - "authorizationData":{"shape":"AuthorizationData"}, - "protocolType":{"shape":"TargetProtocolType"} - } - }, - "GatewayTargetList":{ - "type":"list", - "member":{"shape":"GatewayTarget"} - }, - "GatewayUrl":{ - "type":"string", - "max":1024, - "min":1 - }, - "GetAgentRuntimeEndpointRequest":{ - "type":"structure", - "required":[ - "agentRuntimeId", - "endpointName" - ], - "members":{ - "agentRuntimeId":{ - "shape":"AgentRuntimeId", - "location":"uri", - "locationName":"agentRuntimeId" - }, - "endpointName":{ - "shape":"EndpointName", - "location":"uri", - "locationName":"endpointName" - } - } - }, - "GetAgentRuntimeEndpointResponse":{ - "type":"structure", - "required":[ - "agentRuntimeEndpointArn", - "agentRuntimeArn", - "status", - "createdAt", - "lastUpdatedAt", - "name", - "id" - ], - "members":{ - "liveVersion":{"shape":"AgentRuntimeVersion"}, - "targetVersion":{"shape":"AgentRuntimeVersion"}, - "agentRuntimeEndpointArn":{"shape":"AgentRuntimeEndpointArn"}, - "agentRuntimeArn":{"shape":"AgentRuntimeArn"}, - "description":{"shape":"AgentEndpointDescription"}, - "status":{"shape":"AgentRuntimeEndpointStatus"}, - "createdAt":{"shape":"DateTimestamp"}, - "lastUpdatedAt":{"shape":"DateTimestamp"}, - "failureReason":{"shape":"String"}, - "name":{"shape":"EndpointName"}, - "id":{"shape":"AgentRuntimeEndpointId"} - } - }, - "GetAgentRuntimeRequest":{ - "type":"structure", - "required":["agentRuntimeId"], - "members":{ - "agentRuntimeId":{ - "shape":"AgentRuntimeId", - "location":"uri", - "locationName":"agentRuntimeId" - }, - "agentRuntimeVersion":{ - "shape":"AgentRuntimeVersion", - "location":"querystring", - "locationName":"version" - } - } - }, - "GetAgentRuntimeResponse":{ - "type":"structure", - "required":[ - "agentRuntimeArn", - "agentRuntimeName", - "agentRuntimeId", - "agentRuntimeVersion", - "createdAt", - "lastUpdatedAt", - "roleArn", - "networkConfiguration", - "status", - "lifecycleConfiguration" - ], - "members":{ - "agentRuntimeArn":{"shape":"AgentRuntimeArn"}, - "agentRuntimeName":{"shape":"AgentRuntimeName"}, - "agentRuntimeId":{"shape":"AgentRuntimeId"}, - "agentRuntimeVersion":{"shape":"AgentRuntimeVersion"}, - "createdAt":{"shape":"DateTimestamp"}, - "lastUpdatedAt":{"shape":"DateTimestamp"}, - "roleArn":{"shape":"RoleArn"}, - "networkConfiguration":{"shape":"NetworkConfiguration"}, - "status":{"shape":"AgentRuntimeStatus"}, - "lifecycleConfiguration":{"shape":"LifecycleConfiguration"}, - "failureReason":{"shape":"String"}, - "description":{"shape":"Description"}, - "workloadIdentityDetails":{"shape":"WorkloadIdentityDetails"}, - "agentRuntimeArtifact":{"shape":"AgentRuntimeArtifact"}, - "protocolConfiguration":{"shape":"ProtocolConfiguration"}, - "environmentVariables":{"shape":"EnvironmentVariablesMap"}, - "authorizerConfiguration":{"shape":"AuthorizerConfiguration"}, - "requestHeaderConfiguration":{"shape":"RequestHeaderConfiguration"}, - "metadataConfiguration":{"shape":"RuntimeMetadataConfiguration"}, - "filesystemConfigurations":{"shape":"FilesystemConfigurations"} - } - }, - "GetApiKeyCredentialProviderRequest":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{"shape":"CredentialProviderName"} - } - }, - "GetApiKeyCredentialProviderResponse":{ - "type":"structure", - "required":[ - "apiKeySecretArn", - "name", - "credentialProviderArn", - "createdTime", - "lastUpdatedTime" - ], - "members":{ - "apiKeySecretArn":{"shape":"Secret"}, - "apiKeySecretJsonKey":{"shape":"SecretJsonKeyType"}, - "apiKeySecretSource":{"shape":"SecretSourceType"}, - "name":{"shape":"CredentialProviderName"}, - "credentialProviderArn":{"shape":"ApiKeyCredentialProviderArnType"}, - "createdTime":{"shape":"Timestamp"}, - "lastUpdatedTime":{"shape":"Timestamp"} - } - }, - "GetBrowserProfileRequest":{ - "type":"structure", - "required":["profileId"], - "members":{ - "profileId":{ - "shape":"BrowserProfileId", - "location":"uri", - "locationName":"profileId" - } - } - }, - "GetBrowserProfileResponse":{ - "type":"structure", - "required":[ - "profileId", - "profileArn", - "name", - "status", - "createdAt", - "lastUpdatedAt" - ], - "members":{ - "profileId":{"shape":"BrowserProfileId"}, - "profileArn":{"shape":"BrowserProfileArn"}, - "name":{"shape":"BrowserProfileName"}, - "description":{"shape":"Description"}, - "status":{"shape":"BrowserProfileStatus"}, - "createdAt":{"shape":"DateTimestamp"}, - "lastUpdatedAt":{"shape":"DateTimestamp"}, - "lastSavedAt":{"shape":"DateTimestamp"}, - "lastSavedBrowserSessionId":{"shape":"BrowserSessionId"}, - "lastSavedBrowserId":{"shape":"BrowserId"} - } - }, - "GetBrowserRequest":{ - "type":"structure", - "required":["browserId"], - "members":{ - "browserId":{ - "shape":"BrowserId", - "location":"uri", - "locationName":"browserId" - } - } - }, - "GetBrowserResponse":{ - "type":"structure", - "required":[ - "browserId", - "browserArn", - "name", - "networkConfiguration", - "status", - "createdAt", - "lastUpdatedAt" - ], - "members":{ - "browserId":{"shape":"BrowserId"}, - "browserArn":{"shape":"BrowserArn"}, - "name":{"shape":"SandboxName"}, - "description":{"shape":"Description"}, - "executionRoleArn":{"shape":"RoleArn"}, - "networkConfiguration":{"shape":"BrowserNetworkConfiguration"}, - "recording":{"shape":"RecordingConfig"}, - "browserSigning":{"shape":"BrowserSigningConfigOutput"}, - "enterprisePolicies":{"shape":"BrowserEnterprisePolicies"}, - "certificates":{"shape":"Certificates"}, - "filesystemConfigurations":{"shape":"ToolsFileSystemConfigurations"}, - "status":{"shape":"BrowserStatus"}, - "failureReason":{"shape":"String"}, - "createdAt":{"shape":"DateTimestamp"}, - "lastUpdatedAt":{"shape":"DateTimestamp"} - } - }, - "GetCodeInterpreterRequest":{ - "type":"structure", - "required":["codeInterpreterId"], - "members":{ - "codeInterpreterId":{ - "shape":"CodeInterpreterId", - "location":"uri", - "locationName":"codeInterpreterId" - } - } - }, - "GetCodeInterpreterResponse":{ - "type":"structure", - "required":[ - "codeInterpreterId", - "codeInterpreterArn", - "name", - "networkConfiguration", - "status", - "createdAt", - "lastUpdatedAt" - ], - "members":{ - "codeInterpreterId":{"shape":"CodeInterpreterId"}, - "codeInterpreterArn":{"shape":"CodeInterpreterArn"}, - "name":{"shape":"SandboxName"}, - "description":{"shape":"Description"}, - "executionRoleArn":{"shape":"RoleArn"}, - "networkConfiguration":{"shape":"CodeInterpreterNetworkConfiguration"}, - "status":{"shape":"CodeInterpreterStatus"}, - "certificates":{"shape":"Certificates"}, - "filesystemConfigurations":{"shape":"ToolsFileSystemConfigurations"}, - "failureReason":{"shape":"String"}, - "createdAt":{"shape":"DateTimestamp"}, - "lastUpdatedAt":{"shape":"DateTimestamp"} - } - }, - "GetConfigurationBundleRequest":{ - "type":"structure", - "required":["bundleId"], - "members":{ - "bundleId":{ - "shape":"ConfigurationBundleId", - "location":"uri", - "locationName":"bundleId" - }, - "branchName":{ - "shape":"BranchName", - "location":"querystring", - "locationName":"branchName" - } - } - }, - "GetConfigurationBundleResponse":{ - "type":"structure", - "required":[ - "bundleArn", - "bundleId", - "bundleName", - "versionId", - "components", - "createdAt", - "updatedAt" - ], - "members":{ - "bundleArn":{"shape":"ConfigurationBundleArn"}, - "bundleId":{"shape":"ConfigurationBundleId"}, - "bundleName":{"shape":"ConfigurationBundleName"}, - "description":{"shape":"ConfigurationBundleDescription"}, - "versionId":{"shape":"ConfigurationBundleVersion"}, - "components":{"shape":"ComponentConfigurationMap"}, - "lineageMetadata":{"shape":"VersionLineageMetadata"}, - "createdAt":{"shape":"Timestamp"}, - "updatedAt":{"shape":"Timestamp"}, - "kmsKeyArn":{"shape":"KmsKeyArn"} - } - }, - "GetConfigurationBundleVersionRequest":{ - "type":"structure", - "required":[ - "bundleId", - "versionId" - ], - "members":{ - "bundleId":{ - "shape":"ConfigurationBundleId", - "location":"uri", - "locationName":"bundleId" - }, - "versionId":{ - "shape":"ConfigurationBundleVersion", - "location":"uri", - "locationName":"versionId" - } - } - }, - "GetConfigurationBundleVersionResponse":{ - "type":"structure", - "required":[ - "bundleArn", - "bundleId", - "bundleName", - "versionId", - "components", - "createdAt", - "versionCreatedAt" - ], - "members":{ - "bundleArn":{"shape":"ConfigurationBundleArn"}, - "bundleId":{"shape":"ConfigurationBundleId"}, - "bundleName":{"shape":"ConfigurationBundleName"}, - "description":{"shape":"ConfigurationBundleDescription"}, - "versionId":{"shape":"ConfigurationBundleVersion"}, - "components":{"shape":"ComponentConfigurationMap"}, - "lineageMetadata":{"shape":"VersionLineageMetadata"}, - "createdAt":{"shape":"Timestamp"}, - "versionCreatedAt":{"shape":"Timestamp"}, - "kmsKeyArn":{"shape":"KmsKeyArn"} - } - }, - "GetDatasetRequest":{ - "type":"structure", - "required":["datasetId"], - "members":{ - "datasetId":{ - "shape":"DatasetId", - "location":"uri", - "locationName":"datasetId" - }, - "datasetVersion":{ - "shape":"DatasetVersion", - "location":"querystring", - "locationName":"datasetVersion" - } - } - }, - "GetDatasetResponse":{ - "type":"structure", - "required":[ - "datasetArn", - "datasetId", - "datasetVersion", - "datasetName", - "status", - "schemaType", - "exampleCount", - "createdAt", - "updatedAt" - ], - "members":{ - "datasetArn":{"shape":"DatasetArn"}, - "datasetId":{"shape":"DatasetId"}, - "datasetVersion":{"shape":"DatasetVersion"}, - "datasetName":{"shape":"DatasetName"}, - "description":{"shape":"String"}, - "status":{"shape":"DatasetStatus"}, - "draftStatus":{"shape":"DraftStatus"}, - "failureReason":{"shape":"String"}, - "schemaType":{"shape":"DatasetSchemaType"}, - "kmsKeyArn":{"shape":"KmsKeyArn"}, - "exampleCount":{"shape":"Long"}, - "downloadUrl":{"shape":"DownloadUrl"}, - "downloadUrlExpiresAt":{"shape":"Timestamp"}, - "createdAt":{"shape":"Timestamp"}, - "updatedAt":{"shape":"Timestamp"}, - "tags":{"shape":"TagsMap"} - } - }, - "GetEvaluatorRequest":{ - "type":"structure", - "required":["evaluatorId"], - "members":{ - "evaluatorId":{ - "shape":"EvaluatorId", - "location":"uri", - "locationName":"evaluatorId" - }, - "includedData":{ - "shape":"IncludedData", - "location":"querystring", - "locationName":"includedData" - } - } - }, - "GetEvaluatorResponse":{ - "type":"structure", - "required":[ - "evaluatorArn", - "evaluatorId", - "evaluatorName", - "evaluatorConfig", - "level", - "status", - "createdAt", - "updatedAt" - ], - "members":{ - "evaluatorArn":{"shape":"EvaluatorArn"}, - "evaluatorId":{"shape":"EvaluatorId"}, - "evaluatorName":{"shape":"EvaluatorName"}, - "description":{"shape":"EvaluatorDescription"}, - "evaluatorConfig":{"shape":"EvaluatorConfig"}, - "level":{"shape":"EvaluatorLevel"}, - "status":{"shape":"EvaluatorStatus"}, - "createdAt":{"shape":"Timestamp"}, - "updatedAt":{"shape":"Timestamp"}, - "lockedForModification":{"shape":"Boolean"}, - "kmsKeyArn":{"shape":"KmsKeyArn"} - } - }, - "GetGatewayRequest":{ - "type":"structure", - "required":["gatewayIdentifier"], - "members":{ - "gatewayIdentifier":{ - "shape":"GatewayIdentifier", - "location":"uri", - "locationName":"gatewayIdentifier" - } - } - }, - "GetGatewayResponse":{ - "type":"structure", - "required":[ - "gatewayArn", - "gatewayId", - "createdAt", - "updatedAt", - "status", - "name", - "authorizerType" - ], - "members":{ - "gatewayArn":{"shape":"GatewayArn"}, - "gatewayId":{"shape":"GatewayId"}, - "gatewayUrl":{"shape":"GatewayUrl"}, - "createdAt":{"shape":"DateTimestamp"}, - "updatedAt":{"shape":"DateTimestamp"}, - "status":{"shape":"GatewayStatus"}, - "statusReasons":{"shape":"StatusReasons"}, - "name":{"shape":"GatewayName"}, - "description":{"shape":"GatewayDescription"}, - "roleArn":{"shape":"RoleArn"}, - "protocolType":{"shape":"GatewayProtocolType"}, - "protocolConfiguration":{"shape":"GatewayProtocolConfiguration"}, - "authorizerType":{"shape":"AuthorizerType"}, - "authorizerConfiguration":{"shape":"AuthorizerConfiguration"}, - "kmsKeyArn":{"shape":"KmsKeyArn"}, - "customTransformConfiguration":{"shape":"CustomTransformConfiguration"}, - "interceptorConfigurations":{"shape":"GatewayInterceptorConfigurations"}, - "policyEngineConfiguration":{"shape":"GatewayPolicyEngineConfiguration"}, - "workloadIdentityDetails":{"shape":"WorkloadIdentityDetails"}, - "exceptionLevel":{"shape":"ExceptionLevel"}, - "webAclArn":{"shape":"WebAclArn"}, - "wafConfiguration":{"shape":"WafConfiguration"} - } - }, - "GetGatewayRuleRequest":{ - "type":"structure", - "required":[ - "gatewayIdentifier", - "ruleId" - ], - "members":{ - "gatewayIdentifier":{ - "shape":"GatewayIdentifier", - "location":"uri", - "locationName":"gatewayIdentifier" - }, - "ruleId":{ - "shape":"GatewayRuleId", - "location":"uri", - "locationName":"ruleId" - } - } - }, - "GetGatewayRuleResponse":{ - "type":"structure", - "required":[ - "ruleId", - "gatewayArn", - "priority", - "actions", - "createdAt", - "status" - ], - "members":{ - "ruleId":{"shape":"GatewayRuleId"}, - "gatewayArn":{"shape":"GatewayArn"}, - "priority":{"shape":"GatewayRulePriority"}, - "conditions":{"shape":"Conditions"}, - "actions":{"shape":"Actions"}, - "description":{"shape":"GatewayRuleDescription"}, - "createdAt":{"shape":"DateTimestamp"}, - "status":{"shape":"GatewayRuleStatus"}, - "system":{"shape":"SystemManagedBlock"}, - "updatedAt":{"shape":"DateTimestamp"} - } - }, - "GetGatewayTargetRequest":{ - "type":"structure", - "required":[ - "gatewayIdentifier", - "targetId" - ], - "members":{ - "gatewayIdentifier":{ - "shape":"GatewayIdentifier", - "location":"uri", - "locationName":"gatewayIdentifier" - }, - "targetId":{ - "shape":"TargetId", - "location":"uri", - "locationName":"targetId" - } - } - }, - "GetGatewayTargetResponse":{ - "type":"structure", - "required":[ - "gatewayArn", - "targetId", - "createdAt", - "updatedAt", - "status", - "name", - "targetConfiguration", - "credentialProviderConfigurations" - ], - "members":{ - "gatewayArn":{"shape":"GatewayArn"}, - "targetId":{"shape":"TargetId"}, - "createdAt":{"shape":"DateTimestamp"}, - "updatedAt":{"shape":"DateTimestamp"}, - "status":{"shape":"TargetStatus"}, - "statusReasons":{"shape":"StatusReasons"}, - "name":{"shape":"TargetName"}, - "description":{"shape":"TargetDescription"}, - "targetConfiguration":{"shape":"TargetConfiguration"}, - "credentialProviderConfigurations":{"shape":"CredentialProviderConfigurations"}, - "lastSynchronizedAt":{"shape":"DateTimestamp"}, - "metadataConfiguration":{"shape":"MetadataConfiguration"}, - "privateEndpoint":{"shape":"PrivateEndpoint"}, - "privateEndpointManagedResources":{"shape":"PrivateEndpointManagedResources"}, - "authorizationData":{"shape":"AuthorizationData"}, - "protocolType":{"shape":"TargetProtocolType"} - } - }, - "GetHarnessEndpointRequest":{ - "type":"structure", - "required":[ - "harnessId", - "endpointName" - ], - "members":{ - "harnessId":{ - "shape":"HarnessId", - "location":"uri", - "locationName":"harnessId" - }, - "endpointName":{ - "shape":"HarnessEndpointName", - "location":"uri", - "locationName":"endpointName" - } - } - }, - "GetHarnessEndpointResponse":{ - "type":"structure", - "required":["endpoint"], - "members":{ - "endpoint":{"shape":"HarnessEndpoint"} - } - }, - "GetHarnessRequest":{ - "type":"structure", - "required":["harnessId"], - "members":{ - "harnessId":{ - "shape":"HarnessId", - "location":"uri", - "locationName":"harnessId" - }, - "harnessVersion":{ - "shape":"HarnessVersion", - "location":"querystring", - "locationName":"harnessVersion" - } - } - }, - "GetHarnessResponse":{ - "type":"structure", - "required":["harness"], - "members":{ - "harness":{"shape":"Harness"} - } - }, - "GetMemoryInput":{ - "type":"structure", - "required":["memoryId"], - "members":{ - "memoryId":{ - "shape":"MemoryId", - "location":"uri", - "locationName":"memoryId" - }, - "view":{ - "shape":"MemoryView", - "location":"querystring", - "locationName":"view" - } - } - }, - "GetMemoryOutput":{ - "type":"structure", - "required":["memory"], - "members":{ - "memory":{"shape":"Memory"} - } - }, - "GetOauth2CredentialProviderRequest":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{"shape":"CredentialProviderName"} - } - }, - "GetOauth2CredentialProviderResponse":{ - "type":"structure", - "required":[ - "clientSecretArn", - "name", - "credentialProviderArn", - "credentialProviderVendor", - "oauth2ProviderConfigOutput", - "createdTime", - "lastUpdatedTime" - ], - "members":{ - "clientSecretArn":{"shape":"Secret"}, - "clientSecretJsonKey":{"shape":"SecretJsonKeyType"}, - "clientSecretSource":{"shape":"SecretSourceType"}, - "name":{"shape":"CredentialProviderName"}, - "credentialProviderArn":{"shape":"CredentialProviderArnType"}, - "credentialProviderVendor":{"shape":"CredentialProviderVendorType"}, - "callbackUrl":{"shape":"String"}, - "oauth2ProviderConfigOutput":{"shape":"Oauth2ProviderConfigOutput"}, - "createdTime":{"shape":"Timestamp"}, - "lastUpdatedTime":{"shape":"Timestamp"}, - "status":{"shape":"Status"}, - "failureReason":{"shape":"String"} - } - }, - "GetOnlineEvaluationConfigRequest":{ - "type":"structure", - "required":["onlineEvaluationConfigId"], - "members":{ - "onlineEvaluationConfigId":{ - "shape":"OnlineEvaluationConfigId", - "location":"uri", - "locationName":"onlineEvaluationConfigId" - } - } - }, - "GetOnlineEvaluationConfigResponse":{ - "type":"structure", - "required":[ - "onlineEvaluationConfigArn", - "onlineEvaluationConfigId", - "onlineEvaluationConfigName", - "rule", - "dataSourceConfig", - "status", - "executionStatus", - "createdAt", - "updatedAt" - ], - "members":{ - "onlineEvaluationConfigArn":{"shape":"OnlineEvaluationConfigArn"}, - "onlineEvaluationConfigId":{"shape":"OnlineEvaluationConfigId"}, - "onlineEvaluationConfigName":{"shape":"EvaluationConfigName"}, - "description":{"shape":"EvaluationConfigDescription"}, - "rule":{"shape":"Rule"}, - "dataSourceConfig":{"shape":"DataSourceConfig"}, - "evaluators":{"shape":"EvaluatorList"}, - "insights":{"shape":"InsightList"}, - "clusteringConfig":{"shape":"ClusteringConfig"}, - "outputConfig":{"shape":"OutputConfig"}, - "evaluationExecutionRoleArn":{"shape":"RoleArn"}, - "status":{"shape":"OnlineEvaluationConfigStatus"}, - "executionStatus":{"shape":"OnlineEvaluationExecutionStatus"}, - "createdAt":{"shape":"Timestamp"}, - "updatedAt":{"shape":"Timestamp"}, - "failureReason":{"shape":"String"} - } - }, - "GetPaymentConnectorRequest":{ - "type":"structure", - "required":[ - "paymentManagerId", - "paymentConnectorId" - ], - "members":{ - "paymentManagerId":{ - "shape":"PaymentManagerId", - "location":"uri", - "locationName":"paymentManagerId" - }, - "paymentConnectorId":{ - "shape":"PaymentConnectorId", - "location":"uri", - "locationName":"paymentConnectorId" - } - } - }, - "GetPaymentConnectorResponse":{ - "type":"structure", - "required":[ - "paymentConnectorId", - "name", - "type", - "credentialProviderConfigurations", - "createdAt", - "lastUpdatedAt", - "status" - ], - "members":{ - "paymentConnectorId":{"shape":"PaymentConnectorId"}, - "name":{"shape":"PaymentConnectorName"}, - "description":{"shape":"PaymentsDescription"}, - "type":{"shape":"PaymentConnectorType"}, - "credentialProviderConfigurations":{"shape":"CredentialsProviderConfigurations"}, - "createdAt":{"shape":"DateTimestamp"}, - "lastUpdatedAt":{"shape":"DateTimestamp"}, - "status":{"shape":"PaymentConnectorStatus"} - } - }, - "GetPaymentCredentialProviderRequest":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{"shape":"CredentialProviderName"} - } - }, - "GetPaymentCredentialProviderResponse":{ - "type":"structure", - "required":[ - "name", - "credentialProviderArn", - "credentialProviderVendor", - "providerConfigurationOutput", - "createdTime", - "lastUpdatedTime" - ], - "members":{ - "name":{"shape":"CredentialProviderName"}, - "credentialProviderArn":{"shape":"PaymentCredentialProviderArnType"}, - "credentialProviderVendor":{"shape":"PaymentCredentialProviderVendorType"}, - "providerConfigurationOutput":{"shape":"PaymentProviderConfigurationOutput"}, - "createdTime":{"shape":"Timestamp"}, - "lastUpdatedTime":{"shape":"Timestamp"}, - "tags":{"shape":"TagsMap"} - } - }, - "GetPaymentManagerRequest":{ - "type":"structure", - "required":["paymentManagerId"], - "members":{ - "paymentManagerId":{ - "shape":"PaymentManagerId", - "location":"uri", - "locationName":"paymentManagerId" - } - } - }, - "GetPaymentManagerResponse":{ - "type":"structure", - "required":[ - "paymentManagerArn", - "paymentManagerId", - "name", - "authorizerType", - "roleArn", - "createdAt", - "lastUpdatedAt", - "status" - ], - "members":{ - "paymentManagerArn":{"shape":"PaymentManagerArn"}, - "paymentManagerId":{"shape":"PaymentManagerId"}, - "name":{"shape":"PaymentManagerName"}, - "description":{"shape":"PaymentsDescription"}, - "authorizerType":{"shape":"PaymentsAuthorizerType"}, - "authorizerConfiguration":{"shape":"AuthorizerConfiguration"}, - "roleArn":{"shape":"RoleArn"}, - "workloadIdentityDetails":{"shape":"WorkloadIdentityDetails"}, - "createdAt":{"shape":"DateTimestamp"}, - "lastUpdatedAt":{"shape":"DateTimestamp"}, - "status":{"shape":"PaymentManagerStatus"}, - "tags":{"shape":"TagsMap"} - } - }, - "GetPolicyEngineRequest":{ - "type":"structure", - "required":["policyEngineId"], - "members":{ - "policyEngineId":{ - "shape":"ResourceId", - "location":"uri", - "locationName":"policyEngineId" - } - } - }, - "GetPolicyEngineResponse":{ - "type":"structure", - "required":[ - "policyEngineId", - "name", - "createdAt", - "updatedAt", - "policyEngineArn", - "status", - "statusReasons" - ], - "members":{ - "policyEngineId":{"shape":"ResourceId"}, - "name":{"shape":"PolicyEngineName"}, - "createdAt":{"shape":"DateTimestamp"}, - "updatedAt":{"shape":"DateTimestamp"}, - "policyEngineArn":{"shape":"PolicyEngineArn"}, - "status":{"shape":"PolicyEngineStatus"}, - "encryptionKeyArn":{"shape":"KmsKeyArn"}, - "description":{"shape":"Description"}, - "statusReasons":{"shape":"PolicyStatusReasons"} - } - }, - "GetPolicyEngineSummaryRequest":{ - "type":"structure", - "required":["policyEngineId"], - "members":{ - "policyEngineId":{ - "shape":"ResourceId", - "location":"uri", - "locationName":"policyEngineId" - } - } - }, - "GetPolicyEngineSummaryResponse":{ - "type":"structure", - "required":[ - "policyEngineId", - "name", - "createdAt", - "updatedAt", - "policyEngineArn", - "status" - ], - "members":{ - "policyEngineId":{"shape":"ResourceId"}, - "name":{"shape":"PolicyEngineName"}, - "createdAt":{"shape":"DateTimestamp"}, - "updatedAt":{"shape":"DateTimestamp"}, - "policyEngineArn":{"shape":"PolicyEngineArn"}, - "status":{"shape":"PolicyEngineStatus"}, - "encryptionKeyArn":{"shape":"KmsKeyArn"} - } - }, - "GetPolicyGenerationRequest":{ - "type":"structure", - "required":[ - "policyGenerationId", - "policyEngineId" - ], - "members":{ - "policyGenerationId":{ - "shape":"ResourceId", - "location":"uri", - "locationName":"policyGenerationId" - }, - "policyEngineId":{ - "shape":"ResourceId", - "location":"uri", - "locationName":"policyEngineId" - } - } - }, - "GetPolicyGenerationResponse":{ - "type":"structure", - "required":[ - "policyEngineId", - "policyGenerationId", - "name", - "policyGenerationArn", - "resource", - "createdAt", - "updatedAt", - "status", - "statusReasons" - ], - "members":{ - "policyEngineId":{"shape":"ResourceId"}, - "policyGenerationId":{"shape":"ResourceId"}, - "name":{"shape":"PolicyGenerationName"}, - "policyGenerationArn":{"shape":"PolicyGenerationArn"}, - "resource":{"shape":"Resource"}, - "createdAt":{"shape":"DateTimestamp"}, - "updatedAt":{"shape":"DateTimestamp"}, - "status":{"shape":"PolicyGenerationStatus"}, - "findings":{"shape":"String"}, - "statusReasons":{"shape":"PolicyStatusReasons"} - } - }, - "GetPolicyGenerationSummaryRequest":{ - "type":"structure", - "required":[ - "policyGenerationId", - "policyEngineId" - ], - "members":{ - "policyGenerationId":{ - "shape":"ResourceId", - "location":"uri", - "locationName":"policyGenerationId" - }, - "policyEngineId":{ - "shape":"ResourceId", - "location":"uri", - "locationName":"policyEngineId" - } - } - }, - "GetPolicyGenerationSummaryResponse":{ - "type":"structure", - "required":[ - "policyEngineId", - "policyGenerationId", - "name", - "policyGenerationArn", - "resource", - "createdAt", - "updatedAt", - "status" - ], - "members":{ - "policyEngineId":{"shape":"ResourceId"}, - "policyGenerationId":{"shape":"ResourceId"}, - "name":{"shape":"PolicyGenerationName"}, - "policyGenerationArn":{"shape":"PolicyGenerationArn"}, - "resource":{"shape":"Resource"}, - "createdAt":{"shape":"DateTimestamp"}, - "updatedAt":{"shape":"DateTimestamp"}, - "status":{"shape":"PolicyGenerationStatus"}, - "findings":{"shape":"String"} - } - }, - "GetPolicyRequest":{ - "type":"structure", - "required":[ - "policyEngineId", - "policyId" - ], - "members":{ - "policyEngineId":{ - "shape":"ResourceId", - "location":"uri", - "locationName":"policyEngineId" - }, - "policyId":{ - "shape":"ResourceId", - "location":"uri", - "locationName":"policyId" - } - } - }, - "GetPolicyResponse":{ - "type":"structure", - "required":[ - "policyId", - "name", - "policyEngineId", - "createdAt", - "updatedAt", - "policyArn", - "status", - "definition", - "statusReasons" - ], - "members":{ - "policyId":{"shape":"ResourceId"}, - "name":{"shape":"PolicyName"}, - "policyEngineId":{"shape":"ResourceId"}, - "createdAt":{"shape":"DateTimestamp"}, - "updatedAt":{"shape":"DateTimestamp"}, - "policyArn":{"shape":"PolicyArn"}, - "status":{"shape":"PolicyStatus"}, - "enforcementMode":{"shape":"EnforcementMode"}, - "definition":{"shape":"PolicyDefinition"}, - "description":{"shape":"Description"}, - "statusReasons":{"shape":"PolicyStatusReasons"} - } - }, - "GetPolicySummaryRequest":{ - "type":"structure", - "required":[ - "policyEngineId", - "policyId" - ], - "members":{ - "policyEngineId":{ - "shape":"ResourceId", - "location":"uri", - "locationName":"policyEngineId" - }, - "policyId":{ - "shape":"ResourceId", - "location":"uri", - "locationName":"policyId" - } - } - }, - "GetPolicySummaryResponse":{ - "type":"structure", - "required":[ - "policyId", - "name", - "policyEngineId", - "createdAt", - "updatedAt", - "policyArn", - "status" - ], - "members":{ - "policyId":{"shape":"ResourceId"}, - "name":{"shape":"PolicyName"}, - "policyEngineId":{"shape":"ResourceId"}, - "createdAt":{"shape":"DateTimestamp"}, - "updatedAt":{"shape":"DateTimestamp"}, - "policyArn":{"shape":"PolicyArn"}, - "status":{"shape":"PolicyStatus"}, - "enforcementMode":{"shape":"EnforcementMode"} - } - }, - "GetRegistryRecordRequest":{ - "type":"structure", - "required":[ - "registryId", - "recordId" - ], - "members":{ - "registryId":{ - "shape":"RegistryIdentifier", - "location":"uri", - "locationName":"registryId" - }, - "recordId":{ - "shape":"RecordIdentifier", - "location":"uri", - "locationName":"recordId" - } - } - }, - "GetRegistryRecordResponse":{ - "type":"structure", - "required":[ - "registryArn", - "recordArn", - "recordId", - "name", - "descriptorType", - "descriptors", - "status", - "createdAt", - "updatedAt" - ], - "members":{ - "registryArn":{"shape":"RegistryArn"}, - "recordArn":{"shape":"RegistryRecordArn"}, - "recordId":{"shape":"RegistryRecordId"}, - "name":{"shape":"RegistryRecordName"}, - "description":{"shape":"Description"}, - "descriptorType":{"shape":"DescriptorType"}, - "descriptors":{"shape":"Descriptors"}, - "recordVersion":{"shape":"RegistryRecordVersion"}, - "status":{"shape":"RegistryRecordStatus"}, - "createdAt":{"shape":"DateTimestamp"}, - "updatedAt":{"shape":"DateTimestamp"}, - "statusReason":{"shape":"String"}, - "synchronizationType":{"shape":"SynchronizationType"}, - "synchronizationConfiguration":{"shape":"SynchronizationConfiguration"} - } - }, - "GetRegistryRequest":{ - "type":"structure", - "required":["registryId"], - "members":{ - "registryId":{ - "shape":"RegistryIdentifier", - "location":"uri", - "locationName":"registryId" - } - } - }, - "GetRegistryResponse":{ - "type":"structure", - "required":[ - "name", - "registryId", - "registryArn", - "status", - "createdAt", - "updatedAt" - ], - "members":{ - "name":{"shape":"RegistryName"}, - "description":{"shape":"Description"}, - "registryId":{"shape":"RegistryId"}, - "registryArn":{"shape":"RegistryArn"}, - "authorizerType":{"shape":"RegistryAuthorizerType"}, - "authorizerConfiguration":{"shape":"AuthorizerConfiguration"}, - "approvalConfiguration":{"shape":"ApprovalConfiguration"}, - "status":{"shape":"RegistryStatus"}, - "statusReason":{"shape":"String"}, - "createdAt":{"shape":"DateTimestamp"}, - "updatedAt":{"shape":"DateTimestamp"} - } - }, - "GetResourcePolicyRequest":{ - "type":"structure", - "required":["resourceArn"], - "members":{ - "resourceArn":{ - "shape":"BedrockAgentcoreResourceArn", - "location":"uri", - "locationName":"resourceArn" - } - } - }, - "GetResourcePolicyResponse":{ - "type":"structure", - "members":{ - "policy":{"shape":"ResourcePolicyBody"} - } - }, - "GetTokenVaultRequest":{ - "type":"structure", - "members":{ - "tokenVaultId":{"shape":"TokenVaultIdType"} - } - }, - "GetTokenVaultResponse":{ - "type":"structure", - "required":[ - "tokenVaultId", - "kmsConfiguration", - "lastModifiedDate" - ], - "members":{ - "tokenVaultId":{"shape":"TokenVaultIdType"}, - "kmsConfiguration":{"shape":"KmsConfiguration"}, - "lastModifiedDate":{"shape":"Timestamp"} - } - }, - "GetWorkloadIdentityRequest":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{"shape":"WorkloadIdentityNameType"} - } - }, - "GetWorkloadIdentityResponse":{ - "type":"structure", - "required":[ - "name", - "workloadIdentityArn", - "createdTime", - "lastUpdatedTime" - ], - "members":{ - "name":{"shape":"WorkloadIdentityNameType"}, - "workloadIdentityArn":{"shape":"WorkloadIdentityArnType"}, - "allowedResourceOauth2ReturnUrls":{"shape":"ResourceOauth2ReturnUrlListType"}, - "createdTime":{"shape":"Timestamp"}, - "lastUpdatedTime":{"shape":"Timestamp"} - } - }, - "GithubOauth2ProviderConfigInput":{ - "type":"structure", - "required":["clientId"], - "members":{ - "clientId":{"shape":"ClientIdType"}, - "clientSecret":{"shape":"DefaultClientSecretType"}, - "clientSecretConfig":{"shape":"SecretReference"}, - "clientSecretSource":{"shape":"SecretSourceType"} - } - }, - "GithubOauth2ProviderConfigOutput":{ - "type":"structure", - "required":["oauthDiscovery"], - "members":{ - "oauthDiscovery":{"shape":"Oauth2Discovery"}, - "clientId":{"shape":"ClientIdType"} - } - }, - "GoogleOauth2ProviderConfigInput":{ - "type":"structure", - "required":["clientId"], - "members":{ - "clientId":{"shape":"ClientIdType"}, - "clientSecret":{"shape":"DefaultClientSecretType"}, - "clientSecretConfig":{"shape":"SecretReference"}, - "clientSecretSource":{"shape":"SecretSourceType"} - } - }, - "GoogleOauth2ProviderConfigOutput":{ - "type":"structure", - "required":["oauthDiscovery"], - "members":{ - "oauthDiscovery":{"shape":"Oauth2Discovery"}, - "clientId":{"shape":"ClientIdType"} - } - }, - "Harness":{ - "type":"structure", - "required":[ - "harnessId", - "harnessName", - "arn", - "status", - "executionRoleArn", - "createdAt", - "updatedAt", - "model", - "systemPrompt", - "tools", - "skills", - "allowedTools", - "truncation", - "environment" - ], - "members":{ - "harnessId":{"shape":"HarnessId"}, - "harnessName":{"shape":"HarnessName"}, - "arn":{"shape":"HarnessArn"}, - "status":{"shape":"HarnessStatus"}, - "harnessVersion":{"shape":"HarnessVersion"}, - "executionRoleArn":{"shape":"RoleArn"}, - "createdAt":{"shape":"DateTimestamp"}, - "updatedAt":{"shape":"DateTimestamp"}, - "model":{"shape":"HarnessModelConfiguration"}, - "systemPrompt":{"shape":"HarnessSystemPrompt"}, - "tools":{"shape":"HarnessTools"}, - "skills":{"shape":"HarnessSkills"}, - "allowedTools":{"shape":"HarnessAllowedTools"}, - "truncation":{"shape":"HarnessTruncationConfiguration"}, - "environment":{"shape":"HarnessEnvironmentProvider"}, - "environmentArtifact":{"shape":"HarnessEnvironmentArtifact"}, - "environmentVariables":{"shape":"EnvironmentVariablesMap"}, - "authorizerConfiguration":{"shape":"AuthorizerConfiguration"}, - "memory":{"shape":"HarnessMemoryConfiguration"}, - "maxIterations":{"shape":"Integer"}, - "maxTokens":{"shape":"Integer"}, - "timeoutSeconds":{"shape":"Integer"}, - "failureReason":{"shape":"String"} - } - }, - "HarnessAgentCoreBrowserConfig":{ - "type":"structure", - "members":{ - "browserArn":{"shape":"HarnessBrowserArn"} - } - }, - "HarnessAgentCoreCodeInterpreterConfig":{ - "type":"structure", - "members":{ - "codeInterpreterArn":{"shape":"HarnessCodeInterpreterArn"} - } - }, - "HarnessAgentCoreGatewayConfig":{ - "type":"structure", - "required":["gatewayArn"], - "members":{ - "gatewayArn":{"shape":"GatewayArn"}, - "outboundAuth":{"shape":"HarnessGatewayOutboundAuth"} - } - }, - "HarnessAgentCoreMemoryConfiguration":{ - "type":"structure", - "required":["arn"], - "members":{ - "arn":{"shape":"MemoryArn"}, - "actorId":{"shape":"String"}, - "messagesCount":{"shape":"Integer"}, - "retrievalConfig":{"shape":"HarnessAgentCoreMemoryRetrievalConfigs"} - } - }, - "HarnessAgentCoreMemoryRetrievalConfig":{ - "type":"structure", - "members":{ - "topK":{"shape":"Integer"}, - "relevanceScore":{"shape":"Float"}, - "strategyId":{"shape":"String"} - } - }, - "HarnessAgentCoreMemoryRetrievalConfigs":{ - "type":"map", - "key":{"shape":"String"}, - "value":{"shape":"HarnessAgentCoreMemoryRetrievalConfig"} - }, - "HarnessAgentCoreRuntimeEnvironment":{ - "type":"structure", - "required":[ - "agentRuntimeArn", - "agentRuntimeName", - "agentRuntimeId", - "lifecycleConfiguration", - "networkConfiguration" - ], - "members":{ - "agentRuntimeArn":{"shape":"BedrockAgentcoreResourceArn"}, - "agentRuntimeName":{"shape":"String"}, - "agentRuntimeId":{"shape":"String"}, - "lifecycleConfiguration":{"shape":"LifecycleConfiguration"}, - "networkConfiguration":{"shape":"NetworkConfiguration"}, - "filesystemConfigurations":{"shape":"FilesystemConfigurations"} - } - }, - "HarnessAgentCoreRuntimeEnvironmentRequest":{ - "type":"structure", - "members":{ - "lifecycleConfiguration":{"shape":"LifecycleConfiguration"}, - "networkConfiguration":{"shape":"NetworkConfiguration"}, - "filesystemConfigurations":{"shape":"FilesystemConfigurations"} - } - }, - "HarnessAllowedTool":{ - "type":"string", - "max":64, - "min":1, - "pattern":"(\\*|@?[^/]+(/[^/]+)?)" - }, - "HarnessAllowedTools":{ - "type":"list", - "member":{"shape":"HarnessAllowedTool"} - }, - "HarnessArn":{ - "type":"string", - "pattern":"arn:([^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:harness/[a-zA-Z][a-zA-Z0-9_]{0,39}-[a-zA-Z0-9]{10}" - }, - "HarnessAwsSkillPath":{ - "type":"string", - "max":4096, - "min":1, - "pattern":"([^*?\\[\\]]|\\*)+" - }, - "HarnessAwsSkillPaths":{ - "type":"list", - "member":{"shape":"HarnessAwsSkillPath"} - }, - "HarnessBedrockApiFormat":{ - "type":"string", - "enum":[ - "converse_stream", - "responses", - "chat_completions" - ] - }, - "HarnessBedrockModelConfig":{ - "type":"structure", - "required":["modelId"], - "members":{ - "modelId":{"shape":"ModelId"}, - "maxTokens":{"shape":"MaxTokens"}, - "temperature":{"shape":"Temperature"}, - "topP":{"shape":"TopP"}, - "apiFormat":{"shape":"HarnessBedrockApiFormat"}, - "additionalParams":{"shape":"Document"} - } - }, - "HarnessBrowserArn":{ - "type":"string", - "pattern":"arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:(aws|[0-9]{12}):browser(-custom)?/(aws\\.browser\\.v1|[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10})" - }, - "HarnessCodeInterpreterArn":{ - "type":"string", - "pattern":"arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:(aws|[0-9]{12}):code-interpreter(-custom)?/(aws\\.codeinterpreter\\.v1|[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10})" - }, - "HarnessDisabledMemoryConfiguration":{ - "type":"structure", - "members":{} - }, - "HarnessEndpoint":{ - "type":"structure", - "required":[ - "harnessId", - "harnessName", - "endpointName", - "arn", - "status", - "createdAt", - "updatedAt" - ], - "members":{ - "harnessId":{"shape":"HarnessId"}, - "harnessName":{"shape":"HarnessName"}, - "endpointName":{"shape":"HarnessEndpointName"}, - "arn":{"shape":"HarnessEndpointArn"}, - "status":{"shape":"HarnessEndpointStatus"}, - "createdAt":{"shape":"DateTimestamp"}, - "updatedAt":{"shape":"DateTimestamp"}, - "liveVersion":{"shape":"HarnessVersion"}, - "targetVersion":{"shape":"HarnessVersion"}, - "description":{"shape":"HarnessEndpointDescription"}, - "failureReason":{"shape":"String"} - } - }, - "HarnessEndpointArn":{ - "type":"string", - "pattern":"arn:([^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:harness/[a-zA-Z][a-zA-Z0-9_]{0,39}-[a-zA-Z0-9]{10}/harness-endpoint/[a-zA-Z][a-zA-Z0-9_]{0,47}" - }, - "HarnessEndpointDescription":{ - "type":"string", - "max":256, - "min":1 - }, - "HarnessEndpointName":{ - "type":"string", - "pattern":"[a-zA-Z][a-zA-Z0-9_]{0,47}" - }, - "HarnessEndpointStatus":{ - "type":"string", - "enum":[ - "CREATING", - "CREATE_FAILED", - "UPDATING", - "UPDATE_FAILED", - "READY", - "DELETING", - "DELETE_FAILED" - ] - }, - "HarnessEndpoints":{ - "type":"list", - "member":{"shape":"HarnessEndpoint"} - }, - "HarnessEnvironmentArtifact":{ - "type":"structure", - "members":{ - "containerConfiguration":{"shape":"ContainerConfiguration"} - }, - "union":true - }, - "HarnessEnvironmentProvider":{ - "type":"structure", - "members":{ - "agentCoreRuntimeEnvironment":{"shape":"HarnessAgentCoreRuntimeEnvironment"} - }, - "union":true - }, - "HarnessEnvironmentProviderRequest":{ - "type":"structure", - "members":{ - "agentCoreRuntimeEnvironment":{"shape":"HarnessAgentCoreRuntimeEnvironmentRequest"} - }, - "union":true - }, - "HarnessGatewayOutboundAuth":{ - "type":"structure", - "members":{ - "awsIam":{"shape":"Unit"}, - "none":{"shape":"Unit"}, - "oauth":{"shape":"OAuthCredentialProvider"} - }, - "union":true - }, - "HarnessGeminiModelConfig":{ - "type":"structure", - "required":[ - "modelId", - "apiKeyArn" - ], - "members":{ - "modelId":{"shape":"ModelId"}, - "apiKeyArn":{"shape":"ApiKeyArn"}, - "maxTokens":{"shape":"MaxTokens"}, - "temperature":{"shape":"Temperature"}, - "topP":{"shape":"TopP"}, - "topK":{"shape":"TopK"}, - "additionalParams":{"shape":"Document"} - } - }, - "HarnessId":{ - "type":"string", - "pattern":"[a-zA-Z][a-zA-Z0-9_]{0,39}-[a-zA-Z0-9]{10}" - }, - "HarnessInlineFunctionConfig":{ - "type":"structure", - "required":[ - "description", - "inputSchema" - ], - "members":{ - "description":{"shape":"HarnessInlineFunctionDescription"}, - "inputSchema":{"shape":"SensitiveJson"} - } - }, - "HarnessInlineFunctionDescription":{ - "type":"string", - "max":4096, - "min":1, - "sensitive":true - }, - "HarnessLiteLlmApiBase":{ - "type":"string", - "max":16383, - "min":1, - "sensitive":true - }, - "HarnessLiteLlmModelConfig":{ - "type":"structure", - "required":["modelId"], - "members":{ - "modelId":{"shape":"ModelId"}, - "apiKeyArn":{"shape":"ApiKeyArn"}, - "apiBase":{"shape":"HarnessLiteLlmApiBase"}, - "maxTokens":{"shape":"MaxTokens"}, - "temperature":{"shape":"Temperature"}, - "topP":{"shape":"TopP"}, - "additionalParams":{"shape":"Document"} - } - }, - "HarnessManagedMemoryConfiguration":{ - "type":"structure", - "members":{ - "arn":{"shape":"MemoryArn"}, - "strategies":{"shape":"HarnessManagedMemoryStrategyList"}, - "eventExpiryDuration":{"shape":"HarnessManagedMemoryConfigurationEventExpiryDurationInteger"}, - "encryptionKeyArn":{"shape":"KmsKeyArn"} - } - }, - "HarnessManagedMemoryConfigurationEventExpiryDurationInteger":{ - "type":"integer", - "box":true, - "max":365, - "min":3 - }, - "HarnessManagedMemoryStrategyList":{ - "type":"list", - "member":{"shape":"HarnessManagedMemoryStrategyType"}, - "max":4, - "min":1 - }, - "HarnessManagedMemoryStrategyType":{ - "type":"string", - "enum":[ - "SEMANTIC", - "SUMMARIZATION", - "USER_PREFERENCE", - "EPISODIC" - ] - }, - "HarnessMemoryConfiguration":{ - "type":"structure", - "members":{ - "agentCoreMemoryConfiguration":{"shape":"HarnessAgentCoreMemoryConfiguration"}, - "managedMemoryConfiguration":{"shape":"HarnessManagedMemoryConfiguration"}, - "disabled":{"shape":"HarnessDisabledMemoryConfiguration"} - }, - "union":true - }, - "HarnessModelConfiguration":{ - "type":"structure", - "members":{ - "bedrockModelConfig":{"shape":"HarnessBedrockModelConfig"}, - "openAiModelConfig":{"shape":"HarnessOpenAiModelConfig"}, - "geminiModelConfig":{"shape":"HarnessGeminiModelConfig"}, - "liteLlmModelConfig":{"shape":"HarnessLiteLlmModelConfig"} - }, - "union":true - }, - "HarnessName":{ - "type":"string", - "pattern":"[a-zA-Z][a-zA-Z0-9_]{0,39}" - }, - "HarnessOpenAiApiFormat":{ - "type":"string", - "enum":[ - "chat_completions", - "responses" - ] - }, - "HarnessOpenAiModelConfig":{ - "type":"structure", - "required":[ - "modelId", - "apiKeyArn" - ], - "members":{ - "modelId":{"shape":"ModelId"}, - "apiKeyArn":{"shape":"ApiKeyArn"}, - "maxTokens":{"shape":"MaxTokens"}, - "temperature":{"shape":"Temperature"}, - "topP":{"shape":"TopP"}, - "apiFormat":{"shape":"HarnessOpenAiApiFormat"}, - "additionalParams":{"shape":"Document"} - } - }, - "HarnessRemoteMcpConfig":{ - "type":"structure", - "required":["url"], - "members":{ - "url":{"shape":"HarnessRemoteMcpUrl"}, - "headers":{"shape":"HttpHeadersMap"} - } - }, - "HarnessRemoteMcpUrl":{ - "type":"string", - "max":16383, - "min":1, - "sensitive":true - }, - "HarnessSkill":{ - "type":"structure", - "members":{ - "path":{"shape":"HarnessSkillPath"}, - "s3":{"shape":"HarnessSkillS3Source"}, - "git":{"shape":"HarnessSkillGitSource"}, - "awsSkills":{"shape":"HarnessSkillAwsSkillsSource"} - }, - "union":true - }, - "HarnessSkillAwsSkillsSource":{ - "type":"structure", - "members":{ - "paths":{"shape":"HarnessAwsSkillPaths"} - } - }, - "HarnessSkillGitAuth":{ - "type":"structure", - "required":["credentialArn"], - "members":{ - "credentialArn":{"shape":"ApiKeyArn"}, - "username":{"shape":"String"} - } - }, - "HarnessSkillGitSource":{ - "type":"structure", - "required":["url"], - "members":{ - "url":{"shape":"HarnessSkillGitUrl"}, - "path":{"shape":"String"}, - "auth":{"shape":"HarnessSkillGitAuth"} - } - }, - "HarnessSkillGitUrl":{ - "type":"string", - "max":16383, - "min":8, - "pattern":"https://[^#@]+" - }, - "HarnessSkillPath":{ - "type":"string", - "max":4096, - "min":1 - }, - "HarnessSkillS3Source":{ - "type":"structure", - "required":["uri"], - "members":{ - "uri":{"shape":"HarnessSkillS3Uri"} - } - }, - "HarnessSkillS3Uri":{ - "type":"string", - "max":16383, - "min":5, - "pattern":"s3://.*" - }, - "HarnessSkills":{ - "type":"list", - "member":{"shape":"HarnessSkill"} - }, - "HarnessSlidingWindowConfiguration":{ - "type":"structure", - "members":{ - "messagesCount":{"shape":"Integer"} - } - }, - "HarnessStatus":{ - "type":"string", - "enum":[ - "CREATING", - "CREATE_FAILED", - "UPDATING", - "UPDATE_FAILED", - "READY", - "DELETING", - "DELETE_FAILED" - ] - }, - "HarnessSummaries":{ - "type":"list", - "member":{"shape":"HarnessSummary"} - }, - "HarnessSummarizationConfiguration":{ - "type":"structure", - "members":{ - "summaryRatio":{"shape":"Float"}, - "preserveRecentMessages":{"shape":"Integer"}, - "summarizationSystemPrompt":{"shape":"String"} - } - }, - "HarnessSummary":{ - "type":"structure", - "required":[ - "harnessId", - "harnessName", - "arn", - "status", - "createdAt", - "updatedAt" - ], - "members":{ - "harnessId":{"shape":"HarnessId"}, - "harnessName":{"shape":"HarnessName"}, - "arn":{"shape":"HarnessArn"}, - "status":{"shape":"HarnessStatus"}, - "createdAt":{"shape":"DateTimestamp"}, - "updatedAt":{"shape":"DateTimestamp"}, - "harnessVersion":{"shape":"HarnessVersion"} - } - }, - "HarnessSystemContentBlock":{ - "type":"structure", - "members":{ - "text":{"shape":"SensitiveText"} - }, - "union":true - }, - "HarnessSystemPrompt":{ - "type":"list", - "member":{"shape":"HarnessSystemContentBlock"} - }, - "HarnessTool":{ - "type":"structure", - "required":["type"], - "members":{ - "type":{"shape":"HarnessToolType"}, - "name":{"shape":"HarnessToolName"}, - "config":{"shape":"HarnessToolConfiguration"} - } - }, - "HarnessToolConfiguration":{ - "type":"structure", - "members":{ - "remoteMcp":{"shape":"HarnessRemoteMcpConfig"}, - "agentCoreBrowser":{"shape":"HarnessAgentCoreBrowserConfig"}, - "agentCoreGateway":{"shape":"HarnessAgentCoreGatewayConfig"}, - "inlineFunction":{"shape":"HarnessInlineFunctionConfig"}, - "agentCoreCodeInterpreter":{"shape":"HarnessAgentCoreCodeInterpreterConfig"} - }, - "union":true - }, - "HarnessToolName":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[a-zA-Z0-9_-]+" - }, - "HarnessToolType":{ - "type":"string", - "enum":[ - "remote_mcp", - "agentcore_browser", - "agentcore_gateway", - "inline_function", - "agentcore_code_interpreter" - ] - }, - "HarnessTools":{ - "type":"list", - "member":{"shape":"HarnessTool"} - }, - "HarnessTruncationConfiguration":{ - "type":"structure", - "required":["strategy"], - "members":{ - "strategy":{"shape":"HarnessTruncationStrategy"}, - "config":{"shape":"HarnessTruncationStrategyConfiguration"} - } - }, - "HarnessTruncationStrategy":{ - "type":"string", - "enum":[ - "sliding_window", - "summarization", - "none" - ] - }, - "HarnessTruncationStrategyConfiguration":{ - "type":"structure", - "members":{ - "slidingWindow":{"shape":"HarnessSlidingWindowConfiguration"}, - "summarization":{"shape":"HarnessSummarizationConfiguration"} - }, - "union":true - }, - "HarnessVersion":{ - "type":"string", - "max":5, - "min":1, - "pattern":"([1-9][0-9]{0,4})" - }, - "HarnessVersionSummaries":{ - "type":"list", - "member":{"shape":"HarnessVersionSummary"} - }, - "HarnessVersionSummary":{ - "type":"structure", - "required":[ - "harnessId", - "harnessName", - "arn", - "harnessVersion", - "status", - "createdAt", - "updatedAt" - ], - "members":{ - "harnessId":{"shape":"HarnessId"}, - "harnessName":{"shape":"HarnessName"}, - "arn":{"shape":"HarnessArn"}, - "harnessVersion":{"shape":"HarnessVersion"}, - "status":{"shape":"HarnessStatus"}, - "createdAt":{"shape":"DateTimestamp"}, - "updatedAt":{"shape":"DateTimestamp"}, - "failureReason":{"shape":"String"} - } - }, - "HeaderName":{ - "type":"string", - "max":256, - "min":1, - "pattern":"[A-Za-z][A-Za-z0-9_-]{0,255}" - }, - "HostingEnvironment":{ - "type":"structure", - "required":["arn"], - "members":{ - "arn":{"shape":"BedrockAgentcoreResourceArn"} - } - }, - "HostingEnvironmentListType":{ - "type":"list", - "member":{"shape":"HostingEnvironment"}, - "max":10, - "min":1 - }, - "HttpApiSchemaConfiguration":{ - "type":"structure", - "required":["source"], - "members":{ - "source":{"shape":"ApiSchemaConfiguration"} - } - }, - "HttpHeaderKey":{ - "type":"string", - "max":16383, - "min":1 - }, - "HttpHeaderName":{ - "type":"string", - "max":100, - "min":1 - }, - "HttpHeaderValue":{ - "type":"string", - "max":16383, - "min":1 - }, - "HttpHeadersMap":{ - "type":"map", - "key":{"shape":"HttpHeaderKey"}, - "value":{"shape":"HttpHeaderValue"}, - "sensitive":true - }, - "HttpQueryParameterName":{ - "type":"string", - "max":40, - "min":1 - }, - "HttpTargetConfiguration":{ - "type":"structure", - "members":{ - "agentcoreRuntime":{"shape":"RuntimeTargetConfiguration"}, - "passthrough":{"shape":"PassthroughTargetConfiguration"} - }, - "union":true - }, - "IamCredentialProvider":{ - "type":"structure", - "required":["service"], - "members":{ - "service":{"shape":"IamCredentialProviderServiceString"}, - "region":{"shape":"IamCredentialProviderRegionString"} - } - }, - "IamCredentialProviderRegionString":{ - "type":"string", - "max":32, - "min":1, - "pattern":"[a-zA-Z0-9-]+" - }, - "IamCredentialProviderServiceString":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[a-zA-Z0-9._-]+" - }, - "IamPrincipal":{ - "type":"structure", - "required":["arn"], - "members":{ - "arn":{"shape":"IamPrincipalArn"}, - "operator":{"shape":"PrincipalMatchOperator"} - } - }, - "IamPrincipalArn":{ - "type":"string", - "max":2048, - "min":0, - "pattern":"(arn:aws[a-zA-Z-]*:iam::(\\d{12}|\\*):(user|role)/[\\w+=,.@*?/-]+|arn:aws[a-zA-Z-]*:sts::(\\d{12}|\\*):assumed-role/[\\w+=,.@*?/-]+)" - }, - "IamRoleArn":{ - "type":"string", - "max":2048, - "min":20, - "pattern":"arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+" - }, - "IamSigningRegion":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[a-z0-9-]+" - }, - "IamSigningServiceName":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[a-zA-Z0-9_-]+" - }, - "InboundTokenClaimNameType":{ - "type":"string", - "max":255, - "min":1, - "pattern":"[A-Za-z0-9_.-:]+" - }, - "InboundTokenClaimValueType":{ - "type":"string", - "enum":[ - "STRING", - "STRING_ARRAY" - ] - }, - "IncludedData":{ - "type":"string", - "enum":[ - "ALL_DATA", - "METADATA_ONLY" - ] - }, - "IncludedOauth2ProviderConfigInput":{ - "type":"structure", - "required":["clientId"], - "members":{ - "clientId":{"shape":"ClientIdType"}, - "clientSecret":{"shape":"DefaultClientSecretType"}, - "clientSecretConfig":{"shape":"SecretReference"}, - "clientSecretSource":{"shape":"SecretSourceType"}, - "issuer":{"shape":"IssuerUrlType"}, - "authorizationEndpoint":{"shape":"AuthorizationEndpointType"}, - "tokenEndpoint":{"shape":"TokenEndpointType"} - } - }, - "IncludedOauth2ProviderConfigOutput":{ - "type":"structure", - "required":["oauthDiscovery"], - "members":{ - "oauthDiscovery":{"shape":"Oauth2Discovery"}, - "clientId":{"shape":"ClientIdType"} - } - }, - "IndexedKey":{ - "type":"structure", - "required":[ - "key", - "type" - ], - "members":{ - "key":{"shape":"MetadataKey"}, - "type":{"shape":"MetadataValueType"} - } - }, - "IndexedKeysList":{ - "type":"list", - "member":{"shape":"IndexedKey"}, - "max":10, - "min":1 - }, - "InferenceConfiguration":{ - "type":"structure", - "members":{ - "maxTokens":{"shape":"InferenceConfigurationMaxTokensInteger"}, - "temperature":{"shape":"InferenceConfigurationTemperatureFloat"}, - "topP":{"shape":"InferenceConfigurationTopPFloat"}, - "stopSequences":{"shape":"InferenceConfigurationStopSequencesList"} - } - }, - "InferenceConfigurationMaxTokensInteger":{ - "type":"integer", - "box":true, - "min":1 - }, - "InferenceConfigurationStopSequencesList":{ - "type":"list", - "member":{"shape":"NonEmptyString"}, - "max":2500, - "min":0 - }, - "InferenceConfigurationTemperatureFloat":{ - "type":"float", - "box":true, - "max":1, - "min":0 - }, - "InferenceConfigurationTopPFloat":{ - "type":"float", - "box":true, - "max":1, - "min":0 - }, - "InferenceConnectorId":{ - "type":"string", - "max":256, - "min":1 - }, - "InferenceConnectorSource":{ - "type":"structure", - "required":["connectorId"], - "members":{ - "connectorId":{"shape":"InferenceConnectorId"} - } - }, - "InferenceConnectorTargetConfiguration":{ - "type":"structure", - "required":["source"], - "members":{ - "source":{"shape":"InferenceConnectorSource"} - } - }, - "InferenceOperationConfiguration":{ - "type":"structure", - "required":["path"], - "members":{ - "path":{"shape":"InferenceOperationPath"}, - "providerPath":{"shape":"InferenceOperationPath"}, - "models":{"shape":"ModelEntries"} - } - }, - "InferenceOperationConfigurations":{ - "type":"list", - "member":{"shape":"InferenceOperationConfiguration"}, - "max":10, - "min":1 - }, - "InferenceOperationPath":{ - "type":"string", - "max":256, - "min":1, - "pattern":"/[a-zA-Z0-9\\-\\._/]+" - }, - "InferenceProviderTargetConfiguration":{ - "type":"structure", - "required":["endpoint"], - "members":{ - "endpoint":{"shape":"PassthroughEndpoint"}, - "modelMapping":{"shape":"ModelMapping"}, - "operations":{"shape":"InferenceOperationConfigurations"} - } - }, - "InferenceTargetConfiguration":{ - "type":"structure", - "members":{ - "connector":{"shape":"InferenceConnectorTargetConfiguration"}, - "provider":{"shape":"InferenceProviderTargetConfiguration"} - }, - "union":true - }, - "InlineContent":{ - "type":"string", - "max":102400, - "min":1 - }, - "InlineExamplesSource":{ - "type":"structure", - "required":["examples"], - "members":{ - "examples":{"shape":"InlineExamplesSourceExamplesList"} - } - }, - "InlineExamplesSourceExamplesList":{ - "type":"list", - "member":{"shape":"SensitiveJson"}, - "max":1000, - "min":1 - }, - "InlinePayload":{ - "type":"string", - "sensitive":true - }, - "Insight":{ - "type":"structure", - "required":["insightId"], - "members":{ - "insightId":{"shape":"InsightId"} - } - }, - "InsightId":{ - "type":"string", - "pattern":"(Builtin\\.[a-zA-Z0-9._-]+|[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10})" - }, - "InsightList":{ - "type":"list", - "member":{"shape":"Insight"}, - "max":10, - "min":0 - }, - "Integer":{ - "type":"integer", - "box":true - }, - "InterceptorConfiguration":{ - "type":"structure", - "members":{ - "lambda":{"shape":"LambdaInterceptorConfiguration"} - }, - "union":true - }, - "InterceptorInputConfiguration":{ - "type":"structure", - "required":["passRequestHeaders"], - "members":{ - "passRequestHeaders":{"shape":"Boolean"}, - "payloadFilter":{"shape":"InterceptorPayloadFilter"} - } - }, - "InterceptorPayloadExclusion":{ - "type":"string", - "enum":["RESPONSE_BODY"] - }, - "InterceptorPayloadExclusionSelector":{ - "type":"structure", - "members":{ - "field":{"shape":"InterceptorPayloadExclusion"} - }, - "union":true - }, - "InterceptorPayloadExclusionSelectorList":{ - "type":"list", - "member":{"shape":"InterceptorPayloadExclusionSelector"}, - "max":1, - "min":1 - }, - "InterceptorPayloadFilter":{ - "type":"structure", - "required":["exclude"], - "members":{ - "exclude":{"shape":"InterceptorPayloadExclusionSelectorList"} - } - }, - "InternalServerException":{ - "type":"structure", - "members":{ - "message":{"shape":"NonBlankString"} - }, - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true - }, - "InvocationConfiguration":{ - "type":"structure", - "required":[ - "topicArn", - "payloadDeliveryBucketName" - ], - "members":{ - "topicArn":{"shape":"Arn"}, - "payloadDeliveryBucketName":{"shape":"String"} - } - }, - "InvocationConfigurationInput":{ - "type":"structure", - "required":[ - "topicArn", - "payloadDeliveryBucketName" - ], - "members":{ - "topicArn":{"shape":"Arn"}, - "payloadDeliveryBucketName":{"shape":"InvocationConfigurationInputPayloadDeliveryBucketNameString"} - } - }, - "InvocationConfigurationInputPayloadDeliveryBucketNameString":{ - "type":"string", - "pattern":"[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]" - }, - "IssuerUrlType":{"type":"string"}, - "KeyType":{ - "type":"string", - "enum":[ - "CustomerManagedKey", - "ServiceManagedKey" - ] - }, - "KinesisResource":{ - "type":"structure", - "required":[ - "dataStreamArn", - "contentConfigurations" - ], - "members":{ - "dataStreamArn":{"shape":"Arn"}, - "contentConfigurations":{"shape":"KinesisResourceContentConfigurationsList"} - } - }, - "KinesisResourceContentConfigurationsList":{ - "type":"list", - "member":{"shape":"ContentConfiguration"}, - "max":1, - "min":1 - }, - "KmsConfiguration":{ - "type":"structure", - "required":["keyType"], - "members":{ - "keyType":{"shape":"KeyType"}, - "kmsKeyArn":{"shape":"KmsKeyArn"} - } - }, - "KmsKeyArn":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}" - }, - "KmsKeySourceType":{ - "type":"structure", - "required":["kmsKeyArn"], - "members":{ - "kmsKeyArn":{"shape":"KmsKeyArn"} - } - }, - "LambdaArn":{ - "type":"string", - "pattern":"arn:(aws[a-zA-Z-]*)?:lambda:([a-z]{2}(-gov)?-[a-z]+-\\d{1}):(\\d{12}):function:([a-zA-Z0-9-_.]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?" - }, - "LambdaEvaluatorConfig":{ - "type":"structure", - "required":["lambdaArn"], - "members":{ - "lambdaArn":{"shape":"LambdaArn"}, - "lambdaTimeoutInSeconds":{"shape":"LambdaEvaluatorConfigLambdaTimeoutInSecondsInteger"} - } - }, - "LambdaEvaluatorConfigLambdaTimeoutInSecondsInteger":{ - "type":"integer", - "box":true, - "max":300, - "min":1 - }, - "LambdaFunctionArn":{ - "type":"string", - "max":170, - "min":1, - "pattern":"arn:(aws[a-zA-Z-]*)?:lambda:([a-z]{2}(-gov)?-[a-z]+-\\d{1}):(\\d{12}):function:([a-zA-Z0-9-_.]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?" - }, - "LambdaInterceptorConfiguration":{ - "type":"structure", - "required":["arn"], - "members":{ - "arn":{"shape":"LambdaFunctionArn"} - } - }, - "LambdaTransformConfiguration":{ - "type":"structure", - "members":{ - "arn":{"shape":"LambdaFunctionArn"} - } - }, - "LifecycleConfiguration":{ - "type":"structure", - "members":{ - "idleRuntimeSessionTimeout":{"shape":"LifecycleConfigurationIdleRuntimeSessionTimeoutInteger"}, - "maxLifetime":{"shape":"LifecycleConfigurationMaxLifetimeInteger"} - } - }, - "LifecycleConfigurationIdleRuntimeSessionTimeoutInteger":{ - "type":"integer", - "box":true, - "max":28800, - "min":60 - }, - "LifecycleConfigurationMaxLifetimeInteger":{ - "type":"integer", - "box":true, - "max":28800, - "min":60 - }, - "LinkedinOauth2ProviderConfigInput":{ - "type":"structure", - "required":["clientId"], - "members":{ - "clientId":{"shape":"ClientIdType"}, - "clientSecret":{"shape":"DefaultClientSecretType"}, - "clientSecretConfig":{"shape":"SecretReference"}, - "clientSecretSource":{"shape":"SecretSourceType"} - } - }, - "LinkedinOauth2ProviderConfigOutput":{ - "type":"structure", - "required":["oauthDiscovery"], - "members":{ - "oauthDiscovery":{"shape":"Oauth2Discovery"}, - "clientId":{"shape":"ClientIdType"} - } - }, - "ListAgentRuntimeEndpointsRequest":{ - "type":"structure", - "required":["agentRuntimeId"], - "members":{ - "agentRuntimeId":{ - "shape":"AgentRuntimeId", - "location":"uri", - "locationName":"agentRuntimeId" - }, - "maxResults":{ - "shape":"MaxResults", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"NextToken", - "location":"querystring", - "locationName":"nextToken" - } - } - }, - "ListAgentRuntimeEndpointsResponse":{ - "type":"structure", - "required":["runtimeEndpoints"], - "members":{ - "runtimeEndpoints":{"shape":"AgentRuntimeEndpoints"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListAgentRuntimeVersionsRequest":{ - "type":"structure", - "required":["agentRuntimeId"], - "members":{ - "agentRuntimeId":{ - "shape":"AgentRuntimeId", - "location":"uri", - "locationName":"agentRuntimeId" - }, - "maxResults":{ - "shape":"MaxResults", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"NextToken", - "location":"querystring", - "locationName":"nextToken" - } - } - }, - "ListAgentRuntimeVersionsResponse":{ - "type":"structure", - "required":["agentRuntimes"], - "members":{ - "agentRuntimes":{"shape":"AgentRuntimes"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListAgentRuntimesRequest":{ - "type":"structure", - "members":{ - "maxResults":{ - "shape":"MaxResults", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"NextToken", - "location":"querystring", - "locationName":"nextToken" - } - } - }, - "ListAgentRuntimesResponse":{ - "type":"structure", - "required":["agentRuntimes"], - "members":{ - "agentRuntimes":{"shape":"AgentRuntimes"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListApiKeyCredentialProvidersRequest":{ - "type":"structure", - "members":{ - "nextToken":{"shape":"String"}, - "maxResults":{"shape":"MaxResults"} - } - }, - "ListApiKeyCredentialProvidersResponse":{ - "type":"structure", - "required":["credentialProviders"], - "members":{ - "credentialProviders":{"shape":"ApiKeyCredentialProviders"}, - "nextToken":{"shape":"String"} - } - }, - "ListBrowserProfilesRequest":{ - "type":"structure", - "members":{ - "maxResults":{ - "shape":"MaxResults", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"NextToken", - "location":"querystring", - "locationName":"nextToken" - }, - "name":{"shape":"BrowserProfileName"} - } - }, - "ListBrowserProfilesResponse":{ - "type":"structure", - "required":["profileSummaries"], - "members":{ - "profileSummaries":{"shape":"BrowserProfileSummaries"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListBrowsersRequest":{ - "type":"structure", - "members":{ - "maxResults":{ - "shape":"MaxResults", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"NextToken", - "location":"querystring", - "locationName":"nextToken" - }, - "type":{ - "shape":"ResourceType", - "location":"querystring", - "locationName":"type" - } - } - }, - "ListBrowsersResponse":{ - "type":"structure", - "required":["browserSummaries"], - "members":{ - "browserSummaries":{"shape":"BrowserSummaries"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListCodeInterpretersRequest":{ - "type":"structure", - "members":{ - "maxResults":{ - "shape":"MaxResults", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"NextToken", - "location":"querystring", - "locationName":"nextToken" - }, - "type":{ - "shape":"ResourceType", - "location":"querystring", - "locationName":"type" - } - } - }, - "ListCodeInterpretersResponse":{ - "type":"structure", - "required":["codeInterpreterSummaries"], - "members":{ - "codeInterpreterSummaries":{"shape":"CodeInterpreterSummaries"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListConfigurationBundleVersionsRequest":{ - "type":"structure", - "required":["bundleId"], - "members":{ - "bundleId":{ - "shape":"ConfigurationBundleId", - "location":"uri", - "locationName":"bundleId" - }, - "nextToken":{ - "shape":"String", - "location":"querystring", - "locationName":"nextToken" - }, - "maxResults":{ - "shape":"ListConfigurationBundleVersionsRequestMaxResultsInteger", - "location":"querystring", - "locationName":"maxResults" - }, - "filter":{"shape":"VersionFilter"} - } - }, - "ListConfigurationBundleVersionsRequestMaxResultsInteger":{ - "type":"integer", - "box":true, - "max":100, - "min":1 - }, - "ListConfigurationBundleVersionsResponse":{ - "type":"structure", - "required":["versions"], - "members":{ - "versions":{"shape":"ConfigurationBundleVersionSummaryList"}, - "nextToken":{"shape":"String"} - } - }, - "ListConfigurationBundlesRequest":{ - "type":"structure", - "members":{ - "nextToken":{ - "shape":"String", - "location":"querystring", - "locationName":"nextToken" - }, - "maxResults":{ - "shape":"ListConfigurationBundlesRequestMaxResultsInteger", - "location":"querystring", - "locationName":"maxResults" - } - } - }, - "ListConfigurationBundlesRequestMaxResultsInteger":{ - "type":"integer", - "box":true, - "max":100, - "min":1 - }, - "ListConfigurationBundlesResponse":{ - "type":"structure", - "required":["bundles"], - "members":{ - "bundles":{"shape":"ConfigurationBundleSummaryList"}, - "nextToken":{"shape":"String"} - } - }, - "ListDatasetExamplesRequest":{ - "type":"structure", - "required":["datasetId"], - "members":{ - "datasetId":{ - "shape":"DatasetId", - "location":"uri", - "locationName":"datasetId" - }, - "datasetVersion":{ - "shape":"DatasetVersion", - "location":"querystring", - "locationName":"datasetVersion" - }, - "maxResults":{ - "shape":"ListDatasetExamplesRequestMaxResultsInteger", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"ListDatasetExamplesRequestNextTokenString", - "location":"querystring", - "locationName":"nextToken" - } - } - }, - "ListDatasetExamplesRequestMaxResultsInteger":{ - "type":"integer", - "box":true, - "max":1000, - "min":1 - }, - "ListDatasetExamplesRequestNextTokenString":{ - "type":"string", - "max":2048, - "min":0 - }, - "ListDatasetExamplesResponse":{ - "type":"structure", - "required":[ - "datasetArn", - "datasetId", - "datasetVersion", - "examples" - ], - "members":{ - "datasetArn":{"shape":"DatasetArn"}, - "datasetId":{"shape":"DatasetId"}, - "datasetVersion":{"shape":"DatasetVersion"}, - "examples":{"shape":"DatasetExampleList"}, - "nextToken":{"shape":"String"} - } - }, - "ListDatasetVersionsRequest":{ - "type":"structure", - "required":["datasetId"], - "members":{ - "datasetId":{ - "shape":"DatasetId", - "location":"uri", - "locationName":"datasetId" - }, - "nextToken":{ - "shape":"String", - "location":"querystring", - "locationName":"nextToken" - }, - "maxResults":{ - "shape":"ListDatasetVersionsRequestMaxResultsInteger", - "location":"querystring", - "locationName":"maxResults" - } - } - }, - "ListDatasetVersionsRequestMaxResultsInteger":{ - "type":"integer", - "box":true, - "max":100, - "min":1 - }, - "ListDatasetVersionsResponse":{ - "type":"structure", - "required":["versions"], - "members":{ - "versions":{"shape":"DatasetVersionSummaryList"}, - "nextToken":{"shape":"String"} - } - }, - "ListDatasetsRequest":{ - "type":"structure", - "members":{ - "nextToken":{ - "shape":"ListDatasetsRequestNextTokenString", - "location":"querystring", - "locationName":"nextToken" - }, - "maxResults":{ - "shape":"ListDatasetsRequestMaxResultsInteger", - "location":"querystring", - "locationName":"maxResults" - } - } - }, - "ListDatasetsRequestMaxResultsInteger":{ - "type":"integer", - "box":true, - "max":100, - "min":1 - }, - "ListDatasetsRequestNextTokenString":{ - "type":"string", - "max":2048, - "min":0 - }, - "ListDatasetsResponse":{ - "type":"structure", - "required":["datasets"], - "members":{ - "datasets":{"shape":"DatasetSummaryList"}, - "nextToken":{"shape":"String"} - } - }, - "ListEvaluatorsRequest":{ - "type":"structure", - "members":{ - "nextToken":{ - "shape":"String", - "location":"querystring", - "locationName":"nextToken" - }, - "maxResults":{ - "shape":"ListEvaluatorsRequestMaxResultsInteger", - "location":"querystring", - "locationName":"maxResults" - } - } - }, - "ListEvaluatorsRequestMaxResultsInteger":{ - "type":"integer", - "box":true, - "max":100, - "min":1 - }, - "ListEvaluatorsResponse":{ - "type":"structure", - "required":["evaluators"], - "members":{ - "evaluators":{"shape":"EvaluatorSummaryList"}, - "nextToken":{"shape":"String"} - } - }, - "ListGatewayRulesRequest":{ - "type":"structure", - "required":["gatewayIdentifier"], - "members":{ - "gatewayIdentifier":{ - "shape":"GatewayIdentifier", - "location":"uri", - "locationName":"gatewayIdentifier" - }, - "maxResults":{ - "shape":"GatewayRuleMaxResults", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"GatewayRuleNextToken", - "location":"querystring", - "locationName":"nextToken" - } - } - }, - "ListGatewayRulesResponse":{ - "type":"structure", - "required":["gatewayRules"], - "members":{ - "gatewayRules":{"shape":"GatewayRules"}, - "nextToken":{"shape":"GatewayRuleNextToken"} - } - }, - "ListGatewayTargetsRequest":{ - "type":"structure", - "required":["gatewayIdentifier"], - "members":{ - "gatewayIdentifier":{ - "shape":"GatewayIdentifier", - "location":"uri", - "locationName":"gatewayIdentifier" - }, - "maxResults":{ - "shape":"TargetMaxResults", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"TargetNextToken", - "location":"querystring", - "locationName":"nextToken" - } - } - }, - "ListGatewayTargetsResponse":{ - "type":"structure", - "required":["items"], - "members":{ - "items":{"shape":"TargetSummaries"}, - "nextToken":{"shape":"TargetNextToken"} - } - }, - "ListGatewaysRequest":{ - "type":"structure", - "members":{ - "maxResults":{ - "shape":"GatewayMaxResults", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"GatewayNextToken", - "location":"querystring", - "locationName":"nextToken" - } - } - }, - "ListGatewaysResponse":{ - "type":"structure", - "required":["items"], - "members":{ - "items":{"shape":"GatewaySummaries"}, - "nextToken":{"shape":"GatewayNextToken"} - } - }, - "ListHarnessEndpointsRequest":{ - "type":"structure", - "required":["harnessId"], - "members":{ - "harnessId":{ - "shape":"HarnessId", - "location":"uri", - "locationName":"harnessId" - }, - "maxResults":{ - "shape":"MaxResults", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"NextToken", - "location":"querystring", - "locationName":"nextToken" - } - } - }, - "ListHarnessEndpointsResponse":{ - "type":"structure", - "required":["endpoints"], - "members":{ - "endpoints":{"shape":"HarnessEndpoints"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListHarnessVersionsRequest":{ - "type":"structure", - "required":["harnessId"], - "members":{ - "harnessId":{ - "shape":"HarnessId", - "location":"uri", - "locationName":"harnessId" - }, - "maxResults":{ - "shape":"MaxResults", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"NextToken", - "location":"querystring", - "locationName":"nextToken" - } - } - }, - "ListHarnessVersionsResponse":{ - "type":"structure", - "required":["harnessVersions"], - "members":{ - "harnessVersions":{"shape":"HarnessVersionSummaries"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListHarnessesRequest":{ - "type":"structure", - "members":{ - "maxResults":{ - "shape":"MaxResults", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"NextToken", - "location":"querystring", - "locationName":"nextToken" - } - } - }, - "ListHarnessesResponse":{ - "type":"structure", - "required":["harnesses"], - "members":{ - "harnesses":{"shape":"HarnessSummaries"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListMemoriesInput":{ - "type":"structure", - "members":{ - "maxResults":{"shape":"ListMemoriesInputMaxResultsInteger"}, - "nextToken":{"shape":"String"} - } - }, - "ListMemoriesInputMaxResultsInteger":{ - "type":"integer", - "box":true, - "max":100, - "min":1 - }, - "ListMemoriesOutput":{ - "type":"structure", - "required":["memories"], - "members":{ - "memories":{"shape":"MemorySummaryList"}, - "nextToken":{"shape":"String"} - } - }, - "ListOauth2CredentialProvidersRequest":{ - "type":"structure", - "members":{ - "nextToken":{"shape":"String"}, - "maxResults":{"shape":"ListOauth2CredentialProvidersRequestMaxResultsInteger"} - } - }, - "ListOauth2CredentialProvidersRequestMaxResultsInteger":{ - "type":"integer", - "box":true, - "max":20, - "min":1 - }, - "ListOauth2CredentialProvidersResponse":{ - "type":"structure", - "required":["credentialProviders"], - "members":{ - "credentialProviders":{"shape":"Oauth2CredentialProviders"}, - "nextToken":{"shape":"String"} - } - }, - "ListOnlineEvaluationConfigsRequest":{ - "type":"structure", - "members":{ - "nextToken":{ - "shape":"String", - "location":"querystring", - "locationName":"nextToken" - }, - "maxResults":{ - "shape":"ListOnlineEvaluationConfigsRequestMaxResultsInteger", - "location":"querystring", - "locationName":"maxResults" - } - } - }, - "ListOnlineEvaluationConfigsRequestMaxResultsInteger":{ - "type":"integer", - "box":true, - "max":100, - "min":1 - }, - "ListOnlineEvaluationConfigsResponse":{ - "type":"structure", - "required":["onlineEvaluationConfigs"], - "members":{ - "onlineEvaluationConfigs":{"shape":"OnlineEvaluationConfigSummaryList"}, - "nextToken":{"shape":"String"} - } - }, - "ListPaymentConnectorsRequest":{ - "type":"structure", - "required":["paymentManagerId"], - "members":{ - "paymentManagerId":{ - "shape":"PaymentManagerId", - "location":"uri", - "locationName":"paymentManagerId" - }, - "maxResults":{ - "shape":"MaxResults", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"NextToken", - "location":"querystring", - "locationName":"nextToken" - } - } - }, - "ListPaymentConnectorsResponse":{ - "type":"structure", - "required":["paymentConnectors"], - "members":{ - "paymentConnectors":{"shape":"PaymentConnectorSummaries"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListPaymentCredentialProvidersRequest":{ - "type":"structure", - "members":{ - "nextToken":{"shape":"String"}, - "maxResults":{"shape":"ListPaymentCredentialProvidersRequestMaxResultsInteger"} - } - }, - "ListPaymentCredentialProvidersRequestMaxResultsInteger":{ - "type":"integer", - "box":true, - "max":20, - "min":1 - }, - "ListPaymentCredentialProvidersResponse":{ - "type":"structure", - "required":["credentialProviders"], - "members":{ - "credentialProviders":{"shape":"PaymentCredentialProviders"}, - "nextToken":{"shape":"String"} - } - }, - "ListPaymentManagersRequest":{ - "type":"structure", - "members":{ - "maxResults":{ - "shape":"MaxResults", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"NextToken", - "location":"querystring", - "locationName":"nextToken" - } - } - }, - "ListPaymentManagersResponse":{ - "type":"structure", - "required":["paymentManagers"], - "members":{ - "paymentManagers":{"shape":"PaymentManagerSummaries"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListPoliciesRequest":{ - "type":"structure", - "required":["policyEngineId"], - "members":{ - "nextToken":{ - "shape":"NextToken", - "location":"querystring", - "locationName":"nextToken" - }, - "maxResults":{ - "shape":"MaxResults", - "location":"querystring", - "locationName":"maxResults" - }, - "policyEngineId":{ - "shape":"ResourceId", - "location":"uri", - "locationName":"policyEngineId" - }, - "targetResourceScope":{ - "shape":"BedrockAgentcoreResourceArn", - "location":"querystring", - "locationName":"targetResourceScope" - } - } - }, - "ListPoliciesResponse":{ - "type":"structure", - "required":["policies"], - "members":{ - "policies":{"shape":"Policies"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListPolicyEngineSummariesRequest":{ - "type":"structure", - "members":{ - "nextToken":{ - "shape":"NextToken", - "location":"querystring", - "locationName":"nextToken" - }, - "maxResults":{ - "shape":"MaxResults", - "location":"querystring", - "locationName":"maxResults" - } - } - }, - "ListPolicyEngineSummariesResponse":{ - "type":"structure", - "required":["policyEngines"], - "members":{ - "policyEngines":{"shape":"PolicyEngineSummaryList"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListPolicyEnginesRequest":{ - "type":"structure", - "members":{ - "nextToken":{ - "shape":"NextToken", - "location":"querystring", - "locationName":"nextToken" - }, - "maxResults":{ - "shape":"MaxResults", - "location":"querystring", - "locationName":"maxResults" - } - } - }, - "ListPolicyEnginesResponse":{ - "type":"structure", - "required":["policyEngines"], - "members":{ - "policyEngines":{"shape":"PolicyEngines"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListPolicyGenerationAssetsRequest":{ - "type":"structure", - "required":[ - "policyGenerationId", - "policyEngineId" - ], - "members":{ - "policyGenerationId":{ - "shape":"ResourceId", - "location":"uri", - "locationName":"policyGenerationId" - }, - "policyEngineId":{ - "shape":"ResourceId", - "location":"uri", - "locationName":"policyEngineId" - }, - "nextToken":{ - "shape":"NextToken", - "location":"querystring", - "locationName":"nextToken" - }, - "maxResults":{ - "shape":"MaxResults", - "location":"querystring", - "locationName":"maxResults" - } - } - }, - "ListPolicyGenerationAssetsResponse":{ - "type":"structure", - "members":{ - "policyGenerationAssets":{"shape":"PolicyGenerationAssets"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListPolicyGenerationSummariesRequest":{ - "type":"structure", - "required":["policyEngineId"], - "members":{ - "nextToken":{ - "shape":"NextToken", - "location":"querystring", - "locationName":"nextToken" - }, - "maxResults":{ - "shape":"MaxResults", - "location":"querystring", - "locationName":"maxResults" - }, - "policyEngineId":{ - "shape":"ResourceId", - "location":"uri", - "locationName":"policyEngineId" - } - } - }, - "ListPolicyGenerationSummariesResponse":{ - "type":"structure", - "required":["policyGenerations"], - "members":{ - "policyGenerations":{"shape":"PolicyGenerationSummaryList"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListPolicyGenerationsRequest":{ - "type":"structure", - "required":["policyEngineId"], - "members":{ - "nextToken":{ - "shape":"NextToken", - "location":"querystring", - "locationName":"nextToken" - }, - "maxResults":{ - "shape":"MaxResults", - "location":"querystring", - "locationName":"maxResults" - }, - "policyEngineId":{ - "shape":"ResourceId", - "location":"uri", - "locationName":"policyEngineId" - } - } - }, - "ListPolicyGenerationsResponse":{ - "type":"structure", - "required":["policyGenerations"], - "members":{ - "policyGenerations":{"shape":"PolicyGenerations"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListPolicySummariesRequest":{ - "type":"structure", - "required":["policyEngineId"], - "members":{ - "nextToken":{ - "shape":"NextToken", - "location":"querystring", - "locationName":"nextToken" - }, - "maxResults":{ - "shape":"MaxResults", - "location":"querystring", - "locationName":"maxResults" - }, - "policyEngineId":{ - "shape":"ResourceId", - "location":"uri", - "locationName":"policyEngineId" - }, - "targetResourceScope":{ - "shape":"BedrockAgentcoreResourceArn", - "location":"querystring", - "locationName":"targetResourceScope" - } - } - }, - "ListPolicySummariesResponse":{ - "type":"structure", - "required":["policies"], - "members":{ - "policies":{"shape":"PolicySummaryList"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListRegistriesRequest":{ - "type":"structure", - "members":{ - "maxResults":{ - "shape":"MaxResults", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"NextToken", - "location":"querystring", - "locationName":"nextToken" - }, - "status":{ - "shape":"RegistryStatus", - "location":"querystring", - "locationName":"status" - }, - "authorizerType":{ - "shape":"RegistryAuthorizerType", - "location":"querystring", - "locationName":"authorizerType" - } - } - }, - "ListRegistriesResponse":{ - "type":"structure", - "required":["registries"], - "members":{ - "registries":{"shape":"RegistrySummaryList"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListRegistryRecordsRequest":{ - "type":"structure", - "required":["registryId"], - "members":{ - "registryId":{ - "shape":"RegistryIdentifier", - "location":"uri", - "locationName":"registryId" - }, - "maxResults":{ - "shape":"MaxResults", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"NextToken", - "location":"querystring", - "locationName":"nextToken" - }, - "name":{ - "shape":"RegistryRecordName", - "location":"querystring", - "locationName":"name" - }, - "status":{ - "shape":"RegistryRecordStatus", - "location":"querystring", - "locationName":"status" - }, - "descriptorType":{ - "shape":"DescriptorType", - "location":"querystring", - "locationName":"descriptorType" - } - } - }, - "ListRegistryRecordsResponse":{ - "type":"structure", - "required":["registryRecords"], - "members":{ - "registryRecords":{"shape":"RegistryRecordSummaryList"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListTagsForResourceRequest":{ - "type":"structure", - "required":["resourceArn"], - "members":{ - "resourceArn":{ - "shape":"TaggableResourcesArn", - "location":"uri", - "locationName":"resourceArn" - } - } - }, - "ListTagsForResourceResponse":{ - "type":"structure", - "members":{ - "tags":{"shape":"TagsMap"} - } - }, - "ListWorkloadIdentitiesRequest":{ - "type":"structure", - "members":{ - "nextToken":{"shape":"String"}, - "maxResults":{"shape":"ListWorkloadIdentitiesRequestMaxResultsInteger"} - } - }, - "ListWorkloadIdentitiesRequestMaxResultsInteger":{ - "type":"integer", - "box":true, - "max":20, - "min":1 - }, - "ListWorkloadIdentitiesResponse":{ - "type":"structure", - "required":["workloadIdentities"], - "members":{ - "workloadIdentities":{"shape":"WorkloadIdentityList"}, - "nextToken":{"shape":"String"} - } - }, - "ListingMode":{ - "type":"string", - "enum":[ - "DEFAULT", - "DYNAMIC" - ] - }, - "LlmAsAJudgeEvaluatorConfig":{ - "type":"structure", - "required":[ - "instructions", - "ratingScale", - "modelConfig" - ], - "members":{ - "instructions":{"shape":"EvaluatorInstructions"}, - "ratingScale":{"shape":"RatingScale"}, - "modelConfig":{"shape":"EvaluatorModelConfig"} - } - }, - "LlmExtractionConfig":{ - "type":"structure", - "required":["definition"], - "members":{ - "llmExtractionInstruction":{"shape":"LlmExtractionInstruction"}, - "definition":{"shape":"Definition"}, - "validation":{"shape":"Validation"} - } - }, - "LlmExtractionInstruction":{ - "type":"string", - "max":1000, - "min":1, - "sensitive":true - }, - "LogGroupName":{ - "type":"string", - "pattern":"[.\\-_/#A-Za-z0-9]+" - }, - "Long":{ - "type":"long", - "box":true - }, - "MCPGatewayConfiguration":{ - "type":"structure", - "members":{ - "supportedVersions":{"shape":"McpSupportedVersions"}, - "instructions":{"shape":"McpInstructions"}, - "searchType":{"shape":"SearchType"}, - "sessionConfiguration":{"shape":"SessionConfiguration"}, - "streamingConfiguration":{"shape":"StreamingConfiguration"} - } - }, - "ManagedResourceDetails":{ - "type":"structure", - "members":{ - "domain":{"shape":"DomainName"}, - "resourceGatewayArn":{"shape":"ResourceGatewayArn"}, - "resourceAssociationArn":{"shape":"ResourceAssociationArn"} - } - }, - "ManagedVpcResource":{ - "type":"structure", - "required":[ - "vpcIdentifier", - "subnetIds", - "endpointIpAddressType" - ], - "members":{ - "vpcIdentifier":{"shape":"VpcIdentifier"}, - "subnetIds":{"shape":"SubnetIds"}, - "endpointIpAddressType":{"shape":"EndpointIpAddressType"}, - "securityGroupIds":{"shape":"SecurityGroupIds"}, - "tags":{"shape":"TagsMap"}, - "routingDomain":{"shape":"RoutingDomain"} - } - }, - "MatchPathPattern":{ - "type":"string", - "max":512, - "min":0, - "pattern":"/[\\w\\-.]+/\\*" - }, - "MatchPaths":{ - "type":"structure", - "required":["anyOf"], - "members":{ - "anyOf":{"shape":"MatchPathsAnyOfList"} - } - }, - "MatchPathsAnyOfList":{ - "type":"list", - "member":{"shape":"MatchPathPattern"}, - "max":10, - "min":1 - }, - "MatchPrincipalEntry":{ - "type":"structure", - "members":{ - "iamPrincipal":{"shape":"IamPrincipal"} - }, - "union":true - }, - "MatchPrincipals":{ - "type":"structure", - "required":["anyOf"], - "members":{ - "anyOf":{"shape":"MatchPrincipalsAnyOfList"} - } - }, - "MatchPrincipalsAnyOfList":{ - "type":"list", - "member":{"shape":"MatchPrincipalEntry"}, - "max":100, - "min":1 - }, - "MatchValueString":{ - "type":"string", - "max":255, - "min":1, - "pattern":"[A-Za-z0-9_.-]+" - }, - "MatchValueStringList":{ - "type":"list", - "member":{"shape":"MatchValueString"}, - "min":1 - }, - "MaxResults":{ - "type":"integer", - "box":true, - "max":100, - "min":1 - }, - "MaxTokens":{ - "type":"integer", - "box":true, - "min":1 - }, - "McpDescriptor":{ - "type":"structure", - "members":{ - "server":{"shape":"ServerDefinition"}, - "tools":{"shape":"ToolsDefinition"} - } - }, - "McpInstructions":{ - "type":"string", - "max":2048, - "min":1, - "sensitive":true - }, - "McpLambdaTargetConfiguration":{ - "type":"structure", - "required":[ - "lambdaArn", - "toolSchema" - ], - "members":{ - "lambdaArn":{"shape":"LambdaFunctionArn"}, - "toolSchema":{"shape":"ToolSchema"} - } - }, - "McpServerTargetConfiguration":{ - "type":"structure", - "required":["endpoint"], - "members":{ - "endpoint":{"shape":"McpServerTargetConfigurationEndpointString"}, - "mcpToolSchema":{"shape":"McpToolSchemaConfiguration"}, - "listingMode":{"shape":"ListingMode"}, - "resourcePriority":{"shape":"TargetResourcePriority"} - } - }, - "McpServerTargetConfigurationEndpointString":{ - "type":"string", - "pattern":"https://.*" - }, - "McpServerUrl":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"https://.*" - }, - "McpSupportedVersions":{ - "type":"list", - "member":{"shape":"McpVersion"} - }, - "McpTargetConfiguration":{ - "type":"structure", - "members":{ - "openApiSchema":{"shape":"ApiSchemaConfiguration"}, - "smithyModel":{"shape":"ApiSchemaConfiguration"}, - "lambda":{"shape":"McpLambdaTargetConfiguration"}, - "mcpServer":{"shape":"McpServerTargetConfiguration"}, - "apiGateway":{"shape":"ApiGatewayTargetConfiguration"}, - "connector":{"shape":"ConnectorTargetConfiguration"} - }, - "union":true - }, - "McpToolSchemaConfiguration":{ - "type":"structure", - "members":{ - "s3":{"shape":"S3Configuration"}, - "inlinePayload":{"shape":"InlinePayload"} - }, - "union":true - }, - "McpVersion":{"type":"string"}, - "Memory":{ - "type":"structure", - "required":[ - "arn", - "id", - "name", - "eventExpiryDuration", - "status", - "createdAt", - "updatedAt" - ], - "members":{ - "arn":{"shape":"MemoryArn"}, - "id":{"shape":"MemoryId"}, - "name":{"shape":"Name"}, - "description":{"shape":"Description"}, - "encryptionKeyArn":{"shape":"Arn"}, - "memoryExecutionRoleArn":{"shape":"Arn"}, - "eventExpiryDuration":{"shape":"MemoryEventExpiryDurationInteger"}, - "status":{"shape":"MemoryStatus"}, - "failureReason":{"shape":"String"}, - "createdAt":{"shape":"Timestamp"}, - "updatedAt":{"shape":"Timestamp"}, - "strategies":{"shape":"MemoryStrategyList"}, - "indexedKeys":{"shape":"IndexedKeysList"}, - "streamDeliveryResources":{"shape":"StreamDeliveryResources"}, - "managedByResourceArn":{"shape":"Arn"} - } - }, - "MemoryArn":{ - "type":"string", - "pattern":"arn:aws:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:memory\\/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}" - }, - "MemoryEventExpiryDurationInteger":{ - "type":"integer", - "box":true, - "max":365, - "min":1 - }, - "MemoryId":{ - "type":"string", - "min":12, - "pattern":"[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}" - }, - "MemoryRecordSchema":{ - "type":"structure", - "members":{ - "metadataSchema":{"shape":"MetadataSchemaList"} - } - }, - "MemoryStatus":{ - "type":"string", - "enum":[ - "CREATING", - "ACTIVE", - "FAILED", - "DELETING", - "UPDATING" - ] - }, - "MemoryStrategy":{ - "type":"structure", - "required":[ - "strategyId", - "name", - "type", - "namespaces", - "namespaceTemplates" - ], - "members":{ - "strategyId":{"shape":"MemoryStrategyId"}, - "name":{"shape":"Name"}, - "description":{"shape":"Description"}, - "configuration":{"shape":"StrategyConfiguration"}, - "type":{"shape":"MemoryStrategyType"}, - "namespaces":{ - "shape":"NamespacesList", - "deprecated":true, - "deprecatedMessage":"Use namespaceTemplates instead", - "deprecatedSince":"2026-03-02" - }, - "namespaceTemplates":{"shape":"NamespacesList"}, - "createdAt":{"shape":"Timestamp"}, - "updatedAt":{"shape":"Timestamp"}, - "status":{"shape":"MemoryStrategyStatus"}, - "memoryRecordSchema":{"shape":"MemoryRecordSchema"} - } - }, - "MemoryStrategyId":{ - "type":"string", - "min":12, - "pattern":"[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}" - }, - "MemoryStrategyInput":{ - "type":"structure", - "members":{ - "semanticMemoryStrategy":{"shape":"SemanticMemoryStrategyInput"}, - "summaryMemoryStrategy":{"shape":"SummaryMemoryStrategyInput"}, - "userPreferenceMemoryStrategy":{"shape":"UserPreferenceMemoryStrategyInput"}, - "customMemoryStrategy":{"shape":"CustomMemoryStrategyInput"}, - "episodicMemoryStrategy":{"shape":"EpisodicMemoryStrategyInput"} - }, - "union":true - }, - "MemoryStrategyInputList":{ - "type":"list", - "member":{"shape":"MemoryStrategyInput"} - }, - "MemoryStrategyList":{ - "type":"list", - "member":{"shape":"MemoryStrategy"} - }, - "MemoryStrategyStatus":{ - "type":"string", - "enum":[ - "CREATING", - "ACTIVE", - "DELETING", - "FAILED" - ] - }, - "MemoryStrategyType":{ - "type":"string", - "enum":[ - "SEMANTIC", - "SUMMARIZATION", - "USER_PREFERENCE", - "CUSTOM", - "EPISODIC" - ] - }, - "MemorySummary":{ - "type":"structure", - "required":[ - "createdAt", - "updatedAt" - ], - "members":{ - "arn":{"shape":"MemoryArn"}, - "id":{"shape":"MemoryId"}, - "status":{"shape":"MemoryStatus"}, - "createdAt":{"shape":"Timestamp"}, - "updatedAt":{"shape":"Timestamp"}, - "managedByResourceArn":{"shape":"Arn"} - } - }, - "MemorySummaryList":{ - "type":"list", - "member":{"shape":"MemorySummary"} - }, - "MemoryView":{ - "type":"string", - "enum":[ - "full", - "without_decryption" - ] - }, - "MessageBasedTrigger":{ - "type":"structure", - "members":{ - "messageCount":{"shape":"Integer"} - } - }, - "MessageBasedTriggerInput":{ - "type":"structure", - "members":{ - "messageCount":{"shape":"MessageBasedTriggerInputMessageCountInteger"} - } - }, - "MessageBasedTriggerInputMessageCountInteger":{ - "type":"integer", - "box":true, - "max":50, - "min":1 - }, - "MetadataConfiguration":{ - "type":"structure", - "members":{ - "allowedRequestHeaders":{"shape":"AllowedRequestHeaders"}, - "allowedQueryParameters":{"shape":"AllowedQueryParameters"}, - "allowedResponseHeaders":{"shape":"AllowedResponseHeaders"} - } - }, - "MetadataKey":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[a-zA-Z0-9\\s._:/=+@-]*" - }, - "MetadataSchemaEntry":{ - "type":"structure", - "required":["key"], - "members":{ - "key":{"shape":"MetadataKey"}, - "type":{"shape":"MetadataValueType"}, - "extractionType":{"shape":"ExtractionType"}, - "extractionConfig":{"shape":"ExtractionConfig"} - } - }, - "MetadataSchemaList":{ - "type":"list", - "member":{"shape":"MetadataSchemaEntry"}, - "max":20, - "min":1 - }, - "MetadataValueType":{ - "type":"string", - "enum":[ - "STRING", - "STRINGLIST", - "NUMBER" - ] - }, - "MicrosoftOauth2ProviderConfigInput":{ - "type":"structure", - "required":["clientId"], - "members":{ - "clientId":{"shape":"ClientIdType"}, - "clientSecret":{"shape":"DefaultClientSecretType"}, - "clientSecretConfig":{"shape":"SecretReference"}, - "clientSecretSource":{"shape":"SecretSourceType"}, - "tenantId":{"shape":"TenantIdType"} - } - }, - "MicrosoftOauth2ProviderConfigOutput":{ - "type":"structure", - "required":["oauthDiscovery"], - "members":{ - "oauthDiscovery":{"shape":"Oauth2Discovery"}, - "clientId":{"shape":"ClientIdType"} - } - }, - "ModelEntries":{ - "type":"list", - "member":{"shape":"ModelEntry"}, - "max":100, - "min":1 - }, - "ModelEntry":{ - "type":"structure", - "required":["model"], - "members":{ - "model":{"shape":"ModelPattern"} - } - }, - "ModelId":{"type":"string"}, - "ModelMapping":{ - "type":"structure", - "members":{ - "providerPrefix":{"shape":"ProviderPrefix"} - } - }, - "ModelPattern":{ - "type":"string", - "max":256, - "min":1, - "pattern":"[a-zA-Z0-9\\-\\._\\*\\?@]+(/[a-zA-Z0-9\\-\\._\\*\\?@]+)*" - }, - "ModifyConsolidationConfiguration":{ - "type":"structure", - "members":{ - "customConsolidationConfiguration":{"shape":"CustomConsolidationConfigurationInput"} - }, - "union":true - }, - "ModifyExtractionConfiguration":{ - "type":"structure", - "members":{ - "customExtractionConfiguration":{"shape":"CustomExtractionConfigurationInput"} - }, - "union":true - }, - "ModifyInvocationConfigurationInput":{ - "type":"structure", - "members":{ - "topicArn":{"shape":"Arn"}, - "payloadDeliveryBucketName":{"shape":"ModifyInvocationConfigurationInputPayloadDeliveryBucketNameString"} - } - }, - "ModifyInvocationConfigurationInputPayloadDeliveryBucketNameString":{ - "type":"string", - "pattern":"[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]" - }, - "ModifyMemoryStrategies":{ - "type":"structure", - "members":{ - "addMemoryStrategies":{"shape":"MemoryStrategyInputList"}, - "modifyMemoryStrategies":{"shape":"ModifyMemoryStrategiesList"}, - "deleteMemoryStrategies":{"shape":"DeleteMemoryStrategiesList"} - } - }, - "ModifyMemoryStrategiesList":{ - "type":"list", - "member":{"shape":"ModifyMemoryStrategyInput"} - }, - "ModifyMemoryStrategyInput":{ - "type":"structure", - "required":["memoryStrategyId"], - "members":{ - "memoryStrategyId":{"shape":"String"}, - "description":{"shape":"Description"}, - "namespaces":{ - "shape":"NamespacesList", - "deprecated":true, - "deprecatedMessage":"Use namespaceTemplates instead", - "deprecatedSince":"2026-03-02" - }, - "namespaceTemplates":{"shape":"NamespacesList"}, - "configuration":{"shape":"ModifyStrategyConfiguration"}, - "memoryRecordSchema":{"shape":"MemoryRecordSchema"} - } - }, - "ModifyReflectionConfiguration":{ - "type":"structure", - "members":{ - "episodicReflectionConfiguration":{"shape":"EpisodicReflectionConfigurationInput"}, - "customReflectionConfiguration":{"shape":"CustomReflectionConfigurationInput"} - }, - "union":true - }, - "ModifySelfManagedConfiguration":{ - "type":"structure", - "members":{ - "triggerConditions":{"shape":"TriggerConditionInputList"}, - "invocationConfiguration":{"shape":"ModifyInvocationConfigurationInput"}, - "historicalContextWindowSize":{"shape":"ModifySelfManagedConfigurationHistoricalContextWindowSizeInteger"} - } - }, - "ModifySelfManagedConfigurationHistoricalContextWindowSizeInteger":{ - "type":"integer", - "box":true, - "max":50, - "min":0 - }, - "ModifyStrategyConfiguration":{ - "type":"structure", - "members":{ - "extraction":{"shape":"ModifyExtractionConfiguration"}, - "consolidation":{"shape":"ModifyConsolidationConfiguration"}, - "reflection":{"shape":"ModifyReflectionConfiguration"}, - "selfManagedConfiguration":{"shape":"ModifySelfManagedConfiguration"} - } - }, - "MountPath":{ - "type":"string", - "max":200, - "min":6, - "pattern":"/mnt/[a-zA-Z0-9._-]+/?" - }, - "Name":{ - "type":"string", - "pattern":"[a-zA-Z][a-zA-Z0-9_]{0,47}" - }, - "Namespace":{ - "type":"string", - "max":512, - "min":1, - "pattern":"[a-zA-Z0-9\\-_\\/]*(\\{(actorId|sessionId|memoryStrategyId)\\}[a-zA-Z0-9\\-_\\/]*)*" - }, - "NamespacesList":{ - "type":"list", - "member":{"shape":"Namespace"}, - "max":1, - "min":1 - }, - "NaturalLanguage":{ - "type":"string", - "max":2000, - "min":1 - }, - "NetworkConfiguration":{ - "type":"structure", - "required":["networkMode"], - "members":{ - "networkMode":{"shape":"NetworkMode"}, - "networkModeConfig":{"shape":"VpcConfig"} - } - }, - "NetworkMode":{ - "type":"string", - "enum":[ - "PUBLIC", - "VPC" - ] - }, - "NextToken":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"\\S*" - }, - "NonBlankString":{ - "type":"string", - "pattern":"[\\s\\S]+" - }, - "NonEmptyString":{ - "type":"string", - "min":1 - }, - "NumberValidation":{ - "type":"structure", - "members":{ - "minValue":{"shape":"Double"}, - "maxValue":{"shape":"Double"} - } - }, - "NumericalScaleDefinition":{ - "type":"structure", - "required":[ - "definition", - "value", - "label" - ], - "members":{ - "definition":{"shape":"String"}, - "value":{"shape":"NumericalScaleDefinitionValueDouble"}, - "label":{"shape":"NumericalScaleDefinitionLabelString"} - } - }, - "NumericalScaleDefinitionLabelString":{ - "type":"string", - "max":100, - "min":1 - }, - "NumericalScaleDefinitionValueDouble":{ - "type":"double", - "box":true, - "min":0 - }, - "NumericalScaleDefinitions":{ - "type":"list", - "member":{"shape":"NumericalScaleDefinition"} - }, - "OAuth2AuthorizationData":{ - "type":"structure", - "required":["authorizationUrl"], - "members":{ - "authorizationUrl":{"shape":"OAuth2AuthorizationDataAuthorizationUrlString"}, - "userId":{"shape":"OAuth2AuthorizationDataUserIdString"} - } - }, - "OAuth2AuthorizationDataAuthorizationUrlString":{ - "type":"string", - "min":1 - }, - "OAuth2AuthorizationDataUserIdString":{ - "type":"string", - "max":128, - "min":1 - }, - "OAuthCredentialProvider":{ - "type":"structure", - "required":[ - "providerArn", - "scopes" - ], - "members":{ - "providerArn":{"shape":"OAuthCredentialProviderArn"}, - "scopes":{"shape":"OAuthScopes"}, - "customParameters":{"shape":"OAuthCustomParameters"}, - "grantType":{"shape":"OAuthGrantType"}, - "defaultReturnUrl":{"shape":"OAuthDefaultReturnUrl"} - } - }, - "OAuthCredentialProviderArn":{ - "type":"string", - "pattern":"arn:([^:]*):([^:]*):([^:]*):([0-9]{12})?:(.+)" - }, - "OAuthCustomParameters":{ - "type":"map", - "key":{"shape":"OAuthCustomParametersKey"}, - "value":{"shape":"OAuthCustomParametersValue"}, - "max":10, - "min":1 - }, - "OAuthCustomParametersKey":{ - "type":"string", - "max":256, - "min":1 - }, - "OAuthCustomParametersValue":{ - "type":"string", - "max":2048, - "min":1, - "sensitive":true - }, - "OAuthDefaultReturnUrl":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"\\w+:(\\/?\\/?)[^\\s]+" - }, - "OAuthGrantType":{ - "type":"string", - "enum":[ - "CLIENT_CREDENTIALS", - "AUTHORIZATION_CODE", - "TOKEN_EXCHANGE" - ] - }, - "OAuthScope":{ - "type":"string", - "max":64, - "min":1 - }, - "OAuthScopes":{ - "type":"list", - "member":{"shape":"OAuthScope"}, - "max":100, - "min":0 - }, - "Oauth2AuthorizationServerMetadata":{ - "type":"structure", - "required":[ - "issuer", - "authorizationEndpoint", - "tokenEndpoint" - ], - "members":{ - "issuer":{"shape":"IssuerUrlType"}, - "authorizationEndpoint":{"shape":"AuthorizationEndpointType"}, - "tokenEndpoint":{"shape":"TokenEndpointType"}, - "responseTypes":{"shape":"ResponseListType"}, - "tokenEndpointAuthMethods":{"shape":"TokenEndpointAuthMethodsType"} - } - }, - "Oauth2CredentialProviderItem":{ - "type":"structure", - "required":[ - "name", - "credentialProviderVendor", - "credentialProviderArn", - "createdTime", - "lastUpdatedTime" - ], - "members":{ - "name":{"shape":"CredentialProviderName"}, - "credentialProviderVendor":{"shape":"CredentialProviderVendorType"}, - "credentialProviderArn":{"shape":"CredentialProviderArnType"}, - "createdTime":{"shape":"Timestamp"}, - "lastUpdatedTime":{"shape":"Timestamp"} - } - }, - "Oauth2CredentialProviders":{ - "type":"list", - "member":{"shape":"Oauth2CredentialProviderItem"} - }, - "Oauth2Discovery":{ - "type":"structure", - "members":{ - "discoveryUrl":{"shape":"DiscoveryUrlType"}, - "authorizationServerMetadata":{"shape":"Oauth2AuthorizationServerMetadata"} - }, - "union":true - }, - "Oauth2ProviderConfigInput":{ - "type":"structure", - "members":{ - "customOauth2ProviderConfig":{"shape":"CustomOauth2ProviderConfigInput"}, - "googleOauth2ProviderConfig":{"shape":"GoogleOauth2ProviderConfigInput"}, - "githubOauth2ProviderConfig":{"shape":"GithubOauth2ProviderConfigInput"}, - "slackOauth2ProviderConfig":{"shape":"SlackOauth2ProviderConfigInput"}, - "salesforceOauth2ProviderConfig":{"shape":"SalesforceOauth2ProviderConfigInput"}, - "microsoftOauth2ProviderConfig":{"shape":"MicrosoftOauth2ProviderConfigInput"}, - "atlassianOauth2ProviderConfig":{"shape":"AtlassianOauth2ProviderConfigInput"}, - "linkedinOauth2ProviderConfig":{"shape":"LinkedinOauth2ProviderConfigInput"}, - "includedOauth2ProviderConfig":{"shape":"IncludedOauth2ProviderConfigInput"} - }, - "union":true - }, - "Oauth2ProviderConfigOutput":{ - "type":"structure", - "members":{ - "customOauth2ProviderConfig":{"shape":"CustomOauth2ProviderConfigOutput"}, - "googleOauth2ProviderConfig":{"shape":"GoogleOauth2ProviderConfigOutput"}, - "githubOauth2ProviderConfig":{"shape":"GithubOauth2ProviderConfigOutput"}, - "slackOauth2ProviderConfig":{"shape":"SlackOauth2ProviderConfigOutput"}, - "salesforceOauth2ProviderConfig":{"shape":"SalesforceOauth2ProviderConfigOutput"}, - "microsoftOauth2ProviderConfig":{"shape":"MicrosoftOauth2ProviderConfigOutput"}, - "atlassianOauth2ProviderConfig":{"shape":"AtlassianOauth2ProviderConfigOutput"}, - "linkedinOauth2ProviderConfig":{"shape":"LinkedinOauth2ProviderConfigOutput"}, - "includedOauth2ProviderConfig":{"shape":"IncludedOauth2ProviderConfigOutput"} - }, - "union":true - }, - "OnBehalfOfTokenExchangeConfigType":{ - "type":"structure", - "required":["grantType"], - "members":{ - "grantType":{"shape":"OnBehalfOfTokenExchangeGrantTypeType"}, - "tokenExchangeGrantTypeConfig":{"shape":"TokenExchangeGrantTypeConfigType"} - } - }, - "OnBehalfOfTokenExchangeGrantTypeType":{ - "type":"string", - "enum":[ - "TOKEN_EXCHANGE", - "JWT_AUTHORIZATION_GRANT" - ] - }, - "OnlineEvaluationConfigArn":{ - "type":"string", - "pattern":"arn:aws[a-zA-Z-]*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:online-evaluation-config\\/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}" - }, - "OnlineEvaluationConfigId":{ - "type":"string", - "pattern":"[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}" - }, - "OnlineEvaluationConfigStatus":{ - "type":"string", - "enum":[ - "ACTIVE", - "CREATING", - "CREATE_FAILED", - "UPDATING", - "UPDATE_FAILED", - "DELETING", - "ERROR" - ] - }, - "OnlineEvaluationConfigSummary":{ - "type":"structure", - "required":[ - "onlineEvaluationConfigArn", - "onlineEvaluationConfigId", - "onlineEvaluationConfigName", - "status", - "executionStatus", - "createdAt", - "updatedAt" - ], - "members":{ - "onlineEvaluationConfigArn":{"shape":"OnlineEvaluationConfigArn"}, - "onlineEvaluationConfigId":{"shape":"OnlineEvaluationConfigId"}, - "onlineEvaluationConfigName":{"shape":"EvaluationConfigName"}, - "description":{"shape":"EvaluationConfigDescription"}, - "status":{"shape":"OnlineEvaluationConfigStatus"}, - "executionStatus":{"shape":"OnlineEvaluationExecutionStatus"}, - "createdAt":{"shape":"Timestamp"}, - "updatedAt":{"shape":"Timestamp"}, - "failureReason":{"shape":"String"}, - "insights":{"shape":"InsightList"}, - "clusteringConfig":{"shape":"ClusteringConfig"} - } - }, - "OnlineEvaluationConfigSummaryList":{ - "type":"list", - "member":{"shape":"OnlineEvaluationConfigSummary"} - }, - "OnlineEvaluationExecutionStatus":{ - "type":"string", - "enum":[ - "ENABLED", - "DISABLED" - ] - }, - "OpenResponsesEvaluatorModelConfig":{ - "type":"structure", - "required":["modelId"], - "members":{ - "modelId":{"shape":"ModelId"}, - "maxOutputTokens":{"shape":"OpenResponsesEvaluatorModelConfigMaxOutputTokensInteger"}, - "temperature":{"shape":"OpenResponsesEvaluatorModelConfigTemperatureFloat"}, - "topP":{"shape":"OpenResponsesEvaluatorModelConfigTopPFloat"}, - "reasoning":{"shape":"ReasoningConfiguration"} - } - }, - "OpenResponsesEvaluatorModelConfigMaxOutputTokensInteger":{ - "type":"integer", - "box":true, - "min":1 - }, - "OpenResponsesEvaluatorModelConfigTemperatureFloat":{ - "type":"float", - "box":true, - "max":2, - "min":0 - }, - "OpenResponsesEvaluatorModelConfigTopPFloat":{ - "type":"float", - "box":true, - "max":1, - "min":0 - }, - "OutputConfig":{ - "type":"structure", - "required":["cloudWatchConfig"], - "members":{ - "cloudWatchConfig":{"shape":"CloudWatchOutputConfig"} - } - }, - "OverrideType":{ - "type":"string", - "enum":[ - "SEMANTIC_OVERRIDE", - "SUMMARY_OVERRIDE", - "USER_PREFERENCE_OVERRIDE", - "SELF_MANAGED", - "EPISODIC_OVERRIDE" - ] - }, - "PassthroughEndpoint":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"https://[a-zA-Z0-9\\-\\.]+(:[0-9]{1,5})?(/.*)?" - }, - "PassthroughProtocolType":{ - "type":"string", - "enum":[ - "MCP", - "A2A", - "INFERENCE", - "CUSTOM" - ] - }, - "PassthroughTargetConfiguration":{ - "type":"structure", - "required":[ - "endpoint", - "protocolType" - ], - "members":{ - "endpoint":{"shape":"PassthroughEndpoint"}, - "protocolType":{"shape":"PassthroughProtocolType"}, - "schema":{"shape":"HttpApiSchemaConfiguration"}, - "stickinessConfiguration":{"shape":"StickinessConfiguration"} - } - }, - "PaymentConnectorId":{ - "type":"string", - "max":211, - "min":12, - "pattern":"([0-9a-z][-]?){1,100}-[0-9a-z]{10}" - }, - "PaymentConnectorName":{ - "type":"string", - "max":48, - "min":1, - "pattern":"[a-zA-Z][a-zA-Z0-9_]{0,47}" - }, - "PaymentConnectorStatus":{ - "type":"string", - "enum":[ - "CREATING", - "UPDATING", - "DELETING", - "READY", - "CREATE_FAILED", - "UPDATE_FAILED", - "DELETE_FAILED" - ] - }, - "PaymentConnectorSummaries":{ - "type":"list", - "member":{"shape":"PaymentConnectorSummary"} - }, - "PaymentConnectorSummary":{ - "type":"structure", - "required":[ - "paymentConnectorId", - "name", - "type", - "status", - "lastUpdatedAt" - ], - "members":{ - "paymentConnectorId":{"shape":"PaymentConnectorId"}, - "name":{"shape":"PaymentConnectorName"}, - "type":{"shape":"PaymentConnectorType"}, - "status":{"shape":"PaymentConnectorStatus"}, - "lastUpdatedAt":{"shape":"DateTimestamp"} - } - }, - "PaymentConnectorType":{ - "type":"string", - "enum":[ - "CoinbaseCDP", - "StripePrivy" - ] - }, - "PaymentCredentialProviderArn":{ - "type":"string", - "max":2048, - "min":69, - "pattern":"arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b|aws-iso-e|aws-iso-f|aws-eusc):(acps|bedrock-agentcore):[A-Za-z0-9-]{1,64}:[0-9]{12}:token-vault/[a-zA-Z0-9-.]+/paymentcredentialprovider/[a-zA-Z0-9-.]+" - }, - "PaymentCredentialProviderArnType":{ - "type":"string", - "pattern":"arn:(aws|aws-us-gov):acps:[A-Za-z0-9-]{1,64}:[0-9]{12}:token-vault/[a-zA-Z0-9-.]+/paymentcredentialprovider/[a-zA-Z0-9-.]+" - }, - "PaymentCredentialProviderConfiguration":{ - "type":"structure", - "required":["credentialProviderArn"], - "members":{ - "credentialProviderArn":{"shape":"PaymentCredentialProviderArn"} - } - }, - "PaymentCredentialProviderItem":{ - "type":"structure", - "required":[ - "name", - "credentialProviderVendor", - "credentialProviderArn", - "createdTime", - "lastUpdatedTime" - ], - "members":{ - "name":{"shape":"CredentialProviderName"}, - "credentialProviderVendor":{"shape":"PaymentCredentialProviderVendorType"}, - "credentialProviderArn":{"shape":"PaymentCredentialProviderArnType"}, - "createdTime":{"shape":"Timestamp"}, - "lastUpdatedTime":{"shape":"Timestamp"} - } - }, - "PaymentCredentialProviderVendorType":{ - "type":"string", - "enum":[ - "CoinbaseCDP", - "StripePrivy" - ] - }, - "PaymentCredentialProviders":{ - "type":"list", - "member":{"shape":"PaymentCredentialProviderItem"} - }, - "PaymentManagerArn":{ - "type":"string", - "max":2048, - "min":66, - "pattern":"arn:(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:payment-manager/([0-9a-z][-]?){1,48}-[a-z0-9]{10}" - }, - "PaymentManagerId":{ - "type":"string", - "max":211, - "min":12, - "pattern":"([0-9a-z][-]?){1,100}-[0-9a-z]{10}" - }, - "PaymentManagerName":{ - "type":"string", - "max":48, - "min":1, - "pattern":"[a-zA-Z][a-zA-Z0-9]{0,47}" - }, - "PaymentManagerStatus":{ - "type":"string", - "enum":[ - "CREATING", - "UPDATING", - "DELETING", - "READY", - "CREATE_FAILED", - "UPDATE_FAILED", - "DELETE_FAILED" - ] - }, - "PaymentManagerSummaries":{ - "type":"list", - "member":{"shape":"PaymentManagerSummary"} - }, - "PaymentManagerSummary":{ - "type":"structure", - "required":[ - "paymentManagerArn", - "paymentManagerId", - "name", - "authorizerType", - "roleArn", - "status", - "lastUpdatedAt" - ], - "members":{ - "paymentManagerArn":{"shape":"PaymentManagerArn"}, - "paymentManagerId":{"shape":"PaymentManagerId"}, - "name":{"shape":"PaymentManagerName"}, - "description":{"shape":"PaymentsDescription"}, - "authorizerType":{"shape":"PaymentsAuthorizerType"}, - "roleArn":{"shape":"RoleArn"}, - "status":{"shape":"PaymentManagerStatus"}, - "createdAt":{"shape":"DateTimestamp"}, - "lastUpdatedAt":{"shape":"DateTimestamp"} - } - }, - "PaymentProviderConfigurationInput":{ - "type":"structure", - "members":{ - "coinbaseCdpConfiguration":{"shape":"CoinbaseCdpConfigurationInput"}, - "stripePrivyConfiguration":{"shape":"StripePrivyConfigurationInput"} - }, - "union":true - }, - "PaymentProviderConfigurationOutput":{ - "type":"structure", - "members":{ - "coinbaseCdpConfiguration":{"shape":"CoinbaseCdpConfigurationOutput"}, - "stripePrivyConfiguration":{"shape":"StripePrivyConfigurationOutput"} - }, - "union":true - }, - "PaymentsAuthorizerType":{ - "type":"string", - "enum":[ - "CUSTOM_JWT", - "AWS_IAM" - ] - }, - "PaymentsDescription":{ - "type":"string", - "max":4096, - "min":1, - "pattern":"[a-zA-Z0-9\\s]+" - }, - "Policies":{ - "type":"list", - "member":{"shape":"Policy"}, - "max":100, - "min":0 - }, - "Policy":{ - "type":"structure", - "required":[ - "policyId", - "name", - "policyEngineId", - "createdAt", - "updatedAt", - "policyArn", - "status", - "definition", - "statusReasons" - ], - "members":{ - "policyId":{"shape":"ResourceId"}, - "name":{"shape":"PolicyName"}, - "policyEngineId":{"shape":"ResourceId"}, - "createdAt":{"shape":"DateTimestamp"}, - "updatedAt":{"shape":"DateTimestamp"}, - "policyArn":{"shape":"PolicyArn"}, - "status":{"shape":"PolicyStatus"}, - "enforcementMode":{"shape":"EnforcementMode"}, - "definition":{"shape":"PolicyDefinition"}, - "description":{"shape":"Description"}, - "statusReasons":{"shape":"PolicyStatusReasons"} - } - }, - "PolicyArn":{ - "type":"string", - "max":203, - "min":96, - "pattern":"arn:aws[-a-z]{0,7}:bedrock-agentcore:[a-z0-9-]{9,15}:[0-9]{12}:policy-engine/[a-zA-Z][a-zA-Z0-9-_]{0,47}-[a-zA-Z0-9_]{10}/policy/[a-zA-Z][a-zA-Z0-9-_]{0,47}-[a-zA-Z0-9_]{10}" - }, - "PolicyDefinition":{ - "type":"structure", - "members":{ - "cedar":{"shape":"CedarPolicy"}, - "policyGeneration":{"shape":"PolicyGenerationDetails"}, - "policy":{"shape":"PolicyStatement"} - }, - "union":true - }, - "PolicyEngine":{ - "type":"structure", - "required":[ - "policyEngineId", - "name", - "createdAt", - "updatedAt", - "policyEngineArn", - "status", - "statusReasons" - ], - "members":{ - "policyEngineId":{"shape":"ResourceId"}, - "name":{"shape":"PolicyEngineName"}, - "createdAt":{"shape":"DateTimestamp"}, - "updatedAt":{"shape":"DateTimestamp"}, - "policyEngineArn":{"shape":"PolicyEngineArn"}, - "status":{"shape":"PolicyEngineStatus"}, - "encryptionKeyArn":{"shape":"KmsKeyArn"}, - "description":{"shape":"Description"}, - "statusReasons":{"shape":"PolicyStatusReasons"} - } - }, - "PolicyEngineArn":{ - "type":"string", - "max":136, - "min":76, - "pattern":"arn:aws[-a-z]{0,7}:bedrock-agentcore:[a-z0-9-]{9,15}:[0-9]{12}:policy-engine/[a-zA-Z][a-zA-Z0-9-_]{0,47}-[a-zA-Z0-9_]{10}" - }, - "PolicyEngineName":{ - "type":"string", - "max":48, - "min":1, - "pattern":"[A-Za-z][A-Za-z0-9_]*" - }, - "PolicyEngineStatus":{ - "type":"string", - "enum":[ - "CREATING", - "ACTIVE", - "UPDATING", - "DELETING", - "CREATE_FAILED", - "UPDATE_FAILED", - "DELETE_FAILED" - ] - }, - "PolicyEngineSummary":{ - "type":"structure", - "required":[ - "policyEngineId", - "name", - "createdAt", - "updatedAt", - "policyEngineArn", - "status" - ], - "members":{ - "policyEngineId":{"shape":"ResourceId"}, - "name":{"shape":"PolicyEngineName"}, - "createdAt":{"shape":"DateTimestamp"}, - "updatedAt":{"shape":"DateTimestamp"}, - "policyEngineArn":{"shape":"PolicyEngineArn"}, - "status":{"shape":"PolicyEngineStatus"}, - "encryptionKeyArn":{"shape":"KmsKeyArn"} - } - }, - "PolicyEngineSummaryList":{ - "type":"list", - "member":{"shape":"PolicyEngineSummary"}, - "max":100, - "min":0 - }, - "PolicyEngines":{ - "type":"list", - "member":{"shape":"PolicyEngine"}, - "max":100, - "min":0 - }, - "PolicyGeneration":{ - "type":"structure", - "required":[ - "policyEngineId", - "policyGenerationId", - "name", - "policyGenerationArn", - "resource", - "createdAt", - "updatedAt", - "status", - "statusReasons" - ], - "members":{ - "policyEngineId":{"shape":"ResourceId"}, - "policyGenerationId":{"shape":"ResourceId"}, - "name":{"shape":"PolicyGenerationName"}, - "policyGenerationArn":{"shape":"PolicyGenerationArn"}, - "resource":{"shape":"Resource"}, - "createdAt":{"shape":"DateTimestamp"}, - "updatedAt":{"shape":"DateTimestamp"}, - "status":{"shape":"PolicyGenerationStatus"}, - "findings":{"shape":"String"}, - "statusReasons":{"shape":"PolicyStatusReasons"} - } - }, - "PolicyGenerationArn":{ - "type":"string", - "max":210, - "min":103, - "pattern":"arn:aws[-a-z]{0,7}:bedrock-agentcore:[a-z0-9-]{9,15}:[0-9]{12}:policy-engine/[a-zA-Z][a-zA-Z0-9-_]{0,47}-[a-zA-Z0-9_]{10}/policy-generation/[a-zA-Z][a-zA-Z0-9-_]{0,47}-[a-zA-Z0-9_]{10}" - }, - "PolicyGenerationAsset":{ - "type":"structure", - "required":[ - "policyGenerationAssetId", - "rawTextFragment", - "findings" - ], - "members":{ - "policyGenerationAssetId":{"shape":"ResourceId"}, - "definition":{"shape":"PolicyDefinition"}, - "rawTextFragment":{"shape":"NaturalLanguage"}, - "findings":{"shape":"Findings"} - } - }, - "PolicyGenerationAssets":{ - "type":"list", - "member":{"shape":"PolicyGenerationAsset"} - }, - "PolicyGenerationDetails":{ - "type":"structure", - "required":[ - "policyGenerationId", - "policyGenerationAssetId" - ], - "members":{ - "policyGenerationId":{"shape":"ResourceId"}, - "policyGenerationAssetId":{"shape":"ResourceId"} - } - }, - "PolicyGenerationName":{ - "type":"string", - "max":48, - "min":1, - "pattern":"[A-Za-z][A-Za-z0-9_]*" - }, - "PolicyGenerationStatus":{ - "type":"string", - "enum":[ - "GENERATING", - "GENERATED", - "GENERATE_FAILED", - "DELETE_FAILED" - ] - }, - "PolicyGenerationSummary":{ - "type":"structure", - "required":[ - "policyEngineId", - "policyGenerationId", - "name", - "policyGenerationArn", - "resource", - "createdAt", - "updatedAt", - "status" - ], - "members":{ - "policyEngineId":{"shape":"ResourceId"}, - "policyGenerationId":{"shape":"ResourceId"}, - "name":{"shape":"PolicyGenerationName"}, - "policyGenerationArn":{"shape":"PolicyGenerationArn"}, - "resource":{"shape":"Resource"}, - "createdAt":{"shape":"DateTimestamp"}, - "updatedAt":{"shape":"DateTimestamp"}, - "status":{"shape":"PolicyGenerationStatus"}, - "findings":{"shape":"String"} - } - }, - "PolicyGenerationSummaryList":{ - "type":"list", - "member":{"shape":"PolicyGenerationSummary"}, - "max":100, - "min":0 - }, - "PolicyGenerations":{ - "type":"list", - "member":{"shape":"PolicyGeneration"}, - "max":100, - "min":0 - }, - "PolicyName":{ - "type":"string", - "max":48, - "min":1, - "pattern":"[A-Za-z][A-Za-z0-9_]*" - }, - "PolicyStatement":{ - "type":"structure", - "required":["statement"], - "members":{ - "statement":{"shape":"Statement"} - } - }, - "PolicyStatus":{ - "type":"string", - "enum":[ - "CREATING", - "ACTIVE", - "UPDATING", - "DELETING", - "CREATE_FAILED", - "UPDATE_FAILED", - "DELETE_FAILED" - ] - }, - "PolicyStatusReasons":{ - "type":"list", - "member":{"shape":"String"} - }, - "PolicySummary":{ - "type":"structure", - "required":[ - "policyId", - "name", - "policyEngineId", - "createdAt", - "updatedAt", - "policyArn", - "status" - ], - "members":{ - "policyId":{"shape":"ResourceId"}, - "name":{"shape":"PolicyName"}, - "policyEngineId":{"shape":"ResourceId"}, - "createdAt":{"shape":"DateTimestamp"}, - "updatedAt":{"shape":"DateTimestamp"}, - "policyArn":{"shape":"PolicyArn"}, - "status":{"shape":"PolicyStatus"}, - "enforcementMode":{"shape":"EnforcementMode"} - } - }, - "PolicySummaryList":{ - "type":"list", - "member":{"shape":"PolicySummary"}, - "max":100, - "min":0 - }, - "PolicyValidationMode":{ - "type":"string", - "enum":[ - "FAIL_ON_ANY_FINDINGS", - "IGNORE_ALL_FINDINGS" - ] - }, - "PrincipalMatchOperator":{ - "type":"string", - "enum":[ - "StringEquals", - "StringLike" - ] - }, - "PrivateEndpoint":{ - "type":"structure", - "members":{ - "selfManagedLatticeResource":{"shape":"SelfManagedLatticeResource"}, - "managedVpcResource":{"shape":"ManagedVpcResource"} - }, - "union":true - }, - "PrivateEndpointManagedResources":{ - "type":"list", - "member":{"shape":"ManagedResourceDetails"} - }, - "PrivateEndpointOverride":{ - "type":"structure", - "required":[ - "domain", - "privateEndpoint" - ], - "members":{ - "domain":{"shape":"PrivateEndpointOverrideDomain"}, - "privateEndpoint":{"shape":"PrivateEndpoint"} - } - }, - "PrivateEndpointOverrideDomain":{ - "type":"string", - "max":253, - "min":1 - }, - "PrivateEndpointOverrides":{ - "type":"list", - "member":{"shape":"PrivateEndpointOverride"}, - "max":5, - "min":0 - }, - "PrivateKeyJwtConfig":{ - "type":"structure", - "members":{ - "privateKeySource":{"shape":"PrivateKeySource"}, - "signingAlgorithm":{"shape":"SigningAlgorithm"}, - "additionalHeaderClaims":{"shape":"AdditionalClaims"}, - "additionalPayloadClaims":{"shape":"AdditionalClaims"} - } - }, - "PrivateKeySource":{ - "type":"structure", - "members":{ - "kmsKeySource":{"shape":"KmsKeySourceType"} - }, - "union":true - }, - "Prompt":{ - "type":"string", - "max":30000, - "min":1, - "sensitive":true - }, - "ProtocolConfiguration":{ - "type":"structure", - "required":["serverProtocol"], - "members":{ - "serverProtocol":{"shape":"ServerProtocol"} - } - }, - "ProviderPrefix":{ - "type":"structure", - "members":{ - "strip":{"shape":"Boolean"}, - "separator":{"shape":"ProviderPrefixSeparatorString"} - } - }, - "ProviderPrefixSeparatorString":{ - "type":"string", - "max":1, - "min":1 - }, - "PutResourcePolicyRequest":{ - "type":"structure", - "required":[ - "resourceArn", - "policy" - ], - "members":{ - "resourceArn":{ - "shape":"BedrockAgentcoreResourceArn", - "location":"uri", - "locationName":"resourceArn" - }, - "policy":{"shape":"ResourcePolicyBody"} - } - }, - "PutResourcePolicyResponse":{ - "type":"structure", - "required":["policy"], - "members":{ - "policy":{"shape":"ResourcePolicyBody"} - } - }, - "RatingScale":{ - "type":"structure", - "members":{ - "numerical":{"shape":"NumericalScaleDefinitions"}, - "categorical":{"shape":"CategoricalScaleDefinitions"} - }, - "sensitive":true, - "union":true - }, - "ReasoningConfiguration":{ - "type":"structure", - "members":{ - "effort":{"shape":"ReasoningConfigurationEffortString"} - } - }, - "ReasoningConfigurationEffortString":{ - "type":"string", - "max":64, - "min":1 - }, - "RecordIdentifier":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"(arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:registry/[a-zA-Z0-9]{12,16}/record/)?[a-zA-Z0-9]{12}" - }, - "RecordingConfig":{ - "type":"structure", - "members":{ - "enabled":{"shape":"Boolean"}, - "s3Location":{"shape":"S3Location"} - } - }, - "ReflectionConfiguration":{ - "type":"structure", - "members":{ - "customReflectionConfiguration":{"shape":"CustomReflectionConfiguration"}, - "episodicReflectionConfiguration":{"shape":"EpisodicReflectionConfiguration"} - }, - "union":true - }, - "RegistryArn":{ - "type":"string", - "pattern":"arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:registry/[a-zA-Z0-9]{12,16}" - }, - "RegistryAuthorizerType":{ - "type":"string", - "enum":[ - "CUSTOM_JWT", - "AWS_IAM" - ] - }, - "RegistryId":{ - "type":"string", - "max":16, - "min":12, - "pattern":"[a-zA-Z0-9]{12,16}" - }, - "RegistryIdentifier":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"(arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:registry/)?[a-zA-Z0-9]{12,16}" - }, - "RegistryName":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[a-zA-Z0-9][a-zA-Z0-9_\\-\\.\\/]*" - }, - "RegistryRecordArn":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:registry/[a-zA-Z0-9]{12,16}/record/[a-zA-Z0-9]{12}" - }, - "RegistryRecordCredentialProviderConfiguration":{ - "type":"structure", - "required":[ - "credentialProviderType", - "credentialProvider" - ], - "members":{ - "credentialProviderType":{"shape":"RegistryRecordCredentialProviderType"}, - "credentialProvider":{"shape":"RegistryRecordCredentialProviderUnion"} - } - }, - "RegistryRecordCredentialProviderConfigurationList":{ - "type":"list", - "member":{"shape":"RegistryRecordCredentialProviderConfiguration"}, - "max":1, - "min":0 - }, - "RegistryRecordCredentialProviderType":{ - "type":"string", - "enum":[ - "OAUTH", - "IAM" - ] - }, - "RegistryRecordCredentialProviderUnion":{ - "type":"structure", - "members":{ - "oauthCredentialProvider":{"shape":"RegistryRecordOAuthCredentialProvider"}, - "iamCredentialProvider":{"shape":"RegistryRecordIamCredentialProvider"} - }, - "union":true - }, - "RegistryRecordIamCredentialProvider":{ - "type":"structure", - "members":{ - "roleArn":{"shape":"IamRoleArn"}, - "service":{"shape":"IamSigningServiceName"}, - "region":{"shape":"IamSigningRegion"} - } - }, - "RegistryRecordId":{ - "type":"string", - "max":12, - "min":12, - "pattern":"[a-zA-Z0-9]{12}" - }, - "RegistryRecordName":{ - "type":"string", - "max":255, - "min":1, - "pattern":"[a-zA-Z0-9][a-zA-Z0-9_\\-\\.\\/]*" - }, - "RegistryRecordOAuthCredentialProvider":{ - "type":"structure", - "required":["providerArn"], - "members":{ - "providerArn":{"shape":"CredentialProviderArn"}, - "grantType":{"shape":"RegistryRecordOAuthGrantType"}, - "scopes":{"shape":"ScopeList"}, - "customParameters":{"shape":"CustomParameterMap"} - } - }, - "RegistryRecordOAuthGrantType":{ - "type":"string", - "enum":["CLIENT_CREDENTIALS"] - }, - "RegistryRecordStatus":{ - "type":"string", - "enum":[ - "DRAFT", - "PENDING_APPROVAL", - "APPROVED", - "REJECTED", - "DEPRECATED", - "CREATING", - "UPDATING", - "CREATE_FAILED", - "UPDATE_FAILED" - ] - }, - "RegistryRecordSummary":{ - "type":"structure", - "required":[ - "registryArn", - "recordArn", - "recordId", - "name", - "descriptorType", - "recordVersion", - "status", - "createdAt", - "updatedAt" - ], - "members":{ - "registryArn":{"shape":"RegistryArn"}, - "recordArn":{"shape":"RegistryRecordArn"}, - "recordId":{"shape":"RegistryRecordId"}, - "name":{"shape":"RegistryRecordName"}, - "description":{"shape":"Description"}, - "descriptorType":{"shape":"DescriptorType"}, - "recordVersion":{"shape":"RegistryRecordVersion"}, - "status":{"shape":"RegistryRecordStatus"}, - "createdAt":{"shape":"DateTimestamp"}, - "updatedAt":{"shape":"DateTimestamp"} - } - }, - "RegistryRecordSummaryList":{ - "type":"list", - "member":{"shape":"RegistryRecordSummary"} - }, - "RegistryRecordVersion":{ - "type":"string", - "max":255, - "min":1, - "pattern":"[a-zA-Z0-9.-]+" - }, - "RegistryStatus":{ - "type":"string", - "enum":[ - "CREATING", - "READY", - "UPDATING", - "CREATE_FAILED", - "UPDATE_FAILED", - "DELETING", - "DELETE_FAILED" - ] - }, - "RegistrySummary":{ - "type":"structure", - "required":[ - "name", - "registryId", - "registryArn", - "status", - "createdAt", - "updatedAt" - ], - "members":{ - "name":{"shape":"RegistryName"}, - "description":{"shape":"Description"}, - "registryId":{"shape":"RegistryId"}, - "registryArn":{"shape":"RegistryArn"}, - "authorizerType":{"shape":"RegistryAuthorizerType"}, - "status":{"shape":"RegistryStatus"}, - "statusReason":{"shape":"String"}, - "createdAt":{"shape":"DateTimestamp"}, - "updatedAt":{"shape":"DateTimestamp"} - } - }, - "RegistrySummaryList":{ - "type":"list", - "member":{"shape":"RegistrySummary"} - }, - "RequestHeaderAllowlist":{ - "type":"list", - "member":{"shape":"HeaderName"}, - "max":20, - "min":1 - }, - "RequestHeaderConfiguration":{ - "type":"structure", - "members":{ - "requestHeaderAllowlist":{"shape":"RequestHeaderAllowlist"} - }, - "union":true - }, - "RequiredProperties":{ - "type":"list", - "member":{"shape":"String"} - }, - "Resource":{ - "type":"structure", - "members":{ - "arn":{"shape":"BedrockAgentcoreResourceArn"} - }, - "union":true - }, - "ResourceAssociationArn":{ - "type":"string", - "pattern":"arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:servicenetworkresourceassociation/snra-[0-9a-f]{17}" - }, - "ResourceConfigurationIdentifier":{ - "type":"string", - "max":2048, - "min":20, - "pattern":"((rcfg-[0-9a-z]{17})|(arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:resourceconfiguration/rcfg-[0-9a-z]{17}))" - }, - "ResourceGatewayArn":{ - "type":"string", - "pattern":"arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:resourcegateway/rgw-[0-9a-z]{17}" - }, - "ResourceId":{ - "type":"string", - "max":59, - "min":12, - "pattern":"[A-Za-z][A-Za-z0-9_]*-[a-z0-9_]{10}" - }, - "ResourceLimitExceededException":{ - "type":"structure", - "members":{ - "message":{"shape":"String"} - }, - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "ResourceLocation":{ - "type":"structure", - "members":{ - "s3":{"shape":"S3Location"} - }, - "union":true - }, - "ResourceNotFoundException":{ - "type":"structure", - "members":{ - "message":{"shape":"NonBlankString"} - }, - "error":{ - "httpStatusCode":404, - "senderFault":true - }, - "exception":true - }, - "ResourceOauth2ReturnUrlListType":{ - "type":"list", - "member":{"shape":"ResourceOauth2ReturnUrlType"} - }, - "ResourceOauth2ReturnUrlType":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"\\w+:(\\/?\\/?)[^\\s]+" - }, - "ResourcePolicyBody":{ - "type":"string", - "max":20480, - "min":1 - }, - "ResourceType":{ - "type":"string", - "enum":[ - "SYSTEM", - "CUSTOM" - ] - }, - "ResponseListType":{ - "type":"list", - "member":{"shape":"ResponseType"} - }, - "ResponseType":{"type":"string"}, - "RestApiMethod":{ - "type":"string", - "enum":[ - "GET", - "DELETE", - "HEAD", - "OPTIONS", - "PATCH", - "PUT", - "POST" - ] - }, - "RestApiMethods":{ - "type":"list", - "member":{"shape":"RestApiMethod"} - }, - "RoleArn":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+" - }, - "RouteToTargetAction":{ - "type":"structure", - "members":{ - "staticRoute":{"shape":"StaticRoute"}, - "weightedRoute":{"shape":"WeightedRoute"} - }, - "union":true - }, - "RoutingDomain":{ - "type":"string", - "max":255, - "min":3 - }, - "Rule":{ - "type":"structure", - "required":["samplingConfig"], - "members":{ - "samplingConfig":{"shape":"SamplingConfig"}, - "filters":{"shape":"FilterList"}, - "sessionConfig":{"shape":"SessionConfig"} - } - }, - "RuntimeArn":{ - "type":"string", - "pattern":"arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:runtime/[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10}" - }, - "RuntimeContainerUri":{ - "type":"string", - "max":1024, - "min":1, - "pattern":"(([0-9]{12})\\.dkr\\.ecr\\.([a-z0-9-]+)\\.amazonaws\\.com(\\.cn)?|public\\.ecr\\.aws)/((?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*)(?::([^:@]{1,300}))?(?:@(.+))?" - }, - "RuntimeMetadataConfiguration":{ - "type":"structure", - "required":["requireMMDSV2"], - "members":{ - "requireMMDSV2":{"shape":"Boolean"} - } - }, - "RuntimeQualifier":{ - "type":"string", - "pattern":".*([1-9][0-9]{0,4})|([a-zA-Z][a-zA-Z0-9_]{0,47}).*" - }, - "RuntimeTargetConfiguration":{ - "type":"structure", - "required":["arn"], - "members":{ - "arn":{"shape":"RuntimeArn"}, - "qualifier":{"shape":"RuntimeQualifier"}, - "schema":{"shape":"HttpApiSchemaConfiguration"} - } - }, - "S3BucketUri":{ - "type":"string", - "pattern":"s3://.{1,2043}" - }, - "S3Configuration":{ - "type":"structure", - "members":{ - "uri":{"shape":"S3BucketUri"}, - "bucketOwnerAccountId":{"shape":"AwsAccountId"} - } - }, - "S3FilesAccessPointArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[-a-z]*:s3files:[0-9a-z-:]+:file-system/fs-[0-9a-f]{17,40}/access-point/fsap-[0-9a-f]{17,40}" - }, - "S3FilesAccessPointConfiguration":{ - "type":"structure", - "required":[ - "accessPointArn", - "mountPath" - ], - "members":{ - "accessPointArn":{"shape":"S3FilesAccessPointArn"}, - "mountPath":{"shape":"MountPath"} - } - }, - "S3FilesConfiguration":{ - "type":"structure", - "required":[ - "accessPointArn", - "mountPath", - "fileSystemArn" - ], - "members":{ - "accessPointArn":{"shape":"S3FilesAccessPointArn"}, - "mountPath":{"shape":"MountPath"}, - "fileSystemArn":{"shape":"S3FilesFileSystemArn"} - } - }, - "S3FilesFileSystemArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[-a-z]*:s3files:[a-z0-9-]+:[0-9]{12}:file-system/fs-[0-9a-f]{17,40}" - }, - "S3Location":{ - "type":"structure", - "required":[ - "bucket", - "prefix" - ], - "members":{ - "bucket":{"shape":"S3LocationBucketString"}, - "prefix":{"shape":"S3LocationPrefixString"}, - "versionId":{"shape":"S3LocationVersionIdString"} - } - }, - "S3LocationBucketString":{ - "type":"string", - "pattern":"[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]" - }, - "S3LocationPrefixString":{ - "type":"string", - "max":1024, - "min":1 - }, - "S3LocationVersionIdString":{ - "type":"string", - "max":1024, - "min":3 - }, - "S3Source":{ - "type":"structure", - "required":["s3Uri"], - "members":{ - "s3Uri":{"shape":"S3Uri"} - } - }, - "S3Uri":{ - "type":"string", - "pattern":"s3://[a-z0-9][a-z0-9.\\-]{1,61}[a-z0-9]/.{1,1024}" - }, - "SalesforceOauth2ProviderConfigInput":{ - "type":"structure", - "required":["clientId"], - "members":{ - "clientId":{"shape":"ClientIdType"}, - "clientSecret":{"shape":"DefaultClientSecretType"}, - "clientSecretConfig":{"shape":"SecretReference"}, - "clientSecretSource":{"shape":"SecretSourceType"} - } - }, - "SalesforceOauth2ProviderConfigOutput":{ - "type":"structure", - "required":["oauthDiscovery"], - "members":{ - "oauthDiscovery":{"shape":"Oauth2Discovery"}, - "clientId":{"shape":"ClientIdType"} - } - }, - "SamplingConfig":{ - "type":"structure", - "required":["samplingPercentage"], - "members":{ - "samplingPercentage":{"shape":"SamplingConfigSamplingPercentageDouble"} - } - }, - "SamplingConfigSamplingPercentageDouble":{ - "type":"double", - "box":true, - "max":100.0, - "min":0.01 - }, - "SandboxName":{ - "type":"string", - "pattern":"[a-zA-Z][a-zA-Z0-9_]{0,47}" - }, - "SchemaDefinition":{ - "type":"structure", - "required":["type"], - "members":{ - "type":{"shape":"SchemaType"}, - "properties":{"shape":"SchemaProperties"}, - "required":{"shape":"RequiredProperties"}, - "items":{"shape":"SchemaDefinition"}, - "description":{"shape":"String"} - } - }, - "SchemaProperties":{ - "type":"map", - "key":{"shape":"String"}, - "value":{"shape":"SchemaDefinition"} - }, - "SchemaType":{ - "type":"string", - "enum":[ - "string", - "number", - "object", - "array", - "boolean", - "integer" - ] - }, - "SchemaVersion":{ - "type":"string", - "max":255, - "min":1 - }, - "ScopeList":{ - "type":"list", - "member":{"shape":"String"} - }, - "ScopeType":{ - "type":"string", - "max":128, - "min":1 - }, - "ScopesListType":{ - "type":"list", - "member":{"shape":"ScopeType"} - }, - "SearchType":{ - "type":"string", - "enum":["SEMANTIC"] - }, - "Secret":{ - "type":"structure", - "required":["secretArn"], - "members":{ - "secretArn":{"shape":"SecretArn"} - } - }, - "SecretArn":{ - "type":"string", - "pattern":"arn:(aws|aws-us-gov):secretsmanager:[A-Za-z0-9-]{1,64}:[0-9]{12}:secret:[a-zA-Z0-9-_/+=.@!]+" - }, - "SecretIdType":{ - "type":"string", - "max":2048, - "min":1 - }, - "SecretJsonKeyType":{ - "type":"string", - "max":128, - "min":1 - }, - "SecretReference":{ - "type":"structure", - "required":[ - "secretId", - "jsonKey" - ], - "members":{ - "secretId":{"shape":"SecretIdType"}, - "jsonKey":{"shape":"SecretJsonKeyType"} - } - }, - "SecretSourceType":{ - "type":"string", - "enum":[ - "MANAGED", - "EXTERNAL" - ] - }, - "SecretsManagerLocation":{ - "type":"structure", - "required":["secretArn"], - "members":{ - "secretArn":{"shape":"ToolSecretArn"} - } - }, - "SecurityGroupId":{ - "type":"string", - "pattern":"sg-[0-9a-zA-Z]{8,17}" - }, - "SecurityGroupIdentifier":{ - "type":"string", - "pattern":"sg-(([0-9a-z]{8})|([0-9a-z]{17}))" - }, - "SecurityGroupIds":{ - "type":"list", - "member":{"shape":"SecurityGroupIdentifier"}, - "max":5, - "min":0 - }, - "SecurityGroups":{ - "type":"list", - "member":{"shape":"SecurityGroupId"}, - "max":16, - "min":1 - }, - "SelfManagedConfiguration":{ - "type":"structure", - "required":[ - "triggerConditions", - "invocationConfiguration", - "historicalContextWindowSize" - ], - "members":{ - "triggerConditions":{"shape":"TriggerConditionsList"}, - "invocationConfiguration":{"shape":"InvocationConfiguration"}, - "historicalContextWindowSize":{"shape":"Integer"} - } - }, - "SelfManagedConfigurationInput":{ - "type":"structure", - "required":["invocationConfiguration"], - "members":{ - "triggerConditions":{"shape":"TriggerConditionInputList"}, - "invocationConfiguration":{"shape":"InvocationConfigurationInput"}, - "historicalContextWindowSize":{"shape":"SelfManagedConfigurationInputHistoricalContextWindowSizeInteger"} - } - }, - "SelfManagedConfigurationInputHistoricalContextWindowSizeInteger":{ - "type":"integer", - "box":true, - "max":50, - "min":0 - }, - "SelfManagedLatticeResource":{ - "type":"structure", - "members":{ - "resourceConfigurationIdentifier":{"shape":"ResourceConfigurationIdentifier"} - }, - "union":true - }, - "SemanticConsolidationOverride":{ - "type":"structure", - "required":[ - "appendToPrompt", - "modelId" - ], - "members":{ - "appendToPrompt":{"shape":"Prompt"}, - "modelId":{"shape":"String"} - } - }, - "SemanticExtractionOverride":{ - "type":"structure", - "required":[ - "appendToPrompt", - "modelId" - ], - "members":{ - "appendToPrompt":{"shape":"Prompt"}, - "modelId":{"shape":"String"} - } - }, - "SemanticMemoryStrategyInput":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{"shape":"Name"}, - "description":{"shape":"Description"}, - "namespaces":{ - "shape":"NamespacesList", - "deprecated":true, - "deprecatedMessage":"Use namespaceTemplates instead", - "deprecatedSince":"2026-03-02" - }, - "namespaceTemplates":{"shape":"NamespacesList"}, - "memoryRecordSchema":{"shape":"MemoryRecordSchema"} - } - }, - "SemanticOverrideConfigurationInput":{ - "type":"structure", - "members":{ - "extraction":{"shape":"SemanticOverrideExtractionConfigurationInput"}, - "consolidation":{"shape":"SemanticOverrideConsolidationConfigurationInput"} - } - }, - "SemanticOverrideConsolidationConfigurationInput":{ - "type":"structure", - "required":[ - "appendToPrompt", - "modelId" - ], - "members":{ - "appendToPrompt":{"shape":"Prompt"}, - "modelId":{"shape":"String"} - } - }, - "SemanticOverrideExtractionConfigurationInput":{ - "type":"structure", - "required":[ - "appendToPrompt", - "modelId" - ], - "members":{ - "appendToPrompt":{"shape":"Prompt"}, - "modelId":{"shape":"String"} - } - }, - "SensitiveJson":{ - "type":"structure", - "members":{}, - "document":true, - "sensitive":true - }, - "SensitiveText":{ - "type":"string", - "min":1, - "sensitive":true - }, - "ServerDefinition":{ - "type":"structure", - "members":{ - "schemaVersion":{"shape":"SchemaVersion"}, - "inlineContent":{"shape":"InlineContent"} - } - }, - "ServerProtocol":{ - "type":"string", - "enum":[ - "MCP", - "HTTP", - "A2A", - "AGUI" - ] - }, - "ServiceException":{ - "type":"structure", - "members":{ - "message":{"shape":"String"} - }, - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true, - "retryable":{"throttling":false} - }, - "ServiceName":{ - "type":"string", - "max":256, - "min":1, - "pattern":"[a-zA-Z0-9._-]+" - }, - "ServiceQuotaExceededException":{ - "type":"structure", - "members":{ - "message":{"shape":"NonBlankString"} - }, - "error":{ - "httpStatusCode":402, - "senderFault":true - }, - "exception":true - }, - "SessionConfig":{ - "type":"structure", - "required":["sessionTimeoutMinutes"], - "members":{ - "sessionTimeoutMinutes":{"shape":"SessionConfigSessionTimeoutMinutesInteger"} - } - }, - "SessionConfigSessionTimeoutMinutesInteger":{ - "type":"integer", - "box":true, - "max":1440, - "min":1 - }, - "SessionConfiguration":{ - "type":"structure", - "members":{ - "sessionTimeoutInSeconds":{"shape":"SessionConfigurationSessionTimeoutInSecondsInteger"} - } - }, - "SessionConfigurationSessionTimeoutInSecondsInteger":{ - "type":"integer", - "box":true, - "max":28800, - "min":900 - }, - "SessionStorageConfiguration":{ - "type":"structure", - "required":["mountPath"], - "members":{ - "mountPath":{"shape":"MountPath"} - } - }, - "SetTokenVaultCMKRequest":{ - "type":"structure", - "required":["kmsConfiguration"], - "members":{ - "tokenVaultId":{"shape":"TokenVaultIdType"}, - "kmsConfiguration":{"shape":"KmsConfiguration"} - } - }, - "SetTokenVaultCMKResponse":{ - "type":"structure", - "required":[ - "tokenVaultId", - "kmsConfiguration", - "lastModifiedDate" - ], - "members":{ - "tokenVaultId":{"shape":"TokenVaultIdType"}, - "kmsConfiguration":{"shape":"KmsConfiguration"}, - "lastModifiedDate":{"shape":"Timestamp"} - } - }, - "SigningAlgorithm":{ - "type":"string", - "enum":[ - "RS256", - "PS256", - "ES256" - ] - }, - "SkillDefinition":{ - "type":"structure", - "members":{ - "schemaVersion":{"shape":"SchemaVersion"}, - "inlineContent":{"shape":"InlineContent"} - } - }, - "SkillMdDefinition":{ - "type":"structure", - "members":{ - "inlineContent":{"shape":"InlineContent"} - } - }, - "SlackOauth2ProviderConfigInput":{ - "type":"structure", - "required":["clientId"], - "members":{ - "clientId":{"shape":"ClientIdType"}, - "clientSecret":{"shape":"DefaultClientSecretType"}, - "clientSecretConfig":{"shape":"SecretReference"}, - "clientSecretSource":{"shape":"SecretSourceType"} - } - }, - "SlackOauth2ProviderConfigOutput":{ - "type":"structure", - "required":["oauthDiscovery"], - "members":{ - "oauthDiscovery":{"shape":"Oauth2Discovery"}, - "clientId":{"shape":"ClientIdType"} - } - }, - "StartPolicyGenerationRequest":{ - "type":"structure", - "required":[ - "policyEngineId", - "resource", - "content", - "name" - ], - "members":{ - "policyEngineId":{ - "shape":"ResourceId", - "location":"uri", - "locationName":"policyEngineId" - }, - "resource":{"shape":"Resource"}, - "content":{"shape":"Content"}, - "name":{"shape":"PolicyGenerationName"}, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - } - } - }, - "StartPolicyGenerationResponse":{ - "type":"structure", - "required":[ - "policyEngineId", - "policyGenerationId", - "name", - "policyGenerationArn", - "resource", - "createdAt", - "updatedAt", - "status", - "statusReasons" - ], - "members":{ - "policyEngineId":{"shape":"ResourceId"}, - "policyGenerationId":{"shape":"ResourceId"}, - "name":{"shape":"PolicyGenerationName"}, - "policyGenerationArn":{"shape":"PolicyGenerationArn"}, - "resource":{"shape":"Resource"}, - "createdAt":{"shape":"DateTimestamp"}, - "updatedAt":{"shape":"DateTimestamp"}, - "status":{"shape":"PolicyGenerationStatus"}, - "findings":{"shape":"String"}, - "statusReasons":{"shape":"PolicyStatusReasons"} - } - }, - "Statement":{ - "type":"string", - "max":10000, - "min":35 - }, - "StaticOverride":{ - "type":"structure", - "required":[ - "bundleArn", - "bundleVersion" - ], - "members":{ - "bundleArn":{"shape":"GatewayConfigurationBundleArn"}, - "bundleVersion":{"shape":"StaticOverrideBundleVersionString"} - } - }, - "StaticOverrideBundleVersionString":{ - "type":"string", - "pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" - }, - "StaticRoute":{ - "type":"structure", - "required":["targetName"], - "members":{ - "targetName":{"shape":"TargetName"} - } - }, - "Status":{ - "type":"string", - "enum":[ - "CREATING", - "CREATE_FAILED", - "UPDATING", - "UPDATE_FAILED", - "READY", - "DELETING", - "DELETE_FAILED" - ] - }, - "StatusReason":{ - "type":"string", - "max":2048, - "min":0 - }, - "StatusReasons":{ - "type":"list", - "member":{"shape":"StatusReason"}, - "max":100, - "min":0 - }, - "StickinessConfiguration":{ - "type":"structure", - "required":["identifier"], - "members":{ - "identifier":{"shape":"StickinessConfigurationIdentifierString"}, - "timeout":{"shape":"StickinessTimeout"} - } - }, - "StickinessConfigurationIdentifierString":{ - "type":"string", - "max":256, - "min":1 - }, - "StickinessTimeout":{ - "type":"integer", - "box":true, - "max":86400, - "min":1 - }, - "StrategyConfiguration":{ - "type":"structure", - "members":{ - "type":{"shape":"OverrideType"}, - "extraction":{"shape":"ExtractionConfiguration"}, - "consolidation":{"shape":"ConsolidationConfiguration"}, - "reflection":{"shape":"ReflectionConfiguration"}, - "selfManagedConfiguration":{"shape":"SelfManagedConfiguration"} - } - }, - "StreamDeliveryResource":{ - "type":"structure", - "members":{ - "kinesis":{"shape":"KinesisResource"} - }, - "union":true - }, - "StreamDeliveryResources":{ - "type":"structure", - "required":["resources"], - "members":{ - "resources":{"shape":"StreamDeliveryResourcesList"} - } - }, - "StreamDeliveryResourcesList":{ - "type":"list", - "member":{"shape":"StreamDeliveryResource"}, - "max":1, - "min":0 - }, - "StreamingConfiguration":{ - "type":"structure", - "members":{ - "enableResponseStreaming":{"shape":"Boolean"} - } - }, - "String":{"type":"string"}, - "StringListValidation":{ - "type":"structure", - "members":{ - "allowedValues":{"shape":"AllowedStringListValuesList"}, - "maxItems":{"shape":"StringListValidationMaxItemsInteger"} - } - }, - "StringListValidationMaxItemsInteger":{ - "type":"integer", - "box":true, - "max":5, - "min":1 - }, - "StringValidation":{ - "type":"structure", - "required":["allowedValues"], - "members":{ - "allowedValues":{"shape":"AllowedStringValuesList"} - } - }, - "StripePrivyAppIdType":{ - "type":"string", - "max":512, - "min":1, - "pattern":"[a-zA-Z0-9\\-_]+" - }, - "StripePrivyAuthorizationIdType":{ - "type":"string", - "max":512, - "min":1, - "pattern":"[a-zA-Z0-9\\-_]+" - }, - "StripePrivyConfigurationInput":{ - "type":"structure", - "required":[ - "appId", - "authorizationId" - ], - "members":{ - "appId":{"shape":"StripePrivyAppIdType"}, - "appSecret":{"shape":"DefaultStripePrivyAppSecretType"}, - "appSecretSource":{"shape":"SecretSourceType"}, - "appSecretConfig":{"shape":"SecretReference"}, - "authorizationPrivateKey":{"shape":"DefaultStripePrivyAuthorizationPrivateKeyType"}, - "authorizationPrivateKeySource":{"shape":"SecretSourceType"}, - "authorizationPrivateKeyConfig":{"shape":"SecretReference"}, - "authorizationId":{"shape":"StripePrivyAuthorizationIdType"} - } - }, - "StripePrivyConfigurationOutput":{ - "type":"structure", - "required":[ - "appId", - "appSecretArn", - "authorizationPrivateKeyArn", - "authorizationId" - ], - "members":{ - "appId":{"shape":"StripePrivyAppIdType"}, - "appSecretArn":{"shape":"Secret"}, - "appSecretJsonKey":{"shape":"SecretJsonKeyType"}, - "appSecretSource":{"shape":"SecretSourceType"}, - "authorizationPrivateKeyArn":{"shape":"Secret"}, - "authorizationPrivateKeyJsonKey":{"shape":"SecretJsonKeyType"}, - "authorizationPrivateKeySource":{"shape":"SecretSourceType"}, - "authorizationId":{"shape":"StripePrivyAuthorizationIdType"} - } - }, - "SubmitRegistryRecordForApprovalRequest":{ - "type":"structure", - "required":[ - "registryId", - "recordId" - ], - "members":{ - "registryId":{ - "shape":"RegistryIdentifier", - "location":"uri", - "locationName":"registryId" - }, - "recordId":{ - "shape":"RecordIdentifier", - "location":"uri", - "locationName":"recordId" - } - } - }, - "SubmitRegistryRecordForApprovalResponse":{ - "type":"structure", - "required":[ - "registryArn", - "recordArn", - "recordId", - "status", - "updatedAt" - ], - "members":{ - "registryArn":{"shape":"RegistryArn"}, - "recordArn":{"shape":"RegistryRecordArn"}, - "recordId":{"shape":"RegistryRecordId"}, - "status":{"shape":"RegistryRecordStatus"}, - "updatedAt":{"shape":"DateTimestamp"} - } - }, - "SubnetId":{ - "type":"string", - "pattern":"subnet-[0-9a-zA-Z]{8,17}" - }, - "SubnetIds":{ - "type":"list", - "member":{"shape":"SubnetId"} - }, - "Subnets":{ - "type":"list", - "member":{"shape":"SubnetId"}, - "max":16, - "min":1 - }, - "SummaryConsolidationOverride":{ - "type":"structure", - "required":[ - "appendToPrompt", - "modelId" - ], - "members":{ - "appendToPrompt":{"shape":"Prompt"}, - "modelId":{"shape":"String"} - } - }, - "SummaryMemoryStrategyInput":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{"shape":"Name"}, - "description":{"shape":"Description"}, - "namespaces":{ - "shape":"NamespacesList", - "deprecated":true, - "deprecatedMessage":"Use namespaceTemplates instead", - "deprecatedSince":"2026-03-02" - }, - "namespaceTemplates":{"shape":"NamespacesList"}, - "memoryRecordSchema":{"shape":"MemoryRecordSchema"} - } - }, - "SummaryOverrideConfigurationInput":{ - "type":"structure", - "members":{ - "consolidation":{"shape":"SummaryOverrideConsolidationConfigurationInput"} - } - }, - "SummaryOverrideConsolidationConfigurationInput":{ - "type":"structure", - "required":[ - "appendToPrompt", - "modelId" - ], - "members":{ - "appendToPrompt":{"shape":"Prompt"}, - "modelId":{"shape":"String"} - } - }, - "SynchronizationConfiguration":{ - "type":"structure", - "members":{ - "fromUrl":{"shape":"FromUrlSynchronizationConfiguration"} - } - }, - "SynchronizationType":{ - "type":"string", - "enum":["URL"] - }, - "SynchronizeGatewayTargetsRequest":{ - "type":"structure", - "required":[ - "gatewayIdentifier", - "targetIdList" - ], - "members":{ - "gatewayIdentifier":{ - "shape":"GatewayIdentifier", - "location":"uri", - "locationName":"gatewayIdentifier" - }, - "targetIdList":{"shape":"TargetIdList"} - } - }, - "SynchronizeGatewayTargetsResponse":{ - "type":"structure", - "members":{ - "targets":{"shape":"GatewayTargetList"} - } - }, - "SystemManagedBlock":{ - "type":"structure", - "required":["managedBy"], - "members":{ - "managedBy":{"shape":"String"} - } - }, - "TagKey":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[a-zA-Z0-9\\s._:/=+@-]*" - }, - "TagKeyList":{ - "type":"list", - "member":{"shape":"TagKey"}, - "max":200, - "min":0 - }, - "TagResourceRequest":{ - "type":"structure", - "required":[ - "resourceArn", - "tags" - ], - "members":{ - "resourceArn":{ - "shape":"TaggableResourcesArn", - "location":"uri", - "locationName":"resourceArn" - }, - "tags":{"shape":"TagsMap"} - } - }, - "TagResourceResponse":{ - "type":"structure", - "members":{} - }, - "TagValue":{ - "type":"string", - "max":256, - "min":0, - "pattern":"[a-zA-Z0-9\\s._:/=+@-]*" - }, - "TaggableResourcesArn":{ - "type":"string", - "max":1011, - "min":20, - "pattern":"arn:(?:[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:([a-z-]+/[^/]+)(?:/[a-z-]+/[^/]+)*" - }, - "TagsMap":{ - "type":"map", - "key":{"shape":"TagKey"}, - "value":{"shape":"TagValue"}, - "max":50, - "min":0 - }, - "TargetConfiguration":{ - "type":"structure", - "members":{ - "mcp":{"shape":"McpTargetConfiguration"}, - "http":{"shape":"HttpTargetConfiguration"}, - "inference":{"shape":"InferenceTargetConfiguration"} - }, - "union":true - }, - "TargetDescription":{ - "type":"string", - "max":200, - "min":1, - "sensitive":true - }, - "TargetId":{ - "type":"string", - "pattern":"[0-9a-zA-Z]{10}" - }, - "TargetIdList":{ - "type":"list", - "member":{"shape":"TargetId"}, - "max":1, - "min":1 - }, - "TargetMaxResults":{ - "type":"integer", - "box":true, - "max":1000, - "min":1 - }, - "TargetName":{ - "type":"string", - "pattern":"([0-9a-zA-Z][-]?){1,100}", - "sensitive":true - }, - "TargetNextToken":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"\\S*" - }, - "TargetProtocolType":{ - "type":"string", - "enum":[ - "MCP", - "HTTP" - ] - }, - "TargetResourcePriority":{ - "type":"integer", - "box":true, - "max":1000, - "min":0 - }, - "TargetStatus":{ - "type":"string", - "enum":[ - "CREATING", - "UPDATING", - "UPDATE_UNSUCCESSFUL", - "DELETING", - "READY", - "FAILED", - "SYNCHRONIZING", - "SYNCHRONIZE_UNSUCCESSFUL", - "CREATE_PENDING_AUTH", - "UPDATE_PENDING_AUTH", - "SYNCHRONIZE_PENDING_AUTH" - ] - }, - "TargetSummaries":{ - "type":"list", - "member":{"shape":"TargetSummary"} - }, - "TargetSummary":{ - "type":"structure", - "required":[ - "targetId", - "name", - "status", - "createdAt", - "updatedAt" - ], - "members":{ - "targetId":{"shape":"TargetId"}, - "name":{"shape":"TargetName"}, - "status":{"shape":"TargetStatus"}, - "description":{"shape":"TargetDescription"}, - "createdAt":{"shape":"DateTimestamp"}, - "updatedAt":{"shape":"DateTimestamp"}, - "resourcePriority":{"shape":"TargetResourcePriority"}, - "lastSynchronizedAt":{"shape":"DateTimestamp"}, - "authorizationData":{"shape":"AuthorizationData"}, - "targetType":{"shape":"TargetType"}, - "listingMode":{"shape":"ListingMode"} - } - }, - "TargetTrafficSplitEntries":{ - "type":"list", - "member":{"shape":"TargetTrafficSplitEntry"}, - "max":2, - "min":2 - }, - "TargetTrafficSplitEntry":{ - "type":"structure", - "required":[ - "name", - "weight", - "targetName" - ], - "members":{ - "name":{"shape":"TargetTrafficSplitEntryNameString"}, - "weight":{"shape":"TargetTrafficSplitEntryWeightInteger"}, - "targetName":{"shape":"TargetName"}, - "description":{"shape":"TargetTrafficSplitEntryDescriptionString"}, - "metadata":{"shape":"TrafficSplitMetadataMap"} - } - }, - "TargetTrafficSplitEntryDescriptionString":{ - "type":"string", - "max":200, - "min":1 - }, - "TargetTrafficSplitEntryNameString":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[a-zA-Z0-9]([a-zA-Z0-9-]{0,62}[a-zA-Z0-9])?" - }, - "TargetTrafficSplitEntryWeightInteger":{ - "type":"integer", - "box":true, - "max":99, - "min":1 - }, - "TargetType":{ - "type":"string", - "enum":[ - "OPEN_API_SCHEMA", - "SMITHY_MODEL", - "MCP_SERVER", - "LAMBDA", - "API_GATEWAY", - "CONNECTOR", - "AGENTCORE_RUNTIME", - "PASSTHROUGH", - "PROVIDER" - ] - }, - "Temperature":{ - "type":"float", - "box":true, - "max":2.0, - "min":0.0 - }, - "TenantIdType":{ - "type":"string", - "max":2048, - "min":1 - }, - "ThrottledException":{ - "type":"structure", - "members":{ - "message":{"shape":"String"} - }, - "error":{ - "httpStatusCode":429, - "senderFault":true - }, - "exception":true, - "retryable":{"throttling":false} - }, - "ThrottlingException":{ - "type":"structure", - "members":{ - "message":{"shape":"NonBlankString"} - }, - "error":{ - "httpStatusCode":429, - "senderFault":true - }, - "exception":true - }, - "TimeBasedTrigger":{ - "type":"structure", - "members":{ - "idleSessionTimeout":{"shape":"Integer"} - } - }, - "TimeBasedTriggerInput":{ - "type":"structure", - "members":{ - "idleSessionTimeout":{"shape":"TimeBasedTriggerInputIdleSessionTimeoutInteger"} - } - }, - "TimeBasedTriggerInputIdleSessionTimeoutInteger":{ - "type":"integer", - "box":true, - "max":3000, - "min":10 - }, - "Timestamp":{"type":"timestamp"}, - "TokenAuthMethod":{ - "type":"string", - "pattern":"(client_secret_post|client_secret_basic)" - }, - "TokenBasedTrigger":{ - "type":"structure", - "members":{ - "tokenCount":{"shape":"Integer"} - } - }, - "TokenBasedTriggerInput":{ - "type":"structure", - "members":{ - "tokenCount":{"shape":"TokenBasedTriggerInputTokenCountInteger"} - } - }, - "TokenBasedTriggerInputTokenCountInteger":{ - "type":"integer", - "box":true, - "max":500000, - "min":100 - }, - "TokenEndpointAuthMethodsType":{ - "type":"list", - "member":{"shape":"TokenAuthMethod"}, - "max":2, - "min":1 - }, - "TokenEndpointType":{"type":"string"}, - "TokenExchangeGrantTypeConfigType":{ - "type":"structure", - "required":["actorTokenContent"], - "members":{ - "actorTokenContent":{"shape":"ActorTokenContentType"}, - "actorTokenScopes":{"shape":"ScopesListType"} - } - }, - "TokenVaultIdType":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[a-zA-Z0-9\\-_]+" - }, - "ToolDefinition":{ - "type":"structure", - "required":[ - "name", - "description", - "inputSchema" - ], - "members":{ - "name":{"shape":"String"}, - "description":{"shape":"String"}, - "inputSchema":{"shape":"SchemaDefinition"}, - "outputSchema":{"shape":"SchemaDefinition"} - }, - "sensitive":true - }, - "ToolDefinitions":{ - "type":"list", - "member":{"shape":"ToolDefinition"} - }, - "ToolSchema":{ - "type":"structure", - "members":{ - "s3":{"shape":"S3Configuration"}, - "inlinePayload":{"shape":"ToolDefinitions"} - }, - "union":true - }, - "ToolSecretArn":{ - "type":"string", - "pattern":"arn:aws(-[a-z-]+)?:secretsmanager:[a-z0-9-]+:[0-9]{12}:secret:[a-zA-Z0-9/_+=.@-]+" - }, - "ToolsDefinition":{ - "type":"structure", - "members":{ - "protocolVersion":{"shape":"SchemaVersion"}, - "inlineContent":{"shape":"InlineContent"} - } - }, - "ToolsFileSystemConfiguration":{ - "type":"structure", - "members":{ - "s3FilesConfiguration":{"shape":"S3FilesConfiguration"}, - "efsConfiguration":{"shape":"EfsConfiguration"} - }, - "union":true - }, - "ToolsFileSystemConfigurations":{ - "type":"list", - "member":{"shape":"ToolsFileSystemConfiguration"}, - "max":10, - "min":0 - }, - "TopK":{ - "type":"integer", - "box":true, - "max":500, - "min":0 - }, - "TopP":{ - "type":"float", - "box":true, - "max":1.0, - "min":0.0 - }, - "TrafficSplitEntries":{ - "type":"list", - "member":{"shape":"TrafficSplitEntry"}, - "max":2, - "min":2 - }, - "TrafficSplitEntry":{ - "type":"structure", - "required":[ - "name", - "weight", - "configurationBundle" - ], - "members":{ - "name":{"shape":"TrafficSplitEntryNameString"}, - "weight":{"shape":"TrafficSplitEntryWeightInteger"}, - "configurationBundle":{"shape":"ConfigurationBundleReference"}, - "description":{"shape":"TrafficSplitEntryDescriptionString"}, - "metadata":{"shape":"TrafficSplitMetadataMap"} - } - }, - "TrafficSplitEntryDescriptionString":{ - "type":"string", - "max":200, - "min":1 - }, - "TrafficSplitEntryNameString":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[a-zA-Z0-9]([a-zA-Z0-9-]{0,62}[a-zA-Z0-9])?" - }, - "TrafficSplitEntryWeightInteger":{ - "type":"integer", - "box":true, - "max":99, - "min":1 - }, - "TrafficSplitMetadataKey":{ - "type":"string", - "max":128, - "min":1 - }, - "TrafficSplitMetadataMap":{ - "type":"map", - "key":{"shape":"TrafficSplitMetadataKey"}, - "value":{"shape":"TrafficSplitMetadataValue"}, - "max":25, - "min":0 - }, - "TrafficSplitMetadataValue":{ - "type":"string", - "max":256, - "min":1 - }, - "TriggerCondition":{ - "type":"structure", - "members":{ - "messageBasedTrigger":{"shape":"MessageBasedTrigger"}, - "tokenBasedTrigger":{"shape":"TokenBasedTrigger"}, - "timeBasedTrigger":{"shape":"TimeBasedTrigger"} - }, - "union":true - }, - "TriggerConditionInput":{ - "type":"structure", - "members":{ - "messageBasedTrigger":{"shape":"MessageBasedTriggerInput"}, - "tokenBasedTrigger":{"shape":"TokenBasedTriggerInput"}, - "timeBasedTrigger":{"shape":"TimeBasedTriggerInput"} - }, - "union":true - }, - "TriggerConditionInputList":{ - "type":"list", - "member":{"shape":"TriggerConditionInput"}, - "min":1 - }, - "TriggerConditionsList":{ - "type":"list", - "member":{"shape":"TriggerCondition"}, - "min":1 - }, - "UnauthorizedException":{ - "type":"structure", - "members":{ - "message":{"shape":"NonBlankString"} - }, - "error":{ - "httpStatusCode":401, - "senderFault":true - }, - "exception":true - }, - "Unit":{ - "type":"structure", - "members":{} - }, - "UntagResourceRequest":{ - "type":"structure", - "required":[ - "resourceArn", - "tagKeys" - ], - "members":{ - "resourceArn":{ - "shape":"TaggableResourcesArn", - "location":"uri", - "locationName":"resourceArn" - }, - "tagKeys":{ - "shape":"TagKeyList", - "location":"querystring", - "locationName":"tagKeys" - } - } - }, - "UntagResourceResponse":{ - "type":"structure", - "members":{} - }, - "UpdateAgentRuntimeEndpointRequest":{ - "type":"structure", - "required":[ - "agentRuntimeId", - "endpointName" - ], - "members":{ - "agentRuntimeId":{ - "shape":"AgentRuntimeId", - "location":"uri", - "locationName":"agentRuntimeId" - }, - "endpointName":{ - "shape":"EndpointName", - "location":"uri", - "locationName":"endpointName" - }, - "agentRuntimeVersion":{"shape":"AgentRuntimeVersion"}, - "description":{"shape":"AgentEndpointDescription"}, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - } - } - }, - "UpdateAgentRuntimeEndpointResponse":{ - "type":"structure", - "required":[ - "agentRuntimeEndpointArn", - "agentRuntimeArn", - "status", - "createdAt", - "lastUpdatedAt" - ], - "members":{ - "liveVersion":{"shape":"AgentRuntimeVersion"}, - "targetVersion":{"shape":"AgentRuntimeVersion"}, - "agentRuntimeEndpointArn":{"shape":"AgentRuntimeEndpointArn"}, - "agentRuntimeArn":{"shape":"AgentRuntimeArn"}, - "status":{"shape":"AgentRuntimeEndpointStatus"}, - "createdAt":{"shape":"DateTimestamp"}, - "lastUpdatedAt":{"shape":"DateTimestamp"} - } - }, - "UpdateAgentRuntimeRequest":{ - "type":"structure", - "required":[ - "agentRuntimeId", - "agentRuntimeArtifact", - "roleArn", - "networkConfiguration" - ], - "members":{ - "agentRuntimeId":{ - "shape":"AgentRuntimeId", - "location":"uri", - "locationName":"agentRuntimeId" - }, - "agentRuntimeArtifact":{"shape":"AgentRuntimeArtifact"}, - "roleArn":{"shape":"RoleArn"}, - "networkConfiguration":{"shape":"NetworkConfiguration"}, - "description":{"shape":"Description"}, - "authorizerConfiguration":{"shape":"AuthorizerConfiguration"}, - "requestHeaderConfiguration":{"shape":"RequestHeaderConfiguration"}, - "protocolConfiguration":{"shape":"ProtocolConfiguration"}, - "lifecycleConfiguration":{"shape":"LifecycleConfiguration"}, - "metadataConfiguration":{"shape":"RuntimeMetadataConfiguration"}, - "environmentVariables":{"shape":"EnvironmentVariablesMap"}, - "filesystemConfigurations":{"shape":"FilesystemConfigurations"}, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - } - } - }, - "UpdateAgentRuntimeResponse":{ - "type":"structure", - "required":[ - "agentRuntimeArn", - "agentRuntimeId", - "agentRuntimeVersion", - "createdAt", - "lastUpdatedAt", - "status" - ], - "members":{ - "agentRuntimeArn":{"shape":"AgentRuntimeArn"}, - "agentRuntimeId":{"shape":"AgentRuntimeId"}, - "workloadIdentityDetails":{"shape":"WorkloadIdentityDetails"}, - "agentRuntimeVersion":{"shape":"AgentRuntimeVersion"}, - "createdAt":{"shape":"DateTimestamp"}, - "lastUpdatedAt":{"shape":"DateTimestamp"}, - "status":{"shape":"AgentRuntimeStatus"} - } - }, - "UpdateApiKeyCredentialProviderRequest":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{"shape":"CredentialProviderName"}, - "apiKey":{"shape":"DefaultApiKeyType"}, - "apiKeySecretConfig":{"shape":"SecretReference"}, - "apiKeySecretSource":{"shape":"SecretSourceType"} - } - }, - "UpdateApiKeyCredentialProviderResponse":{ - "type":"structure", - "required":[ - "apiKeySecretArn", - "name", - "credentialProviderArn", - "createdTime", - "lastUpdatedTime" - ], - "members":{ - "apiKeySecretArn":{"shape":"Secret"}, - "apiKeySecretJsonKey":{"shape":"SecretJsonKeyType"}, - "apiKeySecretSource":{"shape":"SecretSourceType"}, - "name":{"shape":"CredentialProviderName"}, - "credentialProviderArn":{"shape":"ApiKeyCredentialProviderArnType"}, - "createdTime":{"shape":"Timestamp"}, - "lastUpdatedTime":{"shape":"Timestamp"} - } - }, - "UpdateConfigurationBundleRequest":{ - "type":"structure", - "required":["bundleId"], - "members":{ - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - }, - "bundleId":{ - "shape":"ConfigurationBundleId", - "location":"uri", - "locationName":"bundleId" - }, - "bundleName":{"shape":"ConfigurationBundleName"}, - "description":{"shape":"ConfigurationBundleDescription"}, - "components":{"shape":"ComponentConfigurationMap"}, - "parentVersionIds":{"shape":"ConfigurationBundleVersionList"}, - "branchName":{"shape":"BranchName"}, - "commitMessage":{"shape":"UpdateConfigurationBundleRequestCommitMessageString"}, - "createdBy":{"shape":"VersionCreatedBySource"}, - "kmsKeyArn":{"shape":"KmsKeyArn"} - } - }, - "UpdateConfigurationBundleRequestCommitMessageString":{ - "type":"string", - "max":500, - "min":1 - }, - "UpdateConfigurationBundleResponse":{ - "type":"structure", - "required":[ - "bundleArn", - "bundleId", - "versionId", - "updatedAt" - ], - "members":{ - "bundleArn":{"shape":"ConfigurationBundleArn"}, - "bundleId":{"shape":"ConfigurationBundleId"}, - "versionId":{"shape":"ConfigurationBundleVersion"}, - "updatedAt":{"shape":"Timestamp"} - } - }, - "UpdateDatasetExamplesRequest":{ - "type":"structure", - "required":[ - "datasetId", - "examples" - ], - "members":{ - "datasetId":{ - "shape":"DatasetId", - "location":"uri", - "locationName":"datasetId" - }, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - }, - "examples":{"shape":"UpdateDatasetExamplesRequestExamplesList"} - } - }, - "UpdateDatasetExamplesRequestExamplesList":{ - "type":"list", - "member":{"shape":"SensitiveJson"}, - "max":1000, - "min":1 - }, - "UpdateDatasetExamplesResponse":{ - "type":"structure", - "required":[ - "datasetArn", - "datasetId", - "status", - "updatedCount", - "updatedAt" - ], - "members":{ - "datasetArn":{"shape":"DatasetArn"}, - "datasetId":{"shape":"DatasetId"}, - "status":{"shape":"DatasetStatus"}, - "updatedCount":{"shape":"Long"}, - "updatedAt":{"shape":"Timestamp"} - } - }, - "UpdateDatasetRequest":{ - "type":"structure", - "required":["datasetId"], - "members":{ - "datasetId":{ - "shape":"DatasetId", - "location":"uri", - "locationName":"datasetId" - }, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - }, - "description":{"shape":"UpdateDatasetRequestDescriptionString"} - } - }, - "UpdateDatasetRequestDescriptionString":{ - "type":"string", - "max":200, - "min":0 - }, - "UpdateDatasetResponse":{ - "type":"structure", - "required":[ - "datasetArn", - "datasetId", - "updatedAt" - ], - "members":{ - "datasetArn":{"shape":"DatasetArn"}, - "datasetId":{"shape":"DatasetId"}, - "updatedAt":{"shape":"Timestamp"} - } - }, - "UpdateEvaluatorRequest":{ - "type":"structure", - "required":["evaluatorId"], - "members":{ - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - }, - "evaluatorId":{ - "shape":"EvaluatorId", - "location":"uri", - "locationName":"evaluatorId" - }, - "description":{"shape":"EvaluatorDescription"}, - "evaluatorConfig":{"shape":"EvaluatorConfig"}, - "level":{"shape":"EvaluatorLevel"}, - "kmsKeyArn":{"shape":"KmsKeyArn"} - } - }, - "UpdateEvaluatorResponse":{ - "type":"structure", - "required":[ - "evaluatorArn", - "evaluatorId", - "updatedAt", - "status" - ], - "members":{ - "evaluatorArn":{"shape":"EvaluatorArn"}, - "evaluatorId":{"shape":"EvaluatorId"}, - "updatedAt":{"shape":"Timestamp"}, - "status":{"shape":"EvaluatorStatus"} - } - }, - "UpdateGatewayRequest":{ - "type":"structure", - "required":[ - "gatewayIdentifier", - "name", - "roleArn", - "authorizerType" - ], - "members":{ - "gatewayIdentifier":{ - "shape":"GatewayIdentifier", - "location":"uri", - "locationName":"gatewayIdentifier" - }, - "name":{"shape":"GatewayName"}, - "description":{"shape":"GatewayDescription"}, - "roleArn":{"shape":"RoleArn"}, - "protocolType":{"shape":"GatewayProtocolType"}, - "protocolConfiguration":{"shape":"GatewayProtocolConfiguration"}, - "authorizerType":{"shape":"AuthorizerType"}, - "authorizerConfiguration":{"shape":"AuthorizerConfiguration"}, - "kmsKeyArn":{"shape":"KmsKeyArn"}, - "customTransformConfiguration":{"shape":"CustomTransformConfiguration"}, - "interceptorConfigurations":{"shape":"GatewayInterceptorConfigurations"}, - "policyEngineConfiguration":{"shape":"GatewayPolicyEngineConfiguration"}, - "exceptionLevel":{"shape":"ExceptionLevel"}, - "wafConfiguration":{"shape":"WafConfiguration"} - } - }, - "UpdateGatewayResponse":{ - "type":"structure", - "required":[ - "gatewayArn", - "gatewayId", - "createdAt", - "updatedAt", - "status", - "name", - "authorizerType" - ], - "members":{ - "gatewayArn":{"shape":"GatewayArn"}, - "gatewayId":{"shape":"GatewayId"}, - "gatewayUrl":{"shape":"GatewayUrl"}, - "createdAt":{"shape":"DateTimestamp"}, - "updatedAt":{"shape":"DateTimestamp"}, - "status":{"shape":"GatewayStatus"}, - "statusReasons":{"shape":"StatusReasons"}, - "name":{"shape":"GatewayName"}, - "description":{"shape":"GatewayDescription"}, - "roleArn":{"shape":"RoleArn"}, - "protocolType":{"shape":"GatewayProtocolType"}, - "protocolConfiguration":{"shape":"GatewayProtocolConfiguration"}, - "authorizerType":{"shape":"AuthorizerType"}, - "authorizerConfiguration":{"shape":"AuthorizerConfiguration"}, - "kmsKeyArn":{"shape":"KmsKeyArn"}, - "customTransformConfiguration":{"shape":"CustomTransformConfiguration"}, - "interceptorConfigurations":{"shape":"GatewayInterceptorConfigurations"}, - "policyEngineConfiguration":{"shape":"GatewayPolicyEngineConfiguration"}, - "workloadIdentityDetails":{"shape":"WorkloadIdentityDetails"}, - "exceptionLevel":{"shape":"ExceptionLevel"}, - "webAclArn":{"shape":"WebAclArn"}, - "wafConfiguration":{"shape":"WafConfiguration"} - } - }, - "UpdateGatewayRuleRequest":{ - "type":"structure", - "required":[ - "gatewayIdentifier", - "ruleId" - ], - "members":{ - "gatewayIdentifier":{ - "shape":"GatewayIdentifier", - "location":"uri", - "locationName":"gatewayIdentifier" - }, - "ruleId":{ - "shape":"GatewayRuleId", - "location":"uri", - "locationName":"ruleId" - }, - "priority":{"shape":"GatewayRulePriority"}, - "conditions":{"shape":"Conditions"}, - "actions":{"shape":"Actions"}, - "description":{"shape":"GatewayRuleDescription"} - } - }, - "UpdateGatewayRuleResponse":{ - "type":"structure", - "required":[ - "ruleId", - "gatewayArn", - "priority", - "actions", - "createdAt", - "status" - ], - "members":{ - "ruleId":{"shape":"GatewayRuleId"}, - "gatewayArn":{"shape":"GatewayArn"}, - "priority":{"shape":"GatewayRulePriority"}, - "conditions":{"shape":"Conditions"}, - "actions":{"shape":"Actions"}, - "description":{"shape":"GatewayRuleDescription"}, - "createdAt":{"shape":"DateTimestamp"}, - "status":{"shape":"GatewayRuleStatus"}, - "system":{"shape":"SystemManagedBlock"}, - "updatedAt":{"shape":"DateTimestamp"} - } - }, - "UpdateGatewayTargetRequest":{ - "type":"structure", - "required":[ - "gatewayIdentifier", - "targetId", - "targetConfiguration" - ], - "members":{ - "gatewayIdentifier":{ - "shape":"GatewayIdentifier", - "location":"uri", - "locationName":"gatewayIdentifier" - }, - "targetId":{ - "shape":"TargetId", - "location":"uri", - "locationName":"targetId" - }, - "name":{"shape":"TargetName"}, - "description":{"shape":"TargetDescription"}, - "targetConfiguration":{"shape":"TargetConfiguration"}, - "credentialProviderConfigurations":{"shape":"CredentialProviderConfigurations"}, - "metadataConfiguration":{"shape":"MetadataConfiguration"}, - "privateEndpoint":{"shape":"PrivateEndpoint"} - } - }, - "UpdateGatewayTargetResponse":{ - "type":"structure", - "required":[ - "gatewayArn", - "targetId", - "createdAt", - "updatedAt", - "status", - "name", - "targetConfiguration", - "credentialProviderConfigurations" - ], - "members":{ - "gatewayArn":{"shape":"GatewayArn"}, - "targetId":{"shape":"TargetId"}, - "createdAt":{"shape":"DateTimestamp"}, - "updatedAt":{"shape":"DateTimestamp"}, - "status":{"shape":"TargetStatus"}, - "statusReasons":{"shape":"StatusReasons"}, - "name":{"shape":"TargetName"}, - "description":{"shape":"TargetDescription"}, - "targetConfiguration":{"shape":"TargetConfiguration"}, - "credentialProviderConfigurations":{"shape":"CredentialProviderConfigurations"}, - "lastSynchronizedAt":{"shape":"DateTimestamp"}, - "metadataConfiguration":{"shape":"MetadataConfiguration"}, - "privateEndpoint":{"shape":"PrivateEndpoint"}, - "privateEndpointManagedResources":{"shape":"PrivateEndpointManagedResources"}, - "authorizationData":{"shape":"AuthorizationData"}, - "protocolType":{"shape":"TargetProtocolType"} - } - }, - "UpdateHarnessEndpointRequest":{ - "type":"structure", - "required":[ - "harnessId", - "endpointName" - ], - "members":{ - "harnessId":{ - "shape":"HarnessId", - "location":"uri", - "locationName":"harnessId" - }, - "endpointName":{ - "shape":"HarnessEndpointName", - "location":"uri", - "locationName":"endpointName" - }, - "targetVersion":{"shape":"HarnessVersion"}, - "description":{"shape":"HarnessEndpointDescription"}, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - } - } - }, - "UpdateHarnessEndpointResponse":{ - "type":"structure", - "required":["endpoint"], - "members":{ - "endpoint":{"shape":"HarnessEndpoint"} - } - }, - "UpdateHarnessRequest":{ - "type":"structure", - "required":["harnessId"], - "members":{ - "harnessId":{ - "shape":"HarnessId", - "location":"uri", - "locationName":"harnessId" - }, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - }, - "executionRoleArn":{"shape":"RoleArn"}, - "environment":{"shape":"HarnessEnvironmentProviderRequest"}, - "environmentArtifact":{"shape":"UpdatedHarnessEnvironmentArtifact"}, - "environmentVariables":{"shape":"EnvironmentVariablesMap"}, - "authorizerConfiguration":{"shape":"UpdatedAuthorizerConfiguration"}, - "model":{"shape":"HarnessModelConfiguration"}, - "systemPrompt":{"shape":"HarnessSystemPrompt"}, - "tools":{"shape":"HarnessTools"}, - "skills":{"shape":"HarnessSkills"}, - "allowedTools":{"shape":"HarnessAllowedTools"}, - "memory":{"shape":"UpdatedHarnessMemoryConfiguration"}, - "truncation":{"shape":"HarnessTruncationConfiguration"}, - "maxIterations":{"shape":"Integer"}, - "maxTokens":{"shape":"Integer"}, - "timeoutSeconds":{"shape":"Integer"} - } - }, - "UpdateHarnessResponse":{ - "type":"structure", - "required":["harness"], - "members":{ - "harness":{"shape":"Harness"} - } - }, - "UpdateMemoryInput":{ - "type":"structure", - "required":["memoryId"], - "members":{ - "clientToken":{ - "shape":"UpdateMemoryInputClientTokenString", - "idempotencyToken":true - }, - "memoryId":{ - "shape":"MemoryId", - "location":"uri", - "locationName":"memoryId" - }, - "description":{"shape":"Description"}, - "eventExpiryDuration":{"shape":"UpdateMemoryInputEventExpiryDurationInteger"}, - "memoryExecutionRoleArn":{"shape":"Arn"}, - "memoryStrategies":{"shape":"ModifyMemoryStrategies"}, - "addIndexedKeys":{"shape":"IndexedKeysList"}, - "streamDeliveryResources":{"shape":"StreamDeliveryResources"} - } - }, - "UpdateMemoryInputClientTokenString":{ - "type":"string", - "max":500, - "min":0 - }, - "UpdateMemoryInputEventExpiryDurationInteger":{ - "type":"integer", - "box":true, - "max":365, - "min":3 - }, - "UpdateMemoryOutput":{ - "type":"structure", - "members":{ - "memory":{"shape":"Memory"} - } - }, - "UpdateOauth2CredentialProviderRequest":{ - "type":"structure", - "required":[ - "name", - "credentialProviderVendor", - "oauth2ProviderConfigInput" - ], - "members":{ - "name":{"shape":"CredentialProviderName"}, - "credentialProviderVendor":{"shape":"CredentialProviderVendorType"}, - "oauth2ProviderConfigInput":{"shape":"Oauth2ProviderConfigInput"} - } - }, - "UpdateOauth2CredentialProviderResponse":{ - "type":"structure", - "required":[ - "clientSecretArn", - "name", - "credentialProviderVendor", - "credentialProviderArn", - "oauth2ProviderConfigOutput", - "createdTime", - "lastUpdatedTime" - ], - "members":{ - "clientSecretArn":{"shape":"Secret"}, - "clientSecretJsonKey":{"shape":"SecretJsonKeyType"}, - "clientSecretSource":{"shape":"SecretSourceType"}, - "name":{"shape":"CredentialProviderName"}, - "credentialProviderVendor":{"shape":"CredentialProviderVendorType"}, - "credentialProviderArn":{"shape":"CredentialProviderArnType"}, - "callbackUrl":{"shape":"String"}, - "oauth2ProviderConfigOutput":{"shape":"Oauth2ProviderConfigOutput"}, - "createdTime":{"shape":"Timestamp"}, - "lastUpdatedTime":{"shape":"Timestamp"}, - "status":{"shape":"Status"} - } - }, - "UpdateOnlineEvaluationConfigRequest":{ - "type":"structure", - "required":["onlineEvaluationConfigId"], - "members":{ - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - }, - "onlineEvaluationConfigId":{ - "shape":"OnlineEvaluationConfigId", - "location":"uri", - "locationName":"onlineEvaluationConfigId" - }, - "description":{"shape":"EvaluationConfigDescription"}, - "rule":{"shape":"Rule"}, - "dataSourceConfig":{"shape":"DataSourceConfig"}, - "evaluators":{"shape":"EvaluatorList"}, - "insights":{"shape":"InsightList"}, - "clusteringConfig":{"shape":"ClusteringConfig"}, - "evaluationExecutionRoleArn":{"shape":"RoleArn"}, - "executionStatus":{"shape":"OnlineEvaluationExecutionStatus"} - } - }, - "UpdateOnlineEvaluationConfigResponse":{ - "type":"structure", - "required":[ - "onlineEvaluationConfigArn", - "onlineEvaluationConfigId", - "updatedAt", - "status", - "executionStatus" - ], - "members":{ - "onlineEvaluationConfigArn":{"shape":"OnlineEvaluationConfigArn"}, - "onlineEvaluationConfigId":{"shape":"OnlineEvaluationConfigId"}, - "updatedAt":{"shape":"Timestamp"}, - "status":{"shape":"OnlineEvaluationConfigStatus"}, - "executionStatus":{"shape":"OnlineEvaluationExecutionStatus"}, - "failureReason":{"shape":"String"} - } - }, - "UpdatePaymentConnectorRequest":{ - "type":"structure", - "required":[ - "paymentManagerId", - "paymentConnectorId" - ], - "members":{ - "paymentManagerId":{ - "shape":"PaymentManagerId", - "location":"uri", - "locationName":"paymentManagerId" - }, - "paymentConnectorId":{ - "shape":"PaymentConnectorId", - "location":"uri", - "locationName":"paymentConnectorId" - }, - "description":{"shape":"PaymentsDescription"}, - "type":{"shape":"PaymentConnectorType"}, - "credentialProviderConfigurations":{"shape":"CredentialsProviderConfigurations"}, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - } - } - }, - "UpdatePaymentConnectorResponse":{ - "type":"structure", - "required":[ - "paymentConnectorId", - "paymentManagerId", - "name", - "type", - "credentialProviderConfigurations", - "lastUpdatedAt", - "status" - ], - "members":{ - "paymentConnectorId":{"shape":"PaymentConnectorId"}, - "paymentManagerId":{"shape":"PaymentManagerId"}, - "name":{"shape":"PaymentConnectorName"}, - "type":{"shape":"PaymentConnectorType"}, - "credentialProviderConfigurations":{"shape":"CredentialsProviderConfigurations"}, - "lastUpdatedAt":{"shape":"DateTimestamp"}, - "status":{"shape":"PaymentConnectorStatus"} - } - }, - "UpdatePaymentCredentialProviderRequest":{ - "type":"structure", - "required":[ - "name", - "credentialProviderVendor", - "providerConfigurationInput" - ], - "members":{ - "name":{"shape":"CredentialProviderName"}, - "credentialProviderVendor":{"shape":"PaymentCredentialProviderVendorType"}, - "providerConfigurationInput":{"shape":"PaymentProviderConfigurationInput"} - } - }, - "UpdatePaymentCredentialProviderResponse":{ - "type":"structure", - "required":[ - "name", - "credentialProviderVendor", - "credentialProviderArn", - "providerConfigurationOutput", - "createdTime", - "lastUpdatedTime" - ], - "members":{ - "name":{"shape":"CredentialProviderName"}, - "credentialProviderVendor":{"shape":"PaymentCredentialProviderVendorType"}, - "credentialProviderArn":{"shape":"PaymentCredentialProviderArnType"}, - "providerConfigurationOutput":{"shape":"PaymentProviderConfigurationOutput"}, - "createdTime":{"shape":"Timestamp"}, - "lastUpdatedTime":{"shape":"Timestamp"} - } - }, - "UpdatePaymentManagerRequest":{ - "type":"structure", - "required":["paymentManagerId"], - "members":{ - "paymentManagerId":{ - "shape":"PaymentManagerId", - "location":"uri", - "locationName":"paymentManagerId" - }, - "description":{"shape":"PaymentsDescription"}, - "authorizerType":{"shape":"PaymentsAuthorizerType"}, - "authorizerConfiguration":{"shape":"AuthorizerConfiguration"}, - "roleArn":{"shape":"RoleArn"}, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - } - } - }, - "UpdatePaymentManagerResponse":{ - "type":"structure", - "required":[ - "paymentManagerArn", - "paymentManagerId", - "name", - "authorizerType", - "roleArn", - "lastUpdatedAt", - "status" - ], - "members":{ - "paymentManagerArn":{"shape":"PaymentManagerArn"}, - "paymentManagerId":{"shape":"PaymentManagerId"}, - "name":{"shape":"PaymentManagerName"}, - "authorizerType":{"shape":"PaymentsAuthorizerType"}, - "roleArn":{"shape":"RoleArn"}, - "workloadIdentityDetails":{"shape":"WorkloadIdentityDetails"}, - "lastUpdatedAt":{"shape":"DateTimestamp"}, - "status":{"shape":"PaymentManagerStatus"} - } - }, - "UpdatePolicyEngineRequest":{ - "type":"structure", - "required":["policyEngineId"], - "members":{ - "policyEngineId":{ - "shape":"ResourceId", - "location":"uri", - "locationName":"policyEngineId" - }, - "description":{"shape":"UpdatedDescription"} - } - }, - "UpdatePolicyEngineResponse":{ - "type":"structure", - "required":[ - "policyEngineId", - "name", - "createdAt", - "updatedAt", - "policyEngineArn", - "status", - "statusReasons" - ], - "members":{ - "policyEngineId":{"shape":"ResourceId"}, - "name":{"shape":"PolicyEngineName"}, - "createdAt":{"shape":"DateTimestamp"}, - "updatedAt":{"shape":"DateTimestamp"}, - "policyEngineArn":{"shape":"PolicyEngineArn"}, - "status":{"shape":"PolicyEngineStatus"}, - "encryptionKeyArn":{"shape":"KmsKeyArn"}, - "description":{"shape":"Description"}, - "statusReasons":{"shape":"PolicyStatusReasons"} - } - }, - "UpdatePolicyRequest":{ - "type":"structure", - "required":[ - "policyEngineId", - "policyId" - ], - "members":{ - "policyEngineId":{ - "shape":"ResourceId", - "location":"uri", - "locationName":"policyEngineId" - }, - "policyId":{ - "shape":"ResourceId", - "location":"uri", - "locationName":"policyId" - }, - "description":{"shape":"UpdatedDescription"}, - "definition":{"shape":"PolicyDefinition"}, - "validationMode":{"shape":"PolicyValidationMode"}, - "enforcementMode":{"shape":"EnforcementMode"} - } - }, - "UpdatePolicyResponse":{ - "type":"structure", - "required":[ - "policyId", - "name", - "policyEngineId", - "createdAt", - "updatedAt", - "policyArn", - "status", - "definition", - "statusReasons" - ], - "members":{ - "policyId":{"shape":"ResourceId"}, - "name":{"shape":"PolicyName"}, - "policyEngineId":{"shape":"ResourceId"}, - "createdAt":{"shape":"DateTimestamp"}, - "updatedAt":{"shape":"DateTimestamp"}, - "policyArn":{"shape":"PolicyArn"}, - "status":{"shape":"PolicyStatus"}, - "enforcementMode":{"shape":"EnforcementMode"}, - "definition":{"shape":"PolicyDefinition"}, - "description":{"shape":"Description"}, - "statusReasons":{"shape":"PolicyStatusReasons"} - } - }, - "UpdateRegistryRecordRequest":{ - "type":"structure", - "required":[ - "registryId", - "recordId" - ], - "members":{ - "registryId":{ - "shape":"RegistryIdentifier", - "location":"uri", - "locationName":"registryId" - }, - "recordId":{ - "shape":"RecordIdentifier", - "location":"uri", - "locationName":"recordId" - }, - "name":{"shape":"RegistryRecordName"}, - "description":{"shape":"UpdatedDescription"}, - "descriptorType":{"shape":"DescriptorType"}, - "descriptors":{"shape":"UpdatedDescriptors"}, - "recordVersion":{"shape":"RegistryRecordVersion"}, - "synchronizationType":{"shape":"UpdatedSynchronizationType"}, - "synchronizationConfiguration":{"shape":"UpdatedSynchronizationConfiguration"}, - "triggerSynchronization":{"shape":"Boolean"} - } - }, - "UpdateRegistryRecordResponse":{ - "type":"structure", - "required":[ - "registryArn", - "recordArn", - "recordId", - "name", - "descriptorType", - "descriptors", - "status", - "createdAt", - "updatedAt" - ], - "members":{ - "registryArn":{"shape":"RegistryArn"}, - "recordArn":{"shape":"RegistryRecordArn"}, - "recordId":{"shape":"RegistryRecordId"}, - "name":{"shape":"RegistryRecordName"}, - "description":{"shape":"Description"}, - "descriptorType":{"shape":"DescriptorType"}, - "descriptors":{"shape":"Descriptors"}, - "recordVersion":{"shape":"RegistryRecordVersion"}, - "status":{"shape":"RegistryRecordStatus"}, - "createdAt":{"shape":"DateTimestamp"}, - "updatedAt":{"shape":"DateTimestamp"}, - "statusReason":{"shape":"String"}, - "synchronizationType":{"shape":"SynchronizationType"}, - "synchronizationConfiguration":{"shape":"SynchronizationConfiguration"} - } - }, - "UpdateRegistryRecordStatusRequest":{ - "type":"structure", - "required":[ - "registryId", - "recordId", - "status", - "statusReason" - ], - "members":{ - "registryId":{ - "shape":"RegistryIdentifier", - "location":"uri", - "locationName":"registryId" - }, - "recordId":{ - "shape":"RecordIdentifier", - "location":"uri", - "locationName":"recordId" - }, - "status":{"shape":"RegistryRecordStatus"}, - "statusReason":{"shape":"UpdateRegistryRecordStatusRequestStatusReasonString"} - } - }, - "UpdateRegistryRecordStatusRequestStatusReasonString":{ - "type":"string", - "max":255, - "min":0 - }, - "UpdateRegistryRecordStatusResponse":{ - "type":"structure", - "required":[ - "registryArn", - "recordArn", - "recordId", - "status", - "statusReason", - "updatedAt" - ], - "members":{ - "registryArn":{"shape":"RegistryArn"}, - "recordArn":{"shape":"RegistryRecordArn"}, - "recordId":{"shape":"RegistryRecordId"}, - "status":{"shape":"RegistryRecordStatus"}, - "statusReason":{"shape":"String"}, - "updatedAt":{"shape":"DateTimestamp"} - } - }, - "UpdateRegistryRequest":{ - "type":"structure", - "required":["registryId"], - "members":{ - "registryId":{ - "shape":"RegistryIdentifier", - "location":"uri", - "locationName":"registryId" - }, - "name":{"shape":"RegistryName"}, - "description":{"shape":"UpdatedDescription"}, - "authorizerConfiguration":{"shape":"UpdatedAuthorizerConfiguration"}, - "approvalConfiguration":{"shape":"UpdatedApprovalConfiguration"} - } - }, - "UpdateRegistryResponse":{ - "type":"structure", - "required":[ - "name", - "registryId", - "registryArn", - "status", - "createdAt", - "updatedAt" - ], - "members":{ - "name":{"shape":"RegistryName"}, - "description":{"shape":"Description"}, - "registryId":{"shape":"RegistryId"}, - "registryArn":{"shape":"RegistryArn"}, - "authorizerType":{"shape":"RegistryAuthorizerType"}, - "authorizerConfiguration":{"shape":"AuthorizerConfiguration"}, - "approvalConfiguration":{"shape":"ApprovalConfiguration"}, - "status":{"shape":"RegistryStatus"}, - "statusReason":{"shape":"String"}, - "createdAt":{"shape":"DateTimestamp"}, - "updatedAt":{"shape":"DateTimestamp"} - } - }, - "UpdateWorkloadIdentityRequest":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{"shape":"WorkloadIdentityNameType"}, - "allowedResourceOauth2ReturnUrls":{"shape":"ResourceOauth2ReturnUrlListType"} - } - }, - "UpdateWorkloadIdentityResponse":{ - "type":"structure", - "required":[ - "name", - "workloadIdentityArn", - "createdTime", - "lastUpdatedTime" - ], - "members":{ - "name":{"shape":"WorkloadIdentityNameType"}, - "workloadIdentityArn":{"shape":"WorkloadIdentityArnType"}, - "allowedResourceOauth2ReturnUrls":{"shape":"ResourceOauth2ReturnUrlListType"}, - "createdTime":{"shape":"Timestamp"}, - "lastUpdatedTime":{"shape":"Timestamp"} - } - }, - "UpdatedA2aDescriptor":{ - "type":"structure", - "members":{ - "optionalValue":{"shape":"A2aDescriptor"} - } - }, - "UpdatedAgentSkillsDescriptor":{ - "type":"structure", - "members":{ - "optionalValue":{"shape":"UpdatedAgentSkillsDescriptorFields"} - } - }, - "UpdatedAgentSkillsDescriptorFields":{ - "type":"structure", - "members":{ - "skillMd":{"shape":"UpdatedSkillMdDefinition"}, - "skillDefinition":{"shape":"UpdatedSkillDefinition"} - } - }, - "UpdatedApprovalConfiguration":{ - "type":"structure", - "members":{ - "optionalValue":{"shape":"ApprovalConfiguration"} - } - }, - "UpdatedAuthorizerConfiguration":{ - "type":"structure", - "members":{ - "optionalValue":{"shape":"AuthorizerConfiguration"} - } - }, - "UpdatedCustomDescriptor":{ - "type":"structure", - "members":{ - "optionalValue":{"shape":"CustomDescriptor"} - } - }, - "UpdatedDescription":{ - "type":"structure", - "members":{ - "optionalValue":{"shape":"Description"} - } - }, - "UpdatedDescriptors":{ - "type":"structure", - "members":{ - "optionalValue":{"shape":"UpdatedDescriptorsUnion"} - } - }, - "UpdatedDescriptorsUnion":{ - "type":"structure", - "members":{ - "mcp":{"shape":"UpdatedMcpDescriptor"}, - "a2a":{"shape":"UpdatedA2aDescriptor"}, - "custom":{"shape":"UpdatedCustomDescriptor"}, - "agentSkills":{"shape":"UpdatedAgentSkillsDescriptor"} - } - }, - "UpdatedHarnessEnvironmentArtifact":{ - "type":"structure", - "members":{ - "optionalValue":{"shape":"HarnessEnvironmentArtifact"} - } - }, - "UpdatedHarnessMemoryConfiguration":{ - "type":"structure", - "members":{ - "optionalValue":{"shape":"HarnessMemoryConfiguration"} - } - }, - "UpdatedMcpDescriptor":{ - "type":"structure", - "members":{ - "optionalValue":{"shape":"UpdatedMcpDescriptorFields"} - } - }, - "UpdatedMcpDescriptorFields":{ - "type":"structure", - "members":{ - "server":{"shape":"UpdatedServerDefinition"}, - "tools":{"shape":"UpdatedToolsDefinition"} - } - }, - "UpdatedServerDefinition":{ - "type":"structure", - "members":{ - "optionalValue":{"shape":"ServerDefinition"} - } - }, - "UpdatedSkillDefinition":{ - "type":"structure", - "members":{ - "optionalValue":{"shape":"SkillDefinition"} - } - }, - "UpdatedSkillMdDefinition":{ - "type":"structure", - "members":{ - "optionalValue":{"shape":"SkillMdDefinition"} - } - }, - "UpdatedSynchronizationConfiguration":{ - "type":"structure", - "members":{ - "optionalValue":{"shape":"SynchronizationConfiguration"} - } - }, - "UpdatedSynchronizationType":{ - "type":"structure", - "members":{ - "optionalValue":{"shape":"SynchronizationType"} - } - }, - "UpdatedToolsDefinition":{ - "type":"structure", - "members":{ - "optionalValue":{"shape":"ToolsDefinition"} - } - }, - "UserPreferenceConsolidationOverride":{ - "type":"structure", - "required":[ - "appendToPrompt", - "modelId" - ], - "members":{ - "appendToPrompt":{"shape":"Prompt"}, - "modelId":{"shape":"String"} - } - }, - "UserPreferenceExtractionOverride":{ - "type":"structure", - "required":[ - "appendToPrompt", - "modelId" - ], - "members":{ - "appendToPrompt":{"shape":"Prompt"}, - "modelId":{"shape":"String"} - } - }, - "UserPreferenceMemoryStrategyInput":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{"shape":"Name"}, - "description":{"shape":"Description"}, - "namespaces":{ - "shape":"NamespacesList", - "deprecated":true, - "deprecatedMessage":"Use namespaceTemplates instead", - "deprecatedSince":"2026-03-02" - }, - "namespaceTemplates":{"shape":"NamespacesList"}, - "memoryRecordSchema":{"shape":"MemoryRecordSchema"} - } - }, - "UserPreferenceOverrideConfigurationInput":{ - "type":"structure", - "members":{ - "extraction":{"shape":"UserPreferenceOverrideExtractionConfigurationInput"}, - "consolidation":{"shape":"UserPreferenceOverrideConsolidationConfigurationInput"} - } - }, - "UserPreferenceOverrideConsolidationConfigurationInput":{ - "type":"structure", - "required":[ - "appendToPrompt", - "modelId" - ], - "members":{ - "appendToPrompt":{"shape":"Prompt"}, - "modelId":{"shape":"String"} - } - }, - "UserPreferenceOverrideExtractionConfigurationInput":{ - "type":"structure", - "required":[ - "appendToPrompt", - "modelId" - ], - "members":{ - "appendToPrompt":{"shape":"Prompt"}, - "modelId":{"shape":"String"} - } - }, - "Validation":{ - "type":"structure", - "members":{ - "stringValidation":{"shape":"StringValidation"}, - "stringListValidation":{"shape":"StringListValidation"}, - "numberValidation":{"shape":"NumberValidation"} - }, - "union":true - }, - "ValidationException":{ - "type":"structure", - "required":[ - "message", - "reason" - ], - "members":{ - "message":{"shape":"String"}, - "reason":{"shape":"ValidationExceptionReason"}, - "fieldList":{"shape":"ValidationExceptionFieldList"} - }, - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "ValidationExceptionField":{ - "type":"structure", - "required":[ - "name", - "message" - ], - "members":{ - "name":{"shape":"String"}, - "message":{"shape":"String"} - } - }, - "ValidationExceptionFieldList":{ - "type":"list", - "member":{"shape":"ValidationExceptionField"} - }, - "ValidationExceptionReason":{ - "type":"string", - "enum":[ - "CannotParse", - "FieldValidationFailed", - "IdempotentParameterMismatchException", - "EventInOtherSession", - "ResourceConflict" - ] - }, - "VersionCreatedBySource":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{"shape":"String"}, - "arn":{"shape":"String"} - } - }, - "VersionFilter":{ - "type":"structure", - "members":{ - "branchName":{"shape":"BranchName"}, - "createdByName":{"shape":"String"}, - "latestPerBranch":{"shape":"Boolean"} - } - }, - "VersionLineageMetadata":{ - "type":"structure", - "members":{ - "parentVersionIds":{"shape":"ConfigurationBundleVersionList"}, - "branchName":{"shape":"BranchName"}, - "createdBy":{"shape":"VersionCreatedBySource"}, - "commitMessage":{"shape":"VersionLineageMetadataCommitMessageString"} - } - }, - "VersionLineageMetadataCommitMessageString":{ - "type":"string", - "max":500, - "min":1 - }, - "VpcConfig":{ - "type":"structure", - "required":[ - "securityGroups", - "subnets" - ], - "members":{ - "securityGroups":{"shape":"SecurityGroups"}, - "subnets":{"shape":"Subnets"}, - "requireServiceS3Endpoint":{"shape":"Boolean"} - } - }, - "VpcIdentifier":{ - "type":"string", - "pattern":"vpc-(([0-9a-z]{8})|([0-9a-z]{17}))" - }, - "WafConfiguration":{ - "type":"structure", - "members":{ - "failureMode":{"shape":"WafFailureMode"} - } - }, - "WafFailureMode":{ - "type":"string", - "enum":[ - "FAIL_CLOSE", - "FAIL_OPEN" - ] - }, - "WebAclArn":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"arn:[a-z0-9\\-]+:wafv2:[a-z0-9\\-]+:[0-9]{12}:regional/webacl/.+" - }, - "WeightedOverride":{ - "type":"structure", - "required":["trafficSplit"], - "members":{ - "trafficSplit":{"shape":"TrafficSplitEntries"} - } - }, - "WeightedRoute":{ - "type":"structure", - "required":["trafficSplit"], - "members":{ - "trafficSplit":{"shape":"TargetTrafficSplitEntries"} - } - }, - "WorkloadIdentityArn":{ - "type":"string", - "max":1024, - "min":1 - }, - "WorkloadIdentityArnType":{ - "type":"string", - "max":1024, - "min":1 - }, - "WorkloadIdentityDetails":{ - "type":"structure", - "required":["workloadIdentityArn"], - "members":{ - "workloadIdentityArn":{"shape":"WorkloadIdentityArn"} - } - }, - "WorkloadIdentityList":{ - "type":"list", - "member":{"shape":"WorkloadIdentityType"} - }, - "WorkloadIdentityNameListType":{ - "type":"list", - "member":{"shape":"WorkloadIdentityNameType"}, - "max":10, - "min":1 - }, - "WorkloadIdentityNameType":{ - "type":"string", - "max":255, - "min":3, - "pattern":"[A-Za-z0-9_.-]+" - }, - "WorkloadIdentityType":{ - "type":"structure", - "required":[ - "name", - "workloadIdentityArn" - ], - "members":{ - "name":{"shape":"WorkloadIdentityNameType"}, - "workloadIdentityArn":{"shape":"WorkloadIdentityArnType"} - } - }, - "entryPoint":{ - "type":"string", - "max":128, - "min":1 - } - } -} diff --git a/tools/code-generation/api-descriptions/bedrock-agentcore-control/2023-06-05/docs-2.json b/tools/code-generation/api-descriptions/bedrock-agentcore-control/2023-06-05/docs-2.json deleted file mode 100644 index c51d27a42a4a..000000000000 --- a/tools/code-generation/api-descriptions/bedrock-agentcore-control/2023-06-05/docs-2.json +++ /dev/null @@ -1,8719 +0,0 @@ -{ - "version": "2.0", - "service": "

Welcome to the Amazon Bedrock AgentCore Control plane API reference. Control plane actions configure, create, modify, and monitor Amazon Web Services resources.

", - "operations": { - "AddDatasetExamples": "

Adds examples to the dataset's DRAFT. All examples are validated against the dataset's schema type before any writes occur. If any example fails validation, the entire batch is rejected (all-or-nothing semantics).

", - "CreateAgentRuntime": "

Creates an Amazon Bedrock AgentCore Runtime.

", - "CreateAgentRuntimeEndpoint": "

Creates an AgentCore Runtime endpoint.

", - "CreateApiKeyCredentialProvider": "

Creates a new API key credential provider.

", - "CreateBrowser": "

Creates a custom browser.

", - "CreateBrowserProfile": "

Creates a browser profile in Amazon Bedrock AgentCore. A browser profile stores persistent browser data such as cookies, local storage, session storage, and browsing history that can be saved from browser sessions and reused in subsequent sessions.

", - "CreateCodeInterpreter": "

Creates a custom code interpreter.

", - "CreateConfigurationBundle": "

Creates a new configuration bundle resource. A configuration bundle stores versioned component configurations for agent evaluation workflows.

", - "CreateDataset": "

Creates a new dataset resource asynchronously. Returns immediately with status CREATING. Poll GetDataset until status transitions to ACTIVE or CREATE_FAILED.

", - "CreateDatasetVersion": "

Publishes the current DRAFT as a new numbered version. The DRAFT is preserved and remains editable after publishing. Returns immediately with status UPDATING. Poll GetDataset until status transitions to ACTIVE or UPDATE_FAILED.

", - "CreateEvaluator": "

Creates a custom evaluator for agent quality assessment. Custom evaluators can use either LLM-as-a-Judge configurations with user-defined prompts, rating scales, and model settings, or code-based configurations with customer-managed Lambda functions to evaluate agent performance at tool call, trace, or session levels.

", - "CreateGateway": "

Creates a gateway for Amazon Bedrock Agent. A gateway serves as an integration point between your agent and external services.

If you specify CUSTOM_JWT as the authorizerType, you must provide an authorizerConfiguration.

", - "CreateGatewayRule": "

Creates a rule for a gateway. Rules define conditions and actions that control how requests are routed and processed through the gateway, including principal-based access control and path-based routing.

", - "CreateGatewayTarget": "

Creates a target for a gateway. A target defines an endpoint that the gateway can connect to.

", - "CreateHarness": "

Operation to create a harness.

", - "CreateHarnessEndpoint": "

Operation to create a harness endpoint.

", - "CreateMemory": "

Creates a new Amazon Bedrock AgentCore Memory resource.

", - "CreateOauth2CredentialProvider": "

Creates a new OAuth2 credential provider.

", - "CreateOnlineEvaluationConfig": "

Creates an online evaluation configuration for continuous monitoring of agent performance. Online evaluation automatically samples live traffic from CloudWatch logs at specified rates and applies evaluators to assess agent quality in production.

", - "CreatePaymentConnector": "

Creates a new payment connector for a payment manager. A payment connector integrates with a supported payment provider to enable payment processing capabilities.

", - "CreatePaymentCredentialProvider": "

Creates a new payment credential provider for storing authentication credentials used by payment connectors to communicate with external payment providers.

", - "CreatePaymentManager": "

Creates a new payment manager in your Amazon Web Services account. A payment manager serves as the top-level resource for managing payment processing capabilities, including payment connectors that integrate with supported payment providers.

If you specify CUSTOM_JWT as the authorizerType, you must provide an authorizerConfiguration.

", - "CreatePolicy": "

Creates a policy within the AgentCore Policy system. Policies provide real-time, deterministic control over agentic interactions with AgentCore Gateway. Using the Cedar policy language, you can define fine-grained policies that specify which interactions with Gateway tools are permitted based on input parameters and OAuth claims, ensuring agents operate within defined boundaries and business rules. The policy is validated during creation against the Cedar schema generated from the Gateway's tools' input schemas, which defines the available tools, their parameters, and expected data types. This is an asynchronous operation. Use the GetPolicy operation to poll the status field to track completion.

", - "CreatePolicyEngine": "

Creates a new policy engine within the AgentCore Policy system. A policy engine is a collection of policies that evaluates and authorizes agent tool calls. When associated with Gateways (each Gateway can be associated with at most one policy engine, but multiple Gateways can be associated with the same engine), the policy engine intercepts all agent requests and determines whether to allow or deny each action based on the defined policies. This is an asynchronous operation. Use the GetPolicyEngine operation to poll the status field to track completion.

", - "CreateRegistry": "

Creates a new registry in your Amazon Web Services account. A registry serves as a centralized catalog for organizing and managing registry records, including MCP servers, A2A agents, agent skills, and custom resource types.

If you specify CUSTOM_JWT as the authorizerType, you must provide an authorizerConfiguration.

", - "CreateRegistryRecord": "

Creates a new registry record within the specified registry. A registry record represents an individual AI resource's metadata in the registry. This could be an MCP server (and associated tools), A2A agent, agent skill, or a custom resource with a custom schema.

The record is processed asynchronously and returns HTTP 202 Accepted.

", - "CreateWorkloadIdentity": "

Creates a new workload identity.

", - "DeleteAgentRuntime": "

Deletes an Amazon Bedrock AgentCore Runtime.

", - "DeleteAgentRuntimeEndpoint": "

Deletes an AAgentCore Runtime endpoint.

", - "DeleteApiKeyCredentialProvider": "

Deletes an API key credential provider.

", - "DeleteBrowser": "

Deletes a custom browser.

", - "DeleteBrowserProfile": "

Deletes a browser profile.

", - "DeleteCodeInterpreter": "

Deletes a custom code interpreter.

", - "DeleteConfigurationBundle": "

Deletes a configuration bundle and all of its versions.

", - "DeleteDataset": "

Deletes a dataset version or an entire dataset asynchronously. If datasetVersion is absent, deletes all versions and the dataset record itself. If provided, deletes only that specific version.

", - "DeleteDatasetExamples": "

Deletes specific examples by ID from DRAFT. All example IDs are validated before any deletes occur. If any ID does not exist in DRAFT, the entire batch is rejected (all-or-nothing semantics).

", - "DeleteEvaluator": "

Deletes a custom evaluator. Builtin evaluators cannot be deleted. The evaluator must not be referenced by any active online evaluation configurations.

", - "DeleteGateway": "

Deletes a gateway.

", - "DeleteGatewayRule": "

Deletes a gateway rule.

", - "DeleteGatewayTarget": "

Deletes a gateway target.

You cannot delete a target that is in a pending authorization state (CREATE_PENDING_AUTH, UPDATE_PENDING_AUTH, or SYNCHRONIZE_PENDING_AUTH). Wait for the authorization to complete or fail before deleting the target.

", - "DeleteHarness": "

Operation to delete a Harness.

", - "DeleteHarnessEndpoint": "

Operation to delete a harness endpoint.

", - "DeleteMemory": "

Deletes an Amazon Bedrock AgentCore Memory resource.

", - "DeleteOauth2CredentialProvider": "

Deletes an OAuth2 credential provider.

", - "DeleteOnlineEvaluationConfig": "

Deletes an online evaluation configuration and stops any ongoing evaluation processes associated with it.

", - "DeletePaymentConnector": "

Deletes a payment connector.

", - "DeletePaymentCredentialProvider": "

Deletes a payment credential provider and its associated stored credentials.

", - "DeletePaymentManager": "

Deletes a payment manager. All payment connectors associated with the payment manager must be deleted before the payment manager can be deleted. This operation initiates the deletion process asynchronously.

", - "DeletePolicy": "

Deletes an existing policy from the AgentCore Policy system. Once deleted, the policy can no longer be used for agent behavior control and all references to it become invalid. This is an asynchronous operation. Use the GetPolicy operation to poll the status field to track completion.

", - "DeletePolicyEngine": "

Deletes an existing policy engine from the AgentCore Policy system. The policy engine must not have any associated policies before deletion. Once deleted, the policy engine and all its configurations become unavailable for policy management and evaluation. This is an asynchronous operation. Use the GetPolicyEngine operation to poll the status field to track completion.

", - "DeleteRegistry": "

Deletes a registry. The registry must contain zero records before it can be deleted. This operation initiates the deletion process asynchronously.

", - "DeleteRegistryRecord": "

Deletes a registry record. The record's status transitions to DELETING and the record is removed asynchronously.

", - "DeleteResourcePolicy": "

Deletes the resource-based policy for a specified resource.

This feature is currently available only for AgentCore Runtime and Gateway.

", - "DeleteWorkloadIdentity": "

Deletes a workload identity.

", - "GetAgentRuntime": "

Gets an Amazon Bedrock AgentCore Runtime.

", - "GetAgentRuntimeEndpoint": "

Gets information about an Amazon Secure AgentEndpoint.

", - "GetApiKeyCredentialProvider": "

Retrieves information about an API key credential provider.

", - "GetBrowser": "

Gets information about a custom browser.

", - "GetBrowserProfile": "

Gets information about a browser profile.

", - "GetCodeInterpreter": "

Gets information about a custom code interpreter.

", - "GetConfigurationBundle": "

Gets the latest version of a configuration bundle. By default, returns the latest version on the mainline branch. Use GetConfigurationBundleVersion to retrieve a specific historical version.

", - "GetConfigurationBundleVersion": "

Gets a specific version of a configuration bundle by its version identifier.

", - "GetDataset": "

Retrieves dataset metadata. Use the datasetVersion query parameter to retrieve a specific version's metadata. If absent, defaults to DRAFT. For paginated example content, use ListDatasetExamples.

", - "GetEvaluator": "

Retrieves detailed information about an evaluator, including its configuration, status, and metadata. Works with both built-in and custom evaluators.

", - "GetGateway": "

Retrieves information about a specific Gateway.

", - "GetGatewayRule": "

Retrieves detailed information about a specific gateway rule.

", - "GetGatewayTarget": "

Retrieves information about a specific gateway target.

", - "GetHarness": "

Operation to get a single harness.

", - "GetHarnessEndpoint": "

Operation to get a single harness endpoint.

", - "GetMemory": "

Retrieve an existing Amazon Bedrock AgentCore Memory resource.

", - "GetOauth2CredentialProvider": "

Retrieves information about an OAuth2 credential provider.

", - "GetOnlineEvaluationConfig": "

Retrieves detailed information about an online evaluation configuration, including its rules, data sources, evaluators, and execution status.

", - "GetPaymentConnector": "

Retrieves information about a specific payment connector.

", - "GetPaymentCredentialProvider": "

Retrieves information about a specific payment credential provider.

", - "GetPaymentManager": "

Retrieves information about a specific payment manager.

", - "GetPolicy": "

Retrieves detailed information about a specific policy within the AgentCore Policy system. This operation returns the complete policy definition, metadata, and current status, allowing administrators to review and manage policy configurations.

", - "GetPolicyEngine": "

Retrieves detailed information about a specific policy engine within the AgentCore Policy system. This operation returns the complete policy engine configuration, metadata, and current status, allowing administrators to review and manage policy engine settings.

", - "GetPolicyEngineSummary": "

Retrieves a metadata-only summary of a specific policy engine without decrypting customer content. This lightweight read operation returns resource identifiers, status, timestamps, and the encryption key ARN, but does not include the description or status reasons. Because this operation does not require access to the customer's KMS key, it is suitable for resource discovery, inventory, and integration scenarios where only metadata is needed.

", - "GetPolicyGeneration": "

Retrieves information about a policy generation request within the AgentCore Policy system. Policy generation converts natural language descriptions into Cedar policy statements using AI-powered translation, enabling non-technical users to create policies.

", - "GetPolicyGenerationSummary": "

Retrieves a metadata-only summary of a specific policy generation request without decrypting customer content. This lightweight read operation returns resource identifiers, status, timestamps, and findings, but does not include status reasons. Because this operation does not require access to the customer's KMS key, it is suitable for resource discovery, inventory, and integration scenarios where only metadata is needed.

", - "GetPolicySummary": "

Retrieves a metadata-only summary of a specific policy without decrypting customer content. This lightweight read operation returns resource identifiers, status, and timestamps, but does not include the policy definition, description, or status reasons. Because this operation does not require access to the customer's KMS key, it is suitable for resource discovery, inventory, and integration scenarios where only metadata is needed.

", - "GetRegistry": "

Retrieves information about a specific registry.

", - "GetRegistryRecord": "

Retrieves information about a specific registry record.

", - "GetResourcePolicy": "

Retrieves the resource-based policy for a specified resource.

This feature is currently available only for AgentCore Runtime and Gateway.

", - "GetTokenVault": "

Retrieves information about a token vault.

", - "GetWorkloadIdentity": "

Retrieves information about a workload identity.

", - "ListAgentRuntimeEndpoints": "

Lists all endpoints for a specific Amazon Secure Agent.

", - "ListAgentRuntimeVersions": "

Lists all versions of a specific Amazon Secure Agent.

", - "ListAgentRuntimes": "

Lists all Amazon Secure Agents in your account.

", - "ListApiKeyCredentialProviders": "

Lists all API key credential providers in your account.

", - "ListBrowserProfiles": "

Lists all browser profiles in your account.

", - "ListBrowsers": "

Lists all custom browsers in your account.

", - "ListCodeInterpreters": "

Lists all custom code interpreters in your account.

", - "ListConfigurationBundleVersions": "

Lists all versions of a configuration bundle, with optional filtering by branch name or creation source.

", - "ListConfigurationBundles": "

Lists all configuration bundles in the account.

", - "ListDatasetExamples": "

Returns paginated examples from the dataset. The server embeds the resolved version in the pagination token. Once pagination begins, all subsequent pages are pinned to that version regardless of concurrent mutations.

", - "ListDatasetVersions": "

Lists all published versions of a dataset, sorted by version number descending (newest first). Does not include the DRAFT working copy.

", - "ListDatasets": "

Lists all datasets in the caller's account, paginated.

", - "ListEvaluators": "

Lists all available evaluators, including both builtin evaluators provided by the service and custom evaluators created by the user.

", - "ListGatewayRules": "

Lists all rules for a gateway.

", - "ListGatewayTargets": "

Lists all targets for a specific gateway.

", - "ListGateways": "

Lists all gateways in the account.

", - "ListHarnessEndpoints": "

Operation to list the endpoints of a harness.

", - "ListHarnessVersions": "

Operation to list the versions of a Harness.

", - "ListHarnesses": "

Operation to list harnesses.

", - "ListMemories": "

Lists the available Amazon Bedrock AgentCore Memory resources in the current Amazon Web Services Region.

", - "ListOauth2CredentialProviders": "

Lists all OAuth2 credential providers in your account.

", - "ListOnlineEvaluationConfigs": "

Lists all online evaluation configurations in the account, providing summary information about each configuration's status and settings.

", - "ListPaymentConnectors": "

Lists all payment connectors for a specified payment manager.

", - "ListPaymentCredentialProviders": "

Lists all payment credential providers in the account.

", - "ListPaymentManagers": "

Lists all payment managers in the account.

", - "ListPolicies": "

Retrieves a list of policies within the AgentCore Policy engine. This operation supports pagination and filtering to help administrators manage and discover policies across policy engines. Results can be filtered by policy engine or resource associations.

", - "ListPolicyEngineSummaries": "

Retrieves a paginated list of metadata-only policy engine summaries without decrypting customer content. This lightweight read operation returns resource identifiers, status, and timestamps for each policy engine, but does not include descriptions or status reasons. Because this operation does not require access to the customer's KMS key, it is suitable for resource discovery, inventory, and integration scenarios where only metadata is needed.

", - "ListPolicyEngines": "

Retrieves a list of policy engines within the AgentCore Policy system. This operation supports pagination to help administrators discover and manage policy engines across their account. Each policy engine serves as a container for related policies.

", - "ListPolicyGenerationAssets": "

Retrieves a list of generated policy assets from a policy generation request within the AgentCore Policy system. This operation returns the actual Cedar policies and related artifacts produced by the AI-powered policy generation process, allowing users to review and select from multiple generated policy options.

", - "ListPolicyGenerationSummaries": "

Retrieves a paginated list of metadata-only policy generation summaries within a policy engine without decrypting customer content. This lightweight read operation returns resource identifiers, status, timestamps, and findings for each policy generation, but does not include status reasons. Because this operation does not require access to the customer's KMS key, it is suitable for resource discovery, inventory, and integration scenarios where only metadata is needed.

", - "ListPolicyGenerations": "

Retrieves a list of policy generation requests within the AgentCore Policy system. This operation supports pagination and filtering to help track and manage AI-powered policy generation operations.

", - "ListPolicySummaries": "

Retrieves a paginated list of metadata-only policy summaries within a policy engine without decrypting customer content. This lightweight read operation returns resource identifiers, status, and timestamps for each policy, but does not include policy definitions, descriptions, or status reasons. Because this operation does not require access to the customer's KMS key, it is suitable for resource discovery, inventory, and integration scenarios where only metadata is needed.

", - "ListRegistries": "

Lists all registries in the account. You can optionally filter results by status using the status parameter, or by authorizer type using the authorizerType parameter.

", - "ListRegistryRecords": "

Lists registry records within a registry. You can optionally filter results using the name, status, and descriptorType parameters. When multiple filters are specified, they are combined using AND logic.

", - "ListTagsForResource": "

Lists the tags associated with the specified resource.

This feature is currently available only for AgentCore Runtime, Browser, Browser Profile, Code Interpreter tool, and Gateway.

", - "ListWorkloadIdentities": "

Lists all workload identities in your account.

", - "PutResourcePolicy": "

Creates or updates a resource-based policy for a resource with the specified resourceArn.

This feature is currently available only for AgentCore Runtime and Gateway.

", - "SetTokenVaultCMK": "

Sets the customer master key (CMK) for a token vault.

", - "StartPolicyGeneration": "

Initiates the AI-powered generation of Cedar policies from natural language descriptions within the AgentCore Policy system. This feature enables both technical and non-technical users to create policies by describing their authorization requirements in plain English, which is then automatically translated into formal Cedar policy statements. The generation process analyzes the natural language input along with the Gateway's tool context to produce validated policy options. Generated policy assets are automatically deleted after 7 days, so you should review and create policies from the generated assets within this timeframe. Once created, policies are permanent and not subject to this expiration. Generated policies should be reviewed and tested in log-only mode before deploying to production. Use this when you want to describe policy intent naturally rather than learning Cedar syntax, though generated policies may require refinement for complex scenarios.

", - "SubmitRegistryRecordForApproval": "

Submits a registry record for approval. This transitions the record from DRAFT status to PENDING_APPROVAL status. If the registry has auto-approval enabled, the record is automatically approved.

", - "SynchronizeGatewayTargets": "

Synchronizes the gateway targets by fetching the latest tool definitions from the target endpoints.

You cannot synchronize a target that is in a pending authorization state (CREATE_PENDING_AUTH, UPDATE_PENDING_AUTH, or SYNCHRONIZE_PENDING_AUTH). Wait for the authorization to complete or fail before synchronizing.

You cannot synchronize a target that has a static tool schema (mcpToolSchema) configured. Remove the static schema through an UpdateGatewayTarget call to enable dynamic tool synchronization.

", - "TagResource": "

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are also deleted.

This feature is currently available only for AgentCore Runtime, Browser, Browser Profile, Code Interpreter tool, and Gateway.

", - "UntagResource": "

Removes the specified tags from the specified resource.

This feature is currently available only for AgentCore Runtime, Browser, Browser Profile, Code Interpreter tool, and Gateway.

", - "UpdateAgentRuntime": "

Updates an existing Amazon Secure Agent.

", - "UpdateAgentRuntimeEndpoint": "

Updates an existing Amazon Bedrock AgentCore Runtime endpoint.

", - "UpdateApiKeyCredentialProvider": "

Updates an existing API key credential provider.

", - "UpdateConfigurationBundle": "

Updates a configuration bundle by creating a new version with the specified changes. Each update creates a new version in the version history.

", - "UpdateDataset": "

Updates a dataset's metadata. Synchronous operation. Only provided fields are updated; omitted fields remain unchanged. To modify dataset content, use AddDatasetExamples, UpdateDatasetExamples, or DeleteDatasetExamples.

", - "UpdateDatasetExamples": "

Updates multiple existing examples in-place on DRAFT. All examples are validated against the dataset's schema type before any writes occur. If any example fails validation, the entire batch is rejected (all-or-nothing semantics).

", - "UpdateEvaluator": "

Updates a custom evaluator's configuration, description, or evaluation level. Built-in evaluators cannot be updated. The evaluator must not be locked for modification.

", - "UpdateGateway": "

Updates an existing gateway.

", - "UpdateGatewayRule": "

Updates a gateway rule's priority, conditions, actions, or description.

", - "UpdateGatewayTarget": "

Updates an existing gateway target.

You cannot update a target that is in a pending authorization state (CREATE_PENDING_AUTH, UPDATE_PENDING_AUTH, or SYNCHRONIZE_PENDING_AUTH). Wait for the authorization to complete or fail before updating the target.

", - "UpdateHarness": "

Operation to update a harness.

", - "UpdateHarnessEndpoint": "

Operation to update a harness endpoint.

", - "UpdateMemory": "

Update an Amazon Bedrock AgentCore Memory resource memory.

", - "UpdateOauth2CredentialProvider": "

Updates an existing OAuth2 credential provider.

", - "UpdateOnlineEvaluationConfig": "

Updates an online evaluation configuration's settings, including rules, data sources, evaluators, and execution status. Changes take effect immediately for ongoing evaluations.

", - "UpdatePaymentConnector": "

Updates an existing payment connector. This operation uses PATCH semantics, so you only need to specify the fields you want to change.

", - "UpdatePaymentCredentialProvider": "

Updates an existing payment credential provider with new authentication credentials.

", - "UpdatePaymentManager": "

Updates an existing payment manager. This operation uses PATCH semantics, so you only need to specify the fields you want to change.

", - "UpdatePolicy": "

Updates an existing policy within the AgentCore Policy system. This operation allows modification of the policy description and definition while maintaining the policy's identity. The updated policy is validated against the Cedar schema before being applied. This is an asynchronous operation. Use the GetPolicy operation to poll the status field to track completion.

", - "UpdatePolicyEngine": "

Updates an existing policy engine within the AgentCore Policy system. This operation allows modification of the policy engine description while maintaining its identity. This is an asynchronous operation. Use the GetPolicyEngine operation to poll the status field to track completion.

", - "UpdateRegistry": "

Updates an existing registry. This operation uses PATCH semantics, so you only need to specify the fields you want to change.

", - "UpdateRegistryRecord": "

Updates an existing registry record. This operation uses PATCH semantics, so you only need to specify the fields you want to change. The update is processed asynchronously and returns HTTP 202 Accepted.

", - "UpdateRegistryRecordStatus": "

Updates the status of a registry record. Use this operation to approve, reject, or deprecate a registry record.

", - "UpdateWorkloadIdentity": "

Updates an existing workload identity.

" - }, - "shapes": { - "A2aDescriptor": { - "base": "

The Agent-to-Agent (A2A) protocol descriptor for a registry record. Contains the agent card definition as defined by the A2A protocol specification.

", - "refs": { - "Descriptors$a2a": "

The Agent-to-Agent (A2A) protocol descriptor configuration. Use this when the descriptorType is A2A.

", - "UpdatedA2aDescriptor$optionalValue": "

The updated A2A descriptor value.

" - } - }, - "AccessDeniedException": { - "base": "

This exception is thrown when a request is denied per access permissions

", - "refs": {} - }, - "Action": { - "base": "

An action to take when a gateway rule's conditions are met.

", - "refs": { - "Actions$member": null - } - }, - "Actions": { - "base": null, - "refs": { - "CreateGatewayRuleRequest$actions": "

The actions to take when the rule conditions are met. Actions can route to a specific target or apply a configuration bundle override.

", - "CreateGatewayRuleResponse$actions": "

The actions to take when the rule conditions are met.

", - "GatewayRuleDetail$actions": "

The actions to take when the rule conditions are met.

", - "GetGatewayRuleResponse$actions": "

The actions to take when the rule conditions are met.

", - "UpdateGatewayRuleRequest$actions": "

The updated actions for the rule.

", - "UpdateGatewayRuleResponse$actions": "

The actions to take when the rule conditions are met.

" - } - }, - "ActorTokenContentType": { - "base": null, - "refs": { - "TokenExchangeGrantTypeConfigType$actorTokenContent": "

The content type for the actor token in the token exchange.

" - } - }, - "AddDatasetExamplesRequest": { - "base": null, - "refs": {} - }, - "AddDatasetExamplesResponse": { - "base": null, - "refs": {} - }, - "AdditionalClaimName": { - "base": null, - "refs": { - "AdditionalClaims$key": null - } - }, - "AdditionalClaimValue": { - "base": null, - "refs": { - "AdditionalClaims$value": null - } - }, - "AdditionalClaims": { - "base": null, - "refs": { - "PrivateKeyJwtConfig$additionalHeaderClaims": "

A map of additional claims to include in the JWT client assertion header. Standard header claims such as alg and typ cannot be added.

", - "PrivateKeyJwtConfig$additionalPayloadClaims": "

A map of additional claims to include in the JWT client assertion payload. Payload claims generated by the service, such as iss, sub, jti, and exp, cannot be added.

" - } - }, - "AdditionalModelRequestFields": { - "base": null, - "refs": { - "BedrockEvaluatorModelConfig$additionalModelRequestFields": "

Additional model-specific request fields to customize model behavior beyond the standard inference configuration.

" - } - }, - "AdvertisedScopeMappingType": { - "base": "

Maps an originalScope (from allowedScopes) to an advertisedScope exposed in WWW-Authenticate / Protected Resource Metadata.

", - "refs": { - "CustomJWTAuthorizerConfiguration$advertisedScopeMapping": "

A map that associates each scope in allowedScopes with a corresponding advertised scope value. The advertised scope appears in OAuth protected resource metadata and WWW-Authenticate response headers. Use this parameter when the scope that clients request from your identity provider differs from the scope in the validated token. Each key is a scope from allowedScopes that the service uses for token validation. Each value is the corresponding scope that the service advertises to clients. Scopes without a mapping entry appear unchanged to clients.

" - } - }, - "AgentCardDefinition": { - "base": "

The agent card definition for an A2A descriptor. Contains the schema version and inline content for the agent card.

", - "refs": { - "A2aDescriptor$agentCard": "

The agent card definition for the A2A agent, as defined by the A2A protocol specification.

" - } - }, - "AgentEndpointDescription": { - "base": null, - "refs": { - "AgentRuntimeEndpoint$description": "

The description of the agent runtime endpoint.

", - "CreateAgentRuntimeEndpointRequest$description": "

The description of the AgentCore Runtime endpoint.

", - "GetAgentRuntimeEndpointResponse$description": "

The description of the AgentCore Runtime endpoint.

", - "UpdateAgentRuntimeEndpointRequest$description": "

The updated description of the AgentCore Runtime endpoint.

" - } - }, - "AgentManagedRuntimeType": { - "base": null, - "refs": { - "CodeConfiguration$runtime": "

The runtime environment for executing the agent code. Specify the programming language and version to use for the agent runtime. For valid values, see the list of supported runtimes.

" - } - }, - "AgentRuntime": { - "base": "

Contains information about an agent runtime. An agent runtime is the execution environment for a Amazon Bedrock AgentCore Agent.

", - "refs": { - "AgentRuntimes$member": null - } - }, - "AgentRuntimeArn": { - "base": null, - "refs": { - "AgentRuntime$agentRuntimeArn": "

The Amazon Resource Name (ARN) of the agent runtime.

", - "AgentRuntimeEndpoint$agentRuntimeArn": "

The Amazon Resource Name (ARN) of the agent runtime associated with the endpoint.

", - "CreateAgentRuntimeEndpointResponse$agentRuntimeArn": "

The Amazon Resource Name (ARN) of the AgentCore Runtime.

", - "CreateAgentRuntimeResponse$agentRuntimeArn": "

The Amazon Resource Name (ARN) of the AgentCore Runtime.

", - "GetAgentRuntimeEndpointResponse$agentRuntimeArn": "

The Amazon Resource Name (ARN) of the AgentCore Runtime.

", - "GetAgentRuntimeResponse$agentRuntimeArn": "

The Amazon Resource Name (ARN) of the AgentCore Runtime.

", - "UpdateAgentRuntimeEndpointResponse$agentRuntimeArn": "

The Amazon Resource Name (ARN) of the AgentCore Runtime.

", - "UpdateAgentRuntimeResponse$agentRuntimeArn": "

The Amazon Resource Name (ARN) of the updated AgentCore Runtime.

" - } - }, - "AgentRuntimeArtifact": { - "base": "

The artifact of the agent.

", - "refs": { - "CreateAgentRuntimeRequest$agentRuntimeArtifact": "

The artifact of the AgentCore Runtime.

", - "GetAgentRuntimeResponse$agentRuntimeArtifact": "

The artifact of the AgentCore Runtime.

", - "UpdateAgentRuntimeRequest$agentRuntimeArtifact": "

The updated artifact of the AgentCore Runtime.

" - } - }, - "AgentRuntimeEndpoint": { - "base": "

Contains information about an agent runtime endpoint. An endpoint provides a way to connect to and interact with an agent runtime.

", - "refs": { - "AgentRuntimeEndpoints$member": null - } - }, - "AgentRuntimeEndpointArn": { - "base": null, - "refs": { - "AgentRuntimeEndpoint$agentRuntimeEndpointArn": "

The Amazon Resource Name (ARN) of the agent runtime endpoint.

", - "CreateAgentRuntimeEndpointResponse$agentRuntimeEndpointArn": "

The Amazon Resource Name (ARN) of the AgentCore Runtime endpoint.

", - "GetAgentRuntimeEndpointResponse$agentRuntimeEndpointArn": "

The Amazon Resource Name (ARN) of the AgentCore Runtime endpoint.

", - "UpdateAgentRuntimeEndpointResponse$agentRuntimeEndpointArn": "

The Amazon Resource Name (ARN) of the AgentCore Runtime endpoint.

" - } - }, - "AgentRuntimeEndpointId": { - "base": null, - "refs": { - "AgentRuntimeEndpoint$id": "

The unique identifier of the agent runtime endpoint.

", - "GetAgentRuntimeEndpointResponse$id": "

The unique identifier of the AgentCore Runtime endpoint.

" - } - }, - "AgentRuntimeEndpointStatus": { - "base": null, - "refs": { - "AgentRuntimeEndpoint$status": "

The current status of the agent runtime endpoint.

", - "CreateAgentRuntimeEndpointResponse$status": "

The current status of the AgentCore Runtime endpoint.

", - "DeleteAgentRuntimeEndpointResponse$status": "

The current status of the AgentCore Runtime endpoint deletion.

", - "GetAgentRuntimeEndpointResponse$status": "

The current status of the AgentCore Runtime endpoint.

", - "UpdateAgentRuntimeEndpointResponse$status": "

The current status of the updated AgentCore Runtime endpoint.

" - } - }, - "AgentRuntimeEndpoints": { - "base": null, - "refs": { - "ListAgentRuntimeEndpointsResponse$runtimeEndpoints": "

The list of AgentCore Runtime endpoints.

" - } - }, - "AgentRuntimeId": { - "base": null, - "refs": { - "AgentRuntime$agentRuntimeId": "

The unique identifier of the agent runtime.

", - "CreateAgentRuntimeEndpointRequest$agentRuntimeId": "

The unique identifier of the AgentCore Runtime to create an endpoint for.

", - "CreateAgentRuntimeEndpointResponse$agentRuntimeId": "

The unique identifier of the AgentCore Runtime.

", - "CreateAgentRuntimeResponse$agentRuntimeId": "

The unique identifier of the AgentCore Runtime.

", - "DeleteAgentRuntimeEndpointRequest$agentRuntimeId": "

The unique identifier of the AgentCore Runtime associated with the endpoint.

", - "DeleteAgentRuntimeEndpointResponse$agentRuntimeId": "

The unique identifier of the AgentCore Runtime.

", - "DeleteAgentRuntimeRequest$agentRuntimeId": "

The unique identifier of the AgentCore Runtime to delete.

", - "DeleteAgentRuntimeResponse$agentRuntimeId": "

The unique identifier of the AgentCore Runtime.

", - "GetAgentRuntimeEndpointRequest$agentRuntimeId": "

The unique identifier of the AgentCore Runtime associated with the endpoint.

", - "GetAgentRuntimeRequest$agentRuntimeId": "

The unique identifier of the AgentCore Runtime to retrieve.

", - "GetAgentRuntimeResponse$agentRuntimeId": "

The unique identifier of the AgentCore Runtime.

", - "ListAgentRuntimeEndpointsRequest$agentRuntimeId": "

The unique identifier of the AgentCore Runtime to list endpoints for.

", - "ListAgentRuntimeVersionsRequest$agentRuntimeId": "

The unique identifier of the AgentCore Runtime to list versions for.

", - "UpdateAgentRuntimeEndpointRequest$agentRuntimeId": "

The unique identifier of the AgentCore Runtime associated with the endpoint.

", - "UpdateAgentRuntimeRequest$agentRuntimeId": "

The unique identifier of the AgentCore Runtime to update.

", - "UpdateAgentRuntimeResponse$agentRuntimeId": "

The unique identifier of the updated AgentCore Runtime.

" - } - }, - "AgentRuntimeName": { - "base": null, - "refs": { - "AgentRuntime$agentRuntimeName": "

The name of the agent runtime.

", - "CreateAgentRuntimeRequest$agentRuntimeName": "

The name of the AgentCore Runtime.

", - "GetAgentRuntimeResponse$agentRuntimeName": "

The name of the AgentCore Runtime.

" - } - }, - "AgentRuntimeStatus": { - "base": null, - "refs": { - "AgentRuntime$status": "

The current status of the agent runtime.

", - "CreateAgentRuntimeResponse$status": "

The current status of the AgentCore Runtime.

", - "DeleteAgentRuntimeResponse$status": "

The current status of the AgentCore Runtime deletion.

", - "GetAgentRuntimeResponse$status": "

The current status of the AgentCore Runtime.

", - "UpdateAgentRuntimeResponse$status": "

The current status of the updated AgentCore Runtime.

" - } - }, - "AgentRuntimeVersion": { - "base": null, - "refs": { - "AgentRuntime$agentRuntimeVersion": "

The version of the agent runtime.

", - "AgentRuntimeEndpoint$liveVersion": "

The live version of the agent runtime endpoint. This is the version that is currently serving requests.

", - "AgentRuntimeEndpoint$targetVersion": "

The target version of the agent runtime endpoint. This is the version that the endpoint is being updated to.

", - "CreateAgentRuntimeEndpointRequest$agentRuntimeVersion": "

The version of the AgentCore Runtime to use for the endpoint.

", - "CreateAgentRuntimeEndpointResponse$targetVersion": "

The target version of the AgentCore Runtime for the endpoint.

", - "CreateAgentRuntimeResponse$agentRuntimeVersion": "

The version of the AgentCore Runtime.

", - "GetAgentRuntimeEndpointResponse$liveVersion": "

The currently deployed version of the AgentCore Runtime on the endpoint.

", - "GetAgentRuntimeEndpointResponse$targetVersion": "

The target version of the AgentCore Runtime for the endpoint.

", - "GetAgentRuntimeRequest$agentRuntimeVersion": "

The version of the AgentCore Runtime to retrieve.

", - "GetAgentRuntimeResponse$agentRuntimeVersion": "

The version of the AgentCore Runtime.

", - "UpdateAgentRuntimeEndpointRequest$agentRuntimeVersion": "

The updated version of the AgentCore Runtime for the endpoint.

", - "UpdateAgentRuntimeEndpointResponse$liveVersion": "

The currently deployed version of the AgentCore Runtime on the endpoint.

", - "UpdateAgentRuntimeEndpointResponse$targetVersion": "

The target version of the AgentCore Runtime for the endpoint.

", - "UpdateAgentRuntimeResponse$agentRuntimeVersion": "

The version of the updated AgentCore Runtime.

" - } - }, - "AgentRuntimes": { - "base": null, - "refs": { - "ListAgentRuntimeVersionsResponse$agentRuntimes": "

The list of AgentCore Runtime versions.

", - "ListAgentRuntimesResponse$agentRuntimes": "

The list of AgentCore Runtime resources.

" - } - }, - "AgentSkillsDescriptor": { - "base": "

The agent skills descriptor for a registry record. Contains an optional skill markdown definition in human-readable format and an optional structured skill definition.

", - "refs": { - "Descriptors$agentSkills": "

The agent skills descriptor configuration. Use this when the descriptorType is AGENT_SKILLS.

" - } - }, - "AllowedAudience": { - "base": null, - "refs": { - "AllowedAudienceList$member": null - } - }, - "AllowedAudienceList": { - "base": null, - "refs": { - "CustomJWTAuthorizerConfiguration$allowedAudience": "

Represents individual audience values that are validated in the incoming JWT token validation process.

" - } - }, - "AllowedClient": { - "base": null, - "refs": { - "AllowedClientsList$member": null - } - }, - "AllowedClientsList": { - "base": null, - "refs": { - "CustomJWTAuthorizerConfiguration$allowedClients": "

Represents individual client IDs that are validated in the incoming JWT token validation process.

" - } - }, - "AllowedQueryParameters": { - "base": null, - "refs": { - "MetadataConfiguration$allowedQueryParameters": "

A list of URL query parameters that are allowed to be propagated from incoming gateway URL to the target.

" - } - }, - "AllowedRequestHeaders": { - "base": null, - "refs": { - "MetadataConfiguration$allowedRequestHeaders": "

A list of HTTP headers that are allowed to be propagated from incoming client requests to the target.

" - } - }, - "AllowedResponseHeaders": { - "base": null, - "refs": { - "MetadataConfiguration$allowedResponseHeaders": "

A list of HTTP headers that are allowed to be propagated from the target response back to the client.

" - } - }, - "AllowedScopeType": { - "base": null, - "refs": { - "AdvertisedScopeMappingType$key": null, - "AdvertisedScopeMappingType$value": null, - "AllowedScopesType$member": null - } - }, - "AllowedScopesType": { - "base": null, - "refs": { - "CustomJWTAuthorizerConfiguration$allowedScopes": "

An array of scopes that are allowed to access the token.

" - } - }, - "AllowedStringListValue": { - "base": null, - "refs": { - "AllowedStringListValuesList$member": null - } - }, - "AllowedStringListValuesList": { - "base": null, - "refs": { - "StringListValidation$allowedValues": "

Allowed values for items in this STRINGLIST field.

" - } - }, - "AllowedStringValue": { - "base": null, - "refs": { - "AllowedStringValuesList$member": null - } - }, - "AllowedStringValuesList": { - "base": null, - "refs": { - "StringValidation$allowedValues": "

Allowed values for this STRING field.

" - } - }, - "AllowedWorkloadConfiguration": { - "base": "

The configuration that restricts which workloads in the request's identity chain are allowed to invoke the target, identified by their hosting environments and workload identities. At launch, this is supported only for AgentCore Runtime targets, and the allowed workloads are AgentCore Gateways.

", - "refs": { - "CustomJWTAuthorizerConfiguration$allowedWorkloadConfiguration": "

The configuration that restricts which workloads in the request's identity chain are allowed to invoke the target, identified by their hosting environments and workload identities. At launch, this is supported only for AgentCore Runtime targets, and the allowed workloads are AgentCore Gateways.

" - } - }, - "ApiGatewayTargetConfiguration": { - "base": "

The configuration for an Amazon API Gateway target.

", - "refs": { - "McpTargetConfiguration$apiGateway": "

The configuration for an Amazon API Gateway target.

" - } - }, - "ApiGatewayToolConfiguration": { - "base": "

The configuration for defining REST API tool filters and overrides for the gateway target.

", - "refs": { - "ApiGatewayTargetConfiguration$apiGatewayToolConfiguration": "

The configuration for defining REST API tool filters and overrides for the gateway target.

" - } - }, - "ApiGatewayToolFilter": { - "base": "

Specifies which operations from an API Gateway REST API are exposed as tools. Tool names and descriptions are derived from the operationId and description fields in the API's exported OpenAPI specification.

", - "refs": { - "ApiGatewayToolFilters$member": null - } - }, - "ApiGatewayToolFilters": { - "base": null, - "refs": { - "ApiGatewayToolConfiguration$toolFilters": "

A list of path and method patterns to expose as tools using metadata from the REST API's OpenAPI specification.

" - } - }, - "ApiGatewayToolOverride": { - "base": "

Settings to override configurations for a tool.

", - "refs": { - "ApiGatewayToolOverrides$member": null - } - }, - "ApiGatewayToolOverrides": { - "base": null, - "refs": { - "ApiGatewayToolConfiguration$toolOverrides": "

A list of explicit tool definitions with optional custom names and descriptions.

" - } - }, - "ApiKeyArn": { - "base": null, - "refs": { - "HarnessGeminiModelConfig$apiKeyArn": "

The ARN of your Gemini API key on AgentCore Identity.

", - "HarnessLiteLlmModelConfig$apiKeyArn": "

The ARN of the API key in AgentCore Identity for authenticating with the model provider.

", - "HarnessOpenAiModelConfig$apiKeyArn": "

The ARN of your OpenAI API key on AgentCore Identity.

", - "HarnessSkillGitAuth$credentialArn": "

The ARN of the credential in AgentCore Identity containing the password or personal access token.

" - } - }, - "ApiKeyCredentialLocation": { - "base": null, - "refs": { - "ApiKeyCredentialProvider$credentialLocation": "

The location of the API key credential. This field specifies where in the request the API key should be placed.

" - } - }, - "ApiKeyCredentialParameterName": { - "base": null, - "refs": { - "ApiKeyCredentialProvider$credentialParameterName": "

The name of the credential parameter for the API key. This parameter name is used when sending the API key to the target endpoint.

" - } - }, - "ApiKeyCredentialPrefix": { - "base": null, - "refs": { - "ApiKeyCredentialProvider$credentialPrefix": "

The prefix for the API key credential. This prefix is added to the API key when sending it to the target endpoint.

" - } - }, - "ApiKeyCredentialProvider": { - "base": "

An API key credential provider for gateway authentication. This structure contains the configuration for authenticating with the target endpoint using an API key.

", - "refs": { - "CredentialProvider$apiKeyCredentialProvider": "

The API key credential provider. This provider uses an API key to authenticate with the target endpoint.

" - } - }, - "ApiKeyCredentialProviderArn": { - "base": null, - "refs": { - "ApiKeyCredentialProvider$providerArn": "

The Amazon Resource Name (ARN) of the API key credential provider. This ARN identifies the provider in Amazon Web Services.

" - } - }, - "ApiKeyCredentialProviderArnType": { - "base": null, - "refs": { - "ApiKeyCredentialProviderItem$credentialProviderArn": "

The Amazon Resource Name (ARN) of the API key credential provider.

", - "CreateApiKeyCredentialProviderResponse$credentialProviderArn": "

The Amazon Resource Name (ARN) of the created API key credential provider.

", - "GetApiKeyCredentialProviderResponse$credentialProviderArn": "

The Amazon Resource Name (ARN) of the API key credential provider.

", - "UpdateApiKeyCredentialProviderResponse$credentialProviderArn": "

The Amazon Resource Name (ARN) of the API key credential provider.

" - } - }, - "ApiKeyCredentialProviderItem": { - "base": "

Contains information about an API key credential provider.

", - "refs": { - "ApiKeyCredentialProviders$member": null - } - }, - "ApiKeyCredentialProviders": { - "base": null, - "refs": { - "ListApiKeyCredentialProvidersResponse$credentialProviders": "

The list of API key credential providers.

" - } - }, - "ApiSchemaConfiguration": { - "base": "

Configuration for API schema.

", - "refs": { - "HttpApiSchemaConfiguration$source": null, - "McpTargetConfiguration$openApiSchema": "

The OpenAPI schema for the Model Context Protocol target. This schema defines the API structure of the target.

", - "McpTargetConfiguration$smithyModel": "

The Smithy model for the Model Context Protocol target. This model defines the API structure of the target using the Smithy specification.

" - } - }, - "ApprovalConfiguration": { - "base": "

Configuration for the registry record approval workflow. Controls whether records added to the registry require explicit approval before becoming active.

", - "refs": { - "CreateRegistryRequest$approvalConfiguration": "

The approval configuration for registry records. Controls whether records require explicit approval before becoming active. See the ApprovalConfiguration data type for supported configuration options.

", - "GetRegistryResponse$approvalConfiguration": "

The approval configuration for registry records. For details, see the ApprovalConfiguration data type.

", - "UpdateRegistryResponse$approvalConfiguration": "

The approval configuration for the updated registry. For details, see the ApprovalConfiguration data type.

", - "UpdatedApprovalConfiguration$optionalValue": "

The updated approval configuration value. Set to null to unset the approval configuration.

" - } - }, - "Arn": { - "base": null, - "refs": { - "CreateMemoryInput$encryptionKeyArn": "

The Amazon Resource Name (ARN) of the KMS key used to encrypt the memory data.

", - "CreateMemoryInput$memoryExecutionRoleArn": "

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the memory to access Amazon Web Services services.

", - "InvocationConfiguration$topicArn": "

The ARN of the SNS topic for job notifications.

", - "InvocationConfigurationInput$topicArn": "

The ARN of the SNS topic for job notifications.

", - "KinesisResource$dataStreamArn": "

ARN of the Kinesis Data Stream.

", - "Memory$encryptionKeyArn": "

The ARN of the KMS key used to encrypt the memory.

", - "Memory$memoryExecutionRoleArn": "

The ARN of the IAM role that provides permissions for the memory.

", - "Memory$managedByResourceArn": "

ARN of the resource managing this memory (e.g. a harness). When set, strategy modifications and deletion are only allowed through the managing resource.

", - "MemorySummary$managedByResourceArn": "

ARN of the resource managing this memory (e.g. a harness). Null if not managed.

", - "ModifyInvocationConfigurationInput$topicArn": "

The updated ARN of the SNS topic for job notifications.

", - "UpdateMemoryInput$memoryExecutionRoleArn": "

The ARN of the IAM role that provides permissions for the AgentCore Memory resource.

" - } - }, - "AtlassianOauth2ProviderConfigInput": { - "base": "

Configuration settings for connecting to Atlassian services using OAuth2 authentication. This includes the client credentials required to authenticate with Atlassian's OAuth2 authorization server.

", - "refs": { - "Oauth2ProviderConfigInput$atlassianOauth2ProviderConfig": "

Configuration settings for Atlassian OAuth2 provider integration.

" - } - }, - "AtlassianOauth2ProviderConfigOutput": { - "base": "

The configuration details returned for an Atlassian OAuth2 provider, including the client ID and OAuth2 discovery information.

", - "refs": { - "Oauth2ProviderConfigOutput$atlassianOauth2ProviderConfig": "

The configuration details for the Atlassian OAuth2 provider.

" - } - }, - "AuthorizationData": { - "base": "

Contains the authorization data that is returned when a gateway target is configured with a credential provider with authorization code grant type and requires user federation.

", - "refs": { - "CreateGatewayTargetResponse$authorizationData": "

OAuth2 authorization data for the created gateway target. This data is returned when a target is configured with a credential provider with authorization code grant type and requires user federation.

", - "GatewayTarget$authorizationData": "

OAuth2 authorization data for the gateway target. This data is returned when a target is configured with a credential provider with authorization code grant type and requires user federation.

", - "GetGatewayTargetResponse$authorizationData": "

OAuth2 authorization data for the gateway target. This data is returned when a target is configured with a credential provider with authorization code grant type and requires user federation.

", - "TargetSummary$authorizationData": null, - "UpdateGatewayTargetResponse$authorizationData": "

OAuth2 authorization data for the updated gateway target. This data is returned when a target is configured with a credential provider with authorization code grant type and requires user federation.

" - } - }, - "AuthorizationEndpointType": { - "base": null, - "refs": { - "IncludedOauth2ProviderConfigInput$authorizationEndpoint": "

OAuth2 authorization endpoint for your isolated OAuth2 application tenant. This is where users are redirected to authenticate and authorize access to their resources.

", - "Oauth2AuthorizationServerMetadata$authorizationEndpoint": "

The authorization endpoint URL for the OAuth2 authorization server.

" - } - }, - "AuthorizerConfiguration": { - "base": "

Represents inbound authorization configuration options used to authenticate incoming requests.

", - "refs": { - "CreateAgentRuntimeRequest$authorizerConfiguration": "

The authorizer configuration for the AgentCore Runtime.

", - "CreateGatewayRequest$authorizerConfiguration": "

The authorizer configuration for the gateway. Required if authorizerType is CUSTOM_JWT.

", - "CreateGatewayResponse$authorizerConfiguration": "

The authorizer configuration for the created gateway.

", - "CreateHarnessRequest$authorizerConfiguration": null, - "CreatePaymentManagerRequest$authorizerConfiguration": "

The authorizer configuration for the payment manager.

", - "CreatePaymentManagerResponse$authorizerConfiguration": null, - "CreateRegistryRequest$authorizerConfiguration": "

The authorizer configuration for the registry. Required if authorizerType is CUSTOM_JWT. For details, see the AuthorizerConfiguration data type.

", - "GetAgentRuntimeResponse$authorizerConfiguration": "

The authorizer configuration for the AgentCore Runtime.

", - "GetGatewayResponse$authorizerConfiguration": "

The authorizer configuration for the gateway.

", - "GetPaymentManagerResponse$authorizerConfiguration": null, - "GetRegistryResponse$authorizerConfiguration": "

The authorizer configuration for the registry. For details, see the AuthorizerConfiguration data type.

", - "Harness$authorizerConfiguration": null, - "UpdateAgentRuntimeRequest$authorizerConfiguration": "

The updated authorizer configuration for the AgentCore Runtime.

", - "UpdateGatewayRequest$authorizerConfiguration": "

The updated authorizer configuration for the gateway.

", - "UpdateGatewayResponse$authorizerConfiguration": "

The updated authorizer configuration for the gateway.

", - "UpdatePaymentManagerRequest$authorizerConfiguration": "

The updated authorizer configuration for the payment manager.

", - "UpdateRegistryResponse$authorizerConfiguration": "

The authorizer configuration for the updated registry. For details, see the AuthorizerConfiguration data type.

", - "UpdatedAuthorizerConfiguration$optionalValue": "

The updated authorizer configuration value. If not specified, it will clear the current authorizer configuration of the resource.

" - } - }, - "AuthorizerType": { - "base": null, - "refs": { - "CreateGatewayRequest$authorizerType": "

The type of authorizer to use for the gateway.

  • CUSTOM_JWT - Authorize with a bearer token.

  • AWS_IAM - Authorize with your Amazon Web Services IAM credentials.

  • NONE - No authorization

", - "CreateGatewayResponse$authorizerType": "

The type of authorizer used by the gateway.

", - "GatewaySummary$authorizerType": "

The type of authorizer used by the gateway.

", - "GetGatewayResponse$authorizerType": "

Authorizer type for the gateway.

", - "UpdateGatewayRequest$authorizerType": "

The updated authorizer type for the gateway.

", - "UpdateGatewayResponse$authorizerType": "

The updated authorizer type for the gateway.

" - } - }, - "AuthorizingClaimMatchValueType": { - "base": "

Defines the value or values to match for and the relationship of the match.

", - "refs": { - "CustomClaimValidationType$authorizingClaimMatchValue": "

Defines the value or values to match for and the relationship of the match.

" - } - }, - "AwsAccountId": { - "base": null, - "refs": { - "S3Configuration$bucketOwnerAccountId": "

The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.

" - } - }, - "BedrockAgentcoreResourceArn": { - "base": null, - "refs": { - "DeleteResourcePolicyRequest$resourceArn": "

The Amazon Resource Name (ARN) of the resource for which to delete the resource policy.

", - "GetResourcePolicyRequest$resourceArn": "

The Amazon Resource Name (ARN) of the resource for which to retrieve the resource policy.

", - "HarnessAgentCoreRuntimeEnvironment$agentRuntimeArn": "

The ARN of the underlying AgentCore Runtime.

", - "HostingEnvironment$arn": "

The Amazon Resource Name (ARN) of the hosting environment.

", - "ListPoliciesRequest$targetResourceScope": "

Optional filter to list policies that apply to a specific resource scope or resource type. This helps narrow down policy results to those relevant for particular Amazon Web Services resources, agent tools, or operational contexts within the policy engine ecosystem.

", - "ListPolicySummariesRequest$targetResourceScope": "

Optional filter to list policy summaries that apply to a specific resource scope or resource type. This helps narrow down results to those relevant for particular Amazon Web Services resources, agent tools, or operational contexts within the policy engine ecosystem.

", - "PutResourcePolicyRequest$resourceArn": "

The Amazon Resource Name (ARN) of the resource for which to create or update the resource policy.

", - "Resource$arn": "

The Amazon Resource Name (ARN) of the resource. This globally unique identifier specifies the exact resource that policies will be evaluated against for access control decisions.

" - } - }, - "BedrockEvaluatorModelConfig": { - "base": "

The configuration for using Amazon Bedrock models in evaluator assessments, including model selection and inference parameters.

", - "refs": { - "EvaluatorModelConfig$bedrockEvaluatorModelConfig": "

The Amazon Bedrock model configuration for evaluation.

" - } - }, - "Boolean": { - "base": null, - "refs": { - "ApprovalConfiguration$autoApproval": "

Whether registry records are auto-approved. When set to true, records are automatically approved upon creation. When set to false (the default), records require explicit approval for security purposes.

", - "BrowserSigningConfigInput$enabled": "

Specifies whether browser signing is enabled. When enabled, the browser will cryptographically sign HTTP requests to identify itself as an AI agent to bot control vendors.

", - "BrowserSigningConfigOutput$enabled": "

Indicates whether browser signing is currently enabled for cryptographic agent identification using HTTP message signatures.

", - "ConnectorParameterOverride$visible": "

Whether this parameter is visible to the agent. If not specified, uses the service default.

", - "CreateOnlineEvaluationConfigRequest$enableOnCreate": "

Whether to enable the online evaluation configuration immediately upon creation. If true, evaluation begins automatically.

", - "DeleteHarnessRequest$deleteManagedMemory": "

Whether to delete the managed memory on harness deletion. Default: true. If false, the memory is disassociated and becomes a regular customer-owned resource.

", - "EvaluatorSummary$lockedForModification": "

Whether the evaluator is locked for modification due to being referenced by active online evaluation configurations.

", - "FilterValue$booleanValue": "

The boolean value for true/false filtering conditions.

", - "GetEvaluatorResponse$lockedForModification": "

Whether the evaluator is locked for modification due to being referenced by active online evaluation configurations.

", - "InterceptorInputConfiguration$passRequestHeaders": "

Indicates whether to pass request headers as input into the interceptor. When set to true, request headers will be passed.

", - "ProviderPrefix$strip": "

Whether clients can omit the provider prefix from model IDs. If true, the gateway accepts model IDs without the prefix and restores the full prefixed form before forwarding to the provider. The default is false.

", - "RecordingConfig$enabled": "

Indicates whether recording is enabled for the browser. When set to true, browser sessions are recorded.

", - "RuntimeMetadataConfiguration$requireMMDSV2": "

Enables MMDSv2 (microVM Metadata Service Version 2) requirement for the agent runtime. When set to true, the runtime microVM will only accept MMDSv2 requests.

", - "StreamingConfiguration$enableResponseStreaming": "

Indicates whether response streaming is enabled for the gateway. When set to true, the gateway streams responses from targets back to the client.

", - "UpdateRegistryRecordRequest$triggerSynchronization": "

Whether to trigger synchronization using the stored or provided configuration. When set to true, the service will synchronize the record metadata from the configured external source.

", - "VersionFilter$latestPerBranch": "

When true, returns only the latest version for each branch. When false or not specified, returns all versions. Can be combined with branchName to get the latest version for a specific branch.

", - "VpcConfig$requireServiceS3Endpoint": "

This field applies only to Agent Runtimes. It is not applicable to Browsers or Code Interpreters.

Controls whether a service-managed Amazon S3 gateway endpoint is provisioned in the VPC network topology for the agent runtime. This gateway is used by Amazon Bedrock AgentCore Runtime to download code and container images during agent startup.

Starting May 5, 2026, Amazon Bedrock AgentCore Runtime is gradually rolling out a change to how network isolation is configured for VPC mode agents. Agent runtimes created on or after this rollout will no longer include the service-managed Amazon S3 gateway. Instead, all network access, including to Amazon S3, is governed exclusively by your VPC configuration. This field cannot be set on agent runtimes created after the rollout. Passing this field in an UpdateAgentRuntime request for these agent runtimes returns a ValidationException.

Agent runtimes created before the rollout are not affected and continue to operate with the service-managed Amazon S3 gateway. To enforce full VPC network isolation on these existing agent runtimes, set this field to false via the UpdateAgentRuntime API. Before opting out, ensure your VPC provides the Amazon S3 access required for agent startup. If this field is not specified or is set to true, the service-managed Amazon S3 gateway remains provisioned.

This field is only supported in the UpdateAgentRuntime API for pre-rollout agent runtimes. Passing this field in a CreateAgentRuntime request returns a ValidationException.

" - } - }, - "BranchName": { - "base": null, - "refs": { - "CreateConfigurationBundleRequest$branchName": "

The branch name for version tracking. Defaults to mainline if not specified.

", - "GetConfigurationBundleRequest$branchName": "

The branch name to get the latest version from. If not specified, returns the latest version on the mainline branch.

", - "UpdateConfigurationBundleRequest$branchName": "

The branch name for this version. If not specified, inherits the parent's branch or defaults to mainline.

", - "VersionFilter$branchName": "

Filter by branch name.

", - "VersionLineageMetadata$branchName": "

The branch name for this version. If not specified, inherits the parent's branch or defaults to mainline.

" - } - }, - "BrowserArn": { - "base": null, - "refs": { - "BrowserSummary$browserArn": "

The Amazon Resource Name (ARN) of the browser.

", - "CreateBrowserResponse$browserArn": "

The Amazon Resource Name (ARN) of the created browser.

", - "GetBrowserResponse$browserArn": "

The Amazon Resource Name (ARN) of the browser.

" - } - }, - "BrowserEnterprisePolicies": { - "base": null, - "refs": { - "CreateBrowserRequest$enterprisePolicies": "

A list of enterprise policy files for the browser.

", - "GetBrowserResponse$enterprisePolicies": "

The list of enterprise policy files configured for the browser.

" - } - }, - "BrowserEnterprisePolicy": { - "base": "

Browser enterprise policy configuration.

", - "refs": { - "BrowserEnterprisePolicies$member": null - } - }, - "BrowserEnterprisePolicyType": { - "base": null, - "refs": { - "BrowserEnterprisePolicy$type": "

The type of browser enterprise policy. Available values are MANAGED and RECOMMENDED.

" - } - }, - "BrowserId": { - "base": null, - "refs": { - "BrowserProfileSummary$lastSavedBrowserId": "

The identifier of the browser from which data was last saved to this profile.

", - "BrowserSummary$browserId": "

The unique identifier of the browser.

", - "CreateBrowserResponse$browserId": "

The unique identifier of the created browser.

", - "DeleteBrowserRequest$browserId": "

The unique identifier of the browser to delete.

", - "DeleteBrowserResponse$browserId": "

The unique identifier of the deleted browser.

", - "GetBrowserProfileResponse$lastSavedBrowserId": "

The identifier of the browser from which data was last saved to this profile.

", - "GetBrowserRequest$browserId": "

The unique identifier of the browser to retrieve.

", - "GetBrowserResponse$browserId": "

The unique identifier of the browser.

" - } - }, - "BrowserNetworkConfiguration": { - "base": "

The network configuration for a browser. This structure defines how the browser connects to the network.

", - "refs": { - "CreateBrowserRequest$networkConfiguration": "

The network configuration for the browser. This configuration specifies the network mode for the browser.

", - "GetBrowserResponse$networkConfiguration": null - } - }, - "BrowserNetworkMode": { - "base": null, - "refs": { - "BrowserNetworkConfiguration$networkMode": "

The network mode for the browser. This field specifies how the browser connects to the network.

" - } - }, - "BrowserProfileArn": { - "base": null, - "refs": { - "BrowserProfileSummary$profileArn": "

The Amazon Resource Name (ARN) of the browser profile.

", - "CreateBrowserProfileResponse$profileArn": "

The Amazon Resource Name (ARN) of the created browser profile.

", - "DeleteBrowserProfileResponse$profileArn": "

The Amazon Resource Name (ARN) of the deleted browser profile.

", - "GetBrowserProfileResponse$profileArn": "

The Amazon Resource Name (ARN) of the browser profile.

" - } - }, - "BrowserProfileId": { - "base": null, - "refs": { - "BrowserProfileSummary$profileId": "

The unique identifier of the browser profile.

", - "CreateBrowserProfileResponse$profileId": "

The unique identifier of the created browser profile.

", - "DeleteBrowserProfileRequest$profileId": "

The unique identifier of the browser profile to delete.

", - "DeleteBrowserProfileResponse$profileId": "

The unique identifier of the deleted browser profile.

", - "GetBrowserProfileRequest$profileId": "

The unique identifier of the browser profile to retrieve.

", - "GetBrowserProfileResponse$profileId": "

The unique identifier of the browser profile.

" - } - }, - "BrowserProfileName": { - "base": null, - "refs": { - "BrowserProfileSummary$name": "

The name of the browser profile.

", - "CreateBrowserProfileRequest$name": "

The name of the browser profile. The name must be unique within your account and can contain alphanumeric characters and underscores.

", - "GetBrowserProfileResponse$name": "

The name of the browser profile.

", - "ListBrowserProfilesRequest$name": "

The name of the browser profile to filter results by.

" - } - }, - "BrowserProfileStatus": { - "base": "

The status of a browser profile.

", - "refs": { - "BrowserProfileSummary$status": "

The current status of the browser profile. Possible values include READY, SAVING, DELETING, and DELETED.

", - "CreateBrowserProfileResponse$status": "

The current status of the browser profile.

", - "DeleteBrowserProfileResponse$status": "

The current status of the browser profile deletion.

", - "GetBrowserProfileResponse$status": "

The current status of the browser profile.

" - } - }, - "BrowserProfileSummaries": { - "base": null, - "refs": { - "ListBrowserProfilesResponse$profileSummaries": "

The list of browser profile summaries.

" - } - }, - "BrowserProfileSummary": { - "base": "

Contains summary information about a browser profile. A browser profile stores persistent browser data that can be reused across browser sessions.

", - "refs": { - "BrowserProfileSummaries$member": null - } - }, - "BrowserSessionId": { - "base": null, - "refs": { - "BrowserProfileSummary$lastSavedBrowserSessionId": "

The identifier of the browser session from which data was last saved to this profile.

", - "GetBrowserProfileResponse$lastSavedBrowserSessionId": "

The identifier of the browser session from which data was last saved to this profile.

" - } - }, - "BrowserSigningConfigInput": { - "base": "

Configuration for enabling browser signing capabilities that allow agents to cryptographically identify themselves to websites using HTTP message signatures.

", - "refs": { - "CreateBrowserRequest$browserSigning": "

The browser signing configuration that enables cryptographic agent identification using HTTP message signatures for web bot authentication.

" - } - }, - "BrowserSigningConfigOutput": { - "base": "

The current browser signing configuration that shows whether cryptographic agent identification is enabled for web bot authentication.

", - "refs": { - "GetBrowserResponse$browserSigning": "

The browser signing configuration that shows whether cryptographic agent identification is enabled for web bot authentication.

" - } - }, - "BrowserStatus": { - "base": null, - "refs": { - "BrowserSummary$status": "

The current status of the browser.

", - "CreateBrowserResponse$status": "

The current status of the browser.

", - "DeleteBrowserResponse$status": "

The current status of the browser deletion.

", - "GetBrowserResponse$status": "

The current status of the browser.

" - } - }, - "BrowserSummaries": { - "base": null, - "refs": { - "ListBrowsersResponse$browserSummaries": "

The list of browser summaries.

" - } - }, - "BrowserSummary": { - "base": "

Contains summary information about a browser. A browser enables Amazon Bedrock AgentCore Agent to interact with web content.

", - "refs": { - "BrowserSummaries$member": null - } - }, - "CategoricalScaleDefinition": { - "base": "

The definition of a categorical rating scale option that provides a named category with its description for evaluation scoring.

", - "refs": { - "CategoricalScaleDefinitions$member": null - } - }, - "CategoricalScaleDefinitionLabelString": { - "base": null, - "refs": { - "CategoricalScaleDefinition$label": "

The label or name of this categorical rating option.

" - } - }, - "CategoricalScaleDefinitions": { - "base": null, - "refs": { - "RatingScale$categorical": "

The categorical rating scale with named categories and definitions for qualitative evaluation.

" - } - }, - "CedarPolicy": { - "base": "

Represents a Cedar policy statement within the AgentCore Policy system. Cedar is a policy language designed for authorization that provides human-readable, analyzable, and high-performance policy evaluation for controlling agent behavior and access decisions.

", - "refs": { - "PolicyDefinition$cedar": "

The Cedar policy definition within the policy definition structure. This contains the Cedar policy statement that defines the authorization logic using Cedar's human-readable, analyzable policy language. Cedar policies specify principals (who can access), actions (what operations are allowed), resources (what can be accessed), and optional conditions for fine-grained control. Cedar provides a formal policy language designed for authorization with deterministic evaluation, making policies testable, reviewable, and auditable. All Cedar policies follow a default-deny model where actions are denied unless explicitly permitted, and forbid policies always override permit policies.

" - } - }, - "Certificate": { - "base": "

A certificate to install in the browser or code interpreter.

", - "refs": { - "Certificates$member": null - } - }, - "CertificateLocation": { - "base": "

The location from which to retrieve a certificate.

", - "refs": { - "Certificate$location": "

The location of the certificate.

" - } - }, - "Certificates": { - "base": null, - "refs": { - "CreateBrowserRequest$certificates": "

A list of certificates to install in the browser.

", - "CreateCodeInterpreterRequest$certificates": "

A list of certificates to install in the code interpreter.

", - "GetBrowserResponse$certificates": "

The list of certificates configured for the browser.

", - "GetCodeInterpreterResponse$certificates": "

The list of certificates configured for the code interpreter.

" - } - }, - "ClaimMatchOperatorType": { - "base": null, - "refs": { - "AuthorizingClaimMatchValueType$claimMatchOperator": "

Defines the relationship between the claim field value and the value or values you're matching for.

" - } - }, - "ClaimMatchValueType": { - "base": "

The value or values to match for.

  • Include a matchValueString with the EQUALS operator to specify a string that matches the claim field value.

  • Include a matchValueArray to specify an array of string values. You can use the following operators:

    • Use CONTAINS to yield a match if the claim field value is in the array.

    • Use CONTAINS_ANY to yield a match if the claim field value contains any of the strings in the array.

", - "refs": { - "AuthorizingClaimMatchValueType$claimMatchValue": "

The value or values to match for.

" - } - }, - "ClientAuthenticationMethodType": { - "base": null, - "refs": { - "CustomOauth2ProviderConfigInput$clientAuthenticationMethod": "

The client authentication method to use when authenticating with the token endpoint.

", - "CustomOauth2ProviderConfigOutput$clientAuthenticationMethod": "

The client authentication method used when authenticating with the token endpoint.

" - } - }, - "ClientIdType": { - "base": null, - "refs": { - "AtlassianOauth2ProviderConfigInput$clientId": "

The client ID for the Atlassian OAuth2 provider. This identifier is assigned by Atlassian when you register your application.

", - "AtlassianOauth2ProviderConfigOutput$clientId": "

The client ID for the Atlassian OAuth2 provider.

", - "CustomOauth2ProviderConfigOutput$clientId": "

The client ID for the custom OAuth2 provider.

", - "GithubOauth2ProviderConfigInput$clientId": "

The client ID for the GitHub OAuth2 provider.

", - "GithubOauth2ProviderConfigOutput$clientId": "

The client ID for the GitHub OAuth2 provider.

", - "GoogleOauth2ProviderConfigInput$clientId": "

The client ID for the Google OAuth2 provider.

", - "GoogleOauth2ProviderConfigOutput$clientId": "

The client ID for the Google OAuth2 provider.

", - "IncludedOauth2ProviderConfigInput$clientId": "

The client ID for the supported OAuth2 provider. This identifier is assigned by the OAuth2 provider when you register your application.

", - "IncludedOauth2ProviderConfigOutput$clientId": "

The client ID for the supported OAuth2 provider.

", - "LinkedinOauth2ProviderConfigInput$clientId": "

The client ID for the LinkedIn OAuth2 provider. This identifier is assigned by LinkedIn when you register your application.

", - "LinkedinOauth2ProviderConfigOutput$clientId": "

The client ID for the LinkedIn OAuth2 provider.

", - "MicrosoftOauth2ProviderConfigInput$clientId": "

The client ID for the Microsoft OAuth2 provider.

", - "MicrosoftOauth2ProviderConfigOutput$clientId": "

The client ID for the Microsoft OAuth2 provider.

", - "SalesforceOauth2ProviderConfigInput$clientId": "

The client ID for the Salesforce OAuth2 provider.

", - "SalesforceOauth2ProviderConfigOutput$clientId": "

The client ID for the Salesforce OAuth2 provider.

", - "SlackOauth2ProviderConfigInput$clientId": "

The client ID for the Slack OAuth2 provider.

", - "SlackOauth2ProviderConfigOutput$clientId": "

The client ID for the Slack OAuth2 provider.

" - } - }, - "ClientToken": { - "base": null, - "refs": { - "AddDatasetExamplesRequest$clientToken": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "CreateAgentRuntimeEndpointRequest$clientToken": "

A unique, case-sensitive identifier to ensure idempotency of the request.

", - "CreateAgentRuntimeRequest$clientToken": "

A unique, case-sensitive identifier to ensure idempotency of the request.

", - "CreateBrowserProfileRequest$clientToken": "

A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock AgentCore ignores the request but does not return an error.

", - "CreateBrowserRequest$clientToken": "

A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock AgentCore ignores the request but does not return an error.

", - "CreateCodeInterpreterRequest$clientToken": "

A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock AgentCore ignores the request but does not return an error.

", - "CreateConfigurationBundleRequest$clientToken": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "CreateDatasetRequest$clientToken": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "CreateDatasetVersionRequest$clientToken": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "CreateEvaluatorRequest$clientToken": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "CreateGatewayRequest$clientToken": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "CreateGatewayRuleRequest$clientToken": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "CreateGatewayTargetRequest$clientToken": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "CreateHarnessEndpointRequest$clientToken": "

A unique, case-sensitive identifier to ensure idempotency of the request.

", - "CreateHarnessRequest$clientToken": "

A unique, case-sensitive identifier to ensure idempotency of the request.

", - "CreateOnlineEvaluationConfigRequest$clientToken": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "CreatePaymentConnectorRequest$clientToken": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "CreatePaymentManagerRequest$clientToken": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "CreatePolicyEngineRequest$clientToken": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request with the same client token, the service returns the same response without creating a duplicate policy engine.

", - "CreatePolicyRequest$clientToken": "

A unique, case-sensitive identifier to ensure the idempotency of the request. The AWS SDK automatically generates this token, so you don't need to provide it in most cases. If you retry a request with the same client token, the service returns the same response without creating a duplicate policy.

", - "CreateRegistryRecordRequest$clientToken": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "CreateRegistryRequest$clientToken": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "DeleteAgentRuntimeEndpointRequest$clientToken": "

A unique, case-sensitive identifier to ensure idempotency of the request.

", - "DeleteAgentRuntimeRequest$clientToken": "

A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request but does not return an error.

", - "DeleteBrowserProfileRequest$clientToken": "

A unique, case-sensitive identifier to ensure idempotency of the request.

", - "DeleteBrowserRequest$clientToken": "

A unique, case-sensitive identifier to ensure idempotency of the request.

", - "DeleteCodeInterpreterRequest$clientToken": "

A unique, case-sensitive identifier to ensure idempotency of the request.

", - "DeleteDatasetExamplesRequest$clientToken": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "DeleteHarnessEndpointRequest$clientToken": "

A unique, case-sensitive identifier to ensure idempotency of the request.

", - "DeleteHarnessRequest$clientToken": "

A unique, case-sensitive identifier to ensure idempotency of the request.

", - "DeletePaymentConnectorRequest$clientToken": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "DeletePaymentManagerRequest$clientToken": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "StartPolicyGenerationRequest$clientToken": "

A unique, case-sensitive identifier to ensure the idempotency of the request. The AWS SDK automatically generates this token, so you don't need to provide it in most cases. If you retry a request with the same client token, the service returns the same response without starting a duplicate generation.

", - "UpdateAgentRuntimeEndpointRequest$clientToken": "

A unique, case-sensitive identifier to ensure idempotency of the request.

", - "UpdateAgentRuntimeRequest$clientToken": "

A unique, case-sensitive identifier to ensure idempotency of the request.

", - "UpdateConfigurationBundleRequest$clientToken": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "UpdateDatasetExamplesRequest$clientToken": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "UpdateDatasetRequest$clientToken": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "UpdateEvaluatorRequest$clientToken": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "UpdateHarnessEndpointRequest$clientToken": "

A unique, case-sensitive identifier to ensure idempotency of the request.

", - "UpdateHarnessRequest$clientToken": "

A unique, case-sensitive identifier to ensure idempotency of the request.

", - "UpdateOnlineEvaluationConfigRequest$clientToken": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "UpdatePaymentConnectorRequest$clientToken": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "UpdatePaymentManagerRequest$clientToken": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

" - } - }, - "CloudWatchLogsInputConfig": { - "base": "

The configuration for reading agent traces from CloudWatch logs as input for online evaluation.

", - "refs": { - "DataSourceConfig$cloudWatchLogs": "

The CloudWatch logs configuration for reading agent traces from log groups.

" - } - }, - "CloudWatchLogsInputConfigLogGroupNamesList": { - "base": null, - "refs": { - "CloudWatchLogsInputConfig$logGroupNames": "

The list of CloudWatch log group names to monitor for agent traces.

" - } - }, - "CloudWatchLogsInputConfigServiceNamesList": { - "base": null, - "refs": { - "CloudWatchLogsInputConfig$serviceNames": "

The list of service names to filter traces within the specified log groups. Used to identify relevant agent sessions.

" - } - }, - "CloudWatchOutputConfig": { - "base": "

The configuration for writing evaluation results to CloudWatch logs with embedded metric format (EMF) for monitoring.

", - "refs": { - "OutputConfig$cloudWatchConfig": "

The CloudWatch configuration for writing evaluation results to CloudWatch logs with embedded metric format.

" - } - }, - "ClusteringConfig": { - "base": "

Configuration for periodic batch evaluation clustering, specifying how often clustering jobs run.

", - "refs": { - "CreateOnlineEvaluationConfigRequest$clusteringConfig": "

Configuration for periodic batch evaluation clustering of insight results.

", - "GetOnlineEvaluationConfigResponse$clusteringConfig": "

The clustering configuration for periodic batch evaluation.

", - "OnlineEvaluationConfigSummary$clusteringConfig": "

The clustering configuration for periodic batch evaluation.

", - "UpdateOnlineEvaluationConfigRequest$clusteringConfig": "

The updated clustering configuration for periodic batch evaluation.

" - } - }, - "ClusteringFrequency": { - "base": null, - "refs": { - "ClusteringFrequencyList$member": null - } - }, - "ClusteringFrequencyList": { - "base": null, - "refs": { - "ClusteringConfig$frequencies": "

The list of frequencies at which clustering batch evaluations are triggered.

" - } - }, - "Code": { - "base": "

The source code configuration that specifies the location and details of the code to be executed.

", - "refs": { - "CodeConfiguration$code": "

The source code location and configuration details.

" - } - }, - "CodeBasedEvaluatorConfig": { - "base": "

Configuration for a code-based evaluator. Specify the Lambda function to use for evaluation.

", - "refs": { - "EvaluatorConfig$codeBased": "

Configuration for a code-based evaluator that uses a customer-managed Lambda function to programmatically assess agent performance.

" - } - }, - "CodeConfiguration": { - "base": "

The configuration for the source code that defines how the agent runtime code should be executed, including the code location, runtime environment, and entry point.

", - "refs": { - "AgentRuntimeArtifact$codeConfiguration": "

The code configuration for the agent runtime artifact, including the source code location and execution settings.

" - } - }, - "CodeConfigurationEntryPointList": { - "base": null, - "refs": { - "CodeConfiguration$entryPoint": "

The entry point for the code execution, specifying the function or method that should be invoked when the code runs.

" - } - }, - "CodeInterpreterArn": { - "base": null, - "refs": { - "CodeInterpreterSummary$codeInterpreterArn": "

The Amazon Resource Name (ARN) of the code interpreter.

", - "CreateCodeInterpreterResponse$codeInterpreterArn": "

The Amazon Resource Name (ARN) of the created code interpreter.

", - "GetCodeInterpreterResponse$codeInterpreterArn": "

The Amazon Resource Name (ARN) of the code interpreter.

" - } - }, - "CodeInterpreterId": { - "base": null, - "refs": { - "CodeInterpreterSummary$codeInterpreterId": "

The unique identifier of the code interpreter.

", - "CreateCodeInterpreterResponse$codeInterpreterId": "

The unique identifier of the created code interpreter.

", - "DeleteCodeInterpreterRequest$codeInterpreterId": "

The unique identifier of the code interpreter to delete.

", - "DeleteCodeInterpreterResponse$codeInterpreterId": "

The unique identifier of the deleted code interpreter.

", - "GetCodeInterpreterRequest$codeInterpreterId": "

The unique identifier of the code interpreter to retrieve.

", - "GetCodeInterpreterResponse$codeInterpreterId": "

The unique identifier of the code interpreter.

" - } - }, - "CodeInterpreterNetworkConfiguration": { - "base": "

The network configuration for a code interpreter. This structure defines how the code interpreter connects to the network.

", - "refs": { - "CreateCodeInterpreterRequest$networkConfiguration": "

The network configuration for the code interpreter. This configuration specifies the network mode for the code interpreter.

", - "GetCodeInterpreterResponse$networkConfiguration": null - } - }, - "CodeInterpreterNetworkMode": { - "base": null, - "refs": { - "CodeInterpreterNetworkConfiguration$networkMode": "

The network mode for the code interpreter. This field specifies how the code interpreter connects to the network.

" - } - }, - "CodeInterpreterStatus": { - "base": null, - "refs": { - "CodeInterpreterSummary$status": "

The current status of the code interpreter.

", - "CreateCodeInterpreterResponse$status": "

The current status of the code interpreter.

", - "DeleteCodeInterpreterResponse$status": "

The current status of the code interpreter deletion.

", - "GetCodeInterpreterResponse$status": "

The current status of the code interpreter.

" - } - }, - "CodeInterpreterSummaries": { - "base": null, - "refs": { - "ListCodeInterpretersResponse$codeInterpreterSummaries": "

The list of code interpreter summaries.

" - } - }, - "CodeInterpreterSummary": { - "base": "

Contains summary information about a code interpreter. A code interpreter enables Amazon Bedrock AgentCore Agent to execute code.

", - "refs": { - "CodeInterpreterSummaries$member": null - } - }, - "CoinbaseCdpApiKeyIdType": { - "base": null, - "refs": { - "CoinbaseCdpConfigurationInput$apiKeyId": "

The API key identifier provided by Coinbase Developer Platform.

", - "CoinbaseCdpConfigurationOutput$apiKeyId": "

The API key identifier provided by Coinbase Developer Platform.

" - } - }, - "CoinbaseCdpConfigurationInput": { - "base": "

Coinbase CDP configuration — credentials provided by Coinbase Developer Platform.

", - "refs": { - "PaymentProviderConfigurationInput$coinbaseCdpConfiguration": "

The Coinbase CDP configuration.

" - } - }, - "CoinbaseCdpConfigurationOutput": { - "base": "

Coinbase CDP configuration output with secret ARNs.

", - "refs": { - "PaymentProviderConfigurationOutput$coinbaseCdpConfiguration": "

The Coinbase CDP configuration.

" - } - }, - "ComponentConfiguration": { - "base": "

The configuration for a component within a configuration bundle. The component type is inferred from the component identifier ARN.

", - "refs": { - "ComponentConfigurationMap$value": null - } - }, - "ComponentConfigurationMap": { - "base": null, - "refs": { - "CreateConfigurationBundleRequest$components": "

A map of component identifiers to their configurations. Each component represents a configurable element within the bundle.

", - "GetConfigurationBundleResponse$components": "

A map of component identifiers to their configurations for this version.

", - "GetConfigurationBundleVersionResponse$components": "

A map of component identifiers to their configurations for this version.

", - "UpdateConfigurationBundleRequest$components": "

The updated component configurations. Creates a new version of the bundle.

" - } - }, - "ComponentIdentifier": { - "base": null, - "refs": { - "ComponentConfigurationMap$key": null - } - }, - "ConcurrentModificationException": { - "base": "

Exception thrown when a resource is modified concurrently by multiple requests.

", - "refs": {} - }, - "Condition": { - "base": "

A condition that determines when a gateway rule applies. Conditions can match on principals or request paths.

", - "refs": { - "Conditions$member": null - } - }, - "Conditions": { - "base": null, - "refs": { - "CreateGatewayRuleRequest$conditions": "

The conditions that must be met for the rule to apply. Conditions can match on principals (IAM ARNs) or request paths.

", - "CreateGatewayRuleResponse$conditions": "

The conditions that must be met for the rule to apply.

", - "GatewayRuleDetail$conditions": "

The conditions that must be met for the rule to apply.

", - "GetGatewayRuleResponse$conditions": "

The conditions that must be met for the rule to apply.

", - "UpdateGatewayRuleRequest$conditions": "

The updated conditions for the rule.

", - "UpdateGatewayRuleResponse$conditions": "

The conditions that must be met for the rule to apply.

" - } - }, - "ConfigurationBundleAction": { - "base": "

An action that applies a configuration bundle override, either as a static override or a weighted split for A/B testing.

", - "refs": { - "Action$configurationBundle": "

An action that applies a configuration bundle override to the request.

" - } - }, - "ConfigurationBundleArn": { - "base": null, - "refs": { - "ConfigurationBundleSummary$bundleArn": "

The Amazon Resource Name (ARN) of the configuration bundle.

", - "ConfigurationBundleVersionSummary$bundleArn": "

The Amazon Resource Name (ARN) of the configuration bundle.

", - "CreateConfigurationBundleResponse$bundleArn": "

The Amazon Resource Name (ARN) of the created configuration bundle.

", - "GetConfigurationBundleResponse$bundleArn": "

The Amazon Resource Name (ARN) of the configuration bundle.

", - "GetConfigurationBundleVersionResponse$bundleArn": "

The Amazon Resource Name (ARN) of the configuration bundle.

", - "UpdateConfigurationBundleResponse$bundleArn": "

The Amazon Resource Name (ARN) of the updated configuration bundle.

" - } - }, - "ConfigurationBundleDescription": { - "base": null, - "refs": { - "ConfigurationBundleSummary$description": "

The description of the configuration bundle.

", - "CreateConfigurationBundleRequest$description": "

The description for the configuration bundle.

", - "GetConfigurationBundleResponse$description": "

The description of the configuration bundle.

", - "GetConfigurationBundleVersionResponse$description": "

The description of the configuration bundle.

", - "UpdateConfigurationBundleRequest$description": "

The updated description for the configuration bundle.

" - } - }, - "ConfigurationBundleId": { - "base": null, - "refs": { - "ConfigurationBundleSummary$bundleId": "

The unique identifier of the configuration bundle.

", - "ConfigurationBundleVersionSummary$bundleId": "

The unique identifier of the configuration bundle.

", - "CreateConfigurationBundleResponse$bundleId": "

The unique identifier of the created configuration bundle.

", - "DeleteConfigurationBundleRequest$bundleId": "

The unique identifier of the configuration bundle to delete.

", - "DeleteConfigurationBundleResponse$bundleId": "

The unique identifier of the deleted configuration bundle.

", - "GetConfigurationBundleRequest$bundleId": "

The unique identifier of the configuration bundle to retrieve.

", - "GetConfigurationBundleResponse$bundleId": "

The unique identifier of the configuration bundle.

", - "GetConfigurationBundleVersionRequest$bundleId": "

The unique identifier of the configuration bundle.

", - "GetConfigurationBundleVersionResponse$bundleId": "

The unique identifier of the configuration bundle.

", - "ListConfigurationBundleVersionsRequest$bundleId": "

The unique identifier of the configuration bundle to list versions for.

", - "UpdateConfigurationBundleRequest$bundleId": "

The unique identifier of the configuration bundle to update.

", - "UpdateConfigurationBundleResponse$bundleId": "

The unique identifier of the updated configuration bundle.

" - } - }, - "ConfigurationBundleName": { - "base": null, - "refs": { - "ConfigurationBundleSummary$bundleName": "

The name of the configuration bundle.

", - "CreateConfigurationBundleRequest$bundleName": "

The name for the configuration bundle. Names must be unique within your account.

", - "GetConfigurationBundleResponse$bundleName": "

The name of the configuration bundle.

", - "GetConfigurationBundleVersionResponse$bundleName": "

The name of the configuration bundle.

", - "UpdateConfigurationBundleRequest$bundleName": "

The updated name for the configuration bundle.

" - } - }, - "ConfigurationBundleReference": { - "base": "

A reference to a specific version of a configuration bundle.

", - "refs": { - "TrafficSplitEntry$configurationBundle": "

The configuration bundle reference for this variant.

" - } - }, - "ConfigurationBundleReferenceBundleVersionString": { - "base": null, - "refs": { - "ConfigurationBundleReference$bundleVersion": "

The version of the configuration bundle.

" - } - }, - "ConfigurationBundleStatus": { - "base": null, - "refs": { - "DeleteConfigurationBundleResponse$status": "

The status of the configuration bundle deletion operation.

" - } - }, - "ConfigurationBundleSummary": { - "base": "

Summary information about a configuration bundle.

", - "refs": { - "ConfigurationBundleSummaryList$member": null - } - }, - "ConfigurationBundleSummaryList": { - "base": null, - "refs": { - "ListConfigurationBundlesResponse$bundles": "

The list of configuration bundle summaries.

" - } - }, - "ConfigurationBundleVersion": { - "base": null, - "refs": { - "ConfigurationBundleVersionList$member": null, - "ConfigurationBundleVersionSummary$versionId": "

The version identifier of this configuration bundle version.

", - "CreateConfigurationBundleResponse$versionId": "

The initial version identifier of the configuration bundle.

", - "GetConfigurationBundleResponse$versionId": "

The version identifier of this configuration bundle.

", - "GetConfigurationBundleVersionRequest$versionId": "

The version identifier of the configuration bundle version to retrieve.

", - "GetConfigurationBundleVersionResponse$versionId": "

The version identifier of this configuration bundle version.

", - "UpdateConfigurationBundleResponse$versionId": "

The new version identifier created by this update.

" - } - }, - "ConfigurationBundleVersionList": { - "base": null, - "refs": { - "UpdateConfigurationBundleRequest$parentVersionIds": "

A list of parent version identifiers for lineage tracking. Regular commits have a single parent. Merge commits have two parents: the target branch parent and the source branch parent. If the branch already exists, the first parent must be the latest version on that branch.

", - "VersionLineageMetadata$parentVersionIds": "

A list of parent version identifiers. Regular commits have 0-1 parents. Merge commits have 2 parents: the target branch parent and the source branch parent. The first parent represents the primary lineage.

" - } - }, - "ConfigurationBundleVersionSummary": { - "base": "

Summary information about a configuration bundle version.

", - "refs": { - "ConfigurationBundleVersionSummaryList$member": null - } - }, - "ConfigurationBundleVersionSummaryList": { - "base": null, - "refs": { - "ListConfigurationBundleVersionsResponse$versions": "

The list of configuration bundle version summaries.

" - } - }, - "ConflictException": { - "base": "

This exception is thrown when there is a conflict performing an operation

", - "refs": {} - }, - "ConnectorConfiguration": { - "base": "

Configuration for a single tool within a connector.

", - "refs": { - "ConnectorConfigurations$member": null - } - }, - "ConnectorConfigurationDescriptionString": { - "base": null, - "refs": { - "ConnectorConfiguration$description": "

An agent-facing description override for this tool.

" - } - }, - "ConnectorConfigurationNameString": { - "base": null, - "refs": { - "ConnectorConfiguration$name": "

The tool or operation name (for example, retrieve or webSearch).

" - } - }, - "ConnectorConfigurations": { - "base": null, - "refs": { - "ConnectorTargetConfiguration$configurations": "

A list of per-tool configurations for the connector.

" - } - }, - "ConnectorId": { - "base": null, - "refs": { - "ConnectorSource$connectorId": "

The identifier for the connector integration (for example, bedrock-knowledge-bases).

" - } - }, - "ConnectorParameterOverride": { - "base": "

Specifies a parameter override for a connector tool, allowing you to control parameter visibility and descriptions.

", - "refs": { - "ConnectorParameterOverrides$member": null - } - }, - "ConnectorParameterOverrides": { - "base": null, - "refs": { - "ConnectorConfiguration$parameterOverrides": "

Parameters to expose to the agent at runtime, with optional description overrides.

" - } - }, - "ConnectorSource": { - "base": "

The source identifying the connector integration.

", - "refs": { - "ConnectorTargetConfiguration$source": "

The source configuration identifying which connector to use.

" - } - }, - "ConnectorTargetConfiguration": { - "base": "

Configuration for a connector integration target. Connectors provide pre-built integrations with Amazon Web Services services and third-party tools.

", - "refs": { - "McpTargetConfiguration$connector": "

The connector integration configuration for the Model Context Protocol target. This configuration defines how the gateway uses a pre-built connector to communicate with the target.

" - } - }, - "ConnectorVersion": { - "base": null, - "refs": { - "ConnectorSource$version": "

The version of the connector to use (for example, 1.1.0). If you don't specify a version, the service uses the latest available version.

" - } - }, - "ConsolidationConfiguration": { - "base": "

Contains consolidation configuration information for a memory strategy.

", - "refs": { - "StrategyConfiguration$consolidation": "

The consolidation configuration for the memory strategy.

" - } - }, - "ContainerConfiguration": { - "base": "

Representation of a container configuration.

", - "refs": { - "AgentRuntimeArtifact$containerConfiguration": "

The container configuration for the agent artifact.

", - "HarnessEnvironmentArtifact$containerConfiguration": null - } - }, - "Content": { - "base": "

Represents content input for policy generation operations. This structure encapsulates the natural language descriptions or other content formats that are used as input for AI-powered policy generation.

", - "refs": { - "StartPolicyGenerationRequest$content": "

The natural language description of the desired policy behavior. This content is processed by AI to generate corresponding Cedar policy statements that match the described intent.

" - } - }, - "ContentConfiguration": { - "base": "

Defines what content to stream and at what level of detail.

", - "refs": { - "KinesisResourceContentConfigurationsList$member": null - } - }, - "ContentLevel": { - "base": null, - "refs": { - "ContentConfiguration$level": "

Level of detail for streamed content.

" - } - }, - "ContentType": { - "base": null, - "refs": { - "ContentConfiguration$type": "

Type of content to stream.

" - } - }, - "CreateAgentRuntimeEndpointRequest": { - "base": null, - "refs": {} - }, - "CreateAgentRuntimeEndpointResponse": { - "base": null, - "refs": {} - }, - "CreateAgentRuntimeRequest": { - "base": null, - "refs": {} - }, - "CreateAgentRuntimeResponse": { - "base": null, - "refs": {} - }, - "CreateApiKeyCredentialProviderRequest": { - "base": null, - "refs": {} - }, - "CreateApiKeyCredentialProviderResponse": { - "base": null, - "refs": {} - }, - "CreateBrowserProfileRequest": { - "base": null, - "refs": {} - }, - "CreateBrowserProfileResponse": { - "base": null, - "refs": {} - }, - "CreateBrowserRequest": { - "base": null, - "refs": {} - }, - "CreateBrowserResponse": { - "base": null, - "refs": {} - }, - "CreateCodeInterpreterRequest": { - "base": null, - "refs": {} - }, - "CreateCodeInterpreterResponse": { - "base": null, - "refs": {} - }, - "CreateConfigurationBundleRequest": { - "base": null, - "refs": {} - }, - "CreateConfigurationBundleRequestCommitMessageString": { - "base": null, - "refs": { - "CreateConfigurationBundleRequest$commitMessage": "

A commit message describing the initial version of the configuration bundle.

" - } - }, - "CreateConfigurationBundleResponse": { - "base": null, - "refs": {} - }, - "CreateDatasetRequest": { - "base": null, - "refs": {} - }, - "CreateDatasetRequestDescriptionString": { - "base": null, - "refs": { - "CreateDatasetRequest$description": "

A description of the dataset.

" - } - }, - "CreateDatasetResponse": { - "base": null, - "refs": {} - }, - "CreateDatasetVersionRequest": { - "base": null, - "refs": {} - }, - "CreateDatasetVersionResponse": { - "base": null, - "refs": {} - }, - "CreateEvaluatorRequest": { - "base": null, - "refs": {} - }, - "CreateEvaluatorResponse": { - "base": null, - "refs": {} - }, - "CreateGatewayRequest": { - "base": null, - "refs": {} - }, - "CreateGatewayResponse": { - "base": null, - "refs": {} - }, - "CreateGatewayRuleRequest": { - "base": null, - "refs": {} - }, - "CreateGatewayRuleResponse": { - "base": null, - "refs": {} - }, - "CreateGatewayTargetRequest": { - "base": null, - "refs": {} - }, - "CreateGatewayTargetResponse": { - "base": null, - "refs": {} - }, - "CreateHarnessEndpointRequest": { - "base": null, - "refs": {} - }, - "CreateHarnessEndpointResponse": { - "base": null, - "refs": {} - }, - "CreateHarnessRequest": { - "base": null, - "refs": {} - }, - "CreateHarnessResponse": { - "base": null, - "refs": {} - }, - "CreateMemoryInput": { - "base": null, - "refs": {} - }, - "CreateMemoryInputClientTokenString": { - "base": null, - "refs": { - "CreateMemoryInput$clientToken": "

A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request but does not return an error.

" - } - }, - "CreateMemoryInputEventExpiryDurationInteger": { - "base": null, - "refs": { - "CreateMemoryInput$eventExpiryDuration": "

The duration after which memory events expire. Specified as an ISO 8601 duration.

" - } - }, - "CreateMemoryOutput": { - "base": null, - "refs": {} - }, - "CreateOauth2CredentialProviderRequest": { - "base": null, - "refs": {} - }, - "CreateOauth2CredentialProviderResponse": { - "base": null, - "refs": {} - }, - "CreateOnlineEvaluationConfigRequest": { - "base": null, - "refs": {} - }, - "CreateOnlineEvaluationConfigResponse": { - "base": null, - "refs": {} - }, - "CreatePaymentConnectorRequest": { - "base": null, - "refs": {} - }, - "CreatePaymentConnectorResponse": { - "base": null, - "refs": {} - }, - "CreatePaymentCredentialProviderRequest": { - "base": null, - "refs": {} - }, - "CreatePaymentCredentialProviderResponse": { - "base": null, - "refs": {} - }, - "CreatePaymentManagerRequest": { - "base": null, - "refs": {} - }, - "CreatePaymentManagerResponse": { - "base": null, - "refs": {} - }, - "CreatePolicyEngineRequest": { - "base": null, - "refs": {} - }, - "CreatePolicyEngineResponse": { - "base": null, - "refs": {} - }, - "CreatePolicyRequest": { - "base": null, - "refs": {} - }, - "CreatePolicyResponse": { - "base": null, - "refs": {} - }, - "CreateRegistryRecordRequest": { - "base": null, - "refs": {} - }, - "CreateRegistryRecordResponse": { - "base": null, - "refs": {} - }, - "CreateRegistryRequest": { - "base": null, - "refs": {} - }, - "CreateRegistryResponse": { - "base": null, - "refs": {} - }, - "CreateWorkloadIdentityRequest": { - "base": null, - "refs": {} - }, - "CreateWorkloadIdentityResponse": { - "base": null, - "refs": {} - }, - "CredentialProvider": { - "base": "

A credential provider for gateway authentication. This structure contains the configuration for authenticating with the target endpoint.

", - "refs": { - "CredentialProviderConfiguration$credentialProvider": "

The credential provider. This field contains the specific configuration for the credential provider type.

" - } - }, - "CredentialProviderArn": { - "base": null, - "refs": { - "RegistryRecordOAuthCredentialProvider$providerArn": "

The Amazon Resource Name (ARN) of the OAuth credential provider resource.

" - } - }, - "CredentialProviderArnType": { - "base": null, - "refs": { - "CreateOauth2CredentialProviderResponse$credentialProviderArn": "

The Amazon Resource Name (ARN) of the OAuth2 credential provider.

", - "GetOauth2CredentialProviderResponse$credentialProviderArn": "

ARN of the credential provider requested.

", - "Oauth2CredentialProviderItem$credentialProviderArn": "

The Amazon Resource Name (ARN) of the OAuth2 credential provider.

", - "UpdateOauth2CredentialProviderResponse$credentialProviderArn": "

The Amazon Resource Name (ARN) of the OAuth2 credential provider.

" - } - }, - "CredentialProviderConfiguration": { - "base": "

The configuration for a credential provider. This structure defines how the gateway authenticates with the target endpoint.

", - "refs": { - "CredentialProviderConfigurations$member": null - } - }, - "CredentialProviderConfigurations": { - "base": null, - "refs": { - "CreateGatewayTargetRequest$credentialProviderConfigurations": "

The credential provider configurations for the target. These configurations specify how the gateway authenticates with the target endpoint.

", - "CreateGatewayTargetResponse$credentialProviderConfigurations": "

The credential provider configurations for the target.

", - "GatewayTarget$credentialProviderConfigurations": "

The provider configurations.

", - "GetGatewayTargetResponse$credentialProviderConfigurations": "

The credential provider configurations for the gateway target.

", - "UpdateGatewayTargetRequest$credentialProviderConfigurations": "

The updated credential provider configurations for the gateway target.

", - "UpdateGatewayTargetResponse$credentialProviderConfigurations": "

The updated credential provider configurations for the gateway target.

" - } - }, - "CredentialProviderName": { - "base": null, - "refs": { - "ApiKeyCredentialProviderItem$name": "

The name of the API key credential provider.

", - "CreateApiKeyCredentialProviderRequest$name": "

The name of the API key credential provider. The name must be unique within your account.

", - "CreateApiKeyCredentialProviderResponse$name": "

The name of the created API key credential provider.

", - "CreateOauth2CredentialProviderRequest$name": "

The name of the OAuth2 credential provider. The name must be unique within your account.

", - "CreateOauth2CredentialProviderResponse$name": "

The name of the OAuth2 credential provider.

", - "CreatePaymentCredentialProviderRequest$name": "

Unique name for the payment credential provider.

", - "CreatePaymentCredentialProviderResponse$name": "

The name of the created payment credential provider.

", - "DeleteApiKeyCredentialProviderRequest$name": "

The name of the API key credential provider to delete.

", - "DeleteOauth2CredentialProviderRequest$name": "

The name of the OAuth2 credential provider to delete.

", - "DeletePaymentCredentialProviderRequest$name": "

The name of the payment credential provider to delete.

", - "GetApiKeyCredentialProviderRequest$name": "

The name of the API key credential provider to retrieve.

", - "GetApiKeyCredentialProviderResponse$name": "

The name of the API key credential provider.

", - "GetOauth2CredentialProviderRequest$name": "

The name of the OAuth2 credential provider to retrieve.

", - "GetOauth2CredentialProviderResponse$name": "

The name of the OAuth2 credential provider.

", - "GetPaymentCredentialProviderRequest$name": "

The name of the payment credential provider to retrieve.

", - "GetPaymentCredentialProviderResponse$name": "

The name of the payment credential provider.

", - "Oauth2CredentialProviderItem$name": "

The name of the OAuth2 credential provider.

", - "PaymentCredentialProviderItem$name": "

The name of the payment credential provider.

", - "UpdateApiKeyCredentialProviderRequest$name": "

The name of the API key credential provider to update.

", - "UpdateApiKeyCredentialProviderResponse$name": "

The name of the API key credential provider.

", - "UpdateOauth2CredentialProviderRequest$name": "

The name of the OAuth2 credential provider to update.

", - "UpdateOauth2CredentialProviderResponse$name": "

The name of the OAuth2 credential provider.

", - "UpdatePaymentCredentialProviderRequest$name": "

The name of the payment credential provider to update.

", - "UpdatePaymentCredentialProviderResponse$name": "

The name of the updated payment credential provider.

" - } - }, - "CredentialProviderType": { - "base": null, - "refs": { - "CredentialProviderConfiguration$credentialProviderType": "

The type of credential provider. This field specifies which authentication method the gateway uses.

" - } - }, - "CredentialProviderVendorType": { - "base": null, - "refs": { - "CreateOauth2CredentialProviderRequest$credentialProviderVendor": "

The vendor of the OAuth2 credential provider. This specifies which OAuth2 implementation to use.

", - "GetOauth2CredentialProviderResponse$credentialProviderVendor": "

The vendor of the OAuth2 credential provider.

", - "Oauth2CredentialProviderItem$credentialProviderVendor": "

The vendor of the OAuth2 credential provider.

", - "UpdateOauth2CredentialProviderRequest$credentialProviderVendor": "

The vendor of the OAuth2 credential provider.

", - "UpdateOauth2CredentialProviderResponse$credentialProviderVendor": "

The vendor of the OAuth2 credential provider.

" - } - }, - "CredentialsProviderConfiguration": { - "base": "

The credential provider configuration for a payment connector. Specifies the payment provider type and its associated credential provider.

", - "refs": { - "CredentialsProviderConfigurations$member": null - } - }, - "CredentialsProviderConfigurations": { - "base": null, - "refs": { - "CreatePaymentConnectorRequest$credentialProviderConfigurations": "

The credential provider configurations for the payment connector. These configurations specify how the connector authenticates with the payment provider.

", - "CreatePaymentConnectorResponse$credentialProviderConfigurations": "

The credential provider configurations for the created payment connector.

", - "GetPaymentConnectorResponse$credentialProviderConfigurations": "

The credential provider configurations for the payment connector.

", - "UpdatePaymentConnectorRequest$credentialProviderConfigurations": "

The updated credential provider configurations for the payment connector.

", - "UpdatePaymentConnectorResponse$credentialProviderConfigurations": "

The credential provider configurations for the updated payment connector.

" - } - }, - "CustomClaimValidationType": { - "base": "

Defines the name of a custom claim field and rules for finding matches to authenticate its value.

", - "refs": { - "CustomClaimValidationsType$member": null - } - }, - "CustomClaimValidationsType": { - "base": null, - "refs": { - "CustomJWTAuthorizerConfiguration$customClaims": "

An array of objects that define a custom claim validation name, value, and operation

" - } - }, - "CustomConfigurationInput": { - "base": "

Input for custom configuration of a memory strategy.

", - "refs": { - "CustomMemoryStrategyInput$configuration": "

The configuration for the custom memory strategy.

" - } - }, - "CustomConsolidationConfiguration": { - "base": "

Contains custom consolidation configuration information.

", - "refs": { - "ConsolidationConfiguration$customConsolidationConfiguration": "

The custom consolidation configuration.

" - } - }, - "CustomConsolidationConfigurationInput": { - "base": "

Input for a custom consolidation configuration.

", - "refs": { - "ModifyConsolidationConfiguration$customConsolidationConfiguration": "

The updated custom consolidation configuration.

" - } - }, - "CustomDescriptor": { - "base": "

A custom descriptor for a registry record. Use this for resources such as APIs, Lambda functions, or servers that do not conform to a standard protocol like MCP or A2A.

", - "refs": { - "Descriptors$custom": "

The custom descriptor configuration. Use this when the descriptorType is CUSTOM.

", - "UpdatedCustomDescriptor$optionalValue": "

The updated custom descriptor value.

" - } - }, - "CustomEvaluatorArn": { - "base": null, - "refs": { - "CreateEvaluatorResponse$evaluatorArn": "

The Amazon Resource Name (ARN) of the created evaluator.

" - } - }, - "CustomEvaluatorName": { - "base": null, - "refs": { - "CreateEvaluatorRequest$evaluatorName": "

The name of the evaluator. Must be unique within your account.

" - } - }, - "CustomExtractionConfiguration": { - "base": "

Contains custom extraction configuration information.

", - "refs": { - "ExtractionConfiguration$customExtractionConfiguration": "

The custom extraction configuration.

" - } - }, - "CustomExtractionConfigurationInput": { - "base": "

Input for a custom extraction configuration.

", - "refs": { - "ModifyExtractionConfiguration$customExtractionConfiguration": "

The updated custom extraction configuration.

" - } - }, - "CustomJWTAuthorizerConfiguration": { - "base": "

Configuration for inbound JWT-based authorization, specifying how incoming requests should be authenticated.

", - "refs": { - "AuthorizerConfiguration$customJWTAuthorizer": "

The inbound JWT-based authorization, specifying how incoming requests should be authenticated.

" - } - }, - "CustomMemoryStrategyInput": { - "base": "

Input for creating a custom memory strategy.

", - "refs": { - "MemoryStrategyInput$customMemoryStrategy": "

Input for creating a custom memory strategy.

" - } - }, - "CustomOauth2ProviderConfigInput": { - "base": "

Input configuration for a custom OAuth2 provider.

", - "refs": { - "Oauth2ProviderConfigInput$customOauth2ProviderConfig": "

The configuration for a custom OAuth2 provider.

" - } - }, - "CustomOauth2ProviderConfigOutput": { - "base": "

Output configuration for a custom OAuth2 provider.

", - "refs": { - "Oauth2ProviderConfigOutput$customOauth2ProviderConfig": "

The output configuration for a custom OAuth2 provider.

" - } - }, - "CustomParameterMap": { - "base": null, - "refs": { - "RegistryRecordOAuthCredentialProvider$customParameters": "

Additional custom parameters for the OAuth flow.

" - } - }, - "CustomReflectionConfiguration": { - "base": "

Contains configurations for a custom reflection strategy.

", - "refs": { - "ReflectionConfiguration$customReflectionConfiguration": "

The configuration for a custom reflection strategy.

" - } - }, - "CustomReflectionConfigurationInput": { - "base": "

Input for a custom reflection configuration.

", - "refs": { - "ModifyReflectionConfiguration$customReflectionConfiguration": "

The updated custom reflection configuration.

" - } - }, - "CustomTransformConfiguration": { - "base": "

The configuration for custom transformations applied to requests and responses through the gateway. This structure defines how the gateway transforms data.

", - "refs": { - "CreateGatewayResponse$customTransformConfiguration": "

The custom transformation configuration for the gateway. This configuration defines how the gateway transforms requests and responses.

", - "GetGatewayResponse$customTransformConfiguration": "

The custom transformation configuration for the gateway. This configuration defines how the gateway transforms requests and responses.

", - "UpdateGatewayRequest$customTransformConfiguration": "

The updated custom transformation configuration for the gateway. This configuration defines how the gateway transforms requests and responses.

", - "UpdateGatewayResponse$customTransformConfiguration": "

The custom transformation configuration for the gateway. This configuration defines how the gateway transforms requests and responses.

" - } - }, - "DataSourceConfig": { - "base": "

The configuration that specifies where to read agent traces for online evaluation.

", - "refs": { - "CreateOnlineEvaluationConfigRequest$dataSourceConfig": "

The data source configuration that specifies CloudWatch log groups and service names to monitor for agent traces.

", - "GetOnlineEvaluationConfigResponse$dataSourceConfig": "

The data source configuration specifying CloudWatch log groups and service names to monitor.

", - "UpdateOnlineEvaluationConfigRequest$dataSourceConfig": "

The updated data source configuration specifying CloudWatch log groups and service names to monitor.

" - } - }, - "DataSourceType": { - "base": "

Source of examples to add to the dataset.

", - "refs": { - "AddDatasetExamplesRequest$source": "

Source of examples to add. Provide either inline examples or an S3 URI pointing to a JSONL file.

", - "CreateDatasetRequest$source": "

Source of initial examples. Provide either inline examples or an S3 URI pointing to a JSONL file.

" - } - }, - "DatasetArn": { - "base": null, - "refs": { - "AddDatasetExamplesResponse$datasetArn": "

The Amazon Resource Name (ARN) of the dataset.

", - "CreateDatasetResponse$datasetArn": "

The Amazon Resource Name (ARN) of the created dataset.

", - "CreateDatasetVersionResponse$datasetArn": "

The Amazon Resource Name (ARN) of the dataset.

", - "DatasetSummary$datasetArn": "

The Amazon Resource Name (ARN) of the dataset.

", - "DeleteDatasetExamplesResponse$datasetArn": "

The Amazon Resource Name (ARN) of the dataset.

", - "DeleteDatasetResponse$datasetArn": "

The Amazon Resource Name (ARN) of the dataset.

", - "GetDatasetResponse$datasetArn": "

The Amazon Resource Name (ARN) of the dataset.

", - "ListDatasetExamplesResponse$datasetArn": "

The Amazon Resource Name (ARN) of the dataset.

", - "UpdateDatasetExamplesResponse$datasetArn": "

The Amazon Resource Name (ARN) of the dataset.

", - "UpdateDatasetResponse$datasetArn": "

The Amazon Resource Name (ARN) of the updated dataset.

" - } - }, - "DatasetExampleList": { - "base": "

A list of dataset examples. Each element is a free-form JSON document whose structure is defined by the dataset's schema type.

", - "refs": { - "ListDatasetExamplesResponse$examples": "

Paginated example content. Each element is a JSON object containing at least an exampleId field plus the schema-specific content fields.

" - } - }, - "DatasetId": { - "base": null, - "refs": { - "AddDatasetExamplesRequest$datasetId": "

The unique identifier of the dataset to add examples to.

", - "AddDatasetExamplesResponse$datasetId": "

The unique identifier of the dataset.

", - "CreateDatasetResponse$datasetId": "

The unique identifier of the created dataset.

", - "CreateDatasetVersionRequest$datasetId": "

The unique identifier of the dataset to publish a version for.

", - "CreateDatasetVersionResponse$datasetId": "

The unique identifier of the dataset.

", - "DatasetSummary$datasetId": "

The unique identifier of the dataset.

", - "DeleteDatasetExamplesRequest$datasetId": "

The unique identifier of the dataset.

", - "DeleteDatasetExamplesResponse$datasetId": "

The unique identifier of the dataset.

", - "DeleteDatasetRequest$datasetId": "

The unique identifier of the dataset to delete.

", - "DeleteDatasetResponse$datasetId": "

The unique identifier of the dataset.

", - "GetDatasetRequest$datasetId": "

The unique identifier of the dataset to retrieve.

", - "GetDatasetResponse$datasetId": "

The unique identifier of the dataset.

", - "ListDatasetExamplesRequest$datasetId": "

The unique identifier of the dataset.

", - "ListDatasetExamplesResponse$datasetId": "

The unique identifier of the dataset.

", - "ListDatasetVersionsRequest$datasetId": "

The unique identifier of the dataset.

", - "UpdateDatasetExamplesRequest$datasetId": "

The unique identifier of the dataset.

", - "UpdateDatasetExamplesResponse$datasetId": "

The unique identifier of the dataset.

", - "UpdateDatasetRequest$datasetId": "

The unique identifier of the dataset to update.

", - "UpdateDatasetResponse$datasetId": "

The unique identifier of the updated dataset.

" - } - }, - "DatasetName": { - "base": null, - "refs": { - "CreateDatasetRequest$datasetName": "

Human-readable name for the dataset. Must be unique within the account. Immutable after creation.

", - "DatasetSummary$datasetName": "

The name of the dataset.

", - "GetDatasetResponse$datasetName": "

The name of the dataset.

" - } - }, - "DatasetSchemaType": { - "base": "

Versioned schema type for dataset examples. Each value identifies both the source format and the version of that format's schema.

", - "refs": { - "CreateDatasetRequest$schemaType": "

Versioned schema type governing the structure of examples. Immutable after creation.

", - "DatasetSummary$schemaType": "

The schema type of the dataset.

", - "GetDatasetResponse$schemaType": "

The schema type declared at create time. Immutable after creation.

" - } - }, - "DatasetStatus": { - "base": "

Dataset lifecycle and operation status.

", - "refs": { - "AddDatasetExamplesResponse$status": "

The current status of the dataset.

", - "CreateDatasetResponse$status": "

Always CREATING immediately after this call. Poll GetDataset until status transitions to ACTIVE or CREATE_FAILED.

", - "CreateDatasetVersionResponse$status": "

Always UPDATING immediately after this call. Poll GetDataset until status transitions to ACTIVE or UPDATE_FAILED.

", - "DatasetSummary$status": "

The current status of the dataset.

", - "DeleteDatasetExamplesResponse$status": "

The current status of the dataset.

", - "DeleteDatasetResponse$status": "

The current status of the dataset after the delete request.

", - "GetDatasetResponse$status": "

The current status of the dataset.

", - "UpdateDatasetExamplesResponse$status": "

The current status of the dataset.

" - } - }, - "DatasetSummary": { - "base": "

Summary information about a dataset.

", - "refs": { - "DatasetSummaryList$member": null - } - }, - "DatasetSummaryList": { - "base": null, - "refs": { - "ListDatasetsResponse$datasets": "

The list of datasets.

" - } - }, - "DatasetVersion": { - "base": "

Dataset version identifier. Accepts \"DRAFT\" or a non-negative integer string representing a published version number.

", - "refs": { - "CreateDatasetVersionResponse$datasetVersion": "

The version number being created.

", - "DatasetVersionSummary$datasetVersion": "

The version number of this published snapshot.

", - "DeleteDatasetRequest$datasetVersion": "

Optional version to delete. If absent, deletes the entire dataset. If provided, deletes only that specific version.

", - "DeleteDatasetResponse$datasetVersion": "

The version that was deleted.

", - "GetDatasetRequest$datasetVersion": "

Version to retrieve: \"DRAFT\" or a version number. Defaults to DRAFT if absent.

", - "GetDatasetResponse$datasetVersion": "

The resolved version: \"DRAFT\" (default) or the requested version number.

", - "ListDatasetExamplesRequest$datasetVersion": "

Version to paginate: \"DRAFT\" or a version number. Defaults to DRAFT if absent. Only used on the first request; for subsequent pages, the version is extracted from the pagination token.

", - "ListDatasetExamplesResponse$datasetVersion": "

The version returned.

" - } - }, - "DatasetVersionSummary": { - "base": "

Summary information about a published dataset version.

", - "refs": { - "DatasetVersionSummaryList$member": null - } - }, - "DatasetVersionSummaryList": { - "base": null, - "refs": { - "ListDatasetVersionsResponse$versions": "

The list of published dataset versions.

" - } - }, - "DateTimestamp": { - "base": null, - "refs": { - "AgentRuntime$lastUpdatedAt": "

The timestamp when the agent runtime was last updated.

", - "AgentRuntimeEndpoint$createdAt": "

The timestamp when the agent runtime endpoint was created.

", - "AgentRuntimeEndpoint$lastUpdatedAt": "

The timestamp when the agent runtime endpoint was last updated.

", - "BrowserProfileSummary$createdAt": "

The timestamp when the browser profile was created.

", - "BrowserProfileSummary$lastUpdatedAt": "

The timestamp when the browser profile was last updated.

", - "BrowserProfileSummary$lastSavedAt": "

The timestamp when browser session data was last saved to this profile.

", - "BrowserSummary$createdAt": "

The timestamp when the browser was created.

", - "BrowserSummary$lastUpdatedAt": "

The timestamp when the browser was last updated.

", - "CodeInterpreterSummary$createdAt": "

The timestamp when the code interpreter was created.

", - "CodeInterpreterSummary$lastUpdatedAt": "

The timestamp when the code interpreter was last updated.

", - "CreateAgentRuntimeEndpointResponse$createdAt": "

The timestamp when the AgentCore Runtime endpoint was created.

", - "CreateAgentRuntimeResponse$createdAt": "

The timestamp when the AgentCore Runtime was created.

", - "CreateBrowserProfileResponse$createdAt": "

The timestamp when the browser profile was created.

", - "CreateBrowserResponse$createdAt": "

The timestamp when the browser was created.

", - "CreateCodeInterpreterResponse$createdAt": "

The timestamp when the code interpreter was created.

", - "CreateGatewayResponse$createdAt": "

The timestamp when the gateway was created.

", - "CreateGatewayResponse$updatedAt": "

The timestamp when the gateway was last updated.

", - "CreateGatewayRuleResponse$createdAt": "

The timestamp when the rule was created.

", - "CreateGatewayTargetResponse$createdAt": "

The timestamp when the target was created.

", - "CreateGatewayTargetResponse$updatedAt": "

The timestamp when the target was last updated.

", - "CreateGatewayTargetResponse$lastSynchronizedAt": "

The last synchronization of the target.

", - "CreatePaymentConnectorResponse$createdAt": "

The timestamp when the payment connector was created.

", - "CreatePaymentManagerResponse$createdAt": "

The timestamp when the payment manager was created.

", - "CreatePolicyEngineResponse$createdAt": "

The timestamp when the policy engine was created. This is automatically set by the service and used for auditing and lifecycle management.

", - "CreatePolicyEngineResponse$updatedAt": "

The timestamp when the policy engine was last updated. For newly created policy engines, this matches the createdAt timestamp.

", - "CreatePolicyResponse$createdAt": "

The timestamp when the policy was created. This is automatically set by the service and used for auditing and lifecycle management.

", - "CreatePolicyResponse$updatedAt": "

The timestamp when the policy was last updated. For newly created policies, this matches the createdAt timestamp.

", - "DeleteBrowserProfileResponse$lastUpdatedAt": "

The timestamp when the browser profile was last updated.

", - "DeleteBrowserProfileResponse$lastSavedAt": "

The timestamp when browser session data was last saved to this profile before deletion.

", - "DeleteBrowserResponse$lastUpdatedAt": "

The timestamp when the browser was last updated.

", - "DeleteCodeInterpreterResponse$lastUpdatedAt": "

The timestamp when the code interpreter was last updated.

", - "DeletePolicyEngineResponse$createdAt": "

The timestamp when the deleted policy engine was originally created.

", - "DeletePolicyEngineResponse$updatedAt": "

The timestamp when the deleted policy engine was last modified before deletion. This tracks the final state of the policy engine before it was removed from the system.

", - "DeletePolicyResponse$createdAt": "

The timestamp when the deleted policy was originally created.

", - "DeletePolicyResponse$updatedAt": "

The timestamp when the deleted policy was last modified before deletion. This tracks the final state of the policy before it was removed from the system.

", - "GatewayRuleDetail$createdAt": "

The timestamp when the rule was created.

", - "GatewayRuleDetail$updatedAt": "

The timestamp when the rule was last updated.

", - "GatewaySummary$createdAt": "

The timestamp when the gateway was created.

", - "GatewaySummary$updatedAt": "

The timestamp when the gateway was last updated.

", - "GatewayTarget$createdAt": "

The date and time at which the target was created.

", - "GatewayTarget$updatedAt": "

The date and time at which the target was updated.

", - "GatewayTarget$lastSynchronizedAt": "

The last synchronization time.

", - "GetAgentRuntimeEndpointResponse$createdAt": "

The timestamp when the AgentCore Runtime endpoint was created.

", - "GetAgentRuntimeEndpointResponse$lastUpdatedAt": "

The timestamp when the AgentCore Runtime endpoint was last updated.

", - "GetAgentRuntimeResponse$createdAt": "

The timestamp when the AgentCore Runtime was created.

", - "GetAgentRuntimeResponse$lastUpdatedAt": "

The timestamp when the AgentCore Runtime was last updated.

", - "GetBrowserProfileResponse$createdAt": "

The timestamp when the browser profile was created.

", - "GetBrowserProfileResponse$lastUpdatedAt": "

The timestamp when the browser profile was last updated.

", - "GetBrowserProfileResponse$lastSavedAt": "

The timestamp when browser session data was last saved to this profile.

", - "GetBrowserResponse$createdAt": "

The timestamp when the browser was created.

", - "GetBrowserResponse$lastUpdatedAt": "

The timestamp when the browser was last updated.

", - "GetCodeInterpreterResponse$createdAt": "

The timestamp when the code interpreter was created.

", - "GetCodeInterpreterResponse$lastUpdatedAt": "

The timestamp when the code interpreter was last updated.

", - "GetGatewayResponse$createdAt": "

The timestamp when the gateway was created.

", - "GetGatewayResponse$updatedAt": "

The timestamp when the gateway was last updated.

", - "GetGatewayRuleResponse$createdAt": "

The timestamp when the rule was created.

", - "GetGatewayRuleResponse$updatedAt": "

The timestamp when the rule was last updated.

", - "GetGatewayTargetResponse$createdAt": "

The timestamp when the gateway target was created.

", - "GetGatewayTargetResponse$updatedAt": "

The timestamp when the gateway target was last updated.

", - "GetGatewayTargetResponse$lastSynchronizedAt": "

The last synchronization of the target.

", - "GetPaymentConnectorResponse$createdAt": "

The timestamp when the payment connector was created.

", - "GetPaymentConnectorResponse$lastUpdatedAt": "

The timestamp when the payment connector was last updated.

", - "GetPaymentManagerResponse$createdAt": "

The timestamp when the payment manager was created.

", - "GetPaymentManagerResponse$lastUpdatedAt": "

The timestamp when the payment manager was last updated.

", - "GetPolicyEngineResponse$createdAt": "

The timestamp when the policy engine was originally created.

", - "GetPolicyEngineResponse$updatedAt": "

The timestamp when the policy engine was last modified. This tracks the most recent changes to the policy engine configuration.

", - "GetPolicyEngineSummaryResponse$createdAt": "

The timestamp when the policy engine was originally created.

", - "GetPolicyEngineSummaryResponse$updatedAt": "

The timestamp when the policy engine was last modified.

", - "GetPolicyGenerationResponse$createdAt": "

The timestamp when the policy generation request was created. This is used for tracking and auditing generation operations and their lifecycle.

", - "GetPolicyGenerationResponse$updatedAt": "

The timestamp when the policy generation was last updated. This tracks the progress of the generation process and any status changes.

", - "GetPolicyGenerationSummaryResponse$createdAt": "

The timestamp when the policy generation request was created.

", - "GetPolicyGenerationSummaryResponse$updatedAt": "

The timestamp when the policy generation was last updated.

", - "GetPolicyResponse$createdAt": "

The timestamp when the policy was originally created.

", - "GetPolicyResponse$updatedAt": "

The timestamp when the policy was last modified. This tracks the most recent changes to the policy configuration.

", - "GetPolicySummaryResponse$createdAt": "

The timestamp when the policy was originally created.

", - "GetPolicySummaryResponse$updatedAt": "

The timestamp when the policy was last modified.

", - "GetRegistryRecordResponse$createdAt": "

The timestamp when the registry record was created.

", - "GetRegistryRecordResponse$updatedAt": "

The timestamp when the registry record was last updated.

", - "GetRegistryResponse$createdAt": "

The timestamp when the registry was created.

", - "GetRegistryResponse$updatedAt": "

The timestamp when the registry was last updated.

", - "Harness$createdAt": "

The createdAt time of the harness.

", - "Harness$updatedAt": "

The updatedAt time of the harness.

", - "HarnessEndpoint$createdAt": "

The timestamp when the endpoint was created.

", - "HarnessEndpoint$updatedAt": "

The timestamp when the endpoint was last updated.

", - "HarnessSummary$createdAt": "

The timestamp when the harness was created.

", - "HarnessSummary$updatedAt": "

The timestamp when the harness was last updated.

", - "HarnessVersionSummary$createdAt": "

The timestamp when this harness version was created.

", - "HarnessVersionSummary$updatedAt": "

The timestamp when this harness version was last updated.

", - "PaymentConnectorSummary$lastUpdatedAt": "

The timestamp when the payment connector was last updated.

", - "PaymentManagerSummary$createdAt": "

The timestamp when the payment manager was created.

", - "PaymentManagerSummary$lastUpdatedAt": "

The timestamp when the payment manager was last updated.

", - "Policy$createdAt": "

The timestamp when the policy was originally created. This is automatically set by the service and used for auditing and lifecycle management.

", - "Policy$updatedAt": "

The timestamp when the policy was last modified. This tracks the most recent changes to the policy configuration or metadata.

", - "PolicyEngine$createdAt": "

The timestamp when the policy engine was originally created. This is automatically set by the service and used for auditing and lifecycle management.

", - "PolicyEngine$updatedAt": "

The timestamp when the policy engine was last modified. This tracks the most recent changes to the policy engine configuration or metadata.

", - "PolicyEngineSummary$createdAt": "

The timestamp when the policy engine was originally created.

", - "PolicyEngineSummary$updatedAt": "

The timestamp when the policy engine was last modified.

", - "PolicyGeneration$createdAt": "

The timestamp when this policy generation request was created.

", - "PolicyGeneration$updatedAt": "

The timestamp when this policy generation was last updated.

", - "PolicyGenerationSummary$createdAt": "

The timestamp when this policy generation request was created.

", - "PolicyGenerationSummary$updatedAt": "

The timestamp when this policy generation was last updated.

", - "PolicySummary$createdAt": "

The timestamp when the policy was originally created.

", - "PolicySummary$updatedAt": "

The timestamp when the policy was last modified.

", - "RegistryRecordSummary$createdAt": "

The timestamp when the registry record was created.

", - "RegistryRecordSummary$updatedAt": "

The timestamp when the registry record was last updated.

", - "RegistrySummary$createdAt": "

The timestamp when the registry was created.

", - "RegistrySummary$updatedAt": "

The timestamp when the registry was last updated.

", - "StartPolicyGenerationResponse$createdAt": "

The timestamp when the policy generation request was created.

", - "StartPolicyGenerationResponse$updatedAt": "

The timestamp when the policy generation was last updated.

", - "SubmitRegistryRecordForApprovalResponse$updatedAt": "

The timestamp when the record was last updated.

", - "TargetSummary$createdAt": "

The timestamp when the target was created.

", - "TargetSummary$updatedAt": "

The timestamp when the target was last updated.

", - "TargetSummary$lastSynchronizedAt": "

The timestamp when the target was last synchronized.

", - "UpdateAgentRuntimeEndpointResponse$createdAt": "

The timestamp when the AgentCore Runtime endpoint was created.

", - "UpdateAgentRuntimeEndpointResponse$lastUpdatedAt": "

The timestamp when the AgentCore Runtime endpoint was last updated.

", - "UpdateAgentRuntimeResponse$createdAt": "

The timestamp when the AgentCore Runtime was created.

", - "UpdateAgentRuntimeResponse$lastUpdatedAt": "

The timestamp when the AgentCore Runtime was last updated.

", - "UpdateGatewayResponse$createdAt": "

The timestamp when the gateway was created.

", - "UpdateGatewayResponse$updatedAt": "

The timestamp when the gateway was last updated.

", - "UpdateGatewayRuleResponse$createdAt": "

The timestamp when the rule was created.

", - "UpdateGatewayRuleResponse$updatedAt": "

The timestamp when the rule was last updated.

", - "UpdateGatewayTargetResponse$createdAt": "

The timestamp when the gateway target was created.

", - "UpdateGatewayTargetResponse$updatedAt": "

The timestamp when the gateway target was last updated.

", - "UpdateGatewayTargetResponse$lastSynchronizedAt": "

The date and time at which the targets were last synchronized.

", - "UpdatePaymentConnectorResponse$lastUpdatedAt": "

The timestamp when the payment connector was last updated.

", - "UpdatePaymentManagerResponse$lastUpdatedAt": "

The timestamp when the payment manager was last updated.

", - "UpdatePolicyEngineResponse$createdAt": "

The original creation timestamp of the policy engine.

", - "UpdatePolicyEngineResponse$updatedAt": "

The timestamp when the policy engine was last updated.

", - "UpdatePolicyResponse$createdAt": "

The original creation timestamp of the policy.

", - "UpdatePolicyResponse$updatedAt": "

The timestamp when the policy was last updated.

", - "UpdateRegistryRecordResponse$createdAt": "

The timestamp when the registry record was created.

", - "UpdateRegistryRecordResponse$updatedAt": "

The timestamp when the registry record was last updated.

", - "UpdateRegistryRecordStatusResponse$updatedAt": "

The timestamp when the record was last updated.

", - "UpdateRegistryResponse$createdAt": "

The timestamp when the registry was created.

", - "UpdateRegistryResponse$updatedAt": "

The timestamp when the registry was last updated.

" - } - }, - "DecryptionFailure": { - "base": "

Exception thrown when decryption of a secret fails.

", - "refs": {} - }, - "DefaultApiKeyType": { - "base": null, - "refs": { - "CreateApiKeyCredentialProviderRequest$apiKey": "

The API key to use for authentication. This value is encrypted and stored securely.

", - "UpdateApiKeyCredentialProviderRequest$apiKey": "

The new API key to use for authentication. This value replaces the existing API key and is encrypted and stored securely.

" - } - }, - "DefaultClientIdType": { - "base": null, - "refs": { - "CustomOauth2ProviderConfigInput$clientId": "

The client ID for the custom OAuth2 provider.

" - } - }, - "DefaultClientSecretType": { - "base": null, - "refs": { - "AtlassianOauth2ProviderConfigInput$clientSecret": "

The client secret for the Atlassian OAuth2 provider. This secret is assigned by Atlassian and used along with the client ID to authenticate your application.

", - "CustomOauth2ProviderConfigInput$clientSecret": "

The client secret for the custom OAuth2 provider.

", - "GithubOauth2ProviderConfigInput$clientSecret": "

The client secret for the GitHub OAuth2 provider.

", - "GoogleOauth2ProviderConfigInput$clientSecret": "

The client secret for the Google OAuth2 provider.

", - "IncludedOauth2ProviderConfigInput$clientSecret": "

The client secret for the supported OAuth2 provider. This secret is assigned by the OAuth2 provider and used along with the client ID to authenticate your application.

", - "LinkedinOauth2ProviderConfigInput$clientSecret": "

The client secret for the LinkedIn OAuth2 provider. This secret is assigned by LinkedIn and used along with the client ID to authenticate your application.

", - "MicrosoftOauth2ProviderConfigInput$clientSecret": "

The client secret for the Microsoft OAuth2 provider.

", - "SalesforceOauth2ProviderConfigInput$clientSecret": "

The client secret for the Salesforce OAuth2 provider.

", - "SlackOauth2ProviderConfigInput$clientSecret": "

The client secret for the Slack OAuth2 provider.

" - } - }, - "DefaultCoinbaseCdpApiKeySecretType": { - "base": null, - "refs": { - "CoinbaseCdpConfigurationInput$apiKeySecret": "

The API key secret provided by Coinbase Developer Platform.

" - } - }, - "DefaultCoinbaseCdpWalletSecretType": { - "base": null, - "refs": { - "CoinbaseCdpConfigurationInput$walletSecret": "

The wallet secret provided by Coinbase Developer Platform.

" - } - }, - "DefaultStripePrivyAppSecretType": { - "base": null, - "refs": { - "StripePrivyConfigurationInput$appSecret": "

The app secret provided by Privy.

" - } - }, - "DefaultStripePrivyAuthorizationPrivateKeyType": { - "base": null, - "refs": { - "StripePrivyConfigurationInput$authorizationPrivateKey": "

The authorization private key for the Stripe Privy integration.

" - } - }, - "Definition": { - "base": null, - "refs": { - "LlmExtractionConfig$definition": "

Description of what this metadata field represents.

" - } - }, - "DeleteAgentRuntimeEndpointRequest": { - "base": null, - "refs": {} - }, - "DeleteAgentRuntimeEndpointResponse": { - "base": null, - "refs": {} - }, - "DeleteAgentRuntimeRequest": { - "base": null, - "refs": {} - }, - "DeleteAgentRuntimeResponse": { - "base": null, - "refs": {} - }, - "DeleteApiKeyCredentialProviderRequest": { - "base": null, - "refs": {} - }, - "DeleteApiKeyCredentialProviderResponse": { - "base": null, - "refs": {} - }, - "DeleteBrowserProfileRequest": { - "base": null, - "refs": {} - }, - "DeleteBrowserProfileResponse": { - "base": null, - "refs": {} - }, - "DeleteBrowserRequest": { - "base": null, - "refs": {} - }, - "DeleteBrowserResponse": { - "base": null, - "refs": {} - }, - "DeleteCodeInterpreterRequest": { - "base": null, - "refs": {} - }, - "DeleteCodeInterpreterResponse": { - "base": null, - "refs": {} - }, - "DeleteConfigurationBundleRequest": { - "base": null, - "refs": {} - }, - "DeleteConfigurationBundleResponse": { - "base": null, - "refs": {} - }, - "DeleteDatasetExamplesRequest": { - "base": null, - "refs": {} - }, - "DeleteDatasetExamplesRequestExampleIdsList": { - "base": null, - "refs": { - "DeleteDatasetExamplesRequest$exampleIds": "

The IDs of the examples to delete.

" - } - }, - "DeleteDatasetExamplesResponse": { - "base": null, - "refs": {} - }, - "DeleteDatasetRequest": { - "base": null, - "refs": {} - }, - "DeleteDatasetResponse": { - "base": null, - "refs": {} - }, - "DeleteEvaluatorRequest": { - "base": null, - "refs": {} - }, - "DeleteEvaluatorResponse": { - "base": null, - "refs": {} - }, - "DeleteGatewayRequest": { - "base": null, - "refs": {} - }, - "DeleteGatewayResponse": { - "base": null, - "refs": {} - }, - "DeleteGatewayRuleRequest": { - "base": null, - "refs": {} - }, - "DeleteGatewayRuleResponse": { - "base": null, - "refs": {} - }, - "DeleteGatewayTargetRequest": { - "base": null, - "refs": {} - }, - "DeleteGatewayTargetResponse": { - "base": null, - "refs": {} - }, - "DeleteHarnessEndpointRequest": { - "base": null, - "refs": {} - }, - "DeleteHarnessEndpointResponse": { - "base": null, - "refs": {} - }, - "DeleteHarnessRequest": { - "base": null, - "refs": {} - }, - "DeleteHarnessResponse": { - "base": null, - "refs": {} - }, - "DeleteMemoryInput": { - "base": null, - "refs": {} - }, - "DeleteMemoryInputClientTokenString": { - "base": null, - "refs": { - "DeleteMemoryInput$clientToken": "

A client token is used for keeping track of idempotent requests. It can contain a session id which can be around 250 chars, combined with a unique AWS identifier.

" - } - }, - "DeleteMemoryOutput": { - "base": null, - "refs": {} - }, - "DeleteMemoryStrategiesList": { - "base": null, - "refs": { - "ModifyMemoryStrategies$deleteMemoryStrategies": "

The list of memory strategies to delete.

" - } - }, - "DeleteMemoryStrategyInput": { - "base": "

Input for deleting a memory strategy.

", - "refs": { - "DeleteMemoryStrategiesList$member": null - } - }, - "DeleteOauth2CredentialProviderRequest": { - "base": null, - "refs": {} - }, - "DeleteOauth2CredentialProviderResponse": { - "base": null, - "refs": {} - }, - "DeleteOnlineEvaluationConfigRequest": { - "base": null, - "refs": {} - }, - "DeleteOnlineEvaluationConfigResponse": { - "base": null, - "refs": {} - }, - "DeletePaymentConnectorRequest": { - "base": null, - "refs": {} - }, - "DeletePaymentConnectorResponse": { - "base": null, - "refs": {} - }, - "DeletePaymentCredentialProviderRequest": { - "base": null, - "refs": {} - }, - "DeletePaymentCredentialProviderResponse": { - "base": null, - "refs": {} - }, - "DeletePaymentManagerRequest": { - "base": null, - "refs": {} - }, - "DeletePaymentManagerResponse": { - "base": null, - "refs": {} - }, - "DeletePolicyEngineRequest": { - "base": null, - "refs": {} - }, - "DeletePolicyEngineResponse": { - "base": null, - "refs": {} - }, - "DeletePolicyRequest": { - "base": null, - "refs": {} - }, - "DeletePolicyResponse": { - "base": null, - "refs": {} - }, - "DeleteRegistryRecordRequest": { - "base": null, - "refs": {} - }, - "DeleteRegistryRecordResponse": { - "base": null, - "refs": {} - }, - "DeleteRegistryRequest": { - "base": null, - "refs": {} - }, - "DeleteRegistryResponse": { - "base": null, - "refs": {} - }, - "DeleteResourcePolicyRequest": { - "base": null, - "refs": {} - }, - "DeleteResourcePolicyResponse": { - "base": null, - "refs": {} - }, - "DeleteWorkloadIdentityRequest": { - "base": null, - "refs": {} - }, - "DeleteWorkloadIdentityResponse": { - "base": null, - "refs": {} - }, - "Description": { - "base": null, - "refs": { - "AgentRuntime$description": "

The description of the agent runtime.

", - "BrowserProfileSummary$description": "

The description of the browser profile.

", - "BrowserSummary$description": "

The description of the browser.

", - "CodeInterpreterSummary$description": "

The description of the code interpreter.

", - "CreateAgentRuntimeRequest$description": "

The description of the AgentCore Runtime.

", - "CreateBrowserProfileRequest$description": "

A description of the browser profile. Use this field to describe the purpose or contents of the profile.

", - "CreateBrowserRequest$description": "

The description of the browser.

", - "CreateCodeInterpreterRequest$description": "

The description of the code interpreter.

", - "CreateMemoryInput$description": "

The description of the memory.

", - "CreatePolicyEngineRequest$description": "

A human-readable description of the policy engine's purpose and scope (1-4,096 characters). This helps administrators understand the policy engine's role in the overall governance strategy. Document which Gateway this engine will be associated with, what types of tools or workflows it governs, and the team or service responsible for maintaining it. Clear descriptions are essential when managing multiple policy engines across different services or environments.

", - "CreatePolicyEngineResponse$description": "

A human-readable description of the policy engine's purpose.

", - "CreatePolicyRequest$description": "

A human-readable description of the policy's purpose and functionality (1-4,096 characters). This helps policy administrators understand the policy's intent, business rules, and operational scope. Use this field to document why the policy exists, what business requirement it addresses, and any special considerations for maintenance. Clear descriptions are essential for policy governance, auditing, and troubleshooting.

", - "CreatePolicyResponse$description": "

The human-readable description of the policy's purpose and functionality. This helps administrators understand and manage the policy.

", - "CreateRegistryRecordRequest$description": "

A description of the registry record.

", - "CreateRegistryRequest$description": "

A description of the registry.

", - "CustomMemoryStrategyInput$description": "

The description of the custom memory strategy.

", - "DeletePolicyEngineResponse$description": "

The human-readable description of the deleted policy engine.

", - "DeletePolicyResponse$description": "

The human-readable description of the deleted policy.

", - "EpisodicMemoryStrategyInput$description": "

The description of the episodic memory strategy.

", - "GetAgentRuntimeResponse$description": "

The description of the AgentCore Runtime.

", - "GetBrowserProfileResponse$description": "

The description of the browser profile.

", - "GetBrowserResponse$description": "

The description of the browser.

", - "GetCodeInterpreterResponse$description": "

The description of the code interpreter.

", - "GetPolicyEngineResponse$description": "

The human-readable description of the policy engine's purpose and scope. This helps administrators understand the policy engine's role in governance.

", - "GetPolicyResponse$description": "

The human-readable description of the policy's purpose and functionality. This helps administrators understand and manage the policy.

", - "GetRegistryRecordResponse$description": "

The description of the registry record.

", - "GetRegistryResponse$description": "

The description of the registry.

", - "Memory$description": "

The description of the memory.

", - "MemoryStrategy$description": "

The description of the memory strategy.

", - "ModifyMemoryStrategyInput$description": "

The updated description of the memory strategy.

", - "Policy$description": "

A human-readable description of the policy's purpose and functionality. Limited to 4,096 characters, this helps administrators understand and manage the policy.

", - "PolicyEngine$description": "

A human-readable description of the policy engine's purpose and scope. Limited to 4,096 characters, this helps administrators understand the policy engine's role in the overall governance strategy.

", - "RegistryRecordSummary$description": "

The description of the registry record.

", - "RegistrySummary$description": "

The description of the registry.

", - "SemanticMemoryStrategyInput$description": "

The description of the semantic memory strategy.

", - "SummaryMemoryStrategyInput$description": "

The description of the summary memory strategy.

", - "UpdateAgentRuntimeRequest$description": "

The updated description of the AgentCore Runtime.

", - "UpdateMemoryInput$description": "

The updated description of the AgentCore Memory resource.

", - "UpdatePolicyEngineResponse$description": "

The updated description of the policy engine.

", - "UpdatePolicyResponse$description": "

The updated description of the policy.

", - "UpdateRegistryRecordResponse$description": "

The description of the updated registry record.

", - "UpdateRegistryResponse$description": "

The description of the updated registry.

", - "UpdatedDescription$optionalValue": "

Represents an optional value that is used to update the human-readable description of the resource. If not specified, it will clear the current description of the resource.

", - "UserPreferenceMemoryStrategyInput$description": "

The description of the user preference memory strategy.

" - } - }, - "DescriptorType": { - "base": null, - "refs": { - "CreateRegistryRecordRequest$descriptorType": "

The descriptor type of the registry record.

  • MCP - Model Context Protocol descriptor for MCP-compatible servers and tools.

  • A2A - Agent-to-Agent protocol descriptor.

  • CUSTOM - Custom descriptor type for resources such as APIs, Lambda functions, or servers not conforming to a standard protocol.

  • AGENT_SKILLS - Agent skills descriptor for defining agent skill definitions.

", - "GetRegistryRecordResponse$descriptorType": "

The descriptor type of the registry record. Possible values are MCP, A2A, CUSTOM, and AGENT_SKILLS.

", - "ListRegistryRecordsRequest$descriptorType": "

Filter registry records by their descriptor type. Possible values are MCP, A2A, CUSTOM, and AGENT_SKILLS.

", - "RegistryRecordSummary$descriptorType": "

The descriptor type of the registry record. Possible values are MCP, A2A, CUSTOM, and AGENT_SKILLS.

", - "UpdateRegistryRecordRequest$descriptorType": "

The updated descriptor type for the registry record. Changing the descriptor type may require updating the descriptors field to match the new type's schema requirements.

", - "UpdateRegistryRecordResponse$descriptorType": "

The descriptor type of the updated registry record. Possible values are MCP, A2A, CUSTOM, and AGENT_SKILLS.

" - } - }, - "Descriptors": { - "base": "

Contains descriptor-type-specific configurations for a registry record. Only the descriptor matching the record's descriptorType should be populated.

", - "refs": { - "CreateRegistryRecordRequest$descriptors": "

The descriptor-type-specific configuration containing the resource schema and metadata. The structure of this field depends on the descriptorType you specify.

", - "GetRegistryRecordResponse$descriptors": "

The descriptor-type-specific configuration containing the resource schema and metadata. For details, see the Descriptors data type.

", - "UpdateRegistryRecordResponse$descriptors": "

The descriptor-type-specific configuration of the updated registry record. For details, see the Descriptors data type.

" - } - }, - "DiscoveryUrl": { - "base": null, - "refs": { - "CustomJWTAuthorizerConfiguration$discoveryUrl": "

This URL is used to fetch OpenID Connect configuration or authorization server metadata for validating incoming tokens.

" - } - }, - "DiscoveryUrlType": { - "base": null, - "refs": { - "Oauth2Discovery$discoveryUrl": "

The discovery URL for the OAuth2 provider.

" - } - }, - "Document": { - "base": null, - "refs": { - "ComponentConfiguration$configuration": "

The configuration values as a flexible JSON document.

", - "ConnectorConfiguration$parameterValues": "

Parameters to set as fixed or default values when provisioning this tool.

", - "HarnessBedrockModelConfig$additionalParams": "

Provider-specific parameters passed through to the model provider unchanged.

", - "HarnessGeminiModelConfig$additionalParams": "

Provider-specific parameters passed through to the Gemini model provider unchanged.

", - "HarnessLiteLlmModelConfig$additionalParams": "

Provider-specific parameters passed through to the model provider unchanged.

", - "HarnessOpenAiModelConfig$additionalParams": "

Provider-specific parameters passed through to the model provider unchanged.

" - } - }, - "DomainName": { - "base": null, - "refs": { - "ManagedResourceDetails$domain": "

The domain associated with this managed resource.

" - } - }, - "Double": { - "base": null, - "refs": { - "FilterValue$doubleValue": "

The numeric value for numerical filtering and comparisons.

", - "NumberValidation$minValue": "

Minimum allowed value.

", - "NumberValidation$maxValue": "

Maximum allowed value.

" - } - }, - "DownloadUrl": { - "base": null, - "refs": { - "GetDatasetResponse$downloadUrl": "

Presigned Amazon S3 URL to download the consolidated dataset file for the resolved version. Expires after 5 minutes. Omitted if the file does not yet exist.

" - } - }, - "DraftStatus": { - "base": "

Publish synchronization state of the DRAFT working copy.

", - "refs": { - "DatasetSummary$draftStatus": "

Publish synchronization state. Only authoritative when status is ACTIVE.

", - "GetDatasetResponse$draftStatus": "

Publish synchronization state. Only authoritative when status is ACTIVE. MODIFIED indicates DRAFT has unpublished changes. UNMODIFIED indicates DRAFT matches the latest published version.

" - } - }, - "EfsAccessPointArn": { - "base": null, - "refs": { - "EfsAccessPointConfiguration$accessPointArn": "

The ARN of the EFS access point to mount into the AgentCore Runtime.

", - "EfsConfiguration$accessPointArn": "

The Amazon Resource Name (ARN) of the Amazon Elastic File System (Amazon EFS) access point to mount.

" - } - }, - "EfsAccessPointConfiguration": { - "base": "

Configuration for an Amazon EFS access point filesystem mounted into the AgentCore Runtime. EFS access points provide shared file storage accessible from your AgentCore Runtime sessions.

", - "refs": { - "FilesystemConfiguration$efsAccessPoint": "

Configuration for an Amazon EFS access point to mount into the AgentCore Runtime.

" - } - }, - "EfsConfiguration": { - "base": "

The configuration for mounting an Amazon Elastic File System (Amazon EFS) access point that you own into a session.

", - "refs": { - "ToolsFileSystemConfiguration$efsConfiguration": "

The configuration for mounting your own Amazon Elastic File System (Amazon EFS) access point into the session.

" - } - }, - "EfsFileSystemArn": { - "base": "

The Amazon Resource Name (ARN) of an Amazon Elastic File System (Amazon EFS) file system. The access points you specify must belong to this file system.

", - "refs": { - "EfsConfiguration$fileSystemArn": "

The Amazon Resource Name (ARN) of the Amazon Elastic File System (Amazon EFS) file system that owns the access point.

" - } - }, - "EnabledConnectors": { - "base": null, - "refs": { - "ConnectorTargetConfiguration$enabled": "

A list of tool names to enable from this connector. If absent, all tools provided by the connector are enabled.

" - } - }, - "EncryptionFailure": { - "base": "

Exception thrown when encryption of a secret fails.

", - "refs": {} - }, - "EndpointIpAddressType": { - "base": null, - "refs": { - "ManagedVpcResource$endpointIpAddressType": "

The IP address type for the resource configuration endpoint.

" - } - }, - "EndpointName": { - "base": null, - "refs": { - "AgentRuntimeEndpoint$name": "

The name of the agent runtime endpoint.

", - "CreateAgentRuntimeEndpointRequest$name": "

The name of the AgentCore Runtime endpoint.

", - "CreateAgentRuntimeEndpointResponse$endpointName": "

The name of the AgentCore Runtime endpoint.

", - "DeleteAgentRuntimeEndpointRequest$endpointName": "

The name of the AgentCore Runtime endpoint to delete.

", - "DeleteAgentRuntimeEndpointResponse$endpointName": "

The name of the AgentCore Runtime endpoint.

", - "GetAgentRuntimeEndpointRequest$endpointName": "

The name of the AgentCore Runtime endpoint to retrieve.

", - "GetAgentRuntimeEndpointResponse$name": "

The name of the AgentCore Runtime endpoint.

", - "UpdateAgentRuntimeEndpointRequest$endpointName": "

The name of the AgentCore Runtime endpoint to update.

" - } - }, - "EnforcementMode": { - "base": "

The enforcement mode for a policy. Run this policy in LOG_ONLY mode to collect data on how it affects your application. Once you are satisfied with the data gathered, switch the policy to ACTIVE.

", - "refs": { - "CreatePolicyRequest$enforcementMode": "

The enforcement mode for the policy. Run this policy in LOG_ONLY mode to collect data on how it affects your application. Once you are satisfied with the data gathered, switch the policy to ACTIVE. Defaults to ACTIVE.

", - "CreatePolicyResponse$enforcementMode": "

The enforcement mode of the created policy.

", - "DeletePolicyResponse$enforcementMode": "

The enforcement mode of the deleted policy.

", - "GetPolicyResponse$enforcementMode": "

The current enforcement mode of the policy.

", - "GetPolicySummaryResponse$enforcementMode": "

The current enforcement mode of the policy.

", - "Policy$enforcementMode": "

The current enforcement mode of the policy.

", - "PolicySummary$enforcementMode": "

The current enforcement mode of the policy.

", - "UpdatePolicyRequest$enforcementMode": "

The enforcement mode for the policy. Run this policy in LOG_ONLY mode to collect data on how it affects your application. Once you are satisfied with the data gathered, switch the policy to ACTIVE. If you omit this field, the policy's existing enforcement mode is unchanged.

", - "UpdatePolicyResponse$enforcementMode": "

The current enforcement mode of the updated policy.

" - } - }, - "EnvironmentVariableKey": { - "base": null, - "refs": { - "EnvironmentVariablesMap$key": null - } - }, - "EnvironmentVariableValue": { - "base": null, - "refs": { - "EnvironmentVariablesMap$value": null - } - }, - "EnvironmentVariablesMap": { - "base": null, - "refs": { - "CreateAgentRuntimeRequest$environmentVariables": "

Environment variables to set in the AgentCore Runtime environment.

", - "CreateHarnessRequest$environmentVariables": "

Environment variables to set in the harness runtime environment.

", - "GetAgentRuntimeResponse$environmentVariables": "

Environment variables set in the AgentCore Runtime environment.

", - "Harness$environmentVariables": "

Environment variables exposed in the environment in which the harness operates.

", - "UpdateAgentRuntimeRequest$environmentVariables": "

Updated environment variables to set in the AgentCore Runtime environment.

", - "UpdateHarnessRequest$environmentVariables": "

Environment variables to set in the harness runtime environment. If specified, this replaces all existing environment variables. If not specified, the existing value is retained.

" - } - }, - "EpisodicConsolidationOverride": { - "base": "

Contains configurations to override the default consolidation step for the episodic memory strategy.

", - "refs": { - "CustomConsolidationConfiguration$episodicConsolidationOverride": "

The configurations to override the default consolidation step for the episodic memory strategy.

" - } - }, - "EpisodicExtractionOverride": { - "base": "

Contains configurations to override the default extraction step for the episodic memory strategy.

", - "refs": { - "CustomExtractionConfiguration$episodicExtractionOverride": "

The configurations to override the default extraction step for the episodic memory strategy.

" - } - }, - "EpisodicMemoryStrategyInput": { - "base": "

Input for creating an episodic memory strategy.

", - "refs": { - "MemoryStrategyInput$episodicMemoryStrategy": "

Input for creating an episodic memory strategy

" - } - }, - "EpisodicOverrideConfigurationInput": { - "base": "

Input for the configuration to override the episodic memory strategy.

", - "refs": { - "CustomConfigurationInput$episodicOverride": "

The episodic memory strategy override configuration for a custom memory strategy.

" - } - }, - "EpisodicOverrideConsolidationConfigurationInput": { - "base": "

Configurations for overriding the consolidation step of the episodic memory strategy.

", - "refs": { - "CustomConsolidationConfigurationInput$episodicConsolidationOverride": "

Configurations to override the consolidation step of the episodic strategy.

", - "EpisodicOverrideConfigurationInput$consolidation": "

Contains configurations for overriding the consolidation step of the episodic memory strategy.

" - } - }, - "EpisodicOverrideExtractionConfigurationInput": { - "base": "

Configurations for overriding the extraction step of the episodic memory strategy.

", - "refs": { - "CustomExtractionConfigurationInput$episodicExtractionOverride": "

Configurations to override the extraction step of the episodic strategy.

", - "EpisodicOverrideConfigurationInput$extraction": "

Contains configurations for overriding the extraction step of the episodic memory strategy.

" - } - }, - "EpisodicOverrideReflectionConfigurationInput": { - "base": "

Configurations for overriding the reflection step of the episodic memory strategy.

", - "refs": { - "CustomReflectionConfigurationInput$episodicReflectionOverride": "

The reflection override configuration input.

", - "EpisodicOverrideConfigurationInput$reflection": "

Contains configurations for overriding the reflection step of the episodic memory strategy.

" - } - }, - "EpisodicReflectionConfiguration": { - "base": "

The configuration for the reflections created with the episodic memory strategy.

", - "refs": { - "ReflectionConfiguration$episodicReflectionConfiguration": "

The configuration for the episodic reflection strategy.

" - } - }, - "EpisodicReflectionConfigurationInput": { - "base": "

An episodic reflection configuration input.

", - "refs": { - "EpisodicMemoryStrategyInput$reflectionConfiguration": "

The configuration for the reflections created with the episodic memory strategy.

", - "ModifyReflectionConfiguration$episodicReflectionConfiguration": "

The updated episodic reflection configuration.

" - } - }, - "EpisodicReflectionOverride": { - "base": "

Contains configurations to override the default reflection step for the episodic memory strategy.

", - "refs": { - "CustomReflectionConfiguration$episodicReflectionOverride": "

The configuration for a reflection strategy to override the default one.

" - } - }, - "EvaluationConfigDescription": { - "base": null, - "refs": { - "CreateOnlineEvaluationConfigRequest$description": "

The description of the online evaluation configuration that explains its monitoring purpose and scope.

", - "GetOnlineEvaluationConfigResponse$description": "

The description of the online evaluation configuration.

", - "OnlineEvaluationConfigSummary$description": "

The description of the online evaluation configuration.

", - "UpdateOnlineEvaluationConfigRequest$description": "

The updated description of the online evaluation configuration.

" - } - }, - "EvaluationConfigName": { - "base": null, - "refs": { - "CreateOnlineEvaluationConfigRequest$onlineEvaluationConfigName": "

The name of the online evaluation configuration. Must be unique within your account.

", - "GetOnlineEvaluationConfigResponse$onlineEvaluationConfigName": "

The name of the online evaluation configuration.

", - "OnlineEvaluationConfigSummary$onlineEvaluationConfigName": "

The name of the online evaluation configuration.

" - } - }, - "EvaluatorArn": { - "base": null, - "refs": { - "DeleteEvaluatorResponse$evaluatorArn": "

The Amazon Resource Name (ARN) of the deleted evaluator.

", - "EvaluatorSummary$evaluatorArn": "

The Amazon Resource Name (ARN) of the evaluator.

", - "GetEvaluatorResponse$evaluatorArn": "

The Amazon Resource Name (ARN) of the evaluator.

", - "UpdateEvaluatorResponse$evaluatorArn": "

The Amazon Resource Name (ARN) of the updated evaluator.

" - } - }, - "EvaluatorConfig": { - "base": "

The configuration that defines how an evaluator assesses agent performance, including the evaluation method and parameters.

", - "refs": { - "CreateEvaluatorRequest$evaluatorConfig": "

The configuration for the evaluator. Specify either LLM-as-a-Judge settings with instructions, rating scale, and model configuration, or code-based settings with a customer-managed Lambda function.

", - "GetEvaluatorResponse$evaluatorConfig": "

The configuration of the evaluator, including LLM-as-a-Judge or code-based settings.

", - "UpdateEvaluatorRequest$evaluatorConfig": "

The updated configuration for the evaluator. Specify either LLM-as-a-Judge settings with instructions, rating scale, and model configuration, or code-based settings with a customer-managed Lambda function.

" - } - }, - "EvaluatorDescription": { - "base": null, - "refs": { - "CreateEvaluatorRequest$description": "

The description of the evaluator that explains its purpose and evaluation criteria.

", - "EvaluatorSummary$description": "

The description of the evaluator.

", - "GetEvaluatorResponse$description": "

The description of the evaluator.

", - "UpdateEvaluatorRequest$description": "

The updated description of the evaluator.

" - } - }, - "EvaluatorId": { - "base": null, - "refs": { - "CreateEvaluatorResponse$evaluatorId": "

The unique identifier of the created evaluator.

", - "DeleteEvaluatorRequest$evaluatorId": "

The unique identifier of the evaluator to delete.

", - "DeleteEvaluatorResponse$evaluatorId": "

The unique identifier of the deleted evaluator.

", - "EvaluatorReference$evaluatorId": "

The unique identifier of the evaluator. Can reference builtin evaluators (e.g., Builtin.Helpfulness) or custom evaluators.

", - "EvaluatorSummary$evaluatorId": "

The unique identifier of the evaluator.

", - "GetEvaluatorRequest$evaluatorId": "

The unique identifier of the evaluator to retrieve. Can be a built-in evaluator ID (e.g., Builtin.Helpfulness) or a custom evaluator ID.

", - "GetEvaluatorResponse$evaluatorId": "

The unique identifier of the evaluator.

", - "UpdateEvaluatorRequest$evaluatorId": "

The unique identifier of the evaluator to update.

", - "UpdateEvaluatorResponse$evaluatorId": "

The unique identifier of the updated evaluator.

" - } - }, - "EvaluatorInstructions": { - "base": null, - "refs": { - "LlmAsAJudgeEvaluatorConfig$instructions": "

The evaluation instructions that guide the language model in assessing agent performance, including criteria and evaluation guidelines.

" - } - }, - "EvaluatorLevel": { - "base": null, - "refs": { - "CreateEvaluatorRequest$level": "

The evaluation level that determines the scope of evaluation. Valid values are TOOL_CALL for individual tool invocations, TRACE for single request-response interactions, or SESSION for entire conversation sessions.

", - "EvaluatorSummary$level": "

The evaluation level (TOOL_CALL, TRACE, or SESSION) that determines the scope of evaluation.

", - "GetEvaluatorResponse$level": "

The evaluation level (TOOL_CALL, TRACE, or SESSION) that determines the scope of evaluation.

", - "UpdateEvaluatorRequest$level": "

The updated evaluation level (TOOL_CALL, TRACE, or SESSION) that determines the scope of evaluation.

" - } - }, - "EvaluatorList": { - "base": null, - "refs": { - "CreateOnlineEvaluationConfigRequest$evaluators": "

The list of evaluators to apply during online evaluation. Can include both built-in evaluators and custom evaluators created with CreateEvaluator.

", - "GetOnlineEvaluationConfigResponse$evaluators": "

The list of evaluators applied during online evaluation.

", - "UpdateOnlineEvaluationConfigRequest$evaluators": "

The updated list of evaluators to apply during online evaluation.

" - } - }, - "EvaluatorModelConfig": { - "base": "

The model configuration that specifies which foundation model to use for evaluation and how to configure it.

", - "refs": { - "LlmAsAJudgeEvaluatorConfig$modelConfig": "

The model configuration that specifies which foundation model to use and how to configure it for evaluation.

" - } - }, - "EvaluatorName": { - "base": null, - "refs": { - "EvaluatorSummary$evaluatorName": "

The name of the evaluator.

", - "GetEvaluatorResponse$evaluatorName": "

The name of the evaluator.

" - } - }, - "EvaluatorReference": { - "base": "

The reference to an evaluator used in online evaluation configurations, containing the evaluator identifier.

", - "refs": { - "EvaluatorList$member": null - } - }, - "EvaluatorStatus": { - "base": null, - "refs": { - "CreateEvaluatorResponse$status": "

The status of the evaluator creation operation.

", - "DeleteEvaluatorResponse$status": "

The status of the evaluator deletion operation.

", - "EvaluatorSummary$status": "

The current status of the evaluator.

", - "GetEvaluatorResponse$status": "

The current status of the evaluator.

", - "UpdateEvaluatorResponse$status": "

The status of the evaluator update operation.

" - } - }, - "EvaluatorSummary": { - "base": "

The summary information about an evaluator, including basic metadata and status information.

", - "refs": { - "EvaluatorSummaryList$member": null - } - }, - "EvaluatorSummaryList": { - "base": null, - "refs": { - "ListEvaluatorsResponse$evaluators": "

The list of evaluator summaries containing basic information about each evaluator.

" - } - }, - "EvaluatorType": { - "base": null, - "refs": { - "EvaluatorSummary$evaluatorType": "

The type of evaluator, indicating whether it is a built-in evaluator provided by the service or a custom evaluator created by the user.

" - } - }, - "ExampleId": { - "base": null, - "refs": { - "DeleteDatasetExamplesRequestExampleIdsList$member": null, - "ExampleIdList$member": null - } - }, - "ExampleIdList": { - "base": null, - "refs": { - "AddDatasetExamplesResponse$exampleIds": "

IDs of all added examples (auto-generated UUIDs).

" - } - }, - "ExceptionLevel": { - "base": null, - "refs": { - "CreateGatewayRequest$exceptionLevel": "

The level of detail in error messages returned when invoking the gateway.

  • If the value is DEBUG, granular exception messages are returned to help a user debug the gateway.

  • If the value is omitted, a generic error message is returned to the end user.

", - "CreateGatewayResponse$exceptionLevel": "

The level of detail in error messages returned when invoking the gateway.

  • If the value is DEBUG, granular exception messages are returned to help a user debug the gateway.

  • If the value is omitted, a generic error message is returned to the end user.

", - "GetGatewayResponse$exceptionLevel": "

The level of detail in error messages returned when invoking the gateway.

  • If the value is DEBUG, granular exception messages are returned to help a user debug the gateway.

  • If the value is omitted, a generic error message is returned to the end user.

", - "UpdateGatewayRequest$exceptionLevel": "

The level of detail in error messages returned when invoking the gateway.

  • If the value is DEBUG, granular exception messages are returned to help a user debug the gateway.

  • If the value is omitted, a generic error message is returned to the end user.

", - "UpdateGatewayResponse$exceptionLevel": "

The level of detail in error messages returned when invoking the gateway.

  • If the value is DEBUG, granular exception messages are returned to help a user debug the gateway.

  • If the value is omitted, a generic error message is returned to the end user.

" - } - }, - "ExtractionConfig": { - "base": "

Configuration for metadata extraction from conversational content.

", - "refs": { - "MetadataSchemaEntry$extractionConfig": "

Configuration for extracting this metadata value from conversational content. Applicable only if extractionType is LLM inferred.

" - } - }, - "ExtractionConfiguration": { - "base": "

Contains extraction configuration information for a memory strategy.

", - "refs": { - "StrategyConfiguration$extraction": "

The extraction configuration for the memory strategy.

" - } - }, - "ExtractionType": { - "base": "

The extraction type for a metadata field, determining how the value is obtained during memory processing.

", - "refs": { - "MetadataSchemaEntry$extractionType": "

Specifies whether the metadata value is extracted by the LLM or passed through deterministically from the event.

" - } - }, - "FilesystemConfiguration": { - "base": "

Configuration for a filesystem that can be mounted into the AgentCore Runtime.

", - "refs": { - "FilesystemConfigurations$member": null - } - }, - "FilesystemConfigurations": { - "base": null, - "refs": { - "CreateAgentRuntimeRequest$filesystemConfigurations": "

The filesystem configurations to mount into the AgentCore Runtime. Use filesystem configurations to provide persistent storage to your AgentCore Runtime sessions.

", - "GetAgentRuntimeResponse$filesystemConfigurations": "

The filesystem configurations mounted into the AgentCore Runtime.

", - "HarnessAgentCoreRuntimeEnvironment$filesystemConfigurations": "

The filesystem configurations for the runtime environment.

", - "HarnessAgentCoreRuntimeEnvironmentRequest$filesystemConfigurations": "

The filesystem configurations for the runtime environment.

", - "UpdateAgentRuntimeRequest$filesystemConfigurations": "

The updated filesystem configurations to mount into the AgentCore Runtime.

" - } - }, - "Filter": { - "base": "

The filter that applies conditions to agent traces during online evaluation to determine which traces should be evaluated.

", - "refs": { - "FilterList$member": null - } - }, - "FilterKeyString": { - "base": null, - "refs": { - "Filter$key": "

The key or field name to filter on within the agent trace data.

" - } - }, - "FilterList": { - "base": null, - "refs": { - "Rule$filters": "

The list of filters that determine which agent traces should be included in the evaluation based on trace properties.

" - } - }, - "FilterOperator": { - "base": null, - "refs": { - "Filter$operator": "

The comparison operator to use for filtering.

" - } - }, - "FilterValue": { - "base": "

The value used in filter comparisons, supporting different data types for flexible filtering criteria.

", - "refs": { - "Filter$value": "

The value to compare against using the specified operator.

" - } - }, - "FilterValueStringValueString": { - "base": null, - "refs": { - "FilterValue$stringValue": "

The string value for text-based filtering.

" - } - }, - "Finding": { - "base": "

Represents a finding or issue discovered during policy generation or validation. Findings provide insights about potential problems, recommendations, or validation results from policy analysis operations. Finding types include: VALID (policy is ready to use), INVALID (policy has validation errors that must be fixed), NOT_TRANSLATABLE (input couldn't be converted to policy), ALLOW_ALL (policy would allow all actions, potential security risk), ALLOW_NONE (policy would allow no actions, unusable), DENY_ALL (policy would deny all actions, may be too restrictive), and DENY_NONE (policy would deny no actions, ineffective). Review all findings before creating policies from generated assets to ensure they match your security requirements.

", - "refs": { - "Findings$member": null - } - }, - "FindingType": { - "base": null, - "refs": { - "Finding$type": "

The type or category of the finding. This classifies the finding as an error, warning, recommendation, or informational message to help users understand the severity and nature of the issue.

" - } - }, - "Findings": { - "base": null, - "refs": { - "PolicyGenerationAsset$findings": "

Analysis findings and insights related to this specific generated policy asset. These findings may include validation results, potential issues, or recommendations for improvement to help users evaluate the quality and appropriateness of the generated policy.

" - } - }, - "Float": { - "base": null, - "refs": { - "HarnessAgentCoreMemoryRetrievalConfig$relevanceScore": "

The minimum relevance score for retrieved memories.

", - "HarnessSummarizationConfiguration$summaryRatio": "

The ratio of content to summarize.

" - } - }, - "FromUrlSynchronizationConfiguration": { - "base": "

Configuration for synchronizing from a URL-based MCP server.

", - "refs": { - "SynchronizationConfiguration$fromUrl": "

Configuration for synchronizing from a URL-based source.

" - } - }, - "GatewayArn": { - "base": null, - "refs": { - "CreateGatewayResponse$gatewayArn": "

The Amazon Resource Name (ARN) of the created gateway.

", - "CreateGatewayRuleResponse$gatewayArn": "

The Amazon Resource Name (ARN) of the gateway that the rule belongs to.

", - "CreateGatewayTargetResponse$gatewayArn": "

The Amazon Resource Name (ARN) of the gateway.

", - "DeleteGatewayTargetResponse$gatewayArn": "

The Amazon Resource Name (ARN) of the gateway.

", - "GatewayRuleDetail$gatewayArn": "

The Amazon Resource Name (ARN) of the gateway that the rule belongs to.

", - "GatewayTarget$gatewayArn": "

The Amazon Resource Name (ARN) of the gateway target.

", - "GetGatewayResponse$gatewayArn": "

The Amazon Resource Name (ARN) of the gateway.

", - "GetGatewayRuleResponse$gatewayArn": "

The Amazon Resource Name (ARN) of the gateway that the rule belongs to.

", - "GetGatewayTargetResponse$gatewayArn": "

The Amazon Resource Name (ARN) of the gateway.

", - "HarnessAgentCoreGatewayConfig$gatewayArn": "

The ARN of the desired AgentCore Gateway.

", - "UpdateGatewayResponse$gatewayArn": "

The Amazon Resource Name (ARN) of the updated gateway.

", - "UpdateGatewayRuleResponse$gatewayArn": "

The Amazon Resource Name (ARN) of the gateway that the rule belongs to.

", - "UpdateGatewayTargetResponse$gatewayArn": "

The Amazon Resource Name (ARN) of the gateway.

" - } - }, - "GatewayConfigurationBundleArn": { - "base": null, - "refs": { - "ConfigurationBundleReference$bundleArn": "

The Amazon Resource Name (ARN) of the configuration bundle.

", - "StaticOverride$bundleArn": "

The Amazon Resource Name (ARN) of the configuration bundle to apply.

" - } - }, - "GatewayDescription": { - "base": null, - "refs": { - "CreateGatewayRequest$description": "

The description of the gateway.

", - "CreateGatewayResponse$description": "

The description of the gateway.

", - "GatewaySummary$description": "

The description of the gateway.

", - "GetGatewayResponse$description": "

The description of the gateway.

", - "UpdateGatewayRequest$description": "

The updated description for the gateway.

", - "UpdateGatewayResponse$description": "

The updated description of the gateway.

" - } - }, - "GatewayId": { - "base": null, - "refs": { - "CreateGatewayResponse$gatewayId": "

The unique identifier of the created gateway.

", - "DeleteGatewayResponse$gatewayId": "

The unique identifier of the deleted gateway.

", - "GatewaySummary$gatewayId": "

The unique identifier of the gateway.

", - "GetGatewayResponse$gatewayId": "

The unique identifier of the gateway.

", - "UpdateGatewayResponse$gatewayId": "

The unique identifier of the updated gateway.

" - } - }, - "GatewayIdentifier": { - "base": null, - "refs": { - "CreateGatewayRuleRequest$gatewayIdentifier": "

The identifier of the gateway to create a rule for.

", - "CreateGatewayTargetRequest$gatewayIdentifier": "

The identifier of the gateway to create a target for.

", - "DeleteGatewayRequest$gatewayIdentifier": "

The identifier of the gateway to delete.

", - "DeleteGatewayRuleRequest$gatewayIdentifier": "

The identifier of the gateway containing the rule.

", - "DeleteGatewayTargetRequest$gatewayIdentifier": "

The unique identifier of the gateway associated with the target.

", - "GetGatewayRequest$gatewayIdentifier": "

The identifier of the gateway to retrieve.

", - "GetGatewayRuleRequest$gatewayIdentifier": "

The identifier of the gateway containing the rule.

", - "GetGatewayTargetRequest$gatewayIdentifier": "

The identifier of the gateway that contains the target.

", - "ListGatewayRulesRequest$gatewayIdentifier": "

The identifier of the gateway to list rules for.

", - "ListGatewayTargetsRequest$gatewayIdentifier": "

The identifier of the gateway to list targets for.

", - "SynchronizeGatewayTargetsRequest$gatewayIdentifier": "

The gateway Identifier.

", - "UpdateGatewayRequest$gatewayIdentifier": "

The identifier of the gateway to update.

", - "UpdateGatewayRuleRequest$gatewayIdentifier": "

The identifier of the gateway containing the rule.

", - "UpdateGatewayTargetRequest$gatewayIdentifier": "

The unique identifier of the gateway associated with the target.

" - } - }, - "GatewayInterceptionPoint": { - "base": null, - "refs": { - "GatewayInterceptionPoints$member": null - } - }, - "GatewayInterceptionPoints": { - "base": null, - "refs": { - "GatewayInterceptorConfiguration$interceptionPoints": "

The supported points of interception. This field specifies which points during the gateway invocation to invoke the interceptor

" - } - }, - "GatewayInterceptorConfiguration": { - "base": "

The configuration for an interceptor on a gateway. This structure defines settings for an interceptor that will be invoked during the invocation of the gateway.

", - "refs": { - "GatewayInterceptorConfigurations$member": null - } - }, - "GatewayInterceptorConfigurations": { - "base": null, - "refs": { - "CreateGatewayRequest$interceptorConfigurations": "

A list of configuration settings for a gateway interceptor. Gateway interceptors allow custom code to be invoked during gateway invocations.

", - "CreateGatewayResponse$interceptorConfigurations": "

The list of interceptor configurations for the created gateway.

", - "GetGatewayResponse$interceptorConfigurations": "

The interceptors configured on the gateway.

", - "UpdateGatewayRequest$interceptorConfigurations": "

The updated interceptor configurations for the gateway.

", - "UpdateGatewayResponse$interceptorConfigurations": "

The updated interceptor configurations for the gateway.

" - } - }, - "GatewayMaxResults": { - "base": null, - "refs": { - "ListGatewaysRequest$maxResults": "

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.

" - } - }, - "GatewayName": { - "base": null, - "refs": { - "CreateGatewayRequest$name": "

The name of the gateway. The name must be unique within your account.

", - "CreateGatewayResponse$name": "

The name of the gateway.

", - "GatewaySummary$name": "

The name of the gateway.

", - "GetGatewayResponse$name": "

The name of the gateway.

", - "UpdateGatewayRequest$name": "

The name of the gateway. This name must be the same as the one when the gateway was created.

", - "UpdateGatewayResponse$name": "

The name of the gateway.

" - } - }, - "GatewayNextToken": { - "base": null, - "refs": { - "ListGatewaysRequest$nextToken": "

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.

", - "ListGatewaysResponse$nextToken": "

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.

" - } - }, - "GatewayPolicyEngineArn": { - "base": null, - "refs": { - "GatewayPolicyEngineConfiguration$arn": "

The ARN of the policy engine. The policy engine contains Cedar policies that define fine-grained authorization rules specifying who can perform what actions on which resources as agents interact through the gateway.

" - } - }, - "GatewayPolicyEngineConfiguration": { - "base": "

The configuration for a policy engine associated with a gateway. A policy engine is a collection of policies that evaluates and authorizes agent tool calls. When associated with a gateway, the policy engine intercepts all agent requests and determines whether to allow or deny each action based on the defined policies.

", - "refs": { - "CreateGatewayRequest$policyEngineConfiguration": "

The policy engine configuration for the gateway. A policy engine is a collection of policies that evaluates and authorizes agent tool calls. When associated with a gateway, the policy engine intercepts all agent requests and determines whether to allow or deny each action based on the defined policies.

", - "CreateGatewayResponse$policyEngineConfiguration": "

The policy engine configuration for the created gateway.

", - "GetGatewayResponse$policyEngineConfiguration": "

The policy engine configuration for the gateway.

", - "UpdateGatewayRequest$policyEngineConfiguration": "

The updated policy engine configuration for the gateway. A policy engine is a collection of policies that evaluates and authorizes agent tool calls. When associated with a gateway, the policy engine intercepts all agent requests and determines whether to allow or deny each action based on the defined policies.

", - "UpdateGatewayResponse$policyEngineConfiguration": "

The updated policy engine configuration for the gateway.

" - } - }, - "GatewayPolicyEngineMode": { - "base": null, - "refs": { - "GatewayPolicyEngineConfiguration$mode": "

The enforcement mode for the policy engine. Valid values include:

  • LOG_ONLY - The policy engine evaluates each action against your policies and adds traces on whether tool calls would be allowed or denied, but does not enforce the decision. Use this mode to test and validate policies before enabling enforcement.

  • ENFORCE - The policy engine evaluates actions against your policies and enforces decisions by allowing or denying agent operations. Test and validate policies in LOG_ONLY mode before enabling enforcement to avoid unintended denials or adversely affecting production traffic.

" - } - }, - "GatewayProtocolConfiguration": { - "base": "

The configuration for a gateway protocol. This structure defines how the gateway communicates with external services.

", - "refs": { - "CreateGatewayRequest$protocolConfiguration": "

The configuration settings for the protocol specified in the protocolType parameter.

", - "CreateGatewayResponse$protocolConfiguration": "

The configuration settings for the protocol used by the gateway.

", - "GetGatewayResponse$protocolConfiguration": null, - "UpdateGatewayRequest$protocolConfiguration": null, - "UpdateGatewayResponse$protocolConfiguration": null - } - }, - "GatewayProtocolType": { - "base": null, - "refs": { - "CreateGatewayRequest$protocolType": "

The protocol type for the gateway.

", - "CreateGatewayResponse$protocolType": "

The protocol type of the gateway.

", - "GatewaySummary$protocolType": "

The protocol type used by the gateway.

", - "GetGatewayResponse$protocolType": "

Protocol applied to a gateway.

", - "UpdateGatewayRequest$protocolType": "

The updated protocol type for the gateway.

", - "UpdateGatewayResponse$protocolType": "

The updated protocol type for the gateway.

" - } - }, - "GatewayRuleDescription": { - "base": null, - "refs": { - "CreateGatewayRuleRequest$description": "

The description of the gateway rule.

", - "CreateGatewayRuleResponse$description": "

The description of the gateway rule.

", - "GatewayRuleDetail$description": "

The description of the gateway rule.

", - "GetGatewayRuleResponse$description": "

The description of the gateway rule.

", - "UpdateGatewayRuleRequest$description": "

The updated description of the rule.

", - "UpdateGatewayRuleResponse$description": "

The description of the gateway rule.

" - } - }, - "GatewayRuleDetail": { - "base": "

Detailed information about a gateway rule.

", - "refs": { - "GatewayRules$member": null - } - }, - "GatewayRuleId": { - "base": null, - "refs": { - "CreateGatewayRuleResponse$ruleId": "

The unique identifier of the gateway rule.

", - "DeleteGatewayRuleRequest$ruleId": "

The unique identifier of the rule to delete.

", - "DeleteGatewayRuleResponse$ruleId": "

The unique identifier of the deleted rule.

", - "GatewayRuleDetail$ruleId": "

The unique identifier of the gateway rule.

", - "GetGatewayRuleRequest$ruleId": "

The unique identifier of the rule to retrieve.

", - "GetGatewayRuleResponse$ruleId": "

The unique identifier of the gateway rule.

", - "UpdateGatewayRuleRequest$ruleId": "

The unique identifier of the rule to update.

", - "UpdateGatewayRuleResponse$ruleId": "

The unique identifier of the gateway rule.

" - } - }, - "GatewayRuleMaxResults": { - "base": null, - "refs": { - "ListGatewayRulesRequest$maxResults": "

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.

" - } - }, - "GatewayRuleNextToken": { - "base": null, - "refs": { - "ListGatewayRulesRequest$nextToken": "

The pagination token from a previous request.

", - "ListGatewayRulesResponse$nextToken": "

The pagination token to use in a subsequent request.

" - } - }, - "GatewayRulePriority": { - "base": null, - "refs": { - "CreateGatewayRuleRequest$priority": "

The priority of the rule. Rules are evaluated in order of priority, with lower numbers evaluated first. Must be between 1 and 1,000,000.

", - "CreateGatewayRuleResponse$priority": "

The priority of the rule. Rules are evaluated in order of priority, with lower numbers evaluated first.

", - "GatewayRuleDetail$priority": "

The priority of the rule. Rules are evaluated in order of priority, with lower numbers evaluated first.

", - "GetGatewayRuleResponse$priority": "

The priority of the rule. Rules are evaluated in order of priority, with lower numbers evaluated first.

", - "UpdateGatewayRuleRequest$priority": "

The updated priority of the rule.

", - "UpdateGatewayRuleResponse$priority": "

The priority of the rule. Rules are evaluated in order of priority, with lower numbers evaluated first.

" - } - }, - "GatewayRuleStatus": { - "base": null, - "refs": { - "CreateGatewayRuleResponse$status": "

The current status of the rule.

", - "DeleteGatewayRuleResponse$status": "

The status of the rule deletion operation.

", - "GatewayRuleDetail$status": "

The current status of the rule.

", - "GetGatewayRuleResponse$status": "

The current status of the rule.

", - "UpdateGatewayRuleResponse$status": "

The current status of the rule.

" - } - }, - "GatewayRules": { - "base": null, - "refs": { - "ListGatewayRulesResponse$gatewayRules": "

The list of gateway rules.

" - } - }, - "GatewayStatus": { - "base": null, - "refs": { - "CreateGatewayResponse$status": "

The current status of the gateway.

", - "DeleteGatewayResponse$status": "

The current status of the gateway deletion.

", - "GatewaySummary$status": "

The current status of the gateway.

", - "GetGatewayResponse$status": "

The current status of the gateway.

", - "UpdateGatewayResponse$status": "

The current status of the updated gateway.

" - } - }, - "GatewaySummaries": { - "base": null, - "refs": { - "ListGatewaysResponse$items": "

The list of gateway summaries.

" - } - }, - "GatewaySummary": { - "base": "

Contains summary information about a gateway.

", - "refs": { - "GatewaySummaries$member": null - } - }, - "GatewayTarget": { - "base": "

The gateway target.

", - "refs": { - "GatewayTargetList$member": null - } - }, - "GatewayTargetList": { - "base": null, - "refs": { - "SynchronizeGatewayTargetsResponse$targets": "

The gateway targets for synchronization.

" - } - }, - "GatewayUrl": { - "base": null, - "refs": { - "CreateGatewayResponse$gatewayUrl": "

The URL endpoint for the created gateway.

", - "GetGatewayResponse$gatewayUrl": "

An endpoint for invoking gateway.

", - "UpdateGatewayResponse$gatewayUrl": "

An endpoint for invoking the updated gateway.

" - } - }, - "GetAgentRuntimeEndpointRequest": { - "base": null, - "refs": {} - }, - "GetAgentRuntimeEndpointResponse": { - "base": null, - "refs": {} - }, - "GetAgentRuntimeRequest": { - "base": null, - "refs": {} - }, - "GetAgentRuntimeResponse": { - "base": null, - "refs": {} - }, - "GetApiKeyCredentialProviderRequest": { - "base": null, - "refs": {} - }, - "GetApiKeyCredentialProviderResponse": { - "base": null, - "refs": {} - }, - "GetBrowserProfileRequest": { - "base": null, - "refs": {} - }, - "GetBrowserProfileResponse": { - "base": null, - "refs": {} - }, - "GetBrowserRequest": { - "base": null, - "refs": {} - }, - "GetBrowserResponse": { - "base": null, - "refs": {} - }, - "GetCodeInterpreterRequest": { - "base": null, - "refs": {} - }, - "GetCodeInterpreterResponse": { - "base": null, - "refs": {} - }, - "GetConfigurationBundleRequest": { - "base": null, - "refs": {} - }, - "GetConfigurationBundleResponse": { - "base": null, - "refs": {} - }, - "GetConfigurationBundleVersionRequest": { - "base": null, - "refs": {} - }, - "GetConfigurationBundleVersionResponse": { - "base": null, - "refs": {} - }, - "GetDatasetRequest": { - "base": null, - "refs": {} - }, - "GetDatasetResponse": { - "base": null, - "refs": {} - }, - "GetEvaluatorRequest": { - "base": null, - "refs": {} - }, - "GetEvaluatorResponse": { - "base": null, - "refs": {} - }, - "GetGatewayRequest": { - "base": null, - "refs": {} - }, - "GetGatewayResponse": { - "base": null, - "refs": {} - }, - "GetGatewayRuleRequest": { - "base": null, - "refs": {} - }, - "GetGatewayRuleResponse": { - "base": "

Create response excludes updatedAt (redundant on create). Get/Update responses include it via their own output structures.

", - "refs": {} - }, - "GetGatewayTargetRequest": { - "base": null, - "refs": {} - }, - "GetGatewayTargetResponse": { - "base": null, - "refs": {} - }, - "GetHarnessEndpointRequest": { - "base": null, - "refs": {} - }, - "GetHarnessEndpointResponse": { - "base": null, - "refs": {} - }, - "GetHarnessRequest": { - "base": null, - "refs": {} - }, - "GetHarnessResponse": { - "base": null, - "refs": {} - }, - "GetMemoryInput": { - "base": null, - "refs": {} - }, - "GetMemoryOutput": { - "base": null, - "refs": {} - }, - "GetOauth2CredentialProviderRequest": { - "base": null, - "refs": {} - }, - "GetOauth2CredentialProviderResponse": { - "base": null, - "refs": {} - }, - "GetOnlineEvaluationConfigRequest": { - "base": null, - "refs": {} - }, - "GetOnlineEvaluationConfigResponse": { - "base": null, - "refs": {} - }, - "GetPaymentConnectorRequest": { - "base": null, - "refs": {} - }, - "GetPaymentConnectorResponse": { - "base": null, - "refs": {} - }, - "GetPaymentCredentialProviderRequest": { - "base": null, - "refs": {} - }, - "GetPaymentCredentialProviderResponse": { - "base": null, - "refs": {} - }, - "GetPaymentManagerRequest": { - "base": null, - "refs": {} - }, - "GetPaymentManagerResponse": { - "base": null, - "refs": {} - }, - "GetPolicyEngineRequest": { - "base": null, - "refs": {} - }, - "GetPolicyEngineResponse": { - "base": null, - "refs": {} - }, - "GetPolicyEngineSummaryRequest": { - "base": null, - "refs": {} - }, - "GetPolicyEngineSummaryResponse": { - "base": null, - "refs": {} - }, - "GetPolicyGenerationRequest": { - "base": null, - "refs": {} - }, - "GetPolicyGenerationResponse": { - "base": null, - "refs": {} - }, - "GetPolicyGenerationSummaryRequest": { - "base": null, - "refs": {} - }, - "GetPolicyGenerationSummaryResponse": { - "base": null, - "refs": {} - }, - "GetPolicyRequest": { - "base": null, - "refs": {} - }, - "GetPolicyResponse": { - "base": null, - "refs": {} - }, - "GetPolicySummaryRequest": { - "base": null, - "refs": {} - }, - "GetPolicySummaryResponse": { - "base": null, - "refs": {} - }, - "GetRegistryRecordRequest": { - "base": null, - "refs": {} - }, - "GetRegistryRecordResponse": { - "base": null, - "refs": {} - }, - "GetRegistryRequest": { - "base": null, - "refs": {} - }, - "GetRegistryResponse": { - "base": null, - "refs": {} - }, - "GetResourcePolicyRequest": { - "base": null, - "refs": {} - }, - "GetResourcePolicyResponse": { - "base": null, - "refs": {} - }, - "GetTokenVaultRequest": { - "base": null, - "refs": {} - }, - "GetTokenVaultResponse": { - "base": null, - "refs": {} - }, - "GetWorkloadIdentityRequest": { - "base": null, - "refs": {} - }, - "GetWorkloadIdentityResponse": { - "base": null, - "refs": {} - }, - "GithubOauth2ProviderConfigInput": { - "base": "

Input configuration for a GitHub OAuth2 provider.

", - "refs": { - "Oauth2ProviderConfigInput$githubOauth2ProviderConfig": "

The configuration for a GitHub OAuth2 provider.

" - } - }, - "GithubOauth2ProviderConfigOutput": { - "base": "

Output configuration for a GitHub OAuth2 provider.

", - "refs": { - "Oauth2ProviderConfigOutput$githubOauth2ProviderConfig": "

The output configuration for a GitHub OAuth2 provider.

" - } - }, - "GoogleOauth2ProviderConfigInput": { - "base": "

Input configuration for a Google OAuth2 provider.

", - "refs": { - "Oauth2ProviderConfigInput$googleOauth2ProviderConfig": "

The configuration for a Google OAuth2 provider.

" - } - }, - "GoogleOauth2ProviderConfigOutput": { - "base": "

Output configuration for a Google OAuth2 provider.

", - "refs": { - "Oauth2ProviderConfigOutput$googleOauth2ProviderConfig": "

The output configuration for a Google OAuth2 provider.

" - } - }, - "Harness": { - "base": "

Representation of a harness.

", - "refs": { - "CreateHarnessResponse$harness": "

The harness that was created.

", - "DeleteHarnessResponse$harness": "

The harness that was deleted.

", - "GetHarnessResponse$harness": "

The harness resource.

", - "UpdateHarnessResponse$harness": "

The updated harness.

" - } - }, - "HarnessAgentCoreBrowserConfig": { - "base": "

Configuration for AgentCore Browser.

", - "refs": { - "HarnessToolConfiguration$agentCoreBrowser": "

Configuration for AgentCore Browser.

" - } - }, - "HarnessAgentCoreCodeInterpreterConfig": { - "base": "

Configuration for AgentCore Code Interpreter.

", - "refs": { - "HarnessToolConfiguration$agentCoreCodeInterpreter": "

Configuration for AgentCore Code Interpreter.

" - } - }, - "HarnessAgentCoreGatewayConfig": { - "base": "

Configuration for AgentCore Gateway.

", - "refs": { - "HarnessToolConfiguration$agentCoreGateway": "

Configuration for AgentCore Gateway.

" - } - }, - "HarnessAgentCoreMemoryConfiguration": { - "base": "

Configuration for AgentCore Memory integration.

", - "refs": { - "HarnessMemoryConfiguration$agentCoreMemoryConfiguration": "

The AgentCore Memory configuration.

" - } - }, - "HarnessAgentCoreMemoryRetrievalConfig": { - "base": "

Configuration for memory retrieval within a namespace.

", - "refs": { - "HarnessAgentCoreMemoryRetrievalConfigs$value": null - } - }, - "HarnessAgentCoreMemoryRetrievalConfigs": { - "base": null, - "refs": { - "HarnessAgentCoreMemoryConfiguration$retrievalConfig": "

The retrieval configuration for long-term memory, mapping namespace path templates to retrieval settings.

" - } - }, - "HarnessAgentCoreRuntimeEnvironment": { - "base": "

The AgentCore Runtime environment for a harness.

", - "refs": { - "HarnessEnvironmentProvider$agentCoreRuntimeEnvironment": "

The AgentCore Runtime environment configuration.

" - } - }, - "HarnessAgentCoreRuntimeEnvironmentRequest": { - "base": "

The AgentCore Runtime environment request configuration.

", - "refs": { - "HarnessEnvironmentProviderRequest$agentCoreRuntimeEnvironment": "

The AgentCore Runtime environment configuration.

" - } - }, - "HarnessAllowedTool": { - "base": null, - "refs": { - "HarnessAllowedTools$member": null - } - }, - "HarnessAllowedTools": { - "base": null, - "refs": { - "CreateHarnessRequest$allowedTools": "

The tools that the agent is allowed to use. Supports glob patterns such as * for all tools, @builtin for all built-in tools, or @serverName/toolName for specific MCP server tools.

", - "Harness$allowedTools": "

The allowed tools of the harness. All tools are allowed by default.

", - "UpdateHarnessRequest$allowedTools": "

The tools that the agent is allowed to use. If specified, this replaces all existing allowed tools. If not specified, the existing value is retained.

" - } - }, - "HarnessArn": { - "base": null, - "refs": { - "Harness$arn": "

The ARN of the harness.

", - "HarnessSummary$arn": "

The ARN of the harness.

", - "HarnessVersionSummary$arn": "

The ARN of the harness.

" - } - }, - "HarnessAwsSkillPath": { - "base": null, - "refs": { - "HarnessAwsSkillPaths$member": null - } - }, - "HarnessAwsSkillPaths": { - "base": null, - "refs": { - "HarnessSkillAwsSkillsSource$paths": "

Optionally filter allowed skills with glob syntax, e.g., ['core-skills/*'].

" - } - }, - "HarnessBedrockApiFormat": { - "base": null, - "refs": { - "HarnessBedrockModelConfig$apiFormat": "

The API format to use when calling the Bedrock provider.

" - } - }, - "HarnessBedrockModelConfig": { - "base": "

Configuration for an Amazon Bedrock model provider.

", - "refs": { - "HarnessModelConfiguration$bedrockModelConfig": "

Configuration for an Amazon Bedrock model.

" - } - }, - "HarnessBrowserArn": { - "base": "

Browser ARN for Harness tool configuration. Accepts both managed (aws.browser.v1) and custom browser ARNs.

", - "refs": { - "HarnessAgentCoreBrowserConfig$browserArn": "

If not populated, the built-in Browser ARN is used.

" - } - }, - "HarnessCodeInterpreterArn": { - "base": "

Code Interpreter ARN for Harness tool configuration. Accepts both managed (aws.codeinterpreter.v1) and custom code interpreter ARNs.

", - "refs": { - "HarnessAgentCoreCodeInterpreterConfig$codeInterpreterArn": "

If not populated, the built-in Code Interpreter ARN is used.

" - } - }, - "HarnessDisabledMemoryConfiguration": { - "base": "

Explicitly opt out of memory.

", - "refs": { - "HarnessMemoryConfiguration$disabled": "

Explicitly opt out of memory.

" - } - }, - "HarnessEndpoint": { - "base": "

Representation of a harness endpoint. An endpoint is a named, stable reference to a specific version of a harness that callers invoke, allowing the underlying version to be updated without changing how the agent is invoked.

", - "refs": { - "CreateHarnessEndpointResponse$endpoint": "

The endpoint that was created.

", - "DeleteHarnessEndpointResponse$endpoint": "

The endpoint that was deleted.

", - "GetHarnessEndpointResponse$endpoint": "

The endpoint resource.

", - "HarnessEndpoints$member": null, - "UpdateHarnessEndpointResponse$endpoint": "

The updated endpoint.

" - } - }, - "HarnessEndpointArn": { - "base": null, - "refs": { - "HarnessEndpoint$arn": "

The ARN of the endpoint.

" - } - }, - "HarnessEndpointDescription": { - "base": null, - "refs": { - "CreateHarnessEndpointRequest$description": "

A description of the endpoint.

", - "HarnessEndpoint$description": "

The description of the endpoint.

", - "UpdateHarnessEndpointRequest$description": "

A description of the endpoint. If not specified, the existing value is retained.

" - } - }, - "HarnessEndpointName": { - "base": null, - "refs": { - "CreateHarnessEndpointRequest$endpointName": "

The name of the endpoint. Must start with a letter and contain only alphanumeric characters and underscores.

", - "DeleteHarnessEndpointRequest$endpointName": "

The name of the endpoint to delete.

", - "GetHarnessEndpointRequest$endpointName": "

The name of the endpoint to retrieve.

", - "HarnessEndpoint$endpointName": "

The name of the endpoint.

", - "UpdateHarnessEndpointRequest$endpointName": "

The name of the endpoint to update.

" - } - }, - "HarnessEndpointStatus": { - "base": null, - "refs": { - "HarnessEndpoint$status": "

The status of the endpoint.

" - } - }, - "HarnessEndpoints": { - "base": null, - "refs": { - "ListHarnessEndpointsResponse$endpoints": "

The list of harness endpoints.

" - } - }, - "HarnessEnvironmentArtifact": { - "base": "

The environment artifact for a harness, such as a container image containing custom dependencies.

", - "refs": { - "CreateHarnessRequest$environmentArtifact": "

The environment artifact for the harness, such as a custom container image containing additional dependencies.

", - "Harness$environmentArtifact": "

The environment artifact (e.g., container) in which the Harness operates.

", - "UpdatedHarnessEnvironmentArtifact$optionalValue": "

The updated environment artifact value, or null to clear the existing configuration.

" - } - }, - "HarnessEnvironmentProvider": { - "base": "

The environment provider for a harness.

", - "refs": { - "Harness$environment": "

The compute environment on which the Harness runs.

" - } - }, - "HarnessEnvironmentProviderRequest": { - "base": "

The environment provider request configuration.

", - "refs": { - "CreateHarnessRequest$environment": "

The compute environment configuration for the harness, including network and lifecycle settings.

", - "UpdateHarnessRequest$environment": "

The compute environment configuration for the harness. If not specified, the existing value is retained.

" - } - }, - "HarnessGatewayOutboundAuth": { - "base": "

Authentication method for calling a Gateway.

", - "refs": { - "HarnessAgentCoreGatewayConfig$outboundAuth": "

How harness authenticates to this Gateway. Defaults to AWS_IAM (SigV4) if omitted.

" - } - }, - "HarnessGeminiModelConfig": { - "base": "

Configuration for a Google Gemini model provider. Requires an API key stored in AgentCore Identity.

", - "refs": { - "HarnessModelConfiguration$geminiModelConfig": "

Configuration for a Google Gemini model.

" - } - }, - "HarnessId": { - "base": null, - "refs": { - "CreateHarnessEndpointRequest$harnessId": "

The ID of the harness to create an endpoint for.

", - "DeleteHarnessEndpointRequest$harnessId": "

The ID of the harness that the endpoint belongs to.

", - "DeleteHarnessRequest$harnessId": "

The ID of the harness to delete.

", - "GetHarnessEndpointRequest$harnessId": "

The ID of the harness that the endpoint belongs to.

", - "GetHarnessRequest$harnessId": "

The ID of the harness to retrieve.

", - "Harness$harnessId": "

The ID of the harness.

", - "HarnessEndpoint$harnessId": "

The ID of the harness that the endpoint belongs to.

", - "HarnessSummary$harnessId": "

The ID of the harness.

", - "HarnessVersionSummary$harnessId": "

The ID of the harness.

", - "ListHarnessEndpointsRequest$harnessId": "

The ID of the harness whose endpoints are listed.

", - "ListHarnessVersionsRequest$harnessId": "

The ID of the harness whose versions are listed.

", - "UpdateHarnessEndpointRequest$harnessId": "

The ID of the harness that the endpoint belongs to.

", - "UpdateHarnessRequest$harnessId": "

The ID of the harness to update.

" - } - }, - "HarnessInlineFunctionConfig": { - "base": "

Configuration for an inline function tool. When the agent calls this tool, the tool call is returned to the caller for external execution.

", - "refs": { - "HarnessToolConfiguration$inlineFunction": "

Configuration for an inline function tool.

" - } - }, - "HarnessInlineFunctionDescription": { - "base": null, - "refs": { - "HarnessInlineFunctionConfig$description": "

Description of what the tool does, provided to the model.

" - } - }, - "HarnessLiteLlmApiBase": { - "base": null, - "refs": { - "HarnessLiteLlmModelConfig$apiBase": "

The base URL for the model provider's API endpoint.

" - } - }, - "HarnessLiteLlmModelConfig": { - "base": "

Configuration for a LiteLLM model provider, enabling connection to third-party model providers.

", - "refs": { - "HarnessModelConfiguration$liteLlmModelConfig": "

The LiteLLM model configuration for connecting to third-party model providers.

" - } - }, - "HarnessManagedMemoryConfiguration": { - "base": "

Configuration for managed memory creation.

", - "refs": { - "HarnessMemoryConfiguration$managedMemoryConfiguration": "

Harness creates and manages a memory resource in the customer's account.

" - } - }, - "HarnessManagedMemoryConfigurationEventExpiryDurationInteger": { - "base": null, - "refs": { - "HarnessManagedMemoryConfiguration$eventExpiryDuration": "

Event retention in days. Defaults to 30.

" - } - }, - "HarnessManagedMemoryStrategyList": { - "base": null, - "refs": { - "HarnessManagedMemoryConfiguration$strategies": "

Strategy types to enable. Defaults to [SEMANTIC, SUMMARIZATION].

" - } - }, - "HarnessManagedMemoryStrategyType": { - "base": null, - "refs": { - "HarnessManagedMemoryStrategyList$member": null - } - }, - "HarnessMemoryConfiguration": { - "base": "

The memory configuration for a harness.

", - "refs": { - "CreateHarnessRequest$memory": "

The AgentCore Memory configuration for persisting conversation context across sessions.

", - "Harness$memory": "

AgentCore Memory instance configuration for short and long term memory.

", - "UpdatedHarnessMemoryConfiguration$optionalValue": "

The updated memory configuration value, or null to clear the existing configuration.

" - } - }, - "HarnessModelConfiguration": { - "base": "

Specification of which model to use.

", - "refs": { - "CreateHarnessRequest$model": "

The model configuration for the harness. Supports Amazon Bedrock, OpenAI, and Google Gemini model providers.

", - "Harness$model": "

The configuration of the default model used by the Harness.

", - "UpdateHarnessRequest$model": "

The model configuration for the harness. If not specified, the existing value is retained.

" - } - }, - "HarnessName": { - "base": null, - "refs": { - "CreateHarnessRequest$harnessName": "

The name of the harness. Must start with a letter and contain only alphanumeric characters and underscores.

", - "Harness$harnessName": "

The name of the harness.

", - "HarnessEndpoint$harnessName": "

The name of the harness that the endpoint belongs to.

", - "HarnessSummary$harnessName": "

The name of the harness.

", - "HarnessVersionSummary$harnessName": "

The name of the harness.

" - } - }, - "HarnessOpenAiApiFormat": { - "base": null, - "refs": { - "HarnessOpenAiModelConfig$apiFormat": "

The API format to use when calling the OpenAI provider.

" - } - }, - "HarnessOpenAiModelConfig": { - "base": "

Configuration for an OpenAI model provider. Requires an API key stored in AgentCore Identity.

", - "refs": { - "HarnessModelConfiguration$openAiModelConfig": "

Configuration for an OpenAI model.

" - } - }, - "HarnessRemoteMcpConfig": { - "base": "

Configuration for connecting to a remote MCP server.

", - "refs": { - "HarnessToolConfiguration$remoteMcp": "

Configuration for remote MCP server.

" - } - }, - "HarnessRemoteMcpUrl": { - "base": null, - "refs": { - "HarnessRemoteMcpConfig$url": "

URL of the MCP endpoint.

" - } - }, - "HarnessSkill": { - "base": "

A skill available to the agent.

", - "refs": { - "HarnessSkills$member": null - } - }, - "HarnessSkillAwsSkillsSource": { - "base": "

Passed to show that AWS Skills should be included.

", - "refs": { - "HarnessSkill$awsSkills": "

AWS Skills baked into the harness's underlying Runtime.

" - } - }, - "HarnessSkillGitAuth": { - "base": "

Authentication configuration for accessing a private git repository.

", - "refs": { - "HarnessSkillGitSource$auth": "

Authentication configuration for private repositories.

" - } - }, - "HarnessSkillGitSource": { - "base": "

A git repository source for a skill.

", - "refs": { - "HarnessSkill$git": "

A git repository containing the skill.

" - } - }, - "HarnessSkillGitUrl": { - "base": null, - "refs": { - "HarnessSkillGitSource$url": "

The HTTPS URL of the git repository.

" - } - }, - "HarnessSkillPath": { - "base": null, - "refs": { - "HarnessSkill$path": "

The filesystem path to the skill definition.

" - } - }, - "HarnessSkillS3Source": { - "base": "

An S3 source for a skill.

", - "refs": { - "HarnessSkill$s3": "

An S3 source containing the skill.

" - } - }, - "HarnessSkillS3Uri": { - "base": null, - "refs": { - "HarnessSkillS3Source$uri": "

The S3 URI pointing to the skill directory (e.g., s3://bucket/skills/my-skill/).

" - } - }, - "HarnessSkills": { - "base": null, - "refs": { - "CreateHarnessRequest$skills": "

The skills available to the agent. Skills are bundles of files that the agent can pull into its context on demand.

", - "Harness$skills": "

The skills of the harness.

", - "UpdateHarnessRequest$skills": "

The skills available to the agent. If specified, this replaces all existing skills. If not specified, the existing value is retained.

" - } - }, - "HarnessSlidingWindowConfiguration": { - "base": "

Configuration for sliding window truncation strategy.

", - "refs": { - "HarnessTruncationStrategyConfiguration$slidingWindow": "

Configuration for sliding window truncation.

" - } - }, - "HarnessStatus": { - "base": null, - "refs": { - "Harness$status": "

The status of the harness.

", - "HarnessSummary$status": "

The current status of the harness.

", - "HarnessVersionSummary$status": "

The status of this harness version.

" - } - }, - "HarnessSummaries": { - "base": null, - "refs": { - "ListHarnessesResponse$harnesses": "

The list of harness summaries.

" - } - }, - "HarnessSummarizationConfiguration": { - "base": "

Configuration for summarization-based truncation strategy.

", - "refs": { - "HarnessTruncationStrategyConfiguration$summarization": "

Configuration for summarization-based truncation.

" - } - }, - "HarnessSummary": { - "base": "

Summary information about a harness.

", - "refs": { - "HarnessSummaries$member": null - } - }, - "HarnessSystemContentBlock": { - "base": "

A content block in the system prompt.

", - "refs": { - "HarnessSystemPrompt$member": null - } - }, - "HarnessSystemPrompt": { - "base": null, - "refs": { - "CreateHarnessRequest$systemPrompt": "

The system prompt that defines the agent's behavior and instructions.

", - "Harness$systemPrompt": "

The system prompt of the harness.

", - "UpdateHarnessRequest$systemPrompt": "

The system prompt that defines the agent's behavior. If not specified, the existing value is retained.

" - } - }, - "HarnessTool": { - "base": "

A tool available to the agent loop.

", - "refs": { - "HarnessTools$member": null - } - }, - "HarnessToolConfiguration": { - "base": "

Configuration union for different tool types.

", - "refs": { - "HarnessTool$config": "

Tool-specific configuration.

" - } - }, - "HarnessToolName": { - "base": null, - "refs": { - "HarnessTool$name": "

Unique name for the tool. If not provided, a name will be inferred or generated.

" - } - }, - "HarnessToolType": { - "base": null, - "refs": { - "HarnessTool$type": "

The type of tool.

" - } - }, - "HarnessTools": { - "base": null, - "refs": { - "CreateHarnessRequest$tools": "

The tools available to the agent, such as remote MCP servers, AgentCore Gateway, AgentCore Browser, Code Interpreter, or inline functions.

", - "Harness$tools": "

The tools of the harness.

", - "UpdateHarnessRequest$tools": "

The tools available to the agent. If specified, this replaces all existing tools. If not specified, the existing value is retained.

" - } - }, - "HarnessTruncationConfiguration": { - "base": "

Configuration for truncating conversation context when it exceeds model limits.

", - "refs": { - "CreateHarnessRequest$truncation": "

The truncation configuration for managing conversation context when it exceeds model limits.

", - "Harness$truncation": "

Configuration for truncating model context.

", - "UpdateHarnessRequest$truncation": "

The truncation configuration for managing conversation context. If not specified, the existing value is retained.

" - } - }, - "HarnessTruncationStrategy": { - "base": null, - "refs": { - "HarnessTruncationConfiguration$strategy": "

The truncation strategy to use.

" - } - }, - "HarnessTruncationStrategyConfiguration": { - "base": "

Strategy-specific truncation configuration.

", - "refs": { - "HarnessTruncationConfiguration$config": "

The strategy-specific configuration.

" - } - }, - "HarnessVersion": { - "base": null, - "refs": { - "CreateHarnessEndpointRequest$targetVersion": "

The harness version that the endpoint points to and serves invocations from.

", - "GetHarnessRequest$harnessVersion": "

Specific version of the harness to retrieve. If omitted, returns the current Harness configuration, including its status.

", - "Harness$harnessVersion": "

The version of the harness. Incremented on every successful UpdateHarness.

", - "HarnessEndpoint$liveVersion": "

The harness version that the endpoint is currently serving.

", - "HarnessEndpoint$targetVersion": "

The harness version that the endpoint points to. While an update is in progress, this can differ from the live version until the endpoint finishes transitioning.

", - "HarnessSummary$harnessVersion": "

The latest version of the harness.

", - "HarnessVersionSummary$harnessVersion": "

The version of the harness that this summary describes.

", - "UpdateHarnessEndpointRequest$targetVersion": "

The harness version that the endpoint points to. If not specified, the existing value is retained.

" - } - }, - "HarnessVersionSummaries": { - "base": null, - "refs": { - "ListHarnessVersionsResponse$harnessVersions": "

The list of harness version summaries.

" - } - }, - "HarnessVersionSummary": { - "base": "

Summary information about a single version of a harness.

", - "refs": { - "HarnessVersionSummaries$member": null - } - }, - "HeaderName": { - "base": null, - "refs": { - "RequestHeaderAllowlist$member": null - } - }, - "HostingEnvironment": { - "base": "

A hosting environment whose workloads are allowed to invoke the target. At launch, the only supported hosting environment is AgentCore Gateway.

", - "refs": { - "HostingEnvironmentListType$member": null - } - }, - "HostingEnvironmentListType": { - "base": null, - "refs": { - "AllowedWorkloadConfiguration$hostingEnvironments": "

The list of hosting environments whose workloads are allowed to invoke the target. At launch, the only supported hosting environment is AgentCore Gateway.

" - } - }, - "HttpApiSchemaConfiguration": { - "base": "

The API schema configuration for an HTTP target. This schema defines the API structure that the target exposes.

", - "refs": { - "PassthroughTargetConfiguration$schema": "

The API schema configuration that defines the structure of the passthrough target's API.

", - "RuntimeTargetConfiguration$schema": "

The API schema configuration that defines the structure of the runtime target's API.

" - } - }, - "HttpHeaderKey": { - "base": "

The key of an HTTP header.

", - "refs": { - "HttpHeadersMap$key": null - } - }, - "HttpHeaderName": { - "base": null, - "refs": { - "AllowedRequestHeaders$member": null, - "AllowedResponseHeaders$member": null - } - }, - "HttpHeaderValue": { - "base": "

The value of an HTTP header.

", - "refs": { - "HttpHeadersMap$value": null - } - }, - "HttpHeadersMap": { - "base": "

Map of key/value pairs for HTTP headers.

", - "refs": { - "HarnessRemoteMcpConfig$headers": "

Custom headers to include when connecting to the remote MCP server.

" - } - }, - "HttpQueryParameterName": { - "base": null, - "refs": { - "AllowedQueryParameters$member": null - } - }, - "HttpTargetConfiguration": { - "base": "

The HTTP target configuration for a gateway target. Contains the configuration for HTTP-based target endpoints.

", - "refs": { - "TargetConfiguration$http": "

The HTTP target configuration. Use this to route gateway requests to an HTTP-based endpoint such as an AgentCore Runtime.

" - } - }, - "IamCredentialProvider": { - "base": "

An IAM credential provider for gateway authentication. This structure contains the configuration for authenticating with the target endpoint using IAM credentials and SigV4 signing.

", - "refs": { - "CredentialProvider$iamCredentialProvider": "

The IAM credential provider. This provider uses IAM authentication with SigV4 signing to access the target endpoint.

" - } - }, - "IamCredentialProviderRegionString": { - "base": null, - "refs": { - "IamCredentialProvider$region": "

The Amazon Web Services Region used for SigV4 signing. If not specified, defaults to the gateway's Region.

" - } - }, - "IamCredentialProviderServiceString": { - "base": null, - "refs": { - "IamCredentialProvider$service": "

The target Amazon Web Services service name used for SigV4 signing. This value identifies the service that the gateway authenticates with when making requests to the target endpoint.

" - } - }, - "IamPrincipal": { - "base": "

An IAM principal specification for rule matching.

", - "refs": { - "MatchPrincipalEntry$iamPrincipal": "

An IAM principal to match against, specified by ARN.

" - } - }, - "IamPrincipalArn": { - "base": null, - "refs": { - "IamPrincipal$arn": "

The Amazon Resource Name (ARN) of the IAM principal. Supports user, role, and assumed-role ARNs. Wildcards can be used with the StringLike operator.

" - } - }, - "IamRoleArn": { - "base": null, - "refs": { - "RegistryRecordIamCredentialProvider$roleArn": "

The Amazon Resource Name (ARN) of the IAM role to assume for SigV4 signing.

" - } - }, - "IamSigningRegion": { - "base": null, - "refs": { - "RegistryRecordIamCredentialProvider$region": "

The Amazon Web Services region for SigV4 signing (for example, us-west-2). If not specified, the region is extracted from the MCP server URL hostname, with fallback to the service's own region.

" - } - }, - "IamSigningServiceName": { - "base": null, - "refs": { - "RegistryRecordIamCredentialProvider$service": "

The SigV4 signing service name (for example, execute-api or bedrock-agentcore).

" - } - }, - "InboundTokenClaimNameType": { - "base": null, - "refs": { - "CustomClaimValidationType$inboundTokenClaimName": "

The name of the custom claim field to check.

" - } - }, - "InboundTokenClaimValueType": { - "base": null, - "refs": { - "CustomClaimValidationType$inboundTokenClaimValueType": "

The data type of the claim value to check for.

  • Use STRING if you want to find an exact match to a string you define.

  • Use STRING_ARRAY if you want to fnd a match to at least one value in an array you define.

" - } - }, - "IncludedData": { - "base": null, - "refs": { - "GetEvaluatorRequest$includedData": "

Controls which data is returned in the response. ALL_DATA (default) returns the full evaluator including decrypted instructions and rating scale. For evaluators encrypted with a customer managed KMS key, this requires kms:Decrypt permission on the key. METADATA_ONLY returns evaluator metadata and model configuration without instructions or rating scale, and does not require any KMS permissions.

" - } - }, - "IncludedOauth2ProviderConfigInput": { - "base": "

Configuration settings for connecting to a supported OAuth2 provider. This includes client credentials and OAuth2 discovery information for providers that have built-in support.

", - "refs": { - "Oauth2ProviderConfigInput$includedOauth2ProviderConfig": "

The configuration for a non-custom OAuth2 provider. This includes settings for supported OAuth2 providers that have built-in integration support.

" - } - }, - "IncludedOauth2ProviderConfigOutput": { - "base": "

The configuration details returned for a supported OAuth2 provider, including client credentials and OAuth2 discovery information.

", - "refs": { - "Oauth2ProviderConfigOutput$includedOauth2ProviderConfig": "

The configuration for a non-custom OAuth2 provider. This includes the configuration details for supported OAuth2 providers that have built-in integration support.

" - } - }, - "IndexedKey": { - "base": "

A metadata key indexed for filtering.

", - "refs": { - "IndexedKeysList$member": null - } - }, - "IndexedKeysList": { - "base": null, - "refs": { - "CreateMemoryInput$indexedKeys": "

Metadata keys to index for filtering. Once declared, indexed keys cannot be removed.

", - "Memory$indexedKeys": "

The indexed metadata keys for this memory. Only indexed keys can be used in metadata filters.

", - "UpdateMemoryInput$addIndexedKeys": "

Additional metadata keys to index. Previously indexed keys cannot be removed.

" - } - }, - "InferenceConfiguration": { - "base": "

The configuration parameters that control how the foundation model behaves during evaluation, including response generation settings.

", - "refs": { - "BedrockEvaluatorModelConfig$inferenceConfig": "

The inference configuration parameters that control model behavior during evaluation, including temperature, token limits, and sampling settings.

" - } - }, - "InferenceConfigurationMaxTokensInteger": { - "base": null, - "refs": { - "InferenceConfiguration$maxTokens": "

The maximum number of tokens to generate in the model response during evaluation.

" - } - }, - "InferenceConfigurationStopSequencesList": { - "base": null, - "refs": { - "InferenceConfiguration$stopSequences": "

The list of sequences that will cause the model to stop generating tokens when encountered.

" - } - }, - "InferenceConfigurationTemperatureFloat": { - "base": null, - "refs": { - "InferenceConfiguration$temperature": "

The temperature value that controls randomness in the model's responses. Lower values produce more deterministic outputs.

" - } - }, - "InferenceConfigurationTopPFloat": { - "base": null, - "refs": { - "InferenceConfiguration$topP": "

The top-p sampling parameter that controls the diversity of the model's responses by limiting the cumulative probability of token choices.

" - } - }, - "InferenceConnectorId": { - "base": null, - "refs": { - "InferenceConnectorSource$connectorId": "

The identifier for the inference connector (for example, bedrock-mantle, openai, or anthropic).

" - } - }, - "InferenceConnectorSource": { - "base": "

The source identifying the inference connector.

", - "refs": { - "InferenceConnectorTargetConfiguration$source": "

The source configuration identifying which inference connector to use.

" - } - }, - "InferenceConnectorTargetConfiguration": { - "base": "

The configuration for a connector-based inference target. This configuration uses a built-in connector that provides predefined rules for a large language model (LLM) provider.

", - "refs": { - "InferenceTargetConfiguration$connector": "

The connector-based inference configuration. Use this option to route requests to an LLM provider through a built-in connector that includes predefined provider rules.

" - } - }, - "InferenceOperationConfiguration": { - "base": "

The configuration for a specific inference operation, including its request path and the models that the operation supports.

", - "refs": { - "InferenceOperationConfigurations$member": null - } - }, - "InferenceOperationConfigurations": { - "base": null, - "refs": { - "InferenceProviderTargetConfiguration$operations": "

A list of per-operation configurations that map request paths to the models supported for each operation.

" - } - }, - "InferenceOperationPath": { - "base": null, - "refs": { - "InferenceOperationConfiguration$path": "

The request path for this operation (for example, /v1/messages or /v1/responses).

", - "InferenceOperationConfiguration$providerPath": "

The provider path to forward requests to, if it differs from the request path. For example, /anthropic/v1/messages when the provider expects a different path than the client-facing /v1/messages.

" - } - }, - "InferenceProviderTargetConfiguration": { - "base": "

The configuration for a provider-based inference target. This configuration explicitly defines the endpoint, model mapping, and operations used to route requests to a large language model (LLM) provider.

", - "refs": { - "InferenceTargetConfiguration$provider": "

The provider-based inference configuration. Use this option to explicitly configure the endpoint, model mapping, and operations for an LLM provider.

" - } - }, - "InferenceTargetConfiguration": { - "base": "

The configuration for an inference target. An inference target routes requests to a large language model (LLM) provider, either through a built-in connector or an explicitly configured provider.

", - "refs": { - "TargetConfiguration$inference": "

The inference configuration for the target. This configuration routes requests to a large language model (LLM) provider.

" - } - }, - "InlineContent": { - "base": null, - "refs": { - "AgentCardDefinition$inlineContent": "

The JSON content containing the A2A agent card definition, conforming to the A2A protocol specification.

", - "CustomDescriptor$inlineContent": "

The custom descriptor content as a valid JSON document. You can define any custom schema that describes your resource.

", - "ServerDefinition$inlineContent": "

The JSON content containing the MCP server definition, conforming to the MCP protocol specification.

", - "SkillDefinition$inlineContent": "

The JSON content containing the structured skill definition.

", - "SkillMdDefinition$inlineContent": "

The markdown content describing the agent's skills in a human-readable format.

", - "ToolsDefinition$inlineContent": "

The JSON content containing the MCP tools definition, conforming to the MCP protocol specification.

" - } - }, - "InlineExamplesSource": { - "base": "

Inline examples provided directly in the request body.

", - "refs": { - "DataSourceType$inlineExamples": "

Inline examples provided directly in the request body.

" - } - }, - "InlineExamplesSourceExamplesList": { - "base": "

A list of dataset examples. Each element is a free-form JSON document whose structure is defined by the dataset's schema type.

", - "refs": { - "InlineExamplesSource$examples": "

Examples to add. Each example is assigned an auto-generated UUID.

" - } - }, - "InlinePayload": { - "base": null, - "refs": { - "ApiSchemaConfiguration$inlinePayload": "

The inline payload containing the API schema definition.

", - "McpToolSchemaConfiguration$inlinePayload": "

The inline payload containing the MCP tool schema definition.

" - } - }, - "Insight": { - "base": "

A reference to an insight analysis to run against sessions during evaluation. Insights provide deeper analysis beyond individual evaluator scores, including failure detection, user intent clustering, and execution summarization.

", - "refs": { - "InsightList$member": null - } - }, - "InsightId": { - "base": "

Canonical insight identifiers using the Builtin.Insight.* naming convention. Used by BatchEvaluate, InternalEvaluate, and ServiceEngineEvaluate flows.

", - "refs": { - "Insight$insightId": "

The unique identifier of the insight to run.

" - } - }, - "InsightList": { - "base": null, - "refs": { - "CreateOnlineEvaluationConfigRequest$insights": "

The list of insight types to run against agent sessions.

", - "GetOnlineEvaluationConfigResponse$insights": "

The list of insight types configured for this evaluation.

", - "OnlineEvaluationConfigSummary$insights": "

The list of insight types configured for this evaluation.

", - "UpdateOnlineEvaluationConfigRequest$insights": "

The updated list of insight types to run against agent sessions.

" - } - }, - "Integer": { - "base": null, - "refs": { - "CreateHarnessRequest$maxIterations": "

The maximum number of iterations the agent loop can execute per invocation.

", - "CreateHarnessRequest$maxTokens": "

The maximum total number of output tokens the agent can generate across all model calls within a single invocation.

", - "CreateHarnessRequest$timeoutSeconds": "

The maximum duration in seconds for the agent loop execution per invocation.

", - "Harness$maxIterations": "

The maximum number of iterations in the agent loop allowed before exiting per invocation.

", - "Harness$maxTokens": "

The maximum total number of output tokens the agent can generate across all model calls within a single invocation.

", - "Harness$timeoutSeconds": "

The maximum duration per invocation.

", - "HarnessAgentCoreMemoryConfiguration$messagesCount": "

The number of messages to retrieve from memory.

", - "HarnessAgentCoreMemoryRetrievalConfig$topK": "

The maximum number of memory entries to retrieve.

", - "HarnessSlidingWindowConfiguration$messagesCount": "

The number of recent messages to retain in the context window.

", - "HarnessSummarizationConfiguration$preserveRecentMessages": "

The number of recent messages to preserve without summarization.

", - "MessageBasedTrigger$messageCount": "

The number of messages that trigger memory processing.

", - "SelfManagedConfiguration$historicalContextWindowSize": "

The number of historical messages to include in processing context.

", - "TimeBasedTrigger$idleSessionTimeout": "

Idle session timeout (seconds) that triggers memory processing.

", - "TokenBasedTrigger$tokenCount": "

Number of tokens that trigger memory processing.

", - "UpdateHarnessRequest$maxIterations": "

The maximum number of iterations the agent loop can execute per invocation. If not specified, the existing value is retained.

", - "UpdateHarnessRequest$maxTokens": "

The maximum total number of output tokens the agent can generate across all model calls within a single invocation. If not specified, the existing value is retained.

", - "UpdateHarnessRequest$timeoutSeconds": "

The maximum duration in seconds for the agent loop execution per invocation. If not specified, the existing value is retained.

" - } - }, - "InterceptorConfiguration": { - "base": "

The interceptor configuration.

", - "refs": { - "GatewayInterceptorConfiguration$interceptor": "

The infrastructure settings of an interceptor configuration. This structure defines how the interceptor can be invoked.

" - } - }, - "InterceptorInputConfiguration": { - "base": "

The input configuration of the interceptor.

", - "refs": { - "GatewayInterceptorConfiguration$inputConfiguration": "

The configuration for the input of the interceptor. This field specifies how the input to the interceptor is constructed

" - } - }, - "InterceptorPayloadExclusion": { - "base": null, - "refs": { - "InterceptorPayloadExclusionSelector$field": "

The field to exclude from the interceptor input.

" - } - }, - "InterceptorPayloadExclusionSelector": { - "base": "

A selector that identifies a payload field to exclude from the interceptor input.

", - "refs": { - "InterceptorPayloadExclusionSelectorList$member": null - } - }, - "InterceptorPayloadExclusionSelectorList": { - "base": null, - "refs": { - "InterceptorPayloadFilter$exclude": "

The list of selectors that identify payload fields to exclude from the interceptor input.

" - } - }, - "InterceptorPayloadFilter": { - "base": "

The filter that controls which fields of the request or response payload are included in the input to the interceptor.

", - "refs": { - "InterceptorInputConfiguration$payloadFilter": "

The filter that determines which parts of the request or response payload are passed as input to the interceptor.

" - } - }, - "InternalServerException": { - "base": "

This exception is thrown if there was an unexpected error during processing of request

", - "refs": {} - }, - "InvocationConfiguration": { - "base": "

The configuration to invoke a self-managed memory processing pipeline with.

", - "refs": { - "SelfManagedConfiguration$invocationConfiguration": "

The configuration to use when invoking memory processing.

" - } - }, - "InvocationConfigurationInput": { - "base": "

The configuration to invoke a self-managed memory processing pipeline with.

", - "refs": { - "SelfManagedConfigurationInput$invocationConfiguration": "

Configuration to invoke a self-managed memory processing pipeline with.

" - } - }, - "InvocationConfigurationInputPayloadDeliveryBucketNameString": { - "base": null, - "refs": { - "InvocationConfigurationInput$payloadDeliveryBucketName": "

The S3 bucket name for event payload delivery.

" - } - }, - "IssuerUrlType": { - "base": null, - "refs": { - "IncludedOauth2ProviderConfigInput$issuer": "

Token issuer of your isolated OAuth2 application tenant. This URL identifies the authorization server that issues tokens for this provider.

", - "Oauth2AuthorizationServerMetadata$issuer": "

The issuer URL for the OAuth2 authorization server.

" - } - }, - "KeyType": { - "base": null, - "refs": { - "KmsConfiguration$keyType": "

The type of KMS key (CustomerManagedKey or ServiceManagedKey).

" - } - }, - "KinesisResource": { - "base": "

Configuration for Kinesis Data Stream delivery.

", - "refs": { - "StreamDeliveryResource$kinesis": "

Kinesis Data Stream configuration.

" - } - }, - "KinesisResourceContentConfigurationsList": { - "base": null, - "refs": { - "KinesisResource$contentConfigurations": "

Content configurations for stream delivery.

" - } - }, - "KmsConfiguration": { - "base": "

Contains the KMS configuration for a resource.

", - "refs": { - "GetTokenVaultResponse$kmsConfiguration": "

The KMS configuration for the token vault.

", - "SetTokenVaultCMKRequest$kmsConfiguration": "

The KMS configuration for the token vault, including the key type and KMS key ARN.

", - "SetTokenVaultCMKResponse$kmsConfiguration": "

The KMS configuration for the token vault.

" - } - }, - "KmsKeyArn": { - "base": null, - "refs": { - "CreateConfigurationBundleRequest$kmsKeyArn": "

Optional KMS key ARN for encrypting component configurations.

", - "CreateDatasetRequest$kmsKeyArn": "

Optional KMS key ARN for server-side encryption on service Amazon S3 writes.

", - "CreateEvaluatorRequest$kmsKeyArn": "

The Amazon Resource Name (ARN) of a customer managed KMS key to use for encrypting sensitive evaluator data, including instructions and rating scale. If you don't specify a KMS key, the evaluator data is encrypted with an Amazon Web Services owned key. Only symmetric encryption KMS keys are supported. For more information, see Encryption at rest for AgentCore Evaluations.

", - "CreateGatewayRequest$kmsKeyArn": "

The Amazon Resource Name (ARN) of the KMS key used to encrypt data associated with the gateway.

", - "CreateGatewayResponse$kmsKeyArn": "

The Amazon Resource Name (ARN) of the KMS key used to encrypt data associated with the gateway.

", - "CreatePolicyEngineRequest$encryptionKeyArn": "

The Amazon Resource Name (ARN) of the KMS key used to encrypt the policy engine data.

", - "CreatePolicyEngineResponse$encryptionKeyArn": "

The Amazon Resource Name (ARN) of the KMS key used to encrypt the policy engine data.

", - "DeletePolicyEngineResponse$encryptionKeyArn": "

The Amazon Resource Name (ARN) of the KMS key used to encrypt the policy engine data.

", - "EvaluatorSummary$kmsKeyArn": "

The Amazon Resource Name (ARN) of the customer managed KMS key used to encrypt the evaluator's sensitive data. This field is only present for evaluators encrypted with a customer managed key.

", - "GetConfigurationBundleResponse$kmsKeyArn": "

KMS key ARN used to encrypt component configurations, if CMK was provided.

", - "GetConfigurationBundleVersionResponse$kmsKeyArn": "

KMS key ARN used to encrypt component configurations, if CMK was provided.

", - "GetDatasetResponse$kmsKeyArn": "

KMS key ARN used for server-side encryption on service Amazon S3 writes, if configured.

", - "GetEvaluatorResponse$kmsKeyArn": "

The Amazon Resource Name (ARN) of the customer managed KMS key used to encrypt the evaluator's sensitive data. This field is only present for evaluators encrypted with a customer managed key.

", - "GetGatewayResponse$kmsKeyArn": "

The Amazon Resource Name (ARN) of the KMS key used to encrypt the gateway.

", - "GetPolicyEngineResponse$encryptionKeyArn": "

The Amazon Resource Name (ARN) of the KMS key used to encrypt the policy engine data.

", - "GetPolicyEngineSummaryResponse$encryptionKeyArn": "

The Amazon Resource Name (ARN) of the KMS key used to encrypt the policy engine data.

", - "HarnessManagedMemoryConfiguration$encryptionKeyArn": "

Customer-managed KMS key. Defaults to AWS-owned key. Not updatable after creation.

", - "KmsConfiguration$kmsKeyArn": "

The Amazon Resource Name (ARN) of the KMS key.

", - "KmsKeySourceType$kmsKeyArn": "

The Amazon Resource Name (ARN) of the KMS key used to sign the JWT client assertion. The key must be an asymmetric key with key usage SIGN_VERIFY and a key spec compatible with the configured signing algorithm.

", - "PolicyEngine$encryptionKeyArn": "

The Amazon Resource Name (ARN) of the KMS key used to encrypt the policy engine data.

", - "PolicyEngineSummary$encryptionKeyArn": "

The Amazon Resource Name (ARN) of the KMS key used to encrypt the policy engine data.

", - "UpdateConfigurationBundleRequest$kmsKeyArn": "

Optional KMS key ARN for encrypting component configurations. If provided, components will be encrypted with this key. If the bundle already has a KMS key, this rotates to the new key.

", - "UpdateEvaluatorRequest$kmsKeyArn": "

The Amazon Resource Name (ARN) of a customer managed KMS key to use for encrypting sensitive evaluator data. Specify a new key ARN to rotate the encryption key, or specify a key ARN to add encryption to an evaluator that was previously created without one. When you rotate to a new key, the service decrypts the existing data with the old key and re-encrypts it with the new key. Only symmetric encryption KMS keys are supported. For more information, see Encryption at rest for AgentCore Evaluations.

", - "UpdateGatewayRequest$kmsKeyArn": "

The updated ARN of the KMS key used to encrypt the gateway.

", - "UpdateGatewayResponse$kmsKeyArn": "

The updated ARN of the KMS key used to encrypt the gateway.

", - "UpdatePolicyEngineResponse$encryptionKeyArn": "

The Amazon Resource Name (ARN) of the KMS key used to encrypt the policy engine data.

" - } - }, - "KmsKeySourceType": { - "base": "

Contains the KMS key configuration for a JWT client assertion.

", - "refs": { - "PrivateKeySource$kmsKeySource": "

The KMS key source for the JWT client assertion.

" - } - }, - "LambdaArn": { - "base": null, - "refs": { - "LambdaEvaluatorConfig$lambdaArn": "

The Amazon Resource Name (ARN) of the Lambda function that implements the evaluation logic.

" - } - }, - "LambdaEvaluatorConfig": { - "base": "

Configuration for a Lambda function used as a code-based evaluator.

", - "refs": { - "CodeBasedEvaluatorConfig$lambdaConfig": "

The Lambda function configuration for code-based evaluation.

" - } - }, - "LambdaEvaluatorConfigLambdaTimeoutInSecondsInteger": { - "base": null, - "refs": { - "LambdaEvaluatorConfig$lambdaTimeoutInSeconds": "

The timeout in seconds for the Lambda function invocation. Defaults to 60. Must be between 1 and 300.

" - } - }, - "LambdaFunctionArn": { - "base": null, - "refs": { - "LambdaInterceptorConfiguration$arn": "

The arn of the lambda function to be invoked for the interceptor.

", - "LambdaTransformConfiguration$arn": "

The Amazon Resource Name (ARN) of the Lambda function. This function is invoked by the gateway to transform data.

", - "McpLambdaTargetConfiguration$lambdaArn": "

The Amazon Resource Name (ARN) of the Lambda function. This function is invoked by the gateway to communicate with the target.

" - } - }, - "LambdaInterceptorConfiguration": { - "base": "

The lambda configuration for the interceptor

", - "refs": { - "InterceptorConfiguration$lambda": "

The details of the lambda function used for the interceptor.

" - } - }, - "LambdaTransformConfiguration": { - "base": "

The Lambda configuration for custom transformations. This structure defines the Lambda function that the gateway invokes to transform data.

", - "refs": { - "CustomTransformConfiguration$lambda": "

The Lambda configuration for custom transformations. This configuration defines how the gateway uses a Lambda function to transform data.

" - } - }, - "LifecycleConfiguration": { - "base": "

LifecycleConfiguration lets you manage the lifecycle of runtime sessions and resources in AgentCore Runtime. This configuration helps optimize resource utilization by automatically cleaning up idle sessions and preventing long-running instances from consuming resources indefinitely.

", - "refs": { - "CreateAgentRuntimeRequest$lifecycleConfiguration": "

The life cycle configuration for the AgentCore Runtime.

", - "GetAgentRuntimeResponse$lifecycleConfiguration": "

The life cycle configuration for the AgentCore Runtime.

", - "HarnessAgentCoreRuntimeEnvironment$lifecycleConfiguration": null, - "HarnessAgentCoreRuntimeEnvironmentRequest$lifecycleConfiguration": null, - "UpdateAgentRuntimeRequest$lifecycleConfiguration": "

The updated life cycle configuration for the AgentCore Runtime.

" - } - }, - "LifecycleConfigurationIdleRuntimeSessionTimeoutInteger": { - "base": null, - "refs": { - "LifecycleConfiguration$idleRuntimeSessionTimeout": "

Timeout in seconds for idle runtime sessions. When a session remains idle for this duration, it will be automatically terminated. Default: 900 seconds (15 minutes).

" - } - }, - "LifecycleConfigurationMaxLifetimeInteger": { - "base": null, - "refs": { - "LifecycleConfiguration$maxLifetime": "

Maximum lifetime for the instance in seconds. Once reached, instances will be automatically terminated and replaced. Default: 28800 seconds (8 hours).

" - } - }, - "LinkedinOauth2ProviderConfigInput": { - "base": "

Configuration settings for connecting to LinkedIn services using OAuth2 authentication. This includes the client credentials required to authenticate with LinkedIn's OAuth2 authorization server.

", - "refs": { - "Oauth2ProviderConfigInput$linkedinOauth2ProviderConfig": "

Configuration settings for LinkedIn OAuth2 provider integration.

" - } - }, - "LinkedinOauth2ProviderConfigOutput": { - "base": "

The configuration details returned for a LinkedIn OAuth2 provider, including the client ID and OAuth2 discovery information.

", - "refs": { - "Oauth2ProviderConfigOutput$linkedinOauth2ProviderConfig": "

The configuration details for the LinkedIn OAuth2 provider.

" - } - }, - "ListAgentRuntimeEndpointsRequest": { - "base": null, - "refs": {} - }, - "ListAgentRuntimeEndpointsResponse": { - "base": null, - "refs": {} - }, - "ListAgentRuntimeVersionsRequest": { - "base": null, - "refs": {} - }, - "ListAgentRuntimeVersionsResponse": { - "base": null, - "refs": {} - }, - "ListAgentRuntimesRequest": { - "base": null, - "refs": {} - }, - "ListAgentRuntimesResponse": { - "base": null, - "refs": {} - }, - "ListApiKeyCredentialProvidersRequest": { - "base": null, - "refs": {} - }, - "ListApiKeyCredentialProvidersResponse": { - "base": null, - "refs": {} - }, - "ListBrowserProfilesRequest": { - "base": null, - "refs": {} - }, - "ListBrowserProfilesResponse": { - "base": null, - "refs": {} - }, - "ListBrowsersRequest": { - "base": null, - "refs": {} - }, - "ListBrowsersResponse": { - "base": null, - "refs": {} - }, - "ListCodeInterpretersRequest": { - "base": null, - "refs": {} - }, - "ListCodeInterpretersResponse": { - "base": null, - "refs": {} - }, - "ListConfigurationBundleVersionsRequest": { - "base": null, - "refs": {} - }, - "ListConfigurationBundleVersionsRequestMaxResultsInteger": { - "base": null, - "refs": { - "ListConfigurationBundleVersionsRequest$maxResults": "

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.

" - } - }, - "ListConfigurationBundleVersionsResponse": { - "base": null, - "refs": {} - }, - "ListConfigurationBundlesRequest": { - "base": null, - "refs": {} - }, - "ListConfigurationBundlesRequestMaxResultsInteger": { - "base": null, - "refs": { - "ListConfigurationBundlesRequest$maxResults": "

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.

" - } - }, - "ListConfigurationBundlesResponse": { - "base": null, - "refs": {} - }, - "ListDatasetExamplesRequest": { - "base": null, - "refs": {} - }, - "ListDatasetExamplesRequestMaxResultsInteger": { - "base": null, - "refs": { - "ListDatasetExamplesRequest$maxResults": "

Maximum number of examples to return per page.

" - } - }, - "ListDatasetExamplesRequestNextTokenString": { - "base": null, - "refs": { - "ListDatasetExamplesRequest$nextToken": "

The token for the next page of results.

" - } - }, - "ListDatasetExamplesResponse": { - "base": null, - "refs": {} - }, - "ListDatasetVersionsRequest": { - "base": null, - "refs": {} - }, - "ListDatasetVersionsRequestMaxResultsInteger": { - "base": null, - "refs": { - "ListDatasetVersionsRequest$maxResults": "

The maximum number of versions to return per page.

" - } - }, - "ListDatasetVersionsResponse": { - "base": null, - "refs": {} - }, - "ListDatasetsRequest": { - "base": null, - "refs": {} - }, - "ListDatasetsRequestMaxResultsInteger": { - "base": null, - "refs": { - "ListDatasetsRequest$maxResults": "

The maximum number of datasets to return per page.

" - } - }, - "ListDatasetsRequestNextTokenString": { - "base": null, - "refs": { - "ListDatasetsRequest$nextToken": "

The token for the next page of results.

" - } - }, - "ListDatasetsResponse": { - "base": null, - "refs": {} - }, - "ListEvaluatorsRequest": { - "base": null, - "refs": {} - }, - "ListEvaluatorsRequestMaxResultsInteger": { - "base": null, - "refs": { - "ListEvaluatorsRequest$maxResults": "

The maximum number of evaluators to return in a single response.

" - } - }, - "ListEvaluatorsResponse": { - "base": null, - "refs": {} - }, - "ListGatewayRulesRequest": { - "base": null, - "refs": {} - }, - "ListGatewayRulesResponse": { - "base": null, - "refs": {} - }, - "ListGatewayTargetsRequest": { - "base": null, - "refs": {} - }, - "ListGatewayTargetsResponse": { - "base": null, - "refs": {} - }, - "ListGatewaysRequest": { - "base": null, - "refs": {} - }, - "ListGatewaysResponse": { - "base": null, - "refs": {} - }, - "ListHarnessEndpointsRequest": { - "base": null, - "refs": {} - }, - "ListHarnessEndpointsResponse": { - "base": null, - "refs": {} - }, - "ListHarnessVersionsRequest": { - "base": null, - "refs": {} - }, - "ListHarnessVersionsResponse": { - "base": null, - "refs": {} - }, - "ListHarnessesRequest": { - "base": null, - "refs": {} - }, - "ListHarnessesResponse": { - "base": null, - "refs": {} - }, - "ListMemoriesInput": { - "base": null, - "refs": {} - }, - "ListMemoriesInputMaxResultsInteger": { - "base": null, - "refs": { - "ListMemoriesInput$maxResults": "

The maximum number of results to return in a single call. The default value is 10. The maximum value is 50.

" - } - }, - "ListMemoriesOutput": { - "base": null, - "refs": {} - }, - "ListOauth2CredentialProvidersRequest": { - "base": null, - "refs": {} - }, - "ListOauth2CredentialProvidersRequestMaxResultsInteger": { - "base": null, - "refs": { - "ListOauth2CredentialProvidersRequest$maxResults": "

Maximum number of results to return.

" - } - }, - "ListOauth2CredentialProvidersResponse": { - "base": null, - "refs": {} - }, - "ListOnlineEvaluationConfigsRequest": { - "base": null, - "refs": {} - }, - "ListOnlineEvaluationConfigsRequestMaxResultsInteger": { - "base": null, - "refs": { - "ListOnlineEvaluationConfigsRequest$maxResults": "

The maximum number of online evaluation configurations to return in a single response.

" - } - }, - "ListOnlineEvaluationConfigsResponse": { - "base": null, - "refs": {} - }, - "ListPaymentConnectorsRequest": { - "base": null, - "refs": {} - }, - "ListPaymentConnectorsResponse": { - "base": null, - "refs": {} - }, - "ListPaymentCredentialProvidersRequest": { - "base": null, - "refs": {} - }, - "ListPaymentCredentialProvidersRequestMaxResultsInteger": { - "base": null, - "refs": { - "ListPaymentCredentialProvidersRequest$maxResults": "

Maximum number of results to return.

" - } - }, - "ListPaymentCredentialProvidersResponse": { - "base": null, - "refs": {} - }, - "ListPaymentManagersRequest": { - "base": null, - "refs": {} - }, - "ListPaymentManagersResponse": { - "base": null, - "refs": {} - }, - "ListPoliciesRequest": { - "base": null, - "refs": {} - }, - "ListPoliciesResponse": { - "base": null, - "refs": {} - }, - "ListPolicyEngineSummariesRequest": { - "base": null, - "refs": {} - }, - "ListPolicyEngineSummariesResponse": { - "base": null, - "refs": {} - }, - "ListPolicyEnginesRequest": { - "base": null, - "refs": {} - }, - "ListPolicyEnginesResponse": { - "base": null, - "refs": {} - }, - "ListPolicyGenerationAssetsRequest": { - "base": null, - "refs": {} - }, - "ListPolicyGenerationAssetsResponse": { - "base": null, - "refs": {} - }, - "ListPolicyGenerationSummariesRequest": { - "base": null, - "refs": {} - }, - "ListPolicyGenerationSummariesResponse": { - "base": null, - "refs": {} - }, - "ListPolicyGenerationsRequest": { - "base": null, - "refs": {} - }, - "ListPolicyGenerationsResponse": { - "base": null, - "refs": {} - }, - "ListPolicySummariesRequest": { - "base": null, - "refs": {} - }, - "ListPolicySummariesResponse": { - "base": null, - "refs": {} - }, - "ListRegistriesRequest": { - "base": null, - "refs": {} - }, - "ListRegistriesResponse": { - "base": null, - "refs": {} - }, - "ListRegistryRecordsRequest": { - "base": null, - "refs": {} - }, - "ListRegistryRecordsResponse": { - "base": null, - "refs": {} - }, - "ListTagsForResourceRequest": { - "base": null, - "refs": {} - }, - "ListTagsForResourceResponse": { - "base": null, - "refs": {} - }, - "ListWorkloadIdentitiesRequest": { - "base": null, - "refs": {} - }, - "ListWorkloadIdentitiesRequestMaxResultsInteger": { - "base": null, - "refs": { - "ListWorkloadIdentitiesRequest$maxResults": "

Maximum number of results to return.

" - } - }, - "ListWorkloadIdentitiesResponse": { - "base": null, - "refs": {} - }, - "ListingMode": { - "base": null, - "refs": { - "McpServerTargetConfiguration$listingMode": "

The listing mode for the MCP server target configuration. MCP resources for default targets are cached at the control plane for faster access. MCP resources for dynamic targets will be dynamically retrieved when listing tools.

", - "TargetSummary$listingMode": "

The listing mode for the target. MCP resources for DEFAULT targets are cached at the control plane for faster access. MCP resources for DYNAMIC targets are retrieved dynamically when listing tools.

" - } - }, - "LlmAsAJudgeEvaluatorConfig": { - "base": "

The configuration for LLM-as-a-Judge evaluation that uses a language model to assess agent performance based on custom instructions and rating scales.

", - "refs": { - "EvaluatorConfig$llmAsAJudge": "

The LLM-as-a-Judge configuration that uses a language model to evaluate agent performance based on custom instructions and rating scales.

" - } - }, - "LlmExtractionConfig": { - "base": "

Model-based metadata extraction configuration.

", - "refs": { - "ExtractionConfig$llmExtractionConfig": "

Model-based extraction using a definition and instructions.

" - } - }, - "LlmExtractionInstruction": { - "base": null, - "refs": { - "LlmExtractionConfig$llmExtractionInstruction": "

Instructions for extraction. Supports built-in operators like LATEST_VALUE or custom natural-language instructions.

" - } - }, - "LogGroupName": { - "base": null, - "refs": { - "CloudWatchLogsInputConfigLogGroupNamesList$member": null, - "CloudWatchOutputConfig$logGroupName": "

The name of the CloudWatch log group where evaluation results will be written. The log group will be created if it doesn't exist.

" - } - }, - "Long": { - "base": null, - "refs": { - "AddDatasetExamplesResponse$addedCount": "

The number of examples added.

", - "DatasetSummary$exampleCount": "

The number of examples in the dataset.

", - "DatasetVersionSummary$exampleCount": "

The number of examples in this version.

", - "DeleteDatasetExamplesResponse$deletedCount": "

The number of examples deleted.

", - "GetDatasetResponse$exampleCount": "

The number of examples in the DRAFT.

", - "UpdateDatasetExamplesResponse$updatedCount": "

The number of examples updated.

" - } - }, - "MCPGatewayConfiguration": { - "base": "

The configuration for a Model Context Protocol (MCP) gateway. This structure defines how the gateway implements the MCP protocol.

", - "refs": { - "GatewayProtocolConfiguration$mcp": "

The configuration for the Model Context Protocol (MCP). This protocol enables communication between Amazon Bedrock Agent and external tools.

" - } - }, - "ManagedResourceDetails": { - "base": "

Details of a resource created and managed by the gateway for private endpoint connectivity.

", - "refs": { - "PrivateEndpointManagedResources$member": null - } - }, - "ManagedVpcResource": { - "base": "

Configuration for a managed VPC Lattice resource. The gateway creates and manages the VPC Lattice resource gateway and resource configuration on your behalf using a service-linked role.

", - "refs": { - "PrivateEndpoint$managedVpcResource": "

Configuration for connecting to a private resource using a managed VPC Lattice resource. The gateway creates and manages the VPC Lattice resources on your behalf.

" - } - }, - "MatchPathPattern": { - "base": null, - "refs": { - "MatchPathsAnyOfList$member": null - } - }, - "MatchPaths": { - "base": "

A condition that matches requests based on the request path.

", - "refs": { - "Condition$matchPaths": "

A condition that matches on the request path.

" - } - }, - "MatchPathsAnyOfList": { - "base": null, - "refs": { - "MatchPaths$anyOf": "

A list of path patterns. The condition is met if the request path matches any of the patterns.

" - } - }, - "MatchPrincipalEntry": { - "base": "

Union for principal matching. Currently supports IAM principal ARN glob matching.

", - "refs": { - "MatchPrincipalsAnyOfList$member": null - } - }, - "MatchPrincipals": { - "base": "

A condition that matches requests based on the caller's identity.

", - "refs": { - "Condition$matchPrincipals": "

A condition that matches on the identity of the caller making the request.

" - } - }, - "MatchPrincipalsAnyOfList": { - "base": null, - "refs": { - "MatchPrincipals$anyOf": "

A list of principal entries. The condition is met if any of the entries match the caller's identity.

" - } - }, - "MatchValueString": { - "base": null, - "refs": { - "ClaimMatchValueType$matchValueString": "

The string value to match for.

", - "MatchValueStringList$member": null - } - }, - "MatchValueStringList": { - "base": null, - "refs": { - "ClaimMatchValueType$matchValueStringList": "

An array of strings to check for a match.

" - } - }, - "MaxResults": { - "base": null, - "refs": { - "ListAgentRuntimeEndpointsRequest$maxResults": "

The maximum number of results to return in the response.

", - "ListAgentRuntimeVersionsRequest$maxResults": "

The maximum number of results to return in the response.

", - "ListAgentRuntimesRequest$maxResults": "

The maximum number of results to return in the response.

", - "ListApiKeyCredentialProvidersRequest$maxResults": "

Maximum number of results to return.

", - "ListBrowserProfilesRequest$maxResults": "

The maximum number of results to return in the response.

", - "ListBrowsersRequest$maxResults": "

The maximum number of results to return in a single call. The default value is 10. The maximum value is 50.

", - "ListCodeInterpretersRequest$maxResults": "

The maximum number of results to return in the response.

", - "ListHarnessEndpointsRequest$maxResults": "

The maximum number of results to return in a single call.

", - "ListHarnessVersionsRequest$maxResults": "

The maximum number of results to return in a single call.

", - "ListHarnessesRequest$maxResults": "

The maximum number of results to return in a single call.

", - "ListPaymentConnectorsRequest$maxResults": "

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.

", - "ListPaymentManagersRequest$maxResults": "

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.

", - "ListPoliciesRequest$maxResults": "

The maximum number of policies to return in a single response. If not specified, the default is 10 policies per page, with a maximum of 100 per page.

", - "ListPolicyEngineSummariesRequest$maxResults": "

The maximum number of policy engine summaries to return in a single response.

", - "ListPolicyEnginesRequest$maxResults": "

The maximum number of policy engines to return in a single response. If not specified, the default is 10 policy engines per page, with a maximum of 100 per page.

", - "ListPolicyGenerationAssetsRequest$maxResults": "

The maximum number of policy generation assets to return in a single response. If not specified, the default is 10 assets per page, with a maximum of 100 per page. This helps control response size when dealing with policy generations that produce many alternative policy options.

", - "ListPolicyGenerationSummariesRequest$maxResults": "

The maximum number of policy generation summaries to return in a single response.

", - "ListPolicyGenerationsRequest$maxResults": "

The maximum number of policy generations to return in a single response.

", - "ListPolicySummariesRequest$maxResults": "

The maximum number of policy summaries to return in a single response.

", - "ListRegistriesRequest$maxResults": "

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.

", - "ListRegistryRecordsRequest$maxResults": "

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.

" - } - }, - "MaxTokens": { - "base": null, - "refs": { - "HarnessBedrockModelConfig$maxTokens": "

The maximum number of tokens to allow in the generated response per model call.

", - "HarnessGeminiModelConfig$maxTokens": "

The maximum number of tokens to allow in the generated response per model call.

", - "HarnessLiteLlmModelConfig$maxTokens": "

The maximum number of tokens to allow in the generated response per iteration.

", - "HarnessOpenAiModelConfig$maxTokens": "

The maximum number of tokens to allow in the generated response per model call.

" - } - }, - "McpDescriptor": { - "base": "

The Model Context Protocol (MCP) descriptor for a registry record. Contains the server definition and tools definition for an MCP-compatible server. The schema is validated against the MCP protocol specification.

", - "refs": { - "Descriptors$mcp": "

The Model Context Protocol (MCP) descriptor configuration. Use this when the descriptorType is MCP.

" - } - }, - "McpInstructions": { - "base": null, - "refs": { - "MCPGatewayConfiguration$instructions": "

The instructions for using the Model Context Protocol gateway. These instructions provide guidance on how to interact with the gateway.

" - } - }, - "McpLambdaTargetConfiguration": { - "base": "

The Lambda configuration for a Model Context Protocol target. This structure defines how the gateway uses a Lambda function to communicate with the target.

", - "refs": { - "McpTargetConfiguration$lambda": "

The Lambda configuration for the Model Context Protocol target. This configuration defines how the gateway uses a Lambda function to communicate with the target.

" - } - }, - "McpServerTargetConfiguration": { - "base": "

The target configuration for the MCP server.

", - "refs": { - "McpTargetConfiguration$mcpServer": "

The MCP server specified as the gateway target.

" - } - }, - "McpServerTargetConfigurationEndpointString": { - "base": null, - "refs": { - "McpServerTargetConfiguration$endpoint": "

The endpoint for the MCP server target configuration.

" - } - }, - "McpServerUrl": { - "base": null, - "refs": { - "FromUrlSynchronizationConfiguration$url": "

The HTTPS URL of the MCP server to synchronize from.

" - } - }, - "McpSupportedVersions": { - "base": null, - "refs": { - "MCPGatewayConfiguration$supportedVersions": "

The supported versions of the Model Context Protocol. This field specifies which versions of the protocol the gateway can use.

" - } - }, - "McpTargetConfiguration": { - "base": "

The Model Context Protocol (MCP) configuration for a target. This structure defines how the gateway uses MCP to communicate with the target.

", - "refs": { - "TargetConfiguration$mcp": "

The Model Context Protocol (MCP) configuration for the target. This configuration defines how the gateway uses MCP to communicate with the target.

" - } - }, - "McpToolSchemaConfiguration": { - "base": "

The MCP tool schema configuration for an MCP server target. The tool schema must be aligned with the MCP specification.

", - "refs": { - "McpServerTargetConfiguration$mcpToolSchema": "

The tool schema configuration for the MCP server target. Supported only when the credential provider is configured with an authorization code grant type. Dynamic tool discovery/synchronization will be disabled when target is configured with mcpToolSchema.

" - } - }, - "McpVersion": { - "base": null, - "refs": { - "McpSupportedVersions$member": null - } - }, - "Memory": { - "base": "

Contains information about a memory resource.

", - "refs": { - "CreateMemoryOutput$memory": "

The details of the created memory, including its ID, ARN, name, description, and configuration settings.

", - "GetMemoryOutput$memory": "

The retrieved AgentCore Memory resource details.

", - "UpdateMemoryOutput$memory": "

The updated AgentCore Memory resource details.

" - } - }, - "MemoryArn": { - "base": null, - "refs": { - "HarnessAgentCoreMemoryConfiguration$arn": "

The ARN of the AgentCore Memory resource.

", - "HarnessManagedMemoryConfiguration$arn": "

The ARN of the managed AgentCore Memory resource. Read-only on Get, ignored on Create/Update input.

", - "Memory$arn": "

The Amazon Resource Name (ARN) of the memory.

", - "MemorySummary$arn": "

The Amazon Resource Name (ARN) of the memory.

" - } - }, - "MemoryEventExpiryDurationInteger": { - "base": null, - "refs": { - "Memory$eventExpiryDuration": "

The number of days after which memory events will expire.

" - } - }, - "MemoryId": { - "base": null, - "refs": { - "DeleteMemoryInput$memoryId": "

The unique identifier of the memory to delete.

", - "DeleteMemoryOutput$memoryId": "

The unique identifier of the deleted AgentCore Memory resource.

", - "GetMemoryInput$memoryId": "

The unique identifier of the memory to retrieve.

", - "Memory$id": "

The unique identifier of the memory.

", - "MemorySummary$id": "

The unique identifier of the memory.

", - "UpdateMemoryInput$memoryId": "

The unique identifier of the memory to update.

" - } - }, - "MemoryRecordSchema": { - "base": "

Schema for metadata on memory records generated by a strategy.

", - "refs": { - "CustomMemoryStrategyInput$memoryRecordSchema": "

Schema for metadata fields on records generated by this strategy.

", - "EpisodicMemoryStrategyInput$memoryRecordSchema": "

Schema for metadata fields on records generated by this strategy.

", - "EpisodicOverrideReflectionConfigurationInput$memoryRecordSchema": "

Schema for metadata fields on records generated by this reflection override.

", - "EpisodicReflectionConfiguration$memoryRecordSchema": "

\"Schema for metadata fields on records generated by reflections.

", - "EpisodicReflectionConfigurationInput$memoryRecordSchema": "

Schema for metadata fields on records generated by reflections.

", - "EpisodicReflectionOverride$memoryRecordSchema": "

Schema for metadata fields on records generated by this reflection override.

", - "MemoryStrategy$memoryRecordSchema": "

Schema for metadata fields on records generated by this strategy.

", - "ModifyMemoryStrategyInput$memoryRecordSchema": "

Updated metadata schema for records generated by this strategy.

", - "SemanticMemoryStrategyInput$memoryRecordSchema": null, - "SummaryMemoryStrategyInput$memoryRecordSchema": "

Schema for metadata fields on records generated by this strategy.

", - "UserPreferenceMemoryStrategyInput$memoryRecordSchema": "

Schema for metadata fields on records generated by this strategy.

" - } - }, - "MemoryStatus": { - "base": null, - "refs": { - "DeleteMemoryOutput$status": "

The current status of the AgentCore Memory resource deletion.

", - "Memory$status": "

The current status of the memory.

", - "MemorySummary$status": "

The current status of the memory.

" - } - }, - "MemoryStrategy": { - "base": "

Contains information about a memory strategy.

", - "refs": { - "MemoryStrategyList$member": null - } - }, - "MemoryStrategyId": { - "base": null, - "refs": { - "MemoryStrategy$strategyId": "

The unique identifier of the memory strategy.

" - } - }, - "MemoryStrategyInput": { - "base": "

Contains input information for creating a memory strategy.

", - "refs": { - "MemoryStrategyInputList$member": null - } - }, - "MemoryStrategyInputList": { - "base": null, - "refs": { - "CreateMemoryInput$memoryStrategies": "

The memory strategies to use for this memory. Strategies define how information is extracted, processed, and consolidated.

", - "ModifyMemoryStrategies$addMemoryStrategies": "

The list of memory strategies to add.

" - } - }, - "MemoryStrategyList": { - "base": null, - "refs": { - "Memory$strategies": "

The list of memory strategies associated with this memory.

" - } - }, - "MemoryStrategyStatus": { - "base": null, - "refs": { - "MemoryStrategy$status": "

The current status of the memory strategy.

" - } - }, - "MemoryStrategyType": { - "base": null, - "refs": { - "MemoryStrategy$type": "

The type of the memory strategy.

" - } - }, - "MemorySummary": { - "base": "

Contains summary information about a memory resource.

", - "refs": { - "MemorySummaryList$member": null - } - }, - "MemorySummaryList": { - "base": null, - "refs": { - "ListMemoriesOutput$memories": "

The list of AgentCore Memory resource summaries.

" - } - }, - "MemoryView": { - "base": null, - "refs": { - "GetMemoryInput$view": "

The level of detail to return for the memory.

" - } - }, - "MessageBasedTrigger": { - "base": "

The trigger configuration based on a message.

", - "refs": { - "TriggerCondition$messageBasedTrigger": "

Message based trigger configuration.

" - } - }, - "MessageBasedTriggerInput": { - "base": "

The trigger configuration based on a message.

", - "refs": { - "TriggerConditionInput$messageBasedTrigger": "

Message based trigger configuration.

" - } - }, - "MessageBasedTriggerInputMessageCountInteger": { - "base": null, - "refs": { - "MessageBasedTriggerInput$messageCount": "

The number of messages that trigger memory processing.

" - } - }, - "MetadataConfiguration": { - "base": "

Configuration for HTTP header and query parameter propagation between the gateway and target servers.

", - "refs": { - "CreateGatewayTargetRequest$metadataConfiguration": "

Optional configuration for HTTP header and query parameter propagation to and from the gateway target.

", - "CreateGatewayTargetResponse$metadataConfiguration": "

The metadata configuration that was applied to the created gateway target.

", - "GatewayTarget$metadataConfiguration": "

The metadata configuration for HTTP header and query parameter propagation to and from this gateway target.

", - "GetGatewayTargetResponse$metadataConfiguration": "

The metadata configuration for HTTP header and query parameter propagation for the retrieved gateway target.

", - "UpdateGatewayTargetRequest$metadataConfiguration": "

Configuration for HTTP header and query parameter propagation to the gateway target.

", - "UpdateGatewayTargetResponse$metadataConfiguration": "

The metadata configuration that was applied to the gateway target.

" - } - }, - "MetadataKey": { - "base": null, - "refs": { - "IndexedKey$key": "

The metadata key name to index.

", - "MetadataSchemaEntry$key": "

The metadata field name. Must match an indexed key to be queryable via metadata filters.

" - } - }, - "MetadataSchemaEntry": { - "base": "

A metadata field definition within a strategy's schema.

", - "refs": { - "MetadataSchemaList$member": null - } - }, - "MetadataSchemaList": { - "base": null, - "refs": { - "MemoryRecordSchema$metadataSchema": "

The metadata field definitions for this strategy.

" - } - }, - "MetadataValueType": { - "base": null, - "refs": { - "IndexedKey$type": "

The data type of the indexed key.

", - "MetadataSchemaEntry$type": "

The MetadataValueType.

" - } - }, - "MicrosoftOauth2ProviderConfigInput": { - "base": "

Input configuration for a Microsoft OAuth2 provider.

", - "refs": { - "Oauth2ProviderConfigInput$microsoftOauth2ProviderConfig": "

The configuration for a Microsoft OAuth2 provider.

" - } - }, - "MicrosoftOauth2ProviderConfigOutput": { - "base": "

Output configuration for a Microsoft OAuth2 provider.

", - "refs": { - "Oauth2ProviderConfigOutput$microsoftOauth2ProviderConfig": "

The output configuration for a Microsoft OAuth2 provider.

" - } - }, - "ModelEntries": { - "base": null, - "refs": { - "InferenceOperationConfiguration$models": "

The list of models supported for this operation.

" - } - }, - "ModelEntry": { - "base": "

A model entry that specifies a model supported for an inference operation.

", - "refs": { - "ModelEntries$member": null - } - }, - "ModelId": { - "base": null, - "refs": { - "BedrockEvaluatorModelConfig$modelId": "

The identifier of the Amazon Bedrock model to use for evaluation. Must be a supported foundation model available in your region.

", - "HarnessBedrockModelConfig$modelId": "

The Bedrock model ID.

", - "HarnessGeminiModelConfig$modelId": "

The Gemini model ID.

", - "HarnessLiteLlmModelConfig$modelId": "

The LiteLLM model identifier (e.g., \"anthropic/claude-3-sonnet\").

", - "HarnessOpenAiModelConfig$modelId": "

The OpenAI model ID.

", - "OpenResponsesEvaluatorModelConfig$modelId": "

The identifier of the model to use for evaluation.

" - } - }, - "ModelMapping": { - "base": "

The configuration that translates model IDs between client-facing names and provider model IDs.

", - "refs": { - "InferenceProviderTargetConfiguration$modelMapping": "

The configuration that translates client-facing model IDs to the model IDs expected by the provider.

" - } - }, - "ModelPattern": { - "base": null, - "refs": { - "ModelEntry$model": "

The model ID or glob pattern that identifies the model (for example, anthropic.claude-opus-* or openai.gpt-oss-*).

" - } - }, - "ModifyConsolidationConfiguration": { - "base": "

Contains information for modifying a consolidation configuration.

", - "refs": { - "ModifyStrategyConfiguration$consolidation": "

The updated consolidation configuration.

" - } - }, - "ModifyExtractionConfiguration": { - "base": "

Contains information for modifying an extraction configuration.

", - "refs": { - "ModifyStrategyConfiguration$extraction": "

The updated extraction configuration.

" - } - }, - "ModifyInvocationConfigurationInput": { - "base": "

The configuration for updating invocation settings.

", - "refs": { - "ModifySelfManagedConfiguration$invocationConfiguration": "

The updated configuration to invoke self-managed memory processing pipeline.

" - } - }, - "ModifyInvocationConfigurationInputPayloadDeliveryBucketNameString": { - "base": null, - "refs": { - "ModifyInvocationConfigurationInput$payloadDeliveryBucketName": "

The updated S3 bucket name for event payload delivery.

" - } - }, - "ModifyMemoryStrategies": { - "base": "

Contains information for modifying memory strategies.

", - "refs": { - "UpdateMemoryInput$memoryStrategies": "

The memory strategies to add, modify, or delete.

" - } - }, - "ModifyMemoryStrategiesList": { - "base": null, - "refs": { - "ModifyMemoryStrategies$modifyMemoryStrategies": "

The list of memory strategies to modify.

" - } - }, - "ModifyMemoryStrategyInput": { - "base": "

Input for modifying a memory strategy.

", - "refs": { - "ModifyMemoryStrategiesList$member": null - } - }, - "ModifyReflectionConfiguration": { - "base": "

Contains information for modifying a reflection configuration.

", - "refs": { - "ModifyStrategyConfiguration$reflection": "

The updated reflection configuration.

" - } - }, - "ModifySelfManagedConfiguration": { - "base": "

The configuration for updating the self-managed memory strategy.

", - "refs": { - "ModifyStrategyConfiguration$selfManagedConfiguration": "

The updated self-managed configuration.

" - } - }, - "ModifySelfManagedConfigurationHistoricalContextWindowSizeInteger": { - "base": null, - "refs": { - "ModifySelfManagedConfiguration$historicalContextWindowSize": "

The updated number of historical messages to include in processing context.

" - } - }, - "ModifyStrategyConfiguration": { - "base": "

Contains information for modifying a strategy configuration.

", - "refs": { - "ModifyMemoryStrategyInput$configuration": "

The updated configuration for the memory strategy.

" - } - }, - "MountPath": { - "base": null, - "refs": { - "EfsAccessPointConfiguration$mountPath": "

The mount path for the EFS access point inside the AgentCore Runtime. The path must be under /mnt with exactly one subdirectory level (for example, /mnt/data).

", - "EfsConfiguration$mountPath": "

The absolute path within the session at which the access point is mounted, for example /mnt/efs. Each mount path must be unique across all file system configurations in the session.

", - "S3FilesAccessPointConfiguration$mountPath": "

The mount path for the S3 Files access point inside the AgentCore Runtime. The path must be under /mnt with exactly one subdirectory level (for example, /mnt/data).

", - "S3FilesConfiguration$mountPath": "

The absolute path within the session at which the access point is mounted, for example /mnt/s3data. Each mount path must be unique across all file system configurations in the session.

", - "SessionStorageConfiguration$mountPath": "

The mount path for the session storage filesystem inside the AgentCore Runtime. The path must be under /mnt with exactly one subdirectory level (for example, /mnt/data).

" - } - }, - "Name": { - "base": null, - "refs": { - "CreateMemoryInput$name": "

The name of the memory. The name must be unique within your account.

", - "CustomMemoryStrategyInput$name": "

The name of the custom memory strategy.

", - "EpisodicMemoryStrategyInput$name": "

The name of the episodic memory strategy.

", - "Memory$name": "

The name of the memory.

", - "MemoryStrategy$name": "

The name of the memory strategy.

", - "SemanticMemoryStrategyInput$name": "

The name of the semantic memory strategy.

", - "SummaryMemoryStrategyInput$name": "

The name of the summary memory strategy.

", - "UserPreferenceMemoryStrategyInput$name": "

The name of the user preference memory strategy.

" - } - }, - "Namespace": { - "base": null, - "refs": { - "NamespacesList$member": null - } - }, - "NamespacesList": { - "base": null, - "refs": { - "CustomMemoryStrategyInput$namespaces": "

This is a legacy parameter, use namespaceTemplates. The namespaces associated with the custom memory strategy.

", - "CustomMemoryStrategyInput$namespaceTemplates": "

The namespaceTemplates associated with the custom memory strategy.

", - "EpisodicMemoryStrategyInput$namespaces": "

This is a legacy parameter, use namespaceTemplates. The namespaces for which to create episodes.

", - "EpisodicMemoryStrategyInput$namespaceTemplates": "

The namespaceTemplates for which to create episodes.

", - "EpisodicOverrideReflectionConfigurationInput$namespaces": "

This is a legacy parameter, use namespaceTemplates. The namespaces to use for episodic reflection. Can be less nested than the episodic namespaces.

", - "EpisodicOverrideReflectionConfigurationInput$namespaceTemplates": "

The namespaceTemplates to use for episodic reflection. Can be less nested than the episodic namespaces.

", - "EpisodicReflectionConfiguration$namespaces": "

This is a legacy parameter, use namespaceTemplates. The namespaces for which to create reflections. Can be less nested than the episodic namespaces.

", - "EpisodicReflectionConfiguration$namespaceTemplates": "

The namespaceTemplates for which to create reflections. Can be less nested than the episodic namespaces.

", - "EpisodicReflectionConfigurationInput$namespaces": "

This is a legacy parameter, use namespaceTemplates. The namespaces over which to create reflections. Can be less nested than episode namespaces.

", - "EpisodicReflectionConfigurationInput$namespaceTemplates": "

The namespaceTemplates over which to create reflections. Can be less nested than episode namespaces.

", - "EpisodicReflectionOverride$namespaces": "

This is a legacy parameter. The namespaces over which reflections were created. Can be less nested than the episodic namespaces.

", - "EpisodicReflectionOverride$namespaceTemplates": "

The namespaceTemplates over which reflections were created. Can be less nested than the episodic namespaces.

", - "MemoryStrategy$namespaces": "

This is a legacy parameter. The namespaces associated with the memory strategy.

", - "MemoryStrategy$namespaceTemplates": "

The namespaceTemplates associated with the memory strategy.

", - "ModifyMemoryStrategyInput$namespaces": "

This is a legacy parameter, use namespaceTemplates. The updated namespaces for the memory strategy.

", - "ModifyMemoryStrategyInput$namespaceTemplates": "

The updated namespaceTemplates for the memory strategy.

", - "SemanticMemoryStrategyInput$namespaces": "

This is a legacy parameter, use namespaceTemplates. The namespaces associated with the semantic memory strategy.

", - "SemanticMemoryStrategyInput$namespaceTemplates": "

The namespaceTemplates associated with the semantic memory strategy.

", - "SummaryMemoryStrategyInput$namespaces": "

This is a legacy parameter, use namespaceTemplates. The namespaces associated with the summary memory strategy.

", - "SummaryMemoryStrategyInput$namespaceTemplates": "

The namespaceTemplates associated with the summary memory strategy.

", - "UserPreferenceMemoryStrategyInput$namespaces": "

This is a legacy parameter, use namespaceTemplates. The namespaces associated with the user preference memory strategy.

", - "UserPreferenceMemoryStrategyInput$namespaceTemplates": "

The namespaceTemplates associated with the user preference memory strategy.

" - } - }, - "NaturalLanguage": { - "base": null, - "refs": { - "Content$rawText": "

The raw text content containing natural language descriptions of desired policy behavior. This text is processed by AI to generate corresponding Cedar policy statements that match the described intent.

", - "PolicyGenerationAsset$rawTextFragment": "

The portion of the original natural language input that this generated policy asset addresses. This helps users understand which part of their policy description was translated into this specific Cedar policy statement, enabling better policy selection and refinement. When a single natural language input describes multiple authorization requirements, the generation process creates separate policy assets for each requirement, with each asset's rawTextFragment showing which requirement it addresses. Use this mapping to verify that all parts of your natural language input were correctly translated into Cedar policies.

" - } - }, - "NetworkConfiguration": { - "base": "

SecurityConfig for the Agent.

", - "refs": { - "CreateAgentRuntimeRequest$networkConfiguration": "

The network configuration for the AgentCore Runtime.

", - "GetAgentRuntimeResponse$networkConfiguration": "

The network configuration for the AgentCore Runtime.

", - "HarnessAgentCoreRuntimeEnvironment$networkConfiguration": null, - "HarnessAgentCoreRuntimeEnvironmentRequest$networkConfiguration": null, - "UpdateAgentRuntimeRequest$networkConfiguration": "

The updated network configuration for the AgentCore Runtime.

" - } - }, - "NetworkMode": { - "base": null, - "refs": { - "NetworkConfiguration$networkMode": "

The network mode for the AgentCore Runtime.

" - } - }, - "NextToken": { - "base": null, - "refs": { - "ListAgentRuntimeEndpointsRequest$nextToken": "

A token to retrieve the next page of results.

", - "ListAgentRuntimeEndpointsResponse$nextToken": "

A token to retrieve the next page of results.

", - "ListAgentRuntimeVersionsRequest$nextToken": "

A token to retrieve the next page of results.

", - "ListAgentRuntimeVersionsResponse$nextToken": "

A token to retrieve the next page of results.

", - "ListAgentRuntimesRequest$nextToken": "

A token to retrieve the next page of results.

", - "ListAgentRuntimesResponse$nextToken": "

A token to retrieve the next page of results.

", - "ListBrowserProfilesRequest$nextToken": "

A token to retrieve the next page of results.

", - "ListBrowserProfilesResponse$nextToken": "

A token to retrieve the next page of results.

", - "ListBrowsersRequest$nextToken": "

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

", - "ListBrowsersResponse$nextToken": "

A token to retrieve the next page of results.

", - "ListCodeInterpretersRequest$nextToken": "

A token to retrieve the next page of results.

", - "ListCodeInterpretersResponse$nextToken": "

A token to retrieve the next page of results.

", - "ListHarnessEndpointsRequest$nextToken": "

The token for the next set of results.

", - "ListHarnessEndpointsResponse$nextToken": "

The token for the next set of results.

", - "ListHarnessVersionsRequest$nextToken": "

The token for the next set of results.

", - "ListHarnessVersionsResponse$nextToken": "

The token for the next set of results.

", - "ListHarnessesRequest$nextToken": "

The token for the next set of results.

", - "ListHarnessesResponse$nextToken": "

The token for the next set of results.

", - "ListPaymentConnectorsRequest$nextToken": "

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.

", - "ListPaymentConnectorsResponse$nextToken": "

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.

", - "ListPaymentManagersRequest$nextToken": "

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.

", - "ListPaymentManagersResponse$nextToken": "

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.

", - "ListPoliciesRequest$nextToken": "

A pagination token returned from a previous ListPolicies call. Use this token to retrieve the next page of results when the response is paginated.

", - "ListPoliciesResponse$nextToken": "

A pagination token that can be used in subsequent ListPolicies calls to retrieve additional results. This token is only present when there are more results available.

", - "ListPolicyEngineSummariesRequest$nextToken": "

A pagination token returned from a previous ListPolicyEngineSummaries call. Use this token to retrieve the next page of results when the response is paginated.

", - "ListPolicyEngineSummariesResponse$nextToken": "

A pagination token that can be used in subsequent ListPolicyEngineSummaries calls to retrieve additional results. This token is only present when there are more results available.

", - "ListPolicyEnginesRequest$nextToken": "

A pagination token returned from a previous ListPolicyEngines call. Use this token to retrieve the next page of results when the response is paginated.

", - "ListPolicyEnginesResponse$nextToken": "

A pagination token that can be used in subsequent ListPolicyEngines calls to retrieve additional results. This token is only present when there are more results available.

", - "ListPolicyGenerationAssetsRequest$nextToken": "

A pagination token returned from a previous ListPolicyGenerationAssets call. Use this token to retrieve the next page of assets when the response is paginated due to large numbers of generated policy options.

", - "ListPolicyGenerationAssetsResponse$nextToken": "

A pagination token that can be used in subsequent ListPolicyGenerationAssets calls to retrieve additional assets. This token is only present when there are more generated policy assets available beyond the current response.

", - "ListPolicyGenerationSummariesRequest$nextToken": "

A pagination token returned from a previous ListPolicyGenerationSummaries call. Use this token to retrieve the next page of results when the response is paginated.

", - "ListPolicyGenerationSummariesResponse$nextToken": "

A pagination token that can be used in subsequent ListPolicyGenerationSummaries calls to retrieve additional results. This token is only present when there are more results available.

", - "ListPolicyGenerationsRequest$nextToken": "

A pagination token for retrieving additional policy generations when results are paginated.

", - "ListPolicyGenerationsResponse$nextToken": "

A pagination token for retrieving additional policy generations if more results are available.

", - "ListPolicySummariesRequest$nextToken": "

A pagination token returned from a previous ListPolicySummaries call. Use this token to retrieve the next page of results when the response is paginated.

", - "ListPolicySummariesResponse$nextToken": "

A pagination token that can be used in subsequent ListPolicySummaries calls to retrieve additional results. This token is only present when there are more results available.

", - "ListRegistriesRequest$nextToken": "

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.

", - "ListRegistriesResponse$nextToken": "

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.

", - "ListRegistryRecordsRequest$nextToken": "

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.

", - "ListRegistryRecordsResponse$nextToken": "

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.

" - } - }, - "NonBlankString": { - "base": null, - "refs": { - "AccessDeniedException$message": null, - "ConflictException$message": null, - "InternalServerException$message": null, - "ResourceNotFoundException$message": null, - "ServiceQuotaExceededException$message": null, - "ThrottlingException$message": null, - "UnauthorizedException$message": null - } - }, - "NonEmptyString": { - "base": null, - "refs": { - "InferenceConfigurationStopSequencesList$member": null - } - }, - "NumberValidation": { - "base": "

Validation for NUMBER fields.

", - "refs": { - "Validation$numberValidation": null - } - }, - "NumericalScaleDefinition": { - "base": "

The definition of a numerical rating scale option that provides a numeric value with its description for evaluation scoring.

", - "refs": { - "NumericalScaleDefinitions$member": null - } - }, - "NumericalScaleDefinitionLabelString": { - "base": null, - "refs": { - "NumericalScaleDefinition$label": "

The label or name that describes this numerical rating option.

" - } - }, - "NumericalScaleDefinitionValueDouble": { - "base": null, - "refs": { - "NumericalScaleDefinition$value": "

The numerical value for this rating scale option.

" - } - }, - "NumericalScaleDefinitions": { - "base": null, - "refs": { - "RatingScale$numerical": "

The numerical rating scale with defined score values and descriptions for quantitative evaluation.

" - } - }, - "OAuth2AuthorizationData": { - "base": "

OAuth2-specific authorization data, including the authorization URL and user identifier for the authorization session.

", - "refs": { - "AuthorizationData$oauth2": "

OAuth2 authorization data for the gateway target.

" - } - }, - "OAuth2AuthorizationDataAuthorizationUrlString": { - "base": null, - "refs": { - "OAuth2AuthorizationData$authorizationUrl": "

The URL to initiate the authorization process. This URL is provided when the OAuth2 access token requires user authorization.

" - } - }, - "OAuth2AuthorizationDataUserIdString": { - "base": null, - "refs": { - "OAuth2AuthorizationData$userId": "

The user identifier associated with the OAuth2 authorization session that is defined by AgentCore Gateway.

" - } - }, - "OAuthCredentialProvider": { - "base": "

An OAuth credential provider for gateway authentication. This structure contains the configuration for authenticating with the target endpoint using OAuth.

", - "refs": { - "CredentialProvider$oauthCredentialProvider": "

The OAuth credential provider. This provider uses OAuth authentication to access the target endpoint.

", - "HarnessGatewayOutboundAuth$oauth": "

Use OAuth credentials for outbound authentication to the gateway.

" - } - }, - "OAuthCredentialProviderArn": { - "base": null, - "refs": { - "OAuthCredentialProvider$providerArn": "

The Amazon Resource Name (ARN) of the OAuth credential provider. This ARN identifies the provider in Amazon Web Services.

" - } - }, - "OAuthCustomParameters": { - "base": null, - "refs": { - "OAuthCredentialProvider$customParameters": "

The custom parameters for the OAuth credential provider. These parameters provide additional configuration for the OAuth authentication process.

" - } - }, - "OAuthCustomParametersKey": { - "base": null, - "refs": { - "OAuthCustomParameters$key": null - } - }, - "OAuthCustomParametersValue": { - "base": null, - "refs": { - "OAuthCustomParameters$value": null - } - }, - "OAuthDefaultReturnUrl": { - "base": null, - "refs": { - "OAuthCredentialProvider$defaultReturnUrl": "

The URL where the end user's browser is redirected after obtaining the authorization code. Generally points to the customer's application.

" - } - }, - "OAuthGrantType": { - "base": null, - "refs": { - "OAuthCredentialProvider$grantType": "

Specifies the kind of credentials to use for authorization:

  • CLIENT_CREDENTIALS - Authorization with a client ID and secret.

  • AUTHORIZATION_CODE - Authorization with a token that is specific to an individual end user.

  • TOKEN_EXCHANGE - Authorization using on-behalf-of token exchange. An inbound user token is exchanged for a downstream access token scoped to the target audience.

" - } - }, - "OAuthScope": { - "base": null, - "refs": { - "OAuthScopes$member": null - } - }, - "OAuthScopes": { - "base": null, - "refs": { - "OAuthCredentialProvider$scopes": "

The OAuth scopes for the credential provider. These scopes define the level of access requested from the OAuth provider.

" - } - }, - "Oauth2AuthorizationServerMetadata": { - "base": "

Contains the authorization server metadata for an OAuth2 provider.

", - "refs": { - "Oauth2Discovery$authorizationServerMetadata": "

The authorization server metadata for the OAuth2 provider.

" - } - }, - "Oauth2CredentialProviderItem": { - "base": "

Contains information about an OAuth2 credential provider.

", - "refs": { - "Oauth2CredentialProviders$member": null - } - }, - "Oauth2CredentialProviders": { - "base": null, - "refs": { - "ListOauth2CredentialProvidersResponse$credentialProviders": "

The list of OAuth2 credential providers.

" - } - }, - "Oauth2Discovery": { - "base": "

Contains the discovery information for an OAuth2 provider.

", - "refs": { - "AtlassianOauth2ProviderConfigOutput$oauthDiscovery": null, - "CustomOauth2ProviderConfigInput$oauthDiscovery": "

The OAuth2 discovery information for the custom provider.

", - "CustomOauth2ProviderConfigOutput$oauthDiscovery": "

The OAuth2 discovery information for the custom provider.

", - "GithubOauth2ProviderConfigOutput$oauthDiscovery": "

The OAuth2 discovery information for the GitHub provider.

", - "GoogleOauth2ProviderConfigOutput$oauthDiscovery": "

The OAuth2 discovery information for the Google provider.

", - "IncludedOauth2ProviderConfigOutput$oauthDiscovery": null, - "LinkedinOauth2ProviderConfigOutput$oauthDiscovery": null, - "MicrosoftOauth2ProviderConfigOutput$oauthDiscovery": "

The OAuth2 discovery information for the Microsoft provider.

", - "SalesforceOauth2ProviderConfigOutput$oauthDiscovery": "

The OAuth2 discovery information for the Salesforce provider.

", - "SlackOauth2ProviderConfigOutput$oauthDiscovery": "

The OAuth2 discovery information for the Slack provider.

" - } - }, - "Oauth2ProviderConfigInput": { - "base": "

Contains the input configuration for an OAuth2 provider.

", - "refs": { - "CreateOauth2CredentialProviderRequest$oauth2ProviderConfigInput": "

The configuration settings for the OAuth2 provider, including client ID, client secret, and other vendor-specific settings.

", - "UpdateOauth2CredentialProviderRequest$oauth2ProviderConfigInput": "

The configuration input for the OAuth2 provider.

" - } - }, - "Oauth2ProviderConfigOutput": { - "base": "

Contains the output configuration for an OAuth2 provider.

", - "refs": { - "CreateOauth2CredentialProviderResponse$oauth2ProviderConfigOutput": null, - "GetOauth2CredentialProviderResponse$oauth2ProviderConfigOutput": "

The configuration output for the OAuth2 provider.

", - "UpdateOauth2CredentialProviderResponse$oauth2ProviderConfigOutput": "

The configuration output for the OAuth2 provider.

" - } - }, - "OnBehalfOfTokenExchangeConfigType": { - "base": "

Configuration for on-behalf-of token exchange.

", - "refs": { - "CustomOauth2ProviderConfigInput$onBehalfOfTokenExchangeConfig": "

The configuration for on-behalf-of token exchange. This enables authentication flows that use RFC 8693 token exchange or RFC 7523 JWT authorization grants.

", - "CustomOauth2ProviderConfigOutput$onBehalfOfTokenExchangeConfig": "

The configuration for on-behalf-of token exchange.

" - } - }, - "OnBehalfOfTokenExchangeGrantTypeType": { - "base": null, - "refs": { - "OnBehalfOfTokenExchangeConfigType$grantType": "

The grant type for the on-behalf-of token exchange.

" - } - }, - "OnlineEvaluationConfigArn": { - "base": null, - "refs": { - "CreateOnlineEvaluationConfigResponse$onlineEvaluationConfigArn": "

The Amazon Resource Name (ARN) of the created online evaluation configuration.

", - "DeleteOnlineEvaluationConfigResponse$onlineEvaluationConfigArn": "

The Amazon Resource Name (ARN) of the deleted online evaluation configuration.

", - "GetOnlineEvaluationConfigResponse$onlineEvaluationConfigArn": "

The Amazon Resource Name (ARN) of the online evaluation configuration.

", - "OnlineEvaluationConfigSummary$onlineEvaluationConfigArn": "

The Amazon Resource Name (ARN) of the online evaluation configuration.

", - "UpdateOnlineEvaluationConfigResponse$onlineEvaluationConfigArn": "

The Amazon Resource Name (ARN) of the updated online evaluation configuration.

" - } - }, - "OnlineEvaluationConfigId": { - "base": null, - "refs": { - "CreateOnlineEvaluationConfigResponse$onlineEvaluationConfigId": "

The unique identifier of the created online evaluation configuration.

", - "DeleteOnlineEvaluationConfigRequest$onlineEvaluationConfigId": "

The unique identifier of the online evaluation configuration to delete.

", - "DeleteOnlineEvaluationConfigResponse$onlineEvaluationConfigId": "

The unique identifier of the deleted online evaluation configuration.

", - "GetOnlineEvaluationConfigRequest$onlineEvaluationConfigId": "

The unique identifier of the online evaluation configuration to retrieve.

", - "GetOnlineEvaluationConfigResponse$onlineEvaluationConfigId": "

The unique identifier of the online evaluation configuration.

", - "OnlineEvaluationConfigSummary$onlineEvaluationConfigId": "

The unique identifier of the online evaluation configuration.

", - "UpdateOnlineEvaluationConfigRequest$onlineEvaluationConfigId": "

The unique identifier of the online evaluation configuration to update.

", - "UpdateOnlineEvaluationConfigResponse$onlineEvaluationConfigId": "

The unique identifier of the updated online evaluation configuration.

" - } - }, - "OnlineEvaluationConfigStatus": { - "base": null, - "refs": { - "CreateOnlineEvaluationConfigResponse$status": "

The status of the online evaluation configuration.

", - "DeleteOnlineEvaluationConfigResponse$status": "

The status of the online evaluation configuration deletion operation.

", - "GetOnlineEvaluationConfigResponse$status": "

The status of the online evaluation configuration.

", - "OnlineEvaluationConfigSummary$status": "

The status of the online evaluation configuration.

", - "UpdateOnlineEvaluationConfigResponse$status": "

The status of the online evaluation configuration.

" - } - }, - "OnlineEvaluationConfigSummary": { - "base": "

The summary information about an online evaluation configuration, including basic metadata and execution status.

", - "refs": { - "OnlineEvaluationConfigSummaryList$member": null - } - }, - "OnlineEvaluationConfigSummaryList": { - "base": null, - "refs": { - "ListOnlineEvaluationConfigsResponse$onlineEvaluationConfigs": "

The list of online evaluation configuration summaries containing basic information about each configuration.

" - } - }, - "OnlineEvaluationExecutionStatus": { - "base": null, - "refs": { - "CreateOnlineEvaluationConfigResponse$executionStatus": "

The execution status indicating whether the online evaluation is currently running.

", - "GetOnlineEvaluationConfigResponse$executionStatus": "

The execution status indicating whether the online evaluation is currently running.

", - "OnlineEvaluationConfigSummary$executionStatus": "

The execution status indicating whether the online evaluation is currently running.

", - "UpdateOnlineEvaluationConfigRequest$executionStatus": "

The updated execution status to enable or disable the online evaluation.

", - "UpdateOnlineEvaluationConfigResponse$executionStatus": "

The execution status indicating whether the online evaluation is currently running.

" - } - }, - "OpenResponsesEvaluatorModelConfig": { - "base": "

The configuration for using models served through the OpenResponses API in evaluator assessments, including model selection and inference parameters.

", - "refs": { - "EvaluatorModelConfig$responsesEvaluatorModelConfig": "

The OpenResponses model configuration for evaluation.

" - } - }, - "OpenResponsesEvaluatorModelConfigMaxOutputTokensInteger": { - "base": null, - "refs": { - "OpenResponsesEvaluatorModelConfig$maxOutputTokens": "

The maximum number of tokens to generate in the model response, including visible output and reasoning tokens.

" - } - }, - "OpenResponsesEvaluatorModelConfigTemperatureFloat": { - "base": null, - "refs": { - "OpenResponsesEvaluatorModelConfig$temperature": "

The temperature value that controls randomness in the model's responses. Lower values produce more deterministic outputs.

" - } - }, - "OpenResponsesEvaluatorModelConfigTopPFloat": { - "base": null, - "refs": { - "OpenResponsesEvaluatorModelConfig$topP": "

The top-p sampling parameter that controls the diversity of the model's responses by limiting the cumulative probability of token choices.

" - } - }, - "OutputConfig": { - "base": "

The configuration that specifies where evaluation results should be written for monitoring and analysis.

", - "refs": { - "CreateOnlineEvaluationConfigResponse$outputConfig": null, - "GetOnlineEvaluationConfigResponse$outputConfig": "

The output configuration specifying where evaluation results are written.

" - } - }, - "OverrideType": { - "base": null, - "refs": { - "StrategyConfiguration$type": "

The type of override for the strategy configuration.

" - } - }, - "PassthroughEndpoint": { - "base": null, - "refs": { - "InferenceProviderTargetConfiguration$endpoint": "

The HTTPS endpoint of the inference provider that the gateway forwards requests to.

", - "PassthroughTargetConfiguration$endpoint": "

The HTTPS endpoint that the gateway forwards requests to for this passthrough target.

" - } - }, - "PassthroughProtocolType": { - "base": null, - "refs": { - "PassthroughTargetConfiguration$protocolType": "

The application protocol that the passthrough target implements. This value is required for passthrough targets:

  • MCP - The Model Context Protocol.

  • A2A - The Agent-to-Agent protocol.

  • INFERENCE - The protocol for routing requests to a large language model (LLM) provider.

  • CUSTOM - A custom application protocol.

" - } - }, - "PassthroughTargetConfiguration": { - "base": "

The configuration for an HTTP passthrough target. A passthrough target forwards requests directly to an external HTTP endpoint.

", - "refs": { - "HttpTargetConfiguration$passthrough": "

The passthrough configuration for the HTTP target. A passthrough target forwards requests directly to an external HTTP endpoint.

" - } - }, - "PaymentConnectorId": { - "base": null, - "refs": { - "CreatePaymentConnectorResponse$paymentConnectorId": "

The unique identifier of the created payment connector.

", - "DeletePaymentConnectorRequest$paymentConnectorId": "

The unique identifier of the payment connector to delete.

", - "DeletePaymentConnectorResponse$paymentConnectorId": "

The unique identifier of the deleted payment connector.

", - "GetPaymentConnectorRequest$paymentConnectorId": "

The unique identifier of the payment connector to retrieve.

", - "GetPaymentConnectorResponse$paymentConnectorId": "

The unique identifier of the payment connector.

", - "PaymentConnectorSummary$paymentConnectorId": "

The unique identifier of the payment connector.

", - "UpdatePaymentConnectorRequest$paymentConnectorId": "

The unique identifier of the payment connector to update.

", - "UpdatePaymentConnectorResponse$paymentConnectorId": "

The unique identifier of the updated payment connector.

" - } - }, - "PaymentConnectorName": { - "base": null, - "refs": { - "CreatePaymentConnectorRequest$name": "

The name of the payment connector.

", - "CreatePaymentConnectorResponse$name": "

The name of the created payment connector.

", - "GetPaymentConnectorResponse$name": "

The name of the payment connector.

", - "PaymentConnectorSummary$name": "

The name of the payment connector.

", - "UpdatePaymentConnectorResponse$name": "

The name of the updated payment connector.

" - } - }, - "PaymentConnectorStatus": { - "base": null, - "refs": { - "CreatePaymentConnectorResponse$status": "

The current status of the payment connector. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.

", - "DeletePaymentConnectorResponse$status": "

The current status of the payment connector, set to DELETING when deletion is initiated. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.

", - "GetPaymentConnectorResponse$status": "

The current status of the payment connector. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.

", - "PaymentConnectorSummary$status": "

The current status of the payment connector. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.

", - "UpdatePaymentConnectorResponse$status": "

The current status of the updated payment connector. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.

" - } - }, - "PaymentConnectorSummaries": { - "base": null, - "refs": { - "ListPaymentConnectorsResponse$paymentConnectors": "

The list of payment connector summaries. For details about the fields in each summary, see the PaymentConnectorSummary data type.

" - } - }, - "PaymentConnectorSummary": { - "base": "

Contains summary information about a payment connector.

", - "refs": { - "PaymentConnectorSummaries$member": null - } - }, - "PaymentConnectorType": { - "base": null, - "refs": { - "CreatePaymentConnectorRequest$type": "

The type of payment connector, which determines the payment provider integration.

", - "CreatePaymentConnectorResponse$type": "

The type of the created payment connector.

", - "GetPaymentConnectorResponse$type": "

The type of the payment connector, which determines the payment provider integration.

", - "PaymentConnectorSummary$type": "

The type of the payment connector, which determines the payment provider integration.

", - "UpdatePaymentConnectorRequest$type": "

The updated type of the payment connector.

", - "UpdatePaymentConnectorResponse$type": "

The type of the updated payment connector.

" - } - }, - "PaymentCredentialProviderArn": { - "base": null, - "refs": { - "PaymentCredentialProviderConfiguration$credentialProviderArn": "

The Amazon Resource Name (ARN) of the credential provider that stores the authentication credentials for the payment provider.

" - } - }, - "PaymentCredentialProviderArnType": { - "base": null, - "refs": { - "CreatePaymentCredentialProviderResponse$credentialProviderArn": "

The Amazon Resource Name (ARN) of the created payment credential provider.

", - "GetPaymentCredentialProviderResponse$credentialProviderArn": "

The Amazon Resource Name (ARN) of the payment credential provider.

", - "PaymentCredentialProviderItem$credentialProviderArn": "

The Amazon Resource Name (ARN) of the payment credential provider.

", - "UpdatePaymentCredentialProviderResponse$credentialProviderArn": "

The Amazon Resource Name (ARN) of the updated payment credential provider.

" - } - }, - "PaymentCredentialProviderConfiguration": { - "base": "

Configuration for a payment credential provider that stores authentication credentials for a payment provider.

", - "refs": { - "CredentialsProviderConfiguration$coinbaseCDP": "

The credential provider configuration for a Coinbase CDP payment connector.

", - "CredentialsProviderConfiguration$stripePrivy": "

The credential provider configuration for a Stripe Privy payment connector.

" - } - }, - "PaymentCredentialProviderItem": { - "base": "

Contains summary information about a payment credential provider.

", - "refs": { - "PaymentCredentialProviders$member": null - } - }, - "PaymentCredentialProviderVendorType": { - "base": "

Supported vendor types for payment providers using non-standard auth protocols.

", - "refs": { - "CreatePaymentCredentialProviderRequest$credentialProviderVendor": "

The vendor type for the payment credential provider (e.g., CoinbaseCDP, StripePrivy).

", - "CreatePaymentCredentialProviderResponse$credentialProviderVendor": "

The vendor type for the created payment credential provider.

", - "GetPaymentCredentialProviderResponse$credentialProviderVendor": "

The vendor type for the payment credential provider.

", - "PaymentCredentialProviderItem$credentialProviderVendor": "

The vendor type for the payment credential provider.

", - "UpdatePaymentCredentialProviderRequest$credentialProviderVendor": "

The vendor type for the payment credential provider (e.g., CoinbaseCDP, StripePrivy).

", - "UpdatePaymentCredentialProviderResponse$credentialProviderVendor": "

The vendor type for the updated payment credential provider.

" - } - }, - "PaymentCredentialProviders": { - "base": null, - "refs": { - "ListPaymentCredentialProvidersResponse$credentialProviders": "

The list of payment credential providers.

" - } - }, - "PaymentManagerArn": { - "base": null, - "refs": { - "CreatePaymentManagerResponse$paymentManagerArn": "

The Amazon Resource Name (ARN) of the created payment manager.

", - "GetPaymentManagerResponse$paymentManagerArn": "

The Amazon Resource Name (ARN) of the payment manager.

", - "PaymentManagerSummary$paymentManagerArn": "

The Amazon Resource Name (ARN) of the payment manager.

", - "UpdatePaymentManagerResponse$paymentManagerArn": "

The Amazon Resource Name (ARN) of the updated payment manager.

" - } - }, - "PaymentManagerId": { - "base": null, - "refs": { - "CreatePaymentConnectorRequest$paymentManagerId": "

The unique identifier of the payment manager to create the connector for.

", - "CreatePaymentConnectorResponse$paymentManagerId": "

The unique identifier of the parent payment manager.

", - "CreatePaymentManagerResponse$paymentManagerId": "

The unique identifier of the created payment manager.

", - "DeletePaymentConnectorRequest$paymentManagerId": "

The unique identifier of the parent payment manager.

", - "DeletePaymentManagerRequest$paymentManagerId": "

The unique identifier of the payment manager to delete.

", - "DeletePaymentManagerResponse$paymentManagerId": "

The unique identifier of the deleted payment manager.

", - "GetPaymentConnectorRequest$paymentManagerId": "

The unique identifier of the parent payment manager.

", - "GetPaymentManagerRequest$paymentManagerId": "

The unique identifier of the payment manager to retrieve.

", - "GetPaymentManagerResponse$paymentManagerId": "

The unique identifier of the payment manager.

", - "ListPaymentConnectorsRequest$paymentManagerId": "

The unique identifier of the payment manager whose connectors to list.

", - "PaymentManagerSummary$paymentManagerId": "

The unique identifier of the payment manager.

", - "UpdatePaymentConnectorRequest$paymentManagerId": "

The unique identifier of the parent payment manager.

", - "UpdatePaymentConnectorResponse$paymentManagerId": "

The unique identifier of the parent payment manager.

", - "UpdatePaymentManagerRequest$paymentManagerId": "

The unique identifier of the payment manager to update.

", - "UpdatePaymentManagerResponse$paymentManagerId": "

The unique identifier of the updated payment manager.

" - } - }, - "PaymentManagerName": { - "base": null, - "refs": { - "CreatePaymentManagerRequest$name": "

The name of the payment manager.

", - "CreatePaymentManagerResponse$name": "

The name of the created payment manager.

", - "GetPaymentManagerResponse$name": "

The name of the payment manager.

", - "PaymentManagerSummary$name": "

The name of the payment manager.

", - "UpdatePaymentManagerResponse$name": "

The name of the updated payment manager.

" - } - }, - "PaymentManagerStatus": { - "base": null, - "refs": { - "CreatePaymentManagerResponse$status": "

The current status of the payment manager. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.

", - "DeletePaymentManagerResponse$status": "

The current status of the payment manager, set to DELETING when deletion is initiated. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.

", - "GetPaymentManagerResponse$status": "

The current status of the payment manager. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.

", - "PaymentManagerSummary$status": "

The current status of the payment manager. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.

", - "UpdatePaymentManagerResponse$status": "

The current status of the updated payment manager. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.

" - } - }, - "PaymentManagerSummaries": { - "base": null, - "refs": { - "ListPaymentManagersResponse$paymentManagers": "

The list of payment manager summaries. For details about the fields in each summary, see the PaymentManagerSummary data type.

" - } - }, - "PaymentManagerSummary": { - "base": "

Contains summary information about a payment manager.

", - "refs": { - "PaymentManagerSummaries$member": null - } - }, - "PaymentProviderConfigurationInput": { - "base": "

Provider configuration input — contains secrets for creation and update. Varies by vendor type.

", - "refs": { - "CreatePaymentCredentialProviderRequest$providerConfigurationInput": "

Configuration specific to the vendor, including API credentials.

", - "UpdatePaymentCredentialProviderRequest$providerConfigurationInput": "

Configuration specific to the vendor, including API credentials.

" - } - }, - "PaymentProviderConfigurationOutput": { - "base": "

Provider configuration output — no raw secrets, only ARNs. Varies by vendor type.

", - "refs": { - "CreatePaymentCredentialProviderResponse$providerConfigurationOutput": "

Output configuration (contains secret ARNs, excludes actual secret values).

", - "GetPaymentCredentialProviderResponse$providerConfigurationOutput": "

Output configuration (contains secret ARNs, excludes actual secret values).

", - "UpdatePaymentCredentialProviderResponse$providerConfigurationOutput": "

Output configuration (contains secret ARNs, excludes actual secret values).

" - } - }, - "PaymentsAuthorizerType": { - "base": null, - "refs": { - "CreatePaymentManagerRequest$authorizerType": "

The type of authorizer to use for the payment manager.

  • CUSTOM_JWT - Authorize with a bearer token.

  • AWS_IAM - Authorize with your Amazon Web Services IAM credentials.

", - "CreatePaymentManagerResponse$authorizerType": "

The type of authorizer for the created payment manager.

", - "GetPaymentManagerResponse$authorizerType": "

The type of authorizer used by the payment manager.

  • CUSTOM_JWT - Authorize with a bearer token.

  • AWS_IAM - Authorize with your Amazon Web Services IAM credentials.

", - "PaymentManagerSummary$authorizerType": "

The type of authorizer used by the payment manager.

  • CUSTOM_JWT - Authorize with a bearer token.

  • AWS_IAM - Authorize with your Amazon Web Services IAM credentials.

", - "UpdatePaymentManagerRequest$authorizerType": "

The updated authorizer type for the payment manager.

", - "UpdatePaymentManagerResponse$authorizerType": "

The type of authorizer for the updated payment manager.

" - } - }, - "PaymentsDescription": { - "base": null, - "refs": { - "CreatePaymentConnectorRequest$description": "

A description of the payment connector.

", - "CreatePaymentManagerRequest$description": "

A description of the payment manager.

", - "GetPaymentConnectorResponse$description": "

The description of the payment connector.

", - "GetPaymentManagerResponse$description": "

The description of the payment manager.

", - "PaymentManagerSummary$description": "

The description of the payment manager.

", - "UpdatePaymentConnectorRequest$description": "

The updated description of the payment connector.

", - "UpdatePaymentManagerRequest$description": "

The updated description of the payment manager.

" - } - }, - "Policies": { - "base": null, - "refs": { - "ListPoliciesResponse$policies": "

An array of policy objects that match the specified criteria. Each policy object contains the policy metadata, status, and key identifiers for further operations.

" - } - }, - "Policy": { - "base": "

Represents a complete policy resource within the AgentCore Policy system. Policies are ARN-able resources that contain Cedar policy statements and associated metadata for controlling agent behavior and access decisions. Each policy belongs to a policy engine and defines fine-grained authorization rules that are evaluated in real-time as agents interact with tools through Gateway. Policies use the Cedar policy language to specify who (principals based on OAuth claims like username, role, or scope) can perform what actions (tool calls) on which resources (Gateways), with optional conditions for attribute-based access control. Multiple policies can apply to a single request, with Cedar's forbid-wins semantics ensuring that security restrictions are never accidentally overridden.

", - "refs": { - "Policies$member": null - } - }, - "PolicyArn": { - "base": null, - "refs": { - "CreatePolicyResponse$policyArn": "

The Amazon Resource Name (ARN) of the created policy. This globally unique identifier can be used for cross-service references and IAM policy statements.

", - "DeletePolicyResponse$policyArn": "

The Amazon Resource Name (ARN) of the deleted policy. This globally unique identifier confirms which policy resource was successfully removed.

", - "GetPolicyResponse$policyArn": "

The Amazon Resource Name (ARN) of the policy. This globally unique identifier can be used for cross-service references and IAM policy statements.

", - "GetPolicySummaryResponse$policyArn": "

The Amazon Resource Name (ARN) of the policy.

", - "Policy$policyArn": "

The Amazon Resource Name (ARN) of the policy. This globally unique identifier can be used for cross-service references and IAM policy statements.

", - "PolicySummary$policyArn": "

The Amazon Resource Name (ARN) of the policy.

", - "UpdatePolicyResponse$policyArn": "

The ARN of the updated policy.

" - } - }, - "PolicyDefinition": { - "base": "

Represents the definition structure for policies within the AgentCore Policy system. This structure encapsulates different policy formats and languages that can be used to define access control rules.

", - "refs": { - "CreatePolicyRequest$definition": "

The Cedar policy statement that defines the access control rules. This contains the actual policy logic written in Cedar policy language, specifying effect (permit or forbid), principals, actions, resources, and conditions for agent behavior control.

", - "CreatePolicyResponse$definition": "

The Cedar policy statement that was created. This is the validated policy definition that will be used for agent behavior control and access decisions.

", - "DeletePolicyResponse$definition": null, - "GetPolicyResponse$definition": "

The Cedar policy statement that defines the access control rules. This contains the actual policy logic used for agent behavior control and access decisions.

", - "Policy$definition": "

The Cedar policy statement that defines the access control rules. This contains the actual policy logic used for agent behavior control and access decisions.

", - "PolicyGenerationAsset$definition": null, - "UpdatePolicyRequest$definition": "

The new Cedar policy statement that defines the access control rules. This replaces the existing policy definition with new logic while maintaining the policy's identity.

", - "UpdatePolicyResponse$definition": "

The updated Cedar policy statement.

" - } - }, - "PolicyEngine": { - "base": "

Represents a policy engine resource within the AgentCore Policy system. Policy engines serve as containers for grouping related policies and provide the execution context for policy evaluation and management. Each policy engine can be associated with one Gateway (one engine per Gateway), where it intercepts all agent tool calls and evaluates them against the contained policies before allowing tools to execute. The policy engine maintains the Cedar schema generated from the Gateway's tool manifest, ensuring that policies are validated against the actual tools and parameters available. Policy engines support two enforcement modes that can be configured when associating with a Gateway: log-only mode for testing (evaluates decisions without blocking) and enforce mode for production (actively allows or denies based on policy evaluation).

", - "refs": { - "PolicyEngines$member": null - } - }, - "PolicyEngineArn": { - "base": null, - "refs": { - "CreatePolicyEngineResponse$policyEngineArn": "

The Amazon Resource Name (ARN) of the created policy engine. This globally unique identifier can be used for cross-service references and IAM policy statements.

", - "DeletePolicyEngineResponse$policyEngineArn": "

The Amazon Resource Name (ARN) of the deleted policy engine. This globally unique identifier confirms which policy engine resource was successfully removed.

", - "GetPolicyEngineResponse$policyEngineArn": "

The Amazon Resource Name (ARN) of the policy engine. This globally unique identifier can be used for cross-service references and IAM policy statements.

", - "GetPolicyEngineSummaryResponse$policyEngineArn": "

The Amazon Resource Name (ARN) of the policy engine.

", - "PolicyEngine$policyEngineArn": "

The Amazon Resource Name (ARN) of the policy engine. This globally unique identifier can be used for cross-service references and IAM policy statements.

", - "PolicyEngineSummary$policyEngineArn": "

The Amazon Resource Name (ARN) of the policy engine.

", - "UpdatePolicyEngineResponse$policyEngineArn": "

The ARN of the updated policy engine.

" - } - }, - "PolicyEngineName": { - "base": null, - "refs": { - "CreatePolicyEngineRequest$name": "

The customer-assigned immutable name for the policy engine. This name identifies the policy engine and cannot be changed after creation.

", - "CreatePolicyEngineResponse$name": "

The customer-assigned name of the created policy engine. This matches the name provided in the request and serves as the human-readable identifier.

", - "DeletePolicyEngineResponse$name": "

The customer-assigned name of the deleted policy engine.

", - "GetPolicyEngineResponse$name": "

The customer-assigned name of the policy engine. This is the human-readable identifier that was specified when the policy engine was created.

", - "GetPolicyEngineSummaryResponse$name": "

The customer-assigned name of the policy engine.

", - "PolicyEngine$name": "

The customer-assigned immutable name for the policy engine. This human-readable identifier must be unique within the account and cannot exceed 48 characters.

", - "PolicyEngineSummary$name": "

The customer-assigned name of the policy engine.

", - "UpdatePolicyEngineResponse$name": "

The name of the updated policy engine.

" - } - }, - "PolicyEngineStatus": { - "base": null, - "refs": { - "CreatePolicyEngineResponse$status": "

The current status of the policy engine. A status of ACTIVE indicates the policy engine is ready for use.

", - "DeletePolicyEngineResponse$status": "

The status of the policy engine deletion operation. This provides status about any issues that occurred during the deletion process.

", - "GetPolicyEngineResponse$status": "

The current status of the policy engine.

", - "GetPolicyEngineSummaryResponse$status": "

The current status of the policy engine.

", - "PolicyEngine$status": "

The current status of the policy engine.

", - "PolicyEngineSummary$status": "

The current status of the policy engine.

", - "UpdatePolicyEngineResponse$status": "

The current status of the updated policy engine.

" - } - }, - "PolicyEngineSummary": { - "base": "

Represents a metadata-only summary of a policy engine resource. This structure contains resource identifiers, status, and timestamps without customer-encrypted fields such as description or status reasons. Policy engine summaries are returned by operations that do not require access to the customer's KMS key.

", - "refs": { - "PolicyEngineSummaryList$member": null - } - }, - "PolicyEngineSummaryList": { - "base": null, - "refs": { - "ListPolicyEngineSummariesResponse$policyEngines": "

An array of policy engine summary objects that exist in the account. Each summary contains resource identifiers, status, and timestamps without customer-encrypted content.

" - } - }, - "PolicyEngines": { - "base": null, - "refs": { - "ListPolicyEnginesResponse$policyEngines": "

An array of policy engine objects that exist in the account. Each policy engine object contains the engine metadata, status, and key identifiers for further operations.

" - } - }, - "PolicyGeneration": { - "base": "

Represents a policy generation request within the AgentCore Policy system. Tracks the AI-powered conversion of natural language descriptions into Cedar policy statements, enabling users to author policies by describing authorization requirements in plain English. The generation process analyzes the natural language input along with the Gateway's tool context and Cedar schema to produce one or more validated policy options. Each generation request tracks the status of the conversion process and maintains findings about the generated policies, including validation results and potential issues. Generated policy assets remain available for one week after successful generation, allowing time to review and create policies from the generated options.

", - "refs": { - "PolicyGenerations$member": null - } - }, - "PolicyGenerationArn": { - "base": null, - "refs": { - "GetPolicyGenerationResponse$policyGenerationArn": "

The Amazon Resource Name (ARN) of the policy generation. This globally unique identifier can be used for tracking, auditing, and cross-service references.

", - "GetPolicyGenerationSummaryResponse$policyGenerationArn": "

The Amazon Resource Name (ARN) of the policy generation request.

", - "PolicyGeneration$policyGenerationArn": "

The ARN of this policy generation request.

", - "PolicyGenerationSummary$policyGenerationArn": "

The ARN of this policy generation request.

", - "StartPolicyGenerationResponse$policyGenerationArn": "

The ARN of the created policy generation request.

" - } - }, - "PolicyGenerationAsset": { - "base": "

Represents a generated policy asset from the AI-powered policy generation process within the AgentCore Policy system. Each asset contains a Cedar policy statement generated from natural language input, along with associated metadata and analysis findings to help users evaluate and select the most appropriate policy option.

", - "refs": { - "PolicyGenerationAssets$member": null - } - }, - "PolicyGenerationAssets": { - "base": null, - "refs": { - "ListPolicyGenerationAssetsResponse$policyGenerationAssets": "

An array of generated policy assets including Cedar policies and related artifacts from the AI-powered policy generation process. Each asset represents a different policy option or variation generated from the original natural language input.

" - } - }, - "PolicyGenerationDetails": { - "base": "

Represents the information identifying a generated policy asset from the AI-powered policy generation process within the AgentCore Policy system. Each asset contains a Cedar policy statement generated from natural language input, along with associated metadata and analysis findings to help users evaluate and select the most appropriate policy option.

", - "refs": { - "PolicyDefinition$policyGeneration": "

The generated policy asset information within the policy definition structure. This contains information identifying a generated policy asset from the AI-powered policy generation process within the AgentCore Policy system. Each asset contains a Cedar policy statement generated from natural language input, along with associated metadata and analysis findings to help users evaluate and select the most appropriate policy option.

" - } - }, - "PolicyGenerationName": { - "base": null, - "refs": { - "GetPolicyGenerationResponse$name": "

The customer-assigned name for the policy generation request. This helps identify and track generation operations across multiple requests.

", - "GetPolicyGenerationSummaryResponse$name": "

The customer-assigned name for the policy generation request.

", - "PolicyGeneration$name": "

The customer-assigned name for this policy generation request.

", - "PolicyGenerationSummary$name": "

The customer-assigned name for this policy generation request.

", - "StartPolicyGenerationRequest$name": "

A customer-assigned name for the policy generation request. This helps track and identify generation operations, especially when running multiple generations simultaneously.

", - "StartPolicyGenerationResponse$name": "

The customer-assigned name for the policy generation request.

" - } - }, - "PolicyGenerationStatus": { - "base": null, - "refs": { - "GetPolicyGenerationResponse$status": "

The current status of the policy generation. This indicates whether the generation is in progress, completed successfully, or failed during processing.

", - "GetPolicyGenerationSummaryResponse$status": "

The current status of the policy generation request.

", - "PolicyGeneration$status": "

The current status of this policy generation request.

", - "PolicyGenerationSummary$status": "

The current status of this policy generation request.

", - "StartPolicyGenerationResponse$status": "

The initial status of the policy generation request.

" - } - }, - "PolicyGenerationSummary": { - "base": "

Represents a metadata-only summary of a policy generation resource. This structure contains resource identifiers, status, timestamps, and findings without customer-encrypted fields such as status reasons. Policy generation summaries are returned by operations that do not require access to the customer's KMS key.

", - "refs": { - "PolicyGenerationSummaryList$member": null - } - }, - "PolicyGenerationSummaryList": { - "base": null, - "refs": { - "ListPolicyGenerationSummariesResponse$policyGenerations": "

An array of policy generation summary objects that match the specified criteria. Each summary contains resource identifiers, status, timestamps, and findings without customer-encrypted content.

" - } - }, - "PolicyGenerations": { - "base": null, - "refs": { - "ListPolicyGenerationsResponse$policyGenerations": "

An array of policy generation objects that match the specified criteria.

" - } - }, - "PolicyName": { - "base": null, - "refs": { - "CreatePolicyRequest$name": "

The customer-assigned immutable name for the policy. Must be unique within the account. This name is used for policy identification and cannot be changed after creation.

", - "CreatePolicyResponse$name": "

The customer-assigned name of the created policy. This matches the name provided in the request and serves as the human-readable identifier for the policy.

", - "DeletePolicyResponse$name": "

The customer-assigned name of the deleted policy. This confirms which policy was successfully removed from the system and matches the name that was originally assigned during policy creation.

", - "GetPolicyResponse$name": "

The customer-assigned name of the policy. This is the human-readable identifier that was specified when the policy was created.

", - "GetPolicySummaryResponse$name": "

The customer-assigned name of the policy.

", - "Policy$name": "

The customer-assigned immutable name for the policy. This human-readable identifier must be unique within the account and cannot exceed 48 characters.

", - "PolicySummary$name": "

The customer-assigned name of the policy.

", - "UpdatePolicyResponse$name": "

The name of the updated policy.

" - } - }, - "PolicyStatement": { - "base": "

An AgentCore policy statement, which supports plain Cedar policies as well as guardrails definitions.

", - "refs": { - "PolicyDefinition$policy": "

An AgentCore policy statement that defines the access control rules. The statement can be a Cedar policy or a guardrails definition.

" - } - }, - "PolicyStatus": { - "base": null, - "refs": { - "CreatePolicyResponse$status": "

The current status of the policy. A status of ACTIVE indicates the policy is ready for use.

", - "DeletePolicyResponse$status": "

The status of the policy deletion operation. This provides information about any issues that occurred during the deletion process.

", - "GetPolicyResponse$status": "

The current status of the policy.

", - "GetPolicySummaryResponse$status": "

The current status of the policy.

", - "Policy$status": "

The current status of the policy.

", - "PolicySummary$status": "

The current status of the policy.

", - "UpdatePolicyResponse$status": "

The current status of the updated policy.

" - } - }, - "PolicyStatusReasons": { - "base": null, - "refs": { - "CreatePolicyEngineResponse$statusReasons": "

Additional information about the policy engine status. This provides details about any failures or the current state of the policy engine creation process.

", - "CreatePolicyResponse$statusReasons": "

Additional information about the policy status. This provides details about any failures or the current state of the policy creation process.

", - "DeletePolicyEngineResponse$statusReasons": "

Additional information about the deletion status. This provides details about the deletion process or any issues that may have occurred.

", - "DeletePolicyResponse$statusReasons": "

Additional information about the deletion status. This provides details about the deletion process or any issues that may have occurred.

", - "GetPolicyEngineResponse$statusReasons": "

Additional information about the policy engine status. This provides details about any failures or the current state of the policy engine.

", - "GetPolicyGenerationResponse$statusReasons": "

Additional information about the generation status. This provides details about any failures, warnings, or the current state of the generation process.

", - "GetPolicyResponse$statusReasons": "

Additional information about the policy status. This provides details about any failures or the current state of the policy.

", - "Policy$statusReasons": "

Additional information about the policy status. This provides details about any failures or the current state of the policy lifecycle.

", - "PolicyEngine$statusReasons": "

Additional information about the policy engine status. This provides details about any failures or the current state of the policy engine lifecycle.

", - "PolicyGeneration$statusReasons": "

Additional information about the generation status.

", - "StartPolicyGenerationResponse$statusReasons": "

Additional information about the generation status.

", - "UpdatePolicyEngineResponse$statusReasons": "

Additional information about the update status.

", - "UpdatePolicyResponse$statusReasons": "

Additional information about the update status.

" - } - }, - "PolicySummary": { - "base": "

Represents a metadata-only summary of a policy resource. This structure contains resource identifiers, status, and timestamps without customer-encrypted fields such as definition, description, or status reasons. Policy summaries are returned by operations that do not require access to the customer's KMS key.

", - "refs": { - "PolicySummaryList$member": null - } - }, - "PolicySummaryList": { - "base": null, - "refs": { - "ListPolicySummariesResponse$policies": "

An array of policy summary objects that match the specified criteria. Each summary contains resource identifiers, status, and timestamps without customer-encrypted content.

" - } - }, - "PolicyValidationMode": { - "base": null, - "refs": { - "CreatePolicyRequest$validationMode": "

The validation mode for the policy creation. Determines how Cedar analyzer validation results are handled during policy creation. FAIL_ON_ANY_FINDINGS (default) runs the Cedar analyzer to validate the policy against the Cedar schema and tool context, failing creation if the analyzer detects any validation issues to ensure strict conformance. IGNORE_ALL_FINDINGS runs the Cedar analyzer but allows policy creation even if validation issues are detected, useful for testing or when the policy schema is evolving. Use FAIL_ON_ANY_FINDINGS for production policies to ensure correctness, and IGNORE_ALL_FINDINGS only when you understand and accept the analyzer findings.

", - "UpdatePolicyRequest$validationMode": "

The validation mode for the policy update. Determines how Cedar analyzer validation results are handled during policy updates. FAIL_ON_ANY_FINDINGS runs the Cedar analyzer and fails the update if validation issues are detected, ensuring the policy conforms to the Cedar schema and tool context. IGNORE_ALL_FINDINGS runs the Cedar analyzer but allows updates despite validation warnings. Use FAIL_ON_ANY_FINDINGS to ensure policy correctness during updates, especially when modifying policy logic or conditions.

" - } - }, - "PrincipalMatchOperator": { - "base": null, - "refs": { - "IamPrincipal$operator": "

The match operator. StringEquals requires an exact match. StringLike supports wildcard patterns using * and ?.

" - } - }, - "PrivateEndpoint": { - "base": "

The private endpoint configuration for a gateway target. Defines how the gateway connects to private resources in your VPC.

", - "refs": { - "CreateGatewayTargetRequest$privateEndpoint": "

The private endpoint configuration for the gateway target. Use this to connect the gateway to private resources in your VPC.

", - "CreateGatewayTargetResponse$privateEndpoint": "

The private endpoint configuration for the gateway target.

", - "CustomJWTAuthorizerConfiguration$privateEndpoint": null, - "CustomOauth2ProviderConfigInput$privateEndpoint": "

The default private endpoint for the custom OAuth2 provider, enabling secure connectivity through a VPC Lattice resource configuration.

", - "CustomOauth2ProviderConfigOutput$privateEndpoint": "

The default private endpoint for the custom OAuth2 provider, enabling secure connectivity through a VPC Lattice resource configuration.

", - "GatewayTarget$privateEndpoint": null, - "GetGatewayTargetResponse$privateEndpoint": "

The private endpoint configuration for the gateway target.

", - "PrivateEndpointOverride$privateEndpoint": "

The private endpoint configuration for the specified domain.

", - "UpdateGatewayTargetRequest$privateEndpoint": "

The private endpoint configuration for the gateway target. Use this to connect the gateway to private resources in your VPC.

", - "UpdateGatewayTargetResponse$privateEndpoint": "

The private endpoint configuration for the gateway target.

" - } - }, - "PrivateEndpointManagedResources": { - "base": "

A list of managed resources created by the gateway for private endpoint connectivity.

", - "refs": { - "CreateGatewayTargetResponse$privateEndpointManagedResources": "

The managed resources created by the gateway for private endpoint connectivity.

", - "GatewayTarget$privateEndpointManagedResources": "

A list of managed resources created by the gateway for private endpoint connectivity. These resources are created in your account when you use a managed VPC Lattice resource configuration.

", - "GetGatewayTargetResponse$privateEndpointManagedResources": "

The managed resources created by the gateway for private endpoint connectivity.

", - "UpdateGatewayTargetResponse$privateEndpointManagedResources": "

The managed resources created by the gateway for private endpoint connectivity.

" - } - }, - "PrivateEndpointOverride": { - "base": "

A mapping of a specific domain to a private endpoint for secure connectivity through a VPC Lattice resource configuration.

", - "refs": { - "PrivateEndpointOverrides$member": null - } - }, - "PrivateEndpointOverrideDomain": { - "base": null, - "refs": { - "PrivateEndpointOverride$domain": "

The domain to override with a private endpoint.

" - } - }, - "PrivateEndpointOverrides": { - "base": null, - "refs": { - "CustomJWTAuthorizerConfiguration$privateEndpointOverrides": "

The private endpoint overrides for the custom JWT authorizer configuration.

", - "CustomOauth2ProviderConfigInput$privateEndpointOverrides": "

The private endpoint overrides for the custom OAuth2 provider configuration.

", - "CustomOauth2ProviderConfigOutput$privateEndpointOverrides": "

The private endpoint overrides for the custom OAuth2 provider configuration.

" - } - }, - "PrivateKeyJwtConfig": { - "base": "

Configuration for private_key_jwt client authentication (RFC 7523). On Create: privateKeySource and signingAlgorithm are required (enforced server-side). On Update: all fields are optional — only provided fields are updated.

", - "refs": { - "CustomOauth2ProviderConfigInput$privateKeyJwtConfig": null, - "CustomOauth2ProviderConfigOutput$privateKeyJwtConfig": null - } - }, - "PrivateKeySource": { - "base": "

Contains the private key source configuration for a JWT client assertion.

", - "refs": { - "PrivateKeyJwtConfig$privateKeySource": "

The private key source for the JWT client assertion.

" - } - }, - "Prompt": { - "base": null, - "refs": { - "EpisodicConsolidationOverride$appendToPrompt": "

The text appended to the prompt for the consolidation step of the episodic memory strategy.

", - "EpisodicExtractionOverride$appendToPrompt": "

The text appended to the prompt for the extraction step of the episodic memory strategy.

", - "EpisodicOverrideConsolidationConfigurationInput$appendToPrompt": "

The text to append to the prompt for the consolidation step of the episodic memory strategy.

", - "EpisodicOverrideExtractionConfigurationInput$appendToPrompt": "

The text to append to the prompt for the extraction step of the episodic memory strategy.

", - "EpisodicOverrideReflectionConfigurationInput$appendToPrompt": "

The text to append to the prompt for reflection step of the episodic memory strategy.

", - "EpisodicReflectionOverride$appendToPrompt": "

The text appended to the prompt for the reflection step of the episodic memory strategy.

", - "SemanticConsolidationOverride$appendToPrompt": "

The text to append to the prompt for semantic consolidation.

", - "SemanticExtractionOverride$appendToPrompt": "

The text to append to the prompt for semantic extraction.

", - "SemanticOverrideConsolidationConfigurationInput$appendToPrompt": "

The text to append to the prompt for semantic consolidation.

", - "SemanticOverrideExtractionConfigurationInput$appendToPrompt": "

The text to append to the prompt for semantic extraction.

", - "SummaryConsolidationOverride$appendToPrompt": "

The text to append to the prompt for summary consolidation.

", - "SummaryOverrideConsolidationConfigurationInput$appendToPrompt": "

The text to append to the prompt for summary consolidation.

", - "UserPreferenceConsolidationOverride$appendToPrompt": "

The text to append to the prompt for user preference consolidation.

", - "UserPreferenceExtractionOverride$appendToPrompt": "

The text to append to the prompt for user preference extraction.

", - "UserPreferenceOverrideConsolidationConfigurationInput$appendToPrompt": "

The text to append to the prompt for user preference consolidation.

", - "UserPreferenceOverrideExtractionConfigurationInput$appendToPrompt": "

The text to append to the prompt for user preference extraction.

" - } - }, - "ProtocolConfiguration": { - "base": "

The protocol configuration for an agent runtime. This structure defines how the agent runtime communicates with clients.

", - "refs": { - "CreateAgentRuntimeRequest$protocolConfiguration": null, - "GetAgentRuntimeResponse$protocolConfiguration": null, - "UpdateAgentRuntimeRequest$protocolConfiguration": null - } - }, - "ProviderPrefix": { - "base": "

The configuration that controls how a provider prefix is applied to model IDs during translation.

", - "refs": { - "ModelMapping$providerPrefix": "

The provider prefix configuration used for model ID translation.

" - } - }, - "ProviderPrefixSeparatorString": { - "base": null, - "refs": { - "ProviderPrefix$separator": "

The single character that separates the provider prefix from the model name (for example, .). The default is ..

" - } - }, - "PutResourcePolicyRequest": { - "base": null, - "refs": {} - }, - "PutResourcePolicyResponse": { - "base": null, - "refs": {} - }, - "RatingScale": { - "base": "

The rating scale that defines how evaluators should score agent performance, supporting both numerical and categorical scales.

", - "refs": { - "LlmAsAJudgeEvaluatorConfig$ratingScale": "

The rating scale that defines how the evaluator should score agent performance, either numerical or categorical.

" - } - }, - "ReasoningConfiguration": { - "base": "

The reasoning configuration that controls how a reasoning model allocates effort during evaluation.

", - "refs": { - "OpenResponsesEvaluatorModelConfig$reasoning": "

The reasoning configuration for reasoning models. Non-reasoning models ignore this configuration.

" - } - }, - "ReasoningConfigurationEffortString": { - "base": null, - "refs": { - "ReasoningConfiguration$effort": "

The level of reasoning effort the model applies when generating a response. For supported values, see the model provider's documentation.

" - } - }, - "RecordIdentifier": { - "base": null, - "refs": { - "DeleteRegistryRecordRequest$recordId": "

The identifier of the registry record to delete. You can specify either the Amazon Resource Name (ARN) or the ID of the record.

", - "GetRegistryRecordRequest$recordId": "

The identifier of the registry record to retrieve. You can specify either the Amazon Resource Name (ARN) or the ID of the record.

", - "SubmitRegistryRecordForApprovalRequest$recordId": "

The identifier of the registry record to submit for approval. You can specify either the Amazon Resource Name (ARN) or the ID of the record.

", - "UpdateRegistryRecordRequest$recordId": "

The identifier of the registry record to update. You can specify either the Amazon Resource Name (ARN) or the ID of the record.

", - "UpdateRegistryRecordStatusRequest$recordId": "

The identifier of the registry record to update the status for. You can specify either the Amazon Resource Name (ARN) or the ID of the record.

" - } - }, - "RecordingConfig": { - "base": "

The recording configuration for a browser. This structure defines how browser sessions are recorded.

", - "refs": { - "CreateBrowserRequest$recording": "

The recording configuration for the browser. When enabled, browser sessions are recorded and stored in the specified Amazon S3 location.

", - "GetBrowserResponse$recording": null - } - }, - "ReflectionConfiguration": { - "base": "

Contains reflection configuration information for a memory strategy.

", - "refs": { - "StrategyConfiguration$reflection": "

The reflection configuration for the memory strategy.

" - } - }, - "RegistryArn": { - "base": null, - "refs": { - "CreateRegistryResponse$registryArn": "

The Amazon Resource Name (ARN) of the created registry.

", - "GetRegistryRecordResponse$registryArn": "

The Amazon Resource Name (ARN) of the registry that contains the record.

", - "GetRegistryResponse$registryArn": "

The Amazon Resource Name (ARN) of the registry.

", - "RegistryRecordSummary$registryArn": "

The Amazon Resource Name (ARN) of the registry that contains the record.

", - "RegistrySummary$registryArn": "

The Amazon Resource Name (ARN) of the registry.

", - "SubmitRegistryRecordForApprovalResponse$registryArn": "

The Amazon Resource Name (ARN) of the registry that contains the record.

", - "UpdateRegistryRecordResponse$registryArn": "

The Amazon Resource Name (ARN) of the registry that contains the updated record.

", - "UpdateRegistryRecordStatusResponse$registryArn": "

The Amazon Resource Name (ARN) of the registry that contains the record.

", - "UpdateRegistryResponse$registryArn": "

The Amazon Resource Name (ARN) of the updated registry.

" - } - }, - "RegistryAuthorizerType": { - "base": null, - "refs": { - "CreateRegistryRequest$authorizerType": "

The type of authorizer to use for the registry. This controls the authorization method for the Search and Invoke APIs used by consumers, and does not affect the standard CRUDL APIs for registry and registry record management used by administrators.

  • CUSTOM_JWT - Authorize with a bearer token.

  • AWS_IAM - Authorize with your Amazon Web Services IAM credentials.

", - "GetRegistryResponse$authorizerType": "

The type of authorizer used by the registry. This controls the authorization method for the Search and Invoke APIs used by consumers.

  • CUSTOM_JWT - Authorize with a bearer token.

  • AWS_IAM - Authorize with your Amazon Web Services IAM credentials.

", - "ListRegistriesRequest$authorizerType": "

Filter registries by their authorizer type. Possible values are CUSTOM_JWT and AWS_IAM. For more information about authorizer types, see the RegistryAuthorizerType enum.

", - "RegistrySummary$authorizerType": "

The type of authorizer used by the registry. This controls the authorization method for the Search and Invoke APIs used by consumers.

  • CUSTOM_JWT - Authorize with a bearer token.

  • AWS_IAM - Authorize with your Amazon Web Services IAM credentials.

", - "UpdateRegistryResponse$authorizerType": "

The type of authorizer used by the updated registry. This controls the authorization method for the Search and Invoke APIs used by consumers.

  • CUSTOM_JWT - Authorize with a bearer token.

  • AWS_IAM - Authorize with your Amazon Web Services IAM credentials.

" - } - }, - "RegistryId": { - "base": null, - "refs": { - "GetRegistryResponse$registryId": "

The unique identifier of the registry.

", - "RegistrySummary$registryId": "

The unique identifier of the registry.

", - "UpdateRegistryResponse$registryId": "

The unique identifier of the updated registry.

" - } - }, - "RegistryIdentifier": { - "base": null, - "refs": { - "CreateRegistryRecordRequest$registryId": "

The identifier of the registry where the record will be created. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.

", - "DeleteRegistryRecordRequest$registryId": "

The identifier of the registry containing the record. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.

", - "DeleteRegistryRequest$registryId": "

The identifier of the registry to delete. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.

", - "GetRegistryRecordRequest$registryId": "

The identifier of the registry containing the record. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.

", - "GetRegistryRequest$registryId": "

The identifier of the registry to retrieve. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.

", - "ListRegistryRecordsRequest$registryId": "

The identifier of the registry to list records from. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.

", - "SubmitRegistryRecordForApprovalRequest$registryId": "

The identifier of the registry containing the record. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.

", - "UpdateRegistryRecordRequest$registryId": "

The identifier of the registry containing the record. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.

", - "UpdateRegistryRecordStatusRequest$registryId": "

The identifier of the registry containing the record. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.

", - "UpdateRegistryRequest$registryId": "

The identifier of the registry to update. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.

" - } - }, - "RegistryName": { - "base": null, - "refs": { - "CreateRegistryRequest$name": "

The name of the registry. The name must be unique within your account and can contain alphanumeric characters and underscores.

", - "GetRegistryResponse$name": "

The name of the registry.

", - "RegistrySummary$name": "

The name of the registry.

", - "UpdateRegistryRequest$name": "

The updated name of the registry.

", - "UpdateRegistryResponse$name": "

The name of the updated registry.

" - } - }, - "RegistryRecordArn": { - "base": null, - "refs": { - "CreateRegistryRecordResponse$recordArn": "

The Amazon Resource Name (ARN) of the created registry record.

", - "GetRegistryRecordResponse$recordArn": "

The Amazon Resource Name (ARN) of the registry record.

", - "RegistryRecordSummary$recordArn": "

The Amazon Resource Name (ARN) of the registry record.

", - "SubmitRegistryRecordForApprovalResponse$recordArn": "

The Amazon Resource Name (ARN) of the registry record.

", - "UpdateRegistryRecordResponse$recordArn": "

The Amazon Resource Name (ARN) of the updated registry record.

", - "UpdateRegistryRecordStatusResponse$recordArn": "

The Amazon Resource Name (ARN) of the registry record.

" - } - }, - "RegistryRecordCredentialProviderConfiguration": { - "base": "

A pairing of a credential provider type with its corresponding provider details for authenticating with external sources.

", - "refs": { - "RegistryRecordCredentialProviderConfigurationList$member": null - } - }, - "RegistryRecordCredentialProviderConfigurationList": { - "base": null, - "refs": { - "FromUrlSynchronizationConfiguration$credentialProviderConfigurations": "

Optional list of credential provider configurations for authenticating with the MCP server. At most one credential provider configuration can be specified.

" - } - }, - "RegistryRecordCredentialProviderType": { - "base": null, - "refs": { - "RegistryRecordCredentialProviderConfiguration$credentialProviderType": "

The type of credential provider.

  • OAUTH - OAuth-based authentication.

  • IAM - Amazon Web Services IAM-based authentication using SigV4 signing.

" - } - }, - "RegistryRecordCredentialProviderUnion": { - "base": "

Union of supported credential provider types for registry record synchronization.

", - "refs": { - "RegistryRecordCredentialProviderConfiguration$credentialProvider": "

The credential provider configuration details. The structure depends on the credentialProviderType.

" - } - }, - "RegistryRecordIamCredentialProvider": { - "base": "

IAM credential provider configuration for authenticating with an external source using SigV4 signing during synchronization.

", - "refs": { - "RegistryRecordCredentialProviderUnion$iamCredentialProvider": "

The IAM credential provider configuration for authenticating with the external source using SigV4 signing.

" - } - }, - "RegistryRecordId": { - "base": null, - "refs": { - "GetRegistryRecordResponse$recordId": "

The unique identifier of the registry record.

", - "RegistryRecordSummary$recordId": "

The unique identifier of the registry record.

", - "SubmitRegistryRecordForApprovalResponse$recordId": "

The unique identifier of the registry record.

", - "UpdateRegistryRecordResponse$recordId": "

The unique identifier of the updated registry record.

", - "UpdateRegistryRecordStatusResponse$recordId": "

The unique identifier of the registry record.

" - } - }, - "RegistryRecordName": { - "base": null, - "refs": { - "CreateRegistryRecordRequest$name": "

The name of the registry record.

", - "GetRegistryRecordResponse$name": "

The name of the registry record.

", - "ListRegistryRecordsRequest$name": "

Filter registry records by name.

", - "RegistryRecordSummary$name": "

The name of the registry record.

", - "UpdateRegistryRecordRequest$name": "

The updated name for the registry record.

", - "UpdateRegistryRecordResponse$name": "

The name of the updated registry record.

" - } - }, - "RegistryRecordOAuthCredentialProvider": { - "base": "

OAuth credential provider configuration for authenticating with an external source during synchronization.

", - "refs": { - "RegistryRecordCredentialProviderUnion$oauthCredentialProvider": "

The OAuth credential provider configuration for authenticating with the external source.

" - } - }, - "RegistryRecordOAuthGrantType": { - "base": null, - "refs": { - "RegistryRecordOAuthCredentialProvider$grantType": "

The OAuth grant type. Currently only CLIENT_CREDENTIALS is supported.

" - } - }, - "RegistryRecordStatus": { - "base": null, - "refs": { - "CreateRegistryRecordResponse$status": "

The status of the registry record. Set to CREATING while the asynchronous workflow is in progress.

", - "GetRegistryRecordResponse$status": "

The current status of the registry record. Possible values include CREATING, DRAFT, APPROVED, PENDING_APPROVAL, REJECTED, DEPRECATED, UPDATING, CREATE_FAILED, and UPDATE_FAILED. A record transitions from CREATING to DRAFT, then to PENDING_APPROVAL (via SubmitRegistryRecordForApproval), and finally to APPROVED upon approval.

", - "ListRegistryRecordsRequest$status": "

Filter registry records by their current status. Possible values include CREATING, DRAFT, APPROVED, PENDING_APPROVAL, REJECTED, DEPRECATED, UPDATING, CREATE_FAILED, and UPDATE_FAILED.

", - "RegistryRecordSummary$status": "

The current status of the registry record. Possible values include CREATING, DRAFT, APPROVED, PENDING_APPROVAL, REJECTED, DEPRECATED, UPDATING, CREATE_FAILED, and UPDATE_FAILED.

", - "SubmitRegistryRecordForApprovalResponse$status": "

The resulting status of the registry record after submission.

", - "UpdateRegistryRecordResponse$status": "

The current status of the updated registry record. Possible values include CREATING, DRAFT, APPROVED, PENDING_APPROVAL, REJECTED, DEPRECATED, UPDATING, CREATE_FAILED, and UPDATE_FAILED.

", - "UpdateRegistryRecordStatusRequest$status": "

The target status for the registry record.

", - "UpdateRegistryRecordStatusResponse$status": "

The resulting status of the registry record.

" - } - }, - "RegistryRecordSummary": { - "base": "

Contains summary information about a registry record.

", - "refs": { - "RegistryRecordSummaryList$member": null - } - }, - "RegistryRecordSummaryList": { - "base": null, - "refs": { - "ListRegistryRecordsResponse$registryRecords": "

The list of registry record summaries. For details about the fields in each summary, see the RegistryRecordSummary data type.

" - } - }, - "RegistryRecordVersion": { - "base": null, - "refs": { - "CreateRegistryRecordRequest$recordVersion": "

The version of the registry record. Use this to track different versions of the record's content.

", - "GetRegistryRecordResponse$recordVersion": "

The version of the registry record.

", - "RegistryRecordSummary$recordVersion": "

The version of the registry record.

", - "UpdateRegistryRecordRequest$recordVersion": "

The version of the registry record for optimistic locking. If provided, it must match the current version of the record. The service automatically increments the version after a successful update.

", - "UpdateRegistryRecordResponse$recordVersion": "

The version of the updated registry record.

" - } - }, - "RegistryStatus": { - "base": null, - "refs": { - "DeleteRegistryResponse$status": "

The current status of the registry, set to DELETING when deletion is initiated. For a list of all possible registry statuses, see the RegistryStatus data type.

", - "GetRegistryResponse$status": "

The current status of the registry. Possible values include CREATING, READY, UPDATING, CREATE_FAILED, UPDATE_FAILED, DELETING, and DELETE_FAILED.

", - "ListRegistriesRequest$status": "

Filter registries by their current status. Possible values include CREATING, READY, UPDATING, CREATE_FAILED, UPDATE_FAILED, DELETING, and DELETE_FAILED.

", - "RegistrySummary$status": "

The current status of the registry. Possible values include CREATING, READY, UPDATING, CREATE_FAILED, UPDATE_FAILED, DELETING, and DELETE_FAILED.

", - "UpdateRegistryResponse$status": "

The current status of the updated registry. Possible values include CREATING, READY, UPDATING, CREATE_FAILED, UPDATE_FAILED, DELETING, and DELETE_FAILED.

" - } - }, - "RegistrySummary": { - "base": "

Contains summary information about a registry.

", - "refs": { - "RegistrySummaryList$member": null - } - }, - "RegistrySummaryList": { - "base": null, - "refs": { - "ListRegistriesResponse$registries": "

The list of registry summaries. For details about the fields in each summary, see the RegistrySummary data type.

" - } - }, - "RequestHeaderAllowlist": { - "base": null, - "refs": { - "RequestHeaderConfiguration$requestHeaderAllowlist": "

A list of HTTP request headers that are allowed to be passed through to the runtime.

" - } - }, - "RequestHeaderConfiguration": { - "base": "

Configuration for HTTP request headers that will be passed through to the runtime.

", - "refs": { - "CreateAgentRuntimeRequest$requestHeaderConfiguration": "

Configuration for HTTP request headers that will be passed through to the runtime.

", - "GetAgentRuntimeResponse$requestHeaderConfiguration": "

Configuration for HTTP request headers that will be passed through to the runtime.

", - "UpdateAgentRuntimeRequest$requestHeaderConfiguration": "

The updated configuration for HTTP request headers that will be passed through to the runtime.

" - } - }, - "RequiredProperties": { - "base": null, - "refs": { - "SchemaDefinition$required": "

The required fields in the schema definition. These fields must be provided when using the schema.

" - } - }, - "Resource": { - "base": "

Represents a resource within the AgentCore Policy system. Resources are the targets of policy evaluation. Currently, only AgentCore Gateways are supported as resources for policy enforcement.

", - "refs": { - "GetPolicyGenerationResponse$resource": "

The resource information associated with the policy generation. This provides context about the target resources for which the policies are being generated.

", - "GetPolicyGenerationSummaryResponse$resource": "

The resource information associated with the policy generation.

", - "PolicyGeneration$resource": "

The resource information associated with this policy generation.

", - "PolicyGenerationSummary$resource": "

The resource information associated with this policy generation.

", - "StartPolicyGenerationRequest$resource": "

The resource information that provides context for policy generation. This helps the AI understand the target resources and generate appropriate access control rules.

", - "StartPolicyGenerationResponse$resource": "

The resource information associated with the policy generation request.

" - } - }, - "ResourceAssociationArn": { - "base": null, - "refs": { - "ManagedResourceDetails$resourceAssociationArn": "

The ARN of the service network resource association.

" - } - }, - "ResourceConfigurationIdentifier": { - "base": null, - "refs": { - "SelfManagedLatticeResource$resourceConfigurationIdentifier": "

The ARN or ID of the VPC Lattice resource configuration.

" - } - }, - "ResourceGatewayArn": { - "base": null, - "refs": { - "ManagedResourceDetails$resourceGatewayArn": "

The ARN of the VPC Lattice resource gateway created in your account.

" - } - }, - "ResourceId": { - "base": null, - "refs": { - "CreatePolicyEngineResponse$policyEngineId": "

The unique identifier for the created policy engine. This system-generated identifier consists of the user name plus a 10-character generated suffix and is used for all subsequent policy engine operations.

", - "CreatePolicyRequest$policyEngineId": "

The identifier of the policy engine which contains this policy. Policy engines group related policies and provide the execution context for policy evaluation.

", - "CreatePolicyResponse$policyId": "

The unique identifier for the created policy. This is a system-generated identifier consisting of the user name plus a 10-character generated suffix, used for all subsequent policy operations.

", - "CreatePolicyResponse$policyEngineId": "

The identifier of the policy engine that manages this policy. This confirms the policy engine assignment and is used for policy evaluation routing.

", - "DeletePolicyEngineRequest$policyEngineId": "

The unique identifier of the policy engine to be deleted. This must be a valid policy engine ID that exists within the account.

", - "DeletePolicyEngineResponse$policyEngineId": "

The unique identifier of the policy engine being deleted. This confirms which policy engine the deletion operation targets.

", - "DeletePolicyRequest$policyEngineId": "

The identifier of the policy engine that manages the policy to be deleted. This ensures the policy is deleted from the correct policy engine context.

", - "DeletePolicyRequest$policyId": "

The unique identifier of the policy to be deleted. This must be a valid policy ID that exists within the specified policy engine.

", - "DeletePolicyResponse$policyId": "

The unique identifier of the policy being deleted. This confirms which policy the deletion operation targets.

", - "DeletePolicyResponse$policyEngineId": "

The identifier of the policy engine from which the policy was deleted. This confirms the policy engine context for the deletion operation.

", - "GetPolicyEngineRequest$policyEngineId": "

The unique identifier of the policy engine to be retrieved. This must be a valid policy engine ID that exists within the account.

", - "GetPolicyEngineResponse$policyEngineId": "

The unique identifier of the retrieved policy engine. This matches the policy engine ID provided in the request and serves as the system identifier.

", - "GetPolicyEngineSummaryRequest$policyEngineId": "

The unique identifier of the policy engine to retrieve the summary for. This must be a valid policy engine ID that exists within the account.

", - "GetPolicyEngineSummaryResponse$policyEngineId": "

The unique identifier of the policy engine.

", - "GetPolicyGenerationRequest$policyGenerationId": "

The unique identifier of the policy generation request to be retrieved. This must be a valid generation ID from a previous StartPolicyGeneration call.

", - "GetPolicyGenerationRequest$policyEngineId": "

The identifier of the policy engine associated with the policy generation request. This provides the context for the generation operation and schema validation.

", - "GetPolicyGenerationResponse$policyEngineId": "

The identifier of the policy engine associated with this policy generation. This confirms the policy engine context for the generation operation.

", - "GetPolicyGenerationResponse$policyGenerationId": "

The unique identifier of the policy generation request. This matches the generation ID provided in the request and serves as the tracking identifier.

", - "GetPolicyGenerationSummaryRequest$policyGenerationId": "

The unique identifier of the policy generation request to retrieve the summary for.

", - "GetPolicyGenerationSummaryRequest$policyEngineId": "

The identifier of the policy engine associated with the policy generation request.

", - "GetPolicyGenerationSummaryResponse$policyEngineId": "

The identifier of the policy engine associated with this policy generation.

", - "GetPolicyGenerationSummaryResponse$policyGenerationId": "

The unique identifier of the policy generation request.

", - "GetPolicyRequest$policyEngineId": "

The identifier of the policy engine that manages the policy to be retrieved.

", - "GetPolicyRequest$policyId": "

The unique identifier of the policy to be retrieved. This must be a valid policy ID that exists within the specified policy engine.

", - "GetPolicyResponse$policyId": "

The unique identifier of the retrieved policy. This matches the policy ID provided in the request and serves as the system identifier for the policy.

", - "GetPolicyResponse$policyEngineId": "

The identifier of the policy engine that manages this policy. This confirms the policy engine context for the retrieved policy.

", - "GetPolicySummaryRequest$policyEngineId": "

The identifier of the policy engine that manages the policy to retrieve the summary for.

", - "GetPolicySummaryRequest$policyId": "

The unique identifier of the policy to retrieve the summary for. This must be a valid policy ID that exists within the specified policy engine.

", - "GetPolicySummaryResponse$policyId": "

The unique identifier of the policy.

", - "GetPolicySummaryResponse$policyEngineId": "

The identifier of the policy engine that manages this policy.

", - "ListPoliciesRequest$policyEngineId": "

The identifier of the policy engine whose policies to retrieve.

", - "ListPolicyGenerationAssetsRequest$policyGenerationId": "

The unique identifier of the policy generation request whose assets are to be retrieved. This must be a valid generation ID from a previous StartPolicyGeneration call that has completed processing.

", - "ListPolicyGenerationAssetsRequest$policyEngineId": "

The unique identifier of the policy engine associated with the policy generation request. This provides the context for the generation operation and ensures assets are retrieved from the correct policy engine.

", - "ListPolicyGenerationSummariesRequest$policyEngineId": "

The identifier of the policy engine whose policy generation summaries to retrieve.

", - "ListPolicyGenerationsRequest$policyEngineId": "

The identifier of the policy engine whose policy generations to retrieve.

", - "ListPolicySummariesRequest$policyEngineId": "

The identifier of the policy engine whose policy summaries to retrieve.

", - "Policy$policyId": "

The unique identifier for the policy. This system-generated identifier consists of the user name plus a 10-character generated suffix and serves as the primary key for policy operations.

", - "Policy$policyEngineId": "

The identifier of the policy engine that manages this policy. This establishes the policy engine context for policy evaluation and management.

", - "PolicyEngine$policyEngineId": "

The unique identifier for the policy engine. This system-generated identifier consists of the user name plus a 10-character generated suffix and serves as the primary key for policy engine operations.

", - "PolicyEngineSummary$policyEngineId": "

The unique identifier for the policy engine.

", - "PolicyGeneration$policyEngineId": "

The identifier of the policy engine associated with this generation request.

", - "PolicyGeneration$policyGenerationId": "

The unique identifier for this policy generation request.

", - "PolicyGenerationAsset$policyGenerationAssetId": "

The unique identifier for this generated policy asset within the policy generation request. This ID can be used to reference specific generated policy options when creating actual policies from the generation results.

", - "PolicyGenerationDetails$policyGenerationId": "

The unique identifier for this policy generation request.

", - "PolicyGenerationDetails$policyGenerationAssetId": "

The unique identifier for this generated policy asset within the policy generation request.

", - "PolicyGenerationSummary$policyEngineId": "

The identifier of the policy engine associated with this generation request.

", - "PolicyGenerationSummary$policyGenerationId": "

The unique identifier for this policy generation request.

", - "PolicySummary$policyId": "

The unique identifier for the policy.

", - "PolicySummary$policyEngineId": "

The identifier of the policy engine that manages this policy.

", - "StartPolicyGenerationRequest$policyEngineId": "

The identifier of the policy engine that provides the context for policy generation. This engine's schema and tool context are used to ensure generated policies are valid and applicable.

", - "StartPolicyGenerationResponse$policyEngineId": "

The identifier of the policy engine associated with the started policy generation.

", - "StartPolicyGenerationResponse$policyGenerationId": "

The unique identifier assigned to the policy generation request for tracking progress.

", - "UpdatePolicyEngineRequest$policyEngineId": "

The unique identifier of the policy engine to be updated.

", - "UpdatePolicyEngineResponse$policyEngineId": "

The unique identifier of the updated policy engine.

", - "UpdatePolicyRequest$policyEngineId": "

The identifier of the policy engine that manages the policy to be updated. This ensures the policy is updated within the correct policy engine context.

", - "UpdatePolicyRequest$policyId": "

The unique identifier of the policy to be updated. This must be a valid policy ID that exists within the specified policy engine.

", - "UpdatePolicyResponse$policyId": "

The unique identifier of the updated policy.

", - "UpdatePolicyResponse$policyEngineId": "

The identifier of the policy engine managing the updated policy.

" - } - }, - "ResourceLimitExceededException": { - "base": "

Exception thrown when a resource limit is exceeded.

", - "refs": {} - }, - "ResourceLocation": { - "base": "

The location of a resource.

", - "refs": { - "BrowserEnterprisePolicy$location": "

The location of the enterprise policy file.

" - } - }, - "ResourceNotFoundException": { - "base": "

This exception is thrown when a resource referenced by the operation does not exist

", - "refs": {} - }, - "ResourceOauth2ReturnUrlListType": { - "base": null, - "refs": { - "CreateWorkloadIdentityRequest$allowedResourceOauth2ReturnUrls": "

The list of allowed OAuth2 return URLs for resources associated with this workload identity.

", - "CreateWorkloadIdentityResponse$allowedResourceOauth2ReturnUrls": "

The list of allowed OAuth2 return URLs for resources associated with this workload identity.

", - "GetWorkloadIdentityResponse$allowedResourceOauth2ReturnUrls": "

The list of allowed OAuth2 return URLs for resources associated with this workload identity.

", - "UpdateWorkloadIdentityRequest$allowedResourceOauth2ReturnUrls": "

The new list of allowed OAuth2 return URLs for resources associated with this workload identity. This list replaces the existing list.

", - "UpdateWorkloadIdentityResponse$allowedResourceOauth2ReturnUrls": "

The list of allowed OAuth2 return URLs for resources associated with this workload identity.

" - } - }, - "ResourceOauth2ReturnUrlType": { - "base": null, - "refs": { - "ResourceOauth2ReturnUrlListType$member": null - } - }, - "ResourcePolicyBody": { - "base": null, - "refs": { - "GetResourcePolicyResponse$policy": "

The resource policy associated with the specified resource.

", - "PutResourcePolicyRequest$policy": "

The resource policy to create or update.

", - "PutResourcePolicyResponse$policy": "

The resource policy that was created or updated.

" - } - }, - "ResourceType": { - "base": null, - "refs": { - "ListBrowsersRequest$type": "

The type of browsers to list. If not specified, all browser types are returned.

", - "ListCodeInterpretersRequest$type": "

The type of code interpreters to list.

" - } - }, - "ResponseListType": { - "base": null, - "refs": { - "Oauth2AuthorizationServerMetadata$responseTypes": "

The supported response types for the OAuth2 authorization server.

" - } - }, - "ResponseType": { - "base": null, - "refs": { - "ResponseListType$member": null - } - }, - "RestApiMethod": { - "base": null, - "refs": { - "ApiGatewayToolOverride$method": "

The HTTP method to expose for the specified path.

", - "RestApiMethods$member": null - } - }, - "RestApiMethods": { - "base": null, - "refs": { - "ApiGatewayToolFilter$methods": "

The methods to filter for.

" - } - }, - "RoleArn": { - "base": null, - "refs": { - "CreateAgentRuntimeRequest$roleArn": "

The IAM role ARN that provides permissions for the AgentCore Runtime.

", - "CreateBrowserRequest$executionRoleArn": "

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the browser to access Amazon Web Services services.

", - "CreateCodeInterpreterRequest$executionRoleArn": "

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the code interpreter to access Amazon Web Services services.

", - "CreateGatewayRequest$roleArn": "

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the gateway to access Amazon Web Services services.

", - "CreateGatewayResponse$roleArn": "

The Amazon Resource Name (ARN) of the IAM role associated with the gateway.

", - "CreateHarnessRequest$executionRoleArn": "

The ARN of the IAM role that the harness assumes when running. This role must have permissions for the services the agent needs to access, such as Amazon Bedrock for model invocation.

", - "CreateOnlineEvaluationConfigRequest$evaluationExecutionRoleArn": "

The Amazon Resource Name (ARN) of the IAM role that grants permissions to read from CloudWatch logs, write evaluation results, and invoke Amazon Bedrock models for evaluation. If the configuration references evaluators encrypted with a customer managed KMS key, this role must also have kms:Decrypt permission on the KMS key. The service validates this permission at configuration creation time. For more information, see Encryption at rest for AgentCore Evaluations.

", - "CreatePaymentManagerRequest$roleArn": "

The Amazon Resource Name (ARN) of the IAM role that the payment manager assumes to access resources on your behalf.

", - "CreatePaymentManagerResponse$roleArn": "

The Amazon Resource Name (ARN) of the IAM role associated with the created payment manager.

", - "GetAgentRuntimeResponse$roleArn": "

The IAM role ARN that provides permissions for the AgentCore Runtime.

", - "GetBrowserResponse$executionRoleArn": "

The IAM role ARN that provides permissions for the browser.

", - "GetCodeInterpreterResponse$executionRoleArn": "

The IAM role ARN that provides permissions for the code interpreter.

", - "GetGatewayResponse$roleArn": "

The IAM role ARN that provides permissions for the gateway.

", - "GetOnlineEvaluationConfigResponse$evaluationExecutionRoleArn": "

The Amazon Resource Name (ARN) of the IAM role used for evaluation execution.

", - "GetPaymentManagerResponse$roleArn": "

The Amazon Resource Name (ARN) of the IAM role associated with the payment manager.

", - "Harness$executionRoleArn": "

IAM role the harness assumes when running.

", - "PaymentManagerSummary$roleArn": "

The Amazon Resource Name (ARN) of the IAM role associated with the payment manager.

", - "UpdateAgentRuntimeRequest$roleArn": "

The updated IAM role ARN that provides permissions for the AgentCore Runtime.

", - "UpdateGatewayRequest$roleArn": "

The updated IAM role ARN that provides permissions for the gateway.

", - "UpdateGatewayResponse$roleArn": "

The updated IAM role ARN that provides permissions for the gateway.

", - "UpdateHarnessRequest$executionRoleArn": "

The ARN of the IAM role that the harness assumes when running. If not specified, the existing value is retained.

", - "UpdateOnlineEvaluationConfigRequest$evaluationExecutionRoleArn": "

The updated Amazon Resource Name (ARN) of the IAM role used for evaluation execution.

", - "UpdatePaymentManagerRequest$roleArn": "

The updated Amazon Resource Name (ARN) of the IAM role for the payment manager.

", - "UpdatePaymentManagerResponse$roleArn": "

The Amazon Resource Name (ARN) of the IAM role associated with the updated payment manager.

" - } - }, - "RouteToTargetAction": { - "base": "

An action that routes requests to a gateway target, either statically or with weighted traffic splitting.

", - "refs": { - "Action$routeToTarget": "

An action that routes the request to a specific target.

" - } - }, - "RoutingDomain": { - "base": null, - "refs": { - "ManagedVpcResource$routingDomain": "

An intermediate domain to use as the resource configuration endpoint instead of the actual target domain. Use this when you want to route traffic through an intermediate component such as a VPC endpoint or internal load balancer. For more information, see xref:lattice-vpc-egress-routing-domain[Route traffic through an intermediate domain].

" - } - }, - "Rule": { - "base": "

The evaluation rule that defines sampling configuration, filtering criteria, and session detection settings for online evaluation.

", - "refs": { - "CreateOnlineEvaluationConfigRequest$rule": "

The evaluation rule that defines sampling configuration, filters, and session detection settings for the online evaluation.

", - "GetOnlineEvaluationConfigResponse$rule": "

The evaluation rule containing sampling configuration, filters, and session settings.

", - "UpdateOnlineEvaluationConfigRequest$rule": "

The updated evaluation rule containing sampling configuration, filters, and session settings.

" - } - }, - "RuntimeArn": { - "base": null, - "refs": { - "RuntimeTargetConfiguration$arn": "

The Amazon Resource Name (ARN) of the AgentCore Runtime to route requests to.

" - } - }, - "RuntimeContainerUri": { - "base": null, - "refs": { - "ContainerConfiguration$containerUri": "

The ECR URI of the container.

" - } - }, - "RuntimeMetadataConfiguration": { - "base": "

Configuration for microVM metadata service settings.

", - "refs": { - "GetAgentRuntimeResponse$metadataConfiguration": "

Configuration for microVM Metadata Service (MMDS) settings for the AgentCore Runtime.

", - "UpdateAgentRuntimeRequest$metadataConfiguration": "

The updated configuration for microVM Metadata Service (MMDS) settings for the AgentCore Runtime.

" - } - }, - "RuntimeQualifier": { - "base": null, - "refs": { - "RuntimeTargetConfiguration$qualifier": "

The qualifier for the agent runtime, used to target a specific endpoint version. If not specified, the default endpoint is used.

" - } - }, - "RuntimeTargetConfiguration": { - "base": "

Configuration for an AgentCore Runtime target. Specifies the agent runtime to route requests to via HTTP.

", - "refs": { - "HttpTargetConfiguration$agentcoreRuntime": "

The AgentCore Runtime target configuration for HTTP-based communication with an agent runtime.

" - } - }, - "S3BucketUri": { - "base": null, - "refs": { - "S3Configuration$uri": "

The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.

" - } - }, - "S3Configuration": { - "base": "

The Amazon S3 configuration for a gateway. This structure defines how the gateway accesses files in Amazon S3.

", - "refs": { - "ApiSchemaConfiguration$s3": null, - "McpToolSchemaConfiguration$s3": "

The Amazon S3 location of the tool schema. This location contains the schema definition file.

", - "ToolSchema$s3": "

The Amazon S3 location of the tool schema. This location contains the schema definition file.

" - } - }, - "S3FilesAccessPointArn": { - "base": null, - "refs": { - "S3FilesAccessPointConfiguration$accessPointArn": "

The ARN of the S3 Files access point to mount into the AgentCore Runtime.

", - "S3FilesConfiguration$accessPointArn": "

The Amazon Resource Name (ARN) of the Amazon Simple Storage Service (Amazon S3) Files access point to mount.

" - } - }, - "S3FilesAccessPointConfiguration": { - "base": "

Configuration for an Amazon S3 Files access point filesystem mounted into the AgentCore Runtime. S3 Files access points provide shared file storage accessible from your AgentCore Runtime sessions.

", - "refs": { - "FilesystemConfiguration$s3FilesAccessPoint": "

Configuration for an Amazon S3 Files access point to mount into the AgentCore Runtime.

" - } - }, - "S3FilesConfiguration": { - "base": "

The configuration for mounting an Amazon Simple Storage Service (Amazon S3) Files access point that you own into a session.

", - "refs": { - "ToolsFileSystemConfiguration$s3FilesConfiguration": "

The configuration for mounting your own Amazon Simple Storage Service (Amazon S3) Files access point into the session.

" - } - }, - "S3FilesFileSystemArn": { - "base": "

The Amazon Resource Name (ARN) of an Amazon Simple Storage Service (Amazon S3) Files file system. The access points you specify must belong to this file system.

", - "refs": { - "S3FilesConfiguration$fileSystemArn": "

The Amazon Resource Name (ARN) of the Amazon Simple Storage Service (Amazon S3) Files file system that owns the access point.

" - } - }, - "S3Location": { - "base": "

The Amazon S3 location for storing data. This structure defines where in Amazon S3 data is stored.

", - "refs": { - "Code$s3": "

The Amazon Amazon S3 object that contains the source code for the agent runtime.

", - "RecordingConfig$s3Location": "

The Amazon S3 location where browser recordings are stored. This location contains the recorded browser sessions.

", - "ResourceLocation$s3": null - } - }, - "S3LocationBucketString": { - "base": null, - "refs": { - "S3Location$bucket": "

The name of the Amazon S3 bucket. This bucket contains the stored data.

" - } - }, - "S3LocationPrefixString": { - "base": null, - "refs": { - "S3Location$prefix": "

The prefix for objects in the Amazon S3 bucket. This prefix is added to the object keys to organize the data.

" - } - }, - "S3LocationVersionIdString": { - "base": null, - "refs": { - "S3Location$versionId": "

The version ID of the Amazon Amazon S3 object. If not specified, the latest version of the object is used.

" - } - }, - "S3Source": { - "base": "

Amazon S3 location of a JSONL file containing dataset examples.

", - "refs": { - "DataSourceType$s3Source": "

Amazon S3 URI pointing to a JSONL file in the customer's bucket.

" - } - }, - "S3Uri": { - "base": "

Amazon S3 URI string in the format s3://bucket/key.

", - "refs": { - "S3Source$s3Uri": "

Amazon S3 URI of the JSONL file (for example, s3://my-bucket/path/to/examples.jsonl).

" - } - }, - "SalesforceOauth2ProviderConfigInput": { - "base": "

Input configuration for a Salesforce OAuth2 provider.

", - "refs": { - "Oauth2ProviderConfigInput$salesforceOauth2ProviderConfig": "

The configuration for a Salesforce OAuth2 provider.

" - } - }, - "SalesforceOauth2ProviderConfigOutput": { - "base": "

Output configuration for a Salesforce OAuth2 provider.

", - "refs": { - "Oauth2ProviderConfigOutput$salesforceOauth2ProviderConfig": "

The output configuration for a Salesforce OAuth2 provider.

" - } - }, - "SamplingConfig": { - "base": "

The configuration that controls what percentage of agent traces are sampled for evaluation to manage evaluation volume and costs.

", - "refs": { - "Rule$samplingConfig": "

The sampling configuration that determines what percentage of agent traces to evaluate.

" - } - }, - "SamplingConfigSamplingPercentageDouble": { - "base": null, - "refs": { - "SamplingConfig$samplingPercentage": "

The percentage of agent traces to sample for evaluation, ranging from 0.01% to 100%.

" - } - }, - "SandboxName": { - "base": null, - "refs": { - "BrowserSummary$name": "

The name of the browser.

", - "CodeInterpreterSummary$name": "

The name of the code interpreter.

", - "CreateBrowserRequest$name": "

The name of the browser. The name must be unique within your account.

", - "CreateCodeInterpreterRequest$name": "

The name of the code interpreter. The name must be unique within your account.

", - "GetBrowserResponse$name": "

The name of the browser.

", - "GetCodeInterpreterResponse$name": "

The name of the code interpreter.

" - } - }, - "SchemaDefinition": { - "base": "

A schema definition for a gateway target. This structure defines the structure of the API that the target exposes.

", - "refs": { - "SchemaDefinition$items": "

The items in the schema definition. This field is used for array types to define the structure of the array elements.

", - "SchemaProperties$value": null, - "ToolDefinition$inputSchema": "

The input schema for the tool. This schema defines the structure of the input that the tool accepts.

", - "ToolDefinition$outputSchema": "

The output schema for the tool. This schema defines the structure of the output that the tool produces.

" - } - }, - "SchemaProperties": { - "base": null, - "refs": { - "SchemaDefinition$properties": "

The properties of the schema definition. These properties define the fields in the schema.

" - } - }, - "SchemaType": { - "base": null, - "refs": { - "SchemaDefinition$type": "

The type of the schema definition. This field specifies the data type of the schema.

" - } - }, - "SchemaVersion": { - "base": null, - "refs": { - "AgentCardDefinition$schemaVersion": "

The schema version of the agent card based on the A2A protocol specification.

", - "ServerDefinition$schemaVersion": "

The schema version of the server definition based on the MCP protocol specification. If not specified, the version is auto-detected from the content.

", - "SkillDefinition$schemaVersion": "

The version of the skill definition schema.

", - "ToolsDefinition$protocolVersion": "

The protocol version of the tools definition based on the MCP protocol specification. If not specified, the version is auto-detected from the content.

" - } - }, - "ScopeList": { - "base": null, - "refs": { - "RegistryRecordOAuthCredentialProvider$scopes": "

The OAuth scopes to request during authentication.

" - } - }, - "ScopeType": { - "base": null, - "refs": { - "ScopesListType$member": null - } - }, - "ScopesListType": { - "base": null, - "refs": { - "TokenExchangeGrantTypeConfigType$actorTokenScopes": "

The scopes for the actor token. Only valid when actorTokenContent is M2M.

" - } - }, - "SearchType": { - "base": null, - "refs": { - "MCPGatewayConfiguration$searchType": "

The search type for the Model Context Protocol gateway. This field specifies how the gateway handles search operations.

" - } - }, - "Secret": { - "base": "

Contains information about a secret in Amazon Web Services Secrets Manager.

", - "refs": { - "CoinbaseCdpConfigurationOutput$apiKeySecretArn": null, - "CoinbaseCdpConfigurationOutput$walletSecretArn": null, - "CreateApiKeyCredentialProviderResponse$apiKeySecretArn": "

The Amazon Resource Name (ARN) of the secret containing the API key.

", - "CreateOauth2CredentialProviderResponse$clientSecretArn": "

The Amazon Resource Name (ARN) of the client secret in Amazon Web Services Secrets Manager.

", - "GetApiKeyCredentialProviderResponse$apiKeySecretArn": "

The Amazon Resource Name (ARN) of the API key secret in Amazon Web Services Secrets Manager.

", - "GetOauth2CredentialProviderResponse$clientSecretArn": "

The Amazon Resource Name (ARN) of the client secret in Amazon Web Services Secrets Manager.

", - "StripePrivyConfigurationOutput$appSecretArn": null, - "StripePrivyConfigurationOutput$authorizationPrivateKeyArn": null, - "UpdateApiKeyCredentialProviderResponse$apiKeySecretArn": "

The Amazon Resource Name (ARN) of the API key secret in Amazon Web Services Secrets Manager.

", - "UpdateOauth2CredentialProviderResponse$clientSecretArn": "

The Amazon Resource Name (ARN) of the client secret in Amazon Web Services Secrets Manager.

" - } - }, - "SecretArn": { - "base": null, - "refs": { - "Secret$secretArn": "

The Amazon Resource Name (ARN) of the secret in Amazon Web Services Secrets Manager.

" - } - }, - "SecretIdType": { - "base": null, - "refs": { - "SecretReference$secretId": "

The ID of the Amazon Web Services Secrets Manager secret that stores the secret value.

" - } - }, - "SecretJsonKeyType": { - "base": null, - "refs": { - "CoinbaseCdpConfigurationOutput$apiKeySecretJsonKey": "

The JSON key used to extract the API key secret value from the Amazon Web Services Secrets Manager secret.

", - "CoinbaseCdpConfigurationOutput$walletSecretJsonKey": "

The JSON key used to extract the wallet secret value from the Amazon Web Services Secrets Manager secret.

", - "CreateApiKeyCredentialProviderResponse$apiKeySecretJsonKey": "

The JSON key used to extract the API key value from the Amazon Web Services Secrets Manager secret.

", - "CreateOauth2CredentialProviderResponse$clientSecretJsonKey": "

The JSON key used to extract the client secret value from the Amazon Web Services Secrets Manager secret.

", - "GetApiKeyCredentialProviderResponse$apiKeySecretJsonKey": "

The JSON key used to extract the API key value from the Amazon Web Services Secrets Manager secret.

", - "GetOauth2CredentialProviderResponse$clientSecretJsonKey": "

The JSON key used to extract the client secret value from the Amazon Web Services Secrets Manager secret.

", - "SecretReference$jsonKey": "

The JSON key used to extract the secret value from the Amazon Web Services Secrets Manager secret.

", - "StripePrivyConfigurationOutput$appSecretJsonKey": "

The JSON key used to extract the app secret value from the Amazon Web Services Secrets Manager secret.

", - "StripePrivyConfigurationOutput$authorizationPrivateKeyJsonKey": "

The JSON key used to extract the authorization private key value from the Amazon Web Services Secrets Manager secret.

", - "UpdateApiKeyCredentialProviderResponse$apiKeySecretJsonKey": "

The JSON key used to extract the API key value from the Amazon Web Services Secrets Manager secret.

", - "UpdateOauth2CredentialProviderResponse$clientSecretJsonKey": "

The JSON key used to extract the client secret value from the Amazon Web Services Secrets Manager secret.

" - } - }, - "SecretReference": { - "base": "

Contains a reference to a secret stored in Amazon Web Services Secrets Manager.

", - "refs": { - "AtlassianOauth2ProviderConfigInput$clientSecretConfig": "

A reference to the Amazon Web Services Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when clientSecretSource is set to EXTERNAL.

", - "CoinbaseCdpConfigurationInput$apiKeySecretConfig": "

A reference to the Amazon Web Services Secrets Manager secret that stores the API key secret. This includes the secret ID and the JSON key used to extract the API key secret value from the secret. Required when apiKeySecretSource is set to EXTERNAL.

", - "CoinbaseCdpConfigurationInput$walletSecretConfig": "

A reference to the Amazon Web Services Secrets Manager secret that stores the wallet secret. This includes the secret ID and the JSON key used to extract the wallet secret value from the secret. Required when walletSecretSource is set to EXTERNAL.

", - "CreateApiKeyCredentialProviderRequest$apiKeySecretConfig": "

A reference to the Amazon Web Services Secrets Manager secret that stores the API key. This includes the secret ID and the JSON key used to extract the API key value from the secret. Required when apiKeySecretSource is set to EXTERNAL.

", - "CustomOauth2ProviderConfigInput$clientSecretConfig": "

A reference to the Amazon Web Services Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when clientSecretSource is set to EXTERNAL.

", - "GithubOauth2ProviderConfigInput$clientSecretConfig": "

A reference to the Amazon Web Services Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when clientSecretSource is set to EXTERNAL.

", - "GoogleOauth2ProviderConfigInput$clientSecretConfig": "

A reference to the Amazon Web Services Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when clientSecretSource is set to EXTERNAL.

", - "IncludedOauth2ProviderConfigInput$clientSecretConfig": "

A reference to the Amazon Web Services Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when clientSecretSource is set to EXTERNAL.

", - "LinkedinOauth2ProviderConfigInput$clientSecretConfig": "

A reference to the Amazon Web Services Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when clientSecretSource is set to EXTERNAL.

", - "MicrosoftOauth2ProviderConfigInput$clientSecretConfig": "

A reference to the Amazon Web Services Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when clientSecretSource is set to EXTERNAL.

", - "SalesforceOauth2ProviderConfigInput$clientSecretConfig": "

A reference to the Amazon Web Services Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when clientSecretSource is set to EXTERNAL.

", - "SlackOauth2ProviderConfigInput$clientSecretConfig": "

A reference to the Amazon Web Services Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when clientSecretSource is set to EXTERNAL.

", - "StripePrivyConfigurationInput$appSecretConfig": "

A reference to the Amazon Web Services Secrets Manager secret that stores the app secret. This includes the secret ID and the JSON key used to extract the app secret value from the secret. Required when appSecretSource is set to EXTERNAL.

", - "StripePrivyConfigurationInput$authorizationPrivateKeyConfig": "

A reference to the Amazon Web Services Secrets Manager secret that stores the authorization private key. This includes the secret ID and the JSON key used to extract the authorization private key value from the secret. Required when authorizationPrivateKeySource is set to EXTERNAL.

", - "UpdateApiKeyCredentialProviderRequest$apiKeySecretConfig": "

A reference to the Amazon Web Services Secrets Manager secret that stores the API key. This includes the secret ID and the JSON key used to extract the API key value from the secret. Required when apiKeySecretSource is set to EXTERNAL.

" - } - }, - "SecretSourceType": { - "base": null, - "refs": { - "AtlassianOauth2ProviderConfigInput$clientSecretSource": "

The source type of the client secret for the Atlassian OAuth2 provider. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.

", - "CoinbaseCdpConfigurationInput$apiKeySecretSource": "

The source type of the API key secret for the Coinbase Developer Platform. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.

", - "CoinbaseCdpConfigurationInput$walletSecretSource": "

The source type of the wallet secret for the Coinbase Developer Platform. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.

", - "CoinbaseCdpConfigurationOutput$apiKeySecretSource": "

The source type of the API key secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager.

", - "CoinbaseCdpConfigurationOutput$walletSecretSource": "

The source type of the wallet secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager.

", - "CreateApiKeyCredentialProviderRequest$apiKeySecretSource": "

The source type of the API key secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.

", - "CreateApiKeyCredentialProviderResponse$apiKeySecretSource": "

The source type of the API key secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager.

", - "CreateOauth2CredentialProviderResponse$clientSecretSource": "

The source type of the client secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager.

", - "CustomOauth2ProviderConfigInput$clientSecretSource": "

The source type of the client secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.

", - "GetApiKeyCredentialProviderResponse$apiKeySecretSource": "

The source type of the API key secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager.

", - "GetOauth2CredentialProviderResponse$clientSecretSource": "

The source type of the client secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager.

", - "GithubOauth2ProviderConfigInput$clientSecretSource": "

The source type of the client secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.

", - "GoogleOauth2ProviderConfigInput$clientSecretSource": "

The source type of the client secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.

", - "IncludedOauth2ProviderConfigInput$clientSecretSource": "

The source type of the client secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.

", - "LinkedinOauth2ProviderConfigInput$clientSecretSource": "

The source type of the client secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.

", - "MicrosoftOauth2ProviderConfigInput$clientSecretSource": "

The source type of the client secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.

", - "SalesforceOauth2ProviderConfigInput$clientSecretSource": "

The source type of the client secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.

", - "SlackOauth2ProviderConfigInput$clientSecretSource": "

The source type of the client secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.

", - "StripePrivyConfigurationInput$appSecretSource": "

The source type of the app secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.

", - "StripePrivyConfigurationInput$authorizationPrivateKeySource": "

The source type of the authorization private key. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.

", - "StripePrivyConfigurationOutput$appSecretSource": "

The source type of the app secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager.

", - "StripePrivyConfigurationOutput$authorizationPrivateKeySource": "

The source type of the authorization private key. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager.

", - "UpdateApiKeyCredentialProviderRequest$apiKeySecretSource": "

The source type of the API key secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.

", - "UpdateApiKeyCredentialProviderResponse$apiKeySecretSource": "

The source type of the API key secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager.

", - "UpdateOauth2CredentialProviderResponse$clientSecretSource": "

The source type of the client secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager.

" - } - }, - "SecretsManagerLocation": { - "base": "

The Amazon Web Services Secrets Manager location configuration.

", - "refs": { - "CertificateLocation$secretsManager": "

The Amazon Web Services Secrets Manager location of the certificate.

" - } - }, - "SecurityGroupId": { - "base": null, - "refs": { - "SecurityGroups$member": null - } - }, - "SecurityGroupIdentifier": { - "base": null, - "refs": { - "SecurityGroupIds$member": null - } - }, - "SecurityGroupIds": { - "base": null, - "refs": { - "ManagedVpcResource$securityGroupIds": "

The security group IDs to associate with the VPC Lattice resource gateway. If not specified, the default security group for the VPC is used.

" - } - }, - "SecurityGroups": { - "base": null, - "refs": { - "VpcConfig$securityGroups": "

The security groups associated with the VPC configuration.

" - } - }, - "SelfManagedConfiguration": { - "base": "

A configuration for a self-managed memory strategy.

", - "refs": { - "StrategyConfiguration$selfManagedConfiguration": "

Self-managed configuration settings.

" - } - }, - "SelfManagedConfigurationInput": { - "base": "

Input configuration for a self-managed memory strategy.

", - "refs": { - "CustomConfigurationInput$selfManagedConfiguration": "

The self managed configuration for a custom memory strategy.

" - } - }, - "SelfManagedConfigurationInputHistoricalContextWindowSizeInteger": { - "base": null, - "refs": { - "SelfManagedConfigurationInput$historicalContextWindowSize": "

Number of historical messages to include in processing context.

" - } - }, - "SelfManagedLatticeResource": { - "base": "

Configuration for a self-managed VPC Lattice resource. You create and manage the VPC Lattice resource gateway and resource configuration, then provide the resource configuration identifier.

", - "refs": { - "PrivateEndpoint$selfManagedLatticeResource": "

Configuration for connecting to a private resource using a self-managed VPC Lattice resource configuration.

" - } - }, - "SemanticConsolidationOverride": { - "base": "

Contains semantic consolidation override configuration.

", - "refs": { - "CustomConsolidationConfiguration$semanticConsolidationOverride": "

The semantic consolidation override configuration.

" - } - }, - "SemanticExtractionOverride": { - "base": "

Contains semantic extraction override configuration.

", - "refs": { - "CustomExtractionConfiguration$semanticExtractionOverride": "

The semantic extraction override configuration.

" - } - }, - "SemanticMemoryStrategyInput": { - "base": "

Input for creating a semantic memory strategy.

", - "refs": { - "MemoryStrategyInput$semanticMemoryStrategy": "

Input for creating a semantic memory strategy.

" - } - }, - "SemanticOverrideConfigurationInput": { - "base": "

Input for semantic override configuration in a memory strategy.

", - "refs": { - "CustomConfigurationInput$semanticOverride": "

The semantic override configuration for a custom memory strategy.

" - } - }, - "SemanticOverrideConsolidationConfigurationInput": { - "base": "

Input for semantic override consolidation configuration in a memory strategy.

", - "refs": { - "CustomConsolidationConfigurationInput$semanticConsolidationOverride": "

The semantic consolidation override configuration input.

", - "SemanticOverrideConfigurationInput$consolidation": "

The consolidation configuration for a semantic override.

" - } - }, - "SemanticOverrideExtractionConfigurationInput": { - "base": "

Input for semantic override extraction configuration in a memory strategy.

", - "refs": { - "CustomExtractionConfigurationInput$semanticExtractionOverride": "

The semantic extraction override configuration input.

", - "SemanticOverrideConfigurationInput$extraction": "

The extraction configuration for a semantic override.

" - } - }, - "SensitiveJson": { - "base": null, - "refs": { - "DatasetExampleList$member": null, - "HarnessInlineFunctionConfig$inputSchema": "

JSON Schema describing the tool's input parameters.

", - "InlineExamplesSourceExamplesList$member": null, - "UpdateDatasetExamplesRequestExamplesList$member": null - } - }, - "SensitiveText": { - "base": null, - "refs": { - "HarnessSystemContentBlock$text": "

The text content of the system prompt block.

" - } - }, - "ServerDefinition": { - "base": "

The server definition for an MCP descriptor. Contains the schema version and inline content for the MCP server configuration.

", - "refs": { - "McpDescriptor$server": "

The MCP server definition, containing the server configuration and schema as defined by the MCP protocol specification.

", - "UpdatedServerDefinition$optionalValue": "

The updated server definition value.

" - } - }, - "ServerProtocol": { - "base": null, - "refs": { - "ProtocolConfiguration$serverProtocol": "

The server protocol for the agent runtime. This field specifies which protocol the agent runtime uses to communicate with clients.

" - } - }, - "ServiceException": { - "base": "

An internal error occurred.

", - "refs": {} - }, - "ServiceName": { - "base": null, - "refs": { - "CloudWatchLogsInputConfigServiceNamesList$member": null - } - }, - "ServiceQuotaExceededException": { - "base": "

This exception is thrown when a request is made beyond the service quota

", - "refs": {} - }, - "SessionConfig": { - "base": "

The configuration that defines how agent sessions are detected and when they are considered complete for evaluation.

", - "refs": { - "Rule$sessionConfig": "

The session configuration that defines timeout settings for detecting when agent sessions are complete and ready for evaluation.

" - } - }, - "SessionConfigSessionTimeoutMinutesInteger": { - "base": null, - "refs": { - "SessionConfig$sessionTimeoutMinutes": "

The number of minutes of inactivity after which an agent session is considered complete and ready for evaluation. Default is 15 minutes.

" - } - }, - "SessionConfiguration": { - "base": "

The session configuration for an MCP gateway. This structure defines settings that control session behavior.

", - "refs": { - "MCPGatewayConfiguration$sessionConfiguration": "

The session configuration for the MCP gateway. This configuration controls session behavior, including session timeout settings.

" - } - }, - "SessionConfigurationSessionTimeoutInSecondsInteger": { - "base": null, - "refs": { - "SessionConfiguration$sessionTimeoutInSeconds": "

The session timeout in seconds. After this timeout, the session expires and subsequent requests to this session will receive an error. The minimum value is 900 seconds (15 minutes), the maximum value is 28800 seconds (8 hours), and the default value is 3600 seconds (1 hour).

" - } - }, - "SessionStorageConfiguration": { - "base": "

Configuration for a session storage filesystem mounted into the AgentCore Runtime. Session storage provides persistent storage that is preserved across AgentCore Runtime session invocations.

", - "refs": { - "FilesystemConfiguration$sessionStorage": "

Configuration for session storage. Session storage provides persistent storage that is preserved across AgentCore Runtime session invocations.

" - } - }, - "SetTokenVaultCMKRequest": { - "base": null, - "refs": {} - }, - "SetTokenVaultCMKResponse": { - "base": null, - "refs": {} - }, - "SigningAlgorithm": { - "base": null, - "refs": { - "PrivateKeyJwtConfig$signingAlgorithm": "

The algorithm used to sign the JWT client assertion. Valid values are RS256, PS256, and ES256.

" - } - }, - "SkillDefinition": { - "base": "

The structured skill definition with schema version and content.

", - "refs": { - "AgentSkillsDescriptor$skillDefinition": "

The structured skill definition with schema version and content.

", - "UpdatedSkillDefinition$optionalValue": "

The updated skill definition value.

" - } - }, - "SkillMdDefinition": { - "base": "

The skill markdown definition for an agent skills descriptor.

", - "refs": { - "AgentSkillsDescriptor$skillMd": "

The optional skill markdown definition describing the agent's skills in a human-readable format.

", - "UpdatedSkillMdDefinition$optionalValue": "

The updated skill markdown definition value.

" - } - }, - "SlackOauth2ProviderConfigInput": { - "base": "

Input configuration for a Slack OAuth2 provider.

", - "refs": { - "Oauth2ProviderConfigInput$slackOauth2ProviderConfig": "

The configuration for a Slack OAuth2 provider.

" - } - }, - "SlackOauth2ProviderConfigOutput": { - "base": "

Output configuration for a Slack OAuth2 provider.

", - "refs": { - "Oauth2ProviderConfigOutput$slackOauth2ProviderConfig": "

The output configuration for a Slack OAuth2 provider.

" - } - }, - "StartPolicyGenerationRequest": { - "base": null, - "refs": {} - }, - "StartPolicyGenerationResponse": { - "base": null, - "refs": {} - }, - "Statement": { - "base": null, - "refs": { - "CedarPolicy$statement": "

The Cedar policy statement that defines the authorization logic. This statement follows Cedar syntax and specifies principals, actions, resources, and conditions that determine when access should be allowed or denied.

", - "PolicyStatement$statement": "

The body of the AgentCore policy statement. Contains the policy logic, which can be a Cedar policy or a guardrails definition.

" - } - }, - "StaticOverride": { - "base": "

A static configuration bundle override.

", - "refs": { - "ConfigurationBundleAction$staticOverride": "

A static configuration bundle override that applies a single bundle version to all matching requests.

" - } - }, - "StaticOverrideBundleVersionString": { - "base": null, - "refs": { - "StaticOverride$bundleVersion": "

The version of the configuration bundle to apply.

" - } - }, - "StaticRoute": { - "base": "

A static route to a single gateway target.

", - "refs": { - "RouteToTargetAction$staticRoute": "

A static route that sends all matching requests to a single target.

" - } - }, - "Status": { - "base": null, - "refs": { - "CreateOauth2CredentialProviderResponse$status": "

The current status of the OAuth2 credential provider.

", - "GetOauth2CredentialProviderResponse$status": "

The current status of the OAuth2 credential provider.

", - "UpdateOauth2CredentialProviderResponse$status": "

The current status of the updated OAuth2 credential provider.

" - } - }, - "StatusReason": { - "base": null, - "refs": { - "StatusReasons$member": null - } - }, - "StatusReasons": { - "base": null, - "refs": { - "CreateGatewayResponse$statusReasons": "

The reasons for the current status of the gateway.

", - "CreateGatewayTargetResponse$statusReasons": "

The reasons for the current status of the target.

", - "DeleteGatewayResponse$statusReasons": "

The reasons for the current status of the gateway deletion.

", - "DeleteGatewayTargetResponse$statusReasons": "

The reasons for the current status of the gateway target deletion.

", - "GatewayTarget$statusReasons": "

The status reasons for the target status.

", - "GetGatewayResponse$statusReasons": "

The reasons for the current status of the gateway.

", - "GetGatewayTargetResponse$statusReasons": "

The reasons for the current status of the gateway target.

", - "UpdateGatewayResponse$statusReasons": "

The reasons for the current status of the updated gateway.

", - "UpdateGatewayTargetResponse$statusReasons": "

The reasons for the current status of the updated gateway target.

" - } - }, - "StickinessConfiguration": { - "base": "

The configuration for session-sticky routing to a target. Session stickiness routes requests that share a session identifier to the same target.

", - "refs": { - "PassthroughTargetConfiguration$stickinessConfiguration": "

The session stickiness configuration for the passthrough target. This configuration routes requests within the same session to the same target.

" - } - }, - "StickinessConfigurationIdentifierString": { - "base": null, - "refs": { - "StickinessConfiguration$identifier": "

The expression that identifies where to extract the session identifier from the request (for example, $context.header.x-session-id).

" - } - }, - "StickinessTimeout": { - "base": null, - "refs": { - "StickinessConfiguration$timeout": "

The session stickiness timeout, in seconds. After this duration of inactivity, the session affinity expires. Valid values range from 1 to 86400.

" - } - }, - "StrategyConfiguration": { - "base": "

Contains configuration information for a memory strategy.

", - "refs": { - "MemoryStrategy$configuration": "

The configuration of the memory strategy.

" - } - }, - "StreamDeliveryResource": { - "base": "

Supported stream delivery resource types.

", - "refs": { - "StreamDeliveryResourcesList$member": null - } - }, - "StreamDeliveryResources": { - "base": "

Configuration for streaming memory record data to external resources.

", - "refs": { - "CreateMemoryInput$streamDeliveryResources": "

Configuration for streaming memory record data to external resources.

", - "Memory$streamDeliveryResources": "

Configuration for streaming memory record data to external resources.

", - "UpdateMemoryInput$streamDeliveryResources": "

Configuration for streaming memory record data to external resources.

" - } - }, - "StreamDeliveryResourcesList": { - "base": null, - "refs": { - "StreamDeliveryResources$resources": "

List of stream delivery resource configurations.

" - } - }, - "StreamingConfiguration": { - "base": "

The streaming configuration for an MCP gateway. This structure defines settings that control response streaming behavior.

", - "refs": { - "MCPGatewayConfiguration$streamingConfiguration": "

The streaming configuration for the MCP gateway. This configuration controls whether response streaming is enabled for the gateway.

" - } - }, - "String": { - "base": null, - "refs": { - "ApiGatewayTargetConfiguration$restApiId": "

The ID of the API Gateway REST API.

", - "ApiGatewayTargetConfiguration$stage": "

The ID of the stage of the REST API to add as a target.

", - "ApiGatewayToolFilter$filterPath": "

Resource path to match in the REST API. Supports exact paths (for example, /pets) or wildcard paths (for example, /pets/* to match all paths under /pets). Must match existing paths in the REST API.

", - "ApiGatewayToolOverride$name": "

The name of tool. Identifies the tool in the Model Context Protocol.

", - "ApiGatewayToolOverride$description": "

The description of the tool. Provides information about the purpose and usage of the tool. If not provided, uses the description from the API's OpenAPI specification.

", - "ApiGatewayToolOverride$path": "

Resource path in the REST API (e.g., /pets). Must explicitly match an existing path in the REST API.

", - "CategoricalScaleDefinition$definition": "

The description that explains what this categorical rating represents and when it should be used.

", - "ConcurrentModificationException$message": null, - "ConnectorParameterOverride$path": "

A JSON Pointer path identifying the parameter (for example, /numberOfResults or /filter).

", - "ConnectorParameterOverride$description": "

An agent-facing description override for this parameter.

", - "CreateOauth2CredentialProviderResponse$callbackUrl": "

Callback URL to register on the OAuth2 credential provider as an allowed callback URL. This URL is where the OAuth2 authorization server redirects users after they complete the authorization flow.

", - "CreateOnlineEvaluationConfigResponse$failureReason": "

The reason for failure if the online evaluation configuration creation or execution failed.

", - "CustomParameterMap$key": null, - "CustomParameterMap$value": null, - "DatasetSummary$description": "

The description of the dataset.

", - "DecryptionFailure$message": null, - "DeleteMemoryStrategyInput$memoryStrategyId": "

The unique identifier of the memory strategy to delete.

", - "EnabledConnectors$member": null, - "EncryptionFailure$message": null, - "EpisodicConsolidationOverride$modelId": "

The model ID used for the consolidation step of the episodic memory strategy.

", - "EpisodicExtractionOverride$modelId": "

The model ID used for the extraction step of the episodic memory strategy.

", - "EpisodicOverrideConsolidationConfigurationInput$modelId": "

The model ID to use for the consolidation step of the episodic memory strategy.

", - "EpisodicOverrideExtractionConfigurationInput$modelId": "

The model ID to use for the extraction step of the episodic memory strategy.

", - "EpisodicOverrideReflectionConfigurationInput$modelId": "

The model ID to use for the reflection step of the episodic memory strategy.

", - "EpisodicReflectionOverride$modelId": "

The model ID used for the reflection step of the episodic memory strategy.

", - "Finding$description": "

A human-readable description of the finding. This provides detailed information about the issue, recommendation, or validation result to help users understand and address the finding.

", - "GetAgentRuntimeEndpointResponse$failureReason": "

The reason for failure if the AgentCore Runtime endpoint is in a failed state.

", - "GetAgentRuntimeResponse$failureReason": "

The reason for failure if the AgentCore Runtime is in a failed state.

", - "GetBrowserResponse$failureReason": "

The reason for failure if the browser is in a failed state.

", - "GetCodeInterpreterResponse$failureReason": "

The reason for failure if the code interpreter is in a failed state.

", - "GetDatasetResponse$description": "

The description of the dataset.

", - "GetDatasetResponse$failureReason": "

Populated when status is CREATE_FAILED, UPDATE_FAILED, or DELETE_FAILED. Describes the reason for the failure.

", - "GetOauth2CredentialProviderResponse$callbackUrl": "

Callback URL to register on the OAuth2 credential provider as an allowed callback URL. This URL is where the OAuth2 authorization server redirects users after they complete the authorization flow.

", - "GetOauth2CredentialProviderResponse$failureReason": "

The reason for failure if the OAuth2 credential provider is in a failed state.

", - "GetOnlineEvaluationConfigResponse$failureReason": "

The reason for failure if the online evaluation configuration execution failed.

", - "GetPolicyGenerationResponse$findings": "

The findings and results from the policy generation process. This includes any issues, recommendations, validation results, or insights from the generated policies.

", - "GetPolicyGenerationSummaryResponse$findings": "

The findings from the policy generation process, if available.

", - "GetRegistryRecordResponse$statusReason": "

The reason for the current status, typically set when the status is a failure state.

", - "GetRegistryResponse$statusReason": "

The reason for the current status, typically set when the status is a failure state.

", - "Harness$failureReason": "

Reason why create or update operations fail.

", - "HarnessAgentCoreMemoryConfiguration$actorId": "

The actor ID for memory operations.

", - "HarnessAgentCoreMemoryRetrievalConfig$strategyId": "

The ID of the retrieval strategy to use.

", - "HarnessAgentCoreMemoryRetrievalConfigs$key": null, - "HarnessAgentCoreRuntimeEnvironment$agentRuntimeName": "

The name of the underlying AgentCore Runtime.

", - "HarnessAgentCoreRuntimeEnvironment$agentRuntimeId": "

The ID of the underlying AgentCore Runtime.

", - "HarnessEndpoint$failureReason": "

The reason the endpoint's last create or update operation failed.

", - "HarnessSkillGitAuth$username": "

Username for authentication. Defaults to 'oauth2' if not specified.

", - "HarnessSkillGitSource$path": "

Subdirectory within the repository containing the skill.

", - "HarnessSummarizationConfiguration$summarizationSystemPrompt": "

The system prompt used for generating summaries.

", - "HarnessVersionSummary$failureReason": "

Reason why the create or update operation for this harness version failed.

", - "InvocationConfiguration$payloadDeliveryBucketName": "

The S3 bucket name for event payload delivery.

", - "ListApiKeyCredentialProvidersRequest$nextToken": "

Pagination token.

", - "ListApiKeyCredentialProvidersResponse$nextToken": "

Pagination token for the next page of results.

", - "ListConfigurationBundleVersionsRequest$nextToken": "

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.

", - "ListConfigurationBundleVersionsResponse$nextToken": "

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.

", - "ListConfigurationBundlesRequest$nextToken": "

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.

", - "ListConfigurationBundlesResponse$nextToken": "

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.

", - "ListDatasetExamplesResponse$nextToken": "

The token for the next page of results, or null if there are no more results.

", - "ListDatasetVersionsRequest$nextToken": "

The token for the next page of results.

", - "ListDatasetVersionsResponse$nextToken": "

The token for the next page of results, or null if there are no more results.

", - "ListDatasetsResponse$nextToken": "

The token for the next page of results, or null if there are no more results.

", - "ListEvaluatorsRequest$nextToken": "

The pagination token from a previous request to retrieve the next page of results.

", - "ListEvaluatorsResponse$nextToken": "

The pagination token to use in a subsequent request to retrieve the next page of results.

", - "ListMemoriesInput$nextToken": "

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

", - "ListMemoriesOutput$nextToken": "

A token to retrieve the next page of results.

", - "ListOauth2CredentialProvidersRequest$nextToken": "

Pagination token.

", - "ListOauth2CredentialProvidersResponse$nextToken": "

Pagination token for the next page of results.

", - "ListOnlineEvaluationConfigsRequest$nextToken": "

The pagination token from a previous request to retrieve the next page of results.

", - "ListOnlineEvaluationConfigsResponse$nextToken": "

The pagination token to use in a subsequent request to retrieve the next page of results.

", - "ListPaymentCredentialProvidersRequest$nextToken": "

Pagination token.

", - "ListPaymentCredentialProvidersResponse$nextToken": "

Pagination token for the next page of results.

", - "ListWorkloadIdentitiesRequest$nextToken": "

Pagination token.

", - "ListWorkloadIdentitiesResponse$nextToken": "

Pagination token for the next page of results.

", - "Memory$failureReason": "

The reason for failure if the memory is in a failed state.

", - "ModifyMemoryStrategyInput$memoryStrategyId": "

The unique identifier of the memory strategy to modify.

", - "NumericalScaleDefinition$definition": "

The description that explains what this numerical rating represents and when it should be used.

", - "OnlineEvaluationConfigSummary$failureReason": "

The reason for failure if the online evaluation configuration execution failed.

", - "PolicyGeneration$findings": "

Findings and insights from this policy generation process.

", - "PolicyGenerationSummary$findings": "

Findings and insights from this policy generation process.

", - "PolicyStatusReasons$member": null, - "RegistrySummary$statusReason": "

The reason for the current status, typically set when the status is a failure state.

", - "RequiredProperties$member": null, - "ResourceLimitExceededException$message": null, - "SchemaDefinition$description": "

The description of the schema definition. This description provides information about the purpose and usage of the schema.

", - "SchemaProperties$key": null, - "ScopeList$member": null, - "SemanticConsolidationOverride$modelId": "

The model ID to use for semantic consolidation.

", - "SemanticExtractionOverride$modelId": "

The model ID to use for semantic extraction.

", - "SemanticOverrideConsolidationConfigurationInput$modelId": "

The model ID to use for semantic consolidation.

", - "SemanticOverrideExtractionConfigurationInput$modelId": "

The model ID to use for semantic extraction.

", - "ServiceException$message": null, - "StartPolicyGenerationResponse$findings": "

Initial findings from the policy generation process.

", - "SummaryConsolidationOverride$modelId": "

The model ID to use for summary consolidation.

", - "SummaryOverrideConsolidationConfigurationInput$modelId": "

The model ID to use for summary consolidation.

", - "SystemManagedBlock$managedBy": "

The identifier of the system or process that manages this rule.

", - "ThrottledException$message": null, - "ToolDefinition$name": "

The name of the tool. This name identifies the tool in the Model Context Protocol.

", - "ToolDefinition$description": "

The description of the tool. This description provides information about the purpose and usage of the tool.

", - "UpdateOauth2CredentialProviderResponse$callbackUrl": "

Callback URL to register on the OAuth2 credential provider as an allowed callback URL. This URL is where the OAuth2 authorization server redirects users after they complete the authorization flow.

", - "UpdateOnlineEvaluationConfigResponse$failureReason": "

The reason for failure if the online evaluation configuration update or execution failed.

", - "UpdateRegistryRecordResponse$statusReason": "

The reason for the current status of the updated registry record.

", - "UpdateRegistryRecordStatusResponse$statusReason": "

The reason for the status change.

", - "UpdateRegistryResponse$statusReason": "

The reason for the current status of the updated registry.

", - "UserPreferenceConsolidationOverride$modelId": "

The model ID to use for user preference consolidation.

", - "UserPreferenceExtractionOverride$modelId": "

The model ID to use for user preference extraction.

", - "UserPreferenceOverrideConsolidationConfigurationInput$modelId": "

The model ID to use for user preference consolidation.

", - "UserPreferenceOverrideExtractionConfigurationInput$modelId": "

The model ID to use for user preference extraction.

", - "ValidationException$message": null, - "ValidationExceptionField$name": "

The name of the field.

", - "ValidationExceptionField$message": "

A message describing why this field failed validation.

", - "VersionCreatedBySource$name": "

The name of the source (for example, user, optimization-job, or system).

", - "VersionCreatedBySource$arn": "

The Amazon Resource Name (ARN) of the source, if applicable (for example, a user ARN or optimization job ARN).

", - "VersionFilter$createdByName": "

Filter by creation source name.

" - } - }, - "StringListValidation": { - "base": "

Validation for STRINGLIST fields.

", - "refs": { - "Validation$stringListValidation": null - } - }, - "StringListValidationMaxItemsInteger": { - "base": null, - "refs": { - "StringListValidation$maxItems": "

Maximum number of items in the string list.

" - } - }, - "StringValidation": { - "base": "

Validation for STRING fields.

", - "refs": { - "Validation$stringValidation": null - } - }, - "StripePrivyAppIdType": { - "base": null, - "refs": { - "StripePrivyConfigurationInput$appId": "

The app ID provided by Privy.

", - "StripePrivyConfigurationOutput$appId": "

The app ID provided by Privy.

" - } - }, - "StripePrivyAuthorizationIdType": { - "base": null, - "refs": { - "StripePrivyConfigurationInput$authorizationId": "

The authorization ID for the Stripe Privy integration.

", - "StripePrivyConfigurationOutput$authorizationId": "

The authorization ID for the Stripe Privy integration.

" - } - }, - "StripePrivyConfigurationInput": { - "base": "

Stripe Privy configuration — credentials provided by Stripe and Privy.

", - "refs": { - "PaymentProviderConfigurationInput$stripePrivyConfiguration": "

The Stripe Privy configuration.

" - } - }, - "StripePrivyConfigurationOutput": { - "base": "

Stripe Privy configuration output with secret ARNs.

", - "refs": { - "PaymentProviderConfigurationOutput$stripePrivyConfiguration": "

The Stripe Privy configuration.

" - } - }, - "SubmitRegistryRecordForApprovalRequest": { - "base": null, - "refs": {} - }, - "SubmitRegistryRecordForApprovalResponse": { - "base": null, - "refs": {} - }, - "SubnetId": { - "base": null, - "refs": { - "SubnetIds$member": null, - "Subnets$member": null - } - }, - "SubnetIds": { - "base": null, - "refs": { - "ManagedVpcResource$subnetIds": "

The subnet IDs within the VPC where the VPC Lattice resource gateway is placed.

" - } - }, - "Subnets": { - "base": null, - "refs": { - "VpcConfig$subnets": "

The subnets associated with the VPC configuration.

" - } - }, - "SummaryConsolidationOverride": { - "base": "

Contains summary consolidation override configuration.

", - "refs": { - "CustomConsolidationConfiguration$summaryConsolidationOverride": "

The summary consolidation override configuration.

" - } - }, - "SummaryMemoryStrategyInput": { - "base": "

Input for creating a summary memory strategy.

", - "refs": { - "MemoryStrategyInput$summaryMemoryStrategy": "

Input for creating a summary memory strategy.

" - } - }, - "SummaryOverrideConfigurationInput": { - "base": "

Input for summary override configuration in a memory strategy.

", - "refs": { - "CustomConfigurationInput$summaryOverride": "

The summary override configuration for a custom memory strategy.

" - } - }, - "SummaryOverrideConsolidationConfigurationInput": { - "base": "

Input for summary override consolidation configuration in a memory strategy.

", - "refs": { - "CustomConsolidationConfigurationInput$summaryConsolidationOverride": "

The summary consolidation override configuration input.

", - "SummaryOverrideConfigurationInput$consolidation": "

The consolidation configuration for a summary override.

" - } - }, - "SynchronizationConfiguration": { - "base": "

Configuration for synchronizing registry record metadata from an external source.

", - "refs": { - "CreateRegistryRecordRequest$synchronizationConfiguration": "

The configuration for synchronizing registry record metadata from an external source, such as a URL-based MCP server.

", - "GetRegistryRecordResponse$synchronizationConfiguration": "

The configuration for synchronizing registry record metadata from an external source.

", - "UpdateRegistryRecordResponse$synchronizationConfiguration": "

The synchronization configuration of the updated registry record.

", - "UpdatedSynchronizationConfiguration$optionalValue": "

The updated synchronization configuration value.

" - } - }, - "SynchronizationType": { - "base": null, - "refs": { - "CreateRegistryRecordRequest$synchronizationType": "

The type of synchronization to use for keeping the record metadata up to date from an external source. Possible values include FROM_URL and NONE.

", - "GetRegistryRecordResponse$synchronizationType": "

The type of synchronization used for this record.

", - "UpdateRegistryRecordResponse$synchronizationType": "

The synchronization type of the updated registry record.

", - "UpdatedSynchronizationType$optionalValue": "

The updated synchronization type value.

" - } - }, - "SynchronizeGatewayTargetsRequest": { - "base": null, - "refs": {} - }, - "SynchronizeGatewayTargetsResponse": { - "base": null, - "refs": {} - }, - "SystemManagedBlock": { - "base": "

System-managed metadata for rules created by automated processes such as A/B tests.

", - "refs": { - "CreateGatewayRuleResponse$system": "

System-managed metadata for rules created by automated processes.

", - "GatewayRuleDetail$system": "

System-managed metadata for rules created by automated processes.

", - "GetGatewayRuleResponse$system": "

System-managed metadata for rules created by automated processes.

", - "UpdateGatewayRuleResponse$system": "

System-managed metadata for rules created by automated processes.

" - } - }, - "TagKey": { - "base": null, - "refs": { - "TagKeyList$member": null, - "TagsMap$key": null - } - }, - "TagKeyList": { - "base": null, - "refs": { - "UntagResourceRequest$tagKeys": "

The tag keys of the tags to remove from the resource.

" - } - }, - "TagResourceRequest": { - "base": null, - "refs": {} - }, - "TagResourceResponse": { - "base": null, - "refs": {} - }, - "TagValue": { - "base": null, - "refs": { - "TagsMap$value": null - } - }, - "TaggableResourcesArn": { - "base": null, - "refs": { - "ListTagsForResourceRequest$resourceArn": "

The Amazon Resource Name (ARN) of the resource for which you want to list tags.

", - "TagResourceRequest$resourceArn": "

The Amazon Resource Name (ARN) of the resource that you want to tag.

", - "UntagResourceRequest$resourceArn": "

The Amazon Resource Name (ARN) of the resource that you want to untag.

" - } - }, - "TagsMap": { - "base": null, - "refs": { - "CreateAgentRuntimeEndpointRequest$tags": "

A map of tag keys and values to assign to the agent runtime endpoint. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

", - "CreateAgentRuntimeRequest$tags": "

A map of tag keys and values to assign to the agent runtime. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

", - "CreateApiKeyCredentialProviderRequest$tags": "

A map of tag keys and values to assign to the API key credential provider. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

", - "CreateBrowserProfileRequest$tags": "

A map of tag keys and values to assign to the browser profile. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

", - "CreateBrowserRequest$tags": "

A map of tag keys and values to assign to the browser. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

", - "CreateCodeInterpreterRequest$tags": "

A map of tag keys and values to assign to the code interpreter. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

", - "CreateConfigurationBundleRequest$tags": "

A map of tag keys and values to assign to the configuration bundle. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

", - "CreateDatasetRequest$tags": "

A map of tag keys and values to assign to the dataset.

", - "CreateEvaluatorRequest$tags": "

A map of tag keys and values to assign to an AgentCore Evaluator. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

", - "CreateGatewayRequest$tags": "

A map of key-value pairs to associate with the gateway as metadata tags.

", - "CreateHarnessEndpointRequest$tags": "

Tags to apply to the endpoint resource.

", - "CreateHarnessRequest$tags": "

Tags to apply to the harness resource.

", - "CreateMemoryInput$tags": "

A map of tag keys and values to assign to an AgentCore Memory. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

", - "CreateOauth2CredentialProviderRequest$tags": "

A map of tag keys and values to assign to the OAuth2 credential provider. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

", - "CreateOnlineEvaluationConfigRequest$tags": "

A map of tag keys and values to assign to an AgentCore Online Evaluation Config. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

", - "CreatePaymentCredentialProviderRequest$tags": "

Optional tags for resource organization.

", - "CreatePaymentManagerRequest$tags": "

A map of tag keys and values to assign to the payment manager.

", - "CreatePaymentManagerResponse$tags": "

The tags associated with the created payment manager.

", - "CreatePolicyEngineRequest$tags": "

A map of tag keys and values to assign to an AgentCore Policy. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

", - "CreateWorkloadIdentityRequest$tags": "

A map of tag keys and values to assign to the workload identity. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

", - "GetDatasetResponse$tags": "

The tags associated with the dataset.

", - "GetPaymentCredentialProviderResponse$tags": "

The tags associated with the payment credential provider.

", - "GetPaymentManagerResponse$tags": "

The tags associated with the payment manager.

", - "ListTagsForResourceResponse$tags": "

The tags associated with the resource.

", - "ManagedVpcResource$tags": "

Tags to apply to the managed VPC Lattice resource gateway.

", - "TagResourceRequest$tags": "

The tags to add to the resource. A tag is a key-value pair.

" - } - }, - "TargetConfiguration": { - "base": "

The configuration for a gateway target. This structure defines how the gateway connects to and interacts with the target endpoint.

", - "refs": { - "CreateGatewayTargetRequest$targetConfiguration": "

The configuration settings for the target, including endpoint information and schema definitions.

", - "CreateGatewayTargetResponse$targetConfiguration": "

The configuration settings for the target.

", - "GatewayTarget$targetConfiguration": null, - "GetGatewayTargetResponse$targetConfiguration": null, - "UpdateGatewayTargetRequest$targetConfiguration": null, - "UpdateGatewayTargetResponse$targetConfiguration": null - } - }, - "TargetDescription": { - "base": null, - "refs": { - "CreateGatewayTargetRequest$description": "

The description of the gateway target.

", - "CreateGatewayTargetResponse$description": "

The description of the target.

", - "GatewayTarget$description": "

The description for the gateway target.

", - "GetGatewayTargetResponse$description": "

The description of the gateway target.

", - "TargetSummary$description": "

The description of the target.

", - "UpdateGatewayTargetRequest$description": "

The updated description for the gateway target.

", - "UpdateGatewayTargetResponse$description": "

The updated description of the gateway target.

" - } - }, - "TargetId": { - "base": null, - "refs": { - "CreateGatewayTargetResponse$targetId": "

The unique identifier of the created target.

", - "DeleteGatewayTargetRequest$targetId": "

The unique identifier of the gateway target to delete.

", - "DeleteGatewayTargetResponse$targetId": "

The unique identifier of the deleted gateway target.

", - "GatewayTarget$targetId": "

The target ID.

", - "GetGatewayTargetRequest$targetId": "

The unique identifier of the target to retrieve.

", - "GetGatewayTargetResponse$targetId": "

The unique identifier of the gateway target.

", - "TargetIdList$member": null, - "TargetSummary$targetId": "

The unique identifier of the target.

", - "UpdateGatewayTargetRequest$targetId": "

The unique identifier of the gateway target to update.

", - "UpdateGatewayTargetResponse$targetId": "

The unique identifier of the updated gateway target.

" - } - }, - "TargetIdList": { - "base": null, - "refs": { - "SynchronizeGatewayTargetsRequest$targetIdList": "

The target ID list.

" - } - }, - "TargetMaxResults": { - "base": null, - "refs": { - "ListGatewayTargetsRequest$maxResults": "

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.

" - } - }, - "TargetName": { - "base": null, - "refs": { - "CreateGatewayTargetRequest$name": "

The name of the gateway target. The name must be unique within the gateway.

", - "CreateGatewayTargetResponse$name": "

The name of the target.

", - "GatewayTarget$name": "

The name of the gateway target.

", - "GetGatewayTargetResponse$name": "

The name of the gateway target.

", - "StaticRoute$targetName": "

The name of the target to route requests to.

", - "TargetSummary$name": "

The name of the target.

", - "TargetTrafficSplitEntry$targetName": "

The name of the target to route traffic to.

", - "UpdateGatewayTargetRequest$name": "

The updated name for the gateway target.

", - "UpdateGatewayTargetResponse$name": "

The updated name of the gateway target.

" - } - }, - "TargetNextToken": { - "base": null, - "refs": { - "ListGatewayTargetsRequest$nextToken": "

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.

", - "ListGatewayTargetsResponse$nextToken": "

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.

" - } - }, - "TargetProtocolType": { - "base": null, - "refs": { - "CreateGatewayTargetResponse$protocolType": "

The protocol type of the created gateway target.

", - "GatewayTarget$protocolType": "

The protocol type of the gateway target.

", - "GetGatewayTargetResponse$protocolType": "

The protocol type of the gateway target.

", - "UpdateGatewayTargetResponse$protocolType": "

The protocol type of the updated gateway target.

" - } - }, - "TargetResourcePriority": { - "base": null, - "refs": { - "McpServerTargetConfiguration$resourcePriority": "

Priority for resolving MCP server targets with shared resource URIs. Lower values take precedence. Defaults to 1000 when not set.

", - "TargetSummary$resourcePriority": "

Priority for resolving resource URI conflicts across targets. Lower values take precedence. Defaults to 1000 when not set.

" - } - }, - "TargetStatus": { - "base": null, - "refs": { - "CreateGatewayTargetResponse$status": "

The current status of the target.

", - "DeleteGatewayTargetResponse$status": "

The current status of the gateway target deletion.

", - "GatewayTarget$status": "

The status of the gateway target.

", - "GetGatewayTargetResponse$status": "

The current status of the gateway target.

", - "TargetSummary$status": "

The current status of the target.

", - "UpdateGatewayTargetResponse$status": "

The current status of the updated gateway target.

" - } - }, - "TargetSummaries": { - "base": null, - "refs": { - "ListGatewayTargetsResponse$items": "

The list of gateway target summaries.

" - } - }, - "TargetSummary": { - "base": "

Contains summary information about a gateway target. A target represents an endpoint that the gateway can connect to.

", - "refs": { - "TargetSummaries$member": null - } - }, - "TargetTrafficSplitEntries": { - "base": null, - "refs": { - "WeightedRoute$trafficSplit": "

The traffic split entries defining how traffic is distributed between targets.

" - } - }, - "TargetTrafficSplitEntry": { - "base": "

An entry in a target traffic split configuration.

", - "refs": { - "TargetTrafficSplitEntries$member": null - } - }, - "TargetTrafficSplitEntryDescriptionString": { - "base": null, - "refs": { - "TargetTrafficSplitEntry$description": "

The description of this traffic split variant.

" - } - }, - "TargetTrafficSplitEntryNameString": { - "base": null, - "refs": { - "TargetTrafficSplitEntry$name": "

The name of this traffic split variant.

" - } - }, - "TargetTrafficSplitEntryWeightInteger": { - "base": null, - "refs": { - "TargetTrafficSplitEntry$weight": "

The percentage of traffic to route to this variant.

" - } - }, - "TargetType": { - "base": null, - "refs": { - "TargetSummary$targetType": "

The type of the target.

" - } - }, - "Temperature": { - "base": null, - "refs": { - "HarnessBedrockModelConfig$temperature": "

The temperature to set when calling the model.

", - "HarnessGeminiModelConfig$temperature": "

The temperature to set when calling the model.

", - "HarnessLiteLlmModelConfig$temperature": "

The temperature to set when calling the model.

", - "HarnessOpenAiModelConfig$temperature": "

The temperature to set when calling the model.

" - } - }, - "TenantIdType": { - "base": null, - "refs": { - "MicrosoftOauth2ProviderConfigInput$tenantId": "

The Microsoft Entra ID (formerly Azure AD) tenant ID for your organization. This identifies the specific tenant within Microsoft's identity platform where your application is registered.

" - } - }, - "ThrottledException": { - "base": "

API rate limit has been exceeded.

", - "refs": {} - }, - "ThrottlingException": { - "base": "

This exception is thrown when the number of requests exceeds the limit

", - "refs": {} - }, - "TimeBasedTrigger": { - "base": "

Trigger configuration based on time.

", - "refs": { - "TriggerCondition$timeBasedTrigger": "

Time based trigger configuration.

" - } - }, - "TimeBasedTriggerInput": { - "base": "

Trigger configuration based on time.

", - "refs": { - "TriggerConditionInput$timeBasedTrigger": "

Time based trigger configuration.

" - } - }, - "TimeBasedTriggerInputIdleSessionTimeoutInteger": { - "base": null, - "refs": { - "TimeBasedTriggerInput$idleSessionTimeout": "

Idle session timeout (seconds) that triggers memory processing.

" - } - }, - "Timestamp": { - "base": null, - "refs": { - "AddDatasetExamplesResponse$updatedAt": "

The timestamp when the examples were added.

", - "ApiKeyCredentialProviderItem$createdTime": "

The timestamp when the API key credential provider was created.

", - "ApiKeyCredentialProviderItem$lastUpdatedTime": "

The timestamp when the API key credential provider was last updated.

", - "ConfigurationBundleSummary$createdAt": "

The timestamp when the configuration bundle was created.

", - "ConfigurationBundleVersionSummary$versionCreatedAt": "

The timestamp when this version was created.

", - "CreateConfigurationBundleResponse$createdAt": "

The timestamp when the configuration bundle was created.

", - "CreateDatasetResponse$createdAt": "

The timestamp when the dataset was created.

", - "CreateDatasetVersionResponse$createdAt": "

The timestamp when the version creation was initiated.

", - "CreateEvaluatorResponse$createdAt": "

The timestamp when the evaluator was created.

", - "CreateOnlineEvaluationConfigResponse$createdAt": "

The timestamp when the online evaluation configuration was created.

", - "DatasetSummary$createdAt": "

The timestamp when the dataset was created.

", - "DatasetSummary$updatedAt": "

The timestamp when the dataset was last updated.

", - "DatasetVersionSummary$createdAt": "

The timestamp when this version was published.

", - "DeleteDatasetExamplesResponse$updatedAt": "

The timestamp when the examples were deleted.

", - "DeleteDatasetResponse$updatedAt": "

The timestamp when the delete was initiated.

", - "EvaluatorSummary$createdAt": "

The timestamp when the evaluator was created.

", - "EvaluatorSummary$updatedAt": "

The timestamp when the evaluator was last updated.

", - "GetApiKeyCredentialProviderResponse$createdTime": "

The timestamp when the API key credential provider was created.

", - "GetApiKeyCredentialProviderResponse$lastUpdatedTime": "

The timestamp when the API key credential provider was last updated.

", - "GetConfigurationBundleResponse$createdAt": "

The timestamp when the configuration bundle was created.

", - "GetConfigurationBundleResponse$updatedAt": "

The timestamp when the configuration bundle was last updated.

", - "GetConfigurationBundleVersionResponse$createdAt": "

The timestamp when the configuration bundle was created.

", - "GetConfigurationBundleVersionResponse$versionCreatedAt": "

The timestamp when this specific version was created.

", - "GetDatasetResponse$downloadUrlExpiresAt": "

Expiry timestamp for the download URL.

", - "GetDatasetResponse$createdAt": "

The timestamp when the dataset was created.

", - "GetDatasetResponse$updatedAt": "

The timestamp when the dataset was last updated.

", - "GetEvaluatorResponse$createdAt": "

The timestamp when the evaluator was created.

", - "GetEvaluatorResponse$updatedAt": "

The timestamp when the evaluator was last updated.

", - "GetOauth2CredentialProviderResponse$createdTime": "

The timestamp when the OAuth2 credential provider was created.

", - "GetOauth2CredentialProviderResponse$lastUpdatedTime": "

The timestamp when the OAuth2 credential provider was last updated.

", - "GetOnlineEvaluationConfigResponse$createdAt": "

The timestamp when the online evaluation configuration was created.

", - "GetOnlineEvaluationConfigResponse$updatedAt": "

The timestamp when the online evaluation configuration was last updated.

", - "GetPaymentCredentialProviderResponse$createdTime": "

The timestamp when the payment credential provider was created.

", - "GetPaymentCredentialProviderResponse$lastUpdatedTime": "

The timestamp when the payment credential provider was last updated.

", - "GetTokenVaultResponse$lastModifiedDate": "

The timestamp when the token vault was last modified.

", - "GetWorkloadIdentityResponse$createdTime": "

The timestamp when the workload identity was created.

", - "GetWorkloadIdentityResponse$lastUpdatedTime": "

The timestamp when the workload identity was last updated.

", - "Memory$createdAt": "

The timestamp when the memory was created.

", - "Memory$updatedAt": "

The timestamp when the memory was last updated.

", - "MemoryStrategy$createdAt": "

The timestamp when the memory strategy was created.

", - "MemoryStrategy$updatedAt": "

The timestamp when the memory strategy was last updated.

", - "MemorySummary$createdAt": "

The timestamp when the memory was created.

", - "MemorySummary$updatedAt": "

The timestamp when the memory was last updated.

", - "Oauth2CredentialProviderItem$createdTime": "

The timestamp when the OAuth2 credential provider was created.

", - "Oauth2CredentialProviderItem$lastUpdatedTime": "

The timestamp when the OAuth2 credential provider was last updated.

", - "OnlineEvaluationConfigSummary$createdAt": "

The timestamp when the online evaluation configuration was created.

", - "OnlineEvaluationConfigSummary$updatedAt": "

The timestamp when the online evaluation configuration was last updated.

", - "PaymentCredentialProviderItem$createdTime": "

The timestamp when the payment credential provider was created.

", - "PaymentCredentialProviderItem$lastUpdatedTime": "

The timestamp when the payment credential provider was last updated.

", - "SetTokenVaultCMKResponse$lastModifiedDate": "

The timestamp when the token vault was last modified.

", - "UpdateApiKeyCredentialProviderResponse$createdTime": "

The timestamp when the API key credential provider was created.

", - "UpdateApiKeyCredentialProviderResponse$lastUpdatedTime": "

The timestamp when the API key credential provider was last updated.

", - "UpdateConfigurationBundleResponse$updatedAt": "

The timestamp when the configuration bundle was updated.

", - "UpdateDatasetExamplesResponse$updatedAt": "

The timestamp when the examples were updated.

", - "UpdateDatasetResponse$updatedAt": "

The timestamp when the dataset was updated.

", - "UpdateEvaluatorResponse$updatedAt": "

The timestamp when the evaluator was last updated.

", - "UpdateOauth2CredentialProviderResponse$createdTime": "

The timestamp when the OAuth2 credential provider was created.

", - "UpdateOauth2CredentialProviderResponse$lastUpdatedTime": "

The timestamp when the OAuth2 credential provider was last updated.

", - "UpdateOnlineEvaluationConfigResponse$updatedAt": "

The timestamp when the online evaluation configuration was last updated.

", - "UpdatePaymentCredentialProviderResponse$createdTime": "

The timestamp when the payment credential provider was created.

", - "UpdatePaymentCredentialProviderResponse$lastUpdatedTime": "

The timestamp when the payment credential provider was last updated.

", - "UpdateWorkloadIdentityResponse$createdTime": "

The timestamp when the workload identity was created.

", - "UpdateWorkloadIdentityResponse$lastUpdatedTime": "

The timestamp when the workload identity was last updated.

" - } - }, - "TokenAuthMethod": { - "base": null, - "refs": { - "TokenEndpointAuthMethodsType$member": null - } - }, - "TokenBasedTrigger": { - "base": "

Trigger configuration based on tokens.

", - "refs": { - "TriggerCondition$tokenBasedTrigger": "

Token based trigger configuration.

" - } - }, - "TokenBasedTriggerInput": { - "base": "

Trigger configuration based on tokens.

", - "refs": { - "TriggerConditionInput$tokenBasedTrigger": "

Token based trigger configuration.

" - } - }, - "TokenBasedTriggerInputTokenCountInteger": { - "base": null, - "refs": { - "TokenBasedTriggerInput$tokenCount": "

Number of tokens that trigger memory processing.

" - } - }, - "TokenEndpointAuthMethodsType": { - "base": null, - "refs": { - "Oauth2AuthorizationServerMetadata$tokenEndpointAuthMethods": "

The authentication methods supported by the token endpoint. This specifies how clients can authenticate when requesting tokens from the authorization server.

" - } - }, - "TokenEndpointType": { - "base": null, - "refs": { - "IncludedOauth2ProviderConfigInput$tokenEndpoint": "

OAuth2 token endpoint for your isolated OAuth2 application tenant. This is where authorization codes are exchanged for access tokens.

", - "Oauth2AuthorizationServerMetadata$tokenEndpoint": "

The token endpoint URL for the OAuth2 authorization server.

" - } - }, - "TokenExchangeGrantTypeConfigType": { - "base": "

Configuration for RFC 8693 token exchange.

", - "refs": { - "OnBehalfOfTokenExchangeConfigType$tokenExchangeGrantTypeConfig": "

Configuration specific to the TOKEN_EXCHANGE grant type (RFC 8693).

" - } - }, - "TokenVaultIdType": { - "base": null, - "refs": { - "GetTokenVaultRequest$tokenVaultId": "

The unique identifier of the token vault to retrieve.

", - "GetTokenVaultResponse$tokenVaultId": "

The ID of the token vault.

", - "SetTokenVaultCMKRequest$tokenVaultId": "

The unique identifier of the token vault to update.

", - "SetTokenVaultCMKResponse$tokenVaultId": "

The ID of the token vault.

" - } - }, - "ToolDefinition": { - "base": "

A tool definition for a gateway target. This structure defines a tool that the target exposes through the Model Context Protocol.

", - "refs": { - "ToolDefinitions$member": null - } - }, - "ToolDefinitions": { - "base": null, - "refs": { - "ToolSchema$inlinePayload": "

The inline payload of the tool schema. This payload contains the schema definition directly in the request.

" - } - }, - "ToolSchema": { - "base": "

A tool schema for a gateway target. This structure defines the schema for a tool that the target exposes through the Model Context Protocol.

", - "refs": { - "McpLambdaTargetConfiguration$toolSchema": "

The tool schema for the Lambda function. This schema defines the structure of the tools that the Lambda function provides.

" - } - }, - "ToolSecretArn": { - "base": null, - "refs": { - "SecretsManagerLocation$secretArn": "

The ARN of the Amazon Web Services Secrets Manager secret containing the certificate.

" - } - }, - "ToolsDefinition": { - "base": "

The tools definition for an MCP descriptor. Contains the protocol version and inline content describing the available tools.

", - "refs": { - "McpDescriptor$tools": "

The MCP tools definition, containing the tools available on the MCP server as defined by the MCP protocol specification.

", - "UpdatedToolsDefinition$optionalValue": "

The updated tools definition value.

" - } - }, - "ToolsFileSystemConfiguration": { - "base": "

Specifies a file system to mount into the session by providing exactly one of the following:

  • s3FilesConfiguration - Mounts an Amazon Simple Storage Service (Amazon S3) Files access point.

  • efsConfiguration - Mounts an Amazon Elastic File System (Amazon EFS) access point.

", - "refs": { - "ToolsFileSystemConfigurations$member": null - } - }, - "ToolsFileSystemConfigurations": { - "base": "

The file system configurations to mount into the session. Each configuration maps an access point to a path inside the session. You can specify up to 4 configurations. The maximum is 2 Amazon Simple Storage Service (Amazon S3) Files access points and 2 Amazon Elastic File System (Amazon EFS) access points.

", - "refs": { - "CreateBrowserRequest$filesystemConfigurations": "

The file system configurations to mount into the browser. Use these configurations to mount your own Amazon Simple Storage Service (Amazon S3) Files or Amazon Elastic File System (Amazon EFS) access points. Your sessions can then access your data. If you don't specify this field, no file systems are mounted.

", - "CreateCodeInterpreterRequest$filesystemConfigurations": "

The file system configurations to mount into the code interpreter. Use these configurations to mount your own Amazon Simple Storage Service (Amazon S3) Files or Amazon Elastic File System (Amazon EFS) access points. Your sessions can then access your data. If you don't specify this field, no file systems are mounted.

", - "GetBrowserResponse$filesystemConfigurations": "

The file system configurations mounted into the browser. Each entry describes an access point and its mount path.

", - "GetCodeInterpreterResponse$filesystemConfigurations": "

The file system configurations mounted into the code interpreter. Each entry describes an access point and its mount path.

" - } - }, - "TopK": { - "base": null, - "refs": { - "HarnessGeminiModelConfig$topK": "

The topK set when calling the model.

" - } - }, - "TopP": { - "base": null, - "refs": { - "HarnessBedrockModelConfig$topP": "

The topP set when calling the model.

", - "HarnessGeminiModelConfig$topP": "

The topP set when calling the model.

", - "HarnessLiteLlmModelConfig$topP": "

The topP set when calling the model.

", - "HarnessOpenAiModelConfig$topP": "

The topP set when calling the model.

" - } - }, - "TrafficSplitEntries": { - "base": null, - "refs": { - "WeightedOverride$trafficSplit": "

The traffic split entries defining how traffic is distributed between configuration bundle versions.

" - } - }, - "TrafficSplitEntry": { - "base": "

An entry in a traffic split configuration, defining a named variant with a weight and configuration bundle reference.

", - "refs": { - "TrafficSplitEntries$member": null - } - }, - "TrafficSplitEntryDescriptionString": { - "base": null, - "refs": { - "TrafficSplitEntry$description": "

The description of this traffic split variant.

" - } - }, - "TrafficSplitEntryNameString": { - "base": null, - "refs": { - "TrafficSplitEntry$name": "

The name of this traffic split variant.

" - } - }, - "TrafficSplitEntryWeightInteger": { - "base": null, - "refs": { - "TrafficSplitEntry$weight": "

The percentage of traffic to route to this variant. Weights across all entries must sum to 100.

" - } - }, - "TrafficSplitMetadataKey": { - "base": null, - "refs": { - "TrafficSplitMetadataMap$key": null - } - }, - "TrafficSplitMetadataMap": { - "base": null, - "refs": { - "TargetTrafficSplitEntry$metadata": "

Key-value metadata associated with this traffic split variant.

", - "TrafficSplitEntry$metadata": "

Key-value metadata associated with this traffic split variant.

" - } - }, - "TrafficSplitMetadataValue": { - "base": null, - "refs": { - "TrafficSplitMetadataMap$value": null - } - }, - "TriggerCondition": { - "base": "

Condition that triggers memory processing.

", - "refs": { - "TriggerConditionsList$member": null - } - }, - "TriggerConditionInput": { - "base": "

Condition that triggers memory processing.

", - "refs": { - "TriggerConditionInputList$member": null - } - }, - "TriggerConditionInputList": { - "base": null, - "refs": { - "ModifySelfManagedConfiguration$triggerConditions": "

The updated list of conditions that trigger memory processing.

", - "SelfManagedConfigurationInput$triggerConditions": "

A list of conditions that trigger memory processing.

" - } - }, - "TriggerConditionsList": { - "base": null, - "refs": { - "SelfManagedConfiguration$triggerConditions": "

A list of conditions that trigger memory processing.

" - } - }, - "UnauthorizedException": { - "base": "

This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

", - "refs": {} - }, - "Unit": { - "base": null, - "refs": { - "HarnessGatewayOutboundAuth$awsIam": "

SigV4-sign requests using the agent's execution role.

", - "HarnessGatewayOutboundAuth$none": "

No authentication.

" - } - }, - "UntagResourceRequest": { - "base": null, - "refs": {} - }, - "UntagResourceResponse": { - "base": null, - "refs": {} - }, - "UpdateAgentRuntimeEndpointRequest": { - "base": null, - "refs": {} - }, - "UpdateAgentRuntimeEndpointResponse": { - "base": null, - "refs": {} - }, - "UpdateAgentRuntimeRequest": { - "base": null, - "refs": {} - }, - "UpdateAgentRuntimeResponse": { - "base": null, - "refs": {} - }, - "UpdateApiKeyCredentialProviderRequest": { - "base": null, - "refs": {} - }, - "UpdateApiKeyCredentialProviderResponse": { - "base": null, - "refs": {} - }, - "UpdateConfigurationBundleRequest": { - "base": null, - "refs": {} - }, - "UpdateConfigurationBundleRequestCommitMessageString": { - "base": null, - "refs": { - "UpdateConfigurationBundleRequest$commitMessage": "

A commit message describing the changes in this version.

" - } - }, - "UpdateConfigurationBundleResponse": { - "base": null, - "refs": {} - }, - "UpdateDatasetExamplesRequest": { - "base": null, - "refs": {} - }, - "UpdateDatasetExamplesRequestExamplesList": { - "base": "

A list of dataset examples. Each element is a free-form JSON document whose structure is defined by the dataset's schema type.

", - "refs": { - "UpdateDatasetExamplesRequest$examples": "

Examples to update. Each element is a JSON object containing a required exampleId field identifying the existing example, plus the replacement fields. Maximum 1000 examples per call.

" - } - }, - "UpdateDatasetExamplesResponse": { - "base": null, - "refs": {} - }, - "UpdateDatasetRequest": { - "base": null, - "refs": {} - }, - "UpdateDatasetRequestDescriptionString": { - "base": null, - "refs": { - "UpdateDatasetRequest$description": "

The updated description for the dataset.

" - } - }, - "UpdateDatasetResponse": { - "base": null, - "refs": {} - }, - "UpdateEvaluatorRequest": { - "base": null, - "refs": {} - }, - "UpdateEvaluatorResponse": { - "base": null, - "refs": {} - }, - "UpdateGatewayRequest": { - "base": null, - "refs": {} - }, - "UpdateGatewayResponse": { - "base": null, - "refs": {} - }, - "UpdateGatewayRuleRequest": { - "base": null, - "refs": {} - }, - "UpdateGatewayRuleResponse": { - "base": "

Create response excludes updatedAt (redundant on create). Get/Update responses include it via their own output structures.

", - "refs": {} - }, - "UpdateGatewayTargetRequest": { - "base": null, - "refs": {} - }, - "UpdateGatewayTargetResponse": { - "base": null, - "refs": {} - }, - "UpdateHarnessEndpointRequest": { - "base": null, - "refs": {} - }, - "UpdateHarnessEndpointResponse": { - "base": null, - "refs": {} - }, - "UpdateHarnessRequest": { - "base": null, - "refs": {} - }, - "UpdateHarnessResponse": { - "base": null, - "refs": {} - }, - "UpdateMemoryInput": { - "base": null, - "refs": {} - }, - "UpdateMemoryInputClientTokenString": { - "base": null, - "refs": { - "UpdateMemoryInput$clientToken": "

A client token is used for keeping track of idempotent requests. It can contain a session id which can be around 250 chars, combined with a unique AWS identifier.

" - } - }, - "UpdateMemoryInputEventExpiryDurationInteger": { - "base": null, - "refs": { - "UpdateMemoryInput$eventExpiryDuration": "

The number of days after which memory events will expire, between 7 and 365 days.

" - } - }, - "UpdateMemoryOutput": { - "base": null, - "refs": {} - }, - "UpdateOauth2CredentialProviderRequest": { - "base": null, - "refs": {} - }, - "UpdateOauth2CredentialProviderResponse": { - "base": null, - "refs": {} - }, - "UpdateOnlineEvaluationConfigRequest": { - "base": null, - "refs": {} - }, - "UpdateOnlineEvaluationConfigResponse": { - "base": null, - "refs": {} - }, - "UpdatePaymentConnectorRequest": { - "base": null, - "refs": {} - }, - "UpdatePaymentConnectorResponse": { - "base": null, - "refs": {} - }, - "UpdatePaymentCredentialProviderRequest": { - "base": null, - "refs": {} - }, - "UpdatePaymentCredentialProviderResponse": { - "base": null, - "refs": {} - }, - "UpdatePaymentManagerRequest": { - "base": null, - "refs": {} - }, - "UpdatePaymentManagerResponse": { - "base": null, - "refs": {} - }, - "UpdatePolicyEngineRequest": { - "base": null, - "refs": {} - }, - "UpdatePolicyEngineResponse": { - "base": null, - "refs": {} - }, - "UpdatePolicyRequest": { - "base": null, - "refs": {} - }, - "UpdatePolicyResponse": { - "base": null, - "refs": {} - }, - "UpdateRegistryRecordRequest": { - "base": null, - "refs": {} - }, - "UpdateRegistryRecordResponse": { - "base": null, - "refs": {} - }, - "UpdateRegistryRecordStatusRequest": { - "base": null, - "refs": {} - }, - "UpdateRegistryRecordStatusRequestStatusReasonString": { - "base": null, - "refs": { - "UpdateRegistryRecordStatusRequest$statusReason": "

The reason for the status change, such as why the record was approved or rejected.

" - } - }, - "UpdateRegistryRecordStatusResponse": { - "base": null, - "refs": {} - }, - "UpdateRegistryRequest": { - "base": null, - "refs": {} - }, - "UpdateRegistryResponse": { - "base": null, - "refs": {} - }, - "UpdateWorkloadIdentityRequest": { - "base": null, - "refs": {} - }, - "UpdateWorkloadIdentityResponse": { - "base": null, - "refs": {} - }, - "UpdatedA2aDescriptor": { - "base": "

Wrapper for updating an A2A descriptor with PATCH semantics. When present, the A2A descriptor is replaced with the provided value. When absent, the A2A descriptor is left unchanged. To unset, include the wrapper with the value set to null.

", - "refs": { - "UpdatedDescriptorsUnion$a2a": "

The updated A2A descriptor.

" - } - }, - "UpdatedAgentSkillsDescriptor": { - "base": "

Wrapper for updating an agent skills descriptor with PATCH semantics. When present with a value, individual fields can be updated independently. When present with a null value, the entire agent skills descriptor is unset. When absent, the agent skills descriptor is left unchanged.

", - "refs": { - "UpdatedDescriptorsUnion$agentSkills": "

The updated agent skills descriptor.

" - } - }, - "UpdatedAgentSkillsDescriptorFields": { - "base": "

Individual agent skills descriptor fields that can be updated independently.

", - "refs": { - "UpdatedAgentSkillsDescriptor$optionalValue": "

The updated agent skills descriptor fields.

" - } - }, - "UpdatedApprovalConfiguration": { - "base": "

Wrapper for updating an optional approval configuration field with PATCH semantics. When present in an update request, the approval configuration is replaced with the provided value. When absent, the approval configuration is left unchanged.

", - "refs": { - "UpdateRegistryRequest$approvalConfiguration": "

The updated approval configuration for registry records. The updated configuration only affects new records that move to PENDING_APPROVAL status after the change. Existing records already in PENDING_APPROVAL status are not affected.

" - } - }, - "UpdatedAuthorizerConfiguration": { - "base": "

Wrapper for updating an optional AuthorizerConfiguration field with PATCH semantics. When present in an update request, the authorizer configuration is replaced with optionalValue. When absent, the authorizer configuration is left unchanged. To unset, include the wrapper with optionalValue not specified.

", - "refs": { - "UpdateHarnessRequest$authorizerConfiguration": null, - "UpdateRegistryRequest$authorizerConfiguration": "

The updated authorizer configuration for the registry. Changing the authorizer configuration can break existing consumers of the registry who are using the authorization type prior to the update.

" - } - }, - "UpdatedCustomDescriptor": { - "base": "

Wrapper for updating a custom descriptor with PATCH semantics. When present, the custom descriptor is replaced with the provided value. When absent, the custom descriptor is left unchanged. To unset, include the wrapper with the value set to null.

", - "refs": { - "UpdatedDescriptorsUnion$custom": "

The updated custom descriptor.

" - } - }, - "UpdatedDescription": { - "base": "

Wrapper for updating an optional Description field with PATCH semantics. When present in an update request, the description is replaced with optionalValue. When absent, the description is left unchanged. To unset the description, include the wrapper with optionalValue not specified.

", - "refs": { - "UpdatePolicyEngineRequest$description": "

The new description for the policy engine.

", - "UpdatePolicyRequest$description": "

The new human-readable description for the policy. This optional field allows updating the policy's documentation while keeping the same policy logic.

", - "UpdateRegistryRecordRequest$description": "

The updated description for the registry record. To clear the description, include the UpdatedDescription wrapper with optionalValue not specified.

", - "UpdateRegistryRequest$description": "

The updated description of the registry. To clear the description, include the UpdatedDescription wrapper with optionalValue not specified.

" - } - }, - "UpdatedDescriptors": { - "base": "

Wrapper for updating an optional descriptors field with PATCH semantics. When present with a value, individual descriptors can be updated. When present with a null value, all descriptors are unset. When absent, descriptors are left unchanged.

", - "refs": { - "UpdateRegistryRecordRequest$descriptors": "

The updated descriptor-type-specific configuration containing the resource schema and metadata. Uses PATCH semantics where individual descriptor fields can be updated independently.

" - } - }, - "UpdatedDescriptorsUnion": { - "base": "

Contains per-descriptor-type wrappers for updating descriptors. Each descriptor type can be updated independently.

", - "refs": { - "UpdatedDescriptors$optionalValue": "

The updated descriptors value. Contains per-descriptor-type wrappers that are each independently updatable.

" - } - }, - "UpdatedHarnessEnvironmentArtifact": { - "base": "

Wrapper for updating the environment artifact configuration.

", - "refs": { - "UpdateHarnessRequest$environmentArtifact": "

The environment artifact for the harness. Use the optionalValue wrapper to set a new value, or set it to null to clear the existing configuration.

" - } - }, - "UpdatedHarnessMemoryConfiguration": { - "base": "

Wrapper for updating the memory configuration.

", - "refs": { - "UpdateHarnessRequest$memory": "

The AgentCore Memory configuration. Use the optionalValue wrapper to set a new value, or set it to null to clear the existing configuration.

" - } - }, - "UpdatedMcpDescriptor": { - "base": "

Wrapper for updating an MCP descriptor with PATCH semantics. When present with a value, individual MCP fields can be updated independently. When present with a null value, the entire MCP descriptor is unset. When absent, the MCP descriptor is left unchanged.

", - "refs": { - "UpdatedDescriptorsUnion$mcp": "

The updated MCP descriptor.

" - } - }, - "UpdatedMcpDescriptorFields": { - "base": "

Individual MCP descriptor fields that can be updated independently.

", - "refs": { - "UpdatedMcpDescriptor$optionalValue": "

The updated MCP descriptor fields.

" - } - }, - "UpdatedServerDefinition": { - "base": "

Wrapper for updating a server definition with PATCH semantics. When present, the server definition is replaced with the provided value. When absent, the server definition is left unchanged. To unset, include the wrapper with the value set to null.

", - "refs": { - "UpdatedMcpDescriptorFields$server": "

The updated server definition for the MCP descriptor.

" - } - }, - "UpdatedSkillDefinition": { - "base": "

Wrapper for updating a skill definition with PATCH semantics.

", - "refs": { - "UpdatedAgentSkillsDescriptorFields$skillDefinition": "

The updated skill definition.

" - } - }, - "UpdatedSkillMdDefinition": { - "base": "

Wrapper for updating a skill markdown definition with PATCH semantics.

", - "refs": { - "UpdatedAgentSkillsDescriptorFields$skillMd": "

The updated skill markdown definition.

" - } - }, - "UpdatedSynchronizationConfiguration": { - "base": "

Wrapper for updating the synchronization configuration with PATCH semantics. Must be matched with UpdatedSynchronizationType.

", - "refs": { - "UpdateRegistryRecordRequest$synchronizationConfiguration": "

The updated synchronization configuration for the registry record.

" - } - }, - "UpdatedSynchronizationType": { - "base": "

Wrapper for updating the synchronization type with PATCH semantics. Must be matched with UpdatedSynchronizationConfiguration.

", - "refs": { - "UpdateRegistryRecordRequest$synchronizationType": "

The updated synchronization type for the registry record.

" - } - }, - "UpdatedToolsDefinition": { - "base": "

Wrapper for updating a tools definition with PATCH semantics. When present, the tools definition is replaced with the provided value. When absent, the tools definition is left unchanged. To unset, include the wrapper with the value set to null.

", - "refs": { - "UpdatedMcpDescriptorFields$tools": "

The updated tools definition for the MCP descriptor.

" - } - }, - "UserPreferenceConsolidationOverride": { - "base": "

Contains user preference consolidation override configuration.

", - "refs": { - "CustomConsolidationConfiguration$userPreferenceConsolidationOverride": "

The user preference consolidation override configuration.

" - } - }, - "UserPreferenceExtractionOverride": { - "base": "

Contains user preference extraction override configuration.

", - "refs": { - "CustomExtractionConfiguration$userPreferenceExtractionOverride": "

The user preference extraction override configuration.

" - } - }, - "UserPreferenceMemoryStrategyInput": { - "base": "

Input for creating a user preference memory strategy.

", - "refs": { - "MemoryStrategyInput$userPreferenceMemoryStrategy": "

Input for creating a user preference memory strategy.

" - } - }, - "UserPreferenceOverrideConfigurationInput": { - "base": "

Input for user preference override configuration in a memory strategy.

", - "refs": { - "CustomConfigurationInput$userPreferenceOverride": "

The user preference override configuration for a custom memory strategy.

" - } - }, - "UserPreferenceOverrideConsolidationConfigurationInput": { - "base": "

Input for user preference override consolidation configuration in a memory strategy.

", - "refs": { - "CustomConsolidationConfigurationInput$userPreferenceConsolidationOverride": "

The user preference consolidation override configuration input.

", - "UserPreferenceOverrideConfigurationInput$consolidation": "

The consolidation configuration for a user preference override.

" - } - }, - "UserPreferenceOverrideExtractionConfigurationInput": { - "base": "

Input for user preference override extraction configuration in a memory strategy.

", - "refs": { - "CustomExtractionConfigurationInput$userPreferenceExtractionOverride": "

The user preference extraction override configuration input.

", - "UserPreferenceOverrideConfigurationInput$extraction": "

The extraction configuration for a user preference override.

" - } - }, - "Validation": { - "base": "

Validation rules for extracted metadata values. Only one type can be specified, matching the field's data type.

", - "refs": { - "LlmExtractionConfig$validation": "

Validation rules to constrain extracted values.

" - } - }, - "ValidationException": { - "base": "

The input fails to satisfy the constraints specified by the service.

", - "refs": {} - }, - "ValidationExceptionField": { - "base": "

Stores information about a field passed inside a request that resulted in an exception.

", - "refs": { - "ValidationExceptionFieldList$member": null - } - }, - "ValidationExceptionFieldList": { - "base": null, - "refs": { - "ValidationException$fieldList": null - } - }, - "ValidationExceptionReason": { - "base": null, - "refs": { - "ValidationException$reason": null - } - }, - "VersionCreatedBySource": { - "base": "

The source that created a configuration bundle version.

", - "refs": { - "CreateConfigurationBundleRequest$createdBy": "

The source that created this version, including the source name and optional ARN.

", - "UpdateConfigurationBundleRequest$createdBy": "

The source that created this version, including the source name and optional ARN.

", - "VersionLineageMetadata$createdBy": "

The source that created this version.

" - } - }, - "VersionFilter": { - "base": "

A filter for listing configuration bundle versions.

", - "refs": { - "ListConfigurationBundleVersionsRequest$filter": "

An optional filter for listing versions, including branch name, creation source, and whether to return only the latest version per branch.

" - } - }, - "VersionLineageMetadata": { - "base": "

The version lineage metadata that tracks parent versions and creation source. Supports git-like two-parent merges for branch management.

", - "refs": { - "ConfigurationBundleVersionSummary$lineageMetadata": "

The version lineage metadata, including parent versions, branch name, and creation source.

", - "GetConfigurationBundleResponse$lineageMetadata": "

The version lineage metadata, including parent versions, branch name, and creation source.

", - "GetConfigurationBundleVersionResponse$lineageMetadata": "

The version lineage metadata, including parent versions, branch name, and creation source.

" - } - }, - "VersionLineageMetadataCommitMessageString": { - "base": null, - "refs": { - "VersionLineageMetadata$commitMessage": "

A commit message describing the changes in this version.

" - } - }, - "VpcConfig": { - "base": "

VpcConfig for the Agent.

", - "refs": { - "BrowserNetworkConfiguration$vpcConfig": "

The VPC configuration for the browser. This configuration is required when the network mode is set to VPC.

", - "CodeInterpreterNetworkConfiguration$vpcConfig": "

The VPC configuration for the code interpreter. This configuration is required when the network mode is set to VPC.

", - "NetworkConfiguration$networkModeConfig": "

The network mode configuration for the AgentCore Runtime.

" - } - }, - "VpcIdentifier": { - "base": null, - "refs": { - "ManagedVpcResource$vpcIdentifier": "

The ID of the VPC that contains your private resource.

" - } - }, - "WafConfiguration": { - "base": "

The Amazon Web Services WAF configuration for the gateway. This configuration controls how the gateway behaves when the associated web ACL cannot be evaluated.

", - "refs": { - "CreateGatewayResponse$wafConfiguration": "

The Amazon Web Services WAF configuration for the gateway.

", - "GetGatewayResponse$wafConfiguration": "

The Amazon Web Services WAF configuration for the gateway.

", - "UpdateGatewayRequest$wafConfiguration": "

The updated Amazon Web Services WAF configuration for the gateway.

", - "UpdateGatewayResponse$wafConfiguration": "

The Amazon Web Services WAF configuration for the gateway.

" - } - }, - "WafFailureMode": { - "base": null, - "refs": { - "WafConfiguration$failureMode": "

The failure mode that determines how the gateway handles requests when Amazon Web Services WAF is unreachable or times out. Valid values include:

  • FAIL_CLOSE - The gateway blocks requests when Amazon Web Services WAF cannot be evaluated.

  • FAIL_OPEN - The gateway allows requests when Amazon Web Services WAF cannot be evaluated.

" - } - }, - "WebAclArn": { - "base": null, - "refs": { - "CreateGatewayResponse$webAclArn": "

The Amazon Resource Name (ARN) of the Amazon Web Services WAF web ACL associated with the gateway.

", - "GetGatewayResponse$webAclArn": "

The Amazon Resource Name (ARN) of the Amazon Web Services WAF web ACL associated with the gateway.

", - "UpdateGatewayResponse$webAclArn": "

The Amazon Resource Name (ARN) of the Amazon Web Services WAF web ACL associated with the gateway.

" - } - }, - "WeightedOverride": { - "base": "

A weighted configuration bundle override that splits traffic between multiple bundle versions.

", - "refs": { - "ConfigurationBundleAction$weightedOverride": "

A weighted configuration bundle override that splits traffic between multiple bundle versions based on configured weights.

" - } - }, - "WeightedRoute": { - "base": "

A weighted route that splits traffic between multiple gateway targets.

", - "refs": { - "RouteToTargetAction$weightedRoute": "

A weighted route that splits traffic between multiple targets.

" - } - }, - "WorkloadIdentityArn": { - "base": null, - "refs": { - "WorkloadIdentityDetails$workloadIdentityArn": "

The ARN associated with the workload identity.

" - } - }, - "WorkloadIdentityArnType": { - "base": null, - "refs": { - "CreateWorkloadIdentityResponse$workloadIdentityArn": "

The Amazon Resource Name (ARN) of the workload identity.

", - "GetWorkloadIdentityResponse$workloadIdentityArn": "

The Amazon Resource Name (ARN) of the workload identity.

", - "UpdateWorkloadIdentityResponse$workloadIdentityArn": "

The Amazon Resource Name (ARN) of the workload identity.

", - "WorkloadIdentityType$workloadIdentityArn": "

The Amazon Resource Name (ARN) of the workload identity.

" - } - }, - "WorkloadIdentityDetails": { - "base": "

The information about the workload identity.

", - "refs": { - "CreateAgentRuntimeResponse$workloadIdentityDetails": "

The workload identity details for the AgentCore Runtime.

", - "CreateGatewayResponse$workloadIdentityDetails": "

The workload identity details for the created gateway.

", - "CreatePaymentManagerResponse$workloadIdentityDetails": null, - "GetAgentRuntimeResponse$workloadIdentityDetails": "

The workload identity details for the AgentCore Runtime.

", - "GetGatewayResponse$workloadIdentityDetails": "

The workload identity details for the gateway.

", - "GetPaymentManagerResponse$workloadIdentityDetails": null, - "UpdateAgentRuntimeResponse$workloadIdentityDetails": "

The workload identity details for the updated AgentCore Runtime.

", - "UpdateGatewayResponse$workloadIdentityDetails": "

The workload identity details for the updated gateway.

", - "UpdatePaymentManagerResponse$workloadIdentityDetails": null - } - }, - "WorkloadIdentityList": { - "base": null, - "refs": { - "ListWorkloadIdentitiesResponse$workloadIdentities": "

The list of workload identities.

" - } - }, - "WorkloadIdentityNameListType": { - "base": null, - "refs": { - "AllowedWorkloadConfiguration$workloadIdentities": "

The list of workload identities that are allowed to invoke the target.

" - } - }, - "WorkloadIdentityNameType": { - "base": null, - "refs": { - "CreateWorkloadIdentityRequest$name": "

The name of the workload identity. The name must be unique within your account.

", - "CreateWorkloadIdentityResponse$name": "

The name of the workload identity.

", - "DeleteWorkloadIdentityRequest$name": "

The name of the workload identity to delete.

", - "GetWorkloadIdentityRequest$name": "

The name of the workload identity to retrieve.

", - "GetWorkloadIdentityResponse$name": "

The name of the workload identity.

", - "UpdateWorkloadIdentityRequest$name": "

The name of the workload identity to update.

", - "UpdateWorkloadIdentityResponse$name": "

The name of the workload identity.

", - "WorkloadIdentityNameListType$member": null, - "WorkloadIdentityType$name": "

The name of the workload identity.

" - } - }, - "WorkloadIdentityType": { - "base": "

Contains information about a workload identity.

", - "refs": { - "WorkloadIdentityList$member": null - } - }, - "entryPoint": { - "base": null, - "refs": { - "CodeConfigurationEntryPointList$member": null - } - } - } -} diff --git a/tools/code-generation/api-descriptions/bedrock-agentcore-control/2023-06-05/endpoint-bdd-1.json b/tools/code-generation/api-descriptions/bedrock-agentcore-control/2023-06-05/endpoint-bdd-1.json deleted file mode 100644 index ba10753ce24f..000000000000 --- a/tools/code-generation/api-descriptions/bedrock-agentcore-control/2023-06-05/endpoint-bdd-1.json +++ /dev/null @@ -1,188 +0,0 @@ -{ - "version": "1.1", - "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" - } - }, - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - }, - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - }, - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "results": [ - { - "conditions": [], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://bedrock-agentcore-control-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": "https://bedrock-agentcore-control-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": "https://bedrock-agentcore-control.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": "https://bedrock-agentcore-control.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ], - "root": 2, - "nodeCount": 13, - "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" -} \ No newline at end of file diff --git a/tools/code-generation/api-descriptions/bedrock-agentcore-control/2023-06-05/endpoint-rule-set-1.json b/tools/code-generation/api-descriptions/bedrock-agentcore-control/2023-06-05/endpoint-rule-set-1.json deleted file mode 100644 index 9f3c71ea9a72..000000000000 --- a/tools/code-generation/api-descriptions/bedrock-agentcore-control/2023-06-05/endpoint-rule-set-1.json +++ /dev/null @@ -1,350 +0,0 @@ -{ - "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://bedrock-agentcore-control-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://bedrock-agentcore-control-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://bedrock-agentcore-control.{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://bedrock-agentcore-control.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ], - "type": "tree" - } - ] -} \ No newline at end of file diff --git a/tools/code-generation/api-descriptions/bedrock-agentcore-control/2023-06-05/endpoint-tests-1.json b/tools/code-generation/api-descriptions/bedrock-agentcore-control/2023-06-05/endpoint-tests-1.json deleted file mode 100644 index ed9b96e43ac7..000000000000 --- a/tools/code-generation/api-descriptions/bedrock-agentcore-control/2023-06-05/endpoint-tests-1.json +++ /dev/null @@ -1,270 +0,0 @@ -{ - "testCases": [ - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://bedrock-agentcore-control-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://bedrock-agentcore-control-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://bedrock-agentcore-control.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://bedrock-agentcore-control.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://bedrock-agentcore-control-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://bedrock-agentcore-control-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://bedrock-agentcore-control.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://bedrock-agentcore-control.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://bedrock-agentcore-control-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://bedrock-agentcore-control-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://bedrock-agentcore-control.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://bedrock-agentcore-control.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 disabled", - "expect": { - "endpoint": { - "url": "https://bedrock-agentcore-control-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 disabled", - "expect": { - "endpoint": { - "url": "https://bedrock-agentcore-control.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 disabled", - "expect": { - "endpoint": { - "url": "https://bedrock-agentcore-control-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 disabled", - "expect": { - "endpoint": { - "url": "https://bedrock-agentcore-control.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" -} \ No newline at end of file diff --git a/tools/code-generation/api-descriptions/bedrock-agentcore-control/2023-06-05/examples-1.json b/tools/code-generation/api-descriptions/bedrock-agentcore-control/2023-06-05/examples-1.json deleted file mode 100644 index 2fb77604d1be..000000000000 --- a/tools/code-generation/api-descriptions/bedrock-agentcore-control/2023-06-05/examples-1.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "version": "1.0", - "examples": {} -} diff --git a/tools/code-generation/api-descriptions/bedrock-agentcore-control/2023-06-05/paginators-1.json b/tools/code-generation/api-descriptions/bedrock-agentcore-control/2023-06-05/paginators-1.json deleted file mode 100644 index d0ab8a000f47..000000000000 --- a/tools/code-generation/api-descriptions/bedrock-agentcore-control/2023-06-05/paginators-1.json +++ /dev/null @@ -1,214 +0,0 @@ -{ - "pagination": { - "ListAgentRuntimeEndpoints": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "runtimeEndpoints" - }, - "ListAgentRuntimeVersions": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "agentRuntimes" - }, - "ListAgentRuntimes": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "agentRuntimes" - }, - "ListApiKeyCredentialProviders": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "credentialProviders" - }, - "ListBrowserProfiles": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "profileSummaries" - }, - "ListBrowsers": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "browserSummaries" - }, - "ListCodeInterpreters": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "codeInterpreterSummaries" - }, - "ListConfigurationBundleVersions": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "versions" - }, - "ListConfigurationBundles": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "bundles" - }, - "ListDatasetExamples": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "examples" - }, - "ListDatasetVersions": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "versions" - }, - "ListDatasets": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "datasets" - }, - "ListEvaluators": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "evaluators" - }, - "ListGatewayRules": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "gatewayRules" - }, - "ListGatewayTargets": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "items" - }, - "ListGateways": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "items" - }, - "ListHarnessEndpoints": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "endpoints" - }, - "ListHarnessVersions": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "harnessVersions" - }, - "ListHarnesses": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "harnesses" - }, - "ListMemories": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "memories" - }, - "ListOauth2CredentialProviders": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "credentialProviders" - }, - "ListOnlineEvaluationConfigs": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "onlineEvaluationConfigs" - }, - "ListPaymentConnectors": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "paymentConnectors" - }, - "ListPaymentCredentialProviders": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "credentialProviders" - }, - "ListPaymentManagers": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "paymentManagers" - }, - "ListPolicies": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "policies" - }, - "ListPolicyEngineSummaries": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "policyEngines" - }, - "ListPolicyEngines": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "policyEngines" - }, - "ListPolicyGenerationAssets": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "policyGenerationAssets" - }, - "ListPolicyGenerationSummaries": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "policyGenerations" - }, - "ListPolicyGenerations": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "policyGenerations" - }, - "ListPolicySummaries": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "policies" - }, - "ListRegistries": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "registries" - }, - "ListRegistryRecords": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "registryRecords" - }, - "ListWorkloadIdentities": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "workloadIdentities" - } - } -} diff --git a/tools/code-generation/api-descriptions/bedrock-agentcore-control/2023-06-05/service-2.json b/tools/code-generation/api-descriptions/bedrock-agentcore-control/2023-06-05/service-2.json deleted file mode 100644 index 05b1536f6749..000000000000 --- a/tools/code-generation/api-descriptions/bedrock-agentcore-control/2023-06-05/service-2.json +++ /dev/null @@ -1,22407 +0,0 @@ -{ - "version":"2.0", - "metadata":{ - "apiVersion":"2023-06-05", - "auth":["aws.auth#sigv4"], - "endpointPrefix":"bedrock-agentcore-control", - "protocol":"rest-json", - "protocols":["rest-json"], - "serviceFullName":"Amazon Bedrock AgentCore Control", - "serviceId":"Bedrock AgentCore Control", - "signatureVersion":"v4", - "signingName":"bedrock-agentcore", - "uid":"bedrock-agentcore-control-2023-06-05" - }, - "operations":{ - "AddDatasetExamples":{ - "name":"AddDatasetExamples", - "http":{ - "method":"POST", - "requestUri":"/datasets/{datasetId}/examples/add", - "responseCode":202 - }, - "input":{"shape":"AddDatasetExamplesRequest"}, - "output":{"shape":"AddDatasetExamplesResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Adds examples to the dataset's DRAFT. All examples are validated against the dataset's schema type before any writes occur. If any example fails validation, the entire batch is rejected (all-or-nothing semantics).

" - }, - "CreateAgentRuntime":{ - "name":"CreateAgentRuntime", - "http":{ - "method":"PUT", - "requestUri":"/runtimes/", - "responseCode":202 - }, - "input":{"shape":"CreateAgentRuntimeRequest"}, - "output":{"shape":"CreateAgentRuntimeResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Creates an Amazon Bedrock AgentCore Runtime.

", - "idempotent":true - }, - "CreateAgentRuntimeEndpoint":{ - "name":"CreateAgentRuntimeEndpoint", - "http":{ - "method":"PUT", - "requestUri":"/runtimes/{agentRuntimeId}/runtime-endpoints/", - "responseCode":202 - }, - "input":{"shape":"CreateAgentRuntimeEndpointRequest"}, - "output":{"shape":"CreateAgentRuntimeEndpointResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Creates an AgentCore Runtime endpoint.

", - "idempotent":true - }, - "CreateApiKeyCredentialProvider":{ - "name":"CreateApiKeyCredentialProvider", - "http":{ - "method":"POST", - "requestUri":"/identities/CreateApiKeyCredentialProvider", - "responseCode":201 - }, - "input":{"shape":"CreateApiKeyCredentialProviderRequest"}, - "output":{"shape":"CreateApiKeyCredentialProviderResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"UnauthorizedException"}, - {"shape":"ResourceLimitExceededException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"AccessDeniedException"}, - {"shape":"DecryptionFailure"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"}, - {"shape":"EncryptionFailure"} - ], - "documentation":"

Creates a new API key credential provider.

", - "idempotent":true - }, - "CreateBrowser":{ - "name":"CreateBrowser", - "http":{ - "method":"PUT", - "requestUri":"/browsers", - "responseCode":202 - }, - "input":{"shape":"CreateBrowserRequest"}, - "output":{"shape":"CreateBrowserResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Creates a custom browser.

", - "idempotent":true - }, - "CreateBrowserProfile":{ - "name":"CreateBrowserProfile", - "http":{ - "method":"PUT", - "requestUri":"/browser-profiles", - "responseCode":200 - }, - "input":{"shape":"CreateBrowserProfileRequest"}, - "output":{"shape":"CreateBrowserProfileResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Creates a browser profile in Amazon Bedrock AgentCore. A browser profile stores persistent browser data such as cookies, local storage, session storage, and browsing history that can be saved from browser sessions and reused in subsequent sessions.

", - "idempotent":true - }, - "CreateCodeInterpreter":{ - "name":"CreateCodeInterpreter", - "http":{ - "method":"PUT", - "requestUri":"/code-interpreters", - "responseCode":202 - }, - "input":{"shape":"CreateCodeInterpreterRequest"}, - "output":{"shape":"CreateCodeInterpreterResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Creates a custom code interpreter.

", - "idempotent":true - }, - "CreateConfigurationBundle":{ - "name":"CreateConfigurationBundle", - "http":{ - "method":"POST", - "requestUri":"/configuration-bundles/create", - "responseCode":201 - }, - "input":{"shape":"CreateConfigurationBundleRequest"}, - "output":{"shape":"CreateConfigurationBundleResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Creates a new configuration bundle resource. A configuration bundle stores versioned component configurations for agent evaluation workflows.

" - }, - "CreateDataset":{ - "name":"CreateDataset", - "http":{ - "method":"POST", - "requestUri":"/datasets", - "responseCode":202 - }, - "input":{"shape":"CreateDatasetRequest"}, - "output":{"shape":"CreateDatasetResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Creates a new dataset resource asynchronously. Returns immediately with status CREATING. Poll GetDataset until status transitions to ACTIVE or CREATE_FAILED.

" - }, - "CreateDatasetVersion":{ - "name":"CreateDatasetVersion", - "http":{ - "method":"POST", - "requestUri":"/datasets/{datasetId}/versions", - "responseCode":202 - }, - "input":{"shape":"CreateDatasetVersionRequest"}, - "output":{"shape":"CreateDatasetVersionResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Publishes the current DRAFT as a new numbered version. The DRAFT is preserved and remains editable after publishing. Returns immediately with status UPDATING. Poll GetDataset until status transitions to ACTIVE or UPDATE_FAILED.

" - }, - "CreateEvaluator":{ - "name":"CreateEvaluator", - "http":{ - "method":"POST", - "requestUri":"/evaluators/create", - "responseCode":202 - }, - "input":{"shape":"CreateEvaluatorRequest"}, - "output":{"shape":"CreateEvaluatorResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Creates a custom evaluator for agent quality assessment. Custom evaluators can use either LLM-as-a-Judge configurations with user-defined prompts, rating scales, and model settings, or code-based configurations with customer-managed Lambda functions to evaluate agent performance at tool call, trace, or session levels.

" - }, - "CreateGateway":{ - "name":"CreateGateway", - "http":{ - "method":"POST", - "requestUri":"/gateways/", - "responseCode":202 - }, - "input":{"shape":"CreateGatewayRequest"}, - "output":{"shape":"CreateGatewayResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Creates a gateway for Amazon Bedrock Agent. A gateway serves as an integration point between your agent and external services.

If you specify CUSTOM_JWT as the authorizerType, you must provide an authorizerConfiguration.

", - "idempotent":true - }, - "CreateGatewayRule":{ - "name":"CreateGatewayRule", - "http":{ - "method":"POST", - "requestUri":"/gateways/{gatewayIdentifier}/rules", - "responseCode":202 - }, - "input":{"shape":"CreateGatewayRuleRequest"}, - "output":{"shape":"CreateGatewayRuleResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Creates a rule for a gateway. Rules define conditions and actions that control how requests are routed and processed through the gateway, including principal-based access control and path-based routing.

", - "idempotent":true - }, - "CreateGatewayTarget":{ - "name":"CreateGatewayTarget", - "http":{ - "method":"POST", - "requestUri":"/gateways/{gatewayIdentifier}/targets/", - "responseCode":202 - }, - "input":{"shape":"CreateGatewayTargetRequest"}, - "output":{"shape":"CreateGatewayTargetResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Creates a target for a gateway. A target defines an endpoint that the gateway can connect to.

", - "idempotent":true - }, - "CreateHarness":{ - "name":"CreateHarness", - "http":{ - "method":"POST", - "requestUri":"/harnesses", - "responseCode":201 - }, - "input":{"shape":"CreateHarnessRequest"}, - "output":{"shape":"CreateHarnessResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Operation to create a harness.

", - "idempotent":true - }, - "CreateHarnessEndpoint":{ - "name":"CreateHarnessEndpoint", - "http":{ - "method":"POST", - "requestUri":"/harnesses/{harnessId}/endpoints", - "responseCode":201 - }, - "input":{"shape":"CreateHarnessEndpointRequest"}, - "output":{"shape":"CreateHarnessEndpointResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Operation to create a harness endpoint.

", - "idempotent":true - }, - "CreateMemory":{ - "name":"CreateMemory", - "http":{ - "method":"POST", - "requestUri":"/memories/create", - "responseCode":202 - }, - "input":{"shape":"CreateMemoryInput"}, - "output":{"shape":"CreateMemoryOutput"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ServiceException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottledException"} - ], - "documentation":"

Creates a new Amazon Bedrock AgentCore Memory resource.

", - "idempotent":true - }, - "CreateOauth2CredentialProvider":{ - "name":"CreateOauth2CredentialProvider", - "http":{ - "method":"POST", - "requestUri":"/identities/CreateOauth2CredentialProvider", - "responseCode":201 - }, - "input":{"shape":"CreateOauth2CredentialProviderRequest"}, - "output":{"shape":"CreateOauth2CredentialProviderResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"UnauthorizedException"}, - {"shape":"ResourceLimitExceededException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"AccessDeniedException"}, - {"shape":"DecryptionFailure"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"}, - {"shape":"EncryptionFailure"} - ], - "documentation":"

Creates a new OAuth2 credential provider.

", - "idempotent":true - }, - "CreateOnlineEvaluationConfig":{ - "name":"CreateOnlineEvaluationConfig", - "http":{ - "method":"POST", - "requestUri":"/online-evaluation-configs/create", - "responseCode":202 - }, - "input":{"shape":"CreateOnlineEvaluationConfigRequest"}, - "output":{"shape":"CreateOnlineEvaluationConfigResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Creates an online evaluation configuration for continuous monitoring of agent performance. Online evaluation automatically samples live traffic from CloudWatch logs at specified rates and applies evaluators to assess agent quality in production.

" - }, - "CreatePaymentConnector":{ - "name":"CreatePaymentConnector", - "http":{ - "method":"POST", - "requestUri":"/payments/managers/{paymentManagerId}/connectors", - "responseCode":202 - }, - "input":{"shape":"CreatePaymentConnectorRequest"}, - "output":{"shape":"CreatePaymentConnectorResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Creates a new payment connector for a payment manager. A payment connector integrates with a supported payment provider to enable payment processing capabilities.

", - "idempotent":true - }, - "CreatePaymentCredentialProvider":{ - "name":"CreatePaymentCredentialProvider", - "http":{ - "method":"POST", - "requestUri":"/identities/CreatePaymentCredentialProvider", - "responseCode":201 - }, - "input":{"shape":"CreatePaymentCredentialProviderRequest"}, - "output":{"shape":"CreatePaymentCredentialProviderResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"UnauthorizedException"}, - {"shape":"ResourceLimitExceededException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"AccessDeniedException"}, - {"shape":"DecryptionFailure"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"}, - {"shape":"EncryptionFailure"} - ], - "documentation":"

Creates a new payment credential provider for storing authentication credentials used by payment connectors to communicate with external payment providers.

", - "idempotent":true - }, - "CreatePaymentManager":{ - "name":"CreatePaymentManager", - "http":{ - "method":"POST", - "requestUri":"/payments/managers", - "responseCode":202 - }, - "input":{"shape":"CreatePaymentManagerRequest"}, - "output":{"shape":"CreatePaymentManagerResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Creates a new payment manager in your Amazon Web Services account. A payment manager serves as the top-level resource for managing payment processing capabilities, including payment connectors that integrate with supported payment providers.

If you specify CUSTOM_JWT as the authorizerType, you must provide an authorizerConfiguration.

", - "idempotent":true - }, - "CreatePolicy":{ - "name":"CreatePolicy", - "http":{ - "method":"POST", - "requestUri":"/policy-engines/{policyEngineId}/policies", - "responseCode":202 - }, - "input":{"shape":"CreatePolicyRequest"}, - "output":{"shape":"CreatePolicyResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Creates a policy within the AgentCore Policy system. Policies provide real-time, deterministic control over agentic interactions with AgentCore Gateway. Using the Cedar policy language, you can define fine-grained policies that specify which interactions with Gateway tools are permitted based on input parameters and OAuth claims, ensuring agents operate within defined boundaries and business rules. The policy is validated during creation against the Cedar schema generated from the Gateway's tools' input schemas, which defines the available tools, their parameters, and expected data types. This is an asynchronous operation. Use the GetPolicy operation to poll the status field to track completion.

" - }, - "CreatePolicyEngine":{ - "name":"CreatePolicyEngine", - "http":{ - "method":"POST", - "requestUri":"/policy-engines", - "responseCode":202 - }, - "input":{"shape":"CreatePolicyEngineRequest"}, - "output":{"shape":"CreatePolicyEngineResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Creates a new policy engine within the AgentCore Policy system. A policy engine is a collection of policies that evaluates and authorizes agent tool calls. When associated with Gateways (each Gateway can be associated with at most one policy engine, but multiple Gateways can be associated with the same engine), the policy engine intercepts all agent requests and determines whether to allow or deny each action based on the defined policies. This is an asynchronous operation. Use the GetPolicyEngine operation to poll the status field to track completion.

" - }, - "CreateRegistry":{ - "name":"CreateRegistry", - "http":{ - "method":"POST", - "requestUri":"/registries", - "responseCode":202 - }, - "input":{"shape":"CreateRegistryRequest"}, - "output":{"shape":"CreateRegistryResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Creates a new registry in your Amazon Web Services account. A registry serves as a centralized catalog for organizing and managing registry records, including MCP servers, A2A agents, agent skills, and custom resource types.

If you specify CUSTOM_JWT as the authorizerType, you must provide an authorizerConfiguration.

", - "idempotent":true - }, - "CreateRegistryRecord":{ - "name":"CreateRegistryRecord", - "http":{ - "method":"POST", - "requestUri":"/registries/{registryId}/records", - "responseCode":202 - }, - "input":{"shape":"CreateRegistryRecordRequest"}, - "output":{"shape":"CreateRegistryRecordResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Creates a new registry record within the specified registry. A registry record represents an individual AI resource's metadata in the registry. This could be an MCP server (and associated tools), A2A agent, agent skill, or a custom resource with a custom schema.

The record is processed asynchronously and returns HTTP 202 Accepted.

", - "idempotent":true - }, - "CreateWorkloadIdentity":{ - "name":"CreateWorkloadIdentity", - "http":{ - "method":"POST", - "requestUri":"/identities/CreateWorkloadIdentity", - "responseCode":201 - }, - "input":{"shape":"CreateWorkloadIdentityRequest"}, - "output":{"shape":"CreateWorkloadIdentityResponse"}, - "errors":[ - {"shape":"UnauthorizedException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Creates a new workload identity.

", - "idempotent":true - }, - "DeleteAgentRuntime":{ - "name":"DeleteAgentRuntime", - "http":{ - "method":"DELETE", - "requestUri":"/runtimes/{agentRuntimeId}/", - "responseCode":202 - }, - "input":{"shape":"DeleteAgentRuntimeRequest"}, - "output":{"shape":"DeleteAgentRuntimeResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Deletes an Amazon Bedrock AgentCore Runtime.

", - "idempotent":true - }, - "DeleteAgentRuntimeEndpoint":{ - "name":"DeleteAgentRuntimeEndpoint", - "http":{ - "method":"DELETE", - "requestUri":"/runtimes/{agentRuntimeId}/runtime-endpoints/{endpointName}/", - "responseCode":202 - }, - "input":{"shape":"DeleteAgentRuntimeEndpointRequest"}, - "output":{"shape":"DeleteAgentRuntimeEndpointResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Deletes an AAgentCore Runtime endpoint.

", - "idempotent":true - }, - "DeleteApiKeyCredentialProvider":{ - "name":"DeleteApiKeyCredentialProvider", - "http":{ - "method":"POST", - "requestUri":"/identities/DeleteApiKeyCredentialProvider", - "responseCode":204 - }, - "input":{"shape":"DeleteApiKeyCredentialProviderRequest"}, - "output":{"shape":"DeleteApiKeyCredentialProviderResponse"}, - "errors":[ - {"shape":"UnauthorizedException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Deletes an API key credential provider.

", - "idempotent":true - }, - "DeleteBrowser":{ - "name":"DeleteBrowser", - "http":{ - "method":"DELETE", - "requestUri":"/browsers/{browserId}", - "responseCode":202 - }, - "input":{"shape":"DeleteBrowserRequest"}, - "output":{"shape":"DeleteBrowserResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Deletes a custom browser.

", - "idempotent":true - }, - "DeleteBrowserProfile":{ - "name":"DeleteBrowserProfile", - "http":{ - "method":"DELETE", - "requestUri":"/browser-profiles/{profileId}", - "responseCode":200 - }, - "input":{"shape":"DeleteBrowserProfileRequest"}, - "output":{"shape":"DeleteBrowserProfileResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Deletes a browser profile.

", - "idempotent":true - }, - "DeleteCodeInterpreter":{ - "name":"DeleteCodeInterpreter", - "http":{ - "method":"DELETE", - "requestUri":"/code-interpreters/{codeInterpreterId}", - "responseCode":202 - }, - "input":{"shape":"DeleteCodeInterpreterRequest"}, - "output":{"shape":"DeleteCodeInterpreterResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Deletes a custom code interpreter.

", - "idempotent":true - }, - "DeleteConfigurationBundle":{ - "name":"DeleteConfigurationBundle", - "http":{ - "method":"DELETE", - "requestUri":"/configuration-bundles/{bundleId}", - "responseCode":202 - }, - "input":{"shape":"DeleteConfigurationBundleRequest"}, - "output":{"shape":"DeleteConfigurationBundleResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Deletes a configuration bundle and all of its versions.

", - "idempotent":true - }, - "DeleteDataset":{ - "name":"DeleteDataset", - "http":{ - "method":"DELETE", - "requestUri":"/datasets/{datasetId}", - "responseCode":202 - }, - "input":{"shape":"DeleteDatasetRequest"}, - "output":{"shape":"DeleteDatasetResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Deletes a dataset version or an entire dataset asynchronously. If datasetVersion is absent, deletes all versions and the dataset record itself. If provided, deletes only that specific version.

", - "idempotent":true - }, - "DeleteDatasetExamples":{ - "name":"DeleteDatasetExamples", - "http":{ - "method":"POST", - "requestUri":"/datasets/{datasetId}/examples/delete", - "responseCode":202 - }, - "input":{"shape":"DeleteDatasetExamplesRequest"}, - "output":{"shape":"DeleteDatasetExamplesResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Deletes specific examples by ID from DRAFT. All example IDs are validated before any deletes occur. If any ID does not exist in DRAFT, the entire batch is rejected (all-or-nothing semantics).

" - }, - "DeleteEvaluator":{ - "name":"DeleteEvaluator", - "http":{ - "method":"DELETE", - "requestUri":"/evaluators/{evaluatorId}", - "responseCode":202 - }, - "input":{"shape":"DeleteEvaluatorRequest"}, - "output":{"shape":"DeleteEvaluatorResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Deletes a custom evaluator. Builtin evaluators cannot be deleted. The evaluator must not be referenced by any active online evaluation configurations.

", - "idempotent":true - }, - "DeleteGateway":{ - "name":"DeleteGateway", - "http":{ - "method":"DELETE", - "requestUri":"/gateways/{gatewayIdentifier}/", - "responseCode":202 - }, - "input":{"shape":"DeleteGatewayRequest"}, - "output":{"shape":"DeleteGatewayResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Deletes a gateway.

", - "idempotent":true - }, - "DeleteGatewayRule":{ - "name":"DeleteGatewayRule", - "http":{ - "method":"DELETE", - "requestUri":"/gateways/{gatewayIdentifier}/rules/{ruleId}", - "responseCode":202 - }, - "input":{"shape":"DeleteGatewayRuleRequest"}, - "output":{"shape":"DeleteGatewayRuleResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Deletes a gateway rule.

", - "idempotent":true - }, - "DeleteGatewayTarget":{ - "name":"DeleteGatewayTarget", - "http":{ - "method":"DELETE", - "requestUri":"/gateways/{gatewayIdentifier}/targets/{targetId}/", - "responseCode":202 - }, - "input":{"shape":"DeleteGatewayTargetRequest"}, - "output":{"shape":"DeleteGatewayTargetResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Deletes a gateway target.

You cannot delete a target that is in a pending authorization state (CREATE_PENDING_AUTH, UPDATE_PENDING_AUTH, or SYNCHRONIZE_PENDING_AUTH). Wait for the authorization to complete or fail before deleting the target.

", - "idempotent":true - }, - "DeleteHarness":{ - "name":"DeleteHarness", - "http":{ - "method":"DELETE", - "requestUri":"/harnesses/{harnessId}", - "responseCode":200 - }, - "input":{"shape":"DeleteHarnessRequest"}, - "output":{"shape":"DeleteHarnessResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Operation to delete a Harness.

", - "idempotent":true - }, - "DeleteHarnessEndpoint":{ - "name":"DeleteHarnessEndpoint", - "http":{ - "method":"DELETE", - "requestUri":"/harnesses/{harnessId}/endpoints/{endpointName}", - "responseCode":200 - }, - "input":{"shape":"DeleteHarnessEndpointRequest"}, - "output":{"shape":"DeleteHarnessEndpointResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Operation to delete a harness endpoint.

", - "idempotent":true - }, - "DeleteMemory":{ - "name":"DeleteMemory", - "http":{ - "method":"DELETE", - "requestUri":"/memories/{memoryId}/delete", - "responseCode":202 - }, - "input":{"shape":"DeleteMemoryInput"}, - "output":{"shape":"DeleteMemoryOutput"}, - "errors":[ - {"shape":"ServiceException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottledException"} - ], - "documentation":"

Deletes an Amazon Bedrock AgentCore Memory resource.

", - "idempotent":true - }, - "DeleteOauth2CredentialProvider":{ - "name":"DeleteOauth2CredentialProvider", - "http":{ - "method":"POST", - "requestUri":"/identities/DeleteOauth2CredentialProvider", - "responseCode":204 - }, - "input":{"shape":"DeleteOauth2CredentialProviderRequest"}, - "output":{"shape":"DeleteOauth2CredentialProviderResponse"}, - "errors":[ - {"shape":"UnauthorizedException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Deletes an OAuth2 credential provider.

", - "idempotent":true - }, - "DeleteOnlineEvaluationConfig":{ - "name":"DeleteOnlineEvaluationConfig", - "http":{ - "method":"DELETE", - "requestUri":"/online-evaluation-configs/{onlineEvaluationConfigId}", - "responseCode":202 - }, - "input":{"shape":"DeleteOnlineEvaluationConfigRequest"}, - "output":{"shape":"DeleteOnlineEvaluationConfigResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Deletes an online evaluation configuration and stops any ongoing evaluation processes associated with it.

", - "idempotent":true - }, - "DeletePaymentConnector":{ - "name":"DeletePaymentConnector", - "http":{ - "method":"DELETE", - "requestUri":"/payments/managers/{paymentManagerId}/connectors/{paymentConnectorId}", - "responseCode":202 - }, - "input":{"shape":"DeletePaymentConnectorRequest"}, - "output":{"shape":"DeletePaymentConnectorResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Deletes a payment connector.

", - "idempotent":true - }, - "DeletePaymentCredentialProvider":{ - "name":"DeletePaymentCredentialProvider", - "http":{ - "method":"POST", - "requestUri":"/identities/DeletePaymentCredentialProvider", - "responseCode":204 - }, - "input":{"shape":"DeletePaymentCredentialProviderRequest"}, - "output":{"shape":"DeletePaymentCredentialProviderResponse"}, - "errors":[ - {"shape":"UnauthorizedException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Deletes a payment credential provider and its associated stored credentials.

", - "idempotent":true - }, - "DeletePaymentManager":{ - "name":"DeletePaymentManager", - "http":{ - "method":"DELETE", - "requestUri":"/payments/managers/{paymentManagerId}", - "responseCode":202 - }, - "input":{"shape":"DeletePaymentManagerRequest"}, - "output":{"shape":"DeletePaymentManagerResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Deletes a payment manager. All payment connectors associated with the payment manager must be deleted before the payment manager can be deleted. This operation initiates the deletion process asynchronously.

", - "idempotent":true - }, - "DeletePolicy":{ - "name":"DeletePolicy", - "http":{ - "method":"DELETE", - "requestUri":"/policy-engines/{policyEngineId}/policies/{policyId}", - "responseCode":202 - }, - "input":{"shape":"DeletePolicyRequest"}, - "output":{"shape":"DeletePolicyResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Deletes an existing policy from the AgentCore Policy system. Once deleted, the policy can no longer be used for agent behavior control and all references to it become invalid. This is an asynchronous operation. Use the GetPolicy operation to poll the status field to track completion.

", - "idempotent":true - }, - "DeletePolicyEngine":{ - "name":"DeletePolicyEngine", - "http":{ - "method":"DELETE", - "requestUri":"/policy-engines/{policyEngineId}", - "responseCode":202 - }, - "input":{"shape":"DeletePolicyEngineRequest"}, - "output":{"shape":"DeletePolicyEngineResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Deletes an existing policy engine from the AgentCore Policy system. The policy engine must not have any associated policies before deletion. Once deleted, the policy engine and all its configurations become unavailable for policy management and evaluation. This is an asynchronous operation. Use the GetPolicyEngine operation to poll the status field to track completion.

", - "idempotent":true - }, - "DeleteRegistry":{ - "name":"DeleteRegistry", - "http":{ - "method":"DELETE", - "requestUri":"/registries/{registryId}", - "responseCode":202 - }, - "input":{"shape":"DeleteRegistryRequest"}, - "output":{"shape":"DeleteRegistryResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Deletes a registry. The registry must contain zero records before it can be deleted. This operation initiates the deletion process asynchronously.

", - "idempotent":true - }, - "DeleteRegistryRecord":{ - "name":"DeleteRegistryRecord", - "http":{ - "method":"DELETE", - "requestUri":"/registries/{registryId}/records/{recordId}", - "responseCode":200 - }, - "input":{"shape":"DeleteRegistryRecordRequest"}, - "output":{"shape":"DeleteRegistryRecordResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Deletes a registry record. The record's status transitions to DELETING and the record is removed asynchronously.

", - "idempotent":true - }, - "DeleteResourcePolicy":{ - "name":"DeleteResourcePolicy", - "http":{ - "method":"DELETE", - "requestUri":"/resourcepolicy/{resourceArn}", - "responseCode":204 - }, - "input":{"shape":"DeleteResourcePolicyRequest"}, - "output":{"shape":"DeleteResourcePolicyResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Deletes the resource-based policy for a specified resource.

This feature is currently available only for AgentCore Runtime and Gateway.

", - "idempotent":true - }, - "DeleteWorkloadIdentity":{ - "name":"DeleteWorkloadIdentity", - "http":{ - "method":"POST", - "requestUri":"/identities/DeleteWorkloadIdentity", - "responseCode":204 - }, - "input":{"shape":"DeleteWorkloadIdentityRequest"}, - "output":{"shape":"DeleteWorkloadIdentityResponse"}, - "errors":[ - {"shape":"UnauthorizedException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Deletes a workload identity.

", - "idempotent":true - }, - "GetAgentRuntime":{ - "name":"GetAgentRuntime", - "http":{ - "method":"GET", - "requestUri":"/runtimes/{agentRuntimeId}/", - "responseCode":200 - }, - "input":{"shape":"GetAgentRuntimeRequest"}, - "output":{"shape":"GetAgentRuntimeResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Gets an Amazon Bedrock AgentCore Runtime.

", - "readonly":true - }, - "GetAgentRuntimeEndpoint":{ - "name":"GetAgentRuntimeEndpoint", - "http":{ - "method":"GET", - "requestUri":"/runtimes/{agentRuntimeId}/runtime-endpoints/{endpointName}/", - "responseCode":200 - }, - "input":{"shape":"GetAgentRuntimeEndpointRequest"}, - "output":{"shape":"GetAgentRuntimeEndpointResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Gets information about an Amazon Secure AgentEndpoint.

", - "readonly":true - }, - "GetApiKeyCredentialProvider":{ - "name":"GetApiKeyCredentialProvider", - "http":{ - "method":"POST", - "requestUri":"/identities/GetApiKeyCredentialProvider", - "responseCode":200 - }, - "input":{"shape":"GetApiKeyCredentialProviderRequest"}, - "output":{"shape":"GetApiKeyCredentialProviderResponse"}, - "errors":[ - {"shape":"UnauthorizedException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"DecryptionFailure"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Retrieves information about an API key credential provider.

", - "readonly":true - }, - "GetBrowser":{ - "name":"GetBrowser", - "http":{ - "method":"GET", - "requestUri":"/browsers/{browserId}", - "responseCode":200 - }, - "input":{"shape":"GetBrowserRequest"}, - "output":{"shape":"GetBrowserResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Gets information about a custom browser.

", - "readonly":true - }, - "GetBrowserProfile":{ - "name":"GetBrowserProfile", - "http":{ - "method":"GET", - "requestUri":"/browser-profiles/{profileId}", - "responseCode":200 - }, - "input":{"shape":"GetBrowserProfileRequest"}, - "output":{"shape":"GetBrowserProfileResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Gets information about a browser profile.

", - "readonly":true - }, - "GetCodeInterpreter":{ - "name":"GetCodeInterpreter", - "http":{ - "method":"GET", - "requestUri":"/code-interpreters/{codeInterpreterId}", - "responseCode":200 - }, - "input":{"shape":"GetCodeInterpreterRequest"}, - "output":{"shape":"GetCodeInterpreterResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Gets information about a custom code interpreter.

", - "readonly":true - }, - "GetConfigurationBundle":{ - "name":"GetConfigurationBundle", - "http":{ - "method":"GET", - "requestUri":"/configuration-bundles/{bundleId}", - "responseCode":200 - }, - "input":{"shape":"GetConfigurationBundleRequest"}, - "output":{"shape":"GetConfigurationBundleResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Gets the latest version of a configuration bundle. By default, returns the latest version on the mainline branch. Use GetConfigurationBundleVersion to retrieve a specific historical version.

", - "readonly":true - }, - "GetConfigurationBundleVersion":{ - "name":"GetConfigurationBundleVersion", - "http":{ - "method":"GET", - "requestUri":"/configuration-bundles/{bundleId}/versions/{versionId}", - "responseCode":200 - }, - "input":{"shape":"GetConfigurationBundleVersionRequest"}, - "output":{"shape":"GetConfigurationBundleVersionResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Gets a specific version of a configuration bundle by its version identifier.

", - "readonly":true - }, - "GetDataset":{ - "name":"GetDataset", - "http":{ - "method":"GET", - "requestUri":"/datasets/{datasetId}", - "responseCode":200 - }, - "input":{"shape":"GetDatasetRequest"}, - "output":{"shape":"GetDatasetResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Retrieves dataset metadata. Use the datasetVersion query parameter to retrieve a specific version's metadata. If absent, defaults to DRAFT. For paginated example content, use ListDatasetExamples.

", - "readonly":true - }, - "GetEvaluator":{ - "name":"GetEvaluator", - "http":{ - "method":"GET", - "requestUri":"/evaluators/{evaluatorId}", - "responseCode":200 - }, - "input":{"shape":"GetEvaluatorRequest"}, - "output":{"shape":"GetEvaluatorResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Retrieves detailed information about an evaluator, including its configuration, status, and metadata. Works with both built-in and custom evaluators.

", - "readonly":true - }, - "GetGateway":{ - "name":"GetGateway", - "http":{ - "method":"GET", - "requestUri":"/gateways/{gatewayIdentifier}/", - "responseCode":200 - }, - "input":{"shape":"GetGatewayRequest"}, - "output":{"shape":"GetGatewayResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Retrieves information about a specific Gateway.

", - "readonly":true - }, - "GetGatewayRule":{ - "name":"GetGatewayRule", - "http":{ - "method":"GET", - "requestUri":"/gateways/{gatewayIdentifier}/rules/{ruleId}", - "responseCode":200 - }, - "input":{"shape":"GetGatewayRuleRequest"}, - "output":{"shape":"GetGatewayRuleResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Retrieves detailed information about a specific gateway rule.

", - "readonly":true - }, - "GetGatewayTarget":{ - "name":"GetGatewayTarget", - "http":{ - "method":"GET", - "requestUri":"/gateways/{gatewayIdentifier}/targets/{targetId}/", - "responseCode":200 - }, - "input":{"shape":"GetGatewayTargetRequest"}, - "output":{"shape":"GetGatewayTargetResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Retrieves information about a specific gateway target.

", - "readonly":true - }, - "GetHarness":{ - "name":"GetHarness", - "http":{ - "method":"GET", - "requestUri":"/harnesses/{harnessId}", - "responseCode":200 - }, - "input":{"shape":"GetHarnessRequest"}, - "output":{"shape":"GetHarnessResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Operation to get a single harness.

", - "readonly":true - }, - "GetHarnessEndpoint":{ - "name":"GetHarnessEndpoint", - "http":{ - "method":"GET", - "requestUri":"/harnesses/{harnessId}/endpoints/{endpointName}", - "responseCode":200 - }, - "input":{"shape":"GetHarnessEndpointRequest"}, - "output":{"shape":"GetHarnessEndpointResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Operation to get a single harness endpoint.

", - "readonly":true - }, - "GetMemory":{ - "name":"GetMemory", - "http":{ - "method":"GET", - "requestUri":"/memories/{memoryId}/details", - "responseCode":200 - }, - "input":{"shape":"GetMemoryInput"}, - "output":{"shape":"GetMemoryOutput"}, - "errors":[ - {"shape":"ServiceException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottledException"} - ], - "documentation":"

Retrieve an existing Amazon Bedrock AgentCore Memory resource.

", - "readonly":true - }, - "GetOauth2CredentialProvider":{ - "name":"GetOauth2CredentialProvider", - "http":{ - "method":"POST", - "requestUri":"/identities/GetOauth2CredentialProvider", - "responseCode":200 - }, - "input":{"shape":"GetOauth2CredentialProviderRequest"}, - "output":{"shape":"GetOauth2CredentialProviderResponse"}, - "errors":[ - {"shape":"UnauthorizedException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"DecryptionFailure"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Retrieves information about an OAuth2 credential provider.

", - "readonly":true - }, - "GetOnlineEvaluationConfig":{ - "name":"GetOnlineEvaluationConfig", - "http":{ - "method":"GET", - "requestUri":"/online-evaluation-configs/{onlineEvaluationConfigId}", - "responseCode":200 - }, - "input":{"shape":"GetOnlineEvaluationConfigRequest"}, - "output":{"shape":"GetOnlineEvaluationConfigResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Retrieves detailed information about an online evaluation configuration, including its rules, data sources, evaluators, and execution status.

", - "readonly":true - }, - "GetPaymentConnector":{ - "name":"GetPaymentConnector", - "http":{ - "method":"GET", - "requestUri":"/payments/managers/{paymentManagerId}/connectors/{paymentConnectorId}", - "responseCode":200 - }, - "input":{"shape":"GetPaymentConnectorRequest"}, - "output":{"shape":"GetPaymentConnectorResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Retrieves information about a specific payment connector.

", - "readonly":true - }, - "GetPaymentCredentialProvider":{ - "name":"GetPaymentCredentialProvider", - "http":{ - "method":"POST", - "requestUri":"/identities/GetPaymentCredentialProvider", - "responseCode":200 - }, - "input":{"shape":"GetPaymentCredentialProviderRequest"}, - "output":{"shape":"GetPaymentCredentialProviderResponse"}, - "errors":[ - {"shape":"UnauthorizedException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"DecryptionFailure"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Retrieves information about a specific payment credential provider.

", - "readonly":true - }, - "GetPaymentManager":{ - "name":"GetPaymentManager", - "http":{ - "method":"GET", - "requestUri":"/payments/managers/{paymentManagerId}", - "responseCode":200 - }, - "input":{"shape":"GetPaymentManagerRequest"}, - "output":{"shape":"GetPaymentManagerResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Retrieves information about a specific payment manager.

", - "readonly":true - }, - "GetPolicy":{ - "name":"GetPolicy", - "http":{ - "method":"GET", - "requestUri":"/policy-engines/{policyEngineId}/policies/{policyId}", - "responseCode":200 - }, - "input":{"shape":"GetPolicyRequest"}, - "output":{"shape":"GetPolicyResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Retrieves detailed information about a specific policy within the AgentCore Policy system. This operation returns the complete policy definition, metadata, and current status, allowing administrators to review and manage policy configurations.

", - "readonly":true - }, - "GetPolicyEngine":{ - "name":"GetPolicyEngine", - "http":{ - "method":"GET", - "requestUri":"/policy-engines/{policyEngineId}", - "responseCode":200 - }, - "input":{"shape":"GetPolicyEngineRequest"}, - "output":{"shape":"GetPolicyEngineResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Retrieves detailed information about a specific policy engine within the AgentCore Policy system. This operation returns the complete policy engine configuration, metadata, and current status, allowing administrators to review and manage policy engine settings.

", - "readonly":true - }, - "GetPolicyEngineSummary":{ - "name":"GetPolicyEngineSummary", - "http":{ - "method":"GET", - "requestUri":"/policy-engine-summaries/{policyEngineId}", - "responseCode":200 - }, - "input":{"shape":"GetPolicyEngineSummaryRequest"}, - "output":{"shape":"GetPolicyEngineSummaryResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Retrieves a metadata-only summary of a specific policy engine without decrypting customer content. This lightweight read operation returns resource identifiers, status, timestamps, and the encryption key ARN, but does not include the description or status reasons. Because this operation does not require access to the customer's KMS key, it is suitable for resource discovery, inventory, and integration scenarios where only metadata is needed.

", - "readonly":true - }, - "GetPolicyGeneration":{ - "name":"GetPolicyGeneration", - "http":{ - "method":"GET", - "requestUri":"/policy-engines/{policyEngineId}/policy-generations/{policyGenerationId}", - "responseCode":200 - }, - "input":{"shape":"GetPolicyGenerationRequest"}, - "output":{"shape":"GetPolicyGenerationResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Retrieves information about a policy generation request within the AgentCore Policy system. Policy generation converts natural language descriptions into Cedar policy statements using AI-powered translation, enabling non-technical users to create policies.

", - "readonly":true - }, - "GetPolicyGenerationSummary":{ - "name":"GetPolicyGenerationSummary", - "http":{ - "method":"GET", - "requestUri":"/policy-engines/{policyEngineId}/policy-generation-summaries/{policyGenerationId}", - "responseCode":200 - }, - "input":{"shape":"GetPolicyGenerationSummaryRequest"}, - "output":{"shape":"GetPolicyGenerationSummaryResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Retrieves a metadata-only summary of a specific policy generation request without decrypting customer content. This lightweight read operation returns resource identifiers, status, timestamps, and findings, but does not include status reasons. Because this operation does not require access to the customer's KMS key, it is suitable for resource discovery, inventory, and integration scenarios where only metadata is needed.

", - "readonly":true - }, - "GetPolicySummary":{ - "name":"GetPolicySummary", - "http":{ - "method":"GET", - "requestUri":"/policy-engines/{policyEngineId}/policy-summaries/{policyId}", - "responseCode":200 - }, - "input":{"shape":"GetPolicySummaryRequest"}, - "output":{"shape":"GetPolicySummaryResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Retrieves a metadata-only summary of a specific policy without decrypting customer content. This lightweight read operation returns resource identifiers, status, and timestamps, but does not include the policy definition, description, or status reasons. Because this operation does not require access to the customer's KMS key, it is suitable for resource discovery, inventory, and integration scenarios where only metadata is needed.

", - "readonly":true - }, - "GetRegistry":{ - "name":"GetRegistry", - "http":{ - "method":"GET", - "requestUri":"/registries/{registryId}", - "responseCode":200 - }, - "input":{"shape":"GetRegistryRequest"}, - "output":{"shape":"GetRegistryResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Retrieves information about a specific registry.

", - "readonly":true - }, - "GetRegistryRecord":{ - "name":"GetRegistryRecord", - "http":{ - "method":"GET", - "requestUri":"/registries/{registryId}/records/{recordId}", - "responseCode":200 - }, - "input":{"shape":"GetRegistryRecordRequest"}, - "output":{"shape":"GetRegistryRecordResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Retrieves information about a specific registry record.

", - "readonly":true - }, - "GetResourcePolicy":{ - "name":"GetResourcePolicy", - "http":{ - "method":"GET", - "requestUri":"/resourcepolicy/{resourceArn}", - "responseCode":200 - }, - "input":{"shape":"GetResourcePolicyRequest"}, - "output":{"shape":"GetResourcePolicyResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Retrieves the resource-based policy for a specified resource.

This feature is currently available only for AgentCore Runtime and Gateway.

", - "readonly":true - }, - "GetTokenVault":{ - "name":"GetTokenVault", - "http":{ - "method":"POST", - "requestUri":"/identities/get-token-vault", - "responseCode":200 - }, - "input":{"shape":"GetTokenVaultRequest"}, - "output":{"shape":"GetTokenVaultResponse"}, - "errors":[ - {"shape":"UnauthorizedException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Retrieves information about a token vault.

", - "readonly":true - }, - "GetWorkloadIdentity":{ - "name":"GetWorkloadIdentity", - "http":{ - "method":"POST", - "requestUri":"/identities/GetWorkloadIdentity", - "responseCode":200 - }, - "input":{"shape":"GetWorkloadIdentityRequest"}, - "output":{"shape":"GetWorkloadIdentityResponse"}, - "errors":[ - {"shape":"UnauthorizedException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Retrieves information about a workload identity.

", - "readonly":true - }, - "ListAgentRuntimeEndpoints":{ - "name":"ListAgentRuntimeEndpoints", - "http":{ - "method":"POST", - "requestUri":"/runtimes/{agentRuntimeId}/runtime-endpoints/", - "responseCode":200 - }, - "input":{"shape":"ListAgentRuntimeEndpointsRequest"}, - "output":{"shape":"ListAgentRuntimeEndpointsResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Lists all endpoints for a specific Amazon Secure Agent.

", - "readonly":true - }, - "ListAgentRuntimeVersions":{ - "name":"ListAgentRuntimeVersions", - "http":{ - "method":"POST", - "requestUri":"/runtimes/{agentRuntimeId}/versions/", - "responseCode":200 - }, - "input":{"shape":"ListAgentRuntimeVersionsRequest"}, - "output":{"shape":"ListAgentRuntimeVersionsResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Lists all versions of a specific Amazon Secure Agent.

", - "readonly":true - }, - "ListAgentRuntimes":{ - "name":"ListAgentRuntimes", - "http":{ - "method":"POST", - "requestUri":"/runtimes/", - "responseCode":200 - }, - "input":{"shape":"ListAgentRuntimesRequest"}, - "output":{"shape":"ListAgentRuntimesResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Lists all Amazon Secure Agents in your account.

", - "readonly":true - }, - "ListApiKeyCredentialProviders":{ - "name":"ListApiKeyCredentialProviders", - "http":{ - "method":"POST", - "requestUri":"/identities/ListApiKeyCredentialProviders", - "responseCode":200 - }, - "input":{"shape":"ListApiKeyCredentialProvidersRequest"}, - "output":{"shape":"ListApiKeyCredentialProvidersResponse"}, - "errors":[ - {"shape":"UnauthorizedException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Lists all API key credential providers in your account.

", - "readonly":true - }, - "ListBrowserProfiles":{ - "name":"ListBrowserProfiles", - "http":{ - "method":"POST", - "requestUri":"/browser-profiles", - "responseCode":200 - }, - "input":{"shape":"ListBrowserProfilesRequest"}, - "output":{"shape":"ListBrowserProfilesResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Lists all browser profiles in your account.

", - "readonly":true - }, - "ListBrowsers":{ - "name":"ListBrowsers", - "http":{ - "method":"POST", - "requestUri":"/browsers", - "responseCode":200 - }, - "input":{"shape":"ListBrowsersRequest"}, - "output":{"shape":"ListBrowsersResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Lists all custom browsers in your account.

", - "readonly":true - }, - "ListCodeInterpreters":{ - "name":"ListCodeInterpreters", - "http":{ - "method":"POST", - "requestUri":"/code-interpreters", - "responseCode":200 - }, - "input":{"shape":"ListCodeInterpretersRequest"}, - "output":{"shape":"ListCodeInterpretersResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Lists all custom code interpreters in your account.

", - "readonly":true - }, - "ListConfigurationBundleVersions":{ - "name":"ListConfigurationBundleVersions", - "http":{ - "method":"POST", - "requestUri":"/configuration-bundles/{bundleId}/versions", - "responseCode":200 - }, - "input":{"shape":"ListConfigurationBundleVersionsRequest"}, - "output":{"shape":"ListConfigurationBundleVersionsResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Lists all versions of a configuration bundle, with optional filtering by branch name or creation source.

", - "readonly":true - }, - "ListConfigurationBundles":{ - "name":"ListConfigurationBundles", - "http":{ - "method":"POST", - "requestUri":"/configuration-bundles", - "responseCode":200 - }, - "input":{"shape":"ListConfigurationBundlesRequest"}, - "output":{"shape":"ListConfigurationBundlesResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Lists all configuration bundles in the account.

", - "readonly":true - }, - "ListDatasetExamples":{ - "name":"ListDatasetExamples", - "http":{ - "method":"GET", - "requestUri":"/datasets/{datasetId}/examples", - "responseCode":200 - }, - "input":{"shape":"ListDatasetExamplesRequest"}, - "output":{"shape":"ListDatasetExamplesResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Returns paginated examples from the dataset. The server embeds the resolved version in the pagination token. Once pagination begins, all subsequent pages are pinned to that version regardless of concurrent mutations.

", - "readonly":true - }, - "ListDatasetVersions":{ - "name":"ListDatasetVersions", - "http":{ - "method":"GET", - "requestUri":"/datasets/{datasetId}/versions", - "responseCode":200 - }, - "input":{"shape":"ListDatasetVersionsRequest"}, - "output":{"shape":"ListDatasetVersionsResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Lists all published versions of a dataset, sorted by version number descending (newest first). Does not include the DRAFT working copy.

", - "readonly":true - }, - "ListDatasets":{ - "name":"ListDatasets", - "http":{ - "method":"GET", - "requestUri":"/datasets", - "responseCode":200 - }, - "input":{"shape":"ListDatasetsRequest"}, - "output":{"shape":"ListDatasetsResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Lists all datasets in the caller's account, paginated.

", - "readonly":true - }, - "ListEvaluators":{ - "name":"ListEvaluators", - "http":{ - "method":"POST", - "requestUri":"/evaluators", - "responseCode":200 - }, - "input":{"shape":"ListEvaluatorsRequest"}, - "output":{"shape":"ListEvaluatorsResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Lists all available evaluators, including both builtin evaluators provided by the service and custom evaluators created by the user.

", - "readonly":true - }, - "ListGatewayRules":{ - "name":"ListGatewayRules", - "http":{ - "method":"GET", - "requestUri":"/gateways/{gatewayIdentifier}/rules", - "responseCode":200 - }, - "input":{"shape":"ListGatewayRulesRequest"}, - "output":{"shape":"ListGatewayRulesResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Lists all rules for a gateway.

", - "readonly":true - }, - "ListGatewayTargets":{ - "name":"ListGatewayTargets", - "http":{ - "method":"GET", - "requestUri":"/gateways/{gatewayIdentifier}/targets/", - "responseCode":200 - }, - "input":{"shape":"ListGatewayTargetsRequest"}, - "output":{"shape":"ListGatewayTargetsResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Lists all targets for a specific gateway.

", - "readonly":true - }, - "ListGateways":{ - "name":"ListGateways", - "http":{ - "method":"GET", - "requestUri":"/gateways/", - "responseCode":200 - }, - "input":{"shape":"ListGatewaysRequest"}, - "output":{"shape":"ListGatewaysResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Lists all gateways in the account.

", - "readonly":true - }, - "ListHarnessEndpoints":{ - "name":"ListHarnessEndpoints", - "http":{ - "method":"GET", - "requestUri":"/harnesses/{harnessId}/endpoints", - "responseCode":200 - }, - "input":{"shape":"ListHarnessEndpointsRequest"}, - "output":{"shape":"ListHarnessEndpointsResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Operation to list the endpoints of a harness.

", - "readonly":true - }, - "ListHarnessVersions":{ - "name":"ListHarnessVersions", - "http":{ - "method":"GET", - "requestUri":"/harnesses/{harnessId}/versions", - "responseCode":200 - }, - "input":{"shape":"ListHarnessVersionsRequest"}, - "output":{"shape":"ListHarnessVersionsResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Operation to list the versions of a Harness.

", - "readonly":true - }, - "ListHarnesses":{ - "name":"ListHarnesses", - "http":{ - "method":"GET", - "requestUri":"/harnesses", - "responseCode":200 - }, - "input":{"shape":"ListHarnessesRequest"}, - "output":{"shape":"ListHarnessesResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Operation to list harnesses.

", - "readonly":true - }, - "ListMemories":{ - "name":"ListMemories", - "http":{ - "method":"POST", - "requestUri":"/memories/", - "responseCode":200 - }, - "input":{"shape":"ListMemoriesInput"}, - "output":{"shape":"ListMemoriesOutput"}, - "errors":[ - {"shape":"ServiceException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottledException"} - ], - "documentation":"

Lists the available Amazon Bedrock AgentCore Memory resources in the current Amazon Web Services Region.

", - "readonly":true - }, - "ListOauth2CredentialProviders":{ - "name":"ListOauth2CredentialProviders", - "http":{ - "method":"POST", - "requestUri":"/identities/ListOauth2CredentialProviders", - "responseCode":200 - }, - "input":{"shape":"ListOauth2CredentialProvidersRequest"}, - "output":{"shape":"ListOauth2CredentialProvidersResponse"}, - "errors":[ - {"shape":"UnauthorizedException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Lists all OAuth2 credential providers in your account.

", - "readonly":true - }, - "ListOnlineEvaluationConfigs":{ - "name":"ListOnlineEvaluationConfigs", - "http":{ - "method":"POST", - "requestUri":"/online-evaluation-configs", - "responseCode":200 - }, - "input":{"shape":"ListOnlineEvaluationConfigsRequest"}, - "output":{"shape":"ListOnlineEvaluationConfigsResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Lists all online evaluation configurations in the account, providing summary information about each configuration's status and settings.

", - "readonly":true - }, - "ListPaymentConnectors":{ - "name":"ListPaymentConnectors", - "http":{ - "method":"POST", - "requestUri":"/payments/managers/{paymentManagerId}/connectors-list", - "responseCode":200 - }, - "input":{"shape":"ListPaymentConnectorsRequest"}, - "output":{"shape":"ListPaymentConnectorsResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Lists all payment connectors for a specified payment manager.

", - "readonly":true - }, - "ListPaymentCredentialProviders":{ - "name":"ListPaymentCredentialProviders", - "http":{ - "method":"POST", - "requestUri":"/identities/ListPaymentCredentialProviders", - "responseCode":200 - }, - "input":{"shape":"ListPaymentCredentialProvidersRequest"}, - "output":{"shape":"ListPaymentCredentialProvidersResponse"}, - "errors":[ - {"shape":"UnauthorizedException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Lists all payment credential providers in the account.

", - "readonly":true - }, - "ListPaymentManagers":{ - "name":"ListPaymentManagers", - "http":{ - "method":"POST", - "requestUri":"/payments/managers-list", - "responseCode":200 - }, - "input":{"shape":"ListPaymentManagersRequest"}, - "output":{"shape":"ListPaymentManagersResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Lists all payment managers in the account.

", - "readonly":true - }, - "ListPolicies":{ - "name":"ListPolicies", - "http":{ - "method":"GET", - "requestUri":"/policy-engines/{policyEngineId}/policies", - "responseCode":200 - }, - "input":{"shape":"ListPoliciesRequest"}, - "output":{"shape":"ListPoliciesResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Retrieves a list of policies within the AgentCore Policy engine. This operation supports pagination and filtering to help administrators manage and discover policies across policy engines. Results can be filtered by policy engine or resource associations.

", - "readonly":true - }, - "ListPolicyEngineSummaries":{ - "name":"ListPolicyEngineSummaries", - "http":{ - "method":"GET", - "requestUri":"/policy-engine-summaries", - "responseCode":200 - }, - "input":{"shape":"ListPolicyEngineSummariesRequest"}, - "output":{"shape":"ListPolicyEngineSummariesResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Retrieves a paginated list of metadata-only policy engine summaries without decrypting customer content. This lightweight read operation returns resource identifiers, status, and timestamps for each policy engine, but does not include descriptions or status reasons. Because this operation does not require access to the customer's KMS key, it is suitable for resource discovery, inventory, and integration scenarios where only metadata is needed.

", - "readonly":true - }, - "ListPolicyEngines":{ - "name":"ListPolicyEngines", - "http":{ - "method":"GET", - "requestUri":"/policy-engines", - "responseCode":200 - }, - "input":{"shape":"ListPolicyEnginesRequest"}, - "output":{"shape":"ListPolicyEnginesResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Retrieves a list of policy engines within the AgentCore Policy system. This operation supports pagination to help administrators discover and manage policy engines across their account. Each policy engine serves as a container for related policies.

", - "readonly":true - }, - "ListPolicyGenerationAssets":{ - "name":"ListPolicyGenerationAssets", - "http":{ - "method":"GET", - "requestUri":"/policy-engines/{policyEngineId}/policy-generations/{policyGenerationId}/assets", - "responseCode":200 - }, - "input":{"shape":"ListPolicyGenerationAssetsRequest"}, - "output":{"shape":"ListPolicyGenerationAssetsResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Retrieves a list of generated policy assets from a policy generation request within the AgentCore Policy system. This operation returns the actual Cedar policies and related artifacts produced by the AI-powered policy generation process, allowing users to review and select from multiple generated policy options.

", - "readonly":true - }, - "ListPolicyGenerationSummaries":{ - "name":"ListPolicyGenerationSummaries", - "http":{ - "method":"GET", - "requestUri":"/policy-engines/{policyEngineId}/policy-generation-summaries", - "responseCode":200 - }, - "input":{"shape":"ListPolicyGenerationSummariesRequest"}, - "output":{"shape":"ListPolicyGenerationSummariesResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Retrieves a paginated list of metadata-only policy generation summaries within a policy engine without decrypting customer content. This lightweight read operation returns resource identifiers, status, timestamps, and findings for each policy generation, but does not include status reasons. Because this operation does not require access to the customer's KMS key, it is suitable for resource discovery, inventory, and integration scenarios where only metadata is needed.

", - "readonly":true - }, - "ListPolicyGenerations":{ - "name":"ListPolicyGenerations", - "http":{ - "method":"GET", - "requestUri":"/policy-engines/{policyEngineId}/policy-generations", - "responseCode":200 - }, - "input":{"shape":"ListPolicyGenerationsRequest"}, - "output":{"shape":"ListPolicyGenerationsResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Retrieves a list of policy generation requests within the AgentCore Policy system. This operation supports pagination and filtering to help track and manage AI-powered policy generation operations.

", - "readonly":true - }, - "ListPolicySummaries":{ - "name":"ListPolicySummaries", - "http":{ - "method":"GET", - "requestUri":"/policy-engines/{policyEngineId}/policy-summaries", - "responseCode":200 - }, - "input":{"shape":"ListPolicySummariesRequest"}, - "output":{"shape":"ListPolicySummariesResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Retrieves a paginated list of metadata-only policy summaries within a policy engine without decrypting customer content. This lightweight read operation returns resource identifiers, status, and timestamps for each policy, but does not include policy definitions, descriptions, or status reasons. Because this operation does not require access to the customer's KMS key, it is suitable for resource discovery, inventory, and integration scenarios where only metadata is needed.

", - "readonly":true - }, - "ListRegistries":{ - "name":"ListRegistries", - "http":{ - "method":"GET", - "requestUri":"/registries", - "responseCode":200 - }, - "input":{"shape":"ListRegistriesRequest"}, - "output":{"shape":"ListRegistriesResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Lists all registries in the account. You can optionally filter results by status using the status parameter, or by authorizer type using the authorizerType parameter.

", - "readonly":true - }, - "ListRegistryRecords":{ - "name":"ListRegistryRecords", - "http":{ - "method":"GET", - "requestUri":"/registries/{registryId}/records", - "responseCode":200 - }, - "input":{"shape":"ListRegistryRecordsRequest"}, - "output":{"shape":"ListRegistryRecordsResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Lists registry records within a registry. You can optionally filter results using the name, status, and descriptorType parameters. When multiple filters are specified, they are combined using AND logic.

", - "readonly":true - }, - "ListTagsForResource":{ - "name":"ListTagsForResource", - "http":{ - "method":"GET", - "requestUri":"/tags/{resourceArn}", - "responseCode":200 - }, - "input":{"shape":"ListTagsForResourceRequest"}, - "output":{"shape":"ListTagsForResourceResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Lists the tags associated with the specified resource.

This feature is currently available only for AgentCore Runtime, Browser, Browser Profile, Code Interpreter tool, and Gateway.

", - "readonly":true - }, - "ListWorkloadIdentities":{ - "name":"ListWorkloadIdentities", - "http":{ - "method":"POST", - "requestUri":"/identities/ListWorkloadIdentities", - "responseCode":200 - }, - "input":{"shape":"ListWorkloadIdentitiesRequest"}, - "output":{"shape":"ListWorkloadIdentitiesResponse"}, - "errors":[ - {"shape":"UnauthorizedException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Lists all workload identities in your account.

", - "readonly":true - }, - "PutResourcePolicy":{ - "name":"PutResourcePolicy", - "http":{ - "method":"PUT", - "requestUri":"/resourcepolicy/{resourceArn}", - "responseCode":201 - }, - "input":{"shape":"PutResourcePolicyRequest"}, - "output":{"shape":"PutResourcePolicyResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Creates or updates a resource-based policy for a resource with the specified resourceArn.

This feature is currently available only for AgentCore Runtime and Gateway.

", - "idempotent":true - }, - "SetTokenVaultCMK":{ - "name":"SetTokenVaultCMK", - "http":{ - "method":"POST", - "requestUri":"/identities/set-token-vault-cmk", - "responseCode":200 - }, - "input":{"shape":"SetTokenVaultCMKRequest"}, - "output":{"shape":"SetTokenVaultCMKResponse"}, - "errors":[ - {"shape":"UnauthorizedException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Sets the customer master key (CMK) for a token vault.

" - }, - "StartPolicyGeneration":{ - "name":"StartPolicyGeneration", - "http":{ - "method":"POST", - "requestUri":"/policy-engines/{policyEngineId}/policy-generations", - "responseCode":202 - }, - "input":{"shape":"StartPolicyGenerationRequest"}, - "output":{"shape":"StartPolicyGenerationResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Initiates the AI-powered generation of Cedar policies from natural language descriptions within the AgentCore Policy system. This feature enables both technical and non-technical users to create policies by describing their authorization requirements in plain English, which is then automatically translated into formal Cedar policy statements. The generation process analyzes the natural language input along with the Gateway's tool context to produce validated policy options. Generated policy assets are automatically deleted after 7 days, so you should review and create policies from the generated assets within this timeframe. Once created, policies are permanent and not subject to this expiration. Generated policies should be reviewed and tested in log-only mode before deploying to production. Use this when you want to describe policy intent naturally rather than learning Cedar syntax, though generated policies may require refinement for complex scenarios.

" - }, - "SubmitRegistryRecordForApproval":{ - "name":"SubmitRegistryRecordForApproval", - "http":{ - "method":"POST", - "requestUri":"/registries/{registryId}/records/{recordId}/submit-for-approval", - "responseCode":202 - }, - "input":{"shape":"SubmitRegistryRecordForApprovalRequest"}, - "output":{"shape":"SubmitRegistryRecordForApprovalResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Submits a registry record for approval. This transitions the record from DRAFT status to PENDING_APPROVAL status. If the registry has auto-approval enabled, the record is automatically approved.

" - }, - "SynchronizeGatewayTargets":{ - "name":"SynchronizeGatewayTargets", - "http":{ - "method":"PUT", - "requestUri":"/gateways/{gatewayIdentifier}/synchronizeTargets", - "responseCode":202 - }, - "input":{"shape":"SynchronizeGatewayTargetsRequest"}, - "output":{"shape":"SynchronizeGatewayTargetsResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Synchronizes the gateway targets by fetching the latest tool definitions from the target endpoints.

You cannot synchronize a target that is in a pending authorization state (CREATE_PENDING_AUTH, UPDATE_PENDING_AUTH, or SYNCHRONIZE_PENDING_AUTH). Wait for the authorization to complete or fail before synchronizing.

You cannot synchronize a target that has a static tool schema (mcpToolSchema) configured. Remove the static schema through an UpdateGatewayTarget call to enable dynamic tool synchronization.

", - "idempotent":true - }, - "TagResource":{ - "name":"TagResource", - "http":{ - "method":"POST", - "requestUri":"/tags/{resourceArn}", - "responseCode":204 - }, - "input":{"shape":"TagResourceRequest"}, - "output":{"shape":"TagResourceResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are also deleted.

This feature is currently available only for AgentCore Runtime, Browser, Browser Profile, Code Interpreter tool, and Gateway.

" - }, - "UntagResource":{ - "name":"UntagResource", - "http":{ - "method":"DELETE", - "requestUri":"/tags/{resourceArn}", - "responseCode":204 - }, - "input":{"shape":"UntagResourceRequest"}, - "output":{"shape":"UntagResourceResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Removes the specified tags from the specified resource.

This feature is currently available only for AgentCore Runtime, Browser, Browser Profile, Code Interpreter tool, and Gateway.

", - "idempotent":true - }, - "UpdateAgentRuntime":{ - "name":"UpdateAgentRuntime", - "http":{ - "method":"PUT", - "requestUri":"/runtimes/{agentRuntimeId}/", - "responseCode":202 - }, - "input":{"shape":"UpdateAgentRuntimeRequest"}, - "output":{"shape":"UpdateAgentRuntimeResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Updates an existing Amazon Secure Agent.

", - "idempotent":true - }, - "UpdateAgentRuntimeEndpoint":{ - "name":"UpdateAgentRuntimeEndpoint", - "http":{ - "method":"PUT", - "requestUri":"/runtimes/{agentRuntimeId}/runtime-endpoints/{endpointName}/", - "responseCode":202 - }, - "input":{"shape":"UpdateAgentRuntimeEndpointRequest"}, - "output":{"shape":"UpdateAgentRuntimeEndpointResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Updates an existing Amazon Bedrock AgentCore Runtime endpoint.

", - "idempotent":true - }, - "UpdateApiKeyCredentialProvider":{ - "name":"UpdateApiKeyCredentialProvider", - "http":{ - "method":"POST", - "requestUri":"/identities/UpdateApiKeyCredentialProvider", - "responseCode":200 - }, - "input":{"shape":"UpdateApiKeyCredentialProviderRequest"}, - "output":{"shape":"UpdateApiKeyCredentialProviderResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"UnauthorizedException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"DecryptionFailure"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"}, - {"shape":"EncryptionFailure"} - ], - "documentation":"

Updates an existing API key credential provider.

", - "idempotent":true - }, - "UpdateConfigurationBundle":{ - "name":"UpdateConfigurationBundle", - "http":{ - "method":"PUT", - "requestUri":"/configuration-bundles/{bundleId}", - "responseCode":200 - }, - "input":{"shape":"UpdateConfigurationBundleRequest"}, - "output":{"shape":"UpdateConfigurationBundleResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Updates a configuration bundle by creating a new version with the specified changes. Each update creates a new version in the version history.

" - }, - "UpdateDataset":{ - "name":"UpdateDataset", - "http":{ - "method":"PUT", - "requestUri":"/datasets/{datasetId}", - "responseCode":200 - }, - "input":{"shape":"UpdateDatasetRequest"}, - "output":{"shape":"UpdateDatasetResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Updates a dataset's metadata. Synchronous operation. Only provided fields are updated; omitted fields remain unchanged. To modify dataset content, use AddDatasetExamples, UpdateDatasetExamples, or DeleteDatasetExamples.

", - "idempotent":true - }, - "UpdateDatasetExamples":{ - "name":"UpdateDatasetExamples", - "http":{ - "method":"POST", - "requestUri":"/datasets/{datasetId}/examples/update", - "responseCode":202 - }, - "input":{"shape":"UpdateDatasetExamplesRequest"}, - "output":{"shape":"UpdateDatasetExamplesResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Updates multiple existing examples in-place on DRAFT. All examples are validated against the dataset's schema type before any writes occur. If any example fails validation, the entire batch is rejected (all-or-nothing semantics).

" - }, - "UpdateEvaluator":{ - "name":"UpdateEvaluator", - "http":{ - "method":"PUT", - "requestUri":"/evaluators/{evaluatorId}", - "responseCode":202 - }, - "input":{"shape":"UpdateEvaluatorRequest"}, - "output":{"shape":"UpdateEvaluatorResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Updates a custom evaluator's configuration, description, or evaluation level. Built-in evaluators cannot be updated. The evaluator must not be locked for modification.

", - "idempotent":true - }, - "UpdateGateway":{ - "name":"UpdateGateway", - "http":{ - "method":"PUT", - "requestUri":"/gateways/{gatewayIdentifier}/", - "responseCode":202 - }, - "input":{"shape":"UpdateGatewayRequest"}, - "output":{"shape":"UpdateGatewayResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Updates an existing gateway.

", - "idempotent":true - }, - "UpdateGatewayRule":{ - "name":"UpdateGatewayRule", - "http":{ - "method":"PATCH", - "requestUri":"/gateways/{gatewayIdentifier}/rules/{ruleId}", - "responseCode":202 - }, - "input":{"shape":"UpdateGatewayRuleRequest"}, - "output":{"shape":"UpdateGatewayRuleResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Updates a gateway rule's priority, conditions, actions, or description.

", - "idempotent":true - }, - "UpdateGatewayTarget":{ - "name":"UpdateGatewayTarget", - "http":{ - "method":"PUT", - "requestUri":"/gateways/{gatewayIdentifier}/targets/{targetId}/", - "responseCode":202 - }, - "input":{"shape":"UpdateGatewayTargetRequest"}, - "output":{"shape":"UpdateGatewayTargetResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Updates an existing gateway target.

You cannot update a target that is in a pending authorization state (CREATE_PENDING_AUTH, UPDATE_PENDING_AUTH, or SYNCHRONIZE_PENDING_AUTH). Wait for the authorization to complete or fail before updating the target.

", - "idempotent":true - }, - "UpdateHarness":{ - "name":"UpdateHarness", - "http":{ - "method":"PATCH", - "requestUri":"/harnesses/{harnessId}", - "responseCode":200 - }, - "input":{"shape":"UpdateHarnessRequest"}, - "output":{"shape":"UpdateHarnessResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Operation to update a harness.

", - "idempotent":true - }, - "UpdateHarnessEndpoint":{ - "name":"UpdateHarnessEndpoint", - "http":{ - "method":"PATCH", - "requestUri":"/harnesses/{harnessId}/endpoints/{endpointName}", - "responseCode":200 - }, - "input":{"shape":"UpdateHarnessEndpointRequest"}, - "output":{"shape":"UpdateHarnessEndpointResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Operation to update a harness endpoint.

", - "idempotent":true - }, - "UpdateMemory":{ - "name":"UpdateMemory", - "http":{ - "method":"PUT", - "requestUri":"/memories/{memoryId}/update", - "responseCode":202 - }, - "input":{"shape":"UpdateMemoryInput"}, - "output":{"shape":"UpdateMemoryOutput"}, - "errors":[ - {"shape":"ServiceException"}, - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottledException"} - ], - "documentation":"

Update an Amazon Bedrock AgentCore Memory resource memory.

", - "idempotent":true - }, - "UpdateOauth2CredentialProvider":{ - "name":"UpdateOauth2CredentialProvider", - "http":{ - "method":"POST", - "requestUri":"/identities/UpdateOauth2CredentialProvider", - "responseCode":200 - }, - "input":{"shape":"UpdateOauth2CredentialProviderRequest"}, - "output":{"shape":"UpdateOauth2CredentialProviderResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"UnauthorizedException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"DecryptionFailure"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"}, - {"shape":"EncryptionFailure"} - ], - "documentation":"

Updates an existing OAuth2 credential provider.

" - }, - "UpdateOnlineEvaluationConfig":{ - "name":"UpdateOnlineEvaluationConfig", - "http":{ - "method":"PUT", - "requestUri":"/online-evaluation-configs/{onlineEvaluationConfigId}", - "responseCode":202 - }, - "input":{"shape":"UpdateOnlineEvaluationConfigRequest"}, - "output":{"shape":"UpdateOnlineEvaluationConfigResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Updates an online evaluation configuration's settings, including rules, data sources, evaluators, and execution status. Changes take effect immediately for ongoing evaluations.

", - "idempotent":true - }, - "UpdatePaymentConnector":{ - "name":"UpdatePaymentConnector", - "http":{ - "method":"PATCH", - "requestUri":"/payments/managers/{paymentManagerId}/connectors/{paymentConnectorId}", - "responseCode":202 - }, - "input":{"shape":"UpdatePaymentConnectorRequest"}, - "output":{"shape":"UpdatePaymentConnectorResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Updates an existing payment connector. This operation uses PATCH semantics, so you only need to specify the fields you want to change.

", - "idempotent":true - }, - "UpdatePaymentCredentialProvider":{ - "name":"UpdatePaymentCredentialProvider", - "http":{ - "method":"POST", - "requestUri":"/identities/UpdatePaymentCredentialProvider", - "responseCode":200 - }, - "input":{"shape":"UpdatePaymentCredentialProviderRequest"}, - "output":{"shape":"UpdatePaymentCredentialProviderResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"UnauthorizedException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"DecryptionFailure"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"}, - {"shape":"EncryptionFailure"} - ], - "documentation":"

Updates an existing payment credential provider with new authentication credentials.

" - }, - "UpdatePaymentManager":{ - "name":"UpdatePaymentManager", - "http":{ - "method":"PATCH", - "requestUri":"/payments/managers/{paymentManagerId}", - "responseCode":202 - }, - "input":{"shape":"UpdatePaymentManagerRequest"}, - "output":{"shape":"UpdatePaymentManagerResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Updates an existing payment manager. This operation uses PATCH semantics, so you only need to specify the fields you want to change.

", - "idempotent":true - }, - "UpdatePolicy":{ - "name":"UpdatePolicy", - "http":{ - "method":"PATCH", - "requestUri":"/policy-engines/{policyEngineId}/policies/{policyId}", - "responseCode":202 - }, - "input":{"shape":"UpdatePolicyRequest"}, - "output":{"shape":"UpdatePolicyResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Updates an existing policy within the AgentCore Policy system. This operation allows modification of the policy description and definition while maintaining the policy's identity. The updated policy is validated against the Cedar schema before being applied. This is an asynchronous operation. Use the GetPolicy operation to poll the status field to track completion.

", - "idempotent":true - }, - "UpdatePolicyEngine":{ - "name":"UpdatePolicyEngine", - "http":{ - "method":"PATCH", - "requestUri":"/policy-engines/{policyEngineId}", - "responseCode":202 - }, - "input":{"shape":"UpdatePolicyEngineRequest"}, - "output":{"shape":"UpdatePolicyEngineResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Updates an existing policy engine within the AgentCore Policy system. This operation allows modification of the policy engine description while maintaining its identity. This is an asynchronous operation. Use the GetPolicyEngine operation to poll the status field to track completion.

", - "idempotent":true - }, - "UpdateRegistry":{ - "name":"UpdateRegistry", - "http":{ - "method":"PATCH", - "requestUri":"/registries/{registryId}", - "responseCode":202 - }, - "input":{"shape":"UpdateRegistryRequest"}, - "output":{"shape":"UpdateRegistryResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Updates an existing registry. This operation uses PATCH semantics, so you only need to specify the fields you want to change.

" - }, - "UpdateRegistryRecord":{ - "name":"UpdateRegistryRecord", - "http":{ - "method":"PATCH", - "requestUri":"/registries/{registryId}/records/{recordId}", - "responseCode":202 - }, - "input":{"shape":"UpdateRegistryRecordRequest"}, - "output":{"shape":"UpdateRegistryRecordResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Updates an existing registry record. This operation uses PATCH semantics, so you only need to specify the fields you want to change. The update is processed asynchronously and returns HTTP 202 Accepted.

" - }, - "UpdateRegistryRecordStatus":{ - "name":"UpdateRegistryRecordStatus", - "http":{ - "method":"PATCH", - "requestUri":"/registries/{registryId}/records/{recordId}/status", - "responseCode":202 - }, - "input":{"shape":"UpdateRegistryRecordStatusRequest"}, - "output":{"shape":"UpdateRegistryRecordStatusResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Updates the status of a registry record. Use this operation to approve, reject, or deprecate a registry record.

" - }, - "UpdateWorkloadIdentity":{ - "name":"UpdateWorkloadIdentity", - "http":{ - "method":"POST", - "requestUri":"/identities/UpdateWorkloadIdentity", - "responseCode":200 - }, - "input":{"shape":"UpdateWorkloadIdentityRequest"}, - "output":{"shape":"UpdateWorkloadIdentityResponse"}, - "errors":[ - {"shape":"UnauthorizedException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"

Updates an existing workload identity.

", - "idempotent":true - } - }, - "shapes":{ - "A2aDescriptor":{ - "type":"structure", - "members":{ - "agentCard":{ - "shape":"AgentCardDefinition", - "documentation":"

The agent card definition for the A2A agent, as defined by the A2A protocol specification.

" - } - }, - "documentation":"

The Agent-to-Agent (A2A) protocol descriptor for a registry record. Contains the agent card definition as defined by the A2A protocol specification.

" - }, - "AccessDeniedException":{ - "type":"structure", - "members":{ - "message":{"shape":"NonBlankString"} - }, - "documentation":"

This exception is thrown when a request is denied per access permissions

", - "error":{ - "httpStatusCode":403, - "senderFault":true - }, - "exception":true - }, - "Action":{ - "type":"structure", - "members":{ - "configurationBundle":{ - "shape":"ConfigurationBundleAction", - "documentation":"

An action that applies a configuration bundle override to the request.

" - }, - "routeToTarget":{ - "shape":"RouteToTargetAction", - "documentation":"

An action that routes the request to a specific target.

" - } - }, - "documentation":"

An action to take when a gateway rule's conditions are met.

", - "union":true - }, - "Actions":{ - "type":"list", - "member":{"shape":"Action"}, - "max":2, - "min":1 - }, - "ActorTokenContentType":{ - "type":"string", - "enum":[ - "NONE", - "M2M", - "AWS_IAM_ID_TOKEN_JWT" - ] - }, - "AddDatasetExamplesRequest":{ - "type":"structure", - "required":[ - "datasetId", - "source" - ], - "members":{ - "datasetId":{ - "shape":"DatasetId", - "documentation":"

The unique identifier of the dataset to add examples to.

", - "location":"uri", - "locationName":"datasetId" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "idempotencyToken":true - }, - "source":{ - "shape":"DataSourceType", - "documentation":"

Source of examples to add. Provide either inline examples or an S3 URI pointing to a JSONL file.

" - } - } - }, - "AddDatasetExamplesResponse":{ - "type":"structure", - "required":[ - "datasetArn", - "datasetId", - "status", - "addedCount", - "updatedAt", - "exampleIds" - ], - "members":{ - "datasetArn":{ - "shape":"DatasetArn", - "documentation":"

The Amazon Resource Name (ARN) of the dataset.

" - }, - "datasetId":{ - "shape":"DatasetId", - "documentation":"

The unique identifier of the dataset.

" - }, - "status":{ - "shape":"DatasetStatus", - "documentation":"

The current status of the dataset.

" - }, - "addedCount":{ - "shape":"Long", - "documentation":"

The number of examples added.

" - }, - "updatedAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the examples were added.

" - }, - "exampleIds":{ - "shape":"ExampleIdList", - "documentation":"

IDs of all added examples (auto-generated UUIDs).

" - } - } - }, - "AdditionalClaimName":{ - "type":"string", - "max":255, - "min":1, - "pattern":"[A-Za-z0-9_.:#-]+" - }, - "AdditionalClaimValue":{ - "type":"string", - "max":2048, - "min":1, - "sensitive":true - }, - "AdditionalClaims":{ - "type":"map", - "key":{"shape":"AdditionalClaimName"}, - "value":{"shape":"AdditionalClaimValue"}, - "max":10, - "min":1 - }, - "AdditionalModelRequestFields":{ - "type":"structure", - "members":{}, - "document":true - }, - "AdvertisedScopeMappingType":{ - "type":"map", - "key":{"shape":"AllowedScopeType"}, - "value":{"shape":"AllowedScopeType"}, - "documentation":"

Maps an originalScope (from allowedScopes) to an advertisedScope exposed in WWW-Authenticate / Protected Resource Metadata.

", - "max":50, - "min":1 - }, - "AgentCardDefinition":{ - "type":"structure", - "members":{ - "schemaVersion":{ - "shape":"SchemaVersion", - "documentation":"

The schema version of the agent card based on the A2A protocol specification.

" - }, - "inlineContent":{ - "shape":"InlineContent", - "documentation":"

The JSON content containing the A2A agent card definition, conforming to the A2A protocol specification.

" - } - }, - "documentation":"

The agent card definition for an A2A descriptor. Contains the schema version and inline content for the agent card.

" - }, - "AgentEndpointDescription":{ - "type":"string", - "max":256, - "min":1 - }, - "AgentManagedRuntimeType":{ - "type":"string", - "enum":[ - "PYTHON_3_10", - "PYTHON_3_11", - "PYTHON_3_12", - "PYTHON_3_13", - "PYTHON_3_14", - "NODE_22" - ] - }, - "AgentRuntime":{ - "type":"structure", - "required":[ - "agentRuntimeArn", - "agentRuntimeId", - "agentRuntimeVersion", - "agentRuntimeName", - "description", - "lastUpdatedAt", - "status" - ], - "members":{ - "agentRuntimeArn":{ - "shape":"AgentRuntimeArn", - "documentation":"

The Amazon Resource Name (ARN) of the agent runtime.

" - }, - "agentRuntimeId":{ - "shape":"AgentRuntimeId", - "documentation":"

The unique identifier of the agent runtime.

" - }, - "agentRuntimeVersion":{ - "shape":"AgentRuntimeVersion", - "documentation":"

The version of the agent runtime.

" - }, - "agentRuntimeName":{ - "shape":"AgentRuntimeName", - "documentation":"

The name of the agent runtime.

" - }, - "description":{ - "shape":"Description", - "documentation":"

The description of the agent runtime.

" - }, - "lastUpdatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the agent runtime was last updated.

" - }, - "status":{ - "shape":"AgentRuntimeStatus", - "documentation":"

The current status of the agent runtime.

" - } - }, - "documentation":"

Contains information about an agent runtime. An agent runtime is the execution environment for a Amazon Bedrock AgentCore Agent.

" - }, - "AgentRuntimeArn":{ - "type":"string", - "pattern":"arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:runtime/[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10}" - }, - "AgentRuntimeArtifact":{ - "type":"structure", - "members":{ - "containerConfiguration":{ - "shape":"ContainerConfiguration", - "documentation":"

The container configuration for the agent artifact.

" - }, - "codeConfiguration":{ - "shape":"CodeConfiguration", - "documentation":"

The code configuration for the agent runtime artifact, including the source code location and execution settings.

" - } - }, - "documentation":"

The artifact of the agent.

", - "union":true - }, - "AgentRuntimeEndpoint":{ - "type":"structure", - "required":[ - "name", - "agentRuntimeEndpointArn", - "agentRuntimeArn", - "status", - "id", - "createdAt", - "lastUpdatedAt" - ], - "members":{ - "name":{ - "shape":"EndpointName", - "documentation":"

The name of the agent runtime endpoint.

" - }, - "liveVersion":{ - "shape":"AgentRuntimeVersion", - "documentation":"

The live version of the agent runtime endpoint. This is the version that is currently serving requests.

" - }, - "targetVersion":{ - "shape":"AgentRuntimeVersion", - "documentation":"

The target version of the agent runtime endpoint. This is the version that the endpoint is being updated to.

" - }, - "agentRuntimeEndpointArn":{ - "shape":"AgentRuntimeEndpointArn", - "documentation":"

The Amazon Resource Name (ARN) of the agent runtime endpoint.

" - }, - "agentRuntimeArn":{ - "shape":"AgentRuntimeArn", - "documentation":"

The Amazon Resource Name (ARN) of the agent runtime associated with the endpoint.

" - }, - "status":{ - "shape":"AgentRuntimeEndpointStatus", - "documentation":"

The current status of the agent runtime endpoint.

" - }, - "id":{ - "shape":"AgentRuntimeEndpointId", - "documentation":"

The unique identifier of the agent runtime endpoint.

" - }, - "description":{ - "shape":"AgentEndpointDescription", - "documentation":"

The description of the agent runtime endpoint.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the agent runtime endpoint was created.

" - }, - "lastUpdatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the agent runtime endpoint was last updated.

" - } - }, - "documentation":"

Contains information about an agent runtime endpoint. An endpoint provides a way to connect to and interact with an agent runtime.

" - }, - "AgentRuntimeEndpointArn":{ - "type":"string", - "pattern":"arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:runtime/[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10}/runtime-endpoint/[a-zA-Z][a-zA-Z0-9_]{0,47}" - }, - "AgentRuntimeEndpointId":{ - "type":"string", - "pattern":"[a-zA-Z][a-zA-Z0-9_]{0,99}-[a-zA-Z0-9]{10}" - }, - "AgentRuntimeEndpointStatus":{ - "type":"string", - "enum":[ - "CREATING", - "CREATE_FAILED", - "UPDATING", - "UPDATE_FAILED", - "READY", - "DELETING" - ] - }, - "AgentRuntimeEndpoints":{ - "type":"list", - "member":{"shape":"AgentRuntimeEndpoint"} - }, - "AgentRuntimeId":{ - "type":"string", - "pattern":"[a-zA-Z][a-zA-Z0-9_]{0,99}-[a-zA-Z0-9]{10}" - }, - "AgentRuntimeName":{ - "type":"string", - "pattern":"[a-zA-Z][a-zA-Z0-9_]{0,47}" - }, - "AgentRuntimeStatus":{ - "type":"string", - "enum":[ - "CREATING", - "CREATE_FAILED", - "UPDATING", - "UPDATE_FAILED", - "READY", - "DELETING" - ] - }, - "AgentRuntimeVersion":{ - "type":"string", - "max":5, - "min":1, - "pattern":"([1-9][0-9]{0,4})" - }, - "AgentRuntimes":{ - "type":"list", - "member":{"shape":"AgentRuntime"} - }, - "AgentSkillsDescriptor":{ - "type":"structure", - "members":{ - "skillMd":{ - "shape":"SkillMdDefinition", - "documentation":"

The optional skill markdown definition describing the agent's skills in a human-readable format.

" - }, - "skillDefinition":{ - "shape":"SkillDefinition", - "documentation":"

The structured skill definition with schema version and content.

" - } - }, - "documentation":"

The agent skills descriptor for a registry record. Contains an optional skill markdown definition in human-readable format and an optional structured skill definition.

" - }, - "AllowedAudience":{"type":"string"}, - "AllowedAudienceList":{ - "type":"list", - "member":{"shape":"AllowedAudience"}, - "min":1 - }, - "AllowedClient":{"type":"string"}, - "AllowedClientsList":{ - "type":"list", - "member":{"shape":"AllowedClient"}, - "min":1 - }, - "AllowedQueryParameters":{ - "type":"list", - "member":{"shape":"HttpQueryParameterName"}, - "max":10, - "min":1 - }, - "AllowedRequestHeaders":{ - "type":"list", - "member":{"shape":"HttpHeaderName"}, - "max":10, - "min":1 - }, - "AllowedResponseHeaders":{ - "type":"list", - "member":{"shape":"HttpHeaderName"}, - "max":10, - "min":1 - }, - "AllowedScopeType":{ - "type":"string", - "max":255, - "min":1, - "pattern":"[\\x21\\x23-\\x5B\\x5D-\\x7E]+" - }, - "AllowedScopesType":{ - "type":"list", - "member":{"shape":"AllowedScopeType"}, - "min":1 - }, - "AllowedStringListValue":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[a-zA-Z0-9\\s._:/=+@-]*" - }, - "AllowedStringListValuesList":{ - "type":"list", - "member":{"shape":"AllowedStringListValue"}, - "max":10, - "min":1 - }, - "AllowedStringValue":{ - "type":"string", - "max":256, - "min":1, - "pattern":"[a-zA-Z0-9\\s._:/=+@-]*" - }, - "AllowedStringValuesList":{ - "type":"list", - "member":{"shape":"AllowedStringValue"}, - "max":10, - "min":1 - }, - "AllowedWorkloadConfiguration":{ - "type":"structure", - "members":{ - "hostingEnvironments":{ - "shape":"HostingEnvironmentListType", - "documentation":"

The list of hosting environments whose workloads are allowed to invoke the target. At launch, the only supported hosting environment is AgentCore Gateway.

" - }, - "workloadIdentities":{ - "shape":"WorkloadIdentityNameListType", - "documentation":"

The list of workload identities that are allowed to invoke the target.

" - } - }, - "documentation":"

The configuration that restricts which workloads in the request's identity chain are allowed to invoke the target, identified by their hosting environments and workload identities. At launch, this is supported only for AgentCore Runtime targets, and the allowed workloads are AgentCore Gateways.

" - }, - "ApiGatewayTargetConfiguration":{ - "type":"structure", - "required":[ - "restApiId", - "stage", - "apiGatewayToolConfiguration" - ], - "members":{ - "restApiId":{ - "shape":"String", - "documentation":"

The ID of the API Gateway REST API.

" - }, - "stage":{ - "shape":"String", - "documentation":"

The ID of the stage of the REST API to add as a target.

" - }, - "apiGatewayToolConfiguration":{ - "shape":"ApiGatewayToolConfiguration", - "documentation":"

The configuration for defining REST API tool filters and overrides for the gateway target.

" - } - }, - "documentation":"

The configuration for an Amazon API Gateway target.

" - }, - "ApiGatewayToolConfiguration":{ - "type":"structure", - "required":["toolFilters"], - "members":{ - "toolOverrides":{ - "shape":"ApiGatewayToolOverrides", - "documentation":"

A list of explicit tool definitions with optional custom names and descriptions.

" - }, - "toolFilters":{ - "shape":"ApiGatewayToolFilters", - "documentation":"

A list of path and method patterns to expose as tools using metadata from the REST API's OpenAPI specification.

" - } - }, - "documentation":"

The configuration for defining REST API tool filters and overrides for the gateway target.

" - }, - "ApiGatewayToolFilter":{ - "type":"structure", - "required":[ - "filterPath", - "methods" - ], - "members":{ - "filterPath":{ - "shape":"String", - "documentation":"

Resource path to match in the REST API. Supports exact paths (for example, /pets) or wildcard paths (for example, /pets/* to match all paths under /pets). Must match existing paths in the REST API.

" - }, - "methods":{ - "shape":"RestApiMethods", - "documentation":"

The methods to filter for.

" - } - }, - "documentation":"

Specifies which operations from an API Gateway REST API are exposed as tools. Tool names and descriptions are derived from the operationId and description fields in the API's exported OpenAPI specification.

" - }, - "ApiGatewayToolFilters":{ - "type":"list", - "member":{"shape":"ApiGatewayToolFilter"} - }, - "ApiGatewayToolOverride":{ - "type":"structure", - "required":[ - "name", - "path", - "method" - ], - "members":{ - "name":{ - "shape":"String", - "documentation":"

The name of tool. Identifies the tool in the Model Context Protocol.

" - }, - "description":{ - "shape":"String", - "documentation":"

The description of the tool. Provides information about the purpose and usage of the tool. If not provided, uses the description from the API's OpenAPI specification.

" - }, - "path":{ - "shape":"String", - "documentation":"

Resource path in the REST API (e.g., /pets). Must explicitly match an existing path in the REST API.

" - }, - "method":{ - "shape":"RestApiMethod", - "documentation":"

The HTTP method to expose for the specified path.

" - } - }, - "documentation":"

Settings to override configurations for a tool.

" - }, - "ApiGatewayToolOverrides":{ - "type":"list", - "member":{"shape":"ApiGatewayToolOverride"} - }, - "ApiKeyArn":{ - "type":"string", - "pattern":"arn:aws:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:token-vault/[a-zA-Z0-9-.]+/apikeycredentialprovider/[a-zA-Z0-9-.]+" - }, - "ApiKeyCredentialLocation":{ - "type":"string", - "enum":[ - "HEADER", - "QUERY_PARAMETER" - ] - }, - "ApiKeyCredentialParameterName":{ - "type":"string", - "max":64, - "min":1 - }, - "ApiKeyCredentialPrefix":{ - "type":"string", - "max":64, - "min":1 - }, - "ApiKeyCredentialProvider":{ - "type":"structure", - "required":["providerArn"], - "members":{ - "providerArn":{ - "shape":"ApiKeyCredentialProviderArn", - "documentation":"

The Amazon Resource Name (ARN) of the API key credential provider. This ARN identifies the provider in Amazon Web Services.

" - }, - "credentialParameterName":{ - "shape":"ApiKeyCredentialParameterName", - "documentation":"

The name of the credential parameter for the API key. This parameter name is used when sending the API key to the target endpoint.

" - }, - "credentialPrefix":{ - "shape":"ApiKeyCredentialPrefix", - "documentation":"

The prefix for the API key credential. This prefix is added to the API key when sending it to the target endpoint.

" - }, - "credentialLocation":{ - "shape":"ApiKeyCredentialLocation", - "documentation":"

The location of the API key credential. This field specifies where in the request the API key should be placed.

" - } - }, - "documentation":"

An API key credential provider for gateway authentication. This structure contains the configuration for authenticating with the target endpoint using an API key.

" - }, - "ApiKeyCredentialProviderArn":{ - "type":"string", - "pattern":"arn:([^:]*):([^:]*):([^:]*):([0-9]{12})?:(.+)" - }, - "ApiKeyCredentialProviderArnType":{ - "type":"string", - "pattern":"arn:(aws|aws-us-gov):acps:[A-Za-z0-9-]{1,64}:[0-9]{12}:token-vault/[a-zA-Z0-9-.]+/apikeycredentialprovider/[a-zA-Z0-9-.]+" - }, - "ApiKeyCredentialProviderItem":{ - "type":"structure", - "required":[ - "name", - "credentialProviderArn", - "createdTime", - "lastUpdatedTime" - ], - "members":{ - "name":{ - "shape":"CredentialProviderName", - "documentation":"

The name of the API key credential provider.

" - }, - "credentialProviderArn":{ - "shape":"ApiKeyCredentialProviderArnType", - "documentation":"

The Amazon Resource Name (ARN) of the API key credential provider.

" - }, - "createdTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the API key credential provider was created.

" - }, - "lastUpdatedTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the API key credential provider was last updated.

" - } - }, - "documentation":"

Contains information about an API key credential provider.

" - }, - "ApiKeyCredentialProviders":{ - "type":"list", - "member":{"shape":"ApiKeyCredentialProviderItem"} - }, - "ApiSchemaConfiguration":{ - "type":"structure", - "members":{ - "s3":{"shape":"S3Configuration"}, - "inlinePayload":{ - "shape":"InlinePayload", - "documentation":"

The inline payload containing the API schema definition.

" - } - }, - "documentation":"

Configuration for API schema.

", - "union":true - }, - "ApprovalConfiguration":{ - "type":"structure", - "members":{ - "autoApproval":{ - "shape":"Boolean", - "documentation":"

Whether registry records are auto-approved. When set to true, records are automatically approved upon creation. When set to false (the default), records require explicit approval for security purposes.

" - } - }, - "documentation":"

Configuration for the registry record approval workflow. Controls whether records added to the registry require explicit approval before becoming active.

" - }, - "Arn":{ - "type":"string", - "pattern":"arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}" - }, - "AtlassianOauth2ProviderConfigInput":{ - "type":"structure", - "required":["clientId"], - "members":{ - "clientId":{ - "shape":"ClientIdType", - "documentation":"

The client ID for the Atlassian OAuth2 provider. This identifier is assigned by Atlassian when you register your application.

" - }, - "clientSecret":{ - "shape":"DefaultClientSecretType", - "documentation":"

The client secret for the Atlassian OAuth2 provider. This secret is assigned by Atlassian and used along with the client ID to authenticate your application.

" - }, - "clientSecretConfig":{ - "shape":"SecretReference", - "documentation":"

A reference to the Amazon Web Services Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when clientSecretSource is set to EXTERNAL.

" - }, - "clientSecretSource":{ - "shape":"SecretSourceType", - "documentation":"

The source type of the client secret for the Atlassian OAuth2 provider. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.

" - } - }, - "documentation":"

Configuration settings for connecting to Atlassian services using OAuth2 authentication. This includes the client credentials required to authenticate with Atlassian's OAuth2 authorization server.

" - }, - "AtlassianOauth2ProviderConfigOutput":{ - "type":"structure", - "required":["oauthDiscovery"], - "members":{ - "oauthDiscovery":{"shape":"Oauth2Discovery"}, - "clientId":{ - "shape":"ClientIdType", - "documentation":"

The client ID for the Atlassian OAuth2 provider.

" - } - }, - "documentation":"

The configuration details returned for an Atlassian OAuth2 provider, including the client ID and OAuth2 discovery information.

" - }, - "AuthorizationData":{ - "type":"structure", - "members":{ - "oauth2":{ - "shape":"OAuth2AuthorizationData", - "documentation":"

OAuth2 authorization data for the gateway target.

" - } - }, - "documentation":"

Contains the authorization data that is returned when a gateway target is configured with a credential provider with authorization code grant type and requires user federation.

", - "union":true - }, - "AuthorizationEndpointType":{"type":"string"}, - "AuthorizerConfiguration":{ - "type":"structure", - "members":{ - "customJWTAuthorizer":{ - "shape":"CustomJWTAuthorizerConfiguration", - "documentation":"

The inbound JWT-based authorization, specifying how incoming requests should be authenticated.

" - } - }, - "documentation":"

Represents inbound authorization configuration options used to authenticate incoming requests.

", - "union":true - }, - "AuthorizerType":{ - "type":"string", - "enum":[ - "CUSTOM_JWT", - "AWS_IAM", - "NONE", - "AUTHENTICATE_ONLY" - ] - }, - "AuthorizingClaimMatchValueType":{ - "type":"structure", - "required":[ - "claimMatchValue", - "claimMatchOperator" - ], - "members":{ - "claimMatchValue":{ - "shape":"ClaimMatchValueType", - "documentation":"

The value or values to match for.

" - }, - "claimMatchOperator":{ - "shape":"ClaimMatchOperatorType", - "documentation":"

Defines the relationship between the claim field value and the value or values you're matching for.

" - } - }, - "documentation":"

Defines the value or values to match for and the relationship of the match.

" - }, - "AwsAccountId":{ - "type":"string", - "pattern":"[0-9]{12}" - }, - "BedrockAgentcoreResourceArn":{ - "type":"string", - "max":1011, - "min":20 - }, - "BedrockEvaluatorModelConfig":{ - "type":"structure", - "required":["modelId"], - "members":{ - "modelId":{ - "shape":"ModelId", - "documentation":"

The identifier of the Amazon Bedrock model to use for evaluation. Must be a supported foundation model available in your region.

" - }, - "inferenceConfig":{ - "shape":"InferenceConfiguration", - "documentation":"

The inference configuration parameters that control model behavior during evaluation, including temperature, token limits, and sampling settings.

" - }, - "additionalModelRequestFields":{ - "shape":"AdditionalModelRequestFields", - "documentation":"

Additional model-specific request fields to customize model behavior beyond the standard inference configuration.

" - } - }, - "documentation":"

The configuration for using Amazon Bedrock models in evaluator assessments, including model selection and inference parameters.

" - }, - "Boolean":{ - "type":"boolean", - "box":true - }, - "BranchName":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[a-zA-Z][a-zA-Z0-9_/-]{0,127}" - }, - "BrowserArn":{ - "type":"string", - "pattern":"arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:(aws|[0-9]{12}):browser(-custom)?/(aws\\.browser\\.v1|[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10})" - }, - "BrowserEnterprisePolicies":{ - "type":"list", - "member":{"shape":"BrowserEnterprisePolicy"}, - "max":100, - "min":0 - }, - "BrowserEnterprisePolicy":{ - "type":"structure", - "required":["location"], - "members":{ - "location":{ - "shape":"ResourceLocation", - "documentation":"

The location of the enterprise policy file.

" - }, - "type":{ - "shape":"BrowserEnterprisePolicyType", - "documentation":"

The type of browser enterprise policy. Available values are MANAGED and RECOMMENDED.

" - } - }, - "documentation":"

Browser enterprise policy configuration.

" - }, - "BrowserEnterprisePolicyType":{ - "type":"string", - "enum":[ - "MANAGED", - "RECOMMENDED" - ] - }, - "BrowserId":{ - "type":"string", - "pattern":"(aws\\.browser\\.v1|[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10})" - }, - "BrowserNetworkConfiguration":{ - "type":"structure", - "required":["networkMode"], - "members":{ - "networkMode":{ - "shape":"BrowserNetworkMode", - "documentation":"

The network mode for the browser. This field specifies how the browser connects to the network.

" - }, - "vpcConfig":{ - "shape":"VpcConfig", - "documentation":"

The VPC configuration for the browser. This configuration is required when the network mode is set to VPC.

" - } - }, - "documentation":"

The network configuration for a browser. This structure defines how the browser connects to the network.

" - }, - "BrowserNetworkMode":{ - "type":"string", - "enum":[ - "PUBLIC", - "VPC" - ] - }, - "BrowserProfileArn":{ - "type":"string", - "pattern":"arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:browser-profile/[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10}" - }, - "BrowserProfileId":{ - "type":"string", - "pattern":"[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10}" - }, - "BrowserProfileName":{ - "type":"string", - "pattern":"[a-zA-Z][a-zA-Z0-9_]{0,47}" - }, - "BrowserProfileStatus":{ - "type":"string", - "documentation":"

The status of a browser profile.

", - "enum":[ - "READY", - "DELETING", - "DELETED", - "SAVING" - ] - }, - "BrowserProfileSummaries":{ - "type":"list", - "member":{"shape":"BrowserProfileSummary"} - }, - "BrowserProfileSummary":{ - "type":"structure", - "required":[ - "profileId", - "profileArn", - "name", - "status", - "createdAt", - "lastUpdatedAt" - ], - "members":{ - "profileId":{ - "shape":"BrowserProfileId", - "documentation":"

The unique identifier of the browser profile.

" - }, - "profileArn":{ - "shape":"BrowserProfileArn", - "documentation":"

The Amazon Resource Name (ARN) of the browser profile.

" - }, - "name":{ - "shape":"BrowserProfileName", - "documentation":"

The name of the browser profile.

" - }, - "description":{ - "shape":"Description", - "documentation":"

The description of the browser profile.

" - }, - "status":{ - "shape":"BrowserProfileStatus", - "documentation":"

The current status of the browser profile. Possible values include READY, SAVING, DELETING, and DELETED.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the browser profile was created.

" - }, - "lastUpdatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the browser profile was last updated.

" - }, - "lastSavedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when browser session data was last saved to this profile.

" - }, - "lastSavedBrowserSessionId":{ - "shape":"BrowserSessionId", - "documentation":"

The identifier of the browser session from which data was last saved to this profile.

" - }, - "lastSavedBrowserId":{ - "shape":"BrowserId", - "documentation":"

The identifier of the browser from which data was last saved to this profile.

" - } - }, - "documentation":"

Contains summary information about a browser profile. A browser profile stores persistent browser data that can be reused across browser sessions.

" - }, - "BrowserSessionId":{ - "type":"string", - "pattern":"[0-9a-zA-Z]{1,40}" - }, - "BrowserSigningConfigInput":{ - "type":"structure", - "required":["enabled"], - "members":{ - "enabled":{ - "shape":"Boolean", - "documentation":"

Specifies whether browser signing is enabled. When enabled, the browser will cryptographically sign HTTP requests to identify itself as an AI agent to bot control vendors.

" - } - }, - "documentation":"

Configuration for enabling browser signing capabilities that allow agents to cryptographically identify themselves to websites using HTTP message signatures.

" - }, - "BrowserSigningConfigOutput":{ - "type":"structure", - "required":["enabled"], - "members":{ - "enabled":{ - "shape":"Boolean", - "documentation":"

Indicates whether browser signing is currently enabled for cryptographic agent identification using HTTP message signatures.

" - } - }, - "documentation":"

The current browser signing configuration that shows whether cryptographic agent identification is enabled for web bot authentication.

" - }, - "BrowserStatus":{ - "type":"string", - "enum":[ - "CREATING", - "CREATE_FAILED", - "READY", - "DELETING", - "DELETE_FAILED", - "DELETED" - ] - }, - "BrowserSummaries":{ - "type":"list", - "member":{"shape":"BrowserSummary"} - }, - "BrowserSummary":{ - "type":"structure", - "required":[ - "browserId", - "browserArn", - "status", - "createdAt" - ], - "members":{ - "browserId":{ - "shape":"BrowserId", - "documentation":"

The unique identifier of the browser.

" - }, - "browserArn":{ - "shape":"BrowserArn", - "documentation":"

The Amazon Resource Name (ARN) of the browser.

" - }, - "name":{ - "shape":"SandboxName", - "documentation":"

The name of the browser.

" - }, - "description":{ - "shape":"Description", - "documentation":"

The description of the browser.

" - }, - "status":{ - "shape":"BrowserStatus", - "documentation":"

The current status of the browser.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the browser was created.

" - }, - "lastUpdatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the browser was last updated.

" - } - }, - "documentation":"

Contains summary information about a browser. A browser enables Amazon Bedrock AgentCore Agent to interact with web content.

" - }, - "CategoricalScaleDefinition":{ - "type":"structure", - "required":[ - "definition", - "label" - ], - "members":{ - "definition":{ - "shape":"String", - "documentation":"

The description that explains what this categorical rating represents and when it should be used.

" - }, - "label":{ - "shape":"CategoricalScaleDefinitionLabelString", - "documentation":"

The label or name of this categorical rating option.

" - } - }, - "documentation":"

The definition of a categorical rating scale option that provides a named category with its description for evaluation scoring.

" - }, - "CategoricalScaleDefinitionLabelString":{ - "type":"string", - "max":100, - "min":1 - }, - "CategoricalScaleDefinitions":{ - "type":"list", - "member":{"shape":"CategoricalScaleDefinition"} - }, - "CedarPolicy":{ - "type":"structure", - "required":["statement"], - "members":{ - "statement":{ - "shape":"Statement", - "documentation":"

The Cedar policy statement that defines the authorization logic. This statement follows Cedar syntax and specifies principals, actions, resources, and conditions that determine when access should be allowed or denied.

" - } - }, - "documentation":"

Represents a Cedar policy statement within the AgentCore Policy system. Cedar is a policy language designed for authorization that provides human-readable, analyzable, and high-performance policy evaluation for controlling agent behavior and access decisions.

" - }, - "Certificate":{ - "type":"structure", - "required":["location"], - "members":{ - "location":{ - "shape":"CertificateLocation", - "documentation":"

The location of the certificate.

" - } - }, - "documentation":"

A certificate to install in the browser or code interpreter.

" - }, - "CertificateLocation":{ - "type":"structure", - "members":{ - "secretsManager":{ - "shape":"SecretsManagerLocation", - "documentation":"

The Amazon Web Services Secrets Manager location of the certificate.

" - } - }, - "documentation":"

The location from which to retrieve a certificate.

", - "union":true - }, - "Certificates":{ - "type":"list", - "member":{"shape":"Certificate"}, - "max":200, - "min":1 - }, - "ClaimMatchOperatorType":{ - "type":"string", - "enum":[ - "EQUALS", - "CONTAINS", - "CONTAINS_ANY" - ] - }, - "ClaimMatchValueType":{ - "type":"structure", - "members":{ - "matchValueString":{ - "shape":"MatchValueString", - "documentation":"

The string value to match for.

" - }, - "matchValueStringList":{ - "shape":"MatchValueStringList", - "documentation":"

An array of strings to check for a match.

" - } - }, - "documentation":"

The value or values to match for.

  • Include a matchValueString with the EQUALS operator to specify a string that matches the claim field value.

  • Include a matchValueArray to specify an array of string values. You can use the following operators:

    • Use CONTAINS to yield a match if the claim field value is in the array.

    • Use CONTAINS_ANY to yield a match if the claim field value contains any of the strings in the array.

", - "union":true - }, - "ClientAuthenticationMethodType":{ - "type":"string", - "enum":[ - "CLIENT_SECRET_BASIC", - "CLIENT_SECRET_POST", - "AWS_IAM_ID_TOKEN_JWT", - "PRIVATE_KEY_JWT" - ] - }, - "ClientIdType":{ - "type":"string", - "max":256, - "min":1 - }, - "ClientToken":{ - "type":"string", - "max":256, - "min":33, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}" - }, - "CloudWatchLogsInputConfig":{ - "type":"structure", - "required":[ - "logGroupNames", - "serviceNames" - ], - "members":{ - "logGroupNames":{ - "shape":"CloudWatchLogsInputConfigLogGroupNamesList", - "documentation":"

The list of CloudWatch log group names to monitor for agent traces.

" - }, - "serviceNames":{ - "shape":"CloudWatchLogsInputConfigServiceNamesList", - "documentation":"

The list of service names to filter traces within the specified log groups. Used to identify relevant agent sessions.

" - } - }, - "documentation":"

The configuration for reading agent traces from CloudWatch logs as input for online evaluation.

" - }, - "CloudWatchLogsInputConfigLogGroupNamesList":{ - "type":"list", - "member":{"shape":"LogGroupName"}, - "max":5, - "min":1 - }, - "CloudWatchLogsInputConfigServiceNamesList":{ - "type":"list", - "member":{"shape":"ServiceName"}, - "max":1, - "min":1 - }, - "CloudWatchOutputConfig":{ - "type":"structure", - "required":["logGroupName"], - "members":{ - "logGroupName":{ - "shape":"LogGroupName", - "documentation":"

The name of the CloudWatch log group where evaluation results will be written. The log group will be created if it doesn't exist.

" - } - }, - "documentation":"

The configuration for writing evaluation results to CloudWatch logs with embedded metric format (EMF) for monitoring.

" - }, - "ClusteringConfig":{ - "type":"structure", - "required":["frequencies"], - "members":{ - "frequencies":{ - "shape":"ClusteringFrequencyList", - "documentation":"

The list of frequencies at which clustering batch evaluations are triggered.

" - } - }, - "documentation":"

Configuration for periodic batch evaluation clustering, specifying how often clustering jobs run.

" - }, - "ClusteringFrequency":{ - "type":"string", - "enum":[ - "DAILY", - "WEEKLY", - "MONTHLY" - ] - }, - "ClusteringFrequencyList":{ - "type":"list", - "member":{"shape":"ClusteringFrequency"}, - "max":3, - "min":0 - }, - "Code":{ - "type":"structure", - "members":{ - "s3":{ - "shape":"S3Location", - "documentation":"

The Amazon Amazon S3 object that contains the source code for the agent runtime.

" - } - }, - "documentation":"

The source code configuration that specifies the location and details of the code to be executed.

", - "union":true - }, - "CodeBasedEvaluatorConfig":{ - "type":"structure", - "members":{ - "lambdaConfig":{ - "shape":"LambdaEvaluatorConfig", - "documentation":"

The Lambda function configuration for code-based evaluation.

" - } - }, - "documentation":"

Configuration for a code-based evaluator. Specify the Lambda function to use for evaluation.

", - "union":true - }, - "CodeConfiguration":{ - "type":"structure", - "required":[ - "code", - "runtime", - "entryPoint" - ], - "members":{ - "code":{ - "shape":"Code", - "documentation":"

The source code location and configuration details.

" - }, - "runtime":{ - "shape":"AgentManagedRuntimeType", - "documentation":"

The runtime environment for executing the agent code. Specify the programming language and version to use for the agent runtime. For valid values, see the list of supported runtimes.

" - }, - "entryPoint":{ - "shape":"CodeConfigurationEntryPointList", - "documentation":"

The entry point for the code execution, specifying the function or method that should be invoked when the code runs.

" - } - }, - "documentation":"

The configuration for the source code that defines how the agent runtime code should be executed, including the code location, runtime environment, and entry point.

" - }, - "CodeConfigurationEntryPointList":{ - "type":"list", - "member":{"shape":"entryPoint"}, - "max":2, - "min":1 - }, - "CodeInterpreterArn":{ - "type":"string", - "pattern":"arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:(aws|[0-9]{12}):code-interpreter(-custom)?/(aws\\.codeinterpreter\\.v1|[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10})" - }, - "CodeInterpreterId":{ - "type":"string", - "pattern":"(aws\\.codeinterpreter\\.v1|[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10})" - }, - "CodeInterpreterNetworkConfiguration":{ - "type":"structure", - "required":["networkMode"], - "members":{ - "networkMode":{ - "shape":"CodeInterpreterNetworkMode", - "documentation":"

The network mode for the code interpreter. This field specifies how the code interpreter connects to the network.

" - }, - "vpcConfig":{ - "shape":"VpcConfig", - "documentation":"

The VPC configuration for the code interpreter. This configuration is required when the network mode is set to VPC.

" - } - }, - "documentation":"

The network configuration for a code interpreter. This structure defines how the code interpreter connects to the network.

" - }, - "CodeInterpreterNetworkMode":{ - "type":"string", - "enum":[ - "PUBLIC", - "SANDBOX", - "VPC" - ] - }, - "CodeInterpreterStatus":{ - "type":"string", - "enum":[ - "CREATING", - "CREATE_FAILED", - "READY", - "DELETING", - "DELETE_FAILED", - "DELETED" - ] - }, - "CodeInterpreterSummaries":{ - "type":"list", - "member":{"shape":"CodeInterpreterSummary"} - }, - "CodeInterpreterSummary":{ - "type":"structure", - "required":[ - "codeInterpreterId", - "codeInterpreterArn", - "status", - "createdAt" - ], - "members":{ - "codeInterpreterId":{ - "shape":"CodeInterpreterId", - "documentation":"

The unique identifier of the code interpreter.

" - }, - "codeInterpreterArn":{ - "shape":"CodeInterpreterArn", - "documentation":"

The Amazon Resource Name (ARN) of the code interpreter.

" - }, - "name":{ - "shape":"SandboxName", - "documentation":"

The name of the code interpreter.

" - }, - "description":{ - "shape":"Description", - "documentation":"

The description of the code interpreter.

" - }, - "status":{ - "shape":"CodeInterpreterStatus", - "documentation":"

The current status of the code interpreter.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the code interpreter was created.

" - }, - "lastUpdatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the code interpreter was last updated.

" - } - }, - "documentation":"

Contains summary information about a code interpreter. A code interpreter enables Amazon Bedrock AgentCore Agent to execute code.

" - }, - "CoinbaseCdpApiKeyIdType":{ - "type":"string", - "max":512, - "min":1, - "pattern":"[a-zA-Z0-9\\-_]+" - }, - "CoinbaseCdpConfigurationInput":{ - "type":"structure", - "required":["apiKeyId"], - "members":{ - "apiKeyId":{ - "shape":"CoinbaseCdpApiKeyIdType", - "documentation":"

The API key identifier provided by Coinbase Developer Platform.

" - }, - "apiKeySecret":{ - "shape":"DefaultCoinbaseCdpApiKeySecretType", - "documentation":"

The API key secret provided by Coinbase Developer Platform.

" - }, - "apiKeySecretSource":{ - "shape":"SecretSourceType", - "documentation":"

The source type of the API key secret for the Coinbase Developer Platform. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.

" - }, - "apiKeySecretConfig":{ - "shape":"SecretReference", - "documentation":"

A reference to the Amazon Web Services Secrets Manager secret that stores the API key secret. This includes the secret ID and the JSON key used to extract the API key secret value from the secret. Required when apiKeySecretSource is set to EXTERNAL.

" - }, - "walletSecret":{ - "shape":"DefaultCoinbaseCdpWalletSecretType", - "documentation":"

The wallet secret provided by Coinbase Developer Platform.

" - }, - "walletSecretSource":{ - "shape":"SecretSourceType", - "documentation":"

The source type of the wallet secret for the Coinbase Developer Platform. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.

" - }, - "walletSecretConfig":{ - "shape":"SecretReference", - "documentation":"

A reference to the Amazon Web Services Secrets Manager secret that stores the wallet secret. This includes the secret ID and the JSON key used to extract the wallet secret value from the secret. Required when walletSecretSource is set to EXTERNAL.

" - } - }, - "documentation":"

Coinbase CDP configuration — credentials provided by Coinbase Developer Platform.

" - }, - "CoinbaseCdpConfigurationOutput":{ - "type":"structure", - "required":[ - "apiKeyId", - "apiKeySecretArn", - "walletSecretArn" - ], - "members":{ - "apiKeyId":{ - "shape":"CoinbaseCdpApiKeyIdType", - "documentation":"

The API key identifier provided by Coinbase Developer Platform.

" - }, - "apiKeySecretArn":{"shape":"Secret"}, - "apiKeySecretJsonKey":{ - "shape":"SecretJsonKeyType", - "documentation":"

The JSON key used to extract the API key secret value from the Amazon Web Services Secrets Manager secret.

" - }, - "apiKeySecretSource":{ - "shape":"SecretSourceType", - "documentation":"

The source type of the API key secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager.

" - }, - "walletSecretArn":{"shape":"Secret"}, - "walletSecretJsonKey":{ - "shape":"SecretJsonKeyType", - "documentation":"

The JSON key used to extract the wallet secret value from the Amazon Web Services Secrets Manager secret.

" - }, - "walletSecretSource":{ - "shape":"SecretSourceType", - "documentation":"

The source type of the wallet secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager.

" - } - }, - "documentation":"

Coinbase CDP configuration output with secret ARNs.

" - }, - "ComponentConfiguration":{ - "type":"structure", - "required":["configuration"], - "members":{ - "configuration":{ - "shape":"Document", - "documentation":"

The configuration values as a flexible JSON document.

" - } - }, - "documentation":"

The configuration for a component within a configuration bundle. The component type is inferred from the component identifier ARN.

", - "sensitive":true - }, - "ComponentConfigurationMap":{ - "type":"map", - "key":{"shape":"ComponentIdentifier"}, - "value":{"shape":"ComponentConfiguration"} - }, - "ComponentIdentifier":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"[a-zA-Z][a-zA-Z0-9_:/.\\-]{0,2047}" - }, - "ConcurrentModificationException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"} - }, - "documentation":"

Exception thrown when a resource is modified concurrently by multiple requests.

", - "error":{ - "httpStatusCode":409, - "senderFault":true - }, - "exception":true - }, - "Condition":{ - "type":"structure", - "members":{ - "matchPrincipals":{ - "shape":"MatchPrincipals", - "documentation":"

A condition that matches on the identity of the caller making the request.

" - }, - "matchPaths":{ - "shape":"MatchPaths", - "documentation":"

A condition that matches on the request path.

" - } - }, - "documentation":"

A condition that determines when a gateway rule applies. Conditions can match on principals or request paths.

", - "union":true - }, - "Conditions":{ - "type":"list", - "member":{"shape":"Condition"}, - "max":2, - "min":0 - }, - "ConfigurationBundleAction":{ - "type":"structure", - "members":{ - "staticOverride":{ - "shape":"StaticOverride", - "documentation":"

A static configuration bundle override that applies a single bundle version to all matching requests.

" - }, - "weightedOverride":{ - "shape":"WeightedOverride", - "documentation":"

A weighted configuration bundle override that splits traffic between multiple bundle versions based on configured weights.

" - } - }, - "documentation":"

An action that applies a configuration bundle override, either as a static override or a weighted split for A/B testing.

", - "union":true - }, - "ConfigurationBundleArn":{ - "type":"string", - "pattern":"arn:aws[a-zA-Z-]*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:configuration-bundle/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}" - }, - "ConfigurationBundleDescription":{ - "type":"string", - "max":500, - "min":1, - "pattern":".+", - "sensitive":true - }, - "ConfigurationBundleId":{ - "type":"string", - "pattern":"[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}" - }, - "ConfigurationBundleName":{ - "type":"string", - "pattern":"[a-zA-Z][a-zA-Z0-9_]{0,99}" - }, - "ConfigurationBundleReference":{ - "type":"structure", - "required":[ - "bundleArn", - "bundleVersion" - ], - "members":{ - "bundleArn":{ - "shape":"GatewayConfigurationBundleArn", - "documentation":"

The Amazon Resource Name (ARN) of the configuration bundle.

" - }, - "bundleVersion":{ - "shape":"ConfigurationBundleReferenceBundleVersionString", - "documentation":"

The version of the configuration bundle.

" - } - }, - "documentation":"

A reference to a specific version of a configuration bundle.

" - }, - "ConfigurationBundleReferenceBundleVersionString":{ - "type":"string", - "pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" - }, - "ConfigurationBundleStatus":{ - "type":"string", - "enum":[ - "ACTIVE", - "CREATING", - "CREATE_FAILED", - "UPDATING", - "UPDATE_FAILED", - "DELETING", - "DELETE_FAILED" - ] - }, - "ConfigurationBundleSummary":{ - "type":"structure", - "required":[ - "bundleArn", - "bundleId", - "bundleName" - ], - "members":{ - "bundleArn":{ - "shape":"ConfigurationBundleArn", - "documentation":"

The Amazon Resource Name (ARN) of the configuration bundle.

" - }, - "bundleId":{ - "shape":"ConfigurationBundleId", - "documentation":"

The unique identifier of the configuration bundle.

" - }, - "bundleName":{ - "shape":"ConfigurationBundleName", - "documentation":"

The name of the configuration bundle.

" - }, - "description":{ - "shape":"ConfigurationBundleDescription", - "documentation":"

The description of the configuration bundle.

" - }, - "createdAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the configuration bundle was created.

" - } - }, - "documentation":"

Summary information about a configuration bundle.

" - }, - "ConfigurationBundleSummaryList":{ - "type":"list", - "member":{"shape":"ConfigurationBundleSummary"} - }, - "ConfigurationBundleVersion":{ - "type":"string", - "pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" - }, - "ConfigurationBundleVersionList":{ - "type":"list", - "member":{"shape":"ConfigurationBundleVersion"} - }, - "ConfigurationBundleVersionSummary":{ - "type":"structure", - "required":[ - "bundleArn", - "bundleId", - "versionId", - "versionCreatedAt" - ], - "members":{ - "bundleArn":{ - "shape":"ConfigurationBundleArn", - "documentation":"

The Amazon Resource Name (ARN) of the configuration bundle.

" - }, - "bundleId":{ - "shape":"ConfigurationBundleId", - "documentation":"

The unique identifier of the configuration bundle.

" - }, - "versionId":{ - "shape":"ConfigurationBundleVersion", - "documentation":"

The version identifier of this configuration bundle version.

" - }, - "lineageMetadata":{ - "shape":"VersionLineageMetadata", - "documentation":"

The version lineage metadata, including parent versions, branch name, and creation source.

" - }, - "versionCreatedAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when this version was created.

" - } - }, - "documentation":"

Summary information about a configuration bundle version.

" - }, - "ConfigurationBundleVersionSummaryList":{ - "type":"list", - "member":{"shape":"ConfigurationBundleVersionSummary"} - }, - "ConflictException":{ - "type":"structure", - "members":{ - "message":{"shape":"NonBlankString"} - }, - "documentation":"

This exception is thrown when there is a conflict performing an operation

", - "error":{ - "httpStatusCode":409, - "senderFault":true - }, - "exception":true - }, - "ConnectorConfiguration":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{ - "shape":"ConnectorConfigurationNameString", - "documentation":"

The tool or operation name (for example, retrieve or webSearch).

" - }, - "description":{ - "shape":"ConnectorConfigurationDescriptionString", - "documentation":"

An agent-facing description override for this tool.

" - }, - "parameterValues":{ - "shape":"Document", - "documentation":"

Parameters to set as fixed or default values when provisioning this tool.

" - }, - "parameterOverrides":{ - "shape":"ConnectorParameterOverrides", - "documentation":"

Parameters to expose to the agent at runtime, with optional description overrides.

" - } - }, - "documentation":"

Configuration for a single tool within a connector.

" - }, - "ConnectorConfigurationDescriptionString":{ - "type":"string", - "max":2000, - "min":0 - }, - "ConnectorConfigurationNameString":{ - "type":"string", - "max":64, - "min":0, - "pattern":"[a-zA-Z][a-zA-Z0-9_-]*" - }, - "ConnectorConfigurations":{ - "type":"list", - "member":{"shape":"ConnectorConfiguration"} - }, - "ConnectorId":{ - "type":"string", - "max":256, - "min":1 - }, - "ConnectorParameterOverride":{ - "type":"structure", - "required":["path"], - "members":{ - "path":{ - "shape":"String", - "documentation":"

A JSON Pointer path identifying the parameter (for example, /numberOfResults or /filter).

" - }, - "description":{ - "shape":"String", - "documentation":"

An agent-facing description override for this parameter.

" - }, - "visible":{ - "shape":"Boolean", - "documentation":"

Whether this parameter is visible to the agent. If not specified, uses the service default.

" - } - }, - "documentation":"

Specifies a parameter override for a connector tool, allowing you to control parameter visibility and descriptions.

" - }, - "ConnectorParameterOverrides":{ - "type":"list", - "member":{"shape":"ConnectorParameterOverride"} - }, - "ConnectorSource":{ - "type":"structure", - "required":["connectorId"], - "members":{ - "connectorId":{ - "shape":"ConnectorId", - "documentation":"

The identifier for the connector integration (for example, bedrock-knowledge-bases).

" - }, - "version":{ - "shape":"ConnectorVersion", - "documentation":"

The version of the connector to use (for example, 1.1.0). If you don't specify a version, the service uses the latest available version.

" - } - }, - "documentation":"

The source identifying the connector integration.

" - }, - "ConnectorTargetConfiguration":{ - "type":"structure", - "required":["source"], - "members":{ - "source":{ - "shape":"ConnectorSource", - "documentation":"

The source configuration identifying which connector to use.

" - }, - "enabled":{ - "shape":"EnabledConnectors", - "documentation":"

A list of tool names to enable from this connector. If absent, all tools provided by the connector are enabled.

" - }, - "configurations":{ - "shape":"ConnectorConfigurations", - "documentation":"

A list of per-tool configurations for the connector.

" - } - }, - "documentation":"

Configuration for a connector integration target. Connectors provide pre-built integrations with Amazon Web Services services and third-party tools.

" - }, - "ConnectorVersion":{ - "type":"string", - "max":32, - "min":5, - "pattern":"(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)" - }, - "ConsolidationConfiguration":{ - "type":"structure", - "members":{ - "customConsolidationConfiguration":{ - "shape":"CustomConsolidationConfiguration", - "documentation":"

The custom consolidation configuration.

" - } - }, - "documentation":"

Contains consolidation configuration information for a memory strategy.

", - "union":true - }, - "ContainerConfiguration":{ - "type":"structure", - "required":["containerUri"], - "members":{ - "containerUri":{ - "shape":"RuntimeContainerUri", - "documentation":"

The ECR URI of the container.

" - } - }, - "documentation":"

Representation of a container configuration.

" - }, - "Content":{ - "type":"structure", - "members":{ - "rawText":{ - "shape":"NaturalLanguage", - "documentation":"

The raw text content containing natural language descriptions of desired policy behavior. This text is processed by AI to generate corresponding Cedar policy statements that match the described intent.

" - } - }, - "documentation":"

Represents content input for policy generation operations. This structure encapsulates the natural language descriptions or other content formats that are used as input for AI-powered policy generation.

", - "union":true - }, - "ContentConfiguration":{ - "type":"structure", - "required":["type"], - "members":{ - "type":{ - "shape":"ContentType", - "documentation":"

Type of content to stream.

" - }, - "level":{ - "shape":"ContentLevel", - "documentation":"

Level of detail for streamed content.

" - } - }, - "documentation":"

Defines what content to stream and at what level of detail.

" - }, - "ContentLevel":{ - "type":"string", - "enum":[ - "METADATA_ONLY", - "FULL_CONTENT" - ] - }, - "ContentType":{ - "type":"string", - "enum":["MEMORY_RECORDS"] - }, - "CreateAgentRuntimeEndpointRequest":{ - "type":"structure", - "required":[ - "agentRuntimeId", - "name" - ], - "members":{ - "agentRuntimeId":{ - "shape":"AgentRuntimeId", - "documentation":"

The unique identifier of the AgentCore Runtime to create an endpoint for.

", - "location":"uri", - "locationName":"agentRuntimeId" - }, - "name":{ - "shape":"EndpointName", - "documentation":"

The name of the AgentCore Runtime endpoint.

" - }, - "agentRuntimeVersion":{ - "shape":"AgentRuntimeVersion", - "documentation":"

The version of the AgentCore Runtime to use for the endpoint.

" - }, - "description":{ - "shape":"AgentEndpointDescription", - "documentation":"

The description of the AgentCore Runtime endpoint.

" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure idempotency of the request.

", - "idempotencyToken":true - }, - "tags":{ - "shape":"TagsMap", - "documentation":"

A map of tag keys and values to assign to the agent runtime endpoint. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

" - } - } - }, - "CreateAgentRuntimeEndpointResponse":{ - "type":"structure", - "required":[ - "targetVersion", - "agentRuntimeEndpointArn", - "agentRuntimeArn", - "status", - "createdAt" - ], - "members":{ - "targetVersion":{ - "shape":"AgentRuntimeVersion", - "documentation":"

The target version of the AgentCore Runtime for the endpoint.

" - }, - "agentRuntimeEndpointArn":{ - "shape":"AgentRuntimeEndpointArn", - "documentation":"

The Amazon Resource Name (ARN) of the AgentCore Runtime endpoint.

" - }, - "agentRuntimeArn":{ - "shape":"AgentRuntimeArn", - "documentation":"

The Amazon Resource Name (ARN) of the AgentCore Runtime.

" - }, - "agentRuntimeId":{ - "shape":"AgentRuntimeId", - "documentation":"

The unique identifier of the AgentCore Runtime.

" - }, - "endpointName":{ - "shape":"EndpointName", - "documentation":"

The name of the AgentCore Runtime endpoint.

" - }, - "status":{ - "shape":"AgentRuntimeEndpointStatus", - "documentation":"

The current status of the AgentCore Runtime endpoint.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the AgentCore Runtime endpoint was created.

" - } - } - }, - "CreateAgentRuntimeRequest":{ - "type":"structure", - "required":[ - "agentRuntimeName", - "agentRuntimeArtifact", - "roleArn", - "networkConfiguration" - ], - "members":{ - "agentRuntimeName":{ - "shape":"AgentRuntimeName", - "documentation":"

The name of the AgentCore Runtime.

" - }, - "agentRuntimeArtifact":{ - "shape":"AgentRuntimeArtifact", - "documentation":"

The artifact of the AgentCore Runtime.

" - }, - "roleArn":{ - "shape":"RoleArn", - "documentation":"

The IAM role ARN that provides permissions for the AgentCore Runtime.

" - }, - "networkConfiguration":{ - "shape":"NetworkConfiguration", - "documentation":"

The network configuration for the AgentCore Runtime.

" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure idempotency of the request.

", - "idempotencyToken":true - }, - "description":{ - "shape":"Description", - "documentation":"

The description of the AgentCore Runtime.

" - }, - "authorizerConfiguration":{ - "shape":"AuthorizerConfiguration", - "documentation":"

The authorizer configuration for the AgentCore Runtime.

" - }, - "requestHeaderConfiguration":{ - "shape":"RequestHeaderConfiguration", - "documentation":"

Configuration for HTTP request headers that will be passed through to the runtime.

" - }, - "protocolConfiguration":{"shape":"ProtocolConfiguration"}, - "lifecycleConfiguration":{ - "shape":"LifecycleConfiguration", - "documentation":"

The life cycle configuration for the AgentCore Runtime.

" - }, - "environmentVariables":{ - "shape":"EnvironmentVariablesMap", - "documentation":"

Environment variables to set in the AgentCore Runtime environment.

" - }, - "filesystemConfigurations":{ - "shape":"FilesystemConfigurations", - "documentation":"

The filesystem configurations to mount into the AgentCore Runtime. Use filesystem configurations to provide persistent storage to your AgentCore Runtime sessions.

" - }, - "tags":{ - "shape":"TagsMap", - "documentation":"

A map of tag keys and values to assign to the agent runtime. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

" - } - } - }, - "CreateAgentRuntimeResponse":{ - "type":"structure", - "required":[ - "agentRuntimeArn", - "agentRuntimeId", - "agentRuntimeVersion", - "createdAt", - "status" - ], - "members":{ - "agentRuntimeArn":{ - "shape":"AgentRuntimeArn", - "documentation":"

The Amazon Resource Name (ARN) of the AgentCore Runtime.

" - }, - "workloadIdentityDetails":{ - "shape":"WorkloadIdentityDetails", - "documentation":"

The workload identity details for the AgentCore Runtime.

" - }, - "agentRuntimeId":{ - "shape":"AgentRuntimeId", - "documentation":"

The unique identifier of the AgentCore Runtime.

" - }, - "agentRuntimeVersion":{ - "shape":"AgentRuntimeVersion", - "documentation":"

The version of the AgentCore Runtime.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the AgentCore Runtime was created.

" - }, - "status":{ - "shape":"AgentRuntimeStatus", - "documentation":"

The current status of the AgentCore Runtime.

" - } - } - }, - "CreateApiKeyCredentialProviderRequest":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{ - "shape":"CredentialProviderName", - "documentation":"

The name of the API key credential provider. The name must be unique within your account.

" - }, - "apiKey":{ - "shape":"DefaultApiKeyType", - "documentation":"

The API key to use for authentication. This value is encrypted and stored securely.

" - }, - "apiKeySecretConfig":{ - "shape":"SecretReference", - "documentation":"

A reference to the Amazon Web Services Secrets Manager secret that stores the API key. This includes the secret ID and the JSON key used to extract the API key value from the secret. Required when apiKeySecretSource is set to EXTERNAL.

" - }, - "apiKeySecretSource":{ - "shape":"SecretSourceType", - "documentation":"

The source type of the API key secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.

" - }, - "tags":{ - "shape":"TagsMap", - "documentation":"

A map of tag keys and values to assign to the API key credential provider. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

" - } - } - }, - "CreateApiKeyCredentialProviderResponse":{ - "type":"structure", - "required":[ - "apiKeySecretArn", - "name", - "credentialProviderArn" - ], - "members":{ - "apiKeySecretArn":{ - "shape":"Secret", - "documentation":"

The Amazon Resource Name (ARN) of the secret containing the API key.

" - }, - "apiKeySecretJsonKey":{ - "shape":"SecretJsonKeyType", - "documentation":"

The JSON key used to extract the API key value from the Amazon Web Services Secrets Manager secret.

" - }, - "apiKeySecretSource":{ - "shape":"SecretSourceType", - "documentation":"

The source type of the API key secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager.

" - }, - "name":{ - "shape":"CredentialProviderName", - "documentation":"

The name of the created API key credential provider.

" - }, - "credentialProviderArn":{ - "shape":"ApiKeyCredentialProviderArnType", - "documentation":"

The Amazon Resource Name (ARN) of the created API key credential provider.

" - } - } - }, - "CreateBrowserProfileRequest":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{ - "shape":"BrowserProfileName", - "documentation":"

The name of the browser profile. The name must be unique within your account and can contain alphanumeric characters and underscores.

" - }, - "description":{ - "shape":"Description", - "documentation":"

A description of the browser profile. Use this field to describe the purpose or contents of the profile.

" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock AgentCore ignores the request but does not return an error.

", - "idempotencyToken":true - }, - "tags":{ - "shape":"TagsMap", - "documentation":"

A map of tag keys and values to assign to the browser profile. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

" - } - } - }, - "CreateBrowserProfileResponse":{ - "type":"structure", - "required":[ - "profileId", - "profileArn", - "createdAt", - "status" - ], - "members":{ - "profileId":{ - "shape":"BrowserProfileId", - "documentation":"

The unique identifier of the created browser profile.

" - }, - "profileArn":{ - "shape":"BrowserProfileArn", - "documentation":"

The Amazon Resource Name (ARN) of the created browser profile.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the browser profile was created.

" - }, - "status":{ - "shape":"BrowserProfileStatus", - "documentation":"

The current status of the browser profile.

" - } - } - }, - "CreateBrowserRequest":{ - "type":"structure", - "required":[ - "name", - "networkConfiguration" - ], - "members":{ - "name":{ - "shape":"SandboxName", - "documentation":"

The name of the browser. The name must be unique within your account.

" - }, - "description":{ - "shape":"Description", - "documentation":"

The description of the browser.

" - }, - "executionRoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the browser to access Amazon Web Services services.

" - }, - "networkConfiguration":{ - "shape":"BrowserNetworkConfiguration", - "documentation":"

The network configuration for the browser. This configuration specifies the network mode for the browser.

" - }, - "recording":{ - "shape":"RecordingConfig", - "documentation":"

The recording configuration for the browser. When enabled, browser sessions are recorded and stored in the specified Amazon S3 location.

" - }, - "browserSigning":{ - "shape":"BrowserSigningConfigInput", - "documentation":"

The browser signing configuration that enables cryptographic agent identification using HTTP message signatures for web bot authentication.

" - }, - "enterprisePolicies":{ - "shape":"BrowserEnterprisePolicies", - "documentation":"

A list of enterprise policy files for the browser.

" - }, - "certificates":{ - "shape":"Certificates", - "documentation":"

A list of certificates to install in the browser.

" - }, - "filesystemConfigurations":{ - "shape":"ToolsFileSystemConfigurations", - "documentation":"

The file system configurations to mount into the browser. Use these configurations to mount your own Amazon Simple Storage Service (Amazon S3) Files or Amazon Elastic File System (Amazon EFS) access points. Your sessions can then access your data. If you don't specify this field, no file systems are mounted.

" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock AgentCore ignores the request but does not return an error.

", - "idempotencyToken":true - }, - "tags":{ - "shape":"TagsMap", - "documentation":"

A map of tag keys and values to assign to the browser. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

" - } - } - }, - "CreateBrowserResponse":{ - "type":"structure", - "required":[ - "browserId", - "browserArn", - "createdAt", - "status" - ], - "members":{ - "browserId":{ - "shape":"BrowserId", - "documentation":"

The unique identifier of the created browser.

" - }, - "browserArn":{ - "shape":"BrowserArn", - "documentation":"

The Amazon Resource Name (ARN) of the created browser.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the browser was created.

" - }, - "status":{ - "shape":"BrowserStatus", - "documentation":"

The current status of the browser.

" - } - } - }, - "CreateCodeInterpreterRequest":{ - "type":"structure", - "required":[ - "name", - "networkConfiguration" - ], - "members":{ - "name":{ - "shape":"SandboxName", - "documentation":"

The name of the code interpreter. The name must be unique within your account.

" - }, - "description":{ - "shape":"Description", - "documentation":"

The description of the code interpreter.

" - }, - "executionRoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the code interpreter to access Amazon Web Services services.

" - }, - "networkConfiguration":{ - "shape":"CodeInterpreterNetworkConfiguration", - "documentation":"

The network configuration for the code interpreter. This configuration specifies the network mode for the code interpreter.

" - }, - "certificates":{ - "shape":"Certificates", - "documentation":"

A list of certificates to install in the code interpreter.

" - }, - "filesystemConfigurations":{ - "shape":"ToolsFileSystemConfigurations", - "documentation":"

The file system configurations to mount into the code interpreter. Use these configurations to mount your own Amazon Simple Storage Service (Amazon S3) Files or Amazon Elastic File System (Amazon EFS) access points. Your sessions can then access your data. If you don't specify this field, no file systems are mounted.

" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock AgentCore ignores the request but does not return an error.

", - "idempotencyToken":true - }, - "tags":{ - "shape":"TagsMap", - "documentation":"

A map of tag keys and values to assign to the code interpreter. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

" - } - } - }, - "CreateCodeInterpreterResponse":{ - "type":"structure", - "required":[ - "codeInterpreterId", - "codeInterpreterArn", - "createdAt", - "status" - ], - "members":{ - "codeInterpreterId":{ - "shape":"CodeInterpreterId", - "documentation":"

The unique identifier of the created code interpreter.

" - }, - "codeInterpreterArn":{ - "shape":"CodeInterpreterArn", - "documentation":"

The Amazon Resource Name (ARN) of the created code interpreter.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the code interpreter was created.

" - }, - "status":{ - "shape":"CodeInterpreterStatus", - "documentation":"

The current status of the code interpreter.

" - } - } - }, - "CreateConfigurationBundleRequest":{ - "type":"structure", - "required":[ - "bundleName", - "components" - ], - "members":{ - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "idempotencyToken":true - }, - "bundleName":{ - "shape":"ConfigurationBundleName", - "documentation":"

The name for the configuration bundle. Names must be unique within your account.

" - }, - "description":{ - "shape":"ConfigurationBundleDescription", - "documentation":"

The description for the configuration bundle.

" - }, - "components":{ - "shape":"ComponentConfigurationMap", - "documentation":"

A map of component identifiers to their configurations. Each component represents a configurable element within the bundle.

" - }, - "branchName":{ - "shape":"BranchName", - "documentation":"

The branch name for version tracking. Defaults to mainline if not specified.

" - }, - "commitMessage":{ - "shape":"CreateConfigurationBundleRequestCommitMessageString", - "documentation":"

A commit message describing the initial version of the configuration bundle.

" - }, - "createdBy":{ - "shape":"VersionCreatedBySource", - "documentation":"

The source that created this version, including the source name and optional ARN.

" - }, - "kmsKeyArn":{ - "shape":"KmsKeyArn", - "documentation":"

Optional KMS key ARN for encrypting component configurations.

" - }, - "tags":{ - "shape":"TagsMap", - "documentation":"

A map of tag keys and values to assign to the configuration bundle. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

" - } - } - }, - "CreateConfigurationBundleRequestCommitMessageString":{ - "type":"string", - "max":500, - "min":1 - }, - "CreateConfigurationBundleResponse":{ - "type":"structure", - "required":[ - "bundleArn", - "bundleId", - "versionId", - "createdAt" - ], - "members":{ - "bundleArn":{ - "shape":"ConfigurationBundleArn", - "documentation":"

The Amazon Resource Name (ARN) of the created configuration bundle.

" - }, - "bundleId":{ - "shape":"ConfigurationBundleId", - "documentation":"

The unique identifier of the created configuration bundle.

" - }, - "versionId":{ - "shape":"ConfigurationBundleVersion", - "documentation":"

The initial version identifier of the configuration bundle.

" - }, - "createdAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the configuration bundle was created.

" - } - } - }, - "CreateDatasetRequest":{ - "type":"structure", - "required":[ - "datasetName", - "source", - "schemaType" - ], - "members":{ - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "idempotencyToken":true - }, - "datasetName":{ - "shape":"DatasetName", - "documentation":"

Human-readable name for the dataset. Must be unique within the account. Immutable after creation.

" - }, - "description":{ - "shape":"CreateDatasetRequestDescriptionString", - "documentation":"

A description of the dataset.

" - }, - "source":{ - "shape":"DataSourceType", - "documentation":"

Source of initial examples. Provide either inline examples or an S3 URI pointing to a JSONL file.

" - }, - "schemaType":{ - "shape":"DatasetSchemaType", - "documentation":"

Versioned schema type governing the structure of examples. Immutable after creation.

" - }, - "kmsKeyArn":{ - "shape":"KmsKeyArn", - "documentation":"

Optional KMS key ARN for server-side encryption on service Amazon S3 writes.

" - }, - "tags":{ - "shape":"TagsMap", - "documentation":"

A map of tag keys and values to assign to the dataset.

" - } - } - }, - "CreateDatasetRequestDescriptionString":{ - "type":"string", - "max":200, - "min":0 - }, - "CreateDatasetResponse":{ - "type":"structure", - "required":[ - "datasetArn", - "datasetId", - "status", - "createdAt" - ], - "members":{ - "datasetArn":{ - "shape":"DatasetArn", - "documentation":"

The Amazon Resource Name (ARN) of the created dataset.

" - }, - "datasetId":{ - "shape":"DatasetId", - "documentation":"

The unique identifier of the created dataset.

" - }, - "status":{ - "shape":"DatasetStatus", - "documentation":"

Always CREATING immediately after this call. Poll GetDataset until status transitions to ACTIVE or CREATE_FAILED.

" - }, - "createdAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the dataset was created.

" - } - } - }, - "CreateDatasetVersionRequest":{ - "type":"structure", - "required":["datasetId"], - "members":{ - "datasetId":{ - "shape":"DatasetId", - "documentation":"

The unique identifier of the dataset to publish a version for.

", - "location":"uri", - "locationName":"datasetId" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "idempotencyToken":true - } - } - }, - "CreateDatasetVersionResponse":{ - "type":"structure", - "required":[ - "datasetArn", - "datasetId", - "status", - "datasetVersion", - "createdAt" - ], - "members":{ - "datasetArn":{ - "shape":"DatasetArn", - "documentation":"

The Amazon Resource Name (ARN) of the dataset.

" - }, - "datasetId":{ - "shape":"DatasetId", - "documentation":"

The unique identifier of the dataset.

" - }, - "status":{ - "shape":"DatasetStatus", - "documentation":"

Always UPDATING immediately after this call. Poll GetDataset until status transitions to ACTIVE or UPDATE_FAILED.

" - }, - "datasetVersion":{ - "shape":"DatasetVersion", - "documentation":"

The version number being created.

" - }, - "createdAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the version creation was initiated.

" - } - } - }, - "CreateEvaluatorRequest":{ - "type":"structure", - "required":[ - "evaluatorName", - "evaluatorConfig", - "level" - ], - "members":{ - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "idempotencyToken":true - }, - "evaluatorName":{ - "shape":"CustomEvaluatorName", - "documentation":"

The name of the evaluator. Must be unique within your account.

" - }, - "description":{ - "shape":"EvaluatorDescription", - "documentation":"

The description of the evaluator that explains its purpose and evaluation criteria.

" - }, - "evaluatorConfig":{ - "shape":"EvaluatorConfig", - "documentation":"

The configuration for the evaluator. Specify either LLM-as-a-Judge settings with instructions, rating scale, and model configuration, or code-based settings with a customer-managed Lambda function.

" - }, - "level":{ - "shape":"EvaluatorLevel", - "documentation":"

The evaluation level that determines the scope of evaluation. Valid values are TOOL_CALL for individual tool invocations, TRACE for single request-response interactions, or SESSION for entire conversation sessions.

" - }, - "kmsKeyArn":{ - "shape":"KmsKeyArn", - "documentation":"

The Amazon Resource Name (ARN) of a customer managed KMS key to use for encrypting sensitive evaluator data, including instructions and rating scale. If you don't specify a KMS key, the evaluator data is encrypted with an Amazon Web Services owned key. Only symmetric encryption KMS keys are supported. For more information, see Encryption at rest for AgentCore Evaluations.

" - }, - "tags":{ - "shape":"TagsMap", - "documentation":"

A map of tag keys and values to assign to an AgentCore Evaluator. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

" - } - } - }, - "CreateEvaluatorResponse":{ - "type":"structure", - "required":[ - "evaluatorArn", - "evaluatorId", - "createdAt", - "status" - ], - "members":{ - "evaluatorArn":{ - "shape":"CustomEvaluatorArn", - "documentation":"

The Amazon Resource Name (ARN) of the created evaluator.

" - }, - "evaluatorId":{ - "shape":"EvaluatorId", - "documentation":"

The unique identifier of the created evaluator.

" - }, - "createdAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the evaluator was created.

" - }, - "status":{ - "shape":"EvaluatorStatus", - "documentation":"

The status of the evaluator creation operation.

" - } - } - }, - "CreateGatewayRequest":{ - "type":"structure", - "required":[ - "name", - "roleArn", - "authorizerType" - ], - "members":{ - "name":{ - "shape":"GatewayName", - "documentation":"

The name of the gateway. The name must be unique within your account.

" - }, - "description":{ - "shape":"GatewayDescription", - "documentation":"

The description of the gateway.

" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "idempotencyToken":true - }, - "roleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the gateway to access Amazon Web Services services.

" - }, - "protocolType":{ - "shape":"GatewayProtocolType", - "documentation":"

The protocol type for the gateway.

" - }, - "protocolConfiguration":{ - "shape":"GatewayProtocolConfiguration", - "documentation":"

The configuration settings for the protocol specified in the protocolType parameter.

" - }, - "authorizerType":{ - "shape":"AuthorizerType", - "documentation":"

The type of authorizer to use for the gateway.

  • CUSTOM_JWT - Authorize with a bearer token.

  • AWS_IAM - Authorize with your Amazon Web Services IAM credentials.

  • NONE - No authorization

" - }, - "authorizerConfiguration":{ - "shape":"AuthorizerConfiguration", - "documentation":"

The authorizer configuration for the gateway. Required if authorizerType is CUSTOM_JWT.

" - }, - "kmsKeyArn":{ - "shape":"KmsKeyArn", - "documentation":"

The Amazon Resource Name (ARN) of the KMS key used to encrypt data associated with the gateway.

" - }, - "interceptorConfigurations":{ - "shape":"GatewayInterceptorConfigurations", - "documentation":"

A list of configuration settings for a gateway interceptor. Gateway interceptors allow custom code to be invoked during gateway invocations.

" - }, - "policyEngineConfiguration":{ - "shape":"GatewayPolicyEngineConfiguration", - "documentation":"

The policy engine configuration for the gateway. A policy engine is a collection of policies that evaluates and authorizes agent tool calls. When associated with a gateway, the policy engine intercepts all agent requests and determines whether to allow or deny each action based on the defined policies.

" - }, - "exceptionLevel":{ - "shape":"ExceptionLevel", - "documentation":"

The level of detail in error messages returned when invoking the gateway.

  • If the value is DEBUG, granular exception messages are returned to help a user debug the gateway.

  • If the value is omitted, a generic error message is returned to the end user.

" - }, - "tags":{ - "shape":"TagsMap", - "documentation":"

A map of key-value pairs to associate with the gateway as metadata tags.

" - } - } - }, - "CreateGatewayResponse":{ - "type":"structure", - "required":[ - "gatewayArn", - "gatewayId", - "createdAt", - "updatedAt", - "status", - "name", - "authorizerType" - ], - "members":{ - "gatewayArn":{ - "shape":"GatewayArn", - "documentation":"

The Amazon Resource Name (ARN) of the created gateway.

" - }, - "gatewayId":{ - "shape":"GatewayId", - "documentation":"

The unique identifier of the created gateway.

" - }, - "gatewayUrl":{ - "shape":"GatewayUrl", - "documentation":"

The URL endpoint for the created gateway.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the gateway was created.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the gateway was last updated.

" - }, - "status":{ - "shape":"GatewayStatus", - "documentation":"

The current status of the gateway.

" - }, - "statusReasons":{ - "shape":"StatusReasons", - "documentation":"

The reasons for the current status of the gateway.

" - }, - "name":{ - "shape":"GatewayName", - "documentation":"

The name of the gateway.

" - }, - "description":{ - "shape":"GatewayDescription", - "documentation":"

The description of the gateway.

" - }, - "roleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the IAM role associated with the gateway.

" - }, - "protocolType":{ - "shape":"GatewayProtocolType", - "documentation":"

The protocol type of the gateway.

" - }, - "protocolConfiguration":{ - "shape":"GatewayProtocolConfiguration", - "documentation":"

The configuration settings for the protocol used by the gateway.

" - }, - "authorizerType":{ - "shape":"AuthorizerType", - "documentation":"

The type of authorizer used by the gateway.

" - }, - "authorizerConfiguration":{ - "shape":"AuthorizerConfiguration", - "documentation":"

The authorizer configuration for the created gateway.

" - }, - "kmsKeyArn":{ - "shape":"KmsKeyArn", - "documentation":"

The Amazon Resource Name (ARN) of the KMS key used to encrypt data associated with the gateway.

" - }, - "customTransformConfiguration":{ - "shape":"CustomTransformConfiguration", - "documentation":"

The custom transformation configuration for the gateway. This configuration defines how the gateway transforms requests and responses.

" - }, - "interceptorConfigurations":{ - "shape":"GatewayInterceptorConfigurations", - "documentation":"

The list of interceptor configurations for the created gateway.

" - }, - "policyEngineConfiguration":{ - "shape":"GatewayPolicyEngineConfiguration", - "documentation":"

The policy engine configuration for the created gateway.

" - }, - "workloadIdentityDetails":{ - "shape":"WorkloadIdentityDetails", - "documentation":"

The workload identity details for the created gateway.

" - }, - "exceptionLevel":{ - "shape":"ExceptionLevel", - "documentation":"

The level of detail in error messages returned when invoking the gateway.

  • If the value is DEBUG, granular exception messages are returned to help a user debug the gateway.

  • If the value is omitted, a generic error message is returned to the end user.

" - }, - "webAclArn":{ - "shape":"WebAclArn", - "documentation":"

The Amazon Resource Name (ARN) of the Amazon Web Services WAF web ACL associated with the gateway.

" - }, - "wafConfiguration":{ - "shape":"WafConfiguration", - "documentation":"

The Amazon Web Services WAF configuration for the gateway.

" - } - } - }, - "CreateGatewayRuleRequest":{ - "type":"structure", - "required":[ - "gatewayIdentifier", - "priority", - "actions" - ], - "members":{ - "gatewayIdentifier":{ - "shape":"GatewayIdentifier", - "documentation":"

The identifier of the gateway to create a rule for.

", - "location":"uri", - "locationName":"gatewayIdentifier" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "idempotencyToken":true - }, - "priority":{ - "shape":"GatewayRulePriority", - "documentation":"

The priority of the rule. Rules are evaluated in order of priority, with lower numbers evaluated first. Must be between 1 and 1,000,000.

" - }, - "conditions":{ - "shape":"Conditions", - "documentation":"

The conditions that must be met for the rule to apply. Conditions can match on principals (IAM ARNs) or request paths.

" - }, - "actions":{ - "shape":"Actions", - "documentation":"

The actions to take when the rule conditions are met. Actions can route to a specific target or apply a configuration bundle override.

" - }, - "description":{ - "shape":"GatewayRuleDescription", - "documentation":"

The description of the gateway rule.

" - } - } - }, - "CreateGatewayRuleResponse":{ - "type":"structure", - "required":[ - "ruleId", - "gatewayArn", - "priority", - "actions", - "createdAt", - "status" - ], - "members":{ - "ruleId":{ - "shape":"GatewayRuleId", - "documentation":"

The unique identifier of the gateway rule.

" - }, - "gatewayArn":{ - "shape":"GatewayArn", - "documentation":"

The Amazon Resource Name (ARN) of the gateway that the rule belongs to.

" - }, - "priority":{ - "shape":"GatewayRulePriority", - "documentation":"

The priority of the rule. Rules are evaluated in order of priority, with lower numbers evaluated first.

" - }, - "conditions":{ - "shape":"Conditions", - "documentation":"

The conditions that must be met for the rule to apply.

" - }, - "actions":{ - "shape":"Actions", - "documentation":"

The actions to take when the rule conditions are met.

" - }, - "description":{ - "shape":"GatewayRuleDescription", - "documentation":"

The description of the gateway rule.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the rule was created.

" - }, - "status":{ - "shape":"GatewayRuleStatus", - "documentation":"

The current status of the rule.

" - }, - "system":{ - "shape":"SystemManagedBlock", - "documentation":"

System-managed metadata for rules created by automated processes.

" - } - } - }, - "CreateGatewayTargetRequest":{ - "type":"structure", - "required":[ - "gatewayIdentifier", - "targetConfiguration" - ], - "members":{ - "gatewayIdentifier":{ - "shape":"GatewayIdentifier", - "documentation":"

The identifier of the gateway to create a target for.

", - "location":"uri", - "locationName":"gatewayIdentifier" - }, - "name":{ - "shape":"TargetName", - "documentation":"

The name of the gateway target. The name must be unique within the gateway.

" - }, - "description":{ - "shape":"TargetDescription", - "documentation":"

The description of the gateway target.

" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "idempotencyToken":true - }, - "targetConfiguration":{ - "shape":"TargetConfiguration", - "documentation":"

The configuration settings for the target, including endpoint information and schema definitions.

" - }, - "credentialProviderConfigurations":{ - "shape":"CredentialProviderConfigurations", - "documentation":"

The credential provider configurations for the target. These configurations specify how the gateway authenticates with the target endpoint.

" - }, - "metadataConfiguration":{ - "shape":"MetadataConfiguration", - "documentation":"

Optional configuration for HTTP header and query parameter propagation to and from the gateway target.

" - }, - "privateEndpoint":{ - "shape":"PrivateEndpoint", - "documentation":"

The private endpoint configuration for the gateway target. Use this to connect the gateway to private resources in your VPC.

" - } - } - }, - "CreateGatewayTargetResponse":{ - "type":"structure", - "required":[ - "gatewayArn", - "targetId", - "createdAt", - "updatedAt", - "status", - "name", - "targetConfiguration", - "credentialProviderConfigurations" - ], - "members":{ - "gatewayArn":{ - "shape":"GatewayArn", - "documentation":"

The Amazon Resource Name (ARN) of the gateway.

" - }, - "targetId":{ - "shape":"TargetId", - "documentation":"

The unique identifier of the created target.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the target was created.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the target was last updated.

" - }, - "status":{ - "shape":"TargetStatus", - "documentation":"

The current status of the target.

" - }, - "statusReasons":{ - "shape":"StatusReasons", - "documentation":"

The reasons for the current status of the target.

" - }, - "name":{ - "shape":"TargetName", - "documentation":"

The name of the target.

" - }, - "description":{ - "shape":"TargetDescription", - "documentation":"

The description of the target.

" - }, - "targetConfiguration":{ - "shape":"TargetConfiguration", - "documentation":"

The configuration settings for the target.

" - }, - "credentialProviderConfigurations":{ - "shape":"CredentialProviderConfigurations", - "documentation":"

The credential provider configurations for the target.

" - }, - "lastSynchronizedAt":{ - "shape":"DateTimestamp", - "documentation":"

The last synchronization of the target.

" - }, - "metadataConfiguration":{ - "shape":"MetadataConfiguration", - "documentation":"

The metadata configuration that was applied to the created gateway target.

" - }, - "privateEndpoint":{ - "shape":"PrivateEndpoint", - "documentation":"

The private endpoint configuration for the gateway target.

" - }, - "privateEndpointManagedResources":{ - "shape":"PrivateEndpointManagedResources", - "documentation":"

The managed resources created by the gateway for private endpoint connectivity.

" - }, - "authorizationData":{ - "shape":"AuthorizationData", - "documentation":"

OAuth2 authorization data for the created gateway target. This data is returned when a target is configured with a credential provider with authorization code grant type and requires user federation.

" - }, - "protocolType":{ - "shape":"TargetProtocolType", - "documentation":"

The protocol type of the created gateway target.

" - } - } - }, - "CreateHarnessEndpointRequest":{ - "type":"structure", - "required":[ - "harnessId", - "endpointName" - ], - "members":{ - "harnessId":{ - "shape":"HarnessId", - "documentation":"

The ID of the harness to create an endpoint for.

", - "location":"uri", - "locationName":"harnessId" - }, - "endpointName":{ - "shape":"HarnessEndpointName", - "documentation":"

The name of the endpoint. Must start with a letter and contain only alphanumeric characters and underscores.

" - }, - "targetVersion":{ - "shape":"HarnessVersion", - "documentation":"

The harness version that the endpoint points to and serves invocations from.

" - }, - "description":{ - "shape":"HarnessEndpointDescription", - "documentation":"

A description of the endpoint.

" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure idempotency of the request.

", - "idempotencyToken":true - }, - "tags":{ - "shape":"TagsMap", - "documentation":"

Tags to apply to the endpoint resource.

" - } - } - }, - "CreateHarnessEndpointResponse":{ - "type":"structure", - "required":["endpoint"], - "members":{ - "endpoint":{ - "shape":"HarnessEndpoint", - "documentation":"

The endpoint that was created.

" - } - } - }, - "CreateHarnessRequest":{ - "type":"structure", - "required":[ - "harnessName", - "executionRoleArn" - ], - "members":{ - "harnessName":{ - "shape":"HarnessName", - "documentation":"

The name of the harness. Must start with a letter and contain only alphanumeric characters and underscores.

" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure idempotency of the request.

", - "idempotencyToken":true - }, - "executionRoleArn":{ - "shape":"RoleArn", - "documentation":"

The ARN of the IAM role that the harness assumes when running. This role must have permissions for the services the agent needs to access, such as Amazon Bedrock for model invocation.

" - }, - "environment":{ - "shape":"HarnessEnvironmentProviderRequest", - "documentation":"

The compute environment configuration for the harness, including network and lifecycle settings.

" - }, - "environmentArtifact":{ - "shape":"HarnessEnvironmentArtifact", - "documentation":"

The environment artifact for the harness, such as a custom container image containing additional dependencies.

" - }, - "environmentVariables":{ - "shape":"EnvironmentVariablesMap", - "documentation":"

Environment variables to set in the harness runtime environment.

" - }, - "authorizerConfiguration":{"shape":"AuthorizerConfiguration"}, - "model":{ - "shape":"HarnessModelConfiguration", - "documentation":"

The model configuration for the harness. Supports Amazon Bedrock, OpenAI, and Google Gemini model providers.

" - }, - "systemPrompt":{ - "shape":"HarnessSystemPrompt", - "documentation":"

The system prompt that defines the agent's behavior and instructions.

" - }, - "tools":{ - "shape":"HarnessTools", - "documentation":"

The tools available to the agent, such as remote MCP servers, AgentCore Gateway, AgentCore Browser, Code Interpreter, or inline functions.

" - }, - "skills":{ - "shape":"HarnessSkills", - "documentation":"

The skills available to the agent. Skills are bundles of files that the agent can pull into its context on demand.

" - }, - "allowedTools":{ - "shape":"HarnessAllowedTools", - "documentation":"

The tools that the agent is allowed to use. Supports glob patterns such as * for all tools, @builtin for all built-in tools, or @serverName/toolName for specific MCP server tools.

" - }, - "memory":{ - "shape":"HarnessMemoryConfiguration", - "documentation":"

The AgentCore Memory configuration for persisting conversation context across sessions.

" - }, - "truncation":{ - "shape":"HarnessTruncationConfiguration", - "documentation":"

The truncation configuration for managing conversation context when it exceeds model limits.

" - }, - "maxIterations":{ - "shape":"Integer", - "documentation":"

The maximum number of iterations the agent loop can execute per invocation.

" - }, - "maxTokens":{ - "shape":"Integer", - "documentation":"

The maximum total number of output tokens the agent can generate across all model calls within a single invocation.

" - }, - "timeoutSeconds":{ - "shape":"Integer", - "documentation":"

The maximum duration in seconds for the agent loop execution per invocation.

" - }, - "tags":{ - "shape":"TagsMap", - "documentation":"

Tags to apply to the harness resource.

" - } - } - }, - "CreateHarnessResponse":{ - "type":"structure", - "required":["harness"], - "members":{ - "harness":{ - "shape":"Harness", - "documentation":"

The harness that was created.

" - } - } - }, - "CreateMemoryInput":{ - "type":"structure", - "required":[ - "name", - "eventExpiryDuration" - ], - "members":{ - "clientToken":{ - "shape":"CreateMemoryInputClientTokenString", - "documentation":"

A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request but does not return an error.

", - "idempotencyToken":true - }, - "name":{ - "shape":"Name", - "documentation":"

The name of the memory. The name must be unique within your account.

" - }, - "description":{ - "shape":"Description", - "documentation":"

The description of the memory.

" - }, - "encryptionKeyArn":{ - "shape":"Arn", - "documentation":"

The Amazon Resource Name (ARN) of the KMS key used to encrypt the memory data.

" - }, - "memoryExecutionRoleArn":{ - "shape":"Arn", - "documentation":"

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the memory to access Amazon Web Services services.

" - }, - "eventExpiryDuration":{ - "shape":"CreateMemoryInputEventExpiryDurationInteger", - "documentation":"

The duration after which memory events expire. Specified as an ISO 8601 duration.

" - }, - "memoryStrategies":{ - "shape":"MemoryStrategyInputList", - "documentation":"

The memory strategies to use for this memory. Strategies define how information is extracted, processed, and consolidated.

" - }, - "indexedKeys":{ - "shape":"IndexedKeysList", - "documentation":"

Metadata keys to index for filtering. Once declared, indexed keys cannot be removed.

" - }, - "streamDeliveryResources":{ - "shape":"StreamDeliveryResources", - "documentation":"

Configuration for streaming memory record data to external resources.

" - }, - "tags":{ - "shape":"TagsMap", - "documentation":"

A map of tag keys and values to assign to an AgentCore Memory. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

" - } - } - }, - "CreateMemoryInputClientTokenString":{ - "type":"string", - "max":500, - "min":0 - }, - "CreateMemoryInputEventExpiryDurationInteger":{ - "type":"integer", - "box":true, - "max":365, - "min":3 - }, - "CreateMemoryOutput":{ - "type":"structure", - "members":{ - "memory":{ - "shape":"Memory", - "documentation":"

The details of the created memory, including its ID, ARN, name, description, and configuration settings.

" - } - } - }, - "CreateOauth2CredentialProviderRequest":{ - "type":"structure", - "required":[ - "name", - "credentialProviderVendor", - "oauth2ProviderConfigInput" - ], - "members":{ - "name":{ - "shape":"CredentialProviderName", - "documentation":"

The name of the OAuth2 credential provider. The name must be unique within your account.

" - }, - "credentialProviderVendor":{ - "shape":"CredentialProviderVendorType", - "documentation":"

The vendor of the OAuth2 credential provider. This specifies which OAuth2 implementation to use.

" - }, - "oauth2ProviderConfigInput":{ - "shape":"Oauth2ProviderConfigInput", - "documentation":"

The configuration settings for the OAuth2 provider, including client ID, client secret, and other vendor-specific settings.

" - }, - "tags":{ - "shape":"TagsMap", - "documentation":"

A map of tag keys and values to assign to the OAuth2 credential provider. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

" - } - } - }, - "CreateOauth2CredentialProviderResponse":{ - "type":"structure", - "required":[ - "clientSecretArn", - "name", - "credentialProviderArn" - ], - "members":{ - "clientSecretArn":{ - "shape":"Secret", - "documentation":"

The Amazon Resource Name (ARN) of the client secret in Amazon Web Services Secrets Manager.

" - }, - "clientSecretJsonKey":{ - "shape":"SecretJsonKeyType", - "documentation":"

The JSON key used to extract the client secret value from the Amazon Web Services Secrets Manager secret.

" - }, - "clientSecretSource":{ - "shape":"SecretSourceType", - "documentation":"

The source type of the client secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager.

" - }, - "name":{ - "shape":"CredentialProviderName", - "documentation":"

The name of the OAuth2 credential provider.

" - }, - "credentialProviderArn":{ - "shape":"CredentialProviderArnType", - "documentation":"

The Amazon Resource Name (ARN) of the OAuth2 credential provider.

" - }, - "callbackUrl":{ - "shape":"String", - "documentation":"

Callback URL to register on the OAuth2 credential provider as an allowed callback URL. This URL is where the OAuth2 authorization server redirects users after they complete the authorization flow.

" - }, - "oauth2ProviderConfigOutput":{"shape":"Oauth2ProviderConfigOutput"}, - "status":{ - "shape":"Status", - "documentation":"

The current status of the OAuth2 credential provider.

" - } - } - }, - "CreateOnlineEvaluationConfigRequest":{ - "type":"structure", - "required":[ - "onlineEvaluationConfigName", - "rule", - "dataSourceConfig", - "evaluationExecutionRoleArn", - "enableOnCreate" - ], - "members":{ - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "idempotencyToken":true - }, - "onlineEvaluationConfigName":{ - "shape":"EvaluationConfigName", - "documentation":"

The name of the online evaluation configuration. Must be unique within your account.

" - }, - "description":{ - "shape":"EvaluationConfigDescription", - "documentation":"

The description of the online evaluation configuration that explains its monitoring purpose and scope.

" - }, - "rule":{ - "shape":"Rule", - "documentation":"

The evaluation rule that defines sampling configuration, filters, and session detection settings for the online evaluation.

" - }, - "dataSourceConfig":{ - "shape":"DataSourceConfig", - "documentation":"

The data source configuration that specifies CloudWatch log groups and service names to monitor for agent traces.

" - }, - "evaluators":{ - "shape":"EvaluatorList", - "documentation":"

The list of evaluators to apply during online evaluation. Can include both built-in evaluators and custom evaluators created with CreateEvaluator.

" - }, - "insights":{ - "shape":"InsightList", - "documentation":"

The list of insight types to run against agent sessions.

" - }, - "clusteringConfig":{ - "shape":"ClusteringConfig", - "documentation":"

Configuration for periodic batch evaluation clustering of insight results.

" - }, - "evaluationExecutionRoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the IAM role that grants permissions to read from CloudWatch logs, write evaluation results, and invoke Amazon Bedrock models for evaluation. If the configuration references evaluators encrypted with a customer managed KMS key, this role must also have kms:Decrypt permission on the KMS key. The service validates this permission at configuration creation time. For more information, see Encryption at rest for AgentCore Evaluations.

" - }, - "enableOnCreate":{ - "shape":"Boolean", - "documentation":"

Whether to enable the online evaluation configuration immediately upon creation. If true, evaluation begins automatically.

" - }, - "tags":{ - "shape":"TagsMap", - "documentation":"

A map of tag keys and values to assign to an AgentCore Online Evaluation Config. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

" - } - } - }, - "CreateOnlineEvaluationConfigResponse":{ - "type":"structure", - "required":[ - "onlineEvaluationConfigArn", - "onlineEvaluationConfigId", - "createdAt", - "status", - "executionStatus" - ], - "members":{ - "onlineEvaluationConfigArn":{ - "shape":"OnlineEvaluationConfigArn", - "documentation":"

The Amazon Resource Name (ARN) of the created online evaluation configuration.

" - }, - "onlineEvaluationConfigId":{ - "shape":"OnlineEvaluationConfigId", - "documentation":"

The unique identifier of the created online evaluation configuration.

" - }, - "createdAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the online evaluation configuration was created.

" - }, - "outputConfig":{"shape":"OutputConfig"}, - "status":{ - "shape":"OnlineEvaluationConfigStatus", - "documentation":"

The status of the online evaluation configuration.

" - }, - "executionStatus":{ - "shape":"OnlineEvaluationExecutionStatus", - "documentation":"

The execution status indicating whether the online evaluation is currently running.

" - }, - "failureReason":{ - "shape":"String", - "documentation":"

The reason for failure if the online evaluation configuration creation or execution failed.

" - } - } - }, - "CreatePaymentConnectorRequest":{ - "type":"structure", - "required":[ - "paymentManagerId", - "name", - "type", - "credentialProviderConfigurations" - ], - "members":{ - "paymentManagerId":{ - "shape":"PaymentManagerId", - "documentation":"

The unique identifier of the payment manager to create the connector for.

", - "location":"uri", - "locationName":"paymentManagerId" - }, - "name":{ - "shape":"PaymentConnectorName", - "documentation":"

The name of the payment connector.

" - }, - "description":{ - "shape":"PaymentsDescription", - "documentation":"

A description of the payment connector.

" - }, - "type":{ - "shape":"PaymentConnectorType", - "documentation":"

The type of payment connector, which determines the payment provider integration.

" - }, - "credentialProviderConfigurations":{ - "shape":"CredentialsProviderConfigurations", - "documentation":"

The credential provider configurations for the payment connector. These configurations specify how the connector authenticates with the payment provider.

" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "idempotencyToken":true - } - } - }, - "CreatePaymentConnectorResponse":{ - "type":"structure", - "required":[ - "paymentConnectorId", - "paymentManagerId", - "name", - "type", - "credentialProviderConfigurations", - "createdAt", - "status" - ], - "members":{ - "paymentConnectorId":{ - "shape":"PaymentConnectorId", - "documentation":"

The unique identifier of the created payment connector.

" - }, - "paymentManagerId":{ - "shape":"PaymentManagerId", - "documentation":"

The unique identifier of the parent payment manager.

" - }, - "name":{ - "shape":"PaymentConnectorName", - "documentation":"

The name of the created payment connector.

" - }, - "type":{ - "shape":"PaymentConnectorType", - "documentation":"

The type of the created payment connector.

" - }, - "credentialProviderConfigurations":{ - "shape":"CredentialsProviderConfigurations", - "documentation":"

The credential provider configurations for the created payment connector.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the payment connector was created.

" - }, - "status":{ - "shape":"PaymentConnectorStatus", - "documentation":"

The current status of the payment connector. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.

" - } - } - }, - "CreatePaymentCredentialProviderRequest":{ - "type":"structure", - "required":[ - "name", - "credentialProviderVendor", - "providerConfigurationInput" - ], - "members":{ - "name":{ - "shape":"CredentialProviderName", - "documentation":"

Unique name for the payment credential provider.

" - }, - "credentialProviderVendor":{ - "shape":"PaymentCredentialProviderVendorType", - "documentation":"

The vendor type for the payment credential provider (e.g., CoinbaseCDP, StripePrivy).

" - }, - "providerConfigurationInput":{ - "shape":"PaymentProviderConfigurationInput", - "documentation":"

Configuration specific to the vendor, including API credentials.

" - }, - "tags":{ - "shape":"TagsMap", - "documentation":"

Optional tags for resource organization.

" - } - } - }, - "CreatePaymentCredentialProviderResponse":{ - "type":"structure", - "required":[ - "name", - "credentialProviderVendor", - "credentialProviderArn", - "providerConfigurationOutput" - ], - "members":{ - "name":{ - "shape":"CredentialProviderName", - "documentation":"

The name of the created payment credential provider.

" - }, - "credentialProviderVendor":{ - "shape":"PaymentCredentialProviderVendorType", - "documentation":"

The vendor type for the created payment credential provider.

" - }, - "credentialProviderArn":{ - "shape":"PaymentCredentialProviderArnType", - "documentation":"

The Amazon Resource Name (ARN) of the created payment credential provider.

" - }, - "providerConfigurationOutput":{ - "shape":"PaymentProviderConfigurationOutput", - "documentation":"

Output configuration (contains secret ARNs, excludes actual secret values).

" - } - } - }, - "CreatePaymentManagerRequest":{ - "type":"structure", - "required":[ - "name", - "authorizerType", - "roleArn" - ], - "members":{ - "name":{ - "shape":"PaymentManagerName", - "documentation":"

The name of the payment manager.

" - }, - "description":{ - "shape":"PaymentsDescription", - "documentation":"

A description of the payment manager.

" - }, - "authorizerType":{ - "shape":"PaymentsAuthorizerType", - "documentation":"

The type of authorizer to use for the payment manager.

  • CUSTOM_JWT - Authorize with a bearer token.

  • AWS_IAM - Authorize with your Amazon Web Services IAM credentials.

" - }, - "authorizerConfiguration":{ - "shape":"AuthorizerConfiguration", - "documentation":"

The authorizer configuration for the payment manager.

" - }, - "roleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the IAM role that the payment manager assumes to access resources on your behalf.

" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "idempotencyToken":true - }, - "tags":{ - "shape":"TagsMap", - "documentation":"

A map of tag keys and values to assign to the payment manager.

" - } - } - }, - "CreatePaymentManagerResponse":{ - "type":"structure", - "required":[ - "paymentManagerArn", - "paymentManagerId", - "name", - "authorizerType", - "roleArn", - "createdAt", - "status" - ], - "members":{ - "paymentManagerArn":{ - "shape":"PaymentManagerArn", - "documentation":"

The Amazon Resource Name (ARN) of the created payment manager.

" - }, - "paymentManagerId":{ - "shape":"PaymentManagerId", - "documentation":"

The unique identifier of the created payment manager.

" - }, - "name":{ - "shape":"PaymentManagerName", - "documentation":"

The name of the created payment manager.

" - }, - "authorizerType":{ - "shape":"PaymentsAuthorizerType", - "documentation":"

The type of authorizer for the created payment manager.

" - }, - "authorizerConfiguration":{"shape":"AuthorizerConfiguration"}, - "roleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the IAM role associated with the created payment manager.

" - }, - "workloadIdentityDetails":{"shape":"WorkloadIdentityDetails"}, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the payment manager was created.

" - }, - "status":{ - "shape":"PaymentManagerStatus", - "documentation":"

The current status of the payment manager. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.

" - }, - "tags":{ - "shape":"TagsMap", - "documentation":"

The tags associated with the created payment manager.

" - } - } - }, - "CreatePolicyEngineRequest":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{ - "shape":"PolicyEngineName", - "documentation":"

The customer-assigned immutable name for the policy engine. This name identifies the policy engine and cannot be changed after creation.

" - }, - "description":{ - "shape":"Description", - "documentation":"

A human-readable description of the policy engine's purpose and scope (1-4,096 characters). This helps administrators understand the policy engine's role in the overall governance strategy. Document which Gateway this engine will be associated with, what types of tools or workflows it governs, and the team or service responsible for maintaining it. Clear descriptions are essential when managing multiple policy engines across different services or environments.

" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request with the same client token, the service returns the same response without creating a duplicate policy engine.

", - "idempotencyToken":true - }, - "encryptionKeyArn":{ - "shape":"KmsKeyArn", - "documentation":"

The Amazon Resource Name (ARN) of the KMS key used to encrypt the policy engine data.

" - }, - "tags":{ - "shape":"TagsMap", - "documentation":"

A map of tag keys and values to assign to an AgentCore Policy. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

" - } - } - }, - "CreatePolicyEngineResponse":{ - "type":"structure", - "required":[ - "policyEngineId", - "name", - "createdAt", - "updatedAt", - "policyEngineArn", - "status", - "statusReasons" - ], - "members":{ - "policyEngineId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier for the created policy engine. This system-generated identifier consists of the user name plus a 10-character generated suffix and is used for all subsequent policy engine operations.

" - }, - "name":{ - "shape":"PolicyEngineName", - "documentation":"

The customer-assigned name of the created policy engine. This matches the name provided in the request and serves as the human-readable identifier.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the policy engine was created. This is automatically set by the service and used for auditing and lifecycle management.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the policy engine was last updated. For newly created policy engines, this matches the createdAt timestamp.

" - }, - "policyEngineArn":{ - "shape":"PolicyEngineArn", - "documentation":"

The Amazon Resource Name (ARN) of the created policy engine. This globally unique identifier can be used for cross-service references and IAM policy statements.

" - }, - "status":{ - "shape":"PolicyEngineStatus", - "documentation":"

The current status of the policy engine. A status of ACTIVE indicates the policy engine is ready for use.

" - }, - "encryptionKeyArn":{ - "shape":"KmsKeyArn", - "documentation":"

The Amazon Resource Name (ARN) of the KMS key used to encrypt the policy engine data.

" - }, - "description":{ - "shape":"Description", - "documentation":"

A human-readable description of the policy engine's purpose.

" - }, - "statusReasons":{ - "shape":"PolicyStatusReasons", - "documentation":"

Additional information about the policy engine status. This provides details about any failures or the current state of the policy engine creation process.

" - } - } - }, - "CreatePolicyRequest":{ - "type":"structure", - "required":[ - "name", - "definition", - "policyEngineId" - ], - "members":{ - "name":{ - "shape":"PolicyName", - "documentation":"

The customer-assigned immutable name for the policy. Must be unique within the account. This name is used for policy identification and cannot be changed after creation.

" - }, - "definition":{ - "shape":"PolicyDefinition", - "documentation":"

The Cedar policy statement that defines the access control rules. This contains the actual policy logic written in Cedar policy language, specifying effect (permit or forbid), principals, actions, resources, and conditions for agent behavior control.

" - }, - "description":{ - "shape":"Description", - "documentation":"

A human-readable description of the policy's purpose and functionality (1-4,096 characters). This helps policy administrators understand the policy's intent, business rules, and operational scope. Use this field to document why the policy exists, what business requirement it addresses, and any special considerations for maintenance. Clear descriptions are essential for policy governance, auditing, and troubleshooting.

" - }, - "validationMode":{ - "shape":"PolicyValidationMode", - "documentation":"

The validation mode for the policy creation. Determines how Cedar analyzer validation results are handled during policy creation. FAIL_ON_ANY_FINDINGS (default) runs the Cedar analyzer to validate the policy against the Cedar schema and tool context, failing creation if the analyzer detects any validation issues to ensure strict conformance. IGNORE_ALL_FINDINGS runs the Cedar analyzer but allows policy creation even if validation issues are detected, useful for testing or when the policy schema is evolving. Use FAIL_ON_ANY_FINDINGS for production policies to ensure correctness, and IGNORE_ALL_FINDINGS only when you understand and accept the analyzer findings.

" - }, - "enforcementMode":{ - "shape":"EnforcementMode", - "documentation":"

The enforcement mode for the policy. Run this policy in LOG_ONLY mode to collect data on how it affects your application. Once you are satisfied with the data gathered, switch the policy to ACTIVE. Defaults to ACTIVE.

" - }, - "policyEngineId":{ - "shape":"ResourceId", - "documentation":"

The identifier of the policy engine which contains this policy. Policy engines group related policies and provide the execution context for policy evaluation.

", - "location":"uri", - "locationName":"policyEngineId" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure the idempotency of the request. The AWS SDK automatically generates this token, so you don't need to provide it in most cases. If you retry a request with the same client token, the service returns the same response without creating a duplicate policy.

", - "idempotencyToken":true - } - } - }, - "CreatePolicyResponse":{ - "type":"structure", - "required":[ - "policyId", - "name", - "policyEngineId", - "createdAt", - "updatedAt", - "policyArn", - "status", - "definition", - "statusReasons" - ], - "members":{ - "policyId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier for the created policy. This is a system-generated identifier consisting of the user name plus a 10-character generated suffix, used for all subsequent policy operations.

" - }, - "name":{ - "shape":"PolicyName", - "documentation":"

The customer-assigned name of the created policy. This matches the name provided in the request and serves as the human-readable identifier for the policy.

" - }, - "policyEngineId":{ - "shape":"ResourceId", - "documentation":"

The identifier of the policy engine that manages this policy. This confirms the policy engine assignment and is used for policy evaluation routing.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the policy was created. This is automatically set by the service and used for auditing and lifecycle management.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the policy was last updated. For newly created policies, this matches the createdAt timestamp.

" - }, - "policyArn":{ - "shape":"PolicyArn", - "documentation":"

The Amazon Resource Name (ARN) of the created policy. This globally unique identifier can be used for cross-service references and IAM policy statements.

" - }, - "status":{ - "shape":"PolicyStatus", - "documentation":"

The current status of the policy. A status of ACTIVE indicates the policy is ready for use.

" - }, - "enforcementMode":{ - "shape":"EnforcementMode", - "documentation":"

The enforcement mode of the created policy.

" - }, - "definition":{ - "shape":"PolicyDefinition", - "documentation":"

The Cedar policy statement that was created. This is the validated policy definition that will be used for agent behavior control and access decisions.

" - }, - "description":{ - "shape":"Description", - "documentation":"

The human-readable description of the policy's purpose and functionality. This helps administrators understand and manage the policy.

" - }, - "statusReasons":{ - "shape":"PolicyStatusReasons", - "documentation":"

Additional information about the policy status. This provides details about any failures or the current state of the policy creation process.

" - } - } - }, - "CreateRegistryRecordRequest":{ - "type":"structure", - "required":[ - "registryId", - "name", - "descriptorType" - ], - "members":{ - "registryId":{ - "shape":"RegistryIdentifier", - "documentation":"

The identifier of the registry where the record will be created. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.

", - "location":"uri", - "locationName":"registryId" - }, - "name":{ - "shape":"RegistryRecordName", - "documentation":"

The name of the registry record.

" - }, - "description":{ - "shape":"Description", - "documentation":"

A description of the registry record.

" - }, - "descriptorType":{ - "shape":"DescriptorType", - "documentation":"

The descriptor type of the registry record.

  • MCP - Model Context Protocol descriptor for MCP-compatible servers and tools.

  • A2A - Agent-to-Agent protocol descriptor.

  • CUSTOM - Custom descriptor type for resources such as APIs, Lambda functions, or servers not conforming to a standard protocol.

  • AGENT_SKILLS - Agent skills descriptor for defining agent skill definitions.

" - }, - "descriptors":{ - "shape":"Descriptors", - "documentation":"

The descriptor-type-specific configuration containing the resource schema and metadata. The structure of this field depends on the descriptorType you specify.

" - }, - "recordVersion":{ - "shape":"RegistryRecordVersion", - "documentation":"

The version of the registry record. Use this to track different versions of the record's content.

" - }, - "synchronizationType":{ - "shape":"SynchronizationType", - "documentation":"

The type of synchronization to use for keeping the record metadata up to date from an external source. Possible values include FROM_URL and NONE.

" - }, - "synchronizationConfiguration":{ - "shape":"SynchronizationConfiguration", - "documentation":"

The configuration for synchronizing registry record metadata from an external source, such as a URL-based MCP server.

" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "idempotencyToken":true - } - } - }, - "CreateRegistryRecordResponse":{ - "type":"structure", - "required":[ - "recordArn", - "status" - ], - "members":{ - "recordArn":{ - "shape":"RegistryRecordArn", - "documentation":"

The Amazon Resource Name (ARN) of the created registry record.

" - }, - "status":{ - "shape":"RegistryRecordStatus", - "documentation":"

The status of the registry record. Set to CREATING while the asynchronous workflow is in progress.

" - } - } - }, - "CreateRegistryRequest":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{ - "shape":"RegistryName", - "documentation":"

The name of the registry. The name must be unique within your account and can contain alphanumeric characters and underscores.

" - }, - "description":{ - "shape":"Description", - "documentation":"

A description of the registry.

" - }, - "authorizerType":{ - "shape":"RegistryAuthorizerType", - "documentation":"

The type of authorizer to use for the registry. This controls the authorization method for the Search and Invoke APIs used by consumers, and does not affect the standard CRUDL APIs for registry and registry record management used by administrators.

  • CUSTOM_JWT - Authorize with a bearer token.

  • AWS_IAM - Authorize with your Amazon Web Services IAM credentials.

" - }, - "authorizerConfiguration":{ - "shape":"AuthorizerConfiguration", - "documentation":"

The authorizer configuration for the registry. Required if authorizerType is CUSTOM_JWT. For details, see the AuthorizerConfiguration data type.

" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "idempotencyToken":true - }, - "approvalConfiguration":{ - "shape":"ApprovalConfiguration", - "documentation":"

The approval configuration for registry records. Controls whether records require explicit approval before becoming active. See the ApprovalConfiguration data type for supported configuration options.

" - } - } - }, - "CreateRegistryResponse":{ - "type":"structure", - "required":["registryArn"], - "members":{ - "registryArn":{ - "shape":"RegistryArn", - "documentation":"

The Amazon Resource Name (ARN) of the created registry.

" - } - } - }, - "CreateWorkloadIdentityRequest":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{ - "shape":"WorkloadIdentityNameType", - "documentation":"

The name of the workload identity. The name must be unique within your account.

" - }, - "allowedResourceOauth2ReturnUrls":{ - "shape":"ResourceOauth2ReturnUrlListType", - "documentation":"

The list of allowed OAuth2 return URLs for resources associated with this workload identity.

" - }, - "tags":{ - "shape":"TagsMap", - "documentation":"

A map of tag keys and values to assign to the workload identity. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

" - } - } - }, - "CreateWorkloadIdentityResponse":{ - "type":"structure", - "required":[ - "name", - "workloadIdentityArn" - ], - "members":{ - "name":{ - "shape":"WorkloadIdentityNameType", - "documentation":"

The name of the workload identity.

" - }, - "workloadIdentityArn":{ - "shape":"WorkloadIdentityArnType", - "documentation":"

The Amazon Resource Name (ARN) of the workload identity.

" - }, - "allowedResourceOauth2ReturnUrls":{ - "shape":"ResourceOauth2ReturnUrlListType", - "documentation":"

The list of allowed OAuth2 return URLs for resources associated with this workload identity.

" - } - } - }, - "CredentialProvider":{ - "type":"structure", - "members":{ - "oauthCredentialProvider":{ - "shape":"OAuthCredentialProvider", - "documentation":"

The OAuth credential provider. This provider uses OAuth authentication to access the target endpoint.

" - }, - "apiKeyCredentialProvider":{ - "shape":"ApiKeyCredentialProvider", - "documentation":"

The API key credential provider. This provider uses an API key to authenticate with the target endpoint.

" - }, - "iamCredentialProvider":{ - "shape":"IamCredentialProvider", - "documentation":"

The IAM credential provider. This provider uses IAM authentication with SigV4 signing to access the target endpoint.

" - } - }, - "documentation":"

A credential provider for gateway authentication. This structure contains the configuration for authenticating with the target endpoint.

", - "union":true - }, - "CredentialProviderArn":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:.*" - }, - "CredentialProviderArnType":{ - "type":"string", - "pattern":"arn:(aws|aws-us-gov):acps:[A-Za-z0-9-]{1,64}:[0-9]{12}:token-vault/[a-zA-Z0-9-.]+/oauth2credentialprovider/[a-zA-Z0-9-.]+" - }, - "CredentialProviderConfiguration":{ - "type":"structure", - "required":["credentialProviderType"], - "members":{ - "credentialProviderType":{ - "shape":"CredentialProviderType", - "documentation":"

The type of credential provider. This field specifies which authentication method the gateway uses.

" - }, - "credentialProvider":{ - "shape":"CredentialProvider", - "documentation":"

The credential provider. This field contains the specific configuration for the credential provider type.

" - } - }, - "documentation":"

The configuration for a credential provider. This structure defines how the gateway authenticates with the target endpoint.

" - }, - "CredentialProviderConfigurations":{ - "type":"list", - "member":{"shape":"CredentialProviderConfiguration"}, - "max":1, - "min":1 - }, - "CredentialProviderName":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[a-zA-Z0-9\\-_]+" - }, - "CredentialProviderType":{ - "type":"string", - "enum":[ - "GATEWAY_IAM_ROLE", - "OAUTH", - "API_KEY", - "CALLER_IAM_CREDENTIALS", - "JWT_PASSTHROUGH" - ] - }, - "CredentialProviderVendorType":{ - "type":"string", - "enum":[ - "GoogleOauth2", - "GithubOauth2", - "SlackOauth2", - "SalesforceOauth2", - "MicrosoftOauth2", - "CustomOauth2", - "AtlassianOauth2", - "LinkedinOauth2", - "XOauth2", - "OktaOauth2", - "OneLoginOauth2", - "PingOneOauth2", - "FacebookOauth2", - "YandexOauth2", - "RedditOauth2", - "ZoomOauth2", - "TwitchOauth2", - "SpotifyOauth2", - "DropboxOauth2", - "NotionOauth2", - "HubspotOauth2", - "CyberArkOauth2", - "FusionAuthOauth2", - "Auth0Oauth2", - "CognitoOauth2" - ] - }, - "CredentialsProviderConfiguration":{ - "type":"structure", - "members":{ - "coinbaseCDP":{ - "shape":"PaymentCredentialProviderConfiguration", - "documentation":"

The credential provider configuration for a Coinbase CDP payment connector.

" - }, - "stripePrivy":{ - "shape":"PaymentCredentialProviderConfiguration", - "documentation":"

The credential provider configuration for a Stripe Privy payment connector.

" - } - }, - "documentation":"

The credential provider configuration for a payment connector. Specifies the payment provider type and its associated credential provider.

", - "union":true - }, - "CredentialsProviderConfigurations":{ - "type":"list", - "member":{"shape":"CredentialsProviderConfiguration"}, - "max":1, - "min":1 - }, - "CustomClaimValidationType":{ - "type":"structure", - "required":[ - "inboundTokenClaimName", - "inboundTokenClaimValueType", - "authorizingClaimMatchValue" - ], - "members":{ - "inboundTokenClaimName":{ - "shape":"InboundTokenClaimNameType", - "documentation":"

The name of the custom claim field to check.

" - }, - "inboundTokenClaimValueType":{ - "shape":"InboundTokenClaimValueType", - "documentation":"

The data type of the claim value to check for.

  • Use STRING if you want to find an exact match to a string you define.

  • Use STRING_ARRAY if you want to fnd a match to at least one value in an array you define.

" - }, - "authorizingClaimMatchValue":{ - "shape":"AuthorizingClaimMatchValueType", - "documentation":"

Defines the value or values to match for and the relationship of the match.

" - } - }, - "documentation":"

Defines the name of a custom claim field and rules for finding matches to authenticate its value.

" - }, - "CustomClaimValidationsType":{ - "type":"list", - "member":{"shape":"CustomClaimValidationType"}, - "min":1 - }, - "CustomConfigurationInput":{ - "type":"structure", - "members":{ - "semanticOverride":{ - "shape":"SemanticOverrideConfigurationInput", - "documentation":"

The semantic override configuration for a custom memory strategy.

" - }, - "summaryOverride":{ - "shape":"SummaryOverrideConfigurationInput", - "documentation":"

The summary override configuration for a custom memory strategy.

" - }, - "userPreferenceOverride":{ - "shape":"UserPreferenceOverrideConfigurationInput", - "documentation":"

The user preference override configuration for a custom memory strategy.

" - }, - "episodicOverride":{ - "shape":"EpisodicOverrideConfigurationInput", - "documentation":"

The episodic memory strategy override configuration for a custom memory strategy.

" - }, - "selfManagedConfiguration":{ - "shape":"SelfManagedConfigurationInput", - "documentation":"

The self managed configuration for a custom memory strategy.

" - } - }, - "documentation":"

Input for custom configuration of a memory strategy.

", - "union":true - }, - "CustomConsolidationConfiguration":{ - "type":"structure", - "members":{ - "semanticConsolidationOverride":{ - "shape":"SemanticConsolidationOverride", - "documentation":"

The semantic consolidation override configuration.

" - }, - "summaryConsolidationOverride":{ - "shape":"SummaryConsolidationOverride", - "documentation":"

The summary consolidation override configuration.

" - }, - "userPreferenceConsolidationOverride":{ - "shape":"UserPreferenceConsolidationOverride", - "documentation":"

The user preference consolidation override configuration.

" - }, - "episodicConsolidationOverride":{ - "shape":"EpisodicConsolidationOverride", - "documentation":"

The configurations to override the default consolidation step for the episodic memory strategy.

" - } - }, - "documentation":"

Contains custom consolidation configuration information.

", - "union":true - }, - "CustomConsolidationConfigurationInput":{ - "type":"structure", - "members":{ - "semanticConsolidationOverride":{ - "shape":"SemanticOverrideConsolidationConfigurationInput", - "documentation":"

The semantic consolidation override configuration input.

" - }, - "summaryConsolidationOverride":{ - "shape":"SummaryOverrideConsolidationConfigurationInput", - "documentation":"

The summary consolidation override configuration input.

" - }, - "userPreferenceConsolidationOverride":{ - "shape":"UserPreferenceOverrideConsolidationConfigurationInput", - "documentation":"

The user preference consolidation override configuration input.

" - }, - "episodicConsolidationOverride":{ - "shape":"EpisodicOverrideConsolidationConfigurationInput", - "documentation":"

Configurations to override the consolidation step of the episodic strategy.

" - } - }, - "documentation":"

Input for a custom consolidation configuration.

", - "union":true - }, - "CustomDescriptor":{ - "type":"structure", - "members":{ - "inlineContent":{ - "shape":"InlineContent", - "documentation":"

The custom descriptor content as a valid JSON document. You can define any custom schema that describes your resource.

" - } - }, - "documentation":"

A custom descriptor for a registry record. Use this for resources such as APIs, Lambda functions, or servers that do not conform to a standard protocol like MCP or A2A.

" - }, - "CustomEvaluatorArn":{ - "type":"string", - "pattern":"arn:aws[a-zA-Z-]*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:evaluator\\/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}" - }, - "CustomEvaluatorName":{ - "type":"string", - "pattern":"[a-zA-Z][a-zA-Z0-9_]{0,47}" - }, - "CustomExtractionConfiguration":{ - "type":"structure", - "members":{ - "semanticExtractionOverride":{ - "shape":"SemanticExtractionOverride", - "documentation":"

The semantic extraction override configuration.

" - }, - "userPreferenceExtractionOverride":{ - "shape":"UserPreferenceExtractionOverride", - "documentation":"

The user preference extraction override configuration.

" - }, - "episodicExtractionOverride":{ - "shape":"EpisodicExtractionOverride", - "documentation":"

The configurations to override the default extraction step for the episodic memory strategy.

" - } - }, - "documentation":"

Contains custom extraction configuration information.

", - "union":true - }, - "CustomExtractionConfigurationInput":{ - "type":"structure", - "members":{ - "semanticExtractionOverride":{ - "shape":"SemanticOverrideExtractionConfigurationInput", - "documentation":"

The semantic extraction override configuration input.

" - }, - "userPreferenceExtractionOverride":{ - "shape":"UserPreferenceOverrideExtractionConfigurationInput", - "documentation":"

The user preference extraction override configuration input.

" - }, - "episodicExtractionOverride":{ - "shape":"EpisodicOverrideExtractionConfigurationInput", - "documentation":"

Configurations to override the extraction step of the episodic strategy.

" - } - }, - "documentation":"

Input for a custom extraction configuration.

", - "union":true - }, - "CustomJWTAuthorizerConfiguration":{ - "type":"structure", - "required":["discoveryUrl"], - "members":{ - "discoveryUrl":{ - "shape":"DiscoveryUrl", - "documentation":"

This URL is used to fetch OpenID Connect configuration or authorization server metadata for validating incoming tokens.

" - }, - "allowedAudience":{ - "shape":"AllowedAudienceList", - "documentation":"

Represents individual audience values that are validated in the incoming JWT token validation process.

" - }, - "allowedClients":{ - "shape":"AllowedClientsList", - "documentation":"

Represents individual client IDs that are validated in the incoming JWT token validation process.

" - }, - "allowedScopes":{ - "shape":"AllowedScopesType", - "documentation":"

An array of scopes that are allowed to access the token.

" - }, - "advertisedScopeMapping":{ - "shape":"AdvertisedScopeMappingType", - "documentation":"

A map that associates each scope in allowedScopes with a corresponding advertised scope value. The advertised scope appears in OAuth protected resource metadata and WWW-Authenticate response headers. Use this parameter when the scope that clients request from your identity provider differs from the scope in the validated token. Each key is a scope from allowedScopes that the service uses for token validation. Each value is the corresponding scope that the service advertises to clients. Scopes without a mapping entry appear unchanged to clients.

" - }, - "customClaims":{ - "shape":"CustomClaimValidationsType", - "documentation":"

An array of objects that define a custom claim validation name, value, and operation

" - }, - "privateEndpoint":{"shape":"PrivateEndpoint"}, - "privateEndpointOverrides":{ - "shape":"PrivateEndpointOverrides", - "documentation":"

The private endpoint overrides for the custom JWT authorizer configuration.

" - }, - "allowedWorkloadConfiguration":{ - "shape":"AllowedWorkloadConfiguration", - "documentation":"

The configuration that restricts which workloads in the request's identity chain are allowed to invoke the target, identified by their hosting environments and workload identities. At launch, this is supported only for AgentCore Runtime targets, and the allowed workloads are AgentCore Gateways.

" - } - }, - "documentation":"

Configuration for inbound JWT-based authorization, specifying how incoming requests should be authenticated.

" - }, - "CustomMemoryStrategyInput":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{ - "shape":"Name", - "documentation":"

The name of the custom memory strategy.

" - }, - "description":{ - "shape":"Description", - "documentation":"

The description of the custom memory strategy.

" - }, - "namespaces":{ - "shape":"NamespacesList", - "documentation":"

This is a legacy parameter, use namespaceTemplates. The namespaces associated with the custom memory strategy.

", - "deprecated":true, - "deprecatedMessage":"Use namespaceTemplates instead", - "deprecatedSince":"2026-03-02" - }, - "namespaceTemplates":{ - "shape":"NamespacesList", - "documentation":"

The namespaceTemplates associated with the custom memory strategy.

" - }, - "configuration":{ - "shape":"CustomConfigurationInput", - "documentation":"

The configuration for the custom memory strategy.

" - }, - "memoryRecordSchema":{ - "shape":"MemoryRecordSchema", - "documentation":"

Schema for metadata fields on records generated by this strategy.

" - } - }, - "documentation":"

Input for creating a custom memory strategy.

" - }, - "CustomOauth2ProviderConfigInput":{ - "type":"structure", - "required":["oauthDiscovery"], - "members":{ - "oauthDiscovery":{ - "shape":"Oauth2Discovery", - "documentation":"

The OAuth2 discovery information for the custom provider.

" - }, - "clientId":{ - "shape":"DefaultClientIdType", - "documentation":"

The client ID for the custom OAuth2 provider.

" - }, - "clientSecret":{ - "shape":"DefaultClientSecretType", - "documentation":"

The client secret for the custom OAuth2 provider.

" - }, - "clientSecretConfig":{ - "shape":"SecretReference", - "documentation":"

A reference to the Amazon Web Services Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when clientSecretSource is set to EXTERNAL.

" - }, - "clientSecretSource":{ - "shape":"SecretSourceType", - "documentation":"

The source type of the client secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.

" - }, - "onBehalfOfTokenExchangeConfig":{ - "shape":"OnBehalfOfTokenExchangeConfigType", - "documentation":"

The configuration for on-behalf-of token exchange. This enables authentication flows that use RFC 8693 token exchange or RFC 7523 JWT authorization grants.

" - }, - "clientAuthenticationMethod":{ - "shape":"ClientAuthenticationMethodType", - "documentation":"

The client authentication method to use when authenticating with the token endpoint.

" - }, - "privateKeyJwtConfig":{"shape":"PrivateKeyJwtConfig"}, - "privateEndpoint":{ - "shape":"PrivateEndpoint", - "documentation":"

The default private endpoint for the custom OAuth2 provider, enabling secure connectivity through a VPC Lattice resource configuration.

" - }, - "privateEndpointOverrides":{ - "shape":"PrivateEndpointOverrides", - "documentation":"

The private endpoint overrides for the custom OAuth2 provider configuration.

" - } - }, - "documentation":"

Input configuration for a custom OAuth2 provider.

" - }, - "CustomOauth2ProviderConfigOutput":{ - "type":"structure", - "required":["oauthDiscovery"], - "members":{ - "oauthDiscovery":{ - "shape":"Oauth2Discovery", - "documentation":"

The OAuth2 discovery information for the custom provider.

" - }, - "clientId":{ - "shape":"ClientIdType", - "documentation":"

The client ID for the custom OAuth2 provider.

" - }, - "onBehalfOfTokenExchangeConfig":{ - "shape":"OnBehalfOfTokenExchangeConfigType", - "documentation":"

The configuration for on-behalf-of token exchange.

" - }, - "clientAuthenticationMethod":{ - "shape":"ClientAuthenticationMethodType", - "documentation":"

The client authentication method used when authenticating with the token endpoint.

" - }, - "privateEndpoint":{ - "shape":"PrivateEndpoint", - "documentation":"

The default private endpoint for the custom OAuth2 provider, enabling secure connectivity through a VPC Lattice resource configuration.

" - }, - "privateEndpointOverrides":{ - "shape":"PrivateEndpointOverrides", - "documentation":"

The private endpoint overrides for the custom OAuth2 provider configuration.

" - }, - "privateKeyJwtConfig":{"shape":"PrivateKeyJwtConfig"} - }, - "documentation":"

Output configuration for a custom OAuth2 provider.

" - }, - "CustomParameterMap":{ - "type":"map", - "key":{"shape":"String"}, - "value":{"shape":"String"} - }, - "CustomReflectionConfiguration":{ - "type":"structure", - "members":{ - "episodicReflectionOverride":{ - "shape":"EpisodicReflectionOverride", - "documentation":"

The configuration for a reflection strategy to override the default one.

" - } - }, - "documentation":"

Contains configurations for a custom reflection strategy.

", - "union":true - }, - "CustomReflectionConfigurationInput":{ - "type":"structure", - "members":{ - "episodicReflectionOverride":{ - "shape":"EpisodicOverrideReflectionConfigurationInput", - "documentation":"

The reflection override configuration input.

" - } - }, - "documentation":"

Input for a custom reflection configuration.

", - "union":true - }, - "CustomTransformConfiguration":{ - "type":"structure", - "members":{ - "lambda":{ - "shape":"LambdaTransformConfiguration", - "documentation":"

The Lambda configuration for custom transformations. This configuration defines how the gateway uses a Lambda function to transform data.

" - } - }, - "documentation":"

The configuration for custom transformations applied to requests and responses through the gateway. This structure defines how the gateway transforms data.

" - }, - "DataSourceConfig":{ - "type":"structure", - "members":{ - "cloudWatchLogs":{ - "shape":"CloudWatchLogsInputConfig", - "documentation":"

The CloudWatch logs configuration for reading agent traces from log groups.

" - } - }, - "documentation":"

The configuration that specifies where to read agent traces for online evaluation.

", - "union":true - }, - "DataSourceType":{ - "type":"structure", - "members":{ - "inlineExamples":{ - "shape":"InlineExamplesSource", - "documentation":"

Inline examples provided directly in the request body.

" - }, - "s3Source":{ - "shape":"S3Source", - "documentation":"

Amazon S3 URI pointing to a JSONL file in the customer's bucket.

" - } - }, - "documentation":"

Source of examples to add to the dataset.

", - "union":true - }, - "DatasetArn":{ - "type":"string", - "pattern":"arn:aws(-[a-z]+)*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:dataset/[a-zA-Z0-9_-]{1,110}" - }, - "DatasetExampleList":{ - "type":"list", - "member":{"shape":"SensitiveJson"}, - "documentation":"

A list of dataset examples. Each element is a free-form JSON document whose structure is defined by the dataset's schema type.

" - }, - "DatasetId":{ - "type":"string", - "pattern":"[a-zA-Z0-9_-]{1,110}" - }, - "DatasetName":{ - "type":"string", - "pattern":"[a-zA-Z][a-zA-Z0-9_]{0,47}" - }, - "DatasetSchemaType":{ - "type":"string", - "documentation":"

Versioned schema type for dataset examples. Each value identifies both the source format and the version of that format's schema.

", - "enum":[ - "AGENTCORE_EVALUATION_PREDEFINED_V1", - "AGENTCORE_EVALUATION_SIMULATED_V1" - ] - }, - "DatasetStatus":{ - "type":"string", - "documentation":"

Dataset lifecycle and operation status.

", - "enum":[ - "CREATING", - "UPDATING", - "DELETING", - "ACTIVE", - "CREATE_FAILED", - "UPDATE_FAILED", - "DELETE_FAILED" - ] - }, - "DatasetSummary":{ - "type":"structure", - "required":[ - "datasetArn", - "datasetId", - "datasetName", - "status", - "schemaType", - "exampleCount", - "createdAt", - "updatedAt" - ], - "members":{ - "datasetArn":{ - "shape":"DatasetArn", - "documentation":"

The Amazon Resource Name (ARN) of the dataset.

" - }, - "datasetId":{ - "shape":"DatasetId", - "documentation":"

The unique identifier of the dataset.

" - }, - "datasetName":{ - "shape":"DatasetName", - "documentation":"

The name of the dataset.

" - }, - "description":{ - "shape":"String", - "documentation":"

The description of the dataset.

" - }, - "status":{ - "shape":"DatasetStatus", - "documentation":"

The current status of the dataset.

" - }, - "draftStatus":{ - "shape":"DraftStatus", - "documentation":"

Publish synchronization state. Only authoritative when status is ACTIVE.

" - }, - "schemaType":{ - "shape":"DatasetSchemaType", - "documentation":"

The schema type of the dataset.

" - }, - "exampleCount":{ - "shape":"Long", - "documentation":"

The number of examples in the dataset.

" - }, - "createdAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the dataset was created.

" - }, - "updatedAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the dataset was last updated.

" - } - }, - "documentation":"

Summary information about a dataset.

" - }, - "DatasetSummaryList":{ - "type":"list", - "member":{"shape":"DatasetSummary"} - }, - "DatasetVersion":{ - "type":"string", - "documentation":"

Dataset version identifier. Accepts \"DRAFT\" or a non-negative integer string representing a published version number.

", - "pattern":"(DRAFT|[0-9]+)" - }, - "DatasetVersionSummary":{ - "type":"structure", - "required":[ - "datasetVersion", - "exampleCount", - "createdAt" - ], - "members":{ - "datasetVersion":{ - "shape":"DatasetVersion", - "documentation":"

The version number of this published snapshot.

" - }, - "exampleCount":{ - "shape":"Long", - "documentation":"

The number of examples in this version.

" - }, - "createdAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when this version was published.

" - } - }, - "documentation":"

Summary information about a published dataset version.

" - }, - "DatasetVersionSummaryList":{ - "type":"list", - "member":{"shape":"DatasetVersionSummary"} - }, - "DateTimestamp":{ - "type":"timestamp", - "timestampFormat":"iso8601" - }, - "DecryptionFailure":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"} - }, - "documentation":"

Exception thrown when decryption of a secret fails.

", - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "DefaultApiKeyType":{ - "type":"string", - "max":65536, - "min":0, - "sensitive":true - }, - "DefaultClientIdType":{ - "type":"string", - "max":256, - "min":0 - }, - "DefaultClientSecretType":{ - "type":"string", - "max":2048, - "min":0, - "sensitive":true - }, - "DefaultCoinbaseCdpApiKeySecretType":{ - "type":"string", - "max":2048, - "min":0, - "pattern":"[a-zA-Z0-9+/=\\-_\\s]*", - "sensitive":true - }, - "DefaultCoinbaseCdpWalletSecretType":{ - "type":"string", - "max":2048, - "min":0, - "pattern":"[a-zA-Z0-9+/=\\-_\\s]*", - "sensitive":true - }, - "DefaultStripePrivyAppSecretType":{ - "type":"string", - "max":2048, - "min":0, - "pattern":"[a-zA-Z0-9+/=\\-_\\s]*", - "sensitive":true - }, - "DefaultStripePrivyAuthorizationPrivateKeyType":{ - "type":"string", - "max":2048, - "min":0, - "pattern":"(wallet-auth:)?[a-zA-Z0-9+/=\\-_\\s]*", - "sensitive":true - }, - "Definition":{ - "type":"string", - "max":1000, - "min":1, - "sensitive":true - }, - "DeleteAgentRuntimeEndpointRequest":{ - "type":"structure", - "required":[ - "agentRuntimeId", - "endpointName" - ], - "members":{ - "agentRuntimeId":{ - "shape":"AgentRuntimeId", - "documentation":"

The unique identifier of the AgentCore Runtime associated with the endpoint.

", - "location":"uri", - "locationName":"agentRuntimeId" - }, - "endpointName":{ - "shape":"EndpointName", - "documentation":"

The name of the AgentCore Runtime endpoint to delete.

", - "location":"uri", - "locationName":"endpointName" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure idempotency of the request.

", - "idempotencyToken":true, - "location":"querystring", - "locationName":"clientToken" - } - } - }, - "DeleteAgentRuntimeEndpointResponse":{ - "type":"structure", - "required":["status"], - "members":{ - "status":{ - "shape":"AgentRuntimeEndpointStatus", - "documentation":"

The current status of the AgentCore Runtime endpoint deletion.

" - }, - "agentRuntimeId":{ - "shape":"AgentRuntimeId", - "documentation":"

The unique identifier of the AgentCore Runtime.

" - }, - "endpointName":{ - "shape":"EndpointName", - "documentation":"

The name of the AgentCore Runtime endpoint.

" - } - } - }, - "DeleteAgentRuntimeRequest":{ - "type":"structure", - "required":["agentRuntimeId"], - "members":{ - "agentRuntimeId":{ - "shape":"AgentRuntimeId", - "documentation":"

The unique identifier of the AgentCore Runtime to delete.

", - "location":"uri", - "locationName":"agentRuntimeId" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request but does not return an error.

", - "idempotencyToken":true, - "location":"querystring", - "locationName":"clientToken" - } - } - }, - "DeleteAgentRuntimeResponse":{ - "type":"structure", - "required":["status"], - "members":{ - "status":{ - "shape":"AgentRuntimeStatus", - "documentation":"

The current status of the AgentCore Runtime deletion.

" - }, - "agentRuntimeId":{ - "shape":"AgentRuntimeId", - "documentation":"

The unique identifier of the AgentCore Runtime.

" - } - } - }, - "DeleteApiKeyCredentialProviderRequest":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{ - "shape":"CredentialProviderName", - "documentation":"

The name of the API key credential provider to delete.

" - } - } - }, - "DeleteApiKeyCredentialProviderResponse":{ - "type":"structure", - "members":{} - }, - "DeleteBrowserProfileRequest":{ - "type":"structure", - "required":["profileId"], - "members":{ - "profileId":{ - "shape":"BrowserProfileId", - "documentation":"

The unique identifier of the browser profile to delete.

", - "location":"uri", - "locationName":"profileId" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure idempotency of the request.

", - "idempotencyToken":true, - "location":"querystring", - "locationName":"clientToken" - } - } - }, - "DeleteBrowserProfileResponse":{ - "type":"structure", - "required":[ - "profileId", - "profileArn", - "status", - "lastUpdatedAt" - ], - "members":{ - "profileId":{ - "shape":"BrowserProfileId", - "documentation":"

The unique identifier of the deleted browser profile.

" - }, - "profileArn":{ - "shape":"BrowserProfileArn", - "documentation":"

The Amazon Resource Name (ARN) of the deleted browser profile.

" - }, - "status":{ - "shape":"BrowserProfileStatus", - "documentation":"

The current status of the browser profile deletion.

" - }, - "lastUpdatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the browser profile was last updated.

" - }, - "lastSavedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when browser session data was last saved to this profile before deletion.

" - } - } - }, - "DeleteBrowserRequest":{ - "type":"structure", - "required":["browserId"], - "members":{ - "browserId":{ - "shape":"BrowserId", - "documentation":"

The unique identifier of the browser to delete.

", - "location":"uri", - "locationName":"browserId" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure idempotency of the request.

", - "idempotencyToken":true, - "location":"querystring", - "locationName":"clientToken" - } - } - }, - "DeleteBrowserResponse":{ - "type":"structure", - "required":[ - "browserId", - "status", - "lastUpdatedAt" - ], - "members":{ - "browserId":{ - "shape":"BrowserId", - "documentation":"

The unique identifier of the deleted browser.

" - }, - "status":{ - "shape":"BrowserStatus", - "documentation":"

The current status of the browser deletion.

" - }, - "lastUpdatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the browser was last updated.

" - } - } - }, - "DeleteCodeInterpreterRequest":{ - "type":"structure", - "required":["codeInterpreterId"], - "members":{ - "codeInterpreterId":{ - "shape":"CodeInterpreterId", - "documentation":"

The unique identifier of the code interpreter to delete.

", - "location":"uri", - "locationName":"codeInterpreterId" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure idempotency of the request.

", - "idempotencyToken":true, - "location":"querystring", - "locationName":"clientToken" - } - } - }, - "DeleteCodeInterpreterResponse":{ - "type":"structure", - "required":[ - "codeInterpreterId", - "status", - "lastUpdatedAt" - ], - "members":{ - "codeInterpreterId":{ - "shape":"CodeInterpreterId", - "documentation":"

The unique identifier of the deleted code interpreter.

" - }, - "status":{ - "shape":"CodeInterpreterStatus", - "documentation":"

The current status of the code interpreter deletion.

" - }, - "lastUpdatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the code interpreter was last updated.

" - } - } - }, - "DeleteConfigurationBundleRequest":{ - "type":"structure", - "required":["bundleId"], - "members":{ - "bundleId":{ - "shape":"ConfigurationBundleId", - "documentation":"

The unique identifier of the configuration bundle to delete.

", - "location":"uri", - "locationName":"bundleId" - } - } - }, - "DeleteConfigurationBundleResponse":{ - "type":"structure", - "required":[ - "bundleId", - "status" - ], - "members":{ - "bundleId":{ - "shape":"ConfigurationBundleId", - "documentation":"

The unique identifier of the deleted configuration bundle.

" - }, - "status":{ - "shape":"ConfigurationBundleStatus", - "documentation":"

The status of the configuration bundle deletion operation.

" - } - } - }, - "DeleteDatasetExamplesRequest":{ - "type":"structure", - "required":[ - "datasetId", - "exampleIds" - ], - "members":{ - "datasetId":{ - "shape":"DatasetId", - "documentation":"

The unique identifier of the dataset.

", - "location":"uri", - "locationName":"datasetId" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "idempotencyToken":true - }, - "exampleIds":{ - "shape":"DeleteDatasetExamplesRequestExampleIdsList", - "documentation":"

The IDs of the examples to delete.

" - } - } - }, - "DeleteDatasetExamplesRequestExampleIdsList":{ - "type":"list", - "member":{"shape":"ExampleId"}, - "max":1000, - "min":1 - }, - "DeleteDatasetExamplesResponse":{ - "type":"structure", - "required":[ - "datasetArn", - "datasetId", - "status", - "deletedCount", - "updatedAt" - ], - "members":{ - "datasetArn":{ - "shape":"DatasetArn", - "documentation":"

The Amazon Resource Name (ARN) of the dataset.

" - }, - "datasetId":{ - "shape":"DatasetId", - "documentation":"

The unique identifier of the dataset.

" - }, - "status":{ - "shape":"DatasetStatus", - "documentation":"

The current status of the dataset.

" - }, - "deletedCount":{ - "shape":"Long", - "documentation":"

The number of examples deleted.

" - }, - "updatedAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the examples were deleted.

" - } - } - }, - "DeleteDatasetRequest":{ - "type":"structure", - "required":["datasetId"], - "members":{ - "datasetId":{ - "shape":"DatasetId", - "documentation":"

The unique identifier of the dataset to delete.

", - "location":"uri", - "locationName":"datasetId" - }, - "datasetVersion":{ - "shape":"DatasetVersion", - "documentation":"

Optional version to delete. If absent, deletes the entire dataset. If provided, deletes only that specific version.

", - "location":"querystring", - "locationName":"datasetVersion" - } - } - }, - "DeleteDatasetResponse":{ - "type":"structure", - "required":[ - "datasetArn", - "datasetId", - "status", - "datasetVersion", - "updatedAt" - ], - "members":{ - "datasetArn":{ - "shape":"DatasetArn", - "documentation":"

The Amazon Resource Name (ARN) of the dataset.

" - }, - "datasetId":{ - "shape":"DatasetId", - "documentation":"

The unique identifier of the dataset.

" - }, - "status":{ - "shape":"DatasetStatus", - "documentation":"

The current status of the dataset after the delete request.

" - }, - "datasetVersion":{ - "shape":"DatasetVersion", - "documentation":"

The version that was deleted.

" - }, - "updatedAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the delete was initiated.

" - } - } - }, - "DeleteEvaluatorRequest":{ - "type":"structure", - "required":["evaluatorId"], - "members":{ - "evaluatorId":{ - "shape":"EvaluatorId", - "documentation":"

The unique identifier of the evaluator to delete.

", - "location":"uri", - "locationName":"evaluatorId" - } - } - }, - "DeleteEvaluatorResponse":{ - "type":"structure", - "required":[ - "evaluatorArn", - "evaluatorId", - "status" - ], - "members":{ - "evaluatorArn":{ - "shape":"EvaluatorArn", - "documentation":"

The Amazon Resource Name (ARN) of the deleted evaluator.

" - }, - "evaluatorId":{ - "shape":"EvaluatorId", - "documentation":"

The unique identifier of the deleted evaluator.

" - }, - "status":{ - "shape":"EvaluatorStatus", - "documentation":"

The status of the evaluator deletion operation.

" - } - } - }, - "DeleteGatewayRequest":{ - "type":"structure", - "required":["gatewayIdentifier"], - "members":{ - "gatewayIdentifier":{ - "shape":"GatewayIdentifier", - "documentation":"

The identifier of the gateway to delete.

", - "location":"uri", - "locationName":"gatewayIdentifier" - } - } - }, - "DeleteGatewayResponse":{ - "type":"structure", - "required":[ - "gatewayId", - "status" - ], - "members":{ - "gatewayId":{ - "shape":"GatewayId", - "documentation":"

The unique identifier of the deleted gateway.

" - }, - "status":{ - "shape":"GatewayStatus", - "documentation":"

The current status of the gateway deletion.

" - }, - "statusReasons":{ - "shape":"StatusReasons", - "documentation":"

The reasons for the current status of the gateway deletion.

" - } - } - }, - "DeleteGatewayRuleRequest":{ - "type":"structure", - "required":[ - "gatewayIdentifier", - "ruleId" - ], - "members":{ - "gatewayIdentifier":{ - "shape":"GatewayIdentifier", - "documentation":"

The identifier of the gateway containing the rule.

", - "location":"uri", - "locationName":"gatewayIdentifier" - }, - "ruleId":{ - "shape":"GatewayRuleId", - "documentation":"

The unique identifier of the rule to delete.

", - "location":"uri", - "locationName":"ruleId" - } - } - }, - "DeleteGatewayRuleResponse":{ - "type":"structure", - "required":[ - "ruleId", - "status" - ], - "members":{ - "ruleId":{ - "shape":"GatewayRuleId", - "documentation":"

The unique identifier of the deleted rule.

" - }, - "status":{ - "shape":"GatewayRuleStatus", - "documentation":"

The status of the rule deletion operation.

" - } - } - }, - "DeleteGatewayTargetRequest":{ - "type":"structure", - "required":[ - "gatewayIdentifier", - "targetId" - ], - "members":{ - "gatewayIdentifier":{ - "shape":"GatewayIdentifier", - "documentation":"

The unique identifier of the gateway associated with the target.

", - "location":"uri", - "locationName":"gatewayIdentifier" - }, - "targetId":{ - "shape":"TargetId", - "documentation":"

The unique identifier of the gateway target to delete.

", - "location":"uri", - "locationName":"targetId" - } - } - }, - "DeleteGatewayTargetResponse":{ - "type":"structure", - "required":[ - "gatewayArn", - "targetId", - "status" - ], - "members":{ - "gatewayArn":{ - "shape":"GatewayArn", - "documentation":"

The Amazon Resource Name (ARN) of the gateway.

" - }, - "targetId":{ - "shape":"TargetId", - "documentation":"

The unique identifier of the deleted gateway target.

" - }, - "status":{ - "shape":"TargetStatus", - "documentation":"

The current status of the gateway target deletion.

" - }, - "statusReasons":{ - "shape":"StatusReasons", - "documentation":"

The reasons for the current status of the gateway target deletion.

" - } - } - }, - "DeleteHarnessEndpointRequest":{ - "type":"structure", - "required":[ - "harnessId", - "endpointName" - ], - "members":{ - "harnessId":{ - "shape":"HarnessId", - "documentation":"

The ID of the harness that the endpoint belongs to.

", - "location":"uri", - "locationName":"harnessId" - }, - "endpointName":{ - "shape":"HarnessEndpointName", - "documentation":"

The name of the endpoint to delete.

", - "location":"uri", - "locationName":"endpointName" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure idempotency of the request.

", - "idempotencyToken":true, - "location":"querystring", - "locationName":"clientToken" - } - } - }, - "DeleteHarnessEndpointResponse":{ - "type":"structure", - "required":["endpoint"], - "members":{ - "endpoint":{ - "shape":"HarnessEndpoint", - "documentation":"

The endpoint that was deleted.

" - } - } - }, - "DeleteHarnessRequest":{ - "type":"structure", - "required":["harnessId"], - "members":{ - "harnessId":{ - "shape":"HarnessId", - "documentation":"

The ID of the harness to delete.

", - "location":"uri", - "locationName":"harnessId" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure idempotency of the request.

", - "idempotencyToken":true, - "location":"querystring", - "locationName":"clientToken" - }, - "deleteManagedMemory":{ - "shape":"Boolean", - "documentation":"

Whether to delete the managed memory on harness deletion. Default: true. If false, the memory is disassociated and becomes a regular customer-owned resource.

", - "location":"querystring", - "locationName":"deleteManagedMemory" - } - } - }, - "DeleteHarnessResponse":{ - "type":"structure", - "members":{ - "harness":{ - "shape":"Harness", - "documentation":"

The harness that was deleted.

" - } - } - }, - "DeleteMemoryInput":{ - "type":"structure", - "required":["memoryId"], - "members":{ - "clientToken":{ - "shape":"DeleteMemoryInputClientTokenString", - "documentation":"

A client token is used for keeping track of idempotent requests. It can contain a session id which can be around 250 chars, combined with a unique AWS identifier.

", - "idempotencyToken":true, - "location":"querystring", - "locationName":"clientToken" - }, - "memoryId":{ - "shape":"MemoryId", - "documentation":"

The unique identifier of the memory to delete.

", - "location":"uri", - "locationName":"memoryId" - } - } - }, - "DeleteMemoryInputClientTokenString":{ - "type":"string", - "max":500, - "min":0 - }, - "DeleteMemoryOutput":{ - "type":"structure", - "required":["memoryId"], - "members":{ - "memoryId":{ - "shape":"MemoryId", - "documentation":"

The unique identifier of the deleted AgentCore Memory resource.

" - }, - "status":{ - "shape":"MemoryStatus", - "documentation":"

The current status of the AgentCore Memory resource deletion.

" - } - } - }, - "DeleteMemoryStrategiesList":{ - "type":"list", - "member":{"shape":"DeleteMemoryStrategyInput"} - }, - "DeleteMemoryStrategyInput":{ - "type":"structure", - "required":["memoryStrategyId"], - "members":{ - "memoryStrategyId":{ - "shape":"String", - "documentation":"

The unique identifier of the memory strategy to delete.

" - } - }, - "documentation":"

Input for deleting a memory strategy.

" - }, - "DeleteOauth2CredentialProviderRequest":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{ - "shape":"CredentialProviderName", - "documentation":"

The name of the OAuth2 credential provider to delete.

" - } - } - }, - "DeleteOauth2CredentialProviderResponse":{ - "type":"structure", - "members":{} - }, - "DeleteOnlineEvaluationConfigRequest":{ - "type":"structure", - "required":["onlineEvaluationConfigId"], - "members":{ - "onlineEvaluationConfigId":{ - "shape":"OnlineEvaluationConfigId", - "documentation":"

The unique identifier of the online evaluation configuration to delete.

", - "location":"uri", - "locationName":"onlineEvaluationConfigId" - } - } - }, - "DeleteOnlineEvaluationConfigResponse":{ - "type":"structure", - "required":[ - "onlineEvaluationConfigArn", - "onlineEvaluationConfigId", - "status" - ], - "members":{ - "onlineEvaluationConfigArn":{ - "shape":"OnlineEvaluationConfigArn", - "documentation":"

The Amazon Resource Name (ARN) of the deleted online evaluation configuration.

" - }, - "onlineEvaluationConfigId":{ - "shape":"OnlineEvaluationConfigId", - "documentation":"

The unique identifier of the deleted online evaluation configuration.

" - }, - "status":{ - "shape":"OnlineEvaluationConfigStatus", - "documentation":"

The status of the online evaluation configuration deletion operation.

" - } - } - }, - "DeletePaymentConnectorRequest":{ - "type":"structure", - "required":[ - "paymentManagerId", - "paymentConnectorId" - ], - "members":{ - "paymentManagerId":{ - "shape":"PaymentManagerId", - "documentation":"

The unique identifier of the parent payment manager.

", - "location":"uri", - "locationName":"paymentManagerId" - }, - "paymentConnectorId":{ - "shape":"PaymentConnectorId", - "documentation":"

The unique identifier of the payment connector to delete.

", - "location":"uri", - "locationName":"paymentConnectorId" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "idempotencyToken":true, - "location":"querystring", - "locationName":"clientToken" - } - } - }, - "DeletePaymentConnectorResponse":{ - "type":"structure", - "required":["status"], - "members":{ - "status":{ - "shape":"PaymentConnectorStatus", - "documentation":"

The current status of the payment connector, set to DELETING when deletion is initiated. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.

" - }, - "paymentConnectorId":{ - "shape":"PaymentConnectorId", - "documentation":"

The unique identifier of the deleted payment connector.

" - } - } - }, - "DeletePaymentCredentialProviderRequest":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{ - "shape":"CredentialProviderName", - "documentation":"

The name of the payment credential provider to delete.

" - } - } - }, - "DeletePaymentCredentialProviderResponse":{ - "type":"structure", - "members":{} - }, - "DeletePaymentManagerRequest":{ - "type":"structure", - "required":["paymentManagerId"], - "members":{ - "paymentManagerId":{ - "shape":"PaymentManagerId", - "documentation":"

The unique identifier of the payment manager to delete.

", - "location":"uri", - "locationName":"paymentManagerId" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "idempotencyToken":true, - "location":"querystring", - "locationName":"clientToken" - } - } - }, - "DeletePaymentManagerResponse":{ - "type":"structure", - "required":["status"], - "members":{ - "status":{ - "shape":"PaymentManagerStatus", - "documentation":"

The current status of the payment manager, set to DELETING when deletion is initiated. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.

" - }, - "paymentManagerId":{ - "shape":"PaymentManagerId", - "documentation":"

The unique identifier of the deleted payment manager.

" - } - } - }, - "DeletePolicyEngineRequest":{ - "type":"structure", - "required":["policyEngineId"], - "members":{ - "policyEngineId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the policy engine to be deleted. This must be a valid policy engine ID that exists within the account.

", - "location":"uri", - "locationName":"policyEngineId" - } - } - }, - "DeletePolicyEngineResponse":{ - "type":"structure", - "required":[ - "policyEngineId", - "name", - "createdAt", - "updatedAt", - "policyEngineArn", - "status", - "statusReasons" - ], - "members":{ - "policyEngineId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the policy engine being deleted. This confirms which policy engine the deletion operation targets.

" - }, - "name":{ - "shape":"PolicyEngineName", - "documentation":"

The customer-assigned name of the deleted policy engine.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the deleted policy engine was originally created.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the deleted policy engine was last modified before deletion. This tracks the final state of the policy engine before it was removed from the system.

" - }, - "policyEngineArn":{ - "shape":"PolicyEngineArn", - "documentation":"

The Amazon Resource Name (ARN) of the deleted policy engine. This globally unique identifier confirms which policy engine resource was successfully removed.

" - }, - "status":{ - "shape":"PolicyEngineStatus", - "documentation":"

The status of the policy engine deletion operation. This provides status about any issues that occurred during the deletion process.

" - }, - "encryptionKeyArn":{ - "shape":"KmsKeyArn", - "documentation":"

The Amazon Resource Name (ARN) of the KMS key used to encrypt the policy engine data.

" - }, - "description":{ - "shape":"Description", - "documentation":"

The human-readable description of the deleted policy engine.

" - }, - "statusReasons":{ - "shape":"PolicyStatusReasons", - "documentation":"

Additional information about the deletion status. This provides details about the deletion process or any issues that may have occurred.

" - } - } - }, - "DeletePolicyRequest":{ - "type":"structure", - "required":[ - "policyEngineId", - "policyId" - ], - "members":{ - "policyEngineId":{ - "shape":"ResourceId", - "documentation":"

The identifier of the policy engine that manages the policy to be deleted. This ensures the policy is deleted from the correct policy engine context.

", - "location":"uri", - "locationName":"policyEngineId" - }, - "policyId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the policy to be deleted. This must be a valid policy ID that exists within the specified policy engine.

", - "location":"uri", - "locationName":"policyId" - } - } - }, - "DeletePolicyResponse":{ - "type":"structure", - "required":[ - "policyId", - "name", - "policyEngineId", - "createdAt", - "updatedAt", - "policyArn", - "status", - "definition", - "statusReasons" - ], - "members":{ - "policyId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the policy being deleted. This confirms which policy the deletion operation targets.

" - }, - "name":{ - "shape":"PolicyName", - "documentation":"

The customer-assigned name of the deleted policy. This confirms which policy was successfully removed from the system and matches the name that was originally assigned during policy creation.

" - }, - "policyEngineId":{ - "shape":"ResourceId", - "documentation":"

The identifier of the policy engine from which the policy was deleted. This confirms the policy engine context for the deletion operation.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the deleted policy was originally created.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the deleted policy was last modified before deletion. This tracks the final state of the policy before it was removed from the system.

" - }, - "policyArn":{ - "shape":"PolicyArn", - "documentation":"

The Amazon Resource Name (ARN) of the deleted policy. This globally unique identifier confirms which policy resource was successfully removed.

" - }, - "status":{ - "shape":"PolicyStatus", - "documentation":"

The status of the policy deletion operation. This provides information about any issues that occurred during the deletion process.

" - }, - "enforcementMode":{ - "shape":"EnforcementMode", - "documentation":"

The enforcement mode of the deleted policy.

" - }, - "definition":{"shape":"PolicyDefinition"}, - "description":{ - "shape":"Description", - "documentation":"

The human-readable description of the deleted policy.

" - }, - "statusReasons":{ - "shape":"PolicyStatusReasons", - "documentation":"

Additional information about the deletion status. This provides details about the deletion process or any issues that may have occurred.

" - } - } - }, - "DeleteRegistryRecordRequest":{ - "type":"structure", - "required":[ - "registryId", - "recordId" - ], - "members":{ - "registryId":{ - "shape":"RegistryIdentifier", - "documentation":"

The identifier of the registry containing the record. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.

", - "location":"uri", - "locationName":"registryId" - }, - "recordId":{ - "shape":"RecordIdentifier", - "documentation":"

The identifier of the registry record to delete. You can specify either the Amazon Resource Name (ARN) or the ID of the record.

", - "location":"uri", - "locationName":"recordId" - } - } - }, - "DeleteRegistryRecordResponse":{ - "type":"structure", - "members":{} - }, - "DeleteRegistryRequest":{ - "type":"structure", - "required":["registryId"], - "members":{ - "registryId":{ - "shape":"RegistryIdentifier", - "documentation":"

The identifier of the registry to delete. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.

", - "location":"uri", - "locationName":"registryId" - } - } - }, - "DeleteRegistryResponse":{ - "type":"structure", - "required":["status"], - "members":{ - "status":{ - "shape":"RegistryStatus", - "documentation":"

The current status of the registry, set to DELETING when deletion is initiated. For a list of all possible registry statuses, see the RegistryStatus data type.

" - } - } - }, - "DeleteResourcePolicyRequest":{ - "type":"structure", - "required":["resourceArn"], - "members":{ - "resourceArn":{ - "shape":"BedrockAgentcoreResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the resource for which to delete the resource policy.

", - "location":"uri", - "locationName":"resourceArn" - } - } - }, - "DeleteResourcePolicyResponse":{ - "type":"structure", - "members":{} - }, - "DeleteWorkloadIdentityRequest":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{ - "shape":"WorkloadIdentityNameType", - "documentation":"

The name of the workload identity to delete.

" - } - } - }, - "DeleteWorkloadIdentityResponse":{ - "type":"structure", - "members":{} - }, - "Description":{ - "type":"string", - "max":4096, - "min":1, - "sensitive":true - }, - "DescriptorType":{ - "type":"string", - "enum":[ - "MCP", - "A2A", - "CUSTOM", - "AGENT_SKILLS" - ] - }, - "Descriptors":{ - "type":"structure", - "members":{ - "mcp":{ - "shape":"McpDescriptor", - "documentation":"

The Model Context Protocol (MCP) descriptor configuration. Use this when the descriptorType is MCP.

" - }, - "a2a":{ - "shape":"A2aDescriptor", - "documentation":"

The Agent-to-Agent (A2A) protocol descriptor configuration. Use this when the descriptorType is A2A.

" - }, - "custom":{ - "shape":"CustomDescriptor", - "documentation":"

The custom descriptor configuration. Use this when the descriptorType is CUSTOM.

" - }, - "agentSkills":{ - "shape":"AgentSkillsDescriptor", - "documentation":"

The agent skills descriptor configuration. Use this when the descriptorType is AGENT_SKILLS.

" - } - }, - "documentation":"

Contains descriptor-type-specific configurations for a registry record. Only the descriptor matching the record's descriptorType should be populated.

" - }, - "DiscoveryUrl":{ - "type":"string", - "pattern":".+/\\.well-known/openid-configuration" - }, - "DiscoveryUrlType":{ - "type":"string", - "pattern":".+/\\.well-known/(openid-configuration|oauth-authorization-server)" - }, - "Document":{ - "type":"structure", - "members":{}, - "document":true - }, - "DomainName":{"type":"string"}, - "Double":{ - "type":"double", - "box":true - }, - "DownloadUrl":{ - "type":"string", - "sensitive":true - }, - "DraftStatus":{ - "type":"string", - "documentation":"

Publish synchronization state of the DRAFT working copy.

", - "enum":[ - "MODIFIED", - "UNMODIFIED" - ] - }, - "EfsAccessPointArn":{ - "type":"string", - "max":128, - "min":0, - "pattern":"arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:access-point/fsap-[0-9a-f]{8,40}" - }, - "EfsAccessPointConfiguration":{ - "type":"structure", - "required":[ - "accessPointArn", - "mountPath" - ], - "members":{ - "accessPointArn":{ - "shape":"EfsAccessPointArn", - "documentation":"

The ARN of the EFS access point to mount into the AgentCore Runtime.

" - }, - "mountPath":{ - "shape":"MountPath", - "documentation":"

The mount path for the EFS access point inside the AgentCore Runtime. The path must be under /mnt with exactly one subdirectory level (for example, /mnt/data).

" - } - }, - "documentation":"

Configuration for an Amazon EFS access point filesystem mounted into the AgentCore Runtime. EFS access points provide shared file storage accessible from your AgentCore Runtime sessions.

" - }, - "EfsConfiguration":{ - "type":"structure", - "required":[ - "accessPointArn", - "mountPath", - "fileSystemArn" - ], - "members":{ - "accessPointArn":{ - "shape":"EfsAccessPointArn", - "documentation":"

The Amazon Resource Name (ARN) of the Amazon Elastic File System (Amazon EFS) access point to mount.

" - }, - "mountPath":{ - "shape":"MountPath", - "documentation":"

The absolute path within the session at which the access point is mounted, for example /mnt/efs. Each mount path must be unique across all file system configurations in the session.

" - }, - "fileSystemArn":{ - "shape":"EfsFileSystemArn", - "documentation":"

The Amazon Resource Name (ARN) of the Amazon Elastic File System (Amazon EFS) file system that owns the access point.

" - } - }, - "documentation":"

The configuration for mounting an Amazon Elastic File System (Amazon EFS) access point that you own into a session.

" - }, - "EfsFileSystemArn":{ - "type":"string", - "documentation":"

The Amazon Resource Name (ARN) of an Amazon Elastic File System (Amazon EFS) file system. The access points you specify must belong to this file system.

", - "max":256, - "min":0, - "pattern":"arn:aws[-a-z]*:elasticfilesystem:[a-z0-9-]+:[0-9]{12}:file-system/fs-[0-9a-f]{8,40}" - }, - "EnabledConnectors":{ - "type":"list", - "member":{"shape":"String"}, - "max":50, - "min":1 - }, - "EncryptionFailure":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"} - }, - "documentation":"

Exception thrown when encryption of a secret fails.

", - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "EndpointIpAddressType":{ - "type":"string", - "enum":[ - "IPV4", - "IPV6" - ] - }, - "EndpointName":{ - "type":"string", - "pattern":"[a-zA-Z][a-zA-Z0-9_]{0,47}", - "sensitive":true - }, - "EnforcementMode":{ - "type":"string", - "documentation":"

The enforcement mode for a policy. Run this policy in LOG_ONLY mode to collect data on how it affects your application. Once you are satisfied with the data gathered, switch the policy to ACTIVE.

", - "enum":[ - "ACTIVE", - "LOG_ONLY" - ] - }, - "EnvironmentVariableKey":{ - "type":"string", - "max":100, - "min":1 - }, - "EnvironmentVariableValue":{ - "type":"string", - "max":5000, - "min":0 - }, - "EnvironmentVariablesMap":{ - "type":"map", - "key":{"shape":"EnvironmentVariableKey"}, - "value":{"shape":"EnvironmentVariableValue"}, - "max":50, - "min":0, - "sensitive":true - }, - "EpisodicConsolidationOverride":{ - "type":"structure", - "required":[ - "appendToPrompt", - "modelId" - ], - "members":{ - "appendToPrompt":{ - "shape":"Prompt", - "documentation":"

The text appended to the prompt for the consolidation step of the episodic memory strategy.

" - }, - "modelId":{ - "shape":"String", - "documentation":"

The model ID used for the consolidation step of the episodic memory strategy.

" - } - }, - "documentation":"

Contains configurations to override the default consolidation step for the episodic memory strategy.

" - }, - "EpisodicExtractionOverride":{ - "type":"structure", - "required":[ - "appendToPrompt", - "modelId" - ], - "members":{ - "appendToPrompt":{ - "shape":"Prompt", - "documentation":"

The text appended to the prompt for the extraction step of the episodic memory strategy.

" - }, - "modelId":{ - "shape":"String", - "documentation":"

The model ID used for the extraction step of the episodic memory strategy.

" - } - }, - "documentation":"

Contains configurations to override the default extraction step for the episodic memory strategy.

" - }, - "EpisodicMemoryStrategyInput":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{ - "shape":"Name", - "documentation":"

The name of the episodic memory strategy.

" - }, - "description":{ - "shape":"Description", - "documentation":"

The description of the episodic memory strategy.

" - }, - "namespaces":{ - "shape":"NamespacesList", - "documentation":"

This is a legacy parameter, use namespaceTemplates. The namespaces for which to create episodes.

", - "deprecated":true, - "deprecatedMessage":"Use namespaceTemplates instead", - "deprecatedSince":"2026-03-02" - }, - "namespaceTemplates":{ - "shape":"NamespacesList", - "documentation":"

The namespaceTemplates for which to create episodes.

" - }, - "reflectionConfiguration":{ - "shape":"EpisodicReflectionConfigurationInput", - "documentation":"

The configuration for the reflections created with the episodic memory strategy.

" - }, - "memoryRecordSchema":{ - "shape":"MemoryRecordSchema", - "documentation":"

Schema for metadata fields on records generated by this strategy.

" - } - }, - "documentation":"

Input for creating an episodic memory strategy.

" - }, - "EpisodicOverrideConfigurationInput":{ - "type":"structure", - "members":{ - "extraction":{ - "shape":"EpisodicOverrideExtractionConfigurationInput", - "documentation":"

Contains configurations for overriding the extraction step of the episodic memory strategy.

" - }, - "consolidation":{ - "shape":"EpisodicOverrideConsolidationConfigurationInput", - "documentation":"

Contains configurations for overriding the consolidation step of the episodic memory strategy.

" - }, - "reflection":{ - "shape":"EpisodicOverrideReflectionConfigurationInput", - "documentation":"

Contains configurations for overriding the reflection step of the episodic memory strategy.

" - } - }, - "documentation":"

Input for the configuration to override the episodic memory strategy.

" - }, - "EpisodicOverrideConsolidationConfigurationInput":{ - "type":"structure", - "required":[ - "appendToPrompt", - "modelId" - ], - "members":{ - "appendToPrompt":{ - "shape":"Prompt", - "documentation":"

The text to append to the prompt for the consolidation step of the episodic memory strategy.

" - }, - "modelId":{ - "shape":"String", - "documentation":"

The model ID to use for the consolidation step of the episodic memory strategy.

" - } - }, - "documentation":"

Configurations for overriding the consolidation step of the episodic memory strategy.

" - }, - "EpisodicOverrideExtractionConfigurationInput":{ - "type":"structure", - "required":[ - "appendToPrompt", - "modelId" - ], - "members":{ - "appendToPrompt":{ - "shape":"Prompt", - "documentation":"

The text to append to the prompt for the extraction step of the episodic memory strategy.

" - }, - "modelId":{ - "shape":"String", - "documentation":"

The model ID to use for the extraction step of the episodic memory strategy.

" - } - }, - "documentation":"

Configurations for overriding the extraction step of the episodic memory strategy.

" - }, - "EpisodicOverrideReflectionConfigurationInput":{ - "type":"structure", - "required":[ - "appendToPrompt", - "modelId" - ], - "members":{ - "appendToPrompt":{ - "shape":"Prompt", - "documentation":"

The text to append to the prompt for reflection step of the episodic memory strategy.

" - }, - "modelId":{ - "shape":"String", - "documentation":"

The model ID to use for the reflection step of the episodic memory strategy.

" - }, - "namespaces":{ - "shape":"NamespacesList", - "documentation":"

This is a legacy parameter, use namespaceTemplates. The namespaces to use for episodic reflection. Can be less nested than the episodic namespaces.

", - "deprecated":true, - "deprecatedMessage":"Use namespaceTemplates instead", - "deprecatedSince":"2026-03-02" - }, - "namespaceTemplates":{ - "shape":"NamespacesList", - "documentation":"

The namespaceTemplates to use for episodic reflection. Can be less nested than the episodic namespaces.

" - }, - "memoryRecordSchema":{ - "shape":"MemoryRecordSchema", - "documentation":"

Schema for metadata fields on records generated by this reflection override.

" - } - }, - "documentation":"

Configurations for overriding the reflection step of the episodic memory strategy.

" - }, - "EpisodicReflectionConfiguration":{ - "type":"structure", - "members":{ - "namespaces":{ - "shape":"NamespacesList", - "documentation":"

This is a legacy parameter, use namespaceTemplates. The namespaces for which to create reflections. Can be less nested than the episodic namespaces.

", - "deprecated":true, - "deprecatedMessage":"Use namespaceTemplates instead", - "deprecatedSince":"2026-03-02" - }, - "namespaceTemplates":{ - "shape":"NamespacesList", - "documentation":"

The namespaceTemplates for which to create reflections. Can be less nested than the episodic namespaces.

" - }, - "memoryRecordSchema":{ - "shape":"MemoryRecordSchema", - "documentation":"

\"Schema for metadata fields on records generated by reflections.

" - } - }, - "documentation":"

The configuration for the reflections created with the episodic memory strategy.

" - }, - "EpisodicReflectionConfigurationInput":{ - "type":"structure", - "members":{ - "namespaces":{ - "shape":"NamespacesList", - "documentation":"

This is a legacy parameter, use namespaceTemplates. The namespaces over which to create reflections. Can be less nested than episode namespaces.

", - "deprecated":true, - "deprecatedMessage":"Use namespaceTemplates instead", - "deprecatedSince":"2026-03-02" - }, - "namespaceTemplates":{ - "shape":"NamespacesList", - "documentation":"

The namespaceTemplates over which to create reflections. Can be less nested than episode namespaces.

" - }, - "memoryRecordSchema":{ - "shape":"MemoryRecordSchema", - "documentation":"

Schema for metadata fields on records generated by reflections.

" - } - }, - "documentation":"

An episodic reflection configuration input.

" - }, - "EpisodicReflectionOverride":{ - "type":"structure", - "required":[ - "appendToPrompt", - "modelId" - ], - "members":{ - "appendToPrompt":{ - "shape":"Prompt", - "documentation":"

The text appended to the prompt for the reflection step of the episodic memory strategy.

" - }, - "modelId":{ - "shape":"String", - "documentation":"

The model ID used for the reflection step of the episodic memory strategy.

" - }, - "namespaces":{ - "shape":"NamespacesList", - "documentation":"

This is a legacy parameter. The namespaces over which reflections were created. Can be less nested than the episodic namespaces.

", - "deprecated":true, - "deprecatedMessage":"Use namespaceTemplates instead", - "deprecatedSince":"2026-03-02" - }, - "namespaceTemplates":{ - "shape":"NamespacesList", - "documentation":"

The namespaceTemplates over which reflections were created. Can be less nested than the episodic namespaces.

" - }, - "memoryRecordSchema":{ - "shape":"MemoryRecordSchema", - "documentation":"

Schema for metadata fields on records generated by this reflection override.

" - } - }, - "documentation":"

Contains configurations to override the default reflection step for the episodic memory strategy.

" - }, - "EvaluationConfigDescription":{ - "type":"string", - "max":200, - "min":1, - "pattern":".+", - "sensitive":true - }, - "EvaluationConfigName":{ - "type":"string", - "pattern":"[a-zA-Z][a-zA-Z0-9_]{0,47}" - }, - "EvaluatorArn":{ - "type":"string", - "pattern":"arn:aws[a-zA-Z-]*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:evaluator\\/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}$|^arn:aws[a-zA-Z-]*:bedrock-agentcore:::evaluator/Builtin.[a-zA-Z0-9_-]+" - }, - "EvaluatorConfig":{ - "type":"structure", - "members":{ - "llmAsAJudge":{ - "shape":"LlmAsAJudgeEvaluatorConfig", - "documentation":"

The LLM-as-a-Judge configuration that uses a language model to evaluate agent performance based on custom instructions and rating scales.

" - }, - "codeBased":{ - "shape":"CodeBasedEvaluatorConfig", - "documentation":"

Configuration for a code-based evaluator that uses a customer-managed Lambda function to programmatically assess agent performance.

" - } - }, - "documentation":"

The configuration that defines how an evaluator assesses agent performance, including the evaluation method and parameters.

", - "union":true - }, - "EvaluatorDescription":{ - "type":"string", - "max":200, - "min":1, - "sensitive":true - }, - "EvaluatorId":{ - "type":"string", - "pattern":"(Builtin.[a-zA-Z0-9_-]+|[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10})" - }, - "EvaluatorInstructions":{ - "type":"string", - "sensitive":true - }, - "EvaluatorLevel":{ - "type":"string", - "enum":[ - "TOOL_CALL", - "TRACE", - "SESSION" - ] - }, - "EvaluatorList":{ - "type":"list", - "member":{"shape":"EvaluatorReference"}, - "max":10, - "min":0 - }, - "EvaluatorModelConfig":{ - "type":"structure", - "members":{ - "bedrockEvaluatorModelConfig":{ - "shape":"BedrockEvaluatorModelConfig", - "documentation":"

The Amazon Bedrock model configuration for evaluation.

" - }, - "responsesEvaluatorModelConfig":{ - "shape":"OpenResponsesEvaluatorModelConfig", - "documentation":"

The OpenResponses model configuration for evaluation.

" - } - }, - "documentation":"

The model configuration that specifies which foundation model to use for evaluation and how to configure it.

", - "union":true - }, - "EvaluatorName":{ - "type":"string", - "pattern":"(Builtin.[a-zA-Z0-9_-]+|[a-zA-Z][a-zA-Z0-9_]{0,47})" - }, - "EvaluatorReference":{ - "type":"structure", - "members":{ - "evaluatorId":{ - "shape":"EvaluatorId", - "documentation":"

The unique identifier of the evaluator. Can reference builtin evaluators (e.g., Builtin.Helpfulness) or custom evaluators.

" - } - }, - "documentation":"

The reference to an evaluator used in online evaluation configurations, containing the evaluator identifier.

", - "union":true - }, - "EvaluatorStatus":{ - "type":"string", - "enum":[ - "ACTIVE", - "CREATING", - "CREATE_FAILED", - "UPDATING", - "UPDATE_FAILED", - "DELETING" - ] - }, - "EvaluatorSummary":{ - "type":"structure", - "required":[ - "evaluatorArn", - "evaluatorId", - "evaluatorName", - "evaluatorType", - "status", - "createdAt", - "updatedAt" - ], - "members":{ - "evaluatorArn":{ - "shape":"EvaluatorArn", - "documentation":"

The Amazon Resource Name (ARN) of the evaluator.

" - }, - "evaluatorId":{ - "shape":"EvaluatorId", - "documentation":"

The unique identifier of the evaluator.

" - }, - "evaluatorName":{ - "shape":"EvaluatorName", - "documentation":"

The name of the evaluator.

" - }, - "description":{ - "shape":"EvaluatorDescription", - "documentation":"

The description of the evaluator.

" - }, - "evaluatorType":{ - "shape":"EvaluatorType", - "documentation":"

The type of evaluator, indicating whether it is a built-in evaluator provided by the service or a custom evaluator created by the user.

" - }, - "level":{ - "shape":"EvaluatorLevel", - "documentation":"

The evaluation level (TOOL_CALL, TRACE, or SESSION) that determines the scope of evaluation.

" - }, - "status":{ - "shape":"EvaluatorStatus", - "documentation":"

The current status of the evaluator.

" - }, - "createdAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the evaluator was created.

" - }, - "updatedAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the evaluator was last updated.

" - }, - "lockedForModification":{ - "shape":"Boolean", - "documentation":"

Whether the evaluator is locked for modification due to being referenced by active online evaluation configurations.

" - }, - "kmsKeyArn":{ - "shape":"KmsKeyArn", - "documentation":"

The Amazon Resource Name (ARN) of the customer managed KMS key used to encrypt the evaluator's sensitive data. This field is only present for evaluators encrypted with a customer managed key.

" - } - }, - "documentation":"

The summary information about an evaluator, including basic metadata and status information.

" - }, - "EvaluatorSummaryList":{ - "type":"list", - "member":{"shape":"EvaluatorSummary"} - }, - "EvaluatorType":{ - "type":"string", - "enum":[ - "Builtin", - "Custom", - "CustomCode" - ] - }, - "ExampleId":{ - "type":"string", - "max":256, - "min":0, - "pattern":"[a-zA-Z0-9_.:-]+" - }, - "ExampleIdList":{ - "type":"list", - "member":{"shape":"ExampleId"} - }, - "ExceptionLevel":{ - "type":"string", - "enum":["DEBUG"] - }, - "ExtractionConfig":{ - "type":"structure", - "members":{ - "llmExtractionConfig":{ - "shape":"LlmExtractionConfig", - "documentation":"

Model-based extraction using a definition and instructions.

" - } - }, - "documentation":"

Configuration for metadata extraction from conversational content.

", - "union":true - }, - "ExtractionConfiguration":{ - "type":"structure", - "members":{ - "customExtractionConfiguration":{ - "shape":"CustomExtractionConfiguration", - "documentation":"

The custom extraction configuration.

" - } - }, - "documentation":"

Contains extraction configuration information for a memory strategy.

", - "union":true - }, - "ExtractionType":{ - "type":"string", - "documentation":"

The extraction type for a metadata field, determining how the value is obtained during memory processing.

", - "enum":[ - "LLM_INFERRED", - "STRICTLY_CONSISTENT" - ] - }, - "FilesystemConfiguration":{ - "type":"structure", - "members":{ - "sessionStorage":{ - "shape":"SessionStorageConfiguration", - "documentation":"

Configuration for session storage. Session storage provides persistent storage that is preserved across AgentCore Runtime session invocations.

" - }, - "s3FilesAccessPoint":{ - "shape":"S3FilesAccessPointConfiguration", - "documentation":"

Configuration for an Amazon S3 Files access point to mount into the AgentCore Runtime.

" - }, - "efsAccessPoint":{ - "shape":"EfsAccessPointConfiguration", - "documentation":"

Configuration for an Amazon EFS access point to mount into the AgentCore Runtime.

" - } - }, - "documentation":"

Configuration for a filesystem that can be mounted into the AgentCore Runtime.

", - "union":true - }, - "FilesystemConfigurations":{ - "type":"list", - "member":{"shape":"FilesystemConfiguration"}, - "max":5, - "min":0 - }, - "Filter":{ - "type":"structure", - "required":[ - "key", - "operator", - "value" - ], - "members":{ - "key":{ - "shape":"FilterKeyString", - "documentation":"

The key or field name to filter on within the agent trace data.

" - }, - "operator":{ - "shape":"FilterOperator", - "documentation":"

The comparison operator to use for filtering.

" - }, - "value":{ - "shape":"FilterValue", - "documentation":"

The value to compare against using the specified operator.

" - } - }, - "documentation":"

The filter that applies conditions to agent traces during online evaluation to determine which traces should be evaluated.

" - }, - "FilterKeyString":{ - "type":"string", - "max":256, - "min":1, - "pattern":"[a-zA-Z0-9._-]+" - }, - "FilterList":{ - "type":"list", - "member":{"shape":"Filter"}, - "max":5, - "min":0 - }, - "FilterOperator":{ - "type":"string", - "enum":[ - "Equals", - "NotEquals", - "GreaterThan", - "LessThan", - "GreaterThanOrEqual", - "LessThanOrEqual", - "Contains", - "NotContains" - ] - }, - "FilterValue":{ - "type":"structure", - "members":{ - "stringValue":{ - "shape":"FilterValueStringValueString", - "documentation":"

The string value for text-based filtering.

" - }, - "doubleValue":{ - "shape":"Double", - "documentation":"

The numeric value for numerical filtering and comparisons.

" - }, - "booleanValue":{ - "shape":"Boolean", - "documentation":"

The boolean value for true/false filtering conditions.

" - } - }, - "documentation":"

The value used in filter comparisons, supporting different data types for flexible filtering criteria.

", - "union":true - }, - "FilterValueStringValueString":{ - "type":"string", - "max":1024, - "min":1 - }, - "Finding":{ - "type":"structure", - "members":{ - "type":{ - "shape":"FindingType", - "documentation":"

The type or category of the finding. This classifies the finding as an error, warning, recommendation, or informational message to help users understand the severity and nature of the issue.

" - }, - "description":{ - "shape":"String", - "documentation":"

A human-readable description of the finding. This provides detailed information about the issue, recommendation, or validation result to help users understand and address the finding.

" - } - }, - "documentation":"

Represents a finding or issue discovered during policy generation or validation. Findings provide insights about potential problems, recommendations, or validation results from policy analysis operations. Finding types include: VALID (policy is ready to use), INVALID (policy has validation errors that must be fixed), NOT_TRANSLATABLE (input couldn't be converted to policy), ALLOW_ALL (policy would allow all actions, potential security risk), ALLOW_NONE (policy would allow no actions, unusable), DENY_ALL (policy would deny all actions, may be too restrictive), and DENY_NONE (policy would deny no actions, ineffective). Review all findings before creating policies from generated assets to ensure they match your security requirements.

" - }, - "FindingType":{ - "type":"string", - "enum":[ - "VALID", - "INVALID", - "NOT_TRANSLATABLE", - "ALLOW_ALL", - "ALLOW_NONE", - "DENY_ALL", - "DENY_NONE" - ] - }, - "Findings":{ - "type":"list", - "member":{"shape":"Finding"} - }, - "Float":{ - "type":"float", - "box":true - }, - "FromUrlSynchronizationConfiguration":{ - "type":"structure", - "required":["url"], - "members":{ - "url":{ - "shape":"McpServerUrl", - "documentation":"

The HTTPS URL of the MCP server to synchronize from.

" - }, - "credentialProviderConfigurations":{ - "shape":"RegistryRecordCredentialProviderConfigurationList", - "documentation":"

Optional list of credential provider configurations for authenticating with the MCP server. At most one credential provider configuration can be specified.

" - } - }, - "documentation":"

Configuration for synchronizing from a URL-based MCP server.

" - }, - "GatewayArn":{ - "type":"string", - "pattern":"arn:aws(|-cn|-us-gov):bedrock-agentcore:[a-z0-9-]{1,20}:[0-9]{12}:gateway/([0-9a-z][-]?){1,48}-[a-z0-9]{10}" - }, - "GatewayConfigurationBundleArn":{ - "type":"string", - "pattern":"arn:aws[a-zA-Z-]*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:configuration-bundle/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}" - }, - "GatewayDescription":{ - "type":"string", - "max":200, - "min":1, - "sensitive":true - }, - "GatewayId":{ - "type":"string", - "pattern":"([0-9a-z][-]?){1,100}-[0-9a-z]{10}" - }, - "GatewayIdentifier":{ - "type":"string", - "pattern":"([0-9a-z][-]?){1,100}-[0-9a-z]{10}" - }, - "GatewayInterceptionPoint":{ - "type":"string", - "enum":[ - "REQUEST", - "RESPONSE" - ] - }, - "GatewayInterceptionPoints":{ - "type":"list", - "member":{"shape":"GatewayInterceptionPoint"}, - "max":2, - "min":1 - }, - "GatewayInterceptorConfiguration":{ - "type":"structure", - "required":[ - "interceptor", - "interceptionPoints" - ], - "members":{ - "interceptor":{ - "shape":"InterceptorConfiguration", - "documentation":"

The infrastructure settings of an interceptor configuration. This structure defines how the interceptor can be invoked.

" - }, - "interceptionPoints":{ - "shape":"GatewayInterceptionPoints", - "documentation":"

The supported points of interception. This field specifies which points during the gateway invocation to invoke the interceptor

" - }, - "inputConfiguration":{ - "shape":"InterceptorInputConfiguration", - "documentation":"

The configuration for the input of the interceptor. This field specifies how the input to the interceptor is constructed

" - } - }, - "documentation":"

The configuration for an interceptor on a gateway. This structure defines settings for an interceptor that will be invoked during the invocation of the gateway.

" - }, - "GatewayInterceptorConfigurations":{ - "type":"list", - "member":{"shape":"GatewayInterceptorConfiguration"}, - "max":2, - "min":1 - }, - "GatewayMaxResults":{ - "type":"integer", - "box":true, - "max":1000, - "min":1 - }, - "GatewayName":{ - "type":"string", - "pattern":"([0-9a-zA-Z][-]?){1,48}" - }, - "GatewayNextToken":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"\\S*" - }, - "GatewayPolicyEngineArn":{ - "type":"string", - "max":170, - "min":1, - "pattern":"arn:aws:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:policy-engine\\/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9_]{10}" - }, - "GatewayPolicyEngineConfiguration":{ - "type":"structure", - "required":[ - "arn", - "mode" - ], - "members":{ - "arn":{ - "shape":"GatewayPolicyEngineArn", - "documentation":"

The ARN of the policy engine. The policy engine contains Cedar policies that define fine-grained authorization rules specifying who can perform what actions on which resources as agents interact through the gateway.

" - }, - "mode":{ - "shape":"GatewayPolicyEngineMode", - "documentation":"

The enforcement mode for the policy engine. Valid values include:

  • LOG_ONLY - The policy engine evaluates each action against your policies and adds traces on whether tool calls would be allowed or denied, but does not enforce the decision. Use this mode to test and validate policies before enabling enforcement.

  • ENFORCE - The policy engine evaluates actions against your policies and enforces decisions by allowing or denying agent operations. Test and validate policies in LOG_ONLY mode before enabling enforcement to avoid unintended denials or adversely affecting production traffic.

" - } - }, - "documentation":"

The configuration for a policy engine associated with a gateway. A policy engine is a collection of policies that evaluates and authorizes agent tool calls. When associated with a gateway, the policy engine intercepts all agent requests and determines whether to allow or deny each action based on the defined policies.

" - }, - "GatewayPolicyEngineMode":{ - "type":"string", - "enum":[ - "LOG_ONLY", - "ENFORCE" - ] - }, - "GatewayProtocolConfiguration":{ - "type":"structure", - "members":{ - "mcp":{ - "shape":"MCPGatewayConfiguration", - "documentation":"

The configuration for the Model Context Protocol (MCP). This protocol enables communication between Amazon Bedrock Agent and external tools.

" - } - }, - "documentation":"

The configuration for a gateway protocol. This structure defines how the gateway communicates with external services.

", - "union":true - }, - "GatewayProtocolType":{ - "type":"string", - "enum":["MCP"] - }, - "GatewayRuleDescription":{ - "type":"string", - "max":256, - "min":1 - }, - "GatewayRuleDetail":{ - "type":"structure", - "required":[ - "ruleId", - "gatewayArn", - "priority", - "actions", - "createdAt", - "status" - ], - "members":{ - "ruleId":{ - "shape":"GatewayRuleId", - "documentation":"

The unique identifier of the gateway rule.

" - }, - "gatewayArn":{ - "shape":"GatewayArn", - "documentation":"

The Amazon Resource Name (ARN) of the gateway that the rule belongs to.

" - }, - "priority":{ - "shape":"GatewayRulePriority", - "documentation":"

The priority of the rule. Rules are evaluated in order of priority, with lower numbers evaluated first.

" - }, - "conditions":{ - "shape":"Conditions", - "documentation":"

The conditions that must be met for the rule to apply.

" - }, - "actions":{ - "shape":"Actions", - "documentation":"

The actions to take when the rule conditions are met.

" - }, - "description":{ - "shape":"GatewayRuleDescription", - "documentation":"

The description of the gateway rule.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the rule was created.

" - }, - "status":{ - "shape":"GatewayRuleStatus", - "documentation":"

The current status of the rule.

" - }, - "system":{ - "shape":"SystemManagedBlock", - "documentation":"

System-managed metadata for rules created by automated processes.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the rule was last updated.

" - } - }, - "documentation":"

Detailed information about a gateway rule.

" - }, - "GatewayRuleId":{ - "type":"string", - "max":36, - "min":36, - "pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" - }, - "GatewayRuleMaxResults":{ - "type":"integer", - "box":true, - "max":100, - "min":1 - }, - "GatewayRuleNextToken":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"\\S*" - }, - "GatewayRulePriority":{ - "type":"integer", - "box":true, - "max":1000000, - "min":1 - }, - "GatewayRuleStatus":{ - "type":"string", - "enum":[ - "CREATING", - "ACTIVE", - "UPDATING", - "DELETING" - ] - }, - "GatewayRules":{ - "type":"list", - "member":{"shape":"GatewayRuleDetail"} - }, - "GatewayStatus":{ - "type":"string", - "enum":[ - "CREATING", - "UPDATING", - "UPDATE_UNSUCCESSFUL", - "DELETING", - "READY", - "FAILED" - ] - }, - "GatewaySummaries":{ - "type":"list", - "member":{"shape":"GatewaySummary"} - }, - "GatewaySummary":{ - "type":"structure", - "required":[ - "gatewayId", - "name", - "status", - "createdAt", - "updatedAt", - "authorizerType" - ], - "members":{ - "gatewayId":{ - "shape":"GatewayId", - "documentation":"

The unique identifier of the gateway.

" - }, - "name":{ - "shape":"GatewayName", - "documentation":"

The name of the gateway.

" - }, - "status":{ - "shape":"GatewayStatus", - "documentation":"

The current status of the gateway.

" - }, - "description":{ - "shape":"GatewayDescription", - "documentation":"

The description of the gateway.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the gateway was created.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the gateway was last updated.

" - }, - "authorizerType":{ - "shape":"AuthorizerType", - "documentation":"

The type of authorizer used by the gateway.

" - }, - "protocolType":{ - "shape":"GatewayProtocolType", - "documentation":"

The protocol type used by the gateway.

" - } - }, - "documentation":"

Contains summary information about a gateway.

" - }, - "GatewayTarget":{ - "type":"structure", - "required":[ - "gatewayArn", - "targetId", - "createdAt", - "updatedAt", - "status", - "name", - "targetConfiguration", - "credentialProviderConfigurations" - ], - "members":{ - "gatewayArn":{ - "shape":"GatewayArn", - "documentation":"

The Amazon Resource Name (ARN) of the gateway target.

" - }, - "targetId":{ - "shape":"TargetId", - "documentation":"

The target ID.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The date and time at which the target was created.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The date and time at which the target was updated.

" - }, - "status":{ - "shape":"TargetStatus", - "documentation":"

The status of the gateway target.

" - }, - "statusReasons":{ - "shape":"StatusReasons", - "documentation":"

The status reasons for the target status.

" - }, - "name":{ - "shape":"TargetName", - "documentation":"

The name of the gateway target.

" - }, - "description":{ - "shape":"TargetDescription", - "documentation":"

The description for the gateway target.

" - }, - "targetConfiguration":{"shape":"TargetConfiguration"}, - "credentialProviderConfigurations":{ - "shape":"CredentialProviderConfigurations", - "documentation":"

The provider configurations.

" - }, - "lastSynchronizedAt":{ - "shape":"DateTimestamp", - "documentation":"

The last synchronization time.

" - }, - "metadataConfiguration":{ - "shape":"MetadataConfiguration", - "documentation":"

The metadata configuration for HTTP header and query parameter propagation to and from this gateway target.

" - }, - "privateEndpoint":{"shape":"PrivateEndpoint"}, - "privateEndpointManagedResources":{ - "shape":"PrivateEndpointManagedResources", - "documentation":"

A list of managed resources created by the gateway for private endpoint connectivity. These resources are created in your account when you use a managed VPC Lattice resource configuration.

" - }, - "authorizationData":{ - "shape":"AuthorizationData", - "documentation":"

OAuth2 authorization data for the gateway target. This data is returned when a target is configured with a credential provider with authorization code grant type and requires user federation.

" - }, - "protocolType":{ - "shape":"TargetProtocolType", - "documentation":"

The protocol type of the gateway target.

" - } - }, - "documentation":"

The gateway target.

" - }, - "GatewayTargetList":{ - "type":"list", - "member":{"shape":"GatewayTarget"} - }, - "GatewayUrl":{ - "type":"string", - "max":1024, - "min":1 - }, - "GetAgentRuntimeEndpointRequest":{ - "type":"structure", - "required":[ - "agentRuntimeId", - "endpointName" - ], - "members":{ - "agentRuntimeId":{ - "shape":"AgentRuntimeId", - "documentation":"

The unique identifier of the AgentCore Runtime associated with the endpoint.

", - "location":"uri", - "locationName":"agentRuntimeId" - }, - "endpointName":{ - "shape":"EndpointName", - "documentation":"

The name of the AgentCore Runtime endpoint to retrieve.

", - "location":"uri", - "locationName":"endpointName" - } - } - }, - "GetAgentRuntimeEndpointResponse":{ - "type":"structure", - "required":[ - "agentRuntimeEndpointArn", - "agentRuntimeArn", - "status", - "createdAt", - "lastUpdatedAt", - "name", - "id" - ], - "members":{ - "liveVersion":{ - "shape":"AgentRuntimeVersion", - "documentation":"

The currently deployed version of the AgentCore Runtime on the endpoint.

" - }, - "targetVersion":{ - "shape":"AgentRuntimeVersion", - "documentation":"

The target version of the AgentCore Runtime for the endpoint.

" - }, - "agentRuntimeEndpointArn":{ - "shape":"AgentRuntimeEndpointArn", - "documentation":"

The Amazon Resource Name (ARN) of the AgentCore Runtime endpoint.

" - }, - "agentRuntimeArn":{ - "shape":"AgentRuntimeArn", - "documentation":"

The Amazon Resource Name (ARN) of the AgentCore Runtime.

" - }, - "description":{ - "shape":"AgentEndpointDescription", - "documentation":"

The description of the AgentCore Runtime endpoint.

" - }, - "status":{ - "shape":"AgentRuntimeEndpointStatus", - "documentation":"

The current status of the AgentCore Runtime endpoint.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the AgentCore Runtime endpoint was created.

" - }, - "lastUpdatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the AgentCore Runtime endpoint was last updated.

" - }, - "failureReason":{ - "shape":"String", - "documentation":"

The reason for failure if the AgentCore Runtime endpoint is in a failed state.

" - }, - "name":{ - "shape":"EndpointName", - "documentation":"

The name of the AgentCore Runtime endpoint.

" - }, - "id":{ - "shape":"AgentRuntimeEndpointId", - "documentation":"

The unique identifier of the AgentCore Runtime endpoint.

" - } - } - }, - "GetAgentRuntimeRequest":{ - "type":"structure", - "required":["agentRuntimeId"], - "members":{ - "agentRuntimeId":{ - "shape":"AgentRuntimeId", - "documentation":"

The unique identifier of the AgentCore Runtime to retrieve.

", - "location":"uri", - "locationName":"agentRuntimeId" - }, - "agentRuntimeVersion":{ - "shape":"AgentRuntimeVersion", - "documentation":"

The version of the AgentCore Runtime to retrieve.

", - "location":"querystring", - "locationName":"version" - } - } - }, - "GetAgentRuntimeResponse":{ - "type":"structure", - "required":[ - "agentRuntimeArn", - "agentRuntimeName", - "agentRuntimeId", - "agentRuntimeVersion", - "createdAt", - "lastUpdatedAt", - "roleArn", - "networkConfiguration", - "status", - "lifecycleConfiguration" - ], - "members":{ - "agentRuntimeArn":{ - "shape":"AgentRuntimeArn", - "documentation":"

The Amazon Resource Name (ARN) of the AgentCore Runtime.

" - }, - "agentRuntimeName":{ - "shape":"AgentRuntimeName", - "documentation":"

The name of the AgentCore Runtime.

" - }, - "agentRuntimeId":{ - "shape":"AgentRuntimeId", - "documentation":"

The unique identifier of the AgentCore Runtime.

" - }, - "agentRuntimeVersion":{ - "shape":"AgentRuntimeVersion", - "documentation":"

The version of the AgentCore Runtime.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the AgentCore Runtime was created.

" - }, - "lastUpdatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the AgentCore Runtime was last updated.

" - }, - "roleArn":{ - "shape":"RoleArn", - "documentation":"

The IAM role ARN that provides permissions for the AgentCore Runtime.

" - }, - "networkConfiguration":{ - "shape":"NetworkConfiguration", - "documentation":"

The network configuration for the AgentCore Runtime.

" - }, - "status":{ - "shape":"AgentRuntimeStatus", - "documentation":"

The current status of the AgentCore Runtime.

" - }, - "lifecycleConfiguration":{ - "shape":"LifecycleConfiguration", - "documentation":"

The life cycle configuration for the AgentCore Runtime.

" - }, - "failureReason":{ - "shape":"String", - "documentation":"

The reason for failure if the AgentCore Runtime is in a failed state.

" - }, - "description":{ - "shape":"Description", - "documentation":"

The description of the AgentCore Runtime.

" - }, - "workloadIdentityDetails":{ - "shape":"WorkloadIdentityDetails", - "documentation":"

The workload identity details for the AgentCore Runtime.

" - }, - "agentRuntimeArtifact":{ - "shape":"AgentRuntimeArtifact", - "documentation":"

The artifact of the AgentCore Runtime.

" - }, - "protocolConfiguration":{"shape":"ProtocolConfiguration"}, - "environmentVariables":{ - "shape":"EnvironmentVariablesMap", - "documentation":"

Environment variables set in the AgentCore Runtime environment.

" - }, - "authorizerConfiguration":{ - "shape":"AuthorizerConfiguration", - "documentation":"

The authorizer configuration for the AgentCore Runtime.

" - }, - "requestHeaderConfiguration":{ - "shape":"RequestHeaderConfiguration", - "documentation":"

Configuration for HTTP request headers that will be passed through to the runtime.

" - }, - "metadataConfiguration":{ - "shape":"RuntimeMetadataConfiguration", - "documentation":"

Configuration for microVM Metadata Service (MMDS) settings for the AgentCore Runtime.

" - }, - "filesystemConfigurations":{ - "shape":"FilesystemConfigurations", - "documentation":"

The filesystem configurations mounted into the AgentCore Runtime.

" - } - } - }, - "GetApiKeyCredentialProviderRequest":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{ - "shape":"CredentialProviderName", - "documentation":"

The name of the API key credential provider to retrieve.

" - } - } - }, - "GetApiKeyCredentialProviderResponse":{ - "type":"structure", - "required":[ - "apiKeySecretArn", - "name", - "credentialProviderArn", - "createdTime", - "lastUpdatedTime" - ], - "members":{ - "apiKeySecretArn":{ - "shape":"Secret", - "documentation":"

The Amazon Resource Name (ARN) of the API key secret in Amazon Web Services Secrets Manager.

" - }, - "apiKeySecretJsonKey":{ - "shape":"SecretJsonKeyType", - "documentation":"

The JSON key used to extract the API key value from the Amazon Web Services Secrets Manager secret.

" - }, - "apiKeySecretSource":{ - "shape":"SecretSourceType", - "documentation":"

The source type of the API key secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager.

" - }, - "name":{ - "shape":"CredentialProviderName", - "documentation":"

The name of the API key credential provider.

" - }, - "credentialProviderArn":{ - "shape":"ApiKeyCredentialProviderArnType", - "documentation":"

The Amazon Resource Name (ARN) of the API key credential provider.

" - }, - "createdTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the API key credential provider was created.

" - }, - "lastUpdatedTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the API key credential provider was last updated.

" - } - } - }, - "GetBrowserProfileRequest":{ - "type":"structure", - "required":["profileId"], - "members":{ - "profileId":{ - "shape":"BrowserProfileId", - "documentation":"

The unique identifier of the browser profile to retrieve.

", - "location":"uri", - "locationName":"profileId" - } - } - }, - "GetBrowserProfileResponse":{ - "type":"structure", - "required":[ - "profileId", - "profileArn", - "name", - "status", - "createdAt", - "lastUpdatedAt" - ], - "members":{ - "profileId":{ - "shape":"BrowserProfileId", - "documentation":"

The unique identifier of the browser profile.

" - }, - "profileArn":{ - "shape":"BrowserProfileArn", - "documentation":"

The Amazon Resource Name (ARN) of the browser profile.

" - }, - "name":{ - "shape":"BrowserProfileName", - "documentation":"

The name of the browser profile.

" - }, - "description":{ - "shape":"Description", - "documentation":"

The description of the browser profile.

" - }, - "status":{ - "shape":"BrowserProfileStatus", - "documentation":"

The current status of the browser profile.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the browser profile was created.

" - }, - "lastUpdatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the browser profile was last updated.

" - }, - "lastSavedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when browser session data was last saved to this profile.

" - }, - "lastSavedBrowserSessionId":{ - "shape":"BrowserSessionId", - "documentation":"

The identifier of the browser session from which data was last saved to this profile.

" - }, - "lastSavedBrowserId":{ - "shape":"BrowserId", - "documentation":"

The identifier of the browser from which data was last saved to this profile.

" - } - } - }, - "GetBrowserRequest":{ - "type":"structure", - "required":["browserId"], - "members":{ - "browserId":{ - "shape":"BrowserId", - "documentation":"

The unique identifier of the browser to retrieve.

", - "location":"uri", - "locationName":"browserId" - } - } - }, - "GetBrowserResponse":{ - "type":"structure", - "required":[ - "browserId", - "browserArn", - "name", - "networkConfiguration", - "status", - "createdAt", - "lastUpdatedAt" - ], - "members":{ - "browserId":{ - "shape":"BrowserId", - "documentation":"

The unique identifier of the browser.

" - }, - "browserArn":{ - "shape":"BrowserArn", - "documentation":"

The Amazon Resource Name (ARN) of the browser.

" - }, - "name":{ - "shape":"SandboxName", - "documentation":"

The name of the browser.

" - }, - "description":{ - "shape":"Description", - "documentation":"

The description of the browser.

" - }, - "executionRoleArn":{ - "shape":"RoleArn", - "documentation":"

The IAM role ARN that provides permissions for the browser.

" - }, - "networkConfiguration":{"shape":"BrowserNetworkConfiguration"}, - "recording":{"shape":"RecordingConfig"}, - "browserSigning":{ - "shape":"BrowserSigningConfigOutput", - "documentation":"

The browser signing configuration that shows whether cryptographic agent identification is enabled for web bot authentication.

" - }, - "enterprisePolicies":{ - "shape":"BrowserEnterprisePolicies", - "documentation":"

The list of enterprise policy files configured for the browser.

" - }, - "certificates":{ - "shape":"Certificates", - "documentation":"

The list of certificates configured for the browser.

" - }, - "filesystemConfigurations":{ - "shape":"ToolsFileSystemConfigurations", - "documentation":"

The file system configurations mounted into the browser. Each entry describes an access point and its mount path.

" - }, - "status":{ - "shape":"BrowserStatus", - "documentation":"

The current status of the browser.

" - }, - "failureReason":{ - "shape":"String", - "documentation":"

The reason for failure if the browser is in a failed state.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the browser was created.

" - }, - "lastUpdatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the browser was last updated.

" - } - } - }, - "GetCodeInterpreterRequest":{ - "type":"structure", - "required":["codeInterpreterId"], - "members":{ - "codeInterpreterId":{ - "shape":"CodeInterpreterId", - "documentation":"

The unique identifier of the code interpreter to retrieve.

", - "location":"uri", - "locationName":"codeInterpreterId" - } - } - }, - "GetCodeInterpreterResponse":{ - "type":"structure", - "required":[ - "codeInterpreterId", - "codeInterpreterArn", - "name", - "networkConfiguration", - "status", - "createdAt", - "lastUpdatedAt" - ], - "members":{ - "codeInterpreterId":{ - "shape":"CodeInterpreterId", - "documentation":"

The unique identifier of the code interpreter.

" - }, - "codeInterpreterArn":{ - "shape":"CodeInterpreterArn", - "documentation":"

The Amazon Resource Name (ARN) of the code interpreter.

" - }, - "name":{ - "shape":"SandboxName", - "documentation":"

The name of the code interpreter.

" - }, - "description":{ - "shape":"Description", - "documentation":"

The description of the code interpreter.

" - }, - "executionRoleArn":{ - "shape":"RoleArn", - "documentation":"

The IAM role ARN that provides permissions for the code interpreter.

" - }, - "networkConfiguration":{"shape":"CodeInterpreterNetworkConfiguration"}, - "status":{ - "shape":"CodeInterpreterStatus", - "documentation":"

The current status of the code interpreter.

" - }, - "certificates":{ - "shape":"Certificates", - "documentation":"

The list of certificates configured for the code interpreter.

" - }, - "filesystemConfigurations":{ - "shape":"ToolsFileSystemConfigurations", - "documentation":"

The file system configurations mounted into the code interpreter. Each entry describes an access point and its mount path.

" - }, - "failureReason":{ - "shape":"String", - "documentation":"

The reason for failure if the code interpreter is in a failed state.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the code interpreter was created.

" - }, - "lastUpdatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the code interpreter was last updated.

" - } - } - }, - "GetConfigurationBundleRequest":{ - "type":"structure", - "required":["bundleId"], - "members":{ - "bundleId":{ - "shape":"ConfigurationBundleId", - "documentation":"

The unique identifier of the configuration bundle to retrieve.

", - "location":"uri", - "locationName":"bundleId" - }, - "branchName":{ - "shape":"BranchName", - "documentation":"

The branch name to get the latest version from. If not specified, returns the latest version on the mainline branch.

", - "location":"querystring", - "locationName":"branchName" - } - } - }, - "GetConfigurationBundleResponse":{ - "type":"structure", - "required":[ - "bundleArn", - "bundleId", - "bundleName", - "versionId", - "components", - "createdAt", - "updatedAt" - ], - "members":{ - "bundleArn":{ - "shape":"ConfigurationBundleArn", - "documentation":"

The Amazon Resource Name (ARN) of the configuration bundle.

" - }, - "bundleId":{ - "shape":"ConfigurationBundleId", - "documentation":"

The unique identifier of the configuration bundle.

" - }, - "bundleName":{ - "shape":"ConfigurationBundleName", - "documentation":"

The name of the configuration bundle.

" - }, - "description":{ - "shape":"ConfigurationBundleDescription", - "documentation":"

The description of the configuration bundle.

" - }, - "versionId":{ - "shape":"ConfigurationBundleVersion", - "documentation":"

The version identifier of this configuration bundle.

" - }, - "components":{ - "shape":"ComponentConfigurationMap", - "documentation":"

A map of component identifiers to their configurations for this version.

" - }, - "lineageMetadata":{ - "shape":"VersionLineageMetadata", - "documentation":"

The version lineage metadata, including parent versions, branch name, and creation source.

" - }, - "createdAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the configuration bundle was created.

" - }, - "updatedAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the configuration bundle was last updated.

" - }, - "kmsKeyArn":{ - "shape":"KmsKeyArn", - "documentation":"

KMS key ARN used to encrypt component configurations, if CMK was provided.

" - } - } - }, - "GetConfigurationBundleVersionRequest":{ - "type":"structure", - "required":[ - "bundleId", - "versionId" - ], - "members":{ - "bundleId":{ - "shape":"ConfigurationBundleId", - "documentation":"

The unique identifier of the configuration bundle.

", - "location":"uri", - "locationName":"bundleId" - }, - "versionId":{ - "shape":"ConfigurationBundleVersion", - "documentation":"

The version identifier of the configuration bundle version to retrieve.

", - "location":"uri", - "locationName":"versionId" - } - } - }, - "GetConfigurationBundleVersionResponse":{ - "type":"structure", - "required":[ - "bundleArn", - "bundleId", - "bundleName", - "versionId", - "components", - "createdAt", - "versionCreatedAt" - ], - "members":{ - "bundleArn":{ - "shape":"ConfigurationBundleArn", - "documentation":"

The Amazon Resource Name (ARN) of the configuration bundle.

" - }, - "bundleId":{ - "shape":"ConfigurationBundleId", - "documentation":"

The unique identifier of the configuration bundle.

" - }, - "bundleName":{ - "shape":"ConfigurationBundleName", - "documentation":"

The name of the configuration bundle.

" - }, - "description":{ - "shape":"ConfigurationBundleDescription", - "documentation":"

The description of the configuration bundle.

" - }, - "versionId":{ - "shape":"ConfigurationBundleVersion", - "documentation":"

The version identifier of this configuration bundle version.

" - }, - "components":{ - "shape":"ComponentConfigurationMap", - "documentation":"

A map of component identifiers to their configurations for this version.

" - }, - "lineageMetadata":{ - "shape":"VersionLineageMetadata", - "documentation":"

The version lineage metadata, including parent versions, branch name, and creation source.

" - }, - "createdAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the configuration bundle was created.

" - }, - "versionCreatedAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when this specific version was created.

" - }, - "kmsKeyArn":{ - "shape":"KmsKeyArn", - "documentation":"

KMS key ARN used to encrypt component configurations, if CMK was provided.

" - } - } - }, - "GetDatasetRequest":{ - "type":"structure", - "required":["datasetId"], - "members":{ - "datasetId":{ - "shape":"DatasetId", - "documentation":"

The unique identifier of the dataset to retrieve.

", - "location":"uri", - "locationName":"datasetId" - }, - "datasetVersion":{ - "shape":"DatasetVersion", - "documentation":"

Version to retrieve: \"DRAFT\" or a version number. Defaults to DRAFT if absent.

", - "location":"querystring", - "locationName":"datasetVersion" - } - } - }, - "GetDatasetResponse":{ - "type":"structure", - "required":[ - "datasetArn", - "datasetId", - "datasetVersion", - "datasetName", - "status", - "schemaType", - "exampleCount", - "createdAt", - "updatedAt" - ], - "members":{ - "datasetArn":{ - "shape":"DatasetArn", - "documentation":"

The Amazon Resource Name (ARN) of the dataset.

" - }, - "datasetId":{ - "shape":"DatasetId", - "documentation":"

The unique identifier of the dataset.

" - }, - "datasetVersion":{ - "shape":"DatasetVersion", - "documentation":"

The resolved version: \"DRAFT\" (default) or the requested version number.

" - }, - "datasetName":{ - "shape":"DatasetName", - "documentation":"

The name of the dataset.

" - }, - "description":{ - "shape":"String", - "documentation":"

The description of the dataset.

" - }, - "status":{ - "shape":"DatasetStatus", - "documentation":"

The current status of the dataset.

" - }, - "draftStatus":{ - "shape":"DraftStatus", - "documentation":"

Publish synchronization state. Only authoritative when status is ACTIVE. MODIFIED indicates DRAFT has unpublished changes. UNMODIFIED indicates DRAFT matches the latest published version.

" - }, - "failureReason":{ - "shape":"String", - "documentation":"

Populated when status is CREATE_FAILED, UPDATE_FAILED, or DELETE_FAILED. Describes the reason for the failure.

" - }, - "schemaType":{ - "shape":"DatasetSchemaType", - "documentation":"

The schema type declared at create time. Immutable after creation.

" - }, - "kmsKeyArn":{ - "shape":"KmsKeyArn", - "documentation":"

KMS key ARN used for server-side encryption on service Amazon S3 writes, if configured.

" - }, - "exampleCount":{ - "shape":"Long", - "documentation":"

The number of examples in the DRAFT.

" - }, - "downloadUrl":{ - "shape":"DownloadUrl", - "documentation":"

Presigned Amazon S3 URL to download the consolidated dataset file for the resolved version. Expires after 5 minutes. Omitted if the file does not yet exist.

" - }, - "downloadUrlExpiresAt":{ - "shape":"Timestamp", - "documentation":"

Expiry timestamp for the download URL.

" - }, - "createdAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the dataset was created.

" - }, - "updatedAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the dataset was last updated.

" - }, - "tags":{ - "shape":"TagsMap", - "documentation":"

The tags associated with the dataset.

" - } - } - }, - "GetEvaluatorRequest":{ - "type":"structure", - "required":["evaluatorId"], - "members":{ - "evaluatorId":{ - "shape":"EvaluatorId", - "documentation":"

The unique identifier of the evaluator to retrieve. Can be a built-in evaluator ID (e.g., Builtin.Helpfulness) or a custom evaluator ID.

", - "location":"uri", - "locationName":"evaluatorId" - }, - "includedData":{ - "shape":"IncludedData", - "documentation":"

Controls which data is returned in the response. ALL_DATA (default) returns the full evaluator including decrypted instructions and rating scale. For evaluators encrypted with a customer managed KMS key, this requires kms:Decrypt permission on the key. METADATA_ONLY returns evaluator metadata and model configuration without instructions or rating scale, and does not require any KMS permissions.

", - "location":"querystring", - "locationName":"includedData" - } - } - }, - "GetEvaluatorResponse":{ - "type":"structure", - "required":[ - "evaluatorArn", - "evaluatorId", - "evaluatorName", - "evaluatorConfig", - "level", - "status", - "createdAt", - "updatedAt" - ], - "members":{ - "evaluatorArn":{ - "shape":"EvaluatorArn", - "documentation":"

The Amazon Resource Name (ARN) of the evaluator.

" - }, - "evaluatorId":{ - "shape":"EvaluatorId", - "documentation":"

The unique identifier of the evaluator.

" - }, - "evaluatorName":{ - "shape":"EvaluatorName", - "documentation":"

The name of the evaluator.

" - }, - "description":{ - "shape":"EvaluatorDescription", - "documentation":"

The description of the evaluator.

" - }, - "evaluatorConfig":{ - "shape":"EvaluatorConfig", - "documentation":"

The configuration of the evaluator, including LLM-as-a-Judge or code-based settings.

" - }, - "level":{ - "shape":"EvaluatorLevel", - "documentation":"

The evaluation level (TOOL_CALL, TRACE, or SESSION) that determines the scope of evaluation.

" - }, - "status":{ - "shape":"EvaluatorStatus", - "documentation":"

The current status of the evaluator.

" - }, - "createdAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the evaluator was created.

" - }, - "updatedAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the evaluator was last updated.

" - }, - "lockedForModification":{ - "shape":"Boolean", - "documentation":"

Whether the evaluator is locked for modification due to being referenced by active online evaluation configurations.

" - }, - "kmsKeyArn":{ - "shape":"KmsKeyArn", - "documentation":"

The Amazon Resource Name (ARN) of the customer managed KMS key used to encrypt the evaluator's sensitive data. This field is only present for evaluators encrypted with a customer managed key.

" - } - } - }, - "GetGatewayRequest":{ - "type":"structure", - "required":["gatewayIdentifier"], - "members":{ - "gatewayIdentifier":{ - "shape":"GatewayIdentifier", - "documentation":"

The identifier of the gateway to retrieve.

", - "location":"uri", - "locationName":"gatewayIdentifier" - } - } - }, - "GetGatewayResponse":{ - "type":"structure", - "required":[ - "gatewayArn", - "gatewayId", - "createdAt", - "updatedAt", - "status", - "name", - "authorizerType" - ], - "members":{ - "gatewayArn":{ - "shape":"GatewayArn", - "documentation":"

The Amazon Resource Name (ARN) of the gateway.

" - }, - "gatewayId":{ - "shape":"GatewayId", - "documentation":"

The unique identifier of the gateway.

" - }, - "gatewayUrl":{ - "shape":"GatewayUrl", - "documentation":"

An endpoint for invoking gateway.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the gateway was created.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the gateway was last updated.

" - }, - "status":{ - "shape":"GatewayStatus", - "documentation":"

The current status of the gateway.

" - }, - "statusReasons":{ - "shape":"StatusReasons", - "documentation":"

The reasons for the current status of the gateway.

" - }, - "name":{ - "shape":"GatewayName", - "documentation":"

The name of the gateway.

" - }, - "description":{ - "shape":"GatewayDescription", - "documentation":"

The description of the gateway.

" - }, - "roleArn":{ - "shape":"RoleArn", - "documentation":"

The IAM role ARN that provides permissions for the gateway.

" - }, - "protocolType":{ - "shape":"GatewayProtocolType", - "documentation":"

Protocol applied to a gateway.

" - }, - "protocolConfiguration":{"shape":"GatewayProtocolConfiguration"}, - "authorizerType":{ - "shape":"AuthorizerType", - "documentation":"

Authorizer type for the gateway.

" - }, - "authorizerConfiguration":{ - "shape":"AuthorizerConfiguration", - "documentation":"

The authorizer configuration for the gateway.

" - }, - "kmsKeyArn":{ - "shape":"KmsKeyArn", - "documentation":"

The Amazon Resource Name (ARN) of the KMS key used to encrypt the gateway.

" - }, - "customTransformConfiguration":{ - "shape":"CustomTransformConfiguration", - "documentation":"

The custom transformation configuration for the gateway. This configuration defines how the gateway transforms requests and responses.

" - }, - "interceptorConfigurations":{ - "shape":"GatewayInterceptorConfigurations", - "documentation":"

The interceptors configured on the gateway.

" - }, - "policyEngineConfiguration":{ - "shape":"GatewayPolicyEngineConfiguration", - "documentation":"

The policy engine configuration for the gateway.

" - }, - "workloadIdentityDetails":{ - "shape":"WorkloadIdentityDetails", - "documentation":"

The workload identity details for the gateway.

" - }, - "exceptionLevel":{ - "shape":"ExceptionLevel", - "documentation":"

The level of detail in error messages returned when invoking the gateway.

  • If the value is DEBUG, granular exception messages are returned to help a user debug the gateway.

  • If the value is omitted, a generic error message is returned to the end user.

" - }, - "webAclArn":{ - "shape":"WebAclArn", - "documentation":"

The Amazon Resource Name (ARN) of the Amazon Web Services WAF web ACL associated with the gateway.

" - }, - "wafConfiguration":{ - "shape":"WafConfiguration", - "documentation":"

The Amazon Web Services WAF configuration for the gateway.

" - } - } - }, - "GetGatewayRuleRequest":{ - "type":"structure", - "required":[ - "gatewayIdentifier", - "ruleId" - ], - "members":{ - "gatewayIdentifier":{ - "shape":"GatewayIdentifier", - "documentation":"

The identifier of the gateway containing the rule.

", - "location":"uri", - "locationName":"gatewayIdentifier" - }, - "ruleId":{ - "shape":"GatewayRuleId", - "documentation":"

The unique identifier of the rule to retrieve.

", - "location":"uri", - "locationName":"ruleId" - } - } - }, - "GetGatewayRuleResponse":{ - "type":"structure", - "required":[ - "ruleId", - "gatewayArn", - "priority", - "actions", - "createdAt", - "status" - ], - "members":{ - "ruleId":{ - "shape":"GatewayRuleId", - "documentation":"

The unique identifier of the gateway rule.

" - }, - "gatewayArn":{ - "shape":"GatewayArn", - "documentation":"

The Amazon Resource Name (ARN) of the gateway that the rule belongs to.

" - }, - "priority":{ - "shape":"GatewayRulePriority", - "documentation":"

The priority of the rule. Rules are evaluated in order of priority, with lower numbers evaluated first.

" - }, - "conditions":{ - "shape":"Conditions", - "documentation":"

The conditions that must be met for the rule to apply.

" - }, - "actions":{ - "shape":"Actions", - "documentation":"

The actions to take when the rule conditions are met.

" - }, - "description":{ - "shape":"GatewayRuleDescription", - "documentation":"

The description of the gateway rule.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the rule was created.

" - }, - "status":{ - "shape":"GatewayRuleStatus", - "documentation":"

The current status of the rule.

" - }, - "system":{ - "shape":"SystemManagedBlock", - "documentation":"

System-managed metadata for rules created by automated processes.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the rule was last updated.

" - } - }, - "documentation":"

Create response excludes updatedAt (redundant on create). Get/Update responses include it via their own output structures.

" - }, - "GetGatewayTargetRequest":{ - "type":"structure", - "required":[ - "gatewayIdentifier", - "targetId" - ], - "members":{ - "gatewayIdentifier":{ - "shape":"GatewayIdentifier", - "documentation":"

The identifier of the gateway that contains the target.

", - "location":"uri", - "locationName":"gatewayIdentifier" - }, - "targetId":{ - "shape":"TargetId", - "documentation":"

The unique identifier of the target to retrieve.

", - "location":"uri", - "locationName":"targetId" - } - } - }, - "GetGatewayTargetResponse":{ - "type":"structure", - "required":[ - "gatewayArn", - "targetId", - "createdAt", - "updatedAt", - "status", - "name", - "targetConfiguration", - "credentialProviderConfigurations" - ], - "members":{ - "gatewayArn":{ - "shape":"GatewayArn", - "documentation":"

The Amazon Resource Name (ARN) of the gateway.

" - }, - "targetId":{ - "shape":"TargetId", - "documentation":"

The unique identifier of the gateway target.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the gateway target was created.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the gateway target was last updated.

" - }, - "status":{ - "shape":"TargetStatus", - "documentation":"

The current status of the gateway target.

" - }, - "statusReasons":{ - "shape":"StatusReasons", - "documentation":"

The reasons for the current status of the gateway target.

" - }, - "name":{ - "shape":"TargetName", - "documentation":"

The name of the gateway target.

" - }, - "description":{ - "shape":"TargetDescription", - "documentation":"

The description of the gateway target.

" - }, - "targetConfiguration":{"shape":"TargetConfiguration"}, - "credentialProviderConfigurations":{ - "shape":"CredentialProviderConfigurations", - "documentation":"

The credential provider configurations for the gateway target.

" - }, - "lastSynchronizedAt":{ - "shape":"DateTimestamp", - "documentation":"

The last synchronization of the target.

" - }, - "metadataConfiguration":{ - "shape":"MetadataConfiguration", - "documentation":"

The metadata configuration for HTTP header and query parameter propagation for the retrieved gateway target.

" - }, - "privateEndpoint":{ - "shape":"PrivateEndpoint", - "documentation":"

The private endpoint configuration for the gateway target.

" - }, - "privateEndpointManagedResources":{ - "shape":"PrivateEndpointManagedResources", - "documentation":"

The managed resources created by the gateway for private endpoint connectivity.

" - }, - "authorizationData":{ - "shape":"AuthorizationData", - "documentation":"

OAuth2 authorization data for the gateway target. This data is returned when a target is configured with a credential provider with authorization code grant type and requires user federation.

" - }, - "protocolType":{ - "shape":"TargetProtocolType", - "documentation":"

The protocol type of the gateway target.

" - } - } - }, - "GetHarnessEndpointRequest":{ - "type":"structure", - "required":[ - "harnessId", - "endpointName" - ], - "members":{ - "harnessId":{ - "shape":"HarnessId", - "documentation":"

The ID of the harness that the endpoint belongs to.

", - "location":"uri", - "locationName":"harnessId" - }, - "endpointName":{ - "shape":"HarnessEndpointName", - "documentation":"

The name of the endpoint to retrieve.

", - "location":"uri", - "locationName":"endpointName" - } - } - }, - "GetHarnessEndpointResponse":{ - "type":"structure", - "required":["endpoint"], - "members":{ - "endpoint":{ - "shape":"HarnessEndpoint", - "documentation":"

The endpoint resource.

" - } - } - }, - "GetHarnessRequest":{ - "type":"structure", - "required":["harnessId"], - "members":{ - "harnessId":{ - "shape":"HarnessId", - "documentation":"

The ID of the harness to retrieve.

", - "location":"uri", - "locationName":"harnessId" - }, - "harnessVersion":{ - "shape":"HarnessVersion", - "documentation":"

Specific version of the harness to retrieve. If omitted, returns the current Harness configuration, including its status.

", - "location":"querystring", - "locationName":"harnessVersion" - } - } - }, - "GetHarnessResponse":{ - "type":"structure", - "required":["harness"], - "members":{ - "harness":{ - "shape":"Harness", - "documentation":"

The harness resource.

" - } - } - }, - "GetMemoryInput":{ - "type":"structure", - "required":["memoryId"], - "members":{ - "memoryId":{ - "shape":"MemoryId", - "documentation":"

The unique identifier of the memory to retrieve.

", - "location":"uri", - "locationName":"memoryId" - }, - "view":{ - "shape":"MemoryView", - "documentation":"

The level of detail to return for the memory.

", - "location":"querystring", - "locationName":"view" - } - } - }, - "GetMemoryOutput":{ - "type":"structure", - "required":["memory"], - "members":{ - "memory":{ - "shape":"Memory", - "documentation":"

The retrieved AgentCore Memory resource details.

" - } - } - }, - "GetOauth2CredentialProviderRequest":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{ - "shape":"CredentialProviderName", - "documentation":"

The name of the OAuth2 credential provider to retrieve.

" - } - } - }, - "GetOauth2CredentialProviderResponse":{ - "type":"structure", - "required":[ - "clientSecretArn", - "name", - "credentialProviderArn", - "credentialProviderVendor", - "oauth2ProviderConfigOutput", - "createdTime", - "lastUpdatedTime" - ], - "members":{ - "clientSecretArn":{ - "shape":"Secret", - "documentation":"

The Amazon Resource Name (ARN) of the client secret in Amazon Web Services Secrets Manager.

" - }, - "clientSecretJsonKey":{ - "shape":"SecretJsonKeyType", - "documentation":"

The JSON key used to extract the client secret value from the Amazon Web Services Secrets Manager secret.

" - }, - "clientSecretSource":{ - "shape":"SecretSourceType", - "documentation":"

The source type of the client secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager.

" - }, - "name":{ - "shape":"CredentialProviderName", - "documentation":"

The name of the OAuth2 credential provider.

" - }, - "credentialProviderArn":{ - "shape":"CredentialProviderArnType", - "documentation":"

ARN of the credential provider requested.

" - }, - "credentialProviderVendor":{ - "shape":"CredentialProviderVendorType", - "documentation":"

The vendor of the OAuth2 credential provider.

" - }, - "callbackUrl":{ - "shape":"String", - "documentation":"

Callback URL to register on the OAuth2 credential provider as an allowed callback URL. This URL is where the OAuth2 authorization server redirects users after they complete the authorization flow.

" - }, - "oauth2ProviderConfigOutput":{ - "shape":"Oauth2ProviderConfigOutput", - "documentation":"

The configuration output for the OAuth2 provider.

" - }, - "createdTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the OAuth2 credential provider was created.

" - }, - "lastUpdatedTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the OAuth2 credential provider was last updated.

" - }, - "status":{ - "shape":"Status", - "documentation":"

The current status of the OAuth2 credential provider.

" - }, - "failureReason":{ - "shape":"String", - "documentation":"

The reason for failure if the OAuth2 credential provider is in a failed state.

" - } - } - }, - "GetOnlineEvaluationConfigRequest":{ - "type":"structure", - "required":["onlineEvaluationConfigId"], - "members":{ - "onlineEvaluationConfigId":{ - "shape":"OnlineEvaluationConfigId", - "documentation":"

The unique identifier of the online evaluation configuration to retrieve.

", - "location":"uri", - "locationName":"onlineEvaluationConfigId" - } - } - }, - "GetOnlineEvaluationConfigResponse":{ - "type":"structure", - "required":[ - "onlineEvaluationConfigArn", - "onlineEvaluationConfigId", - "onlineEvaluationConfigName", - "rule", - "dataSourceConfig", - "status", - "executionStatus", - "createdAt", - "updatedAt" - ], - "members":{ - "onlineEvaluationConfigArn":{ - "shape":"OnlineEvaluationConfigArn", - "documentation":"

The Amazon Resource Name (ARN) of the online evaluation configuration.

" - }, - "onlineEvaluationConfigId":{ - "shape":"OnlineEvaluationConfigId", - "documentation":"

The unique identifier of the online evaluation configuration.

" - }, - "onlineEvaluationConfigName":{ - "shape":"EvaluationConfigName", - "documentation":"

The name of the online evaluation configuration.

" - }, - "description":{ - "shape":"EvaluationConfigDescription", - "documentation":"

The description of the online evaluation configuration.

" - }, - "rule":{ - "shape":"Rule", - "documentation":"

The evaluation rule containing sampling configuration, filters, and session settings.

" - }, - "dataSourceConfig":{ - "shape":"DataSourceConfig", - "documentation":"

The data source configuration specifying CloudWatch log groups and service names to monitor.

" - }, - "evaluators":{ - "shape":"EvaluatorList", - "documentation":"

The list of evaluators applied during online evaluation.

" - }, - "insights":{ - "shape":"InsightList", - "documentation":"

The list of insight types configured for this evaluation.

" - }, - "clusteringConfig":{ - "shape":"ClusteringConfig", - "documentation":"

The clustering configuration for periodic batch evaluation.

" - }, - "outputConfig":{ - "shape":"OutputConfig", - "documentation":"

The output configuration specifying where evaluation results are written.

" - }, - "evaluationExecutionRoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the IAM role used for evaluation execution.

" - }, - "status":{ - "shape":"OnlineEvaluationConfigStatus", - "documentation":"

The status of the online evaluation configuration.

" - }, - "executionStatus":{ - "shape":"OnlineEvaluationExecutionStatus", - "documentation":"

The execution status indicating whether the online evaluation is currently running.

" - }, - "createdAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the online evaluation configuration was created.

" - }, - "updatedAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the online evaluation configuration was last updated.

" - }, - "failureReason":{ - "shape":"String", - "documentation":"

The reason for failure if the online evaluation configuration execution failed.

" - } - } - }, - "GetPaymentConnectorRequest":{ - "type":"structure", - "required":[ - "paymentManagerId", - "paymentConnectorId" - ], - "members":{ - "paymentManagerId":{ - "shape":"PaymentManagerId", - "documentation":"

The unique identifier of the parent payment manager.

", - "location":"uri", - "locationName":"paymentManagerId" - }, - "paymentConnectorId":{ - "shape":"PaymentConnectorId", - "documentation":"

The unique identifier of the payment connector to retrieve.

", - "location":"uri", - "locationName":"paymentConnectorId" - } - } - }, - "GetPaymentConnectorResponse":{ - "type":"structure", - "required":[ - "paymentConnectorId", - "name", - "type", - "credentialProviderConfigurations", - "createdAt", - "lastUpdatedAt", - "status" - ], - "members":{ - "paymentConnectorId":{ - "shape":"PaymentConnectorId", - "documentation":"

The unique identifier of the payment connector.

" - }, - "name":{ - "shape":"PaymentConnectorName", - "documentation":"

The name of the payment connector.

" - }, - "description":{ - "shape":"PaymentsDescription", - "documentation":"

The description of the payment connector.

" - }, - "type":{ - "shape":"PaymentConnectorType", - "documentation":"

The type of the payment connector, which determines the payment provider integration.

" - }, - "credentialProviderConfigurations":{ - "shape":"CredentialsProviderConfigurations", - "documentation":"

The credential provider configurations for the payment connector.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the payment connector was created.

" - }, - "lastUpdatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the payment connector was last updated.

" - }, - "status":{ - "shape":"PaymentConnectorStatus", - "documentation":"

The current status of the payment connector. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.

" - } - } - }, - "GetPaymentCredentialProviderRequest":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{ - "shape":"CredentialProviderName", - "documentation":"

The name of the payment credential provider to retrieve.

" - } - } - }, - "GetPaymentCredentialProviderResponse":{ - "type":"structure", - "required":[ - "name", - "credentialProviderArn", - "credentialProviderVendor", - "providerConfigurationOutput", - "createdTime", - "lastUpdatedTime" - ], - "members":{ - "name":{ - "shape":"CredentialProviderName", - "documentation":"

The name of the payment credential provider.

" - }, - "credentialProviderArn":{ - "shape":"PaymentCredentialProviderArnType", - "documentation":"

The Amazon Resource Name (ARN) of the payment credential provider.

" - }, - "credentialProviderVendor":{ - "shape":"PaymentCredentialProviderVendorType", - "documentation":"

The vendor type for the payment credential provider.

" - }, - "providerConfigurationOutput":{ - "shape":"PaymentProviderConfigurationOutput", - "documentation":"

Output configuration (contains secret ARNs, excludes actual secret values).

" - }, - "createdTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the payment credential provider was created.

" - }, - "lastUpdatedTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the payment credential provider was last updated.

" - }, - "tags":{ - "shape":"TagsMap", - "documentation":"

The tags associated with the payment credential provider.

" - } - } - }, - "GetPaymentManagerRequest":{ - "type":"structure", - "required":["paymentManagerId"], - "members":{ - "paymentManagerId":{ - "shape":"PaymentManagerId", - "documentation":"

The unique identifier of the payment manager to retrieve.

", - "location":"uri", - "locationName":"paymentManagerId" - } - } - }, - "GetPaymentManagerResponse":{ - "type":"structure", - "required":[ - "paymentManagerArn", - "paymentManagerId", - "name", - "authorizerType", - "roleArn", - "createdAt", - "lastUpdatedAt", - "status" - ], - "members":{ - "paymentManagerArn":{ - "shape":"PaymentManagerArn", - "documentation":"

The Amazon Resource Name (ARN) of the payment manager.

" - }, - "paymentManagerId":{ - "shape":"PaymentManagerId", - "documentation":"

The unique identifier of the payment manager.

" - }, - "name":{ - "shape":"PaymentManagerName", - "documentation":"

The name of the payment manager.

" - }, - "description":{ - "shape":"PaymentsDescription", - "documentation":"

The description of the payment manager.

" - }, - "authorizerType":{ - "shape":"PaymentsAuthorizerType", - "documentation":"

The type of authorizer used by the payment manager.

  • CUSTOM_JWT - Authorize with a bearer token.

  • AWS_IAM - Authorize with your Amazon Web Services IAM credentials.

" - }, - "authorizerConfiguration":{"shape":"AuthorizerConfiguration"}, - "roleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the IAM role associated with the payment manager.

" - }, - "workloadIdentityDetails":{"shape":"WorkloadIdentityDetails"}, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the payment manager was created.

" - }, - "lastUpdatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the payment manager was last updated.

" - }, - "status":{ - "shape":"PaymentManagerStatus", - "documentation":"

The current status of the payment manager. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.

" - }, - "tags":{ - "shape":"TagsMap", - "documentation":"

The tags associated with the payment manager.

" - } - } - }, - "GetPolicyEngineRequest":{ - "type":"structure", - "required":["policyEngineId"], - "members":{ - "policyEngineId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the policy engine to be retrieved. This must be a valid policy engine ID that exists within the account.

", - "location":"uri", - "locationName":"policyEngineId" - } - } - }, - "GetPolicyEngineResponse":{ - "type":"structure", - "required":[ - "policyEngineId", - "name", - "createdAt", - "updatedAt", - "policyEngineArn", - "status", - "statusReasons" - ], - "members":{ - "policyEngineId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the retrieved policy engine. This matches the policy engine ID provided in the request and serves as the system identifier.

" - }, - "name":{ - "shape":"PolicyEngineName", - "documentation":"

The customer-assigned name of the policy engine. This is the human-readable identifier that was specified when the policy engine was created.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the policy engine was originally created.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the policy engine was last modified. This tracks the most recent changes to the policy engine configuration.

" - }, - "policyEngineArn":{ - "shape":"PolicyEngineArn", - "documentation":"

The Amazon Resource Name (ARN) of the policy engine. This globally unique identifier can be used for cross-service references and IAM policy statements.

" - }, - "status":{ - "shape":"PolicyEngineStatus", - "documentation":"

The current status of the policy engine.

" - }, - "encryptionKeyArn":{ - "shape":"KmsKeyArn", - "documentation":"

The Amazon Resource Name (ARN) of the KMS key used to encrypt the policy engine data.

" - }, - "description":{ - "shape":"Description", - "documentation":"

The human-readable description of the policy engine's purpose and scope. This helps administrators understand the policy engine's role in governance.

" - }, - "statusReasons":{ - "shape":"PolicyStatusReasons", - "documentation":"

Additional information about the policy engine status. This provides details about any failures or the current state of the policy engine.

" - } - } - }, - "GetPolicyEngineSummaryRequest":{ - "type":"structure", - "required":["policyEngineId"], - "members":{ - "policyEngineId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the policy engine to retrieve the summary for. This must be a valid policy engine ID that exists within the account.

", - "location":"uri", - "locationName":"policyEngineId" - } - } - }, - "GetPolicyEngineSummaryResponse":{ - "type":"structure", - "required":[ - "policyEngineId", - "name", - "createdAt", - "updatedAt", - "policyEngineArn", - "status" - ], - "members":{ - "policyEngineId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the policy engine.

" - }, - "name":{ - "shape":"PolicyEngineName", - "documentation":"

The customer-assigned name of the policy engine.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the policy engine was originally created.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the policy engine was last modified.

" - }, - "policyEngineArn":{ - "shape":"PolicyEngineArn", - "documentation":"

The Amazon Resource Name (ARN) of the policy engine.

" - }, - "status":{ - "shape":"PolicyEngineStatus", - "documentation":"

The current status of the policy engine.

" - }, - "encryptionKeyArn":{ - "shape":"KmsKeyArn", - "documentation":"

The Amazon Resource Name (ARN) of the KMS key used to encrypt the policy engine data.

" - } - } - }, - "GetPolicyGenerationRequest":{ - "type":"structure", - "required":[ - "policyGenerationId", - "policyEngineId" - ], - "members":{ - "policyGenerationId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the policy generation request to be retrieved. This must be a valid generation ID from a previous StartPolicyGeneration call.

", - "location":"uri", - "locationName":"policyGenerationId" - }, - "policyEngineId":{ - "shape":"ResourceId", - "documentation":"

The identifier of the policy engine associated with the policy generation request. This provides the context for the generation operation and schema validation.

", - "location":"uri", - "locationName":"policyEngineId" - } - } - }, - "GetPolicyGenerationResponse":{ - "type":"structure", - "required":[ - "policyEngineId", - "policyGenerationId", - "name", - "policyGenerationArn", - "resource", - "createdAt", - "updatedAt", - "status", - "statusReasons" - ], - "members":{ - "policyEngineId":{ - "shape":"ResourceId", - "documentation":"

The identifier of the policy engine associated with this policy generation. This confirms the policy engine context for the generation operation.

" - }, - "policyGenerationId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the policy generation request. This matches the generation ID provided in the request and serves as the tracking identifier.

" - }, - "name":{ - "shape":"PolicyGenerationName", - "documentation":"

The customer-assigned name for the policy generation request. This helps identify and track generation operations across multiple requests.

" - }, - "policyGenerationArn":{ - "shape":"PolicyGenerationArn", - "documentation":"

The Amazon Resource Name (ARN) of the policy generation. This globally unique identifier can be used for tracking, auditing, and cross-service references.

" - }, - "resource":{ - "shape":"Resource", - "documentation":"

The resource information associated with the policy generation. This provides context about the target resources for which the policies are being generated.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the policy generation request was created. This is used for tracking and auditing generation operations and their lifecycle.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the policy generation was last updated. This tracks the progress of the generation process and any status changes.

" - }, - "status":{ - "shape":"PolicyGenerationStatus", - "documentation":"

The current status of the policy generation. This indicates whether the generation is in progress, completed successfully, or failed during processing.

" - }, - "findings":{ - "shape":"String", - "documentation":"

The findings and results from the policy generation process. This includes any issues, recommendations, validation results, or insights from the generated policies.

" - }, - "statusReasons":{ - "shape":"PolicyStatusReasons", - "documentation":"

Additional information about the generation status. This provides details about any failures, warnings, or the current state of the generation process.

" - } - } - }, - "GetPolicyGenerationSummaryRequest":{ - "type":"structure", - "required":[ - "policyGenerationId", - "policyEngineId" - ], - "members":{ - "policyGenerationId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the policy generation request to retrieve the summary for.

", - "location":"uri", - "locationName":"policyGenerationId" - }, - "policyEngineId":{ - "shape":"ResourceId", - "documentation":"

The identifier of the policy engine associated with the policy generation request.

", - "location":"uri", - "locationName":"policyEngineId" - } - } - }, - "GetPolicyGenerationSummaryResponse":{ - "type":"structure", - "required":[ - "policyEngineId", - "policyGenerationId", - "name", - "policyGenerationArn", - "resource", - "createdAt", - "updatedAt", - "status" - ], - "members":{ - "policyEngineId":{ - "shape":"ResourceId", - "documentation":"

The identifier of the policy engine associated with this policy generation.

" - }, - "policyGenerationId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the policy generation request.

" - }, - "name":{ - "shape":"PolicyGenerationName", - "documentation":"

The customer-assigned name for the policy generation request.

" - }, - "policyGenerationArn":{ - "shape":"PolicyGenerationArn", - "documentation":"

The Amazon Resource Name (ARN) of the policy generation request.

" - }, - "resource":{ - "shape":"Resource", - "documentation":"

The resource information associated with the policy generation.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the policy generation request was created.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the policy generation was last updated.

" - }, - "status":{ - "shape":"PolicyGenerationStatus", - "documentation":"

The current status of the policy generation request.

" - }, - "findings":{ - "shape":"String", - "documentation":"

The findings from the policy generation process, if available.

" - } - } - }, - "GetPolicyRequest":{ - "type":"structure", - "required":[ - "policyEngineId", - "policyId" - ], - "members":{ - "policyEngineId":{ - "shape":"ResourceId", - "documentation":"

The identifier of the policy engine that manages the policy to be retrieved.

", - "location":"uri", - "locationName":"policyEngineId" - }, - "policyId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the policy to be retrieved. This must be a valid policy ID that exists within the specified policy engine.

", - "location":"uri", - "locationName":"policyId" - } - } - }, - "GetPolicyResponse":{ - "type":"structure", - "required":[ - "policyId", - "name", - "policyEngineId", - "createdAt", - "updatedAt", - "policyArn", - "status", - "definition", - "statusReasons" - ], - "members":{ - "policyId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the retrieved policy. This matches the policy ID provided in the request and serves as the system identifier for the policy.

" - }, - "name":{ - "shape":"PolicyName", - "documentation":"

The customer-assigned name of the policy. This is the human-readable identifier that was specified when the policy was created.

" - }, - "policyEngineId":{ - "shape":"ResourceId", - "documentation":"

The identifier of the policy engine that manages this policy. This confirms the policy engine context for the retrieved policy.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the policy was originally created.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the policy was last modified. This tracks the most recent changes to the policy configuration.

" - }, - "policyArn":{ - "shape":"PolicyArn", - "documentation":"

The Amazon Resource Name (ARN) of the policy. This globally unique identifier can be used for cross-service references and IAM policy statements.

" - }, - "status":{ - "shape":"PolicyStatus", - "documentation":"

The current status of the policy.

" - }, - "enforcementMode":{ - "shape":"EnforcementMode", - "documentation":"

The current enforcement mode of the policy.

" - }, - "definition":{ - "shape":"PolicyDefinition", - "documentation":"

The Cedar policy statement that defines the access control rules. This contains the actual policy logic used for agent behavior control and access decisions.

" - }, - "description":{ - "shape":"Description", - "documentation":"

The human-readable description of the policy's purpose and functionality. This helps administrators understand and manage the policy.

" - }, - "statusReasons":{ - "shape":"PolicyStatusReasons", - "documentation":"

Additional information about the policy status. This provides details about any failures or the current state of the policy.

" - } - } - }, - "GetPolicySummaryRequest":{ - "type":"structure", - "required":[ - "policyEngineId", - "policyId" - ], - "members":{ - "policyEngineId":{ - "shape":"ResourceId", - "documentation":"

The identifier of the policy engine that manages the policy to retrieve the summary for.

", - "location":"uri", - "locationName":"policyEngineId" - }, - "policyId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the policy to retrieve the summary for. This must be a valid policy ID that exists within the specified policy engine.

", - "location":"uri", - "locationName":"policyId" - } - } - }, - "GetPolicySummaryResponse":{ - "type":"structure", - "required":[ - "policyId", - "name", - "policyEngineId", - "createdAt", - "updatedAt", - "policyArn", - "status" - ], - "members":{ - "policyId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the policy.

" - }, - "name":{ - "shape":"PolicyName", - "documentation":"

The customer-assigned name of the policy.

" - }, - "policyEngineId":{ - "shape":"ResourceId", - "documentation":"

The identifier of the policy engine that manages this policy.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the policy was originally created.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the policy was last modified.

" - }, - "policyArn":{ - "shape":"PolicyArn", - "documentation":"

The Amazon Resource Name (ARN) of the policy.

" - }, - "status":{ - "shape":"PolicyStatus", - "documentation":"

The current status of the policy.

" - }, - "enforcementMode":{ - "shape":"EnforcementMode", - "documentation":"

The current enforcement mode of the policy.

" - } - } - }, - "GetRegistryRecordRequest":{ - "type":"structure", - "required":[ - "registryId", - "recordId" - ], - "members":{ - "registryId":{ - "shape":"RegistryIdentifier", - "documentation":"

The identifier of the registry containing the record. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.

", - "location":"uri", - "locationName":"registryId" - }, - "recordId":{ - "shape":"RecordIdentifier", - "documentation":"

The identifier of the registry record to retrieve. You can specify either the Amazon Resource Name (ARN) or the ID of the record.

", - "location":"uri", - "locationName":"recordId" - } - } - }, - "GetRegistryRecordResponse":{ - "type":"structure", - "required":[ - "registryArn", - "recordArn", - "recordId", - "name", - "descriptorType", - "descriptors", - "status", - "createdAt", - "updatedAt" - ], - "members":{ - "registryArn":{ - "shape":"RegistryArn", - "documentation":"

The Amazon Resource Name (ARN) of the registry that contains the record.

" - }, - "recordArn":{ - "shape":"RegistryRecordArn", - "documentation":"

The Amazon Resource Name (ARN) of the registry record.

" - }, - "recordId":{ - "shape":"RegistryRecordId", - "documentation":"

The unique identifier of the registry record.

" - }, - "name":{ - "shape":"RegistryRecordName", - "documentation":"

The name of the registry record.

" - }, - "description":{ - "shape":"Description", - "documentation":"

The description of the registry record.

" - }, - "descriptorType":{ - "shape":"DescriptorType", - "documentation":"

The descriptor type of the registry record. Possible values are MCP, A2A, CUSTOM, and AGENT_SKILLS.

" - }, - "descriptors":{ - "shape":"Descriptors", - "documentation":"

The descriptor-type-specific configuration containing the resource schema and metadata. For details, see the Descriptors data type.

" - }, - "recordVersion":{ - "shape":"RegistryRecordVersion", - "documentation":"

The version of the registry record.

" - }, - "status":{ - "shape":"RegistryRecordStatus", - "documentation":"

The current status of the registry record. Possible values include CREATING, DRAFT, APPROVED, PENDING_APPROVAL, REJECTED, DEPRECATED, UPDATING, CREATE_FAILED, and UPDATE_FAILED. A record transitions from CREATING to DRAFT, then to PENDING_APPROVAL (via SubmitRegistryRecordForApproval), and finally to APPROVED upon approval.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the registry record was created.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the registry record was last updated.

" - }, - "statusReason":{ - "shape":"String", - "documentation":"

The reason for the current status, typically set when the status is a failure state.

" - }, - "synchronizationType":{ - "shape":"SynchronizationType", - "documentation":"

The type of synchronization used for this record.

" - }, - "synchronizationConfiguration":{ - "shape":"SynchronizationConfiguration", - "documentation":"

The configuration for synchronizing registry record metadata from an external source.

" - } - } - }, - "GetRegistryRequest":{ - "type":"structure", - "required":["registryId"], - "members":{ - "registryId":{ - "shape":"RegistryIdentifier", - "documentation":"

The identifier of the registry to retrieve. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.

", - "location":"uri", - "locationName":"registryId" - } - } - }, - "GetRegistryResponse":{ - "type":"structure", - "required":[ - "name", - "registryId", - "registryArn", - "status", - "createdAt", - "updatedAt" - ], - "members":{ - "name":{ - "shape":"RegistryName", - "documentation":"

The name of the registry.

" - }, - "description":{ - "shape":"Description", - "documentation":"

The description of the registry.

" - }, - "registryId":{ - "shape":"RegistryId", - "documentation":"

The unique identifier of the registry.

" - }, - "registryArn":{ - "shape":"RegistryArn", - "documentation":"

The Amazon Resource Name (ARN) of the registry.

" - }, - "authorizerType":{ - "shape":"RegistryAuthorizerType", - "documentation":"

The type of authorizer used by the registry. This controls the authorization method for the Search and Invoke APIs used by consumers.

  • CUSTOM_JWT - Authorize with a bearer token.

  • AWS_IAM - Authorize with your Amazon Web Services IAM credentials.

" - }, - "authorizerConfiguration":{ - "shape":"AuthorizerConfiguration", - "documentation":"

The authorizer configuration for the registry. For details, see the AuthorizerConfiguration data type.

" - }, - "approvalConfiguration":{ - "shape":"ApprovalConfiguration", - "documentation":"

The approval configuration for registry records. For details, see the ApprovalConfiguration data type.

" - }, - "status":{ - "shape":"RegistryStatus", - "documentation":"

The current status of the registry. Possible values include CREATING, READY, UPDATING, CREATE_FAILED, UPDATE_FAILED, DELETING, and DELETE_FAILED.

" - }, - "statusReason":{ - "shape":"String", - "documentation":"

The reason for the current status, typically set when the status is a failure state.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the registry was created.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the registry was last updated.

" - } - } - }, - "GetResourcePolicyRequest":{ - "type":"structure", - "required":["resourceArn"], - "members":{ - "resourceArn":{ - "shape":"BedrockAgentcoreResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the resource for which to retrieve the resource policy.

", - "location":"uri", - "locationName":"resourceArn" - } - } - }, - "GetResourcePolicyResponse":{ - "type":"structure", - "members":{ - "policy":{ - "shape":"ResourcePolicyBody", - "documentation":"

The resource policy associated with the specified resource.

" - } - } - }, - "GetTokenVaultRequest":{ - "type":"structure", - "members":{ - "tokenVaultId":{ - "shape":"TokenVaultIdType", - "documentation":"

The unique identifier of the token vault to retrieve.

" - } - } - }, - "GetTokenVaultResponse":{ - "type":"structure", - "required":[ - "tokenVaultId", - "kmsConfiguration", - "lastModifiedDate" - ], - "members":{ - "tokenVaultId":{ - "shape":"TokenVaultIdType", - "documentation":"

The ID of the token vault.

" - }, - "kmsConfiguration":{ - "shape":"KmsConfiguration", - "documentation":"

The KMS configuration for the token vault.

" - }, - "lastModifiedDate":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the token vault was last modified.

" - } - } - }, - "GetWorkloadIdentityRequest":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{ - "shape":"WorkloadIdentityNameType", - "documentation":"

The name of the workload identity to retrieve.

" - } - } - }, - "GetWorkloadIdentityResponse":{ - "type":"structure", - "required":[ - "name", - "workloadIdentityArn", - "createdTime", - "lastUpdatedTime" - ], - "members":{ - "name":{ - "shape":"WorkloadIdentityNameType", - "documentation":"

The name of the workload identity.

" - }, - "workloadIdentityArn":{ - "shape":"WorkloadIdentityArnType", - "documentation":"

The Amazon Resource Name (ARN) of the workload identity.

" - }, - "allowedResourceOauth2ReturnUrls":{ - "shape":"ResourceOauth2ReturnUrlListType", - "documentation":"

The list of allowed OAuth2 return URLs for resources associated with this workload identity.

" - }, - "createdTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the workload identity was created.

" - }, - "lastUpdatedTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the workload identity was last updated.

" - } - } - }, - "GithubOauth2ProviderConfigInput":{ - "type":"structure", - "required":["clientId"], - "members":{ - "clientId":{ - "shape":"ClientIdType", - "documentation":"

The client ID for the GitHub OAuth2 provider.

" - }, - "clientSecret":{ - "shape":"DefaultClientSecretType", - "documentation":"

The client secret for the GitHub OAuth2 provider.

" - }, - "clientSecretConfig":{ - "shape":"SecretReference", - "documentation":"

A reference to the Amazon Web Services Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when clientSecretSource is set to EXTERNAL.

" - }, - "clientSecretSource":{ - "shape":"SecretSourceType", - "documentation":"

The source type of the client secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.

" - } - }, - "documentation":"

Input configuration for a GitHub OAuth2 provider.

" - }, - "GithubOauth2ProviderConfigOutput":{ - "type":"structure", - "required":["oauthDiscovery"], - "members":{ - "oauthDiscovery":{ - "shape":"Oauth2Discovery", - "documentation":"

The OAuth2 discovery information for the GitHub provider.

" - }, - "clientId":{ - "shape":"ClientIdType", - "documentation":"

The client ID for the GitHub OAuth2 provider.

" - } - }, - "documentation":"

Output configuration for a GitHub OAuth2 provider.

" - }, - "GoogleOauth2ProviderConfigInput":{ - "type":"structure", - "required":["clientId"], - "members":{ - "clientId":{ - "shape":"ClientIdType", - "documentation":"

The client ID for the Google OAuth2 provider.

" - }, - "clientSecret":{ - "shape":"DefaultClientSecretType", - "documentation":"

The client secret for the Google OAuth2 provider.

" - }, - "clientSecretConfig":{ - "shape":"SecretReference", - "documentation":"

A reference to the Amazon Web Services Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when clientSecretSource is set to EXTERNAL.

" - }, - "clientSecretSource":{ - "shape":"SecretSourceType", - "documentation":"

The source type of the client secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.

" - } - }, - "documentation":"

Input configuration for a Google OAuth2 provider.

" - }, - "GoogleOauth2ProviderConfigOutput":{ - "type":"structure", - "required":["oauthDiscovery"], - "members":{ - "oauthDiscovery":{ - "shape":"Oauth2Discovery", - "documentation":"

The OAuth2 discovery information for the Google provider.

" - }, - "clientId":{ - "shape":"ClientIdType", - "documentation":"

The client ID for the Google OAuth2 provider.

" - } - }, - "documentation":"

Output configuration for a Google OAuth2 provider.

" - }, - "Harness":{ - "type":"structure", - "required":[ - "harnessId", - "harnessName", - "arn", - "status", - "executionRoleArn", - "createdAt", - "updatedAt", - "model", - "systemPrompt", - "tools", - "skills", - "allowedTools", - "truncation", - "environment" - ], - "members":{ - "harnessId":{ - "shape":"HarnessId", - "documentation":"

The ID of the harness.

" - }, - "harnessName":{ - "shape":"HarnessName", - "documentation":"

The name of the harness.

" - }, - "arn":{ - "shape":"HarnessArn", - "documentation":"

The ARN of the harness.

" - }, - "status":{ - "shape":"HarnessStatus", - "documentation":"

The status of the harness.

" - }, - "harnessVersion":{ - "shape":"HarnessVersion", - "documentation":"

The version of the harness. Incremented on every successful UpdateHarness.

" - }, - "executionRoleArn":{ - "shape":"RoleArn", - "documentation":"

IAM role the harness assumes when running.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The createdAt time of the harness.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The updatedAt time of the harness.

" - }, - "model":{ - "shape":"HarnessModelConfiguration", - "documentation":"

The configuration of the default model used by the Harness.

" - }, - "systemPrompt":{ - "shape":"HarnessSystemPrompt", - "documentation":"

The system prompt of the harness.

" - }, - "tools":{ - "shape":"HarnessTools", - "documentation":"

The tools of the harness.

" - }, - "skills":{ - "shape":"HarnessSkills", - "documentation":"

The skills of the harness.

" - }, - "allowedTools":{ - "shape":"HarnessAllowedTools", - "documentation":"

The allowed tools of the harness. All tools are allowed by default.

" - }, - "truncation":{ - "shape":"HarnessTruncationConfiguration", - "documentation":"

Configuration for truncating model context.

" - }, - "environment":{ - "shape":"HarnessEnvironmentProvider", - "documentation":"

The compute environment on which the Harness runs.

" - }, - "environmentArtifact":{ - "shape":"HarnessEnvironmentArtifact", - "documentation":"

The environment artifact (e.g., container) in which the Harness operates.

" - }, - "environmentVariables":{ - "shape":"EnvironmentVariablesMap", - "documentation":"

Environment variables exposed in the environment in which the harness operates.

" - }, - "authorizerConfiguration":{"shape":"AuthorizerConfiguration"}, - "memory":{ - "shape":"HarnessMemoryConfiguration", - "documentation":"

AgentCore Memory instance configuration for short and long term memory.

" - }, - "maxIterations":{ - "shape":"Integer", - "documentation":"

The maximum number of iterations in the agent loop allowed before exiting per invocation.

" - }, - "maxTokens":{ - "shape":"Integer", - "documentation":"

The maximum total number of output tokens the agent can generate across all model calls within a single invocation.

" - }, - "timeoutSeconds":{ - "shape":"Integer", - "documentation":"

The maximum duration per invocation.

" - }, - "failureReason":{ - "shape":"String", - "documentation":"

Reason why create or update operations fail.

" - } - }, - "documentation":"

Representation of a harness.

" - }, - "HarnessAgentCoreBrowserConfig":{ - "type":"structure", - "members":{ - "browserArn":{ - "shape":"HarnessBrowserArn", - "documentation":"

If not populated, the built-in Browser ARN is used.

" - } - }, - "documentation":"

Configuration for AgentCore Browser.

" - }, - "HarnessAgentCoreCodeInterpreterConfig":{ - "type":"structure", - "members":{ - "codeInterpreterArn":{ - "shape":"HarnessCodeInterpreterArn", - "documentation":"

If not populated, the built-in Code Interpreter ARN is used.

" - } - }, - "documentation":"

Configuration for AgentCore Code Interpreter.

" - }, - "HarnessAgentCoreGatewayConfig":{ - "type":"structure", - "required":["gatewayArn"], - "members":{ - "gatewayArn":{ - "shape":"GatewayArn", - "documentation":"

The ARN of the desired AgentCore Gateway.

" - }, - "outboundAuth":{ - "shape":"HarnessGatewayOutboundAuth", - "documentation":"

How harness authenticates to this Gateway. Defaults to AWS_IAM (SigV4) if omitted.

" - } - }, - "documentation":"

Configuration for AgentCore Gateway.

" - }, - "HarnessAgentCoreMemoryConfiguration":{ - "type":"structure", - "required":["arn"], - "members":{ - "arn":{ - "shape":"MemoryArn", - "documentation":"

The ARN of the AgentCore Memory resource.

" - }, - "actorId":{ - "shape":"String", - "documentation":"

The actor ID for memory operations.

" - }, - "messagesCount":{ - "shape":"Integer", - "documentation":"

The number of messages to retrieve from memory.

" - }, - "retrievalConfig":{ - "shape":"HarnessAgentCoreMemoryRetrievalConfigs", - "documentation":"

The retrieval configuration for long-term memory, mapping namespace path templates to retrieval settings.

" - } - }, - "documentation":"

Configuration for AgentCore Memory integration.

" - }, - "HarnessAgentCoreMemoryRetrievalConfig":{ - "type":"structure", - "members":{ - "topK":{ - "shape":"Integer", - "documentation":"

The maximum number of memory entries to retrieve.

" - }, - "relevanceScore":{ - "shape":"Float", - "documentation":"

The minimum relevance score for retrieved memories.

" - }, - "strategyId":{ - "shape":"String", - "documentation":"

The ID of the retrieval strategy to use.

" - } - }, - "documentation":"

Configuration for memory retrieval within a namespace.

" - }, - "HarnessAgentCoreMemoryRetrievalConfigs":{ - "type":"map", - "key":{"shape":"String"}, - "value":{"shape":"HarnessAgentCoreMemoryRetrievalConfig"} - }, - "HarnessAgentCoreRuntimeEnvironment":{ - "type":"structure", - "required":[ - "agentRuntimeArn", - "agentRuntimeName", - "agentRuntimeId", - "lifecycleConfiguration", - "networkConfiguration" - ], - "members":{ - "agentRuntimeArn":{ - "shape":"BedrockAgentcoreResourceArn", - "documentation":"

The ARN of the underlying AgentCore Runtime.

" - }, - "agentRuntimeName":{ - "shape":"String", - "documentation":"

The name of the underlying AgentCore Runtime.

" - }, - "agentRuntimeId":{ - "shape":"String", - "documentation":"

The ID of the underlying AgentCore Runtime.

" - }, - "lifecycleConfiguration":{"shape":"LifecycleConfiguration"}, - "networkConfiguration":{"shape":"NetworkConfiguration"}, - "filesystemConfigurations":{ - "shape":"FilesystemConfigurations", - "documentation":"

The filesystem configurations for the runtime environment.

" - } - }, - "documentation":"

The AgentCore Runtime environment for a harness.

" - }, - "HarnessAgentCoreRuntimeEnvironmentRequest":{ - "type":"structure", - "members":{ - "lifecycleConfiguration":{"shape":"LifecycleConfiguration"}, - "networkConfiguration":{"shape":"NetworkConfiguration"}, - "filesystemConfigurations":{ - "shape":"FilesystemConfigurations", - "documentation":"

The filesystem configurations for the runtime environment.

" - } - }, - "documentation":"

The AgentCore Runtime environment request configuration.

" - }, - "HarnessAllowedTool":{ - "type":"string", - "max":64, - "min":1, - "pattern":"(\\*|@?[^/]+(/[^/]+)?)" - }, - "HarnessAllowedTools":{ - "type":"list", - "member":{"shape":"HarnessAllowedTool"} - }, - "HarnessArn":{ - "type":"string", - "pattern":"arn:([^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:harness/[a-zA-Z][a-zA-Z0-9_]{0,39}-[a-zA-Z0-9]{10}" - }, - "HarnessAwsSkillPath":{ - "type":"string", - "max":4096, - "min":1, - "pattern":"([^*?\\[\\]]|\\*)+" - }, - "HarnessAwsSkillPaths":{ - "type":"list", - "member":{"shape":"HarnessAwsSkillPath"} - }, - "HarnessBedrockApiFormat":{ - "type":"string", - "enum":[ - "converse_stream", - "responses", - "chat_completions" - ] - }, - "HarnessBedrockModelConfig":{ - "type":"structure", - "required":["modelId"], - "members":{ - "modelId":{ - "shape":"ModelId", - "documentation":"

The Bedrock model ID.

" - }, - "maxTokens":{ - "shape":"MaxTokens", - "documentation":"

The maximum number of tokens to allow in the generated response per model call.

" - }, - "temperature":{ - "shape":"Temperature", - "documentation":"

The temperature to set when calling the model.

" - }, - "topP":{ - "shape":"TopP", - "documentation":"

The topP set when calling the model.

" - }, - "apiFormat":{ - "shape":"HarnessBedrockApiFormat", - "documentation":"

The API format to use when calling the Bedrock provider.

" - }, - "additionalParams":{ - "shape":"Document", - "documentation":"

Provider-specific parameters passed through to the model provider unchanged.

" - } - }, - "documentation":"

Configuration for an Amazon Bedrock model provider.

" - }, - "HarnessBrowserArn":{ - "type":"string", - "documentation":"

Browser ARN for Harness tool configuration. Accepts both managed (aws.browser.v1) and custom browser ARNs.

", - "pattern":"arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:(aws|[0-9]{12}):browser(-custom)?/(aws\\.browser\\.v1|[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10})" - }, - "HarnessCodeInterpreterArn":{ - "type":"string", - "documentation":"

Code Interpreter ARN for Harness tool configuration. Accepts both managed (aws.codeinterpreter.v1) and custom code interpreter ARNs.

", - "pattern":"arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:(aws|[0-9]{12}):code-interpreter(-custom)?/(aws\\.codeinterpreter\\.v1|[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10})" - }, - "HarnessDisabledMemoryConfiguration":{ - "type":"structure", - "members":{}, - "documentation":"

Explicitly opt out of memory.

" - }, - "HarnessEndpoint":{ - "type":"structure", - "required":[ - "harnessId", - "harnessName", - "endpointName", - "arn", - "status", - "createdAt", - "updatedAt" - ], - "members":{ - "harnessId":{ - "shape":"HarnessId", - "documentation":"

The ID of the harness that the endpoint belongs to.

" - }, - "harnessName":{ - "shape":"HarnessName", - "documentation":"

The name of the harness that the endpoint belongs to.

" - }, - "endpointName":{ - "shape":"HarnessEndpointName", - "documentation":"

The name of the endpoint.

" - }, - "arn":{ - "shape":"HarnessEndpointArn", - "documentation":"

The ARN of the endpoint.

" - }, - "status":{ - "shape":"HarnessEndpointStatus", - "documentation":"

The status of the endpoint.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the endpoint was created.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the endpoint was last updated.

" - }, - "liveVersion":{ - "shape":"HarnessVersion", - "documentation":"

The harness version that the endpoint is currently serving.

" - }, - "targetVersion":{ - "shape":"HarnessVersion", - "documentation":"

The harness version that the endpoint points to. While an update is in progress, this can differ from the live version until the endpoint finishes transitioning.

" - }, - "description":{ - "shape":"HarnessEndpointDescription", - "documentation":"

The description of the endpoint.

" - }, - "failureReason":{ - "shape":"String", - "documentation":"

The reason the endpoint's last create or update operation failed.

" - } - }, - "documentation":"

Representation of a harness endpoint. An endpoint is a named, stable reference to a specific version of a harness that callers invoke, allowing the underlying version to be updated without changing how the agent is invoked.

" - }, - "HarnessEndpointArn":{ - "type":"string", - "pattern":"arn:([^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:harness/[a-zA-Z][a-zA-Z0-9_]{0,39}-[a-zA-Z0-9]{10}/harness-endpoint/[a-zA-Z][a-zA-Z0-9_]{0,47}" - }, - "HarnessEndpointDescription":{ - "type":"string", - "max":256, - "min":1 - }, - "HarnessEndpointName":{ - "type":"string", - "pattern":"[a-zA-Z][a-zA-Z0-9_]{0,47}" - }, - "HarnessEndpointStatus":{ - "type":"string", - "enum":[ - "CREATING", - "CREATE_FAILED", - "UPDATING", - "UPDATE_FAILED", - "READY", - "DELETING", - "DELETE_FAILED" - ] - }, - "HarnessEndpoints":{ - "type":"list", - "member":{"shape":"HarnessEndpoint"} - }, - "HarnessEnvironmentArtifact":{ - "type":"structure", - "members":{ - "containerConfiguration":{"shape":"ContainerConfiguration"} - }, - "documentation":"

The environment artifact for a harness, such as a container image containing custom dependencies.

", - "union":true - }, - "HarnessEnvironmentProvider":{ - "type":"structure", - "members":{ - "agentCoreRuntimeEnvironment":{ - "shape":"HarnessAgentCoreRuntimeEnvironment", - "documentation":"

The AgentCore Runtime environment configuration.

" - } - }, - "documentation":"

The environment provider for a harness.

", - "union":true - }, - "HarnessEnvironmentProviderRequest":{ - "type":"structure", - "members":{ - "agentCoreRuntimeEnvironment":{ - "shape":"HarnessAgentCoreRuntimeEnvironmentRequest", - "documentation":"

The AgentCore Runtime environment configuration.

" - } - }, - "documentation":"

The environment provider request configuration.

", - "union":true - }, - "HarnessGatewayOutboundAuth":{ - "type":"structure", - "members":{ - "awsIam":{ - "shape":"Unit", - "documentation":"

SigV4-sign requests using the agent's execution role.

" - }, - "none":{ - "shape":"Unit", - "documentation":"

No authentication.

" - }, - "oauth":{ - "shape":"OAuthCredentialProvider", - "documentation":"

Use OAuth credentials for outbound authentication to the gateway.

" - } - }, - "documentation":"

Authentication method for calling a Gateway.

", - "union":true - }, - "HarnessGeminiModelConfig":{ - "type":"structure", - "required":[ - "modelId", - "apiKeyArn" - ], - "members":{ - "modelId":{ - "shape":"ModelId", - "documentation":"

The Gemini model ID.

" - }, - "apiKeyArn":{ - "shape":"ApiKeyArn", - "documentation":"

The ARN of your Gemini API key on AgentCore Identity.

" - }, - "maxTokens":{ - "shape":"MaxTokens", - "documentation":"

The maximum number of tokens to allow in the generated response per model call.

" - }, - "temperature":{ - "shape":"Temperature", - "documentation":"

The temperature to set when calling the model.

" - }, - "topP":{ - "shape":"TopP", - "documentation":"

The topP set when calling the model.

" - }, - "topK":{ - "shape":"TopK", - "documentation":"

The topK set when calling the model.

" - }, - "additionalParams":{ - "shape":"Document", - "documentation":"

Provider-specific parameters passed through to the Gemini model provider unchanged.

" - } - }, - "documentation":"

Configuration for a Google Gemini model provider. Requires an API key stored in AgentCore Identity.

" - }, - "HarnessId":{ - "type":"string", - "pattern":"[a-zA-Z][a-zA-Z0-9_]{0,39}-[a-zA-Z0-9]{10}" - }, - "HarnessInlineFunctionConfig":{ - "type":"structure", - "required":[ - "description", - "inputSchema" - ], - "members":{ - "description":{ - "shape":"HarnessInlineFunctionDescription", - "documentation":"

Description of what the tool does, provided to the model.

" - }, - "inputSchema":{ - "shape":"SensitiveJson", - "documentation":"

JSON Schema describing the tool's input parameters.

" - } - }, - "documentation":"

Configuration for an inline function tool. When the agent calls this tool, the tool call is returned to the caller for external execution.

" - }, - "HarnessInlineFunctionDescription":{ - "type":"string", - "max":4096, - "min":1, - "sensitive":true - }, - "HarnessLiteLlmApiBase":{ - "type":"string", - "max":16383, - "min":1, - "sensitive":true - }, - "HarnessLiteLlmModelConfig":{ - "type":"structure", - "required":["modelId"], - "members":{ - "modelId":{ - "shape":"ModelId", - "documentation":"

The LiteLLM model identifier (e.g., \"anthropic/claude-3-sonnet\").

" - }, - "apiKeyArn":{ - "shape":"ApiKeyArn", - "documentation":"

The ARN of the API key in AgentCore Identity for authenticating with the model provider.

" - }, - "apiBase":{ - "shape":"HarnessLiteLlmApiBase", - "documentation":"

The base URL for the model provider's API endpoint.

" - }, - "maxTokens":{ - "shape":"MaxTokens", - "documentation":"

The maximum number of tokens to allow in the generated response per iteration.

" - }, - "temperature":{ - "shape":"Temperature", - "documentation":"

The temperature to set when calling the model.

" - }, - "topP":{ - "shape":"TopP", - "documentation":"

The topP set when calling the model.

" - }, - "additionalParams":{ - "shape":"Document", - "documentation":"

Provider-specific parameters passed through to the model provider unchanged.

" - } - }, - "documentation":"

Configuration for a LiteLLM model provider, enabling connection to third-party model providers.

" - }, - "HarnessManagedMemoryConfiguration":{ - "type":"structure", - "members":{ - "arn":{ - "shape":"MemoryArn", - "documentation":"

The ARN of the managed AgentCore Memory resource. Read-only on Get, ignored on Create/Update input.

" - }, - "strategies":{ - "shape":"HarnessManagedMemoryStrategyList", - "documentation":"

Strategy types to enable. Defaults to [SEMANTIC, SUMMARIZATION].

" - }, - "eventExpiryDuration":{ - "shape":"HarnessManagedMemoryConfigurationEventExpiryDurationInteger", - "documentation":"

Event retention in days. Defaults to 30.

" - }, - "encryptionKeyArn":{ - "shape":"KmsKeyArn", - "documentation":"

Customer-managed KMS key. Defaults to AWS-owned key. Not updatable after creation.

" - } - }, - "documentation":"

Configuration for managed memory creation.

" - }, - "HarnessManagedMemoryConfigurationEventExpiryDurationInteger":{ - "type":"integer", - "box":true, - "max":365, - "min":3 - }, - "HarnessManagedMemoryStrategyList":{ - "type":"list", - "member":{"shape":"HarnessManagedMemoryStrategyType"}, - "max":4, - "min":1 - }, - "HarnessManagedMemoryStrategyType":{ - "type":"string", - "enum":[ - "SEMANTIC", - "SUMMARIZATION", - "USER_PREFERENCE", - "EPISODIC" - ] - }, - "HarnessMemoryConfiguration":{ - "type":"structure", - "members":{ - "agentCoreMemoryConfiguration":{ - "shape":"HarnessAgentCoreMemoryConfiguration", - "documentation":"

The AgentCore Memory configuration.

" - }, - "managedMemoryConfiguration":{ - "shape":"HarnessManagedMemoryConfiguration", - "documentation":"

Harness creates and manages a memory resource in the customer's account.

" - }, - "disabled":{ - "shape":"HarnessDisabledMemoryConfiguration", - "documentation":"

Explicitly opt out of memory.

" - } - }, - "documentation":"

The memory configuration for a harness.

", - "union":true - }, - "HarnessModelConfiguration":{ - "type":"structure", - "members":{ - "bedrockModelConfig":{ - "shape":"HarnessBedrockModelConfig", - "documentation":"

Configuration for an Amazon Bedrock model.

" - }, - "openAiModelConfig":{ - "shape":"HarnessOpenAiModelConfig", - "documentation":"

Configuration for an OpenAI model.

" - }, - "geminiModelConfig":{ - "shape":"HarnessGeminiModelConfig", - "documentation":"

Configuration for a Google Gemini model.

" - }, - "liteLlmModelConfig":{ - "shape":"HarnessLiteLlmModelConfig", - "documentation":"

The LiteLLM model configuration for connecting to third-party model providers.

" - } - }, - "documentation":"

Specification of which model to use.

", - "union":true - }, - "HarnessName":{ - "type":"string", - "pattern":"[a-zA-Z][a-zA-Z0-9_]{0,39}" - }, - "HarnessOpenAiApiFormat":{ - "type":"string", - "enum":[ - "chat_completions", - "responses" - ] - }, - "HarnessOpenAiModelConfig":{ - "type":"structure", - "required":[ - "modelId", - "apiKeyArn" - ], - "members":{ - "modelId":{ - "shape":"ModelId", - "documentation":"

The OpenAI model ID.

" - }, - "apiKeyArn":{ - "shape":"ApiKeyArn", - "documentation":"

The ARN of your OpenAI API key on AgentCore Identity.

" - }, - "maxTokens":{ - "shape":"MaxTokens", - "documentation":"

The maximum number of tokens to allow in the generated response per model call.

" - }, - "temperature":{ - "shape":"Temperature", - "documentation":"

The temperature to set when calling the model.

" - }, - "topP":{ - "shape":"TopP", - "documentation":"

The topP set when calling the model.

" - }, - "apiFormat":{ - "shape":"HarnessOpenAiApiFormat", - "documentation":"

The API format to use when calling the OpenAI provider.

" - }, - "additionalParams":{ - "shape":"Document", - "documentation":"

Provider-specific parameters passed through to the model provider unchanged.

" - } - }, - "documentation":"

Configuration for an OpenAI model provider. Requires an API key stored in AgentCore Identity.

" - }, - "HarnessRemoteMcpConfig":{ - "type":"structure", - "required":["url"], - "members":{ - "url":{ - "shape":"HarnessRemoteMcpUrl", - "documentation":"

URL of the MCP endpoint.

" - }, - "headers":{ - "shape":"HttpHeadersMap", - "documentation":"

Custom headers to include when connecting to the remote MCP server.

" - } - }, - "documentation":"

Configuration for connecting to a remote MCP server.

" - }, - "HarnessRemoteMcpUrl":{ - "type":"string", - "max":16383, - "min":1, - "sensitive":true - }, - "HarnessSkill":{ - "type":"structure", - "members":{ - "path":{ - "shape":"HarnessSkillPath", - "documentation":"

The filesystem path to the skill definition.

" - }, - "s3":{ - "shape":"HarnessSkillS3Source", - "documentation":"

An S3 source containing the skill.

" - }, - "git":{ - "shape":"HarnessSkillGitSource", - "documentation":"

A git repository containing the skill.

" - }, - "awsSkills":{ - "shape":"HarnessSkillAwsSkillsSource", - "documentation":"

AWS Skills baked into the harness's underlying Runtime.

" - } - }, - "documentation":"

A skill available to the agent.

", - "union":true - }, - "HarnessSkillAwsSkillsSource":{ - "type":"structure", - "members":{ - "paths":{ - "shape":"HarnessAwsSkillPaths", - "documentation":"

Optionally filter allowed skills with glob syntax, e.g., ['core-skills/*'].

" - } - }, - "documentation":"

Passed to show that AWS Skills should be included.

" - }, - "HarnessSkillGitAuth":{ - "type":"structure", - "required":["credentialArn"], - "members":{ - "credentialArn":{ - "shape":"ApiKeyArn", - "documentation":"

The ARN of the credential in AgentCore Identity containing the password or personal access token.

" - }, - "username":{ - "shape":"String", - "documentation":"

Username for authentication. Defaults to 'oauth2' if not specified.

" - } - }, - "documentation":"

Authentication configuration for accessing a private git repository.

" - }, - "HarnessSkillGitSource":{ - "type":"structure", - "required":["url"], - "members":{ - "url":{ - "shape":"HarnessSkillGitUrl", - "documentation":"

The HTTPS URL of the git repository.

" - }, - "path":{ - "shape":"String", - "documentation":"

Subdirectory within the repository containing the skill.

" - }, - "auth":{ - "shape":"HarnessSkillGitAuth", - "documentation":"

Authentication configuration for private repositories.

" - } - }, - "documentation":"

A git repository source for a skill.

" - }, - "HarnessSkillGitUrl":{ - "type":"string", - "max":16383, - "min":8, - "pattern":"https://[^#@]+" - }, - "HarnessSkillPath":{ - "type":"string", - "max":4096, - "min":1 - }, - "HarnessSkillS3Source":{ - "type":"structure", - "required":["uri"], - "members":{ - "uri":{ - "shape":"HarnessSkillS3Uri", - "documentation":"

The S3 URI pointing to the skill directory (e.g., s3://bucket/skills/my-skill/).

" - } - }, - "documentation":"

An S3 source for a skill.

" - }, - "HarnessSkillS3Uri":{ - "type":"string", - "max":16383, - "min":5, - "pattern":"s3://.*" - }, - "HarnessSkills":{ - "type":"list", - "member":{"shape":"HarnessSkill"} - }, - "HarnessSlidingWindowConfiguration":{ - "type":"structure", - "members":{ - "messagesCount":{ - "shape":"Integer", - "documentation":"

The number of recent messages to retain in the context window.

" - } - }, - "documentation":"

Configuration for sliding window truncation strategy.

" - }, - "HarnessStatus":{ - "type":"string", - "enum":[ - "CREATING", - "CREATE_FAILED", - "UPDATING", - "UPDATE_FAILED", - "READY", - "DELETING", - "DELETE_FAILED" - ] - }, - "HarnessSummaries":{ - "type":"list", - "member":{"shape":"HarnessSummary"} - }, - "HarnessSummarizationConfiguration":{ - "type":"structure", - "members":{ - "summaryRatio":{ - "shape":"Float", - "documentation":"

The ratio of content to summarize.

" - }, - "preserveRecentMessages":{ - "shape":"Integer", - "documentation":"

The number of recent messages to preserve without summarization.

" - }, - "summarizationSystemPrompt":{ - "shape":"String", - "documentation":"

The system prompt used for generating summaries.

" - } - }, - "documentation":"

Configuration for summarization-based truncation strategy.

" - }, - "HarnessSummary":{ - "type":"structure", - "required":[ - "harnessId", - "harnessName", - "arn", - "status", - "createdAt", - "updatedAt" - ], - "members":{ - "harnessId":{ - "shape":"HarnessId", - "documentation":"

The ID of the harness.

" - }, - "harnessName":{ - "shape":"HarnessName", - "documentation":"

The name of the harness.

" - }, - "arn":{ - "shape":"HarnessArn", - "documentation":"

The ARN of the harness.

" - }, - "status":{ - "shape":"HarnessStatus", - "documentation":"

The current status of the harness.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the harness was created.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the harness was last updated.

" - }, - "harnessVersion":{ - "shape":"HarnessVersion", - "documentation":"

The latest version of the harness.

" - } - }, - "documentation":"

Summary information about a harness.

" - }, - "HarnessSystemContentBlock":{ - "type":"structure", - "members":{ - "text":{ - "shape":"SensitiveText", - "documentation":"

The text content of the system prompt block.

" - } - }, - "documentation":"

A content block in the system prompt.

", - "union":true - }, - "HarnessSystemPrompt":{ - "type":"list", - "member":{"shape":"HarnessSystemContentBlock"} - }, - "HarnessTool":{ - "type":"structure", - "required":["type"], - "members":{ - "type":{ - "shape":"HarnessToolType", - "documentation":"

The type of tool.

" - }, - "name":{ - "shape":"HarnessToolName", - "documentation":"

Unique name for the tool. If not provided, a name will be inferred or generated.

" - }, - "config":{ - "shape":"HarnessToolConfiguration", - "documentation":"

Tool-specific configuration.

" - } - }, - "documentation":"

A tool available to the agent loop.

" - }, - "HarnessToolConfiguration":{ - "type":"structure", - "members":{ - "remoteMcp":{ - "shape":"HarnessRemoteMcpConfig", - "documentation":"

Configuration for remote MCP server.

" - }, - "agentCoreBrowser":{ - "shape":"HarnessAgentCoreBrowserConfig", - "documentation":"

Configuration for AgentCore Browser.

" - }, - "agentCoreGateway":{ - "shape":"HarnessAgentCoreGatewayConfig", - "documentation":"

Configuration for AgentCore Gateway.

" - }, - "inlineFunction":{ - "shape":"HarnessInlineFunctionConfig", - "documentation":"

Configuration for an inline function tool.

" - }, - "agentCoreCodeInterpreter":{ - "shape":"HarnessAgentCoreCodeInterpreterConfig", - "documentation":"

Configuration for AgentCore Code Interpreter.

" - } - }, - "documentation":"

Configuration union for different tool types.

", - "union":true - }, - "HarnessToolName":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[a-zA-Z0-9_-]+" - }, - "HarnessToolType":{ - "type":"string", - "enum":[ - "remote_mcp", - "agentcore_browser", - "agentcore_gateway", - "inline_function", - "agentcore_code_interpreter" - ] - }, - "HarnessTools":{ - "type":"list", - "member":{"shape":"HarnessTool"} - }, - "HarnessTruncationConfiguration":{ - "type":"structure", - "required":["strategy"], - "members":{ - "strategy":{ - "shape":"HarnessTruncationStrategy", - "documentation":"

The truncation strategy to use.

" - }, - "config":{ - "shape":"HarnessTruncationStrategyConfiguration", - "documentation":"

The strategy-specific configuration.

" - } - }, - "documentation":"

Configuration for truncating conversation context when it exceeds model limits.

" - }, - "HarnessTruncationStrategy":{ - "type":"string", - "enum":[ - "sliding_window", - "summarization", - "none" - ] - }, - "HarnessTruncationStrategyConfiguration":{ - "type":"structure", - "members":{ - "slidingWindow":{ - "shape":"HarnessSlidingWindowConfiguration", - "documentation":"

Configuration for sliding window truncation.

" - }, - "summarization":{ - "shape":"HarnessSummarizationConfiguration", - "documentation":"

Configuration for summarization-based truncation.

" - } - }, - "documentation":"

Strategy-specific truncation configuration.

", - "union":true - }, - "HarnessVersion":{ - "type":"string", - "max":5, - "min":1, - "pattern":"([1-9][0-9]{0,4})" - }, - "HarnessVersionSummaries":{ - "type":"list", - "member":{"shape":"HarnessVersionSummary"} - }, - "HarnessVersionSummary":{ - "type":"structure", - "required":[ - "harnessId", - "harnessName", - "arn", - "harnessVersion", - "status", - "createdAt", - "updatedAt" - ], - "members":{ - "harnessId":{ - "shape":"HarnessId", - "documentation":"

The ID of the harness.

" - }, - "harnessName":{ - "shape":"HarnessName", - "documentation":"

The name of the harness.

" - }, - "arn":{ - "shape":"HarnessArn", - "documentation":"

The ARN of the harness.

" - }, - "harnessVersion":{ - "shape":"HarnessVersion", - "documentation":"

The version of the harness that this summary describes.

" - }, - "status":{ - "shape":"HarnessStatus", - "documentation":"

The status of this harness version.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when this harness version was created.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when this harness version was last updated.

" - }, - "failureReason":{ - "shape":"String", - "documentation":"

Reason why the create or update operation for this harness version failed.

" - } - }, - "documentation":"

Summary information about a single version of a harness.

" - }, - "HeaderName":{ - "type":"string", - "max":256, - "min":1, - "pattern":"[A-Za-z][A-Za-z0-9_-]{0,255}" - }, - "HostingEnvironment":{ - "type":"structure", - "required":["arn"], - "members":{ - "arn":{ - "shape":"BedrockAgentcoreResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the hosting environment.

" - } - }, - "documentation":"

A hosting environment whose workloads are allowed to invoke the target. At launch, the only supported hosting environment is AgentCore Gateway.

" - }, - "HostingEnvironmentListType":{ - "type":"list", - "member":{"shape":"HostingEnvironment"}, - "max":10, - "min":1 - }, - "HttpApiSchemaConfiguration":{ - "type":"structure", - "required":["source"], - "members":{ - "source":{"shape":"ApiSchemaConfiguration"} - }, - "documentation":"

The API schema configuration for an HTTP target. This schema defines the API structure that the target exposes.

" - }, - "HttpHeaderKey":{ - "type":"string", - "documentation":"

The key of an HTTP header.

", - "max":16383, - "min":1 - }, - "HttpHeaderName":{ - "type":"string", - "max":100, - "min":1 - }, - "HttpHeaderValue":{ - "type":"string", - "documentation":"

The value of an HTTP header.

", - "max":16383, - "min":1 - }, - "HttpHeadersMap":{ - "type":"map", - "key":{"shape":"HttpHeaderKey"}, - "value":{"shape":"HttpHeaderValue"}, - "documentation":"

Map of key/value pairs for HTTP headers.

", - "sensitive":true - }, - "HttpQueryParameterName":{ - "type":"string", - "max":40, - "min":1 - }, - "HttpTargetConfiguration":{ - "type":"structure", - "members":{ - "agentcoreRuntime":{ - "shape":"RuntimeTargetConfiguration", - "documentation":"

The AgentCore Runtime target configuration for HTTP-based communication with an agent runtime.

" - }, - "passthrough":{ - "shape":"PassthroughTargetConfiguration", - "documentation":"

The passthrough configuration for the HTTP target. A passthrough target forwards requests directly to an external HTTP endpoint.

" - } - }, - "documentation":"

The HTTP target configuration for a gateway target. Contains the configuration for HTTP-based target endpoints.

", - "union":true - }, - "IamCredentialProvider":{ - "type":"structure", - "required":["service"], - "members":{ - "service":{ - "shape":"IamCredentialProviderServiceString", - "documentation":"

The target Amazon Web Services service name used for SigV4 signing. This value identifies the service that the gateway authenticates with when making requests to the target endpoint.

" - }, - "region":{ - "shape":"IamCredentialProviderRegionString", - "documentation":"

The Amazon Web Services Region used for SigV4 signing. If not specified, defaults to the gateway's Region.

" - } - }, - "documentation":"

An IAM credential provider for gateway authentication. This structure contains the configuration for authenticating with the target endpoint using IAM credentials and SigV4 signing.

" - }, - "IamCredentialProviderRegionString":{ - "type":"string", - "max":32, - "min":1, - "pattern":"[a-zA-Z0-9-]+" - }, - "IamCredentialProviderServiceString":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[a-zA-Z0-9._-]+" - }, - "IamPrincipal":{ - "type":"structure", - "required":["arn"], - "members":{ - "arn":{ - "shape":"IamPrincipalArn", - "documentation":"

The Amazon Resource Name (ARN) of the IAM principal. Supports user, role, and assumed-role ARNs. Wildcards can be used with the StringLike operator.

" - }, - "operator":{ - "shape":"PrincipalMatchOperator", - "documentation":"

The match operator. StringEquals requires an exact match. StringLike supports wildcard patterns using * and ?.

" - } - }, - "documentation":"

An IAM principal specification for rule matching.

" - }, - "IamPrincipalArn":{ - "type":"string", - "max":2048, - "min":0, - "pattern":"(arn:aws[a-zA-Z-]*:iam::(\\d{12}|\\*):(user|role)/[\\w+=,.@*?/-]+|arn:aws[a-zA-Z-]*:sts::(\\d{12}|\\*):assumed-role/[\\w+=,.@*?/-]+)" - }, - "IamRoleArn":{ - "type":"string", - "max":2048, - "min":20, - "pattern":"arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+" - }, - "IamSigningRegion":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[a-z0-9-]+" - }, - "IamSigningServiceName":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[a-zA-Z0-9_-]+" - }, - "InboundTokenClaimNameType":{ - "type":"string", - "max":255, - "min":1, - "pattern":"[A-Za-z0-9_.-:]+" - }, - "InboundTokenClaimValueType":{ - "type":"string", - "enum":[ - "STRING", - "STRING_ARRAY" - ] - }, - "IncludedData":{ - "type":"string", - "enum":[ - "ALL_DATA", - "METADATA_ONLY" - ] - }, - "IncludedOauth2ProviderConfigInput":{ - "type":"structure", - "required":["clientId"], - "members":{ - "clientId":{ - "shape":"ClientIdType", - "documentation":"

The client ID for the supported OAuth2 provider. This identifier is assigned by the OAuth2 provider when you register your application.

" - }, - "clientSecret":{ - "shape":"DefaultClientSecretType", - "documentation":"

The client secret for the supported OAuth2 provider. This secret is assigned by the OAuth2 provider and used along with the client ID to authenticate your application.

" - }, - "clientSecretConfig":{ - "shape":"SecretReference", - "documentation":"

A reference to the Amazon Web Services Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when clientSecretSource is set to EXTERNAL.

" - }, - "clientSecretSource":{ - "shape":"SecretSourceType", - "documentation":"

The source type of the client secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.

" - }, - "issuer":{ - "shape":"IssuerUrlType", - "documentation":"

Token issuer of your isolated OAuth2 application tenant. This URL identifies the authorization server that issues tokens for this provider.

" - }, - "authorizationEndpoint":{ - "shape":"AuthorizationEndpointType", - "documentation":"

OAuth2 authorization endpoint for your isolated OAuth2 application tenant. This is where users are redirected to authenticate and authorize access to their resources.

" - }, - "tokenEndpoint":{ - "shape":"TokenEndpointType", - "documentation":"

OAuth2 token endpoint for your isolated OAuth2 application tenant. This is where authorization codes are exchanged for access tokens.

" - } - }, - "documentation":"

Configuration settings for connecting to a supported OAuth2 provider. This includes client credentials and OAuth2 discovery information for providers that have built-in support.

" - }, - "IncludedOauth2ProviderConfigOutput":{ - "type":"structure", - "required":["oauthDiscovery"], - "members":{ - "oauthDiscovery":{"shape":"Oauth2Discovery"}, - "clientId":{ - "shape":"ClientIdType", - "documentation":"

The client ID for the supported OAuth2 provider.

" - } - }, - "documentation":"

The configuration details returned for a supported OAuth2 provider, including client credentials and OAuth2 discovery information.

" - }, - "IndexedKey":{ - "type":"structure", - "required":[ - "key", - "type" - ], - "members":{ - "key":{ - "shape":"MetadataKey", - "documentation":"

The metadata key name to index.

" - }, - "type":{ - "shape":"MetadataValueType", - "documentation":"

The data type of the indexed key.

" - } - }, - "documentation":"

A metadata key indexed for filtering.

" - }, - "IndexedKeysList":{ - "type":"list", - "member":{"shape":"IndexedKey"}, - "max":10, - "min":1 - }, - "InferenceConfiguration":{ - "type":"structure", - "members":{ - "maxTokens":{ - "shape":"InferenceConfigurationMaxTokensInteger", - "documentation":"

The maximum number of tokens to generate in the model response during evaluation.

" - }, - "temperature":{ - "shape":"InferenceConfigurationTemperatureFloat", - "documentation":"

The temperature value that controls randomness in the model's responses. Lower values produce more deterministic outputs.

" - }, - "topP":{ - "shape":"InferenceConfigurationTopPFloat", - "documentation":"

The top-p sampling parameter that controls the diversity of the model's responses by limiting the cumulative probability of token choices.

" - }, - "stopSequences":{ - "shape":"InferenceConfigurationStopSequencesList", - "documentation":"

The list of sequences that will cause the model to stop generating tokens when encountered.

" - } - }, - "documentation":"

The configuration parameters that control how the foundation model behaves during evaluation, including response generation settings.

" - }, - "InferenceConfigurationMaxTokensInteger":{ - "type":"integer", - "box":true, - "min":1 - }, - "InferenceConfigurationStopSequencesList":{ - "type":"list", - "member":{"shape":"NonEmptyString"}, - "max":2500, - "min":0 - }, - "InferenceConfigurationTemperatureFloat":{ - "type":"float", - "box":true, - "max":1, - "min":0 - }, - "InferenceConfigurationTopPFloat":{ - "type":"float", - "box":true, - "max":1, - "min":0 - }, - "InferenceConnectorId":{ - "type":"string", - "max":256, - "min":1 - }, - "InferenceConnectorSource":{ - "type":"structure", - "required":["connectorId"], - "members":{ - "connectorId":{ - "shape":"InferenceConnectorId", - "documentation":"

The identifier for the inference connector (for example, bedrock-mantle, openai, or anthropic).

" - } - }, - "documentation":"

The source identifying the inference connector.

" - }, - "InferenceConnectorTargetConfiguration":{ - "type":"structure", - "required":["source"], - "members":{ - "source":{ - "shape":"InferenceConnectorSource", - "documentation":"

The source configuration identifying which inference connector to use.

" - } - }, - "documentation":"

The configuration for a connector-based inference target. This configuration uses a built-in connector that provides predefined rules for a large language model (LLM) provider.

" - }, - "InferenceOperationConfiguration":{ - "type":"structure", - "required":["path"], - "members":{ - "path":{ - "shape":"InferenceOperationPath", - "documentation":"

The request path for this operation (for example, /v1/messages or /v1/responses).

" - }, - "providerPath":{ - "shape":"InferenceOperationPath", - "documentation":"

The provider path to forward requests to, if it differs from the request path. For example, /anthropic/v1/messages when the provider expects a different path than the client-facing /v1/messages.

" - }, - "models":{ - "shape":"ModelEntries", - "documentation":"

The list of models supported for this operation.

" - } - }, - "documentation":"

The configuration for a specific inference operation, including its request path and the models that the operation supports.

" - }, - "InferenceOperationConfigurations":{ - "type":"list", - "member":{"shape":"InferenceOperationConfiguration"}, - "max":10, - "min":1 - }, - "InferenceOperationPath":{ - "type":"string", - "max":256, - "min":1, - "pattern":"/[a-zA-Z0-9\\-\\._/]+" - }, - "InferenceProviderTargetConfiguration":{ - "type":"structure", - "required":["endpoint"], - "members":{ - "endpoint":{ - "shape":"PassthroughEndpoint", - "documentation":"

The HTTPS endpoint of the inference provider that the gateway forwards requests to.

" - }, - "modelMapping":{ - "shape":"ModelMapping", - "documentation":"

The configuration that translates client-facing model IDs to the model IDs expected by the provider.

" - }, - "operations":{ - "shape":"InferenceOperationConfigurations", - "documentation":"

A list of per-operation configurations that map request paths to the models supported for each operation.

" - } - }, - "documentation":"

The configuration for a provider-based inference target. This configuration explicitly defines the endpoint, model mapping, and operations used to route requests to a large language model (LLM) provider.

" - }, - "InferenceTargetConfiguration":{ - "type":"structure", - "members":{ - "connector":{ - "shape":"InferenceConnectorTargetConfiguration", - "documentation":"

The connector-based inference configuration. Use this option to route requests to an LLM provider through a built-in connector that includes predefined provider rules.

" - }, - "provider":{ - "shape":"InferenceProviderTargetConfiguration", - "documentation":"

The provider-based inference configuration. Use this option to explicitly configure the endpoint, model mapping, and operations for an LLM provider.

" - } - }, - "documentation":"

The configuration for an inference target. An inference target routes requests to a large language model (LLM) provider, either through a built-in connector or an explicitly configured provider.

", - "union":true - }, - "InlineContent":{ - "type":"string", - "max":102400, - "min":1 - }, - "InlineExamplesSource":{ - "type":"structure", - "required":["examples"], - "members":{ - "examples":{ - "shape":"InlineExamplesSourceExamplesList", - "documentation":"

Examples to add. Each example is assigned an auto-generated UUID.

" - } - }, - "documentation":"

Inline examples provided directly in the request body.

" - }, - "InlineExamplesSourceExamplesList":{ - "type":"list", - "member":{"shape":"SensitiveJson"}, - "documentation":"

A list of dataset examples. Each element is a free-form JSON document whose structure is defined by the dataset's schema type.

", - "max":1000, - "min":1 - }, - "InlinePayload":{ - "type":"string", - "sensitive":true - }, - "Insight":{ - "type":"structure", - "required":["insightId"], - "members":{ - "insightId":{ - "shape":"InsightId", - "documentation":"

The unique identifier of the insight to run.

" - } - }, - "documentation":"

A reference to an insight analysis to run against sessions during evaluation. Insights provide deeper analysis beyond individual evaluator scores, including failure detection, user intent clustering, and execution summarization.

" - }, - "InsightId":{ - "type":"string", - "documentation":"

Canonical insight identifiers using the Builtin.Insight.* naming convention. Used by BatchEvaluate, InternalEvaluate, and ServiceEngineEvaluate flows.

", - "pattern":"(Builtin\\.[a-zA-Z0-9._-]+|[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10})" - }, - "InsightList":{ - "type":"list", - "member":{"shape":"Insight"}, - "max":10, - "min":0 - }, - "Integer":{ - "type":"integer", - "box":true - }, - "InterceptorConfiguration":{ - "type":"structure", - "members":{ - "lambda":{ - "shape":"LambdaInterceptorConfiguration", - "documentation":"

The details of the lambda function used for the interceptor.

" - } - }, - "documentation":"

The interceptor configuration.

", - "union":true - }, - "InterceptorInputConfiguration":{ - "type":"structure", - "required":["passRequestHeaders"], - "members":{ - "passRequestHeaders":{ - "shape":"Boolean", - "documentation":"

Indicates whether to pass request headers as input into the interceptor. When set to true, request headers will be passed.

" - }, - "payloadFilter":{ - "shape":"InterceptorPayloadFilter", - "documentation":"

The filter that determines which parts of the request or response payload are passed as input to the interceptor.

" - } - }, - "documentation":"

The input configuration of the interceptor.

" - }, - "InterceptorPayloadExclusion":{ - "type":"string", - "enum":["RESPONSE_BODY"] - }, - "InterceptorPayloadExclusionSelector":{ - "type":"structure", - "members":{ - "field":{ - "shape":"InterceptorPayloadExclusion", - "documentation":"

The field to exclude from the interceptor input.

" - } - }, - "documentation":"

A selector that identifies a payload field to exclude from the interceptor input.

", - "union":true - }, - "InterceptorPayloadExclusionSelectorList":{ - "type":"list", - "member":{"shape":"InterceptorPayloadExclusionSelector"}, - "max":1, - "min":1 - }, - "InterceptorPayloadFilter":{ - "type":"structure", - "required":["exclude"], - "members":{ - "exclude":{ - "shape":"InterceptorPayloadExclusionSelectorList", - "documentation":"

The list of selectors that identify payload fields to exclude from the interceptor input.

" - } - }, - "documentation":"

The filter that controls which fields of the request or response payload are included in the input to the interceptor.

" - }, - "InternalServerException":{ - "type":"structure", - "members":{ - "message":{"shape":"NonBlankString"} - }, - "documentation":"

This exception is thrown if there was an unexpected error during processing of request

", - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true - }, - "InvocationConfiguration":{ - "type":"structure", - "required":[ - "topicArn", - "payloadDeliveryBucketName" - ], - "members":{ - "topicArn":{ - "shape":"Arn", - "documentation":"

The ARN of the SNS topic for job notifications.

" - }, - "payloadDeliveryBucketName":{ - "shape":"String", - "documentation":"

The S3 bucket name for event payload delivery.

" - } - }, - "documentation":"

The configuration to invoke a self-managed memory processing pipeline with.

" - }, - "InvocationConfigurationInput":{ - "type":"structure", - "required":[ - "topicArn", - "payloadDeliveryBucketName" - ], - "members":{ - "topicArn":{ - "shape":"Arn", - "documentation":"

The ARN of the SNS topic for job notifications.

" - }, - "payloadDeliveryBucketName":{ - "shape":"InvocationConfigurationInputPayloadDeliveryBucketNameString", - "documentation":"

The S3 bucket name for event payload delivery.

" - } - }, - "documentation":"

The configuration to invoke a self-managed memory processing pipeline with.

" - }, - "InvocationConfigurationInputPayloadDeliveryBucketNameString":{ - "type":"string", - "pattern":"[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]" - }, - "IssuerUrlType":{"type":"string"}, - "KeyType":{ - "type":"string", - "enum":[ - "CustomerManagedKey", - "ServiceManagedKey" - ] - }, - "KinesisResource":{ - "type":"structure", - "required":[ - "dataStreamArn", - "contentConfigurations" - ], - "members":{ - "dataStreamArn":{ - "shape":"Arn", - "documentation":"

ARN of the Kinesis Data Stream.

" - }, - "contentConfigurations":{ - "shape":"KinesisResourceContentConfigurationsList", - "documentation":"

Content configurations for stream delivery.

" - } - }, - "documentation":"

Configuration for Kinesis Data Stream delivery.

" - }, - "KinesisResourceContentConfigurationsList":{ - "type":"list", - "member":{"shape":"ContentConfiguration"}, - "max":1, - "min":1 - }, - "KmsConfiguration":{ - "type":"structure", - "required":["keyType"], - "members":{ - "keyType":{ - "shape":"KeyType", - "documentation":"

The type of KMS key (CustomerManagedKey or ServiceManagedKey).

" - }, - "kmsKeyArn":{ - "shape":"KmsKeyArn", - "documentation":"

The Amazon Resource Name (ARN) of the KMS key.

" - } - }, - "documentation":"

Contains the KMS configuration for a resource.

" - }, - "KmsKeyArn":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}" - }, - "KmsKeySourceType":{ - "type":"structure", - "required":["kmsKeyArn"], - "members":{ - "kmsKeyArn":{ - "shape":"KmsKeyArn", - "documentation":"

The Amazon Resource Name (ARN) of the KMS key used to sign the JWT client assertion. The key must be an asymmetric key with key usage SIGN_VERIFY and a key spec compatible with the configured signing algorithm.

" - } - }, - "documentation":"

Contains the KMS key configuration for a JWT client assertion.

" - }, - "LambdaArn":{ - "type":"string", - "pattern":"arn:(aws[a-zA-Z-]*)?:lambda:([a-z]{2}(-gov)?-[a-z]+-\\d{1}):(\\d{12}):function:([a-zA-Z0-9-_.]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?" - }, - "LambdaEvaluatorConfig":{ - "type":"structure", - "required":["lambdaArn"], - "members":{ - "lambdaArn":{ - "shape":"LambdaArn", - "documentation":"

The Amazon Resource Name (ARN) of the Lambda function that implements the evaluation logic.

" - }, - "lambdaTimeoutInSeconds":{ - "shape":"LambdaEvaluatorConfigLambdaTimeoutInSecondsInteger", - "documentation":"

The timeout in seconds for the Lambda function invocation. Defaults to 60. Must be between 1 and 300.

" - } - }, - "documentation":"

Configuration for a Lambda function used as a code-based evaluator.

" - }, - "LambdaEvaluatorConfigLambdaTimeoutInSecondsInteger":{ - "type":"integer", - "box":true, - "max":300, - "min":1 - }, - "LambdaFunctionArn":{ - "type":"string", - "max":170, - "min":1, - "pattern":"arn:(aws[a-zA-Z-]*)?:lambda:([a-z]{2}(-gov)?-[a-z]+-\\d{1}):(\\d{12}):function:([a-zA-Z0-9-_.]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?" - }, - "LambdaInterceptorConfiguration":{ - "type":"structure", - "required":["arn"], - "members":{ - "arn":{ - "shape":"LambdaFunctionArn", - "documentation":"

The arn of the lambda function to be invoked for the interceptor.

" - } - }, - "documentation":"

The lambda configuration for the interceptor

" - }, - "LambdaTransformConfiguration":{ - "type":"structure", - "members":{ - "arn":{ - "shape":"LambdaFunctionArn", - "documentation":"

The Amazon Resource Name (ARN) of the Lambda function. This function is invoked by the gateway to transform data.

" - } - }, - "documentation":"

The Lambda configuration for custom transformations. This structure defines the Lambda function that the gateway invokes to transform data.

" - }, - "LifecycleConfiguration":{ - "type":"structure", - "members":{ - "idleRuntimeSessionTimeout":{ - "shape":"LifecycleConfigurationIdleRuntimeSessionTimeoutInteger", - "documentation":"

Timeout in seconds for idle runtime sessions. When a session remains idle for this duration, it will be automatically terminated. Default: 900 seconds (15 minutes).

" - }, - "maxLifetime":{ - "shape":"LifecycleConfigurationMaxLifetimeInteger", - "documentation":"

Maximum lifetime for the instance in seconds. Once reached, instances will be automatically terminated and replaced. Default: 28800 seconds (8 hours).

" - } - }, - "documentation":"

LifecycleConfiguration lets you manage the lifecycle of runtime sessions and resources in AgentCore Runtime. This configuration helps optimize resource utilization by automatically cleaning up idle sessions and preventing long-running instances from consuming resources indefinitely.

" - }, - "LifecycleConfigurationIdleRuntimeSessionTimeoutInteger":{ - "type":"integer", - "box":true, - "max":28800, - "min":60 - }, - "LifecycleConfigurationMaxLifetimeInteger":{ - "type":"integer", - "box":true, - "max":28800, - "min":60 - }, - "LinkedinOauth2ProviderConfigInput":{ - "type":"structure", - "required":["clientId"], - "members":{ - "clientId":{ - "shape":"ClientIdType", - "documentation":"

The client ID for the LinkedIn OAuth2 provider. This identifier is assigned by LinkedIn when you register your application.

" - }, - "clientSecret":{ - "shape":"DefaultClientSecretType", - "documentation":"

The client secret for the LinkedIn OAuth2 provider. This secret is assigned by LinkedIn and used along with the client ID to authenticate your application.

" - }, - "clientSecretConfig":{ - "shape":"SecretReference", - "documentation":"

A reference to the Amazon Web Services Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when clientSecretSource is set to EXTERNAL.

" - }, - "clientSecretSource":{ - "shape":"SecretSourceType", - "documentation":"

The source type of the client secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.

" - } - }, - "documentation":"

Configuration settings for connecting to LinkedIn services using OAuth2 authentication. This includes the client credentials required to authenticate with LinkedIn's OAuth2 authorization server.

" - }, - "LinkedinOauth2ProviderConfigOutput":{ - "type":"structure", - "required":["oauthDiscovery"], - "members":{ - "oauthDiscovery":{"shape":"Oauth2Discovery"}, - "clientId":{ - "shape":"ClientIdType", - "documentation":"

The client ID for the LinkedIn OAuth2 provider.

" - } - }, - "documentation":"

The configuration details returned for a LinkedIn OAuth2 provider, including the client ID and OAuth2 discovery information.

" - }, - "ListAgentRuntimeEndpointsRequest":{ - "type":"structure", - "required":["agentRuntimeId"], - "members":{ - "agentRuntimeId":{ - "shape":"AgentRuntimeId", - "documentation":"

The unique identifier of the AgentCore Runtime to list endpoints for.

", - "location":"uri", - "locationName":"agentRuntimeId" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return in the response.

", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to retrieve the next page of results.

", - "location":"querystring", - "locationName":"nextToken" - } - } - }, - "ListAgentRuntimeEndpointsResponse":{ - "type":"structure", - "required":["runtimeEndpoints"], - "members":{ - "runtimeEndpoints":{ - "shape":"AgentRuntimeEndpoints", - "documentation":"

The list of AgentCore Runtime endpoints.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to retrieve the next page of results.

" - } - } - }, - "ListAgentRuntimeVersionsRequest":{ - "type":"structure", - "required":["agentRuntimeId"], - "members":{ - "agentRuntimeId":{ - "shape":"AgentRuntimeId", - "documentation":"

The unique identifier of the AgentCore Runtime to list versions for.

", - "location":"uri", - "locationName":"agentRuntimeId" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return in the response.

", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to retrieve the next page of results.

", - "location":"querystring", - "locationName":"nextToken" - } - } - }, - "ListAgentRuntimeVersionsResponse":{ - "type":"structure", - "required":["agentRuntimes"], - "members":{ - "agentRuntimes":{ - "shape":"AgentRuntimes", - "documentation":"

The list of AgentCore Runtime versions.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to retrieve the next page of results.

" - } - } - }, - "ListAgentRuntimesRequest":{ - "type":"structure", - "members":{ - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return in the response.

", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to retrieve the next page of results.

", - "location":"querystring", - "locationName":"nextToken" - } - } - }, - "ListAgentRuntimesResponse":{ - "type":"structure", - "required":["agentRuntimes"], - "members":{ - "agentRuntimes":{ - "shape":"AgentRuntimes", - "documentation":"

The list of AgentCore Runtime resources.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to retrieve the next page of results.

" - } - } - }, - "ListApiKeyCredentialProvidersRequest":{ - "type":"structure", - "members":{ - "nextToken":{ - "shape":"String", - "documentation":"

Pagination token.

" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"

Maximum number of results to return.

" - } - } - }, - "ListApiKeyCredentialProvidersResponse":{ - "type":"structure", - "required":["credentialProviders"], - "members":{ - "credentialProviders":{ - "shape":"ApiKeyCredentialProviders", - "documentation":"

The list of API key credential providers.

" - }, - "nextToken":{ - "shape":"String", - "documentation":"

Pagination token for the next page of results.

" - } - } - }, - "ListBrowserProfilesRequest":{ - "type":"structure", - "members":{ - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return in the response.

", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to retrieve the next page of results.

", - "location":"querystring", - "locationName":"nextToken" - }, - "name":{ - "shape":"BrowserProfileName", - "documentation":"

The name of the browser profile to filter results by.

" - } - } - }, - "ListBrowserProfilesResponse":{ - "type":"structure", - "required":["profileSummaries"], - "members":{ - "profileSummaries":{ - "shape":"BrowserProfileSummaries", - "documentation":"

The list of browser profile summaries.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to retrieve the next page of results.

" - } - } - }, - "ListBrowsersRequest":{ - "type":"structure", - "members":{ - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return in a single call. The default value is 10. The maximum value is 50.

", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

", - "location":"querystring", - "locationName":"nextToken" - }, - "type":{ - "shape":"ResourceType", - "documentation":"

The type of browsers to list. If not specified, all browser types are returned.

", - "location":"querystring", - "locationName":"type" - } - } - }, - "ListBrowsersResponse":{ - "type":"structure", - "required":["browserSummaries"], - "members":{ - "browserSummaries":{ - "shape":"BrowserSummaries", - "documentation":"

The list of browser summaries.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to retrieve the next page of results.

" - } - } - }, - "ListCodeInterpretersRequest":{ - "type":"structure", - "members":{ - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return in the response.

", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to retrieve the next page of results.

", - "location":"querystring", - "locationName":"nextToken" - }, - "type":{ - "shape":"ResourceType", - "documentation":"

The type of code interpreters to list.

", - "location":"querystring", - "locationName":"type" - } - } - }, - "ListCodeInterpretersResponse":{ - "type":"structure", - "required":["codeInterpreterSummaries"], - "members":{ - "codeInterpreterSummaries":{ - "shape":"CodeInterpreterSummaries", - "documentation":"

The list of code interpreter summaries.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to retrieve the next page of results.

" - } - } - }, - "ListConfigurationBundleVersionsRequest":{ - "type":"structure", - "required":["bundleId"], - "members":{ - "bundleId":{ - "shape":"ConfigurationBundleId", - "documentation":"

The unique identifier of the configuration bundle to list versions for.

", - "location":"uri", - "locationName":"bundleId" - }, - "nextToken":{ - "shape":"String", - "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.

", - "location":"querystring", - "locationName":"nextToken" - }, - "maxResults":{ - "shape":"ListConfigurationBundleVersionsRequestMaxResultsInteger", - "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.

", - "location":"querystring", - "locationName":"maxResults" - }, - "filter":{ - "shape":"VersionFilter", - "documentation":"

An optional filter for listing versions, including branch name, creation source, and whether to return only the latest version per branch.

" - } - } - }, - "ListConfigurationBundleVersionsRequestMaxResultsInteger":{ - "type":"integer", - "box":true, - "max":100, - "min":1 - }, - "ListConfigurationBundleVersionsResponse":{ - "type":"structure", - "required":["versions"], - "members":{ - "versions":{ - "shape":"ConfigurationBundleVersionSummaryList", - "documentation":"

The list of configuration bundle version summaries.

" - }, - "nextToken":{ - "shape":"String", - "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.

" - } - } - }, - "ListConfigurationBundlesRequest":{ - "type":"structure", - "members":{ - "nextToken":{ - "shape":"String", - "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.

", - "location":"querystring", - "locationName":"nextToken" - }, - "maxResults":{ - "shape":"ListConfigurationBundlesRequestMaxResultsInteger", - "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.

", - "location":"querystring", - "locationName":"maxResults" - } - } - }, - "ListConfigurationBundlesRequestMaxResultsInteger":{ - "type":"integer", - "box":true, - "max":100, - "min":1 - }, - "ListConfigurationBundlesResponse":{ - "type":"structure", - "required":["bundles"], - "members":{ - "bundles":{ - "shape":"ConfigurationBundleSummaryList", - "documentation":"

The list of configuration bundle summaries.

" - }, - "nextToken":{ - "shape":"String", - "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.

" - } - } - }, - "ListDatasetExamplesRequest":{ - "type":"structure", - "required":["datasetId"], - "members":{ - "datasetId":{ - "shape":"DatasetId", - "documentation":"

The unique identifier of the dataset.

", - "location":"uri", - "locationName":"datasetId" - }, - "datasetVersion":{ - "shape":"DatasetVersion", - "documentation":"

Version to paginate: \"DRAFT\" or a version number. Defaults to DRAFT if absent. Only used on the first request; for subsequent pages, the version is extracted from the pagination token.

", - "location":"querystring", - "locationName":"datasetVersion" - }, - "maxResults":{ - "shape":"ListDatasetExamplesRequestMaxResultsInteger", - "documentation":"

Maximum number of examples to return per page.

", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"ListDatasetExamplesRequestNextTokenString", - "documentation":"

The token for the next page of results.

", - "location":"querystring", - "locationName":"nextToken" - } - } - }, - "ListDatasetExamplesRequestMaxResultsInteger":{ - "type":"integer", - "box":true, - "max":1000, - "min":1 - }, - "ListDatasetExamplesRequestNextTokenString":{ - "type":"string", - "max":2048, - "min":0 - }, - "ListDatasetExamplesResponse":{ - "type":"structure", - "required":[ - "datasetArn", - "datasetId", - "datasetVersion", - "examples" - ], - "members":{ - "datasetArn":{ - "shape":"DatasetArn", - "documentation":"

The Amazon Resource Name (ARN) of the dataset.

" - }, - "datasetId":{ - "shape":"DatasetId", - "documentation":"

The unique identifier of the dataset.

" - }, - "datasetVersion":{ - "shape":"DatasetVersion", - "documentation":"

The version returned.

" - }, - "examples":{ - "shape":"DatasetExampleList", - "documentation":"

Paginated example content. Each element is a JSON object containing at least an exampleId field plus the schema-specific content fields.

" - }, - "nextToken":{ - "shape":"String", - "documentation":"

The token for the next page of results, or null if there are no more results.

" - } - } - }, - "ListDatasetVersionsRequest":{ - "type":"structure", - "required":["datasetId"], - "members":{ - "datasetId":{ - "shape":"DatasetId", - "documentation":"

The unique identifier of the dataset.

", - "location":"uri", - "locationName":"datasetId" - }, - "nextToken":{ - "shape":"String", - "documentation":"

The token for the next page of results.

", - "location":"querystring", - "locationName":"nextToken" - }, - "maxResults":{ - "shape":"ListDatasetVersionsRequestMaxResultsInteger", - "documentation":"

The maximum number of versions to return per page.

", - "location":"querystring", - "locationName":"maxResults" - } - } - }, - "ListDatasetVersionsRequestMaxResultsInteger":{ - "type":"integer", - "box":true, - "max":100, - "min":1 - }, - "ListDatasetVersionsResponse":{ - "type":"structure", - "required":["versions"], - "members":{ - "versions":{ - "shape":"DatasetVersionSummaryList", - "documentation":"

The list of published dataset versions.

" - }, - "nextToken":{ - "shape":"String", - "documentation":"

The token for the next page of results, or null if there are no more results.

" - } - } - }, - "ListDatasetsRequest":{ - "type":"structure", - "members":{ - "nextToken":{ - "shape":"ListDatasetsRequestNextTokenString", - "documentation":"

The token for the next page of results.

", - "location":"querystring", - "locationName":"nextToken" - }, - "maxResults":{ - "shape":"ListDatasetsRequestMaxResultsInteger", - "documentation":"

The maximum number of datasets to return per page.

", - "location":"querystring", - "locationName":"maxResults" - } - } - }, - "ListDatasetsRequestMaxResultsInteger":{ - "type":"integer", - "box":true, - "max":100, - "min":1 - }, - "ListDatasetsRequestNextTokenString":{ - "type":"string", - "max":2048, - "min":0 - }, - "ListDatasetsResponse":{ - "type":"structure", - "required":["datasets"], - "members":{ - "datasets":{ - "shape":"DatasetSummaryList", - "documentation":"

The list of datasets.

" - }, - "nextToken":{ - "shape":"String", - "documentation":"

The token for the next page of results, or null if there are no more results.

" - } - } - }, - "ListEvaluatorsRequest":{ - "type":"structure", - "members":{ - "nextToken":{ - "shape":"String", - "documentation":"

The pagination token from a previous request to retrieve the next page of results.

", - "location":"querystring", - "locationName":"nextToken" - }, - "maxResults":{ - "shape":"ListEvaluatorsRequestMaxResultsInteger", - "documentation":"

The maximum number of evaluators to return in a single response.

", - "location":"querystring", - "locationName":"maxResults" - } - } - }, - "ListEvaluatorsRequestMaxResultsInteger":{ - "type":"integer", - "box":true, - "max":100, - "min":1 - }, - "ListEvaluatorsResponse":{ - "type":"structure", - "required":["evaluators"], - "members":{ - "evaluators":{ - "shape":"EvaluatorSummaryList", - "documentation":"

The list of evaluator summaries containing basic information about each evaluator.

" - }, - "nextToken":{ - "shape":"String", - "documentation":"

The pagination token to use in a subsequent request to retrieve the next page of results.

" - } - } - }, - "ListGatewayRulesRequest":{ - "type":"structure", - "required":["gatewayIdentifier"], - "members":{ - "gatewayIdentifier":{ - "shape":"GatewayIdentifier", - "documentation":"

The identifier of the gateway to list rules for.

", - "location":"uri", - "locationName":"gatewayIdentifier" - }, - "maxResults":{ - "shape":"GatewayRuleMaxResults", - "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.

", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"GatewayRuleNextToken", - "documentation":"

The pagination token from a previous request.

", - "location":"querystring", - "locationName":"nextToken" - } - } - }, - "ListGatewayRulesResponse":{ - "type":"structure", - "required":["gatewayRules"], - "members":{ - "gatewayRules":{ - "shape":"GatewayRules", - "documentation":"

The list of gateway rules.

" - }, - "nextToken":{ - "shape":"GatewayRuleNextToken", - "documentation":"

The pagination token to use in a subsequent request.

" - } - } - }, - "ListGatewayTargetsRequest":{ - "type":"structure", - "required":["gatewayIdentifier"], - "members":{ - "gatewayIdentifier":{ - "shape":"GatewayIdentifier", - "documentation":"

The identifier of the gateway to list targets for.

", - "location":"uri", - "locationName":"gatewayIdentifier" - }, - "maxResults":{ - "shape":"TargetMaxResults", - "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.

", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"TargetNextToken", - "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.

", - "location":"querystring", - "locationName":"nextToken" - } - } - }, - "ListGatewayTargetsResponse":{ - "type":"structure", - "required":["items"], - "members":{ - "items":{ - "shape":"TargetSummaries", - "documentation":"

The list of gateway target summaries.

" - }, - "nextToken":{ - "shape":"TargetNextToken", - "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.

" - } - } - }, - "ListGatewaysRequest":{ - "type":"structure", - "members":{ - "maxResults":{ - "shape":"GatewayMaxResults", - "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.

", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"GatewayNextToken", - "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.

", - "location":"querystring", - "locationName":"nextToken" - } - } - }, - "ListGatewaysResponse":{ - "type":"structure", - "required":["items"], - "members":{ - "items":{ - "shape":"GatewaySummaries", - "documentation":"

The list of gateway summaries.

" - }, - "nextToken":{ - "shape":"GatewayNextToken", - "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.

" - } - } - }, - "ListHarnessEndpointsRequest":{ - "type":"structure", - "required":["harnessId"], - "members":{ - "harnessId":{ - "shape":"HarnessId", - "documentation":"

The ID of the harness whose endpoints are listed.

", - "location":"uri", - "locationName":"harnessId" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return in a single call.

", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

The token for the next set of results.

", - "location":"querystring", - "locationName":"nextToken" - } - } - }, - "ListHarnessEndpointsResponse":{ - "type":"structure", - "required":["endpoints"], - "members":{ - "endpoints":{ - "shape":"HarnessEndpoints", - "documentation":"

The list of harness endpoints.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

The token for the next set of results.

" - } - } - }, - "ListHarnessVersionsRequest":{ - "type":"structure", - "required":["harnessId"], - "members":{ - "harnessId":{ - "shape":"HarnessId", - "documentation":"

The ID of the harness whose versions are listed.

", - "location":"uri", - "locationName":"harnessId" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return in a single call.

", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

The token for the next set of results.

", - "location":"querystring", - "locationName":"nextToken" - } - } - }, - "ListHarnessVersionsResponse":{ - "type":"structure", - "required":["harnessVersions"], - "members":{ - "harnessVersions":{ - "shape":"HarnessVersionSummaries", - "documentation":"

The list of harness version summaries.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

The token for the next set of results.

" - } - } - }, - "ListHarnessesRequest":{ - "type":"structure", - "members":{ - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return in a single call.

", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

The token for the next set of results.

", - "location":"querystring", - "locationName":"nextToken" - } - } - }, - "ListHarnessesResponse":{ - "type":"structure", - "required":["harnesses"], - "members":{ - "harnesses":{ - "shape":"HarnessSummaries", - "documentation":"

The list of harness summaries.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

The token for the next set of results.

" - } - } - }, - "ListMemoriesInput":{ - "type":"structure", - "members":{ - "maxResults":{ - "shape":"ListMemoriesInputMaxResultsInteger", - "documentation":"

The maximum number of results to return in a single call. The default value is 10. The maximum value is 50.

" - }, - "nextToken":{ - "shape":"String", - "documentation":"

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

" - } - } - }, - "ListMemoriesInputMaxResultsInteger":{ - "type":"integer", - "box":true, - "max":100, - "min":1 - }, - "ListMemoriesOutput":{ - "type":"structure", - "required":["memories"], - "members":{ - "memories":{ - "shape":"MemorySummaryList", - "documentation":"

The list of AgentCore Memory resource summaries.

" - }, - "nextToken":{ - "shape":"String", - "documentation":"

A token to retrieve the next page of results.

" - } - } - }, - "ListOauth2CredentialProvidersRequest":{ - "type":"structure", - "members":{ - "nextToken":{ - "shape":"String", - "documentation":"

Pagination token.

" - }, - "maxResults":{ - "shape":"ListOauth2CredentialProvidersRequestMaxResultsInteger", - "documentation":"

Maximum number of results to return.

" - } - } - }, - "ListOauth2CredentialProvidersRequestMaxResultsInteger":{ - "type":"integer", - "box":true, - "max":20, - "min":1 - }, - "ListOauth2CredentialProvidersResponse":{ - "type":"structure", - "required":["credentialProviders"], - "members":{ - "credentialProviders":{ - "shape":"Oauth2CredentialProviders", - "documentation":"

The list of OAuth2 credential providers.

" - }, - "nextToken":{ - "shape":"String", - "documentation":"

Pagination token for the next page of results.

" - } - } - }, - "ListOnlineEvaluationConfigsRequest":{ - "type":"structure", - "members":{ - "nextToken":{ - "shape":"String", - "documentation":"

The pagination token from a previous request to retrieve the next page of results.

", - "location":"querystring", - "locationName":"nextToken" - }, - "maxResults":{ - "shape":"ListOnlineEvaluationConfigsRequestMaxResultsInteger", - "documentation":"

The maximum number of online evaluation configurations to return in a single response.

", - "location":"querystring", - "locationName":"maxResults" - } - } - }, - "ListOnlineEvaluationConfigsRequestMaxResultsInteger":{ - "type":"integer", - "box":true, - "max":100, - "min":1 - }, - "ListOnlineEvaluationConfigsResponse":{ - "type":"structure", - "required":["onlineEvaluationConfigs"], - "members":{ - "onlineEvaluationConfigs":{ - "shape":"OnlineEvaluationConfigSummaryList", - "documentation":"

The list of online evaluation configuration summaries containing basic information about each configuration.

" - }, - "nextToken":{ - "shape":"String", - "documentation":"

The pagination token to use in a subsequent request to retrieve the next page of results.

" - } - } - }, - "ListPaymentConnectorsRequest":{ - "type":"structure", - "required":["paymentManagerId"], - "members":{ - "paymentManagerId":{ - "shape":"PaymentManagerId", - "documentation":"

The unique identifier of the payment manager whose connectors to list.

", - "location":"uri", - "locationName":"paymentManagerId" - }, - "maxResults":{ - "shape":"MaxResults", - "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.

", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"NextToken", - "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.

", - "location":"querystring", - "locationName":"nextToken" - } - } - }, - "ListPaymentConnectorsResponse":{ - "type":"structure", - "required":["paymentConnectors"], - "members":{ - "paymentConnectors":{ - "shape":"PaymentConnectorSummaries", - "documentation":"

The list of payment connector summaries. For details about the fields in each summary, see the PaymentConnectorSummary data type.

" - }, - "nextToken":{ - "shape":"NextToken", - "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.

" - } - } - }, - "ListPaymentCredentialProvidersRequest":{ - "type":"structure", - "members":{ - "nextToken":{ - "shape":"String", - "documentation":"

Pagination token.

" - }, - "maxResults":{ - "shape":"ListPaymentCredentialProvidersRequestMaxResultsInteger", - "documentation":"

Maximum number of results to return.

" - } - } - }, - "ListPaymentCredentialProvidersRequestMaxResultsInteger":{ - "type":"integer", - "box":true, - "max":20, - "min":1 - }, - "ListPaymentCredentialProvidersResponse":{ - "type":"structure", - "required":["credentialProviders"], - "members":{ - "credentialProviders":{ - "shape":"PaymentCredentialProviders", - "documentation":"

The list of payment credential providers.

" - }, - "nextToken":{ - "shape":"String", - "documentation":"

Pagination token for the next page of results.

" - } - } - }, - "ListPaymentManagersRequest":{ - "type":"structure", - "members":{ - "maxResults":{ - "shape":"MaxResults", - "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.

", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"NextToken", - "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.

", - "location":"querystring", - "locationName":"nextToken" - } - } - }, - "ListPaymentManagersResponse":{ - "type":"structure", - "required":["paymentManagers"], - "members":{ - "paymentManagers":{ - "shape":"PaymentManagerSummaries", - "documentation":"

The list of payment manager summaries. For details about the fields in each summary, see the PaymentManagerSummary data type.

" - }, - "nextToken":{ - "shape":"NextToken", - "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.

" - } - } - }, - "ListPoliciesRequest":{ - "type":"structure", - "required":["policyEngineId"], - "members":{ - "nextToken":{ - "shape":"NextToken", - "documentation":"

A pagination token returned from a previous ListPolicies call. Use this token to retrieve the next page of results when the response is paginated.

", - "location":"querystring", - "locationName":"nextToken" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of policies to return in a single response. If not specified, the default is 10 policies per page, with a maximum of 100 per page.

", - "location":"querystring", - "locationName":"maxResults" - }, - "policyEngineId":{ - "shape":"ResourceId", - "documentation":"

The identifier of the policy engine whose policies to retrieve.

", - "location":"uri", - "locationName":"policyEngineId" - }, - "targetResourceScope":{ - "shape":"BedrockAgentcoreResourceArn", - "documentation":"

Optional filter to list policies that apply to a specific resource scope or resource type. This helps narrow down policy results to those relevant for particular Amazon Web Services resources, agent tools, or operational contexts within the policy engine ecosystem.

", - "location":"querystring", - "locationName":"targetResourceScope" - } - } - }, - "ListPoliciesResponse":{ - "type":"structure", - "required":["policies"], - "members":{ - "policies":{ - "shape":"Policies", - "documentation":"

An array of policy objects that match the specified criteria. Each policy object contains the policy metadata, status, and key identifiers for further operations.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A pagination token that can be used in subsequent ListPolicies calls to retrieve additional results. This token is only present when there are more results available.

" - } - } - }, - "ListPolicyEngineSummariesRequest":{ - "type":"structure", - "members":{ - "nextToken":{ - "shape":"NextToken", - "documentation":"

A pagination token returned from a previous ListPolicyEngineSummaries call. Use this token to retrieve the next page of results when the response is paginated.

", - "location":"querystring", - "locationName":"nextToken" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of policy engine summaries to return in a single response.

", - "location":"querystring", - "locationName":"maxResults" - } - } - }, - "ListPolicyEngineSummariesResponse":{ - "type":"structure", - "required":["policyEngines"], - "members":{ - "policyEngines":{ - "shape":"PolicyEngineSummaryList", - "documentation":"

An array of policy engine summary objects that exist in the account. Each summary contains resource identifiers, status, and timestamps without customer-encrypted content.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A pagination token that can be used in subsequent ListPolicyEngineSummaries calls to retrieve additional results. This token is only present when there are more results available.

" - } - } - }, - "ListPolicyEnginesRequest":{ - "type":"structure", - "members":{ - "nextToken":{ - "shape":"NextToken", - "documentation":"

A pagination token returned from a previous ListPolicyEngines call. Use this token to retrieve the next page of results when the response is paginated.

", - "location":"querystring", - "locationName":"nextToken" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of policy engines to return in a single response. If not specified, the default is 10 policy engines per page, with a maximum of 100 per page.

", - "location":"querystring", - "locationName":"maxResults" - } - } - }, - "ListPolicyEnginesResponse":{ - "type":"structure", - "required":["policyEngines"], - "members":{ - "policyEngines":{ - "shape":"PolicyEngines", - "documentation":"

An array of policy engine objects that exist in the account. Each policy engine object contains the engine metadata, status, and key identifiers for further operations.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A pagination token that can be used in subsequent ListPolicyEngines calls to retrieve additional results. This token is only present when there are more results available.

" - } - } - }, - "ListPolicyGenerationAssetsRequest":{ - "type":"structure", - "required":[ - "policyGenerationId", - "policyEngineId" - ], - "members":{ - "policyGenerationId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the policy generation request whose assets are to be retrieved. This must be a valid generation ID from a previous StartPolicyGeneration call that has completed processing.

", - "location":"uri", - "locationName":"policyGenerationId" - }, - "policyEngineId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the policy engine associated with the policy generation request. This provides the context for the generation operation and ensures assets are retrieved from the correct policy engine.

", - "location":"uri", - "locationName":"policyEngineId" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A pagination token returned from a previous ListPolicyGenerationAssets call. Use this token to retrieve the next page of assets when the response is paginated due to large numbers of generated policy options.

", - "location":"querystring", - "locationName":"nextToken" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of policy generation assets to return in a single response. If not specified, the default is 10 assets per page, with a maximum of 100 per page. This helps control response size when dealing with policy generations that produce many alternative policy options.

", - "location":"querystring", - "locationName":"maxResults" - } - } - }, - "ListPolicyGenerationAssetsResponse":{ - "type":"structure", - "members":{ - "policyGenerationAssets":{ - "shape":"PolicyGenerationAssets", - "documentation":"

An array of generated policy assets including Cedar policies and related artifacts from the AI-powered policy generation process. Each asset represents a different policy option or variation generated from the original natural language input.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A pagination token that can be used in subsequent ListPolicyGenerationAssets calls to retrieve additional assets. This token is only present when there are more generated policy assets available beyond the current response.

" - } - } - }, - "ListPolicyGenerationSummariesRequest":{ - "type":"structure", - "required":["policyEngineId"], - "members":{ - "nextToken":{ - "shape":"NextToken", - "documentation":"

A pagination token returned from a previous ListPolicyGenerationSummaries call. Use this token to retrieve the next page of results when the response is paginated.

", - "location":"querystring", - "locationName":"nextToken" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of policy generation summaries to return in a single response.

", - "location":"querystring", - "locationName":"maxResults" - }, - "policyEngineId":{ - "shape":"ResourceId", - "documentation":"

The identifier of the policy engine whose policy generation summaries to retrieve.

", - "location":"uri", - "locationName":"policyEngineId" - } - } - }, - "ListPolicyGenerationSummariesResponse":{ - "type":"structure", - "required":["policyGenerations"], - "members":{ - "policyGenerations":{ - "shape":"PolicyGenerationSummaryList", - "documentation":"

An array of policy generation summary objects that match the specified criteria. Each summary contains resource identifiers, status, timestamps, and findings without customer-encrypted content.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A pagination token that can be used in subsequent ListPolicyGenerationSummaries calls to retrieve additional results. This token is only present when there are more results available.

" - } - } - }, - "ListPolicyGenerationsRequest":{ - "type":"structure", - "required":["policyEngineId"], - "members":{ - "nextToken":{ - "shape":"NextToken", - "documentation":"

A pagination token for retrieving additional policy generations when results are paginated.

", - "location":"querystring", - "locationName":"nextToken" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of policy generations to return in a single response.

", - "location":"querystring", - "locationName":"maxResults" - }, - "policyEngineId":{ - "shape":"ResourceId", - "documentation":"

The identifier of the policy engine whose policy generations to retrieve.

", - "location":"uri", - "locationName":"policyEngineId" - } - } - }, - "ListPolicyGenerationsResponse":{ - "type":"structure", - "required":["policyGenerations"], - "members":{ - "policyGenerations":{ - "shape":"PolicyGenerations", - "documentation":"

An array of policy generation objects that match the specified criteria.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A pagination token for retrieving additional policy generations if more results are available.

" - } - } - }, - "ListPolicySummariesRequest":{ - "type":"structure", - "required":["policyEngineId"], - "members":{ - "nextToken":{ - "shape":"NextToken", - "documentation":"

A pagination token returned from a previous ListPolicySummaries call. Use this token to retrieve the next page of results when the response is paginated.

", - "location":"querystring", - "locationName":"nextToken" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of policy summaries to return in a single response.

", - "location":"querystring", - "locationName":"maxResults" - }, - "policyEngineId":{ - "shape":"ResourceId", - "documentation":"

The identifier of the policy engine whose policy summaries to retrieve.

", - "location":"uri", - "locationName":"policyEngineId" - }, - "targetResourceScope":{ - "shape":"BedrockAgentcoreResourceArn", - "documentation":"

Optional filter to list policy summaries that apply to a specific resource scope or resource type. This helps narrow down results to those relevant for particular Amazon Web Services resources, agent tools, or operational contexts within the policy engine ecosystem.

", - "location":"querystring", - "locationName":"targetResourceScope" - } - } - }, - "ListPolicySummariesResponse":{ - "type":"structure", - "required":["policies"], - "members":{ - "policies":{ - "shape":"PolicySummaryList", - "documentation":"

An array of policy summary objects that match the specified criteria. Each summary contains resource identifiers, status, and timestamps without customer-encrypted content.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A pagination token that can be used in subsequent ListPolicySummaries calls to retrieve additional results. This token is only present when there are more results available.

" - } - } - }, - "ListRegistriesRequest":{ - "type":"structure", - "members":{ - "maxResults":{ - "shape":"MaxResults", - "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.

", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"NextToken", - "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.

", - "location":"querystring", - "locationName":"nextToken" - }, - "status":{ - "shape":"RegistryStatus", - "documentation":"

Filter registries by their current status. Possible values include CREATING, READY, UPDATING, CREATE_FAILED, UPDATE_FAILED, DELETING, and DELETE_FAILED.

", - "location":"querystring", - "locationName":"status" - }, - "authorizerType":{ - "shape":"RegistryAuthorizerType", - "documentation":"

Filter registries by their authorizer type. Possible values are CUSTOM_JWT and AWS_IAM. For more information about authorizer types, see the RegistryAuthorizerType enum.

", - "location":"querystring", - "locationName":"authorizerType" - } - } - }, - "ListRegistriesResponse":{ - "type":"structure", - "required":["registries"], - "members":{ - "registries":{ - "shape":"RegistrySummaryList", - "documentation":"

The list of registry summaries. For details about the fields in each summary, see the RegistrySummary data type.

" - }, - "nextToken":{ - "shape":"NextToken", - "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.

" - } - } - }, - "ListRegistryRecordsRequest":{ - "type":"structure", - "required":["registryId"], - "members":{ - "registryId":{ - "shape":"RegistryIdentifier", - "documentation":"

The identifier of the registry to list records from. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.

", - "location":"uri", - "locationName":"registryId" - }, - "maxResults":{ - "shape":"MaxResults", - "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.

", - "location":"querystring", - "locationName":"maxResults" - }, - "nextToken":{ - "shape":"NextToken", - "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.

", - "location":"querystring", - "locationName":"nextToken" - }, - "name":{ - "shape":"RegistryRecordName", - "documentation":"

Filter registry records by name.

", - "location":"querystring", - "locationName":"name" - }, - "status":{ - "shape":"RegistryRecordStatus", - "documentation":"

Filter registry records by their current status. Possible values include CREATING, DRAFT, APPROVED, PENDING_APPROVAL, REJECTED, DEPRECATED, UPDATING, CREATE_FAILED, and UPDATE_FAILED.

", - "location":"querystring", - "locationName":"status" - }, - "descriptorType":{ - "shape":"DescriptorType", - "documentation":"

Filter registry records by their descriptor type. Possible values are MCP, A2A, CUSTOM, and AGENT_SKILLS.

", - "location":"querystring", - "locationName":"descriptorType" - } - } - }, - "ListRegistryRecordsResponse":{ - "type":"structure", - "required":["registryRecords"], - "members":{ - "registryRecords":{ - "shape":"RegistryRecordSummaryList", - "documentation":"

The list of registry record summaries. For details about the fields in each summary, see the RegistryRecordSummary data type.

" - }, - "nextToken":{ - "shape":"NextToken", - "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.

" - } - } - }, - "ListTagsForResourceRequest":{ - "type":"structure", - "required":["resourceArn"], - "members":{ - "resourceArn":{ - "shape":"TaggableResourcesArn", - "documentation":"

The Amazon Resource Name (ARN) of the resource for which you want to list tags.

", - "location":"uri", - "locationName":"resourceArn" - } - } - }, - "ListTagsForResourceResponse":{ - "type":"structure", - "members":{ - "tags":{ - "shape":"TagsMap", - "documentation":"

The tags associated with the resource.

" - } - } - }, - "ListWorkloadIdentitiesRequest":{ - "type":"structure", - "members":{ - "nextToken":{ - "shape":"String", - "documentation":"

Pagination token.

" - }, - "maxResults":{ - "shape":"ListWorkloadIdentitiesRequestMaxResultsInteger", - "documentation":"

Maximum number of results to return.

" - } - } - }, - "ListWorkloadIdentitiesRequestMaxResultsInteger":{ - "type":"integer", - "box":true, - "max":20, - "min":1 - }, - "ListWorkloadIdentitiesResponse":{ - "type":"structure", - "required":["workloadIdentities"], - "members":{ - "workloadIdentities":{ - "shape":"WorkloadIdentityList", - "documentation":"

The list of workload identities.

" - }, - "nextToken":{ - "shape":"String", - "documentation":"

Pagination token for the next page of results.

" - } - } - }, - "ListingMode":{ - "type":"string", - "enum":[ - "DEFAULT", - "DYNAMIC" - ] - }, - "LlmAsAJudgeEvaluatorConfig":{ - "type":"structure", - "required":[ - "instructions", - "ratingScale", - "modelConfig" - ], - "members":{ - "instructions":{ - "shape":"EvaluatorInstructions", - "documentation":"

The evaluation instructions that guide the language model in assessing agent performance, including criteria and evaluation guidelines.

" - }, - "ratingScale":{ - "shape":"RatingScale", - "documentation":"

The rating scale that defines how the evaluator should score agent performance, either numerical or categorical.

" - }, - "modelConfig":{ - "shape":"EvaluatorModelConfig", - "documentation":"

The model configuration that specifies which foundation model to use and how to configure it for evaluation.

" - } - }, - "documentation":"

The configuration for LLM-as-a-Judge evaluation that uses a language model to assess agent performance based on custom instructions and rating scales.

" - }, - "LlmExtractionConfig":{ - "type":"structure", - "required":["definition"], - "members":{ - "llmExtractionInstruction":{ - "shape":"LlmExtractionInstruction", - "documentation":"

Instructions for extraction. Supports built-in operators like LATEST_VALUE or custom natural-language instructions.

" - }, - "definition":{ - "shape":"Definition", - "documentation":"

Description of what this metadata field represents.

" - }, - "validation":{ - "shape":"Validation", - "documentation":"

Validation rules to constrain extracted values.

" - } - }, - "documentation":"

Model-based metadata extraction configuration.

" - }, - "LlmExtractionInstruction":{ - "type":"string", - "max":1000, - "min":1, - "sensitive":true - }, - "LogGroupName":{ - "type":"string", - "pattern":"[.\\-_/#A-Za-z0-9]+" - }, - "Long":{ - "type":"long", - "box":true - }, - "MCPGatewayConfiguration":{ - "type":"structure", - "members":{ - "supportedVersions":{ - "shape":"McpSupportedVersions", - "documentation":"

The supported versions of the Model Context Protocol. This field specifies which versions of the protocol the gateway can use.

" - }, - "instructions":{ - "shape":"McpInstructions", - "documentation":"

The instructions for using the Model Context Protocol gateway. These instructions provide guidance on how to interact with the gateway.

" - }, - "searchType":{ - "shape":"SearchType", - "documentation":"

The search type for the Model Context Protocol gateway. This field specifies how the gateway handles search operations.

" - }, - "sessionConfiguration":{ - "shape":"SessionConfiguration", - "documentation":"

The session configuration for the MCP gateway. This configuration controls session behavior, including session timeout settings.

" - }, - "streamingConfiguration":{ - "shape":"StreamingConfiguration", - "documentation":"

The streaming configuration for the MCP gateway. This configuration controls whether response streaming is enabled for the gateway.

" - } - }, - "documentation":"

The configuration for a Model Context Protocol (MCP) gateway. This structure defines how the gateway implements the MCP protocol.

" - }, - "ManagedResourceDetails":{ - "type":"structure", - "members":{ - "domain":{ - "shape":"DomainName", - "documentation":"

The domain associated with this managed resource.

" - }, - "resourceGatewayArn":{ - "shape":"ResourceGatewayArn", - "documentation":"

The ARN of the VPC Lattice resource gateway created in your account.

" - }, - "resourceAssociationArn":{ - "shape":"ResourceAssociationArn", - "documentation":"

The ARN of the service network resource association.

" - } - }, - "documentation":"

Details of a resource created and managed by the gateway for private endpoint connectivity.

" - }, - "ManagedVpcResource":{ - "type":"structure", - "required":[ - "vpcIdentifier", - "subnetIds", - "endpointIpAddressType" - ], - "members":{ - "vpcIdentifier":{ - "shape":"VpcIdentifier", - "documentation":"

The ID of the VPC that contains your private resource.

" - }, - "subnetIds":{ - "shape":"SubnetIds", - "documentation":"

The subnet IDs within the VPC where the VPC Lattice resource gateway is placed.

" - }, - "endpointIpAddressType":{ - "shape":"EndpointIpAddressType", - "documentation":"

The IP address type for the resource configuration endpoint.

" - }, - "securityGroupIds":{ - "shape":"SecurityGroupIds", - "documentation":"

The security group IDs to associate with the VPC Lattice resource gateway. If not specified, the default security group for the VPC is used.

" - }, - "tags":{ - "shape":"TagsMap", - "documentation":"

Tags to apply to the managed VPC Lattice resource gateway.

" - }, - "routingDomain":{ - "shape":"RoutingDomain", - "documentation":"

An intermediate domain to use as the resource configuration endpoint instead of the actual target domain. Use this when you want to route traffic through an intermediate component such as a VPC endpoint or internal load balancer. For more information, see xref:lattice-vpc-egress-routing-domain[Route traffic through an intermediate domain].

" - } - }, - "documentation":"

Configuration for a managed VPC Lattice resource. The gateway creates and manages the VPC Lattice resource gateway and resource configuration on your behalf using a service-linked role.

" - }, - "MatchPathPattern":{ - "type":"string", - "max":512, - "min":0, - "pattern":"/[\\w\\-.]+/\\*" - }, - "MatchPaths":{ - "type":"structure", - "required":["anyOf"], - "members":{ - "anyOf":{ - "shape":"MatchPathsAnyOfList", - "documentation":"

A list of path patterns. The condition is met if the request path matches any of the patterns.

" - } - }, - "documentation":"

A condition that matches requests based on the request path.

" - }, - "MatchPathsAnyOfList":{ - "type":"list", - "member":{"shape":"MatchPathPattern"}, - "max":10, - "min":1 - }, - "MatchPrincipalEntry":{ - "type":"structure", - "members":{ - "iamPrincipal":{ - "shape":"IamPrincipal", - "documentation":"

An IAM principal to match against, specified by ARN.

" - } - }, - "documentation":"

Union for principal matching. Currently supports IAM principal ARN glob matching.

", - "union":true - }, - "MatchPrincipals":{ - "type":"structure", - "required":["anyOf"], - "members":{ - "anyOf":{ - "shape":"MatchPrincipalsAnyOfList", - "documentation":"

A list of principal entries. The condition is met if any of the entries match the caller's identity.

" - } - }, - "documentation":"

A condition that matches requests based on the caller's identity.

" - }, - "MatchPrincipalsAnyOfList":{ - "type":"list", - "member":{"shape":"MatchPrincipalEntry"}, - "max":100, - "min":1 - }, - "MatchValueString":{ - "type":"string", - "max":255, - "min":1, - "pattern":"[A-Za-z0-9_.-]+" - }, - "MatchValueStringList":{ - "type":"list", - "member":{"shape":"MatchValueString"}, - "min":1 - }, - "MaxResults":{ - "type":"integer", - "box":true, - "max":100, - "min":1 - }, - "MaxTokens":{ - "type":"integer", - "box":true, - "min":1 - }, - "McpDescriptor":{ - "type":"structure", - "members":{ - "server":{ - "shape":"ServerDefinition", - "documentation":"

The MCP server definition, containing the server configuration and schema as defined by the MCP protocol specification.

" - }, - "tools":{ - "shape":"ToolsDefinition", - "documentation":"

The MCP tools definition, containing the tools available on the MCP server as defined by the MCP protocol specification.

" - } - }, - "documentation":"

The Model Context Protocol (MCP) descriptor for a registry record. Contains the server definition and tools definition for an MCP-compatible server. The schema is validated against the MCP protocol specification.

" - }, - "McpInstructions":{ - "type":"string", - "max":2048, - "min":1, - "sensitive":true - }, - "McpLambdaTargetConfiguration":{ - "type":"structure", - "required":[ - "lambdaArn", - "toolSchema" - ], - "members":{ - "lambdaArn":{ - "shape":"LambdaFunctionArn", - "documentation":"

The Amazon Resource Name (ARN) of the Lambda function. This function is invoked by the gateway to communicate with the target.

" - }, - "toolSchema":{ - "shape":"ToolSchema", - "documentation":"

The tool schema for the Lambda function. This schema defines the structure of the tools that the Lambda function provides.

" - } - }, - "documentation":"

The Lambda configuration for a Model Context Protocol target. This structure defines how the gateway uses a Lambda function to communicate with the target.

" - }, - "McpServerTargetConfiguration":{ - "type":"structure", - "required":["endpoint"], - "members":{ - "endpoint":{ - "shape":"McpServerTargetConfigurationEndpointString", - "documentation":"

The endpoint for the MCP server target configuration.

" - }, - "mcpToolSchema":{ - "shape":"McpToolSchemaConfiguration", - "documentation":"

The tool schema configuration for the MCP server target. Supported only when the credential provider is configured with an authorization code grant type. Dynamic tool discovery/synchronization will be disabled when target is configured with mcpToolSchema.

" - }, - "listingMode":{ - "shape":"ListingMode", - "documentation":"

The listing mode for the MCP server target configuration. MCP resources for default targets are cached at the control plane for faster access. MCP resources for dynamic targets will be dynamically retrieved when listing tools.

" - }, - "resourcePriority":{ - "shape":"TargetResourcePriority", - "documentation":"

Priority for resolving MCP server targets with shared resource URIs. Lower values take precedence. Defaults to 1000 when not set.

" - } - }, - "documentation":"

The target configuration for the MCP server.

" - }, - "McpServerTargetConfigurationEndpointString":{ - "type":"string", - "pattern":"https://.*" - }, - "McpServerUrl":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"https://.*" - }, - "McpSupportedVersions":{ - "type":"list", - "member":{"shape":"McpVersion"} - }, - "McpTargetConfiguration":{ - "type":"structure", - "members":{ - "openApiSchema":{ - "shape":"ApiSchemaConfiguration", - "documentation":"

The OpenAPI schema for the Model Context Protocol target. This schema defines the API structure of the target.

" - }, - "smithyModel":{ - "shape":"ApiSchemaConfiguration", - "documentation":"

The Smithy model for the Model Context Protocol target. This model defines the API structure of the target using the Smithy specification.

" - }, - "lambda":{ - "shape":"McpLambdaTargetConfiguration", - "documentation":"

The Lambda configuration for the Model Context Protocol target. This configuration defines how the gateway uses a Lambda function to communicate with the target.

" - }, - "mcpServer":{ - "shape":"McpServerTargetConfiguration", - "documentation":"

The MCP server specified as the gateway target.

" - }, - "apiGateway":{ - "shape":"ApiGatewayTargetConfiguration", - "documentation":"

The configuration for an Amazon API Gateway target.

" - }, - "connector":{ - "shape":"ConnectorTargetConfiguration", - "documentation":"

The connector integration configuration for the Model Context Protocol target. This configuration defines how the gateway uses a pre-built connector to communicate with the target.

" - } - }, - "documentation":"

The Model Context Protocol (MCP) configuration for a target. This structure defines how the gateway uses MCP to communicate with the target.

", - "union":true - }, - "McpToolSchemaConfiguration":{ - "type":"structure", - "members":{ - "s3":{ - "shape":"S3Configuration", - "documentation":"

The Amazon S3 location of the tool schema. This location contains the schema definition file.

" - }, - "inlinePayload":{ - "shape":"InlinePayload", - "documentation":"

The inline payload containing the MCP tool schema definition.

" - } - }, - "documentation":"

The MCP tool schema configuration for an MCP server target. The tool schema must be aligned with the MCP specification.

", - "union":true - }, - "McpVersion":{"type":"string"}, - "Memory":{ - "type":"structure", - "required":[ - "arn", - "id", - "name", - "eventExpiryDuration", - "status", - "createdAt", - "updatedAt" - ], - "members":{ - "arn":{ - "shape":"MemoryArn", - "documentation":"

The Amazon Resource Name (ARN) of the memory.

" - }, - "id":{ - "shape":"MemoryId", - "documentation":"

The unique identifier of the memory.

" - }, - "name":{ - "shape":"Name", - "documentation":"

The name of the memory.

" - }, - "description":{ - "shape":"Description", - "documentation":"

The description of the memory.

" - }, - "encryptionKeyArn":{ - "shape":"Arn", - "documentation":"

The ARN of the KMS key used to encrypt the memory.

" - }, - "memoryExecutionRoleArn":{ - "shape":"Arn", - "documentation":"

The ARN of the IAM role that provides permissions for the memory.

" - }, - "eventExpiryDuration":{ - "shape":"MemoryEventExpiryDurationInteger", - "documentation":"

The number of days after which memory events will expire.

" - }, - "status":{ - "shape":"MemoryStatus", - "documentation":"

The current status of the memory.

" - }, - "failureReason":{ - "shape":"String", - "documentation":"

The reason for failure if the memory is in a failed state.

" - }, - "createdAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the memory was created.

" - }, - "updatedAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the memory was last updated.

" - }, - "strategies":{ - "shape":"MemoryStrategyList", - "documentation":"

The list of memory strategies associated with this memory.

" - }, - "indexedKeys":{ - "shape":"IndexedKeysList", - "documentation":"

The indexed metadata keys for this memory. Only indexed keys can be used in metadata filters.

" - }, - "streamDeliveryResources":{ - "shape":"StreamDeliveryResources", - "documentation":"

Configuration for streaming memory record data to external resources.

" - }, - "managedByResourceArn":{ - "shape":"Arn", - "documentation":"

ARN of the resource managing this memory (e.g. a harness). When set, strategy modifications and deletion are only allowed through the managing resource.

" - } - }, - "documentation":"

Contains information about a memory resource.

" - }, - "MemoryArn":{ - "type":"string", - "pattern":"arn:aws:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:memory\\/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}" - }, - "MemoryEventExpiryDurationInteger":{ - "type":"integer", - "box":true, - "max":365, - "min":1 - }, - "MemoryId":{ - "type":"string", - "min":12, - "pattern":"[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}" - }, - "MemoryRecordSchema":{ - "type":"structure", - "members":{ - "metadataSchema":{ - "shape":"MetadataSchemaList", - "documentation":"

The metadata field definitions for this strategy.

" - } - }, - "documentation":"

Schema for metadata on memory records generated by a strategy.

" - }, - "MemoryStatus":{ - "type":"string", - "enum":[ - "CREATING", - "ACTIVE", - "FAILED", - "DELETING", - "UPDATING" - ] - }, - "MemoryStrategy":{ - "type":"structure", - "required":[ - "strategyId", - "name", - "type", - "namespaces", - "namespaceTemplates" - ], - "members":{ - "strategyId":{ - "shape":"MemoryStrategyId", - "documentation":"

The unique identifier of the memory strategy.

" - }, - "name":{ - "shape":"Name", - "documentation":"

The name of the memory strategy.

" - }, - "description":{ - "shape":"Description", - "documentation":"

The description of the memory strategy.

" - }, - "configuration":{ - "shape":"StrategyConfiguration", - "documentation":"

The configuration of the memory strategy.

" - }, - "type":{ - "shape":"MemoryStrategyType", - "documentation":"

The type of the memory strategy.

" - }, - "namespaces":{ - "shape":"NamespacesList", - "documentation":"

This is a legacy parameter. The namespaces associated with the memory strategy.

", - "deprecated":true, - "deprecatedMessage":"Use namespaceTemplates instead", - "deprecatedSince":"2026-03-02" - }, - "namespaceTemplates":{ - "shape":"NamespacesList", - "documentation":"

The namespaceTemplates associated with the memory strategy.

" - }, - "createdAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the memory strategy was created.

" - }, - "updatedAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the memory strategy was last updated.

" - }, - "status":{ - "shape":"MemoryStrategyStatus", - "documentation":"

The current status of the memory strategy.

" - }, - "memoryRecordSchema":{ - "shape":"MemoryRecordSchema", - "documentation":"

Schema for metadata fields on records generated by this strategy.

" - } - }, - "documentation":"

Contains information about a memory strategy.

" - }, - "MemoryStrategyId":{ - "type":"string", - "min":12, - "pattern":"[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}" - }, - "MemoryStrategyInput":{ - "type":"structure", - "members":{ - "semanticMemoryStrategy":{ - "shape":"SemanticMemoryStrategyInput", - "documentation":"

Input for creating a semantic memory strategy.

" - }, - "summaryMemoryStrategy":{ - "shape":"SummaryMemoryStrategyInput", - "documentation":"

Input for creating a summary memory strategy.

" - }, - "userPreferenceMemoryStrategy":{ - "shape":"UserPreferenceMemoryStrategyInput", - "documentation":"

Input for creating a user preference memory strategy.

" - }, - "customMemoryStrategy":{ - "shape":"CustomMemoryStrategyInput", - "documentation":"

Input for creating a custom memory strategy.

" - }, - "episodicMemoryStrategy":{ - "shape":"EpisodicMemoryStrategyInput", - "documentation":"

Input for creating an episodic memory strategy

" - } - }, - "documentation":"

Contains input information for creating a memory strategy.

", - "union":true - }, - "MemoryStrategyInputList":{ - "type":"list", - "member":{"shape":"MemoryStrategyInput"} - }, - "MemoryStrategyList":{ - "type":"list", - "member":{"shape":"MemoryStrategy"} - }, - "MemoryStrategyStatus":{ - "type":"string", - "enum":[ - "CREATING", - "ACTIVE", - "DELETING", - "FAILED" - ] - }, - "MemoryStrategyType":{ - "type":"string", - "enum":[ - "SEMANTIC", - "SUMMARIZATION", - "USER_PREFERENCE", - "CUSTOM", - "EPISODIC" - ] - }, - "MemorySummary":{ - "type":"structure", - "required":[ - "createdAt", - "updatedAt" - ], - "members":{ - "arn":{ - "shape":"MemoryArn", - "documentation":"

The Amazon Resource Name (ARN) of the memory.

" - }, - "id":{ - "shape":"MemoryId", - "documentation":"

The unique identifier of the memory.

" - }, - "status":{ - "shape":"MemoryStatus", - "documentation":"

The current status of the memory.

" - }, - "createdAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the memory was created.

" - }, - "updatedAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the memory was last updated.

" - }, - "managedByResourceArn":{ - "shape":"Arn", - "documentation":"

ARN of the resource managing this memory (e.g. a harness). Null if not managed.

" - } - }, - "documentation":"

Contains summary information about a memory resource.

" - }, - "MemorySummaryList":{ - "type":"list", - "member":{"shape":"MemorySummary"} - }, - "MemoryView":{ - "type":"string", - "enum":[ - "full", - "without_decryption" - ] - }, - "MessageBasedTrigger":{ - "type":"structure", - "members":{ - "messageCount":{ - "shape":"Integer", - "documentation":"

The number of messages that trigger memory processing.

" - } - }, - "documentation":"

The trigger configuration based on a message.

" - }, - "MessageBasedTriggerInput":{ - "type":"structure", - "members":{ - "messageCount":{ - "shape":"MessageBasedTriggerInputMessageCountInteger", - "documentation":"

The number of messages that trigger memory processing.

" - } - }, - "documentation":"

The trigger configuration based on a message.

" - }, - "MessageBasedTriggerInputMessageCountInteger":{ - "type":"integer", - "box":true, - "max":50, - "min":1 - }, - "MetadataConfiguration":{ - "type":"structure", - "members":{ - "allowedRequestHeaders":{ - "shape":"AllowedRequestHeaders", - "documentation":"

A list of HTTP headers that are allowed to be propagated from incoming client requests to the target.

" - }, - "allowedQueryParameters":{ - "shape":"AllowedQueryParameters", - "documentation":"

A list of URL query parameters that are allowed to be propagated from incoming gateway URL to the target.

" - }, - "allowedResponseHeaders":{ - "shape":"AllowedResponseHeaders", - "documentation":"

A list of HTTP headers that are allowed to be propagated from the target response back to the client.

" - } - }, - "documentation":"

Configuration for HTTP header and query parameter propagation between the gateway and target servers.

" - }, - "MetadataKey":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[a-zA-Z0-9\\s._:/=+@-]*" - }, - "MetadataSchemaEntry":{ - "type":"structure", - "required":["key"], - "members":{ - "key":{ - "shape":"MetadataKey", - "documentation":"

The metadata field name. Must match an indexed key to be queryable via metadata filters.

" - }, - "type":{ - "shape":"MetadataValueType", - "documentation":"

The MetadataValueType.

" - }, - "extractionType":{ - "shape":"ExtractionType", - "documentation":"

Specifies whether the metadata value is extracted by the LLM or passed through deterministically from the event.

" - }, - "extractionConfig":{ - "shape":"ExtractionConfig", - "documentation":"

Configuration for extracting this metadata value from conversational content. Applicable only if extractionType is LLM inferred.

" - } - }, - "documentation":"

A metadata field definition within a strategy's schema.

" - }, - "MetadataSchemaList":{ - "type":"list", - "member":{"shape":"MetadataSchemaEntry"}, - "max":20, - "min":1 - }, - "MetadataValueType":{ - "type":"string", - "enum":[ - "STRING", - "STRINGLIST", - "NUMBER" - ] - }, - "MicrosoftOauth2ProviderConfigInput":{ - "type":"structure", - "required":["clientId"], - "members":{ - "clientId":{ - "shape":"ClientIdType", - "documentation":"

The client ID for the Microsoft OAuth2 provider.

" - }, - "clientSecret":{ - "shape":"DefaultClientSecretType", - "documentation":"

The client secret for the Microsoft OAuth2 provider.

" - }, - "clientSecretConfig":{ - "shape":"SecretReference", - "documentation":"

A reference to the Amazon Web Services Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when clientSecretSource is set to EXTERNAL.

" - }, - "clientSecretSource":{ - "shape":"SecretSourceType", - "documentation":"

The source type of the client secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.

" - }, - "tenantId":{ - "shape":"TenantIdType", - "documentation":"

The Microsoft Entra ID (formerly Azure AD) tenant ID for your organization. This identifies the specific tenant within Microsoft's identity platform where your application is registered.

" - } - }, - "documentation":"

Input configuration for a Microsoft OAuth2 provider.

" - }, - "MicrosoftOauth2ProviderConfigOutput":{ - "type":"structure", - "required":["oauthDiscovery"], - "members":{ - "oauthDiscovery":{ - "shape":"Oauth2Discovery", - "documentation":"

The OAuth2 discovery information for the Microsoft provider.

" - }, - "clientId":{ - "shape":"ClientIdType", - "documentation":"

The client ID for the Microsoft OAuth2 provider.

" - } - }, - "documentation":"

Output configuration for a Microsoft OAuth2 provider.

" - }, - "ModelEntries":{ - "type":"list", - "member":{"shape":"ModelEntry"}, - "max":100, - "min":1 - }, - "ModelEntry":{ - "type":"structure", - "required":["model"], - "members":{ - "model":{ - "shape":"ModelPattern", - "documentation":"

The model ID or glob pattern that identifies the model (for example, anthropic.claude-opus-* or openai.gpt-oss-*).

" - } - }, - "documentation":"

A model entry that specifies a model supported for an inference operation.

" - }, - "ModelId":{"type":"string"}, - "ModelMapping":{ - "type":"structure", - "members":{ - "providerPrefix":{ - "shape":"ProviderPrefix", - "documentation":"

The provider prefix configuration used for model ID translation.

" - } - }, - "documentation":"

The configuration that translates model IDs between client-facing names and provider model IDs.

" - }, - "ModelPattern":{ - "type":"string", - "max":256, - "min":1, - "pattern":"[a-zA-Z0-9\\-\\._\\*\\?@]+(/[a-zA-Z0-9\\-\\._\\*\\?@]+)*" - }, - "ModifyConsolidationConfiguration":{ - "type":"structure", - "members":{ - "customConsolidationConfiguration":{ - "shape":"CustomConsolidationConfigurationInput", - "documentation":"

The updated custom consolidation configuration.

" - } - }, - "documentation":"

Contains information for modifying a consolidation configuration.

", - "union":true - }, - "ModifyExtractionConfiguration":{ - "type":"structure", - "members":{ - "customExtractionConfiguration":{ - "shape":"CustomExtractionConfigurationInput", - "documentation":"

The updated custom extraction configuration.

" - } - }, - "documentation":"

Contains information for modifying an extraction configuration.

", - "union":true - }, - "ModifyInvocationConfigurationInput":{ - "type":"structure", - "members":{ - "topicArn":{ - "shape":"Arn", - "documentation":"

The updated ARN of the SNS topic for job notifications.

" - }, - "payloadDeliveryBucketName":{ - "shape":"ModifyInvocationConfigurationInputPayloadDeliveryBucketNameString", - "documentation":"

The updated S3 bucket name for event payload delivery.

" - } - }, - "documentation":"

The configuration for updating invocation settings.

" - }, - "ModifyInvocationConfigurationInputPayloadDeliveryBucketNameString":{ - "type":"string", - "pattern":"[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]" - }, - "ModifyMemoryStrategies":{ - "type":"structure", - "members":{ - "addMemoryStrategies":{ - "shape":"MemoryStrategyInputList", - "documentation":"

The list of memory strategies to add.

" - }, - "modifyMemoryStrategies":{ - "shape":"ModifyMemoryStrategiesList", - "documentation":"

The list of memory strategies to modify.

" - }, - "deleteMemoryStrategies":{ - "shape":"DeleteMemoryStrategiesList", - "documentation":"

The list of memory strategies to delete.

" - } - }, - "documentation":"

Contains information for modifying memory strategies.

" - }, - "ModifyMemoryStrategiesList":{ - "type":"list", - "member":{"shape":"ModifyMemoryStrategyInput"} - }, - "ModifyMemoryStrategyInput":{ - "type":"structure", - "required":["memoryStrategyId"], - "members":{ - "memoryStrategyId":{ - "shape":"String", - "documentation":"

The unique identifier of the memory strategy to modify.

" - }, - "description":{ - "shape":"Description", - "documentation":"

The updated description of the memory strategy.

" - }, - "namespaces":{ - "shape":"NamespacesList", - "documentation":"

This is a legacy parameter, use namespaceTemplates. The updated namespaces for the memory strategy.

", - "deprecated":true, - "deprecatedMessage":"Use namespaceTemplates instead", - "deprecatedSince":"2026-03-02" - }, - "namespaceTemplates":{ - "shape":"NamespacesList", - "documentation":"

The updated namespaceTemplates for the memory strategy.

" - }, - "configuration":{ - "shape":"ModifyStrategyConfiguration", - "documentation":"

The updated configuration for the memory strategy.

" - }, - "memoryRecordSchema":{ - "shape":"MemoryRecordSchema", - "documentation":"

Updated metadata schema for records generated by this strategy.

" - } - }, - "documentation":"

Input for modifying a memory strategy.

" - }, - "ModifyReflectionConfiguration":{ - "type":"structure", - "members":{ - "episodicReflectionConfiguration":{ - "shape":"EpisodicReflectionConfigurationInput", - "documentation":"

The updated episodic reflection configuration.

" - }, - "customReflectionConfiguration":{ - "shape":"CustomReflectionConfigurationInput", - "documentation":"

The updated custom reflection configuration.

" - } - }, - "documentation":"

Contains information for modifying a reflection configuration.

", - "union":true - }, - "ModifySelfManagedConfiguration":{ - "type":"structure", - "members":{ - "triggerConditions":{ - "shape":"TriggerConditionInputList", - "documentation":"

The updated list of conditions that trigger memory processing.

" - }, - "invocationConfiguration":{ - "shape":"ModifyInvocationConfigurationInput", - "documentation":"

The updated configuration to invoke self-managed memory processing pipeline.

" - }, - "historicalContextWindowSize":{ - "shape":"ModifySelfManagedConfigurationHistoricalContextWindowSizeInteger", - "documentation":"

The updated number of historical messages to include in processing context.

" - } - }, - "documentation":"

The configuration for updating the self-managed memory strategy.

" - }, - "ModifySelfManagedConfigurationHistoricalContextWindowSizeInteger":{ - "type":"integer", - "box":true, - "max":50, - "min":0 - }, - "ModifyStrategyConfiguration":{ - "type":"structure", - "members":{ - "extraction":{ - "shape":"ModifyExtractionConfiguration", - "documentation":"

The updated extraction configuration.

" - }, - "consolidation":{ - "shape":"ModifyConsolidationConfiguration", - "documentation":"

The updated consolidation configuration.

" - }, - "reflection":{ - "shape":"ModifyReflectionConfiguration", - "documentation":"

The updated reflection configuration.

" - }, - "selfManagedConfiguration":{ - "shape":"ModifySelfManagedConfiguration", - "documentation":"

The updated self-managed configuration.

" - } - }, - "documentation":"

Contains information for modifying a strategy configuration.

" - }, - "MountPath":{ - "type":"string", - "max":200, - "min":6, - "pattern":"/mnt/[a-zA-Z0-9._-]+/?" - }, - "Name":{ - "type":"string", - "pattern":"[a-zA-Z][a-zA-Z0-9_]{0,47}" - }, - "Namespace":{ - "type":"string", - "max":512, - "min":1, - "pattern":"[a-zA-Z0-9\\-_\\/]*(\\{(actorId|sessionId|memoryStrategyId)\\}[a-zA-Z0-9\\-_\\/]*)*" - }, - "NamespacesList":{ - "type":"list", - "member":{"shape":"Namespace"}, - "max":1, - "min":1 - }, - "NaturalLanguage":{ - "type":"string", - "max":2000, - "min":1 - }, - "NetworkConfiguration":{ - "type":"structure", - "required":["networkMode"], - "members":{ - "networkMode":{ - "shape":"NetworkMode", - "documentation":"

The network mode for the AgentCore Runtime.

" - }, - "networkModeConfig":{ - "shape":"VpcConfig", - "documentation":"

The network mode configuration for the AgentCore Runtime.

" - } - }, - "documentation":"

SecurityConfig for the Agent.

" - }, - "NetworkMode":{ - "type":"string", - "enum":[ - "PUBLIC", - "VPC" - ] - }, - "NextToken":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"\\S*" - }, - "NonBlankString":{ - "type":"string", - "pattern":"[\\s\\S]+" - }, - "NonEmptyString":{ - "type":"string", - "min":1 - }, - "NumberValidation":{ - "type":"structure", - "members":{ - "minValue":{ - "shape":"Double", - "documentation":"

Minimum allowed value.

" - }, - "maxValue":{ - "shape":"Double", - "documentation":"

Maximum allowed value.

" - } - }, - "documentation":"

Validation for NUMBER fields.

" - }, - "NumericalScaleDefinition":{ - "type":"structure", - "required":[ - "definition", - "value", - "label" - ], - "members":{ - "definition":{ - "shape":"String", - "documentation":"

The description that explains what this numerical rating represents and when it should be used.

" - }, - "value":{ - "shape":"NumericalScaleDefinitionValueDouble", - "documentation":"

The numerical value for this rating scale option.

" - }, - "label":{ - "shape":"NumericalScaleDefinitionLabelString", - "documentation":"

The label or name that describes this numerical rating option.

" - } - }, - "documentation":"

The definition of a numerical rating scale option that provides a numeric value with its description for evaluation scoring.

" - }, - "NumericalScaleDefinitionLabelString":{ - "type":"string", - "max":100, - "min":1 - }, - "NumericalScaleDefinitionValueDouble":{ - "type":"double", - "box":true, - "min":0 - }, - "NumericalScaleDefinitions":{ - "type":"list", - "member":{"shape":"NumericalScaleDefinition"} - }, - "OAuth2AuthorizationData":{ - "type":"structure", - "required":["authorizationUrl"], - "members":{ - "authorizationUrl":{ - "shape":"OAuth2AuthorizationDataAuthorizationUrlString", - "documentation":"

The URL to initiate the authorization process. This URL is provided when the OAuth2 access token requires user authorization.

" - }, - "userId":{ - "shape":"OAuth2AuthorizationDataUserIdString", - "documentation":"

The user identifier associated with the OAuth2 authorization session that is defined by AgentCore Gateway.

" - } - }, - "documentation":"

OAuth2-specific authorization data, including the authorization URL and user identifier for the authorization session.

" - }, - "OAuth2AuthorizationDataAuthorizationUrlString":{ - "type":"string", - "min":1 - }, - "OAuth2AuthorizationDataUserIdString":{ - "type":"string", - "max":128, - "min":1 - }, - "OAuthCredentialProvider":{ - "type":"structure", - "required":[ - "providerArn", - "scopes" - ], - "members":{ - "providerArn":{ - "shape":"OAuthCredentialProviderArn", - "documentation":"

The Amazon Resource Name (ARN) of the OAuth credential provider. This ARN identifies the provider in Amazon Web Services.

" - }, - "scopes":{ - "shape":"OAuthScopes", - "documentation":"

The OAuth scopes for the credential provider. These scopes define the level of access requested from the OAuth provider.

" - }, - "customParameters":{ - "shape":"OAuthCustomParameters", - "documentation":"

The custom parameters for the OAuth credential provider. These parameters provide additional configuration for the OAuth authentication process.

" - }, - "grantType":{ - "shape":"OAuthGrantType", - "documentation":"

Specifies the kind of credentials to use for authorization:

  • CLIENT_CREDENTIALS - Authorization with a client ID and secret.

  • AUTHORIZATION_CODE - Authorization with a token that is specific to an individual end user.

  • TOKEN_EXCHANGE - Authorization using on-behalf-of token exchange. An inbound user token is exchanged for a downstream access token scoped to the target audience.

" - }, - "defaultReturnUrl":{ - "shape":"OAuthDefaultReturnUrl", - "documentation":"

The URL where the end user's browser is redirected after obtaining the authorization code. Generally points to the customer's application.

" - } - }, - "documentation":"

An OAuth credential provider for gateway authentication. This structure contains the configuration for authenticating with the target endpoint using OAuth.

" - }, - "OAuthCredentialProviderArn":{ - "type":"string", - "pattern":"arn:([^:]*):([^:]*):([^:]*):([0-9]{12})?:(.+)" - }, - "OAuthCustomParameters":{ - "type":"map", - "key":{"shape":"OAuthCustomParametersKey"}, - "value":{"shape":"OAuthCustomParametersValue"}, - "max":10, - "min":1 - }, - "OAuthCustomParametersKey":{ - "type":"string", - "max":256, - "min":1 - }, - "OAuthCustomParametersValue":{ - "type":"string", - "max":2048, - "min":1, - "sensitive":true - }, - "OAuthDefaultReturnUrl":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"\\w+:(\\/?\\/?)[^\\s]+" - }, - "OAuthGrantType":{ - "type":"string", - "enum":[ - "CLIENT_CREDENTIALS", - "AUTHORIZATION_CODE", - "TOKEN_EXCHANGE" - ] - }, - "OAuthScope":{ - "type":"string", - "max":64, - "min":1 - }, - "OAuthScopes":{ - "type":"list", - "member":{"shape":"OAuthScope"}, - "max":100, - "min":0 - }, - "Oauth2AuthorizationServerMetadata":{ - "type":"structure", - "required":[ - "issuer", - "authorizationEndpoint", - "tokenEndpoint" - ], - "members":{ - "issuer":{ - "shape":"IssuerUrlType", - "documentation":"

The issuer URL for the OAuth2 authorization server.

" - }, - "authorizationEndpoint":{ - "shape":"AuthorizationEndpointType", - "documentation":"

The authorization endpoint URL for the OAuth2 authorization server.

" - }, - "tokenEndpoint":{ - "shape":"TokenEndpointType", - "documentation":"

The token endpoint URL for the OAuth2 authorization server.

" - }, - "responseTypes":{ - "shape":"ResponseListType", - "documentation":"

The supported response types for the OAuth2 authorization server.

" - }, - "tokenEndpointAuthMethods":{ - "shape":"TokenEndpointAuthMethodsType", - "documentation":"

The authentication methods supported by the token endpoint. This specifies how clients can authenticate when requesting tokens from the authorization server.

" - } - }, - "documentation":"

Contains the authorization server metadata for an OAuth2 provider.

" - }, - "Oauth2CredentialProviderItem":{ - "type":"structure", - "required":[ - "name", - "credentialProviderVendor", - "credentialProviderArn", - "createdTime", - "lastUpdatedTime" - ], - "members":{ - "name":{ - "shape":"CredentialProviderName", - "documentation":"

The name of the OAuth2 credential provider.

" - }, - "credentialProviderVendor":{ - "shape":"CredentialProviderVendorType", - "documentation":"

The vendor of the OAuth2 credential provider.

" - }, - "credentialProviderArn":{ - "shape":"CredentialProviderArnType", - "documentation":"

The Amazon Resource Name (ARN) of the OAuth2 credential provider.

" - }, - "createdTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the OAuth2 credential provider was created.

" - }, - "lastUpdatedTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the OAuth2 credential provider was last updated.

" - } - }, - "documentation":"

Contains information about an OAuth2 credential provider.

" - }, - "Oauth2CredentialProviders":{ - "type":"list", - "member":{"shape":"Oauth2CredentialProviderItem"} - }, - "Oauth2Discovery":{ - "type":"structure", - "members":{ - "discoveryUrl":{ - "shape":"DiscoveryUrlType", - "documentation":"

The discovery URL for the OAuth2 provider.

" - }, - "authorizationServerMetadata":{ - "shape":"Oauth2AuthorizationServerMetadata", - "documentation":"

The authorization server metadata for the OAuth2 provider.

" - } - }, - "documentation":"

Contains the discovery information for an OAuth2 provider.

", - "union":true - }, - "Oauth2ProviderConfigInput":{ - "type":"structure", - "members":{ - "customOauth2ProviderConfig":{ - "shape":"CustomOauth2ProviderConfigInput", - "documentation":"

The configuration for a custom OAuth2 provider.

" - }, - "googleOauth2ProviderConfig":{ - "shape":"GoogleOauth2ProviderConfigInput", - "documentation":"

The configuration for a Google OAuth2 provider.

" - }, - "githubOauth2ProviderConfig":{ - "shape":"GithubOauth2ProviderConfigInput", - "documentation":"

The configuration for a GitHub OAuth2 provider.

" - }, - "slackOauth2ProviderConfig":{ - "shape":"SlackOauth2ProviderConfigInput", - "documentation":"

The configuration for a Slack OAuth2 provider.

" - }, - "salesforceOauth2ProviderConfig":{ - "shape":"SalesforceOauth2ProviderConfigInput", - "documentation":"

The configuration for a Salesforce OAuth2 provider.

" - }, - "microsoftOauth2ProviderConfig":{ - "shape":"MicrosoftOauth2ProviderConfigInput", - "documentation":"

The configuration for a Microsoft OAuth2 provider.

" - }, - "atlassianOauth2ProviderConfig":{ - "shape":"AtlassianOauth2ProviderConfigInput", - "documentation":"

Configuration settings for Atlassian OAuth2 provider integration.

" - }, - "linkedinOauth2ProviderConfig":{ - "shape":"LinkedinOauth2ProviderConfigInput", - "documentation":"

Configuration settings for LinkedIn OAuth2 provider integration.

" - }, - "includedOauth2ProviderConfig":{ - "shape":"IncludedOauth2ProviderConfigInput", - "documentation":"

The configuration for a non-custom OAuth2 provider. This includes settings for supported OAuth2 providers that have built-in integration support.

" - } - }, - "documentation":"

Contains the input configuration for an OAuth2 provider.

", - "union":true - }, - "Oauth2ProviderConfigOutput":{ - "type":"structure", - "members":{ - "customOauth2ProviderConfig":{ - "shape":"CustomOauth2ProviderConfigOutput", - "documentation":"

The output configuration for a custom OAuth2 provider.

" - }, - "googleOauth2ProviderConfig":{ - "shape":"GoogleOauth2ProviderConfigOutput", - "documentation":"

The output configuration for a Google OAuth2 provider.

" - }, - "githubOauth2ProviderConfig":{ - "shape":"GithubOauth2ProviderConfigOutput", - "documentation":"

The output configuration for a GitHub OAuth2 provider.

" - }, - "slackOauth2ProviderConfig":{ - "shape":"SlackOauth2ProviderConfigOutput", - "documentation":"

The output configuration for a Slack OAuth2 provider.

" - }, - "salesforceOauth2ProviderConfig":{ - "shape":"SalesforceOauth2ProviderConfigOutput", - "documentation":"

The output configuration for a Salesforce OAuth2 provider.

" - }, - "microsoftOauth2ProviderConfig":{ - "shape":"MicrosoftOauth2ProviderConfigOutput", - "documentation":"

The output configuration for a Microsoft OAuth2 provider.

" - }, - "atlassianOauth2ProviderConfig":{ - "shape":"AtlassianOauth2ProviderConfigOutput", - "documentation":"

The configuration details for the Atlassian OAuth2 provider.

" - }, - "linkedinOauth2ProviderConfig":{ - "shape":"LinkedinOauth2ProviderConfigOutput", - "documentation":"

The configuration details for the LinkedIn OAuth2 provider.

" - }, - "includedOauth2ProviderConfig":{ - "shape":"IncludedOauth2ProviderConfigOutput", - "documentation":"

The configuration for a non-custom OAuth2 provider. This includes the configuration details for supported OAuth2 providers that have built-in integration support.

" - } - }, - "documentation":"

Contains the output configuration for an OAuth2 provider.

", - "union":true - }, - "OnBehalfOfTokenExchangeConfigType":{ - "type":"structure", - "required":["grantType"], - "members":{ - "grantType":{ - "shape":"OnBehalfOfTokenExchangeGrantTypeType", - "documentation":"

The grant type for the on-behalf-of token exchange.

" - }, - "tokenExchangeGrantTypeConfig":{ - "shape":"TokenExchangeGrantTypeConfigType", - "documentation":"

Configuration specific to the TOKEN_EXCHANGE grant type (RFC 8693).

" - } - }, - "documentation":"

Configuration for on-behalf-of token exchange.

" - }, - "OnBehalfOfTokenExchangeGrantTypeType":{ - "type":"string", - "enum":[ - "TOKEN_EXCHANGE", - "JWT_AUTHORIZATION_GRANT" - ] - }, - "OnlineEvaluationConfigArn":{ - "type":"string", - "pattern":"arn:aws[a-zA-Z-]*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:online-evaluation-config\\/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}" - }, - "OnlineEvaluationConfigId":{ - "type":"string", - "pattern":"[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}" - }, - "OnlineEvaluationConfigStatus":{ - "type":"string", - "enum":[ - "ACTIVE", - "CREATING", - "CREATE_FAILED", - "UPDATING", - "UPDATE_FAILED", - "DELETING", - "ERROR" - ] - }, - "OnlineEvaluationConfigSummary":{ - "type":"structure", - "required":[ - "onlineEvaluationConfigArn", - "onlineEvaluationConfigId", - "onlineEvaluationConfigName", - "status", - "executionStatus", - "createdAt", - "updatedAt" - ], - "members":{ - "onlineEvaluationConfigArn":{ - "shape":"OnlineEvaluationConfigArn", - "documentation":"

The Amazon Resource Name (ARN) of the online evaluation configuration.

" - }, - "onlineEvaluationConfigId":{ - "shape":"OnlineEvaluationConfigId", - "documentation":"

The unique identifier of the online evaluation configuration.

" - }, - "onlineEvaluationConfigName":{ - "shape":"EvaluationConfigName", - "documentation":"

The name of the online evaluation configuration.

" - }, - "description":{ - "shape":"EvaluationConfigDescription", - "documentation":"

The description of the online evaluation configuration.

" - }, - "status":{ - "shape":"OnlineEvaluationConfigStatus", - "documentation":"

The status of the online evaluation configuration.

" - }, - "executionStatus":{ - "shape":"OnlineEvaluationExecutionStatus", - "documentation":"

The execution status indicating whether the online evaluation is currently running.

" - }, - "createdAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the online evaluation configuration was created.

" - }, - "updatedAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the online evaluation configuration was last updated.

" - }, - "failureReason":{ - "shape":"String", - "documentation":"

The reason for failure if the online evaluation configuration execution failed.

" - }, - "insights":{ - "shape":"InsightList", - "documentation":"

The list of insight types configured for this evaluation.

" - }, - "clusteringConfig":{ - "shape":"ClusteringConfig", - "documentation":"

The clustering configuration for periodic batch evaluation.

" - } - }, - "documentation":"

The summary information about an online evaluation configuration, including basic metadata and execution status.

" - }, - "OnlineEvaluationConfigSummaryList":{ - "type":"list", - "member":{"shape":"OnlineEvaluationConfigSummary"} - }, - "OnlineEvaluationExecutionStatus":{ - "type":"string", - "enum":[ - "ENABLED", - "DISABLED" - ] - }, - "OpenResponsesEvaluatorModelConfig":{ - "type":"structure", - "required":["modelId"], - "members":{ - "modelId":{ - "shape":"ModelId", - "documentation":"

The identifier of the model to use for evaluation.

" - }, - "maxOutputTokens":{ - "shape":"OpenResponsesEvaluatorModelConfigMaxOutputTokensInteger", - "documentation":"

The maximum number of tokens to generate in the model response, including visible output and reasoning tokens.

" - }, - "temperature":{ - "shape":"OpenResponsesEvaluatorModelConfigTemperatureFloat", - "documentation":"

The temperature value that controls randomness in the model's responses. Lower values produce more deterministic outputs.

" - }, - "topP":{ - "shape":"OpenResponsesEvaluatorModelConfigTopPFloat", - "documentation":"

The top-p sampling parameter that controls the diversity of the model's responses by limiting the cumulative probability of token choices.

" - }, - "reasoning":{ - "shape":"ReasoningConfiguration", - "documentation":"

The reasoning configuration for reasoning models. Non-reasoning models ignore this configuration.

" - } - }, - "documentation":"

The configuration for using models served through the OpenResponses API in evaluator assessments, including model selection and inference parameters.

" - }, - "OpenResponsesEvaluatorModelConfigMaxOutputTokensInteger":{ - "type":"integer", - "box":true, - "min":1 - }, - "OpenResponsesEvaluatorModelConfigTemperatureFloat":{ - "type":"float", - "box":true, - "max":2, - "min":0 - }, - "OpenResponsesEvaluatorModelConfigTopPFloat":{ - "type":"float", - "box":true, - "max":1, - "min":0 - }, - "OutputConfig":{ - "type":"structure", - "required":["cloudWatchConfig"], - "members":{ - "cloudWatchConfig":{ - "shape":"CloudWatchOutputConfig", - "documentation":"

The CloudWatch configuration for writing evaluation results to CloudWatch logs with embedded metric format.

" - } - }, - "documentation":"

The configuration that specifies where evaluation results should be written for monitoring and analysis.

" - }, - "OverrideType":{ - "type":"string", - "enum":[ - "SEMANTIC_OVERRIDE", - "SUMMARY_OVERRIDE", - "USER_PREFERENCE_OVERRIDE", - "SELF_MANAGED", - "EPISODIC_OVERRIDE" - ] - }, - "PassthroughEndpoint":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"https://[a-zA-Z0-9\\-\\.]+(:[0-9]{1,5})?(/.*)?" - }, - "PassthroughProtocolType":{ - "type":"string", - "enum":[ - "MCP", - "A2A", - "INFERENCE", - "CUSTOM" - ] - }, - "PassthroughTargetConfiguration":{ - "type":"structure", - "required":[ - "endpoint", - "protocolType" - ], - "members":{ - "endpoint":{ - "shape":"PassthroughEndpoint", - "documentation":"

The HTTPS endpoint that the gateway forwards requests to for this passthrough target.

" - }, - "protocolType":{ - "shape":"PassthroughProtocolType", - "documentation":"

The application protocol that the passthrough target implements. This value is required for passthrough targets:

  • MCP - The Model Context Protocol.

  • A2A - The Agent-to-Agent protocol.

  • INFERENCE - The protocol for routing requests to a large language model (LLM) provider.

  • CUSTOM - A custom application protocol.

" - }, - "schema":{ - "shape":"HttpApiSchemaConfiguration", - "documentation":"

The API schema configuration that defines the structure of the passthrough target's API.

" - }, - "stickinessConfiguration":{ - "shape":"StickinessConfiguration", - "documentation":"

The session stickiness configuration for the passthrough target. This configuration routes requests within the same session to the same target.

" - } - }, - "documentation":"

The configuration for an HTTP passthrough target. A passthrough target forwards requests directly to an external HTTP endpoint.

" - }, - "PaymentConnectorId":{ - "type":"string", - "max":211, - "min":12, - "pattern":"([0-9a-z][-]?){1,100}-[0-9a-z]{10}" - }, - "PaymentConnectorName":{ - "type":"string", - "max":48, - "min":1, - "pattern":"[a-zA-Z][a-zA-Z0-9_]{0,47}" - }, - "PaymentConnectorStatus":{ - "type":"string", - "enum":[ - "CREATING", - "UPDATING", - "DELETING", - "READY", - "CREATE_FAILED", - "UPDATE_FAILED", - "DELETE_FAILED" - ] - }, - "PaymentConnectorSummaries":{ - "type":"list", - "member":{"shape":"PaymentConnectorSummary"} - }, - "PaymentConnectorSummary":{ - "type":"structure", - "required":[ - "paymentConnectorId", - "name", - "type", - "status", - "lastUpdatedAt" - ], - "members":{ - "paymentConnectorId":{ - "shape":"PaymentConnectorId", - "documentation":"

The unique identifier of the payment connector.

" - }, - "name":{ - "shape":"PaymentConnectorName", - "documentation":"

The name of the payment connector.

" - }, - "type":{ - "shape":"PaymentConnectorType", - "documentation":"

The type of the payment connector, which determines the payment provider integration.

" - }, - "status":{ - "shape":"PaymentConnectorStatus", - "documentation":"

The current status of the payment connector. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.

" - }, - "lastUpdatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the payment connector was last updated.

" - } - }, - "documentation":"

Contains summary information about a payment connector.

" - }, - "PaymentConnectorType":{ - "type":"string", - "enum":[ - "CoinbaseCDP", - "StripePrivy" - ] - }, - "PaymentCredentialProviderArn":{ - "type":"string", - "max":2048, - "min":69, - "pattern":"arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b|aws-iso-e|aws-iso-f|aws-eusc):(acps|bedrock-agentcore):[A-Za-z0-9-]{1,64}:[0-9]{12}:token-vault/[a-zA-Z0-9-.]+/paymentcredentialprovider/[a-zA-Z0-9-.]+" - }, - "PaymentCredentialProviderArnType":{ - "type":"string", - "pattern":"arn:(aws|aws-us-gov):acps:[A-Za-z0-9-]{1,64}:[0-9]{12}:token-vault/[a-zA-Z0-9-.]+/paymentcredentialprovider/[a-zA-Z0-9-.]+" - }, - "PaymentCredentialProviderConfiguration":{ - "type":"structure", - "required":["credentialProviderArn"], - "members":{ - "credentialProviderArn":{ - "shape":"PaymentCredentialProviderArn", - "documentation":"

The Amazon Resource Name (ARN) of the credential provider that stores the authentication credentials for the payment provider.

" - } - }, - "documentation":"

Configuration for a payment credential provider that stores authentication credentials for a payment provider.

" - }, - "PaymentCredentialProviderItem":{ - "type":"structure", - "required":[ - "name", - "credentialProviderVendor", - "credentialProviderArn", - "createdTime", - "lastUpdatedTime" - ], - "members":{ - "name":{ - "shape":"CredentialProviderName", - "documentation":"

The name of the payment credential provider.

" - }, - "credentialProviderVendor":{ - "shape":"PaymentCredentialProviderVendorType", - "documentation":"

The vendor type for the payment credential provider.

" - }, - "credentialProviderArn":{ - "shape":"PaymentCredentialProviderArnType", - "documentation":"

The Amazon Resource Name (ARN) of the payment credential provider.

" - }, - "createdTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the payment credential provider was created.

" - }, - "lastUpdatedTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the payment credential provider was last updated.

" - } - }, - "documentation":"

Contains summary information about a payment credential provider.

" - }, - "PaymentCredentialProviderVendorType":{ - "type":"string", - "documentation":"

Supported vendor types for payment providers using non-standard auth protocols.

", - "enum":[ - "CoinbaseCDP", - "StripePrivy" - ] - }, - "PaymentCredentialProviders":{ - "type":"list", - "member":{"shape":"PaymentCredentialProviderItem"} - }, - "PaymentManagerArn":{ - "type":"string", - "max":2048, - "min":66, - "pattern":"arn:(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:payment-manager/([0-9a-z][-]?){1,48}-[a-z0-9]{10}" - }, - "PaymentManagerId":{ - "type":"string", - "max":211, - "min":12, - "pattern":"([0-9a-z][-]?){1,100}-[0-9a-z]{10}" - }, - "PaymentManagerName":{ - "type":"string", - "max":48, - "min":1, - "pattern":"[a-zA-Z][a-zA-Z0-9]{0,47}" - }, - "PaymentManagerStatus":{ - "type":"string", - "enum":[ - "CREATING", - "UPDATING", - "DELETING", - "READY", - "CREATE_FAILED", - "UPDATE_FAILED", - "DELETE_FAILED" - ] - }, - "PaymentManagerSummaries":{ - "type":"list", - "member":{"shape":"PaymentManagerSummary"} - }, - "PaymentManagerSummary":{ - "type":"structure", - "required":[ - "paymentManagerArn", - "paymentManagerId", - "name", - "authorizerType", - "roleArn", - "status", - "lastUpdatedAt" - ], - "members":{ - "paymentManagerArn":{ - "shape":"PaymentManagerArn", - "documentation":"

The Amazon Resource Name (ARN) of the payment manager.

" - }, - "paymentManagerId":{ - "shape":"PaymentManagerId", - "documentation":"

The unique identifier of the payment manager.

" - }, - "name":{ - "shape":"PaymentManagerName", - "documentation":"

The name of the payment manager.

" - }, - "description":{ - "shape":"PaymentsDescription", - "documentation":"

The description of the payment manager.

" - }, - "authorizerType":{ - "shape":"PaymentsAuthorizerType", - "documentation":"

The type of authorizer used by the payment manager.

  • CUSTOM_JWT - Authorize with a bearer token.

  • AWS_IAM - Authorize with your Amazon Web Services IAM credentials.

" - }, - "roleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the IAM role associated with the payment manager.

" - }, - "status":{ - "shape":"PaymentManagerStatus", - "documentation":"

The current status of the payment manager. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the payment manager was created.

" - }, - "lastUpdatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the payment manager was last updated.

" - } - }, - "documentation":"

Contains summary information about a payment manager.

" - }, - "PaymentProviderConfigurationInput":{ - "type":"structure", - "members":{ - "coinbaseCdpConfiguration":{ - "shape":"CoinbaseCdpConfigurationInput", - "documentation":"

The Coinbase CDP configuration.

" - }, - "stripePrivyConfiguration":{ - "shape":"StripePrivyConfigurationInput", - "documentation":"

The Stripe Privy configuration.

" - } - }, - "documentation":"

Provider configuration input — contains secrets for creation and update. Varies by vendor type.

", - "union":true - }, - "PaymentProviderConfigurationOutput":{ - "type":"structure", - "members":{ - "coinbaseCdpConfiguration":{ - "shape":"CoinbaseCdpConfigurationOutput", - "documentation":"

The Coinbase CDP configuration.

" - }, - "stripePrivyConfiguration":{ - "shape":"StripePrivyConfigurationOutput", - "documentation":"

The Stripe Privy configuration.

" - } - }, - "documentation":"

Provider configuration output — no raw secrets, only ARNs. Varies by vendor type.

", - "union":true - }, - "PaymentsAuthorizerType":{ - "type":"string", - "enum":[ - "CUSTOM_JWT", - "AWS_IAM" - ] - }, - "PaymentsDescription":{ - "type":"string", - "max":4096, - "min":1, - "pattern":"[a-zA-Z0-9\\s]+" - }, - "Policies":{ - "type":"list", - "member":{"shape":"Policy"}, - "max":100, - "min":0 - }, - "Policy":{ - "type":"structure", - "required":[ - "policyId", - "name", - "policyEngineId", - "createdAt", - "updatedAt", - "policyArn", - "status", - "definition", - "statusReasons" - ], - "members":{ - "policyId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier for the policy. This system-generated identifier consists of the user name plus a 10-character generated suffix and serves as the primary key for policy operations.

" - }, - "name":{ - "shape":"PolicyName", - "documentation":"

The customer-assigned immutable name for the policy. This human-readable identifier must be unique within the account and cannot exceed 48 characters.

" - }, - "policyEngineId":{ - "shape":"ResourceId", - "documentation":"

The identifier of the policy engine that manages this policy. This establishes the policy engine context for policy evaluation and management.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the policy was originally created. This is automatically set by the service and used for auditing and lifecycle management.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the policy was last modified. This tracks the most recent changes to the policy configuration or metadata.

" - }, - "policyArn":{ - "shape":"PolicyArn", - "documentation":"

The Amazon Resource Name (ARN) of the policy. This globally unique identifier can be used for cross-service references and IAM policy statements.

" - }, - "status":{ - "shape":"PolicyStatus", - "documentation":"

The current status of the policy.

" - }, - "enforcementMode":{ - "shape":"EnforcementMode", - "documentation":"

The current enforcement mode of the policy.

" - }, - "definition":{ - "shape":"PolicyDefinition", - "documentation":"

The Cedar policy statement that defines the access control rules. This contains the actual policy logic used for agent behavior control and access decisions.

" - }, - "description":{ - "shape":"Description", - "documentation":"

A human-readable description of the policy's purpose and functionality. Limited to 4,096 characters, this helps administrators understand and manage the policy.

" - }, - "statusReasons":{ - "shape":"PolicyStatusReasons", - "documentation":"

Additional information about the policy status. This provides details about any failures or the current state of the policy lifecycle.

" - } - }, - "documentation":"

Represents a complete policy resource within the AgentCore Policy system. Policies are ARN-able resources that contain Cedar policy statements and associated metadata for controlling agent behavior and access decisions. Each policy belongs to a policy engine and defines fine-grained authorization rules that are evaluated in real-time as agents interact with tools through Gateway. Policies use the Cedar policy language to specify who (principals based on OAuth claims like username, role, or scope) can perform what actions (tool calls) on which resources (Gateways), with optional conditions for attribute-based access control. Multiple policies can apply to a single request, with Cedar's forbid-wins semantics ensuring that security restrictions are never accidentally overridden.

" - }, - "PolicyArn":{ - "type":"string", - "max":203, - "min":96, - "pattern":"arn:aws[-a-z]{0,7}:bedrock-agentcore:[a-z0-9-]{9,15}:[0-9]{12}:policy-engine/[a-zA-Z][a-zA-Z0-9-_]{0,47}-[a-zA-Z0-9_]{10}/policy/[a-zA-Z][a-zA-Z0-9-_]{0,47}-[a-zA-Z0-9_]{10}" - }, - "PolicyDefinition":{ - "type":"structure", - "members":{ - "cedar":{ - "shape":"CedarPolicy", - "documentation":"

The Cedar policy definition within the policy definition structure. This contains the Cedar policy statement that defines the authorization logic using Cedar's human-readable, analyzable policy language. Cedar policies specify principals (who can access), actions (what operations are allowed), resources (what can be accessed), and optional conditions for fine-grained control. Cedar provides a formal policy language designed for authorization with deterministic evaluation, making policies testable, reviewable, and auditable. All Cedar policies follow a default-deny model where actions are denied unless explicitly permitted, and forbid policies always override permit policies.

" - }, - "policyGeneration":{ - "shape":"PolicyGenerationDetails", - "documentation":"

The generated policy asset information within the policy definition structure. This contains information identifying a generated policy asset from the AI-powered policy generation process within the AgentCore Policy system. Each asset contains a Cedar policy statement generated from natural language input, along with associated metadata and analysis findings to help users evaluate and select the most appropriate policy option.

" - }, - "policy":{ - "shape":"PolicyStatement", - "documentation":"

An AgentCore policy statement that defines the access control rules. The statement can be a Cedar policy or a guardrails definition.

" - } - }, - "documentation":"

Represents the definition structure for policies within the AgentCore Policy system. This structure encapsulates different policy formats and languages that can be used to define access control rules.

", - "union":true - }, - "PolicyEngine":{ - "type":"structure", - "required":[ - "policyEngineId", - "name", - "createdAt", - "updatedAt", - "policyEngineArn", - "status", - "statusReasons" - ], - "members":{ - "policyEngineId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier for the policy engine. This system-generated identifier consists of the user name plus a 10-character generated suffix and serves as the primary key for policy engine operations.

" - }, - "name":{ - "shape":"PolicyEngineName", - "documentation":"

The customer-assigned immutable name for the policy engine. This human-readable identifier must be unique within the account and cannot exceed 48 characters.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the policy engine was originally created. This is automatically set by the service and used for auditing and lifecycle management.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the policy engine was last modified. This tracks the most recent changes to the policy engine configuration or metadata.

" - }, - "policyEngineArn":{ - "shape":"PolicyEngineArn", - "documentation":"

The Amazon Resource Name (ARN) of the policy engine. This globally unique identifier can be used for cross-service references and IAM policy statements.

" - }, - "status":{ - "shape":"PolicyEngineStatus", - "documentation":"

The current status of the policy engine.

" - }, - "encryptionKeyArn":{ - "shape":"KmsKeyArn", - "documentation":"

The Amazon Resource Name (ARN) of the KMS key used to encrypt the policy engine data.

" - }, - "description":{ - "shape":"Description", - "documentation":"

A human-readable description of the policy engine's purpose and scope. Limited to 4,096 characters, this helps administrators understand the policy engine's role in the overall governance strategy.

" - }, - "statusReasons":{ - "shape":"PolicyStatusReasons", - "documentation":"

Additional information about the policy engine status. This provides details about any failures or the current state of the policy engine lifecycle.

" - } - }, - "documentation":"

Represents a policy engine resource within the AgentCore Policy system. Policy engines serve as containers for grouping related policies and provide the execution context for policy evaluation and management. Each policy engine can be associated with one Gateway (one engine per Gateway), where it intercepts all agent tool calls and evaluates them against the contained policies before allowing tools to execute. The policy engine maintains the Cedar schema generated from the Gateway's tool manifest, ensuring that policies are validated against the actual tools and parameters available. Policy engines support two enforcement modes that can be configured when associating with a Gateway: log-only mode for testing (evaluates decisions without blocking) and enforce mode for production (actively allows or denies based on policy evaluation).

" - }, - "PolicyEngineArn":{ - "type":"string", - "max":136, - "min":76, - "pattern":"arn:aws[-a-z]{0,7}:bedrock-agentcore:[a-z0-9-]{9,15}:[0-9]{12}:policy-engine/[a-zA-Z][a-zA-Z0-9-_]{0,47}-[a-zA-Z0-9_]{10}" - }, - "PolicyEngineName":{ - "type":"string", - "max":48, - "min":1, - "pattern":"[A-Za-z][A-Za-z0-9_]*" - }, - "PolicyEngineStatus":{ - "type":"string", - "enum":[ - "CREATING", - "ACTIVE", - "UPDATING", - "DELETING", - "CREATE_FAILED", - "UPDATE_FAILED", - "DELETE_FAILED" - ] - }, - "PolicyEngineSummary":{ - "type":"structure", - "required":[ - "policyEngineId", - "name", - "createdAt", - "updatedAt", - "policyEngineArn", - "status" - ], - "members":{ - "policyEngineId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier for the policy engine.

" - }, - "name":{ - "shape":"PolicyEngineName", - "documentation":"

The customer-assigned name of the policy engine.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the policy engine was originally created.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the policy engine was last modified.

" - }, - "policyEngineArn":{ - "shape":"PolicyEngineArn", - "documentation":"

The Amazon Resource Name (ARN) of the policy engine.

" - }, - "status":{ - "shape":"PolicyEngineStatus", - "documentation":"

The current status of the policy engine.

" - }, - "encryptionKeyArn":{ - "shape":"KmsKeyArn", - "documentation":"

The Amazon Resource Name (ARN) of the KMS key used to encrypt the policy engine data.

" - } - }, - "documentation":"

Represents a metadata-only summary of a policy engine resource. This structure contains resource identifiers, status, and timestamps without customer-encrypted fields such as description or status reasons. Policy engine summaries are returned by operations that do not require access to the customer's KMS key.

" - }, - "PolicyEngineSummaryList":{ - "type":"list", - "member":{"shape":"PolicyEngineSummary"}, - "max":100, - "min":0 - }, - "PolicyEngines":{ - "type":"list", - "member":{"shape":"PolicyEngine"}, - "max":100, - "min":0 - }, - "PolicyGeneration":{ - "type":"structure", - "required":[ - "policyEngineId", - "policyGenerationId", - "name", - "policyGenerationArn", - "resource", - "createdAt", - "updatedAt", - "status", - "statusReasons" - ], - "members":{ - "policyEngineId":{ - "shape":"ResourceId", - "documentation":"

The identifier of the policy engine associated with this generation request.

" - }, - "policyGenerationId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier for this policy generation request.

" - }, - "name":{ - "shape":"PolicyGenerationName", - "documentation":"

The customer-assigned name for this policy generation request.

" - }, - "policyGenerationArn":{ - "shape":"PolicyGenerationArn", - "documentation":"

The ARN of this policy generation request.

" - }, - "resource":{ - "shape":"Resource", - "documentation":"

The resource information associated with this policy generation.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when this policy generation request was created.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when this policy generation was last updated.

" - }, - "status":{ - "shape":"PolicyGenerationStatus", - "documentation":"

The current status of this policy generation request.

" - }, - "findings":{ - "shape":"String", - "documentation":"

Findings and insights from this policy generation process.

" - }, - "statusReasons":{ - "shape":"PolicyStatusReasons", - "documentation":"

Additional information about the generation status.

" - } - }, - "documentation":"

Represents a policy generation request within the AgentCore Policy system. Tracks the AI-powered conversion of natural language descriptions into Cedar policy statements, enabling users to author policies by describing authorization requirements in plain English. The generation process analyzes the natural language input along with the Gateway's tool context and Cedar schema to produce one or more validated policy options. Each generation request tracks the status of the conversion process and maintains findings about the generated policies, including validation results and potential issues. Generated policy assets remain available for one week after successful generation, allowing time to review and create policies from the generated options.

" - }, - "PolicyGenerationArn":{ - "type":"string", - "max":210, - "min":103, - "pattern":"arn:aws[-a-z]{0,7}:bedrock-agentcore:[a-z0-9-]{9,15}:[0-9]{12}:policy-engine/[a-zA-Z][a-zA-Z0-9-_]{0,47}-[a-zA-Z0-9_]{10}/policy-generation/[a-zA-Z][a-zA-Z0-9-_]{0,47}-[a-zA-Z0-9_]{10}" - }, - "PolicyGenerationAsset":{ - "type":"structure", - "required":[ - "policyGenerationAssetId", - "rawTextFragment", - "findings" - ], - "members":{ - "policyGenerationAssetId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier for this generated policy asset within the policy generation request. This ID can be used to reference specific generated policy options when creating actual policies from the generation results.

" - }, - "definition":{"shape":"PolicyDefinition"}, - "rawTextFragment":{ - "shape":"NaturalLanguage", - "documentation":"

The portion of the original natural language input that this generated policy asset addresses. This helps users understand which part of their policy description was translated into this specific Cedar policy statement, enabling better policy selection and refinement. When a single natural language input describes multiple authorization requirements, the generation process creates separate policy assets for each requirement, with each asset's rawTextFragment showing which requirement it addresses. Use this mapping to verify that all parts of your natural language input were correctly translated into Cedar policies.

" - }, - "findings":{ - "shape":"Findings", - "documentation":"

Analysis findings and insights related to this specific generated policy asset. These findings may include validation results, potential issues, or recommendations for improvement to help users evaluate the quality and appropriateness of the generated policy.

" - } - }, - "documentation":"

Represents a generated policy asset from the AI-powered policy generation process within the AgentCore Policy system. Each asset contains a Cedar policy statement generated from natural language input, along with associated metadata and analysis findings to help users evaluate and select the most appropriate policy option.

" - }, - "PolicyGenerationAssets":{ - "type":"list", - "member":{"shape":"PolicyGenerationAsset"} - }, - "PolicyGenerationDetails":{ - "type":"structure", - "required":[ - "policyGenerationId", - "policyGenerationAssetId" - ], - "members":{ - "policyGenerationId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier for this policy generation request.

" - }, - "policyGenerationAssetId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier for this generated policy asset within the policy generation request.

" - } - }, - "documentation":"

Represents the information identifying a generated policy asset from the AI-powered policy generation process within the AgentCore Policy system. Each asset contains a Cedar policy statement generated from natural language input, along with associated metadata and analysis findings to help users evaluate and select the most appropriate policy option.

" - }, - "PolicyGenerationName":{ - "type":"string", - "max":48, - "min":1, - "pattern":"[A-Za-z][A-Za-z0-9_]*" - }, - "PolicyGenerationStatus":{ - "type":"string", - "enum":[ - "GENERATING", - "GENERATED", - "GENERATE_FAILED", - "DELETE_FAILED" - ] - }, - "PolicyGenerationSummary":{ - "type":"structure", - "required":[ - "policyEngineId", - "policyGenerationId", - "name", - "policyGenerationArn", - "resource", - "createdAt", - "updatedAt", - "status" - ], - "members":{ - "policyEngineId":{ - "shape":"ResourceId", - "documentation":"

The identifier of the policy engine associated with this generation request.

" - }, - "policyGenerationId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier for this policy generation request.

" - }, - "name":{ - "shape":"PolicyGenerationName", - "documentation":"

The customer-assigned name for this policy generation request.

" - }, - "policyGenerationArn":{ - "shape":"PolicyGenerationArn", - "documentation":"

The ARN of this policy generation request.

" - }, - "resource":{ - "shape":"Resource", - "documentation":"

The resource information associated with this policy generation.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when this policy generation request was created.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when this policy generation was last updated.

" - }, - "status":{ - "shape":"PolicyGenerationStatus", - "documentation":"

The current status of this policy generation request.

" - }, - "findings":{ - "shape":"String", - "documentation":"

Findings and insights from this policy generation process.

" - } - }, - "documentation":"

Represents a metadata-only summary of a policy generation resource. This structure contains resource identifiers, status, timestamps, and findings without customer-encrypted fields such as status reasons. Policy generation summaries are returned by operations that do not require access to the customer's KMS key.

" - }, - "PolicyGenerationSummaryList":{ - "type":"list", - "member":{"shape":"PolicyGenerationSummary"}, - "max":100, - "min":0 - }, - "PolicyGenerations":{ - "type":"list", - "member":{"shape":"PolicyGeneration"}, - "max":100, - "min":0 - }, - "PolicyName":{ - "type":"string", - "max":48, - "min":1, - "pattern":"[A-Za-z][A-Za-z0-9_]*" - }, - "PolicyStatement":{ - "type":"structure", - "required":["statement"], - "members":{ - "statement":{ - "shape":"Statement", - "documentation":"

The body of the AgentCore policy statement. Contains the policy logic, which can be a Cedar policy or a guardrails definition.

" - } - }, - "documentation":"

An AgentCore policy statement, which supports plain Cedar policies as well as guardrails definitions.

" - }, - "PolicyStatus":{ - "type":"string", - "enum":[ - "CREATING", - "ACTIVE", - "UPDATING", - "DELETING", - "CREATE_FAILED", - "UPDATE_FAILED", - "DELETE_FAILED" - ] - }, - "PolicyStatusReasons":{ - "type":"list", - "member":{"shape":"String"} - }, - "PolicySummary":{ - "type":"structure", - "required":[ - "policyId", - "name", - "policyEngineId", - "createdAt", - "updatedAt", - "policyArn", - "status" - ], - "members":{ - "policyId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier for the policy.

" - }, - "name":{ - "shape":"PolicyName", - "documentation":"

The customer-assigned name of the policy.

" - }, - "policyEngineId":{ - "shape":"ResourceId", - "documentation":"

The identifier of the policy engine that manages this policy.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the policy was originally created.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the policy was last modified.

" - }, - "policyArn":{ - "shape":"PolicyArn", - "documentation":"

The Amazon Resource Name (ARN) of the policy.

" - }, - "status":{ - "shape":"PolicyStatus", - "documentation":"

The current status of the policy.

" - }, - "enforcementMode":{ - "shape":"EnforcementMode", - "documentation":"

The current enforcement mode of the policy.

" - } - }, - "documentation":"

Represents a metadata-only summary of a policy resource. This structure contains resource identifiers, status, and timestamps without customer-encrypted fields such as definition, description, or status reasons. Policy summaries are returned by operations that do not require access to the customer's KMS key.

" - }, - "PolicySummaryList":{ - "type":"list", - "member":{"shape":"PolicySummary"}, - "max":100, - "min":0 - }, - "PolicyValidationMode":{ - "type":"string", - "enum":[ - "FAIL_ON_ANY_FINDINGS", - "IGNORE_ALL_FINDINGS" - ] - }, - "PrincipalMatchOperator":{ - "type":"string", - "enum":[ - "StringEquals", - "StringLike" - ] - }, - "PrivateEndpoint":{ - "type":"structure", - "members":{ - "selfManagedLatticeResource":{ - "shape":"SelfManagedLatticeResource", - "documentation":"

Configuration for connecting to a private resource using a self-managed VPC Lattice resource configuration.

" - }, - "managedVpcResource":{ - "shape":"ManagedVpcResource", - "documentation":"

Configuration for connecting to a private resource using a managed VPC Lattice resource. The gateway creates and manages the VPC Lattice resources on your behalf.

" - } - }, - "documentation":"

The private endpoint configuration for a gateway target. Defines how the gateway connects to private resources in your VPC.

", - "union":true - }, - "PrivateEndpointManagedResources":{ - "type":"list", - "member":{"shape":"ManagedResourceDetails"}, - "documentation":"

A list of managed resources created by the gateway for private endpoint connectivity.

" - }, - "PrivateEndpointOverride":{ - "type":"structure", - "required":[ - "domain", - "privateEndpoint" - ], - "members":{ - "domain":{ - "shape":"PrivateEndpointOverrideDomain", - "documentation":"

The domain to override with a private endpoint.

" - }, - "privateEndpoint":{ - "shape":"PrivateEndpoint", - "documentation":"

The private endpoint configuration for the specified domain.

" - } - }, - "documentation":"

A mapping of a specific domain to a private endpoint for secure connectivity through a VPC Lattice resource configuration.

" - }, - "PrivateEndpointOverrideDomain":{ - "type":"string", - "max":253, - "min":1 - }, - "PrivateEndpointOverrides":{ - "type":"list", - "member":{"shape":"PrivateEndpointOverride"}, - "max":5, - "min":0 - }, - "PrivateKeyJwtConfig":{ - "type":"structure", - "members":{ - "privateKeySource":{ - "shape":"PrivateKeySource", - "documentation":"

The private key source for the JWT client assertion.

" - }, - "signingAlgorithm":{ - "shape":"SigningAlgorithm", - "documentation":"

The algorithm used to sign the JWT client assertion. Valid values are RS256, PS256, and ES256.

" - }, - "additionalHeaderClaims":{ - "shape":"AdditionalClaims", - "documentation":"

A map of additional claims to include in the JWT client assertion header. Standard header claims such as alg and typ cannot be added.

" - }, - "additionalPayloadClaims":{ - "shape":"AdditionalClaims", - "documentation":"

A map of additional claims to include in the JWT client assertion payload. Payload claims generated by the service, such as iss, sub, jti, and exp, cannot be added.

" - } - }, - "documentation":"

Configuration for private_key_jwt client authentication (RFC 7523). On Create: privateKeySource and signingAlgorithm are required (enforced server-side). On Update: all fields are optional — only provided fields are updated.

" - }, - "PrivateKeySource":{ - "type":"structure", - "members":{ - "kmsKeySource":{ - "shape":"KmsKeySourceType", - "documentation":"

The KMS key source for the JWT client assertion.

" - } - }, - "documentation":"

Contains the private key source configuration for a JWT client assertion.

", - "union":true - }, - "Prompt":{ - "type":"string", - "max":30000, - "min":1, - "sensitive":true - }, - "ProtocolConfiguration":{ - "type":"structure", - "required":["serverProtocol"], - "members":{ - "serverProtocol":{ - "shape":"ServerProtocol", - "documentation":"

The server protocol for the agent runtime. This field specifies which protocol the agent runtime uses to communicate with clients.

" - } - }, - "documentation":"

The protocol configuration for an agent runtime. This structure defines how the agent runtime communicates with clients.

" - }, - "ProviderPrefix":{ - "type":"structure", - "members":{ - "strip":{ - "shape":"Boolean", - "documentation":"

Whether clients can omit the provider prefix from model IDs. If true, the gateway accepts model IDs without the prefix and restores the full prefixed form before forwarding to the provider. The default is false.

" - }, - "separator":{ - "shape":"ProviderPrefixSeparatorString", - "documentation":"

The single character that separates the provider prefix from the model name (for example, .). The default is ..

" - } - }, - "documentation":"

The configuration that controls how a provider prefix is applied to model IDs during translation.

" - }, - "ProviderPrefixSeparatorString":{ - "type":"string", - "max":1, - "min":1 - }, - "PutResourcePolicyRequest":{ - "type":"structure", - "required":[ - "resourceArn", - "policy" - ], - "members":{ - "resourceArn":{ - "shape":"BedrockAgentcoreResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the resource for which to create or update the resource policy.

", - "location":"uri", - "locationName":"resourceArn" - }, - "policy":{ - "shape":"ResourcePolicyBody", - "documentation":"

The resource policy to create or update.

" - } - } - }, - "PutResourcePolicyResponse":{ - "type":"structure", - "required":["policy"], - "members":{ - "policy":{ - "shape":"ResourcePolicyBody", - "documentation":"

The resource policy that was created or updated.

" - } - } - }, - "RatingScale":{ - "type":"structure", - "members":{ - "numerical":{ - "shape":"NumericalScaleDefinitions", - "documentation":"

The numerical rating scale with defined score values and descriptions for quantitative evaluation.

" - }, - "categorical":{ - "shape":"CategoricalScaleDefinitions", - "documentation":"

The categorical rating scale with named categories and definitions for qualitative evaluation.

" - } - }, - "documentation":"

The rating scale that defines how evaluators should score agent performance, supporting both numerical and categorical scales.

", - "sensitive":true, - "union":true - }, - "ReasoningConfiguration":{ - "type":"structure", - "members":{ - "effort":{ - "shape":"ReasoningConfigurationEffortString", - "documentation":"

The level of reasoning effort the model applies when generating a response. For supported values, see the model provider's documentation.

" - } - }, - "documentation":"

The reasoning configuration that controls how a reasoning model allocates effort during evaluation.

" - }, - "ReasoningConfigurationEffortString":{ - "type":"string", - "max":64, - "min":1 - }, - "RecordIdentifier":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"(arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:registry/[a-zA-Z0-9]{12,16}/record/)?[a-zA-Z0-9]{12}" - }, - "RecordingConfig":{ - "type":"structure", - "members":{ - "enabled":{ - "shape":"Boolean", - "documentation":"

Indicates whether recording is enabled for the browser. When set to true, browser sessions are recorded.

" - }, - "s3Location":{ - "shape":"S3Location", - "documentation":"

The Amazon S3 location where browser recordings are stored. This location contains the recorded browser sessions.

" - } - }, - "documentation":"

The recording configuration for a browser. This structure defines how browser sessions are recorded.

" - }, - "ReflectionConfiguration":{ - "type":"structure", - "members":{ - "customReflectionConfiguration":{ - "shape":"CustomReflectionConfiguration", - "documentation":"

The configuration for a custom reflection strategy.

" - }, - "episodicReflectionConfiguration":{ - "shape":"EpisodicReflectionConfiguration", - "documentation":"

The configuration for the episodic reflection strategy.

" - } - }, - "documentation":"

Contains reflection configuration information for a memory strategy.

", - "union":true - }, - "RegistryArn":{ - "type":"string", - "pattern":"arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:registry/[a-zA-Z0-9]{12,16}" - }, - "RegistryAuthorizerType":{ - "type":"string", - "enum":[ - "CUSTOM_JWT", - "AWS_IAM" - ] - }, - "RegistryId":{ - "type":"string", - "max":16, - "min":12, - "pattern":"[a-zA-Z0-9]{12,16}" - }, - "RegistryIdentifier":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"(arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:registry/)?[a-zA-Z0-9]{12,16}" - }, - "RegistryName":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[a-zA-Z0-9][a-zA-Z0-9_\\-\\.\\/]*" - }, - "RegistryRecordArn":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:registry/[a-zA-Z0-9]{12,16}/record/[a-zA-Z0-9]{12}" - }, - "RegistryRecordCredentialProviderConfiguration":{ - "type":"structure", - "required":[ - "credentialProviderType", - "credentialProvider" - ], - "members":{ - "credentialProviderType":{ - "shape":"RegistryRecordCredentialProviderType", - "documentation":"

The type of credential provider.

  • OAUTH - OAuth-based authentication.

  • IAM - Amazon Web Services IAM-based authentication using SigV4 signing.

" - }, - "credentialProvider":{ - "shape":"RegistryRecordCredentialProviderUnion", - "documentation":"

The credential provider configuration details. The structure depends on the credentialProviderType.

" - } - }, - "documentation":"

A pairing of a credential provider type with its corresponding provider details for authenticating with external sources.

" - }, - "RegistryRecordCredentialProviderConfigurationList":{ - "type":"list", - "member":{"shape":"RegistryRecordCredentialProviderConfiguration"}, - "max":1, - "min":0 - }, - "RegistryRecordCredentialProviderType":{ - "type":"string", - "enum":[ - "OAUTH", - "IAM" - ] - }, - "RegistryRecordCredentialProviderUnion":{ - "type":"structure", - "members":{ - "oauthCredentialProvider":{ - "shape":"RegistryRecordOAuthCredentialProvider", - "documentation":"

The OAuth credential provider configuration for authenticating with the external source.

" - }, - "iamCredentialProvider":{ - "shape":"RegistryRecordIamCredentialProvider", - "documentation":"

The IAM credential provider configuration for authenticating with the external source using SigV4 signing.

" - } - }, - "documentation":"

Union of supported credential provider types for registry record synchronization.

", - "union":true - }, - "RegistryRecordIamCredentialProvider":{ - "type":"structure", - "members":{ - "roleArn":{ - "shape":"IamRoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the IAM role to assume for SigV4 signing.

" - }, - "service":{ - "shape":"IamSigningServiceName", - "documentation":"

The SigV4 signing service name (for example, execute-api or bedrock-agentcore).

" - }, - "region":{ - "shape":"IamSigningRegion", - "documentation":"

The Amazon Web Services region for SigV4 signing (for example, us-west-2). If not specified, the region is extracted from the MCP server URL hostname, with fallback to the service's own region.

" - } - }, - "documentation":"

IAM credential provider configuration for authenticating with an external source using SigV4 signing during synchronization.

" - }, - "RegistryRecordId":{ - "type":"string", - "max":12, - "min":12, - "pattern":"[a-zA-Z0-9]{12}" - }, - "RegistryRecordName":{ - "type":"string", - "max":255, - "min":1, - "pattern":"[a-zA-Z0-9][a-zA-Z0-9_\\-\\.\\/]*" - }, - "RegistryRecordOAuthCredentialProvider":{ - "type":"structure", - "required":["providerArn"], - "members":{ - "providerArn":{ - "shape":"CredentialProviderArn", - "documentation":"

The Amazon Resource Name (ARN) of the OAuth credential provider resource.

" - }, - "grantType":{ - "shape":"RegistryRecordOAuthGrantType", - "documentation":"

The OAuth grant type. Currently only CLIENT_CREDENTIALS is supported.

" - }, - "scopes":{ - "shape":"ScopeList", - "documentation":"

The OAuth scopes to request during authentication.

" - }, - "customParameters":{ - "shape":"CustomParameterMap", - "documentation":"

Additional custom parameters for the OAuth flow.

" - } - }, - "documentation":"

OAuth credential provider configuration for authenticating with an external source during synchronization.

" - }, - "RegistryRecordOAuthGrantType":{ - "type":"string", - "enum":["CLIENT_CREDENTIALS"] - }, - "RegistryRecordStatus":{ - "type":"string", - "enum":[ - "DRAFT", - "PENDING_APPROVAL", - "APPROVED", - "REJECTED", - "DEPRECATED", - "CREATING", - "UPDATING", - "CREATE_FAILED", - "UPDATE_FAILED" - ] - }, - "RegistryRecordSummary":{ - "type":"structure", - "required":[ - "registryArn", - "recordArn", - "recordId", - "name", - "descriptorType", - "recordVersion", - "status", - "createdAt", - "updatedAt" - ], - "members":{ - "registryArn":{ - "shape":"RegistryArn", - "documentation":"

The Amazon Resource Name (ARN) of the registry that contains the record.

" - }, - "recordArn":{ - "shape":"RegistryRecordArn", - "documentation":"

The Amazon Resource Name (ARN) of the registry record.

" - }, - "recordId":{ - "shape":"RegistryRecordId", - "documentation":"

The unique identifier of the registry record.

" - }, - "name":{ - "shape":"RegistryRecordName", - "documentation":"

The name of the registry record.

" - }, - "description":{ - "shape":"Description", - "documentation":"

The description of the registry record.

" - }, - "descriptorType":{ - "shape":"DescriptorType", - "documentation":"

The descriptor type of the registry record. Possible values are MCP, A2A, CUSTOM, and AGENT_SKILLS.

" - }, - "recordVersion":{ - "shape":"RegistryRecordVersion", - "documentation":"

The version of the registry record.

" - }, - "status":{ - "shape":"RegistryRecordStatus", - "documentation":"

The current status of the registry record. Possible values include CREATING, DRAFT, APPROVED, PENDING_APPROVAL, REJECTED, DEPRECATED, UPDATING, CREATE_FAILED, and UPDATE_FAILED.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the registry record was created.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the registry record was last updated.

" - } - }, - "documentation":"

Contains summary information about a registry record.

" - }, - "RegistryRecordSummaryList":{ - "type":"list", - "member":{"shape":"RegistryRecordSummary"} - }, - "RegistryRecordVersion":{ - "type":"string", - "max":255, - "min":1, - "pattern":"[a-zA-Z0-9.-]+" - }, - "RegistryStatus":{ - "type":"string", - "enum":[ - "CREATING", - "READY", - "UPDATING", - "CREATE_FAILED", - "UPDATE_FAILED", - "DELETING", - "DELETE_FAILED" - ] - }, - "RegistrySummary":{ - "type":"structure", - "required":[ - "name", - "registryId", - "registryArn", - "status", - "createdAt", - "updatedAt" - ], - "members":{ - "name":{ - "shape":"RegistryName", - "documentation":"

The name of the registry.

" - }, - "description":{ - "shape":"Description", - "documentation":"

The description of the registry.

" - }, - "registryId":{ - "shape":"RegistryId", - "documentation":"

The unique identifier of the registry.

" - }, - "registryArn":{ - "shape":"RegistryArn", - "documentation":"

The Amazon Resource Name (ARN) of the registry.

" - }, - "authorizerType":{ - "shape":"RegistryAuthorizerType", - "documentation":"

The type of authorizer used by the registry. This controls the authorization method for the Search and Invoke APIs used by consumers.

  • CUSTOM_JWT - Authorize with a bearer token.

  • AWS_IAM - Authorize with your Amazon Web Services IAM credentials.

" - }, - "status":{ - "shape":"RegistryStatus", - "documentation":"

The current status of the registry. Possible values include CREATING, READY, UPDATING, CREATE_FAILED, UPDATE_FAILED, DELETING, and DELETE_FAILED.

" - }, - "statusReason":{ - "shape":"String", - "documentation":"

The reason for the current status, typically set when the status is a failure state.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the registry was created.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the registry was last updated.

" - } - }, - "documentation":"

Contains summary information about a registry.

" - }, - "RegistrySummaryList":{ - "type":"list", - "member":{"shape":"RegistrySummary"} - }, - "RequestHeaderAllowlist":{ - "type":"list", - "member":{"shape":"HeaderName"}, - "max":20, - "min":1 - }, - "RequestHeaderConfiguration":{ - "type":"structure", - "members":{ - "requestHeaderAllowlist":{ - "shape":"RequestHeaderAllowlist", - "documentation":"

A list of HTTP request headers that are allowed to be passed through to the runtime.

" - } - }, - "documentation":"

Configuration for HTTP request headers that will be passed through to the runtime.

", - "union":true - }, - "RequiredProperties":{ - "type":"list", - "member":{"shape":"String"} - }, - "Resource":{ - "type":"structure", - "members":{ - "arn":{ - "shape":"BedrockAgentcoreResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the resource. This globally unique identifier specifies the exact resource that policies will be evaluated against for access control decisions.

" - } - }, - "documentation":"

Represents a resource within the AgentCore Policy system. Resources are the targets of policy evaluation. Currently, only AgentCore Gateways are supported as resources for policy enforcement.

", - "union":true - }, - "ResourceAssociationArn":{ - "type":"string", - "pattern":"arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:servicenetworkresourceassociation/snra-[0-9a-f]{17}" - }, - "ResourceConfigurationIdentifier":{ - "type":"string", - "max":2048, - "min":20, - "pattern":"((rcfg-[0-9a-z]{17})|(arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:resourceconfiguration/rcfg-[0-9a-z]{17}))" - }, - "ResourceGatewayArn":{ - "type":"string", - "pattern":"arn:[a-z0-9\\-]+:vpc-lattice:[a-zA-Z0-9\\-]+:\\d{12}:resourcegateway/rgw-[0-9a-z]{17}" - }, - "ResourceId":{ - "type":"string", - "max":59, - "min":12, - "pattern":"[A-Za-z][A-Za-z0-9_]*-[a-z0-9_]{10}" - }, - "ResourceLimitExceededException":{ - "type":"structure", - "members":{ - "message":{"shape":"String"} - }, - "documentation":"

Exception thrown when a resource limit is exceeded.

", - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "ResourceLocation":{ - "type":"structure", - "members":{ - "s3":{"shape":"S3Location"} - }, - "documentation":"

The location of a resource.

", - "union":true - }, - "ResourceNotFoundException":{ - "type":"structure", - "members":{ - "message":{"shape":"NonBlankString"} - }, - "documentation":"

This exception is thrown when a resource referenced by the operation does not exist

", - "error":{ - "httpStatusCode":404, - "senderFault":true - }, - "exception":true - }, - "ResourceOauth2ReturnUrlListType":{ - "type":"list", - "member":{"shape":"ResourceOauth2ReturnUrlType"} - }, - "ResourceOauth2ReturnUrlType":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"\\w+:(\\/?\\/?)[^\\s]+" - }, - "ResourcePolicyBody":{ - "type":"string", - "max":20480, - "min":1 - }, - "ResourceType":{ - "type":"string", - "enum":[ - "SYSTEM", - "CUSTOM" - ] - }, - "ResponseListType":{ - "type":"list", - "member":{"shape":"ResponseType"} - }, - "ResponseType":{"type":"string"}, - "RestApiMethod":{ - "type":"string", - "enum":[ - "GET", - "DELETE", - "HEAD", - "OPTIONS", - "PATCH", - "PUT", - "POST" - ] - }, - "RestApiMethods":{ - "type":"list", - "member":{"shape":"RestApiMethod"} - }, - "RoleArn":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+" - }, - "RouteToTargetAction":{ - "type":"structure", - "members":{ - "staticRoute":{ - "shape":"StaticRoute", - "documentation":"

A static route that sends all matching requests to a single target.

" - }, - "weightedRoute":{ - "shape":"WeightedRoute", - "documentation":"

A weighted route that splits traffic between multiple targets.

" - } - }, - "documentation":"

An action that routes requests to a gateway target, either statically or with weighted traffic splitting.

", - "union":true - }, - "RoutingDomain":{ - "type":"string", - "max":255, - "min":3 - }, - "Rule":{ - "type":"structure", - "required":["samplingConfig"], - "members":{ - "samplingConfig":{ - "shape":"SamplingConfig", - "documentation":"

The sampling configuration that determines what percentage of agent traces to evaluate.

" - }, - "filters":{ - "shape":"FilterList", - "documentation":"

The list of filters that determine which agent traces should be included in the evaluation based on trace properties.

" - }, - "sessionConfig":{ - "shape":"SessionConfig", - "documentation":"

The session configuration that defines timeout settings for detecting when agent sessions are complete and ready for evaluation.

" - } - }, - "documentation":"

The evaluation rule that defines sampling configuration, filtering criteria, and session detection settings for online evaluation.

" - }, - "RuntimeArn":{ - "type":"string", - "pattern":"arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:runtime/[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10}" - }, - "RuntimeContainerUri":{ - "type":"string", - "max":1024, - "min":1, - "pattern":"(([0-9]{12})\\.dkr\\.ecr\\.([a-z0-9-]+)\\.amazonaws\\.com(\\.cn)?|public\\.ecr\\.aws)/((?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*)(?::([^:@]{1,300}))?(?:@(.+))?" - }, - "RuntimeMetadataConfiguration":{ - "type":"structure", - "required":["requireMMDSV2"], - "members":{ - "requireMMDSV2":{ - "shape":"Boolean", - "documentation":"

Enables MMDSv2 (microVM Metadata Service Version 2) requirement for the agent runtime. When set to true, the runtime microVM will only accept MMDSv2 requests.

" - } - }, - "documentation":"

Configuration for microVM metadata service settings.

" - }, - "RuntimeQualifier":{ - "type":"string", - "pattern":".*([1-9][0-9]{0,4})|([a-zA-Z][a-zA-Z0-9_]{0,47}).*" - }, - "RuntimeTargetConfiguration":{ - "type":"structure", - "required":["arn"], - "members":{ - "arn":{ - "shape":"RuntimeArn", - "documentation":"

The Amazon Resource Name (ARN) of the AgentCore Runtime to route requests to.

" - }, - "qualifier":{ - "shape":"RuntimeQualifier", - "documentation":"

The qualifier for the agent runtime, used to target a specific endpoint version. If not specified, the default endpoint is used.

" - }, - "schema":{ - "shape":"HttpApiSchemaConfiguration", - "documentation":"

The API schema configuration that defines the structure of the runtime target's API.

" - } - }, - "documentation":"

Configuration for an AgentCore Runtime target. Specifies the agent runtime to route requests to via HTTP.

" - }, - "S3BucketUri":{ - "type":"string", - "pattern":"s3://.{1,2043}" - }, - "S3Configuration":{ - "type":"structure", - "members":{ - "uri":{ - "shape":"S3BucketUri", - "documentation":"

The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3.

" - }, - "bucketOwnerAccountId":{ - "shape":"AwsAccountId", - "documentation":"

The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.

" - } - }, - "documentation":"

The Amazon S3 configuration for a gateway. This structure defines how the gateway accesses files in Amazon S3.

" - }, - "S3FilesAccessPointArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[-a-z]*:s3files:[0-9a-z-:]+:file-system/fs-[0-9a-f]{17,40}/access-point/fsap-[0-9a-f]{17,40}" - }, - "S3FilesAccessPointConfiguration":{ - "type":"structure", - "required":[ - "accessPointArn", - "mountPath" - ], - "members":{ - "accessPointArn":{ - "shape":"S3FilesAccessPointArn", - "documentation":"

The ARN of the S3 Files access point to mount into the AgentCore Runtime.

" - }, - "mountPath":{ - "shape":"MountPath", - "documentation":"

The mount path for the S3 Files access point inside the AgentCore Runtime. The path must be under /mnt with exactly one subdirectory level (for example, /mnt/data).

" - } - }, - "documentation":"

Configuration for an Amazon S3 Files access point filesystem mounted into the AgentCore Runtime. S3 Files access points provide shared file storage accessible from your AgentCore Runtime sessions.

" - }, - "S3FilesConfiguration":{ - "type":"structure", - "required":[ - "accessPointArn", - "mountPath", - "fileSystemArn" - ], - "members":{ - "accessPointArn":{ - "shape":"S3FilesAccessPointArn", - "documentation":"

The Amazon Resource Name (ARN) of the Amazon Simple Storage Service (Amazon S3) Files access point to mount.

" - }, - "mountPath":{ - "shape":"MountPath", - "documentation":"

The absolute path within the session at which the access point is mounted, for example /mnt/s3data. Each mount path must be unique across all file system configurations in the session.

" - }, - "fileSystemArn":{ - "shape":"S3FilesFileSystemArn", - "documentation":"

The Amazon Resource Name (ARN) of the Amazon Simple Storage Service (Amazon S3) Files file system that owns the access point.

" - } - }, - "documentation":"

The configuration for mounting an Amazon Simple Storage Service (Amazon S3) Files access point that you own into a session.

" - }, - "S3FilesFileSystemArn":{ - "type":"string", - "documentation":"

The Amazon Resource Name (ARN) of an Amazon Simple Storage Service (Amazon S3) Files file system. The access points you specify must belong to this file system.

", - "max":256, - "min":0, - "pattern":"arn:aws[-a-z]*:s3files:[a-z0-9-]+:[0-9]{12}:file-system/fs-[0-9a-f]{17,40}" - }, - "S3Location":{ - "type":"structure", - "required":[ - "bucket", - "prefix" - ], - "members":{ - "bucket":{ - "shape":"S3LocationBucketString", - "documentation":"

The name of the Amazon S3 bucket. This bucket contains the stored data.

" - }, - "prefix":{ - "shape":"S3LocationPrefixString", - "documentation":"

The prefix for objects in the Amazon S3 bucket. This prefix is added to the object keys to organize the data.

" - }, - "versionId":{ - "shape":"S3LocationVersionIdString", - "documentation":"

The version ID of the Amazon Amazon S3 object. If not specified, the latest version of the object is used.

" - } - }, - "documentation":"

The Amazon S3 location for storing data. This structure defines where in Amazon S3 data is stored.

" - }, - "S3LocationBucketString":{ - "type":"string", - "pattern":"[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]" - }, - "S3LocationPrefixString":{ - "type":"string", - "max":1024, - "min":1 - }, - "S3LocationVersionIdString":{ - "type":"string", - "max":1024, - "min":3 - }, - "S3Source":{ - "type":"structure", - "required":["s3Uri"], - "members":{ - "s3Uri":{ - "shape":"S3Uri", - "documentation":"

Amazon S3 URI of the JSONL file (for example, s3://my-bucket/path/to/examples.jsonl).

" - } - }, - "documentation":"

Amazon S3 location of a JSONL file containing dataset examples.

" - }, - "S3Uri":{ - "type":"string", - "documentation":"

Amazon S3 URI string in the format s3://bucket/key.

", - "pattern":"s3://[a-z0-9][a-z0-9.\\-]{1,61}[a-z0-9]/.{1,1024}" - }, - "SalesforceOauth2ProviderConfigInput":{ - "type":"structure", - "required":["clientId"], - "members":{ - "clientId":{ - "shape":"ClientIdType", - "documentation":"

The client ID for the Salesforce OAuth2 provider.

" - }, - "clientSecret":{ - "shape":"DefaultClientSecretType", - "documentation":"

The client secret for the Salesforce OAuth2 provider.

" - }, - "clientSecretConfig":{ - "shape":"SecretReference", - "documentation":"

A reference to the Amazon Web Services Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when clientSecretSource is set to EXTERNAL.

" - }, - "clientSecretSource":{ - "shape":"SecretSourceType", - "documentation":"

The source type of the client secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.

" - } - }, - "documentation":"

Input configuration for a Salesforce OAuth2 provider.

" - }, - "SalesforceOauth2ProviderConfigOutput":{ - "type":"structure", - "required":["oauthDiscovery"], - "members":{ - "oauthDiscovery":{ - "shape":"Oauth2Discovery", - "documentation":"

The OAuth2 discovery information for the Salesforce provider.

" - }, - "clientId":{ - "shape":"ClientIdType", - "documentation":"

The client ID for the Salesforce OAuth2 provider.

" - } - }, - "documentation":"

Output configuration for a Salesforce OAuth2 provider.

" - }, - "SamplingConfig":{ - "type":"structure", - "required":["samplingPercentage"], - "members":{ - "samplingPercentage":{ - "shape":"SamplingConfigSamplingPercentageDouble", - "documentation":"

The percentage of agent traces to sample for evaluation, ranging from 0.01% to 100%.

" - } - }, - "documentation":"

The configuration that controls what percentage of agent traces are sampled for evaluation to manage evaluation volume and costs.

" - }, - "SamplingConfigSamplingPercentageDouble":{ - "type":"double", - "box":true, - "max":100.0, - "min":0.01 - }, - "SandboxName":{ - "type":"string", - "pattern":"[a-zA-Z][a-zA-Z0-9_]{0,47}" - }, - "SchemaDefinition":{ - "type":"structure", - "required":["type"], - "members":{ - "type":{ - "shape":"SchemaType", - "documentation":"

The type of the schema definition. This field specifies the data type of the schema.

" - }, - "properties":{ - "shape":"SchemaProperties", - "documentation":"

The properties of the schema definition. These properties define the fields in the schema.

" - }, - "required":{ - "shape":"RequiredProperties", - "documentation":"

The required fields in the schema definition. These fields must be provided when using the schema.

" - }, - "items":{ - "shape":"SchemaDefinition", - "documentation":"

The items in the schema definition. This field is used for array types to define the structure of the array elements.

" - }, - "description":{ - "shape":"String", - "documentation":"

The description of the schema definition. This description provides information about the purpose and usage of the schema.

" - } - }, - "documentation":"

A schema definition for a gateway target. This structure defines the structure of the API that the target exposes.

" - }, - "SchemaProperties":{ - "type":"map", - "key":{"shape":"String"}, - "value":{"shape":"SchemaDefinition"} - }, - "SchemaType":{ - "type":"string", - "enum":[ - "string", - "number", - "object", - "array", - "boolean", - "integer" - ] - }, - "SchemaVersion":{ - "type":"string", - "max":255, - "min":1 - }, - "ScopeList":{ - "type":"list", - "member":{"shape":"String"} - }, - "ScopeType":{ - "type":"string", - "max":128, - "min":1 - }, - "ScopesListType":{ - "type":"list", - "member":{"shape":"ScopeType"} - }, - "SearchType":{ - "type":"string", - "enum":["SEMANTIC"] - }, - "Secret":{ - "type":"structure", - "required":["secretArn"], - "members":{ - "secretArn":{ - "shape":"SecretArn", - "documentation":"

The Amazon Resource Name (ARN) of the secret in Amazon Web Services Secrets Manager.

" - } - }, - "documentation":"

Contains information about a secret in Amazon Web Services Secrets Manager.

" - }, - "SecretArn":{ - "type":"string", - "pattern":"arn:(aws|aws-us-gov):secretsmanager:[A-Za-z0-9-]{1,64}:[0-9]{12}:secret:[a-zA-Z0-9-_/+=.@!]+" - }, - "SecretIdType":{ - "type":"string", - "max":2048, - "min":1 - }, - "SecretJsonKeyType":{ - "type":"string", - "max":128, - "min":1 - }, - "SecretReference":{ - "type":"structure", - "required":[ - "secretId", - "jsonKey" - ], - "members":{ - "secretId":{ - "shape":"SecretIdType", - "documentation":"

The ID of the Amazon Web Services Secrets Manager secret that stores the secret value.

" - }, - "jsonKey":{ - "shape":"SecretJsonKeyType", - "documentation":"

The JSON key used to extract the secret value from the Amazon Web Services Secrets Manager secret.

" - } - }, - "documentation":"

Contains a reference to a secret stored in Amazon Web Services Secrets Manager.

" - }, - "SecretSourceType":{ - "type":"string", - "enum":[ - "MANAGED", - "EXTERNAL" - ] - }, - "SecretsManagerLocation":{ - "type":"structure", - "required":["secretArn"], - "members":{ - "secretArn":{ - "shape":"ToolSecretArn", - "documentation":"

The ARN of the Amazon Web Services Secrets Manager secret containing the certificate.

" - } - }, - "documentation":"

The Amazon Web Services Secrets Manager location configuration.

" - }, - "SecurityGroupId":{ - "type":"string", - "pattern":"sg-[0-9a-zA-Z]{8,17}" - }, - "SecurityGroupIdentifier":{ - "type":"string", - "pattern":"sg-(([0-9a-z]{8})|([0-9a-z]{17}))" - }, - "SecurityGroupIds":{ - "type":"list", - "member":{"shape":"SecurityGroupIdentifier"}, - "max":5, - "min":0 - }, - "SecurityGroups":{ - "type":"list", - "member":{"shape":"SecurityGroupId"}, - "max":16, - "min":1 - }, - "SelfManagedConfiguration":{ - "type":"structure", - "required":[ - "triggerConditions", - "invocationConfiguration", - "historicalContextWindowSize" - ], - "members":{ - "triggerConditions":{ - "shape":"TriggerConditionsList", - "documentation":"

A list of conditions that trigger memory processing.

" - }, - "invocationConfiguration":{ - "shape":"InvocationConfiguration", - "documentation":"

The configuration to use when invoking memory processing.

" - }, - "historicalContextWindowSize":{ - "shape":"Integer", - "documentation":"

The number of historical messages to include in processing context.

" - } - }, - "documentation":"

A configuration for a self-managed memory strategy.

" - }, - "SelfManagedConfigurationInput":{ - "type":"structure", - "required":["invocationConfiguration"], - "members":{ - "triggerConditions":{ - "shape":"TriggerConditionInputList", - "documentation":"

A list of conditions that trigger memory processing.

" - }, - "invocationConfiguration":{ - "shape":"InvocationConfigurationInput", - "documentation":"

Configuration to invoke a self-managed memory processing pipeline with.

" - }, - "historicalContextWindowSize":{ - "shape":"SelfManagedConfigurationInputHistoricalContextWindowSizeInteger", - "documentation":"

Number of historical messages to include in processing context.

" - } - }, - "documentation":"

Input configuration for a self-managed memory strategy.

" - }, - "SelfManagedConfigurationInputHistoricalContextWindowSizeInteger":{ - "type":"integer", - "box":true, - "max":50, - "min":0 - }, - "SelfManagedLatticeResource":{ - "type":"structure", - "members":{ - "resourceConfigurationIdentifier":{ - "shape":"ResourceConfigurationIdentifier", - "documentation":"

The ARN or ID of the VPC Lattice resource configuration.

" - } - }, - "documentation":"

Configuration for a self-managed VPC Lattice resource. You create and manage the VPC Lattice resource gateway and resource configuration, then provide the resource configuration identifier.

", - "union":true - }, - "SemanticConsolidationOverride":{ - "type":"structure", - "required":[ - "appendToPrompt", - "modelId" - ], - "members":{ - "appendToPrompt":{ - "shape":"Prompt", - "documentation":"

The text to append to the prompt for semantic consolidation.

" - }, - "modelId":{ - "shape":"String", - "documentation":"

The model ID to use for semantic consolidation.

" - } - }, - "documentation":"

Contains semantic consolidation override configuration.

" - }, - "SemanticExtractionOverride":{ - "type":"structure", - "required":[ - "appendToPrompt", - "modelId" - ], - "members":{ - "appendToPrompt":{ - "shape":"Prompt", - "documentation":"

The text to append to the prompt for semantic extraction.

" - }, - "modelId":{ - "shape":"String", - "documentation":"

The model ID to use for semantic extraction.

" - } - }, - "documentation":"

Contains semantic extraction override configuration.

" - }, - "SemanticMemoryStrategyInput":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{ - "shape":"Name", - "documentation":"

The name of the semantic memory strategy.

" - }, - "description":{ - "shape":"Description", - "documentation":"

The description of the semantic memory strategy.

" - }, - "namespaces":{ - "shape":"NamespacesList", - "documentation":"

This is a legacy parameter, use namespaceTemplates. The namespaces associated with the semantic memory strategy.

", - "deprecated":true, - "deprecatedMessage":"Use namespaceTemplates instead", - "deprecatedSince":"2026-03-02" - }, - "namespaceTemplates":{ - "shape":"NamespacesList", - "documentation":"

The namespaceTemplates associated with the semantic memory strategy.

" - }, - "memoryRecordSchema":{"shape":"MemoryRecordSchema"} - }, - "documentation":"

Input for creating a semantic memory strategy.

" - }, - "SemanticOverrideConfigurationInput":{ - "type":"structure", - "members":{ - "extraction":{ - "shape":"SemanticOverrideExtractionConfigurationInput", - "documentation":"

The extraction configuration for a semantic override.

" - }, - "consolidation":{ - "shape":"SemanticOverrideConsolidationConfigurationInput", - "documentation":"

The consolidation configuration for a semantic override.

" - } - }, - "documentation":"

Input for semantic override configuration in a memory strategy.

" - }, - "SemanticOverrideConsolidationConfigurationInput":{ - "type":"structure", - "required":[ - "appendToPrompt", - "modelId" - ], - "members":{ - "appendToPrompt":{ - "shape":"Prompt", - "documentation":"

The text to append to the prompt for semantic consolidation.

" - }, - "modelId":{ - "shape":"String", - "documentation":"

The model ID to use for semantic consolidation.

" - } - }, - "documentation":"

Input for semantic override consolidation configuration in a memory strategy.

" - }, - "SemanticOverrideExtractionConfigurationInput":{ - "type":"structure", - "required":[ - "appendToPrompt", - "modelId" - ], - "members":{ - "appendToPrompt":{ - "shape":"Prompt", - "documentation":"

The text to append to the prompt for semantic extraction.

" - }, - "modelId":{ - "shape":"String", - "documentation":"

The model ID to use for semantic extraction.

" - } - }, - "documentation":"

Input for semantic override extraction configuration in a memory strategy.

" - }, - "SensitiveJson":{ - "type":"structure", - "members":{}, - "document":true, - "sensitive":true - }, - "SensitiveText":{ - "type":"string", - "min":1, - "sensitive":true - }, - "ServerDefinition":{ - "type":"structure", - "members":{ - "schemaVersion":{ - "shape":"SchemaVersion", - "documentation":"

The schema version of the server definition based on the MCP protocol specification. If not specified, the version is auto-detected from the content.

" - }, - "inlineContent":{ - "shape":"InlineContent", - "documentation":"

The JSON content containing the MCP server definition, conforming to the MCP protocol specification.

" - } - }, - "documentation":"

The server definition for an MCP descriptor. Contains the schema version and inline content for the MCP server configuration.

" - }, - "ServerProtocol":{ - "type":"string", - "enum":[ - "MCP", - "HTTP", - "A2A", - "AGUI" - ] - }, - "ServiceException":{ - "type":"structure", - "members":{ - "message":{"shape":"String"} - }, - "documentation":"

An internal error occurred.

", - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true, - "retryable":{"throttling":false} - }, - "ServiceName":{ - "type":"string", - "max":256, - "min":1, - "pattern":"[a-zA-Z0-9._-]+" - }, - "ServiceQuotaExceededException":{ - "type":"structure", - "members":{ - "message":{"shape":"NonBlankString"} - }, - "documentation":"

This exception is thrown when a request is made beyond the service quota

", - "error":{ - "httpStatusCode":402, - "senderFault":true - }, - "exception":true - }, - "SessionConfig":{ - "type":"structure", - "required":["sessionTimeoutMinutes"], - "members":{ - "sessionTimeoutMinutes":{ - "shape":"SessionConfigSessionTimeoutMinutesInteger", - "documentation":"

The number of minutes of inactivity after which an agent session is considered complete and ready for evaluation. Default is 15 minutes.

" - } - }, - "documentation":"

The configuration that defines how agent sessions are detected and when they are considered complete for evaluation.

" - }, - "SessionConfigSessionTimeoutMinutesInteger":{ - "type":"integer", - "box":true, - "max":1440, - "min":1 - }, - "SessionConfiguration":{ - "type":"structure", - "members":{ - "sessionTimeoutInSeconds":{ - "shape":"SessionConfigurationSessionTimeoutInSecondsInteger", - "documentation":"

The session timeout in seconds. After this timeout, the session expires and subsequent requests to this session will receive an error. The minimum value is 900 seconds (15 minutes), the maximum value is 28800 seconds (8 hours), and the default value is 3600 seconds (1 hour).

" - } - }, - "documentation":"

The session configuration for an MCP gateway. This structure defines settings that control session behavior.

" - }, - "SessionConfigurationSessionTimeoutInSecondsInteger":{ - "type":"integer", - "box":true, - "max":28800, - "min":900 - }, - "SessionStorageConfiguration":{ - "type":"structure", - "required":["mountPath"], - "members":{ - "mountPath":{ - "shape":"MountPath", - "documentation":"

The mount path for the session storage filesystem inside the AgentCore Runtime. The path must be under /mnt with exactly one subdirectory level (for example, /mnt/data).

" - } - }, - "documentation":"

Configuration for a session storage filesystem mounted into the AgentCore Runtime. Session storage provides persistent storage that is preserved across AgentCore Runtime session invocations.

" - }, - "SetTokenVaultCMKRequest":{ - "type":"structure", - "required":["kmsConfiguration"], - "members":{ - "tokenVaultId":{ - "shape":"TokenVaultIdType", - "documentation":"

The unique identifier of the token vault to update.

" - }, - "kmsConfiguration":{ - "shape":"KmsConfiguration", - "documentation":"

The KMS configuration for the token vault, including the key type and KMS key ARN.

" - } - } - }, - "SetTokenVaultCMKResponse":{ - "type":"structure", - "required":[ - "tokenVaultId", - "kmsConfiguration", - "lastModifiedDate" - ], - "members":{ - "tokenVaultId":{ - "shape":"TokenVaultIdType", - "documentation":"

The ID of the token vault.

" - }, - "kmsConfiguration":{ - "shape":"KmsConfiguration", - "documentation":"

The KMS configuration for the token vault.

" - }, - "lastModifiedDate":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the token vault was last modified.

" - } - } - }, - "SigningAlgorithm":{ - "type":"string", - "enum":[ - "RS256", - "PS256", - "ES256" - ] - }, - "SkillDefinition":{ - "type":"structure", - "members":{ - "schemaVersion":{ - "shape":"SchemaVersion", - "documentation":"

The version of the skill definition schema.

" - }, - "inlineContent":{ - "shape":"InlineContent", - "documentation":"

The JSON content containing the structured skill definition.

" - } - }, - "documentation":"

The structured skill definition with schema version and content.

" - }, - "SkillMdDefinition":{ - "type":"structure", - "members":{ - "inlineContent":{ - "shape":"InlineContent", - "documentation":"

The markdown content describing the agent's skills in a human-readable format.

" - } - }, - "documentation":"

The skill markdown definition for an agent skills descriptor.

" - }, - "SlackOauth2ProviderConfigInput":{ - "type":"structure", - "required":["clientId"], - "members":{ - "clientId":{ - "shape":"ClientIdType", - "documentation":"

The client ID for the Slack OAuth2 provider.

" - }, - "clientSecret":{ - "shape":"DefaultClientSecretType", - "documentation":"

The client secret for the Slack OAuth2 provider.

" - }, - "clientSecretConfig":{ - "shape":"SecretReference", - "documentation":"

A reference to the Amazon Web Services Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when clientSecretSource is set to EXTERNAL.

" - }, - "clientSecretSource":{ - "shape":"SecretSourceType", - "documentation":"

The source type of the client secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.

" - } - }, - "documentation":"

Input configuration for a Slack OAuth2 provider.

" - }, - "SlackOauth2ProviderConfigOutput":{ - "type":"structure", - "required":["oauthDiscovery"], - "members":{ - "oauthDiscovery":{ - "shape":"Oauth2Discovery", - "documentation":"

The OAuth2 discovery information for the Slack provider.

" - }, - "clientId":{ - "shape":"ClientIdType", - "documentation":"

The client ID for the Slack OAuth2 provider.

" - } - }, - "documentation":"

Output configuration for a Slack OAuth2 provider.

" - }, - "StartPolicyGenerationRequest":{ - "type":"structure", - "required":[ - "policyEngineId", - "resource", - "content", - "name" - ], - "members":{ - "policyEngineId":{ - "shape":"ResourceId", - "documentation":"

The identifier of the policy engine that provides the context for policy generation. This engine's schema and tool context are used to ensure generated policies are valid and applicable.

", - "location":"uri", - "locationName":"policyEngineId" - }, - "resource":{ - "shape":"Resource", - "documentation":"

The resource information that provides context for policy generation. This helps the AI understand the target resources and generate appropriate access control rules.

" - }, - "content":{ - "shape":"Content", - "documentation":"

The natural language description of the desired policy behavior. This content is processed by AI to generate corresponding Cedar policy statements that match the described intent.

" - }, - "name":{ - "shape":"PolicyGenerationName", - "documentation":"

A customer-assigned name for the policy generation request. This helps track and identify generation operations, especially when running multiple generations simultaneously.

" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure the idempotency of the request. The AWS SDK automatically generates this token, so you don't need to provide it in most cases. If you retry a request with the same client token, the service returns the same response without starting a duplicate generation.

", - "idempotencyToken":true - } - } - }, - "StartPolicyGenerationResponse":{ - "type":"structure", - "required":[ - "policyEngineId", - "policyGenerationId", - "name", - "policyGenerationArn", - "resource", - "createdAt", - "updatedAt", - "status", - "statusReasons" - ], - "members":{ - "policyEngineId":{ - "shape":"ResourceId", - "documentation":"

The identifier of the policy engine associated with the started policy generation.

" - }, - "policyGenerationId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier assigned to the policy generation request for tracking progress.

" - }, - "name":{ - "shape":"PolicyGenerationName", - "documentation":"

The customer-assigned name for the policy generation request.

" - }, - "policyGenerationArn":{ - "shape":"PolicyGenerationArn", - "documentation":"

The ARN of the created policy generation request.

" - }, - "resource":{ - "shape":"Resource", - "documentation":"

The resource information associated with the policy generation request.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the policy generation request was created.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the policy generation was last updated.

" - }, - "status":{ - "shape":"PolicyGenerationStatus", - "documentation":"

The initial status of the policy generation request.

" - }, - "findings":{ - "shape":"String", - "documentation":"

Initial findings from the policy generation process.

" - }, - "statusReasons":{ - "shape":"PolicyStatusReasons", - "documentation":"

Additional information about the generation status.

" - } - } - }, - "Statement":{ - "type":"string", - "max":10000, - "min":35 - }, - "StaticOverride":{ - "type":"structure", - "required":[ - "bundleArn", - "bundleVersion" - ], - "members":{ - "bundleArn":{ - "shape":"GatewayConfigurationBundleArn", - "documentation":"

The Amazon Resource Name (ARN) of the configuration bundle to apply.

" - }, - "bundleVersion":{ - "shape":"StaticOverrideBundleVersionString", - "documentation":"

The version of the configuration bundle to apply.

" - } - }, - "documentation":"

A static configuration bundle override.

" - }, - "StaticOverrideBundleVersionString":{ - "type":"string", - "pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" - }, - "StaticRoute":{ - "type":"structure", - "required":["targetName"], - "members":{ - "targetName":{ - "shape":"TargetName", - "documentation":"

The name of the target to route requests to.

" - } - }, - "documentation":"

A static route to a single gateway target.

" - }, - "Status":{ - "type":"string", - "enum":[ - "CREATING", - "CREATE_FAILED", - "UPDATING", - "UPDATE_FAILED", - "READY", - "DELETING", - "DELETE_FAILED" - ] - }, - "StatusReason":{ - "type":"string", - "max":2048, - "min":0 - }, - "StatusReasons":{ - "type":"list", - "member":{"shape":"StatusReason"}, - "max":100, - "min":0 - }, - "StickinessConfiguration":{ - "type":"structure", - "required":["identifier"], - "members":{ - "identifier":{ - "shape":"StickinessConfigurationIdentifierString", - "documentation":"

The expression that identifies where to extract the session identifier from the request (for example, $context.header.x-session-id).

" - }, - "timeout":{ - "shape":"StickinessTimeout", - "documentation":"

The session stickiness timeout, in seconds. After this duration of inactivity, the session affinity expires. Valid values range from 1 to 86400.

" - } - }, - "documentation":"

The configuration for session-sticky routing to a target. Session stickiness routes requests that share a session identifier to the same target.

" - }, - "StickinessConfigurationIdentifierString":{ - "type":"string", - "max":256, - "min":1 - }, - "StickinessTimeout":{ - "type":"integer", - "box":true, - "max":86400, - "min":1 - }, - "StrategyConfiguration":{ - "type":"structure", - "members":{ - "type":{ - "shape":"OverrideType", - "documentation":"

The type of override for the strategy configuration.

" - }, - "extraction":{ - "shape":"ExtractionConfiguration", - "documentation":"

The extraction configuration for the memory strategy.

" - }, - "consolidation":{ - "shape":"ConsolidationConfiguration", - "documentation":"

The consolidation configuration for the memory strategy.

" - }, - "reflection":{ - "shape":"ReflectionConfiguration", - "documentation":"

The reflection configuration for the memory strategy.

" - }, - "selfManagedConfiguration":{ - "shape":"SelfManagedConfiguration", - "documentation":"

Self-managed configuration settings.

" - } - }, - "documentation":"

Contains configuration information for a memory strategy.

" - }, - "StreamDeliveryResource":{ - "type":"structure", - "members":{ - "kinesis":{ - "shape":"KinesisResource", - "documentation":"

Kinesis Data Stream configuration.

" - } - }, - "documentation":"

Supported stream delivery resource types.

", - "union":true - }, - "StreamDeliveryResources":{ - "type":"structure", - "required":["resources"], - "members":{ - "resources":{ - "shape":"StreamDeliveryResourcesList", - "documentation":"

List of stream delivery resource configurations.

" - } - }, - "documentation":"

Configuration for streaming memory record data to external resources.

" - }, - "StreamDeliveryResourcesList":{ - "type":"list", - "member":{"shape":"StreamDeliveryResource"}, - "max":1, - "min":0 - }, - "StreamingConfiguration":{ - "type":"structure", - "members":{ - "enableResponseStreaming":{ - "shape":"Boolean", - "documentation":"

Indicates whether response streaming is enabled for the gateway. When set to true, the gateway streams responses from targets back to the client.

" - } - }, - "documentation":"

The streaming configuration for an MCP gateway. This structure defines settings that control response streaming behavior.

" - }, - "String":{"type":"string"}, - "StringListValidation":{ - "type":"structure", - "members":{ - "allowedValues":{ - "shape":"AllowedStringListValuesList", - "documentation":"

Allowed values for items in this STRINGLIST field.

" - }, - "maxItems":{ - "shape":"StringListValidationMaxItemsInteger", - "documentation":"

Maximum number of items in the string list.

" - } - }, - "documentation":"

Validation for STRINGLIST fields.

" - }, - "StringListValidationMaxItemsInteger":{ - "type":"integer", - "box":true, - "max":5, - "min":1 - }, - "StringValidation":{ - "type":"structure", - "required":["allowedValues"], - "members":{ - "allowedValues":{ - "shape":"AllowedStringValuesList", - "documentation":"

Allowed values for this STRING field.

" - } - }, - "documentation":"

Validation for STRING fields.

" - }, - "StripePrivyAppIdType":{ - "type":"string", - "max":512, - "min":1, - "pattern":"[a-zA-Z0-9\\-_]+" - }, - "StripePrivyAuthorizationIdType":{ - "type":"string", - "max":512, - "min":1, - "pattern":"[a-zA-Z0-9\\-_]+" - }, - "StripePrivyConfigurationInput":{ - "type":"structure", - "required":[ - "appId", - "authorizationId" - ], - "members":{ - "appId":{ - "shape":"StripePrivyAppIdType", - "documentation":"

The app ID provided by Privy.

" - }, - "appSecret":{ - "shape":"DefaultStripePrivyAppSecretType", - "documentation":"

The app secret provided by Privy.

" - }, - "appSecretSource":{ - "shape":"SecretSourceType", - "documentation":"

The source type of the app secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.

" - }, - "appSecretConfig":{ - "shape":"SecretReference", - "documentation":"

A reference to the Amazon Web Services Secrets Manager secret that stores the app secret. This includes the secret ID and the JSON key used to extract the app secret value from the secret. Required when appSecretSource is set to EXTERNAL.

" - }, - "authorizationPrivateKey":{ - "shape":"DefaultStripePrivyAuthorizationPrivateKeyType", - "documentation":"

The authorization private key for the Stripe Privy integration.

" - }, - "authorizationPrivateKeySource":{ - "shape":"SecretSourceType", - "documentation":"

The source type of the authorization private key. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.

" - }, - "authorizationPrivateKeyConfig":{ - "shape":"SecretReference", - "documentation":"

A reference to the Amazon Web Services Secrets Manager secret that stores the authorization private key. This includes the secret ID and the JSON key used to extract the authorization private key value from the secret. Required when authorizationPrivateKeySource is set to EXTERNAL.

" - }, - "authorizationId":{ - "shape":"StripePrivyAuthorizationIdType", - "documentation":"

The authorization ID for the Stripe Privy integration.

" - } - }, - "documentation":"

Stripe Privy configuration — credentials provided by Stripe and Privy.

" - }, - "StripePrivyConfigurationOutput":{ - "type":"structure", - "required":[ - "appId", - "appSecretArn", - "authorizationPrivateKeyArn", - "authorizationId" - ], - "members":{ - "appId":{ - "shape":"StripePrivyAppIdType", - "documentation":"

The app ID provided by Privy.

" - }, - "appSecretArn":{"shape":"Secret"}, - "appSecretJsonKey":{ - "shape":"SecretJsonKeyType", - "documentation":"

The JSON key used to extract the app secret value from the Amazon Web Services Secrets Manager secret.

" - }, - "appSecretSource":{ - "shape":"SecretSourceType", - "documentation":"

The source type of the app secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager.

" - }, - "authorizationPrivateKeyArn":{"shape":"Secret"}, - "authorizationPrivateKeyJsonKey":{ - "shape":"SecretJsonKeyType", - "documentation":"

The JSON key used to extract the authorization private key value from the Amazon Web Services Secrets Manager secret.

" - }, - "authorizationPrivateKeySource":{ - "shape":"SecretSourceType", - "documentation":"

The source type of the authorization private key. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager.

" - }, - "authorizationId":{ - "shape":"StripePrivyAuthorizationIdType", - "documentation":"

The authorization ID for the Stripe Privy integration.

" - } - }, - "documentation":"

Stripe Privy configuration output with secret ARNs.

" - }, - "SubmitRegistryRecordForApprovalRequest":{ - "type":"structure", - "required":[ - "registryId", - "recordId" - ], - "members":{ - "registryId":{ - "shape":"RegistryIdentifier", - "documentation":"

The identifier of the registry containing the record. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.

", - "location":"uri", - "locationName":"registryId" - }, - "recordId":{ - "shape":"RecordIdentifier", - "documentation":"

The identifier of the registry record to submit for approval. You can specify either the Amazon Resource Name (ARN) or the ID of the record.

", - "location":"uri", - "locationName":"recordId" - } - } - }, - "SubmitRegistryRecordForApprovalResponse":{ - "type":"structure", - "required":[ - "registryArn", - "recordArn", - "recordId", - "status", - "updatedAt" - ], - "members":{ - "registryArn":{ - "shape":"RegistryArn", - "documentation":"

The Amazon Resource Name (ARN) of the registry that contains the record.

" - }, - "recordArn":{ - "shape":"RegistryRecordArn", - "documentation":"

The Amazon Resource Name (ARN) of the registry record.

" - }, - "recordId":{ - "shape":"RegistryRecordId", - "documentation":"

The unique identifier of the registry record.

" - }, - "status":{ - "shape":"RegistryRecordStatus", - "documentation":"

The resulting status of the registry record after submission.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the record was last updated.

" - } - } - }, - "SubnetId":{ - "type":"string", - "pattern":"subnet-[0-9a-zA-Z]{8,17}" - }, - "SubnetIds":{ - "type":"list", - "member":{"shape":"SubnetId"} - }, - "Subnets":{ - "type":"list", - "member":{"shape":"SubnetId"}, - "max":16, - "min":1 - }, - "SummaryConsolidationOverride":{ - "type":"structure", - "required":[ - "appendToPrompt", - "modelId" - ], - "members":{ - "appendToPrompt":{ - "shape":"Prompt", - "documentation":"

The text to append to the prompt for summary consolidation.

" - }, - "modelId":{ - "shape":"String", - "documentation":"

The model ID to use for summary consolidation.

" - } - }, - "documentation":"

Contains summary consolidation override configuration.

" - }, - "SummaryMemoryStrategyInput":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{ - "shape":"Name", - "documentation":"

The name of the summary memory strategy.

" - }, - "description":{ - "shape":"Description", - "documentation":"

The description of the summary memory strategy.

" - }, - "namespaces":{ - "shape":"NamespacesList", - "documentation":"

This is a legacy parameter, use namespaceTemplates. The namespaces associated with the summary memory strategy.

", - "deprecated":true, - "deprecatedMessage":"Use namespaceTemplates instead", - "deprecatedSince":"2026-03-02" - }, - "namespaceTemplates":{ - "shape":"NamespacesList", - "documentation":"

The namespaceTemplates associated with the summary memory strategy.

" - }, - "memoryRecordSchema":{ - "shape":"MemoryRecordSchema", - "documentation":"

Schema for metadata fields on records generated by this strategy.

" - } - }, - "documentation":"

Input for creating a summary memory strategy.

" - }, - "SummaryOverrideConfigurationInput":{ - "type":"structure", - "members":{ - "consolidation":{ - "shape":"SummaryOverrideConsolidationConfigurationInput", - "documentation":"

The consolidation configuration for a summary override.

" - } - }, - "documentation":"

Input for summary override configuration in a memory strategy.

" - }, - "SummaryOverrideConsolidationConfigurationInput":{ - "type":"structure", - "required":[ - "appendToPrompt", - "modelId" - ], - "members":{ - "appendToPrompt":{ - "shape":"Prompt", - "documentation":"

The text to append to the prompt for summary consolidation.

" - }, - "modelId":{ - "shape":"String", - "documentation":"

The model ID to use for summary consolidation.

" - } - }, - "documentation":"

Input for summary override consolidation configuration in a memory strategy.

" - }, - "SynchronizationConfiguration":{ - "type":"structure", - "members":{ - "fromUrl":{ - "shape":"FromUrlSynchronizationConfiguration", - "documentation":"

Configuration for synchronizing from a URL-based source.

" - } - }, - "documentation":"

Configuration for synchronizing registry record metadata from an external source.

" - }, - "SynchronizationType":{ - "type":"string", - "enum":["URL"] - }, - "SynchronizeGatewayTargetsRequest":{ - "type":"structure", - "required":[ - "gatewayIdentifier", - "targetIdList" - ], - "members":{ - "gatewayIdentifier":{ - "shape":"GatewayIdentifier", - "documentation":"

The gateway Identifier.

", - "location":"uri", - "locationName":"gatewayIdentifier" - }, - "targetIdList":{ - "shape":"TargetIdList", - "documentation":"

The target ID list.

" - } - } - }, - "SynchronizeGatewayTargetsResponse":{ - "type":"structure", - "members":{ - "targets":{ - "shape":"GatewayTargetList", - "documentation":"

The gateway targets for synchronization.

" - } - } - }, - "SystemManagedBlock":{ - "type":"structure", - "required":["managedBy"], - "members":{ - "managedBy":{ - "shape":"String", - "documentation":"

The identifier of the system or process that manages this rule.

" - } - }, - "documentation":"

System-managed metadata for rules created by automated processes such as A/B tests.

" - }, - "TagKey":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[a-zA-Z0-9\\s._:/=+@-]*" - }, - "TagKeyList":{ - "type":"list", - "member":{"shape":"TagKey"}, - "max":200, - "min":0 - }, - "TagResourceRequest":{ - "type":"structure", - "required":[ - "resourceArn", - "tags" - ], - "members":{ - "resourceArn":{ - "shape":"TaggableResourcesArn", - "documentation":"

The Amazon Resource Name (ARN) of the resource that you want to tag.

", - "location":"uri", - "locationName":"resourceArn" - }, - "tags":{ - "shape":"TagsMap", - "documentation":"

The tags to add to the resource. A tag is a key-value pair.

" - } - } - }, - "TagResourceResponse":{ - "type":"structure", - "members":{} - }, - "TagValue":{ - "type":"string", - "max":256, - "min":0, - "pattern":"[a-zA-Z0-9\\s._:/=+@-]*" - }, - "TaggableResourcesArn":{ - "type":"string", - "max":1011, - "min":20, - "pattern":"arn:(?:[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:([a-z-]+/[^/]+)(?:/[a-z-]+/[^/]+)*" - }, - "TagsMap":{ - "type":"map", - "key":{"shape":"TagKey"}, - "value":{"shape":"TagValue"}, - "max":50, - "min":0 - }, - "TargetConfiguration":{ - "type":"structure", - "members":{ - "mcp":{ - "shape":"McpTargetConfiguration", - "documentation":"

The Model Context Protocol (MCP) configuration for the target. This configuration defines how the gateway uses MCP to communicate with the target.

" - }, - "http":{ - "shape":"HttpTargetConfiguration", - "documentation":"

The HTTP target configuration. Use this to route gateway requests to an HTTP-based endpoint such as an AgentCore Runtime.

" - }, - "inference":{ - "shape":"InferenceTargetConfiguration", - "documentation":"

The inference configuration for the target. This configuration routes requests to a large language model (LLM) provider.

" - } - }, - "documentation":"

The configuration for a gateway target. This structure defines how the gateway connects to and interacts with the target endpoint.

", - "union":true - }, - "TargetDescription":{ - "type":"string", - "max":200, - "min":1, - "sensitive":true - }, - "TargetId":{ - "type":"string", - "pattern":"[0-9a-zA-Z]{10}" - }, - "TargetIdList":{ - "type":"list", - "member":{"shape":"TargetId"}, - "max":1, - "min":1 - }, - "TargetMaxResults":{ - "type":"integer", - "box":true, - "max":1000, - "min":1 - }, - "TargetName":{ - "type":"string", - "pattern":"([0-9a-zA-Z][-]?){1,100}", - "sensitive":true - }, - "TargetNextToken":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"\\S*" - }, - "TargetProtocolType":{ - "type":"string", - "enum":[ - "MCP", - "HTTP" - ] - }, - "TargetResourcePriority":{ - "type":"integer", - "box":true, - "max":1000, - "min":0 - }, - "TargetStatus":{ - "type":"string", - "enum":[ - "CREATING", - "UPDATING", - "UPDATE_UNSUCCESSFUL", - "DELETING", - "READY", - "FAILED", - "SYNCHRONIZING", - "SYNCHRONIZE_UNSUCCESSFUL", - "CREATE_PENDING_AUTH", - "UPDATE_PENDING_AUTH", - "SYNCHRONIZE_PENDING_AUTH" - ] - }, - "TargetSummaries":{ - "type":"list", - "member":{"shape":"TargetSummary"} - }, - "TargetSummary":{ - "type":"structure", - "required":[ - "targetId", - "name", - "status", - "createdAt", - "updatedAt" - ], - "members":{ - "targetId":{ - "shape":"TargetId", - "documentation":"

The unique identifier of the target.

" - }, - "name":{ - "shape":"TargetName", - "documentation":"

The name of the target.

" - }, - "status":{ - "shape":"TargetStatus", - "documentation":"

The current status of the target.

" - }, - "description":{ - "shape":"TargetDescription", - "documentation":"

The description of the target.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the target was created.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the target was last updated.

" - }, - "resourcePriority":{ - "shape":"TargetResourcePriority", - "documentation":"

Priority for resolving resource URI conflicts across targets. Lower values take precedence. Defaults to 1000 when not set.

" - }, - "lastSynchronizedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the target was last synchronized.

" - }, - "authorizationData":{"shape":"AuthorizationData"}, - "targetType":{ - "shape":"TargetType", - "documentation":"

The type of the target.

" - }, - "listingMode":{ - "shape":"ListingMode", - "documentation":"

The listing mode for the target. MCP resources for DEFAULT targets are cached at the control plane for faster access. MCP resources for DYNAMIC targets are retrieved dynamically when listing tools.

" - } - }, - "documentation":"

Contains summary information about a gateway target. A target represents an endpoint that the gateway can connect to.

" - }, - "TargetTrafficSplitEntries":{ - "type":"list", - "member":{"shape":"TargetTrafficSplitEntry"}, - "max":2, - "min":2 - }, - "TargetTrafficSplitEntry":{ - "type":"structure", - "required":[ - "name", - "weight", - "targetName" - ], - "members":{ - "name":{ - "shape":"TargetTrafficSplitEntryNameString", - "documentation":"

The name of this traffic split variant.

" - }, - "weight":{ - "shape":"TargetTrafficSplitEntryWeightInteger", - "documentation":"

The percentage of traffic to route to this variant.

" - }, - "targetName":{ - "shape":"TargetName", - "documentation":"

The name of the target to route traffic to.

" - }, - "description":{ - "shape":"TargetTrafficSplitEntryDescriptionString", - "documentation":"

The description of this traffic split variant.

" - }, - "metadata":{ - "shape":"TrafficSplitMetadataMap", - "documentation":"

Key-value metadata associated with this traffic split variant.

" - } - }, - "documentation":"

An entry in a target traffic split configuration.

" - }, - "TargetTrafficSplitEntryDescriptionString":{ - "type":"string", - "max":200, - "min":1 - }, - "TargetTrafficSplitEntryNameString":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[a-zA-Z0-9]([a-zA-Z0-9-]{0,62}[a-zA-Z0-9])?" - }, - "TargetTrafficSplitEntryWeightInteger":{ - "type":"integer", - "box":true, - "max":99, - "min":1 - }, - "TargetType":{ - "type":"string", - "enum":[ - "OPEN_API_SCHEMA", - "SMITHY_MODEL", - "MCP_SERVER", - "LAMBDA", - "API_GATEWAY", - "CONNECTOR", - "AGENTCORE_RUNTIME", - "PASSTHROUGH", - "PROVIDER" - ] - }, - "Temperature":{ - "type":"float", - "box":true, - "max":2.0, - "min":0.0 - }, - "TenantIdType":{ - "type":"string", - "max":2048, - "min":1 - }, - "ThrottledException":{ - "type":"structure", - "members":{ - "message":{"shape":"String"} - }, - "documentation":"

API rate limit has been exceeded.

", - "error":{ - "httpStatusCode":429, - "senderFault":true - }, - "exception":true, - "retryable":{"throttling":false} - }, - "ThrottlingException":{ - "type":"structure", - "members":{ - "message":{"shape":"NonBlankString"} - }, - "documentation":"

This exception is thrown when the number of requests exceeds the limit

", - "error":{ - "httpStatusCode":429, - "senderFault":true - }, - "exception":true - }, - "TimeBasedTrigger":{ - "type":"structure", - "members":{ - "idleSessionTimeout":{ - "shape":"Integer", - "documentation":"

Idle session timeout (seconds) that triggers memory processing.

" - } - }, - "documentation":"

Trigger configuration based on time.

" - }, - "TimeBasedTriggerInput":{ - "type":"structure", - "members":{ - "idleSessionTimeout":{ - "shape":"TimeBasedTriggerInputIdleSessionTimeoutInteger", - "documentation":"

Idle session timeout (seconds) that triggers memory processing.

" - } - }, - "documentation":"

Trigger configuration based on time.

" - }, - "TimeBasedTriggerInputIdleSessionTimeoutInteger":{ - "type":"integer", - "box":true, - "max":3000, - "min":10 - }, - "Timestamp":{"type":"timestamp"}, - "TokenAuthMethod":{ - "type":"string", - "pattern":"(client_secret_post|client_secret_basic)" - }, - "TokenBasedTrigger":{ - "type":"structure", - "members":{ - "tokenCount":{ - "shape":"Integer", - "documentation":"

Number of tokens that trigger memory processing.

" - } - }, - "documentation":"

Trigger configuration based on tokens.

" - }, - "TokenBasedTriggerInput":{ - "type":"structure", - "members":{ - "tokenCount":{ - "shape":"TokenBasedTriggerInputTokenCountInteger", - "documentation":"

Number of tokens that trigger memory processing.

" - } - }, - "documentation":"

Trigger configuration based on tokens.

" - }, - "TokenBasedTriggerInputTokenCountInteger":{ - "type":"integer", - "box":true, - "max":500000, - "min":100 - }, - "TokenEndpointAuthMethodsType":{ - "type":"list", - "member":{"shape":"TokenAuthMethod"}, - "max":2, - "min":1 - }, - "TokenEndpointType":{"type":"string"}, - "TokenExchangeGrantTypeConfigType":{ - "type":"structure", - "required":["actorTokenContent"], - "members":{ - "actorTokenContent":{ - "shape":"ActorTokenContentType", - "documentation":"

The content type for the actor token in the token exchange.

" - }, - "actorTokenScopes":{ - "shape":"ScopesListType", - "documentation":"

The scopes for the actor token. Only valid when actorTokenContent is M2M.

" - } - }, - "documentation":"

Configuration for RFC 8693 token exchange.

" - }, - "TokenVaultIdType":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[a-zA-Z0-9\\-_]+" - }, - "ToolDefinition":{ - "type":"structure", - "required":[ - "name", - "description", - "inputSchema" - ], - "members":{ - "name":{ - "shape":"String", - "documentation":"

The name of the tool. This name identifies the tool in the Model Context Protocol.

" - }, - "description":{ - "shape":"String", - "documentation":"

The description of the tool. This description provides information about the purpose and usage of the tool.

" - }, - "inputSchema":{ - "shape":"SchemaDefinition", - "documentation":"

The input schema for the tool. This schema defines the structure of the input that the tool accepts.

" - }, - "outputSchema":{ - "shape":"SchemaDefinition", - "documentation":"

The output schema for the tool. This schema defines the structure of the output that the tool produces.

" - } - }, - "documentation":"

A tool definition for a gateway target. This structure defines a tool that the target exposes through the Model Context Protocol.

", - "sensitive":true - }, - "ToolDefinitions":{ - "type":"list", - "member":{"shape":"ToolDefinition"} - }, - "ToolSchema":{ - "type":"structure", - "members":{ - "s3":{ - "shape":"S3Configuration", - "documentation":"

The Amazon S3 location of the tool schema. This location contains the schema definition file.

" - }, - "inlinePayload":{ - "shape":"ToolDefinitions", - "documentation":"

The inline payload of the tool schema. This payload contains the schema definition directly in the request.

" - } - }, - "documentation":"

A tool schema for a gateway target. This structure defines the schema for a tool that the target exposes through the Model Context Protocol.

", - "union":true - }, - "ToolSecretArn":{ - "type":"string", - "pattern":"arn:aws(-[a-z-]+)?:secretsmanager:[a-z0-9-]+:[0-9]{12}:secret:[a-zA-Z0-9/_+=.@-]+" - }, - "ToolsDefinition":{ - "type":"structure", - "members":{ - "protocolVersion":{ - "shape":"SchemaVersion", - "documentation":"

The protocol version of the tools definition based on the MCP protocol specification. If not specified, the version is auto-detected from the content.

" - }, - "inlineContent":{ - "shape":"InlineContent", - "documentation":"

The JSON content containing the MCP tools definition, conforming to the MCP protocol specification.

" - } - }, - "documentation":"

The tools definition for an MCP descriptor. Contains the protocol version and inline content describing the available tools.

" - }, - "ToolsFileSystemConfiguration":{ - "type":"structure", - "members":{ - "s3FilesConfiguration":{ - "shape":"S3FilesConfiguration", - "documentation":"

The configuration for mounting your own Amazon Simple Storage Service (Amazon S3) Files access point into the session.

" - }, - "efsConfiguration":{ - "shape":"EfsConfiguration", - "documentation":"

The configuration for mounting your own Amazon Elastic File System (Amazon EFS) access point into the session.

" - } - }, - "documentation":"

Specifies a file system to mount into the session by providing exactly one of the following:

  • s3FilesConfiguration - Mounts an Amazon Simple Storage Service (Amazon S3) Files access point.

  • efsConfiguration - Mounts an Amazon Elastic File System (Amazon EFS) access point.

", - "union":true - }, - "ToolsFileSystemConfigurations":{ - "type":"list", - "member":{"shape":"ToolsFileSystemConfiguration"}, - "documentation":"

The file system configurations to mount into the session. Each configuration maps an access point to a path inside the session. You can specify up to 4 configurations. The maximum is 2 Amazon Simple Storage Service (Amazon S3) Files access points and 2 Amazon Elastic File System (Amazon EFS) access points.

", - "max":10, - "min":0 - }, - "TopK":{ - "type":"integer", - "box":true, - "max":500, - "min":0 - }, - "TopP":{ - "type":"float", - "box":true, - "max":1.0, - "min":0.0 - }, - "TrafficSplitEntries":{ - "type":"list", - "member":{"shape":"TrafficSplitEntry"}, - "max":2, - "min":2 - }, - "TrafficSplitEntry":{ - "type":"structure", - "required":[ - "name", - "weight", - "configurationBundle" - ], - "members":{ - "name":{ - "shape":"TrafficSplitEntryNameString", - "documentation":"

The name of this traffic split variant.

" - }, - "weight":{ - "shape":"TrafficSplitEntryWeightInteger", - "documentation":"

The percentage of traffic to route to this variant. Weights across all entries must sum to 100.

" - }, - "configurationBundle":{ - "shape":"ConfigurationBundleReference", - "documentation":"

The configuration bundle reference for this variant.

" - }, - "description":{ - "shape":"TrafficSplitEntryDescriptionString", - "documentation":"

The description of this traffic split variant.

" - }, - "metadata":{ - "shape":"TrafficSplitMetadataMap", - "documentation":"

Key-value metadata associated with this traffic split variant.

" - } - }, - "documentation":"

An entry in a traffic split configuration, defining a named variant with a weight and configuration bundle reference.

" - }, - "TrafficSplitEntryDescriptionString":{ - "type":"string", - "max":200, - "min":1 - }, - "TrafficSplitEntryNameString":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[a-zA-Z0-9]([a-zA-Z0-9-]{0,62}[a-zA-Z0-9])?" - }, - "TrafficSplitEntryWeightInteger":{ - "type":"integer", - "box":true, - "max":99, - "min":1 - }, - "TrafficSplitMetadataKey":{ - "type":"string", - "max":128, - "min":1 - }, - "TrafficSplitMetadataMap":{ - "type":"map", - "key":{"shape":"TrafficSplitMetadataKey"}, - "value":{"shape":"TrafficSplitMetadataValue"}, - "max":25, - "min":0 - }, - "TrafficSplitMetadataValue":{ - "type":"string", - "max":256, - "min":1 - }, - "TriggerCondition":{ - "type":"structure", - "members":{ - "messageBasedTrigger":{ - "shape":"MessageBasedTrigger", - "documentation":"

Message based trigger configuration.

" - }, - "tokenBasedTrigger":{ - "shape":"TokenBasedTrigger", - "documentation":"

Token based trigger configuration.

" - }, - "timeBasedTrigger":{ - "shape":"TimeBasedTrigger", - "documentation":"

Time based trigger configuration.

" - } - }, - "documentation":"

Condition that triggers memory processing.

", - "union":true - }, - "TriggerConditionInput":{ - "type":"structure", - "members":{ - "messageBasedTrigger":{ - "shape":"MessageBasedTriggerInput", - "documentation":"

Message based trigger configuration.

" - }, - "tokenBasedTrigger":{ - "shape":"TokenBasedTriggerInput", - "documentation":"

Token based trigger configuration.

" - }, - "timeBasedTrigger":{ - "shape":"TimeBasedTriggerInput", - "documentation":"

Time based trigger configuration.

" - } - }, - "documentation":"

Condition that triggers memory processing.

", - "union":true - }, - "TriggerConditionInputList":{ - "type":"list", - "member":{"shape":"TriggerConditionInput"}, - "min":1 - }, - "TriggerConditionsList":{ - "type":"list", - "member":{"shape":"TriggerCondition"}, - "min":1 - }, - "UnauthorizedException":{ - "type":"structure", - "members":{ - "message":{"shape":"NonBlankString"} - }, - "documentation":"

This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

", - "error":{ - "httpStatusCode":401, - "senderFault":true - }, - "exception":true - }, - "Unit":{ - "type":"structure", - "members":{} - }, - "UntagResourceRequest":{ - "type":"structure", - "required":[ - "resourceArn", - "tagKeys" - ], - "members":{ - "resourceArn":{ - "shape":"TaggableResourcesArn", - "documentation":"

The Amazon Resource Name (ARN) of the resource that you want to untag.

", - "location":"uri", - "locationName":"resourceArn" - }, - "tagKeys":{ - "shape":"TagKeyList", - "documentation":"

The tag keys of the tags to remove from the resource.

", - "location":"querystring", - "locationName":"tagKeys" - } - } - }, - "UntagResourceResponse":{ - "type":"structure", - "members":{} - }, - "UpdateAgentRuntimeEndpointRequest":{ - "type":"structure", - "required":[ - "agentRuntimeId", - "endpointName" - ], - "members":{ - "agentRuntimeId":{ - "shape":"AgentRuntimeId", - "documentation":"

The unique identifier of the AgentCore Runtime associated with the endpoint.

", - "location":"uri", - "locationName":"agentRuntimeId" - }, - "endpointName":{ - "shape":"EndpointName", - "documentation":"

The name of the AgentCore Runtime endpoint to update.

", - "location":"uri", - "locationName":"endpointName" - }, - "agentRuntimeVersion":{ - "shape":"AgentRuntimeVersion", - "documentation":"

The updated version of the AgentCore Runtime for the endpoint.

" - }, - "description":{ - "shape":"AgentEndpointDescription", - "documentation":"

The updated description of the AgentCore Runtime endpoint.

" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure idempotency of the request.

", - "idempotencyToken":true - } - } - }, - "UpdateAgentRuntimeEndpointResponse":{ - "type":"structure", - "required":[ - "agentRuntimeEndpointArn", - "agentRuntimeArn", - "status", - "createdAt", - "lastUpdatedAt" - ], - "members":{ - "liveVersion":{ - "shape":"AgentRuntimeVersion", - "documentation":"

The currently deployed version of the AgentCore Runtime on the endpoint.

" - }, - "targetVersion":{ - "shape":"AgentRuntimeVersion", - "documentation":"

The target version of the AgentCore Runtime for the endpoint.

" - }, - "agentRuntimeEndpointArn":{ - "shape":"AgentRuntimeEndpointArn", - "documentation":"

The Amazon Resource Name (ARN) of the AgentCore Runtime endpoint.

" - }, - "agentRuntimeArn":{ - "shape":"AgentRuntimeArn", - "documentation":"

The Amazon Resource Name (ARN) of the AgentCore Runtime.

" - }, - "status":{ - "shape":"AgentRuntimeEndpointStatus", - "documentation":"

The current status of the updated AgentCore Runtime endpoint.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the AgentCore Runtime endpoint was created.

" - }, - "lastUpdatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the AgentCore Runtime endpoint was last updated.

" - } - } - }, - "UpdateAgentRuntimeRequest":{ - "type":"structure", - "required":[ - "agentRuntimeId", - "agentRuntimeArtifact", - "roleArn", - "networkConfiguration" - ], - "members":{ - "agentRuntimeId":{ - "shape":"AgentRuntimeId", - "documentation":"

The unique identifier of the AgentCore Runtime to update.

", - "location":"uri", - "locationName":"agentRuntimeId" - }, - "agentRuntimeArtifact":{ - "shape":"AgentRuntimeArtifact", - "documentation":"

The updated artifact of the AgentCore Runtime.

" - }, - "roleArn":{ - "shape":"RoleArn", - "documentation":"

The updated IAM role ARN that provides permissions for the AgentCore Runtime.

" - }, - "networkConfiguration":{ - "shape":"NetworkConfiguration", - "documentation":"

The updated network configuration for the AgentCore Runtime.

" - }, - "description":{ - "shape":"Description", - "documentation":"

The updated description of the AgentCore Runtime.

" - }, - "authorizerConfiguration":{ - "shape":"AuthorizerConfiguration", - "documentation":"

The updated authorizer configuration for the AgentCore Runtime.

" - }, - "requestHeaderConfiguration":{ - "shape":"RequestHeaderConfiguration", - "documentation":"

The updated configuration for HTTP request headers that will be passed through to the runtime.

" - }, - "protocolConfiguration":{"shape":"ProtocolConfiguration"}, - "lifecycleConfiguration":{ - "shape":"LifecycleConfiguration", - "documentation":"

The updated life cycle configuration for the AgentCore Runtime.

" - }, - "metadataConfiguration":{ - "shape":"RuntimeMetadataConfiguration", - "documentation":"

The updated configuration for microVM Metadata Service (MMDS) settings for the AgentCore Runtime.

" - }, - "environmentVariables":{ - "shape":"EnvironmentVariablesMap", - "documentation":"

Updated environment variables to set in the AgentCore Runtime environment.

" - }, - "filesystemConfigurations":{ - "shape":"FilesystemConfigurations", - "documentation":"

The updated filesystem configurations to mount into the AgentCore Runtime.

" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure idempotency of the request.

", - "idempotencyToken":true - } - } - }, - "UpdateAgentRuntimeResponse":{ - "type":"structure", - "required":[ - "agentRuntimeArn", - "agentRuntimeId", - "agentRuntimeVersion", - "createdAt", - "lastUpdatedAt", - "status" - ], - "members":{ - "agentRuntimeArn":{ - "shape":"AgentRuntimeArn", - "documentation":"

The Amazon Resource Name (ARN) of the updated AgentCore Runtime.

" - }, - "agentRuntimeId":{ - "shape":"AgentRuntimeId", - "documentation":"

The unique identifier of the updated AgentCore Runtime.

" - }, - "workloadIdentityDetails":{ - "shape":"WorkloadIdentityDetails", - "documentation":"

The workload identity details for the updated AgentCore Runtime.

" - }, - "agentRuntimeVersion":{ - "shape":"AgentRuntimeVersion", - "documentation":"

The version of the updated AgentCore Runtime.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the AgentCore Runtime was created.

" - }, - "lastUpdatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the AgentCore Runtime was last updated.

" - }, - "status":{ - "shape":"AgentRuntimeStatus", - "documentation":"

The current status of the updated AgentCore Runtime.

" - } - } - }, - "UpdateApiKeyCredentialProviderRequest":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{ - "shape":"CredentialProviderName", - "documentation":"

The name of the API key credential provider to update.

" - }, - "apiKey":{ - "shape":"DefaultApiKeyType", - "documentation":"

The new API key to use for authentication. This value replaces the existing API key and is encrypted and stored securely.

" - }, - "apiKeySecretConfig":{ - "shape":"SecretReference", - "documentation":"

A reference to the Amazon Web Services Secrets Manager secret that stores the API key. This includes the secret ID and the JSON key used to extract the API key value from the secret. Required when apiKeySecretSource is set to EXTERNAL.

" - }, - "apiKeySecretSource":{ - "shape":"SecretSourceType", - "documentation":"

The source type of the API key secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.

" - } - } - }, - "UpdateApiKeyCredentialProviderResponse":{ - "type":"structure", - "required":[ - "apiKeySecretArn", - "name", - "credentialProviderArn", - "createdTime", - "lastUpdatedTime" - ], - "members":{ - "apiKeySecretArn":{ - "shape":"Secret", - "documentation":"

The Amazon Resource Name (ARN) of the API key secret in Amazon Web Services Secrets Manager.

" - }, - "apiKeySecretJsonKey":{ - "shape":"SecretJsonKeyType", - "documentation":"

The JSON key used to extract the API key value from the Amazon Web Services Secrets Manager secret.

" - }, - "apiKeySecretSource":{ - "shape":"SecretSourceType", - "documentation":"

The source type of the API key secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager.

" - }, - "name":{ - "shape":"CredentialProviderName", - "documentation":"

The name of the API key credential provider.

" - }, - "credentialProviderArn":{ - "shape":"ApiKeyCredentialProviderArnType", - "documentation":"

The Amazon Resource Name (ARN) of the API key credential provider.

" - }, - "createdTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the API key credential provider was created.

" - }, - "lastUpdatedTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the API key credential provider was last updated.

" - } - } - }, - "UpdateConfigurationBundleRequest":{ - "type":"structure", - "required":["bundleId"], - "members":{ - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "idempotencyToken":true - }, - "bundleId":{ - "shape":"ConfigurationBundleId", - "documentation":"

The unique identifier of the configuration bundle to update.

", - "location":"uri", - "locationName":"bundleId" - }, - "bundleName":{ - "shape":"ConfigurationBundleName", - "documentation":"

The updated name for the configuration bundle.

" - }, - "description":{ - "shape":"ConfigurationBundleDescription", - "documentation":"

The updated description for the configuration bundle.

" - }, - "components":{ - "shape":"ComponentConfigurationMap", - "documentation":"

The updated component configurations. Creates a new version of the bundle.

" - }, - "parentVersionIds":{ - "shape":"ConfigurationBundleVersionList", - "documentation":"

A list of parent version identifiers for lineage tracking. Regular commits have a single parent. Merge commits have two parents: the target branch parent and the source branch parent. If the branch already exists, the first parent must be the latest version on that branch.

" - }, - "branchName":{ - "shape":"BranchName", - "documentation":"

The branch name for this version. If not specified, inherits the parent's branch or defaults to mainline.

" - }, - "commitMessage":{ - "shape":"UpdateConfigurationBundleRequestCommitMessageString", - "documentation":"

A commit message describing the changes in this version.

" - }, - "createdBy":{ - "shape":"VersionCreatedBySource", - "documentation":"

The source that created this version, including the source name and optional ARN.

" - }, - "kmsKeyArn":{ - "shape":"KmsKeyArn", - "documentation":"

Optional KMS key ARN for encrypting component configurations. If provided, components will be encrypted with this key. If the bundle already has a KMS key, this rotates to the new key.

" - } - } - }, - "UpdateConfigurationBundleRequestCommitMessageString":{ - "type":"string", - "max":500, - "min":1 - }, - "UpdateConfigurationBundleResponse":{ - "type":"structure", - "required":[ - "bundleArn", - "bundleId", - "versionId", - "updatedAt" - ], - "members":{ - "bundleArn":{ - "shape":"ConfigurationBundleArn", - "documentation":"

The Amazon Resource Name (ARN) of the updated configuration bundle.

" - }, - "bundleId":{ - "shape":"ConfigurationBundleId", - "documentation":"

The unique identifier of the updated configuration bundle.

" - }, - "versionId":{ - "shape":"ConfigurationBundleVersion", - "documentation":"

The new version identifier created by this update.

" - }, - "updatedAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the configuration bundle was updated.

" - } - } - }, - "UpdateDatasetExamplesRequest":{ - "type":"structure", - "required":[ - "datasetId", - "examples" - ], - "members":{ - "datasetId":{ - "shape":"DatasetId", - "documentation":"

The unique identifier of the dataset.

", - "location":"uri", - "locationName":"datasetId" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "idempotencyToken":true - }, - "examples":{ - "shape":"UpdateDatasetExamplesRequestExamplesList", - "documentation":"

Examples to update. Each element is a JSON object containing a required exampleId field identifying the existing example, plus the replacement fields. Maximum 1000 examples per call.

" - } - } - }, - "UpdateDatasetExamplesRequestExamplesList":{ - "type":"list", - "member":{"shape":"SensitiveJson"}, - "documentation":"

A list of dataset examples. Each element is a free-form JSON document whose structure is defined by the dataset's schema type.

", - "max":1000, - "min":1 - }, - "UpdateDatasetExamplesResponse":{ - "type":"structure", - "required":[ - "datasetArn", - "datasetId", - "status", - "updatedCount", - "updatedAt" - ], - "members":{ - "datasetArn":{ - "shape":"DatasetArn", - "documentation":"

The Amazon Resource Name (ARN) of the dataset.

" - }, - "datasetId":{ - "shape":"DatasetId", - "documentation":"

The unique identifier of the dataset.

" - }, - "status":{ - "shape":"DatasetStatus", - "documentation":"

The current status of the dataset.

" - }, - "updatedCount":{ - "shape":"Long", - "documentation":"

The number of examples updated.

" - }, - "updatedAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the examples were updated.

" - } - } - }, - "UpdateDatasetRequest":{ - "type":"structure", - "required":["datasetId"], - "members":{ - "datasetId":{ - "shape":"DatasetId", - "documentation":"

The unique identifier of the dataset to update.

", - "location":"uri", - "locationName":"datasetId" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "idempotencyToken":true - }, - "description":{ - "shape":"UpdateDatasetRequestDescriptionString", - "documentation":"

The updated description for the dataset.

" - } - } - }, - "UpdateDatasetRequestDescriptionString":{ - "type":"string", - "max":200, - "min":0 - }, - "UpdateDatasetResponse":{ - "type":"structure", - "required":[ - "datasetArn", - "datasetId", - "updatedAt" - ], - "members":{ - "datasetArn":{ - "shape":"DatasetArn", - "documentation":"

The Amazon Resource Name (ARN) of the updated dataset.

" - }, - "datasetId":{ - "shape":"DatasetId", - "documentation":"

The unique identifier of the updated dataset.

" - }, - "updatedAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the dataset was updated.

" - } - } - }, - "UpdateEvaluatorRequest":{ - "type":"structure", - "required":["evaluatorId"], - "members":{ - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "idempotencyToken":true - }, - "evaluatorId":{ - "shape":"EvaluatorId", - "documentation":"

The unique identifier of the evaluator to update.

", - "location":"uri", - "locationName":"evaluatorId" - }, - "description":{ - "shape":"EvaluatorDescription", - "documentation":"

The updated description of the evaluator.

" - }, - "evaluatorConfig":{ - "shape":"EvaluatorConfig", - "documentation":"

The updated configuration for the evaluator. Specify either LLM-as-a-Judge settings with instructions, rating scale, and model configuration, or code-based settings with a customer-managed Lambda function.

" - }, - "level":{ - "shape":"EvaluatorLevel", - "documentation":"

The updated evaluation level (TOOL_CALL, TRACE, or SESSION) that determines the scope of evaluation.

" - }, - "kmsKeyArn":{ - "shape":"KmsKeyArn", - "documentation":"

The Amazon Resource Name (ARN) of a customer managed KMS key to use for encrypting sensitive evaluator data. Specify a new key ARN to rotate the encryption key, or specify a key ARN to add encryption to an evaluator that was previously created without one. When you rotate to a new key, the service decrypts the existing data with the old key and re-encrypts it with the new key. Only symmetric encryption KMS keys are supported. For more information, see Encryption at rest for AgentCore Evaluations.

" - } - } - }, - "UpdateEvaluatorResponse":{ - "type":"structure", - "required":[ - "evaluatorArn", - "evaluatorId", - "updatedAt", - "status" - ], - "members":{ - "evaluatorArn":{ - "shape":"EvaluatorArn", - "documentation":"

The Amazon Resource Name (ARN) of the updated evaluator.

" - }, - "evaluatorId":{ - "shape":"EvaluatorId", - "documentation":"

The unique identifier of the updated evaluator.

" - }, - "updatedAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the evaluator was last updated.

" - }, - "status":{ - "shape":"EvaluatorStatus", - "documentation":"

The status of the evaluator update operation.

" - } - } - }, - "UpdateGatewayRequest":{ - "type":"structure", - "required":[ - "gatewayIdentifier", - "name", - "roleArn", - "authorizerType" - ], - "members":{ - "gatewayIdentifier":{ - "shape":"GatewayIdentifier", - "documentation":"

The identifier of the gateway to update.

", - "location":"uri", - "locationName":"gatewayIdentifier" - }, - "name":{ - "shape":"GatewayName", - "documentation":"

The name of the gateway. This name must be the same as the one when the gateway was created.

" - }, - "description":{ - "shape":"GatewayDescription", - "documentation":"

The updated description for the gateway.

" - }, - "roleArn":{ - "shape":"RoleArn", - "documentation":"

The updated IAM role ARN that provides permissions for the gateway.

" - }, - "protocolType":{ - "shape":"GatewayProtocolType", - "documentation":"

The updated protocol type for the gateway.

" - }, - "protocolConfiguration":{"shape":"GatewayProtocolConfiguration"}, - "authorizerType":{ - "shape":"AuthorizerType", - "documentation":"

The updated authorizer type for the gateway.

" - }, - "authorizerConfiguration":{ - "shape":"AuthorizerConfiguration", - "documentation":"

The updated authorizer configuration for the gateway.

" - }, - "kmsKeyArn":{ - "shape":"KmsKeyArn", - "documentation":"

The updated ARN of the KMS key used to encrypt the gateway.

" - }, - "customTransformConfiguration":{ - "shape":"CustomTransformConfiguration", - "documentation":"

The updated custom transformation configuration for the gateway. This configuration defines how the gateway transforms requests and responses.

" - }, - "interceptorConfigurations":{ - "shape":"GatewayInterceptorConfigurations", - "documentation":"

The updated interceptor configurations for the gateway.

" - }, - "policyEngineConfiguration":{ - "shape":"GatewayPolicyEngineConfiguration", - "documentation":"

The updated policy engine configuration for the gateway. A policy engine is a collection of policies that evaluates and authorizes agent tool calls. When associated with a gateway, the policy engine intercepts all agent requests and determines whether to allow or deny each action based on the defined policies.

" - }, - "exceptionLevel":{ - "shape":"ExceptionLevel", - "documentation":"

The level of detail in error messages returned when invoking the gateway.

  • If the value is DEBUG, granular exception messages are returned to help a user debug the gateway.

  • If the value is omitted, a generic error message is returned to the end user.

" - }, - "wafConfiguration":{ - "shape":"WafConfiguration", - "documentation":"

The updated Amazon Web Services WAF configuration for the gateway.

" - } - } - }, - "UpdateGatewayResponse":{ - "type":"structure", - "required":[ - "gatewayArn", - "gatewayId", - "createdAt", - "updatedAt", - "status", - "name", - "authorizerType" - ], - "members":{ - "gatewayArn":{ - "shape":"GatewayArn", - "documentation":"

The Amazon Resource Name (ARN) of the updated gateway.

" - }, - "gatewayId":{ - "shape":"GatewayId", - "documentation":"

The unique identifier of the updated gateway.

" - }, - "gatewayUrl":{ - "shape":"GatewayUrl", - "documentation":"

An endpoint for invoking the updated gateway.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the gateway was created.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the gateway was last updated.

" - }, - "status":{ - "shape":"GatewayStatus", - "documentation":"

The current status of the updated gateway.

" - }, - "statusReasons":{ - "shape":"StatusReasons", - "documentation":"

The reasons for the current status of the updated gateway.

" - }, - "name":{ - "shape":"GatewayName", - "documentation":"

The name of the gateway.

" - }, - "description":{ - "shape":"GatewayDescription", - "documentation":"

The updated description of the gateway.

" - }, - "roleArn":{ - "shape":"RoleArn", - "documentation":"

The updated IAM role ARN that provides permissions for the gateway.

" - }, - "protocolType":{ - "shape":"GatewayProtocolType", - "documentation":"

The updated protocol type for the gateway.

" - }, - "protocolConfiguration":{"shape":"GatewayProtocolConfiguration"}, - "authorizerType":{ - "shape":"AuthorizerType", - "documentation":"

The updated authorizer type for the gateway.

" - }, - "authorizerConfiguration":{ - "shape":"AuthorizerConfiguration", - "documentation":"

The updated authorizer configuration for the gateway.

" - }, - "kmsKeyArn":{ - "shape":"KmsKeyArn", - "documentation":"

The updated ARN of the KMS key used to encrypt the gateway.

" - }, - "customTransformConfiguration":{ - "shape":"CustomTransformConfiguration", - "documentation":"

The custom transformation configuration for the gateway. This configuration defines how the gateway transforms requests and responses.

" - }, - "interceptorConfigurations":{ - "shape":"GatewayInterceptorConfigurations", - "documentation":"

The updated interceptor configurations for the gateway.

" - }, - "policyEngineConfiguration":{ - "shape":"GatewayPolicyEngineConfiguration", - "documentation":"

The updated policy engine configuration for the gateway.

" - }, - "workloadIdentityDetails":{ - "shape":"WorkloadIdentityDetails", - "documentation":"

The workload identity details for the updated gateway.

" - }, - "exceptionLevel":{ - "shape":"ExceptionLevel", - "documentation":"

The level of detail in error messages returned when invoking the gateway.

  • If the value is DEBUG, granular exception messages are returned to help a user debug the gateway.

  • If the value is omitted, a generic error message is returned to the end user.

" - }, - "webAclArn":{ - "shape":"WebAclArn", - "documentation":"

The Amazon Resource Name (ARN) of the Amazon Web Services WAF web ACL associated with the gateway.

" - }, - "wafConfiguration":{ - "shape":"WafConfiguration", - "documentation":"

The Amazon Web Services WAF configuration for the gateway.

" - } - } - }, - "UpdateGatewayRuleRequest":{ - "type":"structure", - "required":[ - "gatewayIdentifier", - "ruleId" - ], - "members":{ - "gatewayIdentifier":{ - "shape":"GatewayIdentifier", - "documentation":"

The identifier of the gateway containing the rule.

", - "location":"uri", - "locationName":"gatewayIdentifier" - }, - "ruleId":{ - "shape":"GatewayRuleId", - "documentation":"

The unique identifier of the rule to update.

", - "location":"uri", - "locationName":"ruleId" - }, - "priority":{ - "shape":"GatewayRulePriority", - "documentation":"

The updated priority of the rule.

" - }, - "conditions":{ - "shape":"Conditions", - "documentation":"

The updated conditions for the rule.

" - }, - "actions":{ - "shape":"Actions", - "documentation":"

The updated actions for the rule.

" - }, - "description":{ - "shape":"GatewayRuleDescription", - "documentation":"

The updated description of the rule.

" - } - } - }, - "UpdateGatewayRuleResponse":{ - "type":"structure", - "required":[ - "ruleId", - "gatewayArn", - "priority", - "actions", - "createdAt", - "status" - ], - "members":{ - "ruleId":{ - "shape":"GatewayRuleId", - "documentation":"

The unique identifier of the gateway rule.

" - }, - "gatewayArn":{ - "shape":"GatewayArn", - "documentation":"

The Amazon Resource Name (ARN) of the gateway that the rule belongs to.

" - }, - "priority":{ - "shape":"GatewayRulePriority", - "documentation":"

The priority of the rule. Rules are evaluated in order of priority, with lower numbers evaluated first.

" - }, - "conditions":{ - "shape":"Conditions", - "documentation":"

The conditions that must be met for the rule to apply.

" - }, - "actions":{ - "shape":"Actions", - "documentation":"

The actions to take when the rule conditions are met.

" - }, - "description":{ - "shape":"GatewayRuleDescription", - "documentation":"

The description of the gateway rule.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the rule was created.

" - }, - "status":{ - "shape":"GatewayRuleStatus", - "documentation":"

The current status of the rule.

" - }, - "system":{ - "shape":"SystemManagedBlock", - "documentation":"

System-managed metadata for rules created by automated processes.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the rule was last updated.

" - } - }, - "documentation":"

Create response excludes updatedAt (redundant on create). Get/Update responses include it via their own output structures.

" - }, - "UpdateGatewayTargetRequest":{ - "type":"structure", - "required":[ - "gatewayIdentifier", - "targetId", - "targetConfiguration" - ], - "members":{ - "gatewayIdentifier":{ - "shape":"GatewayIdentifier", - "documentation":"

The unique identifier of the gateway associated with the target.

", - "location":"uri", - "locationName":"gatewayIdentifier" - }, - "targetId":{ - "shape":"TargetId", - "documentation":"

The unique identifier of the gateway target to update.

", - "location":"uri", - "locationName":"targetId" - }, - "name":{ - "shape":"TargetName", - "documentation":"

The updated name for the gateway target.

" - }, - "description":{ - "shape":"TargetDescription", - "documentation":"

The updated description for the gateway target.

" - }, - "targetConfiguration":{"shape":"TargetConfiguration"}, - "credentialProviderConfigurations":{ - "shape":"CredentialProviderConfigurations", - "documentation":"

The updated credential provider configurations for the gateway target.

" - }, - "metadataConfiguration":{ - "shape":"MetadataConfiguration", - "documentation":"

Configuration for HTTP header and query parameter propagation to the gateway target.

" - }, - "privateEndpoint":{ - "shape":"PrivateEndpoint", - "documentation":"

The private endpoint configuration for the gateway target. Use this to connect the gateway to private resources in your VPC.

" - } - } - }, - "UpdateGatewayTargetResponse":{ - "type":"structure", - "required":[ - "gatewayArn", - "targetId", - "createdAt", - "updatedAt", - "status", - "name", - "targetConfiguration", - "credentialProviderConfigurations" - ], - "members":{ - "gatewayArn":{ - "shape":"GatewayArn", - "documentation":"

The Amazon Resource Name (ARN) of the gateway.

" - }, - "targetId":{ - "shape":"TargetId", - "documentation":"

The unique identifier of the updated gateway target.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the gateway target was created.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the gateway target was last updated.

" - }, - "status":{ - "shape":"TargetStatus", - "documentation":"

The current status of the updated gateway target.

" - }, - "statusReasons":{ - "shape":"StatusReasons", - "documentation":"

The reasons for the current status of the updated gateway target.

" - }, - "name":{ - "shape":"TargetName", - "documentation":"

The updated name of the gateway target.

" - }, - "description":{ - "shape":"TargetDescription", - "documentation":"

The updated description of the gateway target.

" - }, - "targetConfiguration":{"shape":"TargetConfiguration"}, - "credentialProviderConfigurations":{ - "shape":"CredentialProviderConfigurations", - "documentation":"

The updated credential provider configurations for the gateway target.

" - }, - "lastSynchronizedAt":{ - "shape":"DateTimestamp", - "documentation":"

The date and time at which the targets were last synchronized.

" - }, - "metadataConfiguration":{ - "shape":"MetadataConfiguration", - "documentation":"

The metadata configuration that was applied to the gateway target.

" - }, - "privateEndpoint":{ - "shape":"PrivateEndpoint", - "documentation":"

The private endpoint configuration for the gateway target.

" - }, - "privateEndpointManagedResources":{ - "shape":"PrivateEndpointManagedResources", - "documentation":"

The managed resources created by the gateway for private endpoint connectivity.

" - }, - "authorizationData":{ - "shape":"AuthorizationData", - "documentation":"

OAuth2 authorization data for the updated gateway target. This data is returned when a target is configured with a credential provider with authorization code grant type and requires user federation.

" - }, - "protocolType":{ - "shape":"TargetProtocolType", - "documentation":"

The protocol type of the updated gateway target.

" - } - } - }, - "UpdateHarnessEndpointRequest":{ - "type":"structure", - "required":[ - "harnessId", - "endpointName" - ], - "members":{ - "harnessId":{ - "shape":"HarnessId", - "documentation":"

The ID of the harness that the endpoint belongs to.

", - "location":"uri", - "locationName":"harnessId" - }, - "endpointName":{ - "shape":"HarnessEndpointName", - "documentation":"

The name of the endpoint to update.

", - "location":"uri", - "locationName":"endpointName" - }, - "targetVersion":{ - "shape":"HarnessVersion", - "documentation":"

The harness version that the endpoint points to. If not specified, the existing value is retained.

" - }, - "description":{ - "shape":"HarnessEndpointDescription", - "documentation":"

A description of the endpoint. If not specified, the existing value is retained.

" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure idempotency of the request.

", - "idempotencyToken":true - } - } - }, - "UpdateHarnessEndpointResponse":{ - "type":"structure", - "required":["endpoint"], - "members":{ - "endpoint":{ - "shape":"HarnessEndpoint", - "documentation":"

The updated endpoint.

" - } - } - }, - "UpdateHarnessRequest":{ - "type":"structure", - "required":["harnessId"], - "members":{ - "harnessId":{ - "shape":"HarnessId", - "documentation":"

The ID of the harness to update.

", - "location":"uri", - "locationName":"harnessId" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure idempotency of the request.

", - "idempotencyToken":true - }, - "executionRoleArn":{ - "shape":"RoleArn", - "documentation":"

The ARN of the IAM role that the harness assumes when running. If not specified, the existing value is retained.

" - }, - "environment":{ - "shape":"HarnessEnvironmentProviderRequest", - "documentation":"

The compute environment configuration for the harness. If not specified, the existing value is retained.

" - }, - "environmentArtifact":{ - "shape":"UpdatedHarnessEnvironmentArtifact", - "documentation":"

The environment artifact for the harness. Use the optionalValue wrapper to set a new value, or set it to null to clear the existing configuration.

" - }, - "environmentVariables":{ - "shape":"EnvironmentVariablesMap", - "documentation":"

Environment variables to set in the harness runtime environment. If specified, this replaces all existing environment variables. If not specified, the existing value is retained.

" - }, - "authorizerConfiguration":{"shape":"UpdatedAuthorizerConfiguration"}, - "model":{ - "shape":"HarnessModelConfiguration", - "documentation":"

The model configuration for the harness. If not specified, the existing value is retained.

" - }, - "systemPrompt":{ - "shape":"HarnessSystemPrompt", - "documentation":"

The system prompt that defines the agent's behavior. If not specified, the existing value is retained.

" - }, - "tools":{ - "shape":"HarnessTools", - "documentation":"

The tools available to the agent. If specified, this replaces all existing tools. If not specified, the existing value is retained.

" - }, - "skills":{ - "shape":"HarnessSkills", - "documentation":"

The skills available to the agent. If specified, this replaces all existing skills. If not specified, the existing value is retained.

" - }, - "allowedTools":{ - "shape":"HarnessAllowedTools", - "documentation":"

The tools that the agent is allowed to use. If specified, this replaces all existing allowed tools. If not specified, the existing value is retained.

" - }, - "memory":{ - "shape":"UpdatedHarnessMemoryConfiguration", - "documentation":"

The AgentCore Memory configuration. Use the optionalValue wrapper to set a new value, or set it to null to clear the existing configuration.

" - }, - "truncation":{ - "shape":"HarnessTruncationConfiguration", - "documentation":"

The truncation configuration for managing conversation context. If not specified, the existing value is retained.

" - }, - "maxIterations":{ - "shape":"Integer", - "documentation":"

The maximum number of iterations the agent loop can execute per invocation. If not specified, the existing value is retained.

" - }, - "maxTokens":{ - "shape":"Integer", - "documentation":"

The maximum total number of output tokens the agent can generate across all model calls within a single invocation. If not specified, the existing value is retained.

" - }, - "timeoutSeconds":{ - "shape":"Integer", - "documentation":"

The maximum duration in seconds for the agent loop execution per invocation. If not specified, the existing value is retained.

" - } - } - }, - "UpdateHarnessResponse":{ - "type":"structure", - "required":["harness"], - "members":{ - "harness":{ - "shape":"Harness", - "documentation":"

The updated harness.

" - } - } - }, - "UpdateMemoryInput":{ - "type":"structure", - "required":["memoryId"], - "members":{ - "clientToken":{ - "shape":"UpdateMemoryInputClientTokenString", - "documentation":"

A client token is used for keeping track of idempotent requests. It can contain a session id which can be around 250 chars, combined with a unique AWS identifier.

", - "idempotencyToken":true - }, - "memoryId":{ - "shape":"MemoryId", - "documentation":"

The unique identifier of the memory to update.

", - "location":"uri", - "locationName":"memoryId" - }, - "description":{ - "shape":"Description", - "documentation":"

The updated description of the AgentCore Memory resource.

" - }, - "eventExpiryDuration":{ - "shape":"UpdateMemoryInputEventExpiryDurationInteger", - "documentation":"

The number of days after which memory events will expire, between 7 and 365 days.

" - }, - "memoryExecutionRoleArn":{ - "shape":"Arn", - "documentation":"

The ARN of the IAM role that provides permissions for the AgentCore Memory resource.

" - }, - "memoryStrategies":{ - "shape":"ModifyMemoryStrategies", - "documentation":"

The memory strategies to add, modify, or delete.

" - }, - "addIndexedKeys":{ - "shape":"IndexedKeysList", - "documentation":"

Additional metadata keys to index. Previously indexed keys cannot be removed.

" - }, - "streamDeliveryResources":{ - "shape":"StreamDeliveryResources", - "documentation":"

Configuration for streaming memory record data to external resources.

" - } - } - }, - "UpdateMemoryInputClientTokenString":{ - "type":"string", - "max":500, - "min":0 - }, - "UpdateMemoryInputEventExpiryDurationInteger":{ - "type":"integer", - "box":true, - "max":365, - "min":3 - }, - "UpdateMemoryOutput":{ - "type":"structure", - "members":{ - "memory":{ - "shape":"Memory", - "documentation":"

The updated AgentCore Memory resource details.

" - } - } - }, - "UpdateOauth2CredentialProviderRequest":{ - "type":"structure", - "required":[ - "name", - "credentialProviderVendor", - "oauth2ProviderConfigInput" - ], - "members":{ - "name":{ - "shape":"CredentialProviderName", - "documentation":"

The name of the OAuth2 credential provider to update.

" - }, - "credentialProviderVendor":{ - "shape":"CredentialProviderVendorType", - "documentation":"

The vendor of the OAuth2 credential provider.

" - }, - "oauth2ProviderConfigInput":{ - "shape":"Oauth2ProviderConfigInput", - "documentation":"

The configuration input for the OAuth2 provider.

" - } - } - }, - "UpdateOauth2CredentialProviderResponse":{ - "type":"structure", - "required":[ - "clientSecretArn", - "name", - "credentialProviderVendor", - "credentialProviderArn", - "oauth2ProviderConfigOutput", - "createdTime", - "lastUpdatedTime" - ], - "members":{ - "clientSecretArn":{ - "shape":"Secret", - "documentation":"

The Amazon Resource Name (ARN) of the client secret in Amazon Web Services Secrets Manager.

" - }, - "clientSecretJsonKey":{ - "shape":"SecretJsonKeyType", - "documentation":"

The JSON key used to extract the client secret value from the Amazon Web Services Secrets Manager secret.

" - }, - "clientSecretSource":{ - "shape":"SecretSourceType", - "documentation":"

The source type of the client secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager.

" - }, - "name":{ - "shape":"CredentialProviderName", - "documentation":"

The name of the OAuth2 credential provider.

" - }, - "credentialProviderVendor":{ - "shape":"CredentialProviderVendorType", - "documentation":"

The vendor of the OAuth2 credential provider.

" - }, - "credentialProviderArn":{ - "shape":"CredentialProviderArnType", - "documentation":"

The Amazon Resource Name (ARN) of the OAuth2 credential provider.

" - }, - "callbackUrl":{ - "shape":"String", - "documentation":"

Callback URL to register on the OAuth2 credential provider as an allowed callback URL. This URL is where the OAuth2 authorization server redirects users after they complete the authorization flow.

" - }, - "oauth2ProviderConfigOutput":{ - "shape":"Oauth2ProviderConfigOutput", - "documentation":"

The configuration output for the OAuth2 provider.

" - }, - "createdTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the OAuth2 credential provider was created.

" - }, - "lastUpdatedTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the OAuth2 credential provider was last updated.

" - }, - "status":{ - "shape":"Status", - "documentation":"

The current status of the updated OAuth2 credential provider.

" - } - } - }, - "UpdateOnlineEvaluationConfigRequest":{ - "type":"structure", - "required":["onlineEvaluationConfigId"], - "members":{ - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "idempotencyToken":true - }, - "onlineEvaluationConfigId":{ - "shape":"OnlineEvaluationConfigId", - "documentation":"

The unique identifier of the online evaluation configuration to update.

", - "location":"uri", - "locationName":"onlineEvaluationConfigId" - }, - "description":{ - "shape":"EvaluationConfigDescription", - "documentation":"

The updated description of the online evaluation configuration.

" - }, - "rule":{ - "shape":"Rule", - "documentation":"

The updated evaluation rule containing sampling configuration, filters, and session settings.

" - }, - "dataSourceConfig":{ - "shape":"DataSourceConfig", - "documentation":"

The updated data source configuration specifying CloudWatch log groups and service names to monitor.

" - }, - "evaluators":{ - "shape":"EvaluatorList", - "documentation":"

The updated list of evaluators to apply during online evaluation.

" - }, - "insights":{ - "shape":"InsightList", - "documentation":"

The updated list of insight types to run against agent sessions.

" - }, - "clusteringConfig":{ - "shape":"ClusteringConfig", - "documentation":"

The updated clustering configuration for periodic batch evaluation.

" - }, - "evaluationExecutionRoleArn":{ - "shape":"RoleArn", - "documentation":"

The updated Amazon Resource Name (ARN) of the IAM role used for evaluation execution.

" - }, - "executionStatus":{ - "shape":"OnlineEvaluationExecutionStatus", - "documentation":"

The updated execution status to enable or disable the online evaluation.

" - } - } - }, - "UpdateOnlineEvaluationConfigResponse":{ - "type":"structure", - "required":[ - "onlineEvaluationConfigArn", - "onlineEvaluationConfigId", - "updatedAt", - "status", - "executionStatus" - ], - "members":{ - "onlineEvaluationConfigArn":{ - "shape":"OnlineEvaluationConfigArn", - "documentation":"

The Amazon Resource Name (ARN) of the updated online evaluation configuration.

" - }, - "onlineEvaluationConfigId":{ - "shape":"OnlineEvaluationConfigId", - "documentation":"

The unique identifier of the updated online evaluation configuration.

" - }, - "updatedAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the online evaluation configuration was last updated.

" - }, - "status":{ - "shape":"OnlineEvaluationConfigStatus", - "documentation":"

The status of the online evaluation configuration.

" - }, - "executionStatus":{ - "shape":"OnlineEvaluationExecutionStatus", - "documentation":"

The execution status indicating whether the online evaluation is currently running.

" - }, - "failureReason":{ - "shape":"String", - "documentation":"

The reason for failure if the online evaluation configuration update or execution failed.

" - } - } - }, - "UpdatePaymentConnectorRequest":{ - "type":"structure", - "required":[ - "paymentManagerId", - "paymentConnectorId" - ], - "members":{ - "paymentManagerId":{ - "shape":"PaymentManagerId", - "documentation":"

The unique identifier of the parent payment manager.

", - "location":"uri", - "locationName":"paymentManagerId" - }, - "paymentConnectorId":{ - "shape":"PaymentConnectorId", - "documentation":"

The unique identifier of the payment connector to update.

", - "location":"uri", - "locationName":"paymentConnectorId" - }, - "description":{ - "shape":"PaymentsDescription", - "documentation":"

The updated description of the payment connector.

" - }, - "type":{ - "shape":"PaymentConnectorType", - "documentation":"

The updated type of the payment connector.

" - }, - "credentialProviderConfigurations":{ - "shape":"CredentialsProviderConfigurations", - "documentation":"

The updated credential provider configurations for the payment connector.

" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "idempotencyToken":true - } - } - }, - "UpdatePaymentConnectorResponse":{ - "type":"structure", - "required":[ - "paymentConnectorId", - "paymentManagerId", - "name", - "type", - "credentialProviderConfigurations", - "lastUpdatedAt", - "status" - ], - "members":{ - "paymentConnectorId":{ - "shape":"PaymentConnectorId", - "documentation":"

The unique identifier of the updated payment connector.

" - }, - "paymentManagerId":{ - "shape":"PaymentManagerId", - "documentation":"

The unique identifier of the parent payment manager.

" - }, - "name":{ - "shape":"PaymentConnectorName", - "documentation":"

The name of the updated payment connector.

" - }, - "type":{ - "shape":"PaymentConnectorType", - "documentation":"

The type of the updated payment connector.

" - }, - "credentialProviderConfigurations":{ - "shape":"CredentialsProviderConfigurations", - "documentation":"

The credential provider configurations for the updated payment connector.

" - }, - "lastUpdatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the payment connector was last updated.

" - }, - "status":{ - "shape":"PaymentConnectorStatus", - "documentation":"

The current status of the updated payment connector. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.

" - } - } - }, - "UpdatePaymentCredentialProviderRequest":{ - "type":"structure", - "required":[ - "name", - "credentialProviderVendor", - "providerConfigurationInput" - ], - "members":{ - "name":{ - "shape":"CredentialProviderName", - "documentation":"

The name of the payment credential provider to update.

" - }, - "credentialProviderVendor":{ - "shape":"PaymentCredentialProviderVendorType", - "documentation":"

The vendor type for the payment credential provider (e.g., CoinbaseCDP, StripePrivy).

" - }, - "providerConfigurationInput":{ - "shape":"PaymentProviderConfigurationInput", - "documentation":"

Configuration specific to the vendor, including API credentials.

" - } - } - }, - "UpdatePaymentCredentialProviderResponse":{ - "type":"structure", - "required":[ - "name", - "credentialProviderVendor", - "credentialProviderArn", - "providerConfigurationOutput", - "createdTime", - "lastUpdatedTime" - ], - "members":{ - "name":{ - "shape":"CredentialProviderName", - "documentation":"

The name of the updated payment credential provider.

" - }, - "credentialProviderVendor":{ - "shape":"PaymentCredentialProviderVendorType", - "documentation":"

The vendor type for the updated payment credential provider.

" - }, - "credentialProviderArn":{ - "shape":"PaymentCredentialProviderArnType", - "documentation":"

The Amazon Resource Name (ARN) of the updated payment credential provider.

" - }, - "providerConfigurationOutput":{ - "shape":"PaymentProviderConfigurationOutput", - "documentation":"

Output configuration (contains secret ARNs, excludes actual secret values).

" - }, - "createdTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the payment credential provider was created.

" - }, - "lastUpdatedTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the payment credential provider was last updated.

" - } - } - }, - "UpdatePaymentManagerRequest":{ - "type":"structure", - "required":["paymentManagerId"], - "members":{ - "paymentManagerId":{ - "shape":"PaymentManagerId", - "documentation":"

The unique identifier of the payment manager to update.

", - "location":"uri", - "locationName":"paymentManagerId" - }, - "description":{ - "shape":"PaymentsDescription", - "documentation":"

The updated description of the payment manager.

" - }, - "authorizerType":{ - "shape":"PaymentsAuthorizerType", - "documentation":"

The updated authorizer type for the payment manager.

" - }, - "authorizerConfiguration":{ - "shape":"AuthorizerConfiguration", - "documentation":"

The updated authorizer configuration for the payment manager.

" - }, - "roleArn":{ - "shape":"RoleArn", - "documentation":"

The updated Amazon Resource Name (ARN) of the IAM role for the payment manager.

" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

", - "idempotencyToken":true - } - } - }, - "UpdatePaymentManagerResponse":{ - "type":"structure", - "required":[ - "paymentManagerArn", - "paymentManagerId", - "name", - "authorizerType", - "roleArn", - "lastUpdatedAt", - "status" - ], - "members":{ - "paymentManagerArn":{ - "shape":"PaymentManagerArn", - "documentation":"

The Amazon Resource Name (ARN) of the updated payment manager.

" - }, - "paymentManagerId":{ - "shape":"PaymentManagerId", - "documentation":"

The unique identifier of the updated payment manager.

" - }, - "name":{ - "shape":"PaymentManagerName", - "documentation":"

The name of the updated payment manager.

" - }, - "authorizerType":{ - "shape":"PaymentsAuthorizerType", - "documentation":"

The type of authorizer for the updated payment manager.

" - }, - "roleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the IAM role associated with the updated payment manager.

" - }, - "workloadIdentityDetails":{"shape":"WorkloadIdentityDetails"}, - "lastUpdatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the payment manager was last updated.

" - }, - "status":{ - "shape":"PaymentManagerStatus", - "documentation":"

The current status of the updated payment manager. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.

" - } - } - }, - "UpdatePolicyEngineRequest":{ - "type":"structure", - "required":["policyEngineId"], - "members":{ - "policyEngineId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the policy engine to be updated.

", - "location":"uri", - "locationName":"policyEngineId" - }, - "description":{ - "shape":"UpdatedDescription", - "documentation":"

The new description for the policy engine.

" - } - } - }, - "UpdatePolicyEngineResponse":{ - "type":"structure", - "required":[ - "policyEngineId", - "name", - "createdAt", - "updatedAt", - "policyEngineArn", - "status", - "statusReasons" - ], - "members":{ - "policyEngineId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the updated policy engine.

" - }, - "name":{ - "shape":"PolicyEngineName", - "documentation":"

The name of the updated policy engine.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The original creation timestamp of the policy engine.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the policy engine was last updated.

" - }, - "policyEngineArn":{ - "shape":"PolicyEngineArn", - "documentation":"

The ARN of the updated policy engine.

" - }, - "status":{ - "shape":"PolicyEngineStatus", - "documentation":"

The current status of the updated policy engine.

" - }, - "encryptionKeyArn":{ - "shape":"KmsKeyArn", - "documentation":"

The Amazon Resource Name (ARN) of the KMS key used to encrypt the policy engine data.

" - }, - "description":{ - "shape":"Description", - "documentation":"

The updated description of the policy engine.

" - }, - "statusReasons":{ - "shape":"PolicyStatusReasons", - "documentation":"

Additional information about the update status.

" - } - } - }, - "UpdatePolicyRequest":{ - "type":"structure", - "required":[ - "policyEngineId", - "policyId" - ], - "members":{ - "policyEngineId":{ - "shape":"ResourceId", - "documentation":"

The identifier of the policy engine that manages the policy to be updated. This ensures the policy is updated within the correct policy engine context.

", - "location":"uri", - "locationName":"policyEngineId" - }, - "policyId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the policy to be updated. This must be a valid policy ID that exists within the specified policy engine.

", - "location":"uri", - "locationName":"policyId" - }, - "description":{ - "shape":"UpdatedDescription", - "documentation":"

The new human-readable description for the policy. This optional field allows updating the policy's documentation while keeping the same policy logic.

" - }, - "definition":{ - "shape":"PolicyDefinition", - "documentation":"

The new Cedar policy statement that defines the access control rules. This replaces the existing policy definition with new logic while maintaining the policy's identity.

" - }, - "validationMode":{ - "shape":"PolicyValidationMode", - "documentation":"

The validation mode for the policy update. Determines how Cedar analyzer validation results are handled during policy updates. FAIL_ON_ANY_FINDINGS runs the Cedar analyzer and fails the update if validation issues are detected, ensuring the policy conforms to the Cedar schema and tool context. IGNORE_ALL_FINDINGS runs the Cedar analyzer but allows updates despite validation warnings. Use FAIL_ON_ANY_FINDINGS to ensure policy correctness during updates, especially when modifying policy logic or conditions.

" - }, - "enforcementMode":{ - "shape":"EnforcementMode", - "documentation":"

The enforcement mode for the policy. Run this policy in LOG_ONLY mode to collect data on how it affects your application. Once you are satisfied with the data gathered, switch the policy to ACTIVE. If you omit this field, the policy's existing enforcement mode is unchanged.

" - } - } - }, - "UpdatePolicyResponse":{ - "type":"structure", - "required":[ - "policyId", - "name", - "policyEngineId", - "createdAt", - "updatedAt", - "policyArn", - "status", - "definition", - "statusReasons" - ], - "members":{ - "policyId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the updated policy.

" - }, - "name":{ - "shape":"PolicyName", - "documentation":"

The name of the updated policy.

" - }, - "policyEngineId":{ - "shape":"ResourceId", - "documentation":"

The identifier of the policy engine managing the updated policy.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The original creation timestamp of the policy.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the policy was last updated.

" - }, - "policyArn":{ - "shape":"PolicyArn", - "documentation":"

The ARN of the updated policy.

" - }, - "status":{ - "shape":"PolicyStatus", - "documentation":"

The current status of the updated policy.

" - }, - "enforcementMode":{ - "shape":"EnforcementMode", - "documentation":"

The current enforcement mode of the updated policy.

" - }, - "definition":{ - "shape":"PolicyDefinition", - "documentation":"

The updated Cedar policy statement.

" - }, - "description":{ - "shape":"Description", - "documentation":"

The updated description of the policy.

" - }, - "statusReasons":{ - "shape":"PolicyStatusReasons", - "documentation":"

Additional information about the update status.

" - } - } - }, - "UpdateRegistryRecordRequest":{ - "type":"structure", - "required":[ - "registryId", - "recordId" - ], - "members":{ - "registryId":{ - "shape":"RegistryIdentifier", - "documentation":"

The identifier of the registry containing the record. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.

", - "location":"uri", - "locationName":"registryId" - }, - "recordId":{ - "shape":"RecordIdentifier", - "documentation":"

The identifier of the registry record to update. You can specify either the Amazon Resource Name (ARN) or the ID of the record.

", - "location":"uri", - "locationName":"recordId" - }, - "name":{ - "shape":"RegistryRecordName", - "documentation":"

The updated name for the registry record.

" - }, - "description":{ - "shape":"UpdatedDescription", - "documentation":"

The updated description for the registry record. To clear the description, include the UpdatedDescription wrapper with optionalValue not specified.

" - }, - "descriptorType":{ - "shape":"DescriptorType", - "documentation":"

The updated descriptor type for the registry record. Changing the descriptor type may require updating the descriptors field to match the new type's schema requirements.

" - }, - "descriptors":{ - "shape":"UpdatedDescriptors", - "documentation":"

The updated descriptor-type-specific configuration containing the resource schema and metadata. Uses PATCH semantics where individual descriptor fields can be updated independently.

" - }, - "recordVersion":{ - "shape":"RegistryRecordVersion", - "documentation":"

The version of the registry record for optimistic locking. If provided, it must match the current version of the record. The service automatically increments the version after a successful update.

" - }, - "synchronizationType":{ - "shape":"UpdatedSynchronizationType", - "documentation":"

The updated synchronization type for the registry record.

" - }, - "synchronizationConfiguration":{ - "shape":"UpdatedSynchronizationConfiguration", - "documentation":"

The updated synchronization configuration for the registry record.

" - }, - "triggerSynchronization":{ - "shape":"Boolean", - "documentation":"

Whether to trigger synchronization using the stored or provided configuration. When set to true, the service will synchronize the record metadata from the configured external source.

" - } - } - }, - "UpdateRegistryRecordResponse":{ - "type":"structure", - "required":[ - "registryArn", - "recordArn", - "recordId", - "name", - "descriptorType", - "descriptors", - "status", - "createdAt", - "updatedAt" - ], - "members":{ - "registryArn":{ - "shape":"RegistryArn", - "documentation":"

The Amazon Resource Name (ARN) of the registry that contains the updated record.

" - }, - "recordArn":{ - "shape":"RegistryRecordArn", - "documentation":"

The Amazon Resource Name (ARN) of the updated registry record.

" - }, - "recordId":{ - "shape":"RegistryRecordId", - "documentation":"

The unique identifier of the updated registry record.

" - }, - "name":{ - "shape":"RegistryRecordName", - "documentation":"

The name of the updated registry record.

" - }, - "description":{ - "shape":"Description", - "documentation":"

The description of the updated registry record.

" - }, - "descriptorType":{ - "shape":"DescriptorType", - "documentation":"

The descriptor type of the updated registry record. Possible values are MCP, A2A, CUSTOM, and AGENT_SKILLS.

" - }, - "descriptors":{ - "shape":"Descriptors", - "documentation":"

The descriptor-type-specific configuration of the updated registry record. For details, see the Descriptors data type.

" - }, - "recordVersion":{ - "shape":"RegistryRecordVersion", - "documentation":"

The version of the updated registry record.

" - }, - "status":{ - "shape":"RegistryRecordStatus", - "documentation":"

The current status of the updated registry record. Possible values include CREATING, DRAFT, APPROVED, PENDING_APPROVAL, REJECTED, DEPRECATED, UPDATING, CREATE_FAILED, and UPDATE_FAILED.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the registry record was created.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the registry record was last updated.

" - }, - "statusReason":{ - "shape":"String", - "documentation":"

The reason for the current status of the updated registry record.

" - }, - "synchronizationType":{ - "shape":"SynchronizationType", - "documentation":"

The synchronization type of the updated registry record.

" - }, - "synchronizationConfiguration":{ - "shape":"SynchronizationConfiguration", - "documentation":"

The synchronization configuration of the updated registry record.

" - } - } - }, - "UpdateRegistryRecordStatusRequest":{ - "type":"structure", - "required":[ - "registryId", - "recordId", - "status", - "statusReason" - ], - "members":{ - "registryId":{ - "shape":"RegistryIdentifier", - "documentation":"

The identifier of the registry containing the record. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.

", - "location":"uri", - "locationName":"registryId" - }, - "recordId":{ - "shape":"RecordIdentifier", - "documentation":"

The identifier of the registry record to update the status for. You can specify either the Amazon Resource Name (ARN) or the ID of the record.

", - "location":"uri", - "locationName":"recordId" - }, - "status":{ - "shape":"RegistryRecordStatus", - "documentation":"

The target status for the registry record.

" - }, - "statusReason":{ - "shape":"UpdateRegistryRecordStatusRequestStatusReasonString", - "documentation":"

The reason for the status change, such as why the record was approved or rejected.

" - } - } - }, - "UpdateRegistryRecordStatusRequestStatusReasonString":{ - "type":"string", - "max":255, - "min":0 - }, - "UpdateRegistryRecordStatusResponse":{ - "type":"structure", - "required":[ - "registryArn", - "recordArn", - "recordId", - "status", - "statusReason", - "updatedAt" - ], - "members":{ - "registryArn":{ - "shape":"RegistryArn", - "documentation":"

The Amazon Resource Name (ARN) of the registry that contains the record.

" - }, - "recordArn":{ - "shape":"RegistryRecordArn", - "documentation":"

The Amazon Resource Name (ARN) of the registry record.

" - }, - "recordId":{ - "shape":"RegistryRecordId", - "documentation":"

The unique identifier of the registry record.

" - }, - "status":{ - "shape":"RegistryRecordStatus", - "documentation":"

The resulting status of the registry record.

" - }, - "statusReason":{ - "shape":"String", - "documentation":"

The reason for the status change.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the record was last updated.

" - } - } - }, - "UpdateRegistryRequest":{ - "type":"structure", - "required":["registryId"], - "members":{ - "registryId":{ - "shape":"RegistryIdentifier", - "documentation":"

The identifier of the registry to update. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.

", - "location":"uri", - "locationName":"registryId" - }, - "name":{ - "shape":"RegistryName", - "documentation":"

The updated name of the registry.

" - }, - "description":{ - "shape":"UpdatedDescription", - "documentation":"

The updated description of the registry. To clear the description, include the UpdatedDescription wrapper with optionalValue not specified.

" - }, - "authorizerConfiguration":{ - "shape":"UpdatedAuthorizerConfiguration", - "documentation":"

The updated authorizer configuration for the registry. Changing the authorizer configuration can break existing consumers of the registry who are using the authorization type prior to the update.

" - }, - "approvalConfiguration":{ - "shape":"UpdatedApprovalConfiguration", - "documentation":"

The updated approval configuration for registry records. The updated configuration only affects new records that move to PENDING_APPROVAL status after the change. Existing records already in PENDING_APPROVAL status are not affected.

" - } - } - }, - "UpdateRegistryResponse":{ - "type":"structure", - "required":[ - "name", - "registryId", - "registryArn", - "status", - "createdAt", - "updatedAt" - ], - "members":{ - "name":{ - "shape":"RegistryName", - "documentation":"

The name of the updated registry.

" - }, - "description":{ - "shape":"Description", - "documentation":"

The description of the updated registry.

" - }, - "registryId":{ - "shape":"RegistryId", - "documentation":"

The unique identifier of the updated registry.

" - }, - "registryArn":{ - "shape":"RegistryArn", - "documentation":"

The Amazon Resource Name (ARN) of the updated registry.

" - }, - "authorizerType":{ - "shape":"RegistryAuthorizerType", - "documentation":"

The type of authorizer used by the updated registry. This controls the authorization method for the Search and Invoke APIs used by consumers.

  • CUSTOM_JWT - Authorize with a bearer token.

  • AWS_IAM - Authorize with your Amazon Web Services IAM credentials.

" - }, - "authorizerConfiguration":{ - "shape":"AuthorizerConfiguration", - "documentation":"

The authorizer configuration for the updated registry. For details, see the AuthorizerConfiguration data type.

" - }, - "approvalConfiguration":{ - "shape":"ApprovalConfiguration", - "documentation":"

The approval configuration for the updated registry. For details, see the ApprovalConfiguration data type.

" - }, - "status":{ - "shape":"RegistryStatus", - "documentation":"

The current status of the updated registry. Possible values include CREATING, READY, UPDATING, CREATE_FAILED, UPDATE_FAILED, DELETING, and DELETE_FAILED.

" - }, - "statusReason":{ - "shape":"String", - "documentation":"

The reason for the current status of the updated registry.

" - }, - "createdAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the registry was created.

" - }, - "updatedAt":{ - "shape":"DateTimestamp", - "documentation":"

The timestamp when the registry was last updated.

" - } - } - }, - "UpdateWorkloadIdentityRequest":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{ - "shape":"WorkloadIdentityNameType", - "documentation":"

The name of the workload identity to update.

" - }, - "allowedResourceOauth2ReturnUrls":{ - "shape":"ResourceOauth2ReturnUrlListType", - "documentation":"

The new list of allowed OAuth2 return URLs for resources associated with this workload identity. This list replaces the existing list.

" - } - } - }, - "UpdateWorkloadIdentityResponse":{ - "type":"structure", - "required":[ - "name", - "workloadIdentityArn", - "createdTime", - "lastUpdatedTime" - ], - "members":{ - "name":{ - "shape":"WorkloadIdentityNameType", - "documentation":"

The name of the workload identity.

" - }, - "workloadIdentityArn":{ - "shape":"WorkloadIdentityArnType", - "documentation":"

The Amazon Resource Name (ARN) of the workload identity.

" - }, - "allowedResourceOauth2ReturnUrls":{ - "shape":"ResourceOauth2ReturnUrlListType", - "documentation":"

The list of allowed OAuth2 return URLs for resources associated with this workload identity.

" - }, - "createdTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the workload identity was created.

" - }, - "lastUpdatedTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the workload identity was last updated.

" - } - } - }, - "UpdatedA2aDescriptor":{ - "type":"structure", - "members":{ - "optionalValue":{ - "shape":"A2aDescriptor", - "documentation":"

The updated A2A descriptor value.

" - } - }, - "documentation":"

Wrapper for updating an A2A descriptor with PATCH semantics. When present, the A2A descriptor is replaced with the provided value. When absent, the A2A descriptor is left unchanged. To unset, include the wrapper with the value set to null.

" - }, - "UpdatedAgentSkillsDescriptor":{ - "type":"structure", - "members":{ - "optionalValue":{ - "shape":"UpdatedAgentSkillsDescriptorFields", - "documentation":"

The updated agent skills descriptor fields.

" - } - }, - "documentation":"

Wrapper for updating an agent skills descriptor with PATCH semantics. When present with a value, individual fields can be updated independently. When present with a null value, the entire agent skills descriptor is unset. When absent, the agent skills descriptor is left unchanged.

" - }, - "UpdatedAgentSkillsDescriptorFields":{ - "type":"structure", - "members":{ - "skillMd":{ - "shape":"UpdatedSkillMdDefinition", - "documentation":"

The updated skill markdown definition.

" - }, - "skillDefinition":{ - "shape":"UpdatedSkillDefinition", - "documentation":"

The updated skill definition.

" - } - }, - "documentation":"

Individual agent skills descriptor fields that can be updated independently.

" - }, - "UpdatedApprovalConfiguration":{ - "type":"structure", - "members":{ - "optionalValue":{ - "shape":"ApprovalConfiguration", - "documentation":"

The updated approval configuration value. Set to null to unset the approval configuration.

" - } - }, - "documentation":"

Wrapper for updating an optional approval configuration field with PATCH semantics. When present in an update request, the approval configuration is replaced with the provided value. When absent, the approval configuration is left unchanged.

" - }, - "UpdatedAuthorizerConfiguration":{ - "type":"structure", - "members":{ - "optionalValue":{ - "shape":"AuthorizerConfiguration", - "documentation":"

The updated authorizer configuration value. If not specified, it will clear the current authorizer configuration of the resource.

" - } - }, - "documentation":"

Wrapper for updating an optional AuthorizerConfiguration field with PATCH semantics. When present in an update request, the authorizer configuration is replaced with optionalValue. When absent, the authorizer configuration is left unchanged. To unset, include the wrapper with optionalValue not specified.

" - }, - "UpdatedCustomDescriptor":{ - "type":"structure", - "members":{ - "optionalValue":{ - "shape":"CustomDescriptor", - "documentation":"

The updated custom descriptor value.

" - } - }, - "documentation":"

Wrapper for updating a custom descriptor with PATCH semantics. When present, the custom descriptor is replaced with the provided value. When absent, the custom descriptor is left unchanged. To unset, include the wrapper with the value set to null.

" - }, - "UpdatedDescription":{ - "type":"structure", - "members":{ - "optionalValue":{ - "shape":"Description", - "documentation":"

Represents an optional value that is used to update the human-readable description of the resource. If not specified, it will clear the current description of the resource.

" - } - }, - "documentation":"

Wrapper for updating an optional Description field with PATCH semantics. When present in an update request, the description is replaced with optionalValue. When absent, the description is left unchanged. To unset the description, include the wrapper with optionalValue not specified.

" - }, - "UpdatedDescriptors":{ - "type":"structure", - "members":{ - "optionalValue":{ - "shape":"UpdatedDescriptorsUnion", - "documentation":"

The updated descriptors value. Contains per-descriptor-type wrappers that are each independently updatable.

" - } - }, - "documentation":"

Wrapper for updating an optional descriptors field with PATCH semantics. When present with a value, individual descriptors can be updated. When present with a null value, all descriptors are unset. When absent, descriptors are left unchanged.

" - }, - "UpdatedDescriptorsUnion":{ - "type":"structure", - "members":{ - "mcp":{ - "shape":"UpdatedMcpDescriptor", - "documentation":"

The updated MCP descriptor.

" - }, - "a2a":{ - "shape":"UpdatedA2aDescriptor", - "documentation":"

The updated A2A descriptor.

" - }, - "custom":{ - "shape":"UpdatedCustomDescriptor", - "documentation":"

The updated custom descriptor.

" - }, - "agentSkills":{ - "shape":"UpdatedAgentSkillsDescriptor", - "documentation":"

The updated agent skills descriptor.

" - } - }, - "documentation":"

Contains per-descriptor-type wrappers for updating descriptors. Each descriptor type can be updated independently.

" - }, - "UpdatedHarnessEnvironmentArtifact":{ - "type":"structure", - "members":{ - "optionalValue":{ - "shape":"HarnessEnvironmentArtifact", - "documentation":"

The updated environment artifact value, or null to clear the existing configuration.

" - } - }, - "documentation":"

Wrapper for updating the environment artifact configuration.

" - }, - "UpdatedHarnessMemoryConfiguration":{ - "type":"structure", - "members":{ - "optionalValue":{ - "shape":"HarnessMemoryConfiguration", - "documentation":"

The updated memory configuration value, or null to clear the existing configuration.

" - } - }, - "documentation":"

Wrapper for updating the memory configuration.

" - }, - "UpdatedMcpDescriptor":{ - "type":"structure", - "members":{ - "optionalValue":{ - "shape":"UpdatedMcpDescriptorFields", - "documentation":"

The updated MCP descriptor fields.

" - } - }, - "documentation":"

Wrapper for updating an MCP descriptor with PATCH semantics. When present with a value, individual MCP fields can be updated independently. When present with a null value, the entire MCP descriptor is unset. When absent, the MCP descriptor is left unchanged.

" - }, - "UpdatedMcpDescriptorFields":{ - "type":"structure", - "members":{ - "server":{ - "shape":"UpdatedServerDefinition", - "documentation":"

The updated server definition for the MCP descriptor.

" - }, - "tools":{ - "shape":"UpdatedToolsDefinition", - "documentation":"

The updated tools definition for the MCP descriptor.

" - } - }, - "documentation":"

Individual MCP descriptor fields that can be updated independently.

" - }, - "UpdatedServerDefinition":{ - "type":"structure", - "members":{ - "optionalValue":{ - "shape":"ServerDefinition", - "documentation":"

The updated server definition value.

" - } - }, - "documentation":"

Wrapper for updating a server definition with PATCH semantics. When present, the server definition is replaced with the provided value. When absent, the server definition is left unchanged. To unset, include the wrapper with the value set to null.

" - }, - "UpdatedSkillDefinition":{ - "type":"structure", - "members":{ - "optionalValue":{ - "shape":"SkillDefinition", - "documentation":"

The updated skill definition value.

" - } - }, - "documentation":"

Wrapper for updating a skill definition with PATCH semantics.

" - }, - "UpdatedSkillMdDefinition":{ - "type":"structure", - "members":{ - "optionalValue":{ - "shape":"SkillMdDefinition", - "documentation":"

The updated skill markdown definition value.

" - } - }, - "documentation":"

Wrapper for updating a skill markdown definition with PATCH semantics.

" - }, - "UpdatedSynchronizationConfiguration":{ - "type":"structure", - "members":{ - "optionalValue":{ - "shape":"SynchronizationConfiguration", - "documentation":"

The updated synchronization configuration value.

" - } - }, - "documentation":"

Wrapper for updating the synchronization configuration with PATCH semantics. Must be matched with UpdatedSynchronizationType.

" - }, - "UpdatedSynchronizationType":{ - "type":"structure", - "members":{ - "optionalValue":{ - "shape":"SynchronizationType", - "documentation":"

The updated synchronization type value.

" - } - }, - "documentation":"

Wrapper for updating the synchronization type with PATCH semantics. Must be matched with UpdatedSynchronizationConfiguration.

" - }, - "UpdatedToolsDefinition":{ - "type":"structure", - "members":{ - "optionalValue":{ - "shape":"ToolsDefinition", - "documentation":"

The updated tools definition value.

" - } - }, - "documentation":"

Wrapper for updating a tools definition with PATCH semantics. When present, the tools definition is replaced with the provided value. When absent, the tools definition is left unchanged. To unset, include the wrapper with the value set to null.

" - }, - "UserPreferenceConsolidationOverride":{ - "type":"structure", - "required":[ - "appendToPrompt", - "modelId" - ], - "members":{ - "appendToPrompt":{ - "shape":"Prompt", - "documentation":"

The text to append to the prompt for user preference consolidation.

" - }, - "modelId":{ - "shape":"String", - "documentation":"

The model ID to use for user preference consolidation.

" - } - }, - "documentation":"

Contains user preference consolidation override configuration.

" - }, - "UserPreferenceExtractionOverride":{ - "type":"structure", - "required":[ - "appendToPrompt", - "modelId" - ], - "members":{ - "appendToPrompt":{ - "shape":"Prompt", - "documentation":"

The text to append to the prompt for user preference extraction.

" - }, - "modelId":{ - "shape":"String", - "documentation":"

The model ID to use for user preference extraction.

" - } - }, - "documentation":"

Contains user preference extraction override configuration.

" - }, - "UserPreferenceMemoryStrategyInput":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{ - "shape":"Name", - "documentation":"

The name of the user preference memory strategy.

" - }, - "description":{ - "shape":"Description", - "documentation":"

The description of the user preference memory strategy.

" - }, - "namespaces":{ - "shape":"NamespacesList", - "documentation":"

This is a legacy parameter, use namespaceTemplates. The namespaces associated with the user preference memory strategy.

", - "deprecated":true, - "deprecatedMessage":"Use namespaceTemplates instead", - "deprecatedSince":"2026-03-02" - }, - "namespaceTemplates":{ - "shape":"NamespacesList", - "documentation":"

The namespaceTemplates associated with the user preference memory strategy.

" - }, - "memoryRecordSchema":{ - "shape":"MemoryRecordSchema", - "documentation":"

Schema for metadata fields on records generated by this strategy.

" - } - }, - "documentation":"

Input for creating a user preference memory strategy.

" - }, - "UserPreferenceOverrideConfigurationInput":{ - "type":"structure", - "members":{ - "extraction":{ - "shape":"UserPreferenceOverrideExtractionConfigurationInput", - "documentation":"

The extraction configuration for a user preference override.

" - }, - "consolidation":{ - "shape":"UserPreferenceOverrideConsolidationConfigurationInput", - "documentation":"

The consolidation configuration for a user preference override.

" - } - }, - "documentation":"

Input for user preference override configuration in a memory strategy.

" - }, - "UserPreferenceOverrideConsolidationConfigurationInput":{ - "type":"structure", - "required":[ - "appendToPrompt", - "modelId" - ], - "members":{ - "appendToPrompt":{ - "shape":"Prompt", - "documentation":"

The text to append to the prompt for user preference consolidation.

" - }, - "modelId":{ - "shape":"String", - "documentation":"

The model ID to use for user preference consolidation.

" - } - }, - "documentation":"

Input for user preference override consolidation configuration in a memory strategy.

" - }, - "UserPreferenceOverrideExtractionConfigurationInput":{ - "type":"structure", - "required":[ - "appendToPrompt", - "modelId" - ], - "members":{ - "appendToPrompt":{ - "shape":"Prompt", - "documentation":"

The text to append to the prompt for user preference extraction.

" - }, - "modelId":{ - "shape":"String", - "documentation":"

The model ID to use for user preference extraction.

" - } - }, - "documentation":"

Input for user preference override extraction configuration in a memory strategy.

" - }, - "Validation":{ - "type":"structure", - "members":{ - "stringValidation":{"shape":"StringValidation"}, - "stringListValidation":{"shape":"StringListValidation"}, - "numberValidation":{"shape":"NumberValidation"} - }, - "documentation":"

Validation rules for extracted metadata values. Only one type can be specified, matching the field's data type.

", - "union":true - }, - "ValidationException":{ - "type":"structure", - "required":[ - "message", - "reason" - ], - "members":{ - "message":{"shape":"String"}, - "reason":{"shape":"ValidationExceptionReason"}, - "fieldList":{"shape":"ValidationExceptionFieldList"} - }, - "documentation":"

The input fails to satisfy the constraints specified by the service.

", - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "ValidationExceptionField":{ - "type":"structure", - "required":[ - "name", - "message" - ], - "members":{ - "name":{ - "shape":"String", - "documentation":"

The name of the field.

" - }, - "message":{ - "shape":"String", - "documentation":"

A message describing why this field failed validation.

" - } - }, - "documentation":"

Stores information about a field passed inside a request that resulted in an exception.

" - }, - "ValidationExceptionFieldList":{ - "type":"list", - "member":{"shape":"ValidationExceptionField"} - }, - "ValidationExceptionReason":{ - "type":"string", - "enum":[ - "CannotParse", - "FieldValidationFailed", - "IdempotentParameterMismatchException", - "EventInOtherSession", - "ResourceConflict" - ] - }, - "VersionCreatedBySource":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{ - "shape":"String", - "documentation":"

The name of the source (for example, user, optimization-job, or system).

" - }, - "arn":{ - "shape":"String", - "documentation":"

The Amazon Resource Name (ARN) of the source, if applicable (for example, a user ARN or optimization job ARN).

" - } - }, - "documentation":"

The source that created a configuration bundle version.

" - }, - "VersionFilter":{ - "type":"structure", - "members":{ - "branchName":{ - "shape":"BranchName", - "documentation":"

Filter by branch name.

" - }, - "createdByName":{ - "shape":"String", - "documentation":"

Filter by creation source name.

" - }, - "latestPerBranch":{ - "shape":"Boolean", - "documentation":"

When true, returns only the latest version for each branch. When false or not specified, returns all versions. Can be combined with branchName to get the latest version for a specific branch.

" - } - }, - "documentation":"

A filter for listing configuration bundle versions.

" - }, - "VersionLineageMetadata":{ - "type":"structure", - "members":{ - "parentVersionIds":{ - "shape":"ConfigurationBundleVersionList", - "documentation":"

A list of parent version identifiers. Regular commits have 0-1 parents. Merge commits have 2 parents: the target branch parent and the source branch parent. The first parent represents the primary lineage.

" - }, - "branchName":{ - "shape":"BranchName", - "documentation":"

The branch name for this version. If not specified, inherits the parent's branch or defaults to mainline.

" - }, - "createdBy":{ - "shape":"VersionCreatedBySource", - "documentation":"

The source that created this version.

" - }, - "commitMessage":{ - "shape":"VersionLineageMetadataCommitMessageString", - "documentation":"

A commit message describing the changes in this version.

" - } - }, - "documentation":"

The version lineage metadata that tracks parent versions and creation source. Supports git-like two-parent merges for branch management.

" - }, - "VersionLineageMetadataCommitMessageString":{ - "type":"string", - "max":500, - "min":1 - }, - "VpcConfig":{ - "type":"structure", - "required":[ - "securityGroups", - "subnets" - ], - "members":{ - "securityGroups":{ - "shape":"SecurityGroups", - "documentation":"

The security groups associated with the VPC configuration.

" - }, - "subnets":{ - "shape":"Subnets", - "documentation":"

The subnets associated with the VPC configuration.

" - }, - "requireServiceS3Endpoint":{ - "shape":"Boolean", - "documentation":"

This field applies only to Agent Runtimes. It is not applicable to Browsers or Code Interpreters.

Controls whether a service-managed Amazon S3 gateway endpoint is provisioned in the VPC network topology for the agent runtime. This gateway is used by Amazon Bedrock AgentCore Runtime to download code and container images during agent startup.

Starting May 5, 2026, Amazon Bedrock AgentCore Runtime is gradually rolling out a change to how network isolation is configured for VPC mode agents. Agent runtimes created on or after this rollout will no longer include the service-managed Amazon S3 gateway. Instead, all network access, including to Amazon S3, is governed exclusively by your VPC configuration. This field cannot be set on agent runtimes created after the rollout. Passing this field in an UpdateAgentRuntime request for these agent runtimes returns a ValidationException.

Agent runtimes created before the rollout are not affected and continue to operate with the service-managed Amazon S3 gateway. To enforce full VPC network isolation on these existing agent runtimes, set this field to false via the UpdateAgentRuntime API. Before opting out, ensure your VPC provides the Amazon S3 access required for agent startup. If this field is not specified or is set to true, the service-managed Amazon S3 gateway remains provisioned.

This field is only supported in the UpdateAgentRuntime API for pre-rollout agent runtimes. Passing this field in a CreateAgentRuntime request returns a ValidationException.

" - } - }, - "documentation":"

VpcConfig for the Agent.

" - }, - "VpcIdentifier":{ - "type":"string", - "pattern":"vpc-(([0-9a-z]{8})|([0-9a-z]{17}))" - }, - "WafConfiguration":{ - "type":"structure", - "members":{ - "failureMode":{ - "shape":"WafFailureMode", - "documentation":"

The failure mode that determines how the gateway handles requests when Amazon Web Services WAF is unreachable or times out. Valid values include:

  • FAIL_CLOSE - The gateway blocks requests when Amazon Web Services WAF cannot be evaluated.

  • FAIL_OPEN - The gateway allows requests when Amazon Web Services WAF cannot be evaluated.

" - } - }, - "documentation":"

The Amazon Web Services WAF configuration for the gateway. This configuration controls how the gateway behaves when the associated web ACL cannot be evaluated.

" - }, - "WafFailureMode":{ - "type":"string", - "enum":[ - "FAIL_CLOSE", - "FAIL_OPEN" - ] - }, - "WebAclArn":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"arn:[a-z0-9\\-]+:wafv2:[a-z0-9\\-]+:[0-9]{12}:regional/webacl/.+" - }, - "WeightedOverride":{ - "type":"structure", - "required":["trafficSplit"], - "members":{ - "trafficSplit":{ - "shape":"TrafficSplitEntries", - "documentation":"

The traffic split entries defining how traffic is distributed between configuration bundle versions.

" - } - }, - "documentation":"

A weighted configuration bundle override that splits traffic between multiple bundle versions.

" - }, - "WeightedRoute":{ - "type":"structure", - "required":["trafficSplit"], - "members":{ - "trafficSplit":{ - "shape":"TargetTrafficSplitEntries", - "documentation":"

The traffic split entries defining how traffic is distributed between targets.

" - } - }, - "documentation":"

A weighted route that splits traffic between multiple gateway targets.

" - }, - "WorkloadIdentityArn":{ - "type":"string", - "max":1024, - "min":1 - }, - "WorkloadIdentityArnType":{ - "type":"string", - "max":1024, - "min":1 - }, - "WorkloadIdentityDetails":{ - "type":"structure", - "required":["workloadIdentityArn"], - "members":{ - "workloadIdentityArn":{ - "shape":"WorkloadIdentityArn", - "documentation":"

The ARN associated with the workload identity.

" - } - }, - "documentation":"

The information about the workload identity.

" - }, - "WorkloadIdentityList":{ - "type":"list", - "member":{"shape":"WorkloadIdentityType"} - }, - "WorkloadIdentityNameListType":{ - "type":"list", - "member":{"shape":"WorkloadIdentityNameType"}, - "max":10, - "min":1 - }, - "WorkloadIdentityNameType":{ - "type":"string", - "max":255, - "min":3, - "pattern":"[A-Za-z0-9_.-]+" - }, - "WorkloadIdentityType":{ - "type":"structure", - "required":[ - "name", - "workloadIdentityArn" - ], - "members":{ - "name":{ - "shape":"WorkloadIdentityNameType", - "documentation":"

The name of the workload identity.

" - }, - "workloadIdentityArn":{ - "shape":"WorkloadIdentityArnType", - "documentation":"

The Amazon Resource Name (ARN) of the workload identity.

" - } - }, - "documentation":"

Contains information about a workload identity.

" - }, - "entryPoint":{ - "type":"string", - "max":128, - "min":1 - } - }, - "documentation":"

Welcome to the Amazon Bedrock AgentCore Control plane API reference. Control plane actions configure, create, modify, and monitor Amazon Web Services resources.

" -} diff --git a/tools/code-generation/api-descriptions/bedrock-agentcore-control/2023-06-05/smoke.json b/tools/code-generation/api-descriptions/bedrock-agentcore-control/2023-06-05/smoke.json deleted file mode 100644 index a9756813e4af..000000000000 --- a/tools/code-generation/api-descriptions/bedrock-agentcore-control/2023-06-05/smoke.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "version": 1, - "defaultRegion": "us-west-2", - "testCases": [ - ] -} diff --git a/tools/code-generation/api-descriptions/bedrock-agentcore-control/2023-06-05/waiters-2.json b/tools/code-generation/api-descriptions/bedrock-agentcore-control/2023-06-05/waiters-2.json deleted file mode 100644 index 605a9f9f1331..000000000000 --- a/tools/code-generation/api-descriptions/bedrock-agentcore-control/2023-06-05/waiters-2.json +++ /dev/null @@ -1,149 +0,0 @@ -{ - "version" : 2, - "waiters" : { - "MemoryCreated" : { - "delay" : 2, - "maxAttempts" : 60, - "operation" : "GetMemory", - "acceptors" : [ { - "matcher" : "path", - "argument" : "memory.status", - "state" : "retry", - "expected" : "CREATING" - }, { - "matcher" : "path", - "argument" : "memory.status", - "state" : "success", - "expected" : "ACTIVE" - }, { - "matcher" : "path", - "argument" : "memory.status", - "state" : "failure", - "expected" : "FAILED" - } ] - }, - "PolicyActive" : { - "description" : "Wait until a Policy is active", - "delay" : 5, - "maxAttempts" : 24, - "operation" : "GetPolicy", - "acceptors" : [ { - "matcher" : "path", - "argument" : "status", - "state" : "success", - "expected" : "ACTIVE" - }, { - "matcher" : "path", - "argument" : "status", - "state" : "failure", - "expected" : "CREATE_FAILED" - }, { - "matcher" : "path", - "argument" : "status", - "state" : "failure", - "expected" : "UPDATE_FAILED" - }, { - "matcher" : "path", - "argument" : "status", - "state" : "failure", - "expected" : "DELETE_FAILED" - } ] - }, - "PolicyDeleted" : { - "description" : "Wait until a Policy is deleted", - "delay" : 2, - "maxAttempts" : 60, - "operation" : "GetPolicy", - "acceptors" : [ { - "matcher" : "error", - "state" : "success", - "expected" : "ResourceNotFoundException" - }, { - "matcher" : "path", - "argument" : "status", - "state" : "retry", - "expected" : "DELETING" - }, { - "matcher" : "path", - "argument" : "status", - "state" : "failure", - "expected" : "DELETE_FAILED" - } ] - }, - "PolicyEngineActive" : { - "description" : "Wait until a PolicyEngine is active", - "delay" : 5, - "maxAttempts" : 24, - "operation" : "GetPolicyEngine", - "acceptors" : [ { - "matcher" : "path", - "argument" : "status", - "state" : "success", - "expected" : "ACTIVE" - }, { - "matcher" : "path", - "argument" : "status", - "state" : "failure", - "expected" : "CREATE_FAILED" - }, { - "matcher" : "path", - "argument" : "status", - "state" : "failure", - "expected" : "UPDATE_FAILED" - }, { - "matcher" : "path", - "argument" : "status", - "state" : "failure", - "expected" : "DELETE_FAILED" - } ] - }, - "PolicyEngineDeleted" : { - "description" : "Wait until a PolicyEngine is deleted", - "delay" : 2, - "maxAttempts" : 60, - "operation" : "GetPolicyEngine", - "acceptors" : [ { - "matcher" : "error", - "state" : "success", - "expected" : "ResourceNotFoundException" - }, { - "matcher" : "path", - "argument" : "status", - "state" : "retry", - "expected" : "DELETING" - }, { - "matcher" : "path", - "argument" : "status", - "state" : "failure", - "expected" : "DELETE_FAILED" - } ] - }, - "PolicyGenerationCompleted" : { - "description" : "Wait until policy generation is completed", - "delay" : 5, - "maxAttempts" : 24, - "operation" : "GetPolicyGeneration", - "acceptors" : [ { - "matcher" : "path", - "argument" : "status", - "state" : "success", - "expected" : "GENERATED" - }, { - "matcher" : "path", - "argument" : "status", - "state" : "retry", - "expected" : "GENERATING" - }, { - "matcher" : "path", - "argument" : "status", - "state" : "failure", - "expected" : "GENERATE_FAILED" - }, { - "matcher" : "path", - "argument" : "status", - "state" : "failure", - "expected" : "DELETE_FAILED" - } ] - } - } -} \ No newline at end of file diff --git a/tools/code-generation/api-descriptions/custom-service/custom-service-2017-11-03.normal.json b/tools/code-generation/api-descriptions/custom-service/custom-service-2017-11-03.normal.json deleted file mode 100644 index 2c70a75824ff..000000000000 --- a/tools/code-generation/api-descriptions/custom-service/custom-service-2017-11-03.normal.json +++ /dev/null @@ -1,232 +0,0 @@ -{ - "metadata" : { - "apiVersion" : "2017-11-03T00:20:44Z", - "endpointPrefix" : "z2z37qum61", - "serviceFullName" : "PetStore", - "serviceId" : "PetStore", - "protocol" : "api-gateway", - "uid" : "z2z37qum61-2017-11-03T00:20:44Z" - }, - "operations" : { - "CreatePet" : { - "name" : "CreatePet", - "http" : { - "method" : "POST", - "requestUri" : "/test/pets", - "responseCode" : 200 - }, - "input" : { - "shape" : "CreatePetRequest" - }, - "output" : { - "shape" : "CreatePetResponse" - }, - "errors" : [ ], - "authtype" : "none" - }, - "GetApiRoot" : { - "name" : "GetApiRoot", - "http" : { - "method" : "GET", - "requestUri" : "/test/", - "responseCode" : 200 - }, - "input" : { - "shape" : "GetApiRootRequest" - }, - "output" : { - "shape" : "GetApiRootResponse" - }, - "errors" : [ ], - "authtype" : "none" - }, - "GetPet" : { - "name" : "GetPet", - "http" : { - "method" : "GET", - "requestUri" : "/test/pets/{petId}", - "responseCode" : 200 - }, - "input" : { - "shape" : "GetPetRequest" - }, - "output" : { - "shape" : "GetPetResponse" - }, - "errors" : [ ], - "authtype" : "none" - }, - "GetPets" : { - "name" : "GetPets", - "http" : { - "method" : "GET", - "requestUri" : "/test/pets", - "responseCode" : 200 - }, - "input" : { - "shape" : "GetPetsRequest" - }, - "output" : { - "shape" : "GetPetsResponse" - }, - "errors" : [ ], - "authtype" : "none" - } - }, - "shapes" : { - "CreatePetRequest" : { - "type" : "structure", - "members" : { - "NewPet" : { - "shape" : "NewPet" - } - }, - "required" : [ "NewPet" ], - "payload" : "NewPet" - }, - "CreatePetResponse" : { - "type" : "structure", - "members" : { - "NewPetResponse" : { - "shape" : "NewPetResponse" - } - }, - "required" : [ "NewPetResponse" ], - "payload" : "NewPetResponse" - }, - "Empty" : { - "type" : "structure", - "members" : { } - }, - "GetApiRootRequest" : { - "type" : "structure", - "members" : { } - }, - "GetApiRootResponse" : { - "type" : "structure", - "members" : { } - }, - "GetPetRequest" : { - "type" : "structure", - "members" : { - "PetId" : { - "shape" : "__double", - "location" : "uri", - "locationName" : "petId" - } - }, - "required" : [ "PetId" ] - }, - "GetPetResponse" : { - "type" : "structure", - "members" : { - "Pet" : { - "shape" : "Pet" - } - }, - "required" : [ "Pet" ], - "payload" : "Pet" - }, - "GetPetsRequest" : { - "type" : "structure", - "members" : { - "Page" : { - "shape" : "__string", - "location" : "querystring", - "locationName" : "page" - }, - "Type" : { - "shape" : "__string", - "location" : "querystring", - "locationName" : "type" - } - } - }, - "GetPetsResponse" : { - "type" : "structure", - "members" : { - "Pets" : { - "shape" : "Pets" - } - }, - "required" : [ "Pets" ], - "payload" : "Pets" - }, - "NewPet" : { - "type" : "structure", - "members" : { - "Price" : { - "shape" : "__double", - "locationName" : "price" - }, - "Type" : { - "shape" : "PetType", - "locationName" : "type" - } - } - }, - "NewPetResponse" : { - "type" : "structure", - "members" : { - "Message" : { - "shape" : "__string", - "locationName" : "message" - }, - "Pet" : { - "shape" : "Pet", - "locationName" : "pet" - } - } - }, - "Pet" : { - "type" : "structure", - "members" : { - "Id" : { - "shape" : "__double", - "locationName" : "id" - }, - "Price" : { - "shape" : "__double", - "locationName" : "price" - }, - "Type" : { - "shape" : "__string", - "locationName" : "type" - } - } - }, - "PetType" : { - "type" : "string", - "enum" : [ "dog", "cat", "fish", "bird", "gecko" ] - }, - "Pets" : { - "type" : "list", - "member" : { - "shape" : "Pet" - } - }, - "__boolean" : { - "type" : "boolean" - }, - "__double" : { - "type" : "double" - }, - "__integer" : { - "type" : "integer" - }, - "__long" : { - "type" : "long" - }, - "__string" : { - "type" : "string" - }, - "__timestampIso8601" : { - "type" : "timestamp", - "timestampFormat" : "iso8601" - }, - "__timestampUnix" : { - "type" : "timestamp", - "timestampFormat" : "unixTimestamp" - } - } -} diff --git a/tools/code-generation/api-descriptions/iam-2010-05-08.normal.json b/tools/code-generation/api-descriptions/iam-2010-05-08.normal.json index 6c7ba9090749..56ff082382fa 100644 --- a/tools/code-generation/api-descriptions/iam-2010-05-08.normal.json +++ b/tools/code-generation/api-descriptions/iam-2010-05-08.normal.json @@ -1112,7 +1112,7 @@ {"shape":"NoSuchEntityException"}, {"shape":"InvalidInputException"} ], - "documentation":"

Gets a list of all of the context keys referenced in all the IAM policies that are attached to the specified IAM entity. The entity can be an IAM user, group, or role. If you specify a user, then the request also includes all of the policies attached to groups that the user is a member of.

You can optionally include a list of one or more additional policies, specified as strings. If you want to include only a list of policies by string, use GetContextKeysForCustomPolicy instead.

Note: This operation discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use GetContextKeysForCustomPolicy instead.

Context keys are variables maintained by Amazon Web Services and its services that provide details about the context of an API query request. Context keys can be evaluated by testing against a value in an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key names and values you must supply when you call SimulatePrincipalPolicy.

" + "documentation":"

Gets a list of all of the context keys referenced in all the IAM policies that are attached to the specified IAM entity. The entity can be an IAM user, group, or role. If you specify a user, then the request also includes all of the policies attached to groups that the user is a member of.

You can optionally include a list of one or more additional policies, specified as strings. If you want to include only a list of policies by string, use GetContextKeysForCustomPolicy instead.

Note: This operation discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use GetContextKeysForCustomPolicy instead.

Context keys are variables maintained by Amazon Web Services and its services that provide details about the context of an API query request. Context keys can be evaluated by testing against a value in an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key names and values you must supply when you call SimulatePrincipalPolicy. This operation doesn't return context keys referenced by service control policies (SCPs). Only context keys referenced by the identity-based policies attached to the specified entity, and any additional policies that you provide, are included.

" }, "GetCredentialReport":{ "name":"GetCredentialReport", @@ -2344,7 +2344,7 @@ {"shape":"InvalidInputException"}, {"shape":"PolicyEvaluationException"} ], - "documentation":"

Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API operations and Amazon Web Services resources to determine the policies' effective permissions. The policies are provided as strings.

The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations. You can simulate resources that don't exist in your account.

If you want to simulate existing policies that are attached to an IAM user, group, or role, use SimulatePrincipalPolicy instead.

Context keys are variables that are maintained by Amazon Web Services and its services and which provide details about the context of an API query request. You can use the Condition element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForCustomPolicy.

If the output is long, you can use MaxItems and Marker parameters to paginate the results.

The IAM policy simulator evaluates statements in the identity-based policy and the inputs that you provide during simulation. The policy simulator results can differ from your live Amazon Web Services environment. We recommend that you check your policies against your live Amazon Web Services environment after testing using the policy simulator to confirm that you have the desired results. For more information about using the policy simulator, see Testing IAM policies with the IAM policy simulator in the IAM User Guide.

" + "documentation":"

Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API operations and Amazon Web Services resources to determine the policies' effective permissions. The policies are provided as strings.

The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations. You can simulate resources that don't exist in your account.

If you want to simulate existing policies that are attached to an IAM user, group, or role, use SimulatePrincipalPolicy instead.

Context keys are variables that are maintained by Amazon Web Services and its services and which provide details about the context of an API query request. You can use the Condition element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForCustomPolicy.

If the output is long, you can use MaxItems and Marker parameters to paginate the results.

The IAM policy simulator evaluates statements in identity-based policies, service control policies (SCPs) including their condition keys and resource scoping, and the inputs that you provide during simulation. The policy simulator results can differ from your live Amazon Web Services environment. We recommend that you check your policies against your live Amazon Web Services environment after testing using the policy simulator to confirm that you have the desired results. For more information about using the policy simulator, see Testing IAM policies with the IAM policy simulator in the IAM User Guide.

" }, "SimulatePrincipalPolicy":{ "name":"SimulatePrincipalPolicy", @@ -2362,7 +2362,7 @@ {"shape":"InvalidInputException"}, {"shape":"PolicyEvaluationException"} ], - "documentation":"

Simulate how a set of IAM policies attached to an IAM entity works with a list of API operations and Amazon Web Services resources to determine the policies' effective permissions. The entity can be an IAM user, group, or role. If you specify a user, then the simulation also includes all of the policies that are attached to groups that the user belongs to. You can simulate resources that don't exist in your account.

You can optionally include a list of one or more additional policies specified as strings to include in the simulation. If you want to simulate only policies specified as strings, use SimulateCustomPolicy instead.

You can also optionally include one resource-based policy to be evaluated with each of the resources included in the simulation for IAM users only.

The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations.

Note: This operation discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use SimulateCustomPolicy instead.

Context keys are variables maintained by Amazon Web Services and its services that provide details about the context of an API query request. You can use the Condition element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForPrincipalPolicy.

If the output is long, you can use the MaxItems and Marker parameters to paginate the results.

The IAM policy simulator evaluates statements in the identity-based policy and the inputs that you provide during simulation. The policy simulator results can differ from your live Amazon Web Services environment. We recommend that you check your policies against your live Amazon Web Services environment after testing using the policy simulator to confirm that you have the desired results. For more information about using the policy simulator, see Testing IAM policies with the IAM policy simulator in the IAM User Guide.

" + "documentation":"

Simulate how a set of IAM policies attached to an IAM entity works with a list of API operations and Amazon Web Services resources to determine the policies' effective permissions. The entity can be an IAM user, group, or role. If you specify a user, then the simulation also includes all of the policies that are attached to groups that the user belongs to. You can simulate resources that don't exist in your account.

You can optionally include a list of one or more additional policies specified as strings to include in the simulation. If you want to simulate only policies specified as strings, use SimulateCustomPolicy instead.

You can also optionally include one resource-based policy to be evaluated with each of the resources included in the simulation for IAM users only.

The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations.

For cross-account simulations, EvalDecisionDetails returns the decision for each policy type (identity-based policy, resource-based policy, and permissions boundary). This helps you identify which policy type is responsible for an allow or deny decision when policies span multiple accounts.

Note: This operation discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use SimulateCustomPolicy instead.

Context keys are variables maintained by Amazon Web Services and its services that provide details about the context of an API query request. You can use the Condition element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForPrincipalPolicy.

If the output is long, you can use the MaxItems and Marker parameters to paginate the results.

The IAM policy simulator evaluates statements in identity-based policies, service control policies (SCPs) including their condition keys and resource scoping, and the inputs that you provide during simulation. The policy simulator results can differ from your live Amazon Web Services environment. We recommend that you check your policies against your live Amazon Web Services environment after testing using the policy simulator to confirm that you have the desired results. For more information about using the policy simulator, see Testing IAM policies with the IAM policy simulator in the IAM User Guide.

" }, "TagInstanceProfile":{ "name":"TagInstanceProfile", @@ -3199,6 +3199,20 @@ }, "documentation":"

Contains information about an attached policy.

An attached policy is a managed policy that has been attached to a user, group, or role. This data type is used as a response element in the ListAttachedGroupPolicies, ListAttachedRolePolicies, ListAttachedUserPolicies, and GetAccountAuthorizationDetails operations.

For more information about managed policies, refer to Managed policies and inline policies in the IAM User Guide.

" }, + "AttachmentName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\w+=,.@-]+" + }, + "AttachmentType":{ + "type":"string", + "enum":[ + "user", + "group", + "role" + ] + }, "BootstrapDatum":{ "type":"blob", "sensitive":true @@ -4565,7 +4579,7 @@ }, "EvalResourceName":{ "shape":"ResourceNameType", - "documentation":"

The ARN of the resource that the indicated API operation was tested on.

" + "documentation":"

The ARN template for the simulated resource type (for example, arn:${Partition}:s3:::${BucketName}/${KeyName}), or * if no ARN format is defined for the action. This is not a specific customer-provided resource ARN. To find the decision for a specific resource, use ResourceSpecificResults.

If you previously relied on EvalResourceName to identify which specific resource a result applies to, you must now use the EvalResourceName field within individual entries in ResourceSpecificResults instead.

" }, "EvalDecision":{ "shape":"PolicyEvaluationDecisionType", @@ -4573,15 +4587,15 @@ }, "MatchedStatements":{ "shape":"StatementListType", - "documentation":"

A list of the statements in the input policies that determine the result for this scenario. Remember that even if multiple statements allow the operation on the resource, if only one statement denies that operation, then the explicit deny overrides any allow. In addition, the deny statement is the only entry included in the result.

" + "documentation":"

A list of the statements in the input policies that determine the result for this scenario. Remember that even if multiple statements allow the operation on the resource, if only one statement denies that operation, then the explicit deny overrides any allow. In addition, the deny statement is the only entry included in the result.

In the top-level result, this field contains the union of matched statements across all requested resources. Only statements that contributed to the reported decision are included. For per-resource matched statements, see ResourceSpecificResults. This field doesn't include statements from service control policies (SCPs). Only statements from identity-based and resource-based policies appear here.

" }, "MissingContextValues":{ "shape":"ContextKeyNamesResultListType", - "documentation":"

A list of context keys that are required by the included input policies but that were not provided by one of the input parameters. This list is used when the resource in a simulation is \"*\", either explicitly, or when the ResourceArns parameter blank. If you include a list of resources, then any missing context values are instead included under the ResourceSpecificResults section. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.

" + "documentation":"

A list of context keys that are required by the included input policies but that were not provided by one of the input parameters. This list is used when the resource in a simulation is \"*\", either explicitly, or when the ResourceArns parameter blank. If you include a list of resources, then any missing context values are instead included under the ResourceSpecificResults section. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.

In the top-level result, this field contains the deduplicated set of missing context values across all requested resources. This field doesn't include context keys referenced by service control policies (SCPs). Only context keys referenced by identity-based and resource-based policies appear here.

" }, "OrganizationsDecisionDetail":{ "shape":"OrganizationsDecisionDetail", - "documentation":"

A structure that details how Organizations and its service control policies affect the results of the simulation. Only applies if the simulated user's account is part of an organization.

" + "documentation":"

A structure that details how Organizations and its service control policies affect the results of the simulation. Only applies if the simulated user's account is part of an organization.

For resources that don't support organization-level evaluation, this field is omitted from the top-level result. For per-resource details, see ResourceSpecificResults.

" }, "PermissionsBoundaryDecisionDetail":{ "shape":"PermissionsBoundaryDecisionDetail", @@ -4589,14 +4603,14 @@ }, "EvalDecisionDetails":{ "shape":"EvalDecisionDetailsType", - "documentation":"

Additional details about the results of the cross-account evaluation decision. This parameter is populated for only cross-account simulations. It contains a brief summary of how each policy type contributes to the final evaluation decision.

If the simulation evaluates policies within the same account and includes a resource ARN, then the parameter is present but the response is empty. If the simulation evaluates policies within the same account and specifies all resources (*), then the parameter is not returned.

When you make a cross-account request, Amazon Web Services evaluates the request in the trusting account and the trusted account. The request is allowed only if both evaluations return true. For more information about how policies are evaluated, see Evaluating policies within a single account.

If an Organizations SCP included in the evaluation denies access, the simulation ends. In this case, policy evaluation does not proceed any further and this parameter is not returned.

" + "documentation":"

Additional details about the results of the cross-account evaluation decision. This parameter is populated for only cross-account simulations. It contains a brief summary of how each policy type contributes to the final evaluation decision.

In the top-level result, this map reports the most restrictive decision per policy type across all requested resources.

If the simulation evaluates policies within the same account and includes a resource ARN, then the parameter is present but the response is empty. If the simulation evaluates policies within the same account and specifies all resources (*), then the parameter is not returned.

When you make a cross-account request, Amazon Web Services evaluates the request in the trusting account and the trusted account. The request is allowed only if both evaluations return true. For more information about how policies are evaluated, see Evaluating policies within a single account.

If an Organizations SCP included in the evaluation denies access, the simulation ends. In this case, policy evaluation does not proceed any further and this parameter is not returned.

" }, "ResourceSpecificResults":{ "shape":"ResourceSpecificResultListType", "documentation":"

The individual results of the simulation of the API operation specified in EvalActionName on each resource.

" } }, - "documentation":"

Contains the results of a simulation.

This data type is used by the return parameter of SimulateCustomPolicy and SimulatePrincipalPolicy .

" + "documentation":"

Contains the results of a simulation.

This data type is used by the return parameter of SimulateCustomPolicy and SimulatePrincipalPolicy .

The simulator now returns a single EvaluationResult per action, regardless of how many resource ARNs are provided. Previously, simulating one action against N resources returned N evaluation results, each containing the same aggregate decision. The top-level fields (EvalDecision, MatchedStatements, MissingContextValues, EvalDecisionDetails) now represent the aggregate decision across all requested resources. The top-level EvalDecision reflects the most restrictive decision across all resources (for example, if any resource produces explicitDeny, the top-level decision is explicitDeny).

To see the decision for each individual resource, use ResourceSpecificResults. If your application parses evaluation results per resource ARN, update your code to read per-resource decisions from ResourceSpecificResults rather than from the top-level result.

" }, "EvaluationResultsListType":{ "type":"list", @@ -5659,6 +5673,29 @@ }, "documentation":"

Contains information about an IAM group, including all of the group's policies.

This data type is used as a response element in the GetAccountAuthorizationDetails operation.

" }, + "InlinePolicyIdentifierType":{ + "type":"structure", + "required":[ + "PolicyName", + "AttachmentType", + "AttachmentName" + ], + "members":{ + "PolicyName":{ + "shape":"policyNameType", + "documentation":"

The name of the inline policy.

" + }, + "AttachmentType":{ + "shape":"AttachmentType", + "documentation":"

The type of IAM entity that the inline policy is attached to.

" + }, + "AttachmentName":{ + "shape":"AttachmentName", + "documentation":"

The name of the IAM user, group, or role that the inline policy is attached to. Wildcard characters are supported to match multiple entities: use at most one * (matches any sequence of characters, including none), and any number of ? (each matches exactly one character).

" + } + }, + "documentation":"

Identifies one or more inline policies that are embedded in IAM users, groups, or roles, by the name of the policy together with the type and name of the entity that it is attached to. Wildcard characters in the entity name can match multiple entities, so a single identifier can select more than one attached inline policy.

" + }, "InstanceProfile":{ "type":"structure", "required":[ @@ -7260,6 +7297,16 @@ }, "exception":true }, + "OrderedOrganizationPolicyType":{ + "type":"structure", + "members":{ + "ServiceControlPolicyInputList":{ + "shape":"SimulationPolicyListType", + "documentation":"

A list of SCP documents that apply at this level of the Organizations hierarchy. Each document is specified as a string containing the complete, valid JSON text of an SCP.

" + } + }, + "documentation":"

Represents one level of an Organizations hierarchy—the organization root, an organizational unit (OU), or an account—together with the service control policies (SCPs) that apply at that level. Each element in the list represents one level of the hierarchy, ordered from the organization root down to the account.

For more information about SCPs, see Service control policies (SCPs) in the Organizations User Guide.

" + }, "OrganizationIdType":{ "type":"string", "max":34, @@ -7277,6 +7324,11 @@ "documentation":"

The request was rejected because your organization does not have All features enabled. For more information, see Available feature sets in the Organizations User Guide.

", "exception":true }, + "OrganizationPolicyListType":{ + "type":"list", + "member":{"shape":"OrderedOrganizationPolicyType"}, + "max":7 + }, "OrganizationsDecisionDetail":{ "type":"structure", "members":{ @@ -7445,6 +7497,11 @@ }, "exception":true }, + "PolicyExclusionsListType":{ + "type":"list", + "member":{"shape":"PolicyIdentifier"}, + "max":256 + }, "PolicyGrantingServiceAccess":{ "type":"structure", "required":[ @@ -7490,6 +7547,36 @@ "type":"list", "member":{"shape":"PolicyGroup"} }, + "PolicyIdentifier":{ + "type":"structure", + "members":{ + "PolicyType":{ + "shape":"PolicyIdentifierPolicyType", + "documentation":"

The policy type to identify. All policies of the specified type are matched.

" + }, + "PolicyArn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) of an Amazon Web Services managed policy or a customer managed policy that is attached to an IAM user, group, or role. Wildcard characters are supported in the resource name portion of the ARN to match multiple managed policies: use at most one * (matches any sequence of characters, including none), and any number of ? (each matches exactly one character).

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

" + }, + "InlinePolicyIdentifier":{ + "shape":"InlinePolicyIdentifierType", + "documentation":"

An inline policy identifier consisting of a policy name and the entity it is attached to. Wildcard characters (* and ?) in the entity name can match multiple entities.

" + } + }, + "documentation":"

Identifies one or more policies as a union type. Specify exactly one of PolicyType, PolicyArn, or InlinePolicyIdentifier to identify policies by their type, by Amazon Resource Name (ARN), or by the name of an inline policy and the entity it is attached to.

", + "union":true + }, + "PolicyIdentifierPolicyType":{ + "type":"string", + "enum":[ + "inline", + "aws-managed", + "user-managed", + "permission-boundary", + "scp", + "rcp" + ] + }, "PolicyIdentifierType":{"type":"string"}, "PolicyNotAttachableException":{ "type":"structure", @@ -8501,6 +8588,10 @@ "shape":"SimulationPolicyListType", "documentation":"

The IAM permissions boundary policy to simulate. The permissions boundary sets the maximum permissions that an IAM entity can have. You can input only one permissions boundary when you pass a policy to this operation. For more information about permissions boundaries, see Permissions boundaries for IAM entities in the IAM User Guide. The policy input is specified as a string that contains the complete, valid JSON text of a permissions boundary policy.

The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" }, + "OrderedOrganizationPolicyInputList":{ + "shape":"OrganizationPolicyListType", + "documentation":"

An ordered list of service control policies (SCPs) to include in the simulation. Each element represents one level of an Organizations hierarchy, from the organization root to the account.

The simulator evaluates SCPs in the order that you provide, consistent with how Organizations enforces SCPs. The first element must represent the organization root, and the last element must represent the account. Any elements between them represent organizational units (OUs) in descending order.

Use this parameter to simulate the effect of an SCP hierarchy without calling SimulatePrincipalPolicy.

" + }, "ActionNames":{ "shape":"ActionNameListType", "documentation":"

A list of names of API operations to evaluate in the simulation. Each operation is evaluated against each resource. Each operation must include the service identifier, such as iam:CreateUser. This operation does not support using wildcards (*) in an action name.

" @@ -8519,7 +8610,7 @@ }, "CallerArn":{ "shape":"ResourceNameType", - "documentation":"

The ARN of the IAM user that you want to use as the simulated caller of the API operations. CallerArn is required if you include a ResourcePolicy so that the policy's Principal element has a value to use in evaluating the policy.

You can specify only the ARN of an IAM user. You cannot specify the ARN of an assumed role, federated user, or a service principal.

" + "documentation":"

The ARN of the IAM user, group, or role that you want to use as the simulated caller of the API operations. CallerArn is required if you include a ResourcePolicy so that the policy's Principal element has a value to use in evaluating the policy.

You cannot specify the ARN of an assumed role, federated user, or a service principal.

" }, "ContextEntries":{ "shape":"ContextEntryListType", @@ -8576,6 +8667,10 @@ "shape":"SimulationPolicyListType", "documentation":"

The IAM permissions boundary policy to simulate. The permissions boundary sets the maximum permissions that the entity can have. You can input only one permissions boundary when you pass a policy to this operation. An IAM entity can only have one permissions boundary in effect at a time. For example, if a permissions boundary is attached to an entity and you pass in a different permissions boundary policy using this parameter, then the new permissions boundary policy is used for the simulation. For more information about permissions boundaries, see Permissions boundaries for IAM entities in the IAM User Guide. The policy input is specified as a string containing the complete, valid JSON text of a permissions boundary policy.

The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" }, + "PolicyExclusionList":{ + "shape":"PolicyExclusionsListType", + "documentation":"

A list of policies to exclude from the simulation. Use this parameter to test what the simulation result would be if a policy were removed, without changing which policies are actually attached to the principal identified by PolicySourceArn.

Each entry is a PolicyIdentifier that identifies one or more policies to exclude by policy type, by Amazon Resource Name (ARN), or by the name of an inline policy and the entity it is attached to.

Syntactically invalid identifiers, such as malformed ARNs or wildcards in disallowed positions, cause the request to fail with an InvalidInput error. Syntactically valid identifiers that don't match any attached policy are ignored. Resource control policies (RCPs) are not supported in this release; identifiers that target RCPs are also ignored.

" + }, "ActionNames":{ "shape":"ActionNameListType", "documentation":"

A list of names of API operations to evaluate in the simulation. Each operation is evaluated for each resource. Each operation must include the service identifier, such as iam:CreateUser.

" @@ -8594,7 +8689,7 @@ }, "CallerArn":{ "shape":"ResourceNameType", - "documentation":"

The ARN of the IAM user that you want to specify as the simulated caller of the API operations. If you do not specify a CallerArn, it defaults to the ARN of the user that you specify in PolicySourceArn, if you specified a user. If you include both a PolicySourceArn (for example, arn:aws:iam::123456789012:user/David) and a CallerArn (for example, arn:aws:iam::123456789012:user/Bob), the result is that you simulate calling the API operations as Bob, as if Bob had David's policies.

You can specify only the ARN of an IAM user. You cannot specify the ARN of an assumed role, federated user, or a service principal.

CallerArn is required if you include a ResourcePolicy and the PolicySourceArn is not the ARN for an IAM user. This is required so that the resource-based policy's Principal element has a value to use in evaluating the policy.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

" + "documentation":"

The ARN of the IAM user, group, or role that you want to specify as the simulated caller of the API operations. If you do not specify a CallerArn, it defaults to the ARN of the user, group, or role that you specify in PolicySourceArn. If you include both a PolicySourceArn (for example, arn:aws:iam::123456789012:user/David) and a CallerArn (for example, arn:aws:iam::123456789012:user/Bob), the result is that you simulate calling the API operations as Bob, as if Bob had David's policies.

You can specify the ARN of an IAM user, group, or role. You cannot specify the ARN of an assumed role, federated user, or a service principal.

CallerArn is required if you include a ResourcePolicy and the PolicySourceArn is not the ARN for an IAM user, group, or role. This is required so that the resource-based policy's Principal element has a value to use in evaluating the policy.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

" }, "ContextEntries":{ "shape":"ContextEntryListType", diff --git a/tools/code-generation/api-descriptions/iam/2010-05-08/api-2.json b/tools/code-generation/api-descriptions/iam/2010-05-08/api-2.json deleted file mode 100644 index 9a7b80a6269b..000000000000 --- a/tools/code-generation/api-descriptions/iam/2010-05-08/api-2.json +++ /dev/null @@ -1,7258 +0,0 @@ -{ - "version":"2.0", - "metadata":{ - "apiVersion":"2010-05-08", - "endpointPrefix":"iam", - "globalEndpoint":"iam.amazonaws.com", - "protocol":"query", - "protocols":["query"], - "serviceAbbreviation":"IAM", - "serviceFullName":"AWS Identity and Access Management", - "serviceId":"IAM", - "signatureVersion":"v4", - "uid":"iam-2010-05-08", - "xmlNamespace":"https://iam.amazonaws.com/doc/2010-05-08/", - "auth":["aws.auth#sigv4"] - }, - "operations":{ - "AcceptDelegationRequest":{ - "name":"AcceptDelegationRequest", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AcceptDelegationRequestRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"}, - {"shape":"ConcurrentModificationException"} - ] - }, - "AddClientIDToOpenIDConnectProvider":{ - "name":"AddClientIDToOpenIDConnectProvider", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AddClientIDToOpenIDConnectProviderRequest"}, - "errors":[ - {"shape":"ConcurrentModificationException"}, - {"shape":"InvalidInputException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ] - }, - "AddRoleToInstanceProfile":{ - "name":"AddRoleToInstanceProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AddRoleToInstanceProfileRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"EntityAlreadyExistsException"}, - {"shape":"LimitExceededException"}, - {"shape":"UnmodifiableEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "AddUserToGroup":{ - "name":"AddUserToGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AddUserToGroupRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ] - }, - "AssociateDelegationRequest":{ - "name":"AssociateDelegationRequest", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AssociateDelegationRequestRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"InvalidInputException"} - ] - }, - "AttachGroupPolicy":{ - "name":"AttachGroupPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AttachGroupPolicyRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"InvalidInputException"}, - {"shape":"PolicyNotAttachableException"}, - {"shape":"ServiceFailureException"} - ] - }, - "AttachRolePolicy":{ - "name":"AttachRolePolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AttachRolePolicyRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"InvalidInputException"}, - {"shape":"UnmodifiableEntityException"}, - {"shape":"PolicyNotAttachableException"}, - {"shape":"ServiceFailureException"} - ] - }, - "AttachUserPolicy":{ - "name":"AttachUserPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AttachUserPolicyRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"InvalidInputException"}, - {"shape":"PolicyNotAttachableException"}, - {"shape":"ServiceFailureException"} - ] - }, - "ChangePassword":{ - "name":"ChangePassword", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ChangePasswordRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidUserTypeException"}, - {"shape":"LimitExceededException"}, - {"shape":"EntityTemporarilyUnmodifiableException"}, - {"shape":"PasswordPolicyViolationException"}, - {"shape":"ServiceFailureException"} - ] - }, - "CreateAccessKey":{ - "name":"CreateAccessKey", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateAccessKeyRequest"}, - "output":{ - "shape":"CreateAccessKeyResponse", - "resultWrapper":"CreateAccessKeyResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ] - }, - "CreateAccountAlias":{ - "name":"CreateAccountAlias", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateAccountAliasRequest"}, - "errors":[ - {"shape":"ConcurrentModificationException"}, - {"shape":"EntityAlreadyExistsException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ] - }, - "CreateDelegationRequest":{ - "name":"CreateDelegationRequest", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateDelegationRequestRequest"}, - "output":{ - "shape":"CreateDelegationRequestResponse", - "resultWrapper":"CreateDelegationRequestResult" - }, - "errors":[ - {"shape":"EntityAlreadyExistsException"}, - {"shape":"ServiceFailureException"}, - {"shape":"InvalidInputException"}, - {"shape":"LimitExceededException"}, - {"shape":"ConcurrentModificationException"} - ] - }, - "CreateGroup":{ - "name":"CreateGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateGroupRequest"}, - "output":{ - "shape":"CreateGroupResponse", - "resultWrapper":"CreateGroupResult" - }, - "errors":[ - {"shape":"LimitExceededException"}, - {"shape":"EntityAlreadyExistsException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "CreateInstanceProfile":{ - "name":"CreateInstanceProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateInstanceProfileRequest"}, - "output":{ - "shape":"CreateInstanceProfileResponse", - "resultWrapper":"CreateInstanceProfileResult" - }, - "errors":[ - {"shape":"EntityAlreadyExistsException"}, - {"shape":"InvalidInputException"}, - {"shape":"LimitExceededException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ] - }, - "CreateLoginProfile":{ - "name":"CreateLoginProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateLoginProfileRequest"}, - "output":{ - "shape":"CreateLoginProfileResponse", - "resultWrapper":"CreateLoginProfileResult" - }, - "errors":[ - {"shape":"EntityAlreadyExistsException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"PasswordPolicyViolationException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ] - }, - "CreateOpenIDConnectProvider":{ - "name":"CreateOpenIDConnectProvider", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateOpenIDConnectProviderRequest"}, - "output":{ - "shape":"CreateOpenIDConnectProviderResponse", - "resultWrapper":"CreateOpenIDConnectProviderResult" - }, - "errors":[ - {"shape":"InvalidInputException"}, - {"shape":"EntityAlreadyExistsException"}, - {"shape":"LimitExceededException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"}, - {"shape":"OpenIdIdpCommunicationErrorException"} - ] - }, - "CreatePolicy":{ - "name":"CreatePolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreatePolicyRequest"}, - "output":{ - "shape":"CreatePolicyResponse", - "resultWrapper":"CreatePolicyResult" - }, - "errors":[ - {"shape":"InvalidInputException"}, - {"shape":"LimitExceededException"}, - {"shape":"EntityAlreadyExistsException"}, - {"shape":"MalformedPolicyDocumentException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ] - }, - "CreatePolicyVersion":{ - "name":"CreatePolicyVersion", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreatePolicyVersionRequest"}, - "output":{ - "shape":"CreatePolicyVersionResponse", - "resultWrapper":"CreatePolicyVersionResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"MalformedPolicyDocumentException"}, - {"shape":"InvalidInputException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ] - }, - "CreateRole":{ - "name":"CreateRole", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateRoleRequest"}, - "output":{ - "shape":"CreateRoleResponse", - "resultWrapper":"CreateRoleResult" - }, - "errors":[ - {"shape":"LimitExceededException"}, - {"shape":"InvalidInputException"}, - {"shape":"EntityAlreadyExistsException"}, - {"shape":"MalformedPolicyDocumentException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ] - }, - "CreateSAMLProvider":{ - "name":"CreateSAMLProvider", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateSAMLProviderRequest"}, - "output":{ - "shape":"CreateSAMLProviderResponse", - "resultWrapper":"CreateSAMLProviderResult" - }, - "errors":[ - {"shape":"InvalidInputException"}, - {"shape":"EntityAlreadyExistsException"}, - {"shape":"LimitExceededException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ] - }, - "CreateServiceLinkedRole":{ - "name":"CreateServiceLinkedRole", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateServiceLinkedRoleRequest"}, - "output":{ - "shape":"CreateServiceLinkedRoleResponse", - "resultWrapper":"CreateServiceLinkedRoleResult" - }, - "errors":[ - {"shape":"InvalidInputException"}, - {"shape":"LimitExceededException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "CreateServiceSpecificCredential":{ - "name":"CreateServiceSpecificCredential", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateServiceSpecificCredentialRequest"}, - "output":{ - "shape":"CreateServiceSpecificCredentialResponse", - "resultWrapper":"CreateServiceSpecificCredentialResult" - }, - "errors":[ - {"shape":"LimitExceededException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceNotSupportedException"} - ] - }, - "CreateUser":{ - "name":"CreateUser", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateUserRequest"}, - "output":{ - "shape":"CreateUserResponse", - "resultWrapper":"CreateUserResult" - }, - "errors":[ - {"shape":"LimitExceededException"}, - {"shape":"EntityAlreadyExistsException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ] - }, - "CreateVirtualMFADevice":{ - "name":"CreateVirtualMFADevice", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateVirtualMFADeviceRequest"}, - "output":{ - "shape":"CreateVirtualMFADeviceResponse", - "resultWrapper":"CreateVirtualMFADeviceResult" - }, - "errors":[ - {"shape":"LimitExceededException"}, - {"shape":"InvalidInputException"}, - {"shape":"EntityAlreadyExistsException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ] - }, - "DeactivateMFADevice":{ - "name":"DeactivateMFADevice", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeactivateMFADeviceRequest"}, - "errors":[ - {"shape":"EntityTemporarilyUnmodifiableException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"}, - {"shape":"ConcurrentModificationException"} - ] - }, - "DeleteAccessKey":{ - "name":"DeleteAccessKey", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteAccessKeyRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ] - }, - "DeleteAccountAlias":{ - "name":"DeleteAccountAlias", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteAccountAliasRequest"}, - "errors":[ - {"shape":"ConcurrentModificationException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ] - }, - "DeleteAccountPasswordPolicy":{ - "name":"DeleteAccountPasswordPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ] - }, - "DeleteGroup":{ - "name":"DeleteGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteGroupRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"DeleteConflictException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ] - }, - "DeleteGroupPolicy":{ - "name":"DeleteGroupPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteGroupPolicyRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ] - }, - "DeleteInstanceProfile":{ - "name":"DeleteInstanceProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteInstanceProfileRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"DeleteConflictException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ] - }, - "DeleteLoginProfile":{ - "name":"DeleteLoginProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteLoginProfileRequest"}, - "errors":[ - {"shape":"EntityTemporarilyUnmodifiableException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ] - }, - "DeleteOpenIDConnectProvider":{ - "name":"DeleteOpenIDConnectProvider", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteOpenIDConnectProviderRequest"}, - "errors":[ - {"shape":"InvalidInputException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "DeletePolicy":{ - "name":"DeletePolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeletePolicyRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"InvalidInputException"}, - {"shape":"DeleteConflictException"}, - {"shape":"ServiceFailureException"} - ] - }, - "DeletePolicyVersion":{ - "name":"DeletePolicyVersion", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeletePolicyVersionRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"InvalidInputException"}, - {"shape":"DeleteConflictException"}, - {"shape":"ServiceFailureException"} - ] - }, - "DeleteRole":{ - "name":"DeleteRole", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteRoleRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"DeleteConflictException"}, - {"shape":"LimitExceededException"}, - {"shape":"UnmodifiableEntityException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ] - }, - "DeleteRolePermissionsBoundary":{ - "name":"DeleteRolePermissionsBoundary", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteRolePermissionsBoundaryRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"UnmodifiableEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "DeleteRolePolicy":{ - "name":"DeleteRolePolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteRolePolicyRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"UnmodifiableEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "DeleteSAMLProvider":{ - "name":"DeleteSAMLProvider", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteSAMLProviderRequest"}, - "errors":[ - {"shape":"InvalidInputException"}, - {"shape":"LimitExceededException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "DeleteSSHPublicKey":{ - "name":"DeleteSSHPublicKey", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteSSHPublicKeyRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"} - ] - }, - "DeleteServerCertificate":{ - "name":"DeleteServerCertificate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteServerCertificateRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"DeleteConflictException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ] - }, - "DeleteServiceLinkedRole":{ - "name":"DeleteServiceLinkedRole", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteServiceLinkedRoleRequest"}, - "output":{ - "shape":"DeleteServiceLinkedRoleResponse", - "resultWrapper":"DeleteServiceLinkedRoleResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ] - }, - "DeleteServiceSpecificCredential":{ - "name":"DeleteServiceSpecificCredential", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteServiceSpecificCredentialRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"} - ] - }, - "DeleteSigningCertificate":{ - "name":"DeleteSigningCertificate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteSigningCertificateRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ] - }, - "DeleteUser":{ - "name":"DeleteUser", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteUserRequest"}, - "errors":[ - {"shape":"LimitExceededException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"DeleteConflictException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ] - }, - "DeleteUserPermissionsBoundary":{ - "name":"DeleteUserPermissionsBoundary", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteUserPermissionsBoundaryRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "DeleteUserPolicy":{ - "name":"DeleteUserPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteUserPolicyRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ] - }, - "DeleteVirtualMFADevice":{ - "name":"DeleteVirtualMFADevice", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteVirtualMFADeviceRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"DeleteConflictException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"}, - {"shape":"ConcurrentModificationException"} - ] - }, - "DetachGroupPolicy":{ - "name":"DetachGroupPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DetachGroupPolicyRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"InvalidInputException"}, - {"shape":"ServiceFailureException"} - ] - }, - "DetachRolePolicy":{ - "name":"DetachRolePolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DetachRolePolicyRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"InvalidInputException"}, - {"shape":"UnmodifiableEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "DetachUserPolicy":{ - "name":"DetachUserPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DetachUserPolicyRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"InvalidInputException"}, - {"shape":"ServiceFailureException"} - ] - }, - "DisableOrganizationsRootCredentialsManagement":{ - "name":"DisableOrganizationsRootCredentialsManagement", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DisableOrganizationsRootCredentialsManagementRequest"}, - "output":{ - "shape":"DisableOrganizationsRootCredentialsManagementResponse", - "resultWrapper":"DisableOrganizationsRootCredentialsManagementResult" - }, - "errors":[ - {"shape":"ServiceAccessNotEnabledException"}, - {"shape":"AccountNotManagementOrDelegatedAdministratorException"}, - {"shape":"OrganizationNotFoundException"}, - {"shape":"OrganizationNotInAllFeaturesModeException"} - ] - }, - "DisableOrganizationsRootSessions":{ - "name":"DisableOrganizationsRootSessions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DisableOrganizationsRootSessionsRequest"}, - "output":{ - "shape":"DisableOrganizationsRootSessionsResponse", - "resultWrapper":"DisableOrganizationsRootSessionsResult" - }, - "errors":[ - {"shape":"ServiceAccessNotEnabledException"}, - {"shape":"AccountNotManagementOrDelegatedAdministratorException"}, - {"shape":"OrganizationNotFoundException"}, - {"shape":"OrganizationNotInAllFeaturesModeException"} - ] - }, - "DisableOutboundWebIdentityFederation":{ - "name":"DisableOutboundWebIdentityFederation", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "errors":[ - {"shape":"FeatureDisabledException"} - ] - }, - "EnableMFADevice":{ - "name":"EnableMFADevice", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"EnableMFADeviceRequest"}, - "errors":[ - {"shape":"EntityAlreadyExistsException"}, - {"shape":"EntityTemporarilyUnmodifiableException"}, - {"shape":"InvalidAuthenticationCodeException"}, - {"shape":"LimitExceededException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"}, - {"shape":"ConcurrentModificationException"} - ] - }, - "EnableOrganizationsRootCredentialsManagement":{ - "name":"EnableOrganizationsRootCredentialsManagement", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"EnableOrganizationsRootCredentialsManagementRequest"}, - "output":{ - "shape":"EnableOrganizationsRootCredentialsManagementResponse", - "resultWrapper":"EnableOrganizationsRootCredentialsManagementResult" - }, - "errors":[ - {"shape":"ServiceAccessNotEnabledException"}, - {"shape":"AccountNotManagementOrDelegatedAdministratorException"}, - {"shape":"OrganizationNotFoundException"}, - {"shape":"OrganizationNotInAllFeaturesModeException"}, - {"shape":"CallerIsNotManagementAccountException"} - ] - }, - "EnableOrganizationsRootSessions":{ - "name":"EnableOrganizationsRootSessions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"EnableOrganizationsRootSessionsRequest"}, - "output":{ - "shape":"EnableOrganizationsRootSessionsResponse", - "resultWrapper":"EnableOrganizationsRootSessionsResult" - }, - "errors":[ - {"shape":"ServiceAccessNotEnabledException"}, - {"shape":"AccountNotManagementOrDelegatedAdministratorException"}, - {"shape":"OrganizationNotFoundException"}, - {"shape":"OrganizationNotInAllFeaturesModeException"}, - {"shape":"CallerIsNotManagementAccountException"} - ] - }, - "EnableOutboundWebIdentityFederation":{ - "name":"EnableOutboundWebIdentityFederation", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "output":{ - "shape":"EnableOutboundWebIdentityFederationResponse", - "resultWrapper":"EnableOutboundWebIdentityFederationResult" - }, - "errors":[ - {"shape":"FeatureEnabledException"} - ] - }, - "GenerateCredentialReport":{ - "name":"GenerateCredentialReport", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "output":{ - "shape":"GenerateCredentialReportResponse", - "resultWrapper":"GenerateCredentialReportResult" - }, - "errors":[ - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ] - }, - "GenerateOrganizationsAccessReport":{ - "name":"GenerateOrganizationsAccessReport", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GenerateOrganizationsAccessReportRequest"}, - "output":{ - "shape":"GenerateOrganizationsAccessReportResponse", - "resultWrapper":"GenerateOrganizationsAccessReportResult" - }, - "errors":[ - {"shape":"ReportGenerationLimitExceededException"} - ] - }, - "GenerateServiceLastAccessedDetails":{ - "name":"GenerateServiceLastAccessedDetails", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GenerateServiceLastAccessedDetailsRequest"}, - "output":{ - "shape":"GenerateServiceLastAccessedDetailsResponse", - "resultWrapper":"GenerateServiceLastAccessedDetailsResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"} - ] - }, - "GetAccessKeyLastUsed":{ - "name":"GetAccessKeyLastUsed", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetAccessKeyLastUsedRequest"}, - "output":{ - "shape":"GetAccessKeyLastUsedResponse", - "resultWrapper":"GetAccessKeyLastUsedResult" - } - }, - "GetAccountAuthorizationDetails":{ - "name":"GetAccountAuthorizationDetails", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetAccountAuthorizationDetailsRequest"}, - "output":{ - "shape":"GetAccountAuthorizationDetailsResponse", - "resultWrapper":"GetAccountAuthorizationDetailsResult" - }, - "errors":[ - {"shape":"ServiceFailureException"} - ] - }, - "GetAccountPasswordPolicy":{ - "name":"GetAccountPasswordPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "output":{ - "shape":"GetAccountPasswordPolicyResponse", - "resultWrapper":"GetAccountPasswordPolicyResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "GetAccountSummary":{ - "name":"GetAccountSummary", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "output":{ - "shape":"GetAccountSummaryResponse", - "resultWrapper":"GetAccountSummaryResult" - }, - "errors":[ - {"shape":"ServiceFailureException"} - ] - }, - "GetContextKeysForCustomPolicy":{ - "name":"GetContextKeysForCustomPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetContextKeysForCustomPolicyRequest"}, - "output":{ - "shape":"GetContextKeysForPolicyResponse", - "resultWrapper":"GetContextKeysForCustomPolicyResult" - }, - "errors":[ - {"shape":"InvalidInputException"} - ] - }, - "GetContextKeysForPrincipalPolicy":{ - "name":"GetContextKeysForPrincipalPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetContextKeysForPrincipalPolicyRequest"}, - "output":{ - "shape":"GetContextKeysForPolicyResponse", - "resultWrapper":"GetContextKeysForPrincipalPolicyResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"} - ] - }, - "GetCredentialReport":{ - "name":"GetCredentialReport", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "output":{ - "shape":"GetCredentialReportResponse", - "resultWrapper":"GetCredentialReportResult" - }, - "errors":[ - {"shape":"CredentialReportNotPresentException"}, - {"shape":"CredentialReportExpiredException"}, - {"shape":"CredentialReportNotReadyException"}, - {"shape":"ServiceFailureException"} - ] - }, - "GetDelegationRequest":{ - "name":"GetDelegationRequest", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetDelegationRequestRequest"}, - "output":{ - "shape":"GetDelegationRequestResponse", - "resultWrapper":"GetDelegationRequestResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "GetGroup":{ - "name":"GetGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetGroupRequest"}, - "output":{ - "shape":"GetGroupResponse", - "resultWrapper":"GetGroupResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "GetGroupPolicy":{ - "name":"GetGroupPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetGroupPolicyRequest"}, - "output":{ - "shape":"GetGroupPolicyResponse", - "resultWrapper":"GetGroupPolicyResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "GetHumanReadableSummary":{ - "name":"GetHumanReadableSummary", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetHumanReadableSummaryRequest"}, - "output":{ - "shape":"GetHumanReadableSummaryResponse", - "resultWrapper":"GetHumanReadableSummaryResult" - }, - "errors":[ - {"shape":"InvalidInputException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "GetInstanceProfile":{ - "name":"GetInstanceProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetInstanceProfileRequest"}, - "output":{ - "shape":"GetInstanceProfileResponse", - "resultWrapper":"GetInstanceProfileResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "GetLoginProfile":{ - "name":"GetLoginProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetLoginProfileRequest"}, - "output":{ - "shape":"GetLoginProfileResponse", - "resultWrapper":"GetLoginProfileResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "GetMFADevice":{ - "name":"GetMFADevice", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetMFADeviceRequest"}, - "output":{ - "shape":"GetMFADeviceResponse", - "resultWrapper":"GetMFADeviceResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "GetOpenIDConnectProvider":{ - "name":"GetOpenIDConnectProvider", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetOpenIDConnectProviderRequest"}, - "output":{ - "shape":"GetOpenIDConnectProviderResponse", - "resultWrapper":"GetOpenIDConnectProviderResult" - }, - "errors":[ - {"shape":"InvalidInputException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "GetOrganizationsAccessReport":{ - "name":"GetOrganizationsAccessReport", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetOrganizationsAccessReportRequest"}, - "output":{ - "shape":"GetOrganizationsAccessReportResponse", - "resultWrapper":"GetOrganizationsAccessReportResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"} - ] - }, - "GetOutboundWebIdentityFederationInfo":{ - "name":"GetOutboundWebIdentityFederationInfo", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "output":{ - "shape":"GetOutboundWebIdentityFederationInfoResponse", - "resultWrapper":"GetOutboundWebIdentityFederationInfoResult" - }, - "errors":[ - {"shape":"FeatureDisabledException"} - ] - }, - "GetPolicy":{ - "name":"GetPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetPolicyRequest"}, - "output":{ - "shape":"GetPolicyResponse", - "resultWrapper":"GetPolicyResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"ServiceFailureException"} - ] - }, - "GetPolicyVersion":{ - "name":"GetPolicyVersion", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetPolicyVersionRequest"}, - "output":{ - "shape":"GetPolicyVersionResponse", - "resultWrapper":"GetPolicyVersionResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"ServiceFailureException"} - ] - }, - "GetRole":{ - "name":"GetRole", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetRoleRequest"}, - "output":{ - "shape":"GetRoleResponse", - "resultWrapper":"GetRoleResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "GetRolePolicy":{ - "name":"GetRolePolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetRolePolicyRequest"}, - "output":{ - "shape":"GetRolePolicyResponse", - "resultWrapper":"GetRolePolicyResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "GetSAMLProvider":{ - "name":"GetSAMLProvider", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetSAMLProviderRequest"}, - "output":{ - "shape":"GetSAMLProviderResponse", - "resultWrapper":"GetSAMLProviderResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"ServiceFailureException"} - ] - }, - "GetSSHPublicKey":{ - "name":"GetSSHPublicKey", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetSSHPublicKeyRequest"}, - "output":{ - "shape":"GetSSHPublicKeyResponse", - "resultWrapper":"GetSSHPublicKeyResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"UnrecognizedPublicKeyEncodingException"} - ] - }, - "GetServerCertificate":{ - "name":"GetServerCertificate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetServerCertificateRequest"}, - "output":{ - "shape":"GetServerCertificateResponse", - "resultWrapper":"GetServerCertificateResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "GetServiceLastAccessedDetails":{ - "name":"GetServiceLastAccessedDetails", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetServiceLastAccessedDetailsRequest"}, - "output":{ - "shape":"GetServiceLastAccessedDetailsResponse", - "resultWrapper":"GetServiceLastAccessedDetailsResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"} - ] - }, - "GetServiceLastAccessedDetailsWithEntities":{ - "name":"GetServiceLastAccessedDetailsWithEntities", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetServiceLastAccessedDetailsWithEntitiesRequest"}, - "output":{ - "shape":"GetServiceLastAccessedDetailsWithEntitiesResponse", - "resultWrapper":"GetServiceLastAccessedDetailsWithEntitiesResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"} - ] - }, - "GetServiceLinkedRoleDeletionStatus":{ - "name":"GetServiceLinkedRoleDeletionStatus", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetServiceLinkedRoleDeletionStatusRequest"}, - "output":{ - "shape":"GetServiceLinkedRoleDeletionStatusResponse", - "resultWrapper":"GetServiceLinkedRoleDeletionStatusResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"ServiceFailureException"} - ] - }, - "GetUser":{ - "name":"GetUser", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetUserRequest"}, - "output":{ - "shape":"GetUserResponse", - "resultWrapper":"GetUserResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "GetUserPolicy":{ - "name":"GetUserPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetUserPolicyRequest"}, - "output":{ - "shape":"GetUserPolicyResponse", - "resultWrapper":"GetUserPolicyResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "ListAccessKeys":{ - "name":"ListAccessKeys", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListAccessKeysRequest"}, - "output":{ - "shape":"ListAccessKeysResponse", - "resultWrapper":"ListAccessKeysResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "ListAccountAliases":{ - "name":"ListAccountAliases", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListAccountAliasesRequest"}, - "output":{ - "shape":"ListAccountAliasesResponse", - "resultWrapper":"ListAccountAliasesResult" - }, - "errors":[ - {"shape":"ServiceFailureException"} - ] - }, - "ListAttachedGroupPolicies":{ - "name":"ListAttachedGroupPolicies", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListAttachedGroupPoliciesRequest"}, - "output":{ - "shape":"ListAttachedGroupPoliciesResponse", - "resultWrapper":"ListAttachedGroupPoliciesResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"ServiceFailureException"} - ] - }, - "ListAttachedRolePolicies":{ - "name":"ListAttachedRolePolicies", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListAttachedRolePoliciesRequest"}, - "output":{ - "shape":"ListAttachedRolePoliciesResponse", - "resultWrapper":"ListAttachedRolePoliciesResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"ServiceFailureException"} - ] - }, - "ListAttachedUserPolicies":{ - "name":"ListAttachedUserPolicies", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListAttachedUserPoliciesRequest"}, - "output":{ - "shape":"ListAttachedUserPoliciesResponse", - "resultWrapper":"ListAttachedUserPoliciesResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"ServiceFailureException"} - ] - }, - "ListDelegationRequests":{ - "name":"ListDelegationRequests", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListDelegationRequestsRequest"}, - "output":{ - "shape":"ListDelegationRequestsResponse", - "resultWrapper":"ListDelegationRequestsResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"}, - {"shape":"InvalidInputException"} - ] - }, - "ListEntitiesForPolicy":{ - "name":"ListEntitiesForPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListEntitiesForPolicyRequest"}, - "output":{ - "shape":"ListEntitiesForPolicyResponse", - "resultWrapper":"ListEntitiesForPolicyResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"ServiceFailureException"} - ] - }, - "ListGroupPolicies":{ - "name":"ListGroupPolicies", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListGroupPoliciesRequest"}, - "output":{ - "shape":"ListGroupPoliciesResponse", - "resultWrapper":"ListGroupPoliciesResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "ListGroups":{ - "name":"ListGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListGroupsRequest"}, - "output":{ - "shape":"ListGroupsResponse", - "resultWrapper":"ListGroupsResult" - }, - "errors":[ - {"shape":"ServiceFailureException"} - ] - }, - "ListGroupsForUser":{ - "name":"ListGroupsForUser", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListGroupsForUserRequest"}, - "output":{ - "shape":"ListGroupsForUserResponse", - "resultWrapper":"ListGroupsForUserResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "ListInstanceProfileTags":{ - "name":"ListInstanceProfileTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListInstanceProfileTagsRequest"}, - "output":{ - "shape":"ListInstanceProfileTagsResponse", - "resultWrapper":"ListInstanceProfileTagsResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "ListInstanceProfiles":{ - "name":"ListInstanceProfiles", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListInstanceProfilesRequest"}, - "output":{ - "shape":"ListInstanceProfilesResponse", - "resultWrapper":"ListInstanceProfilesResult" - }, - "errors":[ - {"shape":"ServiceFailureException"} - ] - }, - "ListInstanceProfilesForRole":{ - "name":"ListInstanceProfilesForRole", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListInstanceProfilesForRoleRequest"}, - "output":{ - "shape":"ListInstanceProfilesForRoleResponse", - "resultWrapper":"ListInstanceProfilesForRoleResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "ListMFADeviceTags":{ - "name":"ListMFADeviceTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListMFADeviceTagsRequest"}, - "output":{ - "shape":"ListMFADeviceTagsResponse", - "resultWrapper":"ListMFADeviceTagsResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"ServiceFailureException"} - ] - }, - "ListMFADevices":{ - "name":"ListMFADevices", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListMFADevicesRequest"}, - "output":{ - "shape":"ListMFADevicesResponse", - "resultWrapper":"ListMFADevicesResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "ListOpenIDConnectProviderTags":{ - "name":"ListOpenIDConnectProviderTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListOpenIDConnectProviderTagsRequest"}, - "output":{ - "shape":"ListOpenIDConnectProviderTagsResponse", - "resultWrapper":"ListOpenIDConnectProviderTagsResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"}, - {"shape":"InvalidInputException"} - ] - }, - "ListOpenIDConnectProviders":{ - "name":"ListOpenIDConnectProviders", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListOpenIDConnectProvidersRequest"}, - "output":{ - "shape":"ListOpenIDConnectProvidersResponse", - "resultWrapper":"ListOpenIDConnectProvidersResult" - }, - "errors":[ - {"shape":"ServiceFailureException"} - ] - }, - "ListOrganizationsFeatures":{ - "name":"ListOrganizationsFeatures", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListOrganizationsFeaturesRequest"}, - "output":{ - "shape":"ListOrganizationsFeaturesResponse", - "resultWrapper":"ListOrganizationsFeaturesResult" - }, - "errors":[ - {"shape":"ServiceAccessNotEnabledException"}, - {"shape":"AccountNotManagementOrDelegatedAdministratorException"}, - {"shape":"OrganizationNotFoundException"}, - {"shape":"OrganizationNotInAllFeaturesModeException"} - ] - }, - "ListPolicies":{ - "name":"ListPolicies", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListPoliciesRequest"}, - "output":{ - "shape":"ListPoliciesResponse", - "resultWrapper":"ListPoliciesResult" - }, - "errors":[ - {"shape":"ServiceFailureException"} - ] - }, - "ListPoliciesGrantingServiceAccess":{ - "name":"ListPoliciesGrantingServiceAccess", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListPoliciesGrantingServiceAccessRequest"}, - "output":{ - "shape":"ListPoliciesGrantingServiceAccessResponse", - "resultWrapper":"ListPoliciesGrantingServiceAccessResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"} - ] - }, - "ListPolicyTags":{ - "name":"ListPolicyTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListPolicyTagsRequest"}, - "output":{ - "shape":"ListPolicyTagsResponse", - "resultWrapper":"ListPolicyTagsResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"}, - {"shape":"InvalidInputException"} - ] - }, - "ListPolicyVersions":{ - "name":"ListPolicyVersions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListPolicyVersionsRequest"}, - "output":{ - "shape":"ListPolicyVersionsResponse", - "resultWrapper":"ListPolicyVersionsResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"ServiceFailureException"} - ] - }, - "ListRolePolicies":{ - "name":"ListRolePolicies", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListRolePoliciesRequest"}, - "output":{ - "shape":"ListRolePoliciesResponse", - "resultWrapper":"ListRolePoliciesResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "ListRoleTags":{ - "name":"ListRoleTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListRoleTagsRequest"}, - "output":{ - "shape":"ListRoleTagsResponse", - "resultWrapper":"ListRoleTagsResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "ListRoles":{ - "name":"ListRoles", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListRolesRequest"}, - "output":{ - "shape":"ListRolesResponse", - "resultWrapper":"ListRolesResult" - }, - "errors":[ - {"shape":"ServiceFailureException"} - ] - }, - "ListSAMLProviderTags":{ - "name":"ListSAMLProviderTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListSAMLProviderTagsRequest"}, - "output":{ - "shape":"ListSAMLProviderTagsResponse", - "resultWrapper":"ListSAMLProviderTagsResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"}, - {"shape":"InvalidInputException"} - ] - }, - "ListSAMLProviders":{ - "name":"ListSAMLProviders", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListSAMLProvidersRequest"}, - "output":{ - "shape":"ListSAMLProvidersResponse", - "resultWrapper":"ListSAMLProvidersResult" - }, - "errors":[ - {"shape":"ServiceFailureException"} - ] - }, - "ListSSHPublicKeys":{ - "name":"ListSSHPublicKeys", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListSSHPublicKeysRequest"}, - "output":{ - "shape":"ListSSHPublicKeysResponse", - "resultWrapper":"ListSSHPublicKeysResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"} - ] - }, - "ListServerCertificateTags":{ - "name":"ListServerCertificateTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListServerCertificateTagsRequest"}, - "output":{ - "shape":"ListServerCertificateTagsResponse", - "resultWrapper":"ListServerCertificateTagsResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "ListServerCertificates":{ - "name":"ListServerCertificates", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListServerCertificatesRequest"}, - "output":{ - "shape":"ListServerCertificatesResponse", - "resultWrapper":"ListServerCertificatesResult" - }, - "errors":[ - {"shape":"ServiceFailureException"} - ] - }, - "ListServiceSpecificCredentials":{ - "name":"ListServiceSpecificCredentials", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListServiceSpecificCredentialsRequest"}, - "output":{ - "shape":"ListServiceSpecificCredentialsResponse", - "resultWrapper":"ListServiceSpecificCredentialsResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceNotSupportedException"} - ] - }, - "ListSigningCertificates":{ - "name":"ListSigningCertificates", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListSigningCertificatesRequest"}, - "output":{ - "shape":"ListSigningCertificatesResponse", - "resultWrapper":"ListSigningCertificatesResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "ListUserPolicies":{ - "name":"ListUserPolicies", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListUserPoliciesRequest"}, - "output":{ - "shape":"ListUserPoliciesResponse", - "resultWrapper":"ListUserPoliciesResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "ListUserTags":{ - "name":"ListUserTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListUserTagsRequest"}, - "output":{ - "shape":"ListUserTagsResponse", - "resultWrapper":"ListUserTagsResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "ListUsers":{ - "name":"ListUsers", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListUsersRequest"}, - "output":{ - "shape":"ListUsersResponse", - "resultWrapper":"ListUsersResult" - }, - "errors":[ - {"shape":"ServiceFailureException"} - ] - }, - "ListVirtualMFADevices":{ - "name":"ListVirtualMFADevices", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListVirtualMFADevicesRequest"}, - "output":{ - "shape":"ListVirtualMFADevicesResponse", - "resultWrapper":"ListVirtualMFADevicesResult" - } - }, - "PutGroupPolicy":{ - "name":"PutGroupPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"PutGroupPolicyRequest"}, - "errors":[ - {"shape":"LimitExceededException"}, - {"shape":"MalformedPolicyDocumentException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "PutRolePermissionsBoundary":{ - "name":"PutRolePermissionsBoundary", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"PutRolePermissionsBoundaryRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"UnmodifiableEntityException"}, - {"shape":"PolicyNotAttachableException"}, - {"shape":"ServiceFailureException"} - ] - }, - "PutRolePolicy":{ - "name":"PutRolePolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"PutRolePolicyRequest"}, - "errors":[ - {"shape":"LimitExceededException"}, - {"shape":"MalformedPolicyDocumentException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"UnmodifiableEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "PutUserPermissionsBoundary":{ - "name":"PutUserPermissionsBoundary", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"PutUserPermissionsBoundaryRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"PolicyNotAttachableException"}, - {"shape":"ServiceFailureException"} - ] - }, - "PutUserPolicy":{ - "name":"PutUserPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"PutUserPolicyRequest"}, - "errors":[ - {"shape":"LimitExceededException"}, - {"shape":"MalformedPolicyDocumentException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "RejectDelegationRequest":{ - "name":"RejectDelegationRequest", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RejectDelegationRequestRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"InvalidInputException"} - ] - }, - "RemoveClientIDFromOpenIDConnectProvider":{ - "name":"RemoveClientIDFromOpenIDConnectProvider", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RemoveClientIDFromOpenIDConnectProviderRequest"}, - "errors":[ - {"shape":"ConcurrentModificationException"}, - {"shape":"InvalidInputException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "RemoveRoleFromInstanceProfile":{ - "name":"RemoveRoleFromInstanceProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RemoveRoleFromInstanceProfileRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"UnmodifiableEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "RemoveUserFromGroup":{ - "name":"RemoveUserFromGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RemoveUserFromGroupRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ] - }, - "ResetServiceSpecificCredential":{ - "name":"ResetServiceSpecificCredential", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ResetServiceSpecificCredentialRequest"}, - "output":{ - "shape":"ResetServiceSpecificCredentialResponse", - "resultWrapper":"ResetServiceSpecificCredentialResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"} - ] - }, - "ResyncMFADevice":{ - "name":"ResyncMFADevice", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ResyncMFADeviceRequest"}, - "errors":[ - {"shape":"InvalidAuthenticationCodeException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"}, - {"shape":"ConcurrentModificationException"} - ] - }, - "SendDelegationToken":{ - "name":"SendDelegationToken", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"SendDelegationTokenRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"InvalidInputException"} - ] - }, - "SetDefaultPolicyVersion":{ - "name":"SetDefaultPolicyVersion", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"SetDefaultPolicyVersionRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ] - }, - "SetSecurityTokenServicePreferences":{ - "name":"SetSecurityTokenServicePreferences", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"SetSecurityTokenServicePreferencesRequest"}, - "errors":[ - {"shape":"ServiceFailureException"} - ] - }, - "SimulateCustomPolicy":{ - "name":"SimulateCustomPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"SimulateCustomPolicyRequest"}, - "output":{ - "shape":"SimulatePolicyResponse", - "resultWrapper":"SimulateCustomPolicyResult" - }, - "errors":[ - {"shape":"InvalidInputException"}, - {"shape":"PolicyEvaluationException"} - ] - }, - "SimulatePrincipalPolicy":{ - "name":"SimulatePrincipalPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"SimulatePrincipalPolicyRequest"}, - "output":{ - "shape":"SimulatePolicyResponse", - "resultWrapper":"SimulatePrincipalPolicyResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"PolicyEvaluationException"} - ] - }, - "TagInstanceProfile":{ - "name":"TagInstanceProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"TagInstanceProfileRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"LimitExceededException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ] - }, - "TagMFADevice":{ - "name":"TagMFADevice", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"TagMFADeviceRequest"}, - "errors":[ - {"shape":"InvalidInputException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ] - }, - "TagOpenIDConnectProvider":{ - "name":"TagOpenIDConnectProvider", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"TagOpenIDConnectProviderRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"InvalidInputException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ] - }, - "TagPolicy":{ - "name":"TagPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"TagPolicyRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"InvalidInputException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ] - }, - "TagRole":{ - "name":"TagRole", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"TagRoleRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"InvalidInputException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ] - }, - "TagSAMLProvider":{ - "name":"TagSAMLProvider", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"TagSAMLProviderRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"InvalidInputException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ] - }, - "TagServerCertificate":{ - "name":"TagServerCertificate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"TagServerCertificateRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"LimitExceededException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ] - }, - "TagUser":{ - "name":"TagUser", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"TagUserRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"InvalidInputException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ] - }, - "UntagInstanceProfile":{ - "name":"UntagInstanceProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UntagInstanceProfileRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ] - }, - "UntagMFADevice":{ - "name":"UntagMFADevice", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UntagMFADeviceRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ] - }, - "UntagOpenIDConnectProvider":{ - "name":"UntagOpenIDConnectProvider", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UntagOpenIDConnectProviderRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ] - }, - "UntagPolicy":{ - "name":"UntagPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UntagPolicyRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ] - }, - "UntagRole":{ - "name":"UntagRole", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UntagRoleRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ] - }, - "UntagSAMLProvider":{ - "name":"UntagSAMLProvider", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UntagSAMLProviderRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ] - }, - "UntagServerCertificate":{ - "name":"UntagServerCertificate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UntagServerCertificateRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ] - }, - "UntagUser":{ - "name":"UntagUser", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UntagUserRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ] - }, - "UpdateAccessKey":{ - "name":"UpdateAccessKey", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateAccessKeyRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"}, - {"shape":"InvalidInputException"} - ] - }, - "UpdateAccountPasswordPolicy":{ - "name":"UpdateAccountPasswordPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateAccountPasswordPolicyRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"MalformedPolicyDocumentException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ] - }, - "UpdateAssumeRolePolicy":{ - "name":"UpdateAssumeRolePolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateAssumeRolePolicyRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"MalformedPolicyDocumentException"}, - {"shape":"LimitExceededException"}, - {"shape":"UnmodifiableEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "UpdateDelegationRequest":{ - "name":"UpdateDelegationRequest", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateDelegationRequestRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"InvalidInputException"} - ] - }, - "UpdateGroup":{ - "name":"UpdateGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateGroupRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"EntityAlreadyExistsException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ] - }, - "UpdateLoginProfile":{ - "name":"UpdateLoginProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateLoginProfileRequest"}, - "errors":[ - {"shape":"EntityTemporarilyUnmodifiableException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"PasswordPolicyViolationException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ] - }, - "UpdateOpenIDConnectProviderThumbprint":{ - "name":"UpdateOpenIDConnectProviderThumbprint", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateOpenIDConnectProviderThumbprintRequest"}, - "errors":[ - {"shape":"ConcurrentModificationException"}, - {"shape":"InvalidInputException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "UpdateRole":{ - "name":"UpdateRole", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateRoleRequest"}, - "output":{ - "shape":"UpdateRoleResponse", - "resultWrapper":"UpdateRoleResult" - }, - "errors":[ - {"shape":"UnmodifiableEntityException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "UpdateRoleDescription":{ - "name":"UpdateRoleDescription", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateRoleDescriptionRequest"}, - "output":{ - "shape":"UpdateRoleDescriptionResponse", - "resultWrapper":"UpdateRoleDescriptionResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"UnmodifiableEntityException"}, - {"shape":"ServiceFailureException"} - ] - }, - "UpdateSAMLProvider":{ - "name":"UpdateSAMLProvider", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateSAMLProviderRequest"}, - "output":{ - "shape":"UpdateSAMLProviderResponse", - "resultWrapper":"UpdateSAMLProviderResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"}, - {"shape":"ConcurrentModificationException"} - ] - }, - "UpdateSSHPublicKey":{ - "name":"UpdateSSHPublicKey", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateSSHPublicKeyRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"} - ] - }, - "UpdateServerCertificate":{ - "name":"UpdateServerCertificate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateServerCertificateRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"EntityAlreadyExistsException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ] - }, - "UpdateServiceSpecificCredential":{ - "name":"UpdateServiceSpecificCredential", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateServiceSpecificCredentialRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"} - ] - }, - "UpdateSigningCertificate":{ - "name":"UpdateSigningCertificate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateSigningCertificateRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"}, - {"shape":"InvalidInputException"} - ] - }, - "UpdateUser":{ - "name":"UpdateUser", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateUserRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"EntityAlreadyExistsException"}, - {"shape":"EntityTemporarilyUnmodifiableException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ] - }, - "UploadSSHPublicKey":{ - "name":"UploadSSHPublicKey", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UploadSSHPublicKeyRequest"}, - "output":{ - "shape":"UploadSSHPublicKeyResponse", - "resultWrapper":"UploadSSHPublicKeyResult" - }, - "errors":[ - {"shape":"LimitExceededException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidPublicKeyException"}, - {"shape":"DuplicateSSHPublicKeyException"}, - {"shape":"UnrecognizedPublicKeyEncodingException"} - ] - }, - "UploadServerCertificate":{ - "name":"UploadServerCertificate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UploadServerCertificateRequest"}, - "output":{ - "shape":"UploadServerCertificateResponse", - "resultWrapper":"UploadServerCertificateResult" - }, - "errors":[ - {"shape":"LimitExceededException"}, - {"shape":"InvalidInputException"}, - {"shape":"EntityAlreadyExistsException"}, - {"shape":"MalformedCertificateException"}, - {"shape":"KeyPairMismatchException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ] - }, - "UploadSigningCertificate":{ - "name":"UploadSigningCertificate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UploadSigningCertificateRequest"}, - "output":{ - "shape":"UploadSigningCertificateResponse", - "resultWrapper":"UploadSigningCertificateResult" - }, - "errors":[ - {"shape":"LimitExceededException"}, - {"shape":"EntityAlreadyExistsException"}, - {"shape":"MalformedCertificateException"}, - {"shape":"InvalidCertificateException"}, - {"shape":"DuplicateCertificateException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ] - } - }, - "shapes":{ - "AcceptDelegationRequestRequest":{ - "type":"structure", - "required":["DelegationRequestId"], - "members":{ - "DelegationRequestId":{"shape":"delegationRequestIdType"} - } - }, - "AccessAdvisorUsageGranularityType":{ - "type":"string", - "enum":[ - "SERVICE_LEVEL", - "ACTION_LEVEL" - ] - }, - "AccessDetail":{ - "type":"structure", - "required":[ - "ServiceName", - "ServiceNamespace" - ], - "members":{ - "ServiceName":{"shape":"serviceNameType"}, - "ServiceNamespace":{"shape":"serviceNamespaceType"}, - "Region":{"shape":"stringType"}, - "EntityPath":{"shape":"organizationsEntityPathType"}, - "LastAuthenticatedTime":{"shape":"dateType"}, - "TotalAuthenticatedEntities":{"shape":"integerType"} - } - }, - "AccessDetails":{ - "type":"list", - "member":{"shape":"AccessDetail"} - }, - "AccessKey":{ - "type":"structure", - "required":[ - "UserName", - "AccessKeyId", - "Status", - "SecretAccessKey" - ], - "members":{ - "UserName":{"shape":"userNameType"}, - "AccessKeyId":{"shape":"accessKeyIdType"}, - "Status":{"shape":"statusType"}, - "SecretAccessKey":{"shape":"accessKeySecretType"}, - "CreateDate":{"shape":"dateType"} - } - }, - "AccessKeyLastUsed":{ - "type":"structure", - "required":[ - "ServiceName", - "Region" - ], - "members":{ - "LastUsedDate":{"shape":"dateType"}, - "ServiceName":{"shape":"stringType"}, - "Region":{"shape":"stringType"} - } - }, - "AccessKeyMetadata":{ - "type":"structure", - "members":{ - "UserName":{"shape":"userNameType"}, - "AccessKeyId":{"shape":"accessKeyIdType"}, - "Status":{"shape":"statusType"}, - "CreateDate":{"shape":"dateType"} - } - }, - "AccountNotManagementOrDelegatedAdministratorException":{ - "type":"structure", - "members":{}, - "exception":true - }, - "ActionNameListType":{ - "type":"list", - "member":{"shape":"ActionNameType"} - }, - "ActionNameType":{ - "type":"string", - "max":128, - "min":3 - }, - "AddClientIDToOpenIDConnectProviderRequest":{ - "type":"structure", - "required":[ - "OpenIDConnectProviderArn", - "ClientID" - ], - "members":{ - "OpenIDConnectProviderArn":{"shape":"arnType"}, - "ClientID":{"shape":"clientIDType"} - } - }, - "AddRoleToInstanceProfileRequest":{ - "type":"structure", - "required":[ - "InstanceProfileName", - "RoleName" - ], - "members":{ - "InstanceProfileName":{"shape":"instanceProfileNameType"}, - "RoleName":{"shape":"roleNameType"} - } - }, - "AddUserToGroupRequest":{ - "type":"structure", - "required":[ - "GroupName", - "UserName" - ], - "members":{ - "GroupName":{"shape":"groupNameType"}, - "UserName":{"shape":"existingUserNameType"} - } - }, - "ArnListType":{ - "type":"list", - "member":{"shape":"arnType"} - }, - "AssociateDelegationRequestRequest":{ - "type":"structure", - "required":["DelegationRequestId"], - "members":{ - "DelegationRequestId":{"shape":"delegationRequestIdType"} - } - }, - "AttachGroupPolicyRequest":{ - "type":"structure", - "required":[ - "GroupName", - "PolicyArn" - ], - "members":{ - "GroupName":{"shape":"groupNameType"}, - "PolicyArn":{"shape":"arnType"} - } - }, - "AttachRolePolicyRequest":{ - "type":"structure", - "required":[ - "RoleName", - "PolicyArn" - ], - "members":{ - "RoleName":{"shape":"roleNameType"}, - "PolicyArn":{"shape":"arnType"} - } - }, - "AttachUserPolicyRequest":{ - "type":"structure", - "required":[ - "UserName", - "PolicyArn" - ], - "members":{ - "UserName":{"shape":"userNameType"}, - "PolicyArn":{"shape":"arnType"} - } - }, - "AttachedPermissionsBoundary":{ - "type":"structure", - "members":{ - "PermissionsBoundaryType":{"shape":"PermissionsBoundaryAttachmentType"}, - "PermissionsBoundaryArn":{"shape":"arnType"} - } - }, - "AttachedPolicy":{ - "type":"structure", - "members":{ - "PolicyName":{"shape":"policyNameType"}, - "PolicyArn":{"shape":"arnType"} - } - }, - "AttachmentName":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[\\w+=,.@-]+" - }, - "AttachmentType":{ - "type":"string", - "enum":[ - "user", - "group", - "role" - ] - }, - "BootstrapDatum":{ - "type":"blob", - "sensitive":true - }, - "CallerIsNotManagementAccountException":{ - "type":"structure", - "members":{}, - "exception":true - }, - "CertificationKeyType":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[\\u0020-\\u00FF]+" - }, - "CertificationMapType":{ - "type":"map", - "key":{"shape":"CertificationKeyType"}, - "value":{"shape":"CertificationValueType"} - }, - "CertificationValueType":{ - "type":"string", - "max":32, - "min":1, - "pattern":"[\\u0020-\\u00FF]+" - }, - "ChangePasswordRequest":{ - "type":"structure", - "required":[ - "OldPassword", - "NewPassword" - ], - "members":{ - "OldPassword":{"shape":"passwordType"}, - "NewPassword":{"shape":"passwordType"} - } - }, - "ColumnNumber":{"type":"integer"}, - "ConcurrentModificationException":{ - "type":"structure", - "members":{ - "message":{"shape":"ConcurrentModificationMessage"} - }, - "error":{ - "code":"ConcurrentModification", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true - }, - "ConcurrentModificationMessage":{"type":"string"}, - "ContextEntry":{ - "type":"structure", - "members":{ - "ContextKeyName":{"shape":"ContextKeyNameType"}, - "ContextKeyValues":{"shape":"ContextKeyValueListType"}, - "ContextKeyType":{"shape":"ContextKeyTypeEnum"} - } - }, - "ContextEntryListType":{ - "type":"list", - "member":{"shape":"ContextEntry"} - }, - "ContextKeyNameType":{ - "type":"string", - "max":256, - "min":5 - }, - "ContextKeyNamesResultListType":{ - "type":"list", - "member":{"shape":"ContextKeyNameType"} - }, - "ContextKeyTypeEnum":{ - "type":"string", - "enum":[ - "string", - "stringList", - "numeric", - "numericList", - "boolean", - "booleanList", - "ip", - "ipList", - "binary", - "binaryList", - "date", - "dateList" - ] - }, - "ContextKeyValueListType":{ - "type":"list", - "member":{"shape":"ContextKeyValueType"} - }, - "ContextKeyValueType":{"type":"string"}, - "CreateAccessKeyRequest":{ - "type":"structure", - "members":{ - "UserName":{"shape":"existingUserNameType"} - } - }, - "CreateAccessKeyResponse":{ - "type":"structure", - "required":["AccessKey"], - "members":{ - "AccessKey":{"shape":"AccessKey"} - } - }, - "CreateAccountAliasRequest":{ - "type":"structure", - "required":["AccountAlias"], - "members":{ - "AccountAlias":{"shape":"accountAliasType"} - } - }, - "CreateDelegationRequestRequest":{ - "type":"structure", - "required":[ - "Description", - "Permissions", - "RequestorWorkflowId", - "NotificationChannel", - "SessionDuration" - ], - "members":{ - "OwnerAccountId":{"shape":"accountIdType"}, - "Description":{"shape":"delegationRequestDescriptionType"}, - "Permissions":{"shape":"DelegationPermission"}, - "RequestMessage":{"shape":"requestMessageType"}, - "RequestorWorkflowId":{"shape":"requestorWorkflowIdType"}, - "RedirectUrl":{"shape":"redirectUrlType"}, - "NotificationChannel":{"shape":"notificationChannelType"}, - "SessionDuration":{"shape":"sessionDurationType"}, - "OnlySendByOwner":{"shape":"booleanType"} - } - }, - "CreateDelegationRequestResponse":{ - "type":"structure", - "members":{ - "ConsoleDeepLink":{"shape":"consoleDeepLinkType"}, - "DelegationRequestId":{"shape":"delegationRequestIdType"} - } - }, - "CreateGroupRequest":{ - "type":"structure", - "required":["GroupName"], - "members":{ - "Path":{"shape":"pathType"}, - "GroupName":{"shape":"groupNameType"} - } - }, - "CreateGroupResponse":{ - "type":"structure", - "required":["Group"], - "members":{ - "Group":{"shape":"Group"} - } - }, - "CreateInstanceProfileRequest":{ - "type":"structure", - "required":["InstanceProfileName"], - "members":{ - "InstanceProfileName":{"shape":"instanceProfileNameType"}, - "Path":{"shape":"pathType"}, - "Tags":{"shape":"tagListType"} - } - }, - "CreateInstanceProfileResponse":{ - "type":"structure", - "required":["InstanceProfile"], - "members":{ - "InstanceProfile":{"shape":"InstanceProfile"} - } - }, - "CreateLoginProfileRequest":{ - "type":"structure", - "members":{ - "UserName":{"shape":"userNameType"}, - "Password":{"shape":"passwordType"}, - "PasswordResetRequired":{"shape":"booleanType"} - } - }, - "CreateLoginProfileResponse":{ - "type":"structure", - "required":["LoginProfile"], - "members":{ - "LoginProfile":{"shape":"LoginProfile"} - } - }, - "CreateOpenIDConnectProviderRequest":{ - "type":"structure", - "required":["Url"], - "members":{ - "Url":{"shape":"OpenIDConnectProviderUrlType"}, - "ClientIDList":{"shape":"clientIDListType"}, - "ThumbprintList":{"shape":"thumbprintListType"}, - "Tags":{"shape":"tagListType"} - } - }, - "CreateOpenIDConnectProviderResponse":{ - "type":"structure", - "members":{ - "OpenIDConnectProviderArn":{"shape":"arnType"}, - "Tags":{"shape":"tagListType"} - } - }, - "CreatePolicyRequest":{ - "type":"structure", - "required":[ - "PolicyName", - "PolicyDocument" - ], - "members":{ - "PolicyName":{"shape":"policyNameType"}, - "Path":{"shape":"policyPathType"}, - "PolicyDocument":{"shape":"policyDocumentType"}, - "Description":{"shape":"policyDescriptionType"}, - "Tags":{"shape":"tagListType"} - } - }, - "CreatePolicyResponse":{ - "type":"structure", - "members":{ - "Policy":{"shape":"Policy"} - } - }, - "CreatePolicyVersionRequest":{ - "type":"structure", - "required":[ - "PolicyArn", - "PolicyDocument" - ], - "members":{ - "PolicyArn":{"shape":"arnType"}, - "PolicyDocument":{"shape":"policyDocumentType"}, - "SetAsDefault":{"shape":"booleanType"} - } - }, - "CreatePolicyVersionResponse":{ - "type":"structure", - "members":{ - "PolicyVersion":{"shape":"PolicyVersion"} - } - }, - "CreateRoleRequest":{ - "type":"structure", - "required":[ - "RoleName", - "AssumeRolePolicyDocument" - ], - "members":{ - "Path":{"shape":"pathType"}, - "RoleName":{"shape":"roleNameType"}, - "AssumeRolePolicyDocument":{"shape":"policyDocumentType"}, - "Description":{"shape":"roleDescriptionType"}, - "MaxSessionDuration":{"shape":"roleMaxSessionDurationType"}, - "PermissionsBoundary":{"shape":"arnType"}, - "Tags":{"shape":"tagListType"} - } - }, - "CreateRoleResponse":{ - "type":"structure", - "required":["Role"], - "members":{ - "Role":{"shape":"Role"} - } - }, - "CreateSAMLProviderRequest":{ - "type":"structure", - "required":[ - "SAMLMetadataDocument", - "Name" - ], - "members":{ - "SAMLMetadataDocument":{"shape":"SAMLMetadataDocumentType"}, - "Name":{"shape":"SAMLProviderNameType"}, - "Tags":{"shape":"tagListType"}, - "AssertionEncryptionMode":{"shape":"assertionEncryptionModeType"}, - "AddPrivateKey":{"shape":"privateKeyType"} - } - }, - "CreateSAMLProviderResponse":{ - "type":"structure", - "members":{ - "SAMLProviderArn":{"shape":"arnType"}, - "Tags":{"shape":"tagListType"} - } - }, - "CreateServiceLinkedRoleRequest":{ - "type":"structure", - "required":["AWSServiceName"], - "members":{ - "AWSServiceName":{"shape":"groupNameType"}, - "Description":{"shape":"roleDescriptionType"}, - "CustomSuffix":{"shape":"customSuffixType"} - } - }, - "CreateServiceLinkedRoleResponse":{ - "type":"structure", - "members":{ - "Role":{"shape":"Role"} - } - }, - "CreateServiceSpecificCredentialRequest":{ - "type":"structure", - "required":[ - "UserName", - "ServiceName" - ], - "members":{ - "UserName":{"shape":"userNameType"}, - "ServiceName":{"shape":"serviceName"}, - "CredentialAgeDays":{"shape":"credentialAgeDays"} - } - }, - "CreateServiceSpecificCredentialResponse":{ - "type":"structure", - "members":{ - "ServiceSpecificCredential":{"shape":"ServiceSpecificCredential"} - } - }, - "CreateUserRequest":{ - "type":"structure", - "required":["UserName"], - "members":{ - "Path":{"shape":"pathType"}, - "UserName":{"shape":"userNameType"}, - "PermissionsBoundary":{"shape":"arnType"}, - "Tags":{"shape":"tagListType"} - } - }, - "CreateUserResponse":{ - "type":"structure", - "members":{ - "User":{"shape":"User"} - } - }, - "CreateVirtualMFADeviceRequest":{ - "type":"structure", - "required":["VirtualMFADeviceName"], - "members":{ - "Path":{"shape":"pathType"}, - "VirtualMFADeviceName":{"shape":"virtualMFADeviceName"}, - "Tags":{"shape":"tagListType"} - } - }, - "CreateVirtualMFADeviceResponse":{ - "type":"structure", - "required":["VirtualMFADevice"], - "members":{ - "VirtualMFADevice":{"shape":"VirtualMFADevice"} - } - }, - "CredentialReportExpiredException":{ - "type":"structure", - "members":{ - "message":{"shape":"credentialReportExpiredExceptionMessage"} - }, - "error":{ - "code":"ReportExpired", - "httpStatusCode":410, - "senderFault":true - }, - "exception":true - }, - "CredentialReportNotPresentException":{ - "type":"structure", - "members":{ - "message":{"shape":"credentialReportNotPresentExceptionMessage"} - }, - "error":{ - "code":"ReportNotPresent", - "httpStatusCode":410, - "senderFault":true - }, - "exception":true - }, - "CredentialReportNotReadyException":{ - "type":"structure", - "members":{ - "message":{"shape":"credentialReportNotReadyExceptionMessage"} - }, - "error":{ - "code":"ReportInProgress", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true - }, - "DeactivateMFADeviceRequest":{ - "type":"structure", - "required":["SerialNumber"], - "members":{ - "UserName":{"shape":"existingUserNameType"}, - "SerialNumber":{"shape":"serialNumberType"} - } - }, - "DelegationPermission":{ - "type":"structure", - "members":{ - "PolicyTemplateArn":{"shape":"arnType"}, - "Parameters":{"shape":"policyParameterListType"} - } - }, - "DelegationRequest":{ - "type":"structure", - "members":{ - "DelegationRequestId":{"shape":"delegationRequestIdType"}, - "OwnerAccountId":{"shape":"accountIdType"}, - "Description":{"shape":"delegationRequestDescriptionType"}, - "RequestMessage":{"shape":"requestMessageType"}, - "Permissions":{"shape":"DelegationPermission"}, - "PermissionPolicy":{"shape":"permissionType"}, - "RolePermissionRestrictionArns":{"shape":"rolePermissionRestrictionArnListType"}, - "OwnerId":{"shape":"ownerIdType"}, - "ApproverId":{"shape":"arnType"}, - "State":{"shape":"stateType"}, - "ExpirationTime":{"shape":"dateType"}, - "RequestorId":{"shape":"accountIdType"}, - "RequestorName":{"shape":"requestorNameType"}, - "CreateDate":{"shape":"dateType"}, - "SessionDuration":{"shape":"sessionDurationType"}, - "RedirectUrl":{"shape":"redirectUrlType"}, - "Notes":{"shape":"notesType"}, - "RejectionReason":{"shape":"notesType"}, - "OnlySendByOwner":{"shape":"booleanType"}, - "UpdatedTime":{"shape":"dateType"} - } - }, - "DeleteAccessKeyRequest":{ - "type":"structure", - "required":["AccessKeyId"], - "members":{ - "UserName":{"shape":"existingUserNameType"}, - "AccessKeyId":{"shape":"accessKeyIdType"} - } - }, - "DeleteAccountAliasRequest":{ - "type":"structure", - "required":["AccountAlias"], - "members":{ - "AccountAlias":{"shape":"accountAliasType"} - } - }, - "DeleteConflictException":{ - "type":"structure", - "members":{ - "message":{"shape":"deleteConflictMessage"} - }, - "error":{ - "code":"DeleteConflict", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true - }, - "DeleteGroupPolicyRequest":{ - "type":"structure", - "required":[ - "GroupName", - "PolicyName" - ], - "members":{ - "GroupName":{"shape":"groupNameType"}, - "PolicyName":{"shape":"policyNameType"} - } - }, - "DeleteGroupRequest":{ - "type":"structure", - "required":["GroupName"], - "members":{ - "GroupName":{"shape":"groupNameType"} - } - }, - "DeleteInstanceProfileRequest":{ - "type":"structure", - "required":["InstanceProfileName"], - "members":{ - "InstanceProfileName":{"shape":"instanceProfileNameType"} - } - }, - "DeleteLoginProfileRequest":{ - "type":"structure", - "members":{ - "UserName":{"shape":"userNameType"} - } - }, - "DeleteOpenIDConnectProviderRequest":{ - "type":"structure", - "required":["OpenIDConnectProviderArn"], - "members":{ - "OpenIDConnectProviderArn":{"shape":"arnType"} - } - }, - "DeletePolicyRequest":{ - "type":"structure", - "required":["PolicyArn"], - "members":{ - "PolicyArn":{"shape":"arnType"} - } - }, - "DeletePolicyVersionRequest":{ - "type":"structure", - "required":[ - "PolicyArn", - "VersionId" - ], - "members":{ - "PolicyArn":{"shape":"arnType"}, - "VersionId":{"shape":"policyVersionIdType"} - } - }, - "DeleteRolePermissionsBoundaryRequest":{ - "type":"structure", - "required":["RoleName"], - "members":{ - "RoleName":{"shape":"roleNameType"} - } - }, - "DeleteRolePolicyRequest":{ - "type":"structure", - "required":[ - "RoleName", - "PolicyName" - ], - "members":{ - "RoleName":{"shape":"roleNameType"}, - "PolicyName":{"shape":"policyNameType"} - } - }, - "DeleteRoleRequest":{ - "type":"structure", - "required":["RoleName"], - "members":{ - "RoleName":{"shape":"roleNameType"} - } - }, - "DeleteSAMLProviderRequest":{ - "type":"structure", - "required":["SAMLProviderArn"], - "members":{ - "SAMLProviderArn":{"shape":"arnType"} - } - }, - "DeleteSSHPublicKeyRequest":{ - "type":"structure", - "required":[ - "UserName", - "SSHPublicKeyId" - ], - "members":{ - "UserName":{"shape":"userNameType"}, - "SSHPublicKeyId":{"shape":"publicKeyIdType"} - } - }, - "DeleteServerCertificateRequest":{ - "type":"structure", - "required":["ServerCertificateName"], - "members":{ - "ServerCertificateName":{"shape":"serverCertificateNameType"} - } - }, - "DeleteServiceLinkedRoleRequest":{ - "type":"structure", - "required":["RoleName"], - "members":{ - "RoleName":{"shape":"roleNameType"} - } - }, - "DeleteServiceLinkedRoleResponse":{ - "type":"structure", - "required":["DeletionTaskId"], - "members":{ - "DeletionTaskId":{"shape":"DeletionTaskIdType"} - } - }, - "DeleteServiceSpecificCredentialRequest":{ - "type":"structure", - "required":["ServiceSpecificCredentialId"], - "members":{ - "UserName":{"shape":"userNameType"}, - "ServiceSpecificCredentialId":{"shape":"serviceSpecificCredentialId"} - } - }, - "DeleteSigningCertificateRequest":{ - "type":"structure", - "required":["CertificateId"], - "members":{ - "UserName":{"shape":"existingUserNameType"}, - "CertificateId":{"shape":"certificateIdType"} - } - }, - "DeleteUserPermissionsBoundaryRequest":{ - "type":"structure", - "required":["UserName"], - "members":{ - "UserName":{"shape":"userNameType"} - } - }, - "DeleteUserPolicyRequest":{ - "type":"structure", - "required":[ - "UserName", - "PolicyName" - ], - "members":{ - "UserName":{"shape":"existingUserNameType"}, - "PolicyName":{"shape":"policyNameType"} - } - }, - "DeleteUserRequest":{ - "type":"structure", - "required":["UserName"], - "members":{ - "UserName":{"shape":"existingUserNameType"} - } - }, - "DeleteVirtualMFADeviceRequest":{ - "type":"structure", - "required":["SerialNumber"], - "members":{ - "SerialNumber":{"shape":"serialNumberType"} - } - }, - "DeletionTaskFailureReasonType":{ - "type":"structure", - "members":{ - "Reason":{"shape":"ReasonType"}, - "RoleUsageList":{"shape":"RoleUsageListType"} - } - }, - "DeletionTaskIdType":{ - "type":"string", - "max":1000, - "min":1 - }, - "DeletionTaskStatusType":{ - "type":"string", - "enum":[ - "SUCCEEDED", - "IN_PROGRESS", - "FAILED", - "NOT_STARTED" - ] - }, - "DetachGroupPolicyRequest":{ - "type":"structure", - "required":[ - "GroupName", - "PolicyArn" - ], - "members":{ - "GroupName":{"shape":"groupNameType"}, - "PolicyArn":{"shape":"arnType"} - } - }, - "DetachRolePolicyRequest":{ - "type":"structure", - "required":[ - "RoleName", - "PolicyArn" - ], - "members":{ - "RoleName":{"shape":"roleNameType"}, - "PolicyArn":{"shape":"arnType"} - } - }, - "DetachUserPolicyRequest":{ - "type":"structure", - "required":[ - "UserName", - "PolicyArn" - ], - "members":{ - "UserName":{"shape":"userNameType"}, - "PolicyArn":{"shape":"arnType"} - } - }, - "DisableOrganizationsRootCredentialsManagementRequest":{ - "type":"structure", - "members":{} - }, - "DisableOrganizationsRootCredentialsManagementResponse":{ - "type":"structure", - "members":{ - "OrganizationId":{"shape":"OrganizationIdType"}, - "EnabledFeatures":{"shape":"FeaturesListType"} - } - }, - "DisableOrganizationsRootSessionsRequest":{ - "type":"structure", - "members":{} - }, - "DisableOrganizationsRootSessionsResponse":{ - "type":"structure", - "members":{ - "OrganizationId":{"shape":"OrganizationIdType"}, - "EnabledFeatures":{"shape":"FeaturesListType"} - } - }, - "DuplicateCertificateException":{ - "type":"structure", - "members":{ - "message":{"shape":"duplicateCertificateMessage"} - }, - "error":{ - "code":"DuplicateCertificate", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true - }, - "DuplicateSSHPublicKeyException":{ - "type":"structure", - "members":{ - "message":{"shape":"duplicateSSHPublicKeyMessage"} - }, - "error":{ - "code":"DuplicateSSHPublicKey", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "EnableMFADeviceRequest":{ - "type":"structure", - "required":[ - "UserName", - "SerialNumber", - "AuthenticationCode1", - "AuthenticationCode2" - ], - "members":{ - "UserName":{"shape":"existingUserNameType"}, - "SerialNumber":{"shape":"serialNumberType"}, - "AuthenticationCode1":{"shape":"authenticationCodeType"}, - "AuthenticationCode2":{"shape":"authenticationCodeType"} - } - }, - "EnableOrganizationsRootCredentialsManagementRequest":{ - "type":"structure", - "members":{} - }, - "EnableOrganizationsRootCredentialsManagementResponse":{ - "type":"structure", - "members":{ - "OrganizationId":{"shape":"OrganizationIdType"}, - "EnabledFeatures":{"shape":"FeaturesListType"} - } - }, - "EnableOrganizationsRootSessionsRequest":{ - "type":"structure", - "members":{} - }, - "EnableOrganizationsRootSessionsResponse":{ - "type":"structure", - "members":{ - "OrganizationId":{"shape":"OrganizationIdType"}, - "EnabledFeatures":{"shape":"FeaturesListType"} - } - }, - "EnableOutboundWebIdentityFederationResponse":{ - "type":"structure", - "members":{ - "IssuerIdentifier":{"shape":"stringType"} - } - }, - "EntityAlreadyExistsException":{ - "type":"structure", - "members":{ - "message":{"shape":"entityAlreadyExistsMessage"} - }, - "error":{ - "code":"EntityAlreadyExists", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true - }, - "EntityDetails":{ - "type":"structure", - "required":["EntityInfo"], - "members":{ - "EntityInfo":{"shape":"EntityInfo"}, - "LastAuthenticated":{"shape":"dateType"} - } - }, - "EntityInfo":{ - "type":"structure", - "required":[ - "Arn", - "Name", - "Type", - "Id" - ], - "members":{ - "Arn":{"shape":"arnType"}, - "Name":{"shape":"userNameType"}, - "Type":{"shape":"policyOwnerEntityType"}, - "Id":{"shape":"idType"}, - "Path":{"shape":"pathType"} - } - }, - "EntityTemporarilyUnmodifiableException":{ - "type":"structure", - "members":{ - "message":{"shape":"entityTemporarilyUnmodifiableMessage"} - }, - "error":{ - "code":"EntityTemporarilyUnmodifiable", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true - }, - "EntityType":{ - "type":"string", - "enum":[ - "User", - "Role", - "Group", - "LocalManagedPolicy", - "AWSManagedPolicy" - ] - }, - "ErrorDetails":{ - "type":"structure", - "required":[ - "Message", - "Code" - ], - "members":{ - "Message":{"shape":"stringType"}, - "Code":{"shape":"stringType"} - } - }, - "EvalDecisionDetailsType":{ - "type":"map", - "key":{"shape":"EvalDecisionSourceType"}, - "value":{"shape":"PolicyEvaluationDecisionType"} - }, - "EvalDecisionSourceType":{ - "type":"string", - "max":256, - "min":3 - }, - "EvaluationResult":{ - "type":"structure", - "required":[ - "EvalActionName", - "EvalDecision" - ], - "members":{ - "EvalActionName":{"shape":"ActionNameType"}, - "EvalResourceName":{"shape":"ResourceNameType"}, - "EvalDecision":{"shape":"PolicyEvaluationDecisionType"}, - "MatchedStatements":{"shape":"StatementListType"}, - "MissingContextValues":{"shape":"ContextKeyNamesResultListType"}, - "OrganizationsDecisionDetail":{"shape":"OrganizationsDecisionDetail"}, - "PermissionsBoundaryDecisionDetail":{"shape":"PermissionsBoundaryDecisionDetail"}, - "EvalDecisionDetails":{"shape":"EvalDecisionDetailsType"}, - "ResourceSpecificResults":{"shape":"ResourceSpecificResultListType"} - } - }, - "EvaluationResultsListType":{ - "type":"list", - "member":{"shape":"EvaluationResult"} - }, - "FeatureDisabledException":{ - "type":"structure", - "members":{ - "message":{"shape":"FeatureDisabledMessage"} - }, - "error":{ - "code":"FeatureDisabled", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true - }, - "FeatureDisabledMessage":{"type":"string"}, - "FeatureEnabledException":{ - "type":"structure", - "members":{ - "message":{"shape":"FeatureEnabledMessage"} - }, - "error":{ - "code":"FeatureEnabled", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true - }, - "FeatureEnabledMessage":{"type":"string"}, - "FeatureType":{ - "type":"string", - "enum":[ - "RootCredentialsManagement", - "RootSessions" - ] - }, - "FeaturesListType":{ - "type":"list", - "member":{"shape":"FeatureType"} - }, - "GenerateCredentialReportResponse":{ - "type":"structure", - "members":{ - "State":{"shape":"ReportStateType"}, - "Description":{"shape":"ReportStateDescriptionType"} - } - }, - "GenerateOrganizationsAccessReportRequest":{ - "type":"structure", - "required":["EntityPath"], - "members":{ - "EntityPath":{"shape":"organizationsEntityPathType"}, - "OrganizationsPolicyId":{"shape":"organizationsPolicyIdType"} - } - }, - "GenerateOrganizationsAccessReportResponse":{ - "type":"structure", - "members":{ - "JobId":{"shape":"jobIDType"} - } - }, - "GenerateServiceLastAccessedDetailsRequest":{ - "type":"structure", - "required":["Arn"], - "members":{ - "Arn":{"shape":"arnType"}, - "Granularity":{"shape":"AccessAdvisorUsageGranularityType"} - } - }, - "GenerateServiceLastAccessedDetailsResponse":{ - "type":"structure", - "members":{ - "JobId":{"shape":"jobIDType"} - } - }, - "GetAccessKeyLastUsedRequest":{ - "type":"structure", - "required":["AccessKeyId"], - "members":{ - "AccessKeyId":{"shape":"accessKeyIdType"} - } - }, - "GetAccessKeyLastUsedResponse":{ - "type":"structure", - "members":{ - "UserName":{"shape":"existingUserNameType"}, - "AccessKeyLastUsed":{"shape":"AccessKeyLastUsed"} - } - }, - "GetAccountAuthorizationDetailsRequest":{ - "type":"structure", - "members":{ - "Filter":{"shape":"entityListType"}, - "MaxItems":{"shape":"maxItemsType"}, - "Marker":{"shape":"markerType"} - } - }, - "GetAccountAuthorizationDetailsResponse":{ - "type":"structure", - "members":{ - "UserDetailList":{"shape":"userDetailListType"}, - "GroupDetailList":{"shape":"groupDetailListType"}, - "RoleDetailList":{"shape":"roleDetailListType"}, - "Policies":{"shape":"ManagedPolicyDetailListType"}, - "IsTruncated":{"shape":"booleanType"}, - "Marker":{"shape":"responseMarkerType"} - } - }, - "GetAccountPasswordPolicyResponse":{ - "type":"structure", - "required":["PasswordPolicy"], - "members":{ - "PasswordPolicy":{"shape":"PasswordPolicy"} - } - }, - "GetAccountSummaryResponse":{ - "type":"structure", - "members":{ - "SummaryMap":{"shape":"summaryMapType"} - } - }, - "GetContextKeysForCustomPolicyRequest":{ - "type":"structure", - "required":["PolicyInputList"], - "members":{ - "PolicyInputList":{"shape":"SimulationPolicyListType"} - } - }, - "GetContextKeysForPolicyResponse":{ - "type":"structure", - "members":{ - "ContextKeyNames":{"shape":"ContextKeyNamesResultListType"} - } - }, - "GetContextKeysForPrincipalPolicyRequest":{ - "type":"structure", - "required":["PolicySourceArn"], - "members":{ - "PolicySourceArn":{"shape":"arnType"}, - "PolicyInputList":{"shape":"SimulationPolicyListType"} - } - }, - "GetCredentialReportResponse":{ - "type":"structure", - "members":{ - "Content":{"shape":"ReportContentType"}, - "ReportFormat":{"shape":"ReportFormatType"}, - "GeneratedTime":{"shape":"dateType"} - } - }, - "GetDelegationRequestRequest":{ - "type":"structure", - "required":["DelegationRequestId"], - "members":{ - "DelegationRequestId":{"shape":"delegationRequestIdType"}, - "DelegationPermissionCheck":{"shape":"booleanType"} - } - }, - "GetDelegationRequestResponse":{ - "type":"structure", - "members":{ - "DelegationRequest":{"shape":"DelegationRequest"}, - "PermissionCheckStatus":{"shape":"permissionCheckStatusType"}, - "PermissionCheckResult":{"shape":"permissionCheckResultType"} - } - }, - "GetGroupPolicyRequest":{ - "type":"structure", - "required":[ - "GroupName", - "PolicyName" - ], - "members":{ - "GroupName":{"shape":"groupNameType"}, - "PolicyName":{"shape":"policyNameType"} - } - }, - "GetGroupPolicyResponse":{ - "type":"structure", - "required":[ - "GroupName", - "PolicyName", - "PolicyDocument" - ], - "members":{ - "GroupName":{"shape":"groupNameType"}, - "PolicyName":{"shape":"policyNameType"}, - "PolicyDocument":{"shape":"policyDocumentType"} - } - }, - "GetGroupRequest":{ - "type":"structure", - "required":["GroupName"], - "members":{ - "GroupName":{"shape":"groupNameType"}, - "Marker":{"shape":"markerType"}, - "MaxItems":{"shape":"maxItemsType"} - } - }, - "GetGroupResponse":{ - "type":"structure", - "required":[ - "Group", - "Users" - ], - "members":{ - "Group":{"shape":"Group"}, - "Users":{"shape":"userListType"}, - "IsTruncated":{"shape":"booleanType"}, - "Marker":{"shape":"responseMarkerType"} - } - }, - "GetHumanReadableSummaryRequest":{ - "type":"structure", - "required":["EntityArn"], - "members":{ - "EntityArn":{"shape":"arnType"}, - "Locale":{"shape":"localeType"} - } - }, - "GetHumanReadableSummaryResponse":{ - "type":"structure", - "members":{ - "SummaryContent":{"shape":"summaryContentType"}, - "Locale":{"shape":"localeType"}, - "SummaryState":{"shape":"summaryStateType"} - } - }, - "GetInstanceProfileRequest":{ - "type":"structure", - "required":["InstanceProfileName"], - "members":{ - "InstanceProfileName":{"shape":"instanceProfileNameType"} - } - }, - "GetInstanceProfileResponse":{ - "type":"structure", - "required":["InstanceProfile"], - "members":{ - "InstanceProfile":{"shape":"InstanceProfile"} - } - }, - "GetLoginProfileRequest":{ - "type":"structure", - "members":{ - "UserName":{"shape":"userNameType"} - } - }, - "GetLoginProfileResponse":{ - "type":"structure", - "required":["LoginProfile"], - "members":{ - "LoginProfile":{"shape":"LoginProfile"} - } - }, - "GetMFADeviceRequest":{ - "type":"structure", - "required":["SerialNumber"], - "members":{ - "SerialNumber":{"shape":"serialNumberType"}, - "UserName":{"shape":"userNameType"} - } - }, - "GetMFADeviceResponse":{ - "type":"structure", - "required":["SerialNumber"], - "members":{ - "UserName":{"shape":"userNameType"}, - "SerialNumber":{"shape":"serialNumberType"}, - "EnableDate":{"shape":"dateType"}, - "Certifications":{"shape":"CertificationMapType"} - } - }, - "GetOpenIDConnectProviderRequest":{ - "type":"structure", - "required":["OpenIDConnectProviderArn"], - "members":{ - "OpenIDConnectProviderArn":{"shape":"arnType"} - } - }, - "GetOpenIDConnectProviderResponse":{ - "type":"structure", - "members":{ - "Url":{"shape":"OpenIDConnectProviderUrlType"}, - "ClientIDList":{"shape":"clientIDListType"}, - "ThumbprintList":{"shape":"thumbprintListType"}, - "CreateDate":{"shape":"dateType"}, - "Tags":{"shape":"tagListType"} - } - }, - "GetOrganizationsAccessReportRequest":{ - "type":"structure", - "required":["JobId"], - "members":{ - "JobId":{"shape":"jobIDType"}, - "MaxItems":{"shape":"maxItemsType"}, - "Marker":{"shape":"markerType"}, - "SortKey":{"shape":"sortKeyType"} - } - }, - "GetOrganizationsAccessReportResponse":{ - "type":"structure", - "required":[ - "JobStatus", - "JobCreationDate" - ], - "members":{ - "JobStatus":{"shape":"jobStatusType"}, - "JobCreationDate":{"shape":"dateType"}, - "JobCompletionDate":{"shape":"dateType"}, - "NumberOfServicesAccessible":{"shape":"integerType"}, - "NumberOfServicesNotAccessed":{"shape":"integerType"}, - "AccessDetails":{"shape":"AccessDetails"}, - "IsTruncated":{"shape":"booleanType"}, - "Marker":{"shape":"markerType"}, - "ErrorDetails":{"shape":"ErrorDetails"} - } - }, - "GetOutboundWebIdentityFederationInfoResponse":{ - "type":"structure", - "members":{ - "IssuerIdentifier":{"shape":"stringType"}, - "JwtVendingEnabled":{"shape":"booleanType"} - } - }, - "GetPolicyRequest":{ - "type":"structure", - "required":["PolicyArn"], - "members":{ - "PolicyArn":{"shape":"arnType"} - } - }, - "GetPolicyResponse":{ - "type":"structure", - "members":{ - "Policy":{"shape":"Policy"} - } - }, - "GetPolicyVersionRequest":{ - "type":"structure", - "required":[ - "PolicyArn", - "VersionId" - ], - "members":{ - "PolicyArn":{"shape":"arnType"}, - "VersionId":{"shape":"policyVersionIdType"} - } - }, - "GetPolicyVersionResponse":{ - "type":"structure", - "members":{ - "PolicyVersion":{"shape":"PolicyVersion"} - } - }, - "GetRolePolicyRequest":{ - "type":"structure", - "required":[ - "RoleName", - "PolicyName" - ], - "members":{ - "RoleName":{"shape":"roleNameType"}, - "PolicyName":{"shape":"policyNameType"} - } - }, - "GetRolePolicyResponse":{ - "type":"structure", - "required":[ - "RoleName", - "PolicyName", - "PolicyDocument" - ], - "members":{ - "RoleName":{"shape":"roleNameType"}, - "PolicyName":{"shape":"policyNameType"}, - "PolicyDocument":{"shape":"policyDocumentType"} - } - }, - "GetRoleRequest":{ - "type":"structure", - "required":["RoleName"], - "members":{ - "RoleName":{"shape":"roleNameType"} - } - }, - "GetRoleResponse":{ - "type":"structure", - "required":["Role"], - "members":{ - "Role":{"shape":"Role"} - } - }, - "GetSAMLProviderRequest":{ - "type":"structure", - "required":["SAMLProviderArn"], - "members":{ - "SAMLProviderArn":{"shape":"arnType"} - } - }, - "GetSAMLProviderResponse":{ - "type":"structure", - "members":{ - "SAMLProviderUUID":{"shape":"privateKeyIdType"}, - "SAMLMetadataDocument":{"shape":"SAMLMetadataDocumentType"}, - "CreateDate":{"shape":"dateType"}, - "ValidUntil":{"shape":"dateType"}, - "Tags":{"shape":"tagListType"}, - "AssertionEncryptionMode":{"shape":"assertionEncryptionModeType"}, - "PrivateKeyList":{"shape":"privateKeyList"} - } - }, - "GetSSHPublicKeyRequest":{ - "type":"structure", - "required":[ - "UserName", - "SSHPublicKeyId", - "Encoding" - ], - "members":{ - "UserName":{"shape":"userNameType"}, - "SSHPublicKeyId":{"shape":"publicKeyIdType"}, - "Encoding":{"shape":"encodingType"} - } - }, - "GetSSHPublicKeyResponse":{ - "type":"structure", - "members":{ - "SSHPublicKey":{"shape":"SSHPublicKey"} - } - }, - "GetServerCertificateRequest":{ - "type":"structure", - "required":["ServerCertificateName"], - "members":{ - "ServerCertificateName":{"shape":"serverCertificateNameType"} - } - }, - "GetServerCertificateResponse":{ - "type":"structure", - "required":["ServerCertificate"], - "members":{ - "ServerCertificate":{"shape":"ServerCertificate"} - } - }, - "GetServiceLastAccessedDetailsRequest":{ - "type":"structure", - "required":["JobId"], - "members":{ - "JobId":{"shape":"jobIDType"}, - "MaxItems":{"shape":"maxItemsType"}, - "Marker":{"shape":"markerType"} - } - }, - "GetServiceLastAccessedDetailsResponse":{ - "type":"structure", - "required":[ - "JobStatus", - "JobCreationDate", - "ServicesLastAccessed", - "JobCompletionDate" - ], - "members":{ - "JobStatus":{"shape":"jobStatusType"}, - "JobType":{"shape":"AccessAdvisorUsageGranularityType"}, - "JobCreationDate":{"shape":"dateType"}, - "ServicesLastAccessed":{"shape":"ServicesLastAccessed"}, - "JobCompletionDate":{"shape":"dateType"}, - "IsTruncated":{"shape":"booleanType"}, - "Marker":{"shape":"responseMarkerType"}, - "Error":{"shape":"ErrorDetails"} - } - }, - "GetServiceLastAccessedDetailsWithEntitiesRequest":{ - "type":"structure", - "required":[ - "JobId", - "ServiceNamespace" - ], - "members":{ - "JobId":{"shape":"jobIDType"}, - "ServiceNamespace":{"shape":"serviceNamespaceType"}, - "MaxItems":{"shape":"maxItemsType"}, - "Marker":{"shape":"markerType"} - } - }, - "GetServiceLastAccessedDetailsWithEntitiesResponse":{ - "type":"structure", - "required":[ - "JobStatus", - "JobCreationDate", - "JobCompletionDate", - "EntityDetailsList" - ], - "members":{ - "JobStatus":{"shape":"jobStatusType"}, - "JobCreationDate":{"shape":"dateType"}, - "JobCompletionDate":{"shape":"dateType"}, - "EntityDetailsList":{"shape":"entityDetailsListType"}, - "IsTruncated":{"shape":"booleanType"}, - "Marker":{"shape":"responseMarkerType"}, - "Error":{"shape":"ErrorDetails"} - } - }, - "GetServiceLinkedRoleDeletionStatusRequest":{ - "type":"structure", - "required":["DeletionTaskId"], - "members":{ - "DeletionTaskId":{"shape":"DeletionTaskIdType"} - } - }, - "GetServiceLinkedRoleDeletionStatusResponse":{ - "type":"structure", - "required":["Status"], - "members":{ - "Status":{"shape":"DeletionTaskStatusType"}, - "Reason":{"shape":"DeletionTaskFailureReasonType"} - } - }, - "GetUserPolicyRequest":{ - "type":"structure", - "required":[ - "UserName", - "PolicyName" - ], - "members":{ - "UserName":{"shape":"existingUserNameType"}, - "PolicyName":{"shape":"policyNameType"} - } - }, - "GetUserPolicyResponse":{ - "type":"structure", - "required":[ - "UserName", - "PolicyName", - "PolicyDocument" - ], - "members":{ - "UserName":{"shape":"existingUserNameType"}, - "PolicyName":{"shape":"policyNameType"}, - "PolicyDocument":{"shape":"policyDocumentType"} - } - }, - "GetUserRequest":{ - "type":"structure", - "members":{ - "UserName":{"shape":"existingUserNameType"} - } - }, - "GetUserResponse":{ - "type":"structure", - "required":["User"], - "members":{ - "User":{"shape":"User"} - } - }, - "Group":{ - "type":"structure", - "required":[ - "Path", - "GroupName", - "GroupId", - "Arn", - "CreateDate" - ], - "members":{ - "Path":{"shape":"pathType"}, - "GroupName":{"shape":"groupNameType"}, - "GroupId":{"shape":"idType"}, - "Arn":{"shape":"arnType"}, - "CreateDate":{"shape":"dateType"} - } - }, - "GroupDetail":{ - "type":"structure", - "members":{ - "Path":{"shape":"pathType"}, - "GroupName":{"shape":"groupNameType"}, - "GroupId":{"shape":"idType"}, - "Arn":{"shape":"arnType"}, - "CreateDate":{"shape":"dateType"}, - "GroupPolicyList":{"shape":"policyDetailListType"}, - "AttachedManagedPolicies":{"shape":"attachedPoliciesListType"} - } - }, - "InlinePolicyIdentifierType":{ - "type":"structure", - "required":[ - "PolicyName", - "AttachmentType", - "AttachmentName" - ], - "members":{ - "PolicyName":{"shape":"policyNameType"}, - "AttachmentType":{"shape":"AttachmentType"}, - "AttachmentName":{"shape":"AttachmentName"} - } - }, - "InstanceProfile":{ - "type":"structure", - "required":[ - "Path", - "InstanceProfileName", - "InstanceProfileId", - "Arn", - "CreateDate", - "Roles" - ], - "members":{ - "Path":{"shape":"pathType"}, - "InstanceProfileName":{"shape":"instanceProfileNameType"}, - "InstanceProfileId":{"shape":"idType"}, - "Arn":{"shape":"arnType"}, - "CreateDate":{"shape":"dateType"}, - "Roles":{"shape":"roleListType"}, - "Tags":{"shape":"tagListType"} - } - }, - "InvalidAuthenticationCodeException":{ - "type":"structure", - "members":{ - "message":{"shape":"invalidAuthenticationCodeMessage"} - }, - "error":{ - "code":"InvalidAuthenticationCode", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true - }, - "InvalidCertificateException":{ - "type":"structure", - "members":{ - "message":{"shape":"invalidCertificateMessage"} - }, - "error":{ - "code":"InvalidCertificate", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "InvalidInputException":{ - "type":"structure", - "members":{ - "message":{"shape":"invalidInputMessage"} - }, - "error":{ - "code":"InvalidInput", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "InvalidPublicKeyException":{ - "type":"structure", - "members":{ - "message":{"shape":"invalidPublicKeyMessage"} - }, - "error":{ - "code":"InvalidPublicKey", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "InvalidUserTypeException":{ - "type":"structure", - "members":{ - "message":{"shape":"invalidUserTypeMessage"} - }, - "error":{ - "code":"InvalidUserType", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "KeyPairMismatchException":{ - "type":"structure", - "members":{ - "message":{"shape":"keyPairMismatchMessage"} - }, - "error":{ - "code":"KeyPairMismatch", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "LimitExceededException":{ - "type":"structure", - "members":{ - "message":{"shape":"limitExceededMessage"} - }, - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true - }, - "LineNumber":{"type":"integer"}, - "ListAccessKeysRequest":{ - "type":"structure", - "members":{ - "UserName":{"shape":"existingUserNameType"}, - "Marker":{"shape":"markerType"}, - "MaxItems":{"shape":"maxItemsType"} - } - }, - "ListAccessKeysResponse":{ - "type":"structure", - "required":["AccessKeyMetadata"], - "members":{ - "AccessKeyMetadata":{"shape":"accessKeyMetadataListType"}, - "IsTruncated":{"shape":"booleanType"}, - "Marker":{"shape":"responseMarkerType"} - } - }, - "ListAccountAliasesRequest":{ - "type":"structure", - "members":{ - "Marker":{"shape":"markerType"}, - "MaxItems":{"shape":"maxItemsType"} - } - }, - "ListAccountAliasesResponse":{ - "type":"structure", - "required":["AccountAliases"], - "members":{ - "AccountAliases":{"shape":"accountAliasListType"}, - "IsTruncated":{"shape":"booleanType"}, - "Marker":{"shape":"responseMarkerType"} - } - }, - "ListAttachedGroupPoliciesRequest":{ - "type":"structure", - "required":["GroupName"], - "members":{ - "GroupName":{"shape":"groupNameType"}, - "PathPrefix":{"shape":"policyPathType"}, - "Marker":{"shape":"markerType"}, - "MaxItems":{"shape":"maxItemsType"} - } - }, - "ListAttachedGroupPoliciesResponse":{ - "type":"structure", - "members":{ - "AttachedPolicies":{"shape":"attachedPoliciesListType"}, - "IsTruncated":{"shape":"booleanType"}, - "Marker":{"shape":"responseMarkerType"} - } - }, - "ListAttachedRolePoliciesRequest":{ - "type":"structure", - "required":["RoleName"], - "members":{ - "RoleName":{"shape":"roleNameType"}, - "PathPrefix":{"shape":"policyPathType"}, - "Marker":{"shape":"markerType"}, - "MaxItems":{"shape":"maxItemsType"} - } - }, - "ListAttachedRolePoliciesResponse":{ - "type":"structure", - "members":{ - "AttachedPolicies":{"shape":"attachedPoliciesListType"}, - "IsTruncated":{"shape":"booleanType"}, - "Marker":{"shape":"responseMarkerType"} - } - }, - "ListAttachedUserPoliciesRequest":{ - "type":"structure", - "required":["UserName"], - "members":{ - "UserName":{"shape":"userNameType"}, - "PathPrefix":{"shape":"policyPathType"}, - "Marker":{"shape":"markerType"}, - "MaxItems":{"shape":"maxItemsType"} - } - }, - "ListAttachedUserPoliciesResponse":{ - "type":"structure", - "members":{ - "AttachedPolicies":{"shape":"attachedPoliciesListType"}, - "IsTruncated":{"shape":"booleanType"}, - "Marker":{"shape":"responseMarkerType"} - } - }, - "ListDelegationRequestsRequest":{ - "type":"structure", - "members":{ - "OwnerId":{"shape":"ownerIdType"}, - "Marker":{"shape":"markerType"}, - "MaxItems":{"shape":"maxItemsType"} - } - }, - "ListDelegationRequestsResponse":{ - "type":"structure", - "members":{ - "DelegationRequests":{"shape":"delegationRequestsListType"}, - "Marker":{"shape":"markerType"}, - "isTruncated":{"shape":"booleanType"} - } - }, - "ListEntitiesForPolicyRequest":{ - "type":"structure", - "required":["PolicyArn"], - "members":{ - "PolicyArn":{"shape":"arnType"}, - "EntityFilter":{"shape":"EntityType"}, - "PathPrefix":{"shape":"pathType"}, - "PolicyUsageFilter":{"shape":"PolicyUsageType"}, - "Marker":{"shape":"markerType"}, - "MaxItems":{"shape":"maxItemsType"} - } - }, - "ListEntitiesForPolicyResponse":{ - "type":"structure", - "members":{ - "PolicyGroups":{"shape":"PolicyGroupListType"}, - "PolicyUsers":{"shape":"PolicyUserListType"}, - "PolicyRoles":{"shape":"PolicyRoleListType"}, - "IsTruncated":{"shape":"booleanType"}, - "Marker":{"shape":"responseMarkerType"} - } - }, - "ListGroupPoliciesRequest":{ - "type":"structure", - "required":["GroupName"], - "members":{ - "GroupName":{"shape":"groupNameType"}, - "Marker":{"shape":"markerType"}, - "MaxItems":{"shape":"maxItemsType"} - } - }, - "ListGroupPoliciesResponse":{ - "type":"structure", - "required":["PolicyNames"], - "members":{ - "PolicyNames":{"shape":"policyNameListType"}, - "IsTruncated":{"shape":"booleanType"}, - "Marker":{"shape":"responseMarkerType"} - } - }, - "ListGroupsForUserRequest":{ - "type":"structure", - "required":["UserName"], - "members":{ - "UserName":{"shape":"existingUserNameType"}, - "Marker":{"shape":"markerType"}, - "MaxItems":{"shape":"maxItemsType"} - } - }, - "ListGroupsForUserResponse":{ - "type":"structure", - "required":["Groups"], - "members":{ - "Groups":{"shape":"groupListType"}, - "IsTruncated":{"shape":"booleanType"}, - "Marker":{"shape":"responseMarkerType"} - } - }, - "ListGroupsRequest":{ - "type":"structure", - "members":{ - "PathPrefix":{"shape":"pathPrefixType"}, - "Marker":{"shape":"markerType"}, - "MaxItems":{"shape":"maxItemsType"} - } - }, - "ListGroupsResponse":{ - "type":"structure", - "required":["Groups"], - "members":{ - "Groups":{"shape":"groupListType"}, - "IsTruncated":{"shape":"booleanType"}, - "Marker":{"shape":"responseMarkerType"} - } - }, - "ListInstanceProfileTagsRequest":{ - "type":"structure", - "required":["InstanceProfileName"], - "members":{ - "InstanceProfileName":{"shape":"instanceProfileNameType"}, - "Marker":{"shape":"markerType"}, - "MaxItems":{"shape":"maxItemsType"} - } - }, - "ListInstanceProfileTagsResponse":{ - "type":"structure", - "required":["Tags"], - "members":{ - "Tags":{"shape":"tagListType"}, - "IsTruncated":{"shape":"booleanType"}, - "Marker":{"shape":"responseMarkerType"} - } - }, - "ListInstanceProfilesForRoleRequest":{ - "type":"structure", - "required":["RoleName"], - "members":{ - "RoleName":{"shape":"roleNameType"}, - "Marker":{"shape":"markerType"}, - "MaxItems":{"shape":"maxItemsType"} - } - }, - "ListInstanceProfilesForRoleResponse":{ - "type":"structure", - "required":["InstanceProfiles"], - "members":{ - "InstanceProfiles":{"shape":"instanceProfileListType"}, - "IsTruncated":{"shape":"booleanType"}, - "Marker":{"shape":"responseMarkerType"} - } - }, - "ListInstanceProfilesRequest":{ - "type":"structure", - "members":{ - "PathPrefix":{"shape":"pathPrefixType"}, - "Marker":{"shape":"markerType"}, - "MaxItems":{"shape":"maxItemsType"} - } - }, - "ListInstanceProfilesResponse":{ - "type":"structure", - "required":["InstanceProfiles"], - "members":{ - "InstanceProfiles":{"shape":"instanceProfileListType"}, - "IsTruncated":{"shape":"booleanType"}, - "Marker":{"shape":"responseMarkerType"} - } - }, - "ListMFADeviceTagsRequest":{ - "type":"structure", - "required":["SerialNumber"], - "members":{ - "SerialNumber":{"shape":"serialNumberType"}, - "Marker":{"shape":"markerType"}, - "MaxItems":{"shape":"maxItemsType"} - } - }, - "ListMFADeviceTagsResponse":{ - "type":"structure", - "required":["Tags"], - "members":{ - "Tags":{"shape":"tagListType"}, - "IsTruncated":{"shape":"booleanType"}, - "Marker":{"shape":"responseMarkerType"} - } - }, - "ListMFADevicesRequest":{ - "type":"structure", - "members":{ - "UserName":{"shape":"existingUserNameType"}, - "Marker":{"shape":"markerType"}, - "MaxItems":{"shape":"maxItemsType"} - } - }, - "ListMFADevicesResponse":{ - "type":"structure", - "required":["MFADevices"], - "members":{ - "MFADevices":{"shape":"mfaDeviceListType"}, - "IsTruncated":{"shape":"booleanType"}, - "Marker":{"shape":"responseMarkerType"} - } - }, - "ListOpenIDConnectProviderTagsRequest":{ - "type":"structure", - "required":["OpenIDConnectProviderArn"], - "members":{ - "OpenIDConnectProviderArn":{"shape":"arnType"}, - "Marker":{"shape":"markerType"}, - "MaxItems":{"shape":"maxItemsType"} - } - }, - "ListOpenIDConnectProviderTagsResponse":{ - "type":"structure", - "required":["Tags"], - "members":{ - "Tags":{"shape":"tagListType"}, - "IsTruncated":{"shape":"booleanType"}, - "Marker":{"shape":"responseMarkerType"} - } - }, - "ListOpenIDConnectProvidersRequest":{ - "type":"structure", - "members":{} - }, - "ListOpenIDConnectProvidersResponse":{ - "type":"structure", - "members":{ - "OpenIDConnectProviderList":{"shape":"OpenIDConnectProviderListType"} - } - }, - "ListOrganizationsFeaturesRequest":{ - "type":"structure", - "members":{} - }, - "ListOrganizationsFeaturesResponse":{ - "type":"structure", - "members":{ - "OrganizationId":{"shape":"OrganizationIdType"}, - "EnabledFeatures":{"shape":"FeaturesListType"} - } - }, - "ListPoliciesGrantingServiceAccessEntry":{ - "type":"structure", - "members":{ - "ServiceNamespace":{"shape":"serviceNamespaceType"}, - "Policies":{"shape":"policyGrantingServiceAccessListType"} - } - }, - "ListPoliciesGrantingServiceAccessRequest":{ - "type":"structure", - "required":[ - "Arn", - "ServiceNamespaces" - ], - "members":{ - "Marker":{"shape":"markerType"}, - "Arn":{"shape":"arnType"}, - "ServiceNamespaces":{"shape":"serviceNamespaceListType"} - } - }, - "ListPoliciesGrantingServiceAccessResponse":{ - "type":"structure", - "required":["PoliciesGrantingServiceAccess"], - "members":{ - "PoliciesGrantingServiceAccess":{"shape":"listPolicyGrantingServiceAccessResponseListType"}, - "IsTruncated":{"shape":"booleanType"}, - "Marker":{"shape":"responseMarkerType"} - } - }, - "ListPoliciesRequest":{ - "type":"structure", - "members":{ - "Scope":{"shape":"policyScopeType"}, - "OnlyAttached":{"shape":"booleanType"}, - "PathPrefix":{"shape":"policyPathType"}, - "PolicyUsageFilter":{"shape":"PolicyUsageType"}, - "Marker":{"shape":"markerType"}, - "MaxItems":{"shape":"maxItemsType"} - } - }, - "ListPoliciesResponse":{ - "type":"structure", - "members":{ - "Policies":{"shape":"policyListType"}, - "IsTruncated":{"shape":"booleanType"}, - "Marker":{"shape":"responseMarkerType"} - } - }, - "ListPolicyTagsRequest":{ - "type":"structure", - "required":["PolicyArn"], - "members":{ - "PolicyArn":{"shape":"arnType"}, - "Marker":{"shape":"markerType"}, - "MaxItems":{"shape":"maxItemsType"} - } - }, - "ListPolicyTagsResponse":{ - "type":"structure", - "required":["Tags"], - "members":{ - "Tags":{"shape":"tagListType"}, - "IsTruncated":{"shape":"booleanType"}, - "Marker":{"shape":"responseMarkerType"} - } - }, - "ListPolicyVersionsRequest":{ - "type":"structure", - "required":["PolicyArn"], - "members":{ - "PolicyArn":{"shape":"arnType"}, - "Marker":{"shape":"markerType"}, - "MaxItems":{"shape":"maxItemsType"} - } - }, - "ListPolicyVersionsResponse":{ - "type":"structure", - "members":{ - "Versions":{"shape":"policyDocumentVersionListType"}, - "IsTruncated":{"shape":"booleanType"}, - "Marker":{"shape":"responseMarkerType"} - } - }, - "ListRolePoliciesRequest":{ - "type":"structure", - "required":["RoleName"], - "members":{ - "RoleName":{"shape":"roleNameType"}, - "Marker":{"shape":"markerType"}, - "MaxItems":{"shape":"maxItemsType"} - } - }, - "ListRolePoliciesResponse":{ - "type":"structure", - "required":["PolicyNames"], - "members":{ - "PolicyNames":{"shape":"policyNameListType"}, - "IsTruncated":{"shape":"booleanType"}, - "Marker":{"shape":"responseMarkerType"} - } - }, - "ListRoleTagsRequest":{ - "type":"structure", - "required":["RoleName"], - "members":{ - "RoleName":{"shape":"roleNameType"}, - "Marker":{"shape":"markerType"}, - "MaxItems":{"shape":"maxItemsType"} - } - }, - "ListRoleTagsResponse":{ - "type":"structure", - "required":["Tags"], - "members":{ - "Tags":{"shape":"tagListType"}, - "IsTruncated":{"shape":"booleanType"}, - "Marker":{"shape":"responseMarkerType"} - } - }, - "ListRolesRequest":{ - "type":"structure", - "members":{ - "PathPrefix":{"shape":"pathPrefixType"}, - "Marker":{"shape":"markerType"}, - "MaxItems":{"shape":"maxItemsType"} - } - }, - "ListRolesResponse":{ - "type":"structure", - "required":["Roles"], - "members":{ - "Roles":{"shape":"roleListType"}, - "IsTruncated":{"shape":"booleanType"}, - "Marker":{"shape":"responseMarkerType"} - } - }, - "ListSAMLProviderTagsRequest":{ - "type":"structure", - "required":["SAMLProviderArn"], - "members":{ - "SAMLProviderArn":{"shape":"arnType"}, - "Marker":{"shape":"markerType"}, - "MaxItems":{"shape":"maxItemsType"} - } - }, - "ListSAMLProviderTagsResponse":{ - "type":"structure", - "required":["Tags"], - "members":{ - "Tags":{"shape":"tagListType"}, - "IsTruncated":{"shape":"booleanType"}, - "Marker":{"shape":"responseMarkerType"} - } - }, - "ListSAMLProvidersRequest":{ - "type":"structure", - "members":{} - }, - "ListSAMLProvidersResponse":{ - "type":"structure", - "members":{ - "SAMLProviderList":{"shape":"SAMLProviderListType"} - } - }, - "ListSSHPublicKeysRequest":{ - "type":"structure", - "members":{ - "UserName":{"shape":"userNameType"}, - "Marker":{"shape":"markerType"}, - "MaxItems":{"shape":"maxItemsType"} - } - }, - "ListSSHPublicKeysResponse":{ - "type":"structure", - "members":{ - "SSHPublicKeys":{"shape":"SSHPublicKeyListType"}, - "IsTruncated":{"shape":"booleanType"}, - "Marker":{"shape":"responseMarkerType"} - } - }, - "ListServerCertificateTagsRequest":{ - "type":"structure", - "required":["ServerCertificateName"], - "members":{ - "ServerCertificateName":{"shape":"serverCertificateNameType"}, - "Marker":{"shape":"markerType"}, - "MaxItems":{"shape":"maxItemsType"} - } - }, - "ListServerCertificateTagsResponse":{ - "type":"structure", - "required":["Tags"], - "members":{ - "Tags":{"shape":"tagListType"}, - "IsTruncated":{"shape":"booleanType"}, - "Marker":{"shape":"responseMarkerType"} - } - }, - "ListServerCertificatesRequest":{ - "type":"structure", - "members":{ - "PathPrefix":{"shape":"pathPrefixType"}, - "Marker":{"shape":"markerType"}, - "MaxItems":{"shape":"maxItemsType"} - } - }, - "ListServerCertificatesResponse":{ - "type":"structure", - "required":["ServerCertificateMetadataList"], - "members":{ - "ServerCertificateMetadataList":{"shape":"serverCertificateMetadataListType"}, - "IsTruncated":{"shape":"booleanType"}, - "Marker":{"shape":"responseMarkerType"} - } - }, - "ListServiceSpecificCredentialsRequest":{ - "type":"structure", - "members":{ - "UserName":{"shape":"userNameType"}, - "ServiceName":{"shape":"serviceName"}, - "AllUsers":{"shape":"allUsers"}, - "Marker":{"shape":"markerType"}, - "MaxItems":{"shape":"maxItemsType"} - } - }, - "ListServiceSpecificCredentialsResponse":{ - "type":"structure", - "members":{ - "ServiceSpecificCredentials":{"shape":"ServiceSpecificCredentialsListType"}, - "Marker":{"shape":"responseMarkerType"}, - "IsTruncated":{"shape":"booleanType"} - } - }, - "ListSigningCertificatesRequest":{ - "type":"structure", - "members":{ - "UserName":{"shape":"existingUserNameType"}, - "Marker":{"shape":"markerType"}, - "MaxItems":{"shape":"maxItemsType"} - } - }, - "ListSigningCertificatesResponse":{ - "type":"structure", - "required":["Certificates"], - "members":{ - "Certificates":{"shape":"certificateListType"}, - "IsTruncated":{"shape":"booleanType"}, - "Marker":{"shape":"responseMarkerType"} - } - }, - "ListUserPoliciesRequest":{ - "type":"structure", - "required":["UserName"], - "members":{ - "UserName":{"shape":"existingUserNameType"}, - "Marker":{"shape":"markerType"}, - "MaxItems":{"shape":"maxItemsType"} - } - }, - "ListUserPoliciesResponse":{ - "type":"structure", - "required":["PolicyNames"], - "members":{ - "PolicyNames":{"shape":"policyNameListType"}, - "IsTruncated":{"shape":"booleanType"}, - "Marker":{"shape":"responseMarkerType"} - } - }, - "ListUserTagsRequest":{ - "type":"structure", - "required":["UserName"], - "members":{ - "UserName":{"shape":"existingUserNameType"}, - "Marker":{"shape":"markerType"}, - "MaxItems":{"shape":"maxItemsType"} - } - }, - "ListUserTagsResponse":{ - "type":"structure", - "required":["Tags"], - "members":{ - "Tags":{"shape":"tagListType"}, - "IsTruncated":{"shape":"booleanType"}, - "Marker":{"shape":"responseMarkerType"} - } - }, - "ListUsersRequest":{ - "type":"structure", - "members":{ - "PathPrefix":{"shape":"pathPrefixType"}, - "Marker":{"shape":"markerType"}, - "MaxItems":{"shape":"maxItemsType"} - } - }, - "ListUsersResponse":{ - "type":"structure", - "required":["Users"], - "members":{ - "Users":{"shape":"userListType"}, - "IsTruncated":{"shape":"booleanType"}, - "Marker":{"shape":"responseMarkerType"} - } - }, - "ListVirtualMFADevicesRequest":{ - "type":"structure", - "members":{ - "AssignmentStatus":{"shape":"assignmentStatusType"}, - "Marker":{"shape":"markerType"}, - "MaxItems":{"shape":"maxItemsType"} - } - }, - "ListVirtualMFADevicesResponse":{ - "type":"structure", - "required":["VirtualMFADevices"], - "members":{ - "VirtualMFADevices":{"shape":"virtualMFADeviceListType"}, - "IsTruncated":{"shape":"booleanType"}, - "Marker":{"shape":"responseMarkerType"} - } - }, - "LoginProfile":{ - "type":"structure", - "required":[ - "UserName", - "CreateDate" - ], - "members":{ - "UserName":{"shape":"userNameType"}, - "CreateDate":{"shape":"dateType"}, - "PasswordResetRequired":{"shape":"booleanType"} - } - }, - "MFADevice":{ - "type":"structure", - "required":[ - "UserName", - "SerialNumber", - "EnableDate" - ], - "members":{ - "UserName":{"shape":"userNameType"}, - "SerialNumber":{"shape":"serialNumberType"}, - "EnableDate":{"shape":"dateType"} - } - }, - "MalformedCertificateException":{ - "type":"structure", - "members":{ - "message":{"shape":"malformedCertificateMessage"} - }, - "error":{ - "code":"MalformedCertificate", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "MalformedPolicyDocumentException":{ - "type":"structure", - "members":{ - "message":{"shape":"malformedPolicyDocumentMessage"} - }, - "error":{ - "code":"MalformedPolicyDocument", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "ManagedPolicyDetail":{ - "type":"structure", - "members":{ - "PolicyName":{"shape":"policyNameType"}, - "PolicyId":{"shape":"idType"}, - "Arn":{"shape":"arnType"}, - "Path":{"shape":"policyPathType"}, - "DefaultVersionId":{"shape":"policyVersionIdType"}, - "AttachmentCount":{"shape":"attachmentCountType"}, - "PermissionsBoundaryUsageCount":{"shape":"attachmentCountType"}, - "IsAttachable":{"shape":"booleanType"}, - "Description":{"shape":"policyDescriptionType"}, - "CreateDate":{"shape":"dateType"}, - "UpdateDate":{"shape":"dateType"}, - "PolicyVersionList":{"shape":"policyDocumentVersionListType"} - } - }, - "ManagedPolicyDetailListType":{ - "type":"list", - "member":{"shape":"ManagedPolicyDetail"} - }, - "NoSuchEntityException":{ - "type":"structure", - "members":{ - "message":{"shape":"noSuchEntityMessage"} - }, - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true - }, - "OpenIDConnectProviderListEntry":{ - "type":"structure", - "members":{ - "Arn":{"shape":"arnType"} - } - }, - "OpenIDConnectProviderListType":{ - "type":"list", - "member":{"shape":"OpenIDConnectProviderListEntry"} - }, - "OpenIDConnectProviderUrlType":{ - "type":"string", - "max":255, - "min":1 - }, - "OpenIdIdpCommunicationErrorException":{ - "type":"structure", - "members":{ - "message":{"shape":"openIdIdpCommunicationErrorExceptionMessage"} - }, - "error":{ - "code":"OpenIdIdpCommunicationError", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "OrderedOrganizationPolicyType":{ - "type":"structure", - "members":{ - "ServiceControlPolicyInputList":{"shape":"SimulationPolicyListType"} - } - }, - "OrganizationIdType":{ - "type":"string", - "max":34, - "pattern":"^o-[a-z0-9]{10,32}$" - }, - "OrganizationNotFoundException":{ - "type":"structure", - "members":{}, - "exception":true - }, - "OrganizationNotInAllFeaturesModeException":{ - "type":"structure", - "members":{}, - "exception":true - }, - "OrganizationPolicyListType":{ - "type":"list", - "member":{"shape":"OrderedOrganizationPolicyType"}, - "max":7 - }, - "OrganizationsDecisionDetail":{ - "type":"structure", - "members":{ - "AllowedByOrganizations":{"shape":"booleanType"} - } - }, - "PasswordPolicy":{ - "type":"structure", - "members":{ - "MinimumPasswordLength":{"shape":"minimumPasswordLengthType"}, - "RequireSymbols":{"shape":"booleanType"}, - "RequireNumbers":{"shape":"booleanType"}, - "RequireUppercaseCharacters":{"shape":"booleanType"}, - "RequireLowercaseCharacters":{"shape":"booleanType"}, - "AllowUsersToChangePassword":{"shape":"booleanType"}, - "ExpirePasswords":{"shape":"booleanType"}, - "MaxPasswordAge":{"shape":"maxPasswordAgeType"}, - "PasswordReusePrevention":{"shape":"passwordReusePreventionType"}, - "HardExpiry":{"shape":"booleanObjectType"} - } - }, - "PasswordPolicyViolationException":{ - "type":"structure", - "members":{ - "message":{"shape":"passwordPolicyViolationMessage"} - }, - "error":{ - "code":"PasswordPolicyViolation", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "PermissionsBoundaryAttachmentType":{ - "type":"string", - "enum":["PermissionsBoundaryPolicy"] - }, - "PermissionsBoundaryDecisionDetail":{ - "type":"structure", - "members":{ - "AllowedByPermissionsBoundary":{"shape":"booleanType"} - } - }, - "Policy":{ - "type":"structure", - "members":{ - "PolicyName":{"shape":"policyNameType"}, - "PolicyId":{"shape":"idType"}, - "Arn":{"shape":"arnType"}, - "Path":{"shape":"policyPathType"}, - "DefaultVersionId":{"shape":"policyVersionIdType"}, - "AttachmentCount":{"shape":"attachmentCountType"}, - "PermissionsBoundaryUsageCount":{"shape":"attachmentCountType"}, - "IsAttachable":{"shape":"booleanType"}, - "Description":{"shape":"policyDescriptionType"}, - "CreateDate":{"shape":"dateType"}, - "UpdateDate":{"shape":"dateType"}, - "Tags":{"shape":"tagListType"} - } - }, - "PolicyDetail":{ - "type":"structure", - "members":{ - "PolicyName":{"shape":"policyNameType"}, - "PolicyDocument":{"shape":"policyDocumentType"} - } - }, - "PolicyEvaluationDecisionType":{ - "type":"string", - "enum":[ - "allowed", - "explicitDeny", - "implicitDeny" - ] - }, - "PolicyEvaluationException":{ - "type":"structure", - "members":{ - "message":{"shape":"policyEvaluationErrorMessage"} - }, - "error":{ - "code":"PolicyEvaluation", - "httpStatusCode":500 - }, - "exception":true - }, - "PolicyExclusionsListType":{ - "type":"list", - "member":{"shape":"PolicyIdentifier"}, - "max":256 - }, - "PolicyGrantingServiceAccess":{ - "type":"structure", - "required":[ - "PolicyName", - "PolicyType" - ], - "members":{ - "PolicyName":{"shape":"policyNameType"}, - "PolicyType":{"shape":"policyType"}, - "PolicyArn":{"shape":"arnType"}, - "EntityType":{"shape":"policyOwnerEntityType"}, - "EntityName":{"shape":"entityNameType"} - } - }, - "PolicyGroup":{ - "type":"structure", - "members":{ - "GroupName":{"shape":"groupNameType"}, - "GroupId":{"shape":"idType"} - } - }, - "PolicyGroupListType":{ - "type":"list", - "member":{"shape":"PolicyGroup"} - }, - "PolicyIdentifier":{ - "type":"structure", - "members":{ - "PolicyType":{"shape":"PolicyIdentifierPolicyType"}, - "PolicyArn":{"shape":"arnType"}, - "InlinePolicyIdentifier":{"shape":"InlinePolicyIdentifierType"} - }, - "union":true - }, - "PolicyIdentifierPolicyType":{ - "type":"string", - "enum":[ - "inline", - "aws-managed", - "user-managed", - "permission-boundary", - "scp", - "rcp" - ] - }, - "PolicyIdentifierType":{"type":"string"}, - "PolicyNotAttachableException":{ - "type":"structure", - "members":{ - "message":{"shape":"policyNotAttachableMessage"} - }, - "error":{ - "code":"PolicyNotAttachable", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "PolicyParameter":{ - "type":"structure", - "members":{ - "Name":{"shape":"policyParameterNameType"}, - "Values":{"shape":"policyParameterValuesListType"}, - "Type":{"shape":"PolicyParameterTypeEnum"} - } - }, - "PolicyParameterTypeEnum":{ - "type":"string", - "enum":[ - "string", - "stringList" - ] - }, - "PolicyRole":{ - "type":"structure", - "members":{ - "RoleName":{"shape":"roleNameType"}, - "RoleId":{"shape":"idType"} - } - }, - "PolicyRoleListType":{ - "type":"list", - "member":{"shape":"PolicyRole"} - }, - "PolicySourceType":{ - "type":"string", - "enum":[ - "user", - "group", - "role", - "aws-managed", - "user-managed", - "resource", - "none" - ] - }, - "PolicyUsageType":{ - "type":"string", - "enum":[ - "PermissionsPolicy", - "PermissionsBoundary" - ] - }, - "PolicyUser":{ - "type":"structure", - "members":{ - "UserName":{"shape":"userNameType"}, - "UserId":{"shape":"idType"} - } - }, - "PolicyUserListType":{ - "type":"list", - "member":{"shape":"PolicyUser"} - }, - "PolicyVersion":{ - "type":"structure", - "members":{ - "Document":{"shape":"policyDocumentType"}, - "VersionId":{"shape":"policyVersionIdType"}, - "IsDefaultVersion":{"shape":"booleanType"}, - "CreateDate":{"shape":"dateType"} - } - }, - "Position":{ - "type":"structure", - "members":{ - "Line":{"shape":"LineNumber"}, - "Column":{"shape":"ColumnNumber"} - } - }, - "PutGroupPolicyRequest":{ - "type":"structure", - "required":[ - "GroupName", - "PolicyName", - "PolicyDocument" - ], - "members":{ - "GroupName":{"shape":"groupNameType"}, - "PolicyName":{"shape":"policyNameType"}, - "PolicyDocument":{"shape":"policyDocumentType"} - } - }, - "PutRolePermissionsBoundaryRequest":{ - "type":"structure", - "required":[ - "RoleName", - "PermissionsBoundary" - ], - "members":{ - "RoleName":{"shape":"roleNameType"}, - "PermissionsBoundary":{"shape":"arnType"} - } - }, - "PutRolePolicyRequest":{ - "type":"structure", - "required":[ - "RoleName", - "PolicyName", - "PolicyDocument" - ], - "members":{ - "RoleName":{"shape":"roleNameType"}, - "PolicyName":{"shape":"policyNameType"}, - "PolicyDocument":{"shape":"policyDocumentType"} - } - }, - "PutUserPermissionsBoundaryRequest":{ - "type":"structure", - "required":[ - "UserName", - "PermissionsBoundary" - ], - "members":{ - "UserName":{"shape":"userNameType"}, - "PermissionsBoundary":{"shape":"arnType"} - } - }, - "PutUserPolicyRequest":{ - "type":"structure", - "required":[ - "UserName", - "PolicyName", - "PolicyDocument" - ], - "members":{ - "UserName":{"shape":"existingUserNameType"}, - "PolicyName":{"shape":"policyNameType"}, - "PolicyDocument":{"shape":"policyDocumentType"} - } - }, - "ReasonType":{ - "type":"string", - "max":1000 - }, - "RegionNameType":{ - "type":"string", - "max":100, - "min":1 - }, - "RejectDelegationRequestRequest":{ - "type":"structure", - "required":["DelegationRequestId"], - "members":{ - "DelegationRequestId":{"shape":"delegationRequestIdType"}, - "Notes":{"shape":"notesType"} - } - }, - "RemoveClientIDFromOpenIDConnectProviderRequest":{ - "type":"structure", - "required":[ - "OpenIDConnectProviderArn", - "ClientID" - ], - "members":{ - "OpenIDConnectProviderArn":{"shape":"arnType"}, - "ClientID":{"shape":"clientIDType"} - } - }, - "RemoveRoleFromInstanceProfileRequest":{ - "type":"structure", - "required":[ - "InstanceProfileName", - "RoleName" - ], - "members":{ - "InstanceProfileName":{"shape":"instanceProfileNameType"}, - "RoleName":{"shape":"roleNameType"} - } - }, - "RemoveUserFromGroupRequest":{ - "type":"structure", - "required":[ - "GroupName", - "UserName" - ], - "members":{ - "GroupName":{"shape":"groupNameType"}, - "UserName":{"shape":"existingUserNameType"} - } - }, - "ReportContentType":{"type":"blob"}, - "ReportFormatType":{ - "type":"string", - "enum":["text/csv"] - }, - "ReportGenerationLimitExceededException":{ - "type":"structure", - "members":{ - "message":{"shape":"reportGenerationLimitExceededMessage"} - }, - "error":{ - "code":"ReportGenerationLimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true - }, - "ReportStateDescriptionType":{"type":"string"}, - "ReportStateType":{ - "type":"string", - "enum":[ - "STARTED", - "INPROGRESS", - "COMPLETE" - ] - }, - "ResetServiceSpecificCredentialRequest":{ - "type":"structure", - "required":["ServiceSpecificCredentialId"], - "members":{ - "UserName":{"shape":"userNameType"}, - "ServiceSpecificCredentialId":{"shape":"serviceSpecificCredentialId"} - } - }, - "ResetServiceSpecificCredentialResponse":{ - "type":"structure", - "members":{ - "ServiceSpecificCredential":{"shape":"ServiceSpecificCredential"} - } - }, - "ResourceHandlingOptionType":{ - "type":"string", - "max":64, - "min":1 - }, - "ResourceNameListType":{ - "type":"list", - "member":{"shape":"ResourceNameType"} - }, - "ResourceNameType":{ - "type":"string", - "max":2048, - "min":1 - }, - "ResourceSpecificResult":{ - "type":"structure", - "required":[ - "EvalResourceName", - "EvalResourceDecision" - ], - "members":{ - "EvalResourceName":{"shape":"ResourceNameType"}, - "EvalResourceDecision":{"shape":"PolicyEvaluationDecisionType"}, - "MatchedStatements":{"shape":"StatementListType"}, - "MissingContextValues":{"shape":"ContextKeyNamesResultListType"}, - "EvalDecisionDetails":{"shape":"EvalDecisionDetailsType"}, - "PermissionsBoundaryDecisionDetail":{"shape":"PermissionsBoundaryDecisionDetail"} - } - }, - "ResourceSpecificResultListType":{ - "type":"list", - "member":{"shape":"ResourceSpecificResult"} - }, - "ResyncMFADeviceRequest":{ - "type":"structure", - "required":[ - "UserName", - "SerialNumber", - "AuthenticationCode1", - "AuthenticationCode2" - ], - "members":{ - "UserName":{"shape":"existingUserNameType"}, - "SerialNumber":{"shape":"serialNumberType"}, - "AuthenticationCode1":{"shape":"authenticationCodeType"}, - "AuthenticationCode2":{"shape":"authenticationCodeType"} - } - }, - "Role":{ - "type":"structure", - "required":[ - "Path", - "RoleName", - "RoleId", - "Arn", - "CreateDate" - ], - "members":{ - "Path":{"shape":"pathType"}, - "RoleName":{"shape":"roleNameType"}, - "RoleId":{"shape":"idType"}, - "Arn":{"shape":"arnType"}, - "CreateDate":{"shape":"dateType"}, - "AssumeRolePolicyDocument":{"shape":"policyDocumentType"}, - "Description":{"shape":"roleDescriptionType"}, - "MaxSessionDuration":{"shape":"roleMaxSessionDurationType"}, - "PermissionsBoundary":{"shape":"AttachedPermissionsBoundary"}, - "Tags":{"shape":"tagListType"}, - "RoleLastUsed":{"shape":"RoleLastUsed"} - } - }, - "RoleDetail":{ - "type":"structure", - "members":{ - "Path":{"shape":"pathType"}, - "RoleName":{"shape":"roleNameType"}, - "RoleId":{"shape":"idType"}, - "Arn":{"shape":"arnType"}, - "CreateDate":{"shape":"dateType"}, - "AssumeRolePolicyDocument":{"shape":"policyDocumentType"}, - "InstanceProfileList":{"shape":"instanceProfileListType"}, - "RolePolicyList":{"shape":"policyDetailListType"}, - "AttachedManagedPolicies":{"shape":"attachedPoliciesListType"}, - "PermissionsBoundary":{"shape":"AttachedPermissionsBoundary"}, - "Tags":{"shape":"tagListType"}, - "RoleLastUsed":{"shape":"RoleLastUsed"} - } - }, - "RoleLastUsed":{ - "type":"structure", - "members":{ - "LastUsedDate":{"shape":"dateType"}, - "Region":{"shape":"stringType"} - } - }, - "RoleUsageListType":{ - "type":"list", - "member":{"shape":"RoleUsageType"} - }, - "RoleUsageType":{ - "type":"structure", - "members":{ - "Region":{"shape":"RegionNameType"}, - "Resources":{"shape":"ArnListType"} - } - }, - "SAMLMetadataDocumentType":{ - "type":"string", - "max":10000000, - "min":1000 - }, - "SAMLPrivateKey":{ - "type":"structure", - "members":{ - "KeyId":{"shape":"privateKeyIdType"}, - "Timestamp":{"shape":"dateType"} - } - }, - "SAMLProviderListEntry":{ - "type":"structure", - "members":{ - "Arn":{"shape":"arnType"}, - "ValidUntil":{"shape":"dateType"}, - "CreateDate":{"shape":"dateType"} - } - }, - "SAMLProviderListType":{ - "type":"list", - "member":{"shape":"SAMLProviderListEntry"} - }, - "SAMLProviderNameType":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[\\w._-]+" - }, - "SSHPublicKey":{ - "type":"structure", - "required":[ - "UserName", - "SSHPublicKeyId", - "Fingerprint", - "SSHPublicKeyBody", - "Status" - ], - "members":{ - "UserName":{"shape":"userNameType"}, - "SSHPublicKeyId":{"shape":"publicKeyIdType"}, - "Fingerprint":{"shape":"publicKeyFingerprintType"}, - "SSHPublicKeyBody":{"shape":"publicKeyMaterialType"}, - "Status":{"shape":"statusType"}, - "UploadDate":{"shape":"dateType"} - } - }, - "SSHPublicKeyListType":{ - "type":"list", - "member":{"shape":"SSHPublicKeyMetadata"} - }, - "SSHPublicKeyMetadata":{ - "type":"structure", - "required":[ - "UserName", - "SSHPublicKeyId", - "Status", - "UploadDate" - ], - "members":{ - "UserName":{"shape":"userNameType"}, - "SSHPublicKeyId":{"shape":"publicKeyIdType"}, - "Status":{"shape":"statusType"}, - "UploadDate":{"shape":"dateType"} - } - }, - "SendDelegationTokenRequest":{ - "type":"structure", - "required":["DelegationRequestId"], - "members":{ - "DelegationRequestId":{"shape":"delegationRequestIdType"} - } - }, - "ServerCertificate":{ - "type":"structure", - "required":[ - "ServerCertificateMetadata", - "CertificateBody" - ], - "members":{ - "ServerCertificateMetadata":{"shape":"ServerCertificateMetadata"}, - "CertificateBody":{"shape":"certificateBodyType"}, - "CertificateChain":{"shape":"certificateChainType"}, - "Tags":{"shape":"tagListType"} - } - }, - "ServerCertificateMetadata":{ - "type":"structure", - "required":[ - "Path", - "ServerCertificateName", - "ServerCertificateId", - "Arn" - ], - "members":{ - "Path":{"shape":"pathType"}, - "ServerCertificateName":{"shape":"serverCertificateNameType"}, - "ServerCertificateId":{"shape":"idType"}, - "Arn":{"shape":"arnType"}, - "UploadDate":{"shape":"dateType"}, - "Expiration":{"shape":"dateType"} - } - }, - "ServiceAccessNotEnabledException":{ - "type":"structure", - "members":{}, - "exception":true - }, - "ServiceFailureException":{ - "type":"structure", - "members":{ - "message":{"shape":"serviceFailureExceptionMessage"} - }, - "error":{ - "code":"ServiceFailure", - "httpStatusCode":500 - }, - "exception":true - }, - "ServiceLastAccessed":{ - "type":"structure", - "required":[ - "ServiceName", - "ServiceNamespace" - ], - "members":{ - "ServiceName":{"shape":"serviceNameType"}, - "LastAuthenticated":{"shape":"dateType"}, - "ServiceNamespace":{"shape":"serviceNamespaceType"}, - "LastAuthenticatedEntity":{"shape":"arnType"}, - "LastAuthenticatedRegion":{"shape":"stringType"}, - "TotalAuthenticatedEntities":{"shape":"integerType"}, - "TrackedActionsLastAccessed":{"shape":"TrackedActionsLastAccessed"} - } - }, - "ServiceNotSupportedException":{ - "type":"structure", - "members":{ - "message":{"shape":"serviceNotSupportedMessage"} - }, - "error":{ - "code":"NotSupportedService", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true - }, - "ServiceSpecificCredential":{ - "type":"structure", - "required":[ - "CreateDate", - "ServiceName", - "ServiceSpecificCredentialId", - "UserName", - "Status" - ], - "members":{ - "CreateDate":{"shape":"dateType"}, - "ExpirationDate":{"shape":"dateType"}, - "ServiceName":{"shape":"serviceName"}, - "ServiceUserName":{"shape":"serviceUserName"}, - "ServicePassword":{"shape":"servicePassword"}, - "ServiceCredentialAlias":{"shape":"serviceCredentialAlias"}, - "ServiceCredentialSecret":{"shape":"serviceCredentialSecret"}, - "ServiceSpecificCredentialId":{"shape":"serviceSpecificCredentialId"}, - "UserName":{"shape":"userNameType"}, - "Status":{"shape":"statusType"} - } - }, - "ServiceSpecificCredentialMetadata":{ - "type":"structure", - "required":[ - "UserName", - "Status", - "CreateDate", - "ServiceSpecificCredentialId", - "ServiceName" - ], - "members":{ - "UserName":{"shape":"userNameType"}, - "Status":{"shape":"statusType"}, - "ServiceUserName":{"shape":"serviceUserName"}, - "ServiceCredentialAlias":{"shape":"serviceCredentialAlias"}, - "CreateDate":{"shape":"dateType"}, - "ExpirationDate":{"shape":"dateType"}, - "ServiceSpecificCredentialId":{"shape":"serviceSpecificCredentialId"}, - "ServiceName":{"shape":"serviceName"} - } - }, - "ServiceSpecificCredentialsListType":{ - "type":"list", - "member":{"shape":"ServiceSpecificCredentialMetadata"} - }, - "ServicesLastAccessed":{ - "type":"list", - "member":{"shape":"ServiceLastAccessed"} - }, - "SetDefaultPolicyVersionRequest":{ - "type":"structure", - "required":[ - "PolicyArn", - "VersionId" - ], - "members":{ - "PolicyArn":{"shape":"arnType"}, - "VersionId":{"shape":"policyVersionIdType"} - } - }, - "SetSecurityTokenServicePreferencesRequest":{ - "type":"structure", - "required":["GlobalEndpointTokenVersion"], - "members":{ - "GlobalEndpointTokenVersion":{"shape":"globalEndpointTokenVersion"} - } - }, - "SigningCertificate":{ - "type":"structure", - "required":[ - "UserName", - "CertificateId", - "CertificateBody", - "Status" - ], - "members":{ - "UserName":{"shape":"userNameType"}, - "CertificateId":{"shape":"certificateIdType"}, - "CertificateBody":{"shape":"certificateBodyType"}, - "Status":{"shape":"statusType"}, - "UploadDate":{"shape":"dateType"} - } - }, - "SimulateCustomPolicyRequest":{ - "type":"structure", - "required":[ - "PolicyInputList", - "ActionNames" - ], - "members":{ - "PolicyInputList":{"shape":"SimulationPolicyListType"}, - "PermissionsBoundaryPolicyInputList":{"shape":"SimulationPolicyListType"}, - "OrderedOrganizationPolicyInputList":{"shape":"OrganizationPolicyListType"}, - "ActionNames":{"shape":"ActionNameListType"}, - "ResourceArns":{"shape":"ResourceNameListType"}, - "ResourcePolicy":{"shape":"policyDocumentType"}, - "ResourceOwner":{"shape":"ResourceNameType"}, - "CallerArn":{"shape":"ResourceNameType"}, - "ContextEntries":{"shape":"ContextEntryListType"}, - "ResourceHandlingOption":{"shape":"ResourceHandlingOptionType"}, - "MaxItems":{"shape":"maxItemsType"}, - "Marker":{"shape":"markerType"} - } - }, - "SimulatePolicyResponse":{ - "type":"structure", - "members":{ - "EvaluationResults":{"shape":"EvaluationResultsListType"}, - "IsTruncated":{"shape":"booleanType"}, - "Marker":{"shape":"responseMarkerType"} - } - }, - "SimulatePrincipalPolicyRequest":{ - "type":"structure", - "required":[ - "PolicySourceArn", - "ActionNames" - ], - "members":{ - "PolicySourceArn":{"shape":"arnType"}, - "PolicyInputList":{"shape":"SimulationPolicyListType"}, - "PermissionsBoundaryPolicyInputList":{"shape":"SimulationPolicyListType"}, - "PolicyExclusionList":{"shape":"PolicyExclusionsListType"}, - "ActionNames":{"shape":"ActionNameListType"}, - "ResourceArns":{"shape":"ResourceNameListType"}, - "ResourcePolicy":{"shape":"policyDocumentType"}, - "ResourceOwner":{"shape":"ResourceNameType"}, - "CallerArn":{"shape":"ResourceNameType"}, - "ContextEntries":{"shape":"ContextEntryListType"}, - "ResourceHandlingOption":{"shape":"ResourceHandlingOptionType"}, - "MaxItems":{"shape":"maxItemsType"}, - "Marker":{"shape":"markerType"} - } - }, - "SimulationPolicyListType":{ - "type":"list", - "member":{"shape":"policyDocumentType"} - }, - "Statement":{ - "type":"structure", - "members":{ - "SourcePolicyId":{"shape":"PolicyIdentifierType"}, - "SourcePolicyType":{"shape":"PolicySourceType"}, - "StartPosition":{"shape":"Position"}, - "EndPosition":{"shape":"Position"} - } - }, - "StatementListType":{ - "type":"list", - "member":{"shape":"Statement"} - }, - "Tag":{ - "type":"structure", - "required":[ - "Key", - "Value" - ], - "members":{ - "Key":{"shape":"tagKeyType"}, - "Value":{"shape":"tagValueType"} - } - }, - "TagInstanceProfileRequest":{ - "type":"structure", - "required":[ - "InstanceProfileName", - "Tags" - ], - "members":{ - "InstanceProfileName":{"shape":"instanceProfileNameType"}, - "Tags":{"shape":"tagListType"} - } - }, - "TagMFADeviceRequest":{ - "type":"structure", - "required":[ - "SerialNumber", - "Tags" - ], - "members":{ - "SerialNumber":{"shape":"serialNumberType"}, - "Tags":{"shape":"tagListType"} - } - }, - "TagOpenIDConnectProviderRequest":{ - "type":"structure", - "required":[ - "OpenIDConnectProviderArn", - "Tags" - ], - "members":{ - "OpenIDConnectProviderArn":{"shape":"arnType"}, - "Tags":{"shape":"tagListType"} - } - }, - "TagPolicyRequest":{ - "type":"structure", - "required":[ - "PolicyArn", - "Tags" - ], - "members":{ - "PolicyArn":{"shape":"arnType"}, - "Tags":{"shape":"tagListType"} - } - }, - "TagRoleRequest":{ - "type":"structure", - "required":[ - "RoleName", - "Tags" - ], - "members":{ - "RoleName":{"shape":"roleNameType"}, - "Tags":{"shape":"tagListType"} - } - }, - "TagSAMLProviderRequest":{ - "type":"structure", - "required":[ - "SAMLProviderArn", - "Tags" - ], - "members":{ - "SAMLProviderArn":{"shape":"arnType"}, - "Tags":{"shape":"tagListType"} - } - }, - "TagServerCertificateRequest":{ - "type":"structure", - "required":[ - "ServerCertificateName", - "Tags" - ], - "members":{ - "ServerCertificateName":{"shape":"serverCertificateNameType"}, - "Tags":{"shape":"tagListType"} - } - }, - "TagUserRequest":{ - "type":"structure", - "required":[ - "UserName", - "Tags" - ], - "members":{ - "UserName":{"shape":"existingUserNameType"}, - "Tags":{"shape":"tagListType"} - } - }, - "TrackedActionLastAccessed":{ - "type":"structure", - "members":{ - "ActionName":{"shape":"stringType"}, - "LastAccessedEntity":{"shape":"arnType"}, - "LastAccessedTime":{"shape":"dateType"}, - "LastAccessedRegion":{"shape":"stringType"} - } - }, - "TrackedActionsLastAccessed":{ - "type":"list", - "member":{"shape":"TrackedActionLastAccessed"} - }, - "UnmodifiableEntityException":{ - "type":"structure", - "members":{ - "message":{"shape":"unmodifiableEntityMessage"} - }, - "error":{ - "code":"UnmodifiableEntity", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "UnrecognizedPublicKeyEncodingException":{ - "type":"structure", - "members":{ - "message":{"shape":"unrecognizedPublicKeyEncodingMessage"} - }, - "error":{ - "code":"UnrecognizedPublicKeyEncoding", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "UntagInstanceProfileRequest":{ - "type":"structure", - "required":[ - "InstanceProfileName", - "TagKeys" - ], - "members":{ - "InstanceProfileName":{"shape":"instanceProfileNameType"}, - "TagKeys":{"shape":"tagKeyListType"} - } - }, - "UntagMFADeviceRequest":{ - "type":"structure", - "required":[ - "SerialNumber", - "TagKeys" - ], - "members":{ - "SerialNumber":{"shape":"serialNumberType"}, - "TagKeys":{"shape":"tagKeyListType"} - } - }, - "UntagOpenIDConnectProviderRequest":{ - "type":"structure", - "required":[ - "OpenIDConnectProviderArn", - "TagKeys" - ], - "members":{ - "OpenIDConnectProviderArn":{"shape":"arnType"}, - "TagKeys":{"shape":"tagKeyListType"} - } - }, - "UntagPolicyRequest":{ - "type":"structure", - "required":[ - "PolicyArn", - "TagKeys" - ], - "members":{ - "PolicyArn":{"shape":"arnType"}, - "TagKeys":{"shape":"tagKeyListType"} - } - }, - "UntagRoleRequest":{ - "type":"structure", - "required":[ - "RoleName", - "TagKeys" - ], - "members":{ - "RoleName":{"shape":"roleNameType"}, - "TagKeys":{"shape":"tagKeyListType"} - } - }, - "UntagSAMLProviderRequest":{ - "type":"structure", - "required":[ - "SAMLProviderArn", - "TagKeys" - ], - "members":{ - "SAMLProviderArn":{"shape":"arnType"}, - "TagKeys":{"shape":"tagKeyListType"} - } - }, - "UntagServerCertificateRequest":{ - "type":"structure", - "required":[ - "ServerCertificateName", - "TagKeys" - ], - "members":{ - "ServerCertificateName":{"shape":"serverCertificateNameType"}, - "TagKeys":{"shape":"tagKeyListType"} - } - }, - "UntagUserRequest":{ - "type":"structure", - "required":[ - "UserName", - "TagKeys" - ], - "members":{ - "UserName":{"shape":"existingUserNameType"}, - "TagKeys":{"shape":"tagKeyListType"} - } - }, - "UpdateAccessKeyRequest":{ - "type":"structure", - "required":[ - "AccessKeyId", - "Status" - ], - "members":{ - "UserName":{"shape":"existingUserNameType"}, - "AccessKeyId":{"shape":"accessKeyIdType"}, - "Status":{"shape":"statusType"} - } - }, - "UpdateAccountPasswordPolicyRequest":{ - "type":"structure", - "members":{ - "MinimumPasswordLength":{"shape":"minimumPasswordLengthType"}, - "RequireSymbols":{"shape":"booleanType"}, - "RequireNumbers":{"shape":"booleanType"}, - "RequireUppercaseCharacters":{"shape":"booleanType"}, - "RequireLowercaseCharacters":{"shape":"booleanType"}, - "AllowUsersToChangePassword":{"shape":"booleanType"}, - "MaxPasswordAge":{"shape":"maxPasswordAgeType"}, - "PasswordReusePrevention":{"shape":"passwordReusePreventionType"}, - "HardExpiry":{"shape":"booleanObjectType"} - } - }, - "UpdateAssumeRolePolicyRequest":{ - "type":"structure", - "required":[ - "RoleName", - "PolicyDocument" - ], - "members":{ - "RoleName":{"shape":"roleNameType"}, - "PolicyDocument":{"shape":"policyDocumentType"} - } - }, - "UpdateDelegationRequestRequest":{ - "type":"structure", - "required":["DelegationRequestId"], - "members":{ - "DelegationRequestId":{"shape":"delegationRequestIdType"}, - "Notes":{"shape":"notesType"} - } - }, - "UpdateGroupRequest":{ - "type":"structure", - "required":["GroupName"], - "members":{ - "GroupName":{"shape":"groupNameType"}, - "NewPath":{"shape":"pathType"}, - "NewGroupName":{"shape":"groupNameType"} - } - }, - "UpdateLoginProfileRequest":{ - "type":"structure", - "required":["UserName"], - "members":{ - "UserName":{"shape":"userNameType"}, - "Password":{"shape":"passwordType"}, - "PasswordResetRequired":{"shape":"booleanObjectType"} - } - }, - "UpdateOpenIDConnectProviderThumbprintRequest":{ - "type":"structure", - "required":[ - "OpenIDConnectProviderArn", - "ThumbprintList" - ], - "members":{ - "OpenIDConnectProviderArn":{"shape":"arnType"}, - "ThumbprintList":{"shape":"thumbprintListType"} - } - }, - "UpdateRoleDescriptionRequest":{ - "type":"structure", - "required":[ - "RoleName", - "Description" - ], - "members":{ - "RoleName":{"shape":"roleNameType"}, - "Description":{"shape":"roleDescriptionType"} - } - }, - "UpdateRoleDescriptionResponse":{ - "type":"structure", - "members":{ - "Role":{"shape":"Role"} - } - }, - "UpdateRoleRequest":{ - "type":"structure", - "required":["RoleName"], - "members":{ - "RoleName":{"shape":"roleNameType"}, - "Description":{"shape":"roleDescriptionType"}, - "MaxSessionDuration":{"shape":"roleMaxSessionDurationType"} - } - }, - "UpdateRoleResponse":{ - "type":"structure", - "members":{} - }, - "UpdateSAMLProviderRequest":{ - "type":"structure", - "required":["SAMLProviderArn"], - "members":{ - "SAMLMetadataDocument":{"shape":"SAMLMetadataDocumentType"}, - "SAMLProviderArn":{"shape":"arnType"}, - "AssertionEncryptionMode":{"shape":"assertionEncryptionModeType"}, - "AddPrivateKey":{"shape":"privateKeyType"}, - "RemovePrivateKey":{"shape":"privateKeyIdType"} - } - }, - "UpdateSAMLProviderResponse":{ - "type":"structure", - "members":{ - "SAMLProviderArn":{"shape":"arnType"} - } - }, - "UpdateSSHPublicKeyRequest":{ - "type":"structure", - "required":[ - "UserName", - "SSHPublicKeyId", - "Status" - ], - "members":{ - "UserName":{"shape":"userNameType"}, - "SSHPublicKeyId":{"shape":"publicKeyIdType"}, - "Status":{"shape":"statusType"} - } - }, - "UpdateServerCertificateRequest":{ - "type":"structure", - "required":["ServerCertificateName"], - "members":{ - "ServerCertificateName":{"shape":"serverCertificateNameType"}, - "NewPath":{"shape":"pathType"}, - "NewServerCertificateName":{"shape":"serverCertificateNameType"} - } - }, - "UpdateServiceSpecificCredentialRequest":{ - "type":"structure", - "required":[ - "ServiceSpecificCredentialId", - "Status" - ], - "members":{ - "UserName":{"shape":"userNameType"}, - "ServiceSpecificCredentialId":{"shape":"serviceSpecificCredentialId"}, - "Status":{"shape":"statusType"} - } - }, - "UpdateSigningCertificateRequest":{ - "type":"structure", - "required":[ - "CertificateId", - "Status" - ], - "members":{ - "UserName":{"shape":"existingUserNameType"}, - "CertificateId":{"shape":"certificateIdType"}, - "Status":{"shape":"statusType"} - } - }, - "UpdateUserRequest":{ - "type":"structure", - "required":["UserName"], - "members":{ - "UserName":{"shape":"existingUserNameType"}, - "NewPath":{"shape":"pathType"}, - "NewUserName":{"shape":"userNameType"} - } - }, - "UploadSSHPublicKeyRequest":{ - "type":"structure", - "required":[ - "UserName", - "SSHPublicKeyBody" - ], - "members":{ - "UserName":{"shape":"userNameType"}, - "SSHPublicKeyBody":{"shape":"publicKeyMaterialType"} - } - }, - "UploadSSHPublicKeyResponse":{ - "type":"structure", - "members":{ - "SSHPublicKey":{"shape":"SSHPublicKey"} - } - }, - "UploadServerCertificateRequest":{ - "type":"structure", - "required":[ - "ServerCertificateName", - "CertificateBody", - "PrivateKey" - ], - "members":{ - "Path":{"shape":"pathType"}, - "ServerCertificateName":{"shape":"serverCertificateNameType"}, - "CertificateBody":{"shape":"certificateBodyType"}, - "PrivateKey":{"shape":"privateKeyType"}, - "CertificateChain":{"shape":"certificateChainType"}, - "Tags":{"shape":"tagListType"} - } - }, - "UploadServerCertificateResponse":{ - "type":"structure", - "members":{ - "ServerCertificateMetadata":{"shape":"ServerCertificateMetadata"}, - "Tags":{"shape":"tagListType"} - } - }, - "UploadSigningCertificateRequest":{ - "type":"structure", - "required":["CertificateBody"], - "members":{ - "UserName":{"shape":"existingUserNameType"}, - "CertificateBody":{"shape":"certificateBodyType"} - } - }, - "UploadSigningCertificateResponse":{ - "type":"structure", - "required":["Certificate"], - "members":{ - "Certificate":{"shape":"SigningCertificate"} - } - }, - "User":{ - "type":"structure", - "required":[ - "Path", - "UserName", - "UserId", - "Arn", - "CreateDate" - ], - "members":{ - "Path":{"shape":"pathType"}, - "UserName":{"shape":"userNameType"}, - "UserId":{"shape":"idType"}, - "Arn":{"shape":"arnType"}, - "CreateDate":{"shape":"dateType"}, - "PasswordLastUsed":{"shape":"dateType"}, - "PermissionsBoundary":{"shape":"AttachedPermissionsBoundary"}, - "Tags":{"shape":"tagListType"} - } - }, - "UserDetail":{ - "type":"structure", - "members":{ - "Path":{"shape":"pathType"}, - "UserName":{"shape":"userNameType"}, - "UserId":{"shape":"idType"}, - "Arn":{"shape":"arnType"}, - "CreateDate":{"shape":"dateType"}, - "UserPolicyList":{"shape":"policyDetailListType"}, - "GroupList":{"shape":"groupNameListType"}, - "AttachedManagedPolicies":{"shape":"attachedPoliciesListType"}, - "PermissionsBoundary":{"shape":"AttachedPermissionsBoundary"}, - "Tags":{"shape":"tagListType"} - } - }, - "VirtualMFADevice":{ - "type":"structure", - "required":["SerialNumber"], - "members":{ - "SerialNumber":{"shape":"serialNumberType"}, - "Base32StringSeed":{"shape":"BootstrapDatum"}, - "QRCodePNG":{"shape":"BootstrapDatum"}, - "User":{"shape":"User"}, - "EnableDate":{"shape":"dateType"}, - "Tags":{"shape":"tagListType"} - } - }, - "accessKeyIdType":{ - "type":"string", - "max":128, - "min":16, - "pattern":"[\\w]+" - }, - "accessKeyMetadataListType":{ - "type":"list", - "member":{"shape":"AccessKeyMetadata"} - }, - "accessKeySecretType":{ - "type":"string", - "sensitive":true - }, - "accountAliasListType":{ - "type":"list", - "member":{"shape":"accountAliasType"} - }, - "accountAliasType":{ - "type":"string", - "max":63, - "min":3, - "pattern":"^[a-z0-9]([a-z0-9]|-(?!-)){1,61}[a-z0-9]$" - }, - "accountIdType":{ - "type":"string", - "pattern":"\\d{12}" - }, - "allUsers":{ - "type":"boolean", - "box":true - }, - "arnType":{ - "type":"string", - "max":2048, - "min":20 - }, - "assertionEncryptionModeType":{ - "type":"string", - "enum":[ - "Required", - "Allowed" - ] - }, - "assignmentStatusType":{ - "type":"string", - "enum":[ - "Assigned", - "Unassigned", - "Any" - ] - }, - "attachedPoliciesListType":{ - "type":"list", - "member":{"shape":"AttachedPolicy"} - }, - "attachmentCountType":{"type":"integer"}, - "authenticationCodeType":{ - "type":"string", - "max":6, - "min":6, - "pattern":"[\\d]+" - }, - "booleanObjectType":{ - "type":"boolean", - "box":true - }, - "booleanType":{"type":"boolean"}, - "certificateBodyType":{ - "type":"string", - "max":16384, - "min":1, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" - }, - "certificateChainType":{ - "type":"string", - "max":2097152, - "min":1, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" - }, - "certificateIdType":{ - "type":"string", - "max":128, - "min":24, - "pattern":"[\\w]+" - }, - "certificateListType":{ - "type":"list", - "member":{"shape":"SigningCertificate"} - }, - "clientIDListType":{ - "type":"list", - "member":{"shape":"clientIDType"} - }, - "clientIDType":{ - "type":"string", - "max":255, - "min":1 - }, - "consoleDeepLinkType":{ - "type":"string", - "max":255, - "min":1 - }, - "credentialAgeDays":{ - "type":"integer", - "max":36600, - "min":1 - }, - "credentialReportExpiredExceptionMessage":{"type":"string"}, - "credentialReportNotPresentExceptionMessage":{"type":"string"}, - "credentialReportNotReadyExceptionMessage":{"type":"string"}, - "customSuffixType":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[\\w+=,.@-]+" - }, - "dateType":{"type":"timestamp"}, - "delegationRequestDescriptionType":{ - "type":"string", - "max":1000, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]*" - }, - "delegationRequestIdType":{ - "type":"string", - "max":128, - "min":16, - "pattern":"[\\w-]+" - }, - "delegationRequestsListType":{ - "type":"list", - "member":{"shape":"DelegationRequest"} - }, - "deleteConflictMessage":{"type":"string"}, - "duplicateCertificateMessage":{"type":"string"}, - "duplicateSSHPublicKeyMessage":{"type":"string"}, - "encodingType":{ - "type":"string", - "enum":[ - "SSH", - "PEM" - ] - }, - "entityAlreadyExistsMessage":{"type":"string"}, - "entityDetailsListType":{ - "type":"list", - "member":{"shape":"EntityDetails"} - }, - "entityListType":{ - "type":"list", - "member":{"shape":"EntityType"} - }, - "entityNameType":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[\\w+=,.@-]+" - }, - "entityTemporarilyUnmodifiableMessage":{"type":"string"}, - "existingUserNameType":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[\\w+=,.@-]+" - }, - "globalEndpointTokenVersion":{ - "type":"string", - "enum":[ - "v1Token", - "v2Token" - ] - }, - "groupDetailListType":{ - "type":"list", - "member":{"shape":"GroupDetail"} - }, - "groupListType":{ - "type":"list", - "member":{"shape":"Group"} - }, - "groupNameListType":{ - "type":"list", - "member":{"shape":"groupNameType"} - }, - "groupNameType":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[\\w+=,.@-]+" - }, - "idType":{ - "type":"string", - "max":128, - "min":16, - "pattern":"[\\w]+" - }, - "instanceProfileListType":{ - "type":"list", - "member":{"shape":"InstanceProfile"} - }, - "instanceProfileNameType":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[\\w+=,.@-]+" - }, - "integerType":{"type":"integer"}, - "invalidAuthenticationCodeMessage":{"type":"string"}, - "invalidCertificateMessage":{"type":"string"}, - "invalidInputMessage":{"type":"string"}, - "invalidPublicKeyMessage":{"type":"string"}, - "invalidUserTypeMessage":{"type":"string"}, - "jobIDType":{ - "type":"string", - "max":36, - "min":36 - }, - "jobStatusType":{ - "type":"string", - "enum":[ - "IN_PROGRESS", - "COMPLETED", - "FAILED" - ] - }, - "keyPairMismatchMessage":{"type":"string"}, - "limitExceededMessage":{"type":"string"}, - "listPolicyGrantingServiceAccessResponseListType":{ - "type":"list", - "member":{"shape":"ListPoliciesGrantingServiceAccessEntry"} - }, - "localeType":{ - "type":"string", - "max":12, - "min":2 - }, - "malformedCertificateMessage":{"type":"string"}, - "malformedPolicyDocumentMessage":{"type":"string"}, - "markerType":{ - "type":"string", - "max":320, - "min":1, - "pattern":"[\\u0020-\\u00FF]+" - }, - "maxItemsType":{ - "type":"integer", - "max":1000, - "min":1 - }, - "maxPasswordAgeType":{ - "type":"integer", - "box":true, - "max":1095, - "min":1 - }, - "mfaDeviceListType":{ - "type":"list", - "member":{"shape":"MFADevice"} - }, - "minimumPasswordLengthType":{ - "type":"integer", - "max":128, - "min":6 - }, - "noSuchEntityMessage":{"type":"string"}, - "notesType":{ - "type":"string", - "max":500, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]*" - }, - "notificationChannelType":{ - "type":"string", - "max":400, - "min":2, - "pattern":"^[a-zA-Z0-9:_.-]+$" - }, - "openIdIdpCommunicationErrorExceptionMessage":{"type":"string"}, - "organizationsEntityPathType":{ - "type":"string", - "max":427, - "min":19, - "pattern":"^o-[0-9a-z]{10,32}\\/r-[0-9a-z]{4,32}[0-9a-z-\\/]*" - }, - "organizationsPolicyIdType":{ - "type":"string", - "pattern":"^p-[0-9a-zA-Z_]{8,128}$" - }, - "ownerIdType":{ - "type":"string", - "max":2048, - "min":20, - "pattern":"^[a-zA-Z0-9:/+=,.@_-]+$" - }, - "passwordPolicyViolationMessage":{"type":"string"}, - "passwordReusePreventionType":{ - "type":"integer", - "box":true, - "max":24, - "min":1 - }, - "passwordType":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", - "sensitive":true - }, - "pathPrefixType":{ - "type":"string", - "max":512, - "min":1, - "pattern":"\\u002F[\\u0021-\\u007F]*" - }, - "pathType":{ - "type":"string", - "max":512, - "min":1, - "pattern":"(\\u002F)|(\\u002F[\\u0021-\\u007E]+\\u002F)" - }, - "permissionCheckResultType":{ - "type":"string", - "enum":[ - "ALLOWED", - "DENIED", - "UNSURE" - ] - }, - "permissionCheckStatusType":{ - "type":"string", - "enum":[ - "COMPLETE", - "IN_PROGRESS", - "FAILED" - ] - }, - "permissionType":{"type":"string"}, - "policyDescriptionType":{ - "type":"string", - "max":1000 - }, - "policyDetailListType":{ - "type":"list", - "member":{"shape":"PolicyDetail"} - }, - "policyDocumentType":{ - "type":"string", - "max":131072, - "min":1, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" - }, - "policyDocumentVersionListType":{ - "type":"list", - "member":{"shape":"PolicyVersion"} - }, - "policyEvaluationErrorMessage":{"type":"string"}, - "policyGrantingServiceAccessListType":{ - "type":"list", - "member":{"shape":"PolicyGrantingServiceAccess"} - }, - "policyListType":{ - "type":"list", - "member":{"shape":"Policy"} - }, - "policyNameListType":{ - "type":"list", - "member":{"shape":"policyNameType"} - }, - "policyNameType":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[\\w+=,.@-]+" - }, - "policyNotAttachableMessage":{"type":"string"}, - "policyOwnerEntityType":{ - "type":"string", - "enum":[ - "USER", - "ROLE", - "GROUP" - ] - }, - "policyParameterListType":{ - "type":"list", - "member":{"shape":"PolicyParameter"}, - "max":50 - }, - "policyParameterNameType":{ - "type":"string", - "max":256, - "min":5, - "pattern":"[ -~]+" - }, - "policyParameterValueType":{ - "type":"string", - "pattern":"[ -~]+" - }, - "policyParameterValuesListType":{ - "type":"list", - "member":{"shape":"policyParameterValueType"} - }, - "policyPathType":{ - "type":"string", - "max":512, - "min":1, - "pattern":"((/[A-Za-z0-9\\.,\\+@=_-]+)*)/" - }, - "policyScopeType":{ - "type":"string", - "enum":[ - "All", - "AWS", - "Local" - ] - }, - "policyType":{ - "type":"string", - "enum":[ - "INLINE", - "MANAGED" - ] - }, - "policyVersionIdType":{ - "type":"string", - "pattern":"v[1-9][0-9]*(\\.[A-Za-z0-9-]*)?" - }, - "privateKeyIdType":{ - "type":"string", - "max":64, - "min":22, - "pattern":"[A-Z0-9]+" - }, - "privateKeyList":{ - "type":"list", - "member":{"shape":"SAMLPrivateKey"}, - "max":2 - }, - "privateKeyType":{ - "type":"string", - "max":16384, - "min":1, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", - "sensitive":true - }, - "publicKeyFingerprintType":{ - "type":"string", - "max":48, - "min":48, - "pattern":"[:\\w]+" - }, - "publicKeyIdType":{ - "type":"string", - "max":128, - "min":20, - "pattern":"[\\w]+" - }, - "publicKeyMaterialType":{ - "type":"string", - "max":16384, - "min":1, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" - }, - "redirectUrlType":{ - "type":"string", - "max":255, - "min":1, - "pattern":"^http(s?)://[a-zA-Z0-9._/-]*(\\?[a-zA-Z0-9._=&-]*)?(#[a-zA-Z0-9._/-]*)?$" - }, - "reportGenerationLimitExceededMessage":{"type":"string"}, - "requestMessageType":{ - "type":"string", - "max":200, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]*" - }, - "requestorNameType":{ - "type":"string", - "max":30, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]*" - }, - "requestorWorkflowIdType":{ - "type":"string", - "max":400, - "min":5, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]+" - }, - "responseMarkerType":{"type":"string"}, - "roleDescriptionType":{ - "type":"string", - "max":1000, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]*" - }, - "roleDetailListType":{ - "type":"list", - "member":{"shape":"RoleDetail"} - }, - "roleListType":{ - "type":"list", - "member":{"shape":"Role"} - }, - "roleMaxSessionDurationType":{ - "type":"integer", - "max":43200, - "min":3600 - }, - "roleNameType":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[\\w+=,.@-]+" - }, - "rolePermissionRestrictionArnListType":{ - "type":"list", - "member":{"shape":"arnType"} - }, - "serialNumberType":{ - "type":"string", - "max":256, - "min":9, - "pattern":"[\\w+=/:,.@-]+" - }, - "serverCertificateMetadataListType":{ - "type":"list", - "member":{"shape":"ServerCertificateMetadata"} - }, - "serverCertificateNameType":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[\\w+=,.@-]+" - }, - "serviceCredentialAlias":{ - "type":"string", - "max":200, - "min":0, - "pattern":"[\\w+=,.@-]+" - }, - "serviceCredentialSecret":{ - "type":"string", - "sensitive":true - }, - "serviceFailureExceptionMessage":{"type":"string"}, - "serviceName":{"type":"string"}, - "serviceNameType":{"type":"string"}, - "serviceNamespaceListType":{ - "type":"list", - "member":{"shape":"serviceNamespaceType"}, - "max":200, - "min":1 - }, - "serviceNamespaceType":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[\\w-]*" - }, - "serviceNotSupportedMessage":{"type":"string"}, - "servicePassword":{ - "type":"string", - "sensitive":true - }, - "serviceSpecificCredentialId":{ - "type":"string", - "max":128, - "min":20, - "pattern":"[\\w]+" - }, - "serviceUserName":{ - "type":"string", - "max":200, - "min":0, - "pattern":"[\\w+=,.@-]*" - }, - "sessionDurationType":{ - "type":"integer", - "max":43200, - "min":300 - }, - "sortKeyType":{ - "type":"string", - "enum":[ - "SERVICE_NAMESPACE_ASCENDING", - "SERVICE_NAMESPACE_DESCENDING", - "LAST_AUTHENTICATED_TIME_ASCENDING", - "LAST_AUTHENTICATED_TIME_DESCENDING" - ] - }, - "stateType":{ - "type":"string", - "enum":[ - "UNASSIGNED", - "ASSIGNED", - "PENDING_APPROVAL", - "FINALIZED", - "ACCEPTED", - "REJECTED", - "EXPIRED" - ] - }, - "statusType":{ - "type":"string", - "enum":[ - "Active", - "Inactive", - "Expired" - ] - }, - "stringType":{"type":"string"}, - "summaryContentType":{ - "type":"string", - "max":10000, - "min":0 - }, - "summaryKeyType":{ - "type":"string", - "enum":[ - "Users", - "UsersQuota", - "Groups", - "GroupsQuota", - "ServerCertificates", - "ServerCertificatesQuota", - "UserPolicySizeQuota", - "GroupPolicySizeQuota", - "GroupsPerUserQuota", - "SigningCertificatesPerUserQuota", - "AccessKeysPerUserQuota", - "MFADevices", - "MFADevicesInUse", - "AccountMFAEnabled", - "AccountAccessKeysPresent", - "AccountPasswordPresent", - "AccountSigningCertificatesPresent", - "AttachedPoliciesPerGroupQuota", - "AttachedPoliciesPerRoleQuota", - "AttachedPoliciesPerUserQuota", - "Policies", - "PoliciesQuota", - "PolicySizeQuota", - "PolicyVersionsInUse", - "PolicyVersionsInUseQuota", - "VersionsPerPolicyQuota", - "GlobalEndpointTokenVersion", - "AssumeRolePolicySizeQuota", - "InstanceProfiles", - "InstanceProfilesQuota", - "Providers", - "RolePolicySizeQuota", - "Roles", - "RolesQuota" - ] - }, - "summaryMapType":{ - "type":"map", - "key":{"shape":"summaryKeyType"}, - "value":{"shape":"summaryValueType"} - }, - "summaryStateType":{ - "type":"string", - "enum":[ - "AVAILABLE", - "NOT_AVAILABLE", - "NOT_SUPPORTED", - "FAILED" - ] - }, - "summaryValueType":{"type":"integer"}, - "tagKeyListType":{ - "type":"list", - "member":{"shape":"tagKeyType"}, - "max":50 - }, - "tagKeyType":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]+" - }, - "tagListType":{ - "type":"list", - "member":{"shape":"Tag"}, - "max":50 - }, - "tagValueType":{ - "type":"string", - "max":256, - "min":0, - "pattern":"[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*" - }, - "thumbprintListType":{ - "type":"list", - "member":{"shape":"thumbprintType"} - }, - "thumbprintType":{ - "type":"string", - "max":40, - "min":40 - }, - "unmodifiableEntityMessage":{"type":"string"}, - "unrecognizedPublicKeyEncodingMessage":{"type":"string"}, - "userDetailListType":{ - "type":"list", - "member":{"shape":"UserDetail"} - }, - "userListType":{ - "type":"list", - "member":{"shape":"User"} - }, - "userNameType":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[\\w+=,.@-]+" - }, - "virtualMFADeviceListType":{ - "type":"list", - "member":{"shape":"VirtualMFADevice"} - }, - "virtualMFADeviceName":{ - "type":"string", - "min":1, - "pattern":"[\\w+=,.@-]+" - } - } -} diff --git a/tools/code-generation/api-descriptions/iam/2010-05-08/docs-2.json b/tools/code-generation/api-descriptions/iam/2010-05-08/docs-2.json deleted file mode 100644 index cf5504535dfb..000000000000 --- a/tools/code-generation/api-descriptions/iam/2010-05-08/docs-2.json +++ /dev/null @@ -1,3809 +0,0 @@ -{ - "version": "2.0", - "service": "Identity and Access Management

Identity and Access Management (IAM) is a web service for securely controlling access to Amazon Web Services services. With IAM, you can centrally manage users, security credentials such as access keys, and permissions that control which Amazon Web Services resources users and applications can access. For more information about IAM, see Identity and Access Management (IAM) and the Identity and Access Management User Guide.

Programmatic access to IAM

We recommend that you use the Amazon Web Services SDKs to make programmatic API calls to IAM. The Amazon Web Services SDKs consist of libraries and sample code for various programming languages and platforms (for example, Java, Ruby, .NET, iOS, and Android). The SDKs provide a convenient way to create programmatic access to IAM and Amazon Web Services. For example, the SDKs take care of tasks such as cryptographically signing requests, managing errors, and retrying requests automatically. For more information, see Tools to build on Amazon Web Services.

Alternatively, you can also use the IAM Query API to make direct calls to the IAM service. For more information about calling the IAM Query API, see Making query requests in the Identity and Access Management User Guide. IAM supports GET and POST requests for all actions. That is, the API does not require you to use GET for some actions and POST for others. However, GET requests are subject to the limitation size of a URL. Therefore, for operations that require larger sizes, use a POST request.

Signing requests

Requests must be signed using an access key ID and a secret access key. We strongly recommend that you do not use your Amazon Web Services account access key ID and secret access key for everyday work with IAM. You can use the access key ID and secret access key for an IAM user or you can use the Security Token Service to generate temporary security credentials and use those to sign requests.

To sign requests, we recommend that you use Signature Version 4. If you have an existing application that uses Signature Version 2, you do not have to update it to use Signature Version 4. However, some operations now require Signature Version 4. The documentation for operations that require version 4 indicate this requirement.

Additional resources

", - "operations": { - "AcceptDelegationRequest": "

Accepts a delegation request, granting the requested temporary access.

Once the delegation request is accepted, it is eligible to send the exchange token to the partner. The SendDelegationToken API has to be explicitly called to send the delegation token.

At the time of acceptance, IAM records the details and the state of the identity that called this API. This is the identity that gets mapped to the delegated credential.

An accepted request may be rejected before the exchange token is sent to the partner.

", - "AddClientIDToOpenIDConnectProvider": "

Adds a new client ID (also known as audience) to the list of client IDs already registered for the specified IAM OpenID Connect (OIDC) provider resource.

This operation is idempotent; it does not fail or return an error if you add an existing client ID to the provider.

", - "AddRoleToInstanceProfile": "

Adds the specified IAM role to the specified instance profile. An instance profile can contain only one role, and this quota cannot be increased. You can remove the existing role and then add a different role to an instance profile. You must then wait for the change to appear across all of Amazon Web Services because of eventual consistency. To force the change, you must disassociate the instance profile and then associate the instance profile, or you can stop your instance and then restart it.

The caller of this operation must be granted the PassRole permission on the IAM role by a permissions policy.

When using the iam:AssociatedResourceArn condition in a policy to restrict the PassRole IAM action, special considerations apply if the policy is intended to define access for the AddRoleToInstanceProfile action. In this case, you cannot specify a Region or instance ID in the EC2 instance ARN. The ARN value must be arn:aws:ec2:*:CallerAccountId:instance/*. Using any other ARN value may lead to unexpected evaluation results.

For more information about roles, see IAM roles in the IAM User Guide. For more information about instance profiles, see Using instance profiles in the IAM User Guide.

", - "AddUserToGroup": "

Adds the specified user to the specified group.

", - "AssociateDelegationRequest": "

Associates a delegation request with the current identity.

If the partner that created the delegation request has specified the owner account during creation, only an identity from that owner account can call the AssociateDelegationRequest API for the specified delegation request. Once the AssociateDelegationRequest API call is successful, the ARN of the current calling identity will be stored as the ownerId of the request.

If the partner that created the delegation request has not specified the owner account during creation, any caller from any account can call the AssociateDelegationRequest API for the delegation request. Once this API call is successful, the ARN of the current calling identity will be stored as the ownerId and the Amazon Web Services account ID of the current calling identity will be stored as the ownerAccount of the request.

For more details, see Managing Permissions for Delegation Requests.

", - "AttachGroupPolicy": "

Attaches the specified managed policy to the specified IAM group.

You use this operation to attach a managed policy to a group. To embed an inline policy in a group, use PutGroupPolicy .

As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide.

For more information about policies, see Managed policies and inline policies in the IAM User Guide.

", - "AttachRolePolicy": "

Attaches the specified managed policy to the specified IAM role. When you attach a managed policy to a role, the managed policy becomes part of the role's permission (access) policy.

You cannot use a managed policy as the role's trust policy. The role's trust policy is created at the same time as the role, using CreateRole . You can update a role's trust policy using UpdateAssumerolePolicy .

Use this operation to attach a managed policy to a role. To embed an inline policy in a role, use PutRolePolicy . For more information about policies, see Managed policies and inline policies in the IAM User Guide.

As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide.

", - "AttachUserPolicy": "

Attaches the specified managed policy to the specified user.

You use this operation to attach a managed policy to a user. To embed an inline policy in a user, use PutUserPolicy .

As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide.

For more information about policies, see Managed policies and inline policies in the IAM User Guide.

", - "ChangePassword": "

Changes the password of the IAM user who is calling this operation. This operation can be performed using the CLI, the Amazon Web Services API, or the My Security Credentials page in the Amazon Web Services Management Console. The Amazon Web Services account root user password is not affected by this operation.

Use UpdateLoginProfile to use the CLI, the Amazon Web Services API, or the Users page in the IAM console to change the password for any IAM user. For more information about modifying passwords, see Managing passwords in the IAM User Guide.

", - "CreateAccessKey": "

Creates a new Amazon Web Services secret access key and corresponding Amazon Web Services access key ID for the specified user. The default status for new keys is Active.

If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials. This is true even if the Amazon Web Services account has no associated users.

For information about quotas on the number of keys you can create, see IAM and STS quotas in the IAM User Guide.

To ensure the security of your Amazon Web Services account, the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can delete the access keys for the associated user and then create new keys.

", - "CreateAccountAlias": "

Creates an alias for your Amazon Web Services account. For information about using an Amazon Web Services account alias, see Creating, deleting, and listing an Amazon Web Services account alias in the Amazon Web Services Sign-In User Guide.

", - "CreateDelegationRequest": "

Creates an IAM delegation request for temporary access delegation.

This API is not available for general use. In order to use this API, a caller first need to go through an onboarding process described in the partner onboarding documentation.

", - "CreateGroup": "

Creates a new group.

For information about the number of groups you can create, see IAM and STS quotas in the IAM User Guide.

", - "CreateInstanceProfile": "

Creates a new instance profile. For information about instance profiles, see Using roles for applications on Amazon EC2 in the IAM User Guide, and Instance profiles in the Amazon EC2 User Guide.

For information about the number of instance profiles you can create, see IAM object quotas in the IAM User Guide.

", - "CreateLoginProfile": "

Creates a password for the specified IAM user. A password allows an IAM user to access Amazon Web Services services through the Amazon Web Services Management Console.

You can use the CLI, the Amazon Web Services API, or the Users page in the IAM console to create a password for any IAM user. Use ChangePassword to update your own existing password in the My Security Credentials page in the Amazon Web Services Management Console.

For more information about managing passwords, see Managing passwords in the IAM User Guide.

", - "CreateOpenIDConnectProvider": "

Creates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC).

The OIDC provider that you create with this operation can be used as a principal in a role's trust policy. Such a policy establishes a trust relationship between Amazon Web Services and the OIDC provider.

If you are using an OIDC identity provider from Google, Facebook, or Amazon Cognito, you don't need to create a separate IAM identity provider. These OIDC identity providers are already built-in to Amazon Web Services and are available for your use. Instead, you can move directly to creating new roles using your identity provider. To learn more, see Creating a role for web identity or OpenID connect federation in the IAM User Guide.

When you create the IAM OIDC provider, you specify the following:

  • The URL of the OIDC identity provider (IdP) to trust

  • A list of client IDs (also known as audiences) that identify the application or applications allowed to authenticate using the OIDC provider

  • A list of tags that are attached to the specified IAM OIDC provider

  • A list of thumbprints of one or more server certificates that the IdP uses

You get all of this information from the OIDC IdP you want to use to access Amazon Web Services.

Amazon Web Services secures communication with OIDC identity providers (IdPs) using our library of trusted root certificate authorities (CAs) to verify the JSON Web Key Set (JWKS) endpoint's TLS certificate. If your OIDC IdP relies on a certificate that is not signed by one of these trusted CAs, only then we secure communication using the thumbprints set in the IdP's configuration.

The trust for the OIDC provider is derived from the IAM provider that this operation creates. Therefore, it is best to limit access to the CreateOpenIDConnectProvider operation to highly privileged users.

", - "CreatePolicy": "

Creates a new managed policy for your Amazon Web Services account.

This operation creates a policy version with a version identifier of v1 and sets v1 as the policy's default version. For more information about policy versions, see Versioning for managed policies in the IAM User Guide.

As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide.

For more information about managed policies in general, see Managed policies and inline policies in the IAM User Guide.

", - "CreatePolicyVersion": "

Creates a new version of the specified managed policy. To update a managed policy, you create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must delete an existing version using DeletePolicyVersion before you create a new version.

Optionally, you can set the new version as the policy's default version. The default version is the version that is in effect for the IAM users, groups, and roles to which the policy is attached.

For more information about managed policy versions, see Versioning for managed policies in the IAM User Guide.

", - "CreateRole": "

Creates a new role for your Amazon Web Services account.

For more information about roles, see IAM roles in the IAM User Guide. For information about quotas for role names and the number of roles you can create, see IAM and STS quotas in the IAM User Guide.

", - "CreateSAMLProvider": "

Creates an IAM resource that describes an identity provider (IdP) that supports SAML 2.0.

The SAML provider resource that you create with this operation can be used as a principal in an IAM role's trust policy. Such a policy can enable federated users who sign in using the SAML IdP to assume the role. You can create an IAM role that supports Web-based single sign-on (SSO) to the Amazon Web Services Management Console or one that supports API access to Amazon Web Services.

When you create the SAML provider resource, you upload a SAML metadata document that you get from your IdP. That document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that the IdP sends. You must generate the metadata document using the identity management software that is used as your organization's IdP.

This operation requires Signature Version 4.

For more information, see Enabling SAML 2.0 federated users to access the Amazon Web Services Management Console and About SAML 2.0-based federation in the IAM User Guide.

", - "CreateServiceLinkedRole": "

Creates an IAM role that is linked to a specific Amazon Web Services service. The service controls the attached policies and when the role can be deleted. This helps ensure that the service is not broken by an unexpectedly changed or deleted role, which could put your Amazon Web Services resources into an unknown state. Allowing the service to control the role helps improve service stability and proper cleanup when a service and its role are no longer needed. For more information, see Using service-linked roles in the IAM User Guide.

To attach a policy to this service-linked role, you must make the request using the Amazon Web Services service that depends on this role.

", - "CreateServiceSpecificCredential": "

Generates a set of credentials consisting of a user name and password that can be used to access the service specified in the request. These credentials are generated by IAM, and can be used only for the specified service.

You can have a maximum of two sets of service-specific credentials for each supported service per user.

You can reset the password to a new service-generated value by calling ResetServiceSpecificCredential.

For more information about using service-specific credentials to authenticate to an Amazon Web Services service, refer to the following docs:

", - "CreateUser": "

Creates a new IAM user for your Amazon Web Services account.

For information about quotas for the number of IAM users you can create, see IAM and STS quotas in the IAM User Guide.

", - "CreateVirtualMFADevice": "

Creates a new virtual MFA device for the Amazon Web Services account. After creating the virtual MFA, use EnableMFADevice to attach the MFA device to an IAM user. For more information about creating and working with virtual MFA devices, see Using a virtual MFA device in the IAM User Guide.

For information about the maximum number of MFA devices you can create, see IAM and STS quotas in the IAM User Guide.

The seed information contained in the QR code and the Base32 string should be treated like any other secret access information. In other words, protect the seed information as you would your Amazon Web Services access keys or your passwords. After you provision your virtual device, you should ensure that the information is destroyed following secure procedures.

", - "DeactivateMFADevice": "

Deactivates the specified MFA device and removes it from association with the user name for which it was originally enabled.

For more information about creating and working with virtual MFA devices, see Enabling a virtual multi-factor authentication (MFA) device in the IAM User Guide.

", - "DeleteAccessKey": "

Deletes the access key pair associated with the specified IAM user.

If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.

", - "DeleteAccountAlias": "

Deletes the specified Amazon Web Services account alias. For information about using an Amazon Web Services account alias, see Creating, deleting, and listing an Amazon Web Services account alias in the Amazon Web Services Sign-In User Guide.

", - "DeleteAccountPasswordPolicy": "

Deletes the password policy for the Amazon Web Services account. There are no parameters.

", - "DeleteGroup": "

Deletes the specified IAM group. The group must not contain any users or have any attached policies.

", - "DeleteGroupPolicy": "

Deletes the specified inline policy that is embedded in the specified IAM group.

A group can also have managed policies attached to it. To detach a managed policy from a group, use DetachGroupPolicy. For more information about policies, refer to Managed policies and inline policies in the IAM User Guide.

", - "DeleteInstanceProfile": "

Deletes the specified instance profile. The instance profile must not have an associated role.

Make sure that you do not have any Amazon EC2 instances running with the instance profile you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance.

For more information about instance profiles, see Using instance profiles in the IAM User Guide.

", - "DeleteLoginProfile": "

Deletes the password for the specified IAM user or root user, For more information, see Managing passwords for IAM users.

You can use the CLI, the Amazon Web Services API, or the Users page in the IAM console to delete a password for any IAM user. You can use ChangePassword to update, but not delete, your own password in the My Security Credentials page in the Amazon Web Services Management Console.

Deleting a user's password does not prevent a user from accessing Amazon Web Services through the command line interface or the API. To prevent all user access, you must also either make any access keys inactive or delete them. For more information about making keys inactive or deleting them, see UpdateAccessKey and DeleteAccessKey.

", - "DeleteOpenIDConnectProvider": "

Deletes an OpenID Connect identity provider (IdP) resource object in IAM.

Deleting an IAM OIDC provider resource does not update any roles that reference the provider as a principal in their trust policies. Any attempt to assume a role that references a deleted provider fails.

This operation is idempotent; it does not fail or return an error if you call the operation for a provider that does not exist.

", - "DeletePolicy": "

Deletes the specified managed policy.

Before you can delete a managed policy, you must first detach the policy from all users, groups, and roles that it is attached to. In addition, you must delete all the policy's versions. The following steps describe the process for deleting a managed policy:

  • Detach the policy from all users, groups, and roles that the policy is attached to, using DetachUserPolicy, DetachGroupPolicy, or DetachRolePolicy. To list all the users, groups, and roles that a policy is attached to, use ListEntitiesForPolicy.

  • Delete all versions of the policy using DeletePolicyVersion. To list the policy's versions, use ListPolicyVersions. You cannot use DeletePolicyVersion to delete the version that is marked as the default version. You delete the policy's default version in the next step of the process.

  • Delete the policy (this automatically deletes the policy's default version) using this operation.

For information about managed policies, see Managed policies and inline policies in the IAM User Guide.

", - "DeletePolicyVersion": "

Deletes the specified version from the specified managed policy.

You cannot delete the default version from a policy using this operation. To delete the default version from a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.

For information about versions for managed policies, see Versioning for managed policies in the IAM User Guide.

", - "DeleteRole": "

Deletes the specified role. Unlike the Amazon Web Services Management Console, when you delete a role programmatically, you must delete the items attached to the role manually, or the deletion fails. For more information, see Deleting an IAM role. Before attempting to delete a role, remove the following attached items:

Make sure that you do not have any Amazon EC2 instances running with the role you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance.

", - "DeleteRolePermissionsBoundary": "

Deletes the permissions boundary for the specified IAM role.

You cannot set the boundary for a service-linked role.

Deleting the permissions boundary for a role might increase its permissions. For example, it might allow anyone who assumes the role to perform all the actions granted in its permissions policies.

", - "DeleteRolePolicy": "

Deletes the specified inline policy that is embedded in the specified IAM role.

A role can also have managed policies attached to it. To detach a managed policy from a role, use DetachRolePolicy. For more information about policies, refer to Managed policies and inline policies in the IAM User Guide.

", - "DeleteSAMLProvider": "

Deletes a SAML provider resource in IAM.

Deleting the provider resource from IAM does not update any roles that reference the SAML provider resource's ARN as a principal in their trust policies. Any attempt to assume a role that references a non-existent provider resource ARN fails.

This operation requires Signature Version 4.

", - "DeleteSSHPublicKey": "

Deletes the specified SSH public key.

The SSH public key deleted by this operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide.

", - "DeleteServerCertificate": "

Deletes the specified server certificate.

For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.

If you are using a server certificate with Elastic Load Balancing, deleting the certificate could have implications for your application. If Elastic Load Balancing doesn't detect the deletion of bound certificates, it may continue to use the certificates. This could cause Elastic Load Balancing to stop accepting traffic. We recommend that you remove the reference to the certificate from Elastic Load Balancing before using this command to delete the certificate. For more information, see DeleteLoadBalancerListeners in the Elastic Load Balancing API Reference.

", - "DeleteServiceLinkedRole": "

Submits a service-linked role deletion request and returns a DeletionTaskId, which you can use to check the status of the deletion. Before you call this operation, confirm that the role has no active sessions and that any resources used by the role in the linked service are deleted. If you call this operation more than once for the same service-linked role and an earlier deletion task is not complete, then the DeletionTaskId of the earlier request is returned.

If you submit a deletion request for a service-linked role whose linked service is still accessing a resource, then the deletion task fails. If it fails, the GetServiceLinkedRoleDeletionStatus operation returns the reason for the failure, usually including the resources that must be deleted. To delete the service-linked role, you must first remove those resources from the linked service and then submit the deletion request again. Resources are specific to the service that is linked to the role. For more information about removing resources from a service, see the Amazon Web Services documentation for your service.

For more information about service-linked roles, see Roles terms and concepts: Amazon Web Services service-linked role in the IAM User Guide.

", - "DeleteServiceSpecificCredential": "

Deletes the specified service-specific credential.

", - "DeleteSigningCertificate": "

Deletes a signing certificate associated with the specified IAM user.

If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated IAM users.

", - "DeleteUser": "

Deletes the specified IAM user. Unlike the Amazon Web Services Management Console, when you delete a user programmatically, you must delete the items attached to the user manually, or the deletion fails. For more information, see Deleting an IAM user. Before attempting to delete a user, remove the following items:

", - "DeleteUserPermissionsBoundary": "

Deletes the permissions boundary for the specified IAM user.

Deleting the permissions boundary for a user might increase its permissions by allowing the user to perform all the actions granted in its permissions policies.

", - "DeleteUserPolicy": "

Deletes the specified inline policy that is embedded in the specified IAM user.

A user can also have managed policies attached to it. To detach a managed policy from a user, use DetachUserPolicy. For more information about policies, refer to Managed policies and inline policies in the IAM User Guide.

", - "DeleteVirtualMFADevice": "

Deletes a virtual MFA device.

You must deactivate a user's virtual MFA device before you can delete it. For information about deactivating MFA devices, see DeactivateMFADevice.

", - "DetachGroupPolicy": "

Removes the specified managed policy from the specified IAM group.

A group can also have inline policies embedded with it. To delete an inline policy, use DeleteGroupPolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide.

", - "DetachRolePolicy": "

Removes the specified managed policy from the specified role.

A role can also have inline policies embedded with it. To delete an inline policy, use DeleteRolePolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide.

", - "DetachUserPolicy": "

Removes the specified managed policy from the specified user.

A user can also have inline policies embedded with it. To delete an inline policy, use DeleteUserPolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide.

", - "DisableOrganizationsRootCredentialsManagement": "

Disables the management of privileged root user credentials across member accounts in your organization. When you disable this feature, the management account and the delegated administrator for IAM can no longer manage root user credentials for member accounts in your organization.

", - "DisableOrganizationsRootSessions": "

Disables root user sessions for privileged tasks across member accounts in your organization. When you disable this feature, the management account and the delegated administrator for IAM can no longer perform privileged tasks on member accounts in your organization.

", - "DisableOutboundWebIdentityFederation": "

Disables the outbound identity federation feature for your Amazon Web Services account. When disabled, IAM principals in the account cannot use the GetWebIdentityToken API to obtain JSON Web Tokens (JWTs) for authentication with external services. This operation does not affect tokens that were issued before the feature was disabled.

", - "EnableMFADevice": "

Enables the specified MFA device and associates it with the specified IAM user. When enabled, the MFA device is required for every subsequent login by the IAM user associated with the device.

", - "EnableOrganizationsRootCredentialsManagement": "

Enables the management of privileged root user credentials across member accounts in your organization. When you enable root credentials management for centralized root access, the management account and the delegated administrator for IAM can manage root user credentials for member accounts in your organization.

Before you enable centralized root access, you must have an account configured with the following settings:

  • You must manage your Amazon Web Services accounts in Organizations.

  • Enable trusted access for Identity and Access Management in Organizations. For details, see IAM and Organizations in the Organizations User Guide.

", - "EnableOrganizationsRootSessions": "

Allows the management account or delegated administrator to perform privileged tasks on member accounts in your organization. For more information, see Centrally manage root access for member accounts in the Identity and Access Management User Guide.

Before you enable this feature, you must have an account configured with the following settings:

  • You must manage your Amazon Web Services accounts in Organizations.

  • Enable trusted access for Identity and Access Management in Organizations. For details, see IAM and Organizations in the Organizations User Guide.

", - "EnableOutboundWebIdentityFederation": "

Enables the outbound identity federation feature for your Amazon Web Services account. When enabled, IAM principals in your account can use the GetWebIdentityToken API to obtain JSON Web Tokens (JWTs) for secure authentication with external services. This operation also generates a unique issuer URL for your Amazon Web Services account.

", - "GenerateCredentialReport": "

Generates a credential report for the Amazon Web Services account. For more information about the credential report, see Getting credential reports in the IAM User Guide.

", - "GenerateOrganizationsAccessReport": "

Generates a report for service last accessed data for Organizations. You can generate a report for any entities (organization root, organizational unit, or account) or policies in your organization.

To call this operation, you must be signed in using your Organizations management account credentials. You can use your long-term IAM user or root user credentials, or temporary credentials from assuming an IAM role. SCPs must be enabled for your organization root. You must have the required IAM and Organizations permissions. For more information, see Refining permissions using service last accessed data in the IAM User Guide.

You can generate a service last accessed data report for entities by specifying only the entity's path. This data includes a list of services that are allowed by any service control policies (SCPs) that apply to the entity.

You can generate a service last accessed data report for a policy by specifying an entity's path and an optional Organizations policy ID. This data includes a list of services that are allowed by the specified SCP.

For each service in both report types, the data includes the most recent account activity that the policy allows to account principals in the entity or the entity's children. For important information about the data, reporting period, permissions required, troubleshooting, and supported Regions see Reducing permissions using service last accessed data in the IAM User Guide.

The data includes all attempts to access Amazon Web Services, not just the successful ones. This includes all attempts that were made using the Amazon Web Services Management Console, the Amazon Web Services API through any of the SDKs, or any of the command line tools. An unexpected entry in the service last accessed data does not mean that an account has been compromised, because the request might have been denied. Refer to your CloudTrail logs as the authoritative source for information about all API calls and whether they were successful or denied access. For more information, see Logging IAM events with CloudTrail in the IAM User Guide.

This operation returns a JobId. Use this parameter in the GetOrganizationsAccessReport operation to check the status of the report generation. To check the status of this request, use the JobId parameter in the GetOrganizationsAccessReport operation and test the JobStatus response parameter. When the job is complete, you can retrieve the report.

To generate a service last accessed data report for entities, specify an entity path without specifying the optional Organizations policy ID. The type of entity that you specify determines the data returned in the report.

  • Root – When you specify the organizations root as the entity, the resulting report lists all of the services allowed by SCPs that are attached to your root. For each service, the report includes data for all accounts in your organization except the management account, because the management account is not limited by SCPs.

  • OU – When you specify an organizational unit (OU) as the entity, the resulting report lists all of the services allowed by SCPs that are attached to the OU and its parents. For each service, the report includes data for all accounts in the OU or its children. This data excludes the management account, because the management account is not limited by SCPs.

  • management account – When you specify the management account, the resulting report lists all Amazon Web Services services, because the management account is not limited by SCPs. For each service, the report includes data for only the management account.

  • Account – When you specify another account as the entity, the resulting report lists all of the services allowed by SCPs that are attached to the account and its parents. For each service, the report includes data for only the specified account.

To generate a service last accessed data report for policies, specify an entity path and the optional Organizations policy ID. The type of entity that you specify determines the data returned for each service.

  • Root – When you specify the root entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for all accounts in your organization to which the SCP applies. This data excludes the management account, because the management account is not limited by SCPs. If the SCP is not attached to any entities in the organization, then the report will return a list of services with no data.

  • OU – When you specify an OU entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for all accounts in the OU or its children to which the SCP applies. This means that other accounts outside the OU that are affected by the SCP might not be included in the data. This data excludes the management account, because the management account is not limited by SCPs. If the SCP is not attached to the OU or one of its children, the report will return a list of services with no data.

  • management account – When you specify the management account, the resulting report lists all Amazon Web Services services, because the management account is not limited by SCPs. If you specify a policy ID in the CLI or API, the policy is ignored. For each service, the report includes data for only the management account.

  • Account – When you specify another account entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for only the specified account. This means that other accounts in the organization that are affected by the SCP might not be included in the data. If the SCP is not attached to the account, the report will return a list of services with no data.

Service last accessed data does not use other policy types when determining whether a principal could access a service. These other policy types include identity-based policies, resource-based policies, access control lists, IAM permissions boundaries, and STS assume role policies. It only applies SCP logic. For more about the evaluation of policy types, see Evaluating policies in the IAM User Guide.

For more information about service last accessed data, see Reducing policy scope by viewing user activity in the IAM User Guide.

", - "GenerateServiceLastAccessedDetails": "

Generates a report that includes details about when an IAM resource (user, group, role, or policy) was last used in an attempt to access Amazon Web Services services. Recent activity usually appears within four hours. IAM reports activity for at least the last 400 days, or less if your Region began supporting this feature within the last year. For more information, see Regions where data is tracked. For more information about services and actions for which action last accessed information is displayed, see IAM action last accessed information services and actions.

The service last accessed data includes all attempts to access an Amazon Web Services API, not just the successful ones. This includes all attempts that were made using the Amazon Web Services Management Console, the Amazon Web Services API through any of the SDKs, or any of the command line tools. An unexpected entry in the service last accessed data does not mean that your account has been compromised, because the request might have been denied. Refer to your CloudTrail logs as the authoritative source for information about all API calls and whether they were successful or denied access. For more information, see Logging IAM events with CloudTrail in the IAM User Guide.

The GenerateServiceLastAccessedDetails operation returns a JobId. Use this parameter in the following operations to retrieve the following details from your report:

  • GetServiceLastAccessedDetails – Use this operation for users, groups, roles, or policies to list every Amazon Web Services service that the resource could access using permissions policies. For each service, the response includes information about the most recent access attempt.

    The JobId returned by GenerateServiceLastAccessedDetail must be used by the same role within a session, or by the same user when used to call GetServiceLastAccessedDetail.

  • GetServiceLastAccessedDetailsWithEntities – Use this operation for groups and policies to list information about the associated entities (users or roles) that attempted to access a specific Amazon Web Services service.

To check the status of the GenerateServiceLastAccessedDetails request, use the JobId parameter in the same operations and test the JobStatus response parameter.

For additional information about the permissions policies that allow an identity (user, group, or role) to access specific services, use the ListPoliciesGrantingServiceAccess operation.

Service last accessed data does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, Organizations policies, IAM permissions boundaries, and STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see Evaluating policies in the IAM User Guide.

For more information about service and action last accessed data, see Reducing permissions using service last accessed data in the IAM User Guide.

", - "GetAccessKeyLastUsed": "

Retrieves information about when the specified access key was last used. The information includes the date and time of last use, along with the Amazon Web Services service and Region that were specified in the last request made with that key.

", - "GetAccountAuthorizationDetails": "

Retrieves information about all IAM users, groups, roles, and policies in your Amazon Web Services account, including their relationships to one another. Use this operation to obtain a snapshot of the configuration of IAM permissions (users, groups, roles, and policies) in your account.

Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality, and some SDKs do this decoding automatically.

You can optionally filter the results using the Filter parameter. You can paginate the results using the MaxItems and Marker parameters.

", - "GetAccountPasswordPolicy": "

Retrieves the password policy for the Amazon Web Services account. This tells you the complexity requirements and mandatory rotation periods for the IAM user passwords in your account. For more information about using a password policy, see Managing an IAM password policy.

", - "GetAccountSummary": "

Retrieves information about IAM entity usage and IAM quotas in the Amazon Web Services account.

For information about IAM quotas, see IAM and STS quotas in the IAM User Guide.

", - "GetContextKeysForCustomPolicy": "

Gets a list of all of the context keys referenced in the input policies. The policies are supplied as a list of one or more strings. To get the context keys from policies associated with an IAM user, group, or role, use GetContextKeysForPrincipalPolicy.

Context keys are variables maintained by Amazon Web Services and its services that provide details about the context of an API query request. Context keys can be evaluated by testing against a value specified in an IAM policy. Use GetContextKeysForCustomPolicy to understand what key names and values you must supply when you call SimulateCustomPolicy. Note that all parameters are shown in unencoded form here for clarity but must be URL encoded to be included as a part of a real HTML request.

", - "GetContextKeysForPrincipalPolicy": "

Gets a list of all of the context keys referenced in all the IAM policies that are attached to the specified IAM entity. The entity can be an IAM user, group, or role. If you specify a user, then the request also includes all of the policies attached to groups that the user is a member of.

You can optionally include a list of one or more additional policies, specified as strings. If you want to include only a list of policies by string, use GetContextKeysForCustomPolicy instead.

Note: This operation discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use GetContextKeysForCustomPolicy instead.

Context keys are variables maintained by Amazon Web Services and its services that provide details about the context of an API query request. Context keys can be evaluated by testing against a value in an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key names and values you must supply when you call SimulatePrincipalPolicy. This operation doesn't return context keys referenced by service control policies (SCPs). Only context keys referenced by the identity-based policies attached to the specified entity, and any additional policies that you provide, are included.

", - "GetCredentialReport": "

Retrieves a credential report for the Amazon Web Services account. For more information about the credential report, see Getting credential reports in the IAM User Guide.

", - "GetDelegationRequest": "

Retrieves information about a specific delegation request.

If a delegation request has no owner or owner account, GetDelegationRequest for that delegation request can be called by any account. If the owner account is assigned but there is no owner id, only identities within that owner account can call GetDelegationRequest for the delegation request. Once the delegation request is fully owned, the owner of the request gets a default permission to get that delegation request. For more details, see Managing Permissions for Delegation Requests.

", - "GetGroup": "

Returns a list of IAM users that are in the specified IAM group. You can paginate the results using the MaxItems and Marker parameters.

", - "GetGroupPolicy": "

Retrieves the specified inline policy document that is embedded in the specified IAM group.

Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality, and some SDKs do this decoding automatically.

An IAM group can also have managed policies attached to it. To retrieve a managed policy document that is attached to a group, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document.

For more information about policies, see Managed policies and inline policies in the IAM User Guide.

", - "GetHumanReadableSummary": "

Retrieves a human readable summary for a given entity. At this time, the only supported entity type is delegation-request

This method uses a Large Language Model (LLM) to generate the summary.

If a delegation request has no owner or owner account, GetHumanReadableSummary for that delegation request can be called by any account. If the owner account is assigned but there is no owner id, only identities within that owner account can call GetHumanReadableSummary for the delegation request to retrieve a summary of that request. Once the delegation request is fully owned, the owner of the request gets a default permission to get that delegation request. For more details, read default permissions granted to delegation requests. These rules are identical to GetDelegationRequest API behavior, such that a party who has permissions to call GetDelegationRequest for a given delegation request will always be able to retrieve the human readable summary for that request.

", - "GetInstanceProfile": "

Retrieves information about the specified instance profile, including the instance profile's path, GUID, ARN, and role. For more information about instance profiles, see Using instance profiles in the IAM User Guide.

", - "GetLoginProfile": "

Retrieves the user name for the specified IAM user. A login profile is created when you create a password for the user to access the Amazon Web Services Management Console. If the user does not exist or does not have a password, the operation returns a 404 (NoSuchEntity) error.

If you create an IAM user with access to the console, the CreateDate reflects the date you created the initial password for the user.

If you create an IAM user with programmatic access, and then later add a password for the user to access the Amazon Web Services Management Console, the CreateDate reflects the initial password creation date. A user with programmatic access does not have a login profile unless you create a password for the user to access the Amazon Web Services Management Console.

", - "GetMFADevice": "

Retrieves information about an MFA device for a specified user.

", - "GetOpenIDConnectProvider": "

Returns information about the specified OpenID Connect (OIDC) provider resource object in IAM.

", - "GetOrganizationsAccessReport": "

Retrieves the service last accessed data report for Organizations that was previously generated using the GenerateOrganizationsAccessReport operation. This operation retrieves the status of your report job and the report contents.

Depending on the parameters that you passed when you generated the report, the data returned could include different information. For details, see GenerateOrganizationsAccessReport.

To call this operation, you must be signed in to the management account in your organization. SCPs must be enabled for your organization root. You must have permissions to perform this operation. For more information, see Refining permissions using service last accessed data in the IAM User Guide.

For each service that principals in an account (root user, IAM users, or IAM roles) could access using SCPs, the operation returns details about the most recent access attempt. If there was no attempt, the service is listed without details about the most recent attempt to access the service. If the operation fails, it returns the reason that it failed.

By default, the list is sorted by service namespace.

", - "GetOutboundWebIdentityFederationInfo": "

Retrieves the configuration information for the outbound identity federation feature in your Amazon Web Services account. The response includes the unique issuer URL for your Amazon Web Services account and the current enabled/disabled status of the feature. Use this operation to obtain the issuer URL that you need to configure trust relationships with external services.

", - "GetPolicy": "

Retrieves information about the specified managed policy, including the policy's default version and the total number of IAM users, groups, and roles to which the policy is attached. To retrieve the list of the specific users, groups, and roles that the policy is attached to, use ListEntitiesForPolicy. This operation returns metadata about the policy. To retrieve the actual policy document for a specific version of the policy, use GetPolicyVersion.

This operation retrieves information about managed policies. To retrieve information about an inline policy that is embedded with an IAM user, group, or role, use GetUserPolicy, GetGroupPolicy, or GetRolePolicy.

For more information about policies, see Managed policies and inline policies in the IAM User Guide.

", - "GetPolicyVersion": "

Retrieves information about the specified version of the specified managed policy, including the policy document.

Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality, and some SDKs do this decoding automatically.

To list the available versions for a policy, use ListPolicyVersions.

This operation retrieves information about managed policies. To retrieve information about an inline policy that is embedded in a user, group, or role, use GetUserPolicy, GetGroupPolicy, or GetRolePolicy.

For more information about the types of policies, see Managed policies and inline policies in the IAM User Guide.

For more information about managed policy versions, see Versioning for managed policies in the IAM User Guide.

", - "GetRole": "

Retrieves information about the specified role, including the role's path, GUID, ARN, and the role's trust policy that grants permission to assume the role. For more information about roles, see IAM roles in the IAM User Guide.

Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality, and some SDKs do this decoding automatically.

", - "GetRolePolicy": "

Retrieves the specified inline policy document that is embedded with the specified IAM role.

Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality, and some SDKs do this decoding automatically.

An IAM role can also have managed policies attached to it. To retrieve a managed policy document that is attached to a role, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document.

For more information about policies, see Managed policies and inline policies in the IAM User Guide.

For more information about roles, see IAM roles in the IAM User Guide.

", - "GetSAMLProvider": "

Returns the SAML provider metadocument that was uploaded when the IAM SAML provider resource object was created or updated.

This operation requires Signature Version 4.

", - "GetSSHPublicKey": "

Retrieves the specified SSH public key, including metadata about the key.

The SSH public key retrieved by this operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide.

", - "GetServerCertificate": "

Retrieves information about the specified server certificate stored in IAM.

For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.

", - "GetServiceLastAccessedDetails": "

Retrieves a service last accessed report that was created using the GenerateServiceLastAccessedDetails operation. You can use the JobId parameter in GetServiceLastAccessedDetails to retrieve the status of your report job. When the report is complete, you can retrieve the generated report. The report includes a list of Amazon Web Services services that the resource (user, group, role, or managed policy) can access.

Service last accessed data does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, Organizations policies, IAM permissions boundaries, and STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see Evaluating policies in the IAM User Guide.

For each service that the resource could access using permissions policies, the operation returns details about the most recent access attempt. If there was no attempt, the service is listed without details about the most recent attempt to access the service. If the operation fails, the GetServiceLastAccessedDetails operation returns the reason that it failed.

The GetServiceLastAccessedDetails operation returns a list of services. This list includes the number of entities that have attempted to access the service and the date and time of the last attempt. It also returns the ARN of the following entity, depending on the resource ARN that you used to generate the report:

  • User – Returns the user ARN that you used to generate the report

  • Group – Returns the ARN of the group member (user) that last attempted to access the service

  • Role – Returns the role ARN that you used to generate the report

  • Policy – Returns the ARN of the user or role that last used the policy to attempt to access the service

By default, the list is sorted by service namespace.

If you specified ACTION_LEVEL granularity when you generated the report, this operation returns service and action last accessed data. This includes the most recent access attempt for each tracked action within a service. Otherwise, this operation returns only service data.

For more information about service and action last accessed data, see Reducing permissions using service last accessed data in the IAM User Guide.

", - "GetServiceLastAccessedDetailsWithEntities": "

After you generate a group or policy report using the GenerateServiceLastAccessedDetails operation, you can use the JobId parameter in GetServiceLastAccessedDetailsWithEntities. This operation retrieves the status of your report job and a list of entities that could have used group or policy permissions to access the specified service.

  • Group – For a group report, this operation returns a list of users in the group that could have used the group’s policies in an attempt to access the service.

  • Policy – For a policy report, this operation returns a list of entities (users or roles) that could have used the policy in an attempt to access the service.

You can also use this operation for user or role reports to retrieve details about those entities.

If the operation fails, the GetServiceLastAccessedDetailsWithEntities operation returns the reason that it failed.

By default, the list of associated entities is sorted by date, with the most recent access listed first.

", - "GetServiceLinkedRoleDeletionStatus": "

Retrieves the status of your service-linked role deletion. After you use DeleteServiceLinkedRole to submit a service-linked role for deletion, you can use the DeletionTaskId parameter in GetServiceLinkedRoleDeletionStatus to check the status of the deletion. If the deletion fails, this operation returns the reason that it failed, if that information is returned by the service.

", - "GetUser": "

Retrieves information about the specified IAM user, including the user's creation date, path, unique ID, and ARN.

If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID used to sign the request to this operation.

", - "GetUserPolicy": "

Retrieves the specified inline policy document that is embedded in the specified IAM user.

Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality, and some SDKs do this decoding automatically.

An IAM user can also have managed policies attached to it. To retrieve a managed policy document that is attached to a user, use GetPolicy to determine the policy's default version. Then use GetPolicyVersion to retrieve the policy document.

For more information about policies, see Managed policies and inline policies in the IAM User Guide.

", - "ListAccessKeys": "

Returns information about the access key IDs associated with the specified IAM user. If there is none, the operation returns an empty list.

Although each user is limited to a small number of keys, you can still paginate the results using the MaxItems and Marker parameters.

If the UserName is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. If a temporary access key is used, then UserName is required. If a long-term key is assigned to the user, then UserName is not required.

This operation works for access keys under the Amazon Web Services account. If the Amazon Web Services account has no associated users, the root user returns it's own access key IDs by running this command.

To ensure the security of your Amazon Web Services account, the secret access key is accessible only during key and user creation.

", - "ListAccountAliases": "

Lists the account alias associated with the Amazon Web Services account (Note: you can have only one). For information about using an Amazon Web Services account alias, see Creating, deleting, and listing an Amazon Web Services account alias in the IAM User Guide.

", - "ListAttachedGroupPolicies": "

Lists all managed policies that are attached to the specified IAM group.

An IAM group can also have inline policies embedded with it. To list the inline policies for a group, use ListGroupPolicies. For information about policies, see Managed policies and inline policies in the IAM User Guide.

You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the operation returns an empty list.

", - "ListAttachedRolePolicies": "

Lists all managed policies that are attached to the specified IAM role.

An IAM role can also have inline policies embedded with it. To list the inline policies for a role, use ListRolePolicies. For information about policies, see Managed policies and inline policies in the IAM User Guide.

You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified role (or none that match the specified path prefix), the operation returns an empty list.

", - "ListAttachedUserPolicies": "

Lists all managed policies that are attached to the specified IAM user.

An IAM user can also have inline policies embedded with it. To list the inline policies for a user, use ListUserPolicies. For information about policies, see Managed policies and inline policies in the IAM User Guide.

You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the operation returns an empty list.

", - "ListDelegationRequests": "

Lists delegation requests based on the specified criteria.

If a delegation request has no owner, even if it is assigned to a specific account, it will not be part of the ListDelegationRequests output for that account.

For more details, see Managing Permissions for Delegation Requests.

", - "ListEntitiesForPolicy": "

Lists all IAM users, groups, and roles that the specified managed policy is attached to.

You can use the optional EntityFilter parameter to limit the results to a particular type of entity (users, groups, or roles). For example, to list only the roles that are attached to the specified policy, set EntityFilter to Role.

You can paginate the results using the MaxItems and Marker parameters.

", - "ListGroupPolicies": "

Lists the names of the inline policies that are embedded in the specified IAM group.

An IAM group can also have managed policies attached to it. To list the managed policies that are attached to a group, use ListAttachedGroupPolicies. For more information about policies, see Managed policies and inline policies in the IAM User Guide.

You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified group, the operation returns an empty list.

", - "ListGroups": "

Lists the IAM groups that have the specified path prefix.

You can paginate the results using the MaxItems and Marker parameters.

", - "ListGroupsForUser": "

Lists the IAM groups that the specified IAM user belongs to.

You can paginate the results using the MaxItems and Marker parameters.

", - "ListInstanceProfileTags": "

Lists the tags that are attached to the specified IAM instance profile. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

", - "ListInstanceProfiles": "

Lists the instance profiles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about instance profiles, see Using instance profiles in the IAM User Guide.

IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for an instance profile, see GetInstanceProfile.

You can paginate the results using the MaxItems and Marker parameters.

", - "ListInstanceProfilesForRole": "

Lists the instance profiles that have the specified associated IAM role. If there are none, the operation returns an empty list. For more information about instance profiles, go to Using instance profiles in the IAM User Guide.

You can paginate the results using the MaxItems and Marker parameters.

", - "ListMFADeviceTags": "

Lists the tags that are attached to the specified IAM virtual multi-factor authentication (MFA) device. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

", - "ListMFADevices": "

Lists the MFA devices for an IAM user. If the request includes a IAM user name, then this operation lists all the MFA devices associated with the specified user. If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request for this operation.

You can paginate the results using the MaxItems and Marker parameters.

", - "ListOpenIDConnectProviderTags": "

Lists the tags that are attached to the specified OpenID Connect (OIDC)-compatible identity provider. The returned list of tags is sorted by tag key. For more information, see About web identity federation.

For more information about tagging, see Tagging IAM resources in the IAM User Guide.

", - "ListOpenIDConnectProviders": "

Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the Amazon Web Services account.

IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for an OIDC provider, see GetOpenIDConnectProvider.

", - "ListOrganizationsFeatures": "

Lists the centralized root access features enabled for your organization. For more information, see Centrally manage root access for member accounts.

", - "ListPolicies": "

Lists all the managed policies that are available in your Amazon Web Services account, including your own customer-defined managed policies and all Amazon Web Services managed policies.

You can filter the list of policies that is returned using the optional OnlyAttached, Scope, and PathPrefix parameters. For example, to list only the customer managed policies in your Amazon Web Services account, set Scope to Local. To list only Amazon Web Services managed policies, set Scope to AWS.

You can paginate the results using the MaxItems and Marker parameters.

For more information about managed policies, see Managed policies and inline policies in the IAM User Guide.

IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a customer manged policy, see GetPolicy.

", - "ListPoliciesGrantingServiceAccess": "

Retrieves a list of policies that the IAM identity (user, group, or role) can use to access each specified service.

This operation does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, Organizations policies, IAM permissions boundaries, and STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see Evaluating policies in the IAM User Guide.

The list of policies returned by the operation depends on the ARN of the identity that you provide.

  • User – The list of policies includes the managed and inline policies that are attached to the user directly. The list also includes any additional managed and inline policies that are attached to the group to which the user belongs.

  • Group – The list of policies includes only the managed and inline policies that are attached to the group directly. Policies that are attached to the group’s user are not included.

  • Role – The list of policies includes only the managed and inline policies that are attached to the role.

For each managed policy, this operation returns the ARN and policy name. For each inline policy, it returns the policy name and the entity to which it is attached. Inline policies do not have an ARN. For more information about these policy types, see Managed policies and inline policies in the IAM User Guide.

Policies that are attached to users and roles as permissions boundaries are not returned. To view which managed policy is currently used to set the permissions boundary for a user or role, use the GetUser or GetRole operations.

", - "ListPolicyTags": "

Lists the tags that are attached to the specified IAM customer managed policy. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

", - "ListPolicyVersions": "

Lists information about the versions of the specified managed policy, including the version that is currently set as the policy's default version.

For more information about managed policies, see Managed policies and inline policies in the IAM User Guide.

", - "ListRolePolicies": "

Lists the names of the inline policies that are embedded in the specified IAM role.

An IAM role can also have managed policies attached to it. To list the managed policies that are attached to a role, use ListAttachedRolePolicies. For more information about policies, see Managed policies and inline policies in the IAM User Guide.

You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified role, the operation returns an empty list.

", - "ListRoleTags": "

Lists the tags that are attached to the specified role. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

", - "ListRoles": "

Lists the IAM roles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about roles, see IAM roles in the IAM User Guide.

IAM resource-listing operations return a subset of the available attributes for the resource. This operation does not return the following attributes, even though they are an attribute of the returned object:

  • PermissionsBoundary

  • RoleLastUsed

  • Tags

To view all of the information for a role, see GetRole.

You can paginate the results using the MaxItems and Marker parameters.

", - "ListSAMLProviderTags": "

Lists the tags that are attached to the specified Security Assertion Markup Language (SAML) identity provider. The returned list of tags is sorted by tag key. For more information, see About SAML 2.0-based federation.

For more information about tagging, see Tagging IAM resources in the IAM User Guide.

", - "ListSAMLProviders": "

Lists the SAML provider resource objects defined in IAM in the account. IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a SAML provider, see GetSAMLProvider.

This operation requires Signature Version 4.

", - "ListSSHPublicKeys": "

Returns information about the SSH public keys associated with the specified IAM user. If none exists, the operation returns an empty list.

The SSH public keys returned by this operation are used only for authenticating the IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide.

Although each user is limited to a small number of keys, you can still paginate the results using the MaxItems and Marker parameters.

", - "ListServerCertificateTags": "

Lists the tags that are attached to the specified IAM server certificate. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

For certificates in a Region supported by Certificate Manager (ACM), we recommend that you don't use IAM server certificates. Instead, use ACM to provision, manage, and deploy your server certificates. For more information about IAM server certificates, Working with server certificates in the IAM User Guide.

", - "ListServerCertificates": "

Lists the server certificates stored in IAM that have the specified path prefix. If none exist, the operation returns an empty list.

You can paginate the results using the MaxItems and Marker parameters.

For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.

IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a servercertificate, see GetServerCertificate.

", - "ListServiceSpecificCredentials": "

Returns information about the service-specific credentials associated with the specified IAM user. If none exists, the operation returns an empty list. The service-specific credentials returned by this operation are used only for authenticating the IAM user to a specific service. For more information about using service-specific credentials to authenticate to an Amazon Web Services service, refer to the following docs:

", - "ListSigningCertificates": "

Returns information about the signing certificates associated with the specified IAM user. If none exists, the operation returns an empty list.

Although each user is limited to a small number of signing certificates, you can still paginate the results using the MaxItems and Marker parameters.

If the UserName field is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request for this operation. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.

", - "ListUserPolicies": "

Lists the names of the inline policies embedded in the specified IAM user.

An IAM user can also have managed policies attached to it. To list the managed policies that are attached to a user, use ListAttachedUserPolicies. For more information about policies, see Managed policies and inline policies in the IAM User Guide.

You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified user, the operation returns an empty list.

", - "ListUserTags": "

Lists the tags that are attached to the specified IAM user. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

", - "ListUsers": "

Lists the IAM users that have the specified path prefix. If no path prefix is specified, the operation returns all users in the Amazon Web Services account. If there are none, the operation returns an empty list.

IAM resource-listing operations return a subset of the available attributes for the resource. This operation does not return the following attributes, even though they are an attribute of the returned object:

  • PermissionsBoundary

  • Tags

To view all of the information for a user, see GetUser.

You can paginate the results using the MaxItems and Marker parameters.

", - "ListVirtualMFADevices": "

Lists the virtual MFA devices defined in the Amazon Web Services account by assignment status. If you do not specify an assignment status, the operation returns a list of all virtual MFA devices. Assignment status can be Assigned, Unassigned, or Any.

IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view tag information for a virtual MFA device, see ListMFADeviceTags.

You can paginate the results using the MaxItems and Marker parameters.

", - "PutGroupPolicy": "

Adds or updates an inline policy document that is embedded in the specified IAM group.

A user can also have managed policies attached to it. To attach a managed policy to a group, use AttachGroupPolicy . To create a new managed policy, use CreatePolicy . For information about policies, see Managed policies and inline policies in the IAM User Guide.

For information about the maximum number of inline policies that you can embed in a group, see IAM and STS quotas in the IAM User Guide.

Because policy documents can be large, you should use POST rather than GET when calling PutGroupPolicy. For general information about using the Query API with IAM, see Making query requests in the IAM User Guide.

", - "PutRolePermissionsBoundary": "

Adds or updates the policy that is specified as the IAM role's permissions boundary. You can use an Amazon Web Services managed policy or a customer managed policy to set the boundary for a role. Use the boundary to control the maximum permissions that the role can have. Setting a permissions boundary is an advanced feature that can affect the permissions for the role.

You cannot set the boundary for a service-linked role.

Policies used as permissions boundaries do not provide permissions. You must also attach a permissions policy to the role. To learn how the effective permissions for a role are evaluated, see IAM JSON policy evaluation logic in the IAM User Guide.

", - "PutRolePolicy": "

Adds or updates an inline policy document that is embedded in the specified IAM role.

When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role, using CreateRole . You can update a role's trust policy using UpdateAssumeRolePolicy . For more information about roles, see IAM roles in the IAM User Guide.

A role can also have a managed policy attached to it. To attach a managed policy to a role, use AttachRolePolicy . To create a new managed policy, use CreatePolicy . For information about policies, see Managed policies and inline policies in the IAM User Guide.

For information about the maximum number of inline policies that you can embed with a role, see IAM and STS quotas in the IAM User Guide.

Because policy documents can be large, you should use POST rather than GET when calling PutRolePolicy. For general information about using the Query API with IAM, see Making query requests in the IAM User Guide.

", - "PutUserPermissionsBoundary": "

Adds or updates the policy that is specified as the IAM user's permissions boundary. You can use an Amazon Web Services managed policy or a customer managed policy to set the boundary for a user. Use the boundary to control the maximum permissions that the user can have. Setting a permissions boundary is an advanced feature that can affect the permissions for the user.

Policies that are used as permissions boundaries do not provide permissions. You must also attach a permissions policy to the user. To learn how the effective permissions for a user are evaluated, see IAM JSON policy evaluation logic in the IAM User Guide.

", - "PutUserPolicy": "

Adds or updates an inline policy document that is embedded in the specified IAM user.

An IAM user can also have a managed policy attached to it. To attach a managed policy to a user, use AttachUserPolicy . To create a new managed policy, use CreatePolicy . For information about policies, see Managed policies and inline policies in the IAM User Guide.

For information about the maximum number of inline policies that you can embed in a user, see IAM and STS quotas in the IAM User Guide.

Because policy documents can be large, you should use POST rather than GET when calling PutUserPolicy. For general information about using the Query API with IAM, see Making query requests in the IAM User Guide.

", - "RejectDelegationRequest": "

Rejects a delegation request, denying the requested temporary access.

Once a request is rejected, it cannot be accepted or updated later. Rejected requests expire after 7 days.

When rejecting a request, an optional explanation can be added using the Notes request parameter.

For more details, see Managing Permissions for Delegation Requests.

", - "RemoveClientIDFromOpenIDConnectProvider": "

Removes the specified client ID (also known as audience) from the list of client IDs registered for the specified IAM OpenID Connect (OIDC) provider resource object.

This operation is idempotent; it does not fail or return an error if you try to remove a client ID that does not exist.

", - "RemoveRoleFromInstanceProfile": "

Removes the specified IAM role from the specified Amazon EC2 instance profile.

Make sure that you do not have any Amazon EC2 instances running with the role you are about to remove from the instance profile. Removing a role from an instance profile that is associated with a running instance might break any applications running on the instance.

For more information about roles, see IAM roles in the IAM User Guide. For more information about instance profiles, see Using instance profiles in the IAM User Guide.

", - "RemoveUserFromGroup": "

Removes the specified user from the specified group.

", - "ResetServiceSpecificCredential": "

Resets the password for a service-specific credential. The new password is Amazon Web Services generated and cryptographically strong. It cannot be configured by the user. Resetting the password immediately invalidates the previous password associated with this user.

", - "ResyncMFADevice": "

Synchronizes the specified MFA device with its IAM resource object on the Amazon Web Services servers.

For more information about creating and working with virtual MFA devices, see Using a virtual MFA device in the IAM User Guide.

", - "SendDelegationToken": "

Sends the exchange token for an accepted delegation request.

The exchange token is sent to the partner via an asynchronous notification channel, established by the partner.

The delegation request must be in the ACCEPTED state when calling this API. After the SendDelegationToken API call is successful, the request transitions to a FINALIZED state and cannot be rolled back. However, a user may reject an accepted request before the SendDelegationToken API is called.

For more details, see Managing Permissions for Delegation Requests.

", - "SetDefaultPolicyVersion": "

Sets the specified version of the specified policy as the policy's default (operative) version.

This operation affects all users, groups, and roles that the policy is attached to. To list the users, groups, and roles that the policy is attached to, use ListEntitiesForPolicy.

For information about managed policies, see Managed policies and inline policies in the IAM User Guide.

", - "SetSecurityTokenServicePreferences": "

Sets the specified version of the global endpoint token as the token version used for the Amazon Web Services account.

By default, Security Token Service (STS) is available as a global service, and all STS requests go to a single endpoint at https://sts.amazonaws.com. Amazon Web Services recommends using Regional STS endpoints to reduce latency, build in redundancy, and increase session token availability. For information about Regional endpoints for STS, see Security Token Service endpoints and quotas in the Amazon Web Services General Reference.

If you make an STS call to the global endpoint, the resulting session tokens might be valid in some Regions but not others. It depends on the version that is set in this operation. Version 1 tokens are valid only in Amazon Web Services Regions that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily store tokens. For information, see Activating and deactivating STS in an Amazon Web Services Region in the IAM User Guide.

To view the current session token version, see the GlobalEndpointTokenVersion entry in the response of the GetAccountSummary operation.

", - "SimulateCustomPolicy": "

Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API operations and Amazon Web Services resources to determine the policies' effective permissions. The policies are provided as strings.

The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations. You can simulate resources that don't exist in your account.

If you want to simulate existing policies that are attached to an IAM user, group, or role, use SimulatePrincipalPolicy instead.

Context keys are variables that are maintained by Amazon Web Services and its services and which provide details about the context of an API query request. You can use the Condition element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForCustomPolicy.

If the output is long, you can use MaxItems and Marker parameters to paginate the results.

The IAM policy simulator evaluates statements in identity-based policies, service control policies (SCPs) including their condition keys and resource scoping, and the inputs that you provide during simulation. The policy simulator results can differ from your live Amazon Web Services environment. We recommend that you check your policies against your live Amazon Web Services environment after testing using the policy simulator to confirm that you have the desired results. For more information about using the policy simulator, see Testing IAM policies with the IAM policy simulator in the IAM User Guide.

", - "SimulatePrincipalPolicy": "

Simulate how a set of IAM policies attached to an IAM entity works with a list of API operations and Amazon Web Services resources to determine the policies' effective permissions. The entity can be an IAM user, group, or role. If you specify a user, then the simulation also includes all of the policies that are attached to groups that the user belongs to. You can simulate resources that don't exist in your account.

You can optionally include a list of one or more additional policies specified as strings to include in the simulation. If you want to simulate only policies specified as strings, use SimulateCustomPolicy instead.

You can also optionally include one resource-based policy to be evaluated with each of the resources included in the simulation for IAM users only.

The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations.

For cross-account simulations, EvalDecisionDetails returns the decision for each policy type (identity-based policy, resource-based policy, and permissions boundary). This helps you identify which policy type is responsible for an allow or deny decision when policies span multiple accounts.

Note: This operation discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use SimulateCustomPolicy instead.

Context keys are variables maintained by Amazon Web Services and its services that provide details about the context of an API query request. You can use the Condition element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForPrincipalPolicy.

If the output is long, you can use the MaxItems and Marker parameters to paginate the results.

The IAM policy simulator evaluates statements in identity-based policies, service control policies (SCPs) including their condition keys and resource scoping, and the inputs that you provide during simulation. The policy simulator results can differ from your live Amazon Web Services environment. We recommend that you check your policies against your live Amazon Web Services environment after testing using the policy simulator to confirm that you have the desired results. For more information about using the policy simulator, see Testing IAM policies with the IAM policy simulator in the IAM User Guide.

", - "TagInstanceProfile": "

Adds one or more tags to an IAM instance profile. If a tag with the same key name already exists, then that tag is overwritten with the new value.

Each tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:

  • Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.

  • Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM instance profile that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.

  • If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

  • Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

", - "TagMFADevice": "

Adds one or more tags to an IAM virtual multi-factor authentication (MFA) device. If a tag with the same key name already exists, then that tag is overwritten with the new value.

A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:

  • Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.

  • Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM virtual MFA device that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.

  • If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

  • Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

", - "TagOpenIDConnectProvider": "

Adds one or more tags to an OpenID Connect (OIDC)-compatible identity provider. For more information about these providers, see About web identity federation. If a tag with the same key name already exists, then that tag is overwritten with the new value.

A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:

  • Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.

  • Access control - Include tags in IAM identity-based and resource-based policies. You can use tags to restrict access to only an OIDC provider that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.

  • If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

  • Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

", - "TagPolicy": "

Adds one or more tags to an IAM customer managed policy. If a tag with the same key name already exists, then that tag is overwritten with the new value.

A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:

  • Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.

  • Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM customer managed policy that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.

  • If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

  • Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

", - "TagRole": "

Adds one or more tags to an IAM role. The role can be a regular role or a service-linked role. If a tag with the same key name already exists, then that tag is overwritten with the new value.

A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:

  • Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.

  • Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM role that has a specified tag attached. You can also restrict access to only those resources that have a certain tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.

  • Cost allocation - Use tags to help track which individuals and teams are using which Amazon Web Services resources.

  • If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

  • Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

For more information about tagging, see Tagging IAM identities in the IAM User Guide.

", - "TagSAMLProvider": "

Adds one or more tags to a Security Assertion Markup Language (SAML) identity provider. For more information about these providers, see About SAML 2.0-based federation . If a tag with the same key name already exists, then that tag is overwritten with the new value.

A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:

  • Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.

  • Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only a SAML identity provider that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.

  • If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

  • Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

", - "TagServerCertificate": "

Adds one or more tags to an IAM server certificate. If a tag with the same key name already exists, then that tag is overwritten with the new value.

For certificates in a Region supported by Certificate Manager (ACM), we recommend that you don't use IAM server certificates. Instead, use ACM to provision, manage, and deploy your server certificates. For more information about IAM server certificates, Working with server certificates in the IAM User Guide.

A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:

  • Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.

  • Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only a server certificate that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.

  • Cost allocation - Use tags to help track which individuals and teams are using which Amazon Web Services resources.

  • If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

  • Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

", - "TagUser": "

Adds one or more tags to an IAM user. If a tag with the same key name already exists, then that tag is overwritten with the new value.

A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:

  • Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.

  • Access control - Include tags in IAM identity-based and resource-based policies. You can use tags to restrict access to only an IAM requesting user that has a specified tag attached. You can also restrict access to only those resources that have a certain tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.

  • Cost allocation - Use tags to help track which individuals and teams are using which Amazon Web Services resources.

  • If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

  • Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

For more information about tagging, see Tagging IAM identities in the IAM User Guide.

", - "UntagInstanceProfile": "

Removes the specified tags from the IAM instance profile. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

", - "UntagMFADevice": "

Removes the specified tags from the IAM virtual multi-factor authentication (MFA) device. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

", - "UntagOpenIDConnectProvider": "

Removes the specified tags from the specified OpenID Connect (OIDC)-compatible identity provider in IAM. For more information about OIDC providers, see About web identity federation. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

", - "UntagPolicy": "

Removes the specified tags from the customer managed policy. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

", - "UntagRole": "

Removes the specified tags from the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

", - "UntagSAMLProvider": "

Removes the specified tags from the specified Security Assertion Markup Language (SAML) identity provider in IAM. For more information about these providers, see About web identity federation. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

", - "UntagServerCertificate": "

Removes the specified tags from the IAM server certificate. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

For certificates in a Region supported by Certificate Manager (ACM), we recommend that you don't use IAM server certificates. Instead, use ACM to provision, manage, and deploy your server certificates. For more information about IAM server certificates, Working with server certificates in the IAM User Guide.

", - "UntagUser": "

Removes the specified tags from the user. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

", - "UpdateAccessKey": "

Changes the status of the specified access key from Active to Inactive, or vice versa. This operation can be used to disable a user's key as part of a key rotation workflow.

If the UserName is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. If a temporary access key is used, then UserName is required. If a long-term key is assigned to the user, then UserName is not required. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.

For information about rotating keys, see Managing keys and certificates in the IAM User Guide.

", - "UpdateAccountPasswordPolicy": "

Updates the password policy settings for the Amazon Web Services account.

This operation does not support partial updates. No parameters are required, but if you do not specify a parameter, that parameter's value reverts to its default value. See the Request Parameters section for each parameter's default value. Also note that some parameters do not allow the default parameter to be explicitly set. Instead, to invoke the default value, do not include that parameter when you invoke the operation.

For more information about using a password policy, see Managing an IAM password policy in the IAM User Guide.

", - "UpdateAssumeRolePolicy": "

Updates the policy that grants an IAM entity permission to assume a role. This is typically referred to as the \"role trust policy\". For more information about roles, see Using roles to delegate permissions and federate identities.

", - "UpdateDelegationRequest": "

Updates an existing delegation request with additional information. When the delegation request is updated, it reaches the PENDING_APPROVAL state.

Once a delegation request has an owner, that owner gets a default permission to update the delegation request. For more details, see Managing Permissions for Delegation Requests.

", - "UpdateGroup": "

Updates the name and/or the path of the specified IAM group.

You should understand the implications of changing a group's path or name. For more information, see Renaming users and groups in the IAM User Guide.

The person making the request (the principal), must have permission to change the role group with the old name and the new name. For example, to change the group named Managers to MGRs, the principal must have a policy that allows them to update both groups. If the principal has permission to update the Managers group, but not the MGRs group, then the update fails. For more information about permissions, see Access management.

", - "UpdateLoginProfile": "

Changes the password for the specified IAM user. You can use the CLI, the Amazon Web Services API, or the Users page in the IAM console to change the password for any IAM user. Use ChangePassword to change your own password in the My Security Credentials page in the Amazon Web Services Management Console.

For more information about modifying passwords, see Managing passwords in the IAM User Guide.

", - "UpdateOpenIDConnectProviderThumbprint": "

Replaces the existing list of server certificate thumbprints associated with an OpenID Connect (OIDC) provider resource object with a new list of thumbprints.

The list that you pass with this operation completely replaces the existing list of thumbprints. (The lists are not merged.)

Typically, you need to update a thumbprint only when the identity provider certificate changes, which occurs rarely. However, if the provider's certificate does change, any attempt to assume an IAM role that specifies the OIDC provider as a principal fails until the certificate thumbprint is updated.

Amazon Web Services secures communication with OIDC identity providers (IdPs) using our library of trusted root certificate authorities (CAs) to verify the JSON Web Key Set (JWKS) endpoint's TLS certificate. If your OIDC IdP relies on a certificate that is not signed by one of these trusted CAs, only then we secure communication using the thumbprints set in the IdP's configuration.

Trust for the OIDC provider is derived from the provider certificate and is validated by the thumbprint. Therefore, it is best to limit access to the UpdateOpenIDConnectProviderThumbprint operation to highly privileged users.

", - "UpdateRole": "

Updates the description or maximum session duration setting of a role.

", - "UpdateRoleDescription": "

Use UpdateRole instead.

Modifies only the description of a role. This operation performs the same function as the Description parameter in the UpdateRole operation.

", - "UpdateSAMLProvider": "

Updates the metadata document, SAML encryption settings, and private keys for an existing SAML provider. To rotate private keys, add your new private key and then remove the old key in a separate request.

", - "UpdateSSHPublicKey": "

Sets the status of an IAM user's SSH public key to active or inactive. SSH public keys that are inactive cannot be used for authentication. This operation can be used to disable a user's SSH public key as part of a key rotation work flow.

The SSH public key affected by this operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide.

", - "UpdateServerCertificate": "

Updates the name and/or the path of the specified server certificate stored in IAM.

For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.

You should understand the implications of changing a server certificate's path or name. For more information, see Renaming a server certificate in the IAM User Guide.

The person making the request (the principal), must have permission to change the server certificate with the old name and the new name. For example, to change the certificate named ProductionCert to ProdCert, the principal must have a policy that allows them to update both certificates. If the principal has permission to update the ProductionCert group, but not the ProdCert certificate, then the update fails. For more information about permissions, see Access management in the IAM User Guide.

", - "UpdateServiceSpecificCredential": "

Sets the status of a service-specific credential to Active or Inactive. Service-specific credentials that are inactive cannot be used for authentication to the service. This operation can be used to disable a user's service-specific credential as part of a credential rotation work flow.

", - "UpdateSigningCertificate": "

Changes the status of the specified user signing certificate from active to disabled, or vice versa. This operation can be used to disable an IAM user's signing certificate as part of a certificate rotation work flow.

If the UserName field is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.

", - "UpdateUser": "

Updates the name and/or the path of the specified IAM user.

You should understand the implications of changing an IAM user's path or name. For more information, see Renaming an IAM user and Renaming an IAM group in the IAM User Guide.

To change a user name, the requester must have appropriate permissions on both the source object and the target object. For example, to change Bob to Robert, the entity making the request must have permission on Bob and Robert, or must have permission on all (*). For more information about permissions, see Permissions and policies.

", - "UploadSSHPublicKey": "

Uploads an SSH public key and associates it with the specified IAM user.

The SSH public key uploaded by this operation can be used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide.

", - "UploadServerCertificate": "

Uploads a server certificate entity for the Amazon Web Services account. The server certificate entity includes a public key certificate, a private key, and an optional certificate chain, which should all be PEM-encoded.

We recommend that you use Certificate Manager to provision, manage, and deploy your server certificates. With ACM you can request a certificate, deploy it to Amazon Web Services resources, and let ACM handle certificate renewals for you. Certificates provided by ACM are free. For more information about using ACM, see the Certificate Manager User Guide.

For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.

For information about the number of server certificates you can upload, see IAM and STS quotas in the IAM User Guide.

Because the body of the public key certificate, private key, and the certificate chain can be large, you should use POST rather than GET when calling UploadServerCertificate. For information about setting up signatures and authorization through the API, see Signing Amazon Web Services API requests in the Amazon Web Services General Reference. For general information about using the Query API with IAM, see Calling the API by making HTTP query requests in the IAM User Guide.

", - "UploadSigningCertificate": "

Uploads an X.509 signing certificate and associates it with the specified IAM user. Some Amazon Web Services services require you to use certificates to validate requests that are signed with a corresponding private key. When you upload the certificate, its default status is Active.

For information about when you would use an X.509 signing certificate, see Managing server certificates in IAM in the IAM User Guide.

If the UserName is not specified, the IAM user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.

Because the body of an X.509 certificate can be large, you should use POST rather than GET when calling UploadSigningCertificate. For information about setting up signatures and authorization through the API, see Signing Amazon Web Services API requests in the Amazon Web Services General Reference. For general information about using the Query API with IAM, see Making query requests in the IAM User Guide.

" - }, - "shapes": { - "AcceptDelegationRequestRequest": { - "base": null, - "refs": {} - }, - "AccessAdvisorUsageGranularityType": { - "base": null, - "refs": { - "GenerateServiceLastAccessedDetailsRequest$Granularity": "

The level of detail that you want to generate. You can specify whether you want to generate information about the last attempt to access services or actions. If you specify service-level granularity, this operation generates only service data. If you specify action-level granularity, it generates service and action data. If you don't include this optional parameter, the operation generates service data.

", - "GetServiceLastAccessedDetailsResponse$JobType": "

The type of job. Service jobs return information about when each service was last accessed. Action jobs also include information about when tracked actions within the service were last accessed.

" - } - }, - "AccessDetail": { - "base": "

An object that contains details about when a principal in the reported Organizations entity last attempted to access an Amazon Web Services service. A principal can be an IAM user, an IAM role, or the Amazon Web Services account root user within the reported Organizations entity.

This data type is a response element in the GetOrganizationsAccessReport operation.

", - "refs": { - "AccessDetails$member": null - } - }, - "AccessDetails": { - "base": null, - "refs": { - "GetOrganizationsAccessReportResponse$AccessDetails": "

An object that contains details about the most recent attempt to access the service.

" - } - }, - "AccessKey": { - "base": "

Contains information about an Amazon Web Services access key.

This data type is used as a response element in the CreateAccessKey and ListAccessKeys operations.

The SecretAccessKey value is returned only in response to CreateAccessKey. You can get a secret access key only when you first create an access key; you cannot recover the secret access key later. If you lose a secret access key, you must create a new access key.

", - "refs": { - "CreateAccessKeyResponse$AccessKey": "

A structure with details about the access key.

" - } - }, - "AccessKeyLastUsed": { - "base": "

Contains information about the last time an Amazon Web Services access key was used since IAM began tracking this information on April 22, 2015.

This data type is used as a response element in the GetAccessKeyLastUsed operation.

", - "refs": { - "GetAccessKeyLastUsedResponse$AccessKeyLastUsed": "

Contains information about the last time the access key was used.

" - } - }, - "AccessKeyMetadata": { - "base": "

Contains information about an Amazon Web Services access key, without its secret key.

This data type is used as a response element in the ListAccessKeys operation.

", - "refs": { - "accessKeyMetadataListType$member": null - } - }, - "AccountNotManagementOrDelegatedAdministratorException": { - "base": "

The request was rejected because the account making the request is not the management account or delegated administrator account for centralized root access.

", - "refs": {} - }, - "ActionNameListType": { - "base": null, - "refs": { - "SimulateCustomPolicyRequest$ActionNames": "

A list of names of API operations to evaluate in the simulation. Each operation is evaluated against each resource. Each operation must include the service identifier, such as iam:CreateUser. This operation does not support using wildcards (*) in an action name.

", - "SimulatePrincipalPolicyRequest$ActionNames": "

A list of names of API operations to evaluate in the simulation. Each operation is evaluated for each resource. Each operation must include the service identifier, such as iam:CreateUser.

" - } - }, - "ActionNameType": { - "base": null, - "refs": { - "ActionNameListType$member": null, - "EvaluationResult$EvalActionName": "

The name of the API operation tested on the indicated resource.

" - } - }, - "AddClientIDToOpenIDConnectProviderRequest": { - "base": null, - "refs": {} - }, - "AddRoleToInstanceProfileRequest": { - "base": null, - "refs": {} - }, - "AddUserToGroupRequest": { - "base": null, - "refs": {} - }, - "ArnListType": { - "base": null, - "refs": { - "RoleUsageType$Resources": "

The name of the resource that is using the service-linked role.

" - } - }, - "AssociateDelegationRequestRequest": { - "base": null, - "refs": {} - }, - "AttachGroupPolicyRequest": { - "base": null, - "refs": {} - }, - "AttachRolePolicyRequest": { - "base": null, - "refs": {} - }, - "AttachUserPolicyRequest": { - "base": null, - "refs": {} - }, - "AttachedPermissionsBoundary": { - "base": "

Contains information about an attached permissions boundary.

An attached permissions boundary is a managed policy that has been attached to a user or role to set the permissions boundary.

For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.

", - "refs": { - "Role$PermissionsBoundary": "

The ARN of the policy used to set the permissions boundary for the role.

For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.

", - "RoleDetail$PermissionsBoundary": "

The ARN of the policy used to set the permissions boundary for the role.

For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.

", - "User$PermissionsBoundary": "

For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.

", - "UserDetail$PermissionsBoundary": "

The ARN of the policy used to set the permissions boundary for the user.

For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.

" - } - }, - "AttachedPolicy": { - "base": "

Contains information about an attached policy.

An attached policy is a managed policy that has been attached to a user, group, or role. This data type is used as a response element in the ListAttachedGroupPolicies, ListAttachedRolePolicies, ListAttachedUserPolicies, and GetAccountAuthorizationDetails operations.

For more information about managed policies, refer to Managed policies and inline policies in the IAM User Guide.

", - "refs": { - "attachedPoliciesListType$member": null - } - }, - "AttachmentName": { - "base": null, - "refs": { - "InlinePolicyIdentifierType$AttachmentName": "

The name of the IAM user, group, or role that the inline policy is attached to. Wildcard characters are supported to match multiple entities: use at most one * (matches any sequence of characters, including none), and any number of ? (each matches exactly one character).

" - } - }, - "AttachmentType": { - "base": null, - "refs": { - "InlinePolicyIdentifierType$AttachmentType": "

The type of IAM entity that the inline policy is attached to.

" - } - }, - "BootstrapDatum": { - "base": null, - "refs": { - "VirtualMFADevice$Base32StringSeed": "

The base32 seed defined as specified in RFC3548. The Base32StringSeed is base32-encoded.

", - "VirtualMFADevice$QRCodePNG": "

A QR code PNG image that encodes otpauth://totp/$virtualMFADeviceName@$AccountName?secret=$Base32String where $virtualMFADeviceName is one of the create call arguments. AccountName is the user name if set (otherwise, the account ID otherwise), and Base32String is the seed in base32 format. The Base32String value is base64-encoded.

" - } - }, - "CallerIsNotManagementAccountException": { - "base": "

The request was rejected because the account making the request is not the management account for the organization.

", - "refs": {} - }, - "CertificationKeyType": { - "base": null, - "refs": { - "CertificationMapType$key": null - } - }, - "CertificationMapType": { - "base": null, - "refs": { - "GetMFADeviceResponse$Certifications": "

The certifications of a specified user's MFA device. We currently provide FIPS-140-2, FIPS-140-3, and FIDO certification levels obtained from FIDO Alliance Metadata Service (MDS).

" - } - }, - "CertificationValueType": { - "base": null, - "refs": { - "CertificationMapType$value": null - } - }, - "ChangePasswordRequest": { - "base": null, - "refs": {} - }, - "ColumnNumber": { - "base": null, - "refs": { - "Position$Column": "

The column in the line containing the specified position in the document.

" - } - }, - "ConcurrentModificationException": { - "base": "

The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.

", - "refs": {} - }, - "ConcurrentModificationMessage": { - "base": null, - "refs": { - "ConcurrentModificationException$message": null - } - }, - "ContextEntry": { - "base": "

Contains information about a condition context key. It includes the name of the key and specifies the value (or values, if the context key supports multiple values) to use in the simulation. This information is used when evaluating the Condition elements of the input policies.

This data type is used as an input parameter to SimulateCustomPolicy and SimulatePrincipalPolicy.

", - "refs": { - "ContextEntryListType$member": null - } - }, - "ContextEntryListType": { - "base": null, - "refs": { - "SimulateCustomPolicyRequest$ContextEntries": "

A list of context keys and corresponding values for the simulation to use. Whenever a context key is evaluated in one of the simulated IAM permissions policies, the corresponding value is supplied.

", - "SimulatePrincipalPolicyRequest$ContextEntries": "

A list of context keys and corresponding values for the simulation to use. Whenever a context key is evaluated in one of the simulated IAM permissions policies, the corresponding value is supplied.

" - } - }, - "ContextKeyNameType": { - "base": null, - "refs": { - "ContextEntry$ContextKeyName": "

The full name of a condition context key, including the service prefix. For example, aws:SourceIp or s3:VersionId.

", - "ContextKeyNamesResultListType$member": null - } - }, - "ContextKeyNamesResultListType": { - "base": null, - "refs": { - "EvaluationResult$MissingContextValues": "

A list of context keys that are required by the included input policies but that were not provided by one of the input parameters. This list is used when the resource in a simulation is \"*\", either explicitly, or when the ResourceArns parameter blank. If you include a list of resources, then any missing context values are instead included under the ResourceSpecificResults section. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.

In the top-level result, this field contains the deduplicated set of missing context values across all requested resources. This field doesn't include context keys referenced by service control policies (SCPs). Only context keys referenced by identity-based and resource-based policies appear here.

", - "GetContextKeysForPolicyResponse$ContextKeyNames": "

The list of context keys that are referenced in the input policies.

", - "ResourceSpecificResult$MissingContextValues": "

A list of context keys that are required by the included input policies but that were not provided by one of the input parameters. This list is used when a list of ARNs is included in the ResourceArns parameter instead of \"*\". If you do not specify individual resources, by setting ResourceArns to \"*\" or by not including the ResourceArns parameter, then any missing context values are instead included under the EvaluationResults section. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.

" - } - }, - "ContextKeyTypeEnum": { - "base": null, - "refs": { - "ContextEntry$ContextKeyType": "

The data type of the value (or values) specified in the ContextKeyValues parameter.

" - } - }, - "ContextKeyValueListType": { - "base": null, - "refs": { - "ContextEntry$ContextKeyValues": "

The value (or values, if the condition context key supports multiple values) to provide to the simulation when the key is referenced by a Condition element in an input policy.

" - } - }, - "ContextKeyValueType": { - "base": null, - "refs": { - "ContextKeyValueListType$member": null - } - }, - "CreateAccessKeyRequest": { - "base": null, - "refs": {} - }, - "CreateAccessKeyResponse": { - "base": "

Contains the response to a successful CreateAccessKey request.

", - "refs": {} - }, - "CreateAccountAliasRequest": { - "base": null, - "refs": {} - }, - "CreateDelegationRequestRequest": { - "base": null, - "refs": {} - }, - "CreateDelegationRequestResponse": { - "base": null, - "refs": {} - }, - "CreateGroupRequest": { - "base": null, - "refs": {} - }, - "CreateGroupResponse": { - "base": "

Contains the response to a successful CreateGroup request.

", - "refs": {} - }, - "CreateInstanceProfileRequest": { - "base": null, - "refs": {} - }, - "CreateInstanceProfileResponse": { - "base": "

Contains the response to a successful CreateInstanceProfile request.

", - "refs": {} - }, - "CreateLoginProfileRequest": { - "base": null, - "refs": {} - }, - "CreateLoginProfileResponse": { - "base": "

Contains the response to a successful CreateLoginProfile request.

", - "refs": {} - }, - "CreateOpenIDConnectProviderRequest": { - "base": null, - "refs": {} - }, - "CreateOpenIDConnectProviderResponse": { - "base": "

Contains the response to a successful CreateOpenIDConnectProvider request.

", - "refs": {} - }, - "CreatePolicyRequest": { - "base": null, - "refs": {} - }, - "CreatePolicyResponse": { - "base": "

Contains the response to a successful CreatePolicy request.

", - "refs": {} - }, - "CreatePolicyVersionRequest": { - "base": null, - "refs": {} - }, - "CreatePolicyVersionResponse": { - "base": "

Contains the response to a successful CreatePolicyVersion request.

", - "refs": {} - }, - "CreateRoleRequest": { - "base": null, - "refs": {} - }, - "CreateRoleResponse": { - "base": "

Contains the response to a successful CreateRole request.

", - "refs": {} - }, - "CreateSAMLProviderRequest": { - "base": null, - "refs": {} - }, - "CreateSAMLProviderResponse": { - "base": "

Contains the response to a successful CreateSAMLProvider request.

", - "refs": {} - }, - "CreateServiceLinkedRoleRequest": { - "base": null, - "refs": {} - }, - "CreateServiceLinkedRoleResponse": { - "base": null, - "refs": {} - }, - "CreateServiceSpecificCredentialRequest": { - "base": null, - "refs": {} - }, - "CreateServiceSpecificCredentialResponse": { - "base": null, - "refs": {} - }, - "CreateUserRequest": { - "base": null, - "refs": {} - }, - "CreateUserResponse": { - "base": "

Contains the response to a successful CreateUser request.

", - "refs": {} - }, - "CreateVirtualMFADeviceRequest": { - "base": null, - "refs": {} - }, - "CreateVirtualMFADeviceResponse": { - "base": "

Contains the response to a successful CreateVirtualMFADevice request.

", - "refs": {} - }, - "CredentialReportExpiredException": { - "base": "

The request was rejected because the most recent credential report has expired. To generate a new credential report, use GenerateCredentialReport. For more information about credential report expiration, see Getting credential reports in the IAM User Guide.

", - "refs": {} - }, - "CredentialReportNotPresentException": { - "base": "

The request was rejected because the credential report does not exist. To generate a credential report, use GenerateCredentialReport.

", - "refs": {} - }, - "CredentialReportNotReadyException": { - "base": "

The request was rejected because the credential report is still being generated.

", - "refs": {} - }, - "DeactivateMFADeviceRequest": { - "base": null, - "refs": {} - }, - "DelegationPermission": { - "base": "

Contains information about the permissions being delegated in a delegation request.

", - "refs": { - "CreateDelegationRequestRequest$Permissions": "

The permissions to be delegated in this delegation request.

", - "DelegationRequest$Permissions": null - } - }, - "DelegationRequest": { - "base": "

Contains information about a delegation request, including its status, permissions, and associated metadata.

", - "refs": { - "GetDelegationRequestResponse$DelegationRequest": "

The delegation request object containing all details about the request.

", - "delegationRequestsListType$member": null - } - }, - "DeleteAccessKeyRequest": { - "base": null, - "refs": {} - }, - "DeleteAccountAliasRequest": { - "base": null, - "refs": {} - }, - "DeleteConflictException": { - "base": "

The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities.

", - "refs": {} - }, - "DeleteGroupPolicyRequest": { - "base": null, - "refs": {} - }, - "DeleteGroupRequest": { - "base": null, - "refs": {} - }, - "DeleteInstanceProfileRequest": { - "base": null, - "refs": {} - }, - "DeleteLoginProfileRequest": { - "base": null, - "refs": {} - }, - "DeleteOpenIDConnectProviderRequest": { - "base": null, - "refs": {} - }, - "DeletePolicyRequest": { - "base": null, - "refs": {} - }, - "DeletePolicyVersionRequest": { - "base": null, - "refs": {} - }, - "DeleteRolePermissionsBoundaryRequest": { - "base": null, - "refs": {} - }, - "DeleteRolePolicyRequest": { - "base": null, - "refs": {} - }, - "DeleteRoleRequest": { - "base": null, - "refs": {} - }, - "DeleteSAMLProviderRequest": { - "base": null, - "refs": {} - }, - "DeleteSSHPublicKeyRequest": { - "base": null, - "refs": {} - }, - "DeleteServerCertificateRequest": { - "base": null, - "refs": {} - }, - "DeleteServiceLinkedRoleRequest": { - "base": null, - "refs": {} - }, - "DeleteServiceLinkedRoleResponse": { - "base": null, - "refs": {} - }, - "DeleteServiceSpecificCredentialRequest": { - "base": null, - "refs": {} - }, - "DeleteSigningCertificateRequest": { - "base": null, - "refs": {} - }, - "DeleteUserPermissionsBoundaryRequest": { - "base": null, - "refs": {} - }, - "DeleteUserPolicyRequest": { - "base": null, - "refs": {} - }, - "DeleteUserRequest": { - "base": null, - "refs": {} - }, - "DeleteVirtualMFADeviceRequest": { - "base": null, - "refs": {} - }, - "DeletionTaskFailureReasonType": { - "base": "

The reason that the service-linked role deletion failed.

This data type is used as a response element in the GetServiceLinkedRoleDeletionStatus operation.

", - "refs": { - "GetServiceLinkedRoleDeletionStatusResponse$Reason": "

An object that contains details about the reason the deletion failed.

" - } - }, - "DeletionTaskIdType": { - "base": null, - "refs": { - "DeleteServiceLinkedRoleResponse$DeletionTaskId": "

The deletion task identifier that you can use to check the status of the deletion. This identifier is returned in the format task/aws-service-role/<service-principal-name>/<role-name>/<task-uuid>.

", - "GetServiceLinkedRoleDeletionStatusRequest$DeletionTaskId": "

The deletion task identifier. This identifier is returned by the DeleteServiceLinkedRole operation in the format task/aws-service-role/<service-principal-name>/<role-name>/<task-uuid>.

" - } - }, - "DeletionTaskStatusType": { - "base": null, - "refs": { - "GetServiceLinkedRoleDeletionStatusResponse$Status": "

The status of the deletion.

" - } - }, - "DetachGroupPolicyRequest": { - "base": null, - "refs": {} - }, - "DetachRolePolicyRequest": { - "base": null, - "refs": {} - }, - "DetachUserPolicyRequest": { - "base": null, - "refs": {} - }, - "DisableOrganizationsRootCredentialsManagementRequest": { - "base": null, - "refs": {} - }, - "DisableOrganizationsRootCredentialsManagementResponse": { - "base": null, - "refs": {} - }, - "DisableOrganizationsRootSessionsRequest": { - "base": null, - "refs": {} - }, - "DisableOrganizationsRootSessionsResponse": { - "base": null, - "refs": {} - }, - "DuplicateCertificateException": { - "base": "

The request was rejected because the same certificate is associated with an IAM user in the account.

", - "refs": {} - }, - "DuplicateSSHPublicKeyException": { - "base": "

The request was rejected because the SSH public key is already associated with the specified IAM user.

", - "refs": {} - }, - "EnableMFADeviceRequest": { - "base": null, - "refs": {} - }, - "EnableOrganizationsRootCredentialsManagementRequest": { - "base": null, - "refs": {} - }, - "EnableOrganizationsRootCredentialsManagementResponse": { - "base": null, - "refs": {} - }, - "EnableOrganizationsRootSessionsRequest": { - "base": null, - "refs": {} - }, - "EnableOrganizationsRootSessionsResponse": { - "base": null, - "refs": {} - }, - "EnableOutboundWebIdentityFederationResponse": { - "base": null, - "refs": {} - }, - "EntityAlreadyExistsException": { - "base": "

The request was rejected because it attempted to create a resource that already exists.

", - "refs": {} - }, - "EntityDetails": { - "base": "

An object that contains details about when the IAM entities (users or roles) were last used in an attempt to access the specified Amazon Web Services service.

This data type is a response element in the GetServiceLastAccessedDetailsWithEntities operation.

", - "refs": { - "entityDetailsListType$member": null - } - }, - "EntityInfo": { - "base": "

Contains details about the specified entity (user or role).

This data type is an element of the EntityDetails object.

", - "refs": { - "EntityDetails$EntityInfo": "

The EntityInfo object that contains details about the entity (user or role).

" - } - }, - "EntityTemporarilyUnmodifiableException": { - "base": "

The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity.

", - "refs": {} - }, - "EntityType": { - "base": null, - "refs": { - "ListEntitiesForPolicyRequest$EntityFilter": "

The entity type to use for filtering the results.

For example, when EntityFilter is Role, only the roles that are attached to the specified policy are returned. This parameter is optional. If it is not included, all attached entities (users, groups, and roles) are returned. The argument for this parameter must be one of the valid values listed below.

", - "entityListType$member": null - } - }, - "ErrorDetails": { - "base": "

Contains information about the reason that the operation failed.

This data type is used as a response element in the GetOrganizationsAccessReport, GetServiceLastAccessedDetails, and GetServiceLastAccessedDetailsWithEntities operations.

", - "refs": { - "GetOrganizationsAccessReportResponse$ErrorDetails": null, - "GetServiceLastAccessedDetailsResponse$Error": "

An object that contains details about the reason the operation failed.

", - "GetServiceLastAccessedDetailsWithEntitiesResponse$Error": "

An object that contains details about the reason the operation failed.

" - } - }, - "EvalDecisionDetailsType": { - "base": null, - "refs": { - "EvaluationResult$EvalDecisionDetails": "

Additional details about the results of the cross-account evaluation decision. This parameter is populated for only cross-account simulations. It contains a brief summary of how each policy type contributes to the final evaluation decision.

In the top-level result, this map reports the most restrictive decision per policy type across all requested resources.

If the simulation evaluates policies within the same account and includes a resource ARN, then the parameter is present but the response is empty. If the simulation evaluates policies within the same account and specifies all resources (*), then the parameter is not returned.

When you make a cross-account request, Amazon Web Services evaluates the request in the trusting account and the trusted account. The request is allowed only if both evaluations return true. For more information about how policies are evaluated, see Evaluating policies within a single account.

If an Organizations SCP included in the evaluation denies access, the simulation ends. In this case, policy evaluation does not proceed any further and this parameter is not returned.

", - "ResourceSpecificResult$EvalDecisionDetails": "

Additional details about the results of the evaluation decision on a single resource. This parameter is returned only for cross-account simulations. This parameter explains how each policy type contributes to the resource-specific evaluation decision.

" - } - }, - "EvalDecisionSourceType": { - "base": null, - "refs": { - "EvalDecisionDetailsType$key": null - } - }, - "EvaluationResult": { - "base": "

Contains the results of a simulation.

This data type is used by the return parameter of SimulateCustomPolicy and SimulatePrincipalPolicy .

The simulator now returns a single EvaluationResult per action, regardless of how many resource ARNs are provided. Previously, simulating one action against N resources returned N evaluation results, each containing the same aggregate decision. The top-level fields (EvalDecision, MatchedStatements, MissingContextValues, EvalDecisionDetails) now represent the aggregate decision across all requested resources. The top-level EvalDecision reflects the most restrictive decision across all resources (for example, if any resource produces explicitDeny, the top-level decision is explicitDeny).

To see the decision for each individual resource, use ResourceSpecificResults. If your application parses evaluation results per resource ARN, update your code to read per-resource decisions from ResourceSpecificResults rather than from the top-level result.

", - "refs": { - "EvaluationResultsListType$member": null - } - }, - "EvaluationResultsListType": { - "base": null, - "refs": { - "SimulatePolicyResponse$EvaluationResults": "

The results of the simulation.

" - } - }, - "FeatureDisabledException": { - "base": "

The request failed because outbound identity federation is already disabled for your Amazon Web Services account. You cannot disable the feature multiple times

", - "refs": {} - }, - "FeatureDisabledMessage": { - "base": null, - "refs": { - "FeatureDisabledException$message": null - } - }, - "FeatureEnabledException": { - "base": "

The request failed because outbound identity federation is already enabled for your Amazon Web Services account. You cannot enable the feature multiple times. To fetch the current configuration (including the unique issuer URL), use the GetOutboundWebIdentityFederationInfo operation.

", - "refs": {} - }, - "FeatureEnabledMessage": { - "base": null, - "refs": { - "FeatureEnabledException$message": null - } - }, - "FeatureType": { - "base": null, - "refs": { - "FeaturesListType$member": null - } - }, - "FeaturesListType": { - "base": null, - "refs": { - "DisableOrganizationsRootCredentialsManagementResponse$EnabledFeatures": "

The features enabled for centralized root access for member accounts in your organization.

", - "DisableOrganizationsRootSessionsResponse$EnabledFeatures": "

The features you have enabled for centralized root access of member accounts in your organization.

", - "EnableOrganizationsRootCredentialsManagementResponse$EnabledFeatures": "

The features you have enabled for centralized root access.

", - "EnableOrganizationsRootSessionsResponse$EnabledFeatures": "

The features you have enabled for centralized root access.

", - "ListOrganizationsFeaturesResponse$EnabledFeatures": "

Specifies the features that are currently available in your organization.

" - } - }, - "GenerateCredentialReportResponse": { - "base": "

Contains the response to a successful GenerateCredentialReport request.

", - "refs": {} - }, - "GenerateOrganizationsAccessReportRequest": { - "base": null, - "refs": {} - }, - "GenerateOrganizationsAccessReportResponse": { - "base": null, - "refs": {} - }, - "GenerateServiceLastAccessedDetailsRequest": { - "base": null, - "refs": {} - }, - "GenerateServiceLastAccessedDetailsResponse": { - "base": null, - "refs": {} - }, - "GetAccessKeyLastUsedRequest": { - "base": null, - "refs": {} - }, - "GetAccessKeyLastUsedResponse": { - "base": "

Contains the response to a successful GetAccessKeyLastUsed request. It is also returned as a member of the AccessKeyMetaData structure returned by the ListAccessKeys action.

", - "refs": {} - }, - "GetAccountAuthorizationDetailsRequest": { - "base": null, - "refs": {} - }, - "GetAccountAuthorizationDetailsResponse": { - "base": "

Contains the response to a successful GetAccountAuthorizationDetails request.

", - "refs": {} - }, - "GetAccountPasswordPolicyResponse": { - "base": "

Contains the response to a successful GetAccountPasswordPolicy request.

", - "refs": {} - }, - "GetAccountSummaryResponse": { - "base": "

Contains the response to a successful GetAccountSummary request.

", - "refs": {} - }, - "GetContextKeysForCustomPolicyRequest": { - "base": null, - "refs": {} - }, - "GetContextKeysForPolicyResponse": { - "base": "

Contains the response to a successful GetContextKeysForPrincipalPolicy or GetContextKeysForCustomPolicy request.

", - "refs": {} - }, - "GetContextKeysForPrincipalPolicyRequest": { - "base": null, - "refs": {} - }, - "GetCredentialReportResponse": { - "base": "

Contains the response to a successful GetCredentialReport request.

", - "refs": {} - }, - "GetDelegationRequestRequest": { - "base": null, - "refs": {} - }, - "GetDelegationRequestResponse": { - "base": null, - "refs": {} - }, - "GetGroupPolicyRequest": { - "base": null, - "refs": {} - }, - "GetGroupPolicyResponse": { - "base": "

Contains the response to a successful GetGroupPolicy request.

", - "refs": {} - }, - "GetGroupRequest": { - "base": null, - "refs": {} - }, - "GetGroupResponse": { - "base": "

Contains the response to a successful GetGroup request.

", - "refs": {} - }, - "GetHumanReadableSummaryRequest": { - "base": null, - "refs": {} - }, - "GetHumanReadableSummaryResponse": { - "base": null, - "refs": {} - }, - "GetInstanceProfileRequest": { - "base": null, - "refs": {} - }, - "GetInstanceProfileResponse": { - "base": "

Contains the response to a successful GetInstanceProfile request.

", - "refs": {} - }, - "GetLoginProfileRequest": { - "base": null, - "refs": {} - }, - "GetLoginProfileResponse": { - "base": "

Contains the response to a successful GetLoginProfile request.

", - "refs": {} - }, - "GetMFADeviceRequest": { - "base": null, - "refs": {} - }, - "GetMFADeviceResponse": { - "base": null, - "refs": {} - }, - "GetOpenIDConnectProviderRequest": { - "base": null, - "refs": {} - }, - "GetOpenIDConnectProviderResponse": { - "base": "

Contains the response to a successful GetOpenIDConnectProvider request.

", - "refs": {} - }, - "GetOrganizationsAccessReportRequest": { - "base": null, - "refs": {} - }, - "GetOrganizationsAccessReportResponse": { - "base": null, - "refs": {} - }, - "GetOutboundWebIdentityFederationInfoResponse": { - "base": null, - "refs": {} - }, - "GetPolicyRequest": { - "base": null, - "refs": {} - }, - "GetPolicyResponse": { - "base": "

Contains the response to a successful GetPolicy request.

", - "refs": {} - }, - "GetPolicyVersionRequest": { - "base": null, - "refs": {} - }, - "GetPolicyVersionResponse": { - "base": "

Contains the response to a successful GetPolicyVersion request.

", - "refs": {} - }, - "GetRolePolicyRequest": { - "base": null, - "refs": {} - }, - "GetRolePolicyResponse": { - "base": "

Contains the response to a successful GetRolePolicy request.

", - "refs": {} - }, - "GetRoleRequest": { - "base": null, - "refs": {} - }, - "GetRoleResponse": { - "base": "

Contains the response to a successful GetRole request.

", - "refs": {} - }, - "GetSAMLProviderRequest": { - "base": null, - "refs": {} - }, - "GetSAMLProviderResponse": { - "base": "

Contains the response to a successful GetSAMLProvider request.

", - "refs": {} - }, - "GetSSHPublicKeyRequest": { - "base": null, - "refs": {} - }, - "GetSSHPublicKeyResponse": { - "base": "

Contains the response to a successful GetSSHPublicKey request.

", - "refs": {} - }, - "GetServerCertificateRequest": { - "base": null, - "refs": {} - }, - "GetServerCertificateResponse": { - "base": "

Contains the response to a successful GetServerCertificate request.

", - "refs": {} - }, - "GetServiceLastAccessedDetailsRequest": { - "base": null, - "refs": {} - }, - "GetServiceLastAccessedDetailsResponse": { - "base": null, - "refs": {} - }, - "GetServiceLastAccessedDetailsWithEntitiesRequest": { - "base": null, - "refs": {} - }, - "GetServiceLastAccessedDetailsWithEntitiesResponse": { - "base": null, - "refs": {} - }, - "GetServiceLinkedRoleDeletionStatusRequest": { - "base": null, - "refs": {} - }, - "GetServiceLinkedRoleDeletionStatusResponse": { - "base": null, - "refs": {} - }, - "GetUserPolicyRequest": { - "base": null, - "refs": {} - }, - "GetUserPolicyResponse": { - "base": "

Contains the response to a successful GetUserPolicy request.

", - "refs": {} - }, - "GetUserRequest": { - "base": null, - "refs": {} - }, - "GetUserResponse": { - "base": "

Contains the response to a successful GetUser request.

", - "refs": {} - }, - "Group": { - "base": "

Contains information about an IAM group entity.

This data type is used as a response element in the following operations:

", - "refs": { - "CreateGroupResponse$Group": "

A structure containing details about the new group.

", - "GetGroupResponse$Group": "

A structure that contains details about the group.

", - "groupListType$member": null - } - }, - "GroupDetail": { - "base": "

Contains information about an IAM group, including all of the group's policies.

This data type is used as a response element in the GetAccountAuthorizationDetails operation.

", - "refs": { - "groupDetailListType$member": null - } - }, - "InlinePolicyIdentifierType": { - "base": "

Identifies one or more inline policies that are embedded in IAM users, groups, or roles, by the name of the policy together with the type and name of the entity that it is attached to. Wildcard characters in the entity name can match multiple entities, so a single identifier can select more than one attached inline policy.

", - "refs": { - "PolicyIdentifier$InlinePolicyIdentifier": "

An inline policy identifier consisting of a policy name and the entity it is attached to. Wildcard characters (* and ?) in the entity name can match multiple entities.

" - } - }, - "InstanceProfile": { - "base": "

Contains information about an instance profile.

This data type is used as a response element in the following operations:

", - "refs": { - "CreateInstanceProfileResponse$InstanceProfile": "

A structure containing details about the new instance profile.

", - "GetInstanceProfileResponse$InstanceProfile": "

A structure containing details about the instance profile.

", - "instanceProfileListType$member": null - } - }, - "InvalidAuthenticationCodeException": { - "base": "

The request was rejected because the authentication code was not recognized. The error message describes the specific error.

", - "refs": {} - }, - "InvalidCertificateException": { - "base": "

The request was rejected because the certificate is invalid.

", - "refs": {} - }, - "InvalidInputException": { - "base": "

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

", - "refs": {} - }, - "InvalidPublicKeyException": { - "base": "

The request was rejected because the public key is malformed or otherwise invalid.

", - "refs": {} - }, - "InvalidUserTypeException": { - "base": "

The request was rejected because the type of user for the transaction was incorrect.

", - "refs": {} - }, - "KeyPairMismatchException": { - "base": "

The request was rejected because the public key certificate and the private key do not match.

", - "refs": {} - }, - "LimitExceededException": { - "base": "

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.

", - "refs": {} - }, - "LineNumber": { - "base": null, - "refs": { - "Position$Line": "

The line containing the specified position in the document.

" - } - }, - "ListAccessKeysRequest": { - "base": null, - "refs": {} - }, - "ListAccessKeysResponse": { - "base": "

Contains the response to a successful ListAccessKeys request.

", - "refs": {} - }, - "ListAccountAliasesRequest": { - "base": null, - "refs": {} - }, - "ListAccountAliasesResponse": { - "base": "

Contains the response to a successful ListAccountAliases request.

", - "refs": {} - }, - "ListAttachedGroupPoliciesRequest": { - "base": null, - "refs": {} - }, - "ListAttachedGroupPoliciesResponse": { - "base": "

Contains the response to a successful ListAttachedGroupPolicies request.

", - "refs": {} - }, - "ListAttachedRolePoliciesRequest": { - "base": null, - "refs": {} - }, - "ListAttachedRolePoliciesResponse": { - "base": "

Contains the response to a successful ListAttachedRolePolicies request.

", - "refs": {} - }, - "ListAttachedUserPoliciesRequest": { - "base": null, - "refs": {} - }, - "ListAttachedUserPoliciesResponse": { - "base": "

Contains the response to a successful ListAttachedUserPolicies request.

", - "refs": {} - }, - "ListDelegationRequestsRequest": { - "base": null, - "refs": {} - }, - "ListDelegationRequestsResponse": { - "base": null, - "refs": {} - }, - "ListEntitiesForPolicyRequest": { - "base": null, - "refs": {} - }, - "ListEntitiesForPolicyResponse": { - "base": "

Contains the response to a successful ListEntitiesForPolicy request.

", - "refs": {} - }, - "ListGroupPoliciesRequest": { - "base": null, - "refs": {} - }, - "ListGroupPoliciesResponse": { - "base": "

Contains the response to a successful ListGroupPolicies request.

", - "refs": {} - }, - "ListGroupsForUserRequest": { - "base": null, - "refs": {} - }, - "ListGroupsForUserResponse": { - "base": "

Contains the response to a successful ListGroupsForUser request.

", - "refs": {} - }, - "ListGroupsRequest": { - "base": null, - "refs": {} - }, - "ListGroupsResponse": { - "base": "

Contains the response to a successful ListGroups request.

", - "refs": {} - }, - "ListInstanceProfileTagsRequest": { - "base": null, - "refs": {} - }, - "ListInstanceProfileTagsResponse": { - "base": null, - "refs": {} - }, - "ListInstanceProfilesForRoleRequest": { - "base": null, - "refs": {} - }, - "ListInstanceProfilesForRoleResponse": { - "base": "

Contains the response to a successful ListInstanceProfilesForRole request.

", - "refs": {} - }, - "ListInstanceProfilesRequest": { - "base": null, - "refs": {} - }, - "ListInstanceProfilesResponse": { - "base": "

Contains the response to a successful ListInstanceProfiles request.

", - "refs": {} - }, - "ListMFADeviceTagsRequest": { - "base": null, - "refs": {} - }, - "ListMFADeviceTagsResponse": { - "base": null, - "refs": {} - }, - "ListMFADevicesRequest": { - "base": null, - "refs": {} - }, - "ListMFADevicesResponse": { - "base": "

Contains the response to a successful ListMFADevices request.

", - "refs": {} - }, - "ListOpenIDConnectProviderTagsRequest": { - "base": null, - "refs": {} - }, - "ListOpenIDConnectProviderTagsResponse": { - "base": null, - "refs": {} - }, - "ListOpenIDConnectProvidersRequest": { - "base": null, - "refs": {} - }, - "ListOpenIDConnectProvidersResponse": { - "base": "

Contains the response to a successful ListOpenIDConnectProviders request.

", - "refs": {} - }, - "ListOrganizationsFeaturesRequest": { - "base": null, - "refs": {} - }, - "ListOrganizationsFeaturesResponse": { - "base": null, - "refs": {} - }, - "ListPoliciesGrantingServiceAccessEntry": { - "base": "

Contains details about the permissions policies that are attached to the specified identity (user, group, or role).

This data type is used as a response element in the ListPoliciesGrantingServiceAccess operation.

", - "refs": { - "listPolicyGrantingServiceAccessResponseListType$member": null - } - }, - "ListPoliciesGrantingServiceAccessRequest": { - "base": null, - "refs": {} - }, - "ListPoliciesGrantingServiceAccessResponse": { - "base": null, - "refs": {} - }, - "ListPoliciesRequest": { - "base": null, - "refs": {} - }, - "ListPoliciesResponse": { - "base": "

Contains the response to a successful ListPolicies request.

", - "refs": {} - }, - "ListPolicyTagsRequest": { - "base": null, - "refs": {} - }, - "ListPolicyTagsResponse": { - "base": null, - "refs": {} - }, - "ListPolicyVersionsRequest": { - "base": null, - "refs": {} - }, - "ListPolicyVersionsResponse": { - "base": "

Contains the response to a successful ListPolicyVersions request.

", - "refs": {} - }, - "ListRolePoliciesRequest": { - "base": null, - "refs": {} - }, - "ListRolePoliciesResponse": { - "base": "

Contains the response to a successful ListRolePolicies request.

", - "refs": {} - }, - "ListRoleTagsRequest": { - "base": null, - "refs": {} - }, - "ListRoleTagsResponse": { - "base": null, - "refs": {} - }, - "ListRolesRequest": { - "base": null, - "refs": {} - }, - "ListRolesResponse": { - "base": "

Contains the response to a successful ListRoles request.

", - "refs": {} - }, - "ListSAMLProviderTagsRequest": { - "base": null, - "refs": {} - }, - "ListSAMLProviderTagsResponse": { - "base": null, - "refs": {} - }, - "ListSAMLProvidersRequest": { - "base": null, - "refs": {} - }, - "ListSAMLProvidersResponse": { - "base": "

Contains the response to a successful ListSAMLProviders request.

", - "refs": {} - }, - "ListSSHPublicKeysRequest": { - "base": null, - "refs": {} - }, - "ListSSHPublicKeysResponse": { - "base": "

Contains the response to a successful ListSSHPublicKeys request.

", - "refs": {} - }, - "ListServerCertificateTagsRequest": { - "base": null, - "refs": {} - }, - "ListServerCertificateTagsResponse": { - "base": null, - "refs": {} - }, - "ListServerCertificatesRequest": { - "base": null, - "refs": {} - }, - "ListServerCertificatesResponse": { - "base": "

Contains the response to a successful ListServerCertificates request.

", - "refs": {} - }, - "ListServiceSpecificCredentialsRequest": { - "base": null, - "refs": {} - }, - "ListServiceSpecificCredentialsResponse": { - "base": null, - "refs": {} - }, - "ListSigningCertificatesRequest": { - "base": null, - "refs": {} - }, - "ListSigningCertificatesResponse": { - "base": "

Contains the response to a successful ListSigningCertificates request.

", - "refs": {} - }, - "ListUserPoliciesRequest": { - "base": null, - "refs": {} - }, - "ListUserPoliciesResponse": { - "base": "

Contains the response to a successful ListUserPolicies request.

", - "refs": {} - }, - "ListUserTagsRequest": { - "base": null, - "refs": {} - }, - "ListUserTagsResponse": { - "base": null, - "refs": {} - }, - "ListUsersRequest": { - "base": null, - "refs": {} - }, - "ListUsersResponse": { - "base": "

Contains the response to a successful ListUsers request.

", - "refs": {} - }, - "ListVirtualMFADevicesRequest": { - "base": null, - "refs": {} - }, - "ListVirtualMFADevicesResponse": { - "base": "

Contains the response to a successful ListVirtualMFADevices request.

", - "refs": {} - }, - "LoginProfile": { - "base": "

Contains the user name and password create date for a user.

This data type is used as a response element in the CreateLoginProfile and GetLoginProfile operations.

", - "refs": { - "CreateLoginProfileResponse$LoginProfile": "

A structure containing the user name and password create date.

", - "GetLoginProfileResponse$LoginProfile": "

A structure containing the user name and the profile creation date for the user.

" - } - }, - "MFADevice": { - "base": "

Contains information about an MFA device.

This data type is used as a response element in the ListMFADevices operation.

", - "refs": { - "mfaDeviceListType$member": null - } - }, - "MalformedCertificateException": { - "base": "

The request was rejected because the certificate was malformed or expired. The error message describes the specific error.

", - "refs": {} - }, - "MalformedPolicyDocumentException": { - "base": "

The request was rejected because the policy document was malformed. The error message describes the specific error.

", - "refs": {} - }, - "ManagedPolicyDetail": { - "base": "

Contains information about a managed policy, including the policy's ARN, versions, and the number of principal entities (users, groups, and roles) that the policy is attached to.

This data type is used as a response element in the GetAccountAuthorizationDetails operation.

For more information about managed policies, see Managed policies and inline policies in the IAM User Guide.

", - "refs": { - "ManagedPolicyDetailListType$member": null - } - }, - "ManagedPolicyDetailListType": { - "base": null, - "refs": { - "GetAccountAuthorizationDetailsResponse$Policies": "

A list containing information about managed policies.

" - } - }, - "NoSuchEntityException": { - "base": "

The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.

", - "refs": {} - }, - "OpenIDConnectProviderListEntry": { - "base": "

Contains the Amazon Resource Name (ARN) for an IAM OpenID Connect provider.

", - "refs": { - "OpenIDConnectProviderListType$member": null - } - }, - "OpenIDConnectProviderListType": { - "base": "

Contains a list of IAM OpenID Connect providers.

", - "refs": { - "ListOpenIDConnectProvidersResponse$OpenIDConnectProviderList": "

The list of IAM OIDC provider resource objects defined in the Amazon Web Services account.

" - } - }, - "OpenIDConnectProviderUrlType": { - "base": "

Contains a URL that specifies the endpoint for an OpenID Connect provider.

", - "refs": { - "CreateOpenIDConnectProviderRequest$Url": "

The URL of the identity provider. The URL must begin with https:// and should correspond to the iss claim in the provider's OpenID Connect ID tokens. Per the OIDC standard, path components are allowed but query parameters are not. Typically the URL consists of only a hostname, like https://server.example.org or https://example.com. The URL should not contain a port number.

You cannot register the same provider multiple times in a single Amazon Web Services account. If you try to submit a URL that has already been used for an OpenID Connect provider in the Amazon Web Services account, you will get an error.

", - "GetOpenIDConnectProviderResponse$Url": "

The URL that the IAM OIDC provider resource object is associated with. For more information, see CreateOpenIDConnectProvider.

" - } - }, - "OpenIdIdpCommunicationErrorException": { - "base": "

The request failed because IAM cannot connect to the OpenID Connect identity provider URL.

", - "refs": {} - }, - "OrderedOrganizationPolicyType": { - "base": "

Represents one level of an Organizations hierarchy—the organization root, an organizational unit (OU), or an account—together with the service control policies (SCPs) that apply at that level. Each element in the list represents one level of the hierarchy, ordered from the organization root down to the account.

For more information about SCPs, see Service control policies (SCPs) in the Organizations User Guide.

", - "refs": { - "OrganizationPolicyListType$member": null - } - }, - "OrganizationIdType": { - "base": null, - "refs": { - "DisableOrganizationsRootCredentialsManagementResponse$OrganizationId": "

The unique identifier (ID) of an organization.

", - "DisableOrganizationsRootSessionsResponse$OrganizationId": "

The unique identifier (ID) of an organization.

", - "EnableOrganizationsRootCredentialsManagementResponse$OrganizationId": "

The unique identifier (ID) of an organization.

", - "EnableOrganizationsRootSessionsResponse$OrganizationId": "

The unique identifier (ID) of an organization.

", - "ListOrganizationsFeaturesResponse$OrganizationId": "

The unique identifier (ID) of an organization.

" - } - }, - "OrganizationNotFoundException": { - "base": "

The request was rejected because no organization is associated with your account.

", - "refs": {} - }, - "OrganizationNotInAllFeaturesModeException": { - "base": "

The request was rejected because your organization does not have All features enabled. For more information, see Available feature sets in the Organizations User Guide.

", - "refs": {} - }, - "OrganizationPolicyListType": { - "base": null, - "refs": { - "SimulateCustomPolicyRequest$OrderedOrganizationPolicyInputList": "

An ordered list of service control policies (SCPs) to include in the simulation. Each element represents one level of an Organizations hierarchy, from the organization root to the account.

The simulator evaluates SCPs in the order that you provide, consistent with how Organizations enforces SCPs. The first element must represent the organization root, and the last element must represent the account. Any elements between them represent organizational units (OUs) in descending order.

Use this parameter to simulate the effect of an SCP hierarchy without calling SimulatePrincipalPolicy.

" - } - }, - "OrganizationsDecisionDetail": { - "base": "

Contains information about the effect that Organizations has on a policy simulation.

", - "refs": { - "EvaluationResult$OrganizationsDecisionDetail": "

A structure that details how Organizations and its service control policies affect the results of the simulation. Only applies if the simulated user's account is part of an organization.

For resources that don't support organization-level evaluation, this field is omitted from the top-level result. For per-resource details, see ResourceSpecificResults.

" - } - }, - "PasswordPolicy": { - "base": "

Contains information about the account password policy.

This data type is used as a response element in the GetAccountPasswordPolicy operation.

", - "refs": { - "GetAccountPasswordPolicyResponse$PasswordPolicy": "

A structure that contains details about the account's password policy.

" - } - }, - "PasswordPolicyViolationException": { - "base": "

The request was rejected because the provided password did not meet the requirements imposed by the account password policy.

", - "refs": {} - }, - "PermissionsBoundaryAttachmentType": { - "base": null, - "refs": { - "AttachedPermissionsBoundary$PermissionsBoundaryType": "

The permissions boundary usage type that indicates what type of IAM resource is used as the permissions boundary for an entity. This data type can only have a value of Policy.

" - } - }, - "PermissionsBoundaryDecisionDetail": { - "base": "

Contains information about the effect that a permissions boundary has on a policy simulation when the boundary is applied to an IAM entity.

", - "refs": { - "EvaluationResult$PermissionsBoundaryDecisionDetail": "

Contains information about the effect that a permissions boundary has on a policy simulation when the boundary is applied to an IAM entity.

", - "ResourceSpecificResult$PermissionsBoundaryDecisionDetail": "

Contains information about the effect that a permissions boundary has on a policy simulation when that boundary is applied to an IAM entity.

" - } - }, - "Policy": { - "base": "

Contains information about a managed policy.

This data type is used as a response element in the CreatePolicy, GetPolicy, and ListPolicies operations.

For more information about managed policies, refer to Managed policies and inline policies in the IAM User Guide.

", - "refs": { - "CreatePolicyResponse$Policy": "

A structure containing details about the new policy.

", - "GetPolicyResponse$Policy": "

A structure containing details about the policy.

", - "policyListType$member": null - } - }, - "PolicyDetail": { - "base": "

Contains information about an IAM policy, including the policy document.

This data type is used as a response element in the GetAccountAuthorizationDetails operation.

", - "refs": { - "policyDetailListType$member": null - } - }, - "PolicyEvaluationDecisionType": { - "base": null, - "refs": { - "EvalDecisionDetailsType$value": null, - "EvaluationResult$EvalDecision": "

The result of the simulation.

", - "ResourceSpecificResult$EvalResourceDecision": "

The result of the simulation of the simulated API operation on the resource specified in EvalResourceName.

" - } - }, - "PolicyEvaluationException": { - "base": "

The request failed because a provided policy could not be successfully evaluated. An additional detailed message indicates the source of the failure.

", - "refs": {} - }, - "PolicyExclusionsListType": { - "base": null, - "refs": { - "SimulatePrincipalPolicyRequest$PolicyExclusionList": "

A list of policies to exclude from the simulation. Use this parameter to test what the simulation result would be if a policy were removed, without changing which policies are actually attached to the principal identified by PolicySourceArn.

Each entry is a PolicyIdentifier that identifies one or more policies to exclude by policy type, by Amazon Resource Name (ARN), or by the name of an inline policy and the entity it is attached to.

Syntactically invalid identifiers, such as malformed ARNs or wildcards in disallowed positions, cause the request to fail with an InvalidInput error. Syntactically valid identifiers that don't match any attached policy are ignored. Resource control policies (RCPs) are not supported in this release; identifiers that target RCPs are also ignored.

" - } - }, - "PolicyGrantingServiceAccess": { - "base": "

Contains details about the permissions policies that are attached to the specified identity (user, group, or role).

This data type is an element of the ListPoliciesGrantingServiceAccessEntry object.

", - "refs": { - "policyGrantingServiceAccessListType$member": null - } - }, - "PolicyGroup": { - "base": "

Contains information about a group that a managed policy is attached to.

This data type is used as a response element in the ListEntitiesForPolicy operation.

For more information about managed policies, refer to Managed policies and inline policies in the IAM User Guide.

", - "refs": { - "PolicyGroupListType$member": null - } - }, - "PolicyGroupListType": { - "base": null, - "refs": { - "ListEntitiesForPolicyResponse$PolicyGroups": "

A list of IAM groups that the policy is attached to.

" - } - }, - "PolicyIdentifier": { - "base": "

Identifies one or more policies as a union type. Specify exactly one of PolicyType, PolicyArn, or InlinePolicyIdentifier to identify policies by their type, by Amazon Resource Name (ARN), or by the name of an inline policy and the entity it is attached to.

", - "refs": { - "PolicyExclusionsListType$member": null - } - }, - "PolicyIdentifierPolicyType": { - "base": null, - "refs": { - "PolicyIdentifier$PolicyType": "

The policy type to identify. All policies of the specified type are matched.

" - } - }, - "PolicyIdentifierType": { - "base": null, - "refs": { - "Statement$SourcePolicyId": "

The identifier of the policy that was provided as an input.

" - } - }, - "PolicyNotAttachableException": { - "base": "

The request failed because Amazon Web Services service role policies can only be attached to the service-linked role for that service.

", - "refs": {} - }, - "PolicyParameter": { - "base": "

Contains information about a policy parameter used to customize delegated permissions.

", - "refs": { - "policyParameterListType$member": null - } - }, - "PolicyParameterTypeEnum": { - "base": null, - "refs": { - "PolicyParameter$Type": "

The data type of the policy parameter value.

" - } - }, - "PolicyRole": { - "base": "

Contains information about a role that a managed policy is attached to.

This data type is used as a response element in the ListEntitiesForPolicy operation.

For more information about managed policies, refer to Managed policies and inline policies in the IAM User Guide.

", - "refs": { - "PolicyRoleListType$member": null - } - }, - "PolicyRoleListType": { - "base": null, - "refs": { - "ListEntitiesForPolicyResponse$PolicyRoles": "

A list of IAM roles that the policy is attached to.

" - } - }, - "PolicySourceType": { - "base": null, - "refs": { - "Statement$SourcePolicyType": "

The type of the policy.

" - } - }, - "PolicyUsageType": { - "base": "

The policy usage type that indicates whether the policy is used as a permissions policy or as the permissions boundary for an entity.

For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.

", - "refs": { - "ListEntitiesForPolicyRequest$PolicyUsageFilter": "

The policy usage method to use for filtering the results.

To list only permissions policies, set PolicyUsageFilter to PermissionsPolicy. To list only the policies used to set permissions boundaries, set the value to PermissionsBoundary.

This parameter is optional. If it is not included, all policies are returned.

", - "ListPoliciesRequest$PolicyUsageFilter": "

The policy usage method to use for filtering the results.

To list only permissions policies, set PolicyUsageFilter to PermissionsPolicy. To list only the policies used to set permissions boundaries, set the value to PermissionsBoundary.

This parameter is optional. If it is not included, all policies are returned.

" - } - }, - "PolicyUser": { - "base": "

Contains information about a user that a managed policy is attached to.

This data type is used as a response element in the ListEntitiesForPolicy operation.

For more information about managed policies, refer to Managed policies and inline policies in the IAM User Guide.

", - "refs": { - "PolicyUserListType$member": null - } - }, - "PolicyUserListType": { - "base": null, - "refs": { - "ListEntitiesForPolicyResponse$PolicyUsers": "

A list of IAM users that the policy is attached to.

" - } - }, - "PolicyVersion": { - "base": "

Contains information about a version of a managed policy.

This data type is used as a response element in the CreatePolicyVersion, GetPolicyVersion, ListPolicyVersions, and GetAccountAuthorizationDetails operations.

For more information about managed policies, refer to Managed policies and inline policies in the IAM User Guide.

", - "refs": { - "CreatePolicyVersionResponse$PolicyVersion": "

A structure containing details about the new policy version.

", - "GetPolicyVersionResponse$PolicyVersion": "

A structure containing details about the policy version.

", - "policyDocumentVersionListType$member": null - } - }, - "Position": { - "base": "

Contains the row and column of a location of a Statement element in a policy document.

This data type is used as a member of the Statement type.

", - "refs": { - "Statement$StartPosition": "

The row and column of the beginning of the Statement in an IAM policy.

", - "Statement$EndPosition": "

The row and column of the end of a Statement in an IAM policy.

" - } - }, - "PutGroupPolicyRequest": { - "base": null, - "refs": {} - }, - "PutRolePermissionsBoundaryRequest": { - "base": null, - "refs": {} - }, - "PutRolePolicyRequest": { - "base": null, - "refs": {} - }, - "PutUserPermissionsBoundaryRequest": { - "base": null, - "refs": {} - }, - "PutUserPolicyRequest": { - "base": null, - "refs": {} - }, - "ReasonType": { - "base": null, - "refs": { - "DeletionTaskFailureReasonType$Reason": "

A short description of the reason that the service-linked role deletion failed.

" - } - }, - "RegionNameType": { - "base": null, - "refs": { - "RoleUsageType$Region": "

The name of the Region where the service-linked role is being used.

" - } - }, - "RejectDelegationRequestRequest": { - "base": null, - "refs": {} - }, - "RemoveClientIDFromOpenIDConnectProviderRequest": { - "base": null, - "refs": {} - }, - "RemoveRoleFromInstanceProfileRequest": { - "base": null, - "refs": {} - }, - "RemoveUserFromGroupRequest": { - "base": null, - "refs": {} - }, - "ReportContentType": { - "base": null, - "refs": { - "GetCredentialReportResponse$Content": "

Contains the credential report. The report is Base64-encoded.

" - } - }, - "ReportFormatType": { - "base": null, - "refs": { - "GetCredentialReportResponse$ReportFormat": "

The format (MIME type) of the credential report.

" - } - }, - "ReportGenerationLimitExceededException": { - "base": "

The request failed because the maximum number of concurrent requests for this account are already running.

", - "refs": {} - }, - "ReportStateDescriptionType": { - "base": null, - "refs": { - "GenerateCredentialReportResponse$Description": "

Information about the credential report.

" - } - }, - "ReportStateType": { - "base": null, - "refs": { - "GenerateCredentialReportResponse$State": "

Information about the state of the credential report.

" - } - }, - "ResetServiceSpecificCredentialRequest": { - "base": null, - "refs": {} - }, - "ResetServiceSpecificCredentialResponse": { - "base": null, - "refs": {} - }, - "ResourceHandlingOptionType": { - "base": null, - "refs": { - "SimulateCustomPolicyRequest$ResourceHandlingOption": "

Specifies the type of simulation to run. Different API operations that support resource-based policies require different combinations of resources. By specifying the type of simulation to run, you enable the policy simulator to enforce the presence of the required resources to ensure reliable simulation results. If your simulation does not match one of the following scenarios, then you can omit this parameter. The following list shows each of the supported scenario values and the resources that you must define to run the simulation.

Each of the Amazon EC2 scenarios requires that you specify instance, image, and security group resources. If your scenario includes an EBS volume, then you must specify that volume as a resource. If the Amazon EC2 scenario includes VPC, then you must supply the network interface resource. If it includes an IP subnet, then you must specify the subnet resource. For more information on the Amazon EC2 scenario options, see Supported platforms in the Amazon EC2 User Guide.

  • EC2-VPC-InstanceStore

    instance, image, security group, network interface

  • EC2-VPC-InstanceStore-Subnet

    instance, image, security group, network interface, subnet

  • EC2-VPC-EBS

    instance, image, security group, network interface, volume

  • EC2-VPC-EBS-Subnet

    instance, image, security group, network interface, subnet, volume

", - "SimulatePrincipalPolicyRequest$ResourceHandlingOption": "

Specifies the type of simulation to run. Different API operations that support resource-based policies require different combinations of resources. By specifying the type of simulation to run, you enable the policy simulator to enforce the presence of the required resources to ensure reliable simulation results. If your simulation does not match one of the following scenarios, then you can omit this parameter. The following list shows each of the supported scenario values and the resources that you must define to run the simulation.

Each of the Amazon EC2 scenarios requires that you specify instance, image, and security group resources. If your scenario includes an EBS volume, then you must specify that volume as a resource. If the Amazon EC2 scenario includes VPC, then you must supply the network interface resource. If it includes an IP subnet, then you must specify the subnet resource. For more information on the Amazon EC2 scenario options, see Supported platforms in the Amazon EC2 User Guide.

  • EC2-VPC-InstanceStore

    instance, image, security group, network interface

  • EC2-VPC-InstanceStore-Subnet

    instance, image, security group, network interface, subnet

  • EC2-VPC-EBS

    instance, image, security group, network interface, volume

  • EC2-VPC-EBS-Subnet

    instance, image, security group, network interface, subnet, volume

" - } - }, - "ResourceNameListType": { - "base": null, - "refs": { - "SimulateCustomPolicyRequest$ResourceArns": "

A list of ARNs of Amazon Web Services resources to include in the simulation. If this parameter is not provided, then the value defaults to * (all resources). Each API in the ActionNames parameter is evaluated for each resource in this list. The simulation determines the access result (allowed or denied) of each combination and reports it in the response. You can simulate resources that don't exist in your account.

The simulation does not automatically retrieve policies for the specified resources. If you want to include a resource policy in the simulation, then you must include the policy as a string in the ResourcePolicy parameter.

If you include a ResourcePolicy, then it must be applicable to all of the resources included in the simulation or you receive an invalid input error.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

Simulation of resource-based policies isn't supported for IAM roles.

", - "SimulatePrincipalPolicyRequest$ResourceArns": "

A list of ARNs of Amazon Web Services resources to include in the simulation. If this parameter is not provided, then the value defaults to * (all resources). Each API in the ActionNames parameter is evaluated for each resource in this list. The simulation determines the access result (allowed or denied) of each combination and reports it in the response. You can simulate resources that don't exist in your account.

The simulation does not automatically retrieve policies for the specified resources. If you want to include a resource policy in the simulation, then you must include the policy as a string in the ResourcePolicy parameter.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

Simulation of resource-based policies isn't supported for IAM roles.

" - } - }, - "ResourceNameType": { - "base": null, - "refs": { - "EvaluationResult$EvalResourceName": "

The ARN template for the simulated resource type (for example, arn:${Partition}:s3:::${BucketName}/${KeyName}), or * if no ARN format is defined for the action. This is not a specific customer-provided resource ARN. To find the decision for a specific resource, use ResourceSpecificResults.

If you previously relied on EvalResourceName to identify which specific resource a result applies to, you must now use the EvalResourceName field within individual entries in ResourceSpecificResults instead.

", - "ResourceNameListType$member": null, - "ResourceSpecificResult$EvalResourceName": "

The name of the simulated resource, in Amazon Resource Name (ARN) format.

", - "SimulateCustomPolicyRequest$ResourceOwner": "

An ARN representing the Amazon Web Services account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN. Examples of resource ARNs include an S3 bucket or object. If ResourceOwner is specified, it is also used as the account owner of any ResourcePolicy included in the simulation. If the ResourceOwner parameter is not specified, then the owner of the resources and the resource policy defaults to the account of the identity provided in CallerArn. This parameter is required only if you specify a resource-based policy and account that owns the resource is different from the account that owns the simulated calling user CallerArn.

The ARN for an account uses the following syntax: arn:aws:iam::AWS-account-ID:root. For example, to represent the account with the 112233445566 ID, use the following ARN: arn:aws:iam::112233445566-ID:root.

", - "SimulateCustomPolicyRequest$CallerArn": "

The ARN of the IAM user, group, or role that you want to use as the simulated caller of the API operations. CallerArn is required if you include a ResourcePolicy so that the policy's Principal element has a value to use in evaluating the policy.

You cannot specify the ARN of an assumed role, federated user, or a service principal.

", - "SimulatePrincipalPolicyRequest$ResourceOwner": "

An Amazon Web Services account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN. Examples of resource ARNs include an S3 bucket or object. If ResourceOwner is specified, it is also used as the account owner of any ResourcePolicy included in the simulation. If the ResourceOwner parameter is not specified, then the owner of the resources and the resource policy defaults to the account of the identity provided in CallerArn. This parameter is required only if you specify a resource-based policy and account that owns the resource is different from the account that owns the simulated calling user CallerArn.

", - "SimulatePrincipalPolicyRequest$CallerArn": "

The ARN of the IAM user, group, or role that you want to specify as the simulated caller of the API operations. If you do not specify a CallerArn, it defaults to the ARN of the user, group, or role that you specify in PolicySourceArn. If you include both a PolicySourceArn (for example, arn:aws:iam::123456789012:user/David) and a CallerArn (for example, arn:aws:iam::123456789012:user/Bob), the result is that you simulate calling the API operations as Bob, as if Bob had David's policies.

You can specify the ARN of an IAM user, group, or role. You cannot specify the ARN of an assumed role, federated user, or a service principal.

CallerArn is required if you include a ResourcePolicy and the PolicySourceArn is not the ARN for an IAM user, group, or role. This is required so that the resource-based policy's Principal element has a value to use in evaluating the policy.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

" - } - }, - "ResourceSpecificResult": { - "base": "

Contains the result of the simulation of a single API operation call on a single resource.

This data type is used by a member of the EvaluationResult data type.

", - "refs": { - "ResourceSpecificResultListType$member": null - } - }, - "ResourceSpecificResultListType": { - "base": null, - "refs": { - "EvaluationResult$ResourceSpecificResults": "

The individual results of the simulation of the API operation specified in EvalActionName on each resource.

" - } - }, - "ResyncMFADeviceRequest": { - "base": null, - "refs": {} - }, - "Role": { - "base": "

Contains information about an IAM role. This structure is returned as a response element in several API operations that interact with roles.

", - "refs": { - "CreateRoleResponse$Role": "

A structure containing details about the new role.

", - "CreateServiceLinkedRoleResponse$Role": "

A Role object that contains details about the newly created role.

", - "GetRoleResponse$Role": "

A structure containing details about the IAM role.

", - "UpdateRoleDescriptionResponse$Role": "

A structure that contains details about the modified role.

", - "roleListType$member": null - } - }, - "RoleDetail": { - "base": "

Contains information about an IAM role, including all of the role's policies.

This data type is used as a response element in the GetAccountAuthorizationDetails operation.

", - "refs": { - "roleDetailListType$member": null - } - }, - "RoleLastUsed": { - "base": "

Contains information about the last time that an IAM role was used. This includes the date and time and the Region in which the role was last used. Activity is only reported for the trailing 400 days. This period can be shorter if your Region began supporting these features within the last year. The role might have been used more than 400 days ago. For more information, see Regions where data is tracked in the IAM user Guide.

This data type is returned as a response element in the GetRole and GetAccountAuthorizationDetails operations.

", - "refs": { - "Role$RoleLastUsed": "

Contains information about the last time that an IAM role was used. This includes the date and time and the Region in which the role was last used. Activity is only reported for the trailing 400 days. This period can be shorter if your Region began supporting these features within the last year. The role might have been used more than 400 days ago. For more information, see Regions where data is tracked in the IAM user Guide.

", - "RoleDetail$RoleLastUsed": "

Contains information about the last time that an IAM role was used. This includes the date and time and the Region in which the role was last used. Activity is only reported for the trailing 400 days. This period can be shorter if your Region began supporting these features within the last year. The role might have been used more than 400 days ago. For more information, see Regions where data is tracked in the IAM User Guide.

" - } - }, - "RoleUsageListType": { - "base": null, - "refs": { - "DeletionTaskFailureReasonType$RoleUsageList": "

A list of objects that contains details about the service-linked role deletion failure, if that information is returned by the service. If the service-linked role has active sessions or if any resources that were used by the role have not been deleted from the linked service, the role can't be deleted. This parameter includes a list of the resources that are associated with the role and the Region in which the resources are being used.

" - } - }, - "RoleUsageType": { - "base": "

An object that contains details about how a service-linked role is used, if that information is returned by the service.

This data type is used as a response element in the GetServiceLinkedRoleDeletionStatus operation.

", - "refs": { - "RoleUsageListType$member": null - } - }, - "SAMLMetadataDocumentType": { - "base": null, - "refs": { - "CreateSAMLProviderRequest$SAMLMetadataDocument": "

An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.

For more information, see About SAML 2.0-based federation in the IAM User Guide

", - "GetSAMLProviderResponse$SAMLMetadataDocument": "

The XML metadata document that includes information about an identity provider.

", - "UpdateSAMLProviderRequest$SAMLMetadataDocument": "

An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your IdP.

" - } - }, - "SAMLPrivateKey": { - "base": "

Contains the private keys for the SAML provider.

This data type is used as a response element in the GetSAMLProvider operation.

", - "refs": { - "privateKeyList$member": null - } - }, - "SAMLProviderListEntry": { - "base": "

Contains the list of SAML providers for this account.

", - "refs": { - "SAMLProviderListType$member": null - } - }, - "SAMLProviderListType": { - "base": null, - "refs": { - "ListSAMLProvidersResponse$SAMLProviderList": "

The list of SAML provider resource objects defined in IAM for this Amazon Web Services account.

" - } - }, - "SAMLProviderNameType": { - "base": null, - "refs": { - "CreateSAMLProviderRequest$Name": "

The name of the provider to create.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - } - }, - "SSHPublicKey": { - "base": "

Contains information about an SSH public key.

This data type is used as a response element in the GetSSHPublicKey and UploadSSHPublicKey operations.

", - "refs": { - "GetSSHPublicKeyResponse$SSHPublicKey": "

A structure containing details about the SSH public key.

", - "UploadSSHPublicKeyResponse$SSHPublicKey": "

Contains information about the SSH public key.

" - } - }, - "SSHPublicKeyListType": { - "base": null, - "refs": { - "ListSSHPublicKeysResponse$SSHPublicKeys": "

A list of the SSH public keys assigned to IAM user.

" - } - }, - "SSHPublicKeyMetadata": { - "base": "

Contains information about an SSH public key, without the key's body or fingerprint.

This data type is used as a response element in the ListSSHPublicKeys operation.

", - "refs": { - "SSHPublicKeyListType$member": null - } - }, - "SendDelegationTokenRequest": { - "base": null, - "refs": {} - }, - "ServerCertificate": { - "base": "

Contains information about a server certificate.

This data type is used as a response element in the GetServerCertificate operation.

", - "refs": { - "GetServerCertificateResponse$ServerCertificate": "

A structure containing details about the server certificate.

" - } - }, - "ServerCertificateMetadata": { - "base": "

Contains information about a server certificate without its certificate body, certificate chain, and private key.

This data type is used as a response element in the UploadServerCertificate and ListServerCertificates operations.

", - "refs": { - "ServerCertificate$ServerCertificateMetadata": "

The meta information of the server certificate, such as its name, path, ID, and ARN.

", - "UploadServerCertificateResponse$ServerCertificateMetadata": "

The meta information of the uploaded server certificate without its certificate body, certificate chain, and private key.

", - "serverCertificateMetadataListType$member": null - } - }, - "ServiceAccessNotEnabledException": { - "base": "

The request was rejected because trusted access is not enabled for IAM in Organizations. For details, see IAM and Organizations in the Organizations User Guide.

", - "refs": {} - }, - "ServiceFailureException": { - "base": "

The request processing has failed because of an unknown error, exception or failure.

", - "refs": {} - }, - "ServiceLastAccessed": { - "base": "

Contains details about the most recent attempt to access the service.

This data type is used as a response element in the GetServiceLastAccessedDetails operation.

", - "refs": { - "ServicesLastAccessed$member": null - } - }, - "ServiceNotSupportedException": { - "base": "

The specified service does not support service-specific credentials.

", - "refs": {} - }, - "ServiceSpecificCredential": { - "base": "

Contains the details of a service-specific credential.

", - "refs": { - "CreateServiceSpecificCredentialResponse$ServiceSpecificCredential": "

A structure that contains information about the newly created service-specific credential.

This is the only time that the password for this credential set is available. It cannot be recovered later. Instead, you must reset the password with ResetServiceSpecificCredential.

", - "ResetServiceSpecificCredentialResponse$ServiceSpecificCredential": "

A structure with details about the updated service-specific credential, including the new password.

This is the only time that you can access the password. You cannot recover the password later, but you can reset it again.

" - } - }, - "ServiceSpecificCredentialMetadata": { - "base": "

Contains additional details about a service-specific credential.

", - "refs": { - "ServiceSpecificCredentialsListType$member": null - } - }, - "ServiceSpecificCredentialsListType": { - "base": null, - "refs": { - "ListServiceSpecificCredentialsResponse$ServiceSpecificCredentials": "

A list of structures that each contain details about a service-specific credential.

" - } - }, - "ServicesLastAccessed": { - "base": null, - "refs": { - "GetServiceLastAccessedDetailsResponse$ServicesLastAccessed": "

A ServiceLastAccessed object that contains details about the most recent attempt to access the service.

" - } - }, - "SetDefaultPolicyVersionRequest": { - "base": null, - "refs": {} - }, - "SetSecurityTokenServicePreferencesRequest": { - "base": null, - "refs": {} - }, - "SigningCertificate": { - "base": "

Contains information about an X.509 signing certificate.

This data type is used as a response element in the UploadSigningCertificate and ListSigningCertificates operations.

", - "refs": { - "UploadSigningCertificateResponse$Certificate": "

Information about the certificate.

", - "certificateListType$member": null - } - }, - "SimulateCustomPolicyRequest": { - "base": null, - "refs": {} - }, - "SimulatePolicyResponse": { - "base": "

Contains the response to a successful SimulatePrincipalPolicy or SimulateCustomPolicy request.

", - "refs": {} - }, - "SimulatePrincipalPolicyRequest": { - "base": null, - "refs": {} - }, - "SimulationPolicyListType": { - "base": null, - "refs": { - "GetContextKeysForCustomPolicyRequest$PolicyInputList": "

A list of policies for which you want the list of context keys referenced in those policies. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

", - "GetContextKeysForPrincipalPolicyRequest$PolicyInputList": "

An optional list of additional policies for which you want the list of context keys that are referenced.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

", - "OrderedOrganizationPolicyType$ServiceControlPolicyInputList": "

A list of SCP documents that apply at this level of the Organizations hierarchy. Each document is specified as a string containing the complete, valid JSON text of an SCP.

", - "SimulateCustomPolicyRequest$PolicyInputList": "

A list of policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy. Do not include any resource-based policies in this parameter. Any resource-based policy must be submitted with the ResourcePolicy parameter. The policies cannot be \"scope-down\" policies, such as you could include in a call to GetFederationToken or one of the AssumeRole API operations. In other words, do not use policies designed to restrict what a user can do while using the temporary credentials.

The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

", - "SimulateCustomPolicyRequest$PermissionsBoundaryPolicyInputList": "

The IAM permissions boundary policy to simulate. The permissions boundary sets the maximum permissions that an IAM entity can have. You can input only one permissions boundary when you pass a policy to this operation. For more information about permissions boundaries, see Permissions boundaries for IAM entities in the IAM User Guide. The policy input is specified as a string that contains the complete, valid JSON text of a permissions boundary policy.

The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

", - "SimulatePrincipalPolicyRequest$PolicyInputList": "

An optional list of additional policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

", - "SimulatePrincipalPolicyRequest$PermissionsBoundaryPolicyInputList": "

The IAM permissions boundary policy to simulate. The permissions boundary sets the maximum permissions that the entity can have. You can input only one permissions boundary when you pass a policy to this operation. An IAM entity can only have one permissions boundary in effect at a time. For example, if a permissions boundary is attached to an entity and you pass in a different permissions boundary policy using this parameter, then the new permissions boundary policy is used for the simulation. For more information about permissions boundaries, see Permissions boundaries for IAM entities in the IAM User Guide. The policy input is specified as a string containing the complete, valid JSON text of a permissions boundary policy.

The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" - } - }, - "Statement": { - "base": "

Contains a reference to a Statement element in a policy document that determines the result of the simulation.

This data type is used by the MatchedStatements member of the EvaluationResult type.

", - "refs": { - "StatementListType$member": null - } - }, - "StatementListType": { - "base": null, - "refs": { - "EvaluationResult$MatchedStatements": "

A list of the statements in the input policies that determine the result for this scenario. Remember that even if multiple statements allow the operation on the resource, if only one statement denies that operation, then the explicit deny overrides any allow. In addition, the deny statement is the only entry included in the result.

In the top-level result, this field contains the union of matched statements across all requested resources. Only statements that contributed to the reported decision are included. For per-resource matched statements, see ResourceSpecificResults. This field doesn't include statements from service control policies (SCPs). Only statements from identity-based and resource-based policies appear here.

", - "ResourceSpecificResult$MatchedStatements": "

A list of the statements in the input policies that determine the result for this part of the simulation. Remember that even if multiple statements allow the operation on the resource, if any statement denies that operation, then the explicit deny overrides any allow. In addition, the deny statement is the only entry included in the result.

" - } - }, - "Tag": { - "base": "

A structure that represents user-provided metadata that can be associated with an IAM resource. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

", - "refs": { - "tagListType$member": null - } - }, - "TagInstanceProfileRequest": { - "base": null, - "refs": {} - }, - "TagMFADeviceRequest": { - "base": null, - "refs": {} - }, - "TagOpenIDConnectProviderRequest": { - "base": null, - "refs": {} - }, - "TagPolicyRequest": { - "base": null, - "refs": {} - }, - "TagRoleRequest": { - "base": null, - "refs": {} - }, - "TagSAMLProviderRequest": { - "base": null, - "refs": {} - }, - "TagServerCertificateRequest": { - "base": null, - "refs": {} - }, - "TagUserRequest": { - "base": null, - "refs": {} - }, - "TrackedActionLastAccessed": { - "base": "

Contains details about the most recent attempt to access an action within the service.

This data type is used as a response element in the GetServiceLastAccessedDetails operation.

", - "refs": { - "TrackedActionsLastAccessed$member": null - } - }, - "TrackedActionsLastAccessed": { - "base": null, - "refs": { - "ServiceLastAccessed$TrackedActionsLastAccessed": "

An object that contains details about the most recent attempt to access a tracked action within the service.

This field is null if there no tracked actions or if the principal did not use the tracked actions within the tracking period. This field is also null if the report was generated at the service level and not the action level. For more information, see the Granularity field in GenerateServiceLastAccessedDetails.

" - } - }, - "UnmodifiableEntityException": { - "base": "

The request was rejected because service-linked roles are protected Amazon Web Services resources. Only the service that depends on the service-linked role can modify or delete the role on your behalf. The error message includes the name of the service that depends on this service-linked role. You must request the change through that service.

", - "refs": {} - }, - "UnrecognizedPublicKeyEncodingException": { - "base": "

The request was rejected because the public key encoding format is unsupported or unrecognized.

", - "refs": {} - }, - "UntagInstanceProfileRequest": { - "base": null, - "refs": {} - }, - "UntagMFADeviceRequest": { - "base": null, - "refs": {} - }, - "UntagOpenIDConnectProviderRequest": { - "base": null, - "refs": {} - }, - "UntagPolicyRequest": { - "base": null, - "refs": {} - }, - "UntagRoleRequest": { - "base": null, - "refs": {} - }, - "UntagSAMLProviderRequest": { - "base": null, - "refs": {} - }, - "UntagServerCertificateRequest": { - "base": null, - "refs": {} - }, - "UntagUserRequest": { - "base": null, - "refs": {} - }, - "UpdateAccessKeyRequest": { - "base": null, - "refs": {} - }, - "UpdateAccountPasswordPolicyRequest": { - "base": null, - "refs": {} - }, - "UpdateAssumeRolePolicyRequest": { - "base": null, - "refs": {} - }, - "UpdateDelegationRequestRequest": { - "base": null, - "refs": {} - }, - "UpdateGroupRequest": { - "base": null, - "refs": {} - }, - "UpdateLoginProfileRequest": { - "base": null, - "refs": {} - }, - "UpdateOpenIDConnectProviderThumbprintRequest": { - "base": null, - "refs": {} - }, - "UpdateRoleDescriptionRequest": { - "base": null, - "refs": {} - }, - "UpdateRoleDescriptionResponse": { - "base": null, - "refs": {} - }, - "UpdateRoleRequest": { - "base": null, - "refs": {} - }, - "UpdateRoleResponse": { - "base": null, - "refs": {} - }, - "UpdateSAMLProviderRequest": { - "base": null, - "refs": {} - }, - "UpdateSAMLProviderResponse": { - "base": "

Contains the response to a successful UpdateSAMLProvider request.

", - "refs": {} - }, - "UpdateSSHPublicKeyRequest": { - "base": null, - "refs": {} - }, - "UpdateServerCertificateRequest": { - "base": null, - "refs": {} - }, - "UpdateServiceSpecificCredentialRequest": { - "base": null, - "refs": {} - }, - "UpdateSigningCertificateRequest": { - "base": null, - "refs": {} - }, - "UpdateUserRequest": { - "base": null, - "refs": {} - }, - "UploadSSHPublicKeyRequest": { - "base": null, - "refs": {} - }, - "UploadSSHPublicKeyResponse": { - "base": "

Contains the response to a successful UploadSSHPublicKey request.

", - "refs": {} - }, - "UploadServerCertificateRequest": { - "base": null, - "refs": {} - }, - "UploadServerCertificateResponse": { - "base": "

Contains the response to a successful UploadServerCertificate request.

", - "refs": {} - }, - "UploadSigningCertificateRequest": { - "base": null, - "refs": {} - }, - "UploadSigningCertificateResponse": { - "base": "

Contains the response to a successful UploadSigningCertificate request.

", - "refs": {} - }, - "User": { - "base": "

Contains information about an IAM user entity.

This data type is used as a response element in the following operations:

", - "refs": { - "CreateUserResponse$User": "

A structure with details about the new IAM user.

", - "GetUserResponse$User": "

A structure containing details about the IAM user.

Due to a service issue, password last used data does not include password use from May 3, 2018 22:50 PDT to May 23, 2018 14:08 PDT. This affects last sign-in dates shown in the IAM console and password last used dates in the IAM credential report, and returned by this operation. If users signed in during the affected time, the password last used date that is returned is the date the user last signed in before May 3, 2018. For users that signed in after May 23, 2018 14:08 PDT, the returned password last used date is accurate.

You can use password last used information to identify unused credentials for deletion. For example, you might delete users who did not sign in to Amazon Web Services in the last 90 days. In cases like this, we recommend that you adjust your evaluation window to include dates after May 23, 2018. Alternatively, if your users use access keys to access Amazon Web Services programmatically you can refer to access key last used information because it is accurate for all dates.

", - "VirtualMFADevice$User": "

The IAM user associated with this virtual MFA device.

", - "userListType$member": null - } - }, - "UserDetail": { - "base": "

Contains information about an IAM user, including all the user's policies and all the IAM groups the user is in.

This data type is used as a response element in the GetAccountAuthorizationDetails operation.

", - "refs": { - "userDetailListType$member": null - } - }, - "VirtualMFADevice": { - "base": "

Contains information about a virtual MFA device.

", - "refs": { - "CreateVirtualMFADeviceResponse$VirtualMFADevice": "

A structure containing details about the new virtual MFA device.

", - "virtualMFADeviceListType$member": null - } - }, - "accessKeyIdType": { - "base": null, - "refs": { - "AccessKey$AccessKeyId": "

The ID for this access key.

", - "AccessKeyMetadata$AccessKeyId": "

The ID for this access key.

", - "DeleteAccessKeyRequest$AccessKeyId": "

The access key ID for the access key ID and secret access key you want to delete.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

", - "GetAccessKeyLastUsedRequest$AccessKeyId": "

The identifier of an access key.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

", - "UpdateAccessKeyRequest$AccessKeyId": "

The access key ID of the secret access key you want to update.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

" - } - }, - "accessKeyMetadataListType": { - "base": "

Contains a list of access key metadata.

This data type is used as a response element in the ListAccessKeys operation.

", - "refs": { - "ListAccessKeysResponse$AccessKeyMetadata": "

A list of objects containing metadata about the access keys.

" - } - }, - "accessKeySecretType": { - "base": null, - "refs": { - "AccessKey$SecretAccessKey": "

The secret key used to sign requests.

" - } - }, - "accountAliasListType": { - "base": null, - "refs": { - "ListAccountAliasesResponse$AccountAliases": "

A list of aliases associated with the account. Amazon Web Services supports only one alias per account.

" - } - }, - "accountAliasType": { - "base": null, - "refs": { - "CreateAccountAliasRequest$AccountAlias": "

The account alias to create.

This parameter allows (through its regex pattern) a string of characters consisting of lowercase letters, digits, and dashes. You cannot start or finish with a dash, nor can you have two dashes in a row.

", - "DeleteAccountAliasRequest$AccountAlias": "

The name of the account alias to delete.

This parameter allows (through its regex pattern) a string of characters consisting of lowercase letters, digits, and dashes. You cannot start or finish with a dash, nor can you have two dashes in a row.

", - "accountAliasListType$member": null - } - }, - "accountIdType": { - "base": null, - "refs": { - "CreateDelegationRequestRequest$OwnerAccountId": "

The Amazon Web Services account ID this delegation request is targeted to.

If the account ID is not known, this parameter can be omitted, resulting in a request that can be associated by any account. If the account ID passed, then the created delegation request can only be associated with an identity of that target account.

", - "DelegationRequest$OwnerAccountId": "

Amazon Web Services account ID of the owner of the delegation request.

", - "DelegationRequest$RequestorId": "

Identity of the requestor of this delegation request. This will be an Amazon Web Services account ID.

" - } - }, - "allUsers": { - "base": null, - "refs": { - "ListServiceSpecificCredentialsRequest$AllUsers": "

A flag indicating whether to list service specific credentials for all users. This parameter cannot be specified together with UserName. When true, returns all credentials associated with the specified service.

" - } - }, - "arnType": { - "base": "

The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.

For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", - "refs": { - "AddClientIDToOpenIDConnectProviderRequest$OpenIDConnectProviderArn": "

The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider resource to add the client ID to. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders operation.

", - "ArnListType$member": null, - "AttachGroupPolicyRequest$PolicyArn": "

The Amazon Resource Name (ARN) of the IAM policy you want to attach.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", - "AttachRolePolicyRequest$PolicyArn": "

The Amazon Resource Name (ARN) of the IAM policy you want to attach.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", - "AttachUserPolicyRequest$PolicyArn": "

The Amazon Resource Name (ARN) of the IAM policy you want to attach.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", - "AttachedPermissionsBoundary$PermissionsBoundaryArn": "

The ARN of the policy used to set the permissions boundary for the user or role.

", - "AttachedPolicy$PolicyArn": null, - "CreateOpenIDConnectProviderResponse$OpenIDConnectProviderArn": "

The Amazon Resource Name (ARN) of the new IAM OpenID Connect provider that is created. For more information, see OpenIDConnectProviderListEntry.

", - "CreatePolicyVersionRequest$PolicyArn": "

The Amazon Resource Name (ARN) of the IAM policy to which you want to add a new version.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", - "CreateRoleRequest$PermissionsBoundary": "

The ARN of the managed policy that is used to set the permissions boundary for the role.

A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see Permissions boundaries for IAM entities in the IAM User Guide.

For more information about policy types, see Policy types in the IAM User Guide.

", - "CreateSAMLProviderResponse$SAMLProviderArn": "

The Amazon Resource Name (ARN) of the new SAML provider resource in IAM.

", - "CreateUserRequest$PermissionsBoundary": "

The ARN of the managed policy that is used to set the permissions boundary for the user.

A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see Permissions boundaries for IAM entities in the IAM User Guide.

For more information about policy types, see Policy types in the IAM User Guide.

", - "DelegationPermission$PolicyTemplateArn": "

This ARN maps to a pre-registered policy content for this partner. See the partner onboarding documentation to understand how to create a delegation template.

", - "DelegationRequest$ApproverId": null, - "DeleteOpenIDConnectProviderRequest$OpenIDConnectProviderArn": "

The Amazon Resource Name (ARN) of the IAM OpenID Connect provider resource object to delete. You can get a list of OpenID Connect provider resource ARNs by using the ListOpenIDConnectProviders operation.

", - "DeletePolicyRequest$PolicyArn": "

The Amazon Resource Name (ARN) of the IAM policy you want to delete.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", - "DeletePolicyVersionRequest$PolicyArn": "

The Amazon Resource Name (ARN) of the IAM policy from which you want to delete a version.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", - "DeleteSAMLProviderRequest$SAMLProviderArn": "

The Amazon Resource Name (ARN) of the SAML provider to delete.

", - "DetachGroupPolicyRequest$PolicyArn": "

The Amazon Resource Name (ARN) of the IAM policy you want to detach.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", - "DetachRolePolicyRequest$PolicyArn": "

The Amazon Resource Name (ARN) of the IAM policy you want to detach.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", - "DetachUserPolicyRequest$PolicyArn": "

The Amazon Resource Name (ARN) of the IAM policy you want to detach.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", - "EntityInfo$Arn": null, - "GenerateServiceLastAccessedDetailsRequest$Arn": "

The ARN of the IAM resource (user, group, role, or managed policy) used to generate information about when the resource was last used in an attempt to access an Amazon Web Services service.

", - "GetContextKeysForPrincipalPolicyRequest$PolicySourceArn": "

The ARN of a user, group, or role whose policies contain the context keys that you want listed. If you specify a user, the list includes context keys that are found in all policies that are attached to the user. The list also includes all groups that the user is a member of. If you pick a group or a role, then it includes only those context keys that are found in policies attached to that entity. Note that all parameters are shown in unencoded form here for clarity, but must be URL encoded to be included as a part of a real HTML request.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", - "GetHumanReadableSummaryRequest$EntityArn": "

Arn of the entity to be summarized. At this time, the only supported entity type is delegation-request

", - "GetOpenIDConnectProviderRequest$OpenIDConnectProviderArn": "

The Amazon Resource Name (ARN) of the OIDC provider resource object in IAM to get information for. You can get a list of OIDC provider resource ARNs by using the ListOpenIDConnectProviders operation.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", - "GetPolicyRequest$PolicyArn": "

The Amazon Resource Name (ARN) of the managed policy that you want information about.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", - "GetPolicyVersionRequest$PolicyArn": "

The Amazon Resource Name (ARN) of the managed policy that you want information about.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", - "GetSAMLProviderRequest$SAMLProviderArn": "

The Amazon Resource Name (ARN) of the SAML provider resource object in IAM to get information about.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", - "Group$Arn": "

The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how to use them in policies, see IAM identifiers in the IAM User Guide.

", - "GroupDetail$Arn": null, - "InstanceProfile$Arn": "

The Amazon Resource Name (ARN) specifying the instance profile. For more information about ARNs and how to use them in policies, see IAM identifiers in the IAM User Guide.

", - "ListEntitiesForPolicyRequest$PolicyArn": "

The Amazon Resource Name (ARN) of the IAM policy for which you want the versions.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", - "ListOpenIDConnectProviderTagsRequest$OpenIDConnectProviderArn": "

The ARN of the OpenID Connect (OIDC) identity provider whose tags you want to see.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "ListPoliciesGrantingServiceAccessRequest$Arn": "

The ARN of the IAM identity (user, group, or role) whose policies you want to list.

", - "ListPolicyTagsRequest$PolicyArn": "

The ARN of the IAM customer managed policy whose tags you want to see.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "ListPolicyVersionsRequest$PolicyArn": "

The Amazon Resource Name (ARN) of the IAM policy for which you want the versions.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", - "ListSAMLProviderTagsRequest$SAMLProviderArn": "

The ARN of the Security Assertion Markup Language (SAML) identity provider whose tags you want to see.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "ManagedPolicyDetail$Arn": null, - "OpenIDConnectProviderListEntry$Arn": null, - "Policy$Arn": null, - "PolicyGrantingServiceAccess$PolicyArn": null, - "PolicyIdentifier$PolicyArn": "

The Amazon Resource Name (ARN) of an Amazon Web Services managed policy or a customer managed policy that is attached to an IAM user, group, or role. Wildcard characters are supported in the resource name portion of the ARN to match multiple managed policies: use at most one * (matches any sequence of characters, including none), and any number of ? (each matches exactly one character).

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", - "PutRolePermissionsBoundaryRequest$PermissionsBoundary": "

The ARN of the managed policy that is used to set the permissions boundary for the role.

A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see Permissions boundaries for IAM entities in the IAM User Guide.

For more information about policy types, see Policy types in the IAM User Guide.

", - "PutUserPermissionsBoundaryRequest$PermissionsBoundary": "

The ARN of the managed policy that is used to set the permissions boundary for the user.

A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see Permissions boundaries for IAM entities in the IAM User Guide.

For more information about policy types, see Policy types in the IAM User Guide.

", - "RemoveClientIDFromOpenIDConnectProviderRequest$OpenIDConnectProviderArn": "

The Amazon Resource Name (ARN) of the IAM OIDC provider resource to remove the client ID from. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders operation.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", - "Role$Arn": "

The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in policies, see IAM identifiers in the IAM User Guide guide.

", - "RoleDetail$Arn": null, - "SAMLProviderListEntry$Arn": "

The Amazon Resource Name (ARN) of the SAML provider.

", - "ServerCertificateMetadata$Arn": "

The Amazon Resource Name (ARN) specifying the server certificate. For more information about ARNs and how to use them in policies, see IAM identifiers in the IAM User Guide.

", - "ServiceLastAccessed$LastAuthenticatedEntity": "

The ARN of the authenticated entity (user or role) that last attempted to access the service. Amazon Web Services does not report unauthenticated requests.

This field is null if no IAM entities attempted to access the service within the tracking period.

", - "SetDefaultPolicyVersionRequest$PolicyArn": "

The Amazon Resource Name (ARN) of the IAM policy whose default version you want to set.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", - "SimulatePrincipalPolicyRequest$PolicySourceArn": "

The Amazon Resource Name (ARN) of a user, group, or role whose policies you want to include in the simulation. If you specify a user, group, or role, the simulation includes all policies that are associated with that entity. If you specify a user, the simulation also includes all policies that are attached to any groups the user belongs to.

The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", - "TagOpenIDConnectProviderRequest$OpenIDConnectProviderArn": "

The ARN of the OIDC identity provider in IAM to which you want to add tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "TagPolicyRequest$PolicyArn": "

The ARN of the IAM customer managed policy to which you want to add tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "TagSAMLProviderRequest$SAMLProviderArn": "

The ARN of the SAML identity provider in IAM to which you want to add tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "TrackedActionLastAccessed$LastAccessedEntity": null, - "UntagOpenIDConnectProviderRequest$OpenIDConnectProviderArn": "

The ARN of the OIDC provider in IAM from which you want to remove tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "UntagPolicyRequest$PolicyArn": "

The ARN of the IAM customer managed policy from which you want to remove tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "UntagSAMLProviderRequest$SAMLProviderArn": "

The ARN of the SAML identity provider in IAM from which you want to remove tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "UpdateOpenIDConnectProviderThumbprintRequest$OpenIDConnectProviderArn": "

The Amazon Resource Name (ARN) of the IAM OIDC provider resource object for which you want to update the thumbprint. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders operation.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", - "UpdateSAMLProviderRequest$SAMLProviderArn": "

The Amazon Resource Name (ARN) of the SAML provider to update.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", - "UpdateSAMLProviderResponse$SAMLProviderArn": "

The Amazon Resource Name (ARN) of the SAML provider that was updated.

", - "User$Arn": "

The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.

", - "UserDetail$Arn": null, - "rolePermissionRestrictionArnListType$member": null - } - }, - "assertionEncryptionModeType": { - "base": null, - "refs": { - "CreateSAMLProviderRequest$AssertionEncryptionMode": "

Specifies the encryption setting for the SAML provider.

", - "GetSAMLProviderResponse$AssertionEncryptionMode": "

Specifies the encryption setting for the SAML provider.

", - "UpdateSAMLProviderRequest$AssertionEncryptionMode": "

Specifies the encryption setting for the SAML provider.

" - } - }, - "assignmentStatusType": { - "base": null, - "refs": { - "ListVirtualMFADevicesRequest$AssignmentStatus": "

The status (Unassigned or Assigned) of the devices to list. If you do not specify an AssignmentStatus, the operation defaults to Any, which lists both assigned and unassigned virtual MFA devices.,

" - } - }, - "attachedPoliciesListType": { - "base": null, - "refs": { - "GroupDetail$AttachedManagedPolicies": "

A list of the managed policies attached to the group.

", - "ListAttachedGroupPoliciesResponse$AttachedPolicies": "

A list of the attached policies.

", - "ListAttachedRolePoliciesResponse$AttachedPolicies": "

A list of the attached policies.

", - "ListAttachedUserPoliciesResponse$AttachedPolicies": "

A list of the attached policies.

", - "RoleDetail$AttachedManagedPolicies": "

A list of managed policies attached to the role. These policies are the role's access (permissions) policies.

", - "UserDetail$AttachedManagedPolicies": "

A list of the managed policies attached to the user.

" - } - }, - "attachmentCountType": { - "base": null, - "refs": { - "ManagedPolicyDetail$AttachmentCount": "

The number of principal entities (users, groups, and roles) that the policy is attached to.

", - "ManagedPolicyDetail$PermissionsBoundaryUsageCount": "

The number of entities (users and roles) for which the policy is used as the permissions boundary.

For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.

", - "Policy$AttachmentCount": "

The number of entities (users, groups, and roles) that the policy is attached to.

", - "Policy$PermissionsBoundaryUsageCount": "

The number of entities (users and roles) for which the policy is used to set the permissions boundary.

For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.

" - } - }, - "authenticationCodeType": { - "base": null, - "refs": { - "EnableMFADeviceRequest$AuthenticationCode1": "

An authentication code emitted by the device.

The format for this parameter is a string of six digits.

Submit your request immediately after generating the authentication codes. If you generate the codes and then wait too long to submit the request, the MFA device successfully associates with the user but the MFA device becomes out of sync. This happens because time-based one-time passwords (TOTP) expire after a short period of time. If this happens, you can resync the device.

", - "EnableMFADeviceRequest$AuthenticationCode2": "

A subsequent authentication code emitted by the device.

The format for this parameter is a string of six digits.

Submit your request immediately after generating the authentication codes. If you generate the codes and then wait too long to submit the request, the MFA device successfully associates with the user but the MFA device becomes out of sync. This happens because time-based one-time passwords (TOTP) expire after a short period of time. If this happens, you can resync the device.

", - "ResyncMFADeviceRequest$AuthenticationCode1": "

An authentication code emitted by the device.

The format for this parameter is a sequence of six digits.

", - "ResyncMFADeviceRequest$AuthenticationCode2": "

A subsequent authentication code emitted by the device.

The format for this parameter is a sequence of six digits.

" - } - }, - "booleanObjectType": { - "base": null, - "refs": { - "PasswordPolicy$HardExpiry": "

Specifies whether IAM users are prevented from setting a new password via the Amazon Web Services Management Console after their password has expired. The IAM user cannot access the console until an administrator resets the password. IAM users with iam:ChangePassword permission and active access keys can reset their own expired console password using the CLI or API.

", - "UpdateAccountPasswordPolicyRequest$HardExpiry": "

Prevents IAM users who are accessing the account via the Amazon Web Services Management Console from setting a new console password after their password has expired. The IAM user cannot access the console until an administrator resets the password.

If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that IAM users can change their passwords after they expire and continue to sign in as the user.

In the Amazon Web Services Management Console, the custom password policy option Allow users to change their own password gives IAM users permissions to iam:ChangePassword for only their user and to the iam:GetAccountPasswordPolicy action. This option does not attach a permissions policy to each user, rather the permissions are applied at the account-level for all users by IAM. IAM users with iam:ChangePassword permission and active access keys can reset their own expired console password using the CLI or API.

", - "UpdateLoginProfileRequest$PasswordResetRequired": "

Allows this new password to be used only once by requiring the specified IAM user to set a new password on next sign-in.

" - } - }, - "booleanType": { - "base": null, - "refs": { - "CreateDelegationRequestRequest$OnlySendByOwner": "

Specifies whether the delegation token should only be sent by the owner.

This flag prevents any party other than the owner from calling SendDelegationToken API for this delegation request. This behavior becomes useful when the delegation request owner needs to be present for subsequent partner interactions, but the delegation request was sent to a more privileged user for approval due to the owner lacking sufficient delegation permissions.

", - "CreateLoginProfileRequest$PasswordResetRequired": "

Specifies whether the user is required to set a new password on next sign-in.

", - "CreatePolicyVersionRequest$SetAsDefault": "

Specifies whether to set this version as the policy's default version.

When this parameter is true, the new policy version becomes the operative version. That is, it becomes the version that is in effect for the IAM users, groups, and roles that the policy is attached to.

For more information about managed policy versions, see Versioning for managed policies in the IAM User Guide.

", - "DelegationRequest$OnlySendByOwner": "

A flag indicating whether the SendDelegationToken must be called by the owner of this delegation request. This is set by the requesting partner.

", - "GetAccountAuthorizationDetailsResponse$IsTruncated": "

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

", - "GetDelegationRequestRequest$DelegationPermissionCheck": "

Specifies whether to perform a permission check for the delegation request.

If set to true, the GetDelegationRequest API call will start a permission check process. This process calculates whether the caller has sufficient permissions to cover the asks from this delegation request.

Setting this parameter to true does not guarantee an answer in the response. See the PermissionCheckStatus and the PermissionCheckResult response attributes for further details.

", - "GetGroupResponse$IsTruncated": "

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

", - "GetOrganizationsAccessReportResponse$IsTruncated": "

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

", - "GetOutboundWebIdentityFederationInfoResponse$JwtVendingEnabled": "

Indicates whether outbound identity federation is currently enabled for your Amazon Web Services account. When true, IAM principals in the account can call the GetWebIdentityToken API to obtain JSON Web Tokens (JWTs) for authentication with external services.

", - "GetServiceLastAccessedDetailsResponse$IsTruncated": "

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

", - "GetServiceLastAccessedDetailsWithEntitiesResponse$IsTruncated": "

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

", - "ListAccessKeysResponse$IsTruncated": "

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

", - "ListAccountAliasesResponse$IsTruncated": "

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

", - "ListAttachedGroupPoliciesResponse$IsTruncated": "

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

", - "ListAttachedRolePoliciesResponse$IsTruncated": "

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

", - "ListAttachedUserPoliciesResponse$IsTruncated": "

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

", - "ListDelegationRequestsResponse$isTruncated": "

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items.

", - "ListEntitiesForPolicyResponse$IsTruncated": "

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

", - "ListGroupPoliciesResponse$IsTruncated": "

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

", - "ListGroupsForUserResponse$IsTruncated": "

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

", - "ListGroupsResponse$IsTruncated": "

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

", - "ListInstanceProfileTagsResponse$IsTruncated": "

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

", - "ListInstanceProfilesForRoleResponse$IsTruncated": "

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

", - "ListInstanceProfilesResponse$IsTruncated": "

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

", - "ListMFADeviceTagsResponse$IsTruncated": "

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

", - "ListMFADevicesResponse$IsTruncated": "

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

", - "ListOpenIDConnectProviderTagsResponse$IsTruncated": "

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

", - "ListPoliciesGrantingServiceAccessResponse$IsTruncated": "

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

", - "ListPoliciesRequest$OnlyAttached": "

A flag to filter the results to only the attached policies.

When OnlyAttached is true, the returned list contains only the policies that are attached to an IAM user, group, or role. When OnlyAttached is false, or when the parameter is not included, all policies are returned.

", - "ListPoliciesResponse$IsTruncated": "

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

", - "ListPolicyTagsResponse$IsTruncated": "

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

", - "ListPolicyVersionsResponse$IsTruncated": "

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

", - "ListRolePoliciesResponse$IsTruncated": "

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

", - "ListRoleTagsResponse$IsTruncated": "

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

", - "ListRolesResponse$IsTruncated": "

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

", - "ListSAMLProviderTagsResponse$IsTruncated": "

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

", - "ListSSHPublicKeysResponse$IsTruncated": "

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

", - "ListServerCertificateTagsResponse$IsTruncated": "

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

", - "ListServerCertificatesResponse$IsTruncated": "

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

", - "ListServiceSpecificCredentialsResponse$IsTruncated": "

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items.

", - "ListSigningCertificatesResponse$IsTruncated": "

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

", - "ListUserPoliciesResponse$IsTruncated": "

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

", - "ListUserTagsResponse$IsTruncated": "

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

", - "ListUsersResponse$IsTruncated": "

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

", - "ListVirtualMFADevicesResponse$IsTruncated": "

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

", - "LoginProfile$PasswordResetRequired": "

Specifies whether the user is required to set a new password on next sign-in.

", - "ManagedPolicyDetail$IsAttachable": "

Specifies whether the policy can be attached to an IAM user, group, or role.

", - "OrganizationsDecisionDetail$AllowedByOrganizations": "

Specifies whether the simulated operation is allowed by the Organizations service control policies that impact the simulated user's account.

", - "PasswordPolicy$RequireSymbols": "

Specifies whether IAM user passwords must contain at least one of the following symbols:

! @ # $ % ^ & * ( ) _ + - = [ ] { } | '

", - "PasswordPolicy$RequireNumbers": "

Specifies whether IAM user passwords must contain at least one numeric character (0 to 9).

", - "PasswordPolicy$RequireUppercaseCharacters": "

Specifies whether IAM user passwords must contain at least one uppercase character (A to Z).

", - "PasswordPolicy$RequireLowercaseCharacters": "

Specifies whether IAM user passwords must contain at least one lowercase character (a to z).

", - "PasswordPolicy$AllowUsersToChangePassword": "

Specifies whether IAM users are allowed to change their own password. Gives IAM users permissions to iam:ChangePassword for only their user and to the iam:GetAccountPasswordPolicy action. This option does not attach a permissions policy to each user, rather the permissions are applied at the account-level for all users by IAM.

", - "PasswordPolicy$ExpirePasswords": "

Indicates whether passwords in the account expire. Returns true if MaxPasswordAge contains a value greater than 0. Returns false if MaxPasswordAge is 0 or not present.

", - "PermissionsBoundaryDecisionDetail$AllowedByPermissionsBoundary": "

Specifies whether an action is allowed by a permissions boundary that is applied to an IAM entity (user or role). A value of true means that the permissions boundary does not deny the action. This means that the policy includes an Allow statement that matches the request. In this case, if an identity-based policy also allows the action, the request is allowed. A value of false means that either the requested action is not allowed (implicitly denied) or that the action is explicitly denied by the permissions boundary. In both of these cases, the action is not allowed, regardless of the identity-based policy.

", - "Policy$IsAttachable": "

Specifies whether the policy can be attached to an IAM user, group, or role.

", - "PolicyVersion$IsDefaultVersion": "

Specifies whether the policy version is set as the policy's default version.

", - "SimulatePolicyResponse$IsTruncated": "

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

", - "UpdateAccountPasswordPolicyRequest$RequireSymbols": "

Specifies whether IAM user passwords must contain at least one of the following non-alphanumeric characters:

! @ # $ % ^ & * ( ) _ + - = [ ] { } | '

If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that passwords do not require at least one symbol character.

", - "UpdateAccountPasswordPolicyRequest$RequireNumbers": "

Specifies whether IAM user passwords must contain at least one numeric character (0 to 9).

If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that passwords do not require at least one numeric character.

", - "UpdateAccountPasswordPolicyRequest$RequireUppercaseCharacters": "

Specifies whether IAM user passwords must contain at least one uppercase character from the ISO basic Latin alphabet (A to Z).

If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that passwords do not require at least one uppercase character.

", - "UpdateAccountPasswordPolicyRequest$RequireLowercaseCharacters": "

Specifies whether IAM user passwords must contain at least one lowercase character from the ISO basic Latin alphabet (a to z).

If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that passwords do not require at least one lowercase character.

", - "UpdateAccountPasswordPolicyRequest$AllowUsersToChangePassword": "

Allows all IAM users in your account to use the Amazon Web Services Management Console to change their own passwords. For more information, see Permitting IAM users to change their own passwords in the IAM User Guide.

If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that IAM users in the account do not automatically have permissions to change their own password.

" - } - }, - "certificateBodyType": { - "base": null, - "refs": { - "ServerCertificate$CertificateBody": "

The contents of the public key certificate.

", - "SigningCertificate$CertificateBody": "

The contents of the signing certificate.

", - "UploadServerCertificateRequest$CertificateBody": "

The contents of the public key certificate in PEM-encoded format.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

", - "UploadSigningCertificateRequest$CertificateBody": "

The contents of the signing certificate.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" - } - }, - "certificateChainType": { - "base": null, - "refs": { - "ServerCertificate$CertificateChain": "

The contents of the public key certificate chain.

", - "UploadServerCertificateRequest$CertificateChain": "

The contents of the certificate chain. This is typically a concatenation of the PEM-encoded public key certificates of the chain.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" - } - }, - "certificateIdType": { - "base": null, - "refs": { - "DeleteSigningCertificateRequest$CertificateId": "

The ID of the signing certificate to delete.

The format of this parameter, as described by its regex pattern, is a string of characters that can be upper- or lower-cased letters or digits.

", - "SigningCertificate$CertificateId": "

The ID for the signing certificate.

", - "UpdateSigningCertificateRequest$CertificateId": "

The ID of the signing certificate you want to update.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

" - } - }, - "certificateListType": { - "base": "

Contains a list of signing certificates.

This data type is used as a response element in the ListSigningCertificates operation.

", - "refs": { - "ListSigningCertificatesResponse$Certificates": "

A list of the user's signing certificate information.

" - } - }, - "clientIDListType": { - "base": null, - "refs": { - "CreateOpenIDConnectProviderRequest$ClientIDList": "

Provides a list of client IDs, also known as audiences. When a mobile or web app registers with an OpenID Connect provider, they establish a value that identifies the application. This is the value that's sent as the client_id parameter on OAuth requests.

You can register multiple client IDs with the same provider. For example, you might have multiple applications that use the same OIDC provider. You cannot register more than 100 client IDs with a single IAM OIDC provider.

There is no defined format for a client ID. The CreateOpenIDConnectProviderRequest operation accepts client IDs up to 255 characters long.

", - "GetOpenIDConnectProviderResponse$ClientIDList": "

A list of client IDs (also known as audiences) that are associated with the specified IAM OIDC provider resource object. For more information, see CreateOpenIDConnectProvider.

" - } - }, - "clientIDType": { - "base": null, - "refs": { - "AddClientIDToOpenIDConnectProviderRequest$ClientID": "

The client ID (also known as audience) to add to the IAM OpenID Connect provider resource.

", - "RemoveClientIDFromOpenIDConnectProviderRequest$ClientID": "

The client ID (also known as audience) to remove from the IAM OIDC provider resource. For more information about client IDs, see CreateOpenIDConnectProvider.

", - "clientIDListType$member": null - } - }, - "consoleDeepLinkType": { - "base": null, - "refs": { - "CreateDelegationRequestResponse$ConsoleDeepLink": "

A deep link URL to the Amazon Web Services Management Console for managing the delegation request.

For a console based workflow, partners should redirect the customer to this URL. If the customer is not logged in to any Amazon Web Services account, the Amazon Web Services workflow will automatically direct the customer to log in and then display the delegation request approval page.

" - } - }, - "credentialAgeDays": { - "base": null, - "refs": { - "CreateServiceSpecificCredentialRequest$CredentialAgeDays": "

The number of days until the service specific credential expires. This field is only valid for services that support long-term API keys and must be a positive integer. When not specified, the credential will not expire.

To see which services support long-term API keys, refer to API keys for Amazon Web Services services in the IAM User Guide.

" - } - }, - "credentialReportExpiredExceptionMessage": { - "base": null, - "refs": { - "CredentialReportExpiredException$message": null - } - }, - "credentialReportNotPresentExceptionMessage": { - "base": null, - "refs": { - "CredentialReportNotPresentException$message": null - } - }, - "credentialReportNotReadyExceptionMessage": { - "base": null, - "refs": { - "CredentialReportNotReadyException$message": null - } - }, - "customSuffixType": { - "base": null, - "refs": { - "CreateServiceLinkedRoleRequest$CustomSuffix": "

A string that you provide, which is combined with the service-provided prefix to form the complete role name. If you make multiple requests for the same service, then you must supply a different CustomSuffix for each request. Otherwise the request fails with a duplicate role name error. For example, you could add -1 or -debug to the suffix.

Some services do not support the CustomSuffix parameter. If you provide an optional suffix and the operation fails, try the operation again without the suffix.

" - } - }, - "dateType": { - "base": null, - "refs": { - "AccessDetail$LastAuthenticatedTime": "

The date and time, in ISO 8601 date-time format, when an authenticated principal most recently attempted to access the service. Amazon Web Services does not report unauthenticated requests.

This field is null if no principals in the reported Organizations entity attempted to access the service within the tracking period.

", - "AccessKey$CreateDate": "

The date when the access key was created.

", - "AccessKeyLastUsed$LastUsedDate": "

The date and time, in ISO 8601 date-time format, when the access key was most recently used. This field is null in the following situations:

  • The user does not have an access key.

  • An access key exists but has not been used since IAM began tracking this information.

  • There is no sign-in data associated with the user.

", - "AccessKeyMetadata$CreateDate": "

The date when the access key was created.

", - "DelegationRequest$ExpirationTime": "

The expiry time of this delegation request

See the Understanding the Request Lifecycle for details on the life time of a delegation request at each state.

", - "DelegationRequest$CreateDate": "

Creation date (timestamp) of this delegation request.

", - "DelegationRequest$UpdatedTime": "

Last updated timestamp of the request.

", - "EntityDetails$LastAuthenticated": "

The date and time, in ISO 8601 date-time format, when the authenticated entity last attempted to access Amazon Web Services. Amazon Web Services does not report unauthenticated requests.

This field is null if no IAM entities attempted to access the service within the tracking period.

", - "GetCredentialReportResponse$GeneratedTime": "

The date and time when the credential report was created, in ISO 8601 date-time format.

", - "GetMFADeviceResponse$EnableDate": "

The date that a specified user's MFA device was first enabled.

", - "GetOpenIDConnectProviderResponse$CreateDate": "

The date and time when the IAM OIDC provider resource object was created in the Amazon Web Services account.

", - "GetOrganizationsAccessReportResponse$JobCreationDate": "

The date and time, in ISO 8601 date-time format, when the report job was created.

", - "GetOrganizationsAccessReportResponse$JobCompletionDate": "

The date and time, in ISO 8601 date-time format, when the generated report job was completed or failed.

This field is null if the job is still in progress, as indicated by a job status value of IN_PROGRESS.

", - "GetSAMLProviderResponse$CreateDate": "

The date and time when the SAML provider was created.

", - "GetSAMLProviderResponse$ValidUntil": "

The expiration date and time for the SAML provider.

", - "GetServiceLastAccessedDetailsResponse$JobCreationDate": "

The date and time, in ISO 8601 date-time format, when the report job was created.

", - "GetServiceLastAccessedDetailsResponse$JobCompletionDate": "

The date and time, in ISO 8601 date-time format, when the generated report job was completed or failed.

This field is null if the job is still in progress, as indicated by a job status value of IN_PROGRESS.

", - "GetServiceLastAccessedDetailsWithEntitiesResponse$JobCreationDate": "

The date and time, in ISO 8601 date-time format, when the report job was created.

", - "GetServiceLastAccessedDetailsWithEntitiesResponse$JobCompletionDate": "

The date and time, in ISO 8601 date-time format, when the generated report job was completed or failed.

This field is null if the job is still in progress, as indicated by a job status value of IN_PROGRESS.

", - "Group$CreateDate": "

The date and time, in ISO 8601 date-time format, when the group was created.

", - "GroupDetail$CreateDate": "

The date and time, in ISO 8601 date-time format, when the group was created.

", - "InstanceProfile$CreateDate": "

The date when the instance profile was created.

", - "LoginProfile$CreateDate": "

The date when the password for the user was created.

", - "MFADevice$EnableDate": "

The date when the MFA device was enabled for the user.

", - "ManagedPolicyDetail$CreateDate": "

The date and time, in ISO 8601 date-time format, when the policy was created.

", - "ManagedPolicyDetail$UpdateDate": "

The date and time, in ISO 8601 date-time format, when the policy was last updated.

When a policy has only one version, this field contains the date and time when the policy was created. When a policy has more than one version, this field contains the date and time when the most recent policy version was created.

", - "Policy$CreateDate": "

The date and time, in ISO 8601 date-time format, when the policy was created.

", - "Policy$UpdateDate": "

The date and time, in ISO 8601 date-time format, when the policy was last updated.

When a policy has only one version, this field contains the date and time when the policy was created. When a policy has more than one version, this field contains the date and time when the most recent policy version was created.

", - "PolicyVersion$CreateDate": "

The date and time, in ISO 8601 date-time format, when the policy version was created.

", - "Role$CreateDate": "

The date and time, in ISO 8601 date-time format, when the role was created.

", - "RoleDetail$CreateDate": "

The date and time, in ISO 8601 date-time format, when the role was created.

", - "RoleLastUsed$LastUsedDate": "

The date and time, in ISO 8601 date-time format that the role was last used.

This field is null if the role has not been used within the IAM tracking period. For more information about the tracking period, see Regions where data is tracked in the IAM User Guide.

", - "SAMLPrivateKey$Timestamp": "

The date and time, in ISO 8601 date-time format, when the private key was uploaded.

", - "SAMLProviderListEntry$ValidUntil": "

The expiration date and time for the SAML provider.

", - "SAMLProviderListEntry$CreateDate": "

The date and time when the SAML provider was created.

", - "SSHPublicKey$UploadDate": "

The date and time, in ISO 8601 date-time format, when the SSH public key was uploaded.

", - "SSHPublicKeyMetadata$UploadDate": "

The date and time, in ISO 8601 date-time format, when the SSH public key was uploaded.

", - "ServerCertificateMetadata$UploadDate": "

The date when the server certificate was uploaded.

", - "ServerCertificateMetadata$Expiration": "

The date on which the certificate is set to expire.

", - "ServiceLastAccessed$LastAuthenticated": "

The date and time, in ISO 8601 date-time format, when an authenticated entity most recently attempted to access the service. Amazon Web Services does not report unauthenticated requests.

This field is null if no IAM entities attempted to access the service within the tracking period.

", - "ServiceSpecificCredential$CreateDate": "

The date and time, in ISO 8601 date-time format, when the service-specific credential were created.

", - "ServiceSpecificCredential$ExpirationDate": "

The date and time when the service specific credential expires. This field is only present for Bedrock API keys and CloudWatch Logs API keys that were created with an expiration period.

", - "ServiceSpecificCredentialMetadata$CreateDate": "

The date and time, in ISO 8601 date-time format, when the service-specific credential were created.

", - "ServiceSpecificCredentialMetadata$ExpirationDate": "

The date and time when the service specific credential expires. This field is only present for Bedrock API keys and CloudWatch Logs API keys that were created with an expiration period.

", - "SigningCertificate$UploadDate": "

The date when the signing certificate was uploaded.

", - "TrackedActionLastAccessed$LastAccessedTime": "

The date and time, in ISO 8601 date-time format, when an authenticated entity most recently attempted to access the tracked service. Amazon Web Services does not report unauthenticated requests.

This field is null if no IAM entities attempted to access the service within the tracking period.

", - "User$CreateDate": "

The date and time, in ISO 8601 date-time format, when the user was created.

", - "User$PasswordLastUsed": "

The date and time, in ISO 8601 date-time format, when the user's password was last used to sign in to an Amazon Web Services website. For a list of Amazon Web Services websites that capture a user's last sign-in time, see the Credential reports topic in the IAM User Guide. If a password is used more than once in a five-minute span, only the first use is returned in this field. If the field is null (no value), then it indicates that they never signed in with a password. This can be because:

  • The user never had a password.

  • A password exists but has not been used since IAM started tracking this information on October 20, 2014.

A null value does not mean that the user never had a password. Also, if the user does not currently have a password but had one in the past, then this field contains the date and time the most recent password was used.

This value is returned only in the GetUser and ListUsers operations.

", - "UserDetail$CreateDate": "

The date and time, in ISO 8601 date-time format, when the user was created.

", - "VirtualMFADevice$EnableDate": "

The date and time on which the virtual MFA device was enabled.

" - } - }, - "delegationRequestDescriptionType": { - "base": null, - "refs": { - "CreateDelegationRequestRequest$Description": "

A description of the delegation request.

", - "DelegationRequest$Description": "

Description of the delegation request. This is a message that is provided by the Amazon Web Services partner that filed the delegation request.

" - } - }, - "delegationRequestIdType": { - "base": null, - "refs": { - "AcceptDelegationRequestRequest$DelegationRequestId": "

The unique identifier of the delegation request to accept.

", - "AssociateDelegationRequestRequest$DelegationRequestId": "

The unique identifier of the delegation request to associate.

", - "CreateDelegationRequestResponse$DelegationRequestId": "

The unique identifier for the created delegation request.

", - "DelegationRequest$DelegationRequestId": "

The unique identifier for the delegation request.

", - "GetDelegationRequestRequest$DelegationRequestId": "

The unique identifier of the delegation request to retrieve.

", - "RejectDelegationRequestRequest$DelegationRequestId": "

The unique identifier of the delegation request to reject.

", - "SendDelegationTokenRequest$DelegationRequestId": "

The unique identifier of the delegation request for which to send the token.

", - "UpdateDelegationRequestRequest$DelegationRequestId": "

The unique identifier of the delegation request to update.

" - } - }, - "delegationRequestsListType": { - "base": null, - "refs": { - "ListDelegationRequestsResponse$DelegationRequests": "

A list of delegation requests that match the specified criteria.

" - } - }, - "deleteConflictMessage": { - "base": null, - "refs": { - "DeleteConflictException$message": null - } - }, - "duplicateCertificateMessage": { - "base": null, - "refs": { - "DuplicateCertificateException$message": null - } - }, - "duplicateSSHPublicKeyMessage": { - "base": null, - "refs": { - "DuplicateSSHPublicKeyException$message": null - } - }, - "encodingType": { - "base": null, - "refs": { - "GetSSHPublicKeyRequest$Encoding": "

Specifies the public key encoding format to use in the response. To retrieve the public key in ssh-rsa format, use SSH. To retrieve the public key in PEM format, use PEM.

" - } - }, - "entityAlreadyExistsMessage": { - "base": null, - "refs": { - "EntityAlreadyExistsException$message": null - } - }, - "entityDetailsListType": { - "base": null, - "refs": { - "GetServiceLastAccessedDetailsWithEntitiesResponse$EntityDetailsList": "

An EntityDetailsList object that contains details about when an IAM entity (user or role) used group or policy permissions in an attempt to access the specified Amazon Web Services service.

" - } - }, - "entityListType": { - "base": null, - "refs": { - "GetAccountAuthorizationDetailsRequest$Filter": "

A list of entity types used to filter the results. Only the entities that match the types you specify are included in the output. Use the value LocalManagedPolicy to include customer managed policies.

The format for this parameter is a comma-separated (if more than one) list of strings. Each string value in the list must be one of the valid values listed below.

" - } - }, - "entityNameType": { - "base": null, - "refs": { - "PolicyGrantingServiceAccess$EntityName": "

The name of the entity (user or role) to which the inline policy is attached.

This field is null for managed policies. For more information about these policy types, see Managed policies and inline policies in the IAM User Guide.

" - } - }, - "entityTemporarilyUnmodifiableMessage": { - "base": null, - "refs": { - "EntityTemporarilyUnmodifiableException$message": null - } - }, - "existingUserNameType": { - "base": null, - "refs": { - "AddUserToGroupRequest$UserName": "

The name of the user to add.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "CreateAccessKeyRequest$UserName": "

The name of the IAM user that the new key will belong to.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "DeactivateMFADeviceRequest$UserName": "

The name of the user whose MFA device you want to deactivate.

This parameter is optional. If no user name is included, it defaults to the principal making the request. When you make this request with root user credentials, you must use an AssumeRoot session to omit the user name.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "DeleteAccessKeyRequest$UserName": "

The name of the user whose access key pair you want to delete.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "DeleteSigningCertificateRequest$UserName": "

The name of the user the signing certificate belongs to.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "DeleteUserPolicyRequest$UserName": "

The name (friendly name, not ARN) identifying the user that the policy is embedded in.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "DeleteUserRequest$UserName": "

The name of the user to delete.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "EnableMFADeviceRequest$UserName": "

The name of the IAM user for whom you want to enable the MFA device.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "GetAccessKeyLastUsedResponse$UserName": "

The name of the IAM user that owns this access key.

", - "GetUserPolicyRequest$UserName": "

The name of the user who the policy is associated with.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "GetUserPolicyResponse$UserName": "

The user the policy is associated with.

", - "GetUserRequest$UserName": "

The name of the user to get information about.

This parameter is optional. If it is not included, it defaults to the user making the request. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "ListAccessKeysRequest$UserName": "

The name of the user.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "ListGroupsForUserRequest$UserName": "

The name of the user to list groups for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "ListMFADevicesRequest$UserName": "

The name of the user whose MFA devices you want to list.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "ListSigningCertificatesRequest$UserName": "

The name of the IAM user whose signing certificates you want to examine.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "ListUserPoliciesRequest$UserName": "

The name of the user to list policies for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "ListUserTagsRequest$UserName": "

The name of the IAM user whose tags you want to see.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "PutUserPolicyRequest$UserName": "

The name of the user to associate the policy with.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "RemoveUserFromGroupRequest$UserName": "

The name of the user to remove.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "ResyncMFADeviceRequest$UserName": "

The name of the user whose MFA device you want to resynchronize.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "TagUserRequest$UserName": "

The name of the IAM user to which you want to add tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "UntagUserRequest$UserName": "

The name of the IAM user from which you want to remove tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "UpdateAccessKeyRequest$UserName": "

The name of the user whose key you want to update.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "UpdateSigningCertificateRequest$UserName": "

The name of the IAM user the signing certificate belongs to.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "UpdateUserRequest$UserName": "

Name of the user to update. If you're changing the name of the user, this is the original user name.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "UploadSigningCertificateRequest$UserName": "

The name of the user the signing certificate is for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - } - }, - "globalEndpointTokenVersion": { - "base": null, - "refs": { - "SetSecurityTokenServicePreferencesRequest$GlobalEndpointTokenVersion": "

The version of the global endpoint token. Version 1 tokens are valid only in Amazon Web Services Regions that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily store tokens.

For information, see Activating and deactivating STS in an Amazon Web Services Region in the IAM User Guide.

" - } - }, - "groupDetailListType": { - "base": null, - "refs": { - "GetAccountAuthorizationDetailsResponse$GroupDetailList": "

A list containing information about IAM groups.

" - } - }, - "groupListType": { - "base": "

Contains a list of IAM groups.

This data type is used as a response element in the ListGroups operation.

", - "refs": { - "ListGroupsForUserResponse$Groups": "

A list of groups.

", - "ListGroupsResponse$Groups": "

A list of groups.

" - } - }, - "groupNameListType": { - "base": null, - "refs": { - "UserDetail$GroupList": "

A list of IAM groups that the user is in.

" - } - }, - "groupNameType": { - "base": null, - "refs": { - "AddUserToGroupRequest$GroupName": "

The name of the group to update.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "AttachGroupPolicyRequest$GroupName": "

The name (friendly name, not ARN) of the group to attach the policy to.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "CreateGroupRequest$GroupName": "

The name of the group to create. Do not include the path in this value.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both \"MyResource\" and \"myresource\".

", - "CreateServiceLinkedRoleRequest$AWSServiceName": "

The service principal for the Amazon Web Services service to which this role is attached. You use a string similar to a URL but without the http:// in front. For example: elasticbeanstalk.amazonaws.com.

Service principals are unique and case-sensitive. To find the exact service principal for your service-linked role, see Amazon Web Services services that work with IAM in the IAM User Guide. Look for the services that have Yes in the Service-Linked Role column. Choose the Yes link to view the service-linked role documentation for that service.

", - "DeleteGroupPolicyRequest$GroupName": "

The name (friendly name, not ARN) identifying the group that the policy is embedded in.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "DeleteGroupRequest$GroupName": "

The name of the IAM group to delete.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "DetachGroupPolicyRequest$GroupName": "

The name (friendly name, not ARN) of the IAM group to detach the policy from.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "GetGroupPolicyRequest$GroupName": "

The name of the group the policy is associated with.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "GetGroupPolicyResponse$GroupName": "

The group the policy is associated with.

", - "GetGroupRequest$GroupName": "

The name of the group.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "Group$GroupName": "

The friendly name that identifies the group.

", - "GroupDetail$GroupName": "

The friendly name that identifies the group.

", - "ListAttachedGroupPoliciesRequest$GroupName": "

The name (friendly name, not ARN) of the group to list attached policies for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "ListGroupPoliciesRequest$GroupName": "

The name of the group to list policies for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "PolicyGroup$GroupName": "

The name (friendly name, not ARN) identifying the group.

", - "PutGroupPolicyRequest$GroupName": "

The name of the group to associate the policy with.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-.

", - "RemoveUserFromGroupRequest$GroupName": "

The name of the group to update.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "UpdateGroupRequest$GroupName": "

Name of the IAM group to update. If you're changing the name of the group, this is the original name.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "UpdateGroupRequest$NewGroupName": "

New name for the IAM group. Only include this if changing the group's name.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both \"MyResource\" and \"myresource\".

", - "groupNameListType$member": null - } - }, - "idType": { - "base": null, - "refs": { - "EntityInfo$Id": "

The identifier of the entity (user or role).

", - "Group$GroupId": "

The stable and unique string identifying the group. For more information about IDs, see IAM identifiers in the IAM User Guide.

", - "GroupDetail$GroupId": "

The stable and unique string identifying the group. For more information about IDs, see IAM identifiers in the IAM User Guide.

", - "InstanceProfile$InstanceProfileId": "

The stable and unique string identifying the instance profile. For more information about IDs, see IAM identifiers in the IAM User Guide.

", - "ManagedPolicyDetail$PolicyId": "

The stable and unique string identifying the policy.

For more information about IDs, see IAM identifiers in the IAM User Guide.

", - "Policy$PolicyId": "

The stable and unique string identifying the policy.

For more information about IDs, see IAM identifiers in the IAM User Guide.

", - "PolicyGroup$GroupId": "

The stable and unique string identifying the group. For more information about IDs, see IAM identifiers in the IAM User Guide.

", - "PolicyRole$RoleId": "

The stable and unique string identifying the role. For more information about IDs, see IAM identifiers in the IAM User Guide.

", - "PolicyUser$UserId": "

The stable and unique string identifying the user. For more information about IDs, see IAM identifiers in the IAM User Guide.

", - "Role$RoleId": "

The stable and unique string identifying the role. For more information about IDs, see IAM identifiers in the IAM User Guide.

", - "RoleDetail$RoleId": "

The stable and unique string identifying the role. For more information about IDs, see IAM identifiers in the IAM User Guide.

", - "ServerCertificateMetadata$ServerCertificateId": "

The stable and unique string identifying the server certificate. For more information about IDs, see IAM identifiers in the IAM User Guide.

", - "User$UserId": "

The stable and unique string identifying the user. For more information about IDs, see IAM identifiers in the IAM User Guide.

", - "UserDetail$UserId": "

The stable and unique string identifying the user. For more information about IDs, see IAM identifiers in the IAM User Guide.

" - } - }, - "instanceProfileListType": { - "base": "

Contains a list of instance profiles.

", - "refs": { - "ListInstanceProfilesForRoleResponse$InstanceProfiles": "

A list of instance profiles.

", - "ListInstanceProfilesResponse$InstanceProfiles": "

A list of instance profiles.

", - "RoleDetail$InstanceProfileList": "

A list of instance profiles that contain this role.

" - } - }, - "instanceProfileNameType": { - "base": null, - "refs": { - "AddRoleToInstanceProfileRequest$InstanceProfileName": "

The name of the instance profile to update.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "CreateInstanceProfileRequest$InstanceProfileName": "

The name of the instance profile to create.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "DeleteInstanceProfileRequest$InstanceProfileName": "

The name of the instance profile to delete.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "GetInstanceProfileRequest$InstanceProfileName": "

The name of the instance profile to get information about.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "InstanceProfile$InstanceProfileName": "

The name identifying the instance profile.

", - "ListInstanceProfileTagsRequest$InstanceProfileName": "

The name of the IAM instance profile whose tags you want to see.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "RemoveRoleFromInstanceProfileRequest$InstanceProfileName": "

The name of the instance profile to update.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "TagInstanceProfileRequest$InstanceProfileName": "

The name of the IAM instance profile to which you want to add tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "UntagInstanceProfileRequest$InstanceProfileName": "

The name of the IAM instance profile from which you want to remove tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - } - }, - "integerType": { - "base": null, - "refs": { - "AccessDetail$TotalAuthenticatedEntities": "

The number of accounts with authenticated principals (root user, IAM users, and IAM roles) that attempted to access the service in the tracking period.

", - "GetOrganizationsAccessReportResponse$NumberOfServicesAccessible": "

The number of services that the applicable SCPs allow account principals to access.

", - "GetOrganizationsAccessReportResponse$NumberOfServicesNotAccessed": "

The number of services that account principals are allowed but did not attempt to access.

", - "ServiceLastAccessed$TotalAuthenticatedEntities": "

The total number of authenticated principals (root user, IAM users, or IAM roles) that have attempted to access the service.

This field is null if no principals attempted to access the service within the tracking period.

" - } - }, - "invalidAuthenticationCodeMessage": { - "base": null, - "refs": { - "InvalidAuthenticationCodeException$message": null - } - }, - "invalidCertificateMessage": { - "base": null, - "refs": { - "InvalidCertificateException$message": null - } - }, - "invalidInputMessage": { - "base": null, - "refs": { - "InvalidInputException$message": null - } - }, - "invalidPublicKeyMessage": { - "base": null, - "refs": { - "InvalidPublicKeyException$message": null - } - }, - "invalidUserTypeMessage": { - "base": null, - "refs": { - "InvalidUserTypeException$message": null - } - }, - "jobIDType": { - "base": null, - "refs": { - "GenerateOrganizationsAccessReportResponse$JobId": "

The job identifier that you can use in the GetOrganizationsAccessReport operation.

", - "GenerateServiceLastAccessedDetailsResponse$JobId": "

The JobId that you can use in the GetServiceLastAccessedDetails or GetServiceLastAccessedDetailsWithEntities operations. The JobId returned by GenerateServiceLastAccessedDetail must be used by the same role within a session, or by the same user when used to call GetServiceLastAccessedDetail.

", - "GetOrganizationsAccessReportRequest$JobId": "

The identifier of the request generated by the GenerateOrganizationsAccessReport operation.

", - "GetServiceLastAccessedDetailsRequest$JobId": "

The ID of the request generated by the GenerateServiceLastAccessedDetails operation. The JobId returned by GenerateServiceLastAccessedDetail must be used by the same role within a session, or by the same user when used to call GetServiceLastAccessedDetail.

", - "GetServiceLastAccessedDetailsWithEntitiesRequest$JobId": "

The ID of the request generated by the GenerateServiceLastAccessedDetails operation.

" - } - }, - "jobStatusType": { - "base": null, - "refs": { - "GetOrganizationsAccessReportResponse$JobStatus": "

The status of the job.

", - "GetServiceLastAccessedDetailsResponse$JobStatus": "

The status of the job.

", - "GetServiceLastAccessedDetailsWithEntitiesResponse$JobStatus": "

The status of the job.

" - } - }, - "keyPairMismatchMessage": { - "base": null, - "refs": { - "KeyPairMismatchException$message": null - } - }, - "limitExceededMessage": { - "base": null, - "refs": { - "LimitExceededException$message": null - } - }, - "listPolicyGrantingServiceAccessResponseListType": { - "base": null, - "refs": { - "ListPoliciesGrantingServiceAccessResponse$PoliciesGrantingServiceAccess": "

A ListPoliciesGrantingServiceAccess object that contains details about the permissions policies attached to the specified identity (user, group, or role).

" - } - }, - "localeType": { - "base": null, - "refs": { - "GetHumanReadableSummaryRequest$Locale": "

A string representing the locale to use for the summary generation. The supported locale strings are based on the Supported languages of the Amazon Web Services Management Console .

", - "GetHumanReadableSummaryResponse$Locale": "

The locale that this response was generated for. This maps to the input locale.

" - } - }, - "malformedCertificateMessage": { - "base": null, - "refs": { - "MalformedCertificateException$message": null - } - }, - "malformedPolicyDocumentMessage": { - "base": null, - "refs": { - "MalformedPolicyDocumentException$message": null - } - }, - "markerType": { - "base": null, - "refs": { - "GetAccountAuthorizationDetailsRequest$Marker": "

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

", - "GetGroupRequest$Marker": "

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

", - "GetOrganizationsAccessReportRequest$Marker": "

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

", - "GetOrganizationsAccessReportResponse$Marker": "

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", - "GetServiceLastAccessedDetailsRequest$Marker": "

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

", - "GetServiceLastAccessedDetailsWithEntitiesRequest$Marker": "

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

", - "ListAccessKeysRequest$Marker": "

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

", - "ListAccountAliasesRequest$Marker": "

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

", - "ListAttachedGroupPoliciesRequest$Marker": "

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

", - "ListAttachedRolePoliciesRequest$Marker": "

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

", - "ListAttachedUserPoliciesRequest$Marker": "

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

", - "ListDelegationRequestsRequest$Marker": "

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

", - "ListDelegationRequestsResponse$Marker": "

When isTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", - "ListEntitiesForPolicyRequest$Marker": "

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

", - "ListGroupPoliciesRequest$Marker": "

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

", - "ListGroupsForUserRequest$Marker": "

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

", - "ListGroupsRequest$Marker": "

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

", - "ListInstanceProfileTagsRequest$Marker": "

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

", - "ListInstanceProfilesForRoleRequest$Marker": "

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

", - "ListInstanceProfilesRequest$Marker": "

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

", - "ListMFADeviceTagsRequest$Marker": "

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

", - "ListMFADevicesRequest$Marker": "

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

", - "ListOpenIDConnectProviderTagsRequest$Marker": "

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

", - "ListPoliciesGrantingServiceAccessRequest$Marker": "

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

", - "ListPoliciesRequest$Marker": "

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

", - "ListPolicyTagsRequest$Marker": "

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

", - "ListPolicyVersionsRequest$Marker": "

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

", - "ListRolePoliciesRequest$Marker": "

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

", - "ListRoleTagsRequest$Marker": "

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

", - "ListRolesRequest$Marker": "

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

", - "ListSAMLProviderTagsRequest$Marker": "

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

", - "ListSSHPublicKeysRequest$Marker": "

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

", - "ListServerCertificateTagsRequest$Marker": "

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

", - "ListServerCertificatesRequest$Marker": "

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

", - "ListServiceSpecificCredentialsRequest$Marker": "

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker from the response that you received to indicate where the next call should start.

", - "ListSigningCertificatesRequest$Marker": "

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

", - "ListUserPoliciesRequest$Marker": "

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

", - "ListUserTagsRequest$Marker": "

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

", - "ListUsersRequest$Marker": "

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

", - "ListVirtualMFADevicesRequest$Marker": "

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

", - "SimulateCustomPolicyRequest$Marker": "

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

", - "SimulatePrincipalPolicyRequest$Marker": "

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" - } - }, - "maxItemsType": { - "base": null, - "refs": { - "GetAccountAuthorizationDetailsRequest$MaxItems": "

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

", - "GetGroupRequest$MaxItems": "

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

", - "GetOrganizationsAccessReportRequest$MaxItems": "

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

", - "GetServiceLastAccessedDetailsRequest$MaxItems": "

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

", - "GetServiceLastAccessedDetailsWithEntitiesRequest$MaxItems": "

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

", - "ListAccessKeysRequest$MaxItems": "

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

", - "ListAccountAliasesRequest$MaxItems": "

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

", - "ListAttachedGroupPoliciesRequest$MaxItems": "

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

", - "ListAttachedRolePoliciesRequest$MaxItems": "

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

", - "ListAttachedUserPoliciesRequest$MaxItems": "

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

", - "ListDelegationRequestsRequest$MaxItems": "

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM may return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

", - "ListEntitiesForPolicyRequest$MaxItems": "

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

", - "ListGroupPoliciesRequest$MaxItems": "

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

", - "ListGroupsForUserRequest$MaxItems": "

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

", - "ListGroupsRequest$MaxItems": "

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

", - "ListInstanceProfileTagsRequest$MaxItems": "

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

", - "ListInstanceProfilesForRoleRequest$MaxItems": "

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

", - "ListInstanceProfilesRequest$MaxItems": "

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

", - "ListMFADeviceTagsRequest$MaxItems": "

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

", - "ListMFADevicesRequest$MaxItems": "

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

", - "ListOpenIDConnectProviderTagsRequest$MaxItems": "

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

", - "ListPoliciesRequest$MaxItems": "

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

", - "ListPolicyTagsRequest$MaxItems": "

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

", - "ListPolicyVersionsRequest$MaxItems": "

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

", - "ListRolePoliciesRequest$MaxItems": "

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

", - "ListRoleTagsRequest$MaxItems": "

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

", - "ListRolesRequest$MaxItems": "

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

", - "ListSAMLProviderTagsRequest$MaxItems": "

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

", - "ListSSHPublicKeysRequest$MaxItems": "

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

", - "ListServerCertificateTagsRequest$MaxItems": "

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

", - "ListServerCertificatesRequest$MaxItems": "

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

", - "ListServiceSpecificCredentialsRequest$MaxItems": "

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

", - "ListSigningCertificatesRequest$MaxItems": "

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

", - "ListUserPoliciesRequest$MaxItems": "

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

", - "ListUserTagsRequest$MaxItems": "

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

", - "ListUsersRequest$MaxItems": "

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

", - "ListVirtualMFADevicesRequest$MaxItems": "

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

", - "SimulateCustomPolicyRequest$MaxItems": "

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

", - "SimulatePrincipalPolicyRequest$MaxItems": "

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" - } - }, - "maxPasswordAgeType": { - "base": null, - "refs": { - "PasswordPolicy$MaxPasswordAge": "

The number of days that an IAM user password is valid.

", - "UpdateAccountPasswordPolicyRequest$MaxPasswordAge": "

The number of days that an IAM user password is valid.

If you do not specify a value for this parameter, then the operation uses the default value of 0. The result is that IAM user passwords never expire.

" - } - }, - "mfaDeviceListType": { - "base": "

Contains a list of MFA devices.

This data type is used as a response element in the ListMFADevices and ListVirtualMFADevices operations.

", - "refs": { - "ListMFADevicesResponse$MFADevices": "

A list of MFA devices.

" - } - }, - "minimumPasswordLengthType": { - "base": null, - "refs": { - "PasswordPolicy$MinimumPasswordLength": "

Minimum length to require for IAM user passwords.

", - "UpdateAccountPasswordPolicyRequest$MinimumPasswordLength": "

The minimum number of characters allowed in an IAM user password.

If you do not specify a value for this parameter, then the operation uses the default value of 6.

" - } - }, - "noSuchEntityMessage": { - "base": null, - "refs": { - "NoSuchEntityException$message": null - } - }, - "notesType": { - "base": null, - "refs": { - "DelegationRequest$Notes": "

Notes added to this delegation request, if this request was updated via the UpdateDelegationRequest API.

", - "DelegationRequest$RejectionReason": "

Reasons for rejecting this delegation request, if this request was rejected. See also RejectDelegationRequest API documentation.

", - "RejectDelegationRequestRequest$Notes": "

Optional notes explaining the reason for rejecting the delegation request.

", - "UpdateDelegationRequestRequest$Notes": "

Additional notes or comments to add to the delegation request.

" - } - }, - "notificationChannelType": { - "base": null, - "refs": { - "CreateDelegationRequestRequest$NotificationChannel": "

The notification channel for updates about the delegation request.

At this time,only SNS topic ARNs are accepted for notification. This topic ARN must have a resource policy granting SNS:Publish permission to the IAM service principal (iam.amazonaws.com). See partner onboarding documentation for more details.

" - } - }, - "openIdIdpCommunicationErrorExceptionMessage": { - "base": null, - "refs": { - "OpenIdIdpCommunicationErrorException$message": null - } - }, - "organizationsEntityPathType": { - "base": null, - "refs": { - "AccessDetail$EntityPath": "

The path of the Organizations entity (root, organizational unit, or account) from which an authenticated principal last attempted to access the service. Amazon Web Services does not report unauthenticated requests.

This field is null if no principals (IAM users, IAM roles, or root user) in the reported Organizations entity attempted to access the service within the tracking period.

", - "GenerateOrganizationsAccessReportRequest$EntityPath": "

The path of the Organizations entity (root, OU, or account). You can build an entity path using the known structure of your organization. For example, assume that your account ID is 123456789012 and its parent OU ID is ou-rge0-awsabcde. The organization root ID is r-f6g7h8i9j0example and your organization ID is o-a1b2c3d4e5. Your entity path is o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-rge0-awsabcde/123456789012.

" - } - }, - "organizationsPolicyIdType": { - "base": null, - "refs": { - "GenerateOrganizationsAccessReportRequest$OrganizationsPolicyId": "

The identifier of the Organizations service control policy (SCP). This parameter is optional.

This ID is used to generate information about when an account principal that is limited by the SCP attempted to access an Amazon Web Services service.

" - } - }, - "ownerIdType": { - "base": null, - "refs": { - "DelegationRequest$OwnerId": "

ARN of the owner of this delegation request.

", - "ListDelegationRequestsRequest$OwnerId": "

The owner ID to filter delegation requests by.

" - } - }, - "passwordPolicyViolationMessage": { - "base": null, - "refs": { - "PasswordPolicyViolationException$message": null - } - }, - "passwordReusePreventionType": { - "base": null, - "refs": { - "PasswordPolicy$PasswordReusePrevention": "

Specifies the number of previous passwords that IAM users are prevented from reusing.

", - "UpdateAccountPasswordPolicyRequest$PasswordReusePrevention": "

Specifies the number of previous passwords that IAM users are prevented from reusing.

If you do not specify a value for this parameter, then the operation uses the default value of 0. The result is that IAM users are not prevented from reusing previous passwords.

" - } - }, - "passwordType": { - "base": null, - "refs": { - "ChangePasswordRequest$OldPassword": "

The IAM user's current password.

", - "ChangePasswordRequest$NewPassword": "

The new password. The new password must conform to the Amazon Web Services account's password policy, if one exists.

The regex pattern that is used to validate this parameter is a string of characters. That string can include almost any printable ASCII character from the space (\\u0020) through the end of the ASCII character range (\\u00FF). You can also include the tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D) characters. Any of these characters are valid in a password. However, many tools, such as the Amazon Web Services Management Console, might restrict the ability to type certain characters because they have special meaning within that tool.

", - "CreateLoginProfileRequest$Password": "

The new password for the user.

This parameter must be omitted when you make the request with an AssumeRoot session. It is required in all other cases.

The regex pattern that is used to validate this parameter is a string of characters. That string can include almost any printable ASCII character from the space (\\u0020) through the end of the ASCII character range (\\u00FF). You can also include the tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D) characters. Any of these characters are valid in a password. However, many tools, such as the Amazon Web Services Management Console, might restrict the ability to type certain characters because they have special meaning within that tool.

", - "UpdateLoginProfileRequest$Password": "

The new password for the specified IAM user.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

However, the format can be further restricted by the account administrator by setting a password policy on the Amazon Web Services account. For more information, see UpdateAccountPasswordPolicy.

" - } - }, - "pathPrefixType": { - "base": null, - "refs": { - "ListGroupsRequest$PathPrefix": "

The path prefix for filtering the results. For example, the prefix /division_abc/subdivision_xyz/ gets all groups whose path starts with /division_abc/subdivision_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all groups. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

", - "ListInstanceProfilesRequest$PathPrefix": "

The path prefix for filtering the results. For example, the prefix /application_abc/component_xyz/ gets all instance profiles whose path starts with /application_abc/component_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all instance profiles. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

", - "ListRolesRequest$PathPrefix": "

The path prefix for filtering the results. For example, the prefix /application_abc/component_xyz/ gets all roles whose path starts with /application_abc/component_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all roles. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

", - "ListServerCertificatesRequest$PathPrefix": "

The path prefix for filtering the results. For example: /company/servercerts would get all server certificates for which the path starts with /company/servercerts.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all server certificates. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

", - "ListUsersRequest$PathPrefix": "

The path prefix for filtering the results. For example: /division_abc/subdivision_xyz/, which would get all user names whose path starts with /division_abc/subdivision_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all user names. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" - } - }, - "pathType": { - "base": null, - "refs": { - "CreateGroupRequest$Path": "

The path to the group. For more information about paths, see IAM identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

", - "CreateInstanceProfileRequest$Path": "

The path to the instance profile. For more information about paths, see IAM Identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

", - "CreateRoleRequest$Path": "

The path to the role. For more information about paths, see IAM Identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

", - "CreateUserRequest$Path": "

The path for the user name. For more information about paths, see IAM identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

", - "CreateVirtualMFADeviceRequest$Path": "

The path for the virtual MFA device. For more information about paths, see IAM identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

", - "EntityInfo$Path": "

The path to the entity (user or role). For more information about paths, see IAM identifiers in the IAM User Guide.

", - "Group$Path": "

The path to the group. For more information about paths, see IAM identifiers in the IAM User Guide.

", - "GroupDetail$Path": "

The path to the group. For more information about paths, see IAM identifiers in the IAM User Guide.

", - "InstanceProfile$Path": "

The path to the instance profile. For more information about paths, see IAM identifiers in the IAM User Guide.

", - "ListEntitiesForPolicyRequest$PathPrefix": "

The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all entities.

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

", - "Role$Path": "

The path to the role. For more information about paths, see IAM identifiers in the IAM User Guide.

", - "RoleDetail$Path": "

The path to the role. For more information about paths, see IAM identifiers in the IAM User Guide.

", - "ServerCertificateMetadata$Path": "

The path to the server certificate. For more information about paths, see IAM identifiers in the IAM User Guide.

", - "UpdateGroupRequest$NewPath": "

New path for the IAM group. Only include this if changing the group's path.

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

", - "UpdateServerCertificateRequest$NewPath": "

The new path for the server certificate. Include this only if you are updating the server certificate's path.

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

", - "UpdateUserRequest$NewPath": "

New path for the IAM user. Include this parameter only if you're changing the user's path.

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

", - "UploadServerCertificateRequest$Path": "

The path for the server certificate. For more information about paths, see IAM identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

If you are uploading a server certificate specifically for use with Amazon CloudFront distributions, you must specify a path using the path parameter. The path must begin with /cloudfront and must include a trailing slash (for example, /cloudfront/test/).

", - "User$Path": "

The path to the user. For more information about paths, see IAM identifiers in the IAM User Guide.

The ARN of the policy used to set the permissions boundary for the user.

", - "UserDetail$Path": "

The path to the user. For more information about paths, see IAM identifiers in the IAM User Guide.

" - } - }, - "permissionCheckResultType": { - "base": null, - "refs": { - "GetDelegationRequestResponse$PermissionCheckResult": "

The result of the permission check, indicating whether the caller has sufficient permissions to cover the requested permissions. This is an approximate result.

  • ALLOWED : The caller has sufficient permissions cover all the requested permissions.

  • DENIED : The caller does not have sufficient permissions to cover all the requested permissions.

  • UNSURE : It is not possible to determine whether the caller has all the permissions needed. This output is most likely for cases when the caller has permissions with conditions.

" - } - }, - "permissionCheckStatusType": { - "base": null, - "refs": { - "GetDelegationRequestResponse$PermissionCheckStatus": "

The status of the permission check for the delegation request.

This value indicates the status of the process to check whether the caller has sufficient permissions to cover the requested actions in the delegation request. Since this is an asynchronous process, there are three potential values:

  • IN_PROGRESS : The permission check process has started.

  • COMPLETED : The permission check process has completed. The PermissionCheckResult will include the result.

  • FAILED : The permission check process has failed.

" - } - }, - "permissionType": { - "base": null, - "refs": { - "DelegationRequest$PermissionPolicy": "

JSON content of the associated permission policy of this delegation request.

" - } - }, - "policyDescriptionType": { - "base": null, - "refs": { - "CreatePolicyRequest$Description": "

A friendly description of the policy.

Typically used to store information about the permissions defined in the policy. For example, \"Grants access to production DynamoDB tables.\"

The policy description is immutable. After a value is assigned, it cannot be changed.

", - "ManagedPolicyDetail$Description": "

A friendly description of the policy.

", - "Policy$Description": "

A friendly description of the policy.

This element is included in the response to the GetPolicy operation. It is not included in the response to the ListPolicies operation.

" - } - }, - "policyDetailListType": { - "base": null, - "refs": { - "GroupDetail$GroupPolicyList": "

A list of the inline policies embedded in the group.

", - "RoleDetail$RolePolicyList": "

A list of inline policies embedded in the role. These policies are the role's access (permissions) policies.

", - "UserDetail$UserPolicyList": "

A list of the inline policies embedded in the user.

" - } - }, - "policyDocumentType": { - "base": null, - "refs": { - "CreatePolicyRequest$PolicyDocument": "

The JSON policy document that you want to use as the content for the new policy.

You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

To learn more about JSON policy grammar, see Grammar of the IAM JSON policy language in the IAM User Guide.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

", - "CreatePolicyVersionRequest$PolicyDocument": "

The JSON policy document that you want to use as the content for this new version of the policy.

You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

", - "CreateRoleRequest$AssumeRolePolicyDocument": "

The trust relationship policy document that grants an entity permission to assume the role.

In IAM, you must provide a JSON policy that has been converted to a string. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

Upon success, the response includes the same trust policy in JSON format.

", - "GetGroupPolicyResponse$PolicyDocument": "

The policy document.

IAM stores policies in JSON format. However, resources that were created using CloudFormation templates can be formatted in YAML. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

", - "GetRolePolicyResponse$PolicyDocument": "

The policy document.

IAM stores policies in JSON format. However, resources that were created using CloudFormation templates can be formatted in YAML. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

", - "GetUserPolicyResponse$PolicyDocument": "

The policy document.

IAM stores policies in JSON format. However, resources that were created using CloudFormation templates can be formatted in YAML. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

", - "PolicyDetail$PolicyDocument": "

The policy document.

", - "PolicyVersion$Document": "

The policy document.

The policy document is returned in the response to the GetPolicyVersion and GetAccountAuthorizationDetails operations. It is not returned in the response to the CreatePolicyVersion or ListPolicyVersions operations.

The policy document returned in this structure is URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.

", - "PutGroupPolicyRequest$PolicyDocument": "

The policy document.

You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

", - "PutRolePolicyRequest$PolicyDocument": "

The policy document.

You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

", - "PutUserPolicyRequest$PolicyDocument": "

The policy document.

You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

", - "Role$AssumeRolePolicyDocument": "

The policy that grants an entity permission to assume the role.

", - "RoleDetail$AssumeRolePolicyDocument": "

The trust policy that grants permission to assume the role.

", - "SimulateCustomPolicyRequest$ResourcePolicy": "

A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation.

The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

Simulation of resource-based policies isn't supported for IAM roles.

", - "SimulatePrincipalPolicyRequest$ResourcePolicy": "

A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation.

The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

Simulation of resource-based policies isn't supported for IAM roles.

", - "SimulationPolicyListType$member": null, - "UpdateAssumeRolePolicyRequest$PolicyDocument": "

The policy that grants an entity permission to assume the role.

You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" - } - }, - "policyDocumentVersionListType": { - "base": null, - "refs": { - "ListPolicyVersionsResponse$Versions": "

A list of policy versions.

For more information about managed policy versions, see Versioning for managed policies in the IAM User Guide.

", - "ManagedPolicyDetail$PolicyVersionList": "

A list containing information about the versions of the policy.

" - } - }, - "policyEvaluationErrorMessage": { - "base": null, - "refs": { - "PolicyEvaluationException$message": null - } - }, - "policyGrantingServiceAccessListType": { - "base": null, - "refs": { - "ListPoliciesGrantingServiceAccessEntry$Policies": "

The PoliciesGrantingServiceAccess object that contains details about the policy.

" - } - }, - "policyListType": { - "base": null, - "refs": { - "ListPoliciesResponse$Policies": "

A list of policies.

" - } - }, - "policyNameListType": { - "base": "

Contains a list of policy names.

This data type is used as a response element in the ListPolicies operation.

", - "refs": { - "ListGroupPoliciesResponse$PolicyNames": "

A list of policy names.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "ListRolePoliciesResponse$PolicyNames": "

A list of policy names.

", - "ListUserPoliciesResponse$PolicyNames": "

A list of policy names.

" - } - }, - "policyNameType": { - "base": null, - "refs": { - "AttachedPolicy$PolicyName": "

The friendly name of the attached policy.

", - "CreatePolicyRequest$PolicyName": "

The friendly name of the policy.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both \"MyResource\" and \"myresource\".

", - "DeleteGroupPolicyRequest$PolicyName": "

The name identifying the policy document to delete.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "DeleteRolePolicyRequest$PolicyName": "

The name of the inline policy to delete from the specified IAM role.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "DeleteUserPolicyRequest$PolicyName": "

The name identifying the policy document to delete.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "GetGroupPolicyRequest$PolicyName": "

The name of the policy document to get.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "GetGroupPolicyResponse$PolicyName": "

The name of the policy.

", - "GetRolePolicyRequest$PolicyName": "

The name of the policy document to get.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "GetRolePolicyResponse$PolicyName": "

The name of the policy.

", - "GetUserPolicyRequest$PolicyName": "

The name of the policy document to get.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "GetUserPolicyResponse$PolicyName": "

The name of the policy.

", - "InlinePolicyIdentifierType$PolicyName": "

The name of the inline policy.

", - "ManagedPolicyDetail$PolicyName": "

The friendly name (not ARN) identifying the policy.

", - "Policy$PolicyName": "

The friendly name (not ARN) identifying the policy.

", - "PolicyDetail$PolicyName": "

The name of the policy.

", - "PolicyGrantingServiceAccess$PolicyName": "

The policy name.

", - "PutGroupPolicyRequest$PolicyName": "

The name of the policy document.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "PutRolePolicyRequest$PolicyName": "

The name of the policy document.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "PutUserPolicyRequest$PolicyName": "

The name of the policy document.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "policyNameListType$member": null - } - }, - "policyNotAttachableMessage": { - "base": null, - "refs": { - "PolicyNotAttachableException$message": null - } - }, - "policyOwnerEntityType": { - "base": null, - "refs": { - "EntityInfo$Type": "

The type of entity (user or role).

", - "PolicyGrantingServiceAccess$EntityType": "

The type of entity (user or role) that used the policy to access the service to which the inline policy is attached.

This field is null for managed policies. For more information about these policy types, see Managed policies and inline policies in the IAM User Guide.

" - } - }, - "policyParameterListType": { - "base": null, - "refs": { - "DelegationPermission$Parameters": "

A list of policy parameters that define the scope and constraints of the delegated permissions.

" - } - }, - "policyParameterNameType": { - "base": null, - "refs": { - "PolicyParameter$Name": "

The name of the policy parameter.

" - } - }, - "policyParameterValueType": { - "base": null, - "refs": { - "policyParameterValuesListType$member": null - } - }, - "policyParameterValuesListType": { - "base": null, - "refs": { - "PolicyParameter$Values": "

The allowed values for the policy parameter.

" - } - }, - "policyPathType": { - "base": null, - "refs": { - "CreatePolicyRequest$Path": "

The path for the policy.

For more information about paths, see IAM identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

You cannot use an asterisk (*) in the path name.

", - "ListAttachedGroupPoliciesRequest$PathPrefix": "

The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

", - "ListAttachedRolePoliciesRequest$PathPrefix": "

The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

", - "ListAttachedUserPoliciesRequest$PathPrefix": "

The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

", - "ListPoliciesRequest$PathPrefix": "

The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

", - "ManagedPolicyDetail$Path": "

The path to the policy.

For more information about paths, see IAM identifiers in the IAM User Guide.

", - "Policy$Path": "

The path to the policy.

For more information about paths, see IAM identifiers in the IAM User Guide.

" - } - }, - "policyScopeType": { - "base": null, - "refs": { - "ListPoliciesRequest$Scope": "

The scope to use for filtering the results.

To list only Amazon Web Services managed policies, set Scope to AWS. To list only the customer managed policies in your Amazon Web Services account, set Scope to Local.

This parameter is optional. If it is not included, or if it is set to All, all policies are returned.

" - } - }, - "policyType": { - "base": null, - "refs": { - "PolicyGrantingServiceAccess$PolicyType": "

The policy type. For more information about these policy types, see Managed policies and inline policies in the IAM User Guide.

" - } - }, - "policyVersionIdType": { - "base": null, - "refs": { - "DeletePolicyVersionRequest$VersionId": "

The policy version to delete.

This parameter allows (through its regex pattern) a string of characters that consists of the lowercase letter 'v' followed by one or two digits, and optionally followed by a period '.' and a string of letters and digits.

For more information about managed policy versions, see Versioning for managed policies in the IAM User Guide.

", - "GetPolicyVersionRequest$VersionId": "

Identifies the policy version to retrieve.

This parameter allows (through its regex pattern) a string of characters that consists of the lowercase letter 'v' followed by one or two digits, and optionally followed by a period '.' and a string of letters and digits.

", - "ManagedPolicyDetail$DefaultVersionId": "

The identifier for the version of the policy that is set as the default (operative) version.

For more information about policy versions, see Versioning for managed policies in the IAM User Guide.

", - "Policy$DefaultVersionId": "

The identifier for the version of the policy that is set as the default version.

", - "PolicyVersion$VersionId": "

The identifier for the policy version.

Policy version identifiers always begin with v (always lowercase). When a policy is created, the first policy version is v1.

", - "SetDefaultPolicyVersionRequest$VersionId": "

The version of the policy to set as the default (operative) version.

For more information about managed policy versions, see Versioning for managed policies in the IAM User Guide.

" - } - }, - "privateKeyIdType": { - "base": null, - "refs": { - "GetSAMLProviderResponse$SAMLProviderUUID": "

The unique identifier assigned to the SAML provider.

", - "SAMLPrivateKey$KeyId": "

The unique identifier for the SAML private key.

", - "UpdateSAMLProviderRequest$RemovePrivateKey": "

The Key ID of the private key to remove.

" - } - }, - "privateKeyList": { - "base": null, - "refs": { - "GetSAMLProviderResponse$PrivateKeyList": "

The private key metadata for the SAML provider.

" - } - }, - "privateKeyType": { - "base": null, - "refs": { - "CreateSAMLProviderRequest$AddPrivateKey": "

The private key generated from your external identity provider. The private key must be a .pem file that uses AES-GCM or AES-CBC encryption algorithm to decrypt SAML assertions.

", - "UpdateSAMLProviderRequest$AddPrivateKey": "

Specifies the new private key from your external identity provider. The private key must be a .pem file that uses AES-GCM or AES-CBC encryption algorithm to decrypt SAML assertions.

", - "UploadServerCertificateRequest$PrivateKey": "

The contents of the private key in PEM-encoded format.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" - } - }, - "publicKeyFingerprintType": { - "base": null, - "refs": { - "SSHPublicKey$Fingerprint": "

The MD5 message digest of the SSH public key.

" - } - }, - "publicKeyIdType": { - "base": null, - "refs": { - "DeleteSSHPublicKeyRequest$SSHPublicKeyId": "

The unique identifier for the SSH public key.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

", - "GetSSHPublicKeyRequest$SSHPublicKeyId": "

The unique identifier for the SSH public key.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

", - "SSHPublicKey$SSHPublicKeyId": "

The unique identifier for the SSH public key.

", - "SSHPublicKeyMetadata$SSHPublicKeyId": "

The unique identifier for the SSH public key.

", - "UpdateSSHPublicKeyRequest$SSHPublicKeyId": "

The unique identifier for the SSH public key.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

" - } - }, - "publicKeyMaterialType": { - "base": null, - "refs": { - "SSHPublicKey$SSHPublicKeyBody": "

The SSH public key.

", - "UploadSSHPublicKeyRequest$SSHPublicKeyBody": "

The SSH public key. The public key must be encoded in ssh-rsa format or PEM format. The minimum bit-length of the public key is 2048 bits. For example, you can generate a 2048-bit key, and the resulting PEM file is 1679 bytes long.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" - } - }, - "redirectUrlType": { - "base": null, - "refs": { - "CreateDelegationRequestRequest$RedirectUrl": "

The URL to redirect to after the delegation request is processed.

This URL is used by the IAM console to show a link to the customer to re-load the partner workflow.

", - "DelegationRequest$RedirectUrl": "

A URL to be redirected to once the delegation request is approved. Partners provide this URL when creating the delegation request.

" - } - }, - "reportGenerationLimitExceededMessage": { - "base": null, - "refs": { - "ReportGenerationLimitExceededException$message": null - } - }, - "requestMessageType": { - "base": null, - "refs": { - "CreateDelegationRequestRequest$RequestMessage": "

A message explaining the reason for the delegation request.

Requesters can utilize this field to add a custom note to the delegation request. This field is different from the description such that this is to be utilized for a custom messaging on a case-by-case basis.

For example, if the current delegation request is in response to a previous request being rejected, this explanation can be added to the request via this field.

", - "DelegationRequest$RequestMessage": "

A custom message that is added to the delegation request by the partner.

This element is different from the Description element such that this is a request specific message injected by the partner. The Description is typically a generic explanation of what the delegation request is targeted to do.

" - } - }, - "requestorNameType": { - "base": null, - "refs": { - "DelegationRequest$RequestorName": "

A friendly name of the requestor.

" - } - }, - "requestorWorkflowIdType": { - "base": null, - "refs": { - "CreateDelegationRequestRequest$RequestorWorkflowId": "

The workflow ID associated with the requestor.

This is the unique identifier on the partner side that can be used to track the progress of the request.

IAM maintains a uniqueness check on this workflow id for each request - if a workflow id for an existing request is passed, this API call will fail.

" - } - }, - "responseMarkerType": { - "base": null, - "refs": { - "GetAccountAuthorizationDetailsResponse$Marker": "

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", - "GetGroupResponse$Marker": "

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", - "GetServiceLastAccessedDetailsResponse$Marker": "

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", - "GetServiceLastAccessedDetailsWithEntitiesResponse$Marker": "

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", - "ListAccessKeysResponse$Marker": "

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", - "ListAccountAliasesResponse$Marker": "

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", - "ListAttachedGroupPoliciesResponse$Marker": "

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", - "ListAttachedRolePoliciesResponse$Marker": "

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", - "ListAttachedUserPoliciesResponse$Marker": "

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", - "ListEntitiesForPolicyResponse$Marker": "

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", - "ListGroupPoliciesResponse$Marker": "

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", - "ListGroupsForUserResponse$Marker": "

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", - "ListGroupsResponse$Marker": "

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", - "ListInstanceProfileTagsResponse$Marker": "

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", - "ListInstanceProfilesForRoleResponse$Marker": "

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", - "ListInstanceProfilesResponse$Marker": "

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", - "ListMFADeviceTagsResponse$Marker": "

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", - "ListMFADevicesResponse$Marker": "

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", - "ListOpenIDConnectProviderTagsResponse$Marker": "

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", - "ListPoliciesGrantingServiceAccessResponse$Marker": "

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", - "ListPoliciesResponse$Marker": "

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", - "ListPolicyTagsResponse$Marker": "

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", - "ListPolicyVersionsResponse$Marker": "

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", - "ListRolePoliciesResponse$Marker": "

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", - "ListRoleTagsResponse$Marker": "

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", - "ListRolesResponse$Marker": "

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", - "ListSAMLProviderTagsResponse$Marker": "

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", - "ListSSHPublicKeysResponse$Marker": "

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", - "ListServerCertificateTagsResponse$Marker": "

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", - "ListServerCertificatesResponse$Marker": "

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", - "ListServiceSpecificCredentialsResponse$Marker": "

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", - "ListSigningCertificatesResponse$Marker": "

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", - "ListUserPoliciesResponse$Marker": "

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", - "ListUserTagsResponse$Marker": "

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", - "ListUsersResponse$Marker": "

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", - "ListVirtualMFADevicesResponse$Marker": "

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", - "SimulatePolicyResponse$Marker": "

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" - } - }, - "roleDescriptionType": { - "base": null, - "refs": { - "CreateRoleRequest$Description": "

A description of the role.

", - "CreateServiceLinkedRoleRequest$Description": "

The description of the role.

", - "Role$Description": "

A description of the role that you provide.

", - "UpdateRoleDescriptionRequest$Description": "

The new description that you want to apply to the specified role.

", - "UpdateRoleRequest$Description": "

The new description that you want to apply to the specified role.

" - } - }, - "roleDetailListType": { - "base": null, - "refs": { - "GetAccountAuthorizationDetailsResponse$RoleDetailList": "

A list containing information about IAM roles.

" - } - }, - "roleListType": { - "base": "

Contains a list of IAM roles.

This data type is used as a response element in the ListRoles operation.

", - "refs": { - "InstanceProfile$Roles": "

The role associated with the instance profile.

", - "ListRolesResponse$Roles": "

A list of roles.

" - } - }, - "roleMaxSessionDurationType": { - "base": null, - "refs": { - "CreateRoleRequest$MaxSessionDuration": "

The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours.

Anyone who assumes the role from the CLI or API can use the DurationSeconds API parameter or the duration-seconds CLI parameter to request a longer session. The MaxSessionDuration setting determines the maximum duration that can be requested using the DurationSeconds parameter. If users don't specify a value for the DurationSeconds parameter, their security credentials are valid for one hour by default. This applies when you use the AssumeRole* API operations or the assume-role* CLI operations but does not apply when you use those operations to create a console URL. For more information, see Using IAM roles in the IAM User Guide.

", - "Role$MaxSessionDuration": "

The maximum session duration (in seconds) for the specified role. Anyone who uses the CLI, or API to assume the role can specify the duration using the optional DurationSeconds API parameter or duration-seconds CLI parameter.

", - "UpdateRoleRequest$MaxSessionDuration": "

The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours.

Anyone who assumes the role from the CLI or API can use the DurationSeconds API parameter or the duration-seconds CLI parameter to request a longer session. The MaxSessionDuration setting determines the maximum duration that can be requested using the DurationSeconds parameter. If users don't specify a value for the DurationSeconds parameter, their security credentials are valid for one hour by default. This applies when you use the AssumeRole* API operations or the assume-role* CLI operations but does not apply when you use those operations to create a console URL. For more information, see Using IAM roles in the IAM User Guide.

IAM role credentials provided by Amazon EC2 instances assigned to the role are not subject to the specified maximum session duration.

" - } - }, - "roleNameType": { - "base": null, - "refs": { - "AddRoleToInstanceProfileRequest$RoleName": "

The name of the role to add.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "AttachRolePolicyRequest$RoleName": "

The name (friendly name, not ARN) of the role to attach the policy to.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "CreateRoleRequest$RoleName": "

The name of the role to create.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both \"MyResource\" and \"myresource\".

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "DeleteRolePermissionsBoundaryRequest$RoleName": "

The name (friendly name, not ARN) of the IAM role from which you want to remove the permissions boundary.

", - "DeleteRolePolicyRequest$RoleName": "

The name (friendly name, not ARN) identifying the role that the policy is embedded in.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "DeleteRoleRequest$RoleName": "

The name of the role to delete.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "DeleteServiceLinkedRoleRequest$RoleName": "

The name of the service-linked role to be deleted.

", - "DetachRolePolicyRequest$RoleName": "

The name (friendly name, not ARN) of the IAM role to detach the policy from.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "GetRolePolicyRequest$RoleName": "

The name of the role associated with the policy.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "GetRolePolicyResponse$RoleName": "

The role the policy is associated with.

", - "GetRoleRequest$RoleName": "

The name of the IAM role to get information about.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "ListAttachedRolePoliciesRequest$RoleName": "

The name (friendly name, not ARN) of the role to list attached policies for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "ListInstanceProfilesForRoleRequest$RoleName": "

The name of the role to list instance profiles for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "ListRolePoliciesRequest$RoleName": "

The name of the role to list policies for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "ListRoleTagsRequest$RoleName": "

The name of the IAM role for which you want to see the list of tags.

This parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "PolicyRole$RoleName": "

The name (friendly name, not ARN) identifying the role.

", - "PutRolePermissionsBoundaryRequest$RoleName": "

The name (friendly name, not ARN) of the IAM role for which you want to set the permissions boundary.

", - "PutRolePolicyRequest$RoleName": "

The name of the role to associate the policy with.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "RemoveRoleFromInstanceProfileRequest$RoleName": "

The name of the role to remove.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "Role$RoleName": "

The friendly name that identifies the role.

", - "RoleDetail$RoleName": "

The friendly name that identifies the role.

", - "TagRoleRequest$RoleName": "

The name of the IAM role to which you want to add tags.

This parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "UntagRoleRequest$RoleName": "

The name of the IAM role from which you want to remove tags.

This parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "UpdateAssumeRolePolicyRequest$RoleName": "

The name of the role to update with the new policy.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "UpdateRoleDescriptionRequest$RoleName": "

The name of the role that you want to modify.

", - "UpdateRoleRequest$RoleName": "

The name of the role that you want to modify.

" - } - }, - "rolePermissionRestrictionArnListType": { - "base": null, - "refs": { - "DelegationRequest$RolePermissionRestrictionArns": "

If the PermissionPolicy includes role creation permissions, this element will include the list of permissions boundary policies associated with the role creation. See Permissions boundaries for IAM entities for more details about IAM permission boundaries.

" - } - }, - "serialNumberType": { - "base": null, - "refs": { - "DeactivateMFADeviceRequest$SerialNumber": "

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@:/-

", - "DeleteVirtualMFADeviceRequest$SerialNumber": "

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the same as the ARN.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@:/-

", - "EnableMFADeviceRequest$SerialNumber": "

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@:/-

", - "GetMFADeviceRequest$SerialNumber": "

Serial number that uniquely identifies the MFA device. For this API, we only accept FIDO security key ARNs.

", - "GetMFADeviceResponse$SerialNumber": "

Serial number that uniquely identifies the MFA device. For this API, we only accept FIDO security key ARNs.

", - "ListMFADeviceTagsRequest$SerialNumber": "

The unique identifier for the IAM virtual MFA device whose tags you want to see. For virtual MFA devices, the serial number is the same as the ARN.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "MFADevice$SerialNumber": "

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.

", - "ResyncMFADeviceRequest$SerialNumber": "

Serial number that uniquely identifies the MFA device.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "TagMFADeviceRequest$SerialNumber": "

The unique identifier for the IAM virtual MFA device to which you want to add tags. For virtual MFA devices, the serial number is the same as the ARN.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "UntagMFADeviceRequest$SerialNumber": "

The unique identifier for the IAM virtual MFA device from which you want to remove tags. For virtual MFA devices, the serial number is the same as the ARN.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "VirtualMFADevice$SerialNumber": "

The serial number associated with VirtualMFADevice.

" - } - }, - "serverCertificateMetadataListType": { - "base": null, - "refs": { - "ListServerCertificatesResponse$ServerCertificateMetadataList": "

A list of server certificates.

" - } - }, - "serverCertificateNameType": { - "base": null, - "refs": { - "DeleteServerCertificateRequest$ServerCertificateName": "

The name of the server certificate you want to delete.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "GetServerCertificateRequest$ServerCertificateName": "

The name of the server certificate you want to retrieve information about.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "ListServerCertificateTagsRequest$ServerCertificateName": "

The name of the IAM server certificate whose tags you want to see.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "ServerCertificateMetadata$ServerCertificateName": "

The name that identifies the server certificate.

", - "TagServerCertificateRequest$ServerCertificateName": "

The name of the IAM server certificate to which you want to add tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "UntagServerCertificateRequest$ServerCertificateName": "

The name of the IAM server certificate from which you want to remove tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "UpdateServerCertificateRequest$ServerCertificateName": "

The name of the server certificate that you want to update.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "UpdateServerCertificateRequest$NewServerCertificateName": "

The new name for the server certificate. Include this only if you are updating the server certificate's name. The name of the certificate cannot contain any spaces.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "UploadServerCertificateRequest$ServerCertificateName": "

The name for the server certificate. Do not include the path in this value. The name of the certificate cannot contain any spaces.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - } - }, - "serviceCredentialAlias": { - "base": null, - "refs": { - "ServiceSpecificCredential$ServiceCredentialAlias": "

For Bedrock API keys and CloudWatch Logs API keys, this is the public portion of the credential that includes the IAM user name and a suffix containing version and creation information.

", - "ServiceSpecificCredentialMetadata$ServiceCredentialAlias": "

For Bedrock API keys and CloudWatch Logs API keys, this is the public portion of the credential that includes the IAM user name and a suffix containing version and creation information.

" - } - }, - "serviceCredentialSecret": { - "base": null, - "refs": { - "ServiceSpecificCredential$ServiceCredentialSecret": "

For Bedrock API keys and CloudWatch Logs API keys, this is the secret portion of the credential that should be used to authenticate API calls. This value is returned only when the credential is created.

" - } - }, - "serviceFailureExceptionMessage": { - "base": null, - "refs": { - "ServiceFailureException$message": null - } - }, - "serviceName": { - "base": null, - "refs": { - "CreateServiceSpecificCredentialRequest$ServiceName": "

The name of the Amazon Web Services service that is to be associated with the credentials. The service you specify here is the only service that can be accessed using these credentials.

", - "ListServiceSpecificCredentialsRequest$ServiceName": "

Filters the returned results to only those for the specified Amazon Web Services service. If not specified, then Amazon Web Services returns service-specific credentials for all services.

", - "ServiceSpecificCredential$ServiceName": "

The name of the service associated with the service-specific credential.

", - "ServiceSpecificCredentialMetadata$ServiceName": "

The name of the service associated with the service-specific credential.

" - } - }, - "serviceNameType": { - "base": null, - "refs": { - "AccessDetail$ServiceName": "

The name of the service in which access was attempted.

", - "ServiceLastAccessed$ServiceName": "

The name of the service in which access was attempted.

" - } - }, - "serviceNamespaceListType": { - "base": null, - "refs": { - "ListPoliciesGrantingServiceAccessRequest$ServiceNamespaces": "

The service namespace for the Amazon Web Services services whose policies you want to list.

To learn the service namespace for a service, see Actions, resources, and condition keys for Amazon Web Services services in the IAM User Guide. Choose the name of the service to view details for that service. In the first paragraph, find the service prefix. For example, (service prefix: a4b). For more information about service namespaces, see Amazon Web Services service namespaces in the Amazon Web Services General Reference.

" - } - }, - "serviceNamespaceType": { - "base": null, - "refs": { - "AccessDetail$ServiceNamespace": "

The namespace of the service in which access was attempted.

To learn the service namespace of a service, see Actions, resources, and condition keys for Amazon Web Services services in the Service Authorization Reference. Choose the name of the service to view details for that service. In the first paragraph, find the service prefix. For example, (service prefix: a4b). For more information about service namespaces, see Amazon Web Services service namespaces in the Amazon Web Services General Reference.

", - "GetServiceLastAccessedDetailsWithEntitiesRequest$ServiceNamespace": "

The service namespace for an Amazon Web Services service. Provide the service namespace to learn when the IAM entity last attempted to access the specified service.

To learn the service namespace for a service, see Actions, resources, and condition keys for Amazon Web Services services in the IAM User Guide. Choose the name of the service to view details for that service. In the first paragraph, find the service prefix. For example, (service prefix: a4b). For more information about service namespaces, see Amazon Web Services service namespaces in the Amazon Web Services General Reference.

", - "ListPoliciesGrantingServiceAccessEntry$ServiceNamespace": "

The namespace of the service that was accessed.

To learn the service namespace of a service, see Actions, resources, and condition keys for Amazon Web Services services in the Service Authorization Reference. Choose the name of the service to view details for that service. In the first paragraph, find the service prefix. For example, (service prefix: a4b). For more information about service namespaces, see Amazon Web Services service namespaces in the Amazon Web Services General Reference.

", - "ServiceLastAccessed$ServiceNamespace": "

The namespace of the service in which access was attempted.

To learn the service namespace of a service, see Actions, resources, and condition keys for Amazon Web Services services in the Service Authorization Reference. Choose the name of the service to view details for that service. In the first paragraph, find the service prefix. For example, (service prefix: a4b). For more information about service namespaces, see Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", - "serviceNamespaceListType$member": null - } - }, - "serviceNotSupportedMessage": { - "base": null, - "refs": { - "ServiceNotSupportedException$message": null - } - }, - "servicePassword": { - "base": null, - "refs": { - "ServiceSpecificCredential$ServicePassword": "

The generated password for the service-specific credential.

" - } - }, - "serviceSpecificCredentialId": { - "base": null, - "refs": { - "DeleteServiceSpecificCredentialRequest$ServiceSpecificCredentialId": "

The unique identifier of the service-specific credential. You can get this value by calling ListServiceSpecificCredentials.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

", - "ResetServiceSpecificCredentialRequest$ServiceSpecificCredentialId": "

The unique identifier of the service-specific credential.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

", - "ServiceSpecificCredential$ServiceSpecificCredentialId": "

The unique identifier for the service-specific credential.

", - "ServiceSpecificCredentialMetadata$ServiceSpecificCredentialId": "

The unique identifier for the service-specific credential.

", - "UpdateServiceSpecificCredentialRequest$ServiceSpecificCredentialId": "

The unique identifier of the service-specific credential.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

" - } - }, - "serviceUserName": { - "base": null, - "refs": { - "ServiceSpecificCredential$ServiceUserName": "

The generated user name for the service-specific credential. This value is generated by combining the IAM user's name combined with the ID number of the Amazon Web Services account, as in jane-at-123456789012, for example. This value cannot be configured by the user.

", - "ServiceSpecificCredentialMetadata$ServiceUserName": "

The generated user name for the service-specific credential.

" - } - }, - "sessionDurationType": { - "base": null, - "refs": { - "CreateDelegationRequestRequest$SessionDuration": "

The duration for which the delegated session should remain active, in seconds.

The active time window for the session starts when the customer calls the SendDelegationToken API.

", - "DelegationRequest$SessionDuration": "

The life-time of the requested session credential.

" - } - }, - "sortKeyType": { - "base": null, - "refs": { - "GetOrganizationsAccessReportRequest$SortKey": "

The key that is used to sort the results. If you choose the namespace key, the results are returned in alphabetical order. If you choose the time key, the results are sorted numerically by the date and time.

" - } - }, - "stateType": { - "base": null, - "refs": { - "DelegationRequest$State": "

The state of this delegation request.

See the Understanding the Request Lifecycle for an explanation of how these states are transitioned.

" - } - }, - "statusType": { - "base": null, - "refs": { - "AccessKey$Status": "

The status of the access key. Active means that the key is valid for API calls, while Inactive means it is not.

", - "AccessKeyMetadata$Status": "

The status of the access key. Active means that the key is valid for API calls; Inactive means it is not.

", - "SSHPublicKey$Status": "

The status of the SSH public key. Active means that the key can be used for authentication with an CodeCommit repository. Inactive means that the key cannot be used.

", - "SSHPublicKeyMetadata$Status": "

The status of the SSH public key. Active means that the key can be used for authentication with an CodeCommit repository. Inactive means that the key cannot be used.

", - "ServiceSpecificCredential$Status": "

The status of the service-specific credential. Active means that the key is valid for API calls, while Inactive means it is not.

", - "ServiceSpecificCredentialMetadata$Status": "

The status of the service-specific credential. Active means that the key is valid for API calls, while Inactive means it is not.

", - "SigningCertificate$Status": "

The status of the signing certificate. Active means that the key is valid for API calls, while Inactive means it is not.

", - "UpdateAccessKeyRequest$Status": "

The status you want to assign to the secret access key. Active means that the key can be used for programmatic calls to Amazon Web Services, while Inactive means that the key cannot be used.

", - "UpdateSSHPublicKeyRequest$Status": "

The status to assign to the SSH public key. Active means that the key can be used for authentication with an CodeCommit repository. Inactive means that the key cannot be used.

", - "UpdateServiceSpecificCredentialRequest$Status": "

The status to be assigned to the service-specific credential.

", - "UpdateSigningCertificateRequest$Status": "

The status you want to assign to the certificate. Active means that the certificate can be used for programmatic calls to Amazon Web Services Inactive means that the certificate cannot be used.

" - } - }, - "stringType": { - "base": null, - "refs": { - "AccessDetail$Region": "

The Region where the last service access attempt occurred.

This field is null if no principals in the reported Organizations entity attempted to access the service within the tracking period.

", - "AccessKeyLastUsed$ServiceName": "

The name of the Amazon Web Services service with which this access key was most recently used. The value of this field is \"N/A\" in the following situations:

  • The user does not have an access key.

  • An access key exists but has not been used since IAM started tracking this information.

  • There is no sign-in data associated with the user.

", - "AccessKeyLastUsed$Region": "

The Amazon Web Services Region where this access key was most recently used. The value for this field is \"N/A\" in the following situations:

  • The user does not have an access key.

  • An access key exists but has not been used since IAM began tracking this information.

  • There is no sign-in data associated with the user.

For more information about Amazon Web Services Regions, see Regions and endpoints in the Amazon Web Services General Reference.

", - "EnableOutboundWebIdentityFederationResponse$IssuerIdentifier": "

A unique issuer URL for your Amazon Web Services account that hosts the OpenID Connect (OIDC) discovery endpoints at /.well-known/openid-configuration and /.well-known/jwks.json. The OpenID Connect (OIDC) discovery endpoints contain verification keys and metadata necessary for token verification.

", - "ErrorDetails$Message": "

Detailed information about the reason that the operation failed.

", - "ErrorDetails$Code": "

The error code associated with the operation failure.

", - "GetOutboundWebIdentityFederationInfoResponse$IssuerIdentifier": "

A unique issuer URL for your Amazon Web Services account that hosts the OpenID Connect (OIDC) discovery endpoints at /.well-known/openid-configuration and /.well-known/jwks.json. The OpenID Connect (OIDC) discovery endpoints contain verification keys and metadata necessary for token verification.

", - "RoleLastUsed$Region": "

The name of the Amazon Web Services Region in which the role was last used.

", - "ServiceLastAccessed$LastAuthenticatedRegion": "

The Region from which the authenticated entity (user or role) last attempted to access the service. Amazon Web Services does not report unauthenticated requests.

This field is null if no IAM entities attempted to access the service within the tracking period.

", - "TrackedActionLastAccessed$ActionName": "

The name of the tracked action to which access was attempted. Tracked actions are actions that report activity to IAM.

", - "TrackedActionLastAccessed$LastAccessedRegion": "

The Region from which the authenticated entity (user or role) last attempted to access the tracked action. Amazon Web Services does not report unauthenticated requests.

This field is null if no IAM entities attempted to access the service within the tracking period.

" - } - }, - "summaryContentType": { - "base": null, - "refs": { - "GetHumanReadableSummaryResponse$SummaryContent": "

Summary content in the specified locale. Summary content is non-empty only if the SummaryState is AVAILABLE.

" - } - }, - "summaryKeyType": { - "base": null, - "refs": { - "summaryMapType$key": null - } - }, - "summaryMapType": { - "base": null, - "refs": { - "GetAccountSummaryResponse$SummaryMap": "

A set of key–value pairs containing information about IAM entity usage and IAM quotas.

" - } - }, - "summaryStateType": { - "base": null, - "refs": { - "GetHumanReadableSummaryResponse$SummaryState": "

State of summary generation. This generation process is asynchronous and this attribute indicates the state of the generation process.

" - } - }, - "summaryValueType": { - "base": null, - "refs": { - "summaryMapType$value": null - } - }, - "tagKeyListType": { - "base": null, - "refs": { - "UntagInstanceProfileRequest$TagKeys": "

A list of key names as a simple array of strings. The tags with matching keys are removed from the specified instance profile.

", - "UntagMFADeviceRequest$TagKeys": "

A list of key names as a simple array of strings. The tags with matching keys are removed from the specified instance profile.

", - "UntagOpenIDConnectProviderRequest$TagKeys": "

A list of key names as a simple array of strings. The tags with matching keys are removed from the specified OIDC provider.

", - "UntagPolicyRequest$TagKeys": "

A list of key names as a simple array of strings. The tags with matching keys are removed from the specified policy.

", - "UntagRoleRequest$TagKeys": "

A list of key names as a simple array of strings. The tags with matching keys are removed from the specified role.

", - "UntagSAMLProviderRequest$TagKeys": "

A list of key names as a simple array of strings. The tags with matching keys are removed from the specified SAML identity provider.

", - "UntagServerCertificateRequest$TagKeys": "

A list of key names as a simple array of strings. The tags with matching keys are removed from the specified IAM server certificate.

", - "UntagUserRequest$TagKeys": "

A list of key names as a simple array of strings. The tags with matching keys are removed from the specified user.

" - } - }, - "tagKeyType": { - "base": null, - "refs": { - "Tag$Key": "

The key name that can be used to look up or retrieve the associated value. For example, Department or Cost Center are common choices.

", - "tagKeyListType$member": null - } - }, - "tagListType": { - "base": null, - "refs": { - "CreateInstanceProfileRequest$Tags": "

A list of tags that you want to attach to the newly created IAM instance profile. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

", - "CreateOpenIDConnectProviderRequest$Tags": "

A list of tags that you want to attach to the new IAM OpenID Connect (OIDC) provider. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

", - "CreateOpenIDConnectProviderResponse$Tags": "

A list of tags that are attached to the new IAM OIDC provider. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

", - "CreatePolicyRequest$Tags": "

A list of tags that you want to attach to the new IAM customer managed policy. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

", - "CreateRoleRequest$Tags": "

A list of tags that you want to attach to the new role. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

", - "CreateSAMLProviderRequest$Tags": "

A list of tags that you want to attach to the new IAM SAML provider. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

", - "CreateSAMLProviderResponse$Tags": "

A list of tags that are attached to the new IAM SAML provider. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

", - "CreateUserRequest$Tags": "

A list of tags that you want to attach to the new user. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

", - "CreateVirtualMFADeviceRequest$Tags": "

A list of tags that you want to attach to the new IAM virtual MFA device. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

", - "GetOpenIDConnectProviderResponse$Tags": "

A list of tags that are attached to the specified IAM OIDC provider. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

", - "GetSAMLProviderResponse$Tags": "

A list of tags that are attached to the specified IAM SAML provider. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

", - "InstanceProfile$Tags": "

A list of tags that are attached to the instance profile. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

", - "ListInstanceProfileTagsResponse$Tags": "

The list of tags that are currently attached to the IAM instance profile. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

", - "ListMFADeviceTagsResponse$Tags": "

The list of tags that are currently attached to the virtual MFA device. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

", - "ListOpenIDConnectProviderTagsResponse$Tags": "

The list of tags that are currently attached to the OpenID Connect (OIDC) identity provider. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

", - "ListPolicyTagsResponse$Tags": "

The list of tags that are currently attached to the IAM customer managed policy. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

", - "ListRoleTagsResponse$Tags": "

The list of tags that are currently attached to the role. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

", - "ListSAMLProviderTagsResponse$Tags": "

The list of tags that are currently attached to the Security Assertion Markup Language (SAML) identity provider. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

", - "ListServerCertificateTagsResponse$Tags": "

The list of tags that are currently attached to the IAM server certificate. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

", - "ListUserTagsResponse$Tags": "

The list of tags that are currently attached to the user. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

", - "Policy$Tags": "

A list of tags that are attached to the instance profile. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

", - "Role$Tags": "

A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

", - "RoleDetail$Tags": "

A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

", - "ServerCertificate$Tags": "

A list of tags that are attached to the server certificate. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

", - "TagInstanceProfileRequest$Tags": "

The list of tags that you want to attach to the IAM instance profile. Each tag consists of a key name and an associated value.

", - "TagMFADeviceRequest$Tags": "

The list of tags that you want to attach to the IAM virtual MFA device. Each tag consists of a key name and an associated value.

", - "TagOpenIDConnectProviderRequest$Tags": "

The list of tags that you want to attach to the OIDC identity provider in IAM. Each tag consists of a key name and an associated value.

", - "TagPolicyRequest$Tags": "

The list of tags that you want to attach to the IAM customer managed policy. Each tag consists of a key name and an associated value.

", - "TagRoleRequest$Tags": "

The list of tags that you want to attach to the IAM role. Each tag consists of a key name and an associated value.

", - "TagSAMLProviderRequest$Tags": "

The list of tags that you want to attach to the SAML identity provider in IAM. Each tag consists of a key name and an associated value.

", - "TagServerCertificateRequest$Tags": "

The list of tags that you want to attach to the IAM server certificate. Each tag consists of a key name and an associated value.

", - "TagUserRequest$Tags": "

The list of tags that you want to attach to the IAM user. Each tag consists of a key name and an associated value.

", - "UploadServerCertificateRequest$Tags": "

A list of tags that you want to attach to the new IAM server certificate resource. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

", - "UploadServerCertificateResponse$Tags": "

A list of tags that are attached to the new IAM server certificate. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

", - "User$Tags": "

A list of tags that are associated with the user. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

", - "UserDetail$Tags": "

A list of tags that are associated with the user. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

", - "VirtualMFADevice$Tags": "

A list of tags that are attached to the virtual MFA device. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

" - } - }, - "tagValueType": { - "base": null, - "refs": { - "Tag$Value": "

The value associated with this tag. For example, tags with a key name of Department could have values such as Human Resources, Accounting, and Support. Tags with a key name of Cost Center might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.

" - } - }, - "thumbprintListType": { - "base": "

Contains a list of thumbprints of identity provider server certificates.

", - "refs": { - "CreateOpenIDConnectProviderRequest$ThumbprintList": "

A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificates. Typically this list includes only one entry. However, IAM lets you have up to five thumbprints for an OIDC provider. This lets you maintain multiple thumbprints if the identity provider is rotating certificates.

This parameter is optional. If it is not included, IAM will retrieve and use the top intermediate certificate authority (CA) thumbprint of the OpenID Connect identity provider server certificate.

The server certificate thumbprint is the hex-encoded SHA-1 hash value of the X.509 certificate used by the domain where the OpenID Connect provider makes its keys available. It is always a 40-character string.

For example, assume that the OIDC provider is server.example.com and the provider stores its keys at https://keys.server.example.com/openid-connect. In that case, the thumbprint string would be the hex-encoded SHA-1 hash value of the certificate used by https://keys.server.example.com.

For more information about obtaining the OIDC provider thumbprint, see Obtaining the thumbprint for an OpenID Connect provider in the IAM user Guide.

If your OIDC provider's discovery endpoint and JWKS endpoint (jwks_uri) use different certificates or hosts, include the thumbprints for both endpoints in this list.

", - "GetOpenIDConnectProviderResponse$ThumbprintList": "

A list of certificate thumbprints that are associated with the specified IAM OIDC provider resource object. For more information, see CreateOpenIDConnectProvider.

", - "UpdateOpenIDConnectProviderThumbprintRequest$ThumbprintList": "

A list of certificate thumbprints that are associated with the specified IAM OpenID Connect provider. For more information, see CreateOpenIDConnectProvider.

" - } - }, - "thumbprintType": { - "base": "

Contains a thumbprint for an identity provider's server certificate.

The identity provider's server certificate thumbprint is the hex-encoded SHA-1 hash value of the self-signed X.509 certificate. This thumbprint is used by the domain where the OpenID Connect provider makes its keys available. The thumbprint is always a 40-character string.

", - "refs": { - "thumbprintListType$member": null - } - }, - "unmodifiableEntityMessage": { - "base": null, - "refs": { - "UnmodifiableEntityException$message": null - } - }, - "unrecognizedPublicKeyEncodingMessage": { - "base": null, - "refs": { - "UnrecognizedPublicKeyEncodingException$message": null - } - }, - "userDetailListType": { - "base": null, - "refs": { - "GetAccountAuthorizationDetailsResponse$UserDetailList": "

A list containing information about IAM users.

" - } - }, - "userListType": { - "base": "

Contains a list of users.

This data type is used as a response element in the GetGroup and ListUsers operations.

", - "refs": { - "GetGroupResponse$Users": "

A list of users in the group.

", - "ListUsersResponse$Users": "

A list of users.

" - } - }, - "userNameType": { - "base": null, - "refs": { - "AccessKey$UserName": "

The name of the IAM user that the access key is associated with.

", - "AccessKeyMetadata$UserName": "

The name of the IAM user that the key is associated with.

", - "AttachUserPolicyRequest$UserName": "

The name (friendly name, not ARN) of the IAM user to attach the policy to.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "CreateLoginProfileRequest$UserName": "

The name of the IAM user to create a password for. The user must already exist.

This parameter is optional. If no user name is included, it defaults to the principal making the request. When you make this request with root user credentials, you must use an AssumeRoot session to omit the user name.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "CreateServiceSpecificCredentialRequest$UserName": "

The name of the IAM user that is to be associated with the credentials. The new service-specific credentials have the same permissions as the associated user except that they can be used only to access the specified service.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "CreateUserRequest$UserName": "

The name of the user to create.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both \"MyResource\" and \"myresource\".

", - "DeleteLoginProfileRequest$UserName": "

The name of the user whose password you want to delete.

This parameter is optional. If no user name is included, it defaults to the principal making the request. When you make this request with root user credentials, you must use an AssumeRoot session to omit the user name.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "DeleteSSHPublicKeyRequest$UserName": "

The name of the IAM user associated with the SSH public key.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "DeleteServiceSpecificCredentialRequest$UserName": "

The name of the IAM user associated with the service-specific credential. If this value is not specified, then the operation assumes the user whose credentials are used to call the operation.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "DeleteUserPermissionsBoundaryRequest$UserName": "

The name (friendly name, not ARN) of the IAM user from which you want to remove the permissions boundary.

", - "DetachUserPolicyRequest$UserName": "

The name (friendly name, not ARN) of the IAM user to detach the policy from.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "EntityInfo$Name": "

The name of the entity (user or role).

", - "GetLoginProfileRequest$UserName": "

The name of the user whose login profile you want to retrieve.

This parameter is optional. If no user name is included, it defaults to the principal making the request. When you make this request with root user credentials, you must use an AssumeRoot session to omit the user name.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "GetMFADeviceRequest$UserName": "

The friendly name identifying the user.

", - "GetMFADeviceResponse$UserName": "

The friendly name identifying the user.

", - "GetSSHPublicKeyRequest$UserName": "

The name of the IAM user associated with the SSH public key.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "ListAttachedUserPoliciesRequest$UserName": "

The name (friendly name, not ARN) of the user to list attached policies for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "ListSSHPublicKeysRequest$UserName": "

The name of the IAM user to list SSH public keys for. If none is specified, the UserName field is determined implicitly based on the Amazon Web Services access key used to sign the request.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "ListServiceSpecificCredentialsRequest$UserName": "

The name of the user whose service-specific credentials you want information about. If this value is not specified, then the operation assumes the user whose credentials are used to call the operation.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "LoginProfile$UserName": "

The name of the user, which can be used for signing in to the Amazon Web Services Management Console.

", - "MFADevice$UserName": "

The user with whom the MFA device is associated.

", - "PolicyUser$UserName": "

The name (friendly name, not ARN) identifying the user.

", - "PutUserPermissionsBoundaryRequest$UserName": "

The name (friendly name, not ARN) of the IAM user for which you want to set the permissions boundary.

", - "ResetServiceSpecificCredentialRequest$UserName": "

The name of the IAM user associated with the service-specific credential. If this value is not specified, then the operation assumes the user whose credentials are used to call the operation.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "SSHPublicKey$UserName": "

The name of the IAM user associated with the SSH public key.

", - "SSHPublicKeyMetadata$UserName": "

The name of the IAM user associated with the SSH public key.

", - "ServiceSpecificCredential$UserName": "

The name of the IAM user associated with the service-specific credential.

", - "ServiceSpecificCredentialMetadata$UserName": "

The name of the IAM user associated with the service-specific credential.

", - "SigningCertificate$UserName": "

The name of the user the signing certificate is associated with.

", - "UpdateLoginProfileRequest$UserName": "

The name of the user whose password you want to update.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "UpdateSSHPublicKeyRequest$UserName": "

The name of the IAM user associated with the SSH public key.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "UpdateServiceSpecificCredentialRequest$UserName": "

The name of the IAM user associated with the service-specific credential. If you do not specify this value, then the operation assumes the user whose credentials are used to call the operation.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "UpdateUserRequest$NewUserName": "

New name for the user. Include this parameter only if you're changing the user's name.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both \"MyResource\" and \"myresource\".

", - "UploadSSHPublicKeyRequest$UserName": "

The name of the IAM user to associate the SSH public key with.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "User$UserName": "

The friendly name identifying the user.

", - "UserDetail$UserName": "

The friendly name identifying the user.

" - } - }, - "virtualMFADeviceListType": { - "base": null, - "refs": { - "ListVirtualMFADevicesResponse$VirtualMFADevices": "

The list of virtual MFA devices in the current account that match the AssignmentStatus value that was passed in the request.

" - } - }, - "virtualMFADeviceName": { - "base": null, - "refs": { - "CreateVirtualMFADeviceRequest$VirtualMFADeviceName": "

The name of the virtual MFA device, which must be unique. Use with path to uniquely identify a virtual MFA device.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - } - } - } -} diff --git a/tools/code-generation/api-descriptions/iam/2010-05-08/endpoint-bdd-1.json b/tools/code-generation/api-descriptions/iam/2010-05-08/endpoint-bdd-1.json deleted file mode 100644 index 3fd6c6e36cb4..000000000000 --- a/tools/code-generation/api-descriptions/iam/2010-05-08/endpoint-bdd-1.json +++ /dev/null @@ -1,544 +0,0 @@ -{ - "version": "1.1", - "parameters": { - "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" - }, - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "string" - } - }, - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - }, - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - }, - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - }, - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws" - ] - }, - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws-cn" - ] - }, - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws-us-gov" - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - }, - true - ] - }, - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws-iso" - ] - }, - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws-iso-b" - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - }, - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws-iso-e" - ] - }, - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws-iso-f" - ] - }, - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws-eusc" - ] - } - ], - "results": [ - { - "conditions": [], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://iam.global.api.aws", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-east-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://iam-fips.global.api.aws", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-east-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://iam.global.api.amazonwebservices.com.cn", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "cn-north-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://iam.cn-north-1.amazonaws.com.cn", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "cn-north-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://iam.us-gov.api.aws", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-gov-west-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://iam.us-gov.amazonaws.com", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-gov-west-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://iam.us-iso-east-1.c2s.ic.gov", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-iso-east-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://iam-fips.us-iso-east-1.c2s.ic.gov", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-iso-east-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://iam.us-isob-east-1.sc2s.sgov.gov", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-isob-east-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://iam-fips.us-isob-east-1.sc2s.sgov.gov", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-isob-east-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://iam.eu-isoe-west-1.cloud.adc-e.uk", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "eu-isoe-west-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://iam.us-isof-south-1.csp.hci.ic.gov", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-isof-south-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://iam.eusc-de-east-1.amazonaws.eu", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "eusc-de-east-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://iam-fips.{PartitionResult#dualStackDnsSuffix}", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "{PartitionResult#implicitGlobalRegion}" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": "https://iam-fips.{PartitionResult#dnsSuffix}", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "{PartitionResult#implicitGlobalRegion}" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": "https://iam.{PartitionResult#dualStackDnsSuffix}", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "{PartitionResult#implicitGlobalRegion}" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": "https://iam.{PartitionResult#dnsSuffix}", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "{PartitionResult#implicitGlobalRegion}" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ], - "root": 2, - "nodeCount": 28, - "nodes": "/////wAAAAH/////AAAAAAAAABsAAAADAAAAAQAAAAQF9eEYAAAAAgAAAAUF9eEYAAAAAwAAABIAAAAGAAAABAAAAA4AAAAHAAAABgX14QcAAAAIAAAABwX14QkAAAAJAAAACQX14QoAAAAKAAAACgX14QwAAAALAAAADAX14Q4AAAAMAAAADQX14Q8AAAANAAAADgX14RAF9eEXAAAABQX14QQAAAAPAAAABgX14QYAAAAQAAAABwX14QgAAAARAAAACAX14RUF9eEWAAAABAAAABcAAAATAAAABwX14QkAAAAUAAAACQX14QsAAAAVAAAACgX14Q0AAAAWAAAACwX14RMF9eEUAAAABQX14QUAAAAYAAAABwX14QgAAAAZAAAACAAAABoF9eESAAAACwX14REF9eESAAAAAwX14QEAAAAcAAAABAX14QIF9eED" -} \ No newline at end of file diff --git a/tools/code-generation/api-descriptions/iam/2010-05-08/endpoint-rule-set-1.json b/tools/code-generation/api-descriptions/iam/2010-05-08/endpoint-rule-set-1.json deleted file mode 100644 index bad185dfe692..000000000000 --- a/tools/code-generation/api-descriptions/iam/2010-05-08/endpoint-rule-set-1.json +++ /dev/null @@ -1,1122 +0,0 @@ -{ - "version": "1.0", - "parameters": { - "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" - }, - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the 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": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws" - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - false - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "endpoint": { - "url": "https://iam.global.api.aws", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-east-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws" - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "endpoint": { - "url": "https://iam-fips.global.api.aws", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-east-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws-cn" - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - false - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "endpoint": { - "url": "https://iam.global.api.amazonwebservices.com.cn", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "cn-north-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws-cn" - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - false - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - false - ] - } - ], - "endpoint": { - "url": "https://iam.cn-north-1.amazonaws.com.cn", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "cn-north-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws-us-gov" - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - false - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "endpoint": { - "url": "https://iam.us-gov.api.aws", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-gov-west-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws-us-gov" - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "endpoint": { - "url": "https://iam.us-gov.api.aws", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-gov-west-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws-us-gov" - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - false - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - false - ] - } - ], - "endpoint": { - "url": "https://iam.us-gov.amazonaws.com", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-gov-west-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws-us-gov" - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - false - ] - } - ], - "endpoint": { - "url": "https://iam.us-gov.amazonaws.com", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-gov-west-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws-iso" - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - false - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - false - ] - } - ], - "endpoint": { - "url": "https://iam.us-iso-east-1.c2s.ic.gov", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-iso-east-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws-iso" - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - false - ] - } - ], - "endpoint": { - "url": "https://iam-fips.us-iso-east-1.c2s.ic.gov", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-iso-east-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws-iso-b" - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - false - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - false - ] - } - ], - "endpoint": { - "url": "https://iam.us-isob-east-1.sc2s.sgov.gov", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-isob-east-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws-iso-b" - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - false - ] - } - ], - "endpoint": { - "url": "https://iam-fips.us-isob-east-1.sc2s.sgov.gov", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-isob-east-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws-iso-e" - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - false - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - false - ] - } - ], - "endpoint": { - "url": "https://iam.eu-isoe-west-1.cloud.adc-e.uk", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "eu-isoe-west-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws-iso-f" - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - false - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - false - ] - } - ], - "endpoint": { - "url": "https://iam.us-isof-south-1.csp.hci.ic.gov", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-isof-south-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws-eusc" - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - false - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - false - ] - } - ], - "endpoint": { - "url": "https://iam.eusc-de-east-1.amazonaws.eu", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "eusc-de-east-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "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": [], - "endpoint": { - "url": "https://iam-fips.{PartitionResult#dualStackDnsSuffix}", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "{PartitionResult#implicitGlobalRegion}" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - } - ], - "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 - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - false - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://iam-fips.{PartitionResult#dnsSuffix}", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "{PartitionResult#implicitGlobalRegion}" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - false - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://iam.{PartitionResult#dualStackDnsSuffix}", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "{PartitionResult#implicitGlobalRegion}" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://iam.{PartitionResult#dnsSuffix}", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "{PartitionResult#implicitGlobalRegion}" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ], - "type": "tree" - } - ] -} \ No newline at end of file diff --git a/tools/code-generation/api-descriptions/iam/2010-05-08/endpoint-tests-1.json b/tools/code-generation/api-descriptions/iam/2010-05-08/endpoint-tests-1.json deleted file mode 100644 index a38a2c02fcbd..000000000000 --- a/tools/code-generation/api-descriptions/iam/2010-05-08/endpoint-tests-1.json +++ /dev/null @@ -1,506 +0,0 @@ -{ - "testCases": [ - { - "documentation": "For custom endpoint with region not set and fips disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Endpoint": "https://example.com", - "UseFIPS": false - } - }, - { - "documentation": "For custom endpoint with fips enabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Endpoint": "https://example.com", - "UseFIPS": true - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Endpoint": "https://example.com", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-east-1" - } - ] - }, - "url": "https://iam-fips.global.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": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-east-1" - } - ] - }, - "url": "https://iam-fips.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": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-east-1" - } - ] - }, - "url": "https://iam.global.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": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-east-1" - } - ] - }, - "url": "https://iam.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "cn-northwest-1" - } - ] - }, - "url": "https://iam-fips.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-northwest-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "cn-northwest-1" - } - ] - }, - "url": "https://iam-fips.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-northwest-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "cn-north-1" - } - ] - }, - "url": "https://iam.global.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-northwest-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "cn-north-1" - } - ] - }, - "url": "https://iam.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-northwest-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eusc-de-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "eusc-de-east-1" - } - ] - }, - "url": "https://iam-fips.amazonaws.eu" - } - }, - "params": { - "Region": "eusc-de-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region eusc-de-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "eusc-de-east-1" - } - ] - }, - "url": "https://iam.eusc-de-east-1.amazonaws.eu" - } - }, - "params": { - "Region": "eusc-de-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-iso-east-1" - } - ] - }, - "url": "https://iam-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 disabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-iso-east-1" - } - ] - }, - "url": "https://iam.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 disabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-isob-east-1" - } - ] - }, - "url": "https://iam-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 disabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-isob-east-1" - } - ] - }, - "url": "https://iam.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-isoe-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "eu-isoe-west-1" - } - ] - }, - "url": "https://iam-fips.cloud.adc-e.uk" - } - }, - "params": { - "Region": "eu-isoe-west-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "eu-isoe-west-1" - } - ] - }, - "url": "https://iam.eu-isoe-west-1.cloud.adc-e.uk" - } - }, - "params": { - "Region": "eu-isoe-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-isof-south-1" - } - ] - }, - "url": "https://iam-fips.csp.hci.ic.gov" - } - }, - "params": { - "Region": "us-isof-south-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-isof-south-1" - } - ] - }, - "url": "https://iam.us-isof-south-1.csp.hci.ic.gov" - } - }, - "params": { - "Region": "us-isof-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-gov-west-1" - } - ] - }, - "url": "https://iam.us-gov.api.aws" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-gov-west-1" - } - ] - }, - "url": "https://iam.us-gov.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-gov-west-1" - } - ] - }, - "url": "https://iam.us-gov.api.aws" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-gov-west-1" - } - ] - }, - "url": "https://iam.us-gov.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } - } - ], - "version": "1.0" -} \ No newline at end of file diff --git a/tools/code-generation/api-descriptions/iam/2010-05-08/examples-1.json b/tools/code-generation/api-descriptions/iam/2010-05-08/examples-1.json deleted file mode 100644 index d554b11be95f..000000000000 --- a/tools/code-generation/api-descriptions/iam/2010-05-08/examples-1.json +++ /dev/null @@ -1,1526 +0,0 @@ -{ - "version": "1.0", - "examples": { - "AddClientIDToOpenIDConnectProvider": [ - { - "input": { - "ClientID": "my-application-ID", - "OpenIDConnectProviderArn": "arn:aws:iam::123456789012:oidc-provider/server.example.com" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following add-client-id-to-open-id-connect-provider command adds the client ID my-application-ID to the OIDC provider named server.example.com:", - "id": "028e91f4-e2a6-4d59-9e3b-4965a3fb19be", - "title": "To add a client ID (audience) to an Open-ID Connect (OIDC) provider" - } - ], - "AddRoleToInstanceProfile": [ - { - "input": { - "InstanceProfileName": "Webserver", - "RoleName": "S3Access" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command adds the role named S3Access to the instance profile named Webserver:", - "id": "c107fac3-edb6-4827-8a71-8863ec91c81f", - "title": "To add a role to an instance profile" - } - ], - "AddUserToGroup": [ - { - "input": { - "GroupName": "Admins", - "UserName": "Bob" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command adds an IAM user named Bob to the IAM group named Admins:", - "id": "619c7e6b-09f8-4036-857b-51a6ea5027ca", - "title": "To add a user to an IAM group" - } - ], - "AttachGroupPolicy": [ - { - "input": { - "GroupName": "Finance", - "PolicyArn": "arn:aws:iam::aws:policy/ReadOnlyAccess" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command attaches the AWS managed policy named ReadOnlyAccess to the IAM group named Finance.", - "id": "87551489-86f0-45db-9889-759936778f2b", - "title": "To attach a managed policy to an IAM group" - } - ], - "AttachRolePolicy": [ - { - "input": { - "PolicyArn": "arn:aws:iam::aws:policy/ReadOnlyAccess", - "RoleName": "ReadOnlyRole" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command attaches the AWS managed policy named ReadOnlyAccess to the IAM role named ReadOnlyRole.", - "id": "3e1b8c7c-99c8-4fc4-a20c-131fe3f22c7e", - "title": "To attach a managed policy to an IAM role" - } - ], - "AttachUserPolicy": [ - { - "input": { - "PolicyArn": "arn:aws:iam::aws:policy/AdministratorAccess", - "UserName": "Alice" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command attaches the AWS managed policy named AdministratorAccess to the IAM user named Alice.", - "id": "1372ebd8-9475-4b1a-a479-23b6fd4b8b3e", - "title": "To attach a managed policy to an IAM user" - } - ], - "ChangePassword": [ - { - "input": { - "NewPassword": "]35d/{pB9Fo9wJ", - "OldPassword": "3s0K_;xh4~8XXI" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command changes the password for the current IAM user.", - "id": "3a80c66f-bffb-46df-947c-1e8fa583b470", - "title": "To change the password for your IAM user" - } - ], - "CreateAccessKey": [ - { - "input": { - "UserName": "Bob" - }, - "output": { - "AccessKey": { - "AccessKeyId": "AKIAIOSFODNN7EXAMPLE", - "CreateDate": "2015-03-09T18:39:23.411Z", - "SecretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY", - "Status": "Active", - "UserName": "Bob" - } - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command creates an access key (access key ID and secret access key) for the IAM user named Bob.", - "id": "1fbb3211-4cf2-41db-8c20-ba58d9f5802d", - "title": "To create an access key for an IAM user" - } - ], - "CreateAccountAlias": [ - { - "input": { - "AccountAlias": "examplecorp" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command associates the alias examplecorp to your AWS account.", - "id": "5adaf6fb-94fc-4ca2-b825-2fbc2062add1", - "title": "To create an account alias" - } - ], - "CreateGroup": [ - { - "input": { - "GroupName": "Admins" - }, - "output": { - "Group": { - "Arn": "arn:aws:iam::123456789012:group/Admins", - "CreateDate": "2015-03-09T20:30:24.940Z", - "GroupId": "AIDGPMS9RO4H3FEXAMPLE", - "GroupName": "Admins", - "Path": "/" - } - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command creates an IAM group named Admins.", - "id": "d5da2a90-5e69-4ef7-8ae8-4c33dc21fd21", - "title": "To create an IAM group" - } - ], - "CreateInstanceProfile": [ - { - "input": { - "InstanceProfileName": "Webserver" - }, - "output": { - "InstanceProfile": { - "Arn": "arn:aws:iam::123456789012:instance-profile/Webserver", - "CreateDate": "2015-03-09T20:33:19.626Z", - "InstanceProfileId": "AIPAJMBYC7DLSPEXAMPLE", - "InstanceProfileName": "Webserver", - "Path": "/", - "Roles": [] - } - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command creates an instance profile named Webserver that is ready to have a role attached and then be associated with an EC2 instance.", - "id": "5d84e6ae-5921-4e39-8454-10232cd9ff9a", - "title": "To create an instance profile" - } - ], - "CreateLoginProfile": [ - { - "input": { - "Password": "h]6EszR}vJ*m", - "PasswordResetRequired": true, - "UserName": "Bob" - }, - "output": { - "LoginProfile": { - "CreateDate": "2015-03-10T20:55:40.274Z", - "PasswordResetRequired": true, - "UserName": "Bob" - } - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command changes IAM user Bob's password and sets the flag that required Bob to change the password the next time he signs in.", - "id": "c63795bc-3444-40b3-89df-83c474ef88be", - "title": "To create an instance profile" - } - ], - "CreateOpenIDConnectProvider": [ - { - "input": { - "ClientIDList": [ - "my-application-id" - ], - "ThumbprintList": [ - "3768084dfb3d2b68b7897bf5f565da8efEXAMPLE" - ], - "Url": "https://server.example.com" - }, - "output": { - "OpenIDConnectProviderArn": "arn:aws:iam::123456789012:oidc-provider/server.example.com" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following example defines a new OIDC provider in IAM with a client ID of my-application-id and pointing at the server with a URL of https://server.example.com.", - "id": "4e4a6bff-cc97-4406-922e-0ab4a82cdb63", - "title": "To create an instance profile" - } - ], - "CreateRole": [ - { - "input": { - "AssumeRolePolicyDocument": "", - "Path": "/", - "RoleName": "Test-Role" - }, - "output": { - "Role": { - "Arn": "arn:aws:iam::123456789012:role/Test-Role", - "AssumeRolePolicyDocument": "", - "CreateDate": "2013-06-07T20:43:32.821Z", - "Path": "/", - "RoleId": "AKIAIOSFODNN7EXAMPLE", - "RoleName": "Test-Role" - } - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command creates a role named Test-Role and attaches a trust policy that you must convert from JSON to a string. Upon success, the response includes the same policy as a URL-encoded JSON string.", - "id": "eaaa4b5f-51f1-4f73-b0d3-30127040eff8", - "title": "To create an IAM role" - } - ], - "CreateUser": [ - { - "input": { - "UserName": "Bob" - }, - "output": { - "User": { - "Arn": "arn:aws:iam::123456789012:user/Bob", - "CreateDate": "2013-06-08T03:20:41.270Z", - "Path": "/", - "UserId": "AKIAIOSFODNN7EXAMPLE", - "UserName": "Bob" - } - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following create-user command creates an IAM user named Bob in the current account.", - "id": "eb15f90b-e5f5-4af8-a594-e4e82b181a62", - "title": "To create an IAM user" - } - ], - "DeleteAccessKey": [ - { - "input": { - "AccessKeyId": "AKIDPMS9RO4H3FEXAMPLE", - "UserName": "Bob" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command deletes one access key (access key ID and secret access key) assigned to the IAM user named Bob.", - "id": "61a785a7-d30a-415a-ae18-ab9236e56871", - "title": "To delete an access key for an IAM user" - } - ], - "DeleteAccountAlias": [ - { - "input": { - "AccountAlias": "mycompany" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command removes the alias mycompany from the current AWS account:", - "id": "7abeca65-04a8-4500-a890-47f1092bf766", - "title": "To delete an account alias" - } - ], - "DeleteAccountPasswordPolicy": [ - { - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command removes the password policy from the current AWS account:", - "id": "9ddf755e-495c-49bc-ae3b-ea6cc9b8ebcf", - "title": "To delete the current account password policy" - } - ], - "DeleteGroupPolicy": [ - { - "input": { - "GroupName": "Admins", - "PolicyName": "ExamplePolicy" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command deletes the policy named ExamplePolicy from the group named Admins:", - "id": "e683f2bd-98a4-4fe0-bb66-33169c692d4a", - "title": "To delete a policy from an IAM group" - } - ], - "DeleteInstanceProfile": [ - { - "input": { - "InstanceProfileName": "ExampleInstanceProfile" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command deletes the instance profile named ExampleInstanceProfile", - "id": "12d74fb8-3433-49db-8171-a1fc764e354d", - "title": "To delete an instance profile" - } - ], - "DeleteLoginProfile": [ - { - "input": { - "UserName": "Bob" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command deletes the password for the IAM user named Bob.", - "id": "1fe57059-fc73-42e2-b992-517b7d573b5c", - "title": "To delete a password for an IAM user" - } - ], - "DeleteRole": [ - { - "input": { - "RoleName": "Test-Role" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command removes the role named Test-Role.", - "id": "053cdf74-9bda-44b8-bdbb-140fd5a32603", - "title": "To delete an IAM role" - } - ], - "DeleteRolePolicy": [ - { - "input": { - "PolicyName": "ExamplePolicy", - "RoleName": "Test-Role" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command removes the policy named ExamplePolicy from the role named Test-Role.", - "id": "9c667336-fde3-462c-b8f3-950800821e27", - "title": "To remove a policy from an IAM role" - } - ], - "DeleteSigningCertificate": [ - { - "input": { - "CertificateId": "TA7SMP42TDN5Z26OBPJE7EXAMPLE", - "UserName": "Anika" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command deletes the specified signing certificate for the IAM user named Anika.", - "id": "e3357586-ba9c-4070-b35b-d1a899b71987", - "title": "To delete a signing certificate for an IAM user" - } - ], - "DeleteUser": [ - { - "input": { - "UserName": "Bob" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command removes the IAM user named Bob from the current account.", - "id": "a13dc3f9-59fe-42d9-abbb-fb98b204fdf0", - "title": "To delete an IAM user" - } - ], - "DeleteUserPolicy": [ - { - "input": { - "PolicyName": "ExamplePolicy", - "UserName": "Juan" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following delete-user-policy command removes the specified policy from the IAM user named Juan:", - "id": "34f07ddc-9bc1-4f52-bc59-cd0a3ccd06c8", - "title": "To remove a policy from an IAM user" - } - ], - "DeleteVirtualMFADevice": [ - { - "input": { - "SerialNumber": "arn:aws:iam::123456789012:mfa/ExampleName" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following delete-virtual-mfa-device command removes the specified MFA device from the current AWS account.", - "id": "2933b08b-dbe7-4b89-b8c1-fdf75feea1ee", - "title": "To remove a virtual MFA device" - } - ], - "DisableOrganizationsRootCredentialsManagement": [ - { - "input": {}, - "output": { - "EnabledFeatures": [ - "RootSessions" - ], - "OrganizationId": "o-aa111bb222" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command disables the management of privileged root user credentials across member accounts in your organization.", - "id": "to-disable-the-rootcredentialsmanagement-feature-in-your-organization-1730908292211", - "title": "To disable the RootCredentialsManagement feature in your organization" - } - ], - "DisableOrganizationsRootSessions": [ - { - "input": {}, - "output": { - "EnabledFeatures": [ - "RootCredentialsManagement" - ], - "OrganizationId": "o-aa111bb222" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command disables root user sessions for privileged tasks across member accounts in your organization.", - "id": "to-disable-the-rootsessions-feature-in-your-organization-1730908495962", - "title": "To disable the RootSessions feature in your organization" - } - ], - "EnableOrganizationsRootCredentialsManagement": [ - { - "input": {}, - "output": { - "EnabledFeatures": [ - "RootCredentialsManagement" - ], - "OrganizationId": "o-aa111bb222" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command enables the management of privileged root user credentials across member accounts in your organization.", - "id": "to-enable-the-rootcredentialsmanagement-feature-in-your-organization-1730908602395", - "title": "To enable the RootCredentialsManagement feature in your organization" - } - ], - "EnableOrganizationsRootSessions": [ - { - "input": {}, - "output": { - "EnabledFeatures": [ - "RootCredentialsManagement", - "RootSessions" - ], - "OrganizationId": "o-aa111bb222" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command allows the management account or delegated administrator to perform privileged tasks on member accounts in your organization.", - "id": "to-enable-the-rootsessions-feature-in-your-organization-1730908736611", - "title": "To enable the RootSessions feature in your organization" - } - ], - "GenerateOrganizationsAccessReport": [ - { - "input": { - "EntityPath": "o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-1a2b3c-k9l8m7n6o5example" - }, - "output": { - "JobId": "examplea-1234-b567-cde8-90fg123abcd4" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following operation generates a report for the organizational unit ou-rge0-awexample", - "id": "generateorganizationsaccessreport-ou", - "title": "To generate a service last accessed data report for an organizational unit" - } - ], - "GenerateServiceLastAccessedDetails": [ - { - "input": { - "Arn": "arn:aws:iam::123456789012:policy/ExamplePolicy1" - }, - "output": { - "JobId": "examplef-1305-c245-eba4-71fe298bcda7" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following operation generates a report for the policy: ExamplePolicy1", - "id": "generateaccessdata-policy-1541695178514", - "title": "To generate a service last accessed data report for a policy" - } - ], - "GetAccountPasswordPolicy": [ - { - "output": { - "PasswordPolicy": { - "AllowUsersToChangePassword": false, - "ExpirePasswords": false, - "HardExpiry": false, - "MaxPasswordAge": 90, - "MinimumPasswordLength": 8, - "PasswordReusePrevention": 12, - "RequireLowercaseCharacters": false, - "RequireNumbers": true, - "RequireSymbols": true, - "RequireUppercaseCharacters": false - } - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command displays details about the password policy for the current AWS account.", - "id": "5e4598c7-c425-431f-8af1-19073b3c4a5f", - "title": "To see the current account password policy" - } - ], - "GetAccountSummary": [ - { - "output": { - "SummaryMap": { - "AccessKeysPerUserQuota": 2, - "AccountAccessKeysPresent": 1, - "AccountMFAEnabled": 0, - "AccountSigningCertificatesPresent": 0, - "AttachedPoliciesPerGroupQuota": 10, - "AttachedPoliciesPerRoleQuota": 10, - "AttachedPoliciesPerUserQuota": 10, - "GlobalEndpointTokenVersion": 2, - "GroupPolicySizeQuota": 5120, - "Groups": 15, - "GroupsPerUserQuota": 10, - "GroupsQuota": 100, - "MFADevices": 6, - "MFADevicesInUse": 3, - "Policies": 8, - "PoliciesQuota": 1000, - "PolicySizeQuota": 5120, - "PolicyVersionsInUse": 22, - "PolicyVersionsInUseQuota": 10000, - "ServerCertificates": 1, - "ServerCertificatesQuota": 20, - "SigningCertificatesPerUserQuota": 2, - "UserPolicySizeQuota": 2048, - "Users": 27, - "UsersQuota": 5000, - "VersionsPerPolicyQuota": 5 - } - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command returns information about the IAM entity quotas and usage in the current AWS account.", - "id": "9d8447af-f344-45de-8219-2cebc3cce7f2", - "title": "To get information about IAM entity quotas and usage in the current account" - } - ], - "GetInstanceProfile": [ - { - "input": { - "InstanceProfileName": "ExampleInstanceProfile" - }, - "output": { - "InstanceProfile": { - "Arn": "arn:aws:iam::336924118301:instance-profile/ExampleInstanceProfile", - "CreateDate": "2013-06-12T23:52:02Z", - "InstanceProfileId": "AID2MAB8DPLSRHEXAMPLE", - "InstanceProfileName": "ExampleInstanceProfile", - "Path": "/", - "Roles": [ - { - "Arn": "arn:aws:iam::336924118301:role/Test-Role", - "AssumeRolePolicyDocument": "", - "CreateDate": "2013-01-09T06:33:26Z", - "Path": "/", - "RoleId": "AIDGPMS9RO4H3FEXAMPLE", - "RoleName": "Test-Role" - } - ] - } - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command gets information about the instance profile named ExampleInstanceProfile.", - "id": "463b9ba5-18cc-4608-9ccb-5a7c6b6e5fe7", - "title": "To get information about an instance profile" - } - ], - "GetLoginProfile": [ - { - "input": { - "UserName": "Anika" - }, - "output": { - "LoginProfile": { - "CreateDate": "2012-09-21T23:03:39Z", - "UserName": "Anika" - } - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command gets information about the password for the IAM user named Anika.", - "id": "d6b580cc-909f-4925-9caa-d425cbc1ad47", - "title": "To get password information for an IAM user" - } - ], - "GetOrganizationsAccessReport": [ - { - "input": { - "JobId": "examplea-1234-b567-cde8-90fg123abcd4" - }, - "output": { - "AccessDetails": [ - { - "EntityPath": "o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-1a2b3c-k9l8m7n6o5example/111122223333", - "LastAuthenticatedTime": "2019-05-25T16:29:52Z", - "Region": "us-east-1", - "ServiceName": "Amazon DynamoDB", - "ServiceNamespace": "dynamodb", - "TotalAuthenticatedEntities": 2 - }, - { - "EntityPath": "o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-1a2b3c-k9l8m7n6o5example/123456789012", - "LastAuthenticatedTime": "2019-06-15T13:12:06Z", - "Region": "us-east-1", - "ServiceName": "AWS Identity and Access Management", - "ServiceNamespace": "iam", - "TotalAuthenticatedEntities": 4 - }, - { - "ServiceName": "Amazon Simple Storage Service", - "ServiceNamespace": "s3", - "TotalAuthenticatedEntities": 0 - } - ], - "IsTruncated": false, - "JobCompletionDate": "2019-06-18T19:47:35.241Z", - "JobCreationDate": "2019-06-18T19:47:31.466Z", - "JobStatus": "COMPLETED", - "NumberOfServicesAccessible": 3, - "NumberOfServicesNotAccessed": 1 - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following operation gets details about the report with the job ID: examplea-1234-b567-cde8-90fg123abcd4", - "id": "getorganizationsaccessreport-ou", - "title": "To get details from a previously generated organizational unit report" - } - ], - "GetRole": [ - { - "input": { - "RoleName": "Test-Role" - }, - "output": { - "Role": { - "Arn": "arn:aws:iam::123456789012:role/Test-Role", - "AssumeRolePolicyDocument": "", - "CreateDate": "2013-04-18T05:01:58Z", - "MaxSessionDuration": 3600, - "Path": "/", - "RoleId": "AROADBQP57FF2AEXAMPLE", - "RoleLastUsed": { - "LastUsedDate": "2019-11-18T05:01:58Z", - "Region": "us-east-1" - }, - "RoleName": "Test-Role" - } - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command gets information about the role named Test-Role.", - "id": "5b7d03a6-340c-472d-aa77-56425950d8b0", - "title": "To get information about an IAM role" - } - ], - "GetServiceLastAccessedDetails": [ - { - "input": { - "JobId": "examplef-1305-c245-eba4-71fe298bcda7" - }, - "output": { - "IsTruncated": false, - "JobCompletionDate": "2018-10-24T19:47:35.241Z", - "JobCreationDate": "2018-10-24T19:47:31.466Z", - "JobStatus": "COMPLETED", - "ServicesLastAccessed": [ - { - "LastAuthenticated": "2018-10-24T19:11:00Z", - "LastAuthenticatedEntity": "arn:aws:iam::123456789012:user/AWSExampleUser01", - "ServiceName": "AWS Identity and Access Management", - "ServiceNamespace": "iam", - "TotalAuthenticatedEntities": 2 - }, - { - "ServiceName": "Amazon Simple Storage Service", - "ServiceNamespace": "s3", - "TotalAuthenticatedEntities": 0 - } - ] - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following operation gets details about the report with the job ID: examplef-1305-c245-eba4-71fe298bcda7", - "id": "getserviceaccessdetails-policy-1541696298085", - "title": "To get details from a previously-generated report" - } - ], - "GetServiceLastAccessedDetailsWithEntities": [ - { - "input": { - "JobId": "examplef-1305-c245-eba4-71fe298bcda7", - "ServiceNamespace": "iam" - }, - "output": { - "EntityDetailsList": [ - { - "EntityInfo": { - "Arn": "arn:aws:iam::123456789012:user/AWSExampleUser01", - "Id": "AIDAEX2EXAMPLEB6IGCDC", - "Name": "AWSExampleUser01", - "Path": "/", - "Type": "USER" - }, - "LastAuthenticated": "2018-10-24T19:10:00Z" - }, - { - "EntityInfo": { - "Arn": "arn:aws:iam::123456789012:role/AWSExampleRole01", - "Id": "AROAEAEXAMPLEIANXSIU4", - "Name": "AWSExampleRole01", - "Path": "/", - "Type": "ROLE" - } - } - ], - "IsTruncated": false, - "JobCompletionDate": "2018-10-24T19:47:35.241Z", - "JobCreationDate": "2018-10-24T19:47:31.466Z", - "JobStatus": "COMPLETED" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following operation returns details about the entities that attempted to access the IAM service.", - "id": "getserviceaccessdetailsentity-policy-1541697621384", - "title": "To get sntity details from a previously-generated report" - } - ], - "GetUser": [ - { - "input": { - "UserName": "Bob" - }, - "output": { - "User": { - "Arn": "arn:aws:iam::123456789012:user/Bob", - "CreateDate": "2012-09-21T23:03:13Z", - "Path": "/", - "UserId": "AKIAIOSFODNN7EXAMPLE", - "UserName": "Bob" - } - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command gets information about the IAM user named Bob.", - "id": "ede000a1-9e4c-40db-bd0a-d4f95e41a6ab", - "title": "To get information about an IAM user" - } - ], - "ListAccessKeys": [ - { - "input": { - "UserName": "Alice" - }, - "output": { - "AccessKeyMetadata": [ - { - "AccessKeyId": "AKIA111111111EXAMPLE", - "CreateDate": "2016-12-01T22:19:58Z", - "Status": "Active", - "UserName": "Alice" - }, - { - "AccessKeyId": "AKIA222222222EXAMPLE", - "CreateDate": "2016-12-01T22:20:01Z", - "Status": "Active", - "UserName": "Alice" - } - ] - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command lists the access keys IDs for the IAM user named Alice.", - "id": "15571463-ebea-411a-a021-1c76bd2a3625", - "title": "To list the access key IDs for an IAM user" - } - ], - "ListAccountAliases": [ - { - "input": {}, - "output": { - "AccountAliases": [ - "exmaple-corporation" - ] - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command lists the aliases for the current account.", - "id": "e27b457a-16f9-4e05-a006-3df7b3472741", - "title": "To list account aliases" - } - ], - "ListGroupPolicies": [ - { - "input": { - "GroupName": "Admins" - }, - "output": { - "PolicyNames": [ - "AdminRoot", - "KeyPolicy" - ] - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command lists the names of in-line policies that are embedded in the IAM group named Admins.", - "id": "02de5095-2410-4d3a-ac1b-cc40234af68f", - "title": "To list the in-line policies for an IAM group" - } - ], - "ListGroups": [ - { - "input": {}, - "output": { - "Groups": [ - { - "Arn": "arn:aws:iam::123456789012:group/Admins", - "CreateDate": "2016-12-15T21:40:08.121Z", - "GroupId": "AGPA1111111111EXAMPLE", - "GroupName": "Admins", - "Path": "/division_abc/subdivision_xyz/" - }, - { - "Arn": "arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/engineering/Test", - "CreateDate": "2016-11-30T14:10:01.156Z", - "GroupId": "AGP22222222222EXAMPLE", - "GroupName": "Test", - "Path": "/division_abc/subdivision_xyz/product_1234/engineering/" - }, - { - "Arn": "arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/Managers", - "CreateDate": "2016-06-12T20:14:52.032Z", - "GroupId": "AGPI3333333333EXAMPLE", - "GroupName": "Managers", - "Path": "/division_abc/subdivision_xyz/product_1234/" - } - ] - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command lists the IAM groups in the current account:", - "id": "b3ab1380-2a21-42fb-8e85-503f65512c66", - "title": "To list the IAM groups for the current account" - } - ], - "ListGroupsForUser": [ - { - "input": { - "UserName": "Bob" - }, - "output": { - "Groups": [ - { - "Arn": "arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/engineering/Test", - "CreateDate": "2016-11-30T14:10:01.156Z", - "GroupId": "AGP2111111111EXAMPLE", - "GroupName": "Test", - "Path": "/division_abc/subdivision_xyz/product_1234/engineering/" - }, - { - "Arn": "arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/Managers", - "CreateDate": "2016-06-12T20:14:52.032Z", - "GroupId": "AGPI222222222SEXAMPLE", - "GroupName": "Managers", - "Path": "/division_abc/subdivision_xyz/product_1234/" - } - ] - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command displays the groups that the IAM user named Bob belongs to.", - "id": "278ec2ee-fc28-4136-83fb-433af0ae46a2", - "title": "To list the groups that an IAM user belongs to" - } - ], - "ListOrganizationsFeatures": [ - { - "input": {}, - "output": { - "EnabledFeatures": [ - "RootCredentialsManagement" - ], - "OrganizationId": "o-aa111bb222" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "he following command lists the centralized root access features enabled for your organization.", - "id": "to-list-the-centralized-root-access-features-enabled-for-your-organization-1730908832557", - "title": "To list the centralized root access features enabled for your organization" - } - ], - "ListPoliciesGrantingServiceAccess": [ - { - "input": { - "Arn": "arn:aws:iam::123456789012:user/ExampleUser01", - "ServiceNamespaces": [ - "iam", - "ec2" - ] - }, - "output": { - "IsTruncated": false, - "PoliciesGrantingServiceAccess": [ - { - "Policies": [ - { - "PolicyArn": "arn:aws:iam::123456789012:policy/ExampleIamPolicy", - "PolicyName": "ExampleIamPolicy", - "PolicyType": "MANAGED" - }, - { - "EntityName": "AWSExampleGroup1", - "EntityType": "GROUP", - "PolicyName": "ExampleGroup1Policy", - "PolicyType": "INLINE" - } - ], - "ServiceNamespace": "iam" - }, - { - "Policies": [ - { - "PolicyArn": "arn:aws:iam::123456789012:policy/ExampleEc2Policy", - "PolicyName": "ExampleEc2Policy", - "PolicyType": "MANAGED" - } - ], - "ServiceNamespace": "ec2" - } - ] - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following operation lists policies that allow ExampleUser01 to access IAM or EC2.", - "id": "listpoliciesaccess-user-1541698749508", - "title": "To list policies that allow access to a service" - } - ], - "ListRoleTags": [ - { - "input": { - "RoleName": "taggedrole1" - }, - "output": { - "IsTruncated": false, - "Tags": [ - { - "Key": "Dept", - "Value": "12345" - }, - { - "Key": "Team", - "Value": "Accounting" - } - ] - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following example shows how to list the tags attached to a role.", - "id": "to-list-the-tags-attached-to-an-iam-role-1506719238376", - "title": "To list the tags attached to an IAM role" - } - ], - "ListSigningCertificates": [ - { - "input": { - "UserName": "Bob" - }, - "output": { - "Certificates": [ - { - "CertificateBody": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", - "CertificateId": "TA7SMP42TDN5Z26OBPJE7EXAMPLE", - "Status": "Active", - "UploadDate": "2013-06-06T21:40:08Z", - "UserName": "Bob" - } - ] - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command lists the signing certificates for the IAM user named Bob.", - "id": "b4c10256-4fc9-457e-b3fd-4a110d4d73dc", - "title": "To list the signing certificates for an IAM user" - } - ], - "ListUserTags": [ - { - "input": { - "UserName": "anika" - }, - "output": { - "IsTruncated": false, - "Tags": [ - { - "Key": "Dept", - "Value": "12345" - }, - { - "Key": "Team", - "Value": "Accounting" - } - ] - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following example shows how to list the tags attached to a user.", - "id": "to-list-the-tags-attached-to-an-iam-user-1506719473186", - "title": "To list the tags attached to an IAM user" - } - ], - "ListUsers": [ - { - "input": {}, - "output": { - "Users": [ - { - "Arn": "arn:aws:iam::123456789012:user/division_abc/subdivision_xyz/engineering/Juan", - "CreateDate": "2012-09-05T19:38:48Z", - "PasswordLastUsed": "2016-09-08T21:47:36Z", - "Path": "/division_abc/subdivision_xyz/engineering/", - "UserId": "AID2MAB8DPLSRHEXAMPLE", - "UserName": "Juan" - }, - { - "Arn": "arn:aws:iam::123456789012:user/division_abc/subdivision_xyz/engineering/Anika", - "CreateDate": "2014-04-09T15:43:45Z", - "PasswordLastUsed": "2016-09-24T16:18:07Z", - "Path": "/division_abc/subdivision_xyz/engineering/", - "UserId": "AIDIODR4TAW7CSEXAMPLE", - "UserName": "Anika" - } - ] - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command lists the IAM users in the current account.", - "id": "9edfbd73-03d8-4d8a-9a79-76c85e8c8298", - "title": "To list IAM users" - } - ], - "ListVirtualMFADevices": [ - { - "input": {}, - "output": { - "VirtualMFADevices": [ - { - "SerialNumber": "arn:aws:iam::123456789012:mfa/ExampleMFADevice" - }, - { - "SerialNumber": "arn:aws:iam::123456789012:mfa/Juan" - } - ] - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command lists the virtual MFA devices that have been configured for the current account.", - "id": "54f9ac18-5100-4070-bec4-fe5f612710d5", - "title": "To list virtual MFA devices" - } - ], - "PutGroupPolicy": [ - { - "input": { - "GroupName": "PowerUsers", - "PolicyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":[\"iam:Get*\",\"iam:List*\",\"iam:Generate*\"],\"Resource\":\"*\"}}", - "PolicyName": "IAMReadAccess" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command adds a policy named IAMReadAccess to the IAM group named PowerUsers.", - "id": "4bc17418-758f-4d0f-ab0c-4d00265fec2e", - "title": "To add a policy to a group" - } - ], - "PutRolePolicy": [ - { - "input": { - "PolicyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"s3:*\",\"Resource\":\"*\"}}", - "PolicyName": "S3AccessPolicy", - "RoleName": "S3Access" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command adds a permissions policy to the role named Test-Role.", - "id": "de62fd00-46c7-4601-9e0d-71d5fbb11ecb", - "title": "To attach a permissions policy to an IAM role" - } - ], - "PutUserPolicy": [ - { - "input": { - "PolicyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"*\",\"Resource\":\"*\"}}", - "PolicyName": "AllAccessPolicy", - "UserName": "Bob" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command attaches a policy to the IAM user named Bob.", - "id": "2551ffc6-3576-4d39-823f-30b60bffc2c7", - "title": "To attach a policy to an IAM user" - } - ], - "RemoveRoleFromInstanceProfile": [ - { - "input": { - "InstanceProfileName": "ExampleInstanceProfile", - "RoleName": "Test-Role" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command removes the role named Test-Role from the instance profile named ExampleInstanceProfile.", - "id": "6d9f46f1-9f4a-4873-b403-51a85c5c627c", - "title": "To remove a role from an instance profile" - } - ], - "RemoveUserFromGroup": [ - { - "input": { - "GroupName": "Admins", - "UserName": "Bob" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command removes the user named Bob from the IAM group named Admins.", - "id": "fb54d5b4-0caf-41d8-af0e-10a84413f174", - "title": "To remove a user from an IAM group" - } - ], - "SetSecurityTokenServicePreferences": [ - { - "input": { - "GlobalEndpointTokenVersion": "v2Token" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command sets the STS global endpoint token to version 2. Version 2 tokens are valid in all Regions.", - "id": "61a785a7-d30a-415a-ae18-ab9236e56871", - "title": "To delete an access key for an IAM user" - } - ], - "TagRole": [ - { - "input": { - "RoleName": "taggedrole", - "Tags": [ - { - "Key": "Dept", - "Value": "Accounting" - }, - { - "Key": "CostCenter", - "Value": "12345" - } - ] - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following example shows how to add tags to an existing role.", - "id": "to-add-a-tag-key-and-value-to-an-iam-role-1506718791513", - "title": "To add a tag key and value to an IAM role" - } - ], - "TagUser": [ - { - "input": { - "Tags": [ - { - "Key": "Dept", - "Value": "Accounting" - }, - { - "Key": "CostCenter", - "Value": "12345" - } - ], - "UserName": "anika" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following example shows how to add tags to an existing user.", - "id": "to-add-a-tag-key-and-value-to-an-iam-user-1506719044227", - "title": "To add a tag key and value to an IAM user" - } - ], - "UntagRole": [ - { - "input": { - "RoleName": "taggedrole", - "TagKeys": [ - "Dept" - ] - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following example shows how to remove a tag with the key 'Dept' from a role named 'taggedrole'.", - "id": "to-remove-a-tag-from-an-iam-role-1506719589943", - "title": "To remove a tag from an IAM role" - } - ], - "UntagUser": [ - { - "input": { - "TagKeys": [ - "Dept" - ], - "UserName": "anika" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following example shows how to remove tags that are attached to a user named 'anika'.", - "id": "to-remove-a-tag-from-an-iam-user-1506719725554", - "title": "To remove a tag from an IAM user" - } - ], - "UpdateAccessKey": [ - { - "input": { - "AccessKeyId": "AKIAIOSFODNN7EXAMPLE", - "Status": "Inactive", - "UserName": "Bob" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command deactivates the specified access key (access key ID and secret access key) for the IAM user named Bob.", - "id": "02b556fd-e673-49b7-ab6b-f2f9035967d0", - "title": "To activate or deactivate an access key for an IAM user" - } - ], - "UpdateAccountPasswordPolicy": [ - { - "input": { - "MinimumPasswordLength": 8, - "RequireNumbers": true - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command sets the password policy to require a minimum length of eight characters and to require one or more numbers in the password:", - "id": "c263a1af-37dc-4423-8dba-9790284ef5e0", - "title": "To set or change the current account password policy" - } - ], - "UpdateAssumeRolePolicy": [ - { - "input": { - "PolicyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"Service\":[\"ec2.amazonaws.com\"]},\"Action\":[\"sts:AssumeRole\"]}]}", - "RoleName": "S3AccessForEC2Instances" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command updates the role trust policy for the role named Test-Role:", - "id": "c9150063-d953-4e99-9576-9685872006c6", - "title": "To update the trust policy for an IAM role" - } - ], - "UpdateGroup": [ - { - "input": { - "GroupName": "Test", - "NewGroupName": "Test-1" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command changes the name of the IAM group Test to Test-1.", - "id": "f0cf1662-91ae-4278-a80e-7db54256ccba", - "title": "To rename an IAM group" - } - ], - "UpdateLoginProfile": [ - { - "input": { - "Password": "SomeKindOfPassword123!@#", - "UserName": "Bob" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command creates or changes the password for the IAM user named Bob.", - "id": "036d9498-ecdb-4ed6-a8d8-366c383d1487", - "title": "To change the password for an IAM user" - } - ], - "UpdateSigningCertificate": [ - { - "input": { - "CertificateId": "TA7SMP42TDN5Z26OBPJE7EXAMPLE", - "Status": "Inactive", - "UserName": "Bob" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command changes the status of a signing certificate for a user named Bob to Inactive.", - "id": "829aee7b-efc5-4b3b-84a5-7f899b38018d", - "title": "To change the active status of a signing certificate for an IAM user" - } - ], - "UpdateUser": [ - { - "input": { - "NewUserName": "Robert", - "UserName": "Bob" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command changes the name of the IAM user Bob to Robert. It does not change the user's path.", - "id": "275d53ed-347a-44e6-b7d0-a96276154352", - "title": "To change an IAM user's name" - } - ], - "UploadServerCertificate": [ - { - "input": { - "CertificateBody": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", - "Path": "/company/servercerts/", - "PrivateKey": "-----BEGIN DSA PRIVATE KEY----------END DSA PRIVATE KEY-----", - "ServerCertificateName": "ProdServerCert" - }, - "output": { - "ServerCertificateMetadata": { - "Arn": "arn:aws:iam::123456789012:server-certificate/company/servercerts/ProdServerCert", - "Expiration": "2012-05-08T01:02:03.004Z", - "Path": "/company/servercerts/", - "ServerCertificateId": "ASCA1111111111EXAMPLE", - "ServerCertificateName": "ProdServerCert", - "UploadDate": "2010-05-08T01:02:03.004Z" - } - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following upload-server-certificate command uploads a server certificate to your AWS account:", - "id": "06eab6d1-ebf2-4bd9-839d-f7508b9a38b6", - "title": "To upload a server certificate to your AWS account" - } - ], - "UploadSigningCertificate": [ - { - "input": { - "CertificateBody": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", - "UserName": "Bob" - }, - "output": { - "Certificate": { - "CertificateBody": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", - "CertificateId": "ID123456789012345EXAMPLE", - "Status": "Active", - "UploadDate": "2015-06-06T21:40:08.121Z", - "UserName": "Bob" - } - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following command uploads a signing certificate for the IAM user named Bob.", - "id": "e67489b6-7b73-4e30-9ed3-9a9e0231e458", - "title": "To upload a signing certificate for an IAM user" - } - ] - } -} diff --git a/tools/code-generation/api-descriptions/iam/2010-05-08/paginators-1.json b/tools/code-generation/api-descriptions/iam/2010-05-08/paginators-1.json deleted file mode 100644 index 6c8f8df8499d..000000000000 --- a/tools/code-generation/api-descriptions/iam/2010-05-08/paginators-1.json +++ /dev/null @@ -1,254 +0,0 @@ -{ - "pagination": { - "GetAccountAuthorizationDetails": { - "input_token": "Marker", - "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": "Marker", - "result_key": [ - "UserDetailList", - "GroupDetailList", - "RoleDetailList", - "Policies" - ] - }, - "GetGroup": { - "input_token": "Marker", - "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": "Marker", - "result_key": "Users" - }, - "ListAccessKeys": { - "input_token": "Marker", - "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": "Marker", - "result_key": "AccessKeyMetadata" - }, - "ListAccountAliases": { - "input_token": "Marker", - "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": "Marker", - "result_key": "AccountAliases" - }, - "ListAttachedGroupPolicies": { - "input_token": "Marker", - "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": "Marker", - "result_key": "AttachedPolicies" - }, - "ListAttachedRolePolicies": { - "input_token": "Marker", - "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": "Marker", - "result_key": "AttachedPolicies" - }, - "ListAttachedUserPolicies": { - "input_token": "Marker", - "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": "Marker", - "result_key": "AttachedPolicies" - }, - "ListEntitiesForPolicy": { - "input_token": "Marker", - "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": "Marker", - "result_key": [ - "PolicyGroups", - "PolicyUsers", - "PolicyRoles" - ] - }, - "ListGroupPolicies": { - "input_token": "Marker", - "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": "Marker", - "result_key": "PolicyNames" - }, - "ListGroups": { - "input_token": "Marker", - "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": "Marker", - "result_key": "Groups" - }, - "ListGroupsForUser": { - "input_token": "Marker", - "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": "Marker", - "result_key": "Groups" - }, - "ListInstanceProfileTags": { - "input_token": "Marker", - "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": "Marker", - "result_key": "Tags" - }, - "ListInstanceProfiles": { - "input_token": "Marker", - "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": "Marker", - "result_key": "InstanceProfiles" - }, - "ListInstanceProfilesForRole": { - "input_token": "Marker", - "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": "Marker", - "result_key": "InstanceProfiles" - }, - "ListMFADeviceTags": { - "input_token": "Marker", - "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": "Marker", - "result_key": "Tags" - }, - "ListMFADevices": { - "input_token": "Marker", - "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": "Marker", - "result_key": "MFADevices" - }, - "ListOpenIDConnectProviderTags": { - "input_token": "Marker", - "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": "Marker", - "result_key": "Tags" - }, - "ListPolicies": { - "input_token": "Marker", - "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": "Marker", - "result_key": "Policies" - }, - "ListPolicyTags": { - "input_token": "Marker", - "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": "Marker", - "result_key": "Tags" - }, - "ListPolicyVersions": { - "input_token": "Marker", - "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": "Marker", - "result_key": "Versions" - }, - "ListRolePolicies": { - "input_token": "Marker", - "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": "Marker", - "result_key": "PolicyNames" - }, - "ListRoleTags": { - "input_token": "Marker", - "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": "Marker", - "result_key": "Tags" - }, - "ListRoles": { - "input_token": "Marker", - "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": "Marker", - "result_key": "Roles" - }, - "ListSAMLProviderTags": { - "input_token": "Marker", - "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": "Marker", - "result_key": "Tags" - }, - "ListSAMLProviders": { - "result_key": "SAMLProviderList" - }, - "ListSSHPublicKeys": { - "input_token": "Marker", - "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": "Marker", - "result_key": "SSHPublicKeys" - }, - "ListServerCertificateTags": { - "input_token": "Marker", - "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": "Marker", - "result_key": "Tags" - }, - "ListServerCertificates": { - "input_token": "Marker", - "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": "Marker", - "result_key": "ServerCertificateMetadataList" - }, - "ListSigningCertificates": { - "input_token": "Marker", - "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": "Marker", - "result_key": "Certificates" - }, - "ListUserPolicies": { - "input_token": "Marker", - "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": "Marker", - "result_key": "PolicyNames" - }, - "ListUserTags": { - "input_token": "Marker", - "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": "Marker", - "result_key": "Tags" - }, - "ListUsers": { - "input_token": "Marker", - "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": "Marker", - "result_key": "Users" - }, - "ListVirtualMFADevices": { - "input_token": "Marker", - "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": "Marker", - "result_key": "VirtualMFADevices" - }, - "SimulateCustomPolicy": { - "input_token": "Marker", - "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": "Marker", - "result_key": "EvaluationResults" - }, - "SimulatePrincipalPolicy": { - "input_token": "Marker", - "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": "Marker", - "result_key": "EvaluationResults" - } - } -} \ No newline at end of file diff --git a/tools/code-generation/api-descriptions/iam/2010-05-08/resources-1.json b/tools/code-generation/api-descriptions/iam/2010-05-08/resources-1.json deleted file mode 100644 index 7ce6980e887d..000000000000 --- a/tools/code-generation/api-descriptions/iam/2010-05-08/resources-1.json +++ /dev/null @@ -1,1740 +0,0 @@ -{ - "service": { - "actions": { - "ChangePassword": { - "request": { "operation": "ChangePassword" } - }, - "CreateAccountAlias": { - "request": { "operation": "CreateAccountAlias" } - }, - "CreateAccountPasswordPolicy": { - "request": { "operation": "UpdateAccountPasswordPolicy" }, - "resource": { - "type": "AccountPasswordPolicy", - "identifiers": [ ] - } - }, - "CreateGroup": { - "request": { "operation": "CreateGroup" }, - "resource": { - "type": "Group", - "identifiers": [ - { "target": "Name", "source": "requestParameter", "path": "GroupName" } - ], - "path": "Group" - } - }, - "CreateInstanceProfile": { - "request": { "operation": "CreateInstanceProfile" }, - "resource": { - "type": "InstanceProfile", - "identifiers": [ - { "target": "Name", "source": "requestParameter", "path": "InstanceProfileName" } - ], - "path": "InstanceProfile" - } - }, - "CreatePolicy": { - "request": { "operation": "CreatePolicy" }, - "resource": { - "type": "Policy", - "identifiers": [ - { "target": "Arn", "source": "response", "path": "Policy.Arn" } - ] - } - }, - "CreateRole": { - "request": { "operation": "CreateRole" }, - "resource": { - "type": "Role", - "identifiers": [ - { "target": "Name", "source": "requestParameter", "path": "RoleName" } - ], - "path": "Role" - } - }, - "CreateSamlProvider": { - "request": { "operation": "CreateSAMLProvider" }, - "resource": { - "type": "SamlProvider", - "identifiers": [ - { "target": "Arn", "source": "response", "path": "SAMLProviderArn" } - ] - } - }, - "CreateServerCertificate": { - "request": { "operation": "UploadServerCertificate" }, - "resource": { - "type": "ServerCertificate", - "identifiers": [ - { "target": "Name", "source": "requestParameter", "path": "ServerCertificateName" } - ] - } - }, - "CreateSigningCertificate": { - "request": { "operation": "UploadSigningCertificate" }, - "resource": { - "type": "SigningCertificate", - "identifiers": [ - { "target": "Id", "source": "response", "path": "Certificate.CertificateId" } - ], - "path": "Certificate" - } - }, - "CreateUser": { - "request": { "operation": "CreateUser" }, - "resource": { - "type": "User", - "identifiers": [ - { "target": "Name", "source": "requestParameter", "path": "UserName" } - ], - "path": "User" - } - }, - "CreateVirtualMfaDevice": { - "request": { "operation": "CreateVirtualMFADevice" }, - "resource": { - "type": "VirtualMfaDevice", - "identifiers": [ - { "target": "SerialNumber", "source": "response", "path": "VirtualMFADevice.SerialNumber" } - ], - "path": "VirtualMFADevice" - } - } - }, - "has": { - "AccountPasswordPolicy": { - "resource": { - "type": "AccountPasswordPolicy", - "identifiers": [ ] - } - }, - "AccountSummary": { - "resource": { - "type": "AccountSummary", - "identifiers": [ ] - } - }, - "CurrentUser": { - "resource": { - "type": "CurrentUser", - "identifiers": [ ] - } - }, - "Group": { - "resource": { - "type": "Group", - "identifiers": [ - { "target": "Name", "source": "input" } - ] - } - }, - "InstanceProfile": { - "resource": { - "type": "InstanceProfile", - "identifiers": [ - { "target": "Name", "source": "input" } - ] - } - }, - "Policy": { - "resource": { - "type": "Policy", - "identifiers": [ - { "target": "Arn", "source": "input" } - ] - } - }, - "Role": { - "resource": { - "type": "Role", - "identifiers": [ - { "target": "Name", "source": "input" } - ] - } - }, - "SamlProvider": { - "resource": { - "type": "SamlProvider", - "identifiers": [ - { "target": "Arn", "source": "input" } - ] - } - }, - "ServerCertificate": { - "resource": { - "type": "ServerCertificate", - "identifiers": [ - { "target": "Name", "source": "input" } - ] - } - }, - "User": { - "resource": { - "type": "User", - "identifiers": [ - { "target": "Name", "source": "input" } - ] - } - }, - "VirtualMfaDevice": { - "resource": { - "type": "VirtualMfaDevice", - "identifiers": [ - { "target": "SerialNumber", "source": "input" } - ] - } - } - }, - "hasMany": { - "Groups": { - "request": { "operation": "ListGroups" }, - "resource": { - "type": "Group", - "identifiers": [ - { "target": "Name", "source": "response", "path": "Groups[].GroupName" } - ], - "path": "Groups[]" - } - }, - "InstanceProfiles": { - "request": { "operation": "ListInstanceProfiles" }, - "resource": { - "type": "InstanceProfile", - "identifiers": [ - { "target": "Name", "source": "response", "path": "InstanceProfiles[].InstanceProfileName" } - ], - "path": "InstanceProfiles[]" - } - }, - "Policies": { - "request": { "operation": "ListPolicies" }, - "resource": { - "type": "Policy", - "identifiers": [ - { "target": "Arn", "source": "response", "path": "Policies[].Arn" } - ], - "path": "Policies[]" - } - }, - "Roles": { - "request": { "operation": "ListRoles" }, - "resource": { - "type": "Role", - "identifiers": [ - { "target": "Name", "source": "response", "path": "Roles[].RoleName" } - ], - "path": "Roles[]" - } - }, - "SamlProviders": { - "request": { "operation": "ListSAMLProviders" }, - "resource": { - "type": "SamlProvider", - "identifiers": [ - { "target": "Arn", "source": "response", "path": "SAMLProviderList[].Arn" } - ] - } - }, - "ServerCertificates": { - "request": { "operation": "ListServerCertificates" }, - "resource": { - "type": "ServerCertificate", - "identifiers": [ - { "target": "Name", "source": "response", "path": "ServerCertificateMetadataList[].ServerCertificateName" } - ] - } - }, - "Users": { - "request": { "operation": "ListUsers" }, - "resource": { - "type": "User", - "identifiers": [ - { "target": "Name", "source": "response", "path": "Users[].UserName" } - ], - "path": "Users[]" - } - }, - "VirtualMfaDevices": { - "request": { "operation": "ListVirtualMFADevices" }, - "resource": { - "type": "VirtualMfaDevice", - "identifiers": [ - { "target": "SerialNumber", "source": "response", "path": "VirtualMFADevices[].SerialNumber" } - ], - "path": "VirtualMFADevices[]" - } - } - } - }, - "resources": { - "AccessKey": { - "identifiers": [ - { - "name": "UserName", - "memberName": "UserName" - }, - { - "name": "Id", - "memberName": "AccessKeyId" - } - ], - "shape": "AccessKeyMetadata", - "actions": { - "Activate": { - "request": { - "operation": "UpdateAccessKey", - "params": [ - { "target": "UserName", "source": "identifier", "name": "UserName" }, - { "target": "AccessKeyId", "source": "identifier", "name": "Id" }, - { "target": "Status", "source": "string", "value": "Active" } - ] - } - }, - "Deactivate": { - "request": { - "operation": "UpdateAccessKey", - "params": [ - { "target": "UserName", "source": "identifier", "name": "UserName" }, - { "target": "AccessKeyId", "source": "identifier", "name": "Id" }, - { "target": "Status", "source": "string", "value": "Inactive" } - ] - } - }, - "Delete": { - "request": { - "operation": "DeleteAccessKey", - "params": [ - { "target": "UserName", "source": "identifier", "name": "UserName" }, - { "target": "AccessKeyId", "source": "identifier", "name": "Id" } - ] - } - } - }, - "has": { - "User": { - "resource": { - "type": "User", - "identifiers": [ - { "target": "Name", "source": "identifier", "name": "UserName" } - ] - } - } - } - }, - "AccessKeyPair": { - "identifiers": [ - { - "name": "UserName", - "memberName": "UserName" - }, - { - "name": "Id", - "memberName": "AccessKeyId" - }, - { - "name": "Secret", - "memberName": "SecretAccessKey" - } - ], - "shape": "AccessKey", - "actions": { - "Activate": { - "request": { - "operation": "UpdateAccessKey", - "params": [ - { "target": "UserName", "source": "identifier", "name": "UserName" }, - { "target": "AccessKeyId", "source": "identifier", "name": "Id" }, - { "target": "Status", "source": "string", "value": "Active" } - ] - } - }, - "Deactivate": { - "request": { - "operation": "UpdateAccessKey", - "params": [ - { "target": "UserName", "source": "identifier", "name": "UserName" }, - { "target": "AccessKeyId", "source": "identifier", "name": "Id" }, - { "target": "Status", "source": "string", "value": "Inactive" } - ] - } - }, - "Delete": { - "request": { - "operation": "DeleteAccessKey", - "params": [ - { "target": "UserName", "source": "identifier", "name": "UserName" }, - { "target": "AccessKeyId", "source": "identifier", "name": "Id" } - ] - } - } - } - }, - "AccountPasswordPolicy": { - "identifiers": [ ], - "shape": "PasswordPolicy", - "load": { - "request": { "operation": "GetAccountPasswordPolicy" }, - "path": "PasswordPolicy" - }, - "actions": { - "Delete": { - "request": { "operation": "DeleteAccountPasswordPolicy" } - }, - "Update": { - "request": { "operation": "UpdateAccountPasswordPolicy" } - } - } - }, - "AccountSummary": { - "identifiers": [ ], - "shape": "GetAccountSummaryResponse", - "load": { - "request": { "operation": "GetAccountSummary" }, - "path": "@" - } - }, - "AssumeRolePolicy": { - "identifiers": [ - { "name": "RoleName" } - ], - "actions": { - "Update": { - "request": { - "operation": "UpdateAssumeRolePolicy", - "params": [ - { "target": "RoleName", "source": "identifier", "name": "RoleName" } - ] - } - } - }, - "has": { - "Role": { - "resource": { - "type": "Role", - "identifiers": [ - { "target": "Name", "source": "identifier", "name": "RoleName" } - ] - } - } - } - }, - "CurrentUser": { - "identifiers": [ ], - "shape": "User", - "load": { - "request": { "operation": "GetUser" }, - "path": "User" - }, - "has": { - "User": { - "resource": { - "type": "User", - "identifiers": [ - { "target": "Name", "source": "data", "path": "UserName" } - ] - } - } - }, - "hasMany": { - "AccessKeys": { - "request": { "operation": "ListAccessKeys" }, - "resource": { - "type": "AccessKey", - "identifiers": [ - { "target": "UserName", "source": "response", "path": "AccessKeyMetadata[].UserName" }, - { "target": "Id", "source": "response", "path": "AccessKeyMetadata[].AccessKeyId" } - ], - "path": "AccessKeyMetadata[]" - } - }, - "MfaDevices": { - "request": { "operation": "ListMFADevices" }, - "resource": { - "type": "MfaDevice", - "identifiers": [ - { "target": "UserName", "source": "response", "path": "MFADevices[].UserName" }, - { "target": "SerialNumber", "source": "response", "path": "MFADevices[].SerialNumber" } - ], - "path": "MFADevices[]" - } - }, - "SigningCertificates": { - "request": { "operation": "ListSigningCertificates" }, - "resource": { - "type": "SigningCertificate", - "identifiers": [ - { "target": "UserName", "source": "response", "path": "Certificates[].UserName" }, - { "target": "Id", "source": "response", "path": "Certificates[].CertificateId" } - ], - "path": "Certificates[]" - } - } - } - }, - "Group": { - "identifiers": [ - { - "name": "Name", - "memberName": "GroupName" - } - ], - "shape": "Group", - "load": { - "request": { - "operation": "GetGroup", - "params": [ - { "target": "GroupName", "source": "identifier", "name": "Name" } - ] - }, - "path": "Group" - }, - "actions": { - "AddUser": { - "request": { - "operation": "AddUserToGroup", - "params": [ - { "target": "GroupName", "source": "identifier", "name": "Name" } - ] - } - }, - "AttachPolicy": { - "request": { - "operation": "AttachGroupPolicy", - "params": [ - { "target": "GroupName", "source": "identifier", "name": "Name" } - ] - } - }, - "Create": { - "request": { - "operation": "CreateGroup", - "params": [ - { "target": "GroupName", "source": "identifier", "name": "Name" } - ] - }, - "resource": { - "type": "Group", - "identifiers": [ - { "target": "Name", "source": "requestParameter", "path": "GroupName" } - ], - "path": "Group" - } - }, - "CreatePolicy": { - "request": { - "operation": "PutGroupPolicy", - "params": [ - { "target": "GroupName", "source": "identifier", "name": "Name" } - ] - }, - "resource": { - "type": "GroupPolicy", - "identifiers": [ - { "target": "GroupName", "source": "identifier", "name": "Name" }, - { "target": "Name", "source": "requestParameter", "path": "PolicyName" } - ] - } - }, - "Delete": { - "request": { - "operation": "DeleteGroup", - "params": [ - { "target": "GroupName", "source": "identifier", "name": "Name" } - ] - } - }, - "DetachPolicy": { - "request": { - "operation": "DetachGroupPolicy", - "params": [ - { "target": "GroupName", "source": "identifier", "name": "Name" } - ] - } - }, - "RemoveUser": { - "request": { - "operation": "RemoveUserFromGroup", - "params": [ - { "target": "GroupName", "source": "identifier", "name": "Name" } - ] - } - }, - "Update": { - "request": { - "operation": "UpdateGroup", - "params": [ - { "target": "GroupName", "source": "identifier", "name": "Name" } - ] - }, - "resource": { - "type": "Group", - "identifiers": [ - { "target": "Name", "source": "requestParameter", "path": "NewGroupName" } - ] - } - } - }, - "has": { - "Policy": { - "resource": { - "type": "GroupPolicy", - "identifiers": [ - { "target": "GroupName", "source": "identifier", "name": "Name" }, - { "target": "Name", "source": "input" } - ] - } - } - }, - "hasMany": { - "AttachedPolicies": { - "request": { - "operation": "ListAttachedGroupPolicies", - "params": [ - { "target": "GroupName", "source": "identifier", "name": "Name" } - ] - }, - "resource": { - "type": "Policy", - "identifiers": [ - { "target": "Arn", "source": "response", "path": "AttachedPolicies[].PolicyArn" } - ] - } - }, - "Policies": { - "request": { - "operation": "ListGroupPolicies", - "params": [ - { "target": "GroupName", "source": "identifier", "name": "Name" } - ] - }, - "resource": { - "type": "GroupPolicy", - "identifiers": [ - { "target": "GroupName", "source": "identifier", "name": "Name" }, - { "target": "Name", "source": "response", "path": "PolicyNames[]" } - ] - } - }, - "Users": { - "request": { - "operation": "GetGroup", - "params": [ - { "target": "GroupName", "source": "identifier", "name": "Name" } - ] - }, - "resource": { - "type": "User", - "identifiers": [ - { "target": "Name", "source": "response", "path": "Users[].UserName" } - ], - "path": "Users[]" - } - } - } - }, - "GroupPolicy": { - "identifiers": [ - { - "name": "GroupName", - "memberName": "GroupName" - }, - { - "name": "Name", - "memberName": "PolicyName" - } - ], - "shape": "GetGroupPolicyResponse", - "load": { - "request": { - "operation": "GetGroupPolicy", - "params": [ - { "target": "GroupName", "source": "identifier", "name": "GroupName" }, - { "target": "PolicyName", "source": "identifier", "name": "Name" } - ] - }, - "path": "@" - }, - "actions": { - "Delete": { - "request": { - "operation": "DeleteGroupPolicy", - "params": [ - { "target": "GroupName", "source": "identifier", "name": "GroupName" }, - { "target": "PolicyName", "source": "identifier", "name": "Name" } - ] - } - }, - "Put": { - "request": { - "operation": "PutGroupPolicy", - "params": [ - { "target": "GroupName", "source": "identifier", "name": "GroupName" }, - { "target": "PolicyName", "source": "identifier", "name": "Name" } - ] - } - } - }, - "has": { - "Group": { - "resource": { - "type": "Group", - "identifiers": [ - { "target": "Name", "source": "identifier", "name": "GroupName" } - ] - } - } - } - }, - "InstanceProfile": { - "identifiers": [ - { - "name": "Name", - "memberName": "InstanceProfileName" - } - ], - "shape": "InstanceProfile", - "load": { - "request": { - "operation": "GetInstanceProfile", - "params": [ - { "target": "InstanceProfileName", "source": "identifier", "name": "Name" } - ] - }, - "path": "InstanceProfile" - }, - "actions": { - "AddRole": { - "request": { - "operation": "AddRoleToInstanceProfile", - "params": [ - { "target": "InstanceProfileName", "source": "identifier", "name": "Name" } - ] - } - }, - "Delete": { - "request": { - "operation": "DeleteInstanceProfile", - "params": [ - { "target": "InstanceProfileName", "source": "identifier", "name": "Name" } - ] - } - }, - "RemoveRole": { - "request": { - "operation": "RemoveRoleFromInstanceProfile", - "params": [ - { "target": "InstanceProfileName", "source": "identifier", "name": "Name" } - ] - } - } - }, - "waiters": { - "Exists": { - "waiterName": "InstanceProfileExists", - "params": [ - { "target": "InstanceProfileName", "source": "identifier", "name": "Name" } - ] - } - }, - "has": { - "Roles": { - "resource": { - "type": "Role", - "identifiers": [ - { "target": "Name", "source": "data", "path": "Roles[].RoleName" } - ], - "path": "Roles[]" - } - } - } - }, - "LoginProfile": { - "identifiers": [ - { - "name": "UserName", - "memberName": "UserName" - } - ], - "shape": "LoginProfile", - "load": { - "request": { - "operation": "GetLoginProfile", - "params": [ - { "target": "UserName", "source": "identifier", "name": "UserName" } - ] - }, - "path": "LoginProfile" - }, - "actions": { - "Create": { - "request": { - "operation": "CreateLoginProfile", - "params": [ - { "target": "UserName", "source": "identifier", "name": "UserName" } - ] - }, - "resource": { - "type": "LoginProfile", - "identifiers": [ - { "target": "UserName", "source": "response", "path": "LoginProfile.UserName" } - ], - "path": "LoginProfile" - } - }, - "Delete": { - "request": { - "operation": "DeleteLoginProfile", - "params": [ - { "target": "UserName", "source": "identifier", "name": "UserName" } - ] - } - }, - "Update": { - "request": { - "operation": "UpdateLoginProfile", - "params": [ - { "target": "UserName", "source": "identifier", "name": "UserName" } - ] - } - } - }, - "has": { - "User": { - "resource": { - "type": "User", - "identifiers": [ - { "target": "Name", "source": "identifier", "name": "UserName" } - ] - } - } - } - }, - "MfaDevice": { - "identifiers": [ - { - "name": "UserName", - "memberName": "UserName" - }, - { - "name": "SerialNumber", - "memberName": "SerialNumber" - } - ], - "shape": "MFADevice", - "actions": { - "Associate": { - "request": { - "operation": "EnableMFADevice", - "params": [ - { "target": "UserName", "source": "identifier", "name": "UserName" }, - { "target": "SerialNumber", "source": "identifier", "name": "SerialNumber" } - ] - } - }, - "Disassociate": { - "request": { - "operation": "DeactivateMFADevice", - "params": [ - { "target": "UserName", "source": "identifier", "name": "UserName" }, - { "target": "SerialNumber", "source": "identifier", "name": "SerialNumber" } - ] - } - }, - "Resync": { - "request": { - "operation": "ResyncMFADevice", - "params": [ - { "target": "UserName", "source": "identifier", "name": "UserName" }, - { "target": "SerialNumber", "source": "identifier", "name": "SerialNumber" } - ] - } - } - }, - "has": { - "User": { - "resource": { - "type": "User", - "identifiers": [ - { "target": "Name", "source": "identifier", "name": "UserName" } - ] - } - } - } - }, - "Policy": { - "identifiers": [ - { - "name": "Arn", - "memberName": "Arn" - } - ], - "shape": "Policy", - "load": { - "request": { - "operation": "GetPolicy", - "params": [ - { "target": "PolicyArn", "source": "identifier", "name": "Arn" } - ] - }, - "path": "Policy" - }, - "actions": { - "AttachGroup": { - "request": { - "operation": "AttachGroupPolicy", - "params": [ - { "target": "PolicyArn", "source": "identifier", "name": "Arn" } - ] - } - }, - "AttachRole": { - "request": { - "operation": "AttachRolePolicy", - "params": [ - { "target": "PolicyArn", "source": "identifier", "name": "Arn" } - ] - } - }, - "AttachUser": { - "request": { - "operation": "AttachUserPolicy", - "params": [ - { "target": "PolicyArn", "source": "identifier", "name": "Arn" } - ] - } - }, - "CreateVersion": { - "request": { - "operation": "CreatePolicyVersion", - "params": [ - { "target": "PolicyArn", "source": "identifier", "name": "Arn" } - ] - }, - "resource": { - "type": "PolicyVersion", - "identifiers": [ - { "target": "Arn", "source": "identifier", "name": "Arn" }, - { "target": "VersionId", "source": "response", "path": "PolicyVersion.VersionId" } - ] - } - }, - "Delete": { - "request": { - "operation": "DeletePolicy", - "params": [ - { "target": "PolicyArn", "source": "identifier", "name": "Arn" } - ] - } - }, - "DetachGroup": { - "request": { - "operation": "DetachGroupPolicy", - "params": [ - { "target": "PolicyArn", "source": "identifier", "name": "Arn" } - ] - } - }, - "DetachRole": { - "request": { - "operation": "DetachRolePolicy", - "params": [ - { "target": "PolicyArn", "source": "identifier", "name": "Arn" } - ] - } - }, - "DetachUser": { - "request": { - "operation": "DetachUserPolicy", - "params": [ - { "target": "PolicyArn", "source": "identifier", "name": "Arn" } - ] - } - } - }, - "has": { - "DefaultVersion": { - "resource": { - "type": "PolicyVersion", - "identifiers": [ - { "target": "Arn", "source": "identifier", "name": "Arn" }, - { "target": "VersionId", "source": "data", "path": "DefaultVersionId" } - ] - } - } - }, - "hasMany": { - "AttachedGroups": { - "request": { - "operation": "ListEntitiesForPolicy", - "params": [ - { "target": "PolicyArn", "source": "identifier", "name": "Arn" }, - { "target": "EntityFilter", "source": "string", "value": "Group" } - ] - }, - "resource": { - "type": "Group", - "identifiers": [ - { "target": "Name", "source": "response", "path": "PolicyGroups[].GroupName" } - ], - "path": "PolicyGroups[]" - } - }, - "AttachedRoles": { - "request": { - "operation": "ListEntitiesForPolicy", - "params": [ - { "target": "PolicyArn", "source": "identifier", "name": "Arn" }, - { "target": "EntityFilter", "source": "string", "value": "Role" } - ] - }, - "resource": { - "type": "Role", - "identifiers": [ - { "target": "Name", "source": "response", "path": "PolicyRoles[].RoleName" } - ], - "path": "PolicyRoles[]" - } - }, - "AttachedUsers": { - "request": { - "operation": "ListEntitiesForPolicy", - "params": [ - { "target": "PolicyArn", "source": "identifier", "name": "Arn" }, - { "target": "EntityFilter", "source": "string", "value": "User" } - ] - }, - "resource": { - "type": "User", - "identifiers": [ - { "target": "Name", "source": "response", "path": "PolicyUsers[].UserName" } - ], - "path": "PolicyRoles[]" - } - }, - "Versions": { - "request": { - "operation": "ListPolicyVersions", - "params": [ - { "target": "PolicyArn", "source": "identifier", "name": "Arn" } - ] - }, - "resource": { - "type": "PolicyVersion", - "identifiers": [ - { "target": "Arn", "source": "identifier", "name": "Arn" }, - { "target": "VersionId", "source": "response", "path": "Versions[].VersionId" } - ], - "path": "Versions[]" - } - } - } - }, - "PolicyVersion": { - "identifiers": [ - { "name": "Arn" }, - { "name": "VersionId" } - ], - "shape": "PolicyVersion", - "load": { - "request": { - "operation": "GetPolicyVersion", - "params": [ - { "target": "PolicyArn", "source": "identifier", "name": "Arn" }, - { "target": "VersionId", "source": "identifier", "name": "VersionId" } - ] - }, - "path": "PolicyVersion" - }, - "actions": { - "Delete": { - "request": { - "operation": "DeletePolicyVersion", - "params": [ - { "target": "PolicyArn", "source": "identifier", "name": "Arn" }, - { "target": "VersionId", "source": "identifier", "name": "VersionId" } - ] - } - }, - "SetAsDefault": { - "request": { - "operation": "SetDefaultPolicyVersion", - "params": [ - { "target": "PolicyArn", "source": "identifier", "name": "Arn" }, - { "target": "VersionId", "source": "identifier", "name": "VersionId" } - ] - } - } - } - }, - "Role": { - "identifiers": [ - { - "name": "Name", - "memberName": "RoleName" - } - ], - "shape": "Role", - "load": { - "request": { - "operation": "GetRole", - "params": [ - { "target": "RoleName", "source": "identifier", "name": "Name" } - ] - }, - "path": "Role" - }, - "actions": { - "AttachPolicy": { - "request": { - "operation": "AttachRolePolicy", - "params": [ - { "target": "RoleName", "source": "identifier", "name": "Name" } - ] - } - }, - "Delete": { - "request": { - "operation": "DeleteRole", - "params": [ - { "target": "RoleName", "source": "identifier", "name": "Name" } - ] - } - }, - "DetachPolicy": { - "request": { - "operation": "DetachRolePolicy", - "params": [ - { "target": "RoleName", "source": "identifier", "name": "Name" } - ] - } - } - }, - "has": { - "AssumeRolePolicy": { - "resource": { - "type": "AssumeRolePolicy", - "identifiers": [ - { "target": "RoleName", "source": "identifier", "name": "Name" } - ] - } - }, - "Policy": { - "resource": { - "type": "RolePolicy", - "identifiers": [ - { "target": "RoleName", "source": "identifier", "name": "Name" }, - { "target": "Name", "source": "input" } - ] - } - } - }, - "hasMany": { - "AttachedPolicies": { - "request": { - "operation": "ListAttachedRolePolicies", - "params": [ - { "target": "RoleName", "source": "identifier", "name": "Name" } - ] - }, - "resource": { - "type": "Policy", - "identifiers": [ - { "target": "Arn", "source": "response", "path": "AttachedPolicies[].PolicyArn" } - ] - } - }, - "InstanceProfiles": { - "request": { - "operation": "ListInstanceProfilesForRole", - "params": [ - { "target": "RoleName", "source": "identifier", "name": "Name" } - ] - }, - "resource": { - "type": "InstanceProfile", - "identifiers": [ - { "target": "Name", "source": "response", "path": "InstanceProfiles[].InstanceProfileName" } - ], - "path": "InstanceProfiles[]" - } - }, - "Policies": { - "request": { - "operation": "ListRolePolicies", - "params": [ - { "target": "RoleName", "source": "identifier", "name": "Name" } - ] - }, - "resource": { - "type": "RolePolicy", - "identifiers": [ - { "target": "RoleName", "source": "identifier", "name": "Name" }, - { "target": "Name", "source": "response", "path": "PolicyNames[]" } - ] - } - } - } - }, - "RolePolicy": { - "identifiers": [ - { - "name": "RoleName", - "memberName": "RoleName" - }, - { - "name": "Name", - "memberName": "PolicyName" - } - ], - "shape": "GetRolePolicyResponse", - "load": { - "request": { - "operation": "GetRolePolicy", - "params": [ - { "target": "RoleName", "source": "identifier", "name": "RoleName" }, - { "target": "PolicyName", "source": "identifier", "name": "Name" } - ] - }, - "path": "@" - }, - "actions": { - "Delete": { - "request": { - "operation": "DeleteRolePolicy", - "params": [ - { "target": "RoleName", "source": "identifier", "name": "RoleName" }, - { "target": "PolicyName", "source": "identifier", "name": "Name" } - ] - } - }, - "Put": { - "request": { - "operation": "PutRolePolicy", - "params": [ - { "target": "RoleName", "source": "identifier", "name": "RoleName" }, - { "target": "PolicyName", "source": "identifier", "name": "Name" } - ] - } - } - }, - "has": { - "Role": { - "resource": { - "type": "Role", - "identifiers": [ - { "target": "Name", "source": "identifier", "name": "RoleName" } - ] - } - } - } - }, - "SamlProvider": { - "identifiers": [ - { "name": "Arn" } - ], - "shape": "GetSAMLProviderResponse", - "load": { - "request": { - "operation": "GetSAMLProvider", - "params": [ - { "target": "SAMLProviderArn", "source": "identifier", "name": "Arn" } - ] - }, - "path": "@" - }, - "actions": { - "Delete": { - "request": { - "operation": "DeleteSAMLProvider", - "params": [ - { "target": "SAMLProviderArn", "source": "identifier", "name": "Arn" } - ] - } - }, - "Update": { - "request": { - "operation": "UpdateSAMLProvider", - "params": [ - { "target": "SAMLProviderArn", "source": "identifier", "name": "Arn" } - ] - } - } - } - }, - "ServerCertificate": { - "identifiers": [ - { "name": "Name" } - ], - "shape": "ServerCertificate", - "load": { - "request": { - "operation": "GetServerCertificate", - "params": [ - { "target": "ServerCertificateName", "source": "identifier", "name": "Name" } - ] - }, - "path": "ServerCertificate" - }, - "actions": { - "Delete": { - "request": { - "operation": "DeleteServerCertificate", - "params": [ - { "target": "ServerCertificateName", "source": "identifier", "name": "Name" } - ] - } - }, - "Update": { - "request": { - "operation": "UpdateServerCertificate", - "params": [ - { "target": "ServerCertificateName", "source": "identifier", "name": "Name" } - ] - }, - "resource": { - "type": "ServerCertificate", - "identifiers": [ - { "target": "Name", "source": "requestParameter", "path": "NewServerCertificateName" } - ] - } - } - } - }, - "SigningCertificate": { - "identifiers": [ - { - "name": "UserName", - "memberName": "UserName" - }, - { - "name": "Id", - "memberName": "CertificateId" - } - ], - "shape": "SigningCertificate", - "actions": { - "Activate": { - "request": { - "operation": "UpdateSigningCertificate", - "params": [ - { "target": "UserName", "source": "identifier", "name": "UserName" }, - { "target": "CertificateId", "source": "identifier", "name": "Id" }, - { "target": "Status", "source": "string", "value": "Active" } - ] - } - }, - "Deactivate": { - "request": { - "operation": "UpdateSigningCertificate", - "params": [ - { "target": "UserName", "source": "identifier", "name": "UserName" }, - { "target": "CertificateId", "source": "identifier", "name": "Id" }, - { "target": "Status", "source": "string", "value": "Inactive" } - ] - } - }, - "Delete": { - "request": { - "operation": "DeleteSigningCertificate", - "params": [ - { "target": "UserName", "source": "identifier", "name": "UserName" }, - { "target": "CertificateId", "source": "identifier", "name": "Id" } - ] - } - } - }, - "has": { - "User": { - "resource": { - "type": "User", - "identifiers": [ - { "target": "Name", "source": "identifier", "name": "UserName" } - ] - } - } - } - }, - "User": { - "identifiers": [ - { - "name": "Name", - "memberName": "UserName" - } - ], - "shape": "User", - "load": { - "request": { - "operation": "GetUser", - "params": [ - { "target": "UserName", "source": "identifier", "name": "Name" } - ] - }, - "path": "User" - }, - "actions": { - "AddGroup": { - "request": { - "operation": "AddUserToGroup", - "params": [ - { "target": "UserName", "source": "identifier", "name": "Name" } - ] - } - }, - "AttachPolicy": { - "request": { - "operation": "AttachUserPolicy", - "params": [ - { "target": "UserName", "source": "identifier", "name": "Name" } - ] - } - }, - "Create": { - "request": { - "operation": "CreateUser", - "params": [ - { "target": "UserName", "source": "identifier", "name": "Name" } - ] - }, - "resource": { - "type": "User", - "identifiers": [ - { "target": "Name", "source": "requestParameter", "path": "UserName" } - ], - "path": "User" - } - }, - "CreateAccessKeyPair": { - "request": { - "operation": "CreateAccessKey", - "params": [ - { "target": "UserName", "source": "identifier", "name": "Name" } - ] - }, - "resource": { - "type": "AccessKeyPair", - "identifiers": [ - { "target": "UserName", "source": "identifier", "name": "Name" }, - { "target": "Id", "source": "response", "path": "AccessKey.AccessKeyId" }, - { "target": "Secret", "source": "response", "path": "AccessKey.SecretAccessKey" } - ], - "path": "AccessKey" - } - }, - "CreateLoginProfile": { - "request": { - "operation": "CreateLoginProfile", - "params": [ - { "target": "UserName", "source": "identifier", "name": "Name" } - ] - }, - "resource": { - "type": "LoginProfile", - "identifiers": [ - { "target": "UserName", "source": "response", "path": "LoginProfile.UserName" } - ], - "path": "LoginProfile" - } - }, - "CreatePolicy": { - "request": { - "operation": "PutUserPolicy", - "params": [ - { "target": "UserName", "source": "identifier", "name": "Name" } - ] - }, - "resource": { - "type": "UserPolicy", - "identifiers": [ - { "target": "UserName", "source": "identifier", "name": "Name" }, - { "target": "Name", "source": "requestParameter", "path": "PolicyName" } - ] - } - }, - "Delete": { - "request": { - "operation": "DeleteUser", - "params": [ - { "target": "UserName", "source": "identifier", "name": "Name" } - ] - } - }, - "DetachPolicy": { - "request": { - "operation": "DetachUserPolicy", - "params": [ - { "target": "UserName", "source": "identifier", "name": "Name" } - ] - } - }, - "EnableMfa": { - "request": { - "operation": "EnableMFADevice", - "params": [ - { "target": "UserName", "source": "identifier", "name": "Name" } - ] - }, - "resource": { - "type": "MfaDevice", - "identifiers": [ - { "target": "UserName", "source": "identifier", "name": "Name" }, - { "target": "SerialNumber", "source": "requestParameter", "path": "SerialNumber" } - ] - } - }, - "RemoveGroup": { - "request": { - "operation": "RemoveUserFromGroup", - "params": [ - { "target": "UserName", "source": "identifier", "name": "Name" } - ] - } - }, - "Update": { - "request": { - "operation": "UpdateUser", - "params": [ - { "target": "UserName", "source": "identifier", "name": "Name" } - ] - }, - "resource": { - "type": "User", - "identifiers": [ - { "target": "Name", "source": "requestParameter", "path": "NewUserName" } - ] - } - } - }, - "waiters": { - "Exists": { - "waiterName": "UserExists", - "params": [ - { "target": "UserName", "source": "identifier", "name": "Name" } - ] - } - }, - "has": { - "AccessKey": { - "resource": { - "type": "AccessKey", - "identifiers": [ - { "target": "UserName", "source": "identifier", "name": "Name" }, - { "target": "Id", "source": "input" } - ] - } - }, - "LoginProfile": { - "resource": { - "type": "LoginProfile", - "identifiers": [ - { "target": "UserName", "source": "identifier", "name": "Name" } - ] - } - }, - "MfaDevice": { - "resource": { - "type": "MfaDevice", - "identifiers": [ - { "target": "UserName", "source": "identifier", "name": "Name" }, - { "target": "SerialNumber", "source": "input" } - ] - } - }, - "Policy": { - "resource": { - "type": "UserPolicy", - "identifiers": [ - { "target": "UserName", "source": "identifier", "name": "Name" }, - { "target": "Name", "source": "input" } - ] - } - }, - "SigningCertificate": { - "resource": { - "type": "SigningCertificate", - "identifiers": [ - { "target": "UserName", "source": "identifier", "name": "Name" }, - { "target": "Id", "source": "input" } - ] - } - } - }, - "hasMany": { - "AccessKeys": { - "request": { - "operation": "ListAccessKeys", - "params": [ - { "target": "UserName", "source": "identifier", "name": "Name" } - ] - }, - "resource": { - "type": "AccessKey", - "identifiers": [ - { "target": "UserName", "source": "identifier", "name": "Name" }, - { "target": "Id", "source": "response", "path": "AccessKeyMetadata[].AccessKeyId" } - ], - "path": "AccessKeyMetadata[]" - } - }, - "AttachedPolicies": { - "request": { - "operation": "ListAttachedUserPolicies", - "params": [ - { "target": "UserName", "source": "identifier", "name": "Name" } - ] - }, - "resource": { - "type": "Policy", - "identifiers": [ - { "target": "Arn", "source": "response", "path": "AttachedPolicies[].PolicyArn" } - ] - } - }, - "Groups": { - "request": { - "operation": "ListGroupsForUser", - "params": [ - { "target": "UserName", "source": "identifier", "name": "Name" } - ] - }, - "resource": { - "type": "Group", - "identifiers": [ - { "target": "Name", "source": "response", "path": "Groups[].GroupName" } - ], - "path": "Groups[]" - } - }, - "MfaDevices": { - "request": { - "operation": "ListMFADevices", - "params": [ - { "target": "UserName", "source": "identifier", "name": "Name" } - ] - }, - "resource": { - "type": "MfaDevice", - "identifiers": [ - { "target": "UserName", "source": "identifier", "name": "Name" }, - { "target": "SerialNumber", "source": "response", "path": "MFADevices[].SerialNumber" } - ], - "path": "MFADevices[]" - } - }, - "Policies": { - "request": { - "operation": "ListUserPolicies", - "params": [ - { "target": "UserName", "source": "identifier", "name": "Name" } - ] - }, - "resource": { - "type": "UserPolicy", - "identifiers": [ - { "target": "UserName", "source": "identifier", "name": "Name" }, - { "target": "Name", "source": "response", "path": "PolicyNames[]" } - ] - } - }, - "SigningCertificates": { - "request": { - "operation": "ListSigningCertificates", - "params": [ - { "target": "UserName", "source": "identifier", "name": "Name" } - ] - }, - "resource": { - "type": "SigningCertificate", - "identifiers": [ - { "target": "UserName", "source": "identifier", "name": "Name" }, - { "target": "Id", "source": "response", "path": "Certificates[].CertificateId" } - ], - "path": "Certificates[]" - } - } - } - }, - "UserPolicy": { - "identifiers": [ - { - "name": "UserName", - "memberName": "UserName" - }, - { - "name": "Name", - "memberName": "PolicyName" - } - ], - "shape": "GetUserPolicyResponse", - "load": { - "request": { - "operation": "GetUserPolicy", - "params": [ - { "target": "UserName", "source": "identifier", "name": "UserName" }, - { "target": "PolicyName", "source": "identifier", "name": "Name" } - ] - }, - "path": "@" - }, - "actions": { - "Delete": { - "request": { - "operation": "DeleteUserPolicy", - "params": [ - { "target": "UserName", "source": "identifier", "name": "UserName" }, - { "target": "PolicyName", "source": "identifier", "name": "Name" } - ] - } - }, - "Put": { - "request": { - "operation": "PutUserPolicy", - "params": [ - { "target": "UserName", "source": "identifier", "name": "UserName" }, - { "target": "PolicyName", "source": "identifier", "name": "Name" } - ] - } - } - }, - "has": { - "User": { - "resource": { - "type": "User", - "identifiers": [ - { "target": "Name", "source": "identifier", "name": "UserName" } - ] - } - } - } - }, - "VirtualMfaDevice": { - "identifiers": [ - { - "name": "SerialNumber", - "memberName": "SerialNumber" - } - ], - "shape": "VirtualMFADevice", - "actions": { - "Delete": { - "request": { - "operation": "DeleteVirtualMFADevice", - "params": [ - { "target": "SerialNumber", "source": "identifier", "name": "SerialNumber" } - ] - } - } - }, - "has": { - "User": { - "resource": { - "type": "User", - "identifiers": [ - { "target": "Name", "source": "data", "path": "User.UserName" } - ] - } - } - } - } - } -} diff --git a/tools/code-generation/api-descriptions/iam/2010-05-08/service-2.json b/tools/code-generation/api-descriptions/iam/2010-05-08/service-2.json deleted file mode 100644 index 56ff082382fa..000000000000 --- a/tools/code-generation/api-descriptions/iam/2010-05-08/service-2.json +++ /dev/null @@ -1,10366 +0,0 @@ -{ - "version":"2.0", - "metadata":{ - "apiVersion":"2010-05-08", - "endpointPrefix":"iam", - "globalEndpoint":"iam.amazonaws.com", - "protocol":"query", - "protocols":["query"], - "serviceAbbreviation":"IAM", - "serviceFullName":"AWS Identity and Access Management", - "serviceId":"IAM", - "signatureVersion":"v4", - "uid":"iam-2010-05-08", - "xmlNamespace":"https://iam.amazonaws.com/doc/2010-05-08/", - "auth":["aws.auth#sigv4"] - }, - "operations":{ - "AcceptDelegationRequest":{ - "name":"AcceptDelegationRequest", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AcceptDelegationRequestRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"}, - {"shape":"ConcurrentModificationException"} - ], - "documentation":"

Accepts a delegation request, granting the requested temporary access.

Once the delegation request is accepted, it is eligible to send the exchange token to the partner. The SendDelegationToken API has to be explicitly called to send the delegation token.

At the time of acceptance, IAM records the details and the state of the identity that called this API. This is the identity that gets mapped to the delegated credential.

An accepted request may be rejected before the exchange token is sent to the partner.

" - }, - "AddClientIDToOpenIDConnectProvider":{ - "name":"AddClientIDToOpenIDConnectProvider", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AddClientIDToOpenIDConnectProviderRequest"}, - "errors":[ - {"shape":"ConcurrentModificationException"}, - {"shape":"InvalidInputException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Adds a new client ID (also known as audience) to the list of client IDs already registered for the specified IAM OpenID Connect (OIDC) provider resource.

This operation is idempotent; it does not fail or return an error if you add an existing client ID to the provider.

" - }, - "AddRoleToInstanceProfile":{ - "name":"AddRoleToInstanceProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AddRoleToInstanceProfileRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"EntityAlreadyExistsException"}, - {"shape":"LimitExceededException"}, - {"shape":"UnmodifiableEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Adds the specified IAM role to the specified instance profile. An instance profile can contain only one role, and this quota cannot be increased. You can remove the existing role and then add a different role to an instance profile. You must then wait for the change to appear across all of Amazon Web Services because of eventual consistency. To force the change, you must disassociate the instance profile and then associate the instance profile, or you can stop your instance and then restart it.

The caller of this operation must be granted the PassRole permission on the IAM role by a permissions policy.

When using the iam:AssociatedResourceArn condition in a policy to restrict the PassRole IAM action, special considerations apply if the policy is intended to define access for the AddRoleToInstanceProfile action. In this case, you cannot specify a Region or instance ID in the EC2 instance ARN. The ARN value must be arn:aws:ec2:*:CallerAccountId:instance/*. Using any other ARN value may lead to unexpected evaluation results.

For more information about roles, see IAM roles in the IAM User Guide. For more information about instance profiles, see Using instance profiles in the IAM User Guide.

" - }, - "AddUserToGroup":{ - "name":"AddUserToGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AddUserToGroupRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Adds the specified user to the specified group.

" - }, - "AssociateDelegationRequest":{ - "name":"AssociateDelegationRequest", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AssociateDelegationRequestRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"InvalidInputException"} - ], - "documentation":"

Associates a delegation request with the current identity.

If the partner that created the delegation request has specified the owner account during creation, only an identity from that owner account can call the AssociateDelegationRequest API for the specified delegation request. Once the AssociateDelegationRequest API call is successful, the ARN of the current calling identity will be stored as the ownerId of the request.

If the partner that created the delegation request has not specified the owner account during creation, any caller from any account can call the AssociateDelegationRequest API for the delegation request. Once this API call is successful, the ARN of the current calling identity will be stored as the ownerId and the Amazon Web Services account ID of the current calling identity will be stored as the ownerAccount of the request.

For more details, see Managing Permissions for Delegation Requests.

" - }, - "AttachGroupPolicy":{ - "name":"AttachGroupPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AttachGroupPolicyRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"InvalidInputException"}, - {"shape":"PolicyNotAttachableException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Attaches the specified managed policy to the specified IAM group.

You use this operation to attach a managed policy to a group. To embed an inline policy in a group, use PutGroupPolicy .

As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide.

For more information about policies, see Managed policies and inline policies in the IAM User Guide.

" - }, - "AttachRolePolicy":{ - "name":"AttachRolePolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AttachRolePolicyRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"InvalidInputException"}, - {"shape":"UnmodifiableEntityException"}, - {"shape":"PolicyNotAttachableException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Attaches the specified managed policy to the specified IAM role. When you attach a managed policy to a role, the managed policy becomes part of the role's permission (access) policy.

You cannot use a managed policy as the role's trust policy. The role's trust policy is created at the same time as the role, using CreateRole . You can update a role's trust policy using UpdateAssumerolePolicy .

Use this operation to attach a managed policy to a role. To embed an inline policy in a role, use PutRolePolicy . For more information about policies, see Managed policies and inline policies in the IAM User Guide.

As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide.

" - }, - "AttachUserPolicy":{ - "name":"AttachUserPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AttachUserPolicyRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"InvalidInputException"}, - {"shape":"PolicyNotAttachableException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Attaches the specified managed policy to the specified user.

You use this operation to attach a managed policy to a user. To embed an inline policy in a user, use PutUserPolicy .

As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide.

For more information about policies, see Managed policies and inline policies in the IAM User Guide.

" - }, - "ChangePassword":{ - "name":"ChangePassword", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ChangePasswordRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidUserTypeException"}, - {"shape":"LimitExceededException"}, - {"shape":"EntityTemporarilyUnmodifiableException"}, - {"shape":"PasswordPolicyViolationException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Changes the password of the IAM user who is calling this operation. This operation can be performed using the CLI, the Amazon Web Services API, or the My Security Credentials page in the Amazon Web Services Management Console. The Amazon Web Services account root user password is not affected by this operation.

Use UpdateLoginProfile to use the CLI, the Amazon Web Services API, or the Users page in the IAM console to change the password for any IAM user. For more information about modifying passwords, see Managing passwords in the IAM User Guide.

" - }, - "CreateAccessKey":{ - "name":"CreateAccessKey", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateAccessKeyRequest"}, - "output":{ - "shape":"CreateAccessKeyResponse", - "resultWrapper":"CreateAccessKeyResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Creates a new Amazon Web Services secret access key and corresponding Amazon Web Services access key ID for the specified user. The default status for new keys is Active.

If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials. This is true even if the Amazon Web Services account has no associated users.

For information about quotas on the number of keys you can create, see IAM and STS quotas in the IAM User Guide.

To ensure the security of your Amazon Web Services account, the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can delete the access keys for the associated user and then create new keys.

" - }, - "CreateAccountAlias":{ - "name":"CreateAccountAlias", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateAccountAliasRequest"}, - "errors":[ - {"shape":"ConcurrentModificationException"}, - {"shape":"EntityAlreadyExistsException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Creates an alias for your Amazon Web Services account. For information about using an Amazon Web Services account alias, see Creating, deleting, and listing an Amazon Web Services account alias in the Amazon Web Services Sign-In User Guide.

" - }, - "CreateDelegationRequest":{ - "name":"CreateDelegationRequest", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateDelegationRequestRequest"}, - "output":{ - "shape":"CreateDelegationRequestResponse", - "resultWrapper":"CreateDelegationRequestResult" - }, - "errors":[ - {"shape":"EntityAlreadyExistsException"}, - {"shape":"ServiceFailureException"}, - {"shape":"InvalidInputException"}, - {"shape":"LimitExceededException"}, - {"shape":"ConcurrentModificationException"} - ], - "documentation":"

Creates an IAM delegation request for temporary access delegation.

This API is not available for general use. In order to use this API, a caller first need to go through an onboarding process described in the partner onboarding documentation.

" - }, - "CreateGroup":{ - "name":"CreateGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateGroupRequest"}, - "output":{ - "shape":"CreateGroupResponse", - "resultWrapper":"CreateGroupResult" - }, - "errors":[ - {"shape":"LimitExceededException"}, - {"shape":"EntityAlreadyExistsException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Creates a new group.

For information about the number of groups you can create, see IAM and STS quotas in the IAM User Guide.

" - }, - "CreateInstanceProfile":{ - "name":"CreateInstanceProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateInstanceProfileRequest"}, - "output":{ - "shape":"CreateInstanceProfileResponse", - "resultWrapper":"CreateInstanceProfileResult" - }, - "errors":[ - {"shape":"EntityAlreadyExistsException"}, - {"shape":"InvalidInputException"}, - {"shape":"LimitExceededException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Creates a new instance profile. For information about instance profiles, see Using roles for applications on Amazon EC2 in the IAM User Guide, and Instance profiles in the Amazon EC2 User Guide.

For information about the number of instance profiles you can create, see IAM object quotas in the IAM User Guide.

" - }, - "CreateLoginProfile":{ - "name":"CreateLoginProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateLoginProfileRequest"}, - "output":{ - "shape":"CreateLoginProfileResponse", - "resultWrapper":"CreateLoginProfileResult" - }, - "errors":[ - {"shape":"EntityAlreadyExistsException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"PasswordPolicyViolationException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Creates a password for the specified IAM user. A password allows an IAM user to access Amazon Web Services services through the Amazon Web Services Management Console.

You can use the CLI, the Amazon Web Services API, or the Users page in the IAM console to create a password for any IAM user. Use ChangePassword to update your own existing password in the My Security Credentials page in the Amazon Web Services Management Console.

For more information about managing passwords, see Managing passwords in the IAM User Guide.

" - }, - "CreateOpenIDConnectProvider":{ - "name":"CreateOpenIDConnectProvider", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateOpenIDConnectProviderRequest"}, - "output":{ - "shape":"CreateOpenIDConnectProviderResponse", - "resultWrapper":"CreateOpenIDConnectProviderResult" - }, - "errors":[ - {"shape":"InvalidInputException"}, - {"shape":"EntityAlreadyExistsException"}, - {"shape":"LimitExceededException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"}, - {"shape":"OpenIdIdpCommunicationErrorException"} - ], - "documentation":"

Creates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC).

The OIDC provider that you create with this operation can be used as a principal in a role's trust policy. Such a policy establishes a trust relationship between Amazon Web Services and the OIDC provider.

If you are using an OIDC identity provider from Google, Facebook, or Amazon Cognito, you don't need to create a separate IAM identity provider. These OIDC identity providers are already built-in to Amazon Web Services and are available for your use. Instead, you can move directly to creating new roles using your identity provider. To learn more, see Creating a role for web identity or OpenID connect federation in the IAM User Guide.

When you create the IAM OIDC provider, you specify the following:

  • The URL of the OIDC identity provider (IdP) to trust

  • A list of client IDs (also known as audiences) that identify the application or applications allowed to authenticate using the OIDC provider

  • A list of tags that are attached to the specified IAM OIDC provider

  • A list of thumbprints of one or more server certificates that the IdP uses

You get all of this information from the OIDC IdP you want to use to access Amazon Web Services.

Amazon Web Services secures communication with OIDC identity providers (IdPs) using our library of trusted root certificate authorities (CAs) to verify the JSON Web Key Set (JWKS) endpoint's TLS certificate. If your OIDC IdP relies on a certificate that is not signed by one of these trusted CAs, only then we secure communication using the thumbprints set in the IdP's configuration.

The trust for the OIDC provider is derived from the IAM provider that this operation creates. Therefore, it is best to limit access to the CreateOpenIDConnectProvider operation to highly privileged users.

" - }, - "CreatePolicy":{ - "name":"CreatePolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreatePolicyRequest"}, - "output":{ - "shape":"CreatePolicyResponse", - "resultWrapper":"CreatePolicyResult" - }, - "errors":[ - {"shape":"InvalidInputException"}, - {"shape":"LimitExceededException"}, - {"shape":"EntityAlreadyExistsException"}, - {"shape":"MalformedPolicyDocumentException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Creates a new managed policy for your Amazon Web Services account.

This operation creates a policy version with a version identifier of v1 and sets v1 as the policy's default version. For more information about policy versions, see Versioning for managed policies in the IAM User Guide.

As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide.

For more information about managed policies in general, see Managed policies and inline policies in the IAM User Guide.

" - }, - "CreatePolicyVersion":{ - "name":"CreatePolicyVersion", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreatePolicyVersionRequest"}, - "output":{ - "shape":"CreatePolicyVersionResponse", - "resultWrapper":"CreatePolicyVersionResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"MalformedPolicyDocumentException"}, - {"shape":"InvalidInputException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Creates a new version of the specified managed policy. To update a managed policy, you create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must delete an existing version using DeletePolicyVersion before you create a new version.

Optionally, you can set the new version as the policy's default version. The default version is the version that is in effect for the IAM users, groups, and roles to which the policy is attached.

For more information about managed policy versions, see Versioning for managed policies in the IAM User Guide.

" - }, - "CreateRole":{ - "name":"CreateRole", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateRoleRequest"}, - "output":{ - "shape":"CreateRoleResponse", - "resultWrapper":"CreateRoleResult" - }, - "errors":[ - {"shape":"LimitExceededException"}, - {"shape":"InvalidInputException"}, - {"shape":"EntityAlreadyExistsException"}, - {"shape":"MalformedPolicyDocumentException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Creates a new role for your Amazon Web Services account.

For more information about roles, see IAM roles in the IAM User Guide. For information about quotas for role names and the number of roles you can create, see IAM and STS quotas in the IAM User Guide.

" - }, - "CreateSAMLProvider":{ - "name":"CreateSAMLProvider", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateSAMLProviderRequest"}, - "output":{ - "shape":"CreateSAMLProviderResponse", - "resultWrapper":"CreateSAMLProviderResult" - }, - "errors":[ - {"shape":"InvalidInputException"}, - {"shape":"EntityAlreadyExistsException"}, - {"shape":"LimitExceededException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Creates an IAM resource that describes an identity provider (IdP) that supports SAML 2.0.

The SAML provider resource that you create with this operation can be used as a principal in an IAM role's trust policy. Such a policy can enable federated users who sign in using the SAML IdP to assume the role. You can create an IAM role that supports Web-based single sign-on (SSO) to the Amazon Web Services Management Console or one that supports API access to Amazon Web Services.

When you create the SAML provider resource, you upload a SAML metadata document that you get from your IdP. That document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that the IdP sends. You must generate the metadata document using the identity management software that is used as your organization's IdP.

This operation requires Signature Version 4.

For more information, see Enabling SAML 2.0 federated users to access the Amazon Web Services Management Console and About SAML 2.0-based federation in the IAM User Guide.

" - }, - "CreateServiceLinkedRole":{ - "name":"CreateServiceLinkedRole", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateServiceLinkedRoleRequest"}, - "output":{ - "shape":"CreateServiceLinkedRoleResponse", - "resultWrapper":"CreateServiceLinkedRoleResult" - }, - "errors":[ - {"shape":"InvalidInputException"}, - {"shape":"LimitExceededException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Creates an IAM role that is linked to a specific Amazon Web Services service. The service controls the attached policies and when the role can be deleted. This helps ensure that the service is not broken by an unexpectedly changed or deleted role, which could put your Amazon Web Services resources into an unknown state. Allowing the service to control the role helps improve service stability and proper cleanup when a service and its role are no longer needed. For more information, see Using service-linked roles in the IAM User Guide.

To attach a policy to this service-linked role, you must make the request using the Amazon Web Services service that depends on this role.

" - }, - "CreateServiceSpecificCredential":{ - "name":"CreateServiceSpecificCredential", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateServiceSpecificCredentialRequest"}, - "output":{ - "shape":"CreateServiceSpecificCredentialResponse", - "resultWrapper":"CreateServiceSpecificCredentialResult" - }, - "errors":[ - {"shape":"LimitExceededException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceNotSupportedException"} - ], - "documentation":"

Generates a set of credentials consisting of a user name and password that can be used to access the service specified in the request. These credentials are generated by IAM, and can be used only for the specified service.

You can have a maximum of two sets of service-specific credentials for each supported service per user.

You can reset the password to a new service-generated value by calling ResetServiceSpecificCredential.

For more information about using service-specific credentials to authenticate to an Amazon Web Services service, refer to the following docs:

" - }, - "CreateUser":{ - "name":"CreateUser", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateUserRequest"}, - "output":{ - "shape":"CreateUserResponse", - "resultWrapper":"CreateUserResult" - }, - "errors":[ - {"shape":"LimitExceededException"}, - {"shape":"EntityAlreadyExistsException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Creates a new IAM user for your Amazon Web Services account.

For information about quotas for the number of IAM users you can create, see IAM and STS quotas in the IAM User Guide.

" - }, - "CreateVirtualMFADevice":{ - "name":"CreateVirtualMFADevice", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateVirtualMFADeviceRequest"}, - "output":{ - "shape":"CreateVirtualMFADeviceResponse", - "resultWrapper":"CreateVirtualMFADeviceResult" - }, - "errors":[ - {"shape":"LimitExceededException"}, - {"shape":"InvalidInputException"}, - {"shape":"EntityAlreadyExistsException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Creates a new virtual MFA device for the Amazon Web Services account. After creating the virtual MFA, use EnableMFADevice to attach the MFA device to an IAM user. For more information about creating and working with virtual MFA devices, see Using a virtual MFA device in the IAM User Guide.

For information about the maximum number of MFA devices you can create, see IAM and STS quotas in the IAM User Guide.

The seed information contained in the QR code and the Base32 string should be treated like any other secret access information. In other words, protect the seed information as you would your Amazon Web Services access keys or your passwords. After you provision your virtual device, you should ensure that the information is destroyed following secure procedures.

" - }, - "DeactivateMFADevice":{ - "name":"DeactivateMFADevice", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeactivateMFADeviceRequest"}, - "errors":[ - {"shape":"EntityTemporarilyUnmodifiableException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"}, - {"shape":"ConcurrentModificationException"} - ], - "documentation":"

Deactivates the specified MFA device and removes it from association with the user name for which it was originally enabled.

For more information about creating and working with virtual MFA devices, see Enabling a virtual multi-factor authentication (MFA) device in the IAM User Guide.

" - }, - "DeleteAccessKey":{ - "name":"DeleteAccessKey", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteAccessKeyRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Deletes the access key pair associated with the specified IAM user.

If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.

" - }, - "DeleteAccountAlias":{ - "name":"DeleteAccountAlias", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteAccountAliasRequest"}, - "errors":[ - {"shape":"ConcurrentModificationException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Deletes the specified Amazon Web Services account alias. For information about using an Amazon Web Services account alias, see Creating, deleting, and listing an Amazon Web Services account alias in the Amazon Web Services Sign-In User Guide.

" - }, - "DeleteAccountPasswordPolicy":{ - "name":"DeleteAccountPasswordPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Deletes the password policy for the Amazon Web Services account. There are no parameters.

" - }, - "DeleteGroup":{ - "name":"DeleteGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteGroupRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"DeleteConflictException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Deletes the specified IAM group. The group must not contain any users or have any attached policies.

" - }, - "DeleteGroupPolicy":{ - "name":"DeleteGroupPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteGroupPolicyRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Deletes the specified inline policy that is embedded in the specified IAM group.

A group can also have managed policies attached to it. To detach a managed policy from a group, use DetachGroupPolicy. For more information about policies, refer to Managed policies and inline policies in the IAM User Guide.

" - }, - "DeleteInstanceProfile":{ - "name":"DeleteInstanceProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteInstanceProfileRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"DeleteConflictException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Deletes the specified instance profile. The instance profile must not have an associated role.

Make sure that you do not have any Amazon EC2 instances running with the instance profile you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance.

For more information about instance profiles, see Using instance profiles in the IAM User Guide.

" - }, - "DeleteLoginProfile":{ - "name":"DeleteLoginProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteLoginProfileRequest"}, - "errors":[ - {"shape":"EntityTemporarilyUnmodifiableException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Deletes the password for the specified IAM user or root user, For more information, see Managing passwords for IAM users.

You can use the CLI, the Amazon Web Services API, or the Users page in the IAM console to delete a password for any IAM user. You can use ChangePassword to update, but not delete, your own password in the My Security Credentials page in the Amazon Web Services Management Console.

Deleting a user's password does not prevent a user from accessing Amazon Web Services through the command line interface or the API. To prevent all user access, you must also either make any access keys inactive or delete them. For more information about making keys inactive or deleting them, see UpdateAccessKey and DeleteAccessKey.

" - }, - "DeleteOpenIDConnectProvider":{ - "name":"DeleteOpenIDConnectProvider", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteOpenIDConnectProviderRequest"}, - "errors":[ - {"shape":"InvalidInputException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Deletes an OpenID Connect identity provider (IdP) resource object in IAM.

Deleting an IAM OIDC provider resource does not update any roles that reference the provider as a principal in their trust policies. Any attempt to assume a role that references a deleted provider fails.

This operation is idempotent; it does not fail or return an error if you call the operation for a provider that does not exist.

" - }, - "DeletePolicy":{ - "name":"DeletePolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeletePolicyRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"InvalidInputException"}, - {"shape":"DeleteConflictException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Deletes the specified managed policy.

Before you can delete a managed policy, you must first detach the policy from all users, groups, and roles that it is attached to. In addition, you must delete all the policy's versions. The following steps describe the process for deleting a managed policy:

  • Detach the policy from all users, groups, and roles that the policy is attached to, using DetachUserPolicy, DetachGroupPolicy, or DetachRolePolicy. To list all the users, groups, and roles that a policy is attached to, use ListEntitiesForPolicy.

  • Delete all versions of the policy using DeletePolicyVersion. To list the policy's versions, use ListPolicyVersions. You cannot use DeletePolicyVersion to delete the version that is marked as the default version. You delete the policy's default version in the next step of the process.

  • Delete the policy (this automatically deletes the policy's default version) using this operation.

For information about managed policies, see Managed policies and inline policies in the IAM User Guide.

" - }, - "DeletePolicyVersion":{ - "name":"DeletePolicyVersion", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeletePolicyVersionRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"InvalidInputException"}, - {"shape":"DeleteConflictException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Deletes the specified version from the specified managed policy.

You cannot delete the default version from a policy using this operation. To delete the default version from a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.

For information about versions for managed policies, see Versioning for managed policies in the IAM User Guide.

" - }, - "DeleteRole":{ - "name":"DeleteRole", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteRoleRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"DeleteConflictException"}, - {"shape":"LimitExceededException"}, - {"shape":"UnmodifiableEntityException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Deletes the specified role. Unlike the Amazon Web Services Management Console, when you delete a role programmatically, you must delete the items attached to the role manually, or the deletion fails. For more information, see Deleting an IAM role. Before attempting to delete a role, remove the following attached items:

Make sure that you do not have any Amazon EC2 instances running with the role you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance.

" - }, - "DeleteRolePermissionsBoundary":{ - "name":"DeleteRolePermissionsBoundary", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteRolePermissionsBoundaryRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"UnmodifiableEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Deletes the permissions boundary for the specified IAM role.

You cannot set the boundary for a service-linked role.

Deleting the permissions boundary for a role might increase its permissions. For example, it might allow anyone who assumes the role to perform all the actions granted in its permissions policies.

" - }, - "DeleteRolePolicy":{ - "name":"DeleteRolePolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteRolePolicyRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"UnmodifiableEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Deletes the specified inline policy that is embedded in the specified IAM role.

A role can also have managed policies attached to it. To detach a managed policy from a role, use DetachRolePolicy. For more information about policies, refer to Managed policies and inline policies in the IAM User Guide.

" - }, - "DeleteSAMLProvider":{ - "name":"DeleteSAMLProvider", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteSAMLProviderRequest"}, - "errors":[ - {"shape":"InvalidInputException"}, - {"shape":"LimitExceededException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Deletes a SAML provider resource in IAM.

Deleting the provider resource from IAM does not update any roles that reference the SAML provider resource's ARN as a principal in their trust policies. Any attempt to assume a role that references a non-existent provider resource ARN fails.

This operation requires Signature Version 4.

" - }, - "DeleteSSHPublicKey":{ - "name":"DeleteSSHPublicKey", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteSSHPublicKeyRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"} - ], - "documentation":"

Deletes the specified SSH public key.

The SSH public key deleted by this operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide.

" - }, - "DeleteServerCertificate":{ - "name":"DeleteServerCertificate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteServerCertificateRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"DeleteConflictException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Deletes the specified server certificate.

For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.

If you are using a server certificate with Elastic Load Balancing, deleting the certificate could have implications for your application. If Elastic Load Balancing doesn't detect the deletion of bound certificates, it may continue to use the certificates. This could cause Elastic Load Balancing to stop accepting traffic. We recommend that you remove the reference to the certificate from Elastic Load Balancing before using this command to delete the certificate. For more information, see DeleteLoadBalancerListeners in the Elastic Load Balancing API Reference.

" - }, - "DeleteServiceLinkedRole":{ - "name":"DeleteServiceLinkedRole", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteServiceLinkedRoleRequest"}, - "output":{ - "shape":"DeleteServiceLinkedRoleResponse", - "resultWrapper":"DeleteServiceLinkedRoleResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Submits a service-linked role deletion request and returns a DeletionTaskId, which you can use to check the status of the deletion. Before you call this operation, confirm that the role has no active sessions and that any resources used by the role in the linked service are deleted. If you call this operation more than once for the same service-linked role and an earlier deletion task is not complete, then the DeletionTaskId of the earlier request is returned.

If you submit a deletion request for a service-linked role whose linked service is still accessing a resource, then the deletion task fails. If it fails, the GetServiceLinkedRoleDeletionStatus operation returns the reason for the failure, usually including the resources that must be deleted. To delete the service-linked role, you must first remove those resources from the linked service and then submit the deletion request again. Resources are specific to the service that is linked to the role. For more information about removing resources from a service, see the Amazon Web Services documentation for your service.

For more information about service-linked roles, see Roles terms and concepts: Amazon Web Services service-linked role in the IAM User Guide.

" - }, - "DeleteServiceSpecificCredential":{ - "name":"DeleteServiceSpecificCredential", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteServiceSpecificCredentialRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"} - ], - "documentation":"

Deletes the specified service-specific credential.

" - }, - "DeleteSigningCertificate":{ - "name":"DeleteSigningCertificate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteSigningCertificateRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Deletes a signing certificate associated with the specified IAM user.

If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated IAM users.

" - }, - "DeleteUser":{ - "name":"DeleteUser", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteUserRequest"}, - "errors":[ - {"shape":"LimitExceededException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"DeleteConflictException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Deletes the specified IAM user. Unlike the Amazon Web Services Management Console, when you delete a user programmatically, you must delete the items attached to the user manually, or the deletion fails. For more information, see Deleting an IAM user. Before attempting to delete a user, remove the following items:

" - }, - "DeleteUserPermissionsBoundary":{ - "name":"DeleteUserPermissionsBoundary", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteUserPermissionsBoundaryRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Deletes the permissions boundary for the specified IAM user.

Deleting the permissions boundary for a user might increase its permissions by allowing the user to perform all the actions granted in its permissions policies.

" - }, - "DeleteUserPolicy":{ - "name":"DeleteUserPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteUserPolicyRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Deletes the specified inline policy that is embedded in the specified IAM user.

A user can also have managed policies attached to it. To detach a managed policy from a user, use DetachUserPolicy. For more information about policies, refer to Managed policies and inline policies in the IAM User Guide.

" - }, - "DeleteVirtualMFADevice":{ - "name":"DeleteVirtualMFADevice", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteVirtualMFADeviceRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"DeleteConflictException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"}, - {"shape":"ConcurrentModificationException"} - ], - "documentation":"

Deletes a virtual MFA device.

You must deactivate a user's virtual MFA device before you can delete it. For information about deactivating MFA devices, see DeactivateMFADevice.

" - }, - "DetachGroupPolicy":{ - "name":"DetachGroupPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DetachGroupPolicyRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"InvalidInputException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Removes the specified managed policy from the specified IAM group.

A group can also have inline policies embedded with it. To delete an inline policy, use DeleteGroupPolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide.

" - }, - "DetachRolePolicy":{ - "name":"DetachRolePolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DetachRolePolicyRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"InvalidInputException"}, - {"shape":"UnmodifiableEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Removes the specified managed policy from the specified role.

A role can also have inline policies embedded with it. To delete an inline policy, use DeleteRolePolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide.

" - }, - "DetachUserPolicy":{ - "name":"DetachUserPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DetachUserPolicyRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"InvalidInputException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Removes the specified managed policy from the specified user.

A user can also have inline policies embedded with it. To delete an inline policy, use DeleteUserPolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide.

" - }, - "DisableOrganizationsRootCredentialsManagement":{ - "name":"DisableOrganizationsRootCredentialsManagement", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DisableOrganizationsRootCredentialsManagementRequest"}, - "output":{ - "shape":"DisableOrganizationsRootCredentialsManagementResponse", - "resultWrapper":"DisableOrganizationsRootCredentialsManagementResult" - }, - "errors":[ - {"shape":"ServiceAccessNotEnabledException"}, - {"shape":"AccountNotManagementOrDelegatedAdministratorException"}, - {"shape":"OrganizationNotFoundException"}, - {"shape":"OrganizationNotInAllFeaturesModeException"} - ], - "documentation":"

Disables the management of privileged root user credentials across member accounts in your organization. When you disable this feature, the management account and the delegated administrator for IAM can no longer manage root user credentials for member accounts in your organization.

" - }, - "DisableOrganizationsRootSessions":{ - "name":"DisableOrganizationsRootSessions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DisableOrganizationsRootSessionsRequest"}, - "output":{ - "shape":"DisableOrganizationsRootSessionsResponse", - "resultWrapper":"DisableOrganizationsRootSessionsResult" - }, - "errors":[ - {"shape":"ServiceAccessNotEnabledException"}, - {"shape":"AccountNotManagementOrDelegatedAdministratorException"}, - {"shape":"OrganizationNotFoundException"}, - {"shape":"OrganizationNotInAllFeaturesModeException"} - ], - "documentation":"

Disables root user sessions for privileged tasks across member accounts in your organization. When you disable this feature, the management account and the delegated administrator for IAM can no longer perform privileged tasks on member accounts in your organization.

" - }, - "DisableOutboundWebIdentityFederation":{ - "name":"DisableOutboundWebIdentityFederation", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "errors":[ - {"shape":"FeatureDisabledException"} - ], - "documentation":"

Disables the outbound identity federation feature for your Amazon Web Services account. When disabled, IAM principals in the account cannot use the GetWebIdentityToken API to obtain JSON Web Tokens (JWTs) for authentication with external services. This operation does not affect tokens that were issued before the feature was disabled.

" - }, - "EnableMFADevice":{ - "name":"EnableMFADevice", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"EnableMFADeviceRequest"}, - "errors":[ - {"shape":"EntityAlreadyExistsException"}, - {"shape":"EntityTemporarilyUnmodifiableException"}, - {"shape":"InvalidAuthenticationCodeException"}, - {"shape":"LimitExceededException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"}, - {"shape":"ConcurrentModificationException"} - ], - "documentation":"

Enables the specified MFA device and associates it with the specified IAM user. When enabled, the MFA device is required for every subsequent login by the IAM user associated with the device.

" - }, - "EnableOrganizationsRootCredentialsManagement":{ - "name":"EnableOrganizationsRootCredentialsManagement", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"EnableOrganizationsRootCredentialsManagementRequest"}, - "output":{ - "shape":"EnableOrganizationsRootCredentialsManagementResponse", - "resultWrapper":"EnableOrganizationsRootCredentialsManagementResult" - }, - "errors":[ - {"shape":"ServiceAccessNotEnabledException"}, - {"shape":"AccountNotManagementOrDelegatedAdministratorException"}, - {"shape":"OrganizationNotFoundException"}, - {"shape":"OrganizationNotInAllFeaturesModeException"}, - {"shape":"CallerIsNotManagementAccountException"} - ], - "documentation":"

Enables the management of privileged root user credentials across member accounts in your organization. When you enable root credentials management for centralized root access, the management account and the delegated administrator for IAM can manage root user credentials for member accounts in your organization.

Before you enable centralized root access, you must have an account configured with the following settings:

  • You must manage your Amazon Web Services accounts in Organizations.

  • Enable trusted access for Identity and Access Management in Organizations. For details, see IAM and Organizations in the Organizations User Guide.

" - }, - "EnableOrganizationsRootSessions":{ - "name":"EnableOrganizationsRootSessions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"EnableOrganizationsRootSessionsRequest"}, - "output":{ - "shape":"EnableOrganizationsRootSessionsResponse", - "resultWrapper":"EnableOrganizationsRootSessionsResult" - }, - "errors":[ - {"shape":"ServiceAccessNotEnabledException"}, - {"shape":"AccountNotManagementOrDelegatedAdministratorException"}, - {"shape":"OrganizationNotFoundException"}, - {"shape":"OrganizationNotInAllFeaturesModeException"}, - {"shape":"CallerIsNotManagementAccountException"} - ], - "documentation":"

Allows the management account or delegated administrator to perform privileged tasks on member accounts in your organization. For more information, see Centrally manage root access for member accounts in the Identity and Access Management User Guide.

Before you enable this feature, you must have an account configured with the following settings:

  • You must manage your Amazon Web Services accounts in Organizations.

  • Enable trusted access for Identity and Access Management in Organizations. For details, see IAM and Organizations in the Organizations User Guide.

" - }, - "EnableOutboundWebIdentityFederation":{ - "name":"EnableOutboundWebIdentityFederation", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "output":{ - "shape":"EnableOutboundWebIdentityFederationResponse", - "resultWrapper":"EnableOutboundWebIdentityFederationResult" - }, - "errors":[ - {"shape":"FeatureEnabledException"} - ], - "documentation":"

Enables the outbound identity federation feature for your Amazon Web Services account. When enabled, IAM principals in your account can use the GetWebIdentityToken API to obtain JSON Web Tokens (JWTs) for secure authentication with external services. This operation also generates a unique issuer URL for your Amazon Web Services account.

" - }, - "GenerateCredentialReport":{ - "name":"GenerateCredentialReport", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "output":{ - "shape":"GenerateCredentialReportResponse", - "resultWrapper":"GenerateCredentialReportResult" - }, - "errors":[ - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Generates a credential report for the Amazon Web Services account. For more information about the credential report, see Getting credential reports in the IAM User Guide.

" - }, - "GenerateOrganizationsAccessReport":{ - "name":"GenerateOrganizationsAccessReport", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GenerateOrganizationsAccessReportRequest"}, - "output":{ - "shape":"GenerateOrganizationsAccessReportResponse", - "resultWrapper":"GenerateOrganizationsAccessReportResult" - }, - "errors":[ - {"shape":"ReportGenerationLimitExceededException"} - ], - "documentation":"

Generates a report for service last accessed data for Organizations. You can generate a report for any entities (organization root, organizational unit, or account) or policies in your organization.

To call this operation, you must be signed in using your Organizations management account credentials. You can use your long-term IAM user or root user credentials, or temporary credentials from assuming an IAM role. SCPs must be enabled for your organization root. You must have the required IAM and Organizations permissions. For more information, see Refining permissions using service last accessed data in the IAM User Guide.

You can generate a service last accessed data report for entities by specifying only the entity's path. This data includes a list of services that are allowed by any service control policies (SCPs) that apply to the entity.

You can generate a service last accessed data report for a policy by specifying an entity's path and an optional Organizations policy ID. This data includes a list of services that are allowed by the specified SCP.

For each service in both report types, the data includes the most recent account activity that the policy allows to account principals in the entity or the entity's children. For important information about the data, reporting period, permissions required, troubleshooting, and supported Regions see Reducing permissions using service last accessed data in the IAM User Guide.

The data includes all attempts to access Amazon Web Services, not just the successful ones. This includes all attempts that were made using the Amazon Web Services Management Console, the Amazon Web Services API through any of the SDKs, or any of the command line tools. An unexpected entry in the service last accessed data does not mean that an account has been compromised, because the request might have been denied. Refer to your CloudTrail logs as the authoritative source for information about all API calls and whether they were successful or denied access. For more information, see Logging IAM events with CloudTrail in the IAM User Guide.

This operation returns a JobId. Use this parameter in the GetOrganizationsAccessReport operation to check the status of the report generation. To check the status of this request, use the JobId parameter in the GetOrganizationsAccessReport operation and test the JobStatus response parameter. When the job is complete, you can retrieve the report.

To generate a service last accessed data report for entities, specify an entity path without specifying the optional Organizations policy ID. The type of entity that you specify determines the data returned in the report.

  • Root – When you specify the organizations root as the entity, the resulting report lists all of the services allowed by SCPs that are attached to your root. For each service, the report includes data for all accounts in your organization except the management account, because the management account is not limited by SCPs.

  • OU – When you specify an organizational unit (OU) as the entity, the resulting report lists all of the services allowed by SCPs that are attached to the OU and its parents. For each service, the report includes data for all accounts in the OU or its children. This data excludes the management account, because the management account is not limited by SCPs.

  • management account – When you specify the management account, the resulting report lists all Amazon Web Services services, because the management account is not limited by SCPs. For each service, the report includes data for only the management account.

  • Account – When you specify another account as the entity, the resulting report lists all of the services allowed by SCPs that are attached to the account and its parents. For each service, the report includes data for only the specified account.

To generate a service last accessed data report for policies, specify an entity path and the optional Organizations policy ID. The type of entity that you specify determines the data returned for each service.

  • Root – When you specify the root entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for all accounts in your organization to which the SCP applies. This data excludes the management account, because the management account is not limited by SCPs. If the SCP is not attached to any entities in the organization, then the report will return a list of services with no data.

  • OU – When you specify an OU entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for all accounts in the OU or its children to which the SCP applies. This means that other accounts outside the OU that are affected by the SCP might not be included in the data. This data excludes the management account, because the management account is not limited by SCPs. If the SCP is not attached to the OU or one of its children, the report will return a list of services with no data.

  • management account – When you specify the management account, the resulting report lists all Amazon Web Services services, because the management account is not limited by SCPs. If you specify a policy ID in the CLI or API, the policy is ignored. For each service, the report includes data for only the management account.

  • Account – When you specify another account entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for only the specified account. This means that other accounts in the organization that are affected by the SCP might not be included in the data. If the SCP is not attached to the account, the report will return a list of services with no data.

Service last accessed data does not use other policy types when determining whether a principal could access a service. These other policy types include identity-based policies, resource-based policies, access control lists, IAM permissions boundaries, and STS assume role policies. It only applies SCP logic. For more about the evaluation of policy types, see Evaluating policies in the IAM User Guide.

For more information about service last accessed data, see Reducing policy scope by viewing user activity in the IAM User Guide.

" - }, - "GenerateServiceLastAccessedDetails":{ - "name":"GenerateServiceLastAccessedDetails", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GenerateServiceLastAccessedDetailsRequest"}, - "output":{ - "shape":"GenerateServiceLastAccessedDetailsResponse", - "resultWrapper":"GenerateServiceLastAccessedDetailsResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"} - ], - "documentation":"

Generates a report that includes details about when an IAM resource (user, group, role, or policy) was last used in an attempt to access Amazon Web Services services. Recent activity usually appears within four hours. IAM reports activity for at least the last 400 days, or less if your Region began supporting this feature within the last year. For more information, see Regions where data is tracked. For more information about services and actions for which action last accessed information is displayed, see IAM action last accessed information services and actions.

The service last accessed data includes all attempts to access an Amazon Web Services API, not just the successful ones. This includes all attempts that were made using the Amazon Web Services Management Console, the Amazon Web Services API through any of the SDKs, or any of the command line tools. An unexpected entry in the service last accessed data does not mean that your account has been compromised, because the request might have been denied. Refer to your CloudTrail logs as the authoritative source for information about all API calls and whether they were successful or denied access. For more information, see Logging IAM events with CloudTrail in the IAM User Guide.

The GenerateServiceLastAccessedDetails operation returns a JobId. Use this parameter in the following operations to retrieve the following details from your report:

  • GetServiceLastAccessedDetails – Use this operation for users, groups, roles, or policies to list every Amazon Web Services service that the resource could access using permissions policies. For each service, the response includes information about the most recent access attempt.

    The JobId returned by GenerateServiceLastAccessedDetail must be used by the same role within a session, or by the same user when used to call GetServiceLastAccessedDetail.

  • GetServiceLastAccessedDetailsWithEntities – Use this operation for groups and policies to list information about the associated entities (users or roles) that attempted to access a specific Amazon Web Services service.

To check the status of the GenerateServiceLastAccessedDetails request, use the JobId parameter in the same operations and test the JobStatus response parameter.

For additional information about the permissions policies that allow an identity (user, group, or role) to access specific services, use the ListPoliciesGrantingServiceAccess operation.

Service last accessed data does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, Organizations policies, IAM permissions boundaries, and STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see Evaluating policies in the IAM User Guide.

For more information about service and action last accessed data, see Reducing permissions using service last accessed data in the IAM User Guide.

" - }, - "GetAccessKeyLastUsed":{ - "name":"GetAccessKeyLastUsed", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetAccessKeyLastUsedRequest"}, - "output":{ - "shape":"GetAccessKeyLastUsedResponse", - "resultWrapper":"GetAccessKeyLastUsedResult" - }, - "documentation":"

Retrieves information about when the specified access key was last used. The information includes the date and time of last use, along with the Amazon Web Services service and Region that were specified in the last request made with that key.

" - }, - "GetAccountAuthorizationDetails":{ - "name":"GetAccountAuthorizationDetails", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetAccountAuthorizationDetailsRequest"}, - "output":{ - "shape":"GetAccountAuthorizationDetailsResponse", - "resultWrapper":"GetAccountAuthorizationDetailsResult" - }, - "errors":[ - {"shape":"ServiceFailureException"} - ], - "documentation":"

Retrieves information about all IAM users, groups, roles, and policies in your Amazon Web Services account, including their relationships to one another. Use this operation to obtain a snapshot of the configuration of IAM permissions (users, groups, roles, and policies) in your account.

Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality, and some SDKs do this decoding automatically.

You can optionally filter the results using the Filter parameter. You can paginate the results using the MaxItems and Marker parameters.

" - }, - "GetAccountPasswordPolicy":{ - "name":"GetAccountPasswordPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "output":{ - "shape":"GetAccountPasswordPolicyResponse", - "resultWrapper":"GetAccountPasswordPolicyResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Retrieves the password policy for the Amazon Web Services account. This tells you the complexity requirements and mandatory rotation periods for the IAM user passwords in your account. For more information about using a password policy, see Managing an IAM password policy.

" - }, - "GetAccountSummary":{ - "name":"GetAccountSummary", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "output":{ - "shape":"GetAccountSummaryResponse", - "resultWrapper":"GetAccountSummaryResult" - }, - "errors":[ - {"shape":"ServiceFailureException"} - ], - "documentation":"

Retrieves information about IAM entity usage and IAM quotas in the Amazon Web Services account.

For information about IAM quotas, see IAM and STS quotas in the IAM User Guide.

" - }, - "GetContextKeysForCustomPolicy":{ - "name":"GetContextKeysForCustomPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetContextKeysForCustomPolicyRequest"}, - "output":{ - "shape":"GetContextKeysForPolicyResponse", - "resultWrapper":"GetContextKeysForCustomPolicyResult" - }, - "errors":[ - {"shape":"InvalidInputException"} - ], - "documentation":"

Gets a list of all of the context keys referenced in the input policies. The policies are supplied as a list of one or more strings. To get the context keys from policies associated with an IAM user, group, or role, use GetContextKeysForPrincipalPolicy.

Context keys are variables maintained by Amazon Web Services and its services that provide details about the context of an API query request. Context keys can be evaluated by testing against a value specified in an IAM policy. Use GetContextKeysForCustomPolicy to understand what key names and values you must supply when you call SimulateCustomPolicy. Note that all parameters are shown in unencoded form here for clarity but must be URL encoded to be included as a part of a real HTML request.

" - }, - "GetContextKeysForPrincipalPolicy":{ - "name":"GetContextKeysForPrincipalPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetContextKeysForPrincipalPolicyRequest"}, - "output":{ - "shape":"GetContextKeysForPolicyResponse", - "resultWrapper":"GetContextKeysForPrincipalPolicyResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"} - ], - "documentation":"

Gets a list of all of the context keys referenced in all the IAM policies that are attached to the specified IAM entity. The entity can be an IAM user, group, or role. If you specify a user, then the request also includes all of the policies attached to groups that the user is a member of.

You can optionally include a list of one or more additional policies, specified as strings. If you want to include only a list of policies by string, use GetContextKeysForCustomPolicy instead.

Note: This operation discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use GetContextKeysForCustomPolicy instead.

Context keys are variables maintained by Amazon Web Services and its services that provide details about the context of an API query request. Context keys can be evaluated by testing against a value in an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key names and values you must supply when you call SimulatePrincipalPolicy. This operation doesn't return context keys referenced by service control policies (SCPs). Only context keys referenced by the identity-based policies attached to the specified entity, and any additional policies that you provide, are included.

" - }, - "GetCredentialReport":{ - "name":"GetCredentialReport", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "output":{ - "shape":"GetCredentialReportResponse", - "resultWrapper":"GetCredentialReportResult" - }, - "errors":[ - {"shape":"CredentialReportNotPresentException"}, - {"shape":"CredentialReportExpiredException"}, - {"shape":"CredentialReportNotReadyException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Retrieves a credential report for the Amazon Web Services account. For more information about the credential report, see Getting credential reports in the IAM User Guide.

" - }, - "GetDelegationRequest":{ - "name":"GetDelegationRequest", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetDelegationRequestRequest"}, - "output":{ - "shape":"GetDelegationRequestResponse", - "resultWrapper":"GetDelegationRequestResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Retrieves information about a specific delegation request.

If a delegation request has no owner or owner account, GetDelegationRequest for that delegation request can be called by any account. If the owner account is assigned but there is no owner id, only identities within that owner account can call GetDelegationRequest for the delegation request. Once the delegation request is fully owned, the owner of the request gets a default permission to get that delegation request. For more details, see Managing Permissions for Delegation Requests.

" - }, - "GetGroup":{ - "name":"GetGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetGroupRequest"}, - "output":{ - "shape":"GetGroupResponse", - "resultWrapper":"GetGroupResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Returns a list of IAM users that are in the specified IAM group. You can paginate the results using the MaxItems and Marker parameters.

" - }, - "GetGroupPolicy":{ - "name":"GetGroupPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetGroupPolicyRequest"}, - "output":{ - "shape":"GetGroupPolicyResponse", - "resultWrapper":"GetGroupPolicyResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Retrieves the specified inline policy document that is embedded in the specified IAM group.

Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality, and some SDKs do this decoding automatically.

An IAM group can also have managed policies attached to it. To retrieve a managed policy document that is attached to a group, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document.

For more information about policies, see Managed policies and inline policies in the IAM User Guide.

" - }, - "GetHumanReadableSummary":{ - "name":"GetHumanReadableSummary", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetHumanReadableSummaryRequest"}, - "output":{ - "shape":"GetHumanReadableSummaryResponse", - "resultWrapper":"GetHumanReadableSummaryResult" - }, - "errors":[ - {"shape":"InvalidInputException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Retrieves a human readable summary for a given entity. At this time, the only supported entity type is delegation-request

This method uses a Large Language Model (LLM) to generate the summary.

If a delegation request has no owner or owner account, GetHumanReadableSummary for that delegation request can be called by any account. If the owner account is assigned but there is no owner id, only identities within that owner account can call GetHumanReadableSummary for the delegation request to retrieve a summary of that request. Once the delegation request is fully owned, the owner of the request gets a default permission to get that delegation request. For more details, read default permissions granted to delegation requests. These rules are identical to GetDelegationRequest API behavior, such that a party who has permissions to call GetDelegationRequest for a given delegation request will always be able to retrieve the human readable summary for that request.

" - }, - "GetInstanceProfile":{ - "name":"GetInstanceProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetInstanceProfileRequest"}, - "output":{ - "shape":"GetInstanceProfileResponse", - "resultWrapper":"GetInstanceProfileResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Retrieves information about the specified instance profile, including the instance profile's path, GUID, ARN, and role. For more information about instance profiles, see Using instance profiles in the IAM User Guide.

" - }, - "GetLoginProfile":{ - "name":"GetLoginProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetLoginProfileRequest"}, - "output":{ - "shape":"GetLoginProfileResponse", - "resultWrapper":"GetLoginProfileResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Retrieves the user name for the specified IAM user. A login profile is created when you create a password for the user to access the Amazon Web Services Management Console. If the user does not exist or does not have a password, the operation returns a 404 (NoSuchEntity) error.

If you create an IAM user with access to the console, the CreateDate reflects the date you created the initial password for the user.

If you create an IAM user with programmatic access, and then later add a password for the user to access the Amazon Web Services Management Console, the CreateDate reflects the initial password creation date. A user with programmatic access does not have a login profile unless you create a password for the user to access the Amazon Web Services Management Console.

" - }, - "GetMFADevice":{ - "name":"GetMFADevice", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetMFADeviceRequest"}, - "output":{ - "shape":"GetMFADeviceResponse", - "resultWrapper":"GetMFADeviceResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Retrieves information about an MFA device for a specified user.

" - }, - "GetOpenIDConnectProvider":{ - "name":"GetOpenIDConnectProvider", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetOpenIDConnectProviderRequest"}, - "output":{ - "shape":"GetOpenIDConnectProviderResponse", - "resultWrapper":"GetOpenIDConnectProviderResult" - }, - "errors":[ - {"shape":"InvalidInputException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Returns information about the specified OpenID Connect (OIDC) provider resource object in IAM.

" - }, - "GetOrganizationsAccessReport":{ - "name":"GetOrganizationsAccessReport", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetOrganizationsAccessReportRequest"}, - "output":{ - "shape":"GetOrganizationsAccessReportResponse", - "resultWrapper":"GetOrganizationsAccessReportResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"} - ], - "documentation":"

Retrieves the service last accessed data report for Organizations that was previously generated using the GenerateOrganizationsAccessReport operation. This operation retrieves the status of your report job and the report contents.

Depending on the parameters that you passed when you generated the report, the data returned could include different information. For details, see GenerateOrganizationsAccessReport.

To call this operation, you must be signed in to the management account in your organization. SCPs must be enabled for your organization root. You must have permissions to perform this operation. For more information, see Refining permissions using service last accessed data in the IAM User Guide.

For each service that principals in an account (root user, IAM users, or IAM roles) could access using SCPs, the operation returns details about the most recent access attempt. If there was no attempt, the service is listed without details about the most recent attempt to access the service. If the operation fails, it returns the reason that it failed.

By default, the list is sorted by service namespace.

" - }, - "GetOutboundWebIdentityFederationInfo":{ - "name":"GetOutboundWebIdentityFederationInfo", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "output":{ - "shape":"GetOutboundWebIdentityFederationInfoResponse", - "resultWrapper":"GetOutboundWebIdentityFederationInfoResult" - }, - "errors":[ - {"shape":"FeatureDisabledException"} - ], - "documentation":"

Retrieves the configuration information for the outbound identity federation feature in your Amazon Web Services account. The response includes the unique issuer URL for your Amazon Web Services account and the current enabled/disabled status of the feature. Use this operation to obtain the issuer URL that you need to configure trust relationships with external services.

" - }, - "GetPolicy":{ - "name":"GetPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetPolicyRequest"}, - "output":{ - "shape":"GetPolicyResponse", - "resultWrapper":"GetPolicyResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Retrieves information about the specified managed policy, including the policy's default version and the total number of IAM users, groups, and roles to which the policy is attached. To retrieve the list of the specific users, groups, and roles that the policy is attached to, use ListEntitiesForPolicy. This operation returns metadata about the policy. To retrieve the actual policy document for a specific version of the policy, use GetPolicyVersion.

This operation retrieves information about managed policies. To retrieve information about an inline policy that is embedded with an IAM user, group, or role, use GetUserPolicy, GetGroupPolicy, or GetRolePolicy.

For more information about policies, see Managed policies and inline policies in the IAM User Guide.

" - }, - "GetPolicyVersion":{ - "name":"GetPolicyVersion", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetPolicyVersionRequest"}, - "output":{ - "shape":"GetPolicyVersionResponse", - "resultWrapper":"GetPolicyVersionResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Retrieves information about the specified version of the specified managed policy, including the policy document.

Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality, and some SDKs do this decoding automatically.

To list the available versions for a policy, use ListPolicyVersions.

This operation retrieves information about managed policies. To retrieve information about an inline policy that is embedded in a user, group, or role, use GetUserPolicy, GetGroupPolicy, or GetRolePolicy.

For more information about the types of policies, see Managed policies and inline policies in the IAM User Guide.

For more information about managed policy versions, see Versioning for managed policies in the IAM User Guide.

" - }, - "GetRole":{ - "name":"GetRole", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetRoleRequest"}, - "output":{ - "shape":"GetRoleResponse", - "resultWrapper":"GetRoleResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Retrieves information about the specified role, including the role's path, GUID, ARN, and the role's trust policy that grants permission to assume the role. For more information about roles, see IAM roles in the IAM User Guide.

Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality, and some SDKs do this decoding automatically.

" - }, - "GetRolePolicy":{ - "name":"GetRolePolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetRolePolicyRequest"}, - "output":{ - "shape":"GetRolePolicyResponse", - "resultWrapper":"GetRolePolicyResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Retrieves the specified inline policy document that is embedded with the specified IAM role.

Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality, and some SDKs do this decoding automatically.

An IAM role can also have managed policies attached to it. To retrieve a managed policy document that is attached to a role, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document.

For more information about policies, see Managed policies and inline policies in the IAM User Guide.

For more information about roles, see IAM roles in the IAM User Guide.

" - }, - "GetSAMLProvider":{ - "name":"GetSAMLProvider", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetSAMLProviderRequest"}, - "output":{ - "shape":"GetSAMLProviderResponse", - "resultWrapper":"GetSAMLProviderResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Returns the SAML provider metadocument that was uploaded when the IAM SAML provider resource object was created or updated.

This operation requires Signature Version 4.

" - }, - "GetSSHPublicKey":{ - "name":"GetSSHPublicKey", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetSSHPublicKeyRequest"}, - "output":{ - "shape":"GetSSHPublicKeyResponse", - "resultWrapper":"GetSSHPublicKeyResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"UnrecognizedPublicKeyEncodingException"} - ], - "documentation":"

Retrieves the specified SSH public key, including metadata about the key.

The SSH public key retrieved by this operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide.

" - }, - "GetServerCertificate":{ - "name":"GetServerCertificate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetServerCertificateRequest"}, - "output":{ - "shape":"GetServerCertificateResponse", - "resultWrapper":"GetServerCertificateResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Retrieves information about the specified server certificate stored in IAM.

For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.

" - }, - "GetServiceLastAccessedDetails":{ - "name":"GetServiceLastAccessedDetails", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetServiceLastAccessedDetailsRequest"}, - "output":{ - "shape":"GetServiceLastAccessedDetailsResponse", - "resultWrapper":"GetServiceLastAccessedDetailsResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"} - ], - "documentation":"

Retrieves a service last accessed report that was created using the GenerateServiceLastAccessedDetails operation. You can use the JobId parameter in GetServiceLastAccessedDetails to retrieve the status of your report job. When the report is complete, you can retrieve the generated report. The report includes a list of Amazon Web Services services that the resource (user, group, role, or managed policy) can access.

Service last accessed data does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, Organizations policies, IAM permissions boundaries, and STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see Evaluating policies in the IAM User Guide.

For each service that the resource could access using permissions policies, the operation returns details about the most recent access attempt. If there was no attempt, the service is listed without details about the most recent attempt to access the service. If the operation fails, the GetServiceLastAccessedDetails operation returns the reason that it failed.

The GetServiceLastAccessedDetails operation returns a list of services. This list includes the number of entities that have attempted to access the service and the date and time of the last attempt. It also returns the ARN of the following entity, depending on the resource ARN that you used to generate the report:

  • User – Returns the user ARN that you used to generate the report

  • Group – Returns the ARN of the group member (user) that last attempted to access the service

  • Role – Returns the role ARN that you used to generate the report

  • Policy – Returns the ARN of the user or role that last used the policy to attempt to access the service

By default, the list is sorted by service namespace.

If you specified ACTION_LEVEL granularity when you generated the report, this operation returns service and action last accessed data. This includes the most recent access attempt for each tracked action within a service. Otherwise, this operation returns only service data.

For more information about service and action last accessed data, see Reducing permissions using service last accessed data in the IAM User Guide.

" - }, - "GetServiceLastAccessedDetailsWithEntities":{ - "name":"GetServiceLastAccessedDetailsWithEntities", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetServiceLastAccessedDetailsWithEntitiesRequest"}, - "output":{ - "shape":"GetServiceLastAccessedDetailsWithEntitiesResponse", - "resultWrapper":"GetServiceLastAccessedDetailsWithEntitiesResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"} - ], - "documentation":"

After you generate a group or policy report using the GenerateServiceLastAccessedDetails operation, you can use the JobId parameter in GetServiceLastAccessedDetailsWithEntities. This operation retrieves the status of your report job and a list of entities that could have used group or policy permissions to access the specified service.

  • Group – For a group report, this operation returns a list of users in the group that could have used the group’s policies in an attempt to access the service.

  • Policy – For a policy report, this operation returns a list of entities (users or roles) that could have used the policy in an attempt to access the service.

You can also use this operation for user or role reports to retrieve details about those entities.

If the operation fails, the GetServiceLastAccessedDetailsWithEntities operation returns the reason that it failed.

By default, the list of associated entities is sorted by date, with the most recent access listed first.

" - }, - "GetServiceLinkedRoleDeletionStatus":{ - "name":"GetServiceLinkedRoleDeletionStatus", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetServiceLinkedRoleDeletionStatusRequest"}, - "output":{ - "shape":"GetServiceLinkedRoleDeletionStatusResponse", - "resultWrapper":"GetServiceLinkedRoleDeletionStatusResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Retrieves the status of your service-linked role deletion. After you use DeleteServiceLinkedRole to submit a service-linked role for deletion, you can use the DeletionTaskId parameter in GetServiceLinkedRoleDeletionStatus to check the status of the deletion. If the deletion fails, this operation returns the reason that it failed, if that information is returned by the service.

" - }, - "GetUser":{ - "name":"GetUser", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetUserRequest"}, - "output":{ - "shape":"GetUserResponse", - "resultWrapper":"GetUserResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Retrieves information about the specified IAM user, including the user's creation date, path, unique ID, and ARN.

If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID used to sign the request to this operation.

" - }, - "GetUserPolicy":{ - "name":"GetUserPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetUserPolicyRequest"}, - "output":{ - "shape":"GetUserPolicyResponse", - "resultWrapper":"GetUserPolicyResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Retrieves the specified inline policy document that is embedded in the specified IAM user.

Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality, and some SDKs do this decoding automatically.

An IAM user can also have managed policies attached to it. To retrieve a managed policy document that is attached to a user, use GetPolicy to determine the policy's default version. Then use GetPolicyVersion to retrieve the policy document.

For more information about policies, see Managed policies and inline policies in the IAM User Guide.

" - }, - "ListAccessKeys":{ - "name":"ListAccessKeys", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListAccessKeysRequest"}, - "output":{ - "shape":"ListAccessKeysResponse", - "resultWrapper":"ListAccessKeysResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Returns information about the access key IDs associated with the specified IAM user. If there is none, the operation returns an empty list.

Although each user is limited to a small number of keys, you can still paginate the results using the MaxItems and Marker parameters.

If the UserName is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. If a temporary access key is used, then UserName is required. If a long-term key is assigned to the user, then UserName is not required.

This operation works for access keys under the Amazon Web Services account. If the Amazon Web Services account has no associated users, the root user returns it's own access key IDs by running this command.

To ensure the security of your Amazon Web Services account, the secret access key is accessible only during key and user creation.

" - }, - "ListAccountAliases":{ - "name":"ListAccountAliases", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListAccountAliasesRequest"}, - "output":{ - "shape":"ListAccountAliasesResponse", - "resultWrapper":"ListAccountAliasesResult" - }, - "errors":[ - {"shape":"ServiceFailureException"} - ], - "documentation":"

Lists the account alias associated with the Amazon Web Services account (Note: you can have only one). For information about using an Amazon Web Services account alias, see Creating, deleting, and listing an Amazon Web Services account alias in the IAM User Guide.

" - }, - "ListAttachedGroupPolicies":{ - "name":"ListAttachedGroupPolicies", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListAttachedGroupPoliciesRequest"}, - "output":{ - "shape":"ListAttachedGroupPoliciesResponse", - "resultWrapper":"ListAttachedGroupPoliciesResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Lists all managed policies that are attached to the specified IAM group.

An IAM group can also have inline policies embedded with it. To list the inline policies for a group, use ListGroupPolicies. For information about policies, see Managed policies and inline policies in the IAM User Guide.

You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the operation returns an empty list.

" - }, - "ListAttachedRolePolicies":{ - "name":"ListAttachedRolePolicies", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListAttachedRolePoliciesRequest"}, - "output":{ - "shape":"ListAttachedRolePoliciesResponse", - "resultWrapper":"ListAttachedRolePoliciesResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Lists all managed policies that are attached to the specified IAM role.

An IAM role can also have inline policies embedded with it. To list the inline policies for a role, use ListRolePolicies. For information about policies, see Managed policies and inline policies in the IAM User Guide.

You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified role (or none that match the specified path prefix), the operation returns an empty list.

" - }, - "ListAttachedUserPolicies":{ - "name":"ListAttachedUserPolicies", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListAttachedUserPoliciesRequest"}, - "output":{ - "shape":"ListAttachedUserPoliciesResponse", - "resultWrapper":"ListAttachedUserPoliciesResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Lists all managed policies that are attached to the specified IAM user.

An IAM user can also have inline policies embedded with it. To list the inline policies for a user, use ListUserPolicies. For information about policies, see Managed policies and inline policies in the IAM User Guide.

You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the operation returns an empty list.

" - }, - "ListDelegationRequests":{ - "name":"ListDelegationRequests", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListDelegationRequestsRequest"}, - "output":{ - "shape":"ListDelegationRequestsResponse", - "resultWrapper":"ListDelegationRequestsResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"}, - {"shape":"InvalidInputException"} - ], - "documentation":"

Lists delegation requests based on the specified criteria.

If a delegation request has no owner, even if it is assigned to a specific account, it will not be part of the ListDelegationRequests output for that account.

For more details, see Managing Permissions for Delegation Requests.

" - }, - "ListEntitiesForPolicy":{ - "name":"ListEntitiesForPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListEntitiesForPolicyRequest"}, - "output":{ - "shape":"ListEntitiesForPolicyResponse", - "resultWrapper":"ListEntitiesForPolicyResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Lists all IAM users, groups, and roles that the specified managed policy is attached to.

You can use the optional EntityFilter parameter to limit the results to a particular type of entity (users, groups, or roles). For example, to list only the roles that are attached to the specified policy, set EntityFilter to Role.

You can paginate the results using the MaxItems and Marker parameters.

" - }, - "ListGroupPolicies":{ - "name":"ListGroupPolicies", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListGroupPoliciesRequest"}, - "output":{ - "shape":"ListGroupPoliciesResponse", - "resultWrapper":"ListGroupPoliciesResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Lists the names of the inline policies that are embedded in the specified IAM group.

An IAM group can also have managed policies attached to it. To list the managed policies that are attached to a group, use ListAttachedGroupPolicies. For more information about policies, see Managed policies and inline policies in the IAM User Guide.

You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified group, the operation returns an empty list.

" - }, - "ListGroups":{ - "name":"ListGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListGroupsRequest"}, - "output":{ - "shape":"ListGroupsResponse", - "resultWrapper":"ListGroupsResult" - }, - "errors":[ - {"shape":"ServiceFailureException"} - ], - "documentation":"

Lists the IAM groups that have the specified path prefix.

You can paginate the results using the MaxItems and Marker parameters.

" - }, - "ListGroupsForUser":{ - "name":"ListGroupsForUser", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListGroupsForUserRequest"}, - "output":{ - "shape":"ListGroupsForUserResponse", - "resultWrapper":"ListGroupsForUserResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Lists the IAM groups that the specified IAM user belongs to.

You can paginate the results using the MaxItems and Marker parameters.

" - }, - "ListInstanceProfileTags":{ - "name":"ListInstanceProfileTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListInstanceProfileTagsRequest"}, - "output":{ - "shape":"ListInstanceProfileTagsResponse", - "resultWrapper":"ListInstanceProfileTagsResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Lists the tags that are attached to the specified IAM instance profile. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

" - }, - "ListInstanceProfiles":{ - "name":"ListInstanceProfiles", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListInstanceProfilesRequest"}, - "output":{ - "shape":"ListInstanceProfilesResponse", - "resultWrapper":"ListInstanceProfilesResult" - }, - "errors":[ - {"shape":"ServiceFailureException"} - ], - "documentation":"

Lists the instance profiles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about instance profiles, see Using instance profiles in the IAM User Guide.

IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for an instance profile, see GetInstanceProfile.

You can paginate the results using the MaxItems and Marker parameters.

" - }, - "ListInstanceProfilesForRole":{ - "name":"ListInstanceProfilesForRole", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListInstanceProfilesForRoleRequest"}, - "output":{ - "shape":"ListInstanceProfilesForRoleResponse", - "resultWrapper":"ListInstanceProfilesForRoleResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Lists the instance profiles that have the specified associated IAM role. If there are none, the operation returns an empty list. For more information about instance profiles, go to Using instance profiles in the IAM User Guide.

You can paginate the results using the MaxItems and Marker parameters.

" - }, - "ListMFADeviceTags":{ - "name":"ListMFADeviceTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListMFADeviceTagsRequest"}, - "output":{ - "shape":"ListMFADeviceTagsResponse", - "resultWrapper":"ListMFADeviceTagsResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Lists the tags that are attached to the specified IAM virtual multi-factor authentication (MFA) device. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

" - }, - "ListMFADevices":{ - "name":"ListMFADevices", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListMFADevicesRequest"}, - "output":{ - "shape":"ListMFADevicesResponse", - "resultWrapper":"ListMFADevicesResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Lists the MFA devices for an IAM user. If the request includes a IAM user name, then this operation lists all the MFA devices associated with the specified user. If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request for this operation.

You can paginate the results using the MaxItems and Marker parameters.

" - }, - "ListOpenIDConnectProviderTags":{ - "name":"ListOpenIDConnectProviderTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListOpenIDConnectProviderTagsRequest"}, - "output":{ - "shape":"ListOpenIDConnectProviderTagsResponse", - "resultWrapper":"ListOpenIDConnectProviderTagsResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"}, - {"shape":"InvalidInputException"} - ], - "documentation":"

Lists the tags that are attached to the specified OpenID Connect (OIDC)-compatible identity provider. The returned list of tags is sorted by tag key. For more information, see About web identity federation.

For more information about tagging, see Tagging IAM resources in the IAM User Guide.

" - }, - "ListOpenIDConnectProviders":{ - "name":"ListOpenIDConnectProviders", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListOpenIDConnectProvidersRequest"}, - "output":{ - "shape":"ListOpenIDConnectProvidersResponse", - "resultWrapper":"ListOpenIDConnectProvidersResult" - }, - "errors":[ - {"shape":"ServiceFailureException"} - ], - "documentation":"

Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the Amazon Web Services account.

IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for an OIDC provider, see GetOpenIDConnectProvider.

" - }, - "ListOrganizationsFeatures":{ - "name":"ListOrganizationsFeatures", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListOrganizationsFeaturesRequest"}, - "output":{ - "shape":"ListOrganizationsFeaturesResponse", - "resultWrapper":"ListOrganizationsFeaturesResult" - }, - "errors":[ - {"shape":"ServiceAccessNotEnabledException"}, - {"shape":"AccountNotManagementOrDelegatedAdministratorException"}, - {"shape":"OrganizationNotFoundException"}, - {"shape":"OrganizationNotInAllFeaturesModeException"} - ], - "documentation":"

Lists the centralized root access features enabled for your organization. For more information, see Centrally manage root access for member accounts.

" - }, - "ListPolicies":{ - "name":"ListPolicies", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListPoliciesRequest"}, - "output":{ - "shape":"ListPoliciesResponse", - "resultWrapper":"ListPoliciesResult" - }, - "errors":[ - {"shape":"ServiceFailureException"} - ], - "documentation":"

Lists all the managed policies that are available in your Amazon Web Services account, including your own customer-defined managed policies and all Amazon Web Services managed policies.

You can filter the list of policies that is returned using the optional OnlyAttached, Scope, and PathPrefix parameters. For example, to list only the customer managed policies in your Amazon Web Services account, set Scope to Local. To list only Amazon Web Services managed policies, set Scope to AWS.

You can paginate the results using the MaxItems and Marker parameters.

For more information about managed policies, see Managed policies and inline policies in the IAM User Guide.

IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a customer manged policy, see GetPolicy.

" - }, - "ListPoliciesGrantingServiceAccess":{ - "name":"ListPoliciesGrantingServiceAccess", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListPoliciesGrantingServiceAccessRequest"}, - "output":{ - "shape":"ListPoliciesGrantingServiceAccessResponse", - "resultWrapper":"ListPoliciesGrantingServiceAccessResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"} - ], - "documentation":"

Retrieves a list of policies that the IAM identity (user, group, or role) can use to access each specified service.

This operation does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, Organizations policies, IAM permissions boundaries, and STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see Evaluating policies in the IAM User Guide.

The list of policies returned by the operation depends on the ARN of the identity that you provide.

  • User – The list of policies includes the managed and inline policies that are attached to the user directly. The list also includes any additional managed and inline policies that are attached to the group to which the user belongs.

  • Group – The list of policies includes only the managed and inline policies that are attached to the group directly. Policies that are attached to the group’s user are not included.

  • Role – The list of policies includes only the managed and inline policies that are attached to the role.

For each managed policy, this operation returns the ARN and policy name. For each inline policy, it returns the policy name and the entity to which it is attached. Inline policies do not have an ARN. For more information about these policy types, see Managed policies and inline policies in the IAM User Guide.

Policies that are attached to users and roles as permissions boundaries are not returned. To view which managed policy is currently used to set the permissions boundary for a user or role, use the GetUser or GetRole operations.

" - }, - "ListPolicyTags":{ - "name":"ListPolicyTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListPolicyTagsRequest"}, - "output":{ - "shape":"ListPolicyTagsResponse", - "resultWrapper":"ListPolicyTagsResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"}, - {"shape":"InvalidInputException"} - ], - "documentation":"

Lists the tags that are attached to the specified IAM customer managed policy. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

" - }, - "ListPolicyVersions":{ - "name":"ListPolicyVersions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListPolicyVersionsRequest"}, - "output":{ - "shape":"ListPolicyVersionsResponse", - "resultWrapper":"ListPolicyVersionsResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Lists information about the versions of the specified managed policy, including the version that is currently set as the policy's default version.

For more information about managed policies, see Managed policies and inline policies in the IAM User Guide.

" - }, - "ListRolePolicies":{ - "name":"ListRolePolicies", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListRolePoliciesRequest"}, - "output":{ - "shape":"ListRolePoliciesResponse", - "resultWrapper":"ListRolePoliciesResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Lists the names of the inline policies that are embedded in the specified IAM role.

An IAM role can also have managed policies attached to it. To list the managed policies that are attached to a role, use ListAttachedRolePolicies. For more information about policies, see Managed policies and inline policies in the IAM User Guide.

You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified role, the operation returns an empty list.

" - }, - "ListRoleTags":{ - "name":"ListRoleTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListRoleTagsRequest"}, - "output":{ - "shape":"ListRoleTagsResponse", - "resultWrapper":"ListRoleTagsResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Lists the tags that are attached to the specified role. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

" - }, - "ListRoles":{ - "name":"ListRoles", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListRolesRequest"}, - "output":{ - "shape":"ListRolesResponse", - "resultWrapper":"ListRolesResult" - }, - "errors":[ - {"shape":"ServiceFailureException"} - ], - "documentation":"

Lists the IAM roles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about roles, see IAM roles in the IAM User Guide.

IAM resource-listing operations return a subset of the available attributes for the resource. This operation does not return the following attributes, even though they are an attribute of the returned object:

  • PermissionsBoundary

  • RoleLastUsed

  • Tags

To view all of the information for a role, see GetRole.

You can paginate the results using the MaxItems and Marker parameters.

" - }, - "ListSAMLProviderTags":{ - "name":"ListSAMLProviderTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListSAMLProviderTagsRequest"}, - "output":{ - "shape":"ListSAMLProviderTagsResponse", - "resultWrapper":"ListSAMLProviderTagsResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"}, - {"shape":"InvalidInputException"} - ], - "documentation":"

Lists the tags that are attached to the specified Security Assertion Markup Language (SAML) identity provider. The returned list of tags is sorted by tag key. For more information, see About SAML 2.0-based federation.

For more information about tagging, see Tagging IAM resources in the IAM User Guide.

" - }, - "ListSAMLProviders":{ - "name":"ListSAMLProviders", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListSAMLProvidersRequest"}, - "output":{ - "shape":"ListSAMLProvidersResponse", - "resultWrapper":"ListSAMLProvidersResult" - }, - "errors":[ - {"shape":"ServiceFailureException"} - ], - "documentation":"

Lists the SAML provider resource objects defined in IAM in the account. IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a SAML provider, see GetSAMLProvider.

This operation requires Signature Version 4.

" - }, - "ListSSHPublicKeys":{ - "name":"ListSSHPublicKeys", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListSSHPublicKeysRequest"}, - "output":{ - "shape":"ListSSHPublicKeysResponse", - "resultWrapper":"ListSSHPublicKeysResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"} - ], - "documentation":"

Returns information about the SSH public keys associated with the specified IAM user. If none exists, the operation returns an empty list.

The SSH public keys returned by this operation are used only for authenticating the IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide.

Although each user is limited to a small number of keys, you can still paginate the results using the MaxItems and Marker parameters.

" - }, - "ListServerCertificateTags":{ - "name":"ListServerCertificateTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListServerCertificateTagsRequest"}, - "output":{ - "shape":"ListServerCertificateTagsResponse", - "resultWrapper":"ListServerCertificateTagsResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Lists the tags that are attached to the specified IAM server certificate. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

For certificates in a Region supported by Certificate Manager (ACM), we recommend that you don't use IAM server certificates. Instead, use ACM to provision, manage, and deploy your server certificates. For more information about IAM server certificates, Working with server certificates in the IAM User Guide.

" - }, - "ListServerCertificates":{ - "name":"ListServerCertificates", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListServerCertificatesRequest"}, - "output":{ - "shape":"ListServerCertificatesResponse", - "resultWrapper":"ListServerCertificatesResult" - }, - "errors":[ - {"shape":"ServiceFailureException"} - ], - "documentation":"

Lists the server certificates stored in IAM that have the specified path prefix. If none exist, the operation returns an empty list.

You can paginate the results using the MaxItems and Marker parameters.

For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.

IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a servercertificate, see GetServerCertificate.

" - }, - "ListServiceSpecificCredentials":{ - "name":"ListServiceSpecificCredentials", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListServiceSpecificCredentialsRequest"}, - "output":{ - "shape":"ListServiceSpecificCredentialsResponse", - "resultWrapper":"ListServiceSpecificCredentialsResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceNotSupportedException"} - ], - "documentation":"

Returns information about the service-specific credentials associated with the specified IAM user. If none exists, the operation returns an empty list. The service-specific credentials returned by this operation are used only for authenticating the IAM user to a specific service. For more information about using service-specific credentials to authenticate to an Amazon Web Services service, refer to the following docs:

" - }, - "ListSigningCertificates":{ - "name":"ListSigningCertificates", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListSigningCertificatesRequest"}, - "output":{ - "shape":"ListSigningCertificatesResponse", - "resultWrapper":"ListSigningCertificatesResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Returns information about the signing certificates associated with the specified IAM user. If none exists, the operation returns an empty list.

Although each user is limited to a small number of signing certificates, you can still paginate the results using the MaxItems and Marker parameters.

If the UserName field is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request for this operation. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.

" - }, - "ListUserPolicies":{ - "name":"ListUserPolicies", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListUserPoliciesRequest"}, - "output":{ - "shape":"ListUserPoliciesResponse", - "resultWrapper":"ListUserPoliciesResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Lists the names of the inline policies embedded in the specified IAM user.

An IAM user can also have managed policies attached to it. To list the managed policies that are attached to a user, use ListAttachedUserPolicies. For more information about policies, see Managed policies and inline policies in the IAM User Guide.

You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified user, the operation returns an empty list.

" - }, - "ListUserTags":{ - "name":"ListUserTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListUserTagsRequest"}, - "output":{ - "shape":"ListUserTagsResponse", - "resultWrapper":"ListUserTagsResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Lists the tags that are attached to the specified IAM user. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

" - }, - "ListUsers":{ - "name":"ListUsers", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListUsersRequest"}, - "output":{ - "shape":"ListUsersResponse", - "resultWrapper":"ListUsersResult" - }, - "errors":[ - {"shape":"ServiceFailureException"} - ], - "documentation":"

Lists the IAM users that have the specified path prefix. If no path prefix is specified, the operation returns all users in the Amazon Web Services account. If there are none, the operation returns an empty list.

IAM resource-listing operations return a subset of the available attributes for the resource. This operation does not return the following attributes, even though they are an attribute of the returned object:

  • PermissionsBoundary

  • Tags

To view all of the information for a user, see GetUser.

You can paginate the results using the MaxItems and Marker parameters.

" - }, - "ListVirtualMFADevices":{ - "name":"ListVirtualMFADevices", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListVirtualMFADevicesRequest"}, - "output":{ - "shape":"ListVirtualMFADevicesResponse", - "resultWrapper":"ListVirtualMFADevicesResult" - }, - "documentation":"

Lists the virtual MFA devices defined in the Amazon Web Services account by assignment status. If you do not specify an assignment status, the operation returns a list of all virtual MFA devices. Assignment status can be Assigned, Unassigned, or Any.

IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view tag information for a virtual MFA device, see ListMFADeviceTags.

You can paginate the results using the MaxItems and Marker parameters.

" - }, - "PutGroupPolicy":{ - "name":"PutGroupPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"PutGroupPolicyRequest"}, - "errors":[ - {"shape":"LimitExceededException"}, - {"shape":"MalformedPolicyDocumentException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Adds or updates an inline policy document that is embedded in the specified IAM group.

A user can also have managed policies attached to it. To attach a managed policy to a group, use AttachGroupPolicy . To create a new managed policy, use CreatePolicy . For information about policies, see Managed policies and inline policies in the IAM User Guide.

For information about the maximum number of inline policies that you can embed in a group, see IAM and STS quotas in the IAM User Guide.

Because policy documents can be large, you should use POST rather than GET when calling PutGroupPolicy. For general information about using the Query API with IAM, see Making query requests in the IAM User Guide.

" - }, - "PutRolePermissionsBoundary":{ - "name":"PutRolePermissionsBoundary", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"PutRolePermissionsBoundaryRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"UnmodifiableEntityException"}, - {"shape":"PolicyNotAttachableException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Adds or updates the policy that is specified as the IAM role's permissions boundary. You can use an Amazon Web Services managed policy or a customer managed policy to set the boundary for a role. Use the boundary to control the maximum permissions that the role can have. Setting a permissions boundary is an advanced feature that can affect the permissions for the role.

You cannot set the boundary for a service-linked role.

Policies used as permissions boundaries do not provide permissions. You must also attach a permissions policy to the role. To learn how the effective permissions for a role are evaluated, see IAM JSON policy evaluation logic in the IAM User Guide.

" - }, - "PutRolePolicy":{ - "name":"PutRolePolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"PutRolePolicyRequest"}, - "errors":[ - {"shape":"LimitExceededException"}, - {"shape":"MalformedPolicyDocumentException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"UnmodifiableEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Adds or updates an inline policy document that is embedded in the specified IAM role.

When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role, using CreateRole . You can update a role's trust policy using UpdateAssumeRolePolicy . For more information about roles, see IAM roles in the IAM User Guide.

A role can also have a managed policy attached to it. To attach a managed policy to a role, use AttachRolePolicy . To create a new managed policy, use CreatePolicy . For information about policies, see Managed policies and inline policies in the IAM User Guide.

For information about the maximum number of inline policies that you can embed with a role, see IAM and STS quotas in the IAM User Guide.

Because policy documents can be large, you should use POST rather than GET when calling PutRolePolicy. For general information about using the Query API with IAM, see Making query requests in the IAM User Guide.

" - }, - "PutUserPermissionsBoundary":{ - "name":"PutUserPermissionsBoundary", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"PutUserPermissionsBoundaryRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"PolicyNotAttachableException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Adds or updates the policy that is specified as the IAM user's permissions boundary. You can use an Amazon Web Services managed policy or a customer managed policy to set the boundary for a user. Use the boundary to control the maximum permissions that the user can have. Setting a permissions boundary is an advanced feature that can affect the permissions for the user.

Policies that are used as permissions boundaries do not provide permissions. You must also attach a permissions policy to the user. To learn how the effective permissions for a user are evaluated, see IAM JSON policy evaluation logic in the IAM User Guide.

" - }, - "PutUserPolicy":{ - "name":"PutUserPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"PutUserPolicyRequest"}, - "errors":[ - {"shape":"LimitExceededException"}, - {"shape":"MalformedPolicyDocumentException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Adds or updates an inline policy document that is embedded in the specified IAM user.

An IAM user can also have a managed policy attached to it. To attach a managed policy to a user, use AttachUserPolicy . To create a new managed policy, use CreatePolicy . For information about policies, see Managed policies and inline policies in the IAM User Guide.

For information about the maximum number of inline policies that you can embed in a user, see IAM and STS quotas in the IAM User Guide.

Because policy documents can be large, you should use POST rather than GET when calling PutUserPolicy. For general information about using the Query API with IAM, see Making query requests in the IAM User Guide.

" - }, - "RejectDelegationRequest":{ - "name":"RejectDelegationRequest", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RejectDelegationRequestRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"InvalidInputException"} - ], - "documentation":"

Rejects a delegation request, denying the requested temporary access.

Once a request is rejected, it cannot be accepted or updated later. Rejected requests expire after 7 days.

When rejecting a request, an optional explanation can be added using the Notes request parameter.

For more details, see Managing Permissions for Delegation Requests.

" - }, - "RemoveClientIDFromOpenIDConnectProvider":{ - "name":"RemoveClientIDFromOpenIDConnectProvider", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RemoveClientIDFromOpenIDConnectProviderRequest"}, - "errors":[ - {"shape":"ConcurrentModificationException"}, - {"shape":"InvalidInputException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Removes the specified client ID (also known as audience) from the list of client IDs registered for the specified IAM OpenID Connect (OIDC) provider resource object.

This operation is idempotent; it does not fail or return an error if you try to remove a client ID that does not exist.

" - }, - "RemoveRoleFromInstanceProfile":{ - "name":"RemoveRoleFromInstanceProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RemoveRoleFromInstanceProfileRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"UnmodifiableEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Removes the specified IAM role from the specified Amazon EC2 instance profile.

Make sure that you do not have any Amazon EC2 instances running with the role you are about to remove from the instance profile. Removing a role from an instance profile that is associated with a running instance might break any applications running on the instance.

For more information about roles, see IAM roles in the IAM User Guide. For more information about instance profiles, see Using instance profiles in the IAM User Guide.

" - }, - "RemoveUserFromGroup":{ - "name":"RemoveUserFromGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RemoveUserFromGroupRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Removes the specified user from the specified group.

" - }, - "ResetServiceSpecificCredential":{ - "name":"ResetServiceSpecificCredential", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ResetServiceSpecificCredentialRequest"}, - "output":{ - "shape":"ResetServiceSpecificCredentialResponse", - "resultWrapper":"ResetServiceSpecificCredentialResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"} - ], - "documentation":"

Resets the password for a service-specific credential. The new password is Amazon Web Services generated and cryptographically strong. It cannot be configured by the user. Resetting the password immediately invalidates the previous password associated with this user.

" - }, - "ResyncMFADevice":{ - "name":"ResyncMFADevice", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ResyncMFADeviceRequest"}, - "errors":[ - {"shape":"InvalidAuthenticationCodeException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"}, - {"shape":"ConcurrentModificationException"} - ], - "documentation":"

Synchronizes the specified MFA device with its IAM resource object on the Amazon Web Services servers.

For more information about creating and working with virtual MFA devices, see Using a virtual MFA device in the IAM User Guide.

" - }, - "SendDelegationToken":{ - "name":"SendDelegationToken", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"SendDelegationTokenRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"InvalidInputException"} - ], - "documentation":"

Sends the exchange token for an accepted delegation request.

The exchange token is sent to the partner via an asynchronous notification channel, established by the partner.

The delegation request must be in the ACCEPTED state when calling this API. After the SendDelegationToken API call is successful, the request transitions to a FINALIZED state and cannot be rolled back. However, a user may reject an accepted request before the SendDelegationToken API is called.

For more details, see Managing Permissions for Delegation Requests.

" - }, - "SetDefaultPolicyVersion":{ - "name":"SetDefaultPolicyVersion", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"SetDefaultPolicyVersionRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Sets the specified version of the specified policy as the policy's default (operative) version.

This operation affects all users, groups, and roles that the policy is attached to. To list the users, groups, and roles that the policy is attached to, use ListEntitiesForPolicy.

For information about managed policies, see Managed policies and inline policies in the IAM User Guide.

" - }, - "SetSecurityTokenServicePreferences":{ - "name":"SetSecurityTokenServicePreferences", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"SetSecurityTokenServicePreferencesRequest"}, - "errors":[ - {"shape":"ServiceFailureException"} - ], - "documentation":"

Sets the specified version of the global endpoint token as the token version used for the Amazon Web Services account.

By default, Security Token Service (STS) is available as a global service, and all STS requests go to a single endpoint at https://sts.amazonaws.com. Amazon Web Services recommends using Regional STS endpoints to reduce latency, build in redundancy, and increase session token availability. For information about Regional endpoints for STS, see Security Token Service endpoints and quotas in the Amazon Web Services General Reference.

If you make an STS call to the global endpoint, the resulting session tokens might be valid in some Regions but not others. It depends on the version that is set in this operation. Version 1 tokens are valid only in Amazon Web Services Regions that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily store tokens. For information, see Activating and deactivating STS in an Amazon Web Services Region in the IAM User Guide.

To view the current session token version, see the GlobalEndpointTokenVersion entry in the response of the GetAccountSummary operation.

" - }, - "SimulateCustomPolicy":{ - "name":"SimulateCustomPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"SimulateCustomPolicyRequest"}, - "output":{ - "shape":"SimulatePolicyResponse", - "resultWrapper":"SimulateCustomPolicyResult" - }, - "errors":[ - {"shape":"InvalidInputException"}, - {"shape":"PolicyEvaluationException"} - ], - "documentation":"

Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API operations and Amazon Web Services resources to determine the policies' effective permissions. The policies are provided as strings.

The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations. You can simulate resources that don't exist in your account.

If you want to simulate existing policies that are attached to an IAM user, group, or role, use SimulatePrincipalPolicy instead.

Context keys are variables that are maintained by Amazon Web Services and its services and which provide details about the context of an API query request. You can use the Condition element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForCustomPolicy.

If the output is long, you can use MaxItems and Marker parameters to paginate the results.

The IAM policy simulator evaluates statements in identity-based policies, service control policies (SCPs) including their condition keys and resource scoping, and the inputs that you provide during simulation. The policy simulator results can differ from your live Amazon Web Services environment. We recommend that you check your policies against your live Amazon Web Services environment after testing using the policy simulator to confirm that you have the desired results. For more information about using the policy simulator, see Testing IAM policies with the IAM policy simulator in the IAM User Guide.

" - }, - "SimulatePrincipalPolicy":{ - "name":"SimulatePrincipalPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"SimulatePrincipalPolicyRequest"}, - "output":{ - "shape":"SimulatePolicyResponse", - "resultWrapper":"SimulatePrincipalPolicyResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"PolicyEvaluationException"} - ], - "documentation":"

Simulate how a set of IAM policies attached to an IAM entity works with a list of API operations and Amazon Web Services resources to determine the policies' effective permissions. The entity can be an IAM user, group, or role. If you specify a user, then the simulation also includes all of the policies that are attached to groups that the user belongs to. You can simulate resources that don't exist in your account.

You can optionally include a list of one or more additional policies specified as strings to include in the simulation. If you want to simulate only policies specified as strings, use SimulateCustomPolicy instead.

You can also optionally include one resource-based policy to be evaluated with each of the resources included in the simulation for IAM users only.

The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations.

For cross-account simulations, EvalDecisionDetails returns the decision for each policy type (identity-based policy, resource-based policy, and permissions boundary). This helps you identify which policy type is responsible for an allow or deny decision when policies span multiple accounts.

Note: This operation discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use SimulateCustomPolicy instead.

Context keys are variables maintained by Amazon Web Services and its services that provide details about the context of an API query request. You can use the Condition element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForPrincipalPolicy.

If the output is long, you can use the MaxItems and Marker parameters to paginate the results.

The IAM policy simulator evaluates statements in identity-based policies, service control policies (SCPs) including their condition keys and resource scoping, and the inputs that you provide during simulation. The policy simulator results can differ from your live Amazon Web Services environment. We recommend that you check your policies against your live Amazon Web Services environment after testing using the policy simulator to confirm that you have the desired results. For more information about using the policy simulator, see Testing IAM policies with the IAM policy simulator in the IAM User Guide.

" - }, - "TagInstanceProfile":{ - "name":"TagInstanceProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"TagInstanceProfileRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"LimitExceededException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Adds one or more tags to an IAM instance profile. If a tag with the same key name already exists, then that tag is overwritten with the new value.

Each tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:

  • Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.

  • Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM instance profile that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.

  • If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

  • Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

" - }, - "TagMFADevice":{ - "name":"TagMFADevice", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"TagMFADeviceRequest"}, - "errors":[ - {"shape":"InvalidInputException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Adds one or more tags to an IAM virtual multi-factor authentication (MFA) device. If a tag with the same key name already exists, then that tag is overwritten with the new value.

A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:

  • Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.

  • Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM virtual MFA device that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.

  • If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

  • Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

" - }, - "TagOpenIDConnectProvider":{ - "name":"TagOpenIDConnectProvider", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"TagOpenIDConnectProviderRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"InvalidInputException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Adds one or more tags to an OpenID Connect (OIDC)-compatible identity provider. For more information about these providers, see About web identity federation. If a tag with the same key name already exists, then that tag is overwritten with the new value.

A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:

  • Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.

  • Access control - Include tags in IAM identity-based and resource-based policies. You can use tags to restrict access to only an OIDC provider that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.

  • If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

  • Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

" - }, - "TagPolicy":{ - "name":"TagPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"TagPolicyRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"InvalidInputException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Adds one or more tags to an IAM customer managed policy. If a tag with the same key name already exists, then that tag is overwritten with the new value.

A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:

  • Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.

  • Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM customer managed policy that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.

  • If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

  • Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

" - }, - "TagRole":{ - "name":"TagRole", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"TagRoleRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"InvalidInputException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Adds one or more tags to an IAM role. The role can be a regular role or a service-linked role. If a tag with the same key name already exists, then that tag is overwritten with the new value.

A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:

  • Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.

  • Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM role that has a specified tag attached. You can also restrict access to only those resources that have a certain tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.

  • Cost allocation - Use tags to help track which individuals and teams are using which Amazon Web Services resources.

  • If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

  • Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

For more information about tagging, see Tagging IAM identities in the IAM User Guide.

" - }, - "TagSAMLProvider":{ - "name":"TagSAMLProvider", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"TagSAMLProviderRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"InvalidInputException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Adds one or more tags to a Security Assertion Markup Language (SAML) identity provider. For more information about these providers, see About SAML 2.0-based federation . If a tag with the same key name already exists, then that tag is overwritten with the new value.

A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:

  • Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.

  • Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only a SAML identity provider that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.

  • If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

  • Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

" - }, - "TagServerCertificate":{ - "name":"TagServerCertificate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"TagServerCertificateRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"LimitExceededException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Adds one or more tags to an IAM server certificate. If a tag with the same key name already exists, then that tag is overwritten with the new value.

For certificates in a Region supported by Certificate Manager (ACM), we recommend that you don't use IAM server certificates. Instead, use ACM to provision, manage, and deploy your server certificates. For more information about IAM server certificates, Working with server certificates in the IAM User Guide.

A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:

  • Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.

  • Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only a server certificate that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.

  • Cost allocation - Use tags to help track which individuals and teams are using which Amazon Web Services resources.

  • If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

  • Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

" - }, - "TagUser":{ - "name":"TagUser", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"TagUserRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"InvalidInputException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Adds one or more tags to an IAM user. If a tag with the same key name already exists, then that tag is overwritten with the new value.

A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:

  • Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.

  • Access control - Include tags in IAM identity-based and resource-based policies. You can use tags to restrict access to only an IAM requesting user that has a specified tag attached. You can also restrict access to only those resources that have a certain tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.

  • Cost allocation - Use tags to help track which individuals and teams are using which Amazon Web Services resources.

  • If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

  • Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

For more information about tagging, see Tagging IAM identities in the IAM User Guide.

" - }, - "UntagInstanceProfile":{ - "name":"UntagInstanceProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UntagInstanceProfileRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Removes the specified tags from the IAM instance profile. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

" - }, - "UntagMFADevice":{ - "name":"UntagMFADevice", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UntagMFADeviceRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Removes the specified tags from the IAM virtual multi-factor authentication (MFA) device. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

" - }, - "UntagOpenIDConnectProvider":{ - "name":"UntagOpenIDConnectProvider", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UntagOpenIDConnectProviderRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Removes the specified tags from the specified OpenID Connect (OIDC)-compatible identity provider in IAM. For more information about OIDC providers, see About web identity federation. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

" - }, - "UntagPolicy":{ - "name":"UntagPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UntagPolicyRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Removes the specified tags from the customer managed policy. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

" - }, - "UntagRole":{ - "name":"UntagRole", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UntagRoleRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Removes the specified tags from the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

" - }, - "UntagSAMLProvider":{ - "name":"UntagSAMLProvider", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UntagSAMLProviderRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Removes the specified tags from the specified Security Assertion Markup Language (SAML) identity provider in IAM. For more information about these providers, see About web identity federation. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

" - }, - "UntagServerCertificate":{ - "name":"UntagServerCertificate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UntagServerCertificateRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Removes the specified tags from the IAM server certificate. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

For certificates in a Region supported by Certificate Manager (ACM), we recommend that you don't use IAM server certificates. Instead, use ACM to provision, manage, and deploy your server certificates. For more information about IAM server certificates, Working with server certificates in the IAM User Guide.

" - }, - "UntagUser":{ - "name":"UntagUser", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UntagUserRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Removes the specified tags from the user. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

" - }, - "UpdateAccessKey":{ - "name":"UpdateAccessKey", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateAccessKeyRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"}, - {"shape":"InvalidInputException"} - ], - "documentation":"

Changes the status of the specified access key from Active to Inactive, or vice versa. This operation can be used to disable a user's key as part of a key rotation workflow.

If the UserName is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. If a temporary access key is used, then UserName is required. If a long-term key is assigned to the user, then UserName is not required. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.

For information about rotating keys, see Managing keys and certificates in the IAM User Guide.

" - }, - "UpdateAccountPasswordPolicy":{ - "name":"UpdateAccountPasswordPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateAccountPasswordPolicyRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"MalformedPolicyDocumentException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Updates the password policy settings for the Amazon Web Services account.

This operation does not support partial updates. No parameters are required, but if you do not specify a parameter, that parameter's value reverts to its default value. See the Request Parameters section for each parameter's default value. Also note that some parameters do not allow the default parameter to be explicitly set. Instead, to invoke the default value, do not include that parameter when you invoke the operation.

For more information about using a password policy, see Managing an IAM password policy in the IAM User Guide.

" - }, - "UpdateAssumeRolePolicy":{ - "name":"UpdateAssumeRolePolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateAssumeRolePolicyRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"MalformedPolicyDocumentException"}, - {"shape":"LimitExceededException"}, - {"shape":"UnmodifiableEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Updates the policy that grants an IAM entity permission to assume a role. This is typically referred to as the \"role trust policy\". For more information about roles, see Using roles to delegate permissions and federate identities.

" - }, - "UpdateDelegationRequest":{ - "name":"UpdateDelegationRequest", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateDelegationRequestRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"InvalidInputException"} - ], - "documentation":"

Updates an existing delegation request with additional information. When the delegation request is updated, it reaches the PENDING_APPROVAL state.

Once a delegation request has an owner, that owner gets a default permission to update the delegation request. For more details, see Managing Permissions for Delegation Requests.

" - }, - "UpdateGroup":{ - "name":"UpdateGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateGroupRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"EntityAlreadyExistsException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Updates the name and/or the path of the specified IAM group.

You should understand the implications of changing a group's path or name. For more information, see Renaming users and groups in the IAM User Guide.

The person making the request (the principal), must have permission to change the role group with the old name and the new name. For example, to change the group named Managers to MGRs, the principal must have a policy that allows them to update both groups. If the principal has permission to update the Managers group, but not the MGRs group, then the update fails. For more information about permissions, see Access management.

" - }, - "UpdateLoginProfile":{ - "name":"UpdateLoginProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateLoginProfileRequest"}, - "errors":[ - {"shape":"EntityTemporarilyUnmodifiableException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"PasswordPolicyViolationException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Changes the password for the specified IAM user. You can use the CLI, the Amazon Web Services API, or the Users page in the IAM console to change the password for any IAM user. Use ChangePassword to change your own password in the My Security Credentials page in the Amazon Web Services Management Console.

For more information about modifying passwords, see Managing passwords in the IAM User Guide.

" - }, - "UpdateOpenIDConnectProviderThumbprint":{ - "name":"UpdateOpenIDConnectProviderThumbprint", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateOpenIDConnectProviderThumbprintRequest"}, - "errors":[ - {"shape":"ConcurrentModificationException"}, - {"shape":"InvalidInputException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Replaces the existing list of server certificate thumbprints associated with an OpenID Connect (OIDC) provider resource object with a new list of thumbprints.

The list that you pass with this operation completely replaces the existing list of thumbprints. (The lists are not merged.)

Typically, you need to update a thumbprint only when the identity provider certificate changes, which occurs rarely. However, if the provider's certificate does change, any attempt to assume an IAM role that specifies the OIDC provider as a principal fails until the certificate thumbprint is updated.

Amazon Web Services secures communication with OIDC identity providers (IdPs) using our library of trusted root certificate authorities (CAs) to verify the JSON Web Key Set (JWKS) endpoint's TLS certificate. If your OIDC IdP relies on a certificate that is not signed by one of these trusted CAs, only then we secure communication using the thumbprints set in the IdP's configuration.

Trust for the OIDC provider is derived from the provider certificate and is validated by the thumbprint. Therefore, it is best to limit access to the UpdateOpenIDConnectProviderThumbprint operation to highly privileged users.

" - }, - "UpdateRole":{ - "name":"UpdateRole", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateRoleRequest"}, - "output":{ - "shape":"UpdateRoleResponse", - "resultWrapper":"UpdateRoleResult" - }, - "errors":[ - {"shape":"UnmodifiableEntityException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Updates the description or maximum session duration setting of a role.

" - }, - "UpdateRoleDescription":{ - "name":"UpdateRoleDescription", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateRoleDescriptionRequest"}, - "output":{ - "shape":"UpdateRoleDescriptionResponse", - "resultWrapper":"UpdateRoleDescriptionResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"UnmodifiableEntityException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Use UpdateRole instead.

Modifies only the description of a role. This operation performs the same function as the Description parameter in the UpdateRole operation.

" - }, - "UpdateSAMLProvider":{ - "name":"UpdateSAMLProvider", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateSAMLProviderRequest"}, - "output":{ - "shape":"UpdateSAMLProviderResponse", - "resultWrapper":"UpdateSAMLProviderResult" - }, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"}, - {"shape":"ConcurrentModificationException"} - ], - "documentation":"

Updates the metadata document, SAML encryption settings, and private keys for an existing SAML provider. To rotate private keys, add your new private key and then remove the old key in a separate request.

" - }, - "UpdateSSHPublicKey":{ - "name":"UpdateSSHPublicKey", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateSSHPublicKeyRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidInputException"} - ], - "documentation":"

Sets the status of an IAM user's SSH public key to active or inactive. SSH public keys that are inactive cannot be used for authentication. This operation can be used to disable a user's SSH public key as part of a key rotation work flow.

The SSH public key affected by this operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide.

" - }, - "UpdateServerCertificate":{ - "name":"UpdateServerCertificate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateServerCertificateRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"EntityAlreadyExistsException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Updates the name and/or the path of the specified server certificate stored in IAM.

For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.

You should understand the implications of changing a server certificate's path or name. For more information, see Renaming a server certificate in the IAM User Guide.

The person making the request (the principal), must have permission to change the server certificate with the old name and the new name. For example, to change the certificate named ProductionCert to ProdCert, the principal must have a policy that allows them to update both certificates. If the principal has permission to update the ProductionCert group, but not the ProdCert certificate, then the update fails. For more information about permissions, see Access management in the IAM User Guide.

" - }, - "UpdateServiceSpecificCredential":{ - "name":"UpdateServiceSpecificCredential", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateServiceSpecificCredentialRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"} - ], - "documentation":"

Sets the status of a service-specific credential to Active or Inactive. Service-specific credentials that are inactive cannot be used for authentication to the service. This operation can be used to disable a user's service-specific credential as part of a credential rotation work flow.

" - }, - "UpdateSigningCertificate":{ - "name":"UpdateSigningCertificate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateSigningCertificateRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"ServiceFailureException"}, - {"shape":"InvalidInputException"} - ], - "documentation":"

Changes the status of the specified user signing certificate from active to disabled, or vice versa. This operation can be used to disable an IAM user's signing certificate as part of a certificate rotation work flow.

If the UserName field is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.

" - }, - "UpdateUser":{ - "name":"UpdateUser", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateUserRequest"}, - "errors":[ - {"shape":"NoSuchEntityException"}, - {"shape":"LimitExceededException"}, - {"shape":"EntityAlreadyExistsException"}, - {"shape":"EntityTemporarilyUnmodifiableException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Updates the name and/or the path of the specified IAM user.

You should understand the implications of changing an IAM user's path or name. For more information, see Renaming an IAM user and Renaming an IAM group in the IAM User Guide.

To change a user name, the requester must have appropriate permissions on both the source object and the target object. For example, to change Bob to Robert, the entity making the request must have permission on Bob and Robert, or must have permission on all (*). For more information about permissions, see Permissions and policies.

" - }, - "UploadSSHPublicKey":{ - "name":"UploadSSHPublicKey", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UploadSSHPublicKeyRequest"}, - "output":{ - "shape":"UploadSSHPublicKeyResponse", - "resultWrapper":"UploadSSHPublicKeyResult" - }, - "errors":[ - {"shape":"LimitExceededException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"InvalidPublicKeyException"}, - {"shape":"DuplicateSSHPublicKeyException"}, - {"shape":"UnrecognizedPublicKeyEncodingException"} - ], - "documentation":"

Uploads an SSH public key and associates it with the specified IAM user.

The SSH public key uploaded by this operation can be used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide.

" - }, - "UploadServerCertificate":{ - "name":"UploadServerCertificate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UploadServerCertificateRequest"}, - "output":{ - "shape":"UploadServerCertificateResponse", - "resultWrapper":"UploadServerCertificateResult" - }, - "errors":[ - {"shape":"LimitExceededException"}, - {"shape":"InvalidInputException"}, - {"shape":"EntityAlreadyExistsException"}, - {"shape":"MalformedCertificateException"}, - {"shape":"KeyPairMismatchException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Uploads a server certificate entity for the Amazon Web Services account. The server certificate entity includes a public key certificate, a private key, and an optional certificate chain, which should all be PEM-encoded.

We recommend that you use Certificate Manager to provision, manage, and deploy your server certificates. With ACM you can request a certificate, deploy it to Amazon Web Services resources, and let ACM handle certificate renewals for you. Certificates provided by ACM are free. For more information about using ACM, see the Certificate Manager User Guide.

For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.

For information about the number of server certificates you can upload, see IAM and STS quotas in the IAM User Guide.

Because the body of the public key certificate, private key, and the certificate chain can be large, you should use POST rather than GET when calling UploadServerCertificate. For information about setting up signatures and authorization through the API, see Signing Amazon Web Services API requests in the Amazon Web Services General Reference. For general information about using the Query API with IAM, see Calling the API by making HTTP query requests in the IAM User Guide.

" - }, - "UploadSigningCertificate":{ - "name":"UploadSigningCertificate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UploadSigningCertificateRequest"}, - "output":{ - "shape":"UploadSigningCertificateResponse", - "resultWrapper":"UploadSigningCertificateResult" - }, - "errors":[ - {"shape":"LimitExceededException"}, - {"shape":"EntityAlreadyExistsException"}, - {"shape":"MalformedCertificateException"}, - {"shape":"InvalidCertificateException"}, - {"shape":"DuplicateCertificateException"}, - {"shape":"NoSuchEntityException"}, - {"shape":"ConcurrentModificationException"}, - {"shape":"ServiceFailureException"} - ], - "documentation":"

Uploads an X.509 signing certificate and associates it with the specified IAM user. Some Amazon Web Services services require you to use certificates to validate requests that are signed with a corresponding private key. When you upload the certificate, its default status is Active.

For information about when you would use an X.509 signing certificate, see Managing server certificates in IAM in the IAM User Guide.

If the UserName is not specified, the IAM user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.

Because the body of an X.509 certificate can be large, you should use POST rather than GET when calling UploadSigningCertificate. For information about setting up signatures and authorization through the API, see Signing Amazon Web Services API requests in the Amazon Web Services General Reference. For general information about using the Query API with IAM, see Making query requests in the IAM User Guide.

" - } - }, - "shapes":{ - "AcceptDelegationRequestRequest":{ - "type":"structure", - "required":["DelegationRequestId"], - "members":{ - "DelegationRequestId":{ - "shape":"delegationRequestIdType", - "documentation":"

The unique identifier of the delegation request to accept.

" - } - } - }, - "AccessAdvisorUsageGranularityType":{ - "type":"string", - "enum":[ - "SERVICE_LEVEL", - "ACTION_LEVEL" - ] - }, - "AccessDetail":{ - "type":"structure", - "required":[ - "ServiceName", - "ServiceNamespace" - ], - "members":{ - "ServiceName":{ - "shape":"serviceNameType", - "documentation":"

The name of the service in which access was attempted.

" - }, - "ServiceNamespace":{ - "shape":"serviceNamespaceType", - "documentation":"

The namespace of the service in which access was attempted.

To learn the service namespace of a service, see Actions, resources, and condition keys for Amazon Web Services services in the Service Authorization Reference. Choose the name of the service to view details for that service. In the first paragraph, find the service prefix. For example, (service prefix: a4b). For more information about service namespaces, see Amazon Web Services service namespaces in the Amazon Web Services General Reference.

" - }, - "Region":{ - "shape":"stringType", - "documentation":"

The Region where the last service access attempt occurred.

This field is null if no principals in the reported Organizations entity attempted to access the service within the tracking period.

" - }, - "EntityPath":{ - "shape":"organizationsEntityPathType", - "documentation":"

The path of the Organizations entity (root, organizational unit, or account) from which an authenticated principal last attempted to access the service. Amazon Web Services does not report unauthenticated requests.

This field is null if no principals (IAM users, IAM roles, or root user) in the reported Organizations entity attempted to access the service within the tracking period.

" - }, - "LastAuthenticatedTime":{ - "shape":"dateType", - "documentation":"

The date and time, in ISO 8601 date-time format, when an authenticated principal most recently attempted to access the service. Amazon Web Services does not report unauthenticated requests.

This field is null if no principals in the reported Organizations entity attempted to access the service within the tracking period.

" - }, - "TotalAuthenticatedEntities":{ - "shape":"integerType", - "documentation":"

The number of accounts with authenticated principals (root user, IAM users, and IAM roles) that attempted to access the service in the tracking period.

" - } - }, - "documentation":"

An object that contains details about when a principal in the reported Organizations entity last attempted to access an Amazon Web Services service. A principal can be an IAM user, an IAM role, or the Amazon Web Services account root user within the reported Organizations entity.

This data type is a response element in the GetOrganizationsAccessReport operation.

" - }, - "AccessDetails":{ - "type":"list", - "member":{"shape":"AccessDetail"} - }, - "AccessKey":{ - "type":"structure", - "required":[ - "UserName", - "AccessKeyId", - "Status", - "SecretAccessKey" - ], - "members":{ - "UserName":{ - "shape":"userNameType", - "documentation":"

The name of the IAM user that the access key is associated with.

" - }, - "AccessKeyId":{ - "shape":"accessKeyIdType", - "documentation":"

The ID for this access key.

" - }, - "Status":{ - "shape":"statusType", - "documentation":"

The status of the access key. Active means that the key is valid for API calls, while Inactive means it is not.

" - }, - "SecretAccessKey":{ - "shape":"accessKeySecretType", - "documentation":"

The secret key used to sign requests.

" - }, - "CreateDate":{ - "shape":"dateType", - "documentation":"

The date when the access key was created.

" - } - }, - "documentation":"

Contains information about an Amazon Web Services access key.

This data type is used as a response element in the CreateAccessKey and ListAccessKeys operations.

The SecretAccessKey value is returned only in response to CreateAccessKey. You can get a secret access key only when you first create an access key; you cannot recover the secret access key later. If you lose a secret access key, you must create a new access key.

" - }, - "AccessKeyLastUsed":{ - "type":"structure", - "required":[ - "ServiceName", - "Region" - ], - "members":{ - "LastUsedDate":{ - "shape":"dateType", - "documentation":"

The date and time, in ISO 8601 date-time format, when the access key was most recently used. This field is null in the following situations:

  • The user does not have an access key.

  • An access key exists but has not been used since IAM began tracking this information.

  • There is no sign-in data associated with the user.

" - }, - "ServiceName":{ - "shape":"stringType", - "documentation":"

The name of the Amazon Web Services service with which this access key was most recently used. The value of this field is \"N/A\" in the following situations:

  • The user does not have an access key.

  • An access key exists but has not been used since IAM started tracking this information.

  • There is no sign-in data associated with the user.

" - }, - "Region":{ - "shape":"stringType", - "documentation":"

The Amazon Web Services Region where this access key was most recently used. The value for this field is \"N/A\" in the following situations:

  • The user does not have an access key.

  • An access key exists but has not been used since IAM began tracking this information.

  • There is no sign-in data associated with the user.

For more information about Amazon Web Services Regions, see Regions and endpoints in the Amazon Web Services General Reference.

" - } - }, - "documentation":"

Contains information about the last time an Amazon Web Services access key was used since IAM began tracking this information on April 22, 2015.

This data type is used as a response element in the GetAccessKeyLastUsed operation.

" - }, - "AccessKeyMetadata":{ - "type":"structure", - "members":{ - "UserName":{ - "shape":"userNameType", - "documentation":"

The name of the IAM user that the key is associated with.

" - }, - "AccessKeyId":{ - "shape":"accessKeyIdType", - "documentation":"

The ID for this access key.

" - }, - "Status":{ - "shape":"statusType", - "documentation":"

The status of the access key. Active means that the key is valid for API calls; Inactive means it is not.

" - }, - "CreateDate":{ - "shape":"dateType", - "documentation":"

The date when the access key was created.

" - } - }, - "documentation":"

Contains information about an Amazon Web Services access key, without its secret key.

This data type is used as a response element in the ListAccessKeys operation.

" - }, - "AccountNotManagementOrDelegatedAdministratorException":{ - "type":"structure", - "members":{}, - "documentation":"

The request was rejected because the account making the request is not the management account or delegated administrator account for centralized root access.

", - "exception":true - }, - "ActionNameListType":{ - "type":"list", - "member":{"shape":"ActionNameType"} - }, - "ActionNameType":{ - "type":"string", - "max":128, - "min":3 - }, - "AddClientIDToOpenIDConnectProviderRequest":{ - "type":"structure", - "required":[ - "OpenIDConnectProviderArn", - "ClientID" - ], - "members":{ - "OpenIDConnectProviderArn":{ - "shape":"arnType", - "documentation":"

The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider resource to add the client ID to. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders operation.

" - }, - "ClientID":{ - "shape":"clientIDType", - "documentation":"

The client ID (also known as audience) to add to the IAM OpenID Connect provider resource.

" - } - } - }, - "AddRoleToInstanceProfileRequest":{ - "type":"structure", - "required":[ - "InstanceProfileName", - "RoleName" - ], - "members":{ - "InstanceProfileName":{ - "shape":"instanceProfileNameType", - "documentation":"

The name of the instance profile to update.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "RoleName":{ - "shape":"roleNameType", - "documentation":"

The name of the role to add.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - } - } - }, - "AddUserToGroupRequest":{ - "type":"structure", - "required":[ - "GroupName", - "UserName" - ], - "members":{ - "GroupName":{ - "shape":"groupNameType", - "documentation":"

The name of the group to update.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "UserName":{ - "shape":"existingUserNameType", - "documentation":"

The name of the user to add.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - } - } - }, - "ArnListType":{ - "type":"list", - "member":{"shape":"arnType"} - }, - "AssociateDelegationRequestRequest":{ - "type":"structure", - "required":["DelegationRequestId"], - "members":{ - "DelegationRequestId":{ - "shape":"delegationRequestIdType", - "documentation":"

The unique identifier of the delegation request to associate.

" - } - } - }, - "AttachGroupPolicyRequest":{ - "type":"structure", - "required":[ - "GroupName", - "PolicyArn" - ], - "members":{ - "GroupName":{ - "shape":"groupNameType", - "documentation":"

The name (friendly name, not ARN) of the group to attach the policy to.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "PolicyArn":{ - "shape":"arnType", - "documentation":"

The Amazon Resource Name (ARN) of the IAM policy you want to attach.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

" - } - } - }, - "AttachRolePolicyRequest":{ - "type":"structure", - "required":[ - "RoleName", - "PolicyArn" - ], - "members":{ - "RoleName":{ - "shape":"roleNameType", - "documentation":"

The name (friendly name, not ARN) of the role to attach the policy to.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "PolicyArn":{ - "shape":"arnType", - "documentation":"

The Amazon Resource Name (ARN) of the IAM policy you want to attach.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

" - } - } - }, - "AttachUserPolicyRequest":{ - "type":"structure", - "required":[ - "UserName", - "PolicyArn" - ], - "members":{ - "UserName":{ - "shape":"userNameType", - "documentation":"

The name (friendly name, not ARN) of the IAM user to attach the policy to.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "PolicyArn":{ - "shape":"arnType", - "documentation":"

The Amazon Resource Name (ARN) of the IAM policy you want to attach.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

" - } - } - }, - "AttachedPermissionsBoundary":{ - "type":"structure", - "members":{ - "PermissionsBoundaryType":{ - "shape":"PermissionsBoundaryAttachmentType", - "documentation":"

The permissions boundary usage type that indicates what type of IAM resource is used as the permissions boundary for an entity. This data type can only have a value of Policy.

" - }, - "PermissionsBoundaryArn":{ - "shape":"arnType", - "documentation":"

The ARN of the policy used to set the permissions boundary for the user or role.

" - } - }, - "documentation":"

Contains information about an attached permissions boundary.

An attached permissions boundary is a managed policy that has been attached to a user or role to set the permissions boundary.

For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.

" - }, - "AttachedPolicy":{ - "type":"structure", - "members":{ - "PolicyName":{ - "shape":"policyNameType", - "documentation":"

The friendly name of the attached policy.

" - }, - "PolicyArn":{"shape":"arnType"} - }, - "documentation":"

Contains information about an attached policy.

An attached policy is a managed policy that has been attached to a user, group, or role. This data type is used as a response element in the ListAttachedGroupPolicies, ListAttachedRolePolicies, ListAttachedUserPolicies, and GetAccountAuthorizationDetails operations.

For more information about managed policies, refer to Managed policies and inline policies in the IAM User Guide.

" - }, - "AttachmentName":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[\\w+=,.@-]+" - }, - "AttachmentType":{ - "type":"string", - "enum":[ - "user", - "group", - "role" - ] - }, - "BootstrapDatum":{ - "type":"blob", - "sensitive":true - }, - "CallerIsNotManagementAccountException":{ - "type":"structure", - "members":{}, - "documentation":"

The request was rejected because the account making the request is not the management account for the organization.

", - "exception":true - }, - "CertificationKeyType":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[\\u0020-\\u00FF]+" - }, - "CertificationMapType":{ - "type":"map", - "key":{"shape":"CertificationKeyType"}, - "value":{"shape":"CertificationValueType"} - }, - "CertificationValueType":{ - "type":"string", - "max":32, - "min":1, - "pattern":"[\\u0020-\\u00FF]+" - }, - "ChangePasswordRequest":{ - "type":"structure", - "required":[ - "OldPassword", - "NewPassword" - ], - "members":{ - "OldPassword":{ - "shape":"passwordType", - "documentation":"

The IAM user's current password.

" - }, - "NewPassword":{ - "shape":"passwordType", - "documentation":"

The new password. The new password must conform to the Amazon Web Services account's password policy, if one exists.

The regex pattern that is used to validate this parameter is a string of characters. That string can include almost any printable ASCII character from the space (\\u0020) through the end of the ASCII character range (\\u00FF). You can also include the tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D) characters. Any of these characters are valid in a password. However, many tools, such as the Amazon Web Services Management Console, might restrict the ability to type certain characters because they have special meaning within that tool.

" - } - } - }, - "ColumnNumber":{"type":"integer"}, - "ConcurrentModificationException":{ - "type":"structure", - "members":{ - "message":{"shape":"ConcurrentModificationMessage"} - }, - "documentation":"

The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.

", - "error":{ - "code":"ConcurrentModification", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true - }, - "ConcurrentModificationMessage":{"type":"string"}, - "ContextEntry":{ - "type":"structure", - "members":{ - "ContextKeyName":{ - "shape":"ContextKeyNameType", - "documentation":"

The full name of a condition context key, including the service prefix. For example, aws:SourceIp or s3:VersionId.

" - }, - "ContextKeyValues":{ - "shape":"ContextKeyValueListType", - "documentation":"

The value (or values, if the condition context key supports multiple values) to provide to the simulation when the key is referenced by a Condition element in an input policy.

" - }, - "ContextKeyType":{ - "shape":"ContextKeyTypeEnum", - "documentation":"

The data type of the value (or values) specified in the ContextKeyValues parameter.

" - } - }, - "documentation":"

Contains information about a condition context key. It includes the name of the key and specifies the value (or values, if the context key supports multiple values) to use in the simulation. This information is used when evaluating the Condition elements of the input policies.

This data type is used as an input parameter to SimulateCustomPolicy and SimulatePrincipalPolicy.

" - }, - "ContextEntryListType":{ - "type":"list", - "member":{"shape":"ContextEntry"} - }, - "ContextKeyNameType":{ - "type":"string", - "max":256, - "min":5 - }, - "ContextKeyNamesResultListType":{ - "type":"list", - "member":{"shape":"ContextKeyNameType"} - }, - "ContextKeyTypeEnum":{ - "type":"string", - "enum":[ - "string", - "stringList", - "numeric", - "numericList", - "boolean", - "booleanList", - "ip", - "ipList", - "binary", - "binaryList", - "date", - "dateList" - ] - }, - "ContextKeyValueListType":{ - "type":"list", - "member":{"shape":"ContextKeyValueType"} - }, - "ContextKeyValueType":{"type":"string"}, - "CreateAccessKeyRequest":{ - "type":"structure", - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"

The name of the IAM user that the new key will belong to.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - } - } - }, - "CreateAccessKeyResponse":{ - "type":"structure", - "required":["AccessKey"], - "members":{ - "AccessKey":{ - "shape":"AccessKey", - "documentation":"

A structure with details about the access key.

" - } - }, - "documentation":"

Contains the response to a successful CreateAccessKey request.

" - }, - "CreateAccountAliasRequest":{ - "type":"structure", - "required":["AccountAlias"], - "members":{ - "AccountAlias":{ - "shape":"accountAliasType", - "documentation":"

The account alias to create.

This parameter allows (through its regex pattern) a string of characters consisting of lowercase letters, digits, and dashes. You cannot start or finish with a dash, nor can you have two dashes in a row.

" - } - } - }, - "CreateDelegationRequestRequest":{ - "type":"structure", - "required":[ - "Description", - "Permissions", - "RequestorWorkflowId", - "NotificationChannel", - "SessionDuration" - ], - "members":{ - "OwnerAccountId":{ - "shape":"accountIdType", - "documentation":"

The Amazon Web Services account ID this delegation request is targeted to.

If the account ID is not known, this parameter can be omitted, resulting in a request that can be associated by any account. If the account ID passed, then the created delegation request can only be associated with an identity of that target account.

" - }, - "Description":{ - "shape":"delegationRequestDescriptionType", - "documentation":"

A description of the delegation request.

" - }, - "Permissions":{ - "shape":"DelegationPermission", - "documentation":"

The permissions to be delegated in this delegation request.

" - }, - "RequestMessage":{ - "shape":"requestMessageType", - "documentation":"

A message explaining the reason for the delegation request.

Requesters can utilize this field to add a custom note to the delegation request. This field is different from the description such that this is to be utilized for a custom messaging on a case-by-case basis.

For example, if the current delegation request is in response to a previous request being rejected, this explanation can be added to the request via this field.

" - }, - "RequestorWorkflowId":{ - "shape":"requestorWorkflowIdType", - "documentation":"

The workflow ID associated with the requestor.

This is the unique identifier on the partner side that can be used to track the progress of the request.

IAM maintains a uniqueness check on this workflow id for each request - if a workflow id for an existing request is passed, this API call will fail.

" - }, - "RedirectUrl":{ - "shape":"redirectUrlType", - "documentation":"

The URL to redirect to after the delegation request is processed.

This URL is used by the IAM console to show a link to the customer to re-load the partner workflow.

" - }, - "NotificationChannel":{ - "shape":"notificationChannelType", - "documentation":"

The notification channel for updates about the delegation request.

At this time,only SNS topic ARNs are accepted for notification. This topic ARN must have a resource policy granting SNS:Publish permission to the IAM service principal (iam.amazonaws.com). See partner onboarding documentation for more details.

" - }, - "SessionDuration":{ - "shape":"sessionDurationType", - "documentation":"

The duration for which the delegated session should remain active, in seconds.

The active time window for the session starts when the customer calls the SendDelegationToken API.

" - }, - "OnlySendByOwner":{ - "shape":"booleanType", - "documentation":"

Specifies whether the delegation token should only be sent by the owner.

This flag prevents any party other than the owner from calling SendDelegationToken API for this delegation request. This behavior becomes useful when the delegation request owner needs to be present for subsequent partner interactions, but the delegation request was sent to a more privileged user for approval due to the owner lacking sufficient delegation permissions.

" - } - } - }, - "CreateDelegationRequestResponse":{ - "type":"structure", - "members":{ - "ConsoleDeepLink":{ - "shape":"consoleDeepLinkType", - "documentation":"

A deep link URL to the Amazon Web Services Management Console for managing the delegation request.

For a console based workflow, partners should redirect the customer to this URL. If the customer is not logged in to any Amazon Web Services account, the Amazon Web Services workflow will automatically direct the customer to log in and then display the delegation request approval page.

" - }, - "DelegationRequestId":{ - "shape":"delegationRequestIdType", - "documentation":"

The unique identifier for the created delegation request.

" - } - } - }, - "CreateGroupRequest":{ - "type":"structure", - "required":["GroupName"], - "members":{ - "Path":{ - "shape":"pathType", - "documentation":"

The path to the group. For more information about paths, see IAM identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" - }, - "GroupName":{ - "shape":"groupNameType", - "documentation":"

The name of the group to create. Do not include the path in this value.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both \"MyResource\" and \"myresource\".

" - } - } - }, - "CreateGroupResponse":{ - "type":"structure", - "required":["Group"], - "members":{ - "Group":{ - "shape":"Group", - "documentation":"

A structure containing details about the new group.

" - } - }, - "documentation":"

Contains the response to a successful CreateGroup request.

" - }, - "CreateInstanceProfileRequest":{ - "type":"structure", - "required":["InstanceProfileName"], - "members":{ - "InstanceProfileName":{ - "shape":"instanceProfileNameType", - "documentation":"

The name of the instance profile to create.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "Path":{ - "shape":"pathType", - "documentation":"

The path to the instance profile. For more information about paths, see IAM Identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" - }, - "Tags":{ - "shape":"tagListType", - "documentation":"

A list of tags that you want to attach to the newly created IAM instance profile. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

" - } - } - }, - "CreateInstanceProfileResponse":{ - "type":"structure", - "required":["InstanceProfile"], - "members":{ - "InstanceProfile":{ - "shape":"InstanceProfile", - "documentation":"

A structure containing details about the new instance profile.

" - } - }, - "documentation":"

Contains the response to a successful CreateInstanceProfile request.

" - }, - "CreateLoginProfileRequest":{ - "type":"structure", - "members":{ - "UserName":{ - "shape":"userNameType", - "documentation":"

The name of the IAM user to create a password for. The user must already exist.

This parameter is optional. If no user name is included, it defaults to the principal making the request. When you make this request with root user credentials, you must use an AssumeRoot session to omit the user name.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "Password":{ - "shape":"passwordType", - "documentation":"

The new password for the user.

This parameter must be omitted when you make the request with an AssumeRoot session. It is required in all other cases.

The regex pattern that is used to validate this parameter is a string of characters. That string can include almost any printable ASCII character from the space (\\u0020) through the end of the ASCII character range (\\u00FF). You can also include the tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D) characters. Any of these characters are valid in a password. However, many tools, such as the Amazon Web Services Management Console, might restrict the ability to type certain characters because they have special meaning within that tool.

" - }, - "PasswordResetRequired":{ - "shape":"booleanType", - "documentation":"

Specifies whether the user is required to set a new password on next sign-in.

" - } - } - }, - "CreateLoginProfileResponse":{ - "type":"structure", - "required":["LoginProfile"], - "members":{ - "LoginProfile":{ - "shape":"LoginProfile", - "documentation":"

A structure containing the user name and password create date.

" - } - }, - "documentation":"

Contains the response to a successful CreateLoginProfile request.

" - }, - "CreateOpenIDConnectProviderRequest":{ - "type":"structure", - "required":["Url"], - "members":{ - "Url":{ - "shape":"OpenIDConnectProviderUrlType", - "documentation":"

The URL of the identity provider. The URL must begin with https:// and should correspond to the iss claim in the provider's OpenID Connect ID tokens. Per the OIDC standard, path components are allowed but query parameters are not. Typically the URL consists of only a hostname, like https://server.example.org or https://example.com. The URL should not contain a port number.

You cannot register the same provider multiple times in a single Amazon Web Services account. If you try to submit a URL that has already been used for an OpenID Connect provider in the Amazon Web Services account, you will get an error.

" - }, - "ClientIDList":{ - "shape":"clientIDListType", - "documentation":"

Provides a list of client IDs, also known as audiences. When a mobile or web app registers with an OpenID Connect provider, they establish a value that identifies the application. This is the value that's sent as the client_id parameter on OAuth requests.

You can register multiple client IDs with the same provider. For example, you might have multiple applications that use the same OIDC provider. You cannot register more than 100 client IDs with a single IAM OIDC provider.

There is no defined format for a client ID. The CreateOpenIDConnectProviderRequest operation accepts client IDs up to 255 characters long.

" - }, - "ThumbprintList":{ - "shape":"thumbprintListType", - "documentation":"

A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificates. Typically this list includes only one entry. However, IAM lets you have up to five thumbprints for an OIDC provider. This lets you maintain multiple thumbprints if the identity provider is rotating certificates.

This parameter is optional. If it is not included, IAM will retrieve and use the top intermediate certificate authority (CA) thumbprint of the OpenID Connect identity provider server certificate.

The server certificate thumbprint is the hex-encoded SHA-1 hash value of the X.509 certificate used by the domain where the OpenID Connect provider makes its keys available. It is always a 40-character string.

For example, assume that the OIDC provider is server.example.com and the provider stores its keys at https://keys.server.example.com/openid-connect. In that case, the thumbprint string would be the hex-encoded SHA-1 hash value of the certificate used by https://keys.server.example.com.

For more information about obtaining the OIDC provider thumbprint, see Obtaining the thumbprint for an OpenID Connect provider in the IAM user Guide.

If your OIDC provider's discovery endpoint and JWKS endpoint (jwks_uri) use different certificates or hosts, include the thumbprints for both endpoints in this list.

" - }, - "Tags":{ - "shape":"tagListType", - "documentation":"

A list of tags that you want to attach to the new IAM OpenID Connect (OIDC) provider. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

" - } - } - }, - "CreateOpenIDConnectProviderResponse":{ - "type":"structure", - "members":{ - "OpenIDConnectProviderArn":{ - "shape":"arnType", - "documentation":"

The Amazon Resource Name (ARN) of the new IAM OpenID Connect provider that is created. For more information, see OpenIDConnectProviderListEntry.

" - }, - "Tags":{ - "shape":"tagListType", - "documentation":"

A list of tags that are attached to the new IAM OIDC provider. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

" - } - }, - "documentation":"

Contains the response to a successful CreateOpenIDConnectProvider request.

" - }, - "CreatePolicyRequest":{ - "type":"structure", - "required":[ - "PolicyName", - "PolicyDocument" - ], - "members":{ - "PolicyName":{ - "shape":"policyNameType", - "documentation":"

The friendly name of the policy.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both \"MyResource\" and \"myresource\".

" - }, - "Path":{ - "shape":"policyPathType", - "documentation":"

The path for the policy.

For more information about paths, see IAM identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

You cannot use an asterisk (*) in the path name.

" - }, - "PolicyDocument":{ - "shape":"policyDocumentType", - "documentation":"

The JSON policy document that you want to use as the content for the new policy.

You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

To learn more about JSON policy grammar, see Grammar of the IAM JSON policy language in the IAM User Guide.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" - }, - "Description":{ - "shape":"policyDescriptionType", - "documentation":"

A friendly description of the policy.

Typically used to store information about the permissions defined in the policy. For example, \"Grants access to production DynamoDB tables.\"

The policy description is immutable. After a value is assigned, it cannot be changed.

" - }, - "Tags":{ - "shape":"tagListType", - "documentation":"

A list of tags that you want to attach to the new IAM customer managed policy. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

" - } - } - }, - "CreatePolicyResponse":{ - "type":"structure", - "members":{ - "Policy":{ - "shape":"Policy", - "documentation":"

A structure containing details about the new policy.

" - } - }, - "documentation":"

Contains the response to a successful CreatePolicy request.

" - }, - "CreatePolicyVersionRequest":{ - "type":"structure", - "required":[ - "PolicyArn", - "PolicyDocument" - ], - "members":{ - "PolicyArn":{ - "shape":"arnType", - "documentation":"

The Amazon Resource Name (ARN) of the IAM policy to which you want to add a new version.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

" - }, - "PolicyDocument":{ - "shape":"policyDocumentType", - "documentation":"

The JSON policy document that you want to use as the content for this new version of the policy.

You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" - }, - "SetAsDefault":{ - "shape":"booleanType", - "documentation":"

Specifies whether to set this version as the policy's default version.

When this parameter is true, the new policy version becomes the operative version. That is, it becomes the version that is in effect for the IAM users, groups, and roles that the policy is attached to.

For more information about managed policy versions, see Versioning for managed policies in the IAM User Guide.

" - } - } - }, - "CreatePolicyVersionResponse":{ - "type":"structure", - "members":{ - "PolicyVersion":{ - "shape":"PolicyVersion", - "documentation":"

A structure containing details about the new policy version.

" - } - }, - "documentation":"

Contains the response to a successful CreatePolicyVersion request.

" - }, - "CreateRoleRequest":{ - "type":"structure", - "required":[ - "RoleName", - "AssumeRolePolicyDocument" - ], - "members":{ - "Path":{ - "shape":"pathType", - "documentation":"

The path to the role. For more information about paths, see IAM Identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" - }, - "RoleName":{ - "shape":"roleNameType", - "documentation":"

The name of the role to create.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both \"MyResource\" and \"myresource\".

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "AssumeRolePolicyDocument":{ - "shape":"policyDocumentType", - "documentation":"

The trust relationship policy document that grants an entity permission to assume the role.

In IAM, you must provide a JSON policy that has been converted to a string. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

Upon success, the response includes the same trust policy in JSON format.

" - }, - "Description":{ - "shape":"roleDescriptionType", - "documentation":"

A description of the role.

" - }, - "MaxSessionDuration":{ - "shape":"roleMaxSessionDurationType", - "documentation":"

The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours.

Anyone who assumes the role from the CLI or API can use the DurationSeconds API parameter or the duration-seconds CLI parameter to request a longer session. The MaxSessionDuration setting determines the maximum duration that can be requested using the DurationSeconds parameter. If users don't specify a value for the DurationSeconds parameter, their security credentials are valid for one hour by default. This applies when you use the AssumeRole* API operations or the assume-role* CLI operations but does not apply when you use those operations to create a console URL. For more information, see Using IAM roles in the IAM User Guide.

" - }, - "PermissionsBoundary":{ - "shape":"arnType", - "documentation":"

The ARN of the managed policy that is used to set the permissions boundary for the role.

A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see Permissions boundaries for IAM entities in the IAM User Guide.

For more information about policy types, see Policy types in the IAM User Guide.

" - }, - "Tags":{ - "shape":"tagListType", - "documentation":"

A list of tags that you want to attach to the new role. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

" - } - } - }, - "CreateRoleResponse":{ - "type":"structure", - "required":["Role"], - "members":{ - "Role":{ - "shape":"Role", - "documentation":"

A structure containing details about the new role.

" - } - }, - "documentation":"

Contains the response to a successful CreateRole request.

" - }, - "CreateSAMLProviderRequest":{ - "type":"structure", - "required":[ - "SAMLMetadataDocument", - "Name" - ], - "members":{ - "SAMLMetadataDocument":{ - "shape":"SAMLMetadataDocumentType", - "documentation":"

An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.

For more information, see About SAML 2.0-based federation in the IAM User Guide

" - }, - "Name":{ - "shape":"SAMLProviderNameType", - "documentation":"

The name of the provider to create.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "Tags":{ - "shape":"tagListType", - "documentation":"

A list of tags that you want to attach to the new IAM SAML provider. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

" - }, - "AssertionEncryptionMode":{ - "shape":"assertionEncryptionModeType", - "documentation":"

Specifies the encryption setting for the SAML provider.

" - }, - "AddPrivateKey":{ - "shape":"privateKeyType", - "documentation":"

The private key generated from your external identity provider. The private key must be a .pem file that uses AES-GCM or AES-CBC encryption algorithm to decrypt SAML assertions.

" - } - } - }, - "CreateSAMLProviderResponse":{ - "type":"structure", - "members":{ - "SAMLProviderArn":{ - "shape":"arnType", - "documentation":"

The Amazon Resource Name (ARN) of the new SAML provider resource in IAM.

" - }, - "Tags":{ - "shape":"tagListType", - "documentation":"

A list of tags that are attached to the new IAM SAML provider. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

" - } - }, - "documentation":"

Contains the response to a successful CreateSAMLProvider request.

" - }, - "CreateServiceLinkedRoleRequest":{ - "type":"structure", - "required":["AWSServiceName"], - "members":{ - "AWSServiceName":{ - "shape":"groupNameType", - "documentation":"

The service principal for the Amazon Web Services service to which this role is attached. You use a string similar to a URL but without the http:// in front. For example: elasticbeanstalk.amazonaws.com.

Service principals are unique and case-sensitive. To find the exact service principal for your service-linked role, see Amazon Web Services services that work with IAM in the IAM User Guide. Look for the services that have Yes in the Service-Linked Role column. Choose the Yes link to view the service-linked role documentation for that service.

" - }, - "Description":{ - "shape":"roleDescriptionType", - "documentation":"

The description of the role.

" - }, - "CustomSuffix":{ - "shape":"customSuffixType", - "documentation":"

A string that you provide, which is combined with the service-provided prefix to form the complete role name. If you make multiple requests for the same service, then you must supply a different CustomSuffix for each request. Otherwise the request fails with a duplicate role name error. For example, you could add -1 or -debug to the suffix.

Some services do not support the CustomSuffix parameter. If you provide an optional suffix and the operation fails, try the operation again without the suffix.

" - } - } - }, - "CreateServiceLinkedRoleResponse":{ - "type":"structure", - "members":{ - "Role":{ - "shape":"Role", - "documentation":"

A Role object that contains details about the newly created role.

" - } - } - }, - "CreateServiceSpecificCredentialRequest":{ - "type":"structure", - "required":[ - "UserName", - "ServiceName" - ], - "members":{ - "UserName":{ - "shape":"userNameType", - "documentation":"

The name of the IAM user that is to be associated with the credentials. The new service-specific credentials have the same permissions as the associated user except that they can be used only to access the specified service.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "ServiceName":{ - "shape":"serviceName", - "documentation":"

The name of the Amazon Web Services service that is to be associated with the credentials. The service you specify here is the only service that can be accessed using these credentials.

" - }, - "CredentialAgeDays":{ - "shape":"credentialAgeDays", - "documentation":"

The number of days until the service specific credential expires. This field is only valid for services that support long-term API keys and must be a positive integer. When not specified, the credential will not expire.

To see which services support long-term API keys, refer to API keys for Amazon Web Services services in the IAM User Guide.

" - } - } - }, - "CreateServiceSpecificCredentialResponse":{ - "type":"structure", - "members":{ - "ServiceSpecificCredential":{ - "shape":"ServiceSpecificCredential", - "documentation":"

A structure that contains information about the newly created service-specific credential.

This is the only time that the password for this credential set is available. It cannot be recovered later. Instead, you must reset the password with ResetServiceSpecificCredential.

" - } - } - }, - "CreateUserRequest":{ - "type":"structure", - "required":["UserName"], - "members":{ - "Path":{ - "shape":"pathType", - "documentation":"

The path for the user name. For more information about paths, see IAM identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" - }, - "UserName":{ - "shape":"userNameType", - "documentation":"

The name of the user to create.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both \"MyResource\" and \"myresource\".

" - }, - "PermissionsBoundary":{ - "shape":"arnType", - "documentation":"

The ARN of the managed policy that is used to set the permissions boundary for the user.

A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see Permissions boundaries for IAM entities in the IAM User Guide.

For more information about policy types, see Policy types in the IAM User Guide.

" - }, - "Tags":{ - "shape":"tagListType", - "documentation":"

A list of tags that you want to attach to the new user. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

" - } - } - }, - "CreateUserResponse":{ - "type":"structure", - "members":{ - "User":{ - "shape":"User", - "documentation":"

A structure with details about the new IAM user.

" - } - }, - "documentation":"

Contains the response to a successful CreateUser request.

" - }, - "CreateVirtualMFADeviceRequest":{ - "type":"structure", - "required":["VirtualMFADeviceName"], - "members":{ - "Path":{ - "shape":"pathType", - "documentation":"

The path for the virtual MFA device. For more information about paths, see IAM identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" - }, - "VirtualMFADeviceName":{ - "shape":"virtualMFADeviceName", - "documentation":"

The name of the virtual MFA device, which must be unique. Use with path to uniquely identify a virtual MFA device.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "Tags":{ - "shape":"tagListType", - "documentation":"

A list of tags that you want to attach to the new IAM virtual MFA device. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

" - } - } - }, - "CreateVirtualMFADeviceResponse":{ - "type":"structure", - "required":["VirtualMFADevice"], - "members":{ - "VirtualMFADevice":{ - "shape":"VirtualMFADevice", - "documentation":"

A structure containing details about the new virtual MFA device.

" - } - }, - "documentation":"

Contains the response to a successful CreateVirtualMFADevice request.

" - }, - "CredentialReportExpiredException":{ - "type":"structure", - "members":{ - "message":{"shape":"credentialReportExpiredExceptionMessage"} - }, - "documentation":"

The request was rejected because the most recent credential report has expired. To generate a new credential report, use GenerateCredentialReport. For more information about credential report expiration, see Getting credential reports in the IAM User Guide.

", - "error":{ - "code":"ReportExpired", - "httpStatusCode":410, - "senderFault":true - }, - "exception":true - }, - "CredentialReportNotPresentException":{ - "type":"structure", - "members":{ - "message":{"shape":"credentialReportNotPresentExceptionMessage"} - }, - "documentation":"

The request was rejected because the credential report does not exist. To generate a credential report, use GenerateCredentialReport.

", - "error":{ - "code":"ReportNotPresent", - "httpStatusCode":410, - "senderFault":true - }, - "exception":true - }, - "CredentialReportNotReadyException":{ - "type":"structure", - "members":{ - "message":{"shape":"credentialReportNotReadyExceptionMessage"} - }, - "documentation":"

The request was rejected because the credential report is still being generated.

", - "error":{ - "code":"ReportInProgress", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true - }, - "DeactivateMFADeviceRequest":{ - "type":"structure", - "required":["SerialNumber"], - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"

The name of the user whose MFA device you want to deactivate.

This parameter is optional. If no user name is included, it defaults to the principal making the request. When you make this request with root user credentials, you must use an AssumeRoot session to omit the user name.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "SerialNumber":{ - "shape":"serialNumberType", - "documentation":"

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@:/-

" - } - } - }, - "DelegationPermission":{ - "type":"structure", - "members":{ - "PolicyTemplateArn":{ - "shape":"arnType", - "documentation":"

This ARN maps to a pre-registered policy content for this partner. See the partner onboarding documentation to understand how to create a delegation template.

" - }, - "Parameters":{ - "shape":"policyParameterListType", - "documentation":"

A list of policy parameters that define the scope and constraints of the delegated permissions.

" - } - }, - "documentation":"

Contains information about the permissions being delegated in a delegation request.

" - }, - "DelegationRequest":{ - "type":"structure", - "members":{ - "DelegationRequestId":{ - "shape":"delegationRequestIdType", - "documentation":"

The unique identifier for the delegation request.

" - }, - "OwnerAccountId":{ - "shape":"accountIdType", - "documentation":"

Amazon Web Services account ID of the owner of the delegation request.

" - }, - "Description":{ - "shape":"delegationRequestDescriptionType", - "documentation":"

Description of the delegation request. This is a message that is provided by the Amazon Web Services partner that filed the delegation request.

" - }, - "RequestMessage":{ - "shape":"requestMessageType", - "documentation":"

A custom message that is added to the delegation request by the partner.

This element is different from the Description element such that this is a request specific message injected by the partner. The Description is typically a generic explanation of what the delegation request is targeted to do.

" - }, - "Permissions":{"shape":"DelegationPermission"}, - "PermissionPolicy":{ - "shape":"permissionType", - "documentation":"

JSON content of the associated permission policy of this delegation request.

" - }, - "RolePermissionRestrictionArns":{ - "shape":"rolePermissionRestrictionArnListType", - "documentation":"

If the PermissionPolicy includes role creation permissions, this element will include the list of permissions boundary policies associated with the role creation. See Permissions boundaries for IAM entities for more details about IAM permission boundaries.

" - }, - "OwnerId":{ - "shape":"ownerIdType", - "documentation":"

ARN of the owner of this delegation request.

" - }, - "ApproverId":{"shape":"arnType"}, - "State":{ - "shape":"stateType", - "documentation":"

The state of this delegation request.

See the Understanding the Request Lifecycle for an explanation of how these states are transitioned.

" - }, - "ExpirationTime":{ - "shape":"dateType", - "documentation":"

The expiry time of this delegation request

See the Understanding the Request Lifecycle for details on the life time of a delegation request at each state.

" - }, - "RequestorId":{ - "shape":"accountIdType", - "documentation":"

Identity of the requestor of this delegation request. This will be an Amazon Web Services account ID.

" - }, - "RequestorName":{ - "shape":"requestorNameType", - "documentation":"

A friendly name of the requestor.

" - }, - "CreateDate":{ - "shape":"dateType", - "documentation":"

Creation date (timestamp) of this delegation request.

" - }, - "SessionDuration":{ - "shape":"sessionDurationType", - "documentation":"

The life-time of the requested session credential.

" - }, - "RedirectUrl":{ - "shape":"redirectUrlType", - "documentation":"

A URL to be redirected to once the delegation request is approved. Partners provide this URL when creating the delegation request.

" - }, - "Notes":{ - "shape":"notesType", - "documentation":"

Notes added to this delegation request, if this request was updated via the UpdateDelegationRequest API.

" - }, - "RejectionReason":{ - "shape":"notesType", - "documentation":"

Reasons for rejecting this delegation request, if this request was rejected. See also RejectDelegationRequest API documentation.

" - }, - "OnlySendByOwner":{ - "shape":"booleanType", - "documentation":"

A flag indicating whether the SendDelegationToken must be called by the owner of this delegation request. This is set by the requesting partner.

" - }, - "UpdatedTime":{ - "shape":"dateType", - "documentation":"

Last updated timestamp of the request.

" - } - }, - "documentation":"

Contains information about a delegation request, including its status, permissions, and associated metadata.

" - }, - "DeleteAccessKeyRequest":{ - "type":"structure", - "required":["AccessKeyId"], - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"

The name of the user whose access key pair you want to delete.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "AccessKeyId":{ - "shape":"accessKeyIdType", - "documentation":"

The access key ID for the access key ID and secret access key you want to delete.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

" - } - } - }, - "DeleteAccountAliasRequest":{ - "type":"structure", - "required":["AccountAlias"], - "members":{ - "AccountAlias":{ - "shape":"accountAliasType", - "documentation":"

The name of the account alias to delete.

This parameter allows (through its regex pattern) a string of characters consisting of lowercase letters, digits, and dashes. You cannot start or finish with a dash, nor can you have two dashes in a row.

" - } - } - }, - "DeleteConflictException":{ - "type":"structure", - "members":{ - "message":{"shape":"deleteConflictMessage"} - }, - "documentation":"

The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities.

", - "error":{ - "code":"DeleteConflict", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true - }, - "DeleteGroupPolicyRequest":{ - "type":"structure", - "required":[ - "GroupName", - "PolicyName" - ], - "members":{ - "GroupName":{ - "shape":"groupNameType", - "documentation":"

The name (friendly name, not ARN) identifying the group that the policy is embedded in.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "PolicyName":{ - "shape":"policyNameType", - "documentation":"

The name identifying the policy document to delete.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - } - } - }, - "DeleteGroupRequest":{ - "type":"structure", - "required":["GroupName"], - "members":{ - "GroupName":{ - "shape":"groupNameType", - "documentation":"

The name of the IAM group to delete.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - } - } - }, - "DeleteInstanceProfileRequest":{ - "type":"structure", - "required":["InstanceProfileName"], - "members":{ - "InstanceProfileName":{ - "shape":"instanceProfileNameType", - "documentation":"

The name of the instance profile to delete.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - } - } - }, - "DeleteLoginProfileRequest":{ - "type":"structure", - "members":{ - "UserName":{ - "shape":"userNameType", - "documentation":"

The name of the user whose password you want to delete.

This parameter is optional. If no user name is included, it defaults to the principal making the request. When you make this request with root user credentials, you must use an AssumeRoot session to omit the user name.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - } - } - }, - "DeleteOpenIDConnectProviderRequest":{ - "type":"structure", - "required":["OpenIDConnectProviderArn"], - "members":{ - "OpenIDConnectProviderArn":{ - "shape":"arnType", - "documentation":"

The Amazon Resource Name (ARN) of the IAM OpenID Connect provider resource object to delete. You can get a list of OpenID Connect provider resource ARNs by using the ListOpenIDConnectProviders operation.

" - } - } - }, - "DeletePolicyRequest":{ - "type":"structure", - "required":["PolicyArn"], - "members":{ - "PolicyArn":{ - "shape":"arnType", - "documentation":"

The Amazon Resource Name (ARN) of the IAM policy you want to delete.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

" - } - } - }, - "DeletePolicyVersionRequest":{ - "type":"structure", - "required":[ - "PolicyArn", - "VersionId" - ], - "members":{ - "PolicyArn":{ - "shape":"arnType", - "documentation":"

The Amazon Resource Name (ARN) of the IAM policy from which you want to delete a version.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

" - }, - "VersionId":{ - "shape":"policyVersionIdType", - "documentation":"

The policy version to delete.

This parameter allows (through its regex pattern) a string of characters that consists of the lowercase letter 'v' followed by one or two digits, and optionally followed by a period '.' and a string of letters and digits.

For more information about managed policy versions, see Versioning for managed policies in the IAM User Guide.

" - } - } - }, - "DeleteRolePermissionsBoundaryRequest":{ - "type":"structure", - "required":["RoleName"], - "members":{ - "RoleName":{ - "shape":"roleNameType", - "documentation":"

The name (friendly name, not ARN) of the IAM role from which you want to remove the permissions boundary.

" - } - } - }, - "DeleteRolePolicyRequest":{ - "type":"structure", - "required":[ - "RoleName", - "PolicyName" - ], - "members":{ - "RoleName":{ - "shape":"roleNameType", - "documentation":"

The name (friendly name, not ARN) identifying the role that the policy is embedded in.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "PolicyName":{ - "shape":"policyNameType", - "documentation":"

The name of the inline policy to delete from the specified IAM role.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - } - } - }, - "DeleteRoleRequest":{ - "type":"structure", - "required":["RoleName"], - "members":{ - "RoleName":{ - "shape":"roleNameType", - "documentation":"

The name of the role to delete.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - } - } - }, - "DeleteSAMLProviderRequest":{ - "type":"structure", - "required":["SAMLProviderArn"], - "members":{ - "SAMLProviderArn":{ - "shape":"arnType", - "documentation":"

The Amazon Resource Name (ARN) of the SAML provider to delete.

" - } - } - }, - "DeleteSSHPublicKeyRequest":{ - "type":"structure", - "required":[ - "UserName", - "SSHPublicKeyId" - ], - "members":{ - "UserName":{ - "shape":"userNameType", - "documentation":"

The name of the IAM user associated with the SSH public key.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "SSHPublicKeyId":{ - "shape":"publicKeyIdType", - "documentation":"

The unique identifier for the SSH public key.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

" - } - } - }, - "DeleteServerCertificateRequest":{ - "type":"structure", - "required":["ServerCertificateName"], - "members":{ - "ServerCertificateName":{ - "shape":"serverCertificateNameType", - "documentation":"

The name of the server certificate you want to delete.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - } - } - }, - "DeleteServiceLinkedRoleRequest":{ - "type":"structure", - "required":["RoleName"], - "members":{ - "RoleName":{ - "shape":"roleNameType", - "documentation":"

The name of the service-linked role to be deleted.

" - } - } - }, - "DeleteServiceLinkedRoleResponse":{ - "type":"structure", - "required":["DeletionTaskId"], - "members":{ - "DeletionTaskId":{ - "shape":"DeletionTaskIdType", - "documentation":"

The deletion task identifier that you can use to check the status of the deletion. This identifier is returned in the format task/aws-service-role/<service-principal-name>/<role-name>/<task-uuid>.

" - } - } - }, - "DeleteServiceSpecificCredentialRequest":{ - "type":"structure", - "required":["ServiceSpecificCredentialId"], - "members":{ - "UserName":{ - "shape":"userNameType", - "documentation":"

The name of the IAM user associated with the service-specific credential. If this value is not specified, then the operation assumes the user whose credentials are used to call the operation.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "ServiceSpecificCredentialId":{ - "shape":"serviceSpecificCredentialId", - "documentation":"

The unique identifier of the service-specific credential. You can get this value by calling ListServiceSpecificCredentials.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

" - } - } - }, - "DeleteSigningCertificateRequest":{ - "type":"structure", - "required":["CertificateId"], - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"

The name of the user the signing certificate belongs to.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "CertificateId":{ - "shape":"certificateIdType", - "documentation":"

The ID of the signing certificate to delete.

The format of this parameter, as described by its regex pattern, is a string of characters that can be upper- or lower-cased letters or digits.

" - } - } - }, - "DeleteUserPermissionsBoundaryRequest":{ - "type":"structure", - "required":["UserName"], - "members":{ - "UserName":{ - "shape":"userNameType", - "documentation":"

The name (friendly name, not ARN) of the IAM user from which you want to remove the permissions boundary.

" - } - } - }, - "DeleteUserPolicyRequest":{ - "type":"structure", - "required":[ - "UserName", - "PolicyName" - ], - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"

The name (friendly name, not ARN) identifying the user that the policy is embedded in.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "PolicyName":{ - "shape":"policyNameType", - "documentation":"

The name identifying the policy document to delete.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - } - } - }, - "DeleteUserRequest":{ - "type":"structure", - "required":["UserName"], - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"

The name of the user to delete.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - } - } - }, - "DeleteVirtualMFADeviceRequest":{ - "type":"structure", - "required":["SerialNumber"], - "members":{ - "SerialNumber":{ - "shape":"serialNumberType", - "documentation":"

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the same as the ARN.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@:/-

" - } - } - }, - "DeletionTaskFailureReasonType":{ - "type":"structure", - "members":{ - "Reason":{ - "shape":"ReasonType", - "documentation":"

A short description of the reason that the service-linked role deletion failed.

" - }, - "RoleUsageList":{ - "shape":"RoleUsageListType", - "documentation":"

A list of objects that contains details about the service-linked role deletion failure, if that information is returned by the service. If the service-linked role has active sessions or if any resources that were used by the role have not been deleted from the linked service, the role can't be deleted. This parameter includes a list of the resources that are associated with the role and the Region in which the resources are being used.

" - } - }, - "documentation":"

The reason that the service-linked role deletion failed.

This data type is used as a response element in the GetServiceLinkedRoleDeletionStatus operation.

" - }, - "DeletionTaskIdType":{ - "type":"string", - "max":1000, - "min":1 - }, - "DeletionTaskStatusType":{ - "type":"string", - "enum":[ - "SUCCEEDED", - "IN_PROGRESS", - "FAILED", - "NOT_STARTED" - ] - }, - "DetachGroupPolicyRequest":{ - "type":"structure", - "required":[ - "GroupName", - "PolicyArn" - ], - "members":{ - "GroupName":{ - "shape":"groupNameType", - "documentation":"

The name (friendly name, not ARN) of the IAM group to detach the policy from.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "PolicyArn":{ - "shape":"arnType", - "documentation":"

The Amazon Resource Name (ARN) of the IAM policy you want to detach.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

" - } - } - }, - "DetachRolePolicyRequest":{ - "type":"structure", - "required":[ - "RoleName", - "PolicyArn" - ], - "members":{ - "RoleName":{ - "shape":"roleNameType", - "documentation":"

The name (friendly name, not ARN) of the IAM role to detach the policy from.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "PolicyArn":{ - "shape":"arnType", - "documentation":"

The Amazon Resource Name (ARN) of the IAM policy you want to detach.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

" - } - } - }, - "DetachUserPolicyRequest":{ - "type":"structure", - "required":[ - "UserName", - "PolicyArn" - ], - "members":{ - "UserName":{ - "shape":"userNameType", - "documentation":"

The name (friendly name, not ARN) of the IAM user to detach the policy from.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "PolicyArn":{ - "shape":"arnType", - "documentation":"

The Amazon Resource Name (ARN) of the IAM policy you want to detach.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

" - } - } - }, - "DisableOrganizationsRootCredentialsManagementRequest":{ - "type":"structure", - "members":{} - }, - "DisableOrganizationsRootCredentialsManagementResponse":{ - "type":"structure", - "members":{ - "OrganizationId":{ - "shape":"OrganizationIdType", - "documentation":"

The unique identifier (ID) of an organization.

" - }, - "EnabledFeatures":{ - "shape":"FeaturesListType", - "documentation":"

The features enabled for centralized root access for member accounts in your organization.

" - } - } - }, - "DisableOrganizationsRootSessionsRequest":{ - "type":"structure", - "members":{} - }, - "DisableOrganizationsRootSessionsResponse":{ - "type":"structure", - "members":{ - "OrganizationId":{ - "shape":"OrganizationIdType", - "documentation":"

The unique identifier (ID) of an organization.

" - }, - "EnabledFeatures":{ - "shape":"FeaturesListType", - "documentation":"

The features you have enabled for centralized root access of member accounts in your organization.

" - } - } - }, - "DuplicateCertificateException":{ - "type":"structure", - "members":{ - "message":{"shape":"duplicateCertificateMessage"} - }, - "documentation":"

The request was rejected because the same certificate is associated with an IAM user in the account.

", - "error":{ - "code":"DuplicateCertificate", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true - }, - "DuplicateSSHPublicKeyException":{ - "type":"structure", - "members":{ - "message":{"shape":"duplicateSSHPublicKeyMessage"} - }, - "documentation":"

The request was rejected because the SSH public key is already associated with the specified IAM user.

", - "error":{ - "code":"DuplicateSSHPublicKey", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "EnableMFADeviceRequest":{ - "type":"structure", - "required":[ - "UserName", - "SerialNumber", - "AuthenticationCode1", - "AuthenticationCode2" - ], - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"

The name of the IAM user for whom you want to enable the MFA device.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "SerialNumber":{ - "shape":"serialNumberType", - "documentation":"

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@:/-

" - }, - "AuthenticationCode1":{ - "shape":"authenticationCodeType", - "documentation":"

An authentication code emitted by the device.

The format for this parameter is a string of six digits.

Submit your request immediately after generating the authentication codes. If you generate the codes and then wait too long to submit the request, the MFA device successfully associates with the user but the MFA device becomes out of sync. This happens because time-based one-time passwords (TOTP) expire after a short period of time. If this happens, you can resync the device.

" - }, - "AuthenticationCode2":{ - "shape":"authenticationCodeType", - "documentation":"

A subsequent authentication code emitted by the device.

The format for this parameter is a string of six digits.

Submit your request immediately after generating the authentication codes. If you generate the codes and then wait too long to submit the request, the MFA device successfully associates with the user but the MFA device becomes out of sync. This happens because time-based one-time passwords (TOTP) expire after a short period of time. If this happens, you can resync the device.

" - } - } - }, - "EnableOrganizationsRootCredentialsManagementRequest":{ - "type":"structure", - "members":{} - }, - "EnableOrganizationsRootCredentialsManagementResponse":{ - "type":"structure", - "members":{ - "OrganizationId":{ - "shape":"OrganizationIdType", - "documentation":"

The unique identifier (ID) of an organization.

" - }, - "EnabledFeatures":{ - "shape":"FeaturesListType", - "documentation":"

The features you have enabled for centralized root access.

" - } - } - }, - "EnableOrganizationsRootSessionsRequest":{ - "type":"structure", - "members":{} - }, - "EnableOrganizationsRootSessionsResponse":{ - "type":"structure", - "members":{ - "OrganizationId":{ - "shape":"OrganizationIdType", - "documentation":"

The unique identifier (ID) of an organization.

" - }, - "EnabledFeatures":{ - "shape":"FeaturesListType", - "documentation":"

The features you have enabled for centralized root access.

" - } - } - }, - "EnableOutboundWebIdentityFederationResponse":{ - "type":"structure", - "members":{ - "IssuerIdentifier":{ - "shape":"stringType", - "documentation":"

A unique issuer URL for your Amazon Web Services account that hosts the OpenID Connect (OIDC) discovery endpoints at /.well-known/openid-configuration and /.well-known/jwks.json. The OpenID Connect (OIDC) discovery endpoints contain verification keys and metadata necessary for token verification.

" - } - } - }, - "EntityAlreadyExistsException":{ - "type":"structure", - "members":{ - "message":{"shape":"entityAlreadyExistsMessage"} - }, - "documentation":"

The request was rejected because it attempted to create a resource that already exists.

", - "error":{ - "code":"EntityAlreadyExists", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true - }, - "EntityDetails":{ - "type":"structure", - "required":["EntityInfo"], - "members":{ - "EntityInfo":{ - "shape":"EntityInfo", - "documentation":"

The EntityInfo object that contains details about the entity (user or role).

" - }, - "LastAuthenticated":{ - "shape":"dateType", - "documentation":"

The date and time, in ISO 8601 date-time format, when the authenticated entity last attempted to access Amazon Web Services. Amazon Web Services does not report unauthenticated requests.

This field is null if no IAM entities attempted to access the service within the tracking period.

" - } - }, - "documentation":"

An object that contains details about when the IAM entities (users or roles) were last used in an attempt to access the specified Amazon Web Services service.

This data type is a response element in the GetServiceLastAccessedDetailsWithEntities operation.

" - }, - "EntityInfo":{ - "type":"structure", - "required":[ - "Arn", - "Name", - "Type", - "Id" - ], - "members":{ - "Arn":{"shape":"arnType"}, - "Name":{ - "shape":"userNameType", - "documentation":"

The name of the entity (user or role).

" - }, - "Type":{ - "shape":"policyOwnerEntityType", - "documentation":"

The type of entity (user or role).

" - }, - "Id":{ - "shape":"idType", - "documentation":"

The identifier of the entity (user or role).

" - }, - "Path":{ - "shape":"pathType", - "documentation":"

The path to the entity (user or role). For more information about paths, see IAM identifiers in the IAM User Guide.

" - } - }, - "documentation":"

Contains details about the specified entity (user or role).

This data type is an element of the EntityDetails object.

" - }, - "EntityTemporarilyUnmodifiableException":{ - "type":"structure", - "members":{ - "message":{"shape":"entityTemporarilyUnmodifiableMessage"} - }, - "documentation":"

The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity.

", - "error":{ - "code":"EntityTemporarilyUnmodifiable", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true - }, - "EntityType":{ - "type":"string", - "enum":[ - "User", - "Role", - "Group", - "LocalManagedPolicy", - "AWSManagedPolicy" - ] - }, - "ErrorDetails":{ - "type":"structure", - "required":[ - "Message", - "Code" - ], - "members":{ - "Message":{ - "shape":"stringType", - "documentation":"

Detailed information about the reason that the operation failed.

" - }, - "Code":{ - "shape":"stringType", - "documentation":"

The error code associated with the operation failure.

" - } - }, - "documentation":"

Contains information about the reason that the operation failed.

This data type is used as a response element in the GetOrganizationsAccessReport, GetServiceLastAccessedDetails, and GetServiceLastAccessedDetailsWithEntities operations.

" - }, - "EvalDecisionDetailsType":{ - "type":"map", - "key":{"shape":"EvalDecisionSourceType"}, - "value":{"shape":"PolicyEvaluationDecisionType"} - }, - "EvalDecisionSourceType":{ - "type":"string", - "max":256, - "min":3 - }, - "EvaluationResult":{ - "type":"structure", - "required":[ - "EvalActionName", - "EvalDecision" - ], - "members":{ - "EvalActionName":{ - "shape":"ActionNameType", - "documentation":"

The name of the API operation tested on the indicated resource.

" - }, - "EvalResourceName":{ - "shape":"ResourceNameType", - "documentation":"

The ARN template for the simulated resource type (for example, arn:${Partition}:s3:::${BucketName}/${KeyName}), or * if no ARN format is defined for the action. This is not a specific customer-provided resource ARN. To find the decision for a specific resource, use ResourceSpecificResults.

If you previously relied on EvalResourceName to identify which specific resource a result applies to, you must now use the EvalResourceName field within individual entries in ResourceSpecificResults instead.

" - }, - "EvalDecision":{ - "shape":"PolicyEvaluationDecisionType", - "documentation":"

The result of the simulation.

" - }, - "MatchedStatements":{ - "shape":"StatementListType", - "documentation":"

A list of the statements in the input policies that determine the result for this scenario. Remember that even if multiple statements allow the operation on the resource, if only one statement denies that operation, then the explicit deny overrides any allow. In addition, the deny statement is the only entry included in the result.

In the top-level result, this field contains the union of matched statements across all requested resources. Only statements that contributed to the reported decision are included. For per-resource matched statements, see ResourceSpecificResults. This field doesn't include statements from service control policies (SCPs). Only statements from identity-based and resource-based policies appear here.

" - }, - "MissingContextValues":{ - "shape":"ContextKeyNamesResultListType", - "documentation":"

A list of context keys that are required by the included input policies but that were not provided by one of the input parameters. This list is used when the resource in a simulation is \"*\", either explicitly, or when the ResourceArns parameter blank. If you include a list of resources, then any missing context values are instead included under the ResourceSpecificResults section. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.

In the top-level result, this field contains the deduplicated set of missing context values across all requested resources. This field doesn't include context keys referenced by service control policies (SCPs). Only context keys referenced by identity-based and resource-based policies appear here.

" - }, - "OrganizationsDecisionDetail":{ - "shape":"OrganizationsDecisionDetail", - "documentation":"

A structure that details how Organizations and its service control policies affect the results of the simulation. Only applies if the simulated user's account is part of an organization.

For resources that don't support organization-level evaluation, this field is omitted from the top-level result. For per-resource details, see ResourceSpecificResults.

" - }, - "PermissionsBoundaryDecisionDetail":{ - "shape":"PermissionsBoundaryDecisionDetail", - "documentation":"

Contains information about the effect that a permissions boundary has on a policy simulation when the boundary is applied to an IAM entity.

" - }, - "EvalDecisionDetails":{ - "shape":"EvalDecisionDetailsType", - "documentation":"

Additional details about the results of the cross-account evaluation decision. This parameter is populated for only cross-account simulations. It contains a brief summary of how each policy type contributes to the final evaluation decision.

In the top-level result, this map reports the most restrictive decision per policy type across all requested resources.

If the simulation evaluates policies within the same account and includes a resource ARN, then the parameter is present but the response is empty. If the simulation evaluates policies within the same account and specifies all resources (*), then the parameter is not returned.

When you make a cross-account request, Amazon Web Services evaluates the request in the trusting account and the trusted account. The request is allowed only if both evaluations return true. For more information about how policies are evaluated, see Evaluating policies within a single account.

If an Organizations SCP included in the evaluation denies access, the simulation ends. In this case, policy evaluation does not proceed any further and this parameter is not returned.

" - }, - "ResourceSpecificResults":{ - "shape":"ResourceSpecificResultListType", - "documentation":"

The individual results of the simulation of the API operation specified in EvalActionName on each resource.

" - } - }, - "documentation":"

Contains the results of a simulation.

This data type is used by the return parameter of SimulateCustomPolicy and SimulatePrincipalPolicy .

The simulator now returns a single EvaluationResult per action, regardless of how many resource ARNs are provided. Previously, simulating one action against N resources returned N evaluation results, each containing the same aggregate decision. The top-level fields (EvalDecision, MatchedStatements, MissingContextValues, EvalDecisionDetails) now represent the aggregate decision across all requested resources. The top-level EvalDecision reflects the most restrictive decision across all resources (for example, if any resource produces explicitDeny, the top-level decision is explicitDeny).

To see the decision for each individual resource, use ResourceSpecificResults. If your application parses evaluation results per resource ARN, update your code to read per-resource decisions from ResourceSpecificResults rather than from the top-level result.

" - }, - "EvaluationResultsListType":{ - "type":"list", - "member":{"shape":"EvaluationResult"} - }, - "FeatureDisabledException":{ - "type":"structure", - "members":{ - "message":{"shape":"FeatureDisabledMessage"} - }, - "documentation":"

The request failed because outbound identity federation is already disabled for your Amazon Web Services account. You cannot disable the feature multiple times

", - "error":{ - "code":"FeatureDisabled", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true - }, - "FeatureDisabledMessage":{"type":"string"}, - "FeatureEnabledException":{ - "type":"structure", - "members":{ - "message":{"shape":"FeatureEnabledMessage"} - }, - "documentation":"

The request failed because outbound identity federation is already enabled for your Amazon Web Services account. You cannot enable the feature multiple times. To fetch the current configuration (including the unique issuer URL), use the GetOutboundWebIdentityFederationInfo operation.

", - "error":{ - "code":"FeatureEnabled", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true - }, - "FeatureEnabledMessage":{"type":"string"}, - "FeatureType":{ - "type":"string", - "enum":[ - "RootCredentialsManagement", - "RootSessions" - ] - }, - "FeaturesListType":{ - "type":"list", - "member":{"shape":"FeatureType"} - }, - "GenerateCredentialReportResponse":{ - "type":"structure", - "members":{ - "State":{ - "shape":"ReportStateType", - "documentation":"

Information about the state of the credential report.

" - }, - "Description":{ - "shape":"ReportStateDescriptionType", - "documentation":"

Information about the credential report.

" - } - }, - "documentation":"

Contains the response to a successful GenerateCredentialReport request.

" - }, - "GenerateOrganizationsAccessReportRequest":{ - "type":"structure", - "required":["EntityPath"], - "members":{ - "EntityPath":{ - "shape":"organizationsEntityPathType", - "documentation":"

The path of the Organizations entity (root, OU, or account). You can build an entity path using the known structure of your organization. For example, assume that your account ID is 123456789012 and its parent OU ID is ou-rge0-awsabcde. The organization root ID is r-f6g7h8i9j0example and your organization ID is o-a1b2c3d4e5. Your entity path is o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-rge0-awsabcde/123456789012.

" - }, - "OrganizationsPolicyId":{ - "shape":"organizationsPolicyIdType", - "documentation":"

The identifier of the Organizations service control policy (SCP). This parameter is optional.

This ID is used to generate information about when an account principal that is limited by the SCP attempted to access an Amazon Web Services service.

" - } - } - }, - "GenerateOrganizationsAccessReportResponse":{ - "type":"structure", - "members":{ - "JobId":{ - "shape":"jobIDType", - "documentation":"

The job identifier that you can use in the GetOrganizationsAccessReport operation.

" - } - } - }, - "GenerateServiceLastAccessedDetailsRequest":{ - "type":"structure", - "required":["Arn"], - "members":{ - "Arn":{ - "shape":"arnType", - "documentation":"

The ARN of the IAM resource (user, group, role, or managed policy) used to generate information about when the resource was last used in an attempt to access an Amazon Web Services service.

" - }, - "Granularity":{ - "shape":"AccessAdvisorUsageGranularityType", - "documentation":"

The level of detail that you want to generate. You can specify whether you want to generate information about the last attempt to access services or actions. If you specify service-level granularity, this operation generates only service data. If you specify action-level granularity, it generates service and action data. If you don't include this optional parameter, the operation generates service data.

" - } - } - }, - "GenerateServiceLastAccessedDetailsResponse":{ - "type":"structure", - "members":{ - "JobId":{ - "shape":"jobIDType", - "documentation":"

The JobId that you can use in the GetServiceLastAccessedDetails or GetServiceLastAccessedDetailsWithEntities operations. The JobId returned by GenerateServiceLastAccessedDetail must be used by the same role within a session, or by the same user when used to call GetServiceLastAccessedDetail.

" - } - } - }, - "GetAccessKeyLastUsedRequest":{ - "type":"structure", - "required":["AccessKeyId"], - "members":{ - "AccessKeyId":{ - "shape":"accessKeyIdType", - "documentation":"

The identifier of an access key.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

" - } - } - }, - "GetAccessKeyLastUsedResponse":{ - "type":"structure", - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"

The name of the IAM user that owns this access key.

" - }, - "AccessKeyLastUsed":{ - "shape":"AccessKeyLastUsed", - "documentation":"

Contains information about the last time the access key was used.

" - } - }, - "documentation":"

Contains the response to a successful GetAccessKeyLastUsed request. It is also returned as a member of the AccessKeyMetaData structure returned by the ListAccessKeys action.

" - }, - "GetAccountAuthorizationDetailsRequest":{ - "type":"structure", - "members":{ - "Filter":{ - "shape":"entityListType", - "documentation":"

A list of entity types used to filter the results. Only the entities that match the types you specify are included in the output. Use the value LocalManagedPolicy to include customer managed policies.

The format for this parameter is a comma-separated (if more than one) list of strings. Each string value in the list must be one of the valid values listed below.

" - }, - "MaxItems":{ - "shape":"maxItemsType", - "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" - }, - "Marker":{ - "shape":"markerType", - "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" - } - } - }, - "GetAccountAuthorizationDetailsResponse":{ - "type":"structure", - "members":{ - "UserDetailList":{ - "shape":"userDetailListType", - "documentation":"

A list containing information about IAM users.

" - }, - "GroupDetailList":{ - "shape":"groupDetailListType", - "documentation":"

A list containing information about IAM groups.

" - }, - "RoleDetailList":{ - "shape":"roleDetailListType", - "documentation":"

A list containing information about IAM roles.

" - }, - "Policies":{ - "shape":"ManagedPolicyDetailListType", - "documentation":"

A list containing information about managed policies.

" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" - }, - "Marker":{ - "shape":"responseMarkerType", - "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" - } - }, - "documentation":"

Contains the response to a successful GetAccountAuthorizationDetails request.

" - }, - "GetAccountPasswordPolicyResponse":{ - "type":"structure", - "required":["PasswordPolicy"], - "members":{ - "PasswordPolicy":{ - "shape":"PasswordPolicy", - "documentation":"

A structure that contains details about the account's password policy.

" - } - }, - "documentation":"

Contains the response to a successful GetAccountPasswordPolicy request.

" - }, - "GetAccountSummaryResponse":{ - "type":"structure", - "members":{ - "SummaryMap":{ - "shape":"summaryMapType", - "documentation":"

A set of key–value pairs containing information about IAM entity usage and IAM quotas.

" - } - }, - "documentation":"

Contains the response to a successful GetAccountSummary request.

" - }, - "GetContextKeysForCustomPolicyRequest":{ - "type":"structure", - "required":["PolicyInputList"], - "members":{ - "PolicyInputList":{ - "shape":"SimulationPolicyListType", - "documentation":"

A list of policies for which you want the list of context keys referenced in those policies. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" - } - } - }, - "GetContextKeysForPolicyResponse":{ - "type":"structure", - "members":{ - "ContextKeyNames":{ - "shape":"ContextKeyNamesResultListType", - "documentation":"

The list of context keys that are referenced in the input policies.

" - } - }, - "documentation":"

Contains the response to a successful GetContextKeysForPrincipalPolicy or GetContextKeysForCustomPolicy request.

" - }, - "GetContextKeysForPrincipalPolicyRequest":{ - "type":"structure", - "required":["PolicySourceArn"], - "members":{ - "PolicySourceArn":{ - "shape":"arnType", - "documentation":"

The ARN of a user, group, or role whose policies contain the context keys that you want listed. If you specify a user, the list includes context keys that are found in all policies that are attached to the user. The list also includes all groups that the user is a member of. If you pick a group or a role, then it includes only those context keys that are found in policies attached to that entity. Note that all parameters are shown in unencoded form here for clarity, but must be URL encoded to be included as a part of a real HTML request.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

" - }, - "PolicyInputList":{ - "shape":"SimulationPolicyListType", - "documentation":"

An optional list of additional policies for which you want the list of context keys that are referenced.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" - } - } - }, - "GetCredentialReportResponse":{ - "type":"structure", - "members":{ - "Content":{ - "shape":"ReportContentType", - "documentation":"

Contains the credential report. The report is Base64-encoded.

" - }, - "ReportFormat":{ - "shape":"ReportFormatType", - "documentation":"

The format (MIME type) of the credential report.

" - }, - "GeneratedTime":{ - "shape":"dateType", - "documentation":"

The date and time when the credential report was created, in ISO 8601 date-time format.

" - } - }, - "documentation":"

Contains the response to a successful GetCredentialReport request.

" - }, - "GetDelegationRequestRequest":{ - "type":"structure", - "required":["DelegationRequestId"], - "members":{ - "DelegationRequestId":{ - "shape":"delegationRequestIdType", - "documentation":"

The unique identifier of the delegation request to retrieve.

" - }, - "DelegationPermissionCheck":{ - "shape":"booleanType", - "documentation":"

Specifies whether to perform a permission check for the delegation request.

If set to true, the GetDelegationRequest API call will start a permission check process. This process calculates whether the caller has sufficient permissions to cover the asks from this delegation request.

Setting this parameter to true does not guarantee an answer in the response. See the PermissionCheckStatus and the PermissionCheckResult response attributes for further details.

" - } - } - }, - "GetDelegationRequestResponse":{ - "type":"structure", - "members":{ - "DelegationRequest":{ - "shape":"DelegationRequest", - "documentation":"

The delegation request object containing all details about the request.

" - }, - "PermissionCheckStatus":{ - "shape":"permissionCheckStatusType", - "documentation":"

The status of the permission check for the delegation request.

This value indicates the status of the process to check whether the caller has sufficient permissions to cover the requested actions in the delegation request. Since this is an asynchronous process, there are three potential values:

  • IN_PROGRESS : The permission check process has started.

  • COMPLETED : The permission check process has completed. The PermissionCheckResult will include the result.

  • FAILED : The permission check process has failed.

" - }, - "PermissionCheckResult":{ - "shape":"permissionCheckResultType", - "documentation":"

The result of the permission check, indicating whether the caller has sufficient permissions to cover the requested permissions. This is an approximate result.

  • ALLOWED : The caller has sufficient permissions cover all the requested permissions.

  • DENIED : The caller does not have sufficient permissions to cover all the requested permissions.

  • UNSURE : It is not possible to determine whether the caller has all the permissions needed. This output is most likely for cases when the caller has permissions with conditions.

" - } - } - }, - "GetGroupPolicyRequest":{ - "type":"structure", - "required":[ - "GroupName", - "PolicyName" - ], - "members":{ - "GroupName":{ - "shape":"groupNameType", - "documentation":"

The name of the group the policy is associated with.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "PolicyName":{ - "shape":"policyNameType", - "documentation":"

The name of the policy document to get.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - } - } - }, - "GetGroupPolicyResponse":{ - "type":"structure", - "required":[ - "GroupName", - "PolicyName", - "PolicyDocument" - ], - "members":{ - "GroupName":{ - "shape":"groupNameType", - "documentation":"

The group the policy is associated with.

" - }, - "PolicyName":{ - "shape":"policyNameType", - "documentation":"

The name of the policy.

" - }, - "PolicyDocument":{ - "shape":"policyDocumentType", - "documentation":"

The policy document.

IAM stores policies in JSON format. However, resources that were created using CloudFormation templates can be formatted in YAML. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

" - } - }, - "documentation":"

Contains the response to a successful GetGroupPolicy request.

" - }, - "GetGroupRequest":{ - "type":"structure", - "required":["GroupName"], - "members":{ - "GroupName":{ - "shape":"groupNameType", - "documentation":"

The name of the group.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "Marker":{ - "shape":"markerType", - "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" - }, - "MaxItems":{ - "shape":"maxItemsType", - "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" - } - } - }, - "GetGroupResponse":{ - "type":"structure", - "required":[ - "Group", - "Users" - ], - "members":{ - "Group":{ - "shape":"Group", - "documentation":"

A structure that contains details about the group.

" - }, - "Users":{ - "shape":"userListType", - "documentation":"

A list of users in the group.

" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" - }, - "Marker":{ - "shape":"responseMarkerType", - "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" - } - }, - "documentation":"

Contains the response to a successful GetGroup request.

" - }, - "GetHumanReadableSummaryRequest":{ - "type":"structure", - "required":["EntityArn"], - "members":{ - "EntityArn":{ - "shape":"arnType", - "documentation":"

Arn of the entity to be summarized. At this time, the only supported entity type is delegation-request

" - }, - "Locale":{ - "shape":"localeType", - "documentation":"

A string representing the locale to use for the summary generation. The supported locale strings are based on the Supported languages of the Amazon Web Services Management Console .

" - } - } - }, - "GetHumanReadableSummaryResponse":{ - "type":"structure", - "members":{ - "SummaryContent":{ - "shape":"summaryContentType", - "documentation":"

Summary content in the specified locale. Summary content is non-empty only if the SummaryState is AVAILABLE.

" - }, - "Locale":{ - "shape":"localeType", - "documentation":"

The locale that this response was generated for. This maps to the input locale.

" - }, - "SummaryState":{ - "shape":"summaryStateType", - "documentation":"

State of summary generation. This generation process is asynchronous and this attribute indicates the state of the generation process.

" - } - } - }, - "GetInstanceProfileRequest":{ - "type":"structure", - "required":["InstanceProfileName"], - "members":{ - "InstanceProfileName":{ - "shape":"instanceProfileNameType", - "documentation":"

The name of the instance profile to get information about.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - } - } - }, - "GetInstanceProfileResponse":{ - "type":"structure", - "required":["InstanceProfile"], - "members":{ - "InstanceProfile":{ - "shape":"InstanceProfile", - "documentation":"

A structure containing details about the instance profile.

" - } - }, - "documentation":"

Contains the response to a successful GetInstanceProfile request.

" - }, - "GetLoginProfileRequest":{ - "type":"structure", - "members":{ - "UserName":{ - "shape":"userNameType", - "documentation":"

The name of the user whose login profile you want to retrieve.

This parameter is optional. If no user name is included, it defaults to the principal making the request. When you make this request with root user credentials, you must use an AssumeRoot session to omit the user name.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - } - } - }, - "GetLoginProfileResponse":{ - "type":"structure", - "required":["LoginProfile"], - "members":{ - "LoginProfile":{ - "shape":"LoginProfile", - "documentation":"

A structure containing the user name and the profile creation date for the user.

" - } - }, - "documentation":"

Contains the response to a successful GetLoginProfile request.

" - }, - "GetMFADeviceRequest":{ - "type":"structure", - "required":["SerialNumber"], - "members":{ - "SerialNumber":{ - "shape":"serialNumberType", - "documentation":"

Serial number that uniquely identifies the MFA device. For this API, we only accept FIDO security key ARNs.

" - }, - "UserName":{ - "shape":"userNameType", - "documentation":"

The friendly name identifying the user.

" - } - } - }, - "GetMFADeviceResponse":{ - "type":"structure", - "required":["SerialNumber"], - "members":{ - "UserName":{ - "shape":"userNameType", - "documentation":"

The friendly name identifying the user.

" - }, - "SerialNumber":{ - "shape":"serialNumberType", - "documentation":"

Serial number that uniquely identifies the MFA device. For this API, we only accept FIDO security key ARNs.

" - }, - "EnableDate":{ - "shape":"dateType", - "documentation":"

The date that a specified user's MFA device was first enabled.

" - }, - "Certifications":{ - "shape":"CertificationMapType", - "documentation":"

The certifications of a specified user's MFA device. We currently provide FIPS-140-2, FIPS-140-3, and FIDO certification levels obtained from FIDO Alliance Metadata Service (MDS).

" - } - } - }, - "GetOpenIDConnectProviderRequest":{ - "type":"structure", - "required":["OpenIDConnectProviderArn"], - "members":{ - "OpenIDConnectProviderArn":{ - "shape":"arnType", - "documentation":"

The Amazon Resource Name (ARN) of the OIDC provider resource object in IAM to get information for. You can get a list of OIDC provider resource ARNs by using the ListOpenIDConnectProviders operation.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

" - } - } - }, - "GetOpenIDConnectProviderResponse":{ - "type":"structure", - "members":{ - "Url":{ - "shape":"OpenIDConnectProviderUrlType", - "documentation":"

The URL that the IAM OIDC provider resource object is associated with. For more information, see CreateOpenIDConnectProvider.

" - }, - "ClientIDList":{ - "shape":"clientIDListType", - "documentation":"

A list of client IDs (also known as audiences) that are associated with the specified IAM OIDC provider resource object. For more information, see CreateOpenIDConnectProvider.

" - }, - "ThumbprintList":{ - "shape":"thumbprintListType", - "documentation":"

A list of certificate thumbprints that are associated with the specified IAM OIDC provider resource object. For more information, see CreateOpenIDConnectProvider.

" - }, - "CreateDate":{ - "shape":"dateType", - "documentation":"

The date and time when the IAM OIDC provider resource object was created in the Amazon Web Services account.

" - }, - "Tags":{ - "shape":"tagListType", - "documentation":"

A list of tags that are attached to the specified IAM OIDC provider. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

" - } - }, - "documentation":"

Contains the response to a successful GetOpenIDConnectProvider request.

" - }, - "GetOrganizationsAccessReportRequest":{ - "type":"structure", - "required":["JobId"], - "members":{ - "JobId":{ - "shape":"jobIDType", - "documentation":"

The identifier of the request generated by the GenerateOrganizationsAccessReport operation.

" - }, - "MaxItems":{ - "shape":"maxItemsType", - "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" - }, - "Marker":{ - "shape":"markerType", - "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" - }, - "SortKey":{ - "shape":"sortKeyType", - "documentation":"

The key that is used to sort the results. If you choose the namespace key, the results are returned in alphabetical order. If you choose the time key, the results are sorted numerically by the date and time.

" - } - } - }, - "GetOrganizationsAccessReportResponse":{ - "type":"structure", - "required":[ - "JobStatus", - "JobCreationDate" - ], - "members":{ - "JobStatus":{ - "shape":"jobStatusType", - "documentation":"

The status of the job.

" - }, - "JobCreationDate":{ - "shape":"dateType", - "documentation":"

The date and time, in ISO 8601 date-time format, when the report job was created.

" - }, - "JobCompletionDate":{ - "shape":"dateType", - "documentation":"

The date and time, in ISO 8601 date-time format, when the generated report job was completed or failed.

This field is null if the job is still in progress, as indicated by a job status value of IN_PROGRESS.

" - }, - "NumberOfServicesAccessible":{ - "shape":"integerType", - "documentation":"

The number of services that the applicable SCPs allow account principals to access.

" - }, - "NumberOfServicesNotAccessed":{ - "shape":"integerType", - "documentation":"

The number of services that account principals are allowed but did not attempt to access.

" - }, - "AccessDetails":{ - "shape":"AccessDetails", - "documentation":"

An object that contains details about the most recent attempt to access the service.

" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" - }, - "Marker":{ - "shape":"markerType", - "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" - }, - "ErrorDetails":{"shape":"ErrorDetails"} - } - }, - "GetOutboundWebIdentityFederationInfoResponse":{ - "type":"structure", - "members":{ - "IssuerIdentifier":{ - "shape":"stringType", - "documentation":"

A unique issuer URL for your Amazon Web Services account that hosts the OpenID Connect (OIDC) discovery endpoints at /.well-known/openid-configuration and /.well-known/jwks.json. The OpenID Connect (OIDC) discovery endpoints contain verification keys and metadata necessary for token verification.

" - }, - "JwtVendingEnabled":{ - "shape":"booleanType", - "documentation":"

Indicates whether outbound identity federation is currently enabled for your Amazon Web Services account. When true, IAM principals in the account can call the GetWebIdentityToken API to obtain JSON Web Tokens (JWTs) for authentication with external services.

" - } - } - }, - "GetPolicyRequest":{ - "type":"structure", - "required":["PolicyArn"], - "members":{ - "PolicyArn":{ - "shape":"arnType", - "documentation":"

The Amazon Resource Name (ARN) of the managed policy that you want information about.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

" - } - } - }, - "GetPolicyResponse":{ - "type":"structure", - "members":{ - "Policy":{ - "shape":"Policy", - "documentation":"

A structure containing details about the policy.

" - } - }, - "documentation":"

Contains the response to a successful GetPolicy request.

" - }, - "GetPolicyVersionRequest":{ - "type":"structure", - "required":[ - "PolicyArn", - "VersionId" - ], - "members":{ - "PolicyArn":{ - "shape":"arnType", - "documentation":"

The Amazon Resource Name (ARN) of the managed policy that you want information about.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

" - }, - "VersionId":{ - "shape":"policyVersionIdType", - "documentation":"

Identifies the policy version to retrieve.

This parameter allows (through its regex pattern) a string of characters that consists of the lowercase letter 'v' followed by one or two digits, and optionally followed by a period '.' and a string of letters and digits.

" - } - } - }, - "GetPolicyVersionResponse":{ - "type":"structure", - "members":{ - "PolicyVersion":{ - "shape":"PolicyVersion", - "documentation":"

A structure containing details about the policy version.

" - } - }, - "documentation":"

Contains the response to a successful GetPolicyVersion request.

" - }, - "GetRolePolicyRequest":{ - "type":"structure", - "required":[ - "RoleName", - "PolicyName" - ], - "members":{ - "RoleName":{ - "shape":"roleNameType", - "documentation":"

The name of the role associated with the policy.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "PolicyName":{ - "shape":"policyNameType", - "documentation":"

The name of the policy document to get.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - } - } - }, - "GetRolePolicyResponse":{ - "type":"structure", - "required":[ - "RoleName", - "PolicyName", - "PolicyDocument" - ], - "members":{ - "RoleName":{ - "shape":"roleNameType", - "documentation":"

The role the policy is associated with.

" - }, - "PolicyName":{ - "shape":"policyNameType", - "documentation":"

The name of the policy.

" - }, - "PolicyDocument":{ - "shape":"policyDocumentType", - "documentation":"

The policy document.

IAM stores policies in JSON format. However, resources that were created using CloudFormation templates can be formatted in YAML. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

" - } - }, - "documentation":"

Contains the response to a successful GetRolePolicy request.

" - }, - "GetRoleRequest":{ - "type":"structure", - "required":["RoleName"], - "members":{ - "RoleName":{ - "shape":"roleNameType", - "documentation":"

The name of the IAM role to get information about.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - } - } - }, - "GetRoleResponse":{ - "type":"structure", - "required":["Role"], - "members":{ - "Role":{ - "shape":"Role", - "documentation":"

A structure containing details about the IAM role.

" - } - }, - "documentation":"

Contains the response to a successful GetRole request.

" - }, - "GetSAMLProviderRequest":{ - "type":"structure", - "required":["SAMLProviderArn"], - "members":{ - "SAMLProviderArn":{ - "shape":"arnType", - "documentation":"

The Amazon Resource Name (ARN) of the SAML provider resource object in IAM to get information about.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

" - } - } - }, - "GetSAMLProviderResponse":{ - "type":"structure", - "members":{ - "SAMLProviderUUID":{ - "shape":"privateKeyIdType", - "documentation":"

The unique identifier assigned to the SAML provider.

" - }, - "SAMLMetadataDocument":{ - "shape":"SAMLMetadataDocumentType", - "documentation":"

The XML metadata document that includes information about an identity provider.

" - }, - "CreateDate":{ - "shape":"dateType", - "documentation":"

The date and time when the SAML provider was created.

" - }, - "ValidUntil":{ - "shape":"dateType", - "documentation":"

The expiration date and time for the SAML provider.

" - }, - "Tags":{ - "shape":"tagListType", - "documentation":"

A list of tags that are attached to the specified IAM SAML provider. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

" - }, - "AssertionEncryptionMode":{ - "shape":"assertionEncryptionModeType", - "documentation":"

Specifies the encryption setting for the SAML provider.

" - }, - "PrivateKeyList":{ - "shape":"privateKeyList", - "documentation":"

The private key metadata for the SAML provider.

" - } - }, - "documentation":"

Contains the response to a successful GetSAMLProvider request.

" - }, - "GetSSHPublicKeyRequest":{ - "type":"structure", - "required":[ - "UserName", - "SSHPublicKeyId", - "Encoding" - ], - "members":{ - "UserName":{ - "shape":"userNameType", - "documentation":"

The name of the IAM user associated with the SSH public key.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "SSHPublicKeyId":{ - "shape":"publicKeyIdType", - "documentation":"

The unique identifier for the SSH public key.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

" - }, - "Encoding":{ - "shape":"encodingType", - "documentation":"

Specifies the public key encoding format to use in the response. To retrieve the public key in ssh-rsa format, use SSH. To retrieve the public key in PEM format, use PEM.

" - } - } - }, - "GetSSHPublicKeyResponse":{ - "type":"structure", - "members":{ - "SSHPublicKey":{ - "shape":"SSHPublicKey", - "documentation":"

A structure containing details about the SSH public key.

" - } - }, - "documentation":"

Contains the response to a successful GetSSHPublicKey request.

" - }, - "GetServerCertificateRequest":{ - "type":"structure", - "required":["ServerCertificateName"], - "members":{ - "ServerCertificateName":{ - "shape":"serverCertificateNameType", - "documentation":"

The name of the server certificate you want to retrieve information about.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - } - } - }, - "GetServerCertificateResponse":{ - "type":"structure", - "required":["ServerCertificate"], - "members":{ - "ServerCertificate":{ - "shape":"ServerCertificate", - "documentation":"

A structure containing details about the server certificate.

" - } - }, - "documentation":"

Contains the response to a successful GetServerCertificate request.

" - }, - "GetServiceLastAccessedDetailsRequest":{ - "type":"structure", - "required":["JobId"], - "members":{ - "JobId":{ - "shape":"jobIDType", - "documentation":"

The ID of the request generated by the GenerateServiceLastAccessedDetails operation. The JobId returned by GenerateServiceLastAccessedDetail must be used by the same role within a session, or by the same user when used to call GetServiceLastAccessedDetail.

" - }, - "MaxItems":{ - "shape":"maxItemsType", - "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" - }, - "Marker":{ - "shape":"markerType", - "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" - } - } - }, - "GetServiceLastAccessedDetailsResponse":{ - "type":"structure", - "required":[ - "JobStatus", - "JobCreationDate", - "ServicesLastAccessed", - "JobCompletionDate" - ], - "members":{ - "JobStatus":{ - "shape":"jobStatusType", - "documentation":"

The status of the job.

" - }, - "JobType":{ - "shape":"AccessAdvisorUsageGranularityType", - "documentation":"

The type of job. Service jobs return information about when each service was last accessed. Action jobs also include information about when tracked actions within the service were last accessed.

" - }, - "JobCreationDate":{ - "shape":"dateType", - "documentation":"

The date and time, in ISO 8601 date-time format, when the report job was created.

" - }, - "ServicesLastAccessed":{ - "shape":"ServicesLastAccessed", - "documentation":"

A ServiceLastAccessed object that contains details about the most recent attempt to access the service.

" - }, - "JobCompletionDate":{ - "shape":"dateType", - "documentation":"

The date and time, in ISO 8601 date-time format, when the generated report job was completed or failed.

This field is null if the job is still in progress, as indicated by a job status value of IN_PROGRESS.

" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" - }, - "Marker":{ - "shape":"responseMarkerType", - "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" - }, - "Error":{ - "shape":"ErrorDetails", - "documentation":"

An object that contains details about the reason the operation failed.

" - } - } - }, - "GetServiceLastAccessedDetailsWithEntitiesRequest":{ - "type":"structure", - "required":[ - "JobId", - "ServiceNamespace" - ], - "members":{ - "JobId":{ - "shape":"jobIDType", - "documentation":"

The ID of the request generated by the GenerateServiceLastAccessedDetails operation.

" - }, - "ServiceNamespace":{ - "shape":"serviceNamespaceType", - "documentation":"

The service namespace for an Amazon Web Services service. Provide the service namespace to learn when the IAM entity last attempted to access the specified service.

To learn the service namespace for a service, see Actions, resources, and condition keys for Amazon Web Services services in the IAM User Guide. Choose the name of the service to view details for that service. In the first paragraph, find the service prefix. For example, (service prefix: a4b). For more information about service namespaces, see Amazon Web Services service namespaces in the Amazon Web Services General Reference.

" - }, - "MaxItems":{ - "shape":"maxItemsType", - "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" - }, - "Marker":{ - "shape":"markerType", - "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" - } - } - }, - "GetServiceLastAccessedDetailsWithEntitiesResponse":{ - "type":"structure", - "required":[ - "JobStatus", - "JobCreationDate", - "JobCompletionDate", - "EntityDetailsList" - ], - "members":{ - "JobStatus":{ - "shape":"jobStatusType", - "documentation":"

The status of the job.

" - }, - "JobCreationDate":{ - "shape":"dateType", - "documentation":"

The date and time, in ISO 8601 date-time format, when the report job was created.

" - }, - "JobCompletionDate":{ - "shape":"dateType", - "documentation":"

The date and time, in ISO 8601 date-time format, when the generated report job was completed or failed.

This field is null if the job is still in progress, as indicated by a job status value of IN_PROGRESS.

" - }, - "EntityDetailsList":{ - "shape":"entityDetailsListType", - "documentation":"

An EntityDetailsList object that contains details about when an IAM entity (user or role) used group or policy permissions in an attempt to access the specified Amazon Web Services service.

" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" - }, - "Marker":{ - "shape":"responseMarkerType", - "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" - }, - "Error":{ - "shape":"ErrorDetails", - "documentation":"

An object that contains details about the reason the operation failed.

" - } - } - }, - "GetServiceLinkedRoleDeletionStatusRequest":{ - "type":"structure", - "required":["DeletionTaskId"], - "members":{ - "DeletionTaskId":{ - "shape":"DeletionTaskIdType", - "documentation":"

The deletion task identifier. This identifier is returned by the DeleteServiceLinkedRole operation in the format task/aws-service-role/<service-principal-name>/<role-name>/<task-uuid>.

" - } - } - }, - "GetServiceLinkedRoleDeletionStatusResponse":{ - "type":"structure", - "required":["Status"], - "members":{ - "Status":{ - "shape":"DeletionTaskStatusType", - "documentation":"

The status of the deletion.

" - }, - "Reason":{ - "shape":"DeletionTaskFailureReasonType", - "documentation":"

An object that contains details about the reason the deletion failed.

" - } - } - }, - "GetUserPolicyRequest":{ - "type":"structure", - "required":[ - "UserName", - "PolicyName" - ], - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"

The name of the user who the policy is associated with.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "PolicyName":{ - "shape":"policyNameType", - "documentation":"

The name of the policy document to get.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - } - } - }, - "GetUserPolicyResponse":{ - "type":"structure", - "required":[ - "UserName", - "PolicyName", - "PolicyDocument" - ], - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"

The user the policy is associated with.

" - }, - "PolicyName":{ - "shape":"policyNameType", - "documentation":"

The name of the policy.

" - }, - "PolicyDocument":{ - "shape":"policyDocumentType", - "documentation":"

The policy document.

IAM stores policies in JSON format. However, resources that were created using CloudFormation templates can be formatted in YAML. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

" - } - }, - "documentation":"

Contains the response to a successful GetUserPolicy request.

" - }, - "GetUserRequest":{ - "type":"structure", - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"

The name of the user to get information about.

This parameter is optional. If it is not included, it defaults to the user making the request. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - } - } - }, - "GetUserResponse":{ - "type":"structure", - "required":["User"], - "members":{ - "User":{ - "shape":"User", - "documentation":"

A structure containing details about the IAM user.

Due to a service issue, password last used data does not include password use from May 3, 2018 22:50 PDT to May 23, 2018 14:08 PDT. This affects last sign-in dates shown in the IAM console and password last used dates in the IAM credential report, and returned by this operation. If users signed in during the affected time, the password last used date that is returned is the date the user last signed in before May 3, 2018. For users that signed in after May 23, 2018 14:08 PDT, the returned password last used date is accurate.

You can use password last used information to identify unused credentials for deletion. For example, you might delete users who did not sign in to Amazon Web Services in the last 90 days. In cases like this, we recommend that you adjust your evaluation window to include dates after May 23, 2018. Alternatively, if your users use access keys to access Amazon Web Services programmatically you can refer to access key last used information because it is accurate for all dates.

" - } - }, - "documentation":"

Contains the response to a successful GetUser request.

" - }, - "Group":{ - "type":"structure", - "required":[ - "Path", - "GroupName", - "GroupId", - "Arn", - "CreateDate" - ], - "members":{ - "Path":{ - "shape":"pathType", - "documentation":"

The path to the group. For more information about paths, see IAM identifiers in the IAM User Guide.

" - }, - "GroupName":{ - "shape":"groupNameType", - "documentation":"

The friendly name that identifies the group.

" - }, - "GroupId":{ - "shape":"idType", - "documentation":"

The stable and unique string identifying the group. For more information about IDs, see IAM identifiers in the IAM User Guide.

" - }, - "Arn":{ - "shape":"arnType", - "documentation":"

The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how to use them in policies, see IAM identifiers in the IAM User Guide.

" - }, - "CreateDate":{ - "shape":"dateType", - "documentation":"

The date and time, in ISO 8601 date-time format, when the group was created.

" - } - }, - "documentation":"

Contains information about an IAM group entity.

This data type is used as a response element in the following operations:

" - }, - "GroupDetail":{ - "type":"structure", - "members":{ - "Path":{ - "shape":"pathType", - "documentation":"

The path to the group. For more information about paths, see IAM identifiers in the IAM User Guide.

" - }, - "GroupName":{ - "shape":"groupNameType", - "documentation":"

The friendly name that identifies the group.

" - }, - "GroupId":{ - "shape":"idType", - "documentation":"

The stable and unique string identifying the group. For more information about IDs, see IAM identifiers in the IAM User Guide.

" - }, - "Arn":{"shape":"arnType"}, - "CreateDate":{ - "shape":"dateType", - "documentation":"

The date and time, in ISO 8601 date-time format, when the group was created.

" - }, - "GroupPolicyList":{ - "shape":"policyDetailListType", - "documentation":"

A list of the inline policies embedded in the group.

" - }, - "AttachedManagedPolicies":{ - "shape":"attachedPoliciesListType", - "documentation":"

A list of the managed policies attached to the group.

" - } - }, - "documentation":"

Contains information about an IAM group, including all of the group's policies.

This data type is used as a response element in the GetAccountAuthorizationDetails operation.

" - }, - "InlinePolicyIdentifierType":{ - "type":"structure", - "required":[ - "PolicyName", - "AttachmentType", - "AttachmentName" - ], - "members":{ - "PolicyName":{ - "shape":"policyNameType", - "documentation":"

The name of the inline policy.

" - }, - "AttachmentType":{ - "shape":"AttachmentType", - "documentation":"

The type of IAM entity that the inline policy is attached to.

" - }, - "AttachmentName":{ - "shape":"AttachmentName", - "documentation":"

The name of the IAM user, group, or role that the inline policy is attached to. Wildcard characters are supported to match multiple entities: use at most one * (matches any sequence of characters, including none), and any number of ? (each matches exactly one character).

" - } - }, - "documentation":"

Identifies one or more inline policies that are embedded in IAM users, groups, or roles, by the name of the policy together with the type and name of the entity that it is attached to. Wildcard characters in the entity name can match multiple entities, so a single identifier can select more than one attached inline policy.

" - }, - "InstanceProfile":{ - "type":"structure", - "required":[ - "Path", - "InstanceProfileName", - "InstanceProfileId", - "Arn", - "CreateDate", - "Roles" - ], - "members":{ - "Path":{ - "shape":"pathType", - "documentation":"

The path to the instance profile. For more information about paths, see IAM identifiers in the IAM User Guide.

" - }, - "InstanceProfileName":{ - "shape":"instanceProfileNameType", - "documentation":"

The name identifying the instance profile.

" - }, - "InstanceProfileId":{ - "shape":"idType", - "documentation":"

The stable and unique string identifying the instance profile. For more information about IDs, see IAM identifiers in the IAM User Guide.

" - }, - "Arn":{ - "shape":"arnType", - "documentation":"

The Amazon Resource Name (ARN) specifying the instance profile. For more information about ARNs and how to use them in policies, see IAM identifiers in the IAM User Guide.

" - }, - "CreateDate":{ - "shape":"dateType", - "documentation":"

The date when the instance profile was created.

" - }, - "Roles":{ - "shape":"roleListType", - "documentation":"

The role associated with the instance profile.

" - }, - "Tags":{ - "shape":"tagListType", - "documentation":"

A list of tags that are attached to the instance profile. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

" - } - }, - "documentation":"

Contains information about an instance profile.

This data type is used as a response element in the following operations:

" - }, - "InvalidAuthenticationCodeException":{ - "type":"structure", - "members":{ - "message":{"shape":"invalidAuthenticationCodeMessage"} - }, - "documentation":"

The request was rejected because the authentication code was not recognized. The error message describes the specific error.

", - "error":{ - "code":"InvalidAuthenticationCode", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true - }, - "InvalidCertificateException":{ - "type":"structure", - "members":{ - "message":{"shape":"invalidCertificateMessage"} - }, - "documentation":"

The request was rejected because the certificate is invalid.

", - "error":{ - "code":"InvalidCertificate", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "InvalidInputException":{ - "type":"structure", - "members":{ - "message":{"shape":"invalidInputMessage"} - }, - "documentation":"

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

", - "error":{ - "code":"InvalidInput", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "InvalidPublicKeyException":{ - "type":"structure", - "members":{ - "message":{"shape":"invalidPublicKeyMessage"} - }, - "documentation":"

The request was rejected because the public key is malformed or otherwise invalid.

", - "error":{ - "code":"InvalidPublicKey", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "InvalidUserTypeException":{ - "type":"structure", - "members":{ - "message":{"shape":"invalidUserTypeMessage"} - }, - "documentation":"

The request was rejected because the type of user for the transaction was incorrect.

", - "error":{ - "code":"InvalidUserType", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "KeyPairMismatchException":{ - "type":"structure", - "members":{ - "message":{"shape":"keyPairMismatchMessage"} - }, - "documentation":"

The request was rejected because the public key certificate and the private key do not match.

", - "error":{ - "code":"KeyPairMismatch", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "LimitExceededException":{ - "type":"structure", - "members":{ - "message":{"shape":"limitExceededMessage"} - }, - "documentation":"

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.

", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true - }, - "LineNumber":{"type":"integer"}, - "ListAccessKeysRequest":{ - "type":"structure", - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"

The name of the user.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "Marker":{ - "shape":"markerType", - "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" - }, - "MaxItems":{ - "shape":"maxItemsType", - "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" - } - } - }, - "ListAccessKeysResponse":{ - "type":"structure", - "required":["AccessKeyMetadata"], - "members":{ - "AccessKeyMetadata":{ - "shape":"accessKeyMetadataListType", - "documentation":"

A list of objects containing metadata about the access keys.

" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" - }, - "Marker":{ - "shape":"responseMarkerType", - "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" - } - }, - "documentation":"

Contains the response to a successful ListAccessKeys request.

" - }, - "ListAccountAliasesRequest":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"markerType", - "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" - }, - "MaxItems":{ - "shape":"maxItemsType", - "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" - } - } - }, - "ListAccountAliasesResponse":{ - "type":"structure", - "required":["AccountAliases"], - "members":{ - "AccountAliases":{ - "shape":"accountAliasListType", - "documentation":"

A list of aliases associated with the account. Amazon Web Services supports only one alias per account.

" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" - }, - "Marker":{ - "shape":"responseMarkerType", - "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" - } - }, - "documentation":"

Contains the response to a successful ListAccountAliases request.

" - }, - "ListAttachedGroupPoliciesRequest":{ - "type":"structure", - "required":["GroupName"], - "members":{ - "GroupName":{ - "shape":"groupNameType", - "documentation":"

The name (friendly name, not ARN) of the group to list attached policies for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "PathPrefix":{ - "shape":"policyPathType", - "documentation":"

The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" - }, - "Marker":{ - "shape":"markerType", - "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" - }, - "MaxItems":{ - "shape":"maxItemsType", - "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" - } - } - }, - "ListAttachedGroupPoliciesResponse":{ - "type":"structure", - "members":{ - "AttachedPolicies":{ - "shape":"attachedPoliciesListType", - "documentation":"

A list of the attached policies.

" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" - }, - "Marker":{ - "shape":"responseMarkerType", - "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" - } - }, - "documentation":"

Contains the response to a successful ListAttachedGroupPolicies request.

" - }, - "ListAttachedRolePoliciesRequest":{ - "type":"structure", - "required":["RoleName"], - "members":{ - "RoleName":{ - "shape":"roleNameType", - "documentation":"

The name (friendly name, not ARN) of the role to list attached policies for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "PathPrefix":{ - "shape":"policyPathType", - "documentation":"

The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" - }, - "Marker":{ - "shape":"markerType", - "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" - }, - "MaxItems":{ - "shape":"maxItemsType", - "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" - } - } - }, - "ListAttachedRolePoliciesResponse":{ - "type":"structure", - "members":{ - "AttachedPolicies":{ - "shape":"attachedPoliciesListType", - "documentation":"

A list of the attached policies.

" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" - }, - "Marker":{ - "shape":"responseMarkerType", - "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" - } - }, - "documentation":"

Contains the response to a successful ListAttachedRolePolicies request.

" - }, - "ListAttachedUserPoliciesRequest":{ - "type":"structure", - "required":["UserName"], - "members":{ - "UserName":{ - "shape":"userNameType", - "documentation":"

The name (friendly name, not ARN) of the user to list attached policies for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "PathPrefix":{ - "shape":"policyPathType", - "documentation":"

The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" - }, - "Marker":{ - "shape":"markerType", - "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" - }, - "MaxItems":{ - "shape":"maxItemsType", - "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" - } - } - }, - "ListAttachedUserPoliciesResponse":{ - "type":"structure", - "members":{ - "AttachedPolicies":{ - "shape":"attachedPoliciesListType", - "documentation":"

A list of the attached policies.

" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" - }, - "Marker":{ - "shape":"responseMarkerType", - "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" - } - }, - "documentation":"

Contains the response to a successful ListAttachedUserPolicies request.

" - }, - "ListDelegationRequestsRequest":{ - "type":"structure", - "members":{ - "OwnerId":{ - "shape":"ownerIdType", - "documentation":"

The owner ID to filter delegation requests by.

" - }, - "Marker":{ - "shape":"markerType", - "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" - }, - "MaxItems":{ - "shape":"maxItemsType", - "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM may return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" - } - } - }, - "ListDelegationRequestsResponse":{ - "type":"structure", - "members":{ - "DelegationRequests":{ - "shape":"delegationRequestsListType", - "documentation":"

A list of delegation requests that match the specified criteria.

" - }, - "Marker":{ - "shape":"markerType", - "documentation":"

When isTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" - }, - "isTruncated":{ - "shape":"booleanType", - "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items.

" - } - } - }, - "ListEntitiesForPolicyRequest":{ - "type":"structure", - "required":["PolicyArn"], - "members":{ - "PolicyArn":{ - "shape":"arnType", - "documentation":"

The Amazon Resource Name (ARN) of the IAM policy for which you want the versions.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

" - }, - "EntityFilter":{ - "shape":"EntityType", - "documentation":"

The entity type to use for filtering the results.

For example, when EntityFilter is Role, only the roles that are attached to the specified policy are returned. This parameter is optional. If it is not included, all attached entities (users, groups, and roles) are returned. The argument for this parameter must be one of the valid values listed below.

" - }, - "PathPrefix":{ - "shape":"pathType", - "documentation":"

The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all entities.

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" - }, - "PolicyUsageFilter":{ - "shape":"PolicyUsageType", - "documentation":"

The policy usage method to use for filtering the results.

To list only permissions policies, set PolicyUsageFilter to PermissionsPolicy. To list only the policies used to set permissions boundaries, set the value to PermissionsBoundary.

This parameter is optional. If it is not included, all policies are returned.

" - }, - "Marker":{ - "shape":"markerType", - "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" - }, - "MaxItems":{ - "shape":"maxItemsType", - "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" - } - } - }, - "ListEntitiesForPolicyResponse":{ - "type":"structure", - "members":{ - "PolicyGroups":{ - "shape":"PolicyGroupListType", - "documentation":"

A list of IAM groups that the policy is attached to.

" - }, - "PolicyUsers":{ - "shape":"PolicyUserListType", - "documentation":"

A list of IAM users that the policy is attached to.

" - }, - "PolicyRoles":{ - "shape":"PolicyRoleListType", - "documentation":"

A list of IAM roles that the policy is attached to.

" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" - }, - "Marker":{ - "shape":"responseMarkerType", - "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" - } - }, - "documentation":"

Contains the response to a successful ListEntitiesForPolicy request.

" - }, - "ListGroupPoliciesRequest":{ - "type":"structure", - "required":["GroupName"], - "members":{ - "GroupName":{ - "shape":"groupNameType", - "documentation":"

The name of the group to list policies for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "Marker":{ - "shape":"markerType", - "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" - }, - "MaxItems":{ - "shape":"maxItemsType", - "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" - } - } - }, - "ListGroupPoliciesResponse":{ - "type":"structure", - "required":["PolicyNames"], - "members":{ - "PolicyNames":{ - "shape":"policyNameListType", - "documentation":"

A list of policy names.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" - }, - "Marker":{ - "shape":"responseMarkerType", - "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" - } - }, - "documentation":"

Contains the response to a successful ListGroupPolicies request.

" - }, - "ListGroupsForUserRequest":{ - "type":"structure", - "required":["UserName"], - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"

The name of the user to list groups for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "Marker":{ - "shape":"markerType", - "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" - }, - "MaxItems":{ - "shape":"maxItemsType", - "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" - } - } - }, - "ListGroupsForUserResponse":{ - "type":"structure", - "required":["Groups"], - "members":{ - "Groups":{ - "shape":"groupListType", - "documentation":"

A list of groups.

" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" - }, - "Marker":{ - "shape":"responseMarkerType", - "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" - } - }, - "documentation":"

Contains the response to a successful ListGroupsForUser request.

" - }, - "ListGroupsRequest":{ - "type":"structure", - "members":{ - "PathPrefix":{ - "shape":"pathPrefixType", - "documentation":"

The path prefix for filtering the results. For example, the prefix /division_abc/subdivision_xyz/ gets all groups whose path starts with /division_abc/subdivision_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all groups. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" - }, - "Marker":{ - "shape":"markerType", - "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" - }, - "MaxItems":{ - "shape":"maxItemsType", - "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" - } - } - }, - "ListGroupsResponse":{ - "type":"structure", - "required":["Groups"], - "members":{ - "Groups":{ - "shape":"groupListType", - "documentation":"

A list of groups.

" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" - }, - "Marker":{ - "shape":"responseMarkerType", - "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" - } - }, - "documentation":"

Contains the response to a successful ListGroups request.

" - }, - "ListInstanceProfileTagsRequest":{ - "type":"structure", - "required":["InstanceProfileName"], - "members":{ - "InstanceProfileName":{ - "shape":"instanceProfileNameType", - "documentation":"

The name of the IAM instance profile whose tags you want to see.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "Marker":{ - "shape":"markerType", - "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" - }, - "MaxItems":{ - "shape":"maxItemsType", - "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" - } - } - }, - "ListInstanceProfileTagsResponse":{ - "type":"structure", - "required":["Tags"], - "members":{ - "Tags":{ - "shape":"tagListType", - "documentation":"

The list of tags that are currently attached to the IAM instance profile. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" - }, - "Marker":{ - "shape":"responseMarkerType", - "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" - } - } - }, - "ListInstanceProfilesForRoleRequest":{ - "type":"structure", - "required":["RoleName"], - "members":{ - "RoleName":{ - "shape":"roleNameType", - "documentation":"

The name of the role to list instance profiles for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "Marker":{ - "shape":"markerType", - "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" - }, - "MaxItems":{ - "shape":"maxItemsType", - "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" - } - } - }, - "ListInstanceProfilesForRoleResponse":{ - "type":"structure", - "required":["InstanceProfiles"], - "members":{ - "InstanceProfiles":{ - "shape":"instanceProfileListType", - "documentation":"

A list of instance profiles.

" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" - }, - "Marker":{ - "shape":"responseMarkerType", - "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" - } - }, - "documentation":"

Contains the response to a successful ListInstanceProfilesForRole request.

" - }, - "ListInstanceProfilesRequest":{ - "type":"structure", - "members":{ - "PathPrefix":{ - "shape":"pathPrefixType", - "documentation":"

The path prefix for filtering the results. For example, the prefix /application_abc/component_xyz/ gets all instance profiles whose path starts with /application_abc/component_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all instance profiles. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" - }, - "Marker":{ - "shape":"markerType", - "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" - }, - "MaxItems":{ - "shape":"maxItemsType", - "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" - } - } - }, - "ListInstanceProfilesResponse":{ - "type":"structure", - "required":["InstanceProfiles"], - "members":{ - "InstanceProfiles":{ - "shape":"instanceProfileListType", - "documentation":"

A list of instance profiles.

" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" - }, - "Marker":{ - "shape":"responseMarkerType", - "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" - } - }, - "documentation":"

Contains the response to a successful ListInstanceProfiles request.

" - }, - "ListMFADeviceTagsRequest":{ - "type":"structure", - "required":["SerialNumber"], - "members":{ - "SerialNumber":{ - "shape":"serialNumberType", - "documentation":"

The unique identifier for the IAM virtual MFA device whose tags you want to see. For virtual MFA devices, the serial number is the same as the ARN.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "Marker":{ - "shape":"markerType", - "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" - }, - "MaxItems":{ - "shape":"maxItemsType", - "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" - } - } - }, - "ListMFADeviceTagsResponse":{ - "type":"structure", - "required":["Tags"], - "members":{ - "Tags":{ - "shape":"tagListType", - "documentation":"

The list of tags that are currently attached to the virtual MFA device. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" - }, - "Marker":{ - "shape":"responseMarkerType", - "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" - } - } - }, - "ListMFADevicesRequest":{ - "type":"structure", - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"

The name of the user whose MFA devices you want to list.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "Marker":{ - "shape":"markerType", - "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" - }, - "MaxItems":{ - "shape":"maxItemsType", - "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" - } - } - }, - "ListMFADevicesResponse":{ - "type":"structure", - "required":["MFADevices"], - "members":{ - "MFADevices":{ - "shape":"mfaDeviceListType", - "documentation":"

A list of MFA devices.

" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" - }, - "Marker":{ - "shape":"responseMarkerType", - "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" - } - }, - "documentation":"

Contains the response to a successful ListMFADevices request.

" - }, - "ListOpenIDConnectProviderTagsRequest":{ - "type":"structure", - "required":["OpenIDConnectProviderArn"], - "members":{ - "OpenIDConnectProviderArn":{ - "shape":"arnType", - "documentation":"

The ARN of the OpenID Connect (OIDC) identity provider whose tags you want to see.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "Marker":{ - "shape":"markerType", - "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" - }, - "MaxItems":{ - "shape":"maxItemsType", - "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" - } - } - }, - "ListOpenIDConnectProviderTagsResponse":{ - "type":"structure", - "required":["Tags"], - "members":{ - "Tags":{ - "shape":"tagListType", - "documentation":"

The list of tags that are currently attached to the OpenID Connect (OIDC) identity provider. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" - }, - "Marker":{ - "shape":"responseMarkerType", - "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" - } - } - }, - "ListOpenIDConnectProvidersRequest":{ - "type":"structure", - "members":{} - }, - "ListOpenIDConnectProvidersResponse":{ - "type":"structure", - "members":{ - "OpenIDConnectProviderList":{ - "shape":"OpenIDConnectProviderListType", - "documentation":"

The list of IAM OIDC provider resource objects defined in the Amazon Web Services account.

" - } - }, - "documentation":"

Contains the response to a successful ListOpenIDConnectProviders request.

" - }, - "ListOrganizationsFeaturesRequest":{ - "type":"structure", - "members":{} - }, - "ListOrganizationsFeaturesResponse":{ - "type":"structure", - "members":{ - "OrganizationId":{ - "shape":"OrganizationIdType", - "documentation":"

The unique identifier (ID) of an organization.

" - }, - "EnabledFeatures":{ - "shape":"FeaturesListType", - "documentation":"

Specifies the features that are currently available in your organization.

" - } - } - }, - "ListPoliciesGrantingServiceAccessEntry":{ - "type":"structure", - "members":{ - "ServiceNamespace":{ - "shape":"serviceNamespaceType", - "documentation":"

The namespace of the service that was accessed.

To learn the service namespace of a service, see Actions, resources, and condition keys for Amazon Web Services services in the Service Authorization Reference. Choose the name of the service to view details for that service. In the first paragraph, find the service prefix. For example, (service prefix: a4b). For more information about service namespaces, see Amazon Web Services service namespaces in the Amazon Web Services General Reference.

" - }, - "Policies":{ - "shape":"policyGrantingServiceAccessListType", - "documentation":"

The PoliciesGrantingServiceAccess object that contains details about the policy.

" - } - }, - "documentation":"

Contains details about the permissions policies that are attached to the specified identity (user, group, or role).

This data type is used as a response element in the ListPoliciesGrantingServiceAccess operation.

" - }, - "ListPoliciesGrantingServiceAccessRequest":{ - "type":"structure", - "required":[ - "Arn", - "ServiceNamespaces" - ], - "members":{ - "Marker":{ - "shape":"markerType", - "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" - }, - "Arn":{ - "shape":"arnType", - "documentation":"

The ARN of the IAM identity (user, group, or role) whose policies you want to list.

" - }, - "ServiceNamespaces":{ - "shape":"serviceNamespaceListType", - "documentation":"

The service namespace for the Amazon Web Services services whose policies you want to list.

To learn the service namespace for a service, see Actions, resources, and condition keys for Amazon Web Services services in the IAM User Guide. Choose the name of the service to view details for that service. In the first paragraph, find the service prefix. For example, (service prefix: a4b). For more information about service namespaces, see Amazon Web Services service namespaces in the Amazon Web Services General Reference.

" - } - } - }, - "ListPoliciesGrantingServiceAccessResponse":{ - "type":"structure", - "required":["PoliciesGrantingServiceAccess"], - "members":{ - "PoliciesGrantingServiceAccess":{ - "shape":"listPolicyGrantingServiceAccessResponseListType", - "documentation":"

A ListPoliciesGrantingServiceAccess object that contains details about the permissions policies attached to the specified identity (user, group, or role).

" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" - }, - "Marker":{ - "shape":"responseMarkerType", - "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" - } - } - }, - "ListPoliciesRequest":{ - "type":"structure", - "members":{ - "Scope":{ - "shape":"policyScopeType", - "documentation":"

The scope to use for filtering the results.

To list only Amazon Web Services managed policies, set Scope to AWS. To list only the customer managed policies in your Amazon Web Services account, set Scope to Local.

This parameter is optional. If it is not included, or if it is set to All, all policies are returned.

" - }, - "OnlyAttached":{ - "shape":"booleanType", - "documentation":"

A flag to filter the results to only the attached policies.

When OnlyAttached is true, the returned list contains only the policies that are attached to an IAM user, group, or role. When OnlyAttached is false, or when the parameter is not included, all policies are returned.

" - }, - "PathPrefix":{ - "shape":"policyPathType", - "documentation":"

The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" - }, - "PolicyUsageFilter":{ - "shape":"PolicyUsageType", - "documentation":"

The policy usage method to use for filtering the results.

To list only permissions policies, set PolicyUsageFilter to PermissionsPolicy. To list only the policies used to set permissions boundaries, set the value to PermissionsBoundary.

This parameter is optional. If it is not included, all policies are returned.

" - }, - "Marker":{ - "shape":"markerType", - "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" - }, - "MaxItems":{ - "shape":"maxItemsType", - "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" - } - } - }, - "ListPoliciesResponse":{ - "type":"structure", - "members":{ - "Policies":{ - "shape":"policyListType", - "documentation":"

A list of policies.

" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" - }, - "Marker":{ - "shape":"responseMarkerType", - "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" - } - }, - "documentation":"

Contains the response to a successful ListPolicies request.

" - }, - "ListPolicyTagsRequest":{ - "type":"structure", - "required":["PolicyArn"], - "members":{ - "PolicyArn":{ - "shape":"arnType", - "documentation":"

The ARN of the IAM customer managed policy whose tags you want to see.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "Marker":{ - "shape":"markerType", - "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" - }, - "MaxItems":{ - "shape":"maxItemsType", - "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" - } - } - }, - "ListPolicyTagsResponse":{ - "type":"structure", - "required":["Tags"], - "members":{ - "Tags":{ - "shape":"tagListType", - "documentation":"

The list of tags that are currently attached to the IAM customer managed policy. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" - }, - "Marker":{ - "shape":"responseMarkerType", - "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" - } - } - }, - "ListPolicyVersionsRequest":{ - "type":"structure", - "required":["PolicyArn"], - "members":{ - "PolicyArn":{ - "shape":"arnType", - "documentation":"

The Amazon Resource Name (ARN) of the IAM policy for which you want the versions.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

" - }, - "Marker":{ - "shape":"markerType", - "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" - }, - "MaxItems":{ - "shape":"maxItemsType", - "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" - } - } - }, - "ListPolicyVersionsResponse":{ - "type":"structure", - "members":{ - "Versions":{ - "shape":"policyDocumentVersionListType", - "documentation":"

A list of policy versions.

For more information about managed policy versions, see Versioning for managed policies in the IAM User Guide.

" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" - }, - "Marker":{ - "shape":"responseMarkerType", - "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" - } - }, - "documentation":"

Contains the response to a successful ListPolicyVersions request.

" - }, - "ListRolePoliciesRequest":{ - "type":"structure", - "required":["RoleName"], - "members":{ - "RoleName":{ - "shape":"roleNameType", - "documentation":"

The name of the role to list policies for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "Marker":{ - "shape":"markerType", - "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" - }, - "MaxItems":{ - "shape":"maxItemsType", - "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" - } - } - }, - "ListRolePoliciesResponse":{ - "type":"structure", - "required":["PolicyNames"], - "members":{ - "PolicyNames":{ - "shape":"policyNameListType", - "documentation":"

A list of policy names.

" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" - }, - "Marker":{ - "shape":"responseMarkerType", - "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" - } - }, - "documentation":"

Contains the response to a successful ListRolePolicies request.

" - }, - "ListRoleTagsRequest":{ - "type":"structure", - "required":["RoleName"], - "members":{ - "RoleName":{ - "shape":"roleNameType", - "documentation":"

The name of the IAM role for which you want to see the list of tags.

This parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "Marker":{ - "shape":"markerType", - "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" - }, - "MaxItems":{ - "shape":"maxItemsType", - "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" - } - } - }, - "ListRoleTagsResponse":{ - "type":"structure", - "required":["Tags"], - "members":{ - "Tags":{ - "shape":"tagListType", - "documentation":"

The list of tags that are currently attached to the role. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" - }, - "Marker":{ - "shape":"responseMarkerType", - "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" - } - } - }, - "ListRolesRequest":{ - "type":"structure", - "members":{ - "PathPrefix":{ - "shape":"pathPrefixType", - "documentation":"

The path prefix for filtering the results. For example, the prefix /application_abc/component_xyz/ gets all roles whose path starts with /application_abc/component_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all roles. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" - }, - "Marker":{ - "shape":"markerType", - "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" - }, - "MaxItems":{ - "shape":"maxItemsType", - "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" - } - } - }, - "ListRolesResponse":{ - "type":"structure", - "required":["Roles"], - "members":{ - "Roles":{ - "shape":"roleListType", - "documentation":"

A list of roles.

" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" - }, - "Marker":{ - "shape":"responseMarkerType", - "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" - } - }, - "documentation":"

Contains the response to a successful ListRoles request.

" - }, - "ListSAMLProviderTagsRequest":{ - "type":"structure", - "required":["SAMLProviderArn"], - "members":{ - "SAMLProviderArn":{ - "shape":"arnType", - "documentation":"

The ARN of the Security Assertion Markup Language (SAML) identity provider whose tags you want to see.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "Marker":{ - "shape":"markerType", - "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" - }, - "MaxItems":{ - "shape":"maxItemsType", - "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" - } - } - }, - "ListSAMLProviderTagsResponse":{ - "type":"structure", - "required":["Tags"], - "members":{ - "Tags":{ - "shape":"tagListType", - "documentation":"

The list of tags that are currently attached to the Security Assertion Markup Language (SAML) identity provider. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" - }, - "Marker":{ - "shape":"responseMarkerType", - "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" - } - } - }, - "ListSAMLProvidersRequest":{ - "type":"structure", - "members":{} - }, - "ListSAMLProvidersResponse":{ - "type":"structure", - "members":{ - "SAMLProviderList":{ - "shape":"SAMLProviderListType", - "documentation":"

The list of SAML provider resource objects defined in IAM for this Amazon Web Services account.

" - } - }, - "documentation":"

Contains the response to a successful ListSAMLProviders request.

" - }, - "ListSSHPublicKeysRequest":{ - "type":"structure", - "members":{ - "UserName":{ - "shape":"userNameType", - "documentation":"

The name of the IAM user to list SSH public keys for. If none is specified, the UserName field is determined implicitly based on the Amazon Web Services access key used to sign the request.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "Marker":{ - "shape":"markerType", - "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" - }, - "MaxItems":{ - "shape":"maxItemsType", - "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" - } - } - }, - "ListSSHPublicKeysResponse":{ - "type":"structure", - "members":{ - "SSHPublicKeys":{ - "shape":"SSHPublicKeyListType", - "documentation":"

A list of the SSH public keys assigned to IAM user.

" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" - }, - "Marker":{ - "shape":"responseMarkerType", - "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" - } - }, - "documentation":"

Contains the response to a successful ListSSHPublicKeys request.

" - }, - "ListServerCertificateTagsRequest":{ - "type":"structure", - "required":["ServerCertificateName"], - "members":{ - "ServerCertificateName":{ - "shape":"serverCertificateNameType", - "documentation":"

The name of the IAM server certificate whose tags you want to see.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "Marker":{ - "shape":"markerType", - "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" - }, - "MaxItems":{ - "shape":"maxItemsType", - "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" - } - } - }, - "ListServerCertificateTagsResponse":{ - "type":"structure", - "required":["Tags"], - "members":{ - "Tags":{ - "shape":"tagListType", - "documentation":"

The list of tags that are currently attached to the IAM server certificate. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" - }, - "Marker":{ - "shape":"responseMarkerType", - "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" - } - } - }, - "ListServerCertificatesRequest":{ - "type":"structure", - "members":{ - "PathPrefix":{ - "shape":"pathPrefixType", - "documentation":"

The path prefix for filtering the results. For example: /company/servercerts would get all server certificates for which the path starts with /company/servercerts.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all server certificates. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" - }, - "Marker":{ - "shape":"markerType", - "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" - }, - "MaxItems":{ - "shape":"maxItemsType", - "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" - } - } - }, - "ListServerCertificatesResponse":{ - "type":"structure", - "required":["ServerCertificateMetadataList"], - "members":{ - "ServerCertificateMetadataList":{ - "shape":"serverCertificateMetadataListType", - "documentation":"

A list of server certificates.

" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" - }, - "Marker":{ - "shape":"responseMarkerType", - "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" - } - }, - "documentation":"

Contains the response to a successful ListServerCertificates request.

" - }, - "ListServiceSpecificCredentialsRequest":{ - "type":"structure", - "members":{ - "UserName":{ - "shape":"userNameType", - "documentation":"

The name of the user whose service-specific credentials you want information about. If this value is not specified, then the operation assumes the user whose credentials are used to call the operation.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "ServiceName":{ - "shape":"serviceName", - "documentation":"

Filters the returned results to only those for the specified Amazon Web Services service. If not specified, then Amazon Web Services returns service-specific credentials for all services.

" - }, - "AllUsers":{ - "shape":"allUsers", - "documentation":"

A flag indicating whether to list service specific credentials for all users. This parameter cannot be specified together with UserName. When true, returns all credentials associated with the specified service.

" - }, - "Marker":{ - "shape":"markerType", - "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker from the response that you received to indicate where the next call should start.

" - }, - "MaxItems":{ - "shape":"maxItemsType", - "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

" - } - } - }, - "ListServiceSpecificCredentialsResponse":{ - "type":"structure", - "members":{ - "ServiceSpecificCredentials":{ - "shape":"ServiceSpecificCredentialsListType", - "documentation":"

A list of structures that each contain details about a service-specific credential.

" - }, - "Marker":{ - "shape":"responseMarkerType", - "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items.

" - } - } - }, - "ListSigningCertificatesRequest":{ - "type":"structure", - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"

The name of the IAM user whose signing certificates you want to examine.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "Marker":{ - "shape":"markerType", - "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" - }, - "MaxItems":{ - "shape":"maxItemsType", - "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" - } - } - }, - "ListSigningCertificatesResponse":{ - "type":"structure", - "required":["Certificates"], - "members":{ - "Certificates":{ - "shape":"certificateListType", - "documentation":"

A list of the user's signing certificate information.

" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" - }, - "Marker":{ - "shape":"responseMarkerType", - "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" - } - }, - "documentation":"

Contains the response to a successful ListSigningCertificates request.

" - }, - "ListUserPoliciesRequest":{ - "type":"structure", - "required":["UserName"], - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"

The name of the user to list policies for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "Marker":{ - "shape":"markerType", - "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" - }, - "MaxItems":{ - "shape":"maxItemsType", - "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" - } - } - }, - "ListUserPoliciesResponse":{ - "type":"structure", - "required":["PolicyNames"], - "members":{ - "PolicyNames":{ - "shape":"policyNameListType", - "documentation":"

A list of policy names.

" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" - }, - "Marker":{ - "shape":"responseMarkerType", - "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" - } - }, - "documentation":"

Contains the response to a successful ListUserPolicies request.

" - }, - "ListUserTagsRequest":{ - "type":"structure", - "required":["UserName"], - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"

The name of the IAM user whose tags you want to see.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "Marker":{ - "shape":"markerType", - "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" - }, - "MaxItems":{ - "shape":"maxItemsType", - "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" - } - } - }, - "ListUserTagsResponse":{ - "type":"structure", - "required":["Tags"], - "members":{ - "Tags":{ - "shape":"tagListType", - "documentation":"

The list of tags that are currently attached to the user. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" - }, - "Marker":{ - "shape":"responseMarkerType", - "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" - } - } - }, - "ListUsersRequest":{ - "type":"structure", - "members":{ - "PathPrefix":{ - "shape":"pathPrefixType", - "documentation":"

The path prefix for filtering the results. For example: /division_abc/subdivision_xyz/, which would get all user names whose path starts with /division_abc/subdivision_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all user names. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" - }, - "Marker":{ - "shape":"markerType", - "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" - }, - "MaxItems":{ - "shape":"maxItemsType", - "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" - } - } - }, - "ListUsersResponse":{ - "type":"structure", - "required":["Users"], - "members":{ - "Users":{ - "shape":"userListType", - "documentation":"

A list of users.

" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" - }, - "Marker":{ - "shape":"responseMarkerType", - "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" - } - }, - "documentation":"

Contains the response to a successful ListUsers request.

" - }, - "ListVirtualMFADevicesRequest":{ - "type":"structure", - "members":{ - "AssignmentStatus":{ - "shape":"assignmentStatusType", - "documentation":"

The status (Unassigned or Assigned) of the devices to list. If you do not specify an AssignmentStatus, the operation defaults to Any, which lists both assigned and unassigned virtual MFA devices.,

" - }, - "Marker":{ - "shape":"markerType", - "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" - }, - "MaxItems":{ - "shape":"maxItemsType", - "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" - } - } - }, - "ListVirtualMFADevicesResponse":{ - "type":"structure", - "required":["VirtualMFADevices"], - "members":{ - "VirtualMFADevices":{ - "shape":"virtualMFADeviceListType", - "documentation":"

The list of virtual MFA devices in the current account that match the AssignmentStatus value that was passed in the request.

" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" - }, - "Marker":{ - "shape":"responseMarkerType", - "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" - } - }, - "documentation":"

Contains the response to a successful ListVirtualMFADevices request.

" - }, - "LoginProfile":{ - "type":"structure", - "required":[ - "UserName", - "CreateDate" - ], - "members":{ - "UserName":{ - "shape":"userNameType", - "documentation":"

The name of the user, which can be used for signing in to the Amazon Web Services Management Console.

" - }, - "CreateDate":{ - "shape":"dateType", - "documentation":"

The date when the password for the user was created.

" - }, - "PasswordResetRequired":{ - "shape":"booleanType", - "documentation":"

Specifies whether the user is required to set a new password on next sign-in.

" - } - }, - "documentation":"

Contains the user name and password create date for a user.

This data type is used as a response element in the CreateLoginProfile and GetLoginProfile operations.

" - }, - "MFADevice":{ - "type":"structure", - "required":[ - "UserName", - "SerialNumber", - "EnableDate" - ], - "members":{ - "UserName":{ - "shape":"userNameType", - "documentation":"

The user with whom the MFA device is associated.

" - }, - "SerialNumber":{ - "shape":"serialNumberType", - "documentation":"

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.

" - }, - "EnableDate":{ - "shape":"dateType", - "documentation":"

The date when the MFA device was enabled for the user.

" - } - }, - "documentation":"

Contains information about an MFA device.

This data type is used as a response element in the ListMFADevices operation.

" - }, - "MalformedCertificateException":{ - "type":"structure", - "members":{ - "message":{"shape":"malformedCertificateMessage"} - }, - "documentation":"

The request was rejected because the certificate was malformed or expired. The error message describes the specific error.

", - "error":{ - "code":"MalformedCertificate", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "MalformedPolicyDocumentException":{ - "type":"structure", - "members":{ - "message":{"shape":"malformedPolicyDocumentMessage"} - }, - "documentation":"

The request was rejected because the policy document was malformed. The error message describes the specific error.

", - "error":{ - "code":"MalformedPolicyDocument", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "ManagedPolicyDetail":{ - "type":"structure", - "members":{ - "PolicyName":{ - "shape":"policyNameType", - "documentation":"

The friendly name (not ARN) identifying the policy.

" - }, - "PolicyId":{ - "shape":"idType", - "documentation":"

The stable and unique string identifying the policy.

For more information about IDs, see IAM identifiers in the IAM User Guide.

" - }, - "Arn":{"shape":"arnType"}, - "Path":{ - "shape":"policyPathType", - "documentation":"

The path to the policy.

For more information about paths, see IAM identifiers in the IAM User Guide.

" - }, - "DefaultVersionId":{ - "shape":"policyVersionIdType", - "documentation":"

The identifier for the version of the policy that is set as the default (operative) version.

For more information about policy versions, see Versioning for managed policies in the IAM User Guide.

" - }, - "AttachmentCount":{ - "shape":"attachmentCountType", - "documentation":"

The number of principal entities (users, groups, and roles) that the policy is attached to.

" - }, - "PermissionsBoundaryUsageCount":{ - "shape":"attachmentCountType", - "documentation":"

The number of entities (users and roles) for which the policy is used as the permissions boundary.

For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.

" - }, - "IsAttachable":{ - "shape":"booleanType", - "documentation":"

Specifies whether the policy can be attached to an IAM user, group, or role.

" - }, - "Description":{ - "shape":"policyDescriptionType", - "documentation":"

A friendly description of the policy.

" - }, - "CreateDate":{ - "shape":"dateType", - "documentation":"

The date and time, in ISO 8601 date-time format, when the policy was created.

" - }, - "UpdateDate":{ - "shape":"dateType", - "documentation":"

The date and time, in ISO 8601 date-time format, when the policy was last updated.

When a policy has only one version, this field contains the date and time when the policy was created. When a policy has more than one version, this field contains the date and time when the most recent policy version was created.

" - }, - "PolicyVersionList":{ - "shape":"policyDocumentVersionListType", - "documentation":"

A list containing information about the versions of the policy.

" - } - }, - "documentation":"

Contains information about a managed policy, including the policy's ARN, versions, and the number of principal entities (users, groups, and roles) that the policy is attached to.

This data type is used as a response element in the GetAccountAuthorizationDetails operation.

For more information about managed policies, see Managed policies and inline policies in the IAM User Guide.

" - }, - "ManagedPolicyDetailListType":{ - "type":"list", - "member":{"shape":"ManagedPolicyDetail"} - }, - "NoSuchEntityException":{ - "type":"structure", - "members":{ - "message":{"shape":"noSuchEntityMessage"} - }, - "documentation":"

The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.

", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true - }, - "OpenIDConnectProviderListEntry":{ - "type":"structure", - "members":{ - "Arn":{"shape":"arnType"} - }, - "documentation":"

Contains the Amazon Resource Name (ARN) for an IAM OpenID Connect provider.

" - }, - "OpenIDConnectProviderListType":{ - "type":"list", - "member":{"shape":"OpenIDConnectProviderListEntry"}, - "documentation":"

Contains a list of IAM OpenID Connect providers.

" - }, - "OpenIDConnectProviderUrlType":{ - "type":"string", - "documentation":"

Contains a URL that specifies the endpoint for an OpenID Connect provider.

", - "max":255, - "min":1 - }, - "OpenIdIdpCommunicationErrorException":{ - "type":"structure", - "members":{ - "message":{"shape":"openIdIdpCommunicationErrorExceptionMessage"} - }, - "documentation":"

The request failed because IAM cannot connect to the OpenID Connect identity provider URL.

", - "error":{ - "code":"OpenIdIdpCommunicationError", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "OrderedOrganizationPolicyType":{ - "type":"structure", - "members":{ - "ServiceControlPolicyInputList":{ - "shape":"SimulationPolicyListType", - "documentation":"

A list of SCP documents that apply at this level of the Organizations hierarchy. Each document is specified as a string containing the complete, valid JSON text of an SCP.

" - } - }, - "documentation":"

Represents one level of an Organizations hierarchy—the organization root, an organizational unit (OU), or an account—together with the service control policies (SCPs) that apply at that level. Each element in the list represents one level of the hierarchy, ordered from the organization root down to the account.

For more information about SCPs, see Service control policies (SCPs) in the Organizations User Guide.

" - }, - "OrganizationIdType":{ - "type":"string", - "max":34, - "pattern":"^o-[a-z0-9]{10,32}$" - }, - "OrganizationNotFoundException":{ - "type":"structure", - "members":{}, - "documentation":"

The request was rejected because no organization is associated with your account.

", - "exception":true - }, - "OrganizationNotInAllFeaturesModeException":{ - "type":"structure", - "members":{}, - "documentation":"

The request was rejected because your organization does not have All features enabled. For more information, see Available feature sets in the Organizations User Guide.

", - "exception":true - }, - "OrganizationPolicyListType":{ - "type":"list", - "member":{"shape":"OrderedOrganizationPolicyType"}, - "max":7 - }, - "OrganizationsDecisionDetail":{ - "type":"structure", - "members":{ - "AllowedByOrganizations":{ - "shape":"booleanType", - "documentation":"

Specifies whether the simulated operation is allowed by the Organizations service control policies that impact the simulated user's account.

" - } - }, - "documentation":"

Contains information about the effect that Organizations has on a policy simulation.

" - }, - "PasswordPolicy":{ - "type":"structure", - "members":{ - "MinimumPasswordLength":{ - "shape":"minimumPasswordLengthType", - "documentation":"

Minimum length to require for IAM user passwords.

" - }, - "RequireSymbols":{ - "shape":"booleanType", - "documentation":"

Specifies whether IAM user passwords must contain at least one of the following symbols:

! @ # $ % ^ & * ( ) _ + - = [ ] { } | '

" - }, - "RequireNumbers":{ - "shape":"booleanType", - "documentation":"

Specifies whether IAM user passwords must contain at least one numeric character (0 to 9).

" - }, - "RequireUppercaseCharacters":{ - "shape":"booleanType", - "documentation":"

Specifies whether IAM user passwords must contain at least one uppercase character (A to Z).

" - }, - "RequireLowercaseCharacters":{ - "shape":"booleanType", - "documentation":"

Specifies whether IAM user passwords must contain at least one lowercase character (a to z).

" - }, - "AllowUsersToChangePassword":{ - "shape":"booleanType", - "documentation":"

Specifies whether IAM users are allowed to change their own password. Gives IAM users permissions to iam:ChangePassword for only their user and to the iam:GetAccountPasswordPolicy action. This option does not attach a permissions policy to each user, rather the permissions are applied at the account-level for all users by IAM.

" - }, - "ExpirePasswords":{ - "shape":"booleanType", - "documentation":"

Indicates whether passwords in the account expire. Returns true if MaxPasswordAge contains a value greater than 0. Returns false if MaxPasswordAge is 0 or not present.

" - }, - "MaxPasswordAge":{ - "shape":"maxPasswordAgeType", - "documentation":"

The number of days that an IAM user password is valid.

" - }, - "PasswordReusePrevention":{ - "shape":"passwordReusePreventionType", - "documentation":"

Specifies the number of previous passwords that IAM users are prevented from reusing.

" - }, - "HardExpiry":{ - "shape":"booleanObjectType", - "documentation":"

Specifies whether IAM users are prevented from setting a new password via the Amazon Web Services Management Console after their password has expired. The IAM user cannot access the console until an administrator resets the password. IAM users with iam:ChangePassword permission and active access keys can reset their own expired console password using the CLI or API.

" - } - }, - "documentation":"

Contains information about the account password policy.

This data type is used as a response element in the GetAccountPasswordPolicy operation.

" - }, - "PasswordPolicyViolationException":{ - "type":"structure", - "members":{ - "message":{"shape":"passwordPolicyViolationMessage"} - }, - "documentation":"

The request was rejected because the provided password did not meet the requirements imposed by the account password policy.

", - "error":{ - "code":"PasswordPolicyViolation", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "PermissionsBoundaryAttachmentType":{ - "type":"string", - "enum":["PermissionsBoundaryPolicy"] - }, - "PermissionsBoundaryDecisionDetail":{ - "type":"structure", - "members":{ - "AllowedByPermissionsBoundary":{ - "shape":"booleanType", - "documentation":"

Specifies whether an action is allowed by a permissions boundary that is applied to an IAM entity (user or role). A value of true means that the permissions boundary does not deny the action. This means that the policy includes an Allow statement that matches the request. In this case, if an identity-based policy also allows the action, the request is allowed. A value of false means that either the requested action is not allowed (implicitly denied) or that the action is explicitly denied by the permissions boundary. In both of these cases, the action is not allowed, regardless of the identity-based policy.

" - } - }, - "documentation":"

Contains information about the effect that a permissions boundary has on a policy simulation when the boundary is applied to an IAM entity.

" - }, - "Policy":{ - "type":"structure", - "members":{ - "PolicyName":{ - "shape":"policyNameType", - "documentation":"

The friendly name (not ARN) identifying the policy.

" - }, - "PolicyId":{ - "shape":"idType", - "documentation":"

The stable and unique string identifying the policy.

For more information about IDs, see IAM identifiers in the IAM User Guide.

" - }, - "Arn":{"shape":"arnType"}, - "Path":{ - "shape":"policyPathType", - "documentation":"

The path to the policy.

For more information about paths, see IAM identifiers in the IAM User Guide.

" - }, - "DefaultVersionId":{ - "shape":"policyVersionIdType", - "documentation":"

The identifier for the version of the policy that is set as the default version.

" - }, - "AttachmentCount":{ - "shape":"attachmentCountType", - "documentation":"

The number of entities (users, groups, and roles) that the policy is attached to.

" - }, - "PermissionsBoundaryUsageCount":{ - "shape":"attachmentCountType", - "documentation":"

The number of entities (users and roles) for which the policy is used to set the permissions boundary.

For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.

" - }, - "IsAttachable":{ - "shape":"booleanType", - "documentation":"

Specifies whether the policy can be attached to an IAM user, group, or role.

" - }, - "Description":{ - "shape":"policyDescriptionType", - "documentation":"

A friendly description of the policy.

This element is included in the response to the GetPolicy operation. It is not included in the response to the ListPolicies operation.

" - }, - "CreateDate":{ - "shape":"dateType", - "documentation":"

The date and time, in ISO 8601 date-time format, when the policy was created.

" - }, - "UpdateDate":{ - "shape":"dateType", - "documentation":"

The date and time, in ISO 8601 date-time format, when the policy was last updated.

When a policy has only one version, this field contains the date and time when the policy was created. When a policy has more than one version, this field contains the date and time when the most recent policy version was created.

" - }, - "Tags":{ - "shape":"tagListType", - "documentation":"

A list of tags that are attached to the instance profile. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

" - } - }, - "documentation":"

Contains information about a managed policy.

This data type is used as a response element in the CreatePolicy, GetPolicy, and ListPolicies operations.

For more information about managed policies, refer to Managed policies and inline policies in the IAM User Guide.

" - }, - "PolicyDetail":{ - "type":"structure", - "members":{ - "PolicyName":{ - "shape":"policyNameType", - "documentation":"

The name of the policy.

" - }, - "PolicyDocument":{ - "shape":"policyDocumentType", - "documentation":"

The policy document.

" - } - }, - "documentation":"

Contains information about an IAM policy, including the policy document.

This data type is used as a response element in the GetAccountAuthorizationDetails operation.

" - }, - "PolicyEvaluationDecisionType":{ - "type":"string", - "enum":[ - "allowed", - "explicitDeny", - "implicitDeny" - ] - }, - "PolicyEvaluationException":{ - "type":"structure", - "members":{ - "message":{"shape":"policyEvaluationErrorMessage"} - }, - "documentation":"

The request failed because a provided policy could not be successfully evaluated. An additional detailed message indicates the source of the failure.

", - "error":{ - "code":"PolicyEvaluation", - "httpStatusCode":500 - }, - "exception":true - }, - "PolicyExclusionsListType":{ - "type":"list", - "member":{"shape":"PolicyIdentifier"}, - "max":256 - }, - "PolicyGrantingServiceAccess":{ - "type":"structure", - "required":[ - "PolicyName", - "PolicyType" - ], - "members":{ - "PolicyName":{ - "shape":"policyNameType", - "documentation":"

The policy name.

" - }, - "PolicyType":{ - "shape":"policyType", - "documentation":"

The policy type. For more information about these policy types, see Managed policies and inline policies in the IAM User Guide.

" - }, - "PolicyArn":{"shape":"arnType"}, - "EntityType":{ - "shape":"policyOwnerEntityType", - "documentation":"

The type of entity (user or role) that used the policy to access the service to which the inline policy is attached.

This field is null for managed policies. For more information about these policy types, see Managed policies and inline policies in the IAM User Guide.

" - }, - "EntityName":{ - "shape":"entityNameType", - "documentation":"

The name of the entity (user or role) to which the inline policy is attached.

This field is null for managed policies. For more information about these policy types, see Managed policies and inline policies in the IAM User Guide.

" - } - }, - "documentation":"

Contains details about the permissions policies that are attached to the specified identity (user, group, or role).

This data type is an element of the ListPoliciesGrantingServiceAccessEntry object.

" - }, - "PolicyGroup":{ - "type":"structure", - "members":{ - "GroupName":{ - "shape":"groupNameType", - "documentation":"

The name (friendly name, not ARN) identifying the group.

" - }, - "GroupId":{ - "shape":"idType", - "documentation":"

The stable and unique string identifying the group. For more information about IDs, see IAM identifiers in the IAM User Guide.

" - } - }, - "documentation":"

Contains information about a group that a managed policy is attached to.

This data type is used as a response element in the ListEntitiesForPolicy operation.

For more information about managed policies, refer to Managed policies and inline policies in the IAM User Guide.

" - }, - "PolicyGroupListType":{ - "type":"list", - "member":{"shape":"PolicyGroup"} - }, - "PolicyIdentifier":{ - "type":"structure", - "members":{ - "PolicyType":{ - "shape":"PolicyIdentifierPolicyType", - "documentation":"

The policy type to identify. All policies of the specified type are matched.

" - }, - "PolicyArn":{ - "shape":"arnType", - "documentation":"

The Amazon Resource Name (ARN) of an Amazon Web Services managed policy or a customer managed policy that is attached to an IAM user, group, or role. Wildcard characters are supported in the resource name portion of the ARN to match multiple managed policies: use at most one * (matches any sequence of characters, including none), and any number of ? (each matches exactly one character).

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

" - }, - "InlinePolicyIdentifier":{ - "shape":"InlinePolicyIdentifierType", - "documentation":"

An inline policy identifier consisting of a policy name and the entity it is attached to. Wildcard characters (* and ?) in the entity name can match multiple entities.

" - } - }, - "documentation":"

Identifies one or more policies as a union type. Specify exactly one of PolicyType, PolicyArn, or InlinePolicyIdentifier to identify policies by their type, by Amazon Resource Name (ARN), or by the name of an inline policy and the entity it is attached to.

", - "union":true - }, - "PolicyIdentifierPolicyType":{ - "type":"string", - "enum":[ - "inline", - "aws-managed", - "user-managed", - "permission-boundary", - "scp", - "rcp" - ] - }, - "PolicyIdentifierType":{"type":"string"}, - "PolicyNotAttachableException":{ - "type":"structure", - "members":{ - "message":{"shape":"policyNotAttachableMessage"} - }, - "documentation":"

The request failed because Amazon Web Services service role policies can only be attached to the service-linked role for that service.

", - "error":{ - "code":"PolicyNotAttachable", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "PolicyParameter":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"policyParameterNameType", - "documentation":"

The name of the policy parameter.

" - }, - "Values":{ - "shape":"policyParameterValuesListType", - "documentation":"

The allowed values for the policy parameter.

" - }, - "Type":{ - "shape":"PolicyParameterTypeEnum", - "documentation":"

The data type of the policy parameter value.

" - } - }, - "documentation":"

Contains information about a policy parameter used to customize delegated permissions.

" - }, - "PolicyParameterTypeEnum":{ - "type":"string", - "enum":[ - "string", - "stringList" - ] - }, - "PolicyRole":{ - "type":"structure", - "members":{ - "RoleName":{ - "shape":"roleNameType", - "documentation":"

The name (friendly name, not ARN) identifying the role.

" - }, - "RoleId":{ - "shape":"idType", - "documentation":"

The stable and unique string identifying the role. For more information about IDs, see IAM identifiers in the IAM User Guide.

" - } - }, - "documentation":"

Contains information about a role that a managed policy is attached to.

This data type is used as a response element in the ListEntitiesForPolicy operation.

For more information about managed policies, refer to Managed policies and inline policies in the IAM User Guide.

" - }, - "PolicyRoleListType":{ - "type":"list", - "member":{"shape":"PolicyRole"} - }, - "PolicySourceType":{ - "type":"string", - "enum":[ - "user", - "group", - "role", - "aws-managed", - "user-managed", - "resource", - "none" - ] - }, - "PolicyUsageType":{ - "type":"string", - "documentation":"

The policy usage type that indicates whether the policy is used as a permissions policy or as the permissions boundary for an entity.

For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.

", - "enum":[ - "PermissionsPolicy", - "PermissionsBoundary" - ] - }, - "PolicyUser":{ - "type":"structure", - "members":{ - "UserName":{ - "shape":"userNameType", - "documentation":"

The name (friendly name, not ARN) identifying the user.

" - }, - "UserId":{ - "shape":"idType", - "documentation":"

The stable and unique string identifying the user. For more information about IDs, see IAM identifiers in the IAM User Guide.

" - } - }, - "documentation":"

Contains information about a user that a managed policy is attached to.

This data type is used as a response element in the ListEntitiesForPolicy operation.

For more information about managed policies, refer to Managed policies and inline policies in the IAM User Guide.

" - }, - "PolicyUserListType":{ - "type":"list", - "member":{"shape":"PolicyUser"} - }, - "PolicyVersion":{ - "type":"structure", - "members":{ - "Document":{ - "shape":"policyDocumentType", - "documentation":"

The policy document.

The policy document is returned in the response to the GetPolicyVersion and GetAccountAuthorizationDetails operations. It is not returned in the response to the CreatePolicyVersion or ListPolicyVersions operations.

The policy document returned in this structure is URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.

" - }, - "VersionId":{ - "shape":"policyVersionIdType", - "documentation":"

The identifier for the policy version.

Policy version identifiers always begin with v (always lowercase). When a policy is created, the first policy version is v1.

" - }, - "IsDefaultVersion":{ - "shape":"booleanType", - "documentation":"

Specifies whether the policy version is set as the policy's default version.

" - }, - "CreateDate":{ - "shape":"dateType", - "documentation":"

The date and time, in ISO 8601 date-time format, when the policy version was created.

" - } - }, - "documentation":"

Contains information about a version of a managed policy.

This data type is used as a response element in the CreatePolicyVersion, GetPolicyVersion, ListPolicyVersions, and GetAccountAuthorizationDetails operations.

For more information about managed policies, refer to Managed policies and inline policies in the IAM User Guide.

" - }, - "Position":{ - "type":"structure", - "members":{ - "Line":{ - "shape":"LineNumber", - "documentation":"

The line containing the specified position in the document.

" - }, - "Column":{ - "shape":"ColumnNumber", - "documentation":"

The column in the line containing the specified position in the document.

" - } - }, - "documentation":"

Contains the row and column of a location of a Statement element in a policy document.

This data type is used as a member of the Statement type.

" - }, - "PutGroupPolicyRequest":{ - "type":"structure", - "required":[ - "GroupName", - "PolicyName", - "PolicyDocument" - ], - "members":{ - "GroupName":{ - "shape":"groupNameType", - "documentation":"

The name of the group to associate the policy with.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-.

" - }, - "PolicyName":{ - "shape":"policyNameType", - "documentation":"

The name of the policy document.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "PolicyDocument":{ - "shape":"policyDocumentType", - "documentation":"

The policy document.

You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" - } - } - }, - "PutRolePermissionsBoundaryRequest":{ - "type":"structure", - "required":[ - "RoleName", - "PermissionsBoundary" - ], - "members":{ - "RoleName":{ - "shape":"roleNameType", - "documentation":"

The name (friendly name, not ARN) of the IAM role for which you want to set the permissions boundary.

" - }, - "PermissionsBoundary":{ - "shape":"arnType", - "documentation":"

The ARN of the managed policy that is used to set the permissions boundary for the role.

A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see Permissions boundaries for IAM entities in the IAM User Guide.

For more information about policy types, see Policy types in the IAM User Guide.

" - } - } - }, - "PutRolePolicyRequest":{ - "type":"structure", - "required":[ - "RoleName", - "PolicyName", - "PolicyDocument" - ], - "members":{ - "RoleName":{ - "shape":"roleNameType", - "documentation":"

The name of the role to associate the policy with.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "PolicyName":{ - "shape":"policyNameType", - "documentation":"

The name of the policy document.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "PolicyDocument":{ - "shape":"policyDocumentType", - "documentation":"

The policy document.

You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" - } - } - }, - "PutUserPermissionsBoundaryRequest":{ - "type":"structure", - "required":[ - "UserName", - "PermissionsBoundary" - ], - "members":{ - "UserName":{ - "shape":"userNameType", - "documentation":"

The name (friendly name, not ARN) of the IAM user for which you want to set the permissions boundary.

" - }, - "PermissionsBoundary":{ - "shape":"arnType", - "documentation":"

The ARN of the managed policy that is used to set the permissions boundary for the user.

A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see Permissions boundaries for IAM entities in the IAM User Guide.

For more information about policy types, see Policy types in the IAM User Guide.

" - } - } - }, - "PutUserPolicyRequest":{ - "type":"structure", - "required":[ - "UserName", - "PolicyName", - "PolicyDocument" - ], - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"

The name of the user to associate the policy with.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "PolicyName":{ - "shape":"policyNameType", - "documentation":"

The name of the policy document.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "PolicyDocument":{ - "shape":"policyDocumentType", - "documentation":"

The policy document.

You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" - } - } - }, - "ReasonType":{ - "type":"string", - "max":1000 - }, - "RegionNameType":{ - "type":"string", - "max":100, - "min":1 - }, - "RejectDelegationRequestRequest":{ - "type":"structure", - "required":["DelegationRequestId"], - "members":{ - "DelegationRequestId":{ - "shape":"delegationRequestIdType", - "documentation":"

The unique identifier of the delegation request to reject.

" - }, - "Notes":{ - "shape":"notesType", - "documentation":"

Optional notes explaining the reason for rejecting the delegation request.

" - } - } - }, - "RemoveClientIDFromOpenIDConnectProviderRequest":{ - "type":"structure", - "required":[ - "OpenIDConnectProviderArn", - "ClientID" - ], - "members":{ - "OpenIDConnectProviderArn":{ - "shape":"arnType", - "documentation":"

The Amazon Resource Name (ARN) of the IAM OIDC provider resource to remove the client ID from. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders operation.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

" - }, - "ClientID":{ - "shape":"clientIDType", - "documentation":"

The client ID (also known as audience) to remove from the IAM OIDC provider resource. For more information about client IDs, see CreateOpenIDConnectProvider.

" - } - } - }, - "RemoveRoleFromInstanceProfileRequest":{ - "type":"structure", - "required":[ - "InstanceProfileName", - "RoleName" - ], - "members":{ - "InstanceProfileName":{ - "shape":"instanceProfileNameType", - "documentation":"

The name of the instance profile to update.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "RoleName":{ - "shape":"roleNameType", - "documentation":"

The name of the role to remove.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - } - } - }, - "RemoveUserFromGroupRequest":{ - "type":"structure", - "required":[ - "GroupName", - "UserName" - ], - "members":{ - "GroupName":{ - "shape":"groupNameType", - "documentation":"

The name of the group to update.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "UserName":{ - "shape":"existingUserNameType", - "documentation":"

The name of the user to remove.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - } - } - }, - "ReportContentType":{"type":"blob"}, - "ReportFormatType":{ - "type":"string", - "enum":["text/csv"] - }, - "ReportGenerationLimitExceededException":{ - "type":"structure", - "members":{ - "message":{"shape":"reportGenerationLimitExceededMessage"} - }, - "documentation":"

The request failed because the maximum number of concurrent requests for this account are already running.

", - "error":{ - "code":"ReportGenerationLimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true - }, - "ReportStateDescriptionType":{"type":"string"}, - "ReportStateType":{ - "type":"string", - "enum":[ - "STARTED", - "INPROGRESS", - "COMPLETE" - ] - }, - "ResetServiceSpecificCredentialRequest":{ - "type":"structure", - "required":["ServiceSpecificCredentialId"], - "members":{ - "UserName":{ - "shape":"userNameType", - "documentation":"

The name of the IAM user associated with the service-specific credential. If this value is not specified, then the operation assumes the user whose credentials are used to call the operation.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "ServiceSpecificCredentialId":{ - "shape":"serviceSpecificCredentialId", - "documentation":"

The unique identifier of the service-specific credential.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

" - } - } - }, - "ResetServiceSpecificCredentialResponse":{ - "type":"structure", - "members":{ - "ServiceSpecificCredential":{ - "shape":"ServiceSpecificCredential", - "documentation":"

A structure with details about the updated service-specific credential, including the new password.

This is the only time that you can access the password. You cannot recover the password later, but you can reset it again.

" - } - } - }, - "ResourceHandlingOptionType":{ - "type":"string", - "max":64, - "min":1 - }, - "ResourceNameListType":{ - "type":"list", - "member":{"shape":"ResourceNameType"} - }, - "ResourceNameType":{ - "type":"string", - "max":2048, - "min":1 - }, - "ResourceSpecificResult":{ - "type":"structure", - "required":[ - "EvalResourceName", - "EvalResourceDecision" - ], - "members":{ - "EvalResourceName":{ - "shape":"ResourceNameType", - "documentation":"

The name of the simulated resource, in Amazon Resource Name (ARN) format.

" - }, - "EvalResourceDecision":{ - "shape":"PolicyEvaluationDecisionType", - "documentation":"

The result of the simulation of the simulated API operation on the resource specified in EvalResourceName.

" - }, - "MatchedStatements":{ - "shape":"StatementListType", - "documentation":"

A list of the statements in the input policies that determine the result for this part of the simulation. Remember that even if multiple statements allow the operation on the resource, if any statement denies that operation, then the explicit deny overrides any allow. In addition, the deny statement is the only entry included in the result.

" - }, - "MissingContextValues":{ - "shape":"ContextKeyNamesResultListType", - "documentation":"

A list of context keys that are required by the included input policies but that were not provided by one of the input parameters. This list is used when a list of ARNs is included in the ResourceArns parameter instead of \"*\". If you do not specify individual resources, by setting ResourceArns to \"*\" or by not including the ResourceArns parameter, then any missing context values are instead included under the EvaluationResults section. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.

" - }, - "EvalDecisionDetails":{ - "shape":"EvalDecisionDetailsType", - "documentation":"

Additional details about the results of the evaluation decision on a single resource. This parameter is returned only for cross-account simulations. This parameter explains how each policy type contributes to the resource-specific evaluation decision.

" - }, - "PermissionsBoundaryDecisionDetail":{ - "shape":"PermissionsBoundaryDecisionDetail", - "documentation":"

Contains information about the effect that a permissions boundary has on a policy simulation when that boundary is applied to an IAM entity.

" - } - }, - "documentation":"

Contains the result of the simulation of a single API operation call on a single resource.

This data type is used by a member of the EvaluationResult data type.

" - }, - "ResourceSpecificResultListType":{ - "type":"list", - "member":{"shape":"ResourceSpecificResult"} - }, - "ResyncMFADeviceRequest":{ - "type":"structure", - "required":[ - "UserName", - "SerialNumber", - "AuthenticationCode1", - "AuthenticationCode2" - ], - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"

The name of the user whose MFA device you want to resynchronize.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "SerialNumber":{ - "shape":"serialNumberType", - "documentation":"

Serial number that uniquely identifies the MFA device.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "AuthenticationCode1":{ - "shape":"authenticationCodeType", - "documentation":"

An authentication code emitted by the device.

The format for this parameter is a sequence of six digits.

" - }, - "AuthenticationCode2":{ - "shape":"authenticationCodeType", - "documentation":"

A subsequent authentication code emitted by the device.

The format for this parameter is a sequence of six digits.

" - } - } - }, - "Role":{ - "type":"structure", - "required":[ - "Path", - "RoleName", - "RoleId", - "Arn", - "CreateDate" - ], - "members":{ - "Path":{ - "shape":"pathType", - "documentation":"

The path to the role. For more information about paths, see IAM identifiers in the IAM User Guide.

" - }, - "RoleName":{ - "shape":"roleNameType", - "documentation":"

The friendly name that identifies the role.

" - }, - "RoleId":{ - "shape":"idType", - "documentation":"

The stable and unique string identifying the role. For more information about IDs, see IAM identifiers in the IAM User Guide.

" - }, - "Arn":{ - "shape":"arnType", - "documentation":"

The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in policies, see IAM identifiers in the IAM User Guide guide.

" - }, - "CreateDate":{ - "shape":"dateType", - "documentation":"

The date and time, in ISO 8601 date-time format, when the role was created.

" - }, - "AssumeRolePolicyDocument":{ - "shape":"policyDocumentType", - "documentation":"

The policy that grants an entity permission to assume the role.

" - }, - "Description":{ - "shape":"roleDescriptionType", - "documentation":"

A description of the role that you provide.

" - }, - "MaxSessionDuration":{ - "shape":"roleMaxSessionDurationType", - "documentation":"

The maximum session duration (in seconds) for the specified role. Anyone who uses the CLI, or API to assume the role can specify the duration using the optional DurationSeconds API parameter or duration-seconds CLI parameter.

" - }, - "PermissionsBoundary":{ - "shape":"AttachedPermissionsBoundary", - "documentation":"

The ARN of the policy used to set the permissions boundary for the role.

For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.

" - }, - "Tags":{ - "shape":"tagListType", - "documentation":"

A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

" - }, - "RoleLastUsed":{ - "shape":"RoleLastUsed", - "documentation":"

Contains information about the last time that an IAM role was used. This includes the date and time and the Region in which the role was last used. Activity is only reported for the trailing 400 days. This period can be shorter if your Region began supporting these features within the last year. The role might have been used more than 400 days ago. For more information, see Regions where data is tracked in the IAM user Guide.

" - } - }, - "documentation":"

Contains information about an IAM role. This structure is returned as a response element in several API operations that interact with roles.

" - }, - "RoleDetail":{ - "type":"structure", - "members":{ - "Path":{ - "shape":"pathType", - "documentation":"

The path to the role. For more information about paths, see IAM identifiers in the IAM User Guide.

" - }, - "RoleName":{ - "shape":"roleNameType", - "documentation":"

The friendly name that identifies the role.

" - }, - "RoleId":{ - "shape":"idType", - "documentation":"

The stable and unique string identifying the role. For more information about IDs, see IAM identifiers in the IAM User Guide.

" - }, - "Arn":{"shape":"arnType"}, - "CreateDate":{ - "shape":"dateType", - "documentation":"

The date and time, in ISO 8601 date-time format, when the role was created.

" - }, - "AssumeRolePolicyDocument":{ - "shape":"policyDocumentType", - "documentation":"

The trust policy that grants permission to assume the role.

" - }, - "InstanceProfileList":{ - "shape":"instanceProfileListType", - "documentation":"

A list of instance profiles that contain this role.

" - }, - "RolePolicyList":{ - "shape":"policyDetailListType", - "documentation":"

A list of inline policies embedded in the role. These policies are the role's access (permissions) policies.

" - }, - "AttachedManagedPolicies":{ - "shape":"attachedPoliciesListType", - "documentation":"

A list of managed policies attached to the role. These policies are the role's access (permissions) policies.

" - }, - "PermissionsBoundary":{ - "shape":"AttachedPermissionsBoundary", - "documentation":"

The ARN of the policy used to set the permissions boundary for the role.

For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.

" - }, - "Tags":{ - "shape":"tagListType", - "documentation":"

A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

" - }, - "RoleLastUsed":{ - "shape":"RoleLastUsed", - "documentation":"

Contains information about the last time that an IAM role was used. This includes the date and time and the Region in which the role was last used. Activity is only reported for the trailing 400 days. This period can be shorter if your Region began supporting these features within the last year. The role might have been used more than 400 days ago. For more information, see Regions where data is tracked in the IAM User Guide.

" - } - }, - "documentation":"

Contains information about an IAM role, including all of the role's policies.

This data type is used as a response element in the GetAccountAuthorizationDetails operation.

" - }, - "RoleLastUsed":{ - "type":"structure", - "members":{ - "LastUsedDate":{ - "shape":"dateType", - "documentation":"

The date and time, in ISO 8601 date-time format that the role was last used.

This field is null if the role has not been used within the IAM tracking period. For more information about the tracking period, see Regions where data is tracked in the IAM User Guide.

" - }, - "Region":{ - "shape":"stringType", - "documentation":"

The name of the Amazon Web Services Region in which the role was last used.

" - } - }, - "documentation":"

Contains information about the last time that an IAM role was used. This includes the date and time and the Region in which the role was last used. Activity is only reported for the trailing 400 days. This period can be shorter if your Region began supporting these features within the last year. The role might have been used more than 400 days ago. For more information, see Regions where data is tracked in the IAM user Guide.

This data type is returned as a response element in the GetRole and GetAccountAuthorizationDetails operations.

" - }, - "RoleUsageListType":{ - "type":"list", - "member":{"shape":"RoleUsageType"} - }, - "RoleUsageType":{ - "type":"structure", - "members":{ - "Region":{ - "shape":"RegionNameType", - "documentation":"

The name of the Region where the service-linked role is being used.

" - }, - "Resources":{ - "shape":"ArnListType", - "documentation":"

The name of the resource that is using the service-linked role.

" - } - }, - "documentation":"

An object that contains details about how a service-linked role is used, if that information is returned by the service.

This data type is used as a response element in the GetServiceLinkedRoleDeletionStatus operation.

" - }, - "SAMLMetadataDocumentType":{ - "type":"string", - "max":10000000, - "min":1000 - }, - "SAMLPrivateKey":{ - "type":"structure", - "members":{ - "KeyId":{ - "shape":"privateKeyIdType", - "documentation":"

The unique identifier for the SAML private key.

" - }, - "Timestamp":{ - "shape":"dateType", - "documentation":"

The date and time, in ISO 8601 date-time format, when the private key was uploaded.

" - } - }, - "documentation":"

Contains the private keys for the SAML provider.

This data type is used as a response element in the GetSAMLProvider operation.

" - }, - "SAMLProviderListEntry":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"arnType", - "documentation":"

The Amazon Resource Name (ARN) of the SAML provider.

" - }, - "ValidUntil":{ - "shape":"dateType", - "documentation":"

The expiration date and time for the SAML provider.

" - }, - "CreateDate":{ - "shape":"dateType", - "documentation":"

The date and time when the SAML provider was created.

" - } - }, - "documentation":"

Contains the list of SAML providers for this account.

" - }, - "SAMLProviderListType":{ - "type":"list", - "member":{"shape":"SAMLProviderListEntry"} - }, - "SAMLProviderNameType":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[\\w._-]+" - }, - "SSHPublicKey":{ - "type":"structure", - "required":[ - "UserName", - "SSHPublicKeyId", - "Fingerprint", - "SSHPublicKeyBody", - "Status" - ], - "members":{ - "UserName":{ - "shape":"userNameType", - "documentation":"

The name of the IAM user associated with the SSH public key.

" - }, - "SSHPublicKeyId":{ - "shape":"publicKeyIdType", - "documentation":"

The unique identifier for the SSH public key.

" - }, - "Fingerprint":{ - "shape":"publicKeyFingerprintType", - "documentation":"

The MD5 message digest of the SSH public key.

" - }, - "SSHPublicKeyBody":{ - "shape":"publicKeyMaterialType", - "documentation":"

The SSH public key.

" - }, - "Status":{ - "shape":"statusType", - "documentation":"

The status of the SSH public key. Active means that the key can be used for authentication with an CodeCommit repository. Inactive means that the key cannot be used.

" - }, - "UploadDate":{ - "shape":"dateType", - "documentation":"

The date and time, in ISO 8601 date-time format, when the SSH public key was uploaded.

" - } - }, - "documentation":"

Contains information about an SSH public key.

This data type is used as a response element in the GetSSHPublicKey and UploadSSHPublicKey operations.

" - }, - "SSHPublicKeyListType":{ - "type":"list", - "member":{"shape":"SSHPublicKeyMetadata"} - }, - "SSHPublicKeyMetadata":{ - "type":"structure", - "required":[ - "UserName", - "SSHPublicKeyId", - "Status", - "UploadDate" - ], - "members":{ - "UserName":{ - "shape":"userNameType", - "documentation":"

The name of the IAM user associated with the SSH public key.

" - }, - "SSHPublicKeyId":{ - "shape":"publicKeyIdType", - "documentation":"

The unique identifier for the SSH public key.

" - }, - "Status":{ - "shape":"statusType", - "documentation":"

The status of the SSH public key. Active means that the key can be used for authentication with an CodeCommit repository. Inactive means that the key cannot be used.

" - }, - "UploadDate":{ - "shape":"dateType", - "documentation":"

The date and time, in ISO 8601 date-time format, when the SSH public key was uploaded.

" - } - }, - "documentation":"

Contains information about an SSH public key, without the key's body or fingerprint.

This data type is used as a response element in the ListSSHPublicKeys operation.

" - }, - "SendDelegationTokenRequest":{ - "type":"structure", - "required":["DelegationRequestId"], - "members":{ - "DelegationRequestId":{ - "shape":"delegationRequestIdType", - "documentation":"

The unique identifier of the delegation request for which to send the token.

" - } - } - }, - "ServerCertificate":{ - "type":"structure", - "required":[ - "ServerCertificateMetadata", - "CertificateBody" - ], - "members":{ - "ServerCertificateMetadata":{ - "shape":"ServerCertificateMetadata", - "documentation":"

The meta information of the server certificate, such as its name, path, ID, and ARN.

" - }, - "CertificateBody":{ - "shape":"certificateBodyType", - "documentation":"

The contents of the public key certificate.

" - }, - "CertificateChain":{ - "shape":"certificateChainType", - "documentation":"

The contents of the public key certificate chain.

" - }, - "Tags":{ - "shape":"tagListType", - "documentation":"

A list of tags that are attached to the server certificate. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

" - } - }, - "documentation":"

Contains information about a server certificate.

This data type is used as a response element in the GetServerCertificate operation.

" - }, - "ServerCertificateMetadata":{ - "type":"structure", - "required":[ - "Path", - "ServerCertificateName", - "ServerCertificateId", - "Arn" - ], - "members":{ - "Path":{ - "shape":"pathType", - "documentation":"

The path to the server certificate. For more information about paths, see IAM identifiers in the IAM User Guide.

" - }, - "ServerCertificateName":{ - "shape":"serverCertificateNameType", - "documentation":"

The name that identifies the server certificate.

" - }, - "ServerCertificateId":{ - "shape":"idType", - "documentation":"

The stable and unique string identifying the server certificate. For more information about IDs, see IAM identifiers in the IAM User Guide.

" - }, - "Arn":{ - "shape":"arnType", - "documentation":"

The Amazon Resource Name (ARN) specifying the server certificate. For more information about ARNs and how to use them in policies, see IAM identifiers in the IAM User Guide.

" - }, - "UploadDate":{ - "shape":"dateType", - "documentation":"

The date when the server certificate was uploaded.

" - }, - "Expiration":{ - "shape":"dateType", - "documentation":"

The date on which the certificate is set to expire.

" - } - }, - "documentation":"

Contains information about a server certificate without its certificate body, certificate chain, and private key.

This data type is used as a response element in the UploadServerCertificate and ListServerCertificates operations.

" - }, - "ServiceAccessNotEnabledException":{ - "type":"structure", - "members":{}, - "documentation":"

The request was rejected because trusted access is not enabled for IAM in Organizations. For details, see IAM and Organizations in the Organizations User Guide.

", - "exception":true - }, - "ServiceFailureException":{ - "type":"structure", - "members":{ - "message":{"shape":"serviceFailureExceptionMessage"} - }, - "documentation":"

The request processing has failed because of an unknown error, exception or failure.

", - "error":{ - "code":"ServiceFailure", - "httpStatusCode":500 - }, - "exception":true - }, - "ServiceLastAccessed":{ - "type":"structure", - "required":[ - "ServiceName", - "ServiceNamespace" - ], - "members":{ - "ServiceName":{ - "shape":"serviceNameType", - "documentation":"

The name of the service in which access was attempted.

" - }, - "LastAuthenticated":{ - "shape":"dateType", - "documentation":"

The date and time, in ISO 8601 date-time format, when an authenticated entity most recently attempted to access the service. Amazon Web Services does not report unauthenticated requests.

This field is null if no IAM entities attempted to access the service within the tracking period.

" - }, - "ServiceNamespace":{ - "shape":"serviceNamespaceType", - "documentation":"

The namespace of the service in which access was attempted.

To learn the service namespace of a service, see Actions, resources, and condition keys for Amazon Web Services services in the Service Authorization Reference. Choose the name of the service to view details for that service. In the first paragraph, find the service prefix. For example, (service prefix: a4b). For more information about service namespaces, see Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

" - }, - "LastAuthenticatedEntity":{ - "shape":"arnType", - "documentation":"

The ARN of the authenticated entity (user or role) that last attempted to access the service. Amazon Web Services does not report unauthenticated requests.

This field is null if no IAM entities attempted to access the service within the tracking period.

" - }, - "LastAuthenticatedRegion":{ - "shape":"stringType", - "documentation":"

The Region from which the authenticated entity (user or role) last attempted to access the service. Amazon Web Services does not report unauthenticated requests.

This field is null if no IAM entities attempted to access the service within the tracking period.

" - }, - "TotalAuthenticatedEntities":{ - "shape":"integerType", - "documentation":"

The total number of authenticated principals (root user, IAM users, or IAM roles) that have attempted to access the service.

This field is null if no principals attempted to access the service within the tracking period.

" - }, - "TrackedActionsLastAccessed":{ - "shape":"TrackedActionsLastAccessed", - "documentation":"

An object that contains details about the most recent attempt to access a tracked action within the service.

This field is null if there no tracked actions or if the principal did not use the tracked actions within the tracking period. This field is also null if the report was generated at the service level and not the action level. For more information, see the Granularity field in GenerateServiceLastAccessedDetails.

" - } - }, - "documentation":"

Contains details about the most recent attempt to access the service.

This data type is used as a response element in the GetServiceLastAccessedDetails operation.

" - }, - "ServiceNotSupportedException":{ - "type":"structure", - "members":{ - "message":{"shape":"serviceNotSupportedMessage"} - }, - "documentation":"

The specified service does not support service-specific credentials.

", - "error":{ - "code":"NotSupportedService", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true - }, - "ServiceSpecificCredential":{ - "type":"structure", - "required":[ - "CreateDate", - "ServiceName", - "ServiceSpecificCredentialId", - "UserName", - "Status" - ], - "members":{ - "CreateDate":{ - "shape":"dateType", - "documentation":"

The date and time, in ISO 8601 date-time format, when the service-specific credential were created.

" - }, - "ExpirationDate":{ - "shape":"dateType", - "documentation":"

The date and time when the service specific credential expires. This field is only present for Bedrock API keys and CloudWatch Logs API keys that were created with an expiration period.

" - }, - "ServiceName":{ - "shape":"serviceName", - "documentation":"

The name of the service associated with the service-specific credential.

" - }, - "ServiceUserName":{ - "shape":"serviceUserName", - "documentation":"

The generated user name for the service-specific credential. This value is generated by combining the IAM user's name combined with the ID number of the Amazon Web Services account, as in jane-at-123456789012, for example. This value cannot be configured by the user.

" - }, - "ServicePassword":{ - "shape":"servicePassword", - "documentation":"

The generated password for the service-specific credential.

" - }, - "ServiceCredentialAlias":{ - "shape":"serviceCredentialAlias", - "documentation":"

For Bedrock API keys and CloudWatch Logs API keys, this is the public portion of the credential that includes the IAM user name and a suffix containing version and creation information.

" - }, - "ServiceCredentialSecret":{ - "shape":"serviceCredentialSecret", - "documentation":"

For Bedrock API keys and CloudWatch Logs API keys, this is the secret portion of the credential that should be used to authenticate API calls. This value is returned only when the credential is created.

" - }, - "ServiceSpecificCredentialId":{ - "shape":"serviceSpecificCredentialId", - "documentation":"

The unique identifier for the service-specific credential.

" - }, - "UserName":{ - "shape":"userNameType", - "documentation":"

The name of the IAM user associated with the service-specific credential.

" - }, - "Status":{ - "shape":"statusType", - "documentation":"

The status of the service-specific credential. Active means that the key is valid for API calls, while Inactive means it is not.

" - } - }, - "documentation":"

Contains the details of a service-specific credential.

" - }, - "ServiceSpecificCredentialMetadata":{ - "type":"structure", - "required":[ - "UserName", - "Status", - "CreateDate", - "ServiceSpecificCredentialId", - "ServiceName" - ], - "members":{ - "UserName":{ - "shape":"userNameType", - "documentation":"

The name of the IAM user associated with the service-specific credential.

" - }, - "Status":{ - "shape":"statusType", - "documentation":"

The status of the service-specific credential. Active means that the key is valid for API calls, while Inactive means it is not.

" - }, - "ServiceUserName":{ - "shape":"serviceUserName", - "documentation":"

The generated user name for the service-specific credential.

" - }, - "ServiceCredentialAlias":{ - "shape":"serviceCredentialAlias", - "documentation":"

For Bedrock API keys and CloudWatch Logs API keys, this is the public portion of the credential that includes the IAM user name and a suffix containing version and creation information.

" - }, - "CreateDate":{ - "shape":"dateType", - "documentation":"

The date and time, in ISO 8601 date-time format, when the service-specific credential were created.

" - }, - "ExpirationDate":{ - "shape":"dateType", - "documentation":"

The date and time when the service specific credential expires. This field is only present for Bedrock API keys and CloudWatch Logs API keys that were created with an expiration period.

" - }, - "ServiceSpecificCredentialId":{ - "shape":"serviceSpecificCredentialId", - "documentation":"

The unique identifier for the service-specific credential.

" - }, - "ServiceName":{ - "shape":"serviceName", - "documentation":"

The name of the service associated with the service-specific credential.

" - } - }, - "documentation":"

Contains additional details about a service-specific credential.

" - }, - "ServiceSpecificCredentialsListType":{ - "type":"list", - "member":{"shape":"ServiceSpecificCredentialMetadata"} - }, - "ServicesLastAccessed":{ - "type":"list", - "member":{"shape":"ServiceLastAccessed"} - }, - "SetDefaultPolicyVersionRequest":{ - "type":"structure", - "required":[ - "PolicyArn", - "VersionId" - ], - "members":{ - "PolicyArn":{ - "shape":"arnType", - "documentation":"

The Amazon Resource Name (ARN) of the IAM policy whose default version you want to set.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

" - }, - "VersionId":{ - "shape":"policyVersionIdType", - "documentation":"

The version of the policy to set as the default (operative) version.

For more information about managed policy versions, see Versioning for managed policies in the IAM User Guide.

" - } - } - }, - "SetSecurityTokenServicePreferencesRequest":{ - "type":"structure", - "required":["GlobalEndpointTokenVersion"], - "members":{ - "GlobalEndpointTokenVersion":{ - "shape":"globalEndpointTokenVersion", - "documentation":"

The version of the global endpoint token. Version 1 tokens are valid only in Amazon Web Services Regions that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily store tokens.

For information, see Activating and deactivating STS in an Amazon Web Services Region in the IAM User Guide.

" - } - } - }, - "SigningCertificate":{ - "type":"structure", - "required":[ - "UserName", - "CertificateId", - "CertificateBody", - "Status" - ], - "members":{ - "UserName":{ - "shape":"userNameType", - "documentation":"

The name of the user the signing certificate is associated with.

" - }, - "CertificateId":{ - "shape":"certificateIdType", - "documentation":"

The ID for the signing certificate.

" - }, - "CertificateBody":{ - "shape":"certificateBodyType", - "documentation":"

The contents of the signing certificate.

" - }, - "Status":{ - "shape":"statusType", - "documentation":"

The status of the signing certificate. Active means that the key is valid for API calls, while Inactive means it is not.

" - }, - "UploadDate":{ - "shape":"dateType", - "documentation":"

The date when the signing certificate was uploaded.

" - } - }, - "documentation":"

Contains information about an X.509 signing certificate.

This data type is used as a response element in the UploadSigningCertificate and ListSigningCertificates operations.

" - }, - "SimulateCustomPolicyRequest":{ - "type":"structure", - "required":[ - "PolicyInputList", - "ActionNames" - ], - "members":{ - "PolicyInputList":{ - "shape":"SimulationPolicyListType", - "documentation":"

A list of policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy. Do not include any resource-based policies in this parameter. Any resource-based policy must be submitted with the ResourcePolicy parameter. The policies cannot be \"scope-down\" policies, such as you could include in a call to GetFederationToken or one of the AssumeRole API operations. In other words, do not use policies designed to restrict what a user can do while using the temporary credentials.

The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" - }, - "PermissionsBoundaryPolicyInputList":{ - "shape":"SimulationPolicyListType", - "documentation":"

The IAM permissions boundary policy to simulate. The permissions boundary sets the maximum permissions that an IAM entity can have. You can input only one permissions boundary when you pass a policy to this operation. For more information about permissions boundaries, see Permissions boundaries for IAM entities in the IAM User Guide. The policy input is specified as a string that contains the complete, valid JSON text of a permissions boundary policy.

The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" - }, - "OrderedOrganizationPolicyInputList":{ - "shape":"OrganizationPolicyListType", - "documentation":"

An ordered list of service control policies (SCPs) to include in the simulation. Each element represents one level of an Organizations hierarchy, from the organization root to the account.

The simulator evaluates SCPs in the order that you provide, consistent with how Organizations enforces SCPs. The first element must represent the organization root, and the last element must represent the account. Any elements between them represent organizational units (OUs) in descending order.

Use this parameter to simulate the effect of an SCP hierarchy without calling SimulatePrincipalPolicy.

" - }, - "ActionNames":{ - "shape":"ActionNameListType", - "documentation":"

A list of names of API operations to evaluate in the simulation. Each operation is evaluated against each resource. Each operation must include the service identifier, such as iam:CreateUser. This operation does not support using wildcards (*) in an action name.

" - }, - "ResourceArns":{ - "shape":"ResourceNameListType", - "documentation":"

A list of ARNs of Amazon Web Services resources to include in the simulation. If this parameter is not provided, then the value defaults to * (all resources). Each API in the ActionNames parameter is evaluated for each resource in this list. The simulation determines the access result (allowed or denied) of each combination and reports it in the response. You can simulate resources that don't exist in your account.

The simulation does not automatically retrieve policies for the specified resources. If you want to include a resource policy in the simulation, then you must include the policy as a string in the ResourcePolicy parameter.

If you include a ResourcePolicy, then it must be applicable to all of the resources included in the simulation or you receive an invalid input error.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

Simulation of resource-based policies isn't supported for IAM roles.

" - }, - "ResourcePolicy":{ - "shape":"policyDocumentType", - "documentation":"

A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation.

The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

Simulation of resource-based policies isn't supported for IAM roles.

" - }, - "ResourceOwner":{ - "shape":"ResourceNameType", - "documentation":"

An ARN representing the Amazon Web Services account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN. Examples of resource ARNs include an S3 bucket or object. If ResourceOwner is specified, it is also used as the account owner of any ResourcePolicy included in the simulation. If the ResourceOwner parameter is not specified, then the owner of the resources and the resource policy defaults to the account of the identity provided in CallerArn. This parameter is required only if you specify a resource-based policy and account that owns the resource is different from the account that owns the simulated calling user CallerArn.

The ARN for an account uses the following syntax: arn:aws:iam::AWS-account-ID:root. For example, to represent the account with the 112233445566 ID, use the following ARN: arn:aws:iam::112233445566-ID:root.

" - }, - "CallerArn":{ - "shape":"ResourceNameType", - "documentation":"

The ARN of the IAM user, group, or role that you want to use as the simulated caller of the API operations. CallerArn is required if you include a ResourcePolicy so that the policy's Principal element has a value to use in evaluating the policy.

You cannot specify the ARN of an assumed role, federated user, or a service principal.

" - }, - "ContextEntries":{ - "shape":"ContextEntryListType", - "documentation":"

A list of context keys and corresponding values for the simulation to use. Whenever a context key is evaluated in one of the simulated IAM permissions policies, the corresponding value is supplied.

" - }, - "ResourceHandlingOption":{ - "shape":"ResourceHandlingOptionType", - "documentation":"

Specifies the type of simulation to run. Different API operations that support resource-based policies require different combinations of resources. By specifying the type of simulation to run, you enable the policy simulator to enforce the presence of the required resources to ensure reliable simulation results. If your simulation does not match one of the following scenarios, then you can omit this parameter. The following list shows each of the supported scenario values and the resources that you must define to run the simulation.

Each of the Amazon EC2 scenarios requires that you specify instance, image, and security group resources. If your scenario includes an EBS volume, then you must specify that volume as a resource. If the Amazon EC2 scenario includes VPC, then you must supply the network interface resource. If it includes an IP subnet, then you must specify the subnet resource. For more information on the Amazon EC2 scenario options, see Supported platforms in the Amazon EC2 User Guide.

  • EC2-VPC-InstanceStore

    instance, image, security group, network interface

  • EC2-VPC-InstanceStore-Subnet

    instance, image, security group, network interface, subnet

  • EC2-VPC-EBS

    instance, image, security group, network interface, volume

  • EC2-VPC-EBS-Subnet

    instance, image, security group, network interface, subnet, volume

" - }, - "MaxItems":{ - "shape":"maxItemsType", - "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" - }, - "Marker":{ - "shape":"markerType", - "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" - } - } - }, - "SimulatePolicyResponse":{ - "type":"structure", - "members":{ - "EvaluationResults":{ - "shape":"EvaluationResultsListType", - "documentation":"

The results of the simulation.

" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" - }, - "Marker":{ - "shape":"responseMarkerType", - "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" - } - }, - "documentation":"

Contains the response to a successful SimulatePrincipalPolicy or SimulateCustomPolicy request.

" - }, - "SimulatePrincipalPolicyRequest":{ - "type":"structure", - "required":[ - "PolicySourceArn", - "ActionNames" - ], - "members":{ - "PolicySourceArn":{ - "shape":"arnType", - "documentation":"

The Amazon Resource Name (ARN) of a user, group, or role whose policies you want to include in the simulation. If you specify a user, group, or role, the simulation includes all policies that are associated with that entity. If you specify a user, the simulation also includes all policies that are attached to any groups the user belongs to.

The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

" - }, - "PolicyInputList":{ - "shape":"SimulationPolicyListType", - "documentation":"

An optional list of additional policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" - }, - "PermissionsBoundaryPolicyInputList":{ - "shape":"SimulationPolicyListType", - "documentation":"

The IAM permissions boundary policy to simulate. The permissions boundary sets the maximum permissions that the entity can have. You can input only one permissions boundary when you pass a policy to this operation. An IAM entity can only have one permissions boundary in effect at a time. For example, if a permissions boundary is attached to an entity and you pass in a different permissions boundary policy using this parameter, then the new permissions boundary policy is used for the simulation. For more information about permissions boundaries, see Permissions boundaries for IAM entities in the IAM User Guide. The policy input is specified as a string containing the complete, valid JSON text of a permissions boundary policy.

The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" - }, - "PolicyExclusionList":{ - "shape":"PolicyExclusionsListType", - "documentation":"

A list of policies to exclude from the simulation. Use this parameter to test what the simulation result would be if a policy were removed, without changing which policies are actually attached to the principal identified by PolicySourceArn.

Each entry is a PolicyIdentifier that identifies one or more policies to exclude by policy type, by Amazon Resource Name (ARN), or by the name of an inline policy and the entity it is attached to.

Syntactically invalid identifiers, such as malformed ARNs or wildcards in disallowed positions, cause the request to fail with an InvalidInput error. Syntactically valid identifiers that don't match any attached policy are ignored. Resource control policies (RCPs) are not supported in this release; identifiers that target RCPs are also ignored.

" - }, - "ActionNames":{ - "shape":"ActionNameListType", - "documentation":"

A list of names of API operations to evaluate in the simulation. Each operation is evaluated for each resource. Each operation must include the service identifier, such as iam:CreateUser.

" - }, - "ResourceArns":{ - "shape":"ResourceNameListType", - "documentation":"

A list of ARNs of Amazon Web Services resources to include in the simulation. If this parameter is not provided, then the value defaults to * (all resources). Each API in the ActionNames parameter is evaluated for each resource in this list. The simulation determines the access result (allowed or denied) of each combination and reports it in the response. You can simulate resources that don't exist in your account.

The simulation does not automatically retrieve policies for the specified resources. If you want to include a resource policy in the simulation, then you must include the policy as a string in the ResourcePolicy parameter.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

Simulation of resource-based policies isn't supported for IAM roles.

" - }, - "ResourcePolicy":{ - "shape":"policyDocumentType", - "documentation":"

A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation.

The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

Simulation of resource-based policies isn't supported for IAM roles.

" - }, - "ResourceOwner":{ - "shape":"ResourceNameType", - "documentation":"

An Amazon Web Services account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN. Examples of resource ARNs include an S3 bucket or object. If ResourceOwner is specified, it is also used as the account owner of any ResourcePolicy included in the simulation. If the ResourceOwner parameter is not specified, then the owner of the resources and the resource policy defaults to the account of the identity provided in CallerArn. This parameter is required only if you specify a resource-based policy and account that owns the resource is different from the account that owns the simulated calling user CallerArn.

" - }, - "CallerArn":{ - "shape":"ResourceNameType", - "documentation":"

The ARN of the IAM user, group, or role that you want to specify as the simulated caller of the API operations. If you do not specify a CallerArn, it defaults to the ARN of the user, group, or role that you specify in PolicySourceArn. If you include both a PolicySourceArn (for example, arn:aws:iam::123456789012:user/David) and a CallerArn (for example, arn:aws:iam::123456789012:user/Bob), the result is that you simulate calling the API operations as Bob, as if Bob had David's policies.

You can specify the ARN of an IAM user, group, or role. You cannot specify the ARN of an assumed role, federated user, or a service principal.

CallerArn is required if you include a ResourcePolicy and the PolicySourceArn is not the ARN for an IAM user, group, or role. This is required so that the resource-based policy's Principal element has a value to use in evaluating the policy.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

" - }, - "ContextEntries":{ - "shape":"ContextEntryListType", - "documentation":"

A list of context keys and corresponding values for the simulation to use. Whenever a context key is evaluated in one of the simulated IAM permissions policies, the corresponding value is supplied.

" - }, - "ResourceHandlingOption":{ - "shape":"ResourceHandlingOptionType", - "documentation":"

Specifies the type of simulation to run. Different API operations that support resource-based policies require different combinations of resources. By specifying the type of simulation to run, you enable the policy simulator to enforce the presence of the required resources to ensure reliable simulation results. If your simulation does not match one of the following scenarios, then you can omit this parameter. The following list shows each of the supported scenario values and the resources that you must define to run the simulation.

Each of the Amazon EC2 scenarios requires that you specify instance, image, and security group resources. If your scenario includes an EBS volume, then you must specify that volume as a resource. If the Amazon EC2 scenario includes VPC, then you must supply the network interface resource. If it includes an IP subnet, then you must specify the subnet resource. For more information on the Amazon EC2 scenario options, see Supported platforms in the Amazon EC2 User Guide.

  • EC2-VPC-InstanceStore

    instance, image, security group, network interface

  • EC2-VPC-InstanceStore-Subnet

    instance, image, security group, network interface, subnet

  • EC2-VPC-EBS

    instance, image, security group, network interface, volume

  • EC2-VPC-EBS-Subnet

    instance, image, security group, network interface, subnet, volume

" - }, - "MaxItems":{ - "shape":"maxItemsType", - "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" - }, - "Marker":{ - "shape":"markerType", - "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" - } - } - }, - "SimulationPolicyListType":{ - "type":"list", - "member":{"shape":"policyDocumentType"} - }, - "Statement":{ - "type":"structure", - "members":{ - "SourcePolicyId":{ - "shape":"PolicyIdentifierType", - "documentation":"

The identifier of the policy that was provided as an input.

" - }, - "SourcePolicyType":{ - "shape":"PolicySourceType", - "documentation":"

The type of the policy.

" - }, - "StartPosition":{ - "shape":"Position", - "documentation":"

The row and column of the beginning of the Statement in an IAM policy.

" - }, - "EndPosition":{ - "shape":"Position", - "documentation":"

The row and column of the end of a Statement in an IAM policy.

" - } - }, - "documentation":"

Contains a reference to a Statement element in a policy document that determines the result of the simulation.

This data type is used by the MatchedStatements member of the EvaluationResult type.

" - }, - "StatementListType":{ - "type":"list", - "member":{"shape":"Statement"} - }, - "Tag":{ - "type":"structure", - "required":[ - "Key", - "Value" - ], - "members":{ - "Key":{ - "shape":"tagKeyType", - "documentation":"

The key name that can be used to look up or retrieve the associated value. For example, Department or Cost Center are common choices.

" - }, - "Value":{ - "shape":"tagValueType", - "documentation":"

The value associated with this tag. For example, tags with a key name of Department could have values such as Human Resources, Accounting, and Support. Tags with a key name of Cost Center might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.

" - } - }, - "documentation":"

A structure that represents user-provided metadata that can be associated with an IAM resource. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

" - }, - "TagInstanceProfileRequest":{ - "type":"structure", - "required":[ - "InstanceProfileName", - "Tags" - ], - "members":{ - "InstanceProfileName":{ - "shape":"instanceProfileNameType", - "documentation":"

The name of the IAM instance profile to which you want to add tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "Tags":{ - "shape":"tagListType", - "documentation":"

The list of tags that you want to attach to the IAM instance profile. Each tag consists of a key name and an associated value.

" - } - } - }, - "TagMFADeviceRequest":{ - "type":"structure", - "required":[ - "SerialNumber", - "Tags" - ], - "members":{ - "SerialNumber":{ - "shape":"serialNumberType", - "documentation":"

The unique identifier for the IAM virtual MFA device to which you want to add tags. For virtual MFA devices, the serial number is the same as the ARN.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "Tags":{ - "shape":"tagListType", - "documentation":"

The list of tags that you want to attach to the IAM virtual MFA device. Each tag consists of a key name and an associated value.

" - } - } - }, - "TagOpenIDConnectProviderRequest":{ - "type":"structure", - "required":[ - "OpenIDConnectProviderArn", - "Tags" - ], - "members":{ - "OpenIDConnectProviderArn":{ - "shape":"arnType", - "documentation":"

The ARN of the OIDC identity provider in IAM to which you want to add tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "Tags":{ - "shape":"tagListType", - "documentation":"

The list of tags that you want to attach to the OIDC identity provider in IAM. Each tag consists of a key name and an associated value.

" - } - } - }, - "TagPolicyRequest":{ - "type":"structure", - "required":[ - "PolicyArn", - "Tags" - ], - "members":{ - "PolicyArn":{ - "shape":"arnType", - "documentation":"

The ARN of the IAM customer managed policy to which you want to add tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "Tags":{ - "shape":"tagListType", - "documentation":"

The list of tags that you want to attach to the IAM customer managed policy. Each tag consists of a key name and an associated value.

" - } - } - }, - "TagRoleRequest":{ - "type":"structure", - "required":[ - "RoleName", - "Tags" - ], - "members":{ - "RoleName":{ - "shape":"roleNameType", - "documentation":"

The name of the IAM role to which you want to add tags.

This parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "Tags":{ - "shape":"tagListType", - "documentation":"

The list of tags that you want to attach to the IAM role. Each tag consists of a key name and an associated value.

" - } - } - }, - "TagSAMLProviderRequest":{ - "type":"structure", - "required":[ - "SAMLProviderArn", - "Tags" - ], - "members":{ - "SAMLProviderArn":{ - "shape":"arnType", - "documentation":"

The ARN of the SAML identity provider in IAM to which you want to add tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "Tags":{ - "shape":"tagListType", - "documentation":"

The list of tags that you want to attach to the SAML identity provider in IAM. Each tag consists of a key name and an associated value.

" - } - } - }, - "TagServerCertificateRequest":{ - "type":"structure", - "required":[ - "ServerCertificateName", - "Tags" - ], - "members":{ - "ServerCertificateName":{ - "shape":"serverCertificateNameType", - "documentation":"

The name of the IAM server certificate to which you want to add tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "Tags":{ - "shape":"tagListType", - "documentation":"

The list of tags that you want to attach to the IAM server certificate. Each tag consists of a key name and an associated value.

" - } - } - }, - "TagUserRequest":{ - "type":"structure", - "required":[ - "UserName", - "Tags" - ], - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"

The name of the IAM user to which you want to add tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "Tags":{ - "shape":"tagListType", - "documentation":"

The list of tags that you want to attach to the IAM user. Each tag consists of a key name and an associated value.

" - } - } - }, - "TrackedActionLastAccessed":{ - "type":"structure", - "members":{ - "ActionName":{ - "shape":"stringType", - "documentation":"

The name of the tracked action to which access was attempted. Tracked actions are actions that report activity to IAM.

" - }, - "LastAccessedEntity":{"shape":"arnType"}, - "LastAccessedTime":{ - "shape":"dateType", - "documentation":"

The date and time, in ISO 8601 date-time format, when an authenticated entity most recently attempted to access the tracked service. Amazon Web Services does not report unauthenticated requests.

This field is null if no IAM entities attempted to access the service within the tracking period.

" - }, - "LastAccessedRegion":{ - "shape":"stringType", - "documentation":"

The Region from which the authenticated entity (user or role) last attempted to access the tracked action. Amazon Web Services does not report unauthenticated requests.

This field is null if no IAM entities attempted to access the service within the tracking period.

" - } - }, - "documentation":"

Contains details about the most recent attempt to access an action within the service.

This data type is used as a response element in the GetServiceLastAccessedDetails operation.

" - }, - "TrackedActionsLastAccessed":{ - "type":"list", - "member":{"shape":"TrackedActionLastAccessed"} - }, - "UnmodifiableEntityException":{ - "type":"structure", - "members":{ - "message":{"shape":"unmodifiableEntityMessage"} - }, - "documentation":"

The request was rejected because service-linked roles are protected Amazon Web Services resources. Only the service that depends on the service-linked role can modify or delete the role on your behalf. The error message includes the name of the service that depends on this service-linked role. You must request the change through that service.

", - "error":{ - "code":"UnmodifiableEntity", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "UnrecognizedPublicKeyEncodingException":{ - "type":"structure", - "members":{ - "message":{"shape":"unrecognizedPublicKeyEncodingMessage"} - }, - "documentation":"

The request was rejected because the public key encoding format is unsupported or unrecognized.

", - "error":{ - "code":"UnrecognizedPublicKeyEncoding", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "UntagInstanceProfileRequest":{ - "type":"structure", - "required":[ - "InstanceProfileName", - "TagKeys" - ], - "members":{ - "InstanceProfileName":{ - "shape":"instanceProfileNameType", - "documentation":"

The name of the IAM instance profile from which you want to remove tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "TagKeys":{ - "shape":"tagKeyListType", - "documentation":"

A list of key names as a simple array of strings. The tags with matching keys are removed from the specified instance profile.

" - } - } - }, - "UntagMFADeviceRequest":{ - "type":"structure", - "required":[ - "SerialNumber", - "TagKeys" - ], - "members":{ - "SerialNumber":{ - "shape":"serialNumberType", - "documentation":"

The unique identifier for the IAM virtual MFA device from which you want to remove tags. For virtual MFA devices, the serial number is the same as the ARN.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "TagKeys":{ - "shape":"tagKeyListType", - "documentation":"

A list of key names as a simple array of strings. The tags with matching keys are removed from the specified instance profile.

" - } - } - }, - "UntagOpenIDConnectProviderRequest":{ - "type":"structure", - "required":[ - "OpenIDConnectProviderArn", - "TagKeys" - ], - "members":{ - "OpenIDConnectProviderArn":{ - "shape":"arnType", - "documentation":"

The ARN of the OIDC provider in IAM from which you want to remove tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "TagKeys":{ - "shape":"tagKeyListType", - "documentation":"

A list of key names as a simple array of strings. The tags with matching keys are removed from the specified OIDC provider.

" - } - } - }, - "UntagPolicyRequest":{ - "type":"structure", - "required":[ - "PolicyArn", - "TagKeys" - ], - "members":{ - "PolicyArn":{ - "shape":"arnType", - "documentation":"

The ARN of the IAM customer managed policy from which you want to remove tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "TagKeys":{ - "shape":"tagKeyListType", - "documentation":"

A list of key names as a simple array of strings. The tags with matching keys are removed from the specified policy.

" - } - } - }, - "UntagRoleRequest":{ - "type":"structure", - "required":[ - "RoleName", - "TagKeys" - ], - "members":{ - "RoleName":{ - "shape":"roleNameType", - "documentation":"

The name of the IAM role from which you want to remove tags.

This parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "TagKeys":{ - "shape":"tagKeyListType", - "documentation":"

A list of key names as a simple array of strings. The tags with matching keys are removed from the specified role.

" - } - } - }, - "UntagSAMLProviderRequest":{ - "type":"structure", - "required":[ - "SAMLProviderArn", - "TagKeys" - ], - "members":{ - "SAMLProviderArn":{ - "shape":"arnType", - "documentation":"

The ARN of the SAML identity provider in IAM from which you want to remove tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "TagKeys":{ - "shape":"tagKeyListType", - "documentation":"

A list of key names as a simple array of strings. The tags with matching keys are removed from the specified SAML identity provider.

" - } - } - }, - "UntagServerCertificateRequest":{ - "type":"structure", - "required":[ - "ServerCertificateName", - "TagKeys" - ], - "members":{ - "ServerCertificateName":{ - "shape":"serverCertificateNameType", - "documentation":"

The name of the IAM server certificate from which you want to remove tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "TagKeys":{ - "shape":"tagKeyListType", - "documentation":"

A list of key names as a simple array of strings. The tags with matching keys are removed from the specified IAM server certificate.

" - } - } - }, - "UntagUserRequest":{ - "type":"structure", - "required":[ - "UserName", - "TagKeys" - ], - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"

The name of the IAM user from which you want to remove tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "TagKeys":{ - "shape":"tagKeyListType", - "documentation":"

A list of key names as a simple array of strings. The tags with matching keys are removed from the specified user.

" - } - } - }, - "UpdateAccessKeyRequest":{ - "type":"structure", - "required":[ - "AccessKeyId", - "Status" - ], - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"

The name of the user whose key you want to update.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "AccessKeyId":{ - "shape":"accessKeyIdType", - "documentation":"

The access key ID of the secret access key you want to update.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

" - }, - "Status":{ - "shape":"statusType", - "documentation":"

The status you want to assign to the secret access key. Active means that the key can be used for programmatic calls to Amazon Web Services, while Inactive means that the key cannot be used.

" - } - } - }, - "UpdateAccountPasswordPolicyRequest":{ - "type":"structure", - "members":{ - "MinimumPasswordLength":{ - "shape":"minimumPasswordLengthType", - "documentation":"

The minimum number of characters allowed in an IAM user password.

If you do not specify a value for this parameter, then the operation uses the default value of 6.

" - }, - "RequireSymbols":{ - "shape":"booleanType", - "documentation":"

Specifies whether IAM user passwords must contain at least one of the following non-alphanumeric characters:

! @ # $ % ^ & * ( ) _ + - = [ ] { } | '

If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that passwords do not require at least one symbol character.

" - }, - "RequireNumbers":{ - "shape":"booleanType", - "documentation":"

Specifies whether IAM user passwords must contain at least one numeric character (0 to 9).

If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that passwords do not require at least one numeric character.

" - }, - "RequireUppercaseCharacters":{ - "shape":"booleanType", - "documentation":"

Specifies whether IAM user passwords must contain at least one uppercase character from the ISO basic Latin alphabet (A to Z).

If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that passwords do not require at least one uppercase character.

" - }, - "RequireLowercaseCharacters":{ - "shape":"booleanType", - "documentation":"

Specifies whether IAM user passwords must contain at least one lowercase character from the ISO basic Latin alphabet (a to z).

If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that passwords do not require at least one lowercase character.

" - }, - "AllowUsersToChangePassword":{ - "shape":"booleanType", - "documentation":"

Allows all IAM users in your account to use the Amazon Web Services Management Console to change their own passwords. For more information, see Permitting IAM users to change their own passwords in the IAM User Guide.

If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that IAM users in the account do not automatically have permissions to change their own password.

" - }, - "MaxPasswordAge":{ - "shape":"maxPasswordAgeType", - "documentation":"

The number of days that an IAM user password is valid.

If you do not specify a value for this parameter, then the operation uses the default value of 0. The result is that IAM user passwords never expire.

" - }, - "PasswordReusePrevention":{ - "shape":"passwordReusePreventionType", - "documentation":"

Specifies the number of previous passwords that IAM users are prevented from reusing.

If you do not specify a value for this parameter, then the operation uses the default value of 0. The result is that IAM users are not prevented from reusing previous passwords.

" - }, - "HardExpiry":{ - "shape":"booleanObjectType", - "documentation":"

Prevents IAM users who are accessing the account via the Amazon Web Services Management Console from setting a new console password after their password has expired. The IAM user cannot access the console until an administrator resets the password.

If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that IAM users can change their passwords after they expire and continue to sign in as the user.

In the Amazon Web Services Management Console, the custom password policy option Allow users to change their own password gives IAM users permissions to iam:ChangePassword for only their user and to the iam:GetAccountPasswordPolicy action. This option does not attach a permissions policy to each user, rather the permissions are applied at the account-level for all users by IAM. IAM users with iam:ChangePassword permission and active access keys can reset their own expired console password using the CLI or API.

" - } - } - }, - "UpdateAssumeRolePolicyRequest":{ - "type":"structure", - "required":[ - "RoleName", - "PolicyDocument" - ], - "members":{ - "RoleName":{ - "shape":"roleNameType", - "documentation":"

The name of the role to update with the new policy.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "PolicyDocument":{ - "shape":"policyDocumentType", - "documentation":"

The policy that grants an entity permission to assume the role.

You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" - } - } - }, - "UpdateDelegationRequestRequest":{ - "type":"structure", - "required":["DelegationRequestId"], - "members":{ - "DelegationRequestId":{ - "shape":"delegationRequestIdType", - "documentation":"

The unique identifier of the delegation request to update.

" - }, - "Notes":{ - "shape":"notesType", - "documentation":"

Additional notes or comments to add to the delegation request.

" - } - } - }, - "UpdateGroupRequest":{ - "type":"structure", - "required":["GroupName"], - "members":{ - "GroupName":{ - "shape":"groupNameType", - "documentation":"

Name of the IAM group to update. If you're changing the name of the group, this is the original name.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "NewPath":{ - "shape":"pathType", - "documentation":"

New path for the IAM group. Only include this if changing the group's path.

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" - }, - "NewGroupName":{ - "shape":"groupNameType", - "documentation":"

New name for the IAM group. Only include this if changing the group's name.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both \"MyResource\" and \"myresource\".

" - } - } - }, - "UpdateLoginProfileRequest":{ - "type":"structure", - "required":["UserName"], - "members":{ - "UserName":{ - "shape":"userNameType", - "documentation":"

The name of the user whose password you want to update.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "Password":{ - "shape":"passwordType", - "documentation":"

The new password for the specified IAM user.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

However, the format can be further restricted by the account administrator by setting a password policy on the Amazon Web Services account. For more information, see UpdateAccountPasswordPolicy.

" - }, - "PasswordResetRequired":{ - "shape":"booleanObjectType", - "documentation":"

Allows this new password to be used only once by requiring the specified IAM user to set a new password on next sign-in.

" - } - } - }, - "UpdateOpenIDConnectProviderThumbprintRequest":{ - "type":"structure", - "required":[ - "OpenIDConnectProviderArn", - "ThumbprintList" - ], - "members":{ - "OpenIDConnectProviderArn":{ - "shape":"arnType", - "documentation":"

The Amazon Resource Name (ARN) of the IAM OIDC provider resource object for which you want to update the thumbprint. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders operation.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

" - }, - "ThumbprintList":{ - "shape":"thumbprintListType", - "documentation":"

A list of certificate thumbprints that are associated with the specified IAM OpenID Connect provider. For more information, see CreateOpenIDConnectProvider.

" - } - } - }, - "UpdateRoleDescriptionRequest":{ - "type":"structure", - "required":[ - "RoleName", - "Description" - ], - "members":{ - "RoleName":{ - "shape":"roleNameType", - "documentation":"

The name of the role that you want to modify.

" - }, - "Description":{ - "shape":"roleDescriptionType", - "documentation":"

The new description that you want to apply to the specified role.

" - } - } - }, - "UpdateRoleDescriptionResponse":{ - "type":"structure", - "members":{ - "Role":{ - "shape":"Role", - "documentation":"

A structure that contains details about the modified role.

" - } - } - }, - "UpdateRoleRequest":{ - "type":"structure", - "required":["RoleName"], - "members":{ - "RoleName":{ - "shape":"roleNameType", - "documentation":"

The name of the role that you want to modify.

" - }, - "Description":{ - "shape":"roleDescriptionType", - "documentation":"

The new description that you want to apply to the specified role.

" - }, - "MaxSessionDuration":{ - "shape":"roleMaxSessionDurationType", - "documentation":"

The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours.

Anyone who assumes the role from the CLI or API can use the DurationSeconds API parameter or the duration-seconds CLI parameter to request a longer session. The MaxSessionDuration setting determines the maximum duration that can be requested using the DurationSeconds parameter. If users don't specify a value for the DurationSeconds parameter, their security credentials are valid for one hour by default. This applies when you use the AssumeRole* API operations or the assume-role* CLI operations but does not apply when you use those operations to create a console URL. For more information, see Using IAM roles in the IAM User Guide.

IAM role credentials provided by Amazon EC2 instances assigned to the role are not subject to the specified maximum session duration.

" - } - } - }, - "UpdateRoleResponse":{ - "type":"structure", - "members":{} - }, - "UpdateSAMLProviderRequest":{ - "type":"structure", - "required":["SAMLProviderArn"], - "members":{ - "SAMLMetadataDocument":{ - "shape":"SAMLMetadataDocumentType", - "documentation":"

An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your IdP.

" - }, - "SAMLProviderArn":{ - "shape":"arnType", - "documentation":"

The Amazon Resource Name (ARN) of the SAML provider to update.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

" - }, - "AssertionEncryptionMode":{ - "shape":"assertionEncryptionModeType", - "documentation":"

Specifies the encryption setting for the SAML provider.

" - }, - "AddPrivateKey":{ - "shape":"privateKeyType", - "documentation":"

Specifies the new private key from your external identity provider. The private key must be a .pem file that uses AES-GCM or AES-CBC encryption algorithm to decrypt SAML assertions.

" - }, - "RemovePrivateKey":{ - "shape":"privateKeyIdType", - "documentation":"

The Key ID of the private key to remove.

" - } - } - }, - "UpdateSAMLProviderResponse":{ - "type":"structure", - "members":{ - "SAMLProviderArn":{ - "shape":"arnType", - "documentation":"

The Amazon Resource Name (ARN) of the SAML provider that was updated.

" - } - }, - "documentation":"

Contains the response to a successful UpdateSAMLProvider request.

" - }, - "UpdateSSHPublicKeyRequest":{ - "type":"structure", - "required":[ - "UserName", - "SSHPublicKeyId", - "Status" - ], - "members":{ - "UserName":{ - "shape":"userNameType", - "documentation":"

The name of the IAM user associated with the SSH public key.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "SSHPublicKeyId":{ - "shape":"publicKeyIdType", - "documentation":"

The unique identifier for the SSH public key.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

" - }, - "Status":{ - "shape":"statusType", - "documentation":"

The status to assign to the SSH public key. Active means that the key can be used for authentication with an CodeCommit repository. Inactive means that the key cannot be used.

" - } - } - }, - "UpdateServerCertificateRequest":{ - "type":"structure", - "required":["ServerCertificateName"], - "members":{ - "ServerCertificateName":{ - "shape":"serverCertificateNameType", - "documentation":"

The name of the server certificate that you want to update.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "NewPath":{ - "shape":"pathType", - "documentation":"

The new path for the server certificate. Include this only if you are updating the server certificate's path.

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" - }, - "NewServerCertificateName":{ - "shape":"serverCertificateNameType", - "documentation":"

The new name for the server certificate. Include this only if you are updating the server certificate's name. The name of the certificate cannot contain any spaces.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - } - } - }, - "UpdateServiceSpecificCredentialRequest":{ - "type":"structure", - "required":[ - "ServiceSpecificCredentialId", - "Status" - ], - "members":{ - "UserName":{ - "shape":"userNameType", - "documentation":"

The name of the IAM user associated with the service-specific credential. If you do not specify this value, then the operation assumes the user whose credentials are used to call the operation.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "ServiceSpecificCredentialId":{ - "shape":"serviceSpecificCredentialId", - "documentation":"

The unique identifier of the service-specific credential.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

" - }, - "Status":{ - "shape":"statusType", - "documentation":"

The status to be assigned to the service-specific credential.

" - } - } - }, - "UpdateSigningCertificateRequest":{ - "type":"structure", - "required":[ - "CertificateId", - "Status" - ], - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"

The name of the IAM user the signing certificate belongs to.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "CertificateId":{ - "shape":"certificateIdType", - "documentation":"

The ID of the signing certificate you want to update.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

" - }, - "Status":{ - "shape":"statusType", - "documentation":"

The status you want to assign to the certificate. Active means that the certificate can be used for programmatic calls to Amazon Web Services Inactive means that the certificate cannot be used.

" - } - } - }, - "UpdateUserRequest":{ - "type":"structure", - "required":["UserName"], - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"

Name of the user to update. If you're changing the name of the user, this is the original user name.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "NewPath":{ - "shape":"pathType", - "documentation":"

New path for the IAM user. Include this parameter only if you're changing the user's path.

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" - }, - "NewUserName":{ - "shape":"userNameType", - "documentation":"

New name for the user. Include this parameter only if you're changing the user's name.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both \"MyResource\" and \"myresource\".

" - } - } - }, - "UploadSSHPublicKeyRequest":{ - "type":"structure", - "required":[ - "UserName", - "SSHPublicKeyBody" - ], - "members":{ - "UserName":{ - "shape":"userNameType", - "documentation":"

The name of the IAM user to associate the SSH public key with.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "SSHPublicKeyBody":{ - "shape":"publicKeyMaterialType", - "documentation":"

The SSH public key. The public key must be encoded in ssh-rsa format or PEM format. The minimum bit-length of the public key is 2048 bits. For example, you can generate a 2048-bit key, and the resulting PEM file is 1679 bytes long.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" - } - } - }, - "UploadSSHPublicKeyResponse":{ - "type":"structure", - "members":{ - "SSHPublicKey":{ - "shape":"SSHPublicKey", - "documentation":"

Contains information about the SSH public key.

" - } - }, - "documentation":"

Contains the response to a successful UploadSSHPublicKey request.

" - }, - "UploadServerCertificateRequest":{ - "type":"structure", - "required":[ - "ServerCertificateName", - "CertificateBody", - "PrivateKey" - ], - "members":{ - "Path":{ - "shape":"pathType", - "documentation":"

The path for the server certificate. For more information about paths, see IAM identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

If you are uploading a server certificate specifically for use with Amazon CloudFront distributions, you must specify a path using the path parameter. The path must begin with /cloudfront and must include a trailing slash (for example, /cloudfront/test/).

" - }, - "ServerCertificateName":{ - "shape":"serverCertificateNameType", - "documentation":"

The name for the server certificate. Do not include the path in this value. The name of the certificate cannot contain any spaces.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "CertificateBody":{ - "shape":"certificateBodyType", - "documentation":"

The contents of the public key certificate in PEM-encoded format.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" - }, - "PrivateKey":{ - "shape":"privateKeyType", - "documentation":"

The contents of the private key in PEM-encoded format.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" - }, - "CertificateChain":{ - "shape":"certificateChainType", - "documentation":"

The contents of the certificate chain. This is typically a concatenation of the PEM-encoded public key certificates of the chain.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" - }, - "Tags":{ - "shape":"tagListType", - "documentation":"

A list of tags that you want to attach to the new IAM server certificate resource. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

" - } - } - }, - "UploadServerCertificateResponse":{ - "type":"structure", - "members":{ - "ServerCertificateMetadata":{ - "shape":"ServerCertificateMetadata", - "documentation":"

The meta information of the uploaded server certificate without its certificate body, certificate chain, and private key.

" - }, - "Tags":{ - "shape":"tagListType", - "documentation":"

A list of tags that are attached to the new IAM server certificate. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

" - } - }, - "documentation":"

Contains the response to a successful UploadServerCertificate request.

" - }, - "UploadSigningCertificateRequest":{ - "type":"structure", - "required":["CertificateBody"], - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"

The name of the user the signing certificate is for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" - }, - "CertificateBody":{ - "shape":"certificateBodyType", - "documentation":"

The contents of the signing certificate.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" - } - } - }, - "UploadSigningCertificateResponse":{ - "type":"structure", - "required":["Certificate"], - "members":{ - "Certificate":{ - "shape":"SigningCertificate", - "documentation":"

Information about the certificate.

" - } - }, - "documentation":"

Contains the response to a successful UploadSigningCertificate request.

" - }, - "User":{ - "type":"structure", - "required":[ - "Path", - "UserName", - "UserId", - "Arn", - "CreateDate" - ], - "members":{ - "Path":{ - "shape":"pathType", - "documentation":"

The path to the user. For more information about paths, see IAM identifiers in the IAM User Guide.

The ARN of the policy used to set the permissions boundary for the user.

" - }, - "UserName":{ - "shape":"userNameType", - "documentation":"

The friendly name identifying the user.

" - }, - "UserId":{ - "shape":"idType", - "documentation":"

The stable and unique string identifying the user. For more information about IDs, see IAM identifiers in the IAM User Guide.

" - }, - "Arn":{ - "shape":"arnType", - "documentation":"

The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.

" - }, - "CreateDate":{ - "shape":"dateType", - "documentation":"

The date and time, in ISO 8601 date-time format, when the user was created.

" - }, - "PasswordLastUsed":{ - "shape":"dateType", - "documentation":"

The date and time, in ISO 8601 date-time format, when the user's password was last used to sign in to an Amazon Web Services website. For a list of Amazon Web Services websites that capture a user's last sign-in time, see the Credential reports topic in the IAM User Guide. If a password is used more than once in a five-minute span, only the first use is returned in this field. If the field is null (no value), then it indicates that they never signed in with a password. This can be because:

  • The user never had a password.

  • A password exists but has not been used since IAM started tracking this information on October 20, 2014.

A null value does not mean that the user never had a password. Also, if the user does not currently have a password but had one in the past, then this field contains the date and time the most recent password was used.

This value is returned only in the GetUser and ListUsers operations.

" - }, - "PermissionsBoundary":{ - "shape":"AttachedPermissionsBoundary", - "documentation":"

For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.

" - }, - "Tags":{ - "shape":"tagListType", - "documentation":"

A list of tags that are associated with the user. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

" - } - }, - "documentation":"

Contains information about an IAM user entity.

This data type is used as a response element in the following operations:

" - }, - "UserDetail":{ - "type":"structure", - "members":{ - "Path":{ - "shape":"pathType", - "documentation":"

The path to the user. For more information about paths, see IAM identifiers in the IAM User Guide.

" - }, - "UserName":{ - "shape":"userNameType", - "documentation":"

The friendly name identifying the user.

" - }, - "UserId":{ - "shape":"idType", - "documentation":"

The stable and unique string identifying the user. For more information about IDs, see IAM identifiers in the IAM User Guide.

" - }, - "Arn":{"shape":"arnType"}, - "CreateDate":{ - "shape":"dateType", - "documentation":"

The date and time, in ISO 8601 date-time format, when the user was created.

" - }, - "UserPolicyList":{ - "shape":"policyDetailListType", - "documentation":"

A list of the inline policies embedded in the user.

" - }, - "GroupList":{ - "shape":"groupNameListType", - "documentation":"

A list of IAM groups that the user is in.

" - }, - "AttachedManagedPolicies":{ - "shape":"attachedPoliciesListType", - "documentation":"

A list of the managed policies attached to the user.

" - }, - "PermissionsBoundary":{ - "shape":"AttachedPermissionsBoundary", - "documentation":"

The ARN of the policy used to set the permissions boundary for the user.

For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.

" - }, - "Tags":{ - "shape":"tagListType", - "documentation":"

A list of tags that are associated with the user. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

" - } - }, - "documentation":"

Contains information about an IAM user, including all the user's policies and all the IAM groups the user is in.

This data type is used as a response element in the GetAccountAuthorizationDetails operation.

" - }, - "VirtualMFADevice":{ - "type":"structure", - "required":["SerialNumber"], - "members":{ - "SerialNumber":{ - "shape":"serialNumberType", - "documentation":"

The serial number associated with VirtualMFADevice.

" - }, - "Base32StringSeed":{ - "shape":"BootstrapDatum", - "documentation":"

The base32 seed defined as specified in RFC3548. The Base32StringSeed is base32-encoded.

" - }, - "QRCodePNG":{ - "shape":"BootstrapDatum", - "documentation":"

A QR code PNG image that encodes otpauth://totp/$virtualMFADeviceName@$AccountName?secret=$Base32String where $virtualMFADeviceName is one of the create call arguments. AccountName is the user name if set (otherwise, the account ID otherwise), and Base32String is the seed in base32 format. The Base32String value is base64-encoded.

" - }, - "User":{ - "shape":"User", - "documentation":"

The IAM user associated with this virtual MFA device.

" - }, - "EnableDate":{ - "shape":"dateType", - "documentation":"

The date and time on which the virtual MFA device was enabled.

" - }, - "Tags":{ - "shape":"tagListType", - "documentation":"

A list of tags that are attached to the virtual MFA device. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

" - } - }, - "documentation":"

Contains information about a virtual MFA device.

" - }, - "accessKeyIdType":{ - "type":"string", - "max":128, - "min":16, - "pattern":"[\\w]+" - }, - "accessKeyMetadataListType":{ - "type":"list", - "member":{"shape":"AccessKeyMetadata"}, - "documentation":"

Contains a list of access key metadata.

This data type is used as a response element in the ListAccessKeys operation.

" - }, - "accessKeySecretType":{ - "type":"string", - "sensitive":true - }, - "accountAliasListType":{ - "type":"list", - "member":{"shape":"accountAliasType"} - }, - "accountAliasType":{ - "type":"string", - "max":63, - "min":3, - "pattern":"^[a-z0-9]([a-z0-9]|-(?!-)){1,61}[a-z0-9]$" - }, - "accountIdType":{ - "type":"string", - "pattern":"\\d{12}" - }, - "allUsers":{ - "type":"boolean", - "box":true - }, - "arnType":{ - "type":"string", - "documentation":"

The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.

For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

", - "max":2048, - "min":20 - }, - "assertionEncryptionModeType":{ - "type":"string", - "enum":[ - "Required", - "Allowed" - ] - }, - "assignmentStatusType":{ - "type":"string", - "enum":[ - "Assigned", - "Unassigned", - "Any" - ] - }, - "attachedPoliciesListType":{ - "type":"list", - "member":{"shape":"AttachedPolicy"} - }, - "attachmentCountType":{"type":"integer"}, - "authenticationCodeType":{ - "type":"string", - "max":6, - "min":6, - "pattern":"[\\d]+" - }, - "booleanObjectType":{ - "type":"boolean", - "box":true - }, - "booleanType":{"type":"boolean"}, - "certificateBodyType":{ - "type":"string", - "max":16384, - "min":1, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" - }, - "certificateChainType":{ - "type":"string", - "max":2097152, - "min":1, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" - }, - "certificateIdType":{ - "type":"string", - "max":128, - "min":24, - "pattern":"[\\w]+" - }, - "certificateListType":{ - "type":"list", - "member":{"shape":"SigningCertificate"}, - "documentation":"

Contains a list of signing certificates.

This data type is used as a response element in the ListSigningCertificates operation.

" - }, - "clientIDListType":{ - "type":"list", - "member":{"shape":"clientIDType"} - }, - "clientIDType":{ - "type":"string", - "max":255, - "min":1 - }, - "consoleDeepLinkType":{ - "type":"string", - "max":255, - "min":1 - }, - "credentialAgeDays":{ - "type":"integer", - "max":36600, - "min":1 - }, - "credentialReportExpiredExceptionMessage":{"type":"string"}, - "credentialReportNotPresentExceptionMessage":{"type":"string"}, - "credentialReportNotReadyExceptionMessage":{"type":"string"}, - "customSuffixType":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[\\w+=,.@-]+" - }, - "dateType":{"type":"timestamp"}, - "delegationRequestDescriptionType":{ - "type":"string", - "max":1000, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]*" - }, - "delegationRequestIdType":{ - "type":"string", - "max":128, - "min":16, - "pattern":"[\\w-]+" - }, - "delegationRequestsListType":{ - "type":"list", - "member":{"shape":"DelegationRequest"} - }, - "deleteConflictMessage":{"type":"string"}, - "duplicateCertificateMessage":{"type":"string"}, - "duplicateSSHPublicKeyMessage":{"type":"string"}, - "encodingType":{ - "type":"string", - "enum":[ - "SSH", - "PEM" - ] - }, - "entityAlreadyExistsMessage":{"type":"string"}, - "entityDetailsListType":{ - "type":"list", - "member":{"shape":"EntityDetails"} - }, - "entityListType":{ - "type":"list", - "member":{"shape":"EntityType"} - }, - "entityNameType":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[\\w+=,.@-]+" - }, - "entityTemporarilyUnmodifiableMessage":{"type":"string"}, - "existingUserNameType":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[\\w+=,.@-]+" - }, - "globalEndpointTokenVersion":{ - "type":"string", - "enum":[ - "v1Token", - "v2Token" - ] - }, - "groupDetailListType":{ - "type":"list", - "member":{"shape":"GroupDetail"} - }, - "groupListType":{ - "type":"list", - "member":{"shape":"Group"}, - "documentation":"

Contains a list of IAM groups.

This data type is used as a response element in the ListGroups operation.

" - }, - "groupNameListType":{ - "type":"list", - "member":{"shape":"groupNameType"} - }, - "groupNameType":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[\\w+=,.@-]+" - }, - "idType":{ - "type":"string", - "max":128, - "min":16, - "pattern":"[\\w]+" - }, - "instanceProfileListType":{ - "type":"list", - "member":{"shape":"InstanceProfile"}, - "documentation":"

Contains a list of instance profiles.

" - }, - "instanceProfileNameType":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[\\w+=,.@-]+" - }, - "integerType":{"type":"integer"}, - "invalidAuthenticationCodeMessage":{"type":"string"}, - "invalidCertificateMessage":{"type":"string"}, - "invalidInputMessage":{"type":"string"}, - "invalidPublicKeyMessage":{"type":"string"}, - "invalidUserTypeMessage":{"type":"string"}, - "jobIDType":{ - "type":"string", - "max":36, - "min":36 - }, - "jobStatusType":{ - "type":"string", - "enum":[ - "IN_PROGRESS", - "COMPLETED", - "FAILED" - ] - }, - "keyPairMismatchMessage":{"type":"string"}, - "limitExceededMessage":{"type":"string"}, - "listPolicyGrantingServiceAccessResponseListType":{ - "type":"list", - "member":{"shape":"ListPoliciesGrantingServiceAccessEntry"} - }, - "localeType":{ - "type":"string", - "max":12, - "min":2 - }, - "malformedCertificateMessage":{"type":"string"}, - "malformedPolicyDocumentMessage":{"type":"string"}, - "markerType":{ - "type":"string", - "max":320, - "min":1, - "pattern":"[\\u0020-\\u00FF]+" - }, - "maxItemsType":{ - "type":"integer", - "max":1000, - "min":1 - }, - "maxPasswordAgeType":{ - "type":"integer", - "box":true, - "max":1095, - "min":1 - }, - "mfaDeviceListType":{ - "type":"list", - "member":{"shape":"MFADevice"}, - "documentation":"

Contains a list of MFA devices.

This data type is used as a response element in the ListMFADevices and ListVirtualMFADevices operations.

" - }, - "minimumPasswordLengthType":{ - "type":"integer", - "max":128, - "min":6 - }, - "noSuchEntityMessage":{"type":"string"}, - "notesType":{ - "type":"string", - "max":500, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]*" - }, - "notificationChannelType":{ - "type":"string", - "max":400, - "min":2, - "pattern":"^[a-zA-Z0-9:_.-]+$" - }, - "openIdIdpCommunicationErrorExceptionMessage":{"type":"string"}, - "organizationsEntityPathType":{ - "type":"string", - "max":427, - "min":19, - "pattern":"^o-[0-9a-z]{10,32}\\/r-[0-9a-z]{4,32}[0-9a-z-\\/]*" - }, - "organizationsPolicyIdType":{ - "type":"string", - "pattern":"^p-[0-9a-zA-Z_]{8,128}$" - }, - "ownerIdType":{ - "type":"string", - "max":2048, - "min":20, - "pattern":"^[a-zA-Z0-9:/+=,.@_-]+$" - }, - "passwordPolicyViolationMessage":{"type":"string"}, - "passwordReusePreventionType":{ - "type":"integer", - "box":true, - "max":24, - "min":1 - }, - "passwordType":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", - "sensitive":true - }, - "pathPrefixType":{ - "type":"string", - "max":512, - "min":1, - "pattern":"\\u002F[\\u0021-\\u007F]*" - }, - "pathType":{ - "type":"string", - "max":512, - "min":1, - "pattern":"(\\u002F)|(\\u002F[\\u0021-\\u007E]+\\u002F)" - }, - "permissionCheckResultType":{ - "type":"string", - "enum":[ - "ALLOWED", - "DENIED", - "UNSURE" - ] - }, - "permissionCheckStatusType":{ - "type":"string", - "enum":[ - "COMPLETE", - "IN_PROGRESS", - "FAILED" - ] - }, - "permissionType":{"type":"string"}, - "policyDescriptionType":{ - "type":"string", - "max":1000 - }, - "policyDetailListType":{ - "type":"list", - "member":{"shape":"PolicyDetail"} - }, - "policyDocumentType":{ - "type":"string", - "max":131072, - "min":1, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" - }, - "policyDocumentVersionListType":{ - "type":"list", - "member":{"shape":"PolicyVersion"} - }, - "policyEvaluationErrorMessage":{"type":"string"}, - "policyGrantingServiceAccessListType":{ - "type":"list", - "member":{"shape":"PolicyGrantingServiceAccess"} - }, - "policyListType":{ - "type":"list", - "member":{"shape":"Policy"} - }, - "policyNameListType":{ - "type":"list", - "member":{"shape":"policyNameType"}, - "documentation":"

Contains a list of policy names.

This data type is used as a response element in the ListPolicies operation.

" - }, - "policyNameType":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[\\w+=,.@-]+" - }, - "policyNotAttachableMessage":{"type":"string"}, - "policyOwnerEntityType":{ - "type":"string", - "enum":[ - "USER", - "ROLE", - "GROUP" - ] - }, - "policyParameterListType":{ - "type":"list", - "member":{"shape":"PolicyParameter"}, - "max":50 - }, - "policyParameterNameType":{ - "type":"string", - "max":256, - "min":5, - "pattern":"[ -~]+" - }, - "policyParameterValueType":{ - "type":"string", - "pattern":"[ -~]+" - }, - "policyParameterValuesListType":{ - "type":"list", - "member":{"shape":"policyParameterValueType"} - }, - "policyPathType":{ - "type":"string", - "max":512, - "min":1, - "pattern":"((/[A-Za-z0-9\\.,\\+@=_-]+)*)/" - }, - "policyScopeType":{ - "type":"string", - "enum":[ - "All", - "AWS", - "Local" - ] - }, - "policyType":{ - "type":"string", - "enum":[ - "INLINE", - "MANAGED" - ] - }, - "policyVersionIdType":{ - "type":"string", - "pattern":"v[1-9][0-9]*(\\.[A-Za-z0-9-]*)?" - }, - "privateKeyIdType":{ - "type":"string", - "max":64, - "min":22, - "pattern":"[A-Z0-9]+" - }, - "privateKeyList":{ - "type":"list", - "member":{"shape":"SAMLPrivateKey"}, - "max":2 - }, - "privateKeyType":{ - "type":"string", - "max":16384, - "min":1, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", - "sensitive":true - }, - "publicKeyFingerprintType":{ - "type":"string", - "max":48, - "min":48, - "pattern":"[:\\w]+" - }, - "publicKeyIdType":{ - "type":"string", - "max":128, - "min":20, - "pattern":"[\\w]+" - }, - "publicKeyMaterialType":{ - "type":"string", - "max":16384, - "min":1, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" - }, - "redirectUrlType":{ - "type":"string", - "max":255, - "min":1, - "pattern":"^http(s?)://[a-zA-Z0-9._/-]*(\\?[a-zA-Z0-9._=&-]*)?(#[a-zA-Z0-9._/-]*)?$" - }, - "reportGenerationLimitExceededMessage":{"type":"string"}, - "requestMessageType":{ - "type":"string", - "max":200, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]*" - }, - "requestorNameType":{ - "type":"string", - "max":30, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]*" - }, - "requestorWorkflowIdType":{ - "type":"string", - "max":400, - "min":5, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]+" - }, - "responseMarkerType":{"type":"string"}, - "roleDescriptionType":{ - "type":"string", - "max":1000, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]*" - }, - "roleDetailListType":{ - "type":"list", - "member":{"shape":"RoleDetail"} - }, - "roleListType":{ - "type":"list", - "member":{"shape":"Role"}, - "documentation":"

Contains a list of IAM roles.

This data type is used as a response element in the ListRoles operation.

" - }, - "roleMaxSessionDurationType":{ - "type":"integer", - "max":43200, - "min":3600 - }, - "roleNameType":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[\\w+=,.@-]+" - }, - "rolePermissionRestrictionArnListType":{ - "type":"list", - "member":{"shape":"arnType"} - }, - "serialNumberType":{ - "type":"string", - "max":256, - "min":9, - "pattern":"[\\w+=/:,.@-]+" - }, - "serverCertificateMetadataListType":{ - "type":"list", - "member":{"shape":"ServerCertificateMetadata"} - }, - "serverCertificateNameType":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[\\w+=,.@-]+" - }, - "serviceCredentialAlias":{ - "type":"string", - "max":200, - "min":0, - "pattern":"[\\w+=,.@-]+" - }, - "serviceCredentialSecret":{ - "type":"string", - "sensitive":true - }, - "serviceFailureExceptionMessage":{"type":"string"}, - "serviceName":{"type":"string"}, - "serviceNameType":{"type":"string"}, - "serviceNamespaceListType":{ - "type":"list", - "member":{"shape":"serviceNamespaceType"}, - "max":200, - "min":1 - }, - "serviceNamespaceType":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[\\w-]*" - }, - "serviceNotSupportedMessage":{"type":"string"}, - "servicePassword":{ - "type":"string", - "sensitive":true - }, - "serviceSpecificCredentialId":{ - "type":"string", - "max":128, - "min":20, - "pattern":"[\\w]+" - }, - "serviceUserName":{ - "type":"string", - "max":200, - "min":0, - "pattern":"[\\w+=,.@-]*" - }, - "sessionDurationType":{ - "type":"integer", - "max":43200, - "min":300 - }, - "sortKeyType":{ - "type":"string", - "enum":[ - "SERVICE_NAMESPACE_ASCENDING", - "SERVICE_NAMESPACE_DESCENDING", - "LAST_AUTHENTICATED_TIME_ASCENDING", - "LAST_AUTHENTICATED_TIME_DESCENDING" - ] - }, - "stateType":{ - "type":"string", - "enum":[ - "UNASSIGNED", - "ASSIGNED", - "PENDING_APPROVAL", - "FINALIZED", - "ACCEPTED", - "REJECTED", - "EXPIRED" - ] - }, - "statusType":{ - "type":"string", - "enum":[ - "Active", - "Inactive", - "Expired" - ] - }, - "stringType":{"type":"string"}, - "summaryContentType":{ - "type":"string", - "max":10000, - "min":0 - }, - "summaryKeyType":{ - "type":"string", - "enum":[ - "Users", - "UsersQuota", - "Groups", - "GroupsQuota", - "ServerCertificates", - "ServerCertificatesQuota", - "UserPolicySizeQuota", - "GroupPolicySizeQuota", - "GroupsPerUserQuota", - "SigningCertificatesPerUserQuota", - "AccessKeysPerUserQuota", - "MFADevices", - "MFADevicesInUse", - "AccountMFAEnabled", - "AccountAccessKeysPresent", - "AccountPasswordPresent", - "AccountSigningCertificatesPresent", - "AttachedPoliciesPerGroupQuota", - "AttachedPoliciesPerRoleQuota", - "AttachedPoliciesPerUserQuota", - "Policies", - "PoliciesQuota", - "PolicySizeQuota", - "PolicyVersionsInUse", - "PolicyVersionsInUseQuota", - "VersionsPerPolicyQuota", - "GlobalEndpointTokenVersion", - "AssumeRolePolicySizeQuota", - "InstanceProfiles", - "InstanceProfilesQuota", - "Providers", - "RolePolicySizeQuota", - "Roles", - "RolesQuota" - ] - }, - "summaryMapType":{ - "type":"map", - "key":{"shape":"summaryKeyType"}, - "value":{"shape":"summaryValueType"} - }, - "summaryStateType":{ - "type":"string", - "enum":[ - "AVAILABLE", - "NOT_AVAILABLE", - "NOT_SUPPORTED", - "FAILED" - ] - }, - "summaryValueType":{"type":"integer"}, - "tagKeyListType":{ - "type":"list", - "member":{"shape":"tagKeyType"}, - "max":50 - }, - "tagKeyType":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]+" - }, - "tagListType":{ - "type":"list", - "member":{"shape":"Tag"}, - "max":50 - }, - "tagValueType":{ - "type":"string", - "max":256, - "min":0, - "pattern":"[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*" - }, - "thumbprintListType":{ - "type":"list", - "member":{"shape":"thumbprintType"}, - "documentation":"

Contains a list of thumbprints of identity provider server certificates.

" - }, - "thumbprintType":{ - "type":"string", - "documentation":"

Contains a thumbprint for an identity provider's server certificate.

The identity provider's server certificate thumbprint is the hex-encoded SHA-1 hash value of the self-signed X.509 certificate. This thumbprint is used by the domain where the OpenID Connect provider makes its keys available. The thumbprint is always a 40-character string.

", - "max":40, - "min":40 - }, - "unmodifiableEntityMessage":{"type":"string"}, - "unrecognizedPublicKeyEncodingMessage":{"type":"string"}, - "userDetailListType":{ - "type":"list", - "member":{"shape":"UserDetail"} - }, - "userListType":{ - "type":"list", - "member":{"shape":"User"}, - "documentation":"

Contains a list of users.

This data type is used as a response element in the GetGroup and ListUsers operations.

" - }, - "userNameType":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[\\w+=,.@-]+" - }, - "virtualMFADeviceListType":{ - "type":"list", - "member":{"shape":"VirtualMFADevice"} - }, - "virtualMFADeviceName":{ - "type":"string", - "min":1, - "pattern":"[\\w+=,.@-]+" - } - }, - "documentation":"Identity and Access Management

Identity and Access Management (IAM) is a web service for securely controlling access to Amazon Web Services services. With IAM, you can centrally manage users, security credentials such as access keys, and permissions that control which Amazon Web Services resources users and applications can access. For more information about IAM, see Identity and Access Management (IAM) and the Identity and Access Management User Guide.

Programmatic access to IAM

We recommend that you use the Amazon Web Services SDKs to make programmatic API calls to IAM. The Amazon Web Services SDKs consist of libraries and sample code for various programming languages and platforms (for example, Java, Ruby, .NET, iOS, and Android). The SDKs provide a convenient way to create programmatic access to IAM and Amazon Web Services. For example, the SDKs take care of tasks such as cryptographically signing requests, managing errors, and retrying requests automatically. For more information, see Tools to build on Amazon Web Services.

Alternatively, you can also use the IAM Query API to make direct calls to the IAM service. For more information about calling the IAM Query API, see Making query requests in the Identity and Access Management User Guide. IAM supports GET and POST requests for all actions. That is, the API does not require you to use GET for some actions and POST for others. However, GET requests are subject to the limitation size of a URL. Therefore, for operations that require larger sizes, use a POST request.

Signing requests

Requests must be signed using an access key ID and a secret access key. We strongly recommend that you do not use your Amazon Web Services account access key ID and secret access key for everyday work with IAM. You can use the access key ID and secret access key for an IAM user or you can use the Security Token Service to generate temporary security credentials and use those to sign requests.

To sign requests, we recommend that you use Signature Version 4. If you have an existing application that uses Signature Version 2, you do not have to update it to use Signature Version 4. However, some operations now require Signature Version 4. The documentation for operations that require version 4 indicate this requirement.

Additional resources

" -} diff --git a/tools/code-generation/api-descriptions/iam/2010-05-08/smoke-2.json b/tools/code-generation/api-descriptions/iam/2010-05-08/smoke-2.json deleted file mode 100644 index cefa15ce799d..000000000000 --- a/tools/code-generation/api-descriptions/iam/2010-05-08/smoke-2.json +++ /dev/null @@ -1,29 +0,0 @@ -{ - "version": 2, - "testCases": [ - { - "id": "ListUsersSuccess", - "operationName": "ListUsers", - "input": {}, - "expectation": { - "success": {} - }, - "config": { - "region": "us-east-1" - } - }, - { - "id": "GetUserFailure", - "operationName": "GetUser", - "input": { - "UserName": "fake_user" - }, - "expectation": { - "failure": {} - }, - "config": { - "region": "us-east-1" - } - } - ] -} diff --git a/tools/code-generation/api-descriptions/iam/2010-05-08/smoke.json b/tools/code-generation/api-descriptions/iam/2010-05-08/smoke.json deleted file mode 100644 index 89b5d20bc739..000000000000 --- a/tools/code-generation/api-descriptions/iam/2010-05-08/smoke.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "version": 1, - "defaultRegion": "us-east-1", - "testCases": [ - { - "operationName": "ListUsers", - "input": {}, - "errorExpectedFromService": false - }, - { - "operationName": "GetUser", - "input": { - "UserName": "fake_user" - }, - "errorExpectedFromService": true - } - ] -} diff --git a/tools/code-generation/api-descriptions/iam/2010-05-08/waiters-2.json b/tools/code-generation/api-descriptions/iam/2010-05-08/waiters-2.json deleted file mode 100644 index 6248041527d0..000000000000 --- a/tools/code-generation/api-descriptions/iam/2010-05-08/waiters-2.json +++ /dev/null @@ -1,73 +0,0 @@ -{ - "version": 2, - "waiters": { - "InstanceProfileExists": { - "delay": 1, - "operation": "GetInstanceProfile", - "maxAttempts": 40, - "acceptors": [ - { - "expected": 200, - "matcher": "status", - "state": "success" - }, - { - "state": "retry", - "matcher": "status", - "expected": 404 - } - ] - }, - "UserExists": { - "delay": 1, - "operation": "GetUser", - "maxAttempts": 20, - "acceptors": [ - { - "state": "success", - "matcher": "status", - "expected": 200 - }, - { - "state": "retry", - "matcher": "error", - "expected": "NoSuchEntity" - } - ] - }, - "RoleExists": { - "delay": 1, - "operation": "GetRole", - "maxAttempts": 20, - "acceptors": [ - { - "state": "success", - "matcher": "status", - "expected": 200 - }, - { - "state": "retry", - "matcher": "error", - "expected": "NoSuchEntity" - } - ] - }, - "PolicyExists": { - "delay": 1, - "operation": "GetPolicy", - "maxAttempts": 20, - "acceptors": [ - { - "state": "success", - "matcher": "status", - "expected": 200 - }, - { - "state": "retry", - "matcher": "error", - "expected": "NoSuchEntity" - } - ] - } - } -} diff --git a/tools/code-generation/api-descriptions/kafka-2018-11-14.normal.json b/tools/code-generation/api-descriptions/kafka-2018-11-14.normal.json index 8bfccc86c2cd..cea9b9757e3b 100644 --- a/tools/code-generation/api-descriptions/kafka-2018-11-14.normal.json +++ b/tools/code-generation/api-descriptions/kafka-2018-11-14.normal.json @@ -61,6 +61,57 @@ ], "documentation": "\n

Associates one or more Scram Secrets with an Amazon MSK cluster.

\n " }, + "CreateChannel": { + "name": "CreateChannel", + "http": { + "method": "POST", + "requestUri": "/v1/clusters/{clusterArn}/channels", + "responseCode": 200 + }, + "input": { + "shape": "CreateChannelRequest" + }, + "output": { + "shape": "CreateChannelResponse", + "documentation": "\n

200 response

\n " + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " + }, + { + "shape": "UnauthorizedException", + "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " + }, + { + "shape": "InternalServerErrorException", + "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " + }, + { + "shape": "ForbiddenException", + "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " + }, + { + "shape": "NotFoundException", + "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " + }, + { + "shape": "ServiceUnavailableException", + "documentation": "\n

503 response

\n " + }, + { + "shape": "TooManyRequestsException", + "documentation": "\n

429 response

\n " + }, + { + "shape": "ConflictException", + "documentation": "\n

This cluster name already exists. Retry your request using another name.

\n " + } + ], + "documentation": "

Creates a Channel that streams records from an Amazon MSK Express cluster topic to Amazon S3 or Apache Iceberg.

", + "idempotent": true + }, "CreateCluster": { "name": "CreateCluster", "http": { @@ -405,6 +456,53 @@ ], "documentation": "\n

Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.

\n " }, + "DeleteChannel": { + "name": "DeleteChannel", + "http": { + "method": "DELETE", + "requestUri": "/v1/clusters/{clusterArn}/channels/{channelArn}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteChannelRequest" + }, + "output": { + "shape": "DeleteChannelResponse", + "documentation": "\n

Successful response.

\n " + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " + }, + { + "shape": "UnauthorizedException", + "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " + }, + { + "shape": "InternalServerErrorException", + "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " + }, + { + "shape": "ForbiddenException", + "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " + }, + { + "shape": "NotFoundException", + "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " + }, + { + "shape": "ServiceUnavailableException", + "documentation": "\n

503 response

\n " + }, + { + "shape": "TooManyRequestsException", + "documentation": "\n

429 response

\n " + } + ], + "documentation": "

Deletes the channel specified by channelArn from the cluster specified by clusterArn. The channel transitions through DELETING and is removed when the asynchronous delete completes.

", + "idempotent": true + }, "DeleteClusterPolicy": { "name": "DeleteClusterPolicy", "http": { @@ -695,6 +793,53 @@ ], "documentation": "\n

Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.

\n " }, + "DescribeChannel": { + "name": "DescribeChannel", + "http": { + "method": "GET", + "requestUri": "/v1/clusters/{clusterArn}/channels/{channelArn}", + "responseCode": 200 + }, + "input": { + "shape": "DescribeChannelRequest" + }, + "output": { + "shape": "DescribeChannelResponse", + "documentation": "\n

Successful response.

\n " + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " + }, + { + "shape": "UnauthorizedException", + "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " + }, + { + "shape": "InternalServerErrorException", + "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " + }, + { + "shape": "ForbiddenException", + "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " + }, + { + "shape": "NotFoundException", + "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " + }, + { + "shape": "ServiceUnavailableException", + "documentation": "\n

503 response

\n " + }, + { + "shape": "TooManyRequestsException", + "documentation": "\n

429 response

\n " + } + ], + "documentation": "

Returns the current configuration and state of a channel.

", + "readonly": true + }, "DescribeClusterOperation": { "name": "DescribeClusterOperation", "http": { @@ -1339,6 +1484,53 @@ ], "documentation": "\n

Returns a list of all the MSK clusters in the current Region.

\n " }, + "ListChannels": { + "name": "ListChannels", + "http": { + "method": "GET", + "requestUri": "/v1/clusters/{clusterArn}/channels", + "responseCode": 200 + }, + "input": { + "shape": "ListChannelsRequest" + }, + "output": { + "shape": "ListChannelsResponse", + "documentation": "\n

Successful response.

\n " + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " + }, + { + "shape": "UnauthorizedException", + "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " + }, + { + "shape": "InternalServerErrorException", + "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " + }, + { + "shape": "ForbiddenException", + "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " + }, + { + "shape": "NotFoundException", + "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " + }, + { + "shape": "ServiceUnavailableException", + "documentation": "\n

503 response

\n " + }, + { + "shape": "TooManyRequestsException", + "documentation": "\n

429 response

\n " + } + ], + "documentation": "

Returns the list of channels in a cluster.

", + "readonly": true + }, "ListConfigurationRevisions": { "name": "ListConfigurationRevisions", "http": { @@ -2094,6 +2286,45 @@ ], "documentation": "\n

Updates the cluster's connectivity configuration.

\n " }, + "UpdateChannel": { + "name": "UpdateChannel", + "http": { + "method": "PUT", + "requestUri": "/v1/clusters/{clusterArn}/channels/{channelArn}", + "responseCode": 200 + }, + "input": { + "shape": "UpdateChannelRequest" + }, + "output": { + "shape": "UpdateChannelResponse" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "UnauthorizedException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Updates the destination configuration of an existing channel. Exactly one of icebergDestinationUpdate or s3DestinationUpdate must be supplied.

", + "idempotent": true + }, "UpdateClusterConfiguration": { "name": "UpdateClusterConfiguration", "http": { @@ -2754,6 +2985,102 @@ }, "documentation": "\n

Information about the current software installed on the cluster.

\n " }, + "Catalog": { + "type": "structure", + "members": { + "CatalogArn": { + "shape": "__string", + "locationName": "catalogArn", + "documentation": "

The Amazon Resource Name (ARN) of the federated AWS Glue Data Catalog that projects the S3 Tables bucket. If omitted, MSK derives the catalog ARN from warehouseLocation.

" + }, + "WarehouseLocation": { + "shape": "__string", + "locationName": "warehouseLocation", + "documentation": "

The Amazon Resource Name (ARN) of the S3 Tables bucket that backs the Apache Iceberg warehouse.

" + } + }, + "documentation": "

Configuration of the AWS Glue Data Catalog and S3 Tables warehouse used by the Apache Iceberg destination.

" + }, + "ChannelInfo": { + "type": "structure", + "members": { + "ChannelArn": { + "shape": "__string", + "locationName": "channelArn", + "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the channel.

\n " + }, + "ChannelName": { + "shape": "__string", + "locationName": "channelName", + "documentation": "

The name of the channel.

" + }, + "Status": { + "shape": "ChannelStatus", + "locationName": "status", + "documentation": "

The current lifecycle state of the channel.

" + }, + "CreationTime": { + "shape": "__timestampIso8601", + "locationName": "creationTime", + "documentation": "\n

The time when the channel was created.

\n " + }, + "DestinationType": { + "shape": "ChannelDestinationType", + "locationName": "destinationType", + "documentation": "

The type of destination configured for the channel.

" + }, + "ClusterOperationArn": { + "shape": "__string", + "locationName": "clusterOperationArn", + "documentation": "

The Amazon Resource Name (ARN) of the in-flight cluster operation. Returned only while the channel is in CREATING, UPDATING, or DELETING.

" + } + }, + "documentation": "

Summary information about a channel returned by ListChannels.

", + "required": [ + "ChannelArn", + "ChannelName", + "Status", + "CreationTime", + "DestinationType" + ] + }, + "ChannelStatus": { + "type": "string", + "documentation": "

The lifecycle state of a channel.

", + "enum": [ + "CREATING", + "ACTIVE", + "UPDATING", + "DELETING", + "FAILED", + "SUSPENDING", + "SUSPENDED" + ] + }, + "ChannelDestinationType": { + "type": "string", + "documentation": "

The type of destination configured for the channel.

", + "enum": [ + "ICEBERG", + "S3" + ] + }, + "ChannelStateInfo": { + "type": "structure", + "members": { + "Code": { + "shape": "__string", + "locationName": "code", + "documentation": "

A short, machine-readable code identifying the failure cause.

" + }, + "Message": { + "shape": "__string", + "locationName": "message", + "documentation": "

A human-readable message describing the failure.

" + } + }, + "documentation": "

Additional context for the current channel state, populated when the channel is in FAILED.

" + }, "ClientAuthentication": { "type": "structure", "members": { @@ -3663,18 +3990,70 @@ "ClusterName" ] }, - "CreateClusterRequest": { + "CreateChannelRequest": { "type": "structure", "members": { - "BrokerNodeGroupInfo": { - "shape": "BrokerNodeGroupInfo", - "locationName": "brokerNodeGroupInfo", - "documentation": "\n

Information about the broker nodes in the cluster.

\n " - }, - "Rebalancing": { - "shape": "Rebalancing", - "locationName": "rebalancing", - "documentation": "\n

Specifies if intelligent rebalancing should be turned on for the new MSK Provisioned cluster with Express brokers. By default, intelligent rebalancing status is ACTIVE for all new clusters.

\n " + "ChannelName": { + "shape": "__string", + "locationName": "channelName", + "documentation": "

The name of the channel. Must be unique within the cluster.

" + }, + "ClusterArn": { + "shape": "__string", + "location": "uri", + "locationName": "clusterArn", + "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

\n " + }, + "EncryptionConfiguration": { + "shape": "EncryptionConfiguration", + "locationName": "encryptionConfiguration", + "documentation": "

The encryption configuration applied to the channel.

" + }, + "IcebergDestinationConfiguration": { + "shape": "IcebergDestinationConfiguration", + "locationName": "icebergDestinationConfiguration", + "documentation": "

The Apache Iceberg destination for the channel. Mutually exclusive with s3DestinationConfiguration.

" + }, + "S3DestinationConfiguration": { + "shape": "S3DestinationConfiguration", + "locationName": "s3DestinationConfiguration", + "documentation": "

The Amazon S3 destination for the channel. Mutually exclusive with icebergDestinationConfiguration.

" + }, + "Tags": { + "shape": "__mapOf__string", + "locationName": "tags", + "documentation": "

The tags attached to the channel.

" + }, + "TopicConfigurationList": { + "shape": "__listOfTopicConfiguration", + "locationName": "topicConfigurationList", + "documentation": "

The list of topic configurations for the channel. Currently exactly one topic must be specified.

" + }, + "LoggingInfo": { + "shape": "ChannelLoggingInfo", + "locationName": "loggingInfo", + "documentation": "

The destinations to which the channel publishes operational logs.

" + } + }, + "documentation": "

Creates a Channel that streams records from an Amazon MSK Express cluster topic to Amazon S3 or Apache Iceberg.

", + "required": [ + "ClusterArn", + "ChannelName", + "TopicConfigurationList" + ] + }, + "CreateClusterRequest": { + "type": "structure", + "members": { + "BrokerNodeGroupInfo": { + "shape": "BrokerNodeGroupInfo", + "locationName": "brokerNodeGroupInfo", + "documentation": "\n

Information about the broker nodes in the cluster.

\n " + }, + "Rebalancing": { + "shape": "Rebalancing", + "locationName": "rebalancing", + "documentation": "\n

Specifies if intelligent rebalancing should be turned on for the new MSK Provisioned cluster with Express brokers. By default, intelligent rebalancing status is ACTIVE for all new clusters.

\n " }, "ClientAuthentication": { "shape": "ClientAuthentication", @@ -3738,6 +4117,25 @@ "ClusterName" ] }, + "CreateChannelResponse": { + "type": "structure", + "members": { + "ChannelArn": { + "shape": "__string", + "locationName": "channelArn", + "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the channel.

\n " + }, + "ClusterOperationArn": { + "shape": "__string", + "locationName": "clusterOperationArn", + "documentation": "\n

The Amazon Resource Name (ARN) of the cluster operation.

\n " + } + }, + "required": [ + "ChannelArn" + ], + "documentation": "

Returns the channel ARN and the cluster-operation ARN that tracks the asynchronous create.

" + }, "CreateClusterResponse": { "type": "structure", "members": { @@ -4344,6 +4742,51 @@ } } }, + "DeadLetterQueueS3": { + "type": "structure", + "members": { + "BucketArn": { + "shape": "__string", + "locationName": "bucketArn", + "documentation": "

The Amazon Resource Name (ARN) of the dead-letter Amazon S3 bucket.

" + }, + "ErrorOutputPrefix": { + "shape": "__string", + "locationName": "errorOutputPrefix", + "documentation": "

An optional prefix prepended to every dead-letter Amazon S3 object key.

" + }, + "ExpectedBucketOwner": { + "shape": "__string", + "locationName": "expectedBucketOwner", + "documentation": "

Optional 12-digit AWS account ID expected to own the dead-letter Amazon S3 bucket.

" + } + }, + "documentation": "

Configuration of the Amazon S3 bucket where records that fail to deliver are stored.

", + "required": [ + "BucketArn" + ] + }, + "DeleteChannelRequest": { + "type": "structure", + "members": { + "ChannelArn": { + "shape": "__string", + "location": "uri", + "locationName": "channelArn", + "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the channel.

\n " + }, + "ClusterArn": { + "shape": "__string", + "location": "uri", + "locationName": "clusterArn", + "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

\n " + } + }, + "required": [ + "ClusterArn", + "ChannelArn" + ] + }, "DeleteClusterPolicyRequest": { "type": "structure", "members": { @@ -4362,6 +4805,25 @@ "type": "structure", "members": {} }, + "DeleteChannelResponse": { + "type": "structure", + "members": { + "ChannelArn": { + "shape": "__string", + "locationName": "channelArn", + "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the channel.

\n " + }, + "ClusterOperationArn": { + "shape": "__string", + "locationName": "clusterOperationArn", + "documentation": "\n

The Amazon Resource Name (ARN) of the cluster operation.

\n " + } + }, + "required": [ + "ChannelArn" + ], + "documentation": "

Returns the channel ARN and the cluster-operation ARN that tracks the asynchronous delete.

" + }, "DeleteConfigurationRequest": { "type": "structure", "members": { @@ -4455,6 +4917,27 @@ } } }, + "DescribeChannelRequest": { + "type": "structure", + "members": { + "ChannelArn": { + "shape": "__string", + "location": "uri", + "locationName": "channelArn", + "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the channel.

\n " + }, + "ClusterArn": { + "shape": "__string", + "location": "uri", + "locationName": "clusterArn", + "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

\n " + } + }, + "required": [ + "ClusterArn", + "ChannelArn" + ] + }, "DescribeClusterOperationRequest": { "type": "structure", "members": { @@ -4483,6 +4966,85 @@ "ClusterOperationArn" ] }, + "DescribeChannelResponse": { + "type": "structure", + "members": { + "ChannelArn": { + "shape": "__string", + "locationName": "channelArn", + "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the channel.

\n " + }, + "ChannelName": { + "shape": "__string", + "locationName": "channelName", + "documentation": "

The name of the channel.

" + }, + "EncryptionConfiguration": { + "shape": "EncryptionConfiguration", + "locationName": "encryptionConfiguration", + "documentation": "

The encryption configuration applied to the channel.

" + }, + "IcebergDestinationConfiguration": { + "shape": "IcebergDestinationConfiguration", + "locationName": "icebergDestinationConfiguration", + "documentation": "

The Apache Iceberg destination for the channel, if configured.

" + }, + "S3DestinationConfiguration": { + "shape": "S3DestinationConfiguration", + "locationName": "s3DestinationConfiguration", + "documentation": "

The Amazon S3 destination for the channel, if configured.

" + }, + "Status": { + "shape": "ChannelStatus", + "locationName": "status", + "documentation": "

The current lifecycle state of the channel.

" + }, + "DestinationType": { + "shape": "ChannelDestinationType", + "locationName": "destinationType", + "documentation": "

The type of destination configured for the channel.

" + }, + "CreationTime": { + "shape": "__timestampIso8601", + "locationName": "creationTime", + "documentation": "\n

The time when the channel was created.

\n " + }, + "TopicConfigurationList": { + "shape": "__listOfTopicConfiguration", + "locationName": "topicConfigurationList", + "documentation": "

The list of topic configurations for the channel.

" + }, + "LoggingInfo": { + "shape": "ChannelLoggingInfo", + "locationName": "loggingInfo", + "documentation": "

The destinations to which the channel publishes operational logs.

" + }, + "StateInfo": { + "shape": "ChannelStateInfo", + "locationName": "stateInfo", + "documentation": "

Additional context for the current channel state, populated when the channel is in FAILED.

" + }, + "ClusterOperationArn": { + "shape": "__string", + "locationName": "clusterOperationArn", + "documentation": "

The Amazon Resource Name (ARN) of the in-flight cluster operation. Returned only while the channel is in CREATING, UPDATING, or DELETING.

" + }, + "Tags": { + "shape": "__mapOf__string", + "locationName": "tags", + "documentation": "

The tags attached to the channel.

" + } + }, + "required": [ + "ChannelArn", + "ChannelName", + "TopicConfigurationList", + "Status", + "DestinationType", + "CreationTime" + ], + "documentation": "

Contains the current configuration and state of a channel.

" + }, "DescribeClusterOperationResponse": { "type": "structure", "members": { @@ -4975,6 +5537,27 @@ } } }, + "DestinationTable": { + "type": "structure", + "members": { + "DestinationDatabaseName": { + "shape": "__string", + "locationName": "destinationDatabaseName", + "documentation": "

The name of the destination namespace (database) in the AWS Glue Data Catalog.

" + }, + "DestinationTableName": { + "shape": "__string", + "locationName": "destinationTableName", + "documentation": "

The name of the destination Apache Iceberg table.

" + }, + "PartitionSpec": { + "shape": "PartitionSpec", + "locationName": "partitionSpec", + "documentation": "

The partition specification for the destination table.

" + } + }, + "documentation": "

Configuration of an Apache Iceberg destination table.

" + }, "EBSStorageInfo": { "type": "structure", "members": { @@ -4991,6 +5574,20 @@ }, "documentation": "\n

Contains information about the EBS storage volumes attached to Apache Kafka broker nodes.

\n " }, + "EncryptionConfiguration": { + "type": "structure", + "members": { + "KmsKeyArn": { + "shape": "__string", + "locationName": "kmsKeyArn", + "documentation": "

The Amazon Resource Name (ARN) of the AWS KMS key used to encrypt the data.

" + } + }, + "documentation": "

The AWS KMS encryption configuration applied to data at rest.

", + "required": [ + "KmsKeyArn" + ] + }, "EncryptionAtRest": { "type": "structure", "members": { @@ -5434,6 +6031,73 @@ } } }, + "IcebergDestinationConfiguration": { + "type": "structure", + "members": { + "AppendOnly": { + "shape": "__boolean", + "locationName": "appendOnly", + "documentation": "

Whether the destination is append-only. Must be true; updates and deletes are not supported.

" + }, + "Catalog": { + "shape": "Catalog", + "locationName": "catalog", + "documentation": "

The AWS Glue Data Catalog and S3 Tables warehouse used by the destination.

" + }, + "DataFreshnessInSeconds": { + "shape": "__integer", + "locationName": "dataFreshnessInSeconds", + "documentation": "

The maximum time, in seconds, that records buffer in MSK before being flushed to the destination. Allowed range: 300 to 900. Default: 600.

" + }, + "DeadLetterQueueS3": { + "shape": "DeadLetterQueueS3", + "locationName": "deadLetterQueueS3", + "documentation": "

The Amazon S3 bucket and prefix where MSK writes records that fail to deliver.

" + }, + "DestinationTableList": { + "shape": "__listOfDestinationTable", + "locationName": "destinationTableList", + "documentation": "

The destination Iceberg tables. Currently exactly one table must be specified.

" + }, + "SchemaEvolution": { + "shape": "SchemaEvolution", + "locationName": "schemaEvolution", + "documentation": "

Configuration controlling whether the destination table's schema is evolved to match incoming records.

" + }, + "ServiceExecutionRoleArn": { + "shape": "__string", + "locationName": "serviceExecutionRoleArn", + "documentation": "

The Amazon Resource Name (ARN) of the IAM role that MSK assumes to access the destination table, the AWS Glue Data Catalog, and the dead-letter Amazon S3 bucket.

" + }, + "TableCreation": { + "shape": "TableCreation", + "locationName": "tableCreation", + "documentation": "

Configuration controlling whether MSK creates the destination table if it does not already exist.

" + }, + "CompressionType": { + "shape": "IcebergCompressionType", + "locationName": "compressionType", + "documentation": "

The compression codec for Iceberg table data files. Defaults to ZSTD.

" + } + }, + "documentation": "

Configuration of an Apache Iceberg destination for a channel.

", + "required": [ + "DeadLetterQueueS3", + "DestinationTableList", + "ServiceExecutionRoleArn", + "SchemaEvolution", + "TableCreation", + "AppendOnly" + ] + }, + "IcebergCompressionType": { + "type": "string", + "enum": [ + "ZSTD", + "SNAPPY" + ], + "documentation": "

Compression codec for Iceberg table data files. Defaults to ZSTD.

" + }, "InternalServerErrorException": { "type": "structure", "members": { @@ -5747,6 +6411,54 @@ } } }, + "ListChannelsRequest": { + "type": "structure", + "members": { + "ClusterArn": { + "shape": "__string", + "location": "uri", + "locationName": "clusterArn", + "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

\n " + }, + "MaxResults": { + "shape": "MaxResults", + "location": "querystring", + "locationName": "maxResults", + "documentation": "\n

Maximum number of channels to return in a single response.

\n " + }, + "NextToken": { + "shape": "__string", + "location": "querystring", + "locationName": "nextToken", + "documentation": "\n

If the response of ListChannels is truncated, it returns a nextToken in the response. This nextToken should be sent in the subsequent request to ListChannels.

\n " + }, + "TopicNameFilter": { + "shape": "__string", + "location": "querystring", + "locationName": "topicNameFilter", + "documentation": "\n

Filters results to channels whose topic name matches the specified value.

\n " + } + }, + "required": [ + "ClusterArn" + ] + }, + "ListChannelsResponse": { + "type": "structure", + "members": { + "Channels": { + "shape": "__listOfChannelInfo", + "locationName": "channels", + "documentation": "

The list of channels in the cluster.

" + }, + "NextToken": { + "shape": "__string", + "locationName": "nextToken", + "documentation": "

If the response from ListChannels is truncated, this token is included. Send it as the nextToken parameter on a subsequent ListChannels call to retrieve the next page.

" + } + }, + "documentation": "

Returns the list of channels in the cluster.

" + }, "ListClustersRequest": { "type": "structure", "members": { @@ -6331,6 +7043,27 @@ "Enabled" ] }, + "ChannelLoggingInfo": { + "type": "structure", + "members": { + "CloudWatchLogs": { + "shape": "CloudWatchLogs", + "locationName": "cloudWatchLogs", + "documentation": "

Details of the CloudWatch Logs destination for Channel logs.

" + }, + "Firehose": { + "shape": "Firehose", + "locationName": "firehose", + "documentation": "

Details of the Kinesis Data Firehose delivery stream that is the destination for Channel logs.

" + }, + "S3": { + "shape": "S3", + "locationName": "s3", + "documentation": "

Details of the Amazon S3 destination for Channel logs.

" + } + }, + "documentation": "

Configuration for the destinations to which the channel publishes operational logs.

" + }, "MutableClusterInfo": { "type": "structure", "members": { @@ -6496,6 +7229,43 @@ "Prometheus" ] }, + "PartitionSource": { + "type": "structure", + "members": { + "SourceName": { + "shape": "__string", + "locationName": "sourceName", + "documentation": "\n

Source name.

\n " + } + }, + "documentation": "

A source column used by an Apache Iceberg destination table's partition specification.

" + }, + "PartitionSpec": { + "type": "structure", + "members": { + "PartitionStrategy": { + "shape": "PartitionStrategy", + "locationName": "partitionStrategy", + "documentation": "

The partitioning strategy applied to records written to the table.

" + }, + "SourceList": { + "shape": "__listOfPartitionSource", + "locationName": "sourceList", + "documentation": "

The source columns used by the partitioning strategy. For TIME_HOUR, must contain exactly one source column whose value is a timestamp.

" + } + }, + "documentation": "

Partition specification for an Apache Iceberg destination table.

", + "required": [ + "PartitionStrategy" + ] + }, + "PartitionStrategy": { + "type": "string", + "documentation": "

The partitioning strategy used to partition records in the destination Apache Iceberg table.

", + "enum": [ + "TIME_HOUR" + ] + }, "Prometheus": { "type": "structure", "members": { @@ -6555,6 +7325,34 @@ }, "documentation": "Public access control for brokers." }, + "RecordConverter": { + "type": "structure", + "members": { + "ValueConverter": { + "shape": "ValueConverter", + "locationName": "valueConverter", + "documentation": "

The deserialization format applied to Apache Kafka record values.

" + } + }, + "documentation": "

Configuration that controls how Apache Kafka record values are deserialized for the destination.

", + "required": [ + "ValueConverter" + ] + }, + "RecordSchema": { + "type": "structure", + "members": { + "GsrArn": { + "shape": "__string", + "locationName": "gsrArn", + "documentation": "

The Amazon Resource Name (ARN) of the AWS Glue Schema Registry schema (not registry) used to validate records for the destination Apache Iceberg table.

" + } + }, + "documentation": "

Schema configuration that controls how Apache Kafka record values are validated.

", + "required": [ + "GsrArn" + ] + }, "PutClusterPolicyRequest": { "type": "structure", "members": { @@ -6657,6 +7455,17 @@ }, "documentation": "\n

Details for client authentication using SASL.

\n " }, + "SchemaEvolution": { + "type": "structure", + "members": { + "EnableSchemaEvolution": { + "shape": "__boolean", + "locationName": "enableSchemaEvolution", + "documentation": "

Whether to allow MSK to evolve the destination table's schema. Must be false for the current release.

" + } + }, + "documentation": "

Configuration controlling whether the Apache Iceberg destination table's schema is evolved as incoming records change.

" + }, "Sasl": { "type": "structure", "members": { @@ -7081,6 +7890,17 @@ "TIERED" ] }, + "TableCreation": { + "type": "structure", + "members": { + "EnableTableCreation": { + "shape": "__boolean", + "locationName": "enableTableCreation", + "documentation": "

Whether MSK creates the destination table on the customer's behalf. Must be true for the current release.

" + } + }, + "documentation": "

Configuration controlling whether MSK creates the destination Apache Iceberg table if it does not already exist.

" + }, "TagResourceRequest": { "type": "structure", "members": { @@ -7128,6 +7948,31 @@ }, "documentation": "\n

Details for client authentication using TLS.

\n " }, + "TopicConfiguration": { + "type": "structure", + "members": { + "RecordConverter": { + "shape": "RecordConverter", + "locationName": "recordConverter", + "documentation": "

Configuration that controls how Apache Kafka record values are deserialized for the destination.

" + }, + "RecordSchema": { + "shape": "RecordSchema", + "locationName": "recordSchema", + "documentation": "

The schema used to validate records when the value converter requires one (for example, JSON_SCHEMA_GSR).

" + }, + "TopicArn": { + "shape": "__string", + "locationName": "topicArn", + "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the topic.

\n " + } + }, + "documentation": "

Configuration of an Apache Kafka topic that feeds a channel.

", + "required": [ + "RecordConverter", + "TopicArn" + ] + }, "TopicInfo": { "type": "structure", "members": { @@ -7467,6 +8312,175 @@ } } }, + "S3CompressionType": { + "type": "string", + "enum": [ + "NONE", + "GZIP", + "ZSTD" + ], + "documentation": "

The compression codec applied to delivered Amazon S3 objects.

" + }, + "S3DestinationConfiguration": { + "type": "structure", + "members": { + "DataFreshnessInSeconds": { + "shape": "__integer", + "locationName": "dataFreshnessInSeconds", + "documentation": "

The maximum time, in seconds, that records buffer in MSK before being flushed to the destination. Allowed range: 300 to 900. Default: 600.

" + }, + "DeadLetterQueueS3": { + "shape": "DeadLetterQueueS3", + "locationName": "deadLetterQueueS3", + "documentation": "

The Amazon S3 bucket and prefix where MSK writes records that fail to deliver.

" + }, + "ServiceExecutionRoleArn": { + "shape": "__string", + "locationName": "serviceExecutionRoleArn", + "documentation": "

The Amazon Resource Name (ARN) of the IAM role that MSK assumes to write to the destination Amazon S3 bucket and the dead-letter bucket.

" + }, + "Storage": { + "shape": "S3Storage", + "locationName": "storage", + "documentation": "

The Amazon S3 bucket, prefix, and storage class for delivered records.

" + } + }, + "required": [ + "Storage", + "ServiceExecutionRoleArn", + "DeadLetterQueueS3" + ], + "documentation": "

Configuration of an Amazon S3 destination for a channel.

" + }, + "IcebergDestinationUpdate": { + "type": "structure", + "members": { + "DataFreshnessInSeconds": { + "shape": "__integer", + "locationName": "dataFreshnessInSeconds", + "documentation": "

The maximum time, in seconds, that records buffer in MSK before being flushed to the destination. Allowed range: 300 to 900.

" + } + }, + "required": [ + "DataFreshnessInSeconds" + ], + "documentation": "

Update payload for an Apache Iceberg destination.

" + }, + "S3DestinationUpdate": { + "type": "structure", + "members": { + "DataFreshnessInSeconds": { + "shape": "__integer", + "locationName": "dataFreshnessInSeconds", + "documentation": "

The maximum time, in seconds, that records buffer in MSK before being flushed to the destination. Allowed range: 300 to 900.

" + } + }, + "required": [ + "DataFreshnessInSeconds" + ], + "documentation": "

Update payload for an Amazon S3 destination.

" + }, + "S3Storage": { + "type": "structure", + "members": { + "BucketArn": { + "shape": "__string", + "locationName": "bucketArn", + "documentation": "

The Amazon Resource Name (ARN) of the destination Amazon S3 bucket.

" + }, + "CompressionType": { + "shape": "S3CompressionType", + "locationName": "compressionType", + "documentation": "

The compression codec applied to delivered Amazon S3 objects.

" + }, + "OutputPrefix": { + "shape": "__string", + "locationName": "outputPrefix", + "documentation": "

An optional prefix prepended to every Amazon S3 object key written by the channel.

" + }, + "OutputKeyTemplate": { + "shape": "__string", + "locationName": "outputKeyTemplate", + "documentation": "

An optional template that controls the Amazon S3 object key for each delivered record. Supports the placeholders !{partition-id}, !{sequence-number}, and !{kafka-offset}.

" + }, + "StorageClass": { + "shape": "S3StorageClass", + "locationName": "storageClass", + "documentation": "

The Amazon S3 storage class for delivered objects.

" + }, + "ExpectedBucketOwner": { + "shape": "__string", + "locationName": "expectedBucketOwner", + "documentation": "

Optional 12-digit AWS account ID expected to own the Amazon S3 bucket.

" + } + }, + "required": [ + "BucketArn", + "StorageClass", + "CompressionType" + ], + "documentation": "

Storage configuration for an Amazon S3 destination bucket.

" + }, + "S3StorageClass": { + "type": "string", + "enum": [ + "STANDARD", + "INTELLIGENT_TIERING", + "GLACIER_IR" + ], + "documentation": "

The Amazon S3 storage class applied to delivered objects.

" + }, + "UpdateChannelRequest": { + "type": "structure", + "members": { + "ChannelArn": { + "shape": "__string", + "location": "uri", + "locationName": "channelArn", + "documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the channel.

" + }, + "ClusterArn": { + "shape": "__string", + "location": "uri", + "locationName": "clusterArn", + "documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

" + }, + "IcebergDestinationUpdate": { + "shape": "IcebergDestinationUpdate", + "locationName": "icebergDestinationUpdate", + "documentation": "

Updates fields on an Apache Iceberg destination. Use only when the channel was created with an Iceberg destination.

" + }, + "S3DestinationUpdate": { + "shape": "S3DestinationUpdate", + "locationName": "s3DestinationUpdate", + "documentation": "

Updates fields on an Amazon S3 destination. Use only when the channel was created with an Amazon S3 destination.

" + } + }, + "required": [ + "ClusterArn", + "ChannelArn" + ], + "documentation": "

Updates an existing channel's destination configuration. You must update the same destination type the channel was created with; the destination type cannot be changed.

" + }, + "UpdateChannelResponse": { + "type": "structure", + "members": { + "ChannelArn": { + "shape": "__string", + "locationName": "channelArn", + "documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the channel.

" + }, + "ClusterOperationArn": { + "shape": "__string", + "locationName": "clusterOperationArn", + "documentation": "\n

The Amazon Resource Name (ARN) of the cluster operation.

\n " + } + }, + "required": [ + "ChannelArn" + ], + "documentation": "

Returns the channel ARN and the cluster-operation ARN that tracks the asynchronous update.

" + }, "UpdateClusterConfigurationRequest": { "type": "structure", "members": { @@ -7922,6 +8936,16 @@ "AWSSERVICE" ] }, + "ValueConverter": { + "type": "string", + "documentation": "

The deserialization format applied to Apache Kafka record values.

", + "enum": [ + "BYTE_ARRAY", + "JSON", + "JSON_SCHEMA_GSR", + "STRING" + ] + }, "VpcConnectionInfo": { "type": "structure", "members": { @@ -8096,6 +9120,12 @@ "shape": "ClusterOperationV2Summary" } }, + "__listOfChannelInfo": { + "type": "list", + "member": { + "shape": "ChannelInfo" + } + }, "__listOfClusterOperationStep": { "type": "list", "member": { @@ -8108,6 +9138,18 @@ "shape": "CompatibleKafkaVersion" } }, + "__listOfDestinationTable": { + "type": "list", + "member": { + "shape": "DestinationTable" + } + }, + "__listOfTopicConfiguration": { + "type": "list", + "member": { + "shape": "TopicConfiguration" + } + }, "__listOfVpcConfig": { "type": "list", "member": { @@ -8156,6 +9198,12 @@ "shape": "NodeInfo" } }, + "__listOfPartitionSource": { + "type": "list", + "member": { + "shape": "PartitionSource" + } + }, "__listOfClientVpcConnection": { "type": "list", "member": { diff --git a/tools/code-generation/api-descriptions/kafka/2018-11-14/api-2.json b/tools/code-generation/api-descriptions/kafka/2018-11-14/api-2.json deleted file mode 100644 index 247cc907a340..000000000000 --- a/tools/code-generation/api-descriptions/kafka/2018-11-14/api-2.json +++ /dev/null @@ -1,7975 +0,0 @@ -{ - "metadata": { - "apiVersion": "2018-11-14", - "endpointPrefix": "kafka", - "signingName": "kafka", - "serviceFullName": "Managed Streaming for Kafka", - "serviceAbbreviation": "Kafka", - "serviceId": "Kafka", - "protocol": "rest-json", - "jsonVersion": "1.1", - "uid": "kafka-2018-11-14", - "signatureVersion": "v4", - "auth": [ - "aws.auth#sigv4" - ] - }, - "operations": { - "BatchAssociateScramSecret": { - "name": "BatchAssociateScramSecret", - "http": { - "method": "POST", - "requestUri": "/v1/clusters/{clusterArn}/scram-secrets", - "responseCode": 200 - }, - "input": { - "shape": "BatchAssociateScramSecretRequest" - }, - "output": { - "shape": "BatchAssociateScramSecretResponse" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - }, - { - "shape": "NotFoundException" - }, - { - "shape": "ServiceUnavailableException" - }, - { - "shape": "TooManyRequestsException" - } - ] - }, - "CreateCluster": { - "name": "CreateCluster", - "http": { - "method": "POST", - "requestUri": "/v1/clusters", - "responseCode": 200 - }, - "input": { - "shape": "CreateClusterRequest" - }, - "output": { - "shape": "CreateClusterResponse" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "ForbiddenException" - }, - { - "shape": "ServiceUnavailableException" - }, - { - "shape": "TooManyRequestsException" - }, - { - "shape": "ConflictException" - } - ] - }, - "CreateClusterV2": { - "name": "CreateClusterV2", - "http": { - "method": "POST", - "requestUri": "/api/v2/clusters", - "responseCode": 200 - }, - "input": { - "shape": "CreateClusterV2Request" - }, - "output": { - "shape": "CreateClusterV2Response" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "ForbiddenException" - }, - { - "shape": "ServiceUnavailableException" - }, - { - "shape": "TooManyRequestsException" - }, - { - "shape": "ConflictException" - } - ] - }, - "CreateConfiguration": { - "name": "CreateConfiguration", - "http": { - "method": "POST", - "requestUri": "/v1/configurations", - "responseCode": 200 - }, - "input": { - "shape": "CreateConfigurationRequest" - }, - "output": { - "shape": "CreateConfigurationResponse" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "ForbiddenException" - }, - { - "shape": "ServiceUnavailableException" - }, - { - "shape": "TooManyRequestsException" - }, - { - "shape": "ConflictException" - } - ] - }, - "CreateChannel": { - "name": "CreateChannel", - "http": { - "method": "POST", - "requestUri": "/v1/clusters/{clusterArn}/channels", - "responseCode": 200 - }, - "input": { - "shape": "CreateChannelRequest" - }, - "output": { - "shape": "CreateChannelResponse" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - }, - { - "shape": "NotFoundException" - }, - { - "shape": "ServiceUnavailableException" - }, - { - "shape": "TooManyRequestsException" - }, - { - "shape": "ConflictException" - } - ], - "idempotent": true - }, - "CreateReplicator": { - "name": "CreateReplicator", - "http": { - "method": "POST", - "requestUri": "/replication/v1/replicators", - "responseCode": 200 - }, - "input": { - "shape": "CreateReplicatorRequest" - }, - "output": { - "shape": "CreateReplicatorResponse" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - }, - { - "shape": "NotFoundException" - }, - { - "shape": "ServiceUnavailableException" - }, - { - "shape": "TooManyRequestsException" - }, - { - "shape": "ConflictException" - } - ] - }, - "CreateTopic": { - "name": "CreateTopic", - "http": { - "method": "POST", - "requestUri": "/v1/clusters/{clusterArn}/topics", - "responseCode": 200 - }, - "input": { - "shape": "CreateTopicRequest" - }, - "output": { - "shape": "CreateTopicResponse" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "ForbiddenException" - }, - { - "shape": "ServiceUnavailableException" - }, - { - "shape": "TooManyRequestsException" - }, - { - "shape": "ConflictException" - }, - { - "shape": "TopicExistsException" - }, - { - "shape": "ClusterConnectivityException" - }, - { - "shape": "KafkaTimeoutException" - }, - { - "shape": "UnknownTopicOrPartitionException" - }, - { - "shape": "ControllerMovedException" - }, - { - "shape": "NotControllerException" - }, - { - "shape": "ReassignmentInProgressException" - }, - { - "shape": "GroupSubscribedToTopicException" - }, - { - "shape": "KafkaRequestException" - } - ] - }, - "CreateVpcConnection": { - "name": "CreateVpcConnection", - "http": { - "method": "POST", - "requestUri": "/v1/vpc-connection", - "responseCode": 200 - }, - "input": { - "shape": "CreateVpcConnectionRequest" - }, - "output": { - "shape": "CreateVpcConnectionResponse" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "ForbiddenException" - }, - { - "shape": "ServiceUnavailableException" - }, - { - "shape": "TooManyRequestsException" - }, - { - "shape": "ConflictException" - } - ] - }, - "DeleteCluster": { - "name": "DeleteCluster", - "http": { - "method": "DELETE", - "requestUri": "/v1/clusters/{clusterArn}", - "responseCode": 200 - }, - "input": { - "shape": "DeleteClusterRequest" - }, - "output": { - "shape": "DeleteClusterResponse" - }, - "errors": [ - { - "shape": "NotFoundException" - }, - { - "shape": "BadRequestException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - } - ] - }, - "DeleteChannel": { - "name": "DeleteChannel", - "http": { - "method": "DELETE", - "requestUri": "/v1/clusters/{clusterArn}/channels/{channelArn}", - "responseCode": 200 - }, - "input": { - "shape": "DeleteChannelRequest" - }, - "output": { - "shape": "DeleteChannelResponse" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - }, - { - "shape": "NotFoundException" - }, - { - "shape": "ServiceUnavailableException" - }, - { - "shape": "TooManyRequestsException" - } - ], - "idempotent": true - }, - "DeleteConfiguration": { - "name": "DeleteConfiguration", - "http": { - "method": "DELETE", - "requestUri": "/v1/configurations/{arn}", - "responseCode": 200 - }, - "input": { - "shape": "DeleteConfigurationRequest" - }, - "output": { - "shape": "DeleteConfigurationResponse" - }, - "errors": [ - { - "shape": "NotFoundException" - }, - { - "shape": "BadRequestException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - } - ] - }, - "DeleteReplicator": { - "name": "DeleteReplicator", - "http": { - "method": "DELETE", - "requestUri": "/replication/v1/replicators/{replicatorArn}", - "responseCode": 200 - }, - "input": { - "shape": "DeleteReplicatorRequest" - }, - "output": { - "shape": "DeleteReplicatorResponse" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - }, - { - "shape": "NotFoundException" - }, - { - "shape": "ServiceUnavailableException" - }, - { - "shape": "TooManyRequestsException" - } - ] - }, - "DeleteTopic": { - "name": "DeleteTopic", - "http": { - "method": "DELETE", - "requestUri": "/v1/clusters/{clusterArn}/topics/{topicName}", - "responseCode": 200 - }, - "input": { - "shape": "DeleteTopicRequest" - }, - "output": { - "shape": "DeleteTopicResponse" - }, - "errors": [ - { - "shape": "NotFoundException" - }, - { - "shape": "BadRequestException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - } - ] - }, - "DeleteVpcConnection": { - "name": "DeleteVpcConnection", - "http": { - "method": "DELETE", - "requestUri": "/v1/vpc-connection/{arn}", - "responseCode": 200 - }, - "input": { - "shape": "DeleteVpcConnectionRequest" - }, - "output": { - "shape": "DeleteVpcConnectionResponse" - }, - "errors": [ - { - "shape": "NotFoundException" - }, - { - "shape": "BadRequestException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - }, - { - "shape": "ClusterConnectivityException" - }, - { - "shape": "KafkaTimeoutException" - }, - { - "shape": "UnknownTopicOrPartitionException" - }, - { - "shape": "ControllerMovedException" - }, - { - "shape": "NotControllerException" - }, - { - "shape": "ReassignmentInProgressException" - }, - { - "shape": "GroupSubscribedToTopicException" - }, - { - "shape": "KafkaRequestException" - } - ] - }, - "DescribeCluster": { - "name": "DescribeCluster", - "http": { - "method": "GET", - "requestUri": "/v1/clusters/{clusterArn}", - "responseCode": 200 - }, - "input": { - "shape": "DescribeClusterRequest" - }, - "output": { - "shape": "DescribeClusterResponse" - }, - "errors": [ - { - "shape": "NotFoundException" - }, - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - } - ] - }, - "DescribeClusterV2": { - "name": "DescribeClusterV2", - "http": { - "method": "GET", - "requestUri": "/api/v2/clusters/{clusterArn}", - "responseCode": 200 - }, - "input": { - "shape": "DescribeClusterV2Request" - }, - "output": { - "shape": "DescribeClusterV2Response" - }, - "errors": [ - { - "shape": "NotFoundException" - }, - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - } - ] - }, - "DescribeClusterOperation": { - "name": "DescribeClusterOperation", - "http": { - "method": "GET", - "requestUri": "/v1/operations/{clusterOperationArn}", - "responseCode": 200 - }, - "input": { - "shape": "DescribeClusterOperationRequest" - }, - "output": { - "shape": "DescribeClusterOperationResponse" - }, - "errors": [ - { - "shape": "NotFoundException" - }, - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - } - ] - }, - "DescribeClusterOperationV2": { - "name": "DescribeClusterOperationV2", - "http": { - "method": "GET", - "requestUri": "/api/v2/operations/{clusterOperationArn}", - "responseCode": 200 - }, - "input": { - "shape": "DescribeClusterOperationV2Request" - }, - "output": { - "shape": "DescribeClusterOperationV2Response" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - }, - { - "shape": "NotFoundException" - }, - { - "shape": "ServiceUnavailableException" - }, - { - "shape": "TooManyRequestsException" - } - ] - }, - "DescribeChannel": { - "name": "DescribeChannel", - "http": { - "method": "GET", - "requestUri": "/v1/clusters/{clusterArn}/channels/{channelArn}", - "responseCode": 200 - }, - "input": { - "shape": "DescribeChannelRequest" - }, - "output": { - "shape": "DescribeChannelResponse" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - }, - { - "shape": "NotFoundException" - }, - { - "shape": "ServiceUnavailableException" - }, - { - "shape": "TooManyRequestsException" - } - ], - "readonly": true - }, - "DescribeConfiguration": { - "name": "DescribeConfiguration", - "http": { - "method": "GET", - "requestUri": "/v1/configurations/{arn}", - "responseCode": 200 - }, - "input": { - "shape": "DescribeConfigurationRequest" - }, - "output": { - "shape": "DescribeConfigurationResponse" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - }, - { - "shape": "NotFoundException" - }, - { - "shape": "ServiceUnavailableException" - } - ] - }, - "DescribeConfigurationRevision": { - "name": "DescribeConfigurationRevision", - "http": { - "method": "GET", - "requestUri": "/v1/configurations/{arn}/revisions/{revision}", - "responseCode": 200 - }, - "input": { - "shape": "DescribeConfigurationRevisionRequest" - }, - "output": { - "shape": "DescribeConfigurationRevisionResponse" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - }, - { - "shape": "NotFoundException" - }, - { - "shape": "ServiceUnavailableException" - } - ] - }, - "DescribeReplicator": { - "name": "DescribeReplicator", - "http": { - "method": "GET", - "requestUri": "/replication/v1/replicators/{replicatorArn}", - "responseCode": 200 - }, - "input": { - "shape": "DescribeReplicatorRequest" - }, - "output": { - "shape": "DescribeReplicatorResponse" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - }, - { - "shape": "NotFoundException" - }, - { - "shape": "ServiceUnavailableException" - }, - { - "shape": "TooManyRequestsException" - } - ] - }, - "DescribeTopic": { - "name": "DescribeTopic", - "http": { - "method": "GET", - "requestUri": "/v1/clusters/{clusterArn}/topics/{topicName}", - "responseCode": 200 - }, - "input": { - "shape": "DescribeTopicRequest" - }, - "output": { - "shape": "DescribeTopicResponse" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - }, - { - "shape": "NotFoundException" - } - ] - }, - "DescribeTopicPartitions": { - "name": "DescribeTopicPartitions", - "http": { - "method": "GET", - "requestUri": "/v1/clusters/{clusterArn}/topics/{topicName}/partitions", - "responseCode": 200 - }, - "input": { - "shape": "DescribeTopicPartitionsRequest" - }, - "output": { - "shape": "DescribeTopicPartitionsResponse" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - }, - { - "shape": "NotFoundException" - } - ] - }, - "DescribeVpcConnection": { - "name": "DescribeVpcConnection", - "http": { - "method": "GET", - "requestUri": "/v1/vpc-connection/{arn}", - "responseCode": 200 - }, - "input": { - "shape": "DescribeVpcConnectionRequest" - }, - "output": { - "shape": "DescribeVpcConnectionResponse" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - }, - { - "shape": "NotFoundException" - }, - { - "shape": "ServiceUnavailableException" - } - ] - }, - "BatchDisassociateScramSecret": { - "name": "BatchDisassociateScramSecret", - "http": { - "method": "PATCH", - "requestUri": "/v1/clusters/{clusterArn}/scram-secrets", - "responseCode": 200 - }, - "input": { - "shape": "BatchDisassociateScramSecretRequest" - }, - "output": { - "shape": "BatchDisassociateScramSecretResponse" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - }, - { - "shape": "NotFoundException" - }, - { - "shape": "ServiceUnavailableException" - }, - { - "shape": "TooManyRequestsException" - } - ] - }, - "GetBootstrapBrokers": { - "name": "GetBootstrapBrokers", - "http": { - "method": "GET", - "requestUri": "/v1/clusters/{clusterArn}/bootstrap-brokers", - "responseCode": 200 - }, - "input": { - "shape": "GetBootstrapBrokersRequest" - }, - "output": { - "shape": "GetBootstrapBrokersResponse" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ConflictException" - }, - { - "shape": "ForbiddenException" - } - ] - }, - "GetCompatibleKafkaVersions": { - "name": "GetCompatibleKafkaVersions", - "http": { - "method": "GET", - "requestUri": "/v1/compatible-kafka-versions", - "responseCode": 200 - }, - "input": { - "shape": "GetCompatibleKafkaVersionsRequest" - }, - "output": { - "shape": "GetCompatibleKafkaVersionsResponse" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - }, - { - "shape": "NotFoundException" - }, - { - "shape": "ServiceUnavailableException" - }, - { - "shape": "TooManyRequestsException" - } - ] - }, - "ListChannels": { - "name": "ListChannels", - "http": { - "method": "GET", - "requestUri": "/v1/clusters/{clusterArn}/channels", - "responseCode": 200 - }, - "input": { - "shape": "ListChannelsRequest" - }, - "output": { - "shape": "ListChannelsResponse" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - }, - { - "shape": "NotFoundException" - }, - { - "shape": "ServiceUnavailableException" - }, - { - "shape": "TooManyRequestsException" - } - ], - "readonly": true - }, - "ListClusterOperations": { - "name": "ListClusterOperations", - "http": { - "method": "GET", - "requestUri": "/v1/clusters/{clusterArn}/operations", - "responseCode": 200 - }, - "input": { - "shape": "ListClusterOperationsRequest" - }, - "output": { - "shape": "ListClusterOperationsResponse" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "ForbiddenException" - } - ] - }, - "ListClusterOperationsV2": { - "name": "ListClusterOperationsV2", - "http": { - "method": "GET", - "requestUri": "/api/v2/clusters/{clusterArn}/operations", - "responseCode": 200 - }, - "input": { - "shape": "ListClusterOperationsV2Request" - }, - "output": { - "shape": "ListClusterOperationsV2Response" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - }, - { - "shape": "NotFoundException" - }, - { - "shape": "ServiceUnavailableException" - }, - { - "shape": "TooManyRequestsException" - } - ] - }, - "ListClusters": { - "name": "ListClusters", - "http": { - "method": "GET", - "requestUri": "/v1/clusters", - "responseCode": 200 - }, - "input": { - "shape": "ListClustersRequest" - }, - "output": { - "shape": "ListClustersResponse" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "ForbiddenException" - } - ] - }, - "ListClustersV2": { - "name": "ListClustersV2", - "http": { - "method": "GET", - "requestUri": "/api/v2/clusters", - "responseCode": 200 - }, - "input": { - "shape": "ListClustersV2Request" - }, - "output": { - "shape": "ListClustersV2Response" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "ForbiddenException" - } - ] - }, - "ListConfigurationRevisions": { - "name": "ListConfigurationRevisions", - "http": { - "method": "GET", - "requestUri": "/v1/configurations/{arn}/revisions", - "responseCode": 200 - }, - "input": { - "shape": "ListConfigurationRevisionsRequest" - }, - "output": { - "shape": "ListConfigurationRevisionsResponse" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - }, - { - "shape": "NotFoundException" - }, - { - "shape": "ServiceUnavailableException" - } - ] - }, - "ListConfigurations": { - "name": "ListConfigurations", - "http": { - "method": "GET", - "requestUri": "/v1/configurations", - "responseCode": 200 - }, - "input": { - "shape": "ListConfigurationsRequest" - }, - "output": { - "shape": "ListConfigurationsResponse" - }, - "errors": [ - { - "shape": "ServiceUnavailableException" - }, - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - } - ] - }, - "ListKafkaVersions": { - "name": "ListKafkaVersions", - "http": { - "method": "GET", - "requestUri": "/v1/kafka-versions", - "responseCode": 200 - }, - "input": { - "shape": "ListKafkaVersionsRequest" - }, - "output": { - "shape": "ListKafkaVersionsResponse" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - } - ] - }, - "ListNodes": { - "name": "ListNodes", - "http": { - "method": "GET", - "requestUri": "/v1/clusters/{clusterArn}/nodes", - "responseCode": 200 - }, - "input": { - "shape": "ListNodesRequest" - }, - "output": { - "shape": "ListNodesResponse" - }, - "errors": [ - { - "shape": "NotFoundException" - }, - { - "shape": "BadRequestException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - } - ] - }, - "ListReplicators": { - "name": "ListReplicators", - "http": { - "method": "GET", - "requestUri": "/replication/v1/replicators", - "responseCode": 200 - }, - "input": { - "shape": "ListReplicatorsRequest" - }, - "output": { - "shape": "ListReplicatorsResponse" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - }, - { - "shape": "NotFoundException" - }, - { - "shape": "ServiceUnavailableException" - }, - { - "shape": "TooManyRequestsException" - } - ] - }, - "ListScramSecrets": { - "name": "ListScramSecrets", - "http": { - "method": "GET", - "requestUri": "/v1/clusters/{clusterArn}/scram-secrets", - "responseCode": 200 - }, - "input": { - "shape": "ListScramSecretsRequest" - }, - "output": { - "shape": "ListScramSecretsResponse" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - }, - { - "shape": "NotFoundException" - }, - { - "shape": "ServiceUnavailableException" - }, - { - "shape": "TooManyRequestsException" - } - ] - }, - "ListTagsForResource": { - "name": "ListTagsForResource", - "http": { - "method": "GET", - "requestUri": "/v1/tags/{resourceArn}", - "responseCode": 200 - }, - "input": { - "shape": "ListTagsForResourceRequest" - }, - "output": { - "shape": "ListTagsForResourceResponse" - }, - "errors": [ - { - "shape": "NotFoundException" - }, - { - "shape": "BadRequestException" - }, - { - "shape": "InternalServerErrorException" - } - ] - }, - "ListClientVpcConnections": { - "name": "ListClientVpcConnections", - "http": { - "method": "GET", - "requestUri": "/v1/clusters/{clusterArn}/client-vpc-connections", - "responseCode": 200 - }, - "input": { - "shape": "ListClientVpcConnectionsRequest" - }, - "output": { - "shape": "ListClientVpcConnectionsResponse" - }, - "errors": [ - { - "shape": "ServiceUnavailableException" - }, - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - } - ] - }, - "ListVpcConnections": { - "name": "ListVpcConnections", - "http": { - "method": "GET", - "requestUri": "/v1/vpc-connections", - "responseCode": 200 - }, - "input": { - "shape": "ListVpcConnectionsRequest" - }, - "output": { - "shape": "ListVpcConnectionsResponse" - }, - "errors": [ - { - "shape": "ServiceUnavailableException" - }, - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - } - ] - }, - "ListTopics": { - "name": "ListTopics", - "http": { - "method": "GET", - "requestUri": "/v1/clusters/{clusterArn}/topics", - "responseCode": 200 - }, - "input": { - "shape": "ListTopicsRequest" - }, - "output": { - "shape": "ListTopicsResponse" - }, - "errors": [ - { - "shape": "ServiceUnavailableException" - }, - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - } - ] - }, - "RejectClientVpcConnection": { - "name": "RejectClientVpcConnection", - "http": { - "method": "PUT", - "requestUri": "/v1/clusters/{clusterArn}/client-vpc-connection", - "responseCode": 200 - }, - "input": { - "shape": "RejectClientVpcConnectionRequest" - }, - "output": { - "shape": "RejectClientVpcConnectionResponse" - }, - "errors": [ - { - "shape": "ServiceUnavailableException" - }, - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - } - ] - }, - "DeleteClusterPolicy": { - "name": "DeleteClusterPolicy", - "http": { - "method": "DELETE", - "requestUri": "/v1/clusters/{clusterArn}/policy", - "responseCode": 200 - }, - "input": { - "shape": "DeleteClusterPolicyRequest" - }, - "output": { - "shape": "DeleteClusterPolicyResponse" - }, - "errors": [ - { - "shape": "NotFoundException" - }, - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - } - ] - }, - "GetClusterPolicy": { - "name": "GetClusterPolicy", - "http": { - "method": "GET", - "requestUri": "/v1/clusters/{clusterArn}/policy", - "responseCode": 200 - }, - "input": { - "shape": "GetClusterPolicyRequest" - }, - "output": { - "shape": "GetClusterPolicyResponse" - }, - "errors": [ - { - "shape": "NotFoundException" - }, - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - } - ] - }, - "PutClusterPolicy": { - "name": "PutClusterPolicy", - "http": { - "method": "PUT", - "requestUri": "/v1/clusters/{clusterArn}/policy", - "responseCode": 200 - }, - "input": { - "shape": "PutClusterPolicyRequest" - }, - "output": { - "shape": "PutClusterPolicyResponse" - }, - "errors": [ - { - "shape": "NotFoundException" - }, - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - } - ] - }, - "RebootBroker": { - "name": "RebootBroker", - "http": { - "method": "PUT", - "requestUri": "/v1/clusters/{clusterArn}/reboot-broker", - "responseCode": 200 - }, - "input": { - "shape": "RebootBrokerRequest" - }, - "output": { - "shape": "RebootBrokerResponse" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - }, - { - "shape": "NotFoundException" - }, - { - "shape": "ServiceUnavailableException" - }, - { - "shape": "TooManyRequestsException" - } - ] - }, - "TagResource": { - "name": "TagResource", - "http": { - "method": "POST", - "requestUri": "/v1/tags/{resourceArn}", - "responseCode": 204 - }, - "input": { - "shape": "TagResourceRequest" - }, - "errors": [ - { - "shape": "NotFoundException" - }, - { - "shape": "BadRequestException" - }, - { - "shape": "InternalServerErrorException" - } - ] - }, - "UntagResource": { - "name": "UntagResource", - "http": { - "method": "DELETE", - "requestUri": "/v1/tags/{resourceArn}", - "responseCode": 204 - }, - "input": { - "shape": "UntagResourceRequest" - }, - "errors": [ - { - "shape": "NotFoundException" - }, - { - "shape": "BadRequestException" - }, - { - "shape": "InternalServerErrorException" - } - ] - }, - "UpdateBrokerCount": { - "name": "UpdateBrokerCount", - "http": { - "method": "PUT", - "requestUri": "/v1/clusters/{clusterArn}/nodes/count", - "responseCode": 200 - }, - "input": { - "shape": "UpdateBrokerCountRequest" - }, - "output": { - "shape": "UpdateBrokerCountResponse" - }, - "errors": [ - { - "shape": "ServiceUnavailableException" - }, - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - } - ] - }, - "UpdateBrokerType": { - "name": "UpdateBrokerType", - "http": { - "method": "PUT", - "requestUri": "/v1/clusters/{clusterArn}/nodes/type", - "responseCode": 200 - }, - "input": { - "shape": "UpdateBrokerTypeRequest" - }, - "output": { - "shape": "UpdateBrokerTypeResponse" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "ForbiddenException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "NotFoundException" - }, - { - "shape": "ServiceUnavailableException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "TooManyRequestsException" - } - ] - }, - "UpdateBrokerStorage": { - "name": "UpdateBrokerStorage", - "http": { - "method": "PUT", - "requestUri": "/v1/clusters/{clusterArn}/nodes/storage", - "responseCode": 200 - }, - "input": { - "shape": "UpdateBrokerStorageRequest" - }, - "output": { - "shape": "UpdateBrokerStorageResponse" - }, - "errors": [ - { - "shape": "ServiceUnavailableException" - }, - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - } - ] - }, - "UpdateConfiguration": { - "name": "UpdateConfiguration", - "http": { - "method": "PUT", - "requestUri": "/v1/configurations/{arn}", - "responseCode": 200 - }, - "input": { - "shape": "UpdateConfigurationRequest" - }, - "output": { - "shape": "UpdateConfigurationResponse" - }, - "errors": [ - { - "shape": "ServiceUnavailableException" - }, - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - } - ] - }, - "UpdateChannel": { - "name": "UpdateChannel", - "http": { - "method": "PUT", - "requestUri": "/v1/clusters/{clusterArn}/channels/{channelArn}", - "responseCode": 200 - }, - "input": { - "shape": "UpdateChannelRequest" - }, - "output": { - "shape": "UpdateChannelResponse" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - }, - { - "shape": "NotFoundException" - }, - { - "shape": "ServiceUnavailableException" - }, - { - "shape": "TooManyRequestsException" - } - ], - "idempotent": true - }, - "UpdateClusterConfiguration": { - "name": "UpdateClusterConfiguration", - "http": { - "method": "PUT", - "requestUri": "/v1/clusters/{clusterArn}/configuration", - "responseCode": 200 - }, - "input": { - "shape": "UpdateClusterConfigurationRequest" - }, - "output": { - "shape": "UpdateClusterConfigurationResponse" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - }, - { - "shape": "NotFoundException" - }, - { - "shape": "ServiceUnavailableException" - } - ] - }, - "UpdateClusterKafkaVersion": { - "name": "UpdateClusterKafkaVersion", - "http": { - "method": "PUT", - "requestUri": "/v1/clusters/{clusterArn}/version", - "responseCode": 200 - }, - "input": { - "shape": "UpdateClusterKafkaVersionRequest" - }, - "output": { - "shape": "UpdateClusterKafkaVersionResponse" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - }, - { - "shape": "NotFoundException" - }, - { - "shape": "ServiceUnavailableException" - }, - { - "shape": "TooManyRequestsException" - } - ] - }, - "UpdateConnectivity": { - "name": "UpdateConnectivity", - "http": { - "method": "PUT", - "requestUri": "/v1/clusters/{clusterArn}/connectivity", - "responseCode": 200 - }, - "input": { - "shape": "UpdateConnectivityRequest" - }, - "output": { - "shape": "UpdateConnectivityResponse" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - }, - { - "shape": "NotFoundException" - }, - { - "shape": "ServiceUnavailableException" - }, - { - "shape": "TooManyRequestsException" - } - ] - }, - "UpdateMonitoring": { - "name": "UpdateMonitoring", - "http": { - "method": "PUT", - "requestUri": "/v1/clusters/{clusterArn}/monitoring", - "responseCode": 200 - }, - "input": { - "shape": "UpdateMonitoringRequest" - }, - "output": { - "shape": "UpdateMonitoringResponse" - }, - "errors": [ - { - "shape": "ServiceUnavailableException" - }, - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - } - ] - }, - "UpdateRebalancing": { - "name": "UpdateRebalancing", - "http": { - "method": "PUT", - "requestUri": "/v1/clusters/{clusterArn}/rebalancing", - "responseCode": 200 - }, - "input": { - "shape": "UpdateRebalancingRequest" - }, - "output": { - "shape": "UpdateRebalancingResponse" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - }, - { - "shape": "NotFoundException" - }, - { - "shape": "ServiceUnavailableException" - }, - { - "shape": "TooManyRequestsException" - }, - { - "shape": "UnauthorizedException" - } - ] - }, - "UpdateReplicationInfo": { - "name": "UpdateReplicationInfo", - "http": { - "method": "PUT", - "requestUri": "/replication/v1/replicators/{replicatorArn}/replication-info", - "responseCode": 200 - }, - "input": { - "shape": "UpdateReplicationInfoRequest" - }, - "output": { - "shape": "UpdateReplicationInfoResponse" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - }, - { - "shape": "NotFoundException" - }, - { - "shape": "ServiceUnavailableException" - }, - { - "shape": "TooManyRequestsException" - } - ] - }, - "UpdateSecurity": { - "name": "UpdateSecurity", - "http": { - "method": "PATCH", - "requestUri": "/v1/clusters/{clusterArn}/security", - "responseCode": 200 - }, - "input": { - "shape": "UpdateSecurityRequest" - }, - "output": { - "shape": "UpdateSecurityResponse" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - }, - { - "shape": "NotFoundException" - }, - { - "shape": "ServiceUnavailableException" - }, - { - "shape": "TooManyRequestsException" - } - ] - }, - "UpdateStorage": { - "name": "UpdateStorage", - "http": { - "method": "PUT", - "requestUri": "/v1/clusters/{clusterArn}/storage", - "responseCode": 200 - }, - "input": { - "shape": "UpdateStorageRequest" - }, - "output": { - "shape": "UpdateStorageResponse" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - }, - { - "shape": "NotFoundException" - }, - { - "shape": "ServiceUnavailableException" - }, - { - "shape": "TooManyRequestsException" - } - ] - }, - "UpdateTopic": { - "name": "UpdateTopic", - "http": { - "method": "PUT", - "requestUri": "/v1/clusters/{clusterArn}/topics/{topicName}", - "responseCode": 200 - }, - "input": { - "shape": "UpdateTopicRequest" - }, - "output": { - "shape": "UpdateTopicResponse" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - }, - { - "shape": "NotFoundException" - }, - { - "shape": "ServiceUnavailableException" - }, - { - "shape": "ClusterConnectivityException" - }, - { - "shape": "KafkaTimeoutException" - }, - { - "shape": "UnknownTopicOrPartitionException" - }, - { - "shape": "ControllerMovedException" - }, - { - "shape": "NotControllerException" - }, - { - "shape": "ReassignmentInProgressException" - }, - { - "shape": "GroupSubscribedToTopicException" - }, - { - "shape": "KafkaRequestException" - } - ] - } - }, - "shapes": { - "AmazonMskCluster": { - "type": "structure", - "members": { - "MskClusterArn": { - "shape": "__string", - "locationName": "mskClusterArn" - } - }, - "required": [ - "MskClusterArn" - ] - }, - "ApacheKafkaCluster": { - "type": "structure", - "members": { - "ApacheKafkaClusterId": { - "shape": "__string", - "locationName": "apacheKafkaClusterId" - }, - "BootstrapBrokerString": { - "shape": "__string", - "locationName": "bootstrapBrokerString" - } - }, - "required": [ - "ApacheKafkaClusterId", - "BootstrapBrokerString" - ] - }, - "BatchAssociateScramSecretRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn" - }, - "SecretArnList": { - "shape": "__listOf__string", - "locationName": "secretArnList" - } - }, - "required": [ - "ClusterArn", - "SecretArnList" - ] - }, - "BatchAssociateScramSecretResponse": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn" - }, - "UnprocessedScramSecrets": { - "shape": "__listOfUnprocessedScramSecret", - "locationName": "unprocessedScramSecrets" - } - } - }, - "BadRequestException": { - "type": "structure", - "members": { - "InvalidParameter": { - "shape": "__string", - "locationName": "invalidParameter" - }, - "Message": { - "shape": "__string", - "locationName": "message" - } - }, - "exception": true, - "error": { - "httpStatusCode": 400 - } - }, - "BrokerAZDistribution": { - "type": "string", - "enum": [ - "DEFAULT" - ] - }, - "BrokerEBSVolumeInfo": { - "type": "structure", - "members": { - "KafkaBrokerNodeId": { - "shape": "__string", - "locationName": "kafkaBrokerNodeId" - }, - "ProvisionedThroughput": { - "shape": "ProvisionedThroughput", - "locationName": "provisionedThroughput" - }, - "VolumeSizeGB": { - "shape": "__integer", - "locationName": "volumeSizeGB" - } - }, - "required": [ - "KafkaBrokerNodeId" - ] - }, - "BrokerLogs": { - "type": "structure", - "members": { - "CloudWatchLogs": { - "shape": "CloudWatchLogs", - "locationName": "cloudWatchLogs" - }, - "Firehose": { - "shape": "Firehose", - "locationName": "firehose" - }, - "S3": { - "shape": "S3", - "locationName": "s3" - } - } - }, - "BrokerNodeGroupInfo": { - "type": "structure", - "members": { - "BrokerAZDistribution": { - "shape": "BrokerAZDistribution", - "locationName": "brokerAZDistribution" - }, - "ClientSubnets": { - "shape": "__listOf__string", - "locationName": "clientSubnets" - }, - "InstanceType": { - "shape": "__stringMin5Max32", - "locationName": "instanceType" - }, - "SecurityGroups": { - "shape": "__listOf__string", - "locationName": "securityGroups" - }, - "StorageInfo": { - "shape": "StorageInfo", - "locationName": "storageInfo" - }, - "ConnectivityInfo": { - "shape": "ConnectivityInfo", - "locationName": "connectivityInfo" - }, - "ZoneIds": { - "shape": "__listOf__string", - "locationName": "zoneIds" - } - }, - "required": [ - "ClientSubnets", - "InstanceType" - ] - }, - "BrokerNodeInfo": { - "type": "structure", - "members": { - "AttachedENIId": { - "shape": "__string", - "locationName": "attachedENIId" - }, - "BrokerId": { - "shape": "__double", - "locationName": "brokerId" - }, - "ClientSubnet": { - "shape": "__string", - "locationName": "clientSubnet" - }, - "ClientVpcIpAddress": { - "shape": "__string", - "locationName": "clientVpcIpAddress" - }, - "CurrentBrokerSoftwareInfo": { - "shape": "BrokerSoftwareInfo", - "locationName": "currentBrokerSoftwareInfo" - }, - "Endpoints": { - "shape": "__listOf__string", - "locationName": "endpoints" - } - } - }, - "BrokerSoftwareInfo": { - "type": "structure", - "members": { - "ConfigurationArn": { - "shape": "__string", - "locationName": "configurationArn" - }, - "ConfigurationRevision": { - "shape": "__long", - "locationName": "configurationRevision" - }, - "KafkaVersion": { - "shape": "__string", - "locationName": "kafkaVersion" - } - } - }, - "Catalog": { - "type": "structure", - "members": { - "CatalogArn": { - "shape": "__string", - "locationName": "catalogArn" - }, - "WarehouseLocation": { - "shape": "__string", - "locationName": "warehouseLocation" - } - } - }, - "ChannelInfo": { - "type": "structure", - "members": { - "ChannelArn": { - "shape": "__string", - "locationName": "channelArn" - }, - "ChannelName": { - "shape": "__string", - "locationName": "channelName" - }, - "Status": { - "shape": "ChannelStatus", - "locationName": "status" - }, - "CreationTime": { - "shape": "__timestampIso8601", - "locationName": "creationTime" - }, - "DestinationType": { - "shape": "ChannelDestinationType", - "locationName": "destinationType" - }, - "ClusterOperationArn": { - "shape": "__string", - "locationName": "clusterOperationArn" - } - }, - "required": [ - "ChannelArn", - "ChannelName", - "Status", - "CreationTime", - "DestinationType" - ] - }, - "ChannelStatus": { - "type": "string", - "enum": [ - "CREATING", - "ACTIVE", - "UPDATING", - "DELETING", - "FAILED", - "SUSPENDING", - "SUSPENDED" - ] - }, - "ChannelDestinationType": { - "type": "string", - "enum": [ - "ICEBERG", - "S3" - ] - }, - "ChannelStateInfo": { - "type": "structure", - "members": { - "Code": { - "shape": "__string", - "locationName": "code" - }, - "Message": { - "shape": "__string", - "locationName": "message" - } - } - }, - "CreateChannelRequest": { - "type": "structure", - "members": { - "ChannelName": { - "shape": "__string", - "locationName": "channelName" - }, - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn" - }, - "EncryptionConfiguration": { - "shape": "EncryptionConfiguration", - "locationName": "encryptionConfiguration" - }, - "IcebergDestinationConfiguration": { - "shape": "IcebergDestinationConfiguration", - "locationName": "icebergDestinationConfiguration" - }, - "LoggingInfo": { - "shape": "ChannelLoggingInfo", - "locationName": "loggingInfo" - }, - "S3DestinationConfiguration": { - "shape": "S3DestinationConfiguration", - "locationName": "s3DestinationConfiguration" - }, - "Tags": { - "shape": "__mapOf__string", - "locationName": "tags" - }, - "TopicConfigurationList": { - "shape": "__listOfTopicConfiguration", - "locationName": "topicConfigurationList" - } - }, - "required": [ - "ClusterArn", - "ChannelName", - "TopicConfigurationList" - ] - }, - "ClientAuthentication": { - "type": "structure", - "members": { - "Sasl": { - "shape": "Sasl", - "locationName": "sasl" - }, - "Tls": { - "shape": "Tls", - "locationName": "tls" - }, - "Unauthenticated": { - "shape": "Unauthenticated", - "locationName": "unauthenticated" - } - } - }, - "VpcConnectivityClientAuthentication": { - "type": "structure", - "members": { - "Sasl": { - "shape": "VpcConnectivitySasl", - "locationName": "sasl" - }, - "Tls": { - "shape": "VpcConnectivityTls", - "locationName": "tls" - } - } - }, - "ClientBroker": { - "type": "string", - "enum": [ - "TLS", - "TLS_PLAINTEXT", - "PLAINTEXT" - ] - }, - "CloudWatchLogs": { - "type": "structure", - "members": { - "Enabled": { - "shape": "__boolean", - "locationName": "enabled" - }, - "LogGroup": { - "shape": "__string", - "locationName": "logGroup" - } - }, - "required": [ - "Enabled" - ] - }, - "ClusterInfo": { - "type": "structure", - "members": { - "ActiveOperationArn": { - "shape": "__string", - "locationName": "activeOperationArn" - }, - "BrokerNodeGroupInfo": { - "shape": "BrokerNodeGroupInfo", - "locationName": "brokerNodeGroupInfo" - }, - "ClientAuthentication": { - "shape": "ClientAuthentication", - "locationName": "clientAuthentication" - }, - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn" - }, - "ClusterName": { - "shape": "__string", - "locationName": "clusterName" - }, - "CreationTime": { - "shape": "__timestampIso8601", - "locationName": "creationTime" - }, - "CurrentBrokerSoftwareInfo": { - "shape": "BrokerSoftwareInfo", - "locationName": "currentBrokerSoftwareInfo" - }, - "LoggingInfo": { - "shape": "LoggingInfo", - "locationName": "loggingInfo" - }, - "CurrentVersion": { - "shape": "__string", - "locationName": "currentVersion" - }, - "EncryptionInfo": { - "shape": "EncryptionInfo", - "locationName": "encryptionInfo" - }, - "EnhancedMonitoring": { - "shape": "EnhancedMonitoring", - "locationName": "enhancedMonitoring" - }, - "NumberOfBrokerNodes": { - "shape": "__integer", - "locationName": "numberOfBrokerNodes" - }, - "OpenMonitoring": { - "shape": "OpenMonitoring", - "locationName": "openMonitoring" - }, - "State": { - "shape": "ClusterState", - "locationName": "state" - }, - "StateInfo": { - "shape": "StateInfo", - "locationName": "stateInfo" - }, - "Tags": { - "shape": "__mapOf__string", - "locationName": "tags" - }, - "ZookeeperConnectString": { - "shape": "__string", - "locationName": "zookeeperConnectString" - }, - "ZookeeperConnectStringTls": { - "shape": "__string", - "locationName": "zookeeperConnectStringTls" - }, - "StorageMode": { - "shape": "StorageMode", - "locationName": "storageMode" - }, - "Rebalancing": { - "shape": "Rebalancing", - "locationName": "rebalancing" - }, - "CustomerActionStatus": { - "shape": "CustomerActionStatus", - "locationName": "customerActionStatus" - } - } - }, - "ClusterOperationInfo": { - "type": "structure", - "members": { - "ClientRequestId": { - "shape": "__string", - "locationName": "clientRequestId" - }, - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn" - }, - "CreationTime": { - "shape": "__timestampIso8601", - "locationName": "creationTime" - }, - "EndTime": { - "shape": "__timestampIso8601", - "locationName": "endTime" - }, - "ErrorInfo": { - "shape": "ErrorInfo", - "locationName": "errorInfo" - }, - "OperationSteps": { - "shape": "__listOfClusterOperationStep", - "locationName": "operationSteps" - }, - "OperationArn": { - "shape": "__string", - "locationName": "operationArn" - }, - "OperationState": { - "shape": "__string", - "locationName": "operationState" - }, - "OperationType": { - "shape": "__string", - "locationName": "operationType" - }, - "SourceClusterInfo": { - "shape": "MutableClusterInfo", - "locationName": "sourceClusterInfo" - }, - "TargetClusterInfo": { - "shape": "MutableClusterInfo", - "locationName": "targetClusterInfo" - }, - "VpcConnectionInfo": { - "shape": "VpcConnectionInfo", - "locationName": "vpcConnectionInfo" - } - } - }, - "ClusterOperationStep": { - "type": "structure", - "members": { - "StepInfo": { - "shape": "ClusterOperationStepInfo", - "locationName": "stepInfo" - }, - "StepName": { - "shape": "__string", - "locationName": "stepName" - } - } - }, - "ClusterOperationStepInfo": { - "type": "structure", - "members": { - "StepStatus": { - "shape": "__string", - "locationName": "stepStatus" - } - } - }, - "ClusterOperationV2": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn" - }, - "ClusterType": { - "shape": "ClusterType", - "locationName": "clusterType" - }, - "StartTime": { - "shape": "__timestampIso8601", - "locationName": "startTime" - }, - "EndTime": { - "shape": "__timestampIso8601", - "locationName": "endTime" - }, - "OperationArn": { - "shape": "__string", - "locationName": "operationArn" - }, - "OperationState": { - "shape": "__string", - "locationName": "operationState" - }, - "OperationType": { - "shape": "__string", - "locationName": "operationType" - }, - "Provisioned": { - "shape": "ClusterOperationV2Provisioned", - "locationName": "provisioned" - }, - "Serverless": { - "shape": "ClusterOperationV2Serverless", - "locationName": "serverless" - } - } - }, - "ClusterOperationV2Provisioned": { - "type": "structure", - "members": { - "OperationSteps": { - "shape": "__listOfClusterOperationStep", - "locationName": "operationSteps" - }, - "SourceClusterInfo": { - "shape": "MutableClusterInfo", - "locationName": "sourceClusterInfo" - }, - "TargetClusterInfo": { - "shape": "MutableClusterInfo", - "locationName": "targetClusterInfo" - }, - "VpcConnectionInfo": { - "shape": "VpcConnectionInfo", - "locationName": "vpcConnectionInfo" - } - } - }, - "ClusterOperationV2Serverless": { - "type": "structure", - "members": { - "SourceClusterInfo": { - "shape": "ServerlessConnectivityInfo", - "locationName": "sourceClusterInfo" - }, - "TargetClusterInfo": { - "shape": "ServerlessConnectivityInfo", - "locationName": "targetClusterInfo" - }, - "VpcConnectionInfo": { - "shape": "VpcConnectionInfoServerless", - "locationName": "vpcConnectionInfo" - } - } - }, - "ClusterOperationV2Summary": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn" - }, - "ClusterType": { - "shape": "ClusterType", - "locationName": "clusterType" - }, - "StartTime": { - "shape": "__timestampIso8601", - "locationName": "startTime" - }, - "EndTime": { - "shape": "__timestampIso8601", - "locationName": "endTime" - }, - "OperationArn": { - "shape": "__string", - "locationName": "operationArn" - }, - "OperationState": { - "shape": "__string", - "locationName": "operationState" - }, - "OperationType": { - "shape": "__string", - "locationName": "operationType" - } - } - }, - "ClusterState": { - "type": "string", - "enum": [ - "ACTIVE", - "CREATING", - "DELETING", - "FAILED", - "HEALING", - "MAINTENANCE", - "REBOOTING_BROKER", - "UPDATING" - ] - }, - "ClientVpcConnection": { - "type": "structure", - "members": { - "Authentication": { - "shape": "__string", - "locationName": "authentication" - }, - "CreationTime": { - "shape": "__timestampIso8601", - "locationName": "creationTime" - }, - "State": { - "shape": "VpcConnectionState", - "locationName": "state" - }, - "VpcConnectionArn": { - "shape": "__string", - "locationName": "vpcConnectionArn" - }, - "Owner": { - "shape": "__string", - "locationName": "owner" - } - }, - "required": [ - "VpcConnectionArn" - ] - }, - "VpcConnection": { - "type": "structure", - "members": { - "VpcConnectionArn": { - "shape": "__string", - "locationName": "vpcConnectionArn" - }, - "TargetClusterArn": { - "shape": "__string", - "locationName": "targetClusterArn" - }, - "CreationTime": { - "shape": "__timestampIso8601", - "locationName": "creationTime" - }, - "Authentication": { - "shape": "__string", - "locationName": "authentication" - }, - "VpcId": { - "shape": "__string", - "locationName": "vpcId" - }, - "State": { - "shape": "VpcConnectionState", - "locationName": "state" - } - }, - "required": [ - "VpcConnectionArn", - "TargetClusterArn" - ] - }, - "CompatibleKafkaVersion": { - "type": "structure", - "members": { - "SourceVersion": { - "shape": "__string", - "locationName": "sourceVersion" - }, - "TargetVersions": { - "shape": "__listOf__string", - "locationName": "targetVersions" - } - } - }, - "Configuration": { - "type": "structure", - "members": { - "Arn": { - "shape": "__string", - "locationName": "arn" - }, - "CreationTime": { - "shape": "__timestampIso8601", - "locationName": "creationTime" - }, - "Description": { - "shape": "__string", - "locationName": "description" - }, - "KafkaVersions": { - "shape": "__listOf__string", - "locationName": "kafkaVersions" - }, - "LatestRevision": { - "shape": "ConfigurationRevision", - "locationName": "latestRevision" - }, - "Name": { - "shape": "__string", - "locationName": "name" - }, - "State": { - "shape": "ConfigurationState", - "locationName": "state" - } - }, - "required": [ - "Description", - "LatestRevision", - "CreationTime", - "KafkaVersions", - "Arn", - "Name", - "State" - ] - }, - "ConfigurationInfo": { - "type": "structure", - "members": { - "Arn": { - "shape": "__string", - "locationName": "arn" - }, - "Revision": { - "shape": "__long", - "locationName": "revision" - } - }, - "required": [ - "Revision", - "Arn" - ] - }, - "ConfigurationRevision": { - "type": "structure", - "members": { - "CreationTime": { - "shape": "__timestampIso8601", - "locationName": "creationTime" - }, - "Description": { - "shape": "__string", - "locationName": "description" - }, - "Revision": { - "shape": "__long", - "locationName": "revision" - } - }, - "required": [ - "Revision", - "CreationTime" - ] - }, - "ConfigurationState": { - "type": "string", - "enum": [ - "ACTIVE", - "DELETING", - "DELETE_FAILED" - ] - }, - "ConflictException": { - "type": "structure", - "members": { - "InvalidParameter": { - "shape": "__string", - "locationName": "invalidParameter" - }, - "Message": { - "shape": "__string", - "locationName": "message" - } - }, - "exception": true, - "error": { - "httpStatusCode": 409 - } - }, - "ConnectivityInfo": { - "type": "structure", - "members": { - "PublicAccess": { - "shape": "PublicAccess", - "locationName": "publicAccess" - }, - "VpcConnectivity": { - "shape": "VpcConnectivity", - "locationName": "vpcConnectivity" - }, - "NetworkType": { - "shape": "NetworkType", - "locationName": "networkType" - } - } - }, - "BrokerCountUpdateInfo": { - "type": "structure", - "members": { - "CreatedBrokerIds": { - "shape": "__listOf__double", - "locationName": "createdBrokerIds" - }, - "DeletedBrokerIds": { - "shape": "__listOf__double", - "locationName": "deletedBrokerIds" - } - } - }, - "ConsumerGroupReplication": { - "type": "structure", - "members": { - "ConsumerGroupsToExclude": { - "shape": "__listOf__stringMax256", - "locationName": "consumerGroupsToExclude" - }, - "ConsumerGroupsToReplicate": { - "shape": "__listOf__stringMax256", - "locationName": "consumerGroupsToReplicate" - }, - "DetectAndCopyNewConsumerGroups": { - "shape": "__boolean", - "locationName": "detectAndCopyNewConsumerGroups" - }, - "SynchroniseConsumerGroupOffsets": { - "shape": "__boolean", - "locationName": "synchroniseConsumerGroupOffsets" - }, - "ConsumerGroupOffsetSyncMode": { - "shape": "ConsumerGroupOffsetSyncMode", - "locationName": "consumerGroupOffsetSyncMode" - } - }, - "required": [ - "ConsumerGroupsToReplicate" - ] - }, - "ConsumerGroupOffsetSyncMode": { - "type": "string", - "enum": [ - "LEGACY", - "ENHANCED" - ] - }, - "ConsumerGroupReplicationUpdate": { - "type": "structure", - "members": { - "ConsumerGroupsToExclude": { - "shape": "__listOf__stringMax256", - "locationName": "consumerGroupsToExclude" - }, - "ConsumerGroupsToReplicate": { - "shape": "__listOf__stringMax256", - "locationName": "consumerGroupsToReplicate" - }, - "DetectAndCopyNewConsumerGroups": { - "shape": "__boolean", - "locationName": "detectAndCopyNewConsumerGroups" - }, - "SynchroniseConsumerGroupOffsets": { - "shape": "__boolean", - "locationName": "synchroniseConsumerGroupOffsets" - } - }, - "required": [ - "ConsumerGroupsToReplicate", - "ConsumerGroupsToExclude", - "SynchroniseConsumerGroupOffsets", - "DetectAndCopyNewConsumerGroups" - ] - }, - "CreateChannelResponse": { - "type": "structure", - "members": { - "ChannelArn": { - "shape": "__string", - "locationName": "channelArn" - }, - "ClusterOperationArn": { - "shape": "__string", - "locationName": "clusterOperationArn" - } - }, - "required": [ - "ChannelArn" - ] - }, - "CreateClusterRequest": { - "type": "structure", - "members": { - "BrokerNodeGroupInfo": { - "shape": "BrokerNodeGroupInfo", - "locationName": "brokerNodeGroupInfo" - }, - "ClientAuthentication": { - "shape": "ClientAuthentication", - "locationName": "clientAuthentication" - }, - "ClusterName": { - "shape": "__stringMin1Max64", - "locationName": "clusterName" - }, - "ConfigurationInfo": { - "shape": "ConfigurationInfo", - "locationName": "configurationInfo" - }, - "EncryptionInfo": { - "shape": "EncryptionInfo", - "locationName": "encryptionInfo" - }, - "EnhancedMonitoring": { - "shape": "EnhancedMonitoring", - "locationName": "enhancedMonitoring" - }, - "KafkaVersion": { - "shape": "__stringMin1Max128", - "locationName": "kafkaVersion" - }, - "LoggingInfo": { - "shape": "LoggingInfo", - "locationName": "loggingInfo" - }, - "NumberOfBrokerNodes": { - "shape": "__integerMin1Max15", - "locationName": "numberOfBrokerNodes" - }, - "OpenMonitoring": { - "shape": "OpenMonitoringInfo", - "locationName": "openMonitoring" - }, - "Tags": { - "shape": "__mapOf__string", - "locationName": "tags" - }, - "Rebalancing": { - "shape": "Rebalancing", - "locationName": "rebalancing" - }, - "StorageMode": { - "shape": "StorageMode", - "locationName": "storageMode" - } - }, - "required": [ - "BrokerNodeGroupInfo", - "KafkaVersion", - "NumberOfBrokerNodes", - "ClusterName" - ] - }, - "CreateClusterResponse": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn" - }, - "ClusterName": { - "shape": "__string", - "locationName": "clusterName" - }, - "State": { - "shape": "ClusterState", - "locationName": "state" - } - } - }, - "CreateConfigurationRequest": { - "type": "structure", - "members": { - "Description": { - "shape": "__string", - "locationName": "description" - }, - "KafkaVersions": { - "shape": "__listOf__string", - "locationName": "kafkaVersions" - }, - "Name": { - "shape": "__string", - "locationName": "name" - }, - "ServerProperties": { - "shape": "__blob", - "locationName": "serverProperties" - } - }, - "required": [ - "ServerProperties", - "Name" - ] - }, - "CreateConfigurationResponse": { - "type": "structure", - "members": { - "Arn": { - "shape": "__string", - "locationName": "arn" - }, - "CreationTime": { - "shape": "__timestampIso8601", - "locationName": "creationTime" - }, - "LatestRevision": { - "shape": "ConfigurationRevision", - "locationName": "latestRevision" - }, - "Name": { - "shape": "__string", - "locationName": "name" - }, - "State": { - "shape": "ConfigurationState", - "locationName": "state" - } - } - }, - "CreateReplicatorRequest": { - "type": "structure", - "members": { - "Description": { - "shape": "__stringMax1024", - "locationName": "description" - }, - "KafkaClusters": { - "shape": "__listOfKafkaCluster", - "locationName": "kafkaClusters" - }, - "LogDelivery": { - "shape": "LogDelivery", - "locationName": "logDelivery" - }, - "ReplicationInfoList": { - "shape": "__listOfReplicationInfo", - "locationName": "replicationInfoList" - }, - "ReplicatorName": { - "shape": "__stringMin1Max128Pattern09AZaZ09AZaZ0", - "locationName": "replicatorName" - }, - "ServiceExecutionRoleArn": { - "shape": "__string", - "locationName": "serviceExecutionRoleArn" - }, - "Tags": { - "shape": "__mapOf__string", - "locationName": "tags" - } - }, - "required": [ - "ServiceExecutionRoleArn", - "ReplicatorName", - "ReplicationInfoList", - "KafkaClusters" - ] - }, - "CreateReplicatorResponse": { - "type": "structure", - "members": { - "ReplicatorArn": { - "shape": "__string", - "locationName": "replicatorArn" - }, - "ReplicatorName": { - "shape": "__string", - "locationName": "replicatorName" - }, - "ReplicatorState": { - "shape": "ReplicatorState", - "locationName": "replicatorState" - } - } - }, - "CreateTopicRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn" - }, - "TopicName": { - "shape": "__string", - "locationName": "topicName" - }, - "PartitionCount": { - "shape": "__integerMin1", - "locationName": "partitionCount" - }, - "ReplicationFactor": { - "shape": "__integerMin1", - "locationName": "replicationFactor" - }, - "Configs": { - "shape": "__string", - "locationName": "configs" - } - }, - "required": [ - "ClusterArn", - "TopicName", - "PartitionCount", - "ReplicationFactor" - ] - }, - "CreateTopicResponse": { - "type": "structure", - "members": { - "TopicArn": { - "shape": "__string", - "locationName": "topicArn" - }, - "TopicName": { - "shape": "__string", - "locationName": "topicName" - }, - "Status": { - "shape": "TopicState", - "locationName": "status" - } - } - }, - "CreateVpcConnectionRequest": { - "type": "structure", - "members": { - "TargetClusterArn": { - "shape": "__string", - "locationName": "targetClusterArn" - }, - "Authentication": { - "shape": "__string", - "locationName": "authentication" - }, - "VpcId": { - "shape": "__string", - "locationName": "vpcId" - }, - "ClientSubnets": { - "shape": "__listOf__string", - "locationName": "clientSubnets" - }, - "SecurityGroups": { - "shape": "__listOf__string", - "locationName": "securityGroups" - }, - "Tags": { - "shape": "__mapOf__string", - "locationName": "tags", - "documentation": "\n

A map of tags for the VPC connection.

\n " - } - }, - "required": [ - "TargetClusterArn", - "Authentication", - "VpcId", - "ClientSubnets", - "SecurityGroups" - ] - }, - "CreateVpcConnectionResponse": { - "type": "structure", - "members": { - "VpcConnectionArn": { - "shape": "__string", - "locationName": "vpcConnectionArn" - }, - "State": { - "shape": "VpcConnectionState", - "locationName": "state" - }, - "Authentication": { - "shape": "__string", - "locationName": "authentication" - }, - "VpcId": { - "shape": "__string", - "locationName": "vpcId" - }, - "ClientSubnets": { - "shape": "__listOf__string", - "locationName": "clientSubnets" - }, - "SecurityGroups": { - "shape": "__listOf__string", - "locationName": "securityGroups" - }, - "CreationTime": { - "shape": "__timestampIso8601", - "locationName": "creationTime" - }, - "Tags": { - "shape": "__mapOf__string", - "locationName": "tags", - "documentation": "\n

A map of tags that you want the vpc connection to have.

\n " - } - } - }, - "DeleteClusterRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn" - }, - "CurrentVersion": { - "shape": "__string", - "location": "querystring", - "locationName": "currentVersion" - } - }, - "required": [ - "ClusterArn" - ] - }, - "DeleteClusterResponse": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn" - }, - "State": { - "shape": "ClusterState", - "locationName": "state" - } - } - }, - "DeleteConfigurationRequest": { - "type": "structure", - "members": { - "Arn": { - "shape": "__string", - "location": "uri", - "locationName": "arn" - } - }, - "required": [ - "Arn" - ] - }, - "DeleteConfigurationResponse": { - "type": "structure", - "members": { - "Arn": { - "shape": "__string", - "locationName": "arn" - }, - "State": { - "shape": "ConfigurationState", - "locationName": "state" - } - } - }, - "DeleteReplicatorRequest": { - "type": "structure", - "members": { - "CurrentVersion": { - "shape": "__string", - "location": "querystring", - "locationName": "currentVersion" - }, - "ReplicatorArn": { - "shape": "__string", - "location": "uri", - "locationName": "replicatorArn" - } - }, - "required": [ - "ReplicatorArn" - ] - }, - "DeleteReplicatorResponse": { - "type": "structure", - "members": { - "ReplicatorArn": { - "shape": "__string", - "locationName": "replicatorArn" - }, - "ReplicatorState": { - "shape": "ReplicatorState", - "locationName": "replicatorState" - } - } - }, - "DeleteTopicRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn" - }, - "TopicName": { - "shape": "__string", - "location": "uri", - "locationName": "topicName" - } - }, - "required": [ - "ClusterArn", - "TopicName" - ] - }, - "DeleteTopicResponse": { - "type": "structure", - "members": { - "TopicArn": { - "shape": "__string", - "locationName": "topicArn" - }, - "TopicName": { - "shape": "__string", - "locationName": "topicName" - }, - "Status": { - "shape": "TopicState", - "locationName": "status" - } - } - }, - "DeleteVpcConnectionRequest": { - "type": "structure", - "members": { - "Arn": { - "shape": "__string", - "location": "uri", - "locationName": "arn" - } - }, - "required": [ - "Arn" - ] - }, - "DeleteVpcConnectionResponse": { - "type": "structure", - "members": { - "VpcConnectionArn": { - "shape": "__string", - "locationName": "vpcConnectionArn" - }, - "State": { - "shape": "VpcConnectionState", - "locationName": "state" - } - } - }, - "DescribeChannelRequest": { - "type": "structure", - "members": { - "ChannelArn": { - "shape": "__string", - "location": "uri", - "locationName": "channelArn" - }, - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn" - } - }, - "required": [ - "ClusterArn", - "ChannelArn" - ] - }, - "DescribeClusterOperationRequest": { - "type": "structure", - "members": { - "ClusterOperationArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterOperationArn" - } - }, - "required": [ - "ClusterOperationArn" - ] - }, - "DescribeClusterOperationV2Request": { - "type": "structure", - "members": { - "ClusterOperationArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterOperationArn" - } - }, - "required": [ - "ClusterOperationArn" - ] - }, - "DescribeChannelResponse": { - "type": "structure", - "members": { - "ChannelArn": { - "shape": "__string", - "locationName": "channelArn" - }, - "ChannelName": { - "shape": "__string", - "locationName": "channelName" - }, - "EncryptionConfiguration": { - "shape": "EncryptionConfiguration", - "locationName": "encryptionConfiguration" - }, - "IcebergDestinationConfiguration": { - "shape": "IcebergDestinationConfiguration", - "locationName": "icebergDestinationConfiguration" - }, - "S3DestinationConfiguration": { - "shape": "S3DestinationConfiguration", - "locationName": "s3DestinationConfiguration" - }, - "Status": { - "shape": "ChannelStatus", - "locationName": "status" - }, - "DestinationType": { - "shape": "ChannelDestinationType", - "locationName": "destinationType" - }, - "CreationTime": { - "shape": "__timestampIso8601", - "locationName": "creationTime" - }, - "TopicConfigurationList": { - "shape": "__listOfTopicConfiguration", - "locationName": "topicConfigurationList" - }, - "LoggingInfo": { - "shape": "ChannelLoggingInfo", - "locationName": "loggingInfo" - }, - "StateInfo": { - "shape": "ChannelStateInfo", - "locationName": "stateInfo" - }, - "ClusterOperationArn": { - "shape": "__string", - "locationName": "clusterOperationArn" - }, - "Tags": { - "shape": "__mapOf__string", - "locationName": "tags" - } - }, - "required": [ - "ChannelArn", - "ChannelName", - "TopicConfigurationList", - "Status", - "DestinationType", - "CreationTime" - ] - }, - "DescribeClusterOperationResponse": { - "type": "structure", - "members": { - "ClusterOperationInfo": { - "shape": "ClusterOperationInfo", - "locationName": "clusterOperationInfo" - } - } - }, - "DescribeClusterOperationV2Response": { - "type": "structure", - "members": { - "ClusterOperationInfo": { - "shape": "ClusterOperationV2", - "locationName": "clusterOperationInfo" - } - } - }, - "DescribeClusterRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn" - } - }, - "required": [ - "ClusterArn" - ] - }, - "DescribeClusterResponse": { - "type": "structure", - "members": { - "ClusterInfo": { - "shape": "ClusterInfo", - "locationName": "clusterInfo" - } - } - }, - "DescribeConfigurationRequest": { - "type": "structure", - "members": { - "Arn": { - "shape": "__string", - "location": "uri", - "locationName": "arn" - } - }, - "required": [ - "Arn" - ] - }, - "DescribeConfigurationResponse": { - "type": "structure", - "members": { - "Arn": { - "shape": "__string", - "locationName": "arn" - }, - "CreationTime": { - "shape": "__timestampIso8601", - "locationName": "creationTime" - }, - "Description": { - "shape": "__string", - "locationName": "description" - }, - "KafkaVersions": { - "shape": "__listOf__string", - "locationName": "kafkaVersions" - }, - "LatestRevision": { - "shape": "ConfigurationRevision", - "locationName": "latestRevision" - }, - "Name": { - "shape": "__string", - "locationName": "name" - }, - "State": { - "shape": "ConfigurationState", - "locationName": "state" - } - } - }, - "DescribeConfigurationRevisionRequest": { - "type": "structure", - "members": { - "Arn": { - "shape": "__string", - "location": "uri", - "locationName": "arn" - }, - "Revision": { - "shape": "__long", - "location": "uri", - "locationName": "revision" - } - }, - "required": [ - "Revision", - "Arn" - ] - }, - "DescribeConfigurationRevisionResponse": { - "type": "structure", - "members": { - "Arn": { - "shape": "__string", - "locationName": "arn" - }, - "CreationTime": { - "shape": "__timestampIso8601", - "locationName": "creationTime" - }, - "Description": { - "shape": "__string", - "locationName": "description" - }, - "Revision": { - "shape": "__long", - "locationName": "revision" - }, - "ServerProperties": { - "shape": "__blob", - "locationName": "serverProperties" - } - } - }, - "DescribeTopicRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn" - }, - "TopicName": { - "shape": "__string", - "location": "uri", - "locationName": "topicName" - } - }, - "required": [ - "ClusterArn", - "TopicName" - ] - }, - "DescribeTopicPartitionsRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn" - }, - "TopicName": { - "shape": "__string", - "location": "uri", - "locationName": "topicName" - }, - "MaxResults": { - "shape": "MaxResults", - "location": "querystring", - "locationName": "maxResults" - }, - "NextToken": { - "shape": "__string", - "location": "querystring", - "locationName": "nextToken" - } - }, - "required": [ - "ClusterArn", - "TopicName" - ] - }, - "DestinationTable": { - "type": "structure", - "members": { - "DestinationDatabaseName": { - "shape": "__string", - "locationName": "destinationDatabaseName" - }, - "DestinationTableName": { - "shape": "__string", - "locationName": "destinationTableName" - }, - "PartitionSpec": { - "shape": "PartitionSpec", - "locationName": "partitionSpec" - } - } - }, - "DescribeTopicResponse": { - "type": "structure", - "members": { - "TopicArn": { - "shape": "__string", - "locationName": "topicArn" - }, - "TopicName": { - "shape": "__string", - "locationName": "topicName" - }, - "ReplicationFactor": { - "shape": "__integer", - "locationName": "replicationFactor" - }, - "PartitionCount": { - "shape": "__integer", - "locationName": "partitionCount" - }, - "Configs": { - "shape": "__string", - "locationName": "configs" - }, - "Status": { - "shape": "TopicState", - "locationName": "status" - } - } - }, - "DescribeTopicPartitionsResponse": { - "type": "structure", - "members": { - "Partitions": { - "shape": "__listOfTopicPartitionInfo", - "locationName": "partitions" - }, - "NextToken": { - "shape": "__string", - "locationName": "nextToken" - } - } - }, - "TopicPartitionInfo": { - "type": "structure", - "documentation": "

Contains information about a topic partition.

", - "members": { - "Partition": { - "shape": "__integer", - "locationName": "partition" - }, - "Leader": { - "shape": "__integer", - "locationName": "leader" - }, - "Replicas": { - "shape": "__listOf__integer", - "locationName": "replicas" - }, - "Isr": { - "shape": "__listOf__integer", - "locationName": "isr" - } - } - }, - "DescribeReplicatorRequest": { - "type": "structure", - "members": { - "ReplicatorArn": { - "shape": "__string", - "location": "uri", - "locationName": "replicatorArn" - } - }, - "required": [ - "ReplicatorArn" - ] - }, - "DescribeReplicatorResponse": { - "type": "structure", - "members": { - "CreationTime": { - "shape": "__timestampIso8601", - "locationName": "creationTime" - }, - "CurrentVersion": { - "shape": "__string", - "locationName": "currentVersion" - }, - "IsReplicatorReference": { - "shape": "__boolean", - "locationName": "isReplicatorReference" - }, - "KafkaClusters": { - "shape": "__listOfKafkaClusterDescription", - "locationName": "kafkaClusters" - }, - "LogDelivery": { - "shape": "LogDelivery", - "locationName": "logDelivery" - }, - "ReplicationInfoList": { - "shape": "__listOfReplicationInfoDescription", - "locationName": "replicationInfoList" - }, - "ReplicatorArn": { - "shape": "__string", - "locationName": "replicatorArn" - }, - "ReplicatorDescription": { - "shape": "__string", - "locationName": "replicatorDescription" - }, - "ReplicatorName": { - "shape": "__string", - "locationName": "replicatorName" - }, - "ReplicatorResourceArn": { - "shape": "__string", - "locationName": "replicatorResourceArn" - }, - "ReplicatorState": { - "shape": "ReplicatorState", - "locationName": "replicatorState" - }, - "ServiceExecutionRoleArn": { - "shape": "__string", - "locationName": "serviceExecutionRoleArn" - }, - "StateInfo": { - "shape": "ReplicationStateInfo", - "locationName": "stateInfo" - }, - "Tags": { - "shape": "__mapOf__string", - "locationName": "tags" - } - } - }, - "DescribeVpcConnectionRequest": { - "type": "structure", - "members": { - "Arn": { - "shape": "__string", - "location": "uri", - "locationName": "arn" - } - }, - "required": [ - "Arn" - ] - }, - "DescribeVpcConnectionResponse": { - "type": "structure", - "members": { - "VpcConnectionArn": { - "shape": "__string", - "locationName": "vpcConnectionArn" - }, - "TargetClusterArn": { - "shape": "__string", - "locationName": "targetClusterArn" - }, - "State": { - "shape": "VpcConnectionState", - "locationName": "state" - }, - "Authentication": { - "shape": "__string", - "locationName": "authentication" - }, - "VpcId": { - "shape": "__string", - "locationName": "vpcId" - }, - "Subnets": { - "shape": "__listOf__string", - "locationName": "subnets" - }, - "SecurityGroups": { - "shape": "__listOf__string", - "locationName": "securityGroups" - }, - "CreationTime": { - "shape": "__timestampIso8601", - "locationName": "creationTime" - }, - "Tags": { - "shape": "__mapOf__string", - "locationName": "tags", - "documentation": "\n

A map of tags that you want the vpc connection to have.

\n " - } - } - }, - "BatchDisassociateScramSecretRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn" - }, - "SecretArnList": { - "shape": "__listOf__string", - "locationName": "secretArnList" - } - }, - "required": [ - "ClusterArn", - "SecretArnList" - ] - }, - "BatchDisassociateScramSecretResponse": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn" - }, - "UnprocessedScramSecrets": { - "shape": "__listOfUnprocessedScramSecret", - "locationName": "unprocessedScramSecrets" - } - } - }, - "EBSStorageInfo": { - "type": "structure", - "members": { - "ProvisionedThroughput": { - "shape": "ProvisionedThroughput", - "locationName": "provisionedThroughput" - }, - "VolumeSize": { - "shape": "__integerMin1Max16384", - "locationName": "volumeSize" - } - } - }, - "EncryptionConfiguration": { - "type": "structure", - "members": { - "KmsKeyArn": { - "shape": "__string", - "locationName": "kmsKeyArn" - } - }, - "required": [ - "KmsKeyArn" - ] - }, - "EncryptionAtRest": { - "type": "structure", - "members": { - "DataVolumeKMSKeyId": { - "shape": "__string", - "locationName": "dataVolumeKMSKeyId" - } - }, - "required": [ - "DataVolumeKMSKeyId" - ] - }, - "EncryptionInTransit": { - "type": "structure", - "members": { - "ClientBroker": { - "shape": "ClientBroker", - "locationName": "clientBroker" - }, - "InCluster": { - "shape": "__boolean", - "locationName": "inCluster" - } - } - }, - "EncryptionInfo": { - "type": "structure", - "members": { - "EncryptionAtRest": { - "shape": "EncryptionAtRest", - "locationName": "encryptionAtRest" - }, - "EncryptionInTransit": { - "shape": "EncryptionInTransit", - "locationName": "encryptionInTransit" - } - } - }, - "EnhancedMonitoring": { - "type": "string", - "enum": [ - "DEFAULT", - "PER_BROKER", - "PER_TOPIC_PER_BROKER", - "PER_TOPIC_PER_PARTITION" - ] - }, - "Error": { - "type": "structure", - "members": { - "InvalidParameter": { - "shape": "__string", - "locationName": "invalidParameter" - }, - "Message": { - "shape": "__string", - "locationName": "message" - } - } - }, - "Firehose": { - "type": "structure", - "members": { - "DeliveryStream": { - "shape": "__string", - "locationName": "deliveryStream" - }, - "Enabled": { - "shape": "__boolean", - "locationName": "enabled" - } - }, - "required": [ - "Enabled" - ] - }, - "ErrorInfo": { - "type": "structure", - "members": { - "ErrorCode": { - "shape": "__string", - "locationName": "errorCode" - }, - "ErrorString": { - "shape": "__string", - "locationName": "errorString" - } - } - }, - "ForbiddenException": { - "type": "structure", - "members": { - "InvalidParameter": { - "shape": "__string", - "locationName": "invalidParameter" - }, - "Message": { - "shape": "__string", - "locationName": "message" - } - }, - "exception": true, - "error": { - "httpStatusCode": 403 - } - }, - "GetBootstrapBrokersRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn" - } - }, - "required": [ - "ClusterArn" - ] - }, - "GetBootstrapBrokersResponse": { - "type": "structure", - "members": { - "BootstrapBrokerString": { - "shape": "__string", - "locationName": "bootstrapBrokerString" - }, - "BootstrapBrokerStringPublicSaslIam": { - "shape": "__string", - "locationName": "bootstrapBrokerStringPublicSaslIam" - }, - "BootstrapBrokerStringPublicSaslScram": { - "shape": "__string", - "locationName": "bootstrapBrokerStringPublicSaslScram" - }, - "BootstrapBrokerStringPublicTls": { - "shape": "__string", - "locationName": "bootstrapBrokerStringPublicTls" - }, - "BootstrapBrokerStringTls": { - "shape": "__string", - "locationName": "bootstrapBrokerStringTls" - }, - "BootstrapBrokerStringSaslScram": { - "shape": "__string", - "locationName": "bootstrapBrokerStringSaslScram" - }, - "BootstrapBrokerStringSaslIam": { - "shape": "__string", - "locationName": "bootstrapBrokerStringSaslIam" - }, - "BootstrapBrokerStringVpcConnectivityTls": { - "shape": "__string", - "locationName": "bootstrapBrokerStringVpcConnectivityTls" - }, - "BootstrapBrokerStringVpcConnectivitySaslScram": { - "shape": "__string", - "locationName": "bootstrapBrokerStringVpcConnectivitySaslScram" - }, - "BootstrapBrokerStringVpcConnectivitySaslIam": { - "shape": "__string", - "locationName": "bootstrapBrokerStringVpcConnectivitySaslIam" - }, - "BootstrapBrokerStringIpv6": { - "shape": "__string", - "locationName": "bootstrapBrokerStringIpv6" - }, - "BootstrapBrokerStringTlsIpv6": { - "shape": "__string", - "locationName": "bootstrapBrokerStringTlsIpv6" - }, - "BootstrapBrokerStringSaslScramIpv6": { - "shape": "__string", - "locationName": "bootstrapBrokerStringSaslScramIpv6" - }, - "BootstrapBrokerStringSaslIamIpv6": { - "shape": "__string", - "locationName": "bootstrapBrokerStringSaslIamIpv6" - } - } - }, - "GetCompatibleKafkaVersionsRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "querystring", - "locationName": "clusterArn" - } - } - }, - "GetCompatibleKafkaVersionsResponse": { - "type": "structure", - "members": { - "CompatibleKafkaVersions": { - "shape": "__listOfCompatibleKafkaVersion", - "locationName": "compatibleKafkaVersions" - } - } - }, - "IcebergDestinationConfiguration": { - "type": "structure", - "members": { - "AppendOnly": { - "shape": "__boolean", - "locationName": "appendOnly" - }, - "Catalog": { - "shape": "Catalog", - "locationName": "catalog" - }, - "DataFreshnessInSeconds": { - "shape": "__integer", - "locationName": "dataFreshnessInSeconds" - }, - "DeadLetterQueueS3": { - "shape": "DeadLetterQueueS3", - "locationName": "deadLetterQueueS3" - }, - "DestinationTableList": { - "shape": "__listOfDestinationTable", - "locationName": "destinationTableList" - }, - "SchemaEvolution": { - "shape": "SchemaEvolution", - "locationName": "schemaEvolution" - }, - "ServiceExecutionRoleArn": { - "shape": "__string", - "locationName": "serviceExecutionRoleArn" - }, - "TableCreation": { - "shape": "TableCreation", - "locationName": "tableCreation" - }, - "CompressionType": { - "shape": "IcebergCompressionType", - "locationName": "compressionType" - } - }, - "required": [ - "DeadLetterQueueS3", - "DestinationTableList", - "ServiceExecutionRoleArn", - "SchemaEvolution", - "TableCreation", - "AppendOnly" - ] - }, - "IcebergCompressionType": { - "type": "string", - "enum": [ - "ZSTD", - "SNAPPY" - ] - }, - "InternalServerErrorException": { - "type": "structure", - "members": { - "InvalidParameter": { - "shape": "__string", - "locationName": "invalidParameter" - }, - "Message": { - "shape": "__string", - "locationName": "message" - } - }, - "exception": true, - "error": { - "httpStatusCode": 500 - } - }, - "KafkaCluster": { - "type": "structure", - "members": { - "AmazonMskCluster": { - "shape": "AmazonMskCluster", - "locationName": "amazonMskCluster" - }, - "ApacheKafkaCluster": { - "shape": "ApacheKafkaCluster", - "locationName": "apacheKafkaCluster" - }, - "VpcConfig": { - "shape": "KafkaClusterClientVpcConfig", - "locationName": "vpcConfig" - }, - "ClientAuthentication": { - "shape": "KafkaClusterClientAuthentication", - "locationName": "clientAuthentication" - }, - "EncryptionInTransit": { - "shape": "KafkaClusterEncryptionInTransit", - "locationName": "encryptionInTransit" - } - } - }, - "KafkaClusterClientVpcConfig": { - "type": "structure", - "members": { - "SecurityGroupIds": { - "shape": "__listOf__string", - "locationName": "securityGroupIds" - }, - "SubnetIds": { - "shape": "__listOf__string", - "locationName": "subnetIds" - } - }, - "required": [ - "SubnetIds" - ] - }, - "KafkaClusterClientAuthentication": { - "type": "structure", - "members": { - "SaslScram": { - "shape": "KafkaClusterSaslScramAuthentication", - "locationName": "saslScram" - }, - "MTLS": { - "shape": "KafkaClusterMTLSAuthentication", - "locationName": "mTLS" - } - } - }, - "KafkaClusterSaslScramAuthentication": { - "type": "structure", - "members": { - "Mechanism": { - "shape": "KafkaClusterSaslScramMechanism", - "locationName": "mechanism" - }, - "SecretArn": { - "shape": "__string", - "locationName": "secretArn" - } - }, - "required": [ - "Mechanism", - "SecretArn" - ] - }, - "KafkaClusterMTLSAuthentication": { - "type": "structure", - "members": { - "SecretArn": { - "shape": "__string", - "locationName": "secretArn" - } - }, - "required": [ - "SecretArn" - ] - }, - "KafkaClusterSaslScramMechanism": { - "type": "string", - "enum": [ - "SHA256", - "SHA512" - ] - }, - "KafkaClusterEncryptionInTransit": { - "type": "structure", - "members": { - "EncryptionType": { - "shape": "KafkaClusterEncryptionInTransitType", - "locationName": "encryptionType" - }, - "RootCaCertificate": { - "shape": "__string", - "locationName": "rootCaCertificate" - } - }, - "required": [ - "EncryptionType" - ] - }, - "KafkaClusterEncryptionInTransitType": { - "type": "string", - "enum": [ - "TLS" - ] - }, - "KafkaClusterDescription": { - "type": "structure", - "members": { - "AmazonMskCluster": { - "shape": "AmazonMskCluster", - "locationName": "amazonMskCluster" - }, - "ApacheKafkaCluster": { - "shape": "ApacheKafkaCluster", - "locationName": "apacheKafkaCluster" - }, - "KafkaClusterAlias": { - "shape": "__string", - "locationName": "kafkaClusterAlias" - }, - "VpcConfig": { - "shape": "KafkaClusterClientVpcConfig", - "locationName": "vpcConfig" - }, - "ClientAuthentication": { - "shape": "KafkaClusterClientAuthentication", - "locationName": "clientAuthentication" - }, - "EncryptionInTransit": { - "shape": "KafkaClusterEncryptionInTransit", - "locationName": "encryptionInTransit" - } - } - }, - "KafkaClusterSummary": { - "type": "structure", - "members": { - "AmazonMskCluster": { - "shape": "AmazonMskCluster", - "locationName": "amazonMskCluster" - }, - "ApacheKafkaCluster": { - "shape": "ApacheKafkaCluster", - "locationName": "apacheKafkaCluster" - }, - "KafkaClusterAlias": { - "shape": "__string", - "locationName": "kafkaClusterAlias" - } - } - }, - "KafkaVersion": { - "type": "structure", - "members": { - "Version": { - "shape": "__string", - "locationName": "version" - }, - "Status": { - "shape": "KafkaVersionStatus", - "locationName": "status" - } - } - }, - "KafkaVersionStatus": { - "type": "string", - "enum": [ - "ACTIVE", - "DEPRECATED" - ] - }, - "ListClusterOperationsRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn" - }, - "MaxResults": { - "shape": "MaxResults", - "location": "querystring", - "locationName": "maxResults" - }, - "NextToken": { - "shape": "__string", - "location": "querystring", - "locationName": "nextToken" - } - }, - "required": [ - "ClusterArn" - ] - }, - "ListClusterOperationsV2Request": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn" - }, - "MaxResults": { - "shape": "MaxResults", - "location": "querystring", - "locationName": "maxResults" - }, - "NextToken": { - "shape": "__string", - "location": "querystring", - "locationName": "nextToken" - } - }, - "required": [ - "ClusterArn" - ] - }, - "ListClusterOperationsResponse": { - "type": "structure", - "members": { - "ClusterOperationInfoList": { - "shape": "__listOfClusterOperationInfo", - "locationName": "clusterOperationInfoList" - }, - "NextToken": { - "shape": "__string", - "locationName": "nextToken" - } - } - }, - "ListClusterOperationsV2Response": { - "type": "structure", - "members": { - "ClusterOperationInfoList": { - "shape": "__listOfClusterOperationV2Summary", - "locationName": "clusterOperationInfoList" - }, - "NextToken": { - "shape": "__string", - "locationName": "nextToken" - } - } - }, - "ListClustersV2Request": { - "type": "structure", - "members": { - "ClusterNameFilter": { - "shape": "__string", - "location": "querystring", - "locationName": "clusterNameFilter", - "documentation": "\n

Specify a prefix of the names of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.

\n " - }, - "ClusterTypeFilter": { - "shape": "__string", - "location": "querystring", - "locationName": "clusterTypeFilter", - "documentation": "\n

Specify either PROVISIONED or SERVERLESS.

\n " - }, - "MaxResults": { - "shape": "MaxResults", - "location": "querystring", - "locationName": "maxResults", - "documentation": "\n

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

\n " - }, - "NextToken": { - "shape": "__string", - "location": "querystring", - "locationName": "nextToken", - "documentation": "\n

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. \n To get the next batch, provide this token in your next request.

\n " - } - } - }, - "ListClustersV2Response": { - "type": "structure", - "members": { - "ClusterInfoList": { - "shape": "__listOfCluster", - "locationName": "clusterInfoList", - "documentation": "\n

Information on each of the MSK clusters in the response.

\n " - }, - "NextToken": { - "shape": "__string", - "locationName": "nextToken", - "documentation": "\n

The paginated results marker. When the result of a ListClusters operation is truncated, the call returns NextToken in the response. \n To get another batch of clusters, provide this token in your next request.

\n " - } - } - }, - "CreateClusterV2Request": { - "type": "structure", - "members": { - "ClusterName": { - "shape": "__stringMin1Max64", - "locationName": "clusterName", - "documentation": "\n

The name of the cluster.

\n " - }, - "Tags": { - "shape": "__mapOf__string", - "locationName": "tags", - "documentation": "\n

A map of tags that you want the cluster to have.

\n " - }, - "Provisioned": { - "shape": "ProvisionedRequest", - "locationName": "provisioned", - "documentation": "\n

Information about the provisioned cluster.

\n " - }, - "Serverless": { - "shape": "ServerlessRequest", - "locationName": "serverless", - "documentation": "\n

Information about the serverless cluster.

\n " - } - }, - "required": [ - "ClusterName" - ] - }, - "CreateClusterV2Response": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster.

\n " - }, - "ClusterName": { - "shape": "__string", - "locationName": "clusterName", - "documentation": "\n

The name of the MSK cluster.

\n " - }, - "State": { - "shape": "ClusterState", - "locationName": "state", - "documentation": "\n

The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

\n " - }, - "ClusterType": { - "shape": "ClusterType", - "locationName": "clusterType", - "documentation": "\n

The type of the cluster. The possible types are PROVISIONED or SERVERLESS.

\n " - } - } - }, - "DeadLetterQueueS3": { - "type": "structure", - "members": { - "BucketArn": { - "shape": "__string", - "locationName": "bucketArn" - }, - "ErrorOutputPrefix": { - "shape": "__string", - "locationName": "errorOutputPrefix" - }, - "ExpectedBucketOwner": { - "shape": "__string", - "locationName": "expectedBucketOwner" - } - }, - "required": [ - "BucketArn" - ] - }, - "CustomerActionStatus": { - "type": "string", - "enum": [ - "CRITICAL_ACTION_REQUIRED", - "ACTION_RECOMMENDED", - "NONE" - ] - }, - "DescribeClusterV2Request": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

\n " - } - }, - "required": [ - "ClusterArn" - ] - }, - "DescribeClusterV2Response": { - "type": "structure", - "members": { - "ClusterInfo": { - "shape": "Cluster", - "locationName": "clusterInfo", - "documentation": "\n

The cluster information.

\n " - } - } - }, - "DeleteChannelRequest": { - "type": "structure", - "members": { - "ChannelArn": { - "shape": "__string", - "location": "uri", - "locationName": "channelArn" - }, - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn" - } - }, - "required": [ - "ClusterArn", - "ChannelArn" - ] - }, - "DeleteChannelResponse": { - "type": "structure", - "members": { - "ChannelArn": { - "shape": "__string", - "locationName": "channelArn" - }, - "ClusterOperationArn": { - "shape": "__string", - "locationName": "clusterOperationArn" - } - }, - "required": [ - "ChannelArn" - ] - }, - "DeleteClusterPolicyRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn" - } - }, - "required": [ - "ClusterArn" - ] - }, - "DeleteClusterPolicyResponse": { - "type": "structure", - "members": {} - }, - "GetClusterPolicyRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn" - } - }, - "required": [ - "ClusterArn" - ] - }, - "GetClusterPolicyResponse": { - "type": "structure", - "members": { - "CurrentVersion": { - "shape": "__string", - "locationName": "currentVersion" - }, - "Policy": { - "shape": "__string", - "locationName": "policy" - } - } - }, - "RecordConverter": { - "type": "structure", - "members": { - "ValueConverter": { - "shape": "ValueConverter", - "locationName": "valueConverter" - } - }, - "required": [ - "ValueConverter" - ] - }, - "RecordSchema": { - "type": "structure", - "members": { - "GsrArn": { - "shape": "__string", - "locationName": "gsrArn" - } - }, - "required": [ - "GsrArn" - ] - }, - "PutClusterPolicyRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn" - }, - "CurrentVersion": { - "shape": "__string", - "locationName": "currentVersion" - }, - "Policy": { - "shape": "__string", - "locationName": "policy" - } - }, - "required": [ - "ClusterArn", - "Policy" - ] - }, - "PutClusterPolicyResponse": { - "type": "structure", - "members": { - "CurrentVersion": { - "shape": "__string", - "locationName": "currentVersion" - } - } - }, - "Cluster": { - "type": "structure", - "members": { - "ActiveOperationArn": { - "shape": "__string", - "locationName": "activeOperationArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies a cluster operation.

\n " - }, - "ClusterType": { - "shape": "ClusterType", - "locationName": "clusterType", - "documentation": "\n

Cluster Type.

\n " - }, - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

\n " - }, - "ClusterName": { - "shape": "__string", - "locationName": "clusterName", - "documentation": "\n

The name of the cluster.

\n " - }, - "CreationTime": { - "shape": "__timestampIso8601", - "locationName": "creationTime", - "documentation": "\n

The time when the cluster was created.

\n " - }, - "CurrentVersion": { - "shape": "__string", - "locationName": "currentVersion", - "documentation": "\n

The current version of the MSK cluster.

\n " - }, - "State": { - "shape": "ClusterState", - "locationName": "state", - "documentation": "\n

The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

\n " - }, - "StateInfo": { - "shape": "StateInfo", - "locationName": "stateInfo", - "documentation": "\n

State Info for the Amazon MSK cluster.

\n " - }, - "Tags": { - "shape": "__mapOf__string", - "locationName": "tags", - "documentation": "\n

Tags attached to the cluster.

\n " - }, - "Provisioned": { - "shape": "Provisioned", - "locationName": "provisioned", - "documentation": "\n

Information about the provisioned cluster.

\n " - }, - "Serverless": { - "shape": "Serverless", - "locationName": "serverless", - "documentation": "\n

Information about the serverless cluster.

\n " - } - }, - "documentation": "\n

Returns information about a cluster.

\n " - }, - "ClusterType": { - "type": "string", - "documentation": "\n

The type of cluster.

\n ", - "enum": [ - "PROVISIONED", - "SERVERLESS" - ] - }, - "Rebalancing": { - "type": "structure", - "documentation": "\n

Specifies whether or not intelligent rebalancing is turned on for a newly created MSK Provisioned cluster with Express brokers. Intelligent rebalancing performs automatic partition balancing operations when you scale your clusters up or down. By default, intelligent rebalancing is ACTIVE for all new Express-based clusters.

\n ", - "members": { - "Status": { - "shape": "RebalancingStatus", - "locationName": "status", - "documentation": "\n

Intelligent rebalancing status. The default intelligent rebalancing status is ACTIVE for all new Express-based clusters.

\n " - } - }, - "required": [ - "Status" - ] - }, - "RebalancingStatus": { - "type": "string", - "documentation": "\n

Intelligent rebalancing status. The default intelligent rebalancing status is ACTIVE for all new Express-based clusters.

\n ", - "enum": [ - "PAUSED", - "ACTIVE" - ] - }, - "ProvisionedRequest": { - "type": "structure", - "documentation": "\n

Provisioned cluster request.

\n ", - "members": { - "BrokerNodeGroupInfo": { - "shape": "BrokerNodeGroupInfo", - "locationName": "brokerNodeGroupInfo", - "documentation": "\n

Information about the brokers.

\n " - }, - "ClientAuthentication": { - "shape": "ClientAuthentication", - "locationName": "clientAuthentication", - "documentation": "\n

Includes all client authentication information.

\n " - }, - "ConfigurationInfo": { - "shape": "ConfigurationInfo", - "locationName": "configurationInfo", - "documentation": "\n

Represents the configuration that you want Amazon MSK to use for the brokers in a cluster.

\n " - }, - "EncryptionInfo": { - "shape": "EncryptionInfo", - "locationName": "encryptionInfo", - "documentation": "\n

Includes all encryption-related information.

\n " - }, - "EnhancedMonitoring": { - "shape": "EnhancedMonitoring", - "locationName": "enhancedMonitoring", - "documentation": "\n

Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.

\n " - }, - "OpenMonitoring": { - "shape": "OpenMonitoringInfo", - "locationName": "openMonitoring", - "documentation": "\n

The settings for open monitoring.

\n " - }, - "KafkaVersion": { - "shape": "__stringMin1Max128", - "locationName": "kafkaVersion", - "documentation": "\n

The Apache Kafka version that you want for the cluster.

\n " - }, - "LoggingInfo": { - "shape": "LoggingInfo", - "locationName": "loggingInfo", - "documentation": "\n

Log delivery information for the cluster.

\n " - }, - "NumberOfBrokerNodes": { - "shape": "__integerMin1Max15", - "locationName": "numberOfBrokerNodes", - "documentation": "\n

The number of brokers in the cluster.

\n " - }, - "StorageMode": { - "shape": "StorageMode", - "locationName": "storageMode", - "documentation": "\n

This controls storage mode for supported storage tiers.

\n " - }, - "Rebalancing": { - "shape": "Rebalancing", - "locationName": "rebalancing", - "documentation": "\n

Specifies if intelligent rebalancing should be turned on for a new MSK Provisioned cluster with Express brokers. For all new Express-based clusters that you create, intelligent rebalancing is turned on by default.

\n " - } - }, - "required": [ - "BrokerNodeGroupInfo", - "KafkaVersion", - "NumberOfBrokerNodes" - ] - }, - "Provisioned": { - "type": "structure", - "documentation": "\n

Provisioned cluster.

\n ", - "members": { - "BrokerNodeGroupInfo": { - "shape": "BrokerNodeGroupInfo", - "locationName": "brokerNodeGroupInfo", - "documentation": "\n

Information about the brokers.

\n " - }, - "CurrentBrokerSoftwareInfo": { - "shape": "BrokerSoftwareInfo", - "locationName": "currentBrokerSoftwareInfo", - "documentation": "\n

Information about the Apache Kafka version deployed on the brokers.

\n " - }, - "ClientAuthentication": { - "shape": "ClientAuthentication", - "locationName": "clientAuthentication", - "documentation": "\n

Includes all client authentication information.

\n " - }, - "EncryptionInfo": { - "shape": "EncryptionInfo", - "locationName": "encryptionInfo", - "documentation": "\n

Includes all encryption-related information.

\n " - }, - "EnhancedMonitoring": { - "shape": "EnhancedMonitoring", - "locationName": "enhancedMonitoring", - "documentation": "\n

Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.

\n " - }, - "OpenMonitoring": { - "shape": "OpenMonitoringInfo", - "locationName": "openMonitoring", - "documentation": "\n

The settings for open monitoring.

\n " - }, - "LoggingInfo": { - "shape": "LoggingInfo", - "locationName": "loggingInfo", - "documentation": "\n

Log delivery information for the cluster.

\n " - }, - "NumberOfBrokerNodes": { - "shape": "__integerMin1Max15", - "locationName": "numberOfBrokerNodes", - "documentation": "\n

The number of brokers in the cluster.

\n " - }, - "ZookeeperConnectString": { - "shape": "__string", - "locationName": "zookeeperConnectString", - "documentation": "\n

The connection string to use to connect to the Apache ZooKeeper cluster.

\n " - }, - "ZookeeperConnectStringTls": { - "shape": "__string", - "locationName": "zookeeperConnectStringTls", - "documentation": "\n

The connection string to use to connect to the Apache ZooKeeper cluster on a TLS port.

\n " - }, - "StorageMode": { - "shape": "StorageMode", - "locationName": "storageMode", - "documentation": "\n

This controls storage mode for supported storage tiers.

\n " - }, - "Rebalancing": { - "shape": "Rebalancing", - "locationName": "rebalancing", - "documentation": "\n

Specifies if intelligent rebalancing is turned on for your MSK Provisioned cluster with Express brokers. For all new Express-based clusters that you create, intelligent rebalancing is turned on by default.

\n " - }, - "CustomerActionStatus": { - "shape": "CustomerActionStatus", - "locationName": "customerActionStatus", - "documentation": "\n

Determines if there is an action required from the customer.

\n " - } - }, - "required": [ - "BrokerNodeGroupInfo", - "NumberOfBrokerNodes" - ] - }, - "ValueConverter": { - "type": "string", - "enum": [ - "BYTE_ARRAY", - "JSON", - "JSON_SCHEMA_GSR", - "STRING" - ] - }, - "VpcConfig": { - "type": "structure", - "documentation": "\n

The configuration of the Amazon VPCs for the cluster.

\n ", - "members": { - "SubnetIds": { - "shape": "__listOf__string", - "locationName": "subnetIds", - "documentation": "\n

The IDs of the subnets associated with the cluster.

\n " - }, - "SecurityGroupIds": { - "shape": "__listOf__string", - "locationName": "securityGroupIds", - "documentation": "\n

The IDs of the security groups associated with the cluster.

\n " - } - }, - "required": [ - "SubnetIds" - ] - }, - "ServerlessRequest": { - "type": "structure", - "documentation": "\n

Serverless cluster request.

\n ", - "members": { - "VpcConfigs": { - "shape": "__listOfVpcConfig", - "locationName": "vpcConfigs", - "documentation": "\n

The configuration of the Amazon VPCs for the cluster.

\n " - }, - "ClientAuthentication": { - "shape": "ServerlessClientAuthentication", - "locationName": "clientAuthentication", - "documentation": "\n

Includes all client authentication information.

\n " - } - }, - "required": [ - "VpcConfigs" - ] - }, - "ServerlessClientAuthentication": { - "type": "structure", - "members": { - "Sasl": { - "shape": "ServerlessSasl", - "locationName": "sasl", - "documentation": "\n

Details for client authentication using SASL.

\n " - } - }, - "documentation": "\n

Includes all client authentication information.

\n " - }, - "ServerlessSasl": { - "type": "structure", - "members": { - "Iam": { - "shape": "Iam", - "locationName": "iam", - "documentation": "\n

Indicates whether IAM access control is enabled.

\n " - } - }, - "documentation": "\n

Details for client authentication using SASL.

\n " - }, - "ServerlessConnectivityInfo": { - "type": "structure", - "members": { - "NetworkType": { - "shape": "NetworkType", - "locationName": "networkType", - "documentation": "\n

The network type of the cluster, which is IPv4 or DUAL. The DUAL network type uses both IPv4 and IPv6 addresses for your cluster and its resources.

By default, a cluster uses the IPv4 network type.

\n " - } - } - }, - "Serverless": { - "type": "structure", - "documentation": "\n

Serverless cluster.

\n ", - "members": { - "VpcConfigs": { - "shape": "__listOfVpcConfig", - "locationName": "vpcConfigs", - "documentation": "\n

The configuration of the Amazon VPCs for the cluster.

\n " - }, - "ClientAuthentication": { - "shape": "ServerlessClientAuthentication", - "locationName": "clientAuthentication", - "documentation": "\n

Includes all client authentication information.

\n " - }, - "ConnectivityInfo": { - "shape": "ServerlessConnectivityInfo", - "locationName": "connectivityInfo", - "documentation": "\n

Describes the cluster's connectivity information, such as its network type, which is IPv4 or DUAL.

\n " - } - }, - "required": [ - "VpcConfigs" - ] - }, - "ListChannelsRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn" - }, - "MaxResults": { - "shape": "MaxResults", - "location": "querystring", - "locationName": "maxResults" - }, - "NextToken": { - "shape": "__string", - "location": "querystring", - "locationName": "nextToken" - }, - "TopicNameFilter": { - "shape": "__string", - "location": "querystring", - "locationName": "topicNameFilter" - } - }, - "required": [ - "ClusterArn" - ] - }, - "ListChannelsResponse": { - "type": "structure", - "members": { - "Channels": { - "shape": "__listOfChannelInfo", - "locationName": "channels" - }, - "NextToken": { - "shape": "__string", - "locationName": "nextToken" - } - } - }, - "ListClustersRequest": { - "type": "structure", - "members": { - "ClusterNameFilter": { - "shape": "__string", - "location": "querystring", - "locationName": "clusterNameFilter" - }, - "MaxResults": { - "shape": "MaxResults", - "location": "querystring", - "locationName": "maxResults" - }, - "NextToken": { - "shape": "__string", - "location": "querystring", - "locationName": "nextToken" - } - } - }, - "ListClustersResponse": { - "type": "structure", - "members": { - "ClusterInfoList": { - "shape": "__listOfClusterInfo", - "locationName": "clusterInfoList" - }, - "NextToken": { - "shape": "__string", - "locationName": "nextToken" - } - } - }, - "ListConfigurationRevisionsRequest": { - "type": "structure", - "members": { - "Arn": { - "shape": "__string", - "location": "uri", - "locationName": "arn" - }, - "MaxResults": { - "shape": "MaxResults", - "location": "querystring", - "locationName": "maxResults" - }, - "NextToken": { - "shape": "__string", - "location": "querystring", - "locationName": "nextToken" - } - }, - "required": [ - "Arn" - ] - }, - "ListConfigurationRevisionsResponse": { - "type": "structure", - "members": { - "NextToken": { - "shape": "__string", - "locationName": "nextToken" - }, - "Revisions": { - "shape": "__listOfConfigurationRevision", - "locationName": "revisions" - } - } - }, - "ListConfigurationsRequest": { - "type": "structure", - "members": { - "MaxResults": { - "shape": "MaxResults", - "location": "querystring", - "locationName": "maxResults" - }, - "NextToken": { - "shape": "__string", - "location": "querystring", - "locationName": "nextToken" - } - } - }, - "ListConfigurationsResponse": { - "type": "structure", - "members": { - "Configurations": { - "shape": "__listOfConfiguration", - "locationName": "configurations" - }, - "NextToken": { - "shape": "__string", - "locationName": "nextToken" - } - } - }, - "ListKafkaVersionsRequest": { - "type": "structure", - "members": { - "MaxResults": { - "shape": "MaxResults", - "location": "querystring", - "locationName": "maxResults" - }, - "NextToken": { - "shape": "__string", - "location": "querystring", - "locationName": "nextToken" - } - } - }, - "ListKafkaVersionsResponse": { - "type": "structure", - "members": { - "KafkaVersions": { - "shape": "__listOfKafkaVersion", - "locationName": "kafkaVersions" - }, - "NextToken": { - "shape": "__string", - "locationName": "nextToken" - } - } - }, - "ListNodesRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn" - }, - "MaxResults": { - "shape": "MaxResults", - "location": "querystring", - "locationName": "maxResults" - }, - "NextToken": { - "shape": "__string", - "location": "querystring", - "locationName": "nextToken" - } - }, - "required": [ - "ClusterArn" - ] - }, - "ListNodesResponse": { - "type": "structure", - "members": { - "NextToken": { - "shape": "__string", - "locationName": "nextToken" - }, - "NodeInfoList": { - "shape": "__listOfNodeInfo", - "locationName": "nodeInfoList" - } - } - }, - "ListScramSecretsRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn" - }, - "MaxResults": { - "shape": "MaxResults", - "location": "querystring", - "locationName": "maxResults" - }, - "NextToken": { - "shape": "__string", - "location": "querystring", - "locationName": "nextToken" - } - }, - "required": [ - "ClusterArn" - ] - }, - "ListScramSecretsResponse": { - "type": "structure", - "members": { - "NextToken": { - "shape": "__string", - "locationName": "nextToken" - }, - "SecretArnList": { - "shape": "__listOf__string", - "locationName": "secretArnList" - } - } - }, - "ListTagsForResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "shape": "__string", - "location": "uri", - "locationName": "resourceArn" - } - }, - "required": [ - "ResourceArn" - ] - }, - "ListTagsForResourceResponse": { - "type": "structure", - "members": { - "Tags": { - "shape": "__mapOf__string", - "locationName": "tags" - } - } - }, - "MaxResults": { - "type": "integer", - "min": 1, - "max": 100 - }, - "LoggingInfo": { - "type": "structure", - "members": { - "BrokerLogs": { - "shape": "BrokerLogs", - "locationName": "brokerLogs" - } - }, - "required": [ - "BrokerLogs" - ] - }, - "ChannelLoggingInfo": { - "type": "structure", - "members": { - "CloudWatchLogs": { - "shape": "CloudWatchLogs", - "locationName": "cloudWatchLogs" - }, - "Firehose": { - "shape": "Firehose", - "locationName": "firehose" - }, - "S3": { - "shape": "S3", - "locationName": "s3" - } - } - }, - "ListClientVpcConnectionsRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn" - }, - "MaxResults": { - "shape": "MaxResults", - "location": "querystring", - "locationName": "maxResults" - }, - "NextToken": { - "shape": "__string", - "location": "querystring", - "locationName": "nextToken" - } - }, - "required": [ - "ClusterArn" - ] - }, - "ListClientVpcConnectionsResponse": { - "type": "structure", - "members": { - "NextToken": { - "shape": "__string", - "locationName": "nextToken" - }, - "ClientVpcConnections": { - "shape": "__listOfClientVpcConnection", - "locationName": "clientVpcConnections" - } - } - }, - "ListTopicsRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn" - }, - "MaxResults": { - "shape": "MaxResults", - "location": "querystring", - "locationName": "maxResults" - }, - "NextToken": { - "shape": "__string", - "location": "querystring", - "locationName": "nextToken" - }, - "TopicNameFilter": { - "shape": "__string", - "location": "querystring", - "locationName": "topicNameFilter" - } - }, - "required": [ - "ClusterArn" - ] - }, - "ListTopicsResponse": { - "type": "structure", - "members": { - "Topics": { - "shape": "__listOfTopicInfo", - "locationName": "topics" - }, - "NextToken": { - "shape": "__string", - "locationName": "nextToken" - } - } - }, - "ListReplicatorsRequest": { - "type": "structure", - "members": { - "MaxResults": { - "shape": "MaxResults", - "location": "querystring", - "locationName": "maxResults" - }, - "NextToken": { - "shape": "__string", - "location": "querystring", - "locationName": "nextToken" - }, - "ReplicatorNameFilter": { - "shape": "__string", - "location": "querystring", - "locationName": "replicatorNameFilter" - } - } - }, - "ListReplicatorsResponse": { - "type": "structure", - "members": { - "NextToken": { - "shape": "__string", - "locationName": "nextToken" - }, - "Replicators": { - "shape": "__listOfReplicatorSummary", - "locationName": "replicators" - } - } - }, - "ListVpcConnectionsRequest": { - "type": "structure", - "members": { - "MaxResults": { - "shape": "MaxResults", - "location": "querystring", - "locationName": "maxResults" - }, - "NextToken": { - "shape": "__string", - "location": "querystring", - "locationName": "nextToken" - } - } - }, - "ListVpcConnectionsResponse": { - "type": "structure", - "members": { - "NextToken": { - "shape": "__string", - "locationName": "nextToken" - }, - "VpcConnections": { - "shape": "__listOfVpcConnection", - "locationName": "vpcConnections" - } - } - }, - "RejectClientVpcConnectionRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn" - }, - "VpcConnectionArn": { - "shape": "__string", - "locationName": "vpcConnectionArn" - } - }, - "required": [ - "VpcConnectionArn", - "ClusterArn" - ] - }, - "RejectClientVpcConnectionResponse": { - "type": "structure", - "members": {} - }, - "MutableClusterInfo": { - "type": "structure", - "members": { - "BrokerEBSVolumeInfo": { - "shape": "__listOfBrokerEBSVolumeInfo", - "locationName": "brokerEBSVolumeInfo" - }, - "ConfigurationInfo": { - "shape": "ConfigurationInfo", - "locationName": "configurationInfo" - }, - "NumberOfBrokerNodes": { - "shape": "__integer", - "locationName": "numberOfBrokerNodes" - }, - "OpenMonitoring": { - "shape": "OpenMonitoring", - "locationName": "openMonitoring" - }, - "EnhancedMonitoring": { - "shape": "EnhancedMonitoring", - "locationName": "enhancedMonitoring" - }, - "KafkaVersion": { - "shape": "__string", - "locationName": "kafkaVersion" - }, - "LoggingInfo": { - "shape": "LoggingInfo", - "locationName": "loggingInfo" - }, - "InstanceType": { - "shape": "__string", - "locationName": "instanceType" - }, - "ClientAuthentication": { - "shape": "ClientAuthentication", - "locationName": "clientAuthentication" - }, - "EncryptionInfo": { - "shape": "EncryptionInfo", - "locationName": "encryptionInfo" - }, - "ConnectivityInfo": { - "shape": "ConnectivityInfo", - "locationName": "connectivityInfo" - }, - "ZookeeperAccess": { - "shape": "ZookeeperAccess", - "locationName": "zookeeperAccess" - }, - "StorageMode": { - "shape": "StorageMode", - "locationName": "storageMode" - }, - "BrokerCountUpdateInfo": { - "shape": "BrokerCountUpdateInfo", - "locationName": "brokerCountUpdateInfo" - }, - "Rebalancing": { - "shape": "Rebalancing", - "locationName": "rebalancing" - } - } - }, - "NodeInfo": { - "type": "structure", - "members": { - "AddedToClusterTime": { - "shape": "__string", - "locationName": "addedToClusterTime" - }, - "BrokerNodeInfo": { - "shape": "BrokerNodeInfo", - "locationName": "brokerNodeInfo" - }, - "ControllerNodeInfo": { - "shape": "ControllerNodeInfo", - "locationName": "controllerNodeInfo" - }, - "InstanceType": { - "shape": "__string", - "locationName": "instanceType" - }, - "NodeARN": { - "shape": "__string", - "locationName": "nodeARN" - }, - "NodeType": { - "shape": "NodeType", - "locationName": "nodeType" - }, - "ZookeeperNodeInfo": { - "shape": "ZookeeperNodeInfo", - "locationName": "zookeeperNodeInfo" - } - } - }, - "NetworkType": { - "type": "string", - "documentation": "\n

The network type of the cluster, which is IPv4 or DUAL. The DUAL network type uses both IPv4 and IPv6 addresses for your cluster and its resources.

By default, a cluster uses the IPv4 network type.

\n ", - "enum": [ - "IPV4", - "DUAL" - ] - }, - "ZookeeperAccess": { - "type": "structure", - "members": { - "Enabled": { - "shape": "__boolean", - "locationName": "enabled" - } - }, - "documentation": "\n

Access control settings for zookeeper

\n " - }, - "NodeType": { - "type": "string", - "enum": [ - "BROKER" - ] - }, - "NotFoundException": { - "type": "structure", - "members": { - "InvalidParameter": { - "shape": "__string", - "locationName": "invalidParameter" - }, - "Message": { - "shape": "__string", - "locationName": "message" - } - }, - "exception": true, - "error": { - "httpStatusCode": 404 - } - }, - "ReplicationInfo": { - "type": "structure", - "members": { - "ConsumerGroupReplication": { - "shape": "ConsumerGroupReplication", - "locationName": "consumerGroupReplication" - }, - "SourceKafkaClusterArn": { - "shape": "__string", - "locationName": "sourceKafkaClusterArn" - }, - "SourceKafkaClusterId": { - "shape": "__string", - "locationName": "sourceKafkaClusterId" - }, - "TargetCompressionType": { - "shape": "TargetCompressionType", - "locationName": "targetCompressionType" - }, - "TargetKafkaClusterArn": { - "shape": "__string", - "locationName": "targetKafkaClusterArn" - }, - "TargetKafkaClusterId": { - "shape": "__string", - "locationName": "targetKafkaClusterId" - }, - "TopicReplication": { - "shape": "TopicReplication", - "locationName": "topicReplication" - } - }, - "required": [ - "TargetCompressionType", - "TopicReplication", - "ConsumerGroupReplication" - ] - }, - "ReplicationInfoDescription": { - "type": "structure", - "members": { - "ConsumerGroupReplication": { - "shape": "ConsumerGroupReplication", - "locationName": "consumerGroupReplication" - }, - "SourceKafkaClusterAlias": { - "shape": "__string", - "locationName": "sourceKafkaClusterAlias" - }, - "TargetCompressionType": { - "shape": "TargetCompressionType", - "locationName": "targetCompressionType" - }, - "TargetKafkaClusterAlias": { - "shape": "__string", - "locationName": "targetKafkaClusterAlias" - }, - "TopicReplication": { - "shape": "TopicReplication", - "locationName": "topicReplication" - } - } - }, - "ReplicationInfoSummary": { - "type": "structure", - "members": { - "SourceKafkaClusterAlias": { - "shape": "__string", - "locationName": "sourceKafkaClusterAlias" - }, - "TargetKafkaClusterAlias": { - "shape": "__string", - "locationName": "targetKafkaClusterAlias" - } - } - }, - "ReplicationStartingPosition": { - "type": "structure", - "members": { - "Type": { - "shape": "ReplicationStartingPositionType", - "locationName": "type" - } - } - }, - "ReplicationStartingPositionType": { - "type": "string", - "enum": [ - "LATEST", - "EARLIEST" - ] - }, - "ReplicationTopicNameConfiguration": { - "type": "structure", - "members": { - "Type": { - "shape": "ReplicationTopicNameConfigurationType", - "locationName": "type" - } - } - }, - "ReplicationTopicNameConfigurationType": { - "type": "string", - "enum": [ - "PREFIXED_WITH_SOURCE_CLUSTER_ALIAS", - "IDENTICAL" - ] - }, - "ReplicatorCloudWatchLogs": { - "type": "structure", - "members": { - "Enabled": { - "shape": "__boolean", - "locationName": "enabled" - }, - "LogGroup": { - "shape": "__string", - "locationName": "logGroup" - } - }, - "required": [ - "Enabled" - ] - }, - "ReplicatorFirehose": { - "type": "structure", - "members": { - "DeliveryStream": { - "shape": "__string", - "locationName": "deliveryStream" - }, - "Enabled": { - "shape": "__boolean", - "locationName": "enabled" - } - }, - "required": [ - "Enabled" - ] - }, - "ReplicatorS3": { - "type": "structure", - "members": { - "Bucket": { - "shape": "__string", - "locationName": "bucket" - }, - "Enabled": { - "shape": "__boolean", - "locationName": "enabled" - }, - "Prefix": { - "shape": "__string", - "locationName": "prefix" - } - }, - "required": [ - "Enabled" - ] - }, - "LogDelivery": { - "type": "structure", - "members": { - "ReplicatorLogDelivery": { - "shape": "ReplicatorLogDelivery", - "locationName": "replicatorLogDelivery" - } - } - }, - "ReplicatorLogDelivery": { - "type": "structure", - "members": { - "CloudWatchLogs": { - "shape": "ReplicatorCloudWatchLogs", - "locationName": "cloudWatchLogs" - }, - "Firehose": { - "shape": "ReplicatorFirehose", - "locationName": "firehose" - }, - "S3": { - "shape": "ReplicatorS3", - "locationName": "s3" - } - } - }, - "ReplicationStateInfo": { - "type": "structure", - "members": { - "Code": { - "shape": "__string", - "locationName": "code" - }, - "Message": { - "shape": "__string", - "locationName": "message" - } - } - }, - "ReplicatorState": { - "type": "string", - "enum": [ - "RUNNING", - "CREATING", - "UPDATING", - "DELETING", - "FAILED" - ] - }, - "ReplicatorSummary": { - "type": "structure", - "members": { - "CreationTime": { - "shape": "__timestampIso8601", - "locationName": "creationTime" - }, - "CurrentVersion": { - "shape": "__string", - "locationName": "currentVersion" - }, - "IsReplicatorReference": { - "shape": "__boolean", - "locationName": "isReplicatorReference" - }, - "KafkaClustersSummary": { - "shape": "__listOfKafkaClusterSummary", - "locationName": "kafkaClustersSummary" - }, - "ReplicationInfoSummaryList": { - "shape": "__listOfReplicationInfoSummary", - "locationName": "replicationInfoSummaryList" - }, - "ReplicatorArn": { - "shape": "__string", - "locationName": "replicatorArn" - }, - "ReplicatorName": { - "shape": "__string", - "locationName": "replicatorName" - }, - "ReplicatorResourceArn": { - "shape": "__string", - "locationName": "replicatorResourceArn" - }, - "ReplicatorState": { - "shape": "ReplicatorState", - "locationName": "replicatorState" - } - } - }, - "SchemaEvolution": { - "type": "structure", - "members": { - "EnableSchemaEvolution": { - "shape": "__boolean", - "locationName": "enableSchemaEvolution" - } - } - }, - "Sasl": { - "type": "structure", - "members": { - "Scram": { - "shape": "Scram", - "locationName": "scram" - }, - "Iam": { - "shape": "Iam", - "locationName": "iam" - } - } - }, - "VpcConnectivitySasl": { - "type": "structure", - "members": { - "Scram": { - "shape": "VpcConnectivityScram", - "locationName": "scram" - }, - "Iam": { - "shape": "VpcConnectivityIam", - "locationName": "iam" - } - } - }, - "Scram": { - "type": "structure", - "members": { - "Enabled": { - "shape": "__boolean", - "locationName": "enabled" - } - } - }, - "VpcConnectivityScram": { - "type": "structure", - "members": { - "Enabled": { - "shape": "__boolean", - "locationName": "enabled" - } - } - }, - "Iam": { - "type": "structure", - "members": { - "Enabled": { - "shape": "__boolean", - "locationName": "enabled" - } - } - }, - "VpcConnectivityIam": { - "type": "structure", - "members": { - "Enabled": { - "shape": "__boolean", - "locationName": "enabled" - } - } - }, - "ServiceUnavailableException": { - "type": "structure", - "members": { - "InvalidParameter": { - "shape": "__string", - "locationName": "invalidParameter" - }, - "Message": { - "shape": "__string", - "locationName": "message" - } - }, - "exception": true, - "error": { - "httpStatusCode": 503 - } - }, - "StateInfo": { - "type": "structure", - "members": { - "Code": { - "shape": "__string", - "locationName": "code" - }, - "Message": { - "shape": "__string", - "locationName": "message" - } - } - }, - "StorageInfo": { - "type": "structure", - "members": { - "EbsStorageInfo": { - "shape": "EBSStorageInfo", - "locationName": "ebsStorageInfo" - } - } - }, - "StorageMode": { - "type": "string", - "enum": [ - "LOCAL", - "TIERED" - ] - }, - "TableCreation": { - "type": "structure", - "members": { - "EnableTableCreation": { - "shape": "__boolean", - "locationName": "enableTableCreation" - } - } - }, - "TagResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "shape": "__string", - "location": "uri", - "locationName": "resourceArn" - }, - "Tags": { - "shape": "__mapOf__string", - "locationName": "tags" - } - }, - "required": [ - "ResourceArn", - "Tags" - ] - }, - "TargetCompressionType": { - "type": "string", - "enum": [ - "NONE", - "GZIP", - "SNAPPY", - "LZ4", - "ZSTD" - ] - }, - "TopicReplication": { - "type": "structure", - "members": { - "CopyAccessControlListsForTopics": { - "shape": "__boolean", - "locationName": "copyAccessControlListsForTopics" - }, - "CopyTopicConfigurations": { - "shape": "__boolean", - "locationName": "copyTopicConfigurations" - }, - "DetectAndCopyNewTopics": { - "shape": "__boolean", - "locationName": "detectAndCopyNewTopics" - }, - "StartingPosition": { - "shape": "ReplicationStartingPosition", - "locationName": "startingPosition" - }, - "TopicNameConfiguration": { - "shape": "ReplicationTopicNameConfiguration", - "locationName": "topicNameConfiguration" - }, - "TopicsToExclude": { - "shape": "__listOf__stringMax249", - "locationName": "topicsToExclude" - }, - "TopicsToReplicate": { - "shape": "__listOf__stringMax249", - "locationName": "topicsToReplicate" - } - }, - "required": [ - "TopicsToReplicate" - ] - }, - "TopicReplicationUpdate": { - "type": "structure", - "members": { - "CopyAccessControlListsForTopics": { - "shape": "__boolean", - "locationName": "copyAccessControlListsForTopics" - }, - "CopyTopicConfigurations": { - "shape": "__boolean", - "locationName": "copyTopicConfigurations" - }, - "DetectAndCopyNewTopics": { - "shape": "__boolean", - "locationName": "detectAndCopyNewTopics" - }, - "TopicsToExclude": { - "shape": "__listOf__stringMax249", - "locationName": "topicsToExclude" - }, - "TopicsToReplicate": { - "shape": "__listOf__stringMax249", - "locationName": "topicsToReplicate" - } - }, - "required": [ - "TopicsToReplicate", - "TopicsToExclude", - "CopyTopicConfigurations", - "DetectAndCopyNewTopics", - "CopyAccessControlListsForTopics" - ] - }, - "Tls": { - "type": "structure", - "members": { - "CertificateAuthorityArnList": { - "shape": "__listOf__string", - "locationName": "certificateAuthorityArnList" - }, - "Enabled": { - "shape": "__boolean", - "locationName": "enabled" - } - } - }, - "TopicConfiguration": { - "type": "structure", - "members": { - "RecordConverter": { - "shape": "RecordConverter", - "locationName": "recordConverter" - }, - "RecordSchema": { - "shape": "RecordSchema", - "locationName": "recordSchema" - }, - "TopicArn": { - "shape": "__string", - "locationName": "topicArn" - } - }, - "required": [ - "RecordConverter", - "TopicArn" - ] - }, - "TopicInfo": { - "type": "structure", - "members": { - "TopicArn": { - "shape": "__string", - "locationName": "topicArn" - }, - "TopicName": { - "shape": "__string", - "locationName": "topicName" - }, - "ReplicationFactor": { - "shape": "__integer", - "locationName": "replicationFactor" - }, - "PartitionCount": { - "shape": "__integer", - "locationName": "partitionCount" - }, - "OutOfSyncReplicaCount": { - "shape": "__integer", - "locationName": "outOfSyncReplicaCount" - } - } - }, - "VpcConnectivityTls": { - "type": "structure", - "members": { - "Enabled": { - "shape": "__boolean", - "locationName": "enabled" - } - } - }, - "TooManyRequestsException": { - "type": "structure", - "members": { - "InvalidParameter": { - "shape": "__string", - "locationName": "invalidParameter" - }, - "Message": { - "shape": "__string", - "locationName": "message" - } - }, - "exception": true, - "error": { - "httpStatusCode": 429 - } - }, - "Unauthenticated": { - "type": "structure", - "members": { - "Enabled": { - "shape": "__boolean", - "locationName": "enabled" - } - } - }, - "UnauthorizedException": { - "type": "structure", - "members": { - "InvalidParameter": { - "shape": "__string", - "locationName": "invalidParameter" - }, - "Message": { - "shape": "__string", - "locationName": "message" - } - }, - "exception": true, - "error": { - "httpStatusCode": 401 - } - }, - "TopicExistsException": { - "type": "structure", - "members": { - "InvalidParameter": { - "shape": "__string", - "locationName": "invalidParameter" - }, - "Message": { - "shape": "__string", - "locationName": "message" - } - }, - "exception": true, - "error": { - "httpStatusCode": 409 - } - }, - "ClusterConnectivityException": { - "type": "structure", - "members": { - "InvalidParameter": { - "shape": "__string", - "locationName": "invalidParameter" - }, - "Message": { - "shape": "__string", - "locationName": "message" - } - }, - "exception": true, - "error": { - "httpStatusCode": 409 - } - }, - "KafkaTimeoutException": { - "type": "structure", - "members": { - "InvalidParameter": { - "shape": "__string", - "locationName": "invalidParameter" - }, - "Message": { - "shape": "__string", - "locationName": "message" - } - }, - "exception": true, - "error": { - "httpStatusCode": 409 - } - }, - "UnknownTopicOrPartitionException": { - "type": "structure", - "members": { - "InvalidParameter": { - "shape": "__string", - "locationName": "invalidParameter" - }, - "Message": { - "shape": "__string", - "locationName": "message" - } - }, - "exception": true, - "error": { - "httpStatusCode": 404 - } - }, - "ControllerMovedException": { - "type": "structure", - "members": { - "InvalidParameter": { - "shape": "__string", - "locationName": "invalidParameter" - }, - "Message": { - "shape": "__string", - "locationName": "message" - } - }, - "exception": true, - "error": { - "httpStatusCode": 409 - } - }, - "NotControllerException": { - "type": "structure", - "members": { - "InvalidParameter": { - "shape": "__string", - "locationName": "invalidParameter" - }, - "Message": { - "shape": "__string", - "locationName": "message" - } - }, - "exception": true, - "error": { - "httpStatusCode": 409 - } - }, - "ReassignmentInProgressException": { - "type": "structure", - "members": { - "InvalidParameter": { - "shape": "__string", - "locationName": "invalidParameter" - }, - "Message": { - "shape": "__string", - "locationName": "message" - } - }, - "exception": true, - "error": { - "httpStatusCode": 409 - } - }, - "GroupSubscribedToTopicException": { - "type": "structure", - "members": { - "InvalidParameter": { - "shape": "__string", - "locationName": "invalidParameter" - }, - "Message": { - "shape": "__string", - "locationName": "message" - } - }, - "exception": true, - "error": { - "httpStatusCode": 409 - } - }, - "KafkaRequestException": { - "type": "structure", - "members": { - "InvalidParameter": { - "shape": "__string", - "locationName": "invalidParameter" - }, - "Message": { - "shape": "__string", - "locationName": "message" - } - }, - "exception": true, - "error": { - "httpStatusCode": 400 - } - }, - "UnprocessedScramSecret": { - "type": "structure", - "members": { - "ErrorCode": { - "shape": "__string", - "locationName": "errorCode" - }, - "ErrorMessage": { - "shape": "__string", - "locationName": "errorMessage" - }, - "SecretArn": { - "shape": "__string", - "locationName": "secretArn" - } - } - }, - "UntagResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "shape": "__string", - "location": "uri", - "locationName": "resourceArn" - }, - "TagKeys": { - "shape": "__listOf__string", - "location": "querystring", - "locationName": "tagKeys" - } - }, - "required": [ - "TagKeys", - "ResourceArn" - ] - }, - "UpdateBrokerTypeRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn" - }, - "CurrentVersion": { - "shape": "__string", - "locationName": "currentVersion" - }, - "TargetInstanceType": { - "shape": "__string", - "locationName": "targetInstanceType" - } - }, - "required": [ - "ClusterArn", - "CurrentVersion", - "TargetInstanceType" - ] - }, - "UpdateBrokerTypeResponse": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn" - }, - "ClusterOperationArn": { - "shape": "__string", - "locationName": "clusterOperationArn" - } - } - }, - "UpdateBrokerCountRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn" - }, - "CurrentVersion": { - "shape": "__string", - "locationName": "currentVersion" - }, - "TargetNumberOfBrokerNodes": { - "shape": "__integerMin1Max15", - "locationName": "targetNumberOfBrokerNodes" - } - }, - "required": [ - "ClusterArn", - "CurrentVersion", - "TargetNumberOfBrokerNodes" - ] - }, - "UpdateBrokerCountResponse": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn" - }, - "ClusterOperationArn": { - "shape": "__string", - "locationName": "clusterOperationArn" - } - } - }, - "UpdateRebalancingRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn" - }, - "CurrentVersion": { - "shape": "__string", - "locationName": "currentVersion" - }, - "Rebalancing": { - "shape": "Rebalancing", - "locationName": "rebalancing" - } - }, - "required": [ - "ClusterArn", - "CurrentVersion", - "Rebalancing" - ] - }, - "UpdateRebalancingResponse": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn" - }, - "ClusterOperationArn": { - "shape": "__string", - "locationName": "clusterOperationArn" - } - } - }, - "UpdateBrokerStorageRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn" - }, - "CurrentVersion": { - "shape": "__string", - "locationName": "currentVersion" - }, - "TargetBrokerEBSVolumeInfo": { - "shape": "__listOfBrokerEBSVolumeInfo", - "locationName": "targetBrokerEBSVolumeInfo" - } - }, - "required": [ - "ClusterArn", - "TargetBrokerEBSVolumeInfo", - "CurrentVersion" - ] - }, - "UpdateBrokerStorageResponse": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn" - }, - "ClusterOperationArn": { - "shape": "__string", - "locationName": "clusterOperationArn" - } - } - }, - "S3CompressionType": { - "type": "string", - "enum": [ - "NONE", - "GZIP", - "ZSTD" - ] - }, - "S3DestinationConfiguration": { - "type": "structure", - "members": { - "DataFreshnessInSeconds": { - "shape": "__integer", - "locationName": "dataFreshnessInSeconds" - }, - "DeadLetterQueueS3": { - "shape": "DeadLetterQueueS3", - "locationName": "deadLetterQueueS3" - }, - "ServiceExecutionRoleArn": { - "shape": "__string", - "locationName": "serviceExecutionRoleArn" - }, - "Storage": { - "shape": "S3Storage", - "locationName": "storage" - } - }, - "required": [ - "Storage", - "ServiceExecutionRoleArn", - "DeadLetterQueueS3" - ] - }, - "IcebergDestinationUpdate": { - "type": "structure", - "members": { - "DataFreshnessInSeconds": { - "shape": "__integer", - "locationName": "dataFreshnessInSeconds" - } - }, - "required": [ - "DataFreshnessInSeconds" - ] - }, - "S3DestinationUpdate": { - "type": "structure", - "members": { - "DataFreshnessInSeconds": { - "shape": "__integer", - "locationName": "dataFreshnessInSeconds" - } - }, - "required": [ - "DataFreshnessInSeconds" - ] - }, - "S3Storage": { - "type": "structure", - "members": { - "BucketArn": { - "shape": "__string", - "locationName": "bucketArn" - }, - "CompressionType": { - "shape": "S3CompressionType", - "locationName": "compressionType" - }, - "OutputPrefix": { - "shape": "__string", - "locationName": "outputPrefix" - }, - "OutputKeyTemplate": { - "shape": "__string", - "locationName": "outputKeyTemplate" - }, - "StorageClass": { - "shape": "S3StorageClass", - "locationName": "storageClass" - }, - "ExpectedBucketOwner": { - "shape": "__string", - "locationName": "expectedBucketOwner" - } - }, - "required": [ - "BucketArn", - "StorageClass", - "CompressionType" - ] - }, - "S3StorageClass": { - "type": "string", - "enum": [ - "STANDARD", - "INTELLIGENT_TIERING", - "GLACIER_IR" - ] - }, - "UpdateChannelRequest": { - "type": "structure", - "members": { - "ChannelArn": { - "shape": "__string", - "location": "uri", - "locationName": "channelArn" - }, - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn" - }, - "IcebergDestinationUpdate": { - "shape": "IcebergDestinationUpdate", - "locationName": "icebergDestinationUpdate" - }, - "S3DestinationUpdate": { - "shape": "S3DestinationUpdate", - "locationName": "s3DestinationUpdate" - } - }, - "required": [ - "ClusterArn", - "ChannelArn" - ] - }, - "UpdateChannelResponse": { - "type": "structure", - "members": { - "ChannelArn": { - "shape": "__string", - "locationName": "channelArn" - }, - "ClusterOperationArn": { - "shape": "__string", - "locationName": "clusterOperationArn" - } - }, - "required": [ - "ChannelArn" - ] - }, - "UpdateClusterConfigurationRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn" - }, - "ConfigurationInfo": { - "shape": "ConfigurationInfo", - "locationName": "configurationInfo" - }, - "CurrentVersion": { - "shape": "__string", - "locationName": "currentVersion" - } - }, - "required": [ - "ClusterArn", - "CurrentVersion", - "ConfigurationInfo" - ] - }, - "UpdateClusterConfigurationResponse": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn" - }, - "ClusterOperationArn": { - "shape": "__string", - "locationName": "clusterOperationArn" - } - } - }, - "UpdateClusterKafkaVersionRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn" - }, - "ConfigurationInfo": { - "shape": "ConfigurationInfo", - "locationName": "configurationInfo" - }, - "CurrentVersion": { - "shape": "__string", - "locationName": "currentVersion" - }, - "TargetKafkaVersion": { - "shape": "__string", - "locationName": "targetKafkaVersion" - } - }, - "required": [ - "ClusterArn", - "TargetKafkaVersion", - "CurrentVersion" - ] - }, - "UpdateClusterKafkaVersionResponse": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn" - }, - "ClusterOperationArn": { - "shape": "__string", - "locationName": "clusterOperationArn" - } - } - }, - "UpdateConfigurationRequest": { - "type": "structure", - "members": { - "Arn": { - "shape": "__string", - "location": "uri", - "locationName": "arn" - }, - "Description": { - "shape": "__string", - "locationName": "description" - }, - "ServerProperties": { - "shape": "__blob", - "locationName": "serverProperties" - } - }, - "required": [ - "Arn", - "ServerProperties" - ] - }, - "UpdateConfigurationResponse": { - "type": "structure", - "members": { - "Arn": { - "shape": "__string", - "locationName": "arn" - }, - "LatestRevision": { - "shape": "ConfigurationRevision", - "locationName": "latestRevision" - } - } - }, - "UpdateConnectivityRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn" - }, - "ConnectivityInfo": { - "shape": "ConnectivityInfo", - "locationName": "connectivityInfo" - }, - "CurrentVersion": { - "shape": "__string", - "locationName": "currentVersion" - }, - "ZookeeperAccess": { - "shape": "ZookeeperAccess", - "locationName": "zookeeperAccess" - } - }, - "required": [ - "ClusterArn", - "CurrentVersion" - ] - }, - "UpdateConnectivityResponse": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn" - }, - "ClusterOperationArn": { - "shape": "__string", - "locationName": "clusterOperationArn" - } - } - }, - "UpdateMonitoringRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn" - }, - "CurrentVersion": { - "shape": "__string", - "locationName": "currentVersion" - }, - "EnhancedMonitoring": { - "shape": "EnhancedMonitoring", - "locationName": "enhancedMonitoring" - }, - "OpenMonitoring": { - "shape": "OpenMonitoringInfo", - "locationName": "openMonitoring" - }, - "LoggingInfo": { - "shape": "LoggingInfo", - "locationName": "loggingInfo" - } - }, - "required": [ - "ClusterArn", - "CurrentVersion" - ] - }, - "UpdateMonitoringResponse": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn" - }, - "ClusterOperationArn": { - "shape": "__string", - "locationName": "clusterOperationArn" - } - } - }, - "UpdateReplicationInfoRequest": { - "type": "structure", - "members": { - "ConsumerGroupReplication": { - "shape": "ConsumerGroupReplicationUpdate", - "locationName": "consumerGroupReplication" - }, - "CurrentVersion": { - "shape": "__string", - "locationName": "currentVersion" - }, - "LogDelivery": { - "shape": "LogDelivery", - "locationName": "logDelivery" - }, - "ReplicatorArn": { - "shape": "__string", - "location": "uri", - "locationName": "replicatorArn" - }, - "SourceKafkaClusterArn": { - "shape": "__string", - "locationName": "sourceKafkaClusterArn" - }, - "SourceKafkaClusterId": { - "shape": "__string", - "locationName": "sourceKafkaClusterId" - }, - "TargetKafkaClusterArn": { - "shape": "__string", - "locationName": "targetKafkaClusterArn" - }, - "TargetKafkaClusterId": { - "shape": "__string", - "locationName": "targetKafkaClusterId" - }, - "TopicReplication": { - "shape": "TopicReplicationUpdate", - "locationName": "topicReplication" - } - }, - "required": [ - "ReplicatorArn", - "CurrentVersion" - ] - }, - "UpdateReplicationInfoResponse": { - "type": "structure", - "members": { - "ReplicatorArn": { - "shape": "__string", - "locationName": "replicatorArn" - }, - "ReplicatorState": { - "shape": "ReplicatorState", - "locationName": "replicatorState" - } - } - }, - "UpdateSecurityRequest": { - "type": "structure", - "members": { - "ClientAuthentication": { - "shape": "ClientAuthentication", - "locationName": "clientAuthentication" - }, - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn" - }, - "CurrentVersion": { - "shape": "__string", - "locationName": "currentVersion" - }, - "EncryptionInfo": { - "shape": "EncryptionInfo", - "locationName": "encryptionInfo" - } - }, - "required": [ - "ClusterArn", - "CurrentVersion" - ] - }, - "UpdateSecurityResponse": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn" - }, - "ClusterOperationArn": { - "shape": "__string", - "locationName": "clusterOperationArn" - } - } - }, - "UpdateStorageRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn" - }, - "CurrentVersion": { - "shape": "__string", - "locationName": "currentVersion" - }, - "ProvisionedThroughput": { - "shape": "ProvisionedThroughput", - "locationName": "provisionedThroughput" - }, - "StorageMode": { - "shape": "StorageMode", - "locationName": "storageMode" - }, - "VolumeSizeGB": { - "shape": "__integer", - "locationName": "volumeSizeGB" - } - }, - "required": [ - "ClusterArn", - "CurrentVersion" - ] - }, - "UpdateTopicRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn" - }, - "TopicName": { - "shape": "__string", - "location": "uri", - "locationName": "topicName" - }, - "Configs": { - "shape": "__string", - "locationName": "configs" - }, - "PartitionCount": { - "shape": "__integer", - "locationName": "partitionCount" - } - }, - "required": [ - "ClusterArn", - "TopicName" - ] - }, - "UpdateTopicResponse": { - "type": "structure", - "members": { - "TopicArn": { - "shape": "__string", - "locationName": "topicArn" - }, - "TopicName": { - "shape": "__string", - "locationName": "topicName" - }, - "Status": { - "shape": "TopicState", - "locationName": "status" - } - } - }, - "UpdateStorageResponse": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn" - }, - "ClusterOperationArn": { - "shape": "__string", - "locationName": "clusterOperationArn" - } - } - }, - "UserIdentity": { - "type": "structure", - "members": { - "Type": { - "shape": "UserIdentityType", - "locationName": "type" - }, - "PrincipalId": { - "shape": "__string", - "locationName": "principalId" - } - } - }, - "UserIdentityType": { - "type": "string", - "enum": [ - "AWSACCOUNT", - "AWSSERVICE" - ] - }, - "ZookeeperNodeInfo": { - "type": "structure", - "members": { - "AttachedENIId": { - "shape": "__string", - "locationName": "attachedENIId" - }, - "ClientVpcIpAddress": { - "shape": "__string", - "locationName": "clientVpcIpAddress" - }, - "Endpoints": { - "shape": "__listOf__string", - "locationName": "endpoints" - }, - "ZookeeperId": { - "shape": "__double", - "locationName": "zookeeperId" - }, - "ZookeeperVersion": { - "shape": "__string", - "locationName": "zookeeperVersion" - } - } - }, - "ControllerNodeInfo": { - "type": "structure", - "members": { - "Endpoints": { - "shape": "__listOf__string", - "locationName": "endpoints" - } - } - }, - "OpenMonitoring": { - "type": "structure", - "members": { - "Prometheus": { - "shape": "Prometheus", - "locationName": "prometheus" - } - }, - "required": [ - "Prometheus" - ] - }, - "OpenMonitoringInfo": { - "type": "structure", - "members": { - "Prometheus": { - "shape": "PrometheusInfo", - "locationName": "prometheus" - } - }, - "required": [ - "Prometheus" - ] - }, - "PartitionSource": { - "type": "structure", - "members": { - "SourceName": { - "shape": "__string", - "locationName": "sourceName" - } - } - }, - "PartitionSpec": { - "type": "structure", - "members": { - "PartitionStrategy": { - "shape": "PartitionStrategy", - "locationName": "partitionStrategy" - }, - "SourceList": { - "shape": "__listOfPartitionSource", - "locationName": "sourceList" - } - }, - "required": [ - "PartitionStrategy" - ] - }, - "PartitionStrategy": { - "type": "string", - "enum": [ - "TIME_HOUR" - ] - }, - "Prometheus": { - "type": "structure", - "members": { - "JmxExporter": { - "shape": "JmxExporter", - "locationName": "jmxExporter" - }, - "NodeExporter": { - "shape": "NodeExporter", - "locationName": "nodeExporter" - } - } - }, - "PrometheusInfo": { - "type": "structure", - "members": { - "JmxExporter": { - "shape": "JmxExporterInfo", - "locationName": "jmxExporter" - }, - "NodeExporter": { - "shape": "NodeExporterInfo", - "locationName": "nodeExporter" - } - } - }, - "ProvisionedThroughput": { - "type": "structure", - "members": { - "Enabled": { - "shape": "__boolean", - "locationName": "enabled" - }, - "VolumeThroughput": { - "shape": "__integer", - "locationName": "volumeThroughput" - } - } - }, - "PublicAccess": { - "type": "structure", - "members": { - "Type": { - "shape": "__string", - "locationName": "type" - } - } - }, - "VpcConnectivity": { - "type": "structure", - "members": { - "ClientAuthentication": { - "shape": "VpcConnectivityClientAuthentication", - "locationName": "clientAuthentication" - } - } - }, - "VpcConnectionInfo": { - "type": "structure", - "members": { - "VpcConnectionArn": { - "shape": "__string", - "locationName": "vpcConnectionArn" - }, - "Owner": { - "shape": "__string", - "locationName": "owner" - }, - "UserIdentity": { - "shape": "UserIdentity", - "locationName": "userIdentity" - }, - "CreationTime": { - "shape": "__timestampIso8601", - "locationName": "creationTime" - } - } - }, - "VpcConnectionInfoServerless": { - "type": "structure", - "members": { - "CreationTime": { - "shape": "__timestampIso8601", - "locationName": "creationTime" - }, - "Owner": { - "shape": "__string", - "locationName": "owner" - }, - "UserIdentity": { - "shape": "UserIdentity", - "locationName": "userIdentity" - }, - "VpcConnectionArn": { - "shape": "__string", - "locationName": "vpcConnectionArn" - } - } - }, - "TopicState": { - "type": "string", - "enum": [ - "CREATING", - "UPDATING", - "DELETING", - "ACTIVE" - ] - }, - "VpcConnectionState": { - "type": "string", - "enum": [ - "CREATING", - "AVAILABLE", - "INACTIVE", - "DEACTIVATING", - "DELETING", - "FAILED", - "REJECTED", - "REJECTING" - ] - }, - "RebootBrokerRequest": { - "type": "structure", - "members": { - "BrokerIds": { - "shape": "__listOf__string", - "locationName": "brokerIds" - }, - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn" - } - }, - "required": [ - "ClusterArn", - "BrokerIds" - ] - }, - "RebootBrokerResponse": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn" - }, - "ClusterOperationArn": { - "shape": "__string", - "locationName": "clusterOperationArn" - } - } - }, - "S3": { - "type": "structure", - "members": { - "Bucket": { - "shape": "__string", - "locationName": "bucket" - }, - "Enabled": { - "shape": "__boolean", - "locationName": "enabled" - }, - "Prefix": { - "shape": "__string", - "locationName": "prefix" - } - }, - "required": [ - "Enabled" - ] - }, - "JmxExporter": { - "type": "structure", - "members": { - "EnabledInBroker": { - "shape": "__boolean", - "locationName": "enabledInBroker" - } - }, - "required": [ - "EnabledInBroker" - ] - }, - "JmxExporterInfo": { - "type": "structure", - "members": { - "EnabledInBroker": { - "shape": "__boolean", - "locationName": "enabledInBroker" - } - }, - "required": [ - "EnabledInBroker" - ] - }, - "NodeExporter": { - "type": "structure", - "members": { - "EnabledInBroker": { - "shape": "__boolean", - "locationName": "enabledInBroker" - } - }, - "required": [ - "EnabledInBroker" - ] - }, - "NodeExporterInfo": { - "type": "structure", - "members": { - "EnabledInBroker": { - "shape": "__boolean", - "locationName": "enabledInBroker" - } - }, - "required": [ - "EnabledInBroker" - ] - }, - "__boolean": { - "type": "boolean" - }, - "__blob": { - "type": "blob" - }, - "__double": { - "type": "double" - }, - "__integer": { - "type": "integer" - }, - "__integerMin1Max15": { - "type": "integer", - "min": 1, - "max": 15 - }, - "__integerMin1Max16384": { - "type": "integer", - "min": 1, - "max": 16384 - }, - "__integerMin1": { - "type": "integer", - "min": 1 - }, - "__listOfChannelInfo": { - "type": "list", - "member": { - "shape": "ChannelInfo" - } - }, - "__listOfBrokerEBSVolumeInfo": { - "type": "list", - "member": { - "shape": "BrokerEBSVolumeInfo" - } - }, - "__listOfClusterInfo": { - "type": "list", - "member": { - "shape": "ClusterInfo" - } - }, - "__listOfClusterOperationV2Summary": { - "type": "list", - "member": { - "shape": "ClusterOperationV2Summary" - } - }, - "__listOfClusterOperationInfo": { - "type": "list", - "member": { - "shape": "ClusterOperationInfo" - } - }, - "__listOfClusterOperationStep": { - "type": "list", - "member": { - "shape": "ClusterOperationStep" - } - }, - "__listOfCompatibleKafkaVersion": { - "type": "list", - "member": { - "shape": "CompatibleKafkaVersion" - } - }, - "__listOfCluster": { - "type": "list", - "member": { - "shape": "Cluster" - } - }, - "__listOfVpcConfig": { - "type": "list", - "member": { - "shape": "VpcConfig" - } - }, - "__listOfConfiguration": { - "type": "list", - "member": { - "shape": "Configuration" - } - }, - "__listOfDestinationTable": { - "type": "list", - "member": { - "shape": "DestinationTable" - } - }, - "__listOfConfigurationRevision": { - "type": "list", - "member": { - "shape": "ConfigurationRevision" - } - }, - "__listOfKafkaCluster": { - "type": "list", - "member": { - "shape": "KafkaCluster" - } - }, - "__listOfKafkaClusterDescription": { - "type": "list", - "member": { - "shape": "KafkaClusterDescription" - } - }, - "__listOfKafkaClusterSummary": { - "type": "list", - "member": { - "shape": "KafkaClusterSummary" - } - }, - "__listOfKafkaVersion": { - "type": "list", - "member": { - "shape": "KafkaVersion" - } - }, - "__listOfNodeInfo": { - "type": "list", - "member": { - "shape": "NodeInfo" - } - }, - "__listOfClientVpcConnection": { - "type": "list", - "member": { - "shape": "ClientVpcConnection" - } - }, - "__listOfPartitionSource": { - "type": "list", - "member": { - "shape": "PartitionSource" - } - }, - "__listOfReplicationInfo": { - "type": "list", - "member": { - "shape": "ReplicationInfo" - } - }, - "__listOfReplicationInfoDescription": { - "type": "list", - "member": { - "shape": "ReplicationInfoDescription" - } - }, - "__listOfReplicationInfoSummary": { - "type": "list", - "member": { - "shape": "ReplicationInfoSummary" - } - }, - "__listOfReplicatorSummary": { - "type": "list", - "member": { - "shape": "ReplicatorSummary" - } - }, - "__listOfTopicConfiguration": { - "type": "list", - "member": { - "shape": "TopicConfiguration" - } - }, - "__listOfTopicInfo": { - "type": "list", - "member": { - "shape": "TopicInfo" - } - }, - "__listOfTopicPartitionInfo": { - "type": "list", - "member": { - "shape": "TopicPartitionInfo" - } - }, - "__listOfVpcConnection": { - "type": "list", - "member": { - "shape": "VpcConnection" - } - }, - "__listOfUnprocessedScramSecret": { - "type": "list", - "member": { - "shape": "UnprocessedScramSecret" - } - }, - "__listOf__double": { - "type": "list", - "member": { - "shape": "__double" - } - }, - "__listOf__string": { - "type": "list", - "member": { - "shape": "__string" - } - }, - "__listOf__integer": { - "type": "list", - "member": { - "shape": "__integer" - } - }, - "__listOf__stringMax249": { - "type": "list", - "member": { - "shape": "__stringMax249" - } - }, - "__listOf__stringMax256": { - "type": "list", - "member": { - "shape": "__stringMax256" - } - }, - "__long": { - "type": "long" - }, - "__mapOf__string": { - "type": "map", - "key": { - "shape": "__string" - }, - "value": { - "shape": "__string" - } - }, - "__string": { - "type": "string" - }, - "__stringMax1024": { - "type": "string", - "max": 1024 - }, - "__stringMax249": { - "type": "string", - "max": 249 - }, - "__stringMax256": { - "type": "string", - "max": 256 - }, - "__stringMin1Max128": { - "type": "string", - "min": 1, - "max": 128 - }, - "__stringMin1Max128Pattern09AZaZ09AZaZ0": { - "type": "string", - "min": 1, - "max": 128, - "pattern": "^[0-9A-Za-z][0-9A-Za-z-]{0,}$" - }, - "__stringMin1Max64": { - "type": "string", - "min": 1, - "max": 64 - }, - "__stringMin5Max32": { - "type": "string", - "min": 5, - "max": 32 - }, - "__timestampIso8601": { - "type": "timestamp", - "timestampFormat": "iso8601" - }, - "__timestampUnix": { - "type": "timestamp", - "timestampFormat": "unixTimestamp" - } - } -} \ No newline at end of file diff --git a/tools/code-generation/api-descriptions/kafka/2018-11-14/docs-2.json b/tools/code-generation/api-descriptions/kafka/2018-11-14/docs-2.json deleted file mode 100644 index 1b7480636ea4..000000000000 --- a/tools/code-generation/api-descriptions/kafka/2018-11-14/docs-2.json +++ /dev/null @@ -1,2086 +0,0 @@ -{ - "version" : "2.0", - "service" : "

The operations for managing an Amazon MSK cluster.

", - "operations" : { - "BatchAssociateScramSecret" : "

Associates one or more Scram Secrets with an Amazon MSK cluster.

", - "CreateCluster" : "

Creates a new MSK cluster.

", - "CreateChannel" : "

Creates a Channel that streams records from an Amazon MSK Express cluster topic to Amazon S3 or Apache Iceberg.

", - "CreateClusterV2" : "

Creates a new Amazon MSK cluster of either the provisioned or the serverless type.

", - "CreateReplicator" : "

Creates a new Kafka Replicator.

", - "CreateConfiguration" : "

Creates a new MSK configuration.

", - "CreateTopic": "

Creates a topic in the specified MSK cluster.

", - "CreateVpcConnection" : "

Creates a new Amazon MSK VPC connection.

", - "DeleteCluster" : "

Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.

", - "DeleteChannel" : "

Deletes the channel specified by channelArn from the cluster specified by clusterArn. The channel transitions through DELETING and is removed when the asynchronous delete completes.

", - "DeleteClusterPolicy" : "

Deletes the MSK cluster policy specified by the Amazon Resource Name (ARN) in your request.

", - "DeleteConfiguration" : "

Deletes the specified MSK configuration. The configuration must be in the ACTIVE or DELETE_FAILED state.

", - "DeleteReplicator" : "

Deletes a replicator.

", - "DeleteVpcConnection" : "

Deletes the Amazon MSK VPC connection specified in your request.

", - "DescribeCluster" : "

Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.

", - "DescribeChannel" : "

Returns the current configuration and state of a channel.

", - "DescribeClusterV2" : "

Returns a description of the MSK cluster of either the provisioned or the serverless type whose Amazon Resource Name (ARN) is specified in the request.

", - "DescribeClusterOperation" : "

Returns a description of the cluster operation specified by the ARN.

", - "DescribeClusterOperationV2" : "

Returns a description of the cluster operation specified by the ARN.

", - "DescribeConfiguration" : "

Returns a description of this MSK configuration.

", - "DescribeConfigurationRevision" : "

Returns a description of this revision of the configuration.

", - "DescribeReplicator" : "

Returns a description of the Kafka Replicator whose Amazon Resource Name (ARN) is specified in the request.

", - "DeleteTopic": "

Deletes a topic in the specified MSK cluster.

", - "DescribeTopic": "

Returns topic details of this topic on a MSK cluster.

", - "DescribeTopicPartitions": "

Returns partition details of this topic on a MSK cluster.

", - "DescribeVpcConnection" : "

Displays information about the specified Amazon MSK VPC connection.

", - "BatchDisassociateScramSecret" : "

Disassociates one or more Scram Secrets from an Amazon MSK cluster.

", - "GetBootstrapBrokers" : "

A list of brokers that a client application can use to bootstrap. This list doesn't necessarily include all of the brokers in the cluster. The following Python 3.6 example shows how you can use the Amazon Resource Name (ARN) of a cluster to get its bootstrap brokers. If you don't know the ARN of your cluster, you can use the ListClusters operation to get the ARNs of all the clusters in this account and Region.

", - "GetCompatibleKafkaVersions" : "

Gets the Apache Kafka versions to which you can update the MSK cluster.

", - "GetClusterPolicy" : "

Retrieves the contents of the specified MSK cluster policy.

", - "ListChannels" : "

Returns the list of channels in a cluster.

", - "ListClientVpcConnections" : "

Displays a list of client VPC connections.

", - "ListClusterOperations" : "

Returns a list of all the operations that have been performed on the specified MSK cluster.

", - "ListClusterOperationsV2" : "

Returns a list of all the operations that have been performed on the specified MSK cluster.

", - "ListClusters" : "

Returns a list of all the MSK clusters in the current Region.

", - "ListClustersV2" : "

Returns a list of all the MSK clusters in the current Region.

", - "ListConfigurationRevisions" : "

Returns a list of all the revisions of an MSK configuration.

", - "ListConfigurations" : "

Returns a list of all the MSK configurations in this Region.

", - "ListKafkaVersions" : "

Returns a list of Apache Kafka versions.

", - "ListNodes" : "

Returns a list of the broker nodes in the cluster.

", - "ListReplicators" : "

Lists the replicators.

", - "ListScramSecrets" : "

Returns a list of the Scram Secrets associated with an Amazon MSK cluster.

", - "ListTagsForResource" : "

Returns a list of the tags associated with the specified resource.

", - "ListVpcConnections" : "

Displays a list of Amazon MSK VPC connections.

", - "ListTopics": "

List topics in a MSK cluster.

", - "PutClusterPolicy" : "

Creates or updates the specified MSK cluster policy. If updating the policy, the currentVersion field is required in the request payload.

", - "RebootBroker" : "

Executes a reboot on a broker.

", - "RejectClientVpcConnections" : "

Rejects a client VPC connection.

", - "TagResource" : "

Adds tags to the specified MSK resource.

", - "UntagResource" : "

Removes the tags associated with the keys that are provided in the query.

", - "UpdateBrokerCount" : "

Updates the number of broker nodes in the cluster. You can use this operation to increase the number of brokers in an existing cluster. You can't decrease the number of brokers.

", - "UpdateBrokerType": "

Updates all the brokers in the cluster to the specified type.

", - "UpdateBrokerStorage" : "

Updates the EBS storage associated with MSK brokers.

", - "UpdateConfiguration" : "

Updates an existing MSK configuration. The configuration must be in the Active state.

", - "UpdateConnectivity" : "

Updates the connectivity configuration for the MSK cluster.

", - "UpdateChannel" : "

Updates the destination configuration of an existing channel. Exactly one of icebergDestinationUpdate or s3DestinationUpdate must be supplied.

", - "UpdateClusterConfiguration" : "

Updates the cluster with the configuration that is specified in the request body.

", - "UpdateClusterKafkaVersion" : "

Updates the Apache Kafka version for the cluster.

", - "UpdateMonitoring" : "

Updates the monitoring settings for the cluster. You can use this operation to specify which Apache Kafka metrics you want Amazon MSK to send to Amazon CloudWatch. You can also specify settings for open monitoring with Prometheus.

", - "UpdateRebalancing" : "

Use this resource to update the intelligent rebalancing status of an Amazon MSK Provisioned cluster with Express brokers.

", - "UpdateReplicationInfo" : "

Updates replication info of a replicator.

", - "UpdateSecurity" : "

You can use this operation to update the encrypting and authentication settings for an existing cluster.

", - "UpdateStorage" : "

Updates cluster broker volume size (or) sets cluster storage mode to TIERED.

", - "UpdateTopic" : "

Updates the topic configuration or partition count in the specified MSK cluster.

" - }, - "shapes" : { - "AmazonMskCluster" : { - "base" : "

Details of an Amazon MSK Cluster.

", - "refs" : { - "KafkaCluster$AmazonMskCluster" : "

Details of an Amazon MSK Cluster.

", - "KafkaClusterDescription$AmazonMskCluster" : "

Details of an Amazon MSK Cluster.

", - "KafkaClusterSummary$AmazonMskCluster" : "

Details of an Amazon MSK Cluster

." - } - }, - "ApacheKafkaCluster" : { - "base" : "

Details of an Apache Kafka Cluster.

", - "refs" : { - "KafkaCluster$ApacheKafkaCluster" : "

Details of an Apache Kafka Cluster.

", - "KafkaClusterDescription$ApacheKafkaCluster" : "

Details of an Apache Kafka Cluster.

", - "KafkaClusterSummary$ApacheKafkaCluster" : "

Details of an Apache Kafka Cluster.

" - } - }, - "BatchAssociateScramSecretRequest" : { - "base" : "

Request body for BatchAssociateScramSecret.

", - "refs" : { } - }, - "BatchAssociateScramSecretResponse" : { - "base" : "

Response body for BatchAssociateScramSecret.

", - "refs" : { } - }, - "BadRequestException" : { - "base" : "

Returns information about an error.

", - "refs" : { } - }, - "BrokerAZDistribution" : { - "base" : "

The distribution of broker nodes across Availability Zones. By default, broker nodes are distributed among the Availability Zones of your Region. Currently, the only supported value is DEFAULT. You can either specify this value explicitly or leave it out.

", - "refs" : { - "BrokerNodeGroupInfo$BrokerAZDistribution" : "

The distribution of broker nodes across Availability Zones.

" - } - }, - "BrokerEBSVolumeInfo" : { - "base" : "

Specifies the EBS volume upgrade information. The broker identifier must be set to the keyword ALL. This means the changes apply to all the brokers in the cluster.

", - "refs" : { - "__listOfBrokerEBSVolumeInfo$member" : null - } - }, - "BrokerLogs" : { - "base" : "

The broker logs configuration for this MSK cluster.

", - "refs" : { - "LoggingInfo$BrokerLogs" : "

You can configure your MSK cluster to send broker logs to different destination types. This configuration specifies the details of these destinations.

" - } - }, - "BrokerNodeGroupInfo" : { - "base" : "

Describes the setup to be used for Apache Kafka broker nodes in the cluster.

", - "refs" : { - "ClusterInfo$BrokerNodeGroupInfo" : "

Information about the brokers.

", - "Provisioned$BrokerNodeGroupInfo" : "

Information about the brokers.

", - "CreateClusterRequest$BrokerNodeGroupInfo" : "

Information about the brokers.

", - "ProvisionedRequest$BrokerNodeGroupInfo" : "

Information about the brokers.

" - } - }, - "Rebalancing" : { - "base" : "

Includes all rebalancing-related information for the cluster.

", - "refs" : { - "ClusterInfo$Rebalancing" : "

Contains information about intelligent rebalancing for new MSK Provisioned clusters with Express brokers. By default, intelligent rebalancing status is ACTIVE.

", - "CreateClusterRequest$Rebalancing" : "

Specifies if intelligent rebalancing should be turned on for the new MSK Provisioned cluster with Express brokers. By default, intelligent rebalancing status is ACTIVE for all new clusters.

", - "MutableClusterInfo$Rebalancing" : "

Describes the intelligent rebalancing configuration of an MSK Provisioned cluster with Express brokers.

", - "Provisioned$Rebalancing" : "

Specifies whether or not intelligent rebalancing is turned on for a newly created MSK Provisioned cluster with Express brokers. Intelligent rebalancing performs automatic partition balancing operations when you scale your clusters up or down. By default, intelligent rebalancing is ACTIVE for all new Express-based clusters.

", - "ProvisionedRequest$Rebalancing" : "

Specifies if intelligent rebalancing is turned on for your MSK Provisioned cluster with Express brokers. For all new Express-based clusters that you create, intelligent rebalancing is turned on by default.

" - } - }, - "RebalancingStatus" : { - "base" : "

Describes the status of rebalancing of the cluster.

", - "refs" : { - "Rebalancing$RebalancingStatus" : "

Intelligent rebalancing status. The default intelligent rebalancing status is ACTIVE for all new Express-based clusters.

" - } - }, - "Provisioned" : { - "base" : "

Describes the provisioned cluster.

", - "refs" : { - "Cluster$Provisioned" : "

Information about the provisioned cluster.

" - } - }, - "ProvisionedRequest" : { - "base" : "

Creates a provisioned cluster.

", - "refs" : { - "CreateClusterV2Request$Provisioned" : "

Creates a provisioned cluster.

" - } - }, - "ServerlessRequest" : { - "base" : "

Creates serverless cluster.

", - "refs" : { - "CreateClusterV2Request$Serverless" : "

Creates a serverless cluster.

" - } - }, - "Serverless" : { - "base" : "

Describes the serverless cluster.

", - "refs" : { - "Cluster$Serverless" : "

Information about the serverless cluster.

" - } - }, - "ServerlessClientAuthentication" : { - "base" : "

Describes the serverless cluster client authentication.

", - "refs" : { - "Serverless$ClientAuthentication" : "

Information about the serverless cluster client authentication.

", - "ServerlessRequest$ClientAuthentication" : "

Information about the serverless cluster client authentication.

" - } - }, - "ServerlessConnectivityInfo": { - "base": "

Describes the cluster's connectivity information, such as its network type, which is IPv4 or DUAL.

", - "refs": { - "Serverless$ConnectivityInfo": "

Describes the cluster's connectivity information, such as its network type, which is IPv4 or DUAL.

", - "ClusterOperationV2Serverless$SourceClusterInfo": "

Source cluster connectivity information for the cluster.

", - "ClusterOperationV2Serverless$TargetClusterInfo": "

Target cluster connectivity information for the cluster.

" - } - }, - "ServerlessSasl" : { - "base" : "

Describes the serverless cluster SASL information.

", - "refs" : { - "ServerlessClientAuthentication$Sasl" : "

Serverless cluster SASL information.

" - } - }, - "SchemaEvolution" : { - "base" : "

Configuration controlling whether the Apache Iceberg destination table's schema is evolved as incoming records change.

", - "refs" : { - "IcebergDestinationConfiguration$SchemaEvolution" : "

Configuration controlling whether the destination table's schema is evolved to match incoming records.

" - } - }, - "BrokerNodeInfo" : { - "base" : "

BrokerNodeInfo

", - "refs" : { - "NodeInfo$BrokerNodeInfo" : "

The broker node info.

" - } - }, - "BrokerSoftwareInfo" : { - "base" : "

Information about the current software installed on the cluster.

", - "refs" : { - "BrokerNodeInfo$CurrentBrokerSoftwareInfo" : "

Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.

", - "ClusterInfo$CurrentBrokerSoftwareInfo" : "

Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.

", - "Provisioned$CurrentBrokerSoftwareInfo" : "

Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.

" - } - }, - "Catalog" : { - "base" : "

Configuration of the AWS Glue Data Catalog and S3 Tables warehouse used by the Apache Iceberg destination.

", - "refs" : { - "IcebergDestinationConfiguration$Catalog" : "

The AWS Glue Data Catalog and S3 Tables warehouse used by the destination.

" - } - }, - "ChannelInfo" : { - "base" : "

Summary information about a channel returned by ListChannels.

", - "refs" : { - "__listOfChannelInfo$member" : null - } - }, - "ChannelStatus" : { - "base" : "

The lifecycle state of a channel.

", - "refs" : { - "ChannelInfo$Status" : "

The current lifecycle state of the channel.

", - "DescribeChannelResponse$Status" : "

The current lifecycle state of the channel.

" - } - }, - "ChannelDestinationType" : { - "base" : "

The type of destination configured for the channel.

", - "refs" : { - "ChannelInfo$DestinationType" : "

The type of destination configured for the channel.

", - "DescribeChannelResponse$DestinationType" : "

The type of destination configured for the channel.

" - } - }, - "ChannelStateInfo" : { - "base" : "

Additional context for the current channel state, populated when the channel is in FAILED.

", - "refs" : { - "DescribeChannelResponse$StateInfo" : "

Additional context for the current channel state, populated when the channel is in FAILED.

" - } - }, - "CreateChannelRequest" : { - "base" : "

Creates a Channel that streams records from an Amazon MSK Express cluster topic to Amazon S3 or Apache Iceberg.

", - "refs" : { } - }, - "CreateChannelResponse" : { - "base" : "

Returns the channel ARN and the cluster-operation ARN that tracks the asynchronous create.

", - "refs" : { } - }, - "ClientAuthentication" : { - "base" : "

Includes all client authentication information.

", - "refs" : { - "ClusterInfo$ClientAuthentication" : "

Includes all client authentication information.

", - "Provisioned$ClientAuthentication" : "

Includes all client authentication information.

", - "CreateClusterRequest$ClientAuthentication" : "

Includes all client authentication related information.

", - "ProvisionedRequest$ClientAuthentication" : "

Includes all client authentication related information.

", - "MutableClusterInfo$ClientAuthentication" : "

Includes all client authentication related information.

", - "UpdateSecurityRequest$ClientAuthentication" : "

Includes all client authentication related information.

" - } - }, - "ClientBroker" : { - "base" : "

Client-broker encryption in transit setting.

", - "refs" : { - "EncryptionInTransit$ClientBroker" : "

Indicates the encryption setting for data in transit between clients and brokers. You must set it to one of the following values.

TLS means that client-broker communication is enabled with TLS only.

TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.

PLAINTEXT means that client-broker communication is enabled in plaintext only.

The default value is TLS.

" - } - }, - "CloudWatchLogs" : { - "base" : "

Details of the CloudWatch Logs destination for broker logs.

", - "refs" : { - "BrokerLogs$CloudWatchLogs" : "

Details of the CloudWatch Logs destination for broker logs.

", - "ChannelLoggingInfo$CloudWatchLogs": "

Details of the CloudWatch Logs destination for Channel logs.

" - } - }, - "ClusterInfo" : { - "base" : "

Returns information about a cluster.

", - "refs" : { - "DescribeClusterResponse$ClusterInfo" : "

The cluster information.

", - "__listOfClusterInfo$member" : null - } - }, - "Cluster" : { - "base" : "

Returns information about a cluster of either the provisioned or the serverless type.

", - "refs" : { - "DescribeClusterV2Response$ClusterInfo" : "

The cluster information.

", - "__listOfCluster$member" : null - } - }, - "ClusterOperationInfo" : { - "base" : "

Returns information about a cluster operation.

", - "refs" : { - "DescribeClusterOperationResponse$ClusterOperationInfo" : "

Cluster operation information

", - "__listOfClusterOperationInfo$member" : null - } - }, - "ClusterOperationStep" : { - "base" : "

Step taken during a cluster operation.

", - "refs" : { - "__listOfClusterOperationStep$member" : null - } - }, - "ClusterOperationStepInfo" : { - "base" : "

State information about the operation step.

", - "refs" : { - "ClusterOperationStep$StepInfo" : "

Information about the step and its status.

" - } - }, - "ClusterOperationV2" : { - "base" : "

Returns information about a cluster operation.

", - "refs" : { - "DescribeClusterOperationV2Response$ClusterOperationInfo" : "

Cluster operation information

" - } - }, - "ClusterOperationV2Provisioned" : { - "base" : "

Returns information about a provisioned cluster operation.

", - "refs" : { - "ClusterOperationV2$Provisioned" : "

Properties of a provisioned cluster.

" - } - }, - "ClusterOperationV2Serverless" : { - "base" : "

Returns information about a serverless cluster operation.

", - "refs" : { - "ClusterOperationV2$Serverless" : "

Properties of a serverless cluster.

" - } - }, - "ClusterOperationV2Summary" : { - "base" : "

Returns information about a cluster operation.

", - "refs" : { - "__listOfClusterOperationV2Summary$member" : null - } - }, - "ClusterState" : { - "base" : "

The state of an Apache Kafka cluster.

", - "refs" : { - "ClusterInfo$State" : "

The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

", - "CreateClusterResponse$State" : "

The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

", - "CreateClusterV2Response$State" : "

The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

", - "DeleteClusterResponse$State" : "

The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

" - } - }, - "CompatibleKafkaVersion" : { - "base" : "

Contains source Apache Kafka versions and compatible target Apache Kafka versions.

", - "refs" : { - "__listOfCompatibleKafkaVersion$member" : null - } - }, - "Configuration" : { - "base" : "

Represents an MSK Configuration.

", - "refs" : { - "__listOfConfiguration$member" : null - } - }, - "ConfigurationInfo" : { - "base" : "

Specifies the configuration to use for the brokers.

", - "refs" : { - "CreateClusterRequest$ConfigurationInfo" : "

Represents the configuration that you want MSK to use for the cluster.

", - "ProvisionedRequest$ConfigurationInfo" : "

Represents the configuration that you want MSK to use for the cluster.

", - "MutableClusterInfo$ConfigurationInfo" : "

Information about the changes in the configuration of the brokers.

", - "UpdateClusterConfigurationRequest$ConfigurationInfo" : "

Represents the configuration that you want MSK to use for the cluster.

" - } - }, - "ConfigurationRevision" : { - "base" : "

Describes a configuration revision.

", - "refs" : { - "Configuration$LatestRevision" : "

Latest revision of the configuration.

", - "CreateConfigurationResponse$LatestRevision" : "

Latest revision of the configuration.

", - "DescribeConfigurationResponse$LatestRevision" : "

Latest revision of the configuration.

", - "UpdateConfigurationResponse$LatestRevision" : "

Latest revision of the configuration.

", - "__listOfConfigurationRevision$member" : null - } - }, - "ConfigurationState" : { - "base" : "

The state of a configuration.

", - "refs" : { - "DescribeConfigurationResponse$State" : "

The state of the configuration. The possible states are ACTIVE, DELETING and DELETE_FAILED.

", - "CreateConfigurationResponse$State" : "

The state of the configuration. The possible states are ACTIVE, DELETING and DELETE_FAILED.

", - "DeleteConfigurationResponse$State" : "

The state of the configuration. The possible states are ACTIVE, DELETING and DELETE_FAILED.

" - } - }, - "ConflictException" : { - "base" : "

Returns information about an error.

", - "refs" : { } - }, - "ConnectivityInfo" : { - "base" : "

Information about the broker access configuration.

", - "refs" : { - "BrokerNodeGroupInfo$ConnectivityInfo" : "

Information about the broker access configuration.

", - "MutableClusterInfo$ConnectivityInfo" : "

Information about the broker access configuration.

", - "UpdateConnectivityRequest$ConnectivityInfo" : "

Information about the broker access configuration.

" - } - }, - "BrokerCountUpdateInfo" : { - "base" : "

Describes brokers being changed during a broker count update.

", - "refs" : { - "MutableClusterInfo$BrokerCountUpdateInfo" : "

Describes brokers being changed during a broker count update.

" - } - }, - "ConsumerGroupReplication" : { - "base" : "

Details about consumer group replication.

", - "refs" : { - "ReplicationInfo$ConsumerGroupReplication" : "

Configuration relating to consumer group replication.

", - "ReplicationInfoDescription$ConsumerGroupReplication" : "

Configuration relating to consumer group replication

." - } - }, - "ConsumerGroupOffsetSyncMode" : { - "base" : "

The consumer group offset synchronization mode. With LEGACY, offsets are synchronized when producers write to the source cluster. With ENHANCED, consumer offsets are synchronized regardless of producer location. ENHANCED requires a corresponding replicator that replicates data from the target cluster to the source cluster.

", - "refs" : { - "ConsumerGroupReplication$ConsumerGroupOffsetSyncMode" : "

The consumer group offset synchronization mode. With LEGACY, offsets are synchronized when producers write to the source cluster. With ENHANCED, consumer offsets are synchronized regardless of producer location. ENHANCED requires a corresponding replicator that replicates data from the target cluster to the source cluster.

" - } - }, - "ConsumerGroupReplicationUpdate" : { - "base" : "

Details about consumer group replication.

", - "refs" : { - "UpdateReplicationInfoRequest$ConsumerGroupReplication" : "

Updated consumer group replication information.

" - } - }, - "CreateClusterRequest" : { - "base" : "

Creates a cluster.

", - "refs" : { } - }, - "CreateClusterV2Request" : { - "base" : "

Creates a new Amazon MSK cluster of either the provisioned or the serverless type.

", - "refs" : { } - }, - "CreateClusterResponse" : { - "base" : "

Returns information about the created cluster.

", - "refs" : { } - }, - "CreateClusterV2Response" : { - "base" : "

Returns information about the created cluster of either the provisioned or the serverless type.

", - "refs" : { } - }, - "CreateConfigurationRequest" : { - "base" : "

Request body for CreateConfiguration.

", - "refs" : { } - }, - "CreateConfigurationResponse" : { - "base" : "

Response body for CreateConfiguration

", - "refs" : { } - }, - "CreateReplicatorRequest" : { - "base" : "

Request body for replicator.

", - "refs" : { } - }, - "CreateReplicatorResponse" : { - "base" : "

Returns information about the created replicator.

", - "refs" : { } - }, - "CreateVpcConnectionRequest" : { - "base" : "

Request body for CreateVpcConnection.

", - "refs" : { } - }, - "CreateTopicRequest" : { - "base" : "

Request body for CreateTopic.

", - "refs" : { } - }, - "CreateTopicResponse" : { - "base" : "

Response body for CreateTopic.

", - "refs" : { } - }, - "CreateVpcConnectionResponse" : { - "base" : "

Response body for CreateVpcConnection

", - "refs" : { } - }, - "ControllerNodeInfo" : { - "base" : "

Controller node information.

", - "refs" : { - "NodeInfo$ControllerNodeInfo" : "

The ControllerNodeInfo.

" - } - }, - "CustomerActionStatus" : { - "base" : "

A type of an action required from the customer.

", - "refs" : { - "ClusterInfo$CustomerActionStatus" : "

Determines if there is an action required from the customer.

", - "Provisioned$CustomerActionStatus" : "

Determines if there is an action required from the customer.

" - } - }, - "DeadLetterQueueS3" : { - "base" : "

Configuration of the Amazon S3 bucket where records that fail to deliver are stored.

", - "refs" : { - "IcebergDestinationConfiguration$DeadLetterQueueS3" : "

The Amazon S3 bucket and prefix where MSK writes records that fail to deliver.

", - "S3DestinationConfiguration$DeadLetterQueueS3" : "

The Amazon S3 bucket and prefix where MSK writes records that fail to deliver.

" - } - }, - "DeleteChannelResponse" : { - "base" : "

Returns the channel ARN and the cluster-operation ARN that tracks the asynchronous delete.

", - "refs" : { } - }, - "DeleteClusterResponse" : { - "base" : "

Returns information about the deleted cluster.

", - "refs" : { } - }, - "DeleteClusterPolicyRequest" : { - "base" : "

Request body for DeleteClusterPolicy.

", - "refs" : { } - }, - "DeleteClusterPolicyResponse" : { - "base" : "

Response body for DeleteClusterPolicy.

", - "refs" : { } - }, - "DeleteConfigurationRequest" : { - "base" : "

Request body for DeleteConfiguration.

", - "refs" : { } - }, - "DeleteConfigurationResponse" : { - "base" : "

Response body for DeleteConfiguration.

", - "refs" : { } - }, - "DeleteReplicatorResponse" : { - "base" : "

Returns information about the deleted replicator.

", - "refs" : { } - }, - "DeleteVpcConnectionRequest" : { - "base" : "

Request body for DeleteVpcConnection.

", - "refs" : { } - }, - "DeleteTopicRequest" : { - "base" : "

Request body for DeleteTopic.

", - "refs" : { } - }, - "DeleteTopicResponse" : { - "base" : "

Response body for DeleteTopic.

", - "refs" : { } - }, - "DeleteVpcConnectionResponse" : { - "base" : "

Response body for DeleteVpcConnection.

", - "refs" : { } - }, - "DescribeClusterOperationResponse" : { - "base" : "

Information about a cluster operation.

", - "refs" : { } - }, - "DescribeClusterOperationV2Response" : { - "base" : "

Information about a cluster operation.

", - "refs" : { } - }, - "DescribeClusterResponse" : { - "base" : "

Returns information about a cluster.

", - "refs" : { } - }, - "DescribeClusterV2Response" : { - "base" : "

Returns information about a cluster of either the provisioned or the serverless type.

", - "refs" : { } - }, - "DescribeChannelResponse" : { - "base" : "

Contains the current configuration and state of a channel.

", - "refs" : { } - }, - "DescribeConfigurationResponse" : { - "base" : "

Response body for DescribeConfiguration.

", - "refs" : { } - }, - "DescribeConfigurationRevisionResponse" : { - "base" : "

Response body for DescribeConfigurationRevision.

", - "refs" : { } - }, - "DescribeTopicRequest" : { - "base" : "

Request body for DescribeTopic.

", - "refs" : { } - }, - "DescribeTopicResponse" : { - "base" : "

The response containing details for a topic.

", - "refs" : { } - }, - "DescribeTopicPartitionsRequest" : { - "base" : "

Request body for DescribeTopicPartitions.

", - "refs" : { } - }, - "DescribeTopicPartitionsResponse" : { - "base" : "

The response containing partitions details for a topic.

", - "refs" : { } - }, - "TopicPartitionInfo" : { - "base" : "

Contains information about a topic partition.

", - "refs" : { - "__listOfTopicPartitionInfo$member" : null - } - }, - "TopicInfo" : { - "base" : "

Includes identification info about the topic.

", - "refs" : { - "__listOfTopicInfo$member" : null - } - }, - "DescribeReplicatorResponse" : { - "base" : "

Response body for DescribeReplicator.

", - "refs" : { } - }, - "DescribeVpcConnectionResponse" : { - "base" : "

Response body for DescribeVpcConnection.

", - "refs" : { } - }, - "DestinationTable" : { - "base" : "

Configuration of an Apache Iceberg destination table.

", - "refs" : { - "__listOfDestinationTable$member" : null - } - }, - "BatchDisassociateScramSecretRequest" : { - "base" : "

Request body for BatchDisassociateScramSecret.

", - "refs" : { } - }, - "BatchDisassociateScramSecretResponse" : { - "base" : "

Response body for BatchDisassociateScramSecret.

", - "refs" : { } - }, - "EBSStorageInfo" : { - "base" : "

Contains information about the EBS storage volumes attached to Apache Kafka broker nodes.

", - "refs" : { - "StorageInfo$EbsStorageInfo" : "

EBS volume information.

" - } - }, - "EncryptionAtRest" : { - "base" : "

The data-volume encryption details.

", - "refs" : { - "EncryptionInfo$EncryptionAtRest" : "

The data-volume encryption details.

" - } - }, - "EncryptionInTransit" : { - "base" : "

The settings for encrypting data in transit.

", - "refs" : { - "EncryptionInfo$EncryptionInTransit" : "

The details for encryption in transit.

" - } - }, - "EncryptionConfiguration" : { - "base" : "

The AWS KMS encryption configuration applied to data at rest.

", - "refs" : { - "CreateChannelRequest$EncryptionConfiguration" : "

The encryption configuration applied to the channel.

", - "DescribeChannelResponse$EncryptionConfiguration" : "

The encryption configuration applied to the channel.

" - } - }, - "EncryptionInfo" : { - "base" : "

Includes encryption-related information, such as the AWS KMS key used for encrypting data at rest and whether you want MSK to encrypt your data in transit.

", - "refs" : { - "ClusterInfo$EncryptionInfo" : "

Includes all encryption-related information.

", - "Provisioned$EncryptionInfo" : "

Includes all encryption-related information.

", - "CreateClusterRequest$EncryptionInfo" : "

Includes all encryption-related information.

", - "ProvisionedRequest$EncryptionInfo" : "

Includes all encryption-related information.

", - "MutableClusterInfo$EncryptionInfo" : "

Includes all encryption-related information.

", - "UpdateSecurityRequest$EncryptionInfo" : "

Includes all encryption-related information.

" - } - }, - "EnhancedMonitoring" : { - "base" : "

Specifies which metrics are gathered for the MSK cluster. This property has the following possible values: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. For a list of the metrics associated with each of these levels of monitoring, see Monitoring.

", - "refs" : { - "ClusterInfo$EnhancedMonitoring" : "

Specifies which metrics are gathered for the MSK cluster. This property has the following possible values: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. For a list of the metrics associated with each of these levels of monitoring, see Monitoring.

", - "Provisioned$EnhancedMonitoring" : "

Specifies which metrics are gathered for the MSK cluster. This property has the following possible values: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. For a list of the metrics associated with each of these levels of monitoring, see Monitoring.

", - "CreateClusterRequest$EnhancedMonitoring" : "

Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.

", - "ProvisionedRequest$EnhancedMonitoring" : "

Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.

", - "MutableClusterInfo$EnhancedMonitoring" : "

Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.

", - "UpdateMonitoringRequest$EnhancedMonitoring" : "

Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.

" - } - }, - "Error" : { - "base" : "

Returns information about an error.

", - "refs" : { } - }, - "ErrorInfo" : { - "base" : "

Returns information about an error state of the cluster.

", - "refs" : { - "ClusterOperationInfo$ErrorInfo" : "

Describes the error if the operation fails.

" - } - }, - "Firehose" : { - "base" : "

Firehose details for logs.

", - "refs" : { - "BrokerLogs$Firehose" : "

Details of the Kinesis Data Firehose delivery stream that is the destination for broker logs.

", - "ChannelLoggingInfo$Firehose": "

Details of the Kinesis Data Firehose delivery stream that is the destination for Channel logs.

" - } - }, - "ForbiddenException" : { - "base" : "

Returns information about an error.

", - "refs" : { } - }, - "GetBootstrapBrokersResponse" : { - "base" : "

Returns a string containing one or more hostname:port pairs.

", - "refs" : { } - }, - "GetCompatibleKafkaVersionsResponse" : { - "base" : "

Response body for GetCompatibleKafkaVersions.

", - "refs" : { } - }, - "GetClusterPolicyRequest" : { - "base" : "

Request body for GetClusterPolicy.

", - "refs" : { } - }, - "GetClusterPolicyResponse" : { - "base" : "

Returns information about the specified cluster policy.

", - "refs" : { } - }, - "IcebergDestinationConfiguration" : { - "base" : "

Configuration of an Apache Iceberg destination for a channel.

", - "refs" : { - "CreateChannelRequest$IcebergDestinationConfiguration" : "

The Apache Iceberg destination for the channel. Mutually exclusive with s3DestinationConfiguration.

", - "DescribeChannelResponse$IcebergDestinationConfiguration" : "

The Apache Iceberg destination for the channel, if configured.

" - } - }, - "InternalServerErrorException" : { - "base" : "

Returns information about an error.

", - "refs" : { } - }, - "JmxExporter" : { - "base" : "

Indicates whether you want to enable or disable the JMX Exporter.

", - "refs" : { - "Prometheus$JmxExporter" : "

Indicates whether you want to enable or disable the JMX Exporter.

" - } - }, - "JmxExporterInfo" : { - "base" : "

Indicates whether you want to enable or disable the JMX Exporter.

", - "refs" : { - "PrometheusInfo$JmxExporter" : "

JMX Exporter settings.

" - } - }, - "KafkaCluster" : { - "base" : "

Information about Kafka Cluster to be used as source / target for replication.

", - "refs" : { - "__listOfKafkaCluster$member" : null - } - }, - "KafkaClusterClientVpcConfig" : { - "base" : null, - "refs" : { - "KafkaCluster$VpcConfig" : "

Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.

", - "KafkaClusterDescription$VpcConfig" : "

Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.

" - } - }, - "KafkaClusterClientAuthentication" : { - "base" : "

Details of the client authentication used by the Apache Kafka cluster.

", - "refs" : { - "KafkaCluster$ClientAuthentication" : "

Details of the client authentication used by the Apache Kafka cluster.

", - "KafkaClusterDescription$ClientAuthentication" : "

Details of the client authentication used by the Apache Kafka cluster.

" - } - }, - "KafkaClusterSaslScramAuthentication" : { - "base" : "

Details for SASL/SCRAM client authentication.

", - "refs" : { - "KafkaClusterClientAuthentication$SaslScram" : "

Details for SASL/SCRAM client authentication.

" - } - }, - "KafkaClusterMTLSAuthentication" : { - "base" : "

Details for mTLS client authentication.

", - "refs" : { - "KafkaClusterClientAuthentication$MTLS" : "

Details for mTLS client authentication.

" - } - }, - "KafkaClusterSaslScramMechanism" : { - "base" : "

The SASL/SCRAM authentication mechanism.

", - "refs" : { - "KafkaClusterSaslScramAuthentication$Mechanism" : "

The SASL/SCRAM authentication mechanism.

" - } - }, - "KafkaClusterEncryptionInTransit" : { - "base" : "

Details of encryption in transit to the Apache Kafka cluster.

", - "refs" : { - "KafkaCluster$EncryptionInTransit" : "

Details of encryption in transit to the Apache Kafka cluster.

", - "KafkaClusterDescription$EncryptionInTransit" : "

Details of encryption in transit to the Apache Kafka cluster.

" - } - }, - "KafkaClusterEncryptionInTransitType" : { - "base" : "

The type of encryption in transit to the Apache Kafka cluster.

", - "refs" : { - "KafkaClusterEncryptionInTransit$EncryptionType" : "

The type of encryption in transit to the Apache Kafka cluster.

" - } - }, - "KafkaClusterDescription" : { - "base" : "

Information about Kafka Cluster used as source / target for replication.

", - "refs" : { - "__listOfKafkaClusterDescription$member" : null - } - }, - "KafkaClusterSummary" : { - "base" : "

Summarized information about Kafka Cluster used as source / target for replication.

", - "refs" : { - "__listOfKafkaClusterSummary$member" : null - } - }, - "KafkaVersion" : { - "base" : "

Information about a Apache Kafka version.

", - "refs" : { - "__listOfKafkaVersion$member" : null - } - }, - "KafkaVersionStatus" : { - "base" : "

The status of a Apache Kafka version.

", - "refs" : { - "KafkaVersion$Status" : "

The status of the Apache Kafka version.

" - } - }, - "ListClusterOperationsResponse" : { - "base" : "

The response contains an array containing cluster operation information and a next token if the response is truncated.

", - "refs" : { } - }, - "ListClusterOperationsV2Response" : { - "base" : "

The response contains an array containing cluster operation information and a next token if the response is truncated.

", - "refs" : { } - }, - "ListClustersResponse" : { - "base" : "

The response contains an array containing cluster information and a next token if the response is truncated.

", - "refs" : { } - }, - "ListClustersV2Response" : { - "base" : "

The response contains an array containing cluster information and a next token if the response is truncated.

", - "refs" : { } - }, - "ListConfigurationRevisionsResponse" : { - "base" : "

Information about revisions of an MSK configuration.

", - "refs" : { } - }, - "ListConfigurationsResponse" : { - "base" : "

The response contains an array of Configuration and a next token if the response is truncated.

", - "refs" : { } - }, - "ListKafkaVersionsResponse" : { - "base" : "

Response for ListKafkaVersions.

", - "refs" : { } - }, - "ListNodesResponse" : { - "base" : "

Information about nodes in the cluster.

", - "refs" : { } - }, - "ListReplicatorsResponse" : { - "base" : "

The response contains an array containing replicator information and a NextToken if the response is truncated.

", - "refs" : { } - }, - "ListScramSecretsResponse" : { - "base" : "

Information about scram secrets associated to the cluster.

", - "refs" : { } - }, - "ListTagsForResourceResponse" : { - "base" : "

Response of listing tags for a resource.

", - "refs" : { } - }, - "ListClientVpcConnectionsRequest" : { - "base" : "

Request body for ListClientVpcConnections.

", - "refs" : { } - }, - "ListChannelsResponse" : { - "base" : "

Returns the list of channels in the cluster.

", - "refs" : { } - }, - "ListClientVpcConnectionsResponse" : { - "base" : "

The response contains an array of client VPC connections and a next token if the response is truncated.

", - "refs" : { } - }, - "ListTopicsRequest" : { - "base" : "

Request body for ListTopics.

", - "refs" : { } - }, - "ListTopicsResponse" : { - "base" : "

The response contains an array of topics on a MSK Cluster.

", - "refs" : { } - }, - "ListVpcConnectionsRequest" : { - "base" : "

Request body for ListVpcConnections.

", - "refs" : { } - }, - "ListVpcConnectionsResponse" : { - "base" : "

The response contains an array of MSK VPC connections and a next token if the response is truncated.

", - "refs" : { } - }, - "RejectClientVpcConnectionRequest" : { - "base" : "

Request body for RejectClientVpcConnection.

", - "refs" : { } - }, - "RejectClientVpcConnectionResponse" : { - "base" : "

Response body for RejectClientVpcConnection.

", - "refs" : { } - }, - "LoggingInfo" : { - "base" : "

You can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.

", - "refs" : { - "ClusterInfo$LoggingInfo" : "

You can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.

", - "Provisioned$LoggingInfo" : "

You can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.

", - "CreateClusterRequest$LoggingInfo" : "

LoggingInfo details.

", - "ProvisionedRequest$LoggingInfo" : "

LoggingInfo details.

", - "MutableClusterInfo$LoggingInfo" : "

LoggingInfo details.

", - "UpdateMonitoringRequest$LoggingInfo" : "

LoggingInfo details.

" - } - }, - "ChannelLoggingInfo" : { - "base" : "

Configuration for the destinations to which the channel publishes operational logs.

", - "refs" : { - "CreateChannelRequest$LoggingInfo" : "

The destinations to which the channel publishes operational logs.

", - "DescribeChannelResponse$LoggingInfo" : "

The destinations to which the channel publishes operational logs.

" - } - }, - "MutableClusterInfo" : { - "base" : "

Information about cluster attributes that can be updated via update APIs.

", - "refs" : { - "ClusterOperationInfo$SourceClusterInfo" : "

Information about cluster attributes before a cluster is updated.

", - "ClusterOperationInfo$TargetClusterInfo" : "

Information about cluster attributes after a cluster is updated.

" - } - }, - "NodeExporter" : { - "base" : "

Indicates whether you want to enable or disable the Node Exporter.

", - "refs" : { - "Prometheus$NodeExporter" : "

Indicates whether you want to enable or disable the Node Exporter.

" - } - }, - "NodeExporterInfo" : { - "base" : "

Indicates whether you want to enable or disable the Node Exporter.

", - "refs" : { - "PrometheusInfo$NodeExporter" : "

Node Exporter settings.

" - } - }, - "NodeInfo" : { - "base" : "

The node information object.

", - "refs" : { - "__listOfNodeInfo$member" : null - } - }, - "NetworkType" : { - "base" : "

The network type of the cluster, which is IPv4 or DUAL. The DUAL network type uses both IPv4 and IPv6 addresses for your cluster and its resources.

By default, a cluster uses the IPv4 network type.

", - "refs" : { - "ConnectivityInfo$NetworkType" : "

The network type of the cluster, which is IPv4 or DUAL. The DUAL network type uses both IPv4 and IPv6 addresses for your cluster and its resources.

By default, a cluster uses the IPv4 network type.

" - } - }, - "ZookeeperAccess" : { - "base" : "

Access control settings for zookeeper

", - "refs" : { - "UpdateConnectivityRequest$ZookeeperAccess" : "

Access control settings for zookeeper

", - "MutableClusterInfo$ZookeeperAccess" : "

Access control settings for zookeeper

" - } - }, - "NodeType" : { - "base" : "

The broker or Zookeeper node.

", - "refs" : { - "NodeInfo$NodeType" : "

The node type.

" - } - }, - "NotFoundException" : { - "base" : "

Returns information about an error.

", - "refs" : { } - }, - "OpenMonitoring" : { - "base" : "

JMX and Node monitoring for the MSK cluster.

", - "refs" : { - "ClusterInfo$OpenMonitoring" : "

Settings for open monitoring using Prometheus.

", - "Provisioned$OpenMonitoring" : "

Settings for open monitoring using Prometheus.

", - "MutableClusterInfo$OpenMonitoring" : "

Settings for open monitoring using Prometheus.

" - } - }, - "OpenMonitoringInfo" : { - "base" : "

JMX and Node monitoring for the MSK cluster.

", - "refs" : { - "CreateClusterRequest$OpenMonitoring" : "

The settings for open monitoring.

", - "ProvisionedRequest$OpenMonitoring" : "

The settings for open monitoring.

", - "UpdateMonitoringRequest$OpenMonitoring" : "

The settings for open monitoring.

" - } - }, - "PartitionSource" : { - "base" : "

A source column used by an Apache Iceberg destination table's partition specification.

", - "refs" : { - "__listOfPartitionSource$member" : null - } - }, - "PartitionSpec" : { - "base" : "

Partition specification for an Apache Iceberg destination table.

", - "refs" : { - "DestinationTable$PartitionSpec" : "

The partition specification for the destination table.

" - } - }, - "PartitionStrategy" : { - "base" : "

The partitioning strategy used to partition records in the destination Apache Iceberg table.

", - "refs" : { - "PartitionSpec$PartitionStrategy" : "

The partitioning strategy applied to records written to the table.

" - } - }, - "Prometheus" : { - "base" : "

Prometheus settings for open monitoring.

", - "refs" : { - "OpenMonitoring$Prometheus" : "

Prometheus settings.

" - } - }, - "PrometheusInfo" : { - "base" : "

Prometheus settings.

", - "refs" : { - "OpenMonitoringInfo$Prometheus" : "

Prometheus settings.

" - } - }, - "ProvisionedThroughput" : { - "base" : "

Contains information about provisioned throughput for EBS storage volumes attached to kafka broker nodes.

", - "refs" : { - "BrokerEBSVolumeInfo$ProvisionedThroughput" : "

EBS volume provisioned throughput information.

", - "EBSStorageInfo$ProvisionedThroughput" : "

EBS volume provisioned throughput information.

", - "UpdateStorageRequest$ProvisionedThroughput" : "

EBS volume provisioned throughput information.

" - } - }, - "PublicAccess" : { - "base" : "

Broker public access control.

", - "refs" : { - "ConnectivityInfo$PublicAccess" : "

Public access control for brokers.

" - } - }, - "PutClusterPolicyRequest" : { - "base" : "

Request body for PutClusterPolicy.

", - "refs" : { } - }, - "PutClusterPolicyResponse" : { - "base" : "

Response body for PutClusterPolicy.

", - "refs" : { } - }, - "RebootBrokerRequest" : { - "base" : "

Request body for RebootBrokerNode action.

", - "refs" : { } - }, - "RebootBrokerResponse" : { - "base" : "

Response body for RebootBrokers action.

", - "refs" : { } - }, - "RecordConverter" : { - "base" : "

Configuration that controls how Apache Kafka record values are deserialized for the destination.

", - "refs" : { - "TopicConfiguration$RecordConverter" : "

Configuration that controls how Apache Kafka record values are deserialized for the destination.

" - } - }, - "RecordSchema" : { - "base" : "

Schema configuration that controls how Apache Kafka record values are validated.

", - "refs" : { - "TopicConfiguration$RecordSchema" : "

The schema used to validate records when the value converter requires one (for example, JSON_SCHEMA_GSR).

" - } - }, - "ReplicationInfo" : { - "base" : "

Specifies configuration for replication between a source and target Kafka cluster.

", - "refs" : { - "__listOfReplicationInfo$member" : null - } - }, - "ReplicationInfoDescription" : { - "base" : "

Specifies configuration for replication between a source and target Kafka cluster (sourceKafkaClusterAlias -> targetKafkaClusterAlias)

", - "refs" : { - "__listOfReplicationInfoDescription$member" : null - } - }, - "ReplicationInfoSummary" : { - "base" : "

Summarized information of replication between clusters.

", - "refs" : { - "__listOfReplicationInfoSummary$member" : null - } - }, - "ReplicationStartingPosition" : { - "base" : "

Configuration for specifying the position in the topics to start replicating from.

", - "refs" : { - "TopicReplication$StartingPosition" : "

Configuration for specifying the position in the topics to start replicating from.

" - } - }, - "ReplicationStartingPositionType" : { - "base" : "

The type of replication starting position.

", - "refs" : { - "ReplicationStartingPosition$Type" : "

The type of replication starting position.

" - } - }, - "ReplicationTopicNameConfiguration" : { - "base" : "

Configuration for specifying replicated topic names should be the same as their corresponding upstream topics or prefixed with source cluster alias.

", - "refs" : { - "TopicReplication$TopicNameConfiguration" : "

Configuration for specifying replicated topic names same as their corresponding upstream topics or prefixed with source cluster alias.

" - } - }, - "ReplicationTopicNameConfigurationType" : { - "base" : "

The type of replicated topic name.

", - "refs" : { - "ReplicationTopicNameConfiguration$Type" : "

The type of replicated topic name.

" - } - }, - "ReplicatorCloudWatchLogs" : { - "base" : "

Details of the CloudWatch Logs destination for replicator logs.

", - "refs" : { - "ReplicatorLogDelivery$CloudWatchLogs" : "

Details of the CloudWatch Logs destination for replicator logs.

" - } - }, - "ReplicatorFirehose" : { - "base" : "

Details of the Kinesis Data Firehose delivery stream that is the destination for replicator logs.

", - "refs" : { - "ReplicatorLogDelivery$Firehose" : "

Details of the Kinesis Data Firehose delivery stream that is the destination for replicator logs.

" - } - }, - "LogDelivery" : { - "base" : "

Configuration for log delivery for the replicator.

", - "refs" : { - "CreateReplicatorRequest$LogDelivery" : "

Configuration for delivering replicator logs to customer destinations.

", - "DescribeReplicatorResponse$LogDelivery" : "

Configuration for log delivery for the replicator.

", - "UpdateReplicationInfoRequest$LogDelivery" : "

Configuration for delivering replicator logs to customer destinations.

" - } - }, - "ReplicatorLogDelivery" : { - "base" : "

Details of the log delivery for the replicator.

", - "refs" : { - "LogDelivery$ReplicatorLogDelivery" : "

The replicator logs configuration for this MSK replicator.

" - } - }, - "ReplicatorS3" : { - "base" : "

Details of the Amazon S3 destination for replicator logs.

", - "refs" : { - "ReplicatorLogDelivery$S3" : "

Details of the Amazon S3 destination for replicator logs.

" - } - }, - "ReplicationStateInfo" : { - "base" : "Details about the state of a replicator", - "refs" : { - "DescribeReplicatorResponse$StateInfo" : "Details about the state of the replicator." - } - }, - "ReplicatorState" : { - "base" : "

The state of a replicator.

", - "refs" : { - "CreateReplicatorResponse$ReplicatorState" : "

State of the replicator.

", - "DeleteReplicatorResponse$ReplicatorState" : "

The state of the replicator.

", - "DescribeReplicatorResponse$ReplicatorState" : "

State of the replicator.

", - "ReplicatorSummary$ReplicatorState" : "

State of the replicator.

", - "UpdateReplicationInfoResponse$ReplicatorState" : "

State of the replicator.

" - } - }, - "ReplicatorSummary" : { - "base" : "

Information about a replicator.

", - "refs" : { - "__listOfReplicatorSummary$member" : null - } - }, - "S3" : { - "base" : "

The details of the Amazon S3 destination for logs.

", - "refs" : { - "BrokerLogs$S3" : "

Details of the Amazon S3 destination for broker logs.

", - "ChannelLoggingInfo$S3": "

Details of the Amazon S3 destination for Channel logs.

" - } - }, - "ServiceUnavailableException" : { - "base" : "

Returns information about an error.

", - "refs" : { } - }, - "StateInfo" : { - "base" : "

Contains information about the state of the Amazon MSK cluster.

", - "refs" : { - "ClusterInfo$StateInfo" : "

Contains information about the state of the Amazon MSK cluster.

" - } - }, - "StorageInfo" : { - "base" : "

Contains information about storage volumes attached to MSK broker nodes.

", - "refs" : { - "BrokerNodeGroupInfo$StorageInfo" : "

Contains information about storage volumes attached to MSK broker nodes.

" - } - }, - "StorageMode" : { - "base" : "

Controls storage mode for various supported storage tiers.

", - "refs" : { - "Provisioned$StorageMode" : "

This controls storage mode for supported storage tiers.

", - "ProvisionedRequest$StorageMode" : "

This controls storage mode for supported storage tiers.

", - "ClusterInfo$StorageMode" : "

This controls storage mode for supported storage tiers.

", - "CreateClusterRequest$StorageMode" : "

This controls storage mode for supported storage tiers.

", - "MutableClusterInfo$StorageMode" : "

This controls storage mode for supported storage tiers.

", - "UpdateStorageRequest$StorageMode" : "

Controls storage mode for supported storage tiers.

" - } - }, - "TagResourceRequest" : { - "base" : "

Tag a resource.

", - "refs" : { } - }, - "TableCreation" : { - "base" : "

Configuration controlling whether MSK creates the destination Apache Iceberg table if it does not already exist.

", - "refs" : { - "IcebergDestinationConfiguration$TableCreation" : "

Configuration controlling whether MSK creates the destination table if it does not already exist.

" - } - }, - "TargetCompressionType" : { - "base" : "

The type of compression to use producing records to the target cluster.

", - "refs" : { - "ReplicationInfo$TargetCompressionType" : "

The compression type to use when producing records to target cluster.

", - "ReplicationInfoDescription$TargetCompressionType" : "

The compression type to use when producing records to target cluster.

" - } - }, - "TopicConfiguration" : { - "base" : "

Configuration of an Apache Kafka topic that feeds a channel.

", - "refs" : { - "__listOfTopicConfiguration$member" : null - } - }, - "TopicReplication" : { - "base" : "

Details about topic replication.

", - "refs" : { - "ReplicationInfo$TopicReplication" : "

Configuration relating to topic replication.

", - "ReplicationInfoDescription$TopicReplication" : "

Configuration relating to topic replication.

" - } - }, - "TopicReplicationUpdate" : { - "base" : "

Details for updating the topic replication of a replicator.

", - "refs" : { - "UpdateReplicationInfoRequest$TopicReplication" : "

Updated topic replication information.

" - } - }, - "Tls" : { - "base" : "

Details for client authentication using TLS.

", - "refs" : { - "ClientAuthentication$Tls" : "

Details for ClientAuthentication using TLS.

" - } - }, - "TooManyRequestsException" : { - "base" : "

Returns information about an error.

", - "refs" : { } - }, - "TopicExistsException": { - "base": "

Returns information about an error.

", - "refs": { } - }, - "ClusterConnectivityException": { - "base": "

Returns information about an error.

", - "refs": { } - }, - "KafkaTimeoutException": { - "base": "

Returns information about an error.

", - "refs": { } - }, - "UnknownTopicOrPartitionException": { - "base": "

Returns information about an error.

", - "refs": { } - }, - "ControllerMovedException": { - "base": "

Returns information about an error.

", - "refs": { } - }, - "NotControllerException": { - "base": "

Returns information about an error.

", - "refs": { } - }, - "ReassignmentInProgressException": { - "base": "

Returns information about an error.

", - "refs": { } - }, - "GroupSubscribedToTopicException": { - "base": "

Returns information about an error.

", - "refs": { } - }, - "KafkaRequestException": { - "base": "

Returns information about an error.

", - "refs": { } - }, - "Unauthenticated" : { - "base" : "

Contains information about unauthenticated traffic to the cluster.

", - "refs" : { - "ClientAuthentication$Unauthenticated" : "

Contains information about unauthenticated traffic to the cluster.

" - } - }, - "UnauthorizedException" : { - "base" : "

Returns information about an error.

", - "refs" : { } - }, - "UpdateBrokerCountRequest" : { - "base" : "

Request body for UpdateBrokerCount.

", - "refs" : { } - }, - "UpdateBrokerCountResponse" : { - "base" : "

Response body for UpdateBrokerCount.

", - "refs" : { } - }, - "UpdateBrokerTypeRequest" : { - "base" : "

Request body for UpdateBrokerType.

", - "refs" : { } - }, - "UpdateBrokerTypeResponse" : { - "base" : "

Response body for UpdateBrokerType.

", - "refs" : { } - }, - "UpdateBrokerStorageRequest" : { - "base" : "

Request object for UpdateBrokerStorage.

", - "refs" : { } - }, - "UpdateBrokerStorageResponse" : { - "base" : "

Response body for UpdateBrokerStorage.

", - "refs" : { } - }, - "UpdateConfigurationRequest" : { - "base" : "

Request body for UpdateConfiguration.

", - "refs" : { } - }, - "UpdateConfigurationResponse" : { - "base" : "

Response body for UpdateConfiguration.

", - "refs" : { } - }, - "UpdateConnectivityRequest" : { - "base" : "

Request body for UpdateConnectivity.

", - "refs" : { } - }, - "UpdateConnectivityResponse" : { - "base" : "

Response body for UpdateConnectivity.

", - "refs" : { } - }, - "S3CompressionType" : { - "base" : "

The compression codec applied to delivered Amazon S3 objects.

", - "refs" : { - "S3Storage$CompressionType" : "

The compression codec applied to delivered Amazon S3 objects.

" - } - }, - "IcebergCompressionType" : { - "base" : "

Compression codec for Iceberg table data files. Defaults to ZSTD.

", - "refs" : { - "IcebergDestinationConfiguration$CompressionType" : "

The compression codec for Iceberg table data files. Defaults to ZSTD.

" - } - }, - "S3DestinationConfiguration" : { - "base" : "

Configuration of an Amazon S3 destination for a channel.

", - "refs" : { - "CreateChannelRequest$S3DestinationConfiguration" : "

The Amazon S3 destination for the channel. Mutually exclusive with icebergDestinationConfiguration.

", - "DescribeChannelResponse$S3DestinationConfiguration" : "

The Amazon S3 destination for the channel, if configured.

" - } - }, - "IcebergDestinationUpdate" : { - "base" : "

Update payload for an Apache Iceberg destination.

", - "refs" : { - "UpdateChannelRequest$IcebergDestinationUpdate" : "

Updates fields on an Apache Iceberg destination. Use only when the channel was created with an Iceberg destination.

" - } - }, - "S3DestinationUpdate" : { - "base" : "

Update payload for an Amazon S3 destination.

", - "refs" : { - "UpdateChannelRequest$S3DestinationUpdate" : "

Updates fields on an Amazon S3 destination. Use only when the channel was created with an Amazon S3 destination.

" - } - }, - "S3Storage" : { - "base" : "

Storage configuration for an Amazon S3 destination bucket.

", - "refs" : { - "S3DestinationConfiguration$Storage" : "

The Amazon S3 bucket, prefix, and storage class for delivered records.

" - } - }, - "S3StorageClass" : { - "base" : "

The Amazon S3 storage class applied to delivered objects.

", - "refs" : { - "S3Storage$StorageClass" : "

The Amazon S3 storage class for delivered objects.

" - } - }, - "UpdateChannelRequest" : { - "base" : "

Updates an existing channel's destination configuration. You must update the same destination type the channel was created with; the destination type cannot be changed.

", - "refs" : { } - }, - "UpdateChannelResponse" : { - "base" : "

Returns the channel ARN and the cluster-operation ARN that tracks the asynchronous update.

", - "refs" : { } - }, - "UpdateClusterConfigurationRequest" : { - "base" : "

Request body for UpdateClusterConfiguration.

", - "refs" : { } - }, - "UpdateClusterConfigurationResponse" : { - "base" : "

Response body for UpdateClusterConfiguration.

", - "refs" : { } - }, - "UpdateClusterKafkaVersionRequest" : { - "base" : "

Request body for UpdateClusterKafkaVersion.

", - "refs" : { } - }, - "UpdateClusterKafkaVersionResponse" : { - "base" : "

Response body for UpdateClusterKafkaVersion.

", - "refs" : { } - }, - "UpdateMonitoringRequest" : { - "base" : "

Request body for UpdateMonitoring.

", - "refs" : { } - }, - "UpdateMonitoringResponse" : { - "base" : "

Response body for UpdateMonitoring.

", - "refs" : { } - }, - "UpdateRebalancingRequest" : { - "base" : "

Request body for UpdateRebalancing.

", - "refs" : { } - }, - "UpdateRebalancingResponse" : { - "base" : "

Response body for UpdateRebalancing.

", - "refs" : { } - }, - "UpdateReplicationInfoRequest" : { - "base" : "

Parameters for updating replication information between source and target Kafka clusters of a replicator.

", - "refs" : { } - }, - "UpdateReplicationInfoResponse" : { - "base" : "

Updated Replication information of a replicator.

", - "refs" : { } - }, - "UpdateSecurityRequest" : { - "base" : "

Request body for UpdateSecurity.

", - "refs" : { } - }, - "UpdateSecurityResponse" : { - "base" : "

Response body for UpdateSecurity.

", - "refs" : { } - }, - "UpdateStorageRequest" : { - "base" : "

Request object for UpdateStorageApi.

", - "refs" : { } - }, - "UpdateStorageResponse" : { - "base" : "

Response body for UpdateStorageResponse Api.

", - "refs" : { } - }, - "UpdateTopicRequest" : { - "base" : "

Request body for UpdateTopic.

", - "refs" : { } - }, - "UpdateTopicResponse" : { - "base" : "

Response body for UpdateTopic.

", - "refs" : { } - }, - "UserIdentity" : { - "base" : "

Description of the requester that calls the API operation.

", - "refs" : { - "VpcConnectionInfo$UserIdentity" : "

Description of the requester that calls the API operation.

" - } - }, - "UserIdentityType" : { - "base" : "

The identity type of the requester that calls the API operation.

", - "refs" : { - "UserIdentity$Type" : "

The identity type of the requester that calls the API operation.

" - } - }, - "ZookeeperNodeInfo" : { - "base" : "

Zookeeper node information.

", - "refs" : { - "NodeInfo$ZookeeperNodeInfo" : "

The ZookeeperNodeInfo.

" - } - }, - "VpcConfig" : { - "base" : "

The configuration of the Amazon VPCs for the cluster.

", - "refs" : { } - }, - "ValueConverter" : { - "base" : "

The deserialization format applied to Apache Kafka record values.

", - "refs" : { - "RecordConverter$ValueConverter" : "

The deserialization format applied to Apache Kafka record values.

" - } - }, - "VpcConnectivity" : { - "base" : "

Broker VPC connectivity access control.

", - "refs" : { - "ConnectivityInfo$VpcConnectivity" : "

VpcConnectivity control for brokers.

" - } - }, - "ClientVpcConnection" : { - "base" : "

The client VPC connection object.

", - "refs" : { - "__listOfClientVpcConnections$member" : null - } - }, - "VpcConnection" : { - "base" : "

The VPC connection object.

", - "refs" : { - "__listOfVpcConnections$member" : null - } - }, - "VpcConnectionInfo" : { - "base" : "

Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.

", - "refs" : { - "ClusterOperationInfo$VpcConnectionInfo" : "

Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.

" - } - }, - "VpcConnectionInfoServerless" : { - "base" : "

Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.

", - "refs" : { - "ClusterOperationV2Serverless$VpcConnectionInfo" : "

Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.

" - } - }, - "VpcConnectionState" : { - "base" : "

The state of a configuration.

", - "refs" : { - "DescribeVpcConnectionResponse$State" : "

The state of the VPC connection. The possible states are AVAILABLE, INACTIVE, DEACTIVATING, DELETING, CREATING, REJECTING, REJECTED and FAILED.

", - "CreateVpcConnectionResponse$State" : "

The state of the VPC connection. The only possible state is CREATING.

", - "DeleteVpcConnectionResponse$State" : "

The state of the VPC connection. The only possible state is DELETING.

" - } - }, - "__boolean" : { - "base" : null, - "refs" : { - "CloudWatchLogs$Enabled" : "

Specifies whether broker logs get sent to the specified CloudWatch Logs destination.

", - "ConsumerGroupReplication$DetectAndCopyNewConsumerGroups" : "

Enables synchronization of consumer groups to target cluster.

", - "ConsumerGroupReplication$SynchroniseConsumerGroupOffsets" : "

Enables synchronization of consumer group offsets to target cluster. The translated offsets will be written to topic __consumer_offsets.

", - "ConsumerGroupReplicationUpdate$DetectAndCopyNewConsumerGroups" : "

Enables synchronization of consumer groups to target cluster.

", - "ConsumerGroupReplicationUpdate$SynchroniseConsumerGroupOffsets" : "

Enables synchronization of consumer group offsets to target cluster. The translated offsets will be written to topic __consumer_offsets.

", - "DescribeReplicatorResponse$IsReplicatorReference" : "

Whether this resource is a replicator reference.

", - "EncryptionInTransit$InCluster" : "

When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.

The default value is true.

", - "Firehose$Enabled" : "

Specifies whether broker logs get sent to the specified Kinesis Data Firehose delivery stream.

", - "ReplicatorCloudWatchLogs$Enabled" : "

Specifies whether broker logs get sent to the specified CloudWatch Logs destination for replication.

", - "ReplicatorFirehose$Enabled" : "

Specifies whether broker logs get sent to the specified Kinesis Data Firehose delivery stream for replication.

", - "ReplicatorS3$Enabled" : "

Specifies whether broker logs get sent to the specified Amazon S3 destination for replication.

", - "IAM$Enabled" : "

IAM authentication is enabled or not.

", - "IcebergDestinationConfiguration$AppendOnly" : "

Whether the destination is append-only. Must be true; updates and deletes are not supported.

", - "JmxExporter$EnabledInBroker" : "

Indicates whether you want to enable or disable the JMX Exporter.

", - "JmxExporterInfo$EnabledInBroker" : "

JMX Exporter being enabled in broker.

", - "NodeExporter$EnabledInBroker" : "

Indicates whether you want to enable or disable the Node Exporter.

", - "NodeExporterInfo$EnabledInBroker" : "

Node Exporter being enabled in broker.

", - "ProvisionedThroughput$Enabled" : "

Provisioned throughput is enabled or not.

", - "ReplicatorSummary$IsReplicatorReference" : "

Whether this resource is a replicator reference.

", - "S3$Enabled" : "

Specifies whether broker logs get sent to the specified Amazon S3 destination.

", - "SchemaEvolution$EnableSchemaEvolution" : "

Whether to allow MSK to evolve the destination table's schema. Must be false for the current release.

", - "Scram$Enabled" : "

SASL/SCRAM authentication is enabled or not.

", - "Tls$Enabled" : "

TLS authentication is enabled or not.

", - "TableCreation$EnableTableCreation" : "

Whether MSK creates the destination table on the customer's behalf. Must be true for the current release.

", - "TopicReplication$CopyAccessControlListsForTopics" : "

Whether to periodically configure remote topic ACLs to match their corresponding upstream topics.

", - "TopicReplication$CopyTopicConfigurations" : "

Whether to periodically configure remote topics to match their corresponding upstream topics.

", - "TopicReplication$DetectAndCopyNewTopics" : "

Whether to periodically check for new topics and partitions.

", - "TopicReplicationUpdate$CopyAccessControlListsForTopics" : "

Whether to periodically configure remote topic ACLs to match their corresponding upstream topics.

", - "TopicReplicationUpdate$CopyTopicConfigurations" : "

Whether to periodically configure remote topics to match their corresponding upstream topics.

", - "TopicReplicationUpdate$DetectAndCopyNewTopics" : "

Whether to periodically check for new topics and partitions.

", - "Unauthenticated$Enabled" : "

Specifies whether you want to enable or disable unauthenticated traffic to your cluster.

", - "VpcConnectivityIAM$Enabled" : "

SASL/IAM authentication for VPC connectivity is on or off.

", - "VpcConnectivityScram$Enabled" : "

SASL/SCRAM authentication for VPC connectivity is on or off.

", - "VpcConnectivityTls$Enabled" : "

TLS authentication for VPC connectivity is on or off.

" - } - }, - "__double" : { - "base" : null, - "refs" : { - "BrokerNodeInfo$BrokerId" : "

The ID of the broker.

", - "ZookeeperNodeInfo$ZookeeperId" : "

The role-specific ID for Zookeeper.

" - } - }, - "__integer" : { - "base" : null, - "refs" : { - "BrokerEBSVolumeInfo$VolumeSizeGB" : "\n

Size of the EBS volume to update.

\n ", - "ClusterInfo$NumberOfBrokerNodes" : "\n

The number of broker nodes in the cluster.

\n ", - "CreateClusterRequest$NumberOfBrokerNodes" : "\n

The number of broker nodes in the cluster.

\n ", - "MutableClusterInfo$NumberOfBrokerNodes" : "\n

The number of broker nodes in the cluster.

\n ", - "ProvisionedThroughput$VolumeThroughput" : "\n

Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.

\n ", - "UpdateStorageRequest$VolumeSizeGB" : "\n

size of the EBS volume to update.

\n ", - "IcebergDestinationUpdate$DataFreshnessInSeconds" : "

The maximum time, in seconds, that records buffer in MSK before being flushed to the destination. Allowed range: 300 to 900.

", - "S3DestinationUpdate$DataFreshnessInSeconds" : "

The maximum time, in seconds, that records buffer in MSK before being flushed to the destination. Allowed range: 300 to 900.

", - "IcebergDestinationConfiguration$DataFreshnessInSeconds" : "

The maximum time, in seconds, that records buffer in MSK before being flushed to the destination. Allowed range: 300 to 900. Default: 600.

", - "S3DestinationConfiguration$DataFreshnessInSeconds" : "

The maximum time, in seconds, that records buffer in MSK before being flushed to the destination. Allowed range: 300 to 900. Default: 600.

" - } - }, - "__integerMin1Max15" : { - "base" : null, - "refs" : { - "CreateClusterRequest$NumberOfBrokerNodes": "

The number of Apache Kafka broker nodes in the Amazon MSK cluster.

", - "UpdateBrokerCountRequest$TargetNumberOfBrokerNodes" : "

The number of broker nodes that you want the cluster to have after this operation completes successfully.

" - } - }, - "__integerMin1Max16384" : { - "base" : null, - "refs" : { - "EBSStorageInfo$VolumeSize" : "

The size in GiB of the EBS volume for the data drive on each broker node.

" - } - }, - "__listOfBrokerEBSVolumeInfo" : { - "base" : null, - "refs" : { - "MutableClusterInfo$BrokerEBSVolumeInfo" : "

Specifies the size of the EBS volume and the ID of the associated broker.

", - "UpdateBrokerStorageRequest$TargetBrokerEBSVolumeInfo" : "

Describes the target volume size and the ID of the broker to apply the update to.

The value you specify for Target-Volume-in-GiB must be a whole number that is greater than 100 GiB.

The storage per broker after the update operation can't exceed 16384 GiB.

" - } - }, - "__listOfClusterInfo" : { - "base" : null, - "refs" : { - "ListClustersResponse$ClusterInfoList" : "

Information on each of the MSK clusters in the response.

" - } - }, - "__listOfCluster" : { - "base" : null, - "refs" : { - "ListClustersV2Response$ClusterInfoList" : "

Information on each of the MSK clusters in the response.

" - } - }, - "__listOfChannelInfo" : { - "base" : null, - "refs" : { - "ListChannelsResponse$Channels" : "

The list of channels in the cluster.

" - } - }, - "__listOfKafkaCluster" : { - "base" : null, - "refs" : { - "CreateReplicatorRequest$KafkaClusters" : "

Kafka Clusters to use in setting up sources / targets for replication.

" - } - }, - "__listOfKafkaClusterDescription" : { - "base" : null, - "refs" : { - "DescribeReplicatorResponse$KafkaClusters" : "

Kafka Clusters used in setting up sources / targets for replication.

" - } - }, - "__listOfKafkaClusterSummary" : { - "base" : null, - "refs" : { - "ReplicatorSummary$KafkaClustersSummary" : "

Kafka Clusters used in setting up sources / targets for replication.

" - } - }, - "__listOfReplicationInfo" : { - "base" : null, - "refs" : { - "CreateReplicatorRequest$ReplicationInfoList" : "

A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.

" - } - }, - "__listOfReplicationInfoDescription" : { - "base" : null, - "refs" : { - "DescribeReplicatorResponse$ReplicationInfoList" : "

A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.

" - } - }, - "__listOfReplicationInfoSummary" : { - "base" : null, - "refs" : { - "ReplicatorSummary$ReplicationInfoSummaryList" : "

A list of summarized information of replications between clusters.

" - } - }, - "__listOfReplicatorSummary" : { - "base" : null, - "refs" : { - "ListReplicatorsResponse$Replicators" : "

List containing information of each of the replicators in the account.

" - } - }, - "__listOfVpcConfig" : { - "base" : null, - "refs" : { - "ServerlessRequest$VpcConfigs" : "

Information on vpc config for the serverless cluster.

", - "Serverless$VpcConfigs" : "

Information on vpc config for the serverless cluster.

" - } - }, - "__listOfClusterOperationInfo" : { - "base" : null, - "refs" : { - "ListClusterOperationsResponse$ClusterOperationInfoList" : "

An array of cluster operation information objects.

" - } - }, - "__listOfClusterOperationStep" : { - "base" : null, - "refs" : { - "ClusterOperationInfo$OperationSteps" : "

Steps completed during the operation.

" - } - }, - "__listOfCompatibleKafkaVersion" : { - "base" : null, - "refs" : { - "GetCompatibleKafkaVersionsResponse$CompatibleKafkaVersions" : "

A list of CompatibleKafkaVersion objects.

" - } - }, - "__listOfConfiguration" : { - "base" : null, - "refs" : { - "ListConfigurationsResponse$Configurations" : "

An array of MSK configurations.

" - } - }, - "__listOfConfigurationRevision" : { - "base" : null, - "refs" : { - "ListConfigurationRevisionsResponse$Revisions" : "

List of ConfigurationRevision objects.

" - } - }, - "__listOfDestinationTable" : { - "base" : null, - "refs" : { - "IcebergDestinationConfiguration$DestinationTableList" : "

The destination Iceberg tables. Currently exactly one table must be specified.

" - } - }, - "__listOfKafkaVersion" : { - "base" : null, - "refs" : { - "ListKafkaVersionsResponse$KafkaVersions" : "

An array of Apache Kafka version objects.

" - } - }, - "__listOfNodeInfo" : { - "base" : null, - "refs" : { - "ListNodesResponse$NodeInfoList" : "

List containing a NodeInfo object.

" - } - }, - "__listOfPartitionSource" : { - "base" : null, - "refs" : { - "PartitionSpec$SourceList" : "

The source columns used by the partitioning strategy. For TIME_HOUR, must contain exactly one source column whose value is a timestamp.

" - } - }, - "__listOfClientVpcConnection" : { - "base" : null, - "refs" : { - "ListClientVpcConnectionsResponse$ClientVpcConnections" : "

List containing a ClientVpcConnection object.

" - } - }, - "__listOfVpcConnection" : { - "base" : null, - "refs" : { - "ListVpcConnectionsResponse$VpcConnections" : "

List containing a VpcConnection object.

" - } - }, - "__listOfUnprocessedScramSecret" : { - "base" : null, - "refs" : { - "BatchAssociateScramSecretResponse$UnprocessedScramSecrets" : "

List of errors when associating secrets to cluster.

", - "BatchDisassociateScramSecretResponse$UnprocessedScramSecrets" : "

List of errors when disassociating secrets to cluster.

" - } - }, - "__listOfTopicConfiguration" : { - "base" : null, - "refs" : { - "CreateChannelRequest$TopicConfigurationList" : "

The list of topic configurations for the channel. Currently exactly one topic must be specified.

", - "DescribeChannelResponse$TopicConfigurationList" : "

The list of topic configurations for the channel.

" - } - }, - "__listOf__double" : { - "base" : null, - "refs" : { - "BrokerCountUpdateInfo$CreatedBrokerIds" : "

List of Broker Ids when creating new Brokers in a cluster.

", - "BrokerCountUpdateInfo$DeletedBrokerIds" : "

List of Broker Ids when deleting existing Brokers in a cluster.

" - } - }, - "__listOf__string" : { - "base" : null, - "refs" : { - "BatchAssociateScramSecretRequest$SecretArnList" : "

List of AWS Secrets Manager secret ARNs.

", - "BatchDisassociateScramSecretRequest$SecretArnList" : "

List of AWS Secrets Manager secret ARNs.

", - "BrokerNodeGroupInfo$ClientSubnets" : "

The list of subnets to connect to in the client virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets. Client applications use elastic network interfaces to produce and consume data. Client subnets can't occupy the Availability Zone with ID use use1-az3.

", - "BrokerNodeGroupInfo$SecurityGroups" : "

The AWS security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC. If you specify security groups that were shared with you, you must ensure that you have permissions to them. Specifically, you need the ec2:DescribeSecurityGroups permission.

", - "BrokerNodeGroupInfo$ZoneIds" : "

The zoneIds for the cluster.

", - "BrokerNodeInfo$Endpoints" : "

Endpoints for accessing the broker.

", - "Configuration$KafkaVersions" : "

An array of the versions of Apache Kafka with which you can use this MSK configuration. You can use this configuration for an MSK cluster only if the Apache Kafka version specified for the cluster appears in this array.

", - "ControllerNodeInfo$Endpoints" : "

Endpoints for accessing the Controller.

", - "CreateConfigurationRequest$KafkaVersions" : "

The versions of Apache Kafka with which you can use this MSK configuration.

", - "CreateVpcConnectionRequest$ClientSubnets" : "

The list of subnets in the client VPC.

", - "CreateVpcConnectionRequest$SecurityGroups" : "

The list of security groups to attach to the VPC connection.

", - "CreateVpcConnectionResponse$ClientSubnets" : "

The list of subnets in the client VPC.

", - "CreateVpcConnectionResponse$SecurityGroups" : "

The list of security groups attached to the VPC connection.

", - "DescribeConfigurationResponse$KafkaVersions" : "

The versions of Apache Kafka with which you can use this MSK configuration.

", - "DescribeVpcConnectionResponse$SecurityGroups" : "

The list of security groups attached to the VPC connection.

", - "DescribeVpcConnectionResponse$Subnets" : "

The list of subnets in the client VPC.

", - "ListScramSecretsResponse$SecretArnList" : "

The list of scram secrets associated with the cluster.

", - "RebootBrokerRequest$BrokerIds" : "

The list of broker ids to be rebooted.

", - "Tls$CertificateAuthorityArnList" : "

List of ACM Certificate Authority ARNs.

", - "ZookeeperNodeInfo$Endpoints" : "

Endpoints for accessing the ZooKeeper.

", - "KafkaClusterClientVpcConfig$SecurityGroupIds" : "

The security groups to attach to the ENIs for the broker nodes.

", - "KafkaClusterClientVpcConfig$SubnetIds" : "

The list of subnets in the client VPC to connect to.

" - } - }, - "__listOf__stringMax249" : { - "base" : null, - "refs" : { - "TopicReplication$TopicsToExclude" : "

List of regular expression patterns indicating the topics that should not be replicated.

", - "TopicReplication$TopicsToReplicate" : "

List of regular expression patterns indicating the topics to copy.

", - "TopicReplicationUpdate$TopicsToExclude" : "

List of regular expression patterns indicating the topics that should not be replicated.

", - "TopicReplicationUpdate$TopicsToReplicate" : "

List of regular expression patterns indicating the topics to copy.

" - } - }, - "__listOf__stringMax256" : { - "base" : null, - "refs" : { - "ConsumerGroupReplication$ConsumerGroupsToExclude" : "

List of regular expression patterns indicating the consumer groups that should not be replicated.

", - "ConsumerGroupReplication$ConsumerGroupsToReplicate" : "

List of regular expression patterns indicating the consumer groups to copy.

", - "ConsumerGroupReplicationUpdate$ConsumerGroupsToExclude" : "

List of regular expression patterns indicating the consumer groups that should not be replicated.

", - "ConsumerGroupReplicationUpdate$ConsumerGroupsToReplicate" : "

List of regular expression patterns indicating the consumer groups to copy.

" - } - }, - "__long" : { - "base" : null, - "refs" : { - "BrokerSoftwareInfo$ConfigurationRevision" : "

The revision of the configuration to use. This field isn't visible in this preview release.

", - "ConfigurationRevision$Revision" : "

The revision number.

", - "DescribeConfigurationRevisionResponse$Revision" : "

The revision number.

", - "ConfigurationInfo$Revision" : "

The revision of the configuration to use.

" - } - }, - "__mapOf__string" : { - "base" : null, - "refs" : { - "ClusterInfo$Tags" : "

Tags attached to the cluster.

", - "CreateClusterRequest$Tags" : "

Create tags when creating the cluster.

", - "CreateChannelRequest$Tags" : "

The tags attached to the channel.

", - "CreateReplicatorRequest$Tags" : "

List of tags to attach to created Replicator.

", - "CreateVpcConnectionRequest$Tags" : "

Create tags when creating the VPC connection.

", - "CreateVpcConnectionResponse$Tags" : "

Tags attached to the VPC connection.

", - "DescribeReplicatorResponse$Tags" : "

List of tags attached to the Replicator.

", - "DescribeVpcConnectionResponse$Tags" : "

Tags attached to the VPC connection.

", - "ListTagsForResourceResponse$Tags" : "

The key-value pair for the resource tag.

", - "TagResourceRequest$Tags" : "

The key-value pair for the resource tag.

", - "VpcConnection$Tags" : "

Tags attached to the VPC connection.

", - "DescribeChannelResponse$Tags" : "

The tags attached to the channel.

" - } - }, - "__string" : { - "base" : null, - "refs" : { - "AmazonMskCluster$MskClusterArn" : "

The Amazon Resource Name (ARN) of an Amazon MSK cluster.

", - "ApacheKafkaCluster$ApacheKafkaClusterId" : "

The ID of the Apache Kafka cluster.

", - "ApacheKafkaCluster$BootstrapBrokerString" : "

The bootstrap broker string of the Apache Kafka cluster.

", - "BatchAssociateScramSecretResponse$ClusterArn" : "

The Amazon Resource Name (ARN) of the cluster.

", - "BatchDisassociateScramSecretResponse$ClusterArn" : "

The Amazon Resource Name (ARN) of the cluster.

", - "BrokerEBSVolumeInfo$KafkaBrokerNodeId" : "

The ID of the broker to update.

", - "BrokerNodeInfo$AttachedENIId" : "

The attached elastic network interface of the broker.

", - "BrokerNodeInfo$ClientSubnet" : "

The client subnet to which this broker node belongs.

", - "BrokerNodeInfo$ClientVpcIpAddress" : "

The virtual private cloud (VPC) of the client.

", - "BrokerSoftwareInfo$ConfigurationArn" : "

The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release.

", - "BrokerSoftwareInfo$KafkaVersion" : "

The version of Apache Kafka.

", - "Catalog$CatalogArn" : "

The Amazon Resource Name (ARN) of the federated AWS Glue Data Catalog that projects the S3 Tables bucket. If omitted, MSK derives the catalog ARN from warehouseLocation.

", - "Catalog$WarehouseLocation" : "

The Amazon Resource Name (ARN) of the S3 Tables bucket that backs the Apache Iceberg warehouse.

", - "ClientVpcConnection$Authentication" : "

The VPC connection authentication type.

", - "ClientVpcConnection$Owner" : "

The owner of the VPC connection.

", - "ClientVpcConnection$VpcConnectionArn" : "

The Amazon Resource Name (ARN) of the VPC connection.

", - "ChannelInfo$ChannelArn" : "

The Amazon Resource Name (ARN) that uniquely identifies the channel.

", - "ChannelInfo$ChannelName" : "

The name of the channel.

", - "CreateChannelRequest$ChannelName" : "

The name of the channel. Must be unique within the cluster.

", - "CreateChannelResponse$ChannelArn" : "

The Amazon Resource Name (ARN) that uniquely identifies the channel.

", - "CreateChannelResponse$ClusterOperationArn" : "

The Amazon Resource Name (ARN) of the cluster operation.

", - "DeleteChannelResponse$ChannelArn" : "

The Amazon Resource Name (ARN) that uniquely identifies the channel.

", - "DeleteChannelResponse$ClusterOperationArn" : "

The Amazon Resource Name (ARN) of the cluster operation.

", - "DescribeChannelResponse$ClusterOperationArn" : "

The Amazon Resource Name (ARN) of the in-flight cluster operation. Returned only while the channel is in CREATING, UPDATING, or DELETING.

", - "ChannelInfo$ClusterOperationArn" : "

The Amazon Resource Name (ARN) of the in-flight cluster operation. Returned only while the channel is in CREATING, UPDATING, or DELETING.

", - "DeadLetterQueueS3$BucketArn" : "

The Amazon Resource Name (ARN) of the dead-letter Amazon S3 bucket.

", - "DeadLetterQueueS3$ErrorOutputPrefix" : "

An optional prefix prepended to every dead-letter Amazon S3 object key.

", - "DeadLetterQueueS3$ExpectedBucketOwner" : "

Optional 12-digit AWS account ID expected to own the dead-letter Amazon S3 bucket.

", - "S3Storage$ExpectedBucketOwner" : "

Optional 12-digit AWS account ID expected to own the Amazon S3 bucket.

", - "RecordSchema$GsrArn" : "

The Amazon Resource Name (ARN) of the AWS Glue Schema Registry schema (not registry) used to validate records for the destination Apache Iceberg table.

", - "S3DestinationConfiguration$ServiceExecutionRoleArn" : "

The Amazon Resource Name (ARN) of the IAM role that MSK assumes to write to the destination Amazon S3 bucket and the dead-letter bucket.

", - "S3Storage$BucketArn" : "

The Amazon Resource Name (ARN) of the destination Amazon S3 bucket.

", - "S3Storage$OutputPrefix" : "

An optional prefix prepended to every Amazon S3 object key written by the channel.

", - "S3Storage$OutputKeyTemplate" : "

An optional template that controls the Amazon S3 object key for each delivered record. Supports the placeholders !{partition-id}, !{sequence-number}, and !{kafka-offset}.

", - "DescribeChannelResponse$ChannelArn" : "

The Amazon Resource Name (ARN) that uniquely identifies the channel.

", - "DescribeChannelResponse$ChannelName" : "

The name of the channel.

", - "ChannelStateInfo$Code" : "

A short, machine-readable code identifying the failure cause.

", - "ChannelStateInfo$Message" : "

A human-readable message describing the failure.

", - "DestinationTable$DestinationDatabaseName" : "

The name of the destination namespace (database) in the AWS Glue Data Catalog.

", - "DestinationTable$DestinationTableName" : "

The name of the destination Apache Iceberg table.

", - "ListChannelsResponse$NextToken" : "

If the response from ListChannels is truncated, this token is included. Send it as the nextToken parameter on a subsequent ListChannels call to retrieve the next page.

", - "CloudWatchLogs$LogGroup" : "

The CloudWatch log group that is the destination for broker logs.

", - "ClusterInfo$ActiveOperationArn" : "

Arn of active cluster operation.

", - "ClusterInfo$ClusterArn" : "

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

", - "ClusterInfo$ClusterName" : "

The name of the cluster.

", - "ClusterInfo$CurrentVersion" : "

The current version of the MSK cluster. Cluster versions aren't simple integers. You can obtain the current version by describing the cluster. An example version is KTVPDKIKX0DER.

", - "ClusterInfo$ZookeeperConnectString" : "

The connection string to use to connect to the Apache ZooKeeper cluster.

", - "ClusterInfo$ZookeeperConnectStringTls" : "

The connection string to use to connect to zookeeper cluster on Tls port.

", - "ClusterOperationInfo$ClientRequestId" : "

The ID of the API request that triggered this operation.

", - "ClusterOperationInfo$ClusterArn" : "

ARN of the cluster.

", - "ClusterOperationInfo$OperationArn" : "

ARN of the cluster operation.

", - "ClusterOperationInfo$OperationState" : "

State of the cluster operation.

", - "ClusterOperationInfo$OperationType" : "

Type of the cluster operation.

", - "ClusterOperationStep$StepName" : "

The name of the step.

", - "ClusterOperationStepInfo$StepStatus" : "

The steps current status.

", - "Configuration$Arn" : "

The Amazon Resource Name (ARN) of the configuration.

", - "Configuration$Description" : "

The description of the configuration.

", - "Configuration$Name" : "

The name of the configuration. Configuration names are strings that match the regex \"^[0-9A-Za-z-]+$\".

", - "ConfigurationInfo$Arn" : "

ARN of the configuration to use.

", - "ConfigurationRevision$Description" : "

The description of the configuration revision.

", - "CreateClusterResponse$ClusterArn" : "

The Amazon Resource Name (ARN) of the cluster.

", - "CreateClusterResponse$ClusterName" : "

The name of the MSK cluster.

", - "CreateConfigurationRequest$Description" : "

The description of the configuration.

", - "CreateConfigurationRequest$Name" : "

The name of the configuration. Configuration names are strings that match the regex \"^[0-9A-Za-z-]+$\".

", - "CreateConfigurationResponse$Arn" : "

The Amazon Resource Name (ARN) of the configuration.

", - "CreateConfigurationResponse$Name" : "

The name of the configuration. Configuration names are strings that match the regex \"^[0-9A-Za-z-]+$\".

", - "CreateReplicatorRequest$ServiceExecutionRoleArn" : "

The ARN of the IAM role used by the replicator to access resources in the customer's account (e.g source and target clusters)

", - "CreateReplicatorResponse$ReplicatorArn" : "

The Amazon Resource Name (ARN) of the replicator.

", - "CreateReplicatorResponse$ReplicatorName" : "

Name of the replicator provided by the customer.

", - "CreateVpcConnectionRequest$TargetClusterArn" : "

The Amazon Resource Name (ARN) of the cluster.

", - "CreateVpcConnectionRequest$VpcId" : "

The VPC ID of the VPC connection.

", - "CreateVpcConnectionResponse$VpcConnectionArn" : "

The Amazon Resource Name (ARN) of the VPC connection.

", - "CreateVpcConnectionResponse$VpcId" : "

The VPC ID of the VPC connection.

", - "DeleteClusterResponse$ClusterArn" : "

The Amazon Resource Name (ARN) of the cluster.

", - "DeleteConfigurationRequest$Arn" : "

The Amazon Resource Name (ARN) of the configuration.

", - "DeleteConfigurationResponse$Arn" : "

The Amazon Resource Name (ARN) of the configuration.

", - "DeleteReplicatorResponse$ReplicatorArn" : "

The Amazon Resource Name (ARN) of the replicator.

", - "DeleteVpcConnectionResponse$VpcConnectionArn" : "

The Amazon Resource Name (ARN) of the VPC connection.

", - "DescribeConfigurationResponse$Arn" : "

The Amazon Resource Name (ARN) of the configuration.

", - "DescribeConfigurationResponse$Description" : "

The description of the configuration.

", - "DescribeConfigurationResponse$Name" : "

The name of the configuration. Configuration names are strings that match the regex \"^[0-9A-Za-z-]+$\".

", - "DescribeConfigurationRevisionResponse$Arn" : "

The Amazon Resource Name (ARN) of the configuration.

", - "DescribeConfigurationRevisionResponse$Description" : "

The description of the configuration.

", - "DescribeReplicatorResponse$CurrentVersion" : "

The current version number of the replicator.

", - "DescribeReplicatorResponse$ReplicatorArn" : "

The Amazon Resource Name (ARN) of the replicator.

", - "DescribeReplicatorResponse$ReplicatorDescription" : "

The description of the replicator.

", - "DescribeReplicatorResponse$ReplicatorName" : "

The name of the replicator.

", - "DescribeReplicatorResponse$ReplicatorResourceArn" : "

The Amazon Resource Name (ARN) of the replicator resource in the region where the replicator was created.

", - "DescribeReplicatorResponse$ServiceExecutionRoleArn" : "

The Amazon Resource Name (ARN) of the IAM role used by the replicator to access resources in the customer's account (e.g source and target clusters)

", - "DescribeVpcConnectionResponse$Authentication" : "

The authentication type of the VPC connection.

", - "DescribeVpcConnectionResponse$TargetClusterArn" : "

The Amazon Resource Name (ARN) of the cluster.

", - "DescribeVpcConnectionResponse$VpcConnectionArn" : "

The Amazon Resource Name (ARN) of the VPC connection.

", - "DescribeVpcConnectionResponse$VpcId" : "

The VPC ID of the VPC connection.

", - "EncryptionAtRest$DataVolumeKMSKeyId" : "

The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.

", - "EncryptionConfiguration$KmsKeyArn" : "

The Amazon Resource Name (ARN) of the AWS KMS key used to encrypt the data.

", - "Error$InvalidParameter" : "

The parameter that caused the error.

", - "Error$Message" : "

The description of the error.

", - "ErrorInfo$ErrorCode" : "

A number describing the error programmatically.

", - "ErrorInfo$ErrorString" : "

An optional field to provide more details about the error.

", - "Firehose$DeliveryStream" : "

The Kinesis Data Firehose delivery stream that is the destination for broker logs.

", - "ReplicatorCloudWatchLogs$LogGroup" : "

The CloudWatch log group that is the destination for replicator logs.

", - "ReplicatorFirehose$DeliveryStream" : "

The Kinesis Data Firehose delivery stream that is the destination for replicator logs.

", - "ReplicatorS3$Bucket" : "

The name of the S3 bucket that is the destination for replicator logs.

", - "ReplicatorS3$Prefix" : "

The S3 prefix that is the destination for replicator logs.

", - "GetBootstrapBrokersResponse$BootstrapBrokerString" : "

A string containing one or more hostname:port pairs.

", - "GetBootstrapBrokersResponse$BootstrapBrokerStringTls" : "

A string containing one or more DNS names (or IP addresses) and TLS port pairs. The following is an example.

{\n \"BootstrapBrokerStringTls\": \"b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094,b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094\"\n}", - "GetBootstrapBrokersResponse$BootstrapBrokerStringSaslScram" : "

A string containing one or more DNS names (or IP addresses) and SASL SCRAM port pairs. The following is an example.

{\n \"BootstrapBrokerStringSaslScram\": \"b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096,b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096\"\n}", - "GetBootstrapBrokersResponse$BootstrapBrokerStringSaslIam" : "

A string that contains one or more DNS names (or IP addresses) and SASL IAM port pairs. The following is an example.

{\n \"BootstrapBrokerStringSaslIam\": \"b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9098,b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9098,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9098\"\n}", - "GetBootstrapBrokersResponse$BootstrapBrokerStringPublicTls" : "

A string containing one or more DNS names (or IP addresses) and TLS port pairs. The following is an example.

{\n \"BootstrapBrokerStringTls\": \"b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9194,b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9194,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9194\"\n}", - "GetBootstrapBrokersResponse$BootstrapBrokerStringPublicSaslScram" : "

A string containing one or more DNS names (or IP addresses) and SASL SCRAM port pairs. The following is an example.

{\n \"BootstrapBrokerStringSaslScram\": \"b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9196,b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9196,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9196\"\n}", - "GetBootstrapBrokersResponse$BootstrapBrokerStringPublicSaslIam" : "

A string that contains one or more DNS names (or IP addresses) and SASL IAM port pairs. The following is an example.

{\n \"BootstrapBrokerStringSaslIam\": \"b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9198,b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9198,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9198\"\n}", - "GetBootstrapBrokersResponse$BootstrapBrokerStringVpcConnectivitySaslIam" : "

A string containing one or more dns name (or IP) and SASL IAM port pairs for VPC connectivity.

", - "GetBootstrapBrokersResponse$BootstrapBrokerStringVpcConnectivitySaslScram" : "

A string containing one or more dns name (or IP) and SASL SCRAM port pairs for VPC connectivity.

", - "GetBootstrapBrokersResponse$BootstrapBrokerStringVpcConnectivityTls" : "

A string containing one or more dns name (or IP) and Tls port pairs for VPC connectivity.

", - "GetBootstrapBrokersResponse$BootstrapBrokerStringIpv6" : "

A string that contains one or more DNS names (or IP) and port pairs for IPv6 connectivity.

", - "GetBootstrapBrokersResponse$BootstrapBrokerStringTlsIpv6" : "

A string that contains one or more DNS names (or IP) and TLS port pairs for IPv6 connectivity.

", - "GetBootstrapBrokersResponse$BootstrapBrokerStringSaslScramIpv6" : "

A string that contains one or more DNS names (or IP) and SASL SCRAM port pairs for IPv6 connectivity.

", - "GetBootstrapBrokersResponse$BootstrapBrokerStringSaslIamIpv6" : "

A string that contains one or more DNS names (or IP) and SASL IAM port pairs for IPv6 connectivity.

", - "GetClusterPolicyResponse$CurrentVersion" : "

Cluster policy version.

", - "GetClusterPolicyResponse$Policy" : "

Cluster policy attached to the MSK cluster.

", - "IcebergDestinationConfiguration$ServiceExecutionRoleArn" : "

The Amazon Resource Name (ARN) of the IAM role that MSK assumes to access the destination table, the AWS Glue Data Catalog, and the dead-letter Amazon S3 bucket.

", - "KafkaVersion$Version" : "

The Apache Kafka version.

", - "KafkaClusterDescription$KafkaClusterAlias" : "

The alias of the Kafka cluster. Used to prefix names of replicated topics.

", - "KafkaClusterEncryptionInTransit$RootCaCertificate" : "

The root CA certificate.

", - "KafkaClusterSaslScramAuthentication$SecretArn" : "

The Amazon Resource Name (ARN) of the Secrets Manager secret.

", - "KafkaClusterMTLSAuthentication$SecretArn" : "

The Amazon Resource Name (ARN) of the Secrets Manager secret.

", - "KafkaClusterSummary$KafkaClusterAlias" : "

The alias of the Kafka cluster. Used to prefix names of replicated topics.

", - "ListClientVpcConnectionsResponse$NextToken" : "

If the response of ListClientVpcConnections is truncated, it returns a NextToken in the response. This Nexttoken should be sent in the subsequent request to ListClientVpcConnections.

", - "ListClusterOperationsResponse$NextToken" : "

If the response of ListClusterOperations is truncated, it returns a NextToken in the response. This Nexttoken should be sent in the subsequent request to ListClusterOperations.

", - "ListClustersResponse$NextToken" : "

The paginated results marker. When the result of a ListClusters operation is truncated, the call returns NextToken in the response. To get another batch of clusters, provide this token in your next request.

", - "ListConfigurationRevisionsResponse$NextToken" : "

Paginated results marker.

", - "ListConfigurationsResponse$NextToken" : "

The paginated results marker. When the result of a ListConfigurations operation is truncated, the call returns NextToken in the response. To get another batch of configurations, provide this token in your next request.

", - "ListKafkaVersionsResponse$NextToken" : "

Paginated results marker.

", - "ListNodesResponse$NextToken" : "

The paginated results marker. When the result of a ListNodes operation is truncated, the call returns NextToken in the response. To get another batch of nodes, provide this token in your next request.

", - "ListReplicatorsResponse$NextToken" : "

If the response of ListReplicators is truncated, it returns a NextToken in the response. This NextToken should be sent in the subsequent request to ListReplicators.

", - "ListScramSecretsResponse$NextToken" : "

Paginated results marker.

", - "ListVpcConnectionsResponse$NextToken" : "

If the response of ListVpcConnections is truncated, it returns a NextToken in the response. This NextToken should be sent in the subsequent request to ListVpcConnections.

", - "MutableClusterInfo$KafkaVersion" : "

The Apache Kafka version.

", - "NodeInfo$AddedToClusterTime" : "

The start time.

", - "NodeInfo$InstanceType" : "

The instance type.

", - "NodeInfo$NodeARN" : "

The Amazon Resource Name (ARN) of the node.

", - "PublicAccess$Type" : "

The value DISABLED indicates that public access is disabled. SERVICE_PROVIDED_EIPS indicates that public access is enabled.

", - "PutClusterPolicyResponse$CurrentVersion" : "

Cluster policy version.

", - "RebootBrokerResponse$ClusterArn" : "

The Amazon Resource Name (ARN) of the cluster.

", - "RebootBrokerResponse$ClusterOperationArn" : "

The Amazon Resource Name (ARN) of the cluster operation.

", - "ReplicationInfo$SourceKafkaClusterArn" : "

The ARN of the source Kafka cluster.

", - "ReplicationInfo$SourceKafkaClusterId" : "

The ID of the source Kafka cluster.

", - "ReplicationInfo$TargetKafkaClusterArn" : "

The ARN of the target Kafka cluster.

", - "ReplicationInfo$TargetKafkaClusterId" : "

The ID of the target Kafka cluster.

", - "ReplicationInfoDescription$SourceKafkaClusterAlias" : "

The alias of the source Kafka cluster.

", - "ReplicationInfoDescription$TargetKafkaClusterAlias" : "

The alias of the target Kafka cluster.

", - "ReplicationInfoSummary$SourceKafkaClusterAlias" : "

The alias of the source Kafka cluster.

", - "ReplicationInfoSummary$TargetKafkaClusterAlias" : "

The alias of the target Kafka cluster.

", - "ReplicationStateInfo$Code" : "

Code that describes the current state of the replicator.

", - "ReplicationStateInfo$Message" : "

Message that describes the state of the replicator.

", - "ReplicatorSummary$CurrentVersion" : "

The current version of the replicator.

", - "ReplicatorSummary$ReplicatorArn" : "

The Amazon Resource Name (ARN) of the replicator.

", - "ReplicatorSummary$ReplicatorName" : "

The name of the replicator.

", - "ReplicatorSummary$ReplicatorResourceArn" : "The Amazon Resource Name (ARN) of the replicator resource in the region where the replicator was created.

", - "S3$Bucket" : "

The name of the S3 bucket that is the destination for broker logs.

", - "S3$Prefix" : "

The S3 prefix that is the destination for broker logs.

", - "StateInfo$Code" : "

If the cluster is in an unusable state, this field contains the code that describes the issue.

", - "StateInfo$Message" : "

If the cluster is in an unusable state, this field contains a message that describes the issue.

", - "UpdateBrokerCountRequest$CurrentVersion" : "

The current version of the cluster.

", - "UpdateBrokerCountResponse$ClusterArn" : "

The Amazon Resource Name (ARN) of the cluster.

", - "UpdateBrokerCountResponse$ClusterOperationArn" : "

The Amazon Resource Name (ARN) of the cluster operation.

", - "UpdateBrokerTypeRequest$CurrentVersion": "

The current version of the cluster.

", - "UpdateBrokerTypeRequest$TargetInstanceType": "

The Amazon MSK broker type that you want all of the brokers in this cluster to be.

", - "UpdateBrokerTypeResponse$ClusterArn" : "

The Amazon Resource Name (ARN) of the cluster.

", - "UpdateBrokerTypeResponse$ClusterOperationArn" : "

The Amazon Resource Name (ARN) of the cluster operation.

", - "UpdateBrokerStorageRequest$CurrentVersion" : "

The version of cluster to update from. A successful operation will then generate a new version.

", - "UpdateBrokerStorageResponse$ClusterArn" : "

The Amazon Resource Name (ARN) of the cluster.

", - "UpdateBrokerStorageResponse$ClusterOperationArn" : "

The Amazon Resource Name (ARN) of the cluster operation.

", - "UpdateConfigurationRequest$Description" : "

The description of the configuration.

", - "UpdateConfigurationRequest$Arn" : "

The Amazon Resource Name (ARN) of the configuration.

", - "UpdateConfigurationResponse$Arn" : "

The Amazon Resource Name (ARN) of the configuration.

", - "UpdateConnectivityRequest$CurrentVersion" : "

The current version of the cluster.

", - "UpdateConnectivityResponse$ClusterArn" : "

The Amazon Resource Name (ARN) of the cluster.

", - "UpdateConnectivityResponse$ClusterOperationArn" : "

The Amazon Resource Name (ARN) of the cluster operation.

", - "UpdateChannelResponse$ChannelArn" : "

The Amazon Resource Name (ARN) that uniquely identifies the channel.

", - "UpdateChannelResponse$ClusterOperationArn" : "

The Amazon Resource Name (ARN) of the cluster operation.

", - "UpdateChannelRequest$ChannelArn" : "

The Amazon Resource Name (ARN) that uniquely identifies the channel.

", - "UpdateChannelRequest$ClusterArn" : "

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

", - "UpdateClusterConfigurationRequest$CurrentVersion" : "

The version of the cluster that you want to update.

", - "UpdateClusterConfigurationResponse$ClusterArn" : "

The Amazon Resource Name (ARN) of the cluster.

", - "UpdateClusterConfigurationResponse$ClusterOperationArn" : "

The Amazon Resource Name (ARN) of the cluster operation.

", - "UpdateClusterKafkaVersionRequest$CurrentVersion" : "

Current cluster version.

", - "UpdateClusterKafkaVersionRequest$TargetKafkaVersion" : "

Target Apache Kafka version.

", - "UpdateClusterKafkaVersionResponse$ClusterArn" : "

The Amazon Resource Name (ARN) of the cluster.

", - "UpdateClusterKafkaVersionResponse$ClusterOperationArn" : "

The Amazon Resource Name (ARN) of the cluster operation.

", - "UpdateMonitoringRequest$CurrentVersion" : "

The version of cluster to update from. A successful operation will then generate a new version.

", - "UpdateMonitoringResponse$ClusterArn" : "

The Amazon Resource Name (ARN) of the cluster.

", - "UpdateMonitoringResponse$ClusterOperationArn" : "

The Amazon Resource Name (ARN) of the cluster operation.

", - "UpdateRebalancingRequest$ClusterArn" : "

The Amazon Resource Name (ARN) of the cluster.

", - "UpdateRebalancingRequest$CurrentVersion" : "

The current version of the cluster.

", - "UpdateRebalancingResponse$ClusterArn" : "

The Amazon Resource Name (ARN) of the cluster whose intelligent rebalancing status you've updated.

", - "UpdateRebalancingResponse$ClusterOperationArn" : "

The Amazon Resource Name (ARN) of the cluster operation.

", - "UpdateReplicationInfoRequest$CurrentVersion" : "

Current replicator version.

", - "UpdateReplicationInfoRequest$SourceKafkaClusterArn" : "

The ARN of the source Kafka cluster.

", - "UpdateReplicationInfoRequest$SourceKafkaClusterId" : "

The ID of the source Kafka cluster.

", - "UpdateReplicationInfoRequest$TargetKafkaClusterArn" : "

The ARN of the target Kafka cluster.

", - "UpdateReplicationInfoRequest$TargetKafkaClusterId" : "

The ID of the target Kafka cluster.

", - "UpdateReplicationInfoResponse$ReplicatorArn" : "

The Amazon Resource Name (ARN) of the replicator.

", - "UpdateSecurityRequest$CurrentVersion" : "

You can use the DescribeCluster operation to get the current version of the cluster. After the security update is complete, the cluster will have a new version.

", - "UpdateSecurityResponse$ClusterArn" : "

The Amazon Resource Name (ARN) of the cluster.

", - "UpdateSecurityResponse$ClusterOperationArn" : "

The Amazon Resource Name (ARN) of the cluster operation.

", - "UpdateStorageRequest$CurrentVersion" : "

The version of cluster to update from. A successful operation will then generate a new version.

", - "UpdateStorageResponse$ClusterArn" : "

The Amazon Resource Name (ARN) of the cluster.

", - "UpdateStorageResponse$ClusterOperationArn" : "

The Amazon Resource Name (ARN) of the cluster operation.

", - "VpcConnection$Authentication" : "

The authentication type for the VPC connection.

", - "VpcConnection$TargetClusterArn" : "

The Amazon Resource Name (ARN) of the cluster.

", - "VpcConnection$VpcConnectionArn" : "

The Amazon Resource Name (ARN) of the VPC connection.

", - "VpcConnection$VpcId" : "

The VPC ID of the VPC connection.

", - "ZookeeperNodeInfo$AttachedENIId" : "

The attached elastic network interface of the zookeeper.

", - "ZookeeperNodeInfo$ClientVpcIpAddress" : "

The virtual private cloud (VPC) IP address of the client.

", - "ZookeeperNodeInfo$ZookeeperVersion" : "

The version of Zookeeper.

", - "__listOf__string$member" : null, - "__mapOf__string$member" : null, - "CreateChannelRequest$ClusterArn" : "

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

", - "DeleteChannelRequest$ChannelArn" : "

The Amazon Resource Name (ARN) that uniquely identifies the channel.

", - "DeleteChannelRequest$ClusterArn" : "

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

", - "DescribeChannelRequest$ChannelArn" : "

The Amazon Resource Name (ARN) that uniquely identifies the channel.

", - "DescribeChannelRequest$ClusterArn" : "

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

", - "ListChannelsRequest$ClusterArn" : "

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

", - "ListChannelsRequest$MaxResults" : "

Maximum number of channels to return in a single response.

", - "ListChannelsRequest$NextToken" : "

If the response of ListChannels is truncated, it returns a nextToken in the response. This nextToken should be sent in the subsequent request to ListChannels.

", - "ListChannelsRequest$TopicNameFilter" : "

Filters results to channels whose topic name matches the specified value.

", - "TopicConfiguration$TopicArn" : "

The Amazon Resource Name (ARN) that uniquely identifies the topic.

" - } - }, - "__stringMax1024" : { - "base" : null, - "refs" : { - "CreateReplicatorRequest$Description" : "

A summary description of the replicator.

" - } - }, - "__stringMax249" : { - "base" : null, - "refs" : { - "__listOf__stringMax249$member" : null - } - }, - "__stringMax256" : { - "base" : null, - "refs" : { - "__listOf__stringMax256$member" : null - } - }, - "__stringMin1" : { - "base" : null, - "refs" : { - "PutClusterPolicyRequest$CurrentVersion" : "

Current cluster policy version.

", - "RejectClientVpcConnectionRequest$VpcConnectionArn" : "

VPC connection ARN.

" - } - }, - "__stringMin1Max128" : { - "base" : null, - "refs" : { - "CreateClusterRequest$KafkaVersion" : "

The version of Apache Kafka.

" - } - }, - "__stringMin1Max20480" : { - "base" : null, - "refs" : { - "PutClusterPolicyRequest$Policy" : "

Cluster policy for cluster.

" - } - }, - "__stringMin1Max64" : { - "base" : null, - "refs" : { - "CreateClusterRequest$ClusterName" : "

The name of the cluster.

" - } - }, - "__stringMin3Max10" : { - "base" : null, - "refs" : { - "CreateVpcConnectionRequest$Authentication" : null, - "CreateVpcConnectionResponse$Authentication" : "

The authentication type for the VPC connection.

" - } - }, - "__stringMin5Max32" : { - "base" : null, - "refs" : { - "BrokerNodeGroupInfo$InstanceType" : "

The type of broker used in the Amazon MSK cluster.

", - "MutableClusterInfo$InstanceType": "

The Amazon MSK broker type that you want all of the brokers in this cluster to be.

" - } - }, - "__stringMin1Max128Pattern09AZaZ09AZaZ0" : { - "base" : null, - "refs" : { - "CreateReplicatorRequest$ReplicatorName" : "

The name of the replicator. Alpha-numeric characters with '-' are allowed.

" - } - }, - "__timestampIso8601" : { - "base" : null, - "refs" : { - "ChannelInfo$CreationTime" : "

The time when the channel was created.

", - "ClientVpcConnection$CreationTime" : "

The creation time of the VPC connection.

", - "ClusterInfo$CreationTime" : "

The time when the cluster was created.

", - "ClusterOperationInfo$CreationTime" : "

The time at which operation was created.

", - "ClusterOperationInfo$EndTime" : "

The time at which the operation finished.

", - "Configuration$CreationTime" : "

The time when the configuration was created.

", - "ConfigurationRevision$CreationTime" : "

The time when the configuration revision was created.

", - "CreateConfigurationResponse$CreationTime" : "

The time when the configuration was created.

", - "CreateVpcConnectionResponse$CreationTime" : "

The time when the VPC connection was created.

", - "DescribeChannelResponse$CreationTime" : "

The time when the channel was created.

", - "DescribeConfigurationResponse$CreationTime" : "

The time when the configuration was created.

", - "DescribeConfigurationRevisionResponse$CreationTime" : "

The time when the configuration was created.

", - "DescribeVpcConnectionResponse$CreationTime" : "

The creation time of the VPC connection.

", - "DescribeReplicatorResponse$CreationTime" : "

The time when the replicator was created.

", - "ReplicatorSummary$CreationTime" : "

The time the replicator was created.

", - "VpcConnection$CreationTime" : "

The creation time of the VPC connection.

" - } - } - } -} diff --git a/tools/code-generation/api-descriptions/kafka/2018-11-14/endpoint-bdd-1.json b/tools/code-generation/api-descriptions/kafka/2018-11-14/endpoint-bdd-1.json deleted file mode 100644 index b84cdcf6dfac..000000000000 --- a/tools/code-generation/api-descriptions/kafka/2018-11-14/endpoint-bdd-1.json +++ /dev/null @@ -1,266 +0,0 @@ -{ - "version": "1.1", - "parameters": { - "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" - }, - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "string" - } - }, - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - }, - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - }, - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - }, - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws" - ] - }, - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws-cn" - ] - }, - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws-eusc" - ] - }, - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws-us-gov" - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "results": [ - { - "conditions": [], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://kafka-api.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://kafka-api-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://kafka.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://kafka-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": "https://kafka-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": "https://kafka.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ], - "root": 2, - "nodeCount": 20, - "nodes": "/////wAAAAH/////AAAAAAAAABMAAAADAAAAAQAAAAQF9eENAAAAAgAAAAUF9eENAAAAAwAAAAwAAAAGAAAABAAAAAcF9eEGAAAABQX14QQAAAAIAAAABgX14QQAAAAJAAAABwX14QQAAAAKAAAACAX14QQAAAALAAAACQX14QsF9eEMAAAABAAAAA8AAAANAAAACAX14QYAAAAOAAAACgX14QkF9eEKAAAABQX14QUAAAAQAAAACAX14QQAAAARAAAACQAAABIF9eEIAAAACgX14QcF9eEIAAAAAwX14QEAAAAUAAAABAX14QIF9eED" -} \ No newline at end of file diff --git a/tools/code-generation/api-descriptions/kafka/2018-11-14/endpoint-rule-set-1.json b/tools/code-generation/api-descriptions/kafka/2018-11-14/endpoint-rule-set-1.json deleted file mode 100644 index 8a427af6cca0..000000000000 --- a/tools/code-generation/api-descriptions/kafka/2018-11-14/endpoint-rule-set-1.json +++ /dev/null @@ -1,645 +0,0 @@ -{ - "version": "1.0", - "parameters": { - "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" - }, - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the 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": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws" - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - false - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "endpoint": { - "url": "https://kafka-api.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws" - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "endpoint": { - "url": "https://kafka-api-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws-cn" - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - false - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "endpoint": { - "url": "https://kafka-api.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws-us-gov" - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - false - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "endpoint": { - "url": "https://kafka-api.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws-us-gov" - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "endpoint": { - "url": "https://kafka-api.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws-us-gov" - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - false - ] - } - ], - "endpoint": { - "url": "https://kafka.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws-eusc" - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - false - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "endpoint": { - "url": "https://kafka-api.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "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": [], - "endpoint": { - "url": "https://kafka-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "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 - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - false - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://kafka-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - false - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://kafka.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://kafka.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ], - "type": "tree" - } - ] -} \ No newline at end of file diff --git a/tools/code-generation/api-descriptions/kafka/2018-11-14/endpoint-tests-1.json b/tools/code-generation/api-descriptions/kafka/2018-11-14/endpoint-tests-1.json deleted file mode 100644 index 14b744bdc5dc..000000000000 --- a/tools/code-generation/api-descriptions/kafka/2018-11-14/endpoint-tests-1.json +++ /dev/null @@ -1,330 +0,0 @@ -{ - "testCases": [ - { - "documentation": "For custom endpoint with region not set and fips disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Endpoint": "https://example.com", - "UseFIPS": false - } - }, - { - "documentation": "For custom endpoint with fips enabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Endpoint": "https://example.com", - "UseFIPS": true - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Endpoint": "https://example.com", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kafka-api-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://kafka-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://kafka-api.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://kafka.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kafka-fips.cn-northwest-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-northwest-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kafka-fips.cn-northwest-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-northwest-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kafka-api.cn-northwest-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-northwest-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kafka.cn-northwest-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-northwest-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eusc-de-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kafka-fips.eusc-de-east-1.amazonaws.eu" - } - }, - "params": { - "Region": "eusc-de-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region eusc-de-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kafka.eusc-de-east-1.amazonaws.eu" - } - }, - "params": { - "Region": "eusc-de-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kafka-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 disabled", - "expect": { - "endpoint": { - "url": "https://kafka.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 disabled", - "expect": { - "endpoint": { - "url": "https://kafka-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 disabled", - "expect": { - "endpoint": { - "url": "https://kafka.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-isoe-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kafka-fips.eu-isoe-west-1.cloud.adc-e.uk" - } - }, - "params": { - "Region": "eu-isoe-west-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kafka.eu-isoe-west-1.cloud.adc-e.uk" - } - }, - "params": { - "Region": "eu-isoe-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kafka-fips.us-isof-south-1.csp.hci.ic.gov" - } - }, - "params": { - "Region": "us-isof-south-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kafka.us-isof-south-1.csp.hci.ic.gov" - } - }, - "params": { - "Region": "us-isof-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kafka-api.us-gov-west-1.api.aws" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kafka.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kafka-api.us-gov-west-1.api.aws" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kafka.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } - } - ], - "version": "1.0" -} \ No newline at end of file diff --git a/tools/code-generation/api-descriptions/kafka/2018-11-14/examples-1.json b/tools/code-generation/api-descriptions/kafka/2018-11-14/examples-1.json deleted file mode 100644 index 8acba10e1426..000000000000 --- a/tools/code-generation/api-descriptions/kafka/2018-11-14/examples-1.json +++ /dev/null @@ -1,224 +0,0 @@ -{ - "version": "1.0", - "examples": { - "CreateChannel": [ - { - "input": { - "clusterArn": "arn:aws:kafka:us-east-1:111122223333:cluster/example-cluster/abcd1234-a123-4b56-c789-abc0def9012a-1", - "channelName": "example-s3-channel", - "topicConfigurationList": [ - { - "topicArn": "arn:aws:kafka:us-east-1:111122223333:topic/example-cluster/abcd1234-a123-4b56-c789-abc0def9012a-1/example-topic", - "recordConverter": { - "valueConverter": "STRING" - } - } - ], - "s3DestinationConfiguration": { - "serviceExecutionRoleArn": "arn:aws:iam::111122223333:role/example-channel-execution-role", - "dataFreshnessInSeconds": 300, - "deadLetterQueueS3": { - "bucketArn": "arn:aws:s3:::example-dlq-bucket", - "errorOutputPrefix": "errorPrefix/", - "expectedBucketOwner": "111122223333" - }, - "storage": { - "bucketArn": "arn:aws:s3:::example-destination-bucket", - "compressionType": "GZIP", - "storageClass": "STANDARD", - "outputPrefix": "channel-output/", - "outputKeyTemplate": "!{channel-id}/!{topic-name}/year=!{yyyy}/month=!{MM}/day=!{dd}/hour=!{HH}/minute=!{mm}/!{topic-name}+!{partition-id}+!{sequence-number}", - "expectedBucketOwner": "111122223333" - } - } - }, - "output": { - "channelArn": "arn:aws:kafka:us-east-1:111122223333:channel/example-cluster/abcd1234-a123-4b56-c789-abc0def9012a-1/example-s3-channel", - "clusterOperationArn": "arn:aws:kafka:us-east-1:111122223333:cluster-operation/example-cluster/abcd1234-a123-4b56-c789-abc0def9012a-1/1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following example creates a data channel that delivers records from a Kafka topic to an Amazon S3 destination.", - "id": "to-create-an-s3-data-channel-1700000000000", - "title": "To create a data channel with an Amazon S3 destination" - }, - { - "input": { - "clusterArn": "arn:aws:kafka:us-east-1:111122223333:cluster/example-cluster/abcd1234-a123-4b56-c789-abc0def9012a-1", - "channelName": "example-iceberg-channel", - "topicConfigurationList": [ - { - "topicArn": "arn:aws:kafka:us-east-1:111122223333:topic/example-cluster/abcd1234-a123-4b56-c789-abc0def9012a-1/example-topic", - "recordConverter": { - "valueConverter": "JSON" - }, - "recordSchema": { - "gsrArn": "arn:aws:glue:us-east-1:111122223333:registry/example-registry" - } - } - ], - "icebergDestinationConfiguration": { - "appendOnly": true, - "catalog": { - "catalogArn": "arn:aws:glue:us-east-1:111122223333:catalog", - "warehouseLocation": "s3://example-warehouse-bucket/warehouse/" - }, - "tableCreation": { - "enableTableCreation": true - }, - "schemaEvolution": { - "enableSchemaEvolution": false - }, - "destinationTableList": [ - { - "destinationDatabaseName": "example_database", - "destinationTableName": "example_table", - "partitionSpec": { - "partitionStrategy": "TIME_HOUR", - "sourceList": [ - { - "sourceName": "event_timestamp" - } - ] - } - } - ], - "dataFreshnessInSeconds": 300, - "deadLetterQueueS3": { - "bucketArn": "arn:aws:s3:::example-dlq-bucket", - "errorOutputPrefix": "errorPrefix/", - "expectedBucketOwner": "111122223333" - }, - "serviceExecutionRoleArn": "arn:aws:iam::111122223333:role/example-channel-execution-role" - } - }, - "output": { - "channelArn": "arn:aws:kafka:us-east-1:111122223333:channel/example-cluster/abcd1234-a123-4b56-c789-abc0def9012a-1/example-iceberg-channel", - "clusterOperationArn": "arn:aws:kafka:us-east-1:111122223333:cluster-operation/example-cluster/abcd1234-a123-4b56-c789-abc0def9012a-1/2b3c4d5e-6f7a-8b9c-0d1e-2f3a4b5c6d7e" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following example creates a data channel that delivers records from a Kafka topic to an Apache Iceberg destination.", - "id": "to-create-an-iceberg-data-channel-1700000000001", - "title": "To create a data channel with an Apache Iceberg destination" - } - ], - "DescribeChannel": [ - { - "input": { - "clusterArn": "arn:aws:kafka:us-east-1:111122223333:cluster/example-cluster/abcd1234-a123-4b56-c789-abc0def9012a-1", - "channelArn": "arn:aws:kafka:us-east-1:111122223333:channel/example-cluster/abcd1234-a123-4b56-c789-abc0def9012a-1/example-s3-channel" - }, - "output": { - "channelArn": "arn:aws:kafka:us-east-1:111122223333:channel/example-cluster/abcd1234-a123-4b56-c789-abc0def9012a-1/example-s3-channel", - "channelName": "example-s3-channel", - "status": "ACTIVE", - "destinationType": "S3", - "creationTime": "2024-01-15T12:00:00.000Z", - "topicConfigurationList": [ - { - "topicArn": "arn:aws:kafka:us-east-1:111122223333:topic/example-cluster/abcd1234-a123-4b56-c789-abc0def9012a-1/example-topic", - "recordConverter": { - "valueConverter": "STRING" - } - } - ], - "s3DestinationConfiguration": { - "serviceExecutionRoleArn": "arn:aws:iam::111122223333:role/example-channel-execution-role", - "dataFreshnessInSeconds": 300, - "deadLetterQueueS3": { - "bucketArn": "arn:aws:s3:::example-dlq-bucket", - "errorOutputPrefix": "errorPrefix/", - "expectedBucketOwner": "111122223333" - }, - "storage": { - "bucketArn": "arn:aws:s3:::example-destination-bucket", - "compressionType": "GZIP", - "storageClass": "STANDARD", - "outputPrefix": "channel-output/", - "expectedBucketOwner": "111122223333" - } - } - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following example returns the configuration and current state of a data channel.", - "id": "to-describe-a-data-channel-1700000000002", - "title": "To describe a data channel" - } - ], - "ListChannels": [ - { - "input": { - "clusterArn": "arn:aws:kafka:us-east-1:111122223333:cluster/example-cluster/abcd1234-a123-4b56-c789-abc0def9012a-1", - "maxResults": 10 - }, - "output": { - "channels": [ - { - "channelArn": "arn:aws:kafka:us-east-1:111122223333:channel/example-cluster/abcd1234-a123-4b56-c789-abc0def9012a-1/example-s3-channel", - "channelName": "example-s3-channel", - "status": "ACTIVE", - "destinationType": "S3", - "creationTime": "2024-01-15T12:00:00.000Z" - } - ] - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following example lists the data channels in a cluster.", - "id": "to-list-data-channels-1700000000003", - "title": "To list the data channels in a cluster" - } - ], - "UpdateChannel": [ - { - "input": { - "clusterArn": "arn:aws:kafka:us-east-1:111122223333:cluster/example-cluster/abcd1234-a123-4b56-c789-abc0def9012a-1", - "channelArn": "arn:aws:kafka:us-east-1:111122223333:channel/example-cluster/abcd1234-a123-4b56-c789-abc0def9012a-1/example-s3-channel", - "s3DestinationUpdate": { - "dataFreshnessInSeconds": 600 - } - }, - "output": { - "channelArn": "arn:aws:kafka:us-east-1:111122223333:channel/example-cluster/abcd1234-a123-4b56-c789-abc0def9012a-1/example-s3-channel", - "clusterOperationArn": "arn:aws:kafka:us-east-1:111122223333:cluster-operation/example-cluster/abcd1234-a123-4b56-c789-abc0def9012a-1/3c4d5e6f-7a8b-9c0d-1e2f-3a4b5c6d7e8f" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following example updates the destination configuration of an existing data channel with an Amazon S3 destination.", - "id": "to-update-a-data-channel-1700000000004", - "title": "To update a data channel" - } - ], - "DeleteChannel": [ - { - "input": { - "clusterArn": "arn:aws:kafka:us-east-1:111122223333:cluster/example-cluster/abcd1234-a123-4b56-c789-abc0def9012a-1", - "channelArn": "arn:aws:kafka:us-east-1:111122223333:channel/example-cluster/abcd1234-a123-4b56-c789-abc0def9012a-1/example-s3-channel" - }, - "output": { - "channelArn": "arn:aws:kafka:us-east-1:111122223333:channel/example-cluster/abcd1234-a123-4b56-c789-abc0def9012a-1/example-s3-channel", - "clusterOperationArn": "arn:aws:kafka:us-east-1:111122223333:cluster-operation/example-cluster/abcd1234-a123-4b56-c789-abc0def9012a-1/4d5e6f7a-8b9c-0d1e-2f3a-4b5c6d7e8f9a" - }, - "comments": { - "input": {}, - "output": {} - }, - "description": "The following example deletes a data channel from a cluster.", - "id": "to-delete-a-data-channel-1700000000005", - "title": "To delete a data channel" - } - ] - } -} diff --git a/tools/code-generation/api-descriptions/kafka/2018-11-14/paginators-1.json b/tools/code-generation/api-descriptions/kafka/2018-11-14/paginators-1.json deleted file mode 100644 index 8c39b168bad7..000000000000 --- a/tools/code-generation/api-descriptions/kafka/2018-11-14/paginators-1.json +++ /dev/null @@ -1,88 +0,0 @@ -{ - "pagination": { - "ListClusters": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "ClusterInfoList" - }, - "ListClustersV2": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "ClusterInfoList" - }, - "ListConfigurations": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "Configurations" - }, - "ListKafkaVersions": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "KafkaVersions" - }, - "ListNodes": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "NodeInfoList" - }, - "ListClusterOperations": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "ClusterOperationInfoList" - }, - "ListClusterOperationsV2": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "ClusterOperationInfoList" - }, - "ListConfigurationRevisions": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "Revisions" - }, - "ListReplicators": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "Replicators" - }, - "ListScramSecrets": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "SecretArnList" - }, - "ListVpcConnections": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "VpcConnections" - }, - "ListClientVpcConnections": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "ClientVpcConnections" - }, - "ListTopics": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "Topics" - }, - "DescribeTopicPartitions": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "Partitions" - } - } -} diff --git a/tools/code-generation/api-descriptions/kafka/2018-11-14/service-2.json b/tools/code-generation/api-descriptions/kafka/2018-11-14/service-2.json deleted file mode 100644 index cea9b9757e3b..000000000000 --- a/tools/code-generation/api-descriptions/kafka/2018-11-14/service-2.json +++ /dev/null @@ -1,9349 +0,0 @@ -{ - "metadata": { - "apiVersion": "2018-11-14", - "endpointPrefix": "kafka", - "signingName": "kafka", - "serviceFullName": "Managed Streaming for Kafka", - "serviceAbbreviation": "Kafka", - "serviceId": "Kafka", - "protocol": "rest-json", - "jsonVersion": "1.1", - "uid": "kafka-2018-11-14", - "signatureVersion": "v4", - "auth": [ - "aws.auth#sigv4" - ] - }, - "operations": { - "BatchAssociateScramSecret": { - "name": "BatchAssociateScramSecret", - "http": { - "method": "POST", - "requestUri": "/v1/clusters/{clusterArn}/scram-secrets", - "responseCode": 200 - }, - "input": { - "shape": "BatchAssociateScramSecretRequest" - }, - "output": { - "shape": "BatchAssociateScramSecretResponse", - "documentation": "\n

200 response

\n " - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - }, - { - "shape": "NotFoundException", - "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " - }, - { - "shape": "ServiceUnavailableException", - "documentation": "\n

503 response

\n " - }, - { - "shape": "TooManyRequestsException", - "documentation": "\n

429 response

\n " - } - ], - "documentation": "\n

Associates one or more Scram Secrets with an Amazon MSK cluster.

\n " - }, - "CreateChannel": { - "name": "CreateChannel", - "http": { - "method": "POST", - "requestUri": "/v1/clusters/{clusterArn}/channels", - "responseCode": 200 - }, - "input": { - "shape": "CreateChannelRequest" - }, - "output": { - "shape": "CreateChannelResponse", - "documentation": "\n

200 response

\n " - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - }, - { - "shape": "NotFoundException", - "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " - }, - { - "shape": "ServiceUnavailableException", - "documentation": "\n

503 response

\n " - }, - { - "shape": "TooManyRequestsException", - "documentation": "\n

429 response

\n " - }, - { - "shape": "ConflictException", - "documentation": "\n

This cluster name already exists. Retry your request using another name.

\n " - } - ], - "documentation": "

Creates a Channel that streams records from an Amazon MSK Express cluster topic to Amazon S3 or Apache Iceberg.

", - "idempotent": true - }, - "CreateCluster": { - "name": "CreateCluster", - "http": { - "method": "POST", - "requestUri": "/v1/clusters", - "responseCode": 200 - }, - "input": { - "shape": "CreateClusterRequest" - }, - "output": { - "shape": "CreateClusterResponse" - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - }, - { - "shape": "ServiceUnavailableException", - "documentation": "\n

503 response

\n " - }, - { - "shape": "TooManyRequestsException", - "documentation": "\n

429 response

\n " - }, - { - "shape": "ConflictException", - "documentation": "\n

This cluster name already exists. Retry your request using another name.

\n " - } - ], - "documentation": "\n

Creates a new MSK cluster.

\n " - }, - "CreateClusterV2": { - "name": "CreateClusterV2", - "http": { - "method": "POST", - "requestUri": "/api/v2/clusters", - "responseCode": 200 - }, - "input": { - "shape": "CreateClusterV2Request" - }, - "output": { - "shape": "CreateClusterV2Response" - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - }, - { - "shape": "ServiceUnavailableException", - "documentation": "\n

503 response

\n " - }, - { - "shape": "TooManyRequestsException", - "documentation": "\n

429 response

\n " - }, - { - "shape": "ConflictException", - "documentation": "\n

This cluster name already exists. Retry your request using another name.

\n " - } - ], - "documentation": "\n

Creates a new MSK cluster.

\n " - }, - "CreateConfiguration": { - "name": "CreateConfiguration", - "http": { - "method": "POST", - "requestUri": "/v1/configurations", - "responseCode": 200 - }, - "input": { - "shape": "CreateConfigurationRequest" - }, - "output": { - "shape": "CreateConfigurationResponse", - "documentation": "\n

200 response

\n " - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - }, - { - "shape": "ServiceUnavailableException", - "documentation": "\n

503 response

\n " - }, - { - "shape": "TooManyRequestsException", - "documentation": "\n

429 response

\n " - }, - { - "shape": "ConflictException", - "documentation": "\n

This cluster name already exists. Retry your request using another name.

\n " - } - ], - "documentation": "\n

Creates a new MSK configuration.

\n " - }, - "CreateReplicator": { - "name": "CreateReplicator", - "http": { - "method": "POST", - "requestUri": "/replication/v1/replicators", - "responseCode": 200 - }, - "input": { - "shape": "CreateReplicatorRequest" - }, - "output": { - "shape": "CreateReplicatorResponse", - "documentation": "

HTTP Status Code 200: OK.

" - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "

HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.

" - }, - { - "shape": "UnauthorizedException", - "documentation": "

HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.

" - }, - { - "shape": "InternalServerErrorException", - "documentation": "

HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

" - }, - { - "shape": "ForbiddenException", - "documentation": "

HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.

" - }, - { - "shape": "NotFoundException", - "documentation": "

HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.

" - }, - { - "shape": "ServiceUnavailableException", - "documentation": "

HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.

" - }, - { - "shape": "TooManyRequestsException", - "documentation": "

HTTP Status Code 429: Limit exceeded. Resource limit reached.

" - }, - { - "shape": "ConflictException", - "documentation": "

HTTP Status Code 409: Conflict. This replicator name already exists. Retry your request with another name.

" - } - ], - "documentation": "

Creates the replicator.

" - }, - "CreateTopic": { - "name": "CreateTopic", - "http": { - "method": "POST", - "requestUri": "/v1/clusters/{clusterArn}/topics", - "responseCode": 200 - }, - "input": { - "shape": "CreateTopicRequest" - }, - "output": { - "shape": "CreateTopicResponse", - "documentation": "\n

200 response

\n " - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - }, - { - "shape": "ServiceUnavailableException", - "documentation": "

HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.

" - }, - { - "shape": "TooManyRequestsException", - "documentation": "HTTP Status Code 429: Limit exceeded. Resource limit reached." - }, - { - "shape": "ConflictException", - "documentation": "\n

This topic name already exists in the cluster. Retry your request using another topic name.

\n " - }, - { - "shape": "TopicExistsException", - "documentation": "\n

The topic already exists in the cluster.

\n " - }, - { - "shape": "ClusterConnectivityException", - "documentation": "\n

Unable to establish a connection to the Kafka cluster.

\n " - }, - { - "shape": "KafkaTimeoutException", - "documentation": "\n

The Kafka request timed out.

\n " - }, - { - "shape": "UnknownTopicOrPartitionException", - "documentation": "\n

The specified topic or partition does not exist.

\n " - }, - { - "shape": "ControllerMovedException", - "documentation": "\n

The Kafka controller has moved.

\n " - }, - { - "shape": "NotControllerException", - "documentation": "\n

TNot Controller.

\n " - }, - { - "shape": "ReassignmentInProgressException", - "documentation": "\n

A partition reassignment is currently in progress.

\n " - }, - { - "shape": "GroupSubscribedToTopicException", - "documentation": "\n

A consumer group is currently subscribed to this topic.

\n " - }, - { - "shape": "KafkaRequestException", - "documentation": "\n

An error occurred while processing the Kafka request.

\n " - } - ], - "documentation": "\n

Creates a topic in the specified MSK cluster.

\n " - }, - "CreateVpcConnection": { - "name": "CreateVpcConnection", - "http": { - "method": "POST", - "requestUri": "/v1/vpc-connection", - "responseCode": 200 - }, - "input": { - "shape": "CreateVpcConnectionRequest" - }, - "output": { - "shape": "CreateVpcConnectionResponse", - "documentation": "\n

200 response

\n " - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - }, - { - "shape": "ServiceUnavailableException", - "documentation": "\n

503 response

\n " - }, - { - "shape": "TooManyRequestsException", - "documentation": "\n

429 response

\n " - } - ], - "documentation": "\n

Creates a new MSK VPC connection.

\n " - }, - "DeleteCluster": { - "name": "DeleteCluster", - "http": { - "method": "DELETE", - "requestUri": "/v1/clusters/{clusterArn}", - "responseCode": 200 - }, - "input": { - "shape": "DeleteClusterRequest" - }, - "output": { - "shape": "DeleteClusterResponse", - "documentation": "\n

Successful response.

\n " - }, - "errors": [ - { - "shape": "NotFoundException", - "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " - }, - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - } - ], - "documentation": "\n

Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.

\n " - }, - "DeleteChannel": { - "name": "DeleteChannel", - "http": { - "method": "DELETE", - "requestUri": "/v1/clusters/{clusterArn}/channels/{channelArn}", - "responseCode": 200 - }, - "input": { - "shape": "DeleteChannelRequest" - }, - "output": { - "shape": "DeleteChannelResponse", - "documentation": "\n

Successful response.

\n " - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - }, - { - "shape": "NotFoundException", - "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " - }, - { - "shape": "ServiceUnavailableException", - "documentation": "\n

503 response

\n " - }, - { - "shape": "TooManyRequestsException", - "documentation": "\n

429 response

\n " - } - ], - "documentation": "

Deletes the channel specified by channelArn from the cluster specified by clusterArn. The channel transitions through DELETING and is removed when the asynchronous delete completes.

", - "idempotent": true - }, - "DeleteClusterPolicy": { - "name": "DeleteClusterPolicy", - "http": { - "method": "DELETE", - "requestUri": "/v1/clusters/{clusterArn}/policy", - "responseCode": 200 - }, - "input": { - "shape": "DeleteClusterPolicyRequest" - }, - "output": { - "shape": "DeleteClusterPolicyResponse", - "documentation": "\n

Successful response.

\n " - }, - "errors": [ - { - "shape": "NotFoundException", - "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " - }, - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - } - ], - "documentation": "\n

Deletes the MSK cluster policy specified by the Amazon Resource Name (ARN) in the request.

\n " - }, - "DeleteConfiguration": { - "name": "DeleteConfiguration", - "http": { - "method": "DELETE", - "requestUri": "/v1/configurations/{arn}", - "responseCode": 200 - }, - "input": { - "shape": "DeleteConfigurationRequest" - }, - "output": { - "shape": "DeleteConfigurationResponse", - "documentation": "\n

Successful response.

\n " - }, - "errors": [ - { - "shape": "NotFoundException", - "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " - }, - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - } - ], - "documentation": "\n

Deletes an MSK Configuration.

\n " - }, - "DeleteReplicator": { - "name": "DeleteReplicator", - "http": { - "method": "DELETE", - "requestUri": "/replication/v1/replicators/{replicatorArn}", - "responseCode": 200 - }, - "input": { - "shape": "DeleteReplicatorRequest" - }, - "output": { - "shape": "DeleteReplicatorResponse", - "documentation": "HTTP Status Code 200: OK." - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "

HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.

" - }, - { - "shape": "UnauthorizedException", - "documentation": "

HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.

" - }, - { - "shape": "InternalServerErrorException", - "documentation": "

HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

" - }, - { - "shape": "ForbiddenException", - "documentation": "

HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.

" - }, - { - "shape": "NotFoundException", - "documentation": "

HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.

" - }, - { - "shape": "ServiceUnavailableException", - "documentation": "

HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.

" - }, - { - "shape": "TooManyRequestsException", - "documentation": "

HTTP Status Code 429: Limit exceeded. Resource limit reached.

" - } - ], - "documentation": "

Deletes a replicator.

" - }, - "DeleteTopic": { - "name": "DeleteTopic", - "http": { - "method": "DELETE", - "requestUri": "/v1/clusters/{clusterArn}/topics/{topicName}", - "responseCode": 200 - }, - "input": { - "shape": "DeleteTopicRequest" - }, - "output": { - "shape": "DeleteTopicResponse", - "documentation": "\n

200 response

\n " - }, - "errors": [ - { - "shape": "NotFoundException", - "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " - }, - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - }, - { - "shape": "ClusterConnectivityException", - "documentation": "\n

Unable to establish a connection to the Kafka cluster.

\n " - }, - { - "shape": "KafkaTimeoutException", - "documentation": "\n

The Kafka request timed out.

\n " - }, - { - "shape": "UnknownTopicOrPartitionException", - "documentation": "\n

The specified topic or partition does not exist.

\n " - }, - { - "shape": "ControllerMovedException", - "documentation": "\n

The Kafka controller has moved.

\n " - }, - { - "shape": "NotControllerException", - "documentation": "\n

Not Controller.

\n " - }, - { - "shape": "ReassignmentInProgressException", - "documentation": "\n

A partition reassignment is currently in progress.

\n " - }, - { - "shape": "GroupSubscribedToTopicException", - "documentation": "\n

A consumer group is currently subscribed to this topic.

\n " - }, - { - "shape": "KafkaRequestException", - "documentation": "\n

An error occurred while processing the Kafka request.

\n " - } - ], - "documentation": "\n

Deletes a topic in the specified MSK cluster.

\n " - }, - "DeleteVpcConnection": { - "name": "DeleteVpcConnection", - "http": { - "method": "DELETE", - "requestUri": "/v1/vpc-connection/{arn}", - "responseCode": 200 - }, - "input": { - "shape": "DeleteVpcConnectionRequest" - }, - "output": { - "shape": "DeleteVpcConnectionResponse", - "documentation": "\n

Successful response.

\n " - }, - "errors": [ - { - "shape": "NotFoundException", - "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " - }, - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - } - ], - "documentation": "\n

Deletes a MSK VPC connection.

\n " - }, - "DescribeCluster": { - "name": "DescribeCluster", - "http": { - "method": "GET", - "requestUri": "/v1/clusters/{clusterArn}", - "responseCode": 200 - }, - "input": { - "shape": "DescribeClusterRequest" - }, - "output": { - "shape": "DescribeClusterResponse", - "documentation": "\n

Successful response.

\n " - }, - "errors": [ - { - "shape": "NotFoundException", - "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " - }, - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - } - ], - "documentation": "\n

Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.

\n " - }, - "DescribeClusterV2": { - "name": "DescribeClusterV2", - "http": { - "method": "GET", - "requestUri": "/api/v2/clusters/{clusterArn}", - "responseCode": 200 - }, - "input": { - "shape": "DescribeClusterV2Request" - }, - "output": { - "shape": "DescribeClusterV2Response", - "documentation": "\n

Successful response.

\n " - }, - "errors": [ - { - "shape": "NotFoundException", - "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " - }, - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - } - ], - "documentation": "\n

Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.

\n " - }, - "DescribeChannel": { - "name": "DescribeChannel", - "http": { - "method": "GET", - "requestUri": "/v1/clusters/{clusterArn}/channels/{channelArn}", - "responseCode": 200 - }, - "input": { - "shape": "DescribeChannelRequest" - }, - "output": { - "shape": "DescribeChannelResponse", - "documentation": "\n

Successful response.

\n " - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - }, - { - "shape": "NotFoundException", - "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " - }, - { - "shape": "ServiceUnavailableException", - "documentation": "\n

503 response

\n " - }, - { - "shape": "TooManyRequestsException", - "documentation": "\n

429 response

\n " - } - ], - "documentation": "

Returns the current configuration and state of a channel.

", - "readonly": true - }, - "DescribeClusterOperation": { - "name": "DescribeClusterOperation", - "http": { - "method": "GET", - "requestUri": "/v1/operations/{clusterOperationArn}", - "responseCode": 200 - }, - "input": { - "shape": "DescribeClusterOperationRequest" - }, - "output": { - "shape": "DescribeClusterOperationResponse", - "documentation": "\n

200 response

\n " - }, - "errors": [ - { - "shape": "NotFoundException", - "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " - }, - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - } - ], - "documentation": "\n

Returns a description of the cluster operation specified by the ARN.

\n " - }, - "DescribeClusterOperationV2": { - "name": "DescribeClusterOperationV2", - "http": { - "method": "GET", - "requestUri": "/api/v2/operations/{clusterOperationArn}", - "responseCode": 200 - }, - "input": { - "shape": "DescribeClusterOperationV2Request" - }, - "output": { - "shape": "DescribeClusterOperationV2Response", - "documentation": "\n

HTTP Status Code 200: OK.

" - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "\n

HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.

" - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.

" - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

" - }, - { - "shape": "ForbiddenException", - "documentation": "\n

HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.

" - }, - { - "shape": "NotFoundException", - "documentation": "\n

HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.

" - }, - { - "shape": "ServiceUnavailableException", - "documentation": "\n

HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.

" - }, - { - "shape": "TooManyRequestsException", - "documentation": "\n

HTTP Status Code 429: Limit exceeded. Resource limit reached.

" - } - ], - "documentation": "\n

Returns a description of the cluster operation specified by the ARN.

\n" - }, - "DescribeConfiguration": { - "name": "DescribeConfiguration", - "http": { - "method": "GET", - "requestUri": "/v1/configurations/{arn}", - "responseCode": 200 - }, - "input": { - "shape": "DescribeConfigurationRequest" - }, - "output": { - "shape": "DescribeConfigurationResponse", - "documentation": "\n

200 response

\n " - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - }, - { - "shape": "NotFoundException", - "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " - }, - { - "shape": "ServiceUnavailableException", - "documentation": "\n

503 response

\n " - } - ], - "documentation": "\n

Returns a description of this MSK configuration.

\n " - }, - "DescribeConfigurationRevision": { - "name": "DescribeConfigurationRevision", - "http": { - "method": "GET", - "requestUri": "/v1/configurations/{arn}/revisions/{revision}", - "responseCode": 200 - }, - "input": { - "shape": "DescribeConfigurationRevisionRequest" - }, - "output": { - "shape": "DescribeConfigurationRevisionResponse", - "documentation": "\n

200 response

\n " - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - }, - { - "shape": "NotFoundException", - "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " - }, - { - "shape": "ServiceUnavailableException", - "documentation": "\n

503 response

\n " - } - ], - "documentation": "\n

Returns a description of this revision of the configuration.

\n " - }, - "DescribeReplicator": { - "name": "DescribeReplicator", - "http": { - "method": "GET", - "requestUri": "/replication/v1/replicators/{replicatorArn}", - "responseCode": 200 - }, - "input": { - "shape": "DescribeReplicatorRequest" - }, - "output": { - "shape": "DescribeReplicatorResponse", - "documentation": "

HTTP Status Code 200: OK." - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "

HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.

" - }, - { - "shape": "UnauthorizedException", - "documentation": "

HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.

" - }, - { - "shape": "InternalServerErrorException", - "documentation": "

HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

" - }, - { - "shape": "ForbiddenException", - "documentation": "

HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.

" - }, - { - "shape": "NotFoundException", - "documentation": "

HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.

" - }, - { - "shape": "ServiceUnavailableException", - "documentation": "

HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.

" - }, - { - "shape": "TooManyRequestsException", - "documentation": "

HTTP Status Code 429: Limit exceeded. Resource limit reached.

" - } - ], - "documentation": "

Describes a replicator.

" - }, - "DescribeTopic": { - "name": "DescribeTopic", - "http": { - "method": "GET", - "requestUri": "/v1/clusters/{clusterArn}/topics/{topicName}", - "responseCode": 200 - }, - "input": { - "shape": "DescribeTopicRequest" - }, - "output": { - "shape": "DescribeTopicResponse", - "documentation": "\n

200 response

\n " - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - }, - { - "shape": "NotFoundException", - "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " - } - ], - "documentation": "\n

Returns topic details of this topic on a MSK cluster.

\n " - }, - "DescribeTopicPartitions": { - "name": "DescribeTopicPartitions", - "http": { - "method": "GET", - "requestUri": "/v1/clusters/{clusterArn}/topics/{topicName}/partitions", - "responseCode": 200 - }, - "input": { - "shape": "DescribeTopicPartitionsRequest" - }, - "output": { - "shape": "DescribeTopicPartitionsResponse", - "documentation": "\n

200 response

\n " - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - }, - { - "shape": "NotFoundException", - "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " - } - ], - "documentation": "\n

Returns partition details of this topic on a MSK cluster.

\n " - }, - "DescribeVpcConnection": { - "name": "DescribeVpcConnection", - "http": { - "method": "GET", - "requestUri": "/v1/vpc-connection/{arn}", - "responseCode": 200 - }, - "input": { - "shape": "DescribeVpcConnectionRequest" - }, - "output": { - "shape": "DescribeVpcConnectionResponse", - "documentation": "\n

200 response

\n " - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - }, - { - "shape": "NotFoundException", - "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " - }, - { - "shape": "ServiceUnavailableException", - "documentation": "\n

503 response

\n " - } - ], - "documentation": "\n

Returns a description of this MSK VPC connection.

\n " - }, - "BatchDisassociateScramSecret": { - "name": "BatchDisassociateScramSecret", - "http": { - "method": "PATCH", - "requestUri": "/v1/clusters/{clusterArn}/scram-secrets", - "responseCode": 200 - }, - "input": { - "shape": "BatchDisassociateScramSecretRequest" - }, - "output": { - "shape": "BatchDisassociateScramSecretResponse", - "documentation": "\n

200 response

\n " - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - }, - { - "shape": "NotFoundException", - "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " - }, - { - "shape": "ServiceUnavailableException", - "documentation": "\n

503 response

\n " - }, - { - "shape": "TooManyRequestsException", - "documentation": "\n

429 response

\n " - } - ], - "documentation": "\n

Disassociates one or more Scram Secrets from an Amazon MSK cluster.

\n " - }, - "GetBootstrapBrokers": { - "name": "GetBootstrapBrokers", - "http": { - "method": "GET", - "requestUri": "/v1/clusters/{clusterArn}/bootstrap-brokers", - "responseCode": 200 - }, - "input": { - "shape": "GetBootstrapBrokersRequest" - }, - "output": { - "shape": "GetBootstrapBrokersResponse", - "documentation": "\n

Successful response.

\n " - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ConflictException", - "documentation": "\n

This cluster name already exists. Retry your request using another name.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - } - ], - "documentation": "\n

A list of brokers that a client application can use to bootstrap. This list doesn't necessarily include all of the brokers in the cluster. The following Python 3.6 example shows how you can use the Amazon Resource Name (ARN) of a cluster to get its bootstrap brokers. If you don't know the ARN of your cluster, you can use the ListClusters operation to get the ARNs of all the clusters in this account and Region.

\n " - }, - "GetCompatibleKafkaVersions": { - "name": "GetCompatibleKafkaVersions", - "http": { - "method": "GET", - "requestUri": "/v1/compatible-kafka-versions", - "responseCode": 200 - }, - "input": { - "shape": "GetCompatibleKafkaVersionsRequest" - }, - "output": { - "shape": "GetCompatibleKafkaVersionsResponse", - "documentation": "\n

Successful response.

\n " - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

n " - }, - { - "shape": "UnauthorizedException", - "documentation": "n

The request is not authorized. The provided credentials couldn't be validated.

n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "n

There was an unexpected internal server error. Retrying your request might resolve the issue.

n " - }, - { - "shape": "ForbiddenException", - "documentation": "n

Access forbidden. Check your credentials and then retry your request.

n " - }, - { - "shape": "NotFoundException", - "documentation": "n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

n " - }, - { - "shape": "ServiceUnavailableException", - "documentation": "n

503 response

n " - }, - { - "shape": "TooManyRequestsException", - "documentation": "n

429 response

n " - } - ], - "documentation": "\n

Gets the Apache Kafka versions to which you can update the MSK cluster.

\n " - }, - "GetClusterPolicy": { - "name": "GetClusterPolicy", - "http": { - "method": "GET", - "requestUri": "/v1/clusters/{clusterArn}/policy", - "responseCode": 200 - }, - "input": { - "shape": "GetClusterPolicyRequest" - }, - "output": { - "shape": "GetClusterPolicyResponse", - "documentation": "\n

Successful response.

\n " - }, - "errors": [ - { - "shape": "NotFoundException", - "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " - }, - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - } - ], - "documentation": "\n

Get the MSK cluster policy specified by the Amazon Resource Name (ARN) in the request.

\n " - }, - "ListClusterOperations": { - "name": "ListClusterOperations", - "http": { - "method": "GET", - "requestUri": "/v1/clusters/{clusterArn}/operations", - "responseCode": 200 - }, - "input": { - "shape": "ListClusterOperationsRequest" - }, - "output": { - "shape": "ListClusterOperationsResponse", - "documentation": "\n

Successful response.

\n " - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - } - ], - "documentation": "\n

Returns a list of all the operations that have been performed on the specified MSK cluster.

\n " - }, - "ListClusterOperationsV2": { - "name": "ListClusterOperationsV2", - "http": { - "method": "GET", - "requestUri": "/api/v2/clusters/{clusterArn}/operations", - "responseCode": 200 - }, - "input": { - "shape": "ListClusterOperationsV2Request" - }, - "output": { - "shape": "ListClusterOperationsV2Response", - "documentation": "\n

HTTP Status Code 200: OK.

" - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "\n

HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.

" - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.

" - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

" - }, - { - "shape": "ForbiddenException", - "documentation": "\n

HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.

" - }, - { - "shape": "NotFoundException", - "documentation": "\n

HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.

" - }, - { - "shape": "ServiceUnavailableException", - "documentation": "\n

HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.

" - }, - { - "shape": "TooManyRequestsException", - "documentation": "\n

HTTP Status Code 429: Limit exceeded. Resource limit reached.

" - } - ], - "documentation": "\n

Returns a list of all the operations that have been performed on the specified MSK cluster.

\n " - }, - "ListClusters": { - "name": "ListClusters", - "http": { - "method": "GET", - "requestUri": "/v1/clusters", - "responseCode": 200 - }, - "input": { - "shape": "ListClustersRequest" - }, - "output": { - "shape": "ListClustersResponse", - "documentation": "\n

Successful response.

\n " - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - } - ], - "documentation": "\n

Returns a list of all the MSK clusters in the current Region.

\n " - }, - "ListClustersV2": { - "name": "ListClustersV2", - "http": { - "method": "GET", - "requestUri": "/api/v2/clusters", - "responseCode": 200 - }, - "input": { - "shape": "ListClustersV2Request" - }, - "output": { - "shape": "ListClustersV2Response", - "documentation": "\n

Successful response.

\n " - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - } - ], - "documentation": "\n

Returns a list of all the MSK clusters in the current Region.

\n " - }, - "ListChannels": { - "name": "ListChannels", - "http": { - "method": "GET", - "requestUri": "/v1/clusters/{clusterArn}/channels", - "responseCode": 200 - }, - "input": { - "shape": "ListChannelsRequest" - }, - "output": { - "shape": "ListChannelsResponse", - "documentation": "\n

Successful response.

\n " - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - }, - { - "shape": "NotFoundException", - "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " - }, - { - "shape": "ServiceUnavailableException", - "documentation": "\n

503 response

\n " - }, - { - "shape": "TooManyRequestsException", - "documentation": "\n

429 response

\n " - } - ], - "documentation": "

Returns the list of channels in a cluster.

", - "readonly": true - }, - "ListConfigurationRevisions": { - "name": "ListConfigurationRevisions", - "http": { - "method": "GET", - "requestUri": "/v1/configurations/{arn}/revisions", - "responseCode": 200 - }, - "input": { - "shape": "ListConfigurationRevisionsRequest" - }, - "output": { - "shape": "ListConfigurationRevisionsResponse", - "documentation": "\n

200 response

\n " - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - }, - { - "shape": "NotFoundException", - "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " - }, - { - "shape": "ServiceUnavailableException", - "documentation": "\n

503 response

\n " - } - ], - "documentation": "\n

Returns a list of all the MSK configurations in this Region.

\n " - }, - "ListConfigurations": { - "name": "ListConfigurations", - "http": { - "method": "GET", - "requestUri": "/v1/configurations", - "responseCode": 200 - }, - "input": { - "shape": "ListConfigurationsRequest" - }, - "output": { - "shape": "ListConfigurationsResponse", - "documentation": "\n

200 response

\n " - }, - "errors": [ - { - "shape": "ServiceUnavailableException", - "documentation": "\n

503 response

\n " - }, - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - } - ], - "documentation": "\n

Returns a list of all the MSK configurations in this Region.

\n " - }, - "ListKafkaVersions": { - "name": "ListKafkaVersions", - "http": { - "method": "GET", - "requestUri": "/v1/kafka-versions", - "responseCode": 200 - }, - "input": { - "shape": "ListKafkaVersionsRequest" - }, - "output": { - "shape": "ListKafkaVersionsResponse" - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - } - ], - "documentation": "\n

Returns a list of Apache Kafka versions.

\n " - }, - "ListNodes": { - "name": "ListNodes", - "http": { - "method": "GET", - "requestUri": "/v1/clusters/{clusterArn}/nodes", - "responseCode": 200 - }, - "input": { - "shape": "ListNodesRequest" - }, - "output": { - "shape": "ListNodesResponse", - "documentation": "\n

Successful response.

\n " - }, - "errors": [ - { - "shape": "NotFoundException", - "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " - }, - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - } - ], - "documentation": "\n

Returns a list of the broker nodes in the cluster.

\n " - }, - "ListReplicators": { - "name": "ListReplicators", - "http": { - "method": "GET", - "requestUri": "/replication/v1/replicators", - "responseCode": 200 - }, - "input": { - "shape": "ListReplicatorsRequest" - }, - "output": { - "shape": "ListReplicatorsResponse", - "documentation": "HTTP Status Code 200: OK." - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "

HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.

" - }, - { - "shape": "UnauthorizedException", - "documentation": "

HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.

" - }, - { - "shape": "InternalServerErrorException", - "documentation": "

HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

" - }, - { - "shape": "ForbiddenException", - "documentation": "

HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.

" - }, - { - "shape": "NotFoundException", - "documentation": "

HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.

" - }, - { - "shape": "ServiceUnavailableException", - "documentation": "

HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.

" - }, - { - "shape": "TooManyRequestsException", - "documentation": "

HTTP Status Code 429: Limit exceeded. Resource limit reached.

" - } - ], - "documentation": "

Lists the replicators.

" - }, - "ListScramSecrets": { - "name": "ListScramSecrets", - "http": { - "method": "GET", - "requestUri": "/v1/clusters/{clusterArn}/scram-secrets", - "responseCode": 200 - }, - "input": { - "shape": "ListScramSecretsRequest" - }, - "output": { - "shape": "ListScramSecretsResponse", - "documentation": "\n

200 response

\n " - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - }, - { - "shape": "NotFoundException", - "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " - }, - { - "shape": "ServiceUnavailableException", - "documentation": "\n

503 response

\n " - }, - { - "shape": "TooManyRequestsException", - "documentation": "\n

429 response

\n " - } - ], - "documentation": "\n

Returns a list of the Scram Secrets associated with an Amazon MSK cluster.

\n " - }, - "ListTagsForResource": { - "name": "ListTagsForResource", - "http": { - "method": "GET", - "requestUri": "/v1/tags/{resourceArn}", - "responseCode": 200 - }, - "input": { - "shape": "ListTagsForResourceRequest" - }, - "output": { - "shape": "ListTagsForResourceResponse", - "documentation": "\n

Success response.

\n " - }, - "errors": [ - { - "shape": "NotFoundException", - "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " - }, - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - } - ], - "documentation": "\n

Returns a list of the tags associated with the specified resource.

\n " - }, - "ListClientVpcConnections": { - "name": "ListClientVpcConnections", - "http": { - "method": "GET", - "requestUri": "/v1/clusters/{clusterArn}/client-vpc-connections", - "responseCode": 200 - }, - "input": { - "shape": "ListClientVpcConnectionsRequest" - }, - "output": { - "shape": "ListClientVpcConnectionsResponse", - "documentation": "\n

200 response

\n " - }, - "errors": [ - { - "shape": "ServiceUnavailableException", - "documentation": "\n

503 response

\n " - }, - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - } - ], - "documentation": "\n

Returns a list of all the VPC connections in this Region.

\n " - }, - "ListTopics": { - "name": "ListTopics", - "http": { - "method": "GET", - "requestUri": "/v1/clusters/{clusterArn}/topics", - "responseCode": 200 - }, - "input": { - "shape": "ListTopicsRequest" - }, - "output": { - "shape": "ListTopicsResponse", - "documentation": "\n

200 response

\n " - }, - "errors": [ - { - "shape": "ServiceUnavailableException", - "documentation": "\n

503 response

\n " - }, - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - } - ], - "documentation": "\n

List topics in a MSK cluster.

\n " - }, - "ListVpcConnections": { - "name": "ListVpcConnections", - "http": { - "method": "GET", - "requestUri": "/v1/vpc-connections", - "responseCode": 200 - }, - "input": { - "shape": "ListVpcConnectionsRequest" - }, - "output": { - "shape": "ListVpcConnectionsResponse", - "documentation": "\n

200 response

\n " - }, - "errors": [ - { - "shape": "ServiceUnavailableException", - "documentation": "\n

503 response

\n " - }, - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - } - ], - "documentation": "\n

Returns a list of all the VPC connections in this Region.

\n " - }, - "RejectClientVpcConnection": { - "name": "RejectClientVpcConnection", - "http": { - "method": "PUT", - "requestUri": "/v1/clusters/{clusterArn}/client-vpc-connection", - "responseCode": 200 - }, - "input": { - "shape": "RejectClientVpcConnectionRequest" - }, - "output": { - "shape": "RejectClientVpcConnectionResponse", - "documentation": "\n

200 response

\n " - }, - "errors": [ - { - "shape": "ServiceUnavailableException", - "documentation": "\n

503 response

\n " - }, - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - } - ], - "documentation": "\n

Returns empty response.

\n " - }, - "PutClusterPolicy": { - "name": "PutClusterPolicy", - "http": { - "method": "PUT", - "requestUri": "/v1/clusters/{clusterArn}/policy", - "responseCode": 200 - }, - "input": { - "shape": "PutClusterPolicyRequest" - }, - "output": { - "shape": "PutClusterPolicyResponse", - "documentation": "\n

Successful response.

\n " - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - } - ], - "documentation": "\n

Creates or updates the MSK cluster policy specified by the cluster Amazon Resource Name (ARN) in the request.

\n " - }, - "RebootBroker": { - "name": "RebootBroker", - "http": { - "method": "PUT", - "requestUri": "/v1/clusters/{clusterArn}/reboot-broker", - "responseCode": 200 - }, - "input": { - "shape": "RebootBrokerRequest" - }, - "output": { - "shape": "RebootBrokerResponse", - "documentation": "\n

Successful response.

\n " - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - }, - { - "shape": "NotFoundException", - "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " - }, - { - "shape": "ServiceUnavailableException", - "documentation": "\n

503 response

\n " - }, - { - "shape": "TooManyRequestsException", - "documentation": "\n

429 response

\n " - } - ], - "documentation": "Reboots brokers." - }, - "TagResource": { - "name": "TagResource", - "http": { - "method": "POST", - "requestUri": "/v1/tags/{resourceArn}", - "responseCode": 204 - }, - "input": { - "shape": "TagResourceRequest" - }, - "errors": [ - { - "shape": "NotFoundException", - "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " - }, - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - } - ], - "documentation": "\n

Adds tags to the specified MSK resource.

\n " - }, - "UntagResource": { - "name": "UntagResource", - "http": { - "method": "DELETE", - "requestUri": "/v1/tags/{resourceArn}", - "responseCode": 204 - }, - "input": { - "shape": "UntagResourceRequest" - }, - "errors": [ - { - "shape": "NotFoundException", - "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " - }, - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - } - ], - "documentation": "\n

Removes the tags associated with the keys that are provided in the query.

\n " - }, - "UpdateBrokerCount": { - "name": "UpdateBrokerCount", - "http": { - "method": "PUT", - "requestUri": "/v1/clusters/{clusterArn}/nodes/count", - "responseCode": 200 - }, - "input": { - "shape": "UpdateBrokerCountRequest" - }, - "output": { - "shape": "UpdateBrokerCountResponse", - "documentation": "\n

Successful response.

\n " - }, - "errors": [ - { - "shape": "ServiceUnavailableException", - "documentation": "\n

503 response

\n " - }, - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - } - ], - "documentation": "\n

Updates the number of broker nodes in the cluster.

\n " - }, - "UpdateBrokerType": { - "name": "UpdateBrokerType", - "http": { - "method": "PUT", - "requestUri": "/v1/clusters/{clusterArn}/nodes/type", - "responseCode": 200 - }, - "input": { - "shape": "UpdateBrokerTypeRequest" - }, - "output": { - "shape": "UpdateBrokerTypeResponse", - "documentation": "\n

Successful response.

\n " - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - }, - { - "shape": "NotFoundException", - "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " - }, - { - "shape": "ServiceUnavailableException", - "documentation": "\n

503 response

\n " - }, - { - "shape": "TooManyRequestsException", - "documentation": "\n

429 response

\n " - } - ], - "documentation": "\n

Updates EC2 instance type.

\n " - }, - "UpdateBrokerStorage": { - "name": "UpdateBrokerStorage", - "http": { - "method": "PUT", - "requestUri": "/v1/clusters/{clusterArn}/nodes/storage", - "responseCode": 200 - }, - "input": { - "shape": "UpdateBrokerStorageRequest" - }, - "output": { - "shape": "UpdateBrokerStorageResponse", - "documentation": "\n

Successful response.

\n " - }, - "errors": [ - { - "shape": "ServiceUnavailableException", - "documentation": "\n

503 response

\n " - }, - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - } - ], - "documentation": "\n

Updates the EBS storage associated with MSK brokers.

\n " - }, - "UpdateConfiguration": { - "name": "UpdateConfiguration", - "http": { - "method": "PUT", - "requestUri": "/v1/configurations/{arn}", - "responseCode": 200 - }, - "input": { - "shape": "UpdateConfigurationRequest" - }, - "output": { - "shape": "UpdateConfigurationResponse", - "documentation": "\n

200 response

\n " - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - }, - { - "shape": "NotFoundException", - "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " - }, - { - "shape": "ServiceUnavailableException", - "documentation": "\n

503 response

\n " - } - ], - "documentation": "\n

Updates an MSK configuration.

\n " - }, - "UpdateConnectivity": { - "name": "UpdateConnectivity", - "http": { - "method": "PUT", - "requestUri": "/v1/clusters/{clusterArn}/connectivity", - "responseCode": 200 - }, - "input": { - "shape": "UpdateConnectivityRequest" - }, - "output": { - "shape": "UpdateConnectivityResponse", - "documentation": "\n

Successful response.

\n " - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - }, - { - "shape": "NotFoundException", - "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " - }, - { - "shape": "ServiceUnavailableException", - "documentation": "\n

503 response

\n " - } - ], - "documentation": "\n

Updates the cluster's connectivity configuration.

\n " - }, - "UpdateChannel": { - "name": "UpdateChannel", - "http": { - "method": "PUT", - "requestUri": "/v1/clusters/{clusterArn}/channels/{channelArn}", - "responseCode": 200 - }, - "input": { - "shape": "UpdateChannelRequest" - }, - "output": { - "shape": "UpdateChannelResponse" - }, - "errors": [ - { - "shape": "BadRequestException" - }, - { - "shape": "UnauthorizedException" - }, - { - "shape": "InternalServerErrorException" - }, - { - "shape": "ForbiddenException" - }, - { - "shape": "NotFoundException" - }, - { - "shape": "ServiceUnavailableException" - }, - { - "shape": "TooManyRequestsException" - } - ], - "documentation": "

Updates the destination configuration of an existing channel. Exactly one of icebergDestinationUpdate or s3DestinationUpdate must be supplied.

", - "idempotent": true - }, - "UpdateClusterConfiguration": { - "name": "UpdateClusterConfiguration", - "http": { - "method": "PUT", - "requestUri": "/v1/clusters/{clusterArn}/configuration", - "responseCode": 200 - }, - "input": { - "shape": "UpdateClusterConfigurationRequest" - }, - "output": { - "shape": "UpdateClusterConfigurationResponse", - "documentation": "\n

Successful response.

\n " - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - }, - { - "shape": "NotFoundException", - "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " - }, - { - "shape": "ServiceUnavailableException", - "documentation": "\n

503 response

\n " - } - ], - "documentation": "\n

Updates the cluster with the configuration that is specified in the request body.

\n " - }, - "UpdateClusterKafkaVersion": { - "name": "UpdateClusterKafkaVersion", - "http": { - "method": "PUT", - "requestUri": "/v1/clusters/{clusterArn}/version", - "responseCode": 200 - }, - "input": { - "shape": "UpdateClusterKafkaVersionRequest" - }, - "output": { - "shape": "UpdateClusterKafkaVersionResponse", - "documentation": "\n

Successful response.

\n " - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - }, - { - "shape": "NotFoundException", - "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " - }, - { - "shape": "ServiceUnavailableException", - "documentation": "\n

503 response

\n " - }, - { - "shape": "TooManyRequestsException", - "documentation": "\n

429 response

\n " - } - ], - "documentation": "\n

Updates the Apache Kafka version for the cluster.

\n " - }, - "UpdateMonitoring": { - "name": "UpdateMonitoring", - "http": { - "method": "PUT", - "requestUri": "/v1/clusters/{clusterArn}/monitoring", - "responseCode": 200 - }, - "input": { - "shape": "UpdateMonitoringRequest" - }, - "output": { - "shape": "UpdateMonitoringResponse", - "documentation": "\n

HTTP Status Code 200: OK.

\n " - }, - "errors": [ - { - "shape": "ServiceUnavailableException", - "documentation": "\n

503 response

\n " - }, - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - } - ], - "documentation": "\n

Updates the monitoring settings for the cluster. You can use this operation to specify which Apache Kafka metrics you want Amazon MSK to send to Amazon CloudWatch. You can also specify settings for open monitoring with Prometheus.

\n " - }, - "UpdateRebalancing": { - "name": "UpdateRebalancing", - "http": { - "method": "PUT", - "requestUri": "/v1/clusters/{clusterArn}/rebalancing", - "responseCode": 200 - }, - "input": { - "shape": "UpdateRebalancingRequest" - }, - "output": { - "shape": "UpdateRebalancingResponse", - "documentation": "\n

HTTP Status Code 200: OK.

\n " - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - }, - { - "shape": "NotFoundException", - "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " - }, - { - "shape": "ServiceUnavailableException", - "documentation": "\n

The service cannot complete the request.

\n " - }, - { - "shape": "TooManyRequestsException", - "documentation": "\n

The request throughput limit was exceeded.

\n " - } - ], - "documentation": "\n

Use this resource to update the intelligent rebalancing status of an Amazon MSK Provisioned cluster with Express brokers.

\n " - }, - "UpdateReplicationInfo": { - "name": "UpdateReplicationInfo", - "http": { - "method": "PUT", - "requestUri": "/replication/v1/replicators/{replicatorArn}/replication-info", - "responseCode": 200 - }, - "input": { - "shape": "UpdateReplicationInfoRequest" - }, - "output": { - "shape": "UpdateReplicationInfoResponse", - "documentation": "HTTP Status Code 200: OK." - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "

HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.

" - }, - { - "shape": "UnauthorizedException", - "documentation": "

HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.

" - }, - { - "shape": "InternalServerErrorException", - "documentation": "

HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

" - }, - { - "shape": "ForbiddenException", - "documentation": "

HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.

" - }, - { - "shape": "NotFoundException", - "documentation": "

HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.

" - }, - { - "shape": "ServiceUnavailableException", - "documentation": "

HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.

" - }, - { - "shape": "TooManyRequestsException", - "documentation": "

HTTP Status Code 429: Limit exceeded. Resource limit reached.

" - } - ], - "documentation": "

Updates replication info of a replicator.

" - }, - "UpdateSecurity": { - "name": "UpdateSecurity", - "http": { - "method": "PATCH", - "requestUri": "/v1/clusters/{clusterArn}/security", - "responseCode": 200 - }, - "input": { - "shape": "UpdateSecurityRequest" - }, - "output": { - "shape": "UpdateSecurityResponse" - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - }, - { - "shape": "NotFoundException", - "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " - }, - { - "shape": "ServiceUnavailableException", - "documentation": "\n

The service cannot complete the request.

\n " - }, - { - "shape": "TooManyRequestsException", - "documentation": "\n

The request throughput limit was exceeded.

\n " - } - ], - "documentation": "\n

Updates the security settings for the cluster. You can use this operation to specify encryption and authentication on existing clusters.

\n " - }, - "UpdateStorage": { - "name": "UpdateStorage", - "http": { - "method": "PUT", - "requestUri": "/v1/clusters/{clusterArn}/storage", - "responseCode": 200 - }, - "input": { - "shape": "UpdateStorageRequest" - }, - "output": { - "shape": "UpdateStorageResponse", - "documentation": "HTTP Status Code 200: OK." - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it." - }, - { - "shape": "UnauthorizedException", - "documentation": "HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated." - }, - { - "shape": "InternalServerErrorException", - "documentation": "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue." - }, - { - "shape": "ForbiddenException", - "documentation": "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request." - }, - { - "shape": "NotFoundException", - "documentation": "HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it." - }, - { - "shape": "ServiceUnavailableException", - "documentation": "HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue." - }, - { - "shape": "TooManyRequestsException", - "documentation": "HTTP Status Code 429: Limit exceeded. Resource limit reached." - } - ], - "documentation": "Updates cluster broker volume size (or) sets cluster storage mode to TIERED." - }, - "UpdateTopic": { - "name": "UpdateTopic", - "http": { - "method": "PUT", - "requestUri": "/v1/clusters/{clusterArn}/topics/{topicName}", - "responseCode": 200 - }, - "input": { - "shape": "UpdateTopicRequest" - }, - "output": { - "shape": "UpdateTopicResponse", - "documentation": "\n

200 response

\n " - }, - "errors": [ - { - "shape": "BadRequestException", - "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " - }, - { - "shape": "UnauthorizedException", - "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " - }, - { - "shape": "InternalServerErrorException", - "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " - }, - { - "shape": "ForbiddenException", - "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " - }, - { - "shape": "NotFoundException", - "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " - }, - { - "shape": "ServiceUnavailableException", - "documentation": "\n

503 response

\n " - }, - { - "shape": "ClusterConnectivityException", - "documentation": "\n

Unable to establish a connection to the Kafka cluster.

\n " - }, - { - "shape": "KafkaTimeoutException", - "documentation": "\n

The Kafka request timed out.

\n " - }, - { - "shape": "UnknownTopicOrPartitionException", - "documentation": "\n

The specified topic or partition does not exist.

\n " - }, - { - "shape": "ControllerMovedException", - "documentation": "\n

The Kafka controller has moved.

\n " - }, - { - "shape": "NotControllerException", - "documentation": "\n

Not Controller

\n " - }, - { - "shape": "ReassignmentInProgressException", - "documentation": "\n

A partition reassignment is currently in progress.

\n " - }, - { - "shape": "GroupSubscribedToTopicException", - "documentation": "\n

A consumer group is currently subscribed to this topic.

\n " - }, - { - "shape": "KafkaRequestException", - "documentation": "\n

An error occurred while processing the Kafka request.

\n " - } - ], - "documentation": "\n

Updates the configuration of the specified topic.

\n " - } - }, - "shapes": { - "AmazonMskCluster": { - "type": "structure", - "members": { - "MskClusterArn": { - "shape": "__string", - "locationName": "mskClusterArn", - "documentation": "

The Amazon Resource Name (ARN) of an Amazon MSK cluster.

" - } - }, - "documentation": "

Details of an Amazon MSK Cluster.

", - "required": [ - "MskClusterArn" - ] - }, - "ApacheKafkaCluster": { - "type": "structure", - "members": { - "ApacheKafkaClusterId": { - "shape": "__string", - "locationName": "apacheKafkaClusterId", - "documentation": "

The ID of the Apache Kafka cluster.

" - }, - "BootstrapBrokerString": { - "shape": "__string", - "locationName": "bootstrapBrokerString", - "documentation": "

The bootstrap broker string of the Apache Kafka cluster.

" - } - }, - "documentation": "

Details of an Apache Kafka Cluster.

", - "required": [ - "ApacheKafkaClusterId", - "BootstrapBrokerString" - ] - }, - "BatchAssociateScramSecretRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster to be updated.

\n " - }, - "SecretArnList": { - "shape": "__listOf__string", - "locationName": "secretArnList", - "documentation": "\n

List of AWS Secrets Manager secret ARNs.

\n " - } - }, - "documentation": "\n

Associates sasl scram secrets to cluster.

\n ", - "required": [ - "ClusterArn", - "SecretArnList" - ] - }, - "BatchAssociateScramSecretResponse": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster.

\n " - }, - "UnprocessedScramSecrets": { - "shape": "__listOfUnprocessedScramSecret", - "locationName": "unprocessedScramSecrets", - "documentation": "\n

List of errors when associating secrets to cluster.

\n " - } - } - }, - "BadRequestException": { - "type": "structure", - "members": { - "InvalidParameter": { - "shape": "__string", - "locationName": "invalidParameter", - "documentation": "\n

The parameter that caused the error.

\n " - }, - "Message": { - "shape": "__string", - "locationName": "message", - "documentation": "\n

The description of the error.

\n " - } - }, - "documentation": "\n

Returns information about an error.

\n ", - "exception": true, - "error": { - "httpStatusCode": 400 - } - }, - "BrokerAZDistribution": { - "type": "string", - "documentation": "\n

The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed.

\n

Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster.

\n ", - "enum": [ - "DEFAULT" - ] - }, - "BrokerCountUpdateInfo": { - "type": "structure", - "members": { - "CreatedBrokerIds": { - "shape": "__listOf__double", - "locationName": "createdBrokerIds", - "documentation": "\n

Kafka Broker IDs of brokers being created.

\n " - }, - "DeletedBrokerIds": { - "shape": "__listOf__double", - "locationName": "deletedBrokerIds", - "documentation": "\n

Kafka Broker IDs of brokers being deleted.

\n " - } - }, - "documentation": "\n

Information regarding UpdateBrokerCount.

\n " - }, - "BrokerEBSVolumeInfo": { - "type": "structure", - "members": { - "KafkaBrokerNodeId": { - "shape": "__string", - "locationName": "kafkaBrokerNodeId", - "documentation": "\n

The ID of the broker to update.

\n " - }, - "ProvisionedThroughput": { - "shape": "ProvisionedThroughput", - "locationName": "provisionedThroughput", - "documentation": "\n

EBS volume provisioned throughput information.

\n " - }, - "VolumeSizeGB": { - "shape": "__integer", - "locationName": "volumeSizeGB", - "documentation": "\n

Size of the EBS volume to update.

\n " - } - }, - "documentation": "\n

Specifies the EBS volume upgrade information. The broker identifier must be set to the keyword ALL. This means the changes apply to all the brokers in the cluster.

\n ", - "required": [ - "KafkaBrokerNodeId" - ] - }, - "BrokerLogs": { - "type": "structure", - "members": { - "CloudWatchLogs": { - "shape": "CloudWatchLogs", - "locationName": "cloudWatchLogs" - }, - "Firehose": { - "shape": "Firehose", - "locationName": "firehose" - }, - "S3": { - "shape": "S3", - "locationName": "s3" - } - } - }, - "Rebalancing": { - "type": "structure", - "documentation": "\n

Specifies whether or not intelligent rebalancing is turned on for a newly created MSK Provisioned cluster with Express brokers. Intelligent rebalancing performs automatic partition balancing operations when you scale your clusters up or down. By default, intelligent rebalancing is ACTIVE for all new Express-based clusters.

\n ", - "members": { - "Status": { - "shape": "RebalancingStatus", - "locationName": "status", - "documentation": "\n

Intelligent rebalancing status. The default intelligent rebalancing status is ACTIVE for all new Express-based clusters.

\n " - } - } - }, - "RebalancingStatus": { - "type": "string", - "documentation": "\n

Intelligent rebalancing status. The default intelligent rebalancing status is ACTIVE for all new Express-based clusters.

\n ", - "enum": [ - "PAUSED", - "ACTIVE" - ] - }, - "BrokerNodeGroupInfo": { - "type": "structure", - "members": { - "BrokerAZDistribution": { - "shape": "BrokerAZDistribution", - "locationName": "brokerAZDistribution", - "documentation": "\n

The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed.

\n

Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster.

\n " - }, - "ClientSubnets": { - "shape": "__listOf__string", - "locationName": "clientSubnets", - "documentation": "\n

The list of subnets to connect to in the client virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets. Client applications use elastic network interfaces to produce and consume data. Client subnets can't occupy the Availability Zone with ID use use1-az3.

\n " - }, - "InstanceType": { - "shape": "__stringMin5Max32", - "locationName": "instanceType", - "documentation": "\n

The type of Amazon EC2 instances to use for Apache Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge,\nkafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.

\n " - }, - "SecurityGroups": { - "shape": "__listOf__string", - "locationName": "securityGroups", - "documentation": "\n

The AWS security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC.

\n " - }, - "StorageInfo": { - "shape": "StorageInfo", - "locationName": "storageInfo", - "documentation": "\n

Contains information about storage volumes attached to MSK broker nodes.

\n " - }, - "ConnectivityInfo": { - "shape": "ConnectivityInfo", - "locationName": "connectivityInfo", - "documentation": "\n

Information about the broker access configuration.

\n " - }, - "ZoneIds": { - "shape": "__listOf__string", - "locationName": "zoneIds", - "documentation": "\n

The list of zoneIds for the cluster in the virtual private cloud (VPC).

\n " - } - }, - "documentation": "\n

Describes the setup to be used for Apache Kafka broker nodes in the cluster.

\n ", - "required": [ - "ClientSubnets", - "InstanceType" - ] - }, - "BrokerNodeInfo": { - "type": "structure", - "members": { - "AttachedENIId": { - "shape": "__string", - "locationName": "attachedENIId", - "documentation": "\n

The attached elastic network interface of the broker.

\n " - }, - "BrokerId": { - "shape": "__double", - "locationName": "brokerId", - "documentation": "\n

The ID of the broker.

\n " - }, - "ClientSubnet": { - "shape": "__string", - "locationName": "clientSubnet", - "documentation": "\n

The client subnet to which this broker node belongs.

\n " - }, - "ClientVpcIpAddress": { - "shape": "__string", - "locationName": "clientVpcIpAddress", - "documentation": "\n

The virtual private cloud (VPC) of the client.

\n " - }, - "CurrentBrokerSoftwareInfo": { - "shape": "BrokerSoftwareInfo", - "locationName": "currentBrokerSoftwareInfo", - "documentation": "\n

Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.

\n " - }, - "Endpoints": { - "shape": "__listOf__string", - "locationName": "endpoints", - "documentation": "\n

Endpoints for accessing the broker.

\n " - } - }, - "documentation": "\n

BrokerNodeInfo

\n " - }, - "BrokerSoftwareInfo": { - "type": "structure", - "members": { - "ConfigurationArn": { - "shape": "__string", - "locationName": "configurationArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release.

\n " - }, - "ConfigurationRevision": { - "shape": "__long", - "locationName": "configurationRevision", - "documentation": "\n

The revision of the configuration to use. This field isn't visible in this preview release.

\n " - }, - "KafkaVersion": { - "shape": "__string", - "locationName": "kafkaVersion", - "documentation": "\n

The version of Apache Kafka.

\n " - } - }, - "documentation": "\n

Information about the current software installed on the cluster.

\n " - }, - "Catalog": { - "type": "structure", - "members": { - "CatalogArn": { - "shape": "__string", - "locationName": "catalogArn", - "documentation": "

The Amazon Resource Name (ARN) of the federated AWS Glue Data Catalog that projects the S3 Tables bucket. If omitted, MSK derives the catalog ARN from warehouseLocation.

" - }, - "WarehouseLocation": { - "shape": "__string", - "locationName": "warehouseLocation", - "documentation": "

The Amazon Resource Name (ARN) of the S3 Tables bucket that backs the Apache Iceberg warehouse.

" - } - }, - "documentation": "

Configuration of the AWS Glue Data Catalog and S3 Tables warehouse used by the Apache Iceberg destination.

" - }, - "ChannelInfo": { - "type": "structure", - "members": { - "ChannelArn": { - "shape": "__string", - "locationName": "channelArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the channel.

\n " - }, - "ChannelName": { - "shape": "__string", - "locationName": "channelName", - "documentation": "

The name of the channel.

" - }, - "Status": { - "shape": "ChannelStatus", - "locationName": "status", - "documentation": "

The current lifecycle state of the channel.

" - }, - "CreationTime": { - "shape": "__timestampIso8601", - "locationName": "creationTime", - "documentation": "\n

The time when the channel was created.

\n " - }, - "DestinationType": { - "shape": "ChannelDestinationType", - "locationName": "destinationType", - "documentation": "

The type of destination configured for the channel.

" - }, - "ClusterOperationArn": { - "shape": "__string", - "locationName": "clusterOperationArn", - "documentation": "

The Amazon Resource Name (ARN) of the in-flight cluster operation. Returned only while the channel is in CREATING, UPDATING, or DELETING.

" - } - }, - "documentation": "

Summary information about a channel returned by ListChannels.

", - "required": [ - "ChannelArn", - "ChannelName", - "Status", - "CreationTime", - "DestinationType" - ] - }, - "ChannelStatus": { - "type": "string", - "documentation": "

The lifecycle state of a channel.

", - "enum": [ - "CREATING", - "ACTIVE", - "UPDATING", - "DELETING", - "FAILED", - "SUSPENDING", - "SUSPENDED" - ] - }, - "ChannelDestinationType": { - "type": "string", - "documentation": "

The type of destination configured for the channel.

", - "enum": [ - "ICEBERG", - "S3" - ] - }, - "ChannelStateInfo": { - "type": "structure", - "members": { - "Code": { - "shape": "__string", - "locationName": "code", - "documentation": "

A short, machine-readable code identifying the failure cause.

" - }, - "Message": { - "shape": "__string", - "locationName": "message", - "documentation": "

A human-readable message describing the failure.

" - } - }, - "documentation": "

Additional context for the current channel state, populated when the channel is in FAILED.

" - }, - "ClientAuthentication": { - "type": "structure", - "members": { - "Sasl": { - "shape": "Sasl", - "locationName": "sasl", - "documentation": "\n

Details for ClientAuthentication using SASL.

\n " - }, - "Tls": { - "shape": "Tls", - "locationName": "tls", - "documentation": "\n

Details for ClientAuthentication using TLS.

\n " - }, - "Unauthenticated": { - "shape": "Unauthenticated", - "locationName": "unauthenticated", - "documentation": "\n

Contains information about unauthenticated traffic to the cluster.

\n " - } - }, - "documentation": "\n

Includes all client authentication information.

\n " - }, - "VpcConnectivityClientAuthentication": { - "type": "structure", - "members": { - "Sasl": { - "shape": "VpcConnectivitySasl", - "locationName": "sasl", - "documentation": "\n

SASL authentication type details for VPC connectivity.

\n " - }, - "Tls": { - "shape": "VpcConnectivityTls", - "locationName": "tls", - "documentation": "\n

TLS authentication type details for VPC connectivity.

\n " - } - }, - "documentation": "\n

Includes all client authentication information for VPC connectivity.

\n " - }, - "ServerlessClientAuthentication": { - "type": "structure", - "members": { - "Sasl": { - "shape": "ServerlessSasl", - "locationName": "sasl", - "documentation": "\n

Details for ClientAuthentication using SASL.

\n " - } - }, - "documentation": "\n

Includes all client authentication information.

\n " - }, - "ClientBroker": { - "type": "string", - "documentation": "\n

Client-broker encryption in transit setting.

\n ", - "enum": [ - "TLS", - "TLS_PLAINTEXT", - "PLAINTEXT" - ] - }, - "CloudWatchLogs": { - "type": "structure", - "members": { - "Enabled": { - "shape": "__boolean", - "locationName": "enabled" - }, - "LogGroup": { - "shape": "__string", - "locationName": "logGroup" - } - }, - "required": [ - "Enabled" - ] - }, - "ClusterInfo": { - "type": "structure", - "members": { - "ActiveOperationArn": { - "shape": "__string", - "locationName": "activeOperationArn", - "documentation": "\n

Arn of active cluster operation.

\n " - }, - "BrokerNodeGroupInfo": { - "shape": "BrokerNodeGroupInfo", - "locationName": "brokerNodeGroupInfo", - "documentation": "\n

Information about the broker nodes.

\n " - }, - "Rebalancing": { - "shape": "Rebalancing", - "locationName": "rebalancing", - "documentation": "\n

Contains information about intelligent rebalancing for new MSK Provisioned clusters with Express brokers. By default, intelligent rebalancing status is ACTIVE.

\n " - }, - "ClientAuthentication": { - "shape": "ClientAuthentication", - "locationName": "clientAuthentication", - "documentation": "\n

Includes all client authentication information.

\n " - }, - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

\n " - }, - "ClusterName": { - "shape": "__string", - "locationName": "clusterName", - "documentation": "\n

The name of the cluster.

\n " - }, - "CreationTime": { - "shape": "__timestampIso8601", - "locationName": "creationTime", - "documentation": "\n

The time when the cluster was created.

\n " - }, - "CurrentBrokerSoftwareInfo": { - "shape": "BrokerSoftwareInfo", - "locationName": "currentBrokerSoftwareInfo", - "documentation": "\n

Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.

\n " - }, - "CurrentVersion": { - "shape": "__string", - "locationName": "currentVersion", - "documentation": "\n

The current version of the MSK cluster.

\n " - }, - "EncryptionInfo": { - "shape": "EncryptionInfo", - "locationName": "encryptionInfo", - "documentation": "\n

Includes all encryption-related information.

\n " - }, - "EnhancedMonitoring": { - "shape": "EnhancedMonitoring", - "locationName": "enhancedMonitoring", - "documentation": "\n

Specifies which metrics are gathered for the MSK cluster. This property has the following possible values: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. For a list of the metrics associated with each of these levels of monitoring, see Monitoring.

\n " - }, - "OpenMonitoring": { - "shape": "OpenMonitoring", - "locationName": "openMonitoring", - "documentation": "\n

Settings for open monitoring using Prometheus.

\n " - }, - "LoggingInfo": { - "shape": "LoggingInfo", - "locationName": "loggingInfo" - }, - "NumberOfBrokerNodes": { - "shape": "__integer", - "locationName": "numberOfBrokerNodes", - "documentation": "\n

The number of broker nodes in the cluster.

\n " - }, - "State": { - "shape": "ClusterState", - "locationName": "state", - "documentation": "\n

The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

\n " - }, - "StateInfo": { - "shape": "StateInfo", - "locationName": "stateInfo" - }, - "Tags": { - "shape": "__mapOf__string", - "locationName": "tags", - "documentation": "\n

Tags attached to the cluster.

\n " - }, - "ZookeeperConnectString": { - "shape": "__string", - "locationName": "zookeeperConnectString", - "documentation": "\n

The connection string to use to connect to the Apache ZooKeeper cluster.

\n " - }, - "ZookeeperConnectStringTls": { - "shape": "__string", - "locationName": "zookeeperConnectStringTls", - "documentation": "\n

The connection string to use to connect to zookeeper cluster on Tls port.

\n " - }, - "StorageMode": { - "shape": "StorageMode", - "locationName": "storageMode", - "documentation": "\n

This controls storage mode for supported storage tiers.

\n " - }, - "CustomerActionStatus": { - "shape": "CustomerActionStatus", - "locationName": "customerActionStatus", - "documentation": "\n

Determines if there is an action required from the customer.

\n " - } - }, - "documentation": "\n

Returns information about a cluster.

\n " - }, - "Cluster": { - "type": "structure", - "members": { - "ActiveOperationArn": { - "shape": "__string", - "locationName": "activeOperationArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies a cluster operation.

\n " - }, - "ClusterType": { - "shape": "ClusterType", - "locationName": "clusterType", - "documentation": "\n

Cluster Type.

\n " - }, - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

\n " - }, - "ClusterName": { - "shape": "__string", - "locationName": "clusterName", - "documentation": "\n

The name of the cluster.

\n " - }, - "CreationTime": { - "shape": "__timestampIso8601", - "locationName": "creationTime", - "documentation": "\n

The time when the cluster was created.

\n " - }, - "CurrentVersion": { - "shape": "__string", - "locationName": "currentVersion", - "documentation": "\n

The current version of the MSK cluster.

\n " - }, - "State": { - "shape": "ClusterState", - "locationName": "state", - "documentation": "\n

The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

\n " - }, - "StateInfo": { - "shape": "StateInfo", - "locationName": "stateInfo", - "documentation": "\n

State Info for the Amazon MSK cluster.

\n " - }, - "Tags": { - "shape": "__mapOf__string", - "locationName": "tags", - "documentation": "\n

Tags attached to the cluster.

\n " - }, - "Provisioned": { - "shape": "Provisioned", - "locationName": "provisioned", - "documentation": "\n

Information about the provisioned cluster.

\n " - }, - "Serverless": { - "shape": "Serverless", - "locationName": "serverless", - "documentation": "\n

Information about the serverless cluster.

\n " - } - }, - "documentation": "\n

Returns information about a cluster.

\n " - }, - "ClusterOperationInfo": { - "type": "structure", - "members": { - "ClientRequestId": { - "shape": "__string", - "locationName": "clientRequestId", - "documentation": "\n

The ID of the API request that triggered this operation.

\n " - }, - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn", - "documentation": "\n

ARN of the cluster.

\n " - }, - "CreationTime": { - "shape": "__timestampIso8601", - "locationName": "creationTime", - "documentation": "\n

The time that the operation was created.

\n " - }, - "EndTime": { - "shape": "__timestampIso8601", - "locationName": "endTime", - "documentation": "\n

The time at which the operation finished.

\n " - }, - "ErrorInfo": { - "shape": "ErrorInfo", - "locationName": "errorInfo", - "documentation": "\n

Describes the error if the operation fails.

\n " - }, - "OperationArn": { - "shape": "__string", - "locationName": "operationArn", - "documentation": "\n

ARN of the cluster operation.

\n " - }, - "OperationState": { - "shape": "__string", - "locationName": "operationState", - "documentation": "\n

State of the cluster operation.

\n " - }, - "OperationSteps": { - "shape": "__listOfClusterOperationStep", - "locationName": "operationSteps", - "documentation": "\n

Steps completed during the operation.

\n " - }, - "OperationType": { - "shape": "__string", - "locationName": "operationType", - "documentation": "\n

Type of the cluster operation.

\n " - }, - "SourceClusterInfo": { - "shape": "MutableClusterInfo", - "locationName": "sourceClusterInfo", - "documentation": "\n

Information about cluster attributes before a cluster is updated.

\n " - }, - "TargetClusterInfo": { - "shape": "MutableClusterInfo", - "locationName": "targetClusterInfo", - "documentation": "\n

Information about cluster attributes after a cluster is updated.

\n " - }, - "VpcConnectionInfo": { - "shape": "VpcConnectionInfo", - "locationName": "vpcConnectionInfo", - "documentation": "\n

Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.

\n " - } - }, - "documentation": "\n

Returns information about a cluster operation.

\n " - }, - "ClusterOperationStep": { - "type": "structure", - "members": { - "StepInfo": { - "shape": "ClusterOperationStepInfo", - "locationName": "stepInfo", - "documentation": "\n

Information about the step and its status.

\n " - }, - "StepName": { - "shape": "__string", - "locationName": "stepName", - "documentation": "\n

The name of the step.

\n " - } - }, - "documentation": "\n

Step taken during a cluster operation.

\n " - }, - "ClusterOperationStepInfo": { - "type": "structure", - "members": { - "StepStatus": { - "shape": "__string", - "locationName": "stepStatus", - "documentation": "\n

The steps current status.

\n " - } - }, - "documentation": "\n

State information about the operation step.

\n " - }, - "ClusterState": { - "type": "string", - "documentation": "\n

The state of the Apache Kafka cluster.

\n ", - "enum": [ - "ACTIVE", - "CREATING", - "DELETING", - "FAILED", - "HEALING", - "MAINTENANCE", - "REBOOTING_BROKER", - "UPDATING" - ] - }, - "ClusterType": { - "type": "string", - "documentation": "\n

The type of cluster.

\n ", - "enum": [ - "PROVISIONED", - "SERVERLESS" - ] - }, - "ProvisionedRequest": { - "type": "structure", - "documentation": "\n

Provisioned cluster request.

\n ", - "members": { - "BrokerNodeGroupInfo": { - "shape": "BrokerNodeGroupInfo", - "locationName": "brokerNodeGroupInfo", - "documentation": "\n

Information about the brokers.

\n " - }, - "Rebalancing": { - "shape": "Rebalancing", - "locationName": "rebalancing", - "documentation": "\n

Specifies if intelligent rebalancing is turned on for your MSK Provisioned cluster with Express brokers. For all new Express-based clusters that you create, intelligent rebalancing is turned on by default.

\n " - }, - "ClientAuthentication": { - "shape": "ClientAuthentication", - "locationName": "clientAuthentication", - "documentation": "\n

Includes all client authentication information.

\n " - }, - "ConfigurationInfo": { - "shape": "ConfigurationInfo", - "locationName": "configurationInfo", - "documentation": "\n

Represents the configuration that you want Amazon MSK to use for the brokers in a cluster.

\n " - }, - "EncryptionInfo": { - "shape": "EncryptionInfo", - "locationName": "encryptionInfo", - "documentation": "\n

Includes all encryption-related information.

\n " - }, - "EnhancedMonitoring": { - "shape": "EnhancedMonitoring", - "locationName": "enhancedMonitoring", - "documentation": "\n

Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.

\n " - }, - "OpenMonitoring": { - "shape": "OpenMonitoringInfo", - "locationName": "openMonitoring", - "documentation": "\n

The settings for open monitoring.

\n " - }, - "KafkaVersion": { - "shape": "__stringMin1Max128", - "locationName": "kafkaVersion", - "documentation": "\n

The Apache Kafka version that you want for the cluster.

\n " - }, - "LoggingInfo": { - "shape": "LoggingInfo", - "locationName": "loggingInfo", - "documentation": "\n

Log delivery information for the cluster.

\n " - }, - "NumberOfBrokerNodes": { - "shape": "__integerMin1Max15", - "locationName": "numberOfBrokerNodes", - "documentation": "\n

The number of broker nodes in the cluster.

\n " - }, - "StorageMode": { - "shape": "StorageMode", - "locationName": "storageMode", - "documentation": "\n

This controls storage mode for supported storage tiers.

\n " - } - }, - "required": [ - "BrokerNodeGroupInfo", - "KafkaVersion", - "NumberOfBrokerNodes" - ] - }, - "Provisioned": { - "type": "structure", - "documentation": "\n

Provisioned cluster.

\n ", - "members": { - "BrokerNodeGroupInfo": { - "shape": "BrokerNodeGroupInfo", - "locationName": "brokerNodeGroupInfo", - "documentation": "\n

Information about the brokers.

\n " - }, - "Rebalancing": { - "shape": "Rebalancing", - "locationName": "rebalancing", - "documentation": "\n

Specifies whether or not intelligent rebalancing is turned on for a newly created MSK Provisioned cluster with Express brokers. Intelligent rebalancing performs automatic partition balancing operations when you scale your clusters up or down. By default, intelligent rebalancing is ACTIVE for all new Express-based clusters.

\n " - }, - "CurrentBrokerSoftwareInfo": { - "shape": "BrokerSoftwareInfo", - "locationName": "currentBrokerSoftwareInfo", - "documentation": "\n

Information about the Apache Kafka version deployed on the brokers.

\n " - }, - "ClientAuthentication": { - "shape": "ClientAuthentication", - "locationName": "clientAuthentication", - "documentation": "\n

Includes all client authentication information.

\n " - }, - "EncryptionInfo": { - "shape": "EncryptionInfo", - "locationName": "encryptionInfo", - "documentation": "\n

Includes all encryption-related information.

\n " - }, - "EnhancedMonitoring": { - "shape": "EnhancedMonitoring", - "locationName": "enhancedMonitoring", - "documentation": "\n

Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.

\n " - }, - "OpenMonitoring": { - "shape": "OpenMonitoringInfo", - "locationName": "openMonitoring", - "documentation": "\n

The settings for open monitoring.

\n " - }, - "LoggingInfo": { - "shape": "LoggingInfo", - "locationName": "loggingInfo", - "documentation": "\n

Log delivery information for the cluster.

\n " - }, - "NumberOfBrokerNodes": { - "shape": "__integerMin1Max15", - "locationName": "numberOfBrokerNodes", - "documentation": "\n

The number of broker nodes in the cluster.

\n " - }, - "ZookeeperConnectString": { - "shape": "__string", - "locationName": "zookeeperConnectString", - "documentation": "\n

The connection string to use to connect to the Apache ZooKeeper cluster.

\n " - }, - "ZookeeperConnectStringTls": { - "shape": "__string", - "locationName": "zookeeperConnectStringTls", - "documentation": "\n

The connection string to use to connect to the Apache ZooKeeper cluster on a TLS port.

\n " - }, - "StorageMode": { - "shape": "StorageMode", - "locationName": "storageMode", - "documentation": "\n

This controls storage mode for supported storage tiers.

\n " - }, - "CustomerActionStatus": { - "shape": "CustomerActionStatus", - "locationName": "customerActionStatus", - "documentation": "\n

Determines if there is an action required from the customer.

\n " - } - }, - "required": [ - "BrokerNodeGroupInfo", - "NumberOfBrokerNodes" - ] - }, - "VpcConfig": { - "type": "structure", - "documentation": "\n

The configuration of the Amazon VPCs for the cluster.

\n ", - "members": { - "SubnetIds": { - "shape": "__listOf__string", - "locationName": "subnetIds", - "documentation": "\n

The IDs of the subnets associated with the cluster.

\n " - }, - "SecurityGroupIds": { - "shape": "__listOf__string", - "locationName": "securityGroupIds", - "documentation": "\n

The IDs of the security groups associated with the cluster.

\n " - } - }, - "required": [ - "SubnetIds" - ] - }, - "ServerlessRequest": { - "type": "structure", - "documentation": "\n

Serverless cluster request.

\n ", - "members": { - "VpcConfigs": { - "shape": "__listOfVpcConfig", - "locationName": "vpcConfigs", - "documentation": "\n

The configuration of the Amazon VPCs for the cluster.

\n " - }, - "ClientAuthentication": { - "shape": "ServerlessClientAuthentication", - "locationName": "clientAuthentication", - "documentation": "\n

Includes all client authentication information.

\n " - } - }, - "required": [ - "VpcConfigs" - ] - }, - "ServerlessConnectivityInfo": { - "type": "structure", - "documentation": "\n

Describes the cluster's connectivity information, such as its network type, which is IPv4 or DUAL.

\n ", - "members": { - "NetworkType": { - "shape": "NetworkType", - "locationName": "networkType", - "documentation": "\n

The network type of the cluster, which is IPv4 or DUAL. The DUAL network type uses both IPv4 and IPv6 addresses for your cluster and its resources.

By default, a cluster uses the IPv4 network type.

\n " - } - } - }, - "Serverless": { - "type": "structure", - "documentation": "\n

Serverless cluster.

\n ", - "members": { - "VpcConfigs": { - "shape": "__listOfVpcConfig", - "locationName": "vpcConfigs", - "documentation": "\n

The configuration of the Amazon VPCs for the cluster.

\n " - }, - "ClientAuthentication": { - "shape": "ServerlessClientAuthentication", - "locationName": "clientAuthentication", - "documentation": "\n

Includes all client authentication information.

\n " - }, - "ConnectivityInfo": { - "shape": "ServerlessConnectivityInfo", - "locationName": "connectivityInfo", - "documentation": "\n

Describes the cluster's connectivity information, such as its network type, which is IPv4 or DUAL.

\n " - } - }, - "required": [ - "VpcConfigs" - ] - }, - "ClientVpcConnection": { - "type": "structure", - "documentation": "\n

The client VPC connection object.

\n ", - "members": { - "Authentication": { - "shape": "__string", - "locationName": "authentication", - "documentation": "\n

Information about the auth scheme of Vpc Connection.

\n " - }, - "CreationTime": { - "shape": "__timestampIso8601", - "locationName": "creationTime", - "documentation": "\n

Creation time of the Vpc Connection.

\n " - }, - "State": { - "shape": "VpcConnectionState", - "locationName": "state", - "documentation": "\n

State of the Vpc Connection.

\n " - }, - "VpcConnectionArn": { - "shape": "__string", - "locationName": "vpcConnectionArn", - "documentation": "\n

The ARN that identifies the Vpc Connection.

\n " - }, - "Owner": { - "shape": "__string", - "locationName": "owner", - "documentation": "\n

The Owner of the Vpc Connection.

\n " - } - }, - "required": [ - "VpcConnectionArn" - ] - }, - "VpcConnection": { - "type": "structure", - "documentation": "\n

The VPC connection object.

\n ", - "members": { - "VpcConnectionArn": { - "shape": "__string", - "locationName": "vpcConnectionArn", - "documentation": "\n

The ARN that identifies the Vpc Connection.

\n " - }, - "TargetClusterArn": { - "shape": "__string", - "locationName": "targetClusterArn", - "documentation": "\n

The ARN that identifies the Cluster which the Vpc Connection belongs to.

\n " - }, - "CreationTime": { - "shape": "__timestampIso8601", - "locationName": "creationTime", - "documentation": "\n

Creation time of the Vpc Connection.

\n " - }, - "Authentication": { - "shape": "__string", - "locationName": "authentication", - "documentation": "\n

Information about the auth scheme of Vpc Connection.

\n " - }, - "VpcId": { - "shape": "__string", - "locationName": "vpcId", - "documentation": "\n

The vpcId that belongs to the Vpc Connection.

\n " - }, - "State": { - "shape": "VpcConnectionState", - "locationName": "state", - "documentation": "\n

State of the Vpc Connection.

\n " - } - }, - "required": [ - "VpcConnectionArn", - "TargetClusterArn" - ] - }, - "CompatibleKafkaVersion": { - "type": "structure", - "members": { - "SourceVersion": { - "shape": "__string", - "locationName": "sourceVersion", - "documentation": "\n

An Apache Kafka version.

\n " - }, - "TargetVersions": { - "shape": "__listOf__string", - "locationName": "targetVersions", - "documentation": "\n

A list of Apache Kafka versions.

\n " - } - }, - "documentation": "\n

Contains source Apache Kafka versions and compatible target Apache Kafka versions.

\n " - }, - "Configuration": { - "type": "structure", - "members": { - "Arn": { - "shape": "__string", - "locationName": "arn", - "documentation": "\n

The Amazon Resource Name (ARN) of the configuration.

\n " - }, - "CreationTime": { - "shape": "__timestampIso8601", - "locationName": "creationTime", - "documentation": "\n

The time when the configuration was created.

\n " - }, - "Description": { - "shape": "__string", - "locationName": "description", - "documentation": "\n

The description of the configuration.

\n " - }, - "KafkaVersions": { - "shape": "__listOf__string", - "locationName": "kafkaVersions", - "documentation": "\n

An array of the versions of Apache Kafka with which you can use this MSK configuration. You can use this configuration for an MSK cluster only if the Apache Kafka version specified for the cluster appears in this array.

\n " - }, - "LatestRevision": { - "shape": "ConfigurationRevision", - "locationName": "latestRevision", - "documentation": "\n

Latest revision of the configuration.

\n " - }, - "Name": { - "shape": "__string", - "locationName": "name", - "documentation": "\n

The name of the configuration.

\n " - }, - "State": { - "shape": "ConfigurationState", - "locationName": "state", - "documentation": "\n

The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.

\n " - } - }, - "documentation": "\n

Represents an MSK Configuration.

\n ", - "required": [ - "Description", - "LatestRevision", - "CreationTime", - "KafkaVersions", - "Arn", - "Name", - "State" - ] - }, - "ConfigurationInfo": { - "type": "structure", - "members": { - "Arn": { - "shape": "__string", - "locationName": "arn", - "documentation": "\n

ARN of the configuration to use.

\n " - }, - "Revision": { - "shape": "__long", - "locationName": "revision", - "documentation": "\n

The revision of the configuration to use.

\n " - } - }, - "documentation": "\n

Specifies the configuration to use for the brokers.

\n ", - "required": [ - "Revision", - "Arn" - ] - }, - "ConfigurationRevision": { - "type": "structure", - "members": { - "CreationTime": { - "shape": "__timestampIso8601", - "locationName": "creationTime", - "documentation": "\n

The time when the configuration revision was created.

\n " - }, - "Description": { - "shape": "__string", - "locationName": "description", - "documentation": "\n

The description of the configuration revision.

\n " - }, - "Revision": { - "shape": "__long", - "locationName": "revision", - "documentation": "\n

The revision number.

\n " - } - }, - "documentation": "\n

Describes a configuration revision.

\n ", - "required": [ - "Revision", - "CreationTime" - ] - }, - "ConfigurationState": { - "type": "string", - "documentation": "\n

The state of a configuration.

\n ", - "enum": [ - "ACTIVE", - "DELETING", - "DELETE_FAILED" - ] - }, - "ConflictException": { - "type": "structure", - "members": { - "InvalidParameter": { - "shape": "__string", - "locationName": "invalidParameter", - "documentation": "\n

The parameter that caused the error.

\n " - }, - "Message": { - "shape": "__string", - "locationName": "message", - "documentation": "\n

The description of the error.

\n " - } - }, - "documentation": "\n

Returns information about an error.

\n ", - "exception": true, - "error": { - "httpStatusCode": 409 - } - }, - "ConnectivityInfo": { - "type": "structure", - "members": { - "PublicAccess": { - "shape": "PublicAccess", - "locationName": "publicAccess", - "documentation": "\n

Public access control for brokers.

\n " - }, - "VpcConnectivity": { - "shape": "VpcConnectivity", - "locationName": "vpcConnectivity", - "documentation": "\n

VPC connectivity access control for brokers.

\n " - }, - "NetworkType": { - "shape": "NetworkType", - "locationName": "networkType", - "documentation": "\n

The network type of the cluster, which is IPv4 or DUAL. The DUAL network type uses both IPv4 and IPv6 addresses for your cluster and its resources.

By default, a cluster uses the IPv4 network type.

\n " - } - }, - "documentation": "\n

Information about the broker access configuration.

\n " - }, - "ConsumerGroupReplication": { - "type": "structure", - "members": { - "ConsumerGroupsToExclude": { - "shape": "__listOf__stringMax256", - "locationName": "consumerGroupsToExclude", - "documentation": "

List of regular expression patterns indicating the consumer groups that should not be replicated.

" - }, - "ConsumerGroupsToReplicate": { - "shape": "__listOf__stringMax256", - "locationName": "consumerGroupsToReplicate", - "documentation": "

List of regular expression patterns indicating the consumer groups to copy.

" - }, - "DetectAndCopyNewConsumerGroups": { - "shape": "__boolean", - "locationName": "detectAndCopyNewConsumerGroups", - "documentation": "

Enables synchronization of consumer groups to target cluster.

" - }, - "SynchroniseConsumerGroupOffsets": { - "shape": "__boolean", - "locationName": "synchroniseConsumerGroupOffsets", - "documentation": "

Enables synchronization of consumer group offsets to target cluster. The translated offsets will be written to topic __consumer_offsets.

" - }, - "ConsumerGroupOffsetSyncMode": { - "shape": "ConsumerGroupOffsetSyncMode", - "locationName": "consumerGroupOffsetSyncMode", - "documentation": "

The consumer group offset synchronization mode. With LEGACY, offsets are synchronized when producers write to the source cluster. With ENHANCED, consumer offsets are synchronized regardless of producer location. ENHANCED requires a corresponding replicator that replicates data from the target cluster to the source cluster.

" - } - }, - "documentation": "

Details about consumer group replication.

", - "required": [ - "ConsumerGroupsToReplicate" - ] - }, - "ConsumerGroupOffsetSyncMode": { - "type": "string", - "documentation": "

The consumer group offset synchronization mode. With LEGACY, offsets are synchronized when producers write to the source cluster. With ENHANCED, consumer offsets are synchronized regardless of producer location. ENHANCED requires a corresponding replicator that replicates data from the target cluster to the source cluster.

", - "enum": [ - "LEGACY", - "ENHANCED" - ] - }, - "ConsumerGroupReplicationUpdate": { - "type": "structure", - "members": { - "ConsumerGroupsToExclude": { - "shape": "__listOf__stringMax256", - "locationName": "consumerGroupsToExclude", - "documentation": "

List of regular expression patterns indicating the consumer groups that should not be replicated.

" - }, - "ConsumerGroupsToReplicate": { - "shape": "__listOf__stringMax256", - "locationName": "consumerGroupsToReplicate", - "documentation": "

List of regular expression patterns indicating the consumer groups to copy.

" - }, - "DetectAndCopyNewConsumerGroups": { - "shape": "__boolean", - "locationName": "detectAndCopyNewConsumerGroups", - "documentation": "

Enables synchronization of consumer groups to target cluster.

" - }, - "SynchroniseConsumerGroupOffsets": { - "shape": "__boolean", - "locationName": "synchroniseConsumerGroupOffsets", - "documentation": "

Enables synchronization of consumer group offsets to target cluster. The translated offsets will be written to topic __consumer_offsets.

" - } - }, - "documentation": "

Details about consumer group replication.

", - "required": [ - "ConsumerGroupsToReplicate", - "ConsumerGroupsToExclude", - "SynchroniseConsumerGroupOffsets", - "DetectAndCopyNewConsumerGroups" - ] - }, - "CreateClusterV2Request": { - "type": "structure", - "members": { - "ClusterName": { - "shape": "__stringMin1Max64", - "locationName": "clusterName", - "documentation": "\n

The name of the cluster.

\n " - }, - "Tags": { - "shape": "__mapOf__string", - "locationName": "tags", - "documentation": "\n

A map of tags that you want the cluster to have.

\n " - }, - "Provisioned": { - "shape": "ProvisionedRequest", - "locationName": "provisioned", - "documentation": "\n

Information about the provisioned cluster.

\n " - }, - "Serverless": { - "shape": "ServerlessRequest", - "locationName": "serverless", - "documentation": "\n

Information about the serverless cluster.

\n " - } - }, - "required": [ - "ClusterName" - ] - }, - "CreateChannelRequest": { - "type": "structure", - "members": { - "ChannelName": { - "shape": "__string", - "locationName": "channelName", - "documentation": "

The name of the channel. Must be unique within the cluster.

" - }, - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

\n " - }, - "EncryptionConfiguration": { - "shape": "EncryptionConfiguration", - "locationName": "encryptionConfiguration", - "documentation": "

The encryption configuration applied to the channel.

" - }, - "IcebergDestinationConfiguration": { - "shape": "IcebergDestinationConfiguration", - "locationName": "icebergDestinationConfiguration", - "documentation": "

The Apache Iceberg destination for the channel. Mutually exclusive with s3DestinationConfiguration.

" - }, - "S3DestinationConfiguration": { - "shape": "S3DestinationConfiguration", - "locationName": "s3DestinationConfiguration", - "documentation": "

The Amazon S3 destination for the channel. Mutually exclusive with icebergDestinationConfiguration.

" - }, - "Tags": { - "shape": "__mapOf__string", - "locationName": "tags", - "documentation": "

The tags attached to the channel.

" - }, - "TopicConfigurationList": { - "shape": "__listOfTopicConfiguration", - "locationName": "topicConfigurationList", - "documentation": "

The list of topic configurations for the channel. Currently exactly one topic must be specified.

" - }, - "LoggingInfo": { - "shape": "ChannelLoggingInfo", - "locationName": "loggingInfo", - "documentation": "

The destinations to which the channel publishes operational logs.

" - } - }, - "documentation": "

Creates a Channel that streams records from an Amazon MSK Express cluster topic to Amazon S3 or Apache Iceberg.

", - "required": [ - "ClusterArn", - "ChannelName", - "TopicConfigurationList" - ] - }, - "CreateClusterRequest": { - "type": "structure", - "members": { - "BrokerNodeGroupInfo": { - "shape": "BrokerNodeGroupInfo", - "locationName": "brokerNodeGroupInfo", - "documentation": "\n

Information about the broker nodes in the cluster.

\n " - }, - "Rebalancing": { - "shape": "Rebalancing", - "locationName": "rebalancing", - "documentation": "\n

Specifies if intelligent rebalancing should be turned on for the new MSK Provisioned cluster with Express brokers. By default, intelligent rebalancing status is ACTIVE for all new clusters.

\n " - }, - "ClientAuthentication": { - "shape": "ClientAuthentication", - "locationName": "clientAuthentication", - "documentation": "\n

Includes all client authentication related information.

\n " - }, - "ClusterName": { - "shape": "__stringMin1Max64", - "locationName": "clusterName", - "documentation": "\n

The name of the cluster.

\n " - }, - "ConfigurationInfo": { - "shape": "ConfigurationInfo", - "locationName": "configurationInfo", - "documentation": "\n

Represents the configuration that you want MSK to use for the brokers in a cluster.

\n " - }, - "EncryptionInfo": { - "shape": "EncryptionInfo", - "locationName": "encryptionInfo", - "documentation": "\n

Includes all encryption-related information.

\n " - }, - "EnhancedMonitoring": { - "shape": "EnhancedMonitoring", - "locationName": "enhancedMonitoring", - "documentation": "\n

Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.

\n " - }, - "OpenMonitoring": { - "shape": "OpenMonitoringInfo", - "locationName": "openMonitoring", - "documentation": "\n

The settings for open monitoring.

\n " - }, - "KafkaVersion": { - "shape": "__stringMin1Max128", - "locationName": "kafkaVersion", - "documentation": "\n

The version of Apache Kafka.

\n " - }, - "LoggingInfo": { - "shape": "LoggingInfo", - "locationName": "loggingInfo" - }, - "NumberOfBrokerNodes": { - "shape": "__integerMin1Max15", - "locationName": "numberOfBrokerNodes", - "documentation": "\n

The number of broker nodes in the cluster.

\n " - }, - "Tags": { - "shape": "__mapOf__string", - "locationName": "tags", - "documentation": "\n

Create tags when creating the cluster.

\n " - }, - "StorageMode": { - "shape": "StorageMode", - "locationName": "storageMode", - "documentation": "\n

This controls storage mode for supported storage tiers.

\n " - } - }, - "required": [ - "BrokerNodeGroupInfo", - "KafkaVersion", - "NumberOfBrokerNodes", - "ClusterName" - ] - }, - "CreateChannelResponse": { - "type": "structure", - "members": { - "ChannelArn": { - "shape": "__string", - "locationName": "channelArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the channel.

\n " - }, - "ClusterOperationArn": { - "shape": "__string", - "locationName": "clusterOperationArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster operation.

\n " - } - }, - "required": [ - "ChannelArn" - ], - "documentation": "

Returns the channel ARN and the cluster-operation ARN that tracks the asynchronous create.

" - }, - "CreateClusterResponse": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster.

\n " - }, - "ClusterName": { - "shape": "__string", - "locationName": "clusterName", - "documentation": "\n

The name of the MSK cluster.

\n " - }, - "State": { - "shape": "ClusterState", - "locationName": "state", - "documentation": "\n

The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

\n " - } - } - }, - "CreateClusterV2Response": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster.

\n " - }, - "ClusterName": { - "shape": "__string", - "locationName": "clusterName", - "documentation": "\n

The name of the MSK cluster.

\n " - }, - "State": { - "shape": "ClusterState", - "locationName": "state", - "documentation": "\n

The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

\n " - }, - "ClusterType": { - "shape": "ClusterType", - "locationName": "clusterType", - "documentation": "\n

The type of the cluster. The possible states are PROVISIONED or SERVERLESS.

\n " - } - } - }, - "CreateConfigurationRequest": { - "type": "structure", - "members": { - "Description": { - "shape": "__string", - "locationName": "description", - "documentation": "\n

The description of the configuration.

\n " - }, - "KafkaVersions": { - "shape": "__listOf__string", - "locationName": "kafkaVersions", - "documentation": "\n

The versions of Apache Kafka with which you can use this MSK configuration.

\n " - }, - "Name": { - "shape": "__string", - "locationName": "name", - "documentation": "\n

The name of the configuration.

\n " - }, - "ServerProperties": { - "shape": "__blob", - "locationName": "serverProperties", - "documentation": "\n

Contents of the server.properties file. When using the API, you must ensure that the contents of the file are base64 encoded. \n When using the AWS Management Console, the SDK, or the AWS CLI, the contents of server.properties can be in plaintext.

\n " - } - }, - "required": [ - "ServerProperties", - "Name" - ] - }, - "CreateConfigurationResponse": { - "type": "structure", - "members": { - "Arn": { - "shape": "__string", - "locationName": "arn", - "documentation": "\n

The Amazon Resource Name (ARN) of the configuration.

\n " - }, - "CreationTime": { - "shape": "__timestampIso8601", - "locationName": "creationTime", - "documentation": "\n

The time when the configuration was created.

\n " - }, - "LatestRevision": { - "shape": "ConfigurationRevision", - "locationName": "latestRevision", - "documentation": "\n

Latest revision of the configuration.

\n " - }, - "Name": { - "shape": "__string", - "locationName": "name", - "documentation": "\n

The name of the configuration.

\n " - }, - "State": { - "shape": "ConfigurationState", - "locationName": "state", - "documentation": "\n

The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.

\n " - } - } - }, - "CreateReplicatorRequest": { - "type": "structure", - "members": { - "Description": { - "shape": "__stringMax1024", - "locationName": "description", - "documentation": "

A summary description of the replicator.

" - }, - "KafkaClusters": { - "shape": "__listOfKafkaCluster", - "locationName": "kafkaClusters", - "documentation": "

Kafka Clusters to use in setting up sources / targets for replication.

" - }, - "ReplicationInfoList": { - "shape": "__listOfReplicationInfo", - "locationName": "replicationInfoList", - "documentation": "

A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.

" - }, - "ReplicatorName": { - "shape": "__stringMin1Max128Pattern09AZaZ09AZaZ0", - "locationName": "replicatorName", - "documentation": "

The name of the replicator. Alpha-numeric characters with '-' are allowed.

" - }, - "ServiceExecutionRoleArn": { - "shape": "__string", - "locationName": "serviceExecutionRoleArn", - "documentation": "

The ARN of the IAM role used by the replicator to access resources in the customer's account (e.g source and target clusters)

" - }, - "Tags": { - "shape": "__mapOf__string", - "locationName": "tags", - "documentation": "

List of tags to attach to created Replicator.

" - }, - "LogDelivery": { - "shape": "LogDelivery", - "locationName": "logDelivery", - "documentation": "

Configuration for delivering replicator logs to customer destinations.

" - } - }, - "documentation": "

Creates a replicator using the specified configuration.

", - "required": [ - "ServiceExecutionRoleArn", - "ReplicatorName", - "ReplicationInfoList", - "KafkaClusters" - ] - }, - "CreateReplicatorResponse": { - "type": "structure", - "members": { - "ReplicatorArn": { - "shape": "__string", - "locationName": "replicatorArn", - "documentation": "

The Amazon Resource Name (ARN) of the replicator.

" - }, - "ReplicatorName": { - "shape": "__string", - "locationName": "replicatorName", - "documentation": "

Name of the replicator provided by the customer.

" - }, - "ReplicatorState": { - "shape": "ReplicatorState", - "locationName": "replicatorState", - "documentation": "

State of the replicator.

" - } - } - }, - "CreateVpcConnectionRequest": { - "type": "structure", - "members": { - "TargetClusterArn": { - "shape": "__string", - "locationName": "targetClusterArn", - "documentation": "\n

The cluster Amazon Resource Name (ARN) for the VPC connection.

\n " - }, - "Authentication": { - "shape": "__string", - "locationName": "authentication", - "documentation": "\n

The authentication type of VPC connection.

\n " - }, - "VpcId": { - "shape": "__string", - "locationName": "vpcId", - "documentation": "\n

The VPC ID of VPC connection.

\n " - }, - "ClientSubnets": { - "shape": "__listOf__string", - "locationName": "clientSubnets", - "documentation": "\n

The list of client subnets.

\n " - }, - "SecurityGroups": { - "shape": "__listOf__string", - "locationName": "securityGroups", - "documentation": "\n

The list of security groups.

\n " - }, - "Tags": { - "shape": "__mapOf__string", - "locationName": "tags", - "documentation": "\n

A map of tags for the VPC connection.

\n " - } - }, - "required": [ - "TargetClusterArn", - "Authentication", - "VpcId", - "ClientSubnets", - "SecurityGroups" - ] - }, - "CreateVpcConnectionResponse": { - "type": "structure", - "members": { - "VpcConnectionArn": { - "shape": "__string", - "locationName": "vpcConnectionArn", - "documentation": "\n

The VPC connection ARN.

\n " - }, - "State": { - "shape": "VpcConnectionState", - "locationName": "state", - "documentation": "\n

The State of Vpc Connection.

\n " - }, - "Authentication": { - "shape": "__string", - "locationName": "authentication", - "documentation": "\n

The authentication type of VPC connection.

\n " - }, - "VpcId": { - "shape": "__string", - "locationName": "vpcId", - "documentation": "\n

The VPC ID of the VPC connection.

\n " - }, - "ClientSubnets": { - "shape": "__listOf__string", - "locationName": "clientSubnets", - "documentation": "\n

The list of client subnets.

\n " - }, - "SecurityGroups": { - "shape": "__listOf__string", - "locationName": "securityGroups", - "documentation": "\n

The list of security groups.

\n " - }, - "CreationTime": { - "shape": "__timestampIso8601", - "locationName": "creationTime", - "documentation": "\n

The creation time of VPC connection.

\n " - }, - "Tags": { - "shape": "__mapOf__string", - "locationName": "tags", - "documentation": "\n

A map of tags for the VPC connection.

\n " - } - } - }, - "CreateTopicRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

\n " - }, - "TopicName": { - "shape": "__string", - "locationName": "topicName", - "documentation": "\n

The name of the topic to create.

\n " - }, - "PartitionCount": { - "shape": "__integerMin1", - "locationName": "partitionCount", - "documentation": "\n

The number of partitions for the topic.

\n " - }, - "ReplicationFactor": { - "shape": "__integerMin1", - "locationName": "replicationFactor", - "documentation": "\n

The replication factor for the topic.

\n " - }, - "Configs": { - "shape": "__string", - "locationName": "configs", - "documentation": "\n

Topic configurations encoded as a Base64 string.

\n " - } - }, - "required": [ - "ClusterArn", - "TopicName", - "PartitionCount", - "ReplicationFactor" - ] - }, - "CreateTopicResponse": { - "type": "structure", - "members": { - "TopicArn": { - "shape": "__string", - "locationName": "topicArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the topic.

\n " - }, - "TopicName": { - "shape": "__string", - "locationName": "topicName", - "documentation": "\n

The name of the topic that was created.

\n " - }, - "Status": { - "shape": "TopicState", - "locationName": "status", - "documentation": "\n

The status of the topic creation.

\n " - } - } - }, - "DeleteTopicRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

\n " - }, - "TopicName": { - "shape": "__string", - "location": "uri", - "locationName": "topicName", - "documentation": "\n

The name of the topic to delete.

\n " - } - }, - "required": [ - "ClusterArn", - "TopicName" - ] - }, - "DeleteTopicResponse": { - "type": "structure", - "members": { - "TopicArn": { - "shape": "__string", - "locationName": "topicArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the topic.

\n " - }, - "TopicName": { - "shape": "__string", - "locationName": "topicName", - "documentation": "\n

The name of the topic that was deleted.

\n " - }, - "Status": { - "shape": "TopicState", - "locationName": "status", - "documentation": "\n

The status of the topic deletion.

\n " - } - } - }, - "UpdateTopicRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

\n " - }, - "TopicName": { - "shape": "__string", - "location": "uri", - "locationName": "topicName", - "documentation": "\n

The name of the topic to update configuration for.

\n " - }, - "Configs": { - "shape": "__string", - "locationName": "configs", - "documentation": "\n

The new topic configurations encoded as a Base64 string.

\n " - }, - "PartitionCount": { - "shape": "__integer", - "locationName": "partitionCount", - "documentation": "\n

The new total number of partitions for the topic.

\n " - } - }, - "required": [ - "ClusterArn", - "TopicName" - ] - }, - "UpdateTopicResponse": { - "type": "structure", - "members": { - "TopicArn": { - "shape": "__string", - "locationName": "topicArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the topic.

\n " - }, - "TopicName": { - "shape": "__string", - "locationName": "topicName", - "documentation": "\n

The name of the topic whose configuration was updated.

\n " - }, - "Status": { - "shape": "TopicState", - "locationName": "status", - "documentation": "\n

The status of the topic update.

\n " - } - } - }, - "ClusterOperationV2": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn", - "documentation": "\n

ARN of the cluster.

" - }, - "ClusterType": { - "shape": "ClusterType", - "locationName": "clusterType", - "documentation": "\n

Type of the backend cluster.

" - }, - "StartTime": { - "shape": "__timestampIso8601", - "locationName": "startTime", - "documentation": "\n

The time at which operation was started.

" - }, - "EndTime": { - "shape": "__timestampIso8601", - "locationName": "endTime", - "documentation": "\n

The time at which the operation finished.

" - }, - "ErrorInfo": { - "shape": "ErrorInfo", - "locationName": "errorInfo", - "documentation": "\n

If cluster operation failed from an error, it describes the error.

" - }, - "OperationArn": { - "shape": "__string", - "locationName": "operationArn", - "documentation": "\n

ARN of the cluster operation.

" - }, - "OperationState": { - "shape": "__string", - "locationName": "operationState", - "documentation": "\n

State of the cluster operation.

" - }, - "OperationType": { - "shape": "__string", - "locationName": "operationType", - "documentation": "\n

Type of the cluster operation.

" - }, - "Provisioned": { - "shape": "ClusterOperationV2Provisioned", - "locationName": "provisioned", - "documentation": "\n

Properties of a provisioned cluster.

" - }, - "Serverless": { - "shape": "ClusterOperationV2Serverless", - "locationName": "serverless", - "documentation": "\n

Properties of a serverless cluster.

" - } - }, - "documentation": "\n

Returns information about a cluster operation.

" - }, - "ClusterOperationV2Provisioned": { - "type": "structure", - "members": { - "OperationSteps": { - "shape": "__listOfClusterOperationStep", - "locationName": "operationSteps", - "documentation": "\n

Steps completed during the operation.

" - }, - "SourceClusterInfo": { - "shape": "MutableClusterInfo", - "locationName": "sourceClusterInfo", - "documentation": "\n

Information about cluster attributes before a cluster is updated.

" - }, - "TargetClusterInfo": { - "shape": "MutableClusterInfo", - "locationName": "targetClusterInfo", - "documentation": "\n

Information about cluster attributes after a cluster is updated.

" - }, - "VpcConnectionInfo": { - "shape": "VpcConnectionInfo", - "locationName": "vpcConnectionInfo", - "documentation": "\n

Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.

" - } - }, - "documentation": "\n

Returns information about a provisioned cluster operation.

" - }, - "ClusterOperationV2Serverless": { - "type": "structure", - "members": { - "SourceClusterInfo": { - "shape": "ServerlessConnectivityInfo", - "locationName": "sourceClusterInfo", - "documentation": "\n

Describes the cluster's attributes before any updates are applied. For example, networkType, which can be either IPv4 or DUAL.

" - }, - "TargetClusterInfo": { - "shape": "ServerlessConnectivityInfo", - "locationName": "targetClusterInfo", - "documentation": "\n

Describes the cluster's attributes after any updates are applied. For example, networkType, which can be either IPv4 or DUAL.

" - }, - "VpcConnectionInfo": { - "shape": "VpcConnectionInfoServerless", - "locationName": "vpcConnectionInfo", - "documentation": "\n

Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.

" - } - }, - "documentation": "\n

Returns information about a serverless cluster operation.

" - }, - "ClusterOperationV2Summary": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn", - "documentation": "\n

ARN of the cluster.

" - }, - "ClusterType": { - "shape": "ClusterType", - "locationName": "clusterType", - "documentation": "\n

Type of the backend cluster.

" - }, - "StartTime": { - "shape": "__timestampIso8601", - "locationName": "startTime", - "documentation": "\n

The time at which operation was started.

" - }, - "EndTime": { - "shape": "__timestampIso8601", - "locationName": "endTime", - "documentation": "\n

The time at which the operation finished.

" - }, - "OperationArn": { - "shape": "__string", - "locationName": "operationArn", - "documentation": "\n

ARN of the cluster operation.

" - }, - "OperationState": { - "shape": "__string", - "locationName": "operationState", - "documentation": "\n

State of the cluster operation.

" - }, - "OperationType": { - "shape": "__string", - "locationName": "operationType", - "documentation": "\n

Type of the cluster operation.

" - } - }, - "documentation": "\n

Returns information about a cluster operation.

" - }, - "ControllerNodeInfo": { - "type": "structure", - "members": { - "Endpoints": { - "shape": "__listOf__string", - "locationName": "endpoints", - "documentation": "\n

Endpoints for accessing the Controller.

\n " - } - }, - "documentation": "\n

Controller node information.

\n " - }, - "CustomerActionStatus": { - "type": "string", - "documentation": "\n

A type of an action required from the customer.

", - "enum": [ - "CRITICAL_ACTION_REQUIRED", - "ACTION_RECOMMENDED", - "NONE" - ] - }, - "DeleteClusterRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

\n " - }, - "CurrentVersion": { - "shape": "__string", - "location": "querystring", - "locationName": "currentVersion", - "documentation": "\n

The current version of the MSK cluster.

\n " - } - }, - "required": [ - "ClusterArn" - ] - }, - "DeleteClusterResponse": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster.

\n " - }, - "State": { - "shape": "ClusterState", - "locationName": "state", - "documentation": "\n

The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

\n " - } - } - }, - "DeadLetterQueueS3": { - "type": "structure", - "members": { - "BucketArn": { - "shape": "__string", - "locationName": "bucketArn", - "documentation": "

The Amazon Resource Name (ARN) of the dead-letter Amazon S3 bucket.

" - }, - "ErrorOutputPrefix": { - "shape": "__string", - "locationName": "errorOutputPrefix", - "documentation": "

An optional prefix prepended to every dead-letter Amazon S3 object key.

" - }, - "ExpectedBucketOwner": { - "shape": "__string", - "locationName": "expectedBucketOwner", - "documentation": "

Optional 12-digit AWS account ID expected to own the dead-letter Amazon S3 bucket.

" - } - }, - "documentation": "

Configuration of the Amazon S3 bucket where records that fail to deliver are stored.

", - "required": [ - "BucketArn" - ] - }, - "DeleteChannelRequest": { - "type": "structure", - "members": { - "ChannelArn": { - "shape": "__string", - "location": "uri", - "locationName": "channelArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the channel.

\n " - }, - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

\n " - } - }, - "required": [ - "ClusterArn", - "ChannelArn" - ] - }, - "DeleteClusterPolicyRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster.

\n " - } - }, - "required": [ - "ClusterArn" - ] - }, - "DeleteClusterPolicyResponse": { - "type": "structure", - "members": {} - }, - "DeleteChannelResponse": { - "type": "structure", - "members": { - "ChannelArn": { - "shape": "__string", - "locationName": "channelArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the channel.

\n " - }, - "ClusterOperationArn": { - "shape": "__string", - "locationName": "clusterOperationArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster operation.

\n " - } - }, - "required": [ - "ChannelArn" - ], - "documentation": "

Returns the channel ARN and the cluster-operation ARN that tracks the asynchronous delete.

" - }, - "DeleteConfigurationRequest": { - "type": "structure", - "members": { - "Arn": { - "shape": "__string", - "location": "uri", - "locationName": "arn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration.

\n " - } - }, - "required": [ - "Arn" - ] - }, - "DeleteConfigurationResponse": { - "type": "structure", - "members": { - "Arn": { - "shape": "__string", - "locationName": "arn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration.

\n " - }, - "State": { - "shape": "ConfigurationState", - "locationName": "state", - "documentation": "\n

The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.

\n " - } - } - }, - "DeleteReplicatorRequest": { - "type": "structure", - "members": { - "CurrentVersion": { - "shape": "__string", - "location": "querystring", - "locationName": "currentVersion", - "documentation": "

The current version of the replicator.

" - }, - "ReplicatorArn": { - "shape": "__string", - "location": "uri", - "locationName": "replicatorArn", - "documentation": "

The Amazon Resource Name (ARN) of the replicator to be deleted.

" - } - }, - "required": [ - "ReplicatorArn" - ] - }, - "DeleteReplicatorResponse": { - "type": "structure", - "members": { - "ReplicatorArn": { - "shape": "__string", - "locationName": "replicatorArn", - "documentation": "

The Amazon Resource Name (ARN) of the replicator.

" - }, - "ReplicatorState": { - "shape": "ReplicatorState", - "locationName": "replicatorState", - "documentation": "

The state of the replicator.

" - } - } - }, - "DeleteVpcConnectionRequest": { - "type": "structure", - "members": { - "Arn": { - "shape": "__string", - "location": "uri", - "locationName": "arn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies an MSK VPC connection.

\n " - } - }, - "required": [ - "Arn" - ] - }, - "DeleteVpcConnectionResponse": { - "type": "structure", - "members": { - "VpcConnectionArn": { - "shape": "__string", - "locationName": "vpcConnectionArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies an MSK VPC connection.

\n " - }, - "State": { - "shape": "VpcConnectionState", - "locationName": "state", - "documentation": "\n

The state of the VPC connection.

\n " - } - } - }, - "DescribeChannelRequest": { - "type": "structure", - "members": { - "ChannelArn": { - "shape": "__string", - "location": "uri", - "locationName": "channelArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the channel.

\n " - }, - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

\n " - } - }, - "required": [ - "ClusterArn", - "ChannelArn" - ] - }, - "DescribeClusterOperationRequest": { - "type": "structure", - "members": { - "ClusterOperationArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterOperationArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the MSK cluster operation.

\n " - } - }, - "required": [ - "ClusterOperationArn" - ] - }, - "DescribeClusterOperationV2Request": { - "type": "structure", - "members": { - "ClusterOperationArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterOperationArn", - "documentation": "ARN of the cluster operation to describe." - } - }, - "required": [ - "ClusterOperationArn" - ] - }, - "DescribeChannelResponse": { - "type": "structure", - "members": { - "ChannelArn": { - "shape": "__string", - "locationName": "channelArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the channel.

\n " - }, - "ChannelName": { - "shape": "__string", - "locationName": "channelName", - "documentation": "

The name of the channel.

" - }, - "EncryptionConfiguration": { - "shape": "EncryptionConfiguration", - "locationName": "encryptionConfiguration", - "documentation": "

The encryption configuration applied to the channel.

" - }, - "IcebergDestinationConfiguration": { - "shape": "IcebergDestinationConfiguration", - "locationName": "icebergDestinationConfiguration", - "documentation": "

The Apache Iceberg destination for the channel, if configured.

" - }, - "S3DestinationConfiguration": { - "shape": "S3DestinationConfiguration", - "locationName": "s3DestinationConfiguration", - "documentation": "

The Amazon S3 destination for the channel, if configured.

" - }, - "Status": { - "shape": "ChannelStatus", - "locationName": "status", - "documentation": "

The current lifecycle state of the channel.

" - }, - "DestinationType": { - "shape": "ChannelDestinationType", - "locationName": "destinationType", - "documentation": "

The type of destination configured for the channel.

" - }, - "CreationTime": { - "shape": "__timestampIso8601", - "locationName": "creationTime", - "documentation": "\n

The time when the channel was created.

\n " - }, - "TopicConfigurationList": { - "shape": "__listOfTopicConfiguration", - "locationName": "topicConfigurationList", - "documentation": "

The list of topic configurations for the channel.

" - }, - "LoggingInfo": { - "shape": "ChannelLoggingInfo", - "locationName": "loggingInfo", - "documentation": "

The destinations to which the channel publishes operational logs.

" - }, - "StateInfo": { - "shape": "ChannelStateInfo", - "locationName": "stateInfo", - "documentation": "

Additional context for the current channel state, populated when the channel is in FAILED.

" - }, - "ClusterOperationArn": { - "shape": "__string", - "locationName": "clusterOperationArn", - "documentation": "

The Amazon Resource Name (ARN) of the in-flight cluster operation. Returned only while the channel is in CREATING, UPDATING, or DELETING.

" - }, - "Tags": { - "shape": "__mapOf__string", - "locationName": "tags", - "documentation": "

The tags attached to the channel.

" - } - }, - "required": [ - "ChannelArn", - "ChannelName", - "TopicConfigurationList", - "Status", - "DestinationType", - "CreationTime" - ], - "documentation": "

Contains the current configuration and state of a channel.

" - }, - "DescribeClusterOperationResponse": { - "type": "structure", - "members": { - "ClusterOperationInfo": { - "shape": "ClusterOperationInfo", - "locationName": "clusterOperationInfo", - "documentation": "\n

Cluster operation information

\n " - } - } - }, - "DescribeClusterOperationV2Response": { - "type": "structure", - "members": { - "ClusterOperationInfo": { - "shape": "ClusterOperationV2", - "locationName": "clusterOperationInfo", - "documentation": "\n

Cluster operation information

" - } - } - }, - "DescribeClusterRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

\n " - } - }, - "required": [ - "ClusterArn" - ] - }, - "DescribeClusterV2Request": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

\n " - } - }, - "required": [ - "ClusterArn" - ] - }, - "DescribeClusterResponse": { - "type": "structure", - "members": { - "ClusterInfo": { - "shape": "ClusterInfo", - "locationName": "clusterInfo", - "documentation": "\n

The cluster information.

\n " - } - } - }, - "DescribeClusterV2Response": { - "type": "structure", - "members": { - "ClusterInfo": { - "shape": "Cluster", - "locationName": "clusterInfo", - "documentation": "\n

The cluster information.

\n " - } - } - }, - "DescribeConfigurationRequest": { - "type": "structure", - "members": { - "Arn": { - "shape": "__string", - "location": "uri", - "locationName": "arn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.

\n " - } - }, - "required": [ - "Arn" - ] - }, - "DescribeConfigurationResponse": { - "type": "structure", - "members": { - "Arn": { - "shape": "__string", - "locationName": "arn", - "documentation": "\n

The Amazon Resource Name (ARN) of the configuration.

\n " - }, - "CreationTime": { - "shape": "__timestampIso8601", - "locationName": "creationTime", - "documentation": "\n

The time when the configuration was created.

\n " - }, - "Description": { - "shape": "__string", - "locationName": "description", - "documentation": "\n

The description of the configuration.

\n " - }, - "KafkaVersions": { - "shape": "__listOf__string", - "locationName": "kafkaVersions", - "documentation": "\n

The versions of Apache Kafka with which you can use this MSK configuration.

\n " - }, - "LatestRevision": { - "shape": "ConfigurationRevision", - "locationName": "latestRevision", - "documentation": "\n

Latest revision of the configuration.

\n " - }, - "Name": { - "shape": "__string", - "locationName": "name", - "documentation": "\n

The name of the configuration.

\n " - }, - "State": { - "shape": "ConfigurationState", - "locationName": "state", - "documentation": "\n

The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.

\n " - } - } - }, - "DescribeConfigurationRevisionRequest": { - "type": "structure", - "members": { - "Arn": { - "shape": "__string", - "location": "uri", - "locationName": "arn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.

\n " - }, - "Revision": { - "shape": "__long", - "location": "uri", - "locationName": "revision", - "documentation": "\n

A string that uniquely identifies a revision of an MSK configuration.

\n " - } - }, - "required": [ - "Revision", - "Arn" - ] - }, - "DescribeConfigurationRevisionResponse": { - "type": "structure", - "members": { - "Arn": { - "shape": "__string", - "locationName": "arn", - "documentation": "\n

The Amazon Resource Name (ARN) of the configuration.

\n " - }, - "CreationTime": { - "shape": "__timestampIso8601", - "locationName": "creationTime", - "documentation": "\n

The time when the configuration was created.

\n " - }, - "Description": { - "shape": "__string", - "locationName": "description", - "documentation": "\n

The description of the configuration.

\n " - }, - "Revision": { - "shape": "__long", - "locationName": "revision", - "documentation": "\n

The revision number.

\n " - }, - "ServerProperties": { - "shape": "__blob", - "locationName": "serverProperties", - "documentation": "\n

Contents of the server.properties file. When using the API, you must ensure that the contents of the file are base64 encoded. \n When using the AWS Management Console, the SDK, or the AWS CLI, the contents of server.properties can be in plaintext.

\n " - } - } - }, - "DescribeTopicRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

\n " - }, - "TopicName": { - "shape": "__string", - "location": "uri", - "locationName": "topicName", - "documentation": "\n

The Kafka topic name that uniquely identifies the topic.

\n " - } - }, - "required": [ - "ClusterArn", - "TopicName" - ] - }, - "DescribeTopicPartitionsRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

\n " - }, - "TopicName": { - "shape": "__string", - "location": "uri", - "locationName": "topicName", - "documentation": "\n

The Kafka topic name that uniquely identifies the topic.

\n " - }, - "MaxResults": { - "shape": "MaxResults", - "location": "querystring", - "locationName": "maxResults", - "documentation": "\n

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

\n " - }, - "NextToken": { - "shape": "__string", - "location": "querystring", - "locationName": "nextToken", - "documentation": "\n

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. \n To get the next batch, provide this token in your next request.

\n " - } - }, - "required": [ - "ClusterArn", - "TopicName" - ] - }, - "DescribeTopicResponse": { - "type": "structure", - "members": { - "TopicArn": { - "shape": "__string", - "locationName": "topicArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the topic.

\n " - }, - "TopicName": { - "shape": "__string", - "locationName": "topicName", - "documentation": "\n

The Kafka topic name of the topic.

" - }, - "ReplicationFactor": { - "shape": "__integer", - "locationName": "replicationFactor", - "documentation": "\n

The replication factor of the topic.

" - }, - "PartitionCount": { - "shape": "__integer", - "locationName": "partitionCount", - "documentation": "\n

The partition count of the topic.

" - }, - "Configs": { - "shape": "__string", - "locationName": "configs", - "documentation": "\n

Topic configurations encoded as a Base64 string.

" - }, - "Status": { - "shape": "TopicState", - "locationName": "status", - "documentation": "\n

The status of the topic.

\n " - } - } - }, - "DescribeTopicPartitionsResponse": { - "type": "structure", - "members": { - "Partitions": { - "shape": "__listOfTopicPartitionInfo", - "locationName": "partitions", - "documentation": "

The list of partition information for the topic.

" - }, - "NextToken": { - "shape": "__string", - "locationName": "nextToken", - "documentation": "\n

The paginated results marker. When the result of a DescribeTopicPartitions operation is truncated, the call returns NextToken in the response. \n To get another batch of configurations, provide this token in your next request.

\n " - } - } - }, - "TopicPartitionInfo": { - "type": "structure", - "documentation": "

Contains information about a topic partition.

", - "members": { - "Partition": { - "shape": "__integer", - "locationName": "partition", - "documentation": "

The partition ID.

" - }, - "Leader": { - "shape": "__integer", - "locationName": "leader", - "documentation": "

The leader broker ID for the partition.

" - }, - "Replicas": { - "shape": "__listOf__integer", - "locationName": "replicas", - "documentation": "

The list of replica broker IDs for the partition.

" - }, - "Isr": { - "shape": "__listOf__integer", - "locationName": "isr", - "documentation": "

The list of in-sync replica broker IDs for the partition.

" - } - } - }, - "DescribeVpcConnectionRequest": { - "type": "structure", - "members": { - "Arn": { - "shape": "__string", - "location": "uri", - "locationName": "arn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies a MSK VPC connection.

\n " - } - }, - "required": [ - "Arn" - ] - }, - "DescribeReplicatorRequest": { - "type": "structure", - "members": { - "ReplicatorArn": { - "shape": "__string", - "location": "uri", - "locationName": "replicatorArn", - "documentation": "

The Amazon Resource Name (ARN) of the replicator to be described.

" - } - }, - "required": [ - "ReplicatorArn" - ] - }, - "DescribeReplicatorResponse": { - "type": "structure", - "members": { - "CreationTime": { - "shape": "__timestampIso8601", - "locationName": "creationTime", - "documentation": "

The time when the replicator was created.

" - }, - "CurrentVersion": { - "shape": "__string", - "locationName": "currentVersion", - "documentation": "

The current version number of the replicator.

" - }, - "IsReplicatorReference": { - "shape": "__boolean", - "locationName": "isReplicatorReference", - "documentation": "

Whether this resource is a replicator reference.

" - }, - "KafkaClusters": { - "shape": "__listOfKafkaClusterDescription", - "locationName": "kafkaClusters", - "documentation": "

Kafka Clusters used in setting up sources / targets for replication.

" - }, - "ReplicationInfoList": { - "shape": "__listOfReplicationInfoDescription", - "locationName": "replicationInfoList", - "documentation": "

A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.

" - }, - "ReplicatorArn": { - "shape": "__string", - "locationName": "replicatorArn", - "documentation": "

The Amazon Resource Name (ARN) of the replicator.

" - }, - "ReplicatorDescription": { - "shape": "__string", - "locationName": "replicatorDescription", - "documentation": "

The description of the replicator.

" - }, - "ReplicatorName": { - "shape": "__string", - "locationName": "replicatorName", - "documentation": "

The name of the replicator.

" - }, - "ReplicatorResourceArn": { - "shape": "__string", - "locationName": "replicatorResourceArn", - "documentation": "

The Amazon Resource Name (ARN) of the replicator resource in the region where the replicator was created.

" - }, - "ReplicatorState": { - "shape": "ReplicatorState", - "locationName": "replicatorState", - "documentation": "

State of the replicator.

" - }, - "ServiceExecutionRoleArn": { - "shape": "__string", - "locationName": "serviceExecutionRoleArn", - "documentation": "

The Amazon Resource Name (ARN) of the IAM role used by the replicator to access resources in the customer's account (e.g source and target clusters)

" - }, - "StateInfo": { - "shape": "ReplicationStateInfo", - "locationName": "stateInfo", - "documentation": "

Details about the state of the replicator.

" - }, - "Tags": { - "shape": "__mapOf__string", - "locationName": "tags", - "documentation": "

List of tags attached to the Replicator.

" - }, - "LogDelivery": { - "shape": "LogDelivery", - "locationName": "logDelivery", - "documentation": "

Configuration for log delivery.

" - } - } - }, - "DescribeVpcConnectionResponse": { - "type": "structure", - "members": { - "VpcConnectionArn": { - "shape": "__string", - "locationName": "vpcConnectionArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies a MSK VPC connection.

\n " - }, - "TargetClusterArn": { - "shape": "__string", - "locationName": "targetClusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies an MSK cluster.

\n " - }, - "State": { - "shape": "VpcConnectionState", - "locationName": "state", - "documentation": "\n

The state of VPC connection.

\n " - }, - "Authentication": { - "shape": "__string", - "locationName": "authentication", - "documentation": "\n

The authentication type of VPC connection.

\n " - }, - "VpcId": { - "shape": "__string", - "locationName": "vpcId", - "documentation": "\n

The VPC Id for the VPC connection.

\n " - }, - "Subnets": { - "shape": "__listOf__string", - "locationName": "subnets", - "documentation": "\n

The list of subnets for the VPC connection.

\n " - }, - "SecurityGroups": { - "shape": "__listOf__string", - "locationName": "securityGroups", - "documentation": "\n

The list of security groups for the VPC connection.

\n " - }, - "CreationTime": { - "shape": "__timestampIso8601", - "locationName": "creationTime", - "documentation": "\n

The creation time of the VPC connection.

\n " - }, - "Tags": { - "shape": "__mapOf__string", - "locationName": "tags", - "documentation": "\n

A map of tags for the VPC connection.

\n " - } - } - }, - "BatchDisassociateScramSecretRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster to be updated.

\n " - }, - "SecretArnList": { - "shape": "__listOf__string", - "locationName": "secretArnList", - "documentation": "\n

List of AWS Secrets Manager secret ARNs.

\n " - } - }, - "documentation": "\n

Disassociates sasl scram secrets to cluster.

\n ", - "required": [ - "ClusterArn", - "SecretArnList" - ] - }, - "BatchDisassociateScramSecretResponse": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster.

\n " - }, - "UnprocessedScramSecrets": { - "shape": "__listOfUnprocessedScramSecret", - "locationName": "unprocessedScramSecrets", - "documentation": "\n

List of errors when disassociating secrets to cluster.

\n " - } - } - }, - "DestinationTable": { - "type": "structure", - "members": { - "DestinationDatabaseName": { - "shape": "__string", - "locationName": "destinationDatabaseName", - "documentation": "

The name of the destination namespace (database) in the AWS Glue Data Catalog.

" - }, - "DestinationTableName": { - "shape": "__string", - "locationName": "destinationTableName", - "documentation": "

The name of the destination Apache Iceberg table.

" - }, - "PartitionSpec": { - "shape": "PartitionSpec", - "locationName": "partitionSpec", - "documentation": "

The partition specification for the destination table.

" - } - }, - "documentation": "

Configuration of an Apache Iceberg destination table.

" - }, - "EBSStorageInfo": { - "type": "structure", - "members": { - "ProvisionedThroughput": { - "shape": "ProvisionedThroughput", - "locationName": "provisionedThroughput", - "documentation": "\n

EBS volume provisioned throughput information.

\n " - }, - "VolumeSize": { - "shape": "__integerMin1Max16384", - "locationName": "volumeSize", - "documentation": "\n

The size in GiB of the EBS volume for the data drive on each broker node.

\n " - } - }, - "documentation": "\n

Contains information about the EBS storage volumes attached to Apache Kafka broker nodes.

\n " - }, - "EncryptionConfiguration": { - "type": "structure", - "members": { - "KmsKeyArn": { - "shape": "__string", - "locationName": "kmsKeyArn", - "documentation": "

The Amazon Resource Name (ARN) of the AWS KMS key used to encrypt the data.

" - } - }, - "documentation": "

The AWS KMS encryption configuration applied to data at rest.

", - "required": [ - "KmsKeyArn" - ] - }, - "EncryptionAtRest": { - "type": "structure", - "members": { - "DataVolumeKMSKeyId": { - "shape": "__string", - "locationName": "dataVolumeKMSKeyId", - "documentation": "\n

The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.

\n " - } - }, - "documentation": "\n

The data-volume encryption details.

\n ", - "required": [ - "DataVolumeKMSKeyId" - ] - }, - "EncryptionInTransit": { - "type": "structure", - "members": { - "ClientBroker": { - "shape": "ClientBroker", - "locationName": "clientBroker", - "documentation": "\n

Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.

\n

\n TLS means that client-broker communication is enabled with TLS only.

\n

\n TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.

\n

\n PLAINTEXT means that client-broker communication is enabled in plaintext only.

\n

The default value is TLS_PLAINTEXT.

\n " - }, - "InCluster": { - "shape": "__boolean", - "locationName": "inCluster", - "documentation": "\n

When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.

\n

The default value is true.

\n " - } - }, - "documentation": "\n

The settings for encrypting data in transit.

\n " - }, - "EncryptionInfo": { - "type": "structure", - "members": { - "EncryptionAtRest": { - "shape": "EncryptionAtRest", - "locationName": "encryptionAtRest", - "documentation": "\n

The data-volume encryption details.

\n " - }, - "EncryptionInTransit": { - "shape": "EncryptionInTransit", - "locationName": "encryptionInTransit", - "documentation": "\n

The details for encryption in transit.

\n " - } - }, - "documentation": "\n

Includes encryption-related information, such as the AWS KMS key used for encrypting data at rest and whether you want MSK to encrypt your data in transit.

\n " - }, - "EnhancedMonitoring": { - "type": "string", - "documentation": "\n

Specifies which metrics are gathered for the MSK cluster. This property has the following possible values: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. For a list of the metrics associated with each of these levels of monitoring, see Monitoring.

\n ", - "enum": [ - "DEFAULT", - "PER_BROKER", - "PER_TOPIC_PER_BROKER", - "PER_TOPIC_PER_PARTITION" - ] - }, - "Error": { - "type": "structure", - "members": { - "InvalidParameter": { - "shape": "__string", - "locationName": "invalidParameter", - "documentation": "\n

The parameter that caused the error.

\n " - }, - "Message": { - "shape": "__string", - "locationName": "message", - "documentation": "\n

The description of the error.

\n " - } - }, - "documentation": "\n

Returns information about an error.

\n " - }, - "ErrorInfo": { - "type": "structure", - "members": { - "ErrorCode": { - "shape": "__string", - "locationName": "errorCode", - "documentation": "\n

A number describing the error programmatically.

\n " - }, - "ErrorString": { - "shape": "__string", - "locationName": "errorString", - "documentation": "\n

An optional field to provide more details about the error.

\n " - } - }, - "documentation": "\n

Returns information about an error state of the cluster.

\n " - }, - "Firehose": { - "type": "structure", - "members": { - "DeliveryStream": { - "shape": "__string", - "locationName": "deliveryStream" - }, - "Enabled": { - "shape": "__boolean", - "locationName": "enabled" - } - }, - "required": [ - "Enabled" - ] - }, - "ForbiddenException": { - "type": "structure", - "members": { - "InvalidParameter": { - "shape": "__string", - "locationName": "invalidParameter", - "documentation": "\n

The parameter that caused the error.

\n " - }, - "Message": { - "shape": "__string", - "locationName": "message", - "documentation": "\n

The description of the error.

\n " - } - }, - "documentation": "\n

Returns information about an error.

\n ", - "exception": true, - "error": { - "httpStatusCode": 403 - } - }, - "TopicExistsException": { - "type": "structure", - "members": { - "InvalidParameter": { - "shape": "__string", - "locationName": "invalidParameter", - "documentation": "\n

The parameter that caused the error.

\n " - }, - "Message": { - "shape": "__string", - "locationName": "message", - "documentation": "\n

The description of the error.

\n " - } - }, - "documentation": "\n

Returns information about an error.

\n ", - "exception": true, - "error": { - "httpStatusCode": 409 - } - }, - "ClusterConnectivityException": { - "type": "structure", - "members": { - "InvalidParameter": { - "shape": "__string", - "locationName": "invalidParameter", - "documentation": "\n

The parameter that caused the error.

\n " - }, - "Message": { - "shape": "__string", - "locationName": "message", - "documentation": "\n

The description of the error.

\n " - } - }, - "documentation": "\n

Returns information about an error.

\n ", - "exception": true, - "error": { - "httpStatusCode": 409 - } - }, - "KafkaTimeoutException": { - "type": "structure", - "members": { - "InvalidParameter": { - "shape": "__string", - "locationName": "invalidParameter", - "documentation": "\n

The parameter that caused the error.

\n " - }, - "Message": { - "shape": "__string", - "locationName": "message", - "documentation": "\n

The description of the error.

\n " - } - }, - "documentation": "\n

Returns information about an error.

\n ", - "exception": true, - "error": { - "httpStatusCode": 409 - } - }, - "UnknownTopicOrPartitionException": { - "type": "structure", - "members": { - "InvalidParameter": { - "shape": "__string", - "locationName": "invalidParameter", - "documentation": "\n

The parameter that caused the error.

\n " - }, - "Message": { - "shape": "__string", - "locationName": "message", - "documentation": "\n

The description of the error.

\n " - } - }, - "documentation": "\n

Returns information about an error.

\n ", - "exception": true, - "error": { - "httpStatusCode": 404 - } - }, - "ControllerMovedException": { - "type": "structure", - "members": { - "InvalidParameter": { - "shape": "__string", - "locationName": "invalidParameter", - "documentation": "\n

The parameter that caused the error.

\n " - }, - "Message": { - "shape": "__string", - "locationName": "message", - "documentation": "\n

The description of the error.

\n " - } - }, - "documentation": "\n

Returns information about an error.

\n ", - "exception": true, - "error": { - "httpStatusCode": 409 - } - }, - "NotControllerException": { - "type": "structure", - "members": { - "InvalidParameter": { - "shape": "__string", - "locationName": "invalidParameter", - "documentation": "\n

The parameter that caused the error.

\n " - }, - "Message": { - "shape": "__string", - "locationName": "message", - "documentation": "\n

The description of the error.

\n " - } - }, - "documentation": "\n

Returns information about an error.

\n ", - "exception": true, - "error": { - "httpStatusCode": 409 - } - }, - "ReassignmentInProgressException": { - "type": "structure", - "members": { - "InvalidParameter": { - "shape": "__string", - "locationName": "invalidParameter", - "documentation": "\n

The parameter that caused the error.

\n " - }, - "Message": { - "shape": "__string", - "locationName": "message", - "documentation": "\n

The description of the error.

\n " - } - }, - "documentation": "\n

Returns information about an error.

\n ", - "exception": true, - "error": { - "httpStatusCode": 409 - } - }, - "GroupSubscribedToTopicException": { - "type": "structure", - "members": { - "InvalidParameter": { - "shape": "__string", - "locationName": "invalidParameter", - "documentation": "\n

The parameter that caused the error.

\n " - }, - "Message": { - "shape": "__string", - "locationName": "message", - "documentation": "\n

The description of the error.

\n " - } - }, - "documentation": "\n

Returns information about an error.

\n ", - "exception": true, - "error": { - "httpStatusCode": 409 - } - }, - "KafkaRequestException": { - "type": "structure", - "members": { - "InvalidParameter": { - "shape": "__string", - "locationName": "invalidParameter", - "documentation": "\n

The parameter that caused the error.

\n " - }, - "Message": { - "shape": "__string", - "locationName": "message", - "documentation": "\n

The description of the error.

\n " - } - }, - "documentation": "\n

Returns information about an error.

\n ", - "exception": true, - "error": { - "httpStatusCode": 400 - } - }, - "GetBootstrapBrokersRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

\n " - } - }, - "required": [ - "ClusterArn" - ] - }, - "GetBootstrapBrokersResponse": { - "type": "structure", - "members": { - "BootstrapBrokerString": { - "shape": "__string", - "locationName": "bootstrapBrokerString", - "documentation": "\n

A string containing one or more hostname:port pairs.

\n " - }, - "BootstrapBrokerStringTls": { - "shape": "__string", - "locationName": "bootstrapBrokerStringTls", - "documentation": "\n

A string containing one or more DNS names (or IP) and TLS port pairs.

\n " - }, - "BootstrapBrokerStringSaslScram": { - "shape": "__string", - "locationName": "bootstrapBrokerStringSaslScram", - "documentation": "\n

A string containing one or more DNS names (or IP) and Sasl Scram port pairs.

\n " - }, - "BootstrapBrokerStringSaslIam": { - "shape": "__string", - "locationName": "bootstrapBrokerStringSaslIam", - "documentation": "\n

A string that contains one or more DNS names (or IP addresses) and SASL IAM port pairs.

\n " - }, - "BootstrapBrokerStringPublicTls": { - "shape": "__string", - "locationName": "bootstrapBrokerStringPublicTls", - "documentation": "\n

A string containing one or more DNS names (or IP) and TLS port pairs.

\n " - }, - "BootstrapBrokerStringPublicSaslScram": { - "shape": "__string", - "locationName": "bootstrapBrokerStringPublicSaslScram", - "documentation": "\n

A string containing one or more DNS names (or IP) and Sasl Scram port pairs.

\n " - }, - "BootstrapBrokerStringPublicSaslIam": { - "shape": "__string", - "locationName": "bootstrapBrokerStringPublicSaslIam", - "documentation": "\n

A string that contains one or more DNS names (or IP addresses) and SASL IAM port pairs.

\n " - }, - "BootstrapBrokerStringVpcConnectivityTls": { - "shape": "__string", - "locationName": "bootstrapBrokerStringVpcConnectivityTls", - "documentation": "\n

A string containing one or more DNS names (or IP) and TLS port pairs for VPC connectivity.

\n " - }, - "BootstrapBrokerStringVpcConnectivitySaslScram": { - "shape": "__string", - "locationName": "bootstrapBrokerStringVpcConnectivitySaslScram", - "documentation": "\n

A string containing one or more DNS names (or IP) and SASL/SCRAM port pairs for VPC connectivity.

\n " - }, - "BootstrapBrokerStringVpcConnectivitySaslIam": { - "shape": "__string", - "locationName": "bootstrapBrokerStringVpcConnectivitySaslIam", - "documentation": "\n

A string containing one or more DNS names (or IP) and SASL/IAM port pairs for VPC connectivity.

\n " - }, - "BootstrapBrokerStringIpv6": { - "shape": "__string", - "locationName": "bootstrapBrokerStringIpv6", - "documentation": "\n

A string that contains one or more DNS names (or IP) and port pairs for IPv6 connectivity.

\n " - }, - "BootstrapBrokerStringTlsIpv6": { - "shape": "__string", - "locationName": "bootstrapBrokerStringTlsIpv6", - "documentation": "\n

A string that contains one or more DNS names (or IP) and TLS port pairs for IPv6 connectivity.

\n " - }, - "BootstrapBrokerStringSaslScramIpv6": { - "shape": "__string", - "locationName": "bootstrapBrokerStringSaslScramIpv6", - "documentation": "\n

A string that contains one or more DNS names (or IP) and SASL SCRAM port pairs for IPv6 connectivity.

\n " - }, - "BootstrapBrokerStringSaslIamIpv6": { - "shape": "__string", - "locationName": "bootstrapBrokerStringSaslIamIpv6", - "documentation": "\n

A string that contains one or more DNS names (or IP) and SASL IAM port pairs for IPv6 connectivity.

\n " - } - } - }, - "GetCompatibleKafkaVersionsRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "querystring", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster check.

\n " - } - } - }, - "GetCompatibleKafkaVersionsResponse": { - "type": "structure", - "members": { - "CompatibleKafkaVersions": { - "shape": "__listOfCompatibleKafkaVersion", - "locationName": "compatibleKafkaVersions", - "documentation": "\n

A list of CompatibleKafkaVersion objects.

\n " - } - } - }, - "GetClusterPolicyRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster.

\n " - } - }, - "required": [ - "ClusterArn" - ] - }, - "GetClusterPolicyResponse": { - "type": "structure", - "members": { - "CurrentVersion": { - "shape": "__string", - "locationName": "currentVersion", - "documentation": "\n

The version of cluster policy.

\n " - }, - "Policy": { - "shape": "__string", - "locationName": "policy", - "documentation": "\n

The cluster policy.

\n " - } - } - }, - "IcebergDestinationConfiguration": { - "type": "structure", - "members": { - "AppendOnly": { - "shape": "__boolean", - "locationName": "appendOnly", - "documentation": "

Whether the destination is append-only. Must be true; updates and deletes are not supported.

" - }, - "Catalog": { - "shape": "Catalog", - "locationName": "catalog", - "documentation": "

The AWS Glue Data Catalog and S3 Tables warehouse used by the destination.

" - }, - "DataFreshnessInSeconds": { - "shape": "__integer", - "locationName": "dataFreshnessInSeconds", - "documentation": "

The maximum time, in seconds, that records buffer in MSK before being flushed to the destination. Allowed range: 300 to 900. Default: 600.

" - }, - "DeadLetterQueueS3": { - "shape": "DeadLetterQueueS3", - "locationName": "deadLetterQueueS3", - "documentation": "

The Amazon S3 bucket and prefix where MSK writes records that fail to deliver.

" - }, - "DestinationTableList": { - "shape": "__listOfDestinationTable", - "locationName": "destinationTableList", - "documentation": "

The destination Iceberg tables. Currently exactly one table must be specified.

" - }, - "SchemaEvolution": { - "shape": "SchemaEvolution", - "locationName": "schemaEvolution", - "documentation": "

Configuration controlling whether the destination table's schema is evolved to match incoming records.

" - }, - "ServiceExecutionRoleArn": { - "shape": "__string", - "locationName": "serviceExecutionRoleArn", - "documentation": "

The Amazon Resource Name (ARN) of the IAM role that MSK assumes to access the destination table, the AWS Glue Data Catalog, and the dead-letter Amazon S3 bucket.

" - }, - "TableCreation": { - "shape": "TableCreation", - "locationName": "tableCreation", - "documentation": "

Configuration controlling whether MSK creates the destination table if it does not already exist.

" - }, - "CompressionType": { - "shape": "IcebergCompressionType", - "locationName": "compressionType", - "documentation": "

The compression codec for Iceberg table data files. Defaults to ZSTD.

" - } - }, - "documentation": "

Configuration of an Apache Iceberg destination for a channel.

", - "required": [ - "DeadLetterQueueS3", - "DestinationTableList", - "ServiceExecutionRoleArn", - "SchemaEvolution", - "TableCreation", - "AppendOnly" - ] - }, - "IcebergCompressionType": { - "type": "string", - "enum": [ - "ZSTD", - "SNAPPY" - ], - "documentation": "

Compression codec for Iceberg table data files. Defaults to ZSTD.

" - }, - "InternalServerErrorException": { - "type": "structure", - "members": { - "InvalidParameter": { - "shape": "__string", - "locationName": "invalidParameter", - "documentation": "\n

The parameter that caused the error.

\n " - }, - "Message": { - "shape": "__string", - "locationName": "message", - "documentation": "\n

The description of the error.

\n " - } - }, - "documentation": "\n

Returns information about an error.

\n ", - "exception": true, - "error": { - "httpStatusCode": 500 - } - }, - "KafkaCluster": { - "type": "structure", - "members": { - "AmazonMskCluster": { - "shape": "AmazonMskCluster", - "locationName": "amazonMskCluster", - "documentation": "

Details of an Amazon MSK Cluster.

" - }, - "ApacheKafkaCluster": { - "shape": "ApacheKafkaCluster", - "locationName": "apacheKafkaCluster", - "documentation": "

Details of an Apache Kafka Cluster.

" - }, - "VpcConfig": { - "shape": "KafkaClusterClientVpcConfig", - "locationName": "vpcConfig", - "documentation": "

Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.

" - }, - "ClientAuthentication": { - "shape": "KafkaClusterClientAuthentication", - "locationName": "clientAuthentication", - "documentation": "

Details of the client authentication used by the Apache Kafka cluster.

" - }, - "EncryptionInTransit": { - "shape": "KafkaClusterEncryptionInTransit", - "locationName": "encryptionInTransit", - "documentation": "

Details of encryption in transit to the Apache Kafka cluster.

" - } - }, - "documentation": "

Information about Kafka Cluster to be used as source / target for replication.

" - }, - "KafkaClusterClientVpcConfig": { - "type": "structure", - "members": { - "SecurityGroupIds": { - "shape": "__listOf__string", - "locationName": "securityGroupIds", - "documentation": "

The security groups to attach to the ENIs for the broker nodes.

" - }, - "SubnetIds": { - "shape": "__listOf__string", - "locationName": "subnetIds", - "documentation": "

The list of subnets in the client VPC to connect to.

" - } - }, - "documentation": "

Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.

", - "required": [ - "SubnetIds" - ] - }, - "KafkaClusterClientAuthentication": { - "type": "structure", - "members": { - "SaslScram": { - "shape": "KafkaClusterSaslScramAuthentication", - "locationName": "saslScram", - "documentation": "

Details for SASL/SCRAM client authentication.

" - }, - "MTLS": { - "shape": "KafkaClusterMTLSAuthentication", - "locationName": "mTLS", - "documentation": "

Details for mTLS client authentication.

" - } - }, - "documentation": "

Details of the client authentication used by the Apache Kafka cluster.

" - }, - "KafkaClusterSaslScramAuthentication": { - "type": "structure", - "members": { - "Mechanism": { - "shape": "KafkaClusterSaslScramMechanism", - "locationName": "mechanism", - "documentation": "

The SASL/SCRAM authentication mechanism.

" - }, - "SecretArn": { - "shape": "__string", - "locationName": "secretArn", - "documentation": "

The Amazon Resource Name (ARN) of the Secrets Manager secret.

" - } - }, - "documentation": "

Details for SASL/SCRAM client authentication.

", - "required": [ - "Mechanism", - "SecretArn" - ] - }, - "KafkaClusterMTLSAuthentication": { - "type": "structure", - "members": { - "SecretArn": { - "shape": "__string", - "locationName": "secretArn", - "documentation": "

The Amazon Resource Name (ARN) of the Secrets Manager secret.

" - } - }, - "documentation": "

Details for mTLS client authentication.

", - "required": [ - "SecretArn" - ] - }, - "KafkaClusterSaslScramMechanism": { - "type": "string", - "documentation": "

The SASL/SCRAM authentication mechanism.

", - "enum": [ - "SHA256", - "SHA512" - ] - }, - "KafkaClusterEncryptionInTransit": { - "type": "structure", - "members": { - "EncryptionType": { - "shape": "KafkaClusterEncryptionInTransitType", - "locationName": "encryptionType", - "documentation": "

The type of encryption in transit to the Apache Kafka cluster.

" - }, - "RootCaCertificate": { - "shape": "__string", - "locationName": "rootCaCertificate", - "documentation": "

The root CA certificate.

" - } - }, - "documentation": "

Details of encryption in transit to the Apache Kafka cluster.

", - "required": [ - "EncryptionType" - ] - }, - "KafkaClusterEncryptionInTransitType": { - "type": "string", - "documentation": "

The type of encryption in transit to the Apache Kafka cluster.

", - "enum": [ - "TLS" - ] - }, - "KafkaClusterDescription": { - "type": "structure", - "members": { - "AmazonMskCluster": { - "shape": "AmazonMskCluster", - "locationName": "amazonMskCluster", - "documentation": "

Details of an Amazon MSK Cluster.

" - }, - "ApacheKafkaCluster": { - "shape": "ApacheKafkaCluster", - "locationName": "apacheKafkaCluster", - "documentation": "

Details of an Apache Kafka Cluster.

" - }, - "KafkaClusterAlias": { - "shape": "__string", - "locationName": "kafkaClusterAlias", - "documentation": "

The alias of the Kafka cluster. Used to prefix names of replicated topics.

" - }, - "VpcConfig": { - "shape": "KafkaClusterClientVpcConfig", - "locationName": "vpcConfig", - "documentation": "

Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.

" - }, - "ClientAuthentication": { - "shape": "KafkaClusterClientAuthentication", - "locationName": "clientAuthentication", - "documentation": "

Details of the client authentication used by the Apache Kafka cluster.

" - }, - "EncryptionInTransit": { - "shape": "KafkaClusterEncryptionInTransit", - "locationName": "encryptionInTransit", - "documentation": "

Details of encryption in transit to the Apache Kafka cluster.

" - } - }, - "documentation": "

Information about Kafka Cluster used as source / target for replication.

" - }, - "KafkaClusterSummary": { - "type": "structure", - "members": { - "AmazonMskCluster": { - "shape": "AmazonMskCluster", - "locationName": "amazonMskCluster", - "documentation": "

Details of an Amazon MSK Cluster.

" - }, - "ApacheKafkaCluster": { - "shape": "ApacheKafkaCluster", - "locationName": "apacheKafkaCluster", - "documentation": "

Details of an Apache Kafka Cluster.

" - }, - "KafkaClusterAlias": { - "shape": "__string", - "locationName": "kafkaClusterAlias", - "documentation": "

The alias of the Kafka cluster. Used to prefix names of replicated topics.

" - } - }, - "documentation": "

Summarized information about Kafka Cluster used as source / target for replication.

" - }, - "KafkaVersion": { - "type": "structure", - "members": { - "Version": { - "shape": "__string", - "locationName": "version" - }, - "Status": { - "shape": "KafkaVersionStatus", - "locationName": "status" - } - } - }, - "KafkaVersionStatus": { - "type": "string", - "enum": [ - "ACTIVE", - "DEPRECATED" - ] - }, - "ListClusterOperationsRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

\n " - }, - "MaxResults": { - "shape": "MaxResults", - "location": "querystring", - "locationName": "maxResults", - "documentation": "\n

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

\n " - }, - "NextToken": { - "shape": "__string", - "location": "querystring", - "locationName": "nextToken", - "documentation": "\n

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. \n To get the next batch, provide this token in your next request.

\n " - } - }, - "required": [ - "ClusterArn" - ] - }, - "ListClusterOperationsV2Request": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn", - "documentation": "The arn of the cluster whose operations are being requested." - }, - "MaxResults": { - "shape": "MaxResults", - "location": "querystring", - "locationName": "maxResults", - "documentation": "The maxResults of the query." - }, - "NextToken": { - "shape": "__string", - "location": "querystring", - "locationName": "nextToken", - "documentation": "The nextToken of the query." - } - }, - "required": [ - "ClusterArn" - ] - }, - "ListClusterOperationsResponse": { - "type": "structure", - "members": { - "ClusterOperationInfoList": { - "shape": "__listOfClusterOperationInfo", - "locationName": "clusterOperationInfoList", - "documentation": "\n

An array of cluster operation information objects.

\n " - }, - "NextToken": { - "shape": "__string", - "locationName": "nextToken", - "documentation": "\n

If the response of ListClusterOperations is truncated, it returns a NextToken in the response. This Nexttoken should be sent in the subsequent request to ListClusterOperations.

\n " - } - } - }, - "ListClusterOperationsV2Response": { - "type": "structure", - "members": { - "ClusterOperationInfoList": { - "shape": "__listOfClusterOperationV2Summary", - "locationName": "clusterOperationInfoList", - "documentation": "\n

An array of cluster operation information objects.

" - }, - "NextToken": { - "shape": "__string", - "locationName": "nextToken", - "documentation": "\n

If the response of ListClusterOperationsV2 is truncated, it returns a NextToken in the response. This NextToken should be sent in the subsequent request to ListClusterOperationsV2.

" - } - } - }, - "ListChannelsRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

\n " - }, - "MaxResults": { - "shape": "MaxResults", - "location": "querystring", - "locationName": "maxResults", - "documentation": "\n

Maximum number of channels to return in a single response.

\n " - }, - "NextToken": { - "shape": "__string", - "location": "querystring", - "locationName": "nextToken", - "documentation": "\n

If the response of ListChannels is truncated, it returns a nextToken in the response. This nextToken should be sent in the subsequent request to ListChannels.

\n " - }, - "TopicNameFilter": { - "shape": "__string", - "location": "querystring", - "locationName": "topicNameFilter", - "documentation": "\n

Filters results to channels whose topic name matches the specified value.

\n " - } - }, - "required": [ - "ClusterArn" - ] - }, - "ListChannelsResponse": { - "type": "structure", - "members": { - "Channels": { - "shape": "__listOfChannelInfo", - "locationName": "channels", - "documentation": "

The list of channels in the cluster.

" - }, - "NextToken": { - "shape": "__string", - "locationName": "nextToken", - "documentation": "

If the response from ListChannels is truncated, this token is included. Send it as the nextToken parameter on a subsequent ListChannels call to retrieve the next page.

" - } - }, - "documentation": "

Returns the list of channels in the cluster.

" - }, - "ListClustersRequest": { - "type": "structure", - "members": { - "ClusterNameFilter": { - "shape": "__string", - "location": "querystring", - "locationName": "clusterNameFilter", - "documentation": "\n

Specify a prefix of the name of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.

\n " - }, - "MaxResults": { - "shape": "MaxResults", - "location": "querystring", - "locationName": "maxResults", - "documentation": "\n

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

\n " - }, - "NextToken": { - "shape": "__string", - "location": "querystring", - "locationName": "nextToken", - "documentation": "\n

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. \n To get the next batch, provide this token in your next request.

\n " - } - } - }, - "ListClustersV2Request": { - "type": "structure", - "members": { - "ClusterNameFilter": { - "shape": "__string", - "location": "querystring", - "locationName": "clusterNameFilter", - "documentation": "\n

Specify a prefix of the names of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.

\n " - }, - "ClusterTypeFilter": { - "shape": "__string", - "location": "querystring", - "locationName": "clusterTypeFilter", - "documentation": "\n

Specify either PROVISIONED or SERVERLESS.

\n " - }, - "MaxResults": { - "shape": "MaxResults", - "location": "querystring", - "locationName": "maxResults", - "documentation": "\n

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

\n " - }, - "NextToken": { - "shape": "__string", - "location": "querystring", - "locationName": "nextToken", - "documentation": "\n

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. \n To get the next batch, provide this token in your next request.

\n " - } - } - }, - "ListClustersResponse": { - "type": "structure", - "members": { - "ClusterInfoList": { - "shape": "__listOfClusterInfo", - "locationName": "clusterInfoList", - "documentation": "\n

Information on each of the MSK clusters in the response.

\n " - }, - "NextToken": { - "shape": "__string", - "locationName": "nextToken", - "documentation": "\n

The paginated results marker. When the result of a ListClusters operation is truncated, the call returns NextToken in the response. \n To get another batch of clusters, provide this token in your next request.

\n " - } - } - }, - "ListClustersV2Response": { - "type": "structure", - "members": { - "ClusterInfoList": { - "shape": "__listOfCluster", - "locationName": "clusterInfoList", - "documentation": "\n

Information on each of the MSK clusters in the response.

\n " - }, - "NextToken": { - "shape": "__string", - "locationName": "nextToken", - "documentation": "\n

The paginated results marker. When the result of a ListClusters operation is truncated, the call returns NextToken in the response. \n To get another batch of clusters, provide this token in your next request.

\n " - } - } - }, - "ListConfigurationRevisionsRequest": { - "type": "structure", - "members": { - "Arn": { - "shape": "__string", - "location": "uri", - "locationName": "arn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.

\n " - }, - "MaxResults": { - "shape": "MaxResults", - "location": "querystring", - "locationName": "maxResults", - "documentation": "\n

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

\n " - }, - "NextToken": { - "shape": "__string", - "location": "querystring", - "locationName": "nextToken", - "documentation": "\n

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. \n To get the next batch, provide this token in your next request.

\n " - } - }, - "required": [ - "Arn" - ] - }, - "ListConfigurationRevisionsResponse": { - "type": "structure", - "members": { - "NextToken": { - "shape": "__string", - "locationName": "nextToken", - "documentation": "\n

Paginated results marker.

\n " - }, - "Revisions": { - "shape": "__listOfConfigurationRevision", - "locationName": "revisions", - "documentation": "\n

List of ConfigurationRevision objects.

\n " - } - } - }, - "ListConfigurationsRequest": { - "type": "structure", - "members": { - "MaxResults": { - "shape": "MaxResults", - "location": "querystring", - "locationName": "maxResults", - "documentation": "\n

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

\n " - }, - "NextToken": { - "shape": "__string", - "location": "querystring", - "locationName": "nextToken", - "documentation": "\n

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. \n To get the next batch, provide this token in your next request.

\n " - } - } - }, - "ListConfigurationsResponse": { - "type": "structure", - "members": { - "Configurations": { - "shape": "__listOfConfiguration", - "locationName": "configurations", - "documentation": "\n

An array of MSK configurations.

\n " - }, - "NextToken": { - "shape": "__string", - "locationName": "nextToken", - "documentation": "\n

The paginated results marker. When the result of a ListConfigurations operation is truncated, the call returns NextToken in the response. \n To get another batch of configurations, provide this token in your next request.

\n " - } - } - }, - "ListKafkaVersionsRequest": { - "type": "structure", - "members": { - "MaxResults": { - "shape": "MaxResults", - "location": "querystring", - "locationName": "maxResults", - "documentation": "\n

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

" - }, - "NextToken": { - "shape": "__string", - "location": "querystring", - "locationName": "nextToken", - "documentation": "\n

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.

" - } - } - }, - "ListKafkaVersionsResponse": { - "type": "structure", - "members": { - "KafkaVersions": { - "shape": "__listOfKafkaVersion", - "locationName": "kafkaVersions" - }, - "NextToken": { - "shape": "__string", - "locationName": "nextToken" - } - } - }, - "ListNodesRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

\n " - }, - "MaxResults": { - "shape": "MaxResults", - "location": "querystring", - "locationName": "maxResults", - "documentation": "\n

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

\n " - }, - "NextToken": { - "shape": "__string", - "location": "querystring", - "locationName": "nextToken", - "documentation": "\n

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. \n To get the next batch, provide this token in your next request.

\n " - } - }, - "required": [ - "ClusterArn" - ] - }, - "ListNodesResponse": { - "type": "structure", - "members": { - "NextToken": { - "shape": "__string", - "locationName": "nextToken", - "documentation": "\n

The paginated results marker. When the result of a ListNodes operation is truncated, the call returns NextToken in the response. \n To get another batch of nodes, provide this token in your next request.

\n " - }, - "NodeInfoList": { - "shape": "__listOfNodeInfo", - "locationName": "nodeInfoList", - "documentation": "\n

List containing a NodeInfo object.

\n " - } - } - }, - "ListReplicatorsRequest": { - "type": "structure", - "members": { - "MaxResults": { - "shape": "MaxResults", - "location": "querystring", - "locationName": "maxResults", - "documentation": "

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

" - }, - "NextToken": { - "shape": "__string", - "location": "querystring", - "locationName": "nextToken", - "documentation": "

If the response of ListReplicators is truncated, it returns a NextToken in the response. This NextToken should be sent in the subsequent request to ListReplicators.

" - }, - "ReplicatorNameFilter": { - "shape": "__string", - "location": "querystring", - "locationName": "replicatorNameFilter", - "documentation": "

Returns replicators starting with given name.

" - } - } - }, - "ListReplicatorsResponse": { - "type": "structure", - "members": { - "NextToken": { - "shape": "__string", - "locationName": "nextToken", - "documentation": "

If the response of ListReplicators is truncated, it returns a NextToken in the response. This NextToken should be sent in the subsequent request to ListReplicators.

" - }, - "Replicators": { - "shape": "__listOfReplicatorSummary", - "locationName": "replicators", - "documentation": "

List containing information of each of the replicators in the account.

" - } - } - }, - "ListScramSecretsRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn", - "documentation": "\n

The arn of the cluster.

\n " - }, - "MaxResults": { - "shape": "MaxResults", - "location": "querystring", - "locationName": "maxResults", - "documentation": "\n

The maxResults of the query.

\n " - }, - "NextToken": { - "shape": "__string", - "location": "querystring", - "locationName": "nextToken", - "documentation": "\n

The nextToken of the query.

\n " - } - }, - "required": [ - "ClusterArn" - ] - }, - "ListScramSecretsResponse": { - "type": "structure", - "members": { - "NextToken": { - "shape": "__string", - "locationName": "nextToken", - "documentation": "\n

Paginated results marker.

\n " - }, - "SecretArnList": { - "shape": "__listOf__string", - "locationName": "secretArnList", - "documentation": "\n

The list of scram secrets associated with the cluster.

\n " - } - } - }, - "ListTagsForResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "shape": "__string", - "location": "uri", - "locationName": "resourceArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.

\n " - } - }, - "required": [ - "ResourceArn" - ] - }, - "ListTagsForResourceResponse": { - "type": "structure", - "members": { - "Tags": { - "shape": "__mapOf__string", - "locationName": "tags", - "documentation": "\n

The key-value pair for the resource tag.

\n " - } - } - }, - "ListClientVpcConnectionsRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster.

\n " - }, - "MaxResults": { - "shape": "MaxResults", - "location": "querystring", - "locationName": "maxResults", - "documentation": "\n

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

\n " - }, - "NextToken": { - "shape": "__string", - "location": "querystring", - "locationName": "nextToken", - "documentation": "\n

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. \n To get the next batch, provide this token in your next request.

\n " - } - }, - "required": [ - "ClusterArn" - ] - }, - "ListClientVpcConnectionsResponse": { - "type": "structure", - "members": { - "ClientVpcConnections": { - "shape": "__listOfClientVpcConnection", - "locationName": "clientVpcConnections", - "documentation": "\n

List of client VPC connections.

\n " - }, - "NextToken": { - "shape": "__string", - "locationName": "nextToken", - "documentation": "\n

The paginated results marker. When the result of a ListClientVpcConnections operation is truncated, the call returns NextToken in the response. \n To get another batch of configurations, provide this token in your next request.

\n " - } - } - }, - "ListTopicsRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

\n " - }, - "MaxResults": { - "shape": "MaxResults", - "location": "querystring", - "locationName": "maxResults", - "documentation": "\n

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

\n " - }, - "NextToken": { - "shape": "__string", - "location": "querystring", - "locationName": "nextToken", - "documentation": "\n

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. \n To get the next batch, provide this token in your next request.

\n " - }, - "TopicNameFilter": { - "shape": "__string", - "location": "querystring", - "locationName": "topicNameFilter", - "documentation": "\n

Returns topics starting with given name.

\n " - } - }, - "required": [ - "ClusterArn" - ] - }, - "ListTopicsResponse": { - "type": "structure", - "members": { - "Topics": { - "shape": "__listOfTopicInfo", - "locationName": "topics", - "documentation": "\n

List containing topics info.

\n " - }, - "NextToken": { - "shape": "__string", - "locationName": "nextToken", - "documentation": "\n

The paginated results marker. When the result of a ListTopics operation is truncated, the call returns NextToken in the response. \n To get another batch of configurations, provide this token in your next request.

\n " - } - } - }, - "ListVpcConnectionsRequest": { - "type": "structure", - "members": { - "MaxResults": { - "shape": "MaxResults", - "location": "querystring", - "locationName": "maxResults", - "documentation": "\n

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

\n " - }, - "NextToken": { - "shape": "__string", - "location": "querystring", - "locationName": "nextToken", - "documentation": "\n

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. \n To get the next batch, provide this token in your next request.

\n " - } - } - }, - "ListVpcConnectionsResponse": { - "type": "structure", - "members": { - "VpcConnections": { - "shape": "__listOfVpcConnection", - "locationName": "vpcConnections", - "documentation": "\n

List of VPC connections.

\n " - }, - "NextToken": { - "shape": "__string", - "locationName": "nextToken", - "documentation": "\n

The paginated results marker. When the result of a ListClientVpcConnections operation is truncated, the call returns NextToken in the response. \n To get another batch of configurations, provide this token in your next request.

\n " - } - } - }, - "RejectClientVpcConnectionRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster.

\n " - }, - "VpcConnectionArn": { - "shape": "__string", - "locationName": "vpcConnectionArn", - "documentation": "\n

The VPC connection ARN.

\n " - } - }, - "required": [ - "VpcConnectionArn", - "ClusterArn" - ] - }, - "RejectClientVpcConnectionResponse": { - "type": "structure", - "members": {} - }, - "MaxResults": { - "type": "integer", - "min": 1, - "max": 100 - }, - "LoggingInfo": { - "type": "structure", - "members": { - "BrokerLogs": { - "shape": "BrokerLogs", - "locationName": "brokerLogs" - } - }, - "required": [ - "BrokerLogs" - ] - }, - "LogDelivery": { - "type": "structure", - "members": { - "ReplicatorLogDelivery": { - "shape": "ReplicatorLogDelivery", - "locationName": "replicatorLogDelivery", - "documentation": "

Configuration for replicator log delivery.

" - } - }, - "documentation": "

Configuration for log delivery to customer destinations.

" - }, - "ReplicatorLogDelivery": { - "type": "structure", - "members": { - "CloudWatchLogs": { - "shape": "ReplicatorCloudWatchLogs", - "locationName": "cloudWatchLogs", - "documentation": "

Configuration for CloudWatch Logs delivery.

" - }, - "Firehose": { - "shape": "ReplicatorFirehose", - "locationName": "firehose", - "documentation": "

Configuration for Firehose delivery.

" - }, - "S3": { - "shape": "ReplicatorS3", - "locationName": "s3", - "documentation": "

Configuration for S3 delivery.

" - } - }, - "documentation": "

Configuration for replicator log delivery.

" - }, - "ReplicatorCloudWatchLogs": { - "type": "structure", - "members": { - "Enabled": { - "shape": "__boolean", - "locationName": "enabled", - "documentation": "

Whether log delivery to CloudWatch Logs is enabled.

" - }, - "LogGroup": { - "shape": "__string", - "locationName": "logGroup", - "documentation": "

The CloudWatch log group that is the destination for log delivery.

" - } - }, - "documentation": "

Details about delivering logs to CloudWatch Logs.

", - "required": [ - "Enabled" - ] - }, - "ReplicatorFirehose": { - "type": "structure", - "members": { - "Enabled": { - "shape": "__boolean", - "locationName": "enabled", - "documentation": "

Whether log delivery to Firehose is enabled.

" - }, - "DeliveryStream": { - "shape": "__string", - "locationName": "deliveryStream", - "documentation": "

The Firehose delivery stream that is the destination for log delivery.

" - } - }, - "documentation": "

Details about delivering logs to Firehose.

", - "required": [ - "Enabled" - ] - }, - "ReplicatorS3": { - "type": "structure", - "members": { - "Enabled": { - "shape": "__boolean", - "locationName": "enabled", - "documentation": "

Whether log delivery to S3 is enabled.

" - }, - "Bucket": { - "shape": "__string", - "locationName": "bucket", - "documentation": "

The S3 bucket that is the destination for log delivery.

" - }, - "Prefix": { - "shape": "__string", - "locationName": "prefix", - "documentation": "

The S3 prefix that is the destination for log delivery.

" - } - }, - "documentation": "

Details about delivering logs to S3.

", - "required": [ - "Enabled" - ] - }, - "ChannelLoggingInfo": { - "type": "structure", - "members": { - "CloudWatchLogs": { - "shape": "CloudWatchLogs", - "locationName": "cloudWatchLogs", - "documentation": "

Details of the CloudWatch Logs destination for Channel logs.

" - }, - "Firehose": { - "shape": "Firehose", - "locationName": "firehose", - "documentation": "

Details of the Kinesis Data Firehose delivery stream that is the destination for Channel logs.

" - }, - "S3": { - "shape": "S3", - "locationName": "s3", - "documentation": "

Details of the Amazon S3 destination for Channel logs.

" - } - }, - "documentation": "

Configuration for the destinations to which the channel publishes operational logs.

" - }, - "MutableClusterInfo": { - "type": "structure", - "members": { - "BrokerEBSVolumeInfo": { - "shape": "__listOfBrokerEBSVolumeInfo", - "locationName": "brokerEBSVolumeInfo", - "documentation": "\n

Specifies the size of the EBS volume and the ID of the associated broker.

\n " - }, - "ConfigurationInfo": { - "shape": "ConfigurationInfo", - "locationName": "configurationInfo", - "documentation": "\n

Information about the changes in the configuration of the brokers.

\n " - }, - "NumberOfBrokerNodes": { - "shape": "__integer", - "locationName": "numberOfBrokerNodes", - "documentation": "\n

The number of broker nodes in the cluster.

\n " - }, - "EnhancedMonitoring": { - "shape": "EnhancedMonitoring", - "locationName": "enhancedMonitoring", - "documentation": "\n

Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.

\n " - }, - "OpenMonitoring": { - "shape": "OpenMonitoring", - "locationName": "openMonitoring", - "documentation": "\n

The settings for open monitoring.

\n " - }, - "ZookeeperAccess": { - "shape": "ZookeeperAccess", - "locationName": "zookeeperAccess", - "documentation": "\n

Access control settings for zookeeper

\n " - }, - "KafkaVersion": { - "shape": "__string", - "locationName": "kafkaVersion", - "documentation": "\n

The Apache Kafka version.

\n " - }, - "LoggingInfo": { - "shape": "LoggingInfo", - "locationName": "loggingInfo", - "documentation": "\n

You can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.

\n " - }, - "InstanceType": { - "shape": "__stringMin5Max32", - "locationName": "instanceType", - "documentation": "\n

Information about the Amazon MSK broker type.

\n " - }, - "ClientAuthentication": { - "shape": "ClientAuthentication", - "locationName": "clientAuthentication", - "documentation": "\n

Includes all client authentication information.

\n " - }, - "EncryptionInfo": { - "shape": "EncryptionInfo", - "locationName": "encryptionInfo", - "documentation": "\n

Includes all encryption-related information.

\n " - }, - "ConnectivityInfo": { - "shape": "ConnectivityInfo", - "locationName": "connectivityInfo", - "documentation": "\n

Information about the broker access configuration.

\n " - }, - "StorageMode": { - "shape": "StorageMode", - "locationName": "storageMode", - "documentation": "\n

This controls storage mode for supported storage tiers.

\n " - }, - "BrokerCountUpdateInfo": { - "shape": "BrokerCountUpdateInfo", - "locationName": "brokerCountUpdateInfo", - "documentation": "\n

Describes brokers being changed during a broker count update.

\n " - }, - "Rebalancing": { - "shape": "Rebalancing", - "locationName": "rebalancing", - "documentation": "\n

Describes the intelligent rebalancing configuration of an MSK Provisioned cluster with Express brokers.

\n " - } - }, - "documentation": "\n

Information about cluster attributes that can be updated via update APIs.

\n " - }, - "NodeExporter": { - "type": "structure", - "members": { - "EnabledInBroker": { - "shape": "__boolean", - "locationName": "enabledInBroker", - "documentation": "\n

Indicates whether you want to turn on or turn off the Node Exporter.

\n " - } - }, - "documentation": "\n

Indicates whether you want to turn on or turn off the Node Exporter.

\n ", - "required": [ - "EnabledInBroker" - ] - }, - "NodeExporterInfo": { - "type": "structure", - "members": { - "EnabledInBroker": { - "shape": "__boolean", - "locationName": "enabledInBroker", - "documentation": "\n

Indicates whether you want to turn on or turn off the Node Exporter.

\n " - } - }, - "documentation": "\n

Indicates whether you want to turn on or turn off the Node Exporter.

\n ", - "required": [ - "EnabledInBroker" - ] - }, - "JmxExporter": { - "type": "structure", - "members": { - "EnabledInBroker": { - "shape": "__boolean", - "locationName": "enabledInBroker", - "documentation": "\n

Indicates whether you want to turn on or turn off the JMX Exporter.

\n " - } - }, - "documentation": "\n

Indicates whether you want to turn on or turn off the JMX Exporter.

\n ", - "required": [ - "EnabledInBroker" - ] - }, - "JmxExporterInfo": { - "type": "structure", - "members": { - "EnabledInBroker": { - "shape": "__boolean", - "locationName": "enabledInBroker", - "documentation": "\n

Indicates whether you want to turn on or turn off the JMX Exporter.

\n " - } - }, - "documentation": "\n

Indicates whether you want to turn on or turn off the JMX Exporter.

\n ", - "required": [ - "EnabledInBroker" - ] - }, - "OpenMonitoring": { - "type": "structure", - "members": { - "Prometheus": { - "shape": "Prometheus", - "locationName": "prometheus", - "documentation": "\n

Prometheus settings.

\n " - } - }, - "documentation": "\n

JMX and Node monitoring for the MSK cluster.

\n ", - "required": [ - "Prometheus" - ] - }, - "OpenMonitoringInfo": { - "type": "structure", - "members": { - "Prometheus": { - "shape": "PrometheusInfo", - "locationName": "prometheus", - "documentation": "\n

Prometheus settings.

\n " - } - }, - "documentation": "\n

JMX and Node monitoring for the MSK cluster.

\n ", - "required": [ - "Prometheus" - ] - }, - "PartitionSource": { - "type": "structure", - "members": { - "SourceName": { - "shape": "__string", - "locationName": "sourceName", - "documentation": "\n

Source name.

\n " - } - }, - "documentation": "

A source column used by an Apache Iceberg destination table's partition specification.

" - }, - "PartitionSpec": { - "type": "structure", - "members": { - "PartitionStrategy": { - "shape": "PartitionStrategy", - "locationName": "partitionStrategy", - "documentation": "

The partitioning strategy applied to records written to the table.

" - }, - "SourceList": { - "shape": "__listOfPartitionSource", - "locationName": "sourceList", - "documentation": "

The source columns used by the partitioning strategy. For TIME_HOUR, must contain exactly one source column whose value is a timestamp.

" - } - }, - "documentation": "

Partition specification for an Apache Iceberg destination table.

", - "required": [ - "PartitionStrategy" - ] - }, - "PartitionStrategy": { - "type": "string", - "documentation": "

The partitioning strategy used to partition records in the destination Apache Iceberg table.

", - "enum": [ - "TIME_HOUR" - ] - }, - "Prometheus": { - "type": "structure", - "members": { - "JmxExporter": { - "shape": "JmxExporter", - "locationName": "jmxExporter", - "documentation": "\n

Indicates whether you want to turn on or turn off the JMX Exporter.

\n " - }, - "NodeExporter": { - "shape": "NodeExporter", - "locationName": "nodeExporter", - "documentation": "\n

Indicates whether you want to turn on or turn off the Node Exporter.

\n " - } - }, - "documentation": "\n

Prometheus settings.

\n " - }, - "PrometheusInfo": { - "type": "structure", - "members": { - "JmxExporter": { - "shape": "JmxExporterInfo", - "locationName": "jmxExporter", - "documentation": "\n

Indicates whether you want to turn on or turn off the JMX Exporter.

\n " - }, - "NodeExporter": { - "shape": "NodeExporterInfo", - "locationName": "nodeExporter", - "documentation": "\n

Indicates whether you want to turn on or turn off the Node Exporter.

\n " - } - }, - "documentation": "\n

Prometheus settings.

\n " - }, - "ProvisionedThroughput": { - "type": "structure", - "members": { - "Enabled": { - "shape": "__boolean", - "locationName": "enabled", - "documentation": "\n

Provisioned throughput is enabled or not.

\n " - }, - "VolumeThroughput": { - "shape": "__integer", - "locationName": "volumeThroughput", - "documentation": "\n

Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.

\n " - } - }, - "documentation": "\n

Contains information about provisioned throughput for EBS storage volumes attached to kafka broker nodes.

\n " - }, - "PublicAccess": { - "type": "structure", - "members": { - "Type": { - "shape": "__string", - "locationName": "type", - "documentation": "\n

The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.

\n " - } - }, - "documentation": "Public access control for brokers." - }, - "RecordConverter": { - "type": "structure", - "members": { - "ValueConverter": { - "shape": "ValueConverter", - "locationName": "valueConverter", - "documentation": "

The deserialization format applied to Apache Kafka record values.

" - } - }, - "documentation": "

Configuration that controls how Apache Kafka record values are deserialized for the destination.

", - "required": [ - "ValueConverter" - ] - }, - "RecordSchema": { - "type": "structure", - "members": { - "GsrArn": { - "shape": "__string", - "locationName": "gsrArn", - "documentation": "

The Amazon Resource Name (ARN) of the AWS Glue Schema Registry schema (not registry) used to validate records for the destination Apache Iceberg table.

" - } - }, - "documentation": "

Schema configuration that controls how Apache Kafka record values are validated.

", - "required": [ - "GsrArn" - ] - }, - "PutClusterPolicyRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster.

\n " - }, - "CurrentVersion": { - "shape": "__string", - "locationName": "currentVersion", - "documentation": "\n

The policy version.

\n " - }, - "Policy": { - "shape": "__string", - "locationName": "policy", - "documentation": "\n

The policy.

\n " - } - }, - "required": [ - "ClusterArn", - "Policy" - ] - }, - "PutClusterPolicyResponse": { - "type": "structure", - "members": { - "CurrentVersion": { - "shape": "__string", - "locationName": "currentVersion", - "documentation": "\n

The policy version.

\n " - } - } - }, - "RebootBrokerRequest": { - "type": "structure", - "members": { - "BrokerIds": { - "shape": "__listOf__string", - "locationName": "brokerIds", - "documentation": "\n

The list of broker IDs to be rebooted. The reboot-broker operation supports rebooting one broker at a time.

\n " - }, - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster to be updated.

\n " - } - }, - "documentation": "Reboots a node.", - "required": [ - "ClusterArn", - "BrokerIds" - ] - }, - "RebootBrokerResponse": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster.

\n " - }, - "ClusterOperationArn": { - "shape": "__string", - "locationName": "clusterOperationArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster operation.

\n " - } - } - }, - "S3": { - "type": "structure", - "members": { - "Bucket": { - "shape": "__string", - "locationName": "bucket" - }, - "Enabled": { - "shape": "__boolean", - "locationName": "enabled" - }, - "Prefix": { - "shape": "__string", - "locationName": "prefix" - } - }, - "required": [ - "Enabled" - ] - }, - "ServerlessSasl": { - "type": "structure", - "members": { - "Iam": { - "shape": "Iam", - "locationName": "iam", - "documentation": "\n

Indicates whether IAM access control is enabled.

\n " - } - }, - "documentation": "\n

Details for client authentication using SASL.

\n " - }, - "SchemaEvolution": { - "type": "structure", - "members": { - "EnableSchemaEvolution": { - "shape": "__boolean", - "locationName": "enableSchemaEvolution", - "documentation": "

Whether to allow MSK to evolve the destination table's schema. Must be false for the current release.

" - } - }, - "documentation": "

Configuration controlling whether the Apache Iceberg destination table's schema is evolved as incoming records change.

" - }, - "Sasl": { - "type": "structure", - "members": { - "Scram": { - "shape": "Scram", - "locationName": "scram", - "documentation": "\n

Details for SASL/SCRAM client authentication.

\n " - }, - "Iam": { - "shape": "Iam", - "locationName": "iam", - "documentation": "\n

Indicates whether IAM access control is enabled.

\n " - } - }, - "documentation": "\n

Details for client authentication using SASL.

\n " - }, - "VpcConnectivitySasl": { - "type": "structure", - "members": { - "Scram": { - "shape": "VpcConnectivityScram", - "locationName": "scram", - "documentation": "\n

Details for SASL/SCRAM client authentication for VPC connectivity.

\n " - }, - "Iam": { - "shape": "VpcConnectivityIam", - "locationName": "iam", - "documentation": "\n

Details for SASL/IAM client authentication for VPC connectivity.

\n " - } - }, - "documentation": "\n

Details for SASL client authentication for VPC connectivity.

\n " - }, - "Scram": { - "type": "structure", - "members": { - "Enabled": { - "shape": "__boolean", - "locationName": "enabled", - "documentation": "\n

SASL/SCRAM authentication is enabled or not.

\n " - } - }, - "documentation": "\n

Details for SASL/SCRAM client authentication.

\n " - }, - "VpcConnectivityScram": { - "type": "structure", - "members": { - "Enabled": { - "shape": "__boolean", - "locationName": "enabled", - "documentation": "\n

SASL/SCRAM authentication is on or off for VPC connectivity.

\n " - } - }, - "documentation": "\n

Details for SASL/SCRAM client authentication for VPC connectivity.

\n " - }, - "Iam": { - "type": "structure", - "members": { - "Enabled": { - "shape": "__boolean", - "locationName": "enabled", - "documentation": "\n

Indicates whether IAM access control is enabled.

\n " - } - }, - "documentation": "\n

Details for IAM access control.

\n " - }, - "VpcConnectivityIam": { - "type": "structure", - "members": { - "Enabled": { - "shape": "__boolean", - "locationName": "enabled", - "documentation": "\n

SASL/IAM authentication is on or off for VPC connectivity.

\n " - } - }, - "documentation": "\n

Details for IAM access control for VPC connectivity.

\n " - }, - "NodeInfo": { - "type": "structure", - "members": { - "AddedToClusterTime": { - "shape": "__string", - "locationName": "addedToClusterTime", - "documentation": "\n

The start time.

\n " - }, - "BrokerNodeInfo": { - "shape": "BrokerNodeInfo", - "locationName": "brokerNodeInfo", - "documentation": "\n

The broker node info.

\n " - }, - "ControllerNodeInfo": { - "shape": "ControllerNodeInfo", - "locationName": "controllerNodeInfo", - "documentation": "\n

The ControllerNodeInfo.

\n " - }, - "InstanceType": { - "shape": "__string", - "locationName": "instanceType", - "documentation": "\n

The instance type.

\n " - }, - "NodeARN": { - "shape": "__string", - "locationName": "nodeARN", - "documentation": "\n

The Amazon Resource Name (ARN) of the node.

\n " - }, - "NodeType": { - "shape": "NodeType", - "locationName": "nodeType", - "documentation": "\n

The node type.

\n " - }, - "ZookeeperNodeInfo": { - "shape": "ZookeeperNodeInfo", - "locationName": "zookeeperNodeInfo", - "documentation": "\n

The ZookeeperNodeInfo.

\n " - } - }, - "documentation": "\n

The node information object.

\n " - }, - "NetworkType": { - "type": "string", - "documentation": "\n

The network type of the cluster, which is IPv4 or DUAL. The DUAL network type uses both IPv4 and IPv6 addresses for your cluster and its resources.

By default, a cluster uses the IPv4 network type.

\n ", - "enum": [ - "IPV4", - "DUAL" - ] - }, - "ZookeeperAccess": { - "type": "structure", - "members": { - "Enabled": { - "shape": "__boolean", - "locationName": "enabled", - "documentation": "\n

Zookeeper Access was on or off for the cluster

\n " - } - }, - "documentation": "\n

Access control settings for zookeeper

\n " - }, - "NodeType": { - "type": "string", - "documentation": "\n

The broker or Zookeeper node.

\n ", - "enum": [ - "BROKER" - ] - }, - "NotFoundException": { - "type": "structure", - "members": { - "InvalidParameter": { - "shape": "__string", - "locationName": "invalidParameter", - "documentation": "\n

The parameter that caused the error.

\n " - }, - "Message": { - "shape": "__string", - "locationName": "message", - "documentation": "\n

The description of the error.

\n " - } - }, - "documentation": "\n

Returns information about an error.

\n ", - "exception": true, - "error": { - "httpStatusCode": 404 - } - }, - "ReplicationInfo": { - "type": "structure", - "members": { - "ConsumerGroupReplication": { - "shape": "ConsumerGroupReplication", - "locationName": "consumerGroupReplication", - "documentation": "

Configuration relating to consumer group replication.

" - }, - "SourceKafkaClusterArn": { - "shape": "__string", - "locationName": "sourceKafkaClusterArn", - "documentation": "

The ARN of the source Kafka cluster.

" - }, - "SourceKafkaClusterId": { - "shape": "__string", - "locationName": "sourceKafkaClusterId", - "documentation": "

The ID of the source Kafka cluster.

" - }, - "TargetCompressionType": { - "shape": "TargetCompressionType", - "locationName": "targetCompressionType", - "documentation": "

The compression type to use when producing records to target cluster.

" - }, - "TargetKafkaClusterArn": { - "shape": "__string", - "locationName": "targetKafkaClusterArn", - "documentation": "

The ARN of the target Kafka cluster.

" - }, - "TargetKafkaClusterId": { - "shape": "__string", - "locationName": "targetKafkaClusterId", - "documentation": "

The ID of the target Kafka cluster.

" - }, - "TopicReplication": { - "shape": "TopicReplication", - "locationName": "topicReplication", - "documentation": "

Configuration relating to topic replication.

" - } - }, - "documentation": "

Specifies configuration for replication between a source and target Kafka cluster.

", - "required": [ - "TargetCompressionType", - "TopicReplication", - "ConsumerGroupReplication" - ] - }, - "ReplicationInfoDescription": { - "type": "structure", - "members": { - "ConsumerGroupReplication": { - "shape": "ConsumerGroupReplication", - "locationName": "consumerGroupReplication", - "documentation": "

Configuration relating to consumer group replication.

" - }, - "SourceKafkaClusterAlias": { - "shape": "__string", - "locationName": "sourceKafkaClusterAlias", - "documentation": "

The alias of the source Kafka cluster.

" - }, - "TargetCompressionType": { - "shape": "TargetCompressionType", - "locationName": "targetCompressionType", - "documentation": "

The compression type to use when producing records to target cluster.

" - }, - "TargetKafkaClusterAlias": { - "shape": "__string", - "locationName": "targetKafkaClusterAlias", - "documentation": "

The alias of the target Kafka cluster.

" - }, - "TopicReplication": { - "shape": "TopicReplication", - "locationName": "topicReplication", - "documentation": "

Configuration relating to topic replication.

" - } - }, - "documentation": "

Specifies configuration for replication between a source and target Kafka cluster (sourceKafkaClusterAlias -> targetKafkaClusterAlias)

" - }, - "ReplicationInfoSummary": { - "type": "structure", - "members": { - "SourceKafkaClusterAlias": { - "shape": "__string", - "locationName": "sourceKafkaClusterAlias", - "documentation": "

The alias of the source Kafka cluster.

" - }, - "TargetKafkaClusterAlias": { - "shape": "__string", - "locationName": "targetKafkaClusterAlias", - "documentation": "

The alias of the target Kafka cluster.

" - } - }, - "documentation": "

Summarized information of replication between clusters.

" - }, - "ReplicationStartingPosition": { - "type": "structure", - "members": { - "Type": { - "shape": "ReplicationStartingPositionType", - "locationName": "type", - "documentation": "

The type of replication starting position.

" - } - }, - "documentation": "

Configuration for specifying the position in the topics to start replicating from.

" - }, - "ReplicationStartingPositionType": { - "type": "string", - "enum": [ - "LATEST", - "EARLIEST" - ], - "documentation": "

The type of replication starting position.

" - }, - "ReplicationTopicNameConfiguration": { - "type": "structure", - "members": { - "Type": { - "shape": "ReplicationTopicNameConfigurationType", - "locationName": "type", - "documentation": "

The type of replicated topic name.

" - } - }, - "documentation": "

Configuration for specifying replicated topic names should be the same as their corresponding upstream topics or prefixed with source cluster alias.

" - }, - "ReplicationTopicNameConfigurationType": { - "type": "string", - "enum": [ - "PREFIXED_WITH_SOURCE_CLUSTER_ALIAS", - "IDENTICAL" - ], - "documentation": "

The type of replicated topic name.

" - }, - "ReplicationStateInfo": { - "type": "structure", - "members": { - "Code": { - "shape": "__string", - "locationName": "code", - "documentation": "Code that describes the current state of the replicator." - }, - "Message": { - "shape": "__string", - "locationName": "message", - "documentation": "Message that describes the state of the replicator." - } - }, - "documentation": "Details about the state of a replicator" - }, - "ReplicatorState": { - "type": "string", - "documentation": "

The state of a replicator.

", - "enum": [ - "RUNNING", - "CREATING", - "UPDATING", - "DELETING", - "FAILED" - ] - }, - "ReplicatorSummary": { - "type": "structure", - "members": { - "CreationTime": { - "shape": "__timestampIso8601", - "locationName": "creationTime", - "documentation": "

The time the replicator was created.

" - }, - "CurrentVersion": { - "shape": "__string", - "locationName": "currentVersion", - "documentation": "

The current version of the replicator.

" - }, - "IsReplicatorReference": { - "shape": "__boolean", - "locationName": "isReplicatorReference", - "documentation": "

Whether this resource is a replicator reference.

" - }, - "KafkaClustersSummary": { - "shape": "__listOfKafkaClusterSummary", - "locationName": "kafkaClustersSummary", - "documentation": "

Kafka Clusters used in setting up sources / targets for replication.

" - }, - "ReplicationInfoSummaryList": { - "shape": "__listOfReplicationInfoSummary", - "locationName": "replicationInfoSummaryList", - "documentation": "

A list of summarized information of replications between clusters.

" - }, - "ReplicatorArn": { - "shape": "__string", - "locationName": "replicatorArn", - "documentation": "

The Amazon Resource Name (ARN) of the replicator.

" - }, - "ReplicatorName": { - "shape": "__string", - "locationName": "replicatorName", - "documentation": "

The name of the replicator.

" - }, - "ReplicatorResourceArn": { - "shape": "__string", - "locationName": "replicatorResourceArn", - "documentation": "

The Amazon Resource Name (ARN) of the replicator resource in the region where the replicator was created.

" - }, - "ReplicatorState": { - "shape": "ReplicatorState", - "locationName": "replicatorState", - "documentation": "

State of the replicator.

" - } - }, - "documentation": "

Information about a replicator.

" - }, - "ServiceUnavailableException": { - "type": "structure", - "members": { - "InvalidParameter": { - "shape": "__string", - "locationName": "invalidParameter", - "documentation": "\n

The parameter that caused the error.

\n " - }, - "Message": { - "shape": "__string", - "locationName": "message", - "documentation": "\n

The description of the error.

\n " - } - }, - "documentation": "\n

Returns information about an error.

\n ", - "exception": true, - "error": { - "httpStatusCode": 503 - } - }, - "StateInfo": { - "type": "structure", - "members": { - "Code": { - "shape": "__string", - "locationName": "code" - }, - "Message": { - "shape": "__string", - "locationName": "message" - } - } - }, - "StorageInfo": { - "type": "structure", - "members": { - "EbsStorageInfo": { - "shape": "EBSStorageInfo", - "locationName": "ebsStorageInfo", - "documentation": "\n

EBS volume information.

\n " - } - }, - "documentation": "\n

Contains information about storage volumes attached to MSK broker nodes.

\n " - }, - "StorageMode": { - "type": "string", - "documentation": "Controls storage mode for various supported storage tiers.", - "enum": [ - "LOCAL", - "TIERED" - ] - }, - "TableCreation": { - "type": "structure", - "members": { - "EnableTableCreation": { - "shape": "__boolean", - "locationName": "enableTableCreation", - "documentation": "

Whether MSK creates the destination table on the customer's behalf. Must be true for the current release.

" - } - }, - "documentation": "

Configuration controlling whether MSK creates the destination Apache Iceberg table if it does not already exist.

" - }, - "TagResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "shape": "__string", - "location": "uri", - "locationName": "resourceArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.

\n " - }, - "Tags": { - "shape": "__mapOf__string", - "locationName": "tags", - "documentation": "\n

The key-value pair for the resource tag.

\n " - } - }, - "required": [ - "ResourceArn", - "Tags" - ] - }, - "TargetCompressionType": { - "type": "string", - "documentation": "

The type of compression to use producing records to the target cluster.

", - "enum": [ - "NONE", - "GZIP", - "SNAPPY", - "LZ4", - "ZSTD" - ] - }, - "Tls": { - "type": "structure", - "members": { - "CertificateAuthorityArnList": { - "shape": "__listOf__string", - "locationName": "certificateAuthorityArnList", - "documentation": "\n

List of ACM Certificate Authority ARNs.

\n " - }, - "Enabled": { - "shape": "__boolean", - "locationName": "enabled", - "documentation": "\n

Specifies whether you want to turn on or turn off TLS authentication.

\n " - } - }, - "documentation": "\n

Details for client authentication using TLS.

\n " - }, - "TopicConfiguration": { - "type": "structure", - "members": { - "RecordConverter": { - "shape": "RecordConverter", - "locationName": "recordConverter", - "documentation": "

Configuration that controls how Apache Kafka record values are deserialized for the destination.

" - }, - "RecordSchema": { - "shape": "RecordSchema", - "locationName": "recordSchema", - "documentation": "

The schema used to validate records when the value converter requires one (for example, JSON_SCHEMA_GSR).

" - }, - "TopicArn": { - "shape": "__string", - "locationName": "topicArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the topic.

\n " - } - }, - "documentation": "

Configuration of an Apache Kafka topic that feeds a channel.

", - "required": [ - "RecordConverter", - "TopicArn" - ] - }, - "TopicInfo": { - "type": "structure", - "members": { - "TopicArn": { - "shape": "__string", - "locationName": "topicArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the topic.

\n " - }, - "TopicName": { - "shape": "__string", - "locationName": "topicName", - "documentation": "\n

Name for a topic.

\n " - }, - "ReplicationFactor": { - "shape": "__integer", - "locationName": "replicationFactor", - "documentation": "\n

Replication factor for a topic.

\n " - }, - "PartitionCount": { - "shape": "__integer", - "locationName": "partitionCount", - "documentation": "\n

Partition count for a topic.

\n " - }, - "OutOfSyncReplicaCount": { - "shape": "__integer", - "locationName": "outOfSyncReplicaCount", - "documentation": "\n

Number of out-of-sync replicas for a topic.

\n " - } - }, - "documentation": "\n

Includes identification info about the topic.

\n " - }, - "VpcConnectivityTls": { - "type": "structure", - "members": { - "Enabled": { - "shape": "__boolean", - "locationName": "enabled", - "documentation": "\n

TLS authentication is on or off for VPC connectivity.

\n " - } - }, - "documentation": "\n

Details for TLS client authentication for VPC connectivity.

\n " - }, - "TooManyRequestsException": { - "type": "structure", - "members": { - "InvalidParameter": { - "shape": "__string", - "locationName": "invalidParameter", - "documentation": "\n

The parameter that caused the error.

\n " - }, - "Message": { - "shape": "__string", - "locationName": "message", - "documentation": "\n

The description of the error.

\n " - } - }, - "documentation": "\n

Returns information about an error.

\n ", - "exception": true, - "error": { - "httpStatusCode": 429 - } - }, - "TopicReplication": { - "type": "structure", - "members": { - "CopyAccessControlListsForTopics": { - "shape": "__boolean", - "locationName": "copyAccessControlListsForTopics", - "documentation": "

Whether to periodically configure remote topic ACLs to match their corresponding upstream topics.

" - }, - "CopyTopicConfigurations": { - "shape": "__boolean", - "locationName": "copyTopicConfigurations", - "documentation": "

Whether to periodically configure remote topics to match their corresponding upstream topics.

" - }, - "DetectAndCopyNewTopics": { - "shape": "__boolean", - "locationName": "detectAndCopyNewTopics", - "documentation": "

Whether to periodically check for new topics and partitions.

" - }, - "StartingPosition": { - "shape": "ReplicationStartingPosition", - "locationName": "startingPosition", - "documentation": "

Configuration for specifying the position in the topics to start replicating from.

" - }, - "TopicNameConfiguration": { - "shape": "ReplicationTopicNameConfiguration", - "locationName": "topicNameConfiguration", - "documentation": "

Configuration for specifying replicated topic names should be the same as their corresponding upstream topics or prefixed with source cluster alias.

" - }, - "TopicsToExclude": { - "shape": "__listOf__stringMax249", - "locationName": "topicsToExclude", - "documentation": "

List of regular expression patterns indicating the topics that should not be replicated.

" - }, - "TopicsToReplicate": { - "shape": "__listOf__stringMax249", - "locationName": "topicsToReplicate", - "documentation": "

List of regular expression patterns indicating the topics to copy.

" - } - }, - "documentation": "

Details about topic replication.

", - "required": [ - "TopicsToReplicate" - ] - }, - "TopicReplicationUpdate": { - "type": "structure", - "members": { - "CopyAccessControlListsForTopics": { - "shape": "__boolean", - "locationName": "copyAccessControlListsForTopics", - "documentation": "

Whether to periodically configure remote topic ACLs to match their corresponding upstream topics.

" - }, - "CopyTopicConfigurations": { - "shape": "__boolean", - "locationName": "copyTopicConfigurations", - "documentation": "

Whether to periodically configure remote topics to match their corresponding upstream topics.

" - }, - "DetectAndCopyNewTopics": { - "shape": "__boolean", - "locationName": "detectAndCopyNewTopics", - "documentation": "

Whether to periodically check for new topics and partitions.

" - }, - "TopicsToExclude": { - "shape": "__listOf__stringMax249", - "locationName": "topicsToExclude", - "documentation": "

List of regular expression patterns indicating the topics that should not be replicated.

" - }, - "TopicsToReplicate": { - "shape": "__listOf__stringMax249", - "locationName": "topicsToReplicate", - "documentation": "

List of regular expression patterns indicating the topics to copy.

" - } - }, - "documentation": "

Details for updating the topic replication of a replicator.

", - "required": [ - "TopicsToReplicate", - "TopicsToExclude", - "CopyTopicConfigurations", - "DetectAndCopyNewTopics", - "CopyAccessControlListsForTopics" - ] - }, - "Unauthenticated": { - "type": "structure", - "members": { - "Enabled": { - "shape": "__boolean", - "locationName": "enabled", - "documentation": "\n

Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.

\n " - } - } - }, - "UnauthorizedException": { - "type": "structure", - "members": { - "InvalidParameter": { - "shape": "__string", - "locationName": "invalidParameter", - "documentation": "\n

The parameter that caused the error.

\n " - }, - "Message": { - "shape": "__string", - "locationName": "message", - "documentation": "\n

The description of the error.

\n " - } - }, - "documentation": "\n

Returns information about an error.

\n ", - "exception": true, - "error": { - "httpStatusCode": 401 - } - }, - "UnprocessedScramSecret": { - "type": "structure", - "members": { - "ErrorCode": { - "shape": "__string", - "locationName": "errorCode", - "documentation": "\n

Error code for associate/disassociate failure.

\n " - }, - "ErrorMessage": { - "shape": "__string", - "locationName": "errorMessage", - "documentation": "\n

Error message for associate/disassociate failure.

\n " - }, - "SecretArn": { - "shape": "__string", - "locationName": "secretArn", - "documentation": "\n

AWS Secrets Manager secret ARN.

\n " - } - }, - "documentation": "\n

Error info for scram secret associate/disassociate failure.

\n " - }, - "UntagResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "shape": "__string", - "location": "uri", - "locationName": "resourceArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.

\n " - }, - "TagKeys": { - "shape": "__listOf__string", - "location": "querystring", - "locationName": "tagKeys", - "documentation": "\n

Tag keys must be unique for a given cluster. In addition, the following restrictions apply:

\n
    \n
  • \n

    Each tag key must be unique. If you add a tag with a key that's already in\n use, your new tag overwrites the existing key-value pair.

    \n
    • \n
  • \n

    You can't start a tag key with aws: because this prefix is reserved for use\n by AWS. AWS creates tags that begin with this prefix on your behalf, but\n you can't edit or delete them.

    \n
    • \n
  • \n

    Tag keys must be between 1 and 128 Unicode characters in length.

    \n
    • \n
  • \n

    Tag keys must consist of the following characters: Unicode letters, digits,\n white space, and the following special characters: _ . / = + -\n @.

    \n
    • \n
\n " - } - }, - "required": [ - "TagKeys", - "ResourceArn" - ] - }, - "UpdateBrokerCountRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

\n " - }, - "CurrentVersion": { - "shape": "__string", - "locationName": "currentVersion", - "documentation": "\n

The version of cluster to update from. A successful operation will then generate a new version.

\n " - }, - "TargetNumberOfBrokerNodes": { - "shape": "__integerMin1Max15", - "locationName": "targetNumberOfBrokerNodes", - "documentation": "\n

The number of broker nodes that you want the cluster to have after this operation completes successfully.

\n " - } - }, - "required": [ - "ClusterArn", - "CurrentVersion", - "TargetNumberOfBrokerNodes" - ] - }, - "UpdateBrokerCountResponse": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster.

\n " - }, - "ClusterOperationArn": { - "shape": "__string", - "locationName": "clusterOperationArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster operation.

\n " - } - } - }, - "UpdateBrokerTypeRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

\n " - }, - "CurrentVersion": { - "shape": "__string", - "locationName": "currentVersion", - "documentation": "\n

The cluster version that you want to change. After this operation completes successfully, the cluster will have a new version.

\n " - }, - "TargetInstanceType": { - "shape": "__string", - "locationName": "targetInstanceType", - "documentation": "\n

The Amazon MSK broker type that you want all of the brokers in this cluster to be.

\n " - } - }, - "required": [ - "ClusterArn", - "CurrentVersion", - "TargetInstanceType" - ] - }, - "UpdateBrokerTypeResponse": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster.

\n " - }, - "ClusterOperationArn": { - "shape": "__string", - "locationName": "clusterOperationArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster operation.

\n " - } - } - }, - "UpdateBrokerStorageRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

\n " - }, - "CurrentVersion": { - "shape": "__string", - "locationName": "currentVersion", - "documentation": "\n

The version of cluster to update from. A successful operation will then generate a new version.

\n " - }, - "TargetBrokerEBSVolumeInfo": { - "shape": "__listOfBrokerEBSVolumeInfo", - "locationName": "targetBrokerEBSVolumeInfo", - "documentation": "\n

Describes the target volume size and the ID of the broker to apply the update to.

\n " - } - }, - "required": [ - "ClusterArn", - "TargetBrokerEBSVolumeInfo", - "CurrentVersion" - ] - }, - "UpdateBrokerStorageResponse": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster.

\n " - }, - "ClusterOperationArn": { - "shape": "__string", - "locationName": "clusterOperationArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster operation.

\n " - } - } - }, - "S3CompressionType": { - "type": "string", - "enum": [ - "NONE", - "GZIP", - "ZSTD" - ], - "documentation": "

The compression codec applied to delivered Amazon S3 objects.

" - }, - "S3DestinationConfiguration": { - "type": "structure", - "members": { - "DataFreshnessInSeconds": { - "shape": "__integer", - "locationName": "dataFreshnessInSeconds", - "documentation": "

The maximum time, in seconds, that records buffer in MSK before being flushed to the destination. Allowed range: 300 to 900. Default: 600.

" - }, - "DeadLetterQueueS3": { - "shape": "DeadLetterQueueS3", - "locationName": "deadLetterQueueS3", - "documentation": "

The Amazon S3 bucket and prefix where MSK writes records that fail to deliver.

" - }, - "ServiceExecutionRoleArn": { - "shape": "__string", - "locationName": "serviceExecutionRoleArn", - "documentation": "

The Amazon Resource Name (ARN) of the IAM role that MSK assumes to write to the destination Amazon S3 bucket and the dead-letter bucket.

" - }, - "Storage": { - "shape": "S3Storage", - "locationName": "storage", - "documentation": "

The Amazon S3 bucket, prefix, and storage class for delivered records.

" - } - }, - "required": [ - "Storage", - "ServiceExecutionRoleArn", - "DeadLetterQueueS3" - ], - "documentation": "

Configuration of an Amazon S3 destination for a channel.

" - }, - "IcebergDestinationUpdate": { - "type": "structure", - "members": { - "DataFreshnessInSeconds": { - "shape": "__integer", - "locationName": "dataFreshnessInSeconds", - "documentation": "

The maximum time, in seconds, that records buffer in MSK before being flushed to the destination. Allowed range: 300 to 900.

" - } - }, - "required": [ - "DataFreshnessInSeconds" - ], - "documentation": "

Update payload for an Apache Iceberg destination.

" - }, - "S3DestinationUpdate": { - "type": "structure", - "members": { - "DataFreshnessInSeconds": { - "shape": "__integer", - "locationName": "dataFreshnessInSeconds", - "documentation": "

The maximum time, in seconds, that records buffer in MSK before being flushed to the destination. Allowed range: 300 to 900.

" - } - }, - "required": [ - "DataFreshnessInSeconds" - ], - "documentation": "

Update payload for an Amazon S3 destination.

" - }, - "S3Storage": { - "type": "structure", - "members": { - "BucketArn": { - "shape": "__string", - "locationName": "bucketArn", - "documentation": "

The Amazon Resource Name (ARN) of the destination Amazon S3 bucket.

" - }, - "CompressionType": { - "shape": "S3CompressionType", - "locationName": "compressionType", - "documentation": "

The compression codec applied to delivered Amazon S3 objects.

" - }, - "OutputPrefix": { - "shape": "__string", - "locationName": "outputPrefix", - "documentation": "

An optional prefix prepended to every Amazon S3 object key written by the channel.

" - }, - "OutputKeyTemplate": { - "shape": "__string", - "locationName": "outputKeyTemplate", - "documentation": "

An optional template that controls the Amazon S3 object key for each delivered record. Supports the placeholders !{partition-id}, !{sequence-number}, and !{kafka-offset}.

" - }, - "StorageClass": { - "shape": "S3StorageClass", - "locationName": "storageClass", - "documentation": "

The Amazon S3 storage class for delivered objects.

" - }, - "ExpectedBucketOwner": { - "shape": "__string", - "locationName": "expectedBucketOwner", - "documentation": "

Optional 12-digit AWS account ID expected to own the Amazon S3 bucket.

" - } - }, - "required": [ - "BucketArn", - "StorageClass", - "CompressionType" - ], - "documentation": "

Storage configuration for an Amazon S3 destination bucket.

" - }, - "S3StorageClass": { - "type": "string", - "enum": [ - "STANDARD", - "INTELLIGENT_TIERING", - "GLACIER_IR" - ], - "documentation": "

The Amazon S3 storage class applied to delivered objects.

" - }, - "UpdateChannelRequest": { - "type": "structure", - "members": { - "ChannelArn": { - "shape": "__string", - "location": "uri", - "locationName": "channelArn", - "documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the channel.

" - }, - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn", - "documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

" - }, - "IcebergDestinationUpdate": { - "shape": "IcebergDestinationUpdate", - "locationName": "icebergDestinationUpdate", - "documentation": "

Updates fields on an Apache Iceberg destination. Use only when the channel was created with an Iceberg destination.

" - }, - "S3DestinationUpdate": { - "shape": "S3DestinationUpdate", - "locationName": "s3DestinationUpdate", - "documentation": "

Updates fields on an Amazon S3 destination. Use only when the channel was created with an Amazon S3 destination.

" - } - }, - "required": [ - "ClusterArn", - "ChannelArn" - ], - "documentation": "

Updates an existing channel's destination configuration. You must update the same destination type the channel was created with; the destination type cannot be changed.

" - }, - "UpdateChannelResponse": { - "type": "structure", - "members": { - "ChannelArn": { - "shape": "__string", - "locationName": "channelArn", - "documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the channel.

" - }, - "ClusterOperationArn": { - "shape": "__string", - "locationName": "clusterOperationArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster operation.

\n " - } - }, - "required": [ - "ChannelArn" - ], - "documentation": "

Returns the channel ARN and the cluster-operation ARN that tracks the asynchronous update.

" - }, - "UpdateClusterConfigurationRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

\n " - }, - "ConfigurationInfo": { - "shape": "ConfigurationInfo", - "locationName": "configurationInfo", - "documentation": "\n

Represents the configuration that you want MSK to use for the brokers in a cluster.

\n " - }, - "CurrentVersion": { - "shape": "__string", - "locationName": "currentVersion", - "documentation": "\n

The version of the cluster that needs to be updated.

\n " - } - }, - "required": [ - "ClusterArn", - "CurrentVersion", - "ConfigurationInfo" - ] - }, - "UpdateClusterConfigurationResponse": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster.

\n " - }, - "ClusterOperationArn": { - "shape": "__string", - "locationName": "clusterOperationArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster operation.

\n " - } - } - }, - "UpdateClusterKafkaVersionRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster to be updated.

\n " - }, - "ConfigurationInfo": { - "shape": "ConfigurationInfo", - "locationName": "configurationInfo", - "documentation": "\n

The custom configuration that should be applied on the new version of cluster.

\n " - }, - "CurrentVersion": { - "shape": "__string", - "locationName": "currentVersion", - "documentation": "\n

Current cluster version.

\n " - }, - "TargetKafkaVersion": { - "shape": "__string", - "locationName": "targetKafkaVersion", - "documentation": "\n

Target Kafka version.

\n " - } - }, - "required": [ - "ClusterArn", - "TargetKafkaVersion", - "CurrentVersion" - ] - }, - "UpdateClusterKafkaVersionResponse": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster.

\n " - }, - "ClusterOperationArn": { - "shape": "__string", - "locationName": "clusterOperationArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster operation.

\n " - } - } - }, - "UpdateMonitoringRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

\n " - }, - "CurrentVersion": { - "shape": "__string", - "locationName": "currentVersion", - "documentation": "\n

The version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.

\n " - }, - "EnhancedMonitoring": { - "shape": "EnhancedMonitoring", - "locationName": "enhancedMonitoring", - "documentation": "\n

Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.

\n " - }, - "OpenMonitoring": { - "shape": "OpenMonitoringInfo", - "locationName": "openMonitoring", - "documentation": "\n

The settings for open monitoring.

\n " - }, - "LoggingInfo": { - "shape": "LoggingInfo", - "locationName": "loggingInfo" - } - }, - "documentation": "Request body for UpdateMonitoring.", - "required": [ - "ClusterArn", - "CurrentVersion" - ] - }, - "UpdateMonitoringResponse": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster.

\n " - }, - "ClusterOperationArn": { - "shape": "__string", - "locationName": "clusterOperationArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster operation.

\n " - } - } - }, - "UpdateRebalancingRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster.

\n " - }, - "CurrentVersion": { - "shape": "__string", - "locationName": "currentVersion", - "documentation": "\n

The current version of the cluster.

\n " - }, - "Rebalancing": { - "shape": "Rebalancing", - "locationName": "rebalancing", - "documentation": "\n

Specifies if intelligent rebalancing should be turned on for your cluster. The default intelligent rebalancing status is ACTIVE for all new MSK Provisioned clusters that you create with Express brokers.

\n " - } - }, - "required": [ - "ClusterArn", - "CurrentVersion", - "Rebalancing" - ] - }, - "UpdateRebalancingResponse": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster whose intelligent rebalancing status you've updated.

\n " - }, - "ClusterOperationArn": { - "shape": "__string", - "locationName": "clusterOperationArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster operation.

\n " - } - } - }, - "UpdateReplicationInfoRequest": { - "type": "structure", - "members": { - "ConsumerGroupReplication": { - "shape": "ConsumerGroupReplicationUpdate", - "locationName": "consumerGroupReplication", - "documentation": "

Updated consumer group replication information.

" - }, - "CurrentVersion": { - "shape": "__string", - "locationName": "currentVersion", - "documentation": "

Current replicator version.

" - }, - "ReplicatorArn": { - "shape": "__string", - "location": "uri", - "locationName": "replicatorArn", - "documentation": "

The Amazon Resource Name (ARN) of the replicator to be updated.

" - }, - "SourceKafkaClusterArn": { - "shape": "__string", - "locationName": "sourceKafkaClusterArn", - "documentation": "

The ARN of the source Kafka cluster.

" - }, - "SourceKafkaClusterId": { - "shape": "__string", - "locationName": "sourceKafkaClusterId", - "documentation": "

The ID of the source Kafka cluster.

" - }, - "TargetKafkaClusterArn": { - "shape": "__string", - "locationName": "targetKafkaClusterArn", - "documentation": "

The ARN of the target Kafka cluster.

" - }, - "TargetKafkaClusterId": { - "shape": "__string", - "locationName": "targetKafkaClusterId", - "documentation": "

The ID of the target Kafka cluster.

" - }, - "TopicReplication": { - "shape": "TopicReplicationUpdate", - "locationName": "topicReplication", - "documentation": "

Updated topic replication information.

" - }, - "LogDelivery": { - "shape": "LogDelivery", - "locationName": "logDelivery", - "documentation": "

Configuration for delivering replicator logs to customer destinations.

" - } - }, - "documentation": "

Update information relating to replication between a given source and target Kafka cluster.

", - "required": [ - "ReplicatorArn", - "CurrentVersion" - ] - }, - "UpdateReplicationInfoResponse": { - "type": "structure", - "members": { - "ReplicatorArn": { - "shape": "__string", - "locationName": "replicatorArn", - "documentation": "

The Amazon Resource Name (ARN) of the replicator.

" - }, - "ReplicatorState": { - "shape": "ReplicatorState", - "locationName": "replicatorState", - "documentation": "

State of the replicator.

" - } - } - }, - "UpdateSecurityRequest": { - "type": "structure", - "members": { - "ClientAuthentication": { - "shape": "ClientAuthentication", - "locationName": "clientAuthentication", - "documentation": "\n

Includes all client authentication related information.

\n " - }, - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

\n " - }, - "CurrentVersion": { - "shape": "__string", - "locationName": "currentVersion", - "documentation": "\n

The version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.

\n " - }, - "EncryptionInfo": { - "shape": "EncryptionInfo", - "locationName": "encryptionInfo", - "documentation": "\n

Includes all encryption-related information.

\n " - } - }, - "required": [ - "ClusterArn", - "CurrentVersion" - ] - }, - "UpdateSecurityResponse": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster.

\n " - }, - "ClusterOperationArn": { - "shape": "__string", - "locationName": "clusterOperationArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster operation.

\n " - } - } - }, - "UpdateStorageRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster to be updated.

\n " - }, - "CurrentVersion": { - "shape": "__string", - "locationName": "currentVersion", - "documentation": "\n

The version of cluster to update from. A successful operation will then generate a new version.

\n " - }, - "ProvisionedThroughput": { - "shape": "ProvisionedThroughput", - "locationName": "provisionedThroughput", - "documentation": "\n

EBS volume provisioned throughput information.

\n " - }, - "StorageMode": { - "shape": "StorageMode", - "locationName": "storageMode", - "documentation": "\n

Controls storage mode for supported storage tiers.

\n " - }, - "VolumeSizeGB": { - "shape": "__integer", - "locationName": "volumeSizeGB", - "documentation": "\n

size of the EBS volume to update.

\n " - } - }, - "documentation": "\n

Request object for UpdateStorage api. Its used to update the storage attributes for the cluster.

\n ", - "required": [ - "ClusterArn", - "CurrentVersion" - ] - }, - "UpdateStorageResponse": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster.

\n " - }, - "ClusterOperationArn": { - "shape": "__string", - "locationName": "clusterOperationArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster operation.

\n " - } - } - }, - "UpdateConfigurationRequest": { - "type": "structure", - "members": { - "Arn": { - "shape": "__string", - "location": "uri", - "locationName": "arn", - "documentation": "\n

The Amazon Resource Name (ARN) of the configuration.

\n " - }, - "Description": { - "shape": "__string", - "locationName": "description", - "documentation": "\n

The description of the configuration revision.

\n " - }, - "ServerProperties": { - "shape": "__blob", - "locationName": "serverProperties", - "documentation": "\n

Contents of the server.properties file. When using the API, you must ensure that the contents of the file are base64 encoded. \n When using the AWS Management Console, the SDK, or the AWS CLI, the contents of server.properties can be in plaintext.

\n " - } - }, - "required": [ - "Arn", - "ServerProperties" - ] - }, - "UpdateConfigurationResponse": { - "type": "structure", - "members": { - "Arn": { - "shape": "__string", - "locationName": "arn", - "documentation": "\n

The Amazon Resource Name (ARN) of the configuration.

\n " - }, - "LatestRevision": { - "shape": "ConfigurationRevision", - "locationName": "latestRevision", - "documentation": "\n

Latest revision of the configuration.

\n " - } - } - }, - "UpdateConnectivityRequest": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "location": "uri", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the configuration.

\n " - }, - "ConnectivityInfo": { - "shape": "ConnectivityInfo", - "locationName": "connectivityInfo", - "documentation": "\n

Information about the broker access configuration.

\n " - }, - "CurrentVersion": { - "shape": "__string", - "locationName": "currentVersion", - "documentation": "\n

The version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.

\n " - }, - "ZookeeperAccess": { - "shape": "ZookeeperAccess", - "locationName": "zookeeperAccess", - "documentation": "\n

Access control settings for zookeeper

\n " - } - }, - "documentation": "Request body for UpdateConnectivity.", - "required": [ - "ClusterArn", - "CurrentVersion" - ] - }, - "UpdateConnectivityResponse": { - "type": "structure", - "members": { - "ClusterArn": { - "shape": "__string", - "locationName": "clusterArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster.

\n " - }, - "ClusterOperationArn": { - "shape": "__string", - "locationName": "clusterOperationArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the cluster operation.

\n " - } - } - }, - "UserIdentity": { - "type": "structure", - "members": { - "Type": { - "shape": "UserIdentityType", - "locationName": "type", - "documentation": "\n

The identity type of the requester that calls the API operation.

\n " - }, - "PrincipalId": { - "shape": "__string", - "locationName": "principalId", - "documentation": "\n

A unique identifier for the requester that calls the API operation.

\n " - } - }, - "documentation": "\n

Description of the requester that calls the API operation.

\n " - }, - "UserIdentityType": { - "type": "string", - "documentation": "\n

The identity type of the requester that calls the API operation.

\n ", - "enum": [ - "AWSACCOUNT", - "AWSSERVICE" - ] - }, - "ValueConverter": { - "type": "string", - "documentation": "

The deserialization format applied to Apache Kafka record values.

", - "enum": [ - "BYTE_ARRAY", - "JSON", - "JSON_SCHEMA_GSR", - "STRING" - ] - }, - "VpcConnectionInfo": { - "type": "structure", - "members": { - "VpcConnectionArn": { - "shape": "__string", - "locationName": "vpcConnectionArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the VPC connection.

\n " - }, - "Owner": { - "shape": "__string", - "locationName": "owner", - "documentation": "\n

The owner of the VPC Connection.

\n " - }, - "UserIdentity": { - "shape": "UserIdentity", - "locationName": "userIdentity", - "documentation": "\n

Description of the requester that calls the API operation.

\n " - }, - "CreationTime": { - "shape": "__timestampIso8601", - "locationName": "creationTime", - "documentation": "\n

The time when Amazon MSK creates the VPC Connnection.

\n " - } - }, - "documentation": "\n

Description of the VPC connection.

\n " - }, - "VpcConnectionInfoServerless": { - "type": "structure", - "members": { - "CreationTime": { - "shape": "__timestampIso8601", - "locationName": "creationTime", - "documentation": "\n

The time when Amazon MSK creates the VPC Connnection.

" - }, - "Owner": { - "shape": "__string", - "locationName": "owner", - "documentation": "\n

The owner of the VPC Connection.

" - }, - "UserIdentity": { - "shape": "UserIdentity", - "locationName": "userIdentity", - "documentation": "\n

Description of the requester that calls the API operation.

" - }, - "VpcConnectionArn": { - "shape": "__string", - "locationName": "vpcConnectionArn", - "documentation": "\n

The Amazon Resource Name (ARN) of the VPC connection.

" - } - }, - "documentation": "Description of the VPC connection." - }, - "TopicState": { - "type": "string", - "documentation": "\n

The state of a topic request.

\n ", - "enum": [ - "CREATING", - "UPDATING", - "DELETING", - "ACTIVE" - ] - }, - "VpcConnectionState": { - "type": "string", - "documentation": "\n

The state of a VPC connection.

\n ", - "enum": [ - "CREATING", - "AVAILABLE", - "INACTIVE", - "DEACTIVATING", - "DELETING", - "FAILED", - "REJECTED", - "REJECTING" - ] - }, - "VpcConnectivity": { - "type": "structure", - "members": { - "ClientAuthentication": { - "shape": "VpcConnectivityClientAuthentication", - "locationName": "clientAuthentication", - "documentation": "\n

Includes all client authentication information for VPC connectivity.

\n " - } - }, - "documentation": "VPC connectivity access control for brokers." - }, - "ZookeeperNodeInfo": { - "type": "structure", - "members": { - "AttachedENIId": { - "shape": "__string", - "locationName": "attachedENIId", - "documentation": "\n

The attached elastic network interface of the broker.

\n " - }, - "ClientVpcIpAddress": { - "shape": "__string", - "locationName": "clientVpcIpAddress", - "documentation": "\n

The virtual private cloud (VPC) IP address of the client.

\n " - }, - "Endpoints": { - "shape": "__listOf__string", - "locationName": "endpoints", - "documentation": "\n

Endpoints for accessing the ZooKeeper.

\n " - }, - "ZookeeperId": { - "shape": "__double", - "locationName": "zookeeperId", - "documentation": "\n

The role-specific ID for Zookeeper.

\n " - }, - "ZookeeperVersion": { - "shape": "__string", - "locationName": "zookeeperVersion", - "documentation": "\n

The version of Zookeeper.

\n " - } - }, - "documentation": "\n

Zookeeper node information.

\n " - }, - "__boolean": { - "type": "boolean" - }, - "__blob": { - "type": "blob" - }, - "__double": { - "type": "double" - }, - "__integer": { - "type": "integer" - }, - "__integerMin1Max15": { - "type": "integer", - "min": 1, - "max": 15 - }, - "__integerMin1Max16384": { - "type": "integer", - "min": 1, - "max": 16384 - }, - "__integerMin1": { - "type": "integer", - "min": 1 - }, - "__listOfBrokerEBSVolumeInfo": { - "type": "list", - "member": { - "shape": "BrokerEBSVolumeInfo" - } - }, - "__listOfClusterInfo": { - "type": "list", - "member": { - "shape": "ClusterInfo" - } - }, - "__listOfCluster": { - "type": "list", - "member": { - "shape": "Cluster" - } - }, - "__listOfClusterOperationInfo": { - "type": "list", - "member": { - "shape": "ClusterOperationInfo" - } - }, - "__listOfClusterOperationV2Summary": { - "type": "list", - "member": { - "shape": "ClusterOperationV2Summary" - } - }, - "__listOfChannelInfo": { - "type": "list", - "member": { - "shape": "ChannelInfo" - } - }, - "__listOfClusterOperationStep": { - "type": "list", - "member": { - "shape": "ClusterOperationStep" - } - }, - "__listOfCompatibleKafkaVersion": { - "type": "list", - "member": { - "shape": "CompatibleKafkaVersion" - } - }, - "__listOfDestinationTable": { - "type": "list", - "member": { - "shape": "DestinationTable" - } - }, - "__listOfTopicConfiguration": { - "type": "list", - "member": { - "shape": "TopicConfiguration" - } - }, - "__listOfVpcConfig": { - "type": "list", - "member": { - "shape": "VpcConfig" - } - }, - "__listOfConfiguration": { - "type": "list", - "member": { - "shape": "Configuration" - } - }, - "__listOfConfigurationRevision": { - "type": "list", - "member": { - "shape": "ConfigurationRevision" - } - }, - "__listOfKafkaVersion": { - "type": "list", - "member": { - "shape": "KafkaVersion" - } - }, - "__listOfKafkaCluster": { - "type": "list", - "member": { - "shape": "KafkaCluster" - } - }, - "__listOfKafkaClusterDescription": { - "type": "list", - "member": { - "shape": "KafkaClusterDescription" - } - }, - "__listOfKafkaClusterSummary": { - "type": "list", - "member": { - "shape": "KafkaClusterSummary" - } - }, - "__listOfNodeInfo": { - "type": "list", - "member": { - "shape": "NodeInfo" - } - }, - "__listOfPartitionSource": { - "type": "list", - "member": { - "shape": "PartitionSource" - } - }, - "__listOfClientVpcConnection": { - "type": "list", - "member": { - "shape": "ClientVpcConnection" - } - }, - "__listOfReplicationInfo": { - "type": "list", - "member": { - "shape": "ReplicationInfo" - } - }, - "__listOfReplicationInfoDescription": { - "type": "list", - "member": { - "shape": "ReplicationInfoDescription" - } - }, - "__listOfReplicationInfoSummary": { - "type": "list", - "member": { - "shape": "ReplicationInfoSummary" - } - }, - "__listOfReplicatorSummary": { - "type": "list", - "member": { - "shape": "ReplicatorSummary" - } - }, - "__listOfTopicInfo": { - "type": "list", - "member": { - "shape": "TopicInfo" - } - }, - "__listOfTopicPartitionInfo": { - "type": "list", - "member": { - "shape": "TopicPartitionInfo" - } - }, - "__listOfVpcConnection": { - "type": "list", - "member": { - "shape": "VpcConnection" - } - }, - "__listOfUnprocessedScramSecret": { - "type": "list", - "member": { - "shape": "UnprocessedScramSecret" - } - }, - "__listOf__double": { - "type": "list", - "member": { - "shape": "__double" - } - }, - "__listOf__string": { - "type": "list", - "member": { - "shape": "__string" - } - }, - "__listOf__integer": { - "type": "list", - "member": { - "shape": "__integer" - } - }, - "__long": { - "type": "long" - }, - "__mapOf__string": { - "type": "map", - "key": { - "shape": "__string" - }, - "value": { - "shape": "__string" - } - }, - "__listOf__stringMax249": { - "type": "list", - "member": { - "shape": "__stringMax249" - } - }, - "__listOf__stringMax256": { - "type": "list", - "member": { - "shape": "__stringMax256" - } - }, - "__string": { - "type": "string" - }, - "__stringMax1024": { - "type": "string", - "max": 1024 - }, - "__stringMax249": { - "type": "string", - "max": 249 - }, - "__stringMax256": { - "type": "string", - "max": 256 - }, - "__stringMin1Max128": { - "type": "string", - "min": 1, - "max": 128 - }, - "__stringMin1Max64": { - "type": "string", - "min": 1, - "max": 64 - }, - "__stringMin5Max32": { - "type": "string", - "min": 5, - "max": 32 - }, - "__stringMin1Max128Pattern09AZaZ09AZaZ0": { - "type": "string", - "min": 1, - "max": 128, - "pattern": "^[0-9A-Za-z][0-9A-Za-z-]{0,}$" - }, - "__timestampIso8601": { - "type": "timestamp", - "timestampFormat": "iso8601" - }, - "__timestampUnix": { - "type": "timestamp", - "timestampFormat": "unixTimestamp" - } - }, - "documentation": "\n

The operations for managing an Amazon MSK cluster.

\n " -} \ No newline at end of file diff --git a/tools/code-generation/api-descriptions/lambda-2015-03-31.normal.json b/tools/code-generation/api-descriptions/lambda-2015-03-31.normal.json index 772b4c97ad40..3ad6ccde297e 100644 --- a/tools/code-generation/api-descriptions/lambda-2015-03-31.normal.json +++ b/tools/code-generation/api-descriptions/lambda-2015-03-31.normal.json @@ -4460,7 +4460,7 @@ }, "S3ObjectStorageMode":{ "shape":"S3ObjectStorageMode", - "documentation":"

Specifies how the deployment package is stored. Use COPY (default) to upload a copy of your deployment package to Lambda. Use REFERENCE to have Lambda reference the deployment package from the specified Amazon S3 bucket.

" + "documentation":"

Specifies how the deployment package is stored. Valid values:

  • COPY (default) – Uploads a copy of your deployment package to Lambda.

  • REFERENCE – Lambda references the deployment package from the specified Amazon S3 bucket.

" }, "ImageUri":{ "shape":"String", @@ -4512,14 +4512,14 @@ "members":{ "ErrorCode":{ "shape":"String", - "documentation":"

The error code for the failed retrieval.

" + "documentation":"

The error code that identifies why Lambda failed to retrieve the deployment package.

" }, "Message":{ "shape":"SensitiveString", - "documentation":"

A description of the error.

" + "documentation":"

The human-readable message that describes why Lambda failed to retrieve the deployment package.

" } }, - "documentation":"

Details about an error related to retrieving a function's deployment package.

" + "documentation":"

Contains details about an error that occurred when Lambda attempted to retrieve a function's deployment package.

" }, "FunctionConfiguration":{ "type":"structure", @@ -6381,7 +6381,10 @@ "shape":"S3ObjectVersion", "documentation":"

For versioned objects, the version of the layer archive object to use.

" }, - "S3ObjectStorageMode":{"shape":"S3ObjectStorageMode"}, + "S3ObjectStorageMode":{ + "shape":"S3ObjectStorageMode", + "documentation":"

Specifies how the layer archive is stored. Valid values:

  • COPY (default) – Uploads a copy of your layer archive to Lambda.

  • REFERENCE – Lambda references the layer archive from the specified Amazon S3 bucket.

" + }, "ZipFile":{ "shape":"Blob", "documentation":"

The base64-encoded contents of the layer archive. Amazon Web Services SDK and Amazon Web Services CLI clients handle the encoding for you.

" @@ -6412,7 +6415,10 @@ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of a signing job.

" }, - "ResolvedS3Object":{"shape":"ResolvedS3Object"} + "ResolvedS3Object":{ + "shape":"ResolvedS3Object", + "documentation":"

The resolved Amazon S3 object that contains the layer archive.

" + } }, "documentation":"

Details about a version of an Lambda layer.

" }, @@ -8424,6 +8430,8 @@ "provided", "provided.al2", "provided.al2023", + "nodejs26.x", + "python3.15", "java8.al2023", "java11.al2023", "java17.al2023" @@ -8534,7 +8542,7 @@ }, "S3ObjectStorageMode":{ "type":"string", - "documentation":"

The storage mode for a function's deployment package.

", + "documentation":"

The method Lambda uses to store a function's deployment package — either by copying the package into Lambda-managed storage (COPY) or by referencing it directly from the source Amazon S3 bucket (REFERENCE).

", "enum":[ "COPY", "REFERENCE" @@ -9566,7 +9574,7 @@ }, "S3ObjectStorageMode":{ "shape":"S3ObjectStorageMode", - "documentation":"

Specifies how the deployment package is stored. Use COPY (default) to upload a copy of your deployment package to Lambda. Use REFERENCE to have Lambda reference the deployment package from the specified Amazon S3 bucket.

" + "documentation":"

Specifies how the deployment package is stored. Valid values:

  • COPY (default) – Uploads a copy of your deployment package to Lambda.

  • REFERENCE – Lambda references the deployment package from the specified Amazon S3 bucket.

" }, "ImageUri":{ "shape":"String", diff --git a/tools/code-generation/api-descriptions/lambda/2015-03-31/api-2.json b/tools/code-generation/api-descriptions/lambda/2015-03-31/api-2.json deleted file mode 100644 index c2ebdbcbd31d..000000000000 --- a/tools/code-generation/api-descriptions/lambda/2015-03-31/api-2.json +++ /dev/null @@ -1,7181 +0,0 @@ -{ - "version":"2.0", - "metadata":{ - "apiVersion":"2015-03-31", - "auth":["aws.auth#sigv4"], - "endpointPrefix":"lambda", - "protocol":"rest-json", - "protocols":["rest-json"], - "serviceFullName":"AWS Lambda", - "serviceId":"Lambda", - "signatureVersion":"v4", - "signingName":"lambda", - "uid":"lambda-2015-03-31" - }, - "operations":{ - "AddLayerVersionPermission":{ - "name":"AddLayerVersionPermission", - "http":{ - "method":"POST", - "requestUri":"/2018-10-31/layers/{LayerName}/versions/{VersionNumber}/policy", - "responseCode":201 - }, - "input":{"shape":"AddLayerVersionPermissionRequest"}, - "output":{"shape":"AddLayerVersionPermissionResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"PolicyLengthExceededException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"PreconditionFailedException"} - ] - }, - "AddPermission":{ - "name":"AddPermission", - "http":{ - "method":"POST", - "requestUri":"/2015-03-31/functions/{FunctionName}/policy", - "responseCode":201 - }, - "input":{"shape":"AddPermissionRequest"}, - "output":{"shape":"AddPermissionResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"PublicPolicyException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"PolicyLengthExceededException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"PreconditionFailedException"} - ] - }, - "CheckpointDurableExecution":{ - "name":"CheckpointDurableExecution", - "http":{ - "method":"POST", - "requestUri":"/2025-12-01/durable-executions/{DurableExecutionArn}/checkpoint", - "responseCode":200 - }, - "input":{"shape":"CheckpointDurableExecutionRequest"}, - "output":{"shape":"CheckpointDurableExecutionResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"KMSInvalidStateException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"KMSNotFoundException"}, - {"shape":"KMSAccessDeniedException"}, - {"shape":"KMSDisabledException"} - ], - "idempotent":true - }, - "CreateAlias":{ - "name":"CreateAlias", - "http":{ - "method":"POST", - "requestUri":"/2015-03-31/functions/{FunctionName}/aliases", - "responseCode":201 - }, - "input":{"shape":"CreateAliasRequest"}, - "output":{"shape":"AliasConfiguration"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"AliasLimitExceededException"}, - {"shape":"ResourceNotFoundException"} - ], - "idempotent":true - }, - "CreateCapacityProvider":{ - "name":"CreateCapacityProvider", - "http":{ - "method":"POST", - "requestUri":"/2025-11-30/capacity-providers", - "responseCode":202 - }, - "input":{"shape":"CreateCapacityProviderRequest"}, - "output":{"shape":"CreateCapacityProviderResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"CapacityProviderLimitExceededException"} - ], - "idempotent":true - }, - "CreateCodeSigningConfig":{ - "name":"CreateCodeSigningConfig", - "http":{ - "method":"POST", - "requestUri":"/2020-04-22/code-signing-configs", - "responseCode":201 - }, - "input":{"shape":"CreateCodeSigningConfigRequest"}, - "output":{"shape":"CreateCodeSigningConfigResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"} - ] - }, - "CreateEventSourceMapping":{ - "name":"CreateEventSourceMapping", - "http":{ - "method":"POST", - "requestUri":"/2015-03-31/event-source-mappings", - "responseCode":202 - }, - "input":{"shape":"CreateEventSourceMappingRequest"}, - "output":{"shape":"EventSourceMappingConfiguration"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ] - }, - "CreateFunction":{ - "name":"CreateFunction", - "http":{ - "method":"POST", - "requestUri":"/2015-03-31/functions", - "responseCode":201 - }, - "input":{"shape":"CreateFunctionRequest"}, - "output":{"shape":"FunctionConfiguration"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"InvalidCodeSignatureException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"CodeVerificationFailedException"}, - {"shape":"CodeSigningConfigNotFoundException"}, - {"shape":"CodeStorageExceededException"}, - {"shape":"FunctionVersionsPerCapacityProviderLimitExceededException"} - ], - "idempotent":true - }, - "CreateFunctionUrlConfig":{ - "name":"CreateFunctionUrlConfig", - "http":{ - "method":"POST", - "requestUri":"/2021-10-31/functions/{FunctionName}/url", - "responseCode":201 - }, - "input":{"shape":"CreateFunctionUrlConfigRequest"}, - "output":{"shape":"CreateFunctionUrlConfigResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ] - }, - "DeleteAlias":{ - "name":"DeleteAlias", - "http":{ - "method":"DELETE", - "requestUri":"/2015-03-31/functions/{FunctionName}/aliases/{Name}", - "responseCode":204 - }, - "input":{"shape":"DeleteAliasRequest"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "idempotent":true - }, - "DeleteCapacityProvider":{ - "name":"DeleteCapacityProvider", - "http":{ - "method":"DELETE", - "requestUri":"/2025-11-30/capacity-providers/{CapacityProviderName}", - "responseCode":202 - }, - "input":{"shape":"DeleteCapacityProviderRequest"}, - "output":{"shape":"DeleteCapacityProviderResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "idempotent":true - }, - "DeleteCodeSigningConfig":{ - "name":"DeleteCodeSigningConfig", - "http":{ - "method":"DELETE", - "requestUri":"/2020-04-22/code-signing-configs/{CodeSigningConfigArn}", - "responseCode":204 - }, - "input":{"shape":"DeleteCodeSigningConfigRequest"}, - "output":{"shape":"DeleteCodeSigningConfigResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"ResourceNotFoundException"} - ], - "idempotent":true - }, - "DeleteEventSourceMapping":{ - "name":"DeleteEventSourceMapping", - "http":{ - "method":"DELETE", - "requestUri":"/2015-03-31/event-source-mappings/{UUID}", - "responseCode":202 - }, - "input":{"shape":"DeleteEventSourceMappingRequest"}, - "output":{"shape":"EventSourceMappingConfiguration"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceInUseException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "idempotent":true - }, - "DeleteFunction":{ - "name":"DeleteFunction", - "http":{ - "method":"DELETE", - "requestUri":"/2015-03-31/functions/{FunctionName}", - "responseCode":200 - }, - "input":{"shape":"DeleteFunctionRequest"}, - "output":{"shape":"DeleteFunctionResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "idempotent":true - }, - "DeleteFunctionCodeSigningConfig":{ - "name":"DeleteFunctionCodeSigningConfig", - "http":{ - "method":"DELETE", - "requestUri":"/2020-06-30/functions/{FunctionName}/code-signing-config", - "responseCode":204 - }, - "input":{"shape":"DeleteFunctionCodeSigningConfigRequest"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"CodeSigningConfigNotFoundException"} - ] - }, - "DeleteFunctionConcurrency":{ - "name":"DeleteFunctionConcurrency", - "http":{ - "method":"DELETE", - "requestUri":"/2017-10-31/functions/{FunctionName}/concurrency", - "responseCode":204 - }, - "input":{"shape":"DeleteFunctionConcurrencyRequest"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ] - }, - "DeleteFunctionEventInvokeConfig":{ - "name":"DeleteFunctionEventInvokeConfig", - "http":{ - "method":"DELETE", - "requestUri":"/2019-09-25/functions/{FunctionName}/event-invoke-config", - "responseCode":204 - }, - "input":{"shape":"DeleteFunctionEventInvokeConfigRequest"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ] - }, - "DeleteFunctionUrlConfig":{ - "name":"DeleteFunctionUrlConfig", - "http":{ - "method":"DELETE", - "requestUri":"/2021-10-31/functions/{FunctionName}/url", - "responseCode":204 - }, - "input":{"shape":"DeleteFunctionUrlConfigRequest"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ] - }, - "DeleteLayerVersion":{ - "name":"DeleteLayerVersion", - "http":{ - "method":"DELETE", - "requestUri":"/2018-10-31/layers/{LayerName}/versions/{VersionNumber}", - "responseCode":204 - }, - "input":{"shape":"DeleteLayerVersionRequest"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "idempotent":true - }, - "DeleteProvisionedConcurrencyConfig":{ - "name":"DeleteProvisionedConcurrencyConfig", - "http":{ - "method":"DELETE", - "requestUri":"/2019-09-30/functions/{FunctionName}/provisioned-concurrency", - "responseCode":204 - }, - "input":{"shape":"DeleteProvisionedConcurrencyConfigRequest"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "idempotent":true - }, - "GetAccountSettings":{ - "name":"GetAccountSettings", - "http":{ - "method":"GET", - "requestUri":"/2016-08-19/account-settings", - "responseCode":200 - }, - "input":{"shape":"GetAccountSettingsRequest"}, - "output":{"shape":"GetAccountSettingsResponse"}, - "errors":[ - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"} - ], - "readonly":true - }, - "GetAlias":{ - "name":"GetAlias", - "http":{ - "method":"GET", - "requestUri":"/2015-03-31/functions/{FunctionName}/aliases/{Name}", - "responseCode":200 - }, - "input":{"shape":"GetAliasRequest"}, - "output":{"shape":"AliasConfiguration"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "readonly":true - }, - "GetCapacityProvider":{ - "name":"GetCapacityProvider", - "http":{ - "method":"GET", - "requestUri":"/2025-11-30/capacity-providers/{CapacityProviderName}", - "responseCode":200 - }, - "input":{"shape":"GetCapacityProviderRequest"}, - "output":{"shape":"GetCapacityProviderResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "readonly":true - }, - "GetCodeSigningConfig":{ - "name":"GetCodeSigningConfig", - "http":{ - "method":"GET", - "requestUri":"/2020-04-22/code-signing-configs/{CodeSigningConfigArn}", - "responseCode":200 - }, - "input":{"shape":"GetCodeSigningConfigRequest"}, - "output":{"shape":"GetCodeSigningConfigResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"ResourceNotFoundException"} - ], - "readonly":true - }, - "GetDurableExecution":{ - "name":"GetDurableExecution", - "http":{ - "method":"GET", - "requestUri":"/2025-12-01/durable-executions/{DurableExecutionArn}", - "responseCode":200 - }, - "input":{"shape":"GetDurableExecutionRequest"}, - "output":{"shape":"GetDurableExecutionResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"KMSInvalidStateException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"KMSNotFoundException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"KMSAccessDeniedException"}, - {"shape":"KMSDisabledException"} - ], - "readonly":true - }, - "GetDurableExecutionHistory":{ - "name":"GetDurableExecutionHistory", - "http":{ - "method":"GET", - "requestUri":"/2025-12-01/durable-executions/{DurableExecutionArn}/history", - "responseCode":200 - }, - "input":{"shape":"GetDurableExecutionHistoryRequest"}, - "output":{"shape":"GetDurableExecutionHistoryResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"KMSInvalidStateException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"KMSNotFoundException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"KMSAccessDeniedException"}, - {"shape":"KMSDisabledException"} - ], - "readonly":true - }, - "GetDurableExecutionState":{ - "name":"GetDurableExecutionState", - "http":{ - "method":"GET", - "requestUri":"/2025-12-01/durable-executions/{DurableExecutionArn}/state", - "responseCode":200 - }, - "input":{"shape":"GetDurableExecutionStateRequest"}, - "output":{"shape":"GetDurableExecutionStateResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"KMSInvalidStateException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"KMSNotFoundException"}, - {"shape":"KMSAccessDeniedException"}, - {"shape":"KMSDisabledException"} - ], - "readonly":true - }, - "GetEventSourceMapping":{ - "name":"GetEventSourceMapping", - "http":{ - "method":"GET", - "requestUri":"/2015-03-31/event-source-mappings/{UUID}", - "responseCode":200 - }, - "input":{"shape":"GetEventSourceMappingRequest"}, - "output":{"shape":"EventSourceMappingConfiguration"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "readonly":true - }, - "GetFunction":{ - "name":"GetFunction", - "http":{ - "method":"GET", - "requestUri":"/2015-03-31/functions/{FunctionName}", - "responseCode":200 - }, - "input":{"shape":"GetFunctionRequest"}, - "output":{"shape":"GetFunctionResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "readonly":true - }, - "GetFunctionCodeSigningConfig":{ - "name":"GetFunctionCodeSigningConfig", - "http":{ - "method":"GET", - "requestUri":"/2020-06-30/functions/{FunctionName}/code-signing-config", - "responseCode":200 - }, - "input":{"shape":"GetFunctionCodeSigningConfigRequest"}, - "output":{"shape":"GetFunctionCodeSigningConfigResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"CodeSigningConfigNotFoundException"} - ], - "readonly":true - }, - "GetFunctionConcurrency":{ - "name":"GetFunctionConcurrency", - "http":{ - "method":"GET", - "requestUri":"/2019-09-30/functions/{FunctionName}/concurrency", - "responseCode":200 - }, - "input":{"shape":"GetFunctionConcurrencyRequest"}, - "output":{"shape":"GetFunctionConcurrencyResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "readonly":true - }, - "GetFunctionConfiguration":{ - "name":"GetFunctionConfiguration", - "http":{ - "method":"GET", - "requestUri":"/2015-03-31/functions/{FunctionName}/configuration", - "responseCode":200 - }, - "input":{"shape":"GetFunctionConfigurationRequest"}, - "output":{"shape":"FunctionConfiguration"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "readonly":true - }, - "GetFunctionEventInvokeConfig":{ - "name":"GetFunctionEventInvokeConfig", - "http":{ - "method":"GET", - "requestUri":"/2019-09-25/functions/{FunctionName}/event-invoke-config", - "responseCode":200 - }, - "input":{"shape":"GetFunctionEventInvokeConfigRequest"}, - "output":{"shape":"FunctionEventInvokeConfig"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "readonly":true - }, - "GetFunctionRecursionConfig":{ - "name":"GetFunctionRecursionConfig", - "http":{ - "method":"GET", - "requestUri":"/2024-08-31/functions/{FunctionName}/recursion-config", - "responseCode":200 - }, - "input":{"shape":"GetFunctionRecursionConfigRequest"}, - "output":{"shape":"GetFunctionRecursionConfigResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "readonly":true - }, - "GetFunctionScalingConfig":{ - "name":"GetFunctionScalingConfig", - "http":{ - "method":"GET", - "requestUri":"/2025-11-30/functions/{FunctionName}/function-scaling-config", - "responseCode":200 - }, - "input":{"shape":"GetFunctionScalingConfigRequest"}, - "output":{"shape":"GetFunctionScalingConfigResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "readonly":true - }, - "GetFunctionUrlConfig":{ - "name":"GetFunctionUrlConfig", - "http":{ - "method":"GET", - "requestUri":"/2021-10-31/functions/{FunctionName}/url", - "responseCode":200 - }, - "input":{"shape":"GetFunctionUrlConfigRequest"}, - "output":{"shape":"GetFunctionUrlConfigResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "readonly":true - }, - "GetLayerVersion":{ - "name":"GetLayerVersion", - "http":{ - "method":"GET", - "requestUri":"/2018-10-31/layers/{LayerName}/versions/{VersionNumber}", - "responseCode":200 - }, - "input":{"shape":"GetLayerVersionRequest"}, - "output":{"shape":"GetLayerVersionResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "readonly":true - }, - "GetLayerVersionByArn":{ - "name":"GetLayerVersionByArn", - "http":{ - "method":"GET", - "requestUri":"/2018-10-31/layers?find=LayerVersion", - "responseCode":200 - }, - "input":{"shape":"GetLayerVersionByArnRequest"}, - "output":{"shape":"GetLayerVersionResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "readonly":true - }, - "GetLayerVersionPolicy":{ - "name":"GetLayerVersionPolicy", - "http":{ - "method":"GET", - "requestUri":"/2018-10-31/layers/{LayerName}/versions/{VersionNumber}/policy", - "responseCode":200 - }, - "input":{"shape":"GetLayerVersionPolicyRequest"}, - "output":{"shape":"GetLayerVersionPolicyResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "readonly":true - }, - "GetPolicy":{ - "name":"GetPolicy", - "http":{ - "method":"GET", - "requestUri":"/2015-03-31/functions/{FunctionName}/policy", - "responseCode":200 - }, - "input":{"shape":"GetPolicyRequest"}, - "output":{"shape":"GetPolicyResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "readonly":true - }, - "GetProvisionedConcurrencyConfig":{ - "name":"GetProvisionedConcurrencyConfig", - "http":{ - "method":"GET", - "requestUri":"/2019-09-30/functions/{FunctionName}/provisioned-concurrency", - "responseCode":200 - }, - "input":{"shape":"GetProvisionedConcurrencyConfigRequest"}, - "output":{"shape":"GetProvisionedConcurrencyConfigResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ProvisionedConcurrencyConfigNotFoundException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "readonly":true - }, - "GetRuntimeManagementConfig":{ - "name":"GetRuntimeManagementConfig", - "http":{ - "method":"GET", - "requestUri":"/2021-07-20/functions/{FunctionName}/runtime-management-config", - "responseCode":200 - }, - "input":{"shape":"GetRuntimeManagementConfigRequest"}, - "output":{"shape":"GetRuntimeManagementConfigResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "readonly":true - }, - "Invoke":{ - "name":"Invoke", - "http":{ - "method":"POST", - "requestUri":"/2015-03-31/functions/{FunctionName}/invocations", - "responseCode":200 - }, - "input":{"shape":"InvocationRequest"}, - "output":{"shape":"InvocationResponse"}, - "errors":[ - {"shape":"CodeArtifactUserDeletedException"}, - {"shape":"ResourceNotReadyException"}, - {"shape":"ServiceQuotaExceededException"}, - {"shape":"InvalidSecurityGroupIDException"}, - {"shape":"SnapStartTimeoutException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"EC2ThrottledException"}, - {"shape":"EFSMountConnectivityException"}, - {"shape":"SubnetIPAddressLimitReachedException"}, - {"shape":"KMSAccessDeniedException"}, - {"shape":"RequestTooLargeException"}, - {"shape":"KMSDisabledException"}, - {"shape":"UnsupportedMediaTypeException"}, - {"shape":"S3FilesMountConnectivityException"}, - {"shape":"SerializedRequestEntityTooLargeException"}, - {"shape":"InvalidRuntimeException"}, - {"shape":"NoPublishedVersionException"}, - {"shape":"EC2UnexpectedException"}, - {"shape":"InvalidSubnetIDException"}, - {"shape":"KMSNotFoundException"}, - {"shape":"InvalidParameterValueException"}, - {"shape":"EC2AccessDeniedException"}, - {"shape":"EFSIOException"}, - {"shape":"KMSInvalidStateException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ENILimitReachedException"}, - {"shape":"SnapStartNotReadyException"}, - {"shape":"ServiceException"}, - {"shape":"CodeArtifactUserPendingException"}, - {"shape":"SnapStartException"}, - {"shape":"RecursiveInvocationException"}, - {"shape":"S3FilesMountFailureException"}, - {"shape":"EFSMountTimeoutException"}, - {"shape":"ENINotReadyException"}, - {"shape":"S3FilesMountTimeoutException"}, - {"shape":"CodeArtifactUserFailedException"}, - {"shape":"ModeNotSupportedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidRequestContentException"}, - {"shape":"SnapStartRegenerationFailureException"}, - {"shape":"DurableExecutionAlreadyStartedException"}, - {"shape":"InvalidZipFileException"}, - {"shape":"EFSMountFailureException"} - ] - }, - "InvokeAsync":{ - "name":"InvokeAsync", - "http":{ - "method":"POST", - "requestUri":"/2014-11-13/functions/{FunctionName}/invoke-async", - "responseCode":202 - }, - "input":{"shape":"InvokeAsyncRequest"}, - "output":{"shape":"InvokeAsyncResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"InvalidSecurityGroupIDException"}, - {"shape":"SnapStartTimeoutException"}, - {"shape":"EC2ThrottledException"}, - {"shape":"EFSMountConnectivityException"}, - {"shape":"SubnetIPAddressLimitReachedException"}, - {"shape":"KMSAccessDeniedException"}, - {"shape":"KMSDisabledException"}, - {"shape":"S3FilesMountConnectivityException"}, - {"shape":"InvalidRuntimeException"}, - {"shape":"EC2UnexpectedException"}, - {"shape":"InvalidSubnetIDException"}, - {"shape":"KMSNotFoundException"}, - {"shape":"EC2AccessDeniedException"}, - {"shape":"EFSIOException"}, - {"shape":"KMSInvalidStateException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ENILimitReachedException"}, - {"shape":"SnapStartNotReadyException"}, - {"shape":"ServiceException"}, - {"shape":"SnapStartException"}, - {"shape":"S3FilesMountFailureException"}, - {"shape":"EFSMountTimeoutException"}, - {"shape":"S3FilesMountTimeoutException"}, - {"shape":"ModeNotSupportedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidRequestContentException"}, - {"shape":"SnapStartRegenerationFailureException"}, - {"shape":"EFSMountFailureException"} - ], - "deprecated":true - }, - "InvokeWithResponseStream":{ - "name":"InvokeWithResponseStream", - "http":{ - "method":"POST", - "requestUri":"/2021-11-15/functions/{FunctionName}/response-streaming-invocations", - "responseCode":200 - }, - "input":{"shape":"InvokeWithResponseStreamRequest"}, - "output":{"shape":"InvokeWithResponseStreamResponse"}, - "errors":[ - {"shape":"ResourceNotReadyException"}, - {"shape":"ServiceQuotaExceededException"}, - {"shape":"InvalidSecurityGroupIDException"}, - {"shape":"SnapStartTimeoutException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"EC2ThrottledException"}, - {"shape":"EFSMountConnectivityException"}, - {"shape":"SubnetIPAddressLimitReachedException"}, - {"shape":"KMSAccessDeniedException"}, - {"shape":"RequestTooLargeException"}, - {"shape":"KMSDisabledException"}, - {"shape":"UnsupportedMediaTypeException"}, - {"shape":"S3FilesMountConnectivityException"}, - {"shape":"SerializedRequestEntityTooLargeException"}, - {"shape":"InvalidRuntimeException"}, - {"shape":"NoPublishedVersionException"}, - {"shape":"EC2UnexpectedException"}, - {"shape":"InvalidSubnetIDException"}, - {"shape":"KMSNotFoundException"}, - {"shape":"InvalidParameterValueException"}, - {"shape":"EC2AccessDeniedException"}, - {"shape":"EFSIOException"}, - {"shape":"KMSInvalidStateException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ENILimitReachedException"}, - {"shape":"SnapStartNotReadyException"}, - {"shape":"ServiceException"}, - {"shape":"SnapStartException"}, - {"shape":"RecursiveInvocationException"}, - {"shape":"S3FilesMountFailureException"}, - {"shape":"EFSMountTimeoutException"}, - {"shape":"S3FilesMountTimeoutException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidRequestContentException"}, - {"shape":"SnapStartRegenerationFailureException"}, - {"shape":"InvalidZipFileException"}, - {"shape":"EFSMountFailureException"} - ] - }, - "ListAliases":{ - "name":"ListAliases", - "http":{ - "method":"GET", - "requestUri":"/2015-03-31/functions/{FunctionName}/aliases", - "responseCode":200 - }, - "input":{"shape":"ListAliasesRequest"}, - "output":{"shape":"ListAliasesResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "readonly":true - }, - "ListCapacityProviders":{ - "name":"ListCapacityProviders", - "http":{ - "method":"GET", - "requestUri":"/2025-11-30/capacity-providers", - "responseCode":200 - }, - "input":{"shape":"ListCapacityProvidersRequest"}, - "output":{"shape":"ListCapacityProvidersResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"} - ], - "readonly":true - }, - "ListCodeSigningConfigs":{ - "name":"ListCodeSigningConfigs", - "http":{ - "method":"GET", - "requestUri":"/2020-04-22/code-signing-configs", - "responseCode":200 - }, - "input":{"shape":"ListCodeSigningConfigsRequest"}, - "output":{"shape":"ListCodeSigningConfigsResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"} - ], - "readonly":true - }, - "ListDurableExecutionsByFunction":{ - "name":"ListDurableExecutionsByFunction", - "http":{ - "method":"GET", - "requestUri":"/2025-12-01/functions/{FunctionName}/durable-executions", - "responseCode":200 - }, - "input":{"shape":"ListDurableExecutionsByFunctionRequest"}, - "output":{"shape":"ListDurableExecutionsByFunctionResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "readonly":true - }, - "ListEventSourceMappings":{ - "name":"ListEventSourceMappings", - "http":{ - "method":"GET", - "requestUri":"/2015-03-31/event-source-mappings", - "responseCode":200 - }, - "input":{"shape":"ListEventSourceMappingsRequest"}, - "output":{"shape":"ListEventSourceMappingsResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "readonly":true - }, - "ListFunctionEventInvokeConfigs":{ - "name":"ListFunctionEventInvokeConfigs", - "http":{ - "method":"GET", - "requestUri":"/2019-09-25/functions/{FunctionName}/event-invoke-config/list", - "responseCode":200 - }, - "input":{"shape":"ListFunctionEventInvokeConfigsRequest"}, - "output":{"shape":"ListFunctionEventInvokeConfigsResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "readonly":true - }, - "ListFunctionUrlConfigs":{ - "name":"ListFunctionUrlConfigs", - "http":{ - "method":"GET", - "requestUri":"/2021-10-31/functions/{FunctionName}/urls", - "responseCode":200 - }, - "input":{"shape":"ListFunctionUrlConfigsRequest"}, - "output":{"shape":"ListFunctionUrlConfigsResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "readonly":true - }, - "ListFunctionVersionsByCapacityProvider":{ - "name":"ListFunctionVersionsByCapacityProvider", - "http":{ - "method":"GET", - "requestUri":"/2025-11-30/capacity-providers/{CapacityProviderName}/function-versions", - "responseCode":200 - }, - "input":{"shape":"ListFunctionVersionsByCapacityProviderRequest"}, - "output":{"shape":"ListFunctionVersionsByCapacityProviderResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "readonly":true - }, - "ListFunctions":{ - "name":"ListFunctions", - "http":{ - "method":"GET", - "requestUri":"/2015-03-31/functions", - "responseCode":200 - }, - "input":{"shape":"ListFunctionsRequest"}, - "output":{"shape":"ListFunctionsResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"} - ], - "readonly":true - }, - "ListFunctionsByCodeSigningConfig":{ - "name":"ListFunctionsByCodeSigningConfig", - "http":{ - "method":"GET", - "requestUri":"/2020-04-22/code-signing-configs/{CodeSigningConfigArn}/functions", - "responseCode":200 - }, - "input":{"shape":"ListFunctionsByCodeSigningConfigRequest"}, - "output":{"shape":"ListFunctionsByCodeSigningConfigResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"ResourceNotFoundException"} - ], - "readonly":true - }, - "ListLayerVersions":{ - "name":"ListLayerVersions", - "http":{ - "method":"GET", - "requestUri":"/2018-10-31/layers/{LayerName}/versions", - "responseCode":200 - }, - "input":{"shape":"ListLayerVersionsRequest"}, - "output":{"shape":"ListLayerVersionsResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "readonly":true - }, - "ListLayers":{ - "name":"ListLayers", - "http":{ - "method":"GET", - "requestUri":"/2018-10-31/layers", - "responseCode":200 - }, - "input":{"shape":"ListLayersRequest"}, - "output":{"shape":"ListLayersResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"} - ], - "readonly":true - }, - "ListProvisionedConcurrencyConfigs":{ - "name":"ListProvisionedConcurrencyConfigs", - "http":{ - "method":"GET", - "requestUri":"/2019-09-30/functions/{FunctionName}/provisioned-concurrency?List=ALL", - "responseCode":200 - }, - "input":{"shape":"ListProvisionedConcurrencyConfigsRequest"}, - "output":{"shape":"ListProvisionedConcurrencyConfigsResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "readonly":true - }, - "ListTags":{ - "name":"ListTags", - "http":{ - "method":"GET", - "requestUri":"/2017-03-31/tags/{Resource}", - "responseCode":200 - }, - "input":{"shape":"ListTagsRequest"}, - "output":{"shape":"ListTagsResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "readonly":true - }, - "ListVersionsByFunction":{ - "name":"ListVersionsByFunction", - "http":{ - "method":"GET", - "requestUri":"/2015-03-31/functions/{FunctionName}/versions", - "responseCode":200 - }, - "input":{"shape":"ListVersionsByFunctionRequest"}, - "output":{"shape":"ListVersionsByFunctionResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "readonly":true - }, - "PublishLayerVersion":{ - "name":"PublishLayerVersion", - "http":{ - "method":"POST", - "requestUri":"/2018-10-31/layers/{LayerName}/versions", - "responseCode":201 - }, - "input":{"shape":"PublishLayerVersionRequest"}, - "output":{"shape":"PublishLayerVersionResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"CodeStorageExceededException"} - ] - }, - "PublishVersion":{ - "name":"PublishVersion", - "http":{ - "method":"POST", - "requestUri":"/2015-03-31/functions/{FunctionName}/versions", - "responseCode":201 - }, - "input":{"shape":"PublishVersionRequest"}, - "output":{"shape":"FunctionConfiguration"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"CodeStorageExceededException"}, - {"shape":"FunctionVersionsPerCapacityProviderLimitExceededException"}, - {"shape":"PreconditionFailedException"} - ] - }, - "PutFunctionCodeSigningConfig":{ - "name":"PutFunctionCodeSigningConfig", - "http":{ - "method":"PUT", - "requestUri":"/2020-06-30/functions/{FunctionName}/code-signing-config", - "responseCode":200 - }, - "input":{"shape":"PutFunctionCodeSigningConfigRequest"}, - "output":{"shape":"PutFunctionCodeSigningConfigResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"CodeSigningConfigNotFoundException"} - ] - }, - "PutFunctionConcurrency":{ - "name":"PutFunctionConcurrency", - "http":{ - "method":"PUT", - "requestUri":"/2017-10-31/functions/{FunctionName}/concurrency", - "responseCode":200 - }, - "input":{"shape":"PutFunctionConcurrencyRequest"}, - "output":{"shape":"Concurrency"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ] - }, - "PutFunctionEventInvokeConfig":{ - "name":"PutFunctionEventInvokeConfig", - "http":{ - "method":"PUT", - "requestUri":"/2019-09-25/functions/{FunctionName}/event-invoke-config", - "responseCode":200 - }, - "input":{"shape":"PutFunctionEventInvokeConfigRequest"}, - "output":{"shape":"FunctionEventInvokeConfig"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ] - }, - "PutFunctionRecursionConfig":{ - "name":"PutFunctionRecursionConfig", - "http":{ - "method":"PUT", - "requestUri":"/2024-08-31/functions/{FunctionName}/recursion-config", - "responseCode":200 - }, - "input":{"shape":"PutFunctionRecursionConfigRequest"}, - "output":{"shape":"PutFunctionRecursionConfigResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ] - }, - "PutFunctionScalingConfig":{ - "name":"PutFunctionScalingConfig", - "http":{ - "method":"PUT", - "requestUri":"/2025-11-30/functions/{FunctionName}/function-scaling-config", - "responseCode":202 - }, - "input":{"shape":"PutFunctionScalingConfigRequest"}, - "output":{"shape":"PutFunctionScalingConfigResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ] - }, - "PutProvisionedConcurrencyConfig":{ - "name":"PutProvisionedConcurrencyConfig", - "http":{ - "method":"PUT", - "requestUri":"/2019-09-30/functions/{FunctionName}/provisioned-concurrency", - "responseCode":202 - }, - "input":{"shape":"PutProvisionedConcurrencyConfigRequest"}, - "output":{"shape":"PutProvisionedConcurrencyConfigResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "idempotent":true - }, - "PutRuntimeManagementConfig":{ - "name":"PutRuntimeManagementConfig", - "http":{ - "method":"PUT", - "requestUri":"/2021-07-20/functions/{FunctionName}/runtime-management-config", - "responseCode":200 - }, - "input":{"shape":"PutRuntimeManagementConfigRequest"}, - "output":{"shape":"PutRuntimeManagementConfigResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ] - }, - "RemoveLayerVersionPermission":{ - "name":"RemoveLayerVersionPermission", - "http":{ - "method":"DELETE", - "requestUri":"/2018-10-31/layers/{LayerName}/versions/{VersionNumber}/policy/{StatementId}", - "responseCode":204 - }, - "input":{"shape":"RemoveLayerVersionPermissionRequest"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"PreconditionFailedException"} - ] - }, - "RemovePermission":{ - "name":"RemovePermission", - "http":{ - "method":"DELETE", - "requestUri":"/2015-03-31/functions/{FunctionName}/policy/{StatementId}", - "responseCode":204 - }, - "input":{"shape":"RemovePermissionRequest"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"PublicPolicyException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"PreconditionFailedException"} - ] - }, - "SendDurableExecutionCallbackFailure":{ - "name":"SendDurableExecutionCallbackFailure", - "http":{ - "method":"POST", - "requestUri":"/2025-12-01/durable-execution-callbacks/{CallbackId}/fail", - "responseCode":200 - }, - "input":{"shape":"SendDurableExecutionCallbackFailureRequest"}, - "output":{"shape":"SendDurableExecutionCallbackFailureResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"KMSInvalidStateException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"KMSNotFoundException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"CallbackTimeoutException"}, - {"shape":"KMSAccessDeniedException"}, - {"shape":"KMSDisabledException"} - ] - }, - "SendDurableExecutionCallbackHeartbeat":{ - "name":"SendDurableExecutionCallbackHeartbeat", - "http":{ - "method":"POST", - "requestUri":"/2025-12-01/durable-execution-callbacks/{CallbackId}/heartbeat", - "responseCode":200 - }, - "input":{"shape":"SendDurableExecutionCallbackHeartbeatRequest"}, - "output":{"shape":"SendDurableExecutionCallbackHeartbeatResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"CallbackTimeoutException"} - ] - }, - "SendDurableExecutionCallbackSuccess":{ - "name":"SendDurableExecutionCallbackSuccess", - "http":{ - "method":"POST", - "requestUri":"/2025-12-01/durable-execution-callbacks/{CallbackId}/succeed", - "responseCode":200 - }, - "input":{"shape":"SendDurableExecutionCallbackSuccessRequest"}, - "output":{"shape":"SendDurableExecutionCallbackSuccessResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"KMSInvalidStateException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"KMSNotFoundException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"CallbackTimeoutException"}, - {"shape":"KMSAccessDeniedException"}, - {"shape":"KMSDisabledException"} - ] - }, - "StopDurableExecution":{ - "name":"StopDurableExecution", - "http":{ - "method":"POST", - "requestUri":"/2025-12-01/durable-executions/{DurableExecutionArn}/stop", - "responseCode":200 - }, - "input":{"shape":"StopDurableExecutionRequest"}, - "output":{"shape":"StopDurableExecutionResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"KMSInvalidStateException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"KMSNotFoundException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"KMSAccessDeniedException"}, - {"shape":"KMSDisabledException"} - ] - }, - "TagResource":{ - "name":"TagResource", - "http":{ - "method":"POST", - "requestUri":"/2017-03-31/tags/{Resource}", - "responseCode":204 - }, - "input":{"shape":"TagResourceRequest"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ] - }, - "UntagResource":{ - "name":"UntagResource", - "http":{ - "method":"DELETE", - "requestUri":"/2017-03-31/tags/{Resource}", - "responseCode":204 - }, - "input":{"shape":"UntagResourceRequest"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ] - }, - "UpdateAlias":{ - "name":"UpdateAlias", - "http":{ - "method":"PUT", - "requestUri":"/2015-03-31/functions/{FunctionName}/aliases/{Name}", - "responseCode":200 - }, - "input":{"shape":"UpdateAliasRequest"}, - "output":{"shape":"AliasConfiguration"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"PreconditionFailedException"} - ] - }, - "UpdateCapacityProvider":{ - "name":"UpdateCapacityProvider", - "http":{ - "method":"PUT", - "requestUri":"/2025-11-30/capacity-providers/{CapacityProviderName}", - "responseCode":202 - }, - "input":{"shape":"UpdateCapacityProviderRequest"}, - "output":{"shape":"UpdateCapacityProviderResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ] - }, - "UpdateCodeSigningConfig":{ - "name":"UpdateCodeSigningConfig", - "http":{ - "method":"PUT", - "requestUri":"/2020-04-22/code-signing-configs/{CodeSigningConfigArn}", - "responseCode":200 - }, - "input":{"shape":"UpdateCodeSigningConfigRequest"}, - "output":{"shape":"UpdateCodeSigningConfigResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"ResourceNotFoundException"} - ] - }, - "UpdateEventSourceMapping":{ - "name":"UpdateEventSourceMapping", - "http":{ - "method":"PUT", - "requestUri":"/2015-03-31/event-source-mappings/{UUID}", - "responseCode":202 - }, - "input":{"shape":"UpdateEventSourceMappingRequest"}, - "output":{"shape":"EventSourceMappingConfiguration"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceInUseException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ] - }, - "UpdateFunctionCode":{ - "name":"UpdateFunctionCode", - "http":{ - "method":"PUT", - "requestUri":"/2015-03-31/functions/{FunctionName}/code", - "responseCode":200 - }, - "input":{"shape":"UpdateFunctionCodeRequest"}, - "output":{"shape":"FunctionConfiguration"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"InvalidCodeSignatureException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"CodeVerificationFailedException"}, - {"shape":"CodeSigningConfigNotFoundException"}, - {"shape":"CodeStorageExceededException"}, - {"shape":"PreconditionFailedException"} - ] - }, - "UpdateFunctionConfiguration":{ - "name":"UpdateFunctionConfiguration", - "http":{ - "method":"PUT", - "requestUri":"/2015-03-31/functions/{FunctionName}/configuration", - "responseCode":200 - }, - "input":{"shape":"UpdateFunctionConfigurationRequest"}, - "output":{"shape":"FunctionConfiguration"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"InvalidCodeSignatureException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"CodeVerificationFailedException"}, - {"shape":"CodeSigningConfigNotFoundException"}, - {"shape":"PreconditionFailedException"} - ] - }, - "UpdateFunctionEventInvokeConfig":{ - "name":"UpdateFunctionEventInvokeConfig", - "http":{ - "method":"POST", - "requestUri":"/2019-09-25/functions/{FunctionName}/event-invoke-config", - "responseCode":200 - }, - "input":{"shape":"UpdateFunctionEventInvokeConfigRequest"}, - "output":{"shape":"FunctionEventInvokeConfig"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ] - }, - "UpdateFunctionUrlConfig":{ - "name":"UpdateFunctionUrlConfig", - "http":{ - "method":"PUT", - "requestUri":"/2021-10-31/functions/{FunctionName}/url", - "responseCode":200 - }, - "input":{"shape":"UpdateFunctionUrlConfigRequest"}, - "output":{"shape":"UpdateFunctionUrlConfigResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ] - } - }, - "shapes":{ - "AccountLimit":{ - "type":"structure", - "members":{ - "TotalCodeSize":{"shape":"Long"}, - "CodeSizeUnzipped":{"shape":"Long"}, - "CodeSizeZipped":{"shape":"Long"}, - "ConcurrentExecutions":{"shape":"Integer"}, - "UnreservedConcurrentExecutions":{"shape":"UnreservedConcurrentExecutions"} - } - }, - "AccountUsage":{ - "type":"structure", - "members":{ - "TotalCodeSize":{"shape":"Long"}, - "FunctionCount":{"shape":"Long"} - } - }, - "Action":{ - "type":"string", - "max":10000, - "min":0, - "pattern":"(lambda:[*]|lambda:[a-zA-Z]+|[*])" - }, - "AddLayerVersionPermissionRequest":{ - "type":"structure", - "required":[ - "LayerName", - "VersionNumber", - "StatementId", - "Action", - "Principal" - ], - "members":{ - "LayerName":{ - "shape":"LayerName", - "location":"uri", - "locationName":"LayerName" - }, - "VersionNumber":{ - "shape":"LayerVersionNumber", - "location":"uri", - "locationName":"VersionNumber" - }, - "StatementId":{"shape":"StatementId"}, - "Action":{"shape":"LayerPermissionAllowedAction"}, - "Principal":{"shape":"LayerPermissionAllowedPrincipal"}, - "OrganizationId":{"shape":"OrganizationId"}, - "RevisionId":{ - "shape":"String", - "location":"querystring", - "locationName":"RevisionId" - } - } - }, - "AddLayerVersionPermissionResponse":{ - "type":"structure", - "members":{ - "Statement":{"shape":"String"}, - "RevisionId":{"shape":"String"} - } - }, - "AddPermissionRequest":{ - "type":"structure", - "required":[ - "FunctionName", - "StatementId", - "Action", - "Principal" - ], - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "location":"uri", - "locationName":"FunctionName" - }, - "StatementId":{"shape":"StatementId"}, - "Action":{"shape":"Action"}, - "Principal":{"shape":"Principal"}, - "SourceArn":{"shape":"Arn"}, - "FunctionUrlAuthType":{"shape":"FunctionUrlAuthType"}, - "InvokedViaFunctionUrl":{"shape":"InvokedViaFunctionUrl"}, - "SourceAccount":{"shape":"SourceOwner"}, - "EventSourceToken":{"shape":"EventSourceToken"}, - "Qualifier":{ - "shape":"NumericLatestPublishedOrAliasQualifier", - "location":"querystring", - "locationName":"Qualifier" - }, - "RevisionId":{"shape":"String"}, - "PrincipalOrgID":{"shape":"PrincipalOrgID"} - } - }, - "AddPermissionResponse":{ - "type":"structure", - "members":{ - "Statement":{"shape":"String"} - } - }, - "AdditionalVersion":{ - "type":"string", - "max":1024, - "min":1, - "pattern":"[0-9]+" - }, - "AdditionalVersionWeights":{ - "type":"map", - "key":{"shape":"AdditionalVersion"}, - "value":{"shape":"Weight"} - }, - "Alias":{ - "type":"string", - "max":128, - "min":1, - "pattern":"(?!^[0-9]+$)([a-zA-Z0-9-_]+)" - }, - "AliasConfiguration":{ - "type":"structure", - "members":{ - "AliasArn":{"shape":"FunctionArn"}, - "Name":{"shape":"Alias"}, - "FunctionVersion":{"shape":"Version"}, - "Description":{"shape":"Description"}, - "RoutingConfig":{"shape":"AliasRoutingConfiguration"}, - "RevisionId":{"shape":"String"} - } - }, - "AliasLimitExceededException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "message":{"shape":"String"} - }, - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "AliasList":{ - "type":"list", - "member":{"shape":"AliasConfiguration"} - }, - "AliasRoutingConfiguration":{ - "type":"structure", - "members":{ - "AdditionalVersionWeights":{"shape":"AdditionalVersionWeights"} - } - }, - "AllowCredentials":{ - "type":"boolean", - "box":true - }, - "AllowMethodsList":{ - "type":"list", - "member":{"shape":"Method"}, - "max":6, - "min":0 - }, - "AllowOriginsList":{ - "type":"list", - "member":{"shape":"Origin"}, - "max":100, - "min":0 - }, - "AllowedPublishers":{ - "type":"structure", - "required":["SigningProfileVersionArns"], - "members":{ - "SigningProfileVersionArns":{"shape":"SigningProfileVersionArns"} - } - }, - "AmazonManagedKafkaEventSourceConfig":{ - "type":"structure", - "members":{ - "ConsumerGroupId":{"shape":"URI"}, - "SchemaRegistryConfig":{"shape":"KafkaSchemaRegistryConfig"} - } - }, - "ApplicationLogLevel":{ - "type":"string", - "enum":[ - "TRACE", - "DEBUG", - "INFO", - "WARN", - "ERROR", - "FATAL" - ] - }, - "Architecture":{ - "type":"string", - "enum":[ - "x86_64", - "arm64" - ] - }, - "ArchitecturesList":{ - "type":"list", - "member":{"shape":"Architecture"}, - "max":1, - "min":1 - }, - "Arn":{ - "type":"string", - "max":10000, - "min":0, - "pattern":"arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-])+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.*)" - }, - "AttemptCount":{ - "type":"integer", - "min":0 - }, - "BatchSize":{ - "type":"integer", - "box":true, - "max":10000, - "min":1 - }, - "BinaryOperationPayload":{ - "type":"blob", - "max":262144, - "min":0, - "sensitive":true - }, - "BisectBatchOnFunctionError":{ - "type":"boolean", - "box":true - }, - "Blob":{ - "type":"blob", - "sensitive":true - }, - "BlobStream":{ - "type":"blob", - "streaming":true - }, - "Boolean":{"type":"boolean"}, - "CallbackDetails":{ - "type":"structure", - "members":{ - "CallbackId":{"shape":"CallbackId"}, - "Result":{"shape":"OperationPayload"}, - "Error":{"shape":"ErrorObject"} - } - }, - "CallbackFailedDetails":{ - "type":"structure", - "required":["Error"], - "members":{ - "Error":{"shape":"EventError"} - } - }, - "CallbackId":{ - "type":"string", - "max":1024, - "min":1, - "pattern":"[A-Za-z0-9+/]+={0,2}" - }, - "CallbackOptions":{ - "type":"structure", - "members":{ - "TimeoutSeconds":{"shape":"CallbackOptionsTimeoutSecondsInteger"}, - "HeartbeatTimeoutSeconds":{"shape":"CallbackOptionsHeartbeatTimeoutSecondsInteger"} - } - }, - "CallbackOptionsHeartbeatTimeoutSecondsInteger":{ - "type":"integer", - "box":true, - "max":99999999, - "min":0 - }, - "CallbackOptionsTimeoutSecondsInteger":{ - "type":"integer", - "box":true, - "max":99999999, - "min":0 - }, - "CallbackStartedDetails":{ - "type":"structure", - "required":["CallbackId"], - "members":{ - "CallbackId":{"shape":"CallbackId"}, - "HeartbeatTimeout":{"shape":"DurationSeconds"}, - "Timeout":{"shape":"DurationSeconds"} - } - }, - "CallbackSucceededDetails":{ - "type":"structure", - "required":["Result"], - "members":{ - "Result":{"shape":"EventResult"} - } - }, - "CallbackTimedOutDetails":{ - "type":"structure", - "required":["Error"], - "members":{ - "Error":{"shape":"EventError"} - } - }, - "CallbackTimeoutException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "CapacityProvider":{ - "type":"structure", - "required":[ - "CapacityProviderArn", - "State", - "VpcConfig", - "PermissionsConfig" - ], - "members":{ - "CapacityProviderArn":{"shape":"CapacityProviderArn"}, - "State":{"shape":"CapacityProviderState"}, - "VpcConfig":{"shape":"CapacityProviderVpcConfig"}, - "PermissionsConfig":{"shape":"CapacityProviderPermissionsConfig"}, - "InstanceRequirements":{"shape":"InstanceRequirements"}, - "CapacityProviderScalingConfig":{"shape":"CapacityProviderScalingConfig"}, - "KmsKeyArn":{"shape":"KMSKeyArn"}, - "LastModified":{"shape":"Timestamp"}, - "PropagateTags":{"shape":"PropagateTags"}, - "TelemetryConfig":{"shape":"CapacityProviderTelemetryConfig"} - } - }, - "CapacityProviderArn":{ - "type":"string", - "max":140, - "min":1, - "pattern":"arn:aws[a-zA-Z-]*:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:capacity-provider:[a-zA-Z0-9-_]+" - }, - "CapacityProviderConfig":{ - "type":"structure", - "required":["LambdaManagedInstancesCapacityProviderConfig"], - "members":{ - "LambdaManagedInstancesCapacityProviderConfig":{"shape":"LambdaManagedInstancesCapacityProviderConfig"} - } - }, - "CapacityProviderLimitExceededException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "message":{"shape":"String"} - }, - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "CapacityProviderLoggingConfig":{ - "type":"structure", - "members":{ - "SystemLogLevel":{"shape":"SystemLogLevel"}, - "LogGroup":{"shape":"LogGroup"} - } - }, - "CapacityProviderMaxVCpuCount":{ - "type":"integer", - "box":true, - "max":15000, - "min":2 - }, - "CapacityProviderName":{ - "type":"string", - "max":140, - "min":1, - "pattern":"(arn:aws[a-zA-Z-]*:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:capacity-provider:[a-zA-Z0-9-_]+)|[a-zA-Z0-9-_]+" - }, - "CapacityProviderPermissionsConfig":{ - "type":"structure", - "required":["CapacityProviderOperatorRoleArn"], - "members":{ - "CapacityProviderOperatorRoleArn":{"shape":"RoleArn"} - } - }, - "CapacityProviderPredefinedMetricType":{ - "type":"string", - "enum":["LambdaCapacityProviderAverageCPUUtilization"] - }, - "CapacityProviderScalingConfig":{ - "type":"structure", - "members":{ - "MaxVCpuCount":{"shape":"CapacityProviderMaxVCpuCount"}, - "ScalingMode":{"shape":"CapacityProviderScalingMode"}, - "ScalingPolicies":{"shape":"CapacityProviderScalingPoliciesList"} - } - }, - "CapacityProviderScalingMode":{ - "type":"string", - "enum":[ - "Auto", - "Manual" - ] - }, - "CapacityProviderScalingPoliciesList":{ - "type":"list", - "member":{"shape":"TargetTrackingScalingPolicy"}, - "max":10, - "min":1 - }, - "CapacityProviderSecurityGroupIds":{ - "type":"list", - "member":{"shape":"SecurityGroupId"}, - "max":5, - "min":0 - }, - "CapacityProviderState":{ - "type":"string", - "enum":[ - "Pending", - "Active", - "Failed", - "Deleting" - ] - }, - "CapacityProviderSubnetIds":{ - "type":"list", - "member":{"shape":"SubnetId"}, - "max":16, - "min":1 - }, - "CapacityProviderTelemetryConfig":{ - "type":"structure", - "members":{ - "LoggingConfig":{"shape":"CapacityProviderLoggingConfig"} - } - }, - "CapacityProviderVpcConfig":{ - "type":"structure", - "required":[ - "SubnetIds", - "SecurityGroupIds" - ], - "members":{ - "SubnetIds":{"shape":"CapacityProviderSubnetIds"}, - "SecurityGroupIds":{"shape":"CapacityProviderSecurityGroupIds"} - } - }, - "CapacityProvidersList":{ - "type":"list", - "member":{"shape":"CapacityProvider"}, - "max":50, - "min":0 - }, - "ChainedInvokeDetails":{ - "type":"structure", - "members":{ - "Result":{"shape":"OperationPayload"}, - "Error":{"shape":"ErrorObject"} - } - }, - "ChainedInvokeFailedDetails":{ - "type":"structure", - "required":["Error"], - "members":{ - "Error":{"shape":"EventError"} - } - }, - "ChainedInvokeOptions":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{"shape":"NamespacedFunctionName"}, - "TenantId":{"shape":"TenantId"} - } - }, - "ChainedInvokeStartedDetails":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{"shape":"NamespacedFunctionName"}, - "TenantId":{"shape":"TenantId"}, - "Input":{"shape":"EventInput"}, - "ExecutedVersion":{"shape":"VersionWithLatestPublished"}, - "DurableExecutionArn":{"shape":"DurableExecutionArn"} - } - }, - "ChainedInvokeStoppedDetails":{ - "type":"structure", - "required":["Error"], - "members":{ - "Error":{"shape":"EventError"} - } - }, - "ChainedInvokeSucceededDetails":{ - "type":"structure", - "required":["Result"], - "members":{ - "Result":{"shape":"EventResult"} - } - }, - "ChainedInvokeTimedOutDetails":{ - "type":"structure", - "required":["Error"], - "members":{ - "Error":{"shape":"EventError"} - } - }, - "CheckpointDurableExecutionRequest":{ - "type":"structure", - "required":[ - "DurableExecutionArn", - "CheckpointToken" - ], - "members":{ - "DurableExecutionArn":{ - "shape":"DurableExecutionArn", - "location":"uri", - "locationName":"DurableExecutionArn" - }, - "CheckpointToken":{"shape":"CheckpointToken"}, - "Updates":{"shape":"OperationUpdates"}, - "ClientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - } - } - }, - "CheckpointDurableExecutionResponse":{ - "type":"structure", - "required":["NewExecutionState"], - "members":{ - "CheckpointToken":{"shape":"CheckpointToken"}, - "NewExecutionState":{"shape":"CheckpointUpdatedExecutionState"} - } - }, - "CheckpointToken":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"[A-Za-z0-9+/]+={0,2}" - }, - "CheckpointUpdatedExecutionState":{ - "type":"structure", - "members":{ - "Operations":{"shape":"Operations"}, - "NextMarker":{"shape":"String"} - } - }, - "ClientToken":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[\\x21-\\x7E]+" - }, - "CodeArtifactUserDeletedException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "message":{"shape":"String"} - }, - "error":{ - "httpStatusCode":409, - "senderFault":true - }, - "exception":true - }, - "CodeArtifactUserFailedException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "message":{"shape":"String"} - }, - "error":{ - "httpStatusCode":409, - "senderFault":true - }, - "exception":true - }, - "CodeArtifactUserPendingException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "message":{"shape":"String"} - }, - "error":{ - "httpStatusCode":409, - "senderFault":true - }, - "exception":true - }, - "CodeSigningConfig":{ - "type":"structure", - "required":[ - "CodeSigningConfigId", - "CodeSigningConfigArn", - "AllowedPublishers", - "CodeSigningPolicies", - "LastModified" - ], - "members":{ - "CodeSigningConfigId":{"shape":"CodeSigningConfigId"}, - "CodeSigningConfigArn":{"shape":"CodeSigningConfigArn"}, - "Description":{"shape":"Description"}, - "AllowedPublishers":{"shape":"AllowedPublishers"}, - "CodeSigningPolicies":{"shape":"CodeSigningPolicies"}, - "LastModified":{"shape":"Timestamp"} - } - }, - "CodeSigningConfigArn":{ - "type":"string", - "max":200, - "min":0, - "pattern":"arn:(aws[a-zA-Z-]*)?:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:code-signing-config:csc-[a-z0-9]{17}" - }, - "CodeSigningConfigId":{ - "type":"string", - "pattern":"csc-[a-zA-Z0-9-_\\.]{17}" - }, - "CodeSigningConfigList":{ - "type":"list", - "member":{"shape":"CodeSigningConfig"} - }, - "CodeSigningConfigNotFoundException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "error":{ - "httpStatusCode":404, - "senderFault":true - }, - "exception":true - }, - "CodeSigningPolicies":{ - "type":"structure", - "members":{ - "UntrustedArtifactOnDeployment":{"shape":"CodeSigningPolicy"} - } - }, - "CodeSigningPolicy":{ - "type":"string", - "enum":[ - "Warn", - "Enforce" - ] - }, - "CodeStorageExceededException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "message":{"shape":"String"} - }, - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "CodeVerificationFailedException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "CollectionName":{ - "type":"string", - "max":57, - "min":1, - "pattern":"(^(?!(system\\x2e)))(^[_a-zA-Z0-9])([^$]*)" - }, - "CompatibleArchitectures":{ - "type":"list", - "member":{"shape":"Architecture"}, - "max":2, - "min":0 - }, - "CompatibleRuntimes":{ - "type":"list", - "member":{"shape":"Runtime"}, - "max":15, - "min":0 - }, - "Concurrency":{ - "type":"structure", - "members":{ - "ReservedConcurrentExecutions":{"shape":"ReservedConcurrentExecutions"} - } - }, - "ContextDetails":{ - "type":"structure", - "members":{ - "ReplayChildren":{"shape":"ReplayChildren"}, - "Result":{"shape":"OperationPayload"}, - "Error":{"shape":"ErrorObject"} - } - }, - "ContextFailedDetails":{ - "type":"structure", - "required":["Error"], - "members":{ - "Error":{"shape":"EventError"} - } - }, - "ContextOptions":{ - "type":"structure", - "members":{ - "ReplayChildren":{"shape":"ReplayChildren"} - } - }, - "ContextStartedDetails":{ - "type":"structure", - "members":{} - }, - "ContextSucceededDetails":{ - "type":"structure", - "required":["Result"], - "members":{ - "Result":{"shape":"EventResult"} - } - }, - "Cors":{ - "type":"structure", - "members":{ - "AllowCredentials":{"shape":"AllowCredentials"}, - "AllowHeaders":{"shape":"HeadersList"}, - "AllowMethods":{"shape":"AllowMethodsList"}, - "AllowOrigins":{"shape":"AllowOriginsList"}, - "ExposeHeaders":{"shape":"HeadersList"}, - "MaxAge":{"shape":"MaxAge"} - } - }, - "CreateAliasRequest":{ - "type":"structure", - "required":[ - "FunctionName", - "Name", - "FunctionVersion" - ], - "members":{ - "FunctionName":{ - "shape":"FunctionName", - "location":"uri", - "locationName":"FunctionName" - }, - "Name":{"shape":"Alias"}, - "FunctionVersion":{"shape":"VersionWithLatestPublished"}, - "Description":{"shape":"Description"}, - "RoutingConfig":{"shape":"AliasRoutingConfiguration"} - } - }, - "CreateCapacityProviderRequest":{ - "type":"structure", - "required":[ - "CapacityProviderName", - "VpcConfig", - "PermissionsConfig" - ], - "members":{ - "CapacityProviderName":{"shape":"CapacityProviderName"}, - "VpcConfig":{"shape":"CapacityProviderVpcConfig"}, - "PermissionsConfig":{"shape":"CapacityProviderPermissionsConfig"}, - "InstanceRequirements":{"shape":"InstanceRequirements"}, - "CapacityProviderScalingConfig":{"shape":"CapacityProviderScalingConfig"}, - "KmsKeyArn":{"shape":"KMSKeyArnNonEmpty"}, - "Tags":{"shape":"Tags"}, - "PropagateTags":{"shape":"PropagateTags"}, - "TelemetryConfig":{"shape":"CapacityProviderTelemetryConfig"} - } - }, - "CreateCapacityProviderResponse":{ - "type":"structure", - "required":["CapacityProvider"], - "members":{ - "CapacityProvider":{"shape":"CapacityProvider"} - } - }, - "CreateCodeSigningConfigRequest":{ - "type":"structure", - "required":["AllowedPublishers"], - "members":{ - "Description":{"shape":"Description"}, - "AllowedPublishers":{"shape":"AllowedPublishers"}, - "CodeSigningPolicies":{"shape":"CodeSigningPolicies"}, - "Tags":{"shape":"Tags"} - } - }, - "CreateCodeSigningConfigResponse":{ - "type":"structure", - "required":["CodeSigningConfig"], - "members":{ - "CodeSigningConfig":{"shape":"CodeSigningConfig"} - } - }, - "CreateEventSourceMappingRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "EventSourceArn":{"shape":"Arn"}, - "FunctionName":{"shape":"NamespacedFunctionName"}, - "Enabled":{"shape":"Enabled"}, - "BatchSize":{"shape":"BatchSize"}, - "FilterCriteria":{"shape":"FilterCriteria"}, - "KMSKeyArn":{"shape":"KMSKeyArn"}, - "MetricsConfig":{"shape":"EventSourceMappingMetricsConfig"}, - "LoggingConfig":{"shape":"EventSourceMappingLoggingConfig"}, - "ScalingConfig":{"shape":"ScalingConfig"}, - "MaximumBatchingWindowInSeconds":{"shape":"MaximumBatchingWindowInSeconds"}, - "ParallelizationFactor":{"shape":"ParallelizationFactor"}, - "StartingPosition":{"shape":"EventSourcePosition"}, - "StartingPositionTimestamp":{"shape":"Date"}, - "DestinationConfig":{"shape":"DestinationConfig"}, - "MaximumRecordAgeInSeconds":{"shape":"MaximumRecordAgeInSeconds"}, - "BisectBatchOnFunctionError":{"shape":"BisectBatchOnFunctionError"}, - "MaximumRetryAttempts":{"shape":"MaximumRetryAttemptsEventSourceMapping"}, - "Tags":{"shape":"Tags"}, - "TumblingWindowInSeconds":{"shape":"TumblingWindowInSeconds"}, - "Topics":{"shape":"Topics"}, - "Queues":{"shape":"Queues"}, - "SourceAccessConfigurations":{"shape":"SourceAccessConfigurations"}, - "SelfManagedEventSource":{"shape":"SelfManagedEventSource"}, - "FunctionResponseTypes":{"shape":"FunctionResponseTypeList"}, - "AmazonManagedKafkaEventSourceConfig":{"shape":"AmazonManagedKafkaEventSourceConfig"}, - "SelfManagedKafkaEventSourceConfig":{"shape":"SelfManagedKafkaEventSourceConfig"}, - "DocumentDBEventSourceConfig":{"shape":"DocumentDBEventSourceConfig"}, - "ProvisionedPollerConfig":{"shape":"ProvisionedPollerConfig"} - } - }, - "CreateFunctionRequest":{ - "type":"structure", - "required":[ - "FunctionName", - "Role", - "Code" - ], - "members":{ - "FunctionName":{"shape":"FunctionName"}, - "Runtime":{"shape":"Runtime"}, - "Role":{"shape":"RoleArn"}, - "Handler":{"shape":"Handler"}, - "Code":{"shape":"FunctionCode"}, - "Description":{"shape":"Description"}, - "Timeout":{"shape":"Timeout"}, - "MemorySize":{"shape":"MemorySize"}, - "Publish":{"shape":"Boolean"}, - "PublishTo":{"shape":"FunctionVersionLatestPublished"}, - "VpcConfig":{"shape":"VpcConfig"}, - "PackageType":{"shape":"PackageType"}, - "DeadLetterConfig":{"shape":"DeadLetterConfig"}, - "Environment":{"shape":"Environment"}, - "KMSKeyArn":{"shape":"KMSKeyArn"}, - "TracingConfig":{"shape":"TracingConfig"}, - "Tags":{"shape":"Tags"}, - "Layers":{"shape":"LayerList"}, - "FileSystemConfigs":{"shape":"FileSystemConfigList"}, - "CodeSigningConfigArn":{"shape":"CodeSigningConfigArn"}, - "ImageConfig":{"shape":"ImageConfig"}, - "Architectures":{"shape":"ArchitecturesList"}, - "EphemeralStorage":{"shape":"EphemeralStorage"}, - "SnapStart":{"shape":"SnapStart"}, - "LoggingConfig":{"shape":"LoggingConfig"}, - "TenancyConfig":{"shape":"TenancyConfig"}, - "CapacityProviderConfig":{"shape":"CapacityProviderConfig"}, - "DurableConfig":{"shape":"DurableConfig"} - } - }, - "CreateFunctionUrlConfigRequest":{ - "type":"structure", - "required":[ - "FunctionName", - "AuthType" - ], - "members":{ - "FunctionName":{ - "shape":"FunctionUrlFunctionName", - "location":"uri", - "locationName":"FunctionName" - }, - "Qualifier":{ - "shape":"FunctionUrlQualifier", - "location":"querystring", - "locationName":"Qualifier" - }, - "AuthType":{"shape":"FunctionUrlAuthType"}, - "Cors":{"shape":"Cors"}, - "InvokeMode":{"shape":"InvokeMode"} - } - }, - "CreateFunctionUrlConfigResponse":{ - "type":"structure", - "required":[ - "FunctionUrl", - "FunctionArn", - "AuthType", - "CreationTime" - ], - "members":{ - "FunctionUrl":{"shape":"FunctionUrl"}, - "FunctionArn":{"shape":"FunctionArn"}, - "AuthType":{"shape":"FunctionUrlAuthType"}, - "Cors":{"shape":"Cors"}, - "CreationTime":{"shape":"Timestamp"}, - "InvokeMode":{"shape":"InvokeMode"} - } - }, - "DatabaseName":{ - "type":"string", - "max":63, - "min":1, - "pattern":"[^ /\\.$\\x22]*" - }, - "Date":{"type":"timestamp"}, - "DeadLetterConfig":{ - "type":"structure", - "members":{ - "TargetArn":{"shape":"ResourceArn"} - } - }, - "DeleteAliasRequest":{ - "type":"structure", - "required":[ - "FunctionName", - "Name" - ], - "members":{ - "FunctionName":{ - "shape":"FunctionName", - "location":"uri", - "locationName":"FunctionName" - }, - "Name":{ - "shape":"Alias", - "location":"uri", - "locationName":"Name" - } - } - }, - "DeleteCapacityProviderRequest":{ - "type":"structure", - "required":["CapacityProviderName"], - "members":{ - "CapacityProviderName":{ - "shape":"CapacityProviderName", - "location":"uri", - "locationName":"CapacityProviderName" - } - } - }, - "DeleteCapacityProviderResponse":{ - "type":"structure", - "required":["CapacityProvider"], - "members":{ - "CapacityProvider":{"shape":"CapacityProvider"} - } - }, - "DeleteCodeSigningConfigRequest":{ - "type":"structure", - "required":["CodeSigningConfigArn"], - "members":{ - "CodeSigningConfigArn":{ - "shape":"CodeSigningConfigArn", - "location":"uri", - "locationName":"CodeSigningConfigArn" - } - } - }, - "DeleteCodeSigningConfigResponse":{ - "type":"structure", - "members":{} - }, - "DeleteEventSourceMappingRequest":{ - "type":"structure", - "required":["UUID"], - "members":{ - "UUID":{ - "shape":"UUIDString", - "location":"uri", - "locationName":"UUID" - } - } - }, - "DeleteFunctionCodeSigningConfigRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "location":"uri", - "locationName":"FunctionName" - } - } - }, - "DeleteFunctionConcurrencyRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"FunctionName", - "location":"uri", - "locationName":"FunctionName" - } - } - }, - "DeleteFunctionEventInvokeConfigRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "location":"uri", - "locationName":"FunctionName" - }, - "Qualifier":{ - "shape":"NumericLatestPublishedOrAliasQualifier", - "location":"querystring", - "locationName":"Qualifier" - } - } - }, - "DeleteFunctionRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "location":"uri", - "locationName":"FunctionName" - }, - "Qualifier":{ - "shape":"NumericLatestPublishedOrAliasQualifier", - "location":"querystring", - "locationName":"Qualifier" - } - } - }, - "DeleteFunctionResponse":{ - "type":"structure", - "members":{ - "StatusCode":{ - "shape":"Integer", - "location":"statusCode" - } - } - }, - "DeleteFunctionUrlConfigRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"FunctionUrlFunctionName", - "location":"uri", - "locationName":"FunctionName" - }, - "Qualifier":{ - "shape":"FunctionUrlQualifier", - "location":"querystring", - "locationName":"Qualifier" - } - } - }, - "DeleteLayerVersionRequest":{ - "type":"structure", - "required":[ - "LayerName", - "VersionNumber" - ], - "members":{ - "LayerName":{ - "shape":"LayerName", - "location":"uri", - "locationName":"LayerName" - }, - "VersionNumber":{ - "shape":"LayerVersionNumber", - "location":"uri", - "locationName":"VersionNumber" - } - } - }, - "DeleteProvisionedConcurrencyConfigRequest":{ - "type":"structure", - "required":[ - "FunctionName", - "Qualifier" - ], - "members":{ - "FunctionName":{ - "shape":"FunctionName", - "location":"uri", - "locationName":"FunctionName" - }, - "Qualifier":{ - "shape":"Qualifier", - "location":"querystring", - "locationName":"Qualifier" - } - } - }, - "Description":{ - "type":"string", - "max":256, - "min":0 - }, - "DestinationArn":{ - "type":"string", - "max":350, - "min":0, - "pattern":"$|kafka://([^.]([a-zA-Z0-9\\-_.]{0,248}))|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-])+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.*)" - }, - "DestinationConfig":{ - "type":"structure", - "members":{ - "OnSuccess":{"shape":"OnSuccess"}, - "OnFailure":{"shape":"OnFailure"} - } - }, - "DocumentDBEventSourceConfig":{ - "type":"structure", - "members":{ - "DatabaseName":{"shape":"DatabaseName"}, - "CollectionName":{"shape":"CollectionName"}, - "FullDocument":{"shape":"FullDocument"} - } - }, - "DurableConfig":{ - "type":"structure", - "members":{ - "KMSKeyArn":{"shape":"KMSKeyArn"}, - "RetentionPeriodInDays":{"shape":"RetentionPeriodInDays"}, - "ExecutionTimeout":{"shape":"ExecutionTimeout"} - } - }, - "DurableExecutionAlreadyStartedException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "error":{ - "httpStatusCode":409, - "senderFault":true - }, - "exception":true - }, - "DurableExecutionArn":{ - "type":"string", - "max":1024, - "min":1, - "pattern":"arn:([a-zA-Z0-9-]+):lambda:([a-zA-Z0-9-]+):(\\d{12}):function:([a-zA-Z0-9_-]+):(\\$LATEST(?:\\.PUBLISHED)?|[0-9]+)/durable-execution/([a-zA-Z0-9_-]+)/([a-zA-Z0-9_-]+)" - }, - "DurableExecutionName":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[a-zA-Z0-9-_]+" - }, - "DurableExecutions":{ - "type":"list", - "member":{"shape":"Execution"} - }, - "DurationSeconds":{ - "type":"integer", - "box":true, - "min":0 - }, - "EC2AccessDeniedException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "error":{"httpStatusCode":502}, - "exception":true, - "fault":true - }, - "EC2ThrottledException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "error":{"httpStatusCode":502}, - "exception":true, - "fault":true - }, - "EC2UnexpectedException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"}, - "EC2ErrorCode":{"shape":"String"} - }, - "error":{"httpStatusCode":502}, - "exception":true, - "fault":true - }, - "EFSIOException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "error":{ - "httpStatusCode":410, - "senderFault":true - }, - "exception":true - }, - "EFSMountConnectivityException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "error":{ - "httpStatusCode":408, - "senderFault":true - }, - "exception":true - }, - "EFSMountFailureException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "error":{ - "httpStatusCode":403, - "senderFault":true - }, - "exception":true - }, - "EFSMountTimeoutException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "error":{ - "httpStatusCode":408, - "senderFault":true - }, - "exception":true - }, - "ENILimitReachedException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "error":{"httpStatusCode":502}, - "exception":true, - "fault":true - }, - "ENINotReadyException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "error":{"httpStatusCode":502}, - "exception":true, - "fault":true - }, - "Enabled":{ - "type":"boolean", - "box":true - }, - "EndPointType":{ - "type":"string", - "enum":["KAFKA_BOOTSTRAP_SERVERS"] - }, - "Endpoint":{ - "type":"string", - "max":300, - "min":1, - "pattern":"(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]):[0-9]{1,5}" - }, - "EndpointLists":{ - "type":"list", - "member":{"shape":"Endpoint"}, - "max":10, - "min":1 - }, - "Endpoints":{ - "type":"map", - "key":{"shape":"EndPointType"}, - "value":{"shape":"EndpointLists"}, - "max":2, - "min":1 - }, - "Environment":{ - "type":"structure", - "members":{ - "Variables":{"shape":"EnvironmentVariables"} - } - }, - "EnvironmentError":{ - "type":"structure", - "members":{ - "ErrorCode":{"shape":"String"}, - "Message":{"shape":"SensitiveString"} - } - }, - "EnvironmentResponse":{ - "type":"structure", - "members":{ - "Variables":{"shape":"EnvironmentVariables"}, - "Error":{"shape":"EnvironmentError"} - } - }, - "EnvironmentVariableName":{ - "type":"string", - "pattern":"[a-zA-Z]([a-zA-Z0-9_])+", - "sensitive":true - }, - "EnvironmentVariableValue":{ - "type":"string", - "sensitive":true - }, - "EnvironmentVariables":{ - "type":"map", - "key":{"shape":"EnvironmentVariableName"}, - "value":{"shape":"EnvironmentVariableValue"}, - "sensitive":true - }, - "EphemeralStorage":{ - "type":"structure", - "required":["Size"], - "members":{ - "Size":{"shape":"EphemeralStorageSize"} - } - }, - "EphemeralStorageSize":{ - "type":"integer", - "box":true, - "max":10240, - "min":512 - }, - "ErrorData":{ - "type":"string", - "sensitive":true - }, - "ErrorMessage":{ - "type":"string", - "sensitive":true - }, - "ErrorObject":{ - "type":"structure", - "members":{ - "ErrorMessage":{"shape":"ErrorMessage"}, - "ErrorType":{"shape":"ErrorType"}, - "ErrorData":{"shape":"ErrorData"}, - "StackTrace":{"shape":"StackTraceEntries"} - } - }, - "ErrorType":{ - "type":"string", - "sensitive":true - }, - "Event":{ - "type":"structure", - "members":{ - "EventType":{"shape":"EventType"}, - "SubType":{"shape":"OperationSubType"}, - "EventId":{"shape":"EventId"}, - "Id":{"shape":"OperationId"}, - "Name":{"shape":"OperationName"}, - "EventTimestamp":{"shape":"ExecutionTimestamp"}, - "ParentId":{"shape":"OperationId"}, - "ExecutionStartedDetails":{"shape":"ExecutionStartedDetails"}, - "ExecutionSucceededDetails":{"shape":"ExecutionSucceededDetails"}, - "ExecutionFailedDetails":{"shape":"ExecutionFailedDetails"}, - "ExecutionTimedOutDetails":{"shape":"ExecutionTimedOutDetails"}, - "ExecutionStoppedDetails":{"shape":"ExecutionStoppedDetails"}, - "ContextStartedDetails":{"shape":"ContextStartedDetails"}, - "ContextSucceededDetails":{"shape":"ContextSucceededDetails"}, - "ContextFailedDetails":{"shape":"ContextFailedDetails"}, - "WaitStartedDetails":{"shape":"WaitStartedDetails"}, - "WaitSucceededDetails":{"shape":"WaitSucceededDetails"}, - "WaitCancelledDetails":{"shape":"WaitCancelledDetails"}, - "StepStartedDetails":{"shape":"StepStartedDetails"}, - "StepSucceededDetails":{"shape":"StepSucceededDetails"}, - "StepFailedDetails":{"shape":"StepFailedDetails"}, - "ChainedInvokeStartedDetails":{"shape":"ChainedInvokeStartedDetails"}, - "ChainedInvokeSucceededDetails":{"shape":"ChainedInvokeSucceededDetails"}, - "ChainedInvokeFailedDetails":{"shape":"ChainedInvokeFailedDetails"}, - "ChainedInvokeTimedOutDetails":{"shape":"ChainedInvokeTimedOutDetails"}, - "ChainedInvokeStoppedDetails":{"shape":"ChainedInvokeStoppedDetails"}, - "CallbackStartedDetails":{"shape":"CallbackStartedDetails"}, - "CallbackSucceededDetails":{"shape":"CallbackSucceededDetails"}, - "CallbackFailedDetails":{"shape":"CallbackFailedDetails"}, - "CallbackTimedOutDetails":{"shape":"CallbackTimedOutDetails"}, - "InvocationCompletedDetails":{"shape":"InvocationCompletedDetails"} - } - }, - "EventError":{ - "type":"structure", - "members":{ - "Payload":{"shape":"ErrorObject"}, - "Truncated":{"shape":"Truncated"} - } - }, - "EventId":{ - "type":"integer", - "box":true, - "min":1 - }, - "EventInput":{ - "type":"structure", - "members":{ - "Payload":{"shape":"InputPayload"}, - "Truncated":{"shape":"Truncated"} - } - }, - "EventResult":{ - "type":"structure", - "members":{ - "Payload":{"shape":"OperationPayload"}, - "Truncated":{"shape":"Truncated"} - } - }, - "EventSourceMappingArn":{ - "type":"string", - "max":120, - "min":85, - "pattern":"arn:(aws[a-zA-Z-]*)?:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:event-source-mapping:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}" - }, - "EventSourceMappingConfiguration":{ - "type":"structure", - "members":{ - "UUID":{"shape":"UUIDString"}, - "StartingPosition":{"shape":"EventSourcePosition"}, - "StartingPositionTimestamp":{"shape":"Date"}, - "BatchSize":{"shape":"BatchSize"}, - "MaximumBatchingWindowInSeconds":{"shape":"MaximumBatchingWindowInSeconds"}, - "ParallelizationFactor":{"shape":"ParallelizationFactor"}, - "EventSourceArn":{"shape":"Arn"}, - "FilterCriteria":{"shape":"FilterCriteria"}, - "FilterCriteriaError":{"shape":"FilterCriteriaError"}, - "KMSKeyArn":{"shape":"KMSKeyArn"}, - "MetricsConfig":{"shape":"EventSourceMappingMetricsConfig"}, - "LoggingConfig":{"shape":"EventSourceMappingLoggingConfig"}, - "ScalingConfig":{"shape":"ScalingConfig"}, - "FunctionArn":{"shape":"FunctionArn"}, - "LastModified":{"shape":"Date"}, - "LastProcessingResult":{"shape":"String"}, - "State":{"shape":"String"}, - "StateTransitionReason":{"shape":"String"}, - "DestinationConfig":{"shape":"DestinationConfig"}, - "Topics":{"shape":"Topics"}, - "Queues":{"shape":"Queues"}, - "SourceAccessConfigurations":{"shape":"SourceAccessConfigurations"}, - "SelfManagedEventSource":{"shape":"SelfManagedEventSource"}, - "MaximumRecordAgeInSeconds":{"shape":"MaximumRecordAgeInSeconds"}, - "BisectBatchOnFunctionError":{"shape":"BisectBatchOnFunctionError"}, - "MaximumRetryAttempts":{"shape":"MaximumRetryAttemptsEventSourceMapping"}, - "TumblingWindowInSeconds":{"shape":"TumblingWindowInSeconds"}, - "FunctionResponseTypes":{"shape":"FunctionResponseTypeList"}, - "AmazonManagedKafkaEventSourceConfig":{"shape":"AmazonManagedKafkaEventSourceConfig"}, - "SelfManagedKafkaEventSourceConfig":{"shape":"SelfManagedKafkaEventSourceConfig"}, - "DocumentDBEventSourceConfig":{"shape":"DocumentDBEventSourceConfig"}, - "EventSourceMappingArn":{"shape":"EventSourceMappingArn"}, - "ProvisionedPollerConfig":{"shape":"ProvisionedPollerConfig"} - } - }, - "EventSourceMappingLoggingConfig":{ - "type":"structure", - "members":{ - "SystemLogLevel":{"shape":"EventSourceMappingSystemLogLevel"} - } - }, - "EventSourceMappingMetric":{ - "type":"string", - "enum":[ - "EventCount", - "ErrorCount", - "KafkaMetrics" - ] - }, - "EventSourceMappingMetricList":{ - "type":"list", - "member":{"shape":"EventSourceMappingMetric"}, - "max":3, - "min":0 - }, - "EventSourceMappingMetricsConfig":{ - "type":"structure", - "members":{ - "Metrics":{"shape":"EventSourceMappingMetricList"} - } - }, - "EventSourceMappingSystemLogLevel":{ - "type":"string", - "enum":[ - "DEBUG", - "INFO", - "WARN" - ] - }, - "EventSourceMappingsList":{ - "type":"list", - "member":{"shape":"EventSourceMappingConfiguration"} - }, - "EventSourcePosition":{ - "type":"string", - "enum":[ - "TRIM_HORIZON", - "LATEST", - "AT_TIMESTAMP" - ] - }, - "EventSourceToken":{ - "type":"string", - "max":256, - "min":0, - "pattern":"[a-zA-Z0-9._\\-]+" - }, - "EventType":{ - "type":"string", - "enum":[ - "ExecutionStarted", - "ExecutionSucceeded", - "ExecutionFailed", - "ExecutionTimedOut", - "ExecutionStopped", - "ContextStarted", - "ContextSucceeded", - "ContextFailed", - "WaitStarted", - "WaitSucceeded", - "WaitCancelled", - "StepStarted", - "StepSucceeded", - "StepFailed", - "ChainedInvokeStarted", - "ChainedInvokeSucceeded", - "ChainedInvokeFailed", - "ChainedInvokeTimedOut", - "ChainedInvokeStopped", - "CallbackStarted", - "CallbackSucceeded", - "CallbackFailed", - "CallbackTimedOut", - "InvocationCompleted" - ] - }, - "Events":{ - "type":"list", - "member":{"shape":"Event"} - }, - "Execution":{ - "type":"structure", - "required":[ - "DurableExecutionArn", - "DurableExecutionName", - "FunctionArn", - "Status", - "StartTimestamp" - ], - "members":{ - "DurableExecutionArn":{"shape":"DurableExecutionArn"}, - "DurableExecutionName":{"shape":"DurableExecutionName"}, - "FunctionArn":{"shape":"NameSpacedFunctionArn"}, - "Status":{"shape":"ExecutionStatus"}, - "StartTimestamp":{"shape":"ExecutionTimestamp"}, - "EndTimestamp":{"shape":"ExecutionTimestamp"}, - "KMSKeyArn":{"shape":"KMSKeyArn"} - } - }, - "ExecutionDataIncluded":{ - "type":"boolean", - "box":true - }, - "ExecutionDetails":{ - "type":"structure", - "members":{ - "InputPayload":{"shape":"InputPayload"} - } - }, - "ExecutionEnvironmentMemoryGiBPerVCpu":{ - "type":"double", - "box":true, - "max":8, - "min":2 - }, - "ExecutionFailedDetails":{ - "type":"structure", - "required":["Error"], - "members":{ - "Error":{"shape":"EventError"} - } - }, - "ExecutionStartedDetails":{ - "type":"structure", - "required":[ - "Input", - "ExecutionTimeout" - ], - "members":{ - "Input":{"shape":"EventInput"}, - "ExecutionTimeout":{"shape":"DurationSeconds"} - } - }, - "ExecutionStatus":{ - "type":"string", - "enum":[ - "RUNNING", - "SUCCEEDED", - "FAILED", - "TIMED_OUT", - "STOPPED" - ] - }, - "ExecutionStatusList":{ - "type":"list", - "member":{"shape":"ExecutionStatus"}, - "max":10, - "min":1 - }, - "ExecutionStoppedDetails":{ - "type":"structure", - "required":["Error"], - "members":{ - "Error":{"shape":"EventError"} - } - }, - "ExecutionSucceededDetails":{ - "type":"structure", - "required":["Result"], - "members":{ - "Result":{"shape":"EventResult"} - } - }, - "ExecutionTimedOutDetails":{ - "type":"structure", - "members":{ - "Error":{"shape":"EventError"} - } - }, - "ExecutionTimeout":{ - "type":"integer", - "box":true, - "max":31622400, - "min":1 - }, - "ExecutionTimestamp":{"type":"timestamp"}, - "FileSystemArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[a-zA-Z-]*:elasticfilesystem:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:access-point/fsap-[a-f0-9]{17}$|^arn:aws[-a-z]*:s3files:[0-9a-z-:]+:file-system/fs-[0-9a-f]{17,40}/access-point/fsap-[0-9a-f]{17,40}" - }, - "FileSystemConfig":{ - "type":"structure", - "required":[ - "Arn", - "LocalMountPath" - ], - "members":{ - "Arn":{"shape":"FileSystemArn"}, - "LocalMountPath":{"shape":"LocalMountPath"} - } - }, - "FileSystemConfigList":{ - "type":"list", - "member":{"shape":"FileSystemConfig"}, - "max":1, - "min":0 - }, - "Filter":{ - "type":"structure", - "members":{ - "Pattern":{"shape":"Pattern"} - } - }, - "FilterCriteria":{ - "type":"structure", - "members":{ - "Filters":{"shape":"FilterList"} - } - }, - "FilterCriteriaError":{ - "type":"structure", - "members":{ - "ErrorCode":{"shape":"FilterCriteriaErrorCode"}, - "Message":{"shape":"FilterCriteriaErrorMessage"} - } - }, - "FilterCriteriaErrorCode":{ - "type":"string", - "max":50, - "min":10, - "pattern":"[A-Za-z]+Exception" - }, - "FilterCriteriaErrorMessage":{ - "type":"string", - "max":2048, - "min":10, - "pattern":".*" - }, - "FilterList":{ - "type":"list", - "member":{"shape":"Filter"} - }, - "FullDocument":{ - "type":"string", - "enum":[ - "UpdateLookup", - "Default" - ] - }, - "FunctionArn":{ - "type":"string", - "max":10000, - "min":0, - "pattern":"arn:(aws[a-zA-Z-]*)?:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?" - }, - "FunctionArnList":{ - "type":"list", - "member":{"shape":"FunctionArn"} - }, - "FunctionCode":{ - "type":"structure", - "members":{ - "ZipFile":{"shape":"Blob"}, - "S3Bucket":{"shape":"S3Bucket"}, - "S3Key":{"shape":"S3Key"}, - "S3ObjectVersion":{"shape":"S3ObjectVersion"}, - "S3ObjectStorageMode":{"shape":"S3ObjectStorageMode"}, - "ImageUri":{"shape":"String"}, - "SourceKMSKeyArn":{"shape":"KMSKeyArn"} - } - }, - "FunctionCodeLocation":{ - "type":"structure", - "members":{ - "RepositoryType":{"shape":"String"}, - "Location":{"shape":"SensitiveStringOnServerOnly"}, - "ImageUri":{"shape":"String"}, - "ResolvedImageUri":{"shape":"String"}, - "ResolvedS3Object":{"shape":"ResolvedS3Object"}, - "SourceKMSKeyArn":{"shape":"KMSKeyArn"}, - "Error":{"shape":"FunctionCodeLocationError"} - } - }, - "FunctionCodeLocationError":{ - "type":"structure", - "members":{ - "ErrorCode":{"shape":"String"}, - "Message":{"shape":"SensitiveString"} - } - }, - "FunctionConfiguration":{ - "type":"structure", - "members":{ - "FunctionName":{"shape":"NamespacedFunctionName"}, - "FunctionArn":{"shape":"NameSpacedFunctionArn"}, - "Runtime":{"shape":"Runtime"}, - "Role":{"shape":"RoleArn"}, - "Handler":{"shape":"Handler"}, - "CodeSize":{"shape":"Long"}, - "Description":{"shape":"Description"}, - "Timeout":{"shape":"Timeout"}, - "MemorySize":{"shape":"MemorySize"}, - "LastModified":{"shape":"Timestamp"}, - "CodeSha256":{"shape":"String"}, - "Version":{"shape":"Version"}, - "VpcConfig":{"shape":"VpcConfigResponse"}, - "DeadLetterConfig":{"shape":"DeadLetterConfig"}, - "Environment":{"shape":"EnvironmentResponse"}, - "KMSKeyArn":{"shape":"KMSKeyArn"}, - "TracingConfig":{"shape":"TracingConfigResponse"}, - "MasterArn":{"shape":"FunctionArn"}, - "RevisionId":{"shape":"String"}, - "Layers":{"shape":"LayersReferenceList"}, - "State":{"shape":"State"}, - "StateReason":{"shape":"StateReason"}, - "StateReasonCode":{"shape":"StateReasonCode"}, - "LastUpdateStatus":{"shape":"LastUpdateStatus"}, - "LastUpdateStatusReason":{"shape":"LastUpdateStatusReason"}, - "LastUpdateStatusReasonCode":{"shape":"LastUpdateStatusReasonCode"}, - "FileSystemConfigs":{"shape":"FileSystemConfigList"}, - "SigningProfileVersionArn":{"shape":"Arn"}, - "SigningJobArn":{"shape":"Arn"}, - "PackageType":{"shape":"PackageType"}, - "ImageConfigResponse":{"shape":"ImageConfigResponse"}, - "Architectures":{"shape":"ArchitecturesList"}, - "EphemeralStorage":{"shape":"EphemeralStorage"}, - "SnapStart":{"shape":"SnapStartResponse"}, - "RuntimeVersionConfig":{"shape":"RuntimeVersionConfig"}, - "LoggingConfig":{"shape":"LoggingConfig"}, - "TenancyConfig":{"shape":"TenancyConfig"}, - "CapacityProviderConfig":{"shape":"CapacityProviderConfig"}, - "ConfigSha256":{"shape":"String"}, - "DurableConfig":{"shape":"DurableConfig"} - } - }, - "FunctionEventInvokeConfig":{ - "type":"structure", - "members":{ - "LastModified":{"shape":"Date"}, - "FunctionArn":{"shape":"FunctionArn"}, - "MaximumRetryAttempts":{"shape":"MaximumRetryAttempts"}, - "MaximumEventAgeInSeconds":{"shape":"MaximumEventAgeInSeconds"}, - "DestinationConfig":{"shape":"DestinationConfig"} - } - }, - "FunctionEventInvokeConfigList":{ - "type":"list", - "member":{"shape":"FunctionEventInvokeConfig"} - }, - "FunctionList":{ - "type":"list", - "member":{"shape":"FunctionConfiguration"} - }, - "FunctionName":{ - "type":"string", - "max":140, - "min":1, - "pattern":"(arn:(aws[a-zA-Z-]*)?:lambda:)?((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?" - }, - "FunctionResponseType":{ - "type":"string", - "enum":["ReportBatchItemFailures"] - }, - "FunctionResponseTypeList":{ - "type":"list", - "member":{"shape":"FunctionResponseType"}, - "max":1, - "min":0 - }, - "FunctionScalingConfig":{ - "type":"structure", - "members":{ - "MinExecutionEnvironments":{"shape":"FunctionScalingConfigExecutionEnvironments"}, - "MaxExecutionEnvironments":{"shape":"FunctionScalingConfigExecutionEnvironments"} - } - }, - "FunctionScalingConfigExecutionEnvironments":{ - "type":"integer", - "box":true, - "max":15000, - "min":0 - }, - "FunctionUrl":{ - "type":"string", - "max":100, - "min":40 - }, - "FunctionUrlAuthType":{ - "type":"string", - "enum":[ - "NONE", - "AWS_IAM" - ] - }, - "FunctionUrlConfig":{ - "type":"structure", - "required":[ - "FunctionUrl", - "FunctionArn", - "CreationTime", - "LastModifiedTime", - "AuthType" - ], - "members":{ - "FunctionUrl":{"shape":"FunctionUrl"}, - "FunctionArn":{"shape":"FunctionArn"}, - "CreationTime":{"shape":"Timestamp"}, - "LastModifiedTime":{"shape":"Timestamp"}, - "Cors":{"shape":"Cors"}, - "AuthType":{"shape":"FunctionUrlAuthType"}, - "InvokeMode":{"shape":"InvokeMode"} - } - }, - "FunctionUrlConfigList":{ - "type":"list", - "member":{"shape":"FunctionUrlConfig"} - }, - "FunctionUrlFunctionName":{ - "type":"string", - "max":140, - "min":1, - "pattern":"(arn:(aws[a-zA-Z-]*)?:lambda:)?((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]{1,64})(:((?!\\d+$)[0-9a-zA-Z-_]+))?" - }, - "FunctionUrlQualifier":{ - "type":"string", - "max":128, - "min":1, - "pattern":"((?!^\\d+$)^[0-9a-zA-Z-_]+$)" - }, - "FunctionVersion":{ - "type":"string", - "enum":["ALL"] - }, - "FunctionVersionLatestPublished":{ - "type":"string", - "enum":["LATEST_PUBLISHED"] - }, - "FunctionVersionsByCapacityProviderList":{ - "type":"list", - "member":{"shape":"FunctionVersionsByCapacityProviderListItem"}, - "max":50, - "min":0 - }, - "FunctionVersionsByCapacityProviderListItem":{ - "type":"structure", - "required":[ - "FunctionArn", - "State" - ], - "members":{ - "FunctionArn":{"shape":"NameSpacedFunctionArn"}, - "State":{"shape":"State"} - } - }, - "FunctionVersionsPerCapacityProviderLimitExceededException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "message":{"shape":"String"} - }, - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "GetAccountSettingsRequest":{ - "type":"structure", - "members":{} - }, - "GetAccountSettingsResponse":{ - "type":"structure", - "members":{ - "AccountLimit":{"shape":"AccountLimit"}, - "AccountUsage":{"shape":"AccountUsage"} - } - }, - "GetAliasRequest":{ - "type":"structure", - "required":[ - "FunctionName", - "Name" - ], - "members":{ - "FunctionName":{ - "shape":"FunctionName", - "location":"uri", - "locationName":"FunctionName" - }, - "Name":{ - "shape":"Alias", - "location":"uri", - "locationName":"Name" - } - } - }, - "GetCapacityProviderRequest":{ - "type":"structure", - "required":["CapacityProviderName"], - "members":{ - "CapacityProviderName":{ - "shape":"CapacityProviderName", - "location":"uri", - "locationName":"CapacityProviderName" - } - } - }, - "GetCapacityProviderResponse":{ - "type":"structure", - "required":["CapacityProvider"], - "members":{ - "CapacityProvider":{"shape":"CapacityProvider"} - } - }, - "GetCodeSigningConfigRequest":{ - "type":"structure", - "required":["CodeSigningConfigArn"], - "members":{ - "CodeSigningConfigArn":{ - "shape":"CodeSigningConfigArn", - "location":"uri", - "locationName":"CodeSigningConfigArn" - } - } - }, - "GetCodeSigningConfigResponse":{ - "type":"structure", - "required":["CodeSigningConfig"], - "members":{ - "CodeSigningConfig":{"shape":"CodeSigningConfig"} - } - }, - "GetDurableExecutionHistoryRequest":{ - "type":"structure", - "required":["DurableExecutionArn"], - "members":{ - "DurableExecutionArn":{ - "shape":"DurableExecutionArn", - "location":"uri", - "locationName":"DurableExecutionArn" - }, - "IncludeExecutionData":{ - "shape":"IncludeExecutionData", - "location":"querystring", - "locationName":"IncludeExecutionData" - }, - "MaxItems":{ - "shape":"ItemCount", - "location":"querystring", - "locationName":"MaxItems" - }, - "Marker":{ - "shape":"String", - "location":"querystring", - "locationName":"Marker" - }, - "ReverseOrder":{ - "shape":"ReverseOrder", - "location":"querystring", - "locationName":"ReverseOrder" - } - } - }, - "GetDurableExecutionHistoryResponse":{ - "type":"structure", - "required":["Events"], - "members":{ - "Events":{"shape":"Events"}, - "NextMarker":{"shape":"String"} - } - }, - "GetDurableExecutionRequest":{ - "type":"structure", - "required":["DurableExecutionArn"], - "members":{ - "DurableExecutionArn":{ - "shape":"DurableExecutionArn", - "location":"uri", - "locationName":"DurableExecutionArn" - }, - "IncludeExecutionData":{ - "shape":"IncludeExecutionData", - "location":"querystring", - "locationName":"IncludeExecutionData" - } - } - }, - "GetDurableExecutionResponse":{ - "type":"structure", - "required":[ - "DurableExecutionArn", - "DurableExecutionName", - "FunctionArn", - "StartTimestamp", - "Status" - ], - "members":{ - "DurableExecutionArn":{"shape":"DurableExecutionArn"}, - "DurableExecutionName":{"shape":"DurableExecutionName"}, - "FunctionArn":{"shape":"NameSpacedFunctionArn"}, - "InputPayload":{"shape":"InputPayload"}, - "Result":{"shape":"OutputPayload"}, - "Error":{"shape":"ErrorObject"}, - "StartTimestamp":{"shape":"ExecutionTimestamp"}, - "Status":{"shape":"ExecutionStatus"}, - "EndTimestamp":{"shape":"ExecutionTimestamp"}, - "Version":{"shape":"VersionWithLatestPublished"}, - "TraceHeader":{"shape":"TraceHeader"}, - "ExecutionDataIncluded":{"shape":"ExecutionDataIncluded"}, - "DurableConfig":{"shape":"DurableConfig"} - } - }, - "GetDurableExecutionStateRequest":{ - "type":"structure", - "required":[ - "DurableExecutionArn", - "CheckpointToken" - ], - "members":{ - "DurableExecutionArn":{ - "shape":"DurableExecutionArn", - "location":"uri", - "locationName":"DurableExecutionArn" - }, - "CheckpointToken":{ - "shape":"CheckpointToken", - "location":"querystring", - "locationName":"CheckpointToken" - }, - "Marker":{ - "shape":"String", - "location":"querystring", - "locationName":"Marker" - }, - "MaxItems":{ - "shape":"ItemCount", - "location":"querystring", - "locationName":"MaxItems" - } - } - }, - "GetDurableExecutionStateResponse":{ - "type":"structure", - "required":["Operations"], - "members":{ - "Operations":{"shape":"Operations"}, - "NextMarker":{"shape":"String"} - } - }, - "GetEventSourceMappingRequest":{ - "type":"structure", - "required":["UUID"], - "members":{ - "UUID":{ - "shape":"UUIDString", - "location":"uri", - "locationName":"UUID" - } - } - }, - "GetFunctionCodeSigningConfigRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "location":"uri", - "locationName":"FunctionName" - } - } - }, - "GetFunctionCodeSigningConfigResponse":{ - "type":"structure", - "required":[ - "CodeSigningConfigArn", - "FunctionName" - ], - "members":{ - "CodeSigningConfigArn":{"shape":"CodeSigningConfigArn"}, - "FunctionName":{"shape":"FunctionName"} - } - }, - "GetFunctionConcurrencyRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"FunctionName", - "location":"uri", - "locationName":"FunctionName" - } - } - }, - "GetFunctionConcurrencyResponse":{ - "type":"structure", - "members":{ - "ReservedConcurrentExecutions":{"shape":"ReservedConcurrentExecutions"} - } - }, - "GetFunctionConfigurationRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "location":"uri", - "locationName":"FunctionName" - }, - "Qualifier":{ - "shape":"NumericLatestPublishedOrAliasQualifier", - "location":"querystring", - "locationName":"Qualifier" - } - } - }, - "GetFunctionEventInvokeConfigRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "location":"uri", - "locationName":"FunctionName" - }, - "Qualifier":{ - "shape":"NumericLatestPublishedOrAliasQualifier", - "location":"querystring", - "locationName":"Qualifier" - } - } - }, - "GetFunctionRecursionConfigRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"UnqualifiedFunctionName", - "location":"uri", - "locationName":"FunctionName" - } - } - }, - "GetFunctionRecursionConfigResponse":{ - "type":"structure", - "members":{ - "RecursiveLoop":{"shape":"RecursiveLoop"} - } - }, - "GetFunctionRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "location":"uri", - "locationName":"FunctionName" - }, - "Qualifier":{ - "shape":"NumericLatestPublishedOrAliasQualifier", - "location":"querystring", - "locationName":"Qualifier" - } - } - }, - "GetFunctionResponse":{ - "type":"structure", - "members":{ - "Configuration":{"shape":"FunctionConfiguration"}, - "Code":{"shape":"FunctionCodeLocation"}, - "Tags":{"shape":"Tags"}, - "TagsError":{"shape":"TagsError"}, - "Concurrency":{"shape":"Concurrency"} - } - }, - "GetFunctionScalingConfigRequest":{ - "type":"structure", - "required":[ - "FunctionName", - "Qualifier" - ], - "members":{ - "FunctionName":{ - "shape":"UnqualifiedFunctionName", - "location":"uri", - "locationName":"FunctionName" - }, - "Qualifier":{ - "shape":"PublishedFunctionQualifier", - "location":"querystring", - "locationName":"Qualifier" - } - } - }, - "GetFunctionScalingConfigResponse":{ - "type":"structure", - "members":{ - "FunctionArn":{"shape":"FunctionArn"}, - "AppliedFunctionScalingConfig":{"shape":"FunctionScalingConfig"}, - "RequestedFunctionScalingConfig":{"shape":"FunctionScalingConfig"} - } - }, - "GetFunctionUrlConfigRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"FunctionUrlFunctionName", - "location":"uri", - "locationName":"FunctionName" - }, - "Qualifier":{ - "shape":"FunctionUrlQualifier", - "location":"querystring", - "locationName":"Qualifier" - } - } - }, - "GetFunctionUrlConfigResponse":{ - "type":"structure", - "required":[ - "FunctionUrl", - "FunctionArn", - "AuthType", - "CreationTime", - "LastModifiedTime" - ], - "members":{ - "FunctionUrl":{"shape":"FunctionUrl"}, - "FunctionArn":{"shape":"FunctionArn"}, - "AuthType":{"shape":"FunctionUrlAuthType"}, - "Cors":{"shape":"Cors"}, - "CreationTime":{"shape":"Timestamp"}, - "LastModifiedTime":{"shape":"Timestamp"}, - "InvokeMode":{"shape":"InvokeMode"} - } - }, - "GetLayerVersionByArnRequest":{ - "type":"structure", - "required":["Arn"], - "members":{ - "Arn":{ - "shape":"LayerVersionArn", - "location":"querystring", - "locationName":"Arn" - } - } - }, - "GetLayerVersionPolicyRequest":{ - "type":"structure", - "required":[ - "LayerName", - "VersionNumber" - ], - "members":{ - "LayerName":{ - "shape":"LayerName", - "location":"uri", - "locationName":"LayerName" - }, - "VersionNumber":{ - "shape":"LayerVersionNumber", - "location":"uri", - "locationName":"VersionNumber" - } - } - }, - "GetLayerVersionPolicyResponse":{ - "type":"structure", - "members":{ - "Policy":{"shape":"String"}, - "RevisionId":{"shape":"String"} - } - }, - "GetLayerVersionRequest":{ - "type":"structure", - "required":[ - "LayerName", - "VersionNumber" - ], - "members":{ - "LayerName":{ - "shape":"LayerName", - "location":"uri", - "locationName":"LayerName" - }, - "VersionNumber":{ - "shape":"LayerVersionNumber", - "location":"uri", - "locationName":"VersionNumber" - } - } - }, - "GetLayerVersionResponse":{ - "type":"structure", - "members":{ - "Content":{"shape":"LayerVersionContentOutput"}, - "LayerArn":{"shape":"LayerArn"}, - "LayerVersionArn":{"shape":"LayerVersionArn"}, - "Description":{"shape":"Description"}, - "CreatedDate":{"shape":"Timestamp"}, - "Version":{"shape":"LayerVersionNumber"}, - "CompatibleArchitectures":{"shape":"CompatibleArchitectures"}, - "CompatibleRuntimes":{"shape":"CompatibleRuntimes"}, - "LicenseInfo":{"shape":"LicenseInfo"} - } - }, - "GetPolicyRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "location":"uri", - "locationName":"FunctionName" - }, - "Qualifier":{ - "shape":"NumericLatestPublishedOrAliasQualifier", - "location":"querystring", - "locationName":"Qualifier" - } - } - }, - "GetPolicyResponse":{ - "type":"structure", - "members":{ - "Policy":{"shape":"String"}, - "RevisionId":{"shape":"String"} - } - }, - "GetProvisionedConcurrencyConfigRequest":{ - "type":"structure", - "required":[ - "FunctionName", - "Qualifier" - ], - "members":{ - "FunctionName":{ - "shape":"FunctionName", - "location":"uri", - "locationName":"FunctionName" - }, - "Qualifier":{ - "shape":"Qualifier", - "location":"querystring", - "locationName":"Qualifier" - } - } - }, - "GetProvisionedConcurrencyConfigResponse":{ - "type":"structure", - "members":{ - "RequestedProvisionedConcurrentExecutions":{"shape":"PositiveInteger"}, - "AvailableProvisionedConcurrentExecutions":{"shape":"NonNegativeInteger"}, - "AllocatedProvisionedConcurrentExecutions":{"shape":"NonNegativeInteger"}, - "Status":{"shape":"ProvisionedConcurrencyStatusEnum"}, - "StatusReason":{"shape":"String"}, - "LastModified":{"shape":"Timestamp"} - } - }, - "GetRuntimeManagementConfigRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "location":"uri", - "locationName":"FunctionName" - }, - "Qualifier":{ - "shape":"NumericLatestPublishedOrAliasQualifier", - "location":"querystring", - "locationName":"Qualifier" - } - } - }, - "GetRuntimeManagementConfigResponse":{ - "type":"structure", - "members":{ - "UpdateRuntimeOn":{"shape":"UpdateRuntimeOn"}, - "FunctionArn":{"shape":"NameSpacedFunctionArn"}, - "RuntimeVersionArn":{"shape":"RuntimeVersionArn"} - } - }, - "Handler":{ - "type":"string", - "max":128, - "min":0, - "pattern":"[^\\s]+" - }, - "Header":{ - "type":"string", - "max":1024, - "min":0, - "pattern":".*" - }, - "HeadersList":{ - "type":"list", - "member":{"shape":"Header"}, - "max":100, - "min":0 - }, - "HttpStatus":{"type":"integer"}, - "ImageConfig":{ - "type":"structure", - "members":{ - "EntryPoint":{"shape":"StringList"}, - "Command":{"shape":"StringList"}, - "WorkingDirectory":{"shape":"WorkingDirectory"} - } - }, - "ImageConfigError":{ - "type":"structure", - "members":{ - "ErrorCode":{"shape":"String"}, - "Message":{"shape":"SensitiveString"} - } - }, - "ImageConfigResponse":{ - "type":"structure", - "members":{ - "ImageConfig":{"shape":"ImageConfig"}, - "Error":{"shape":"ImageConfigError"} - } - }, - "IncludeExecutionData":{ - "type":"boolean", - "box":true - }, - "InputPayload":{ - "type":"string", - "max":6291456, - "min":0, - "sensitive":true - }, - "InstanceRequirements":{ - "type":"structure", - "members":{ - "Architectures":{"shape":"ArchitecturesList"}, - "AllowedInstanceTypes":{"shape":"InstanceTypeSet"}, - "ExcludedInstanceTypes":{"shape":"InstanceTypeSet"} - } - }, - "InstanceType":{ - "type":"string", - "max":30, - "min":1, - "pattern":"[a-zA-Z0-9\\.\\*\\-]+" - }, - "InstanceTypeSet":{ - "type":"list", - "member":{"shape":"InstanceType"}, - "max":400, - "min":0 - }, - "Integer":{"type":"integer"}, - "InvalidCodeSignatureException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "InvalidParameterValueException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "message":{"shape":"String"} - }, - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "InvalidRequestContentException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "message":{"shape":"String"} - }, - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "InvalidRuntimeException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "error":{"httpStatusCode":502}, - "exception":true, - "fault":true - }, - "InvalidSecurityGroupIDException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "error":{"httpStatusCode":502}, - "exception":true, - "fault":true - }, - "InvalidSubnetIDException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "error":{"httpStatusCode":502}, - "exception":true, - "fault":true - }, - "InvalidZipFileException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "error":{"httpStatusCode":502}, - "exception":true, - "fault":true - }, - "InvocationCompletedDetails":{ - "type":"structure", - "required":[ - "StartTimestamp", - "EndTimestamp", - "RequestId" - ], - "members":{ - "StartTimestamp":{"shape":"ExecutionTimestamp"}, - "EndTimestamp":{"shape":"ExecutionTimestamp"}, - "RequestId":{"shape":"String"}, - "Error":{"shape":"EventError"} - } - }, - "InvocationRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "location":"uri", - "locationName":"FunctionName" - }, - "InvocationType":{ - "shape":"InvocationType", - "location":"header", - "locationName":"X-Amz-Invocation-Type" - }, - "LogType":{ - "shape":"LogType", - "location":"header", - "locationName":"X-Amz-Log-Type" - }, - "ClientContext":{ - "shape":"String", - "location":"header", - "locationName":"X-Amz-Client-Context" - }, - "DurableExecutionName":{ - "shape":"DurableExecutionName", - "location":"header", - "locationName":"X-Amz-Durable-Execution-Name" - }, - "Payload":{"shape":"Blob"}, - "Qualifier":{ - "shape":"NumericLatestPublishedOrAliasQualifier", - "location":"querystring", - "locationName":"Qualifier" - }, - "TenantId":{ - "shape":"TenantId", - "location":"header", - "locationName":"X-Amz-Tenant-Id" - } - }, - "payload":"Payload" - }, - "InvocationResponse":{ - "type":"structure", - "members":{ - "StatusCode":{ - "shape":"Integer", - "location":"statusCode" - }, - "FunctionError":{ - "shape":"String", - "location":"header", - "locationName":"X-Amz-Function-Error" - }, - "LogResult":{ - "shape":"String", - "location":"header", - "locationName":"X-Amz-Log-Result" - }, - "Payload":{"shape":"Blob"}, - "ExecutedVersion":{ - "shape":"Version", - "location":"header", - "locationName":"X-Amz-Executed-Version" - }, - "DurableExecutionArn":{ - "shape":"DurableExecutionArn", - "location":"header", - "locationName":"X-Amz-Durable-Execution-Arn" - } - }, - "payload":"Payload" - }, - "InvocationType":{ - "type":"string", - "enum":[ - "Event", - "RequestResponse", - "DryRun" - ] - }, - "InvokeAsyncRequest":{ - "type":"structure", - "required":[ - "FunctionName", - "InvokeArgs" - ], - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "location":"uri", - "locationName":"FunctionName" - }, - "InvokeArgs":{"shape":"BlobStream"} - }, - "deprecated":true, - "payload":"InvokeArgs" - }, - "InvokeAsyncResponse":{ - "type":"structure", - "members":{ - "Status":{ - "shape":"HttpStatus", - "location":"statusCode" - } - }, - "deprecated":true - }, - "InvokeMode":{ - "type":"string", - "enum":[ - "BUFFERED", - "RESPONSE_STREAM" - ] - }, - "InvokeResponseStreamUpdate":{ - "type":"structure", - "members":{ - "Payload":{ - "shape":"Blob", - "eventpayload":true - } - }, - "event":true - }, - "InvokeWithResponseStreamCompleteEvent":{ - "type":"structure", - "members":{ - "ErrorCode":{"shape":"String"}, - "ErrorDetails":{"shape":"String"}, - "LogResult":{"shape":"String"} - }, - "event":true - }, - "InvokeWithResponseStreamRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "location":"uri", - "locationName":"FunctionName" - }, - "LogType":{ - "shape":"LogType", - "location":"header", - "locationName":"X-Amz-Log-Type" - }, - "ClientContext":{ - "shape":"String", - "location":"header", - "locationName":"X-Amz-Client-Context" - }, - "Qualifier":{ - "shape":"NumericLatestPublishedOrAliasQualifier", - "location":"querystring", - "locationName":"Qualifier" - }, - "Payload":{"shape":"Blob"}, - "TenantId":{ - "shape":"TenantId", - "location":"header", - "locationName":"X-Amz-Tenant-Id" - }, - "InvocationType":{ - "shape":"ResponseStreamingInvocationType", - "location":"header", - "locationName":"X-Amz-Invocation-Type" - } - }, - "payload":"Payload" - }, - "InvokeWithResponseStreamResponse":{ - "type":"structure", - "members":{ - "StatusCode":{ - "shape":"Integer", - "location":"statusCode" - }, - "ExecutedVersion":{ - "shape":"Version", - "location":"header", - "locationName":"X-Amz-Executed-Version" - }, - "EventStream":{"shape":"InvokeWithResponseStreamResponseEvent"}, - "ResponseStreamContentType":{ - "shape":"String", - "location":"header", - "locationName":"Content-Type" - } - }, - "payload":"EventStream" - }, - "InvokeWithResponseStreamResponseEvent":{ - "type":"structure", - "members":{ - "PayloadChunk":{"shape":"InvokeResponseStreamUpdate"}, - "InvokeComplete":{"shape":"InvokeWithResponseStreamCompleteEvent"} - }, - "eventstream":true - }, - "InvokedViaFunctionUrl":{ - "type":"boolean", - "box":true - }, - "ItemCount":{ - "type":"integer", - "max":1000, - "min":0 - }, - "KMSAccessDeniedException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "error":{"httpStatusCode":502}, - "exception":true, - "fault":true - }, - "KMSDisabledException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "error":{"httpStatusCode":502}, - "exception":true, - "fault":true - }, - "KMSInvalidStateException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "error":{"httpStatusCode":502}, - "exception":true, - "fault":true - }, - "KMSKeyArn":{ - "type":"string", - "max":10000, - "min":0, - "pattern":"(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()" - }, - "KMSKeyArnNonEmpty":{ - "type":"string", - "max":10000, - "min":0, - "pattern":"arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*" - }, - "KMSNotFoundException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "error":{"httpStatusCode":502}, - "exception":true, - "fault":true - }, - "KafkaSchemaRegistryAccessConfig":{ - "type":"structure", - "members":{ - "Type":{"shape":"KafkaSchemaRegistryAuthType"}, - "URI":{"shape":"Arn"} - } - }, - "KafkaSchemaRegistryAccessConfigList":{ - "type":"list", - "member":{"shape":"KafkaSchemaRegistryAccessConfig"} - }, - "KafkaSchemaRegistryAuthType":{ - "type":"string", - "enum":[ - "BASIC_AUTH", - "CLIENT_CERTIFICATE_TLS_AUTH", - "SERVER_ROOT_CA_CERTIFICATE" - ] - }, - "KafkaSchemaRegistryConfig":{ - "type":"structure", - "members":{ - "SchemaRegistryURI":{"shape":"SchemaRegistryUri"}, - "EventRecordFormat":{"shape":"SchemaRegistryEventRecordFormat"}, - "AccessConfigs":{"shape":"KafkaSchemaRegistryAccessConfigList"}, - "SchemaValidationConfigs":{"shape":"KafkaSchemaValidationConfigList"} - } - }, - "KafkaSchemaValidationAttribute":{ - "type":"string", - "enum":[ - "KEY", - "VALUE" - ] - }, - "KafkaSchemaValidationConfig":{ - "type":"structure", - "members":{ - "Attribute":{"shape":"KafkaSchemaValidationAttribute"} - } - }, - "KafkaSchemaValidationConfigList":{ - "type":"list", - "member":{"shape":"KafkaSchemaValidationConfig"} - }, - "LambdaManagedInstancesCapacityProviderConfig":{ - "type":"structure", - "required":["CapacityProviderArn"], - "members":{ - "CapacityProviderArn":{"shape":"CapacityProviderArn"}, - "PerExecutionEnvironmentMaxConcurrency":{"shape":"PerExecutionEnvironmentMaxConcurrency"}, - "ExecutionEnvironmentMemoryGiBPerVCpu":{"shape":"ExecutionEnvironmentMemoryGiBPerVCpu"} - } - }, - "LastUpdateStatus":{ - "type":"string", - "enum":[ - "Successful", - "Failed", - "InProgress" - ] - }, - "LastUpdateStatusReason":{"type":"string"}, - "LastUpdateStatusReasonCode":{ - "type":"string", - "enum":[ - "EniLimitExceeded", - "InsufficientRolePermissions", - "InvalidConfiguration", - "InternalError", - "SubnetOutOfIPAddresses", - "InvalidSubnet", - "InvalidSecurityGroup", - "ImageDeleted", - "ImageAccessDenied", - "InvalidImage", - "KMSKeyAccessDenied", - "KMSKeyNotFound", - "InvalidStateKMSKey", - "DisabledKMSKey", - "EFSIOError", - "EFSMountConnectivityError", - "EFSMountFailure", - "EFSMountTimeout", - "InvalidRuntime", - "InvalidZipFileException", - "FunctionError", - "ServiceQuotaExceededException", - "VcpuLimitExceeded", - "CapacityProviderScalingLimitExceeded", - "InsufficientCapacity", - "EC2RequestLimitExceeded", - "FunctionError.InitTimeout", - "FunctionError.RuntimeInitError", - "FunctionError.ExtensionInitError", - "FunctionError.InvalidEntryPoint", - "FunctionError.InvalidWorkingDirectory", - "FunctionError.PermissionDenied", - "FunctionError.TooManyExtensions", - "FunctionError.InitResourceExhausted", - "DisallowedByVpcEncryptionControl", - "DependencyError" - ] - }, - "Layer":{ - "type":"structure", - "members":{ - "Arn":{"shape":"LayerVersionArn"}, - "CodeSize":{"shape":"Long"}, - "SigningProfileVersionArn":{"shape":"Arn"}, - "SigningJobArn":{"shape":"Arn"} - } - }, - "LayerArn":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"arn:(aws[a-zA-Z-]*)?:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:layer:[a-zA-Z0-9-_]+" - }, - "LayerList":{ - "type":"list", - "member":{"shape":"LayerVersionArn"} - }, - "LayerName":{ - "type":"string", - "max":140, - "min":1, - "pattern":"(arn:(aws[a-zA-Z-]*)?:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:layer:[a-zA-Z0-9-_]+)|[a-zA-Z0-9-_]+" - }, - "LayerPermissionAllowedAction":{ - "type":"string", - "max":22, - "min":0, - "pattern":"lambda:GetLayerVersion" - }, - "LayerPermissionAllowedPrincipal":{ - "type":"string", - "max":10000, - "min":0, - "pattern":"\\d{12}|\\*|arn:(aws[a-zA-Z-]*):iam::\\d{12}:root" - }, - "LayerVersionArn":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"((arn:(aws[a-zA-Z-]*)?:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:layer:[a-zA-Z0-9-_]+:[0-9]+)|(arn:[a-zA-Z0-9-]+:lambda:::awslayer:[a-zA-Z0-9-_]+))" - }, - "LayerVersionContentInput":{ - "type":"structure", - "members":{ - "S3Bucket":{"shape":"S3Bucket"}, - "S3Key":{"shape":"S3Key"}, - "S3ObjectVersion":{"shape":"S3ObjectVersion"}, - "S3ObjectStorageMode":{"shape":"S3ObjectStorageMode"}, - "ZipFile":{"shape":"Blob"} - } - }, - "LayerVersionContentOutput":{ - "type":"structure", - "members":{ - "Location":{"shape":"SensitiveStringOnServerOnly"}, - "CodeSha256":{"shape":"String"}, - "CodeSize":{"shape":"Long"}, - "SigningProfileVersionArn":{"shape":"Arn"}, - "SigningJobArn":{"shape":"Arn"}, - "ResolvedS3Object":{"shape":"ResolvedS3Object"} - } - }, - "LayerVersionNumber":{"type":"long"}, - "LayerVersionsList":{ - "type":"list", - "member":{"shape":"LayerVersionsListItem"} - }, - "LayerVersionsListItem":{ - "type":"structure", - "members":{ - "LayerVersionArn":{"shape":"LayerVersionArn"}, - "Version":{"shape":"LayerVersionNumber"}, - "Description":{"shape":"Description"}, - "CreatedDate":{"shape":"Timestamp"}, - "CompatibleArchitectures":{"shape":"CompatibleArchitectures"}, - "CompatibleRuntimes":{"shape":"CompatibleRuntimes"}, - "LicenseInfo":{"shape":"LicenseInfo"} - } - }, - "LayersList":{ - "type":"list", - "member":{"shape":"LayersListItem"} - }, - "LayersListItem":{ - "type":"structure", - "members":{ - "LayerName":{"shape":"LayerName"}, - "LayerArn":{"shape":"LayerArn"}, - "LatestMatchingVersion":{"shape":"LayerVersionsListItem"} - } - }, - "LayersReferenceList":{ - "type":"list", - "member":{"shape":"Layer"} - }, - "LicenseInfo":{ - "type":"string", - "max":512, - "min":0, - "pattern":".*" - }, - "ListAliasesRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"FunctionName", - "location":"uri", - "locationName":"FunctionName" - }, - "FunctionVersion":{ - "shape":"VersionWithLatestPublished", - "location":"querystring", - "locationName":"FunctionVersion" - }, - "Marker":{ - "shape":"String", - "location":"querystring", - "locationName":"Marker" - }, - "MaxItems":{ - "shape":"MaxListItems", - "location":"querystring", - "locationName":"MaxItems" - } - } - }, - "ListAliasesResponse":{ - "type":"structure", - "members":{ - "NextMarker":{"shape":"String"}, - "Aliases":{"shape":"AliasList"} - } - }, - "ListCapacityProvidersRequest":{ - "type":"structure", - "members":{ - "State":{ - "shape":"CapacityProviderState", - "location":"querystring", - "locationName":"State" - }, - "Marker":{ - "shape":"String", - "location":"querystring", - "locationName":"Marker" - }, - "MaxItems":{ - "shape":"MaxFiftyListItems", - "location":"querystring", - "locationName":"MaxItems" - } - } - }, - "ListCapacityProvidersResponse":{ - "type":"structure", - "required":["CapacityProviders"], - "members":{ - "CapacityProviders":{"shape":"CapacityProvidersList"}, - "NextMarker":{"shape":"String"} - } - }, - "ListCodeSigningConfigsRequest":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "location":"querystring", - "locationName":"Marker" - }, - "MaxItems":{ - "shape":"MaxListItems", - "location":"querystring", - "locationName":"MaxItems" - } - } - }, - "ListCodeSigningConfigsResponse":{ - "type":"structure", - "members":{ - "NextMarker":{"shape":"String"}, - "CodeSigningConfigs":{"shape":"CodeSigningConfigList"} - } - }, - "ListDurableExecutionsByFunctionRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "location":"uri", - "locationName":"FunctionName" - }, - "Qualifier":{ - "shape":"NumericLatestPublishedOrAliasQualifier", - "location":"querystring", - "locationName":"Qualifier" - }, - "DurableExecutionName":{ - "shape":"DurableExecutionName", - "location":"querystring", - "locationName":"DurableExecutionName" - }, - "Statuses":{ - "shape":"ExecutionStatusList", - "location":"querystring", - "locationName":"Statuses" - }, - "StartedAfter":{ - "shape":"ExecutionTimestamp", - "location":"querystring", - "locationName":"StartedAfter" - }, - "StartedBefore":{ - "shape":"ExecutionTimestamp", - "location":"querystring", - "locationName":"StartedBefore" - }, - "ReverseOrder":{ - "shape":"ReverseOrder", - "location":"querystring", - "locationName":"ReverseOrder" - }, - "Marker":{ - "shape":"String", - "location":"querystring", - "locationName":"Marker" - }, - "MaxItems":{ - "shape":"ItemCount", - "location":"querystring", - "locationName":"MaxItems" - } - } - }, - "ListDurableExecutionsByFunctionResponse":{ - "type":"structure", - "members":{ - "DurableExecutions":{"shape":"DurableExecutions"}, - "NextMarker":{"shape":"String"} - } - }, - "ListEventSourceMappingsRequest":{ - "type":"structure", - "members":{ - "EventSourceArn":{ - "shape":"Arn", - "location":"querystring", - "locationName":"EventSourceArn" - }, - "FunctionName":{ - "shape":"NamespacedFunctionName", - "location":"querystring", - "locationName":"FunctionName" - }, - "Marker":{ - "shape":"String", - "location":"querystring", - "locationName":"Marker" - }, - "MaxItems":{ - "shape":"MaxListItems", - "location":"querystring", - "locationName":"MaxItems" - } - } - }, - "ListEventSourceMappingsResponse":{ - "type":"structure", - "members":{ - "NextMarker":{"shape":"String"}, - "EventSourceMappings":{"shape":"EventSourceMappingsList"} - } - }, - "ListFunctionEventInvokeConfigsRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "location":"uri", - "locationName":"FunctionName" - }, - "Marker":{ - "shape":"String", - "location":"querystring", - "locationName":"Marker" - }, - "MaxItems":{ - "shape":"MaxFunctionEventInvokeConfigListItems", - "location":"querystring", - "locationName":"MaxItems" - } - } - }, - "ListFunctionEventInvokeConfigsResponse":{ - "type":"structure", - "members":{ - "FunctionEventInvokeConfigs":{"shape":"FunctionEventInvokeConfigList"}, - "NextMarker":{"shape":"String"} - } - }, - "ListFunctionUrlConfigsRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"FunctionUrlFunctionName", - "location":"uri", - "locationName":"FunctionName" - }, - "Marker":{ - "shape":"String", - "location":"querystring", - "locationName":"Marker" - }, - "MaxItems":{ - "shape":"MaxItems", - "location":"querystring", - "locationName":"MaxItems" - } - } - }, - "ListFunctionUrlConfigsResponse":{ - "type":"structure", - "required":["FunctionUrlConfigs"], - "members":{ - "FunctionUrlConfigs":{"shape":"FunctionUrlConfigList"}, - "NextMarker":{"shape":"String"} - } - }, - "ListFunctionVersionsByCapacityProviderRequest":{ - "type":"structure", - "required":["CapacityProviderName"], - "members":{ - "CapacityProviderName":{ - "shape":"CapacityProviderName", - "location":"uri", - "locationName":"CapacityProviderName" - }, - "Marker":{ - "shape":"String", - "location":"querystring", - "locationName":"Marker" - }, - "MaxItems":{ - "shape":"MaxFiftyListItems", - "location":"querystring", - "locationName":"MaxItems" - } - } - }, - "ListFunctionVersionsByCapacityProviderResponse":{ - "type":"structure", - "required":[ - "CapacityProviderArn", - "FunctionVersions" - ], - "members":{ - "CapacityProviderArn":{"shape":"CapacityProviderArn"}, - "FunctionVersions":{"shape":"FunctionVersionsByCapacityProviderList"}, - "NextMarker":{"shape":"String"} - } - }, - "ListFunctionsByCodeSigningConfigRequest":{ - "type":"structure", - "required":["CodeSigningConfigArn"], - "members":{ - "CodeSigningConfigArn":{ - "shape":"CodeSigningConfigArn", - "location":"uri", - "locationName":"CodeSigningConfigArn" - }, - "Marker":{ - "shape":"String", - "location":"querystring", - "locationName":"Marker" - }, - "MaxItems":{ - "shape":"MaxListItems", - "location":"querystring", - "locationName":"MaxItems" - } - } - }, - "ListFunctionsByCodeSigningConfigResponse":{ - "type":"structure", - "members":{ - "NextMarker":{"shape":"String"}, - "FunctionArns":{"shape":"FunctionArnList"} - } - }, - "ListFunctionsRequest":{ - "type":"structure", - "members":{ - "MasterRegion":{ - "shape":"MasterRegion", - "location":"querystring", - "locationName":"MasterRegion" - }, - "FunctionVersion":{ - "shape":"FunctionVersion", - "location":"querystring", - "locationName":"FunctionVersion" - }, - "Marker":{ - "shape":"String", - "location":"querystring", - "locationName":"Marker" - }, - "MaxItems":{ - "shape":"MaxListItems", - "location":"querystring", - "locationName":"MaxItems" - } - } - }, - "ListFunctionsResponse":{ - "type":"structure", - "members":{ - "NextMarker":{"shape":"String"}, - "Functions":{"shape":"FunctionList"} - } - }, - "ListLayerVersionsRequest":{ - "type":"structure", - "required":["LayerName"], - "members":{ - "CompatibleArchitecture":{ - "shape":"Architecture", - "location":"querystring", - "locationName":"CompatibleArchitecture" - }, - "CompatibleRuntime":{ - "shape":"Runtime", - "location":"querystring", - "locationName":"CompatibleRuntime" - }, - "LayerName":{ - "shape":"LayerName", - "location":"uri", - "locationName":"LayerName" - }, - "Marker":{ - "shape":"String", - "location":"querystring", - "locationName":"Marker" - }, - "MaxItems":{ - "shape":"MaxLayerListItems", - "location":"querystring", - "locationName":"MaxItems" - } - } - }, - "ListLayerVersionsResponse":{ - "type":"structure", - "members":{ - "NextMarker":{"shape":"String"}, - "LayerVersions":{"shape":"LayerVersionsList"} - } - }, - "ListLayersRequest":{ - "type":"structure", - "members":{ - "CompatibleArchitecture":{ - "shape":"Architecture", - "location":"querystring", - "locationName":"CompatibleArchitecture" - }, - "CompatibleRuntime":{ - "shape":"Runtime", - "location":"querystring", - "locationName":"CompatibleRuntime" - }, - "Marker":{ - "shape":"String", - "location":"querystring", - "locationName":"Marker" - }, - "MaxItems":{ - "shape":"MaxLayerListItems", - "location":"querystring", - "locationName":"MaxItems" - } - } - }, - "ListLayersResponse":{ - "type":"structure", - "members":{ - "NextMarker":{"shape":"String"}, - "Layers":{"shape":"LayersList"} - } - }, - "ListProvisionedConcurrencyConfigsRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"FunctionName", - "location":"uri", - "locationName":"FunctionName" - }, - "Marker":{ - "shape":"String", - "location":"querystring", - "locationName":"Marker" - }, - "MaxItems":{ - "shape":"MaxProvisionedConcurrencyConfigListItems", - "location":"querystring", - "locationName":"MaxItems" - } - } - }, - "ListProvisionedConcurrencyConfigsResponse":{ - "type":"structure", - "members":{ - "ProvisionedConcurrencyConfigs":{"shape":"ProvisionedConcurrencyConfigList"}, - "NextMarker":{"shape":"String"} - } - }, - "ListTagsRequest":{ - "type":"structure", - "required":["Resource"], - "members":{ - "Resource":{ - "shape":"TaggableResource", - "location":"uri", - "locationName":"Resource" - } - } - }, - "ListTagsResponse":{ - "type":"structure", - "members":{ - "Tags":{"shape":"Tags"} - } - }, - "ListVersionsByFunctionRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "location":"uri", - "locationName":"FunctionName" - }, - "Marker":{ - "shape":"String", - "location":"querystring", - "locationName":"Marker" - }, - "MaxItems":{ - "shape":"MaxListItems", - "location":"querystring", - "locationName":"MaxItems" - } - } - }, - "ListVersionsByFunctionResponse":{ - "type":"structure", - "members":{ - "NextMarker":{"shape":"String"}, - "Versions":{"shape":"FunctionList"} - } - }, - "LocalMountPath":{ - "type":"string", - "max":160, - "min":0, - "pattern":"/mnt/[a-zA-Z0-9-_.]+" - }, - "LogFormat":{ - "type":"string", - "enum":[ - "JSON", - "Text" - ] - }, - "LogGroup":{ - "type":"string", - "max":512, - "min":1, - "pattern":"[\\.\\-_/#A-Za-z0-9]+" - }, - "LogType":{ - "type":"string", - "enum":[ - "None", - "Tail" - ] - }, - "LoggingConfig":{ - "type":"structure", - "members":{ - "LogFormat":{"shape":"LogFormat"}, - "ApplicationLogLevel":{"shape":"ApplicationLogLevel"}, - "SystemLogLevel":{"shape":"SystemLogLevel"}, - "LogGroup":{"shape":"LogGroup"} - } - }, - "Long":{"type":"long"}, - "MasterRegion":{ - "type":"string", - "max":50, - "min":1, - "pattern":"ALL|(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}" - }, - "MaxAge":{ - "type":"integer", - "box":true, - "max":86400, - "min":0 - }, - "MaxFiftyListItems":{ - "type":"integer", - "box":true, - "max":50, - "min":1 - }, - "MaxFunctionEventInvokeConfigListItems":{ - "type":"integer", - "box":true, - "max":50, - "min":1 - }, - "MaxItems":{ - "type":"integer", - "box":true, - "max":50, - "min":1 - }, - "MaxLayerListItems":{ - "type":"integer", - "box":true, - "max":50, - "min":1 - }, - "MaxListItems":{ - "type":"integer", - "box":true, - "max":10000, - "min":1 - }, - "MaxProvisionedConcurrencyConfigListItems":{ - "type":"integer", - "box":true, - "max":50, - "min":1 - }, - "MaximumBatchingWindowInSeconds":{ - "type":"integer", - "box":true, - "max":300, - "min":0 - }, - "MaximumConcurrency":{ - "type":"integer", - "box":true, - "max":1000, - "min":2 - }, - "MaximumEventAgeInSeconds":{ - "type":"integer", - "box":true, - "max":21600, - "min":60 - }, - "MaximumNumberOfPollers":{ - "type":"integer", - "box":true, - "max":10000, - "min":1 - }, - "MaximumRecordAgeInSeconds":{ - "type":"integer", - "box":true, - "max":604800, - "min":-1 - }, - "MaximumRetryAttempts":{ - "type":"integer", - "box":true, - "max":2, - "min":0 - }, - "MaximumRetryAttemptsEventSourceMapping":{ - "type":"integer", - "box":true, - "max":10000, - "min":-1 - }, - "MemorySize":{ - "type":"integer", - "box":true, - "max":32768, - "min":128 - }, - "Method":{ - "type":"string", - "max":6, - "min":0, - "pattern":".*" - }, - "MetricTargetValue":{ - "type":"double", - "box":true, - "max":100, - "min":0 - }, - "MinimumNumberOfPollers":{ - "type":"integer", - "box":true, - "max":200, - "min":1 - }, - "ModeNotSupportedException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "message":{"shape":"String"} - }, - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "NameSpacedFunctionArn":{ - "type":"string", - "max":10000, - "min":0, - "pattern":"arn:(aws[a-zA-Z-]*)?:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_\\.]+(:(\\$LATEST(\\.PUBLISHED)?|[a-zA-Z0-9-_]+))?" - }, - "NamespacedFunctionName":{ - "type":"string", - "max":256, - "min":1, - "pattern":"(arn:(aws[a-zA-Z-]*)?:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:|(((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:)?(\\d{12}:)?))(function:)?([a-zA-Z0-9-_\\.]+)(:(\\$LATEST(\\.PUBLISHED)?|[a-zA-Z0-9-_]+))?" - }, - "NamespacedStatementId":{ - "type":"string", - "max":100, - "min":1, - "pattern":"([a-zA-Z0-9-_.]+)" - }, - "NoPublishedVersionException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "NonNegativeInteger":{ - "type":"integer", - "box":true, - "min":0 - }, - "NullableBoolean":{ - "type":"boolean", - "box":true - }, - "NumericLatestPublishedOrAliasQualifier":{ - "type":"string", - "max":128, - "min":1, - "pattern":"\\$(LATEST(\\.PUBLISHED)?)|[a-zA-Z0-9-_$]+" - }, - "OnFailure":{ - "type":"structure", - "members":{ - "Destination":{"shape":"DestinationArn"} - } - }, - "OnSuccess":{ - "type":"structure", - "members":{ - "Destination":{"shape":"DestinationArn"} - } - }, - "Operation":{ - "type":"structure", - "required":[ - "Id", - "Type", - "StartTimestamp", - "Status" - ], - "members":{ - "Id":{"shape":"OperationId"}, - "ParentId":{"shape":"OperationId"}, - "Name":{"shape":"OperationName"}, - "Type":{"shape":"OperationType"}, - "SubType":{"shape":"OperationSubType"}, - "StartTimestamp":{"shape":"ExecutionTimestamp"}, - "EndTimestamp":{"shape":"ExecutionTimestamp"}, - "Status":{"shape":"OperationStatus"}, - "ExecutionDetails":{"shape":"ExecutionDetails"}, - "ContextDetails":{"shape":"ContextDetails"}, - "StepDetails":{"shape":"StepDetails"}, - "WaitDetails":{"shape":"WaitDetails"}, - "CallbackDetails":{"shape":"CallbackDetails"}, - "ChainedInvokeDetails":{"shape":"ChainedInvokeDetails"} - } - }, - "OperationAction":{ - "type":"string", - "enum":[ - "START", - "SUCCEED", - "FAIL", - "RETRY", - "CANCEL" - ] - }, - "OperationId":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[a-zA-Z0-9-_]+" - }, - "OperationName":{ - "type":"string", - "max":256, - "min":1, - "pattern":"[\\x20-\\x7E]+" - }, - "OperationPayload":{ - "type":"string", - "max":6291456, - "min":0, - "sensitive":true - }, - "OperationStatus":{ - "type":"string", - "enum":[ - "STARTED", - "PENDING", - "READY", - "SUCCEEDED", - "FAILED", - "CANCELLED", - "TIMED_OUT", - "STOPPED" - ] - }, - "OperationSubType":{ - "type":"string", - "max":32, - "min":1, - "pattern":"[a-zA-Z0-9-_]+" - }, - "OperationType":{ - "type":"string", - "enum":[ - "EXECUTION", - "CONTEXT", - "STEP", - "WAIT", - "CALLBACK", - "CHAINED_INVOKE" - ] - }, - "OperationUpdate":{ - "type":"structure", - "required":[ - "Id", - "Type", - "Action" - ], - "members":{ - "Id":{"shape":"OperationId"}, - "ParentId":{"shape":"OperationId"}, - "Name":{"shape":"OperationName"}, - "Type":{"shape":"OperationType"}, - "SubType":{"shape":"OperationSubType"}, - "Action":{"shape":"OperationAction"}, - "Payload":{"shape":"OperationPayload"}, - "Error":{"shape":"ErrorObject"}, - "ContextOptions":{"shape":"ContextOptions"}, - "StepOptions":{"shape":"StepOptions"}, - "WaitOptions":{"shape":"WaitOptions"}, - "CallbackOptions":{"shape":"CallbackOptions"}, - "ChainedInvokeOptions":{"shape":"ChainedInvokeOptions"} - } - }, - "OperationUpdates":{ - "type":"list", - "member":{"shape":"OperationUpdate"} - }, - "Operations":{ - "type":"list", - "member":{"shape":"Operation"} - }, - "OrganizationId":{ - "type":"string", - "max":34, - "min":0, - "pattern":"o-[a-z0-9]{10,32}" - }, - "Origin":{ - "type":"string", - "max":253, - "min":1, - "pattern":".*" - }, - "OutputPayload":{ - "type":"string", - "max":6291456, - "min":0, - "sensitive":true - }, - "PackageType":{ - "type":"string", - "enum":[ - "Zip", - "Image" - ] - }, - "ParallelizationFactor":{ - "type":"integer", - "box":true, - "max":10, - "min":1 - }, - "Pattern":{ - "type":"string", - "max":4096, - "min":0, - "pattern":"[\\s\\S]*" - }, - "PerExecutionEnvironmentMaxConcurrency":{ - "type":"integer", - "box":true, - "max":1600, - "min":1 - }, - "PolicyLengthExceededException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "message":{"shape":"String"} - }, - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "PositiveInteger":{ - "type":"integer", - "box":true, - "min":1 - }, - "PreconditionFailedException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "message":{"shape":"String"} - }, - "error":{ - "httpStatusCode":412, - "senderFault":true - }, - "exception":true - }, - "Principal":{ - "type":"string", - "max":2048, - "min":0, - "pattern":"[^\\s]+" - }, - "PrincipalOrgID":{ - "type":"string", - "max":34, - "min":12, - "pattern":"o-[a-z0-9]{10,32}" - }, - "PropagateTags":{ - "type":"structure", - "members":{ - "Mode":{"shape":"PropagateTagsMode"}, - "ExplicitTags":{"shape":"PropagateTagsExplicitTagsMap"} - } - }, - "PropagateTagsExplicitTagsMap":{ - "type":"map", - "key":{"shape":"TagKey"}, - "value":{"shape":"TagValue"}, - "max":40, - "min":0 - }, - "PropagateTagsMode":{ - "type":"string", - "enum":[ - "None", - "Explicit" - ] - }, - "ProvisionedConcurrencyConfigList":{ - "type":"list", - "member":{"shape":"ProvisionedConcurrencyConfigListItem"} - }, - "ProvisionedConcurrencyConfigListItem":{ - "type":"structure", - "members":{ - "FunctionArn":{"shape":"FunctionArn"}, - "RequestedProvisionedConcurrentExecutions":{"shape":"PositiveInteger"}, - "AvailableProvisionedConcurrentExecutions":{"shape":"NonNegativeInteger"}, - "AllocatedProvisionedConcurrentExecutions":{"shape":"NonNegativeInteger"}, - "Status":{"shape":"ProvisionedConcurrencyStatusEnum"}, - "StatusReason":{"shape":"String"}, - "LastModified":{"shape":"Timestamp"} - } - }, - "ProvisionedConcurrencyConfigNotFoundException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "message":{"shape":"String"} - }, - "error":{ - "httpStatusCode":404, - "senderFault":true - }, - "exception":true - }, - "ProvisionedConcurrencyStatusEnum":{ - "type":"string", - "enum":[ - "IN_PROGRESS", - "READY", - "FAILED" - ] - }, - "ProvisionedPollerConfig":{ - "type":"structure", - "members":{ - "MinimumPollers":{"shape":"MinimumNumberOfPollers"}, - "MaximumPollers":{"shape":"MaximumNumberOfPollers"}, - "PollerGroupName":{"shape":"ProvisionedPollerGroupName"} - } - }, - "ProvisionedPollerGroupName":{ - "type":"string", - "max":128, - "min":0, - "pattern":"[a-zA-Z0-9-_]*" - }, - "PublicPolicyException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "PublishLayerVersionRequest":{ - "type":"structure", - "required":[ - "LayerName", - "Content" - ], - "members":{ - "LayerName":{ - "shape":"LayerName", - "location":"uri", - "locationName":"LayerName" - }, - "Description":{"shape":"Description"}, - "Content":{"shape":"LayerVersionContentInput"}, - "CompatibleArchitectures":{"shape":"CompatibleArchitectures"}, - "CompatibleRuntimes":{"shape":"CompatibleRuntimes"}, - "LicenseInfo":{"shape":"LicenseInfo"} - } - }, - "PublishLayerVersionResponse":{ - "type":"structure", - "members":{ - "Content":{"shape":"LayerVersionContentOutput"}, - "LayerArn":{"shape":"LayerArn"}, - "LayerVersionArn":{"shape":"LayerVersionArn"}, - "Description":{"shape":"Description"}, - "CreatedDate":{"shape":"Timestamp"}, - "Version":{"shape":"LayerVersionNumber"}, - "CompatibleArchitectures":{"shape":"CompatibleArchitectures"}, - "CompatibleRuntimes":{"shape":"CompatibleRuntimes"}, - "LicenseInfo":{"shape":"LicenseInfo"} - } - }, - "PublishVersionRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"FunctionName", - "location":"uri", - "locationName":"FunctionName" - }, - "CodeSha256":{"shape":"String"}, - "Description":{"shape":"Description"}, - "RevisionId":{"shape":"String"}, - "PublishTo":{"shape":"FunctionVersionLatestPublished"} - } - }, - "PublishedFunctionQualifier":{ - "type":"string", - "max":128, - "min":1, - "pattern":"(\\$LATEST\\.PUBLISHED|[0-9]+)" - }, - "PutFunctionCodeSigningConfigRequest":{ - "type":"structure", - "required":[ - "CodeSigningConfigArn", - "FunctionName" - ], - "members":{ - "CodeSigningConfigArn":{"shape":"CodeSigningConfigArn"}, - "FunctionName":{ - "shape":"NamespacedFunctionName", - "location":"uri", - "locationName":"FunctionName" - } - } - }, - "PutFunctionCodeSigningConfigResponse":{ - "type":"structure", - "required":[ - "CodeSigningConfigArn", - "FunctionName" - ], - "members":{ - "CodeSigningConfigArn":{"shape":"CodeSigningConfigArn"}, - "FunctionName":{"shape":"FunctionName"} - } - }, - "PutFunctionConcurrencyRequest":{ - "type":"structure", - "required":[ - "FunctionName", - "ReservedConcurrentExecutions" - ], - "members":{ - "FunctionName":{ - "shape":"FunctionName", - "location":"uri", - "locationName":"FunctionName" - }, - "ReservedConcurrentExecutions":{"shape":"ReservedConcurrentExecutions"} - } - }, - "PutFunctionEventInvokeConfigRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "location":"uri", - "locationName":"FunctionName" - }, - "Qualifier":{ - "shape":"NumericLatestPublishedOrAliasQualifier", - "location":"querystring", - "locationName":"Qualifier" - }, - "MaximumRetryAttempts":{"shape":"MaximumRetryAttempts"}, - "MaximumEventAgeInSeconds":{"shape":"MaximumEventAgeInSeconds"}, - "DestinationConfig":{"shape":"DestinationConfig"} - } - }, - "PutFunctionRecursionConfigRequest":{ - "type":"structure", - "required":[ - "FunctionName", - "RecursiveLoop" - ], - "members":{ - "FunctionName":{ - "shape":"UnqualifiedFunctionName", - "location":"uri", - "locationName":"FunctionName" - }, - "RecursiveLoop":{"shape":"RecursiveLoop"} - } - }, - "PutFunctionRecursionConfigResponse":{ - "type":"structure", - "members":{ - "RecursiveLoop":{"shape":"RecursiveLoop"} - } - }, - "PutFunctionScalingConfigRequest":{ - "type":"structure", - "required":[ - "FunctionName", - "Qualifier" - ], - "members":{ - "FunctionName":{ - "shape":"UnqualifiedFunctionName", - "location":"uri", - "locationName":"FunctionName" - }, - "Qualifier":{ - "shape":"PublishedFunctionQualifier", - "location":"querystring", - "locationName":"Qualifier" - }, - "FunctionScalingConfig":{"shape":"FunctionScalingConfig"} - } - }, - "PutFunctionScalingConfigResponse":{ - "type":"structure", - "members":{ - "FunctionState":{"shape":"State"} - } - }, - "PutProvisionedConcurrencyConfigRequest":{ - "type":"structure", - "required":[ - "FunctionName", - "Qualifier", - "ProvisionedConcurrentExecutions" - ], - "members":{ - "FunctionName":{ - "shape":"FunctionName", - "location":"uri", - "locationName":"FunctionName" - }, - "Qualifier":{ - "shape":"Qualifier", - "location":"querystring", - "locationName":"Qualifier" - }, - "ProvisionedConcurrentExecutions":{"shape":"PositiveInteger"} - } - }, - "PutProvisionedConcurrencyConfigResponse":{ - "type":"structure", - "members":{ - "RequestedProvisionedConcurrentExecutions":{"shape":"PositiveInteger"}, - "AllocatedProvisionedConcurrentExecutions":{"shape":"NonNegativeInteger"}, - "AvailableProvisionedConcurrentExecutions":{"shape":"NonNegativeInteger"}, - "Status":{"shape":"ProvisionedConcurrencyStatusEnum"}, - "StatusReason":{"shape":"String"}, - "LastModified":{"shape":"Timestamp"} - } - }, - "PutRuntimeManagementConfigRequest":{ - "type":"structure", - "required":[ - "FunctionName", - "UpdateRuntimeOn" - ], - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "location":"uri", - "locationName":"FunctionName" - }, - "Qualifier":{ - "shape":"NumericLatestPublishedOrAliasQualifier", - "location":"querystring", - "locationName":"Qualifier" - }, - "UpdateRuntimeOn":{"shape":"UpdateRuntimeOn"}, - "RuntimeVersionArn":{"shape":"RuntimeVersionArn"} - } - }, - "PutRuntimeManagementConfigResponse":{ - "type":"structure", - "required":[ - "UpdateRuntimeOn", - "FunctionArn" - ], - "members":{ - "UpdateRuntimeOn":{"shape":"UpdateRuntimeOn"}, - "FunctionArn":{"shape":"FunctionArn"}, - "RuntimeVersionArn":{"shape":"RuntimeVersionArn"} - } - }, - "Qualifier":{ - "type":"string", - "max":128, - "min":1, - "pattern":"(|[a-zA-Z0-9$_-]+)" - }, - "Queue":{ - "type":"string", - "max":1000, - "min":1, - "pattern":"[\\s\\S]*" - }, - "Queues":{ - "type":"list", - "member":{"shape":"Queue"}, - "max":1, - "min":1 - }, - "RecursiveInvocationException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "RecursiveLoop":{ - "type":"string", - "enum":[ - "Allow", - "Terminate" - ] - }, - "RemoveLayerVersionPermissionRequest":{ - "type":"structure", - "required":[ - "LayerName", - "VersionNumber", - "StatementId" - ], - "members":{ - "LayerName":{ - "shape":"LayerName", - "location":"uri", - "locationName":"LayerName" - }, - "VersionNumber":{ - "shape":"LayerVersionNumber", - "location":"uri", - "locationName":"VersionNumber" - }, - "StatementId":{ - "shape":"StatementId", - "location":"uri", - "locationName":"StatementId" - }, - "RevisionId":{ - "shape":"String", - "location":"querystring", - "locationName":"RevisionId" - } - } - }, - "RemovePermissionRequest":{ - "type":"structure", - "required":[ - "FunctionName", - "StatementId" - ], - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "location":"uri", - "locationName":"FunctionName" - }, - "StatementId":{ - "shape":"NamespacedStatementId", - "location":"uri", - "locationName":"StatementId" - }, - "Qualifier":{ - "shape":"NumericLatestPublishedOrAliasQualifier", - "location":"querystring", - "locationName":"Qualifier" - }, - "RevisionId":{ - "shape":"String", - "location":"querystring", - "locationName":"RevisionId" - } - } - }, - "ReplayChildren":{ - "type":"boolean", - "box":true - }, - "RequestTooLargeException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "message":{"shape":"String"} - }, - "error":{ - "httpStatusCode":413, - "senderFault":true - }, - "exception":true - }, - "ReservedConcurrentExecutions":{ - "type":"integer", - "box":true, - "min":0 - }, - "ResolvedS3Object":{ - "type":"structure", - "members":{ - "S3Bucket":{"shape":"S3Bucket"}, - "S3Key":{"shape":"S3Key"}, - "S3ObjectVersion":{"shape":"S3ObjectVersion"} - } - }, - "ResourceArn":{ - "type":"string", - "max":10000, - "min":0, - "pattern":"(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()" - }, - "ResourceConflictException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "message":{"shape":"String"} - }, - "error":{ - "httpStatusCode":409, - "senderFault":true - }, - "exception":true - }, - "ResourceInUseException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "ResourceNotFoundException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "error":{ - "httpStatusCode":404, - "senderFault":true - }, - "exception":true - }, - "ResourceNotReadyException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "message":{"shape":"String"} - }, - "error":{"httpStatusCode":502}, - "exception":true, - "fault":true - }, - "ResponseStreamingInvocationType":{ - "type":"string", - "enum":[ - "RequestResponse", - "DryRun" - ] - }, - "RetentionPeriodInDays":{ - "type":"integer", - "box":true, - "max":90, - "min":1 - }, - "RetryDetails":{ - "type":"structure", - "members":{ - "CurrentAttempt":{"shape":"AttemptCount"}, - "NextAttemptDelaySeconds":{"shape":"DurationSeconds"} - } - }, - "ReverseOrder":{ - "type":"boolean", - "box":true - }, - "RoleArn":{ - "type":"string", - "max":10000, - "min":0, - "pattern":"arn:(aws[a-zA-Z-]*)?:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+" - }, - "Runtime":{ - "type":"string", - "enum":[ - "nodejs", - "nodejs4.3", - "nodejs6.10", - "nodejs8.10", - "nodejs10.x", - "nodejs12.x", - "nodejs14.x", - "nodejs16.x", - "nodejs18.x", - "nodejs20.x", - "nodejs22.x", - "nodejs24.x", - "java8", - "java8.al2", - "java11", - "java17", - "java21", - "java25", - "python2.7", - "python3.6", - "python3.7", - "python3.8", - "python3.9", - "python3.10", - "python3.11", - "python3.12", - "python3.13", - "python3.14", - "dotnetcore1.0", - "dotnetcore2.0", - "dotnetcore2.1", - "dotnetcore3.1", - "dotnet6", - "dotnet8", - "dotnet10", - "nodejs4.3-edge", - "go1.x", - "ruby2.5", - "ruby2.7", - "ruby3.2", - "ruby3.3", - "ruby3.4", - "ruby4.0", - "provided", - "provided.al2", - "provided.al2023", - "nodejs26.x", - "python3.15", - "java8.al2023", - "java11.al2023", - "java17.al2023" - ] - }, - "RuntimeVersionArn":{ - "type":"string", - "max":2048, - "min":26, - "pattern":"arn:(aws[a-zA-Z-]*):lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}::runtime:.+" - }, - "RuntimeVersionConfig":{ - "type":"structure", - "members":{ - "RuntimeVersionArn":{"shape":"RuntimeVersionArn"}, - "Error":{"shape":"RuntimeVersionError"} - } - }, - "RuntimeVersionError":{ - "type":"structure", - "members":{ - "ErrorCode":{"shape":"String"}, - "Message":{"shape":"SensitiveString"} - } - }, - "S3Bucket":{ - "type":"string", - "max":63, - "min":3, - "pattern":"[0-9A-Za-z\\.\\-_]*(?Lambda

Overview

Lambda is a compute service that lets you run code without provisioning or managing servers. Lambda runs your code on a high-availability compute infrastructure and performs all of the administration of the compute resources, including server and operating system maintenance, capacity provisioning and automatic scaling, code monitoring and logging. With Lambda, you can run code for virtually any type of application or backend service. For more information about the Lambda service, see What is Lambda in the Lambda Developer Guide.

The Lambda API Reference provides information about each of the API methods, including details about the parameters in each API request and response.

You can use Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command line tools to access the API. For installation instructions, see Tools for Amazon Web Services.

For a list of Region-specific endpoints that Lambda supports, see Lambda endpoints and quotas in the Amazon Web Services General Reference..

When making the API calls, you will need to authenticate your request by providing a signature. Lambda supports signature version 4. For more information, see Signature Version 4 signing process in the Amazon Web Services General Reference..

CA certificates

Because Amazon Web Services SDKs use the CA certificates from your computer, changes to the certificates on the Amazon Web Services servers can cause connection failures when you attempt to use an SDK. You can prevent these failures by keeping your computer's CA certificates and operating system up-to-date. If you encounter this issue in a corporate environment and do not manage your own computer, you might need to ask an administrator to assist with the update process. The following list shows minimum operating system and Java versions:

  • Microsoft Windows versions that have updates from January 2005 or later installed contain at least one of the required CAs in their trust list.

  • Mac OS X 10.4 with Java for Mac OS X 10.4 Release 5 (February 2007), Mac OS X 10.5 (October 2007), and later versions contain at least one of the required CAs in their trust list.

  • Red Hat Enterprise Linux 5 (March 2007), 6, and 7 and CentOS 5, 6, and 7 all contain at least one of the required CAs in their default trusted CA list.

  • Java 1.4.2_12 (May 2006), 5 Update 2 (March 2005), and all later versions, including Java 6 (December 2006), 7, and 8, contain at least one of the required CAs in their default trusted CA list.

When accessing the Lambda management console or Lambda API endpoints, whether through browsers or programmatically, you will need to ensure your client machines support any of the following CAs:

  • Amazon Root CA 1

  • Starfield Services Root Certificate Authority - G2

  • Starfield Class 2 Certification Authority

Root certificates from the first two authorities are available from Amazon trust services, but keeping your computer up-to-date is the more straightforward solution. To learn more about ACM-provided certificates, see Amazon Web Services Certificate Manager FAQs.

", - "operations": { - "AddLayerVersionPermission": "

Adds permissions to the resource-based policy of a version of an Lambda layer. Use this action to grant layer usage permission to other accounts. You can grant permission to a single account, all accounts in an organization, or all Amazon Web Services accounts.

To revoke permission, call RemoveLayerVersionPermission with the statement ID that you specified when you added it.

", - "AddPermission": "

Grants a principal permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function. Note: Lambda does not support adding policies to version $LATEST.

To grant permission to another account, specify the account ID as the Principal. To grant permission to an organization defined in Organizations, specify the organization ID as the PrincipalOrgID. For Amazon Web Services services, the principal is a domain-style identifier that the service defines, such as s3.amazonaws.com or sns.amazonaws.com. For Amazon Web Services services, you can also specify the ARN of the associated resource as the SourceArn. If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function.

This operation adds a statement to a resource-based permissions policy for the function. For more information about function policies, see Using resource-based policies for Lambda.

", - "CheckpointDurableExecution": "

Saves the progress of a durable function execution during runtime. This API is used by the Lambda durable functions SDK to checkpoint completed steps and schedule asynchronous operations. You typically don't need to call this API directly as the SDK handles checkpointing automatically.

Each checkpoint operation consumes the current checkpoint token and returns a new one for the next checkpoint. This ensures that checkpoints are applied in the correct order and prevents duplicate or out-of-order state updates.

", - "CreateAlias": "

Creates an alias for a Lambda function version. Use aliases to provide clients with a function identifier that you can update to invoke a different version.

You can also map an alias to split invocation requests between two versions. Use the RoutingConfig parameter to specify a second version and the percentage of invocation requests that it receives.

", - "CreateCapacityProvider": "

Creates a capacity provider that manages compute resources for Lambda functions

", - "CreateCodeSigningConfig": "

Creates a code signing configuration. A code signing configuration defines a list of allowed signing profiles and defines the code-signing validation policy (action to be taken if deployment validation checks fail).

", - "CreateEventSourceMapping": "

Creates a mapping between an event source and an Lambda function. Lambda reads items from the event source and invokes the function.

For details about how to configure different event sources, see the following topics.

The following error handling options are available for stream sources (DynamoDB, Kinesis, Amazon MSK, and self-managed Apache Kafka):

  • BisectBatchOnFunctionError – If the function returns an error, split the batch in two and retry.

  • MaximumRecordAgeInSeconds – Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires

  • MaximumRetryAttempts – Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.

  • OnFailure – Send discarded records to an Amazon SQS queue, Amazon SNS topic, Kafka topic, or Amazon S3 bucket. For more information, see Adding a destination.

The following option is available only for DynamoDB and Kinesis event sources:

  • ParallelizationFactor – Process multiple batches from each shard concurrently.

For information about which configuration parameters apply to each event source, see the following topics.

", - "CreateFunction": "

Creates a Lambda function. To create a function, you need a deployment package and an execution role. The deployment package is a .zip file archive or container image that contains your function code. The execution role grants the function permission to use Amazon Web Services services, such as Amazon CloudWatch Logs for log streaming and X-Ray for request tracing.

If the deployment package is a container image, then you set the package type to Image. For a container image, the code property must include the URI of a container image in the Amazon ECR registry. You do not need to specify the handler and runtime properties.

If the deployment package is a .zip file archive, then you set the package type to Zip. For a .zip file archive, the code property specifies the location of the .zip file. You must also specify the handler and runtime properties. The code in the deployment package must be compatible with the target instruction set architecture of the function (x86-64 or arm64). If you do not specify the architecture, then the default value is x86-64.

When you create a function, Lambda provisions an instance of the function and its supporting resources. If your function connects to a VPC, this process can take a minute or so. During this time, you can't invoke or modify the function. The State, StateReason, and StateReasonCode fields in the response from GetFunctionConfiguration indicate when the function is ready to invoke. For more information, see Lambda function states.

A function has an unpublished version, and can have published versions and aliases. The unpublished version changes when you update your function's code and configuration. A published version is a snapshot of your function code and configuration that can't be changed. An alias is a named resource that maps to a version, and can be changed to map to a different version. Use the Publish parameter to create version 1 of your function from its initial configuration.

The other parameters let you configure version-specific and function-level settings. You can modify version-specific settings later with UpdateFunctionConfiguration. Function-level settings apply to both the unpublished and published versions of the function, and include tags (TagResource) and per-function concurrency limits (PutFunctionConcurrency).

You can use code signing if your deployment package is a .zip file archive. To enable code signing for this function, specify the ARN of a code-signing configuration. When a user attempts to deploy a code package with UpdateFunctionCode, Lambda checks that the code package has a valid signature from a trusted publisher. The code-signing configuration includes set of signing profiles, which define the trusted publishers for this function.

If another Amazon Web Services account or an Amazon Web Services service invokes your function, use AddPermission to grant permission by creating a resource-based Identity and Access Management (IAM) policy. You can grant permissions at the function level, on a version, or on an alias.

To invoke your function directly, use Invoke. To invoke your function in response to events in other Amazon Web Services services, create an event source mapping (CreateEventSourceMapping), or configure a function trigger in the other service. For more information, see Invoking Lambda functions.

", - "CreateFunctionUrlConfig": "

Creates a Lambda function URL with the specified configuration parameters. A function URL is a dedicated HTTP(S) endpoint that you can use to invoke your function.

", - "DeleteAlias": "

Deletes a Lambda function alias.

", - "DeleteCapacityProvider": "

Deletes a capacity provider. You cannot delete a capacity provider that is currently being used by Lambda functions.

", - "DeleteCodeSigningConfig": "

Deletes the code signing configuration. You can delete the code signing configuration only if no function is using it.

", - "DeleteEventSourceMapping": "

Deletes an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.

When you delete an event source mapping, it enters a Deleting state and might not be completely deleted for several seconds.

", - "DeleteFunction": "

Deletes a Lambda function. To delete a specific function version, use the Qualifier parameter. Otherwise, all versions and aliases are deleted. This doesn't require the user to have explicit permissions for DeleteAlias.

A deleted Lambda function cannot be recovered. Ensure that you specify the correct function name and version before deleting.

To delete Lambda event source mappings that invoke a function, use DeleteEventSourceMapping. For Amazon Web Services services and resources that invoke your function directly, delete the trigger in the service where you originally configured it.

", - "DeleteFunctionCodeSigningConfig": "

Removes the code signing configuration from the function.

", - "DeleteFunctionConcurrency": "

Removes a concurrent execution limit from a function.

", - "DeleteFunctionEventInvokeConfig": "

Deletes the configuration for asynchronous invocation for a function, version, or alias.

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

", - "DeleteFunctionUrlConfig": "

Deletes a Lambda function URL. When you delete a function URL, you can't recover it. Creating a new function URL results in a different URL address.

", - "DeleteLayerVersion": "

Deletes a version of an Lambda layer. Deleted versions can no longer be viewed or added to functions. To avoid breaking functions, a copy of the version remains in Lambda until no functions refer to it.

", - "DeleteProvisionedConcurrencyConfig": "

Deletes the provisioned concurrency configuration for a function.

", - "GetAccountSettings": "

Retrieves details about your account's limits and usage in an Amazon Web Services Region.

", - "GetAlias": "

Returns details about a Lambda function alias.

", - "GetCapacityProvider": "

Retrieves information about a specific capacity provider, including its configuration, state, and associated resources.

", - "GetCodeSigningConfig": "

Returns information about the specified code signing configuration.

", - "GetDurableExecution": "

Retrieves detailed information about a specific durable execution, including its current status, input payload, result or error information, and execution metadata such as start time and usage statistics.

", - "GetDurableExecutionHistory": "

Retrieves the execution history for a durable execution, showing all the steps, callbacks, and events that occurred during the execution. This provides a detailed audit trail of the execution's progress over time.

The history is available while the execution is running and for a retention period after it completes (1-90 days, default 30 days). You can control whether to include execution data such as step results and callback payloads.

", - "GetDurableExecutionState": "

Retrieves the current execution state required for the replay process during durable function execution. This API is used by the Lambda durable functions SDK to get state information needed for replay. You typically don't need to call this API directly as the SDK handles state management automatically.

The response contains operations ordered by start sequence number in ascending order. Completed operations with children don't include child operation details since they don't need to be replayed.

", - "GetEventSourceMapping": "

Returns details about an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.

", - "GetFunction": "

Returns information about the function or function version, with a link to download the deployment package that's valid for 10 minutes. If you specify a function version, only details that are specific to that version are returned.

", - "GetFunctionCodeSigningConfig": "

Returns the code signing configuration for the specified function.

", - "GetFunctionConcurrency": "

Returns details about the reserved concurrency configuration for a function. To set a concurrency limit for a function, use PutFunctionConcurrency.

", - "GetFunctionConfiguration": "

Returns the version-specific settings of a Lambda function or version. The output includes only options that can vary between versions of a function. To modify these settings, use UpdateFunctionConfiguration.

To get all of a function's details, including function-level settings, use GetFunction.

", - "GetFunctionEventInvokeConfig": "

Retrieves the configuration for asynchronous invocation for a function, version, or alias.

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

", - "GetFunctionRecursionConfig": "

Returns your function's recursive loop detection configuration.

", - "GetFunctionScalingConfig": "

Retrieves the scaling configuration for a Lambda Managed Instances function.

", - "GetFunctionUrlConfig": "

Returns details about a Lambda function URL.

", - "GetLayerVersion": "

Returns information about a version of an Lambda layer, with a link to download the layer archive that's valid for 10 minutes.

", - "GetLayerVersionByArn": "

Returns information about a version of an Lambda layer, with a link to download the layer archive that's valid for 10 minutes.

", - "GetLayerVersionPolicy": "

Returns the permission policy for a version of an Lambda layer. For more information, see AddLayerVersionPermission.

", - "GetPolicy": "

Returns the resource-based IAM policy for a function, version, or alias.

", - "GetProvisionedConcurrencyConfig": "

Retrieves the provisioned concurrency configuration for a function's alias or version.

", - "GetRuntimeManagementConfig": "

Retrieves the runtime management configuration for a function's version. If the runtime update mode is Manual, this includes the ARN of the runtime version and the runtime update mode. If the runtime update mode is Auto or Function update, this includes the runtime update mode and null is returned for the ARN. For more information, see Runtime updates.

", - "Invoke": "

Invokes a Lambda function. You can invoke a function synchronously (and wait for the response), or asynchronously. By default, Lambda invokes your function synchronously (i.e. theInvocationType is RequestResponse). To invoke a function asynchronously, set InvocationType to Event. Lambda passes the ClientContext object to your function for synchronous invocations only.

For synchronous invocations, the maximum payload size is 6 MB. For asynchronous invocations, the maximum payload size is 1 MB.

For synchronous invocation, details about the function response, including errors, are included in the response body and headers. For either invocation type, you can find more information in the execution log and trace.

When an error occurs, your function may be invoked multiple times. Retry behavior varies by error type, client, event source, and invocation type. For example, if you invoke a function asynchronously and it returns an error, Lambda executes the function up to two more times. For more information, see Error handling and automatic retries in Lambda.

For asynchronous invocation, Lambda adds events to a queue before sending them to your function. If your function does not have enough capacity to keep up with the queue, events may be lost. Occasionally, your function may receive the same event multiple times, even if no error occurs. To retain events that were not processed, configure your function with a dead-letter queue.

The status code in the API response doesn't reflect function errors. Error codes are reserved for errors that prevent your function from executing, such as permissions errors, quota errors, or issues with your function's code and configuration. For example, Lambda returns TooManyRequestsException if running the function would cause you to exceed a concurrency limit at either the account level (ConcurrentInvocationLimitExceeded) or function level (ReservedFunctionConcurrentInvocationLimitExceeded).

For functions with a long timeout, your client might disconnect during synchronous invocation while it waits for a response. Configure your HTTP client, SDK, firewall, proxy, or operating system to allow for long connections with timeout or keep-alive settings.

This operation requires permission for the lambda:InvokeFunction action. For details on how to set up permissions for cross-account invocations, see Granting function access to other accounts.

", - "InvokeAsync": "

For asynchronous function invocation, use Invoke.

Invokes a function asynchronously.

The payload limit is 256KB. For larger payloads, for up to 1MB, use Invoke.

If you do use the InvokeAsync action, note that it doesn't support the use of X-Ray active tracing. Trace ID is not propagated to the function, even if X-Ray active tracing is turned on.

", - "InvokeWithResponseStream": "

Configure your Lambda functions to stream response payloads back to clients. For more information, see Configuring a Lambda function to stream responses.

This operation requires permission for the lambda:InvokeFunction action. For details on how to set up permissions for cross-account invocations, see Granting function access to other accounts.

", - "ListAliases": "

Returns a list of aliases for a Lambda function.

", - "ListCapacityProviders": "

Returns a list of capacity providers in your account.

", - "ListCodeSigningConfigs": "

Returns a list of code signing configurations. A request returns up to 10,000 configurations per call. You can use the MaxItems parameter to return fewer configurations per call.

", - "ListDurableExecutionsByFunction": "

Returns a list of durable executions for a specified Lambda function. You can filter the results by execution name, status, and start time range. This API supports pagination for large result sets.

", - "ListEventSourceMappings": "

Lists event source mappings. Specify an EventSourceArn to show only event source mappings for a single event source.

", - "ListFunctionEventInvokeConfigs": "

Retrieves a list of configurations for asynchronous invocation for a function.

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

", - "ListFunctionUrlConfigs": "

Returns a list of Lambda function URLs for the specified function.

", - "ListFunctionVersionsByCapacityProvider": "

Returns a list of function versions that are configured to use a specific capacity provider.

", - "ListFunctions": "

Returns a list of Lambda functions, with the version-specific configuration of each. Lambda returns up to 50 functions per call.

Set FunctionVersion to ALL to include all published versions of each function in addition to the unpublished version.

The ListFunctions operation returns a subset of the FunctionConfiguration fields. To get the additional fields (State, StateReasonCode, StateReason, LastUpdateStatus, LastUpdateStatusReason, LastUpdateStatusReasonCode, RuntimeVersionConfig) for a function or version, use GetFunction.

", - "ListFunctionsByCodeSigningConfig": "

List the functions that use the specified code signing configuration. You can use this method prior to deleting a code signing configuration, to verify that no functions are using it.

", - "ListLayerVersions": "

Lists the versions of an Lambda layer. Versions that have been deleted aren't listed. Specify a runtime identifier to list only versions that indicate that they're compatible with that runtime. Specify a compatible architecture to include only layer versions that are compatible with that architecture.

", - "ListLayers": "

Lists Lambda layers and shows information about the latest version of each. Specify a runtime identifier to list only layers that indicate that they're compatible with that runtime. Specify a compatible architecture to include only layers that are compatible with that instruction set architecture.

", - "ListProvisionedConcurrencyConfigs": "

Retrieves a list of provisioned concurrency configurations for a function.

", - "ListTags": "

Returns a function, event source mapping, or code signing configuration's tags. You can also view function tags with GetFunction.

", - "ListVersionsByFunction": "

Returns a list of versions, with the version-specific configuration of each. Lambda returns up to 50 versions per call.

", - "PublishLayerVersion": "

Creates an Lambda layer from a ZIP archive. Each time you call PublishLayerVersion with the same layer name, a new version is created.

Add layers to your function with CreateFunction or UpdateFunctionConfiguration.

", - "PublishVersion": "

Creates a version from the current code and configuration of a function. Use versions to create a snapshot of your function code and configuration that doesn't change.

Lambda doesn't publish a version if the function's configuration and code haven't changed since the last version. Use UpdateFunctionCode or UpdateFunctionConfiguration to update the function before publishing a version.

Clients can invoke versions directly or with an alias. To create an alias, use CreateAlias.

", - "PutFunctionCodeSigningConfig": "

Update the code signing configuration for the function. Changes to the code signing configuration take effect the next time a user tries to deploy a code package to the function.

", - "PutFunctionConcurrency": "

Sets the maximum number of simultaneous executions for a function, and reserves capacity for that concurrency level.

Concurrency settings apply to the function as a whole, including all published versions and the unpublished version. Reserving concurrency both ensures that your function has capacity to process the specified number of events simultaneously, and prevents it from scaling beyond that level. Use GetFunction to see the current setting for a function.

Use GetAccountSettings to see your Regional concurrency limit. You can reserve concurrency for as many functions as you like, as long as you leave at least 100 simultaneous executions unreserved for functions that aren't configured with a per-function limit. For more information, see Lambda function scaling.

", - "PutFunctionEventInvokeConfig": "

Configures options for asynchronous invocation on a function, version, or alias. If a configuration already exists for a function, version, or alias, this operation overwrites it. If you exclude any settings, they are removed. To set one option without affecting existing settings for other options, use UpdateFunctionEventInvokeConfig.

By default, Lambda retries an asynchronous invocation twice if the function returns an error. It retains events in a queue for up to six hours. When an event fails all processing attempts or stays in the asynchronous invocation queue for too long, Lambda discards it. To retain discarded events, configure a dead-letter queue with UpdateFunctionConfiguration.

To send an invocation record to a queue, topic, S3 bucket, function, or event bus, specify a destination. You can configure separate destinations for successful invocations (on-success) and events that fail all processing attempts (on-failure). You can configure destinations in addition to or instead of a dead-letter queue.

S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type.

", - "PutFunctionRecursionConfig": "

Sets your function's recursive loop detection configuration.

When you configure a Lambda function to output to the same service or resource that invokes the function, it's possible to create an infinite recursive loop. For example, a Lambda function might write a message to an Amazon Simple Queue Service (Amazon SQS) queue, which then invokes the same function. This invocation causes the function to write another message to the queue, which in turn invokes the function again.

Lambda can detect certain types of recursive loops shortly after they occur. When Lambda detects a recursive loop and your function's recursive loop detection configuration is set to Terminate, it stops your function being invoked and notifies you.

", - "PutFunctionScalingConfig": "

Sets the scaling configuration for a Lambda Managed Instances function. The scaling configuration defines the minimum and maximum number of execution environments that can be provisioned for the function, allowing you to control scaling behavior and resource allocation.

", - "PutProvisionedConcurrencyConfig": "

Adds a provisioned concurrency configuration to a function's alias or version.

", - "PutRuntimeManagementConfig": "

Sets the runtime management configuration for a function's version. For more information, see Runtime updates.

", - "RemoveLayerVersionPermission": "

Removes a statement from the permissions policy for a version of an Lambda layer. For more information, see AddLayerVersionPermission.

", - "RemovePermission": "

Revokes function-use permission from an Amazon Web Services service or another Amazon Web Services account. You can get the ID of the statement from the output of GetPolicy.

", - "SendDurableExecutionCallbackFailure": "

Sends a failure response for a callback operation in a durable execution. Use this API when an external system cannot complete a callback operation successfully.

", - "SendDurableExecutionCallbackHeartbeat": "

Sends a heartbeat signal for a long-running callback operation to prevent timeout. Use this API to extend the callback timeout period while the external operation is still in progress.

", - "SendDurableExecutionCallbackSuccess": "

Sends a successful completion response for a callback operation in a durable execution. Use this API when an external system has successfully completed a callback operation.

", - "StopDurableExecution": "

Stops a running durable execution. The execution transitions to STOPPED status and cannot be resumed. Any in-progress operations are terminated.

", - "TagResource": "

Adds tags to a function, event source mapping, or code signing configuration.

", - "UntagResource": "

Removes tags from a function, event source mapping, or code signing configuration.

", - "UpdateAlias": "

Updates the configuration of a Lambda function alias.

", - "UpdateCapacityProvider": "

Updates the configuration of an existing capacity provider.

", - "UpdateCodeSigningConfig": "

Update the code signing configuration. Changes to the code signing configuration take effect the next time a user tries to deploy a code package to the function.

", - "UpdateEventSourceMapping": "

Updates an event source mapping. You can change the function that Lambda invokes, or pause invocation and resume later from the same location.

For details about how to configure different event sources, see the following topics.

The following error handling options are available for stream sources (DynamoDB, Kinesis, Amazon MSK, and self-managed Apache Kafka):

  • BisectBatchOnFunctionError – If the function returns an error, split the batch in two and retry.

  • MaximumRecordAgeInSeconds – Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires

  • MaximumRetryAttempts – Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.

  • OnFailure – Send discarded records to an Amazon SQS queue, Amazon SNS topic, Kafka topic, or Amazon S3 bucket. For more information, see Adding a destination.

The following option is available only for DynamoDB and Kinesis event sources:

  • ParallelizationFactor – Process multiple batches from each shard concurrently.

For information about which configuration parameters apply to each event source, see the following topics.

", - "UpdateFunctionCode": "

Updates a Lambda function's code. If code signing is enabled for the function, the code package must be signed by a trusted publisher. For more information, see Configuring code signing for Lambda.

If the function's package type is Image, then you must specify the code package in ImageUri as the URI of a container image in the Amazon ECR registry.

If the function's package type is Zip, then you must specify the deployment package as a .zip file archive. Enter the Amazon S3 bucket and key of the code .zip file location. You can also provide the function code inline using the ZipFile field.

The code in the deployment package must be compatible with the target instruction set architecture of the function (x86-64 or arm64).

The function's code is locked when you publish a version. You can't modify the code of a published version, only the unpublished version.

For a function defined as a container image, Lambda resolves the image tag to an image digest. In Amazon ECR, if you update the image tag to a new image, Lambda does not automatically update the function.

", - "UpdateFunctionConfiguration": "

Modify the version-specific settings of a Lambda function.

When you update a function, Lambda provisions an instance of the function and its supporting resources. If your function connects to a VPC, this process can take a minute. During this time, you can't modify the function, but you can still invoke it. The LastUpdateStatus, LastUpdateStatusReason, and LastUpdateStatusReasonCode fields in the response from GetFunctionConfiguration indicate when the update is complete and the function is processing events with the new configuration. For more information, see Lambda function states.

These settings can vary between versions of a function and are locked when you publish a version. You can't modify the configuration of a published version, only the unpublished version.

To configure function concurrency, use PutFunctionConcurrency. To grant invoke permissions to an Amazon Web Services account or Amazon Web Services service, use AddPermission.

", - "UpdateFunctionEventInvokeConfig": "

Updates the configuration for asynchronous invocation for a function, version, or alias.

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

", - "UpdateFunctionUrlConfig": "

Updates the configuration for a Lambda function URL.

" - }, - "shapes": { - "AccountLimit": { - "base": "

Limits that are related to concurrency and storage. All file and storage sizes are in bytes.

", - "refs": { - "GetAccountSettingsResponse$AccountLimit": "

Limits that are related to concurrency and code storage.

" - } - }, - "AccountUsage": { - "base": "

The number of functions and amount of storage in use.

", - "refs": { - "GetAccountSettingsResponse$AccountUsage": "

The number of functions and amount of storage in use.

" - } - }, - "Action": { - "base": null, - "refs": { - "AddPermissionRequest$Action": "

The action that the principal can use on the function. For example, lambda:InvokeFunction or lambda:GetFunction.

" - } - }, - "AddLayerVersionPermissionRequest": { - "base": null, - "refs": {} - }, - "AddLayerVersionPermissionResponse": { - "base": null, - "refs": {} - }, - "AddPermissionRequest": { - "base": null, - "refs": {} - }, - "AddPermissionResponse": { - "base": null, - "refs": {} - }, - "AdditionalVersion": { - "base": null, - "refs": { - "AdditionalVersionWeights$key": null - } - }, - "AdditionalVersionWeights": { - "base": null, - "refs": { - "AliasRoutingConfiguration$AdditionalVersionWeights": "

The second version, and the percentage of traffic that's routed to it.

" - } - }, - "Alias": { - "base": null, - "refs": { - "AliasConfiguration$Name": "

The name of the alias.

", - "CreateAliasRequest$Name": "

The name of the alias.

", - "DeleteAliasRequest$Name": "

The name of the alias.

", - "GetAliasRequest$Name": "

The name of the alias.

", - "UpdateAliasRequest$Name": "

The name of the alias.

" - } - }, - "AliasConfiguration": { - "base": "

Provides configuration information about a Lambda function alias.

", - "refs": { - "AliasList$member": null - } - }, - "AliasLimitExceededException": { - "base": "

Lambda couldn't create the alias because your Amazon Web Services account has exceeded the maximum number of aliases allowed per Lambda function. For more information, see Lambda quotas.

", - "refs": {} - }, - "AliasList": { - "base": null, - "refs": { - "ListAliasesResponse$Aliases": "

A list of aliases.

" - } - }, - "AliasRoutingConfiguration": { - "base": "

The traffic-shifting configuration of a Lambda function alias.

", - "refs": { - "AliasConfiguration$RoutingConfig": "

The routing configuration of the alias.

", - "CreateAliasRequest$RoutingConfig": "

The routing configuration of the alias.

", - "UpdateAliasRequest$RoutingConfig": "

The routing configuration of the alias.

" - } - }, - "AllowCredentials": { - "base": null, - "refs": { - "Cors$AllowCredentials": "

Whether to allow cookies or other credentials in requests to your function URL. The default is false.

" - } - }, - "AllowMethodsList": { - "base": null, - "refs": { - "Cors$AllowMethods": "

The HTTP methods that are allowed when calling your function URL. For example: GET, POST, DELETE, or the wildcard character (*).

" - } - }, - "AllowOriginsList": { - "base": null, - "refs": { - "Cors$AllowOrigins": "

The origins that can access your function URL. You can list any number of specific origins, separated by a comma. For example: https://www.example.com, http://localhost:60905.

Alternatively, you can grant access to all origins using the wildcard character (*).

" - } - }, - "AllowedPublishers": { - "base": "

List of signing profiles that can sign a code package.

", - "refs": { - "CodeSigningConfig$AllowedPublishers": "

List of allowed publishers.

", - "CreateCodeSigningConfigRequest$AllowedPublishers": "

Signing profiles for this code signing configuration.

", - "UpdateCodeSigningConfigRequest$AllowedPublishers": "

Signing profiles for this code signing configuration.

" - } - }, - "AmazonManagedKafkaEventSourceConfig": { - "base": "

Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.

", - "refs": { - "CreateEventSourceMappingRequest$AmazonManagedKafkaEventSourceConfig": "

Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.

", - "EventSourceMappingConfiguration$AmazonManagedKafkaEventSourceConfig": "

Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.

", - "UpdateEventSourceMappingRequest$AmazonManagedKafkaEventSourceConfig": null - } - }, - "ApplicationLogLevel": { - "base": null, - "refs": { - "LoggingConfig$ApplicationLogLevel": "

Set this property to filter the application logs for your function that Lambda sends to CloudWatch. Lambda only sends application logs at the selected level of detail and lower, where TRACE is the highest level and FATAL is the lowest.

" - } - }, - "Architecture": { - "base": null, - "refs": { - "ArchitecturesList$member": null, - "CompatibleArchitectures$member": null, - "ListLayerVersionsRequest$CompatibleArchitecture": "

The compatible instruction set architecture.

", - "ListLayersRequest$CompatibleArchitecture": "

The compatible instruction set architecture.

" - } - }, - "ArchitecturesList": { - "base": null, - "refs": { - "CreateFunctionRequest$Architectures": "

The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64.

", - "FunctionConfiguration$Architectures": "

The instruction set architecture that the function supports. Architecture is a string array with one of the valid values. The default architecture value is x86_64.

", - "InstanceRequirements$Architectures": "

A list of supported CPU architectures for compute instances. Valid values include x86_64 and arm64.

", - "UpdateFunctionCodeRequest$Architectures": "

The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64.

" - } - }, - "Arn": { - "base": null, - "refs": { - "AddPermissionRequest$SourceArn": "

For Amazon Web Services services, the ARN of the Amazon Web Services resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic.

Note that Lambda configures the comparison using the StringLike operator.

", - "CreateEventSourceMappingRequest$EventSourceArn": "

The Amazon Resource Name (ARN) of the event source.

  • Amazon Kinesis – The ARN of the data stream or a stream consumer.

  • Amazon DynamoDB Streams – The ARN of the stream.

  • Amazon Simple Queue Service – The ARN of the queue.

  • Amazon Managed Streaming for Apache Kafka – The ARN of the cluster or the ARN of the VPC connection (for cross-account event source mappings).

  • Amazon MQ – The ARN of the broker.

  • Amazon DocumentDB – The ARN of the DocumentDB change stream.

", - "EventSourceMappingConfiguration$EventSourceArn": "

The Amazon Resource Name (ARN) of the event source.

", - "FunctionConfiguration$SigningProfileVersionArn": "

The ARN of the signing profile version.

", - "FunctionConfiguration$SigningJobArn": "

The ARN of the signing job.

", - "KafkaSchemaRegistryAccessConfig$URI": "

The URI of the secret (Secrets Manager secret ARN) to authenticate with your schema registry.

", - "Layer$SigningProfileVersionArn": "

The Amazon Resource Name (ARN) for a signing profile version.

", - "Layer$SigningJobArn": "

The Amazon Resource Name (ARN) of a signing job.

", - "LayerVersionContentOutput$SigningProfileVersionArn": "

The Amazon Resource Name (ARN) for a signing profile version.

", - "LayerVersionContentOutput$SigningJobArn": "

The Amazon Resource Name (ARN) of a signing job.

", - "ListEventSourceMappingsRequest$EventSourceArn": "

The Amazon Resource Name (ARN) of the event source.

  • Amazon Kinesis – The ARN of the data stream or a stream consumer.

  • Amazon DynamoDB Streams – The ARN of the stream.

  • Amazon Simple Queue Service – The ARN of the queue.

  • Amazon Managed Streaming for Apache Kafka – The ARN of the cluster or the ARN of the VPC connection (for cross-account event source mappings).

  • Amazon MQ – The ARN of the broker.

  • Amazon DocumentDB – The ARN of the DocumentDB change stream.

", - "SigningProfileVersionArns$member": null - } - }, - "AttemptCount": { - "base": null, - "refs": { - "RetryDetails$CurrentAttempt": "

The current attempt number for this operation.

", - "StepDetails$Attempt": "

The current attempt number for this step.

" - } - }, - "BatchSize": { - "base": null, - "refs": { - "CreateEventSourceMappingRequest$BatchSize": "

The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).

  • Amazon Kinesis – Default 100. Max 10,000.

  • Amazon DynamoDB Streams – Default 100. Max 10,000.

  • Amazon Simple Queue Service – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.

  • Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000.

  • Self-managed Apache Kafka – Default 100. Max 10,000.

  • Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000.

  • DocumentDB – Default 100. Max 10,000.

", - "EventSourceMappingConfiguration$BatchSize": "

The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).

Default value: Varies by service. For Amazon SQS, the default is 10. For all other services, the default is 100.

Related setting: When you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

", - "UpdateEventSourceMappingRequest$BatchSize": "

The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).

  • Amazon Kinesis – Default 100. Max 10,000.

  • Amazon DynamoDB Streams – Default 100. Max 10,000.

  • Amazon Simple Queue Service – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.

  • Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000.

  • Self-managed Apache Kafka – Default 100. Max 10,000.

  • Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000.

  • DocumentDB – Default 100. Max 10,000.

" - } - }, - "BinaryOperationPayload": { - "base": null, - "refs": { - "SendDurableExecutionCallbackSuccessRequest$Result": "

The result data from the successful callback operation. Maximum size is 256 KB.

" - } - }, - "BisectBatchOnFunctionError": { - "base": null, - "refs": { - "CreateEventSourceMappingRequest$BisectBatchOnFunctionError": "

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) If the function returns an error, split the batch in two and retry.

", - "EventSourceMappingConfiguration$BisectBatchOnFunctionError": "

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) If the function returns an error, split the batch in two and retry. The default value is false.

", - "UpdateEventSourceMappingRequest$BisectBatchOnFunctionError": "

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) If the function returns an error, split the batch in two and retry.

" - } - }, - "Blob": { - "base": null, - "refs": { - "FunctionCode$ZipFile": "

The base64-encoded contents of the deployment package. Amazon Web Services SDK and CLI clients handle the encoding for you.

", - "InvocationRequest$Payload": "

The JSON that you want to provide to your Lambda function as input. The maximum payload size is 6 MB for synchronous invocations and 1 MB for asynchronous invocations.

You can enter the JSON directly. For example, --payload '{ \"key\": \"value\" }'. You can also specify a file path. For example, --payload file://payload.json.

", - "InvocationResponse$Payload": "

The response from the function, or an error object.

", - "InvokeResponseStreamUpdate$Payload": "

Data returned by your Lambda function.

", - "InvokeWithResponseStreamRequest$Payload": "

The JSON that you want to provide to your Lambda function as input.

You can enter the JSON directly. For example, --payload '{ \"key\": \"value\" }'. You can also specify a file path. For example, --payload file://payload.json.

", - "LayerVersionContentInput$ZipFile": "

The base64-encoded contents of the layer archive. Amazon Web Services SDK and Amazon Web Services CLI clients handle the encoding for you.

", - "UpdateFunctionCodeRequest$ZipFile": "

The base64-encoded contents of the deployment package. Amazon Web Services SDK and CLI clients handle the encoding for you. Use only with a function defined with a .zip file archive deployment package.

" - } - }, - "BlobStream": { - "base": null, - "refs": { - "InvokeAsyncRequest$InvokeArgs": "

The JSON that you want to provide to your Lambda function as input.

" - } - }, - "Boolean": { - "base": null, - "refs": { - "CreateFunctionRequest$Publish": "

Set to true to publish the first version of the function during creation.

", - "UpdateFunctionCodeRequest$Publish": "

Set to true to publish a new version of the function after updating the code. This has the same effect as calling PublishVersion separately.

", - "UpdateFunctionCodeRequest$DryRun": "

Set to true to validate the request parameters and access permissions without modifying the function code.

" - } - }, - "CallbackDetails": { - "base": "

Contains details about a callback operation in a durable execution, including the callback token and timeout configuration.

", - "refs": { - "Operation$CallbackDetails": null - } - }, - "CallbackFailedDetails": { - "base": "

Contains details about a failed callback operation, including error information and the reason for failure.

", - "refs": { - "Event$CallbackFailedDetails": null - } - }, - "CallbackId": { - "base": null, - "refs": { - "CallbackDetails$CallbackId": "

The callback ID. Callback IDs are generated by the DurableContext when a durable function calls ctx.waitForCallback.

", - "CallbackStartedDetails$CallbackId": "

The callback ID. Callback IDs are generated by the DurableContext when a durable function calls ctx.waitForCallback.

", - "SendDurableExecutionCallbackFailureRequest$CallbackId": "

The unique identifier for the callback operation.

", - "SendDurableExecutionCallbackHeartbeatRequest$CallbackId": "

The unique identifier for the callback operation.

", - "SendDurableExecutionCallbackSuccessRequest$CallbackId": "

The unique identifier for the callback operation.

" - } - }, - "CallbackOptions": { - "base": "

Configuration options for callback operations in durable executions, including timeout settings and retry behavior.

", - "refs": { - "OperationUpdate$CallbackOptions": null - } - }, - "CallbackOptionsHeartbeatTimeoutSecondsInteger": { - "base": null, - "refs": { - "CallbackOptions$HeartbeatTimeoutSeconds": "

The heartbeat timeout for the callback operation, in seconds. If not specified or set to 0, heartbeat timeout is disabled.

" - } - }, - "CallbackOptionsTimeoutSecondsInteger": { - "base": null, - "refs": { - "CallbackOptions$TimeoutSeconds": "

The timeout for the callback operation in seconds. If not specified or set to 0, the callback has no timeout.

" - } - }, - "CallbackStartedDetails": { - "base": "

Contains details about a callback operation that has started, including timing information and callback metadata.

", - "refs": { - "Event$CallbackStartedDetails": null - } - }, - "CallbackSucceededDetails": { - "base": "

Contains details about a successfully completed callback operation, including the result data and completion timestamp.

", - "refs": { - "Event$CallbackSucceededDetails": null - } - }, - "CallbackTimedOutDetails": { - "base": "

Contains details about a callback operation that timed out, including timeout duration and any partial results.

", - "refs": { - "Event$CallbackTimedOutDetails": null - } - }, - "CallbackTimeoutException": { - "base": "

The callback ID token has either expired or the callback associated with the token has already been closed.

", - "refs": {} - }, - "CapacityProvider": { - "base": "

A capacity provider manages compute resources for Lambda functions.

", - "refs": { - "CapacityProvidersList$member": null, - "CreateCapacityProviderResponse$CapacityProvider": "

Information about the capacity provider that was created.

", - "DeleteCapacityProviderResponse$CapacityProvider": "

Information about the deleted capacity provider.

", - "GetCapacityProviderResponse$CapacityProvider": "

Information about the capacity provider, including its configuration and current state.

", - "UpdateCapacityProviderResponse$CapacityProvider": "

Information about the updated capacity provider.

" - } - }, - "CapacityProviderArn": { - "base": null, - "refs": { - "CapacityProvider$CapacityProviderArn": "

The Amazon Resource Name (ARN) of the capacity provider.

", - "LambdaManagedInstancesCapacityProviderConfig$CapacityProviderArn": "

The Amazon Resource Name (ARN) of the capacity provider.

", - "ListFunctionVersionsByCapacityProviderResponse$CapacityProviderArn": "

The Amazon Resource Name (ARN) of the capacity provider.

" - } - }, - "CapacityProviderConfig": { - "base": "

Configuration for the capacity provider that manages compute resources for Lambda functions.

", - "refs": { - "CreateFunctionRequest$CapacityProviderConfig": "

Configuration for the capacity provider that manages compute resources for Lambda functions.

", - "FunctionConfiguration$CapacityProviderConfig": "

Configuration for the capacity provider that manages compute resources for Lambda functions.

", - "UpdateFunctionConfigurationRequest$CapacityProviderConfig": "

Configuration for the capacity provider that manages compute resources for Lambda functions.

" - } - }, - "CapacityProviderLimitExceededException": { - "base": "

The maximum number of capacity providers for your account has been exceeded. For more information, see Lambda quotas

", - "refs": {} - }, - "CapacityProviderLoggingConfig": { - "base": "

The capacity provider's Amazon CloudWatch Logs configuration settings.

", - "refs": { - "CapacityProviderTelemetryConfig$LoggingConfig": "

The capacity provider's Amazon CloudWatch Logs configuration settings.

" - } - }, - "CapacityProviderMaxVCpuCount": { - "base": null, - "refs": { - "CapacityProviderScalingConfig$MaxVCpuCount": "

The maximum number of vCPUs that the capacity provider can provision across all compute instances.

" - } - }, - "CapacityProviderName": { - "base": null, - "refs": { - "CreateCapacityProviderRequest$CapacityProviderName": "

The name of the capacity provider.

", - "DeleteCapacityProviderRequest$CapacityProviderName": "

The name of the capacity provider to delete.

", - "GetCapacityProviderRequest$CapacityProviderName": "

The name of the capacity provider to retrieve.

", - "ListFunctionVersionsByCapacityProviderRequest$CapacityProviderName": "

The name of the capacity provider to list function versions for.

", - "UpdateCapacityProviderRequest$CapacityProviderName": "

The name of the capacity provider to update.

" - } - }, - "CapacityProviderPermissionsConfig": { - "base": "

Configuration that specifies the permissions required for the capacity provider to manage compute resources.

", - "refs": { - "CapacityProvider$PermissionsConfig": "

The permissions configuration for the capacity provider.

", - "CreateCapacityProviderRequest$PermissionsConfig": "

The permissions configuration that specifies the IAM role ARN used by the capacity provider to manage compute resources.

" - } - }, - "CapacityProviderPredefinedMetricType": { - "base": null, - "refs": { - "TargetTrackingScalingPolicy$PredefinedMetricType": "

The predefined metric type to track for scaling decisions.

" - } - }, - "CapacityProviderScalingConfig": { - "base": "

Configuration that defines how the capacity provider scales compute instances based on demand and policies.

", - "refs": { - "CapacityProvider$CapacityProviderScalingConfig": "

The scaling configuration for the capacity provider.

", - "CreateCapacityProviderRequest$CapacityProviderScalingConfig": "

The scaling configuration that defines how the capacity provider scales compute instances, including maximum vCPU count and scaling policies.

", - "UpdateCapacityProviderRequest$CapacityProviderScalingConfig": "

The updated scaling configuration for the capacity provider.

" - } - }, - "CapacityProviderScalingMode": { - "base": null, - "refs": { - "CapacityProviderScalingConfig$ScalingMode": "

The scaling mode that determines how the capacity provider responds to changes in demand.

" - } - }, - "CapacityProviderScalingPoliciesList": { - "base": null, - "refs": { - "CapacityProviderScalingConfig$ScalingPolicies": "

A list of scaling policies that define how the capacity provider scales compute instances based on metrics and thresholds.

" - } - }, - "CapacityProviderSecurityGroupIds": { - "base": null, - "refs": { - "CapacityProviderVpcConfig$SecurityGroupIds": "

A list of security group IDs that control network access for compute instances managed by the capacity provider.

" - } - }, - "CapacityProviderState": { - "base": null, - "refs": { - "CapacityProvider$State": "

The current state of the capacity provider.

", - "ListCapacityProvidersRequest$State": "

Filter capacity providers by their current state.

" - } - }, - "CapacityProviderSubnetIds": { - "base": null, - "refs": { - "CapacityProviderVpcConfig$SubnetIds": "

A list of subnet IDs where the capacity provider launches compute instances.

" - } - }, - "CapacityProviderTelemetryConfig": { - "base": "

Configuration that specifies the telemetry collection for the capacity provider.

", - "refs": { - "CapacityProvider$TelemetryConfig": "

The telemetry configuration for the capacity provider, including logging settings.

", - "CreateCapacityProviderRequest$TelemetryConfig": "

The telemetry configuration for the capacity provider. Specifies logging settings for managed resources.

", - "UpdateCapacityProviderRequest$TelemetryConfig": "

The updated telemetry configuration for the capacity provider.

" - } - }, - "CapacityProviderVpcConfig": { - "base": "

VPC configuration that specifies the network settings for compute instances managed by the capacity provider.

", - "refs": { - "CapacityProvider$VpcConfig": "

The VPC configuration for the capacity provider.

", - "CreateCapacityProviderRequest$VpcConfig": "

The VPC configuration for the capacity provider, including subnet IDs and security group IDs where compute instances will be launched.

" - } - }, - "CapacityProvidersList": { - "base": null, - "refs": { - "ListCapacityProvidersResponse$CapacityProviders": "

A list of capacity providers in your account.

" - } - }, - "ChainedInvokeDetails": { - "base": "

Contains details about a chained function invocation in a durable execution, including the target function and invocation parameters.

", - "refs": { - "Operation$ChainedInvokeDetails": null - } - }, - "ChainedInvokeFailedDetails": { - "base": "

Contains details about a failed chained function invocation, including error information and failure reason.

", - "refs": { - "Event$ChainedInvokeFailedDetails": null - } - }, - "ChainedInvokeOptions": { - "base": "

Configuration options for chained function invocations in durable executions, including retry settings and timeout configuration.

", - "refs": { - "OperationUpdate$ChainedInvokeOptions": null - } - }, - "ChainedInvokeStartedDetails": { - "base": "

Contains details about a chained function invocation that has started execution, including start time and execution context.

", - "refs": { - "Event$ChainedInvokeStartedDetails": null - } - }, - "ChainedInvokeStoppedDetails": { - "base": "

Details about a chained invocation that was stopped.

", - "refs": { - "Event$ChainedInvokeStoppedDetails": "

Details about a chained invocation that was stopped.

" - } - }, - "ChainedInvokeSucceededDetails": { - "base": "

Details about a chained invocation that succeeded.

", - "refs": { - "Event$ChainedInvokeSucceededDetails": "

Details about a chained invocation that succeeded.

" - } - }, - "ChainedInvokeTimedOutDetails": { - "base": "

Details about a chained invocation that timed out.

", - "refs": { - "Event$ChainedInvokeTimedOutDetails": "

Details about a chained invocation that timed out.

" - } - }, - "CheckpointDurableExecutionRequest": { - "base": null, - "refs": {} - }, - "CheckpointDurableExecutionResponse": { - "base": "

The response from the CheckpointDurableExecution operation.

", - "refs": {} - }, - "CheckpointToken": { - "base": null, - "refs": { - "CheckpointDurableExecutionRequest$CheckpointToken": "

A unique token that identifies the current checkpoint state. This token is provided by the Lambda runtime and must be used to ensure checkpoints are applied in the correct order. Each checkpoint operation consumes this token and returns a new one.

", - "CheckpointDurableExecutionResponse$CheckpointToken": "

A new checkpoint token to use for the next checkpoint operation. This token replaces the one provided in the request and must be used for subsequent checkpoints to maintain proper ordering.

", - "GetDurableExecutionStateRequest$CheckpointToken": "

A checkpoint token that identifies the current state of the execution. This token is provided by the Lambda runtime and ensures that state retrieval is consistent with the current execution context.

" - } - }, - "CheckpointUpdatedExecutionState": { - "base": "

Contains operations that have been updated since the last checkpoint, such as completed asynchronous work like timers or callbacks.

", - "refs": { - "CheckpointDurableExecutionResponse$NewExecutionState": "

Updated execution state information that includes any changes that occurred since the last checkpoint, such as completed callbacks or expired timers. This allows the SDK to update its internal state during replay.

" - } - }, - "ClientToken": { - "base": null, - "refs": { - "CheckpointDurableExecutionRequest$ClientToken": "

An optional idempotency token to ensure that duplicate checkpoint requests are handled correctly. If provided, Lambda uses this token to detect and handle duplicate requests within a 15-minute window.

" - } - }, - "CodeArtifactUserDeletedException": { - "base": "

The Lambda function couldn't be invoked because its code artifact user has been deleted. Wait for Lambda to provision a new code artifact user, or update the function's code package to recreate it.

", - "refs": {} - }, - "CodeArtifactUserFailedException": { - "base": "

The Lambda function couldn't be invoked because provisioning of its code artifact user failed. Update the function's code package or check the Lambda function's State and StateReasonCode for additional context.

", - "refs": {} - }, - "CodeArtifactUserPendingException": { - "base": "

The Lambda function couldn't be invoked because its code artifact user is still being provisioned. Wait for the function's State to become Active and try the request again.

", - "refs": {} - }, - "CodeSigningConfig": { - "base": "

Details about a Code signing configuration.

", - "refs": { - "CodeSigningConfigList$member": null, - "CreateCodeSigningConfigResponse$CodeSigningConfig": "

The code signing configuration.

", - "GetCodeSigningConfigResponse$CodeSigningConfig": "

The code signing configuration

", - "UpdateCodeSigningConfigResponse$CodeSigningConfig": "

The code signing configuration

" - } - }, - "CodeSigningConfigArn": { - "base": null, - "refs": { - "CodeSigningConfig$CodeSigningConfigArn": "

The Amazon Resource Name (ARN) of the Code signing configuration.

", - "CreateFunctionRequest$CodeSigningConfigArn": "

To enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.

", - "DeleteCodeSigningConfigRequest$CodeSigningConfigArn": "

The The Amazon Resource Name (ARN) of the code signing configuration.

", - "GetCodeSigningConfigRequest$CodeSigningConfigArn": "

The The Amazon Resource Name (ARN) of the code signing configuration.

", - "GetFunctionCodeSigningConfigResponse$CodeSigningConfigArn": "

The The Amazon Resource Name (ARN) of the code signing configuration.

", - "ListFunctionsByCodeSigningConfigRequest$CodeSigningConfigArn": "

The The Amazon Resource Name (ARN) of the code signing configuration.

", - "PutFunctionCodeSigningConfigRequest$CodeSigningConfigArn": "

The The Amazon Resource Name (ARN) of the code signing configuration.

", - "PutFunctionCodeSigningConfigResponse$CodeSigningConfigArn": "

The The Amazon Resource Name (ARN) of the code signing configuration.

", - "UpdateCodeSigningConfigRequest$CodeSigningConfigArn": "

The The Amazon Resource Name (ARN) of the code signing configuration.

" - } - }, - "CodeSigningConfigId": { - "base": null, - "refs": { - "CodeSigningConfig$CodeSigningConfigId": "

Unique identifer for the Code signing configuration.

" - } - }, - "CodeSigningConfigList": { - "base": null, - "refs": { - "ListCodeSigningConfigsResponse$CodeSigningConfigs": "

The code signing configurations

" - } - }, - "CodeSigningConfigNotFoundException": { - "base": "

The specified code signing configuration does not exist.

", - "refs": {} - }, - "CodeSigningPolicies": { - "base": "

Code signing configuration policies specify the validation failure action for signature mismatch or expiry.

", - "refs": { - "CodeSigningConfig$CodeSigningPolicies": "

The code signing policy controls the validation failure action for signature mismatch or expiry.

", - "CreateCodeSigningConfigRequest$CodeSigningPolicies": "

The code signing policies define the actions to take if the validation checks fail.

", - "UpdateCodeSigningConfigRequest$CodeSigningPolicies": "

The code signing policy.

" - } - }, - "CodeSigningPolicy": { - "base": null, - "refs": { - "CodeSigningPolicies$UntrustedArtifactOnDeployment": "

Code signing configuration policy for deployment validation failure. If you set the policy to Enforce, Lambda blocks the deployment request if signature validation checks fail. If you set the policy to Warn, Lambda allows the deployment and issues a new Amazon CloudWatch metric (SignatureValidationErrors) and also stores the warning in the CloudTrail log.

Default value: Warn

" - } - }, - "CodeStorageExceededException": { - "base": "

Your Amazon Web Services account has exceeded its maximum total code size. For more information, see Lambda quotas.

", - "refs": {} - }, - "CodeVerificationFailedException": { - "base": "

The code signature failed one or more of the validation checks for signature mismatch or expiry, and the code signing policy is set to ENFORCE. Lambda blocks the deployment.

", - "refs": {} - }, - "CollectionName": { - "base": null, - "refs": { - "DocumentDBEventSourceConfig$CollectionName": "

The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections.

" - } - }, - "CompatibleArchitectures": { - "base": null, - "refs": { - "GetLayerVersionResponse$CompatibleArchitectures": "

A list of compatible instruction set architectures.

", - "LayerVersionsListItem$CompatibleArchitectures": "

A list of compatible instruction set architectures.

", - "PublishLayerVersionRequest$CompatibleArchitectures": "

A list of compatible instruction set architectures.

", - "PublishLayerVersionResponse$CompatibleArchitectures": "

A list of compatible instruction set architectures.

" - } - }, - "CompatibleRuntimes": { - "base": null, - "refs": { - "GetLayerVersionResponse$CompatibleRuntimes": "

The layer's compatible runtimes.

The following list includes deprecated runtimes. For more information, see Runtime use after deprecation.

For a list of all currently supported runtimes, see Supported runtimes.

", - "LayerVersionsListItem$CompatibleRuntimes": "

The layer's compatible runtimes.

The following list includes deprecated runtimes. For more information, see Runtime use after deprecation.

For a list of all currently supported runtimes, see Supported runtimes.

", - "PublishLayerVersionRequest$CompatibleRuntimes": "

A list of compatible function runtimes. Used for filtering with ListLayers and ListLayerVersions.

The following list includes deprecated runtimes. For more information, see Runtime deprecation policy.

", - "PublishLayerVersionResponse$CompatibleRuntimes": "

The layer's compatible runtimes.

The following list includes deprecated runtimes. For more information, see Runtime use after deprecation.

For a list of all currently supported runtimes, see Supported runtimes.

" - } - }, - "Concurrency": { - "base": null, - "refs": { - "GetFunctionResponse$Concurrency": "

The function's reserved concurrency.

" - } - }, - "ContextDetails": { - "base": "

Details about a durable execution context.

", - "refs": { - "Operation$ContextDetails": "

Details about the context, if this operation represents a context.

" - } - }, - "ContextFailedDetails": { - "base": "

Details about a context that failed.

", - "refs": { - "Event$ContextFailedDetails": "

Details about a context that failed.

" - } - }, - "ContextOptions": { - "base": "

Configuration options for a durable execution context.

", - "refs": { - "OperationUpdate$ContextOptions": "

Options for context operations.

" - } - }, - "ContextStartedDetails": { - "base": "

Details about a context that has started.

", - "refs": { - "Event$ContextStartedDetails": "

Details about a context that started.

" - } - }, - "ContextSucceededDetails": { - "base": "

Details about a context that succeeded.

", - "refs": { - "Event$ContextSucceededDetails": "

Details about a context that succeeded.

" - } - }, - "Cors": { - "base": "

The cross-origin resource sharing (CORS) settings for your Lambda function URL. Use CORS to grant access to your function URL from any origin. You can also use CORS to control access for specific HTTP headers and methods in requests to your function URL.

", - "refs": { - "CreateFunctionUrlConfigRequest$Cors": "

The cross-origin resource sharing (CORS) settings for your function URL.

", - "CreateFunctionUrlConfigResponse$Cors": "

The cross-origin resource sharing (CORS) settings for your function URL.

", - "FunctionUrlConfig$Cors": "

The cross-origin resource sharing (CORS) settings for your function URL.

", - "GetFunctionUrlConfigResponse$Cors": "

The cross-origin resource sharing (CORS) settings for your function URL.

", - "UpdateFunctionUrlConfigRequest$Cors": "

The cross-origin resource sharing (CORS) settings for your function URL.

", - "UpdateFunctionUrlConfigResponse$Cors": "

The cross-origin resource sharing (CORS) settings for your function URL.

" - } - }, - "CreateAliasRequest": { - "base": null, - "refs": {} - }, - "CreateCapacityProviderRequest": { - "base": null, - "refs": {} - }, - "CreateCapacityProviderResponse": { - "base": null, - "refs": {} - }, - "CreateCodeSigningConfigRequest": { - "base": null, - "refs": {} - }, - "CreateCodeSigningConfigResponse": { - "base": null, - "refs": {} - }, - "CreateEventSourceMappingRequest": { - "base": null, - "refs": {} - }, - "CreateFunctionRequest": { - "base": null, - "refs": {} - }, - "CreateFunctionUrlConfigRequest": { - "base": null, - "refs": {} - }, - "CreateFunctionUrlConfigResponse": { - "base": null, - "refs": {} - }, - "DatabaseName": { - "base": null, - "refs": { - "DocumentDBEventSourceConfig$DatabaseName": "

The name of the database to consume within the DocumentDB cluster.

" - } - }, - "Date": { - "base": null, - "refs": { - "CreateEventSourceMappingRequest$StartingPositionTimestamp": "

With StartingPosition set to AT_TIMESTAMP, the time from which to start reading. StartingPositionTimestamp cannot be in the future.

", - "EventSourceMappingConfiguration$StartingPositionTimestamp": "

With StartingPosition set to AT_TIMESTAMP, the time from which to start reading. StartingPositionTimestamp cannot be in the future.

", - "EventSourceMappingConfiguration$LastModified": "

The date that the event source mapping was last updated or that its state changed.

", - "FunctionEventInvokeConfig$LastModified": "

The date and time that the configuration was last updated.

" - } - }, - "DeadLetterConfig": { - "base": "

The dead-letter queue for failed asynchronous invocations.

", - "refs": { - "CreateFunctionRequest$DeadLetterConfig": "

A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead-letter queues.

", - "FunctionConfiguration$DeadLetterConfig": "

The function's dead letter queue.

", - "UpdateFunctionConfigurationRequest$DeadLetterConfig": "

A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead-letter queues.

" - } - }, - "DeleteAliasRequest": { - "base": null, - "refs": {} - }, - "DeleteCapacityProviderRequest": { - "base": null, - "refs": {} - }, - "DeleteCapacityProviderResponse": { - "base": null, - "refs": {} - }, - "DeleteCodeSigningConfigRequest": { - "base": null, - "refs": {} - }, - "DeleteCodeSigningConfigResponse": { - "base": null, - "refs": {} - }, - "DeleteEventSourceMappingRequest": { - "base": null, - "refs": {} - }, - "DeleteFunctionCodeSigningConfigRequest": { - "base": null, - "refs": {} - }, - "DeleteFunctionConcurrencyRequest": { - "base": null, - "refs": {} - }, - "DeleteFunctionEventInvokeConfigRequest": { - "base": null, - "refs": {} - }, - "DeleteFunctionRequest": { - "base": null, - "refs": {} - }, - "DeleteFunctionResponse": { - "base": null, - "refs": {} - }, - "DeleteFunctionUrlConfigRequest": { - "base": null, - "refs": {} - }, - "DeleteLayerVersionRequest": { - "base": null, - "refs": {} - }, - "DeleteProvisionedConcurrencyConfigRequest": { - "base": null, - "refs": {} - }, - "Description": { - "base": null, - "refs": { - "AliasConfiguration$Description": "

A description of the alias.

", - "CodeSigningConfig$Description": "

Code signing configuration description.

", - "CreateAliasRequest$Description": "

A description of the alias.

", - "CreateCodeSigningConfigRequest$Description": "

Descriptive name for this code signing configuration.

", - "CreateFunctionRequest$Description": "

A description of the function.

", - "FunctionConfiguration$Description": "

The function's description.

", - "GetLayerVersionResponse$Description": "

The description of the version.

", - "LayerVersionsListItem$Description": "

The description of the version.

", - "PublishLayerVersionRequest$Description": "

The description of the version.

", - "PublishLayerVersionResponse$Description": "

The description of the version.

", - "PublishVersionRequest$Description": "

A description for the version to override the description in the function configuration.

", - "UpdateAliasRequest$Description": "

A description of the alias.

", - "UpdateCodeSigningConfigRequest$Description": "

Descriptive name for this code signing configuration.

", - "UpdateFunctionConfigurationRequest$Description": "

A description of the function.

" - } - }, - "DestinationArn": { - "base": null, - "refs": { - "OnFailure$Destination": "

The Amazon Resource Name (ARN) of the destination resource.

To retain records of failed invocations from Kinesis, DynamoDB, self-managed Apache Kafka, or Amazon MSK, you can configure an Amazon SNS topic, Amazon SQS queue, Amazon S3 bucket, or Kafka topic as the destination.

Amazon SNS destinations have a message size limit of 256 KB. If the combined size of the function request and response payload exceeds the limit, Lambda will drop the payload when sending OnFailure event to the destination. For details on this behavior, refer to Retaining records of asynchronous invocations.

To retain records of failed invocations from Kinesis, DynamoDB, self-managed Kafka or Amazon MSK, you can configure an Amazon SNS topic, Amazon SQS queue, or Amazon S3 bucket as the destination.

", - "OnSuccess$Destination": "

The Amazon Resource Name (ARN) of the destination resource.

Amazon SNS destinations have a message size limit of 256 KB. If the combined size of the function request and response payload exceeds the limit, Lambda will drop the payload when sending OnFailure event to the destination. For details on this behavior, refer to Retaining records of asynchronous invocations.

" - } - }, - "DestinationConfig": { - "base": "

A configuration object that specifies the destination of an event after Lambda processes it. For more information, see Adding a destination.

", - "refs": { - "CreateEventSourceMappingRequest$DestinationConfig": "

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) A configuration object that specifies the destination of an event after Lambda processes it.

", - "EventSourceMappingConfiguration$DestinationConfig": "

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) A configuration object that specifies the destination of an event after Lambda processes it.

", - "FunctionEventInvokeConfig$DestinationConfig": "

A destination for events after they have been sent to a function for processing.

Destinations

  • Function - The Amazon Resource Name (ARN) of a Lambda function.

  • Queue - The ARN of a standard SQS queue.

  • Bucket - The ARN of an Amazon S3 bucket.

  • Topic - The ARN of a standard SNS topic.

  • Event Bus - The ARN of an Amazon EventBridge event bus.

S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type.

", - "PutFunctionEventInvokeConfigRequest$DestinationConfig": "

A destination for events after they have been sent to a function for processing.

Destinations

  • Function - The Amazon Resource Name (ARN) of a Lambda function.

  • Queue - The ARN of a standard SQS queue.

  • Bucket - The ARN of an Amazon S3 bucket.

  • Topic - The ARN of a standard SNS topic.

  • Event Bus - The ARN of an Amazon EventBridge event bus.

S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type.

", - "UpdateEventSourceMappingRequest$DestinationConfig": "

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) A configuration object that specifies the destination of an event after Lambda processes it.

", - "UpdateFunctionEventInvokeConfigRequest$DestinationConfig": "

A destination for events after they have been sent to a function for processing.

Destinations

  • Function - The Amazon Resource Name (ARN) of a Lambda function.

  • Queue - The ARN of a standard SQS queue.

  • Bucket - The ARN of an Amazon S3 bucket.

  • Topic - The ARN of a standard SNS topic.

  • Event Bus - The ARN of an Amazon EventBridge event bus.

S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type.

" - } - }, - "DocumentDBEventSourceConfig": { - "base": "

Specific configuration settings for a DocumentDB event source.

", - "refs": { - "CreateEventSourceMappingRequest$DocumentDBEventSourceConfig": "

Specific configuration settings for a DocumentDB event source.

", - "EventSourceMappingConfiguration$DocumentDBEventSourceConfig": "

Specific configuration settings for a DocumentDB event source.

", - "UpdateEventSourceMappingRequest$DocumentDBEventSourceConfig": "

Specific configuration settings for a DocumentDB event source.

" - } - }, - "DurableConfig": { - "base": "

Configuration settings for durable functions, including execution timeout, retention period for execution history, and an optional ARN of the Key Management Service (KMS) customer managed key that is used to encrypt your durable execution's payload data, including input, output, and error payloads.

", - "refs": { - "CreateFunctionRequest$DurableConfig": "

Configuration settings for durable functions. Enables creating functions with durability that can remember their state and continue execution even after interruptions.

", - "FunctionConfiguration$DurableConfig": "

The function's durable execution configuration settings, if the function is configured for durability.

", - "GetDurableExecutionResponse$DurableConfig": "

Configuration settings for the durable execution, including execution timeout, retention period for execution history, and an optional ARN of the Key Management Service (KMS) customer managed key that is used to encrypt your durable execution's payload data, including input, output, and error payloads.

", - "UpdateFunctionConfigurationRequest$DurableConfig": "

Configuration settings for durable functions, including execution timeout, retention period for execution history, and an optional ARN of the Key Management Service (KMS) customer managed key that is used to encrypt your durable execution's payload data, including input, output, and error payloads.

" - } - }, - "DurableExecutionAlreadyStartedException": { - "base": "

The durable execution with the specified name has already been started. Each durable execution name must be unique within the function. Use a different name or check the status of the existing execution.

", - "refs": {} - }, - "DurableExecutionArn": { - "base": null, - "refs": { - "ChainedInvokeStartedDetails$DurableExecutionArn": "

The Amazon Resource Name (ARN) that identifies the durable execution.

", - "CheckpointDurableExecutionRequest$DurableExecutionArn": "

The Amazon Resource Name (ARN) of the durable execution.

", - "Execution$DurableExecutionArn": "

The Amazon Resource Name (ARN) of the durable execution, if this execution is a durable execution.

", - "GetDurableExecutionHistoryRequest$DurableExecutionArn": "

The Amazon Resource Name (ARN) of the durable execution.

", - "GetDurableExecutionRequest$DurableExecutionArn": "

The Amazon Resource Name (ARN) of the durable execution.

", - "GetDurableExecutionResponse$DurableExecutionArn": "

The Amazon Resource Name (ARN) of the durable execution.

", - "GetDurableExecutionStateRequest$DurableExecutionArn": "

The Amazon Resource Name (ARN) of the durable execution.

", - "InvocationResponse$DurableExecutionArn": "

The ARN of the durable execution that was started. This is returned when invoking a durable function and provides a unique identifier for tracking the execution.

", - "StopDurableExecutionRequest$DurableExecutionArn": "

The Amazon Resource Name (ARN) of the durable execution.

" - } - }, - "DurableExecutionName": { - "base": null, - "refs": { - "Execution$DurableExecutionName": "

The unique name of the durable execution, if one was provided when the execution was started.

", - "GetDurableExecutionResponse$DurableExecutionName": "

The name of the durable execution. This is either the name you provided when invoking the function, or a system-generated unique identifier if no name was provided.

", - "InvocationRequest$DurableExecutionName": "

A unique name for the durable execution. If you invoke a durable function using a name that already exists with the same payload, Lambda returns the existing execution instead of creating a duplicate. If the payload differs, Lambda returns a DurableExecutionAlreadyStartedException error.

If not specified, Lambda generates a unique identifier automatically. For more information, see Execution names.

", - "ListDurableExecutionsByFunctionRequest$DurableExecutionName": "

Filter executions by name. Only executions with names that matches this string are returned.

" - } - }, - "DurableExecutions": { - "base": null, - "refs": { - "ListDurableExecutionsByFunctionResponse$DurableExecutions": "

List of durable execution summaries matching the filter criteria.

" - } - }, - "DurationSeconds": { - "base": null, - "refs": { - "CallbackStartedDetails$HeartbeatTimeout": "

The heartbeat timeout value, in seconds.

", - "CallbackStartedDetails$Timeout": "

The timeout value, in seconds.

", - "ExecutionStartedDetails$ExecutionTimeout": "

The maximum amount of time that the durable execution is allowed to run, in seconds.

", - "RetryDetails$NextAttemptDelaySeconds": "

The delay before the next retry attempt, in seconds.

", - "WaitStartedDetails$Duration": "

The duration to wait, in seconds.

", - "WaitSucceededDetails$Duration": "

The wait duration, in seconds.

" - } - }, - "EC2AccessDeniedException": { - "base": "

Need additional permissions to configure VPC settings.

", - "refs": {} - }, - "EC2ThrottledException": { - "base": "

Amazon EC2 throttled Lambda during Lambda function initialization using the execution role provided for the function.

", - "refs": {} - }, - "EC2UnexpectedException": { - "base": "

Lambda received an unexpected Amazon EC2 client exception while setting up for the Lambda function.

", - "refs": {} - }, - "EFSIOException": { - "base": "

An error occurred when reading from or writing to a connected file system.

", - "refs": {} - }, - "EFSMountConnectivityException": { - "base": "

The Lambda function couldn't make a network connection to the configured file system.

", - "refs": {} - }, - "EFSMountFailureException": { - "base": "

The Lambda function couldn't mount the configured file system due to a permission or configuration issue.

", - "refs": {} - }, - "EFSMountTimeoutException": { - "base": "

The Lambda function made a network connection to the configured file system, but the mount operation timed out.

", - "refs": {} - }, - "ENILimitReachedException": { - "base": "

Lambda couldn't create an elastic network interface in the VPC, specified as part of Lambda function configuration, because the limit for network interfaces has been reached. For more information, see Lambda quotas.

", - "refs": {} - }, - "ENINotReadyException": { - "base": "

Lambda couldn't invoke the Lambda function because the elastic network interface (ENI) configured for its VPC connection isn't ready yet. Wait a few moments and try the request again. For more information about VPC configuration, see Configuring a Lambda function to access resources in a VPC.

", - "refs": {} - }, - "Enabled": { - "base": null, - "refs": { - "CreateEventSourceMappingRequest$Enabled": "

When true, the event source mapping is active. When false, Lambda pauses polling and invocation.

Default: True

", - "UpdateEventSourceMappingRequest$Enabled": "

When true, the event source mapping is active. When false, Lambda pauses polling and invocation.

Default: True

" - } - }, - "EndPointType": { - "base": null, - "refs": { - "Endpoints$key": null - } - }, - "Endpoint": { - "base": null, - "refs": { - "EndpointLists$member": null - } - }, - "EndpointLists": { - "base": null, - "refs": { - "Endpoints$value": null - } - }, - "Endpoints": { - "base": null, - "refs": { - "SelfManagedEventSource$Endpoints": "

The list of bootstrap servers for your Kafka brokers in the following format: \"KAFKA_BOOTSTRAP_SERVERS\": [\"abc.xyz.com:xxxx\",\"abc2.xyz.com:xxxx\"].

" - } - }, - "Environment": { - "base": "

A function's environment variable settings. You can use environment variables to adjust your function's behavior without updating code. An environment variable is a pair of strings that are stored in a function's version-specific configuration.

", - "refs": { - "CreateFunctionRequest$Environment": "

Environment variables that are accessible from function code during execution.

", - "UpdateFunctionConfigurationRequest$Environment": "

Environment variables that are accessible from function code during execution.

" - } - }, - "EnvironmentError": { - "base": "

Error messages for environment variables that couldn't be applied.

", - "refs": { - "EnvironmentResponse$Error": "

Error messages for environment variables that couldn't be applied.

" - } - }, - "EnvironmentResponse": { - "base": "

The results of an operation to update or read environment variables. If the operation succeeds, the response contains the environment variables. If it fails, the response contains details about the error.

", - "refs": { - "FunctionConfiguration$Environment": "

The function's environment variables. Omitted from CloudTrail logs.

" - } - }, - "EnvironmentVariableName": { - "base": null, - "refs": { - "EnvironmentVariables$key": null - } - }, - "EnvironmentVariableValue": { - "base": null, - "refs": { - "EnvironmentVariables$value": null - } - }, - "EnvironmentVariables": { - "base": null, - "refs": { - "Environment$Variables": "

Environment variable key-value pairs. For more information, see Using Lambda environment variables.

", - "EnvironmentResponse$Variables": "

Environment variable key-value pairs. Omitted from CloudTrail logs.

" - } - }, - "EphemeralStorage": { - "base": "

The size of the function's /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).

", - "refs": { - "CreateFunctionRequest$EphemeralStorage": "

The size of the function's /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).

", - "FunctionConfiguration$EphemeralStorage": "

The size of the function's /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).

", - "UpdateFunctionConfigurationRequest$EphemeralStorage": "

The size of the function's /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).

" - } - }, - "EphemeralStorageSize": { - "base": null, - "refs": { - "EphemeralStorage$Size": "

The size of the function's /tmp directory.

" - } - }, - "ErrorData": { - "base": null, - "refs": { - "ErrorObject$ErrorData": "

Machine-readable error data.

" - } - }, - "ErrorMessage": { - "base": null, - "refs": { - "ErrorObject$ErrorMessage": "

A human-readable error message.

" - } - }, - "ErrorObject": { - "base": "

An object that contains error information.

", - "refs": { - "CallbackDetails$Error": "

An error object that contains details about the failure.

", - "ChainedInvokeDetails$Error": "

Details about the chained invocation failure.

", - "ContextDetails$Error": "

Details about the context failure.

", - "EventError$Payload": "

The error payload.

", - "GetDurableExecutionResponse$Error": "

Error information if the durable execution failed. This field is only present when the execution status is FAILED, TIMED_OUT, or STOPPED. The combined size of all error fields is limited to 256 KB.

", - "OperationUpdate$Error": "

The error information for failed operations.

", - "SendDurableExecutionCallbackFailureRequest$Error": "

Error details describing why the callback operation failed.

", - "StepDetails$Error": "

Details about the step failure.

", - "StopDurableExecutionRequest$Error": "

Optional error details explaining why the execution is being stopped.

" - } - }, - "ErrorType": { - "base": null, - "refs": { - "ErrorObject$ErrorType": "

The error type.

" - } - }, - "Event": { - "base": "

An event that occurred during the execution of a durable function.

", - "refs": { - "Events$member": null - } - }, - "EventError": { - "base": "

Error information for an event.

", - "refs": { - "CallbackFailedDetails$Error": "

An error object that contains details about the failure.

", - "CallbackTimedOutDetails$Error": "

Details about the callback timeout.

", - "ChainedInvokeFailedDetails$Error": "

Details about the chained invocation failure.

", - "ChainedInvokeStoppedDetails$Error": "

Details about why the chained invocation stopped.

", - "ChainedInvokeTimedOutDetails$Error": "

Details about the chained invocation timeout.

", - "ContextFailedDetails$Error": "

Details about the context failure.

", - "ExecutionFailedDetails$Error": "

Details about the execution failure.

", - "ExecutionStoppedDetails$Error": "

Details about why the execution stopped.

", - "ExecutionTimedOutDetails$Error": "

Details about the execution timeout.

", - "InvocationCompletedDetails$Error": "

Details about the invocation failure.

", - "StepFailedDetails$Error": "

Details about the step failure.

", - "WaitCancelledDetails$Error": "

Details about why the wait operation was cancelled.

" - } - }, - "EventId": { - "base": null, - "refs": { - "Event$EventId": "

The unique identifier for this event. Event IDs increment sequentially.

" - } - }, - "EventInput": { - "base": "

Input information for an event.

", - "refs": { - "ChainedInvokeStartedDetails$Input": "

The JSON input payload provided to the chained invocation.

", - "ExecutionStartedDetails$Input": "

The input payload provided for the durable execution.

" - } - }, - "EventResult": { - "base": "

Result information for an event.

", - "refs": { - "CallbackSucceededDetails$Result": "

The response payload from the successful operation.

", - "ChainedInvokeSucceededDetails$Result": "

The response payload from the successful operation.

", - "ContextSucceededDetails$Result": "

The JSON response payload from the successful context.

", - "ExecutionSucceededDetails$Result": "

The response payload from the successful operation.

", - "StepSucceededDetails$Result": "

The response payload from the successful operation.

" - } - }, - "EventSourceMappingArn": { - "base": null, - "refs": { - "EventSourceMappingConfiguration$EventSourceMappingArn": "

The Amazon Resource Name (ARN) of the event source mapping.

" - } - }, - "EventSourceMappingConfiguration": { - "base": "

A mapping between an Amazon Web Services resource and a Lambda function. For details, see CreateEventSourceMapping.

", - "refs": { - "EventSourceMappingsList$member": null - } - }, - "EventSourceMappingLoggingConfig": { - "base": "

(Amazon MSK, and self-managed Apache Kafka only) The logging configuration for your event source. Use this configuration object to define the level of logs for your event source mapping.

", - "refs": { - "CreateEventSourceMappingRequest$LoggingConfig": "

(Amazon MSK, and self-managed Apache Kafka only) The logging configuration for your event source. For more information, see Event source mapping logging.

", - "EventSourceMappingConfiguration$LoggingConfig": "

(Amazon MSK, and self-managed Apache Kafka only) The logging configuration for your event source. For more information, see Event source mapping logging.

", - "UpdateEventSourceMappingRequest$LoggingConfig": null - } - }, - "EventSourceMappingMetric": { - "base": null, - "refs": { - "EventSourceMappingMetricList$member": null - } - }, - "EventSourceMappingMetricList": { - "base": null, - "refs": { - "EventSourceMappingMetricsConfig$Metrics": "

The metrics you want your event source mapping to produce, including EventCount, ErrorCount, KafkaMetrics.

  • EventCount to receive metrics related to the number of events processed by your event source mapping.

  • ErrorCount (Amazon MSK and self-managed Apache Kafka) to receive metrics related to the number of errors in your event source mapping processing.

  • KafkaMetrics (Amazon MSK and self-managed Apache Kafka) to receive metrics related to the Kafka consumers from your event source mapping.

For more information about these metrics, see Event source mapping metrics.

" - } - }, - "EventSourceMappingMetricsConfig": { - "base": "

The metrics configuration for your event source. Use this configuration object to define which metrics you want your event source mapping to produce.

", - "refs": { - "CreateEventSourceMappingRequest$MetricsConfig": "

The metrics configuration for your event source. For more information, see Event source mapping metrics.

", - "EventSourceMappingConfiguration$MetricsConfig": "

The metrics configuration for your event source. For more information, see Event source mapping metrics.

", - "UpdateEventSourceMappingRequest$MetricsConfig": "

The metrics configuration for your event source. For more information, see Event source mapping metrics.

" - } - }, - "EventSourceMappingSystemLogLevel": { - "base": null, - "refs": { - "EventSourceMappingLoggingConfig$SystemLogLevel": "

The log level you want your event source mapping to use. Lambda event poller only sends system logs at the selected level of detail and lower, where DEBUG is the highest level and WARN is the lowest. For more information about these metrics, see Event source mapping logging.

" - } - }, - "EventSourceMappingsList": { - "base": null, - "refs": { - "ListEventSourceMappingsResponse$EventSourceMappings": "

A list of event source mappings.

" - } - }, - "EventSourcePosition": { - "base": null, - "refs": { - "CreateEventSourceMappingRequest$StartingPosition": "

The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Stream event sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams, Amazon DocumentDB, Amazon MSK, and self-managed Apache Kafka.

", - "EventSourceMappingConfiguration$StartingPosition": "

The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Stream event sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams, Amazon DocumentDB, Amazon MSK, and self-managed Apache Kafka.

" - } - }, - "EventSourceToken": { - "base": null, - "refs": { - "AddPermissionRequest$EventSourceToken": "

For Alexa Smart Home functions, a token that the invoker must supply.

" - } - }, - "EventType": { - "base": null, - "refs": { - "Event$EventType": "

The type of event that occurred.

" - } - }, - "Events": { - "base": null, - "refs": { - "GetDurableExecutionHistoryResponse$Events": "

An array of execution history events, ordered chronologically unless ReverseOrder is set to true. Each event represents a significant occurrence during the execution, such as step completion or callback resolution.

" - } - }, - "Execution": { - "base": "

Information about a durable execution.

", - "refs": { - "DurableExecutions$member": null - } - }, - "ExecutionDataIncluded": { - "base": null, - "refs": { - "GetDurableExecutionResponse$ExecutionDataIncluded": "

Indicates whether execution data is included in this response. Returns false when IncludeExecutionData is set to false in the request.

" - } - }, - "ExecutionDetails": { - "base": "

Details about a durable execution.

", - "refs": { - "Operation$ExecutionDetails": "

Details about the execution, if this operation represents an execution.

" - } - }, - "ExecutionEnvironmentMemoryGiBPerVCpu": { - "base": null, - "refs": { - "LambdaManagedInstancesCapacityProviderConfig$ExecutionEnvironmentMemoryGiBPerVCpu": "

The amount of memory in GiB allocated per vCPU for execution environments.

" - } - }, - "ExecutionFailedDetails": { - "base": "

Details about a failed durable execution.

", - "refs": { - "Event$ExecutionFailedDetails": "

Details about an execution that failed.

" - } - }, - "ExecutionStartedDetails": { - "base": "

Details about a durable execution that started.

", - "refs": { - "Event$ExecutionStartedDetails": "

Details about an execution that started.

" - } - }, - "ExecutionStatus": { - "base": null, - "refs": { - "Execution$Status": "

The current status of the durable execution.

", - "ExecutionStatusList$member": null, - "GetDurableExecutionResponse$Status": "

The current status of the durable execution. Valid values are RUNNING, SUCCEEDED, FAILED, TIMED_OUT, and STOPPED.

" - } - }, - "ExecutionStatusList": { - "base": null, - "refs": { - "ListDurableExecutionsByFunctionRequest$Statuses": "

Filter executions by status. Valid values: RUNNING, SUCCEEDED, FAILED, TIMED_OUT, STOPPED.

" - } - }, - "ExecutionStoppedDetails": { - "base": "

Details about a durable execution that stopped.

", - "refs": { - "Event$ExecutionStoppedDetails": "

Details about an execution that was stopped.

" - } - }, - "ExecutionSucceededDetails": { - "base": "

Details about a durable execution that succeeded.

", - "refs": { - "Event$ExecutionSucceededDetails": "

Details about an execution that succeeded.

" - } - }, - "ExecutionTimedOutDetails": { - "base": "

Details about a durable execution that timed out.

", - "refs": { - "Event$ExecutionTimedOutDetails": "

Details about an execution that timed out.

" - } - }, - "ExecutionTimeout": { - "base": null, - "refs": { - "DurableConfig$ExecutionTimeout": "

The maximum time (in seconds) that a durable execution can run before timing out. This timeout applies to the entire durable execution, not individual function invocations.

" - } - }, - "ExecutionTimestamp": { - "base": null, - "refs": { - "Event$EventTimestamp": "

The date and time when this event occurred, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

", - "Execution$StartTimestamp": "

The date and time when the durable execution started, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

", - "Execution$EndTimestamp": "

The date and time when the durable execution ended, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

", - "GetDurableExecutionResponse$StartTimestamp": "

The date and time when the durable execution started, in Unix timestamp format.

", - "GetDurableExecutionResponse$EndTimestamp": "

The date and time when the durable execution ended, in Unix timestamp format. This field is only present if the execution has completed (status is SUCCEEDED, FAILED, TIMED_OUT, or STOPPED).

", - "InvocationCompletedDetails$StartTimestamp": "

The date and time when the invocation started, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

", - "InvocationCompletedDetails$EndTimestamp": "

The date and time when the invocation ended, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

", - "ListDurableExecutionsByFunctionRequest$StartedAfter": "

Filter executions that started after this timestamp (ISO 8601 format).

", - "ListDurableExecutionsByFunctionRequest$StartedBefore": "

Filter executions that started before this timestamp (ISO 8601 format).

", - "Operation$StartTimestamp": "

The date and time when the operation started, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

", - "Operation$EndTimestamp": "

The date and time when the operation ended, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

", - "StepDetails$NextAttemptTimestamp": "

The date and time when the next attempt is scheduled, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD). Only populated when the step is in a pending state.

", - "StopDurableExecutionResponse$StopTimestamp": "

The timestamp when the execution was stopped (ISO 8601 format).

", - "WaitDetails$ScheduledEndTimestamp": "

The date and time when the wait operation is scheduled to complete, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

", - "WaitStartedDetails$ScheduledEndTimestamp": "

The date and time when the wait operation is scheduled to complete, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" - } - }, - "FileSystemArn": { - "base": null, - "refs": { - "FileSystemConfig$Arn": "

The Amazon Resource Name (ARN) of the Amazon EFS or Amazon S3 Files access point that provides access to the file system.

" - } - }, - "FileSystemConfig": { - "base": "

Details about the connection between a Lambda function and an Amazon EFS file system or an Amazon S3 Files file system.

", - "refs": { - "FileSystemConfigList$member": null - } - }, - "FileSystemConfigList": { - "base": null, - "refs": { - "CreateFunctionRequest$FileSystemConfigs": "

Connection settings for an Amazon EFS file system or an Amazon S3 Files file system.

", - "FunctionConfiguration$FileSystemConfigs": "

Connection settings for an Amazon EFS file system or an Amazon S3 Files file system.

", - "UpdateFunctionConfigurationRequest$FileSystemConfigs": "

Connection settings for an Amazon EFS file system or an Amazon S3 Files file system.

" - } - }, - "Filter": { - "base": "

A structure within a FilterCriteria object that defines an event filtering pattern.

", - "refs": { - "FilterList$member": null - } - }, - "FilterCriteria": { - "base": "

An object that contains the filters for an event source.

", - "refs": { - "CreateEventSourceMappingRequest$FilterCriteria": "

An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.

", - "EventSourceMappingConfiguration$FilterCriteria": "

An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.

If filter criteria is encrypted, this field shows up as null in the response of ListEventSourceMapping API calls. You can view this field in plaintext in the response of GetEventSourceMapping and DeleteEventSourceMapping calls if you have kms:Decrypt permissions for the correct KMS key.

", - "UpdateEventSourceMappingRequest$FilterCriteria": "

An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.

" - } - }, - "FilterCriteriaError": { - "base": "

An object that contains details about an error related to filter criteria encryption.

", - "refs": { - "EventSourceMappingConfiguration$FilterCriteriaError": "

An object that contains details about an error related to filter criteria encryption.

" - } - }, - "FilterCriteriaErrorCode": { - "base": null, - "refs": { - "FilterCriteriaError$ErrorCode": "

The KMS exception that resulted from filter criteria encryption or decryption.

" - } - }, - "FilterCriteriaErrorMessage": { - "base": null, - "refs": { - "FilterCriteriaError$Message": "

The error message.

" - } - }, - "FilterList": { - "base": null, - "refs": { - "FilterCriteria$Filters": "

A list of filters.

" - } - }, - "FullDocument": { - "base": null, - "refs": { - "DocumentDBEventSourceConfig$FullDocument": "

Determines what DocumentDB sends to your event stream during document update operations. If set to UpdateLookup, DocumentDB sends a delta describing the changes, along with a copy of the entire document. Otherwise, DocumentDB sends only a partial document that contains the changes.

" - } - }, - "FunctionArn": { - "base": null, - "refs": { - "AliasConfiguration$AliasArn": "

The Amazon Resource Name (ARN) of the alias.

", - "CreateFunctionUrlConfigResponse$FunctionArn": "

The Amazon Resource Name (ARN) of your function.

", - "EventSourceMappingConfiguration$FunctionArn": "

The ARN of the Lambda function.

", - "FunctionArnList$member": null, - "FunctionConfiguration$MasterArn": "

For Lambda@Edge functions, the ARN of the main function.

", - "FunctionEventInvokeConfig$FunctionArn": "

The Amazon Resource Name (ARN) of the function.

", - "FunctionUrlConfig$FunctionArn": "

The Amazon Resource Name (ARN) of your function.

", - "GetFunctionScalingConfigResponse$FunctionArn": "

The Amazon Resource Name (ARN) of the function.

", - "GetFunctionUrlConfigResponse$FunctionArn": "

The Amazon Resource Name (ARN) of your function.

", - "ProvisionedConcurrencyConfigListItem$FunctionArn": "

The Amazon Resource Name (ARN) of the alias or version.

", - "PutRuntimeManagementConfigResponse$FunctionArn": "

The ARN of the function

", - "UpdateFunctionUrlConfigResponse$FunctionArn": "

The Amazon Resource Name (ARN) of your function.

" - } - }, - "FunctionArnList": { - "base": null, - "refs": { - "ListFunctionsByCodeSigningConfigResponse$FunctionArns": "

The function ARNs.

" - } - }, - "FunctionCode": { - "base": "

The code for the Lambda function. You can either specify an object in Amazon S3, upload a .zip file archive deployment package directly, or specify the URI of a container image.

", - "refs": { - "CreateFunctionRequest$Code": "

The code for the function.

" - } - }, - "FunctionCodeLocation": { - "base": "

Details about a function's deployment package.

", - "refs": { - "GetFunctionResponse$Code": "

The deployment package of the function or version.

" - } - }, - "FunctionCodeLocationError": { - "base": "

Contains details about an error that occurred when Lambda attempted to retrieve a function's deployment package.

", - "refs": { - "FunctionCodeLocation$Error": "

An object that contains details about an error related to function deployment package retrieval.

" - } - }, - "FunctionConfiguration": { - "base": "

Details about a function's configuration.

", - "refs": { - "FunctionList$member": null, - "GetFunctionResponse$Configuration": "

The configuration of the function or version.

" - } - }, - "FunctionEventInvokeConfig": { - "base": null, - "refs": { - "FunctionEventInvokeConfigList$member": null - } - }, - "FunctionEventInvokeConfigList": { - "base": null, - "refs": { - "ListFunctionEventInvokeConfigsResponse$FunctionEventInvokeConfigs": "

A list of configurations.

" - } - }, - "FunctionList": { - "base": null, - "refs": { - "ListFunctionsResponse$Functions": "

A list of Lambda functions.

", - "ListVersionsByFunctionResponse$Versions": "

A list of Lambda function versions.

" - } - }, - "FunctionName": { - "base": null, - "refs": { - "CreateAliasRequest$FunctionName": "

The name or ARN of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "CreateFunctionRequest$FunctionName": "

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "DeleteAliasRequest$FunctionName": "

The name or ARN of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "DeleteFunctionConcurrencyRequest$FunctionName": "

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "DeleteProvisionedConcurrencyConfigRequest$FunctionName": "

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "GetAliasRequest$FunctionName": "

The name or ARN of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "GetFunctionCodeSigningConfigResponse$FunctionName": "

The name or ARN of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "GetFunctionConcurrencyRequest$FunctionName": "

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "GetProvisionedConcurrencyConfigRequest$FunctionName": "

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "ListAliasesRequest$FunctionName": "

The name or ARN of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "ListProvisionedConcurrencyConfigsRequest$FunctionName": "

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "PublishVersionRequest$FunctionName": "

The name or ARN of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "PutFunctionCodeSigningConfigResponse$FunctionName": "

The name or ARN of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "PutFunctionConcurrencyRequest$FunctionName": "

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "PutProvisionedConcurrencyConfigRequest$FunctionName": "

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "UpdateAliasRequest$FunctionName": "

The name or ARN of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "UpdateFunctionCodeRequest$FunctionName": "

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "UpdateFunctionConfigurationRequest$FunctionName": "

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

" - } - }, - "FunctionResponseType": { - "base": null, - "refs": { - "FunctionResponseTypeList$member": null - } - }, - "FunctionResponseTypeList": { - "base": null, - "refs": { - "CreateEventSourceMappingRequest$FunctionResponseTypes": "

(Kinesis, DynamoDB Streams, Amazon MSK, self-managed Apache Kafka, and Amazon SQS) A list of current response type enums applied to the event source mapping.

", - "EventSourceMappingConfiguration$FunctionResponseTypes": "

(Kinesis, DynamoDB Streams, Amazon MSK, self-managed Apache Kafka, and Amazon SQS) A list of current response type enums applied to the event source mapping.

", - "UpdateEventSourceMappingRequest$FunctionResponseTypes": "

(Kinesis, DynamoDB Streams, Amazon MSK, self-managed Apache Kafka, and Amazon SQS) A list of current response type enums applied to the event source mapping.

" - } - }, - "FunctionScalingConfig": { - "base": "

Configuration that defines the scaling behavior for a Lambda Managed Instances function, including the minimum and maximum number of execution environments that can be provisioned.

", - "refs": { - "GetFunctionScalingConfigResponse$AppliedFunctionScalingConfig": "

The scaling configuration that is currently applied to the function. This represents the actual scaling settings in effect.

", - "GetFunctionScalingConfigResponse$RequestedFunctionScalingConfig": "

The scaling configuration that was requested for the function.

", - "PutFunctionScalingConfigRequest$FunctionScalingConfig": "

The scaling configuration to apply to the function, including minimum and maximum execution environment limits.

" - } - }, - "FunctionScalingConfigExecutionEnvironments": { - "base": null, - "refs": { - "FunctionScalingConfig$MinExecutionEnvironments": "

The minimum number of execution environments to maintain for the function.

", - "FunctionScalingConfig$MaxExecutionEnvironments": "

The maximum number of execution environments that can be provisioned for the function.

" - } - }, - "FunctionUrl": { - "base": null, - "refs": { - "CreateFunctionUrlConfigResponse$FunctionUrl": "

The HTTP URL endpoint for your function.

", - "FunctionUrlConfig$FunctionUrl": "

The HTTP URL endpoint for your function.

", - "GetFunctionUrlConfigResponse$FunctionUrl": "

The HTTP URL endpoint for your function.

", - "UpdateFunctionUrlConfigResponse$FunctionUrl": "

The HTTP URL endpoint for your function.

" - } - }, - "FunctionUrlAuthType": { - "base": null, - "refs": { - "AddPermissionRequest$FunctionUrlAuthType": "

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Control access to Lambda function URLs.

", - "CreateFunctionUrlConfigRequest$AuthType": "

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Control access to Lambda function URLs.

", - "CreateFunctionUrlConfigResponse$AuthType": "

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Control access to Lambda function URLs.

", - "FunctionUrlConfig$AuthType": "

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Security and auth model for Lambda function URLs.

", - "GetFunctionUrlConfigResponse$AuthType": "

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Control access to Lambda function URLs.

", - "UpdateFunctionUrlConfigRequest$AuthType": "

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Control access to Lambda function URLs.

", - "UpdateFunctionUrlConfigResponse$AuthType": "

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Control access to Lambda function URLs.

" - } - }, - "FunctionUrlConfig": { - "base": "

Details about a Lambda function URL.

", - "refs": { - "FunctionUrlConfigList$member": null - } - }, - "FunctionUrlConfigList": { - "base": null, - "refs": { - "ListFunctionUrlConfigsResponse$FunctionUrlConfigs": "

A list of function URL configurations.

" - } - }, - "FunctionUrlFunctionName": { - "base": null, - "refs": { - "CreateFunctionUrlConfigRequest$FunctionName": "

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "DeleteFunctionUrlConfigRequest$FunctionName": "

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "GetFunctionUrlConfigRequest$FunctionName": "

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "ListFunctionUrlConfigsRequest$FunctionName": "

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "UpdateFunctionUrlConfigRequest$FunctionName": "

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

" - } - }, - "FunctionUrlQualifier": { - "base": null, - "refs": { - "CreateFunctionUrlConfigRequest$Qualifier": "

The alias name.

", - "DeleteFunctionUrlConfigRequest$Qualifier": "

The alias name.

", - "GetFunctionUrlConfigRequest$Qualifier": "

The alias name.

", - "UpdateFunctionUrlConfigRequest$Qualifier": "

The alias name.

" - } - }, - "FunctionVersion": { - "base": null, - "refs": { - "ListFunctionsRequest$FunctionVersion": "

Set to ALL to include entries for all published versions of each function.

" - } - }, - "FunctionVersionLatestPublished": { - "base": null, - "refs": { - "CreateFunctionRequest$PublishTo": "

Specifies where to publish the function version or configuration.

", - "PublishVersionRequest$PublishTo": "

Specifies where to publish the function version or configuration.

", - "UpdateFunctionCodeRequest$PublishTo": "

Specifies where to publish the function version or configuration.

" - } - }, - "FunctionVersionsByCapacityProviderList": { - "base": null, - "refs": { - "ListFunctionVersionsByCapacityProviderResponse$FunctionVersions": "

A list of function versions that use the specified capacity provider.

" - } - }, - "FunctionVersionsByCapacityProviderListItem": { - "base": "

Information about a function version that uses a specific capacity provider, including its ARN and current state.

", - "refs": { - "FunctionVersionsByCapacityProviderList$member": null - } - }, - "FunctionVersionsPerCapacityProviderLimitExceededException": { - "base": "

The maximum number of function versions that can be associated with a single capacity provider has been exceeded. For more information, see Lambda quotas.

", - "refs": {} - }, - "GetAccountSettingsRequest": { - "base": null, - "refs": {} - }, - "GetAccountSettingsResponse": { - "base": null, - "refs": {} - }, - "GetAliasRequest": { - "base": null, - "refs": {} - }, - "GetCapacityProviderRequest": { - "base": null, - "refs": {} - }, - "GetCapacityProviderResponse": { - "base": null, - "refs": {} - }, - "GetCodeSigningConfigRequest": { - "base": null, - "refs": {} - }, - "GetCodeSigningConfigResponse": { - "base": null, - "refs": {} - }, - "GetDurableExecutionHistoryRequest": { - "base": null, - "refs": {} - }, - "GetDurableExecutionHistoryResponse": { - "base": "

The response from the GetDurableExecutionHistory operation, containing the execution history and events.

", - "refs": {} - }, - "GetDurableExecutionRequest": { - "base": null, - "refs": {} - }, - "GetDurableExecutionResponse": { - "base": "

The response from the GetDurableExecution operation, containing detailed information about the durable execution.

", - "refs": {} - }, - "GetDurableExecutionStateRequest": { - "base": null, - "refs": {} - }, - "GetDurableExecutionStateResponse": { - "base": "

The response from the GetDurableExecutionState operation, containing the current execution state for replay.

", - "refs": {} - }, - "GetEventSourceMappingRequest": { - "base": null, - "refs": {} - }, - "GetFunctionCodeSigningConfigRequest": { - "base": null, - "refs": {} - }, - "GetFunctionCodeSigningConfigResponse": { - "base": null, - "refs": {} - }, - "GetFunctionConcurrencyRequest": { - "base": null, - "refs": {} - }, - "GetFunctionConcurrencyResponse": { - "base": null, - "refs": {} - }, - "GetFunctionConfigurationRequest": { - "base": null, - "refs": {} - }, - "GetFunctionEventInvokeConfigRequest": { - "base": null, - "refs": {} - }, - "GetFunctionRecursionConfigRequest": { - "base": null, - "refs": {} - }, - "GetFunctionRecursionConfigResponse": { - "base": null, - "refs": {} - }, - "GetFunctionRequest": { - "base": null, - "refs": {} - }, - "GetFunctionResponse": { - "base": null, - "refs": {} - }, - "GetFunctionScalingConfigRequest": { - "base": null, - "refs": {} - }, - "GetFunctionScalingConfigResponse": { - "base": null, - "refs": {} - }, - "GetFunctionUrlConfigRequest": { - "base": null, - "refs": {} - }, - "GetFunctionUrlConfigResponse": { - "base": null, - "refs": {} - }, - "GetLayerVersionByArnRequest": { - "base": null, - "refs": {} - }, - "GetLayerVersionPolicyRequest": { - "base": null, - "refs": {} - }, - "GetLayerVersionPolicyResponse": { - "base": null, - "refs": {} - }, - "GetLayerVersionRequest": { - "base": null, - "refs": {} - }, - "GetLayerVersionResponse": { - "base": null, - "refs": {} - }, - "GetPolicyRequest": { - "base": null, - "refs": {} - }, - "GetPolicyResponse": { - "base": null, - "refs": {} - }, - "GetProvisionedConcurrencyConfigRequest": { - "base": null, - "refs": {} - }, - "GetProvisionedConcurrencyConfigResponse": { - "base": null, - "refs": {} - }, - "GetRuntimeManagementConfigRequest": { - "base": null, - "refs": {} - }, - "GetRuntimeManagementConfigResponse": { - "base": null, - "refs": {} - }, - "Handler": { - "base": null, - "refs": { - "CreateFunctionRequest$Handler": "

The name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Lambda programming model.

", - "FunctionConfiguration$Handler": "

The function that Lambda calls to begin running your function.

", - "UpdateFunctionConfigurationRequest$Handler": "

The name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Lambda programming model.

" - } - }, - "Header": { - "base": null, - "refs": { - "HeadersList$member": null - } - }, - "HeadersList": { - "base": null, - "refs": { - "Cors$AllowHeaders": "

The HTTP headers that origins can include in requests to your function URL. For example: Date, Keep-Alive, X-Custom-Header.

", - "Cors$ExposeHeaders": "

The HTTP headers in your function response that you want to expose to origins that call your function URL. For example: Date, Keep-Alive, X-Custom-Header.

" - } - }, - "HttpStatus": { - "base": null, - "refs": { - "InvokeAsyncResponse$Status": "

The status code.

" - } - }, - "ImageConfig": { - "base": "

Configuration values that override the container image Dockerfile settings. For more information, see Container image settings.

", - "refs": { - "CreateFunctionRequest$ImageConfig": "

Container image configuration values that override the values in the container image Dockerfile.

", - "ImageConfigResponse$ImageConfig": "

Configuration values that override the container image Dockerfile.

", - "UpdateFunctionConfigurationRequest$ImageConfig": "

Container image configuration values that override the values in the container image Docker file.

" - } - }, - "ImageConfigError": { - "base": "

Error response to GetFunctionConfiguration.

", - "refs": { - "ImageConfigResponse$Error": "

Error response to GetFunctionConfiguration.

" - } - }, - "ImageConfigResponse": { - "base": "

Response to a GetFunctionConfiguration request.

", - "refs": { - "FunctionConfiguration$ImageConfigResponse": "

The function's image configuration values.

" - } - }, - "IncludeExecutionData": { - "base": null, - "refs": { - "GetDurableExecutionHistoryRequest$IncludeExecutionData": "

Specifies whether to include execution data such as step results and callback payloads in the history events. Set to true to include data, or false to exclude it for a more compact response. The default is true.

", - "GetDurableExecutionRequest$IncludeExecutionData": "

Specifies whether to include execution data such as input payload, result, and error information in the response. Set to false for a more compact response that includes only execution metadata. The default value is set to true.

" - } - }, - "InputPayload": { - "base": null, - "refs": { - "EventInput$Payload": "

The input payload.

", - "ExecutionDetails$InputPayload": "

The original input payload provided for the durable execution.

", - "GetDurableExecutionResponse$InputPayload": "

The JSON input payload that was provided when the durable execution was started. For asynchronous invocations, this is limited to 256 KB. For synchronous invocations, this can be up to 6 MB.

" - } - }, - "InstanceRequirements": { - "base": "

Specifications that define the characteristics and constraints for compute instances used by the capacity provider.

", - "refs": { - "CapacityProvider$InstanceRequirements": "

The instance requirements for compute resources managed by the capacity provider.

", - "CreateCapacityProviderRequest$InstanceRequirements": "

The instance requirements that specify the compute instance characteristics, including architectures and allowed or excluded instance types.

" - } - }, - "InstanceType": { - "base": null, - "refs": { - "InstanceTypeSet$member": null - } - }, - "InstanceTypeSet": { - "base": null, - "refs": { - "InstanceRequirements$AllowedInstanceTypes": "

A list of EC2 instance types that the capacity provider is allowed to use. If not specified, all compatible instance types are allowed.

", - "InstanceRequirements$ExcludedInstanceTypes": "

A list of EC2 instance types that the capacity provider should not use, even if they meet other requirements.

" - } - }, - "Integer": { - "base": null, - "refs": { - "AccountLimit$ConcurrentExecutions": "

The maximum number of simultaneous function executions.

", - "DeleteFunctionResponse$StatusCode": "

The HTTP status code returned by the operation.

", - "InvocationResponse$StatusCode": "

The HTTP status code is in the 200 range for a successful request. For the RequestResponse invocation type, this status code is 200. For the Event invocation type, this status code is 202. For the DryRun invocation type, the status code is 204.

", - "InvokeWithResponseStreamResponse$StatusCode": "

For a successful request, the HTTP status code is in the 200 range. For the RequestResponse invocation type, this status code is 200. For the DryRun invocation type, this status code is 204.

" - } - }, - "InvalidCodeSignatureException": { - "base": "

The code signature failed the integrity check. If the integrity check fails, then Lambda blocks deployment, even if the code signing policy is set to WARN.

", - "refs": {} - }, - "InvalidParameterValueException": { - "base": "

One of the parameters in the request is not valid.

", - "refs": {} - }, - "InvalidRequestContentException": { - "base": "

The request body could not be parsed as JSON, or a request header is invalid. For example, the 'x-amzn-RequestId' header is not a valid UUID string.

", - "refs": {} - }, - "InvalidRuntimeException": { - "base": "

The runtime or runtime version specified is not supported.

", - "refs": {} - }, - "InvalidSecurityGroupIDException": { - "base": "

The security group ID provided in the Lambda function VPC configuration is not valid.

", - "refs": {} - }, - "InvalidSubnetIDException": { - "base": "

The subnet ID provided in the Lambda function VPC configuration is not valid.

", - "refs": {} - }, - "InvalidZipFileException": { - "base": "

Lambda could not unzip the deployment package.

", - "refs": {} - }, - "InvocationCompletedDetails": { - "base": "

Details about a function invocation that completed.

", - "refs": { - "Event$InvocationCompletedDetails": "

Details about a function invocation that completed.

" - } - }, - "InvocationRequest": { - "base": null, - "refs": {} - }, - "InvocationResponse": { - "base": null, - "refs": {} - }, - "InvocationType": { - "base": null, - "refs": { - "InvocationRequest$InvocationType": "

Choose from the following options.

  • RequestResponse (default) – Invoke the function synchronously. Keep the connection open until the function returns a response or times out. The API response includes the function response and additional data.

  • Event – Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if one is configured). The API response only includes a status code.

  • DryRun – Validate parameter values and verify that the user or role has permission to invoke the function.

" - } - }, - "InvokeAsyncRequest": { - "base": null, - "refs": {} - }, - "InvokeAsyncResponse": { - "base": "

A success response (202 Accepted) indicates that the request is queued for invocation.

", - "refs": {} - }, - "InvokeMode": { - "base": null, - "refs": { - "CreateFunctionUrlConfigRequest$InvokeMode": "

Use one of the following options:

  • BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.

  • RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 200 MB.

", - "CreateFunctionUrlConfigResponse$InvokeMode": "

Use one of the following options:

  • BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.

  • RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 200 MB.

", - "FunctionUrlConfig$InvokeMode": "

Use one of the following options:

  • BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.

  • RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 200 MB.

", - "GetFunctionUrlConfigResponse$InvokeMode": "

Use one of the following options:

  • BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.

  • RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 200 MB.

", - "UpdateFunctionUrlConfigRequest$InvokeMode": "

Use one of the following options:

  • BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.

  • RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 200 MB.

", - "UpdateFunctionUrlConfigResponse$InvokeMode": "

Use one of the following options:

  • BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.

  • RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 200 MB.

" - } - }, - "InvokeResponseStreamUpdate": { - "base": "

A chunk of the streamed response payload.

", - "refs": { - "InvokeWithResponseStreamResponseEvent$PayloadChunk": "

A chunk of the streamed response payload.

" - } - }, - "InvokeWithResponseStreamCompleteEvent": { - "base": "

A response confirming that the event stream is complete.

", - "refs": { - "InvokeWithResponseStreamResponseEvent$InvokeComplete": "

An object that's returned when the stream has ended and all the payload chunks have been returned.

" - } - }, - "InvokeWithResponseStreamRequest": { - "base": null, - "refs": {} - }, - "InvokeWithResponseStreamResponse": { - "base": null, - "refs": {} - }, - "InvokeWithResponseStreamResponseEvent": { - "base": "

An object that includes a chunk of the response payload. When the stream has ended, Lambda includes a InvokeComplete object.

", - "refs": { - "InvokeWithResponseStreamResponse$EventStream": "

The stream of response payloads.

" - } - }, - "InvokedViaFunctionUrl": { - "base": null, - "refs": { - "AddPermissionRequest$InvokedViaFunctionUrl": "

Indicates whether the permission applies when the function is invoked through a function URL.

" - } - }, - "ItemCount": { - "base": null, - "refs": { - "GetDurableExecutionHistoryRequest$MaxItems": "

The maximum number of history events to return per call. You can use Marker to retrieve additional pages of results. The default is 100 and the maximum allowed is 1000. A value of 0 uses the default.

", - "GetDurableExecutionStateRequest$MaxItems": "

The maximum number of operations to return per call. You can use Marker to retrieve additional pages of results. The default is 100 and the maximum allowed is 1000. A value of 0 uses the default.

", - "ListDurableExecutionsByFunctionRequest$MaxItems": "

Maximum number of executions to return (1-1000). Default is 100.

" - } - }, - "KMSAccessDeniedException": { - "base": "

Lambda couldn't decrypt the environment variables because KMS access was denied. Check the Lambda function's KMS permissions.

", - "refs": {} - }, - "KMSDisabledException": { - "base": "

Lambda couldn't decrypt the environment variables because the KMS key used is disabled. Check the Lambda function's KMS key settings.

", - "refs": {} - }, - "KMSInvalidStateException": { - "base": "

Lambda couldn't decrypt the environment variables because the state of the KMS key used is not valid for Decrypt. Check the function's KMS key settings.

", - "refs": {} - }, - "KMSKeyArn": { - "base": null, - "refs": { - "CapacityProvider$KmsKeyArn": "

The ARN of the KMS key used to encrypt the capacity provider's resources.

", - "CreateEventSourceMappingRequest$KMSKeyArn": "

The ARN of the Key Management Service (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria. By default, Lambda does not encrypt your filter criteria object. Specify this property to encrypt data using your own customer managed key.

", - "CreateFunctionRequest$KMSKeyArn": "

The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt the following resources:

  • The function's environment variables.

  • The function's Lambda SnapStart snapshots.

  • When used with SourceKMSKeyArn, the unzipped version of the .zip deployment package that's used for function invocations. For more information, see Specifying a customer managed key for Lambda.

  • The optimized version of the container image that's used for function invocations. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). For more information, see Function lifecycle.

If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key or an Amazon Web Services managed key.

", - "DurableConfig$KMSKeyArn": "

The ARN of the Key Management Service (KMS) customer managed key that is used to encrypt your durable execution's payload data, including input, output, and error payloads.

", - "EventSourceMappingConfiguration$KMSKeyArn": "

The ARN of the Key Management Service (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria.

", - "Execution$KMSKeyArn": "

The ARN of the Key Management Service (KMS) customer managed key that is used to encrypt your durable execution's payload data, including input, output, and error payloads.

", - "FunctionCode$SourceKMSKeyArn": "

The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt your function's .zip deployment package. If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key.

", - "FunctionCodeLocation$SourceKMSKeyArn": "

The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt your function's .zip deployment package. If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key.

", - "FunctionConfiguration$KMSKeyArn": "

The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt the following resources:

  • The function's environment variables.

  • The function's Lambda SnapStart snapshots.

  • When used with SourceKMSKeyArn, the unzipped version of the .zip deployment package that's used for function invocations. For more information, see Specifying a customer managed key for Lambda.

  • The optimized version of the container image that's used for function invocations. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). For more information, see Function lifecycle.

If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key or an Amazon Web Services managed key.

", - "UpdateEventSourceMappingRequest$KMSKeyArn": "

The ARN of the Key Management Service (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria. By default, Lambda does not encrypt your filter criteria object. Specify this property to encrypt data using your own customer managed key.

", - "UpdateFunctionCodeRequest$SourceKMSKeyArn": "

The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt your function's .zip deployment package. If you don't provide a customer managed key, Lambda uses an Amazon Web Services managed key.

", - "UpdateFunctionConfigurationRequest$KMSKeyArn": "

The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt the following resources:

  • The function's environment variables.

  • The function's Lambda SnapStart snapshots.

  • When used with SourceKMSKeyArn, the unzipped version of the .zip deployment package that's used for function invocations. For more information, see Specifying a customer managed key for Lambda.

  • The optimized version of the container image that's used for function invocations. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). For more information, see Function lifecycle.

If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key or an Amazon Web Services managed key.

" - } - }, - "KMSKeyArnNonEmpty": { - "base": null, - "refs": { - "CreateCapacityProviderRequest$KmsKeyArn": "

The ARN of the KMS key used to encrypt data associated with the capacity provider.

" - } - }, - "KMSNotFoundException": { - "base": "

Lambda couldn't decrypt the environment variables because the KMS key was not found. Check the function's KMS key settings.

", - "refs": {} - }, - "KafkaSchemaRegistryAccessConfig": { - "base": "

Specific access configuration settings that tell Lambda how to authenticate with your schema registry.

If you're working with an Glue schema registry, don't provide authentication details in this object. Instead, ensure that your execution role has the required permissions for Lambda to access your cluster.

If you're working with a Confluent schema registry, choose the authentication method in the Type field, and provide the Secrets Manager secret ARN in the URI field.

", - "refs": { - "KafkaSchemaRegistryAccessConfigList$member": null - } - }, - "KafkaSchemaRegistryAccessConfigList": { - "base": null, - "refs": { - "KafkaSchemaRegistryConfig$AccessConfigs": "

An array of access configuration objects that tell Lambda how to authenticate with your schema registry.

" - } - }, - "KafkaSchemaRegistryAuthType": { - "base": null, - "refs": { - "KafkaSchemaRegistryAccessConfig$Type": "

The type of authentication Lambda uses to access your schema registry.

" - } - }, - "KafkaSchemaRegistryConfig": { - "base": "

Specific configuration settings for a Kafka schema registry.

", - "refs": { - "AmazonManagedKafkaEventSourceConfig$SchemaRegistryConfig": "

Specific configuration settings for a Kafka schema registry.

", - "SelfManagedKafkaEventSourceConfig$SchemaRegistryConfig": "

Specific configuration settings for a Kafka schema registry.

" - } - }, - "KafkaSchemaValidationAttribute": { - "base": null, - "refs": { - "KafkaSchemaValidationConfig$Attribute": "

The attributes you want your schema registry to validate and filter for. If you selected JSON as the EventRecordFormat, Lambda also deserializes the selected message attributes.

" - } - }, - "KafkaSchemaValidationConfig": { - "base": "

Specific schema validation configuration settings that tell Lambda the message attributes you want to validate and filter using your schema registry.

", - "refs": { - "KafkaSchemaValidationConfigList$member": null - } - }, - "KafkaSchemaValidationConfigList": { - "base": null, - "refs": { - "KafkaSchemaRegistryConfig$SchemaValidationConfigs": "

An array of schema validation configuration objects, which tell Lambda the message attributes you want to validate and filter using your schema registry.

" - } - }, - "LambdaManagedInstancesCapacityProviderConfig": { - "base": "

Configuration for Lambda-managed instances used by the capacity provider.

", - "refs": { - "CapacityProviderConfig$LambdaManagedInstancesCapacityProviderConfig": "

Configuration for Lambda-managed instances used by the capacity provider.

" - } - }, - "LastUpdateStatus": { - "base": null, - "refs": { - "FunctionConfiguration$LastUpdateStatus": "

The status of the last update that was performed on the function. This is first set to Successful after function creation completes.

" - } - }, - "LastUpdateStatusReason": { - "base": null, - "refs": { - "FunctionConfiguration$LastUpdateStatusReason": "

The reason for the last update that was performed on the function.

" - } - }, - "LastUpdateStatusReasonCode": { - "base": null, - "refs": { - "FunctionConfiguration$LastUpdateStatusReasonCode": "

The reason code for the last update that was performed on the function.

" - } - }, - "Layer": { - "base": "

An Lambda layer.

", - "refs": { - "LayersReferenceList$member": null - } - }, - "LayerArn": { - "base": null, - "refs": { - "GetLayerVersionResponse$LayerArn": "

The ARN of the layer.

", - "LayersListItem$LayerArn": "

The Amazon Resource Name (ARN) of the function layer.

", - "PublishLayerVersionResponse$LayerArn": "

The ARN of the layer.

" - } - }, - "LayerList": { - "base": null, - "refs": { - "CreateFunctionRequest$Layers": "

A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.

", - "UpdateFunctionConfigurationRequest$Layers": "

A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.

" - } - }, - "LayerName": { - "base": null, - "refs": { - "AddLayerVersionPermissionRequest$LayerName": "

The name or Amazon Resource Name (ARN) of the layer.

", - "DeleteLayerVersionRequest$LayerName": "

The name or Amazon Resource Name (ARN) of the layer.

", - "GetLayerVersionPolicyRequest$LayerName": "

The name or Amazon Resource Name (ARN) of the layer.

", - "GetLayerVersionRequest$LayerName": "

The name or Amazon Resource Name (ARN) of the layer.

", - "LayersListItem$LayerName": "

The name of the layer.

", - "ListLayerVersionsRequest$LayerName": "

The name or Amazon Resource Name (ARN) of the layer.

", - "PublishLayerVersionRequest$LayerName": "

The name or Amazon Resource Name (ARN) of the layer.

", - "RemoveLayerVersionPermissionRequest$LayerName": "

The name or Amazon Resource Name (ARN) of the layer.

" - } - }, - "LayerPermissionAllowedAction": { - "base": null, - "refs": { - "AddLayerVersionPermissionRequest$Action": "

The API action that grants access to the layer. For example, lambda:GetLayerVersion.

" - } - }, - "LayerPermissionAllowedPrincipal": { - "base": null, - "refs": { - "AddLayerVersionPermissionRequest$Principal": "

An account ID, or * to grant layer usage permission to all accounts in an organization, or all Amazon Web Services accounts (if organizationId is not specified). For the last case, make sure that you really do want all Amazon Web Services accounts to have usage permission to this layer.

" - } - }, - "LayerVersionArn": { - "base": null, - "refs": { - "GetLayerVersionByArnRequest$Arn": "

The ARN of the layer version.

", - "GetLayerVersionResponse$LayerVersionArn": "

The ARN of the layer version.

", - "Layer$Arn": "

The Amazon Resource Name (ARN) of the function layer.

", - "LayerList$member": null, - "LayerVersionsListItem$LayerVersionArn": "

The ARN of the layer version.

", - "PublishLayerVersionResponse$LayerVersionArn": "

The ARN of the layer version.

" - } - }, - "LayerVersionContentInput": { - "base": "

A ZIP archive that contains the contents of an Lambda layer. You can specify either an Amazon S3 location, or upload a layer archive directly.

", - "refs": { - "PublishLayerVersionRequest$Content": "

The function layer archive.

" - } - }, - "LayerVersionContentOutput": { - "base": "

Details about a version of an Lambda layer.

", - "refs": { - "GetLayerVersionResponse$Content": "

Details about the layer version.

", - "PublishLayerVersionResponse$Content": "

Details about the layer version.

" - } - }, - "LayerVersionNumber": { - "base": null, - "refs": { - "AddLayerVersionPermissionRequest$VersionNumber": "

The version number.

", - "DeleteLayerVersionRequest$VersionNumber": "

The version number.

", - "GetLayerVersionPolicyRequest$VersionNumber": "

The version number.

", - "GetLayerVersionRequest$VersionNumber": "

The version number.

", - "GetLayerVersionResponse$Version": "

The version number.

", - "LayerVersionsListItem$Version": "

The version number.

", - "PublishLayerVersionResponse$Version": "

The version number.

", - "RemoveLayerVersionPermissionRequest$VersionNumber": "

The version number.

" - } - }, - "LayerVersionsList": { - "base": null, - "refs": { - "ListLayerVersionsResponse$LayerVersions": "

A list of versions.

" - } - }, - "LayerVersionsListItem": { - "base": "

Details about a version of an Lambda layer.

", - "refs": { - "LayerVersionsList$member": null, - "LayersListItem$LatestMatchingVersion": "

The newest version of the layer.

" - } - }, - "LayersList": { - "base": null, - "refs": { - "ListLayersResponse$Layers": "

A list of function layers.

" - } - }, - "LayersListItem": { - "base": "

Details about an Lambda layer.

", - "refs": { - "LayersList$member": null - } - }, - "LayersReferenceList": { - "base": null, - "refs": { - "FunctionConfiguration$Layers": "

The function's layers.

" - } - }, - "LicenseInfo": { - "base": null, - "refs": { - "GetLayerVersionResponse$LicenseInfo": "

The layer's software license.

", - "LayerVersionsListItem$LicenseInfo": "

The layer's open-source license.

", - "PublishLayerVersionRequest$LicenseInfo": "

The layer's software license. It can be any of the following:

  • An SPDX license identifier. For example, MIT.

  • The URL of a license hosted on the internet. For example, https://opensource.org/licenses/MIT.

  • The full text of the license.

", - "PublishLayerVersionResponse$LicenseInfo": "

The layer's software license.

" - } - }, - "ListAliasesRequest": { - "base": null, - "refs": {} - }, - "ListAliasesResponse": { - "base": null, - "refs": {} - }, - "ListCapacityProvidersRequest": { - "base": null, - "refs": {} - }, - "ListCapacityProvidersResponse": { - "base": null, - "refs": {} - }, - "ListCodeSigningConfigsRequest": { - "base": null, - "refs": {} - }, - "ListCodeSigningConfigsResponse": { - "base": null, - "refs": {} - }, - "ListDurableExecutionsByFunctionRequest": { - "base": null, - "refs": {} - }, - "ListDurableExecutionsByFunctionResponse": { - "base": "

The response from the ListDurableExecutionsByFunction operation, containing a list of durable executions and pagination information.

", - "refs": {} - }, - "ListEventSourceMappingsRequest": { - "base": null, - "refs": {} - }, - "ListEventSourceMappingsResponse": { - "base": null, - "refs": {} - }, - "ListFunctionEventInvokeConfigsRequest": { - "base": null, - "refs": {} - }, - "ListFunctionEventInvokeConfigsResponse": { - "base": null, - "refs": {} - }, - "ListFunctionUrlConfigsRequest": { - "base": null, - "refs": {} - }, - "ListFunctionUrlConfigsResponse": { - "base": null, - "refs": {} - }, - "ListFunctionVersionsByCapacityProviderRequest": { - "base": null, - "refs": {} - }, - "ListFunctionVersionsByCapacityProviderResponse": { - "base": null, - "refs": {} - }, - "ListFunctionsByCodeSigningConfigRequest": { - "base": null, - "refs": {} - }, - "ListFunctionsByCodeSigningConfigResponse": { - "base": null, - "refs": {} - }, - "ListFunctionsRequest": { - "base": null, - "refs": {} - }, - "ListFunctionsResponse": { - "base": "

A list of Lambda functions.

", - "refs": {} - }, - "ListLayerVersionsRequest": { - "base": null, - "refs": {} - }, - "ListLayerVersionsResponse": { - "base": null, - "refs": {} - }, - "ListLayersRequest": { - "base": null, - "refs": {} - }, - "ListLayersResponse": { - "base": null, - "refs": {} - }, - "ListProvisionedConcurrencyConfigsRequest": { - "base": null, - "refs": {} - }, - "ListProvisionedConcurrencyConfigsResponse": { - "base": null, - "refs": {} - }, - "ListTagsRequest": { - "base": null, - "refs": {} - }, - "ListTagsResponse": { - "base": null, - "refs": {} - }, - "ListVersionsByFunctionRequest": { - "base": null, - "refs": {} - }, - "ListVersionsByFunctionResponse": { - "base": null, - "refs": {} - }, - "LocalMountPath": { - "base": null, - "refs": { - "FileSystemConfig$LocalMountPath": "

The path where the function can access the file system, starting with /mnt/.

" - } - }, - "LogFormat": { - "base": null, - "refs": { - "LoggingConfig$LogFormat": "

The format in which Lambda sends your function's application and system logs to CloudWatch. Select between plain text and structured JSON.

" - } - }, - "LogGroup": { - "base": null, - "refs": { - "CapacityProviderLoggingConfig$LogGroup": "

The name of the Amazon CloudWatch log group the capacity provider sends logs to. By default, Lambda capacity providers send logs to a default log group named /aws/lambda/capacity-provider/<capacity provider name>. To use a different log group, enter an existing log group or enter a new log group name.

", - "LoggingConfig$LogGroup": "

The name of the Amazon CloudWatch log group the function sends logs to. By default, Lambda functions send logs to a default log group named /aws/lambda/<function name>. To use a different log group, enter an existing log group or enter a new log group name.

" - } - }, - "LogType": { - "base": null, - "refs": { - "InvocationRequest$LogType": "

Set to Tail to include the execution log in the response. Applies to synchronously invoked functions only.

", - "InvokeWithResponseStreamRequest$LogType": "

Set to Tail to include the execution log in the response. Applies to synchronously invoked functions only.

" - } - }, - "LoggingConfig": { - "base": "

The function's Amazon CloudWatch Logs configuration settings.

", - "refs": { - "CreateFunctionRequest$LoggingConfig": "

The function's Amazon CloudWatch Logs configuration settings.

", - "FunctionConfiguration$LoggingConfig": "

The function's Amazon CloudWatch Logs configuration settings.

", - "UpdateFunctionConfigurationRequest$LoggingConfig": "

The function's Amazon CloudWatch Logs configuration settings.

" - } - }, - "Long": { - "base": null, - "refs": { - "AccountLimit$TotalCodeSize": "

The amount of storage space that you can use for all deployment packages and layer archives.

", - "AccountLimit$CodeSizeUnzipped": "

The maximum size of a function's deployment package and layers when they're extracted.

", - "AccountLimit$CodeSizeZipped": "

The maximum size of a deployment package when it's uploaded directly to Lambda. Use Amazon S3 for larger files.

", - "AccountUsage$TotalCodeSize": "

The amount of storage space, in bytes, that's being used by deployment packages and layer archives.

", - "AccountUsage$FunctionCount": "

The number of Lambda functions.

", - "FunctionConfiguration$CodeSize": "

The size of the function's deployment package, in bytes.

", - "Layer$CodeSize": "

The size of the layer archive in bytes.

", - "LayerVersionContentOutput$CodeSize": "

The size of the layer archive in bytes.

" - } - }, - "MasterRegion": { - "base": null, - "refs": { - "ListFunctionsRequest$MasterRegion": "

For Lambda@Edge functions, the Amazon Web Services Region of the master function. For example, us-east-1 filters the list of functions to include only Lambda@Edge functions replicated from a master function in US East (N. Virginia). If specified, you must set FunctionVersion to ALL.

" - } - }, - "MaxAge": { - "base": null, - "refs": { - "Cors$MaxAge": "

The maximum amount of time, in seconds, that web browsers can cache results of a preflight request. By default, this is set to 0, which means that the browser doesn't cache results.

" - } - }, - "MaxFiftyListItems": { - "base": null, - "refs": { - "ListCapacityProvidersRequest$MaxItems": "

The maximum number of capacity providers to return.

", - "ListFunctionVersionsByCapacityProviderRequest$MaxItems": "

The maximum number of function versions to return in the response.

" - } - }, - "MaxFunctionEventInvokeConfigListItems": { - "base": null, - "refs": { - "ListFunctionEventInvokeConfigsRequest$MaxItems": "

The maximum number of configurations to return.

" - } - }, - "MaxItems": { - "base": null, - "refs": { - "ListFunctionUrlConfigsRequest$MaxItems": "

The maximum number of function URLs to return in the response. Note that ListFunctionUrlConfigs returns a maximum of 50 items in each response, even if you set the number higher.

" - } - }, - "MaxLayerListItems": { - "base": null, - "refs": { - "ListLayerVersionsRequest$MaxItems": "

The maximum number of versions to return.

", - "ListLayersRequest$MaxItems": "

The maximum number of layers to return.

" - } - }, - "MaxListItems": { - "base": null, - "refs": { - "ListAliasesRequest$MaxItems": "

Limit the number of aliases returned.

", - "ListCodeSigningConfigsRequest$MaxItems": "

Maximum number of items to return.

", - "ListEventSourceMappingsRequest$MaxItems": "

The maximum number of event source mappings to return. Note that ListEventSourceMappings returns a maximum of 100 items in each response, even if you set the number higher.

", - "ListFunctionsByCodeSigningConfigRequest$MaxItems": "

Maximum number of items to return.

", - "ListFunctionsRequest$MaxItems": "

The maximum number of functions to return in the response. Note that ListFunctions returns a maximum of 50 items in each response, even if you set the number higher.

", - "ListVersionsByFunctionRequest$MaxItems": "

The maximum number of versions to return. Note that ListVersionsByFunction returns a maximum of 50 items in each response, even if you set the number higher.

" - } - }, - "MaxProvisionedConcurrencyConfigListItems": { - "base": null, - "refs": { - "ListProvisionedConcurrencyConfigsRequest$MaxItems": "

Specify a number to limit the number of configurations returned.

" - } - }, - "MaximumBatchingWindowInSeconds": { - "base": null, - "refs": { - "CreateEventSourceMappingRequest$MaximumBatchingWindowInSeconds": "

The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.

For Kinesis, DynamoDB, and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it. To restore the default batching window, you must create a new event source mapping.

Related setting: For Kinesis, DynamoDB, and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

", - "EventSourceMappingConfiguration$MaximumBatchingWindowInSeconds": "

The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.

For streams and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it. To restore the default batching window, you must create a new event source mapping.

Related setting: For streams and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

", - "UpdateEventSourceMappingRequest$MaximumBatchingWindowInSeconds": "

The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.

For Kinesis, DynamoDB, and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it. To restore the default batching window, you must create a new event source mapping.

Related setting: For Kinesis, DynamoDB, and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

" - } - }, - "MaximumConcurrency": { - "base": null, - "refs": { - "ScalingConfig$MaximumConcurrency": "

Limits the number of concurrent instances that the Amazon SQS event source can invoke.

" - } - }, - "MaximumEventAgeInSeconds": { - "base": null, - "refs": { - "FunctionEventInvokeConfig$MaximumEventAgeInSeconds": "

The maximum age of a request that Lambda sends to a function for processing.

", - "PutFunctionEventInvokeConfigRequest$MaximumEventAgeInSeconds": "

The maximum age of a request that Lambda sends to a function for processing.

", - "UpdateFunctionEventInvokeConfigRequest$MaximumEventAgeInSeconds": "

The maximum age of a request that Lambda sends to a function for processing.

" - } - }, - "MaximumNumberOfPollers": { - "base": null, - "refs": { - "ProvisionedPollerConfig$MaximumPollers": "

The maximum number of event pollers this event source can scale up to. For Amazon SQS events source mappings, default is 200, and minimum value allowed is 2. For Amazon MSK and self-managed Apache Kafka event source mappings, default is 200, and minimum value allowed is 1.

" - } - }, - "MaximumRecordAgeInSeconds": { - "base": null, - "refs": { - "CreateEventSourceMappingRequest$MaximumRecordAgeInSeconds": "

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) Discard records older than the specified age. The default value is infinite (-1).

", - "EventSourceMappingConfiguration$MaximumRecordAgeInSeconds": "

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.

The minimum valid value for maximum record age is 60s. Although values less than 60 and greater than -1 fall within the parameter's absolute range, they are not allowed

", - "UpdateEventSourceMappingRequest$MaximumRecordAgeInSeconds": "

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) Discard records older than the specified age. The default value is infinite (-1).

" - } - }, - "MaximumRetryAttempts": { - "base": null, - "refs": { - "FunctionEventInvokeConfig$MaximumRetryAttempts": "

The maximum number of times to retry when the function returns an error.

", - "PutFunctionEventInvokeConfigRequest$MaximumRetryAttempts": "

The maximum number of times to retry when the function returns an error.

", - "UpdateFunctionEventInvokeConfigRequest$MaximumRetryAttempts": "

The maximum number of times to retry when the function returns an error.

" - } - }, - "MaximumRetryAttemptsEventSourceMapping": { - "base": null, - "refs": { - "CreateEventSourceMappingRequest$MaximumRetryAttempts": "

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.

", - "EventSourceMappingConfiguration$MaximumRetryAttempts": "

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.

", - "UpdateEventSourceMappingRequest$MaximumRetryAttempts": "

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.

" - } - }, - "MemorySize": { - "base": null, - "refs": { - "CreateFunctionRequest$MemorySize": "

The amount of memory available to the function at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.

", - "FunctionConfiguration$MemorySize": "

The amount of memory available to the function at runtime.

", - "UpdateFunctionConfigurationRequest$MemorySize": "

The amount of memory available to the function at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.

" - } - }, - "Method": { - "base": null, - "refs": { - "AllowMethodsList$member": null - } - }, - "MetricTargetValue": { - "base": null, - "refs": { - "TargetTrackingScalingPolicy$TargetValue": "

The target value for the metric that the scaling policy attempts to maintain through scaling actions.

" - } - }, - "MinimumNumberOfPollers": { - "base": null, - "refs": { - "ProvisionedPollerConfig$MinimumPollers": "

The minimum number of event pollers this event source can scale down to. For Amazon SQS events source mappings, default is 2, and minimum 2 required. For Amazon MSK and self-managed Apache Kafka event source mappings, default is 1.

" - } - }, - "ModeNotSupportedException": { - "base": "

The Lambda function doesn't support the invocation mode requested. For example, calling Invoke with InvocationType=RequestResponse on a function configured for asynchronous-only invocation, or vice versa. For more information about invocation types, see Invoking Lambda functions.

", - "refs": {} - }, - "NameSpacedFunctionArn": { - "base": null, - "refs": { - "Execution$FunctionArn": "

The Amazon Resource Name (ARN) of the Lambda function.

", - "FunctionConfiguration$FunctionArn": "

The function's Amazon Resource Name (ARN).

", - "FunctionVersionsByCapacityProviderListItem$FunctionArn": "

The Amazon Resource Name (ARN) of the function version.

", - "GetDurableExecutionResponse$FunctionArn": "

The Amazon Resource Name (ARN) of the Lambda function that was invoked to start this durable execution.

", - "GetRuntimeManagementConfigResponse$FunctionArn": "

The Amazon Resource Name (ARN) of your function.

" - } - }, - "NamespacedFunctionName": { - "base": null, - "refs": { - "AddPermissionRequest$FunctionName": "

The name or ARN of the Lambda function, version, or alias.

Name formats

  • Function name – my-function (name-only), my-function:v1 (with alias).

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "ChainedInvokeOptions$FunctionName": "

The name or ARN of the Lambda function to invoke.

", - "ChainedInvokeStartedDetails$FunctionName": "

The name or ARN of the Lambda function being invoked.

", - "CreateEventSourceMappingRequest$FunctionName": "

The name or ARN of the Lambda function.

Name formats

  • Function name – MyFunction.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.

  • Partial ARN – 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.

", - "DeleteFunctionCodeSigningConfigRequest$FunctionName": "

The name or ARN of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "DeleteFunctionEventInvokeConfigRequest$FunctionName": "

The name or ARN of the Lambda function, version, or alias.

Name formats

  • Function name - my-function (name-only), my-function:v1 (with alias).

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN - 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "DeleteFunctionRequest$FunctionName": "

The name or ARN of the Lambda function or version.

Name formats

  • Function name – my-function (name-only), my-function:1 (with version).

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "FunctionConfiguration$FunctionName": "

The name of the function.

", - "GetFunctionCodeSigningConfigRequest$FunctionName": "

The name or ARN of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "GetFunctionConfigurationRequest$FunctionName": "

The name or ARN of the Lambda function, version, or alias.

Name formats

  • Function name – my-function (name-only), my-function:v1 (with alias).

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "GetFunctionEventInvokeConfigRequest$FunctionName": "

The name or ARN of the Lambda function, version, or alias.

Name formats

  • Function name - my-function (name-only), my-function:v1 (with alias).

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN - 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "GetFunctionRequest$FunctionName": "

The name or ARN of the Lambda function, version, or alias.

Name formats

  • Function name – my-function (name-only), my-function:v1 (with alias).

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "GetPolicyRequest$FunctionName": "

The name or ARN of the Lambda function, version, or alias.

Name formats

  • Function name – my-function (name-only), my-function:v1 (with alias).

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "GetRuntimeManagementConfigRequest$FunctionName": "

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "InvocationRequest$FunctionName": "

The name or ARN of the Lambda function, version, or alias.

Name formats

  • Function name – my-function (name-only), my-function:v1 (with alias).

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "InvokeAsyncRequest$FunctionName": "

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "InvokeWithResponseStreamRequest$FunctionName": "

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "ListDurableExecutionsByFunctionRequest$FunctionName": "

The name or ARN of the Lambda function. You can specify a function name, a partial ARN, or a full ARN.

", - "ListEventSourceMappingsRequest$FunctionName": "

The name or ARN of the Lambda function.

Name formats

  • Function name – MyFunction.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.

  • Partial ARN – 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.

", - "ListFunctionEventInvokeConfigsRequest$FunctionName": "

The name or ARN of the Lambda function.

Name formats

  • Function name - my-function.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN - 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "ListVersionsByFunctionRequest$FunctionName": "

The name or ARN of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "PutFunctionCodeSigningConfigRequest$FunctionName": "

The name or ARN of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "PutFunctionEventInvokeConfigRequest$FunctionName": "

The name or ARN of the Lambda function, version, or alias.

Name formats

  • Function name - my-function (name-only), my-function:v1 (with alias).

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN - 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "PutRuntimeManagementConfigRequest$FunctionName": "

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "RemovePermissionRequest$FunctionName": "

The name or ARN of the Lambda function, version, or alias.

Name formats

  • Function name – my-function (name-only), my-function:v1 (with alias).

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "UpdateEventSourceMappingRequest$FunctionName": "

The name or ARN of the Lambda function.

Name formats

  • Function name – MyFunction.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.

  • Partial ARN – 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.

", - "UpdateFunctionEventInvokeConfigRequest$FunctionName": "

The name or ARN of the Lambda function, version, or alias.

Name formats

  • Function name - my-function (name-only), my-function:v1 (with alias).

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN - 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

" - } - }, - "NamespacedStatementId": { - "base": null, - "refs": { - "RemovePermissionRequest$StatementId": "

Statement ID of the permission to remove.

" - } - }, - "NoPublishedVersionException": { - "base": "

The function has no published versions available.

", - "refs": {} - }, - "NonNegativeInteger": { - "base": null, - "refs": { - "GetProvisionedConcurrencyConfigResponse$AvailableProvisionedConcurrentExecutions": "

The amount of provisioned concurrency available.

", - "GetProvisionedConcurrencyConfigResponse$AllocatedProvisionedConcurrentExecutions": "

The amount of provisioned concurrency allocated. When a weighted alias is used during linear and canary deployments, this value fluctuates depending on the amount of concurrency that is provisioned for the function versions.

", - "ProvisionedConcurrencyConfigListItem$AvailableProvisionedConcurrentExecutions": "

The amount of provisioned concurrency available.

", - "ProvisionedConcurrencyConfigListItem$AllocatedProvisionedConcurrentExecutions": "

The amount of provisioned concurrency allocated. When a weighted alias is used during linear and canary deployments, this value fluctuates depending on the amount of concurrency that is provisioned for the function versions.

", - "PutProvisionedConcurrencyConfigResponse$AllocatedProvisionedConcurrentExecutions": "

The amount of provisioned concurrency allocated. When a weighted alias is used during linear and canary deployments, this value fluctuates depending on the amount of concurrency that is provisioned for the function versions.

", - "PutProvisionedConcurrencyConfigResponse$AvailableProvisionedConcurrentExecutions": "

The amount of provisioned concurrency available.

" - } - }, - "NullableBoolean": { - "base": null, - "refs": { - "VpcConfig$Ipv6AllowedForDualStack": "

Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets.

", - "VpcConfigResponse$Ipv6AllowedForDualStack": "

Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets.

" - } - }, - "NumericLatestPublishedOrAliasQualifier": { - "base": null, - "refs": { - "AddPermissionRequest$Qualifier": "

Specify a version or alias to add permissions to a published version of the function.

", - "DeleteFunctionEventInvokeConfigRequest$Qualifier": "

A version number or alias name.

", - "DeleteFunctionRequest$Qualifier": "

Specify a version to delete. You can't delete a version that an alias references.

", - "GetFunctionConfigurationRequest$Qualifier": "

Specify a version or alias to get details about a published version of the function.

", - "GetFunctionEventInvokeConfigRequest$Qualifier": "

A version number or alias name.

", - "GetFunctionRequest$Qualifier": "

Specify a version or alias to get details about a published version of the function.

", - "GetPolicyRequest$Qualifier": "

Specify a version or alias to get the policy for that resource.

", - "GetRuntimeManagementConfigRequest$Qualifier": "

Specify a version of the function. This can be $LATEST or a published version number. If no value is specified, the configuration for the $LATEST version is returned.

", - "InvocationRequest$Qualifier": "

Specify a version or alias to invoke a published version of the function.

", - "InvokeWithResponseStreamRequest$Qualifier": "

The alias name.

", - "ListDurableExecutionsByFunctionRequest$Qualifier": "

The function version or alias. If not specified, lists executions for the $LATEST version.

", - "PutFunctionEventInvokeConfigRequest$Qualifier": "

A version number or alias name.

", - "PutRuntimeManagementConfigRequest$Qualifier": "

Specify a version of the function. This can be $LATEST or a published version number. If no value is specified, the configuration for the $LATEST version is returned.

", - "RemovePermissionRequest$Qualifier": "

Specify a version or alias to remove permissions from a published version of the function.

", - "UpdateFunctionEventInvokeConfigRequest$Qualifier": "

A version number or alias name.

" - } - }, - "OnFailure": { - "base": "

A destination for events that failed processing. For more information, see Adding a destination.

", - "refs": { - "DestinationConfig$OnFailure": "

The destination configuration for failed invocations.

" - } - }, - "OnSuccess": { - "base": "

A destination for events that were processed successfully.

To retain records of successful asynchronous invocations, you can configure an Amazon SNS topic, Amazon SQS queue, Lambda function, or Amazon EventBridge event bus as the destination.

OnSuccess is not supported in CreateEventSourceMapping or UpdateEventSourceMapping requests.

", - "refs": { - "DestinationConfig$OnSuccess": "

The destination configuration for successful invocations. Not supported in CreateEventSourceMapping or UpdateEventSourceMapping.

" - } - }, - "Operation": { - "base": "

Information about an operation within a durable execution.

", - "refs": { - "Operations$member": null - } - }, - "OperationAction": { - "base": null, - "refs": { - "OperationUpdate$Action": "

The action to take on the operation.

" - } - }, - "OperationId": { - "base": null, - "refs": { - "Event$Id": "

The unique identifier for this operation.

", - "Event$ParentId": "

The unique identifier of the parent operation, if this operation is running within a child context.

", - "Operation$Id": "

The unique identifier for this operation.

", - "Operation$ParentId": "

The unique identifier of the parent operation, if this operation is running within a child context.

", - "OperationUpdate$Id": "

The unique identifier for this operation.

", - "OperationUpdate$ParentId": "

The unique identifier of the parent operation, if this operation is running within a child context.

" - } - }, - "OperationName": { - "base": null, - "refs": { - "Event$Name": "

The customer-provided name for this operation.

", - "Operation$Name": "

The customer-provided name for this operation.

", - "OperationUpdate$Name": "

The customer-provided name for this operation.

" - } - }, - "OperationPayload": { - "base": null, - "refs": { - "CallbackDetails$Result": "

The response payload from the callback operation as a string.

", - "ChainedInvokeDetails$Result": "

The response payload from the chained invocation.

", - "ContextDetails$Result": "

The response payload from the context.

", - "EventResult$Payload": "

The result payload.

", - "OperationUpdate$Payload": "

The payload for successful operations. The maximum payload size is 6 MB for synchronous EXECUTION operations (RequestResponse invocationType), 1 MB for asynchronous EXECUTION (Event invocationType) and CHAINED_INVOKE operations, and 256 KB for CONTEXT, STEP, WAIT, and CALLBACK operations.

", - "StepDetails$Result": "

The JSON response payload from the step operation.

" - } - }, - "OperationStatus": { - "base": null, - "refs": { - "Operation$Status": "

The current status of the operation.

" - } - }, - "OperationSubType": { - "base": null, - "refs": { - "Event$SubType": "

The subtype of the event, providing additional categorization.

", - "Operation$SubType": "

The subtype of the operation, providing additional categorization.

", - "OperationUpdate$SubType": "

The subtype of the operation, providing additional categorization.

" - } - }, - "OperationType": { - "base": null, - "refs": { - "Operation$Type": "

The type of operation.

", - "OperationUpdate$Type": "

The type of operation to update.

" - } - }, - "OperationUpdate": { - "base": "

An update to be applied to an operation during checkpointing.

", - "refs": { - "OperationUpdates$member": null - } - }, - "OperationUpdates": { - "base": null, - "refs": { - "CheckpointDurableExecutionRequest$Updates": "

An array of state updates to apply during this checkpoint. Each update represents a change to the execution state, such as completing a step, starting a callback, or scheduling a timer. Updates are applied atomically as part of the checkpoint operation.

" - } - }, - "Operations": { - "base": null, - "refs": { - "CheckpointUpdatedExecutionState$Operations": "

A list of operations that have been updated since the last checkpoint.

", - "GetDurableExecutionStateResponse$Operations": "

An array of operations that represent the current state of the durable execution. Operations are ordered by their start sequence number in ascending order and include information needed for replay processing.

" - } - }, - "OrganizationId": { - "base": null, - "refs": { - "AddLayerVersionPermissionRequest$OrganizationId": "

With the principal set to *, grant permission to all accounts in the specified organization.

" - } - }, - "Origin": { - "base": null, - "refs": { - "AllowOriginsList$member": null - } - }, - "OutputPayload": { - "base": null, - "refs": { - "GetDurableExecutionResponse$Result": "

The JSON result returned by the durable execution if it completed successfully. This field is only present when the execution status is SUCCEEDED. The result is limited to 256 KB.

" - } - }, - "PackageType": { - "base": null, - "refs": { - "CreateFunctionRequest$PackageType": "

The type of deployment package. Set to Image for container image and set to Zip for .zip file archive.

", - "FunctionConfiguration$PackageType": "

The type of deployment package. Set to Image for container image and set Zip for .zip file archive.

" - } - }, - "ParallelizationFactor": { - "base": null, - "refs": { - "CreateEventSourceMappingRequest$ParallelizationFactor": "

(Kinesis and DynamoDB Streams only) The number of batches to process from each shard concurrently.

", - "EventSourceMappingConfiguration$ParallelizationFactor": "

(Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.

", - "UpdateEventSourceMappingRequest$ParallelizationFactor": "

(Kinesis and DynamoDB Streams only) The number of batches to process from each shard concurrently.

" - } - }, - "Pattern": { - "base": null, - "refs": { - "Filter$Pattern": "

A filter pattern. For more information on the syntax of a filter pattern, see Filter rule syntax.

" - } - }, - "PerExecutionEnvironmentMaxConcurrency": { - "base": null, - "refs": { - "LambdaManagedInstancesCapacityProviderConfig$PerExecutionEnvironmentMaxConcurrency": "

The maximum number of concurrent execution environments that can run on each compute instance.

" - } - }, - "PolicyLengthExceededException": { - "base": "

The permissions policy for the resource is too large. For more information, see Lambda quotas.

", - "refs": {} - }, - "PositiveInteger": { - "base": null, - "refs": { - "GetProvisionedConcurrencyConfigResponse$RequestedProvisionedConcurrentExecutions": "

The amount of provisioned concurrency requested.

", - "ProvisionedConcurrencyConfigListItem$RequestedProvisionedConcurrentExecutions": "

The amount of provisioned concurrency requested.

", - "PutProvisionedConcurrencyConfigRequest$ProvisionedConcurrentExecutions": "

The amount of provisioned concurrency to allocate for the version or alias.

", - "PutProvisionedConcurrencyConfigResponse$RequestedProvisionedConcurrentExecutions": "

The amount of provisioned concurrency requested.

" - } - }, - "PreconditionFailedException": { - "base": "

The RevisionId provided does not match the latest RevisionId for the Lambda function or alias.

  • For AddPermission and RemovePermission API operations: Call GetPolicy to retrieve the latest RevisionId for your resource.

  • For all other API operations: Call GetFunction or GetAlias to retrieve the latest RevisionId for your resource.

", - "refs": {} - }, - "Principal": { - "base": null, - "refs": { - "AddPermissionRequest$Principal": "

The Amazon Web Services service, Amazon Web Services account, IAM user, or IAM role that invokes the function. If you specify a service, use SourceArn or SourceAccount to limit who can invoke the function through that service.

" - } - }, - "PrincipalOrgID": { - "base": null, - "refs": { - "AddPermissionRequest$PrincipalOrgID": "

The identifier for your organization in Organizations. Use this to grant permissions to all the Amazon Web Services accounts under this organization.

" - } - }, - "PropagateTags": { - "base": "

Configuration for tag propagation to managed resources launched by the capacity provider.

", - "refs": { - "CapacityProvider$PropagateTags": null, - "CreateCapacityProviderRequest$PropagateTags": "

The tag propagation configuration for the capacity provider. Specifies tags to apply to managed resources at launch.

", - "UpdateCapacityProviderRequest$PropagateTags": null - } - }, - "PropagateTagsExplicitTagsMap": { - "base": null, - "refs": { - "PropagateTags$ExplicitTags": "

A list of tags to apply to managed resources when Mode is set to Explicit. You can specify up to 40 tags.

" - } - }, - "PropagateTagsMode": { - "base": null, - "refs": { - "PropagateTags$Mode": "

The tag propagation mode. Set to Explicit to propagate the tags specified in ExplicitTags to managed resources. Set to None to disable tag propagation.

" - } - }, - "ProvisionedConcurrencyConfigList": { - "base": null, - "refs": { - "ListProvisionedConcurrencyConfigsResponse$ProvisionedConcurrencyConfigs": "

A list of provisioned concurrency configurations.

" - } - }, - "ProvisionedConcurrencyConfigListItem": { - "base": "

Details about the provisioned concurrency configuration for a function alias or version.

", - "refs": { - "ProvisionedConcurrencyConfigList$member": null - } - }, - "ProvisionedConcurrencyConfigNotFoundException": { - "base": "

The specified configuration does not exist.

", - "refs": {} - }, - "ProvisionedConcurrencyStatusEnum": { - "base": null, - "refs": { - "GetProvisionedConcurrencyConfigResponse$Status": "

The status of the allocation process.

", - "ProvisionedConcurrencyConfigListItem$Status": "

The status of the allocation process.

", - "PutProvisionedConcurrencyConfigResponse$Status": "

The status of the allocation process.

" - } - }, - "ProvisionedPollerConfig": { - "base": "

The provisioned mode configuration for the event source. Use Provisioned Mode to customize the minimum and maximum number of event pollers for your event source.

", - "refs": { - "CreateEventSourceMappingRequest$ProvisionedPollerConfig": "

(Amazon SQS, Amazon MSK, and self-managed Apache Kafka only) The provisioned mode configuration for the event source. For more information, see provisioned mode.

", - "EventSourceMappingConfiguration$ProvisionedPollerConfig": "

(Amazon SQS, Amazon MSK, and self-managed Apache Kafka only) The provisioned mode configuration for the event source. For more information, see provisioned mode.

", - "UpdateEventSourceMappingRequest$ProvisionedPollerConfig": "

(Amazon SQS, Amazon MSK, and self-managed Apache Kafka only) The provisioned mode configuration for the event source. For more information, see provisioned mode.

" - } - }, - "ProvisionedPollerGroupName": { - "base": null, - "refs": { - "ProvisionedPollerConfig$PollerGroupName": "

(Amazon MSK and self-managed Apache Kafka) The name of the provisioned poller group. Use this option to group multiple ESMs within the event source's VPC to share Event Poller Unit (EPU) capacity. You can use this option to optimize Provisioned mode costs for your ESMs. You can group up to 100 ESMs per poller group and aggregate maximum pollers across all ESMs in a group cannot exceed 2000.

" - } - }, - "PublicPolicyException": { - "base": "

The resource-based policy you tried to add to the Lambda function would grant public access to it, and your account's BlockPublicAccess setting prevents public access. For more information about blocking public access to Lambda functions, see Block public access to Lambda resources.

", - "refs": {} - }, - "PublishLayerVersionRequest": { - "base": null, - "refs": {} - }, - "PublishLayerVersionResponse": { - "base": null, - "refs": {} - }, - "PublishVersionRequest": { - "base": null, - "refs": {} - }, - "PublishedFunctionQualifier": { - "base": null, - "refs": { - "GetFunctionScalingConfigRequest$Qualifier": "

Specify a version or alias to get the scaling configuration for a published version of the function.

", - "PutFunctionScalingConfigRequest$Qualifier": "

Specify a version or alias to set the scaling configuration for a published version of the function.

" - } - }, - "PutFunctionCodeSigningConfigRequest": { - "base": null, - "refs": {} - }, - "PutFunctionCodeSigningConfigResponse": { - "base": null, - "refs": {} - }, - "PutFunctionConcurrencyRequest": { - "base": null, - "refs": {} - }, - "PutFunctionEventInvokeConfigRequest": { - "base": null, - "refs": {} - }, - "PutFunctionRecursionConfigRequest": { - "base": null, - "refs": {} - }, - "PutFunctionRecursionConfigResponse": { - "base": null, - "refs": {} - }, - "PutFunctionScalingConfigRequest": { - "base": null, - "refs": {} - }, - "PutFunctionScalingConfigResponse": { - "base": null, - "refs": {} - }, - "PutProvisionedConcurrencyConfigRequest": { - "base": null, - "refs": {} - }, - "PutProvisionedConcurrencyConfigResponse": { - "base": null, - "refs": {} - }, - "PutRuntimeManagementConfigRequest": { - "base": null, - "refs": {} - }, - "PutRuntimeManagementConfigResponse": { - "base": null, - "refs": {} - }, - "Qualifier": { - "base": null, - "refs": { - "DeleteProvisionedConcurrencyConfigRequest$Qualifier": "

The version number or alias name.

", - "GetProvisionedConcurrencyConfigRequest$Qualifier": "

The version number or alias name.

", - "PutProvisionedConcurrencyConfigRequest$Qualifier": "

The version number or alias name.

" - } - }, - "Queue": { - "base": null, - "refs": { - "Queues$member": null - } - }, - "Queues": { - "base": null, - "refs": { - "CreateEventSourceMappingRequest$Queues": "

(MQ) The name of the Amazon MQ broker destination queue to consume.

", - "EventSourceMappingConfiguration$Queues": "

(Amazon MQ) The name of the Amazon MQ broker destination queue to consume.

" - } - }, - "RecursiveInvocationException": { - "base": "

Lambda has detected your function being invoked in a recursive loop with other Amazon Web Services resources and stopped your function's invocation.

", - "refs": {} - }, - "RecursiveLoop": { - "base": null, - "refs": { - "GetFunctionRecursionConfigResponse$RecursiveLoop": "

If your function's recursive loop detection configuration is Allow, Lambda doesn't take any action when it detects your function being invoked as part of a recursive loop.

If your function's recursive loop detection configuration is Terminate, Lambda stops your function being invoked and notifies you when it detects your function being invoked as part of a recursive loop.

By default, Lambda sets your function's configuration to Terminate. You can update this configuration using the PutFunctionRecursionConfig action.

", - "PutFunctionRecursionConfigRequest$RecursiveLoop": "

If you set your function's recursive loop detection configuration to Allow, Lambda doesn't take any action when it detects your function being invoked as part of a recursive loop. We recommend that you only use this setting if your design intentionally uses a Lambda function to write data back to the same Amazon Web Services resource that invokes it.

If you set your function's recursive loop detection configuration to Terminate, Lambda stops your function being invoked and notifies you when it detects your function being invoked as part of a recursive loop.

By default, Lambda sets your function's configuration to Terminate.

If your design intentionally uses a Lambda function to write data back to the same Amazon Web Services resource that invokes the function, then use caution and implement suitable guard rails to prevent unexpected charges being billed to your Amazon Web Services account. To learn more about best practices for using recursive invocation patterns, see Recursive patterns that cause run-away Lambda functions in Serverless Land.

", - "PutFunctionRecursionConfigResponse$RecursiveLoop": "

The status of your function's recursive loop detection configuration.

When this value is set to Allowand Lambda detects your function being invoked as part of a recursive loop, it doesn't take any action.

When this value is set to Terminate and Lambda detects your function being invoked as part of a recursive loop, it stops your function being invoked and notifies you.

" - } - }, - "RemoveLayerVersionPermissionRequest": { - "base": null, - "refs": {} - }, - "RemovePermissionRequest": { - "base": null, - "refs": {} - }, - "ReplayChildren": { - "base": null, - "refs": { - "ContextDetails$ReplayChildren": "

Whether the state data of child operations of this completed context should be included in the invoke payload and GetDurableExecutionState response.

", - "ContextOptions$ReplayChildren": "

Whether the state data of children of the completed context should be included in the invoke payload and GetDurableExecutionState response.

" - } - }, - "RequestTooLargeException": { - "base": "

The request payload exceeded the Invoke request body JSON input quota. For more information, see Lambda quotas.

", - "refs": {} - }, - "ReservedConcurrentExecutions": { - "base": null, - "refs": { - "Concurrency$ReservedConcurrentExecutions": "

The number of concurrent executions that are reserved for this function. For more information, see Managing Lambda reserved concurrency.

", - "GetFunctionConcurrencyResponse$ReservedConcurrentExecutions": "

The number of simultaneous executions that are reserved for the function.

", - "PutFunctionConcurrencyRequest$ReservedConcurrentExecutions": "

The number of simultaneous executions to reserve for the function.

" - } - }, - "ResolvedS3Object": { - "base": "

Details about the resolved Amazon S3 object that contains a function's deployment package.

", - "refs": { - "FunctionCodeLocation$ResolvedS3Object": "

The resolved Amazon S3 object that contains the deployment package.

", - "LayerVersionContentOutput$ResolvedS3Object": "

The resolved Amazon S3 object that contains the layer archive.

" - } - }, - "ResourceArn": { - "base": null, - "refs": { - "DeadLetterConfig$TargetArn": "

The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

" - } - }, - "ResourceConflictException": { - "base": "

The resource already exists, or another operation is in progress.

", - "refs": {} - }, - "ResourceInUseException": { - "base": "

The operation conflicts with the resource's availability. For example, you tried to update an event source mapping in the CREATING state, or you tried to delete an event source mapping currently UPDATING.

", - "refs": {} - }, - "ResourceNotFoundException": { - "base": "

The resource specified in the request does not exist.

", - "refs": {} - }, - "ResourceNotReadyException": { - "base": "

The function is inactive and its VPC connection is no longer available. Wait for the VPC connection to reestablish and try again.

", - "refs": {} - }, - "ResponseStreamingInvocationType": { - "base": null, - "refs": { - "InvokeWithResponseStreamRequest$InvocationType": "

Use one of the following options:

  • RequestResponse (default) – Invoke the function synchronously. Keep the connection open until the function returns a response or times out. The API operation response includes the function response and additional data.

  • DryRun – Validate parameter values and verify that the IAM user or role has permission to invoke the function.

" - } - }, - "RetentionPeriodInDays": { - "base": null, - "refs": { - "DurableConfig$RetentionPeriodInDays": "

The number of days to retain execution history after a durable execution completes. After this period, execution history is no longer available through the GetDurableExecutionHistory API.

" - } - }, - "RetryDetails": { - "base": "

Information about retry attempts for an operation.

", - "refs": { - "StepFailedDetails$RetryDetails": "

Information about retry attempts for this step operation.

", - "StepSucceededDetails$RetryDetails": "

Information about retry attempts for this step operation.

" - } - }, - "ReverseOrder": { - "base": null, - "refs": { - "GetDurableExecutionHistoryRequest$ReverseOrder": "

When set to true, returns the history events in reverse chronological order (newest first). By default, events are returned in chronological order (oldest first).

", - "ListDurableExecutionsByFunctionRequest$ReverseOrder": "

Set to true to return results in chronological order (oldest first). Default is false.

" - } - }, - "RoleArn": { - "base": null, - "refs": { - "CapacityProviderPermissionsConfig$CapacityProviderOperatorRoleArn": "

The ARN of the IAM role that the capacity provider uses to manage compute instances and other Amazon Web Services resources.

", - "CreateFunctionRequest$Role": "

The Amazon Resource Name (ARN) of the function's execution role.

", - "FunctionConfiguration$Role": "

The function's execution role.

", - "UpdateFunctionConfigurationRequest$Role": "

The Amazon Resource Name (ARN) of the function's execution role.

" - } - }, - "Runtime": { - "base": null, - "refs": { - "CompatibleRuntimes$member": null, - "CreateFunctionRequest$Runtime": "

The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image.

The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see Runtime use after deprecation.

For a list of all currently supported runtimes, see Supported runtimes.

", - "FunctionConfiguration$Runtime": "

The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image.

The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see Runtime use after deprecation.

For a list of all currently supported runtimes, see Supported runtimes.

", - "ListLayerVersionsRequest$CompatibleRuntime": "

A runtime identifier.

The following list includes deprecated runtimes. For more information, see Runtime use after deprecation.

For a list of all currently supported runtimes, see Supported runtimes.

", - "ListLayersRequest$CompatibleRuntime": "

A runtime identifier.

The following list includes deprecated runtimes. For more information, see Runtime use after deprecation.

For a list of all currently supported runtimes, see Supported runtimes.

", - "UpdateFunctionConfigurationRequest$Runtime": "

The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image.

The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see Runtime use after deprecation.

For a list of all currently supported runtimes, see Supported runtimes.

" - } - }, - "RuntimeVersionArn": { - "base": null, - "refs": { - "GetRuntimeManagementConfigResponse$RuntimeVersionArn": "

The ARN of the runtime the function is configured to use. If the runtime update mode is Manual, the ARN is returned, otherwise null is returned.

", - "PutRuntimeManagementConfigRequest$RuntimeVersionArn": "

The ARN of the runtime version you want the function to use.

This is only required if you're using the Manual runtime update mode.

", - "PutRuntimeManagementConfigResponse$RuntimeVersionArn": "

The ARN of the runtime the function is configured to use. If the runtime update mode is manual, the ARN is returned, otherwise null is returned.

", - "RuntimeVersionConfig$RuntimeVersionArn": "

The ARN of the runtime version you want the function to use.

" - } - }, - "RuntimeVersionConfig": { - "base": "

The ARN of the runtime and any errors that occured.

", - "refs": { - "FunctionConfiguration$RuntimeVersionConfig": "

The ARN of the runtime and any errors that occured.

" - } - }, - "RuntimeVersionError": { - "base": "

Any error returned when the runtime version information for the function could not be retrieved.

", - "refs": { - "RuntimeVersionConfig$Error": "

Error response when Lambda is unable to retrieve the runtime version for a function.

" - } - }, - "S3Bucket": { - "base": null, - "refs": { - "FunctionCode$S3Bucket": "

An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a different Amazon Web Services account.

", - "LayerVersionContentInput$S3Bucket": "

The Amazon S3 bucket of the layer archive.

", - "ResolvedS3Object$S3Bucket": "

The Amazon S3 bucket that contains the deployment package.

", - "UpdateFunctionCodeRequest$S3Bucket": "

An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a different Amazon Web Services account. Use only with a function defined with a .zip file archive deployment package.

" - } - }, - "S3FilesMountConnectivityException": { - "base": "

The Lambda function couldn't make a network connection to the configured S3 Files access point.

", - "refs": {} - }, - "S3FilesMountFailureException": { - "base": "

The Lambda function couldn't mount the configured S3 Files access point due to a permission or configuration issue.

", - "refs": {} - }, - "S3FilesMountTimeoutException": { - "base": "

The Lambda function made a network connection to the configured S3 Files access point, but the mount operation timed out.

", - "refs": {} - }, - "S3Key": { - "base": null, - "refs": { - "FunctionCode$S3Key": "

The Amazon S3 key of the deployment package.

", - "LayerVersionContentInput$S3Key": "

The Amazon S3 key of the layer archive.

", - "ResolvedS3Object$S3Key": "

The Amazon S3 key of the deployment package.

", - "UpdateFunctionCodeRequest$S3Key": "

The Amazon S3 key of the deployment package. Use only with a function defined with a .zip file archive deployment package.

" - } - }, - "S3ObjectStorageMode": { - "base": "

The method Lambda uses to store a function's deployment package — either by copying the package into Lambda-managed storage (COPY) or by referencing it directly from the source Amazon S3 bucket (REFERENCE).

", - "refs": { - "FunctionCode$S3ObjectStorageMode": "

Specifies how the deployment package is stored. Valid values:

  • COPY (default) – Uploads a copy of your deployment package to Lambda.

  • REFERENCE – Lambda references the deployment package from the specified Amazon S3 bucket.

", - "LayerVersionContentInput$S3ObjectStorageMode": "

Specifies how the layer archive is stored. Valid values:

  • COPY (default) – Uploads a copy of your layer archive to Lambda.

  • REFERENCE – Lambda references the layer archive from the specified Amazon S3 bucket.

", - "UpdateFunctionCodeRequest$S3ObjectStorageMode": "

Specifies how the deployment package is stored. Valid values:

  • COPY (default) – Uploads a copy of your deployment package to Lambda.

  • REFERENCE – Lambda references the deployment package from the specified Amazon S3 bucket.

" - } - }, - "S3ObjectVersion": { - "base": null, - "refs": { - "FunctionCode$S3ObjectVersion": "

For versioned objects, the version of the deployment package object to use.

", - "LayerVersionContentInput$S3ObjectVersion": "

For versioned objects, the version of the layer archive object to use.

", - "ResolvedS3Object$S3ObjectVersion": "

The version of the deployment package object.

", - "UpdateFunctionCodeRequest$S3ObjectVersion": "

For versioned objects, the version of the deployment package object to use.

" - } - }, - "ScalingConfig": { - "base": "

(Amazon SQS only) The scaling configuration for the event source. To remove the configuration, pass an empty value.

", - "refs": { - "CreateEventSourceMappingRequest$ScalingConfig": "

(Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.

", - "EventSourceMappingConfiguration$ScalingConfig": "

(Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.

", - "UpdateEventSourceMappingRequest$ScalingConfig": "

(Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.

" - } - }, - "SchemaRegistryEventRecordFormat": { - "base": null, - "refs": { - "KafkaSchemaRegistryConfig$EventRecordFormat": "

The record format that Lambda delivers to your function after schema validation.

  • Choose JSON to have Lambda deliver the record to your function as a standard JSON object.

  • Choose SOURCE to have Lambda deliver the record to your function in its original source format. Lambda removes all schema metadata, such as the schema ID, before sending the record to your function.

" - } - }, - "SchemaRegistryUri": { - "base": null, - "refs": { - "KafkaSchemaRegistryConfig$SchemaRegistryURI": "

The URI for your schema registry. The correct URI format depends on the type of schema registry you're using.

  • For Glue schema registries, use the ARN of the registry.

  • For Confluent schema registries, use the URL of the registry.

" - } - }, - "SecurityGroupId": { - "base": null, - "refs": { - "CapacityProviderSecurityGroupIds$member": null, - "SecurityGroupIds$member": null - } - }, - "SecurityGroupIds": { - "base": null, - "refs": { - "VpcConfig$SecurityGroupIds": "

A list of VPC security group IDs.

", - "VpcConfigResponse$SecurityGroupIds": "

A list of VPC security group IDs.

" - } - }, - "SelfManagedEventSource": { - "base": "

The self-managed Apache Kafka cluster for your event source.

", - "refs": { - "CreateEventSourceMappingRequest$SelfManagedEventSource": "

The self-managed Apache Kafka cluster to receive records from.

", - "EventSourceMappingConfiguration$SelfManagedEventSource": "

The self-managed Apache Kafka cluster for your event source.

" - } - }, - "SelfManagedKafkaEventSourceConfig": { - "base": "

Specific configuration settings for a self-managed Apache Kafka event source.

", - "refs": { - "CreateEventSourceMappingRequest$SelfManagedKafkaEventSourceConfig": "

Specific configuration settings for a self-managed Apache Kafka event source.

", - "EventSourceMappingConfiguration$SelfManagedKafkaEventSourceConfig": "

Specific configuration settings for a self-managed Apache Kafka event source.

", - "UpdateEventSourceMappingRequest$SelfManagedKafkaEventSourceConfig": null - } - }, - "SendDurableExecutionCallbackFailureRequest": { - "base": null, - "refs": {} - }, - "SendDurableExecutionCallbackFailureResponse": { - "base": null, - "refs": {} - }, - "SendDurableExecutionCallbackHeartbeatRequest": { - "base": null, - "refs": {} - }, - "SendDurableExecutionCallbackHeartbeatResponse": { - "base": null, - "refs": {} - }, - "SendDurableExecutionCallbackSuccessRequest": { - "base": null, - "refs": {} - }, - "SendDurableExecutionCallbackSuccessResponse": { - "base": null, - "refs": {} - }, - "SensitiveString": { - "base": null, - "refs": { - "EnvironmentError$Message": "

The error message.

", - "FunctionCodeLocationError$Message": "

The human-readable message that describes why Lambda failed to retrieve the deployment package.

", - "ImageConfigError$Message": "

Error message.

", - "RuntimeVersionError$Message": "

The error message.

" - } - }, - "SensitiveStringOnServerOnly": { - "base": null, - "refs": { - "FunctionCodeLocation$Location": "

A presigned URL that you can use to download the deployment package.

", - "LayerVersionContentOutput$Location": "

A link to the layer archive in Amazon S3 that is valid for 10 minutes.

" - } - }, - "SerializedRequestEntityTooLargeException": { - "base": "

The request payload exceeded the maximum allowed size for serialized request entities.

", - "refs": {} - }, - "ServiceException": { - "base": "

The Lambda service encountered an internal error.

", - "refs": {} - }, - "ServiceQuotaExceededException": { - "base": "

The request would exceed a service quota. For more information about Lambda service quotas, see Lambda quotas. To request a quota increase, see Requesting a quota increase in the Service Quotas User Guide.

", - "refs": {} - }, - "SigningProfileVersionArns": { - "base": null, - "refs": { - "AllowedPublishers$SigningProfileVersionArns": "

The Amazon Resource Name (ARN) for each of the signing profiles. A signing profile defines a trusted user who can sign a code package.

" - } - }, - "SnapStart": { - "base": "

The function's Lambda SnapStart setting. Set ApplyOn to PublishedVersions to create a snapshot of the initialized execution environment when you publish a function version.

", - "refs": { - "CreateFunctionRequest$SnapStart": "

The function's SnapStart setting.

", - "UpdateFunctionConfigurationRequest$SnapStart": "

The function's SnapStart setting.

" - } - }, - "SnapStartApplyOn": { - "base": null, - "refs": { - "SnapStart$ApplyOn": "

Set to PublishedVersions to create a snapshot of the initialized execution environment when you publish a function version.

", - "SnapStartResponse$ApplyOn": "

When set to PublishedVersions, Lambda creates a snapshot of the execution environment when you publish a function version.

" - } - }, - "SnapStartException": { - "base": "

The afterRestore() runtime hook encountered an error. For more information, check the Amazon CloudWatch logs.

", - "refs": {} - }, - "SnapStartNotReadyException": { - "base": "

Lambda is initializing your function. You can invoke the function when the function state becomes Active.

", - "refs": {} - }, - "SnapStartOptimizationStatus": { - "base": null, - "refs": { - "SnapStartResponse$OptimizationStatus": "

When you provide a qualified Amazon Resource Name (ARN), this response element indicates whether SnapStart is activated for the specified function version.

" - } - }, - "SnapStartRegenerationFailureException": { - "base": "

Lambda couldn't regenerate the SnapStart snapshot for the function. SnapStart-enabled functions periodically regenerate snapshots when their underlying runtime or dependencies change; this regeneration failed. Wait for Lambda to retry, or update the function's configuration to trigger a new snapshot. For more information, see Lambda SnapStart.

", - "refs": {} - }, - "SnapStartResponse": { - "base": "

The function's SnapStart setting.

", - "refs": { - "FunctionConfiguration$SnapStart": "

Set ApplyOn to PublishedVersions to create a snapshot of the initialized execution environment when you publish a function version. For more information, see Improving startup performance with Lambda SnapStart.

" - } - }, - "SnapStartTimeoutException": { - "base": "

Lambda couldn't restore the snapshot within the timeout limit.

", - "refs": {} - }, - "SourceAccessConfiguration": { - "base": "

To secure and define access to your event source, you can specify the authentication protocol, VPC components, or virtual host.

", - "refs": { - "SourceAccessConfigurations$member": null - } - }, - "SourceAccessConfigurations": { - "base": null, - "refs": { - "CreateEventSourceMappingRequest$SourceAccessConfigurations": "

An array of authentication protocols or VPC components required to secure your event source.

", - "EventSourceMappingConfiguration$SourceAccessConfigurations": "

An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.

", - "UpdateEventSourceMappingRequest$SourceAccessConfigurations": "

An array of authentication protocols or VPC components required to secure your event source.

" - } - }, - "SourceAccessType": { - "base": null, - "refs": { - "SourceAccessConfiguration$Type": "

The type of authentication protocol, VPC components, or virtual host for your event source. For example: \"Type\":\"SASL_SCRAM_512_AUTH\".

  • BASIC_AUTH – (Amazon MQ) The Secrets Manager secret that stores your broker credentials.

  • BASIC_AUTH – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL/PLAIN authentication of your Apache Kafka brokers.

  • VPC_SUBNET – (Self-managed Apache Kafka) The subnets associated with your VPC. Lambda connects to these subnets to fetch data from your self-managed Apache Kafka cluster.

  • VPC_SECURITY_GROUP – (Self-managed Apache Kafka) The VPC security group used to manage access to your self-managed Apache Kafka brokers.

  • SASL_SCRAM_256_AUTH – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your self-managed Apache Kafka brokers.

  • SASL_SCRAM_512_AUTH – (Amazon MSK, Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your self-managed Apache Kafka brokers.

  • VIRTUAL_HOST –- (RabbitMQ) The name of the virtual host in your RabbitMQ broker. Lambda uses this RabbitMQ host as the event source. This property cannot be specified in an UpdateEventSourceMapping API call.

  • CLIENT_CERTIFICATE_TLS_AUTH – (Amazon MSK, self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the certificate chain (X.509 PEM), private key (PKCS#8 PEM), and private key password (optional) used for mutual TLS authentication of your MSK/Apache Kafka brokers.

  • SERVER_ROOT_CA_CERTIFICATE – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the root CA certificate (X.509 PEM) used for TLS encryption of your Apache Kafka brokers.

" - } - }, - "SourceOwner": { - "base": null, - "refs": { - "AddPermissionRequest$SourceAccount": "

For Amazon Web Services service, the ID of the Amazon Web Services account that owns the resource. Use this together with SourceArn to ensure that the specified account owns the resource. It is possible for an Amazon S3 bucket to be deleted by its owner and recreated by another account.

" - } - }, - "StackTraceEntries": { - "base": null, - "refs": { - "ErrorObject$StackTrace": "

Stack trace information for the error.

" - } - }, - "StackTraceEntry": { - "base": null, - "refs": { - "StackTraceEntries$member": null - } - }, - "State": { - "base": null, - "refs": { - "FunctionConfiguration$State": "

The current state of the function. When the state is Inactive, you can reactivate the function by invoking it.

", - "FunctionVersionsByCapacityProviderListItem$State": "

The current state of the function version.

", - "PutFunctionScalingConfigResponse$FunctionState": "

The current state of the function after applying the scaling configuration.

" - } - }, - "StateReason": { - "base": null, - "refs": { - "FunctionConfiguration$StateReason": "

The reason for the function's current state.

" - } - }, - "StateReasonCode": { - "base": null, - "refs": { - "FunctionConfiguration$StateReasonCode": "

The reason code for the function's current state. When the code is Creating, you can't invoke or modify the function.

" - } - }, - "StatementId": { - "base": null, - "refs": { - "AddLayerVersionPermissionRequest$StatementId": "

An identifier that distinguishes the policy from others on the same layer version.

", - "AddPermissionRequest$StatementId": "

A statement identifier that differentiates the statement from others in the same policy.

", - "RemoveLayerVersionPermissionRequest$StatementId": "

The identifier that was specified when the statement was added.

" - } - }, - "StepDetails": { - "base": "

Details about a step operation.

", - "refs": { - "Operation$StepDetails": "

Details about the step, if this operation represents a step.

" - } - }, - "StepFailedDetails": { - "base": "

Details about a step that failed.

", - "refs": { - "Event$StepFailedDetails": "

Details about a step that failed.

" - } - }, - "StepOptions": { - "base": "

Configuration options for a step operation.

", - "refs": { - "OperationUpdate$StepOptions": "

Options for step operations.

" - } - }, - "StepOptionsNextAttemptDelaySecondsInteger": { - "base": null, - "refs": { - "StepOptions$NextAttemptDelaySeconds": "

The delay in seconds before the next retry attempt.

" - } - }, - "StepStartedDetails": { - "base": "

Details about a step that has started.

", - "refs": { - "Event$StepStartedDetails": "

Details about a step that started.

" - } - }, - "StepSucceededDetails": { - "base": "

Details about a step that succeeded.

", - "refs": { - "Event$StepSucceededDetails": "

Details about a step that succeeded.

" - } - }, - "StopDurableExecutionRequest": { - "base": null, - "refs": {} - }, - "StopDurableExecutionResponse": { - "base": null, - "refs": {} - }, - "String": { - "base": null, - "refs": { - "AddLayerVersionPermissionRequest$RevisionId": "

Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a policy that has changed since you last read it.

", - "AddLayerVersionPermissionResponse$Statement": "

The permission statement.

", - "AddLayerVersionPermissionResponse$RevisionId": "

A unique identifier for the current revision of the policy.

", - "AddPermissionRequest$RevisionId": "

Update the policy only if the revision ID matches the ID that's specified. Use this option to avoid modifying a policy that has changed since you last read it.

", - "AddPermissionResponse$Statement": "

The permission statement that's added to the function policy.

", - "AliasConfiguration$RevisionId": "

A unique identifier that changes when you update the alias.

", - "AliasLimitExceededException$Type": "

The exception type.

", - "AliasLimitExceededException$message": "

The exception message.

", - "CallbackTimeoutException$Type": "

The exception type.

", - "CallbackTimeoutException$Message": null, - "CapacityProviderLimitExceededException$Type": "

The exception type.

", - "CapacityProviderLimitExceededException$message": null, - "CheckpointUpdatedExecutionState$NextMarker": "

Indicates that more results are available. Use this value in a subsequent call to retrieve the next page of results.

", - "CodeArtifactUserDeletedException$Type": "

The exception type.

", - "CodeArtifactUserDeletedException$message": "

The exception message.

", - "CodeArtifactUserFailedException$Type": "

The exception type.

", - "CodeArtifactUserFailedException$message": "

The exception message.

", - "CodeArtifactUserPendingException$Type": "

The exception type.

", - "CodeArtifactUserPendingException$message": "

The exception message.

", - "CodeSigningConfigNotFoundException$Type": null, - "CodeSigningConfigNotFoundException$Message": null, - "CodeStorageExceededException$Type": "

The exception type.

", - "CodeStorageExceededException$message": null, - "CodeVerificationFailedException$Type": null, - "CodeVerificationFailedException$Message": null, - "DurableExecutionAlreadyStartedException$Type": "

The exception type.

", - "DurableExecutionAlreadyStartedException$Message": null, - "EC2AccessDeniedException$Type": null, - "EC2AccessDeniedException$Message": null, - "EC2ThrottledException$Type": null, - "EC2ThrottledException$Message": null, - "EC2UnexpectedException$Type": null, - "EC2UnexpectedException$Message": null, - "EC2UnexpectedException$EC2ErrorCode": null, - "EFSIOException$Type": null, - "EFSIOException$Message": null, - "EFSMountConnectivityException$Type": null, - "EFSMountConnectivityException$Message": null, - "EFSMountFailureException$Type": null, - "EFSMountFailureException$Message": null, - "EFSMountTimeoutException$Type": null, - "EFSMountTimeoutException$Message": null, - "ENILimitReachedException$Type": null, - "ENILimitReachedException$Message": null, - "ENINotReadyException$Type": "

The exception type.

", - "ENINotReadyException$Message": "

The exception message.

", - "EnvironmentError$ErrorCode": "

The error code.

", - "EventSourceMappingConfiguration$LastProcessingResult": "

The result of the event source mapping's last processing attempt.

", - "EventSourceMappingConfiguration$State": "

The state of the event source mapping. It can be one of the following: Creating, Enabling, Enabled, Disabling, Disabled, Updating, or Deleting.

", - "EventSourceMappingConfiguration$StateTransitionReason": "

Indicates whether a user or Lambda made the last change to the event source mapping.

", - "FunctionCode$ImageUri": "

URI of a container image in the Amazon ECR registry.

", - "FunctionCodeLocation$RepositoryType": "

The service that's hosting the file.

", - "FunctionCodeLocation$ImageUri": "

URI of a container image in the Amazon ECR registry.

", - "FunctionCodeLocation$ResolvedImageUri": "

The resolved URI for the image.

", - "FunctionCodeLocationError$ErrorCode": "

The error code that identifies why Lambda failed to retrieve the deployment package.

", - "FunctionConfiguration$CodeSha256": "

The SHA256 hash of the function's deployment package.

", - "FunctionConfiguration$RevisionId": "

The latest updated revision of the function or alias.

", - "FunctionConfiguration$ConfigSha256": "

The SHA256 hash of the function configuration.

", - "FunctionVersionsPerCapacityProviderLimitExceededException$Type": "

The exception type.

", - "FunctionVersionsPerCapacityProviderLimitExceededException$message": null, - "GetDurableExecutionHistoryRequest$Marker": "

If NextMarker was returned from a previous request, use this value to retrieve the next page of results. Each pagination token expires after 24 hours.

", - "GetDurableExecutionHistoryResponse$NextMarker": "

If present, indicates that more history events are available. Use this value as the Marker parameter in a subsequent request to retrieve the next page of results.

", - "GetDurableExecutionStateRequest$Marker": "

If NextMarker was returned from a previous request, use this value to retrieve the next page of operations. Each pagination token expires after 24 hours.

", - "GetDurableExecutionStateResponse$NextMarker": "

If present, indicates that more operations are available. Use this value as the Marker parameter in a subsequent request to retrieve the next page of results.

", - "GetLayerVersionPolicyResponse$Policy": "

The policy document.

", - "GetLayerVersionPolicyResponse$RevisionId": "

A unique identifier for the current revision of the policy.

", - "GetPolicyResponse$Policy": "

The resource-based policy.

", - "GetPolicyResponse$RevisionId": "

A unique identifier for the current revision of the policy.

", - "GetProvisionedConcurrencyConfigResponse$StatusReason": "

For failed allocations, the reason that provisioned concurrency could not be allocated.

", - "ImageConfigError$ErrorCode": "

Error code.

", - "InvalidCodeSignatureException$Type": null, - "InvalidCodeSignatureException$Message": null, - "InvalidParameterValueException$Type": "

The exception type.

", - "InvalidParameterValueException$message": "

The exception message.

", - "InvalidRequestContentException$Type": "

The exception type.

", - "InvalidRequestContentException$message": "

The exception message.

", - "InvalidRuntimeException$Type": null, - "InvalidRuntimeException$Message": null, - "InvalidSecurityGroupIDException$Type": null, - "InvalidSecurityGroupIDException$Message": null, - "InvalidSubnetIDException$Type": null, - "InvalidSubnetIDException$Message": null, - "InvalidZipFileException$Type": null, - "InvalidZipFileException$Message": null, - "InvocationCompletedDetails$RequestId": "

The request ID for the invocation.

", - "InvocationRequest$ClientContext": "

Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object. Lambda passes the ClientContext object to your function for synchronous invocations only.

", - "InvocationResponse$FunctionError": "

If present, indicates that an error occurred during function execution. Details about the error are included in the response payload.

", - "InvocationResponse$LogResult": "

The last 4 KB of the execution log, which is base64-encoded.

", - "InvokeWithResponseStreamCompleteEvent$ErrorCode": "

An error code.

", - "InvokeWithResponseStreamCompleteEvent$ErrorDetails": "

The details of any returned error.

", - "InvokeWithResponseStreamCompleteEvent$LogResult": "

The last 4 KB of the execution log, which is base64-encoded.

", - "InvokeWithResponseStreamRequest$ClientContext": "

Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.

", - "InvokeWithResponseStreamResponse$ResponseStreamContentType": "

The type of data the stream is returning.

", - "KMSAccessDeniedException$Type": null, - "KMSAccessDeniedException$Message": null, - "KMSDisabledException$Type": null, - "KMSDisabledException$Message": null, - "KMSInvalidStateException$Type": null, - "KMSInvalidStateException$Message": null, - "KMSNotFoundException$Type": null, - "KMSNotFoundException$Message": null, - "LayerVersionContentOutput$CodeSha256": "

The SHA-256 hash of the layer archive.

", - "ListAliasesRequest$Marker": "

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

", - "ListAliasesResponse$NextMarker": "

The pagination token that's included if more results are available.

", - "ListCapacityProvidersRequest$Marker": "

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

", - "ListCapacityProvidersResponse$NextMarker": "

The pagination token that's included if more results are available.

", - "ListCodeSigningConfigsRequest$Marker": "

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

", - "ListCodeSigningConfigsResponse$NextMarker": "

The pagination token that's included if more results are available.

", - "ListDurableExecutionsByFunctionRequest$Marker": "

Pagination token from a previous request to continue retrieving results.

", - "ListDurableExecutionsByFunctionResponse$NextMarker": "

Pagination token for retrieving additional results. Present only if there are more results available.

", - "ListEventSourceMappingsRequest$Marker": "

A pagination token returned by a previous call.

", - "ListEventSourceMappingsResponse$NextMarker": "

A pagination token that's returned when the response doesn't contain all event source mappings.

", - "ListFunctionEventInvokeConfigsRequest$Marker": "

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

", - "ListFunctionEventInvokeConfigsResponse$NextMarker": "

The pagination token that's included if more results are available.

", - "ListFunctionUrlConfigsRequest$Marker": "

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

", - "ListFunctionUrlConfigsResponse$NextMarker": "

The pagination token that's included if more results are available.

", - "ListFunctionVersionsByCapacityProviderRequest$Marker": "

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

", - "ListFunctionVersionsByCapacityProviderResponse$NextMarker": "

The pagination token that's included if more results are available.

", - "ListFunctionsByCodeSigningConfigRequest$Marker": "

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

", - "ListFunctionsByCodeSigningConfigResponse$NextMarker": "

The pagination token that's included if more results are available.

", - "ListFunctionsRequest$Marker": "

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

", - "ListFunctionsResponse$NextMarker": "

The pagination token that's included if more results are available.

", - "ListLayerVersionsRequest$Marker": "

A pagination token returned by a previous call.

", - "ListLayerVersionsResponse$NextMarker": "

A pagination token returned when the response doesn't contain all versions.

", - "ListLayersRequest$Marker": "

A pagination token returned by a previous call.

", - "ListLayersResponse$NextMarker": "

A pagination token returned when the response doesn't contain all layers.

", - "ListProvisionedConcurrencyConfigsRequest$Marker": "

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

", - "ListProvisionedConcurrencyConfigsResponse$NextMarker": "

The pagination token that's included if more results are available.

", - "ListVersionsByFunctionRequest$Marker": "

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

", - "ListVersionsByFunctionResponse$NextMarker": "

The pagination token that's included if more results are available.

", - "ModeNotSupportedException$Type": "

The exception type.

", - "ModeNotSupportedException$message": "

The exception message.

", - "NoPublishedVersionException$Type": "

The exception type.

", - "NoPublishedVersionException$Message": null, - "PolicyLengthExceededException$Type": null, - "PolicyLengthExceededException$message": null, - "PreconditionFailedException$Type": "

The exception type.

", - "PreconditionFailedException$message": "

The exception message.

", - "ProvisionedConcurrencyConfigListItem$StatusReason": "

For failed allocations, the reason that provisioned concurrency could not be allocated.

", - "ProvisionedConcurrencyConfigNotFoundException$Type": null, - "ProvisionedConcurrencyConfigNotFoundException$message": null, - "PublicPolicyException$Type": "

The exception type.

", - "PublicPolicyException$Message": "

The exception message.

", - "PublishVersionRequest$CodeSha256": "

Only publish a version if the hash value matches the value that's specified. Use this option to avoid publishing a version if the function code has changed since you last updated it. You can get the hash for the version that you uploaded from the output of UpdateFunctionCode.

", - "PublishVersionRequest$RevisionId": "

Only update the function if the revision ID matches the ID that's specified. Use this option to avoid publishing a version if the function configuration has changed since you last updated it.

", - "PutProvisionedConcurrencyConfigResponse$StatusReason": "

For failed allocations, the reason that provisioned concurrency could not be allocated.

", - "RecursiveInvocationException$Type": "

The exception type.

", - "RecursiveInvocationException$Message": "

The exception message.

", - "RemoveLayerVersionPermissionRequest$RevisionId": "

Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a policy that has changed since you last read it.

", - "RemovePermissionRequest$RevisionId": "

Update the policy only if the revision ID matches the ID that's specified. Use this option to avoid modifying a policy that has changed since you last read it.

", - "RequestTooLargeException$Type": null, - "RequestTooLargeException$message": null, - "ResourceConflictException$Type": "

The exception type.

", - "ResourceConflictException$message": "

The exception message.

", - "ResourceInUseException$Type": null, - "ResourceInUseException$Message": null, - "ResourceNotFoundException$Type": null, - "ResourceNotFoundException$Message": null, - "ResourceNotReadyException$Type": "

The exception type.

", - "ResourceNotReadyException$message": "

The exception message.

", - "RuntimeVersionError$ErrorCode": "

The error code.

", - "S3FilesMountConnectivityException$Type": "

The exception type.

", - "S3FilesMountConnectivityException$Message": "

The exception message.

", - "S3FilesMountFailureException$Type": "

The exception type.

", - "S3FilesMountFailureException$Message": "

The exception message.

", - "S3FilesMountTimeoutException$Type": "

The exception type.

", - "S3FilesMountTimeoutException$Message": "

The exception message.

", - "SerializedRequestEntityTooLargeException$Type": "

The error type.

", - "SerializedRequestEntityTooLargeException$message": null, - "ServiceException$Type": null, - "ServiceException$Message": null, - "ServiceQuotaExceededException$Type": "

The exception type.

", - "ServiceQuotaExceededException$Message": "

The exception message.

", - "SnapStartException$Type": null, - "SnapStartException$Message": null, - "SnapStartNotReadyException$Type": null, - "SnapStartNotReadyException$Message": null, - "SnapStartRegenerationFailureException$Type": "

The exception type.

", - "SnapStartRegenerationFailureException$Message": "

The exception message.

", - "SnapStartTimeoutException$Type": null, - "SnapStartTimeoutException$Message": null, - "StringList$member": null, - "SubnetIPAddressLimitReachedException$Type": null, - "SubnetIPAddressLimitReachedException$Message": null, - "TooManyRequestsException$retryAfterSeconds": "

The number of seconds the caller should wait before retrying.

", - "TooManyRequestsException$Type": null, - "TooManyRequestsException$message": null, - "UnsupportedMediaTypeException$Type": null, - "UnsupportedMediaTypeException$message": null, - "UpdateAliasRequest$RevisionId": "

Only update the alias if the revision ID matches the ID that's specified. Use this option to avoid modifying an alias that has changed since you last read it.

", - "UpdateFunctionCodeRequest$ImageUri": "

URI of a container image in the Amazon ECR registry. Do not use for a function defined with a .zip file archive.

", - "UpdateFunctionCodeRequest$RevisionId": "

Update the function only if the revision ID matches the ID that's specified. Use this option to avoid modifying a function that has changed since you last read it.

", - "UpdateFunctionConfigurationRequest$RevisionId": "

Update the function only if the revision ID matches the ID that's specified. Use this option to avoid modifying a function that has changed since you last read it.

" - } - }, - "StringList": { - "base": null, - "refs": { - "ImageConfig$EntryPoint": "

Specifies the entry point to their application, which is typically the location of the runtime executable.

", - "ImageConfig$Command": "

Specifies parameters that you want to pass in with ENTRYPOINT.

" - } - }, - "SubnetIPAddressLimitReachedException": { - "base": "

Lambda couldn't set up VPC access for the Lambda function because one or more configured subnets has no available IP addresses.

", - "refs": {} - }, - "SubnetId": { - "base": null, - "refs": { - "CapacityProviderSubnetIds$member": null, - "SubnetIds$member": null - } - }, - "SubnetIds": { - "base": null, - "refs": { - "VpcConfig$SubnetIds": "

A list of VPC subnet IDs.

", - "VpcConfigResponse$SubnetIds": "

A list of VPC subnet IDs.

" - } - }, - "SystemLogLevel": { - "base": null, - "refs": { - "CapacityProviderLoggingConfig$SystemLogLevel": "

Set this property to filter the system logs for your capacity provider that Lambda sends to CloudWatch. Lambda only sends system logs at the selected level of detail and lower, where DEBUG is the highest level and WARN is the lowest.

", - "LoggingConfig$SystemLogLevel": "

Set this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the selected level of detail and lower, where DEBUG is the highest level and WARN is the lowest.

" - } - }, - "TagKey": { - "base": null, - "refs": { - "PropagateTagsExplicitTagsMap$key": null, - "TagKeyList$member": null, - "Tags$key": null - } - }, - "TagKeyList": { - "base": null, - "refs": { - "UntagResourceRequest$TagKeys": "

A list of tag keys to remove from the resource.

" - } - }, - "TagResourceRequest": { - "base": null, - "refs": {} - }, - "TagValue": { - "base": null, - "refs": { - "PropagateTagsExplicitTagsMap$value": null, - "Tags$value": null - } - }, - "TaggableResource": { - "base": null, - "refs": { - "ListTagsRequest$Resource": "

The resource's Amazon Resource Name (ARN). Note: Lambda does not support adding tags to function aliases or versions.

", - "TagResourceRequest$Resource": "

The resource's Amazon Resource Name (ARN).

", - "UntagResourceRequest$Resource": "

The resource's Amazon Resource Name (ARN).

" - } - }, - "Tags": { - "base": null, - "refs": { - "CreateCapacityProviderRequest$Tags": "

A list of tags to associate with the capacity provider.

", - "CreateCodeSigningConfigRequest$Tags": "

A list of tags to add to the code signing configuration.

", - "CreateEventSourceMappingRequest$Tags": "

A list of tags to apply to the event source mapping.

", - "CreateFunctionRequest$Tags": "

A list of tags to apply to the function.

", - "GetFunctionResponse$Tags": "

The function's tags. Lambda returns tag data only if you have explicit allow permissions for lambda:ListTags.

", - "ListTagsResponse$Tags": "

The function's tags.

", - "TagResourceRequest$Tags": "

A list of tags to apply to the resource.

" - } - }, - "TagsError": { - "base": "

An object that contains details about an error related to retrieving tags.

", - "refs": { - "GetFunctionResponse$TagsError": "

An object that contains details about an error related to retrieving tags.

" - } - }, - "TagsErrorCode": { - "base": null, - "refs": { - "TagsError$ErrorCode": "

The error code.

" - } - }, - "TagsErrorMessage": { - "base": null, - "refs": { - "TagsError$Message": "

The error message.

" - } - }, - "TargetTrackingScalingPolicy": { - "base": "

A scaling policy for the capacity provider that automatically adjusts capacity to maintain a target value for a specific metric.

", - "refs": { - "CapacityProviderScalingPoliciesList$member": null - } - }, - "TenancyConfig": { - "base": "

Specifies the tenant isolation mode configuration for a Lambda function. This allows you to configure specific tenant isolation strategies for your function invocations. Tenant isolation configuration cannot be modified after function creation.

", - "refs": { - "CreateFunctionRequest$TenancyConfig": "

Configuration for multi-tenant applications that use Lambda functions. Defines tenant isolation settings and resource allocations. Required for functions supporting multiple tenants.

", - "FunctionConfiguration$TenancyConfig": "

The function's tenant isolation configuration settings. Determines whether the Lambda function runs on a shared or dedicated infrastructure per unique tenant.

" - } - }, - "TenantId": { - "base": null, - "refs": { - "ChainedInvokeOptions$TenantId": "

The tenant identifier for the chained invocation.

", - "ChainedInvokeStartedDetails$TenantId": "

The tenant identifier for the chained invocation.

", - "InvocationRequest$TenantId": "

The identifier of the tenant in a multi-tenant Lambda function.

", - "InvokeWithResponseStreamRequest$TenantId": "

The identifier of the tenant in a multi-tenant Lambda function.

" - } - }, - "TenantIsolationMode": { - "base": null, - "refs": { - "TenancyConfig$TenantIsolationMode": "

Tenant isolation mode allows for invocation to be sent to a corresponding execution environment dedicated to a specific tenant ID.

" - } - }, - "ThrottleReason": { - "base": null, - "refs": { - "TooManyRequestsException$Reason": null - } - }, - "Timeout": { - "base": null, - "refs": { - "CreateFunctionRequest$Timeout": "

The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see Lambda execution environment.

", - "FunctionConfiguration$Timeout": "

The amount of time in seconds that Lambda allows a function to run before stopping it.

", - "UpdateFunctionConfigurationRequest$Timeout": "

The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see Lambda execution environment.

" - } - }, - "Timestamp": { - "base": null, - "refs": { - "CapacityProvider$LastModified": "

The date and time when the capacity provider was last modified.

", - "CodeSigningConfig$LastModified": "

The date and time that the Code signing configuration was last modified, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

", - "CreateFunctionUrlConfigResponse$CreationTime": "

When the function URL was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

", - "FunctionConfiguration$LastModified": "

The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

", - "FunctionUrlConfig$CreationTime": "

When the function URL was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

", - "FunctionUrlConfig$LastModifiedTime": "

When the function URL configuration was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

", - "GetFunctionUrlConfigResponse$CreationTime": "

When the function URL was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

", - "GetFunctionUrlConfigResponse$LastModifiedTime": "

When the function URL configuration was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

", - "GetLayerVersionResponse$CreatedDate": "

The date that the layer version was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

", - "GetProvisionedConcurrencyConfigResponse$LastModified": "

The date and time that a user last updated the configuration, in ISO 8601 format.

", - "LayerVersionsListItem$CreatedDate": "

The date that the version was created, in ISO 8601 format. For example, 2018-11-27T15:10:45.123+0000.

", - "ProvisionedConcurrencyConfigListItem$LastModified": "

The date and time that a user last updated the configuration, in ISO 8601 format.

", - "PublishLayerVersionResponse$CreatedDate": "

The date that the layer version was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

", - "PutProvisionedConcurrencyConfigResponse$LastModified": "

The date and time that a user last updated the configuration, in ISO 8601 format.

", - "UpdateFunctionUrlConfigResponse$CreationTime": "

When the function URL was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

", - "UpdateFunctionUrlConfigResponse$LastModifiedTime": "

When the function URL configuration was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" - } - }, - "TooManyRequestsException": { - "base": "

The request throughput limit was exceeded. For more information, see Lambda quotas.

", - "refs": {} - }, - "Topic": { - "base": null, - "refs": { - "Topics$member": null - } - }, - "Topics": { - "base": null, - "refs": { - "CreateEventSourceMappingRequest$Topics": "

The name of the Kafka topic.

", - "EventSourceMappingConfiguration$Topics": "

The name of the Kafka topic.

" - } - }, - "TraceHeader": { - "base": "

Contains trace headers for the Lambda durable execution.

", - "refs": { - "GetDurableExecutionResponse$TraceHeader": "

The trace headers associated with the durable execution.

" - } - }, - "TracingConfig": { - "base": "

The function's X-Ray tracing configuration. To sample and record incoming requests, set Mode to Active.

", - "refs": { - "CreateFunctionRequest$TracingConfig": "

Set Mode to Active to sample and trace a subset of incoming requests with X-Ray.

", - "UpdateFunctionConfigurationRequest$TracingConfig": "

Set Mode to Active to sample and trace a subset of incoming requests with X-Ray.

" - } - }, - "TracingConfigResponse": { - "base": "

The function's X-Ray tracing configuration.

", - "refs": { - "FunctionConfiguration$TracingConfig": "

The function's X-Ray tracing configuration.

" - } - }, - "TracingMode": { - "base": null, - "refs": { - "TracingConfig$Mode": "

The tracing mode.

", - "TracingConfigResponse$Mode": "

The tracing mode.

" - } - }, - "Truncated": { - "base": null, - "refs": { - "EventError$Truncated": "

Indicates if the error payload was truncated due to size limits.

", - "EventInput$Truncated": "

Indicates if the error payload was truncated due to size limits.

", - "EventResult$Truncated": "

Indicates if the error payload was truncated due to size limits.

" - } - }, - "TumblingWindowInSeconds": { - "base": null, - "refs": { - "CreateEventSourceMappingRequest$TumblingWindowInSeconds": "

(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.

", - "EventSourceMappingConfiguration$TumblingWindowInSeconds": "

(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.

", - "UpdateEventSourceMappingRequest$TumblingWindowInSeconds": "

(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.

" - } - }, - "URI": { - "base": null, - "refs": { - "AmazonManagedKafkaEventSourceConfig$ConsumerGroupId": "

The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see Customizable consumer group ID.

", - "SelfManagedKafkaEventSourceConfig$ConsumerGroupId": "

The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see Customizable consumer group ID.

", - "SourceAccessConfiguration$URI": "

The value for your chosen configuration in Type. For example: \"URI\": \"arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName\".

" - } - }, - "UUIDString": { - "base": null, - "refs": { - "DeleteEventSourceMappingRequest$UUID": "

The identifier of the event source mapping.

", - "EventSourceMappingConfiguration$UUID": "

The identifier of the event source mapping.

", - "GetEventSourceMappingRequest$UUID": "

The identifier of the event source mapping.

", - "UpdateEventSourceMappingRequest$UUID": "

The identifier of the event source mapping.

" - } - }, - "UnqualifiedFunctionName": { - "base": null, - "refs": { - "GetFunctionRecursionConfigRequest$FunctionName": "

The name of the function.

", - "GetFunctionScalingConfigRequest$FunctionName": "

The name or ARN of the Lambda function.

", - "PutFunctionRecursionConfigRequest$FunctionName": "

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "PutFunctionScalingConfigRequest$FunctionName": "

The name or ARN of the Lambda function.

" - } - }, - "UnreservedConcurrentExecutions": { - "base": null, - "refs": { - "AccountLimit$UnreservedConcurrentExecutions": "

The maximum number of simultaneous function executions, minus the capacity that's reserved for individual functions with PutFunctionConcurrency.

" - } - }, - "UnsupportedMediaTypeException": { - "base": "

The content type of the Invoke request body is not JSON.

", - "refs": {} - }, - "UntagResourceRequest": { - "base": null, - "refs": {} - }, - "UpdateAliasRequest": { - "base": null, - "refs": {} - }, - "UpdateCapacityProviderRequest": { - "base": null, - "refs": {} - }, - "UpdateCapacityProviderResponse": { - "base": null, - "refs": {} - }, - "UpdateCodeSigningConfigRequest": { - "base": null, - "refs": {} - }, - "UpdateCodeSigningConfigResponse": { - "base": null, - "refs": {} - }, - "UpdateEventSourceMappingRequest": { - "base": null, - "refs": {} - }, - "UpdateFunctionCodeRequest": { - "base": null, - "refs": {} - }, - "UpdateFunctionConfigurationRequest": { - "base": null, - "refs": {} - }, - "UpdateFunctionEventInvokeConfigRequest": { - "base": null, - "refs": {} - }, - "UpdateFunctionUrlConfigRequest": { - "base": null, - "refs": {} - }, - "UpdateFunctionUrlConfigResponse": { - "base": null, - "refs": {} - }, - "UpdateRuntimeOn": { - "base": null, - "refs": { - "GetRuntimeManagementConfigResponse$UpdateRuntimeOn": "

The current runtime update mode of the function.

", - "PutRuntimeManagementConfigRequest$UpdateRuntimeOn": "

Specify the runtime update mode.

  • Auto (default) - Automatically update to the most recent and secure runtime version using a Two-phase runtime version rollout. This is the best choice for most customers to ensure they always benefit from runtime updates.

  • Function update - Lambda updates the runtime of your function to the most recent and secure runtime version when you update your function. This approach synchronizes runtime updates with function deployments, giving you control over when runtime updates are applied and allowing you to detect and mitigate rare runtime update incompatibilities early. When using this setting, you need to regularly update your functions to keep their runtime up-to-date.

  • Manual - You specify a runtime version in your function configuration. The function will use this runtime version indefinitely. In the rare case where a new runtime version is incompatible with an existing function, this allows you to roll back your function to an earlier runtime version. For more information, see Roll back a runtime version.

", - "PutRuntimeManagementConfigResponse$UpdateRuntimeOn": "

The runtime update mode.

" - } - }, - "Version": { - "base": null, - "refs": { - "AliasConfiguration$FunctionVersion": "

The function version that the alias invokes.

", - "FunctionConfiguration$Version": "

The version of the Lambda function.

", - "InvocationResponse$ExecutedVersion": "

The version of the function that executed. When you invoke a function with an alias, this indicates which version the alias resolved to.

", - "InvokeWithResponseStreamResponse$ExecutedVersion": "

The version of the function that executed. When you invoke a function with an alias, this indicates which version the alias resolved to.

" - } - }, - "VersionWithLatestPublished": { - "base": null, - "refs": { - "ChainedInvokeStartedDetails$ExecutedVersion": "

The version of the function that was executed.

", - "CreateAliasRequest$FunctionVersion": "

The function version that the alias invokes.

", - "GetDurableExecutionResponse$Version": "

The version of the Lambda function that was invoked for this durable execution. This ensures that all replays during the execution use the same function version.

", - "ListAliasesRequest$FunctionVersion": "

Specify a function version to only list aliases that invoke that version.

", - "UpdateAliasRequest$FunctionVersion": "

The function version that the alias invokes.

" - } - }, - "VpcConfig": { - "base": "

The VPC security groups and subnets that are attached to a Lambda function. For more information, see Configuring a Lambda function to access resources in a VPC.

", - "refs": { - "CreateFunctionRequest$VpcConfig": "

For network connectivity to Amazon Web Services resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see Configuring a Lambda function to access resources in a VPC.

", - "UpdateFunctionConfigurationRequest$VpcConfig": "

For network connectivity to Amazon Web Services resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see Configuring a Lambda function to access resources in a VPC.

" - } - }, - "VpcConfigResponse": { - "base": "

The VPC security groups and subnets that are attached to a Lambda function.

", - "refs": { - "FunctionConfiguration$VpcConfig": "

The function's networking configuration.

" - } - }, - "VpcId": { - "base": null, - "refs": { - "VpcConfigResponse$VpcId": "

The ID of the VPC.

" - } - }, - "WaitCancelledDetails": { - "base": "

Details about a wait operation that was cancelled.

", - "refs": { - "Event$WaitCancelledDetails": "

Details about a wait operation that was cancelled.

" - } - }, - "WaitDetails": { - "base": "

Details about a wait operation.

", - "refs": { - "Operation$WaitDetails": "

Details about the wait operation, if this operation represents a wait.

" - } - }, - "WaitOptions": { - "base": "

Specifies how long to pause the durable execution.

", - "refs": { - "OperationUpdate$WaitOptions": "

Options for wait operations.

" - } - }, - "WaitOptionsWaitSecondsInteger": { - "base": null, - "refs": { - "WaitOptions$WaitSeconds": "

The duration to wait, in seconds.

" - } - }, - "WaitStartedDetails": { - "base": "

Details about a wait operation that has started.

", - "refs": { - "Event$WaitStartedDetails": "

Details about a wait operation that started.

" - } - }, - "WaitSucceededDetails": { - "base": "

Details about a wait operation that succeeded.

", - "refs": { - "Event$WaitSucceededDetails": "

Details about a wait operation that succeeded.

" - } - }, - "Weight": { - "base": null, - "refs": { - "AdditionalVersionWeights$value": null - } - }, - "WorkingDirectory": { - "base": null, - "refs": { - "ImageConfig$WorkingDirectory": "

Specifies the working directory.

" - } - }, - "XAmznTraceId": { - "base": null, - "refs": { - "TraceHeader$XAmznTraceId": "

The X-Ray trace header associated with the durable execution.

" - } - } - } -} diff --git a/tools/code-generation/api-descriptions/lambda/2015-03-31/endpoint-bdd-1.json b/tools/code-generation/api-descriptions/lambda/2015-03-31/endpoint-bdd-1.json deleted file mode 100644 index 2c05a12f0e07..000000000000 --- a/tools/code-generation/api-descriptions/lambda/2015-03-31/endpoint-bdd-1.json +++ /dev/null @@ -1,188 +0,0 @@ -{ - "version": "1.1", - "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" - } - }, - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - }, - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - }, - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "results": [ - { - "conditions": [], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://lambda-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": "https://lambda-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": "https://lambda.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": "https://lambda.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ], - "root": 2, - "nodeCount": 13, - "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" -} \ No newline at end of file diff --git a/tools/code-generation/api-descriptions/lambda/2015-03-31/endpoint-rule-set-1.json b/tools/code-generation/api-descriptions/lambda/2015-03-31/endpoint-rule-set-1.json deleted file mode 100644 index 96339d6fb782..000000000000 --- a/tools/code-generation/api-descriptions/lambda/2015-03-31/endpoint-rule-set-1.json +++ /dev/null @@ -1,314 +0,0 @@ -{ - "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": [ - { - "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" - }, - { - "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": [], - "endpoint": { - "url": "https://lambda-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "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": [], - "endpoint": { - "url": "https://lambda-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "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": [], - "endpoint": { - "url": "https://lambda.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://lambda.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] -} \ No newline at end of file diff --git a/tools/code-generation/api-descriptions/lambda/2015-03-31/endpoint-tests-1.json b/tools/code-generation/api-descriptions/lambda/2015-03-31/endpoint-tests-1.json deleted file mode 100644 index f32dfb175de2..000000000000 --- a/tools/code-generation/api-descriptions/lambda/2015-03-31/endpoint-tests-1.json +++ /dev/null @@ -1,920 +0,0 @@ -{ - "testCases": [ - { - "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lambda.af-south-1.amazonaws.com" - } - }, - "params": { - "Region": "af-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region af-south-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lambda.af-south-1.api.aws" - } - }, - "params": { - "Region": "af-south-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lambda.ap-east-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lambda.ap-east-1.api.aws" - } - }, - "params": { - "Region": "ap-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lambda.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lambda.ap-northeast-1.api.aws" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lambda.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lambda.ap-northeast-2.api.aws" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lambda.ap-northeast-3.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lambda.ap-northeast-3.api.aws" - } - }, - "params": { - "Region": "ap-northeast-3", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lambda.ap-south-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lambda.ap-south-1.api.aws" - } - }, - "params": { - "Region": "ap-south-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lambda.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lambda.ap-southeast-1.api.aws" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lambda.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lambda.ap-southeast-2.api.aws" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lambda.ap-southeast-3.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lambda.ap-southeast-3.api.aws" - } - }, - "params": { - "Region": "ap-southeast-3", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lambda.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lambda.ca-central-1.api.aws" - } - }, - "params": { - "Region": "ca-central-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lambda.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lambda.eu-central-1.api.aws" - } - }, - "params": { - "Region": "eu-central-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lambda.eu-north-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lambda.eu-north-1.api.aws" - } - }, - "params": { - "Region": "eu-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lambda.eu-south-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-south-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lambda.eu-south-1.api.aws" - } - }, - "params": { - "Region": "eu-south-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lambda.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lambda.eu-west-1.api.aws" - } - }, - "params": { - "Region": "eu-west-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lambda.eu-west-2.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lambda.eu-west-2.api.aws" - } - }, - "params": { - "Region": "eu-west-2", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lambda.eu-west-3.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lambda.eu-west-3.api.aws" - } - }, - "params": { - "Region": "eu-west-3", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lambda.me-south-1.amazonaws.com" - } - }, - "params": { - "Region": "me-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region me-south-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lambda.me-south-1.api.aws" - } - }, - "params": { - "Region": "me-south-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lambda.sa-east-1.amazonaws.com" - } - }, - "params": { - "Region": "sa-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lambda.sa-east-1.api.aws" - } - }, - "params": { - "Region": "sa-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lambda.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lambda-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://lambda.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lambda.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lambda-fips.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lambda.us-east-2.api.aws" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lambda.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lambda-fips.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lambda.us-west-1.api.aws" - } - }, - "params": { - "Region": "us-west-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lambda.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lambda-fips.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lambda.us-west-2.api.aws" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lambda-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lambda.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lambda.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lambda.cn-northwest-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-northwest-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lambda.cn-northwest-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-northwest-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lambda-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://lambda-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lambda.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lambda-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lambda.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lambda-fips.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lambda-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 disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lambda.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lambda.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lambda.us-iso-west-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lambda-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lambda.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lambda-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "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" -} \ No newline at end of file diff --git a/tools/code-generation/api-descriptions/lambda/2015-03-31/examples-1.json b/tools/code-generation/api-descriptions/lambda/2015-03-31/examples-1.json deleted file mode 100644 index 86f92bfe7e56..000000000000 --- a/tools/code-generation/api-descriptions/lambda/2015-03-31/examples-1.json +++ /dev/null @@ -1,1234 +0,0 @@ -{ - "version": "1.0", - "examples": { - "AddLayerVersionPermission": [ - { - "input": { - "Action": "lambda:GetLayerVersion", - "LayerName": "my-layer", - "Principal": "223456789012", - "StatementId": "xaccount", - "VersionNumber": 1 - }, - "output": { - "RevisionId": "35d87451-f796-4a3f-a618-95a3671b0a0c", - "Statement": "{\"Sid\":\"xaccount\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::223456789012:root\"},\"Action\":\"lambda:GetLayerVersion\",\"Resource\":\"arn:aws:lambda:us-east-2:123456789012:layer:my-layer:1\"}" - }, - "description": "The following example grants permission for the account 223456789012 to use version 1 of a layer named my-layer.", - "id": "example-1", - "title": "To add permissions to a layer version" - } - ], - "AddPermission": [ - { - "input": { - "Action": "lambda:InvokeFunction", - "FunctionName": "my-function", - "Principal": "s3.amazonaws.com", - "SourceAccount": "123456789012", - "SourceArn": "arn:aws:s3:::my-bucket-1xpuxmplzrlbh/*", - "StatementId": "s3" - }, - "output": { - "Statement": "{\"Sid\":\"s3\",\"Effect\":\"Allow\",\"Principal\":{\"Service\":\"s3.amazonaws.com\"},\"Action\":\"lambda:InvokeFunction\",\"Resource\":\"arn:aws:lambda:us-east-2:123456789012:function:my-function\",\"Condition\":{\"StringEquals\":{\"AWS:SourceAccount\":\"123456789012\"},\"ArnLike\":{\"AWS:SourceArn\":\"arn:aws:s3:::my-bucket-1xpuxmplzrlbh\"}}}" - }, - "description": "The following example adds permission for Amazon S3 to invoke a Lambda function named my-function for notifications from a bucket named my-bucket-1xpuxmplzrlbh in account 123456789012.", - "id": "example-1", - "title": "To grant Amazon S3 permission to invoke a function" - }, - { - "input": { - "Action": "lambda:InvokeFunction", - "FunctionName": "my-function", - "Principal": "223456789012", - "StatementId": "xaccount" - }, - "output": { - "Statement": "{\"Sid\":\"xaccount\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::223456789012:root\"},\"Action\":\"lambda:InvokeFunction\",\"Resource\":\"arn:aws:lambda:us-east-2:123456789012:function:my-function\"}" - }, - "description": "The following example adds permission for account 223456789012 invoke a Lambda function named my-function.", - "id": "example-2", - "title": "To grant another account permission to invoke a function" - } - ], - "CreateAlias": [ - { - "input": { - "Description": "alias for live version of function", - "FunctionName": "my-function", - "FunctionVersion": "1", - "Name": "LIVE" - }, - "output": { - "AliasArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:LIVE", - "Description": "alias for live version of function", - "FunctionVersion": "1", - "Name": "LIVE", - "RevisionId": "873282ed-xmpl-4dc8-a069-d0c647e470c6" - }, - "description": "The following example creates an alias named LIVE that points to version 1 of the my-function Lambda function.", - "id": "example-1", - "title": "To create an alias for a Lambda function" - } - ], - "CreateEventSourceMapping": [ - { - "input": { - "BatchSize": 5, - "EventSourceArn": "arn:aws:sqs:us-west-2:123456789012:my-queue", - "FunctionName": "my-function" - }, - "output": { - "BatchSize": 5, - "EventSourceArn": "arn:aws:sqs:us-west-2:123456789012:my-queue", - "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", - "LastModified": 1569284520.333, - "State": "Creating", - "StateTransitionReason": "USER_INITIATED", - "UUID": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" - }, - "description": "The following example creates a mapping between an SQS queue and the my-function Lambda function.", - "id": "example-1", - "title": "To create a mapping between an event source and an AWS Lambda function" - } - ], - "CreateFunction": [ - { - "input": { - "Code": { - "S3Bucket": "my-bucket-1xpuxmplzrlbh", - "S3Key": "function.zip" - }, - "Description": "Process image objects from Amazon S3.", - "DurableConfig": { - "ExecutionTimeout": 31622400, - "RetentionPeriodInDays": 30 - }, - "Environment": { - "Variables": { - "BUCKET": "my-bucket-1xpuxmplzrlbh", - "PREFIX": "inbound" - } - }, - "FunctionName": "my-function", - "Handler": "index.handler", - "KMSKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", - "MemorySize": 256, - "Publish": true, - "Role": "arn:aws:iam::123456789012:role/lambda-role", - "Runtime": "nodejs12.x", - "Tags": { - "DEPARTMENT": "Assets" - }, - "Timeout": 15, - "TracingConfig": { - "Mode": "Active" - } - }, - "output": { - "CodeSha256": "YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=", - "CodeSize": 5797206, - "Description": "Process image objects from Amazon S3.", - "DurableConfig": { - "ExecutionTimeout": 31622400, - "RetentionPeriodInDays": 30 - }, - "Environment": { - "Variables": { - "BUCKET": "my-bucket-1xpuxmplzrlbh", - "PREFIX": "inbound" - } - }, - "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", - "FunctionName": "my-function", - "Handler": "index.handler", - "KMSKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", - "LastModified": "2020-04-10T19:06:32.563+0000", - "LastUpdateStatus": "Successful", - "MemorySize": 256, - "RevisionId": "b75dcd81-xmpl-48a8-a75a-93ba8b5b9727", - "Role": "arn:aws:iam::123456789012:role/lambda-role", - "Runtime": "nodejs12.x", - "State": "Active", - "Timeout": 15, - "TracingConfig": { - "Mode": "Active" - }, - "Version": "1" - }, - "description": "The following example creates a function with a deployment package in Amazon S3 and enables X-Ray tracing and environment variable encryption.", - "id": "example-1", - "title": "To create a function" - } - ], - "DeleteAlias": [ - { - "input": { - "FunctionName": "my-function", - "Name": "BLUE" - }, - "description": "The following example deletes an alias named BLUE from a function named my-function", - "id": "example-1", - "title": "To delete a Lambda function alias" - } - ], - "DeleteEventSourceMapping": [ - { - "input": { - "UUID": "14e0db71-xmpl-4eb5-b481-8945cf9d10c2" - }, - "output": { - "BatchSize": 5, - "EventSourceArn": "arn:aws:sqs:us-west-2:123456789012:my-queue", - "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function", - "LastModified": "2016-11-21T19:49:20.006Z", - "State": "Enabled", - "StateTransitionReason": "USER_INITIATED", - "UUID": "14e0db71-xmpl-4eb5-b481-8945cf9d10c2" - }, - "description": "The following example deletes an event source mapping. To get a mapping's UUID, use ListEventSourceMappings.", - "id": "example-1", - "title": "To delete a Lambda function event source mapping" - } - ], - "DeleteFunction": [ - { - "input": { - "FunctionName": "my-function", - "Qualifier": "1" - }, - "description": "The following example deletes version 1 of a Lambda function named my-function.", - "id": "example-1", - "title": "To delete a version of a Lambda function" - } - ], - "DeleteFunctionConcurrency": [ - { - "input": { - "FunctionName": "my-function" - }, - "description": "The following example deletes the reserved concurrent execution limit from a function named my-function.", - "id": "example-1", - "title": "To remove the reserved concurrent execution limit from a function" - } - ], - "DeleteFunctionEventInvokeConfig": [ - { - "input": { - "FunctionName": "my-function", - "Qualifier": "GREEN" - }, - "description": "The following example deletes the asynchronous invocation configuration for the GREEN alias of a function named my-function.", - "id": "example-1", - "title": "To delete an asynchronous invocation configuration" - } - ], - "DeleteLayerVersion": [ - { - "input": { - "LayerName": "my-layer", - "VersionNumber": 2 - }, - "description": "The following example deletes version 2 of a layer named my-layer.", - "id": "example-1", - "title": "To delete a version of a Lambda layer" - } - ], - "DeleteProvisionedConcurrencyConfig": [ - { - "input": { - "FunctionName": "my-function", - "Qualifier": "GREEN" - }, - "description": "The following example deletes the provisioned concurrency configuration for the GREEN alias of a function named my-function.", - "id": "example-1", - "title": "To delete a provisioned concurrency configuration" - } - ], - "GetAccountSettings": [ - { - "input": {}, - "output": { - "AccountLimit": { - "CodeSizeUnzipped": 262144000, - "CodeSizeZipped": 52428800, - "ConcurrentExecutions": 1000, - "TotalCodeSize": 80530636800, - "UnreservedConcurrentExecutions": 1000 - }, - "AccountUsage": { - "FunctionCount": 4, - "TotalCodeSize": 9426 - } - }, - "description": "This operation takes no parameters and returns details about storage and concurrency quotas in the current Region.", - "id": "example-1", - "title": "To get account settings" - } - ], - "GetAlias": [ - { - "input": { - "FunctionName": "my-function", - "Name": "BLUE" - }, - "output": { - "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:BLUE", - "Description": "Production environment BLUE.", - "FunctionVersion": "3", - "Name": "BLUE", - "RevisionId": "594f41fb-xmpl-4c20-95c7-6ca5f2a92c93" - }, - "description": "The following example returns details about an alias named BLUE for a function named my-function", - "id": "example-1", - "title": "To get a Lambda function alias" - } - ], - "GetEventSourceMapping": [ - { - "input": { - "UUID": "14e0db71-xmpl-4eb5-b481-8945cf9d10c2" - }, - "output": { - "BatchSize": 500, - "BisectBatchOnFunctionError": false, - "DestinationConfig": {}, - "EventSourceArn": "arn:aws:sqs:us-east-2:123456789012:mySQSqueue", - "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:myFunction", - "LastModified": "2016-11-21T19:49:20.006Z", - "LastProcessingResult": "No records processed", - "MaximumRecordAgeInSeconds": 604800, - "MaximumRetryAttempts": 10000, - "State": "Creating", - "StateTransitionReason": "User action", - "UUID": "14e0db71-xmpl-4eb5-b481-8945cf9d10c2" - }, - "description": "The following example returns details about an event source mapping. To get a mapping's UUID, use ListEventSourceMappings.", - "id": "example-1", - "title": "To get a Lambda function's event source mapping" - } - ], - "GetFunction": [ - { - "input": { - "FunctionName": "my-function", - "Qualifier": "1" - }, - "output": { - "Code": { - "Location": "https://awslambda-us-west-2-tasks.s3.us-west-2.amazonaws.com/snapshots/123456789012/my-function-e7d9d1ed-xmpl-4f79-904a-4b87f2681f30?versionId=sH3TQwBOaUy...", - "RepositoryType": "S3" - }, - "Configuration": { - "CodeSha256": "YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=", - "CodeSize": 5797206, - "Description": "Process image objects from Amazon S3.", - "DurableConfig": { - "ExecutionTimeout": 31622400, - "RetentionPeriodInDays": 30 - }, - "Environment": { - "Variables": { - "BUCKET": "my-bucket-1xpuxmplzrlbh", - "PREFIX": "inbound" - } - }, - "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", - "FunctionName": "my-function", - "Handler": "index.handler", - "KMSKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", - "LastModified": "2020-04-10T19:06:32.563+0000", - "LastUpdateStatus": "Successful", - "MemorySize": 256, - "RevisionId": "b75dcd81-xmpl-48a8-a75a-93ba8b5b9727", - "Role": "arn:aws:iam::123456789012:role/lambda-role", - "Runtime": "nodejs12.x", - "State": "Active", - "Timeout": 15, - "TracingConfig": { - "Mode": "Active" - }, - "Version": "$LATEST" - }, - "Tags": { - "DEPARTMENT": "Assets" - } - }, - "description": "The following example returns code and configuration details for version 1 of a function named my-function.", - "id": "example-1", - "title": "To get a Lambda function" - } - ], - "GetFunctionConcurrency": [ - { - "input": { - "FunctionName": "my-function" - }, - "output": { - "ReservedConcurrentExecutions": 250 - }, - "description": "The following example returns the reserved concurrency setting for a function named my-function.", - "id": "example-1", - "title": "To get the reserved concurrency setting for a function" - } - ], - "GetFunctionConfiguration": [ - { - "input": { - "FunctionName": "my-function", - "Qualifier": "1" - }, - "output": { - "CodeSha256": "YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=", - "CodeSize": 5797206, - "Description": "Process image objects from Amazon S3.", - "DurableConfig": { - "ExecutionTimeout": 31622400, - "RetentionPeriodInDays": 30 - }, - "Environment": { - "Variables": { - "BUCKET": "my-bucket-1xpuxmplzrlbh", - "PREFIX": "inbound" - } - }, - "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", - "FunctionName": "my-function", - "Handler": "index.handler", - "KMSKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", - "LastModified": "2020-04-10T19:06:32.563+0000", - "LastUpdateStatus": "Successful", - "MemorySize": 256, - "RevisionId": "b75dcd81-xmpl-48a8-a75a-93ba8b5b9727", - "Role": "arn:aws:iam::123456789012:role/lambda-role", - "Runtime": "nodejs12.x", - "State": "Active", - "Timeout": 15, - "TracingConfig": { - "Mode": "Active" - }, - "Version": "$LATEST" - }, - "description": "The following example returns and configuration details for version 1 of a function named my-function.", - "id": "example-1", - "title": "To get a Lambda function's event source mapping" - } - ], - "GetFunctionEventInvokeConfig": [ - { - "input": { - "FunctionName": "my-function", - "Qualifier": "BLUE" - }, - "output": { - "DestinationConfig": { - "OnFailure": { - "Destination": "arn:aws:sqs:us-east-2:123456789012:failed-invocations" - }, - "OnSuccess": {} - }, - "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:BLUE", - "LastModified": "2016-11-21T19:49:20.006Z", - "MaximumEventAgeInSeconds": 3600, - "MaximumRetryAttempts": 0 - }, - "description": "The following example returns the asynchronous invocation configuration for the BLUE alias of a function named my-function.", - "id": "example-1", - "title": "To get an asynchronous invocation configuration" - } - ], - "GetLayerVersion": [ - { - "input": { - "LayerName": "my-layer", - "VersionNumber": 1 - }, - "output": { - "CompatibleRuntimes": [ - "python3.6", - "python3.7" - ], - "Content": { - "CodeSha256": "tv9jJO+rPbXUUXuRKi7CwHzKtLDkDRJLB3cC3Z/ouXo=", - "CodeSize": 169, - "Location": "https://awslambda-us-east-2-layers.s3.us-east-2.amazonaws.com/snapshots/123456789012/my-layer-4aaa2fbb-ff77-4b0a-ad92-5b78a716a96a?versionId=27iWyA73cCAYqyH..." - }, - "CreatedDate": "2018-11-14T23:03:52.894+0000", - "Description": "My Python layer", - "LayerArn": "arn:aws:lambda:us-east-2:123456789012:layer:my-layer", - "LayerVersionArn": "arn:aws:lambda:us-east-2:123456789012:layer:my-layer:1", - "LicenseInfo": "MIT", - "Version": 1 - }, - "description": "The following example returns information for version 1 of a layer named my-layer.", - "id": "example-1", - "title": "To get information about a Lambda layer version" - } - ], - "GetLayerVersionByArn": [ - { - "input": { - "Arn": "arn:aws:lambda:ca-central-1:123456789012:layer:blank-python-lib:3" - }, - "output": { - "CompatibleRuntimes": [ - "python3.8" - ], - "Content": { - "CodeSha256": "6x+xmpl/M3BnQUk7gS9sGmfeFsR/npojXoA3fZUv4eU=", - "CodeSize": 9529009, - "Location": "https://awslambda-us-east-2-layers.s3.us-east-2.amazonaws.com/snapshots/123456789012/blank-python-lib-e5212378-xmpl-44ee-8398-9d8ec5113949?versionId=WbZnvf..." - }, - "CreatedDate": "2020-03-31T00:35:18.949+0000", - "Description": "Dependencies for the blank-python sample app.", - "LayerArn": "arn:aws:lambda:us-east-2:123456789012:layer:blank-python-lib", - "LayerVersionArn": "arn:aws:lambda:us-east-2:123456789012:layer:blank-python-lib:3", - "Version": 3 - }, - "description": "The following example returns information about the layer version with the specified Amazon Resource Name (ARN).", - "id": "example-1", - "title": "To get information about a Lambda layer version" - } - ], - "GetPolicy": [ - { - "input": { - "FunctionName": "my-function", - "Qualifier": "1" - }, - "output": { - "Policy": "{\"Version\":\"2012-10-17\",\"Id\":\"default\",\"Statement\":[{\"Sid\":\"xaccount\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:root\"},\"Action\":\"lambda:InvokeFunction\",\"Resource\":\"arn:aws:lambda:us-east-2:123456789012:function:my-function:1\"}]}", - "RevisionId": "4843f2f6-7c59-4fda-b484-afd0bc0e22b8" - }, - "description": "The following example returns the resource-based policy for version 1 of a Lambda function named my-function.", - "id": "example-1", - "title": "To retrieve a Lambda function policy" - } - ], - "GetProvisionedConcurrencyConfig": [ - { - "input": { - "FunctionName": "my-function", - "Qualifier": "BLUE" - }, - "output": { - "AllocatedProvisionedConcurrentExecutions": 100, - "AvailableProvisionedConcurrentExecutions": 100, - "LastModified": "2019-12-31T20:28:49+0000", - "RequestedProvisionedConcurrentExecutions": 100, - "Status": "READY" - }, - "description": "The following example returns details for the provisioned concurrency configuration for the BLUE alias of the specified function.", - "id": "example-1", - "title": "To get a provisioned concurrency configuration" - }, - { - "input": { - "FunctionName": "my-function", - "Qualifier": "BLUE" - }, - "output": { - "AllocatedProvisionedConcurrentExecutions": 100, - "AvailableProvisionedConcurrentExecutions": 100, - "LastModified": "2019-12-31T20:28:49+0000", - "RequestedProvisionedConcurrentExecutions": 100, - "Status": "READY" - }, - "description": "The following example displays details for the provisioned concurrency configuration for the BLUE alias of the specified function.", - "id": "example-2", - "title": "To view a provisioned concurrency configuration" - } - ], - "Invoke": [ - { - "input": { - "DurableExecutionName": "myExecution", - "FunctionName": "my-function", - "InvocationType": "Event", - "Payload": "{}", - "Qualifier": "1" - }, - "output": { - "Payload": "200 SUCCESS", - "StatusCode": 200 - }, - "description": "The following example invokes version 1 of a function named my-function with an empty event payload.", - "id": "example-1", - "title": "To invoke a Lambda function" - }, - { - "input": { - "FunctionName": "my-function", - "InvocationType": "Event", - "Payload": "{}", - "Qualifier": "1" - }, - "output": { - "Payload": "", - "StatusCode": 202 - }, - "description": "The following example invokes version 1 of a function named my-function asynchronously.", - "id": "example-2", - "title": "To invoke a Lambda function asynchronously" - } - ], - "InvokeAsync": [ - { - "input": { - "FunctionName": "my-function", - "InvokeArgs": "{}" - }, - "output": { - "Status": 202 - }, - "description": "The following example invokes a Lambda function asynchronously", - "id": "example-1", - "title": "To invoke a Lambda function asynchronously" - } - ], - "ListAliases": [ - { - "input": { - "FunctionName": "my-function" - }, - "output": { - "Aliases": [ - { - "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:BETA", - "Description": "Production environment BLUE.", - "FunctionVersion": "2", - "Name": "BLUE", - "RevisionId": "a410117f-xmpl-494e-8035-7e204bb7933b", - "RoutingConfig": { - "AdditionalVersionWeights": { - "1": 0.7 - } - } - }, - { - "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:LIVE", - "Description": "Production environment GREEN.", - "FunctionVersion": "1", - "Name": "GREEN", - "RevisionId": "21d40116-xmpl-40ba-9360-3ea284da1bb5" - } - ] - }, - "description": "The following example returns a list of aliases for a function named my-function.", - "id": "example-1", - "title": "To list a function's aliases" - } - ], - "ListEventSourceMappings": [ - { - "input": { - "FunctionName": "my-function" - }, - "output": { - "EventSourceMappings": [ - { - "BatchSize": 5, - "EventSourceArn": "arn:aws:sqs:us-west-2:123456789012:mySQSqueue", - "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", - "LastModified": 1569284520.333, - "State": "Enabled", - "StateTransitionReason": "USER_INITIATED", - "UUID": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" - } - ] - }, - "description": "The following example returns a list of the event source mappings for a function named my-function.", - "id": "example-1", - "title": "To list the event source mappings for a function" - } - ], - "ListFunctionEventInvokeConfigs": [ - { - "input": { - "FunctionName": "my-function" - }, - "output": { - "FunctionEventInvokeConfigs": [ - { - "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:GREEN", - "LastModified": 1577824406.719, - "MaximumEventAgeInSeconds": 1800, - "MaximumRetryAttempts": 2 - }, - { - "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:BLUE", - "LastModified": 1577824396.653, - "MaximumEventAgeInSeconds": 3600, - "MaximumRetryAttempts": 0 - } - ] - }, - "description": "The following example returns a list of asynchronous invocation configurations for a function named my-function.", - "id": "example-1", - "title": "To view a list of asynchronous invocation configurations" - } - ], - "ListFunctions": [ - { - "input": {}, - "output": { - "Functions": [ - { - "CodeSha256": "dBG9m8SGdmlEjw/JYXlhhvCrAv5TxvXsbL/RMr0fT/I=", - "CodeSize": 294, - "Description": "", - "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:helloworld", - "FunctionName": "helloworld", - "Handler": "helloworld.handler", - "LastModified": "2019-09-23T18:32:33.857+0000", - "MemorySize": 128, - "RevisionId": "1718e831-badf-4253-9518-d0644210af7b", - "Role": "arn:aws:iam::123456789012:role/service-role/MyTestFunction-role-zgur6bf4", - "Runtime": "nodejs10.x", - "Timeout": 3, - "TracingConfig": { - "Mode": "PassThrough" - }, - "Version": "$LATEST" - }, - { - "CodeSha256": "sU0cJ2/hOZevwV/lTxCuQqK3gDZP3i8gUoqUUVRmY6E=", - "CodeSize": 266, - "Description": "", - "DurableConfig": { - "ExecutionTimeout": 31622400, - "RetentionPeriodInDays": 30 - }, - "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", - "FunctionName": "my-function", - "Handler": "index.handler", - "LastModified": "2019-10-01T16:47:28.490+0000", - "MemorySize": 256, - "RevisionId": "93017fc9-59cb-41dc-901b-4845ce4bf668", - "Role": "arn:aws:iam::123456789012:role/service-role/helloWorldPython-role-uy3l9qyq", - "Runtime": "nodejs10.x", - "Timeout": 3, - "TracingConfig": { - "Mode": "PassThrough" - }, - "Version": "$LATEST", - "VpcConfig": { - "SecurityGroupIds": [], - "SubnetIds": [], - "VpcId": "" - } - } - ], - "NextMarker": "" - }, - "description": "This operation returns a list of Lambda functions.", - "id": "example-1", - "title": "To get a list of Lambda functions" - } - ], - "ListLayerVersions": [ - { - "input": { - "LayerName": "blank-java-lib" - }, - "output": { - "LayerVersions": [ - { - "CompatibleRuntimes": [ - "java8" - ], - "CreatedDate": "2020-03-18T23:38:42.284+0000", - "Description": "Dependencies for the blank-java sample app.", - "LayerVersionArn": "arn:aws:lambda:us-east-2:123456789012:layer:blank-java-lib:7", - "Version": 7 - }, - { - "CompatibleRuntimes": [ - "java8" - ], - "CreatedDate": "2020-03-17T07:24:21.960+0000", - "Description": "Dependencies for the blank-java sample app.", - "LayerVersionArn": "arn:aws:lambda:us-east-2:123456789012:layer:blank-java-lib:6", - "Version": 6 - } - ] - }, - "description": "The following example displays information about the versions for the layer named blank-java-lib", - "id": "example-1", - "title": "To list versions of a layer" - } - ], - "ListLayers": [ - { - "input": { - "CompatibleRuntime": "python3.7" - }, - "output": { - "Layers": [ - { - "LatestMatchingVersion": { - "CompatibleRuntimes": [ - "python3.6", - "python3.7" - ], - "CreatedDate": "2018-11-15T00:37:46.592+0000", - "Description": "My layer", - "LayerVersionArn": "arn:aws:lambda:us-east-2:123456789012:layer:my-layer:2", - "Version": 2 - }, - "LayerArn": "arn:aws:lambda:us-east-2:123456789012:layer:my-layer", - "LayerName": "my-layer" - } - ] - }, - "description": "The following example returns information about layers that are compatible with the Python 3.7 runtime.", - "id": "example-1", - "title": "To list the layers that are compatible with your function's runtime" - } - ], - "ListProvisionedConcurrencyConfigs": [ - { - "input": { - "FunctionName": "my-function" - }, - "output": { - "ProvisionedConcurrencyConfigs": [ - { - "AllocatedProvisionedConcurrentExecutions": 100, - "AvailableProvisionedConcurrentExecutions": 100, - "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:GREEN", - "LastModified": "2019-12-31T20:29:00+0000", - "RequestedProvisionedConcurrentExecutions": 100, - "Status": "READY" - }, - { - "AllocatedProvisionedConcurrentExecutions": 100, - "AvailableProvisionedConcurrentExecutions": 100, - "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:BLUE", - "LastModified": "2019-12-31T20:28:49+0000", - "RequestedProvisionedConcurrentExecutions": 100, - "Status": "READY" - } - ] - }, - "description": "The following example returns a list of provisioned concurrency configurations for a function named my-function.", - "id": "example-1", - "title": "To get a list of provisioned concurrency configurations" - } - ], - "ListTags": [ - { - "input": { - "Resource": "arn:aws:lambda:us-west-2:123456789012:function:my-function" - }, - "output": { - "Tags": { - "Category": "Web Tools", - "Department": "Sales" - } - }, - "description": "The following example displays the tags attached to the my-function Lambda function.", - "id": "example-1", - "title": "To retrieve the list of tags for a Lambda function" - } - ], - "ListVersionsByFunction": [ - { - "input": { - "FunctionName": "my-function" - }, - "output": { - "Versions": [ - { - "CodeSha256": "YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=", - "CodeSize": 5797206, - "Description": "Process image objects from Amazon S3.", - "DurableConfig": { - "ExecutionTimeout": 31622400, - "RetentionPeriodInDays": 30 - }, - "Environment": { - "Variables": { - "BUCKET": "my-bucket-1xpuxmplzrlbh", - "PREFIX": "inbound" - } - }, - "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", - "FunctionName": "my-function", - "Handler": "index.handler", - "KMSKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", - "LastModified": "2020-04-10T19:06:32.563+0000", - "MemorySize": 256, - "RevisionId": "850ca006-2d98-4ff4-86db-8766e9d32fe9", - "Role": "arn:aws:iam::123456789012:role/lambda-role", - "Runtime": "nodejs12.x", - "Timeout": 15, - "TracingConfig": { - "Mode": "Active" - }, - "Version": "$LATEST" - }, - { - "CodeSha256": "YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=", - "CodeSize": 5797206, - "Description": "Process image objects from Amazon S3.", - "DurableConfig": { - "ExecutionTimeout": 31622400, - "RetentionPeriodInDays": 30 - }, - "Environment": { - "Variables": { - "BUCKET": "my-bucket-1xpuxmplzrlbh", - "PREFIX": "inbound" - } - }, - "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", - "FunctionName": "my-function", - "Handler": "index.handler", - "KMSKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", - "LastModified": "2020-04-10T19:06:32.563+0000", - "MemorySize": 256, - "RevisionId": "b75dcd81-xmpl-48a8-a75a-93ba8b5b9727", - "Role": "arn:aws:iam::123456789012:role/lambda-role", - "Runtime": "nodejs12.x", - "Timeout": 5, - "TracingConfig": { - "Mode": "Active" - }, - "Version": "1" - } - ] - }, - "description": "The following example returns a list of versions of a function named my-function", - "id": "example-1", - "title": "To list versions of a function" - } - ], - "PublishLayerVersion": [ - { - "input": { - "CompatibleRuntimes": [ - "python3.6", - "python3.7" - ], - "Content": { - "S3Bucket": "lambda-layers-us-west-2-123456789012", - "S3Key": "layer.zip" - }, - "Description": "My Python layer", - "LayerName": "my-layer", - "LicenseInfo": "MIT" - }, - "output": { - "CompatibleRuntimes": [ - "python3.6", - "python3.7" - ], - "Content": { - "CodeSha256": "tv9jJO+rPbXUUXuRKi7CwHzKtLDkDRJLB3cC3Z/ouXo=", - "CodeSize": 169, - "Location": "https://awslambda-us-west-2-layers.s3.us-west-2.amazonaws.com/snapshots/123456789012/my-layer-4aaa2fbb-ff77-4b0a-ad92-5b78a716a96a?versionId=27iWyA73cCAYqyH..." - }, - "CreatedDate": "2018-11-14T23:03:52.894+0000", - "Description": "My Python layer", - "LayerArn": "arn:aws:lambda:us-west-2:123456789012:layer:my-layer", - "LayerVersionArn": "arn:aws:lambda:us-west-2:123456789012:layer:my-layer:1", - "LicenseInfo": "MIT", - "Version": 1 - }, - "description": "The following example creates a new Python library layer version. The command retrieves the layer content a file named layer.zip in the specified S3 bucket.", - "id": "example-1", - "title": "To create a Lambda layer version" - } - ], - "PublishVersion": [ - { - "input": { - "CodeSha256": "", - "Description": "", - "FunctionName": "myFunction" - }, - "output": { - "CodeSha256": "YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=", - "CodeSize": 5797206, - "Description": "Process image objects from Amazon S3.", - "Environment": { - "Variables": { - "BUCKET": "my-bucket-1xpuxmplzrlbh", - "PREFIX": "inbound" - } - }, - "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", - "FunctionName": "my-function", - "Handler": "index.handler", - "KMSKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", - "LastModified": "2020-04-10T19:06:32.563+0000", - "LastUpdateStatus": "Successful", - "MemorySize": 256, - "RevisionId": "b75dcd81-xmpl-48a8-a75a-93ba8b5b9727", - "Role": "arn:aws:iam::123456789012:role/lambda-role", - "Runtime": "nodejs12.x", - "State": "Active", - "Timeout": 5, - "TracingConfig": { - "Mode": "Active" - }, - "Version": "1" - }, - "description": "This operation publishes a version of a Lambda function", - "id": "example-1", - "title": "To publish a version of a Lambda function" - } - ], - "PutFunctionConcurrency": [ - { - "input": { - "FunctionName": "my-function", - "ReservedConcurrentExecutions": 100 - }, - "output": { - "ReservedConcurrentExecutions": 100 - }, - "description": "The following example configures 100 reserved concurrent executions for the my-function function.", - "id": "example-1", - "title": "To configure a reserved concurrency limit for a function" - } - ], - "PutFunctionEventInvokeConfig": [ - { - "input": { - "FunctionName": "my-function", - "MaximumEventAgeInSeconds": 3600, - "MaximumRetryAttempts": 0 - }, - "output": { - "DestinationConfig": { - "OnFailure": {}, - "OnSuccess": {} - }, - "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:$LATEST", - "LastModified": "2016-11-21T19:49:20.006Z", - "MaximumEventAgeInSeconds": 3600, - "MaximumRetryAttempts": 0 - }, - "description": "The following example sets a maximum event age of one hour and disables retries for the specified function.", - "id": "example-1", - "title": "To configure error handling for asynchronous invocation" - } - ], - "PutProvisionedConcurrencyConfig": [ - { - "input": { - "FunctionName": "my-function", - "ProvisionedConcurrentExecutions": 100, - "Qualifier": "BLUE" - }, - "output": { - "AllocatedProvisionedConcurrentExecutions": 0, - "LastModified": "2019-11-21T19:32:12+0000", - "RequestedProvisionedConcurrentExecutions": 100, - "Status": "IN_PROGRESS" - }, - "description": "The following example allocates 100 provisioned concurrency for the BLUE alias of the specified function.", - "id": "example-1", - "title": "To allocate provisioned concurrency" - } - ], - "RemoveLayerVersionPermission": [ - { - "input": { - "LayerName": "my-layer", - "StatementId": "xaccount", - "VersionNumber": 1 - }, - "description": "The following example deletes permission for an account to configure a layer version.", - "id": "example-1", - "title": "To delete layer-version permissions" - } - ], - "RemovePermission": [ - { - "input": { - "FunctionName": "my-function", - "Qualifier": "PROD", - "StatementId": "xaccount" - }, - "description": "The following example removes a permissions statement named xaccount from the PROD alias of a function named my-function.", - "id": "example-1", - "title": "To remove a Lambda function's permissions" - } - ], - "TagResource": [ - { - "input": { - "Resource": "arn:aws:lambda:us-west-2:123456789012:function:my-function", - "Tags": { - "DEPARTMENT": "Department A" - } - }, - "description": "The following example adds a tag with the key name DEPARTMENT and a value of 'Department A' to the specified Lambda function.", - "id": "example-1", - "title": "To add tags to an existing Lambda function" - } - ], - "UntagResource": [ - { - "input": { - "Resource": "arn:aws:lambda:us-west-2:123456789012:function:my-function", - "TagKeys": [ - "DEPARTMENT" - ] - }, - "description": "The following example removes the tag with the key name DEPARTMENT tag from the my-function Lambda function.", - "id": "example-1", - "title": "To remove tags from an existing Lambda function" - } - ], - "UpdateAlias": [ - { - "input": { - "FunctionName": "my-function", - "FunctionVersion": "2", - "Name": "BLUE", - "RoutingConfig": { - "AdditionalVersionWeights": { - "1": 0.7 - } - } - }, - "output": { - "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:BLUE", - "Description": "Production environment BLUE.", - "FunctionVersion": "2", - "Name": "BLUE", - "RevisionId": "594f41fb-xmpl-4c20-95c7-6ca5f2a92c93", - "RoutingConfig": { - "AdditionalVersionWeights": { - "1": 0.7 - } - } - }, - "description": "The following example updates the alias named BLUE to send 30% of traffic to version 2 and 70% to version 1.", - "id": "example-1", - "title": "To update a function alias" - } - ], - "UpdateEventSourceMapping": [ - { - "input": { - "BatchSize": 123, - "Enabled": true, - "FunctionName": "myFunction", - "UUID": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" - }, - "output": { - "BatchSize": 123, - "EventSourceArn": "arn:aws:s3:::examplebucket/*", - "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:myFunction", - "LastModified": "2016-11-21T19:49:20.006Z", - "LastProcessingResult": "", - "State": "", - "StateTransitionReason": "", - "UUID": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" - }, - "description": "This operation updates a Lambda function event source mapping", - "id": "example-1", - "title": "To update a Lambda function event source mapping" - } - ], - "UpdateFunctionCode": [ - { - "input": { - "FunctionName": "my-function", - "S3Bucket": "my-bucket-1xpuxmplzrlbh", - "S3Key": "function.zip" - }, - "output": { - "CodeSha256": "PFn4S+er27qk+UuZSTKEQfNKG/XNn7QJs90mJgq6oH8=", - "CodeSize": 308, - "Description": "", - "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function", - "FunctionName": "my-function", - "Handler": "index.handler", - "LastModified": "2019-08-14T22:26:11.234+0000", - "MemorySize": 128, - "RevisionId": "873282ed-xmpl-4dc8-a069-d0c647e470c6", - "Role": "arn:aws:iam::123456789012:role/lambda-role", - "Runtime": "nodejs12.x", - "Timeout": 3, - "TracingConfig": { - "Mode": "PassThrough" - }, - "Version": "$LATEST" - }, - "description": "The following example replaces the code of the unpublished ($LATEST) version of a function named my-function with the contents of the specified zip file in Amazon S3.", - "id": "example-1", - "title": "To update a Lambda function's code" - } - ], - "UpdateFunctionConfiguration": [ - { - "input": { - "DurableConfig": { - "ExecutionTimeout": 3600, - "RetentionPeriodInDays": 45 - }, - "FunctionName": "my-function", - "MemorySize": 256 - }, - "output": { - "CodeSha256": "PFn4S+er27qk+UuZSTKEQfNKG/XNn7QJs90mJgq6oH8=", - "CodeSize": 308, - "Description": "", - "DurableConfig": { - "ExecutionTimeout": 3600, - "RetentionPeriodInDays": 45 - }, - "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function", - "FunctionName": "my-function", - "Handler": "index.handler", - "LastModified": "2019-08-14T22:26:11.234+0000", - "MemorySize": 256, - "RevisionId": "873282ed-xmpl-4dc8-a069-d0c647e470c6", - "Role": "arn:aws:iam::123456789012:role/lambda-role", - "Runtime": "nodejs12.x", - "Timeout": 3, - "TracingConfig": { - "Mode": "PassThrough" - }, - "Version": "$LATEST" - }, - "description": "The following example modifies the memory size to be 256 MB for the unpublished ($LATEST) version of a function named my-function.", - "id": "example-1", - "title": "To update a Lambda function's configuration" - } - ], - "UpdateFunctionEventInvokeConfig": [ - { - "input": { - "DestinationConfig": { - "OnFailure": { - "Destination": "arn:aws:sqs:us-east-2:123456789012:destination" - } - }, - "FunctionName": "my-function" - }, - "output": { - "DestinationConfig": { - "OnFailure": { - "Destination": "arn:aws:sqs:us-east-2:123456789012:destination" - }, - "OnSuccess": {} - }, - "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:$LATEST", - "LastModified": 1573687896.493, - "MaximumEventAgeInSeconds": 3600, - "MaximumRetryAttempts": 0 - }, - "description": "The following example adds an on-failure destination to the existing asynchronous invocation configuration for a function named my-function.", - "id": "example-1", - "title": "To update an asynchronous invocation configuration" - } - ] - } -} diff --git a/tools/code-generation/api-descriptions/lambda/2015-03-31/paginators-1.json b/tools/code-generation/api-descriptions/lambda/2015-03-31/paginators-1.json deleted file mode 100644 index 8e4290431c3f..000000000000 --- a/tools/code-generation/api-descriptions/lambda/2015-03-31/paginators-1.json +++ /dev/null @@ -1,100 +0,0 @@ -{ - "pagination": { - "GetDurableExecutionHistory": { - "input_token": "Marker", - "output_token": "NextMarker", - "limit_key": "MaxItems", - "result_key": "Events" - }, - "GetDurableExecutionState": { - "input_token": "Marker", - "output_token": "NextMarker", - "limit_key": "MaxItems", - "result_key": "Operations" - }, - "ListAliases": { - "input_token": "Marker", - "output_token": "NextMarker", - "limit_key": "MaxItems", - "result_key": "Aliases" - }, - "ListCapacityProviders": { - "input_token": "Marker", - "output_token": "NextMarker", - "limit_key": "MaxItems", - "result_key": "CapacityProviders" - }, - "ListCodeSigningConfigs": { - "input_token": "Marker", - "output_token": "NextMarker", - "limit_key": "MaxItems", - "result_key": "CodeSigningConfigs" - }, - "ListDurableExecutionsByFunction": { - "input_token": "Marker", - "output_token": "NextMarker", - "limit_key": "MaxItems", - "result_key": "DurableExecutions" - }, - "ListEventSourceMappings": { - "input_token": "Marker", - "output_token": "NextMarker", - "limit_key": "MaxItems", - "result_key": "EventSourceMappings" - }, - "ListFunctionEventInvokeConfigs": { - "input_token": "Marker", - "output_token": "NextMarker", - "limit_key": "MaxItems", - "result_key": "FunctionEventInvokeConfigs" - }, - "ListFunctionUrlConfigs": { - "input_token": "Marker", - "output_token": "NextMarker", - "limit_key": "MaxItems", - "result_key": "FunctionUrlConfigs" - }, - "ListFunctionVersionsByCapacityProvider": { - "input_token": "Marker", - "output_token": "NextMarker", - "limit_key": "MaxItems", - "result_key": "FunctionVersions" - }, - "ListFunctions": { - "input_token": "Marker", - "output_token": "NextMarker", - "limit_key": "MaxItems", - "result_key": "Functions" - }, - "ListFunctionsByCodeSigningConfig": { - "input_token": "Marker", - "output_token": "NextMarker", - "limit_key": "MaxItems", - "result_key": "FunctionArns" - }, - "ListLayerVersions": { - "input_token": "Marker", - "output_token": "NextMarker", - "limit_key": "MaxItems", - "result_key": "LayerVersions" - }, - "ListLayers": { - "input_token": "Marker", - "output_token": "NextMarker", - "limit_key": "MaxItems", - "result_key": "Layers" - }, - "ListProvisionedConcurrencyConfigs": { - "input_token": "Marker", - "output_token": "NextMarker", - "limit_key": "MaxItems", - "result_key": "ProvisionedConcurrencyConfigs" - }, - "ListVersionsByFunction": { - "input_token": "Marker", - "output_token": "NextMarker", - "limit_key": "MaxItems", - "result_key": "Versions" - } - } -} diff --git a/tools/code-generation/api-descriptions/lambda/2015-03-31/service-2.json b/tools/code-generation/api-descriptions/lambda/2015-03-31/service-2.json deleted file mode 100644 index 3ad6ccde297e..000000000000 --- a/tools/code-generation/api-descriptions/lambda/2015-03-31/service-2.json +++ /dev/null @@ -1,9943 +0,0 @@ -{ - "version":"2.0", - "metadata":{ - "apiVersion":"2015-03-31", - "auth":["aws.auth#sigv4"], - "endpointPrefix":"lambda", - "protocol":"rest-json", - "protocols":["rest-json"], - "serviceFullName":"AWS Lambda", - "serviceId":"Lambda", - "signatureVersion":"v4", - "signingName":"lambda", - "uid":"lambda-2015-03-31" - }, - "operations":{ - "AddLayerVersionPermission":{ - "name":"AddLayerVersionPermission", - "http":{ - "method":"POST", - "requestUri":"/2018-10-31/layers/{LayerName}/versions/{VersionNumber}/policy", - "responseCode":201 - }, - "input":{"shape":"AddLayerVersionPermissionRequest"}, - "output":{"shape":"AddLayerVersionPermissionResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"PolicyLengthExceededException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"PreconditionFailedException"} - ], - "documentation":"

Adds permissions to the resource-based policy of a version of an Lambda layer. Use this action to grant layer usage permission to other accounts. You can grant permission to a single account, all accounts in an organization, or all Amazon Web Services accounts.

To revoke permission, call RemoveLayerVersionPermission with the statement ID that you specified when you added it.

" - }, - "AddPermission":{ - "name":"AddPermission", - "http":{ - "method":"POST", - "requestUri":"/2015-03-31/functions/{FunctionName}/policy", - "responseCode":201 - }, - "input":{"shape":"AddPermissionRequest"}, - "output":{"shape":"AddPermissionResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"PublicPolicyException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"PolicyLengthExceededException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"PreconditionFailedException"} - ], - "documentation":"

Grants a principal permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function. Note: Lambda does not support adding policies to version $LATEST.

To grant permission to another account, specify the account ID as the Principal. To grant permission to an organization defined in Organizations, specify the organization ID as the PrincipalOrgID. For Amazon Web Services services, the principal is a domain-style identifier that the service defines, such as s3.amazonaws.com or sns.amazonaws.com. For Amazon Web Services services, you can also specify the ARN of the associated resource as the SourceArn. If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function.

This operation adds a statement to a resource-based permissions policy for the function. For more information about function policies, see Using resource-based policies for Lambda.

" - }, - "CheckpointDurableExecution":{ - "name":"CheckpointDurableExecution", - "http":{ - "method":"POST", - "requestUri":"/2025-12-01/durable-executions/{DurableExecutionArn}/checkpoint", - "responseCode":200 - }, - "input":{"shape":"CheckpointDurableExecutionRequest"}, - "output":{"shape":"CheckpointDurableExecutionResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"KMSInvalidStateException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"KMSNotFoundException"}, - {"shape":"KMSAccessDeniedException"}, - {"shape":"KMSDisabledException"} - ], - "documentation":"

Saves the progress of a durable function execution during runtime. This API is used by the Lambda durable functions SDK to checkpoint completed steps and schedule asynchronous operations. You typically don't need to call this API directly as the SDK handles checkpointing automatically.

Each checkpoint operation consumes the current checkpoint token and returns a new one for the next checkpoint. This ensures that checkpoints are applied in the correct order and prevents duplicate or out-of-order state updates.

", - "idempotent":true - }, - "CreateAlias":{ - "name":"CreateAlias", - "http":{ - "method":"POST", - "requestUri":"/2015-03-31/functions/{FunctionName}/aliases", - "responseCode":201 - }, - "input":{"shape":"CreateAliasRequest"}, - "output":{"shape":"AliasConfiguration"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"AliasLimitExceededException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Creates an alias for a Lambda function version. Use aliases to provide clients with a function identifier that you can update to invoke a different version.

You can also map an alias to split invocation requests between two versions. Use the RoutingConfig parameter to specify a second version and the percentage of invocation requests that it receives.

", - "idempotent":true - }, - "CreateCapacityProvider":{ - "name":"CreateCapacityProvider", - "http":{ - "method":"POST", - "requestUri":"/2025-11-30/capacity-providers", - "responseCode":202 - }, - "input":{"shape":"CreateCapacityProviderRequest"}, - "output":{"shape":"CreateCapacityProviderResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"CapacityProviderLimitExceededException"} - ], - "documentation":"

Creates a capacity provider that manages compute resources for Lambda functions

", - "idempotent":true - }, - "CreateCodeSigningConfig":{ - "name":"CreateCodeSigningConfig", - "http":{ - "method":"POST", - "requestUri":"/2020-04-22/code-signing-configs", - "responseCode":201 - }, - "input":{"shape":"CreateCodeSigningConfigRequest"}, - "output":{"shape":"CreateCodeSigningConfigResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"} - ], - "documentation":"

Creates a code signing configuration. A code signing configuration defines a list of allowed signing profiles and defines the code-signing validation policy (action to be taken if deployment validation checks fail).

" - }, - "CreateEventSourceMapping":{ - "name":"CreateEventSourceMapping", - "http":{ - "method":"POST", - "requestUri":"/2015-03-31/event-source-mappings", - "responseCode":202 - }, - "input":{"shape":"CreateEventSourceMappingRequest"}, - "output":{"shape":"EventSourceMappingConfiguration"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Creates a mapping between an event source and an Lambda function. Lambda reads items from the event source and invokes the function.

For details about how to configure different event sources, see the following topics.

The following error handling options are available for stream sources (DynamoDB, Kinesis, Amazon MSK, and self-managed Apache Kafka):

  • BisectBatchOnFunctionError – If the function returns an error, split the batch in two and retry.

  • MaximumRecordAgeInSeconds – Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires

  • MaximumRetryAttempts – Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.

  • OnFailure – Send discarded records to an Amazon SQS queue, Amazon SNS topic, Kafka topic, or Amazon S3 bucket. For more information, see Adding a destination.

The following option is available only for DynamoDB and Kinesis event sources:

  • ParallelizationFactor – Process multiple batches from each shard concurrently.

For information about which configuration parameters apply to each event source, see the following topics.

" - }, - "CreateFunction":{ - "name":"CreateFunction", - "http":{ - "method":"POST", - "requestUri":"/2015-03-31/functions", - "responseCode":201 - }, - "input":{"shape":"CreateFunctionRequest"}, - "output":{"shape":"FunctionConfiguration"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"InvalidCodeSignatureException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"CodeVerificationFailedException"}, - {"shape":"CodeSigningConfigNotFoundException"}, - {"shape":"CodeStorageExceededException"}, - {"shape":"FunctionVersionsPerCapacityProviderLimitExceededException"} - ], - "documentation":"

Creates a Lambda function. To create a function, you need a deployment package and an execution role. The deployment package is a .zip file archive or container image that contains your function code. The execution role grants the function permission to use Amazon Web Services services, such as Amazon CloudWatch Logs for log streaming and X-Ray for request tracing.

If the deployment package is a container image, then you set the package type to Image. For a container image, the code property must include the URI of a container image in the Amazon ECR registry. You do not need to specify the handler and runtime properties.

If the deployment package is a .zip file archive, then you set the package type to Zip. For a .zip file archive, the code property specifies the location of the .zip file. You must also specify the handler and runtime properties. The code in the deployment package must be compatible with the target instruction set architecture of the function (x86-64 or arm64). If you do not specify the architecture, then the default value is x86-64.

When you create a function, Lambda provisions an instance of the function and its supporting resources. If your function connects to a VPC, this process can take a minute or so. During this time, you can't invoke or modify the function. The State, StateReason, and StateReasonCode fields in the response from GetFunctionConfiguration indicate when the function is ready to invoke. For more information, see Lambda function states.

A function has an unpublished version, and can have published versions and aliases. The unpublished version changes when you update your function's code and configuration. A published version is a snapshot of your function code and configuration that can't be changed. An alias is a named resource that maps to a version, and can be changed to map to a different version. Use the Publish parameter to create version 1 of your function from its initial configuration.

The other parameters let you configure version-specific and function-level settings. You can modify version-specific settings later with UpdateFunctionConfiguration. Function-level settings apply to both the unpublished and published versions of the function, and include tags (TagResource) and per-function concurrency limits (PutFunctionConcurrency).

You can use code signing if your deployment package is a .zip file archive. To enable code signing for this function, specify the ARN of a code-signing configuration. When a user attempts to deploy a code package with UpdateFunctionCode, Lambda checks that the code package has a valid signature from a trusted publisher. The code-signing configuration includes set of signing profiles, which define the trusted publishers for this function.

If another Amazon Web Services account or an Amazon Web Services service invokes your function, use AddPermission to grant permission by creating a resource-based Identity and Access Management (IAM) policy. You can grant permissions at the function level, on a version, or on an alias.

To invoke your function directly, use Invoke. To invoke your function in response to events in other Amazon Web Services services, create an event source mapping (CreateEventSourceMapping), or configure a function trigger in the other service. For more information, see Invoking Lambda functions.

", - "idempotent":true - }, - "CreateFunctionUrlConfig":{ - "name":"CreateFunctionUrlConfig", - "http":{ - "method":"POST", - "requestUri":"/2021-10-31/functions/{FunctionName}/url", - "responseCode":201 - }, - "input":{"shape":"CreateFunctionUrlConfigRequest"}, - "output":{"shape":"CreateFunctionUrlConfigResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Creates a Lambda function URL with the specified configuration parameters. A function URL is a dedicated HTTP(S) endpoint that you can use to invoke your function.

" - }, - "DeleteAlias":{ - "name":"DeleteAlias", - "http":{ - "method":"DELETE", - "requestUri":"/2015-03-31/functions/{FunctionName}/aliases/{Name}", - "responseCode":204 - }, - "input":{"shape":"DeleteAliasRequest"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Deletes a Lambda function alias.

", - "idempotent":true - }, - "DeleteCapacityProvider":{ - "name":"DeleteCapacityProvider", - "http":{ - "method":"DELETE", - "requestUri":"/2025-11-30/capacity-providers/{CapacityProviderName}", - "responseCode":202 - }, - "input":{"shape":"DeleteCapacityProviderRequest"}, - "output":{"shape":"DeleteCapacityProviderResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Deletes a capacity provider. You cannot delete a capacity provider that is currently being used by Lambda functions.

", - "idempotent":true - }, - "DeleteCodeSigningConfig":{ - "name":"DeleteCodeSigningConfig", - "http":{ - "method":"DELETE", - "requestUri":"/2020-04-22/code-signing-configs/{CodeSigningConfigArn}", - "responseCode":204 - }, - "input":{"shape":"DeleteCodeSigningConfigRequest"}, - "output":{"shape":"DeleteCodeSigningConfigResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Deletes the code signing configuration. You can delete the code signing configuration only if no function is using it.

", - "idempotent":true - }, - "DeleteEventSourceMapping":{ - "name":"DeleteEventSourceMapping", - "http":{ - "method":"DELETE", - "requestUri":"/2015-03-31/event-source-mappings/{UUID}", - "responseCode":202 - }, - "input":{"shape":"DeleteEventSourceMappingRequest"}, - "output":{"shape":"EventSourceMappingConfiguration"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceInUseException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Deletes an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.

When you delete an event source mapping, it enters a Deleting state and might not be completely deleted for several seconds.

", - "idempotent":true - }, - "DeleteFunction":{ - "name":"DeleteFunction", - "http":{ - "method":"DELETE", - "requestUri":"/2015-03-31/functions/{FunctionName}", - "responseCode":200 - }, - "input":{"shape":"DeleteFunctionRequest"}, - "output":{"shape":"DeleteFunctionResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Deletes a Lambda function. To delete a specific function version, use the Qualifier parameter. Otherwise, all versions and aliases are deleted. This doesn't require the user to have explicit permissions for DeleteAlias.

A deleted Lambda function cannot be recovered. Ensure that you specify the correct function name and version before deleting.

To delete Lambda event source mappings that invoke a function, use DeleteEventSourceMapping. For Amazon Web Services services and resources that invoke your function directly, delete the trigger in the service where you originally configured it.

", - "idempotent":true - }, - "DeleteFunctionCodeSigningConfig":{ - "name":"DeleteFunctionCodeSigningConfig", - "http":{ - "method":"DELETE", - "requestUri":"/2020-06-30/functions/{FunctionName}/code-signing-config", - "responseCode":204 - }, - "input":{"shape":"DeleteFunctionCodeSigningConfigRequest"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"CodeSigningConfigNotFoundException"} - ], - "documentation":"

Removes the code signing configuration from the function.

" - }, - "DeleteFunctionConcurrency":{ - "name":"DeleteFunctionConcurrency", - "http":{ - "method":"DELETE", - "requestUri":"/2017-10-31/functions/{FunctionName}/concurrency", - "responseCode":204 - }, - "input":{"shape":"DeleteFunctionConcurrencyRequest"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Removes a concurrent execution limit from a function.

" - }, - "DeleteFunctionEventInvokeConfig":{ - "name":"DeleteFunctionEventInvokeConfig", - "http":{ - "method":"DELETE", - "requestUri":"/2019-09-25/functions/{FunctionName}/event-invoke-config", - "responseCode":204 - }, - "input":{"shape":"DeleteFunctionEventInvokeConfigRequest"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Deletes the configuration for asynchronous invocation for a function, version, or alias.

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

" - }, - "DeleteFunctionUrlConfig":{ - "name":"DeleteFunctionUrlConfig", - "http":{ - "method":"DELETE", - "requestUri":"/2021-10-31/functions/{FunctionName}/url", - "responseCode":204 - }, - "input":{"shape":"DeleteFunctionUrlConfigRequest"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Deletes a Lambda function URL. When you delete a function URL, you can't recover it. Creating a new function URL results in a different URL address.

" - }, - "DeleteLayerVersion":{ - "name":"DeleteLayerVersion", - "http":{ - "method":"DELETE", - "requestUri":"/2018-10-31/layers/{LayerName}/versions/{VersionNumber}", - "responseCode":204 - }, - "input":{"shape":"DeleteLayerVersionRequest"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Deletes a version of an Lambda layer. Deleted versions can no longer be viewed or added to functions. To avoid breaking functions, a copy of the version remains in Lambda until no functions refer to it.

", - "idempotent":true - }, - "DeleteProvisionedConcurrencyConfig":{ - "name":"DeleteProvisionedConcurrencyConfig", - "http":{ - "method":"DELETE", - "requestUri":"/2019-09-30/functions/{FunctionName}/provisioned-concurrency", - "responseCode":204 - }, - "input":{"shape":"DeleteProvisionedConcurrencyConfigRequest"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Deletes the provisioned concurrency configuration for a function.

", - "idempotent":true - }, - "GetAccountSettings":{ - "name":"GetAccountSettings", - "http":{ - "method":"GET", - "requestUri":"/2016-08-19/account-settings", - "responseCode":200 - }, - "input":{"shape":"GetAccountSettingsRequest"}, - "output":{"shape":"GetAccountSettingsResponse"}, - "errors":[ - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"} - ], - "documentation":"

Retrieves details about your account's limits and usage in an Amazon Web Services Region.

", - "readonly":true - }, - "GetAlias":{ - "name":"GetAlias", - "http":{ - "method":"GET", - "requestUri":"/2015-03-31/functions/{FunctionName}/aliases/{Name}", - "responseCode":200 - }, - "input":{"shape":"GetAliasRequest"}, - "output":{"shape":"AliasConfiguration"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Returns details about a Lambda function alias.

", - "readonly":true - }, - "GetCapacityProvider":{ - "name":"GetCapacityProvider", - "http":{ - "method":"GET", - "requestUri":"/2025-11-30/capacity-providers/{CapacityProviderName}", - "responseCode":200 - }, - "input":{"shape":"GetCapacityProviderRequest"}, - "output":{"shape":"GetCapacityProviderResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Retrieves information about a specific capacity provider, including its configuration, state, and associated resources.

", - "readonly":true - }, - "GetCodeSigningConfig":{ - "name":"GetCodeSigningConfig", - "http":{ - "method":"GET", - "requestUri":"/2020-04-22/code-signing-configs/{CodeSigningConfigArn}", - "responseCode":200 - }, - "input":{"shape":"GetCodeSigningConfigRequest"}, - "output":{"shape":"GetCodeSigningConfigResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Returns information about the specified code signing configuration.

", - "readonly":true - }, - "GetDurableExecution":{ - "name":"GetDurableExecution", - "http":{ - "method":"GET", - "requestUri":"/2025-12-01/durable-executions/{DurableExecutionArn}", - "responseCode":200 - }, - "input":{"shape":"GetDurableExecutionRequest"}, - "output":{"shape":"GetDurableExecutionResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"KMSInvalidStateException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"KMSNotFoundException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"KMSAccessDeniedException"}, - {"shape":"KMSDisabledException"} - ], - "documentation":"

Retrieves detailed information about a specific durable execution, including its current status, input payload, result or error information, and execution metadata such as start time and usage statistics.

", - "readonly":true - }, - "GetDurableExecutionHistory":{ - "name":"GetDurableExecutionHistory", - "http":{ - "method":"GET", - "requestUri":"/2025-12-01/durable-executions/{DurableExecutionArn}/history", - "responseCode":200 - }, - "input":{"shape":"GetDurableExecutionHistoryRequest"}, - "output":{"shape":"GetDurableExecutionHistoryResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"KMSInvalidStateException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"KMSNotFoundException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"KMSAccessDeniedException"}, - {"shape":"KMSDisabledException"} - ], - "documentation":"

Retrieves the execution history for a durable execution, showing all the steps, callbacks, and events that occurred during the execution. This provides a detailed audit trail of the execution's progress over time.

The history is available while the execution is running and for a retention period after it completes (1-90 days, default 30 days). You can control whether to include execution data such as step results and callback payloads.

", - "readonly":true - }, - "GetDurableExecutionState":{ - "name":"GetDurableExecutionState", - "http":{ - "method":"GET", - "requestUri":"/2025-12-01/durable-executions/{DurableExecutionArn}/state", - "responseCode":200 - }, - "input":{"shape":"GetDurableExecutionStateRequest"}, - "output":{"shape":"GetDurableExecutionStateResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"KMSInvalidStateException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"KMSNotFoundException"}, - {"shape":"KMSAccessDeniedException"}, - {"shape":"KMSDisabledException"} - ], - "documentation":"

Retrieves the current execution state required for the replay process during durable function execution. This API is used by the Lambda durable functions SDK to get state information needed for replay. You typically don't need to call this API directly as the SDK handles state management automatically.

The response contains operations ordered by start sequence number in ascending order. Completed operations with children don't include child operation details since they don't need to be replayed.

", - "readonly":true - }, - "GetEventSourceMapping":{ - "name":"GetEventSourceMapping", - "http":{ - "method":"GET", - "requestUri":"/2015-03-31/event-source-mappings/{UUID}", - "responseCode":200 - }, - "input":{"shape":"GetEventSourceMappingRequest"}, - "output":{"shape":"EventSourceMappingConfiguration"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Returns details about an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.

", - "readonly":true - }, - "GetFunction":{ - "name":"GetFunction", - "http":{ - "method":"GET", - "requestUri":"/2015-03-31/functions/{FunctionName}", - "responseCode":200 - }, - "input":{"shape":"GetFunctionRequest"}, - "output":{"shape":"GetFunctionResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Returns information about the function or function version, with a link to download the deployment package that's valid for 10 minutes. If you specify a function version, only details that are specific to that version are returned.

", - "readonly":true - }, - "GetFunctionCodeSigningConfig":{ - "name":"GetFunctionCodeSigningConfig", - "http":{ - "method":"GET", - "requestUri":"/2020-06-30/functions/{FunctionName}/code-signing-config", - "responseCode":200 - }, - "input":{"shape":"GetFunctionCodeSigningConfigRequest"}, - "output":{"shape":"GetFunctionCodeSigningConfigResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"CodeSigningConfigNotFoundException"} - ], - "documentation":"

Returns the code signing configuration for the specified function.

", - "readonly":true - }, - "GetFunctionConcurrency":{ - "name":"GetFunctionConcurrency", - "http":{ - "method":"GET", - "requestUri":"/2019-09-30/functions/{FunctionName}/concurrency", - "responseCode":200 - }, - "input":{"shape":"GetFunctionConcurrencyRequest"}, - "output":{"shape":"GetFunctionConcurrencyResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Returns details about the reserved concurrency configuration for a function. To set a concurrency limit for a function, use PutFunctionConcurrency.

", - "readonly":true - }, - "GetFunctionConfiguration":{ - "name":"GetFunctionConfiguration", - "http":{ - "method":"GET", - "requestUri":"/2015-03-31/functions/{FunctionName}/configuration", - "responseCode":200 - }, - "input":{"shape":"GetFunctionConfigurationRequest"}, - "output":{"shape":"FunctionConfiguration"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Returns the version-specific settings of a Lambda function or version. The output includes only options that can vary between versions of a function. To modify these settings, use UpdateFunctionConfiguration.

To get all of a function's details, including function-level settings, use GetFunction.

", - "readonly":true - }, - "GetFunctionEventInvokeConfig":{ - "name":"GetFunctionEventInvokeConfig", - "http":{ - "method":"GET", - "requestUri":"/2019-09-25/functions/{FunctionName}/event-invoke-config", - "responseCode":200 - }, - "input":{"shape":"GetFunctionEventInvokeConfigRequest"}, - "output":{"shape":"FunctionEventInvokeConfig"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Retrieves the configuration for asynchronous invocation for a function, version, or alias.

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

", - "readonly":true - }, - "GetFunctionRecursionConfig":{ - "name":"GetFunctionRecursionConfig", - "http":{ - "method":"GET", - "requestUri":"/2024-08-31/functions/{FunctionName}/recursion-config", - "responseCode":200 - }, - "input":{"shape":"GetFunctionRecursionConfigRequest"}, - "output":{"shape":"GetFunctionRecursionConfigResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Returns your function's recursive loop detection configuration.

", - "readonly":true - }, - "GetFunctionScalingConfig":{ - "name":"GetFunctionScalingConfig", - "http":{ - "method":"GET", - "requestUri":"/2025-11-30/functions/{FunctionName}/function-scaling-config", - "responseCode":200 - }, - "input":{"shape":"GetFunctionScalingConfigRequest"}, - "output":{"shape":"GetFunctionScalingConfigResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Retrieves the scaling configuration for a Lambda Managed Instances function.

", - "readonly":true - }, - "GetFunctionUrlConfig":{ - "name":"GetFunctionUrlConfig", - "http":{ - "method":"GET", - "requestUri":"/2021-10-31/functions/{FunctionName}/url", - "responseCode":200 - }, - "input":{"shape":"GetFunctionUrlConfigRequest"}, - "output":{"shape":"GetFunctionUrlConfigResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Returns details about a Lambda function URL.

", - "readonly":true - }, - "GetLayerVersion":{ - "name":"GetLayerVersion", - "http":{ - "method":"GET", - "requestUri":"/2018-10-31/layers/{LayerName}/versions/{VersionNumber}", - "responseCode":200 - }, - "input":{"shape":"GetLayerVersionRequest"}, - "output":{"shape":"GetLayerVersionResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Returns information about a version of an Lambda layer, with a link to download the layer archive that's valid for 10 minutes.

", - "readonly":true - }, - "GetLayerVersionByArn":{ - "name":"GetLayerVersionByArn", - "http":{ - "method":"GET", - "requestUri":"/2018-10-31/layers?find=LayerVersion", - "responseCode":200 - }, - "input":{"shape":"GetLayerVersionByArnRequest"}, - "output":{"shape":"GetLayerVersionResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Returns information about a version of an Lambda layer, with a link to download the layer archive that's valid for 10 minutes.

", - "readonly":true - }, - "GetLayerVersionPolicy":{ - "name":"GetLayerVersionPolicy", - "http":{ - "method":"GET", - "requestUri":"/2018-10-31/layers/{LayerName}/versions/{VersionNumber}/policy", - "responseCode":200 - }, - "input":{"shape":"GetLayerVersionPolicyRequest"}, - "output":{"shape":"GetLayerVersionPolicyResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Returns the permission policy for a version of an Lambda layer. For more information, see AddLayerVersionPermission.

", - "readonly":true - }, - "GetPolicy":{ - "name":"GetPolicy", - "http":{ - "method":"GET", - "requestUri":"/2015-03-31/functions/{FunctionName}/policy", - "responseCode":200 - }, - "input":{"shape":"GetPolicyRequest"}, - "output":{"shape":"GetPolicyResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Returns the resource-based IAM policy for a function, version, or alias.

", - "readonly":true - }, - "GetProvisionedConcurrencyConfig":{ - "name":"GetProvisionedConcurrencyConfig", - "http":{ - "method":"GET", - "requestUri":"/2019-09-30/functions/{FunctionName}/provisioned-concurrency", - "responseCode":200 - }, - "input":{"shape":"GetProvisionedConcurrencyConfigRequest"}, - "output":{"shape":"GetProvisionedConcurrencyConfigResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ProvisionedConcurrencyConfigNotFoundException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Retrieves the provisioned concurrency configuration for a function's alias or version.

", - "readonly":true - }, - "GetRuntimeManagementConfig":{ - "name":"GetRuntimeManagementConfig", - "http":{ - "method":"GET", - "requestUri":"/2021-07-20/functions/{FunctionName}/runtime-management-config", - "responseCode":200 - }, - "input":{"shape":"GetRuntimeManagementConfigRequest"}, - "output":{"shape":"GetRuntimeManagementConfigResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Retrieves the runtime management configuration for a function's version. If the runtime update mode is Manual, this includes the ARN of the runtime version and the runtime update mode. If the runtime update mode is Auto or Function update, this includes the runtime update mode and null is returned for the ARN. For more information, see Runtime updates.

", - "readonly":true - }, - "Invoke":{ - "name":"Invoke", - "http":{ - "method":"POST", - "requestUri":"/2015-03-31/functions/{FunctionName}/invocations", - "responseCode":200 - }, - "input":{"shape":"InvocationRequest"}, - "output":{"shape":"InvocationResponse"}, - "errors":[ - {"shape":"CodeArtifactUserDeletedException"}, - {"shape":"ResourceNotReadyException"}, - {"shape":"ServiceQuotaExceededException"}, - {"shape":"InvalidSecurityGroupIDException"}, - {"shape":"SnapStartTimeoutException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"EC2ThrottledException"}, - {"shape":"EFSMountConnectivityException"}, - {"shape":"SubnetIPAddressLimitReachedException"}, - {"shape":"KMSAccessDeniedException"}, - {"shape":"RequestTooLargeException"}, - {"shape":"KMSDisabledException"}, - {"shape":"UnsupportedMediaTypeException"}, - {"shape":"S3FilesMountConnectivityException"}, - {"shape":"SerializedRequestEntityTooLargeException"}, - {"shape":"InvalidRuntimeException"}, - {"shape":"NoPublishedVersionException"}, - {"shape":"EC2UnexpectedException"}, - {"shape":"InvalidSubnetIDException"}, - {"shape":"KMSNotFoundException"}, - {"shape":"InvalidParameterValueException"}, - {"shape":"EC2AccessDeniedException"}, - {"shape":"EFSIOException"}, - {"shape":"KMSInvalidStateException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ENILimitReachedException"}, - {"shape":"SnapStartNotReadyException"}, - {"shape":"ServiceException"}, - {"shape":"CodeArtifactUserPendingException"}, - {"shape":"SnapStartException"}, - {"shape":"RecursiveInvocationException"}, - {"shape":"S3FilesMountFailureException"}, - {"shape":"EFSMountTimeoutException"}, - {"shape":"ENINotReadyException"}, - {"shape":"S3FilesMountTimeoutException"}, - {"shape":"CodeArtifactUserFailedException"}, - {"shape":"ModeNotSupportedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidRequestContentException"}, - {"shape":"SnapStartRegenerationFailureException"}, - {"shape":"DurableExecutionAlreadyStartedException"}, - {"shape":"InvalidZipFileException"}, - {"shape":"EFSMountFailureException"} - ], - "documentation":"

Invokes a Lambda function. You can invoke a function synchronously (and wait for the response), or asynchronously. By default, Lambda invokes your function synchronously (i.e. theInvocationType is RequestResponse). To invoke a function asynchronously, set InvocationType to Event. Lambda passes the ClientContext object to your function for synchronous invocations only.

For synchronous invocations, the maximum payload size is 6 MB. For asynchronous invocations, the maximum payload size is 1 MB.

For synchronous invocation, details about the function response, including errors, are included in the response body and headers. For either invocation type, you can find more information in the execution log and trace.

When an error occurs, your function may be invoked multiple times. Retry behavior varies by error type, client, event source, and invocation type. For example, if you invoke a function asynchronously and it returns an error, Lambda executes the function up to two more times. For more information, see Error handling and automatic retries in Lambda.

For asynchronous invocation, Lambda adds events to a queue before sending them to your function. If your function does not have enough capacity to keep up with the queue, events may be lost. Occasionally, your function may receive the same event multiple times, even if no error occurs. To retain events that were not processed, configure your function with a dead-letter queue.

The status code in the API response doesn't reflect function errors. Error codes are reserved for errors that prevent your function from executing, such as permissions errors, quota errors, or issues with your function's code and configuration. For example, Lambda returns TooManyRequestsException if running the function would cause you to exceed a concurrency limit at either the account level (ConcurrentInvocationLimitExceeded) or function level (ReservedFunctionConcurrentInvocationLimitExceeded).

For functions with a long timeout, your client might disconnect during synchronous invocation while it waits for a response. Configure your HTTP client, SDK, firewall, proxy, or operating system to allow for long connections with timeout or keep-alive settings.

This operation requires permission for the lambda:InvokeFunction action. For details on how to set up permissions for cross-account invocations, see Granting function access to other accounts.

" - }, - "InvokeAsync":{ - "name":"InvokeAsync", - "http":{ - "method":"POST", - "requestUri":"/2014-11-13/functions/{FunctionName}/invoke-async", - "responseCode":202 - }, - "input":{"shape":"InvokeAsyncRequest"}, - "output":{"shape":"InvokeAsyncResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"InvalidSecurityGroupIDException"}, - {"shape":"SnapStartTimeoutException"}, - {"shape":"EC2ThrottledException"}, - {"shape":"EFSMountConnectivityException"}, - {"shape":"SubnetIPAddressLimitReachedException"}, - {"shape":"KMSAccessDeniedException"}, - {"shape":"KMSDisabledException"}, - {"shape":"S3FilesMountConnectivityException"}, - {"shape":"InvalidRuntimeException"}, - {"shape":"EC2UnexpectedException"}, - {"shape":"InvalidSubnetIDException"}, - {"shape":"KMSNotFoundException"}, - {"shape":"EC2AccessDeniedException"}, - {"shape":"EFSIOException"}, - {"shape":"KMSInvalidStateException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ENILimitReachedException"}, - {"shape":"SnapStartNotReadyException"}, - {"shape":"ServiceException"}, - {"shape":"SnapStartException"}, - {"shape":"S3FilesMountFailureException"}, - {"shape":"EFSMountTimeoutException"}, - {"shape":"S3FilesMountTimeoutException"}, - {"shape":"ModeNotSupportedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidRequestContentException"}, - {"shape":"SnapStartRegenerationFailureException"}, - {"shape":"EFSMountFailureException"} - ], - "documentation":"

For asynchronous function invocation, use Invoke.

Invokes a function asynchronously.

The payload limit is 256KB. For larger payloads, for up to 1MB, use Invoke.

If you do use the InvokeAsync action, note that it doesn't support the use of X-Ray active tracing. Trace ID is not propagated to the function, even if X-Ray active tracing is turned on.

", - "deprecated":true - }, - "InvokeWithResponseStream":{ - "name":"InvokeWithResponseStream", - "http":{ - "method":"POST", - "requestUri":"/2021-11-15/functions/{FunctionName}/response-streaming-invocations", - "responseCode":200 - }, - "input":{"shape":"InvokeWithResponseStreamRequest"}, - "output":{"shape":"InvokeWithResponseStreamResponse"}, - "errors":[ - {"shape":"ResourceNotReadyException"}, - {"shape":"ServiceQuotaExceededException"}, - {"shape":"InvalidSecurityGroupIDException"}, - {"shape":"SnapStartTimeoutException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"EC2ThrottledException"}, - {"shape":"EFSMountConnectivityException"}, - {"shape":"SubnetIPAddressLimitReachedException"}, - {"shape":"KMSAccessDeniedException"}, - {"shape":"RequestTooLargeException"}, - {"shape":"KMSDisabledException"}, - {"shape":"UnsupportedMediaTypeException"}, - {"shape":"S3FilesMountConnectivityException"}, - {"shape":"SerializedRequestEntityTooLargeException"}, - {"shape":"InvalidRuntimeException"}, - {"shape":"NoPublishedVersionException"}, - {"shape":"EC2UnexpectedException"}, - {"shape":"InvalidSubnetIDException"}, - {"shape":"KMSNotFoundException"}, - {"shape":"InvalidParameterValueException"}, - {"shape":"EC2AccessDeniedException"}, - {"shape":"EFSIOException"}, - {"shape":"KMSInvalidStateException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ENILimitReachedException"}, - {"shape":"SnapStartNotReadyException"}, - {"shape":"ServiceException"}, - {"shape":"SnapStartException"}, - {"shape":"RecursiveInvocationException"}, - {"shape":"S3FilesMountFailureException"}, - {"shape":"EFSMountTimeoutException"}, - {"shape":"S3FilesMountTimeoutException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidRequestContentException"}, - {"shape":"SnapStartRegenerationFailureException"}, - {"shape":"InvalidZipFileException"}, - {"shape":"EFSMountFailureException"} - ], - "documentation":"

Configure your Lambda functions to stream response payloads back to clients. For more information, see Configuring a Lambda function to stream responses.

This operation requires permission for the lambda:InvokeFunction action. For details on how to set up permissions for cross-account invocations, see Granting function access to other accounts.

" - }, - "ListAliases":{ - "name":"ListAliases", - "http":{ - "method":"GET", - "requestUri":"/2015-03-31/functions/{FunctionName}/aliases", - "responseCode":200 - }, - "input":{"shape":"ListAliasesRequest"}, - "output":{"shape":"ListAliasesResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Returns a list of aliases for a Lambda function.

", - "readonly":true - }, - "ListCapacityProviders":{ - "name":"ListCapacityProviders", - "http":{ - "method":"GET", - "requestUri":"/2025-11-30/capacity-providers", - "responseCode":200 - }, - "input":{"shape":"ListCapacityProvidersRequest"}, - "output":{"shape":"ListCapacityProvidersResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"} - ], - "documentation":"

Returns a list of capacity providers in your account.

", - "readonly":true - }, - "ListCodeSigningConfigs":{ - "name":"ListCodeSigningConfigs", - "http":{ - "method":"GET", - "requestUri":"/2020-04-22/code-signing-configs", - "responseCode":200 - }, - "input":{"shape":"ListCodeSigningConfigsRequest"}, - "output":{"shape":"ListCodeSigningConfigsResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"} - ], - "documentation":"

Returns a list of code signing configurations. A request returns up to 10,000 configurations per call. You can use the MaxItems parameter to return fewer configurations per call.

", - "readonly":true - }, - "ListDurableExecutionsByFunction":{ - "name":"ListDurableExecutionsByFunction", - "http":{ - "method":"GET", - "requestUri":"/2025-12-01/functions/{FunctionName}/durable-executions", - "responseCode":200 - }, - "input":{"shape":"ListDurableExecutionsByFunctionRequest"}, - "output":{"shape":"ListDurableExecutionsByFunctionResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Returns a list of durable executions for a specified Lambda function. You can filter the results by execution name, status, and start time range. This API supports pagination for large result sets.

", - "readonly":true - }, - "ListEventSourceMappings":{ - "name":"ListEventSourceMappings", - "http":{ - "method":"GET", - "requestUri":"/2015-03-31/event-source-mappings", - "responseCode":200 - }, - "input":{"shape":"ListEventSourceMappingsRequest"}, - "output":{"shape":"ListEventSourceMappingsResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Lists event source mappings. Specify an EventSourceArn to show only event source mappings for a single event source.

", - "readonly":true - }, - "ListFunctionEventInvokeConfigs":{ - "name":"ListFunctionEventInvokeConfigs", - "http":{ - "method":"GET", - "requestUri":"/2019-09-25/functions/{FunctionName}/event-invoke-config/list", - "responseCode":200 - }, - "input":{"shape":"ListFunctionEventInvokeConfigsRequest"}, - "output":{"shape":"ListFunctionEventInvokeConfigsResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Retrieves a list of configurations for asynchronous invocation for a function.

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

", - "readonly":true - }, - "ListFunctionUrlConfigs":{ - "name":"ListFunctionUrlConfigs", - "http":{ - "method":"GET", - "requestUri":"/2021-10-31/functions/{FunctionName}/urls", - "responseCode":200 - }, - "input":{"shape":"ListFunctionUrlConfigsRequest"}, - "output":{"shape":"ListFunctionUrlConfigsResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Returns a list of Lambda function URLs for the specified function.

", - "readonly":true - }, - "ListFunctionVersionsByCapacityProvider":{ - "name":"ListFunctionVersionsByCapacityProvider", - "http":{ - "method":"GET", - "requestUri":"/2025-11-30/capacity-providers/{CapacityProviderName}/function-versions", - "responseCode":200 - }, - "input":{"shape":"ListFunctionVersionsByCapacityProviderRequest"}, - "output":{"shape":"ListFunctionVersionsByCapacityProviderResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Returns a list of function versions that are configured to use a specific capacity provider.

", - "readonly":true - }, - "ListFunctions":{ - "name":"ListFunctions", - "http":{ - "method":"GET", - "requestUri":"/2015-03-31/functions", - "responseCode":200 - }, - "input":{"shape":"ListFunctionsRequest"}, - "output":{"shape":"ListFunctionsResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"} - ], - "documentation":"

Returns a list of Lambda functions, with the version-specific configuration of each. Lambda returns up to 50 functions per call.

Set FunctionVersion to ALL to include all published versions of each function in addition to the unpublished version.

The ListFunctions operation returns a subset of the FunctionConfiguration fields. To get the additional fields (State, StateReasonCode, StateReason, LastUpdateStatus, LastUpdateStatusReason, LastUpdateStatusReasonCode, RuntimeVersionConfig) for a function or version, use GetFunction.

", - "readonly":true - }, - "ListFunctionsByCodeSigningConfig":{ - "name":"ListFunctionsByCodeSigningConfig", - "http":{ - "method":"GET", - "requestUri":"/2020-04-22/code-signing-configs/{CodeSigningConfigArn}/functions", - "responseCode":200 - }, - "input":{"shape":"ListFunctionsByCodeSigningConfigRequest"}, - "output":{"shape":"ListFunctionsByCodeSigningConfigResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

List the functions that use the specified code signing configuration. You can use this method prior to deleting a code signing configuration, to verify that no functions are using it.

", - "readonly":true - }, - "ListLayerVersions":{ - "name":"ListLayerVersions", - "http":{ - "method":"GET", - "requestUri":"/2018-10-31/layers/{LayerName}/versions", - "responseCode":200 - }, - "input":{"shape":"ListLayerVersionsRequest"}, - "output":{"shape":"ListLayerVersionsResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Lists the versions of an Lambda layer. Versions that have been deleted aren't listed. Specify a runtime identifier to list only versions that indicate that they're compatible with that runtime. Specify a compatible architecture to include only layer versions that are compatible with that architecture.

", - "readonly":true - }, - "ListLayers":{ - "name":"ListLayers", - "http":{ - "method":"GET", - "requestUri":"/2018-10-31/layers", - "responseCode":200 - }, - "input":{"shape":"ListLayersRequest"}, - "output":{"shape":"ListLayersResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"} - ], - "documentation":"

Lists Lambda layers and shows information about the latest version of each. Specify a runtime identifier to list only layers that indicate that they're compatible with that runtime. Specify a compatible architecture to include only layers that are compatible with that instruction set architecture.

", - "readonly":true - }, - "ListProvisionedConcurrencyConfigs":{ - "name":"ListProvisionedConcurrencyConfigs", - "http":{ - "method":"GET", - "requestUri":"/2019-09-30/functions/{FunctionName}/provisioned-concurrency?List=ALL", - "responseCode":200 - }, - "input":{"shape":"ListProvisionedConcurrencyConfigsRequest"}, - "output":{"shape":"ListProvisionedConcurrencyConfigsResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Retrieves a list of provisioned concurrency configurations for a function.

", - "readonly":true - }, - "ListTags":{ - "name":"ListTags", - "http":{ - "method":"GET", - "requestUri":"/2017-03-31/tags/{Resource}", - "responseCode":200 - }, - "input":{"shape":"ListTagsRequest"}, - "output":{"shape":"ListTagsResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Returns a function, event source mapping, or code signing configuration's tags. You can also view function tags with GetFunction.

", - "readonly":true - }, - "ListVersionsByFunction":{ - "name":"ListVersionsByFunction", - "http":{ - "method":"GET", - "requestUri":"/2015-03-31/functions/{FunctionName}/versions", - "responseCode":200 - }, - "input":{"shape":"ListVersionsByFunctionRequest"}, - "output":{"shape":"ListVersionsByFunctionResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Returns a list of versions, with the version-specific configuration of each. Lambda returns up to 50 versions per call.

", - "readonly":true - }, - "PublishLayerVersion":{ - "name":"PublishLayerVersion", - "http":{ - "method":"POST", - "requestUri":"/2018-10-31/layers/{LayerName}/versions", - "responseCode":201 - }, - "input":{"shape":"PublishLayerVersionRequest"}, - "output":{"shape":"PublishLayerVersionResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"CodeStorageExceededException"} - ], - "documentation":"

Creates an Lambda layer from a ZIP archive. Each time you call PublishLayerVersion with the same layer name, a new version is created.

Add layers to your function with CreateFunction or UpdateFunctionConfiguration.

" - }, - "PublishVersion":{ - "name":"PublishVersion", - "http":{ - "method":"POST", - "requestUri":"/2015-03-31/functions/{FunctionName}/versions", - "responseCode":201 - }, - "input":{"shape":"PublishVersionRequest"}, - "output":{"shape":"FunctionConfiguration"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"CodeStorageExceededException"}, - {"shape":"FunctionVersionsPerCapacityProviderLimitExceededException"}, - {"shape":"PreconditionFailedException"} - ], - "documentation":"

Creates a version from the current code and configuration of a function. Use versions to create a snapshot of your function code and configuration that doesn't change.

Lambda doesn't publish a version if the function's configuration and code haven't changed since the last version. Use UpdateFunctionCode or UpdateFunctionConfiguration to update the function before publishing a version.

Clients can invoke versions directly or with an alias. To create an alias, use CreateAlias.

" - }, - "PutFunctionCodeSigningConfig":{ - "name":"PutFunctionCodeSigningConfig", - "http":{ - "method":"PUT", - "requestUri":"/2020-06-30/functions/{FunctionName}/code-signing-config", - "responseCode":200 - }, - "input":{"shape":"PutFunctionCodeSigningConfigRequest"}, - "output":{"shape":"PutFunctionCodeSigningConfigResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"CodeSigningConfigNotFoundException"} - ], - "documentation":"

Update the code signing configuration for the function. Changes to the code signing configuration take effect the next time a user tries to deploy a code package to the function.

" - }, - "PutFunctionConcurrency":{ - "name":"PutFunctionConcurrency", - "http":{ - "method":"PUT", - "requestUri":"/2017-10-31/functions/{FunctionName}/concurrency", - "responseCode":200 - }, - "input":{"shape":"PutFunctionConcurrencyRequest"}, - "output":{"shape":"Concurrency"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Sets the maximum number of simultaneous executions for a function, and reserves capacity for that concurrency level.

Concurrency settings apply to the function as a whole, including all published versions and the unpublished version. Reserving concurrency both ensures that your function has capacity to process the specified number of events simultaneously, and prevents it from scaling beyond that level. Use GetFunction to see the current setting for a function.

Use GetAccountSettings to see your Regional concurrency limit. You can reserve concurrency for as many functions as you like, as long as you leave at least 100 simultaneous executions unreserved for functions that aren't configured with a per-function limit. For more information, see Lambda function scaling.

" - }, - "PutFunctionEventInvokeConfig":{ - "name":"PutFunctionEventInvokeConfig", - "http":{ - "method":"PUT", - "requestUri":"/2019-09-25/functions/{FunctionName}/event-invoke-config", - "responseCode":200 - }, - "input":{"shape":"PutFunctionEventInvokeConfigRequest"}, - "output":{"shape":"FunctionEventInvokeConfig"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Configures options for asynchronous invocation on a function, version, or alias. If a configuration already exists for a function, version, or alias, this operation overwrites it. If you exclude any settings, they are removed. To set one option without affecting existing settings for other options, use UpdateFunctionEventInvokeConfig.

By default, Lambda retries an asynchronous invocation twice if the function returns an error. It retains events in a queue for up to six hours. When an event fails all processing attempts or stays in the asynchronous invocation queue for too long, Lambda discards it. To retain discarded events, configure a dead-letter queue with UpdateFunctionConfiguration.

To send an invocation record to a queue, topic, S3 bucket, function, or event bus, specify a destination. You can configure separate destinations for successful invocations (on-success) and events that fail all processing attempts (on-failure). You can configure destinations in addition to or instead of a dead-letter queue.

S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type.

" - }, - "PutFunctionRecursionConfig":{ - "name":"PutFunctionRecursionConfig", - "http":{ - "method":"PUT", - "requestUri":"/2024-08-31/functions/{FunctionName}/recursion-config", - "responseCode":200 - }, - "input":{"shape":"PutFunctionRecursionConfigRequest"}, - "output":{"shape":"PutFunctionRecursionConfigResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Sets your function's recursive loop detection configuration.

When you configure a Lambda function to output to the same service or resource that invokes the function, it's possible to create an infinite recursive loop. For example, a Lambda function might write a message to an Amazon Simple Queue Service (Amazon SQS) queue, which then invokes the same function. This invocation causes the function to write another message to the queue, which in turn invokes the function again.

Lambda can detect certain types of recursive loops shortly after they occur. When Lambda detects a recursive loop and your function's recursive loop detection configuration is set to Terminate, it stops your function being invoked and notifies you.

" - }, - "PutFunctionScalingConfig":{ - "name":"PutFunctionScalingConfig", - "http":{ - "method":"PUT", - "requestUri":"/2025-11-30/functions/{FunctionName}/function-scaling-config", - "responseCode":202 - }, - "input":{"shape":"PutFunctionScalingConfigRequest"}, - "output":{"shape":"PutFunctionScalingConfigResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Sets the scaling configuration for a Lambda Managed Instances function. The scaling configuration defines the minimum and maximum number of execution environments that can be provisioned for the function, allowing you to control scaling behavior and resource allocation.

" - }, - "PutProvisionedConcurrencyConfig":{ - "name":"PutProvisionedConcurrencyConfig", - "http":{ - "method":"PUT", - "requestUri":"/2019-09-30/functions/{FunctionName}/provisioned-concurrency", - "responseCode":202 - }, - "input":{"shape":"PutProvisionedConcurrencyConfigRequest"}, - "output":{"shape":"PutProvisionedConcurrencyConfigResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Adds a provisioned concurrency configuration to a function's alias or version.

", - "idempotent":true - }, - "PutRuntimeManagementConfig":{ - "name":"PutRuntimeManagementConfig", - "http":{ - "method":"PUT", - "requestUri":"/2021-07-20/functions/{FunctionName}/runtime-management-config", - "responseCode":200 - }, - "input":{"shape":"PutRuntimeManagementConfigRequest"}, - "output":{"shape":"PutRuntimeManagementConfigResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Sets the runtime management configuration for a function's version. For more information, see Runtime updates.

" - }, - "RemoveLayerVersionPermission":{ - "name":"RemoveLayerVersionPermission", - "http":{ - "method":"DELETE", - "requestUri":"/2018-10-31/layers/{LayerName}/versions/{VersionNumber}/policy/{StatementId}", - "responseCode":204 - }, - "input":{"shape":"RemoveLayerVersionPermissionRequest"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"PreconditionFailedException"} - ], - "documentation":"

Removes a statement from the permissions policy for a version of an Lambda layer. For more information, see AddLayerVersionPermission.

" - }, - "RemovePermission":{ - "name":"RemovePermission", - "http":{ - "method":"DELETE", - "requestUri":"/2015-03-31/functions/{FunctionName}/policy/{StatementId}", - "responseCode":204 - }, - "input":{"shape":"RemovePermissionRequest"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"PublicPolicyException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"PreconditionFailedException"} - ], - "documentation":"

Revokes function-use permission from an Amazon Web Services service or another Amazon Web Services account. You can get the ID of the statement from the output of GetPolicy.

" - }, - "SendDurableExecutionCallbackFailure":{ - "name":"SendDurableExecutionCallbackFailure", - "http":{ - "method":"POST", - "requestUri":"/2025-12-01/durable-execution-callbacks/{CallbackId}/fail", - "responseCode":200 - }, - "input":{"shape":"SendDurableExecutionCallbackFailureRequest"}, - "output":{"shape":"SendDurableExecutionCallbackFailureResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"KMSInvalidStateException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"KMSNotFoundException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"CallbackTimeoutException"}, - {"shape":"KMSAccessDeniedException"}, - {"shape":"KMSDisabledException"} - ], - "documentation":"

Sends a failure response for a callback operation in a durable execution. Use this API when an external system cannot complete a callback operation successfully.

" - }, - "SendDurableExecutionCallbackHeartbeat":{ - "name":"SendDurableExecutionCallbackHeartbeat", - "http":{ - "method":"POST", - "requestUri":"/2025-12-01/durable-execution-callbacks/{CallbackId}/heartbeat", - "responseCode":200 - }, - "input":{"shape":"SendDurableExecutionCallbackHeartbeatRequest"}, - "output":{"shape":"SendDurableExecutionCallbackHeartbeatResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"CallbackTimeoutException"} - ], - "documentation":"

Sends a heartbeat signal for a long-running callback operation to prevent timeout. Use this API to extend the callback timeout period while the external operation is still in progress.

" - }, - "SendDurableExecutionCallbackSuccess":{ - "name":"SendDurableExecutionCallbackSuccess", - "http":{ - "method":"POST", - "requestUri":"/2025-12-01/durable-execution-callbacks/{CallbackId}/succeed", - "responseCode":200 - }, - "input":{"shape":"SendDurableExecutionCallbackSuccessRequest"}, - "output":{"shape":"SendDurableExecutionCallbackSuccessResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"KMSInvalidStateException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"KMSNotFoundException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"CallbackTimeoutException"}, - {"shape":"KMSAccessDeniedException"}, - {"shape":"KMSDisabledException"} - ], - "documentation":"

Sends a successful completion response for a callback operation in a durable execution. Use this API when an external system has successfully completed a callback operation.

" - }, - "StopDurableExecution":{ - "name":"StopDurableExecution", - "http":{ - "method":"POST", - "requestUri":"/2025-12-01/durable-executions/{DurableExecutionArn}/stop", - "responseCode":200 - }, - "input":{"shape":"StopDurableExecutionRequest"}, - "output":{"shape":"StopDurableExecutionResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"KMSInvalidStateException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"KMSNotFoundException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"KMSAccessDeniedException"}, - {"shape":"KMSDisabledException"} - ], - "documentation":"

Stops a running durable execution. The execution transitions to STOPPED status and cannot be resumed. Any in-progress operations are terminated.

" - }, - "TagResource":{ - "name":"TagResource", - "http":{ - "method":"POST", - "requestUri":"/2017-03-31/tags/{Resource}", - "responseCode":204 - }, - "input":{"shape":"TagResourceRequest"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Adds tags to a function, event source mapping, or code signing configuration.

" - }, - "UntagResource":{ - "name":"UntagResource", - "http":{ - "method":"DELETE", - "requestUri":"/2017-03-31/tags/{Resource}", - "responseCode":204 - }, - "input":{"shape":"UntagResourceRequest"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Removes tags from a function, event source mapping, or code signing configuration.

" - }, - "UpdateAlias":{ - "name":"UpdateAlias", - "http":{ - "method":"PUT", - "requestUri":"/2015-03-31/functions/{FunctionName}/aliases/{Name}", - "responseCode":200 - }, - "input":{"shape":"UpdateAliasRequest"}, - "output":{"shape":"AliasConfiguration"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"PreconditionFailedException"} - ], - "documentation":"

Updates the configuration of a Lambda function alias.

" - }, - "UpdateCapacityProvider":{ - "name":"UpdateCapacityProvider", - "http":{ - "method":"PUT", - "requestUri":"/2025-11-30/capacity-providers/{CapacityProviderName}", - "responseCode":202 - }, - "input":{"shape":"UpdateCapacityProviderRequest"}, - "output":{"shape":"UpdateCapacityProviderResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Updates the configuration of an existing capacity provider.

" - }, - "UpdateCodeSigningConfig":{ - "name":"UpdateCodeSigningConfig", - "http":{ - "method":"PUT", - "requestUri":"/2020-04-22/code-signing-configs/{CodeSigningConfigArn}", - "responseCode":200 - }, - "input":{"shape":"UpdateCodeSigningConfigRequest"}, - "output":{"shape":"UpdateCodeSigningConfigResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ServiceException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Update the code signing configuration. Changes to the code signing configuration take effect the next time a user tries to deploy a code package to the function.

" - }, - "UpdateEventSourceMapping":{ - "name":"UpdateEventSourceMapping", - "http":{ - "method":"PUT", - "requestUri":"/2015-03-31/event-source-mappings/{UUID}", - "responseCode":202 - }, - "input":{"shape":"UpdateEventSourceMappingRequest"}, - "output":{"shape":"EventSourceMappingConfiguration"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceInUseException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Updates an event source mapping. You can change the function that Lambda invokes, or pause invocation and resume later from the same location.

For details about how to configure different event sources, see the following topics.

The following error handling options are available for stream sources (DynamoDB, Kinesis, Amazon MSK, and self-managed Apache Kafka):

  • BisectBatchOnFunctionError – If the function returns an error, split the batch in two and retry.

  • MaximumRecordAgeInSeconds – Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires

  • MaximumRetryAttempts – Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.

  • OnFailure – Send discarded records to an Amazon SQS queue, Amazon SNS topic, Kafka topic, or Amazon S3 bucket. For more information, see Adding a destination.

The following option is available only for DynamoDB and Kinesis event sources:

  • ParallelizationFactor – Process multiple batches from each shard concurrently.

For information about which configuration parameters apply to each event source, see the following topics.

" - }, - "UpdateFunctionCode":{ - "name":"UpdateFunctionCode", - "http":{ - "method":"PUT", - "requestUri":"/2015-03-31/functions/{FunctionName}/code", - "responseCode":200 - }, - "input":{"shape":"UpdateFunctionCodeRequest"}, - "output":{"shape":"FunctionConfiguration"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"InvalidCodeSignatureException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"CodeVerificationFailedException"}, - {"shape":"CodeSigningConfigNotFoundException"}, - {"shape":"CodeStorageExceededException"}, - {"shape":"PreconditionFailedException"} - ], - "documentation":"

Updates a Lambda function's code. If code signing is enabled for the function, the code package must be signed by a trusted publisher. For more information, see Configuring code signing for Lambda.

If the function's package type is Image, then you must specify the code package in ImageUri as the URI of a container image in the Amazon ECR registry.

If the function's package type is Zip, then you must specify the deployment package as a .zip file archive. Enter the Amazon S3 bucket and key of the code .zip file location. You can also provide the function code inline using the ZipFile field.

The code in the deployment package must be compatible with the target instruction set architecture of the function (x86-64 or arm64).

The function's code is locked when you publish a version. You can't modify the code of a published version, only the unpublished version.

For a function defined as a container image, Lambda resolves the image tag to an image digest. In Amazon ECR, if you update the image tag to a new image, Lambda does not automatically update the function.

" - }, - "UpdateFunctionConfiguration":{ - "name":"UpdateFunctionConfiguration", - "http":{ - "method":"PUT", - "requestUri":"/2015-03-31/functions/{FunctionName}/configuration", - "responseCode":200 - }, - "input":{"shape":"UpdateFunctionConfigurationRequest"}, - "output":{"shape":"FunctionConfiguration"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"InvalidCodeSignatureException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"CodeVerificationFailedException"}, - {"shape":"CodeSigningConfigNotFoundException"}, - {"shape":"PreconditionFailedException"} - ], - "documentation":"

Modify the version-specific settings of a Lambda function.

When you update a function, Lambda provisions an instance of the function and its supporting resources. If your function connects to a VPC, this process can take a minute. During this time, you can't modify the function, but you can still invoke it. The LastUpdateStatus, LastUpdateStatusReason, and LastUpdateStatusReasonCode fields in the response from GetFunctionConfiguration indicate when the update is complete and the function is processing events with the new configuration. For more information, see Lambda function states.

These settings can vary between versions of a function and are locked when you publish a version. You can't modify the configuration of a published version, only the unpublished version.

To configure function concurrency, use PutFunctionConcurrency. To grant invoke permissions to an Amazon Web Services account or Amazon Web Services service, use AddPermission.

" - }, - "UpdateFunctionEventInvokeConfig":{ - "name":"UpdateFunctionEventInvokeConfig", - "http":{ - "method":"POST", - "requestUri":"/2019-09-25/functions/{FunctionName}/event-invoke-config", - "responseCode":200 - }, - "input":{"shape":"UpdateFunctionEventInvokeConfigRequest"}, - "output":{"shape":"FunctionEventInvokeConfig"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Updates the configuration for asynchronous invocation for a function, version, or alias.

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

" - }, - "UpdateFunctionUrlConfig":{ - "name":"UpdateFunctionUrlConfig", - "http":{ - "method":"PUT", - "requestUri":"/2021-10-31/functions/{FunctionName}/url", - "responseCode":200 - }, - "input":{"shape":"UpdateFunctionUrlConfigRequest"}, - "output":{"shape":"UpdateFunctionUrlConfigResponse"}, - "errors":[ - {"shape":"InvalidParameterValueException"}, - {"shape":"ResourceConflictException"}, - {"shape":"ServiceException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"

Updates the configuration for a Lambda function URL.

" - } - }, - "shapes":{ - "AccountLimit":{ - "type":"structure", - "members":{ - "TotalCodeSize":{ - "shape":"Long", - "documentation":"

The amount of storage space that you can use for all deployment packages and layer archives.

" - }, - "CodeSizeUnzipped":{ - "shape":"Long", - "documentation":"

The maximum size of a function's deployment package and layers when they're extracted.

" - }, - "CodeSizeZipped":{ - "shape":"Long", - "documentation":"

The maximum size of a deployment package when it's uploaded directly to Lambda. Use Amazon S3 for larger files.

" - }, - "ConcurrentExecutions":{ - "shape":"Integer", - "documentation":"

The maximum number of simultaneous function executions.

" - }, - "UnreservedConcurrentExecutions":{ - "shape":"UnreservedConcurrentExecutions", - "documentation":"

The maximum number of simultaneous function executions, minus the capacity that's reserved for individual functions with PutFunctionConcurrency.

" - } - }, - "documentation":"

Limits that are related to concurrency and storage. All file and storage sizes are in bytes.

" - }, - "AccountUsage":{ - "type":"structure", - "members":{ - "TotalCodeSize":{ - "shape":"Long", - "documentation":"

The amount of storage space, in bytes, that's being used by deployment packages and layer archives.

" - }, - "FunctionCount":{ - "shape":"Long", - "documentation":"

The number of Lambda functions.

" - } - }, - "documentation":"

The number of functions and amount of storage in use.

" - }, - "Action":{ - "type":"string", - "max":10000, - "min":0, - "pattern":"(lambda:[*]|lambda:[a-zA-Z]+|[*])" - }, - "AddLayerVersionPermissionRequest":{ - "type":"structure", - "required":[ - "LayerName", - "VersionNumber", - "StatementId", - "Action", - "Principal" - ], - "members":{ - "LayerName":{ - "shape":"LayerName", - "documentation":"

The name or Amazon Resource Name (ARN) of the layer.

", - "location":"uri", - "locationName":"LayerName" - }, - "VersionNumber":{ - "shape":"LayerVersionNumber", - "documentation":"

The version number.

", - "location":"uri", - "locationName":"VersionNumber" - }, - "StatementId":{ - "shape":"StatementId", - "documentation":"

An identifier that distinguishes the policy from others on the same layer version.

" - }, - "Action":{ - "shape":"LayerPermissionAllowedAction", - "documentation":"

The API action that grants access to the layer. For example, lambda:GetLayerVersion.

" - }, - "Principal":{ - "shape":"LayerPermissionAllowedPrincipal", - "documentation":"

An account ID, or * to grant layer usage permission to all accounts in an organization, or all Amazon Web Services accounts (if organizationId is not specified). For the last case, make sure that you really do want all Amazon Web Services accounts to have usage permission to this layer.

" - }, - "OrganizationId":{ - "shape":"OrganizationId", - "documentation":"

With the principal set to *, grant permission to all accounts in the specified organization.

" - }, - "RevisionId":{ - "shape":"String", - "documentation":"

Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a policy that has changed since you last read it.

", - "location":"querystring", - "locationName":"RevisionId" - } - } - }, - "AddLayerVersionPermissionResponse":{ - "type":"structure", - "members":{ - "Statement":{ - "shape":"String", - "documentation":"

The permission statement.

" - }, - "RevisionId":{ - "shape":"String", - "documentation":"

A unique identifier for the current revision of the policy.

" - } - } - }, - "AddPermissionRequest":{ - "type":"structure", - "required":[ - "FunctionName", - "StatementId", - "Action", - "Principal" - ], - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "documentation":"

The name or ARN of the Lambda function, version, or alias.

Name formats

  • Function name – my-function (name-only), my-function:v1 (with alias).

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "location":"uri", - "locationName":"FunctionName" - }, - "StatementId":{ - "shape":"StatementId", - "documentation":"

A statement identifier that differentiates the statement from others in the same policy.

" - }, - "Action":{ - "shape":"Action", - "documentation":"

The action that the principal can use on the function. For example, lambda:InvokeFunction or lambda:GetFunction.

" - }, - "Principal":{ - "shape":"Principal", - "documentation":"

The Amazon Web Services service, Amazon Web Services account, IAM user, or IAM role that invokes the function. If you specify a service, use SourceArn or SourceAccount to limit who can invoke the function through that service.

" - }, - "SourceArn":{ - "shape":"Arn", - "documentation":"

For Amazon Web Services services, the ARN of the Amazon Web Services resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic.

Note that Lambda configures the comparison using the StringLike operator.

" - }, - "FunctionUrlAuthType":{ - "shape":"FunctionUrlAuthType", - "documentation":"

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Control access to Lambda function URLs.

" - }, - "InvokedViaFunctionUrl":{ - "shape":"InvokedViaFunctionUrl", - "documentation":"

Indicates whether the permission applies when the function is invoked through a function URL.

" - }, - "SourceAccount":{ - "shape":"SourceOwner", - "documentation":"

For Amazon Web Services service, the ID of the Amazon Web Services account that owns the resource. Use this together with SourceArn to ensure that the specified account owns the resource. It is possible for an Amazon S3 bucket to be deleted by its owner and recreated by another account.

" - }, - "EventSourceToken":{ - "shape":"EventSourceToken", - "documentation":"

For Alexa Smart Home functions, a token that the invoker must supply.

" - }, - "Qualifier":{ - "shape":"NumericLatestPublishedOrAliasQualifier", - "documentation":"

Specify a version or alias to add permissions to a published version of the function.

", - "location":"querystring", - "locationName":"Qualifier" - }, - "RevisionId":{ - "shape":"String", - "documentation":"

Update the policy only if the revision ID matches the ID that's specified. Use this option to avoid modifying a policy that has changed since you last read it.

" - }, - "PrincipalOrgID":{ - "shape":"PrincipalOrgID", - "documentation":"

The identifier for your organization in Organizations. Use this to grant permissions to all the Amazon Web Services accounts under this organization.

" - } - } - }, - "AddPermissionResponse":{ - "type":"structure", - "members":{ - "Statement":{ - "shape":"String", - "documentation":"

The permission statement that's added to the function policy.

" - } - } - }, - "AdditionalVersion":{ - "type":"string", - "max":1024, - "min":1, - "pattern":"[0-9]+" - }, - "AdditionalVersionWeights":{ - "type":"map", - "key":{"shape":"AdditionalVersion"}, - "value":{"shape":"Weight"} - }, - "Alias":{ - "type":"string", - "max":128, - "min":1, - "pattern":"(?!^[0-9]+$)([a-zA-Z0-9-_]+)" - }, - "AliasConfiguration":{ - "type":"structure", - "members":{ - "AliasArn":{ - "shape":"FunctionArn", - "documentation":"

The Amazon Resource Name (ARN) of the alias.

" - }, - "Name":{ - "shape":"Alias", - "documentation":"

The name of the alias.

" - }, - "FunctionVersion":{ - "shape":"Version", - "documentation":"

The function version that the alias invokes.

" - }, - "Description":{ - "shape":"Description", - "documentation":"

A description of the alias.

" - }, - "RoutingConfig":{ - "shape":"AliasRoutingConfiguration", - "documentation":"

The routing configuration of the alias.

" - }, - "RevisionId":{ - "shape":"String", - "documentation":"

A unique identifier that changes when you update the alias.

" - } - }, - "documentation":"

Provides configuration information about a Lambda function alias.

" - }, - "AliasLimitExceededException":{ - "type":"structure", - "members":{ - "Type":{ - "shape":"String", - "documentation":"

The exception type.

" - }, - "message":{ - "shape":"String", - "documentation":"

The exception message.

" - } - }, - "documentation":"

Lambda couldn't create the alias because your Amazon Web Services account has exceeded the maximum number of aliases allowed per Lambda function. For more information, see Lambda quotas.

", - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "AliasList":{ - "type":"list", - "member":{"shape":"AliasConfiguration"} - }, - "AliasRoutingConfiguration":{ - "type":"structure", - "members":{ - "AdditionalVersionWeights":{ - "shape":"AdditionalVersionWeights", - "documentation":"

The second version, and the percentage of traffic that's routed to it.

" - } - }, - "documentation":"

The traffic-shifting configuration of a Lambda function alias.

" - }, - "AllowCredentials":{ - "type":"boolean", - "box":true - }, - "AllowMethodsList":{ - "type":"list", - "member":{"shape":"Method"}, - "max":6, - "min":0 - }, - "AllowOriginsList":{ - "type":"list", - "member":{"shape":"Origin"}, - "max":100, - "min":0 - }, - "AllowedPublishers":{ - "type":"structure", - "required":["SigningProfileVersionArns"], - "members":{ - "SigningProfileVersionArns":{ - "shape":"SigningProfileVersionArns", - "documentation":"

The Amazon Resource Name (ARN) for each of the signing profiles. A signing profile defines a trusted user who can sign a code package.

" - } - }, - "documentation":"

List of signing profiles that can sign a code package.

" - }, - "AmazonManagedKafkaEventSourceConfig":{ - "type":"structure", - "members":{ - "ConsumerGroupId":{ - "shape":"URI", - "documentation":"

The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see Customizable consumer group ID.

" - }, - "SchemaRegistryConfig":{ - "shape":"KafkaSchemaRegistryConfig", - "documentation":"

Specific configuration settings for a Kafka schema registry.

" - } - }, - "documentation":"

Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.

" - }, - "ApplicationLogLevel":{ - "type":"string", - "enum":[ - "TRACE", - "DEBUG", - "INFO", - "WARN", - "ERROR", - "FATAL" - ] - }, - "Architecture":{ - "type":"string", - "enum":[ - "x86_64", - "arm64" - ] - }, - "ArchitecturesList":{ - "type":"list", - "member":{"shape":"Architecture"}, - "max":1, - "min":1 - }, - "Arn":{ - "type":"string", - "max":10000, - "min":0, - "pattern":"arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-])+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.*)" - }, - "AttemptCount":{ - "type":"integer", - "min":0 - }, - "BatchSize":{ - "type":"integer", - "box":true, - "max":10000, - "min":1 - }, - "BinaryOperationPayload":{ - "type":"blob", - "max":262144, - "min":0, - "sensitive":true - }, - "BisectBatchOnFunctionError":{ - "type":"boolean", - "box":true - }, - "Blob":{ - "type":"blob", - "sensitive":true - }, - "BlobStream":{ - "type":"blob", - "streaming":true - }, - "Boolean":{"type":"boolean"}, - "CallbackDetails":{ - "type":"structure", - "members":{ - "CallbackId":{ - "shape":"CallbackId", - "documentation":"

The callback ID. Callback IDs are generated by the DurableContext when a durable function calls ctx.waitForCallback.

" - }, - "Result":{ - "shape":"OperationPayload", - "documentation":"

The response payload from the callback operation as a string.

" - }, - "Error":{ - "shape":"ErrorObject", - "documentation":"

An error object that contains details about the failure.

" - } - }, - "documentation":"

Contains details about a callback operation in a durable execution, including the callback token and timeout configuration.

" - }, - "CallbackFailedDetails":{ - "type":"structure", - "required":["Error"], - "members":{ - "Error":{ - "shape":"EventError", - "documentation":"

An error object that contains details about the failure.

" - } - }, - "documentation":"

Contains details about a failed callback operation, including error information and the reason for failure.

" - }, - "CallbackId":{ - "type":"string", - "max":1024, - "min":1, - "pattern":"[A-Za-z0-9+/]+={0,2}" - }, - "CallbackOptions":{ - "type":"structure", - "members":{ - "TimeoutSeconds":{ - "shape":"CallbackOptionsTimeoutSecondsInteger", - "documentation":"

The timeout for the callback operation in seconds. If not specified or set to 0, the callback has no timeout.

" - }, - "HeartbeatTimeoutSeconds":{ - "shape":"CallbackOptionsHeartbeatTimeoutSecondsInteger", - "documentation":"

The heartbeat timeout for the callback operation, in seconds. If not specified or set to 0, heartbeat timeout is disabled.

" - } - }, - "documentation":"

Configuration options for callback operations in durable executions, including timeout settings and retry behavior.

" - }, - "CallbackOptionsHeartbeatTimeoutSecondsInteger":{ - "type":"integer", - "box":true, - "max":99999999, - "min":0 - }, - "CallbackOptionsTimeoutSecondsInteger":{ - "type":"integer", - "box":true, - "max":99999999, - "min":0 - }, - "CallbackStartedDetails":{ - "type":"structure", - "required":["CallbackId"], - "members":{ - "CallbackId":{ - "shape":"CallbackId", - "documentation":"

The callback ID. Callback IDs are generated by the DurableContext when a durable function calls ctx.waitForCallback.

" - }, - "HeartbeatTimeout":{ - "shape":"DurationSeconds", - "documentation":"

The heartbeat timeout value, in seconds.

" - }, - "Timeout":{ - "shape":"DurationSeconds", - "documentation":"

The timeout value, in seconds.

" - } - }, - "documentation":"

Contains details about a callback operation that has started, including timing information and callback metadata.

" - }, - "CallbackSucceededDetails":{ - "type":"structure", - "required":["Result"], - "members":{ - "Result":{ - "shape":"EventResult", - "documentation":"

The response payload from the successful operation.

" - } - }, - "documentation":"

Contains details about a successfully completed callback operation, including the result data and completion timestamp.

" - }, - "CallbackTimedOutDetails":{ - "type":"structure", - "required":["Error"], - "members":{ - "Error":{ - "shape":"EventError", - "documentation":"

Details about the callback timeout.

" - } - }, - "documentation":"

Contains details about a callback operation that timed out, including timeout duration and any partial results.

" - }, - "CallbackTimeoutException":{ - "type":"structure", - "members":{ - "Type":{ - "shape":"String", - "documentation":"

The exception type.

" - }, - "Message":{"shape":"String"} - }, - "documentation":"

The callback ID token has either expired or the callback associated with the token has already been closed.

", - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "CapacityProvider":{ - "type":"structure", - "required":[ - "CapacityProviderArn", - "State", - "VpcConfig", - "PermissionsConfig" - ], - "members":{ - "CapacityProviderArn":{ - "shape":"CapacityProviderArn", - "documentation":"

The Amazon Resource Name (ARN) of the capacity provider.

" - }, - "State":{ - "shape":"CapacityProviderState", - "documentation":"

The current state of the capacity provider.

" - }, - "VpcConfig":{ - "shape":"CapacityProviderVpcConfig", - "documentation":"

The VPC configuration for the capacity provider.

" - }, - "PermissionsConfig":{ - "shape":"CapacityProviderPermissionsConfig", - "documentation":"

The permissions configuration for the capacity provider.

" - }, - "InstanceRequirements":{ - "shape":"InstanceRequirements", - "documentation":"

The instance requirements for compute resources managed by the capacity provider.

" - }, - "CapacityProviderScalingConfig":{ - "shape":"CapacityProviderScalingConfig", - "documentation":"

The scaling configuration for the capacity provider.

" - }, - "KmsKeyArn":{ - "shape":"KMSKeyArn", - "documentation":"

The ARN of the KMS key used to encrypt the capacity provider's resources.

" - }, - "LastModified":{ - "shape":"Timestamp", - "documentation":"

The date and time when the capacity provider was last modified.

" - }, - "PropagateTags":{"shape":"PropagateTags"}, - "TelemetryConfig":{ - "shape":"CapacityProviderTelemetryConfig", - "documentation":"

The telemetry configuration for the capacity provider, including logging settings.

" - } - }, - "documentation":"

A capacity provider manages compute resources for Lambda functions.

" - }, - "CapacityProviderArn":{ - "type":"string", - "max":140, - "min":1, - "pattern":"arn:aws[a-zA-Z-]*:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:capacity-provider:[a-zA-Z0-9-_]+" - }, - "CapacityProviderConfig":{ - "type":"structure", - "required":["LambdaManagedInstancesCapacityProviderConfig"], - "members":{ - "LambdaManagedInstancesCapacityProviderConfig":{ - "shape":"LambdaManagedInstancesCapacityProviderConfig", - "documentation":"

Configuration for Lambda-managed instances used by the capacity provider.

" - } - }, - "documentation":"

Configuration for the capacity provider that manages compute resources for Lambda functions.

" - }, - "CapacityProviderLimitExceededException":{ - "type":"structure", - "members":{ - "Type":{ - "shape":"String", - "documentation":"

The exception type.

" - }, - "message":{"shape":"String"} - }, - "documentation":"

The maximum number of capacity providers for your account has been exceeded. For more information, see Lambda quotas

", - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "CapacityProviderLoggingConfig":{ - "type":"structure", - "members":{ - "SystemLogLevel":{ - "shape":"SystemLogLevel", - "documentation":"

Set this property to filter the system logs for your capacity provider that Lambda sends to CloudWatch. Lambda only sends system logs at the selected level of detail and lower, where DEBUG is the highest level and WARN is the lowest.

" - }, - "LogGroup":{ - "shape":"LogGroup", - "documentation":"

The name of the Amazon CloudWatch log group the capacity provider sends logs to. By default, Lambda capacity providers send logs to a default log group named /aws/lambda/capacity-provider/<capacity provider name>. To use a different log group, enter an existing log group or enter a new log group name.

" - } - }, - "documentation":"

The capacity provider's Amazon CloudWatch Logs configuration settings.

" - }, - "CapacityProviderMaxVCpuCount":{ - "type":"integer", - "box":true, - "max":15000, - "min":2 - }, - "CapacityProviderName":{ - "type":"string", - "max":140, - "min":1, - "pattern":"(arn:aws[a-zA-Z-]*:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:capacity-provider:[a-zA-Z0-9-_]+)|[a-zA-Z0-9-_]+" - }, - "CapacityProviderPermissionsConfig":{ - "type":"structure", - "required":["CapacityProviderOperatorRoleArn"], - "members":{ - "CapacityProviderOperatorRoleArn":{ - "shape":"RoleArn", - "documentation":"

The ARN of the IAM role that the capacity provider uses to manage compute instances and other Amazon Web Services resources.

" - } - }, - "documentation":"

Configuration that specifies the permissions required for the capacity provider to manage compute resources.

" - }, - "CapacityProviderPredefinedMetricType":{ - "type":"string", - "enum":["LambdaCapacityProviderAverageCPUUtilization"] - }, - "CapacityProviderScalingConfig":{ - "type":"structure", - "members":{ - "MaxVCpuCount":{ - "shape":"CapacityProviderMaxVCpuCount", - "documentation":"

The maximum number of vCPUs that the capacity provider can provision across all compute instances.

" - }, - "ScalingMode":{ - "shape":"CapacityProviderScalingMode", - "documentation":"

The scaling mode that determines how the capacity provider responds to changes in demand.

" - }, - "ScalingPolicies":{ - "shape":"CapacityProviderScalingPoliciesList", - "documentation":"

A list of scaling policies that define how the capacity provider scales compute instances based on metrics and thresholds.

" - } - }, - "documentation":"

Configuration that defines how the capacity provider scales compute instances based on demand and policies.

" - }, - "CapacityProviderScalingMode":{ - "type":"string", - "enum":[ - "Auto", - "Manual" - ] - }, - "CapacityProviderScalingPoliciesList":{ - "type":"list", - "member":{"shape":"TargetTrackingScalingPolicy"}, - "max":10, - "min":1 - }, - "CapacityProviderSecurityGroupIds":{ - "type":"list", - "member":{"shape":"SecurityGroupId"}, - "max":5, - "min":0 - }, - "CapacityProviderState":{ - "type":"string", - "enum":[ - "Pending", - "Active", - "Failed", - "Deleting" - ] - }, - "CapacityProviderSubnetIds":{ - "type":"list", - "member":{"shape":"SubnetId"}, - "max":16, - "min":1 - }, - "CapacityProviderTelemetryConfig":{ - "type":"structure", - "members":{ - "LoggingConfig":{ - "shape":"CapacityProviderLoggingConfig", - "documentation":"

The capacity provider's Amazon CloudWatch Logs configuration settings.

" - } - }, - "documentation":"

Configuration that specifies the telemetry collection for the capacity provider.

" - }, - "CapacityProviderVpcConfig":{ - "type":"structure", - "required":[ - "SubnetIds", - "SecurityGroupIds" - ], - "members":{ - "SubnetIds":{ - "shape":"CapacityProviderSubnetIds", - "documentation":"

A list of subnet IDs where the capacity provider launches compute instances.

" - }, - "SecurityGroupIds":{ - "shape":"CapacityProviderSecurityGroupIds", - "documentation":"

A list of security group IDs that control network access for compute instances managed by the capacity provider.

" - } - }, - "documentation":"

VPC configuration that specifies the network settings for compute instances managed by the capacity provider.

" - }, - "CapacityProvidersList":{ - "type":"list", - "member":{"shape":"CapacityProvider"}, - "max":50, - "min":0 - }, - "ChainedInvokeDetails":{ - "type":"structure", - "members":{ - "Result":{ - "shape":"OperationPayload", - "documentation":"

The response payload from the chained invocation.

" - }, - "Error":{ - "shape":"ErrorObject", - "documentation":"

Details about the chained invocation failure.

" - } - }, - "documentation":"

Contains details about a chained function invocation in a durable execution, including the target function and invocation parameters.

" - }, - "ChainedInvokeFailedDetails":{ - "type":"structure", - "required":["Error"], - "members":{ - "Error":{ - "shape":"EventError", - "documentation":"

Details about the chained invocation failure.

" - } - }, - "documentation":"

Contains details about a failed chained function invocation, including error information and failure reason.

" - }, - "ChainedInvokeOptions":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "documentation":"

The name or ARN of the Lambda function to invoke.

" - }, - "TenantId":{ - "shape":"TenantId", - "documentation":"

The tenant identifier for the chained invocation.

" - } - }, - "documentation":"

Configuration options for chained function invocations in durable executions, including retry settings and timeout configuration.

" - }, - "ChainedInvokeStartedDetails":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "documentation":"

The name or ARN of the Lambda function being invoked.

" - }, - "TenantId":{ - "shape":"TenantId", - "documentation":"

The tenant identifier for the chained invocation.

" - }, - "Input":{ - "shape":"EventInput", - "documentation":"

The JSON input payload provided to the chained invocation.

" - }, - "ExecutedVersion":{ - "shape":"VersionWithLatestPublished", - "documentation":"

The version of the function that was executed.

" - }, - "DurableExecutionArn":{ - "shape":"DurableExecutionArn", - "documentation":"

The Amazon Resource Name (ARN) that identifies the durable execution.

" - } - }, - "documentation":"

Contains details about a chained function invocation that has started execution, including start time and execution context.

" - }, - "ChainedInvokeStoppedDetails":{ - "type":"structure", - "required":["Error"], - "members":{ - "Error":{ - "shape":"EventError", - "documentation":"

Details about why the chained invocation stopped.

" - } - }, - "documentation":"

Details about a chained invocation that was stopped.

" - }, - "ChainedInvokeSucceededDetails":{ - "type":"structure", - "required":["Result"], - "members":{ - "Result":{ - "shape":"EventResult", - "documentation":"

The response payload from the successful operation.

" - } - }, - "documentation":"

Details about a chained invocation that succeeded.

" - }, - "ChainedInvokeTimedOutDetails":{ - "type":"structure", - "required":["Error"], - "members":{ - "Error":{ - "shape":"EventError", - "documentation":"

Details about the chained invocation timeout.

" - } - }, - "documentation":"

Details about a chained invocation that timed out.

" - }, - "CheckpointDurableExecutionRequest":{ - "type":"structure", - "required":[ - "DurableExecutionArn", - "CheckpointToken" - ], - "members":{ - "DurableExecutionArn":{ - "shape":"DurableExecutionArn", - "documentation":"

The Amazon Resource Name (ARN) of the durable execution.

", - "location":"uri", - "locationName":"DurableExecutionArn" - }, - "CheckpointToken":{ - "shape":"CheckpointToken", - "documentation":"

A unique token that identifies the current checkpoint state. This token is provided by the Lambda runtime and must be used to ensure checkpoints are applied in the correct order. Each checkpoint operation consumes this token and returns a new one.

" - }, - "Updates":{ - "shape":"OperationUpdates", - "documentation":"

An array of state updates to apply during this checkpoint. Each update represents a change to the execution state, such as completing a step, starting a callback, or scheduling a timer. Updates are applied atomically as part of the checkpoint operation.

" - }, - "ClientToken":{ - "shape":"ClientToken", - "documentation":"

An optional idempotency token to ensure that duplicate checkpoint requests are handled correctly. If provided, Lambda uses this token to detect and handle duplicate requests within a 15-minute window.

", - "idempotencyToken":true - } - } - }, - "CheckpointDurableExecutionResponse":{ - "type":"structure", - "required":["NewExecutionState"], - "members":{ - "CheckpointToken":{ - "shape":"CheckpointToken", - "documentation":"

A new checkpoint token to use for the next checkpoint operation. This token replaces the one provided in the request and must be used for subsequent checkpoints to maintain proper ordering.

" - }, - "NewExecutionState":{ - "shape":"CheckpointUpdatedExecutionState", - "documentation":"

Updated execution state information that includes any changes that occurred since the last checkpoint, such as completed callbacks or expired timers. This allows the SDK to update its internal state during replay.

" - } - }, - "documentation":"

The response from the CheckpointDurableExecution operation.

" - }, - "CheckpointToken":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"[A-Za-z0-9+/]+={0,2}" - }, - "CheckpointUpdatedExecutionState":{ - "type":"structure", - "members":{ - "Operations":{ - "shape":"Operations", - "documentation":"

A list of operations that have been updated since the last checkpoint.

" - }, - "NextMarker":{ - "shape":"String", - "documentation":"

Indicates that more results are available. Use this value in a subsequent call to retrieve the next page of results.

" - } - }, - "documentation":"

Contains operations that have been updated since the last checkpoint, such as completed asynchronous work like timers or callbacks.

" - }, - "ClientToken":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[\\x21-\\x7E]+" - }, - "CodeArtifactUserDeletedException":{ - "type":"structure", - "members":{ - "Type":{ - "shape":"String", - "documentation":"

The exception type.

" - }, - "message":{ - "shape":"String", - "documentation":"

The exception message.

" - } - }, - "documentation":"

The Lambda function couldn't be invoked because its code artifact user has been deleted. Wait for Lambda to provision a new code artifact user, or update the function's code package to recreate it.

", - "error":{ - "httpStatusCode":409, - "senderFault":true - }, - "exception":true - }, - "CodeArtifactUserFailedException":{ - "type":"structure", - "members":{ - "Type":{ - "shape":"String", - "documentation":"

The exception type.

" - }, - "message":{ - "shape":"String", - "documentation":"

The exception message.

" - } - }, - "documentation":"

The Lambda function couldn't be invoked because provisioning of its code artifact user failed. Update the function's code package or check the Lambda function's State and StateReasonCode for additional context.

", - "error":{ - "httpStatusCode":409, - "senderFault":true - }, - "exception":true - }, - "CodeArtifactUserPendingException":{ - "type":"structure", - "members":{ - "Type":{ - "shape":"String", - "documentation":"

The exception type.

" - }, - "message":{ - "shape":"String", - "documentation":"

The exception message.

" - } - }, - "documentation":"

The Lambda function couldn't be invoked because its code artifact user is still being provisioned. Wait for the function's State to become Active and try the request again.

", - "error":{ - "httpStatusCode":409, - "senderFault":true - }, - "exception":true - }, - "CodeSigningConfig":{ - "type":"structure", - "required":[ - "CodeSigningConfigId", - "CodeSigningConfigArn", - "AllowedPublishers", - "CodeSigningPolicies", - "LastModified" - ], - "members":{ - "CodeSigningConfigId":{ - "shape":"CodeSigningConfigId", - "documentation":"

Unique identifer for the Code signing configuration.

" - }, - "CodeSigningConfigArn":{ - "shape":"CodeSigningConfigArn", - "documentation":"

The Amazon Resource Name (ARN) of the Code signing configuration.

" - }, - "Description":{ - "shape":"Description", - "documentation":"

Code signing configuration description.

" - }, - "AllowedPublishers":{ - "shape":"AllowedPublishers", - "documentation":"

List of allowed publishers.

" - }, - "CodeSigningPolicies":{ - "shape":"CodeSigningPolicies", - "documentation":"

The code signing policy controls the validation failure action for signature mismatch or expiry.

" - }, - "LastModified":{ - "shape":"Timestamp", - "documentation":"

The date and time that the Code signing configuration was last modified, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" - } - }, - "documentation":"

Details about a Code signing configuration.

" - }, - "CodeSigningConfigArn":{ - "type":"string", - "max":200, - "min":0, - "pattern":"arn:(aws[a-zA-Z-]*)?:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:code-signing-config:csc-[a-z0-9]{17}" - }, - "CodeSigningConfigId":{ - "type":"string", - "pattern":"csc-[a-zA-Z0-9-_\\.]{17}" - }, - "CodeSigningConfigList":{ - "type":"list", - "member":{"shape":"CodeSigningConfig"} - }, - "CodeSigningConfigNotFoundException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "documentation":"

The specified code signing configuration does not exist.

", - "error":{ - "httpStatusCode":404, - "senderFault":true - }, - "exception":true - }, - "CodeSigningPolicies":{ - "type":"structure", - "members":{ - "UntrustedArtifactOnDeployment":{ - "shape":"CodeSigningPolicy", - "documentation":"

Code signing configuration policy for deployment validation failure. If you set the policy to Enforce, Lambda blocks the deployment request if signature validation checks fail. If you set the policy to Warn, Lambda allows the deployment and issues a new Amazon CloudWatch metric (SignatureValidationErrors) and also stores the warning in the CloudTrail log.

Default value: Warn

" - } - }, - "documentation":"

Code signing configuration policies specify the validation failure action for signature mismatch or expiry.

" - }, - "CodeSigningPolicy":{ - "type":"string", - "enum":[ - "Warn", - "Enforce" - ] - }, - "CodeStorageExceededException":{ - "type":"structure", - "members":{ - "Type":{ - "shape":"String", - "documentation":"

The exception type.

" - }, - "message":{"shape":"String"} - }, - "documentation":"

Your Amazon Web Services account has exceeded its maximum total code size. For more information, see Lambda quotas.

", - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "CodeVerificationFailedException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "documentation":"

The code signature failed one or more of the validation checks for signature mismatch or expiry, and the code signing policy is set to ENFORCE. Lambda blocks the deployment.

", - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "CollectionName":{ - "type":"string", - "max":57, - "min":1, - "pattern":"(^(?!(system\\x2e)))(^[_a-zA-Z0-9])([^$]*)" - }, - "CompatibleArchitectures":{ - "type":"list", - "member":{"shape":"Architecture"}, - "max":2, - "min":0 - }, - "CompatibleRuntimes":{ - "type":"list", - "member":{"shape":"Runtime"}, - "max":15, - "min":0 - }, - "Concurrency":{ - "type":"structure", - "members":{ - "ReservedConcurrentExecutions":{ - "shape":"ReservedConcurrentExecutions", - "documentation":"

The number of concurrent executions that are reserved for this function. For more information, see Managing Lambda reserved concurrency.

" - } - } - }, - "ContextDetails":{ - "type":"structure", - "members":{ - "ReplayChildren":{ - "shape":"ReplayChildren", - "documentation":"

Whether the state data of child operations of this completed context should be included in the invoke payload and GetDurableExecutionState response.

" - }, - "Result":{ - "shape":"OperationPayload", - "documentation":"

The response payload from the context.

" - }, - "Error":{ - "shape":"ErrorObject", - "documentation":"

Details about the context failure.

" - } - }, - "documentation":"

Details about a durable execution context.

" - }, - "ContextFailedDetails":{ - "type":"structure", - "required":["Error"], - "members":{ - "Error":{ - "shape":"EventError", - "documentation":"

Details about the context failure.

" - } - }, - "documentation":"

Details about a context that failed.

" - }, - "ContextOptions":{ - "type":"structure", - "members":{ - "ReplayChildren":{ - "shape":"ReplayChildren", - "documentation":"

Whether the state data of children of the completed context should be included in the invoke payload and GetDurableExecutionState response.

" - } - }, - "documentation":"

Configuration options for a durable execution context.

" - }, - "ContextStartedDetails":{ - "type":"structure", - "members":{}, - "documentation":"

Details about a context that has started.

" - }, - "ContextSucceededDetails":{ - "type":"structure", - "required":["Result"], - "members":{ - "Result":{ - "shape":"EventResult", - "documentation":"

The JSON response payload from the successful context.

" - } - }, - "documentation":"

Details about a context that succeeded.

" - }, - "Cors":{ - "type":"structure", - "members":{ - "AllowCredentials":{ - "shape":"AllowCredentials", - "documentation":"

Whether to allow cookies or other credentials in requests to your function URL. The default is false.

" - }, - "AllowHeaders":{ - "shape":"HeadersList", - "documentation":"

The HTTP headers that origins can include in requests to your function URL. For example: Date, Keep-Alive, X-Custom-Header.

" - }, - "AllowMethods":{ - "shape":"AllowMethodsList", - "documentation":"

The HTTP methods that are allowed when calling your function URL. For example: GET, POST, DELETE, or the wildcard character (*).

" - }, - "AllowOrigins":{ - "shape":"AllowOriginsList", - "documentation":"

The origins that can access your function URL. You can list any number of specific origins, separated by a comma. For example: https://www.example.com, http://localhost:60905.

Alternatively, you can grant access to all origins using the wildcard character (*).

" - }, - "ExposeHeaders":{ - "shape":"HeadersList", - "documentation":"

The HTTP headers in your function response that you want to expose to origins that call your function URL. For example: Date, Keep-Alive, X-Custom-Header.

" - }, - "MaxAge":{ - "shape":"MaxAge", - "documentation":"

The maximum amount of time, in seconds, that web browsers can cache results of a preflight request. By default, this is set to 0, which means that the browser doesn't cache results.

" - } - }, - "documentation":"

The cross-origin resource sharing (CORS) settings for your Lambda function URL. Use CORS to grant access to your function URL from any origin. You can also use CORS to control access for specific HTTP headers and methods in requests to your function URL.

" - }, - "CreateAliasRequest":{ - "type":"structure", - "required":[ - "FunctionName", - "Name", - "FunctionVersion" - ], - "members":{ - "FunctionName":{ - "shape":"FunctionName", - "documentation":"

The name or ARN of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "location":"uri", - "locationName":"FunctionName" - }, - "Name":{ - "shape":"Alias", - "documentation":"

The name of the alias.

" - }, - "FunctionVersion":{ - "shape":"VersionWithLatestPublished", - "documentation":"

The function version that the alias invokes.

" - }, - "Description":{ - "shape":"Description", - "documentation":"

A description of the alias.

" - }, - "RoutingConfig":{ - "shape":"AliasRoutingConfiguration", - "documentation":"

The routing configuration of the alias.

" - } - } - }, - "CreateCapacityProviderRequest":{ - "type":"structure", - "required":[ - "CapacityProviderName", - "VpcConfig", - "PermissionsConfig" - ], - "members":{ - "CapacityProviderName":{ - "shape":"CapacityProviderName", - "documentation":"

The name of the capacity provider.

" - }, - "VpcConfig":{ - "shape":"CapacityProviderVpcConfig", - "documentation":"

The VPC configuration for the capacity provider, including subnet IDs and security group IDs where compute instances will be launched.

" - }, - "PermissionsConfig":{ - "shape":"CapacityProviderPermissionsConfig", - "documentation":"

The permissions configuration that specifies the IAM role ARN used by the capacity provider to manage compute resources.

" - }, - "InstanceRequirements":{ - "shape":"InstanceRequirements", - "documentation":"

The instance requirements that specify the compute instance characteristics, including architectures and allowed or excluded instance types.

" - }, - "CapacityProviderScalingConfig":{ - "shape":"CapacityProviderScalingConfig", - "documentation":"

The scaling configuration that defines how the capacity provider scales compute instances, including maximum vCPU count and scaling policies.

" - }, - "KmsKeyArn":{ - "shape":"KMSKeyArnNonEmpty", - "documentation":"

The ARN of the KMS key used to encrypt data associated with the capacity provider.

" - }, - "Tags":{ - "shape":"Tags", - "documentation":"

A list of tags to associate with the capacity provider.

" - }, - "PropagateTags":{ - "shape":"PropagateTags", - "documentation":"

The tag propagation configuration for the capacity provider. Specifies tags to apply to managed resources at launch.

" - }, - "TelemetryConfig":{ - "shape":"CapacityProviderTelemetryConfig", - "documentation":"

The telemetry configuration for the capacity provider. Specifies logging settings for managed resources.

" - } - } - }, - "CreateCapacityProviderResponse":{ - "type":"structure", - "required":["CapacityProvider"], - "members":{ - "CapacityProvider":{ - "shape":"CapacityProvider", - "documentation":"

Information about the capacity provider that was created.

" - } - } - }, - "CreateCodeSigningConfigRequest":{ - "type":"structure", - "required":["AllowedPublishers"], - "members":{ - "Description":{ - "shape":"Description", - "documentation":"

Descriptive name for this code signing configuration.

" - }, - "AllowedPublishers":{ - "shape":"AllowedPublishers", - "documentation":"

Signing profiles for this code signing configuration.

" - }, - "CodeSigningPolicies":{ - "shape":"CodeSigningPolicies", - "documentation":"

The code signing policies define the actions to take if the validation checks fail.

" - }, - "Tags":{ - "shape":"Tags", - "documentation":"

A list of tags to add to the code signing configuration.

" - } - } - }, - "CreateCodeSigningConfigResponse":{ - "type":"structure", - "required":["CodeSigningConfig"], - "members":{ - "CodeSigningConfig":{ - "shape":"CodeSigningConfig", - "documentation":"

The code signing configuration.

" - } - } - }, - "CreateEventSourceMappingRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "EventSourceArn":{ - "shape":"Arn", - "documentation":"

The Amazon Resource Name (ARN) of the event source.

  • Amazon Kinesis – The ARN of the data stream or a stream consumer.

  • Amazon DynamoDB Streams – The ARN of the stream.

  • Amazon Simple Queue Service – The ARN of the queue.

  • Amazon Managed Streaming for Apache Kafka – The ARN of the cluster or the ARN of the VPC connection (for cross-account event source mappings).

  • Amazon MQ – The ARN of the broker.

  • Amazon DocumentDB – The ARN of the DocumentDB change stream.

" - }, - "FunctionName":{ - "shape":"NamespacedFunctionName", - "documentation":"

The name or ARN of the Lambda function.

Name formats

  • Function name – MyFunction.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.

  • Partial ARN – 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.

" - }, - "Enabled":{ - "shape":"Enabled", - "documentation":"

When true, the event source mapping is active. When false, Lambda pauses polling and invocation.

Default: True

" - }, - "BatchSize":{ - "shape":"BatchSize", - "documentation":"

The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).

  • Amazon Kinesis – Default 100. Max 10,000.

  • Amazon DynamoDB Streams – Default 100. Max 10,000.

  • Amazon Simple Queue Service – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.

  • Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000.

  • Self-managed Apache Kafka – Default 100. Max 10,000.

  • Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000.

  • DocumentDB – Default 100. Max 10,000.

" - }, - "FilterCriteria":{ - "shape":"FilterCriteria", - "documentation":"

An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.

" - }, - "KMSKeyArn":{ - "shape":"KMSKeyArn", - "documentation":"

The ARN of the Key Management Service (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria. By default, Lambda does not encrypt your filter criteria object. Specify this property to encrypt data using your own customer managed key.

" - }, - "MetricsConfig":{ - "shape":"EventSourceMappingMetricsConfig", - "documentation":"

The metrics configuration for your event source. For more information, see Event source mapping metrics.

" - }, - "LoggingConfig":{ - "shape":"EventSourceMappingLoggingConfig", - "documentation":"

(Amazon MSK, and self-managed Apache Kafka only) The logging configuration for your event source. For more information, see Event source mapping logging.

" - }, - "ScalingConfig":{ - "shape":"ScalingConfig", - "documentation":"

(Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.

" - }, - "MaximumBatchingWindowInSeconds":{ - "shape":"MaximumBatchingWindowInSeconds", - "documentation":"

The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.

For Kinesis, DynamoDB, and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it. To restore the default batching window, you must create a new event source mapping.

Related setting: For Kinesis, DynamoDB, and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

" - }, - "ParallelizationFactor":{ - "shape":"ParallelizationFactor", - "documentation":"

(Kinesis and DynamoDB Streams only) The number of batches to process from each shard concurrently.

" - }, - "StartingPosition":{ - "shape":"EventSourcePosition", - "documentation":"

The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Stream event sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams, Amazon DocumentDB, Amazon MSK, and self-managed Apache Kafka.

" - }, - "StartingPositionTimestamp":{ - "shape":"Date", - "documentation":"

With StartingPosition set to AT_TIMESTAMP, the time from which to start reading. StartingPositionTimestamp cannot be in the future.

" - }, - "DestinationConfig":{ - "shape":"DestinationConfig", - "documentation":"

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) A configuration object that specifies the destination of an event after Lambda processes it.

" - }, - "MaximumRecordAgeInSeconds":{ - "shape":"MaximumRecordAgeInSeconds", - "documentation":"

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) Discard records older than the specified age. The default value is infinite (-1).

" - }, - "BisectBatchOnFunctionError":{ - "shape":"BisectBatchOnFunctionError", - "documentation":"

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) If the function returns an error, split the batch in two and retry.

" - }, - "MaximumRetryAttempts":{ - "shape":"MaximumRetryAttemptsEventSourceMapping", - "documentation":"

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.

" - }, - "Tags":{ - "shape":"Tags", - "documentation":"

A list of tags to apply to the event source mapping.

" - }, - "TumblingWindowInSeconds":{ - "shape":"TumblingWindowInSeconds", - "documentation":"

(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.

" - }, - "Topics":{ - "shape":"Topics", - "documentation":"

The name of the Kafka topic.

" - }, - "Queues":{ - "shape":"Queues", - "documentation":"

(MQ) The name of the Amazon MQ broker destination queue to consume.

" - }, - "SourceAccessConfigurations":{ - "shape":"SourceAccessConfigurations", - "documentation":"

An array of authentication protocols or VPC components required to secure your event source.

" - }, - "SelfManagedEventSource":{ - "shape":"SelfManagedEventSource", - "documentation":"

The self-managed Apache Kafka cluster to receive records from.

" - }, - "FunctionResponseTypes":{ - "shape":"FunctionResponseTypeList", - "documentation":"

(Kinesis, DynamoDB Streams, Amazon MSK, self-managed Apache Kafka, and Amazon SQS) A list of current response type enums applied to the event source mapping.

" - }, - "AmazonManagedKafkaEventSourceConfig":{ - "shape":"AmazonManagedKafkaEventSourceConfig", - "documentation":"

Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.

" - }, - "SelfManagedKafkaEventSourceConfig":{ - "shape":"SelfManagedKafkaEventSourceConfig", - "documentation":"

Specific configuration settings for a self-managed Apache Kafka event source.

" - }, - "DocumentDBEventSourceConfig":{ - "shape":"DocumentDBEventSourceConfig", - "documentation":"

Specific configuration settings for a DocumentDB event source.

" - }, - "ProvisionedPollerConfig":{ - "shape":"ProvisionedPollerConfig", - "documentation":"

(Amazon SQS, Amazon MSK, and self-managed Apache Kafka only) The provisioned mode configuration for the event source. For more information, see provisioned mode.

" - } - } - }, - "CreateFunctionRequest":{ - "type":"structure", - "required":[ - "FunctionName", - "Role", - "Code" - ], - "members":{ - "FunctionName":{ - "shape":"FunctionName", - "documentation":"

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

" - }, - "Runtime":{ - "shape":"Runtime", - "documentation":"

The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image.

The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see Runtime use after deprecation.

For a list of all currently supported runtimes, see Supported runtimes.

" - }, - "Role":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the function's execution role.

" - }, - "Handler":{ - "shape":"Handler", - "documentation":"

The name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Lambda programming model.

" - }, - "Code":{ - "shape":"FunctionCode", - "documentation":"

The code for the function.

" - }, - "Description":{ - "shape":"Description", - "documentation":"

A description of the function.

" - }, - "Timeout":{ - "shape":"Timeout", - "documentation":"

The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see Lambda execution environment.

" - }, - "MemorySize":{ - "shape":"MemorySize", - "documentation":"

The amount of memory available to the function at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.

" - }, - "Publish":{ - "shape":"Boolean", - "documentation":"

Set to true to publish the first version of the function during creation.

" - }, - "PublishTo":{ - "shape":"FunctionVersionLatestPublished", - "documentation":"

Specifies where to publish the function version or configuration.

" - }, - "VpcConfig":{ - "shape":"VpcConfig", - "documentation":"

For network connectivity to Amazon Web Services resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see Configuring a Lambda function to access resources in a VPC.

" - }, - "PackageType":{ - "shape":"PackageType", - "documentation":"

The type of deployment package. Set to Image for container image and set to Zip for .zip file archive.

" - }, - "DeadLetterConfig":{ - "shape":"DeadLetterConfig", - "documentation":"

A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead-letter queues.

" - }, - "Environment":{ - "shape":"Environment", - "documentation":"

Environment variables that are accessible from function code during execution.

" - }, - "KMSKeyArn":{ - "shape":"KMSKeyArn", - "documentation":"

The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt the following resources:

  • The function's environment variables.

  • The function's Lambda SnapStart snapshots.

  • When used with SourceKMSKeyArn, the unzipped version of the .zip deployment package that's used for function invocations. For more information, see Specifying a customer managed key for Lambda.

  • The optimized version of the container image that's used for function invocations. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). For more information, see Function lifecycle.

If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key or an Amazon Web Services managed key.

" - }, - "TracingConfig":{ - "shape":"TracingConfig", - "documentation":"

Set Mode to Active to sample and trace a subset of incoming requests with X-Ray.

" - }, - "Tags":{ - "shape":"Tags", - "documentation":"

A list of tags to apply to the function.

" - }, - "Layers":{ - "shape":"LayerList", - "documentation":"

A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.

" - }, - "FileSystemConfigs":{ - "shape":"FileSystemConfigList", - "documentation":"

Connection settings for an Amazon EFS file system or an Amazon S3 Files file system.

" - }, - "CodeSigningConfigArn":{ - "shape":"CodeSigningConfigArn", - "documentation":"

To enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.

" - }, - "ImageConfig":{ - "shape":"ImageConfig", - "documentation":"

Container image configuration values that override the values in the container image Dockerfile.

" - }, - "Architectures":{ - "shape":"ArchitecturesList", - "documentation":"

The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64.

" - }, - "EphemeralStorage":{ - "shape":"EphemeralStorage", - "documentation":"

The size of the function's /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).

" - }, - "SnapStart":{ - "shape":"SnapStart", - "documentation":"

The function's SnapStart setting.

" - }, - "LoggingConfig":{ - "shape":"LoggingConfig", - "documentation":"

The function's Amazon CloudWatch Logs configuration settings.

" - }, - "TenancyConfig":{ - "shape":"TenancyConfig", - "documentation":"

Configuration for multi-tenant applications that use Lambda functions. Defines tenant isolation settings and resource allocations. Required for functions supporting multiple tenants.

" - }, - "CapacityProviderConfig":{ - "shape":"CapacityProviderConfig", - "documentation":"

Configuration for the capacity provider that manages compute resources for Lambda functions.

" - }, - "DurableConfig":{ - "shape":"DurableConfig", - "documentation":"

Configuration settings for durable functions. Enables creating functions with durability that can remember their state and continue execution even after interruptions.

" - } - } - }, - "CreateFunctionUrlConfigRequest":{ - "type":"structure", - "required":[ - "FunctionName", - "AuthType" - ], - "members":{ - "FunctionName":{ - "shape":"FunctionUrlFunctionName", - "documentation":"

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "location":"uri", - "locationName":"FunctionName" - }, - "Qualifier":{ - "shape":"FunctionUrlQualifier", - "documentation":"

The alias name.

", - "location":"querystring", - "locationName":"Qualifier" - }, - "AuthType":{ - "shape":"FunctionUrlAuthType", - "documentation":"

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Control access to Lambda function URLs.

" - }, - "Cors":{ - "shape":"Cors", - "documentation":"

The cross-origin resource sharing (CORS) settings for your function URL.

" - }, - "InvokeMode":{ - "shape":"InvokeMode", - "documentation":"

Use one of the following options:

  • BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.

  • RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 200 MB.

" - } - } - }, - "CreateFunctionUrlConfigResponse":{ - "type":"structure", - "required":[ - "FunctionUrl", - "FunctionArn", - "AuthType", - "CreationTime" - ], - "members":{ - "FunctionUrl":{ - "shape":"FunctionUrl", - "documentation":"

The HTTP URL endpoint for your function.

" - }, - "FunctionArn":{ - "shape":"FunctionArn", - "documentation":"

The Amazon Resource Name (ARN) of your function.

" - }, - "AuthType":{ - "shape":"FunctionUrlAuthType", - "documentation":"

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Control access to Lambda function URLs.

" - }, - "Cors":{ - "shape":"Cors", - "documentation":"

The cross-origin resource sharing (CORS) settings for your function URL.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

When the function URL was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" - }, - "InvokeMode":{ - "shape":"InvokeMode", - "documentation":"

Use one of the following options:

  • BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.

  • RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 200 MB.

" - } - } - }, - "DatabaseName":{ - "type":"string", - "max":63, - "min":1, - "pattern":"[^ /\\.$\\x22]*" - }, - "Date":{"type":"timestamp"}, - "DeadLetterConfig":{ - "type":"structure", - "members":{ - "TargetArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

" - } - }, - "documentation":"

The dead-letter queue for failed asynchronous invocations.

" - }, - "DeleteAliasRequest":{ - "type":"structure", - "required":[ - "FunctionName", - "Name" - ], - "members":{ - "FunctionName":{ - "shape":"FunctionName", - "documentation":"

The name or ARN of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "location":"uri", - "locationName":"FunctionName" - }, - "Name":{ - "shape":"Alias", - "documentation":"

The name of the alias.

", - "location":"uri", - "locationName":"Name" - } - } - }, - "DeleteCapacityProviderRequest":{ - "type":"structure", - "required":["CapacityProviderName"], - "members":{ - "CapacityProviderName":{ - "shape":"CapacityProviderName", - "documentation":"

The name of the capacity provider to delete.

", - "location":"uri", - "locationName":"CapacityProviderName" - } - } - }, - "DeleteCapacityProviderResponse":{ - "type":"structure", - "required":["CapacityProvider"], - "members":{ - "CapacityProvider":{ - "shape":"CapacityProvider", - "documentation":"

Information about the deleted capacity provider.

" - } - } - }, - "DeleteCodeSigningConfigRequest":{ - "type":"structure", - "required":["CodeSigningConfigArn"], - "members":{ - "CodeSigningConfigArn":{ - "shape":"CodeSigningConfigArn", - "documentation":"

The The Amazon Resource Name (ARN) of the code signing configuration.

", - "location":"uri", - "locationName":"CodeSigningConfigArn" - } - } - }, - "DeleteCodeSigningConfigResponse":{ - "type":"structure", - "members":{} - }, - "DeleteEventSourceMappingRequest":{ - "type":"structure", - "required":["UUID"], - "members":{ - "UUID":{ - "shape":"UUIDString", - "documentation":"

The identifier of the event source mapping.

", - "location":"uri", - "locationName":"UUID" - } - } - }, - "DeleteFunctionCodeSigningConfigRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "documentation":"

The name or ARN of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "location":"uri", - "locationName":"FunctionName" - } - } - }, - "DeleteFunctionConcurrencyRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"FunctionName", - "documentation":"

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "location":"uri", - "locationName":"FunctionName" - } - } - }, - "DeleteFunctionEventInvokeConfigRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "documentation":"

The name or ARN of the Lambda function, version, or alias.

Name formats

  • Function name - my-function (name-only), my-function:v1 (with alias).

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN - 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "location":"uri", - "locationName":"FunctionName" - }, - "Qualifier":{ - "shape":"NumericLatestPublishedOrAliasQualifier", - "documentation":"

A version number or alias name.

", - "location":"querystring", - "locationName":"Qualifier" - } - } - }, - "DeleteFunctionRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "documentation":"

The name or ARN of the Lambda function or version.

Name formats

  • Function name – my-function (name-only), my-function:1 (with version).

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "location":"uri", - "locationName":"FunctionName" - }, - "Qualifier":{ - "shape":"NumericLatestPublishedOrAliasQualifier", - "documentation":"

Specify a version to delete. You can't delete a version that an alias references.

", - "location":"querystring", - "locationName":"Qualifier" - } - } - }, - "DeleteFunctionResponse":{ - "type":"structure", - "members":{ - "StatusCode":{ - "shape":"Integer", - "documentation":"

The HTTP status code returned by the operation.

", - "location":"statusCode" - } - } - }, - "DeleteFunctionUrlConfigRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"FunctionUrlFunctionName", - "documentation":"

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "location":"uri", - "locationName":"FunctionName" - }, - "Qualifier":{ - "shape":"FunctionUrlQualifier", - "documentation":"

The alias name.

", - "location":"querystring", - "locationName":"Qualifier" - } - } - }, - "DeleteLayerVersionRequest":{ - "type":"structure", - "required":[ - "LayerName", - "VersionNumber" - ], - "members":{ - "LayerName":{ - "shape":"LayerName", - "documentation":"

The name or Amazon Resource Name (ARN) of the layer.

", - "location":"uri", - "locationName":"LayerName" - }, - "VersionNumber":{ - "shape":"LayerVersionNumber", - "documentation":"

The version number.

", - "location":"uri", - "locationName":"VersionNumber" - } - } - }, - "DeleteProvisionedConcurrencyConfigRequest":{ - "type":"structure", - "required":[ - "FunctionName", - "Qualifier" - ], - "members":{ - "FunctionName":{ - "shape":"FunctionName", - "documentation":"

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "location":"uri", - "locationName":"FunctionName" - }, - "Qualifier":{ - "shape":"Qualifier", - "documentation":"

The version number or alias name.

", - "location":"querystring", - "locationName":"Qualifier" - } - } - }, - "Description":{ - "type":"string", - "max":256, - "min":0 - }, - "DestinationArn":{ - "type":"string", - "max":350, - "min":0, - "pattern":"$|kafka://([^.]([a-zA-Z0-9\\-_.]{0,248}))|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-])+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.*)" - }, - "DestinationConfig":{ - "type":"structure", - "members":{ - "OnSuccess":{ - "shape":"OnSuccess", - "documentation":"

The destination configuration for successful invocations. Not supported in CreateEventSourceMapping or UpdateEventSourceMapping.

" - }, - "OnFailure":{ - "shape":"OnFailure", - "documentation":"

The destination configuration for failed invocations.

" - } - }, - "documentation":"

A configuration object that specifies the destination of an event after Lambda processes it. For more information, see Adding a destination.

" - }, - "DocumentDBEventSourceConfig":{ - "type":"structure", - "members":{ - "DatabaseName":{ - "shape":"DatabaseName", - "documentation":"

The name of the database to consume within the DocumentDB cluster.

" - }, - "CollectionName":{ - "shape":"CollectionName", - "documentation":"

The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections.

" - }, - "FullDocument":{ - "shape":"FullDocument", - "documentation":"

Determines what DocumentDB sends to your event stream during document update operations. If set to UpdateLookup, DocumentDB sends a delta describing the changes, along with a copy of the entire document. Otherwise, DocumentDB sends only a partial document that contains the changes.

" - } - }, - "documentation":"

Specific configuration settings for a DocumentDB event source.

" - }, - "DurableConfig":{ - "type":"structure", - "members":{ - "KMSKeyArn":{ - "shape":"KMSKeyArn", - "documentation":"

The ARN of the Key Management Service (KMS) customer managed key that is used to encrypt your durable execution's payload data, including input, output, and error payloads.

" - }, - "RetentionPeriodInDays":{ - "shape":"RetentionPeriodInDays", - "documentation":"

The number of days to retain execution history after a durable execution completes. After this period, execution history is no longer available through the GetDurableExecutionHistory API.

" - }, - "ExecutionTimeout":{ - "shape":"ExecutionTimeout", - "documentation":"

The maximum time (in seconds) that a durable execution can run before timing out. This timeout applies to the entire durable execution, not individual function invocations.

" - } - }, - "documentation":"

Configuration settings for durable functions, including execution timeout, retention period for execution history, and an optional ARN of the Key Management Service (KMS) customer managed key that is used to encrypt your durable execution's payload data, including input, output, and error payloads.

" - }, - "DurableExecutionAlreadyStartedException":{ - "type":"structure", - "members":{ - "Type":{ - "shape":"String", - "documentation":"

The exception type.

" - }, - "Message":{"shape":"String"} - }, - "documentation":"

The durable execution with the specified name has already been started. Each durable execution name must be unique within the function. Use a different name or check the status of the existing execution.

", - "error":{ - "httpStatusCode":409, - "senderFault":true - }, - "exception":true - }, - "DurableExecutionArn":{ - "type":"string", - "max":1024, - "min":1, - "pattern":"arn:([a-zA-Z0-9-]+):lambda:([a-zA-Z0-9-]+):(\\d{12}):function:([a-zA-Z0-9_-]+):(\\$LATEST(?:\\.PUBLISHED)?|[0-9]+)/durable-execution/([a-zA-Z0-9_-]+)/([a-zA-Z0-9_-]+)" - }, - "DurableExecutionName":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[a-zA-Z0-9-_]+" - }, - "DurableExecutions":{ - "type":"list", - "member":{"shape":"Execution"} - }, - "DurationSeconds":{ - "type":"integer", - "box":true, - "min":0 - }, - "EC2AccessDeniedException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "documentation":"

Need additional permissions to configure VPC settings.

", - "error":{"httpStatusCode":502}, - "exception":true, - "fault":true - }, - "EC2ThrottledException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "documentation":"

Amazon EC2 throttled Lambda during Lambda function initialization using the execution role provided for the function.

", - "error":{"httpStatusCode":502}, - "exception":true, - "fault":true - }, - "EC2UnexpectedException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"}, - "EC2ErrorCode":{"shape":"String"} - }, - "documentation":"

Lambda received an unexpected Amazon EC2 client exception while setting up for the Lambda function.

", - "error":{"httpStatusCode":502}, - "exception":true, - "fault":true - }, - "EFSIOException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "documentation":"

An error occurred when reading from or writing to a connected file system.

", - "error":{ - "httpStatusCode":410, - "senderFault":true - }, - "exception":true - }, - "EFSMountConnectivityException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "documentation":"

The Lambda function couldn't make a network connection to the configured file system.

", - "error":{ - "httpStatusCode":408, - "senderFault":true - }, - "exception":true - }, - "EFSMountFailureException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "documentation":"

The Lambda function couldn't mount the configured file system due to a permission or configuration issue.

", - "error":{ - "httpStatusCode":403, - "senderFault":true - }, - "exception":true - }, - "EFSMountTimeoutException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "documentation":"

The Lambda function made a network connection to the configured file system, but the mount operation timed out.

", - "error":{ - "httpStatusCode":408, - "senderFault":true - }, - "exception":true - }, - "ENILimitReachedException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "documentation":"

Lambda couldn't create an elastic network interface in the VPC, specified as part of Lambda function configuration, because the limit for network interfaces has been reached. For more information, see Lambda quotas.

", - "error":{"httpStatusCode":502}, - "exception":true, - "fault":true - }, - "ENINotReadyException":{ - "type":"structure", - "members":{ - "Type":{ - "shape":"String", - "documentation":"

The exception type.

" - }, - "Message":{ - "shape":"String", - "documentation":"

The exception message.

" - } - }, - "documentation":"

Lambda couldn't invoke the Lambda function because the elastic network interface (ENI) configured for its VPC connection isn't ready yet. Wait a few moments and try the request again. For more information about VPC configuration, see Configuring a Lambda function to access resources in a VPC.

", - "error":{"httpStatusCode":502}, - "exception":true, - "fault":true - }, - "Enabled":{ - "type":"boolean", - "box":true - }, - "EndPointType":{ - "type":"string", - "enum":["KAFKA_BOOTSTRAP_SERVERS"] - }, - "Endpoint":{ - "type":"string", - "max":300, - "min":1, - "pattern":"(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]):[0-9]{1,5}" - }, - "EndpointLists":{ - "type":"list", - "member":{"shape":"Endpoint"}, - "max":10, - "min":1 - }, - "Endpoints":{ - "type":"map", - "key":{"shape":"EndPointType"}, - "value":{"shape":"EndpointLists"}, - "max":2, - "min":1 - }, - "Environment":{ - "type":"structure", - "members":{ - "Variables":{ - "shape":"EnvironmentVariables", - "documentation":"

Environment variable key-value pairs. For more information, see Using Lambda environment variables.

" - } - }, - "documentation":"

A function's environment variable settings. You can use environment variables to adjust your function's behavior without updating code. An environment variable is a pair of strings that are stored in a function's version-specific configuration.

" - }, - "EnvironmentError":{ - "type":"structure", - "members":{ - "ErrorCode":{ - "shape":"String", - "documentation":"

The error code.

" - }, - "Message":{ - "shape":"SensitiveString", - "documentation":"

The error message.

" - } - }, - "documentation":"

Error messages for environment variables that couldn't be applied.

" - }, - "EnvironmentResponse":{ - "type":"structure", - "members":{ - "Variables":{ - "shape":"EnvironmentVariables", - "documentation":"

Environment variable key-value pairs. Omitted from CloudTrail logs.

" - }, - "Error":{ - "shape":"EnvironmentError", - "documentation":"

Error messages for environment variables that couldn't be applied.

" - } - }, - "documentation":"

The results of an operation to update or read environment variables. If the operation succeeds, the response contains the environment variables. If it fails, the response contains details about the error.

" - }, - "EnvironmentVariableName":{ - "type":"string", - "pattern":"[a-zA-Z]([a-zA-Z0-9_])+", - "sensitive":true - }, - "EnvironmentVariableValue":{ - "type":"string", - "sensitive":true - }, - "EnvironmentVariables":{ - "type":"map", - "key":{"shape":"EnvironmentVariableName"}, - "value":{"shape":"EnvironmentVariableValue"}, - "sensitive":true - }, - "EphemeralStorage":{ - "type":"structure", - "required":["Size"], - "members":{ - "Size":{ - "shape":"EphemeralStorageSize", - "documentation":"

The size of the function's /tmp directory.

" - } - }, - "documentation":"

The size of the function's /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).

" - }, - "EphemeralStorageSize":{ - "type":"integer", - "box":true, - "max":10240, - "min":512 - }, - "ErrorData":{ - "type":"string", - "sensitive":true - }, - "ErrorMessage":{ - "type":"string", - "sensitive":true - }, - "ErrorObject":{ - "type":"structure", - "members":{ - "ErrorMessage":{ - "shape":"ErrorMessage", - "documentation":"

A human-readable error message.

" - }, - "ErrorType":{ - "shape":"ErrorType", - "documentation":"

The error type.

" - }, - "ErrorData":{ - "shape":"ErrorData", - "documentation":"

Machine-readable error data.

" - }, - "StackTrace":{ - "shape":"StackTraceEntries", - "documentation":"

Stack trace information for the error.

" - } - }, - "documentation":"

An object that contains error information.

" - }, - "ErrorType":{ - "type":"string", - "sensitive":true - }, - "Event":{ - "type":"structure", - "members":{ - "EventType":{ - "shape":"EventType", - "documentation":"

The type of event that occurred.

" - }, - "SubType":{ - "shape":"OperationSubType", - "documentation":"

The subtype of the event, providing additional categorization.

" - }, - "EventId":{ - "shape":"EventId", - "documentation":"

The unique identifier for this event. Event IDs increment sequentially.

" - }, - "Id":{ - "shape":"OperationId", - "documentation":"

The unique identifier for this operation.

" - }, - "Name":{ - "shape":"OperationName", - "documentation":"

The customer-provided name for this operation.

" - }, - "EventTimestamp":{ - "shape":"ExecutionTimestamp", - "documentation":"

The date and time when this event occurred, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" - }, - "ParentId":{ - "shape":"OperationId", - "documentation":"

The unique identifier of the parent operation, if this operation is running within a child context.

" - }, - "ExecutionStartedDetails":{ - "shape":"ExecutionStartedDetails", - "documentation":"

Details about an execution that started.

" - }, - "ExecutionSucceededDetails":{ - "shape":"ExecutionSucceededDetails", - "documentation":"

Details about an execution that succeeded.

" - }, - "ExecutionFailedDetails":{ - "shape":"ExecutionFailedDetails", - "documentation":"

Details about an execution that failed.

" - }, - "ExecutionTimedOutDetails":{ - "shape":"ExecutionTimedOutDetails", - "documentation":"

Details about an execution that timed out.

" - }, - "ExecutionStoppedDetails":{ - "shape":"ExecutionStoppedDetails", - "documentation":"

Details about an execution that was stopped.

" - }, - "ContextStartedDetails":{ - "shape":"ContextStartedDetails", - "documentation":"

Details about a context that started.

" - }, - "ContextSucceededDetails":{ - "shape":"ContextSucceededDetails", - "documentation":"

Details about a context that succeeded.

" - }, - "ContextFailedDetails":{ - "shape":"ContextFailedDetails", - "documentation":"

Details about a context that failed.

" - }, - "WaitStartedDetails":{ - "shape":"WaitStartedDetails", - "documentation":"

Details about a wait operation that started.

" - }, - "WaitSucceededDetails":{ - "shape":"WaitSucceededDetails", - "documentation":"

Details about a wait operation that succeeded.

" - }, - "WaitCancelledDetails":{ - "shape":"WaitCancelledDetails", - "documentation":"

Details about a wait operation that was cancelled.

" - }, - "StepStartedDetails":{ - "shape":"StepStartedDetails", - "documentation":"

Details about a step that started.

" - }, - "StepSucceededDetails":{ - "shape":"StepSucceededDetails", - "documentation":"

Details about a step that succeeded.

" - }, - "StepFailedDetails":{ - "shape":"StepFailedDetails", - "documentation":"

Details about a step that failed.

" - }, - "ChainedInvokeStartedDetails":{"shape":"ChainedInvokeStartedDetails"}, - "ChainedInvokeSucceededDetails":{ - "shape":"ChainedInvokeSucceededDetails", - "documentation":"

Details about a chained invocation that succeeded.

" - }, - "ChainedInvokeFailedDetails":{"shape":"ChainedInvokeFailedDetails"}, - "ChainedInvokeTimedOutDetails":{ - "shape":"ChainedInvokeTimedOutDetails", - "documentation":"

Details about a chained invocation that timed out.

" - }, - "ChainedInvokeStoppedDetails":{ - "shape":"ChainedInvokeStoppedDetails", - "documentation":"

Details about a chained invocation that was stopped.

" - }, - "CallbackStartedDetails":{"shape":"CallbackStartedDetails"}, - "CallbackSucceededDetails":{"shape":"CallbackSucceededDetails"}, - "CallbackFailedDetails":{"shape":"CallbackFailedDetails"}, - "CallbackTimedOutDetails":{"shape":"CallbackTimedOutDetails"}, - "InvocationCompletedDetails":{ - "shape":"InvocationCompletedDetails", - "documentation":"

Details about a function invocation that completed.

" - } - }, - "documentation":"

An event that occurred during the execution of a durable function.

" - }, - "EventError":{ - "type":"structure", - "members":{ - "Payload":{ - "shape":"ErrorObject", - "documentation":"

The error payload.

" - }, - "Truncated":{ - "shape":"Truncated", - "documentation":"

Indicates if the error payload was truncated due to size limits.

" - } - }, - "documentation":"

Error information for an event.

" - }, - "EventId":{ - "type":"integer", - "box":true, - "min":1 - }, - "EventInput":{ - "type":"structure", - "members":{ - "Payload":{ - "shape":"InputPayload", - "documentation":"

The input payload.

" - }, - "Truncated":{ - "shape":"Truncated", - "documentation":"

Indicates if the error payload was truncated due to size limits.

" - } - }, - "documentation":"

Input information for an event.

" - }, - "EventResult":{ - "type":"structure", - "members":{ - "Payload":{ - "shape":"OperationPayload", - "documentation":"

The result payload.

" - }, - "Truncated":{ - "shape":"Truncated", - "documentation":"

Indicates if the error payload was truncated due to size limits.

" - } - }, - "documentation":"

Result information for an event.

" - }, - "EventSourceMappingArn":{ - "type":"string", - "max":120, - "min":85, - "pattern":"arn:(aws[a-zA-Z-]*)?:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:event-source-mapping:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}" - }, - "EventSourceMappingConfiguration":{ - "type":"structure", - "members":{ - "UUID":{ - "shape":"UUIDString", - "documentation":"

The identifier of the event source mapping.

" - }, - "StartingPosition":{ - "shape":"EventSourcePosition", - "documentation":"

The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Stream event sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams, Amazon DocumentDB, Amazon MSK, and self-managed Apache Kafka.

" - }, - "StartingPositionTimestamp":{ - "shape":"Date", - "documentation":"

With StartingPosition set to AT_TIMESTAMP, the time from which to start reading. StartingPositionTimestamp cannot be in the future.

" - }, - "BatchSize":{ - "shape":"BatchSize", - "documentation":"

The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).

Default value: Varies by service. For Amazon SQS, the default is 10. For all other services, the default is 100.

Related setting: When you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

" - }, - "MaximumBatchingWindowInSeconds":{ - "shape":"MaximumBatchingWindowInSeconds", - "documentation":"

The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.

For streams and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it. To restore the default batching window, you must create a new event source mapping.

Related setting: For streams and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

" - }, - "ParallelizationFactor":{ - "shape":"ParallelizationFactor", - "documentation":"

(Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.

" - }, - "EventSourceArn":{ - "shape":"Arn", - "documentation":"

The Amazon Resource Name (ARN) of the event source.

" - }, - "FilterCriteria":{ - "shape":"FilterCriteria", - "documentation":"

An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.

If filter criteria is encrypted, this field shows up as null in the response of ListEventSourceMapping API calls. You can view this field in plaintext in the response of GetEventSourceMapping and DeleteEventSourceMapping calls if you have kms:Decrypt permissions for the correct KMS key.

" - }, - "FilterCriteriaError":{ - "shape":"FilterCriteriaError", - "documentation":"

An object that contains details about an error related to filter criteria encryption.

" - }, - "KMSKeyArn":{ - "shape":"KMSKeyArn", - "documentation":"

The ARN of the Key Management Service (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria.

" - }, - "MetricsConfig":{ - "shape":"EventSourceMappingMetricsConfig", - "documentation":"

The metrics configuration for your event source. For more information, see Event source mapping metrics.

" - }, - "LoggingConfig":{ - "shape":"EventSourceMappingLoggingConfig", - "documentation":"

(Amazon MSK, and self-managed Apache Kafka only) The logging configuration for your event source. For more information, see Event source mapping logging.

" - }, - "ScalingConfig":{ - "shape":"ScalingConfig", - "documentation":"

(Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.

" - }, - "FunctionArn":{ - "shape":"FunctionArn", - "documentation":"

The ARN of the Lambda function.

" - }, - "LastModified":{ - "shape":"Date", - "documentation":"

The date that the event source mapping was last updated or that its state changed.

" - }, - "LastProcessingResult":{ - "shape":"String", - "documentation":"

The result of the event source mapping's last processing attempt.

" - }, - "State":{ - "shape":"String", - "documentation":"

The state of the event source mapping. It can be one of the following: Creating, Enabling, Enabled, Disabling, Disabled, Updating, or Deleting.

" - }, - "StateTransitionReason":{ - "shape":"String", - "documentation":"

Indicates whether a user or Lambda made the last change to the event source mapping.

" - }, - "DestinationConfig":{ - "shape":"DestinationConfig", - "documentation":"

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) A configuration object that specifies the destination of an event after Lambda processes it.

" - }, - "Topics":{ - "shape":"Topics", - "documentation":"

The name of the Kafka topic.

" - }, - "Queues":{ - "shape":"Queues", - "documentation":"

(Amazon MQ) The name of the Amazon MQ broker destination queue to consume.

" - }, - "SourceAccessConfigurations":{ - "shape":"SourceAccessConfigurations", - "documentation":"

An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.

" - }, - "SelfManagedEventSource":{ - "shape":"SelfManagedEventSource", - "documentation":"

The self-managed Apache Kafka cluster for your event source.

" - }, - "MaximumRecordAgeInSeconds":{ - "shape":"MaximumRecordAgeInSeconds", - "documentation":"

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.

The minimum valid value for maximum record age is 60s. Although values less than 60 and greater than -1 fall within the parameter's absolute range, they are not allowed

" - }, - "BisectBatchOnFunctionError":{ - "shape":"BisectBatchOnFunctionError", - "documentation":"

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) If the function returns an error, split the batch in two and retry. The default value is false.

" - }, - "MaximumRetryAttempts":{ - "shape":"MaximumRetryAttemptsEventSourceMapping", - "documentation":"

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.

" - }, - "TumblingWindowInSeconds":{ - "shape":"TumblingWindowInSeconds", - "documentation":"

(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.

" - }, - "FunctionResponseTypes":{ - "shape":"FunctionResponseTypeList", - "documentation":"

(Kinesis, DynamoDB Streams, Amazon MSK, self-managed Apache Kafka, and Amazon SQS) A list of current response type enums applied to the event source mapping.

" - }, - "AmazonManagedKafkaEventSourceConfig":{ - "shape":"AmazonManagedKafkaEventSourceConfig", - "documentation":"

Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.

" - }, - "SelfManagedKafkaEventSourceConfig":{ - "shape":"SelfManagedKafkaEventSourceConfig", - "documentation":"

Specific configuration settings for a self-managed Apache Kafka event source.

" - }, - "DocumentDBEventSourceConfig":{ - "shape":"DocumentDBEventSourceConfig", - "documentation":"

Specific configuration settings for a DocumentDB event source.

" - }, - "EventSourceMappingArn":{ - "shape":"EventSourceMappingArn", - "documentation":"

The Amazon Resource Name (ARN) of the event source mapping.

" - }, - "ProvisionedPollerConfig":{ - "shape":"ProvisionedPollerConfig", - "documentation":"

(Amazon SQS, Amazon MSK, and self-managed Apache Kafka only) The provisioned mode configuration for the event source. For more information, see provisioned mode.

" - } - }, - "documentation":"

A mapping between an Amazon Web Services resource and a Lambda function. For details, see CreateEventSourceMapping.

" - }, - "EventSourceMappingLoggingConfig":{ - "type":"structure", - "members":{ - "SystemLogLevel":{ - "shape":"EventSourceMappingSystemLogLevel", - "documentation":"

The log level you want your event source mapping to use. Lambda event poller only sends system logs at the selected level of detail and lower, where DEBUG is the highest level and WARN is the lowest. For more information about these metrics, see Event source mapping logging.

" - } - }, - "documentation":"

(Amazon MSK, and self-managed Apache Kafka only) The logging configuration for your event source. Use this configuration object to define the level of logs for your event source mapping.

" - }, - "EventSourceMappingMetric":{ - "type":"string", - "enum":[ - "EventCount", - "ErrorCount", - "KafkaMetrics" - ] - }, - "EventSourceMappingMetricList":{ - "type":"list", - "member":{"shape":"EventSourceMappingMetric"}, - "max":3, - "min":0 - }, - "EventSourceMappingMetricsConfig":{ - "type":"structure", - "members":{ - "Metrics":{ - "shape":"EventSourceMappingMetricList", - "documentation":"

The metrics you want your event source mapping to produce, including EventCount, ErrorCount, KafkaMetrics.

  • EventCount to receive metrics related to the number of events processed by your event source mapping.

  • ErrorCount (Amazon MSK and self-managed Apache Kafka) to receive metrics related to the number of errors in your event source mapping processing.

  • KafkaMetrics (Amazon MSK and self-managed Apache Kafka) to receive metrics related to the Kafka consumers from your event source mapping.

For more information about these metrics, see Event source mapping metrics.

" - } - }, - "documentation":"

The metrics configuration for your event source. Use this configuration object to define which metrics you want your event source mapping to produce.

" - }, - "EventSourceMappingSystemLogLevel":{ - "type":"string", - "enum":[ - "DEBUG", - "INFO", - "WARN" - ] - }, - "EventSourceMappingsList":{ - "type":"list", - "member":{"shape":"EventSourceMappingConfiguration"} - }, - "EventSourcePosition":{ - "type":"string", - "enum":[ - "TRIM_HORIZON", - "LATEST", - "AT_TIMESTAMP" - ] - }, - "EventSourceToken":{ - "type":"string", - "max":256, - "min":0, - "pattern":"[a-zA-Z0-9._\\-]+" - }, - "EventType":{ - "type":"string", - "enum":[ - "ExecutionStarted", - "ExecutionSucceeded", - "ExecutionFailed", - "ExecutionTimedOut", - "ExecutionStopped", - "ContextStarted", - "ContextSucceeded", - "ContextFailed", - "WaitStarted", - "WaitSucceeded", - "WaitCancelled", - "StepStarted", - "StepSucceeded", - "StepFailed", - "ChainedInvokeStarted", - "ChainedInvokeSucceeded", - "ChainedInvokeFailed", - "ChainedInvokeTimedOut", - "ChainedInvokeStopped", - "CallbackStarted", - "CallbackSucceeded", - "CallbackFailed", - "CallbackTimedOut", - "InvocationCompleted" - ] - }, - "Events":{ - "type":"list", - "member":{"shape":"Event"} - }, - "Execution":{ - "type":"structure", - "required":[ - "DurableExecutionArn", - "DurableExecutionName", - "FunctionArn", - "Status", - "StartTimestamp" - ], - "members":{ - "DurableExecutionArn":{ - "shape":"DurableExecutionArn", - "documentation":"

The Amazon Resource Name (ARN) of the durable execution, if this execution is a durable execution.

" - }, - "DurableExecutionName":{ - "shape":"DurableExecutionName", - "documentation":"

The unique name of the durable execution, if one was provided when the execution was started.

" - }, - "FunctionArn":{ - "shape":"NameSpacedFunctionArn", - "documentation":"

The Amazon Resource Name (ARN) of the Lambda function.

" - }, - "Status":{ - "shape":"ExecutionStatus", - "documentation":"

The current status of the durable execution.

" - }, - "StartTimestamp":{ - "shape":"ExecutionTimestamp", - "documentation":"

The date and time when the durable execution started, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" - }, - "EndTimestamp":{ - "shape":"ExecutionTimestamp", - "documentation":"

The date and time when the durable execution ended, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" - }, - "KMSKeyArn":{ - "shape":"KMSKeyArn", - "documentation":"

The ARN of the Key Management Service (KMS) customer managed key that is used to encrypt your durable execution's payload data, including input, output, and error payloads.

" - } - }, - "documentation":"

Information about a durable execution.

" - }, - "ExecutionDataIncluded":{ - "type":"boolean", - "box":true - }, - "ExecutionDetails":{ - "type":"structure", - "members":{ - "InputPayload":{ - "shape":"InputPayload", - "documentation":"

The original input payload provided for the durable execution.

" - } - }, - "documentation":"

Details about a durable execution.

" - }, - "ExecutionEnvironmentMemoryGiBPerVCpu":{ - "type":"double", - "box":true, - "max":8, - "min":2 - }, - "ExecutionFailedDetails":{ - "type":"structure", - "required":["Error"], - "members":{ - "Error":{ - "shape":"EventError", - "documentation":"

Details about the execution failure.

" - } - }, - "documentation":"

Details about a failed durable execution.

" - }, - "ExecutionStartedDetails":{ - "type":"structure", - "required":[ - "Input", - "ExecutionTimeout" - ], - "members":{ - "Input":{ - "shape":"EventInput", - "documentation":"

The input payload provided for the durable execution.

" - }, - "ExecutionTimeout":{ - "shape":"DurationSeconds", - "documentation":"

The maximum amount of time that the durable execution is allowed to run, in seconds.

" - } - }, - "documentation":"

Details about a durable execution that started.

" - }, - "ExecutionStatus":{ - "type":"string", - "enum":[ - "RUNNING", - "SUCCEEDED", - "FAILED", - "TIMED_OUT", - "STOPPED" - ] - }, - "ExecutionStatusList":{ - "type":"list", - "member":{"shape":"ExecutionStatus"}, - "max":10, - "min":1 - }, - "ExecutionStoppedDetails":{ - "type":"structure", - "required":["Error"], - "members":{ - "Error":{ - "shape":"EventError", - "documentation":"

Details about why the execution stopped.

" - } - }, - "documentation":"

Details about a durable execution that stopped.

" - }, - "ExecutionSucceededDetails":{ - "type":"structure", - "required":["Result"], - "members":{ - "Result":{ - "shape":"EventResult", - "documentation":"

The response payload from the successful operation.

" - } - }, - "documentation":"

Details about a durable execution that succeeded.

" - }, - "ExecutionTimedOutDetails":{ - "type":"structure", - "members":{ - "Error":{ - "shape":"EventError", - "documentation":"

Details about the execution timeout.

" - } - }, - "documentation":"

Details about a durable execution that timed out.

" - }, - "ExecutionTimeout":{ - "type":"integer", - "box":true, - "max":31622400, - "min":1 - }, - "ExecutionTimestamp":{"type":"timestamp"}, - "FileSystemArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[a-zA-Z-]*:elasticfilesystem:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:access-point/fsap-[a-f0-9]{17}$|^arn:aws[-a-z]*:s3files:[0-9a-z-:]+:file-system/fs-[0-9a-f]{17,40}/access-point/fsap-[0-9a-f]{17,40}" - }, - "FileSystemConfig":{ - "type":"structure", - "required":[ - "Arn", - "LocalMountPath" - ], - "members":{ - "Arn":{ - "shape":"FileSystemArn", - "documentation":"

The Amazon Resource Name (ARN) of the Amazon EFS or Amazon S3 Files access point that provides access to the file system.

" - }, - "LocalMountPath":{ - "shape":"LocalMountPath", - "documentation":"

The path where the function can access the file system, starting with /mnt/.

" - } - }, - "documentation":"

Details about the connection between a Lambda function and an Amazon EFS file system or an Amazon S3 Files file system.

" - }, - "FileSystemConfigList":{ - "type":"list", - "member":{"shape":"FileSystemConfig"}, - "max":1, - "min":0 - }, - "Filter":{ - "type":"structure", - "members":{ - "Pattern":{ - "shape":"Pattern", - "documentation":"

A filter pattern. For more information on the syntax of a filter pattern, see Filter rule syntax.

" - } - }, - "documentation":"

A structure within a FilterCriteria object that defines an event filtering pattern.

" - }, - "FilterCriteria":{ - "type":"structure", - "members":{ - "Filters":{ - "shape":"FilterList", - "documentation":"

A list of filters.

" - } - }, - "documentation":"

An object that contains the filters for an event source.

" - }, - "FilterCriteriaError":{ - "type":"structure", - "members":{ - "ErrorCode":{ - "shape":"FilterCriteriaErrorCode", - "documentation":"

The KMS exception that resulted from filter criteria encryption or decryption.

" - }, - "Message":{ - "shape":"FilterCriteriaErrorMessage", - "documentation":"

The error message.

" - } - }, - "documentation":"

An object that contains details about an error related to filter criteria encryption.

" - }, - "FilterCriteriaErrorCode":{ - "type":"string", - "max":50, - "min":10, - "pattern":"[A-Za-z]+Exception" - }, - "FilterCriteriaErrorMessage":{ - "type":"string", - "max":2048, - "min":10, - "pattern":".*" - }, - "FilterList":{ - "type":"list", - "member":{"shape":"Filter"} - }, - "FullDocument":{ - "type":"string", - "enum":[ - "UpdateLookup", - "Default" - ] - }, - "FunctionArn":{ - "type":"string", - "max":10000, - "min":0, - "pattern":"arn:(aws[a-zA-Z-]*)?:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?" - }, - "FunctionArnList":{ - "type":"list", - "member":{"shape":"FunctionArn"} - }, - "FunctionCode":{ - "type":"structure", - "members":{ - "ZipFile":{ - "shape":"Blob", - "documentation":"

The base64-encoded contents of the deployment package. Amazon Web Services SDK and CLI clients handle the encoding for you.

" - }, - "S3Bucket":{ - "shape":"S3Bucket", - "documentation":"

An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a different Amazon Web Services account.

" - }, - "S3Key":{ - "shape":"S3Key", - "documentation":"

The Amazon S3 key of the deployment package.

" - }, - "S3ObjectVersion":{ - "shape":"S3ObjectVersion", - "documentation":"

For versioned objects, the version of the deployment package object to use.

" - }, - "S3ObjectStorageMode":{ - "shape":"S3ObjectStorageMode", - "documentation":"

Specifies how the deployment package is stored. Valid values:

  • COPY (default) – Uploads a copy of your deployment package to Lambda.

  • REFERENCE – Lambda references the deployment package from the specified Amazon S3 bucket.

" - }, - "ImageUri":{ - "shape":"String", - "documentation":"

URI of a container image in the Amazon ECR registry.

" - }, - "SourceKMSKeyArn":{ - "shape":"KMSKeyArn", - "documentation":"

The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt your function's .zip deployment package. If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key.

" - } - }, - "documentation":"

The code for the Lambda function. You can either specify an object in Amazon S3, upload a .zip file archive deployment package directly, or specify the URI of a container image.

" - }, - "FunctionCodeLocation":{ - "type":"structure", - "members":{ - "RepositoryType":{ - "shape":"String", - "documentation":"

The service that's hosting the file.

" - }, - "Location":{ - "shape":"SensitiveStringOnServerOnly", - "documentation":"

A presigned URL that you can use to download the deployment package.

" - }, - "ImageUri":{ - "shape":"String", - "documentation":"

URI of a container image in the Amazon ECR registry.

" - }, - "ResolvedImageUri":{ - "shape":"String", - "documentation":"

The resolved URI for the image.

" - }, - "ResolvedS3Object":{ - "shape":"ResolvedS3Object", - "documentation":"

The resolved Amazon S3 object that contains the deployment package.

" - }, - "SourceKMSKeyArn":{ - "shape":"KMSKeyArn", - "documentation":"

The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt your function's .zip deployment package. If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key.

" - }, - "Error":{ - "shape":"FunctionCodeLocationError", - "documentation":"

An object that contains details about an error related to function deployment package retrieval.

" - } - }, - "documentation":"

Details about a function's deployment package.

" - }, - "FunctionCodeLocationError":{ - "type":"structure", - "members":{ - "ErrorCode":{ - "shape":"String", - "documentation":"

The error code that identifies why Lambda failed to retrieve the deployment package.

" - }, - "Message":{ - "shape":"SensitiveString", - "documentation":"

The human-readable message that describes why Lambda failed to retrieve the deployment package.

" - } - }, - "documentation":"

Contains details about an error that occurred when Lambda attempted to retrieve a function's deployment package.

" - }, - "FunctionConfiguration":{ - "type":"structure", - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "documentation":"

The name of the function.

" - }, - "FunctionArn":{ - "shape":"NameSpacedFunctionArn", - "documentation":"

The function's Amazon Resource Name (ARN).

" - }, - "Runtime":{ - "shape":"Runtime", - "documentation":"

The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image.

The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see Runtime use after deprecation.

For a list of all currently supported runtimes, see Supported runtimes.

" - }, - "Role":{ - "shape":"RoleArn", - "documentation":"

The function's execution role.

" - }, - "Handler":{ - "shape":"Handler", - "documentation":"

The function that Lambda calls to begin running your function.

" - }, - "CodeSize":{ - "shape":"Long", - "documentation":"

The size of the function's deployment package, in bytes.

" - }, - "Description":{ - "shape":"Description", - "documentation":"

The function's description.

" - }, - "Timeout":{ - "shape":"Timeout", - "documentation":"

The amount of time in seconds that Lambda allows a function to run before stopping it.

" - }, - "MemorySize":{ - "shape":"MemorySize", - "documentation":"

The amount of memory available to the function at runtime.

" - }, - "LastModified":{ - "shape":"Timestamp", - "documentation":"

The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" - }, - "CodeSha256":{ - "shape":"String", - "documentation":"

The SHA256 hash of the function's deployment package.

" - }, - "Version":{ - "shape":"Version", - "documentation":"

The version of the Lambda function.

" - }, - "VpcConfig":{ - "shape":"VpcConfigResponse", - "documentation":"

The function's networking configuration.

" - }, - "DeadLetterConfig":{ - "shape":"DeadLetterConfig", - "documentation":"

The function's dead letter queue.

" - }, - "Environment":{ - "shape":"EnvironmentResponse", - "documentation":"

The function's environment variables. Omitted from CloudTrail logs.

" - }, - "KMSKeyArn":{ - "shape":"KMSKeyArn", - "documentation":"

The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt the following resources:

  • The function's environment variables.

  • The function's Lambda SnapStart snapshots.

  • When used with SourceKMSKeyArn, the unzipped version of the .zip deployment package that's used for function invocations. For more information, see Specifying a customer managed key for Lambda.

  • The optimized version of the container image that's used for function invocations. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). For more information, see Function lifecycle.

If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key or an Amazon Web Services managed key.

" - }, - "TracingConfig":{ - "shape":"TracingConfigResponse", - "documentation":"

The function's X-Ray tracing configuration.

" - }, - "MasterArn":{ - "shape":"FunctionArn", - "documentation":"

For Lambda@Edge functions, the ARN of the main function.

" - }, - "RevisionId":{ - "shape":"String", - "documentation":"

The latest updated revision of the function or alias.

" - }, - "Layers":{ - "shape":"LayersReferenceList", - "documentation":"

The function's layers.

" - }, - "State":{ - "shape":"State", - "documentation":"

The current state of the function. When the state is Inactive, you can reactivate the function by invoking it.

" - }, - "StateReason":{ - "shape":"StateReason", - "documentation":"

The reason for the function's current state.

" - }, - "StateReasonCode":{ - "shape":"StateReasonCode", - "documentation":"

The reason code for the function's current state. When the code is Creating, you can't invoke or modify the function.

" - }, - "LastUpdateStatus":{ - "shape":"LastUpdateStatus", - "documentation":"

The status of the last update that was performed on the function. This is first set to Successful after function creation completes.

" - }, - "LastUpdateStatusReason":{ - "shape":"LastUpdateStatusReason", - "documentation":"

The reason for the last update that was performed on the function.

" - }, - "LastUpdateStatusReasonCode":{ - "shape":"LastUpdateStatusReasonCode", - "documentation":"

The reason code for the last update that was performed on the function.

" - }, - "FileSystemConfigs":{ - "shape":"FileSystemConfigList", - "documentation":"

Connection settings for an Amazon EFS file system or an Amazon S3 Files file system.

" - }, - "SigningProfileVersionArn":{ - "shape":"Arn", - "documentation":"

The ARN of the signing profile version.

" - }, - "SigningJobArn":{ - "shape":"Arn", - "documentation":"

The ARN of the signing job.

" - }, - "PackageType":{ - "shape":"PackageType", - "documentation":"

The type of deployment package. Set to Image for container image and set Zip for .zip file archive.

" - }, - "ImageConfigResponse":{ - "shape":"ImageConfigResponse", - "documentation":"

The function's image configuration values.

" - }, - "Architectures":{ - "shape":"ArchitecturesList", - "documentation":"

The instruction set architecture that the function supports. Architecture is a string array with one of the valid values. The default architecture value is x86_64.

" - }, - "EphemeralStorage":{ - "shape":"EphemeralStorage", - "documentation":"

The size of the function's /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).

" - }, - "SnapStart":{ - "shape":"SnapStartResponse", - "documentation":"

Set ApplyOn to PublishedVersions to create a snapshot of the initialized execution environment when you publish a function version. For more information, see Improving startup performance with Lambda SnapStart.

" - }, - "RuntimeVersionConfig":{ - "shape":"RuntimeVersionConfig", - "documentation":"

The ARN of the runtime and any errors that occured.

" - }, - "LoggingConfig":{ - "shape":"LoggingConfig", - "documentation":"

The function's Amazon CloudWatch Logs configuration settings.

" - }, - "TenancyConfig":{ - "shape":"TenancyConfig", - "documentation":"

The function's tenant isolation configuration settings. Determines whether the Lambda function runs on a shared or dedicated infrastructure per unique tenant.

" - }, - "CapacityProviderConfig":{ - "shape":"CapacityProviderConfig", - "documentation":"

Configuration for the capacity provider that manages compute resources for Lambda functions.

" - }, - "ConfigSha256":{ - "shape":"String", - "documentation":"

The SHA256 hash of the function configuration.

" - }, - "DurableConfig":{ - "shape":"DurableConfig", - "documentation":"

The function's durable execution configuration settings, if the function is configured for durability.

" - } - }, - "documentation":"

Details about a function's configuration.

" - }, - "FunctionEventInvokeConfig":{ - "type":"structure", - "members":{ - "LastModified":{ - "shape":"Date", - "documentation":"

The date and time that the configuration was last updated.

" - }, - "FunctionArn":{ - "shape":"FunctionArn", - "documentation":"

The Amazon Resource Name (ARN) of the function.

" - }, - "MaximumRetryAttempts":{ - "shape":"MaximumRetryAttempts", - "documentation":"

The maximum number of times to retry when the function returns an error.

" - }, - "MaximumEventAgeInSeconds":{ - "shape":"MaximumEventAgeInSeconds", - "documentation":"

The maximum age of a request that Lambda sends to a function for processing.

" - }, - "DestinationConfig":{ - "shape":"DestinationConfig", - "documentation":"

A destination for events after they have been sent to a function for processing.

Destinations

  • Function - The Amazon Resource Name (ARN) of a Lambda function.

  • Queue - The ARN of a standard SQS queue.

  • Bucket - The ARN of an Amazon S3 bucket.

  • Topic - The ARN of a standard SNS topic.

  • Event Bus - The ARN of an Amazon EventBridge event bus.

S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type.

" - } - } - }, - "FunctionEventInvokeConfigList":{ - "type":"list", - "member":{"shape":"FunctionEventInvokeConfig"} - }, - "FunctionList":{ - "type":"list", - "member":{"shape":"FunctionConfiguration"} - }, - "FunctionName":{ - "type":"string", - "max":140, - "min":1, - "pattern":"(arn:(aws[a-zA-Z-]*)?:lambda:)?((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?" - }, - "FunctionResponseType":{ - "type":"string", - "enum":["ReportBatchItemFailures"] - }, - "FunctionResponseTypeList":{ - "type":"list", - "member":{"shape":"FunctionResponseType"}, - "max":1, - "min":0 - }, - "FunctionScalingConfig":{ - "type":"structure", - "members":{ - "MinExecutionEnvironments":{ - "shape":"FunctionScalingConfigExecutionEnvironments", - "documentation":"

The minimum number of execution environments to maintain for the function.

" - }, - "MaxExecutionEnvironments":{ - "shape":"FunctionScalingConfigExecutionEnvironments", - "documentation":"

The maximum number of execution environments that can be provisioned for the function.

" - } - }, - "documentation":"

Configuration that defines the scaling behavior for a Lambda Managed Instances function, including the minimum and maximum number of execution environments that can be provisioned.

" - }, - "FunctionScalingConfigExecutionEnvironments":{ - "type":"integer", - "box":true, - "max":15000, - "min":0 - }, - "FunctionUrl":{ - "type":"string", - "max":100, - "min":40 - }, - "FunctionUrlAuthType":{ - "type":"string", - "enum":[ - "NONE", - "AWS_IAM" - ] - }, - "FunctionUrlConfig":{ - "type":"structure", - "required":[ - "FunctionUrl", - "FunctionArn", - "CreationTime", - "LastModifiedTime", - "AuthType" - ], - "members":{ - "FunctionUrl":{ - "shape":"FunctionUrl", - "documentation":"

The HTTP URL endpoint for your function.

" - }, - "FunctionArn":{ - "shape":"FunctionArn", - "documentation":"

The Amazon Resource Name (ARN) of your function.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

When the function URL was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

When the function URL configuration was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" - }, - "Cors":{ - "shape":"Cors", - "documentation":"

The cross-origin resource sharing (CORS) settings for your function URL.

" - }, - "AuthType":{ - "shape":"FunctionUrlAuthType", - "documentation":"

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Security and auth model for Lambda function URLs.

" - }, - "InvokeMode":{ - "shape":"InvokeMode", - "documentation":"

Use one of the following options:

  • BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.

  • RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 200 MB.

" - } - }, - "documentation":"

Details about a Lambda function URL.

" - }, - "FunctionUrlConfigList":{ - "type":"list", - "member":{"shape":"FunctionUrlConfig"} - }, - "FunctionUrlFunctionName":{ - "type":"string", - "max":140, - "min":1, - "pattern":"(arn:(aws[a-zA-Z-]*)?:lambda:)?((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]{1,64})(:((?!\\d+$)[0-9a-zA-Z-_]+))?" - }, - "FunctionUrlQualifier":{ - "type":"string", - "max":128, - "min":1, - "pattern":"((?!^\\d+$)^[0-9a-zA-Z-_]+$)" - }, - "FunctionVersion":{ - "type":"string", - "enum":["ALL"] - }, - "FunctionVersionLatestPublished":{ - "type":"string", - "enum":["LATEST_PUBLISHED"] - }, - "FunctionVersionsByCapacityProviderList":{ - "type":"list", - "member":{"shape":"FunctionVersionsByCapacityProviderListItem"}, - "max":50, - "min":0 - }, - "FunctionVersionsByCapacityProviderListItem":{ - "type":"structure", - "required":[ - "FunctionArn", - "State" - ], - "members":{ - "FunctionArn":{ - "shape":"NameSpacedFunctionArn", - "documentation":"

The Amazon Resource Name (ARN) of the function version.

" - }, - "State":{ - "shape":"State", - "documentation":"

The current state of the function version.

" - } - }, - "documentation":"

Information about a function version that uses a specific capacity provider, including its ARN and current state.

" - }, - "FunctionVersionsPerCapacityProviderLimitExceededException":{ - "type":"structure", - "members":{ - "Type":{ - "shape":"String", - "documentation":"

The exception type.

" - }, - "message":{"shape":"String"} - }, - "documentation":"

The maximum number of function versions that can be associated with a single capacity provider has been exceeded. For more information, see Lambda quotas.

", - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "GetAccountSettingsRequest":{ - "type":"structure", - "members":{} - }, - "GetAccountSettingsResponse":{ - "type":"structure", - "members":{ - "AccountLimit":{ - "shape":"AccountLimit", - "documentation":"

Limits that are related to concurrency and code storage.

" - }, - "AccountUsage":{ - "shape":"AccountUsage", - "documentation":"

The number of functions and amount of storage in use.

" - } - } - }, - "GetAliasRequest":{ - "type":"structure", - "required":[ - "FunctionName", - "Name" - ], - "members":{ - "FunctionName":{ - "shape":"FunctionName", - "documentation":"

The name or ARN of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "location":"uri", - "locationName":"FunctionName" - }, - "Name":{ - "shape":"Alias", - "documentation":"

The name of the alias.

", - "location":"uri", - "locationName":"Name" - } - } - }, - "GetCapacityProviderRequest":{ - "type":"structure", - "required":["CapacityProviderName"], - "members":{ - "CapacityProviderName":{ - "shape":"CapacityProviderName", - "documentation":"

The name of the capacity provider to retrieve.

", - "location":"uri", - "locationName":"CapacityProviderName" - } - } - }, - "GetCapacityProviderResponse":{ - "type":"structure", - "required":["CapacityProvider"], - "members":{ - "CapacityProvider":{ - "shape":"CapacityProvider", - "documentation":"

Information about the capacity provider, including its configuration and current state.

" - } - } - }, - "GetCodeSigningConfigRequest":{ - "type":"structure", - "required":["CodeSigningConfigArn"], - "members":{ - "CodeSigningConfigArn":{ - "shape":"CodeSigningConfigArn", - "documentation":"

The The Amazon Resource Name (ARN) of the code signing configuration.

", - "location":"uri", - "locationName":"CodeSigningConfigArn" - } - } - }, - "GetCodeSigningConfigResponse":{ - "type":"structure", - "required":["CodeSigningConfig"], - "members":{ - "CodeSigningConfig":{ - "shape":"CodeSigningConfig", - "documentation":"

The code signing configuration

" - } - } - }, - "GetDurableExecutionHistoryRequest":{ - "type":"structure", - "required":["DurableExecutionArn"], - "members":{ - "DurableExecutionArn":{ - "shape":"DurableExecutionArn", - "documentation":"

The Amazon Resource Name (ARN) of the durable execution.

", - "location":"uri", - "locationName":"DurableExecutionArn" - }, - "IncludeExecutionData":{ - "shape":"IncludeExecutionData", - "documentation":"

Specifies whether to include execution data such as step results and callback payloads in the history events. Set to true to include data, or false to exclude it for a more compact response. The default is true.

", - "location":"querystring", - "locationName":"IncludeExecutionData" - }, - "MaxItems":{ - "shape":"ItemCount", - "documentation":"

The maximum number of history events to return per call. You can use Marker to retrieve additional pages of results. The default is 100 and the maximum allowed is 1000. A value of 0 uses the default.

", - "location":"querystring", - "locationName":"MaxItems" - }, - "Marker":{ - "shape":"String", - "documentation":"

If NextMarker was returned from a previous request, use this value to retrieve the next page of results. Each pagination token expires after 24 hours.

", - "location":"querystring", - "locationName":"Marker" - }, - "ReverseOrder":{ - "shape":"ReverseOrder", - "documentation":"

When set to true, returns the history events in reverse chronological order (newest first). By default, events are returned in chronological order (oldest first).

", - "location":"querystring", - "locationName":"ReverseOrder" - } - } - }, - "GetDurableExecutionHistoryResponse":{ - "type":"structure", - "required":["Events"], - "members":{ - "Events":{ - "shape":"Events", - "documentation":"

An array of execution history events, ordered chronologically unless ReverseOrder is set to true. Each event represents a significant occurrence during the execution, such as step completion or callback resolution.

" - }, - "NextMarker":{ - "shape":"String", - "documentation":"

If present, indicates that more history events are available. Use this value as the Marker parameter in a subsequent request to retrieve the next page of results.

" - } - }, - "documentation":"

The response from the GetDurableExecutionHistory operation, containing the execution history and events.

" - }, - "GetDurableExecutionRequest":{ - "type":"structure", - "required":["DurableExecutionArn"], - "members":{ - "DurableExecutionArn":{ - "shape":"DurableExecutionArn", - "documentation":"

The Amazon Resource Name (ARN) of the durable execution.

", - "location":"uri", - "locationName":"DurableExecutionArn" - }, - "IncludeExecutionData":{ - "shape":"IncludeExecutionData", - "documentation":"

Specifies whether to include execution data such as input payload, result, and error information in the response. Set to false for a more compact response that includes only execution metadata. The default value is set to true.

", - "location":"querystring", - "locationName":"IncludeExecutionData" - } - } - }, - "GetDurableExecutionResponse":{ - "type":"structure", - "required":[ - "DurableExecutionArn", - "DurableExecutionName", - "FunctionArn", - "StartTimestamp", - "Status" - ], - "members":{ - "DurableExecutionArn":{ - "shape":"DurableExecutionArn", - "documentation":"

The Amazon Resource Name (ARN) of the durable execution.

" - }, - "DurableExecutionName":{ - "shape":"DurableExecutionName", - "documentation":"

The name of the durable execution. This is either the name you provided when invoking the function, or a system-generated unique identifier if no name was provided.

" - }, - "FunctionArn":{ - "shape":"NameSpacedFunctionArn", - "documentation":"

The Amazon Resource Name (ARN) of the Lambda function that was invoked to start this durable execution.

" - }, - "InputPayload":{ - "shape":"InputPayload", - "documentation":"

The JSON input payload that was provided when the durable execution was started. For asynchronous invocations, this is limited to 256 KB. For synchronous invocations, this can be up to 6 MB.

" - }, - "Result":{ - "shape":"OutputPayload", - "documentation":"

The JSON result returned by the durable execution if it completed successfully. This field is only present when the execution status is SUCCEEDED. The result is limited to 256 KB.

" - }, - "Error":{ - "shape":"ErrorObject", - "documentation":"

Error information if the durable execution failed. This field is only present when the execution status is FAILED, TIMED_OUT, or STOPPED. The combined size of all error fields is limited to 256 KB.

" - }, - "StartTimestamp":{ - "shape":"ExecutionTimestamp", - "documentation":"

The date and time when the durable execution started, in Unix timestamp format.

" - }, - "Status":{ - "shape":"ExecutionStatus", - "documentation":"

The current status of the durable execution. Valid values are RUNNING, SUCCEEDED, FAILED, TIMED_OUT, and STOPPED.

" - }, - "EndTimestamp":{ - "shape":"ExecutionTimestamp", - "documentation":"

The date and time when the durable execution ended, in Unix timestamp format. This field is only present if the execution has completed (status is SUCCEEDED, FAILED, TIMED_OUT, or STOPPED).

" - }, - "Version":{ - "shape":"VersionWithLatestPublished", - "documentation":"

The version of the Lambda function that was invoked for this durable execution. This ensures that all replays during the execution use the same function version.

" - }, - "TraceHeader":{ - "shape":"TraceHeader", - "documentation":"

The trace headers associated with the durable execution.

" - }, - "ExecutionDataIncluded":{ - "shape":"ExecutionDataIncluded", - "documentation":"

Indicates whether execution data is included in this response. Returns false when IncludeExecutionData is set to false in the request.

" - }, - "DurableConfig":{ - "shape":"DurableConfig", - "documentation":"

Configuration settings for the durable execution, including execution timeout, retention period for execution history, and an optional ARN of the Key Management Service (KMS) customer managed key that is used to encrypt your durable execution's payload data, including input, output, and error payloads.

" - } - }, - "documentation":"

The response from the GetDurableExecution operation, containing detailed information about the durable execution.

" - }, - "GetDurableExecutionStateRequest":{ - "type":"structure", - "required":[ - "DurableExecutionArn", - "CheckpointToken" - ], - "members":{ - "DurableExecutionArn":{ - "shape":"DurableExecutionArn", - "documentation":"

The Amazon Resource Name (ARN) of the durable execution.

", - "location":"uri", - "locationName":"DurableExecutionArn" - }, - "CheckpointToken":{ - "shape":"CheckpointToken", - "documentation":"

A checkpoint token that identifies the current state of the execution. This token is provided by the Lambda runtime and ensures that state retrieval is consistent with the current execution context.

", - "location":"querystring", - "locationName":"CheckpointToken" - }, - "Marker":{ - "shape":"String", - "documentation":"

If NextMarker was returned from a previous request, use this value to retrieve the next page of operations. Each pagination token expires after 24 hours.

", - "location":"querystring", - "locationName":"Marker" - }, - "MaxItems":{ - "shape":"ItemCount", - "documentation":"

The maximum number of operations to return per call. You can use Marker to retrieve additional pages of results. The default is 100 and the maximum allowed is 1000. A value of 0 uses the default.

", - "location":"querystring", - "locationName":"MaxItems" - } - } - }, - "GetDurableExecutionStateResponse":{ - "type":"structure", - "required":["Operations"], - "members":{ - "Operations":{ - "shape":"Operations", - "documentation":"

An array of operations that represent the current state of the durable execution. Operations are ordered by their start sequence number in ascending order and include information needed for replay processing.

" - }, - "NextMarker":{ - "shape":"String", - "documentation":"

If present, indicates that more operations are available. Use this value as the Marker parameter in a subsequent request to retrieve the next page of results.

" - } - }, - "documentation":"

The response from the GetDurableExecutionState operation, containing the current execution state for replay.

" - }, - "GetEventSourceMappingRequest":{ - "type":"structure", - "required":["UUID"], - "members":{ - "UUID":{ - "shape":"UUIDString", - "documentation":"

The identifier of the event source mapping.

", - "location":"uri", - "locationName":"UUID" - } - } - }, - "GetFunctionCodeSigningConfigRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "documentation":"

The name or ARN of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "location":"uri", - "locationName":"FunctionName" - } - } - }, - "GetFunctionCodeSigningConfigResponse":{ - "type":"structure", - "required":[ - "CodeSigningConfigArn", - "FunctionName" - ], - "members":{ - "CodeSigningConfigArn":{ - "shape":"CodeSigningConfigArn", - "documentation":"

The The Amazon Resource Name (ARN) of the code signing configuration.

" - }, - "FunctionName":{ - "shape":"FunctionName", - "documentation":"

The name or ARN of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

" - } - } - }, - "GetFunctionConcurrencyRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"FunctionName", - "documentation":"

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "location":"uri", - "locationName":"FunctionName" - } - } - }, - "GetFunctionConcurrencyResponse":{ - "type":"structure", - "members":{ - "ReservedConcurrentExecutions":{ - "shape":"ReservedConcurrentExecutions", - "documentation":"

The number of simultaneous executions that are reserved for the function.

" - } - } - }, - "GetFunctionConfigurationRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "documentation":"

The name or ARN of the Lambda function, version, or alias.

Name formats

  • Function name – my-function (name-only), my-function:v1 (with alias).

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "location":"uri", - "locationName":"FunctionName" - }, - "Qualifier":{ - "shape":"NumericLatestPublishedOrAliasQualifier", - "documentation":"

Specify a version or alias to get details about a published version of the function.

", - "location":"querystring", - "locationName":"Qualifier" - } - } - }, - "GetFunctionEventInvokeConfigRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "documentation":"

The name or ARN of the Lambda function, version, or alias.

Name formats

  • Function name - my-function (name-only), my-function:v1 (with alias).

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN - 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "location":"uri", - "locationName":"FunctionName" - }, - "Qualifier":{ - "shape":"NumericLatestPublishedOrAliasQualifier", - "documentation":"

A version number or alias name.

", - "location":"querystring", - "locationName":"Qualifier" - } - } - }, - "GetFunctionRecursionConfigRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"UnqualifiedFunctionName", - "documentation":"

The name of the function.

", - "location":"uri", - "locationName":"FunctionName" - } - } - }, - "GetFunctionRecursionConfigResponse":{ - "type":"structure", - "members":{ - "RecursiveLoop":{ - "shape":"RecursiveLoop", - "documentation":"

If your function's recursive loop detection configuration is Allow, Lambda doesn't take any action when it detects your function being invoked as part of a recursive loop.

If your function's recursive loop detection configuration is Terminate, Lambda stops your function being invoked and notifies you when it detects your function being invoked as part of a recursive loop.

By default, Lambda sets your function's configuration to Terminate. You can update this configuration using the PutFunctionRecursionConfig action.

" - } - } - }, - "GetFunctionRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "documentation":"

The name or ARN of the Lambda function, version, or alias.

Name formats

  • Function name – my-function (name-only), my-function:v1 (with alias).

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "location":"uri", - "locationName":"FunctionName" - }, - "Qualifier":{ - "shape":"NumericLatestPublishedOrAliasQualifier", - "documentation":"

Specify a version or alias to get details about a published version of the function.

", - "location":"querystring", - "locationName":"Qualifier" - } - } - }, - "GetFunctionResponse":{ - "type":"structure", - "members":{ - "Configuration":{ - "shape":"FunctionConfiguration", - "documentation":"

The configuration of the function or version.

" - }, - "Code":{ - "shape":"FunctionCodeLocation", - "documentation":"

The deployment package of the function or version.

" - }, - "Tags":{ - "shape":"Tags", - "documentation":"

The function's tags. Lambda returns tag data only if you have explicit allow permissions for lambda:ListTags.

" - }, - "TagsError":{ - "shape":"TagsError", - "documentation":"

An object that contains details about an error related to retrieving tags.

" - }, - "Concurrency":{ - "shape":"Concurrency", - "documentation":"

The function's reserved concurrency.

" - } - } - }, - "GetFunctionScalingConfigRequest":{ - "type":"structure", - "required":[ - "FunctionName", - "Qualifier" - ], - "members":{ - "FunctionName":{ - "shape":"UnqualifiedFunctionName", - "documentation":"

The name or ARN of the Lambda function.

", - "location":"uri", - "locationName":"FunctionName" - }, - "Qualifier":{ - "shape":"PublishedFunctionQualifier", - "documentation":"

Specify a version or alias to get the scaling configuration for a published version of the function.

", - "location":"querystring", - "locationName":"Qualifier" - } - } - }, - "GetFunctionScalingConfigResponse":{ - "type":"structure", - "members":{ - "FunctionArn":{ - "shape":"FunctionArn", - "documentation":"

The Amazon Resource Name (ARN) of the function.

" - }, - "AppliedFunctionScalingConfig":{ - "shape":"FunctionScalingConfig", - "documentation":"

The scaling configuration that is currently applied to the function. This represents the actual scaling settings in effect.

" - }, - "RequestedFunctionScalingConfig":{ - "shape":"FunctionScalingConfig", - "documentation":"

The scaling configuration that was requested for the function.

" - } - } - }, - "GetFunctionUrlConfigRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"FunctionUrlFunctionName", - "documentation":"

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "location":"uri", - "locationName":"FunctionName" - }, - "Qualifier":{ - "shape":"FunctionUrlQualifier", - "documentation":"

The alias name.

", - "location":"querystring", - "locationName":"Qualifier" - } - } - }, - "GetFunctionUrlConfigResponse":{ - "type":"structure", - "required":[ - "FunctionUrl", - "FunctionArn", - "AuthType", - "CreationTime", - "LastModifiedTime" - ], - "members":{ - "FunctionUrl":{ - "shape":"FunctionUrl", - "documentation":"

The HTTP URL endpoint for your function.

" - }, - "FunctionArn":{ - "shape":"FunctionArn", - "documentation":"

The Amazon Resource Name (ARN) of your function.

" - }, - "AuthType":{ - "shape":"FunctionUrlAuthType", - "documentation":"

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Control access to Lambda function URLs.

" - }, - "Cors":{ - "shape":"Cors", - "documentation":"

The cross-origin resource sharing (CORS) settings for your function URL.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

When the function URL was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

When the function URL configuration was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" - }, - "InvokeMode":{ - "shape":"InvokeMode", - "documentation":"

Use one of the following options:

  • BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.

  • RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 200 MB.

" - } - } - }, - "GetLayerVersionByArnRequest":{ - "type":"structure", - "required":["Arn"], - "members":{ - "Arn":{ - "shape":"LayerVersionArn", - "documentation":"

The ARN of the layer version.

", - "location":"querystring", - "locationName":"Arn" - } - } - }, - "GetLayerVersionPolicyRequest":{ - "type":"structure", - "required":[ - "LayerName", - "VersionNumber" - ], - "members":{ - "LayerName":{ - "shape":"LayerName", - "documentation":"

The name or Amazon Resource Name (ARN) of the layer.

", - "location":"uri", - "locationName":"LayerName" - }, - "VersionNumber":{ - "shape":"LayerVersionNumber", - "documentation":"

The version number.

", - "location":"uri", - "locationName":"VersionNumber" - } - } - }, - "GetLayerVersionPolicyResponse":{ - "type":"structure", - "members":{ - "Policy":{ - "shape":"String", - "documentation":"

The policy document.

" - }, - "RevisionId":{ - "shape":"String", - "documentation":"

A unique identifier for the current revision of the policy.

" - } - } - }, - "GetLayerVersionRequest":{ - "type":"structure", - "required":[ - "LayerName", - "VersionNumber" - ], - "members":{ - "LayerName":{ - "shape":"LayerName", - "documentation":"

The name or Amazon Resource Name (ARN) of the layer.

", - "location":"uri", - "locationName":"LayerName" - }, - "VersionNumber":{ - "shape":"LayerVersionNumber", - "documentation":"

The version number.

", - "location":"uri", - "locationName":"VersionNumber" - } - } - }, - "GetLayerVersionResponse":{ - "type":"structure", - "members":{ - "Content":{ - "shape":"LayerVersionContentOutput", - "documentation":"

Details about the layer version.

" - }, - "LayerArn":{ - "shape":"LayerArn", - "documentation":"

The ARN of the layer.

" - }, - "LayerVersionArn":{ - "shape":"LayerVersionArn", - "documentation":"

The ARN of the layer version.

" - }, - "Description":{ - "shape":"Description", - "documentation":"

The description of the version.

" - }, - "CreatedDate":{ - "shape":"Timestamp", - "documentation":"

The date that the layer version was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" - }, - "Version":{ - "shape":"LayerVersionNumber", - "documentation":"

The version number.

" - }, - "CompatibleArchitectures":{ - "shape":"CompatibleArchitectures", - "documentation":"

A list of compatible instruction set architectures.

" - }, - "CompatibleRuntimes":{ - "shape":"CompatibleRuntimes", - "documentation":"

The layer's compatible runtimes.

The following list includes deprecated runtimes. For more information, see Runtime use after deprecation.

For a list of all currently supported runtimes, see Supported runtimes.

" - }, - "LicenseInfo":{ - "shape":"LicenseInfo", - "documentation":"

The layer's software license.

" - } - } - }, - "GetPolicyRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "documentation":"

The name or ARN of the Lambda function, version, or alias.

Name formats

  • Function name – my-function (name-only), my-function:v1 (with alias).

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "location":"uri", - "locationName":"FunctionName" - }, - "Qualifier":{ - "shape":"NumericLatestPublishedOrAliasQualifier", - "documentation":"

Specify a version or alias to get the policy for that resource.

", - "location":"querystring", - "locationName":"Qualifier" - } - } - }, - "GetPolicyResponse":{ - "type":"structure", - "members":{ - "Policy":{ - "shape":"String", - "documentation":"

The resource-based policy.

" - }, - "RevisionId":{ - "shape":"String", - "documentation":"

A unique identifier for the current revision of the policy.

" - } - } - }, - "GetProvisionedConcurrencyConfigRequest":{ - "type":"structure", - "required":[ - "FunctionName", - "Qualifier" - ], - "members":{ - "FunctionName":{ - "shape":"FunctionName", - "documentation":"

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "location":"uri", - "locationName":"FunctionName" - }, - "Qualifier":{ - "shape":"Qualifier", - "documentation":"

The version number or alias name.

", - "location":"querystring", - "locationName":"Qualifier" - } - } - }, - "GetProvisionedConcurrencyConfigResponse":{ - "type":"structure", - "members":{ - "RequestedProvisionedConcurrentExecutions":{ - "shape":"PositiveInteger", - "documentation":"

The amount of provisioned concurrency requested.

" - }, - "AvailableProvisionedConcurrentExecutions":{ - "shape":"NonNegativeInteger", - "documentation":"

The amount of provisioned concurrency available.

" - }, - "AllocatedProvisionedConcurrentExecutions":{ - "shape":"NonNegativeInteger", - "documentation":"

The amount of provisioned concurrency allocated. When a weighted alias is used during linear and canary deployments, this value fluctuates depending on the amount of concurrency that is provisioned for the function versions.

" - }, - "Status":{ - "shape":"ProvisionedConcurrencyStatusEnum", - "documentation":"

The status of the allocation process.

" - }, - "StatusReason":{ - "shape":"String", - "documentation":"

For failed allocations, the reason that provisioned concurrency could not be allocated.

" - }, - "LastModified":{ - "shape":"Timestamp", - "documentation":"

The date and time that a user last updated the configuration, in ISO 8601 format.

" - } - } - }, - "GetRuntimeManagementConfigRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "documentation":"

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "location":"uri", - "locationName":"FunctionName" - }, - "Qualifier":{ - "shape":"NumericLatestPublishedOrAliasQualifier", - "documentation":"

Specify a version of the function. This can be $LATEST or a published version number. If no value is specified, the configuration for the $LATEST version is returned.

", - "location":"querystring", - "locationName":"Qualifier" - } - } - }, - "GetRuntimeManagementConfigResponse":{ - "type":"structure", - "members":{ - "UpdateRuntimeOn":{ - "shape":"UpdateRuntimeOn", - "documentation":"

The current runtime update mode of the function.

" - }, - "FunctionArn":{ - "shape":"NameSpacedFunctionArn", - "documentation":"

The Amazon Resource Name (ARN) of your function.

" - }, - "RuntimeVersionArn":{ - "shape":"RuntimeVersionArn", - "documentation":"

The ARN of the runtime the function is configured to use. If the runtime update mode is Manual, the ARN is returned, otherwise null is returned.

" - } - } - }, - "Handler":{ - "type":"string", - "max":128, - "min":0, - "pattern":"[^\\s]+" - }, - "Header":{ - "type":"string", - "max":1024, - "min":0, - "pattern":".*" - }, - "HeadersList":{ - "type":"list", - "member":{"shape":"Header"}, - "max":100, - "min":0 - }, - "HttpStatus":{"type":"integer"}, - "ImageConfig":{ - "type":"structure", - "members":{ - "EntryPoint":{ - "shape":"StringList", - "documentation":"

Specifies the entry point to their application, which is typically the location of the runtime executable.

" - }, - "Command":{ - "shape":"StringList", - "documentation":"

Specifies parameters that you want to pass in with ENTRYPOINT.

" - }, - "WorkingDirectory":{ - "shape":"WorkingDirectory", - "documentation":"

Specifies the working directory.

" - } - }, - "documentation":"

Configuration values that override the container image Dockerfile settings. For more information, see Container image settings.

" - }, - "ImageConfigError":{ - "type":"structure", - "members":{ - "ErrorCode":{ - "shape":"String", - "documentation":"

Error code.

" - }, - "Message":{ - "shape":"SensitiveString", - "documentation":"

Error message.

" - } - }, - "documentation":"

Error response to GetFunctionConfiguration.

" - }, - "ImageConfigResponse":{ - "type":"structure", - "members":{ - "ImageConfig":{ - "shape":"ImageConfig", - "documentation":"

Configuration values that override the container image Dockerfile.

" - }, - "Error":{ - "shape":"ImageConfigError", - "documentation":"

Error response to GetFunctionConfiguration.

" - } - }, - "documentation":"

Response to a GetFunctionConfiguration request.

" - }, - "IncludeExecutionData":{ - "type":"boolean", - "box":true - }, - "InputPayload":{ - "type":"string", - "max":6291456, - "min":0, - "sensitive":true - }, - "InstanceRequirements":{ - "type":"structure", - "members":{ - "Architectures":{ - "shape":"ArchitecturesList", - "documentation":"

A list of supported CPU architectures for compute instances. Valid values include x86_64 and arm64.

" - }, - "AllowedInstanceTypes":{ - "shape":"InstanceTypeSet", - "documentation":"

A list of EC2 instance types that the capacity provider is allowed to use. If not specified, all compatible instance types are allowed.

" - }, - "ExcludedInstanceTypes":{ - "shape":"InstanceTypeSet", - "documentation":"

A list of EC2 instance types that the capacity provider should not use, even if they meet other requirements.

" - } - }, - "documentation":"

Specifications that define the characteristics and constraints for compute instances used by the capacity provider.

" - }, - "InstanceType":{ - "type":"string", - "max":30, - "min":1, - "pattern":"[a-zA-Z0-9\\.\\*\\-]+" - }, - "InstanceTypeSet":{ - "type":"list", - "member":{"shape":"InstanceType"}, - "max":400, - "min":0 - }, - "Integer":{"type":"integer"}, - "InvalidCodeSignatureException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "documentation":"

The code signature failed the integrity check. If the integrity check fails, then Lambda blocks deployment, even if the code signing policy is set to WARN.

", - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "InvalidParameterValueException":{ - "type":"structure", - "members":{ - "Type":{ - "shape":"String", - "documentation":"

The exception type.

" - }, - "message":{ - "shape":"String", - "documentation":"

The exception message.

" - } - }, - "documentation":"

One of the parameters in the request is not valid.

", - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "InvalidRequestContentException":{ - "type":"structure", - "members":{ - "Type":{ - "shape":"String", - "documentation":"

The exception type.

" - }, - "message":{ - "shape":"String", - "documentation":"

The exception message.

" - } - }, - "documentation":"

The request body could not be parsed as JSON, or a request header is invalid. For example, the 'x-amzn-RequestId' header is not a valid UUID string.

", - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "InvalidRuntimeException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "documentation":"

The runtime or runtime version specified is not supported.

", - "error":{"httpStatusCode":502}, - "exception":true, - "fault":true - }, - "InvalidSecurityGroupIDException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "documentation":"

The security group ID provided in the Lambda function VPC configuration is not valid.

", - "error":{"httpStatusCode":502}, - "exception":true, - "fault":true - }, - "InvalidSubnetIDException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "documentation":"

The subnet ID provided in the Lambda function VPC configuration is not valid.

", - "error":{"httpStatusCode":502}, - "exception":true, - "fault":true - }, - "InvalidZipFileException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "documentation":"

Lambda could not unzip the deployment package.

", - "error":{"httpStatusCode":502}, - "exception":true, - "fault":true - }, - "InvocationCompletedDetails":{ - "type":"structure", - "required":[ - "StartTimestamp", - "EndTimestamp", - "RequestId" - ], - "members":{ - "StartTimestamp":{ - "shape":"ExecutionTimestamp", - "documentation":"

The date and time when the invocation started, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" - }, - "EndTimestamp":{ - "shape":"ExecutionTimestamp", - "documentation":"

The date and time when the invocation ended, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" - }, - "RequestId":{ - "shape":"String", - "documentation":"

The request ID for the invocation.

" - }, - "Error":{ - "shape":"EventError", - "documentation":"

Details about the invocation failure.

" - } - }, - "documentation":"

Details about a function invocation that completed.

" - }, - "InvocationRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "documentation":"

The name or ARN of the Lambda function, version, or alias.

Name formats

  • Function name – my-function (name-only), my-function:v1 (with alias).

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "location":"uri", - "locationName":"FunctionName" - }, - "InvocationType":{ - "shape":"InvocationType", - "documentation":"

Choose from the following options.

  • RequestResponse (default) – Invoke the function synchronously. Keep the connection open until the function returns a response or times out. The API response includes the function response and additional data.

  • Event – Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if one is configured). The API response only includes a status code.

  • DryRun – Validate parameter values and verify that the user or role has permission to invoke the function.

", - "location":"header", - "locationName":"X-Amz-Invocation-Type" - }, - "LogType":{ - "shape":"LogType", - "documentation":"

Set to Tail to include the execution log in the response. Applies to synchronously invoked functions only.

", - "location":"header", - "locationName":"X-Amz-Log-Type" - }, - "ClientContext":{ - "shape":"String", - "documentation":"

Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object. Lambda passes the ClientContext object to your function for synchronous invocations only.

", - "location":"header", - "locationName":"X-Amz-Client-Context" - }, - "DurableExecutionName":{ - "shape":"DurableExecutionName", - "documentation":"

A unique name for the durable execution. If you invoke a durable function using a name that already exists with the same payload, Lambda returns the existing execution instead of creating a duplicate. If the payload differs, Lambda returns a DurableExecutionAlreadyStartedException error.

If not specified, Lambda generates a unique identifier automatically. For more information, see Execution names.

", - "location":"header", - "locationName":"X-Amz-Durable-Execution-Name" - }, - "Payload":{ - "shape":"Blob", - "documentation":"

The JSON that you want to provide to your Lambda function as input. The maximum payload size is 6 MB for synchronous invocations and 1 MB for asynchronous invocations.

You can enter the JSON directly. For example, --payload '{ \"key\": \"value\" }'. You can also specify a file path. For example, --payload file://payload.json.

" - }, - "Qualifier":{ - "shape":"NumericLatestPublishedOrAliasQualifier", - "documentation":"

Specify a version or alias to invoke a published version of the function.

", - "location":"querystring", - "locationName":"Qualifier" - }, - "TenantId":{ - "shape":"TenantId", - "documentation":"

The identifier of the tenant in a multi-tenant Lambda function.

", - "location":"header", - "locationName":"X-Amz-Tenant-Id" - } - }, - "payload":"Payload" - }, - "InvocationResponse":{ - "type":"structure", - "members":{ - "StatusCode":{ - "shape":"Integer", - "documentation":"

The HTTP status code is in the 200 range for a successful request. For the RequestResponse invocation type, this status code is 200. For the Event invocation type, this status code is 202. For the DryRun invocation type, the status code is 204.

", - "location":"statusCode" - }, - "FunctionError":{ - "shape":"String", - "documentation":"

If present, indicates that an error occurred during function execution. Details about the error are included in the response payload.

", - "location":"header", - "locationName":"X-Amz-Function-Error" - }, - "LogResult":{ - "shape":"String", - "documentation":"

The last 4 KB of the execution log, which is base64-encoded.

", - "location":"header", - "locationName":"X-Amz-Log-Result" - }, - "Payload":{ - "shape":"Blob", - "documentation":"

The response from the function, or an error object.

" - }, - "ExecutedVersion":{ - "shape":"Version", - "documentation":"

The version of the function that executed. When you invoke a function with an alias, this indicates which version the alias resolved to.

", - "location":"header", - "locationName":"X-Amz-Executed-Version" - }, - "DurableExecutionArn":{ - "shape":"DurableExecutionArn", - "documentation":"

The ARN of the durable execution that was started. This is returned when invoking a durable function and provides a unique identifier for tracking the execution.

", - "location":"header", - "locationName":"X-Amz-Durable-Execution-Arn" - } - }, - "payload":"Payload" - }, - "InvocationType":{ - "type":"string", - "enum":[ - "Event", - "RequestResponse", - "DryRun" - ] - }, - "InvokeAsyncRequest":{ - "type":"structure", - "required":[ - "FunctionName", - "InvokeArgs" - ], - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "documentation":"

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "location":"uri", - "locationName":"FunctionName" - }, - "InvokeArgs":{ - "shape":"BlobStream", - "documentation":"

The JSON that you want to provide to your Lambda function as input.

" - } - }, - "deprecated":true, - "payload":"InvokeArgs" - }, - "InvokeAsyncResponse":{ - "type":"structure", - "members":{ - "Status":{ - "shape":"HttpStatus", - "documentation":"

The status code.

", - "location":"statusCode" - } - }, - "documentation":"

A success response (202 Accepted) indicates that the request is queued for invocation.

", - "deprecated":true - }, - "InvokeMode":{ - "type":"string", - "enum":[ - "BUFFERED", - "RESPONSE_STREAM" - ] - }, - "InvokeResponseStreamUpdate":{ - "type":"structure", - "members":{ - "Payload":{ - "shape":"Blob", - "documentation":"

Data returned by your Lambda function.

", - "eventpayload":true - } - }, - "documentation":"

A chunk of the streamed response payload.

", - "event":true - }, - "InvokeWithResponseStreamCompleteEvent":{ - "type":"structure", - "members":{ - "ErrorCode":{ - "shape":"String", - "documentation":"

An error code.

" - }, - "ErrorDetails":{ - "shape":"String", - "documentation":"

The details of any returned error.

" - }, - "LogResult":{ - "shape":"String", - "documentation":"

The last 4 KB of the execution log, which is base64-encoded.

" - } - }, - "documentation":"

A response confirming that the event stream is complete.

", - "event":true - }, - "InvokeWithResponseStreamRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "documentation":"

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "location":"uri", - "locationName":"FunctionName" - }, - "LogType":{ - "shape":"LogType", - "documentation":"

Set to Tail to include the execution log in the response. Applies to synchronously invoked functions only.

", - "location":"header", - "locationName":"X-Amz-Log-Type" - }, - "ClientContext":{ - "shape":"String", - "documentation":"

Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.

", - "location":"header", - "locationName":"X-Amz-Client-Context" - }, - "Qualifier":{ - "shape":"NumericLatestPublishedOrAliasQualifier", - "documentation":"

The alias name.

", - "location":"querystring", - "locationName":"Qualifier" - }, - "Payload":{ - "shape":"Blob", - "documentation":"

The JSON that you want to provide to your Lambda function as input.

You can enter the JSON directly. For example, --payload '{ \"key\": \"value\" }'. You can also specify a file path. For example, --payload file://payload.json.

" - }, - "TenantId":{ - "shape":"TenantId", - "documentation":"

The identifier of the tenant in a multi-tenant Lambda function.

", - "location":"header", - "locationName":"X-Amz-Tenant-Id" - }, - "InvocationType":{ - "shape":"ResponseStreamingInvocationType", - "documentation":"

Use one of the following options:

  • RequestResponse (default) – Invoke the function synchronously. Keep the connection open until the function returns a response or times out. The API operation response includes the function response and additional data.

  • DryRun – Validate parameter values and verify that the IAM user or role has permission to invoke the function.

", - "location":"header", - "locationName":"X-Amz-Invocation-Type" - } - }, - "payload":"Payload" - }, - "InvokeWithResponseStreamResponse":{ - "type":"structure", - "members":{ - "StatusCode":{ - "shape":"Integer", - "documentation":"

For a successful request, the HTTP status code is in the 200 range. For the RequestResponse invocation type, this status code is 200. For the DryRun invocation type, this status code is 204.

", - "location":"statusCode" - }, - "ExecutedVersion":{ - "shape":"Version", - "documentation":"

The version of the function that executed. When you invoke a function with an alias, this indicates which version the alias resolved to.

", - "location":"header", - "locationName":"X-Amz-Executed-Version" - }, - "EventStream":{ - "shape":"InvokeWithResponseStreamResponseEvent", - "documentation":"

The stream of response payloads.

" - }, - "ResponseStreamContentType":{ - "shape":"String", - "documentation":"

The type of data the stream is returning.

", - "location":"header", - "locationName":"Content-Type" - } - }, - "payload":"EventStream" - }, - "InvokeWithResponseStreamResponseEvent":{ - "type":"structure", - "members":{ - "PayloadChunk":{ - "shape":"InvokeResponseStreamUpdate", - "documentation":"

A chunk of the streamed response payload.

" - }, - "InvokeComplete":{ - "shape":"InvokeWithResponseStreamCompleteEvent", - "documentation":"

An object that's returned when the stream has ended and all the payload chunks have been returned.

" - } - }, - "documentation":"

An object that includes a chunk of the response payload. When the stream has ended, Lambda includes a InvokeComplete object.

", - "eventstream":true - }, - "InvokedViaFunctionUrl":{ - "type":"boolean", - "box":true - }, - "ItemCount":{ - "type":"integer", - "max":1000, - "min":0 - }, - "KMSAccessDeniedException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "documentation":"

Lambda couldn't decrypt the environment variables because KMS access was denied. Check the Lambda function's KMS permissions.

", - "error":{"httpStatusCode":502}, - "exception":true, - "fault":true - }, - "KMSDisabledException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "documentation":"

Lambda couldn't decrypt the environment variables because the KMS key used is disabled. Check the Lambda function's KMS key settings.

", - "error":{"httpStatusCode":502}, - "exception":true, - "fault":true - }, - "KMSInvalidStateException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "documentation":"

Lambda couldn't decrypt the environment variables because the state of the KMS key used is not valid for Decrypt. Check the function's KMS key settings.

", - "error":{"httpStatusCode":502}, - "exception":true, - "fault":true - }, - "KMSKeyArn":{ - "type":"string", - "max":10000, - "min":0, - "pattern":"(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()" - }, - "KMSKeyArnNonEmpty":{ - "type":"string", - "max":10000, - "min":0, - "pattern":"arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*" - }, - "KMSNotFoundException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "documentation":"

Lambda couldn't decrypt the environment variables because the KMS key was not found. Check the function's KMS key settings.

", - "error":{"httpStatusCode":502}, - "exception":true, - "fault":true - }, - "KafkaSchemaRegistryAccessConfig":{ - "type":"structure", - "members":{ - "Type":{ - "shape":"KafkaSchemaRegistryAuthType", - "documentation":"

The type of authentication Lambda uses to access your schema registry.

" - }, - "URI":{ - "shape":"Arn", - "documentation":"

The URI of the secret (Secrets Manager secret ARN) to authenticate with your schema registry.

" - } - }, - "documentation":"

Specific access configuration settings that tell Lambda how to authenticate with your schema registry.

If you're working with an Glue schema registry, don't provide authentication details in this object. Instead, ensure that your execution role has the required permissions for Lambda to access your cluster.

If you're working with a Confluent schema registry, choose the authentication method in the Type field, and provide the Secrets Manager secret ARN in the URI field.

" - }, - "KafkaSchemaRegistryAccessConfigList":{ - "type":"list", - "member":{"shape":"KafkaSchemaRegistryAccessConfig"} - }, - "KafkaSchemaRegistryAuthType":{ - "type":"string", - "enum":[ - "BASIC_AUTH", - "CLIENT_CERTIFICATE_TLS_AUTH", - "SERVER_ROOT_CA_CERTIFICATE" - ] - }, - "KafkaSchemaRegistryConfig":{ - "type":"structure", - "members":{ - "SchemaRegistryURI":{ - "shape":"SchemaRegistryUri", - "documentation":"

The URI for your schema registry. The correct URI format depends on the type of schema registry you're using.

  • For Glue schema registries, use the ARN of the registry.

  • For Confluent schema registries, use the URL of the registry.

" - }, - "EventRecordFormat":{ - "shape":"SchemaRegistryEventRecordFormat", - "documentation":"

The record format that Lambda delivers to your function after schema validation.

  • Choose JSON to have Lambda deliver the record to your function as a standard JSON object.

  • Choose SOURCE to have Lambda deliver the record to your function in its original source format. Lambda removes all schema metadata, such as the schema ID, before sending the record to your function.

" - }, - "AccessConfigs":{ - "shape":"KafkaSchemaRegistryAccessConfigList", - "documentation":"

An array of access configuration objects that tell Lambda how to authenticate with your schema registry.

" - }, - "SchemaValidationConfigs":{ - "shape":"KafkaSchemaValidationConfigList", - "documentation":"

An array of schema validation configuration objects, which tell Lambda the message attributes you want to validate and filter using your schema registry.

" - } - }, - "documentation":"

Specific configuration settings for a Kafka schema registry.

" - }, - "KafkaSchemaValidationAttribute":{ - "type":"string", - "enum":[ - "KEY", - "VALUE" - ] - }, - "KafkaSchemaValidationConfig":{ - "type":"structure", - "members":{ - "Attribute":{ - "shape":"KafkaSchemaValidationAttribute", - "documentation":"

The attributes you want your schema registry to validate and filter for. If you selected JSON as the EventRecordFormat, Lambda also deserializes the selected message attributes.

" - } - }, - "documentation":"

Specific schema validation configuration settings that tell Lambda the message attributes you want to validate and filter using your schema registry.

" - }, - "KafkaSchemaValidationConfigList":{ - "type":"list", - "member":{"shape":"KafkaSchemaValidationConfig"} - }, - "LambdaManagedInstancesCapacityProviderConfig":{ - "type":"structure", - "required":["CapacityProviderArn"], - "members":{ - "CapacityProviderArn":{ - "shape":"CapacityProviderArn", - "documentation":"

The Amazon Resource Name (ARN) of the capacity provider.

" - }, - "PerExecutionEnvironmentMaxConcurrency":{ - "shape":"PerExecutionEnvironmentMaxConcurrency", - "documentation":"

The maximum number of concurrent execution environments that can run on each compute instance.

" - }, - "ExecutionEnvironmentMemoryGiBPerVCpu":{ - "shape":"ExecutionEnvironmentMemoryGiBPerVCpu", - "documentation":"

The amount of memory in GiB allocated per vCPU for execution environments.

" - } - }, - "documentation":"

Configuration for Lambda-managed instances used by the capacity provider.

" - }, - "LastUpdateStatus":{ - "type":"string", - "enum":[ - "Successful", - "Failed", - "InProgress" - ] - }, - "LastUpdateStatusReason":{"type":"string"}, - "LastUpdateStatusReasonCode":{ - "type":"string", - "enum":[ - "EniLimitExceeded", - "InsufficientRolePermissions", - "InvalidConfiguration", - "InternalError", - "SubnetOutOfIPAddresses", - "InvalidSubnet", - "InvalidSecurityGroup", - "ImageDeleted", - "ImageAccessDenied", - "InvalidImage", - "KMSKeyAccessDenied", - "KMSKeyNotFound", - "InvalidStateKMSKey", - "DisabledKMSKey", - "EFSIOError", - "EFSMountConnectivityError", - "EFSMountFailure", - "EFSMountTimeout", - "InvalidRuntime", - "InvalidZipFileException", - "FunctionError", - "ServiceQuotaExceededException", - "VcpuLimitExceeded", - "CapacityProviderScalingLimitExceeded", - "InsufficientCapacity", - "EC2RequestLimitExceeded", - "FunctionError.InitTimeout", - "FunctionError.RuntimeInitError", - "FunctionError.ExtensionInitError", - "FunctionError.InvalidEntryPoint", - "FunctionError.InvalidWorkingDirectory", - "FunctionError.PermissionDenied", - "FunctionError.TooManyExtensions", - "FunctionError.InitResourceExhausted", - "DisallowedByVpcEncryptionControl", - "DependencyError" - ] - }, - "Layer":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"LayerVersionArn", - "documentation":"

The Amazon Resource Name (ARN) of the function layer.

" - }, - "CodeSize":{ - "shape":"Long", - "documentation":"

The size of the layer archive in bytes.

" - }, - "SigningProfileVersionArn":{ - "shape":"Arn", - "documentation":"

The Amazon Resource Name (ARN) for a signing profile version.

" - }, - "SigningJobArn":{ - "shape":"Arn", - "documentation":"

The Amazon Resource Name (ARN) of a signing job.

" - } - }, - "documentation":"

An Lambda layer.

" - }, - "LayerArn":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"arn:(aws[a-zA-Z-]*)?:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:layer:[a-zA-Z0-9-_]+" - }, - "LayerList":{ - "type":"list", - "member":{"shape":"LayerVersionArn"} - }, - "LayerName":{ - "type":"string", - "max":140, - "min":1, - "pattern":"(arn:(aws[a-zA-Z-]*)?:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:layer:[a-zA-Z0-9-_]+)|[a-zA-Z0-9-_]+" - }, - "LayerPermissionAllowedAction":{ - "type":"string", - "max":22, - "min":0, - "pattern":"lambda:GetLayerVersion" - }, - "LayerPermissionAllowedPrincipal":{ - "type":"string", - "max":10000, - "min":0, - "pattern":"\\d{12}|\\*|arn:(aws[a-zA-Z-]*):iam::\\d{12}:root" - }, - "LayerVersionArn":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"((arn:(aws[a-zA-Z-]*)?:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:layer:[a-zA-Z0-9-_]+:[0-9]+)|(arn:[a-zA-Z0-9-]+:lambda:::awslayer:[a-zA-Z0-9-_]+))" - }, - "LayerVersionContentInput":{ - "type":"structure", - "members":{ - "S3Bucket":{ - "shape":"S3Bucket", - "documentation":"

The Amazon S3 bucket of the layer archive.

" - }, - "S3Key":{ - "shape":"S3Key", - "documentation":"

The Amazon S3 key of the layer archive.

" - }, - "S3ObjectVersion":{ - "shape":"S3ObjectVersion", - "documentation":"

For versioned objects, the version of the layer archive object to use.

" - }, - "S3ObjectStorageMode":{ - "shape":"S3ObjectStorageMode", - "documentation":"

Specifies how the layer archive is stored. Valid values:

  • COPY (default) – Uploads a copy of your layer archive to Lambda.

  • REFERENCE – Lambda references the layer archive from the specified Amazon S3 bucket.

" - }, - "ZipFile":{ - "shape":"Blob", - "documentation":"

The base64-encoded contents of the layer archive. Amazon Web Services SDK and Amazon Web Services CLI clients handle the encoding for you.

" - } - }, - "documentation":"

A ZIP archive that contains the contents of an Lambda layer. You can specify either an Amazon S3 location, or upload a layer archive directly.

" - }, - "LayerVersionContentOutput":{ - "type":"structure", - "members":{ - "Location":{ - "shape":"SensitiveStringOnServerOnly", - "documentation":"

A link to the layer archive in Amazon S3 that is valid for 10 minutes.

" - }, - "CodeSha256":{ - "shape":"String", - "documentation":"

The SHA-256 hash of the layer archive.

" - }, - "CodeSize":{ - "shape":"Long", - "documentation":"

The size of the layer archive in bytes.

" - }, - "SigningProfileVersionArn":{ - "shape":"Arn", - "documentation":"

The Amazon Resource Name (ARN) for a signing profile version.

" - }, - "SigningJobArn":{ - "shape":"Arn", - "documentation":"

The Amazon Resource Name (ARN) of a signing job.

" - }, - "ResolvedS3Object":{ - "shape":"ResolvedS3Object", - "documentation":"

The resolved Amazon S3 object that contains the layer archive.

" - } - }, - "documentation":"

Details about a version of an Lambda layer.

" - }, - "LayerVersionNumber":{"type":"long"}, - "LayerVersionsList":{ - "type":"list", - "member":{"shape":"LayerVersionsListItem"} - }, - "LayerVersionsListItem":{ - "type":"structure", - "members":{ - "LayerVersionArn":{ - "shape":"LayerVersionArn", - "documentation":"

The ARN of the layer version.

" - }, - "Version":{ - "shape":"LayerVersionNumber", - "documentation":"

The version number.

" - }, - "Description":{ - "shape":"Description", - "documentation":"

The description of the version.

" - }, - "CreatedDate":{ - "shape":"Timestamp", - "documentation":"

The date that the version was created, in ISO 8601 format. For example, 2018-11-27T15:10:45.123+0000.

" - }, - "CompatibleArchitectures":{ - "shape":"CompatibleArchitectures", - "documentation":"

A list of compatible instruction set architectures.

" - }, - "CompatibleRuntimes":{ - "shape":"CompatibleRuntimes", - "documentation":"

The layer's compatible runtimes.

The following list includes deprecated runtimes. For more information, see Runtime use after deprecation.

For a list of all currently supported runtimes, see Supported runtimes.

" - }, - "LicenseInfo":{ - "shape":"LicenseInfo", - "documentation":"

The layer's open-source license.

" - } - }, - "documentation":"

Details about a version of an Lambda layer.

" - }, - "LayersList":{ - "type":"list", - "member":{"shape":"LayersListItem"} - }, - "LayersListItem":{ - "type":"structure", - "members":{ - "LayerName":{ - "shape":"LayerName", - "documentation":"

The name of the layer.

" - }, - "LayerArn":{ - "shape":"LayerArn", - "documentation":"

The Amazon Resource Name (ARN) of the function layer.

" - }, - "LatestMatchingVersion":{ - "shape":"LayerVersionsListItem", - "documentation":"

The newest version of the layer.

" - } - }, - "documentation":"

Details about an Lambda layer.

" - }, - "LayersReferenceList":{ - "type":"list", - "member":{"shape":"Layer"} - }, - "LicenseInfo":{ - "type":"string", - "max":512, - "min":0, - "pattern":".*" - }, - "ListAliasesRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"FunctionName", - "documentation":"

The name or ARN of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "location":"uri", - "locationName":"FunctionName" - }, - "FunctionVersion":{ - "shape":"VersionWithLatestPublished", - "documentation":"

Specify a function version to only list aliases that invoke that version.

", - "location":"querystring", - "locationName":"FunctionVersion" - }, - "Marker":{ - "shape":"String", - "documentation":"

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

", - "location":"querystring", - "locationName":"Marker" - }, - "MaxItems":{ - "shape":"MaxListItems", - "documentation":"

Limit the number of aliases returned.

", - "location":"querystring", - "locationName":"MaxItems" - } - } - }, - "ListAliasesResponse":{ - "type":"structure", - "members":{ - "NextMarker":{ - "shape":"String", - "documentation":"

The pagination token that's included if more results are available.

" - }, - "Aliases":{ - "shape":"AliasList", - "documentation":"

A list of aliases.

" - } - } - }, - "ListCapacityProvidersRequest":{ - "type":"structure", - "members":{ - "State":{ - "shape":"CapacityProviderState", - "documentation":"

Filter capacity providers by their current state.

", - "location":"querystring", - "locationName":"State" - }, - "Marker":{ - "shape":"String", - "documentation":"

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

", - "location":"querystring", - "locationName":"Marker" - }, - "MaxItems":{ - "shape":"MaxFiftyListItems", - "documentation":"

The maximum number of capacity providers to return.

", - "location":"querystring", - "locationName":"MaxItems" - } - } - }, - "ListCapacityProvidersResponse":{ - "type":"structure", - "required":["CapacityProviders"], - "members":{ - "CapacityProviders":{ - "shape":"CapacityProvidersList", - "documentation":"

A list of capacity providers in your account.

" - }, - "NextMarker":{ - "shape":"String", - "documentation":"

The pagination token that's included if more results are available.

" - } - } - }, - "ListCodeSigningConfigsRequest":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":"

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

", - "location":"querystring", - "locationName":"Marker" - }, - "MaxItems":{ - "shape":"MaxListItems", - "documentation":"

Maximum number of items to return.

", - "location":"querystring", - "locationName":"MaxItems" - } - } - }, - "ListCodeSigningConfigsResponse":{ - "type":"structure", - "members":{ - "NextMarker":{ - "shape":"String", - "documentation":"

The pagination token that's included if more results are available.

" - }, - "CodeSigningConfigs":{ - "shape":"CodeSigningConfigList", - "documentation":"

The code signing configurations

" - } - } - }, - "ListDurableExecutionsByFunctionRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "documentation":"

The name or ARN of the Lambda function. You can specify a function name, a partial ARN, or a full ARN.

", - "location":"uri", - "locationName":"FunctionName" - }, - "Qualifier":{ - "shape":"NumericLatestPublishedOrAliasQualifier", - "documentation":"

The function version or alias. If not specified, lists executions for the $LATEST version.

", - "location":"querystring", - "locationName":"Qualifier" - }, - "DurableExecutionName":{ - "shape":"DurableExecutionName", - "documentation":"

Filter executions by name. Only executions with names that matches this string are returned.

", - "location":"querystring", - "locationName":"DurableExecutionName" - }, - "Statuses":{ - "shape":"ExecutionStatusList", - "documentation":"

Filter executions by status. Valid values: RUNNING, SUCCEEDED, FAILED, TIMED_OUT, STOPPED.

", - "location":"querystring", - "locationName":"Statuses" - }, - "StartedAfter":{ - "shape":"ExecutionTimestamp", - "documentation":"

Filter executions that started after this timestamp (ISO 8601 format).

", - "location":"querystring", - "locationName":"StartedAfter" - }, - "StartedBefore":{ - "shape":"ExecutionTimestamp", - "documentation":"

Filter executions that started before this timestamp (ISO 8601 format).

", - "location":"querystring", - "locationName":"StartedBefore" - }, - "ReverseOrder":{ - "shape":"ReverseOrder", - "documentation":"

Set to true to return results in chronological order (oldest first). Default is false.

", - "location":"querystring", - "locationName":"ReverseOrder" - }, - "Marker":{ - "shape":"String", - "documentation":"

Pagination token from a previous request to continue retrieving results.

", - "location":"querystring", - "locationName":"Marker" - }, - "MaxItems":{ - "shape":"ItemCount", - "documentation":"

Maximum number of executions to return (1-1000). Default is 100.

", - "location":"querystring", - "locationName":"MaxItems" - } - } - }, - "ListDurableExecutionsByFunctionResponse":{ - "type":"structure", - "members":{ - "DurableExecutions":{ - "shape":"DurableExecutions", - "documentation":"

List of durable execution summaries matching the filter criteria.

" - }, - "NextMarker":{ - "shape":"String", - "documentation":"

Pagination token for retrieving additional results. Present only if there are more results available.

" - } - }, - "documentation":"

The response from the ListDurableExecutionsByFunction operation, containing a list of durable executions and pagination information.

" - }, - "ListEventSourceMappingsRequest":{ - "type":"structure", - "members":{ - "EventSourceArn":{ - "shape":"Arn", - "documentation":"

The Amazon Resource Name (ARN) of the event source.

  • Amazon Kinesis – The ARN of the data stream or a stream consumer.

  • Amazon DynamoDB Streams – The ARN of the stream.

  • Amazon Simple Queue Service – The ARN of the queue.

  • Amazon Managed Streaming for Apache Kafka – The ARN of the cluster or the ARN of the VPC connection (for cross-account event source mappings).

  • Amazon MQ – The ARN of the broker.

  • Amazon DocumentDB – The ARN of the DocumentDB change stream.

", - "location":"querystring", - "locationName":"EventSourceArn" - }, - "FunctionName":{ - "shape":"NamespacedFunctionName", - "documentation":"

The name or ARN of the Lambda function.

Name formats

  • Function name – MyFunction.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.

  • Partial ARN – 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.

", - "location":"querystring", - "locationName":"FunctionName" - }, - "Marker":{ - "shape":"String", - "documentation":"

A pagination token returned by a previous call.

", - "location":"querystring", - "locationName":"Marker" - }, - "MaxItems":{ - "shape":"MaxListItems", - "documentation":"

The maximum number of event source mappings to return. Note that ListEventSourceMappings returns a maximum of 100 items in each response, even if you set the number higher.

", - "location":"querystring", - "locationName":"MaxItems" - } - } - }, - "ListEventSourceMappingsResponse":{ - "type":"structure", - "members":{ - "NextMarker":{ - "shape":"String", - "documentation":"

A pagination token that's returned when the response doesn't contain all event source mappings.

" - }, - "EventSourceMappings":{ - "shape":"EventSourceMappingsList", - "documentation":"

A list of event source mappings.

" - } - } - }, - "ListFunctionEventInvokeConfigsRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "documentation":"

The name or ARN of the Lambda function.

Name formats

  • Function name - my-function.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN - 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "location":"uri", - "locationName":"FunctionName" - }, - "Marker":{ - "shape":"String", - "documentation":"

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

", - "location":"querystring", - "locationName":"Marker" - }, - "MaxItems":{ - "shape":"MaxFunctionEventInvokeConfigListItems", - "documentation":"

The maximum number of configurations to return.

", - "location":"querystring", - "locationName":"MaxItems" - } - } - }, - "ListFunctionEventInvokeConfigsResponse":{ - "type":"structure", - "members":{ - "FunctionEventInvokeConfigs":{ - "shape":"FunctionEventInvokeConfigList", - "documentation":"

A list of configurations.

" - }, - "NextMarker":{ - "shape":"String", - "documentation":"

The pagination token that's included if more results are available.

" - } - } - }, - "ListFunctionUrlConfigsRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"FunctionUrlFunctionName", - "documentation":"

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "location":"uri", - "locationName":"FunctionName" - }, - "Marker":{ - "shape":"String", - "documentation":"

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

", - "location":"querystring", - "locationName":"Marker" - }, - "MaxItems":{ - "shape":"MaxItems", - "documentation":"

The maximum number of function URLs to return in the response. Note that ListFunctionUrlConfigs returns a maximum of 50 items in each response, even if you set the number higher.

", - "location":"querystring", - "locationName":"MaxItems" - } - } - }, - "ListFunctionUrlConfigsResponse":{ - "type":"structure", - "required":["FunctionUrlConfigs"], - "members":{ - "FunctionUrlConfigs":{ - "shape":"FunctionUrlConfigList", - "documentation":"

A list of function URL configurations.

" - }, - "NextMarker":{ - "shape":"String", - "documentation":"

The pagination token that's included if more results are available.

" - } - } - }, - "ListFunctionVersionsByCapacityProviderRequest":{ - "type":"structure", - "required":["CapacityProviderName"], - "members":{ - "CapacityProviderName":{ - "shape":"CapacityProviderName", - "documentation":"

The name of the capacity provider to list function versions for.

", - "location":"uri", - "locationName":"CapacityProviderName" - }, - "Marker":{ - "shape":"String", - "documentation":"

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

", - "location":"querystring", - "locationName":"Marker" - }, - "MaxItems":{ - "shape":"MaxFiftyListItems", - "documentation":"

The maximum number of function versions to return in the response.

", - "location":"querystring", - "locationName":"MaxItems" - } - } - }, - "ListFunctionVersionsByCapacityProviderResponse":{ - "type":"structure", - "required":[ - "CapacityProviderArn", - "FunctionVersions" - ], - "members":{ - "CapacityProviderArn":{ - "shape":"CapacityProviderArn", - "documentation":"

The Amazon Resource Name (ARN) of the capacity provider.

" - }, - "FunctionVersions":{ - "shape":"FunctionVersionsByCapacityProviderList", - "documentation":"

A list of function versions that use the specified capacity provider.

" - }, - "NextMarker":{ - "shape":"String", - "documentation":"

The pagination token that's included if more results are available.

" - } - } - }, - "ListFunctionsByCodeSigningConfigRequest":{ - "type":"structure", - "required":["CodeSigningConfigArn"], - "members":{ - "CodeSigningConfigArn":{ - "shape":"CodeSigningConfigArn", - "documentation":"

The The Amazon Resource Name (ARN) of the code signing configuration.

", - "location":"uri", - "locationName":"CodeSigningConfigArn" - }, - "Marker":{ - "shape":"String", - "documentation":"

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

", - "location":"querystring", - "locationName":"Marker" - }, - "MaxItems":{ - "shape":"MaxListItems", - "documentation":"

Maximum number of items to return.

", - "location":"querystring", - "locationName":"MaxItems" - } - } - }, - "ListFunctionsByCodeSigningConfigResponse":{ - "type":"structure", - "members":{ - "NextMarker":{ - "shape":"String", - "documentation":"

The pagination token that's included if more results are available.

" - }, - "FunctionArns":{ - "shape":"FunctionArnList", - "documentation":"

The function ARNs.

" - } - } - }, - "ListFunctionsRequest":{ - "type":"structure", - "members":{ - "MasterRegion":{ - "shape":"MasterRegion", - "documentation":"

For Lambda@Edge functions, the Amazon Web Services Region of the master function. For example, us-east-1 filters the list of functions to include only Lambda@Edge functions replicated from a master function in US East (N. Virginia). If specified, you must set FunctionVersion to ALL.

", - "location":"querystring", - "locationName":"MasterRegion" - }, - "FunctionVersion":{ - "shape":"FunctionVersion", - "documentation":"

Set to ALL to include entries for all published versions of each function.

", - "location":"querystring", - "locationName":"FunctionVersion" - }, - "Marker":{ - "shape":"String", - "documentation":"

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

", - "location":"querystring", - "locationName":"Marker" - }, - "MaxItems":{ - "shape":"MaxListItems", - "documentation":"

The maximum number of functions to return in the response. Note that ListFunctions returns a maximum of 50 items in each response, even if you set the number higher.

", - "location":"querystring", - "locationName":"MaxItems" - } - } - }, - "ListFunctionsResponse":{ - "type":"structure", - "members":{ - "NextMarker":{ - "shape":"String", - "documentation":"

The pagination token that's included if more results are available.

" - }, - "Functions":{ - "shape":"FunctionList", - "documentation":"

A list of Lambda functions.

" - } - }, - "documentation":"

A list of Lambda functions.

" - }, - "ListLayerVersionsRequest":{ - "type":"structure", - "required":["LayerName"], - "members":{ - "CompatibleArchitecture":{ - "shape":"Architecture", - "documentation":"

The compatible instruction set architecture.

", - "location":"querystring", - "locationName":"CompatibleArchitecture" - }, - "CompatibleRuntime":{ - "shape":"Runtime", - "documentation":"

A runtime identifier.

The following list includes deprecated runtimes. For more information, see Runtime use after deprecation.

For a list of all currently supported runtimes, see Supported runtimes.

", - "location":"querystring", - "locationName":"CompatibleRuntime" - }, - "LayerName":{ - "shape":"LayerName", - "documentation":"

The name or Amazon Resource Name (ARN) of the layer.

", - "location":"uri", - "locationName":"LayerName" - }, - "Marker":{ - "shape":"String", - "documentation":"

A pagination token returned by a previous call.

", - "location":"querystring", - "locationName":"Marker" - }, - "MaxItems":{ - "shape":"MaxLayerListItems", - "documentation":"

The maximum number of versions to return.

", - "location":"querystring", - "locationName":"MaxItems" - } - } - }, - "ListLayerVersionsResponse":{ - "type":"structure", - "members":{ - "NextMarker":{ - "shape":"String", - "documentation":"

A pagination token returned when the response doesn't contain all versions.

" - }, - "LayerVersions":{ - "shape":"LayerVersionsList", - "documentation":"

A list of versions.

" - } - } - }, - "ListLayersRequest":{ - "type":"structure", - "members":{ - "CompatibleArchitecture":{ - "shape":"Architecture", - "documentation":"

The compatible instruction set architecture.

", - "location":"querystring", - "locationName":"CompatibleArchitecture" - }, - "CompatibleRuntime":{ - "shape":"Runtime", - "documentation":"

A runtime identifier.

The following list includes deprecated runtimes. For more information, see Runtime use after deprecation.

For a list of all currently supported runtimes, see Supported runtimes.

", - "location":"querystring", - "locationName":"CompatibleRuntime" - }, - "Marker":{ - "shape":"String", - "documentation":"

A pagination token returned by a previous call.

", - "location":"querystring", - "locationName":"Marker" - }, - "MaxItems":{ - "shape":"MaxLayerListItems", - "documentation":"

The maximum number of layers to return.

", - "location":"querystring", - "locationName":"MaxItems" - } - } - }, - "ListLayersResponse":{ - "type":"structure", - "members":{ - "NextMarker":{ - "shape":"String", - "documentation":"

A pagination token returned when the response doesn't contain all layers.

" - }, - "Layers":{ - "shape":"LayersList", - "documentation":"

A list of function layers.

" - } - } - }, - "ListProvisionedConcurrencyConfigsRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"FunctionName", - "documentation":"

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "location":"uri", - "locationName":"FunctionName" - }, - "Marker":{ - "shape":"String", - "documentation":"

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

", - "location":"querystring", - "locationName":"Marker" - }, - "MaxItems":{ - "shape":"MaxProvisionedConcurrencyConfigListItems", - "documentation":"

Specify a number to limit the number of configurations returned.

", - "location":"querystring", - "locationName":"MaxItems" - } - } - }, - "ListProvisionedConcurrencyConfigsResponse":{ - "type":"structure", - "members":{ - "ProvisionedConcurrencyConfigs":{ - "shape":"ProvisionedConcurrencyConfigList", - "documentation":"

A list of provisioned concurrency configurations.

" - }, - "NextMarker":{ - "shape":"String", - "documentation":"

The pagination token that's included if more results are available.

" - } - } - }, - "ListTagsRequest":{ - "type":"structure", - "required":["Resource"], - "members":{ - "Resource":{ - "shape":"TaggableResource", - "documentation":"

The resource's Amazon Resource Name (ARN). Note: Lambda does not support adding tags to function aliases or versions.

", - "location":"uri", - "locationName":"Resource" - } - } - }, - "ListTagsResponse":{ - "type":"structure", - "members":{ - "Tags":{ - "shape":"Tags", - "documentation":"

The function's tags.

" - } - } - }, - "ListVersionsByFunctionRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "documentation":"

The name or ARN of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "location":"uri", - "locationName":"FunctionName" - }, - "Marker":{ - "shape":"String", - "documentation":"

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

", - "location":"querystring", - "locationName":"Marker" - }, - "MaxItems":{ - "shape":"MaxListItems", - "documentation":"

The maximum number of versions to return. Note that ListVersionsByFunction returns a maximum of 50 items in each response, even if you set the number higher.

", - "location":"querystring", - "locationName":"MaxItems" - } - } - }, - "ListVersionsByFunctionResponse":{ - "type":"structure", - "members":{ - "NextMarker":{ - "shape":"String", - "documentation":"

The pagination token that's included if more results are available.

" - }, - "Versions":{ - "shape":"FunctionList", - "documentation":"

A list of Lambda function versions.

" - } - } - }, - "LocalMountPath":{ - "type":"string", - "max":160, - "min":0, - "pattern":"/mnt/[a-zA-Z0-9-_.]+" - }, - "LogFormat":{ - "type":"string", - "enum":[ - "JSON", - "Text" - ] - }, - "LogGroup":{ - "type":"string", - "max":512, - "min":1, - "pattern":"[\\.\\-_/#A-Za-z0-9]+" - }, - "LogType":{ - "type":"string", - "enum":[ - "None", - "Tail" - ] - }, - "LoggingConfig":{ - "type":"structure", - "members":{ - "LogFormat":{ - "shape":"LogFormat", - "documentation":"

The format in which Lambda sends your function's application and system logs to CloudWatch. Select between plain text and structured JSON.

" - }, - "ApplicationLogLevel":{ - "shape":"ApplicationLogLevel", - "documentation":"

Set this property to filter the application logs for your function that Lambda sends to CloudWatch. Lambda only sends application logs at the selected level of detail and lower, where TRACE is the highest level and FATAL is the lowest.

" - }, - "SystemLogLevel":{ - "shape":"SystemLogLevel", - "documentation":"

Set this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the selected level of detail and lower, where DEBUG is the highest level and WARN is the lowest.

" - }, - "LogGroup":{ - "shape":"LogGroup", - "documentation":"

The name of the Amazon CloudWatch log group the function sends logs to. By default, Lambda functions send logs to a default log group named /aws/lambda/<function name>. To use a different log group, enter an existing log group or enter a new log group name.

" - } - }, - "documentation":"

The function's Amazon CloudWatch Logs configuration settings.

" - }, - "Long":{"type":"long"}, - "MasterRegion":{ - "type":"string", - "max":50, - "min":1, - "pattern":"ALL|(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}" - }, - "MaxAge":{ - "type":"integer", - "box":true, - "max":86400, - "min":0 - }, - "MaxFiftyListItems":{ - "type":"integer", - "box":true, - "max":50, - "min":1 - }, - "MaxFunctionEventInvokeConfigListItems":{ - "type":"integer", - "box":true, - "max":50, - "min":1 - }, - "MaxItems":{ - "type":"integer", - "box":true, - "max":50, - "min":1 - }, - "MaxLayerListItems":{ - "type":"integer", - "box":true, - "max":50, - "min":1 - }, - "MaxListItems":{ - "type":"integer", - "box":true, - "max":10000, - "min":1 - }, - "MaxProvisionedConcurrencyConfigListItems":{ - "type":"integer", - "box":true, - "max":50, - "min":1 - }, - "MaximumBatchingWindowInSeconds":{ - "type":"integer", - "box":true, - "max":300, - "min":0 - }, - "MaximumConcurrency":{ - "type":"integer", - "box":true, - "max":1000, - "min":2 - }, - "MaximumEventAgeInSeconds":{ - "type":"integer", - "box":true, - "max":21600, - "min":60 - }, - "MaximumNumberOfPollers":{ - "type":"integer", - "box":true, - "max":10000, - "min":1 - }, - "MaximumRecordAgeInSeconds":{ - "type":"integer", - "box":true, - "max":604800, - "min":-1 - }, - "MaximumRetryAttempts":{ - "type":"integer", - "box":true, - "max":2, - "min":0 - }, - "MaximumRetryAttemptsEventSourceMapping":{ - "type":"integer", - "box":true, - "max":10000, - "min":-1 - }, - "MemorySize":{ - "type":"integer", - "box":true, - "max":32768, - "min":128 - }, - "Method":{ - "type":"string", - "max":6, - "min":0, - "pattern":".*" - }, - "MetricTargetValue":{ - "type":"double", - "box":true, - "max":100, - "min":0 - }, - "MinimumNumberOfPollers":{ - "type":"integer", - "box":true, - "max":200, - "min":1 - }, - "ModeNotSupportedException":{ - "type":"structure", - "members":{ - "Type":{ - "shape":"String", - "documentation":"

The exception type.

" - }, - "message":{ - "shape":"String", - "documentation":"

The exception message.

" - } - }, - "documentation":"

The Lambda function doesn't support the invocation mode requested. For example, calling Invoke with InvocationType=RequestResponse on a function configured for asynchronous-only invocation, or vice versa. For more information about invocation types, see Invoking Lambda functions.

", - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "NameSpacedFunctionArn":{ - "type":"string", - "max":10000, - "min":0, - "pattern":"arn:(aws[a-zA-Z-]*)?:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_\\.]+(:(\\$LATEST(\\.PUBLISHED)?|[a-zA-Z0-9-_]+))?" - }, - "NamespacedFunctionName":{ - "type":"string", - "max":256, - "min":1, - "pattern":"(arn:(aws[a-zA-Z-]*)?:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:|(((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:)?(\\d{12}:)?))(function:)?([a-zA-Z0-9-_\\.]+)(:(\\$LATEST(\\.PUBLISHED)?|[a-zA-Z0-9-_]+))?" - }, - "NamespacedStatementId":{ - "type":"string", - "max":100, - "min":1, - "pattern":"([a-zA-Z0-9-_.]+)" - }, - "NoPublishedVersionException":{ - "type":"structure", - "members":{ - "Type":{ - "shape":"String", - "documentation":"

The exception type.

" - }, - "Message":{"shape":"String"} - }, - "documentation":"

The function has no published versions available.

", - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "NonNegativeInteger":{ - "type":"integer", - "box":true, - "min":0 - }, - "NullableBoolean":{ - "type":"boolean", - "box":true - }, - "NumericLatestPublishedOrAliasQualifier":{ - "type":"string", - "max":128, - "min":1, - "pattern":"\\$(LATEST(\\.PUBLISHED)?)|[a-zA-Z0-9-_$]+" - }, - "OnFailure":{ - "type":"structure", - "members":{ - "Destination":{ - "shape":"DestinationArn", - "documentation":"

The Amazon Resource Name (ARN) of the destination resource.

To retain records of failed invocations from Kinesis, DynamoDB, self-managed Apache Kafka, or Amazon MSK, you can configure an Amazon SNS topic, Amazon SQS queue, Amazon S3 bucket, or Kafka topic as the destination.

Amazon SNS destinations have a message size limit of 256 KB. If the combined size of the function request and response payload exceeds the limit, Lambda will drop the payload when sending OnFailure event to the destination. For details on this behavior, refer to Retaining records of asynchronous invocations.

To retain records of failed invocations from Kinesis, DynamoDB, self-managed Kafka or Amazon MSK, you can configure an Amazon SNS topic, Amazon SQS queue, or Amazon S3 bucket as the destination.

" - } - }, - "documentation":"

A destination for events that failed processing. For more information, see Adding a destination.

" - }, - "OnSuccess":{ - "type":"structure", - "members":{ - "Destination":{ - "shape":"DestinationArn", - "documentation":"

The Amazon Resource Name (ARN) of the destination resource.

Amazon SNS destinations have a message size limit of 256 KB. If the combined size of the function request and response payload exceeds the limit, Lambda will drop the payload when sending OnFailure event to the destination. For details on this behavior, refer to Retaining records of asynchronous invocations.

" - } - }, - "documentation":"

A destination for events that were processed successfully.

To retain records of successful asynchronous invocations, you can configure an Amazon SNS topic, Amazon SQS queue, Lambda function, or Amazon EventBridge event bus as the destination.

OnSuccess is not supported in CreateEventSourceMapping or UpdateEventSourceMapping requests.

" - }, - "Operation":{ - "type":"structure", - "required":[ - "Id", - "Type", - "StartTimestamp", - "Status" - ], - "members":{ - "Id":{ - "shape":"OperationId", - "documentation":"

The unique identifier for this operation.

" - }, - "ParentId":{ - "shape":"OperationId", - "documentation":"

The unique identifier of the parent operation, if this operation is running within a child context.

" - }, - "Name":{ - "shape":"OperationName", - "documentation":"

The customer-provided name for this operation.

" - }, - "Type":{ - "shape":"OperationType", - "documentation":"

The type of operation.

" - }, - "SubType":{ - "shape":"OperationSubType", - "documentation":"

The subtype of the operation, providing additional categorization.

" - }, - "StartTimestamp":{ - "shape":"ExecutionTimestamp", - "documentation":"

The date and time when the operation started, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" - }, - "EndTimestamp":{ - "shape":"ExecutionTimestamp", - "documentation":"

The date and time when the operation ended, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" - }, - "Status":{ - "shape":"OperationStatus", - "documentation":"

The current status of the operation.

" - }, - "ExecutionDetails":{ - "shape":"ExecutionDetails", - "documentation":"

Details about the execution, if this operation represents an execution.

" - }, - "ContextDetails":{ - "shape":"ContextDetails", - "documentation":"

Details about the context, if this operation represents a context.

" - }, - "StepDetails":{ - "shape":"StepDetails", - "documentation":"

Details about the step, if this operation represents a step.

" - }, - "WaitDetails":{ - "shape":"WaitDetails", - "documentation":"

Details about the wait operation, if this operation represents a wait.

" - }, - "CallbackDetails":{"shape":"CallbackDetails"}, - "ChainedInvokeDetails":{"shape":"ChainedInvokeDetails"} - }, - "documentation":"

Information about an operation within a durable execution.

" - }, - "OperationAction":{ - "type":"string", - "enum":[ - "START", - "SUCCEED", - "FAIL", - "RETRY", - "CANCEL" - ] - }, - "OperationId":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[a-zA-Z0-9-_]+" - }, - "OperationName":{ - "type":"string", - "max":256, - "min":1, - "pattern":"[\\x20-\\x7E]+" - }, - "OperationPayload":{ - "type":"string", - "max":6291456, - "min":0, - "sensitive":true - }, - "OperationStatus":{ - "type":"string", - "enum":[ - "STARTED", - "PENDING", - "READY", - "SUCCEEDED", - "FAILED", - "CANCELLED", - "TIMED_OUT", - "STOPPED" - ] - }, - "OperationSubType":{ - "type":"string", - "max":32, - "min":1, - "pattern":"[a-zA-Z0-9-_]+" - }, - "OperationType":{ - "type":"string", - "enum":[ - "EXECUTION", - "CONTEXT", - "STEP", - "WAIT", - "CALLBACK", - "CHAINED_INVOKE" - ] - }, - "OperationUpdate":{ - "type":"structure", - "required":[ - "Id", - "Type", - "Action" - ], - "members":{ - "Id":{ - "shape":"OperationId", - "documentation":"

The unique identifier for this operation.

" - }, - "ParentId":{ - "shape":"OperationId", - "documentation":"

The unique identifier of the parent operation, if this operation is running within a child context.

" - }, - "Name":{ - "shape":"OperationName", - "documentation":"

The customer-provided name for this operation.

" - }, - "Type":{ - "shape":"OperationType", - "documentation":"

The type of operation to update.

" - }, - "SubType":{ - "shape":"OperationSubType", - "documentation":"

The subtype of the operation, providing additional categorization.

" - }, - "Action":{ - "shape":"OperationAction", - "documentation":"

The action to take on the operation.

" - }, - "Payload":{ - "shape":"OperationPayload", - "documentation":"

The payload for successful operations. The maximum payload size is 6 MB for synchronous EXECUTION operations (RequestResponse invocationType), 1 MB for asynchronous EXECUTION (Event invocationType) and CHAINED_INVOKE operations, and 256 KB for CONTEXT, STEP, WAIT, and CALLBACK operations.

" - }, - "Error":{ - "shape":"ErrorObject", - "documentation":"

The error information for failed operations.

" - }, - "ContextOptions":{ - "shape":"ContextOptions", - "documentation":"

Options for context operations.

" - }, - "StepOptions":{ - "shape":"StepOptions", - "documentation":"

Options for step operations.

" - }, - "WaitOptions":{ - "shape":"WaitOptions", - "documentation":"

Options for wait operations.

" - }, - "CallbackOptions":{"shape":"CallbackOptions"}, - "ChainedInvokeOptions":{"shape":"ChainedInvokeOptions"} - }, - "documentation":"

An update to be applied to an operation during checkpointing.

" - }, - "OperationUpdates":{ - "type":"list", - "member":{"shape":"OperationUpdate"} - }, - "Operations":{ - "type":"list", - "member":{"shape":"Operation"} - }, - "OrganizationId":{ - "type":"string", - "max":34, - "min":0, - "pattern":"o-[a-z0-9]{10,32}" - }, - "Origin":{ - "type":"string", - "max":253, - "min":1, - "pattern":".*" - }, - "OutputPayload":{ - "type":"string", - "max":6291456, - "min":0, - "sensitive":true - }, - "PackageType":{ - "type":"string", - "enum":[ - "Zip", - "Image" - ] - }, - "ParallelizationFactor":{ - "type":"integer", - "box":true, - "max":10, - "min":1 - }, - "Pattern":{ - "type":"string", - "max":4096, - "min":0, - "pattern":"[\\s\\S]*" - }, - "PerExecutionEnvironmentMaxConcurrency":{ - "type":"integer", - "box":true, - "max":1600, - "min":1 - }, - "PolicyLengthExceededException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "message":{"shape":"String"} - }, - "documentation":"

The permissions policy for the resource is too large. For more information, see Lambda quotas.

", - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "PositiveInteger":{ - "type":"integer", - "box":true, - "min":1 - }, - "PreconditionFailedException":{ - "type":"structure", - "members":{ - "Type":{ - "shape":"String", - "documentation":"

The exception type.

" - }, - "message":{ - "shape":"String", - "documentation":"

The exception message.

" - } - }, - "documentation":"

The RevisionId provided does not match the latest RevisionId for the Lambda function or alias.

  • For AddPermission and RemovePermission API operations: Call GetPolicy to retrieve the latest RevisionId for your resource.

  • For all other API operations: Call GetFunction or GetAlias to retrieve the latest RevisionId for your resource.

", - "error":{ - "httpStatusCode":412, - "senderFault":true - }, - "exception":true - }, - "Principal":{ - "type":"string", - "max":2048, - "min":0, - "pattern":"[^\\s]+" - }, - "PrincipalOrgID":{ - "type":"string", - "max":34, - "min":12, - "pattern":"o-[a-z0-9]{10,32}" - }, - "PropagateTags":{ - "type":"structure", - "members":{ - "Mode":{ - "shape":"PropagateTagsMode", - "documentation":"

The tag propagation mode. Set to Explicit to propagate the tags specified in ExplicitTags to managed resources. Set to None to disable tag propagation.

" - }, - "ExplicitTags":{ - "shape":"PropagateTagsExplicitTagsMap", - "documentation":"

A list of tags to apply to managed resources when Mode is set to Explicit. You can specify up to 40 tags.

" - } - }, - "documentation":"

Configuration for tag propagation to managed resources launched by the capacity provider.

" - }, - "PropagateTagsExplicitTagsMap":{ - "type":"map", - "key":{"shape":"TagKey"}, - "value":{"shape":"TagValue"}, - "max":40, - "min":0 - }, - "PropagateTagsMode":{ - "type":"string", - "enum":[ - "None", - "Explicit" - ] - }, - "ProvisionedConcurrencyConfigList":{ - "type":"list", - "member":{"shape":"ProvisionedConcurrencyConfigListItem"} - }, - "ProvisionedConcurrencyConfigListItem":{ - "type":"structure", - "members":{ - "FunctionArn":{ - "shape":"FunctionArn", - "documentation":"

The Amazon Resource Name (ARN) of the alias or version.

" - }, - "RequestedProvisionedConcurrentExecutions":{ - "shape":"PositiveInteger", - "documentation":"

The amount of provisioned concurrency requested.

" - }, - "AvailableProvisionedConcurrentExecutions":{ - "shape":"NonNegativeInteger", - "documentation":"

The amount of provisioned concurrency available.

" - }, - "AllocatedProvisionedConcurrentExecutions":{ - "shape":"NonNegativeInteger", - "documentation":"

The amount of provisioned concurrency allocated. When a weighted alias is used during linear and canary deployments, this value fluctuates depending on the amount of concurrency that is provisioned for the function versions.

" - }, - "Status":{ - "shape":"ProvisionedConcurrencyStatusEnum", - "documentation":"

The status of the allocation process.

" - }, - "StatusReason":{ - "shape":"String", - "documentation":"

For failed allocations, the reason that provisioned concurrency could not be allocated.

" - }, - "LastModified":{ - "shape":"Timestamp", - "documentation":"

The date and time that a user last updated the configuration, in ISO 8601 format.

" - } - }, - "documentation":"

Details about the provisioned concurrency configuration for a function alias or version.

" - }, - "ProvisionedConcurrencyConfigNotFoundException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "message":{"shape":"String"} - }, - "documentation":"

The specified configuration does not exist.

", - "error":{ - "httpStatusCode":404, - "senderFault":true - }, - "exception":true - }, - "ProvisionedConcurrencyStatusEnum":{ - "type":"string", - "enum":[ - "IN_PROGRESS", - "READY", - "FAILED" - ] - }, - "ProvisionedPollerConfig":{ - "type":"structure", - "members":{ - "MinimumPollers":{ - "shape":"MinimumNumberOfPollers", - "documentation":"

The minimum number of event pollers this event source can scale down to. For Amazon SQS events source mappings, default is 2, and minimum 2 required. For Amazon MSK and self-managed Apache Kafka event source mappings, default is 1.

" - }, - "MaximumPollers":{ - "shape":"MaximumNumberOfPollers", - "documentation":"

The maximum number of event pollers this event source can scale up to. For Amazon SQS events source mappings, default is 200, and minimum value allowed is 2. For Amazon MSK and self-managed Apache Kafka event source mappings, default is 200, and minimum value allowed is 1.

" - }, - "PollerGroupName":{ - "shape":"ProvisionedPollerGroupName", - "documentation":"

(Amazon MSK and self-managed Apache Kafka) The name of the provisioned poller group. Use this option to group multiple ESMs within the event source's VPC to share Event Poller Unit (EPU) capacity. You can use this option to optimize Provisioned mode costs for your ESMs. You can group up to 100 ESMs per poller group and aggregate maximum pollers across all ESMs in a group cannot exceed 2000.

" - } - }, - "documentation":"

The provisioned mode configuration for the event source. Use Provisioned Mode to customize the minimum and maximum number of event pollers for your event source.

" - }, - "ProvisionedPollerGroupName":{ - "type":"string", - "max":128, - "min":0, - "pattern":"[a-zA-Z0-9-_]*" - }, - "PublicPolicyException":{ - "type":"structure", - "members":{ - "Type":{ - "shape":"String", - "documentation":"

The exception type.

" - }, - "Message":{ - "shape":"String", - "documentation":"

The exception message.

" - } - }, - "documentation":"

The resource-based policy you tried to add to the Lambda function would grant public access to it, and your account's BlockPublicAccess setting prevents public access. For more information about blocking public access to Lambda functions, see Block public access to Lambda resources.

", - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "PublishLayerVersionRequest":{ - "type":"structure", - "required":[ - "LayerName", - "Content" - ], - "members":{ - "LayerName":{ - "shape":"LayerName", - "documentation":"

The name or Amazon Resource Name (ARN) of the layer.

", - "location":"uri", - "locationName":"LayerName" - }, - "Description":{ - "shape":"Description", - "documentation":"

The description of the version.

" - }, - "Content":{ - "shape":"LayerVersionContentInput", - "documentation":"

The function layer archive.

" - }, - "CompatibleArchitectures":{ - "shape":"CompatibleArchitectures", - "documentation":"

A list of compatible instruction set architectures.

" - }, - "CompatibleRuntimes":{ - "shape":"CompatibleRuntimes", - "documentation":"

A list of compatible function runtimes. Used for filtering with ListLayers and ListLayerVersions.

The following list includes deprecated runtimes. For more information, see Runtime deprecation policy.

" - }, - "LicenseInfo":{ - "shape":"LicenseInfo", - "documentation":"

The layer's software license. It can be any of the following:

  • An SPDX license identifier. For example, MIT.

  • The URL of a license hosted on the internet. For example, https://opensource.org/licenses/MIT.

  • The full text of the license.

" - } - } - }, - "PublishLayerVersionResponse":{ - "type":"structure", - "members":{ - "Content":{ - "shape":"LayerVersionContentOutput", - "documentation":"

Details about the layer version.

" - }, - "LayerArn":{ - "shape":"LayerArn", - "documentation":"

The ARN of the layer.

" - }, - "LayerVersionArn":{ - "shape":"LayerVersionArn", - "documentation":"

The ARN of the layer version.

" - }, - "Description":{ - "shape":"Description", - "documentation":"

The description of the version.

" - }, - "CreatedDate":{ - "shape":"Timestamp", - "documentation":"

The date that the layer version was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" - }, - "Version":{ - "shape":"LayerVersionNumber", - "documentation":"

The version number.

" - }, - "CompatibleArchitectures":{ - "shape":"CompatibleArchitectures", - "documentation":"

A list of compatible instruction set architectures.

" - }, - "CompatibleRuntimes":{ - "shape":"CompatibleRuntimes", - "documentation":"

The layer's compatible runtimes.

The following list includes deprecated runtimes. For more information, see Runtime use after deprecation.

For a list of all currently supported runtimes, see Supported runtimes.

" - }, - "LicenseInfo":{ - "shape":"LicenseInfo", - "documentation":"

The layer's software license.

" - } - } - }, - "PublishVersionRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"FunctionName", - "documentation":"

The name or ARN of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "location":"uri", - "locationName":"FunctionName" - }, - "CodeSha256":{ - "shape":"String", - "documentation":"

Only publish a version if the hash value matches the value that's specified. Use this option to avoid publishing a version if the function code has changed since you last updated it. You can get the hash for the version that you uploaded from the output of UpdateFunctionCode.

" - }, - "Description":{ - "shape":"Description", - "documentation":"

A description for the version to override the description in the function configuration.

" - }, - "RevisionId":{ - "shape":"String", - "documentation":"

Only update the function if the revision ID matches the ID that's specified. Use this option to avoid publishing a version if the function configuration has changed since you last updated it.

" - }, - "PublishTo":{ - "shape":"FunctionVersionLatestPublished", - "documentation":"

Specifies where to publish the function version or configuration.

" - } - } - }, - "PublishedFunctionQualifier":{ - "type":"string", - "max":128, - "min":1, - "pattern":"(\\$LATEST\\.PUBLISHED|[0-9]+)" - }, - "PutFunctionCodeSigningConfigRequest":{ - "type":"structure", - "required":[ - "CodeSigningConfigArn", - "FunctionName" - ], - "members":{ - "CodeSigningConfigArn":{ - "shape":"CodeSigningConfigArn", - "documentation":"

The The Amazon Resource Name (ARN) of the code signing configuration.

" - }, - "FunctionName":{ - "shape":"NamespacedFunctionName", - "documentation":"

The name or ARN of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "location":"uri", - "locationName":"FunctionName" - } - } - }, - "PutFunctionCodeSigningConfigResponse":{ - "type":"structure", - "required":[ - "CodeSigningConfigArn", - "FunctionName" - ], - "members":{ - "CodeSigningConfigArn":{ - "shape":"CodeSigningConfigArn", - "documentation":"

The The Amazon Resource Name (ARN) of the code signing configuration.

" - }, - "FunctionName":{ - "shape":"FunctionName", - "documentation":"

The name or ARN of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

" - } - } - }, - "PutFunctionConcurrencyRequest":{ - "type":"structure", - "required":[ - "FunctionName", - "ReservedConcurrentExecutions" - ], - "members":{ - "FunctionName":{ - "shape":"FunctionName", - "documentation":"

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "location":"uri", - "locationName":"FunctionName" - }, - "ReservedConcurrentExecutions":{ - "shape":"ReservedConcurrentExecutions", - "documentation":"

The number of simultaneous executions to reserve for the function.

" - } - } - }, - "PutFunctionEventInvokeConfigRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "documentation":"

The name or ARN of the Lambda function, version, or alias.

Name formats

  • Function name - my-function (name-only), my-function:v1 (with alias).

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN - 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "location":"uri", - "locationName":"FunctionName" - }, - "Qualifier":{ - "shape":"NumericLatestPublishedOrAliasQualifier", - "documentation":"

A version number or alias name.

", - "location":"querystring", - "locationName":"Qualifier" - }, - "MaximumRetryAttempts":{ - "shape":"MaximumRetryAttempts", - "documentation":"

The maximum number of times to retry when the function returns an error.

" - }, - "MaximumEventAgeInSeconds":{ - "shape":"MaximumEventAgeInSeconds", - "documentation":"

The maximum age of a request that Lambda sends to a function for processing.

" - }, - "DestinationConfig":{ - "shape":"DestinationConfig", - "documentation":"

A destination for events after they have been sent to a function for processing.

Destinations

  • Function - The Amazon Resource Name (ARN) of a Lambda function.

  • Queue - The ARN of a standard SQS queue.

  • Bucket - The ARN of an Amazon S3 bucket.

  • Topic - The ARN of a standard SNS topic.

  • Event Bus - The ARN of an Amazon EventBridge event bus.

S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type.

" - } - } - }, - "PutFunctionRecursionConfigRequest":{ - "type":"structure", - "required":[ - "FunctionName", - "RecursiveLoop" - ], - "members":{ - "FunctionName":{ - "shape":"UnqualifiedFunctionName", - "documentation":"

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "location":"uri", - "locationName":"FunctionName" - }, - "RecursiveLoop":{ - "shape":"RecursiveLoop", - "documentation":"

If you set your function's recursive loop detection configuration to Allow, Lambda doesn't take any action when it detects your function being invoked as part of a recursive loop. We recommend that you only use this setting if your design intentionally uses a Lambda function to write data back to the same Amazon Web Services resource that invokes it.

If you set your function's recursive loop detection configuration to Terminate, Lambda stops your function being invoked and notifies you when it detects your function being invoked as part of a recursive loop.

By default, Lambda sets your function's configuration to Terminate.

If your design intentionally uses a Lambda function to write data back to the same Amazon Web Services resource that invokes the function, then use caution and implement suitable guard rails to prevent unexpected charges being billed to your Amazon Web Services account. To learn more about best practices for using recursive invocation patterns, see Recursive patterns that cause run-away Lambda functions in Serverless Land.

" - } - } - }, - "PutFunctionRecursionConfigResponse":{ - "type":"structure", - "members":{ - "RecursiveLoop":{ - "shape":"RecursiveLoop", - "documentation":"

The status of your function's recursive loop detection configuration.

When this value is set to Allowand Lambda detects your function being invoked as part of a recursive loop, it doesn't take any action.

When this value is set to Terminate and Lambda detects your function being invoked as part of a recursive loop, it stops your function being invoked and notifies you.

" - } - } - }, - "PutFunctionScalingConfigRequest":{ - "type":"structure", - "required":[ - "FunctionName", - "Qualifier" - ], - "members":{ - "FunctionName":{ - "shape":"UnqualifiedFunctionName", - "documentation":"

The name or ARN of the Lambda function.

", - "location":"uri", - "locationName":"FunctionName" - }, - "Qualifier":{ - "shape":"PublishedFunctionQualifier", - "documentation":"

Specify a version or alias to set the scaling configuration for a published version of the function.

", - "location":"querystring", - "locationName":"Qualifier" - }, - "FunctionScalingConfig":{ - "shape":"FunctionScalingConfig", - "documentation":"

The scaling configuration to apply to the function, including minimum and maximum execution environment limits.

" - } - } - }, - "PutFunctionScalingConfigResponse":{ - "type":"structure", - "members":{ - "FunctionState":{ - "shape":"State", - "documentation":"

The current state of the function after applying the scaling configuration.

" - } - } - }, - "PutProvisionedConcurrencyConfigRequest":{ - "type":"structure", - "required":[ - "FunctionName", - "Qualifier", - "ProvisionedConcurrentExecutions" - ], - "members":{ - "FunctionName":{ - "shape":"FunctionName", - "documentation":"

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "location":"uri", - "locationName":"FunctionName" - }, - "Qualifier":{ - "shape":"Qualifier", - "documentation":"

The version number or alias name.

", - "location":"querystring", - "locationName":"Qualifier" - }, - "ProvisionedConcurrentExecutions":{ - "shape":"PositiveInteger", - "documentation":"

The amount of provisioned concurrency to allocate for the version or alias.

" - } - } - }, - "PutProvisionedConcurrencyConfigResponse":{ - "type":"structure", - "members":{ - "RequestedProvisionedConcurrentExecutions":{ - "shape":"PositiveInteger", - "documentation":"

The amount of provisioned concurrency requested.

" - }, - "AllocatedProvisionedConcurrentExecutions":{ - "shape":"NonNegativeInteger", - "documentation":"

The amount of provisioned concurrency allocated. When a weighted alias is used during linear and canary deployments, this value fluctuates depending on the amount of concurrency that is provisioned for the function versions.

" - }, - "AvailableProvisionedConcurrentExecutions":{ - "shape":"NonNegativeInteger", - "documentation":"

The amount of provisioned concurrency available.

" - }, - "Status":{ - "shape":"ProvisionedConcurrencyStatusEnum", - "documentation":"

The status of the allocation process.

" - }, - "StatusReason":{ - "shape":"String", - "documentation":"

For failed allocations, the reason that provisioned concurrency could not be allocated.

" - }, - "LastModified":{ - "shape":"Timestamp", - "documentation":"

The date and time that a user last updated the configuration, in ISO 8601 format.

" - } - } - }, - "PutRuntimeManagementConfigRequest":{ - "type":"structure", - "required":[ - "FunctionName", - "UpdateRuntimeOn" - ], - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "documentation":"

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "location":"uri", - "locationName":"FunctionName" - }, - "Qualifier":{ - "shape":"NumericLatestPublishedOrAliasQualifier", - "documentation":"

Specify a version of the function. This can be $LATEST or a published version number. If no value is specified, the configuration for the $LATEST version is returned.

", - "location":"querystring", - "locationName":"Qualifier" - }, - "UpdateRuntimeOn":{ - "shape":"UpdateRuntimeOn", - "documentation":"

Specify the runtime update mode.

  • Auto (default) - Automatically update to the most recent and secure runtime version using a Two-phase runtime version rollout. This is the best choice for most customers to ensure they always benefit from runtime updates.

  • Function update - Lambda updates the runtime of your function to the most recent and secure runtime version when you update your function. This approach synchronizes runtime updates with function deployments, giving you control over when runtime updates are applied and allowing you to detect and mitigate rare runtime update incompatibilities early. When using this setting, you need to regularly update your functions to keep their runtime up-to-date.

  • Manual - You specify a runtime version in your function configuration. The function will use this runtime version indefinitely. In the rare case where a new runtime version is incompatible with an existing function, this allows you to roll back your function to an earlier runtime version. For more information, see Roll back a runtime version.

" - }, - "RuntimeVersionArn":{ - "shape":"RuntimeVersionArn", - "documentation":"

The ARN of the runtime version you want the function to use.

This is only required if you're using the Manual runtime update mode.

" - } - } - }, - "PutRuntimeManagementConfigResponse":{ - "type":"structure", - "required":[ - "UpdateRuntimeOn", - "FunctionArn" - ], - "members":{ - "UpdateRuntimeOn":{ - "shape":"UpdateRuntimeOn", - "documentation":"

The runtime update mode.

" - }, - "FunctionArn":{ - "shape":"FunctionArn", - "documentation":"

The ARN of the function

" - }, - "RuntimeVersionArn":{ - "shape":"RuntimeVersionArn", - "documentation":"

The ARN of the runtime the function is configured to use. If the runtime update mode is manual, the ARN is returned, otherwise null is returned.

" - } - } - }, - "Qualifier":{ - "type":"string", - "max":128, - "min":1, - "pattern":"(|[a-zA-Z0-9$_-]+)" - }, - "Queue":{ - "type":"string", - "max":1000, - "min":1, - "pattern":"[\\s\\S]*" - }, - "Queues":{ - "type":"list", - "member":{"shape":"Queue"}, - "max":1, - "min":1 - }, - "RecursiveInvocationException":{ - "type":"structure", - "members":{ - "Type":{ - "shape":"String", - "documentation":"

The exception type.

" - }, - "Message":{ - "shape":"String", - "documentation":"

The exception message.

" - } - }, - "documentation":"

Lambda has detected your function being invoked in a recursive loop with other Amazon Web Services resources and stopped your function's invocation.

", - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "RecursiveLoop":{ - "type":"string", - "enum":[ - "Allow", - "Terminate" - ] - }, - "RemoveLayerVersionPermissionRequest":{ - "type":"structure", - "required":[ - "LayerName", - "VersionNumber", - "StatementId" - ], - "members":{ - "LayerName":{ - "shape":"LayerName", - "documentation":"

The name or Amazon Resource Name (ARN) of the layer.

", - "location":"uri", - "locationName":"LayerName" - }, - "VersionNumber":{ - "shape":"LayerVersionNumber", - "documentation":"

The version number.

", - "location":"uri", - "locationName":"VersionNumber" - }, - "StatementId":{ - "shape":"StatementId", - "documentation":"

The identifier that was specified when the statement was added.

", - "location":"uri", - "locationName":"StatementId" - }, - "RevisionId":{ - "shape":"String", - "documentation":"

Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a policy that has changed since you last read it.

", - "location":"querystring", - "locationName":"RevisionId" - } - } - }, - "RemovePermissionRequest":{ - "type":"structure", - "required":[ - "FunctionName", - "StatementId" - ], - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "documentation":"

The name or ARN of the Lambda function, version, or alias.

Name formats

  • Function name – my-function (name-only), my-function:v1 (with alias).

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "location":"uri", - "locationName":"FunctionName" - }, - "StatementId":{ - "shape":"NamespacedStatementId", - "documentation":"

Statement ID of the permission to remove.

", - "location":"uri", - "locationName":"StatementId" - }, - "Qualifier":{ - "shape":"NumericLatestPublishedOrAliasQualifier", - "documentation":"

Specify a version or alias to remove permissions from a published version of the function.

", - "location":"querystring", - "locationName":"Qualifier" - }, - "RevisionId":{ - "shape":"String", - "documentation":"

Update the policy only if the revision ID matches the ID that's specified. Use this option to avoid modifying a policy that has changed since you last read it.

", - "location":"querystring", - "locationName":"RevisionId" - } - } - }, - "ReplayChildren":{ - "type":"boolean", - "box":true - }, - "RequestTooLargeException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "message":{"shape":"String"} - }, - "documentation":"

The request payload exceeded the Invoke request body JSON input quota. For more information, see Lambda quotas.

", - "error":{ - "httpStatusCode":413, - "senderFault":true - }, - "exception":true - }, - "ReservedConcurrentExecutions":{ - "type":"integer", - "box":true, - "min":0 - }, - "ResolvedS3Object":{ - "type":"structure", - "members":{ - "S3Bucket":{ - "shape":"S3Bucket", - "documentation":"

The Amazon S3 bucket that contains the deployment package.

" - }, - "S3Key":{ - "shape":"S3Key", - "documentation":"

The Amazon S3 key of the deployment package.

" - }, - "S3ObjectVersion":{ - "shape":"S3ObjectVersion", - "documentation":"

The version of the deployment package object.

" - } - }, - "documentation":"

Details about the resolved Amazon S3 object that contains a function's deployment package.

" - }, - "ResourceArn":{ - "type":"string", - "max":10000, - "min":0, - "pattern":"(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()" - }, - "ResourceConflictException":{ - "type":"structure", - "members":{ - "Type":{ - "shape":"String", - "documentation":"

The exception type.

" - }, - "message":{ - "shape":"String", - "documentation":"

The exception message.

" - } - }, - "documentation":"

The resource already exists, or another operation is in progress.

", - "error":{ - "httpStatusCode":409, - "senderFault":true - }, - "exception":true - }, - "ResourceInUseException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "documentation":"

The operation conflicts with the resource's availability. For example, you tried to update an event source mapping in the CREATING state, or you tried to delete an event source mapping currently UPDATING.

", - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "ResourceNotFoundException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "documentation":"

The resource specified in the request does not exist.

", - "error":{ - "httpStatusCode":404, - "senderFault":true - }, - "exception":true - }, - "ResourceNotReadyException":{ - "type":"structure", - "members":{ - "Type":{ - "shape":"String", - "documentation":"

The exception type.

" - }, - "message":{ - "shape":"String", - "documentation":"

The exception message.

" - } - }, - "documentation":"

The function is inactive and its VPC connection is no longer available. Wait for the VPC connection to reestablish and try again.

", - "error":{"httpStatusCode":502}, - "exception":true, - "fault":true - }, - "ResponseStreamingInvocationType":{ - "type":"string", - "enum":[ - "RequestResponse", - "DryRun" - ] - }, - "RetentionPeriodInDays":{ - "type":"integer", - "box":true, - "max":90, - "min":1 - }, - "RetryDetails":{ - "type":"structure", - "members":{ - "CurrentAttempt":{ - "shape":"AttemptCount", - "documentation":"

The current attempt number for this operation.

" - }, - "NextAttemptDelaySeconds":{ - "shape":"DurationSeconds", - "documentation":"

The delay before the next retry attempt, in seconds.

" - } - }, - "documentation":"

Information about retry attempts for an operation.

" - }, - "ReverseOrder":{ - "type":"boolean", - "box":true - }, - "RoleArn":{ - "type":"string", - "max":10000, - "min":0, - "pattern":"arn:(aws[a-zA-Z-]*)?:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+" - }, - "Runtime":{ - "type":"string", - "enum":[ - "nodejs", - "nodejs4.3", - "nodejs6.10", - "nodejs8.10", - "nodejs10.x", - "nodejs12.x", - "nodejs14.x", - "nodejs16.x", - "nodejs18.x", - "nodejs20.x", - "nodejs22.x", - "nodejs24.x", - "java8", - "java8.al2", - "java11", - "java17", - "java21", - "java25", - "python2.7", - "python3.6", - "python3.7", - "python3.8", - "python3.9", - "python3.10", - "python3.11", - "python3.12", - "python3.13", - "python3.14", - "dotnetcore1.0", - "dotnetcore2.0", - "dotnetcore2.1", - "dotnetcore3.1", - "dotnet6", - "dotnet8", - "dotnet10", - "nodejs4.3-edge", - "go1.x", - "ruby2.5", - "ruby2.7", - "ruby3.2", - "ruby3.3", - "ruby3.4", - "ruby4.0", - "provided", - "provided.al2", - "provided.al2023", - "nodejs26.x", - "python3.15", - "java8.al2023", - "java11.al2023", - "java17.al2023" - ] - }, - "RuntimeVersionArn":{ - "type":"string", - "max":2048, - "min":26, - "pattern":"arn:(aws[a-zA-Z-]*):lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}::runtime:.+" - }, - "RuntimeVersionConfig":{ - "type":"structure", - "members":{ - "RuntimeVersionArn":{ - "shape":"RuntimeVersionArn", - "documentation":"

The ARN of the runtime version you want the function to use.

" - }, - "Error":{ - "shape":"RuntimeVersionError", - "documentation":"

Error response when Lambda is unable to retrieve the runtime version for a function.

" - } - }, - "documentation":"

The ARN of the runtime and any errors that occured.

" - }, - "RuntimeVersionError":{ - "type":"structure", - "members":{ - "ErrorCode":{ - "shape":"String", - "documentation":"

The error code.

" - }, - "Message":{ - "shape":"SensitiveString", - "documentation":"

The error message.

" - } - }, - "documentation":"

Any error returned when the runtime version information for the function could not be retrieved.

" - }, - "S3Bucket":{ - "type":"string", - "max":63, - "min":3, - "pattern":"[0-9A-Za-z\\.\\-_]*(?The exception type.

" - }, - "Message":{ - "shape":"String", - "documentation":"

The exception message.

" - } - }, - "documentation":"

The Lambda function couldn't make a network connection to the configured S3 Files access point.

", - "error":{ - "httpStatusCode":408, - "senderFault":true - }, - "exception":true - }, - "S3FilesMountFailureException":{ - "type":"structure", - "members":{ - "Type":{ - "shape":"String", - "documentation":"

The exception type.

" - }, - "Message":{ - "shape":"String", - "documentation":"

The exception message.

" - } - }, - "documentation":"

The Lambda function couldn't mount the configured S3 Files access point due to a permission or configuration issue.

", - "error":{ - "httpStatusCode":403, - "senderFault":true - }, - "exception":true - }, - "S3FilesMountTimeoutException":{ - "type":"structure", - "members":{ - "Type":{ - "shape":"String", - "documentation":"

The exception type.

" - }, - "Message":{ - "shape":"String", - "documentation":"

The exception message.

" - } - }, - "documentation":"

The Lambda function made a network connection to the configured S3 Files access point, but the mount operation timed out.

", - "error":{ - "httpStatusCode":408, - "senderFault":true - }, - "exception":true - }, - "S3Key":{ - "type":"string", - "max":1024, - "min":1, - "pattern":".*" - }, - "S3ObjectStorageMode":{ - "type":"string", - "documentation":"

The method Lambda uses to store a function's deployment package — either by copying the package into Lambda-managed storage (COPY) or by referencing it directly from the source Amazon S3 bucket (REFERENCE).

", - "enum":[ - "COPY", - "REFERENCE" - ] - }, - "S3ObjectVersion":{ - "type":"string", - "max":1024, - "min":1, - "pattern":".*" - }, - "ScalingConfig":{ - "type":"structure", - "members":{ - "MaximumConcurrency":{ - "shape":"MaximumConcurrency", - "documentation":"

Limits the number of concurrent instances that the Amazon SQS event source can invoke.

" - } - }, - "documentation":"

(Amazon SQS only) The scaling configuration for the event source. To remove the configuration, pass an empty value.

" - }, - "SchemaRegistryEventRecordFormat":{ - "type":"string", - "enum":[ - "JSON", - "SOURCE" - ] - }, - "SchemaRegistryUri":{ - "type":"string", - "max":10000, - "min":1, - "pattern":"[a-zA-Z0-9-\\/*:_+=.@-]*" - }, - "SecurityGroupId":{ - "type":"string", - "max":1024, - "min":0, - "pattern":"sg-[0-9a-zA-Z]*" - }, - "SecurityGroupIds":{ - "type":"list", - "member":{"shape":"SecurityGroupId"}, - "max":5, - "min":0 - }, - "SelfManagedEventSource":{ - "type":"structure", - "members":{ - "Endpoints":{ - "shape":"Endpoints", - "documentation":"

The list of bootstrap servers for your Kafka brokers in the following format: \"KAFKA_BOOTSTRAP_SERVERS\": [\"abc.xyz.com:xxxx\",\"abc2.xyz.com:xxxx\"].

" - } - }, - "documentation":"

The self-managed Apache Kafka cluster for your event source.

" - }, - "SelfManagedKafkaEventSourceConfig":{ - "type":"structure", - "members":{ - "ConsumerGroupId":{ - "shape":"URI", - "documentation":"

The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see Customizable consumer group ID.

" - }, - "SchemaRegistryConfig":{ - "shape":"KafkaSchemaRegistryConfig", - "documentation":"

Specific configuration settings for a Kafka schema registry.

" - } - }, - "documentation":"

Specific configuration settings for a self-managed Apache Kafka event source.

" - }, - "SendDurableExecutionCallbackFailureRequest":{ - "type":"structure", - "required":["CallbackId"], - "members":{ - "CallbackId":{ - "shape":"CallbackId", - "documentation":"

The unique identifier for the callback operation.

", - "location":"uri", - "locationName":"CallbackId" - }, - "Error":{ - "shape":"ErrorObject", - "documentation":"

Error details describing why the callback operation failed.

" - } - }, - "payload":"Error" - }, - "SendDurableExecutionCallbackFailureResponse":{ - "type":"structure", - "members":{} - }, - "SendDurableExecutionCallbackHeartbeatRequest":{ - "type":"structure", - "required":["CallbackId"], - "members":{ - "CallbackId":{ - "shape":"CallbackId", - "documentation":"

The unique identifier for the callback operation.

", - "location":"uri", - "locationName":"CallbackId" - } - } - }, - "SendDurableExecutionCallbackHeartbeatResponse":{ - "type":"structure", - "members":{} - }, - "SendDurableExecutionCallbackSuccessRequest":{ - "type":"structure", - "required":["CallbackId"], - "members":{ - "CallbackId":{ - "shape":"CallbackId", - "documentation":"

The unique identifier for the callback operation.

", - "location":"uri", - "locationName":"CallbackId" - }, - "Result":{ - "shape":"BinaryOperationPayload", - "documentation":"

The result data from the successful callback operation. Maximum size is 256 KB.

" - } - }, - "payload":"Result" - }, - "SendDurableExecutionCallbackSuccessResponse":{ - "type":"structure", - "members":{} - }, - "SensitiveString":{ - "type":"string", - "sensitive":true - }, - "SensitiveStringOnServerOnly":{ - "type":"string", - "max":10000, - "min":0 - }, - "SerializedRequestEntityTooLargeException":{ - "type":"structure", - "members":{ - "Type":{ - "shape":"String", - "documentation":"

The error type.

" - }, - "message":{"shape":"String"} - }, - "documentation":"

The request payload exceeded the maximum allowed size for serialized request entities.

", - "error":{ - "httpStatusCode":413, - "senderFault":true - }, - "exception":true - }, - "ServiceException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "documentation":"

The Lambda service encountered an internal error.

", - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true - }, - "ServiceQuotaExceededException":{ - "type":"structure", - "members":{ - "Type":{ - "shape":"String", - "documentation":"

The exception type.

" - }, - "Message":{ - "shape":"String", - "documentation":"

The exception message.

" - } - }, - "documentation":"

The request would exceed a service quota. For more information about Lambda service quotas, see Lambda quotas. To request a quota increase, see Requesting a quota increase in the Service Quotas User Guide.

", - "error":{ - "httpStatusCode":402, - "senderFault":true - }, - "exception":true - }, - "SigningProfileVersionArns":{ - "type":"list", - "member":{"shape":"Arn"}, - "max":20, - "min":1 - }, - "SnapStart":{ - "type":"structure", - "members":{ - "ApplyOn":{ - "shape":"SnapStartApplyOn", - "documentation":"

Set to PublishedVersions to create a snapshot of the initialized execution environment when you publish a function version.

" - } - }, - "documentation":"

The function's Lambda SnapStart setting. Set ApplyOn to PublishedVersions to create a snapshot of the initialized execution environment when you publish a function version.

" - }, - "SnapStartApplyOn":{ - "type":"string", - "enum":[ - "PublishedVersions", - "None" - ] - }, - "SnapStartException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "documentation":"

The afterRestore() runtime hook encountered an error. For more information, check the Amazon CloudWatch logs.

", - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "SnapStartNotReadyException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "documentation":"

Lambda is initializing your function. You can invoke the function when the function state becomes Active.

", - "error":{ - "httpStatusCode":409, - "senderFault":true - }, - "exception":true - }, - "SnapStartOptimizationStatus":{ - "type":"string", - "enum":[ - "On", - "Off" - ] - }, - "SnapStartRegenerationFailureException":{ - "type":"structure", - "members":{ - "Type":{ - "shape":"String", - "documentation":"

The exception type.

" - }, - "Message":{ - "shape":"String", - "documentation":"

The exception message.

" - } - }, - "documentation":"

Lambda couldn't regenerate the SnapStart snapshot for the function. SnapStart-enabled functions periodically regenerate snapshots when their underlying runtime or dependencies change; this regeneration failed. Wait for Lambda to retry, or update the function's configuration to trigger a new snapshot. For more information, see Lambda SnapStart.

", - "error":{ - "httpStatusCode":409, - "senderFault":true - }, - "exception":true - }, - "SnapStartResponse":{ - "type":"structure", - "members":{ - "ApplyOn":{ - "shape":"SnapStartApplyOn", - "documentation":"

When set to PublishedVersions, Lambda creates a snapshot of the execution environment when you publish a function version.

" - }, - "OptimizationStatus":{ - "shape":"SnapStartOptimizationStatus", - "documentation":"

When you provide a qualified Amazon Resource Name (ARN), this response element indicates whether SnapStart is activated for the specified function version.

" - } - }, - "documentation":"

The function's SnapStart setting.

" - }, - "SnapStartTimeoutException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "documentation":"

Lambda couldn't restore the snapshot within the timeout limit.

", - "error":{ - "httpStatusCode":408, - "senderFault":true - }, - "exception":true - }, - "SourceAccessConfiguration":{ - "type":"structure", - "members":{ - "Type":{ - "shape":"SourceAccessType", - "documentation":"

The type of authentication protocol, VPC components, or virtual host for your event source. For example: \"Type\":\"SASL_SCRAM_512_AUTH\".

  • BASIC_AUTH – (Amazon MQ) The Secrets Manager secret that stores your broker credentials.

  • BASIC_AUTH – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL/PLAIN authentication of your Apache Kafka brokers.

  • VPC_SUBNET – (Self-managed Apache Kafka) The subnets associated with your VPC. Lambda connects to these subnets to fetch data from your self-managed Apache Kafka cluster.

  • VPC_SECURITY_GROUP – (Self-managed Apache Kafka) The VPC security group used to manage access to your self-managed Apache Kafka brokers.

  • SASL_SCRAM_256_AUTH – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your self-managed Apache Kafka brokers.

  • SASL_SCRAM_512_AUTH – (Amazon MSK, Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your self-managed Apache Kafka brokers.

  • VIRTUAL_HOST –- (RabbitMQ) The name of the virtual host in your RabbitMQ broker. Lambda uses this RabbitMQ host as the event source. This property cannot be specified in an UpdateEventSourceMapping API call.

  • CLIENT_CERTIFICATE_TLS_AUTH – (Amazon MSK, self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the certificate chain (X.509 PEM), private key (PKCS#8 PEM), and private key password (optional) used for mutual TLS authentication of your MSK/Apache Kafka brokers.

  • SERVER_ROOT_CA_CERTIFICATE – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the root CA certificate (X.509 PEM) used for TLS encryption of your Apache Kafka brokers.

" - }, - "URI":{ - "shape":"URI", - "documentation":"

The value for your chosen configuration in Type. For example: \"URI\": \"arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName\".

" - } - }, - "documentation":"

To secure and define access to your event source, you can specify the authentication protocol, VPC components, or virtual host.

" - }, - "SourceAccessConfigurations":{ - "type":"list", - "member":{"shape":"SourceAccessConfiguration"}, - "max":23, - "min":0 - }, - "SourceAccessType":{ - "type":"string", - "enum":[ - "BASIC_AUTH", - "VPC_SUBNET", - "VPC_SECURITY_GROUP", - "SASL_SCRAM_512_AUTH", - "SASL_SCRAM_256_AUTH", - "VIRTUAL_HOST", - "CLIENT_CERTIFICATE_TLS_AUTH", - "SERVER_ROOT_CA_CERTIFICATE" - ] - }, - "SourceOwner":{ - "type":"string", - "max":12, - "min":0, - "pattern":"\\d{12}" - }, - "StackTraceEntries":{ - "type":"list", - "member":{"shape":"StackTraceEntry"} - }, - "StackTraceEntry":{ - "type":"string", - "sensitive":true - }, - "State":{ - "type":"string", - "enum":[ - "Pending", - "Active", - "Inactive", - "Failed", - "Deactivating", - "Deactivated", - "ActiveNonInvocable", - "Deleting" - ] - }, - "StateReason":{"type":"string"}, - "StateReasonCode":{ - "type":"string", - "enum":[ - "Idle", - "Creating", - "Restoring", - "EniLimitExceeded", - "InsufficientRolePermissions", - "InvalidConfiguration", - "InternalError", - "SubnetOutOfIPAddresses", - "InvalidSubnet", - "InvalidSecurityGroup", - "ImageDeleted", - "ImageAccessDenied", - "InvalidImage", - "KMSKeyAccessDenied", - "KMSKeyNotFound", - "InvalidStateKMSKey", - "DisabledKMSKey", - "EFSIOError", - "EFSMountConnectivityError", - "EFSMountFailure", - "EFSMountTimeout", - "InvalidRuntime", - "InvalidZipFileException", - "FunctionError", - "ServiceQuotaExceededException", - "VcpuLimitExceeded", - "CapacityProviderScalingLimitExceeded", - "InsufficientCapacity", - "EC2RequestLimitExceeded", - "FunctionError.InitTimeout", - "FunctionError.RuntimeInitError", - "FunctionError.ExtensionInitError", - "FunctionError.InvalidEntryPoint", - "FunctionError.InvalidWorkingDirectory", - "FunctionError.PermissionDenied", - "FunctionError.TooManyExtensions", - "FunctionError.InitResourceExhausted", - "DisallowedByVpcEncryptionControl", - "DrainingDurableExecutions", - "DependencyError" - ] - }, - "StatementId":{ - "type":"string", - "max":100, - "min":1, - "pattern":"([a-zA-Z0-9-_]+)" - }, - "StepDetails":{ - "type":"structure", - "members":{ - "Attempt":{ - "shape":"AttemptCount", - "documentation":"

The current attempt number for this step.

" - }, - "NextAttemptTimestamp":{ - "shape":"ExecutionTimestamp", - "documentation":"

The date and time when the next attempt is scheduled, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD). Only populated when the step is in a pending state.

" - }, - "Result":{ - "shape":"OperationPayload", - "documentation":"

The JSON response payload from the step operation.

" - }, - "Error":{ - "shape":"ErrorObject", - "documentation":"

Details about the step failure.

" - } - }, - "documentation":"

Details about a step operation.

" - }, - "StepFailedDetails":{ - "type":"structure", - "required":[ - "Error", - "RetryDetails" - ], - "members":{ - "Error":{ - "shape":"EventError", - "documentation":"

Details about the step failure.

" - }, - "RetryDetails":{ - "shape":"RetryDetails", - "documentation":"

Information about retry attempts for this step operation.

" - } - }, - "documentation":"

Details about a step that failed.

" - }, - "StepOptions":{ - "type":"structure", - "members":{ - "NextAttemptDelaySeconds":{ - "shape":"StepOptionsNextAttemptDelaySecondsInteger", - "documentation":"

The delay in seconds before the next retry attempt.

" - } - }, - "documentation":"

Configuration options for a step operation.

" - }, - "StepOptionsNextAttemptDelaySecondsInteger":{ - "type":"integer", - "box":true, - "max":31622400, - "min":1 - }, - "StepStartedDetails":{ - "type":"structure", - "members":{}, - "documentation":"

Details about a step that has started.

" - }, - "StepSucceededDetails":{ - "type":"structure", - "required":[ - "Result", - "RetryDetails" - ], - "members":{ - "Result":{ - "shape":"EventResult", - "documentation":"

The response payload from the successful operation.

" - }, - "RetryDetails":{ - "shape":"RetryDetails", - "documentation":"

Information about retry attempts for this step operation.

" - } - }, - "documentation":"

Details about a step that succeeded.

" - }, - "StopDurableExecutionRequest":{ - "type":"structure", - "required":["DurableExecutionArn"], - "members":{ - "DurableExecutionArn":{ - "shape":"DurableExecutionArn", - "documentation":"

The Amazon Resource Name (ARN) of the durable execution.

", - "location":"uri", - "locationName":"DurableExecutionArn" - }, - "Error":{ - "shape":"ErrorObject", - "documentation":"

Optional error details explaining why the execution is being stopped.

" - } - }, - "payload":"Error" - }, - "StopDurableExecutionResponse":{ - "type":"structure", - "required":["StopTimestamp"], - "members":{ - "StopTimestamp":{ - "shape":"ExecutionTimestamp", - "documentation":"

The timestamp when the execution was stopped (ISO 8601 format).

" - } - } - }, - "String":{"type":"string"}, - "StringList":{ - "type":"list", - "member":{"shape":"String"}, - "max":1500, - "min":0 - }, - "SubnetIPAddressLimitReachedException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "documentation":"

Lambda couldn't set up VPC access for the Lambda function because one or more configured subnets has no available IP addresses.

", - "error":{"httpStatusCode":502}, - "exception":true, - "fault":true - }, - "SubnetId":{ - "type":"string", - "max":1024, - "min":0, - "pattern":"subnet-[0-9a-z]*" - }, - "SubnetIds":{ - "type":"list", - "member":{"shape":"SubnetId"}, - "max":16, - "min":0 - }, - "SystemLogLevel":{ - "type":"string", - "enum":[ - "DEBUG", - "INFO", - "WARN" - ] - }, - "TagKey":{ - "type":"string", - "max":128, - "min":1, - "pattern":"([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)" - }, - "TagKeyList":{ - "type":"list", - "member":{"shape":"TagKey"} - }, - "TagResourceRequest":{ - "type":"structure", - "required":[ - "Resource", - "Tags" - ], - "members":{ - "Resource":{ - "shape":"TaggableResource", - "documentation":"

The resource's Amazon Resource Name (ARN).

", - "location":"uri", - "locationName":"Resource" - }, - "Tags":{ - "shape":"Tags", - "documentation":"

A list of tags to apply to the resource.

" - } - } - }, - "TagValue":{ - "type":"string", - "max":256, - "min":0, - "pattern":"([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)" - }, - "TaggableResource":{ - "type":"string", - "max":10000, - "min":1, - "pattern":"arn:(aws[a-zA-Z-]*):lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:(function:[a-zA-Z0-9-_]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?|code-signing-config:csc-[a-z0-9]{17}|event-source-mapping:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}|(capacity-provider|network-connector):[a-zA-Z0-9-_]{1,64})" - }, - "Tags":{ - "type":"map", - "key":{"shape":"TagKey"}, - "value":{"shape":"TagValue"} - }, - "TagsError":{ - "type":"structure", - "required":[ - "ErrorCode", - "Message" - ], - "members":{ - "ErrorCode":{ - "shape":"TagsErrorCode", - "documentation":"

The error code.

" - }, - "Message":{ - "shape":"TagsErrorMessage", - "documentation":"

The error message.

" - } - }, - "documentation":"

An object that contains details about an error related to retrieving tags.

" - }, - "TagsErrorCode":{ - "type":"string", - "max":21, - "min":10, - "pattern":"[A-Za-z]+Exception" - }, - "TagsErrorMessage":{ - "type":"string", - "max":1000, - "min":84, - "pattern":".*" - }, - "TargetTrackingScalingPolicy":{ - "type":"structure", - "required":[ - "PredefinedMetricType", - "TargetValue" - ], - "members":{ - "PredefinedMetricType":{ - "shape":"CapacityProviderPredefinedMetricType", - "documentation":"

The predefined metric type to track for scaling decisions.

" - }, - "TargetValue":{ - "shape":"MetricTargetValue", - "documentation":"

The target value for the metric that the scaling policy attempts to maintain through scaling actions.

" - } - }, - "documentation":"

A scaling policy for the capacity provider that automatically adjusts capacity to maintain a target value for a specific metric.

" - }, - "TenancyConfig":{ - "type":"structure", - "required":["TenantIsolationMode"], - "members":{ - "TenantIsolationMode":{ - "shape":"TenantIsolationMode", - "documentation":"

Tenant isolation mode allows for invocation to be sent to a corresponding execution environment dedicated to a specific tenant ID.

" - } - }, - "documentation":"

Specifies the tenant isolation mode configuration for a Lambda function. This allows you to configure specific tenant isolation strategies for your function invocations. Tenant isolation configuration cannot be modified after function creation.

" - }, - "TenantId":{ - "type":"string", - "max":256, - "min":1, - "pattern":"[a-zA-Z0-9\\._:\\/=+\\-@ ]+" - }, - "TenantIsolationMode":{ - "type":"string", - "enum":["PER_TENANT"] - }, - "ThrottleReason":{ - "type":"string", - "enum":[ - "ConcurrentInvocationLimitExceeded", - "FunctionInvocationRateLimitExceeded", - "ReservedFunctionConcurrentInvocationLimitExceeded", - "ReservedFunctionInvocationRateLimitExceeded", - "CallerRateLimitExceeded", - "ConcurrentSnapshotCreateLimitExceeded" - ] - }, - "Timeout":{ - "type":"integer", - "box":true, - "max":5400, - "min":1 - }, - "Timestamp":{ - "type":"string", - "max":100, - "min":0, - "pattern":".*" - }, - "TooManyRequestsException":{ - "type":"structure", - "members":{ - "retryAfterSeconds":{ - "shape":"String", - "documentation":"

The number of seconds the caller should wait before retrying.

", - "location":"header", - "locationName":"Retry-After" - }, - "Type":{"shape":"String"}, - "message":{"shape":"String"}, - "Reason":{"shape":"ThrottleReason"} - }, - "documentation":"

The request throughput limit was exceeded. For more information, see Lambda quotas.

", - "error":{ - "httpStatusCode":429, - "senderFault":true - }, - "exception":true - }, - "Topic":{ - "type":"string", - "max":249, - "min":1, - "pattern":"[^.]([a-zA-Z0-9\\-_.]+)" - }, - "Topics":{ - "type":"list", - "member":{"shape":"Topic"}, - "max":1, - "min":1 - }, - "TraceHeader":{ - "type":"structure", - "members":{ - "XAmznTraceId":{ - "shape":"XAmznTraceId", - "documentation":"

The X-Ray trace header associated with the durable execution.

" - } - }, - "documentation":"

Contains trace headers for the Lambda durable execution.

" - }, - "TracingConfig":{ - "type":"structure", - "members":{ - "Mode":{ - "shape":"TracingMode", - "documentation":"

The tracing mode.

" - } - }, - "documentation":"

The function's X-Ray tracing configuration. To sample and record incoming requests, set Mode to Active.

" - }, - "TracingConfigResponse":{ - "type":"structure", - "members":{ - "Mode":{ - "shape":"TracingMode", - "documentation":"

The tracing mode.

" - } - }, - "documentation":"

The function's X-Ray tracing configuration.

" - }, - "TracingMode":{ - "type":"string", - "enum":[ - "Active", - "PassThrough" - ] - }, - "Truncated":{ - "type":"boolean", - "box":true - }, - "TumblingWindowInSeconds":{ - "type":"integer", - "box":true, - "max":900, - "min":0 - }, - "URI":{ - "type":"string", - "max":200, - "min":1, - "pattern":"[ a-zA-Z0-9-\\/*:_+=.@-]*" - }, - "UUIDString":{ - "type":"string", - "max":36, - "min":36 - }, - "UnqualifiedFunctionName":{ - "type":"string", - "max":140, - "min":1, - "pattern":"(arn:(aws[a-zA-Z-]*)?:lambda:)?((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)" - }, - "UnreservedConcurrentExecutions":{ - "type":"integer", - "box":true, - "min":0 - }, - "UnsupportedMediaTypeException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "message":{"shape":"String"} - }, - "documentation":"

The content type of the Invoke request body is not JSON.

", - "error":{ - "httpStatusCode":415, - "senderFault":true - }, - "exception":true - }, - "UntagResourceRequest":{ - "type":"structure", - "required":[ - "Resource", - "TagKeys" - ], - "members":{ - "Resource":{ - "shape":"TaggableResource", - "documentation":"

The resource's Amazon Resource Name (ARN).

", - "location":"uri", - "locationName":"Resource" - }, - "TagKeys":{ - "shape":"TagKeyList", - "documentation":"

A list of tag keys to remove from the resource.

", - "location":"querystring", - "locationName":"tagKeys" - } - } - }, - "UpdateAliasRequest":{ - "type":"structure", - "required":[ - "FunctionName", - "Name" - ], - "members":{ - "FunctionName":{ - "shape":"FunctionName", - "documentation":"

The name or ARN of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "location":"uri", - "locationName":"FunctionName" - }, - "Name":{ - "shape":"Alias", - "documentation":"

The name of the alias.

", - "location":"uri", - "locationName":"Name" - }, - "FunctionVersion":{ - "shape":"VersionWithLatestPublished", - "documentation":"

The function version that the alias invokes.

" - }, - "Description":{ - "shape":"Description", - "documentation":"

A description of the alias.

" - }, - "RoutingConfig":{ - "shape":"AliasRoutingConfiguration", - "documentation":"

The routing configuration of the alias.

" - }, - "RevisionId":{ - "shape":"String", - "documentation":"

Only update the alias if the revision ID matches the ID that's specified. Use this option to avoid modifying an alias that has changed since you last read it.

" - } - } - }, - "UpdateCapacityProviderRequest":{ - "type":"structure", - "required":["CapacityProviderName"], - "members":{ - "CapacityProviderName":{ - "shape":"CapacityProviderName", - "documentation":"

The name of the capacity provider to update.

", - "location":"uri", - "locationName":"CapacityProviderName" - }, - "CapacityProviderScalingConfig":{ - "shape":"CapacityProviderScalingConfig", - "documentation":"

The updated scaling configuration for the capacity provider.

" - }, - "PropagateTags":{"shape":"PropagateTags"}, - "TelemetryConfig":{ - "shape":"CapacityProviderTelemetryConfig", - "documentation":"

The updated telemetry configuration for the capacity provider.

" - } - } - }, - "UpdateCapacityProviderResponse":{ - "type":"structure", - "required":["CapacityProvider"], - "members":{ - "CapacityProvider":{ - "shape":"CapacityProvider", - "documentation":"

Information about the updated capacity provider.

" - } - } - }, - "UpdateCodeSigningConfigRequest":{ - "type":"structure", - "required":["CodeSigningConfigArn"], - "members":{ - "CodeSigningConfigArn":{ - "shape":"CodeSigningConfigArn", - "documentation":"

The The Amazon Resource Name (ARN) of the code signing configuration.

", - "location":"uri", - "locationName":"CodeSigningConfigArn" - }, - "Description":{ - "shape":"Description", - "documentation":"

Descriptive name for this code signing configuration.

" - }, - "AllowedPublishers":{ - "shape":"AllowedPublishers", - "documentation":"

Signing profiles for this code signing configuration.

" - }, - "CodeSigningPolicies":{ - "shape":"CodeSigningPolicies", - "documentation":"

The code signing policy.

" - } - } - }, - "UpdateCodeSigningConfigResponse":{ - "type":"structure", - "required":["CodeSigningConfig"], - "members":{ - "CodeSigningConfig":{ - "shape":"CodeSigningConfig", - "documentation":"

The code signing configuration

" - } - } - }, - "UpdateEventSourceMappingRequest":{ - "type":"structure", - "required":["UUID"], - "members":{ - "UUID":{ - "shape":"UUIDString", - "documentation":"

The identifier of the event source mapping.

", - "location":"uri", - "locationName":"UUID" - }, - "FunctionName":{ - "shape":"NamespacedFunctionName", - "documentation":"

The name or ARN of the Lambda function.

Name formats

  • Function name – MyFunction.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.

  • Partial ARN – 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.

" - }, - "Enabled":{ - "shape":"Enabled", - "documentation":"

When true, the event source mapping is active. When false, Lambda pauses polling and invocation.

Default: True

" - }, - "BatchSize":{ - "shape":"BatchSize", - "documentation":"

The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).

  • Amazon Kinesis – Default 100. Max 10,000.

  • Amazon DynamoDB Streams – Default 100. Max 10,000.

  • Amazon Simple Queue Service – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.

  • Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000.

  • Self-managed Apache Kafka – Default 100. Max 10,000.

  • Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000.

  • DocumentDB – Default 100. Max 10,000.

" - }, - "FilterCriteria":{ - "shape":"FilterCriteria", - "documentation":"

An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.

" - }, - "KMSKeyArn":{ - "shape":"KMSKeyArn", - "documentation":"

The ARN of the Key Management Service (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria. By default, Lambda does not encrypt your filter criteria object. Specify this property to encrypt data using your own customer managed key.

" - }, - "MetricsConfig":{ - "shape":"EventSourceMappingMetricsConfig", - "documentation":"

The metrics configuration for your event source. For more information, see Event source mapping metrics.

" - }, - "LoggingConfig":{"shape":"EventSourceMappingLoggingConfig"}, - "ScalingConfig":{ - "shape":"ScalingConfig", - "documentation":"

(Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.

" - }, - "MaximumBatchingWindowInSeconds":{ - "shape":"MaximumBatchingWindowInSeconds", - "documentation":"

The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.

For Kinesis, DynamoDB, and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it. To restore the default batching window, you must create a new event source mapping.

Related setting: For Kinesis, DynamoDB, and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

" - }, - "ParallelizationFactor":{ - "shape":"ParallelizationFactor", - "documentation":"

(Kinesis and DynamoDB Streams only) The number of batches to process from each shard concurrently.

" - }, - "DestinationConfig":{ - "shape":"DestinationConfig", - "documentation":"

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) A configuration object that specifies the destination of an event after Lambda processes it.

" - }, - "MaximumRecordAgeInSeconds":{ - "shape":"MaximumRecordAgeInSeconds", - "documentation":"

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) Discard records older than the specified age. The default value is infinite (-1).

" - }, - "BisectBatchOnFunctionError":{ - "shape":"BisectBatchOnFunctionError", - "documentation":"

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) If the function returns an error, split the batch in two and retry.

" - }, - "MaximumRetryAttempts":{ - "shape":"MaximumRetryAttemptsEventSourceMapping", - "documentation":"

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.

" - }, - "TumblingWindowInSeconds":{ - "shape":"TumblingWindowInSeconds", - "documentation":"

(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.

" - }, - "SourceAccessConfigurations":{ - "shape":"SourceAccessConfigurations", - "documentation":"

An array of authentication protocols or VPC components required to secure your event source.

" - }, - "FunctionResponseTypes":{ - "shape":"FunctionResponseTypeList", - "documentation":"

(Kinesis, DynamoDB Streams, Amazon MSK, self-managed Apache Kafka, and Amazon SQS) A list of current response type enums applied to the event source mapping.

" - }, - "AmazonManagedKafkaEventSourceConfig":{"shape":"AmazonManagedKafkaEventSourceConfig"}, - "SelfManagedKafkaEventSourceConfig":{"shape":"SelfManagedKafkaEventSourceConfig"}, - "DocumentDBEventSourceConfig":{ - "shape":"DocumentDBEventSourceConfig", - "documentation":"

Specific configuration settings for a DocumentDB event source.

" - }, - "ProvisionedPollerConfig":{ - "shape":"ProvisionedPollerConfig", - "documentation":"

(Amazon SQS, Amazon MSK, and self-managed Apache Kafka only) The provisioned mode configuration for the event source. For more information, see provisioned mode.

" - } - } - }, - "UpdateFunctionCodeRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"FunctionName", - "documentation":"

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "location":"uri", - "locationName":"FunctionName" - }, - "ZipFile":{ - "shape":"Blob", - "documentation":"

The base64-encoded contents of the deployment package. Amazon Web Services SDK and CLI clients handle the encoding for you. Use only with a function defined with a .zip file archive deployment package.

" - }, - "S3Bucket":{ - "shape":"S3Bucket", - "documentation":"

An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a different Amazon Web Services account. Use only with a function defined with a .zip file archive deployment package.

" - }, - "S3Key":{ - "shape":"S3Key", - "documentation":"

The Amazon S3 key of the deployment package. Use only with a function defined with a .zip file archive deployment package.

" - }, - "S3ObjectVersion":{ - "shape":"S3ObjectVersion", - "documentation":"

For versioned objects, the version of the deployment package object to use.

" - }, - "S3ObjectStorageMode":{ - "shape":"S3ObjectStorageMode", - "documentation":"

Specifies how the deployment package is stored. Valid values:

  • COPY (default) – Uploads a copy of your deployment package to Lambda.

  • REFERENCE – Lambda references the deployment package from the specified Amazon S3 bucket.

" - }, - "ImageUri":{ - "shape":"String", - "documentation":"

URI of a container image in the Amazon ECR registry. Do not use for a function defined with a .zip file archive.

" - }, - "Architectures":{ - "shape":"ArchitecturesList", - "documentation":"

The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64.

" - }, - "Publish":{ - "shape":"Boolean", - "documentation":"

Set to true to publish a new version of the function after updating the code. This has the same effect as calling PublishVersion separately.

" - }, - "PublishTo":{ - "shape":"FunctionVersionLatestPublished", - "documentation":"

Specifies where to publish the function version or configuration.

" - }, - "DryRun":{ - "shape":"Boolean", - "documentation":"

Set to true to validate the request parameters and access permissions without modifying the function code.

" - }, - "RevisionId":{ - "shape":"String", - "documentation":"

Update the function only if the revision ID matches the ID that's specified. Use this option to avoid modifying a function that has changed since you last read it.

" - }, - "SourceKMSKeyArn":{ - "shape":"KMSKeyArn", - "documentation":"

The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt your function's .zip deployment package. If you don't provide a customer managed key, Lambda uses an Amazon Web Services managed key.

" - } - } - }, - "UpdateFunctionConfigurationRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"FunctionName", - "documentation":"

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "location":"uri", - "locationName":"FunctionName" - }, - "Role":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the function's execution role.

" - }, - "Handler":{ - "shape":"Handler", - "documentation":"

The name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Lambda programming model.

" - }, - "Description":{ - "shape":"Description", - "documentation":"

A description of the function.

" - }, - "Timeout":{ - "shape":"Timeout", - "documentation":"

The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see Lambda execution environment.

" - }, - "MemorySize":{ - "shape":"MemorySize", - "documentation":"

The amount of memory available to the function at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.

" - }, - "VpcConfig":{ - "shape":"VpcConfig", - "documentation":"

For network connectivity to Amazon Web Services resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see Configuring a Lambda function to access resources in a VPC.

" - }, - "Environment":{ - "shape":"Environment", - "documentation":"

Environment variables that are accessible from function code during execution.

" - }, - "Runtime":{ - "shape":"Runtime", - "documentation":"

The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image.

The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see Runtime use after deprecation.

For a list of all currently supported runtimes, see Supported runtimes.

" - }, - "DeadLetterConfig":{ - "shape":"DeadLetterConfig", - "documentation":"

A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead-letter queues.

" - }, - "KMSKeyArn":{ - "shape":"KMSKeyArn", - "documentation":"

The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt the following resources:

  • The function's environment variables.

  • The function's Lambda SnapStart snapshots.

  • When used with SourceKMSKeyArn, the unzipped version of the .zip deployment package that's used for function invocations. For more information, see Specifying a customer managed key for Lambda.

  • The optimized version of the container image that's used for function invocations. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). For more information, see Function lifecycle.

If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key or an Amazon Web Services managed key.

" - }, - "TracingConfig":{ - "shape":"TracingConfig", - "documentation":"

Set Mode to Active to sample and trace a subset of incoming requests with X-Ray.

" - }, - "RevisionId":{ - "shape":"String", - "documentation":"

Update the function only if the revision ID matches the ID that's specified. Use this option to avoid modifying a function that has changed since you last read it.

" - }, - "Layers":{ - "shape":"LayerList", - "documentation":"

A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.

" - }, - "FileSystemConfigs":{ - "shape":"FileSystemConfigList", - "documentation":"

Connection settings for an Amazon EFS file system or an Amazon S3 Files file system.

" - }, - "ImageConfig":{ - "shape":"ImageConfig", - "documentation":"

Container image configuration values that override the values in the container image Docker file.

" - }, - "EphemeralStorage":{ - "shape":"EphemeralStorage", - "documentation":"

The size of the function's /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).

" - }, - "SnapStart":{ - "shape":"SnapStart", - "documentation":"

The function's SnapStart setting.

" - }, - "LoggingConfig":{ - "shape":"LoggingConfig", - "documentation":"

The function's Amazon CloudWatch Logs configuration settings.

" - }, - "CapacityProviderConfig":{ - "shape":"CapacityProviderConfig", - "documentation":"

Configuration for the capacity provider that manages compute resources for Lambda functions.

" - }, - "DurableConfig":{ - "shape":"DurableConfig", - "documentation":"

Configuration settings for durable functions, including execution timeout, retention period for execution history, and an optional ARN of the Key Management Service (KMS) customer managed key that is used to encrypt your durable execution's payload data, including input, output, and error payloads.

" - } - } - }, - "UpdateFunctionEventInvokeConfigRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"NamespacedFunctionName", - "documentation":"

The name or ARN of the Lambda function, version, or alias.

Name formats

  • Function name - my-function (name-only), my-function:v1 (with alias).

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN - 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "location":"uri", - "locationName":"FunctionName" - }, - "Qualifier":{ - "shape":"NumericLatestPublishedOrAliasQualifier", - "documentation":"

A version number or alias name.

", - "location":"querystring", - "locationName":"Qualifier" - }, - "MaximumRetryAttempts":{ - "shape":"MaximumRetryAttempts", - "documentation":"

The maximum number of times to retry when the function returns an error.

" - }, - "MaximumEventAgeInSeconds":{ - "shape":"MaximumEventAgeInSeconds", - "documentation":"

The maximum age of a request that Lambda sends to a function for processing.

" - }, - "DestinationConfig":{ - "shape":"DestinationConfig", - "documentation":"

A destination for events after they have been sent to a function for processing.

Destinations

  • Function - The Amazon Resource Name (ARN) of a Lambda function.

  • Queue - The ARN of a standard SQS queue.

  • Bucket - The ARN of an Amazon S3 bucket.

  • Topic - The ARN of a standard SNS topic.

  • Event Bus - The ARN of an Amazon EventBridge event bus.

S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type.

" - } - } - }, - "UpdateFunctionUrlConfigRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"FunctionUrlFunctionName", - "documentation":"

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", - "location":"uri", - "locationName":"FunctionName" - }, - "Qualifier":{ - "shape":"FunctionUrlQualifier", - "documentation":"

The alias name.

", - "location":"querystring", - "locationName":"Qualifier" - }, - "AuthType":{ - "shape":"FunctionUrlAuthType", - "documentation":"

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Control access to Lambda function URLs.

" - }, - "Cors":{ - "shape":"Cors", - "documentation":"

The cross-origin resource sharing (CORS) settings for your function URL.

" - }, - "InvokeMode":{ - "shape":"InvokeMode", - "documentation":"

Use one of the following options:

  • BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.

  • RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 200 MB.

" - } - } - }, - "UpdateFunctionUrlConfigResponse":{ - "type":"structure", - "required":[ - "FunctionUrl", - "FunctionArn", - "AuthType", - "CreationTime", - "LastModifiedTime" - ], - "members":{ - "FunctionUrl":{ - "shape":"FunctionUrl", - "documentation":"

The HTTP URL endpoint for your function.

" - }, - "FunctionArn":{ - "shape":"FunctionArn", - "documentation":"

The Amazon Resource Name (ARN) of your function.

" - }, - "AuthType":{ - "shape":"FunctionUrlAuthType", - "documentation":"

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Control access to Lambda function URLs.

" - }, - "Cors":{ - "shape":"Cors", - "documentation":"

The cross-origin resource sharing (CORS) settings for your function URL.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

When the function URL was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

When the function URL configuration was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" - }, - "InvokeMode":{ - "shape":"InvokeMode", - "documentation":"

Use one of the following options:

  • BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.

  • RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 200 MB.

" - } - } - }, - "UpdateRuntimeOn":{ - "type":"string", - "enum":[ - "Auto", - "Manual", - "FunctionUpdate" - ] - }, - "Version":{ - "type":"string", - "max":1024, - "min":1, - "pattern":"(\\$LATEST|[0-9]+)" - }, - "VersionWithLatestPublished":{ - "type":"string", - "max":1024, - "min":1, - "pattern":"(\\$LATEST(\\.PUBLISHED)?|[0-9]+)" - }, - "VpcConfig":{ - "type":"structure", - "members":{ - "SubnetIds":{ - "shape":"SubnetIds", - "documentation":"

A list of VPC subnet IDs.

" - }, - "SecurityGroupIds":{ - "shape":"SecurityGroupIds", - "documentation":"

A list of VPC security group IDs.

" - }, - "Ipv6AllowedForDualStack":{ - "shape":"NullableBoolean", - "documentation":"

Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets.

" - } - }, - "documentation":"

The VPC security groups and subnets that are attached to a Lambda function. For more information, see Configuring a Lambda function to access resources in a VPC.

" - }, - "VpcConfigResponse":{ - "type":"structure", - "members":{ - "SubnetIds":{ - "shape":"SubnetIds", - "documentation":"

A list of VPC subnet IDs.

" - }, - "SecurityGroupIds":{ - "shape":"SecurityGroupIds", - "documentation":"

A list of VPC security group IDs.

" - }, - "VpcId":{ - "shape":"VpcId", - "documentation":"

The ID of the VPC.

" - }, - "Ipv6AllowedForDualStack":{ - "shape":"NullableBoolean", - "documentation":"

Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets.

" - } - }, - "documentation":"

The VPC security groups and subnets that are attached to a Lambda function.

" - }, - "VpcId":{"type":"string"}, - "WaitCancelledDetails":{ - "type":"structure", - "members":{ - "Error":{ - "shape":"EventError", - "documentation":"

Details about why the wait operation was cancelled.

" - } - }, - "documentation":"

Details about a wait operation that was cancelled.

" - }, - "WaitDetails":{ - "type":"structure", - "members":{ - "ScheduledEndTimestamp":{ - "shape":"ExecutionTimestamp", - "documentation":"

The date and time when the wait operation is scheduled to complete, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" - } - }, - "documentation":"

Details about a wait operation.

" - }, - "WaitOptions":{ - "type":"structure", - "members":{ - "WaitSeconds":{ - "shape":"WaitOptionsWaitSecondsInteger", - "documentation":"

The duration to wait, in seconds.

" - } - }, - "documentation":"

Specifies how long to pause the durable execution.

" - }, - "WaitOptionsWaitSecondsInteger":{ - "type":"integer", - "box":true, - "max":31622400, - "min":1 - }, - "WaitStartedDetails":{ - "type":"structure", - "required":[ - "Duration", - "ScheduledEndTimestamp" - ], - "members":{ - "Duration":{ - "shape":"DurationSeconds", - "documentation":"

The duration to wait, in seconds.

" - }, - "ScheduledEndTimestamp":{ - "shape":"ExecutionTimestamp", - "documentation":"

The date and time when the wait operation is scheduled to complete, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" - } - }, - "documentation":"

Details about a wait operation that has started.

" - }, - "WaitSucceededDetails":{ - "type":"structure", - "members":{ - "Duration":{ - "shape":"DurationSeconds", - "documentation":"

The wait duration, in seconds.

" - } - }, - "documentation":"

Details about a wait operation that succeeded.

" - }, - "Weight":{ - "type":"double", - "max":1.0, - "min":0.0 - }, - "WorkingDirectory":{ - "type":"string", - "max":1000, - "min":0 - }, - "XAmznTraceId":{ - "type":"string", - "max":8192, - "min":0 - } - }, - "documentation":"

Lambda

Overview

Lambda is a compute service that lets you run code without provisioning or managing servers. Lambda runs your code on a high-availability compute infrastructure and performs all of the administration of the compute resources, including server and operating system maintenance, capacity provisioning and automatic scaling, code monitoring and logging. With Lambda, you can run code for virtually any type of application or backend service. For more information about the Lambda service, see What is Lambda in the Lambda Developer Guide.

The Lambda API Reference provides information about each of the API methods, including details about the parameters in each API request and response.

You can use Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command line tools to access the API. For installation instructions, see Tools for Amazon Web Services.

For a list of Region-specific endpoints that Lambda supports, see Lambda endpoints and quotas in the Amazon Web Services General Reference..

When making the API calls, you will need to authenticate your request by providing a signature. Lambda supports signature version 4. For more information, see Signature Version 4 signing process in the Amazon Web Services General Reference..

CA certificates

Because Amazon Web Services SDKs use the CA certificates from your computer, changes to the certificates on the Amazon Web Services servers can cause connection failures when you attempt to use an SDK. You can prevent these failures by keeping your computer's CA certificates and operating system up-to-date. If you encounter this issue in a corporate environment and do not manage your own computer, you might need to ask an administrator to assist with the update process. The following list shows minimum operating system and Java versions:

  • Microsoft Windows versions that have updates from January 2005 or later installed contain at least one of the required CAs in their trust list.

  • Mac OS X 10.4 with Java for Mac OS X 10.4 Release 5 (February 2007), Mac OS X 10.5 (October 2007), and later versions contain at least one of the required CAs in their trust list.

  • Red Hat Enterprise Linux 5 (March 2007), 6, and 7 and CentOS 5, 6, and 7 all contain at least one of the required CAs in their default trusted CA list.

  • Java 1.4.2_12 (May 2006), 5 Update 2 (March 2005), and all later versions, including Java 6 (December 2006), 7, and 8, contain at least one of the required CAs in their default trusted CA list.

When accessing the Lambda management console or Lambda API endpoints, whether through browsers or programmatically, you will need to ensure your client machines support any of the following CAs:

  • Amazon Root CA 1

  • Starfield Services Root Certificate Authority - G2

  • Starfield Class 2 Certification Authority

Root certificates from the first two authorities are available from Amazon trust services, but keeping your computer up-to-date is the more straightforward solution. To learn more about ACM-provided certificates, see Amazon Web Services Certificate Manager FAQs.

" -} diff --git a/tools/code-generation/api-descriptions/lambda/2015-03-31/smoke-2.json b/tools/code-generation/api-descriptions/lambda/2015-03-31/smoke-2.json deleted file mode 100644 index aeb58c16e7a1..000000000000 --- a/tools/code-generation/api-descriptions/lambda/2015-03-31/smoke-2.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "version" : 2, - "testCases" : [ { - "id" : "ListFunctionsSuccess", - "operationName" : "ListFunctions", - "input" : { }, - "expectation" : { - "success" : { } - }, - "config" : { - "region" : "us-west-2", - "useFips" : false, - "useDualstack" : false, - "useAccountIdRouting" : true - } - }, { - "id" : "ErrorInvalidFunctionName", - "operationName" : "Invoke", - "input" : { - "FunctionName" : "bogus-function" - }, - "expectation" : { - "failure" : { - "errorId" : "ResourceNotFoundException" - } - }, - "config" : { - "region" : "us-west-2", - "useFips" : false, - "useDualstack" : false, - "useAccountIdRouting" : true - } - } ] -} \ No newline at end of file diff --git a/tools/code-generation/api-descriptions/lambda/2015-03-31/waiters-2.json b/tools/code-generation/api-descriptions/lambda/2015-03-31/waiters-2.json deleted file mode 100644 index 92defa11eb2b..000000000000 --- a/tools/code-generation/api-descriptions/lambda/2015-03-31/waiters-2.json +++ /dev/null @@ -1,129 +0,0 @@ -{ - "version" : 2, - "waiters" : { - "FunctionActive" : { - "description" : "Waits for the function's State to be Active. This waiter uses GetFunctionConfiguration API. This should be used after new function creation.", - "delay" : 5, - "maxAttempts" : 60, - "operation" : "GetFunctionConfiguration", - "acceptors" : [ { - "matcher" : "path", - "argument" : "State", - "state" : "success", - "expected" : "Active" - }, { - "matcher" : "path", - "argument" : "State", - "state" : "failure", - "expected" : "Failed" - }, { - "matcher" : "path", - "argument" : "State", - "state" : "retry", - "expected" : "Pending" - } ] - }, - "FunctionActiveV2" : { - "description" : "Waits for the function's State to be Active. This waiter uses GetFunction API. This should be used after new function creation.", - "delay" : 1, - "maxAttempts" : 300, - "operation" : "GetFunction", - "acceptors" : [ { - "matcher" : "path", - "argument" : "Configuration.State", - "state" : "success", - "expected" : "Active" - }, { - "matcher" : "path", - "argument" : "Configuration.State", - "state" : "failure", - "expected" : "Failed" - }, { - "matcher" : "path", - "argument" : "Configuration.State", - "state" : "retry", - "expected" : "Pending" - } ] - }, - "FunctionExists" : { - "delay" : 1, - "maxAttempts" : 20, - "operation" : "GetFunction", - "acceptors" : [ { - "matcher" : "error", - "state" : "success", - "expected" : false - }, { - "matcher" : "error", - "state" : "retry", - "expected" : "ResourceNotFoundException" - } ] - }, - "FunctionUpdated" : { - "description" : "Waits for the function's LastUpdateStatus to be Successful. This waiter uses GetFunctionConfiguration API. This should be used after function updates.", - "delay" : 5, - "maxAttempts" : 60, - "operation" : "GetFunctionConfiguration", - "acceptors" : [ { - "matcher" : "path", - "argument" : "LastUpdateStatus", - "state" : "success", - "expected" : "Successful" - }, { - "matcher" : "path", - "argument" : "LastUpdateStatus", - "state" : "failure", - "expected" : "Failed" - }, { - "matcher" : "path", - "argument" : "LastUpdateStatus", - "state" : "retry", - "expected" : "InProgress" - } ] - }, - "FunctionUpdatedV2" : { - "description" : "Waits for the function's LastUpdateStatus to be Successful. This waiter uses GetFunction API. This should be used after function updates.", - "delay" : 1, - "maxAttempts" : 300, - "operation" : "GetFunction", - "acceptors" : [ { - "matcher" : "path", - "argument" : "Configuration.LastUpdateStatus", - "state" : "success", - "expected" : "Successful" - }, { - "matcher" : "path", - "argument" : "Configuration.LastUpdateStatus", - "state" : "failure", - "expected" : "Failed" - }, { - "matcher" : "path", - "argument" : "Configuration.LastUpdateStatus", - "state" : "retry", - "expected" : "InProgress" - } ] - }, - "PublishedVersionActive" : { - "description" : "Waits for the published version's State to be Active. This waiter uses GetFunctionConfiguration API. This should be used after new version is published.", - "delay" : 5, - "maxAttempts" : 312, - "operation" : "GetFunctionConfiguration", - "acceptors" : [ { - "matcher" : "path", - "argument" : "State", - "state" : "success", - "expected" : "Active" - }, { - "matcher" : "path", - "argument" : "State", - "state" : "failure", - "expected" : "Failed" - }, { - "matcher" : "path", - "argument" : "State", - "state" : "retry", - "expected" : "Pending" - } ] - } - } -} \ No newline at end of file diff --git a/tools/code-generation/api-descriptions/network-firewall/2020-11-12/api-2.json b/tools/code-generation/api-descriptions/network-firewall/2020-11-12/api-2.json deleted file mode 100644 index a80027f72bf1..000000000000 --- a/tools/code-generation/api-descriptions/network-firewall/2020-11-12/api-2.json +++ /dev/null @@ -1,4902 +0,0 @@ -{ - "version":"2.0", - "metadata":{ - "apiVersion":"2020-11-12", - "endpointPrefix":"network-firewall", - "jsonVersion":"1.0", - "protocol":"json", - "protocols":["json"], - "serviceAbbreviation":"Network Firewall", - "serviceFullName":"AWS Network Firewall", - "serviceId":"Network Firewall", - "signatureVersion":"v4", - "signingName":"network-firewall", - "targetPrefix":"NetworkFirewall_20201112", - "uid":"network-firewall-2020-11-12", - "auth":["aws.auth#sigv4"] - }, - "operations":{ - "AcceptNetworkFirewallTransitGatewayAttachment":{ - "name":"AcceptNetworkFirewallTransitGatewayAttachment", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AcceptNetworkFirewallTransitGatewayAttachmentRequest"}, - "output":{"shape":"AcceptNetworkFirewallTransitGatewayAttachmentResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ] - }, - "AssociateAvailabilityZones":{ - "name":"AssociateAvailabilityZones", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AssociateAvailabilityZonesRequest"}, - "output":{"shape":"AssociateAvailabilityZonesResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InvalidTokenException"}, - {"shape":"InvalidOperationException"}, - {"shape":"InsufficientCapacityException"} - ] - }, - "AssociateFirewallPolicy":{ - "name":"AssociateFirewallPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AssociateFirewallPolicyRequest"}, - "output":{"shape":"AssociateFirewallPolicyResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InvalidTokenException"}, - {"shape":"InvalidOperationException"} - ] - }, - "AssociateSubnets":{ - "name":"AssociateSubnets", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AssociateSubnetsRequest"}, - "output":{"shape":"AssociateSubnetsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InvalidTokenException"}, - {"shape":"InvalidOperationException"}, - {"shape":"InsufficientCapacityException"} - ] - }, - "AttachRuleGroupsToProxyConfiguration":{ - "name":"AttachRuleGroupsToProxyConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AttachRuleGroupsToProxyConfigurationRequest"}, - "output":{"shape":"AttachRuleGroupsToProxyConfigurationResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ] - }, - "CreateContainerAssociation":{ - "name":"CreateContainerAssociation", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateContainerAssociationRequest"}, - "output":{"shape":"CreateContainerAssociationResponse"}, - "errors":[ - {"shape":"LimitExceededException"}, - {"shape":"InvalidRequestException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"}, - {"shape":"InsufficientCapacityException"} - ] - }, - "CreateFirewall":{ - "name":"CreateFirewall", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateFirewallRequest"}, - "output":{"shape":"CreateFirewallResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"LimitExceededException"}, - {"shape":"InternalServerError"}, - {"shape":"ThrottlingException"}, - {"shape":"InsufficientCapacityException"}, - {"shape":"InvalidOperationException"} - ] - }, - "CreateFirewallPolicy":{ - "name":"CreateFirewallPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateFirewallPolicyRequest"}, - "output":{"shape":"CreateFirewallPolicyResponse"}, - "errors":[ - {"shape":"LimitExceededException"}, - {"shape":"InvalidRequestException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"}, - {"shape":"InsufficientCapacityException"} - ] - }, - "CreateProxy":{ - "name":"CreateProxy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateProxyRequest"}, - "output":{"shape":"CreateProxyResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"UnsupportedOperationException"}, - {"shape":"LimitExceededException"}, - {"shape":"ThrottlingException"} - ] - }, - "CreateProxyConfiguration":{ - "name":"CreateProxyConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateProxyConfigurationRequest"}, - "output":{"shape":"CreateProxyConfigurationResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"LimitExceededException"}, - {"shape":"ThrottlingException"} - ] - }, - "CreateProxyRuleGroup":{ - "name":"CreateProxyRuleGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateProxyRuleGroupRequest"}, - "output":{"shape":"CreateProxyRuleGroupResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"LimitExceededException"}, - {"shape":"ThrottlingException"} - ] - }, - "CreateProxyRules":{ - "name":"CreateProxyRules", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateProxyRulesRequest"}, - "output":{"shape":"CreateProxyRulesResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ThrottlingException"} - ] - }, - "CreateRuleGroup":{ - "name":"CreateRuleGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateRuleGroupRequest"}, - "output":{"shape":"CreateRuleGroupResponse"}, - "errors":[ - {"shape":"LimitExceededException"}, - {"shape":"InvalidRequestException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"}, - {"shape":"InsufficientCapacityException"} - ] - }, - "CreateTLSInspectionConfiguration":{ - "name":"CreateTLSInspectionConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateTLSInspectionConfigurationRequest"}, - "output":{"shape":"CreateTLSInspectionConfigurationResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"}, - {"shape":"LimitExceededException"}, - {"shape":"InsufficientCapacityException"} - ] - }, - "CreateVpcEndpointAssociation":{ - "name":"CreateVpcEndpointAssociation", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateVpcEndpointAssociationRequest"}, - "output":{"shape":"CreateVpcEndpointAssociationResponse"}, - "errors":[ - {"shape":"LimitExceededException"}, - {"shape":"InvalidRequestException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"}, - {"shape":"InsufficientCapacityException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidOperationException"} - ] - }, - "DeleteContainerAssociation":{ - "name":"DeleteContainerAssociation", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteContainerAssociationRequest"}, - "output":{"shape":"DeleteContainerAssociationResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InvalidOperationException"} - ] - }, - "DeleteFirewall":{ - "name":"DeleteFirewall", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteFirewallRequest"}, - "output":{"shape":"DeleteFirewallResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"UnsupportedOperationException"}, - {"shape":"InvalidOperationException"} - ] - }, - "DeleteFirewallPolicy":{ - "name":"DeleteFirewallPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteFirewallPolicyRequest"}, - "output":{"shape":"DeleteFirewallPolicyResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"}, - {"shape":"UnsupportedOperationException"}, - {"shape":"InvalidOperationException"} - ] - }, - "DeleteNetworkFirewallTransitGatewayAttachment":{ - "name":"DeleteNetworkFirewallTransitGatewayAttachment", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteNetworkFirewallTransitGatewayAttachmentRequest"}, - "output":{"shape":"DeleteNetworkFirewallTransitGatewayAttachmentResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ] - }, - "DeleteProxy":{ - "name":"DeleteProxy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteProxyRequest"}, - "output":{"shape":"DeleteProxyResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"UnsupportedOperationException"}, - {"shape":"ThrottlingException"} - ] - }, - "DeleteProxyConfiguration":{ - "name":"DeleteProxyConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteProxyConfigurationRequest"}, - "output":{"shape":"DeleteProxyConfigurationResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ] - }, - "DeleteProxyRuleGroup":{ - "name":"DeleteProxyRuleGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteProxyRuleGroupRequest"}, - "output":{"shape":"DeleteProxyRuleGroupResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ] - }, - "DeleteProxyRules":{ - "name":"DeleteProxyRules", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteProxyRulesRequest"}, - "output":{"shape":"DeleteProxyRulesResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ] - }, - "DeleteResourcePolicy":{ - "name":"DeleteResourcePolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteResourcePolicyRequest"}, - "output":{"shape":"DeleteResourcePolicyResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InvalidResourcePolicyException"} - ] - }, - "DeleteRuleGroup":{ - "name":"DeleteRuleGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteRuleGroupRequest"}, - "output":{"shape":"DeleteRuleGroupResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"}, - {"shape":"UnsupportedOperationException"}, - {"shape":"InvalidOperationException"} - ] - }, - "DeleteTLSInspectionConfiguration":{ - "name":"DeleteTLSInspectionConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteTLSInspectionConfigurationRequest"}, - "output":{"shape":"DeleteTLSInspectionConfigurationResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InvalidOperationException"} - ] - }, - "DeleteVpcEndpointAssociation":{ - "name":"DeleteVpcEndpointAssociation", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteVpcEndpointAssociationRequest"}, - "output":{"shape":"DeleteVpcEndpointAssociationResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InvalidOperationException"} - ] - }, - "DescribeContainerAssociation":{ - "name":"DescribeContainerAssociation", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeContainerAssociationRequest"}, - "output":{"shape":"DescribeContainerAssociationResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ] - }, - "DescribeFirewall":{ - "name":"DescribeFirewall", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeFirewallRequest"}, - "output":{"shape":"DescribeFirewallResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ] - }, - "DescribeFirewallMetadata":{ - "name":"DescribeFirewallMetadata", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeFirewallMetadataRequest"}, - "output":{"shape":"DescribeFirewallMetadataResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ] - }, - "DescribeFirewallPolicy":{ - "name":"DescribeFirewallPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeFirewallPolicyRequest"}, - "output":{"shape":"DescribeFirewallPolicyResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"} - ] - }, - "DescribeFlowOperation":{ - "name":"DescribeFlowOperation", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeFlowOperationRequest"}, - "output":{"shape":"DescribeFlowOperationResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ] - }, - "DescribeLoggingConfiguration":{ - "name":"DescribeLoggingConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeLoggingConfigurationRequest"}, - "output":{"shape":"DescribeLoggingConfigurationResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ] - }, - "DescribeProxy":{ - "name":"DescribeProxy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeProxyRequest"}, - "output":{"shape":"DescribeProxyResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ] - }, - "DescribeProxyConfiguration":{ - "name":"DescribeProxyConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeProxyConfigurationRequest"}, - "output":{"shape":"DescribeProxyConfigurationResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ] - }, - "DescribeProxyRule":{ - "name":"DescribeProxyRule", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeProxyRuleRequest"}, - "output":{"shape":"DescribeProxyRuleResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ] - }, - "DescribeProxyRuleGroup":{ - "name":"DescribeProxyRuleGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeProxyRuleGroupRequest"}, - "output":{"shape":"DescribeProxyRuleGroupResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ] - }, - "DescribeResourcePolicy":{ - "name":"DescribeResourcePolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeResourcePolicyRequest"}, - "output":{"shape":"DescribeResourcePolicyResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ] - }, - "DescribeRuleGroup":{ - "name":"DescribeRuleGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeRuleGroupRequest"}, - "output":{"shape":"DescribeRuleGroupResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"} - ] - }, - "DescribeRuleGroupMetadata":{ - "name":"DescribeRuleGroupMetadata", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeRuleGroupMetadataRequest"}, - "output":{"shape":"DescribeRuleGroupMetadataResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"} - ] - }, - "DescribeRuleGroupSummary":{ - "name":"DescribeRuleGroupSummary", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeRuleGroupSummaryRequest"}, - "output":{"shape":"DescribeRuleGroupSummaryResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"} - ] - }, - "DescribeTLSInspectionConfiguration":{ - "name":"DescribeTLSInspectionConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeTLSInspectionConfigurationRequest"}, - "output":{"shape":"DescribeTLSInspectionConfigurationResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ] - }, - "DescribeVpcEndpointAssociation":{ - "name":"DescribeVpcEndpointAssociation", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeVpcEndpointAssociationRequest"}, - "output":{"shape":"DescribeVpcEndpointAssociationResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ] - }, - "DetachRuleGroupsFromProxyConfiguration":{ - "name":"DetachRuleGroupsFromProxyConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DetachRuleGroupsFromProxyConfigurationRequest"}, - "output":{"shape":"DetachRuleGroupsFromProxyConfigurationResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ] - }, - "DisassociateAvailabilityZones":{ - "name":"DisassociateAvailabilityZones", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DisassociateAvailabilityZonesRequest"}, - "output":{"shape":"DisassociateAvailabilityZonesResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InvalidTokenException"}, - {"shape":"InvalidOperationException"} - ] - }, - "DisassociateSubnets":{ - "name":"DisassociateSubnets", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DisassociateSubnetsRequest"}, - "output":{"shape":"DisassociateSubnetsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InvalidTokenException"}, - {"shape":"InvalidOperationException"} - ] - }, - "GetAnalysisReportResults":{ - "name":"GetAnalysisReportResults", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetAnalysisReportResultsRequest"}, - "output":{"shape":"GetAnalysisReportResultsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ] - }, - "ListAnalysisReports":{ - "name":"ListAnalysisReports", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListAnalysisReportsRequest"}, - "output":{"shape":"ListAnalysisReportsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ] - }, - "ListContainerAssociations":{ - "name":"ListContainerAssociations", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListContainerAssociationsRequest"}, - "output":{"shape":"ListContainerAssociationsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ThrottlingException"} - ] - }, - "ListFirewallPolicies":{ - "name":"ListFirewallPolicies", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListFirewallPoliciesRequest"}, - "output":{"shape":"ListFirewallPoliciesResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"} - ] - }, - "ListFirewalls":{ - "name":"ListFirewalls", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListFirewallsRequest"}, - "output":{"shape":"ListFirewallsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ThrottlingException"} - ] - }, - "ListFlowOperationResults":{ - "name":"ListFlowOperationResults", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListFlowOperationResultsRequest"}, - "output":{"shape":"ListFlowOperationResultsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ] - }, - "ListFlowOperations":{ - "name":"ListFlowOperations", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListFlowOperationsRequest"}, - "output":{"shape":"ListFlowOperationsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ] - }, - "ListProxies":{ - "name":"ListProxies", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListProxiesRequest"}, - "output":{"shape":"ListProxiesResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ThrottlingException"} - ] - }, - "ListProxyConfigurations":{ - "name":"ListProxyConfigurations", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListProxyConfigurationsRequest"}, - "output":{"shape":"ListProxyConfigurationsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ] - }, - "ListProxyRuleGroups":{ - "name":"ListProxyRuleGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListProxyRuleGroupsRequest"}, - "output":{"shape":"ListProxyRuleGroupsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ] - }, - "ListRuleGroups":{ - "name":"ListRuleGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListRuleGroupsRequest"}, - "output":{"shape":"ListRuleGroupsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"} - ] - }, - "ListTLSInspectionConfigurations":{ - "name":"ListTLSInspectionConfigurations", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListTLSInspectionConfigurationsRequest"}, - "output":{"shape":"ListTLSInspectionConfigurationsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ThrottlingException"} - ] - }, - "ListTagsForResource":{ - "name":"ListTagsForResource", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListTagsForResourceRequest"}, - "output":{"shape":"ListTagsForResourceResponse"}, - "errors":[ - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidRequestException"} - ] - }, - "ListVpcEndpointAssociations":{ - "name":"ListVpcEndpointAssociations", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListVpcEndpointAssociationsRequest"}, - "output":{"shape":"ListVpcEndpointAssociationsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"} - ] - }, - "PutResourcePolicy":{ - "name":"PutResourcePolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"PutResourcePolicyRequest"}, - "output":{"shape":"PutResourcePolicyResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InvalidResourcePolicyException"} - ] - }, - "RejectNetworkFirewallTransitGatewayAttachment":{ - "name":"RejectNetworkFirewallTransitGatewayAttachment", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RejectNetworkFirewallTransitGatewayAttachmentRequest"}, - "output":{"shape":"RejectNetworkFirewallTransitGatewayAttachmentResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ] - }, - "StartAnalysisReport":{ - "name":"StartAnalysisReport", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StartAnalysisReportRequest"}, - "output":{"shape":"StartAnalysisReportResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ] - }, - "StartFlowCapture":{ - "name":"StartFlowCapture", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StartFlowCaptureRequest"}, - "output":{"shape":"StartFlowCaptureResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ] - }, - "StartFlowFlush":{ - "name":"StartFlowFlush", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StartFlowFlushRequest"}, - "output":{"shape":"StartFlowFlushResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ] - }, - "TagResource":{ - "name":"TagResource", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"TagResourceRequest"}, - "output":{"shape":"TagResourceResponse"}, - "errors":[ - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidRequestException"} - ] - }, - "UntagResource":{ - "name":"UntagResource", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UntagResourceRequest"}, - "output":{"shape":"UntagResourceResponse"}, - "errors":[ - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidRequestException"} - ] - }, - "UpdateAvailabilityZoneChangeProtection":{ - "name":"UpdateAvailabilityZoneChangeProtection", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateAvailabilityZoneChangeProtectionRequest"}, - "output":{"shape":"UpdateAvailabilityZoneChangeProtectionResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InvalidTokenException"}, - {"shape":"ResourceOwnerCheckException"} - ] - }, - "UpdateContainerAssociation":{ - "name":"UpdateContainerAssociation", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateContainerAssociationRequest"}, - "output":{"shape":"UpdateContainerAssociationResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidRequestException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"}, - {"shape":"InvalidTokenException"} - ] - }, - "UpdateFirewallAnalysisSettings":{ - "name":"UpdateFirewallAnalysisSettings", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateFirewallAnalysisSettingsRequest"}, - "output":{"shape":"UpdateFirewallAnalysisSettingsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InvalidTokenException"} - ] - }, - "UpdateFirewallDeleteProtection":{ - "name":"UpdateFirewallDeleteProtection", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateFirewallDeleteProtectionRequest"}, - "output":{"shape":"UpdateFirewallDeleteProtectionResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InvalidTokenException"}, - {"shape":"ResourceOwnerCheckException"} - ] - }, - "UpdateFirewallDescription":{ - "name":"UpdateFirewallDescription", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateFirewallDescriptionRequest"}, - "output":{"shape":"UpdateFirewallDescriptionResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InvalidTokenException"} - ] - }, - "UpdateFirewallEncryptionConfiguration":{ - "name":"UpdateFirewallEncryptionConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateFirewallEncryptionConfigurationRequest"}, - "output":{"shape":"UpdateFirewallEncryptionConfigurationResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InvalidTokenException"}, - {"shape":"ResourceOwnerCheckException"} - ] - }, - "UpdateFirewallPolicy":{ - "name":"UpdateFirewallPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateFirewallPolicyRequest"}, - "output":{"shape":"UpdateFirewallPolicyResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"}, - {"shape":"InvalidTokenException"} - ] - }, - "UpdateFirewallPolicyChangeProtection":{ - "name":"UpdateFirewallPolicyChangeProtection", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateFirewallPolicyChangeProtectionRequest"}, - "output":{"shape":"UpdateFirewallPolicyChangeProtectionResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InvalidTokenException"}, - {"shape":"ResourceOwnerCheckException"} - ] - }, - "UpdateLoggingConfiguration":{ - "name":"UpdateLoggingConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateLoggingConfigurationRequest"}, - "output":{"shape":"UpdateLoggingConfigurationResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InvalidTokenException"}, - {"shape":"LogDestinationPermissionException"} - ] - }, - "UpdateProxy":{ - "name":"UpdateProxy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateProxyRequest"}, - "output":{"shape":"UpdateProxyResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"UnsupportedOperationException"}, - {"shape":"ThrottlingException"} - ] - }, - "UpdateProxyConfiguration":{ - "name":"UpdateProxyConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateProxyConfigurationRequest"}, - "output":{"shape":"UpdateProxyConfigurationResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ] - }, - "UpdateProxyRule":{ - "name":"UpdateProxyRule", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateProxyRuleRequest"}, - "output":{"shape":"UpdateProxyRuleResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ] - }, - "UpdateProxyRuleGroupPriorities":{ - "name":"UpdateProxyRuleGroupPriorities", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateProxyRuleGroupPrioritiesRequest"}, - "output":{"shape":"UpdateProxyRuleGroupPrioritiesResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ] - }, - "UpdateProxyRulePriorities":{ - "name":"UpdateProxyRulePriorities", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateProxyRulePrioritiesRequest"}, - "output":{"shape":"UpdateProxyRulePrioritiesResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ] - }, - "UpdateRuleGroup":{ - "name":"UpdateRuleGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateRuleGroupRequest"}, - "output":{"shape":"UpdateRuleGroupResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidRequestException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"}, - {"shape":"InvalidTokenException"} - ] - }, - "UpdateSubnetChangeProtection":{ - "name":"UpdateSubnetChangeProtection", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateSubnetChangeProtectionRequest"}, - "output":{"shape":"UpdateSubnetChangeProtectionResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InvalidTokenException"}, - {"shape":"ResourceOwnerCheckException"} - ] - }, - "UpdateTLSInspectionConfiguration":{ - "name":"UpdateTLSInspectionConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateTLSInspectionConfigurationRequest"}, - "output":{"shape":"UpdateTLSInspectionConfigurationResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"}, - {"shape":"InvalidTokenException"} - ] - } - }, - "shapes":{ - "AWSAccountId":{ - "type":"string", - "max":12, - "min":12, - "pattern":"^\\d{12}$" - }, - "AZSyncState":{ - "type":"structure", - "members":{ - "Attachment":{"shape":"Attachment"} - } - }, - "AcceptNetworkFirewallTransitGatewayAttachmentRequest":{ - "type":"structure", - "required":["TransitGatewayAttachmentId"], - "members":{ - "TransitGatewayAttachmentId":{"shape":"TransitGatewayAttachmentId"} - } - }, - "AcceptNetworkFirewallTransitGatewayAttachmentResponse":{ - "type":"structure", - "required":[ - "TransitGatewayAttachmentId", - "TransitGatewayAttachmentStatus" - ], - "members":{ - "TransitGatewayAttachmentId":{"shape":"TransitGatewayAttachmentId"}, - "TransitGatewayAttachmentStatus":{"shape":"TransitGatewayAttachmentStatus"} - } - }, - "ActionDefinition":{ - "type":"structure", - "members":{ - "PublishMetricAction":{"shape":"PublishMetricAction"} - } - }, - "ActionName":{ - "type":"string", - "max":128, - "min":1, - "pattern":"^[a-zA-Z0-9]+$" - }, - "Address":{ - "type":"structure", - "required":["AddressDefinition"], - "members":{ - "AddressDefinition":{"shape":"AddressDefinition"} - } - }, - "AddressDefinition":{ - "type":"string", - "max":255, - "min":1, - "pattern":"^([a-fA-F\\d:\\.]+($|/\\d{1,3}))$" - }, - "Addresses":{ - "type":"list", - "member":{"shape":"Address"} - }, - "Age":{"type":"integer"}, - "AnalysisReport":{ - "type":"structure", - "members":{ - "AnalysisReportId":{"shape":"AnalysisReportId"}, - "AnalysisType":{"shape":"EnabledAnalysisType"}, - "ReportTime":{"shape":"ReportTime"}, - "Status":{"shape":"Status"} - } - }, - "AnalysisReportId":{ - "type":"string", - "max":128, - "min":1, - "pattern":"\\S+" - }, - "AnalysisReportNextToken":{ - "type":"string", - "max":1024, - "min":1 - }, - "AnalysisReportResults":{ - "type":"list", - "member":{"shape":"AnalysisTypeReportResult"} - }, - "AnalysisReports":{ - "type":"list", - "member":{"shape":"AnalysisReport"} - }, - "AnalysisResult":{ - "type":"structure", - "members":{ - "IdentifiedRuleIds":{"shape":"RuleIdList"}, - "IdentifiedType":{"shape":"IdentifiedType"}, - "AnalysisDetail":{"shape":"CollectionMember_String"} - } - }, - "AnalysisResultList":{ - "type":"list", - "member":{"shape":"AnalysisResult"} - }, - "AnalysisTypeReportResult":{ - "type":"structure", - "members":{ - "Protocol":{"shape":"CollectionMember_String"}, - "FirstAccessed":{"shape":"FirstAccessed"}, - "LastAccessed":{"shape":"LastAccessed"}, - "Domain":{"shape":"Domain"}, - "Hits":{"shape":"Hits"}, - "UniqueSources":{"shape":"UniqueSources"} - } - }, - "AssociateAvailabilityZonesRequest":{ - "type":"structure", - "required":["AvailabilityZoneMappings"], - "members":{ - "UpdateToken":{"shape":"UpdateToken"}, - "FirewallArn":{"shape":"ResourceArn"}, - "FirewallName":{"shape":"ResourceName"}, - "AvailabilityZoneMappings":{"shape":"AvailabilityZoneMappings"} - } - }, - "AssociateAvailabilityZonesResponse":{ - "type":"structure", - "members":{ - "FirewallArn":{"shape":"ResourceArn"}, - "FirewallName":{"shape":"ResourceName"}, - "AvailabilityZoneMappings":{"shape":"AvailabilityZoneMappings"}, - "UpdateToken":{"shape":"UpdateToken"} - } - }, - "AssociateFirewallPolicyRequest":{ - "type":"structure", - "required":["FirewallPolicyArn"], - "members":{ - "UpdateToken":{"shape":"UpdateToken"}, - "FirewallArn":{"shape":"ResourceArn"}, - "FirewallName":{"shape":"ResourceName"}, - "FirewallPolicyArn":{"shape":"ResourceArn"} - } - }, - "AssociateFirewallPolicyResponse":{ - "type":"structure", - "members":{ - "FirewallArn":{"shape":"ResourceArn"}, - "FirewallName":{"shape":"ResourceName"}, - "FirewallPolicyArn":{"shape":"ResourceArn"}, - "UpdateToken":{"shape":"UpdateToken"} - } - }, - "AssociateSubnetsRequest":{ - "type":"structure", - "required":["SubnetMappings"], - "members":{ - "UpdateToken":{"shape":"UpdateToken"}, - "FirewallArn":{"shape":"ResourceArn"}, - "FirewallName":{"shape":"ResourceName"}, - "SubnetMappings":{"shape":"SubnetMappings"} - } - }, - "AssociateSubnetsResponse":{ - "type":"structure", - "members":{ - "FirewallArn":{"shape":"ResourceArn"}, - "FirewallName":{"shape":"ResourceName"}, - "SubnetMappings":{"shape":"SubnetMappings"}, - "UpdateToken":{"shape":"UpdateToken"} - } - }, - "AssociationSyncState":{ - "type":"map", - "key":{"shape":"AvailabilityZone"}, - "value":{"shape":"AZSyncState"} - }, - "AttachRuleGroupsToProxyConfigurationRequest":{ - "type":"structure", - "required":[ - "RuleGroups", - "UpdateToken" - ], - "members":{ - "ProxyConfigurationName":{"shape":"ResourceName"}, - "ProxyConfigurationArn":{"shape":"ResourceArn"}, - "RuleGroups":{"shape":"ProxyRuleGroupAttachmentList"}, - "UpdateToken":{"shape":"UpdateToken"} - } - }, - "AttachRuleGroupsToProxyConfigurationResponse":{ - "type":"structure", - "members":{ - "ProxyConfiguration":{"shape":"ProxyConfiguration"}, - "UpdateToken":{"shape":"UpdateToken"} - } - }, - "Attachment":{ - "type":"structure", - "members":{ - "SubnetId":{"shape":"AzSubnet"}, - "EndpointId":{"shape":"EndpointId"}, - "Status":{"shape":"AttachmentStatus"}, - "StatusMessage":{"shape":"StatusMessage"} - } - }, - "AttachmentId":{"type":"string"}, - "AttachmentStatus":{ - "type":"string", - "enum":[ - "CREATING", - "DELETING", - "FAILED", - "ERROR", - "SCALING", - "READY" - ] - }, - "AvailabilityZone":{"type":"string"}, - "AvailabilityZoneMapping":{ - "type":"structure", - "required":["AvailabilityZone"], - "members":{ - "AvailabilityZone":{"shape":"AvailabilityZoneMappingString"} - } - }, - "AvailabilityZoneMappingString":{ - "type":"string", - "max":128, - "min":1, - "pattern":"\\S+" - }, - "AvailabilityZoneMappings":{ - "type":"list", - "member":{"shape":"AvailabilityZoneMapping"} - }, - "AvailabilityZoneMetadata":{ - "type":"structure", - "members":{ - "IPAddressType":{"shape":"IPAddressType"} - } - }, - "AzSubnet":{ - "type":"string", - "max":128, - "min":1, - "pattern":"^subnet-[0-9a-f]+$" - }, - "AzSubnets":{ - "type":"list", - "member":{"shape":"AzSubnet"} - }, - "Boolean":{"type":"boolean"}, - "ByteCount":{"type":"long"}, - "CIDRCount":{ - "type":"integer", - "max":1000000, - "min":0 - }, - "CIDRSummary":{ - "type":"structure", - "members":{ - "AvailableCIDRCount":{"shape":"CIDRCount"}, - "UtilizedCIDRCount":{"shape":"CIDRCount"}, - "IPSetReferences":{"shape":"IPSetMetadataMap"} - } - }, - "CapacityUsageSummary":{ - "type":"structure", - "members":{ - "CIDRs":{"shape":"CIDRSummary"} - } - }, - "Certificates":{ - "type":"list", - "member":{"shape":"TlsCertificateData"} - }, - "CheckCertificateRevocationStatusActions":{ - "type":"structure", - "members":{ - "RevokedStatusAction":{"shape":"RevocationCheckAction"}, - "UnknownStatusAction":{"shape":"RevocationCheckAction"} - } - }, - "CollectionMember_String":{"type":"string"}, - "ConditionKey":{"type":"string"}, - "ConditionOperator":{"type":"string"}, - "ConfigurationSyncState":{ - "type":"string", - "enum":[ - "PENDING", - "IN_SYNC", - "CAPACITY_CONSTRAINED" - ] - }, - "ContainerAssociationLastUpdatedTime":{"type":"timestamp"}, - "ContainerAssociationStatus":{ - "type":"string", - "enum":[ - "ACTIVE", - "CREATING", - "DELETING", - "UPDATING" - ] - }, - "ContainerAssociationSummary":{ - "type":"structure", - "members":{ - "Arn":{"shape":"ResourceArn"}, - "Name":{"shape":"ResourceName"} - } - }, - "ContainerAssociations":{ - "type":"list", - "member":{"shape":"ContainerAssociationSummary"} - }, - "ContainerAttribute":{ - "type":"structure", - "required":[ - "Key", - "Value" - ], - "members":{ - "Key":{"shape":"ContainerAttributeKey"}, - "Value":{"shape":"ContainerAttributeValue"} - } - }, - "ContainerAttributeKey":{ - "type":"string", - "max":256, - "min":1, - "pattern":"\\S+" - }, - "ContainerAttributeValue":{ - "type":"string", - "max":256, - "min":1, - "pattern":"\\S+" - }, - "ContainerAttributes":{ - "type":"list", - "member":{"shape":"ContainerAttribute"} - }, - "ContainerMonitoringConfiguration":{ - "type":"structure", - "required":["ClusterArn"], - "members":{ - "ClusterArn":{"shape":"ResourceArn"}, - "AttributeFilters":{"shape":"ContainerAttributes"} - } - }, - "ContainerMonitoringConfigurations":{ - "type":"list", - "member":{"shape":"ContainerMonitoringConfiguration"} - }, - "ContainerMonitoringType":{ - "type":"string", - "enum":[ - "ECS", - "EKS" - ] - }, - "Count":{"type":"integer"}, - "CreateContainerAssociationRequest":{ - "type":"structure", - "required":[ - "ContainerAssociationName", - "Type", - "ContainerMonitoringConfigurations" - ], - "members":{ - "ContainerAssociationName":{"shape":"ResourceName"}, - "Description":{"shape":"Description"}, - "Type":{"shape":"ContainerMonitoringType"}, - "ContainerMonitoringConfigurations":{"shape":"ContainerMonitoringConfigurations"}, - "Tags":{"shape":"TagList"} - } - }, - "CreateContainerAssociationResponse":{ - "type":"structure", - "members":{ - "ContainerAssociationName":{"shape":"ResourceName"}, - "ContainerAssociationArn":{"shape":"ResourceArn"}, - "Description":{"shape":"Description"}, - "Type":{"shape":"ContainerMonitoringType"}, - "ContainerMonitoringConfigurations":{"shape":"ContainerMonitoringConfigurations"}, - "Status":{"shape":"ContainerAssociationStatus"}, - "Tags":{"shape":"TagList"}, - "UpdateToken":{"shape":"UpdateToken"} - } - }, - "CreateFirewallPolicyRequest":{ - "type":"structure", - "required":[ - "FirewallPolicyName", - "FirewallPolicy" - ], - "members":{ - "FirewallPolicyName":{"shape":"ResourceName"}, - "FirewallPolicy":{"shape":"FirewallPolicy"}, - "Description":{"shape":"Description"}, - "Tags":{"shape":"TagList"}, - "DryRun":{"shape":"Boolean"}, - "EncryptionConfiguration":{"shape":"EncryptionConfiguration"} - } - }, - "CreateFirewallPolicyResponse":{ - "type":"structure", - "required":[ - "UpdateToken", - "FirewallPolicyResponse" - ], - "members":{ - "UpdateToken":{"shape":"UpdateToken"}, - "FirewallPolicyResponse":{"shape":"FirewallPolicyResponse"} - } - }, - "CreateFirewallRequest":{ - "type":"structure", - "required":[ - "FirewallName", - "FirewallPolicyArn" - ], - "members":{ - "FirewallName":{"shape":"ResourceName"}, - "FirewallPolicyArn":{"shape":"ResourceArn"}, - "VpcId":{"shape":"VpcId"}, - "SubnetMappings":{"shape":"SubnetMappings"}, - "DeleteProtection":{"shape":"Boolean"}, - "SubnetChangeProtection":{"shape":"Boolean"}, - "FirewallPolicyChangeProtection":{"shape":"Boolean"}, - "Description":{"shape":"Description"}, - "Tags":{"shape":"TagList"}, - "EncryptionConfiguration":{"shape":"EncryptionConfiguration"}, - "EnabledAnalysisTypes":{"shape":"EnabledAnalysisTypes"}, - "TransitGatewayId":{"shape":"TransitGatewayId"}, - "AvailabilityZoneMappings":{"shape":"AvailabilityZoneMappings"}, - "AvailabilityZoneChangeProtection":{"shape":"Boolean"} - } - }, - "CreateFirewallResponse":{ - "type":"structure", - "members":{ - "Firewall":{"shape":"Firewall"}, - "FirewallStatus":{"shape":"FirewallStatus"} - } - }, - "CreateProxyConfigurationRequest":{ - "type":"structure", - "required":[ - "ProxyConfigurationName", - "DefaultRulePhaseActions" - ], - "members":{ - "ProxyConfigurationName":{"shape":"ResourceName"}, - "Description":{"shape":"Description"}, - "RuleGroupNames":{"shape":"ResourceNameList"}, - "RuleGroupArns":{"shape":"ResourceArnList"}, - "DefaultRulePhaseActions":{"shape":"ProxyConfigDefaultRulePhaseActionsRequest"}, - "Tags":{"shape":"TagList"} - } - }, - "CreateProxyConfigurationResponse":{ - "type":"structure", - "members":{ - "ProxyConfiguration":{"shape":"ProxyConfiguration"}, - "UpdateToken":{"shape":"UpdateToken"} - } - }, - "CreateProxyRequest":{ - "type":"structure", - "required":[ - "ProxyName", - "NatGatewayId", - "TlsInterceptProperties" - ], - "members":{ - "ProxyName":{"shape":"ResourceName"}, - "NatGatewayId":{"shape":"NatGatewayId"}, - "ProxyConfigurationName":{"shape":"ResourceName"}, - "ProxyConfigurationArn":{"shape":"ResourceArn"}, - "ListenerProperties":{"shape":"ListenerPropertiesRequest"}, - "TlsInterceptProperties":{"shape":"TlsInterceptPropertiesRequest"}, - "Tags":{"shape":"TagList"} - } - }, - "CreateProxyResponse":{ - "type":"structure", - "members":{ - "Proxy":{"shape":"Proxy"}, - "UpdateToken":{"shape":"UpdateToken"} - } - }, - "CreateProxyRule":{ - "type":"structure", - "members":{ - "ProxyRuleName":{"shape":"ResourceName"}, - "Description":{"shape":"Description"}, - "Action":{"shape":"ProxyRulePhaseAction"}, - "Conditions":{"shape":"ProxyRuleConditionList"}, - "InsertPosition":{"shape":"InsertPosition"} - } - }, - "CreateProxyRuleGroupRequest":{ - "type":"structure", - "required":["ProxyRuleGroupName"], - "members":{ - "ProxyRuleGroupName":{"shape":"ResourceName"}, - "Description":{"shape":"Description"}, - "Rules":{"shape":"ProxyRulesByRequestPhase"}, - "Tags":{"shape":"TagList"} - } - }, - "CreateProxyRuleGroupResponse":{ - "type":"structure", - "members":{ - "ProxyRuleGroup":{"shape":"ProxyRuleGroup"}, - "UpdateToken":{"shape":"UpdateToken"} - } - }, - "CreateProxyRuleList":{ - "type":"list", - "member":{"shape":"CreateProxyRule"}, - "max":50, - "min":1 - }, - "CreateProxyRulesByRequestPhase":{ - "type":"structure", - "members":{ - "PreDNS":{"shape":"CreateProxyRuleList"}, - "PreREQUEST":{"shape":"CreateProxyRuleList"}, - "PostRESPONSE":{"shape":"CreateProxyRuleList"} - } - }, - "CreateProxyRulesRequest":{ - "type":"structure", - "required":["Rules"], - "members":{ - "ProxyRuleGroupArn":{"shape":"ResourceArn"}, - "ProxyRuleGroupName":{"shape":"ResourceName"}, - "Rules":{"shape":"CreateProxyRulesByRequestPhase"} - } - }, - "CreateProxyRulesResponse":{ - "type":"structure", - "members":{ - "ProxyRuleGroup":{"shape":"ProxyRuleGroup"}, - "UpdateToken":{"shape":"UpdateToken"} - } - }, - "CreateRuleGroupRequest":{ - "type":"structure", - "required":[ - "RuleGroupName", - "Type", - "Capacity" - ], - "members":{ - "RuleGroupName":{"shape":"ResourceName"}, - "RuleGroup":{"shape":"RuleGroup"}, - "Rules":{"shape":"RulesString"}, - "Type":{"shape":"RuleGroupType"}, - "Description":{"shape":"Description"}, - "Capacity":{"shape":"RuleCapacity"}, - "Tags":{"shape":"TagList"}, - "DryRun":{"shape":"Boolean"}, - "EncryptionConfiguration":{"shape":"EncryptionConfiguration"}, - "SourceMetadata":{"shape":"SourceMetadata"}, - "AnalyzeRuleGroup":{"shape":"Boolean"}, - "SummaryConfiguration":{"shape":"SummaryConfiguration"} - } - }, - "CreateRuleGroupResponse":{ - "type":"structure", - "required":[ - "UpdateToken", - "RuleGroupResponse" - ], - "members":{ - "UpdateToken":{"shape":"UpdateToken"}, - "RuleGroupResponse":{"shape":"RuleGroupResponse"} - } - }, - "CreateTLSInspectionConfigurationRequest":{ - "type":"structure", - "required":[ - "TLSInspectionConfigurationName", - "TLSInspectionConfiguration" - ], - "members":{ - "TLSInspectionConfigurationName":{"shape":"ResourceName"}, - "TLSInspectionConfiguration":{"shape":"TLSInspectionConfiguration"}, - "Description":{"shape":"Description"}, - "Tags":{"shape":"TagList"}, - "EncryptionConfiguration":{"shape":"EncryptionConfiguration"} - } - }, - "CreateTLSInspectionConfigurationResponse":{ - "type":"structure", - "required":[ - "UpdateToken", - "TLSInspectionConfigurationResponse" - ], - "members":{ - "UpdateToken":{"shape":"UpdateToken"}, - "TLSInspectionConfigurationResponse":{"shape":"TLSInspectionConfigurationResponse"} - } - }, - "CreateTime":{"type":"timestamp"}, - "CreateVpcEndpointAssociationRequest":{ - "type":"structure", - "required":[ - "FirewallArn", - "VpcId", - "SubnetMapping" - ], - "members":{ - "FirewallArn":{"shape":"ResourceArn"}, - "VpcId":{"shape":"VpcId"}, - "SubnetMapping":{"shape":"SubnetMapping"}, - "Description":{"shape":"Description"}, - "Tags":{"shape":"TagList"} - } - }, - "CreateVpcEndpointAssociationResponse":{ - "type":"structure", - "members":{ - "VpcEndpointAssociation":{"shape":"VpcEndpointAssociation"}, - "VpcEndpointAssociationStatus":{"shape":"VpcEndpointAssociationStatus"} - } - }, - "CustomAction":{ - "type":"structure", - "required":[ - "ActionName", - "ActionDefinition" - ], - "members":{ - "ActionName":{"shape":"ActionName"}, - "ActionDefinition":{"shape":"ActionDefinition"} - } - }, - "CustomActions":{ - "type":"list", - "member":{"shape":"CustomAction"} - }, - "DeepThreatInspection":{"type":"boolean"}, - "DeleteContainerAssociationRequest":{ - "type":"structure", - "members":{ - "ContainerAssociationName":{"shape":"ResourceName"}, - "ContainerAssociationArn":{"shape":"ResourceArn"} - } - }, - "DeleteContainerAssociationResponse":{ - "type":"structure", - "members":{ - "ContainerAssociationName":{"shape":"ResourceName"}, - "ContainerAssociationArn":{"shape":"ResourceArn"}, - "Status":{"shape":"ContainerAssociationStatus"} - } - }, - "DeleteFirewallPolicyRequest":{ - "type":"structure", - "members":{ - "FirewallPolicyName":{"shape":"ResourceName"}, - "FirewallPolicyArn":{"shape":"ResourceArn"} - } - }, - "DeleteFirewallPolicyResponse":{ - "type":"structure", - "required":["FirewallPolicyResponse"], - "members":{ - "FirewallPolicyResponse":{"shape":"FirewallPolicyResponse"} - } - }, - "DeleteFirewallRequest":{ - "type":"structure", - "members":{ - "FirewallName":{"shape":"ResourceName"}, - "FirewallArn":{"shape":"ResourceArn"} - } - }, - "DeleteFirewallResponse":{ - "type":"structure", - "members":{ - "Firewall":{"shape":"Firewall"}, - "FirewallStatus":{"shape":"FirewallStatus"} - } - }, - "DeleteNetworkFirewallTransitGatewayAttachmentRequest":{ - "type":"structure", - "required":["TransitGatewayAttachmentId"], - "members":{ - "TransitGatewayAttachmentId":{"shape":"TransitGatewayAttachmentId"} - } - }, - "DeleteNetworkFirewallTransitGatewayAttachmentResponse":{ - "type":"structure", - "required":[ - "TransitGatewayAttachmentId", - "TransitGatewayAttachmentStatus" - ], - "members":{ - "TransitGatewayAttachmentId":{"shape":"TransitGatewayAttachmentId"}, - "TransitGatewayAttachmentStatus":{"shape":"TransitGatewayAttachmentStatus"} - } - }, - "DeleteProxyConfigurationRequest":{ - "type":"structure", - "members":{ - "ProxyConfigurationName":{"shape":"ResourceName"}, - "ProxyConfigurationArn":{"shape":"ResourceArn"} - } - }, - "DeleteProxyConfigurationResponse":{ - "type":"structure", - "members":{ - "ProxyConfigurationName":{"shape":"ResourceName"}, - "ProxyConfigurationArn":{"shape":"ResourceArn"} - } - }, - "DeleteProxyRequest":{ - "type":"structure", - "required":["NatGatewayId"], - "members":{ - "NatGatewayId":{"shape":"NatGatewayId"}, - "ProxyName":{"shape":"ResourceName"}, - "ProxyArn":{"shape":"ResourceArn"} - } - }, - "DeleteProxyResponse":{ - "type":"structure", - "members":{ - "NatGatewayId":{"shape":"NatGatewayId"}, - "ProxyName":{"shape":"ResourceName"}, - "ProxyArn":{"shape":"ResourceArn"} - } - }, - "DeleteProxyRuleGroupRequest":{ - "type":"structure", - "members":{ - "ProxyRuleGroupName":{"shape":"ResourceName"}, - "ProxyRuleGroupArn":{"shape":"ResourceArn"} - } - }, - "DeleteProxyRuleGroupResponse":{ - "type":"structure", - "members":{ - "ProxyRuleGroupName":{"shape":"ResourceName"}, - "ProxyRuleGroupArn":{"shape":"ResourceArn"} - } - }, - "DeleteProxyRulesRequest":{ - "type":"structure", - "required":["Rules"], - "members":{ - "ProxyRuleGroupArn":{"shape":"ResourceArn"}, - "ProxyRuleGroupName":{"shape":"ResourceName"}, - "Rules":{"shape":"ResourceNameList"} - } - }, - "DeleteProxyRulesResponse":{ - "type":"structure", - "members":{ - "ProxyRuleGroup":{"shape":"ProxyRuleGroup"} - } - }, - "DeleteResourcePolicyRequest":{ - "type":"structure", - "required":["ResourceArn"], - "members":{ - "ResourceArn":{"shape":"ResourceArn"} - } - }, - "DeleteResourcePolicyResponse":{ - "type":"structure", - "members":{} - }, - "DeleteRuleGroupRequest":{ - "type":"structure", - "members":{ - "RuleGroupName":{"shape":"ResourceName"}, - "RuleGroupArn":{"shape":"ResourceArn"}, - "Type":{"shape":"RuleGroupType"} - } - }, - "DeleteRuleGroupResponse":{ - "type":"structure", - "required":["RuleGroupResponse"], - "members":{ - "RuleGroupResponse":{"shape":"RuleGroupResponse"} - } - }, - "DeleteTLSInspectionConfigurationRequest":{ - "type":"structure", - "members":{ - "TLSInspectionConfigurationArn":{"shape":"ResourceArn"}, - "TLSInspectionConfigurationName":{"shape":"ResourceName"} - } - }, - "DeleteTLSInspectionConfigurationResponse":{ - "type":"structure", - "required":["TLSInspectionConfigurationResponse"], - "members":{ - "TLSInspectionConfigurationResponse":{"shape":"TLSInspectionConfigurationResponse"} - } - }, - "DeleteTime":{"type":"timestamp"}, - "DeleteVpcEndpointAssociationRequest":{ - "type":"structure", - "required":["VpcEndpointAssociationArn"], - "members":{ - "VpcEndpointAssociationArn":{"shape":"ResourceArn"} - } - }, - "DeleteVpcEndpointAssociationResponse":{ - "type":"structure", - "members":{ - "VpcEndpointAssociation":{"shape":"VpcEndpointAssociation"}, - "VpcEndpointAssociationStatus":{"shape":"VpcEndpointAssociationStatus"} - } - }, - "DescribeContainerAssociationRequest":{ - "type":"structure", - "members":{ - "ContainerAssociationName":{"shape":"ResourceName"}, - "ContainerAssociationArn":{"shape":"ResourceArn"} - } - }, - "DescribeContainerAssociationResponse":{ - "type":"structure", - "members":{ - "ContainerAssociationName":{"shape":"ResourceName"}, - "ContainerAssociationArn":{"shape":"ResourceArn"}, - "Description":{"shape":"Description"}, - "Type":{"shape":"ContainerMonitoringType"}, - "ContainerMonitoringConfigurations":{"shape":"ContainerMonitoringConfigurations"}, - "Status":{"shape":"ContainerAssociationStatus"}, - "ResolvedCidrCount":{"shape":"CIDRCount"}, - "LastUpdatedTime":{"shape":"ContainerAssociationLastUpdatedTime"}, - "Tags":{"shape":"TagList"}, - "UpdateToken":{"shape":"UpdateToken"} - } - }, - "DescribeFirewallMetadataRequest":{ - "type":"structure", - "members":{ - "FirewallArn":{"shape":"ResourceArn"} - } - }, - "DescribeFirewallMetadataResponse":{ - "type":"structure", - "members":{ - "FirewallArn":{"shape":"ResourceArn"}, - "FirewallPolicyArn":{"shape":"ResourceArn"}, - "Description":{"shape":"Description"}, - "Status":{"shape":"FirewallStatusValue"}, - "SupportedAvailabilityZones":{"shape":"SupportedAvailabilityZones"}, - "TransitGatewayAttachmentId":{"shape":"TransitGatewayAttachmentId"} - } - }, - "DescribeFirewallPolicyRequest":{ - "type":"structure", - "members":{ - "FirewallPolicyName":{"shape":"ResourceName"}, - "FirewallPolicyArn":{"shape":"ResourceArn"} - } - }, - "DescribeFirewallPolicyResponse":{ - "type":"structure", - "required":[ - "UpdateToken", - "FirewallPolicyResponse" - ], - "members":{ - "UpdateToken":{"shape":"UpdateToken"}, - "FirewallPolicyResponse":{"shape":"FirewallPolicyResponse"}, - "FirewallPolicy":{"shape":"FirewallPolicy"} - } - }, - "DescribeFirewallRequest":{ - "type":"structure", - "members":{ - "FirewallName":{"shape":"ResourceName"}, - "FirewallArn":{"shape":"ResourceArn"} - } - }, - "DescribeFirewallResponse":{ - "type":"structure", - "members":{ - "UpdateToken":{"shape":"UpdateToken"}, - "Firewall":{"shape":"Firewall"}, - "FirewallStatus":{"shape":"FirewallStatus"} - } - }, - "DescribeFlowOperationRequest":{ - "type":"structure", - "required":[ - "FirewallArn", - "FlowOperationId" - ], - "members":{ - "FirewallArn":{"shape":"ResourceArn"}, - "AvailabilityZone":{"shape":"AvailabilityZone"}, - "VpcEndpointAssociationArn":{"shape":"ResourceArn"}, - "VpcEndpointId":{"shape":"VpcEndpointId"}, - "FlowOperationId":{"shape":"FlowOperationId"} - } - }, - "DescribeFlowOperationResponse":{ - "type":"structure", - "members":{ - "FirewallArn":{"shape":"ResourceArn"}, - "AvailabilityZone":{"shape":"AvailabilityZone"}, - "VpcEndpointAssociationArn":{"shape":"ResourceArn"}, - "VpcEndpointId":{"shape":"VpcEndpointId"}, - "FlowOperationId":{"shape":"FlowOperationId"}, - "FlowOperationType":{"shape":"FlowOperationType"}, - "FlowOperationStatus":{"shape":"FlowOperationStatus"}, - "StatusMessage":{"shape":"StatusReason"}, - "FlowRequestTimestamp":{"shape":"FlowRequestTimestamp"}, - "FlowOperation":{"shape":"FlowOperation"} - } - }, - "DescribeLoggingConfigurationRequest":{ - "type":"structure", - "members":{ - "FirewallArn":{"shape":"ResourceArn"}, - "FirewallName":{"shape":"ResourceName"} - } - }, - "DescribeLoggingConfigurationResponse":{ - "type":"structure", - "members":{ - "FirewallArn":{"shape":"ResourceArn"}, - "LoggingConfiguration":{"shape":"LoggingConfiguration"}, - "EnableMonitoringDashboard":{"shape":"EnableMonitoringDashboard"} - } - }, - "DescribeProxyConfigurationRequest":{ - "type":"structure", - "members":{ - "ProxyConfigurationName":{"shape":"ResourceName"}, - "ProxyConfigurationArn":{"shape":"ResourceArn"} - } - }, - "DescribeProxyConfigurationResponse":{ - "type":"structure", - "members":{ - "ProxyConfiguration":{"shape":"ProxyConfiguration"}, - "UpdateToken":{"shape":"UpdateToken"} - } - }, - "DescribeProxyRequest":{ - "type":"structure", - "members":{ - "ProxyName":{"shape":"ResourceName"}, - "ProxyArn":{"shape":"ResourceArn"} - } - }, - "DescribeProxyResource":{ - "type":"structure", - "members":{ - "ProxyName":{"shape":"ResourceName"}, - "ProxyArn":{"shape":"ResourceArn"}, - "ProxyConfigurationName":{"shape":"ResourceName"}, - "ProxyConfigurationArn":{"shape":"ResourceArn"}, - "NatGatewayId":{"shape":"NatGatewayId"}, - "ProxyState":{"shape":"ProxyState"}, - "ProxyModifyState":{"shape":"ProxyModifyState"}, - "ListenerProperties":{"shape":"ListenerProperties"}, - "TlsInterceptProperties":{"shape":"TlsInterceptProperties"}, - "VpcEndpointServiceName":{"shape":"VpcEndpointServiceName"}, - "PrivateDNSName":{"shape":"PrivateDNSName"}, - "CreateTime":{"shape":"CreateTime"}, - "DeleteTime":{"shape":"DeleteTime"}, - "UpdateTime":{"shape":"UpdateTime"}, - "FailureCode":{"shape":"FailureCode"}, - "FailureMessage":{"shape":"FailureMessage"}, - "Tags":{"shape":"TagList"} - } - }, - "DescribeProxyResponse":{ - "type":"structure", - "members":{ - "Proxy":{"shape":"DescribeProxyResource"}, - "UpdateToken":{"shape":"UpdateToken"} - } - }, - "DescribeProxyRuleGroupRequest":{ - "type":"structure", - "members":{ - "ProxyRuleGroupName":{"shape":"ResourceName"}, - "ProxyRuleGroupArn":{"shape":"ResourceArn"} - } - }, - "DescribeProxyRuleGroupResponse":{ - "type":"structure", - "members":{ - "ProxyRuleGroup":{"shape":"ProxyRuleGroup"}, - "UpdateToken":{"shape":"UpdateToken"} - } - }, - "DescribeProxyRuleRequest":{ - "type":"structure", - "required":["ProxyRuleName"], - "members":{ - "ProxyRuleName":{"shape":"ResourceName"}, - "ProxyRuleGroupName":{"shape":"ResourceName"}, - "ProxyRuleGroupArn":{"shape":"ResourceArn"} - } - }, - "DescribeProxyRuleResponse":{ - "type":"structure", - "members":{ - "ProxyRule":{"shape":"ProxyRule"}, - "UpdateToken":{"shape":"UpdateToken"} - } - }, - "DescribeResourcePolicyRequest":{ - "type":"structure", - "required":["ResourceArn"], - "members":{ - "ResourceArn":{"shape":"ResourceArn"} - } - }, - "DescribeResourcePolicyResponse":{ - "type":"structure", - "members":{ - "Policy":{"shape":"PolicyString"} - } - }, - "DescribeRuleGroupMetadataRequest":{ - "type":"structure", - "members":{ - "RuleGroupName":{"shape":"ResourceName"}, - "RuleGroupArn":{"shape":"ResourceArn"}, - "Type":{"shape":"RuleGroupType"} - } - }, - "DescribeRuleGroupMetadataResponse":{ - "type":"structure", - "required":[ - "RuleGroupArn", - "RuleGroupName" - ], - "members":{ - "RuleGroupArn":{"shape":"ResourceArn"}, - "RuleGroupName":{"shape":"ResourceName"}, - "Description":{"shape":"Description"}, - "Type":{"shape":"RuleGroupType"}, - "Capacity":{"shape":"RuleCapacity"}, - "StatefulRuleOptions":{"shape":"StatefulRuleOptions"}, - "LastModifiedTime":{"shape":"LastUpdateTime"}, - "VendorName":{"shape":"VendorName"}, - "ProductId":{"shape":"ProductId"}, - "ListingName":{"shape":"ListingName"} - } - }, - "DescribeRuleGroupRequest":{ - "type":"structure", - "members":{ - "RuleGroupName":{"shape":"ResourceName"}, - "RuleGroupArn":{"shape":"ResourceArn"}, - "Type":{"shape":"RuleGroupType"}, - "AnalyzeRuleGroup":{"shape":"Boolean"} - } - }, - "DescribeRuleGroupResponse":{ - "type":"structure", - "required":[ - "UpdateToken", - "RuleGroupResponse" - ], - "members":{ - "UpdateToken":{"shape":"UpdateToken"}, - "RuleGroup":{"shape":"RuleGroup"}, - "RuleGroupResponse":{"shape":"RuleGroupResponse"} - } - }, - "DescribeRuleGroupSummaryRequest":{ - "type":"structure", - "members":{ - "RuleGroupName":{"shape":"ResourceName"}, - "RuleGroupArn":{"shape":"ResourceArn"}, - "Type":{"shape":"RuleGroupType"} - } - }, - "DescribeRuleGroupSummaryResponse":{ - "type":"structure", - "required":["RuleGroupName"], - "members":{ - "RuleGroupName":{"shape":"ResourceName"}, - "Description":{"shape":"Description"}, - "Summary":{"shape":"Summary"} - } - }, - "DescribeTLSInspectionConfigurationRequest":{ - "type":"structure", - "members":{ - "TLSInspectionConfigurationArn":{"shape":"ResourceArn"}, - "TLSInspectionConfigurationName":{"shape":"ResourceName"} - } - }, - "DescribeTLSInspectionConfigurationResponse":{ - "type":"structure", - "required":[ - "UpdateToken", - "TLSInspectionConfigurationResponse" - ], - "members":{ - "UpdateToken":{"shape":"UpdateToken"}, - "TLSInspectionConfiguration":{"shape":"TLSInspectionConfiguration"}, - "TLSInspectionConfigurationResponse":{"shape":"TLSInspectionConfigurationResponse"} - } - }, - "DescribeVpcEndpointAssociationRequest":{ - "type":"structure", - "required":["VpcEndpointAssociationArn"], - "members":{ - "VpcEndpointAssociationArn":{"shape":"ResourceArn"} - } - }, - "DescribeVpcEndpointAssociationResponse":{ - "type":"structure", - "members":{ - "VpcEndpointAssociation":{"shape":"VpcEndpointAssociation"}, - "VpcEndpointAssociationStatus":{"shape":"VpcEndpointAssociationStatus"} - } - }, - "Description":{ - "type":"string", - "max":512, - "pattern":"^.*$" - }, - "Destination":{ - "type":"string", - "max":1024, - "min":1, - "pattern":"^.*$" - }, - "DetachRuleGroupsFromProxyConfigurationRequest":{ - "type":"structure", - "required":["UpdateToken"], - "members":{ - "ProxyConfigurationName":{"shape":"ResourceName"}, - "ProxyConfigurationArn":{"shape":"ResourceArn"}, - "RuleGroupNames":{"shape":"ResourceNameList"}, - "RuleGroupArns":{"shape":"ResourceArnList"}, - "UpdateToken":{"shape":"UpdateToken"} - } - }, - "DetachRuleGroupsFromProxyConfigurationResponse":{ - "type":"structure", - "members":{ - "ProxyConfiguration":{"shape":"ProxyConfiguration"}, - "UpdateToken":{"shape":"UpdateToken"} - } - }, - "Dimension":{ - "type":"structure", - "required":["Value"], - "members":{ - "Value":{"shape":"DimensionValue"} - } - }, - "DimensionValue":{ - "type":"string", - "max":128, - "min":1, - "pattern":"^[a-zA-Z0-9-_ ]+$" - }, - "Dimensions":{ - "type":"list", - "member":{"shape":"Dimension"}, - "max":1, - "min":1 - }, - "DisassociateAvailabilityZonesRequest":{ - "type":"structure", - "required":["AvailabilityZoneMappings"], - "members":{ - "UpdateToken":{"shape":"UpdateToken"}, - "FirewallArn":{"shape":"ResourceArn"}, - "FirewallName":{"shape":"ResourceName"}, - "AvailabilityZoneMappings":{"shape":"AvailabilityZoneMappings"} - } - }, - "DisassociateAvailabilityZonesResponse":{ - "type":"structure", - "members":{ - "FirewallArn":{"shape":"ResourceArn"}, - "FirewallName":{"shape":"ResourceName"}, - "AvailabilityZoneMappings":{"shape":"AvailabilityZoneMappings"}, - "UpdateToken":{"shape":"UpdateToken"} - } - }, - "DisassociateSubnetsRequest":{ - "type":"structure", - "required":["SubnetIds"], - "members":{ - "UpdateToken":{"shape":"UpdateToken"}, - "FirewallArn":{"shape":"ResourceArn"}, - "FirewallName":{"shape":"ResourceName"}, - "SubnetIds":{"shape":"AzSubnets"} - } - }, - "DisassociateSubnetsResponse":{ - "type":"structure", - "members":{ - "FirewallArn":{"shape":"ResourceArn"}, - "FirewallName":{"shape":"ResourceName"}, - "SubnetMappings":{"shape":"SubnetMappings"}, - "UpdateToken":{"shape":"UpdateToken"} - } - }, - "Domain":{"type":"string"}, - "EnableMonitoringDashboard":{"type":"boolean"}, - "EnableTLSSessionHolding":{"type":"boolean"}, - "EnabledAnalysisType":{ - "type":"string", - "enum":[ - "TLS_SNI", - "HTTP_HOST" - ] - }, - "EnabledAnalysisTypes":{ - "type":"list", - "member":{"shape":"EnabledAnalysisType"} - }, - "EncryptionConfiguration":{ - "type":"structure", - "required":["Type"], - "members":{ - "KeyId":{"shape":"KeyId"}, - "Type":{"shape":"EncryptionType"} - } - }, - "EncryptionType":{ - "type":"string", - "enum":[ - "CUSTOMER_KMS", - "AWS_OWNED_KMS_KEY" - ] - }, - "EndTime":{"type":"timestamp"}, - "EndpointId":{"type":"string"}, - "ErrorMessage":{"type":"string"}, - "FailureCode":{"type":"string"}, - "FailureMessage":{"type":"string"}, - "Firewall":{ - "type":"structure", - "required":[ - "FirewallPolicyArn", - "VpcId", - "SubnetMappings", - "FirewallId" - ], - "members":{ - "FirewallName":{"shape":"ResourceName"}, - "FirewallArn":{"shape":"ResourceArn"}, - "FirewallPolicyArn":{"shape":"ResourceArn"}, - "VpcId":{"shape":"VpcId"}, - "SubnetMappings":{"shape":"SubnetMappings"}, - "DeleteProtection":{"shape":"Boolean"}, - "SubnetChangeProtection":{"shape":"Boolean"}, - "FirewallPolicyChangeProtection":{"shape":"Boolean"}, - "Description":{"shape":"Description"}, - "FirewallId":{"shape":"ResourceId"}, - "Tags":{"shape":"TagList"}, - "EncryptionConfiguration":{"shape":"EncryptionConfiguration"}, - "NumberOfAssociations":{"shape":"NumberOfAssociations"}, - "EnabledAnalysisTypes":{"shape":"EnabledAnalysisTypes"}, - "TransitGatewayId":{"shape":"TransitGatewayId"}, - "TransitGatewayOwnerAccountId":{"shape":"AWSAccountId"}, - "AvailabilityZoneMappings":{"shape":"AvailabilityZoneMappings"}, - "AvailabilityZoneChangeProtection":{"shape":"Boolean"} - } - }, - "FirewallMetadata":{ - "type":"structure", - "members":{ - "FirewallName":{"shape":"ResourceName"}, - "FirewallArn":{"shape":"ResourceArn"}, - "TransitGatewayAttachmentId":{"shape":"TransitGatewayAttachmentId"} - } - }, - "FirewallPolicies":{ - "type":"list", - "member":{"shape":"FirewallPolicyMetadata"} - }, - "FirewallPolicy":{ - "type":"structure", - "required":[ - "StatelessDefaultActions", - "StatelessFragmentDefaultActions" - ], - "members":{ - "StatelessRuleGroupReferences":{"shape":"StatelessRuleGroupReferences"}, - "StatelessDefaultActions":{"shape":"StatelessActions"}, - "StatelessFragmentDefaultActions":{"shape":"StatelessActions"}, - "StatelessCustomActions":{"shape":"CustomActions"}, - "StatefulRuleGroupReferences":{"shape":"StatefulRuleGroupReferences"}, - "StatefulDefaultActions":{"shape":"StatefulActions"}, - "StatefulEngineOptions":{"shape":"StatefulEngineOptions"}, - "TLSInspectionConfigurationArn":{"shape":"ResourceArn"}, - "PolicyVariables":{"shape":"PolicyVariables"}, - "EnableTLSSessionHolding":{"shape":"EnableTLSSessionHolding"} - } - }, - "FirewallPolicyMetadata":{ - "type":"structure", - "members":{ - "Name":{"shape":"ResourceName"}, - "Arn":{"shape":"ResourceArn"} - } - }, - "FirewallPolicyResponse":{ - "type":"structure", - "required":[ - "FirewallPolicyName", - "FirewallPolicyArn", - "FirewallPolicyId" - ], - "members":{ - "FirewallPolicyName":{"shape":"ResourceName"}, - "FirewallPolicyArn":{"shape":"ResourceArn"}, - "FirewallPolicyId":{"shape":"ResourceId"}, - "Description":{"shape":"Description"}, - "FirewallPolicyStatus":{"shape":"ResourceStatus"}, - "Tags":{"shape":"TagList"}, - "ConsumedStatelessRuleCapacity":{"shape":"RuleCapacity"}, - "ConsumedStatefulRuleCapacity":{"shape":"RuleCapacity"}, - "ConsumedStatefulDomainCapacity":{"shape":"RuleCapacity"}, - "NumberOfAssociations":{"shape":"NumberOfAssociations"}, - "EncryptionConfiguration":{"shape":"EncryptionConfiguration"}, - "LastModifiedTime":{"shape":"LastUpdateTime"} - } - }, - "FirewallStatus":{ - "type":"structure", - "required":[ - "Status", - "ConfigurationSyncStateSummary" - ], - "members":{ - "Status":{"shape":"FirewallStatusValue"}, - "ConfigurationSyncStateSummary":{"shape":"ConfigurationSyncState"}, - "SyncStates":{"shape":"SyncStates"}, - "CapacityUsageSummary":{"shape":"CapacityUsageSummary"}, - "TransitGatewayAttachmentSyncState":{"shape":"TransitGatewayAttachmentSyncState"} - } - }, - "FirewallStatusValue":{ - "type":"string", - "enum":[ - "PROVISIONING", - "DELETING", - "READY" - ] - }, - "Firewalls":{ - "type":"list", - "member":{"shape":"FirewallMetadata"} - }, - "FirstAccessed":{"type":"timestamp"}, - "Flags":{ - "type":"list", - "member":{"shape":"TCPFlag"} - }, - "Flow":{ - "type":"structure", - "members":{ - "SourceAddress":{"shape":"Address"}, - "DestinationAddress":{"shape":"Address"}, - "SourcePort":{"shape":"Port"}, - "DestinationPort":{"shape":"Port"}, - "Protocol":{"shape":"ProtocolString"}, - "Age":{"shape":"Age"}, - "PacketCount":{"shape":"PacketCount"}, - "ByteCount":{"shape":"ByteCount"} - } - }, - "FlowFilter":{ - "type":"structure", - "members":{ - "SourceAddress":{"shape":"Address"}, - "DestinationAddress":{"shape":"Address"}, - "SourcePort":{"shape":"Port"}, - "DestinationPort":{"shape":"Port"}, - "Protocols":{"shape":"ProtocolStrings"} - } - }, - "FlowFilters":{ - "type":"list", - "member":{"shape":"FlowFilter"} - }, - "FlowOperation":{ - "type":"structure", - "members":{ - "MinimumFlowAgeInSeconds":{"shape":"Age"}, - "FlowFilters":{"shape":"FlowFilters"} - } - }, - "FlowOperationId":{ - "type":"string", - "max":36, - "min":36, - "pattern":"^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$" - }, - "FlowOperationMetadata":{ - "type":"structure", - "members":{ - "FlowOperationId":{"shape":"FlowOperationId"}, - "FlowOperationType":{"shape":"FlowOperationType"}, - "FlowRequestTimestamp":{"shape":"FlowRequestTimestamp"}, - "FlowOperationStatus":{"shape":"FlowOperationStatus"} - } - }, - "FlowOperationStatus":{ - "type":"string", - "enum":[ - "COMPLETED", - "IN_PROGRESS", - "FAILED", - "COMPLETED_WITH_ERRORS" - ] - }, - "FlowOperationType":{ - "type":"string", - "enum":[ - "FLOW_FLUSH", - "FLOW_CAPTURE" - ] - }, - "FlowOperations":{ - "type":"list", - "member":{"shape":"FlowOperationMetadata"} - }, - "FlowRequestTimestamp":{"type":"timestamp"}, - "FlowTimeouts":{ - "type":"structure", - "members":{ - "TcpIdleTimeoutSeconds":{"shape":"TcpIdleTimeoutRangeBound"} - } - }, - "Flows":{ - "type":"list", - "member":{"shape":"Flow"} - }, - "GeneratedRulesType":{ - "type":"string", - "enum":[ - "ALLOWLIST", - "DENYLIST", - "REJECTLIST", - "ALERTLIST" - ] - }, - "GetAnalysisReportResultsRequest":{ - "type":"structure", - "required":["AnalysisReportId"], - "members":{ - "FirewallName":{"shape":"ResourceName"}, - "AnalysisReportId":{"shape":"AnalysisReportId"}, - "FirewallArn":{"shape":"ResourceArn"}, - "NextToken":{"shape":"AnalysisReportNextToken"}, - "MaxResults":{"shape":"PaginationMaxResults"} - } - }, - "GetAnalysisReportResultsResponse":{ - "type":"structure", - "members":{ - "Status":{"shape":"Status"}, - "StartTime":{"shape":"StartTime"}, - "EndTime":{"shape":"EndTime"}, - "ReportTime":{"shape":"ReportTime"}, - "AnalysisType":{"shape":"EnabledAnalysisType"}, - "NextToken":{"shape":"AnalysisReportNextToken"}, - "AnalysisReportResults":{"shape":"AnalysisReportResults"} - } - }, - "HashMapKey":{ - "type":"string", - "max":50, - "min":3, - "pattern":"^[0-9A-Za-z.\\-_@\\/]+$" - }, - "HashMapValue":{ - "type":"string", - "max":1024, - "min":1, - "pattern":"[\\s\\S]*$" - }, - "Header":{ - "type":"structure", - "required":[ - "Protocol", - "Source", - "SourcePort", - "Direction", - "Destination", - "DestinationPort" - ], - "members":{ - "Protocol":{"shape":"StatefulRuleProtocol"}, - "Source":{"shape":"Source"}, - "SourcePort":{"shape":"Port"}, - "Direction":{"shape":"StatefulRuleDirection"}, - "Destination":{"shape":"Destination"}, - "DestinationPort":{"shape":"Port"} - } - }, - "Hits":{ - "type":"structure", - "members":{ - "Count":{"shape":"Count"} - } - }, - "IPAddressType":{ - "type":"string", - "enum":[ - "DUALSTACK", - "IPV4", - "IPV6" - ] - }, - "IPSet":{ - "type":"structure", - "required":["Definition"], - "members":{ - "Definition":{"shape":"VariableDefinitionList"} - } - }, - "IPSetArn":{"type":"string"}, - "IPSetMetadata":{ - "type":"structure", - "members":{ - "ResolvedCIDRCount":{"shape":"CIDRCount"} - } - }, - "IPSetMetadataMap":{ - "type":"map", - "key":{"shape":"IPSetArn"}, - "value":{"shape":"IPSetMetadata"} - }, - "IPSetReference":{ - "type":"structure", - "members":{ - "ReferenceArn":{"shape":"ResourceArn"} - } - }, - "IPSetReferenceMap":{ - "type":"map", - "key":{"shape":"IPSetReferenceName"}, - "value":{"shape":"IPSetReference"} - }, - "IPSetReferenceName":{ - "type":"string", - "max":32, - "min":1, - "pattern":"^[A-Za-z][A-Za-z0-9_]*$" - }, - "IPSets":{ - "type":"map", - "key":{"shape":"RuleVariableName"}, - "value":{"shape":"IPSet"} - }, - "IdentifiedType":{ - "type":"string", - "enum":[ - "STATELESS_RULE_FORWARDING_ASYMMETRICALLY", - "STATELESS_RULE_CONTAINS_TCP_FLAGS" - ] - }, - "InsertPosition":{"type":"integer"}, - "InsufficientCapacityException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"} - }, - "exception":true, - "fault":true - }, - "InternalServerError":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"} - }, - "exception":true, - "fault":true - }, - "InvalidOperationException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"} - }, - "exception":true - }, - "InvalidRequestException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"} - }, - "exception":true - }, - "InvalidResourcePolicyException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"} - }, - "exception":true - }, - "InvalidTokenException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"} - }, - "exception":true - }, - "KeyId":{ - "type":"string", - "max":2048, - "min":1, - "pattern":".*\\S.*" - }, - "Keyword":{ - "type":"string", - "max":128, - "min":1, - "pattern":".*" - }, - "LastAccessed":{"type":"timestamp"}, - "LastUpdateTime":{"type":"timestamp"}, - "LimitExceededException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"} - }, - "exception":true - }, - "ListAnalysisReportsRequest":{ - "type":"structure", - "members":{ - "FirewallName":{"shape":"ResourceName"}, - "FirewallArn":{"shape":"ResourceArn"}, - "NextToken":{"shape":"PaginationToken"}, - "MaxResults":{"shape":"PaginationMaxResults"} - } - }, - "ListAnalysisReportsResponse":{ - "type":"structure", - "members":{ - "AnalysisReports":{"shape":"AnalysisReports"}, - "NextToken":{"shape":"PaginationToken"} - } - }, - "ListContainerAssociationsRequest":{ - "type":"structure", - "members":{ - "MaxResults":{"shape":"PaginationMaxResults"}, - "NextToken":{"shape":"PaginationToken"} - } - }, - "ListContainerAssociationsResponse":{ - "type":"structure", - "members":{ - "ContainerAssociations":{"shape":"ContainerAssociations"}, - "NextToken":{"shape":"PaginationToken"} - } - }, - "ListFirewallPoliciesRequest":{ - "type":"structure", - "members":{ - "NextToken":{"shape":"PaginationToken"}, - "MaxResults":{"shape":"PaginationMaxResults"} - } - }, - "ListFirewallPoliciesResponse":{ - "type":"structure", - "members":{ - "NextToken":{"shape":"PaginationToken"}, - "FirewallPolicies":{"shape":"FirewallPolicies"} - } - }, - "ListFirewallsRequest":{ - "type":"structure", - "members":{ - "NextToken":{"shape":"PaginationToken"}, - "VpcIds":{"shape":"VpcIds"}, - "MaxResults":{"shape":"PaginationMaxResults"} - } - }, - "ListFirewallsResponse":{ - "type":"structure", - "members":{ - "NextToken":{"shape":"PaginationToken"}, - "Firewalls":{"shape":"Firewalls"} - } - }, - "ListFlowOperationResultsRequest":{ - "type":"structure", - "required":[ - "FirewallArn", - "FlowOperationId" - ], - "members":{ - "FirewallArn":{"shape":"ResourceArn"}, - "FlowOperationId":{"shape":"FlowOperationId"}, - "NextToken":{"shape":"PaginationToken"}, - "MaxResults":{"shape":"PaginationMaxResults"}, - "AvailabilityZone":{"shape":"AvailabilityZone"}, - "VpcEndpointId":{"shape":"VpcEndpointId"}, - "VpcEndpointAssociationArn":{"shape":"ResourceArn"} - } - }, - "ListFlowOperationResultsResponse":{ - "type":"structure", - "members":{ - "FirewallArn":{"shape":"ResourceArn"}, - "AvailabilityZone":{"shape":"AvailabilityZone"}, - "VpcEndpointAssociationArn":{"shape":"ResourceArn"}, - "VpcEndpointId":{"shape":"VpcEndpointId"}, - "FlowOperationId":{"shape":"FlowOperationId"}, - "FlowOperationStatus":{"shape":"FlowOperationStatus"}, - "StatusMessage":{"shape":"StatusReason"}, - "FlowRequestTimestamp":{"shape":"FlowRequestTimestamp"}, - "Flows":{"shape":"Flows"}, - "NextToken":{"shape":"PaginationToken"} - } - }, - "ListFlowOperationsRequest":{ - "type":"structure", - "required":["FirewallArn"], - "members":{ - "FirewallArn":{"shape":"ResourceArn"}, - "AvailabilityZone":{"shape":"AvailabilityZone"}, - "VpcEndpointAssociationArn":{"shape":"ResourceArn"}, - "VpcEndpointId":{"shape":"VpcEndpointId"}, - "FlowOperationType":{"shape":"FlowOperationType"}, - "NextToken":{"shape":"PaginationToken"}, - "MaxResults":{"shape":"PaginationMaxResults"} - } - }, - "ListFlowOperationsResponse":{ - "type":"structure", - "members":{ - "FlowOperations":{"shape":"FlowOperations"}, - "NextToken":{"shape":"PaginationToken"} - } - }, - "ListProxiesRequest":{ - "type":"structure", - "members":{ - "NextToken":{"shape":"PaginationToken"}, - "MaxResults":{"shape":"PaginationMaxResults"} - } - }, - "ListProxiesResponse":{ - "type":"structure", - "members":{ - "Proxies":{"shape":"Proxies"}, - "NextToken":{"shape":"PaginationToken"} - } - }, - "ListProxyConfigurationsRequest":{ - "type":"structure", - "members":{ - "NextToken":{"shape":"PaginationToken"}, - "MaxResults":{"shape":"PaginationMaxResults"} - } - }, - "ListProxyConfigurationsResponse":{ - "type":"structure", - "members":{ - "ProxyConfigurations":{"shape":"ProxyConfigurations"}, - "NextToken":{"shape":"PaginationToken"} - } - }, - "ListProxyRuleGroupsRequest":{ - "type":"structure", - "members":{ - "NextToken":{"shape":"PaginationToken"}, - "MaxResults":{"shape":"PaginationMaxResults"} - } - }, - "ListProxyRuleGroupsResponse":{ - "type":"structure", - "members":{ - "ProxyRuleGroups":{"shape":"ProxyRuleGroups"}, - "NextToken":{"shape":"PaginationToken"} - } - }, - "ListRuleGroupsRequest":{ - "type":"structure", - "members":{ - "NextToken":{"shape":"PaginationToken"}, - "MaxResults":{"shape":"PaginationMaxResults"}, - "Scope":{"shape":"ResourceManagedStatus"}, - "ManagedType":{"shape":"ResourceManagedType"}, - "SubscriptionStatus":{"shape":"SubscriptionStatus"}, - "Type":{"shape":"RuleGroupType"} - } - }, - "ListRuleGroupsResponse":{ - "type":"structure", - "members":{ - "NextToken":{"shape":"PaginationToken"}, - "RuleGroups":{"shape":"RuleGroups"} - } - }, - "ListTLSInspectionConfigurationsRequest":{ - "type":"structure", - "members":{ - "NextToken":{"shape":"PaginationToken"}, - "MaxResults":{"shape":"PaginationMaxResults"} - } - }, - "ListTLSInspectionConfigurationsResponse":{ - "type":"structure", - "members":{ - "NextToken":{"shape":"PaginationToken"}, - "TLSInspectionConfigurations":{"shape":"TLSInspectionConfigurations"} - } - }, - "ListTagsForResourceRequest":{ - "type":"structure", - "required":["ResourceArn"], - "members":{ - "NextToken":{"shape":"PaginationToken"}, - "MaxResults":{"shape":"TagsPaginationMaxResults"}, - "ResourceArn":{"shape":"ResourceArn"} - } - }, - "ListTagsForResourceResponse":{ - "type":"structure", - "members":{ - "NextToken":{"shape":"PaginationToken"}, - "Tags":{"shape":"TagList"} - } - }, - "ListVpcEndpointAssociationsRequest":{ - "type":"structure", - "members":{ - "NextToken":{"shape":"PaginationToken"}, - "MaxResults":{"shape":"PaginationMaxResults"}, - "FirewallArn":{"shape":"ResourceArn"} - } - }, - "ListVpcEndpointAssociationsResponse":{ - "type":"structure", - "members":{ - "NextToken":{"shape":"PaginationToken"}, - "VpcEndpointAssociations":{"shape":"VpcEndpointAssociations"} - } - }, - "ListenerProperties":{ - "type":"list", - "member":{"shape":"ListenerProperty"} - }, - "ListenerPropertiesRequest":{ - "type":"list", - "member":{"shape":"ListenerPropertyRequest"}, - "max":2, - "min":0 - }, - "ListenerProperty":{ - "type":"structure", - "members":{ - "Port":{"shape":"NatGatewayPort"}, - "Type":{"shape":"ListenerPropertyType"} - } - }, - "ListenerPropertyRequest":{ - "type":"structure", - "required":[ - "Port", - "Type" - ], - "members":{ - "Port":{"shape":"NatGatewayPort"}, - "Type":{"shape":"ListenerPropertyType"} - } - }, - "ListenerPropertyType":{ - "type":"string", - "enum":[ - "HTTP", - "HTTPS" - ] - }, - "ListingName":{"type":"string"}, - "LogDestinationConfig":{ - "type":"structure", - "required":[ - "LogType", - "LogDestinationType", - "LogDestination" - ], - "members":{ - "LogType":{"shape":"LogType"}, - "LogDestinationType":{"shape":"LogDestinationType"}, - "LogDestination":{"shape":"LogDestinationMap"} - } - }, - "LogDestinationConfigs":{ - "type":"list", - "member":{"shape":"LogDestinationConfig"} - }, - "LogDestinationMap":{ - "type":"map", - "key":{"shape":"HashMapKey"}, - "value":{"shape":"HashMapValue"} - }, - "LogDestinationPermissionException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"} - }, - "exception":true - }, - "LogDestinationType":{ - "type":"string", - "enum":[ - "S3", - "CloudWatchLogs", - "KinesisDataFirehose" - ], - "max":30, - "min":2, - "pattern":"[0-9A-Za-z]+" - }, - "LogType":{ - "type":"string", - "enum":[ - "ALERT", - "FLOW", - "TLS" - ] - }, - "LoggingConfiguration":{ - "type":"structure", - "required":["LogDestinationConfigs"], - "members":{ - "LogDestinationConfigs":{"shape":"LogDestinationConfigs"} - } - }, - "MatchAttributes":{ - "type":"structure", - "members":{ - "Sources":{"shape":"Addresses"}, - "Destinations":{"shape":"Addresses"}, - "SourcePorts":{"shape":"PortRanges"}, - "DestinationPorts":{"shape":"PortRanges"}, - "Protocols":{"shape":"ProtocolNumbers"}, - "TCPFlags":{"shape":"TCPFlags"} - } - }, - "NatGatewayId":{ - "type":"string", - "min":1 - }, - "NatGatewayPort":{"type":"integer"}, - "NumberOfAssociations":{"type":"integer"}, - "OverrideAction":{ - "type":"string", - "enum":["DROP_TO_ALERT"] - }, - "PacketCount":{"type":"integer"}, - "PaginationMaxResults":{ - "type":"integer", - "max":100, - "min":1 - }, - "PaginationToken":{ - "type":"string", - "max":4096, - "min":1, - "pattern":"[0-9A-Za-z:\\/+=]+$" - }, - "PerObjectStatus":{ - "type":"structure", - "members":{ - "SyncStatus":{"shape":"PerObjectSyncStatus"}, - "UpdateToken":{"shape":"UpdateToken"} - } - }, - "PerObjectSyncStatus":{ - "type":"string", - "enum":[ - "PENDING", - "IN_SYNC", - "CAPACITY_CONSTRAINED", - "NOT_SUBSCRIBED", - "DEPRECATED" - ] - }, - "PolicyString":{ - "type":"string", - "max":395000, - "min":1, - "pattern":".*\\S.*" - }, - "PolicyVariables":{ - "type":"structure", - "members":{ - "RuleVariables":{"shape":"IPSets"} - } - }, - "Port":{ - "type":"string", - "max":1024, - "min":1, - "pattern":"^.*$" - }, - "PortRange":{ - "type":"structure", - "required":[ - "FromPort", - "ToPort" - ], - "members":{ - "FromPort":{"shape":"PortRangeBound"}, - "ToPort":{"shape":"PortRangeBound"} - } - }, - "PortRangeBound":{ - "type":"integer", - "max":65535, - "min":0 - }, - "PortRanges":{ - "type":"list", - "member":{"shape":"PortRange"} - }, - "PortSet":{ - "type":"structure", - "members":{ - "Definition":{"shape":"VariableDefinitionList"} - } - }, - "PortSets":{ - "type":"map", - "key":{"shape":"RuleVariableName"}, - "value":{"shape":"PortSet"} - }, - "Priority":{ - "type":"integer", - "max":65535, - "min":1 - }, - "PrivateDNSName":{"type":"string"}, - "ProductId":{"type":"string"}, - "ProtocolNumber":{ - "type":"integer", - "max":255, - "min":0 - }, - "ProtocolNumbers":{ - "type":"list", - "member":{"shape":"ProtocolNumber"} - }, - "ProtocolString":{ - "type":"string", - "max":12, - "min":1, - "pattern":"^.*$" - }, - "ProtocolStrings":{ - "type":"list", - "member":{"shape":"ProtocolString"} - }, - "Proxies":{ - "type":"list", - "member":{"shape":"ProxyMetadata"} - }, - "Proxy":{ - "type":"structure", - "members":{ - "CreateTime":{"shape":"CreateTime"}, - "DeleteTime":{"shape":"DeleteTime"}, - "UpdateTime":{"shape":"UpdateTime"}, - "FailureCode":{"shape":"FailureCode"}, - "FailureMessage":{"shape":"FailureMessage"}, - "ProxyState":{"shape":"ProxyState"}, - "ProxyModifyState":{"shape":"ProxyModifyState"}, - "NatGatewayId":{"shape":"NatGatewayId"}, - "ProxyConfigurationName":{"shape":"ResourceName"}, - "ProxyConfigurationArn":{"shape":"ResourceArn"}, - "ProxyName":{"shape":"ResourceName"}, - "ProxyArn":{"shape":"ResourceArn"}, - "ListenerProperties":{"shape":"ListenerProperties"}, - "TlsInterceptProperties":{"shape":"TlsInterceptProperties"}, - "Tags":{"shape":"TagList"} - } - }, - "ProxyConditionValue":{"type":"string"}, - "ProxyConditionValueList":{ - "type":"list", - "member":{"shape":"ProxyConditionValue"} - }, - "ProxyConfigDefaultRulePhaseActionsRequest":{ - "type":"structure", - "members":{ - "PreDNS":{"shape":"ProxyRulePhaseAction"}, - "PreREQUEST":{"shape":"ProxyRulePhaseAction"}, - "PostRESPONSE":{"shape":"ProxyRulePhaseAction"} - } - }, - "ProxyConfigRuleGroup":{ - "type":"structure", - "members":{ - "ProxyRuleGroupName":{"shape":"ResourceName"}, - "ProxyRuleGroupArn":{"shape":"ResourceArn"}, - "Type":{"shape":"ProxyConfigRuleGroupType"}, - "Priority":{"shape":"ProxyConfigRuleGroupPriority"} - } - }, - "ProxyConfigRuleGroupPriority":{"type":"integer"}, - "ProxyConfigRuleGroupSet":{ - "type":"list", - "member":{"shape":"ProxyConfigRuleGroup"} - }, - "ProxyConfigRuleGroupType":{"type":"string"}, - "ProxyConfiguration":{ - "type":"structure", - "members":{ - "ProxyConfigurationName":{"shape":"ResourceName"}, - "ProxyConfigurationArn":{"shape":"ResourceArn"}, - "Description":{"shape":"Description"}, - "CreateTime":{"shape":"CreateTime"}, - "DeleteTime":{"shape":"DeleteTime"}, - "RuleGroups":{"shape":"ProxyConfigRuleGroupSet"}, - "DefaultRulePhaseActions":{"shape":"ProxyConfigDefaultRulePhaseActionsRequest"}, - "Tags":{"shape":"TagList"} - } - }, - "ProxyConfigurationMetadata":{ - "type":"structure", - "members":{ - "Name":{"shape":"ResourceName"}, - "Arn":{"shape":"ResourceArn"} - } - }, - "ProxyConfigurations":{ - "type":"list", - "member":{"shape":"ProxyConfigurationMetadata"} - }, - "ProxyMetadata":{ - "type":"structure", - "members":{ - "Name":{"shape":"ResourceName"}, - "Arn":{"shape":"ResourceArn"} - } - }, - "ProxyModifyState":{ - "type":"string", - "enum":[ - "MODIFYING", - "COMPLETED", - "FAILED" - ] - }, - "ProxyRule":{ - "type":"structure", - "members":{ - "ProxyRuleName":{"shape":"ResourceName"}, - "Description":{"shape":"Description"}, - "Action":{"shape":"ProxyRulePhaseAction"}, - "Conditions":{"shape":"ProxyRuleConditionList"} - } - }, - "ProxyRuleCondition":{ - "type":"structure", - "members":{ - "ConditionOperator":{"shape":"ConditionOperator"}, - "ConditionKey":{"shape":"ConditionKey"}, - "ConditionValues":{"shape":"ProxyConditionValueList"} - } - }, - "ProxyRuleConditionList":{ - "type":"list", - "member":{"shape":"ProxyRuleCondition"} - }, - "ProxyRuleGroup":{ - "type":"structure", - "members":{ - "ProxyRuleGroupName":{"shape":"ResourceName"}, - "ProxyRuleGroupArn":{"shape":"ResourceArn"}, - "CreateTime":{"shape":"CreateTime"}, - "DeleteTime":{"shape":"DeleteTime"}, - "Rules":{"shape":"ProxyRulesByRequestPhase"}, - "Description":{"shape":"Description"}, - "Tags":{"shape":"TagList"} - } - }, - "ProxyRuleGroupAttachment":{ - "type":"structure", - "members":{ - "ProxyRuleGroupName":{"shape":"ResourceName"}, - "InsertPosition":{"shape":"InsertPosition"} - } - }, - "ProxyRuleGroupAttachmentList":{ - "type":"list", - "member":{"shape":"ProxyRuleGroupAttachment"} - }, - "ProxyRuleGroupMetadata":{ - "type":"structure", - "members":{ - "Name":{"shape":"ResourceName"}, - "Arn":{"shape":"ResourceArn"} - } - }, - "ProxyRuleGroupPriority":{ - "type":"structure", - "members":{ - "ProxyRuleGroupName":{"shape":"ResourceName"}, - "NewPosition":{"shape":"InsertPosition"} - } - }, - "ProxyRuleGroupPriorityList":{ - "type":"list", - "member":{"shape":"ProxyRuleGroupPriority"} - }, - "ProxyRuleGroupPriorityResult":{ - "type":"structure", - "members":{ - "ProxyRuleGroupName":{"shape":"ResourceName"}, - "Priority":{"shape":"ProxyRuleGroupPriorityResultPriority"} - } - }, - "ProxyRuleGroupPriorityResultList":{ - "type":"list", - "member":{"shape":"ProxyRuleGroupPriorityResult"} - }, - "ProxyRuleGroupPriorityResultPriority":{"type":"integer"}, - "ProxyRuleGroups":{ - "type":"list", - "member":{"shape":"ProxyRuleGroupMetadata"} - }, - "ProxyRuleList":{ - "type":"list", - "member":{"shape":"ProxyRule"} - }, - "ProxyRulePhaseAction":{ - "type":"string", - "enum":[ - "ALLOW", - "DENY", - "ALERT" - ] - }, - "ProxyRulePriority":{ - "type":"structure", - "members":{ - "ProxyRuleName":{"shape":"ResourceName"}, - "NewPosition":{"shape":"InsertPosition"} - } - }, - "ProxyRulePriorityList":{ - "type":"list", - "member":{"shape":"ProxyRulePriority"} - }, - "ProxyRulesByRequestPhase":{ - "type":"structure", - "members":{ - "PreDNS":{"shape":"ProxyRuleList"}, - "PreREQUEST":{"shape":"ProxyRuleList"}, - "PostRESPONSE":{"shape":"ProxyRuleList"} - } - }, - "ProxyState":{ - "type":"string", - "enum":[ - "ATTACHING", - "ATTACHED", - "DETACHING", - "DETACHED", - "ATTACH_FAILED", - "DETACH_FAILED" - ] - }, - "PublishMetricAction":{ - "type":"structure", - "required":["Dimensions"], - "members":{ - "Dimensions":{"shape":"Dimensions"} - } - }, - "PutResourcePolicyRequest":{ - "type":"structure", - "required":[ - "ResourceArn", - "Policy" - ], - "members":{ - "ResourceArn":{"shape":"ResourceArn"}, - "Policy":{"shape":"PolicyString"} - } - }, - "PutResourcePolicyResponse":{ - "type":"structure", - "members":{} - }, - "ReferenceSets":{ - "type":"structure", - "members":{ - "IPSetReferences":{"shape":"IPSetReferenceMap"} - } - }, - "RejectNetworkFirewallTransitGatewayAttachmentRequest":{ - "type":"structure", - "required":["TransitGatewayAttachmentId"], - "members":{ - "TransitGatewayAttachmentId":{"shape":"TransitGatewayAttachmentId"} - } - }, - "RejectNetworkFirewallTransitGatewayAttachmentResponse":{ - "type":"structure", - "required":[ - "TransitGatewayAttachmentId", - "TransitGatewayAttachmentStatus" - ], - "members":{ - "TransitGatewayAttachmentId":{"shape":"TransitGatewayAttachmentId"}, - "TransitGatewayAttachmentStatus":{"shape":"TransitGatewayAttachmentStatus"} - } - }, - "ReportTime":{"type":"timestamp"}, - "ResourceArn":{ - "type":"string", - "max":256, - "min":1, - "pattern":"^arn:aws.*" - }, - "ResourceArnList":{ - "type":"list", - "member":{"shape":"ResourceArn"} - }, - "ResourceId":{ - "type":"string", - "max":36, - "min":36, - "pattern":"^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$" - }, - "ResourceManagedStatus":{ - "type":"string", - "enum":[ - "MANAGED", - "ACCOUNT" - ] - }, - "ResourceManagedType":{ - "type":"string", - "enum":[ - "AWS_MANAGED_THREAT_SIGNATURES", - "AWS_MANAGED_DOMAIN_LISTS", - "ACTIVE_THREAT_DEFENSE", - "PARTNER_MANAGED" - ] - }, - "ResourceName":{ - "type":"string", - "max":128, - "min":1, - "pattern":"^[a-zA-Z0-9-]+$" - }, - "ResourceNameList":{ - "type":"list", - "member":{"shape":"ResourceName"} - }, - "ResourceNotFoundException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"} - }, - "exception":true - }, - "ResourceOwnerCheckException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"} - }, - "exception":true - }, - "ResourceStatus":{ - "type":"string", - "enum":[ - "ACTIVE", - "DELETING", - "ERROR" - ] - }, - "RevocationCheckAction":{ - "type":"string", - "enum":[ - "PASS", - "DROP", - "REJECT" - ] - }, - "RuleCapacity":{"type":"integer"}, - "RuleDefinition":{ - "type":"structure", - "required":[ - "MatchAttributes", - "Actions" - ], - "members":{ - "MatchAttributes":{"shape":"MatchAttributes"}, - "Actions":{"shape":"StatelessActions"} - } - }, - "RuleGroup":{ - "type":"structure", - "required":["RulesSource"], - "members":{ - "RuleVariables":{"shape":"RuleVariables"}, - "ReferenceSets":{"shape":"ReferenceSets"}, - "RulesSource":{"shape":"RulesSource"}, - "StatefulRuleOptions":{"shape":"StatefulRuleOptions"} - } - }, - "RuleGroupMetadata":{ - "type":"structure", - "members":{ - "Name":{"shape":"ResourceName"}, - "Arn":{"shape":"ResourceArn"}, - "VendorName":{"shape":"VendorName"} - } - }, - "RuleGroupRequestPhase":{ - "type":"string", - "enum":[ - "PRE_DNS", - "PRE_REQ", - "POST_RES" - ] - }, - "RuleGroupResponse":{ - "type":"structure", - "required":[ - "RuleGroupArn", - "RuleGroupName", - "RuleGroupId" - ], - "members":{ - "RuleGroupArn":{"shape":"ResourceArn"}, - "RuleGroupName":{"shape":"ResourceName"}, - "RuleGroupId":{"shape":"ResourceId"}, - "Description":{"shape":"Description"}, - "Type":{"shape":"RuleGroupType"}, - "Capacity":{"shape":"RuleCapacity"}, - "RuleGroupStatus":{"shape":"ResourceStatus"}, - "Tags":{"shape":"TagList"}, - "ConsumedCapacity":{"shape":"RuleCapacity"}, - "NumberOfAssociations":{"shape":"NumberOfAssociations"}, - "EncryptionConfiguration":{"shape":"EncryptionConfiguration"}, - "SourceMetadata":{"shape":"SourceMetadata"}, - "SnsTopic":{"shape":"ResourceArn"}, - "LastModifiedTime":{"shape":"LastUpdateTime"}, - "AnalysisResults":{"shape":"AnalysisResultList"}, - "SummaryConfiguration":{"shape":"SummaryConfiguration"} - } - }, - "RuleGroupType":{ - "type":"string", - "enum":[ - "STATELESS", - "STATEFUL", - "STATEFUL_DOMAIN" - ] - }, - "RuleGroups":{ - "type":"list", - "member":{"shape":"RuleGroupMetadata"} - }, - "RuleIdList":{ - "type":"list", - "member":{"shape":"CollectionMember_String"} - }, - "RuleOption":{ - "type":"structure", - "required":["Keyword"], - "members":{ - "Keyword":{"shape":"Keyword"}, - "Settings":{"shape":"Settings"} - } - }, - "RuleOptions":{ - "type":"list", - "member":{"shape":"RuleOption"} - }, - "RuleOrder":{ - "type":"string", - "enum":[ - "DEFAULT_ACTION_ORDER", - "STRICT_ORDER" - ] - }, - "RuleSummaries":{ - "type":"list", - "member":{"shape":"RuleSummary"} - }, - "RuleSummary":{ - "type":"structure", - "members":{ - "SID":{"shape":"CollectionMember_String"}, - "Msg":{"shape":"CollectionMember_String"}, - "Metadata":{"shape":"CollectionMember_String"} - } - }, - "RuleTargets":{ - "type":"list", - "member":{"shape":"CollectionMember_String"} - }, - "RuleVariableName":{ - "type":"string", - "max":32, - "min":1, - "pattern":"^[A-Za-z][A-Za-z0-9_]*$" - }, - "RuleVariables":{ - "type":"structure", - "members":{ - "IPSets":{"shape":"IPSets"}, - "PortSets":{"shape":"PortSets"} - } - }, - "RulesSource":{ - "type":"structure", - "members":{ - "RulesString":{"shape":"RulesString"}, - "RulesSourceList":{"shape":"RulesSourceList"}, - "StatefulRules":{"shape":"StatefulRules"}, - "StatelessRulesAndCustomActions":{"shape":"StatelessRulesAndCustomActions"} - } - }, - "RulesSourceList":{ - "type":"structure", - "required":[ - "Targets", - "TargetTypes", - "GeneratedRulesType" - ], - "members":{ - "Targets":{"shape":"RuleTargets"}, - "TargetTypes":{"shape":"TargetTypes"}, - "GeneratedRulesType":{"shape":"GeneratedRulesType"} - } - }, - "RulesString":{ - "type":"string", - "max":2000000, - "min":0 - }, - "ServerCertificate":{ - "type":"structure", - "members":{ - "ResourceArn":{"shape":"ResourceArn"} - } - }, - "ServerCertificateConfiguration":{ - "type":"structure", - "members":{ - "ServerCertificates":{"shape":"ServerCertificates"}, - "Scopes":{"shape":"ServerCertificateScopes"}, - "CertificateAuthorityArn":{"shape":"ResourceArn"}, - "CheckCertificateRevocationStatus":{"shape":"CheckCertificateRevocationStatusActions"} - } - }, - "ServerCertificateConfigurations":{ - "type":"list", - "member":{"shape":"ServerCertificateConfiguration"} - }, - "ServerCertificateScope":{ - "type":"structure", - "members":{ - "Sources":{"shape":"Addresses"}, - "Destinations":{"shape":"Addresses"}, - "SourcePorts":{"shape":"PortRanges"}, - "DestinationPorts":{"shape":"PortRanges"}, - "Protocols":{"shape":"ProtocolNumbers"} - } - }, - "ServerCertificateScopes":{ - "type":"list", - "member":{"shape":"ServerCertificateScope"} - }, - "ServerCertificates":{ - "type":"list", - "member":{"shape":"ServerCertificate"} - }, - "Setting":{ - "type":"string", - "max":8192, - "min":1, - "pattern":".*" - }, - "Settings":{ - "type":"list", - "member":{"shape":"Setting"} - }, - "Source":{ - "type":"string", - "max":1024, - "min":1, - "pattern":"^.*$" - }, - "SourceMetadata":{ - "type":"structure", - "members":{ - "SourceArn":{"shape":"ResourceArn"}, - "SourceUpdateToken":{"shape":"UpdateToken"} - } - }, - "StartAnalysisReportRequest":{ - "type":"structure", - "required":["AnalysisType"], - "members":{ - "FirewallName":{"shape":"ResourceName"}, - "FirewallArn":{"shape":"ResourceArn"}, - "AnalysisType":{"shape":"EnabledAnalysisType"} - } - }, - "StartAnalysisReportResponse":{ - "type":"structure", - "required":["AnalysisReportId"], - "members":{ - "AnalysisReportId":{"shape":"AnalysisReportId"} - } - }, - "StartFlowCaptureRequest":{ - "type":"structure", - "required":[ - "FirewallArn", - "FlowFilters" - ], - "members":{ - "FirewallArn":{"shape":"ResourceArn"}, - "AvailabilityZone":{"shape":"AvailabilityZone"}, - "VpcEndpointAssociationArn":{"shape":"ResourceArn"}, - "VpcEndpointId":{"shape":"VpcEndpointId"}, - "MinimumFlowAgeInSeconds":{"shape":"Age"}, - "FlowFilters":{"shape":"FlowFilters"} - } - }, - "StartFlowCaptureResponse":{ - "type":"structure", - "members":{ - "FirewallArn":{"shape":"ResourceArn"}, - "FlowOperationId":{"shape":"FlowOperationId"}, - "FlowOperationStatus":{"shape":"FlowOperationStatus"} - } - }, - "StartFlowFlushRequest":{ - "type":"structure", - "required":[ - "FirewallArn", - "FlowFilters" - ], - "members":{ - "FirewallArn":{"shape":"ResourceArn"}, - "AvailabilityZone":{"shape":"AvailabilityZone"}, - "VpcEndpointAssociationArn":{"shape":"ResourceArn"}, - "VpcEndpointId":{"shape":"VpcEndpointId"}, - "MinimumFlowAgeInSeconds":{"shape":"Age"}, - "FlowFilters":{"shape":"FlowFilters"} - } - }, - "StartFlowFlushResponse":{ - "type":"structure", - "members":{ - "FirewallArn":{"shape":"ResourceArn"}, - "FlowOperationId":{"shape":"FlowOperationId"}, - "FlowOperationStatus":{"shape":"FlowOperationStatus"} - } - }, - "StartTime":{"type":"timestamp"}, - "StatefulAction":{ - "type":"string", - "enum":[ - "PASS", - "DROP", - "ALERT", - "REJECT" - ] - }, - "StatefulActions":{ - "type":"list", - "member":{"shape":"CollectionMember_String"} - }, - "StatefulEngineOptions":{ - "type":"structure", - "members":{ - "RuleOrder":{"shape":"RuleOrder"}, - "StreamExceptionPolicy":{"shape":"StreamExceptionPolicy"}, - "FlowTimeouts":{"shape":"FlowTimeouts"} - } - }, - "StatefulRule":{ - "type":"structure", - "required":[ - "Action", - "Header", - "RuleOptions" - ], - "members":{ - "Action":{"shape":"StatefulAction"}, - "Header":{"shape":"Header"}, - "RuleOptions":{"shape":"RuleOptions"} - } - }, - "StatefulRuleDirection":{ - "type":"string", - "enum":[ - "FORWARD", - "ANY" - ] - }, - "StatefulRuleGroupOverride":{ - "type":"structure", - "members":{ - "Action":{"shape":"OverrideAction"} - } - }, - "StatefulRuleGroupReference":{ - "type":"structure", - "required":["ResourceArn"], - "members":{ - "ResourceArn":{"shape":"ResourceArn"}, - "Priority":{ - "shape":"Priority", - "box":true - }, - "Override":{"shape":"StatefulRuleGroupOverride"}, - "DeepThreatInspection":{"shape":"DeepThreatInspection"} - } - }, - "StatefulRuleGroupReferences":{ - "type":"list", - "member":{"shape":"StatefulRuleGroupReference"} - }, - "StatefulRuleOptions":{ - "type":"structure", - "members":{ - "RuleOrder":{"shape":"RuleOrder"} - } - }, - "StatefulRuleProtocol":{ - "type":"string", - "enum":[ - "IP", - "TCP", - "UDP", - "ICMP", - "HTTP", - "FTP", - "TLS", - "SMB", - "DNS", - "DCERPC", - "SSH", - "SMTP", - "IMAP", - "MSN", - "KRB5", - "IKEV2", - "TFTP", - "NTP", - "DHCP", - "HTTP2", - "QUIC" - ] - }, - "StatefulRules":{ - "type":"list", - "member":{"shape":"StatefulRule"} - }, - "StatelessActions":{ - "type":"list", - "member":{"shape":"CollectionMember_String"} - }, - "StatelessRule":{ - "type":"structure", - "required":[ - "RuleDefinition", - "Priority" - ], - "members":{ - "RuleDefinition":{"shape":"RuleDefinition"}, - "Priority":{"shape":"Priority"} - } - }, - "StatelessRuleGroupReference":{ - "type":"structure", - "required":[ - "ResourceArn", - "Priority" - ], - "members":{ - "ResourceArn":{"shape":"ResourceArn"}, - "Priority":{"shape":"Priority"} - } - }, - "StatelessRuleGroupReferences":{ - "type":"list", - "member":{"shape":"StatelessRuleGroupReference"} - }, - "StatelessRules":{ - "type":"list", - "member":{"shape":"StatelessRule"} - }, - "StatelessRulesAndCustomActions":{ - "type":"structure", - "required":["StatelessRules"], - "members":{ - "StatelessRules":{"shape":"StatelessRules"}, - "CustomActions":{"shape":"CustomActions"} - } - }, - "Status":{"type":"string"}, - "StatusMessage":{"type":"string"}, - "StatusReason":{ - "type":"string", - "max":256, - "min":1, - "pattern":"^[a-zA-Z0-9- ]+$" - }, - "StreamExceptionPolicy":{ - "type":"string", - "enum":[ - "DROP", - "CONTINUE", - "REJECT" - ] - }, - "SubnetMapping":{ - "type":"structure", - "required":["SubnetId"], - "members":{ - "SubnetId":{"shape":"CollectionMember_String"}, - "IPAddressType":{"shape":"IPAddressType"} - } - }, - "SubnetMappings":{ - "type":"list", - "member":{"shape":"SubnetMapping"} - }, - "SubscriptionStatus":{ - "type":"string", - "enum":[ - "NOT_SUBSCRIBED", - "SUBSCRIBED" - ] - }, - "Summary":{ - "type":"structure", - "members":{ - "RuleSummaries":{"shape":"RuleSummaries"} - } - }, - "SummaryConfiguration":{ - "type":"structure", - "members":{ - "RuleOptions":{"shape":"SummaryRuleOptions"} - } - }, - "SummaryRuleOption":{ - "type":"string", - "enum":[ - "SID", - "MSG", - "METADATA" - ] - }, - "SummaryRuleOptions":{ - "type":"list", - "member":{"shape":"SummaryRuleOption"} - }, - "SupportedAvailabilityZones":{ - "type":"map", - "key":{"shape":"AvailabilityZone"}, - "value":{"shape":"AvailabilityZoneMetadata"} - }, - "SyncState":{ - "type":"structure", - "members":{ - "Attachment":{"shape":"Attachment"}, - "Config":{"shape":"SyncStateConfig"} - } - }, - "SyncStateConfig":{ - "type":"map", - "key":{"shape":"ResourceName"}, - "value":{"shape":"PerObjectStatus"} - }, - "SyncStates":{ - "type":"map", - "key":{"shape":"AvailabilityZone"}, - "value":{"shape":"SyncState"} - }, - "TCPFlag":{ - "type":"string", - "enum":[ - "FIN", - "SYN", - "RST", - "PSH", - "ACK", - "URG", - "ECE", - "CWR" - ] - }, - "TCPFlagField":{ - "type":"structure", - "required":["Flags"], - "members":{ - "Flags":{"shape":"Flags"}, - "Masks":{"shape":"Flags"} - } - }, - "TCPFlags":{ - "type":"list", - "member":{"shape":"TCPFlagField"} - }, - "TLSInspectionConfiguration":{ - "type":"structure", - "members":{ - "ServerCertificateConfigurations":{"shape":"ServerCertificateConfigurations"} - } - }, - "TLSInspectionConfigurationMetadata":{ - "type":"structure", - "members":{ - "Name":{"shape":"ResourceName"}, - "Arn":{"shape":"ResourceArn"} - } - }, - "TLSInspectionConfigurationResponse":{ - "type":"structure", - "required":[ - "TLSInspectionConfigurationArn", - "TLSInspectionConfigurationName", - "TLSInspectionConfigurationId" - ], - "members":{ - "TLSInspectionConfigurationArn":{"shape":"ResourceArn"}, - "TLSInspectionConfigurationName":{"shape":"ResourceName"}, - "TLSInspectionConfigurationId":{"shape":"ResourceId"}, - "TLSInspectionConfigurationStatus":{"shape":"ResourceStatus"}, - "Description":{"shape":"Description"}, - "Tags":{"shape":"TagList"}, - "LastModifiedTime":{"shape":"LastUpdateTime"}, - "NumberOfAssociations":{"shape":"NumberOfAssociations"}, - "EncryptionConfiguration":{"shape":"EncryptionConfiguration"}, - "Certificates":{"shape":"Certificates"}, - "CertificateAuthority":{"shape":"TlsCertificateData"} - } - }, - "TLSInspectionConfigurations":{ - "type":"list", - "member":{"shape":"TLSInspectionConfigurationMetadata"} - }, - "Tag":{ - "type":"structure", - "required":[ - "Key", - "Value" - ], - "members":{ - "Key":{"shape":"TagKey"}, - "Value":{"shape":"TagValue"} - } - }, - "TagKey":{ - "type":"string", - "max":128, - "min":1, - "pattern":"^.*$" - }, - "TagKeyList":{ - "type":"list", - "member":{"shape":"TagKey"}, - "max":200, - "min":1 - }, - "TagList":{ - "type":"list", - "member":{"shape":"Tag"}, - "max":200, - "min":1 - }, - "TagResourceRequest":{ - "type":"structure", - "required":[ - "ResourceArn", - "Tags" - ], - "members":{ - "ResourceArn":{"shape":"ResourceArn"}, - "Tags":{"shape":"TagList"} - } - }, - "TagResourceResponse":{ - "type":"structure", - "members":{} - }, - "TagValue":{ - "type":"string", - "max":256, - "min":0, - "pattern":"^.*$" - }, - "TagsPaginationMaxResults":{ - "type":"integer", - "max":100, - "min":0 - }, - "TargetType":{ - "type":"string", - "enum":[ - "TLS_SNI", - "HTTP_HOST" - ] - }, - "TargetTypes":{ - "type":"list", - "member":{"shape":"TargetType"} - }, - "TcpIdleTimeoutRangeBound":{"type":"integer"}, - "ThrottlingException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"} - }, - "exception":true - }, - "TlsCertificateData":{ - "type":"structure", - "members":{ - "CertificateArn":{"shape":"ResourceArn"}, - "CertificateSerial":{"shape":"CollectionMember_String"}, - "Status":{"shape":"CollectionMember_String"}, - "StatusMessage":{"shape":"StatusReason"} - } - }, - "TlsInterceptMode":{ - "type":"string", - "enum":[ - "ENABLED", - "DISABLED" - ] - }, - "TlsInterceptProperties":{ - "type":"structure", - "members":{ - "PcaArn":{"shape":"ResourceArn"}, - "TlsInterceptMode":{"shape":"TlsInterceptMode"} - } - }, - "TlsInterceptPropertiesRequest":{ - "type":"structure", - "members":{ - "PcaArn":{"shape":"ResourceArn"}, - "TlsInterceptMode":{"shape":"TlsInterceptMode"} - } - }, - "TransitGatewayAttachmentId":{ - "type":"string", - "max":128, - "min":1, - "pattern":"^tgw-attach-[0-9a-z]+$" - }, - "TransitGatewayAttachmentStatus":{ - "type":"string", - "enum":[ - "CREATING", - "DELETING", - "DELETED", - "FAILED", - "ERROR", - "READY", - "PENDING_ACCEPTANCE", - "REJECTING", - "REJECTED" - ] - }, - "TransitGatewayAttachmentSyncState":{ - "type":"structure", - "members":{ - "AttachmentId":{"shape":"AttachmentId"}, - "TransitGatewayAttachmentStatus":{"shape":"TransitGatewayAttachmentStatus"}, - "StatusMessage":{"shape":"TransitGatewayAttachmentSyncStateMessage"} - } - }, - "TransitGatewayAttachmentSyncStateMessage":{"type":"string"}, - "TransitGatewayId":{ - "type":"string", - "max":128, - "min":1, - "pattern":"^tgw-[0-9a-z]+$" - }, - "UniqueSources":{ - "type":"structure", - "members":{ - "Count":{"shape":"Count"} - } - }, - "UnsupportedOperationException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"} - }, - "exception":true - }, - "UntagResourceRequest":{ - "type":"structure", - "required":[ - "ResourceArn", - "TagKeys" - ], - "members":{ - "ResourceArn":{"shape":"ResourceArn"}, - "TagKeys":{"shape":"TagKeyList"} - } - }, - "UntagResourceResponse":{ - "type":"structure", - "members":{} - }, - "UpdateAvailabilityZoneChangeProtectionRequest":{ - "type":"structure", - "required":["AvailabilityZoneChangeProtection"], - "members":{ - "UpdateToken":{"shape":"UpdateToken"}, - "FirewallArn":{"shape":"ResourceArn"}, - "FirewallName":{"shape":"ResourceName"}, - "AvailabilityZoneChangeProtection":{"shape":"Boolean"} - } - }, - "UpdateAvailabilityZoneChangeProtectionResponse":{ - "type":"structure", - "members":{ - "UpdateToken":{"shape":"UpdateToken"}, - "FirewallArn":{"shape":"ResourceArn"}, - "FirewallName":{"shape":"ResourceName"}, - "AvailabilityZoneChangeProtection":{"shape":"Boolean"} - } - }, - "UpdateContainerAssociationRequest":{ - "type":"structure", - "required":[ - "Type", - "ContainerMonitoringConfigurations", - "UpdateToken" - ], - "members":{ - "ContainerAssociationName":{"shape":"ResourceName"}, - "ContainerAssociationArn":{"shape":"ResourceArn"}, - "Description":{"shape":"Description"}, - "Type":{"shape":"ContainerMonitoringType"}, - "ContainerMonitoringConfigurations":{"shape":"ContainerMonitoringConfigurations"}, - "Tags":{"shape":"TagList"}, - "UpdateToken":{"shape":"UpdateToken"} - } - }, - "UpdateContainerAssociationResponse":{ - "type":"structure", - "members":{ - "ContainerAssociationName":{"shape":"ResourceName"}, - "ContainerAssociationArn":{"shape":"ResourceArn"}, - "Description":{"shape":"Description"}, - "Type":{"shape":"ContainerMonitoringType"}, - "ContainerMonitoringConfigurations":{"shape":"ContainerMonitoringConfigurations"}, - "Status":{"shape":"ContainerAssociationStatus"}, - "Tags":{"shape":"TagList"}, - "UpdateToken":{"shape":"UpdateToken"} - } - }, - "UpdateFirewallAnalysisSettingsRequest":{ - "type":"structure", - "members":{ - "EnabledAnalysisTypes":{"shape":"EnabledAnalysisTypes"}, - "FirewallArn":{"shape":"ResourceArn"}, - "FirewallName":{"shape":"ResourceName"}, - "UpdateToken":{"shape":"UpdateToken"} - } - }, - "UpdateFirewallAnalysisSettingsResponse":{ - "type":"structure", - "members":{ - "EnabledAnalysisTypes":{"shape":"EnabledAnalysisTypes"}, - "FirewallArn":{"shape":"ResourceArn"}, - "FirewallName":{"shape":"ResourceName"}, - "UpdateToken":{"shape":"UpdateToken"} - } - }, - "UpdateFirewallDeleteProtectionRequest":{ - "type":"structure", - "required":["DeleteProtection"], - "members":{ - "UpdateToken":{"shape":"UpdateToken"}, - "FirewallArn":{"shape":"ResourceArn"}, - "FirewallName":{"shape":"ResourceName"}, - "DeleteProtection":{"shape":"Boolean"} - } - }, - "UpdateFirewallDeleteProtectionResponse":{ - "type":"structure", - "members":{ - "FirewallArn":{"shape":"ResourceArn"}, - "FirewallName":{"shape":"ResourceName"}, - "DeleteProtection":{"shape":"Boolean"}, - "UpdateToken":{"shape":"UpdateToken"} - } - }, - "UpdateFirewallDescriptionRequest":{ - "type":"structure", - "members":{ - "UpdateToken":{"shape":"UpdateToken"}, - "FirewallArn":{"shape":"ResourceArn"}, - "FirewallName":{"shape":"ResourceName"}, - "Description":{"shape":"Description"} - } - }, - "UpdateFirewallDescriptionResponse":{ - "type":"structure", - "members":{ - "FirewallArn":{"shape":"ResourceArn"}, - "FirewallName":{"shape":"ResourceName"}, - "Description":{"shape":"Description"}, - "UpdateToken":{"shape":"UpdateToken"} - } - }, - "UpdateFirewallEncryptionConfigurationRequest":{ - "type":"structure", - "members":{ - "UpdateToken":{"shape":"UpdateToken"}, - "FirewallArn":{"shape":"ResourceArn"}, - "FirewallName":{"shape":"ResourceName"}, - "EncryptionConfiguration":{"shape":"EncryptionConfiguration"} - } - }, - "UpdateFirewallEncryptionConfigurationResponse":{ - "type":"structure", - "members":{ - "FirewallArn":{"shape":"ResourceArn"}, - "FirewallName":{"shape":"ResourceName"}, - "UpdateToken":{"shape":"UpdateToken"}, - "EncryptionConfiguration":{"shape":"EncryptionConfiguration"} - } - }, - "UpdateFirewallPolicyChangeProtectionRequest":{ - "type":"structure", - "required":["FirewallPolicyChangeProtection"], - "members":{ - "UpdateToken":{"shape":"UpdateToken"}, - "FirewallArn":{"shape":"ResourceArn"}, - "FirewallName":{"shape":"ResourceName"}, - "FirewallPolicyChangeProtection":{"shape":"Boolean"} - } - }, - "UpdateFirewallPolicyChangeProtectionResponse":{ - "type":"structure", - "members":{ - "UpdateToken":{"shape":"UpdateToken"}, - "FirewallArn":{"shape":"ResourceArn"}, - "FirewallName":{"shape":"ResourceName"}, - "FirewallPolicyChangeProtection":{"shape":"Boolean"} - } - }, - "UpdateFirewallPolicyRequest":{ - "type":"structure", - "required":[ - "UpdateToken", - "FirewallPolicy" - ], - "members":{ - "UpdateToken":{"shape":"UpdateToken"}, - "FirewallPolicyArn":{"shape":"ResourceArn"}, - "FirewallPolicyName":{"shape":"ResourceName"}, - "FirewallPolicy":{"shape":"FirewallPolicy"}, - "Description":{"shape":"Description"}, - "DryRun":{"shape":"Boolean"}, - "EncryptionConfiguration":{"shape":"EncryptionConfiguration"} - } - }, - "UpdateFirewallPolicyResponse":{ - "type":"structure", - "required":[ - "UpdateToken", - "FirewallPolicyResponse" - ], - "members":{ - "UpdateToken":{"shape":"UpdateToken"}, - "FirewallPolicyResponse":{"shape":"FirewallPolicyResponse"} - } - }, - "UpdateLoggingConfigurationRequest":{ - "type":"structure", - "members":{ - "FirewallArn":{"shape":"ResourceArn"}, - "FirewallName":{"shape":"ResourceName"}, - "LoggingConfiguration":{"shape":"LoggingConfiguration"}, - "EnableMonitoringDashboard":{"shape":"EnableMonitoringDashboard"} - } - }, - "UpdateLoggingConfigurationResponse":{ - "type":"structure", - "members":{ - "FirewallArn":{"shape":"ResourceArn"}, - "FirewallName":{"shape":"ResourceName"}, - "LoggingConfiguration":{"shape":"LoggingConfiguration"}, - "EnableMonitoringDashboard":{"shape":"EnableMonitoringDashboard"} - } - }, - "UpdateProxyConfigurationRequest":{ - "type":"structure", - "required":[ - "DefaultRulePhaseActions", - "UpdateToken" - ], - "members":{ - "ProxyConfigurationName":{"shape":"ResourceName"}, - "ProxyConfigurationArn":{"shape":"ResourceArn"}, - "DefaultRulePhaseActions":{"shape":"ProxyConfigDefaultRulePhaseActionsRequest"}, - "UpdateToken":{"shape":"UpdateToken"} - } - }, - "UpdateProxyConfigurationResponse":{ - "type":"structure", - "members":{ - "ProxyConfiguration":{"shape":"ProxyConfiguration"}, - "UpdateToken":{"shape":"UpdateToken"} - } - }, - "UpdateProxyRequest":{ - "type":"structure", - "required":[ - "NatGatewayId", - "UpdateToken" - ], - "members":{ - "NatGatewayId":{"shape":"NatGatewayId"}, - "ProxyName":{"shape":"ResourceName"}, - "ProxyArn":{"shape":"ResourceArn"}, - "ListenerPropertiesToAdd":{"shape":"ListenerPropertiesRequest"}, - "ListenerPropertiesToRemove":{"shape":"ListenerPropertiesRequest"}, - "TlsInterceptProperties":{"shape":"TlsInterceptPropertiesRequest"}, - "UpdateToken":{"shape":"UpdateToken"} - } - }, - "UpdateProxyResponse":{ - "type":"structure", - "members":{ - "Proxy":{"shape":"Proxy"}, - "UpdateToken":{"shape":"UpdateToken"} - } - }, - "UpdateProxyRuleGroupPrioritiesRequest":{ - "type":"structure", - "required":[ - "RuleGroups", - "UpdateToken" - ], - "members":{ - "ProxyConfigurationName":{"shape":"ResourceName"}, - "ProxyConfigurationArn":{"shape":"ResourceArn"}, - "RuleGroups":{"shape":"ProxyRuleGroupPriorityList"}, - "UpdateToken":{"shape":"UpdateToken"} - } - }, - "UpdateProxyRuleGroupPrioritiesResponse":{ - "type":"structure", - "members":{ - "ProxyRuleGroups":{"shape":"ProxyRuleGroupPriorityResultList"}, - "UpdateToken":{"shape":"UpdateToken"} - } - }, - "UpdateProxyRulePrioritiesRequest":{ - "type":"structure", - "required":[ - "RuleGroupRequestPhase", - "Rules", - "UpdateToken" - ], - "members":{ - "ProxyRuleGroupName":{"shape":"ResourceName"}, - "ProxyRuleGroupArn":{"shape":"ResourceArn"}, - "RuleGroupRequestPhase":{"shape":"RuleGroupRequestPhase"}, - "Rules":{"shape":"ProxyRulePriorityList"}, - "UpdateToken":{"shape":"UpdateToken"} - } - }, - "UpdateProxyRulePrioritiesResponse":{ - "type":"structure", - "members":{ - "ProxyRuleGroupName":{"shape":"ResourceName"}, - "ProxyRuleGroupArn":{"shape":"ResourceArn"}, - "RuleGroupRequestPhase":{"shape":"RuleGroupRequestPhase"}, - "Rules":{"shape":"ProxyRulePriorityList"}, - "UpdateToken":{"shape":"UpdateToken"} - } - }, - "UpdateProxyRuleRequest":{ - "type":"structure", - "required":[ - "ProxyRuleName", - "UpdateToken" - ], - "members":{ - "ProxyRuleGroupName":{"shape":"ResourceName"}, - "ProxyRuleGroupArn":{"shape":"ResourceArn"}, - "ProxyRuleName":{"shape":"ResourceName"}, - "Description":{"shape":"Description"}, - "Action":{"shape":"ProxyRulePhaseAction"}, - "AddConditions":{"shape":"ProxyRuleConditionList"}, - "RemoveConditions":{"shape":"ProxyRuleConditionList"}, - "UpdateToken":{"shape":"UpdateToken"} - } - }, - "UpdateProxyRuleResponse":{ - "type":"structure", - "members":{ - "ProxyRule":{"shape":"ProxyRule"}, - "RemovedConditions":{"shape":"ProxyRuleConditionList"}, - "UpdateToken":{"shape":"UpdateToken"} - } - }, - "UpdateRuleGroupRequest":{ - "type":"structure", - "required":["UpdateToken"], - "members":{ - "UpdateToken":{"shape":"UpdateToken"}, - "RuleGroupArn":{"shape":"ResourceArn"}, - "RuleGroupName":{"shape":"ResourceName"}, - "RuleGroup":{"shape":"RuleGroup"}, - "Rules":{"shape":"RulesString"}, - "Type":{"shape":"RuleGroupType"}, - "Description":{"shape":"Description"}, - "DryRun":{"shape":"Boolean"}, - "EncryptionConfiguration":{"shape":"EncryptionConfiguration"}, - "SourceMetadata":{"shape":"SourceMetadata"}, - "AnalyzeRuleGroup":{"shape":"Boolean"}, - "SummaryConfiguration":{"shape":"SummaryConfiguration"} - } - }, - "UpdateRuleGroupResponse":{ - "type":"structure", - "required":[ - "UpdateToken", - "RuleGroupResponse" - ], - "members":{ - "UpdateToken":{"shape":"UpdateToken"}, - "RuleGroupResponse":{"shape":"RuleGroupResponse"} - } - }, - "UpdateSubnetChangeProtectionRequest":{ - "type":"structure", - "required":["SubnetChangeProtection"], - "members":{ - "UpdateToken":{"shape":"UpdateToken"}, - "FirewallArn":{"shape":"ResourceArn"}, - "FirewallName":{"shape":"ResourceName"}, - "SubnetChangeProtection":{"shape":"Boolean"} - } - }, - "UpdateSubnetChangeProtectionResponse":{ - "type":"structure", - "members":{ - "UpdateToken":{"shape":"UpdateToken"}, - "FirewallArn":{"shape":"ResourceArn"}, - "FirewallName":{"shape":"ResourceName"}, - "SubnetChangeProtection":{"shape":"Boolean"} - } - }, - "UpdateTLSInspectionConfigurationRequest":{ - "type":"structure", - "required":[ - "TLSInspectionConfiguration", - "UpdateToken" - ], - "members":{ - "TLSInspectionConfigurationArn":{"shape":"ResourceArn"}, - "TLSInspectionConfigurationName":{"shape":"ResourceName"}, - "TLSInspectionConfiguration":{"shape":"TLSInspectionConfiguration"}, - "Description":{"shape":"Description"}, - "EncryptionConfiguration":{"shape":"EncryptionConfiguration"}, - "UpdateToken":{"shape":"UpdateToken"} - } - }, - "UpdateTLSInspectionConfigurationResponse":{ - "type":"structure", - "required":[ - "UpdateToken", - "TLSInspectionConfigurationResponse" - ], - "members":{ - "UpdateToken":{"shape":"UpdateToken"}, - "TLSInspectionConfigurationResponse":{"shape":"TLSInspectionConfigurationResponse"} - } - }, - "UpdateTime":{"type":"timestamp"}, - "UpdateToken":{ - "type":"string", - "max":1024, - "min":1, - "pattern":"^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$" - }, - "VariableDefinition":{ - "type":"string", - "min":1, - "pattern":"^.*$" - }, - "VariableDefinitionList":{ - "type":"list", - "member":{"shape":"VariableDefinition"} - }, - "VendorName":{"type":"string"}, - "VpcEndpointAssociation":{ - "type":"structure", - "required":[ - "VpcEndpointAssociationArn", - "FirewallArn", - "VpcId", - "SubnetMapping" - ], - "members":{ - "VpcEndpointAssociationId":{"shape":"ResourceId"}, - "VpcEndpointAssociationArn":{"shape":"ResourceArn"}, - "FirewallArn":{"shape":"ResourceArn"}, - "VpcId":{"shape":"VpcId"}, - "SubnetMapping":{"shape":"SubnetMapping"}, - "Description":{"shape":"Description"}, - "Tags":{"shape":"TagList"} - } - }, - "VpcEndpointAssociationMetadata":{ - "type":"structure", - "members":{ - "VpcEndpointAssociationArn":{"shape":"ResourceArn"} - } - }, - "VpcEndpointAssociationStatus":{ - "type":"structure", - "required":["Status"], - "members":{ - "Status":{"shape":"FirewallStatusValue"}, - "AssociationSyncState":{"shape":"AssociationSyncState"} - } - }, - "VpcEndpointAssociations":{ - "type":"list", - "member":{"shape":"VpcEndpointAssociationMetadata"} - }, - "VpcEndpointId":{ - "type":"string", - "max":256, - "min":5, - "pattern":"^vpce-[a-zA-Z0-9]*$" - }, - "VpcEndpointServiceName":{"type":"string"}, - "VpcId":{ - "type":"string", - "max":128, - "min":1, - "pattern":"^vpc-[0-9a-f]+$" - }, - "VpcIds":{ - "type":"list", - "member":{"shape":"VpcId"} - } - } -} diff --git a/tools/code-generation/api-descriptions/network-firewall/2020-11-12/docs-2.json b/tools/code-generation/api-descriptions/network-firewall/2020-11-12/docs-2.json deleted file mode 100644 index 27a4f5c989a4..000000000000 --- a/tools/code-generation/api-descriptions/network-firewall/2020-11-12/docs-2.json +++ /dev/null @@ -1,3332 +0,0 @@ -{ - "version": "2.0", - "service": "

This is the API Reference for Network Firewall. This guide is for developers who need detailed information about the Network Firewall API actions, data types, and errors.

The REST API requires you to handle connection details, such as calculating signatures, handling request retries, and error handling. For general information about using the Amazon Web Services REST APIs, see Amazon Web Services APIs.

To view the complete list of Amazon Web Services Regions where Network Firewall is available, see Service endpoints and quotas in the Amazon Web Services General Reference.

To access Network Firewall using the IPv4 REST API endpoint: https://network-firewall.<region>.amazonaws.com

To access Network Firewall using the Dualstack (IPv4 and IPv6) REST API endpoint: https://network-firewall.<region>.aws.api

Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see Amazon Web Services SDKs.

For descriptions of Network Firewall features, including and step-by-step instructions on how to use them through the Network Firewall console, see the Network Firewall Developer Guide.

Network Firewall is a stateful, managed, network firewall and intrusion detection and prevention service for Amazon Virtual Private Cloud (Amazon VPC). With Network Firewall, you can filter traffic at the perimeter of your VPC. This includes filtering traffic going to and coming from an internet gateway, NAT gateway, or over VPN or Direct Connect. Network Firewall uses rules that are compatible with Suricata, a free, open source network analysis and threat detection engine. Network Firewall supports Suricata version 7.0.3. For information about Suricata, see the Suricata website and the Suricata User Guide.

You can use Network Firewall to monitor and protect your VPC traffic in a number of ways. The following are just a few examples:

  • Allow domains or IP addresses for known Amazon Web Services service endpoints, such as Amazon S3, and block all other forms of traffic.

  • Use custom lists of known bad domains to limit the types of domain names that your applications can access.

  • Perform deep packet inspection on traffic entering or leaving your VPC.

  • Use stateful protocol detection to filter protocols like HTTPS, regardless of the port used.

To enable Network Firewall for your VPCs, you perform steps in both Amazon VPC and in Network Firewall. For information about using Amazon VPC, see Amazon VPC User Guide.

To start using Network Firewall, do the following:

  1. (Optional) If you don't already have a VPC that you want to protect, create it in Amazon VPC.

  2. In Amazon VPC, in each Availability Zone where you want to have a firewall endpoint, create a subnet for the sole use of Network Firewall.

  3. In Network Firewall, define the firewall behavior as follows:

    1. Create stateless and stateful rule groups, to define the components of the network traffic filtering behavior that you want your firewall to have.

    2. Create a firewall policy that uses your rule groups and specifies additional default traffic filtering behavior.

  4. In Network Firewall, create a firewall and specify your new firewall policy and VPC subnets. Network Firewall creates a firewall endpoint in each subnet that you specify, with the behavior that's defined in the firewall policy.

  5. In Amazon VPC, use ingress routing enhancements to route traffic through the new firewall endpoints.

After your firewall is established, you can add firewall endpoints for new Availability Zones by following the prior steps for the Amazon VPC setup and firewall subnet definitions. You can also add endpoints to Availability Zones that you're using in the firewall, either for the same VPC or for another VPC, by following the prior steps for the Amazon VPC setup, and defining the new VPC subnets as VPC endpoint associations.

", - "operations": { - "AcceptNetworkFirewallTransitGatewayAttachment": "

Accepts a transit gateway attachment request for Network Firewall. When you accept the attachment request, Network Firewall creates the necessary routing components to enable traffic flow between the transit gateway and firewall endpoints.

You must accept a transit gateway attachment to complete the creation of a transit gateway-attached firewall, unless auto-accept is enabled on the transit gateway. After acceptance, use DescribeFirewall to verify the firewall status.

To reject an attachment instead of accepting it, use RejectNetworkFirewallTransitGatewayAttachment.

It can take several minutes for the attachment acceptance to complete and the firewall to become available.

", - "AssociateAvailabilityZones": "

Associates the specified Availability Zones with a transit gateway-attached firewall. For each Availability Zone, Network Firewall creates a firewall endpoint to process traffic. You can specify one or more Availability Zones where you want to deploy the firewall.

After adding Availability Zones, you must update your transit gateway route tables to direct traffic through the new firewall endpoints. Use DescribeFirewall to monitor the status of the new endpoints.

", - "AssociateFirewallPolicy": "

Associates a FirewallPolicy to a Firewall.

A firewall policy defines how to monitor and manage your VPC network traffic, using a collection of inspection rule groups and other settings. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.

", - "AssociateSubnets": "

Associates the specified subnets in the Amazon VPC to the firewall. You can specify one subnet for each of the Availability Zones that the VPC spans.

This request creates an Network Firewall firewall endpoint in each of the subnets. To enable the firewall's protections, you must also modify the VPC's route tables for each subnet's Availability Zone, to redirect the traffic that's coming into and going out of the zone through the firewall endpoint.

", - "AttachRuleGroupsToProxyConfiguration": "

Attaches ProxyRuleGroup resources to a ProxyConfiguration

A Proxy Configuration defines the monitoring and protection behavior for a Proxy. The details of the behavior are defined in the rule groups that you add to your configuration.

", - "CreateContainerAssociation": "

Creates a container association for Network Firewall. A container association links container clusters (ECS or EKS) to Network Firewall, enabling dynamic IP resolution for firewall rules based on container attributes.

To manage a container association's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.

To retrieve information about container associations, use ListContainerAssociations and DescribeContainerAssociation.

", - "CreateFirewall": "

Creates an Network Firewall Firewall and accompanying FirewallStatus for a VPC.

The firewall defines the configuration settings for an Network Firewall firewall. The settings that you can define at creation include the firewall policy, the subnets in your VPC to use for the firewall endpoints, and any tags that are attached to the firewall Amazon Web Services resource.

After you create a firewall, you can provide additional settings, like the logging configuration.

To update the settings for a firewall, you use the operations that apply to the settings themselves, for example UpdateLoggingConfiguration, AssociateSubnets, and UpdateFirewallDeleteProtection.

To manage a firewall's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.

To retrieve information about firewalls, use ListFirewalls and DescribeFirewall.

To generate a report on the last 30 days of traffic monitored by a firewall, use StartAnalysisReport.

", - "CreateFirewallPolicy": "

Creates the firewall policy for the firewall according to the specifications.

An Network Firewall firewall policy defines the behavior of a firewall, in a collection of stateless and stateful rule groups and other settings. You can use one firewall policy for multiple firewalls.

", - "CreateProxy": "

Creates an Network Firewall Proxy

Attaches a Proxy configuration to a NAT Gateway.

To manage a proxy's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.

To retrieve information about proxies, use ListProxies and DescribeProxy.

", - "CreateProxyConfiguration": "

Creates an Network Firewall ProxyConfiguration

A Proxy Configuration defines the monitoring and protection behavior for a Proxy. The details of the behavior are defined in the rule groups that you add to your configuration.

To manage a proxy configuration's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.

To retrieve information about proxies, use ListProxyConfigurations and DescribeProxyConfiguration.

", - "CreateProxyRuleGroup": "

Creates an Network Firewall ProxyRuleGroup

Collections of related proxy filtering rules. Rule groups help you manage and reuse sets of rules across multiple proxy configurations.

To manage a proxy rule group's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.

To retrieve information about proxy rule groups, use ListProxyRuleGroups and DescribeProxyRuleGroup.

To retrieve information about individual proxy rules, use DescribeProxyRuleGroup and DescribeProxyRule.

", - "CreateProxyRules": "

Creates Network Firewall ProxyRule resources.

Attaches new proxy rule(s) to an existing proxy rule group.

To retrieve information about individual proxy rules, use DescribeProxyRuleGroup and DescribeProxyRule.

", - "CreateRuleGroup": "

Creates the specified stateless or stateful rule group, which includes the rules for network traffic inspection, a capacity setting, and tags.

You provide your rule group specification in your request using either RuleGroup or Rules.

", - "CreateTLSInspectionConfiguration": "

Creates an Network Firewall TLS inspection configuration. Network Firewall uses TLS inspection configurations to decrypt your firewall's inbound and outbound SSL/TLS traffic. After decryption, Network Firewall inspects the traffic according to your firewall policy's stateful rules, and then re-encrypts it before sending it to its destination. You can enable inspection of your firewall's inbound traffic, outbound traffic, or both. To use TLS inspection with your firewall, you must first import or provision certificates using ACM, create a TLS inspection configuration, add that configuration to a new firewall policy, and then associate that policy with your firewall.

To update the settings for a TLS inspection configuration, use UpdateTLSInspectionConfiguration.

To manage a TLS inspection configuration's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.

To retrieve information about TLS inspection configurations, use ListTLSInspectionConfigurations and DescribeTLSInspectionConfiguration.

For more information about TLS inspection configurations, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.

", - "CreateVpcEndpointAssociation": "

Creates a firewall endpoint for an Network Firewall firewall. This type of firewall endpoint is independent of the firewall endpoints that you specify in the Firewall itself, and you define it in addition to those endpoints after the firewall has been created. You can define a VPC endpoint association using a different VPC than the one you used in the firewall specifications.

", - "DeleteContainerAssociation": "

Deletes the specified container association. When you delete a container association, Network Firewall stops monitoring the associated container clusters and removes the resolved IP addresses from firewall rules.

", - "DeleteFirewall": "

Deletes the specified Firewall and its FirewallStatus. This operation requires the firewall's DeleteProtection flag to be FALSE. You can't revert this operation.

You can check whether a firewall is in use by reviewing the route tables for the Availability Zones where you have firewall subnet mappings. Retrieve the subnet mappings by calling DescribeFirewall. You define and update the route tables through Amazon VPC. As needed, update the route tables for the zones to remove the firewall endpoints. When the route tables no longer use the firewall endpoints, you can remove the firewall safely.

To delete a firewall, remove the delete protection if you need to using UpdateFirewallDeleteProtection, then delete the firewall by calling DeleteFirewall.

", - "DeleteFirewallPolicy": "

Deletes the specified FirewallPolicy.

", - "DeleteNetworkFirewallTransitGatewayAttachment": "

Deletes a transit gateway attachment from a Network Firewall. Either the firewall owner or the transit gateway owner can delete the attachment.

After you delete a transit gateway attachment, traffic will no longer flow through the firewall endpoints.

After you initiate the delete operation, use DescribeFirewall to monitor the deletion status.

", - "DeleteProxy": "

Deletes the specified Proxy.

Detaches a Proxy configuration from a NAT Gateway.

", - "DeleteProxyConfiguration": "

Deletes the specified ProxyConfiguration.

", - "DeleteProxyRuleGroup": "

Deletes the specified ProxyRuleGroup.

", - "DeleteProxyRules": "

Deletes the specified ProxyRule(s). currently attached to a ProxyRuleGroup

", - "DeleteResourcePolicy": "

Deletes a resource policy that you created in a PutResourcePolicy request.

", - "DeleteRuleGroup": "

Deletes the specified RuleGroup.

", - "DeleteTLSInspectionConfiguration": "

Deletes the specified TLSInspectionConfiguration.

", - "DeleteVpcEndpointAssociation": "

Deletes the specified VpcEndpointAssociation.

You can check whether an endpoint association is in use by reviewing the route tables for the Availability Zones where you have the endpoint subnet mapping. You can retrieve the subnet mapping by calling DescribeVpcEndpointAssociation. You define and update the route tables through Amazon VPC. As needed, update the route tables for the Availability Zone to remove the firewall endpoint for the association. When the route tables no longer use the firewall endpoint, you can remove the endpoint association safely.

", - "DescribeContainerAssociation": "

Returns the properties of a container association.

", - "DescribeFirewall": "

Returns the data objects for the specified firewall.

", - "DescribeFirewallMetadata": "

Returns the high-level information about a firewall, including the Availability Zones where the Firewall is currently in use.

", - "DescribeFirewallPolicy": "

Returns the data objects for the specified firewall policy.

", - "DescribeFlowOperation": "

Returns key information about a specific flow operation.

", - "DescribeLoggingConfiguration": "

Returns the logging configuration for the specified firewall.

", - "DescribeProxy": "

Returns the data objects for the specified proxy.

", - "DescribeProxyConfiguration": "

Returns the data objects for the specified proxy configuration.

", - "DescribeProxyRule": "

Returns the data objects for the specified proxy configuration for the specified proxy rule group.

", - "DescribeProxyRuleGroup": "

Returns the data objects for the specified proxy rule group.

", - "DescribeResourcePolicy": "

Retrieves a resource policy that you created in a PutResourcePolicy request.

", - "DescribeRuleGroup": "

Returns the data objects for the specified rule group.

", - "DescribeRuleGroupMetadata": "

High-level information about a rule group, returned by operations like create and describe. You can use the information provided in the metadata to retrieve and manage a rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

", - "DescribeRuleGroupSummary": "

Returns detailed information for a stateful rule group.

For active threat defense Amazon Web Services managed rule groups, this operation provides insight into the protections enabled by the rule group, based on Suricata rule metadata fields. Summaries are available for rule groups you manage and for active threat defense Amazon Web Services managed rule groups.

To modify how threat information appears in summaries, use the SummaryConfiguration parameter in UpdateRuleGroup.

", - "DescribeTLSInspectionConfiguration": "

Returns the data objects for the specified TLS inspection configuration.

", - "DescribeVpcEndpointAssociation": "

Returns the data object for the specified VPC endpoint association.

", - "DetachRuleGroupsFromProxyConfiguration": "

Detaches ProxyRuleGroup resources from a ProxyConfiguration

A Proxy Configuration defines the monitoring and protection behavior for a Proxy. The details of the behavior are defined in the rule groups that you add to your configuration.

", - "DisassociateAvailabilityZones": "

Removes the specified Availability Zone associations from a transit gateway-attached firewall. This removes the firewall endpoints from these Availability Zones and stops traffic filtering in those zones. Before removing an Availability Zone, ensure you've updated your transit gateway route tables to redirect traffic appropriately.

If AvailabilityZoneChangeProtection is enabled, you must first disable it using UpdateAvailabilityZoneChangeProtection.

To verify the status of your Availability Zone changes, use DescribeFirewall.

", - "DisassociateSubnets": "

Removes the specified subnet associations from the firewall. This removes the firewall endpoints from the subnets and removes any network filtering protections that the endpoints were providing.

", - "GetAnalysisReportResults": "

The results of a COMPLETED analysis report generated with StartAnalysisReport.

For more information, see AnalysisTypeReportResult.

", - "ListAnalysisReports": "

Returns a list of all traffic analysis reports generated within the last 30 days.

", - "ListContainerAssociations": "

Retrieves the metadata for the container associations that you have defined. You can optionally page through results.

", - "ListFirewallPolicies": "

Retrieves the metadata for the firewall policies that you have defined. Depending on your setting for max results and the number of firewall policies, a single call might not return the full list.

", - "ListFirewalls": "

Retrieves the metadata for the firewalls that you have defined. If you provide VPC identifiers in your request, this returns only the firewalls for those VPCs.

Depending on your setting for max results and the number of firewalls, a single call might not return the full list.

", - "ListFlowOperationResults": "

Returns the results of a specific flow operation.

Flow operations let you manage the flows tracked in the flow table, also known as the firewall table.

A flow is network traffic that is monitored by a firewall, either by stateful or stateless rules. For traffic to be considered part of a flow, it must share Destination, DestinationPort, Direction, Protocol, Source, and SourcePort.

", - "ListFlowOperations": "

Returns a list of all flow operations ran in a specific firewall. You can optionally narrow the request scope by specifying the operation type or Availability Zone associated with a firewall's flow operations.

Flow operations let you manage the flows tracked in the flow table, also known as the firewall table.

A flow is network traffic that is monitored by a firewall, either by stateful or stateless rules. For traffic to be considered part of a flow, it must share Destination, DestinationPort, Direction, Protocol, Source, and SourcePort.

", - "ListProxies": "

Retrieves the metadata for the proxies that you have defined. Depending on your setting for max results and the number of proxies, a single call might not return the full list.

", - "ListProxyConfigurations": "

Retrieves the metadata for the proxy configuration that you have defined. Depending on your setting for max results and the number of proxy configurations, a single call might not return the full list.

", - "ListProxyRuleGroups": "

Retrieves the metadata for the proxy rule groups that you have defined. Depending on your setting for max results and the number of proxy rule groups, a single call might not return the full list.

", - "ListRuleGroups": "

Retrieves the metadata for the rule groups that you have defined. Depending on your setting for max results and the number of rule groups, a single call might not return the full list.

", - "ListTLSInspectionConfigurations": "

Retrieves the metadata for the TLS inspection configurations that you have defined. Depending on your setting for max results and the number of TLS inspection configurations, a single call might not return the full list.

", - "ListTagsForResource": "

Retrieves the tags associated with the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

You can tag the Amazon Web Services resources that you manage through Network Firewall: firewalls, firewall policies, and rule groups.

", - "ListVpcEndpointAssociations": "

Retrieves the metadata for the VPC endpoint associations that you have defined. If you specify a fireawll, this returns only the endpoint associations for that firewall.

Depending on your setting for max results and the number of associations, a single call might not return the full list.

", - "PutResourcePolicy": "

Creates or updates an IAM policy for your rule group, firewall policy, or firewall. Use this to share these resources between accounts. This operation works in conjunction with the Amazon Web Services Resource Access Manager (RAM) service to manage resource sharing for Network Firewall.

For information about using sharing with Network Firewall resources, see Sharing Network Firewall resources in the Network Firewall Developer Guide.

Use this operation to create or update a resource policy for your Network Firewall rule group, firewall policy, or firewall. In the resource policy, you specify the accounts that you want to share the Network Firewall resource with and the operations that you want the accounts to be able to perform.

When you add an account in the resource policy, you then run the following Resource Access Manager (RAM) operations to access and accept the shared resource.

For additional information about resource sharing using RAM, see Resource Access Manager User Guide.

", - "RejectNetworkFirewallTransitGatewayAttachment": "

Rejects a transit gateway attachment request for Network Firewall. When you reject the attachment request, Network Firewall cancels the creation of routing components between the transit gateway and firewall endpoints.

Only the transit gateway owner can reject the attachment. After rejection, no traffic will flow through the firewall endpoints for this attachment.

Use DescribeFirewall to monitor the rejection status. To accept the attachment instead of rejecting it, use AcceptNetworkFirewallTransitGatewayAttachment.

Once rejected, you cannot reverse this action. To establish connectivity, you must create a new transit gateway-attached firewall.

", - "StartAnalysisReport": "

Generates a traffic analysis report for the timeframe and traffic type you specify.

For information on the contents of a traffic analysis report, see AnalysisReport.

", - "StartFlowCapture": "

Begins capturing the flows in a firewall, according to the filters you define. Captures are similar, but not identical to snapshots. Capture operations provide visibility into flows that are not closed and are tracked by a firewall's flow table. Unlike snapshots, captures are a time-boxed view.

A flow is network traffic that is monitored by a firewall, either by stateful or stateless rules. For traffic to be considered part of a flow, it must share Destination, DestinationPort, Direction, Protocol, Source, and SourcePort.

To avoid encountering operation limits, you should avoid starting captures with broad filters, like wide IP ranges. Instead, we recommend you define more specific criteria with FlowFilters, like narrow IP ranges, ports, or protocols.

", - "StartFlowFlush": "

Begins the flushing of traffic from the firewall, according to the filters you define. When the operation starts, impacted flows are temporarily marked as timed out before the Suricata engine prunes, or flushes, the flows from the firewall table.

While the flush completes, impacted flows are processed as midstream traffic. This may result in a temporary increase in midstream traffic metrics. We recommend that you double check your stream exception policy before you perform a flush operation.

", - "TagResource": "

Adds the specified tags to the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

You can tag the Amazon Web Services resources that you manage through Network Firewall: firewalls, firewall policies, and rule groups.

", - "UntagResource": "

Removes the tags with the specified keys from the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

You can manage tags for the Amazon Web Services resources that you manage through Network Firewall: firewalls, firewall policies, and rule groups.

", - "UpdateAvailabilityZoneChangeProtection": "

Modifies the AvailabilityZoneChangeProtection setting for a transit gateway-attached firewall. When enabled, this setting prevents accidental changes to the firewall's Availability Zone configuration. This helps protect against disrupting traffic flow in production environments.

When enabled, you must disable this protection before using AssociateAvailabilityZones or DisassociateAvailabilityZones to modify the firewall's Availability Zone configuration.

", - "UpdateContainerAssociation": "

Updates the properties of an existing container association. Use this to modify the container monitoring configurations or description.

", - "UpdateFirewallAnalysisSettings": "

Enables specific types of firewall analysis on a specific firewall you define.

", - "UpdateFirewallDeleteProtection": "

Modifies the flag, DeleteProtection, which indicates whether it is possible to delete the firewall. If the flag is set to TRUE, the firewall is protected against deletion. This setting helps protect against accidentally deleting a firewall that's in use.

", - "UpdateFirewallDescription": "

Modifies the description for the specified firewall. Use the description to help you identify the firewall when you're working with it.

", - "UpdateFirewallEncryptionConfiguration": "

A complex type that contains settings for encryption of your firewall resources.

", - "UpdateFirewallPolicy": "

Updates the properties of the specified firewall policy.

", - "UpdateFirewallPolicyChangeProtection": "

Modifies the flag, ChangeProtection, which indicates whether it is possible to change the firewall. If the flag is set to TRUE, the firewall is protected from changes. This setting helps protect against accidentally changing a firewall that's in use.

", - "UpdateLoggingConfiguration": "

Sets the logging configuration for the specified firewall.

To change the logging configuration, retrieve the LoggingConfiguration by calling DescribeLoggingConfiguration, then change it and provide the modified object to this update call. You must change the logging configuration one LogDestinationConfig at a time inside the retrieved LoggingConfiguration object.

You can perform only one of the following actions in any call to UpdateLoggingConfiguration:

  • Create a new log destination object by adding a single LogDestinationConfig array element to LogDestinationConfigs.

  • Delete a log destination object by removing a single LogDestinationConfig array element from LogDestinationConfigs.

  • Change the LogDestination setting in a single LogDestinationConfig array element.

You can't change the LogDestinationType or LogType in a LogDestinationConfig. To change these settings, delete the existing LogDestinationConfig object and create a new one, using two separate calls to this update operation.

", - "UpdateProxy": "

Updates the properties of the specified proxy.

", - "UpdateProxyConfiguration": "

Updates the properties of the specified proxy configuration.

", - "UpdateProxyRule": "

Updates the properties of the specified proxy rule.

", - "UpdateProxyRuleGroupPriorities": "

Updates proxy rule group priorities within a proxy configuration.

", - "UpdateProxyRulePriorities": "

Updates proxy rule priorities within a proxy rule group.

", - "UpdateRuleGroup": "

Updates the rule settings for the specified rule group. You use a rule group by reference in one or more firewall policies. When you modify a rule group, you modify all firewall policies that use the rule group.

To update a rule group, first call DescribeRuleGroup to retrieve the current RuleGroup object, update the object as needed, and then provide the updated object to this call.

", - "UpdateSubnetChangeProtection": "

", - "UpdateTLSInspectionConfiguration": "

Updates the TLS inspection configuration settings for the specified TLS inspection configuration. You use a TLS inspection configuration by referencing it in one or more firewall policies. When you modify a TLS inspection configuration, you modify all firewall policies that use the TLS inspection configuration.

To update a TLS inspection configuration, first call DescribeTLSInspectionConfiguration to retrieve the current TLSInspectionConfiguration object, update the object as needed, and then provide the updated object to this call.

" - }, - "shapes": { - "AWSAccountId": { - "base": null, - "refs": { - "Firewall$TransitGatewayOwnerAccountId": "

The Amazon Web Services account ID that owns the transit gateway. This may be different from the firewall owner's account ID when using a shared transit gateway.

" - } - }, - "AZSyncState": { - "base": "

The status of the firewall endpoint defined by a VpcEndpointAssociation.

", - "refs": { - "AssociationSyncState$value": null - } - }, - "AcceptNetworkFirewallTransitGatewayAttachmentRequest": { - "base": null, - "refs": {} - }, - "AcceptNetworkFirewallTransitGatewayAttachmentResponse": { - "base": null, - "refs": {} - }, - "ActionDefinition": { - "base": "

A custom action to use in stateless rule actions settings. This is used in CustomAction.

", - "refs": { - "CustomAction$ActionDefinition": "

The custom action associated with the action name.

" - } - }, - "ActionName": { - "base": null, - "refs": { - "CustomAction$ActionName": "

The descriptive name of the custom action. You can't change the name of a custom action after you create it.

" - } - }, - "Address": { - "base": "

A single IP address specification. This is used in the MatchAttributes source and destination specifications.

", - "refs": { - "Addresses$member": null, - "Flow$SourceAddress": null, - "Flow$DestinationAddress": null, - "FlowFilter$SourceAddress": null, - "FlowFilter$DestinationAddress": null - } - }, - "AddressDefinition": { - "base": null, - "refs": { - "Address$AddressDefinition": "

Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4 and IPv6.

Examples:

  • To configure Network Firewall to inspect for the IP address 192.0.2.44, specify 192.0.2.44/32.

  • To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

  • To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

  • To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

" - } - }, - "Addresses": { - "base": null, - "refs": { - "MatchAttributes$Sources": "

The source IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any source address.

", - "MatchAttributes$Destinations": "

The destination IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any destination address.

", - "ServerCertificateScope$Sources": "

The source IP addresses and address ranges to decrypt for inspection, in CIDR notation. If not specified, this matches with any source address.

", - "ServerCertificateScope$Destinations": "

The destination IP addresses and address ranges to decrypt for inspection, in CIDR notation. If not specified, this matches with any destination address.

" - } - }, - "Age": { - "base": null, - "refs": { - "Flow$Age": "

Returned as info about age of the flows identified by the flow operation.

", - "FlowOperation$MinimumFlowAgeInSeconds": "

The reqested FlowOperation ignores flows with an age (in seconds) lower than MinimumFlowAgeInSeconds. You provide this for start commands.

", - "StartFlowCaptureRequest$MinimumFlowAgeInSeconds": "

The reqested FlowOperation ignores flows with an age (in seconds) lower than MinimumFlowAgeInSeconds. You provide this for start commands.

We recommend setting this value to at least 1 minute (60 seconds) to reduce chance of capturing flows that are not yet established.

", - "StartFlowFlushRequest$MinimumFlowAgeInSeconds": "

The reqested FlowOperation ignores flows with an age (in seconds) lower than MinimumFlowAgeInSeconds. You provide this for start commands.

" - } - }, - "AnalysisReport": { - "base": "

A report that captures key activity from the last 30 days of network traffic monitored by your firewall.

You can generate up to one report per traffic type, per 30 day period. For example, when you successfully create an HTTP traffic report, you cannot create another HTTP traffic report until 30 days pass. Alternatively, if you generate a report that combines metrics on both HTTP and HTTPS traffic, you cannot create another report for either traffic type until 30 days pass.

", - "refs": { - "AnalysisReports$member": null - } - }, - "AnalysisReportId": { - "base": null, - "refs": { - "AnalysisReport$AnalysisReportId": "

The unique ID of the query that ran when you requested an analysis report.

", - "GetAnalysisReportResultsRequest$AnalysisReportId": "

The unique ID of the query that ran when you requested an analysis report.

", - "StartAnalysisReportResponse$AnalysisReportId": "

The unique ID of the query that ran when you requested an analysis report.

" - } - }, - "AnalysisReportNextToken": { - "base": null, - "refs": { - "GetAnalysisReportResultsRequest$NextToken": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

", - "GetAnalysisReportResultsResponse$NextToken": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" - } - }, - "AnalysisReportResults": { - "base": null, - "refs": { - "GetAnalysisReportResultsResponse$AnalysisReportResults": "

Retrieves the results of a traffic analysis report.

" - } - }, - "AnalysisReports": { - "base": null, - "refs": { - "ListAnalysisReportsResponse$AnalysisReports": "

The id and ReportTime associated with a requested analysis report. Does not provide the status of the analysis report.

" - } - }, - "AnalysisResult": { - "base": "

The analysis result for Network Firewall's stateless rule group analyzer. Every time you call CreateRuleGroup, UpdateRuleGroup, or DescribeRuleGroup on a stateless rule group, Network Firewall analyzes the stateless rule groups in your account and identifies the rules that might adversely effect your firewall's functionality. For example, if Network Firewall detects a rule that's routing traffic asymmetrically, which impacts the service's ability to properly process traffic, the service includes the rule in a list of analysis results.

The AnalysisResult data type is not related to traffic analysis reports you generate using StartAnalysisReport. For information on traffic analysis report results, see AnalysisTypeReportResult.

", - "refs": { - "AnalysisResultList$member": null - } - }, - "AnalysisResultList": { - "base": null, - "refs": { - "RuleGroupResponse$AnalysisResults": "

The list of analysis results for AnalyzeRuleGroup. If you set AnalyzeRuleGroup to TRUE in CreateRuleGroup, UpdateRuleGroup, or DescribeRuleGroup, Network Firewall analyzes the rule group and identifies the rules that might adversely effect your firewall's functionality. For example, if Network Firewall detects a rule that's routing traffic asymmetrically, which impacts the service's ability to properly process traffic, the service includes the rule in the list of analysis results.

" - } - }, - "AnalysisTypeReportResult": { - "base": "

The results of a COMPLETED analysis report generated with StartAnalysisReport.

For an example of traffic analysis report results, see the response syntax of GetAnalysisReportResults.

", - "refs": { - "AnalysisReportResults$member": null - } - }, - "AssociateAvailabilityZonesRequest": { - "base": null, - "refs": {} - }, - "AssociateAvailabilityZonesResponse": { - "base": null, - "refs": {} - }, - "AssociateFirewallPolicyRequest": { - "base": null, - "refs": {} - }, - "AssociateFirewallPolicyResponse": { - "base": null, - "refs": {} - }, - "AssociateSubnetsRequest": { - "base": null, - "refs": {} - }, - "AssociateSubnetsResponse": { - "base": null, - "refs": {} - }, - "AssociationSyncState": { - "base": null, - "refs": { - "VpcEndpointAssociationStatus$AssociationSyncState": "

The list of the Availability Zone sync states for all subnets that are defined by the firewall.

" - } - }, - "AttachRuleGroupsToProxyConfigurationRequest": { - "base": null, - "refs": {} - }, - "AttachRuleGroupsToProxyConfigurationResponse": { - "base": null, - "refs": {} - }, - "Attachment": { - "base": "

The definition and status of the firewall endpoint for a single subnet. In each configured subnet, Network Firewall instantiates a firewall endpoint to handle network traffic.

This data type is used for any firewall endpoint type:

  • For Firewall.SubnetMappings, this Attachment is part of the FirewallStatus sync states information. You define firewall subnets using CreateFirewall and AssociateSubnets.

  • For VpcEndpointAssociation, this Attachment is part of the VpcEndpointAssociationStatus sync states information. You define these subnets using CreateVpcEndpointAssociation.

", - "refs": { - "AZSyncState$Attachment": null, - "SyncState$Attachment": "

The configuration and status for a single firewall subnet. For each configured subnet, Network Firewall creates the attachment by instantiating the firewall endpoint in the subnet so that it's ready to take traffic.

" - } - }, - "AttachmentId": { - "base": null, - "refs": { - "TransitGatewayAttachmentSyncState$AttachmentId": "

The unique identifier of the transit gateway attachment.

" - } - }, - "AttachmentStatus": { - "base": null, - "refs": { - "Attachment$Status": "

The current status of the firewall endpoint instantiation in the subnet.

When this value is READY, the endpoint is available to handle network traffic. Otherwise, this value reflects its state, for example CREATING or DELETING.

" - } - }, - "AvailabilityZone": { - "base": null, - "refs": { - "AssociationSyncState$key": null, - "DescribeFlowOperationRequest$AvailabilityZone": "

The ID of the Availability Zone where the firewall is located. For example, us-east-2a.

Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.

", - "DescribeFlowOperationResponse$AvailabilityZone": "

The ID of the Availability Zone where the firewall is located. For example, us-east-2a.

Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.

", - "ListFlowOperationResultsRequest$AvailabilityZone": "

The ID of the Availability Zone where the firewall is located. For example, us-east-2a.

Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.

", - "ListFlowOperationResultsResponse$AvailabilityZone": "

The ID of the Availability Zone where the firewall is located. For example, us-east-2a.

Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.

", - "ListFlowOperationsRequest$AvailabilityZone": "

The ID of the Availability Zone where the firewall is located. For example, us-east-2a.

Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.

", - "StartFlowCaptureRequest$AvailabilityZone": "

The ID of the Availability Zone where the firewall is located. For example, us-east-2a.

Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.

", - "StartFlowFlushRequest$AvailabilityZone": "

The ID of the Availability Zone where the firewall is located. For example, us-east-2a.

Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.

", - "SupportedAvailabilityZones$key": null, - "SyncStates$key": null - } - }, - "AvailabilityZoneMapping": { - "base": "

Defines the mapping between an Availability Zone and a firewall endpoint for a transit gateway-attached firewall. Each mapping represents where the firewall can process traffic. You use these mappings when calling CreateFirewall, AssociateAvailabilityZones, and DisassociateAvailabilityZones.

To retrieve the current Availability Zone mappings for a firewall, use DescribeFirewall.

", - "refs": { - "AvailabilityZoneMappings$member": null - } - }, - "AvailabilityZoneMappingString": { - "base": null, - "refs": { - "AvailabilityZoneMapping$AvailabilityZone": "

The ID of the Availability Zone where the firewall endpoint is located. For example, us-east-2a. The Availability Zone must be in the same Region as the transit gateway.

" - } - }, - "AvailabilityZoneMappings": { - "base": null, - "refs": { - "AssociateAvailabilityZonesRequest$AvailabilityZoneMappings": "

Required. The Availability Zones where you want to create firewall endpoints. You must specify at least one Availability Zone.

", - "AssociateAvailabilityZonesResponse$AvailabilityZoneMappings": "

The Availability Zones where Network Firewall created firewall endpoints. Each mapping specifies an Availability Zone where the firewall processes traffic.

", - "CreateFirewallRequest$AvailabilityZoneMappings": "

Required. The Availability Zones where you want to create firewall endpoints for a transit gateway-attached firewall. You must specify at least one Availability Zone. Consider enabling the firewall in every Availability Zone where you have workloads to maintain Availability Zone isolation.

You can modify Availability Zones later using AssociateAvailabilityZones or DisassociateAvailabilityZones, but this may briefly disrupt traffic. The AvailabilityZoneChangeProtection setting controls whether you can make these modifications.

", - "DisassociateAvailabilityZonesRequest$AvailabilityZoneMappings": "

Required. The Availability Zones to remove from the firewall's configuration.

", - "DisassociateAvailabilityZonesResponse$AvailabilityZoneMappings": "

The remaining Availability Zones where the firewall has endpoints after the disassociation.

", - "Firewall$AvailabilityZoneMappings": "

The Availability Zones where the firewall endpoints are created for a transit gateway-attached firewall. Each mapping specifies an Availability Zone where the firewall processes traffic.

" - } - }, - "AvailabilityZoneMetadata": { - "base": "

High-level information about an Availability Zone where the firewall has an endpoint defined.

", - "refs": { - "SupportedAvailabilityZones$value": null - } - }, - "AzSubnet": { - "base": null, - "refs": { - "Attachment$SubnetId": "

The unique identifier of the subnet that you've specified to be used for a firewall endpoint.

", - "AzSubnets$member": null - } - }, - "AzSubnets": { - "base": null, - "refs": { - "DisassociateSubnetsRequest$SubnetIds": "

The unique identifiers for the subnets that you want to disassociate.

" - } - }, - "Boolean": { - "base": null, - "refs": { - "CreateFirewallPolicyRequest$DryRun": "

Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.

If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.

If set to FALSE, Network Firewall makes the requested changes to your resources.

", - "CreateFirewallRequest$DeleteProtection": "

A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE.

", - "CreateFirewallRequest$SubnetChangeProtection": "

A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

", - "CreateFirewallRequest$FirewallPolicyChangeProtection": "

A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

", - "CreateFirewallRequest$AvailabilityZoneChangeProtection": "

Optional. A setting indicating whether the firewall is protected against changes to its Availability Zone configuration. When set to TRUE, you cannot add or remove Availability Zones without first disabling this protection using UpdateAvailabilityZoneChangeProtection.

Default value: FALSE

", - "CreateRuleGroupRequest$DryRun": "

Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.

If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.

If set to FALSE, Network Firewall makes the requested changes to your resources.

", - "CreateRuleGroupRequest$AnalyzeRuleGroup": "

Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior such as asymmetric routing. If set to TRUE, Network Firewall runs the analysis and then creates the rule group for you. To run the stateless rule group analyzer without creating the rule group, set DryRun to TRUE.

", - "DescribeRuleGroupRequest$AnalyzeRuleGroup": "

Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior such as asymmetric routing. If set to TRUE, Network Firewall runs the analysis.

", - "Firewall$DeleteProtection": "

A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE.

", - "Firewall$SubnetChangeProtection": "

A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

", - "Firewall$FirewallPolicyChangeProtection": "

A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

", - "Firewall$AvailabilityZoneChangeProtection": "

A setting indicating whether the firewall is protected against changes to its Availability Zone configuration. When set to TRUE, you must first disable this protection before adding or removing Availability Zones.

", - "UpdateAvailabilityZoneChangeProtectionRequest$AvailabilityZoneChangeProtection": "

A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

", - "UpdateAvailabilityZoneChangeProtectionResponse$AvailabilityZoneChangeProtection": "

A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

", - "UpdateFirewallDeleteProtectionRequest$DeleteProtection": "

A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE.

", - "UpdateFirewallDeleteProtectionResponse$DeleteProtection": "

A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE.

", - "UpdateFirewallPolicyChangeProtectionRequest$FirewallPolicyChangeProtection": "

A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

", - "UpdateFirewallPolicyChangeProtectionResponse$FirewallPolicyChangeProtection": "

A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

", - "UpdateFirewallPolicyRequest$DryRun": "

Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.

If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.

If set to FALSE, Network Firewall makes the requested changes to your resources.

", - "UpdateRuleGroupRequest$DryRun": "

Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.

If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.

If set to FALSE, Network Firewall makes the requested changes to your resources.

", - "UpdateRuleGroupRequest$AnalyzeRuleGroup": "

Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior such as asymmetric routing. If set to TRUE, Network Firewall runs the analysis and then updates the rule group for you. To run the stateless rule group analyzer without updating the rule group, set DryRun to TRUE.

", - "UpdateSubnetChangeProtectionRequest$SubnetChangeProtection": "

A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

", - "UpdateSubnetChangeProtectionResponse$SubnetChangeProtection": "

A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

" - } - }, - "ByteCount": { - "base": null, - "refs": { - "Flow$ByteCount": "

Returns the number of bytes received or transmitted in a specific flow.

" - } - }, - "CIDRCount": { - "base": null, - "refs": { - "CIDRSummary$AvailableCIDRCount": "

The number of CIDR blocks available for use by the IP set references in a firewall.

", - "CIDRSummary$UtilizedCIDRCount": "

The number of CIDR blocks used by the IP set references in a firewall.

", - "DescribeContainerAssociationResponse$ResolvedCidrCount": "

The number of CIDR blocks that have been resolved from the monitored containers for this container association.

", - "IPSetMetadata$ResolvedCIDRCount": "

Describes the total number of CIDR blocks currently in use by the IP set references in a firewall. To determine how many CIDR blocks are available for you to use in a firewall, you can call AvailableCIDRCount.

" - } - }, - "CIDRSummary": { - "base": "

Summarizes the CIDR blocks used by the IP set references in a firewall. Network Firewall calculates the number of CIDRs by taking an aggregated count of all CIDRs used by the IP sets you are referencing.

", - "refs": { - "CapacityUsageSummary$CIDRs": "

Describes the capacity usage of the CIDR blocks used by the IP set references in a firewall.

" - } - }, - "CapacityUsageSummary": { - "base": "

The capacity usage summary of the resources used by the ReferenceSets in a firewall.

", - "refs": { - "FirewallStatus$CapacityUsageSummary": "

Describes the capacity usage of the resources contained in a firewall's reference sets. Network Firewall calculates the capacity usage by taking an aggregated count of all of the resources used by all of the reference sets in a firewall.

" - } - }, - "Certificates": { - "base": null, - "refs": { - "TLSInspectionConfigurationResponse$Certificates": "

A list of the certificates associated with the TLS inspection configuration.

" - } - }, - "CheckCertificateRevocationStatusActions": { - "base": "

Defines the actions to take on the SSL/TLS connection if the certificate presented by the server in the connection has a revoked or unknown status.

", - "refs": { - "ServerCertificateConfiguration$CheckCertificateRevocationStatus": "

When enabled, Network Firewall checks if the server certificate presented by the server in the SSL/TLS connection has a revoked or unkown status. If the certificate has an unknown or revoked status, you must specify the actions that Network Firewall takes on outbound traffic. To check the certificate revocation status, you must also specify a CertificateAuthorityArn in ServerCertificateConfiguration.

" - } - }, - "CollectionMember_String": { - "base": null, - "refs": { - "AnalysisResult$AnalysisDetail": "

Provides analysis details for the identified rule.

", - "AnalysisTypeReportResult$Protocol": "

The type of traffic captured by the analysis report.

", - "RuleIdList$member": null, - "RuleSummary$SID": "

The unique identifier (Signature ID) of the Suricata rule.

", - "RuleSummary$Msg": "

The contents taken from the rule's msg field.

", - "RuleSummary$Metadata": "

The contents of the rule's metadata.

", - "RuleTargets$member": null, - "StatefulActions$member": null, - "StatelessActions$member": null, - "SubnetMapping$SubnetId": "

The unique identifier for the subnet.

", - "TlsCertificateData$CertificateSerial": "

The serial number of the certificate.

", - "TlsCertificateData$Status": "

The status of the certificate.

" - } - }, - "ConditionKey": { - "base": null, - "refs": { - "ProxyRuleCondition$ConditionKey": "

Defines what is to be matched.

" - } - }, - "ConditionOperator": { - "base": null, - "refs": { - "ProxyRuleCondition$ConditionOperator": "

Defines how to perform a match.

" - } - }, - "ConfigurationSyncState": { - "base": null, - "refs": { - "FirewallStatus$ConfigurationSyncStateSummary": "

The configuration sync state for the firewall. This summarizes the Config settings in the SyncStates for this firewall status object.

When you create a firewall or update its configuration, for example by adding a rule group to its firewall policy, Network Firewall distributes the configuration changes to all Availability Zones that have subnets defined for the firewall. This summary indicates whether the configuration changes have been applied everywhere.

This status must be IN_SYNC for the firewall to be ready for use, but it doesn't indicate that the firewall is ready. The Status setting indicates firewall readiness. It's based on this setting and the readiness of the firewall endpoints to take traffic.

" - } - }, - "ContainerAssociationLastUpdatedTime": { - "base": null, - "refs": { - "DescribeContainerAssociationResponse$LastUpdatedTime": "

The last time that the container association was updated or resolved new container IP addresses.

" - } - }, - "ContainerAssociationStatus": { - "base": null, - "refs": { - "CreateContainerAssociationResponse$Status": "

The current status of the container association.

", - "DeleteContainerAssociationResponse$Status": "

The current status of the container association.

", - "DescribeContainerAssociationResponse$Status": "

The current status of the container association.

", - "UpdateContainerAssociationResponse$Status": "

The current status of the container association.

" - } - }, - "ContainerAssociationSummary": { - "base": "

High-level information about a container association, returned by the ListContainerAssociations operation. You can use this information to retrieve the full details of a container association using DescribeContainerAssociation.

", - "refs": { - "ContainerAssociations$member": null - } - }, - "ContainerAssociations": { - "base": null, - "refs": { - "ListContainerAssociationsResponse$ContainerAssociations": "

The container association metadata objects.

" - } - }, - "ContainerAttribute": { - "base": "

A key-value pair that defines a container attribute filter for a container monitoring configuration.

", - "refs": { - "ContainerAttributes$member": null - } - }, - "ContainerAttributeKey": { - "base": null, - "refs": { - "ContainerAttribute$Key": "

The key of the container attribute to filter on.

" - } - }, - "ContainerAttributeValue": { - "base": null, - "refs": { - "ContainerAttribute$Value": "

The value of the container attribute to filter on.

" - } - }, - "ContainerAttributes": { - "base": null, - "refs": { - "ContainerMonitoringConfiguration$AttributeFilters": "

A list of key-value pairs that filter which containers within the cluster are monitored. Only containers that match the specified attributes are included.

" - } - }, - "ContainerMonitoringConfiguration": { - "base": "

Defines a container cluster to monitor, along with optional attribute filters that narrow the scope of monitored containers within the cluster.

", - "refs": { - "ContainerMonitoringConfigurations$member": null - } - }, - "ContainerMonitoringConfigurations": { - "base": null, - "refs": { - "CreateContainerAssociationRequest$ContainerMonitoringConfigurations": "

The list of container monitoring configurations that define which clusters and container attributes to monitor.

", - "CreateContainerAssociationResponse$ContainerMonitoringConfigurations": "

The container monitoring configurations for this container association.

", - "DescribeContainerAssociationResponse$ContainerMonitoringConfigurations": "

The container monitoring configurations for this container association.

", - "UpdateContainerAssociationRequest$ContainerMonitoringConfigurations": "

The updated list of container monitoring configurations that define which clusters and container attributes to monitor.

", - "UpdateContainerAssociationResponse$ContainerMonitoringConfigurations": "

The container monitoring configurations for this container association.

" - } - }, - "ContainerMonitoringType": { - "base": null, - "refs": { - "CreateContainerAssociationRequest$Type": "

The type of container orchestration platform for the clusters in this association. Valid values are ECS and EKS. You can't change the type after creation.

", - "CreateContainerAssociationResponse$Type": "

The type of container orchestration platform. Either ECS or EKS.

", - "DescribeContainerAssociationResponse$Type": "

The type of container orchestration platform. Either ECS or EKS.

", - "UpdateContainerAssociationRequest$Type": "

The type of container orchestration platform. This must match the type specified when the container association was created.

", - "UpdateContainerAssociationResponse$Type": "

The type of container orchestration platform. Either ECS or EKS.

" - } - }, - "Count": { - "base": null, - "refs": { - "Hits$Count": "

The number of attempts made to access a domain.

", - "UniqueSources$Count": "

The number of unique source IP addresses that connected to a domain.

" - } - }, - "CreateContainerAssociationRequest": { - "base": null, - "refs": {} - }, - "CreateContainerAssociationResponse": { - "base": null, - "refs": {} - }, - "CreateFirewallPolicyRequest": { - "base": null, - "refs": {} - }, - "CreateFirewallPolicyResponse": { - "base": null, - "refs": {} - }, - "CreateFirewallRequest": { - "base": null, - "refs": {} - }, - "CreateFirewallResponse": { - "base": null, - "refs": {} - }, - "CreateProxyConfigurationRequest": { - "base": null, - "refs": {} - }, - "CreateProxyConfigurationResponse": { - "base": null, - "refs": {} - }, - "CreateProxyRequest": { - "base": null, - "refs": {} - }, - "CreateProxyResponse": { - "base": null, - "refs": {} - }, - "CreateProxyRule": { - "base": "

Individual rules that define match conditions and actions for application-layer traffic. Rules specify what to inspect (domains, headers, methods) and what action to take (allow, deny, alert).

", - "refs": { - "CreateProxyRuleList$member": null - } - }, - "CreateProxyRuleGroupRequest": { - "base": null, - "refs": {} - }, - "CreateProxyRuleGroupResponse": { - "base": null, - "refs": {} - }, - "CreateProxyRuleList": { - "base": null, - "refs": { - "CreateProxyRulesByRequestPhase$PreDNS": "

Before domain resolution.

", - "CreateProxyRulesByRequestPhase$PreREQUEST": "

After DNS, before request.

", - "CreateProxyRulesByRequestPhase$PostRESPONSE": "

After receiving response.

" - } - }, - "CreateProxyRulesByRequestPhase": { - "base": "

Evaluation points in the traffic flow where rules are applied. There are three phases in a traffic where the rule match is applied.

This data type is used specifically for the CreateProxyRules API.

Pre-DNS - before domain resolution.

Pre-Request - after DNS, before request.

Post-Response - after receiving response.

", - "refs": { - "CreateProxyRulesRequest$Rules": "

Individual rules that define match conditions and actions for application-layer traffic. Rules specify what to inspect (domains, headers, methods) and what action to take (allow, deny, alert).

" - } - }, - "CreateProxyRulesRequest": { - "base": null, - "refs": {} - }, - "CreateProxyRulesResponse": { - "base": null, - "refs": {} - }, - "CreateRuleGroupRequest": { - "base": null, - "refs": {} - }, - "CreateRuleGroupResponse": { - "base": null, - "refs": {} - }, - "CreateTLSInspectionConfigurationRequest": { - "base": null, - "refs": {} - }, - "CreateTLSInspectionConfigurationResponse": { - "base": null, - "refs": {} - }, - "CreateTime": { - "base": null, - "refs": { - "DescribeProxyResource$CreateTime": "

Time the Proxy was created.

", - "Proxy$CreateTime": "

Time the Proxy was created.

", - "ProxyConfiguration$CreateTime": "

Time the Proxy Configuration was created.

", - "ProxyRuleGroup$CreateTime": "

Time the Proxy Rule Group was created.

" - } - }, - "CreateVpcEndpointAssociationRequest": { - "base": null, - "refs": {} - }, - "CreateVpcEndpointAssociationResponse": { - "base": null, - "refs": {} - }, - "CustomAction": { - "base": "

An optional, non-standard action to use for stateless packet handling. You can define this in addition to the standard action that you must specify.

You define and name the custom actions that you want to be able to use, and then you reference them by name in your actions settings.

You can use custom actions in the following places:

  • In a rule group's StatelessRulesAndCustomActions specification. The custom actions are available for use by name inside the StatelessRulesAndCustomActions where you define them. You can use them for your stateless rule actions to specify what to do with a packet that matches the rule's match attributes.

  • In a FirewallPolicy specification, in StatelessCustomActions. The custom actions are available for use inside the policy where you define them. You can use them for the policy's default stateless actions settings to specify what to do with packets that don't match any of the policy's stateless rules.

", - "refs": { - "CustomActions$member": null - } - }, - "CustomActions": { - "base": null, - "refs": { - "FirewallPolicy$StatelessCustomActions": "

The custom action definitions that are available for use in the firewall policy's StatelessDefaultActions setting. You name each custom action that you define, and then you can use it by name in your default actions specifications.

", - "StatelessRulesAndCustomActions$CustomActions": "

Defines an array of individual custom action definitions that are available for use by the stateless rules in this StatelessRulesAndCustomActions specification. You name each custom action that you define, and then you can use it by name in your StatelessRule RuleDefinition Actions specification.

" - } - }, - "DeepThreatInspection": { - "base": null, - "refs": { - "StatefulRuleGroupReference$DeepThreatInspection": "

Network Firewall plans to augment the active threat defense managed rule group with an additional deep threat inspection capability. When this capability is released, Amazon Web Services will analyze service logs of network traffic processed by these rule groups to identify threat indicators across customers. Amazon Web Services will use these threat indicators to improve the active threat defense managed rule groups and protect the security of Amazon Web Services customers and services.

Customers can opt-out of deep threat inspection at any time through the Network Firewall console or API. When customers opt out, Network Firewall will not use the network traffic processed by those customers' active threat defense rule groups for rule group improvement.

" - } - }, - "DeleteContainerAssociationRequest": { - "base": null, - "refs": {} - }, - "DeleteContainerAssociationResponse": { - "base": null, - "refs": {} - }, - "DeleteFirewallPolicyRequest": { - "base": null, - "refs": {} - }, - "DeleteFirewallPolicyResponse": { - "base": null, - "refs": {} - }, - "DeleteFirewallRequest": { - "base": null, - "refs": {} - }, - "DeleteFirewallResponse": { - "base": null, - "refs": {} - }, - "DeleteNetworkFirewallTransitGatewayAttachmentRequest": { - "base": null, - "refs": {} - }, - "DeleteNetworkFirewallTransitGatewayAttachmentResponse": { - "base": null, - "refs": {} - }, - "DeleteProxyConfigurationRequest": { - "base": null, - "refs": {} - }, - "DeleteProxyConfigurationResponse": { - "base": null, - "refs": {} - }, - "DeleteProxyRequest": { - "base": null, - "refs": {} - }, - "DeleteProxyResponse": { - "base": null, - "refs": {} - }, - "DeleteProxyRuleGroupRequest": { - "base": null, - "refs": {} - }, - "DeleteProxyRuleGroupResponse": { - "base": null, - "refs": {} - }, - "DeleteProxyRulesRequest": { - "base": null, - "refs": {} - }, - "DeleteProxyRulesResponse": { - "base": null, - "refs": {} - }, - "DeleteResourcePolicyRequest": { - "base": null, - "refs": {} - }, - "DeleteResourcePolicyResponse": { - "base": null, - "refs": {} - }, - "DeleteRuleGroupRequest": { - "base": null, - "refs": {} - }, - "DeleteRuleGroupResponse": { - "base": null, - "refs": {} - }, - "DeleteTLSInspectionConfigurationRequest": { - "base": null, - "refs": {} - }, - "DeleteTLSInspectionConfigurationResponse": { - "base": null, - "refs": {} - }, - "DeleteTime": { - "base": null, - "refs": { - "DescribeProxyResource$DeleteTime": "

Time the Proxy was deleted.

", - "Proxy$DeleteTime": "

Time the Proxy was deleted.

", - "ProxyConfiguration$DeleteTime": "

Time the Proxy Configuration was deleted.

", - "ProxyRuleGroup$DeleteTime": "

Time the Proxy Rule Group was deleted.

" - } - }, - "DeleteVpcEndpointAssociationRequest": { - "base": null, - "refs": {} - }, - "DeleteVpcEndpointAssociationResponse": { - "base": null, - "refs": {} - }, - "DescribeContainerAssociationRequest": { - "base": null, - "refs": {} - }, - "DescribeContainerAssociationResponse": { - "base": null, - "refs": {} - }, - "DescribeFirewallMetadataRequest": { - "base": null, - "refs": {} - }, - "DescribeFirewallMetadataResponse": { - "base": null, - "refs": {} - }, - "DescribeFirewallPolicyRequest": { - "base": null, - "refs": {} - }, - "DescribeFirewallPolicyResponse": { - "base": null, - "refs": {} - }, - "DescribeFirewallRequest": { - "base": null, - "refs": {} - }, - "DescribeFirewallResponse": { - "base": null, - "refs": {} - }, - "DescribeFlowOperationRequest": { - "base": null, - "refs": {} - }, - "DescribeFlowOperationResponse": { - "base": null, - "refs": {} - }, - "DescribeLoggingConfigurationRequest": { - "base": null, - "refs": {} - }, - "DescribeLoggingConfigurationResponse": { - "base": null, - "refs": {} - }, - "DescribeProxyConfigurationRequest": { - "base": null, - "refs": {} - }, - "DescribeProxyConfigurationResponse": { - "base": null, - "refs": {} - }, - "DescribeProxyRequest": { - "base": null, - "refs": {} - }, - "DescribeProxyResource": { - "base": "

Proxy attached to a NAT gateway.

", - "refs": { - "DescribeProxyResponse$Proxy": "

Proxy attached to a NAT gateway.

" - } - }, - "DescribeProxyResponse": { - "base": null, - "refs": {} - }, - "DescribeProxyRuleGroupRequest": { - "base": null, - "refs": {} - }, - "DescribeProxyRuleGroupResponse": { - "base": null, - "refs": {} - }, - "DescribeProxyRuleRequest": { - "base": null, - "refs": {} - }, - "DescribeProxyRuleResponse": { - "base": null, - "refs": {} - }, - "DescribeResourcePolicyRequest": { - "base": null, - "refs": {} - }, - "DescribeResourcePolicyResponse": { - "base": null, - "refs": {} - }, - "DescribeRuleGroupMetadataRequest": { - "base": null, - "refs": {} - }, - "DescribeRuleGroupMetadataResponse": { - "base": null, - "refs": {} - }, - "DescribeRuleGroupRequest": { - "base": null, - "refs": {} - }, - "DescribeRuleGroupResponse": { - "base": null, - "refs": {} - }, - "DescribeRuleGroupSummaryRequest": { - "base": null, - "refs": {} - }, - "DescribeRuleGroupSummaryResponse": { - "base": null, - "refs": {} - }, - "DescribeTLSInspectionConfigurationRequest": { - "base": null, - "refs": {} - }, - "DescribeTLSInspectionConfigurationResponse": { - "base": null, - "refs": {} - }, - "DescribeVpcEndpointAssociationRequest": { - "base": null, - "refs": {} - }, - "DescribeVpcEndpointAssociationResponse": { - "base": null, - "refs": {} - }, - "Description": { - "base": null, - "refs": { - "CreateContainerAssociationRequest$Description": "

A description of the container association.

", - "CreateContainerAssociationResponse$Description": "

A description of the container association.

", - "CreateFirewallPolicyRequest$Description": "

A description of the firewall policy.

", - "CreateFirewallRequest$Description": "

A description of the firewall.

", - "CreateProxyConfigurationRequest$Description": "

A description of the proxy configuration.

", - "CreateProxyRule$Description": "

A description of the proxy rule.

", - "CreateProxyRuleGroupRequest$Description": "

A description of the proxy rule group.

", - "CreateRuleGroupRequest$Description": "

A description of the rule group.

", - "CreateTLSInspectionConfigurationRequest$Description": "

A description of the TLS inspection configuration.

", - "CreateVpcEndpointAssociationRequest$Description": "

A description of the VPC endpoint association.

", - "DescribeContainerAssociationResponse$Description": "

A description of the container association.

", - "DescribeFirewallMetadataResponse$Description": "

A description of the firewall.

", - "DescribeRuleGroupMetadataResponse$Description": "

Returns the metadata objects for the specified rule group.

", - "DescribeRuleGroupSummaryResponse$Description": "

A description of the rule group.

", - "Firewall$Description": "

A description of the firewall.

", - "FirewallPolicyResponse$Description": "

A description of the firewall policy.

", - "ProxyConfiguration$Description": "

A description of the proxy configuration.

", - "ProxyRule$Description": "

A description of the proxy rule.

", - "ProxyRuleGroup$Description": "

A description of the proxy rule group.

", - "RuleGroupResponse$Description": "

A description of the rule group.

", - "TLSInspectionConfigurationResponse$Description": "

A description of the TLS inspection configuration.

", - "UpdateContainerAssociationRequest$Description": "

A description of the container association.

", - "UpdateContainerAssociationResponse$Description": "

A description of the container association.

", - "UpdateFirewallDescriptionRequest$Description": "

The new description for the firewall. If you omit this setting, Network Firewall removes the description for the firewall.

", - "UpdateFirewallDescriptionResponse$Description": "

A description of the firewall.

", - "UpdateFirewallPolicyRequest$Description": "

A description of the firewall policy.

", - "UpdateProxyRuleRequest$Description": "

A description of the proxy rule.

", - "UpdateRuleGroupRequest$Description": "

A description of the rule group.

", - "UpdateTLSInspectionConfigurationRequest$Description": "

A description of the TLS inspection configuration.

", - "VpcEndpointAssociation$Description": "

A description of the VPC endpoint association.

" - } - }, - "Destination": { - "base": null, - "refs": { - "Header$Destination": "

The destination IP address or address range to inspect for, in CIDR notation. To match with any address, specify ANY.

Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4 and IPv6.

Examples:

  • To configure Network Firewall to inspect for the IP address 192.0.2.44, specify 192.0.2.44/32.

  • To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

  • To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

  • To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

" - } - }, - "DetachRuleGroupsFromProxyConfigurationRequest": { - "base": null, - "refs": {} - }, - "DetachRuleGroupsFromProxyConfigurationResponse": { - "base": null, - "refs": {} - }, - "Dimension": { - "base": "

The value to use in an Amazon CloudWatch custom metric dimension. This is used in the PublishMetrics CustomAction. A CloudWatch custom metric dimension is a name/value pair that's part of the identity of a metric.

Network Firewall sets the dimension name to CustomAction and you provide the dimension value.

For more information about CloudWatch custom metric dimensions, see Publishing Custom Metrics in the Amazon CloudWatch User Guide.

", - "refs": { - "Dimensions$member": null - } - }, - "DimensionValue": { - "base": null, - "refs": { - "Dimension$Value": "

The value to use in the custom metric dimension.

" - } - }, - "Dimensions": { - "base": null, - "refs": { - "PublishMetricAction$Dimensions": "

" - } - }, - "DisassociateAvailabilityZonesRequest": { - "base": null, - "refs": {} - }, - "DisassociateAvailabilityZonesResponse": { - "base": null, - "refs": {} - }, - "DisassociateSubnetsRequest": { - "base": null, - "refs": {} - }, - "DisassociateSubnetsResponse": { - "base": null, - "refs": {} - }, - "Domain": { - "base": null, - "refs": { - "AnalysisTypeReportResult$Domain": "

The most frequently accessed domains.

" - } - }, - "EnableMonitoringDashboard": { - "base": null, - "refs": { - "DescribeLoggingConfigurationResponse$EnableMonitoringDashboard": "

A boolean that reflects whether or not the firewall monitoring dashboard is enabled on a firewall.

Returns TRUE when the firewall monitoring dashboard is enabled on the firewall. Returns FALSE when the firewall monitoring dashboard is not enabled on the firewall.

", - "UpdateLoggingConfigurationRequest$EnableMonitoringDashboard": "

A boolean that lets you enable or disable the detailed firewall monitoring dashboard on the firewall.

The monitoring dashboard provides comprehensive visibility into your firewall's flow logs and alert logs. After you enable detailed monitoring, you can access these dashboards directly from the Monitoring page of the Network Firewall console.

Specify TRUE to enable the the detailed monitoring dashboard on the firewall. Specify FALSE to disable the the detailed monitoring dashboard on the firewall.

", - "UpdateLoggingConfigurationResponse$EnableMonitoringDashboard": "

A boolean that reflects whether or not the firewall monitoring dashboard is enabled on a firewall.

Returns TRUE when the firewall monitoring dashboard is enabled on the firewall. Returns FALSE when the firewall monitoring dashboard is not enabled on the firewall.

" - } - }, - "EnableTLSSessionHolding": { - "base": null, - "refs": { - "FirewallPolicy$EnableTLSSessionHolding": "

When true, prevents TCP and TLS packets from reaching destination servers until TLS Inspection has evaluated Server Name Indication (SNI) rules. Requires an associated TLS Inspection configuration.

" - } - }, - "EnabledAnalysisType": { - "base": null, - "refs": { - "AnalysisReport$AnalysisType": "

The type of traffic that will be used to generate a report.

", - "EnabledAnalysisTypes$member": null, - "GetAnalysisReportResultsResponse$AnalysisType": "

The type of traffic that will be used to generate a report.

", - "StartAnalysisReportRequest$AnalysisType": "

The type of traffic that will be used to generate a report.

" - } - }, - "EnabledAnalysisTypes": { - "base": null, - "refs": { - "CreateFirewallRequest$EnabledAnalysisTypes": "

An optional setting indicating the specific traffic analysis types to enable on the firewall.

", - "Firewall$EnabledAnalysisTypes": "

An optional setting indicating the specific traffic analysis types to enable on the firewall.

", - "UpdateFirewallAnalysisSettingsRequest$EnabledAnalysisTypes": "

An optional setting indicating the specific traffic analysis types to enable on the firewall.

", - "UpdateFirewallAnalysisSettingsResponse$EnabledAnalysisTypes": "

An optional setting indicating the specific traffic analysis types to enable on the firewall.

" - } - }, - "EncryptionConfiguration": { - "base": "

A complex type that contains optional Amazon Web Services Key Management Service (KMS) encryption settings for your Network Firewall resources. Your data is encrypted by default with an Amazon Web Services owned key that Amazon Web Services owns and manages for you. You can use either the Amazon Web Services owned key, or provide your own customer managed key. To learn more about KMS encryption of your Network Firewall resources, see Encryption at rest with Amazon Web Services Key Managment Service in the Network Firewall Developer Guide.

", - "refs": { - "CreateFirewallPolicyRequest$EncryptionConfiguration": "

A complex type that contains settings for encryption of your firewall policy resources.

", - "CreateFirewallRequest$EncryptionConfiguration": "

A complex type that contains settings for encryption of your firewall resources.

", - "CreateRuleGroupRequest$EncryptionConfiguration": "

A complex type that contains settings for encryption of your rule group resources.

", - "CreateTLSInspectionConfigurationRequest$EncryptionConfiguration": null, - "Firewall$EncryptionConfiguration": "

A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall.

", - "FirewallPolicyResponse$EncryptionConfiguration": "

A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall policy.

", - "RuleGroupResponse$EncryptionConfiguration": "

A complex type that contains the Amazon Web Services KMS encryption configuration settings for your rule group.

", - "TLSInspectionConfigurationResponse$EncryptionConfiguration": "

A complex type that contains the Amazon Web Services KMS encryption configuration settings for your TLS inspection configuration.

", - "UpdateFirewallEncryptionConfigurationRequest$EncryptionConfiguration": null, - "UpdateFirewallEncryptionConfigurationResponse$EncryptionConfiguration": null, - "UpdateFirewallPolicyRequest$EncryptionConfiguration": "

A complex type that contains settings for encryption of your firewall policy resources.

", - "UpdateRuleGroupRequest$EncryptionConfiguration": "

A complex type that contains settings for encryption of your rule group resources.

", - "UpdateTLSInspectionConfigurationRequest$EncryptionConfiguration": "

A complex type that contains the Amazon Web Services KMS encryption configuration settings for your TLS inspection configuration.

" - } - }, - "EncryptionType": { - "base": null, - "refs": { - "EncryptionConfiguration$Type": "

The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.

" - } - }, - "EndTime": { - "base": null, - "refs": { - "GetAnalysisReportResultsResponse$EndTime": "

The date and time, up to the current date, from which to stop retrieving analysis data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

" - } - }, - "EndpointId": { - "base": null, - "refs": { - "Attachment$EndpointId": "

The identifier of the firewall endpoint that Network Firewall has instantiated in the subnet. You use this to identify the firewall endpoint in the VPC route tables, when you redirect the VPC traffic through the endpoint.

" - } - }, - "ErrorMessage": { - "base": null, - "refs": { - "InsufficientCapacityException$Message": null, - "InternalServerError$Message": null, - "InvalidOperationException$Message": null, - "InvalidRequestException$Message": null, - "InvalidResourcePolicyException$Message": null, - "InvalidTokenException$Message": null, - "LimitExceededException$Message": null, - "LogDestinationPermissionException$Message": null, - "ResourceNotFoundException$Message": null, - "ResourceOwnerCheckException$Message": null, - "ThrottlingException$Message": null, - "UnsupportedOperationException$Message": null - } - }, - "FailureCode": { - "base": null, - "refs": { - "DescribeProxyResource$FailureCode": "

Failure code for cases when the Proxy fails to attach or update.

", - "Proxy$FailureCode": "

Failure code for cases when the Proxy fails to attach or update.

" - } - }, - "FailureMessage": { - "base": null, - "refs": { - "DescribeProxyResource$FailureMessage": "

Failure message for cases when the Proxy fails to attach or update.

", - "Proxy$FailureMessage": "

Failure message for cases when the Proxy fails to attach or update.

" - } - }, - "Firewall": { - "base": "

A firewall defines the behavior of a firewall, the main VPC where the firewall is used, the Availability Zones where the firewall can be used, and one subnet to use for a firewall endpoint within each of the Availability Zones. The Availability Zones are defined implicitly in the subnet specifications.

In addition to the firewall endpoints that you define in this Firewall specification, you can create firewall endpoints in VpcEndpointAssociation resources for any VPC, in any Availability Zone where the firewall is already in use.

The status of the firewall, for example whether it's ready to filter network traffic, is provided in the corresponding FirewallStatus. You can retrieve both the firewall and firewall status by calling DescribeFirewall.

", - "refs": { - "CreateFirewallResponse$Firewall": "

The configuration settings for the firewall. These settings include the firewall policy and the subnets in your VPC to use for the firewall endpoints.

", - "DeleteFirewallResponse$Firewall": null, - "DescribeFirewallResponse$Firewall": "

The configuration settings for the firewall. These settings include the firewall policy and the subnets in your VPC to use for the firewall endpoints.

" - } - }, - "FirewallMetadata": { - "base": "

High-level information about a firewall, returned by operations like create and describe. You can use the information provided in the metadata to retrieve and manage a firewall.

", - "refs": { - "Firewalls$member": null - } - }, - "FirewallPolicies": { - "base": null, - "refs": { - "ListFirewallPoliciesResponse$FirewallPolicies": "

The metadata for the firewall policies. Depending on your setting for max results and the number of firewall policies that you have, this might not be the full list.

" - } - }, - "FirewallPolicy": { - "base": "

The firewall policy defines the behavior of a firewall using a collection of stateless and stateful rule groups and other settings. You can use one firewall policy for multiple firewalls.

This, along with FirewallPolicyResponse, define the policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.

", - "refs": { - "CreateFirewallPolicyRequest$FirewallPolicy": "

The rule groups and policy actions to use in the firewall policy.

", - "DescribeFirewallPolicyResponse$FirewallPolicy": "

The policy for the specified firewall policy.

", - "UpdateFirewallPolicyRequest$FirewallPolicy": "

The updated firewall policy to use for the firewall. You can't add or remove a TLSInspectionConfiguration after you create a firewall policy. However, you can replace an existing TLS inspection configuration with another TLSInspectionConfiguration.

" - } - }, - "FirewallPolicyMetadata": { - "base": "

High-level information about a firewall policy, returned by operations like create and describe. You can use the information provided in the metadata to retrieve and manage a firewall policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.

", - "refs": { - "FirewallPolicies$member": null - } - }, - "FirewallPolicyResponse": { - "base": "

The high-level properties of a firewall policy. This, along with the FirewallPolicy, define the policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.

", - "refs": { - "CreateFirewallPolicyResponse$FirewallPolicyResponse": "

The high-level properties of a firewall policy. This, along with the FirewallPolicy, define the policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.

", - "DeleteFirewallPolicyResponse$FirewallPolicyResponse": "

The object containing the definition of the FirewallPolicyResponse that you asked to delete.

", - "DescribeFirewallPolicyResponse$FirewallPolicyResponse": "

The high-level properties of a firewall policy. This, along with the FirewallPolicy, define the policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.

", - "UpdateFirewallPolicyResponse$FirewallPolicyResponse": "

The high-level properties of a firewall policy. This, along with the FirewallPolicy, define the policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.

" - } - }, - "FirewallStatus": { - "base": "

Detailed information about the current status of a Firewall. You can retrieve this for a firewall by calling DescribeFirewall and providing the firewall name and ARN.

The firewall status indicates a combined status. It indicates whether all subnets are up-to-date with the latest firewall configurations, which is based on the sync states config values, and also whether all subnets have their endpoints fully enabled, based on their sync states attachment values.

", - "refs": { - "CreateFirewallResponse$FirewallStatus": "

Detailed information about the current status of a Firewall. You can retrieve this for a firewall by calling DescribeFirewall and providing the firewall name and ARN.

The firewall status indicates a combined status. It indicates whether all subnets are up-to-date with the latest firewall configurations, which is based on the sync states config values, and also whether all subnets have their endpoints fully enabled, based on their sync states attachment values.

", - "DeleteFirewallResponse$FirewallStatus": null, - "DescribeFirewallResponse$FirewallStatus": "

Detailed information about the current status of a Firewall. You can retrieve this for a firewall by calling DescribeFirewall and providing the firewall name and ARN.

The firewall status indicates a combined status. It indicates whether all subnets are up-to-date with the latest firewall configurations, which is based on the sync states config values, and also whether all subnets have their endpoints fully enabled, based on their sync states attachment values.

" - } - }, - "FirewallStatusValue": { - "base": null, - "refs": { - "DescribeFirewallMetadataResponse$Status": "

The readiness of the configured firewall to handle network traffic across all of the Availability Zones where you have it configured. This setting is READY only when the ConfigurationSyncStateSummary value is IN_SYNC and the Attachment Status values for all of the configured subnets are READY.

", - "FirewallStatus$Status": "

The readiness of the configured firewall to handle network traffic across all of the Availability Zones where you have it configured. This setting is READY only when the ConfigurationSyncStateSummary value is IN_SYNC and the Attachment Status values for all of the configured subnets are READY.

", - "VpcEndpointAssociationStatus$Status": "

The readiness of the configured firewall endpoint to handle network traffic.

" - } - }, - "Firewalls": { - "base": null, - "refs": { - "ListFirewallsResponse$Firewalls": "

The firewall metadata objects for the VPCs that you specified. Depending on your setting for max results and the number of firewalls you have, a single call might not be the full list.

" - } - }, - "FirstAccessed": { - "base": null, - "refs": { - "AnalysisTypeReportResult$FirstAccessed": "

The date and time any domain was first accessed (within the last 30 day period).

" - } - }, - "Flags": { - "base": null, - "refs": { - "TCPFlagField$Flags": "

Used in conjunction with the Masks setting to define the flags that must be set and flags that must not be set in order for the packet to match. This setting can only specify values that are also specified in the Masks setting.

For the flags that are specified in the masks setting, the following must be true for the packet to match:

  • The ones that are set in this flags setting must be set in the packet.

  • The ones that are not set in this flags setting must also not be set in the packet.

", - "TCPFlagField$Masks": "

The set of flags to consider in the inspection. To inspect all flags in the valid values list, leave this with no setting.

" - } - }, - "Flow": { - "base": "

Any number of arrays, where each array is a single flow identified in the scope of the operation. If multiple flows were in the scope of the operation, multiple Flows arrays are returned.

", - "refs": { - "Flows$member": null - } - }, - "FlowFilter": { - "base": "

Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.

", - "refs": { - "FlowFilters$member": null - } - }, - "FlowFilters": { - "base": null, - "refs": { - "FlowOperation$FlowFilters": "

Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.

", - "StartFlowCaptureRequest$FlowFilters": "

Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.

", - "StartFlowFlushRequest$FlowFilters": "

Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.

" - } - }, - "FlowOperation": { - "base": "

Contains information about a flow operation, such as related statuses, unique identifiers, and all filters defined in the operation.

Flow operations let you manage the flows tracked in the flow table, also known as the firewall table.

A flow is network traffic that is monitored by a firewall, either by stateful or stateless rules. For traffic to be considered part of a flow, it must share Destination, DestinationPort, Direction, Protocol, Source, and SourcePort.

", - "refs": { - "DescribeFlowOperationResponse$FlowOperation": "

Returns key information about a flow operation, such as related statuses, unique identifiers, and all filters defined in the operation.

" - } - }, - "FlowOperationId": { - "base": null, - "refs": { - "DescribeFlowOperationRequest$FlowOperationId": "

A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.

", - "DescribeFlowOperationResponse$FlowOperationId": "

A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.

", - "FlowOperationMetadata$FlowOperationId": "

A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.

", - "ListFlowOperationResultsRequest$FlowOperationId": "

A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.

", - "ListFlowOperationResultsResponse$FlowOperationId": "

A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.

", - "StartFlowCaptureResponse$FlowOperationId": "

A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.

", - "StartFlowFlushResponse$FlowOperationId": "

A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.

" - } - }, - "FlowOperationMetadata": { - "base": "

An array of objects with metadata about the requested FlowOperation.

", - "refs": { - "FlowOperations$member": null - } - }, - "FlowOperationStatus": { - "base": null, - "refs": { - "DescribeFlowOperationResponse$FlowOperationStatus": "

Returns the status of the flow operation. This string is returned in the responses to start, list, and describe commands.

If the status is COMPLETED_WITH_ERRORS, results may be returned with any number of Flows missing from the response. If the status is FAILED, Flows returned will be empty.

", - "FlowOperationMetadata$FlowOperationStatus": "

Returns the status of the flow operation. This string is returned in the responses to start, list, and describe commands.

If the status is COMPLETED_WITH_ERRORS, results may be returned with any number of Flows missing from the response. If the status is FAILED, Flows returned will be empty.

", - "ListFlowOperationResultsResponse$FlowOperationStatus": "

Returns the status of the flow operation. This string is returned in the responses to start, list, and describe commands.

If the status is COMPLETED_WITH_ERRORS, results may be returned with any number of Flows missing from the response. If the status is FAILED, Flows returned will be empty.

", - "StartFlowCaptureResponse$FlowOperationStatus": "

Returns the status of the flow operation. This string is returned in the responses to start, list, and describe commands.

If the status is COMPLETED_WITH_ERRORS, results may be returned with any number of Flows missing from the response. If the status is FAILED, Flows returned will be empty.

", - "StartFlowFlushResponse$FlowOperationStatus": "

Returns the status of the flow operation. This string is returned in the responses to start, list, and describe commands.

If the status is COMPLETED_WITH_ERRORS, results may be returned with any number of Flows missing from the response. If the status is FAILED, Flows returned will be empty.

" - } - }, - "FlowOperationType": { - "base": null, - "refs": { - "DescribeFlowOperationResponse$FlowOperationType": "

Defines the type of FlowOperation.

", - "FlowOperationMetadata$FlowOperationType": "

Defines the type of FlowOperation.

", - "ListFlowOperationsRequest$FlowOperationType": "

An optional string that defines whether any or all operation types are returned.

" - } - }, - "FlowOperations": { - "base": null, - "refs": { - "ListFlowOperationsResponse$FlowOperations": "

Flow operations let you manage the flows tracked in the flow table, also known as the firewall table.

A flow is network traffic that is monitored by a firewall, either by stateful or stateless rules. For traffic to be considered part of a flow, it must share Destination, DestinationPort, Direction, Protocol, Source, and SourcePort.

" - } - }, - "FlowRequestTimestamp": { - "base": null, - "refs": { - "DescribeFlowOperationResponse$FlowRequestTimestamp": "

A timestamp indicating when the Suricata engine identified flows impacted by an operation.

", - "FlowOperationMetadata$FlowRequestTimestamp": "

A timestamp indicating when the Suricata engine identified flows impacted by an operation.

", - "ListFlowOperationResultsResponse$FlowRequestTimestamp": "

A timestamp indicating when the Suricata engine identified flows impacted by an operation.

" - } - }, - "FlowTimeouts": { - "base": "

Describes the amount of time that can pass without any traffic sent through the firewall before the firewall determines that the connection is idle and Network Firewall removes the flow entry from its flow table. When you update this value, existing connections will be treated according to your stream exception policy configuration.

", - "refs": { - "StatefulEngineOptions$FlowTimeouts": "

Configures the amount of time that can pass without any traffic sent through the firewall before the firewall determines that the connection is idle.

" - } - }, - "Flows": { - "base": null, - "refs": { - "ListFlowOperationResultsResponse$Flows": "

Any number of arrays, where each array is a single flow identified in the scope of the operation. If multiple flows were in the scope of the operation, multiple Flows arrays are returned.

" - } - }, - "GeneratedRulesType": { - "base": null, - "refs": { - "RulesSourceList$GeneratedRulesType": "

Whether you want to apply allow, reject, alert, or drop behavior to the domains in your target list.

When logging is enabled and you choose Alert, traffic that matches the domain specifications generates an alert in the firewall's logs. Then, traffic either passes, is rejected, or drops based on other rules in the firewall policy.

" - } - }, - "GetAnalysisReportResultsRequest": { - "base": null, - "refs": {} - }, - "GetAnalysisReportResultsResponse": { - "base": null, - "refs": {} - }, - "HashMapKey": { - "base": null, - "refs": { - "LogDestinationMap$key": null - } - }, - "HashMapValue": { - "base": null, - "refs": { - "LogDestinationMap$value": null - } - }, - "Header": { - "base": "

The basic rule criteria for Network Firewall to use to inspect packet headers in stateful traffic flow inspection. Traffic flows that match the criteria are a match for the corresponding StatefulRule.

", - "refs": { - "StatefulRule$Header": "

The stateful inspection criteria for this rule, used to inspect traffic flows.

" - } - }, - "Hits": { - "base": "

Attempts made to a access domain.

", - "refs": { - "AnalysisTypeReportResult$Hits": "

The number of attempts made to access a observed domain.

" - } - }, - "IPAddressType": { - "base": null, - "refs": { - "AvailabilityZoneMetadata$IPAddressType": "

The IP address type of the Firewall subnet in the Availability Zone. You can't change the IP address type after you create the subnet.

", - "SubnetMapping$IPAddressType": "

The subnet's IP address type. You can't change the IP address type after you create the subnet.

" - } - }, - "IPSet": { - "base": "

A list of IP addresses and address ranges, in CIDR notation. This is part of a RuleVariables.

", - "refs": { - "IPSets$value": null - } - }, - "IPSetArn": { - "base": null, - "refs": { - "IPSetMetadataMap$key": null - } - }, - "IPSetMetadata": { - "base": "

General information about the IP set.

", - "refs": { - "IPSetMetadataMap$value": null - } - }, - "IPSetMetadataMap": { - "base": null, - "refs": { - "CIDRSummary$IPSetReferences": "

The list of the IP set references used by a firewall.

" - } - }, - "IPSetReference": { - "base": "

Configures one or more IP set references for a Suricata-compatible rule group. This is used in CreateRuleGroup or UpdateRuleGroup. An IP set reference is a rule variable that references resources that you create and manage in another Amazon Web Services service, such as an Amazon VPC prefix list. Network Firewall IP set references enable you to dynamically update the contents of your rules. When you create, update, or delete the resource you are referencing in your rule, Network Firewall automatically updates the rule's content with the changes. For more information about IP set references in Network Firewall, see Using IP set references in the Network Firewall Developer Guide.

Network Firewall currently supports Amazon VPC prefix lists and resource groups in IP set references.

", - "refs": { - "IPSetReferenceMap$value": null - } - }, - "IPSetReferenceMap": { - "base": null, - "refs": { - "ReferenceSets$IPSetReferences": "

The list of IP set references.

" - } - }, - "IPSetReferenceName": { - "base": null, - "refs": { - "IPSetReferenceMap$key": null - } - }, - "IPSets": { - "base": null, - "refs": { - "PolicyVariables$RuleVariables": "

The IPv4 or IPv6 addresses in CIDR notation to use for the Suricata HOME_NET variable. If your firewall uses an inspection VPC, you might want to override the HOME_NET variable with the CIDRs of your home networks. If you don't override HOME_NET with your own CIDRs, Network Firewall by default uses the CIDR of your inspection VPC.

", - "RuleVariables$IPSets": "

A list of IP addresses and address ranges, in CIDR notation.

" - } - }, - "IdentifiedType": { - "base": null, - "refs": { - "AnalysisResult$IdentifiedType": "

The types of rule configurations that Network Firewall analyzes your rule groups for. Network Firewall analyzes stateless rule groups for the following types of rule configurations:

  • STATELESS_RULE_FORWARDING_ASYMMETRICALLY

    Cause: One or more stateless rules with the action pass or forward are forwarding traffic asymmetrically. Specifically, the rule's set of source IP addresses or their associated port numbers, don't match the set of destination IP addresses or their associated port numbers.

    To mitigate: Make sure that there's an existing return path. For example, if the rule allows traffic from source 10.1.0.0/24 to destination 20.1.0.0/24, you should allow return traffic from source 20.1.0.0/24 to destination 10.1.0.0/24.

  • STATELESS_RULE_CONTAINS_TCP_FLAGS

    Cause: At least one stateless rule with the action pass orforward contains TCP flags that are inconsistent in the forward and return directions.

    To mitigate: Prevent asymmetric routing issues caused by TCP flags by following these actions:

    • Remove unnecessary TCP flag inspections from the rules.

    • If you need to inspect TCP flags, check that the rules correctly account for changes in TCP flags throughout the TCP connection cycle, for example SYN and ACK flags used in a 3-way TCP handshake.

" - } - }, - "InsertPosition": { - "base": null, - "refs": { - "CreateProxyRule$InsertPosition": "

Where to insert a proxy rule in a proxy rule group.

", - "ProxyRuleGroupAttachment$InsertPosition": "

Where to insert a proxy rule group in a proxy configuration.

", - "ProxyRuleGroupPriority$NewPosition": "

Where to move a proxy rule group in a proxy configuration.

", - "ProxyRulePriority$NewPosition": "

Where to move a proxy rule in a proxy rule group.

" - } - }, - "InsufficientCapacityException": { - "base": "

Amazon Web Services doesn't currently have enough available capacity to fulfill your request. Try your request later.

", - "refs": {} - }, - "InternalServerError": { - "base": "

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

", - "refs": {} - }, - "InvalidOperationException": { - "base": "

The operation failed because it's not valid. For example, you might have tried to delete a rule group or firewall policy that's in use.

", - "refs": {} - }, - "InvalidRequestException": { - "base": "

The operation failed because of a problem with your request. Examples include:

  • You specified an unsupported parameter name or value.

  • You tried to update a property with a value that isn't among the available types.

  • Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

", - "refs": {} - }, - "InvalidResourcePolicyException": { - "base": "

The policy statement failed validation.

", - "refs": {} - }, - "InvalidTokenException": { - "base": "

The token you provided is stale or isn't valid for the operation.

", - "refs": {} - }, - "KeyId": { - "base": null, - "refs": { - "EncryptionConfiguration$KeyId": "

The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.

" - } - }, - "Keyword": { - "base": null, - "refs": { - "RuleOption$Keyword": "

The keyword for the Suricata compatible rule option. You must include a sid (signature ID), and can optionally include other keywords. For information about Suricata compatible keywords, see Rule options in the Suricata documentation.

" - } - }, - "LastAccessed": { - "base": null, - "refs": { - "AnalysisTypeReportResult$LastAccessed": "

The date and time any domain was last accessed (within the last 30 day period).

" - } - }, - "LastUpdateTime": { - "base": null, - "refs": { - "DescribeRuleGroupMetadataResponse$LastModifiedTime": "

A timestamp indicating when the rule group was last modified.

", - "FirewallPolicyResponse$LastModifiedTime": "

The last time that the firewall policy was changed.

", - "RuleGroupResponse$LastModifiedTime": "

The last time that the rule group was changed.

", - "TLSInspectionConfigurationResponse$LastModifiedTime": "

The last time that the TLS inspection configuration was changed.

" - } - }, - "LimitExceededException": { - "base": "

Unable to perform the operation because doing so would violate a limit setting.

", - "refs": {} - }, - "ListAnalysisReportsRequest": { - "base": null, - "refs": {} - }, - "ListAnalysisReportsResponse": { - "base": null, - "refs": {} - }, - "ListContainerAssociationsRequest": { - "base": null, - "refs": {} - }, - "ListContainerAssociationsResponse": { - "base": null, - "refs": {} - }, - "ListFirewallPoliciesRequest": { - "base": null, - "refs": {} - }, - "ListFirewallPoliciesResponse": { - "base": null, - "refs": {} - }, - "ListFirewallsRequest": { - "base": null, - "refs": {} - }, - "ListFirewallsResponse": { - "base": null, - "refs": {} - }, - "ListFlowOperationResultsRequest": { - "base": null, - "refs": {} - }, - "ListFlowOperationResultsResponse": { - "base": null, - "refs": {} - }, - "ListFlowOperationsRequest": { - "base": null, - "refs": {} - }, - "ListFlowOperationsResponse": { - "base": null, - "refs": {} - }, - "ListProxiesRequest": { - "base": null, - "refs": {} - }, - "ListProxiesResponse": { - "base": null, - "refs": {} - }, - "ListProxyConfigurationsRequest": { - "base": null, - "refs": {} - }, - "ListProxyConfigurationsResponse": { - "base": null, - "refs": {} - }, - "ListProxyRuleGroupsRequest": { - "base": null, - "refs": {} - }, - "ListProxyRuleGroupsResponse": { - "base": null, - "refs": {} - }, - "ListRuleGroupsRequest": { - "base": null, - "refs": {} - }, - "ListRuleGroupsResponse": { - "base": null, - "refs": {} - }, - "ListTLSInspectionConfigurationsRequest": { - "base": null, - "refs": {} - }, - "ListTLSInspectionConfigurationsResponse": { - "base": null, - "refs": {} - }, - "ListTagsForResourceRequest": { - "base": null, - "refs": {} - }, - "ListTagsForResourceResponse": { - "base": null, - "refs": {} - }, - "ListVpcEndpointAssociationsRequest": { - "base": null, - "refs": {} - }, - "ListVpcEndpointAssociationsResponse": { - "base": null, - "refs": {} - }, - "ListenerProperties": { - "base": null, - "refs": { - "DescribeProxyResource$ListenerProperties": "

Listener properties for HTTP and HTTPS traffic.

", - "Proxy$ListenerProperties": "

Listener properties for HTTP and HTTPS traffic.

" - } - }, - "ListenerPropertiesRequest": { - "base": null, - "refs": { - "CreateProxyRequest$ListenerProperties": "

Listener properties for HTTP and HTTPS traffic.

", - "UpdateProxyRequest$ListenerPropertiesToAdd": "

Listener properties for HTTP and HTTPS traffic to add.

", - "UpdateProxyRequest$ListenerPropertiesToRemove": "

Listener properties for HTTP and HTTPS traffic to remove.

" - } - }, - "ListenerProperty": { - "base": "

Open port for taking HTTP or HTTPS traffic.

", - "refs": { - "ListenerProperties$member": null - } - }, - "ListenerPropertyRequest": { - "base": "

This data type is used specifically for the CreateProxy and UpdateProxy APIs.

Open port for taking HTTP or HTTPS traffic.

", - "refs": { - "ListenerPropertiesRequest$member": null - } - }, - "ListenerPropertyType": { - "base": null, - "refs": { - "ListenerProperty$Type": "

Selection of HTTP or HTTPS traffic.

", - "ListenerPropertyRequest$Type": "

Selection of HTTP or HTTPS traffic.

" - } - }, - "ListingName": { - "base": null, - "refs": { - "DescribeRuleGroupMetadataResponse$ListingName": "

The display name of the product listing for this rule group.

" - } - }, - "LogDestinationConfig": { - "base": "

Defines where Network Firewall sends logs for the firewall for one log type. This is used in LoggingConfiguration. You can send each type of log to an Amazon S3 bucket, a CloudWatch log group, or a Firehose delivery stream.

Network Firewall generates logs for stateful rule groups. You can save alert, flow, and TLS log types.

", - "refs": { - "LogDestinationConfigs$member": null - } - }, - "LogDestinationConfigs": { - "base": null, - "refs": { - "LoggingConfiguration$LogDestinationConfigs": "

Defines the logging destinations for the logs for a firewall. Network Firewall generates logs for stateful rule groups.

" - } - }, - "LogDestinationMap": { - "base": null, - "refs": { - "LogDestinationConfig$LogDestination": "

The named location for the logs, provided in a key:value mapping that is specific to the chosen destination type.

  • For an Amazon S3 bucket, provide the name of the bucket, with key bucketName, and optionally provide a prefix, with key prefix.

    The following example specifies an Amazon S3 bucket named DOC-EXAMPLE-BUCKET and the prefix alerts:

    \"LogDestination\": { \"bucketName\": \"DOC-EXAMPLE-BUCKET\", \"prefix\": \"alerts\" }

  • For a CloudWatch log group, provide the name of the CloudWatch log group, with key logGroup. The following example specifies a log group named alert-log-group:

    \"LogDestination\": { \"logGroup\": \"alert-log-group\" }

  • For a Firehose delivery stream, provide the name of the delivery stream, with key deliveryStream. The following example specifies a delivery stream named alert-delivery-stream:

    \"LogDestination\": { \"deliveryStream\": \"alert-delivery-stream\" }

" - } - }, - "LogDestinationPermissionException": { - "base": "

Unable to send logs to a configured logging destination.

", - "refs": {} - }, - "LogDestinationType": { - "base": null, - "refs": { - "LogDestinationConfig$LogDestinationType": "

The type of storage destination to send these logs to. You can send logs to an Amazon S3 bucket, a CloudWatch log group, or a Firehose delivery stream.

" - } - }, - "LogType": { - "base": null, - "refs": { - "LogDestinationConfig$LogType": "

The type of log to record. You can record the following types of logs from your Network Firewall stateful engine.

  • ALERT - Logs for traffic that matches your stateful rules and that have an action that sends an alert. A stateful rule sends alerts for the rule actions DROP, ALERT, and REJECT. For more information, see StatefulRule.

  • FLOW - Standard network traffic flow logs. The stateful rules engine records flow logs for all network traffic that it receives. Each flow log record captures the network flow for a specific standard stateless rule group.

  • TLS - Logs for events that are related to TLS inspection. For more information, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.

" - } - }, - "LoggingConfiguration": { - "base": "

Defines how Network Firewall performs logging for a Firewall.

", - "refs": { - "DescribeLoggingConfigurationResponse$LoggingConfiguration": null, - "UpdateLoggingConfigurationRequest$LoggingConfiguration": "

Defines how Network Firewall performs logging for a firewall. If you omit this setting, Network Firewall disables logging for the firewall.

", - "UpdateLoggingConfigurationResponse$LoggingConfiguration": null - } - }, - "MatchAttributes": { - "base": "

Criteria for Network Firewall to use to inspect an individual packet in stateless rule inspection. Each match attributes set can include one or more items such as IP address, CIDR range, port number, protocol, and TCP flags.

", - "refs": { - "RuleDefinition$MatchAttributes": "

Criteria for Network Firewall to use to inspect an individual packet in stateless rule inspection. Each match attributes set can include one or more items such as IP address, CIDR range, port number, protocol, and TCP flags.

" - } - }, - "NatGatewayId": { - "base": null, - "refs": { - "CreateProxyRequest$NatGatewayId": "

A unique identifier for the NAT gateway to use with proxy resources.

", - "DeleteProxyRequest$NatGatewayId": "

The NAT Gateway the proxy is attached to.

", - "DeleteProxyResponse$NatGatewayId": "

The NAT Gateway the Proxy was attached to.

", - "DescribeProxyResource$NatGatewayId": "

The NAT Gateway for the proxy.

", - "Proxy$NatGatewayId": "

The NAT Gateway for the proxy.

", - "UpdateProxyRequest$NatGatewayId": "

The NAT Gateway the proxy is attached to.

" - } - }, - "NatGatewayPort": { - "base": null, - "refs": { - "ListenerProperty$Port": "

Port for processing traffic.

", - "ListenerPropertyRequest$Port": "

Port for processing traffic.

" - } - }, - "NumberOfAssociations": { - "base": null, - "refs": { - "Firewall$NumberOfAssociations": "

The number of VpcEndpointAssociation resources that use this firewall.

", - "FirewallPolicyResponse$NumberOfAssociations": "

The number of firewalls that are associated with this firewall policy.

", - "RuleGroupResponse$NumberOfAssociations": "

The number of firewall policies that use this rule group.

", - "TLSInspectionConfigurationResponse$NumberOfAssociations": "

The number of firewall policies that use this TLS inspection configuration.

" - } - }, - "OverrideAction": { - "base": null, - "refs": { - "StatefulRuleGroupOverride$Action": "

The action that changes the rule group from DROP to ALERT. This only applies to managed rule groups.

" - } - }, - "PacketCount": { - "base": null, - "refs": { - "Flow$PacketCount": "

Returns the total number of data packets received or transmitted in a flow.

" - } - }, - "PaginationMaxResults": { - "base": null, - "refs": { - "GetAnalysisReportResultsRequest$MaxResults": "

The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

", - "ListAnalysisReportsRequest$MaxResults": "

The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

", - "ListContainerAssociationsRequest$MaxResults": "

The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

", - "ListFirewallPoliciesRequest$MaxResults": "

The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

", - "ListFirewallsRequest$MaxResults": "

The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

", - "ListFlowOperationResultsRequest$MaxResults": "

The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

", - "ListFlowOperationsRequest$MaxResults": "

The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

", - "ListProxiesRequest$MaxResults": "

The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

", - "ListProxyConfigurationsRequest$MaxResults": "

The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

", - "ListProxyRuleGroupsRequest$MaxResults": "

The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

", - "ListRuleGroupsRequest$MaxResults": "

The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

", - "ListTLSInspectionConfigurationsRequest$MaxResults": "

The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

", - "ListVpcEndpointAssociationsRequest$MaxResults": "

The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

" - } - }, - "PaginationToken": { - "base": null, - "refs": { - "ListAnalysisReportsRequest$NextToken": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

", - "ListAnalysisReportsResponse$NextToken": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

", - "ListContainerAssociationsRequest$NextToken": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

", - "ListContainerAssociationsResponse$NextToken": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

", - "ListFirewallPoliciesRequest$NextToken": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

", - "ListFirewallPoliciesResponse$NextToken": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

", - "ListFirewallsRequest$NextToken": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

", - "ListFirewallsResponse$NextToken": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

", - "ListFlowOperationResultsRequest$NextToken": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

", - "ListFlowOperationResultsResponse$NextToken": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

", - "ListFlowOperationsRequest$NextToken": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

", - "ListFlowOperationsResponse$NextToken": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

", - "ListProxiesRequest$NextToken": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

", - "ListProxiesResponse$NextToken": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

", - "ListProxyConfigurationsRequest$NextToken": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

", - "ListProxyConfigurationsResponse$NextToken": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

", - "ListProxyRuleGroupsRequest$NextToken": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

", - "ListProxyRuleGroupsResponse$NextToken": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

", - "ListRuleGroupsRequest$NextToken": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

", - "ListRuleGroupsResponse$NextToken": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

", - "ListTLSInspectionConfigurationsRequest$NextToken": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

", - "ListTLSInspectionConfigurationsResponse$NextToken": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

", - "ListTagsForResourceRequest$NextToken": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

", - "ListTagsForResourceResponse$NextToken": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

", - "ListVpcEndpointAssociationsRequest$NextToken": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

", - "ListVpcEndpointAssociationsResponse$NextToken": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" - } - }, - "PerObjectStatus": { - "base": "

Provides configuration status for a single policy or rule group that is used for a firewall endpoint. Network Firewall provides each endpoint with the rules that are configured in the firewall policy. Each time you add a subnet or modify the associated firewall policy, Network Firewall synchronizes the rules in the endpoint, so it can properly filter network traffic. This is part of a SyncState for a firewall.

", - "refs": { - "SyncStateConfig$value": null - } - }, - "PerObjectSyncStatus": { - "base": null, - "refs": { - "PerObjectStatus$SyncStatus": "

Indicates whether this object is in sync with the version indicated in the update token.

" - } - }, - "PolicyString": { - "base": null, - "refs": { - "DescribeResourcePolicyResponse$Policy": "

The IAM policy for the resource.

", - "PutResourcePolicyRequest$Policy": "

The IAM policy statement that lists the accounts that you want to share your Network Firewall resources with and the operations that you want the accounts to be able to perform.

For a rule group resource, you can specify the following operations in the Actions section of the statement:

  • network-firewall:CreateFirewallPolicy

  • network-firewall:UpdateFirewallPolicy

  • network-firewall:ListRuleGroups

For a firewall policy resource, you can specify the following operations in the Actions section of the statement:

  • network-firewall:AssociateFirewallPolicy

  • network-firewall:ListFirewallPolicies

For a firewall resource, you can specify the following operations in the Actions section of the statement:

  • network-firewall:CreateVpcEndpointAssociation

  • network-firewall:DescribeFirewallMetadata

  • network-firewall:ListFirewalls

In the Resource section of the statement, you specify the ARNs for the Network Firewall resources that you want to share with the account that you specified in Arn.

" - } - }, - "PolicyVariables": { - "base": "

Contains variables that you can use to override default Suricata settings in your firewall policy.

", - "refs": { - "FirewallPolicy$PolicyVariables": "

Contains variables that you can use to override default Suricata settings in your firewall policy.

" - } - }, - "Port": { - "base": null, - "refs": { - "Flow$SourcePort": "

The source port to inspect for. You can specify an individual port, for example 1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY.

", - "Flow$DestinationPort": "

The destination port to inspect for. You can specify an individual port, for example 1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY.

", - "FlowFilter$SourcePort": "

The source port to inspect for. You can specify an individual port, for example 1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY.

", - "FlowFilter$DestinationPort": "

The destination port to inspect for. You can specify an individual port, for example 1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY.

", - "Header$SourcePort": "

The source port to inspect for. You can specify an individual port, for example 1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY.

", - "Header$DestinationPort": "

The destination port to inspect for. You can specify an individual port, for example 1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY.

" - } - }, - "PortRange": { - "base": "

A single port range specification. This is used for source and destination port ranges in the stateless rule MatchAttributes, SourcePorts, and DestinationPorts settings.

", - "refs": { - "PortRanges$member": null - } - }, - "PortRangeBound": { - "base": null, - "refs": { - "PortRange$FromPort": "

The lower limit of the port range. This must be less than or equal to the ToPort specification.

", - "PortRange$ToPort": "

The upper limit of the port range. This must be greater than or equal to the FromPort specification.

" - } - }, - "PortRanges": { - "base": null, - "refs": { - "MatchAttributes$SourcePorts": "

The source port to inspect for. You can specify an individual port, for example 1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY.

If not specified, this matches with any source port.

This setting is only used for protocols 6 (TCP) and 17 (UDP).

", - "MatchAttributes$DestinationPorts": "

The destination port to inspect for. You can specify an individual port, for example 1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY.

This setting is only used for protocols 6 (TCP) and 17 (UDP).

", - "ServerCertificateScope$SourcePorts": "

The source ports to decrypt for inspection, in Transmission Control Protocol (TCP) format. If not specified, this matches with any source port.

You can specify individual ports, for example 1994, and you can specify port ranges, such as 1990:1994.

", - "ServerCertificateScope$DestinationPorts": "

The destination ports to decrypt for inspection, in Transmission Control Protocol (TCP) format. If not specified, this matches with any destination port.

You can specify individual ports, for example 1994, and you can specify port ranges, such as 1990:1994.

" - } - }, - "PortSet": { - "base": "

A set of port ranges for use in the rules in a rule group.

", - "refs": { - "PortSets$value": null - } - }, - "PortSets": { - "base": null, - "refs": { - "RuleVariables$PortSets": "

A list of port ranges.

" - } - }, - "Priority": { - "base": null, - "refs": { - "StatefulRuleGroupReference$Priority": "

An integer setting that indicates the order in which to run the stateful rule groups in a single FirewallPolicy. This setting only applies to firewall policies that specify the STRICT_ORDER rule order in the stateful engine options settings.

Network Firewall evalutes each stateful rule group against a packet starting with the group that has the lowest priority setting. You must ensure that the priority settings are unique within each policy.

You can change the priority settings of your rule groups at any time. To make it easier to insert rule groups later, number them so there's a wide range in between, for example use 100, 200, and so on.

", - "StatelessRule$Priority": "

Indicates the order in which to run this rule relative to all of the rules that are defined for a stateless rule group. Network Firewall evaluates the rules in a rule group starting with the lowest priority setting. You must ensure that the priority settings are unique for the rule group.

Each stateless rule group uses exactly one StatelessRulesAndCustomActions object, and each StatelessRulesAndCustomActions contains exactly one StatelessRules object. To ensure unique priority settings for your rule groups, set unique priorities for the stateless rules that you define inside any single StatelessRules object.

You can change the priority settings of your rules at any time. To make it easier to insert rules later, number them so there's a wide range in between, for example use 100, 200, and so on.

", - "StatelessRuleGroupReference$Priority": "

An integer setting that indicates the order in which to run the stateless rule groups in a single FirewallPolicy. Network Firewall applies each stateless rule group to a packet starting with the group that has the lowest priority setting. You must ensure that the priority settings are unique within each policy.

" - } - }, - "PrivateDNSName": { - "base": null, - "refs": { - "DescribeProxyResource$PrivateDNSName": "

The private DNS name of the Proxy.

" - } - }, - "ProductId": { - "base": null, - "refs": { - "DescribeRuleGroupMetadataResponse$ProductId": "

The unique identifier for the product listing associated with this rule group.

" - } - }, - "ProtocolNumber": { - "base": null, - "refs": { - "ProtocolNumbers$member": null - } - }, - "ProtocolNumbers": { - "base": null, - "refs": { - "MatchAttributes$Protocols": "

The protocols to inspect for, specified using the assigned internet protocol number (IANA) for each protocol. If not specified, this matches with any protocol.

", - "ServerCertificateScope$Protocols": "

The protocols to inspect for, specified using the assigned internet protocol number (IANA) for each protocol. If not specified, this matches with any protocol.

Network Firewall currently supports only TCP.

" - } - }, - "ProtocolString": { - "base": null, - "refs": { - "Flow$Protocol": "

The protocols to inspect for, specified using the assigned internet protocol number (IANA) for each protocol. If not specified, this matches with any protocol.

", - "ProtocolStrings$member": null - } - }, - "ProtocolStrings": { - "base": null, - "refs": { - "FlowFilter$Protocols": "

The protocols to inspect for, specified using the assigned internet protocol number (IANA) for each protocol. If not specified, this matches with any protocol.

" - } - }, - "Proxies": { - "base": null, - "refs": { - "ListProxiesResponse$Proxies": "

The metadata for the proxies. Depending on your setting for max results and the number of proxies that you have, this might not be the full list.

" - } - }, - "Proxy": { - "base": "

Proxy attached to a NAT gateway.

", - "refs": { - "CreateProxyResponse$Proxy": "

Proxy attached to a NAT gateway.

", - "UpdateProxyResponse$Proxy": "

The updated proxy resource that reflects the updates from the request.

" - } - }, - "ProxyConditionValue": { - "base": null, - "refs": { - "ProxyConditionValueList$member": null - } - }, - "ProxyConditionValueList": { - "base": null, - "refs": { - "ProxyRuleCondition$ConditionValues": "

Specifes the exact value that needs to be matched against.

" - } - }, - "ProxyConfigDefaultRulePhaseActionsRequest": { - "base": "

Evaluation points in the traffic flow where rules are applied. There are three phases in a traffic where the rule match is applied.

This data type is used specifically for the CreateProxyConfiguration and UpdateProxyConfiguration APIs.

", - "refs": { - "CreateProxyConfigurationRequest$DefaultRulePhaseActions": "

Evaluation points in the traffic flow where rules are applied. There are three phases in a traffic where the rule match is applied.

", - "ProxyConfiguration$DefaultRulePhaseActions": "

Evaluation points in the traffic flow where rules are applied. There are three phases in a traffic where the rule match is applied.

Pre-DNS - before domain resolution.

Pre-Request - after DNS, before request.

Post-Response - after receiving response.

", - "UpdateProxyConfigurationRequest$DefaultRulePhaseActions": "

Evaluation points in the traffic flow where rules are applied. There are three phases in a traffic where the rule match is applied.

" - } - }, - "ProxyConfigRuleGroup": { - "base": "

Proxy rule group contained within a proxy configuration.

", - "refs": { - "ProxyConfigRuleGroupSet$member": null - } - }, - "ProxyConfigRuleGroupPriority": { - "base": null, - "refs": { - "ProxyConfigRuleGroup$Priority": "

Priority of the proxy rule group in the proxy configuration.

" - } - }, - "ProxyConfigRuleGroupSet": { - "base": null, - "refs": { - "ProxyConfiguration$RuleGroups": "

Proxy rule groups within the proxy configuration.

" - } - }, - "ProxyConfigRuleGroupType": { - "base": null, - "refs": { - "ProxyConfigRuleGroup$Type": "

Proxy rule group type.

" - } - }, - "ProxyConfiguration": { - "base": "

A Proxy Configuration defines the monitoring and protection behavior for a Proxy. The details of the behavior are defined in the rule groups that you add to your configuration.

", - "refs": { - "AttachRuleGroupsToProxyConfigurationResponse$ProxyConfiguration": "

The updated proxy configuration resource that reflects the updates from the request.

", - "CreateProxyConfigurationResponse$ProxyConfiguration": "

The properties that define the proxy configuration.

", - "DescribeProxyConfigurationResponse$ProxyConfiguration": "

The configuration for the specified proxy configuration.

", - "DetachRuleGroupsFromProxyConfigurationResponse$ProxyConfiguration": "

The updated proxy configuration resource that reflects the updates from the request.

", - "UpdateProxyConfigurationResponse$ProxyConfiguration": "

The updated proxy configuration resource that reflects the updates from the request.

" - } - }, - "ProxyConfigurationMetadata": { - "base": "

High-level information about a proxy configuration, returned by operations like create and describe. You can use the information provided in the metadata to retrieve and manage a proxy configuration. You can retrieve all objects for a proxy configuration by calling DescribeProxyConfiguration.

", - "refs": { - "ProxyConfigurations$member": null - } - }, - "ProxyConfigurations": { - "base": null, - "refs": { - "ListProxyConfigurationsResponse$ProxyConfigurations": "

The metadata for the proxy configurations. Depending on your setting for max results and the number of proxy configurations that you have, this might not be the full list.

" - } - }, - "ProxyMetadata": { - "base": "

High-level information about a proxy, returned by operations like create and describe. You can use the information provided in the metadata to retrieve and manage a proxy. You can retrieve all objects for a proxy by calling DescribeProxy.

", - "refs": { - "Proxies$member": null - } - }, - "ProxyModifyState": { - "base": null, - "refs": { - "DescribeProxyResource$ProxyModifyState": "

Current modification status of the Proxy.

", - "Proxy$ProxyModifyState": "

Current modification status of the Proxy.

" - } - }, - "ProxyRule": { - "base": "

Individual rules that define match conditions and actions for application-layer traffic. Rules specify what to inspect (domains, headers, methods) and what action to take (allow, deny, alert).

", - "refs": { - "DescribeProxyRuleResponse$ProxyRule": "

The configuration for the specified proxy rule.

", - "ProxyRuleList$member": null, - "UpdateProxyRuleResponse$ProxyRule": "

The updated proxy rule resource that reflects the updates from the request.

" - } - }, - "ProxyRuleCondition": { - "base": "

Match criteria that specify what traffic attributes to examine.

", - "refs": { - "ProxyRuleConditionList$member": null - } - }, - "ProxyRuleConditionList": { - "base": null, - "refs": { - "CreateProxyRule$Conditions": "

Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.

", - "ProxyRule$Conditions": "

Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.

", - "UpdateProxyRuleRequest$AddConditions": "

Proxy rule conditions to add. Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.

", - "UpdateProxyRuleRequest$RemoveConditions": "

Proxy rule conditions to remove. Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.

", - "UpdateProxyRuleResponse$RemovedConditions": "

Proxy rule conditions removed from the rule.

" - } - }, - "ProxyRuleGroup": { - "base": "

Collections of related proxy filtering rules. Rule groups help you manage and reuse sets of rules across multiple proxy configurations.

", - "refs": { - "CreateProxyRuleGroupResponse$ProxyRuleGroup": "

The properties that define the proxy rule group.

", - "CreateProxyRulesResponse$ProxyRuleGroup": "

The properties that define the proxy rule group with the newly created proxy rule(s).

", - "DeleteProxyRulesResponse$ProxyRuleGroup": "

The properties that define the proxy rule group with the newly created proxy rule(s).

", - "DescribeProxyRuleGroupResponse$ProxyRuleGroup": "

The configuration for the specified proxy rule group.

" - } - }, - "ProxyRuleGroupAttachment": { - "base": "

The proxy rule group(s) to attach to the proxy configuration

", - "refs": { - "ProxyRuleGroupAttachmentList$member": null - } - }, - "ProxyRuleGroupAttachmentList": { - "base": null, - "refs": { - "AttachRuleGroupsToProxyConfigurationRequest$RuleGroups": "

The proxy rule group(s) to attach to the proxy configuration

" - } - }, - "ProxyRuleGroupMetadata": { - "base": "

High-level information about a proxy rule group, returned by operations like create and describe. You can use the information provided in the metadata to retrieve and manage a proxy rule group. You can retrieve all objects for a proxy rule group by calling DescribeProxyRuleGroup.

", - "refs": { - "ProxyRuleGroups$member": null - } - }, - "ProxyRuleGroupPriority": { - "base": "

Proxy rule group name and new desired position.

", - "refs": { - "ProxyRuleGroupPriorityList$member": null - } - }, - "ProxyRuleGroupPriorityList": { - "base": null, - "refs": { - "UpdateProxyRuleGroupPrioritiesRequest$RuleGroups": "

proxy rule group resources to update to new positions.

" - } - }, - "ProxyRuleGroupPriorityResult": { - "base": "

Proxy rule group along with its priority.

", - "refs": { - "ProxyRuleGroupPriorityResultList$member": null - } - }, - "ProxyRuleGroupPriorityResultList": { - "base": null, - "refs": { - "UpdateProxyRuleGroupPrioritiesResponse$ProxyRuleGroups": "

The updated proxy rule group hierarchy that reflects the updates from the request.

" - } - }, - "ProxyRuleGroupPriorityResultPriority": { - "base": null, - "refs": { - "ProxyRuleGroupPriorityResult$Priority": "

Priority of the proxy rule group in the proxy configuration.

" - } - }, - "ProxyRuleGroups": { - "base": null, - "refs": { - "ListProxyRuleGroupsResponse$ProxyRuleGroups": "

The metadata for the proxy rule groups. Depending on your setting for max results and the number of proxy rule groups that you have, this might not be the full list.

" - } - }, - "ProxyRuleList": { - "base": null, - "refs": { - "ProxyRulesByRequestPhase$PreDNS": "

Before domain resolution.

", - "ProxyRulesByRequestPhase$PreREQUEST": "

After DNS, before request.

", - "ProxyRulesByRequestPhase$PostRESPONSE": "

After receiving response.

" - } - }, - "ProxyRulePhaseAction": { - "base": null, - "refs": { - "CreateProxyRule$Action": "

Action to take.

", - "ProxyConfigDefaultRulePhaseActionsRequest$PreDNS": "

Before domain resolution.

", - "ProxyConfigDefaultRulePhaseActionsRequest$PreREQUEST": "

After DNS, before request.

", - "ProxyConfigDefaultRulePhaseActionsRequest$PostRESPONSE": "

After receiving response.

", - "ProxyRule$Action": "

Action to take.

", - "UpdateProxyRuleRequest$Action": "

Depending on the match action, the proxy either stops the evaluation (if the action is terminal - allow or deny), or continues it (if the action is alert) until it matches a rule with a terminal action.

" - } - }, - "ProxyRulePriority": { - "base": "

Proxy rule name and new desired position.

", - "refs": { - "ProxyRulePriorityList$member": null - } - }, - "ProxyRulePriorityList": { - "base": null, - "refs": { - "UpdateProxyRulePrioritiesRequest$Rules": "

proxy rule resources to update to new positions.

", - "UpdateProxyRulePrioritiesResponse$Rules": "

The updated proxy rule hierarchy that reflects the updates from the request.

" - } - }, - "ProxyRulesByRequestPhase": { - "base": "

Evaluation points in the traffic flow where rules are applied. There are three phases in a traffic where the rule match is applied.

", - "refs": { - "CreateProxyRuleGroupRequest$Rules": "

Individual rules that define match conditions and actions for application-layer traffic. Rules specify what to inspect (domains, headers, methods) and what action to take (allow, deny, alert).

", - "ProxyRuleGroup$Rules": "

Individual rules that define match conditions and actions for application-layer traffic. Rules specify what to inspect (domains, headers, methods) and what action to take (allow, deny, alert).

" - } - }, - "ProxyState": { - "base": null, - "refs": { - "DescribeProxyResource$ProxyState": "

Current attachment/detachment status of the Proxy.

", - "Proxy$ProxyState": "

Current attachment/detachment status of the Proxy.

" - } - }, - "PublishMetricAction": { - "base": "

Stateless inspection criteria that publishes the specified metrics to Amazon CloudWatch for the matching packet. This setting defines a CloudWatch dimension value to be published.

", - "refs": { - "ActionDefinition$PublishMetricAction": "

Stateless inspection criteria that publishes the specified metrics to Amazon CloudWatch for the matching packet. This setting defines a CloudWatch dimension value to be published.

You can pair this custom action with any of the standard stateless rule actions. For example, you could pair this in a rule action with the standard action that forwards the packet for stateful inspection. Then, when a packet matches the rule, Network Firewall publishes metrics for the packet and forwards it.

" - } - }, - "PutResourcePolicyRequest": { - "base": null, - "refs": {} - }, - "PutResourcePolicyResponse": { - "base": null, - "refs": {} - }, - "ReferenceSets": { - "base": "

Contains a set of IP set references.

", - "refs": { - "RuleGroup$ReferenceSets": "

The list of a rule group's reference sets.

" - } - }, - "RejectNetworkFirewallTransitGatewayAttachmentRequest": { - "base": null, - "refs": {} - }, - "RejectNetworkFirewallTransitGatewayAttachmentResponse": { - "base": null, - "refs": {} - }, - "ReportTime": { - "base": null, - "refs": { - "AnalysisReport$ReportTime": "

The date and time the analysis report was ran.

", - "GetAnalysisReportResultsResponse$ReportTime": "

The date and time the analysis report was ran.

" - } - }, - "ResourceArn": { - "base": null, - "refs": { - "AssociateAvailabilityZonesRequest$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

", - "AssociateAvailabilityZonesResponse$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

", - "AssociateFirewallPolicyRequest$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

", - "AssociateFirewallPolicyRequest$FirewallPolicyArn": "

The Amazon Resource Name (ARN) of the firewall policy.

", - "AssociateFirewallPolicyResponse$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

", - "AssociateFirewallPolicyResponse$FirewallPolicyArn": "

The Amazon Resource Name (ARN) of the firewall policy.

", - "AssociateSubnetsRequest$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

", - "AssociateSubnetsResponse$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

", - "AttachRuleGroupsToProxyConfigurationRequest$ProxyConfigurationArn": "

The Amazon Resource Name (ARN) of a proxy configuration.

You must specify the ARN or the name, and you can specify both.

", - "ContainerAssociationSummary$Arn": "

The Amazon Resource Name (ARN) of the container association.

", - "ContainerMonitoringConfiguration$ClusterArn": "

The Amazon Resource Name (ARN) of the container cluster to monitor.

", - "CreateContainerAssociationResponse$ContainerAssociationArn": "

The Amazon Resource Name (ARN) of the container association.

", - "CreateFirewallRequest$FirewallPolicyArn": "

The Amazon Resource Name (ARN) of the FirewallPolicy that you want to use for the firewall.

", - "CreateProxyRequest$ProxyConfigurationArn": "

The Amazon Resource Name (ARN) of a proxy configuration.

You must specify the ARN or the name, and you can specify both.

", - "CreateProxyRulesRequest$ProxyRuleGroupArn": "

The Amazon Resource Name (ARN) of a proxy rule group.

You must specify the ARN or the name, and you can specify both.

", - "CreateVpcEndpointAssociationRequest$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

", - "DeleteContainerAssociationRequest$ContainerAssociationArn": "

The Amazon Resource Name (ARN) of the container association. You must specify the ARN or the name, and you can specify both.

", - "DeleteContainerAssociationResponse$ContainerAssociationArn": "

The Amazon Resource Name (ARN) of the container association.

", - "DeleteFirewallPolicyRequest$FirewallPolicyArn": "

The Amazon Resource Name (ARN) of the firewall policy.

You must specify the ARN or the name, and you can specify both.

", - "DeleteFirewallRequest$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

", - "DeleteProxyConfigurationRequest$ProxyConfigurationArn": "

The Amazon Resource Name (ARN) of a proxy configuration.

You must specify the ARN or the name, and you can specify both.

", - "DeleteProxyConfigurationResponse$ProxyConfigurationArn": "

The Amazon Resource Name (ARN) of a proxy configuration.

", - "DeleteProxyRequest$ProxyArn": "

The Amazon Resource Name (ARN) of a proxy.

You must specify the ARN or the name, and you can specify both.

", - "DeleteProxyResponse$ProxyArn": "

The Amazon Resource Name (ARN) of a proxy.

", - "DeleteProxyRuleGroupRequest$ProxyRuleGroupArn": "

The Amazon Resource Name (ARN) of a proxy rule group.

You must specify the ARN or the name, and you can specify both.

", - "DeleteProxyRuleGroupResponse$ProxyRuleGroupArn": "

The Amazon Resource Name (ARN) of a proxy rule group.

", - "DeleteProxyRulesRequest$ProxyRuleGroupArn": "

The Amazon Resource Name (ARN) of a proxy rule group.

You must specify the ARN or the name, and you can specify both.

", - "DeleteResourcePolicyRequest$ResourceArn": "

The Amazon Resource Name (ARN) of the rule group or firewall policy whose resource policy you want to delete.

", - "DeleteRuleGroupRequest$RuleGroupArn": "

The Amazon Resource Name (ARN) of the rule group.

You must specify the ARN or the name, and you can specify both.

", - "DeleteTLSInspectionConfigurationRequest$TLSInspectionConfigurationArn": "

The Amazon Resource Name (ARN) of the TLS inspection configuration.

You must specify the ARN or the name, and you can specify both.

", - "DeleteVpcEndpointAssociationRequest$VpcEndpointAssociationArn": "

The Amazon Resource Name (ARN) of a VPC endpoint association.

", - "DescribeContainerAssociationRequest$ContainerAssociationArn": "

The Amazon Resource Name (ARN) of the container association. You must specify the ARN or the name, and you can specify both.

", - "DescribeContainerAssociationResponse$ContainerAssociationArn": "

The Amazon Resource Name (ARN) of the container association.

", - "DescribeFirewallMetadataRequest$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

", - "DescribeFirewallMetadataResponse$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

", - "DescribeFirewallMetadataResponse$FirewallPolicyArn": "

The Amazon Resource Name (ARN) of the firewall policy.

", - "DescribeFirewallPolicyRequest$FirewallPolicyArn": "

The Amazon Resource Name (ARN) of the firewall policy.

You must specify the ARN or the name, and you can specify both.

", - "DescribeFirewallRequest$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

", - "DescribeFlowOperationRequest$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

", - "DescribeFlowOperationRequest$VpcEndpointAssociationArn": "

The Amazon Resource Name (ARN) of a VPC endpoint association.

", - "DescribeFlowOperationResponse$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

", - "DescribeFlowOperationResponse$VpcEndpointAssociationArn": "

The Amazon Resource Name (ARN) of a VPC endpoint association.

", - "DescribeLoggingConfigurationRequest$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

", - "DescribeLoggingConfigurationResponse$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

", - "DescribeProxyConfigurationRequest$ProxyConfigurationArn": "

The Amazon Resource Name (ARN) of a proxy configuration.

You must specify the ARN or the name, and you can specify both.

", - "DescribeProxyRequest$ProxyArn": "

The Amazon Resource Name (ARN) of a proxy.

You must specify the ARN or the name, and you can specify both.

", - "DescribeProxyResource$ProxyArn": "

The Amazon Resource Name (ARN) of a proxy.

", - "DescribeProxyResource$ProxyConfigurationArn": "

The Amazon Resource Name (ARN) of a proxy configuration.

", - "DescribeProxyRuleGroupRequest$ProxyRuleGroupArn": "

The Amazon Resource Name (ARN) of a proxy rule group.

You must specify the ARN or the name, and you can specify both.

", - "DescribeProxyRuleRequest$ProxyRuleGroupArn": "

The Amazon Resource Name (ARN) of a proxy rule group.

You must specify the ARN or the name, and you can specify both.

", - "DescribeResourcePolicyRequest$ResourceArn": "

The Amazon Resource Name (ARN) of the rule group or firewall policy whose resource policy you want to retrieve.

", - "DescribeRuleGroupMetadataRequest$RuleGroupArn": "

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

You must specify the ARN or the name, and you can specify both.

", - "DescribeRuleGroupMetadataResponse$RuleGroupArn": "

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

You must specify the ARN or the name, and you can specify both.

", - "DescribeRuleGroupRequest$RuleGroupArn": "

The Amazon Resource Name (ARN) of the rule group.

You must specify the ARN or the name, and you can specify both.

", - "DescribeRuleGroupSummaryRequest$RuleGroupArn": "

Required. The Amazon Resource Name (ARN) of the rule group.

You must specify the ARN or the name, and you can specify both.

", - "DescribeTLSInspectionConfigurationRequest$TLSInspectionConfigurationArn": "

The Amazon Resource Name (ARN) of the TLS inspection configuration.

You must specify the ARN or the name, and you can specify both.

", - "DescribeVpcEndpointAssociationRequest$VpcEndpointAssociationArn": "

The Amazon Resource Name (ARN) of a VPC endpoint association.

", - "DetachRuleGroupsFromProxyConfigurationRequest$ProxyConfigurationArn": "

The Amazon Resource Name (ARN) of a proxy configuration.

You must specify the ARN or the name, and you can specify both.

", - "DisassociateAvailabilityZonesRequest$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

", - "DisassociateAvailabilityZonesResponse$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

", - "DisassociateSubnetsRequest$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

", - "DisassociateSubnetsResponse$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

", - "Firewall$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

", - "Firewall$FirewallPolicyArn": "

The Amazon Resource Name (ARN) of the firewall policy.

The relationship of firewall to firewall policy is many to one. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.

", - "FirewallMetadata$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

", - "FirewallPolicy$TLSInspectionConfigurationArn": "

The Amazon Resource Name (ARN) of the TLS inspection configuration.

", - "FirewallPolicyMetadata$Arn": "

The Amazon Resource Name (ARN) of the firewall policy.

", - "FirewallPolicyResponse$FirewallPolicyArn": "

The Amazon Resource Name (ARN) of the firewall policy.

If this response is for a create request that had DryRun set to TRUE, then this ARN is a placeholder that isn't attached to a valid resource.

", - "GetAnalysisReportResultsRequest$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

", - "IPSetReference$ReferenceArn": "

The Amazon Resource Name (ARN) of the resource that you are referencing in your rule group.

", - "ListAnalysisReportsRequest$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

", - "ListFlowOperationResultsRequest$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

", - "ListFlowOperationResultsRequest$VpcEndpointAssociationArn": "

The Amazon Resource Name (ARN) of a VPC endpoint association.

", - "ListFlowOperationResultsResponse$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

", - "ListFlowOperationResultsResponse$VpcEndpointAssociationArn": "

", - "ListFlowOperationsRequest$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

", - "ListFlowOperationsRequest$VpcEndpointAssociationArn": "

The Amazon Resource Name (ARN) of a VPC endpoint association.

", - "ListTagsForResourceRequest$ResourceArn": "

The Amazon Resource Name (ARN) of the resource.

", - "ListVpcEndpointAssociationsRequest$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

If you don't specify this, Network Firewall retrieves all VPC endpoint associations that you have defined.

", - "Proxy$ProxyConfigurationArn": "

The Amazon Resource Name (ARN) of a proxy configuration.

", - "Proxy$ProxyArn": "

The Amazon Resource Name (ARN) of a proxy.

", - "ProxyConfigRuleGroup$ProxyRuleGroupArn": "

The Amazon Resource Name (ARN) of a proxy rule group.

", - "ProxyConfiguration$ProxyConfigurationArn": "

The Amazon Resource Name (ARN) of a proxy configuration.

", - "ProxyConfigurationMetadata$Arn": "

The Amazon Resource Name (ARN) of a proxy configuration.

", - "ProxyMetadata$Arn": "

The Amazon Resource Name (ARN) of a proxy.

", - "ProxyRuleGroup$ProxyRuleGroupArn": "

The Amazon Resource Name (ARN) of a proxy rule group.

", - "ProxyRuleGroupMetadata$Arn": "

The Amazon Resource Name (ARN) of a proxy rule group.

", - "PutResourcePolicyRequest$ResourceArn": "

The Amazon Resource Name (ARN) of the account that you want to share your Network Firewall resources with.

", - "ResourceArnList$member": null, - "RuleGroupMetadata$Arn": "

The Amazon Resource Name (ARN) of the rule group.

", - "RuleGroupResponse$RuleGroupArn": "

The Amazon Resource Name (ARN) of the rule group.

If this response is for a create request that had DryRun set to TRUE, then this ARN is a placeholder that isn't attached to a valid resource.

", - "RuleGroupResponse$SnsTopic": "

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service SNS topic that's used to record changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the Amazon Simple Notification Service Developer Guide..

", - "ServerCertificate$ResourceArn": "

The Amazon Resource Name (ARN) of the Certificate Manager SSL/TLS server certificate that's used for inbound SSL/TLS inspection.

", - "ServerCertificateConfiguration$CertificateAuthorityArn": "

The Amazon Resource Name (ARN) of the imported certificate authority (CA) certificate within Certificate Manager (ACM) to use for outbound SSL/TLS inspection.

The following limitations apply:

  • You can use CA certificates that you imported into ACM, but you can't generate CA certificates with ACM.

  • You can't use certificates issued by Private Certificate Authority.

For more information about configuring certificates for outbound inspection, see Using SSL/TLS certificates with TLS inspection configurations in the Network Firewall Developer Guide.

For information about working with certificates in ACM, see Importing certificates in the Certificate Manager User Guide.

", - "SourceMetadata$SourceArn": "

The Amazon Resource Name (ARN) of the rule group that your own rule group is copied from.

", - "StartAnalysisReportRequest$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

", - "StartFlowCaptureRequest$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

", - "StartFlowCaptureRequest$VpcEndpointAssociationArn": "

The Amazon Resource Name (ARN) of a VPC endpoint association.

", - "StartFlowCaptureResponse$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

", - "StartFlowFlushRequest$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

", - "StartFlowFlushRequest$VpcEndpointAssociationArn": "

The Amazon Resource Name (ARN) of a VPC endpoint association.

", - "StartFlowFlushResponse$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

", - "StatefulRuleGroupReference$ResourceArn": "

The Amazon Resource Name (ARN) of the stateful rule group.

", - "StatelessRuleGroupReference$ResourceArn": "

The Amazon Resource Name (ARN) of the stateless rule group.

", - "TLSInspectionConfigurationMetadata$Arn": "

The Amazon Resource Name (ARN) of the TLS inspection configuration.

", - "TLSInspectionConfigurationResponse$TLSInspectionConfigurationArn": "

The Amazon Resource Name (ARN) of the TLS inspection configuration.

", - "TagResourceRequest$ResourceArn": "

The Amazon Resource Name (ARN) of the resource.

", - "TlsCertificateData$CertificateArn": "

The Amazon Resource Name (ARN) of the certificate.

", - "TlsInterceptProperties$PcaArn": "

Private Certificate Authority (PCA) used to issue private TLS certificates so that the proxy can present PCA-signed certificates which applications trust through the same root, establishing a secure and consistent trust model for encrypted communication.

", - "TlsInterceptPropertiesRequest$PcaArn": "

Private Certificate Authority (PCA) used to issue private TLS certificates so that the proxy can present PCA-signed certificates which applications trust through the same root, establishing a secure and consistent trust model for encrypted communication.

", - "UntagResourceRequest$ResourceArn": "

The Amazon Resource Name (ARN) of the resource.

", - "UpdateAvailabilityZoneChangeProtectionRequest$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

", - "UpdateAvailabilityZoneChangeProtectionResponse$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

", - "UpdateContainerAssociationRequest$ContainerAssociationArn": "

The Amazon Resource Name (ARN) of the container association. You must specify the ARN or the name, and you can specify both.

", - "UpdateContainerAssociationResponse$ContainerAssociationArn": "

The Amazon Resource Name (ARN) of the container association.

", - "UpdateFirewallAnalysisSettingsRequest$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

", - "UpdateFirewallAnalysisSettingsResponse$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

", - "UpdateFirewallDeleteProtectionRequest$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

", - "UpdateFirewallDeleteProtectionResponse$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

", - "UpdateFirewallDescriptionRequest$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

", - "UpdateFirewallDescriptionResponse$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

", - "UpdateFirewallEncryptionConfigurationRequest$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

", - "UpdateFirewallEncryptionConfigurationResponse$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

", - "UpdateFirewallPolicyChangeProtectionRequest$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

", - "UpdateFirewallPolicyChangeProtectionResponse$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

", - "UpdateFirewallPolicyRequest$FirewallPolicyArn": "

The Amazon Resource Name (ARN) of the firewall policy.

You must specify the ARN or the name, and you can specify both.

", - "UpdateLoggingConfigurationRequest$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

", - "UpdateLoggingConfigurationResponse$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

", - "UpdateProxyConfigurationRequest$ProxyConfigurationArn": "

The Amazon Resource Name (ARN) of a proxy configuration.

You must specify the ARN or the name, and you can specify both.

", - "UpdateProxyRequest$ProxyArn": "

The Amazon Resource Name (ARN) of a proxy.

You must specify the ARN or the name, and you can specify both.

", - "UpdateProxyRuleGroupPrioritiesRequest$ProxyConfigurationArn": "

The Amazon Resource Name (ARN) of a proxy configuration.

You must specify the ARN or the name, and you can specify both.

", - "UpdateProxyRulePrioritiesRequest$ProxyRuleGroupArn": "

The Amazon Resource Name (ARN) of a proxy rule group.

You must specify the ARN or the name, and you can specify both.

", - "UpdateProxyRulePrioritiesResponse$ProxyRuleGroupArn": "

The Amazon Resource Name (ARN) of a proxy rule group.

", - "UpdateProxyRuleRequest$ProxyRuleGroupArn": "

The Amazon Resource Name (ARN) of a proxy rule group.

You must specify the ARN or the name, and you can specify both.

", - "UpdateRuleGroupRequest$RuleGroupArn": "

The Amazon Resource Name (ARN) of the rule group.

You must specify the ARN or the name, and you can specify both.

", - "UpdateSubnetChangeProtectionRequest$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

", - "UpdateSubnetChangeProtectionResponse$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

", - "UpdateTLSInspectionConfigurationRequest$TLSInspectionConfigurationArn": "

The Amazon Resource Name (ARN) of the TLS inspection configuration.

", - "VpcEndpointAssociation$VpcEndpointAssociationArn": "

The Amazon Resource Name (ARN) of a VPC endpoint association.

", - "VpcEndpointAssociation$FirewallArn": "

The Amazon Resource Name (ARN) of the firewall.

", - "VpcEndpointAssociationMetadata$VpcEndpointAssociationArn": "

The Amazon Resource Name (ARN) of a VPC endpoint association.

" - } - }, - "ResourceArnList": { - "base": null, - "refs": { - "CreateProxyConfigurationRequest$RuleGroupArns": "

The proxy rule group arn(s) to attach to the proxy configuration.

You must specify the ARNs or the names, and you can specify both.

", - "DetachRuleGroupsFromProxyConfigurationRequest$RuleGroupArns": "

The proxy rule group arns to detach from the proxy configuration

" - } - }, - "ResourceId": { - "base": null, - "refs": { - "Firewall$FirewallId": "

The unique identifier for the firewall.

", - "FirewallPolicyResponse$FirewallPolicyId": "

The unique identifier for the firewall policy.

", - "RuleGroupResponse$RuleGroupId": "

The unique identifier for the rule group.

", - "TLSInspectionConfigurationResponse$TLSInspectionConfigurationId": "

A unique identifier for the TLS inspection configuration. This ID is returned in the responses to create and list commands. You provide it to operations such as update and delete.

", - "VpcEndpointAssociation$VpcEndpointAssociationId": "

The unique identifier of the VPC endpoint association.

" - } - }, - "ResourceManagedStatus": { - "base": null, - "refs": { - "ListRuleGroupsRequest$Scope": "

The scope of the request. The default setting of ACCOUNT or a setting of NULL returns all of the rule groups in your account. A setting of MANAGED returns all available managed rule groups.

" - } - }, - "ResourceManagedType": { - "base": null, - "refs": { - "ListRuleGroupsRequest$ManagedType": "

Indicates the general category of the Amazon Web Services managed rule group.

" - } - }, - "ResourceName": { - "base": null, - "refs": { - "AssociateAvailabilityZonesRequest$FirewallName": "

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

", - "AssociateAvailabilityZonesResponse$FirewallName": "

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

", - "AssociateFirewallPolicyRequest$FirewallName": "

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

", - "AssociateFirewallPolicyResponse$FirewallName": "

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

", - "AssociateSubnetsRequest$FirewallName": "

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

", - "AssociateSubnetsResponse$FirewallName": "

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

", - "AttachRuleGroupsToProxyConfigurationRequest$ProxyConfigurationName": "

The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.

You must specify the ARN or the name, and you can specify both.

", - "ContainerAssociationSummary$Name": "

The descriptive name of the container association.

", - "CreateContainerAssociationRequest$ContainerAssociationName": "

The descriptive name of the container association. You can't change the name of a container association after you create it.

", - "CreateContainerAssociationResponse$ContainerAssociationName": "

The descriptive name of the container association.

", - "CreateFirewallPolicyRequest$FirewallPolicyName": "

The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.

", - "CreateFirewallRequest$FirewallName": "

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

", - "CreateProxyConfigurationRequest$ProxyConfigurationName": "

The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.

", - "CreateProxyRequest$ProxyName": "

The descriptive name of the proxy. You can't change the name of a proxy after you create it.

", - "CreateProxyRequest$ProxyConfigurationName": "

The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.

You must specify the ARN or the name, and you can specify both.

", - "CreateProxyRule$ProxyRuleName": "

The descriptive name of the proxy rule. You can't change the name of a proxy rule after you create it.

", - "CreateProxyRuleGroupRequest$ProxyRuleGroupName": "

The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.

", - "CreateProxyRulesRequest$ProxyRuleGroupName": "

The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.

You must specify the ARN or the name, and you can specify both.

", - "CreateRuleGroupRequest$RuleGroupName": "

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

", - "CreateTLSInspectionConfigurationRequest$TLSInspectionConfigurationName": "

The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.

", - "DeleteContainerAssociationRequest$ContainerAssociationName": "

The descriptive name of the container association. You must specify the ARN or the name, and you can specify both.

", - "DeleteContainerAssociationResponse$ContainerAssociationName": "

The descriptive name of the container association.

", - "DeleteFirewallPolicyRequest$FirewallPolicyName": "

The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.

You must specify the ARN or the name, and you can specify both.

", - "DeleteFirewallRequest$FirewallName": "

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

", - "DeleteProxyConfigurationRequest$ProxyConfigurationName": "

The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.

You must specify the ARN or the name, and you can specify both.

", - "DeleteProxyConfigurationResponse$ProxyConfigurationName": "

The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.

", - "DeleteProxyRequest$ProxyName": "

The descriptive name of the proxy. You can't change the name of a proxy after you create it.

You must specify the ARN or the name, and you can specify both.

", - "DeleteProxyResponse$ProxyName": "

The descriptive name of the proxy. You can't change the name of a proxy after you create it.

", - "DeleteProxyRuleGroupRequest$ProxyRuleGroupName": "

The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.

You must specify the ARN or the name, and you can specify both.

", - "DeleteProxyRuleGroupResponse$ProxyRuleGroupName": "

The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.

", - "DeleteProxyRulesRequest$ProxyRuleGroupName": "

The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.

You must specify the ARN or the name, and you can specify both.

", - "DeleteRuleGroupRequest$RuleGroupName": "

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

You must specify the ARN or the name, and you can specify both.

", - "DeleteTLSInspectionConfigurationRequest$TLSInspectionConfigurationName": "

The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.

You must specify the ARN or the name, and you can specify both.

", - "DescribeContainerAssociationRequest$ContainerAssociationName": "

The descriptive name of the container association. You must specify the ARN or the name, and you can specify both.

", - "DescribeContainerAssociationResponse$ContainerAssociationName": "

The descriptive name of the container association.

", - "DescribeFirewallPolicyRequest$FirewallPolicyName": "

The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.

You must specify the ARN or the name, and you can specify both.

", - "DescribeFirewallRequest$FirewallName": "

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

", - "DescribeLoggingConfigurationRequest$FirewallName": "

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

", - "DescribeProxyConfigurationRequest$ProxyConfigurationName": "

The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.

You must specify the ARN or the name, and you can specify both.

", - "DescribeProxyRequest$ProxyName": "

The descriptive name of the proxy. You can't change the name of a proxy after you create it.

You must specify the ARN or the name, and you can specify both.

", - "DescribeProxyResource$ProxyName": "

The descriptive name of the proxy. You can't change the name of a proxy after you create it.

", - "DescribeProxyResource$ProxyConfigurationName": "

The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.

", - "DescribeProxyRuleGroupRequest$ProxyRuleGroupName": "

The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.

You must specify the ARN or the name, and you can specify both.

", - "DescribeProxyRuleRequest$ProxyRuleName": "

The descriptive name of the proxy rule. You can't change the name of a proxy rule after you create it.

", - "DescribeProxyRuleRequest$ProxyRuleGroupName": "

The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.

You must specify the ARN or the name, and you can specify both.

", - "DescribeRuleGroupMetadataRequest$RuleGroupName": "

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

You must specify the ARN or the name, and you can specify both.

", - "DescribeRuleGroupMetadataResponse$RuleGroupName": "

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

You must specify the ARN or the name, and you can specify both.

", - "DescribeRuleGroupRequest$RuleGroupName": "

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

You must specify the ARN or the name, and you can specify both.

", - "DescribeRuleGroupSummaryRequest$RuleGroupName": "

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

You must specify the ARN or the name, and you can specify both.

", - "DescribeRuleGroupSummaryResponse$RuleGroupName": "

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

", - "DescribeTLSInspectionConfigurationRequest$TLSInspectionConfigurationName": "

The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.

You must specify the ARN or the name, and you can specify both.

", - "DetachRuleGroupsFromProxyConfigurationRequest$ProxyConfigurationName": "

The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.

You must specify the ARN or the name, and you can specify both.

", - "DisassociateAvailabilityZonesRequest$FirewallName": "

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

", - "DisassociateAvailabilityZonesResponse$FirewallName": "

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

", - "DisassociateSubnetsRequest$FirewallName": "

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

", - "DisassociateSubnetsResponse$FirewallName": "

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

", - "Firewall$FirewallName": "

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

", - "FirewallMetadata$FirewallName": "

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

", - "FirewallPolicyMetadata$Name": "

The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.

", - "FirewallPolicyResponse$FirewallPolicyName": "

The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.

", - "GetAnalysisReportResultsRequest$FirewallName": "

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

", - "ListAnalysisReportsRequest$FirewallName": "

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

", - "Proxy$ProxyConfigurationName": "

The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.

", - "Proxy$ProxyName": "

The descriptive name of the proxy. You can't change the name of a proxy after you create it.

", - "ProxyConfigRuleGroup$ProxyRuleGroupName": "

The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.

", - "ProxyConfiguration$ProxyConfigurationName": "

The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.

", - "ProxyConfigurationMetadata$Name": "

The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.

", - "ProxyMetadata$Name": "

The descriptive name of the proxy. You can't change the name of a proxy after you create it.

", - "ProxyRule$ProxyRuleName": "

The descriptive name of the proxy rule. You can't change the name of a proxy rule after you create it.

", - "ProxyRuleGroup$ProxyRuleGroupName": "

The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.

", - "ProxyRuleGroupAttachment$ProxyRuleGroupName": "

The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.

", - "ProxyRuleGroupMetadata$Name": "

The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.

", - "ProxyRuleGroupPriority$ProxyRuleGroupName": "

The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.

", - "ProxyRuleGroupPriorityResult$ProxyRuleGroupName": "

The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.

", - "ProxyRulePriority$ProxyRuleName": "

The descriptive name of the proxy rule. You can't change the name of a proxy rule after you create it.

", - "ResourceNameList$member": null, - "RuleGroupMetadata$Name": "

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

", - "RuleGroupResponse$RuleGroupName": "

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

", - "StartAnalysisReportRequest$FirewallName": "

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

", - "SyncStateConfig$key": null, - "TLSInspectionConfigurationMetadata$Name": "

The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.

", - "TLSInspectionConfigurationResponse$TLSInspectionConfigurationName": "

The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.

", - "UpdateAvailabilityZoneChangeProtectionRequest$FirewallName": "

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

", - "UpdateAvailabilityZoneChangeProtectionResponse$FirewallName": "

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

", - "UpdateContainerAssociationRequest$ContainerAssociationName": "

The descriptive name of the container association. You must specify the ARN or the name, and you can specify both.

", - "UpdateContainerAssociationResponse$ContainerAssociationName": "

The descriptive name of the container association.

", - "UpdateFirewallAnalysisSettingsRequest$FirewallName": "

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

", - "UpdateFirewallAnalysisSettingsResponse$FirewallName": "

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

", - "UpdateFirewallDeleteProtectionRequest$FirewallName": "

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

", - "UpdateFirewallDeleteProtectionResponse$FirewallName": "

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

", - "UpdateFirewallDescriptionRequest$FirewallName": "

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

", - "UpdateFirewallDescriptionResponse$FirewallName": "

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

", - "UpdateFirewallEncryptionConfigurationRequest$FirewallName": "

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

", - "UpdateFirewallEncryptionConfigurationResponse$FirewallName": "

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

", - "UpdateFirewallPolicyChangeProtectionRequest$FirewallName": "

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

", - "UpdateFirewallPolicyChangeProtectionResponse$FirewallName": "

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

", - "UpdateFirewallPolicyRequest$FirewallPolicyName": "

The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.

You must specify the ARN or the name, and you can specify both.

", - "UpdateLoggingConfigurationRequest$FirewallName": "

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

", - "UpdateLoggingConfigurationResponse$FirewallName": "

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

", - "UpdateProxyConfigurationRequest$ProxyConfigurationName": "

The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.

You must specify the ARN or the name, and you can specify both.

", - "UpdateProxyRequest$ProxyName": "

The descriptive name of the proxy. You can't change the name of a proxy after you create it.

You must specify the ARN or the name, and you can specify both.

", - "UpdateProxyRuleGroupPrioritiesRequest$ProxyConfigurationName": "

The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.

You must specify the ARN or the name, and you can specify both.

", - "UpdateProxyRulePrioritiesRequest$ProxyRuleGroupName": "

The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.

You must specify the ARN or the name, and you can specify both.

", - "UpdateProxyRulePrioritiesResponse$ProxyRuleGroupName": "

The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.

", - "UpdateProxyRuleRequest$ProxyRuleGroupName": "

The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.

You must specify the ARN or the name, and you can specify both.

", - "UpdateProxyRuleRequest$ProxyRuleName": "

The descriptive name of the proxy rule. You can't change the name of a proxy rule after you create it.

", - "UpdateRuleGroupRequest$RuleGroupName": "

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

You must specify the ARN or the name, and you can specify both.

", - "UpdateSubnetChangeProtectionRequest$FirewallName": "

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

", - "UpdateSubnetChangeProtectionResponse$FirewallName": "

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

", - "UpdateTLSInspectionConfigurationRequest$TLSInspectionConfigurationName": "

The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.

" - } - }, - "ResourceNameList": { - "base": null, - "refs": { - "CreateProxyConfigurationRequest$RuleGroupNames": "

The proxy rule group name(s) to attach to the proxy configuration.

You must specify the ARNs or the names, and you can specify both.

", - "DeleteProxyRulesRequest$Rules": "

The proxy rule(s) to remove from the existing proxy rule group.

", - "DetachRuleGroupsFromProxyConfigurationRequest$RuleGroupNames": "

The proxy rule group names to detach from the proxy configuration

" - } - }, - "ResourceNotFoundException": { - "base": "

Unable to locate a resource using the parameters that you provided.

", - "refs": {} - }, - "ResourceOwnerCheckException": { - "base": "

Unable to change the resource because your account doesn't own it.

", - "refs": {} - }, - "ResourceStatus": { - "base": null, - "refs": { - "FirewallPolicyResponse$FirewallPolicyStatus": "

The current status of the firewall policy. You can retrieve this for a firewall policy by calling DescribeFirewallPolicy and providing the firewall policy's name or ARN.

", - "RuleGroupResponse$RuleGroupStatus": "

Detailed information about the current status of a rule group.

", - "TLSInspectionConfigurationResponse$TLSInspectionConfigurationStatus": "

Detailed information about the current status of a TLSInspectionConfiguration. You can retrieve this for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration and providing the TLS inspection configuration name and ARN.

" - } - }, - "RevocationCheckAction": { - "base": null, - "refs": { - "CheckCertificateRevocationStatusActions$RevokedStatusAction": "

Configures how Network Firewall processes traffic when it determines that the certificate presented by the server in the SSL/TLS connection has a revoked status.

  • PASS - Allow the connection to continue, and pass subsequent packets to the stateful engine for inspection.

  • DROP - Network Firewall closes the connection and drops subsequent packets for that connection.

  • REJECT - Network Firewall sends a TCP reject packet back to your client. The service closes the connection and drops subsequent packets for that connection. REJECT is available only for TCP traffic.

", - "CheckCertificateRevocationStatusActions$UnknownStatusAction": "

Configures how Network Firewall processes traffic when it determines that the certificate presented by the server in the SSL/TLS connection has an unknown status, or a status that cannot be determined for any other reason, including when the service is unable to connect to the OCSP and CRL endpoints for the certificate.

  • PASS - Allow the connection to continue, and pass subsequent packets to the stateful engine for inspection.

  • DROP - Network Firewall closes the connection and drops subsequent packets for that connection.

  • REJECT - Network Firewall sends a TCP reject packet back to your client. The service closes the connection and drops subsequent packets for that connection. REJECT is available only for TCP traffic.

" - } - }, - "RuleCapacity": { - "base": null, - "refs": { - "CreateRuleGroupRequest$Capacity": "

The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.

You can retrieve the capacity that would be required for a rule group before you create the rule group by calling CreateRuleGroup with DryRun set to TRUE.

You can't change or exceed this capacity when you update the rule group, so leave room for your rule group to grow.

Capacity for a stateless rule group

For a stateless rule group, the capacity required is the sum of the capacity requirements of the individual rules that you expect to have in the rule group.

To calculate the capacity requirement of a single rule, multiply the capacity requirement values of each of the rule's match settings:

  • A match setting with no criteria specified has a value of 1.

  • A match setting with Any specified has a value of 1.

  • All other match settings have a value equal to the number of elements provided in the setting. For example, a protocol setting [\"UDP\"] and a source setting [\"10.0.0.0/24\"] each have a value of 1. A protocol setting [\"UDP\",\"TCP\"] has a value of 2. A source setting [\"10.0.0.0/24\",\"10.0.0.1/24\",\"10.0.0.2/24\"] has a value of 3.

A rule with no criteria specified in any of its match settings has a capacity requirement of 1. A rule with protocol setting [\"UDP\",\"TCP\"], source setting [\"10.0.0.0/24\",\"10.0.0.1/24\",\"10.0.0.2/24\"], and a single specification or no specification for each of the other match settings has a capacity requirement of 6.

Capacity for a stateful rule group

For a stateful rule group, the minimum capacity required is the number of individual rules that you expect to have in the rule group.

", - "DescribeRuleGroupMetadataResponse$Capacity": "

The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.

You can retrieve the capacity that would be required for a rule group before you create the rule group by calling CreateRuleGroup with DryRun set to TRUE.

", - "FirewallPolicyResponse$ConsumedStatelessRuleCapacity": "

The number of capacity units currently consumed by the policy's stateless rules.

", - "FirewallPolicyResponse$ConsumedStatefulRuleCapacity": "

The number of capacity units currently consumed by the policy's stateful rules.

", - "FirewallPolicyResponse$ConsumedStatefulDomainCapacity": "

The total number of domain name specifications across all domain list rule groups in the firewall policy that use the stateful-domain-rulegroup resource type.

", - "RuleGroupResponse$Capacity": "

The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.

You can retrieve the capacity that would be required for a rule group before you create the rule group by calling CreateRuleGroup with DryRun set to TRUE.

", - "RuleGroupResponse$ConsumedCapacity": "

The number of capacity units currently consumed by the rule group rules.

" - } - }, - "RuleDefinition": { - "base": "

The inspection criteria and action for a single stateless rule. Network Firewall inspects each packet for the specified matching criteria. When a packet matches the criteria, Network Firewall performs the rule's actions on the packet.

", - "refs": { - "StatelessRule$RuleDefinition": "

Defines the stateless 5-tuple packet inspection criteria and the action to take on a packet that matches the criteria.

" - } - }, - "RuleGroup": { - "base": "

The object that defines the rules in a rule group. This, along with RuleGroupResponse, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

Network Firewall uses a rule group to inspect and control network traffic. You define stateless rule groups to inspect individual packets and you define stateful rule groups to inspect packets in the context of their traffic flow.

To use a rule group, you include it by reference in an Network Firewall firewall policy, then you use the policy in a firewall. You can reference a rule group from more than one firewall policy, and you can use a firewall policy in more than one firewall.

", - "refs": { - "CreateRuleGroupRequest$RuleGroup": "

An object that defines the rule group rules.

You must provide either this rule group setting or a Rules setting, but not both.

", - "DescribeRuleGroupResponse$RuleGroup": "

The object that defines the rules in a rule group. This, along with RuleGroupResponse, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

Network Firewall uses a rule group to inspect and control network traffic. You define stateless rule groups to inspect individual packets and you define stateful rule groups to inspect packets in the context of their traffic flow.

To use a rule group, you include it by reference in an Network Firewall firewall policy, then you use the policy in a firewall. You can reference a rule group from more than one firewall policy, and you can use a firewall policy in more than one firewall.

", - "UpdateRuleGroupRequest$RuleGroup": "

An object that defines the rule group rules.

You must provide either this rule group setting or a Rules setting, but not both.

" - } - }, - "RuleGroupMetadata": { - "base": "

High-level information about a rule group, returned by ListRuleGroups. You can use the information provided in the metadata to retrieve and manage a rule group.

", - "refs": { - "RuleGroups$member": null - } - }, - "RuleGroupRequestPhase": { - "base": null, - "refs": { - "UpdateProxyRulePrioritiesRequest$RuleGroupRequestPhase": "

Evaluation points in the traffic flow where rules are applied. There are three phases in a traffic where the rule match is applied.

", - "UpdateProxyRulePrioritiesResponse$RuleGroupRequestPhase": "

Evaluation points in the traffic flow where rules are applied. There are three phases in a traffic where the rule match is applied.

" - } - }, - "RuleGroupResponse": { - "base": "

The high-level properties of a rule group. This, along with the RuleGroup, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

", - "refs": { - "CreateRuleGroupResponse$RuleGroupResponse": "

The high-level properties of a rule group. This, along with the RuleGroup, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

", - "DeleteRuleGroupResponse$RuleGroupResponse": "

The high-level properties of a rule group. This, along with the RuleGroup, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

", - "DescribeRuleGroupResponse$RuleGroupResponse": "

The high-level properties of a rule group. This, along with the RuleGroup, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

", - "UpdateRuleGroupResponse$RuleGroupResponse": "

The high-level properties of a rule group. This, along with the RuleGroup, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

" - } - }, - "RuleGroupType": { - "base": null, - "refs": { - "CreateRuleGroupRequest$Type": "

Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

", - "DeleteRuleGroupRequest$Type": "

Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

This setting is required for requests that do not include the RuleGroupARN.

", - "DescribeRuleGroupMetadataRequest$Type": "

Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

This setting is required for requests that do not include the RuleGroupARN.

", - "DescribeRuleGroupMetadataResponse$Type": "

Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

This setting is required for requests that do not include the RuleGroupARN.

", - "DescribeRuleGroupRequest$Type": "

Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

This setting is required for requests that do not include the RuleGroupARN.

", - "DescribeRuleGroupSummaryRequest$Type": "

The type of rule group you want a summary for. This is a required field.

Valid value: STATEFUL

Note that STATELESS exists but is not currently supported. If you provide STATELESS, an exception is returned.

", - "ListRuleGroupsRequest$Type": "

Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

", - "RuleGroupResponse$Type": "

Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

", - "UpdateRuleGroupRequest$Type": "

Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

This setting is required for requests that do not include the RuleGroupARN.

" - } - }, - "RuleGroups": { - "base": null, - "refs": { - "ListRuleGroupsResponse$RuleGroups": "

The rule group metadata objects that you've defined. Depending on your setting for max results and the number of rule groups, this might not be the full list.

" - } - }, - "RuleIdList": { - "base": null, - "refs": { - "AnalysisResult$IdentifiedRuleIds": "

The priority number of the stateless rules identified in the analysis.

" - } - }, - "RuleOption": { - "base": "

Additional settings for a stateful rule. This is part of the StatefulRule configuration.

", - "refs": { - "RuleOptions$member": null - } - }, - "RuleOptions": { - "base": null, - "refs": { - "StatefulRule$RuleOptions": "

Additional options for the rule. These are the Suricata RuleOptions settings.

" - } - }, - "RuleOrder": { - "base": null, - "refs": { - "StatefulEngineOptions$RuleOrder": "

Indicates how to manage the order of stateful rule evaluation for the policy. STRICT_ORDER is the recommended option, but DEFAULT_ACTION_ORDER is the default option. With STRICT_ORDER, provide your rules in the order that you want them to be evaluated. You can then choose one or more default actions for packets that don't match any rules. Choose STRICT_ORDER to have the stateful rules engine determine the evaluation order of your rules. The default action for this rule order is PASS, followed by DROP, REJECT, and ALERT actions. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them based on your settings. For more information, see Evaluation order for stateful rules in the Network Firewall Developer Guide.

", - "StatefulRuleOptions$RuleOrder": "

Indicates how to manage the order of the rule evaluation for the rule group. DEFAULT_ACTION_ORDER is the default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them based on certain settings. For more information, see Evaluation order for stateful rules in the Network Firewall Developer Guide.

" - } - }, - "RuleSummaries": { - "base": null, - "refs": { - "Summary$RuleSummaries": "

An array of RuleSummary objects containing individual rule details that had been configured by the rulegroup's SummaryConfiguration.

" - } - }, - "RuleSummary": { - "base": "

A complex type containing details about a Suricata rule. Contains:

  • SID

  • Msg

  • Metadata

Summaries are available for rule groups you manage and for active threat defense Amazon Web Services managed rule groups.

", - "refs": { - "RuleSummaries$member": null - } - }, - "RuleTargets": { - "base": null, - "refs": { - "RulesSourceList$Targets": "

The domains that you want to inspect for in your traffic flows. Valid domain specifications are the following:

  • Explicit names. For example, abc.example.com matches only the domain abc.example.com.

  • Names that use a domain wildcard, which you indicate with an initial '.'. For example,.example.com matches example.com and matches all subdomains of example.com, such as abc.example.com and www.example.com.

" - } - }, - "RuleVariableName": { - "base": null, - "refs": { - "IPSets$key": null, - "PortSets$key": null - } - }, - "RuleVariables": { - "base": "

Settings that are available for use in the rules in the RuleGroup where this is defined. See CreateRuleGroup or UpdateRuleGroup for usage.

", - "refs": { - "RuleGroup$RuleVariables": "

Settings that are available for use in the rules in the rule group. You can only use these for stateful rule groups.

" - } - }, - "RulesSource": { - "base": "

The stateless or stateful rules definitions for use in a single rule group. Each rule group requires a single RulesSource. You can use an instance of this for either stateless rules or stateful rules.

", - "refs": { - "RuleGroup$RulesSource": "

The stateful rules or stateless rules for the rule group.

" - } - }, - "RulesSourceList": { - "base": "

Stateful inspection criteria for a domain list rule group.

For HTTPS traffic, domain filtering is SNI-based. It uses the server name indicator extension of the TLS handshake.

By default, Network Firewall domain list inspection only includes traffic coming from the VPC where you deploy the firewall. To inspect traffic from IP addresses outside of the deployment VPC, you set the HOME_NET rule variable to include the CIDR range of the deployment VPC plus the other CIDR ranges. For more information, see RuleVariables in this guide and Stateful domain list rule groups in Network Firewall in the Network Firewall Developer Guide.

", - "refs": { - "RulesSource$RulesSourceList": "

Stateful inspection criteria for a domain list rule group.

" - } - }, - "RulesString": { - "base": null, - "refs": { - "CreateRuleGroupRequest$Rules": "

A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups.

You must provide either this rules setting or a populated RuleGroup setting, but not both.

You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call response returns a RuleGroup object that Network Firewall has populated from your string.

", - "RulesSource$RulesString": "

Stateful inspection criteria, provided in Suricata compatible rules. Suricata is an open-source threat detection framework that includes a standard rule-based language for network traffic inspection.

These rules contain the inspection criteria and the action to take for traffic that matches the criteria, so this type of rule group doesn't have a separate action setting.

You can't use the priority keyword if the RuleOrder option in StatefulRuleOptions is set to STRICT_ORDER.

", - "UpdateRuleGroupRequest$Rules": "

A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups.

You must provide either this rules setting or a populated RuleGroup setting, but not both.

You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call response returns a RuleGroup object that Network Firewall has populated from your string.

" - } - }, - "ServerCertificate": { - "base": "

Any Certificate Manager (ACM) Secure Sockets Layer/Transport Layer Security (SSL/TLS) server certificate that's associated with a ServerCertificateConfiguration. Used in a TLSInspectionConfiguration for inspection of inbound traffic to your firewall. You must request or import a SSL/TLS certificate into ACM for each domain Network Firewall needs to decrypt and inspect. Network Firewall uses the SSL/TLS certificates to decrypt specified inbound SSL/TLS traffic going to your firewall. For information about working with certificates in Certificate Manager, see Request a public certificate or Importing certificates in the Certificate Manager User Guide.

", - "refs": { - "ServerCertificates$member": null - } - }, - "ServerCertificateConfiguration": { - "base": "

Configures the Certificate Manager certificates and scope that Network Firewall uses to decrypt and re-encrypt traffic using a TLSInspectionConfiguration. You can configure ServerCertificates for inbound SSL/TLS inspection, a CertificateAuthorityArn for outbound SSL/TLS inspection, or both. For information about working with certificates for TLS inspection, see Using SSL/TLS server certficiates with TLS inspection configurations in the Network Firewall Developer Guide.

If a server certificate that's associated with your TLSInspectionConfiguration is revoked, deleted, or expired it can result in client-side TLS errors.

", - "refs": { - "ServerCertificateConfigurations$member": null - } - }, - "ServerCertificateConfigurations": { - "base": null, - "refs": { - "TLSInspectionConfiguration$ServerCertificateConfigurations": "

Lists the server certificate configurations that are associated with the TLS configuration.

" - } - }, - "ServerCertificateScope": { - "base": "

Settings that define the Secure Sockets Layer/Transport Layer Security (SSL/TLS) traffic that Network Firewall should decrypt for inspection by the stateful rule engine.

", - "refs": { - "ServerCertificateScopes$member": null - } - }, - "ServerCertificateScopes": { - "base": null, - "refs": { - "ServerCertificateConfiguration$Scopes": "

A list of scopes.

" - } - }, - "ServerCertificates": { - "base": null, - "refs": { - "ServerCertificateConfiguration$ServerCertificates": "

The list of server certificates to use for inbound SSL/TLS inspection.

" - } - }, - "Setting": { - "base": null, - "refs": { - "Settings$member": null - } - }, - "Settings": { - "base": null, - "refs": { - "RuleOption$Settings": "

The settings of the Suricata compatible rule option. Rule options have zero or more setting values, and the number of possible and required settings depends on the Keyword. For more information about the settings for specific options, see Rule options.

" - } - }, - "Source": { - "base": null, - "refs": { - "Header$Source": "

The source IP address or address range to inspect for, in CIDR notation. To match with any address, specify ANY.

Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4 and IPv6.

Examples:

  • To configure Network Firewall to inspect for the IP address 192.0.2.44, specify 192.0.2.44/32.

  • To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

  • To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

  • To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

" - } - }, - "SourceMetadata": { - "base": "

High-level information about the managed rule group that your own rule group is copied from. You can use the the metadata to track version updates made to the originating rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

", - "refs": { - "CreateRuleGroupRequest$SourceMetadata": "

A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to keep track of updates made to the originating rule group.

", - "RuleGroupResponse$SourceMetadata": "

A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to track the version updates made to the originating rule group.

", - "UpdateRuleGroupRequest$SourceMetadata": "

A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to keep track of updates made to the originating rule group.

" - } - }, - "StartAnalysisReportRequest": { - "base": null, - "refs": {} - }, - "StartAnalysisReportResponse": { - "base": null, - "refs": {} - }, - "StartFlowCaptureRequest": { - "base": null, - "refs": {} - }, - "StartFlowCaptureResponse": { - "base": null, - "refs": {} - }, - "StartFlowFlushRequest": { - "base": null, - "refs": {} - }, - "StartFlowFlushResponse": { - "base": null, - "refs": {} - }, - "StartTime": { - "base": null, - "refs": { - "GetAnalysisReportResultsResponse$StartTime": "

The date and time within the last 30 days from which to start retrieving analysis data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ.

" - } - }, - "StatefulAction": { - "base": null, - "refs": { - "StatefulRule$Action": "

Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria. For all actions, Network Firewall performs the specified action and discontinues stateful inspection of the traffic flow.

The actions for a stateful rule are defined as follows:

  • PASS - Permits the packets to go to the intended destination.

  • DROP - Blocks the packets from going to the intended destination and sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.

  • ALERT - Sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.

    You can use this action to test a rule that you intend to use to drop traffic. You can enable the rule with ALERT action, verify in the logs that the rule is filtering as you want, then change the action to DROP.

  • REJECT - Drops traffic that matches the conditions of the stateful rule, and sends a TCP reset packet back to sender of the packet. A TCP reset packet is a packet with no payload and an RST bit contained in the TCP header flags. REJECT is available only for TCP traffic. This option doesn't support FTP or IMAP protocols.

" - } - }, - "StatefulActions": { - "base": null, - "refs": { - "FirewallPolicy$StatefulDefaultActions": "

The default actions to take on a packet that doesn't match any stateful rules. The stateful default action is optional, and is only valid when using the strict rule order.

Valid values of the stateful default action:

  • aws:drop_strict

  • aws:drop_established

  • aws:alert_strict

  • aws:alert_established

For more information, see Strict evaluation order in the Network Firewall Developer Guide.

" - } - }, - "StatefulEngineOptions": { - "base": "

Configuration settings for the handling of the stateful rule groups in a firewall policy.

", - "refs": { - "FirewallPolicy$StatefulEngineOptions": "

Additional options governing how Network Firewall handles stateful rules. The stateful rule groups that you use in your policy must have stateful rule options settings that are compatible with these settings.

" - } - }, - "StatefulRule": { - "base": "

A single Suricata rules specification, for use in a stateful rule group. Use this option to specify a simple Suricata rule with protocol, source and destination, ports, direction, and rule options. For information about the Suricata Rules format, see Rules Format.

", - "refs": { - "StatefulRules$member": null - } - }, - "StatefulRuleDirection": { - "base": null, - "refs": { - "Header$Direction": "

The direction of traffic flow to inspect. If set to ANY, the inspection matches bidirectional traffic, both from the source to the destination and from the destination to the source. If set to FORWARD, the inspection only matches traffic going from the source to the destination.

" - } - }, - "StatefulRuleGroupOverride": { - "base": "

The setting that allows the policy owner to change the behavior of the rule group within a policy.

", - "refs": { - "StatefulRuleGroupReference$Override": "

The action that allows the policy owner to override the behavior of the rule group within a policy.

" - } - }, - "StatefulRuleGroupReference": { - "base": "

Identifier for a single stateful rule group, used in a firewall policy to refer to a rule group.

", - "refs": { - "StatefulRuleGroupReferences$member": null - } - }, - "StatefulRuleGroupReferences": { - "base": null, - "refs": { - "FirewallPolicy$StatefulRuleGroupReferences": "

References to the stateful rule groups that are used in the policy. These define the inspection criteria in stateful rules.

" - } - }, - "StatefulRuleOptions": { - "base": "

Additional options governing how Network Firewall handles the rule group. You can only use these for stateful rule groups.

", - "refs": { - "DescribeRuleGroupMetadataResponse$StatefulRuleOptions": null, - "RuleGroup$StatefulRuleOptions": "

Additional options governing how Network Firewall handles stateful rules. The policies where you use your stateful rule group must have stateful rule options settings that are compatible with these settings. Some limitations apply; for more information, see Strict evaluation order in the Network Firewall Developer Guide.

" - } - }, - "StatefulRuleProtocol": { - "base": null, - "refs": { - "Header$Protocol": "

The protocol to inspect for. To specify all, you can use IP, because all traffic on Amazon Web Services and on the internet is IP.

" - } - }, - "StatefulRules": { - "base": null, - "refs": { - "RulesSource$StatefulRules": "

An array of individual stateful rules inspection criteria to be used together in a stateful rule group. Use this option to specify simple Suricata rules with protocol, source and destination, ports, direction, and rule options. For information about the Suricata Rules format, see Rules Format.

" - } - }, - "StatelessActions": { - "base": null, - "refs": { - "FirewallPolicy$StatelessDefaultActions": "

The actions to take on a packet if it doesn't match any of the stateless rules in the policy. If you want non-matching packets to be forwarded for stateful inspection, specify aws:forward_to_sfe.

You must specify one of the standard actions: aws:pass, aws:drop, or aws:forward_to_sfe. In addition, you can specify custom actions that are compatible with your standard section choice.

For example, you could specify [\"aws:pass\"] or you could specify [\"aws:pass\", “customActionName”]. For information about compatibility, see the custom action descriptions under CustomAction.

", - "FirewallPolicy$StatelessFragmentDefaultActions": "

The actions to take on a fragmented UDP packet if it doesn't match any of the stateless rules in the policy. Network Firewall only manages UDP packet fragments and silently drops packet fragments for other protocols. If you want non-matching fragmented UDP packets to be forwarded for stateful inspection, specify aws:forward_to_sfe.

You must specify one of the standard actions: aws:pass, aws:drop, or aws:forward_to_sfe. In addition, you can specify custom actions that are compatible with your standard section choice.

For example, you could specify [\"aws:pass\"] or you could specify [\"aws:pass\", “customActionName”]. For information about compatibility, see the custom action descriptions under CustomAction.

", - "RuleDefinition$Actions": "

The actions to take on a packet that matches one of the stateless rule definition's match attributes. You must specify a standard action and you can add custom actions.

Network Firewall only forwards a packet for stateful rule inspection if you specify aws:forward_to_sfe for a rule that the packet matches, or if the packet doesn't match any stateless rule and you specify aws:forward_to_sfe for the StatelessDefaultActions setting for the FirewallPolicy.

For every rule, you must specify exactly one of the following standard actions.

  • aws:pass - Discontinues all inspection of the packet and permits it to go to its intended destination.

  • aws:drop - Discontinues all inspection of the packet and blocks it from going to its intended destination.

  • aws:forward_to_sfe - Discontinues stateless inspection of the packet and forwards it to the stateful rule engine for inspection.

Additionally, you can specify a custom action. To do this, you define a custom action by name and type, then provide the name you've assigned to the action in this Actions setting. For information about the options, see CustomAction.

To provide more than one action in this setting, separate the settings with a comma. For example, if you have a custom PublishMetrics action that you've named MyMetricsAction, then you could specify the standard action aws:pass and the custom action with [“aws:pass”, “MyMetricsAction”].

" - } - }, - "StatelessRule": { - "base": "

A single stateless rule. This is used in StatelessRulesAndCustomActions.

", - "refs": { - "StatelessRules$member": null - } - }, - "StatelessRuleGroupReference": { - "base": "

Identifier for a single stateless rule group, used in a firewall policy to refer to the rule group.

", - "refs": { - "StatelessRuleGroupReferences$member": null - } - }, - "StatelessRuleGroupReferences": { - "base": null, - "refs": { - "FirewallPolicy$StatelessRuleGroupReferences": "

References to the stateless rule groups that are used in the policy. These define the matching criteria in stateless rules.

" - } - }, - "StatelessRules": { - "base": null, - "refs": { - "StatelessRulesAndCustomActions$StatelessRules": "

Defines the set of stateless rules for use in a stateless rule group.

" - } - }, - "StatelessRulesAndCustomActions": { - "base": "

Stateless inspection criteria. Each stateless rule group uses exactly one of these data types to define its stateless rules.

", - "refs": { - "RulesSource$StatelessRulesAndCustomActions": "

Stateless inspection criteria to be used in a stateless rule group.

" - } - }, - "Status": { - "base": null, - "refs": { - "AnalysisReport$Status": "

The status of the analysis report you specify. Statuses include RUNNING, COMPLETED, or FAILED.

", - "GetAnalysisReportResultsResponse$Status": "

The status of the analysis report you specify. Statuses include RUNNING, COMPLETED, or FAILED.

" - } - }, - "StatusMessage": { - "base": null, - "refs": { - "Attachment$StatusMessage": "

If Network Firewall fails to create or delete the firewall endpoint in the subnet, it populates this with the reason for the error or failure and how to resolve it. A FAILED status indicates a non-recoverable state, and a ERROR status indicates an issue that you can fix. Depending on the error, it can take as many as 15 minutes to populate this field. For more information about the causes for failiure or errors and solutions available for this field, see Troubleshooting firewall endpoint failures in the Network Firewall Developer Guide.

" - } - }, - "StatusReason": { - "base": null, - "refs": { - "DescribeFlowOperationResponse$StatusMessage": "

If the asynchronous operation fails, Network Firewall populates this with the reason for the error or failure. Options include Flow operation error and Flow timeout.

", - "ListFlowOperationResultsResponse$StatusMessage": "

If the asynchronous operation fails, Network Firewall populates this with the reason for the error or failure. Options include Flow operation error and Flow timeout.

", - "TlsCertificateData$StatusMessage": "

Contains details about the certificate status, including information about certificate errors.

" - } - }, - "StreamExceptionPolicy": { - "base": null, - "refs": { - "StatefulEngineOptions$StreamExceptionPolicy": "

Configures how Network Firewall processes traffic when a network connection breaks midstream. Network connections can break due to disruptions in external networks or within the firewall itself.

  • DROP - Network Firewall fails closed and drops all subsequent traffic going to the firewall. This is the default behavior.

  • CONTINUE - Network Firewall continues to apply rules to the subsequent traffic without context from traffic before the break. This impacts the behavior of rules that depend on this context. For example, if you have a stateful rule to drop http traffic, Network Firewall won't match the traffic for this rule because the service won't have the context from session initialization defining the application layer protocol as HTTP. However, this behavior is rule dependent—a TCP-layer rule using a flow:stateless rule would still match, as would the aws:drop_strict default action.

  • REJECT - Network Firewall fails closed and drops all subsequent traffic going to the firewall. Network Firewall also sends a TCP reject packet back to your client so that the client can immediately establish a new session. Network Firewall will have context about the new session and will apply rules to the subsequent traffic.

" - } - }, - "SubnetMapping": { - "base": "

The ID for a subnet that's used in an association with a firewall. This is used in CreateFirewall, AssociateSubnets, and CreateVpcEndpointAssociation. Network Firewall creates an instance of the associated firewall in each subnet that you specify, to filter traffic in the subnet's Availability Zone.

", - "refs": { - "CreateVpcEndpointAssociationRequest$SubnetMapping": null, - "SubnetMappings$member": null, - "VpcEndpointAssociation$SubnetMapping": null - } - }, - "SubnetMappings": { - "base": null, - "refs": { - "AssociateSubnetsRequest$SubnetMappings": "

The IDs of the subnets that you want to associate with the firewall.

", - "AssociateSubnetsResponse$SubnetMappings": "

The IDs of the subnets that are associated with the firewall.

", - "CreateFirewallRequest$SubnetMappings": "

The public subnets to use for your Network Firewall firewalls. Each subnet must belong to a different Availability Zone in the VPC. Network Firewall creates a firewall endpoint in each subnet.

", - "DisassociateSubnetsResponse$SubnetMappings": "

The IDs of the subnets that are associated with the firewall.

", - "Firewall$SubnetMappings": "

The primary public subnets that Network Firewall is using for the firewall. Network Firewall creates a firewall endpoint in each subnet. Create a subnet mapping for each Availability Zone where you want to use the firewall.

These subnets are all defined for a single, primary VPC, and each must belong to a different Availability Zone. Each of these subnets establishes the availability of the firewall in its Availability Zone.

In addition to these subnets, you can define other endpoints for the firewall in VpcEndpointAssociation resources. You can define these additional endpoints for any VPC, and for any of the Availability Zones where the firewall resource already has a subnet mapping. VPC endpoint associations give you the ability to protect multiple VPCs using a single firewall, and to define multiple firewall endpoints for a VPC in a single Availability Zone.

" - } - }, - "SubscriptionStatus": { - "base": null, - "refs": { - "ListRuleGroupsRequest$SubscriptionStatus": "

Filters the results to show only rule groups with the specified subscription status. Use this to find subscribed or unsubscribed rule groups.

" - } - }, - "Summary": { - "base": "

A complex type containing summaries of security protections provided by a rule group.

Network Firewall extracts this information from selected fields in the rule group's Suricata rules, based on your SummaryConfiguration settings.

", - "refs": { - "DescribeRuleGroupSummaryResponse$Summary": "

A complex type that contains rule information based on the rule group's configured summary settings. The content varies depending on the fields that you specified to extract in your SummaryConfiguration. When you haven't configured any summary settings, this returns an empty array. The response might include:

  • Rule identifiers

  • Rule descriptions

  • Any metadata fields that you specified in your SummaryConfiguration

" - } - }, - "SummaryConfiguration": { - "base": "

A complex type that specifies which Suricata rule metadata fields to use when displaying threat information. Contains:

  • RuleOptions - The Suricata rule options fields to extract and display

These settings affect how threat information appears in both the console and API responses. Summaries are available for rule groups you manage and for active threat defense Amazon Web Services managed rule groups.

", - "refs": { - "CreateRuleGroupRequest$SummaryConfiguration": "

An object that contains a RuleOptions array of strings. You use RuleOptions to determine which of the following RuleSummary values are returned in response to DescribeRuleGroupSummary.

  • Metadata - returns

  • Msg

  • SID

", - "RuleGroupResponse$SummaryConfiguration": "

A complex type containing the currently selected rule option fields that will be displayed for rule summarization returned by DescribeRuleGroupSummary.

", - "UpdateRuleGroupRequest$SummaryConfiguration": "

Updates the selected summary configuration for a rule group.

Changes affect subsequent responses from DescribeRuleGroupSummary.

" - } - }, - "SummaryRuleOption": { - "base": null, - "refs": { - "SummaryRuleOptions$member": null - } - }, - "SummaryRuleOptions": { - "base": null, - "refs": { - "SummaryConfiguration$RuleOptions": "

Specifies the selected rule options returned by DescribeRuleGroupSummary.

" - } - }, - "SupportedAvailabilityZones": { - "base": null, - "refs": { - "DescribeFirewallMetadataResponse$SupportedAvailabilityZones": "

The Availability Zones that the firewall currently supports. This includes all Availability Zones for which the firewall has a subnet defined.

" - } - }, - "SyncState": { - "base": "

The status of the firewall endpoint and firewall policy configuration for a single VPC subnet. This is part of the FirewallStatus.

For each VPC subnet that you associate with a firewall, Network Firewall does the following:

  • Instantiates a firewall endpoint in the subnet, ready to take traffic.

  • Configures the endpoint with the current firewall policy settings, to provide the filtering behavior for the endpoint.

When you update a firewall, for example to add a subnet association or change a rule group in the firewall policy, the affected sync states reflect out-of-sync or not ready status until the changes are complete.

", - "refs": { - "SyncStates$value": null - } - }, - "SyncStateConfig": { - "base": null, - "refs": { - "SyncState$Config": "

The configuration status of the firewall endpoint in a single VPC subnet. Network Firewall provides each endpoint with the rules that are configured in the firewall policy. Each time you add a subnet or modify the associated firewall policy, Network Firewall synchronizes the rules in the endpoint, so it can properly filter network traffic.

" - } - }, - "SyncStates": { - "base": null, - "refs": { - "FirewallStatus$SyncStates": "

Status for the subnets that you've configured in the firewall. This contains one array element per Availability Zone where you've configured a subnet in the firewall.

These objects provide detailed information for the settings ConfigurationSyncStateSummary and Status.

" - } - }, - "TCPFlag": { - "base": null, - "refs": { - "Flags$member": null - } - }, - "TCPFlagField": { - "base": "

TCP flags and masks to inspect packets for, used in stateless rules MatchAttributes settings.

", - "refs": { - "TCPFlags$member": null - } - }, - "TCPFlags": { - "base": null, - "refs": { - "MatchAttributes$TCPFlags": "

The TCP flags and masks to inspect for. If not specified, this matches with any settings. This setting is only used for protocol 6 (TCP).

" - } - }, - "TLSInspectionConfiguration": { - "base": "

The object that defines a TLS inspection configuration. This, along with TLSInspectionConfigurationResponse, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.

Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.

To use a TLS inspection configuration, you add it to a new Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect the traffic traveling through your firewalls. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.

", - "refs": { - "CreateTLSInspectionConfigurationRequest$TLSInspectionConfiguration": "

The object that defines a TLS inspection configuration. This, along with TLSInspectionConfigurationResponse, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.

Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.

To use a TLS inspection configuration, you add it to a new Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect the traffic traveling through your firewalls. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.

", - "DescribeTLSInspectionConfigurationResponse$TLSInspectionConfiguration": "

The object that defines a TLS inspection configuration. This, along with TLSInspectionConfigurationResponse, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.

Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.

To use a TLS inspection configuration, you add it to a new Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect the traffic traveling through your firewalls. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.

", - "UpdateTLSInspectionConfigurationRequest$TLSInspectionConfiguration": "

The object that defines a TLS inspection configuration. This, along with TLSInspectionConfigurationResponse, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.

Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.

To use a TLS inspection configuration, you add it to a new Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect the traffic traveling through your firewalls. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.

" - } - }, - "TLSInspectionConfigurationMetadata": { - "base": "

High-level information about a TLS inspection configuration, returned by ListTLSInspectionConfigurations. You can use the information provided in the metadata to retrieve and manage a TLS configuration.

", - "refs": { - "TLSInspectionConfigurations$member": null - } - }, - "TLSInspectionConfigurationResponse": { - "base": "

The high-level properties of a TLS inspection configuration. This, along with the TLSInspectionConfiguration, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.

", - "refs": { - "CreateTLSInspectionConfigurationResponse$TLSInspectionConfigurationResponse": "

The high-level properties of a TLS inspection configuration. This, along with the TLSInspectionConfiguration, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.

", - "DeleteTLSInspectionConfigurationResponse$TLSInspectionConfigurationResponse": "

The high-level properties of a TLS inspection configuration. This, along with the TLSInspectionConfiguration, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.

", - "DescribeTLSInspectionConfigurationResponse$TLSInspectionConfigurationResponse": "

The high-level properties of a TLS inspection configuration. This, along with the TLSInspectionConfiguration, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.

", - "UpdateTLSInspectionConfigurationResponse$TLSInspectionConfigurationResponse": "

The high-level properties of a TLS inspection configuration. This, along with the TLSInspectionConfiguration, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.

" - } - }, - "TLSInspectionConfigurations": { - "base": null, - "refs": { - "ListTLSInspectionConfigurationsResponse$TLSInspectionConfigurations": "

The TLS inspection configuration metadata objects that you've defined. Depending on your setting for max results and the number of TLS inspection configurations, this might not be the full list.

" - } - }, - "Tag": { - "base": "

A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as \"environment\") and the tag value represents a specific value within that category (such as \"test,\" \"development,\" or \"production\"). You can add up to 50 tags to each Amazon Web Services resource.

", - "refs": { - "TagList$member": null - } - }, - "TagKey": { - "base": null, - "refs": { - "Tag$Key": "

The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as \"customer.\" Tag keys are case-sensitive.

", - "TagKeyList$member": null - } - }, - "TagKeyList": { - "base": null, - "refs": { - "UntagResourceRequest$TagKeys": "

" - } - }, - "TagList": { - "base": null, - "refs": { - "CreateContainerAssociationRequest$Tags": "

The key:value pairs to associate with the resource.

", - "CreateContainerAssociationResponse$Tags": "

The key:value pairs associated with the resource.

", - "CreateFirewallPolicyRequest$Tags": "

The key:value pairs to associate with the resource.

", - "CreateFirewallRequest$Tags": "

The key:value pairs to associate with the resource.

", - "CreateProxyConfigurationRequest$Tags": "

The key:value pairs to associate with the resource.

", - "CreateProxyRequest$Tags": "

The key:value pairs to associate with the resource.

", - "CreateProxyRuleGroupRequest$Tags": "

The key:value pairs to associate with the resource.

", - "CreateRuleGroupRequest$Tags": "

The key:value pairs to associate with the resource.

", - "CreateTLSInspectionConfigurationRequest$Tags": "

The key:value pairs to associate with the resource.

", - "CreateVpcEndpointAssociationRequest$Tags": "

The key:value pairs to associate with the resource.

", - "DescribeContainerAssociationResponse$Tags": "

The key:value pairs associated with the resource.

", - "DescribeProxyResource$Tags": "

The key:value pairs to associate with the resource.

", - "Firewall$Tags": "

", - "FirewallPolicyResponse$Tags": "

The key:value pairs to associate with the resource.

", - "ListTagsForResourceResponse$Tags": "

The tags that are associated with the resource.

", - "Proxy$Tags": "

The key:value pairs to associate with the resource.

", - "ProxyConfiguration$Tags": "

The key:value pairs to associate with the resource.

", - "ProxyRuleGroup$Tags": "

The key:value pairs to associate with the resource.

", - "RuleGroupResponse$Tags": "

The key:value pairs to associate with the resource.

", - "TLSInspectionConfigurationResponse$Tags": "

The key:value pairs to associate with the resource.

", - "TagResourceRequest$Tags": "

", - "UpdateContainerAssociationRequest$Tags": "

The key:value pairs associated with the resource.

", - "UpdateContainerAssociationResponse$Tags": "

The key:value pairs associated with the resource.

", - "VpcEndpointAssociation$Tags": "

The key:value pairs to associate with the resource.

" - } - }, - "TagResourceRequest": { - "base": null, - "refs": {} - }, - "TagResourceResponse": { - "base": null, - "refs": {} - }, - "TagValue": { - "base": null, - "refs": { - "Tag$Value": "

The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as \"companyA\" or \"companyB.\" Tag values are case-sensitive.

" - } - }, - "TagsPaginationMaxResults": { - "base": null, - "refs": { - "ListTagsForResourceRequest$MaxResults": "

The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

" - } - }, - "TargetType": { - "base": null, - "refs": { - "TargetTypes$member": null - } - }, - "TargetTypes": { - "base": null, - "refs": { - "RulesSourceList$TargetTypes": "

The protocols you want to inspect. Specify TLS_SNI for HTTPS. Specify HTTP_HOST for HTTP. You can specify either or both.

" - } - }, - "TcpIdleTimeoutRangeBound": { - "base": null, - "refs": { - "FlowTimeouts$TcpIdleTimeoutSeconds": "

The number of seconds that can pass without any TCP traffic sent through the firewall before the firewall determines that the connection is idle. After the idle timeout passes, data packets are dropped, however, the next TCP SYN packet is considered a new flow and is processed by the firewall. Clients or targets can use TCP keepalive packets to reset the idle timeout.

You can define the TcpIdleTimeoutSeconds value to be between 60 and 6000 seconds. If no value is provided, it defaults to 350 seconds.

" - } - }, - "ThrottlingException": { - "base": "

Unable to process the request due to throttling limitations.

", - "refs": {} - }, - "TlsCertificateData": { - "base": "

Contains metadata about an Certificate Manager certificate.

", - "refs": { - "Certificates$member": null, - "TLSInspectionConfigurationResponse$CertificateAuthority": null - } - }, - "TlsInterceptMode": { - "base": null, - "refs": { - "TlsInterceptProperties$TlsInterceptMode": "

Specifies whether to enable or disable TLS Intercept Mode.

", - "TlsInterceptPropertiesRequest$TlsInterceptMode": "

Specifies whether to enable or disable TLS Intercept Mode.

" - } - }, - "TlsInterceptProperties": { - "base": "

TLS decryption on traffic to filter on attributes in the HTTP header.

", - "refs": { - "DescribeProxyResource$TlsInterceptProperties": "

TLS decryption on traffic to filter on attributes in the HTTP header.

", - "Proxy$TlsInterceptProperties": "

TLS decryption on traffic to filter on attributes in the HTTP header.

" - } - }, - "TlsInterceptPropertiesRequest": { - "base": "

This data type is used specifically for the CreateProxy and UpdateProxy APIs.

TLS decryption on traffic to filter on attributes in the HTTP header.

", - "refs": { - "CreateProxyRequest$TlsInterceptProperties": "

TLS decryption on traffic to filter on attributes in the HTTP header.

", - "UpdateProxyRequest$TlsInterceptProperties": "

TLS decryption on traffic to filter on attributes in the HTTP header.

" - } - }, - "TransitGatewayAttachmentId": { - "base": null, - "refs": { - "AcceptNetworkFirewallTransitGatewayAttachmentRequest$TransitGatewayAttachmentId": "

Required. The unique identifier of the transit gateway attachment to accept. This ID is returned in the response when creating a transit gateway-attached firewall.

", - "AcceptNetworkFirewallTransitGatewayAttachmentResponse$TransitGatewayAttachmentId": "

The unique identifier of the transit gateway attachment that was accepted.

", - "DeleteNetworkFirewallTransitGatewayAttachmentRequest$TransitGatewayAttachmentId": "

Required. The unique identifier of the transit gateway attachment to delete.

", - "DeleteNetworkFirewallTransitGatewayAttachmentResponse$TransitGatewayAttachmentId": "

The ID of the transit gateway attachment that was deleted.

", - "DescribeFirewallMetadataResponse$TransitGatewayAttachmentId": "

The unique identifier of the transit gateway attachment associated with this firewall. This field is only present for transit gateway-attached firewalls.

", - "FirewallMetadata$TransitGatewayAttachmentId": "

The unique identifier of the transit gateway attachment associated with this firewall. This field is only present for transit gateway-attached firewalls.

", - "RejectNetworkFirewallTransitGatewayAttachmentRequest$TransitGatewayAttachmentId": "

Required. The unique identifier of the transit gateway attachment to reject. This ID is returned in the response when creating a transit gateway-attached firewall.

", - "RejectNetworkFirewallTransitGatewayAttachmentResponse$TransitGatewayAttachmentId": "

The unique identifier of the transit gateway attachment that was rejected.

" - } - }, - "TransitGatewayAttachmentStatus": { - "base": null, - "refs": { - "AcceptNetworkFirewallTransitGatewayAttachmentResponse$TransitGatewayAttachmentStatus": "

The current status of the transit gateway attachment. Valid values are:

  • CREATING - The attachment is being created

  • DELETING - The attachment is being deleted

  • DELETED - The attachment has been deleted

  • FAILED - The attachment creation has failed and cannot be recovered

  • ERROR - The attachment is in an error state that might be recoverable

  • READY - The attachment is active and processing traffic

  • PENDING_ACCEPTANCE - The attachment is waiting to be accepted

  • REJECTING - The attachment is in the process of being rejected

  • REJECTED - The attachment has been rejected

", - "DeleteNetworkFirewallTransitGatewayAttachmentResponse$TransitGatewayAttachmentStatus": "

The current status of the transit gateway attachment deletion process.

Valid values are:

  • CREATING - The attachment is being created

  • DELETING - The attachment is being deleted

  • DELETED - The attachment has been deleted

  • FAILED - The attachment creation has failed and cannot be recovered

  • ERROR - The attachment is in an error state that might be recoverable

  • READY - The attachment is active and processing traffic

  • PENDING_ACCEPTANCE - The attachment is waiting to be accepted

  • REJECTING - The attachment is in the process of being rejected

  • REJECTED - The attachment has been rejected

", - "RejectNetworkFirewallTransitGatewayAttachmentResponse$TransitGatewayAttachmentStatus": "

The current status of the transit gateway attachment. Valid values are:

  • CREATING - The attachment is being created

  • DELETING - The attachment is being deleted

  • DELETED - The attachment has been deleted

  • FAILED - The attachment creation has failed and cannot be recovered

  • ERROR - The attachment is in an error state that might be recoverable

  • READY - The attachment is active and processing traffic

  • PENDING_ACCEPTANCE - The attachment is waiting to be accepted

  • REJECTING - The attachment is in the process of being rejected

  • REJECTED - The attachment has been rejected

For information about troubleshooting endpoint failures, see Troubleshooting firewall endpoint failures in the Network Firewall Developer Guide.

", - "TransitGatewayAttachmentSyncState$TransitGatewayAttachmentStatus": "

The current status of the transit gateway attachment.

Valid values are:

  • CREATING - The attachment is being created

  • DELETING - The attachment is being deleted

  • DELETED - The attachment has been deleted

  • FAILED - The attachment creation has failed and cannot be recovered

  • ERROR - The attachment is in an error state that might be recoverable

  • READY - The attachment is active and processing traffic

  • PENDING_ACCEPTANCE - The attachment is waiting to be accepted

  • REJECTING - The attachment is in the process of being rejected

  • REJECTED - The attachment has been rejected

" - } - }, - "TransitGatewayAttachmentSyncState": { - "base": "

Contains information about the synchronization state of a transit gateway attachment, including its current status and any error messages. Network Firewall uses this to track the state of your transit gateway configuration changes.

", - "refs": { - "FirewallStatus$TransitGatewayAttachmentSyncState": "

The synchronization state of the transit gateway attachment. This indicates whether the firewall's transit gateway configuration is properly synchronized and operational. Use this to verify that your transit gateway configuration changes have been applied.

" - } - }, - "TransitGatewayAttachmentSyncStateMessage": { - "base": null, - "refs": { - "TransitGatewayAttachmentSyncState$StatusMessage": "

A message providing additional information about the current status, particularly useful when the transit gateway attachment is in a non-READY state.

Valid values are:

  • CREATING - The attachment is being created

  • DELETING - The attachment is being deleted

  • DELETED - The attachment has been deleted

  • FAILED - The attachment creation has failed and cannot be recovered

  • ERROR - The attachment is in an error state that might be recoverable

  • READY - The attachment is active and processing traffic

  • PENDING_ACCEPTANCE - The attachment is waiting to be accepted

  • REJECTING - The attachment is in the process of being rejected

  • REJECTED - The attachment has been rejected

For information about troubleshooting endpoint failures, see Troubleshooting firewall endpoint failures in the Network Firewall Developer Guide.

" - } - }, - "TransitGatewayId": { - "base": null, - "refs": { - "CreateFirewallRequest$TransitGatewayId": "

Required when creating a transit gateway-attached firewall. The unique identifier of the transit gateway to attach to this firewall. You can provide either a transit gateway from your account or one that has been shared with you through Resource Access Manager.

After creating the firewall, you cannot change the transit gateway association. To use a different transit gateway, you must create a new firewall.

For information about creating firewalls, see CreateFirewall. For specific guidance about transit gateway-attached firewalls, see Considerations for transit gateway-attached firewalls in the Network Firewall Developer Guide.

", - "Firewall$TransitGatewayId": "

The unique identifier of the transit gateway associated with this firewall. This field is only present for transit gateway-attached firewalls.

" - } - }, - "UniqueSources": { - "base": "

A unique source IP address that connected to a domain.

", - "refs": { - "AnalysisTypeReportResult$UniqueSources": "

The number of unique source IP addresses that connected to a domain.

" - } - }, - "UnsupportedOperationException": { - "base": "

The operation you requested isn't supported by Network Firewall.

", - "refs": {} - }, - "UntagResourceRequest": { - "base": null, - "refs": {} - }, - "UntagResourceResponse": { - "base": null, - "refs": {} - }, - "UpdateAvailabilityZoneChangeProtectionRequest": { - "base": null, - "refs": {} - }, - "UpdateAvailabilityZoneChangeProtectionResponse": { - "base": null, - "refs": {} - }, - "UpdateContainerAssociationRequest": { - "base": null, - "refs": {} - }, - "UpdateContainerAssociationResponse": { - "base": null, - "refs": {} - }, - "UpdateFirewallAnalysisSettingsRequest": { - "base": null, - "refs": {} - }, - "UpdateFirewallAnalysisSettingsResponse": { - "base": null, - "refs": {} - }, - "UpdateFirewallDeleteProtectionRequest": { - "base": null, - "refs": {} - }, - "UpdateFirewallDeleteProtectionResponse": { - "base": null, - "refs": {} - }, - "UpdateFirewallDescriptionRequest": { - "base": null, - "refs": {} - }, - "UpdateFirewallDescriptionResponse": { - "base": null, - "refs": {} - }, - "UpdateFirewallEncryptionConfigurationRequest": { - "base": null, - "refs": {} - }, - "UpdateFirewallEncryptionConfigurationResponse": { - "base": null, - "refs": {} - }, - "UpdateFirewallPolicyChangeProtectionRequest": { - "base": null, - "refs": {} - }, - "UpdateFirewallPolicyChangeProtectionResponse": { - "base": null, - "refs": {} - }, - "UpdateFirewallPolicyRequest": { - "base": null, - "refs": {} - }, - "UpdateFirewallPolicyResponse": { - "base": null, - "refs": {} - }, - "UpdateLoggingConfigurationRequest": { - "base": null, - "refs": {} - }, - "UpdateLoggingConfigurationResponse": { - "base": null, - "refs": {} - }, - "UpdateProxyConfigurationRequest": { - "base": null, - "refs": {} - }, - "UpdateProxyConfigurationResponse": { - "base": null, - "refs": {} - }, - "UpdateProxyRequest": { - "base": null, - "refs": {} - }, - "UpdateProxyResponse": { - "base": null, - "refs": {} - }, - "UpdateProxyRuleGroupPrioritiesRequest": { - "base": null, - "refs": {} - }, - "UpdateProxyRuleGroupPrioritiesResponse": { - "base": null, - "refs": {} - }, - "UpdateProxyRulePrioritiesRequest": { - "base": null, - "refs": {} - }, - "UpdateProxyRulePrioritiesResponse": { - "base": null, - "refs": {} - }, - "UpdateProxyRuleRequest": { - "base": null, - "refs": {} - }, - "UpdateProxyRuleResponse": { - "base": null, - "refs": {} - }, - "UpdateRuleGroupRequest": { - "base": null, - "refs": {} - }, - "UpdateRuleGroupResponse": { - "base": null, - "refs": {} - }, - "UpdateSubnetChangeProtectionRequest": { - "base": null, - "refs": {} - }, - "UpdateSubnetChangeProtectionResponse": { - "base": null, - "refs": {} - }, - "UpdateTLSInspectionConfigurationRequest": { - "base": null, - "refs": {} - }, - "UpdateTLSInspectionConfigurationResponse": { - "base": null, - "refs": {} - }, - "UpdateTime": { - "base": null, - "refs": { - "DescribeProxyResource$UpdateTime": "

Time the Proxy was updated.

", - "Proxy$UpdateTime": "

Time the Proxy was updated.

" - } - }, - "UpdateToken": { - "base": null, - "refs": { - "AssociateAvailabilityZonesRequest$UpdateToken": "

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

", - "AssociateAvailabilityZonesResponse$UpdateToken": "

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

", - "AssociateFirewallPolicyRequest$UpdateToken": "

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

", - "AssociateFirewallPolicyResponse$UpdateToken": "

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

", - "AssociateSubnetsRequest$UpdateToken": "

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

", - "AssociateSubnetsResponse$UpdateToken": "

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

", - "AttachRuleGroupsToProxyConfigurationRequest$UpdateToken": "

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy configuration. The token marks the state of the proxy configuration resource at the time of the request.

To make changes to the proxy configuration, you provide the token in your request. Network Firewall uses the token to ensure that the proxy configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

", - "AttachRuleGroupsToProxyConfigurationResponse$UpdateToken": "

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy configuration. The token marks the state of the proxy configuration resource at the time of the request.

To make changes to the proxy configuration, you provide the token in your request. Network Firewall uses the token to ensure that the proxy configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

", - "CreateContainerAssociationResponse$UpdateToken": "

A token used for optimistic locking. Network Firewall returns a token to your requests that access the container association. The token marks the state of the container association resource at the time of the request. To make an update to the container association, provide the token in your request. Network Firewall uses the token to ensure that the container association hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the container association again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

", - "CreateFirewallPolicyResponse$UpdateToken": "

A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request.

To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token.

", - "CreateProxyConfigurationResponse$UpdateToken": "

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy configuration. The token marks the state of the proxy configuration resource at the time of the request.

To make changes to the proxy configuration, you provide the token in your request. Network Firewall uses the token to ensure that the proxy configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

", - "CreateProxyResponse$UpdateToken": "

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy. The token marks the state of the proxy resource at the time of the request.

To make changes to the proxy, you provide the token in your request. Network Firewall uses the token to ensure that the proxy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

", - "CreateProxyRuleGroupResponse$UpdateToken": "

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule group. The token marks the state of the proxy rule group resource at the time of the request.

To make changes to the proxy rule group, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

", - "CreateProxyRulesResponse$UpdateToken": "

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule. The token marks the state of the proxy rule resource at the time of the request.

To make changes to the proxy rule, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy rule again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

", - "CreateRuleGroupResponse$UpdateToken": "

A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.

To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

", - "CreateTLSInspectionConfigurationResponse$UpdateToken": "

A token used for optimistic locking. Network Firewall returns a token to your requests that access the TLS inspection configuration. The token marks the state of the TLS inspection configuration resource at the time of the request.

To make changes to the TLS inspection configuration, you provide the token in your request. Network Firewall uses the token to ensure that the TLS inspection configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the TLS inspection configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

", - "DescribeContainerAssociationResponse$UpdateToken": "

A token used for optimistic locking. Network Firewall returns a token to your requests that access the container association. The token marks the state of the container association resource at the time of the request.

", - "DescribeFirewallPolicyResponse$UpdateToken": "

A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request.

To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token.

", - "DescribeFirewallResponse$UpdateToken": "

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

", - "DescribeProxyConfigurationResponse$UpdateToken": "

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy configuration. The token marks the state of the proxy configuration resource at the time of the request.

To make changes to the proxy configuration, you provide the token in your request. Network Firewall uses the token to ensure that the proxy configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

", - "DescribeProxyResponse$UpdateToken": "

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy. The token marks the state of the proxy resource at the time of the request.

To make changes to the proxy, you provide the token in your request. Network Firewall uses the token to ensure that the proxy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

", - "DescribeProxyRuleGroupResponse$UpdateToken": "

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule group. The token marks the state of the proxy rule group resource at the time of the request.

To make changes to the proxy rule group, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

", - "DescribeProxyRuleResponse$UpdateToken": "

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule. The token marks the state of the proxy rule resource at the time of the request.

To make changes to the proxy rule, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy rule again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

", - "DescribeRuleGroupResponse$UpdateToken": "

A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.

To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

", - "DescribeTLSInspectionConfigurationResponse$UpdateToken": "

A token used for optimistic locking. Network Firewall returns a token to your requests that access the TLS inspection configuration. The token marks the state of the TLS inspection configuration resource at the time of the request.

To make changes to the TLS inspection configuration, you provide the token in your request. Network Firewall uses the token to ensure that the TLS inspection configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the TLS inspection configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

", - "DetachRuleGroupsFromProxyConfigurationRequest$UpdateToken": "

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy configuration. The token marks the state of the proxy configuration resource at the time of the request.

To make changes to the proxy configuration, you provide the token in your request. Network Firewall uses the token to ensure that the proxy configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

", - "DetachRuleGroupsFromProxyConfigurationResponse$UpdateToken": "

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy configuration. The token marks the state of the proxy configuration resource at the time of the request.

To make changes to the proxy configuration, you provide the token in your request. Network Firewall uses the token to ensure that the proxy configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

", - "DisassociateAvailabilityZonesRequest$UpdateToken": "

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

", - "DisassociateAvailabilityZonesResponse$UpdateToken": "

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

", - "DisassociateSubnetsRequest$UpdateToken": "

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

", - "DisassociateSubnetsResponse$UpdateToken": "

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

", - "PerObjectStatus$UpdateToken": "

The current version of the object that is either in sync or pending synchronization.

", - "SourceMetadata$SourceUpdateToken": "

The update token of the Amazon Web Services managed rule group that your own rule group is copied from. To determine the update token for the managed rule group, call DescribeRuleGroup.

", - "UpdateAvailabilityZoneChangeProtectionRequest$UpdateToken": "

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

", - "UpdateAvailabilityZoneChangeProtectionResponse$UpdateToken": "

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

", - "UpdateContainerAssociationRequest$UpdateToken": "

A token used for optimistic locking. Network Firewall returns a token to your requests that access the container association. The token marks the state of the container association resource at the time of the request. To make an update to the container association, provide the token in your request. Network Firewall uses the token to ensure that the container association hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the container association again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

", - "UpdateContainerAssociationResponse$UpdateToken": "

A token used for optimistic locking. Network Firewall returns a token to your requests that access the container association. The token marks the state of the container association resource at the time of the request.

", - "UpdateFirewallAnalysisSettingsRequest$UpdateToken": "

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

", - "UpdateFirewallAnalysisSettingsResponse$UpdateToken": "

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

", - "UpdateFirewallDeleteProtectionRequest$UpdateToken": "

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

", - "UpdateFirewallDeleteProtectionResponse$UpdateToken": "

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

", - "UpdateFirewallDescriptionRequest$UpdateToken": "

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

", - "UpdateFirewallDescriptionResponse$UpdateToken": "

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

", - "UpdateFirewallEncryptionConfigurationRequest$UpdateToken": "

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

", - "UpdateFirewallEncryptionConfigurationResponse$UpdateToken": "

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

", - "UpdateFirewallPolicyChangeProtectionRequest$UpdateToken": "

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

", - "UpdateFirewallPolicyChangeProtectionResponse$UpdateToken": "

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

", - "UpdateFirewallPolicyRequest$UpdateToken": "

A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request.

To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token.

", - "UpdateFirewallPolicyResponse$UpdateToken": "

A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request.

To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token.

", - "UpdateProxyConfigurationRequest$UpdateToken": "

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy configuration. The token marks the state of the proxy configuration resource at the time of the request.

To make changes to the proxy configuration, you provide the token in your request. Network Firewall uses the token to ensure that the proxy configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

", - "UpdateProxyConfigurationResponse$UpdateToken": "

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy configuration. The token marks the state of the proxy configuration resource at the time of the request.

To make changes to the proxy configuration, you provide the token in your request. Network Firewall uses the token to ensure that the proxy configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

", - "UpdateProxyRequest$UpdateToken": "

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy. The token marks the state of the proxy resource at the time of the request.

To make changes to the proxy, you provide the token in your request. Network Firewall uses the token to ensure that the proxy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

", - "UpdateProxyResponse$UpdateToken": "

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy. The token marks the state of the proxy resource at the time of the request.

To make changes to the proxy, you provide the token in your request. Network Firewall uses the token to ensure that the proxy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

", - "UpdateProxyRuleGroupPrioritiesRequest$UpdateToken": "

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy configuration. The token marks the state of the proxy configuration resource at the time of the request.

To make changes to the proxy configuration, you provide the token in your request. Network Firewall uses the token to ensure that the proxy configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

", - "UpdateProxyRuleGroupPrioritiesResponse$UpdateToken": "

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy configuration. The token marks the state of the proxy configuration resource at the time of the request.

To make changes to the proxy configuration, you provide the token in your request. Network Firewall uses the token to ensure that the proxy configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

", - "UpdateProxyRulePrioritiesRequest$UpdateToken": "

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule group. The token marks the state of the proxy rule group resource at the time of the request.

To make changes to the proxy rule group, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

", - "UpdateProxyRulePrioritiesResponse$UpdateToken": "

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule group. The token marks the state of the proxy rule group resource at the time of the request.

To make changes to the proxy rule group, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

", - "UpdateProxyRuleRequest$UpdateToken": "

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule. The token marks the state of the proxy rule resource at the time of the request.

To make changes to the proxy rule, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy rule again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

", - "UpdateProxyRuleResponse$UpdateToken": "

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule. The token marks the state of the proxy rule resource at the time of the request.

To make changes to the proxy rule, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy rule again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

", - "UpdateRuleGroupRequest$UpdateToken": "

A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.

To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

", - "UpdateRuleGroupResponse$UpdateToken": "

A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.

To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

", - "UpdateSubnetChangeProtectionRequest$UpdateToken": "

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

", - "UpdateSubnetChangeProtectionResponse$UpdateToken": "

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

", - "UpdateTLSInspectionConfigurationRequest$UpdateToken": "

A token used for optimistic locking. Network Firewall returns a token to your requests that access the TLS inspection configuration. The token marks the state of the TLS inspection configuration resource at the time of the request.

To make changes to the TLS inspection configuration, you provide the token in your request. Network Firewall uses the token to ensure that the TLS inspection configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the TLS inspection configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

", - "UpdateTLSInspectionConfigurationResponse$UpdateToken": "

A token used for optimistic locking. Network Firewall returns a token to your requests that access the TLS inspection configuration. The token marks the state of the TLS inspection configuration resource at the time of the request.

To make changes to the TLS inspection configuration, you provide the token in your request. Network Firewall uses the token to ensure that the TLS inspection configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the TLS inspection configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

" - } - }, - "VariableDefinition": { - "base": null, - "refs": { - "VariableDefinitionList$member": null - } - }, - "VariableDefinitionList": { - "base": null, - "refs": { - "IPSet$Definition": "

The list of IP addresses and address ranges, in CIDR notation.

", - "PortSet$Definition": "

The set of port ranges.

" - } - }, - "VendorName": { - "base": null, - "refs": { - "DescribeRuleGroupMetadataResponse$VendorName": "

The name of the Amazon Web Services Marketplace vendor that provides this rule group.

", - "RuleGroupMetadata$VendorName": "

The name of the Amazon Web Services Marketplace seller that provides this rule group.

" - } - }, - "VpcEndpointAssociation": { - "base": "

A VPC endpoint association defines a single subnet to use for a firewall endpoint for a Firewall. You can define VPC endpoint associations only in the Availability Zones that already have a subnet mapping defined in the Firewall resource.

You can retrieve the list of Availability Zones that are available for use by calling DescribeFirewallMetadata.

To manage firewall endpoints, first, in the Firewall specification, you specify a single VPC and one subnet for each of the Availability Zones where you want to use the firewall. Then you can define additional endpoints as VPC endpoint associations.

You can use VPC endpoint associations to expand the protections of the firewall as follows:

  • Protect multiple VPCs with a single firewall - You can use the firewall to protect other VPCs, either in your account or in accounts where the firewall is shared. You can only specify Availability Zones that already have a firewall endpoint defined in the Firewall subnet mappings.

  • Define multiple firewall endpoints for a VPC in an Availability Zone - You can create additional firewall endpoints for the VPC that you have defined in the firewall, in any Availability Zone that already has an endpoint defined in the Firewall subnet mappings. You can create multiple VPC endpoint associations for any other VPC where you use the firewall.

You can use Resource Access Manager to share a Firewall that you own with other accounts, which gives them the ability to use the firewall to create VPC endpoint associations. For information about sharing a firewall, see PutResourcePolicy in this guide and see Sharing Network Firewall resources in the Network Firewall Developer Guide.

The status of the VPC endpoint association, which indicates whether it's ready to filter network traffic, is provided in the corresponding VpcEndpointAssociationStatus. You can retrieve both the association and its status by calling DescribeVpcEndpointAssociation.

", - "refs": { - "CreateVpcEndpointAssociationResponse$VpcEndpointAssociation": "

The configuration settings for the VPC endpoint association. These settings include the firewall and the VPC and subnet to use for the firewall endpoint.

", - "DeleteVpcEndpointAssociationResponse$VpcEndpointAssociation": "

The configuration settings for the VPC endpoint association. These settings include the firewall and the VPC and subnet to use for the firewall endpoint.

", - "DescribeVpcEndpointAssociationResponse$VpcEndpointAssociation": "

The configuration settings for the VPC endpoint association. These settings include the firewall and the VPC and subnet to use for the firewall endpoint.

" - } - }, - "VpcEndpointAssociationMetadata": { - "base": "

High-level information about a VPC endpoint association, returned by ListVpcEndpointAssociations. You can use the information provided in the metadata to retrieve and manage a VPC endpoint association.

", - "refs": { - "VpcEndpointAssociations$member": null - } - }, - "VpcEndpointAssociationStatus": { - "base": "

Detailed information about the current status of a VpcEndpointAssociation. You can retrieve this by calling DescribeVpcEndpointAssociation and providing the VPC endpoint association ARN.

", - "refs": { - "CreateVpcEndpointAssociationResponse$VpcEndpointAssociationStatus": "

Detailed information about the current status of a VpcEndpointAssociation. You can retrieve this by calling DescribeVpcEndpointAssociation and providing the VPC endpoint association ARN.

", - "DeleteVpcEndpointAssociationResponse$VpcEndpointAssociationStatus": "

Detailed information about the current status of a VpcEndpointAssociation. You can retrieve this by calling DescribeVpcEndpointAssociation and providing the VPC endpoint association ARN.

", - "DescribeVpcEndpointAssociationResponse$VpcEndpointAssociationStatus": "

Detailed information about the current status of a VpcEndpointAssociation. You can retrieve this by calling DescribeVpcEndpointAssociation and providing the VPC endpoint association ARN.

" - } - }, - "VpcEndpointAssociations": { - "base": null, - "refs": { - "ListVpcEndpointAssociationsResponse$VpcEndpointAssociations": "

The VPC endpoint assocation metadata objects for the firewall that you specified. If you didn't specify a firewall, this is all VPC endpoint associations that you have defined.

Depending on your setting for max results and the number of firewalls you have, a single call might not be the full list.

" - } - }, - "VpcEndpointId": { - "base": null, - "refs": { - "DescribeFlowOperationRequest$VpcEndpointId": "

A unique identifier for the primary endpoint associated with a firewall.

", - "DescribeFlowOperationResponse$VpcEndpointId": "

A unique identifier for the primary endpoint associated with a firewall.

", - "ListFlowOperationResultsRequest$VpcEndpointId": "

A unique identifier for the primary endpoint associated with a firewall.

", - "ListFlowOperationResultsResponse$VpcEndpointId": "

", - "ListFlowOperationsRequest$VpcEndpointId": "

A unique identifier for the primary endpoint associated with a firewall.

", - "StartFlowCaptureRequest$VpcEndpointId": "

A unique identifier for the primary endpoint associated with a firewall.

", - "StartFlowFlushRequest$VpcEndpointId": "

A unique identifier for the primary endpoint associated with a firewall.

" - } - }, - "VpcEndpointServiceName": { - "base": null, - "refs": { - "DescribeProxyResource$VpcEndpointServiceName": "

The service endpoint created in the VPC.

" - } - }, - "VpcId": { - "base": null, - "refs": { - "CreateFirewallRequest$VpcId": "

The unique identifier of the VPC where Network Firewall should create the firewall.

You can't change this setting after you create the firewall.

", - "CreateVpcEndpointAssociationRequest$VpcId": "

The unique identifier of the VPC where you want to create a firewall endpoint.

", - "Firewall$VpcId": "

The unique identifier of the VPC where the firewall is in use.

", - "VpcEndpointAssociation$VpcId": "

The unique identifier of the VPC for the endpoint association.

", - "VpcIds$member": null - } - }, - "VpcIds": { - "base": null, - "refs": { - "ListFirewallsRequest$VpcIds": "

The unique identifiers of the VPCs that you want Network Firewall to retrieve the firewalls for. Leave this blank to retrieve all firewalls that you have defined.

" - } - } - } -} diff --git a/tools/code-generation/api-descriptions/network-firewall/2020-11-12/endpoint-bdd-1.json b/tools/code-generation/api-descriptions/network-firewall/2020-11-12/endpoint-bdd-1.json deleted file mode 100644 index 756709665b9c..000000000000 --- a/tools/code-generation/api-descriptions/network-firewall/2020-11-12/endpoint-bdd-1.json +++ /dev/null @@ -1,188 +0,0 @@ -{ - "version": "1.1", - "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" - } - }, - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - }, - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - }, - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "results": [ - { - "conditions": [], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://network-firewall-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": "https://network-firewall-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": "https://network-firewall.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": "https://network-firewall.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ], - "root": 2, - "nodeCount": 13, - "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" -} \ No newline at end of file diff --git a/tools/code-generation/api-descriptions/network-firewall/2020-11-12/endpoint-rule-set-1.json b/tools/code-generation/api-descriptions/network-firewall/2020-11-12/endpoint-rule-set-1.json deleted file mode 100644 index 080a83293070..000000000000 --- a/tools/code-generation/api-descriptions/network-firewall/2020-11-12/endpoint-rule-set-1.json +++ /dev/null @@ -1,314 +0,0 @@ -{ - "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": [ - { - "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" - }, - { - "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": [], - "endpoint": { - "url": "https://network-firewall-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "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": [], - "endpoint": { - "url": "https://network-firewall-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "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": [], - "endpoint": { - "url": "https://network-firewall.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://network-firewall.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] -} \ No newline at end of file diff --git a/tools/code-generation/api-descriptions/network-firewall/2020-11-12/endpoint-tests-1.json b/tools/code-generation/api-descriptions/network-firewall/2020-11-12/endpoint-tests-1.json deleted file mode 100644 index bd03d424e849..000000000000 --- a/tools/code-generation/api-descriptions/network-firewall/2020-11-12/endpoint-tests-1.json +++ /dev/null @@ -1,608 +0,0 @@ -{ - "testCases": [ - { - "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://network-firewall.af-south-1.amazonaws.com" - } - }, - "params": { - "Region": "af-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://network-firewall.ap-east-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://network-firewall.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://network-firewall.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://network-firewall.ap-northeast-3.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://network-firewall.ap-south-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://network-firewall.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://network-firewall.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://network-firewall.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://network-firewall-fips.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://network-firewall.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://network-firewall.eu-north-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://network-firewall.eu-south-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://network-firewall.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://network-firewall.eu-west-2.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://network-firewall.eu-west-3.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://network-firewall.me-south-1.amazonaws.com" - } - }, - "params": { - "Region": "me-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://network-firewall.sa-east-1.amazonaws.com" - } - }, - "params": { - "Region": "sa-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://network-firewall.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://network-firewall-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://network-firewall.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://network-firewall-fips.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://network-firewall.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://network-firewall-fips.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://network-firewall.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://network-firewall-fips.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://network-firewall-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://network-firewall.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://network-firewall-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://network-firewall-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://network-firewall.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://network-firewall.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://network-firewall.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://network-firewall-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://network-firewall.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://network-firewall-fips.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://network-firewall-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 disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://network-firewall.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://network-firewall-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 disabled", - "expect": { - "endpoint": { - "url": "https://network-firewall.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 disabled", - "expect": { - "endpoint": { - "url": "https://network-firewall-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 disabled", - "expect": { - "endpoint": { - "url": "https://network-firewall.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" -} \ No newline at end of file diff --git a/tools/code-generation/api-descriptions/network-firewall/2020-11-12/examples-1.json b/tools/code-generation/api-descriptions/network-firewall/2020-11-12/examples-1.json deleted file mode 100644 index 2fb77604d1be..000000000000 --- a/tools/code-generation/api-descriptions/network-firewall/2020-11-12/examples-1.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "version": "1.0", - "examples": {} -} diff --git a/tools/code-generation/api-descriptions/network-firewall/2020-11-12/paginators-1.json b/tools/code-generation/api-descriptions/network-firewall/2020-11-12/paginators-1.json deleted file mode 100644 index 94e57aef87e6..000000000000 --- a/tools/code-generation/api-descriptions/network-firewall/2020-11-12/paginators-1.json +++ /dev/null @@ -1,88 +0,0 @@ -{ - "pagination": { - "GetAnalysisReportResults": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "AnalysisReportResults" - }, - "ListAnalysisReports": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "AnalysisReports" - }, - "ListContainerAssociations": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "ContainerAssociations" - }, - "ListFirewallPolicies": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "FirewallPolicies" - }, - "ListFirewalls": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "Firewalls" - }, - "ListFlowOperationResults": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "Flows" - }, - "ListFlowOperations": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "FlowOperations" - }, - "ListProxies": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "Proxies" - }, - "ListProxyConfigurations": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "ProxyConfigurations" - }, - "ListProxyRuleGroups": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "ProxyRuleGroups" - }, - "ListRuleGroups": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "RuleGroups" - }, - "ListTLSInspectionConfigurations": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "TLSInspectionConfigurations" - }, - "ListTagsForResource": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "Tags" - }, - "ListVpcEndpointAssociations": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "VpcEndpointAssociations" - } - } -} diff --git a/tools/code-generation/api-descriptions/network-firewall/2020-11-12/service-2.json b/tools/code-generation/api-descriptions/network-firewall/2020-11-12/service-2.json deleted file mode 100644 index 23c59b3f63ef..000000000000 --- a/tools/code-generation/api-descriptions/network-firewall/2020-11-12/service-2.json +++ /dev/null @@ -1,7783 +0,0 @@ -{ - "version":"2.0", - "metadata":{ - "apiVersion":"2020-11-12", - "endpointPrefix":"network-firewall", - "jsonVersion":"1.0", - "protocol":"json", - "protocols":["json"], - "serviceAbbreviation":"Network Firewall", - "serviceFullName":"AWS Network Firewall", - "serviceId":"Network Firewall", - "signatureVersion":"v4", - "signingName":"network-firewall", - "targetPrefix":"NetworkFirewall_20201112", - "uid":"network-firewall-2020-11-12", - "auth":["aws.auth#sigv4"] - }, - "operations":{ - "AcceptNetworkFirewallTransitGatewayAttachment":{ - "name":"AcceptNetworkFirewallTransitGatewayAttachment", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AcceptNetworkFirewallTransitGatewayAttachmentRequest"}, - "output":{"shape":"AcceptNetworkFirewallTransitGatewayAttachmentResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Accepts a transit gateway attachment request for Network Firewall. When you accept the attachment request, Network Firewall creates the necessary routing components to enable traffic flow between the transit gateway and firewall endpoints.

You must accept a transit gateway attachment to complete the creation of a transit gateway-attached firewall, unless auto-accept is enabled on the transit gateway. After acceptance, use DescribeFirewall to verify the firewall status.

To reject an attachment instead of accepting it, use RejectNetworkFirewallTransitGatewayAttachment.

It can take several minutes for the attachment acceptance to complete and the firewall to become available.

" - }, - "AssociateAvailabilityZones":{ - "name":"AssociateAvailabilityZones", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AssociateAvailabilityZonesRequest"}, - "output":{"shape":"AssociateAvailabilityZonesResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InvalidTokenException"}, - {"shape":"InvalidOperationException"}, - {"shape":"InsufficientCapacityException"} - ], - "documentation":"

Associates the specified Availability Zones with a transit gateway-attached firewall. For each Availability Zone, Network Firewall creates a firewall endpoint to process traffic. You can specify one or more Availability Zones where you want to deploy the firewall.

After adding Availability Zones, you must update your transit gateway route tables to direct traffic through the new firewall endpoints. Use DescribeFirewall to monitor the status of the new endpoints.

" - }, - "AssociateFirewallPolicy":{ - "name":"AssociateFirewallPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AssociateFirewallPolicyRequest"}, - "output":{"shape":"AssociateFirewallPolicyResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InvalidTokenException"}, - {"shape":"InvalidOperationException"} - ], - "documentation":"

Associates a FirewallPolicy to a Firewall.

A firewall policy defines how to monitor and manage your VPC network traffic, using a collection of inspection rule groups and other settings. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.

" - }, - "AssociateSubnets":{ - "name":"AssociateSubnets", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AssociateSubnetsRequest"}, - "output":{"shape":"AssociateSubnetsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InvalidTokenException"}, - {"shape":"InvalidOperationException"}, - {"shape":"InsufficientCapacityException"} - ], - "documentation":"

Associates the specified subnets in the Amazon VPC to the firewall. You can specify one subnet for each of the Availability Zones that the VPC spans.

This request creates an Network Firewall firewall endpoint in each of the subnets. To enable the firewall's protections, you must also modify the VPC's route tables for each subnet's Availability Zone, to redirect the traffic that's coming into and going out of the zone through the firewall endpoint.

" - }, - "AttachRuleGroupsToProxyConfiguration":{ - "name":"AttachRuleGroupsToProxyConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AttachRuleGroupsToProxyConfigurationRequest"}, - "output":{"shape":"AttachRuleGroupsToProxyConfigurationResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Attaches ProxyRuleGroup resources to a ProxyConfiguration

A Proxy Configuration defines the monitoring and protection behavior for a Proxy. The details of the behavior are defined in the rule groups that you add to your configuration.

" - }, - "CreateContainerAssociation":{ - "name":"CreateContainerAssociation", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateContainerAssociationRequest"}, - "output":{"shape":"CreateContainerAssociationResponse"}, - "errors":[ - {"shape":"LimitExceededException"}, - {"shape":"InvalidRequestException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"}, - {"shape":"InsufficientCapacityException"} - ], - "documentation":"

Creates a container association for Network Firewall. A container association links container clusters (ECS or EKS) to Network Firewall, enabling dynamic IP resolution for firewall rules based on container attributes.

To manage a container association's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.

To retrieve information about container associations, use ListContainerAssociations and DescribeContainerAssociation.

" - }, - "CreateFirewall":{ - "name":"CreateFirewall", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateFirewallRequest"}, - "output":{"shape":"CreateFirewallResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"LimitExceededException"}, - {"shape":"InternalServerError"}, - {"shape":"ThrottlingException"}, - {"shape":"InsufficientCapacityException"}, - {"shape":"InvalidOperationException"} - ], - "documentation":"

Creates an Network Firewall Firewall and accompanying FirewallStatus for a VPC.

The firewall defines the configuration settings for an Network Firewall firewall. The settings that you can define at creation include the firewall policy, the subnets in your VPC to use for the firewall endpoints, and any tags that are attached to the firewall Amazon Web Services resource.

After you create a firewall, you can provide additional settings, like the logging configuration.

To update the settings for a firewall, you use the operations that apply to the settings themselves, for example UpdateLoggingConfiguration, AssociateSubnets, and UpdateFirewallDeleteProtection.

To manage a firewall's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.

To retrieve information about firewalls, use ListFirewalls and DescribeFirewall.

To generate a report on the last 30 days of traffic monitored by a firewall, use StartAnalysisReport.

" - }, - "CreateFirewallPolicy":{ - "name":"CreateFirewallPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateFirewallPolicyRequest"}, - "output":{"shape":"CreateFirewallPolicyResponse"}, - "errors":[ - {"shape":"LimitExceededException"}, - {"shape":"InvalidRequestException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"}, - {"shape":"InsufficientCapacityException"} - ], - "documentation":"

Creates the firewall policy for the firewall according to the specifications.

An Network Firewall firewall policy defines the behavior of a firewall, in a collection of stateless and stateful rule groups and other settings. You can use one firewall policy for multiple firewalls.

" - }, - "CreateProxy":{ - "name":"CreateProxy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateProxyRequest"}, - "output":{"shape":"CreateProxyResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"UnsupportedOperationException"}, - {"shape":"LimitExceededException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Creates an Network Firewall Proxy

Attaches a Proxy configuration to a NAT Gateway.

To manage a proxy's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.

To retrieve information about proxies, use ListProxies and DescribeProxy.

" - }, - "CreateProxyConfiguration":{ - "name":"CreateProxyConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateProxyConfigurationRequest"}, - "output":{"shape":"CreateProxyConfigurationResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"LimitExceededException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Creates an Network Firewall ProxyConfiguration

A Proxy Configuration defines the monitoring and protection behavior for a Proxy. The details of the behavior are defined in the rule groups that you add to your configuration.

To manage a proxy configuration's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.

To retrieve information about proxies, use ListProxyConfigurations and DescribeProxyConfiguration.

" - }, - "CreateProxyRuleGroup":{ - "name":"CreateProxyRuleGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateProxyRuleGroupRequest"}, - "output":{"shape":"CreateProxyRuleGroupResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"LimitExceededException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Creates an Network Firewall ProxyRuleGroup

Collections of related proxy filtering rules. Rule groups help you manage and reuse sets of rules across multiple proxy configurations.

To manage a proxy rule group's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.

To retrieve information about proxy rule groups, use ListProxyRuleGroups and DescribeProxyRuleGroup.

To retrieve information about individual proxy rules, use DescribeProxyRuleGroup and DescribeProxyRule.

" - }, - "CreateProxyRules":{ - "name":"CreateProxyRules", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateProxyRulesRequest"}, - "output":{"shape":"CreateProxyRulesResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Creates Network Firewall ProxyRule resources.

Attaches new proxy rule(s) to an existing proxy rule group.

To retrieve information about individual proxy rules, use DescribeProxyRuleGroup and DescribeProxyRule.

" - }, - "CreateRuleGroup":{ - "name":"CreateRuleGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateRuleGroupRequest"}, - "output":{"shape":"CreateRuleGroupResponse"}, - "errors":[ - {"shape":"LimitExceededException"}, - {"shape":"InvalidRequestException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"}, - {"shape":"InsufficientCapacityException"} - ], - "documentation":"

Creates the specified stateless or stateful rule group, which includes the rules for network traffic inspection, a capacity setting, and tags.

You provide your rule group specification in your request using either RuleGroup or Rules.

" - }, - "CreateTLSInspectionConfiguration":{ - "name":"CreateTLSInspectionConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateTLSInspectionConfigurationRequest"}, - "output":{"shape":"CreateTLSInspectionConfigurationResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"}, - {"shape":"LimitExceededException"}, - {"shape":"InsufficientCapacityException"} - ], - "documentation":"

Creates an Network Firewall TLS inspection configuration. Network Firewall uses TLS inspection configurations to decrypt your firewall's inbound and outbound SSL/TLS traffic. After decryption, Network Firewall inspects the traffic according to your firewall policy's stateful rules, and then re-encrypts it before sending it to its destination. You can enable inspection of your firewall's inbound traffic, outbound traffic, or both. To use TLS inspection with your firewall, you must first import or provision certificates using ACM, create a TLS inspection configuration, add that configuration to a new firewall policy, and then associate that policy with your firewall.

To update the settings for a TLS inspection configuration, use UpdateTLSInspectionConfiguration.

To manage a TLS inspection configuration's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.

To retrieve information about TLS inspection configurations, use ListTLSInspectionConfigurations and DescribeTLSInspectionConfiguration.

For more information about TLS inspection configurations, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.

" - }, - "CreateVpcEndpointAssociation":{ - "name":"CreateVpcEndpointAssociation", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateVpcEndpointAssociationRequest"}, - "output":{"shape":"CreateVpcEndpointAssociationResponse"}, - "errors":[ - {"shape":"LimitExceededException"}, - {"shape":"InvalidRequestException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"}, - {"shape":"InsufficientCapacityException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidOperationException"} - ], - "documentation":"

Creates a firewall endpoint for an Network Firewall firewall. This type of firewall endpoint is independent of the firewall endpoints that you specify in the Firewall itself, and you define it in addition to those endpoints after the firewall has been created. You can define a VPC endpoint association using a different VPC than the one you used in the firewall specifications.

" - }, - "DeleteContainerAssociation":{ - "name":"DeleteContainerAssociation", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteContainerAssociationRequest"}, - "output":{"shape":"DeleteContainerAssociationResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InvalidOperationException"} - ], - "documentation":"

Deletes the specified container association. When you delete a container association, Network Firewall stops monitoring the associated container clusters and removes the resolved IP addresses from firewall rules.

" - }, - "DeleteFirewall":{ - "name":"DeleteFirewall", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteFirewallRequest"}, - "output":{"shape":"DeleteFirewallResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"UnsupportedOperationException"}, - {"shape":"InvalidOperationException"} - ], - "documentation":"

Deletes the specified Firewall and its FirewallStatus. This operation requires the firewall's DeleteProtection flag to be FALSE. You can't revert this operation.

You can check whether a firewall is in use by reviewing the route tables for the Availability Zones where you have firewall subnet mappings. Retrieve the subnet mappings by calling DescribeFirewall. You define and update the route tables through Amazon VPC. As needed, update the route tables for the zones to remove the firewall endpoints. When the route tables no longer use the firewall endpoints, you can remove the firewall safely.

To delete a firewall, remove the delete protection if you need to using UpdateFirewallDeleteProtection, then delete the firewall by calling DeleteFirewall.

" - }, - "DeleteFirewallPolicy":{ - "name":"DeleteFirewallPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteFirewallPolicyRequest"}, - "output":{"shape":"DeleteFirewallPolicyResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"}, - {"shape":"UnsupportedOperationException"}, - {"shape":"InvalidOperationException"} - ], - "documentation":"

Deletes the specified FirewallPolicy.

" - }, - "DeleteNetworkFirewallTransitGatewayAttachment":{ - "name":"DeleteNetworkFirewallTransitGatewayAttachment", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteNetworkFirewallTransitGatewayAttachmentRequest"}, - "output":{"shape":"DeleteNetworkFirewallTransitGatewayAttachmentResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Deletes a transit gateway attachment from a Network Firewall. Either the firewall owner or the transit gateway owner can delete the attachment.

After you delete a transit gateway attachment, traffic will no longer flow through the firewall endpoints.

After you initiate the delete operation, use DescribeFirewall to monitor the deletion status.

" - }, - "DeleteProxy":{ - "name":"DeleteProxy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteProxyRequest"}, - "output":{"shape":"DeleteProxyResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"UnsupportedOperationException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Deletes the specified Proxy.

Detaches a Proxy configuration from a NAT Gateway.

" - }, - "DeleteProxyConfiguration":{ - "name":"DeleteProxyConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteProxyConfigurationRequest"}, - "output":{"shape":"DeleteProxyConfigurationResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Deletes the specified ProxyConfiguration.

" - }, - "DeleteProxyRuleGroup":{ - "name":"DeleteProxyRuleGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteProxyRuleGroupRequest"}, - "output":{"shape":"DeleteProxyRuleGroupResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Deletes the specified ProxyRuleGroup.

" - }, - "DeleteProxyRules":{ - "name":"DeleteProxyRules", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteProxyRulesRequest"}, - "output":{"shape":"DeleteProxyRulesResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Deletes the specified ProxyRule(s). currently attached to a ProxyRuleGroup

" - }, - "DeleteResourcePolicy":{ - "name":"DeleteResourcePolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteResourcePolicyRequest"}, - "output":{"shape":"DeleteResourcePolicyResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InvalidResourcePolicyException"} - ], - "documentation":"

Deletes a resource policy that you created in a PutResourcePolicy request.

" - }, - "DeleteRuleGroup":{ - "name":"DeleteRuleGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteRuleGroupRequest"}, - "output":{"shape":"DeleteRuleGroupResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"}, - {"shape":"UnsupportedOperationException"}, - {"shape":"InvalidOperationException"} - ], - "documentation":"

Deletes the specified RuleGroup.

" - }, - "DeleteTLSInspectionConfiguration":{ - "name":"DeleteTLSInspectionConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteTLSInspectionConfigurationRequest"}, - "output":{"shape":"DeleteTLSInspectionConfigurationResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InvalidOperationException"} - ], - "documentation":"

Deletes the specified TLSInspectionConfiguration.

" - }, - "DeleteVpcEndpointAssociation":{ - "name":"DeleteVpcEndpointAssociation", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteVpcEndpointAssociationRequest"}, - "output":{"shape":"DeleteVpcEndpointAssociationResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InvalidOperationException"} - ], - "documentation":"

Deletes the specified VpcEndpointAssociation.

You can check whether an endpoint association is in use by reviewing the route tables for the Availability Zones where you have the endpoint subnet mapping. You can retrieve the subnet mapping by calling DescribeVpcEndpointAssociation. You define and update the route tables through Amazon VPC. As needed, update the route tables for the Availability Zone to remove the firewall endpoint for the association. When the route tables no longer use the firewall endpoint, you can remove the endpoint association safely.

" - }, - "DescribeContainerAssociation":{ - "name":"DescribeContainerAssociation", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeContainerAssociationRequest"}, - "output":{"shape":"DescribeContainerAssociationResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Returns the properties of a container association.

" - }, - "DescribeFirewall":{ - "name":"DescribeFirewall", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeFirewallRequest"}, - "output":{"shape":"DescribeFirewallResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Returns the data objects for the specified firewall.

" - }, - "DescribeFirewallMetadata":{ - "name":"DescribeFirewallMetadata", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeFirewallMetadataRequest"}, - "output":{"shape":"DescribeFirewallMetadataResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Returns the high-level information about a firewall, including the Availability Zones where the Firewall is currently in use.

" - }, - "DescribeFirewallPolicy":{ - "name":"DescribeFirewallPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeFirewallPolicyRequest"}, - "output":{"shape":"DescribeFirewallPolicyResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"} - ], - "documentation":"

Returns the data objects for the specified firewall policy.

" - }, - "DescribeFlowOperation":{ - "name":"DescribeFlowOperation", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeFlowOperationRequest"}, - "output":{"shape":"DescribeFlowOperationResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Returns key information about a specific flow operation.

" - }, - "DescribeLoggingConfiguration":{ - "name":"DescribeLoggingConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeLoggingConfigurationRequest"}, - "output":{"shape":"DescribeLoggingConfigurationResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Returns the logging configuration for the specified firewall.

" - }, - "DescribeProxy":{ - "name":"DescribeProxy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeProxyRequest"}, - "output":{"shape":"DescribeProxyResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Returns the data objects for the specified proxy.

" - }, - "DescribeProxyConfiguration":{ - "name":"DescribeProxyConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeProxyConfigurationRequest"}, - "output":{"shape":"DescribeProxyConfigurationResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Returns the data objects for the specified proxy configuration.

" - }, - "DescribeProxyRule":{ - "name":"DescribeProxyRule", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeProxyRuleRequest"}, - "output":{"shape":"DescribeProxyRuleResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Returns the data objects for the specified proxy configuration for the specified proxy rule group.

" - }, - "DescribeProxyRuleGroup":{ - "name":"DescribeProxyRuleGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeProxyRuleGroupRequest"}, - "output":{"shape":"DescribeProxyRuleGroupResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Returns the data objects for the specified proxy rule group.

" - }, - "DescribeResourcePolicy":{ - "name":"DescribeResourcePolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeResourcePolicyRequest"}, - "output":{"shape":"DescribeResourcePolicyResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Retrieves a resource policy that you created in a PutResourcePolicy request.

" - }, - "DescribeRuleGroup":{ - "name":"DescribeRuleGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeRuleGroupRequest"}, - "output":{"shape":"DescribeRuleGroupResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"} - ], - "documentation":"

Returns the data objects for the specified rule group.

" - }, - "DescribeRuleGroupMetadata":{ - "name":"DescribeRuleGroupMetadata", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeRuleGroupMetadataRequest"}, - "output":{"shape":"DescribeRuleGroupMetadataResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"} - ], - "documentation":"

High-level information about a rule group, returned by operations like create and describe. You can use the information provided in the metadata to retrieve and manage a rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

" - }, - "DescribeRuleGroupSummary":{ - "name":"DescribeRuleGroupSummary", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeRuleGroupSummaryRequest"}, - "output":{"shape":"DescribeRuleGroupSummaryResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"} - ], - "documentation":"

Returns detailed information for a stateful rule group.

For active threat defense Amazon Web Services managed rule groups, this operation provides insight into the protections enabled by the rule group, based on Suricata rule metadata fields. Summaries are available for rule groups you manage and for active threat defense Amazon Web Services managed rule groups.

To modify how threat information appears in summaries, use the SummaryConfiguration parameter in UpdateRuleGroup.

" - }, - "DescribeTLSInspectionConfiguration":{ - "name":"DescribeTLSInspectionConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeTLSInspectionConfigurationRequest"}, - "output":{"shape":"DescribeTLSInspectionConfigurationResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Returns the data objects for the specified TLS inspection configuration.

" - }, - "DescribeVpcEndpointAssociation":{ - "name":"DescribeVpcEndpointAssociation", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeVpcEndpointAssociationRequest"}, - "output":{"shape":"DescribeVpcEndpointAssociationResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Returns the data object for the specified VPC endpoint association.

" - }, - "DetachRuleGroupsFromProxyConfiguration":{ - "name":"DetachRuleGroupsFromProxyConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DetachRuleGroupsFromProxyConfigurationRequest"}, - "output":{"shape":"DetachRuleGroupsFromProxyConfigurationResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Detaches ProxyRuleGroup resources from a ProxyConfiguration

A Proxy Configuration defines the monitoring and protection behavior for a Proxy. The details of the behavior are defined in the rule groups that you add to your configuration.

" - }, - "DisassociateAvailabilityZones":{ - "name":"DisassociateAvailabilityZones", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DisassociateAvailabilityZonesRequest"}, - "output":{"shape":"DisassociateAvailabilityZonesResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InvalidTokenException"}, - {"shape":"InvalidOperationException"} - ], - "documentation":"

Removes the specified Availability Zone associations from a transit gateway-attached firewall. This removes the firewall endpoints from these Availability Zones and stops traffic filtering in those zones. Before removing an Availability Zone, ensure you've updated your transit gateway route tables to redirect traffic appropriately.

If AvailabilityZoneChangeProtection is enabled, you must first disable it using UpdateAvailabilityZoneChangeProtection.

To verify the status of your Availability Zone changes, use DescribeFirewall.

" - }, - "DisassociateSubnets":{ - "name":"DisassociateSubnets", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DisassociateSubnetsRequest"}, - "output":{"shape":"DisassociateSubnetsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InvalidTokenException"}, - {"shape":"InvalidOperationException"} - ], - "documentation":"

Removes the specified subnet associations from the firewall. This removes the firewall endpoints from the subnets and removes any network filtering protections that the endpoints were providing.

" - }, - "GetAnalysisReportResults":{ - "name":"GetAnalysisReportResults", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetAnalysisReportResultsRequest"}, - "output":{"shape":"GetAnalysisReportResultsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

The results of a COMPLETED analysis report generated with StartAnalysisReport.

For more information, see AnalysisTypeReportResult.

" - }, - "ListAnalysisReports":{ - "name":"ListAnalysisReports", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListAnalysisReportsRequest"}, - "output":{"shape":"ListAnalysisReportsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Returns a list of all traffic analysis reports generated within the last 30 days.

" - }, - "ListContainerAssociations":{ - "name":"ListContainerAssociations", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListContainerAssociationsRequest"}, - "output":{"shape":"ListContainerAssociationsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Retrieves the metadata for the container associations that you have defined. You can optionally page through results.

" - }, - "ListFirewallPolicies":{ - "name":"ListFirewallPolicies", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListFirewallPoliciesRequest"}, - "output":{"shape":"ListFirewallPoliciesResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"} - ], - "documentation":"

Retrieves the metadata for the firewall policies that you have defined. Depending on your setting for max results and the number of firewall policies, a single call might not return the full list.

" - }, - "ListFirewalls":{ - "name":"ListFirewalls", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListFirewallsRequest"}, - "output":{"shape":"ListFirewallsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Retrieves the metadata for the firewalls that you have defined. If you provide VPC identifiers in your request, this returns only the firewalls for those VPCs.

Depending on your setting for max results and the number of firewalls, a single call might not return the full list.

" - }, - "ListFlowOperationResults":{ - "name":"ListFlowOperationResults", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListFlowOperationResultsRequest"}, - "output":{"shape":"ListFlowOperationResultsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Returns the results of a specific flow operation.

Flow operations let you manage the flows tracked in the flow table, also known as the firewall table.

A flow is network traffic that is monitored by a firewall, either by stateful or stateless rules. For traffic to be considered part of a flow, it must share Destination, DestinationPort, Direction, Protocol, Source, and SourcePort.

" - }, - "ListFlowOperations":{ - "name":"ListFlowOperations", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListFlowOperationsRequest"}, - "output":{"shape":"ListFlowOperationsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Returns a list of all flow operations ran in a specific firewall. You can optionally narrow the request scope by specifying the operation type or Availability Zone associated with a firewall's flow operations.

Flow operations let you manage the flows tracked in the flow table, also known as the firewall table.

A flow is network traffic that is monitored by a firewall, either by stateful or stateless rules. For traffic to be considered part of a flow, it must share Destination, DestinationPort, Direction, Protocol, Source, and SourcePort.

" - }, - "ListProxies":{ - "name":"ListProxies", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListProxiesRequest"}, - "output":{"shape":"ListProxiesResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Retrieves the metadata for the proxies that you have defined. Depending on your setting for max results and the number of proxies, a single call might not return the full list.

" - }, - "ListProxyConfigurations":{ - "name":"ListProxyConfigurations", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListProxyConfigurationsRequest"}, - "output":{"shape":"ListProxyConfigurationsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Retrieves the metadata for the proxy configuration that you have defined. Depending on your setting for max results and the number of proxy configurations, a single call might not return the full list.

" - }, - "ListProxyRuleGroups":{ - "name":"ListProxyRuleGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListProxyRuleGroupsRequest"}, - "output":{"shape":"ListProxyRuleGroupsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Retrieves the metadata for the proxy rule groups that you have defined. Depending on your setting for max results and the number of proxy rule groups, a single call might not return the full list.

" - }, - "ListRuleGroups":{ - "name":"ListRuleGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListRuleGroupsRequest"}, - "output":{"shape":"ListRuleGroupsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"} - ], - "documentation":"

Retrieves the metadata for the rule groups that you have defined. Depending on your setting for max results and the number of rule groups, a single call might not return the full list.

" - }, - "ListTLSInspectionConfigurations":{ - "name":"ListTLSInspectionConfigurations", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListTLSInspectionConfigurationsRequest"}, - "output":{"shape":"ListTLSInspectionConfigurationsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Retrieves the metadata for the TLS inspection configurations that you have defined. Depending on your setting for max results and the number of TLS inspection configurations, a single call might not return the full list.

" - }, - "ListTagsForResource":{ - "name":"ListTagsForResource", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListTagsForResourceRequest"}, - "output":{"shape":"ListTagsForResourceResponse"}, - "errors":[ - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidRequestException"} - ], - "documentation":"

Retrieves the tags associated with the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

You can tag the Amazon Web Services resources that you manage through Network Firewall: firewalls, firewall policies, and rule groups.

" - }, - "ListVpcEndpointAssociations":{ - "name":"ListVpcEndpointAssociations", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListVpcEndpointAssociationsRequest"}, - "output":{"shape":"ListVpcEndpointAssociationsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"} - ], - "documentation":"

Retrieves the metadata for the VPC endpoint associations that you have defined. If you specify a fireawll, this returns only the endpoint associations for that firewall.

Depending on your setting for max results and the number of associations, a single call might not return the full list.

" - }, - "PutResourcePolicy":{ - "name":"PutResourcePolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"PutResourcePolicyRequest"}, - "output":{"shape":"PutResourcePolicyResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InvalidResourcePolicyException"} - ], - "documentation":"

Creates or updates an IAM policy for your rule group, firewall policy, or firewall. Use this to share these resources between accounts. This operation works in conjunction with the Amazon Web Services Resource Access Manager (RAM) service to manage resource sharing for Network Firewall.

For information about using sharing with Network Firewall resources, see Sharing Network Firewall resources in the Network Firewall Developer Guide.

Use this operation to create or update a resource policy for your Network Firewall rule group, firewall policy, or firewall. In the resource policy, you specify the accounts that you want to share the Network Firewall resource with and the operations that you want the accounts to be able to perform.

When you add an account in the resource policy, you then run the following Resource Access Manager (RAM) operations to access and accept the shared resource.

For additional information about resource sharing using RAM, see Resource Access Manager User Guide.

" - }, - "RejectNetworkFirewallTransitGatewayAttachment":{ - "name":"RejectNetworkFirewallTransitGatewayAttachment", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RejectNetworkFirewallTransitGatewayAttachmentRequest"}, - "output":{"shape":"RejectNetworkFirewallTransitGatewayAttachmentResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Rejects a transit gateway attachment request for Network Firewall. When you reject the attachment request, Network Firewall cancels the creation of routing components between the transit gateway and firewall endpoints.

Only the transit gateway owner can reject the attachment. After rejection, no traffic will flow through the firewall endpoints for this attachment.

Use DescribeFirewall to monitor the rejection status. To accept the attachment instead of rejecting it, use AcceptNetworkFirewallTransitGatewayAttachment.

Once rejected, you cannot reverse this action. To establish connectivity, you must create a new transit gateway-attached firewall.

" - }, - "StartAnalysisReport":{ - "name":"StartAnalysisReport", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StartAnalysisReportRequest"}, - "output":{"shape":"StartAnalysisReportResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Generates a traffic analysis report for the timeframe and traffic type you specify.

For information on the contents of a traffic analysis report, see AnalysisReport.

" - }, - "StartFlowCapture":{ - "name":"StartFlowCapture", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StartFlowCaptureRequest"}, - "output":{"shape":"StartFlowCaptureResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Begins capturing the flows in a firewall, according to the filters you define. Captures are similar, but not identical to snapshots. Capture operations provide visibility into flows that are not closed and are tracked by a firewall's flow table. Unlike snapshots, captures are a time-boxed view.

A flow is network traffic that is monitored by a firewall, either by stateful or stateless rules. For traffic to be considered part of a flow, it must share Destination, DestinationPort, Direction, Protocol, Source, and SourcePort.

To avoid encountering operation limits, you should avoid starting captures with broad filters, like wide IP ranges. Instead, we recommend you define more specific criteria with FlowFilters, like narrow IP ranges, ports, or protocols.

" - }, - "StartFlowFlush":{ - "name":"StartFlowFlush", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StartFlowFlushRequest"}, - "output":{"shape":"StartFlowFlushResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Begins the flushing of traffic from the firewall, according to the filters you define. When the operation starts, impacted flows are temporarily marked as timed out before the Suricata engine prunes, or flushes, the flows from the firewall table.

While the flush completes, impacted flows are processed as midstream traffic. This may result in a temporary increase in midstream traffic metrics. We recommend that you double check your stream exception policy before you perform a flush operation.

" - }, - "TagResource":{ - "name":"TagResource", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"TagResourceRequest"}, - "output":{"shape":"TagResourceResponse"}, - "errors":[ - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidRequestException"} - ], - "documentation":"

Adds the specified tags to the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

You can tag the Amazon Web Services resources that you manage through Network Firewall: firewalls, firewall policies, and rule groups.

" - }, - "UntagResource":{ - "name":"UntagResource", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UntagResourceRequest"}, - "output":{"shape":"UntagResourceResponse"}, - "errors":[ - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidRequestException"} - ], - "documentation":"

Removes the tags with the specified keys from the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

You can manage tags for the Amazon Web Services resources that you manage through Network Firewall: firewalls, firewall policies, and rule groups.

" - }, - "UpdateAvailabilityZoneChangeProtection":{ - "name":"UpdateAvailabilityZoneChangeProtection", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateAvailabilityZoneChangeProtectionRequest"}, - "output":{"shape":"UpdateAvailabilityZoneChangeProtectionResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InvalidTokenException"}, - {"shape":"ResourceOwnerCheckException"} - ], - "documentation":"

Modifies the AvailabilityZoneChangeProtection setting for a transit gateway-attached firewall. When enabled, this setting prevents accidental changes to the firewall's Availability Zone configuration. This helps protect against disrupting traffic flow in production environments.

When enabled, you must disable this protection before using AssociateAvailabilityZones or DisassociateAvailabilityZones to modify the firewall's Availability Zone configuration.

" - }, - "UpdateContainerAssociation":{ - "name":"UpdateContainerAssociation", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateContainerAssociationRequest"}, - "output":{"shape":"UpdateContainerAssociationResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidRequestException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"}, - {"shape":"InvalidTokenException"} - ], - "documentation":"

Updates the properties of an existing container association. Use this to modify the container monitoring configurations or description.

" - }, - "UpdateFirewallAnalysisSettings":{ - "name":"UpdateFirewallAnalysisSettings", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateFirewallAnalysisSettingsRequest"}, - "output":{"shape":"UpdateFirewallAnalysisSettingsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InvalidTokenException"} - ], - "documentation":"

Enables specific types of firewall analysis on a specific firewall you define.

" - }, - "UpdateFirewallDeleteProtection":{ - "name":"UpdateFirewallDeleteProtection", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateFirewallDeleteProtectionRequest"}, - "output":{"shape":"UpdateFirewallDeleteProtectionResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InvalidTokenException"}, - {"shape":"ResourceOwnerCheckException"} - ], - "documentation":"

Modifies the flag, DeleteProtection, which indicates whether it is possible to delete the firewall. If the flag is set to TRUE, the firewall is protected against deletion. This setting helps protect against accidentally deleting a firewall that's in use.

" - }, - "UpdateFirewallDescription":{ - "name":"UpdateFirewallDescription", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateFirewallDescriptionRequest"}, - "output":{"shape":"UpdateFirewallDescriptionResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InvalidTokenException"} - ], - "documentation":"

Modifies the description for the specified firewall. Use the description to help you identify the firewall when you're working with it.

" - }, - "UpdateFirewallEncryptionConfiguration":{ - "name":"UpdateFirewallEncryptionConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateFirewallEncryptionConfigurationRequest"}, - "output":{"shape":"UpdateFirewallEncryptionConfigurationResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InvalidTokenException"}, - {"shape":"ResourceOwnerCheckException"} - ], - "documentation":"

A complex type that contains settings for encryption of your firewall resources.

" - }, - "UpdateFirewallPolicy":{ - "name":"UpdateFirewallPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateFirewallPolicyRequest"}, - "output":{"shape":"UpdateFirewallPolicyResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"}, - {"shape":"InvalidTokenException"} - ], - "documentation":"

Updates the properties of the specified firewall policy.

" - }, - "UpdateFirewallPolicyChangeProtection":{ - "name":"UpdateFirewallPolicyChangeProtection", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateFirewallPolicyChangeProtectionRequest"}, - "output":{"shape":"UpdateFirewallPolicyChangeProtectionResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InvalidTokenException"}, - {"shape":"ResourceOwnerCheckException"} - ], - "documentation":"

Modifies the flag, ChangeProtection, which indicates whether it is possible to change the firewall. If the flag is set to TRUE, the firewall is protected from changes. This setting helps protect against accidentally changing a firewall that's in use.

" - }, - "UpdateLoggingConfiguration":{ - "name":"UpdateLoggingConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateLoggingConfigurationRequest"}, - "output":{"shape":"UpdateLoggingConfigurationResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InvalidTokenException"}, - {"shape":"LogDestinationPermissionException"} - ], - "documentation":"

Sets the logging configuration for the specified firewall.

To change the logging configuration, retrieve the LoggingConfiguration by calling DescribeLoggingConfiguration, then change it and provide the modified object to this update call. You must change the logging configuration one LogDestinationConfig at a time inside the retrieved LoggingConfiguration object.

You can perform only one of the following actions in any call to UpdateLoggingConfiguration:

  • Create a new log destination object by adding a single LogDestinationConfig array element to LogDestinationConfigs.

  • Delete a log destination object by removing a single LogDestinationConfig array element from LogDestinationConfigs.

  • Change the LogDestination setting in a single LogDestinationConfig array element.

You can't change the LogDestinationType or LogType in a LogDestinationConfig. To change these settings, delete the existing LogDestinationConfig object and create a new one, using two separate calls to this update operation.

" - }, - "UpdateProxy":{ - "name":"UpdateProxy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateProxyRequest"}, - "output":{"shape":"UpdateProxyResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"UnsupportedOperationException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Updates the properties of the specified proxy.

" - }, - "UpdateProxyConfiguration":{ - "name":"UpdateProxyConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateProxyConfigurationRequest"}, - "output":{"shape":"UpdateProxyConfigurationResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Updates the properties of the specified proxy configuration.

" - }, - "UpdateProxyRule":{ - "name":"UpdateProxyRule", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateProxyRuleRequest"}, - "output":{"shape":"UpdateProxyRuleResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Updates the properties of the specified proxy rule.

" - }, - "UpdateProxyRuleGroupPriorities":{ - "name":"UpdateProxyRuleGroupPriorities", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateProxyRuleGroupPrioritiesRequest"}, - "output":{"shape":"UpdateProxyRuleGroupPrioritiesResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Updates proxy rule group priorities within a proxy configuration.

" - }, - "UpdateProxyRulePriorities":{ - "name":"UpdateProxyRulePriorities", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateProxyRulePrioritiesRequest"}, - "output":{"shape":"UpdateProxyRulePrioritiesResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"

Updates proxy rule priorities within a proxy rule group.

" - }, - "UpdateRuleGroup":{ - "name":"UpdateRuleGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateRuleGroupRequest"}, - "output":{"shape":"UpdateRuleGroupResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidRequestException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"}, - {"shape":"InvalidTokenException"} - ], - "documentation":"

Updates the rule settings for the specified rule group. You use a rule group by reference in one or more firewall policies. When you modify a rule group, you modify all firewall policies that use the rule group.

To update a rule group, first call DescribeRuleGroup to retrieve the current RuleGroup object, update the object as needed, and then provide the updated object to this call.

" - }, - "UpdateSubnetChangeProtection":{ - "name":"UpdateSubnetChangeProtection", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateSubnetChangeProtectionRequest"}, - "output":{"shape":"UpdateSubnetChangeProtectionResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalServerError"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InvalidTokenException"}, - {"shape":"ResourceOwnerCheckException"} - ], - "documentation":"

" - }, - "UpdateTLSInspectionConfiguration":{ - "name":"UpdateTLSInspectionConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateTLSInspectionConfigurationRequest"}, - "output":{"shape":"UpdateTLSInspectionConfigurationResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerError"}, - {"shape":"InvalidTokenException"} - ], - "documentation":"

Updates the TLS inspection configuration settings for the specified TLS inspection configuration. You use a TLS inspection configuration by referencing it in one or more firewall policies. When you modify a TLS inspection configuration, you modify all firewall policies that use the TLS inspection configuration.

To update a TLS inspection configuration, first call DescribeTLSInspectionConfiguration to retrieve the current TLSInspectionConfiguration object, update the object as needed, and then provide the updated object to this call.

" - } - }, - "shapes":{ - "AWSAccountId":{ - "type":"string", - "max":12, - "min":12, - "pattern":"^\\d{12}$" - }, - "AZSyncState":{ - "type":"structure", - "members":{ - "Attachment":{"shape":"Attachment"} - }, - "documentation":"

The status of the firewall endpoint defined by a VpcEndpointAssociation.

" - }, - "AcceptNetworkFirewallTransitGatewayAttachmentRequest":{ - "type":"structure", - "required":["TransitGatewayAttachmentId"], - "members":{ - "TransitGatewayAttachmentId":{ - "shape":"TransitGatewayAttachmentId", - "documentation":"

Required. The unique identifier of the transit gateway attachment to accept. This ID is returned in the response when creating a transit gateway-attached firewall.

" - } - } - }, - "AcceptNetworkFirewallTransitGatewayAttachmentResponse":{ - "type":"structure", - "required":[ - "TransitGatewayAttachmentId", - "TransitGatewayAttachmentStatus" - ], - "members":{ - "TransitGatewayAttachmentId":{ - "shape":"TransitGatewayAttachmentId", - "documentation":"

The unique identifier of the transit gateway attachment that was accepted.

" - }, - "TransitGatewayAttachmentStatus":{ - "shape":"TransitGatewayAttachmentStatus", - "documentation":"

The current status of the transit gateway attachment. Valid values are:

  • CREATING - The attachment is being created

  • DELETING - The attachment is being deleted

  • DELETED - The attachment has been deleted

  • FAILED - The attachment creation has failed and cannot be recovered

  • ERROR - The attachment is in an error state that might be recoverable

  • READY - The attachment is active and processing traffic

  • PENDING_ACCEPTANCE - The attachment is waiting to be accepted

  • REJECTING - The attachment is in the process of being rejected

  • REJECTED - The attachment has been rejected

" - } - } - }, - "ActionDefinition":{ - "type":"structure", - "members":{ - "PublishMetricAction":{ - "shape":"PublishMetricAction", - "documentation":"

Stateless inspection criteria that publishes the specified metrics to Amazon CloudWatch for the matching packet. This setting defines a CloudWatch dimension value to be published.

You can pair this custom action with any of the standard stateless rule actions. For example, you could pair this in a rule action with the standard action that forwards the packet for stateful inspection. Then, when a packet matches the rule, Network Firewall publishes metrics for the packet and forwards it.

" - } - }, - "documentation":"

A custom action to use in stateless rule actions settings. This is used in CustomAction.

" - }, - "ActionName":{ - "type":"string", - "max":128, - "min":1, - "pattern":"^[a-zA-Z0-9]+$" - }, - "Address":{ - "type":"structure", - "required":["AddressDefinition"], - "members":{ - "AddressDefinition":{ - "shape":"AddressDefinition", - "documentation":"

Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4 and IPv6.

Examples:

  • To configure Network Firewall to inspect for the IP address 192.0.2.44, specify 192.0.2.44/32.

  • To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

  • To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

  • To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

" - } - }, - "documentation":"

A single IP address specification. This is used in the MatchAttributes source and destination specifications.

" - }, - "AddressDefinition":{ - "type":"string", - "max":255, - "min":1, - "pattern":"^([a-fA-F\\d:\\.]+($|/\\d{1,3}))$" - }, - "Addresses":{ - "type":"list", - "member":{"shape":"Address"} - }, - "Age":{"type":"integer"}, - "AnalysisReport":{ - "type":"structure", - "members":{ - "AnalysisReportId":{ - "shape":"AnalysisReportId", - "documentation":"

The unique ID of the query that ran when you requested an analysis report.

" - }, - "AnalysisType":{ - "shape":"EnabledAnalysisType", - "documentation":"

The type of traffic that will be used to generate a report.

" - }, - "ReportTime":{ - "shape":"ReportTime", - "documentation":"

The date and time the analysis report was ran.

" - }, - "Status":{ - "shape":"Status", - "documentation":"

The status of the analysis report you specify. Statuses include RUNNING, COMPLETED, or FAILED.

" - } - }, - "documentation":"

A report that captures key activity from the last 30 days of network traffic monitored by your firewall.

You can generate up to one report per traffic type, per 30 day period. For example, when you successfully create an HTTP traffic report, you cannot create another HTTP traffic report until 30 days pass. Alternatively, if you generate a report that combines metrics on both HTTP and HTTPS traffic, you cannot create another report for either traffic type until 30 days pass.

" - }, - "AnalysisReportId":{ - "type":"string", - "max":128, - "min":1, - "pattern":"\\S+" - }, - "AnalysisReportNextToken":{ - "type":"string", - "max":1024, - "min":1 - }, - "AnalysisReportResults":{ - "type":"list", - "member":{"shape":"AnalysisTypeReportResult"} - }, - "AnalysisReports":{ - "type":"list", - "member":{"shape":"AnalysisReport"} - }, - "AnalysisResult":{ - "type":"structure", - "members":{ - "IdentifiedRuleIds":{ - "shape":"RuleIdList", - "documentation":"

The priority number of the stateless rules identified in the analysis.

" - }, - "IdentifiedType":{ - "shape":"IdentifiedType", - "documentation":"

The types of rule configurations that Network Firewall analyzes your rule groups for. Network Firewall analyzes stateless rule groups for the following types of rule configurations:

  • STATELESS_RULE_FORWARDING_ASYMMETRICALLY

    Cause: One or more stateless rules with the action pass or forward are forwarding traffic asymmetrically. Specifically, the rule's set of source IP addresses or their associated port numbers, don't match the set of destination IP addresses or their associated port numbers.

    To mitigate: Make sure that there's an existing return path. For example, if the rule allows traffic from source 10.1.0.0/24 to destination 20.1.0.0/24, you should allow return traffic from source 20.1.0.0/24 to destination 10.1.0.0/24.

  • STATELESS_RULE_CONTAINS_TCP_FLAGS

    Cause: At least one stateless rule with the action pass orforward contains TCP flags that are inconsistent in the forward and return directions.

    To mitigate: Prevent asymmetric routing issues caused by TCP flags by following these actions:

    • Remove unnecessary TCP flag inspections from the rules.

    • If you need to inspect TCP flags, check that the rules correctly account for changes in TCP flags throughout the TCP connection cycle, for example SYN and ACK flags used in a 3-way TCP handshake.

" - }, - "AnalysisDetail":{ - "shape":"CollectionMember_String", - "documentation":"

Provides analysis details for the identified rule.

" - } - }, - "documentation":"

The analysis result for Network Firewall's stateless rule group analyzer. Every time you call CreateRuleGroup, UpdateRuleGroup, or DescribeRuleGroup on a stateless rule group, Network Firewall analyzes the stateless rule groups in your account and identifies the rules that might adversely effect your firewall's functionality. For example, if Network Firewall detects a rule that's routing traffic asymmetrically, which impacts the service's ability to properly process traffic, the service includes the rule in a list of analysis results.

The AnalysisResult data type is not related to traffic analysis reports you generate using StartAnalysisReport. For information on traffic analysis report results, see AnalysisTypeReportResult.

" - }, - "AnalysisResultList":{ - "type":"list", - "member":{"shape":"AnalysisResult"} - }, - "AnalysisTypeReportResult":{ - "type":"structure", - "members":{ - "Protocol":{ - "shape":"CollectionMember_String", - "documentation":"

The type of traffic captured by the analysis report.

" - }, - "FirstAccessed":{ - "shape":"FirstAccessed", - "documentation":"

The date and time any domain was first accessed (within the last 30 day period).

" - }, - "LastAccessed":{ - "shape":"LastAccessed", - "documentation":"

The date and time any domain was last accessed (within the last 30 day period).

" - }, - "Domain":{ - "shape":"Domain", - "documentation":"

The most frequently accessed domains.

" - }, - "Hits":{ - "shape":"Hits", - "documentation":"

The number of attempts made to access a observed domain.

" - }, - "UniqueSources":{ - "shape":"UniqueSources", - "documentation":"

The number of unique source IP addresses that connected to a domain.

" - } - }, - "documentation":"

The results of a COMPLETED analysis report generated with StartAnalysisReport.

For an example of traffic analysis report results, see the response syntax of GetAnalysisReportResults.

" - }, - "AssociateAvailabilityZonesRequest":{ - "type":"structure", - "required":["AvailabilityZoneMappings"], - "members":{ - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

" - }, - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

" - }, - "FirewallName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "AvailabilityZoneMappings":{ - "shape":"AvailabilityZoneMappings", - "documentation":"

Required. The Availability Zones where you want to create firewall endpoints. You must specify at least one Availability Zone.

" - } - } - }, - "AssociateAvailabilityZonesResponse":{ - "type":"structure", - "members":{ - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

" - }, - "FirewallName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

" - }, - "AvailabilityZoneMappings":{ - "shape":"AvailabilityZoneMappings", - "documentation":"

The Availability Zones where Network Firewall created firewall endpoints. Each mapping specifies an Availability Zone where the firewall processes traffic.

" - }, - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

" - } - } - }, - "AssociateFirewallPolicyRequest":{ - "type":"structure", - "required":["FirewallPolicyArn"], - "members":{ - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

" - }, - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

" - }, - "FirewallName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "FirewallPolicyArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall policy.

" - } - } - }, - "AssociateFirewallPolicyResponse":{ - "type":"structure", - "members":{ - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

" - }, - "FirewallName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

" - }, - "FirewallPolicyArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall policy.

" - }, - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

" - } - } - }, - "AssociateSubnetsRequest":{ - "type":"structure", - "required":["SubnetMappings"], - "members":{ - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

" - }, - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

" - }, - "FirewallName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "SubnetMappings":{ - "shape":"SubnetMappings", - "documentation":"

The IDs of the subnets that you want to associate with the firewall.

" - } - } - }, - "AssociateSubnetsResponse":{ - "type":"structure", - "members":{ - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

" - }, - "FirewallName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

" - }, - "SubnetMappings":{ - "shape":"SubnetMappings", - "documentation":"

The IDs of the subnets that are associated with the firewall.

" - }, - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

" - } - } - }, - "AssociationSyncState":{ - "type":"map", - "key":{"shape":"AvailabilityZone"}, - "value":{"shape":"AZSyncState"} - }, - "AttachRuleGroupsToProxyConfigurationRequest":{ - "type":"structure", - "required":[ - "RuleGroups", - "UpdateToken" - ], - "members":{ - "ProxyConfigurationName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "ProxyConfigurationArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of a proxy configuration.

You must specify the ARN or the name, and you can specify both.

" - }, - "RuleGroups":{ - "shape":"ProxyRuleGroupAttachmentList", - "documentation":"

The proxy rule group(s) to attach to the proxy configuration

" - }, - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy configuration. The token marks the state of the proxy configuration resource at the time of the request.

To make changes to the proxy configuration, you provide the token in your request. Network Firewall uses the token to ensure that the proxy configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

" - } - } - }, - "AttachRuleGroupsToProxyConfigurationResponse":{ - "type":"structure", - "members":{ - "ProxyConfiguration":{ - "shape":"ProxyConfiguration", - "documentation":"

The updated proxy configuration resource that reflects the updates from the request.

" - }, - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy configuration. The token marks the state of the proxy configuration resource at the time of the request.

To make changes to the proxy configuration, you provide the token in your request. Network Firewall uses the token to ensure that the proxy configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

" - } - } - }, - "Attachment":{ - "type":"structure", - "members":{ - "SubnetId":{ - "shape":"AzSubnet", - "documentation":"

The unique identifier of the subnet that you've specified to be used for a firewall endpoint.

" - }, - "EndpointId":{ - "shape":"EndpointId", - "documentation":"

The identifier of the firewall endpoint that Network Firewall has instantiated in the subnet. You use this to identify the firewall endpoint in the VPC route tables, when you redirect the VPC traffic through the endpoint.

" - }, - "Status":{ - "shape":"AttachmentStatus", - "documentation":"

The current status of the firewall endpoint instantiation in the subnet.

When this value is READY, the endpoint is available to handle network traffic. Otherwise, this value reflects its state, for example CREATING or DELETING.

" - }, - "StatusMessage":{ - "shape":"StatusMessage", - "documentation":"

If Network Firewall fails to create or delete the firewall endpoint in the subnet, it populates this with the reason for the error or failure and how to resolve it. A FAILED status indicates a non-recoverable state, and a ERROR status indicates an issue that you can fix. Depending on the error, it can take as many as 15 minutes to populate this field. For more information about the causes for failiure or errors and solutions available for this field, see Troubleshooting firewall endpoint failures in the Network Firewall Developer Guide.

" - } - }, - "documentation":"

The definition and status of the firewall endpoint for a single subnet. In each configured subnet, Network Firewall instantiates a firewall endpoint to handle network traffic.

This data type is used for any firewall endpoint type:

  • For Firewall.SubnetMappings, this Attachment is part of the FirewallStatus sync states information. You define firewall subnets using CreateFirewall and AssociateSubnets.

  • For VpcEndpointAssociation, this Attachment is part of the VpcEndpointAssociationStatus sync states information. You define these subnets using CreateVpcEndpointAssociation.

" - }, - "AttachmentId":{"type":"string"}, - "AttachmentStatus":{ - "type":"string", - "enum":[ - "CREATING", - "DELETING", - "FAILED", - "ERROR", - "SCALING", - "READY" - ] - }, - "AvailabilityZone":{"type":"string"}, - "AvailabilityZoneMapping":{ - "type":"structure", - "required":["AvailabilityZone"], - "members":{ - "AvailabilityZone":{ - "shape":"AvailabilityZoneMappingString", - "documentation":"

The ID of the Availability Zone where the firewall endpoint is located. For example, us-east-2a. The Availability Zone must be in the same Region as the transit gateway.

" - } - }, - "documentation":"

Defines the mapping between an Availability Zone and a firewall endpoint for a transit gateway-attached firewall. Each mapping represents where the firewall can process traffic. You use these mappings when calling CreateFirewall, AssociateAvailabilityZones, and DisassociateAvailabilityZones.

To retrieve the current Availability Zone mappings for a firewall, use DescribeFirewall.

" - }, - "AvailabilityZoneMappingString":{ - "type":"string", - "max":128, - "min":1, - "pattern":"\\S+" - }, - "AvailabilityZoneMappings":{ - "type":"list", - "member":{"shape":"AvailabilityZoneMapping"} - }, - "AvailabilityZoneMetadata":{ - "type":"structure", - "members":{ - "IPAddressType":{ - "shape":"IPAddressType", - "documentation":"

The IP address type of the Firewall subnet in the Availability Zone. You can't change the IP address type after you create the subnet.

" - } - }, - "documentation":"

High-level information about an Availability Zone where the firewall has an endpoint defined.

" - }, - "AzSubnet":{ - "type":"string", - "max":128, - "min":1, - "pattern":"^subnet-[0-9a-f]+$" - }, - "AzSubnets":{ - "type":"list", - "member":{"shape":"AzSubnet"} - }, - "Boolean":{"type":"boolean"}, - "ByteCount":{"type":"long"}, - "CIDRCount":{ - "type":"integer", - "max":1000000, - "min":0 - }, - "CIDRSummary":{ - "type":"structure", - "members":{ - "AvailableCIDRCount":{ - "shape":"CIDRCount", - "documentation":"

The number of CIDR blocks available for use by the IP set references in a firewall.

" - }, - "UtilizedCIDRCount":{ - "shape":"CIDRCount", - "documentation":"

The number of CIDR blocks used by the IP set references in a firewall.

" - }, - "IPSetReferences":{ - "shape":"IPSetMetadataMap", - "documentation":"

The list of the IP set references used by a firewall.

" - } - }, - "documentation":"

Summarizes the CIDR blocks used by the IP set references in a firewall. Network Firewall calculates the number of CIDRs by taking an aggregated count of all CIDRs used by the IP sets you are referencing.

" - }, - "CapacityUsageSummary":{ - "type":"structure", - "members":{ - "CIDRs":{ - "shape":"CIDRSummary", - "documentation":"

Describes the capacity usage of the CIDR blocks used by the IP set references in a firewall.

" - } - }, - "documentation":"

The capacity usage summary of the resources used by the ReferenceSets in a firewall.

" - }, - "Certificates":{ - "type":"list", - "member":{"shape":"TlsCertificateData"} - }, - "CheckCertificateRevocationStatusActions":{ - "type":"structure", - "members":{ - "RevokedStatusAction":{ - "shape":"RevocationCheckAction", - "documentation":"

Configures how Network Firewall processes traffic when it determines that the certificate presented by the server in the SSL/TLS connection has a revoked status.

  • PASS - Allow the connection to continue, and pass subsequent packets to the stateful engine for inspection.

  • DROP - Network Firewall closes the connection and drops subsequent packets for that connection.

  • REJECT - Network Firewall sends a TCP reject packet back to your client. The service closes the connection and drops subsequent packets for that connection. REJECT is available only for TCP traffic.

" - }, - "UnknownStatusAction":{ - "shape":"RevocationCheckAction", - "documentation":"

Configures how Network Firewall processes traffic when it determines that the certificate presented by the server in the SSL/TLS connection has an unknown status, or a status that cannot be determined for any other reason, including when the service is unable to connect to the OCSP and CRL endpoints for the certificate.

  • PASS - Allow the connection to continue, and pass subsequent packets to the stateful engine for inspection.

  • DROP - Network Firewall closes the connection and drops subsequent packets for that connection.

  • REJECT - Network Firewall sends a TCP reject packet back to your client. The service closes the connection and drops subsequent packets for that connection. REJECT is available only for TCP traffic.

" - } - }, - "documentation":"

Defines the actions to take on the SSL/TLS connection if the certificate presented by the server in the connection has a revoked or unknown status.

" - }, - "CollectionMember_String":{"type":"string"}, - "ConditionKey":{"type":"string"}, - "ConditionOperator":{"type":"string"}, - "ConfigurationSyncState":{ - "type":"string", - "enum":[ - "PENDING", - "IN_SYNC", - "CAPACITY_CONSTRAINED" - ] - }, - "ContainerAssociationLastUpdatedTime":{"type":"timestamp"}, - "ContainerAssociationStatus":{ - "type":"string", - "enum":[ - "ACTIVE", - "CREATING", - "DELETING", - "UPDATING" - ] - }, - "ContainerAssociationSummary":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the container association.

" - }, - "Name":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the container association.

" - } - }, - "documentation":"

High-level information about a container association, returned by the ListContainerAssociations operation. You can use this information to retrieve the full details of a container association using DescribeContainerAssociation.

" - }, - "ContainerAssociations":{ - "type":"list", - "member":{"shape":"ContainerAssociationSummary"} - }, - "ContainerAttribute":{ - "type":"structure", - "required":[ - "Key", - "Value" - ], - "members":{ - "Key":{ - "shape":"ContainerAttributeKey", - "documentation":"

The key of the container attribute to filter on.

" - }, - "Value":{ - "shape":"ContainerAttributeValue", - "documentation":"

The value of the container attribute to filter on.

" - } - }, - "documentation":"

A key-value pair that defines a container attribute filter for a container monitoring configuration.

" - }, - "ContainerAttributeKey":{ - "type":"string", - "max":256, - "min":1, - "pattern":"\\S+" - }, - "ContainerAttributeValue":{ - "type":"string", - "max":256, - "min":1, - "pattern":"\\S+" - }, - "ContainerAttributes":{ - "type":"list", - "member":{"shape":"ContainerAttribute"} - }, - "ContainerMonitoringConfiguration":{ - "type":"structure", - "required":["ClusterArn"], - "members":{ - "ClusterArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the container cluster to monitor.

" - }, - "AttributeFilters":{ - "shape":"ContainerAttributes", - "documentation":"

A list of key-value pairs that filter which containers within the cluster are monitored. Only containers that match the specified attributes are included.

" - } - }, - "documentation":"

Defines a container cluster to monitor, along with optional attribute filters that narrow the scope of monitored containers within the cluster.

" - }, - "ContainerMonitoringConfigurations":{ - "type":"list", - "member":{"shape":"ContainerMonitoringConfiguration"} - }, - "ContainerMonitoringType":{ - "type":"string", - "enum":[ - "ECS", - "EKS" - ] - }, - "Count":{"type":"integer"}, - "CreateContainerAssociationRequest":{ - "type":"structure", - "required":[ - "ContainerAssociationName", - "Type", - "ContainerMonitoringConfigurations" - ], - "members":{ - "ContainerAssociationName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the container association. You can't change the name of a container association after you create it.

" - }, - "Description":{ - "shape":"Description", - "documentation":"

A description of the container association.

" - }, - "Type":{ - "shape":"ContainerMonitoringType", - "documentation":"

The type of container orchestration platform for the clusters in this association. Valid values are ECS and EKS. You can't change the type after creation.

" - }, - "ContainerMonitoringConfigurations":{ - "shape":"ContainerMonitoringConfigurations", - "documentation":"

The list of container monitoring configurations that define which clusters and container attributes to monitor.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The key:value pairs to associate with the resource.

" - } - } - }, - "CreateContainerAssociationResponse":{ - "type":"structure", - "members":{ - "ContainerAssociationName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the container association.

" - }, - "ContainerAssociationArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the container association.

" - }, - "Description":{ - "shape":"Description", - "documentation":"

A description of the container association.

" - }, - "Type":{ - "shape":"ContainerMonitoringType", - "documentation":"

The type of container orchestration platform. Either ECS or EKS.

" - }, - "ContainerMonitoringConfigurations":{ - "shape":"ContainerMonitoringConfigurations", - "documentation":"

The container monitoring configurations for this container association.

" - }, - "Status":{ - "shape":"ContainerAssociationStatus", - "documentation":"

The current status of the container association.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The key:value pairs associated with the resource.

" - }, - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

A token used for optimistic locking. Network Firewall returns a token to your requests that access the container association. The token marks the state of the container association resource at the time of the request. To make an update to the container association, provide the token in your request. Network Firewall uses the token to ensure that the container association hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the container association again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

" - } - } - }, - "CreateFirewallPolicyRequest":{ - "type":"structure", - "required":[ - "FirewallPolicyName", - "FirewallPolicy" - ], - "members":{ - "FirewallPolicyName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.

" - }, - "FirewallPolicy":{ - "shape":"FirewallPolicy", - "documentation":"

The rule groups and policy actions to use in the firewall policy.

" - }, - "Description":{ - "shape":"Description", - "documentation":"

A description of the firewall policy.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The key:value pairs to associate with the resource.

" - }, - "DryRun":{ - "shape":"Boolean", - "documentation":"

Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.

If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.

If set to FALSE, Network Firewall makes the requested changes to your resources.

" - }, - "EncryptionConfiguration":{ - "shape":"EncryptionConfiguration", - "documentation":"

A complex type that contains settings for encryption of your firewall policy resources.

" - } - } - }, - "CreateFirewallPolicyResponse":{ - "type":"structure", - "required":[ - "UpdateToken", - "FirewallPolicyResponse" - ], - "members":{ - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request.

To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token.

" - }, - "FirewallPolicyResponse":{ - "shape":"FirewallPolicyResponse", - "documentation":"

The high-level properties of a firewall policy. This, along with the FirewallPolicy, define the policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.

" - } - } - }, - "CreateFirewallRequest":{ - "type":"structure", - "required":[ - "FirewallName", - "FirewallPolicyArn" - ], - "members":{ - "FirewallName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

" - }, - "FirewallPolicyArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the FirewallPolicy that you want to use for the firewall.

" - }, - "VpcId":{ - "shape":"VpcId", - "documentation":"

The unique identifier of the VPC where Network Firewall should create the firewall.

You can't change this setting after you create the firewall.

" - }, - "SubnetMappings":{ - "shape":"SubnetMappings", - "documentation":"

The public subnets to use for your Network Firewall firewalls. Each subnet must belong to a different Availability Zone in the VPC. Network Firewall creates a firewall endpoint in each subnet.

" - }, - "DeleteProtection":{ - "shape":"Boolean", - "documentation":"

A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE.

" - }, - "SubnetChangeProtection":{ - "shape":"Boolean", - "documentation":"

A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

" - }, - "FirewallPolicyChangeProtection":{ - "shape":"Boolean", - "documentation":"

A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

" - }, - "Description":{ - "shape":"Description", - "documentation":"

A description of the firewall.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The key:value pairs to associate with the resource.

" - }, - "EncryptionConfiguration":{ - "shape":"EncryptionConfiguration", - "documentation":"

A complex type that contains settings for encryption of your firewall resources.

" - }, - "EnabledAnalysisTypes":{ - "shape":"EnabledAnalysisTypes", - "documentation":"

An optional setting indicating the specific traffic analysis types to enable on the firewall.

" - }, - "TransitGatewayId":{ - "shape":"TransitGatewayId", - "documentation":"

Required when creating a transit gateway-attached firewall. The unique identifier of the transit gateway to attach to this firewall. You can provide either a transit gateway from your account or one that has been shared with you through Resource Access Manager.

After creating the firewall, you cannot change the transit gateway association. To use a different transit gateway, you must create a new firewall.

For information about creating firewalls, see CreateFirewall. For specific guidance about transit gateway-attached firewalls, see Considerations for transit gateway-attached firewalls in the Network Firewall Developer Guide.

" - }, - "AvailabilityZoneMappings":{ - "shape":"AvailabilityZoneMappings", - "documentation":"

Required. The Availability Zones where you want to create firewall endpoints for a transit gateway-attached firewall. You must specify at least one Availability Zone. Consider enabling the firewall in every Availability Zone where you have workloads to maintain Availability Zone isolation.

You can modify Availability Zones later using AssociateAvailabilityZones or DisassociateAvailabilityZones, but this may briefly disrupt traffic. The AvailabilityZoneChangeProtection setting controls whether you can make these modifications.

" - }, - "AvailabilityZoneChangeProtection":{ - "shape":"Boolean", - "documentation":"

Optional. A setting indicating whether the firewall is protected against changes to its Availability Zone configuration. When set to TRUE, you cannot add or remove Availability Zones without first disabling this protection using UpdateAvailabilityZoneChangeProtection.

Default value: FALSE

" - } - } - }, - "CreateFirewallResponse":{ - "type":"structure", - "members":{ - "Firewall":{ - "shape":"Firewall", - "documentation":"

The configuration settings for the firewall. These settings include the firewall policy and the subnets in your VPC to use for the firewall endpoints.

" - }, - "FirewallStatus":{ - "shape":"FirewallStatus", - "documentation":"

Detailed information about the current status of a Firewall. You can retrieve this for a firewall by calling DescribeFirewall and providing the firewall name and ARN.

The firewall status indicates a combined status. It indicates whether all subnets are up-to-date with the latest firewall configurations, which is based on the sync states config values, and also whether all subnets have their endpoints fully enabled, based on their sync states attachment values.

" - } - } - }, - "CreateProxyConfigurationRequest":{ - "type":"structure", - "required":[ - "ProxyConfigurationName", - "DefaultRulePhaseActions" - ], - "members":{ - "ProxyConfigurationName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.

" - }, - "Description":{ - "shape":"Description", - "documentation":"

A description of the proxy configuration.

" - }, - "RuleGroupNames":{ - "shape":"ResourceNameList", - "documentation":"

The proxy rule group name(s) to attach to the proxy configuration.

You must specify the ARNs or the names, and you can specify both.

" - }, - "RuleGroupArns":{ - "shape":"ResourceArnList", - "documentation":"

The proxy rule group arn(s) to attach to the proxy configuration.

You must specify the ARNs or the names, and you can specify both.

" - }, - "DefaultRulePhaseActions":{ - "shape":"ProxyConfigDefaultRulePhaseActionsRequest", - "documentation":"

Evaluation points in the traffic flow where rules are applied. There are three phases in a traffic where the rule match is applied.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The key:value pairs to associate with the resource.

" - } - } - }, - "CreateProxyConfigurationResponse":{ - "type":"structure", - "members":{ - "ProxyConfiguration":{ - "shape":"ProxyConfiguration", - "documentation":"

The properties that define the proxy configuration.

" - }, - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy configuration. The token marks the state of the proxy configuration resource at the time of the request.

To make changes to the proxy configuration, you provide the token in your request. Network Firewall uses the token to ensure that the proxy configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

" - } - } - }, - "CreateProxyRequest":{ - "type":"structure", - "required":[ - "ProxyName", - "NatGatewayId", - "TlsInterceptProperties" - ], - "members":{ - "ProxyName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy. You can't change the name of a proxy after you create it.

" - }, - "NatGatewayId":{ - "shape":"NatGatewayId", - "documentation":"

A unique identifier for the NAT gateway to use with proxy resources.

" - }, - "ProxyConfigurationName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "ProxyConfigurationArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of a proxy configuration.

You must specify the ARN or the name, and you can specify both.

" - }, - "ListenerProperties":{ - "shape":"ListenerPropertiesRequest", - "documentation":"

Listener properties for HTTP and HTTPS traffic.

" - }, - "TlsInterceptProperties":{ - "shape":"TlsInterceptPropertiesRequest", - "documentation":"

TLS decryption on traffic to filter on attributes in the HTTP header.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The key:value pairs to associate with the resource.

" - } - } - }, - "CreateProxyResponse":{ - "type":"structure", - "members":{ - "Proxy":{ - "shape":"Proxy", - "documentation":"

Proxy attached to a NAT gateway.

" - }, - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy. The token marks the state of the proxy resource at the time of the request.

To make changes to the proxy, you provide the token in your request. Network Firewall uses the token to ensure that the proxy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

" - } - } - }, - "CreateProxyRule":{ - "type":"structure", - "members":{ - "ProxyRuleName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy rule. You can't change the name of a proxy rule after you create it.

" - }, - "Description":{ - "shape":"Description", - "documentation":"

A description of the proxy rule.

" - }, - "Action":{ - "shape":"ProxyRulePhaseAction", - "documentation":"

Action to take.

" - }, - "Conditions":{ - "shape":"ProxyRuleConditionList", - "documentation":"

Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.

" - }, - "InsertPosition":{ - "shape":"InsertPosition", - "documentation":"

Where to insert a proxy rule in a proxy rule group.

" - } - }, - "documentation":"

Individual rules that define match conditions and actions for application-layer traffic. Rules specify what to inspect (domains, headers, methods) and what action to take (allow, deny, alert).

" - }, - "CreateProxyRuleGroupRequest":{ - "type":"structure", - "required":["ProxyRuleGroupName"], - "members":{ - "ProxyRuleGroupName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.

" - }, - "Description":{ - "shape":"Description", - "documentation":"

A description of the proxy rule group.

" - }, - "Rules":{ - "shape":"ProxyRulesByRequestPhase", - "documentation":"

Individual rules that define match conditions and actions for application-layer traffic. Rules specify what to inspect (domains, headers, methods) and what action to take (allow, deny, alert).

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The key:value pairs to associate with the resource.

" - } - } - }, - "CreateProxyRuleGroupResponse":{ - "type":"structure", - "members":{ - "ProxyRuleGroup":{ - "shape":"ProxyRuleGroup", - "documentation":"

The properties that define the proxy rule group.

" - }, - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule group. The token marks the state of the proxy rule group resource at the time of the request.

To make changes to the proxy rule group, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

" - } - } - }, - "CreateProxyRuleList":{ - "type":"list", - "member":{"shape":"CreateProxyRule"}, - "max":50, - "min":1 - }, - "CreateProxyRulesByRequestPhase":{ - "type":"structure", - "members":{ - "PreDNS":{ - "shape":"CreateProxyRuleList", - "documentation":"

Before domain resolution.

" - }, - "PreREQUEST":{ - "shape":"CreateProxyRuleList", - "documentation":"

After DNS, before request.

" - }, - "PostRESPONSE":{ - "shape":"CreateProxyRuleList", - "documentation":"

After receiving response.

" - } - }, - "documentation":"

Evaluation points in the traffic flow where rules are applied. There are three phases in a traffic where the rule match is applied.

This data type is used specifically for the CreateProxyRules API.

Pre-DNS - before domain resolution.

Pre-Request - after DNS, before request.

Post-Response - after receiving response.

" - }, - "CreateProxyRulesRequest":{ - "type":"structure", - "required":["Rules"], - "members":{ - "ProxyRuleGroupArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of a proxy rule group.

You must specify the ARN or the name, and you can specify both.

" - }, - "ProxyRuleGroupName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "Rules":{ - "shape":"CreateProxyRulesByRequestPhase", - "documentation":"

Individual rules that define match conditions and actions for application-layer traffic. Rules specify what to inspect (domains, headers, methods) and what action to take (allow, deny, alert).

" - } - } - }, - "CreateProxyRulesResponse":{ - "type":"structure", - "members":{ - "ProxyRuleGroup":{ - "shape":"ProxyRuleGroup", - "documentation":"

The properties that define the proxy rule group with the newly created proxy rule(s).

" - }, - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule. The token marks the state of the proxy rule resource at the time of the request.

To make changes to the proxy rule, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy rule again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

" - } - } - }, - "CreateRuleGroupRequest":{ - "type":"structure", - "required":[ - "RuleGroupName", - "Type", - "Capacity" - ], - "members":{ - "RuleGroupName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

" - }, - "RuleGroup":{ - "shape":"RuleGroup", - "documentation":"

An object that defines the rule group rules.

You must provide either this rule group setting or a Rules setting, but not both.

" - }, - "Rules":{ - "shape":"RulesString", - "documentation":"

A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups.

You must provide either this rules setting or a populated RuleGroup setting, but not both.

You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call response returns a RuleGroup object that Network Firewall has populated from your string.

" - }, - "Type":{ - "shape":"RuleGroupType", - "documentation":"

Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

" - }, - "Description":{ - "shape":"Description", - "documentation":"

A description of the rule group.

" - }, - "Capacity":{ - "shape":"RuleCapacity", - "documentation":"

The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.

You can retrieve the capacity that would be required for a rule group before you create the rule group by calling CreateRuleGroup with DryRun set to TRUE.

You can't change or exceed this capacity when you update the rule group, so leave room for your rule group to grow.

Capacity for a stateless rule group

For a stateless rule group, the capacity required is the sum of the capacity requirements of the individual rules that you expect to have in the rule group.

To calculate the capacity requirement of a single rule, multiply the capacity requirement values of each of the rule's match settings:

  • A match setting with no criteria specified has a value of 1.

  • A match setting with Any specified has a value of 1.

  • All other match settings have a value equal to the number of elements provided in the setting. For example, a protocol setting [\"UDP\"] and a source setting [\"10.0.0.0/24\"] each have a value of 1. A protocol setting [\"UDP\",\"TCP\"] has a value of 2. A source setting [\"10.0.0.0/24\",\"10.0.0.1/24\",\"10.0.0.2/24\"] has a value of 3.

A rule with no criteria specified in any of its match settings has a capacity requirement of 1. A rule with protocol setting [\"UDP\",\"TCP\"], source setting [\"10.0.0.0/24\",\"10.0.0.1/24\",\"10.0.0.2/24\"], and a single specification or no specification for each of the other match settings has a capacity requirement of 6.

Capacity for a stateful rule group

For a stateful rule group, the minimum capacity required is the number of individual rules that you expect to have in the rule group.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The key:value pairs to associate with the resource.

" - }, - "DryRun":{ - "shape":"Boolean", - "documentation":"

Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.

If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.

If set to FALSE, Network Firewall makes the requested changes to your resources.

" - }, - "EncryptionConfiguration":{ - "shape":"EncryptionConfiguration", - "documentation":"

A complex type that contains settings for encryption of your rule group resources.

" - }, - "SourceMetadata":{ - "shape":"SourceMetadata", - "documentation":"

A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to keep track of updates made to the originating rule group.

" - }, - "AnalyzeRuleGroup":{ - "shape":"Boolean", - "documentation":"

Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior such as asymmetric routing. If set to TRUE, Network Firewall runs the analysis and then creates the rule group for you. To run the stateless rule group analyzer without creating the rule group, set DryRun to TRUE.

" - }, - "SummaryConfiguration":{ - "shape":"SummaryConfiguration", - "documentation":"

An object that contains a RuleOptions array of strings. You use RuleOptions to determine which of the following RuleSummary values are returned in response to DescribeRuleGroupSummary.

  • Metadata - returns

  • Msg

  • SID

" - } - } - }, - "CreateRuleGroupResponse":{ - "type":"structure", - "required":[ - "UpdateToken", - "RuleGroupResponse" - ], - "members":{ - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.

To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

" - }, - "RuleGroupResponse":{ - "shape":"RuleGroupResponse", - "documentation":"

The high-level properties of a rule group. This, along with the RuleGroup, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

" - } - } - }, - "CreateTLSInspectionConfigurationRequest":{ - "type":"structure", - "required":[ - "TLSInspectionConfigurationName", - "TLSInspectionConfiguration" - ], - "members":{ - "TLSInspectionConfigurationName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.

" - }, - "TLSInspectionConfiguration":{ - "shape":"TLSInspectionConfiguration", - "documentation":"

The object that defines a TLS inspection configuration. This, along with TLSInspectionConfigurationResponse, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.

Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.

To use a TLS inspection configuration, you add it to a new Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect the traffic traveling through your firewalls. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.

" - }, - "Description":{ - "shape":"Description", - "documentation":"

A description of the TLS inspection configuration.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The key:value pairs to associate with the resource.

" - }, - "EncryptionConfiguration":{"shape":"EncryptionConfiguration"} - } - }, - "CreateTLSInspectionConfigurationResponse":{ - "type":"structure", - "required":[ - "UpdateToken", - "TLSInspectionConfigurationResponse" - ], - "members":{ - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

A token used for optimistic locking. Network Firewall returns a token to your requests that access the TLS inspection configuration. The token marks the state of the TLS inspection configuration resource at the time of the request.

To make changes to the TLS inspection configuration, you provide the token in your request. Network Firewall uses the token to ensure that the TLS inspection configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the TLS inspection configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

" - }, - "TLSInspectionConfigurationResponse":{ - "shape":"TLSInspectionConfigurationResponse", - "documentation":"

The high-level properties of a TLS inspection configuration. This, along with the TLSInspectionConfiguration, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.

" - } - } - }, - "CreateTime":{"type":"timestamp"}, - "CreateVpcEndpointAssociationRequest":{ - "type":"structure", - "required":[ - "FirewallArn", - "VpcId", - "SubnetMapping" - ], - "members":{ - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

" - }, - "VpcId":{ - "shape":"VpcId", - "documentation":"

The unique identifier of the VPC where you want to create a firewall endpoint.

" - }, - "SubnetMapping":{"shape":"SubnetMapping"}, - "Description":{ - "shape":"Description", - "documentation":"

A description of the VPC endpoint association.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The key:value pairs to associate with the resource.

" - } - } - }, - "CreateVpcEndpointAssociationResponse":{ - "type":"structure", - "members":{ - "VpcEndpointAssociation":{ - "shape":"VpcEndpointAssociation", - "documentation":"

The configuration settings for the VPC endpoint association. These settings include the firewall and the VPC and subnet to use for the firewall endpoint.

" - }, - "VpcEndpointAssociationStatus":{ - "shape":"VpcEndpointAssociationStatus", - "documentation":"

Detailed information about the current status of a VpcEndpointAssociation. You can retrieve this by calling DescribeVpcEndpointAssociation and providing the VPC endpoint association ARN.

" - } - } - }, - "CustomAction":{ - "type":"structure", - "required":[ - "ActionName", - "ActionDefinition" - ], - "members":{ - "ActionName":{ - "shape":"ActionName", - "documentation":"

The descriptive name of the custom action. You can't change the name of a custom action after you create it.

" - }, - "ActionDefinition":{ - "shape":"ActionDefinition", - "documentation":"

The custom action associated with the action name.

" - } - }, - "documentation":"

An optional, non-standard action to use for stateless packet handling. You can define this in addition to the standard action that you must specify.

You define and name the custom actions that you want to be able to use, and then you reference them by name in your actions settings.

You can use custom actions in the following places:

  • In a rule group's StatelessRulesAndCustomActions specification. The custom actions are available for use by name inside the StatelessRulesAndCustomActions where you define them. You can use them for your stateless rule actions to specify what to do with a packet that matches the rule's match attributes.

  • In a FirewallPolicy specification, in StatelessCustomActions. The custom actions are available for use inside the policy where you define them. You can use them for the policy's default stateless actions settings to specify what to do with packets that don't match any of the policy's stateless rules.

" - }, - "CustomActions":{ - "type":"list", - "member":{"shape":"CustomAction"} - }, - "DeepThreatInspection":{"type":"boolean"}, - "DeleteContainerAssociationRequest":{ - "type":"structure", - "members":{ - "ContainerAssociationName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the container association. You must specify the ARN or the name, and you can specify both.

" - }, - "ContainerAssociationArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the container association. You must specify the ARN or the name, and you can specify both.

" - } - } - }, - "DeleteContainerAssociationResponse":{ - "type":"structure", - "members":{ - "ContainerAssociationName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the container association.

" - }, - "ContainerAssociationArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the container association.

" - }, - "Status":{ - "shape":"ContainerAssociationStatus", - "documentation":"

The current status of the container association.

" - } - } - }, - "DeleteFirewallPolicyRequest":{ - "type":"structure", - "members":{ - "FirewallPolicyName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "FirewallPolicyArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall policy.

You must specify the ARN or the name, and you can specify both.

" - } - } - }, - "DeleteFirewallPolicyResponse":{ - "type":"structure", - "required":["FirewallPolicyResponse"], - "members":{ - "FirewallPolicyResponse":{ - "shape":"FirewallPolicyResponse", - "documentation":"

The object containing the definition of the FirewallPolicyResponse that you asked to delete.

" - } - } - }, - "DeleteFirewallRequest":{ - "type":"structure", - "members":{ - "FirewallName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

" - } - } - }, - "DeleteFirewallResponse":{ - "type":"structure", - "members":{ - "Firewall":{"shape":"Firewall"}, - "FirewallStatus":{"shape":"FirewallStatus"} - } - }, - "DeleteNetworkFirewallTransitGatewayAttachmentRequest":{ - "type":"structure", - "required":["TransitGatewayAttachmentId"], - "members":{ - "TransitGatewayAttachmentId":{ - "shape":"TransitGatewayAttachmentId", - "documentation":"

Required. The unique identifier of the transit gateway attachment to delete.

" - } - } - }, - "DeleteNetworkFirewallTransitGatewayAttachmentResponse":{ - "type":"structure", - "required":[ - "TransitGatewayAttachmentId", - "TransitGatewayAttachmentStatus" - ], - "members":{ - "TransitGatewayAttachmentId":{ - "shape":"TransitGatewayAttachmentId", - "documentation":"

The ID of the transit gateway attachment that was deleted.

" - }, - "TransitGatewayAttachmentStatus":{ - "shape":"TransitGatewayAttachmentStatus", - "documentation":"

The current status of the transit gateway attachment deletion process.

Valid values are:

  • CREATING - The attachment is being created

  • DELETING - The attachment is being deleted

  • DELETED - The attachment has been deleted

  • FAILED - The attachment creation has failed and cannot be recovered

  • ERROR - The attachment is in an error state that might be recoverable

  • READY - The attachment is active and processing traffic

  • PENDING_ACCEPTANCE - The attachment is waiting to be accepted

  • REJECTING - The attachment is in the process of being rejected

  • REJECTED - The attachment has been rejected

" - } - } - }, - "DeleteProxyConfigurationRequest":{ - "type":"structure", - "members":{ - "ProxyConfigurationName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "ProxyConfigurationArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of a proxy configuration.

You must specify the ARN or the name, and you can specify both.

" - } - } - }, - "DeleteProxyConfigurationResponse":{ - "type":"structure", - "members":{ - "ProxyConfigurationName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.

" - }, - "ProxyConfigurationArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of a proxy configuration.

" - } - } - }, - "DeleteProxyRequest":{ - "type":"structure", - "required":["NatGatewayId"], - "members":{ - "NatGatewayId":{ - "shape":"NatGatewayId", - "documentation":"

The NAT Gateway the proxy is attached to.

" - }, - "ProxyName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy. You can't change the name of a proxy after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "ProxyArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of a proxy.

You must specify the ARN or the name, and you can specify both.

" - } - } - }, - "DeleteProxyResponse":{ - "type":"structure", - "members":{ - "NatGatewayId":{ - "shape":"NatGatewayId", - "documentation":"

The NAT Gateway the Proxy was attached to.

" - }, - "ProxyName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy. You can't change the name of a proxy after you create it.

" - }, - "ProxyArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of a proxy.

" - } - } - }, - "DeleteProxyRuleGroupRequest":{ - "type":"structure", - "members":{ - "ProxyRuleGroupName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "ProxyRuleGroupArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of a proxy rule group.

You must specify the ARN or the name, and you can specify both.

" - } - } - }, - "DeleteProxyRuleGroupResponse":{ - "type":"structure", - "members":{ - "ProxyRuleGroupName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.

" - }, - "ProxyRuleGroupArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of a proxy rule group.

" - } - } - }, - "DeleteProxyRulesRequest":{ - "type":"structure", - "required":["Rules"], - "members":{ - "ProxyRuleGroupArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of a proxy rule group.

You must specify the ARN or the name, and you can specify both.

" - }, - "ProxyRuleGroupName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "Rules":{ - "shape":"ResourceNameList", - "documentation":"

The proxy rule(s) to remove from the existing proxy rule group.

" - } - } - }, - "DeleteProxyRulesResponse":{ - "type":"structure", - "members":{ - "ProxyRuleGroup":{ - "shape":"ProxyRuleGroup", - "documentation":"

The properties that define the proxy rule group with the newly created proxy rule(s).

" - } - } - }, - "DeleteResourcePolicyRequest":{ - "type":"structure", - "required":["ResourceArn"], - "members":{ - "ResourceArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the rule group or firewall policy whose resource policy you want to delete.

" - } - } - }, - "DeleteResourcePolicyResponse":{ - "type":"structure", - "members":{} - }, - "DeleteRuleGroupRequest":{ - "type":"structure", - "members":{ - "RuleGroupName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "RuleGroupArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the rule group.

You must specify the ARN or the name, and you can specify both.

" - }, - "Type":{ - "shape":"RuleGroupType", - "documentation":"

Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

This setting is required for requests that do not include the RuleGroupARN.

" - } - } - }, - "DeleteRuleGroupResponse":{ - "type":"structure", - "required":["RuleGroupResponse"], - "members":{ - "RuleGroupResponse":{ - "shape":"RuleGroupResponse", - "documentation":"

The high-level properties of a rule group. This, along with the RuleGroup, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

" - } - } - }, - "DeleteTLSInspectionConfigurationRequest":{ - "type":"structure", - "members":{ - "TLSInspectionConfigurationArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the TLS inspection configuration.

You must specify the ARN or the name, and you can specify both.

" - }, - "TLSInspectionConfigurationName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.

You must specify the ARN or the name, and you can specify both.

" - } - } - }, - "DeleteTLSInspectionConfigurationResponse":{ - "type":"structure", - "required":["TLSInspectionConfigurationResponse"], - "members":{ - "TLSInspectionConfigurationResponse":{ - "shape":"TLSInspectionConfigurationResponse", - "documentation":"

The high-level properties of a TLS inspection configuration. This, along with the TLSInspectionConfiguration, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.

" - } - } - }, - "DeleteTime":{"type":"timestamp"}, - "DeleteVpcEndpointAssociationRequest":{ - "type":"structure", - "required":["VpcEndpointAssociationArn"], - "members":{ - "VpcEndpointAssociationArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of a VPC endpoint association.

" - } - } - }, - "DeleteVpcEndpointAssociationResponse":{ - "type":"structure", - "members":{ - "VpcEndpointAssociation":{ - "shape":"VpcEndpointAssociation", - "documentation":"

The configuration settings for the VPC endpoint association. These settings include the firewall and the VPC and subnet to use for the firewall endpoint.

" - }, - "VpcEndpointAssociationStatus":{ - "shape":"VpcEndpointAssociationStatus", - "documentation":"

Detailed information about the current status of a VpcEndpointAssociation. You can retrieve this by calling DescribeVpcEndpointAssociation and providing the VPC endpoint association ARN.

" - } - } - }, - "DescribeContainerAssociationRequest":{ - "type":"structure", - "members":{ - "ContainerAssociationName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the container association. You must specify the ARN or the name, and you can specify both.

" - }, - "ContainerAssociationArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the container association. You must specify the ARN or the name, and you can specify both.

" - } - } - }, - "DescribeContainerAssociationResponse":{ - "type":"structure", - "members":{ - "ContainerAssociationName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the container association.

" - }, - "ContainerAssociationArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the container association.

" - }, - "Description":{ - "shape":"Description", - "documentation":"

A description of the container association.

" - }, - "Type":{ - "shape":"ContainerMonitoringType", - "documentation":"

The type of container orchestration platform. Either ECS or EKS.

" - }, - "ContainerMonitoringConfigurations":{ - "shape":"ContainerMonitoringConfigurations", - "documentation":"

The container monitoring configurations for this container association.

" - }, - "Status":{ - "shape":"ContainerAssociationStatus", - "documentation":"

The current status of the container association.

" - }, - "ResolvedCidrCount":{ - "shape":"CIDRCount", - "documentation":"

The number of CIDR blocks that have been resolved from the monitored containers for this container association.

" - }, - "LastUpdatedTime":{ - "shape":"ContainerAssociationLastUpdatedTime", - "documentation":"

The last time that the container association was updated or resolved new container IP addresses.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The key:value pairs associated with the resource.

" - }, - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

A token used for optimistic locking. Network Firewall returns a token to your requests that access the container association. The token marks the state of the container association resource at the time of the request.

" - } - } - }, - "DescribeFirewallMetadataRequest":{ - "type":"structure", - "members":{ - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

" - } - } - }, - "DescribeFirewallMetadataResponse":{ - "type":"structure", - "members":{ - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

" - }, - "FirewallPolicyArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall policy.

" - }, - "Description":{ - "shape":"Description", - "documentation":"

A description of the firewall.

" - }, - "Status":{ - "shape":"FirewallStatusValue", - "documentation":"

The readiness of the configured firewall to handle network traffic across all of the Availability Zones where you have it configured. This setting is READY only when the ConfigurationSyncStateSummary value is IN_SYNC and the Attachment Status values for all of the configured subnets are READY.

" - }, - "SupportedAvailabilityZones":{ - "shape":"SupportedAvailabilityZones", - "documentation":"

The Availability Zones that the firewall currently supports. This includes all Availability Zones for which the firewall has a subnet defined.

" - }, - "TransitGatewayAttachmentId":{ - "shape":"TransitGatewayAttachmentId", - "documentation":"

The unique identifier of the transit gateway attachment associated with this firewall. This field is only present for transit gateway-attached firewalls.

" - } - } - }, - "DescribeFirewallPolicyRequest":{ - "type":"structure", - "members":{ - "FirewallPolicyName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "FirewallPolicyArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall policy.

You must specify the ARN or the name, and you can specify both.

" - } - } - }, - "DescribeFirewallPolicyResponse":{ - "type":"structure", - "required":[ - "UpdateToken", - "FirewallPolicyResponse" - ], - "members":{ - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request.

To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token.

" - }, - "FirewallPolicyResponse":{ - "shape":"FirewallPolicyResponse", - "documentation":"

The high-level properties of a firewall policy. This, along with the FirewallPolicy, define the policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.

" - }, - "FirewallPolicy":{ - "shape":"FirewallPolicy", - "documentation":"

The policy for the specified firewall policy.

" - } - } - }, - "DescribeFirewallRequest":{ - "type":"structure", - "members":{ - "FirewallName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

" - } - } - }, - "DescribeFirewallResponse":{ - "type":"structure", - "members":{ - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

" - }, - "Firewall":{ - "shape":"Firewall", - "documentation":"

The configuration settings for the firewall. These settings include the firewall policy and the subnets in your VPC to use for the firewall endpoints.

" - }, - "FirewallStatus":{ - "shape":"FirewallStatus", - "documentation":"

Detailed information about the current status of a Firewall. You can retrieve this for a firewall by calling DescribeFirewall and providing the firewall name and ARN.

The firewall status indicates a combined status. It indicates whether all subnets are up-to-date with the latest firewall configurations, which is based on the sync states config values, and also whether all subnets have their endpoints fully enabled, based on their sync states attachment values.

" - } - } - }, - "DescribeFlowOperationRequest":{ - "type":"structure", - "required":[ - "FirewallArn", - "FlowOperationId" - ], - "members":{ - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

" - }, - "AvailabilityZone":{ - "shape":"AvailabilityZone", - "documentation":"

The ID of the Availability Zone where the firewall is located. For example, us-east-2a.

Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.

" - }, - "VpcEndpointAssociationArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of a VPC endpoint association.

" - }, - "VpcEndpointId":{ - "shape":"VpcEndpointId", - "documentation":"

A unique identifier for the primary endpoint associated with a firewall.

" - }, - "FlowOperationId":{ - "shape":"FlowOperationId", - "documentation":"

A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.

" - } - } - }, - "DescribeFlowOperationResponse":{ - "type":"structure", - "members":{ - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

" - }, - "AvailabilityZone":{ - "shape":"AvailabilityZone", - "documentation":"

The ID of the Availability Zone where the firewall is located. For example, us-east-2a.

Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.

" - }, - "VpcEndpointAssociationArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of a VPC endpoint association.

" - }, - "VpcEndpointId":{ - "shape":"VpcEndpointId", - "documentation":"

A unique identifier for the primary endpoint associated with a firewall.

" - }, - "FlowOperationId":{ - "shape":"FlowOperationId", - "documentation":"

A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.

" - }, - "FlowOperationType":{ - "shape":"FlowOperationType", - "documentation":"

Defines the type of FlowOperation.

" - }, - "FlowOperationStatus":{ - "shape":"FlowOperationStatus", - "documentation":"

Returns the status of the flow operation. This string is returned in the responses to start, list, and describe commands.

If the status is COMPLETED_WITH_ERRORS, results may be returned with any number of Flows missing from the response. If the status is FAILED, Flows returned will be empty.

" - }, - "StatusMessage":{ - "shape":"StatusReason", - "documentation":"

If the asynchronous operation fails, Network Firewall populates this with the reason for the error or failure. Options include Flow operation error and Flow timeout.

" - }, - "FlowRequestTimestamp":{ - "shape":"FlowRequestTimestamp", - "documentation":"

A timestamp indicating when the Suricata engine identified flows impacted by an operation.

" - }, - "FlowOperation":{ - "shape":"FlowOperation", - "documentation":"

Returns key information about a flow operation, such as related statuses, unique identifiers, and all filters defined in the operation.

" - } - } - }, - "DescribeLoggingConfigurationRequest":{ - "type":"structure", - "members":{ - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

" - }, - "FirewallName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

" - } - } - }, - "DescribeLoggingConfigurationResponse":{ - "type":"structure", - "members":{ - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

" - }, - "LoggingConfiguration":{"shape":"LoggingConfiguration"}, - "EnableMonitoringDashboard":{ - "shape":"EnableMonitoringDashboard", - "documentation":"

A boolean that reflects whether or not the firewall monitoring dashboard is enabled on a firewall.

Returns TRUE when the firewall monitoring dashboard is enabled on the firewall. Returns FALSE when the firewall monitoring dashboard is not enabled on the firewall.

" - } - } - }, - "DescribeProxyConfigurationRequest":{ - "type":"structure", - "members":{ - "ProxyConfigurationName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "ProxyConfigurationArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of a proxy configuration.

You must specify the ARN or the name, and you can specify both.

" - } - } - }, - "DescribeProxyConfigurationResponse":{ - "type":"structure", - "members":{ - "ProxyConfiguration":{ - "shape":"ProxyConfiguration", - "documentation":"

The configuration for the specified proxy configuration.

" - }, - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy configuration. The token marks the state of the proxy configuration resource at the time of the request.

To make changes to the proxy configuration, you provide the token in your request. Network Firewall uses the token to ensure that the proxy configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

" - } - } - }, - "DescribeProxyRequest":{ - "type":"structure", - "members":{ - "ProxyName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy. You can't change the name of a proxy after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "ProxyArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of a proxy.

You must specify the ARN or the name, and you can specify both.

" - } - } - }, - "DescribeProxyResource":{ - "type":"structure", - "members":{ - "ProxyName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy. You can't change the name of a proxy after you create it.

" - }, - "ProxyArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of a proxy.

" - }, - "ProxyConfigurationName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.

" - }, - "ProxyConfigurationArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of a proxy configuration.

" - }, - "NatGatewayId":{ - "shape":"NatGatewayId", - "documentation":"

The NAT Gateway for the proxy.

" - }, - "ProxyState":{ - "shape":"ProxyState", - "documentation":"

Current attachment/detachment status of the Proxy.

" - }, - "ProxyModifyState":{ - "shape":"ProxyModifyState", - "documentation":"

Current modification status of the Proxy.

" - }, - "ListenerProperties":{ - "shape":"ListenerProperties", - "documentation":"

Listener properties for HTTP and HTTPS traffic.

" - }, - "TlsInterceptProperties":{ - "shape":"TlsInterceptProperties", - "documentation":"

TLS decryption on traffic to filter on attributes in the HTTP header.

" - }, - "VpcEndpointServiceName":{ - "shape":"VpcEndpointServiceName", - "documentation":"

The service endpoint created in the VPC.

" - }, - "PrivateDNSName":{ - "shape":"PrivateDNSName", - "documentation":"

The private DNS name of the Proxy.

" - }, - "CreateTime":{ - "shape":"CreateTime", - "documentation":"

Time the Proxy was created.

" - }, - "DeleteTime":{ - "shape":"DeleteTime", - "documentation":"

Time the Proxy was deleted.

" - }, - "UpdateTime":{ - "shape":"UpdateTime", - "documentation":"

Time the Proxy was updated.

" - }, - "FailureCode":{ - "shape":"FailureCode", - "documentation":"

Failure code for cases when the Proxy fails to attach or update.

" - }, - "FailureMessage":{ - "shape":"FailureMessage", - "documentation":"

Failure message for cases when the Proxy fails to attach or update.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The key:value pairs to associate with the resource.

" - } - }, - "documentation":"

Proxy attached to a NAT gateway.

" - }, - "DescribeProxyResponse":{ - "type":"structure", - "members":{ - "Proxy":{ - "shape":"DescribeProxyResource", - "documentation":"

Proxy attached to a NAT gateway.

" - }, - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy. The token marks the state of the proxy resource at the time of the request.

To make changes to the proxy, you provide the token in your request. Network Firewall uses the token to ensure that the proxy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

" - } - } - }, - "DescribeProxyRuleGroupRequest":{ - "type":"structure", - "members":{ - "ProxyRuleGroupName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "ProxyRuleGroupArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of a proxy rule group.

You must specify the ARN or the name, and you can specify both.

" - } - } - }, - "DescribeProxyRuleGroupResponse":{ - "type":"structure", - "members":{ - "ProxyRuleGroup":{ - "shape":"ProxyRuleGroup", - "documentation":"

The configuration for the specified proxy rule group.

" - }, - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule group. The token marks the state of the proxy rule group resource at the time of the request.

To make changes to the proxy rule group, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

" - } - } - }, - "DescribeProxyRuleRequest":{ - "type":"structure", - "required":["ProxyRuleName"], - "members":{ - "ProxyRuleName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy rule. You can't change the name of a proxy rule after you create it.

" - }, - "ProxyRuleGroupName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "ProxyRuleGroupArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of a proxy rule group.

You must specify the ARN or the name, and you can specify both.

" - } - } - }, - "DescribeProxyRuleResponse":{ - "type":"structure", - "members":{ - "ProxyRule":{ - "shape":"ProxyRule", - "documentation":"

The configuration for the specified proxy rule.

" - }, - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule. The token marks the state of the proxy rule resource at the time of the request.

To make changes to the proxy rule, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy rule again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

" - } - } - }, - "DescribeResourcePolicyRequest":{ - "type":"structure", - "required":["ResourceArn"], - "members":{ - "ResourceArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the rule group or firewall policy whose resource policy you want to retrieve.

" - } - } - }, - "DescribeResourcePolicyResponse":{ - "type":"structure", - "members":{ - "Policy":{ - "shape":"PolicyString", - "documentation":"

The IAM policy for the resource.

" - } - } - }, - "DescribeRuleGroupMetadataRequest":{ - "type":"structure", - "members":{ - "RuleGroupName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "RuleGroupArn":{ - "shape":"ResourceArn", - "documentation":"

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "Type":{ - "shape":"RuleGroupType", - "documentation":"

Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

This setting is required for requests that do not include the RuleGroupARN.

" - } - } - }, - "DescribeRuleGroupMetadataResponse":{ - "type":"structure", - "required":[ - "RuleGroupArn", - "RuleGroupName" - ], - "members":{ - "RuleGroupArn":{ - "shape":"ResourceArn", - "documentation":"

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "RuleGroupName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "Description":{ - "shape":"Description", - "documentation":"

Returns the metadata objects for the specified rule group.

" - }, - "Type":{ - "shape":"RuleGroupType", - "documentation":"

Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

This setting is required for requests that do not include the RuleGroupARN.

" - }, - "Capacity":{ - "shape":"RuleCapacity", - "documentation":"

The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.

You can retrieve the capacity that would be required for a rule group before you create the rule group by calling CreateRuleGroup with DryRun set to TRUE.

" - }, - "StatefulRuleOptions":{"shape":"StatefulRuleOptions"}, - "LastModifiedTime":{ - "shape":"LastUpdateTime", - "documentation":"

A timestamp indicating when the rule group was last modified.

" - }, - "VendorName":{ - "shape":"VendorName", - "documentation":"

The name of the Amazon Web Services Marketplace vendor that provides this rule group.

" - }, - "ProductId":{ - "shape":"ProductId", - "documentation":"

The unique identifier for the product listing associated with this rule group.

" - }, - "ListingName":{ - "shape":"ListingName", - "documentation":"

The display name of the product listing for this rule group.

" - } - } - }, - "DescribeRuleGroupRequest":{ - "type":"structure", - "members":{ - "RuleGroupName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "RuleGroupArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the rule group.

You must specify the ARN or the name, and you can specify both.

" - }, - "Type":{ - "shape":"RuleGroupType", - "documentation":"

Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

This setting is required for requests that do not include the RuleGroupARN.

" - }, - "AnalyzeRuleGroup":{ - "shape":"Boolean", - "documentation":"

Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior such as asymmetric routing. If set to TRUE, Network Firewall runs the analysis.

" - } - } - }, - "DescribeRuleGroupResponse":{ - "type":"structure", - "required":[ - "UpdateToken", - "RuleGroupResponse" - ], - "members":{ - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.

To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

" - }, - "RuleGroup":{ - "shape":"RuleGroup", - "documentation":"

The object that defines the rules in a rule group. This, along with RuleGroupResponse, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

Network Firewall uses a rule group to inspect and control network traffic. You define stateless rule groups to inspect individual packets and you define stateful rule groups to inspect packets in the context of their traffic flow.

To use a rule group, you include it by reference in an Network Firewall firewall policy, then you use the policy in a firewall. You can reference a rule group from more than one firewall policy, and you can use a firewall policy in more than one firewall.

" - }, - "RuleGroupResponse":{ - "shape":"RuleGroupResponse", - "documentation":"

The high-level properties of a rule group. This, along with the RuleGroup, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

" - } - } - }, - "DescribeRuleGroupSummaryRequest":{ - "type":"structure", - "members":{ - "RuleGroupName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "RuleGroupArn":{ - "shape":"ResourceArn", - "documentation":"

Required. The Amazon Resource Name (ARN) of the rule group.

You must specify the ARN or the name, and you can specify both.

" - }, - "Type":{ - "shape":"RuleGroupType", - "documentation":"

The type of rule group you want a summary for. This is a required field.

Valid value: STATEFUL

Note that STATELESS exists but is not currently supported. If you provide STATELESS, an exception is returned.

" - } - } - }, - "DescribeRuleGroupSummaryResponse":{ - "type":"structure", - "required":["RuleGroupName"], - "members":{ - "RuleGroupName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

" - }, - "Description":{ - "shape":"Description", - "documentation":"

A description of the rule group.

" - }, - "Summary":{ - "shape":"Summary", - "documentation":"

A complex type that contains rule information based on the rule group's configured summary settings. The content varies depending on the fields that you specified to extract in your SummaryConfiguration. When you haven't configured any summary settings, this returns an empty array. The response might include:

  • Rule identifiers

  • Rule descriptions

  • Any metadata fields that you specified in your SummaryConfiguration

" - } - } - }, - "DescribeTLSInspectionConfigurationRequest":{ - "type":"structure", - "members":{ - "TLSInspectionConfigurationArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the TLS inspection configuration.

You must specify the ARN or the name, and you can specify both.

" - }, - "TLSInspectionConfigurationName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.

You must specify the ARN or the name, and you can specify both.

" - } - } - }, - "DescribeTLSInspectionConfigurationResponse":{ - "type":"structure", - "required":[ - "UpdateToken", - "TLSInspectionConfigurationResponse" - ], - "members":{ - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

A token used for optimistic locking. Network Firewall returns a token to your requests that access the TLS inspection configuration. The token marks the state of the TLS inspection configuration resource at the time of the request.

To make changes to the TLS inspection configuration, you provide the token in your request. Network Firewall uses the token to ensure that the TLS inspection configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the TLS inspection configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

" - }, - "TLSInspectionConfiguration":{ - "shape":"TLSInspectionConfiguration", - "documentation":"

The object that defines a TLS inspection configuration. This, along with TLSInspectionConfigurationResponse, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.

Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.

To use a TLS inspection configuration, you add it to a new Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect the traffic traveling through your firewalls. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.

" - }, - "TLSInspectionConfigurationResponse":{ - "shape":"TLSInspectionConfigurationResponse", - "documentation":"

The high-level properties of a TLS inspection configuration. This, along with the TLSInspectionConfiguration, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.

" - } - } - }, - "DescribeVpcEndpointAssociationRequest":{ - "type":"structure", - "required":["VpcEndpointAssociationArn"], - "members":{ - "VpcEndpointAssociationArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of a VPC endpoint association.

" - } - } - }, - "DescribeVpcEndpointAssociationResponse":{ - "type":"structure", - "members":{ - "VpcEndpointAssociation":{ - "shape":"VpcEndpointAssociation", - "documentation":"

The configuration settings for the VPC endpoint association. These settings include the firewall and the VPC and subnet to use for the firewall endpoint.

" - }, - "VpcEndpointAssociationStatus":{ - "shape":"VpcEndpointAssociationStatus", - "documentation":"

Detailed information about the current status of a VpcEndpointAssociation. You can retrieve this by calling DescribeVpcEndpointAssociation and providing the VPC endpoint association ARN.

" - } - } - }, - "Description":{ - "type":"string", - "max":512, - "pattern":"^.*$" - }, - "Destination":{ - "type":"string", - "max":1024, - "min":1, - "pattern":"^.*$" - }, - "DetachRuleGroupsFromProxyConfigurationRequest":{ - "type":"structure", - "required":["UpdateToken"], - "members":{ - "ProxyConfigurationName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "ProxyConfigurationArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of a proxy configuration.

You must specify the ARN or the name, and you can specify both.

" - }, - "RuleGroupNames":{ - "shape":"ResourceNameList", - "documentation":"

The proxy rule group names to detach from the proxy configuration

" - }, - "RuleGroupArns":{ - "shape":"ResourceArnList", - "documentation":"

The proxy rule group arns to detach from the proxy configuration

" - }, - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy configuration. The token marks the state of the proxy configuration resource at the time of the request.

To make changes to the proxy configuration, you provide the token in your request. Network Firewall uses the token to ensure that the proxy configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

" - } - } - }, - "DetachRuleGroupsFromProxyConfigurationResponse":{ - "type":"structure", - "members":{ - "ProxyConfiguration":{ - "shape":"ProxyConfiguration", - "documentation":"

The updated proxy configuration resource that reflects the updates from the request.

" - }, - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy configuration. The token marks the state of the proxy configuration resource at the time of the request.

To make changes to the proxy configuration, you provide the token in your request. Network Firewall uses the token to ensure that the proxy configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

" - } - } - }, - "Dimension":{ - "type":"structure", - "required":["Value"], - "members":{ - "Value":{ - "shape":"DimensionValue", - "documentation":"

The value to use in the custom metric dimension.

" - } - }, - "documentation":"

The value to use in an Amazon CloudWatch custom metric dimension. This is used in the PublishMetrics CustomAction. A CloudWatch custom metric dimension is a name/value pair that's part of the identity of a metric.

Network Firewall sets the dimension name to CustomAction and you provide the dimension value.

For more information about CloudWatch custom metric dimensions, see Publishing Custom Metrics in the Amazon CloudWatch User Guide.

" - }, - "DimensionValue":{ - "type":"string", - "max":128, - "min":1, - "pattern":"^[a-zA-Z0-9-_ ]+$" - }, - "Dimensions":{ - "type":"list", - "member":{"shape":"Dimension"}, - "max":1, - "min":1 - }, - "DisassociateAvailabilityZonesRequest":{ - "type":"structure", - "required":["AvailabilityZoneMappings"], - "members":{ - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

" - }, - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

" - }, - "FirewallName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "AvailabilityZoneMappings":{ - "shape":"AvailabilityZoneMappings", - "documentation":"

Required. The Availability Zones to remove from the firewall's configuration.

" - } - } - }, - "DisassociateAvailabilityZonesResponse":{ - "type":"structure", - "members":{ - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

" - }, - "FirewallName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

" - }, - "AvailabilityZoneMappings":{ - "shape":"AvailabilityZoneMappings", - "documentation":"

The remaining Availability Zones where the firewall has endpoints after the disassociation.

" - }, - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

" - } - } - }, - "DisassociateSubnetsRequest":{ - "type":"structure", - "required":["SubnetIds"], - "members":{ - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

" - }, - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

" - }, - "FirewallName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "SubnetIds":{ - "shape":"AzSubnets", - "documentation":"

The unique identifiers for the subnets that you want to disassociate.

" - } - } - }, - "DisassociateSubnetsResponse":{ - "type":"structure", - "members":{ - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

" - }, - "FirewallName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

" - }, - "SubnetMappings":{ - "shape":"SubnetMappings", - "documentation":"

The IDs of the subnets that are associated with the firewall.

" - }, - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

" - } - } - }, - "Domain":{"type":"string"}, - "EnableMonitoringDashboard":{"type":"boolean"}, - "EnableTLSSessionHolding":{"type":"boolean"}, - "EnabledAnalysisType":{ - "type":"string", - "enum":[ - "TLS_SNI", - "HTTP_HOST" - ] - }, - "EnabledAnalysisTypes":{ - "type":"list", - "member":{"shape":"EnabledAnalysisType"} - }, - "EncryptionConfiguration":{ - "type":"structure", - "required":["Type"], - "members":{ - "KeyId":{ - "shape":"KeyId", - "documentation":"

The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.

" - }, - "Type":{ - "shape":"EncryptionType", - "documentation":"

The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.

" - } - }, - "documentation":"

A complex type that contains optional Amazon Web Services Key Management Service (KMS) encryption settings for your Network Firewall resources. Your data is encrypted by default with an Amazon Web Services owned key that Amazon Web Services owns and manages for you. You can use either the Amazon Web Services owned key, or provide your own customer managed key. To learn more about KMS encryption of your Network Firewall resources, see Encryption at rest with Amazon Web Services Key Managment Service in the Network Firewall Developer Guide.

" - }, - "EncryptionType":{ - "type":"string", - "enum":[ - "CUSTOMER_KMS", - "AWS_OWNED_KMS_KEY" - ] - }, - "EndTime":{"type":"timestamp"}, - "EndpointId":{"type":"string"}, - "ErrorMessage":{"type":"string"}, - "FailureCode":{"type":"string"}, - "FailureMessage":{"type":"string"}, - "Firewall":{ - "type":"structure", - "required":[ - "FirewallPolicyArn", - "VpcId", - "SubnetMappings", - "FirewallId" - ], - "members":{ - "FirewallName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

" - }, - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

" - }, - "FirewallPolicyArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall policy.

The relationship of firewall to firewall policy is many to one. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.

" - }, - "VpcId":{ - "shape":"VpcId", - "documentation":"

The unique identifier of the VPC where the firewall is in use.

" - }, - "SubnetMappings":{ - "shape":"SubnetMappings", - "documentation":"

The primary public subnets that Network Firewall is using for the firewall. Network Firewall creates a firewall endpoint in each subnet. Create a subnet mapping for each Availability Zone where you want to use the firewall.

These subnets are all defined for a single, primary VPC, and each must belong to a different Availability Zone. Each of these subnets establishes the availability of the firewall in its Availability Zone.

In addition to these subnets, you can define other endpoints for the firewall in VpcEndpointAssociation resources. You can define these additional endpoints for any VPC, and for any of the Availability Zones where the firewall resource already has a subnet mapping. VPC endpoint associations give you the ability to protect multiple VPCs using a single firewall, and to define multiple firewall endpoints for a VPC in a single Availability Zone.

" - }, - "DeleteProtection":{ - "shape":"Boolean", - "documentation":"

A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE.

" - }, - "SubnetChangeProtection":{ - "shape":"Boolean", - "documentation":"

A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

" - }, - "FirewallPolicyChangeProtection":{ - "shape":"Boolean", - "documentation":"

A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

" - }, - "Description":{ - "shape":"Description", - "documentation":"

A description of the firewall.

" - }, - "FirewallId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier for the firewall.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

" - }, - "EncryptionConfiguration":{ - "shape":"EncryptionConfiguration", - "documentation":"

A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall.

" - }, - "NumberOfAssociations":{ - "shape":"NumberOfAssociations", - "documentation":"

The number of VpcEndpointAssociation resources that use this firewall.

" - }, - "EnabledAnalysisTypes":{ - "shape":"EnabledAnalysisTypes", - "documentation":"

An optional setting indicating the specific traffic analysis types to enable on the firewall.

" - }, - "TransitGatewayId":{ - "shape":"TransitGatewayId", - "documentation":"

The unique identifier of the transit gateway associated with this firewall. This field is only present for transit gateway-attached firewalls.

" - }, - "TransitGatewayOwnerAccountId":{ - "shape":"AWSAccountId", - "documentation":"

The Amazon Web Services account ID that owns the transit gateway. This may be different from the firewall owner's account ID when using a shared transit gateway.

" - }, - "AvailabilityZoneMappings":{ - "shape":"AvailabilityZoneMappings", - "documentation":"

The Availability Zones where the firewall endpoints are created for a transit gateway-attached firewall. Each mapping specifies an Availability Zone where the firewall processes traffic.

" - }, - "AvailabilityZoneChangeProtection":{ - "shape":"Boolean", - "documentation":"

A setting indicating whether the firewall is protected against changes to its Availability Zone configuration. When set to TRUE, you must first disable this protection before adding or removing Availability Zones.

" - } - }, - "documentation":"

A firewall defines the behavior of a firewall, the main VPC where the firewall is used, the Availability Zones where the firewall can be used, and one subnet to use for a firewall endpoint within each of the Availability Zones. The Availability Zones are defined implicitly in the subnet specifications.

In addition to the firewall endpoints that you define in this Firewall specification, you can create firewall endpoints in VpcEndpointAssociation resources for any VPC, in any Availability Zone where the firewall is already in use.

The status of the firewall, for example whether it's ready to filter network traffic, is provided in the corresponding FirewallStatus. You can retrieve both the firewall and firewall status by calling DescribeFirewall.

" - }, - "FirewallMetadata":{ - "type":"structure", - "members":{ - "FirewallName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

" - }, - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

" - }, - "TransitGatewayAttachmentId":{ - "shape":"TransitGatewayAttachmentId", - "documentation":"

The unique identifier of the transit gateway attachment associated with this firewall. This field is only present for transit gateway-attached firewalls.

" - } - }, - "documentation":"

High-level information about a firewall, returned by operations like create and describe. You can use the information provided in the metadata to retrieve and manage a firewall.

" - }, - "FirewallPolicies":{ - "type":"list", - "member":{"shape":"FirewallPolicyMetadata"} - }, - "FirewallPolicy":{ - "type":"structure", - "required":[ - "StatelessDefaultActions", - "StatelessFragmentDefaultActions" - ], - "members":{ - "StatelessRuleGroupReferences":{ - "shape":"StatelessRuleGroupReferences", - "documentation":"

References to the stateless rule groups that are used in the policy. These define the matching criteria in stateless rules.

" - }, - "StatelessDefaultActions":{ - "shape":"StatelessActions", - "documentation":"

The actions to take on a packet if it doesn't match any of the stateless rules in the policy. If you want non-matching packets to be forwarded for stateful inspection, specify aws:forward_to_sfe.

You must specify one of the standard actions: aws:pass, aws:drop, or aws:forward_to_sfe. In addition, you can specify custom actions that are compatible with your standard section choice.

For example, you could specify [\"aws:pass\"] or you could specify [\"aws:pass\", “customActionName”]. For information about compatibility, see the custom action descriptions under CustomAction.

" - }, - "StatelessFragmentDefaultActions":{ - "shape":"StatelessActions", - "documentation":"

The actions to take on a fragmented UDP packet if it doesn't match any of the stateless rules in the policy. Network Firewall only manages UDP packet fragments and silently drops packet fragments for other protocols. If you want non-matching fragmented UDP packets to be forwarded for stateful inspection, specify aws:forward_to_sfe.

You must specify one of the standard actions: aws:pass, aws:drop, or aws:forward_to_sfe. In addition, you can specify custom actions that are compatible with your standard section choice.

For example, you could specify [\"aws:pass\"] or you could specify [\"aws:pass\", “customActionName”]. For information about compatibility, see the custom action descriptions under CustomAction.

" - }, - "StatelessCustomActions":{ - "shape":"CustomActions", - "documentation":"

The custom action definitions that are available for use in the firewall policy's StatelessDefaultActions setting. You name each custom action that you define, and then you can use it by name in your default actions specifications.

" - }, - "StatefulRuleGroupReferences":{ - "shape":"StatefulRuleGroupReferences", - "documentation":"

References to the stateful rule groups that are used in the policy. These define the inspection criteria in stateful rules.

" - }, - "StatefulDefaultActions":{ - "shape":"StatefulActions", - "documentation":"

The default actions to take on a packet that doesn't match any stateful rules. The stateful default action is optional, and is only valid when using the strict rule order.

Valid values of the stateful default action:

  • aws:drop_strict

  • aws:drop_established

  • aws:alert_strict

  • aws:alert_established

For more information, see Strict evaluation order in the Network Firewall Developer Guide.

" - }, - "StatefulEngineOptions":{ - "shape":"StatefulEngineOptions", - "documentation":"

Additional options governing how Network Firewall handles stateful rules. The stateful rule groups that you use in your policy must have stateful rule options settings that are compatible with these settings.

" - }, - "TLSInspectionConfigurationArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the TLS inspection configuration.

" - }, - "PolicyVariables":{ - "shape":"PolicyVariables", - "documentation":"

Contains variables that you can use to override default Suricata settings in your firewall policy.

" - }, - "EnableTLSSessionHolding":{ - "shape":"EnableTLSSessionHolding", - "documentation":"

When true, prevents TCP and TLS packets from reaching destination servers until TLS Inspection has evaluated Server Name Indication (SNI) rules. Requires an associated TLS Inspection configuration.

" - } - }, - "documentation":"

The firewall policy defines the behavior of a firewall using a collection of stateless and stateful rule groups and other settings. You can use one firewall policy for multiple firewalls.

This, along with FirewallPolicyResponse, define the policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.

" - }, - "FirewallPolicyMetadata":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.

" - }, - "Arn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall policy.

" - } - }, - "documentation":"

High-level information about a firewall policy, returned by operations like create and describe. You can use the information provided in the metadata to retrieve and manage a firewall policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.

" - }, - "FirewallPolicyResponse":{ - "type":"structure", - "required":[ - "FirewallPolicyName", - "FirewallPolicyArn", - "FirewallPolicyId" - ], - "members":{ - "FirewallPolicyName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.

" - }, - "FirewallPolicyArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall policy.

If this response is for a create request that had DryRun set to TRUE, then this ARN is a placeholder that isn't attached to a valid resource.

" - }, - "FirewallPolicyId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier for the firewall policy.

" - }, - "Description":{ - "shape":"Description", - "documentation":"

A description of the firewall policy.

" - }, - "FirewallPolicyStatus":{ - "shape":"ResourceStatus", - "documentation":"

The current status of the firewall policy. You can retrieve this for a firewall policy by calling DescribeFirewallPolicy and providing the firewall policy's name or ARN.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The key:value pairs to associate with the resource.

" - }, - "ConsumedStatelessRuleCapacity":{ - "shape":"RuleCapacity", - "documentation":"

The number of capacity units currently consumed by the policy's stateless rules.

" - }, - "ConsumedStatefulRuleCapacity":{ - "shape":"RuleCapacity", - "documentation":"

The number of capacity units currently consumed by the policy's stateful rules.

" - }, - "ConsumedStatefulDomainCapacity":{ - "shape":"RuleCapacity", - "documentation":"

The total number of domain name specifications across all domain list rule groups in the firewall policy that use the stateful-domain-rulegroup resource type.

" - }, - "NumberOfAssociations":{ - "shape":"NumberOfAssociations", - "documentation":"

The number of firewalls that are associated with this firewall policy.

" - }, - "EncryptionConfiguration":{ - "shape":"EncryptionConfiguration", - "documentation":"

A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall policy.

" - }, - "LastModifiedTime":{ - "shape":"LastUpdateTime", - "documentation":"

The last time that the firewall policy was changed.

" - } - }, - "documentation":"

The high-level properties of a firewall policy. This, along with the FirewallPolicy, define the policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.

" - }, - "FirewallStatus":{ - "type":"structure", - "required":[ - "Status", - "ConfigurationSyncStateSummary" - ], - "members":{ - "Status":{ - "shape":"FirewallStatusValue", - "documentation":"

The readiness of the configured firewall to handle network traffic across all of the Availability Zones where you have it configured. This setting is READY only when the ConfigurationSyncStateSummary value is IN_SYNC and the Attachment Status values for all of the configured subnets are READY.

" - }, - "ConfigurationSyncStateSummary":{ - "shape":"ConfigurationSyncState", - "documentation":"

The configuration sync state for the firewall. This summarizes the Config settings in the SyncStates for this firewall status object.

When you create a firewall or update its configuration, for example by adding a rule group to its firewall policy, Network Firewall distributes the configuration changes to all Availability Zones that have subnets defined for the firewall. This summary indicates whether the configuration changes have been applied everywhere.

This status must be IN_SYNC for the firewall to be ready for use, but it doesn't indicate that the firewall is ready. The Status setting indicates firewall readiness. It's based on this setting and the readiness of the firewall endpoints to take traffic.

" - }, - "SyncStates":{ - "shape":"SyncStates", - "documentation":"

Status for the subnets that you've configured in the firewall. This contains one array element per Availability Zone where you've configured a subnet in the firewall.

These objects provide detailed information for the settings ConfigurationSyncStateSummary and Status.

" - }, - "CapacityUsageSummary":{ - "shape":"CapacityUsageSummary", - "documentation":"

Describes the capacity usage of the resources contained in a firewall's reference sets. Network Firewall calculates the capacity usage by taking an aggregated count of all of the resources used by all of the reference sets in a firewall.

" - }, - "TransitGatewayAttachmentSyncState":{ - "shape":"TransitGatewayAttachmentSyncState", - "documentation":"

The synchronization state of the transit gateway attachment. This indicates whether the firewall's transit gateway configuration is properly synchronized and operational. Use this to verify that your transit gateway configuration changes have been applied.

" - } - }, - "documentation":"

Detailed information about the current status of a Firewall. You can retrieve this for a firewall by calling DescribeFirewall and providing the firewall name and ARN.

The firewall status indicates a combined status. It indicates whether all subnets are up-to-date with the latest firewall configurations, which is based on the sync states config values, and also whether all subnets have their endpoints fully enabled, based on their sync states attachment values.

" - }, - "FirewallStatusValue":{ - "type":"string", - "enum":[ - "PROVISIONING", - "DELETING", - "READY" - ] - }, - "Firewalls":{ - "type":"list", - "member":{"shape":"FirewallMetadata"} - }, - "FirstAccessed":{"type":"timestamp"}, - "Flags":{ - "type":"list", - "member":{"shape":"TCPFlag"} - }, - "Flow":{ - "type":"structure", - "members":{ - "SourceAddress":{"shape":"Address"}, - "DestinationAddress":{"shape":"Address"}, - "SourcePort":{ - "shape":"Port", - "documentation":"

The source port to inspect for. You can specify an individual port, for example 1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY.

" - }, - "DestinationPort":{ - "shape":"Port", - "documentation":"

The destination port to inspect for. You can specify an individual port, for example 1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY.

" - }, - "Protocol":{ - "shape":"ProtocolString", - "documentation":"

The protocols to inspect for, specified using the assigned internet protocol number (IANA) for each protocol. If not specified, this matches with any protocol.

" - }, - "Age":{ - "shape":"Age", - "documentation":"

Returned as info about age of the flows identified by the flow operation.

" - }, - "PacketCount":{ - "shape":"PacketCount", - "documentation":"

Returns the total number of data packets received or transmitted in a flow.

" - }, - "ByteCount":{ - "shape":"ByteCount", - "documentation":"

Returns the number of bytes received or transmitted in a specific flow.

" - } - }, - "documentation":"

Any number of arrays, where each array is a single flow identified in the scope of the operation. If multiple flows were in the scope of the operation, multiple Flows arrays are returned.

" - }, - "FlowFilter":{ - "type":"structure", - "members":{ - "SourceAddress":{"shape":"Address"}, - "DestinationAddress":{"shape":"Address"}, - "SourcePort":{ - "shape":"Port", - "documentation":"

The source port to inspect for. You can specify an individual port, for example 1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY.

" - }, - "DestinationPort":{ - "shape":"Port", - "documentation":"

The destination port to inspect for. You can specify an individual port, for example 1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY.

" - }, - "Protocols":{ - "shape":"ProtocolStrings", - "documentation":"

The protocols to inspect for, specified using the assigned internet protocol number (IANA) for each protocol. If not specified, this matches with any protocol.

" - } - }, - "documentation":"

Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.

" - }, - "FlowFilters":{ - "type":"list", - "member":{"shape":"FlowFilter"} - }, - "FlowOperation":{ - "type":"structure", - "members":{ - "MinimumFlowAgeInSeconds":{ - "shape":"Age", - "documentation":"

The reqested FlowOperation ignores flows with an age (in seconds) lower than MinimumFlowAgeInSeconds. You provide this for start commands.

" - }, - "FlowFilters":{ - "shape":"FlowFilters", - "documentation":"

Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.

" - } - }, - "documentation":"

Contains information about a flow operation, such as related statuses, unique identifiers, and all filters defined in the operation.

Flow operations let you manage the flows tracked in the flow table, also known as the firewall table.

A flow is network traffic that is monitored by a firewall, either by stateful or stateless rules. For traffic to be considered part of a flow, it must share Destination, DestinationPort, Direction, Protocol, Source, and SourcePort.

" - }, - "FlowOperationId":{ - "type":"string", - "max":36, - "min":36, - "pattern":"^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$" - }, - "FlowOperationMetadata":{ - "type":"structure", - "members":{ - "FlowOperationId":{ - "shape":"FlowOperationId", - "documentation":"

A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.

" - }, - "FlowOperationType":{ - "shape":"FlowOperationType", - "documentation":"

Defines the type of FlowOperation.

" - }, - "FlowRequestTimestamp":{ - "shape":"FlowRequestTimestamp", - "documentation":"

A timestamp indicating when the Suricata engine identified flows impacted by an operation.

" - }, - "FlowOperationStatus":{ - "shape":"FlowOperationStatus", - "documentation":"

Returns the status of the flow operation. This string is returned in the responses to start, list, and describe commands.

If the status is COMPLETED_WITH_ERRORS, results may be returned with any number of Flows missing from the response. If the status is FAILED, Flows returned will be empty.

" - } - }, - "documentation":"

An array of objects with metadata about the requested FlowOperation.

" - }, - "FlowOperationStatus":{ - "type":"string", - "enum":[ - "COMPLETED", - "IN_PROGRESS", - "FAILED", - "COMPLETED_WITH_ERRORS" - ] - }, - "FlowOperationType":{ - "type":"string", - "enum":[ - "FLOW_FLUSH", - "FLOW_CAPTURE" - ] - }, - "FlowOperations":{ - "type":"list", - "member":{"shape":"FlowOperationMetadata"} - }, - "FlowRequestTimestamp":{"type":"timestamp"}, - "FlowTimeouts":{ - "type":"structure", - "members":{ - "TcpIdleTimeoutSeconds":{ - "shape":"TcpIdleTimeoutRangeBound", - "documentation":"

The number of seconds that can pass without any TCP traffic sent through the firewall before the firewall determines that the connection is idle. After the idle timeout passes, data packets are dropped, however, the next TCP SYN packet is considered a new flow and is processed by the firewall. Clients or targets can use TCP keepalive packets to reset the idle timeout.

You can define the TcpIdleTimeoutSeconds value to be between 60 and 6000 seconds. If no value is provided, it defaults to 350 seconds.

" - } - }, - "documentation":"

Describes the amount of time that can pass without any traffic sent through the firewall before the firewall determines that the connection is idle and Network Firewall removes the flow entry from its flow table. When you update this value, existing connections will be treated according to your stream exception policy configuration.

" - }, - "Flows":{ - "type":"list", - "member":{"shape":"Flow"} - }, - "GeneratedRulesType":{ - "type":"string", - "enum":[ - "ALLOWLIST", - "DENYLIST", - "REJECTLIST", - "ALERTLIST" - ] - }, - "GetAnalysisReportResultsRequest":{ - "type":"structure", - "required":["AnalysisReportId"], - "members":{ - "FirewallName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "AnalysisReportId":{ - "shape":"AnalysisReportId", - "documentation":"

The unique ID of the query that ran when you requested an analysis report.

" - }, - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

" - }, - "NextToken":{ - "shape":"AnalysisReportNextToken", - "documentation":"

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" - }, - "MaxResults":{ - "shape":"PaginationMaxResults", - "documentation":"

The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

" - } - } - }, - "GetAnalysisReportResultsResponse":{ - "type":"structure", - "members":{ - "Status":{ - "shape":"Status", - "documentation":"

The status of the analysis report you specify. Statuses include RUNNING, COMPLETED, or FAILED.

" - }, - "StartTime":{ - "shape":"StartTime", - "documentation":"

The date and time within the last 30 days from which to start retrieving analysis data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ.

" - }, - "EndTime":{ - "shape":"EndTime", - "documentation":"

The date and time, up to the current date, from which to stop retrieving analysis data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

" - }, - "ReportTime":{ - "shape":"ReportTime", - "documentation":"

The date and time the analysis report was ran.

" - }, - "AnalysisType":{ - "shape":"EnabledAnalysisType", - "documentation":"

The type of traffic that will be used to generate a report.

" - }, - "NextToken":{ - "shape":"AnalysisReportNextToken", - "documentation":"

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" - }, - "AnalysisReportResults":{ - "shape":"AnalysisReportResults", - "documentation":"

Retrieves the results of a traffic analysis report.

" - } - } - }, - "HashMapKey":{ - "type":"string", - "max":50, - "min":3, - "pattern":"^[0-9A-Za-z.\\-_@\\/]+$" - }, - "HashMapValue":{ - "type":"string", - "max":1024, - "min":1, - "pattern":"[\\s\\S]*$" - }, - "Header":{ - "type":"structure", - "required":[ - "Protocol", - "Source", - "SourcePort", - "Direction", - "Destination", - "DestinationPort" - ], - "members":{ - "Protocol":{ - "shape":"StatefulRuleProtocol", - "documentation":"

The protocol to inspect for. To specify all, you can use IP, because all traffic on Amazon Web Services and on the internet is IP.

" - }, - "Source":{ - "shape":"Source", - "documentation":"

The source IP address or address range to inspect for, in CIDR notation. To match with any address, specify ANY.

Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4 and IPv6.

Examples:

  • To configure Network Firewall to inspect for the IP address 192.0.2.44, specify 192.0.2.44/32.

  • To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

  • To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

  • To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

" - }, - "SourcePort":{ - "shape":"Port", - "documentation":"

The source port to inspect for. You can specify an individual port, for example 1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY.

" - }, - "Direction":{ - "shape":"StatefulRuleDirection", - "documentation":"

The direction of traffic flow to inspect. If set to ANY, the inspection matches bidirectional traffic, both from the source to the destination and from the destination to the source. If set to FORWARD, the inspection only matches traffic going from the source to the destination.

" - }, - "Destination":{ - "shape":"Destination", - "documentation":"

The destination IP address or address range to inspect for, in CIDR notation. To match with any address, specify ANY.

Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4 and IPv6.

Examples:

  • To configure Network Firewall to inspect for the IP address 192.0.2.44, specify 192.0.2.44/32.

  • To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

  • To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

  • To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

" - }, - "DestinationPort":{ - "shape":"Port", - "documentation":"

The destination port to inspect for. You can specify an individual port, for example 1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY.

" - } - }, - "documentation":"

The basic rule criteria for Network Firewall to use to inspect packet headers in stateful traffic flow inspection. Traffic flows that match the criteria are a match for the corresponding StatefulRule.

" - }, - "Hits":{ - "type":"structure", - "members":{ - "Count":{ - "shape":"Count", - "documentation":"

The number of attempts made to access a domain.

" - } - }, - "documentation":"

Attempts made to a access domain.

" - }, - "IPAddressType":{ - "type":"string", - "enum":[ - "DUALSTACK", - "IPV4", - "IPV6" - ] - }, - "IPSet":{ - "type":"structure", - "required":["Definition"], - "members":{ - "Definition":{ - "shape":"VariableDefinitionList", - "documentation":"

The list of IP addresses and address ranges, in CIDR notation.

" - } - }, - "documentation":"

A list of IP addresses and address ranges, in CIDR notation. This is part of a RuleVariables.

" - }, - "IPSetArn":{"type":"string"}, - "IPSetMetadata":{ - "type":"structure", - "members":{ - "ResolvedCIDRCount":{ - "shape":"CIDRCount", - "documentation":"

Describes the total number of CIDR blocks currently in use by the IP set references in a firewall. To determine how many CIDR blocks are available for you to use in a firewall, you can call AvailableCIDRCount.

" - } - }, - "documentation":"

General information about the IP set.

" - }, - "IPSetMetadataMap":{ - "type":"map", - "key":{"shape":"IPSetArn"}, - "value":{"shape":"IPSetMetadata"} - }, - "IPSetReference":{ - "type":"structure", - "members":{ - "ReferenceArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the resource that you are referencing in your rule group.

" - } - }, - "documentation":"

Configures one or more IP set references for a Suricata-compatible rule group. This is used in CreateRuleGroup or UpdateRuleGroup. An IP set reference is a rule variable that references resources that you create and manage in another Amazon Web Services service, such as an Amazon VPC prefix list. Network Firewall IP set references enable you to dynamically update the contents of your rules. When you create, update, or delete the resource you are referencing in your rule, Network Firewall automatically updates the rule's content with the changes. For more information about IP set references in Network Firewall, see Using IP set references in the Network Firewall Developer Guide.

Network Firewall currently supports Amazon VPC prefix lists and resource groups in IP set references.

" - }, - "IPSetReferenceMap":{ - "type":"map", - "key":{"shape":"IPSetReferenceName"}, - "value":{"shape":"IPSetReference"} - }, - "IPSetReferenceName":{ - "type":"string", - "max":32, - "min":1, - "pattern":"^[A-Za-z][A-Za-z0-9_]*$" - }, - "IPSets":{ - "type":"map", - "key":{"shape":"RuleVariableName"}, - "value":{"shape":"IPSet"} - }, - "IdentifiedType":{ - "type":"string", - "enum":[ - "STATELESS_RULE_FORWARDING_ASYMMETRICALLY", - "STATELESS_RULE_CONTAINS_TCP_FLAGS" - ] - }, - "InsertPosition":{"type":"integer"}, - "InsufficientCapacityException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"} - }, - "documentation":"

Amazon Web Services doesn't currently have enough available capacity to fulfill your request. Try your request later.

", - "exception":true, - "fault":true - }, - "InternalServerError":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"} - }, - "documentation":"

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

", - "exception":true, - "fault":true - }, - "InvalidOperationException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"} - }, - "documentation":"

The operation failed because it's not valid. For example, you might have tried to delete a rule group or firewall policy that's in use.

", - "exception":true - }, - "InvalidRequestException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"} - }, - "documentation":"

The operation failed because of a problem with your request. Examples include:

  • You specified an unsupported parameter name or value.

  • You tried to update a property with a value that isn't among the available types.

  • Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

", - "exception":true - }, - "InvalidResourcePolicyException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"} - }, - "documentation":"

The policy statement failed validation.

", - "exception":true - }, - "InvalidTokenException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"} - }, - "documentation":"

The token you provided is stale or isn't valid for the operation.

", - "exception":true - }, - "KeyId":{ - "type":"string", - "max":2048, - "min":1, - "pattern":".*\\S.*" - }, - "Keyword":{ - "type":"string", - "max":128, - "min":1, - "pattern":".*" - }, - "LastAccessed":{"type":"timestamp"}, - "LastUpdateTime":{"type":"timestamp"}, - "LimitExceededException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"} - }, - "documentation":"

Unable to perform the operation because doing so would violate a limit setting.

", - "exception":true - }, - "ListAnalysisReportsRequest":{ - "type":"structure", - "members":{ - "FirewallName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

" - }, - "NextToken":{ - "shape":"PaginationToken", - "documentation":"

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" - }, - "MaxResults":{ - "shape":"PaginationMaxResults", - "documentation":"

The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

" - } - } - }, - "ListAnalysisReportsResponse":{ - "type":"structure", - "members":{ - "AnalysisReports":{ - "shape":"AnalysisReports", - "documentation":"

The id and ReportTime associated with a requested analysis report. Does not provide the status of the analysis report.

" - }, - "NextToken":{ - "shape":"PaginationToken", - "documentation":"

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" - } - } - }, - "ListContainerAssociationsRequest":{ - "type":"structure", - "members":{ - "MaxResults":{ - "shape":"PaginationMaxResults", - "documentation":"

The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

" - }, - "NextToken":{ - "shape":"PaginationToken", - "documentation":"

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" - } - } - }, - "ListContainerAssociationsResponse":{ - "type":"structure", - "members":{ - "ContainerAssociations":{ - "shape":"ContainerAssociations", - "documentation":"

The container association metadata objects.

" - }, - "NextToken":{ - "shape":"PaginationToken", - "documentation":"

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" - } - } - }, - "ListFirewallPoliciesRequest":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"PaginationToken", - "documentation":"

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" - }, - "MaxResults":{ - "shape":"PaginationMaxResults", - "documentation":"

The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

" - } - } - }, - "ListFirewallPoliciesResponse":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"PaginationToken", - "documentation":"

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" - }, - "FirewallPolicies":{ - "shape":"FirewallPolicies", - "documentation":"

The metadata for the firewall policies. Depending on your setting for max results and the number of firewall policies that you have, this might not be the full list.

" - } - } - }, - "ListFirewallsRequest":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"PaginationToken", - "documentation":"

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" - }, - "VpcIds":{ - "shape":"VpcIds", - "documentation":"

The unique identifiers of the VPCs that you want Network Firewall to retrieve the firewalls for. Leave this blank to retrieve all firewalls that you have defined.

" - }, - "MaxResults":{ - "shape":"PaginationMaxResults", - "documentation":"

The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

" - } - } - }, - "ListFirewallsResponse":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"PaginationToken", - "documentation":"

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" - }, - "Firewalls":{ - "shape":"Firewalls", - "documentation":"

The firewall metadata objects for the VPCs that you specified. Depending on your setting for max results and the number of firewalls you have, a single call might not be the full list.

" - } - } - }, - "ListFlowOperationResultsRequest":{ - "type":"structure", - "required":[ - "FirewallArn", - "FlowOperationId" - ], - "members":{ - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

" - }, - "FlowOperationId":{ - "shape":"FlowOperationId", - "documentation":"

A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.

" - }, - "NextToken":{ - "shape":"PaginationToken", - "documentation":"

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" - }, - "MaxResults":{ - "shape":"PaginationMaxResults", - "documentation":"

The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

" - }, - "AvailabilityZone":{ - "shape":"AvailabilityZone", - "documentation":"

The ID of the Availability Zone where the firewall is located. For example, us-east-2a.

Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.

" - }, - "VpcEndpointId":{ - "shape":"VpcEndpointId", - "documentation":"

A unique identifier for the primary endpoint associated with a firewall.

" - }, - "VpcEndpointAssociationArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of a VPC endpoint association.

" - } - } - }, - "ListFlowOperationResultsResponse":{ - "type":"structure", - "members":{ - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

" - }, - "AvailabilityZone":{ - "shape":"AvailabilityZone", - "documentation":"

The ID of the Availability Zone where the firewall is located. For example, us-east-2a.

Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.

" - }, - "VpcEndpointAssociationArn":{ - "shape":"ResourceArn", - "documentation":"

" - }, - "VpcEndpointId":{ - "shape":"VpcEndpointId", - "documentation":"

" - }, - "FlowOperationId":{ - "shape":"FlowOperationId", - "documentation":"

A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.

" - }, - "FlowOperationStatus":{ - "shape":"FlowOperationStatus", - "documentation":"

Returns the status of the flow operation. This string is returned in the responses to start, list, and describe commands.

If the status is COMPLETED_WITH_ERRORS, results may be returned with any number of Flows missing from the response. If the status is FAILED, Flows returned will be empty.

" - }, - "StatusMessage":{ - "shape":"StatusReason", - "documentation":"

If the asynchronous operation fails, Network Firewall populates this with the reason for the error or failure. Options include Flow operation error and Flow timeout.

" - }, - "FlowRequestTimestamp":{ - "shape":"FlowRequestTimestamp", - "documentation":"

A timestamp indicating when the Suricata engine identified flows impacted by an operation.

" - }, - "Flows":{ - "shape":"Flows", - "documentation":"

Any number of arrays, where each array is a single flow identified in the scope of the operation. If multiple flows were in the scope of the operation, multiple Flows arrays are returned.

" - }, - "NextToken":{ - "shape":"PaginationToken", - "documentation":"

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" - } - } - }, - "ListFlowOperationsRequest":{ - "type":"structure", - "required":["FirewallArn"], - "members":{ - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

" - }, - "AvailabilityZone":{ - "shape":"AvailabilityZone", - "documentation":"

The ID of the Availability Zone where the firewall is located. For example, us-east-2a.

Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.

" - }, - "VpcEndpointAssociationArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of a VPC endpoint association.

" - }, - "VpcEndpointId":{ - "shape":"VpcEndpointId", - "documentation":"

A unique identifier for the primary endpoint associated with a firewall.

" - }, - "FlowOperationType":{ - "shape":"FlowOperationType", - "documentation":"

An optional string that defines whether any or all operation types are returned.

" - }, - "NextToken":{ - "shape":"PaginationToken", - "documentation":"

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" - }, - "MaxResults":{ - "shape":"PaginationMaxResults", - "documentation":"

The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

" - } - } - }, - "ListFlowOperationsResponse":{ - "type":"structure", - "members":{ - "FlowOperations":{ - "shape":"FlowOperations", - "documentation":"

Flow operations let you manage the flows tracked in the flow table, also known as the firewall table.

A flow is network traffic that is monitored by a firewall, either by stateful or stateless rules. For traffic to be considered part of a flow, it must share Destination, DestinationPort, Direction, Protocol, Source, and SourcePort.

" - }, - "NextToken":{ - "shape":"PaginationToken", - "documentation":"

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" - } - } - }, - "ListProxiesRequest":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"PaginationToken", - "documentation":"

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" - }, - "MaxResults":{ - "shape":"PaginationMaxResults", - "documentation":"

The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

" - } - } - }, - "ListProxiesResponse":{ - "type":"structure", - "members":{ - "Proxies":{ - "shape":"Proxies", - "documentation":"

The metadata for the proxies. Depending on your setting for max results and the number of proxies that you have, this might not be the full list.

" - }, - "NextToken":{ - "shape":"PaginationToken", - "documentation":"

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" - } - } - }, - "ListProxyConfigurationsRequest":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"PaginationToken", - "documentation":"

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" - }, - "MaxResults":{ - "shape":"PaginationMaxResults", - "documentation":"

The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

" - } - } - }, - "ListProxyConfigurationsResponse":{ - "type":"structure", - "members":{ - "ProxyConfigurations":{ - "shape":"ProxyConfigurations", - "documentation":"

The metadata for the proxy configurations. Depending on your setting for max results and the number of proxy configurations that you have, this might not be the full list.

" - }, - "NextToken":{ - "shape":"PaginationToken", - "documentation":"

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" - } - } - }, - "ListProxyRuleGroupsRequest":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"PaginationToken", - "documentation":"

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" - }, - "MaxResults":{ - "shape":"PaginationMaxResults", - "documentation":"

The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

" - } - } - }, - "ListProxyRuleGroupsResponse":{ - "type":"structure", - "members":{ - "ProxyRuleGroups":{ - "shape":"ProxyRuleGroups", - "documentation":"

The metadata for the proxy rule groups. Depending on your setting for max results and the number of proxy rule groups that you have, this might not be the full list.

" - }, - "NextToken":{ - "shape":"PaginationToken", - "documentation":"

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" - } - } - }, - "ListRuleGroupsRequest":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"PaginationToken", - "documentation":"

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" - }, - "MaxResults":{ - "shape":"PaginationMaxResults", - "documentation":"

The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

" - }, - "Scope":{ - "shape":"ResourceManagedStatus", - "documentation":"

The scope of the request. The default setting of ACCOUNT or a setting of NULL returns all of the rule groups in your account. A setting of MANAGED returns all available managed rule groups.

" - }, - "ManagedType":{ - "shape":"ResourceManagedType", - "documentation":"

Indicates the general category of the Amazon Web Services managed rule group.

" - }, - "SubscriptionStatus":{ - "shape":"SubscriptionStatus", - "documentation":"

Filters the results to show only rule groups with the specified subscription status. Use this to find subscribed or unsubscribed rule groups.

" - }, - "Type":{ - "shape":"RuleGroupType", - "documentation":"

Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

" - } - } - }, - "ListRuleGroupsResponse":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"PaginationToken", - "documentation":"

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" - }, - "RuleGroups":{ - "shape":"RuleGroups", - "documentation":"

The rule group metadata objects that you've defined. Depending on your setting for max results and the number of rule groups, this might not be the full list.

" - } - } - }, - "ListTLSInspectionConfigurationsRequest":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"PaginationToken", - "documentation":"

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" - }, - "MaxResults":{ - "shape":"PaginationMaxResults", - "documentation":"

The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

" - } - } - }, - "ListTLSInspectionConfigurationsResponse":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"PaginationToken", - "documentation":"

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" - }, - "TLSInspectionConfigurations":{ - "shape":"TLSInspectionConfigurations", - "documentation":"

The TLS inspection configuration metadata objects that you've defined. Depending on your setting for max results and the number of TLS inspection configurations, this might not be the full list.

" - } - } - }, - "ListTagsForResourceRequest":{ - "type":"structure", - "required":["ResourceArn"], - "members":{ - "NextToken":{ - "shape":"PaginationToken", - "documentation":"

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" - }, - "MaxResults":{ - "shape":"TagsPaginationMaxResults", - "documentation":"

The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

" - }, - "ResourceArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the resource.

" - } - } - }, - "ListTagsForResourceResponse":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"PaginationToken", - "documentation":"

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The tags that are associated with the resource.

" - } - } - }, - "ListVpcEndpointAssociationsRequest":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"PaginationToken", - "documentation":"

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" - }, - "MaxResults":{ - "shape":"PaginationMaxResults", - "documentation":"

The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

" - }, - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

If you don't specify this, Network Firewall retrieves all VPC endpoint associations that you have defined.

" - } - } - }, - "ListVpcEndpointAssociationsResponse":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"PaginationToken", - "documentation":"

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" - }, - "VpcEndpointAssociations":{ - "shape":"VpcEndpointAssociations", - "documentation":"

The VPC endpoint assocation metadata objects for the firewall that you specified. If you didn't specify a firewall, this is all VPC endpoint associations that you have defined.

Depending on your setting for max results and the number of firewalls you have, a single call might not be the full list.

" - } - } - }, - "ListenerProperties":{ - "type":"list", - "member":{"shape":"ListenerProperty"} - }, - "ListenerPropertiesRequest":{ - "type":"list", - "member":{"shape":"ListenerPropertyRequest"}, - "max":2, - "min":0 - }, - "ListenerProperty":{ - "type":"structure", - "members":{ - "Port":{ - "shape":"NatGatewayPort", - "documentation":"

Port for processing traffic.

" - }, - "Type":{ - "shape":"ListenerPropertyType", - "documentation":"

Selection of HTTP or HTTPS traffic.

" - } - }, - "documentation":"

Open port for taking HTTP or HTTPS traffic.

" - }, - "ListenerPropertyRequest":{ - "type":"structure", - "required":[ - "Port", - "Type" - ], - "members":{ - "Port":{ - "shape":"NatGatewayPort", - "documentation":"

Port for processing traffic.

" - }, - "Type":{ - "shape":"ListenerPropertyType", - "documentation":"

Selection of HTTP or HTTPS traffic.

" - } - }, - "documentation":"

This data type is used specifically for the CreateProxy and UpdateProxy APIs.

Open port for taking HTTP or HTTPS traffic.

" - }, - "ListenerPropertyType":{ - "type":"string", - "enum":[ - "HTTP", - "HTTPS" - ] - }, - "ListingName":{"type":"string"}, - "LogDestinationConfig":{ - "type":"structure", - "required":[ - "LogType", - "LogDestinationType", - "LogDestination" - ], - "members":{ - "LogType":{ - "shape":"LogType", - "documentation":"

The type of log to record. You can record the following types of logs from your Network Firewall stateful engine.

  • ALERT - Logs for traffic that matches your stateful rules and that have an action that sends an alert. A stateful rule sends alerts for the rule actions DROP, ALERT, and REJECT. For more information, see StatefulRule.

  • FLOW - Standard network traffic flow logs. The stateful rules engine records flow logs for all network traffic that it receives. Each flow log record captures the network flow for a specific standard stateless rule group.

  • TLS - Logs for events that are related to TLS inspection. For more information, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.

" - }, - "LogDestinationType":{ - "shape":"LogDestinationType", - "documentation":"

The type of storage destination to send these logs to. You can send logs to an Amazon S3 bucket, a CloudWatch log group, or a Firehose delivery stream.

" - }, - "LogDestination":{ - "shape":"LogDestinationMap", - "documentation":"

The named location for the logs, provided in a key:value mapping that is specific to the chosen destination type.

  • For an Amazon S3 bucket, provide the name of the bucket, with key bucketName, and optionally provide a prefix, with key prefix.

    The following example specifies an Amazon S3 bucket named DOC-EXAMPLE-BUCKET and the prefix alerts:

    \"LogDestination\": { \"bucketName\": \"DOC-EXAMPLE-BUCKET\", \"prefix\": \"alerts\" }

  • For a CloudWatch log group, provide the name of the CloudWatch log group, with key logGroup. The following example specifies a log group named alert-log-group:

    \"LogDestination\": { \"logGroup\": \"alert-log-group\" }

  • For a Firehose delivery stream, provide the name of the delivery stream, with key deliveryStream. The following example specifies a delivery stream named alert-delivery-stream:

    \"LogDestination\": { \"deliveryStream\": \"alert-delivery-stream\" }

" - } - }, - "documentation":"

Defines where Network Firewall sends logs for the firewall for one log type. This is used in LoggingConfiguration. You can send each type of log to an Amazon S3 bucket, a CloudWatch log group, or a Firehose delivery stream.

Network Firewall generates logs for stateful rule groups. You can save alert, flow, and TLS log types.

" - }, - "LogDestinationConfigs":{ - "type":"list", - "member":{"shape":"LogDestinationConfig"} - }, - "LogDestinationMap":{ - "type":"map", - "key":{"shape":"HashMapKey"}, - "value":{"shape":"HashMapValue"} - }, - "LogDestinationPermissionException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"} - }, - "documentation":"

Unable to send logs to a configured logging destination.

", - "exception":true - }, - "LogDestinationType":{ - "type":"string", - "enum":[ - "S3", - "CloudWatchLogs", - "KinesisDataFirehose" - ], - "max":30, - "min":2, - "pattern":"[0-9A-Za-z]+" - }, - "LogType":{ - "type":"string", - "enum":[ - "ALERT", - "FLOW", - "TLS" - ] - }, - "LoggingConfiguration":{ - "type":"structure", - "required":["LogDestinationConfigs"], - "members":{ - "LogDestinationConfigs":{ - "shape":"LogDestinationConfigs", - "documentation":"

Defines the logging destinations for the logs for a firewall. Network Firewall generates logs for stateful rule groups.

" - } - }, - "documentation":"

Defines how Network Firewall performs logging for a Firewall.

" - }, - "MatchAttributes":{ - "type":"structure", - "members":{ - "Sources":{ - "shape":"Addresses", - "documentation":"

The source IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any source address.

" - }, - "Destinations":{ - "shape":"Addresses", - "documentation":"

The destination IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any destination address.

" - }, - "SourcePorts":{ - "shape":"PortRanges", - "documentation":"

The source port to inspect for. You can specify an individual port, for example 1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY.

If not specified, this matches with any source port.

This setting is only used for protocols 6 (TCP) and 17 (UDP).

" - }, - "DestinationPorts":{ - "shape":"PortRanges", - "documentation":"

The destination port to inspect for. You can specify an individual port, for example 1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY.

This setting is only used for protocols 6 (TCP) and 17 (UDP).

" - }, - "Protocols":{ - "shape":"ProtocolNumbers", - "documentation":"

The protocols to inspect for, specified using the assigned internet protocol number (IANA) for each protocol. If not specified, this matches with any protocol.

" - }, - "TCPFlags":{ - "shape":"TCPFlags", - "documentation":"

The TCP flags and masks to inspect for. If not specified, this matches with any settings. This setting is only used for protocol 6 (TCP).

" - } - }, - "documentation":"

Criteria for Network Firewall to use to inspect an individual packet in stateless rule inspection. Each match attributes set can include one or more items such as IP address, CIDR range, port number, protocol, and TCP flags.

" - }, - "NatGatewayId":{ - "type":"string", - "min":1 - }, - "NatGatewayPort":{"type":"integer"}, - "NumberOfAssociations":{"type":"integer"}, - "OverrideAction":{ - "type":"string", - "enum":["DROP_TO_ALERT"] - }, - "PacketCount":{"type":"integer"}, - "PaginationMaxResults":{ - "type":"integer", - "max":100, - "min":1 - }, - "PaginationToken":{ - "type":"string", - "max":4096, - "min":1, - "pattern":"[0-9A-Za-z:\\/+=]+$" - }, - "PerObjectStatus":{ - "type":"structure", - "members":{ - "SyncStatus":{ - "shape":"PerObjectSyncStatus", - "documentation":"

Indicates whether this object is in sync with the version indicated in the update token.

" - }, - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

The current version of the object that is either in sync or pending synchronization.

" - } - }, - "documentation":"

Provides configuration status for a single policy or rule group that is used for a firewall endpoint. Network Firewall provides each endpoint with the rules that are configured in the firewall policy. Each time you add a subnet or modify the associated firewall policy, Network Firewall synchronizes the rules in the endpoint, so it can properly filter network traffic. This is part of a SyncState for a firewall.

" - }, - "PerObjectSyncStatus":{ - "type":"string", - "enum":[ - "PENDING", - "IN_SYNC", - "CAPACITY_CONSTRAINED", - "NOT_SUBSCRIBED", - "DEPRECATED" - ] - }, - "PolicyString":{ - "type":"string", - "max":395000, - "min":1, - "pattern":".*\\S.*" - }, - "PolicyVariables":{ - "type":"structure", - "members":{ - "RuleVariables":{ - "shape":"IPSets", - "documentation":"

The IPv4 or IPv6 addresses in CIDR notation to use for the Suricata HOME_NET variable. If your firewall uses an inspection VPC, you might want to override the HOME_NET variable with the CIDRs of your home networks. If you don't override HOME_NET with your own CIDRs, Network Firewall by default uses the CIDR of your inspection VPC.

" - } - }, - "documentation":"

Contains variables that you can use to override default Suricata settings in your firewall policy.

" - }, - "Port":{ - "type":"string", - "max":1024, - "min":1, - "pattern":"^.*$" - }, - "PortRange":{ - "type":"structure", - "required":[ - "FromPort", - "ToPort" - ], - "members":{ - "FromPort":{ - "shape":"PortRangeBound", - "documentation":"

The lower limit of the port range. This must be less than or equal to the ToPort specification.

" - }, - "ToPort":{ - "shape":"PortRangeBound", - "documentation":"

The upper limit of the port range. This must be greater than or equal to the FromPort specification.

" - } - }, - "documentation":"

A single port range specification. This is used for source and destination port ranges in the stateless rule MatchAttributes, SourcePorts, and DestinationPorts settings.

" - }, - "PortRangeBound":{ - "type":"integer", - "max":65535, - "min":0 - }, - "PortRanges":{ - "type":"list", - "member":{"shape":"PortRange"} - }, - "PortSet":{ - "type":"structure", - "members":{ - "Definition":{ - "shape":"VariableDefinitionList", - "documentation":"

The set of port ranges.

" - } - }, - "documentation":"

A set of port ranges for use in the rules in a rule group.

" - }, - "PortSets":{ - "type":"map", - "key":{"shape":"RuleVariableName"}, - "value":{"shape":"PortSet"} - }, - "Priority":{ - "type":"integer", - "max":65535, - "min":1 - }, - "PrivateDNSName":{"type":"string"}, - "ProductId":{"type":"string"}, - "ProtocolNumber":{ - "type":"integer", - "max":255, - "min":0 - }, - "ProtocolNumbers":{ - "type":"list", - "member":{"shape":"ProtocolNumber"} - }, - "ProtocolString":{ - "type":"string", - "max":12, - "min":1, - "pattern":"^.*$" - }, - "ProtocolStrings":{ - "type":"list", - "member":{"shape":"ProtocolString"} - }, - "Proxies":{ - "type":"list", - "member":{"shape":"ProxyMetadata"} - }, - "Proxy":{ - "type":"structure", - "members":{ - "CreateTime":{ - "shape":"CreateTime", - "documentation":"

Time the Proxy was created.

" - }, - "DeleteTime":{ - "shape":"DeleteTime", - "documentation":"

Time the Proxy was deleted.

" - }, - "UpdateTime":{ - "shape":"UpdateTime", - "documentation":"

Time the Proxy was updated.

" - }, - "FailureCode":{ - "shape":"FailureCode", - "documentation":"

Failure code for cases when the Proxy fails to attach or update.

" - }, - "FailureMessage":{ - "shape":"FailureMessage", - "documentation":"

Failure message for cases when the Proxy fails to attach or update.

" - }, - "ProxyState":{ - "shape":"ProxyState", - "documentation":"

Current attachment/detachment status of the Proxy.

" - }, - "ProxyModifyState":{ - "shape":"ProxyModifyState", - "documentation":"

Current modification status of the Proxy.

" - }, - "NatGatewayId":{ - "shape":"NatGatewayId", - "documentation":"

The NAT Gateway for the proxy.

" - }, - "ProxyConfigurationName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.

" - }, - "ProxyConfigurationArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of a proxy configuration.

" - }, - "ProxyName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy. You can't change the name of a proxy after you create it.

" - }, - "ProxyArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of a proxy.

" - }, - "ListenerProperties":{ - "shape":"ListenerProperties", - "documentation":"

Listener properties for HTTP and HTTPS traffic.

" - }, - "TlsInterceptProperties":{ - "shape":"TlsInterceptProperties", - "documentation":"

TLS decryption on traffic to filter on attributes in the HTTP header.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The key:value pairs to associate with the resource.

" - } - }, - "documentation":"

Proxy attached to a NAT gateway.

" - }, - "ProxyConditionValue":{"type":"string"}, - "ProxyConditionValueList":{ - "type":"list", - "member":{"shape":"ProxyConditionValue"} - }, - "ProxyConfigDefaultRulePhaseActionsRequest":{ - "type":"structure", - "members":{ - "PreDNS":{ - "shape":"ProxyRulePhaseAction", - "documentation":"

Before domain resolution.

" - }, - "PreREQUEST":{ - "shape":"ProxyRulePhaseAction", - "documentation":"

After DNS, before request.

" - }, - "PostRESPONSE":{ - "shape":"ProxyRulePhaseAction", - "documentation":"

After receiving response.

" - } - }, - "documentation":"

Evaluation points in the traffic flow where rules are applied. There are three phases in a traffic where the rule match is applied.

This data type is used specifically for the CreateProxyConfiguration and UpdateProxyConfiguration APIs.

" - }, - "ProxyConfigRuleGroup":{ - "type":"structure", - "members":{ - "ProxyRuleGroupName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.

" - }, - "ProxyRuleGroupArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of a proxy rule group.

" - }, - "Type":{ - "shape":"ProxyConfigRuleGroupType", - "documentation":"

Proxy rule group type.

" - }, - "Priority":{ - "shape":"ProxyConfigRuleGroupPriority", - "documentation":"

Priority of the proxy rule group in the proxy configuration.

" - } - }, - "documentation":"

Proxy rule group contained within a proxy configuration.

" - }, - "ProxyConfigRuleGroupPriority":{"type":"integer"}, - "ProxyConfigRuleGroupSet":{ - "type":"list", - "member":{"shape":"ProxyConfigRuleGroup"} - }, - "ProxyConfigRuleGroupType":{"type":"string"}, - "ProxyConfiguration":{ - "type":"structure", - "members":{ - "ProxyConfigurationName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.

" - }, - "ProxyConfigurationArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of a proxy configuration.

" - }, - "Description":{ - "shape":"Description", - "documentation":"

A description of the proxy configuration.

" - }, - "CreateTime":{ - "shape":"CreateTime", - "documentation":"

Time the Proxy Configuration was created.

" - }, - "DeleteTime":{ - "shape":"DeleteTime", - "documentation":"

Time the Proxy Configuration was deleted.

" - }, - "RuleGroups":{ - "shape":"ProxyConfigRuleGroupSet", - "documentation":"

Proxy rule groups within the proxy configuration.

" - }, - "DefaultRulePhaseActions":{ - "shape":"ProxyConfigDefaultRulePhaseActionsRequest", - "documentation":"

Evaluation points in the traffic flow where rules are applied. There are three phases in a traffic where the rule match is applied.

Pre-DNS - before domain resolution.

Pre-Request - after DNS, before request.

Post-Response - after receiving response.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The key:value pairs to associate with the resource.

" - } - }, - "documentation":"

A Proxy Configuration defines the monitoring and protection behavior for a Proxy. The details of the behavior are defined in the rule groups that you add to your configuration.

" - }, - "ProxyConfigurationMetadata":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.

" - }, - "Arn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of a proxy configuration.

" - } - }, - "documentation":"

High-level information about a proxy configuration, returned by operations like create and describe. You can use the information provided in the metadata to retrieve and manage a proxy configuration. You can retrieve all objects for a proxy configuration by calling DescribeProxyConfiguration.

" - }, - "ProxyConfigurations":{ - "type":"list", - "member":{"shape":"ProxyConfigurationMetadata"} - }, - "ProxyMetadata":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy. You can't change the name of a proxy after you create it.

" - }, - "Arn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of a proxy.

" - } - }, - "documentation":"

High-level information about a proxy, returned by operations like create and describe. You can use the information provided in the metadata to retrieve and manage a proxy. You can retrieve all objects for a proxy by calling DescribeProxy.

" - }, - "ProxyModifyState":{ - "type":"string", - "enum":[ - "MODIFYING", - "COMPLETED", - "FAILED" - ] - }, - "ProxyRule":{ - "type":"structure", - "members":{ - "ProxyRuleName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy rule. You can't change the name of a proxy rule after you create it.

" - }, - "Description":{ - "shape":"Description", - "documentation":"

A description of the proxy rule.

" - }, - "Action":{ - "shape":"ProxyRulePhaseAction", - "documentation":"

Action to take.

" - }, - "Conditions":{ - "shape":"ProxyRuleConditionList", - "documentation":"

Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.

" - } - }, - "documentation":"

Individual rules that define match conditions and actions for application-layer traffic. Rules specify what to inspect (domains, headers, methods) and what action to take (allow, deny, alert).

" - }, - "ProxyRuleCondition":{ - "type":"structure", - "members":{ - "ConditionOperator":{ - "shape":"ConditionOperator", - "documentation":"

Defines how to perform a match.

" - }, - "ConditionKey":{ - "shape":"ConditionKey", - "documentation":"

Defines what is to be matched.

" - }, - "ConditionValues":{ - "shape":"ProxyConditionValueList", - "documentation":"

Specifes the exact value that needs to be matched against.

" - } - }, - "documentation":"

Match criteria that specify what traffic attributes to examine.

" - }, - "ProxyRuleConditionList":{ - "type":"list", - "member":{"shape":"ProxyRuleCondition"} - }, - "ProxyRuleGroup":{ - "type":"structure", - "members":{ - "ProxyRuleGroupName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.

" - }, - "ProxyRuleGroupArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of a proxy rule group.

" - }, - "CreateTime":{ - "shape":"CreateTime", - "documentation":"

Time the Proxy Rule Group was created.

" - }, - "DeleteTime":{ - "shape":"DeleteTime", - "documentation":"

Time the Proxy Rule Group was deleted.

" - }, - "Rules":{ - "shape":"ProxyRulesByRequestPhase", - "documentation":"

Individual rules that define match conditions and actions for application-layer traffic. Rules specify what to inspect (domains, headers, methods) and what action to take (allow, deny, alert).

" - }, - "Description":{ - "shape":"Description", - "documentation":"

A description of the proxy rule group.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The key:value pairs to associate with the resource.

" - } - }, - "documentation":"

Collections of related proxy filtering rules. Rule groups help you manage and reuse sets of rules across multiple proxy configurations.

" - }, - "ProxyRuleGroupAttachment":{ - "type":"structure", - "members":{ - "ProxyRuleGroupName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.

" - }, - "InsertPosition":{ - "shape":"InsertPosition", - "documentation":"

Where to insert a proxy rule group in a proxy configuration.

" - } - }, - "documentation":"

The proxy rule group(s) to attach to the proxy configuration

" - }, - "ProxyRuleGroupAttachmentList":{ - "type":"list", - "member":{"shape":"ProxyRuleGroupAttachment"} - }, - "ProxyRuleGroupMetadata":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.

" - }, - "Arn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of a proxy rule group.

" - } - }, - "documentation":"

High-level information about a proxy rule group, returned by operations like create and describe. You can use the information provided in the metadata to retrieve and manage a proxy rule group. You can retrieve all objects for a proxy rule group by calling DescribeProxyRuleGroup.

" - }, - "ProxyRuleGroupPriority":{ - "type":"structure", - "members":{ - "ProxyRuleGroupName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.

" - }, - "NewPosition":{ - "shape":"InsertPosition", - "documentation":"

Where to move a proxy rule group in a proxy configuration.

" - } - }, - "documentation":"

Proxy rule group name and new desired position.

" - }, - "ProxyRuleGroupPriorityList":{ - "type":"list", - "member":{"shape":"ProxyRuleGroupPriority"} - }, - "ProxyRuleGroupPriorityResult":{ - "type":"structure", - "members":{ - "ProxyRuleGroupName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.

" - }, - "Priority":{ - "shape":"ProxyRuleGroupPriorityResultPriority", - "documentation":"

Priority of the proxy rule group in the proxy configuration.

" - } - }, - "documentation":"

Proxy rule group along with its priority.

" - }, - "ProxyRuleGroupPriorityResultList":{ - "type":"list", - "member":{"shape":"ProxyRuleGroupPriorityResult"} - }, - "ProxyRuleGroupPriorityResultPriority":{"type":"integer"}, - "ProxyRuleGroups":{ - "type":"list", - "member":{"shape":"ProxyRuleGroupMetadata"} - }, - "ProxyRuleList":{ - "type":"list", - "member":{"shape":"ProxyRule"} - }, - "ProxyRulePhaseAction":{ - "type":"string", - "enum":[ - "ALLOW", - "DENY", - "ALERT" - ] - }, - "ProxyRulePriority":{ - "type":"structure", - "members":{ - "ProxyRuleName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy rule. You can't change the name of a proxy rule after you create it.

" - }, - "NewPosition":{ - "shape":"InsertPosition", - "documentation":"

Where to move a proxy rule in a proxy rule group.

" - } - }, - "documentation":"

Proxy rule name and new desired position.

" - }, - "ProxyRulePriorityList":{ - "type":"list", - "member":{"shape":"ProxyRulePriority"} - }, - "ProxyRulesByRequestPhase":{ - "type":"structure", - "members":{ - "PreDNS":{ - "shape":"ProxyRuleList", - "documentation":"

Before domain resolution.

" - }, - "PreREQUEST":{ - "shape":"ProxyRuleList", - "documentation":"

After DNS, before request.

" - }, - "PostRESPONSE":{ - "shape":"ProxyRuleList", - "documentation":"

After receiving response.

" - } - }, - "documentation":"

Evaluation points in the traffic flow where rules are applied. There are three phases in a traffic where the rule match is applied.

" - }, - "ProxyState":{ - "type":"string", - "enum":[ - "ATTACHING", - "ATTACHED", - "DETACHING", - "DETACHED", - "ATTACH_FAILED", - "DETACH_FAILED" - ] - }, - "PublishMetricAction":{ - "type":"structure", - "required":["Dimensions"], - "members":{ - "Dimensions":{ - "shape":"Dimensions", - "documentation":"

" - } - }, - "documentation":"

Stateless inspection criteria that publishes the specified metrics to Amazon CloudWatch for the matching packet. This setting defines a CloudWatch dimension value to be published.

" - }, - "PutResourcePolicyRequest":{ - "type":"structure", - "required":[ - "ResourceArn", - "Policy" - ], - "members":{ - "ResourceArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the account that you want to share your Network Firewall resources with.

" - }, - "Policy":{ - "shape":"PolicyString", - "documentation":"

The IAM policy statement that lists the accounts that you want to share your Network Firewall resources with and the operations that you want the accounts to be able to perform.

For a rule group resource, you can specify the following operations in the Actions section of the statement:

  • network-firewall:CreateFirewallPolicy

  • network-firewall:UpdateFirewallPolicy

  • network-firewall:ListRuleGroups

For a firewall policy resource, you can specify the following operations in the Actions section of the statement:

  • network-firewall:AssociateFirewallPolicy

  • network-firewall:ListFirewallPolicies

For a firewall resource, you can specify the following operations in the Actions section of the statement:

  • network-firewall:CreateVpcEndpointAssociation

  • network-firewall:DescribeFirewallMetadata

  • network-firewall:ListFirewalls

In the Resource section of the statement, you specify the ARNs for the Network Firewall resources that you want to share with the account that you specified in Arn.

" - } - } - }, - "PutResourcePolicyResponse":{ - "type":"structure", - "members":{} - }, - "ReferenceSets":{ - "type":"structure", - "members":{ - "IPSetReferences":{ - "shape":"IPSetReferenceMap", - "documentation":"

The list of IP set references.

" - } - }, - "documentation":"

Contains a set of IP set references.

" - }, - "RejectNetworkFirewallTransitGatewayAttachmentRequest":{ - "type":"structure", - "required":["TransitGatewayAttachmentId"], - "members":{ - "TransitGatewayAttachmentId":{ - "shape":"TransitGatewayAttachmentId", - "documentation":"

Required. The unique identifier of the transit gateway attachment to reject. This ID is returned in the response when creating a transit gateway-attached firewall.

" - } - } - }, - "RejectNetworkFirewallTransitGatewayAttachmentResponse":{ - "type":"structure", - "required":[ - "TransitGatewayAttachmentId", - "TransitGatewayAttachmentStatus" - ], - "members":{ - "TransitGatewayAttachmentId":{ - "shape":"TransitGatewayAttachmentId", - "documentation":"

The unique identifier of the transit gateway attachment that was rejected.

" - }, - "TransitGatewayAttachmentStatus":{ - "shape":"TransitGatewayAttachmentStatus", - "documentation":"

The current status of the transit gateway attachment. Valid values are:

  • CREATING - The attachment is being created

  • DELETING - The attachment is being deleted

  • DELETED - The attachment has been deleted

  • FAILED - The attachment creation has failed and cannot be recovered

  • ERROR - The attachment is in an error state that might be recoverable

  • READY - The attachment is active and processing traffic

  • PENDING_ACCEPTANCE - The attachment is waiting to be accepted

  • REJECTING - The attachment is in the process of being rejected

  • REJECTED - The attachment has been rejected

For information about troubleshooting endpoint failures, see Troubleshooting firewall endpoint failures in the Network Firewall Developer Guide.

" - } - } - }, - "ReportTime":{"type":"timestamp"}, - "ResourceArn":{ - "type":"string", - "max":256, - "min":1, - "pattern":"^arn:aws.*" - }, - "ResourceArnList":{ - "type":"list", - "member":{"shape":"ResourceArn"} - }, - "ResourceId":{ - "type":"string", - "max":36, - "min":36, - "pattern":"^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$" - }, - "ResourceManagedStatus":{ - "type":"string", - "enum":[ - "MANAGED", - "ACCOUNT" - ] - }, - "ResourceManagedType":{ - "type":"string", - "enum":[ - "AWS_MANAGED_THREAT_SIGNATURES", - "AWS_MANAGED_DOMAIN_LISTS", - "ACTIVE_THREAT_DEFENSE", - "PARTNER_MANAGED" - ] - }, - "ResourceName":{ - "type":"string", - "max":128, - "min":1, - "pattern":"^[a-zA-Z0-9-]+$" - }, - "ResourceNameList":{ - "type":"list", - "member":{"shape":"ResourceName"} - }, - "ResourceNotFoundException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"} - }, - "documentation":"

Unable to locate a resource using the parameters that you provided.

", - "exception":true - }, - "ResourceOwnerCheckException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"} - }, - "documentation":"

Unable to change the resource because your account doesn't own it.

", - "exception":true - }, - "ResourceStatus":{ - "type":"string", - "enum":[ - "ACTIVE", - "DELETING", - "ERROR" - ] - }, - "RevocationCheckAction":{ - "type":"string", - "enum":[ - "PASS", - "DROP", - "REJECT" - ] - }, - "RuleCapacity":{"type":"integer"}, - "RuleDefinition":{ - "type":"structure", - "required":[ - "MatchAttributes", - "Actions" - ], - "members":{ - "MatchAttributes":{ - "shape":"MatchAttributes", - "documentation":"

Criteria for Network Firewall to use to inspect an individual packet in stateless rule inspection. Each match attributes set can include one or more items such as IP address, CIDR range, port number, protocol, and TCP flags.

" - }, - "Actions":{ - "shape":"StatelessActions", - "documentation":"

The actions to take on a packet that matches one of the stateless rule definition's match attributes. You must specify a standard action and you can add custom actions.

Network Firewall only forwards a packet for stateful rule inspection if you specify aws:forward_to_sfe for a rule that the packet matches, or if the packet doesn't match any stateless rule and you specify aws:forward_to_sfe for the StatelessDefaultActions setting for the FirewallPolicy.

For every rule, you must specify exactly one of the following standard actions.

  • aws:pass - Discontinues all inspection of the packet and permits it to go to its intended destination.

  • aws:drop - Discontinues all inspection of the packet and blocks it from going to its intended destination.

  • aws:forward_to_sfe - Discontinues stateless inspection of the packet and forwards it to the stateful rule engine for inspection.

Additionally, you can specify a custom action. To do this, you define a custom action by name and type, then provide the name you've assigned to the action in this Actions setting. For information about the options, see CustomAction.

To provide more than one action in this setting, separate the settings with a comma. For example, if you have a custom PublishMetrics action that you've named MyMetricsAction, then you could specify the standard action aws:pass and the custom action with [“aws:pass”, “MyMetricsAction”].

" - } - }, - "documentation":"

The inspection criteria and action for a single stateless rule. Network Firewall inspects each packet for the specified matching criteria. When a packet matches the criteria, Network Firewall performs the rule's actions on the packet.

" - }, - "RuleGroup":{ - "type":"structure", - "required":["RulesSource"], - "members":{ - "RuleVariables":{ - "shape":"RuleVariables", - "documentation":"

Settings that are available for use in the rules in the rule group. You can only use these for stateful rule groups.

" - }, - "ReferenceSets":{ - "shape":"ReferenceSets", - "documentation":"

The list of a rule group's reference sets.

" - }, - "RulesSource":{ - "shape":"RulesSource", - "documentation":"

The stateful rules or stateless rules for the rule group.

" - }, - "StatefulRuleOptions":{ - "shape":"StatefulRuleOptions", - "documentation":"

Additional options governing how Network Firewall handles stateful rules. The policies where you use your stateful rule group must have stateful rule options settings that are compatible with these settings. Some limitations apply; for more information, see Strict evaluation order in the Network Firewall Developer Guide.

" - } - }, - "documentation":"

The object that defines the rules in a rule group. This, along with RuleGroupResponse, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

Network Firewall uses a rule group to inspect and control network traffic. You define stateless rule groups to inspect individual packets and you define stateful rule groups to inspect packets in the context of their traffic flow.

To use a rule group, you include it by reference in an Network Firewall firewall policy, then you use the policy in a firewall. You can reference a rule group from more than one firewall policy, and you can use a firewall policy in more than one firewall.

" - }, - "RuleGroupMetadata":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

" - }, - "Arn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the rule group.

" - }, - "VendorName":{ - "shape":"VendorName", - "documentation":"

The name of the Amazon Web Services Marketplace seller that provides this rule group.

" - } - }, - "documentation":"

High-level information about a rule group, returned by ListRuleGroups. You can use the information provided in the metadata to retrieve and manage a rule group.

" - }, - "RuleGroupRequestPhase":{ - "type":"string", - "enum":[ - "PRE_DNS", - "PRE_REQ", - "POST_RES" - ] - }, - "RuleGroupResponse":{ - "type":"structure", - "required":[ - "RuleGroupArn", - "RuleGroupName", - "RuleGroupId" - ], - "members":{ - "RuleGroupArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the rule group.

If this response is for a create request that had DryRun set to TRUE, then this ARN is a placeholder that isn't attached to a valid resource.

" - }, - "RuleGroupName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

" - }, - "RuleGroupId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier for the rule group.

" - }, - "Description":{ - "shape":"Description", - "documentation":"

A description of the rule group.

" - }, - "Type":{ - "shape":"RuleGroupType", - "documentation":"

Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

" - }, - "Capacity":{ - "shape":"RuleCapacity", - "documentation":"

The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.

You can retrieve the capacity that would be required for a rule group before you create the rule group by calling CreateRuleGroup with DryRun set to TRUE.

" - }, - "RuleGroupStatus":{ - "shape":"ResourceStatus", - "documentation":"

Detailed information about the current status of a rule group.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The key:value pairs to associate with the resource.

" - }, - "ConsumedCapacity":{ - "shape":"RuleCapacity", - "documentation":"

The number of capacity units currently consumed by the rule group rules.

" - }, - "NumberOfAssociations":{ - "shape":"NumberOfAssociations", - "documentation":"

The number of firewall policies that use this rule group.

" - }, - "EncryptionConfiguration":{ - "shape":"EncryptionConfiguration", - "documentation":"

A complex type that contains the Amazon Web Services KMS encryption configuration settings for your rule group.

" - }, - "SourceMetadata":{ - "shape":"SourceMetadata", - "documentation":"

A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to track the version updates made to the originating rule group.

" - }, - "SnsTopic":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service SNS topic that's used to record changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the Amazon Simple Notification Service Developer Guide..

" - }, - "LastModifiedTime":{ - "shape":"LastUpdateTime", - "documentation":"

The last time that the rule group was changed.

" - }, - "AnalysisResults":{ - "shape":"AnalysisResultList", - "documentation":"

The list of analysis results for AnalyzeRuleGroup. If you set AnalyzeRuleGroup to TRUE in CreateRuleGroup, UpdateRuleGroup, or DescribeRuleGroup, Network Firewall analyzes the rule group and identifies the rules that might adversely effect your firewall's functionality. For example, if Network Firewall detects a rule that's routing traffic asymmetrically, which impacts the service's ability to properly process traffic, the service includes the rule in the list of analysis results.

" - }, - "SummaryConfiguration":{ - "shape":"SummaryConfiguration", - "documentation":"

A complex type containing the currently selected rule option fields that will be displayed for rule summarization returned by DescribeRuleGroupSummary.

" - } - }, - "documentation":"

The high-level properties of a rule group. This, along with the RuleGroup, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

" - }, - "RuleGroupType":{ - "type":"string", - "enum":[ - "STATELESS", - "STATEFUL", - "STATEFUL_DOMAIN" - ] - }, - "RuleGroups":{ - "type":"list", - "member":{"shape":"RuleGroupMetadata"} - }, - "RuleIdList":{ - "type":"list", - "member":{"shape":"CollectionMember_String"} - }, - "RuleOption":{ - "type":"structure", - "required":["Keyword"], - "members":{ - "Keyword":{ - "shape":"Keyword", - "documentation":"

The keyword for the Suricata compatible rule option. You must include a sid (signature ID), and can optionally include other keywords. For information about Suricata compatible keywords, see Rule options in the Suricata documentation.

" - }, - "Settings":{ - "shape":"Settings", - "documentation":"

The settings of the Suricata compatible rule option. Rule options have zero or more setting values, and the number of possible and required settings depends on the Keyword. For more information about the settings for specific options, see Rule options.

" - } - }, - "documentation":"

Additional settings for a stateful rule. This is part of the StatefulRule configuration.

" - }, - "RuleOptions":{ - "type":"list", - "member":{"shape":"RuleOption"} - }, - "RuleOrder":{ - "type":"string", - "enum":[ - "DEFAULT_ACTION_ORDER", - "STRICT_ORDER" - ] - }, - "RuleSummaries":{ - "type":"list", - "member":{"shape":"RuleSummary"} - }, - "RuleSummary":{ - "type":"structure", - "members":{ - "SID":{ - "shape":"CollectionMember_String", - "documentation":"

The unique identifier (Signature ID) of the Suricata rule.

" - }, - "Msg":{ - "shape":"CollectionMember_String", - "documentation":"

The contents taken from the rule's msg field.

" - }, - "Metadata":{ - "shape":"CollectionMember_String", - "documentation":"

The contents of the rule's metadata.

" - } - }, - "documentation":"

A complex type containing details about a Suricata rule. Contains:

  • SID

  • Msg

  • Metadata

Summaries are available for rule groups you manage and for active threat defense Amazon Web Services managed rule groups.

" - }, - "RuleTargets":{ - "type":"list", - "member":{"shape":"CollectionMember_String"} - }, - "RuleVariableName":{ - "type":"string", - "max":32, - "min":1, - "pattern":"^[A-Za-z][A-Za-z0-9_]*$" - }, - "RuleVariables":{ - "type":"structure", - "members":{ - "IPSets":{ - "shape":"IPSets", - "documentation":"

A list of IP addresses and address ranges, in CIDR notation.

" - }, - "PortSets":{ - "shape":"PortSets", - "documentation":"

A list of port ranges.

" - } - }, - "documentation":"

Settings that are available for use in the rules in the RuleGroup where this is defined. See CreateRuleGroup or UpdateRuleGroup for usage.

" - }, - "RulesSource":{ - "type":"structure", - "members":{ - "RulesString":{ - "shape":"RulesString", - "documentation":"

Stateful inspection criteria, provided in Suricata compatible rules. Suricata is an open-source threat detection framework that includes a standard rule-based language for network traffic inspection.

These rules contain the inspection criteria and the action to take for traffic that matches the criteria, so this type of rule group doesn't have a separate action setting.

You can't use the priority keyword if the RuleOrder option in StatefulRuleOptions is set to STRICT_ORDER.

" - }, - "RulesSourceList":{ - "shape":"RulesSourceList", - "documentation":"

Stateful inspection criteria for a domain list rule group.

" - }, - "StatefulRules":{ - "shape":"StatefulRules", - "documentation":"

An array of individual stateful rules inspection criteria to be used together in a stateful rule group. Use this option to specify simple Suricata rules with protocol, source and destination, ports, direction, and rule options. For information about the Suricata Rules format, see Rules Format.

" - }, - "StatelessRulesAndCustomActions":{ - "shape":"StatelessRulesAndCustomActions", - "documentation":"

Stateless inspection criteria to be used in a stateless rule group.

" - } - }, - "documentation":"

The stateless or stateful rules definitions for use in a single rule group. Each rule group requires a single RulesSource. You can use an instance of this for either stateless rules or stateful rules.

" - }, - "RulesSourceList":{ - "type":"structure", - "required":[ - "Targets", - "TargetTypes", - "GeneratedRulesType" - ], - "members":{ - "Targets":{ - "shape":"RuleTargets", - "documentation":"

The domains that you want to inspect for in your traffic flows. Valid domain specifications are the following:

  • Explicit names. For example, abc.example.com matches only the domain abc.example.com.

  • Names that use a domain wildcard, which you indicate with an initial '.'. For example,.example.com matches example.com and matches all subdomains of example.com, such as abc.example.com and www.example.com.

" - }, - "TargetTypes":{ - "shape":"TargetTypes", - "documentation":"

The protocols you want to inspect. Specify TLS_SNI for HTTPS. Specify HTTP_HOST for HTTP. You can specify either or both.

" - }, - "GeneratedRulesType":{ - "shape":"GeneratedRulesType", - "documentation":"

Whether you want to apply allow, reject, alert, or drop behavior to the domains in your target list.

When logging is enabled and you choose Alert, traffic that matches the domain specifications generates an alert in the firewall's logs. Then, traffic either passes, is rejected, or drops based on other rules in the firewall policy.

" - } - }, - "documentation":"

Stateful inspection criteria for a domain list rule group.

For HTTPS traffic, domain filtering is SNI-based. It uses the server name indicator extension of the TLS handshake.

By default, Network Firewall domain list inspection only includes traffic coming from the VPC where you deploy the firewall. To inspect traffic from IP addresses outside of the deployment VPC, you set the HOME_NET rule variable to include the CIDR range of the deployment VPC plus the other CIDR ranges. For more information, see RuleVariables in this guide and Stateful domain list rule groups in Network Firewall in the Network Firewall Developer Guide.

" - }, - "RulesString":{ - "type":"string", - "max":2000000, - "min":0 - }, - "ServerCertificate":{ - "type":"structure", - "members":{ - "ResourceArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the Certificate Manager SSL/TLS server certificate that's used for inbound SSL/TLS inspection.

" - } - }, - "documentation":"

Any Certificate Manager (ACM) Secure Sockets Layer/Transport Layer Security (SSL/TLS) server certificate that's associated with a ServerCertificateConfiguration. Used in a TLSInspectionConfiguration for inspection of inbound traffic to your firewall. You must request or import a SSL/TLS certificate into ACM for each domain Network Firewall needs to decrypt and inspect. Network Firewall uses the SSL/TLS certificates to decrypt specified inbound SSL/TLS traffic going to your firewall. For information about working with certificates in Certificate Manager, see Request a public certificate or Importing certificates in the Certificate Manager User Guide.

" - }, - "ServerCertificateConfiguration":{ - "type":"structure", - "members":{ - "ServerCertificates":{ - "shape":"ServerCertificates", - "documentation":"

The list of server certificates to use for inbound SSL/TLS inspection.

" - }, - "Scopes":{ - "shape":"ServerCertificateScopes", - "documentation":"

A list of scopes.

" - }, - "CertificateAuthorityArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the imported certificate authority (CA) certificate within Certificate Manager (ACM) to use for outbound SSL/TLS inspection.

The following limitations apply:

  • You can use CA certificates that you imported into ACM, but you can't generate CA certificates with ACM.

  • You can't use certificates issued by Private Certificate Authority.

For more information about configuring certificates for outbound inspection, see Using SSL/TLS certificates with TLS inspection configurations in the Network Firewall Developer Guide.

For information about working with certificates in ACM, see Importing certificates in the Certificate Manager User Guide.

" - }, - "CheckCertificateRevocationStatus":{ - "shape":"CheckCertificateRevocationStatusActions", - "documentation":"

When enabled, Network Firewall checks if the server certificate presented by the server in the SSL/TLS connection has a revoked or unkown status. If the certificate has an unknown or revoked status, you must specify the actions that Network Firewall takes on outbound traffic. To check the certificate revocation status, you must also specify a CertificateAuthorityArn in ServerCertificateConfiguration.

" - } - }, - "documentation":"

Configures the Certificate Manager certificates and scope that Network Firewall uses to decrypt and re-encrypt traffic using a TLSInspectionConfiguration. You can configure ServerCertificates for inbound SSL/TLS inspection, a CertificateAuthorityArn for outbound SSL/TLS inspection, or both. For information about working with certificates for TLS inspection, see Using SSL/TLS server certficiates with TLS inspection configurations in the Network Firewall Developer Guide.

If a server certificate that's associated with your TLSInspectionConfiguration is revoked, deleted, or expired it can result in client-side TLS errors.

" - }, - "ServerCertificateConfigurations":{ - "type":"list", - "member":{"shape":"ServerCertificateConfiguration"} - }, - "ServerCertificateScope":{ - "type":"structure", - "members":{ - "Sources":{ - "shape":"Addresses", - "documentation":"

The source IP addresses and address ranges to decrypt for inspection, in CIDR notation. If not specified, this matches with any source address.

" - }, - "Destinations":{ - "shape":"Addresses", - "documentation":"

The destination IP addresses and address ranges to decrypt for inspection, in CIDR notation. If not specified, this matches with any destination address.

" - }, - "SourcePorts":{ - "shape":"PortRanges", - "documentation":"

The source ports to decrypt for inspection, in Transmission Control Protocol (TCP) format. If not specified, this matches with any source port.

You can specify individual ports, for example 1994, and you can specify port ranges, such as 1990:1994.

" - }, - "DestinationPorts":{ - "shape":"PortRanges", - "documentation":"

The destination ports to decrypt for inspection, in Transmission Control Protocol (TCP) format. If not specified, this matches with any destination port.

You can specify individual ports, for example 1994, and you can specify port ranges, such as 1990:1994.

" - }, - "Protocols":{ - "shape":"ProtocolNumbers", - "documentation":"

The protocols to inspect for, specified using the assigned internet protocol number (IANA) for each protocol. If not specified, this matches with any protocol.

Network Firewall currently supports only TCP.

" - } - }, - "documentation":"

Settings that define the Secure Sockets Layer/Transport Layer Security (SSL/TLS) traffic that Network Firewall should decrypt for inspection by the stateful rule engine.

" - }, - "ServerCertificateScopes":{ - "type":"list", - "member":{"shape":"ServerCertificateScope"} - }, - "ServerCertificates":{ - "type":"list", - "member":{"shape":"ServerCertificate"} - }, - "Setting":{ - "type":"string", - "max":8192, - "min":1, - "pattern":".*" - }, - "Settings":{ - "type":"list", - "member":{"shape":"Setting"} - }, - "Source":{ - "type":"string", - "max":1024, - "min":1, - "pattern":"^.*$" - }, - "SourceMetadata":{ - "type":"structure", - "members":{ - "SourceArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the rule group that your own rule group is copied from.

" - }, - "SourceUpdateToken":{ - "shape":"UpdateToken", - "documentation":"

The update token of the Amazon Web Services managed rule group that your own rule group is copied from. To determine the update token for the managed rule group, call DescribeRuleGroup.

" - } - }, - "documentation":"

High-level information about the managed rule group that your own rule group is copied from. You can use the the metadata to track version updates made to the originating rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

" - }, - "StartAnalysisReportRequest":{ - "type":"structure", - "required":["AnalysisType"], - "members":{ - "FirewallName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

" - }, - "AnalysisType":{ - "shape":"EnabledAnalysisType", - "documentation":"

The type of traffic that will be used to generate a report.

" - } - } - }, - "StartAnalysisReportResponse":{ - "type":"structure", - "required":["AnalysisReportId"], - "members":{ - "AnalysisReportId":{ - "shape":"AnalysisReportId", - "documentation":"

The unique ID of the query that ran when you requested an analysis report.

" - } - } - }, - "StartFlowCaptureRequest":{ - "type":"structure", - "required":[ - "FirewallArn", - "FlowFilters" - ], - "members":{ - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

" - }, - "AvailabilityZone":{ - "shape":"AvailabilityZone", - "documentation":"

The ID of the Availability Zone where the firewall is located. For example, us-east-2a.

Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.

" - }, - "VpcEndpointAssociationArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of a VPC endpoint association.

" - }, - "VpcEndpointId":{ - "shape":"VpcEndpointId", - "documentation":"

A unique identifier for the primary endpoint associated with a firewall.

" - }, - "MinimumFlowAgeInSeconds":{ - "shape":"Age", - "documentation":"

The reqested FlowOperation ignores flows with an age (in seconds) lower than MinimumFlowAgeInSeconds. You provide this for start commands.

We recommend setting this value to at least 1 minute (60 seconds) to reduce chance of capturing flows that are not yet established.

" - }, - "FlowFilters":{ - "shape":"FlowFilters", - "documentation":"

Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.

" - } - } - }, - "StartFlowCaptureResponse":{ - "type":"structure", - "members":{ - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

" - }, - "FlowOperationId":{ - "shape":"FlowOperationId", - "documentation":"

A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.

" - }, - "FlowOperationStatus":{ - "shape":"FlowOperationStatus", - "documentation":"

Returns the status of the flow operation. This string is returned in the responses to start, list, and describe commands.

If the status is COMPLETED_WITH_ERRORS, results may be returned with any number of Flows missing from the response. If the status is FAILED, Flows returned will be empty.

" - } - } - }, - "StartFlowFlushRequest":{ - "type":"structure", - "required":[ - "FirewallArn", - "FlowFilters" - ], - "members":{ - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

" - }, - "AvailabilityZone":{ - "shape":"AvailabilityZone", - "documentation":"

The ID of the Availability Zone where the firewall is located. For example, us-east-2a.

Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.

" - }, - "VpcEndpointAssociationArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of a VPC endpoint association.

" - }, - "VpcEndpointId":{ - "shape":"VpcEndpointId", - "documentation":"

A unique identifier for the primary endpoint associated with a firewall.

" - }, - "MinimumFlowAgeInSeconds":{ - "shape":"Age", - "documentation":"

The reqested FlowOperation ignores flows with an age (in seconds) lower than MinimumFlowAgeInSeconds. You provide this for start commands.

" - }, - "FlowFilters":{ - "shape":"FlowFilters", - "documentation":"

Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.

" - } - } - }, - "StartFlowFlushResponse":{ - "type":"structure", - "members":{ - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

" - }, - "FlowOperationId":{ - "shape":"FlowOperationId", - "documentation":"

A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.

" - }, - "FlowOperationStatus":{ - "shape":"FlowOperationStatus", - "documentation":"

Returns the status of the flow operation. This string is returned in the responses to start, list, and describe commands.

If the status is COMPLETED_WITH_ERRORS, results may be returned with any number of Flows missing from the response. If the status is FAILED, Flows returned will be empty.

" - } - } - }, - "StartTime":{"type":"timestamp"}, - "StatefulAction":{ - "type":"string", - "enum":[ - "PASS", - "DROP", - "ALERT", - "REJECT" - ] - }, - "StatefulActions":{ - "type":"list", - "member":{"shape":"CollectionMember_String"} - }, - "StatefulEngineOptions":{ - "type":"structure", - "members":{ - "RuleOrder":{ - "shape":"RuleOrder", - "documentation":"

Indicates how to manage the order of stateful rule evaluation for the policy. STRICT_ORDER is the recommended option, but DEFAULT_ACTION_ORDER is the default option. With STRICT_ORDER, provide your rules in the order that you want them to be evaluated. You can then choose one or more default actions for packets that don't match any rules. Choose STRICT_ORDER to have the stateful rules engine determine the evaluation order of your rules. The default action for this rule order is PASS, followed by DROP, REJECT, and ALERT actions. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them based on your settings. For more information, see Evaluation order for stateful rules in the Network Firewall Developer Guide.

" - }, - "StreamExceptionPolicy":{ - "shape":"StreamExceptionPolicy", - "documentation":"

Configures how Network Firewall processes traffic when a network connection breaks midstream. Network connections can break due to disruptions in external networks or within the firewall itself.

  • DROP - Network Firewall fails closed and drops all subsequent traffic going to the firewall. This is the default behavior.

  • CONTINUE - Network Firewall continues to apply rules to the subsequent traffic without context from traffic before the break. This impacts the behavior of rules that depend on this context. For example, if you have a stateful rule to drop http traffic, Network Firewall won't match the traffic for this rule because the service won't have the context from session initialization defining the application layer protocol as HTTP. However, this behavior is rule dependent—a TCP-layer rule using a flow:stateless rule would still match, as would the aws:drop_strict default action.

  • REJECT - Network Firewall fails closed and drops all subsequent traffic going to the firewall. Network Firewall also sends a TCP reject packet back to your client so that the client can immediately establish a new session. Network Firewall will have context about the new session and will apply rules to the subsequent traffic.

" - }, - "FlowTimeouts":{ - "shape":"FlowTimeouts", - "documentation":"

Configures the amount of time that can pass without any traffic sent through the firewall before the firewall determines that the connection is idle.

" - } - }, - "documentation":"

Configuration settings for the handling of the stateful rule groups in a firewall policy.

" - }, - "StatefulRule":{ - "type":"structure", - "required":[ - "Action", - "Header", - "RuleOptions" - ], - "members":{ - "Action":{ - "shape":"StatefulAction", - "documentation":"

Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria. For all actions, Network Firewall performs the specified action and discontinues stateful inspection of the traffic flow.

The actions for a stateful rule are defined as follows:

  • PASS - Permits the packets to go to the intended destination.

  • DROP - Blocks the packets from going to the intended destination and sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.

  • ALERT - Sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.

    You can use this action to test a rule that you intend to use to drop traffic. You can enable the rule with ALERT action, verify in the logs that the rule is filtering as you want, then change the action to DROP.

  • REJECT - Drops traffic that matches the conditions of the stateful rule, and sends a TCP reset packet back to sender of the packet. A TCP reset packet is a packet with no payload and an RST bit contained in the TCP header flags. REJECT is available only for TCP traffic. This option doesn't support FTP or IMAP protocols.

" - }, - "Header":{ - "shape":"Header", - "documentation":"

The stateful inspection criteria for this rule, used to inspect traffic flows.

" - }, - "RuleOptions":{ - "shape":"RuleOptions", - "documentation":"

Additional options for the rule. These are the Suricata RuleOptions settings.

" - } - }, - "documentation":"

A single Suricata rules specification, for use in a stateful rule group. Use this option to specify a simple Suricata rule with protocol, source and destination, ports, direction, and rule options. For information about the Suricata Rules format, see Rules Format.

" - }, - "StatefulRuleDirection":{ - "type":"string", - "enum":[ - "FORWARD", - "ANY" - ] - }, - "StatefulRuleGroupOverride":{ - "type":"structure", - "members":{ - "Action":{ - "shape":"OverrideAction", - "documentation":"

The action that changes the rule group from DROP to ALERT. This only applies to managed rule groups.

" - } - }, - "documentation":"

The setting that allows the policy owner to change the behavior of the rule group within a policy.

" - }, - "StatefulRuleGroupReference":{ - "type":"structure", - "required":["ResourceArn"], - "members":{ - "ResourceArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the stateful rule group.

" - }, - "Priority":{ - "shape":"Priority", - "documentation":"

An integer setting that indicates the order in which to run the stateful rule groups in a single FirewallPolicy. This setting only applies to firewall policies that specify the STRICT_ORDER rule order in the stateful engine options settings.

Network Firewall evalutes each stateful rule group against a packet starting with the group that has the lowest priority setting. You must ensure that the priority settings are unique within each policy.

You can change the priority settings of your rule groups at any time. To make it easier to insert rule groups later, number them so there's a wide range in between, for example use 100, 200, and so on.

", - "box":true - }, - "Override":{ - "shape":"StatefulRuleGroupOverride", - "documentation":"

The action that allows the policy owner to override the behavior of the rule group within a policy.

" - }, - "DeepThreatInspection":{ - "shape":"DeepThreatInspection", - "documentation":"

Network Firewall plans to augment the active threat defense managed rule group with an additional deep threat inspection capability. When this capability is released, Amazon Web Services will analyze service logs of network traffic processed by these rule groups to identify threat indicators across customers. Amazon Web Services will use these threat indicators to improve the active threat defense managed rule groups and protect the security of Amazon Web Services customers and services.

Customers can opt-out of deep threat inspection at any time through the Network Firewall console or API. When customers opt out, Network Firewall will not use the network traffic processed by those customers' active threat defense rule groups for rule group improvement.

" - } - }, - "documentation":"

Identifier for a single stateful rule group, used in a firewall policy to refer to a rule group.

" - }, - "StatefulRuleGroupReferences":{ - "type":"list", - "member":{"shape":"StatefulRuleGroupReference"} - }, - "StatefulRuleOptions":{ - "type":"structure", - "members":{ - "RuleOrder":{ - "shape":"RuleOrder", - "documentation":"

Indicates how to manage the order of the rule evaluation for the rule group. DEFAULT_ACTION_ORDER is the default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them based on certain settings. For more information, see Evaluation order for stateful rules in the Network Firewall Developer Guide.

" - } - }, - "documentation":"

Additional options governing how Network Firewall handles the rule group. You can only use these for stateful rule groups.

" - }, - "StatefulRuleProtocol":{ - "type":"string", - "enum":[ - "IP", - "TCP", - "UDP", - "ICMP", - "HTTP", - "FTP", - "TLS", - "SMB", - "DNS", - "DCERPC", - "SSH", - "SMTP", - "IMAP", - "MSN", - "KRB5", - "IKEV2", - "TFTP", - "NTP", - "DHCP", - "HTTP2", - "QUIC" - ] - }, - "StatefulRules":{ - "type":"list", - "member":{"shape":"StatefulRule"} - }, - "StatelessActions":{ - "type":"list", - "member":{"shape":"CollectionMember_String"} - }, - "StatelessRule":{ - "type":"structure", - "required":[ - "RuleDefinition", - "Priority" - ], - "members":{ - "RuleDefinition":{ - "shape":"RuleDefinition", - "documentation":"

Defines the stateless 5-tuple packet inspection criteria and the action to take on a packet that matches the criteria.

" - }, - "Priority":{ - "shape":"Priority", - "documentation":"

Indicates the order in which to run this rule relative to all of the rules that are defined for a stateless rule group. Network Firewall evaluates the rules in a rule group starting with the lowest priority setting. You must ensure that the priority settings are unique for the rule group.

Each stateless rule group uses exactly one StatelessRulesAndCustomActions object, and each StatelessRulesAndCustomActions contains exactly one StatelessRules object. To ensure unique priority settings for your rule groups, set unique priorities for the stateless rules that you define inside any single StatelessRules object.

You can change the priority settings of your rules at any time. To make it easier to insert rules later, number them so there's a wide range in between, for example use 100, 200, and so on.

" - } - }, - "documentation":"

A single stateless rule. This is used in StatelessRulesAndCustomActions.

" - }, - "StatelessRuleGroupReference":{ - "type":"structure", - "required":[ - "ResourceArn", - "Priority" - ], - "members":{ - "ResourceArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the stateless rule group.

" - }, - "Priority":{ - "shape":"Priority", - "documentation":"

An integer setting that indicates the order in which to run the stateless rule groups in a single FirewallPolicy. Network Firewall applies each stateless rule group to a packet starting with the group that has the lowest priority setting. You must ensure that the priority settings are unique within each policy.

" - } - }, - "documentation":"

Identifier for a single stateless rule group, used in a firewall policy to refer to the rule group.

" - }, - "StatelessRuleGroupReferences":{ - "type":"list", - "member":{"shape":"StatelessRuleGroupReference"} - }, - "StatelessRules":{ - "type":"list", - "member":{"shape":"StatelessRule"} - }, - "StatelessRulesAndCustomActions":{ - "type":"structure", - "required":["StatelessRules"], - "members":{ - "StatelessRules":{ - "shape":"StatelessRules", - "documentation":"

Defines the set of stateless rules for use in a stateless rule group.

" - }, - "CustomActions":{ - "shape":"CustomActions", - "documentation":"

Defines an array of individual custom action definitions that are available for use by the stateless rules in this StatelessRulesAndCustomActions specification. You name each custom action that you define, and then you can use it by name in your StatelessRule RuleDefinition Actions specification.

" - } - }, - "documentation":"

Stateless inspection criteria. Each stateless rule group uses exactly one of these data types to define its stateless rules.

" - }, - "Status":{"type":"string"}, - "StatusMessage":{"type":"string"}, - "StatusReason":{ - "type":"string", - "max":256, - "min":1, - "pattern":"^[a-zA-Z0-9- ]+$" - }, - "StreamExceptionPolicy":{ - "type":"string", - "enum":[ - "DROP", - "CONTINUE", - "REJECT" - ] - }, - "SubnetMapping":{ - "type":"structure", - "required":["SubnetId"], - "members":{ - "SubnetId":{ - "shape":"CollectionMember_String", - "documentation":"

The unique identifier for the subnet.

" - }, - "IPAddressType":{ - "shape":"IPAddressType", - "documentation":"

The subnet's IP address type. You can't change the IP address type after you create the subnet.

" - } - }, - "documentation":"

The ID for a subnet that's used in an association with a firewall. This is used in CreateFirewall, AssociateSubnets, and CreateVpcEndpointAssociation. Network Firewall creates an instance of the associated firewall in each subnet that you specify, to filter traffic in the subnet's Availability Zone.

" - }, - "SubnetMappings":{ - "type":"list", - "member":{"shape":"SubnetMapping"} - }, - "SubscriptionStatus":{ - "type":"string", - "enum":[ - "NOT_SUBSCRIBED", - "SUBSCRIBED" - ] - }, - "Summary":{ - "type":"structure", - "members":{ - "RuleSummaries":{ - "shape":"RuleSummaries", - "documentation":"

An array of RuleSummary objects containing individual rule details that had been configured by the rulegroup's SummaryConfiguration.

" - } - }, - "documentation":"

A complex type containing summaries of security protections provided by a rule group.

Network Firewall extracts this information from selected fields in the rule group's Suricata rules, based on your SummaryConfiguration settings.

" - }, - "SummaryConfiguration":{ - "type":"structure", - "members":{ - "RuleOptions":{ - "shape":"SummaryRuleOptions", - "documentation":"

Specifies the selected rule options returned by DescribeRuleGroupSummary.

" - } - }, - "documentation":"

A complex type that specifies which Suricata rule metadata fields to use when displaying threat information. Contains:

  • RuleOptions - The Suricata rule options fields to extract and display

These settings affect how threat information appears in both the console and API responses. Summaries are available for rule groups you manage and for active threat defense Amazon Web Services managed rule groups.

" - }, - "SummaryRuleOption":{ - "type":"string", - "enum":[ - "SID", - "MSG", - "METADATA" - ] - }, - "SummaryRuleOptions":{ - "type":"list", - "member":{"shape":"SummaryRuleOption"} - }, - "SupportedAvailabilityZones":{ - "type":"map", - "key":{"shape":"AvailabilityZone"}, - "value":{"shape":"AvailabilityZoneMetadata"} - }, - "SyncState":{ - "type":"structure", - "members":{ - "Attachment":{ - "shape":"Attachment", - "documentation":"

The configuration and status for a single firewall subnet. For each configured subnet, Network Firewall creates the attachment by instantiating the firewall endpoint in the subnet so that it's ready to take traffic.

" - }, - "Config":{ - "shape":"SyncStateConfig", - "documentation":"

The configuration status of the firewall endpoint in a single VPC subnet. Network Firewall provides each endpoint with the rules that are configured in the firewall policy. Each time you add a subnet or modify the associated firewall policy, Network Firewall synchronizes the rules in the endpoint, so it can properly filter network traffic.

" - } - }, - "documentation":"

The status of the firewall endpoint and firewall policy configuration for a single VPC subnet. This is part of the FirewallStatus.

For each VPC subnet that you associate with a firewall, Network Firewall does the following:

  • Instantiates a firewall endpoint in the subnet, ready to take traffic.

  • Configures the endpoint with the current firewall policy settings, to provide the filtering behavior for the endpoint.

When you update a firewall, for example to add a subnet association or change a rule group in the firewall policy, the affected sync states reflect out-of-sync or not ready status until the changes are complete.

" - }, - "SyncStateConfig":{ - "type":"map", - "key":{"shape":"ResourceName"}, - "value":{"shape":"PerObjectStatus"} - }, - "SyncStates":{ - "type":"map", - "key":{"shape":"AvailabilityZone"}, - "value":{"shape":"SyncState"} - }, - "TCPFlag":{ - "type":"string", - "enum":[ - "FIN", - "SYN", - "RST", - "PSH", - "ACK", - "URG", - "ECE", - "CWR" - ] - }, - "TCPFlagField":{ - "type":"structure", - "required":["Flags"], - "members":{ - "Flags":{ - "shape":"Flags", - "documentation":"

Used in conjunction with the Masks setting to define the flags that must be set and flags that must not be set in order for the packet to match. This setting can only specify values that are also specified in the Masks setting.

For the flags that are specified in the masks setting, the following must be true for the packet to match:

  • The ones that are set in this flags setting must be set in the packet.

  • The ones that are not set in this flags setting must also not be set in the packet.

" - }, - "Masks":{ - "shape":"Flags", - "documentation":"

The set of flags to consider in the inspection. To inspect all flags in the valid values list, leave this with no setting.

" - } - }, - "documentation":"

TCP flags and masks to inspect packets for, used in stateless rules MatchAttributes settings.

" - }, - "TCPFlags":{ - "type":"list", - "member":{"shape":"TCPFlagField"} - }, - "TLSInspectionConfiguration":{ - "type":"structure", - "members":{ - "ServerCertificateConfigurations":{ - "shape":"ServerCertificateConfigurations", - "documentation":"

Lists the server certificate configurations that are associated with the TLS configuration.

" - } - }, - "documentation":"

The object that defines a TLS inspection configuration. This, along with TLSInspectionConfigurationResponse, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.

Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.

To use a TLS inspection configuration, you add it to a new Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect the traffic traveling through your firewalls. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.

" - }, - "TLSInspectionConfigurationMetadata":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.

" - }, - "Arn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the TLS inspection configuration.

" - } - }, - "documentation":"

High-level information about a TLS inspection configuration, returned by ListTLSInspectionConfigurations. You can use the information provided in the metadata to retrieve and manage a TLS configuration.

" - }, - "TLSInspectionConfigurationResponse":{ - "type":"structure", - "required":[ - "TLSInspectionConfigurationArn", - "TLSInspectionConfigurationName", - "TLSInspectionConfigurationId" - ], - "members":{ - "TLSInspectionConfigurationArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the TLS inspection configuration.

" - }, - "TLSInspectionConfigurationName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.

" - }, - "TLSInspectionConfigurationId":{ - "shape":"ResourceId", - "documentation":"

A unique identifier for the TLS inspection configuration. This ID is returned in the responses to create and list commands. You provide it to operations such as update and delete.

" - }, - "TLSInspectionConfigurationStatus":{ - "shape":"ResourceStatus", - "documentation":"

Detailed information about the current status of a TLSInspectionConfiguration. You can retrieve this for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration and providing the TLS inspection configuration name and ARN.

" - }, - "Description":{ - "shape":"Description", - "documentation":"

A description of the TLS inspection configuration.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The key:value pairs to associate with the resource.

" - }, - "LastModifiedTime":{ - "shape":"LastUpdateTime", - "documentation":"

The last time that the TLS inspection configuration was changed.

" - }, - "NumberOfAssociations":{ - "shape":"NumberOfAssociations", - "documentation":"

The number of firewall policies that use this TLS inspection configuration.

" - }, - "EncryptionConfiguration":{ - "shape":"EncryptionConfiguration", - "documentation":"

A complex type that contains the Amazon Web Services KMS encryption configuration settings for your TLS inspection configuration.

" - }, - "Certificates":{ - "shape":"Certificates", - "documentation":"

A list of the certificates associated with the TLS inspection configuration.

" - }, - "CertificateAuthority":{"shape":"TlsCertificateData"} - }, - "documentation":"

The high-level properties of a TLS inspection configuration. This, along with the TLSInspectionConfiguration, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.

" - }, - "TLSInspectionConfigurations":{ - "type":"list", - "member":{"shape":"TLSInspectionConfigurationMetadata"} - }, - "Tag":{ - "type":"structure", - "required":[ - "Key", - "Value" - ], - "members":{ - "Key":{ - "shape":"TagKey", - "documentation":"

The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as \"customer.\" Tag keys are case-sensitive.

" - }, - "Value":{ - "shape":"TagValue", - "documentation":"

The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as \"companyA\" or \"companyB.\" Tag values are case-sensitive.

" - } - }, - "documentation":"

A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as \"environment\") and the tag value represents a specific value within that category (such as \"test,\" \"development,\" or \"production\"). You can add up to 50 tags to each Amazon Web Services resource.

" - }, - "TagKey":{ - "type":"string", - "max":128, - "min":1, - "pattern":"^.*$" - }, - "TagKeyList":{ - "type":"list", - "member":{"shape":"TagKey"}, - "max":200, - "min":1 - }, - "TagList":{ - "type":"list", - "member":{"shape":"Tag"}, - "max":200, - "min":1 - }, - "TagResourceRequest":{ - "type":"structure", - "required":[ - "ResourceArn", - "Tags" - ], - "members":{ - "ResourceArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the resource.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

" - } - } - }, - "TagResourceResponse":{ - "type":"structure", - "members":{} - }, - "TagValue":{ - "type":"string", - "max":256, - "min":0, - "pattern":"^.*$" - }, - "TagsPaginationMaxResults":{ - "type":"integer", - "max":100, - "min":0 - }, - "TargetType":{ - "type":"string", - "enum":[ - "TLS_SNI", - "HTTP_HOST" - ] - }, - "TargetTypes":{ - "type":"list", - "member":{"shape":"TargetType"} - }, - "TcpIdleTimeoutRangeBound":{"type":"integer"}, - "ThrottlingException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"} - }, - "documentation":"

Unable to process the request due to throttling limitations.

", - "exception":true - }, - "TlsCertificateData":{ - "type":"structure", - "members":{ - "CertificateArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the certificate.

" - }, - "CertificateSerial":{ - "shape":"CollectionMember_String", - "documentation":"

The serial number of the certificate.

" - }, - "Status":{ - "shape":"CollectionMember_String", - "documentation":"

The status of the certificate.

" - }, - "StatusMessage":{ - "shape":"StatusReason", - "documentation":"

Contains details about the certificate status, including information about certificate errors.

" - } - }, - "documentation":"

Contains metadata about an Certificate Manager certificate.

" - }, - "TlsInterceptMode":{ - "type":"string", - "enum":[ - "ENABLED", - "DISABLED" - ] - }, - "TlsInterceptProperties":{ - "type":"structure", - "members":{ - "PcaArn":{ - "shape":"ResourceArn", - "documentation":"

Private Certificate Authority (PCA) used to issue private TLS certificates so that the proxy can present PCA-signed certificates which applications trust through the same root, establishing a secure and consistent trust model for encrypted communication.

" - }, - "TlsInterceptMode":{ - "shape":"TlsInterceptMode", - "documentation":"

Specifies whether to enable or disable TLS Intercept Mode.

" - } - }, - "documentation":"

TLS decryption on traffic to filter on attributes in the HTTP header.

" - }, - "TlsInterceptPropertiesRequest":{ - "type":"structure", - "members":{ - "PcaArn":{ - "shape":"ResourceArn", - "documentation":"

Private Certificate Authority (PCA) used to issue private TLS certificates so that the proxy can present PCA-signed certificates which applications trust through the same root, establishing a secure and consistent trust model for encrypted communication.

" - }, - "TlsInterceptMode":{ - "shape":"TlsInterceptMode", - "documentation":"

Specifies whether to enable or disable TLS Intercept Mode.

" - } - }, - "documentation":"

This data type is used specifically for the CreateProxy and UpdateProxy APIs.

TLS decryption on traffic to filter on attributes in the HTTP header.

" - }, - "TransitGatewayAttachmentId":{ - "type":"string", - "max":128, - "min":1, - "pattern":"^tgw-attach-[0-9a-z]+$" - }, - "TransitGatewayAttachmentStatus":{ - "type":"string", - "enum":[ - "CREATING", - "DELETING", - "DELETED", - "FAILED", - "ERROR", - "READY", - "PENDING_ACCEPTANCE", - "REJECTING", - "REJECTED" - ] - }, - "TransitGatewayAttachmentSyncState":{ - "type":"structure", - "members":{ - "AttachmentId":{ - "shape":"AttachmentId", - "documentation":"

The unique identifier of the transit gateway attachment.

" - }, - "TransitGatewayAttachmentStatus":{ - "shape":"TransitGatewayAttachmentStatus", - "documentation":"

The current status of the transit gateway attachment.

Valid values are:

  • CREATING - The attachment is being created

  • DELETING - The attachment is being deleted

  • DELETED - The attachment has been deleted

  • FAILED - The attachment creation has failed and cannot be recovered

  • ERROR - The attachment is in an error state that might be recoverable

  • READY - The attachment is active and processing traffic

  • PENDING_ACCEPTANCE - The attachment is waiting to be accepted

  • REJECTING - The attachment is in the process of being rejected

  • REJECTED - The attachment has been rejected

" - }, - "StatusMessage":{ - "shape":"TransitGatewayAttachmentSyncStateMessage", - "documentation":"

A message providing additional information about the current status, particularly useful when the transit gateway attachment is in a non-READY state.

Valid values are:

  • CREATING - The attachment is being created

  • DELETING - The attachment is being deleted

  • DELETED - The attachment has been deleted

  • FAILED - The attachment creation has failed and cannot be recovered

  • ERROR - The attachment is in an error state that might be recoverable

  • READY - The attachment is active and processing traffic

  • PENDING_ACCEPTANCE - The attachment is waiting to be accepted

  • REJECTING - The attachment is in the process of being rejected

  • REJECTED - The attachment has been rejected

For information about troubleshooting endpoint failures, see Troubleshooting firewall endpoint failures in the Network Firewall Developer Guide.

" - } - }, - "documentation":"

Contains information about the synchronization state of a transit gateway attachment, including its current status and any error messages. Network Firewall uses this to track the state of your transit gateway configuration changes.

" - }, - "TransitGatewayAttachmentSyncStateMessage":{"type":"string"}, - "TransitGatewayId":{ - "type":"string", - "max":128, - "min":1, - "pattern":"^tgw-[0-9a-z]+$" - }, - "UniqueSources":{ - "type":"structure", - "members":{ - "Count":{ - "shape":"Count", - "documentation":"

The number of unique source IP addresses that connected to a domain.

" - } - }, - "documentation":"

A unique source IP address that connected to a domain.

" - }, - "UnsupportedOperationException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"} - }, - "documentation":"

The operation you requested isn't supported by Network Firewall.

", - "exception":true - }, - "UntagResourceRequest":{ - "type":"structure", - "required":[ - "ResourceArn", - "TagKeys" - ], - "members":{ - "ResourceArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the resource.

" - }, - "TagKeys":{ - "shape":"TagKeyList", - "documentation":"

" - } - } - }, - "UntagResourceResponse":{ - "type":"structure", - "members":{} - }, - "UpdateAvailabilityZoneChangeProtectionRequest":{ - "type":"structure", - "required":["AvailabilityZoneChangeProtection"], - "members":{ - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

" - }, - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

" - }, - "FirewallName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "AvailabilityZoneChangeProtection":{ - "shape":"Boolean", - "documentation":"

A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

" - } - } - }, - "UpdateAvailabilityZoneChangeProtectionResponse":{ - "type":"structure", - "members":{ - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

" - }, - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

" - }, - "FirewallName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

" - }, - "AvailabilityZoneChangeProtection":{ - "shape":"Boolean", - "documentation":"

A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

" - } - } - }, - "UpdateContainerAssociationRequest":{ - "type":"structure", - "required":[ - "Type", - "ContainerMonitoringConfigurations", - "UpdateToken" - ], - "members":{ - "ContainerAssociationName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the container association. You must specify the ARN or the name, and you can specify both.

" - }, - "ContainerAssociationArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the container association. You must specify the ARN or the name, and you can specify both.

" - }, - "Description":{ - "shape":"Description", - "documentation":"

A description of the container association.

" - }, - "Type":{ - "shape":"ContainerMonitoringType", - "documentation":"

The type of container orchestration platform. This must match the type specified when the container association was created.

" - }, - "ContainerMonitoringConfigurations":{ - "shape":"ContainerMonitoringConfigurations", - "documentation":"

The updated list of container monitoring configurations that define which clusters and container attributes to monitor.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The key:value pairs associated with the resource.

" - }, - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

A token used for optimistic locking. Network Firewall returns a token to your requests that access the container association. The token marks the state of the container association resource at the time of the request. To make an update to the container association, provide the token in your request. Network Firewall uses the token to ensure that the container association hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the container association again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

" - } - } - }, - "UpdateContainerAssociationResponse":{ - "type":"structure", - "members":{ - "ContainerAssociationName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the container association.

" - }, - "ContainerAssociationArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the container association.

" - }, - "Description":{ - "shape":"Description", - "documentation":"

A description of the container association.

" - }, - "Type":{ - "shape":"ContainerMonitoringType", - "documentation":"

The type of container orchestration platform. Either ECS or EKS.

" - }, - "ContainerMonitoringConfigurations":{ - "shape":"ContainerMonitoringConfigurations", - "documentation":"

The container monitoring configurations for this container association.

" - }, - "Status":{ - "shape":"ContainerAssociationStatus", - "documentation":"

The current status of the container association.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The key:value pairs associated with the resource.

" - }, - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

A token used for optimistic locking. Network Firewall returns a token to your requests that access the container association. The token marks the state of the container association resource at the time of the request.

" - } - } - }, - "UpdateFirewallAnalysisSettingsRequest":{ - "type":"structure", - "members":{ - "EnabledAnalysisTypes":{ - "shape":"EnabledAnalysisTypes", - "documentation":"

An optional setting indicating the specific traffic analysis types to enable on the firewall.

" - }, - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

" - }, - "FirewallName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

" - } - } - }, - "UpdateFirewallAnalysisSettingsResponse":{ - "type":"structure", - "members":{ - "EnabledAnalysisTypes":{ - "shape":"EnabledAnalysisTypes", - "documentation":"

An optional setting indicating the specific traffic analysis types to enable on the firewall.

" - }, - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

" - }, - "FirewallName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

" - } - } - }, - "UpdateFirewallDeleteProtectionRequest":{ - "type":"structure", - "required":["DeleteProtection"], - "members":{ - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

" - }, - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

" - }, - "FirewallName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "DeleteProtection":{ - "shape":"Boolean", - "documentation":"

A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE.

" - } - } - }, - "UpdateFirewallDeleteProtectionResponse":{ - "type":"structure", - "members":{ - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

" - }, - "FirewallName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

" - }, - "DeleteProtection":{ - "shape":"Boolean", - "documentation":"

A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE.

" - }, - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

" - } - } - }, - "UpdateFirewallDescriptionRequest":{ - "type":"structure", - "members":{ - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

" - }, - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

" - }, - "FirewallName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "Description":{ - "shape":"Description", - "documentation":"

The new description for the firewall. If you omit this setting, Network Firewall removes the description for the firewall.

" - } - } - }, - "UpdateFirewallDescriptionResponse":{ - "type":"structure", - "members":{ - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

" - }, - "FirewallName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

" - }, - "Description":{ - "shape":"Description", - "documentation":"

A description of the firewall.

" - }, - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

" - } - } - }, - "UpdateFirewallEncryptionConfigurationRequest":{ - "type":"structure", - "members":{ - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

" - }, - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

" - }, - "FirewallName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

" - }, - "EncryptionConfiguration":{"shape":"EncryptionConfiguration"} - } - }, - "UpdateFirewallEncryptionConfigurationResponse":{ - "type":"structure", - "members":{ - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

" - }, - "FirewallName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

" - }, - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

" - }, - "EncryptionConfiguration":{"shape":"EncryptionConfiguration"} - } - }, - "UpdateFirewallPolicyChangeProtectionRequest":{ - "type":"structure", - "required":["FirewallPolicyChangeProtection"], - "members":{ - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

" - }, - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

" - }, - "FirewallName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "FirewallPolicyChangeProtection":{ - "shape":"Boolean", - "documentation":"

A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

" - } - } - }, - "UpdateFirewallPolicyChangeProtectionResponse":{ - "type":"structure", - "members":{ - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

" - }, - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

" - }, - "FirewallName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

" - }, - "FirewallPolicyChangeProtection":{ - "shape":"Boolean", - "documentation":"

A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

" - } - } - }, - "UpdateFirewallPolicyRequest":{ - "type":"structure", - "required":[ - "UpdateToken", - "FirewallPolicy" - ], - "members":{ - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request.

To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token.

" - }, - "FirewallPolicyArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall policy.

You must specify the ARN or the name, and you can specify both.

" - }, - "FirewallPolicyName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "FirewallPolicy":{ - "shape":"FirewallPolicy", - "documentation":"

The updated firewall policy to use for the firewall. You can't add or remove a TLSInspectionConfiguration after you create a firewall policy. However, you can replace an existing TLS inspection configuration with another TLSInspectionConfiguration.

" - }, - "Description":{ - "shape":"Description", - "documentation":"

A description of the firewall policy.

" - }, - "DryRun":{ - "shape":"Boolean", - "documentation":"

Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.

If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.

If set to FALSE, Network Firewall makes the requested changes to your resources.

" - }, - "EncryptionConfiguration":{ - "shape":"EncryptionConfiguration", - "documentation":"

A complex type that contains settings for encryption of your firewall policy resources.

" - } - } - }, - "UpdateFirewallPolicyResponse":{ - "type":"structure", - "required":[ - "UpdateToken", - "FirewallPolicyResponse" - ], - "members":{ - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request.

To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token.

" - }, - "FirewallPolicyResponse":{ - "shape":"FirewallPolicyResponse", - "documentation":"

The high-level properties of a firewall policy. This, along with the FirewallPolicy, define the policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.

" - } - } - }, - "UpdateLoggingConfigurationRequest":{ - "type":"structure", - "members":{ - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

" - }, - "FirewallName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "LoggingConfiguration":{ - "shape":"LoggingConfiguration", - "documentation":"

Defines how Network Firewall performs logging for a firewall. If you omit this setting, Network Firewall disables logging for the firewall.

" - }, - "EnableMonitoringDashboard":{ - "shape":"EnableMonitoringDashboard", - "documentation":"

A boolean that lets you enable or disable the detailed firewall monitoring dashboard on the firewall.

The monitoring dashboard provides comprehensive visibility into your firewall's flow logs and alert logs. After you enable detailed monitoring, you can access these dashboards directly from the Monitoring page of the Network Firewall console.

Specify TRUE to enable the the detailed monitoring dashboard on the firewall. Specify FALSE to disable the the detailed monitoring dashboard on the firewall.

" - } - } - }, - "UpdateLoggingConfigurationResponse":{ - "type":"structure", - "members":{ - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

" - }, - "FirewallName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

" - }, - "LoggingConfiguration":{"shape":"LoggingConfiguration"}, - "EnableMonitoringDashboard":{ - "shape":"EnableMonitoringDashboard", - "documentation":"

A boolean that reflects whether or not the firewall monitoring dashboard is enabled on a firewall.

Returns TRUE when the firewall monitoring dashboard is enabled on the firewall. Returns FALSE when the firewall monitoring dashboard is not enabled on the firewall.

" - } - } - }, - "UpdateProxyConfigurationRequest":{ - "type":"structure", - "required":[ - "DefaultRulePhaseActions", - "UpdateToken" - ], - "members":{ - "ProxyConfigurationName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "ProxyConfigurationArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of a proxy configuration.

You must specify the ARN or the name, and you can specify both.

" - }, - "DefaultRulePhaseActions":{ - "shape":"ProxyConfigDefaultRulePhaseActionsRequest", - "documentation":"

Evaluation points in the traffic flow where rules are applied. There are three phases in a traffic where the rule match is applied.

" - }, - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy configuration. The token marks the state of the proxy configuration resource at the time of the request.

To make changes to the proxy configuration, you provide the token in your request. Network Firewall uses the token to ensure that the proxy configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

" - } - } - }, - "UpdateProxyConfigurationResponse":{ - "type":"structure", - "members":{ - "ProxyConfiguration":{ - "shape":"ProxyConfiguration", - "documentation":"

The updated proxy configuration resource that reflects the updates from the request.

" - }, - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy configuration. The token marks the state of the proxy configuration resource at the time of the request.

To make changes to the proxy configuration, you provide the token in your request. Network Firewall uses the token to ensure that the proxy configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

" - } - } - }, - "UpdateProxyRequest":{ - "type":"structure", - "required":[ - "NatGatewayId", - "UpdateToken" - ], - "members":{ - "NatGatewayId":{ - "shape":"NatGatewayId", - "documentation":"

The NAT Gateway the proxy is attached to.

" - }, - "ProxyName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy. You can't change the name of a proxy after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "ProxyArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of a proxy.

You must specify the ARN or the name, and you can specify both.

" - }, - "ListenerPropertiesToAdd":{ - "shape":"ListenerPropertiesRequest", - "documentation":"

Listener properties for HTTP and HTTPS traffic to add.

" - }, - "ListenerPropertiesToRemove":{ - "shape":"ListenerPropertiesRequest", - "documentation":"

Listener properties for HTTP and HTTPS traffic to remove.

" - }, - "TlsInterceptProperties":{ - "shape":"TlsInterceptPropertiesRequest", - "documentation":"

TLS decryption on traffic to filter on attributes in the HTTP header.

" - }, - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy. The token marks the state of the proxy resource at the time of the request.

To make changes to the proxy, you provide the token in your request. Network Firewall uses the token to ensure that the proxy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

" - } - } - }, - "UpdateProxyResponse":{ - "type":"structure", - "members":{ - "Proxy":{ - "shape":"Proxy", - "documentation":"

The updated proxy resource that reflects the updates from the request.

" - }, - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy. The token marks the state of the proxy resource at the time of the request.

To make changes to the proxy, you provide the token in your request. Network Firewall uses the token to ensure that the proxy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

" - } - } - }, - "UpdateProxyRuleGroupPrioritiesRequest":{ - "type":"structure", - "required":[ - "RuleGroups", - "UpdateToken" - ], - "members":{ - "ProxyConfigurationName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "ProxyConfigurationArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of a proxy configuration.

You must specify the ARN or the name, and you can specify both.

" - }, - "RuleGroups":{ - "shape":"ProxyRuleGroupPriorityList", - "documentation":"

proxy rule group resources to update to new positions.

" - }, - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy configuration. The token marks the state of the proxy configuration resource at the time of the request.

To make changes to the proxy configuration, you provide the token in your request. Network Firewall uses the token to ensure that the proxy configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

" - } - } - }, - "UpdateProxyRuleGroupPrioritiesResponse":{ - "type":"structure", - "members":{ - "ProxyRuleGroups":{ - "shape":"ProxyRuleGroupPriorityResultList", - "documentation":"

The updated proxy rule group hierarchy that reflects the updates from the request.

" - }, - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy configuration. The token marks the state of the proxy configuration resource at the time of the request.

To make changes to the proxy configuration, you provide the token in your request. Network Firewall uses the token to ensure that the proxy configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

" - } - } - }, - "UpdateProxyRulePrioritiesRequest":{ - "type":"structure", - "required":[ - "RuleGroupRequestPhase", - "Rules", - "UpdateToken" - ], - "members":{ - "ProxyRuleGroupName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "ProxyRuleGroupArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of a proxy rule group.

You must specify the ARN or the name, and you can specify both.

" - }, - "RuleGroupRequestPhase":{ - "shape":"RuleGroupRequestPhase", - "documentation":"

Evaluation points in the traffic flow where rules are applied. There are three phases in a traffic where the rule match is applied.

" - }, - "Rules":{ - "shape":"ProxyRulePriorityList", - "documentation":"

proxy rule resources to update to new positions.

" - }, - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule group. The token marks the state of the proxy rule group resource at the time of the request.

To make changes to the proxy rule group, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

" - } - } - }, - "UpdateProxyRulePrioritiesResponse":{ - "type":"structure", - "members":{ - "ProxyRuleGroupName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.

" - }, - "ProxyRuleGroupArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of a proxy rule group.

" - }, - "RuleGroupRequestPhase":{ - "shape":"RuleGroupRequestPhase", - "documentation":"

Evaluation points in the traffic flow where rules are applied. There are three phases in a traffic where the rule match is applied.

" - }, - "Rules":{ - "shape":"ProxyRulePriorityList", - "documentation":"

The updated proxy rule hierarchy that reflects the updates from the request.

" - }, - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule group. The token marks the state of the proxy rule group resource at the time of the request.

To make changes to the proxy rule group, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

" - } - } - }, - "UpdateProxyRuleRequest":{ - "type":"structure", - "required":[ - "ProxyRuleName", - "UpdateToken" - ], - "members":{ - "ProxyRuleGroupName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "ProxyRuleGroupArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of a proxy rule group.

You must specify the ARN or the name, and you can specify both.

" - }, - "ProxyRuleName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the proxy rule. You can't change the name of a proxy rule after you create it.

" - }, - "Description":{ - "shape":"Description", - "documentation":"

A description of the proxy rule.

" - }, - "Action":{ - "shape":"ProxyRulePhaseAction", - "documentation":"

Depending on the match action, the proxy either stops the evaluation (if the action is terminal - allow or deny), or continues it (if the action is alert) until it matches a rule with a terminal action.

" - }, - "AddConditions":{ - "shape":"ProxyRuleConditionList", - "documentation":"

Proxy rule conditions to add. Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.

" - }, - "RemoveConditions":{ - "shape":"ProxyRuleConditionList", - "documentation":"

Proxy rule conditions to remove. Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.

" - }, - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule. The token marks the state of the proxy rule resource at the time of the request.

To make changes to the proxy rule, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy rule again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

" - } - } - }, - "UpdateProxyRuleResponse":{ - "type":"structure", - "members":{ - "ProxyRule":{ - "shape":"ProxyRule", - "documentation":"

The updated proxy rule resource that reflects the updates from the request.

" - }, - "RemovedConditions":{ - "shape":"ProxyRuleConditionList", - "documentation":"

Proxy rule conditions removed from the rule.

" - }, - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule. The token marks the state of the proxy rule resource at the time of the request.

To make changes to the proxy rule, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy rule again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

" - } - } - }, - "UpdateRuleGroupRequest":{ - "type":"structure", - "required":["UpdateToken"], - "members":{ - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.

To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

" - }, - "RuleGroupArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the rule group.

You must specify the ARN or the name, and you can specify both.

" - }, - "RuleGroupName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "RuleGroup":{ - "shape":"RuleGroup", - "documentation":"

An object that defines the rule group rules.

You must provide either this rule group setting or a Rules setting, but not both.

" - }, - "Rules":{ - "shape":"RulesString", - "documentation":"

A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups.

You must provide either this rules setting or a populated RuleGroup setting, but not both.

You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call response returns a RuleGroup object that Network Firewall has populated from your string.

" - }, - "Type":{ - "shape":"RuleGroupType", - "documentation":"

Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

This setting is required for requests that do not include the RuleGroupARN.

" - }, - "Description":{ - "shape":"Description", - "documentation":"

A description of the rule group.

" - }, - "DryRun":{ - "shape":"Boolean", - "documentation":"

Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.

If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.

If set to FALSE, Network Firewall makes the requested changes to your resources.

" - }, - "EncryptionConfiguration":{ - "shape":"EncryptionConfiguration", - "documentation":"

A complex type that contains settings for encryption of your rule group resources.

" - }, - "SourceMetadata":{ - "shape":"SourceMetadata", - "documentation":"

A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to keep track of updates made to the originating rule group.

" - }, - "AnalyzeRuleGroup":{ - "shape":"Boolean", - "documentation":"

Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior such as asymmetric routing. If set to TRUE, Network Firewall runs the analysis and then updates the rule group for you. To run the stateless rule group analyzer without updating the rule group, set DryRun to TRUE.

" - }, - "SummaryConfiguration":{ - "shape":"SummaryConfiguration", - "documentation":"

Updates the selected summary configuration for a rule group.

Changes affect subsequent responses from DescribeRuleGroupSummary.

" - } - } - }, - "UpdateRuleGroupResponse":{ - "type":"structure", - "required":[ - "UpdateToken", - "RuleGroupResponse" - ], - "members":{ - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.

To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

" - }, - "RuleGroupResponse":{ - "shape":"RuleGroupResponse", - "documentation":"

The high-level properties of a rule group. This, along with the RuleGroup, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

" - } - } - }, - "UpdateSubnetChangeProtectionRequest":{ - "type":"structure", - "required":["SubnetChangeProtection"], - "members":{ - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

" - }, - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

" - }, - "FirewallName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

" - }, - "SubnetChangeProtection":{ - "shape":"Boolean", - "documentation":"

A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

" - } - } - }, - "UpdateSubnetChangeProtectionResponse":{ - "type":"structure", - "members":{ - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

" - }, - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

" - }, - "FirewallName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

" - }, - "SubnetChangeProtection":{ - "shape":"Boolean", - "documentation":"

A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

" - } - } - }, - "UpdateTLSInspectionConfigurationRequest":{ - "type":"structure", - "required":[ - "TLSInspectionConfiguration", - "UpdateToken" - ], - "members":{ - "TLSInspectionConfigurationArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the TLS inspection configuration.

" - }, - "TLSInspectionConfigurationName":{ - "shape":"ResourceName", - "documentation":"

The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.

" - }, - "TLSInspectionConfiguration":{ - "shape":"TLSInspectionConfiguration", - "documentation":"

The object that defines a TLS inspection configuration. This, along with TLSInspectionConfigurationResponse, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.

Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.

To use a TLS inspection configuration, you add it to a new Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect the traffic traveling through your firewalls. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.

" - }, - "Description":{ - "shape":"Description", - "documentation":"

A description of the TLS inspection configuration.

" - }, - "EncryptionConfiguration":{ - "shape":"EncryptionConfiguration", - "documentation":"

A complex type that contains the Amazon Web Services KMS encryption configuration settings for your TLS inspection configuration.

" - }, - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

A token used for optimistic locking. Network Firewall returns a token to your requests that access the TLS inspection configuration. The token marks the state of the TLS inspection configuration resource at the time of the request.

To make changes to the TLS inspection configuration, you provide the token in your request. Network Firewall uses the token to ensure that the TLS inspection configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the TLS inspection configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

" - } - } - }, - "UpdateTLSInspectionConfigurationResponse":{ - "type":"structure", - "required":[ - "UpdateToken", - "TLSInspectionConfigurationResponse" - ], - "members":{ - "UpdateToken":{ - "shape":"UpdateToken", - "documentation":"

A token used for optimistic locking. Network Firewall returns a token to your requests that access the TLS inspection configuration. The token marks the state of the TLS inspection configuration resource at the time of the request.

To make changes to the TLS inspection configuration, you provide the token in your request. Network Firewall uses the token to ensure that the TLS inspection configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the TLS inspection configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

" - }, - "TLSInspectionConfigurationResponse":{ - "shape":"TLSInspectionConfigurationResponse", - "documentation":"

The high-level properties of a TLS inspection configuration. This, along with the TLSInspectionConfiguration, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.

" - } - } - }, - "UpdateTime":{"type":"timestamp"}, - "UpdateToken":{ - "type":"string", - "max":1024, - "min":1, - "pattern":"^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$" - }, - "VariableDefinition":{ - "type":"string", - "min":1, - "pattern":"^.*$" - }, - "VariableDefinitionList":{ - "type":"list", - "member":{"shape":"VariableDefinition"} - }, - "VendorName":{"type":"string"}, - "VpcEndpointAssociation":{ - "type":"structure", - "required":[ - "VpcEndpointAssociationArn", - "FirewallArn", - "VpcId", - "SubnetMapping" - ], - "members":{ - "VpcEndpointAssociationId":{ - "shape":"ResourceId", - "documentation":"

The unique identifier of the VPC endpoint association.

" - }, - "VpcEndpointAssociationArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of a VPC endpoint association.

" - }, - "FirewallArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the firewall.

" - }, - "VpcId":{ - "shape":"VpcId", - "documentation":"

The unique identifier of the VPC for the endpoint association.

" - }, - "SubnetMapping":{"shape":"SubnetMapping"}, - "Description":{ - "shape":"Description", - "documentation":"

A description of the VPC endpoint association.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The key:value pairs to associate with the resource.

" - } - }, - "documentation":"

A VPC endpoint association defines a single subnet to use for a firewall endpoint for a Firewall. You can define VPC endpoint associations only in the Availability Zones that already have a subnet mapping defined in the Firewall resource.

You can retrieve the list of Availability Zones that are available for use by calling DescribeFirewallMetadata.

To manage firewall endpoints, first, in the Firewall specification, you specify a single VPC and one subnet for each of the Availability Zones where you want to use the firewall. Then you can define additional endpoints as VPC endpoint associations.

You can use VPC endpoint associations to expand the protections of the firewall as follows:

  • Protect multiple VPCs with a single firewall - You can use the firewall to protect other VPCs, either in your account or in accounts where the firewall is shared. You can only specify Availability Zones that already have a firewall endpoint defined in the Firewall subnet mappings.

  • Define multiple firewall endpoints for a VPC in an Availability Zone - You can create additional firewall endpoints for the VPC that you have defined in the firewall, in any Availability Zone that already has an endpoint defined in the Firewall subnet mappings. You can create multiple VPC endpoint associations for any other VPC where you use the firewall.

You can use Resource Access Manager to share a Firewall that you own with other accounts, which gives them the ability to use the firewall to create VPC endpoint associations. For information about sharing a firewall, see PutResourcePolicy in this guide and see Sharing Network Firewall resources in the Network Firewall Developer Guide.

The status of the VPC endpoint association, which indicates whether it's ready to filter network traffic, is provided in the corresponding VpcEndpointAssociationStatus. You can retrieve both the association and its status by calling DescribeVpcEndpointAssociation.

" - }, - "VpcEndpointAssociationMetadata":{ - "type":"structure", - "members":{ - "VpcEndpointAssociationArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of a VPC endpoint association.

" - } - }, - "documentation":"

High-level information about a VPC endpoint association, returned by ListVpcEndpointAssociations. You can use the information provided in the metadata to retrieve and manage a VPC endpoint association.

" - }, - "VpcEndpointAssociationStatus":{ - "type":"structure", - "required":["Status"], - "members":{ - "Status":{ - "shape":"FirewallStatusValue", - "documentation":"

The readiness of the configured firewall endpoint to handle network traffic.

" - }, - "AssociationSyncState":{ - "shape":"AssociationSyncState", - "documentation":"

The list of the Availability Zone sync states for all subnets that are defined by the firewall.

" - } - }, - "documentation":"

Detailed information about the current status of a VpcEndpointAssociation. You can retrieve this by calling DescribeVpcEndpointAssociation and providing the VPC endpoint association ARN.

" - }, - "VpcEndpointAssociations":{ - "type":"list", - "member":{"shape":"VpcEndpointAssociationMetadata"} - }, - "VpcEndpointId":{ - "type":"string", - "max":256, - "min":5, - "pattern":"^vpce-[a-zA-Z0-9]*$" - }, - "VpcEndpointServiceName":{"type":"string"}, - "VpcId":{ - "type":"string", - "max":128, - "min":1, - "pattern":"^vpc-[0-9a-f]+$" - }, - "VpcIds":{ - "type":"list", - "member":{"shape":"VpcId"} - } - }, - "documentation":"

This is the API Reference for Network Firewall. This guide is for developers who need detailed information about the Network Firewall API actions, data types, and errors.

The REST API requires you to handle connection details, such as calculating signatures, handling request retries, and error handling. For general information about using the Amazon Web Services REST APIs, see Amazon Web Services APIs.

To view the complete list of Amazon Web Services Regions where Network Firewall is available, see Service endpoints and quotas in the Amazon Web Services General Reference.

To access Network Firewall using the IPv4 REST API endpoint: https://network-firewall.<region>.amazonaws.com

To access Network Firewall using the Dualstack (IPv4 and IPv6) REST API endpoint: https://network-firewall.<region>.aws.api

Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see Amazon Web Services SDKs.

For descriptions of Network Firewall features, including and step-by-step instructions on how to use them through the Network Firewall console, see the Network Firewall Developer Guide.

Network Firewall is a stateful, managed, network firewall and intrusion detection and prevention service for Amazon Virtual Private Cloud (Amazon VPC). With Network Firewall, you can filter traffic at the perimeter of your VPC. This includes filtering traffic going to and coming from an internet gateway, NAT gateway, or over VPN or Direct Connect. Network Firewall uses rules that are compatible with Suricata, a free, open source network analysis and threat detection engine. Network Firewall supports Suricata version 7.0.3. For information about Suricata, see the Suricata website and the Suricata User Guide.

You can use Network Firewall to monitor and protect your VPC traffic in a number of ways. The following are just a few examples:

  • Allow domains or IP addresses for known Amazon Web Services service endpoints, such as Amazon S3, and block all other forms of traffic.

  • Use custom lists of known bad domains to limit the types of domain names that your applications can access.

  • Perform deep packet inspection on traffic entering or leaving your VPC.

  • Use stateful protocol detection to filter protocols like HTTPS, regardless of the port used.

To enable Network Firewall for your VPCs, you perform steps in both Amazon VPC and in Network Firewall. For information about using Amazon VPC, see Amazon VPC User Guide.

To start using Network Firewall, do the following:

  1. (Optional) If you don't already have a VPC that you want to protect, create it in Amazon VPC.

  2. In Amazon VPC, in each Availability Zone where you want to have a firewall endpoint, create a subnet for the sole use of Network Firewall.

  3. In Network Firewall, define the firewall behavior as follows:

    1. Create stateless and stateful rule groups, to define the components of the network traffic filtering behavior that you want your firewall to have.

    2. Create a firewall policy that uses your rule groups and specifies additional default traffic filtering behavior.

  4. In Network Firewall, create a firewall and specify your new firewall policy and VPC subnets. Network Firewall creates a firewall endpoint in each subnet that you specify, with the behavior that's defined in the firewall policy.

  5. In Amazon VPC, use ingress routing enhancements to route traffic through the new firewall endpoints.

After your firewall is established, you can add firewall endpoints for new Availability Zones by following the prior steps for the Amazon VPC setup and firewall subnet definitions. You can also add endpoints to Availability Zones that you're using in the firewall, either for the same VPC or for another VPC, by following the prior steps for the Amazon VPC setup, and defining the new VPC subnets as VPC endpoint associations.

" -} diff --git a/tools/code-generation/api-descriptions/pricing-plan-manager/2025-08-05/service-2.json b/tools/code-generation/api-descriptions/pricing-plan-manager-2025-08-05.normal.json similarity index 100% rename from tools/code-generation/api-descriptions/pricing-plan-manager/2025-08-05/service-2.json rename to tools/code-generation/api-descriptions/pricing-plan-manager-2025-08-05.normal.json diff --git a/tools/code-generation/api-descriptions/pricing-plan-manager/2025-08-05/api-2.json b/tools/code-generation/api-descriptions/pricing-plan-manager/2025-08-05/api-2.json deleted file mode 100644 index 4847a7aeacf5..000000000000 --- a/tools/code-generation/api-descriptions/pricing-plan-manager/2025-08-05/api-2.json +++ /dev/null @@ -1,670 +0,0 @@ -{ - "version":"2.0", - "metadata":{ - "apiVersion":"2025-08-05", - "auth":["aws.auth#sigv4"], - "endpointPrefix":"pricingplanmanager", - "protocol":"rest-json", - "protocols":["rest-json"], - "serviceFullName":"PricingPlanManager", - "serviceId":"Pricing Plan Manager", - "signatureVersion":"v4", - "signingName":"pricingplanmanager", - "uid":"pricing-plan-manager-2025-08-05" - }, - "operations":{ - "ApprovePaidSubscription":{ - "name":"ApprovePaidSubscription", - "http":{ - "method":"POST", - "requestUri":"/v1/ApprovePaidSubscription", - "responseCode":200 - }, - "input":{"shape":"ApprovePaidSubscriptionInput"}, - "output":{"shape":"ApprovePaidSubscriptionOutput"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ] - }, - "AssociateResourcesToSubscription":{ - "name":"AssociateResourcesToSubscription", - "http":{ - "method":"POST", - "requestUri":"/v1/AssociateResourcesToSubscription", - "responseCode":200 - }, - "input":{"shape":"AssociateResourcesToSubscriptionInput"}, - "output":{"shape":"AssociateResourcesToSubscriptionOutput"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ] - }, - "CancelSubscription":{ - "name":"CancelSubscription", - "http":{ - "method":"POST", - "requestUri":"/v1/CancelSubscription", - "responseCode":200 - }, - "input":{"shape":"CancelSubscriptionInput"}, - "output":{"shape":"CancelSubscriptionOutput"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ] - }, - "CancelSubscriptionChange":{ - "name":"CancelSubscriptionChange", - "http":{ - "method":"POST", - "requestUri":"/v1/CancelSubscriptionChange", - "responseCode":200 - }, - "input":{"shape":"CancelSubscriptionChangeInput"}, - "output":{"shape":"CancelSubscriptionChangeOutput"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ] - }, - "CreateSubscription":{ - "name":"CreateSubscription", - "http":{ - "method":"POST", - "requestUri":"/v1/CreateSubscription", - "responseCode":200 - }, - "input":{"shape":"CreateSubscriptionInput"}, - "output":{"shape":"CreateSubscriptionOutput"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ] - }, - "DisassociateResourcesFromSubscription":{ - "name":"DisassociateResourcesFromSubscription", - "http":{ - "method":"POST", - "requestUri":"/v1/DisassociateResourcesFromSubscription", - "responseCode":200 - }, - "input":{"shape":"DisassociateResourcesFromSubscriptionInput"}, - "output":{"shape":"DisassociateResourcesFromSubscriptionOutput"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ] - }, - "GetSubscription":{ - "name":"GetSubscription", - "http":{ - "method":"POST", - "requestUri":"/v1/GetSubscription", - "responseCode":200 - }, - "input":{"shape":"GetSubscriptionInput"}, - "output":{"shape":"GetSubscriptionOutput"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ], - "readonly":true - }, - "ListSubscriptions":{ - "name":"ListSubscriptions", - "http":{ - "method":"POST", - "requestUri":"/v1/ListSubscriptions", - "responseCode":200 - }, - "input":{"shape":"ListSubscriptionsInput"}, - "output":{"shape":"ListSubscriptionsOutput"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ], - "readonly":true - }, - "UpdateSubscription":{ - "name":"UpdateSubscription", - "http":{ - "method":"POST", - "requestUri":"/v1/UpdateSubscription", - "responseCode":200 - }, - "input":{"shape":"UpdateSubscriptionInput"}, - "output":{"shape":"UpdateSubscriptionOutput"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ] - } - }, - "shapes":{ - "AccessDeniedException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"} - }, - "error":{ - "httpStatusCode":403, - "senderFault":true - }, - "exception":true - }, - "ApprovalMode":{ - "type":"string", - "enum":[ - "MANUAL", - "IMMEDIATE" - ] - }, - "ApprovePaidSubscriptionInput":{ - "type":"structure", - "required":[ - "arn", - "ifMatch" - ], - "members":{ - "arn":{"shape":"SubscriptionArn"}, - "ifMatch":{ - "shape":"String", - "location":"header", - "locationName":"If-Match" - }, - "clientToken":{ - "shape":"IdempotencyToken", - "idempotencyToken":true - } - } - }, - "ApprovePaidSubscriptionOutput":{ - "type":"structure", - "required":[ - "subscription", - "eTag" - ], - "members":{ - "subscription":{"shape":"Subscription"}, - "eTag":{ - "shape":"String", - "location":"header", - "locationName":"ETag" - } - }, - "payload":"subscription" - }, - "AssociateResourcesToSubscriptionInput":{ - "type":"structure", - "required":[ - "arn", - "resourceArns", - "ifMatch" - ], - "members":{ - "arn":{"shape":"SubscriptionArn"}, - "resourceArns":{"shape":"ResourceArns"}, - "ifMatch":{ - "shape":"String", - "location":"header", - "locationName":"If-Match" - }, - "clientToken":{ - "shape":"IdempotencyToken", - "idempotencyToken":true - } - } - }, - "AssociateResourcesToSubscriptionOutput":{ - "type":"structure", - "required":[ - "subscription", - "eTag" - ], - "members":{ - "subscription":{"shape":"Subscription"}, - "eTag":{ - "shape":"String", - "location":"header", - "locationName":"ETag" - } - }, - "payload":"subscription" - }, - "CancelSubscriptionChangeInput":{ - "type":"structure", - "required":[ - "arn", - "ifMatch" - ], - "members":{ - "arn":{"shape":"SubscriptionArn"}, - "ifMatch":{ - "shape":"String", - "location":"header", - "locationName":"If-Match" - }, - "clientToken":{ - "shape":"IdempotencyToken", - "idempotencyToken":true - } - } - }, - "CancelSubscriptionChangeOutput":{ - "type":"structure", - "required":[ - "subscription", - "eTag" - ], - "members":{ - "subscription":{"shape":"Subscription"}, - "eTag":{ - "shape":"String", - "location":"header", - "locationName":"ETag" - } - }, - "payload":"subscription" - }, - "CancelSubscriptionInput":{ - "type":"structure", - "required":[ - "arn", - "ifMatch" - ], - "members":{ - "arn":{"shape":"SubscriptionArn"}, - "ifMatch":{ - "shape":"String", - "location":"header", - "locationName":"If-Match" - }, - "clientToken":{ - "shape":"IdempotencyToken", - "idempotencyToken":true - } - } - }, - "CancelSubscriptionOutput":{ - "type":"structure", - "required":[ - "subscription", - "eTag" - ], - "members":{ - "subscription":{"shape":"Subscription"}, - "eTag":{ - "shape":"String", - "location":"header", - "locationName":"ETag" - } - }, - "payload":"subscription" - }, - "ConflictException":{ - "type":"structure", - "required":[ - "message", - "resourceId" - ], - "members":{ - "message":{"shape":"String"}, - "resourceId":{"shape":"String"} - }, - "error":{ - "httpStatusCode":409, - "senderFault":true - }, - "exception":true - }, - "CreateSubscriptionInput":{ - "type":"structure", - "required":[ - "planFamily", - "planTier", - "resourceArns" - ], - "members":{ - "planFamily":{"shape":"String"}, - "planTier":{"shape":"String"}, - "usageLevel":{"shape":"String"}, - "resourceArns":{"shape":"ResourceArns"}, - "approvalMode":{"shape":"ApprovalMode"}, - "clientToken":{ - "shape":"IdempotencyToken", - "idempotencyToken":true - } - } - }, - "CreateSubscriptionOutput":{ - "type":"structure", - "required":[ - "subscription", - "eTag" - ], - "members":{ - "subscription":{"shape":"Subscription"}, - "eTag":{ - "shape":"String", - "location":"header", - "locationName":"ETag" - } - }, - "payload":"subscription" - }, - "DisassociateResourcesFromSubscriptionInput":{ - "type":"structure", - "required":[ - "arn", - "resourceArns", - "ifMatch" - ], - "members":{ - "arn":{"shape":"SubscriptionArn"}, - "resourceArns":{"shape":"ResourceArns"}, - "ifMatch":{ - "shape":"String", - "location":"header", - "locationName":"If-Match" - }, - "clientToken":{ - "shape":"IdempotencyToken", - "idempotencyToken":true - } - } - }, - "DisassociateResourcesFromSubscriptionOutput":{ - "type":"structure", - "required":[ - "subscription", - "eTag" - ], - "members":{ - "subscription":{"shape":"Subscription"}, - "eTag":{ - "shape":"String", - "location":"header", - "locationName":"ETag" - } - }, - "payload":"subscription" - }, - "GetSubscriptionInput":{ - "type":"structure", - "required":["arn"], - "members":{ - "arn":{"shape":"SubscriptionArn"} - } - }, - "GetSubscriptionOutput":{ - "type":"structure", - "required":[ - "subscription", - "eTag" - ], - "members":{ - "subscription":{"shape":"Subscription"}, - "eTag":{ - "shape":"String", - "location":"header", - "locationName":"ETag" - } - }, - "payload":"subscription" - }, - "IdempotencyToken":{ - "type":"string", - "max":64, - "min":1 - }, - "InternalServerException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"} - }, - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true - }, - "ListSubscriptionsInput":{ - "type":"structure", - "members":{ - "nextToken":{"shape":"String"} - } - }, - "ListSubscriptionsOutput":{ - "type":"structure", - "required":["subscriptionSummaries"], - "members":{ - "subscriptionSummaries":{"shape":"SubscriptionSummaryList"}, - "nextToken":{"shape":"String"} - } - }, - "ResourceArns":{ - "type":"list", - "member":{"shape":"String"}, - "max":10, - "min":1 - }, - "ResourceNotFoundException":{ - "type":"structure", - "required":[ - "message", - "resourceId" - ], - "members":{ - "message":{"shape":"String"}, - "resourceId":{"shape":"String"} - }, - "error":{ - "httpStatusCode":404, - "senderFault":true - }, - "exception":true - }, - "ScheduledChange":{ - "type":"structure", - "required":["changeType"], - "members":{ - "changeType":{"shape":"ScheduledChangeType"}, - "effectiveDate":{"shape":"SyntheticTimestamp_date_time"}, - "planTier":{"shape":"String"}, - "usageLevel":{"shape":"String"} - } - }, - "ScheduledChangeType":{ - "type":"string", - "enum":[ - "DOWNGRADE", - "CANCELLATION" - ] - }, - "ServiceQuotaExceededException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"} - }, - "error":{ - "httpStatusCode":402, - "senderFault":true - }, - "exception":true - }, - "Status":{ - "type":"string", - "enum":[ - "PENDING_APPROVAL", - "ACTIVE", - "SYNC_IN_PROGRESS", - "FAILED" - ] - }, - "String":{"type":"string"}, - "Subscription":{ - "type":"structure", - "required":[ - "arn", - "planFamily", - "planTier", - "status", - "resourceArns", - "createdAt", - "updatedAt" - ], - "members":{ - "arn":{"shape":"SubscriptionArn"}, - "planFamily":{"shape":"String"}, - "planTier":{"shape":"String"}, - "usageLevel":{"shape":"String"}, - "scheduledChange":{"shape":"ScheduledChange"}, - "status":{"shape":"Status"}, - "statusReason":{"shape":"String"}, - "resourceArns":{"shape":"ResourceArns"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"} - } - }, - "SubscriptionArn":{ - "type":"string", - "max":2048, - "min":1 - }, - "SubscriptionSummary":{ - "type":"structure", - "required":[ - "arn", - "planFamily", - "planTier", - "status", - "resourceArns", - "createdAt", - "updatedAt", - "eTag" - ], - "members":{ - "arn":{"shape":"SubscriptionArn"}, - "planFamily":{"shape":"String"}, - "planTier":{"shape":"String"}, - "usageLevel":{"shape":"String"}, - "scheduledChange":{"shape":"ScheduledChange"}, - "status":{"shape":"Status"}, - "statusReason":{"shape":"String"}, - "resourceArns":{"shape":"ResourceArns"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"}, - "eTag":{"shape":"String"} - } - }, - "SubscriptionSummaryList":{ - "type":"list", - "member":{"shape":"SubscriptionSummary"} - }, - "SyntheticTimestamp_date_time":{ - "type":"timestamp", - "timestampFormat":"iso8601" - }, - "ThrottlingException":{ - "type":"structure", - "members":{ - "message":{"shape":"String"} - }, - "error":{ - "httpStatusCode":429, - "senderFault":true - }, - "exception":true - }, - "UpdateSubscriptionInput":{ - "type":"structure", - "required":[ - "arn", - "planTier", - "ifMatch" - ], - "members":{ - "arn":{"shape":"SubscriptionArn"}, - "planTier":{"shape":"String"}, - "usageLevel":{"shape":"String"}, - "ifMatch":{ - "shape":"String", - "location":"header", - "locationName":"If-Match" - }, - "clientToken":{ - "shape":"IdempotencyToken", - "idempotencyToken":true - } - } - }, - "UpdateSubscriptionOutput":{ - "type":"structure", - "required":[ - "subscription", - "eTag" - ], - "members":{ - "subscription":{"shape":"Subscription"}, - "eTag":{ - "shape":"String", - "location":"header", - "locationName":"ETag" - } - }, - "payload":"subscription" - }, - "ValidationException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"}, - "resourceId":{"shape":"String"} - }, - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - } - } -} diff --git a/tools/code-generation/api-descriptions/pricing-plan-manager/2025-08-05/docs-2.json b/tools/code-generation/api-descriptions/pricing-plan-manager/2025-08-05/docs-2.json deleted file mode 100644 index 4cc846bc9509..000000000000 --- a/tools/code-generation/api-descriptions/pricing-plan-manager/2025-08-05/docs-2.json +++ /dev/null @@ -1,262 +0,0 @@ -{ - "version": "2.0", - "service": "

Manages flat-rate pricing subscriptions for supported AWS services. Use this API to create, approve, update, and cancel subscriptions; associate and disassociate resources; and retrieve subscription details. With a flat-rate pricing subscription, you pay a fixed recurring fee for eligible resources instead of usage-based pricing.

", - "operations": { - "ApprovePaidSubscription": "

Approves a subscription that is in PENDING_APPROVAL status, activating it and starting billing.

This operation requires the current ETag value for concurrency control. Retrieve it from a previous GetSubscription or ListSubscriptions response.

", - "AssociateResourcesToSubscription": "

Adds one or more resources to an existing subscription. The subscription must be in an active state that is not pending other changes.

For subscriptions in the CloudFront plan family, the associated resources must include exactly one Amazon CloudFront distribution and one AWS WAF web ACL. You can also include other supported resources, such as Amazon Route 53 hosted zones, and CloudFront KeyValueStores.

", - "CancelSubscription": "

Cancels a flat-rate pricing subscription.

For active subscriptions, the cancellation is scheduled to take effect at the end of the current billing period. The subscription remains active until that date. To revert a pending cancellation, use CancelSubscriptionChange.

For subscriptions in PENDING_APPROVAL status, the subscription is deleted immediately without scheduling.

", - "CancelSubscriptionChange": "

Cancels a pending scheduled change on a subscription, such as a pending downgrade or cancellation. The subscription returns to its state before the change was scheduled.

You cannot cancel a scheduled change close to its effective date. If the change is within the processing window, this operation returns an error.

", - "CreateSubscription": "

Creates a flat-rate pricing subscription for the specified resources.

When approvalMode is set to MANUAL, paid-tier subscriptions are created in PENDING_APPROVAL status and require a separate ApprovePaidSubscription call before billing starts. Free-tier subscriptions are always activated immediately regardless of approval mode.

When approvalMode is set to IMMEDIATE or is not specified, the subscription is activated immediately.

", - "DisassociateResourcesFromSubscription": "

Removes one or more resources from an existing subscription.

For subscriptions in the CloudFront plan family, the associated resources must always include exactly one Amazon CloudFront distribution and exactly one AWS WAF web ACL. You cannot remove these required resources.

", - "GetSubscription": "

Returns the details of a flat-rate pricing subscription, including its current status, associated resources, and any pending scheduled changes.

", - "ListSubscriptions": "

Returns a summary of all flat-rate pricing subscriptions in the calling account.

", - "UpdateSubscription": "

Changes the plan tier of an existing subscription.

Upgrades take effect immediately. Downgrades are scheduled and the current tier remains unchanged until the end of the billing cycle (calendar month). You cannot update a subscription while a scheduled change is pending. To make a new change, first cancel the pending change using CancelSubscriptionChange.

This operation replaces the plan tier value. If you omit the optional usageLevel field, it is reset to the default.

" - }, - "shapes": { - "AccessDeniedException": { - "base": "

You do not have the required permissions to perform this operation. Verify that your IAM policy grants access to this action.

", - "refs": {} - }, - "ApprovalMode": { - "base": "

Determines whether a subscription requires explicit approval before billing starts.

", - "refs": { - "CreateSubscriptionInput$approvalMode": "

Determines whether the subscription requires explicit approval before billing starts. Set to MANUAL to require a separate ApprovePaidSubscription call, or IMMEDIATE to activate the subscription right away. Defaults to IMMEDIATE if not specified.

" - } - }, - "ApprovePaidSubscriptionInput": { - "base": null, - "refs": {} - }, - "ApprovePaidSubscriptionOutput": { - "base": null, - "refs": {} - }, - "AssociateResourcesToSubscriptionInput": { - "base": null, - "refs": {} - }, - "AssociateResourcesToSubscriptionOutput": { - "base": null, - "refs": {} - }, - "CancelSubscriptionChangeInput": { - "base": null, - "refs": {} - }, - "CancelSubscriptionChangeOutput": { - "base": null, - "refs": {} - }, - "CancelSubscriptionInput": { - "base": null, - "refs": {} - }, - "CancelSubscriptionOutput": { - "base": null, - "refs": {} - }, - "ConflictException": { - "base": "

The request conflicts with the current state of the resource. This typically occurs when the ETag value in the If-Match header does not match the current version of the subscription. Retrieve the latest version and retry.

", - "refs": {} - }, - "CreateSubscriptionInput": { - "base": null, - "refs": {} - }, - "CreateSubscriptionOutput": { - "base": null, - "refs": {} - }, - "DisassociateResourcesFromSubscriptionInput": { - "base": null, - "refs": {} - }, - "DisassociateResourcesFromSubscriptionOutput": { - "base": null, - "refs": {} - }, - "GetSubscriptionInput": { - "base": null, - "refs": {} - }, - "GetSubscriptionOutput": { - "base": null, - "refs": {} - }, - "IdempotencyToken": { - "base": "

A unique, case-sensitive identifier that you provide to ensure a request is handled only once.

", - "refs": { - "ApprovePaidSubscriptionInput$clientToken": "

A unique, case-sensitive identifier that you provide to ensure the request is handled only once.

", - "AssociateResourcesToSubscriptionInput$clientToken": "

A unique, case-sensitive identifier that you provide to ensure the request is handled only once.

", - "CancelSubscriptionChangeInput$clientToken": "

A unique, case-sensitive identifier that you provide to ensure the request is handled only once.

", - "CancelSubscriptionInput$clientToken": "

A unique, case-sensitive identifier that you provide to ensure the request is handled only once.

", - "CreateSubscriptionInput$clientToken": "

A unique, case-sensitive identifier that you provide to ensure that the request is handled only once. If you send the same request with the same client token, the API returns the original response without creating a duplicate subscription.

", - "DisassociateResourcesFromSubscriptionInput$clientToken": "

A unique, case-sensitive identifier that you provide to ensure the request is handled only once.

", - "UpdateSubscriptionInput$clientToken": "

A unique, case-sensitive identifier that you provide to ensure the request is handled only once.

" - } - }, - "InternalServerException": { - "base": "

An unexpected error occurred on the server. Retry the request.

", - "refs": {} - }, - "ListSubscriptionsInput": { - "base": null, - "refs": {} - }, - "ListSubscriptionsOutput": { - "base": null, - "refs": {} - }, - "ResourceArns": { - "base": "

A list of 1 to 10 AWS resource ARNs to include in the subscription.

", - "refs": { - "AssociateResourcesToSubscriptionInput$resourceArns": "

The ARNs of the resources to add to the subscription.

", - "CreateSubscriptionInput$resourceArns": "

The ARNs of the AWS resources to include in the subscription. Specify one or more supported resources.

For subscriptions in the CloudFront plan family, the resources must include exactly one Amazon CloudFront distribution and exactly one AWS WAF web ACL. You can also include other supported resources, such as Amazon Route 53 hosted zones and CloudFront KeyValueStores.

", - "DisassociateResourcesFromSubscriptionInput$resourceArns": "

The ARNs of the resources to remove from the subscription. For subscriptions in the CloudFront plan family, you cannot remove the required CloudFront distribution or WAF web ACL.

", - "Subscription$resourceArns": "

The ARNs of the AWS resources covered by this subscription.

", - "SubscriptionSummary$resourceArns": "

The ARNs of the AWS resources covered by this subscription.

" - } - }, - "ResourceNotFoundException": { - "base": "

The specified subscription was not found. Verify that the ARN is correct and that the subscription belongs to your account.

", - "refs": {} - }, - "ScheduledChange": { - "base": "

A pending change on a subscription that takes effect at the end of the current billing period, such as a tier downgrade or cancellation.

", - "refs": { - "Subscription$scheduledChange": "

A pending change that will take effect at the end of the current billing period. This field is present only when a downgrade or cancellation is scheduled.

", - "SubscriptionSummary$scheduledChange": "

A pending change that will take effect at the end of the current billing period, if any.

" - } - }, - "ScheduledChangeType": { - "base": "

The type of pending change on a subscription.

Possible values:

  • DOWNGRADE — The subscription tier is being lowered at the end of the billing period.

  • CANCELLATION — The subscription is being terminated at the end of the billing period.

", - "refs": { - "ScheduledChange$changeType": "

The type of pending change. Possible values are DOWNGRADE (a tier change to a lower level) and CANCELLATION (subscription termination).

" - } - }, - "ServiceQuotaExceededException": { - "base": "

The request would exceed a service limit. You have reached the maximum number of subscriptions allowed for your account.

", - "refs": {} - }, - "Status": { - "base": "

The status of a flat-rate pricing subscription.

Possible values:

  • PENDING_APPROVAL — The subscription was created with manual approval and is waiting for an ApprovePaidSubscription call.

  • ACTIVE — The subscription is active and resources are covered by flat-rate pricing.

  • SYNC_IN_PROGRESS — A change is being applied to the subscription. Wait for the operation to complete before making additional changes.

  • FAILED — The subscription encountered an error. Check the statusReason field for details.

", - "refs": { - "Subscription$status": "

The current status of the subscription. For the list of possible values, see the Status type.

", - "SubscriptionSummary$status": "

The current status of the subscription.

" - } - }, - "String": { - "base": null, - "refs": { - "AccessDeniedException$message": null, - "ApprovePaidSubscriptionInput$ifMatch": "

The ETag value from a previous GetSubscription or ListSubscriptions response. This ensures you are approving the expected version of the subscription.

", - "ApprovePaidSubscriptionOutput$eTag": "

The updated entity tag for concurrency control.

", - "AssociateResourcesToSubscriptionInput$ifMatch": "

The ETag value from a previous GetSubscription or ListSubscriptions response.

", - "AssociateResourcesToSubscriptionOutput$eTag": "

The updated entity tag for concurrency control.

", - "CancelSubscriptionChangeInput$ifMatch": "

The ETag value from a previous GetSubscription or ListSubscriptions response.

", - "CancelSubscriptionChangeOutput$eTag": "

The updated entity tag for concurrency control.

", - "CancelSubscriptionInput$ifMatch": "

The ETag value from a previous GetSubscription or ListSubscriptions response.

", - "CancelSubscriptionOutput$eTag": "

The updated entity tag for concurrency control.

", - "ConflictException$message": null, - "ConflictException$resourceId": "

The identifier of the resource that has a conflicting state.

", - "CreateSubscriptionInput$planFamily": "

The pricing plan family to subscribe to, such as CloudFront.

", - "CreateSubscriptionInput$planTier": "

The tier level for the subscription, such as FREE, PRO, BUSINESS, or PREMIUM.

", - "CreateSubscriptionInput$usageLevel": "

The usage level within the plan tier. Specify DEFAULT for the base configuration, or a higher level if your plan tier supports it.

", - "CreateSubscriptionOutput$eTag": "

The entity tag for concurrency control. Use this value in the If-Match header for subsequent operations on this subscription.

", - "DisassociateResourcesFromSubscriptionInput$ifMatch": "

The ETag value from a previous GetSubscription or ListSubscriptions response.

", - "DisassociateResourcesFromSubscriptionOutput$eTag": "

The updated entity tag for concurrency control.

", - "GetSubscriptionOutput$eTag": "

The entity tag for concurrency control. Use this value in the If-Match header for subsequent operations on this subscription.

", - "InternalServerException$message": null, - "ListSubscriptionsInput$nextToken": "

A token from a previous ListSubscriptions response. If the response included a nextToken, there are more results available. Pass this value to retrieve the next page of results.

", - "ListSubscriptionsOutput$nextToken": "

A token that indicates there are more results available. Pass this value in a subsequent ListSubscriptions request to retrieve the next page of results.

", - "ResourceArns$member": null, - "ResourceNotFoundException$message": null, - "ResourceNotFoundException$resourceId": "

The identifier of the resource that was not found.

", - "ScheduledChange$planTier": "

For downgrades, the tier level that the subscription will change to. Not present for cancellations.

", - "ScheduledChange$usageLevel": "

For downgrades, the target usage level after the change takes effect.

", - "ServiceQuotaExceededException$message": null, - "Subscription$planFamily": "

The pricing plan family for the subscription, such as CloudFront.

", - "Subscription$planTier": "

The current tier level of the pricing plan, such as FREE, PRO, BUSINESS, or PREMIUM.

", - "Subscription$usageLevel": "

The usage level within the plan tier. When present, indicates a specific capacity configuration beyond the base tier.

", - "Subscription$statusReason": "

A human-readable explanation of the current status, present when additional context is available.

", - "SubscriptionSummary$planFamily": "

The pricing plan family for the subscription, such as CloudFront.

", - "SubscriptionSummary$planTier": "

The current tier level of the pricing plan.

", - "SubscriptionSummary$usageLevel": "

The usage level within the plan tier.

", - "SubscriptionSummary$statusReason": "

A human-readable explanation of the current status, present when additional context is available.

", - "SubscriptionSummary$eTag": "

The entity tag for concurrency control. Pass this value in the If-Match header when making changes to this subscription.

", - "ThrottlingException$message": null, - "UpdateSubscriptionInput$planTier": "

The new tier level for the subscription.

", - "UpdateSubscriptionInput$usageLevel": "

The usage level within the plan tier. Specify DEFAULT for the base configuration. If omitted, the usage level is reset to the default.

", - "UpdateSubscriptionInput$ifMatch": "

The ETag value from a previous GetSubscription or ListSubscriptions response. This ensures you are updating the expected version of the subscription.

", - "UpdateSubscriptionOutput$eTag": "

The updated entity tag for concurrency control.

", - "ValidationException$message": null, - "ValidationException$resourceId": "

The identifier of the resource that failed validation.

" - } - }, - "Subscription": { - "base": "

The full details of a flat-rate pricing subscription, including its current configuration, status, and associated resources.

", - "refs": { - "ApprovePaidSubscriptionOutput$subscription": "

The details of the approved subscription.

", - "AssociateResourcesToSubscriptionOutput$subscription": "

The details of the subscription with the newly added resources.

", - "CancelSubscriptionChangeOutput$subscription": "

The details of the subscription with the pending change removed.

", - "CancelSubscriptionOutput$subscription": "

The details of the subscription with the pending cancellation. For active subscriptions, a scheduledChange of type CANCELLATION is included.

", - "CreateSubscriptionOutput$subscription": "

The details of the newly created subscription.

", - "DisassociateResourcesFromSubscriptionOutput$subscription": "

The details of the subscription with the specified resources removed.

", - "GetSubscriptionOutput$subscription": "

The details of the requested subscription.

", - "UpdateSubscriptionOutput$subscription": "

The details of the updated subscription. For downgrades, the current tier remains unchanged and a scheduledChange indicates the pending change.

" - } - }, - "SubscriptionArn": { - "base": "

The Amazon Resource Name (ARN) of a flat-rate pricing subscription.

", - "refs": { - "ApprovePaidSubscriptionInput$arn": "

The ARN of the subscription to approve.

", - "AssociateResourcesToSubscriptionInput$arn": "

The ARN of the subscription to add resources to.

", - "CancelSubscriptionChangeInput$arn": "

The ARN of the subscription whose pending change you want to cancel.

", - "CancelSubscriptionInput$arn": "

The ARN of the subscription to cancel.

", - "DisassociateResourcesFromSubscriptionInput$arn": "

The ARN of the subscription to remove resources from.

", - "GetSubscriptionInput$arn": "

The ARN of the subscription to retrieve.

", - "Subscription$arn": "

The Amazon Resource Name (ARN) that uniquely identifies this subscription.

", - "SubscriptionSummary$arn": "

The Amazon Resource Name (ARN) that uniquely identifies this subscription.

", - "UpdateSubscriptionInput$arn": "

The ARN of the subscription to update.

" - } - }, - "SubscriptionSummary": { - "base": "

Summary information for a flat-rate pricing subscription, as returned by list operations.

", - "refs": { - "SubscriptionSummaryList$member": null - } - }, - "SubscriptionSummaryList": { - "base": null, - "refs": { - "ListSubscriptionsOutput$subscriptionSummaries": "

The list of subscription summaries for the calling account.

" - } - }, - "SyntheticTimestamp_date_time": { - "base": null, - "refs": { - "ScheduledChange$effectiveDate": "

The date and time when the change takes effect, in ISO 8601 format. This value is populated after the change is confirmed by the billing system.

", - "Subscription$createdAt": "

The date and time when the subscription was created, in ISO 8601 format.

", - "Subscription$updatedAt": "

The date and time when the subscription was last modified, in ISO 8601 format.

", - "SubscriptionSummary$createdAt": "

The date and time when the subscription was created, in ISO 8601 format.

", - "SubscriptionSummary$updatedAt": "

The date and time when the subscription was last modified, in ISO 8601 format.

" - } - }, - "ThrottlingException": { - "base": "

The request rate exceeds the allowed limit. Wait briefly and retry the request.

", - "refs": {} - }, - "UpdateSubscriptionInput": { - "base": null, - "refs": {} - }, - "UpdateSubscriptionOutput": { - "base": null, - "refs": {} - }, - "ValidationException": { - "base": "

The request failed a business rule validation. For example, the specified resource might already be associated with another subscription, or the subscription might not be in the required state for this operation.

", - "refs": {} - } - } -} diff --git a/tools/code-generation/api-descriptions/pricing-plan-manager/2025-08-05/endpoint-bdd-1.json b/tools/code-generation/api-descriptions/pricing-plan-manager/2025-08-05/endpoint-bdd-1.json deleted file mode 100644 index 2816c1670b3d..000000000000 --- a/tools/code-generation/api-descriptions/pricing-plan-manager/2025-08-05/endpoint-bdd-1.json +++ /dev/null @@ -1,67 +0,0 @@ -{ - "version": "1.1", - "parameters": { - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint URL", - "type": "string" - }, - "Region": { - "builtIn": "AWS::Region", - "required": true, - "documentation": "The AWS region", - "type": "string" - } - }, - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "results": [ - { - "conditions": [], - "endpoint": { - "url": "{Endpoint}", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "pricingplanmanager", - "signingRegion": "us-east-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "documentation": "Route every region to the single us-east-1 endpoint, signing for us-east-1.", - "conditions": [], - "endpoint": { - "url": "https://pricingplanmanager.us-east-1.api.aws", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "pricingplanmanager", - "signingRegion": "us-east-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - } - ], - "root": 2, - "nodeCount": 2, - "nodes": "/////wAAAAH/////AAAAAAX14QEF9eEC" -} \ No newline at end of file diff --git a/tools/code-generation/api-descriptions/pricing-plan-manager/2025-08-05/examples-1.json b/tools/code-generation/api-descriptions/pricing-plan-manager/2025-08-05/examples-1.json deleted file mode 100644 index cba02dcfa453..000000000000 --- a/tools/code-generation/api-descriptions/pricing-plan-manager/2025-08-05/examples-1.json +++ /dev/null @@ -1,273 +0,0 @@ -{ - "version": "1.0", - "examples": { - "ApprovePaidSubscription": [ - { - "input": { - "arn": "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890", - "ifMatch": "1" - }, - "output": { - "eTag": "2", - "subscription": { - "arn": "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890", - "createdAt": "2025-01-15T10:30:00Z", - "planFamily": "CloudFront", - "planTier": "PRO", - "resourceArns": [ - "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE", - "arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4" - ], - "status": "SYNC_IN_PROGRESS", - "updatedAt": "2025-01-15T10:35:00Z" - } - }, - "id": "example-1", - "title": "Approve a pending paid subscription" - } - ], - "AssociateResourcesToSubscription": [ - { - "input": { - "arn": "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890", - "ifMatch": "1", - "resourceArns": [ - "arn:aws:route53:::hostedzone/Z0123456789EXAMPLE" - ] - }, - "output": { - "eTag": "2", - "subscription": { - "arn": "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890", - "createdAt": "2025-01-15T10:30:00Z", - "planFamily": "CloudFront", - "planTier": "PRO", - "resourceArns": [ - "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE", - "arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4", - "arn:aws:route53:::hostedzone/Z0123456789EXAMPLE" - ], - "status": "SYNC_IN_PROGRESS", - "updatedAt": "2025-01-18T11:00:00Z" - } - }, - "id": "example-1", - "title": "Associate additional resources to a subscription" - } - ], - "CancelSubscription": [ - { - "input": { - "arn": "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890", - "ifMatch": "2" - }, - "output": { - "eTag": "3", - "subscription": { - "arn": "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890", - "createdAt": "2025-01-15T10:30:00Z", - "planFamily": "CloudFront", - "planTier": "BUSINESS", - "resourceArns": [ - "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE", - "arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4" - ], - "scheduledChange": { - "changeType": "CANCELLATION", - "effectiveDate": "2025-02-01T00:00:00Z" - }, - "status": "ACTIVE", - "updatedAt": "2025-01-16T12:00:00Z" - } - }, - "id": "example-1", - "title": "Cancel a subscription" - } - ], - "CancelSubscriptionChange": [ - { - "input": { - "arn": "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890", - "ifMatch": "3" - }, - "output": { - "eTag": "4", - "subscription": { - "arn": "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890", - "createdAt": "2025-01-15T10:30:00Z", - "planFamily": "CloudFront", - "planTier": "BUSINESS", - "resourceArns": [ - "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE", - "arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4" - ], - "status": "ACTIVE", - "updatedAt": "2025-01-17T09:00:00Z" - } - }, - "id": "example-1", - "title": "Cancel a pending subscription change" - } - ], - "CreateSubscription": [ - { - "input": { - "approvalMode": "MANUAL", - "planFamily": "CloudFront", - "planTier": "PRO", - "resourceArns": [ - "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE", - "arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4" - ] - }, - "output": { - "eTag": "1", - "subscription": { - "arn": "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890", - "createdAt": "2025-01-15T10:30:00Z", - "planFamily": "CloudFront", - "planTier": "PRO", - "resourceArns": [ - "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE", - "arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4" - ], - "status": "PENDING_APPROVAL", - "updatedAt": "2025-01-15T10:30:00Z" - } - }, - "id": "example-1", - "title": "Create a flat-rate pricing subscription (deferred approval)" - }, - { - "input": { - "approvalMode": "IMMEDIATE", - "planFamily": "CloudFront", - "planTier": "PRO", - "resourceArns": [ - "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE", - "arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4" - ] - }, - "output": { - "eTag": "1", - "subscription": { - "arn": "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890", - "createdAt": "2025-01-15T10:30:00Z", - "planFamily": "CloudFront", - "planTier": "PRO", - "resourceArns": [ - "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE", - "arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4" - ], - "status": "SYNC_IN_PROGRESS", - "updatedAt": "2025-01-15T10:30:00Z" - } - }, - "id": "example-2", - "title": "Create a subscription with approval mode" - } - ], - "DisassociateResourcesFromSubscription": [ - { - "input": { - "arn": "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890", - "ifMatch": "2", - "resourceArns": [ - "arn:aws:route53:::hostedzone/Z0123456789EXAMPLE" - ] - }, - "output": { - "eTag": "3", - "subscription": { - "arn": "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890", - "createdAt": "2025-01-15T10:30:00Z", - "planFamily": "CloudFront", - "planTier": "PRO", - "resourceArns": [ - "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE", - "arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4" - ], - "status": "SYNC_IN_PROGRESS", - "updatedAt": "2025-01-18T15:00:00Z" - } - }, - "id": "example-1", - "title": "Remove a resource from a subscription" - } - ], - "GetSubscription": [ - { - "input": { - "arn": "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890" - }, - "output": { - "eTag": "1", - "subscription": { - "arn": "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890", - "createdAt": "2025-01-15T10:30:00Z", - "planFamily": "CloudFront", - "planTier": "PRO", - "resourceArns": [ - "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE", - "arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4" - ], - "status": "ACTIVE", - "updatedAt": "2025-01-15T10:30:00Z" - } - }, - "id": "example-1", - "title": "Get subscription details" - } - ], - "ListSubscriptions": [ - { - "input": {}, - "output": { - "subscriptionSummaries": [ - { - "arn": "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890", - "createdAt": "2025-01-15T10:30:00Z", - "eTag": "1", - "planFamily": "CloudFront", - "planTier": "PRO", - "resourceArns": [ - "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE", - "arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4" - ], - "status": "ACTIVE", - "updatedAt": "2025-01-15T10:30:00Z" - } - ] - }, - "id": "example-1", - "title": "List all subscriptions" - } - ], - "UpdateSubscription": [ - { - "input": { - "arn": "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890", - "ifMatch": "1", - "planTier": "BUSINESS" - }, - "output": { - "eTag": "2", - "subscription": { - "arn": "arn:aws:pricingplanmanager::123456789012:subscription/sub-1234567890", - "createdAt": "2025-01-15T10:30:00Z", - "planFamily": "CloudFront", - "planTier": "BUSINESS", - "resourceArns": [ - "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE", - "arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4" - ], - "status": "SYNC_IN_PROGRESS", - "updatedAt": "2025-01-16T08:00:00Z" - } - }, - "id": "example-1", - "title": "Update a subscription plan tier" - } - ] - } -} diff --git a/tools/code-generation/api-descriptions/pricing-plan-manager/2025-08-05/paginators-1.json b/tools/code-generation/api-descriptions/pricing-plan-manager/2025-08-05/paginators-1.json deleted file mode 100644 index 9c8834ba9c42..000000000000 --- a/tools/code-generation/api-descriptions/pricing-plan-manager/2025-08-05/paginators-1.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "pagination": { - "ListSubscriptions": { - "input_token": "nextToken", - "output_token": "nextToken", - "result_key": "subscriptionSummaries" - } - } -} diff --git a/tools/code-generation/api-descriptions/pricing-plan-manager/2025-08-05/smoke-2.json b/tools/code-generation/api-descriptions/pricing-plan-manager/2025-08-05/smoke-2.json deleted file mode 100644 index df8b17226594..000000000000 --- a/tools/code-generation/api-descriptions/pricing-plan-manager/2025-08-05/smoke-2.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "version" : 2, - "testCases" : [ { - "id" : "ListSubscriptionsSuccess", - "operationName" : "ListSubscriptions", - "input" : { }, - "expectation" : { - "success" : { } - }, - "config" : { - "region" : "us-east-1", - "useFips" : false, - "useDualstack" : false, - "useAccountIdRouting" : true - } - }, { - "id" : "GetSubscriptionFailure", - "operationName" : "GetSubscription", - "input" : { - "arn" : "arn:aws:pricingplanmanager::123456789012:subscription/non-existent" - }, - "expectation" : { - "failure" : { - "errorId" : "ResourceNotFoundException" - } - }, - "config" : { - "region" : "us-east-1", - "useFips" : false, - "useDualstack" : false, - "useAccountIdRouting" : true - } - } ] -} \ No newline at end of file diff --git a/tools/code-generation/api-descriptions/sagemaker-2017-07-24.normal.json b/tools/code-generation/api-descriptions/sagemaker-2017-07-24.normal.json index 8b4c170e5db6..df971da5be34 100644 --- a/tools/code-generation/api-descriptions/sagemaker-2017-07-24.normal.json +++ b/tools/code-generation/api-descriptions/sagemaker-2017-07-24.normal.json @@ -5401,7 +5401,7 @@ "documentation":"

The list of LoRA adapters with their Amazon S3 URIs.

" } }, - "documentation":"

The per-recommendation LoRA adapter details. Contains both the model package ARNs and Amazon S3 URIs for each adapter, regardless of which form was originally supplied in the request. When the customer supplies only Amazon S3 URIs, Amazon SageMaker AI creates model packages on their behalf.

" + "documentation":"

The per-recommendation LoRA adapter details. Contains both the model package ARNs and Amazon S3 URIs for each adapter, regardless of which form was originally supplied in the request. When you supply only Amazon S3 URIs, Amazon SageMaker AI creates model packages on your behalf.

" }, "AIRecommendationAllowOptimization":{ "type":"boolean", @@ -5469,7 +5469,7 @@ }, "MinCpuMemoryRequiredInMb":{ "shape":"AIRecommendationMinCpuMemoryRequiredInMb", - "documentation":"

The minimum host (CPU) memory, in MiB, to reserve per model copy when deploying the recommendation as an Inference Component. This value maps to the base Inference Component's ComputeResourceRequirements$MinMemoryRequiredInMb and is sized so that CopyCountPerInstance copies co-place within the instance's allocatable host memory.

" + "documentation":"

The minimum host (CPU) memory, in MiB, to reserve for each model copy when deploying the recommendation as an Inference Component. This value maps to the Inference Component's ComputeResourceRequirements$MinMemoryRequiredInMb field.

" } }, "documentation":"

The deployment configuration for a recommendation.

" @@ -6792,6 +6792,12 @@ "ml.r6id.24xlarge", "ml.r6id.32xlarge", "ml.p5.4xlarge", + "ml.g7.2xlarge", + "ml.g7.4xlarge", + "ml.g7.8xlarge", + "ml.g7.12xlarge", + "ml.g7.24xlarge", + "ml.g7.48xlarge", "ml.g7e.2xlarge", "ml.g7e.4xlarge", "ml.g7e.8xlarge", @@ -15354,7 +15360,7 @@ }, "TrainingPlanArns":{ "shape":"OptimizationJobTrainingPlanArns", - "documentation":"

The Amazon Resource Name (ARN) of the training plan to use for this optimization job.

When you use reserved capacity from a training plan, the optimization job runs on that reserved capacity instead of on-demand capacity. If you omit this field, the job uses on-demand capacity. Currently, you can specify at most one training plan.

For more information about how to reserve GPU capacity for your optimization jobs using Amazon SageMaker Training Plans, see Reserve capacity with training plans.

" + "documentation":"

The Amazon Resource Name (ARN) of the training plan to use for this optimization job.

When you use reserved capacity from a training plan, the optimization job runs on that reserved capacity instead of on-demand capacity. If you omit this field, the job uses on-demand capacity. You can specify at most one training plan.

For more information about how to reserve GPU capacity for your optimization jobs using Amazon SageMaker Training Plans, see Reserve capacity with training plans.

" } } }, @@ -18169,7 +18175,7 @@ }, "AdapterSource":{ "shape":"AIAdapterSource", - "documentation":"

The LoRA adapter source that was specified when the recommendation job was created. This field is absent when the job was created without LoRA adapters.

" + "documentation":"

The LoRA adapter source that you specified when you created the recommendation job. This field is absent when you created the job without LoRA adapters.

" }, "CreationTime":{ "shape":"Timestamp", diff --git a/tools/code-generation/api-descriptions/sagemaker/2017-07-24/api-2.json b/tools/code-generation/api-descriptions/sagemaker/2017-07-24/api-2.json deleted file mode 100644 index 80ad9b1ca7ac..000000000000 --- a/tools/code-generation/api-descriptions/sagemaker/2017-07-24/api-2.json +++ /dev/null @@ -1,32462 +0,0 @@ -{ - "version":"2.0", - "metadata":{ - "apiVersion":"2017-07-24", - "auth":["aws.auth#sigv4"], - "endpointPrefix":"api.sagemaker", - "jsonVersion":"1.1", - "protocol":"json", - "protocols":["json"], - "serviceAbbreviation":"SageMaker", - "serviceFullName":"Amazon SageMaker Service", - "serviceId":"SageMaker", - "signatureVersion":"v4", - "signingName":"sagemaker", - "targetPrefix":"SageMaker", - "uid":"sagemaker-2017-07-24" - }, - "operations":{ - "AddAssociation":{ - "name":"AddAssociation", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AddAssociationRequest"}, - "output":{"shape":"AddAssociationResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "AddTags":{ - "name":"AddTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AddTagsInput"}, - "output":{"shape":"AddTagsOutput"} - }, - "AssociateTrialComponent":{ - "name":"AssociateTrialComponent", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AssociateTrialComponentRequest"}, - "output":{"shape":"AssociateTrialComponentResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "AttachClusterNodeVolume":{ - "name":"AttachClusterNodeVolume", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AttachClusterNodeVolumeRequest"}, - "output":{"shape":"AttachClusterNodeVolumeResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "BatchAddClusterNodes":{ - "name":"BatchAddClusterNodes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"BatchAddClusterNodesRequest"}, - "output":{"shape":"BatchAddClusterNodesResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "BatchDeleteClusterNodes":{ - "name":"BatchDeleteClusterNodes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"BatchDeleteClusterNodesRequest"}, - "output":{"shape":"BatchDeleteClusterNodesResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "BatchDescribeModelPackage":{ - "name":"BatchDescribeModelPackage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"BatchDescribeModelPackageInput"}, - "output":{"shape":"BatchDescribeModelPackageOutput"} - }, - "BatchRebootClusterNodes":{ - "name":"BatchRebootClusterNodes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"BatchRebootClusterNodesRequest"}, - "output":{"shape":"BatchRebootClusterNodesResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "BatchReplaceClusterNodes":{ - "name":"BatchReplaceClusterNodes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"BatchReplaceClusterNodesRequest"}, - "output":{"shape":"BatchReplaceClusterNodesResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "CreateAIBenchmarkJob":{ - "name":"CreateAIBenchmarkJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateAIBenchmarkJobRequest"}, - "output":{"shape":"CreateAIBenchmarkJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateAIRecommendationJob":{ - "name":"CreateAIRecommendationJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateAIRecommendationJobRequest"}, - "output":{"shape":"CreateAIRecommendationJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateAIWorkloadConfig":{ - "name":"CreateAIWorkloadConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateAIWorkloadConfigRequest"}, - "output":{"shape":"CreateAIWorkloadConfigResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateAction":{ - "name":"CreateAction", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateActionRequest"}, - "output":{"shape":"CreateActionResponse"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateAlgorithm":{ - "name":"CreateAlgorithm", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateAlgorithmInput"}, - "output":{"shape":"CreateAlgorithmOutput"} - }, - "CreateApp":{ - "name":"CreateApp", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateAppRequest"}, - "output":{"shape":"CreateAppResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateAppImageConfig":{ - "name":"CreateAppImageConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateAppImageConfigRequest"}, - "output":{"shape":"CreateAppImageConfigResponse"}, - "errors":[ - {"shape":"ResourceInUse"} - ] - }, - "CreateArtifact":{ - "name":"CreateArtifact", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateArtifactRequest"}, - "output":{"shape":"CreateArtifactResponse"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateAutoMLJob":{ - "name":"CreateAutoMLJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateAutoMLJobRequest"}, - "output":{"shape":"CreateAutoMLJobResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateAutoMLJobV2":{ - "name":"CreateAutoMLJobV2", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateAutoMLJobV2Request"}, - "output":{"shape":"CreateAutoMLJobV2Response"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateCluster":{ - "name":"CreateCluster", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateClusterRequest"}, - "output":{"shape":"CreateClusterResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateClusterSchedulerConfig":{ - "name":"CreateClusterSchedulerConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateClusterSchedulerConfigRequest"}, - "output":{"shape":"CreateClusterSchedulerConfigResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateCodeRepository":{ - "name":"CreateCodeRepository", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateCodeRepositoryInput"}, - "output":{"shape":"CreateCodeRepositoryOutput"} - }, - "CreateCompilationJob":{ - "name":"CreateCompilationJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateCompilationJobRequest"}, - "output":{"shape":"CreateCompilationJobResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateComputeQuota":{ - "name":"CreateComputeQuota", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateComputeQuotaRequest"}, - "output":{"shape":"CreateComputeQuotaResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateContext":{ - "name":"CreateContext", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateContextRequest"}, - "output":{"shape":"CreateContextResponse"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateDataQualityJobDefinition":{ - "name":"CreateDataQualityJobDefinition", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateDataQualityJobDefinitionRequest"}, - "output":{"shape":"CreateDataQualityJobDefinitionResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateDeviceFleet":{ - "name":"CreateDeviceFleet", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateDeviceFleetRequest"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateDomain":{ - "name":"CreateDomain", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateDomainRequest"}, - "output":{"shape":"CreateDomainResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateEdgeDeploymentPlan":{ - "name":"CreateEdgeDeploymentPlan", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateEdgeDeploymentPlanRequest"}, - "output":{"shape":"CreateEdgeDeploymentPlanResponse"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateEdgeDeploymentStage":{ - "name":"CreateEdgeDeploymentStage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateEdgeDeploymentStageRequest"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateEdgePackagingJob":{ - "name":"CreateEdgePackagingJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateEdgePackagingJobRequest"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateEndpoint":{ - "name":"CreateEndpoint", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateEndpointInput"}, - "output":{"shape":"CreateEndpointOutput"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateEndpointConfig":{ - "name":"CreateEndpointConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateEndpointConfigInput"}, - "output":{"shape":"CreateEndpointConfigOutput"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateExperiment":{ - "name":"CreateExperiment", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateExperimentRequest"}, - "output":{"shape":"CreateExperimentResponse"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateFeatureGroup":{ - "name":"CreateFeatureGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateFeatureGroupRequest"}, - "output":{"shape":"CreateFeatureGroupResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateFlowDefinition":{ - "name":"CreateFlowDefinition", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateFlowDefinitionRequest"}, - "output":{"shape":"CreateFlowDefinitionResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateHub":{ - "name":"CreateHub", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateHubRequest"}, - "output":{"shape":"CreateHubResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateHubContentPresignedUrls":{ - "name":"CreateHubContentPresignedUrls", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateHubContentPresignedUrlsRequest"}, - "output":{"shape":"CreateHubContentPresignedUrlsResponse"} - }, - "CreateHubContentReference":{ - "name":"CreateHubContentReference", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateHubContentReferenceRequest"}, - "output":{"shape":"CreateHubContentReferenceResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateHumanTaskUi":{ - "name":"CreateHumanTaskUi", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateHumanTaskUiRequest"}, - "output":{"shape":"CreateHumanTaskUiResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateHyperParameterTuningJob":{ - "name":"CreateHyperParameterTuningJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateHyperParameterTuningJobRequest"}, - "output":{"shape":"CreateHyperParameterTuningJobResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateImage":{ - "name":"CreateImage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateImageRequest"}, - "output":{"shape":"CreateImageResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateImageVersion":{ - "name":"CreateImageVersion", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateImageVersionRequest"}, - "output":{"shape":"CreateImageVersionResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateInferenceComponent":{ - "name":"CreateInferenceComponent", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateInferenceComponentInput"}, - "output":{"shape":"CreateInferenceComponentOutput"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateInferenceExperiment":{ - "name":"CreateInferenceExperiment", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateInferenceExperimentRequest"}, - "output":{"shape":"CreateInferenceExperimentResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateInferenceRecommendationsJob":{ - "name":"CreateInferenceRecommendationsJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateInferenceRecommendationsJobRequest"}, - "output":{"shape":"CreateInferenceRecommendationsJobResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateJob":{ - "name":"CreateJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateJobRequest"}, - "output":{"shape":"CreateJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateLabelingJob":{ - "name":"CreateLabelingJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateLabelingJobRequest"}, - "output":{"shape":"CreateLabelingJobResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateMlflowApp":{ - "name":"CreateMlflowApp", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateMlflowAppRequest"}, - "output":{"shape":"CreateMlflowAppResponse"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateMlflowTrackingServer":{ - "name":"CreateMlflowTrackingServer", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateMlflowTrackingServerRequest"}, - "output":{"shape":"CreateMlflowTrackingServerResponse"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateModel":{ - "name":"CreateModel", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateModelInput"}, - "output":{"shape":"CreateModelOutput"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateModelBiasJobDefinition":{ - "name":"CreateModelBiasJobDefinition", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateModelBiasJobDefinitionRequest"}, - "output":{"shape":"CreateModelBiasJobDefinitionResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateModelCard":{ - "name":"CreateModelCard", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateModelCardRequest"}, - "output":{"shape":"CreateModelCardResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateModelCardExportJob":{ - "name":"CreateModelCardExportJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateModelCardExportJobRequest"}, - "output":{"shape":"CreateModelCardExportJobResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateModelExplainabilityJobDefinition":{ - "name":"CreateModelExplainabilityJobDefinition", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateModelExplainabilityJobDefinitionRequest"}, - "output":{"shape":"CreateModelExplainabilityJobDefinitionResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateModelPackage":{ - "name":"CreateModelPackage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateModelPackageInput"}, - "output":{"shape":"CreateModelPackageOutput"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateModelPackageGroup":{ - "name":"CreateModelPackageGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateModelPackageGroupInput"}, - "output":{"shape":"CreateModelPackageGroupOutput"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateModelQualityJobDefinition":{ - "name":"CreateModelQualityJobDefinition", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateModelQualityJobDefinitionRequest"}, - "output":{"shape":"CreateModelQualityJobDefinitionResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateMonitoringSchedule":{ - "name":"CreateMonitoringSchedule", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateMonitoringScheduleRequest"}, - "output":{"shape":"CreateMonitoringScheduleResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateNotebookInstance":{ - "name":"CreateNotebookInstance", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateNotebookInstanceInput"}, - "output":{"shape":"CreateNotebookInstanceOutput"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateNotebookInstanceLifecycleConfig":{ - "name":"CreateNotebookInstanceLifecycleConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateNotebookInstanceLifecycleConfigInput"}, - "output":{"shape":"CreateNotebookInstanceLifecycleConfigOutput"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateOptimizationJob":{ - "name":"CreateOptimizationJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateOptimizationJobRequest"}, - "output":{"shape":"CreateOptimizationJobResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreatePartnerApp":{ - "name":"CreatePartnerApp", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreatePartnerAppRequest"}, - "output":{"shape":"CreatePartnerAppResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreatePartnerAppPresignedUrl":{ - "name":"CreatePartnerAppPresignedUrl", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreatePartnerAppPresignedUrlRequest"}, - "output":{"shape":"CreatePartnerAppPresignedUrlResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "CreatePipeline":{ - "name":"CreatePipeline", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreatePipelineRequest"}, - "output":{"shape":"CreatePipelineResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreatePresignedDomainUrl":{ - "name":"CreatePresignedDomainUrl", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreatePresignedDomainUrlRequest"}, - "output":{"shape":"CreatePresignedDomainUrlResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "CreatePresignedMlflowAppUrl":{ - "name":"CreatePresignedMlflowAppUrl", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreatePresignedMlflowAppUrlRequest"}, - "output":{"shape":"CreatePresignedMlflowAppUrlResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "CreatePresignedMlflowTrackingServerUrl":{ - "name":"CreatePresignedMlflowTrackingServerUrl", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreatePresignedMlflowTrackingServerUrlRequest"}, - "output":{"shape":"CreatePresignedMlflowTrackingServerUrlResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "CreatePresignedNotebookInstanceUrl":{ - "name":"CreatePresignedNotebookInstanceUrl", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreatePresignedNotebookInstanceUrlInput"}, - "output":{"shape":"CreatePresignedNotebookInstanceUrlOutput"} - }, - "CreateProcessingJob":{ - "name":"CreateProcessingJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateProcessingJobRequest"}, - "output":{"shape":"CreateProcessingJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateProject":{ - "name":"CreateProject", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateProjectInput"}, - "output":{"shape":"CreateProjectOutput"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateSpace":{ - "name":"CreateSpace", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateSpaceRequest"}, - "output":{"shape":"CreateSpaceResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateStudioLifecycleConfig":{ - "name":"CreateStudioLifecycleConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateStudioLifecycleConfigRequest"}, - "output":{"shape":"CreateStudioLifecycleConfigResponse"}, - "errors":[ - {"shape":"ResourceInUse"} - ] - }, - "CreateTrainingJob":{ - "name":"CreateTrainingJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateTrainingJobRequest"}, - "output":{"shape":"CreateTrainingJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateTrainingPlan":{ - "name":"CreateTrainingPlan", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateTrainingPlanRequest"}, - "output":{"shape":"CreateTrainingPlanResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateTransformJob":{ - "name":"CreateTransformJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateTransformJobRequest"}, - "output":{"shape":"CreateTransformJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateTrial":{ - "name":"CreateTrial", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateTrialRequest"}, - "output":{"shape":"CreateTrialResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateTrialComponent":{ - "name":"CreateTrialComponent", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateTrialComponentRequest"}, - "output":{"shape":"CreateTrialComponentResponse"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateUserProfile":{ - "name":"CreateUserProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateUserProfileRequest"}, - "output":{"shape":"CreateUserProfileResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "CreateWorkforce":{ - "name":"CreateWorkforce", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateWorkforceRequest"}, - "output":{"shape":"CreateWorkforceResponse"} - }, - "CreateWorkteam":{ - "name":"CreateWorkteam", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateWorkteamRequest"}, - "output":{"shape":"CreateWorkteamResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "DeleteAIBenchmarkJob":{ - "name":"DeleteAIBenchmarkJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteAIBenchmarkJobRequest"}, - "output":{"shape":"DeleteAIBenchmarkJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DeleteAIRecommendationJob":{ - "name":"DeleteAIRecommendationJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteAIRecommendationJobRequest"}, - "output":{"shape":"DeleteAIRecommendationJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DeleteAIWorkloadConfig":{ - "name":"DeleteAIWorkloadConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteAIWorkloadConfigRequest"}, - "output":{"shape":"DeleteAIWorkloadConfigResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"} - ] - }, - "DeleteAction":{ - "name":"DeleteAction", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteActionRequest"}, - "output":{"shape":"DeleteActionResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DeleteAlgorithm":{ - "name":"DeleteAlgorithm", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteAlgorithmInput"}, - "errors":[ - {"shape":"ConflictException"} - ] - }, - "DeleteApp":{ - "name":"DeleteApp", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteAppRequest"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"} - ] - }, - "DeleteAppImageConfig":{ - "name":"DeleteAppImageConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteAppImageConfigRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DeleteArtifact":{ - "name":"DeleteArtifact", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteArtifactRequest"}, - "output":{"shape":"DeleteArtifactResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DeleteAssociation":{ - "name":"DeleteAssociation", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteAssociationRequest"}, - "output":{"shape":"DeleteAssociationResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DeleteCluster":{ - "name":"DeleteCluster", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteClusterRequest"}, - "output":{"shape":"DeleteClusterResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ] - }, - "DeleteClusterSchedulerConfig":{ - "name":"DeleteClusterSchedulerConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteClusterSchedulerConfigRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DeleteCodeRepository":{ - "name":"DeleteCodeRepository", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteCodeRepositoryInput"} - }, - "DeleteCompilationJob":{ - "name":"DeleteCompilationJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteCompilationJobRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DeleteComputeQuota":{ - "name":"DeleteComputeQuota", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteComputeQuotaRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DeleteContext":{ - "name":"DeleteContext", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteContextRequest"}, - "output":{"shape":"DeleteContextResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DeleteDataQualityJobDefinition":{ - "name":"DeleteDataQualityJobDefinition", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteDataQualityJobDefinitionRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DeleteDeviceFleet":{ - "name":"DeleteDeviceFleet", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteDeviceFleetRequest"}, - "errors":[ - {"shape":"ResourceInUse"} - ] - }, - "DeleteDomain":{ - "name":"DeleteDomain", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteDomainRequest"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"} - ] - }, - "DeleteEdgeDeploymentPlan":{ - "name":"DeleteEdgeDeploymentPlan", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteEdgeDeploymentPlanRequest"}, - "errors":[ - {"shape":"ResourceInUse"} - ] - }, - "DeleteEdgeDeploymentStage":{ - "name":"DeleteEdgeDeploymentStage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteEdgeDeploymentStageRequest"}, - "errors":[ - {"shape":"ResourceInUse"} - ] - }, - "DeleteEndpoint":{ - "name":"DeleteEndpoint", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteEndpointInput"} - }, - "DeleteEndpointConfig":{ - "name":"DeleteEndpointConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteEndpointConfigInput"} - }, - "DeleteExperiment":{ - "name":"DeleteExperiment", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteExperimentRequest"}, - "output":{"shape":"DeleteExperimentResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DeleteFeatureGroup":{ - "name":"DeleteFeatureGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteFeatureGroupRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DeleteFlowDefinition":{ - "name":"DeleteFlowDefinition", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteFlowDefinitionRequest"}, - "output":{"shape":"DeleteFlowDefinitionResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"} - ] - }, - "DeleteHub":{ - "name":"DeleteHub", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteHubRequest"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"} - ] - }, - "DeleteHubContent":{ - "name":"DeleteHubContent", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteHubContentRequest"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"} - ] - }, - "DeleteHubContentReference":{ - "name":"DeleteHubContentReference", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteHubContentReferenceRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DeleteHumanTaskUi":{ - "name":"DeleteHumanTaskUi", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteHumanTaskUiRequest"}, - "output":{"shape":"DeleteHumanTaskUiResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DeleteHyperParameterTuningJob":{ - "name":"DeleteHyperParameterTuningJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteHyperParameterTuningJobRequest"} - }, - "DeleteImage":{ - "name":"DeleteImage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteImageRequest"}, - "output":{"shape":"DeleteImageResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"} - ] - }, - "DeleteImageVersion":{ - "name":"DeleteImageVersion", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteImageVersionRequest"}, - "output":{"shape":"DeleteImageVersionResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"} - ] - }, - "DeleteInferenceComponent":{ - "name":"DeleteInferenceComponent", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteInferenceComponentInput"} - }, - "DeleteInferenceExperiment":{ - "name":"DeleteInferenceExperiment", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteInferenceExperimentRequest"}, - "output":{"shape":"DeleteInferenceExperimentResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ] - }, - "DeleteJob":{ - "name":"DeleteJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteJobRequest"}, - "output":{"shape":"DeleteJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"} - ], - "idempotent":true - }, - "DeleteMlflowApp":{ - "name":"DeleteMlflowApp", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteMlflowAppRequest"}, - "output":{"shape":"DeleteMlflowAppResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DeleteMlflowTrackingServer":{ - "name":"DeleteMlflowTrackingServer", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteMlflowTrackingServerRequest"}, - "output":{"shape":"DeleteMlflowTrackingServerResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DeleteModel":{ - "name":"DeleteModel", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteModelInput"} - }, - "DeleteModelBiasJobDefinition":{ - "name":"DeleteModelBiasJobDefinition", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteModelBiasJobDefinitionRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DeleteModelCard":{ - "name":"DeleteModelCard", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteModelCardRequest"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ] - }, - "DeleteModelExplainabilityJobDefinition":{ - "name":"DeleteModelExplainabilityJobDefinition", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteModelExplainabilityJobDefinitionRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DeleteModelPackage":{ - "name":"DeleteModelPackage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteModelPackageInput"}, - "errors":[ - {"shape":"ConflictException"} - ] - }, - "DeleteModelPackageGroup":{ - "name":"DeleteModelPackageGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteModelPackageGroupInput"}, - "errors":[ - {"shape":"ConflictException"} - ] - }, - "DeleteModelPackageGroupPolicy":{ - "name":"DeleteModelPackageGroupPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteModelPackageGroupPolicyInput"} - }, - "DeleteModelQualityJobDefinition":{ - "name":"DeleteModelQualityJobDefinition", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteModelQualityJobDefinitionRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DeleteMonitoringSchedule":{ - "name":"DeleteMonitoringSchedule", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteMonitoringScheduleRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DeleteNotebookInstance":{ - "name":"DeleteNotebookInstance", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteNotebookInstanceInput"} - }, - "DeleteNotebookInstanceLifecycleConfig":{ - "name":"DeleteNotebookInstanceLifecycleConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteNotebookInstanceLifecycleConfigInput"} - }, - "DeleteOptimizationJob":{ - "name":"DeleteOptimizationJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteOptimizationJobRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DeletePartnerApp":{ - "name":"DeletePartnerApp", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeletePartnerAppRequest"}, - "output":{"shape":"DeletePartnerAppResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ] - }, - "DeletePipeline":{ - "name":"DeletePipeline", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeletePipelineRequest"}, - "output":{"shape":"DeletePipelineResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ] - }, - "DeleteProcessingJob":{ - "name":"DeleteProcessingJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteProcessingJobRequest"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"} - ] - }, - "DeleteProject":{ - "name":"DeleteProject", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteProjectInput"}, - "errors":[ - {"shape":"ConflictException"} - ] - }, - "DeleteSpace":{ - "name":"DeleteSpace", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteSpaceRequest"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"} - ] - }, - "DeleteStudioLifecycleConfig":{ - "name":"DeleteStudioLifecycleConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteStudioLifecycleConfigRequest"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"} - ] - }, - "DeleteTags":{ - "name":"DeleteTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteTagsInput"}, - "output":{"shape":"DeleteTagsOutput"} - }, - "DeleteTrainingJob":{ - "name":"DeleteTrainingJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteTrainingJobRequest"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"} - ] - }, - "DeleteTrial":{ - "name":"DeleteTrial", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteTrialRequest"}, - "output":{"shape":"DeleteTrialResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DeleteTrialComponent":{ - "name":"DeleteTrialComponent", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteTrialComponentRequest"}, - "output":{"shape":"DeleteTrialComponentResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DeleteUserProfile":{ - "name":"DeleteUserProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteUserProfileRequest"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"} - ] - }, - "DeleteWorkforce":{ - "name":"DeleteWorkforce", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteWorkforceRequest"}, - "output":{"shape":"DeleteWorkforceResponse"} - }, - "DeleteWorkteam":{ - "name":"DeleteWorkteam", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteWorkteamRequest"}, - "output":{"shape":"DeleteWorkteamResponse"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ] - }, - "DeregisterDevices":{ - "name":"DeregisterDevices", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeregisterDevicesRequest"} - }, - "DescribeAIBenchmarkJob":{ - "name":"DescribeAIBenchmarkJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeAIBenchmarkJobRequest"}, - "output":{"shape":"DescribeAIBenchmarkJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeAIRecommendationJob":{ - "name":"DescribeAIRecommendationJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeAIRecommendationJobRequest"}, - "output":{"shape":"DescribeAIRecommendationJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeAIWorkloadConfig":{ - "name":"DescribeAIWorkloadConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeAIWorkloadConfigRequest"}, - "output":{"shape":"DescribeAIWorkloadConfigResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeAction":{ - "name":"DescribeAction", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeActionRequest"}, - "output":{"shape":"DescribeActionResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeAlgorithm":{ - "name":"DescribeAlgorithm", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeAlgorithmInput"}, - "output":{"shape":"DescribeAlgorithmOutput"} - }, - "DescribeApp":{ - "name":"DescribeApp", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeAppRequest"}, - "output":{"shape":"DescribeAppResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeAppImageConfig":{ - "name":"DescribeAppImageConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeAppImageConfigRequest"}, - "output":{"shape":"DescribeAppImageConfigResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeArtifact":{ - "name":"DescribeArtifact", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeArtifactRequest"}, - "output":{"shape":"DescribeArtifactResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeAutoMLJob":{ - "name":"DescribeAutoMLJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeAutoMLJobRequest"}, - "output":{"shape":"DescribeAutoMLJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeAutoMLJobV2":{ - "name":"DescribeAutoMLJobV2", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeAutoMLJobV2Request"}, - "output":{"shape":"DescribeAutoMLJobV2Response"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeCluster":{ - "name":"DescribeCluster", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeClusterRequest"}, - "output":{"shape":"DescribeClusterResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeClusterEvent":{ - "name":"DescribeClusterEvent", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeClusterEventRequest"}, - "output":{"shape":"DescribeClusterEventResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeClusterNode":{ - "name":"DescribeClusterNode", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeClusterNodeRequest"}, - "output":{"shape":"DescribeClusterNodeResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeClusterSchedulerConfig":{ - "name":"DescribeClusterSchedulerConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeClusterSchedulerConfigRequest"}, - "output":{"shape":"DescribeClusterSchedulerConfigResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeCodeRepository":{ - "name":"DescribeCodeRepository", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeCodeRepositoryInput"}, - "output":{"shape":"DescribeCodeRepositoryOutput"} - }, - "DescribeCompilationJob":{ - "name":"DescribeCompilationJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeCompilationJobRequest"}, - "output":{"shape":"DescribeCompilationJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeComputeQuota":{ - "name":"DescribeComputeQuota", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeComputeQuotaRequest"}, - "output":{"shape":"DescribeComputeQuotaResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeContext":{ - "name":"DescribeContext", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeContextRequest"}, - "output":{"shape":"DescribeContextResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeDataQualityJobDefinition":{ - "name":"DescribeDataQualityJobDefinition", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeDataQualityJobDefinitionRequest"}, - "output":{"shape":"DescribeDataQualityJobDefinitionResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeDevice":{ - "name":"DescribeDevice", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeDeviceRequest"}, - "output":{"shape":"DescribeDeviceResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeDeviceFleet":{ - "name":"DescribeDeviceFleet", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeDeviceFleetRequest"}, - "output":{"shape":"DescribeDeviceFleetResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeDomain":{ - "name":"DescribeDomain", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeDomainRequest"}, - "output":{"shape":"DescribeDomainResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeEdgeDeploymentPlan":{ - "name":"DescribeEdgeDeploymentPlan", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeEdgeDeploymentPlanRequest"}, - "output":{"shape":"DescribeEdgeDeploymentPlanResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeEdgePackagingJob":{ - "name":"DescribeEdgePackagingJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeEdgePackagingJobRequest"}, - "output":{"shape":"DescribeEdgePackagingJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeEndpoint":{ - "name":"DescribeEndpoint", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeEndpointInput"}, - "output":{"shape":"DescribeEndpointOutput"} - }, - "DescribeEndpointConfig":{ - "name":"DescribeEndpointConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeEndpointConfigInput"}, - "output":{"shape":"DescribeEndpointConfigOutput"} - }, - "DescribeExperiment":{ - "name":"DescribeExperiment", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeExperimentRequest"}, - "output":{"shape":"DescribeExperimentResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeFeatureGroup":{ - "name":"DescribeFeatureGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeFeatureGroupRequest"}, - "output":{"shape":"DescribeFeatureGroupResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeFeatureMetadata":{ - "name":"DescribeFeatureMetadata", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeFeatureMetadataRequest"}, - "output":{"shape":"DescribeFeatureMetadataResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeFlowDefinition":{ - "name":"DescribeFlowDefinition", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeFlowDefinitionRequest"}, - "output":{"shape":"DescribeFlowDefinitionResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeHub":{ - "name":"DescribeHub", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeHubRequest"}, - "output":{"shape":"DescribeHubResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeHubContent":{ - "name":"DescribeHubContent", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeHubContentRequest"}, - "output":{"shape":"DescribeHubContentResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeHumanTaskUi":{ - "name":"DescribeHumanTaskUi", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeHumanTaskUiRequest"}, - "output":{"shape":"DescribeHumanTaskUiResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeHyperParameterTuningJob":{ - "name":"DescribeHyperParameterTuningJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeHyperParameterTuningJobRequest"}, - "output":{"shape":"DescribeHyperParameterTuningJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeImage":{ - "name":"DescribeImage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeImageRequest"}, - "output":{"shape":"DescribeImageResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeImageVersion":{ - "name":"DescribeImageVersion", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeImageVersionRequest"}, - "output":{"shape":"DescribeImageVersionResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeInferenceComponent":{ - "name":"DescribeInferenceComponent", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeInferenceComponentInput"}, - "output":{"shape":"DescribeInferenceComponentOutput"} - }, - "DescribeInferenceExperiment":{ - "name":"DescribeInferenceExperiment", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeInferenceExperimentRequest"}, - "output":{"shape":"DescribeInferenceExperimentResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeInferenceRecommendationsJob":{ - "name":"DescribeInferenceRecommendationsJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeInferenceRecommendationsJobRequest"}, - "output":{"shape":"DescribeInferenceRecommendationsJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeJob":{ - "name":"DescribeJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeJobRequest"}, - "output":{"shape":"DescribeJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "readonly":true - }, - "DescribeJobSchemaVersion":{ - "name":"DescribeJobSchemaVersion", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeJobSchemaVersionRequest"}, - "output":{"shape":"DescribeJobSchemaVersionResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "readonly":true - }, - "DescribeLabelingJob":{ - "name":"DescribeLabelingJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeLabelingJobRequest"}, - "output":{"shape":"DescribeLabelingJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeLineageGroup":{ - "name":"DescribeLineageGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeLineageGroupRequest"}, - "output":{"shape":"DescribeLineageGroupResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeMlflowApp":{ - "name":"DescribeMlflowApp", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeMlflowAppRequest"}, - "output":{"shape":"DescribeMlflowAppResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeMlflowTrackingServer":{ - "name":"DescribeMlflowTrackingServer", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeMlflowTrackingServerRequest"}, - "output":{"shape":"DescribeMlflowTrackingServerResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeModel":{ - "name":"DescribeModel", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeModelInput"}, - "output":{"shape":"DescribeModelOutput"} - }, - "DescribeModelBiasJobDefinition":{ - "name":"DescribeModelBiasJobDefinition", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeModelBiasJobDefinitionRequest"}, - "output":{"shape":"DescribeModelBiasJobDefinitionResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeModelCard":{ - "name":"DescribeModelCard", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeModelCardRequest"}, - "output":{"shape":"DescribeModelCardResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeModelCardExportJob":{ - "name":"DescribeModelCardExportJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeModelCardExportJobRequest"}, - "output":{"shape":"DescribeModelCardExportJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeModelExplainabilityJobDefinition":{ - "name":"DescribeModelExplainabilityJobDefinition", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeModelExplainabilityJobDefinitionRequest"}, - "output":{"shape":"DescribeModelExplainabilityJobDefinitionResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeModelPackage":{ - "name":"DescribeModelPackage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeModelPackageInput"}, - "output":{"shape":"DescribeModelPackageOutput"} - }, - "DescribeModelPackageGroup":{ - "name":"DescribeModelPackageGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeModelPackageGroupInput"}, - "output":{"shape":"DescribeModelPackageGroupOutput"} - }, - "DescribeModelQualityJobDefinition":{ - "name":"DescribeModelQualityJobDefinition", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeModelQualityJobDefinitionRequest"}, - "output":{"shape":"DescribeModelQualityJobDefinitionResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeMonitoringSchedule":{ - "name":"DescribeMonitoringSchedule", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeMonitoringScheduleRequest"}, - "output":{"shape":"DescribeMonitoringScheduleResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeNotebookInstance":{ - "name":"DescribeNotebookInstance", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeNotebookInstanceInput"}, - "output":{"shape":"DescribeNotebookInstanceOutput"} - }, - "DescribeNotebookInstanceLifecycleConfig":{ - "name":"DescribeNotebookInstanceLifecycleConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeNotebookInstanceLifecycleConfigInput"}, - "output":{"shape":"DescribeNotebookInstanceLifecycleConfigOutput"} - }, - "DescribeOptimizationJob":{ - "name":"DescribeOptimizationJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeOptimizationJobRequest"}, - "output":{"shape":"DescribeOptimizationJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribePartnerApp":{ - "name":"DescribePartnerApp", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribePartnerAppRequest"}, - "output":{"shape":"DescribePartnerAppResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribePipeline":{ - "name":"DescribePipeline", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribePipelineRequest"}, - "output":{"shape":"DescribePipelineResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribePipelineDefinitionForExecution":{ - "name":"DescribePipelineDefinitionForExecution", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribePipelineDefinitionForExecutionRequest"}, - "output":{"shape":"DescribePipelineDefinitionForExecutionResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribePipelineExecution":{ - "name":"DescribePipelineExecution", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribePipelineExecutionRequest"}, - "output":{"shape":"DescribePipelineExecutionResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeProcessingJob":{ - "name":"DescribeProcessingJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeProcessingJobRequest"}, - "output":{"shape":"DescribeProcessingJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeProject":{ - "name":"DescribeProject", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeProjectInput"}, - "output":{"shape":"DescribeProjectOutput"} - }, - "DescribeReservedCapacity":{ - "name":"DescribeReservedCapacity", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeReservedCapacityRequest"}, - "output":{"shape":"DescribeReservedCapacityResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeSpace":{ - "name":"DescribeSpace", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeSpaceRequest"}, - "output":{"shape":"DescribeSpaceResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeStudioLifecycleConfig":{ - "name":"DescribeStudioLifecycleConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeStudioLifecycleConfigRequest"}, - "output":{"shape":"DescribeStudioLifecycleConfigResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeSubscribedWorkteam":{ - "name":"DescribeSubscribedWorkteam", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeSubscribedWorkteamRequest"}, - "output":{"shape":"DescribeSubscribedWorkteamResponse"} - }, - "DescribeTrainingJob":{ - "name":"DescribeTrainingJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeTrainingJobRequest"}, - "output":{"shape":"DescribeTrainingJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeTrainingPlan":{ - "name":"DescribeTrainingPlan", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeTrainingPlanRequest"}, - "output":{"shape":"DescribeTrainingPlanResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeTrainingPlanExtensionHistory":{ - "name":"DescribeTrainingPlanExtensionHistory", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeTrainingPlanExtensionHistoryRequest"}, - "output":{"shape":"DescribeTrainingPlanExtensionHistoryResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeTransformJob":{ - "name":"DescribeTransformJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeTransformJobRequest"}, - "output":{"shape":"DescribeTransformJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeTrial":{ - "name":"DescribeTrial", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeTrialRequest"}, - "output":{"shape":"DescribeTrialResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeTrialComponent":{ - "name":"DescribeTrialComponent", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeTrialComponentRequest"}, - "output":{"shape":"DescribeTrialComponentResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DescribeUserProfile":{ - "name":"DescribeUserProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeUserProfileRequest"}, - "output":{"shape":"DescribeUserProfileResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "DescribeWorkforce":{ - "name":"DescribeWorkforce", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeWorkforceRequest"}, - "output":{"shape":"DescribeWorkforceResponse"} - }, - "DescribeWorkteam":{ - "name":"DescribeWorkteam", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeWorkteamRequest"}, - "output":{"shape":"DescribeWorkteamResponse"} - }, - "DetachClusterNodeVolume":{ - "name":"DetachClusterNodeVolume", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DetachClusterNodeVolumeRequest"}, - "output":{"shape":"DetachClusterNodeVolumeResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "DisableSagemakerServicecatalogPortfolio":{ - "name":"DisableSagemakerServicecatalogPortfolio", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DisableSagemakerServicecatalogPortfolioInput"}, - "output":{"shape":"DisableSagemakerServicecatalogPortfolioOutput"} - }, - "DisassociateTrialComponent":{ - "name":"DisassociateTrialComponent", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DisassociateTrialComponentRequest"}, - "output":{"shape":"DisassociateTrialComponentResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "EnableSagemakerServicecatalogPortfolio":{ - "name":"EnableSagemakerServicecatalogPortfolio", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"EnableSagemakerServicecatalogPortfolioInput"}, - "output":{"shape":"EnableSagemakerServicecatalogPortfolioOutput"} - }, - "ExtendTrainingPlan":{ - "name":"ExtendTrainingPlan", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ExtendTrainingPlanRequest"}, - "output":{"shape":"ExtendTrainingPlanResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "GetDeviceFleetReport":{ - "name":"GetDeviceFleetReport", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetDeviceFleetReportRequest"}, - "output":{"shape":"GetDeviceFleetReportResponse"} - }, - "GetLineageGroupPolicy":{ - "name":"GetLineageGroupPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetLineageGroupPolicyRequest"}, - "output":{"shape":"GetLineageGroupPolicyResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "GetModelPackageGroupPolicy":{ - "name":"GetModelPackageGroupPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetModelPackageGroupPolicyInput"}, - "output":{"shape":"GetModelPackageGroupPolicyOutput"} - }, - "GetSagemakerServicecatalogPortfolioStatus":{ - "name":"GetSagemakerServicecatalogPortfolioStatus", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetSagemakerServicecatalogPortfolioStatusInput"}, - "output":{"shape":"GetSagemakerServicecatalogPortfolioStatusOutput"} - }, - "GetScalingConfigurationRecommendation":{ - "name":"GetScalingConfigurationRecommendation", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetScalingConfigurationRecommendationRequest"}, - "output":{"shape":"GetScalingConfigurationRecommendationResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "GetSearchSuggestions":{ - "name":"GetSearchSuggestions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetSearchSuggestionsRequest"}, - "output":{"shape":"GetSearchSuggestionsResponse"} - }, - "ImportHubContent":{ - "name":"ImportHubContent", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ImportHubContentRequest"}, - "output":{"shape":"ImportHubContentResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "ListAIBenchmarkJobs":{ - "name":"ListAIBenchmarkJobs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListAIBenchmarkJobsRequest"}, - "output":{"shape":"ListAIBenchmarkJobsResponse"} - }, - "ListAIRecommendationJobs":{ - "name":"ListAIRecommendationJobs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListAIRecommendationJobsRequest"}, - "output":{"shape":"ListAIRecommendationJobsResponse"} - }, - "ListAIWorkloadConfigs":{ - "name":"ListAIWorkloadConfigs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListAIWorkloadConfigsRequest"}, - "output":{"shape":"ListAIWorkloadConfigsResponse"} - }, - "ListActions":{ - "name":"ListActions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListActionsRequest"}, - "output":{"shape":"ListActionsResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "ListAlgorithms":{ - "name":"ListAlgorithms", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListAlgorithmsInput"}, - "output":{"shape":"ListAlgorithmsOutput"} - }, - "ListAliases":{ - "name":"ListAliases", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListAliasesRequest"}, - "output":{"shape":"ListAliasesResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "ListAppImageConfigs":{ - "name":"ListAppImageConfigs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListAppImageConfigsRequest"}, - "output":{"shape":"ListAppImageConfigsResponse"} - }, - "ListApps":{ - "name":"ListApps", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListAppsRequest"}, - "output":{"shape":"ListAppsResponse"} - }, - "ListArtifacts":{ - "name":"ListArtifacts", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListArtifactsRequest"}, - "output":{"shape":"ListArtifactsResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "ListAssociations":{ - "name":"ListAssociations", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListAssociationsRequest"}, - "output":{"shape":"ListAssociationsResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "ListAutoMLJobs":{ - "name":"ListAutoMLJobs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListAutoMLJobsRequest"}, - "output":{"shape":"ListAutoMLJobsResponse"} - }, - "ListCandidatesForAutoMLJob":{ - "name":"ListCandidatesForAutoMLJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListCandidatesForAutoMLJobRequest"}, - "output":{"shape":"ListCandidatesForAutoMLJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "ListClusterEvents":{ - "name":"ListClusterEvents", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListClusterEventsRequest"}, - "output":{"shape":"ListClusterEventsResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "ListClusterNodes":{ - "name":"ListClusterNodes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListClusterNodesRequest"}, - "output":{"shape":"ListClusterNodesResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "ListClusterSchedulerConfigs":{ - "name":"ListClusterSchedulerConfigs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListClusterSchedulerConfigsRequest"}, - "output":{"shape":"ListClusterSchedulerConfigsResponse"} - }, - "ListClusters":{ - "name":"ListClusters", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListClustersRequest"}, - "output":{"shape":"ListClustersResponse"} - }, - "ListCodeRepositories":{ - "name":"ListCodeRepositories", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListCodeRepositoriesInput"}, - "output":{"shape":"ListCodeRepositoriesOutput"} - }, - "ListCompilationJobs":{ - "name":"ListCompilationJobs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListCompilationJobsRequest"}, - "output":{"shape":"ListCompilationJobsResponse"} - }, - "ListComputeQuotas":{ - "name":"ListComputeQuotas", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListComputeQuotasRequest"}, - "output":{"shape":"ListComputeQuotasResponse"} - }, - "ListContexts":{ - "name":"ListContexts", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListContextsRequest"}, - "output":{"shape":"ListContextsResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "ListDataQualityJobDefinitions":{ - "name":"ListDataQualityJobDefinitions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListDataQualityJobDefinitionsRequest"}, - "output":{"shape":"ListDataQualityJobDefinitionsResponse"} - }, - "ListDeviceFleets":{ - "name":"ListDeviceFleets", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListDeviceFleetsRequest"}, - "output":{"shape":"ListDeviceFleetsResponse"} - }, - "ListDevices":{ - "name":"ListDevices", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListDevicesRequest"}, - "output":{"shape":"ListDevicesResponse"} - }, - "ListDomains":{ - "name":"ListDomains", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListDomainsRequest"}, - "output":{"shape":"ListDomainsResponse"} - }, - "ListEdgeDeploymentPlans":{ - "name":"ListEdgeDeploymentPlans", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListEdgeDeploymentPlansRequest"}, - "output":{"shape":"ListEdgeDeploymentPlansResponse"} - }, - "ListEdgePackagingJobs":{ - "name":"ListEdgePackagingJobs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListEdgePackagingJobsRequest"}, - "output":{"shape":"ListEdgePackagingJobsResponse"} - }, - "ListEndpointConfigs":{ - "name":"ListEndpointConfigs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListEndpointConfigsInput"}, - "output":{"shape":"ListEndpointConfigsOutput"} - }, - "ListEndpoints":{ - "name":"ListEndpoints", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListEndpointsInput"}, - "output":{"shape":"ListEndpointsOutput"} - }, - "ListExperiments":{ - "name":"ListExperiments", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListExperimentsRequest"}, - "output":{"shape":"ListExperimentsResponse"} - }, - "ListFeatureGroups":{ - "name":"ListFeatureGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListFeatureGroupsRequest"}, - "output":{"shape":"ListFeatureGroupsResponse"} - }, - "ListFlowDefinitions":{ - "name":"ListFlowDefinitions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListFlowDefinitionsRequest"}, - "output":{"shape":"ListFlowDefinitionsResponse"} - }, - "ListHubContentVersions":{ - "name":"ListHubContentVersions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListHubContentVersionsRequest"}, - "output":{"shape":"ListHubContentVersionsResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "ListHubContents":{ - "name":"ListHubContents", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListHubContentsRequest"}, - "output":{"shape":"ListHubContentsResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "ListHubs":{ - "name":"ListHubs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListHubsRequest"}, - "output":{"shape":"ListHubsResponse"} - }, - "ListHumanTaskUis":{ - "name":"ListHumanTaskUis", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListHumanTaskUisRequest"}, - "output":{"shape":"ListHumanTaskUisResponse"} - }, - "ListHyperParameterTuningJobs":{ - "name":"ListHyperParameterTuningJobs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListHyperParameterTuningJobsRequest"}, - "output":{"shape":"ListHyperParameterTuningJobsResponse"} - }, - "ListImageVersions":{ - "name":"ListImageVersions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListImageVersionsRequest"}, - "output":{"shape":"ListImageVersionsResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "ListImages":{ - "name":"ListImages", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListImagesRequest"}, - "output":{"shape":"ListImagesResponse"} - }, - "ListInferenceComponents":{ - "name":"ListInferenceComponents", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListInferenceComponentsInput"}, - "output":{"shape":"ListInferenceComponentsOutput"} - }, - "ListInferenceExperiments":{ - "name":"ListInferenceExperiments", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListInferenceExperimentsRequest"}, - "output":{"shape":"ListInferenceExperimentsResponse"} - }, - "ListInferenceRecommendationsJobSteps":{ - "name":"ListInferenceRecommendationsJobSteps", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListInferenceRecommendationsJobStepsRequest"}, - "output":{"shape":"ListInferenceRecommendationsJobStepsResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "ListInferenceRecommendationsJobs":{ - "name":"ListInferenceRecommendationsJobs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListInferenceRecommendationsJobsRequest"}, - "output":{"shape":"ListInferenceRecommendationsJobsResponse"} - }, - "ListJobSchemaVersions":{ - "name":"ListJobSchemaVersions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListJobSchemaVersionsRequest"}, - "output":{"shape":"ListJobSchemaVersionsResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "readonly":true - }, - "ListJobs":{ - "name":"ListJobs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListJobsRequest"}, - "output":{"shape":"ListJobsResponse"}, - "readonly":true - }, - "ListLabelingJobs":{ - "name":"ListLabelingJobs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListLabelingJobsRequest"}, - "output":{"shape":"ListLabelingJobsResponse"} - }, - "ListLabelingJobsForWorkteam":{ - "name":"ListLabelingJobsForWorkteam", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListLabelingJobsForWorkteamRequest"}, - "output":{"shape":"ListLabelingJobsForWorkteamResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "ListLineageGroups":{ - "name":"ListLineageGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListLineageGroupsRequest"}, - "output":{"shape":"ListLineageGroupsResponse"} - }, - "ListMlflowApps":{ - "name":"ListMlflowApps", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListMlflowAppsRequest"}, - "output":{"shape":"ListMlflowAppsResponse"} - }, - "ListMlflowTrackingServers":{ - "name":"ListMlflowTrackingServers", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListMlflowTrackingServersRequest"}, - "output":{"shape":"ListMlflowTrackingServersResponse"} - }, - "ListModelBiasJobDefinitions":{ - "name":"ListModelBiasJobDefinitions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListModelBiasJobDefinitionsRequest"}, - "output":{"shape":"ListModelBiasJobDefinitionsResponse"} - }, - "ListModelCardExportJobs":{ - "name":"ListModelCardExportJobs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListModelCardExportJobsRequest"}, - "output":{"shape":"ListModelCardExportJobsResponse"} - }, - "ListModelCardVersions":{ - "name":"ListModelCardVersions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListModelCardVersionsRequest"}, - "output":{"shape":"ListModelCardVersionsResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "ListModelCards":{ - "name":"ListModelCards", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListModelCardsRequest"}, - "output":{"shape":"ListModelCardsResponse"} - }, - "ListModelExplainabilityJobDefinitions":{ - "name":"ListModelExplainabilityJobDefinitions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListModelExplainabilityJobDefinitionsRequest"}, - "output":{"shape":"ListModelExplainabilityJobDefinitionsResponse"} - }, - "ListModelMetadata":{ - "name":"ListModelMetadata", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListModelMetadataRequest"}, - "output":{"shape":"ListModelMetadataResponse"} - }, - "ListModelPackageGroups":{ - "name":"ListModelPackageGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListModelPackageGroupsInput"}, - "output":{"shape":"ListModelPackageGroupsOutput"} - }, - "ListModelPackages":{ - "name":"ListModelPackages", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListModelPackagesInput"}, - "output":{"shape":"ListModelPackagesOutput"} - }, - "ListModelQualityJobDefinitions":{ - "name":"ListModelQualityJobDefinitions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListModelQualityJobDefinitionsRequest"}, - "output":{"shape":"ListModelQualityJobDefinitionsResponse"} - }, - "ListModels":{ - "name":"ListModels", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListModelsInput"}, - "output":{"shape":"ListModelsOutput"} - }, - "ListMonitoringAlertHistory":{ - "name":"ListMonitoringAlertHistory", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListMonitoringAlertHistoryRequest"}, - "output":{"shape":"ListMonitoringAlertHistoryResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "ListMonitoringAlerts":{ - "name":"ListMonitoringAlerts", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListMonitoringAlertsRequest"}, - "output":{"shape":"ListMonitoringAlertsResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "ListMonitoringExecutions":{ - "name":"ListMonitoringExecutions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListMonitoringExecutionsRequest"}, - "output":{"shape":"ListMonitoringExecutionsResponse"} - }, - "ListMonitoringSchedules":{ - "name":"ListMonitoringSchedules", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListMonitoringSchedulesRequest"}, - "output":{"shape":"ListMonitoringSchedulesResponse"} - }, - "ListNotebookInstanceLifecycleConfigs":{ - "name":"ListNotebookInstanceLifecycleConfigs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListNotebookInstanceLifecycleConfigsInput"}, - "output":{"shape":"ListNotebookInstanceLifecycleConfigsOutput"} - }, - "ListNotebookInstances":{ - "name":"ListNotebookInstances", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListNotebookInstancesInput"}, - "output":{"shape":"ListNotebookInstancesOutput"} - }, - "ListOptimizationJobs":{ - "name":"ListOptimizationJobs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListOptimizationJobsRequest"}, - "output":{"shape":"ListOptimizationJobsResponse"} - }, - "ListPartnerApps":{ - "name":"ListPartnerApps", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListPartnerAppsRequest"}, - "output":{"shape":"ListPartnerAppsResponse"} - }, - "ListPipelineExecutionSteps":{ - "name":"ListPipelineExecutionSteps", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListPipelineExecutionStepsRequest"}, - "output":{"shape":"ListPipelineExecutionStepsResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "ListPipelineExecutions":{ - "name":"ListPipelineExecutions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListPipelineExecutionsRequest"}, - "output":{"shape":"ListPipelineExecutionsResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "ListPipelineParametersForExecution":{ - "name":"ListPipelineParametersForExecution", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListPipelineParametersForExecutionRequest"}, - "output":{"shape":"ListPipelineParametersForExecutionResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "ListPipelineVersions":{ - "name":"ListPipelineVersions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListPipelineVersionsRequest"}, - "output":{"shape":"ListPipelineVersionsResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "ListPipelines":{ - "name":"ListPipelines", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListPipelinesRequest"}, - "output":{"shape":"ListPipelinesResponse"} - }, - "ListProcessingJobs":{ - "name":"ListProcessingJobs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListProcessingJobsRequest"}, - "output":{"shape":"ListProcessingJobsResponse"} - }, - "ListProjects":{ - "name":"ListProjects", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListProjectsInput"}, - "output":{"shape":"ListProjectsOutput"} - }, - "ListResourceCatalogs":{ - "name":"ListResourceCatalogs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListResourceCatalogsRequest"}, - "output":{"shape":"ListResourceCatalogsResponse"} - }, - "ListSpaces":{ - "name":"ListSpaces", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListSpacesRequest"}, - "output":{"shape":"ListSpacesResponse"} - }, - "ListStageDevices":{ - "name":"ListStageDevices", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListStageDevicesRequest"}, - "output":{"shape":"ListStageDevicesResponse"} - }, - "ListStudioLifecycleConfigs":{ - "name":"ListStudioLifecycleConfigs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListStudioLifecycleConfigsRequest"}, - "output":{"shape":"ListStudioLifecycleConfigsResponse"}, - "errors":[ - {"shape":"ResourceInUse"} - ] - }, - "ListSubscribedWorkteams":{ - "name":"ListSubscribedWorkteams", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListSubscribedWorkteamsRequest"}, - "output":{"shape":"ListSubscribedWorkteamsResponse"} - }, - "ListTags":{ - "name":"ListTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListTagsInput"}, - "output":{"shape":"ListTagsOutput"} - }, - "ListTrainingJobs":{ - "name":"ListTrainingJobs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListTrainingJobsRequest"}, - "output":{"shape":"ListTrainingJobsResponse"} - }, - "ListTrainingJobsForHyperParameterTuningJob":{ - "name":"ListTrainingJobsForHyperParameterTuningJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListTrainingJobsForHyperParameterTuningJobRequest"}, - "output":{"shape":"ListTrainingJobsForHyperParameterTuningJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "ListTrainingPlans":{ - "name":"ListTrainingPlans", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListTrainingPlansRequest"}, - "output":{"shape":"ListTrainingPlansResponse"} - }, - "ListTransformJobs":{ - "name":"ListTransformJobs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListTransformJobsRequest"}, - "output":{"shape":"ListTransformJobsResponse"} - }, - "ListTrialComponents":{ - "name":"ListTrialComponents", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListTrialComponentsRequest"}, - "output":{"shape":"ListTrialComponentsResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "ListTrials":{ - "name":"ListTrials", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListTrialsRequest"}, - "output":{"shape":"ListTrialsResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "ListUltraServersByReservedCapacity":{ - "name":"ListUltraServersByReservedCapacity", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListUltraServersByReservedCapacityRequest"}, - "output":{"shape":"ListUltraServersByReservedCapacityResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "ListUserProfiles":{ - "name":"ListUserProfiles", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListUserProfilesRequest"}, - "output":{"shape":"ListUserProfilesResponse"} - }, - "ListWorkforces":{ - "name":"ListWorkforces", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListWorkforcesRequest"}, - "output":{"shape":"ListWorkforcesResponse"} - }, - "ListWorkteams":{ - "name":"ListWorkteams", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListWorkteamsRequest"}, - "output":{"shape":"ListWorkteamsResponse"} - }, - "PutModelPackageGroupPolicy":{ - "name":"PutModelPackageGroupPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"PutModelPackageGroupPolicyInput"}, - "output":{"shape":"PutModelPackageGroupPolicyOutput"}, - "errors":[ - {"shape":"ConflictException"} - ] - }, - "QueryLineage":{ - "name":"QueryLineage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"QueryLineageRequest"}, - "output":{"shape":"QueryLineageResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "RegisterDevices":{ - "name":"RegisterDevices", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RegisterDevicesRequest"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ] - }, - "RenderUiTemplate":{ - "name":"RenderUiTemplate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RenderUiTemplateRequest"}, - "output":{"shape":"RenderUiTemplateResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "RetryPipelineExecution":{ - "name":"RetryPipelineExecution", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RetryPipelineExecutionRequest"}, - "output":{"shape":"RetryPipelineExecutionResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "Search":{ - "name":"Search", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"SearchRequest"}, - "output":{"shape":"SearchResponse"} - }, - "SearchTrainingPlanOfferings":{ - "name":"SearchTrainingPlanOfferings", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"SearchTrainingPlanOfferingsRequest"}, - "output":{"shape":"SearchTrainingPlanOfferingsResponse"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ] - }, - "SendPipelineExecutionStepFailure":{ - "name":"SendPipelineExecutionStepFailure", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"SendPipelineExecutionStepFailureRequest"}, - "output":{"shape":"SendPipelineExecutionStepFailureResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "SendPipelineExecutionStepSuccess":{ - "name":"SendPipelineExecutionStepSuccess", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"SendPipelineExecutionStepSuccessRequest"}, - "output":{"shape":"SendPipelineExecutionStepSuccessResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "StartClusterHealthCheck":{ - "name":"StartClusterHealthCheck", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StartClusterHealthCheckRequest"}, - "output":{"shape":"StartClusterHealthCheckResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "StartEdgeDeploymentStage":{ - "name":"StartEdgeDeploymentStage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StartEdgeDeploymentStageRequest"} - }, - "StartInferenceExperiment":{ - "name":"StartInferenceExperiment", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StartInferenceExperimentRequest"}, - "output":{"shape":"StartInferenceExperimentResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ] - }, - "StartMlflowTrackingServer":{ - "name":"StartMlflowTrackingServer", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StartMlflowTrackingServerRequest"}, - "output":{"shape":"StartMlflowTrackingServerResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ] - }, - "StartMonitoringSchedule":{ - "name":"StartMonitoringSchedule", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StartMonitoringScheduleRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "StartNotebookInstance":{ - "name":"StartNotebookInstance", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StartNotebookInstanceInput"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ] - }, - "StartPipelineExecution":{ - "name":"StartPipelineExecution", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StartPipelineExecutionRequest"}, - "output":{"shape":"StartPipelineExecutionResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "StartSession":{ - "name":"StartSession", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StartSessionRequest"}, - "output":{"shape":"StartSessionResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "StopAIBenchmarkJob":{ - "name":"StopAIBenchmarkJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopAIBenchmarkJobRequest"}, - "output":{"shape":"StopAIBenchmarkJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "StopAIRecommendationJob":{ - "name":"StopAIRecommendationJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopAIRecommendationJobRequest"}, - "output":{"shape":"StopAIRecommendationJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "StopAutoMLJob":{ - "name":"StopAutoMLJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopAutoMLJobRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "StopCompilationJob":{ - "name":"StopCompilationJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopCompilationJobRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "StopEdgeDeploymentStage":{ - "name":"StopEdgeDeploymentStage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopEdgeDeploymentStageRequest"} - }, - "StopEdgePackagingJob":{ - "name":"StopEdgePackagingJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopEdgePackagingJobRequest"} - }, - "StopHyperParameterTuningJob":{ - "name":"StopHyperParameterTuningJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopHyperParameterTuningJobRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "StopInferenceExperiment":{ - "name":"StopInferenceExperiment", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopInferenceExperimentRequest"}, - "output":{"shape":"StopInferenceExperimentResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ] - }, - "StopInferenceRecommendationsJob":{ - "name":"StopInferenceRecommendationsJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopInferenceRecommendationsJobRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "StopJob":{ - "name":"StopJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopJobRequest"}, - "output":{"shape":"StopJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "StopLabelingJob":{ - "name":"StopLabelingJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopLabelingJobRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "StopMlflowTrackingServer":{ - "name":"StopMlflowTrackingServer", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopMlflowTrackingServerRequest"}, - "output":{"shape":"StopMlflowTrackingServerResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ] - }, - "StopMonitoringSchedule":{ - "name":"StopMonitoringSchedule", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopMonitoringScheduleRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "StopNotebookInstance":{ - "name":"StopNotebookInstance", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopNotebookInstanceInput"} - }, - "StopOptimizationJob":{ - "name":"StopOptimizationJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopOptimizationJobRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "StopPipelineExecution":{ - "name":"StopPipelineExecution", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopPipelineExecutionRequest"}, - "output":{"shape":"StopPipelineExecutionResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ] - }, - "StopProcessingJob":{ - "name":"StopProcessingJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopProcessingJobRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "StopTrainingJob":{ - "name":"StopTrainingJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopTrainingJobRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "StopTransformJob":{ - "name":"StopTransformJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopTransformJobRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "UpdateAction":{ - "name":"UpdateAction", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateActionRequest"}, - "output":{"shape":"UpdateActionResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ] - }, - "UpdateAppImageConfig":{ - "name":"UpdateAppImageConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateAppImageConfigRequest"}, - "output":{"shape":"UpdateAppImageConfigResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "UpdateArtifact":{ - "name":"UpdateArtifact", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateArtifactRequest"}, - "output":{"shape":"UpdateArtifactResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ] - }, - "UpdateCluster":{ - "name":"UpdateCluster", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateClusterRequest"}, - "output":{"shape":"UpdateClusterResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "UpdateClusterSchedulerConfig":{ - "name":"UpdateClusterSchedulerConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateClusterSchedulerConfigRequest"}, - "output":{"shape":"UpdateClusterSchedulerConfigResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "UpdateClusterSoftware":{ - "name":"UpdateClusterSoftware", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateClusterSoftwareRequest"}, - "output":{"shape":"UpdateClusterSoftwareResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ] - }, - "UpdateCodeRepository":{ - "name":"UpdateCodeRepository", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateCodeRepositoryInput"}, - "output":{"shape":"UpdateCodeRepositoryOutput"}, - "errors":[ - {"shape":"ConflictException"} - ] - }, - "UpdateComputeQuota":{ - "name":"UpdateComputeQuota", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateComputeQuotaRequest"}, - "output":{"shape":"UpdateComputeQuotaResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "UpdateContext":{ - "name":"UpdateContext", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateContextRequest"}, - "output":{"shape":"UpdateContextResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ] - }, - "UpdateDeviceFleet":{ - "name":"UpdateDeviceFleet", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateDeviceFleetRequest"}, - "errors":[ - {"shape":"ResourceInUse"} - ] - }, - "UpdateDevices":{ - "name":"UpdateDevices", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateDevicesRequest"} - }, - "UpdateDomain":{ - "name":"UpdateDomain", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateDomainRequest"}, - "output":{"shape":"UpdateDomainResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "UpdateEndpoint":{ - "name":"UpdateEndpoint", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateEndpointInput"}, - "output":{"shape":"UpdateEndpointOutput"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ] - }, - "UpdateEndpointWeightsAndCapacities":{ - "name":"UpdateEndpointWeightsAndCapacities", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateEndpointWeightsAndCapacitiesInput"}, - "output":{"shape":"UpdateEndpointWeightsAndCapacitiesOutput"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ] - }, - "UpdateExperiment":{ - "name":"UpdateExperiment", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateExperimentRequest"}, - "output":{"shape":"UpdateExperimentResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ] - }, - "UpdateFeatureGroup":{ - "name":"UpdateFeatureGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateFeatureGroupRequest"}, - "output":{"shape":"UpdateFeatureGroupResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "UpdateFeatureMetadata":{ - "name":"UpdateFeatureMetadata", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateFeatureMetadataRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "UpdateHub":{ - "name":"UpdateHub", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateHubRequest"}, - "output":{"shape":"UpdateHubResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ] - }, - "UpdateHubContent":{ - "name":"UpdateHubContent", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateHubContentRequest"}, - "output":{"shape":"UpdateHubContentResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"} - ] - }, - "UpdateHubContentReference":{ - "name":"UpdateHubContentReference", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateHubContentReferenceRequest"}, - "output":{"shape":"UpdateHubContentReferenceResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"} - ] - }, - "UpdateImage":{ - "name":"UpdateImage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateImageRequest"}, - "output":{"shape":"UpdateImageResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"} - ] - }, - "UpdateImageVersion":{ - "name":"UpdateImageVersion", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateImageVersionRequest"}, - "output":{"shape":"UpdateImageVersionResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"} - ] - }, - "UpdateInferenceComponent":{ - "name":"UpdateInferenceComponent", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateInferenceComponentInput"}, - "output":{"shape":"UpdateInferenceComponentOutput"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ] - }, - "UpdateInferenceComponentRuntimeConfig":{ - "name":"UpdateInferenceComponentRuntimeConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateInferenceComponentRuntimeConfigInput"}, - "output":{"shape":"UpdateInferenceComponentRuntimeConfigOutput"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ] - }, - "UpdateInferenceExperiment":{ - "name":"UpdateInferenceExperiment", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateInferenceExperimentRequest"}, - "output":{"shape":"UpdateInferenceExperimentResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ] - }, - "UpdateMlflowApp":{ - "name":"UpdateMlflowApp", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateMlflowAppRequest"}, - "output":{"shape":"UpdateMlflowAppResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ] - }, - "UpdateMlflowTrackingServer":{ - "name":"UpdateMlflowTrackingServer", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateMlflowTrackingServerRequest"}, - "output":{"shape":"UpdateMlflowTrackingServerResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "UpdateModelCard":{ - "name":"UpdateModelCard", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateModelCardRequest"}, - "output":{"shape":"UpdateModelCardResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "UpdateModelPackage":{ - "name":"UpdateModelPackage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateModelPackageInput"}, - "output":{"shape":"UpdateModelPackageOutput"}, - "errors":[ - {"shape":"ConflictException"} - ] - }, - "UpdateMonitoringAlert":{ - "name":"UpdateMonitoringAlert", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateMonitoringAlertRequest"}, - "output":{"shape":"UpdateMonitoringAlertResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "UpdateMonitoringSchedule":{ - "name":"UpdateMonitoringSchedule", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateMonitoringScheduleRequest"}, - "output":{"shape":"UpdateMonitoringScheduleResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "UpdateNotebookInstance":{ - "name":"UpdateNotebookInstance", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateNotebookInstanceInput"}, - "output":{"shape":"UpdateNotebookInstanceOutput"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ] - }, - "UpdateNotebookInstanceLifecycleConfig":{ - "name":"UpdateNotebookInstanceLifecycleConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateNotebookInstanceLifecycleConfigInput"}, - "output":{"shape":"UpdateNotebookInstanceLifecycleConfigOutput"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ] - }, - "UpdatePartnerApp":{ - "name":"UpdatePartnerApp", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdatePartnerAppRequest"}, - "output":{"shape":"UpdatePartnerAppResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ] - }, - "UpdatePipeline":{ - "name":"UpdatePipeline", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdatePipelineRequest"}, - "output":{"shape":"UpdatePipelineResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ] - }, - "UpdatePipelineExecution":{ - "name":"UpdatePipelineExecution", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdatePipelineExecutionRequest"}, - "output":{"shape":"UpdatePipelineExecutionResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ] - }, - "UpdatePipelineVersion":{ - "name":"UpdatePipelineVersion", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdatePipelineVersionRequest"}, - "output":{"shape":"UpdatePipelineVersionResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ] - }, - "UpdateProject":{ - "name":"UpdateProject", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateProjectInput"}, - "output":{"shape":"UpdateProjectOutput"}, - "errors":[ - {"shape":"ConflictException"} - ] - }, - "UpdateSpace":{ - "name":"UpdateSpace", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateSpaceRequest"}, - "output":{"shape":"UpdateSpaceResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "UpdateTrainingJob":{ - "name":"UpdateTrainingJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateTrainingJobRequest"}, - "output":{"shape":"UpdateTrainingJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "UpdateTrial":{ - "name":"UpdateTrial", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateTrialRequest"}, - "output":{"shape":"UpdateTrialResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ] - }, - "UpdateTrialComponent":{ - "name":"UpdateTrialComponent", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateTrialComponentRequest"}, - "output":{"shape":"UpdateTrialComponentResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ] - }, - "UpdateUserProfile":{ - "name":"UpdateUserProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateUserProfileRequest"}, - "output":{"shape":"UpdateUserProfileResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ] - }, - "UpdateWorkforce":{ - "name":"UpdateWorkforce", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateWorkforceRequest"}, - "output":{"shape":"UpdateWorkforceResponse"}, - "errors":[ - {"shape":"ConflictException"} - ] - }, - "UpdateWorkteam":{ - "name":"UpdateWorkteam", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateWorkteamRequest"}, - "output":{"shape":"UpdateWorkteamResponse"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ] - } - }, - "shapes":{ - "AIAdapterId":{ - "type":"string", - "max":63, - "min":1, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9])*" - }, - "AIAdapterModelPackageEntry":{ - "type":"structure", - "required":[ - "AdapterId", - "ModelPackageArn" - ], - "members":{ - "AdapterId":{"shape":"AIAdapterId"}, - "ModelPackageArn":{"shape":"ModelPackageArn"} - } - }, - "AIAdapterModelPackageEntryList":{ - "type":"list", - "member":{"shape":"AIAdapterModelPackageEntry"}, - "max":10, - "min":1 - }, - "AIAdapterS3Entry":{ - "type":"structure", - "required":[ - "AdapterId", - "S3Uri" - ], - "members":{ - "AdapterId":{"shape":"AIAdapterId"}, - "S3Uri":{"shape":"S3Uri"} - } - }, - "AIAdapterS3EntryList":{ - "type":"list", - "member":{"shape":"AIAdapterS3Entry"}, - "max":10, - "min":1 - }, - "AIAdapterSource":{ - "type":"structure", - "members":{ - "ModelPackageArns":{"shape":"AIAdapterModelPackageEntryList"}, - "S3Uris":{"shape":"AIAdapterS3EntryList"} - }, - "union":true - }, - "AIBenchmarkEndpoint":{ - "type":"structure", - "required":["Identifier"], - "members":{ - "Identifier":{"shape":"AIResourceIdentifier"}, - "TargetContainerHostname":{"shape":"String"}, - "InferenceComponents":{"shape":"AIBenchmarkInferenceComponentList"} - } - }, - "AIBenchmarkInferenceComponent":{ - "type":"structure", - "required":["Identifier"], - "members":{ - "Identifier":{"shape":"AIResourceIdentifier"} - } - }, - "AIBenchmarkInferenceComponentList":{ - "type":"list", - "member":{"shape":"AIBenchmarkInferenceComponent"} - }, - "AIBenchmarkJobArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:ai-benchmark-job/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" - }, - "AIBenchmarkJobStatus":{ - "type":"string", - "enum":[ - "InProgress", - "Completed", - "Failed", - "Stopping", - "Stopped" - ] - }, - "AIBenchmarkJobSummary":{ - "type":"structure", - "required":[ - "AIBenchmarkJobName", - "AIBenchmarkJobArn", - "AIBenchmarkJobStatus", - "CreationTime" - ], - "members":{ - "AIBenchmarkJobName":{"shape":"AIEntityName"}, - "AIBenchmarkJobArn":{"shape":"AIBenchmarkJobArn"}, - "AIBenchmarkJobStatus":{"shape":"AIBenchmarkJobStatus"}, - "CreationTime":{"shape":"Timestamp"}, - "EndTime":{"shape":"Timestamp"}, - "AIWorkloadConfigName":{"shape":"AIEntityName"} - } - }, - "AIBenchmarkJobSummaryList":{ - "type":"list", - "member":{"shape":"AIBenchmarkJobSummary"} - }, - "AIBenchmarkNetworkConfig":{ - "type":"structure", - "members":{ - "VpcConfig":{"shape":"VpcConfig"} - } - }, - "AIBenchmarkOutputConfig":{ - "type":"structure", - "required":["S3OutputLocation"], - "members":{ - "S3OutputLocation":{"shape":"S3Uri"}, - "MlflowConfig":{"shape":"AIMlflowConfig"} - } - }, - "AIBenchmarkOutputResult":{ - "type":"structure", - "required":["S3OutputLocation"], - "members":{ - "S3OutputLocation":{"shape":"S3Uri"}, - "CloudWatchLogs":{"shape":"AICloudWatchLogsList"}, - "MlflowConfig":{"shape":"AIMlflowConfig"} - } - }, - "AIBenchmarkTarget":{ - "type":"structure", - "members":{ - "Endpoint":{"shape":"AIBenchmarkEndpoint"} - }, - "union":true - }, - "AICapacityReservationConfig":{ - "type":"structure", - "members":{ - "CapacityReservationPreference":{"shape":"AICapacityReservationPreference"}, - "MlReservationArns":{"shape":"AIMlReservationArnList"} - } - }, - "AICapacityReservationPreference":{ - "type":"string", - "enum":["capacity-reservations-only"] - }, - "AIChannelName":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[A-Za-z0-9\\.\\-_]+" - }, - "AICloudWatchLogs":{ - "type":"structure", - "members":{ - "LogGroupArn":{"shape":"String"}, - "LogStreamName":{"shape":"String"} - } - }, - "AICloudWatchLogsList":{ - "type":"list", - "member":{"shape":"AICloudWatchLogs"} - }, - "AIDatasetConfig":{ - "type":"structure", - "members":{ - "InputDataConfig":{"shape":"AIWorkloadInputDataConfigList"} - }, - "union":true - }, - "AIEntityName":{ - "type":"string", - "max":63, - "min":1, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" - }, - "AIInferenceSpecificationName":{ - "type":"string", - "max":63, - "min":0, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" - }, - "AIMlReservationArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:[a-z0-9\\-]{1,14}/.*" - }, - "AIMlReservationArnList":{ - "type":"list", - "member":{"shape":"AIMlReservationArn"} - }, - "AIMlflowConfig":{ - "type":"structure", - "required":["MlflowResourceArn"], - "members":{ - "MlflowResourceArn":{"shape":"AIMlflowResourceArn"}, - "MlflowExperimentName":{"shape":"AIMlflowExperimentName"}, - "MlflowRunName":{"shape":"AIMlflowRunName"} - } - }, - "AIMlflowExperimentName":{ - "type":"string", - "max":256, - "min":1, - "pattern":"[a-zA-Z0-9\\-_./]+" - }, - "AIMlflowResourceArn":{ - "type":"string", - "max":2048, - "min":20, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:mlflow-(app|tracking-server)/.*" - }, - "AIMlflowRunName":{ - "type":"string", - "max":256, - "min":1, - "pattern":"[a-zA-Z0-9\\-_./]+" - }, - "AIModelSource":{ - "type":"structure", - "members":{ - "S3":{"shape":"AIModelSourceS3"} - }, - "union":true - }, - "AIModelSourceS3":{ - "type":"structure", - "members":{ - "S3Uri":{"shape":"S3Uri"} - } - }, - "AIRecommendation":{ - "type":"structure", - "members":{ - "RecommendationDescription":{"shape":"String"}, - "OptimizationDetails":{"shape":"AIRecommendationOptimizationDetailList"}, - "ModelDetails":{"shape":"AIRecommendationModelDetails"}, - "DeploymentConfiguration":{"shape":"AIRecommendationDeploymentConfiguration"}, - "AIBenchmarkJobArn":{"shape":"AIBenchmarkJobArn"}, - "ExpectedPerformance":{"shape":"ExpectedPerformanceList"}, - "AdapterDetails":{"shape":"AIRecommendationAdapterDetails"} - } - }, - "AIRecommendationAdapterDetails":{ - "type":"structure", - "required":[ - "ModelPackageArns", - "S3Uris" - ], - "members":{ - "ModelPackageArns":{"shape":"AIAdapterModelPackageEntryList"}, - "S3Uris":{"shape":"AIAdapterS3EntryList"} - } - }, - "AIRecommendationAllowOptimization":{ - "type":"boolean", - "box":true - }, - "AIRecommendationComputeSpec":{ - "type":"structure", - "members":{ - "InstanceTypes":{"shape":"AIRecommendationInstanceTypeList"}, - "CapacityReservationConfig":{"shape":"AICapacityReservationConfig"} - } - }, - "AIRecommendationConstraint":{ - "type":"structure", - "required":["Metric"], - "members":{ - "Metric":{"shape":"AIRecommendationMetric"} - } - }, - "AIRecommendationConstraintList":{ - "type":"list", - "member":{"shape":"AIRecommendationConstraint"} - }, - "AIRecommendationCopyCountPerInstance":{ - "type":"integer", - "box":true - }, - "AIRecommendationDeploymentConfiguration":{ - "type":"structure", - "members":{ - "S3":{"shape":"AIRecommendationDeploymentS3ChannelList"}, - "ImageUri":{"shape":"String"}, - "InstanceType":{"shape":"AIRecommendationInstanceType"}, - "InstanceCount":{"shape":"AIRecommendationInstanceCount"}, - "CopyCountPerInstance":{"shape":"AIRecommendationCopyCountPerInstance"}, - "EnvironmentVariables":{"shape":"EnvironmentMap"}, - "MinCpuMemoryRequiredInMb":{"shape":"AIRecommendationMinCpuMemoryRequiredInMb"} - } - }, - "AIRecommendationDeploymentS3Channel":{ - "type":"structure", - "members":{ - "ChannelName":{"shape":"AIChannelName"}, - "Uri":{"shape":"S3Uri"} - } - }, - "AIRecommendationDeploymentS3ChannelList":{ - "type":"list", - "member":{"shape":"AIRecommendationDeploymentS3Channel"} - }, - "AIRecommendationInferenceFramework":{ - "type":"string", - "enum":[ - "LMI", - "VLLM" - ] - }, - "AIRecommendationInferenceSpecification":{ - "type":"structure", - "members":{ - "Framework":{"shape":"AIRecommendationInferenceFramework"} - } - }, - "AIRecommendationInstanceCount":{ - "type":"integer", - "box":true - }, - "AIRecommendationInstanceDetail":{ - "type":"structure", - "members":{ - "InstanceType":{"shape":"AIRecommendationInstanceType"}, - "InstanceCount":{"shape":"AIRecommendationInstanceCount"}, - "CopyCountPerInstance":{"shape":"AIRecommendationCopyCountPerInstance"} - } - }, - "AIRecommendationInstanceDetailList":{ - "type":"list", - "member":{"shape":"AIRecommendationInstanceDetail"} - }, - "AIRecommendationInstanceType":{ - "type":"string", - "enum":[ - "ml.g5.xlarge", - "ml.g5.2xlarge", - "ml.g5.4xlarge", - "ml.g5.8xlarge", - "ml.g5.12xlarge", - "ml.g5.16xlarge", - "ml.g5.24xlarge", - "ml.g5.48xlarge", - "ml.g6.xlarge", - "ml.g6.2xlarge", - "ml.g6.4xlarge", - "ml.g6.8xlarge", - "ml.g6.12xlarge", - "ml.g6.16xlarge", - "ml.g6.24xlarge", - "ml.g6.48xlarge", - "ml.g6e.xlarge", - "ml.g6e.2xlarge", - "ml.g6e.4xlarge", - "ml.g6e.8xlarge", - "ml.g6e.12xlarge", - "ml.g6e.16xlarge", - "ml.g6e.24xlarge", - "ml.g6e.48xlarge", - "ml.g7e.2xlarge", - "ml.g7e.4xlarge", - "ml.g7e.8xlarge", - "ml.g7e.12xlarge", - "ml.g7e.24xlarge", - "ml.g7e.48xlarge", - "ml.p3.2xlarge", - "ml.p3.8xlarge", - "ml.p3.16xlarge", - "ml.p4d.24xlarge", - "ml.p4de.24xlarge", - "ml.p5.4xlarge", - "ml.p5.48xlarge", - "ml.p5e.48xlarge", - "ml.p5en.48xlarge", - "ml.p6-b200.48xlarge" - ] - }, - "AIRecommendationInstanceTypeList":{ - "type":"list", - "member":{"shape":"AIRecommendationInstanceType"}, - "max":3, - "min":0 - }, - "AIRecommendationJobArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:ai-recommendation-job/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" - }, - "AIRecommendationJobStatus":{ - "type":"string", - "enum":[ - "InProgress", - "Completed", - "Failed", - "Stopping", - "Stopped" - ] - }, - "AIRecommendationJobSummary":{ - "type":"structure", - "required":[ - "AIRecommendationJobName", - "AIRecommendationJobArn", - "AIRecommendationJobStatus", - "CreationTime" - ], - "members":{ - "AIRecommendationJobName":{"shape":"AIEntityName"}, - "AIRecommendationJobArn":{"shape":"AIRecommendationJobArn"}, - "AIRecommendationJobStatus":{"shape":"AIRecommendationJobStatus"}, - "CreationTime":{"shape":"Timestamp"}, - "EndTime":{"shape":"Timestamp"} - } - }, - "AIRecommendationJobSummaryList":{ - "type":"list", - "member":{"shape":"AIRecommendationJobSummary"} - }, - "AIRecommendationList":{ - "type":"list", - "member":{"shape":"AIRecommendation"} - }, - "AIRecommendationMetric":{ - "type":"string", - "enum":[ - "ttft-ms", - "throughput", - "cost" - ] - }, - "AIRecommendationMinCpuMemoryRequiredInMb":{ - "type":"integer", - "box":true, - "min":1 - }, - "AIRecommendationModelDetails":{ - "type":"structure", - "members":{ - "ModelPackageArn":{"shape":"ModelPackageArn"}, - "InferenceSpecificationName":{"shape":"AIInferenceSpecificationName"}, - "InstanceDetails":{"shape":"AIRecommendationInstanceDetailList"} - } - }, - "AIRecommendationOptimizationConfigMap":{ - "type":"map", - "key":{"shape":"String"}, - "value":{"shape":"String"} - }, - "AIRecommendationOptimizationDetail":{ - "type":"structure", - "required":["OptimizationType"], - "members":{ - "OptimizationType":{"shape":"AIRecommendationOptimizationType"}, - "OptimizationConfig":{"shape":"AIRecommendationOptimizationConfigMap"} - } - }, - "AIRecommendationOptimizationDetailList":{ - "type":"list", - "member":{"shape":"AIRecommendationOptimizationDetail"} - }, - "AIRecommendationOptimizationType":{ - "type":"string", - "enum":[ - "SpeculativeDecoding", - "KernelTuning" - ] - }, - "AIRecommendationOutputConfig":{ - "type":"structure", - "members":{ - "S3OutputLocation":{"shape":"S3Uri"}, - "ModelPackageGroupIdentifier":{"shape":"AIResourceIdentifier"}, - "MlflowConfig":{"shape":"AIMlflowConfig"} - } - }, - "AIRecommendationOutputResult":{ - "type":"structure", - "required":["S3OutputLocation"], - "members":{ - "S3OutputLocation":{"shape":"S3Uri"}, - "ModelPackageGroupIdentifier":{"shape":"AIResourceIdentifier"}, - "MlflowConfig":{"shape":"AIMlflowConfig"} - } - }, - "AIRecommendationPerformanceMetric":{ - "type":"structure", - "required":[ - "Metric", - "Value" - ], - "members":{ - "Metric":{"shape":"String"}, - "Stat":{"shape":"String"}, - "Value":{"shape":"String"}, - "Unit":{"shape":"String"} - } - }, - "AIRecommendationPerformanceTarget":{ - "type":"structure", - "required":["Constraints"], - "members":{ - "Constraints":{"shape":"AIRecommendationConstraintList"} - } - }, - "AIResourceIdentifier":{ - "type":"string", - "max":256, - "min":1, - "pattern":"(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:[a-z\\-]*/)?([a-zA-Z0-9]([a-zA-Z0-9\\-]){0,62})(?Provides APIs for creating and managing SageMaker resources.

Other Resources:

", - "operations": { - "AddAssociation": "

Creates an association between the source and the destination. A source can be associated with multiple destinations, and a destination can be associated with multiple sources. An association is a lineage tracking entity. For more information, see Amazon SageMaker ML Lineage Tracking.

", - "AddTags": "

Adds or overwrites one or more tags for the specified SageMaker resource. You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints.

Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see For more information, see Amazon Web Services Tagging Strategies.

Tags that you add to a hyperparameter tuning job by calling this API are also added to any training jobs that the hyperparameter tuning job launches after you call this API, but not to training jobs that the hyperparameter tuning job launched before you called this API. To make sure that the tags associated with a hyperparameter tuning job are also added to all training jobs that the hyperparameter tuning job launches, add the tags when you first create the tuning job by specifying them in the Tags parameter of CreateHyperParameterTuningJob

Tags that you add to a SageMaker Domain or User Profile by calling this API are also added to any Apps that the Domain or User Profile launches after you call this API, but not to Apps that the Domain or User Profile launched before you called this API. To make sure that the tags associated with a Domain or User Profile are also added to all Apps that the Domain or User Profile launches, add the tags when you first create the Domain or User Profile by specifying them in the Tags parameter of CreateDomain or CreateUserProfile.

", - "AssociateTrialComponent": "

Associates a trial component with a trial. A trial component can be associated with multiple trials. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.

", - "AttachClusterNodeVolume": "

Attaches your Amazon Elastic Block Store (Amazon EBS) volume to a node in your EKS orchestrated HyperPod cluster.

This API works with the Amazon Elastic Block Store (Amazon EBS) Container Storage Interface (CSI) driver to manage the lifecycle of persistent storage in your HyperPod EKS clusters.

", - "BatchAddClusterNodes": "

Adds nodes to a HyperPod cluster by incrementing the target count for one or more instance groups. This operation returns a unique NodeLogicalId for each node being added, which can be used to track the provisioning status of the node. This API provides a safer alternative to UpdateCluster for scaling operations by avoiding unintended configuration changes.

This API is only supported for clusters using Continuous as the NodeProvisioningMode.

", - "BatchDeleteClusterNodes": "

Deletes specific nodes within a SageMaker HyperPod cluster. BatchDeleteClusterNodes accepts a cluster name and a list of node IDs.

", - "BatchDescribeModelPackage": "

This action batch describes a list of versioned model packages

", - "BatchRebootClusterNodes": "

Reboots specific nodes within a SageMaker HyperPod cluster using a soft recovery mechanism. BatchRebootClusterNodes performs a graceful reboot of the specified nodes by calling the Amazon Elastic Compute Cloud RebootInstances API, which attempts to cleanly shut down the operating system before restarting the instance.

This operation is useful for recovering from transient issues or applying certain configuration changes that require a restart.

  • Rebooting a node may cause temporary service interruption for workloads running on that node. Ensure your workloads can handle node restarts or use appropriate scheduling to minimize impact.

  • You can reboot up to 25 nodes in a single request.

  • For SageMaker HyperPod clusters using the Slurm workload manager, ensure rebooting nodes will not disrupt critical cluster operations.

", - "BatchReplaceClusterNodes": "

Replaces specific nodes within a SageMaker HyperPod cluster with new hardware. BatchReplaceClusterNodes terminates the specified instances and provisions new replacement instances with the same configuration but fresh hardware. The Amazon Machine Image (AMI) and instance configuration remain the same.

This operation is useful for recovering from hardware failures or persistent issues that cannot be resolved through a reboot.

  • Data Loss Warning: Replacing nodes destroys all instance volumes, including both root and secondary volumes. All data stored on these volumes will be permanently lost and cannot be recovered.

  • To safeguard your work, back up your data to Amazon S3 or an FSx for Lustre file system before invoking the API on a worker node group. This will help prevent any potential data loss from the instance root volume. For more information about backup, see Use the backup script provided by SageMaker HyperPod.

  • If you want to invoke this API on an existing cluster, you'll first need to patch the cluster by running the UpdateClusterSoftware API. For more information about patching a cluster, see Update the SageMaker HyperPod platform software of a cluster.

  • You can replace up to 25 nodes in a single request.

", - "CreateAIBenchmarkJob": "

Creates a benchmark job that runs performance benchmarks against inference infrastructure using a predefined AI workload configuration. The benchmark job measures metrics such as latency, throughput, and cost for your generative AI inference endpoints.

", - "CreateAIRecommendationJob": "

Creates a recommendation job that generates intelligent optimization recommendations for generative AI inference deployments. The job analyzes your model, workload configuration, and performance targets to recommend optimal instance types, model optimization techniques (such as quantization and speculative decoding), and deployment configurations.

", - "CreateAIWorkloadConfig": "

Creates a reusable AI workload configuration that defines datasets, data sources, and benchmark tool settings for consistent performance testing of generative AI inference deployments on Amazon SageMaker AI.

", - "CreateAction": "

Creates an action. An action is a lineage tracking entity that represents an action or activity. For example, a model deployment or an HPO job. Generally, an action involves at least one input or output artifact. For more information, see Amazon SageMaker ML Lineage Tracking.

", - "CreateAlgorithm": "

Create a machine learning algorithm that you can use in SageMaker and list in the Amazon Web Services Marketplace.

", - "CreateApp": "

Creates a running app for the specified UserProfile. This operation is automatically invoked by Amazon SageMaker AI upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously.

", - "CreateAppImageConfig": "

Creates a configuration for running a SageMaker AI image as a KernelGateway app. The configuration specifies the Amazon Elastic File System storage volume on the image, and a list of the kernels in the image.

", - "CreateArtifact": "

Creates an artifact. An artifact is a lineage tracking entity that represents a URI addressable object or data. Some examples are the S3 URI of a dataset and the ECR registry path of an image. For more information, see Amazon SageMaker ML Lineage Tracking.

", - "CreateAutoMLJob": "

Creates an Autopilot job also referred to as Autopilot experiment or AutoML job.

An AutoML job in SageMaker AI is a fully automated process that allows you to build machine learning models with minimal effort and machine learning expertise. When initiating an AutoML job, you provide your data and optionally specify parameters tailored to your use case. SageMaker AI then automates the entire model development lifecycle, including data preprocessing, model training, tuning, and evaluation. AutoML jobs are designed to simplify and accelerate the model building process by automating various tasks and exploring different combinations of machine learning algorithms, data preprocessing techniques, and hyperparameter values. The output of an AutoML job comprises one or more trained models ready for deployment and inference. Additionally, SageMaker AI AutoML jobs generate a candidate model leaderboard, allowing you to select the best-performing model for deployment.

For more information about AutoML jobs, see https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development.html in the SageMaker AI developer guide.

We recommend using the new versions CreateAutoMLJobV2 and DescribeAutoMLJobV2, which offer backward compatibility.

CreateAutoMLJobV2 can manage tabular problem types identical to those of its previous version CreateAutoMLJob, as well as time-series forecasting, non-tabular problem types such as image or text classification, and text generation (LLMs fine-tuning).

Find guidelines about how to migrate a CreateAutoMLJob to CreateAutoMLJobV2 in Migrate a CreateAutoMLJob to CreateAutoMLJobV2.

You can find the best-performing model after you run an AutoML job by calling DescribeAutoMLJobV2 (recommended) or DescribeAutoMLJob.

", - "CreateAutoMLJobV2": "

Creates an Autopilot job also referred to as Autopilot experiment or AutoML job V2.

An AutoML job in SageMaker AI is a fully automated process that allows you to build machine learning models with minimal effort and machine learning expertise. When initiating an AutoML job, you provide your data and optionally specify parameters tailored to your use case. SageMaker AI then automates the entire model development lifecycle, including data preprocessing, model training, tuning, and evaluation. AutoML jobs are designed to simplify and accelerate the model building process by automating various tasks and exploring different combinations of machine learning algorithms, data preprocessing techniques, and hyperparameter values. The output of an AutoML job comprises one or more trained models ready for deployment and inference. Additionally, SageMaker AI AutoML jobs generate a candidate model leaderboard, allowing you to select the best-performing model for deployment.

For more information about AutoML jobs, see https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development.html in the SageMaker AI developer guide.

AutoML jobs V2 support various problem types such as regression, binary, and multiclass classification with tabular data, text and image classification, time-series forecasting, and fine-tuning of large language models (LLMs) for text generation.

CreateAutoMLJobV2 and DescribeAutoMLJobV2 are new versions of CreateAutoMLJob and DescribeAutoMLJob which offer backward compatibility.

CreateAutoMLJobV2 can manage tabular problem types identical to those of its previous version CreateAutoMLJob, as well as time-series forecasting, non-tabular problem types such as image or text classification, and text generation (LLMs fine-tuning).

Find guidelines about how to migrate a CreateAutoMLJob to CreateAutoMLJobV2 in Migrate a CreateAutoMLJob to CreateAutoMLJobV2.

For the list of available problem types supported by CreateAutoMLJobV2, see AutoMLProblemTypeConfig.

You can find the best-performing model after you run an AutoML job V2 by calling DescribeAutoMLJobV2.

", - "CreateCluster": "

Creates an Amazon SageMaker HyperPod cluster. SageMaker HyperPod is a capability of SageMaker for creating and managing persistent clusters for developing large machine learning models, such as large language models (LLMs) and diffusion models. To learn more, see Amazon SageMaker HyperPod in the Amazon SageMaker Developer Guide.

", - "CreateClusterSchedulerConfig": "

Create cluster policy configuration. This policy is used for task prioritization and fair-share allocation of idle compute. This helps prioritize critical workloads and distributes idle compute across entities.

", - "CreateCodeRepository": "

Creates a Git repository as a resource in your SageMaker AI account. You can associate the repository with notebook instances so that you can use Git source control for the notebooks you create. The Git repository is a resource in your SageMaker AI account, so it can be associated with more than one notebook instance, and it persists independently from the lifecycle of any notebook instances it is associated with.

The repository can be hosted either in Amazon Web Services CodeCommit or in any other Git repository.

", - "CreateCompilationJob": "

Starts a model compilation job. After the model has been compiled, Amazon SageMaker AI saves the resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify.

If you choose to host your model using Amazon SageMaker AI hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts with Amazon Web Services IoT Greengrass. In that case, deploy them as an ML resource.

In the request body, you provide the following:

  • A name for the compilation job

  • Information about the input model artifacts

  • The output location for the compiled model and the device (target) that the model runs on

  • The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker AI assumes to perform the model compilation job.

You can also provide a Tag to track the model compilation job's resource use and costs. The response body contains the CompilationJobArn for the compiled job.

To stop a model compilation job, use StopCompilationJob. To get information about a particular model compilation job, use DescribeCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.

", - "CreateComputeQuota": "

Create compute allocation definition. This defines how compute is allocated, shared, and borrowed for specified entities. Specifically, how to lend and borrow idle compute and assign a fair-share weight to the specified entities.

", - "CreateContext": "

Creates a context. A context is a lineage tracking entity that represents a logical grouping of other tracking or experiment entities. Some examples are an endpoint and a model package. For more information, see Amazon SageMaker ML Lineage Tracking.

", - "CreateDataQualityJobDefinition": "

Creates a definition for a job that monitors data quality and drift. For information about model monitor, see Amazon SageMaker AI Model Monitor.

", - "CreateDeviceFleet": "

Creates a device fleet.

", - "CreateDomain": "

Creates a Domain. A domain consists of an associated Amazon Elastic File System volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations. Users within a domain can share notebook files and other artifacts with each other.

EFS storage

When a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files.

SageMaker AI uses the Amazon Web Services Key Management Service (Amazon Web Services KMS) to encrypt the EFS volume attached to the domain with an Amazon Web Services managed key by default. For more control, you can specify a customer managed key. For more information, see Protect Data at Rest Using Encryption.

VPC configuration

All traffic between the domain and the Amazon EFS volume is through the specified VPC and subnets. For other traffic, you can specify the AppNetworkAccessType parameter. AppNetworkAccessType corresponds to the network access type that you choose when you onboard to the domain. The following options are available:

  • PublicInternetOnly - Non-EFS traffic goes through a VPC managed by Amazon SageMaker AI, which allows internet access. This is the default value.

  • VpcOnly - All traffic is through the specified VPC and subnets. Internet access is disabled by default. To allow internet access, you must specify a NAT gateway.

    When internet access is disabled, you won't be able to run a Amazon SageMaker AI Studio notebook or to train or host models unless your VPC has an interface endpoint to the SageMaker AI API and runtime or a NAT gateway and your security groups allow outbound connections.

NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules in order to launch a Amazon SageMaker AI Studio app successfully.

For more information, see Connect Amazon SageMaker AI Studio Notebooks to Resources in a VPC.

", - "CreateEdgeDeploymentPlan": "

Creates an edge deployment plan, consisting of multiple stages. Each stage may have a different deployment configuration and devices.

", - "CreateEdgeDeploymentStage": "

Creates a new stage in an existing edge deployment plan.

", - "CreateEdgePackagingJob": "

Starts a SageMaker Edge Manager model packaging job. Edge Manager will use the model artifacts from the Amazon Simple Storage Service bucket that you specify. After the model has been packaged, Amazon SageMaker saves the resulting artifacts to an S3 bucket that you specify.

", - "CreateEndpoint": "

Creates an endpoint using the endpoint configuration specified in the request. SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the CreateEndpointConfig API.

Use this API to deploy models using SageMaker hosting services.

You must not delete an EndpointConfig that is in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.

The endpoint name must be unique within an Amazon Web Services Region in your Amazon Web Services account.

When it receives the request, SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them.

When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.

When SageMaker receives the request, it sets the endpoint status to Creating. After it creates the endpoint, it sets the status to InService. SageMaker can then process incoming requests for inferences. To check the status of an endpoint, use the DescribeEndpoint API.

If any of the models hosted at this endpoint get model data from an Amazon S3 location, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provided. Amazon Web Services STS is activated in your Amazon Web Services account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide.

To add the IAM role policies for using this API operation, go to the IAM console, and choose Roles in the left navigation pane. Search the IAM role that you want to grant access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to the role.

  • Option 1: For a full SageMaker access, search and attach the AmazonSageMakerFullAccess policy.

  • Option 2: For granting a limited access to an IAM role, paste the following Action elements manually into the JSON file of the IAM role:

    \"Action\": [\"sagemaker:CreateEndpoint\", \"sagemaker:CreateEndpointConfig\"]

    \"Resource\": [

    \"arn:aws:sagemaker:region:account-id:endpoint/endpointName\"

    \"arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName\"

    ]

    For more information, see SageMaker API Permissions: Actions, Permissions, and Resources Reference.

", - "CreateEndpointConfig": "

Creates an endpoint configuration that SageMaker hosting services uses to deploy models. In the configuration, you identify one or more models, created using the CreateModel API, to deploy and the resources that you want SageMaker to provision. Then you call the CreateEndpoint API.

Use this API if you want to use SageMaker hosting services to deploy models into production.

In the request, you define a ProductionVariant, for each model that you want to deploy. Each ProductionVariant parameter also describes the resources that you want SageMaker to provision. This includes the number and type of ML compute instances to deploy.

If you are hosting multiple models, you also assign a VariantWeight to specify how much traffic you want to allocate to each model. For example, suppose that you want to host two models, A and B, and you assign traffic weight 2 for model A and 1 for model B. SageMaker distributes two-thirds of the traffic to Model A, and one-third to model B.

When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.

", - "CreateExperiment": "

Creates a SageMaker experiment. An experiment is a collection of trials that are observed, compared and evaluated as a group. A trial is a set of steps, called trial components, that produce a machine learning model.

In the Studio UI, trials are referred to as run groups and trial components are referred to as runs.

The goal of an experiment is to determine the components that produce the best model. Multiple trials are performed, each one isolating and measuring the impact of a change to one or more inputs, while keeping the remaining inputs constant.

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.

You can add tags to experiments, trials, trial components and then use the Search API to search for the tags.

To add a description to an experiment, specify the optional Description parameter. To add a description later, or to change the description, call the UpdateExperiment API.

To get a list of all your experiments, call the ListExperiments API. To view an experiment's properties, call the DescribeExperiment API. To get a list of all the trials associated with an experiment, call the ListTrials API. To create a trial call the CreateTrial API.

", - "CreateFeatureGroup": "

Create a new FeatureGroup. A FeatureGroup is a group of Features defined in the FeatureStore to describe a Record.

The FeatureGroup defines the schema and features contained in the FeatureGroup. A FeatureGroup definition is composed of a list of Features, a RecordIdentifierFeatureName, an EventTimeFeatureName and configurations for its OnlineStore and OfflineStore. Check Amazon Web Services service quotas to see the FeatureGroups quota for your Amazon Web Services account.

Note that it can take approximately 10-15 minutes to provision an OnlineStore FeatureGroup with the InMemory StorageType.

You must include at least one of OnlineStoreConfig and OfflineStoreConfig to create a FeatureGroup.

", - "CreateFlowDefinition": "

Creates a flow definition.

", - "CreateHub": "

Create a hub.

", - "CreateHubContentPresignedUrls": "

Creates presigned URLs for accessing hub content artifacts. This operation generates time-limited, secure URLs that allow direct download of model artifacts and associated files from Amazon SageMaker hub content, including gated models that require end-user license agreement acceptance.

", - "CreateHubContentReference": "

Create a hub content reference in order to add a model in the JumpStart public hub to a private hub.

", - "CreateHumanTaskUi": "

Defines the settings you will use for the human review workflow user interface. Reviewers will see a three-panel interface with an instruction area, the item to review, and an input area.

", - "CreateHyperParameterTuningJob": "

Starts a hyperparameter tuning job. A hyperparameter tuning job finds the best version of a model by running many training jobs on your dataset using the algorithm you choose and values for hyperparameters within ranges that you specify. It then chooses the hyperparameter values that result in a model that performs the best, as measured by an objective metric that you choose.

A hyperparameter tuning job automatically creates Amazon SageMaker experiments, trials, and trial components for each training job that it runs. You can view these entities in Amazon SageMaker Studio. For more information, see View Experiments, Trials, and Trial Components.

Do not include any security-sensitive information including account access IDs, secrets, or tokens in any hyperparameter fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by any security-sensitive information included in the request hyperparameter variable or plain text fields..

", - "CreateImage": "

Creates a custom SageMaker AI image. A SageMaker AI image is a set of image versions. Each image version represents a container image stored in Amazon ECR. For more information, see Bring your own SageMaker AI image.

", - "CreateImageVersion": "

Creates a version of the SageMaker AI image specified by ImageName. The version represents the Amazon ECR container image specified by BaseImage.

", - "CreateInferenceComponent": "

Creates an inference component, which is a SageMaker AI hosting object that you can use to deploy a model to an endpoint. In the inference component settings, you specify the model, the endpoint, and how the model utilizes the resources that the endpoint hosts. You can optimize resource utilization by tailoring how the required CPU cores, accelerators, and memory are allocated. You can deploy multiple inference components to an endpoint, where each inference component contains one model and the resource utilization needs for that individual model. After you deploy an inference component, you can directly invoke the associated model when you use the InvokeEndpoint API action.

", - "CreateInferenceExperiment": "

Creates an inference experiment using the configurations specified in the request.

Use this API to setup and schedule an experiment to compare model variants on a Amazon SageMaker inference endpoint. For more information about inference experiments, see Shadow tests.

Amazon SageMaker begins your experiment at the scheduled time and routes traffic to your endpoint's model variants based on your specified configuration.

While the experiment is in progress or after it has concluded, you can view metrics that compare your model variants. For more information, see View, monitor, and edit shadow tests.

", - "CreateInferenceRecommendationsJob": "

Starts a recommendation job. You can create either an instance recommendation or load test job.

", - "CreateJob": "

Creates a model customization job in Amazon SageMaker. A job runs a workload based on the job category and configuration you provide. You specify the job category, a schema-versioned configuration document, and an IAM role that grants Amazon SageMaker permission to access resources on your behalf.

Use the AgentRFT category to fine-tune a model using multi-turn reinforcement learning with reward signals. Use the AgentRFTEvaluation category to evaluate a fine-tuned or base model by running multi-turn rollouts against a held-out prompt dataset and computing metrics such as pass@k and mean reward.

Before creating a job, call ListJobSchemaVersions and DescribeJobSchemaVersion to retrieve the configuration schema for your job category. The JobConfigDocument must conform to the schema specified by JobConfigSchemaVersion.

The following operations are related to CreateJob:

  • DescribeJob

  • ListJobs

  • StopJob

  • DeleteJob

  • ListJobSchemaVersions

  • DescribeJobSchemaVersion

", - "CreateLabelingJob": "

Creates a job that uses workers to label the data objects in your input dataset. You can use the labeled data to train machine learning models.

You can select your workforce from one of three providers:

  • A private workforce that you create. It can include employees, contractors, and outside experts. Use a private workforce when want the data to stay within your organization or when a specific set of skills is required.

  • One or more vendors that you select from the Amazon Web Services Marketplace. Vendors provide expertise in specific areas.

  • The Amazon Mechanical Turk workforce. This is the largest workforce, but it should only be used for public data or data that has been stripped of any personally identifiable information.

You can also use automated data labeling to reduce the number of data objects that need to be labeled by a human. Automated data labeling uses active learning to determine if a data object can be labeled by machine or if it needs to be sent to a human worker. For more information, see Using Automated Data Labeling.

The data objects to be labeled are contained in an Amazon S3 bucket. You create a manifest file that describes the location of each object. For more information, see Using Input and Output Data.

The output can be used as the manifest file for another labeling job or as training data for your machine learning models.

You can use this operation to create a static labeling job or a streaming labeling job. A static labeling job stops if all data objects in the input manifest file identified in ManifestS3Uri have been labeled. A streaming labeling job runs perpetually until it is manually stopped, or remains idle for 10 days. You can send new data objects to an active (InProgress) streaming labeling job in real time. To learn how to create a static labeling job, see Create a Labeling Job (API) in the Amazon SageMaker Developer Guide. To learn how to create a streaming labeling job, see Create a Streaming Labeling Job.

", - "CreateMlflowApp": "

Creates an MLflow Tracking Server using a general purpose Amazon S3 bucket as the artifact store.

", - "CreateMlflowTrackingServer": "

Creates an MLflow Tracking Server using a general purpose Amazon S3 bucket as the artifact store. For more information, see Create an MLflow Tracking Server.

", - "CreateModel": "

Creates a model in SageMaker. In the request, you name the model and describe a primary container. For the primary container, you specify the Docker image that contains inference code, artifacts (from prior training), and a custom environment map that the inference code uses when you deploy the model for predictions.

Use this API to create a model if you want to use SageMaker hosting services or run a batch transform job.

To host your model, you create an endpoint configuration with the CreateEndpointConfig API, and then create an endpoint with the CreateEndpoint API. SageMaker then deploys all of the containers that you defined for the model in the hosting environment.

To run a batch transform using your model, you start a job with the CreateTransformJob API. SageMaker uses your model and your dataset to get inferences which are then saved to a specified S3 location.

In the request, you also provide an IAM role that SageMaker can assume to access model artifacts and docker image for deployment on ML compute hosting instances or for batch transform jobs. In addition, you also use the IAM role to manage permissions the inference code needs. For example, if the inference code access any other Amazon Web Services resources, you grant necessary permissions via this role.

", - "CreateModelBiasJobDefinition": "

Creates the definition for a model bias job.

", - "CreateModelCard": "

Creates an Amazon SageMaker Model Card.

For information about how to use model cards, see Amazon SageMaker Model Card.

", - "CreateModelCardExportJob": "

Creates an Amazon SageMaker Model Card export job.

", - "CreateModelExplainabilityJobDefinition": "

Creates the definition for a model explainability job.

", - "CreateModelPackage": "

Creates a model package that you can use to create SageMaker models or list on Amazon Web Services Marketplace, or a versioned model that is part of a model group. Buyers can subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker.

To create a model package by specifying a Docker container that contains your inference code and the Amazon S3 location of your model artifacts, provide values for InferenceSpecification. To create a model from an algorithm resource that you created or subscribed to in Amazon Web Services Marketplace, provide a value for SourceAlgorithmSpecification.

There are two types of model packages:

  • Versioned - a model that is part of a model group in the model registry.

  • Unversioned - a model package that is not part of a model group.

", - "CreateModelPackageGroup": "

Creates a model group. A model group contains a group of model versions.

", - "CreateModelQualityJobDefinition": "

Creates a definition for a job that monitors model quality and drift. For information about model monitor, see Amazon SageMaker AI Model Monitor.

", - "CreateMonitoringSchedule": "

Creates a schedule that regularly starts Amazon SageMaker AI Processing Jobs to monitor the data captured for an Amazon SageMaker AI Endpoint.

", - "CreateNotebookInstance": "

Creates an SageMaker AI notebook instance. A notebook instance is a machine learning (ML) compute instance running on a Jupyter notebook.

In a CreateNotebookInstance request, specify the type of ML compute instance that you want to run. SageMaker AI launches the instance, installs common libraries that you can use to explore datasets for model training, and attaches an ML storage volume to the notebook instance.

SageMaker AI also provides a set of example notebooks. Each notebook demonstrates how to use SageMaker AI with a specific algorithm or with a machine learning framework.

After receiving the request, SageMaker AI does the following:

  1. Creates a network interface in the SageMaker AI VPC.

  2. (Option) If you specified SubnetId, SageMaker AI creates a network interface in your own VPC, which is inferred from the subnet ID that you provide in the input. When creating this network interface, SageMaker AI attaches the security group that you specified in the request to the network interface that it creates in your VPC.

  3. Launches an EC2 instance of the type specified in the request in the SageMaker AI VPC. If you specified SubnetId of your VPC, SageMaker AI specifies both network interfaces when launching this instance. This enables inbound traffic from your own VPC to the notebook instance, assuming that the security groups allow it.

After creating the notebook instance, SageMaker AI returns its Amazon Resource Name (ARN). You can't change the name of a notebook instance after you create it.

After SageMaker AI creates the notebook instance, you can connect to the Jupyter server and work in Jupyter notebooks. For example, you can write code to explore a dataset that you can use for model training, train a model, host models by creating SageMaker AI endpoints, and validate hosted models.

For more information, see How It Works.

", - "CreateNotebookInstanceLifecycleConfig": "

Creates a lifecycle configuration that you can associate with a notebook instance. A lifecycle configuration is a collection of shell scripts that run when you create or start a notebook instance.

Each lifecycle configuration script has a limit of 16384 characters.

The value of the $PATH environment variable that is available to both scripts is /sbin:bin:/usr/sbin:/usr/bin.

View Amazon CloudWatch Logs for notebook instance lifecycle configurations in log group /aws/sagemaker/NotebookInstances in log stream [notebook-instance-name]/[LifecycleConfigHook].

Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 minutes, it fails and the notebook instance is not created or started.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

Lifecycle configuration scripts execute with root access and the notebook instance's IAM execution role privileges. Grant this permission only to trusted principals. See Customize a Notebook Instance Using a Lifecycle Configuration Script for security best practices.

", - "CreateOptimizationJob": "

Creates a job that optimizes a model for inference performance. To create the job, you provide the location of a source model, and you provide the settings for the optimization techniques that you want the job to apply. When the job completes successfully, SageMaker uploads the new optimized model to the output destination that you specify.

For more information about how to use this action, and about the supported optimization techniques, see Optimize model inference with Amazon SageMaker.

", - "CreatePartnerApp": "

Creates an Amazon SageMaker Partner AI App.

", - "CreatePartnerAppPresignedUrl": "

Creates a presigned URL to access an Amazon SageMaker Partner AI App.

", - "CreatePipeline": "

Creates a pipeline using a JSON pipeline definition.

", - "CreatePresignedDomainUrl": "

Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser, the user will be automatically signed in to the domain, and granted access to all of the Apps and files associated with the Domain's Amazon Elastic File System volume. This operation can only be called when the authentication mode equals IAM.

The IAM role or user passed to this API defines the permissions to access the app. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the app.

You can restrict access to this API and to the URL that it returns to a list of IP addresses, Amazon VPCs or Amazon VPC Endpoints that you specify. For more information, see Connect to Amazon SageMaker AI Studio Through an Interface VPC Endpoint .

  • The URL that you get from a call to CreatePresignedDomainUrl has a default timeout of 5 minutes. You can configure this value using ExpiresInSeconds. If you try to use the URL after the timeout limit expires, you are directed to the Amazon Web Services console sign-in page.

  • The JupyterLab session default expiration time is 12 hours. You can configure this value using SessionExpirationDurationInSeconds.

", - "CreatePresignedMlflowAppUrl": "

Returns a presigned URL that you can use to connect to the MLflow UI attached to your MLflow App. For more information, see Launch the MLflow UI using a presigned URL.

", - "CreatePresignedMlflowTrackingServerUrl": "

Returns a presigned URL that you can use to connect to the MLflow UI attached to your tracking server. For more information, see Launch the MLflow UI using a presigned URL.

", - "CreatePresignedNotebookInstanceUrl": "

Returns a URL that you can use to connect to the Jupyter server from a notebook instance. In the SageMaker AI console, when you choose Open next to a notebook instance, SageMaker AI opens a new tab showing the Jupyter server home page from the notebook instance. The console uses this API to get the URL and show the page.

The IAM role or user used to call this API defines the permissions to access the notebook instance. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the notebook instance.

You can restrict access to this API and to the URL that it returns to a list of IP addresses that you specify. Use the NotIpAddress condition operator and the aws:SourceIP condition context key to specify the list of IP addresses that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address.

The URL that you get from a call to CreatePresignedNotebookInstanceUrl is valid only for 5 minutes. If you try to use the URL after the 5-minute limit expires, you are directed to the Amazon Web Services console sign-in page.

", - "CreateProcessingJob": "

Creates a processing job.

", - "CreateProject": "

Creates a machine learning (ML) project that can contain one or more templates that set up an ML pipeline from training to deploying an approved model.

", - "CreateSpace": "

Creates a private space or a space used for real time collaboration in a domain.

", - "CreateStudioLifecycleConfig": "

Creates a new Amazon SageMaker AI Studio Lifecycle Configuration.

", - "CreateTrainingJob": "

Starts a model training job. After training completes, SageMaker saves the resulting model artifacts to an Amazon S3 location that you specify.

If you choose to host your model using SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts in a machine learning service other than SageMaker, provided that you know how to use them for inference.

In the request body, you provide the following:

  • AlgorithmSpecification - Identifies the training algorithm to use.

  • HyperParameters - Specify these algorithm-specific parameters to enable the estimation of model parameters during training. Hyperparameters can be tuned to optimize this learning process. For a list of hyperparameters for each training algorithm provided by SageMaker, see Algorithms.

    Do not include any security-sensitive information including account access IDs, secrets, or tokens in any hyperparameter fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request hyperparameter variable or plain text fields.

  • InputDataConfig - Describes the input required by the training job and the Amazon S3, EFS, or FSx location where it is stored.

  • OutputDataConfig - Identifies the Amazon S3 bucket where you want SageMaker to save the results of model training.

  • ResourceConfig - Identifies the resources, ML compute instances, and ML storage volumes to deploy for model training. In distributed training, you specify more than one instance.

  • EnableManagedSpotTraining - Optimize the cost of training machine learning models by up to 80% by using Amazon EC2 Spot instances. For more information, see Managed Spot Training.

  • RoleArn - The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during model training. You must grant this role the necessary permissions so that SageMaker can successfully complete model training.

  • StoppingCondition - To help cap training costs, use MaxRuntimeInSeconds to set a time limit for training. Use MaxWaitTimeInSeconds to specify how long a managed spot training job has to complete.

  • Environment - The environment variables to set in the Docker container.

    Do not include any security-sensitive information including account access IDs, secrets, or tokens in any environment fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request environment variable or plain text fields.

  • RetryStrategy - The number of times to retry the job when the job fails due to an InternalServerError.

For more information about SageMaker, see How It Works.

", - "CreateTrainingPlan": "

Creates a new training plan in SageMaker to reserve compute capacity.

Amazon SageMaker Training Plan is a capability within SageMaker that allows customers to reserve and manage GPU capacity for large-scale AI model training. It provides a way to secure predictable access to computational resources within specific timelines and budgets, without the need to manage underlying infrastructure.

How it works

Plans can be created for specific resources such as SageMaker Training Jobs or SageMaker HyperPod clusters, automatically provisioning resources, setting up infrastructure, executing workloads, and handling infrastructure failures.

Plan creation workflow

  • Users search for available plan offerings based on their requirements (e.g., instance type, count, start time, duration) using the SearchTrainingPlanOfferings API operation.

  • They create a plan that best matches their needs using the ID of the plan offering they want to use.

  • After successful upfront payment, the plan's status becomes Scheduled.

  • The plan can be used to:

    • Queue training jobs.

    • Allocate to an instance group of a SageMaker HyperPod cluster.

  • When the plan start date arrives, it becomes Active. Based on available reserved capacity:

    • Training jobs are launched.

    • Instance groups are provisioned.

Plan composition

A plan can consist of one or more Reserved Capacities, each defined by a specific instance type, quantity, Availability Zone, duration, and start and end times. For more information about Reserved Capacity, see ReservedCapacitySummary .

", - "CreateTransformJob": "

Starts a transform job. A transform job uses a trained model to get inferences on a dataset and saves these results to an Amazon S3 location that you specify.

To perform batch transformations, you create a transform job and use the data that you have readily available.

In the request body, you provide the following:

  • TransformJobName - Identifies the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

  • ModelName - Identifies the model to use. ModelName must be the name of an existing Amazon SageMaker model in the same Amazon Web Services Region and Amazon Web Services account. For information on creating a model, see CreateModel.

  • TransformInput - Describes the dataset to be transformed and the Amazon S3 location where it is stored.

  • TransformOutput - Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

  • TransformResources - Identifies the ML compute instances and AMI image versions for the transform job.

For more information about how batch transformation works, see Batch Transform.

", - "CreateTrial": "

Creates an SageMaker trial. A trial is a set of steps called trial components that produce a machine learning model. A trial is part of a single SageMaker experiment.

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.

You can add tags to a trial and then use the Search API to search for the tags.

To get a list of all your trials, call the ListTrials API. To view a trial's properties, call the DescribeTrial API. To create a trial component, call the CreateTrialComponent API.

", - "CreateTrialComponent": "

Creates a trial component, which is a stage of a machine learning trial. A trial is composed of one or more trial components. A trial component can be used in multiple trials.

Trial components include pre-processing jobs, training jobs, and batch transform jobs.

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.

You can add tags to a trial component and then use the Search API to search for the tags.

", - "CreateUserProfile": "

Creates a user profile. A user profile represents a single user within a domain, and is the main way to reference a \"person\" for the purposes of sharing, reporting, and other user-oriented features. This entity is created when a user onboards to a domain. If an administrator invites a person by email or imports them from IAM Identity Center, a user profile is automatically created. A user profile is the primary holder of settings for an individual user and has a reference to the user's private Amazon Elastic File System home directory.

", - "CreateWorkforce": "

Use this operation to create a workforce. This operation will return an error if a workforce already exists in the Amazon Web Services Region that you specify. You can only create one workforce in each Amazon Web Services Region per Amazon Web Services account.

If you want to create a new workforce in an Amazon Web Services Region where a workforce already exists, use the DeleteWorkforce API operation to delete the existing workforce and then use CreateWorkforce to create a new workforce.

To create a private workforce using Amazon Cognito, you must specify a Cognito user pool in CognitoConfig. You can also create an Amazon Cognito workforce using the Amazon SageMaker console. For more information, see Create a Private Workforce (Amazon Cognito).

To create a private workforce using your own OIDC Identity Provider (IdP), specify your IdP configuration in OidcConfig. Your OIDC IdP must support groups because groups are used by Ground Truth and Amazon A2I to create work teams. For more information, see Create a Private Workforce (OIDC IdP).

", - "CreateWorkteam": "

Creates a new work team for labeling your data. A work team is defined by one or more Amazon Cognito user pools. You must first create the user pools before you can create a work team.

You cannot create more than 25 work teams in an account and region.

", - "DeleteAIBenchmarkJob": "

Deletes the specified AI benchmark job.

", - "DeleteAIRecommendationJob": "

Deletes the specified AI recommendation job.

", - "DeleteAIWorkloadConfig": "

Deletes the specified AI workload configuration. You cannot delete a configuration that is referenced by an active benchmark job.

", - "DeleteAction": "

Deletes an action.

", - "DeleteAlgorithm": "

Removes the specified algorithm from your account.

", - "DeleteApp": "

Used to stop and delete an app.

", - "DeleteAppImageConfig": "

Deletes an AppImageConfig.

", - "DeleteArtifact": "

Deletes an artifact. Either ArtifactArn or Source must be specified.

", - "DeleteAssociation": "

Deletes an association.

", - "DeleteCluster": "

Delete a SageMaker HyperPod cluster.

", - "DeleteClusterSchedulerConfig": "

Deletes the cluster policy of the cluster.

", - "DeleteCodeRepository": "

Deletes the specified Git repository from your account.

", - "DeleteCompilationJob": "

Deletes the specified compilation job. This action deletes only the compilation job resource in Amazon SageMaker AI. It doesn't delete other resources that are related to that job, such as the model artifacts that the job creates, the compilation logs in CloudWatch, the compiled model, or the IAM role.

You can delete a compilation job only if its current status is COMPLETED, FAILED, or STOPPED. If the job status is STARTING or INPROGRESS, stop the job, and then delete it after its status becomes STOPPED.

", - "DeleteComputeQuota": "

Deletes the compute allocation from the cluster.

", - "DeleteContext": "

Deletes an context.

", - "DeleteDataQualityJobDefinition": "

Deletes a data quality monitoring job definition.

", - "DeleteDeviceFleet": "

Deletes a fleet.

", - "DeleteDomain": "

Used to delete a domain. If you onboarded with IAM mode, you will need to delete your domain to onboard again using IAM Identity Center. Use with caution. All of the members of the domain will lose access to their EFS volume, including data, notebooks, and other artifacts.

", - "DeleteEdgeDeploymentPlan": "

Deletes an edge deployment plan if (and only if) all the stages in the plan are inactive or there are no stages in the plan.

", - "DeleteEdgeDeploymentStage": "

Delete a stage in an edge deployment plan if (and only if) the stage is inactive.

", - "DeleteEndpoint": "

Deletes an endpoint. SageMaker frees up all of the resources that were deployed when the endpoint was created.

SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't need to use the RevokeGrant API call.

When you delete your endpoint, SageMaker asynchronously deletes associated endpoint resources such as KMS key grants. You might still see these resources in your account for a few minutes after deleting your endpoint. Do not delete or revoke the permissions for your ExecutionRoleArn , otherwise SageMaker cannot delete these resources.

", - "DeleteEndpointConfig": "

Deletes an endpoint configuration. The DeleteEndpointConfig API deletes only the specified configuration. It does not delete endpoints created using the configuration.

You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. If you delete the EndpointConfig of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges.

", - "DeleteExperiment": "

Deletes an SageMaker experiment. All trials associated with the experiment must be deleted first. Use the ListTrials API to get a list of the trials associated with the experiment.

", - "DeleteFeatureGroup": "

Delete the FeatureGroup and any data that was written to the OnlineStore of the FeatureGroup. Data cannot be accessed from the OnlineStore immediately after DeleteFeatureGroup is called.

Data written into the OfflineStore will not be deleted. The Amazon Web Services Glue database and tables that are automatically created for your OfflineStore are not deleted.

Note that it can take approximately 10-15 minutes to delete an OnlineStore FeatureGroup with the InMemory StorageType.

", - "DeleteFlowDefinition": "

Deletes the specified flow definition.

", - "DeleteHub": "

Delete a hub.

", - "DeleteHubContent": "

Delete the contents of a hub.

", - "DeleteHubContentReference": "

Delete a hub content reference in order to remove a model from a private hub.

", - "DeleteHumanTaskUi": "

Use this operation to delete a human task user interface (worker task template).

To see a list of human task user interfaces (work task templates) in your account, use ListHumanTaskUis. When you delete a worker task template, it no longer appears when you call ListHumanTaskUis.

", - "DeleteHyperParameterTuningJob": "

Deletes a hyperparameter tuning job. The DeleteHyperParameterTuningJob API deletes only the tuning job entry that was created in SageMaker when you called the CreateHyperParameterTuningJob API. It does not delete training jobs, artifacts, or the IAM role that you specified when creating the model.

", - "DeleteImage": "

Deletes a SageMaker AI image and all versions of the image. The container images aren't deleted.

", - "DeleteImageVersion": "

Deletes a version of a SageMaker AI image. The container image the version represents isn't deleted.

", - "DeleteInferenceComponent": "

Deletes an inference component.

", - "DeleteInferenceExperiment": "

Deletes an inference experiment.

This operation does not delete your endpoint, variants, or any underlying resources. This operation only deletes the metadata of your experiment.

", - "DeleteJob": "

Deletes a job. This operation is idempotent. If the job is currently running, you must stop it before deleting it by calling StopJob.

The following operations are related to DeleteJob:

  • CreateJob

  • StopJob

  • DescribeJob

", - "DeleteMlflowApp": "

Deletes an MLflow App.

", - "DeleteMlflowTrackingServer": "

Deletes an MLflow Tracking Server. For more information, see Clean up MLflow resources.

", - "DeleteModel": "

Deletes a model. The DeleteModel API deletes only the model entry that was created in SageMaker when you called the CreateModel API. It does not delete model artifacts, inference code, or the IAM role that you specified when creating the model.

", - "DeleteModelBiasJobDefinition": "

Deletes an Amazon SageMaker AI model bias job definition.

", - "DeleteModelCard": "

Deletes an Amazon SageMaker Model Card.

", - "DeleteModelExplainabilityJobDefinition": "

Deletes an Amazon SageMaker AI model explainability job definition.

", - "DeleteModelPackage": "

Deletes a model package.

A model package is used to create SageMaker models or list on Amazon Web Services Marketplace. Buyers can subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker.

", - "DeleteModelPackageGroup": "

Deletes the specified model group.

", - "DeleteModelPackageGroupPolicy": "

Deletes a model group resource policy.

", - "DeleteModelQualityJobDefinition": "

Deletes the secified model quality monitoring job definition.

", - "DeleteMonitoringSchedule": "

Deletes a monitoring schedule. Also stops the schedule had not already been stopped. This does not delete the job execution history of the monitoring schedule.

", - "DeleteNotebookInstance": "

Deletes an SageMaker AI notebook instance. Before you can delete a notebook instance, you must call the StopNotebookInstance API.

When you delete a notebook instance, you lose all of your data. SageMaker AI removes the ML compute instance, and deletes the ML storage volume and the network interface associated with the notebook instance.

", - "DeleteNotebookInstanceLifecycleConfig": "

Deletes a notebook instance lifecycle configuration.

", - "DeleteOptimizationJob": "

Deletes an optimization job.

", - "DeletePartnerApp": "

Deletes a SageMaker Partner AI App.

", - "DeletePipeline": "

Deletes a pipeline if there are no running instances of the pipeline. To delete a pipeline, you must stop all running instances of the pipeline using the StopPipelineExecution API. When you delete a pipeline, all instances of the pipeline are deleted.

", - "DeleteProcessingJob": "

Deletes a processing job. After Amazon SageMaker deletes a processing job, all of the metadata for the processing job is lost. You can delete only processing jobs that are in a terminal state (Stopped, Failed, or Completed). You cannot delete a job that is in the InProgress or Stopping state. After deleting the job, you can reuse its name to create another processing job.

", - "DeleteProject": "

Delete the specified project.

", - "DeleteSpace": "

Used to delete a space.

", - "DeleteStudioLifecycleConfig": "

Deletes the Amazon SageMaker AI Studio Lifecycle Configuration. In order to delete the Lifecycle Configuration, there must be no running apps using the Lifecycle Configuration. You must also remove the Lifecycle Configuration from UserSettings in all Domains and UserProfiles.

", - "DeleteTags": "

Deletes the specified tags from an SageMaker resource.

To list a resource's tags, use the ListTags API.

When you call this API to delete tags from a hyperparameter tuning job, the deleted tags are not removed from training jobs that the hyperparameter tuning job launched before you called this API.

When you call this API to delete tags from a SageMaker Domain or User Profile, the deleted tags are not removed from Apps that the SageMaker Domain or User Profile launched before you called this API.

", - "DeleteTrainingJob": "

Deletes a training job. After SageMaker deletes a training job, all of the metadata for the training job is lost. You can delete only training jobs that are in a terminal state (Stopped, Failed, or Completed) and don't retain an Available managed warm pool. You cannot delete a job that is in the InProgress or Stopping state. After deleting the job, you can reuse its name to create another training job.

", - "DeleteTrial": "

Deletes the specified trial. All trial components that make up the trial must be deleted first. Use the DescribeTrialComponent API to get the list of trial components.

", - "DeleteTrialComponent": "

Deletes the specified trial component. A trial component must be disassociated from all trials before the trial component can be deleted. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.

", - "DeleteUserProfile": "

Deletes a user profile. When a user profile is deleted, the user loses access to their EFS volume, including data, notebooks, and other artifacts.

", - "DeleteWorkforce": "

Use this operation to delete a workforce.

If you want to create a new workforce in an Amazon Web Services Region where a workforce already exists, use this operation to delete the existing workforce and then use CreateWorkforce to create a new workforce.

If a private workforce contains one or more work teams, you must use the DeleteWorkteam operation to delete all work teams before you delete the workforce. If you try to delete a workforce that contains one or more work teams, you will receive a ResourceInUse error.

", - "DeleteWorkteam": "

Deletes an existing work team. This operation can't be undone.

", - "DeregisterDevices": "

Deregisters the specified devices. After you deregister a device, you will need to re-register the devices.

", - "DescribeAIBenchmarkJob": "

Returns details of an AI benchmark job, including its status, configuration, target endpoint, and timing information.

", - "DescribeAIRecommendationJob": "

Returns details of an AI recommendation job, including its status, model source, performance targets, optimization recommendations, and deployment configurations.

", - "DescribeAIWorkloadConfig": "

Returns details of an AI workload configuration, including the dataset configuration, benchmark tool settings, tags, and creation time.

", - "DescribeAction": "

Describes an action.

", - "DescribeAlgorithm": "

Returns a description of the specified algorithm that is in your account.

", - "DescribeApp": "

Describes the app.

", - "DescribeAppImageConfig": "

Describes an AppImageConfig.

", - "DescribeArtifact": "

Describes an artifact.

", - "DescribeAutoMLJob": "

Returns information about an AutoML job created by calling CreateAutoMLJob.

AutoML jobs created by calling CreateAutoMLJobV2 cannot be described by DescribeAutoMLJob.

", - "DescribeAutoMLJobV2": "

Returns information about an AutoML job created by calling CreateAutoMLJobV2 or CreateAutoMLJob.

", - "DescribeCluster": "

Retrieves information of a SageMaker HyperPod cluster.

", - "DescribeClusterEvent": "

Retrieves detailed information about a specific event for a given HyperPod cluster. This functionality is only supported when the NodeProvisioningMode is set to Continuous.

", - "DescribeClusterNode": "

Retrieves information of a node (also called a instance interchangeably) of a SageMaker HyperPod cluster.

", - "DescribeClusterSchedulerConfig": "

Description of the cluster policy. This policy is used for task prioritization and fair-share allocation. This helps prioritize critical workloads and distributes idle compute across entities.

", - "DescribeCodeRepository": "

Gets details about the specified Git repository.

", - "DescribeCompilationJob": "

Returns information about a model compilation job.

To create a model compilation job, use CreateCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.

", - "DescribeComputeQuota": "

Description of the compute allocation definition.

", - "DescribeContext": "

Describes a context.

", - "DescribeDataQualityJobDefinition": "

Gets the details of a data quality monitoring job definition.

", - "DescribeDevice": "

Describes the device.

", - "DescribeDeviceFleet": "

A description of the fleet the device belongs to.

", - "DescribeDomain": "

The description of the domain.

", - "DescribeEdgeDeploymentPlan": "

Describes an edge deployment plan with deployment status per stage.

", - "DescribeEdgePackagingJob": "

A description of edge packaging jobs.

", - "DescribeEndpoint": "

Returns the description of an endpoint.

", - "DescribeEndpointConfig": "

Returns the description of an endpoint configuration created using the CreateEndpointConfig API.

", - "DescribeExperiment": "

Provides a list of an experiment's properties.

", - "DescribeFeatureGroup": "

Use this operation to describe a FeatureGroup. The response includes information on the creation time, FeatureGroup name, the unique identifier for each FeatureGroup, and more.

", - "DescribeFeatureMetadata": "

Shows the metadata for a feature within a feature group.

", - "DescribeFlowDefinition": "

Returns information about the specified flow definition.

", - "DescribeHub": "

Describes a hub.

", - "DescribeHubContent": "

Describe the content of a hub.

", - "DescribeHumanTaskUi": "

Returns information about the requested human task user interface (worker task template).

", - "DescribeHyperParameterTuningJob": "

Returns a description of a hyperparameter tuning job, depending on the fields selected. These fields can include the name, Amazon Resource Name (ARN), job status of your tuning job and more.

", - "DescribeImage": "

Describes a SageMaker AI image.

", - "DescribeImageVersion": "

Describes a version of a SageMaker AI image.

", - "DescribeInferenceComponent": "

Returns information about an inference component.

", - "DescribeInferenceExperiment": "

Returns details about an inference experiment.

", - "DescribeInferenceRecommendationsJob": "

Provides the results of the Inference Recommender job. One or more recommendation jobs are returned.

", - "DescribeJob": "

Returns detailed information about a job, including its current status, secondary status, configuration, and timestamps. Use SecondaryStatus for granular progress tracking and SecondaryStatusTransitions to see the full history of status changes with timestamps.

The following operations are related to DescribeJob:

  • CreateJob

  • ListJobs

  • StopJob

  • DeleteJob

", - "DescribeJobSchemaVersion": "

Returns the JSON schema for a specified job category and schema version. Use this schema to validate your JobConfigDocument before calling CreateJob. If you don't specify a schema version, the latest version is returned. The schema defines required fields, allowed values, and constraints for the job configuration.

The following operations are related to DescribeJobSchemaVersion:

  • ListJobSchemaVersions

  • CreateJob

", - "DescribeLabelingJob": "

Gets information about a labeling job.

", - "DescribeLineageGroup": "

Provides a list of properties for the requested lineage group. For more information, see Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.

", - "DescribeMlflowApp": "

Returns information about an MLflow App.

", - "DescribeMlflowTrackingServer": "

Returns information about an MLflow Tracking Server.

", - "DescribeModel": "

Describes a model that you created using the CreateModel API.

", - "DescribeModelBiasJobDefinition": "

Returns a description of a model bias job definition.

", - "DescribeModelCard": "

Describes the content, creation time, and security configuration of an Amazon SageMaker Model Card.

To retrieve only metadata about a model card without requiring kms:Decrypt permission on the associated customer-managed Amazon Web Services KMS key, set IncludedData to MetadataOnly. The default is AllData, which returns the full model card Content and requires kms:Decrypt permission when a customer-managed key is configured.

", - "DescribeModelCardExportJob": "

Describes an Amazon SageMaker Model Card export job.

", - "DescribeModelExplainabilityJobDefinition": "

Returns a description of a model explainability job definition.

", - "DescribeModelPackage": "

Returns a description of the specified model package, which is used to create SageMaker models or list them on Amazon Web Services Marketplace.

If you provided a KMS Key ID when you created your model package, you will see the KMS Decrypt API call in your CloudTrail logs when you use this API. To call this operation without requiring kms:Decrypt permission on the customer-managed key, set IncludedData to MetadataOnly; the response is returned with the embedded ModelCard.ModelCardContent field sanitized.

To create models in SageMaker, buyers can subscribe to model packages listed on Amazon Web Services Marketplace.

", - "DescribeModelPackageGroup": "

Gets a description for the specified model group.

", - "DescribeModelQualityJobDefinition": "

Returns a description of a model quality job definition.

", - "DescribeMonitoringSchedule": "

Describes the schedule for a monitoring job.

", - "DescribeNotebookInstance": "

Returns information about a notebook instance.

", - "DescribeNotebookInstanceLifecycleConfig": "

Returns a description of a notebook instance lifecycle configuration.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

", - "DescribeOptimizationJob": "

Provides the properties of the specified optimization job.

", - "DescribePartnerApp": "

Gets information about a SageMaker Partner AI App.

", - "DescribePipeline": "

Describes the details of a pipeline.

", - "DescribePipelineDefinitionForExecution": "

Describes the details of an execution's pipeline definition.

", - "DescribePipelineExecution": "

Describes the details of a pipeline execution.

", - "DescribeProcessingJob": "

Returns a description of a processing job.

", - "DescribeProject": "

Describes the details of a project.

", - "DescribeReservedCapacity": "

Retrieves details about a reserved capacity.

", - "DescribeSpace": "

Describes the space.

", - "DescribeStudioLifecycleConfig": "

Describes the Amazon SageMaker AI Studio Lifecycle Configuration.

", - "DescribeSubscribedWorkteam": "

Gets information about a work team provided by a vendor. It returns details about the subscription with a vendor in the Amazon Web Services Marketplace.

", - "DescribeTrainingJob": "

Returns information about a training job.

Some of the attributes below only appear if the training job successfully starts. If the training job fails, TrainingJobStatus is Failed and, depending on the FailureReason, attributes like TrainingStartTime, TrainingTimeInSeconds, TrainingEndTime, and BillableTimeInSeconds may not be present in the response.

", - "DescribeTrainingPlan": "

Retrieves detailed information about a specific training plan.

", - "DescribeTrainingPlanExtensionHistory": "

Retrieves the extension history for a specified training plan. The response includes details about each extension, such as the offering ID, start and end dates, status, payment status, and cost information.

", - "DescribeTransformJob": "

Returns information about a transform job.

", - "DescribeTrial": "

Provides a list of a trial's properties.

", - "DescribeTrialComponent": "

Provides a list of a trials component's properties.

", - "DescribeUserProfile": "

Describes a user profile. For more information, see CreateUserProfile.

", - "DescribeWorkforce": "

Lists private workforce information, including workforce name, Amazon Resource Name (ARN), and, if applicable, allowed IP address ranges (CIDRs). Allowable IP address ranges are the IP addresses that workers can use to access tasks.

This operation applies only to private workforces.

", - "DescribeWorkteam": "

Gets information about a specific work team. You can see information such as the creation date, the last updated date, membership information, and the work team's Amazon Resource Name (ARN).

", - "DetachClusterNodeVolume": "

Detaches your Amazon Elastic Block Store (Amazon EBS) volume from a node in your EKS orchestrated SageMaker HyperPod cluster.

This API works with the Amazon Elastic Block Store (Amazon EBS) Container Storage Interface (CSI) driver to manage the lifecycle of persistent storage in your HyperPod EKS clusters.

", - "DisableSagemakerServicecatalogPortfolio": "

Disables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.

", - "DisassociateTrialComponent": "

Disassociates a trial component from a trial. This doesn't effect other trials the component is associated with. Before you can delete a component, you must disassociate the component from all trials it is associated with. To associate a trial component with a trial, call the AssociateTrialComponent API.

To get a list of the trials a component is associated with, use the Search API. Specify ExperimentTrialComponent for the Resource parameter. The list appears in the response under Results.TrialComponent.Parents.

", - "EnableSagemakerServicecatalogPortfolio": "

Enables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.

", - "ExtendTrainingPlan": "

Extends an existing training plan by purchasing an extension offering. This allows you to add additional compute capacity time to your training plan without creating a new plan or reconfiguring your workloads.

To find available extension offerings, use the SearchTrainingPlanOfferings API with the TrainingPlanArn parameter.

To view the history of extensions for a training plan, use the DescribeTrainingPlanExtensionHistory API.

", - "GetDeviceFleetReport": "

Describes a fleet.

", - "GetLineageGroupPolicy": "

The resource policy for the lineage group.

", - "GetModelPackageGroupPolicy": "

Gets a resource policy that manages access for a model group. For information about resource policies, see Identity-based policies and resource-based policies in the Amazon Web Services Identity and Access Management User Guide..

", - "GetSagemakerServicecatalogPortfolioStatus": "

Gets the status of Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.

", - "GetScalingConfigurationRecommendation": "

Starts an Amazon SageMaker Inference Recommender autoscaling recommendation job. Returns recommendations for autoscaling policies that you can apply to your SageMaker endpoint.

", - "GetSearchSuggestions": "

An auto-complete API for the search functionality in the SageMaker console. It returns suggestions of possible matches for the property name to use in Search queries. Provides suggestions for HyperParameters, Tags, and Metrics.

", - "ImportHubContent": "

Import hub content.

", - "ListAIBenchmarkJobs": "

Returns a list of AI benchmark jobs in your account. You can filter the results by name, status, and creation time, and sort the results. The response is paginated.

", - "ListAIRecommendationJobs": "

Returns a list of AI recommendation jobs in your account. You can filter the results by name, status, and creation time, and sort the results. The response is paginated.

", - "ListAIWorkloadConfigs": "

Returns a list of AI workload configurations in your account. You can filter the results by name and creation time, and sort the results. The response is paginated.

", - "ListActions": "

Lists the actions in your account and their properties.

", - "ListAlgorithms": "

Lists the machine learning algorithms that have been created.

", - "ListAliases": "

Lists the aliases of a specified image or image version.

", - "ListAppImageConfigs": "

Lists the AppImageConfigs in your account and their properties. The list can be filtered by creation time or modified time, and whether the AppImageConfig name contains a specified string.

", - "ListApps": "

Lists apps.

", - "ListArtifacts": "

Lists the artifacts in your account and their properties.

", - "ListAssociations": "

Lists the associations in your account and their properties.

", - "ListAutoMLJobs": "

Request a list of jobs.

", - "ListCandidatesForAutoMLJob": "

List the candidates created for the job.

", - "ListClusterEvents": "

Retrieves a list of event summaries for a specified HyperPod cluster. The operation supports filtering, sorting, and pagination of results. This functionality is only supported when the NodeProvisioningMode is set to Continuous.

", - "ListClusterNodes": "

Retrieves the list of instances (also called nodes interchangeably) in a SageMaker HyperPod cluster.

", - "ListClusterSchedulerConfigs": "

List the cluster policy configurations.

", - "ListClusters": "

Retrieves the list of SageMaker HyperPod clusters.

", - "ListCodeRepositories": "

Gets a list of the Git repositories in your account.

", - "ListCompilationJobs": "

Lists model compilation jobs that satisfy various filters.

To create a model compilation job, use CreateCompilationJob. To get information about a particular model compilation job you have created, use DescribeCompilationJob.

", - "ListComputeQuotas": "

List the resource allocation definitions.

", - "ListContexts": "

Lists the contexts in your account and their properties.

", - "ListDataQualityJobDefinitions": "

Lists the data quality job definitions in your account.

", - "ListDeviceFleets": "

Returns a list of devices in the fleet.

", - "ListDevices": "

A list of devices.

", - "ListDomains": "

Lists the domains.

", - "ListEdgeDeploymentPlans": "

Lists all edge deployment plans.

", - "ListEdgePackagingJobs": "

Returns a list of edge packaging jobs.

", - "ListEndpointConfigs": "

Lists endpoint configurations.

", - "ListEndpoints": "

Lists endpoints.

", - "ListExperiments": "

Lists all the experiments in your account. The list can be filtered to show only experiments that were created in a specific time range. The list can be sorted by experiment name or creation time.

", - "ListFeatureGroups": "

List FeatureGroups based on given filter and order.

", - "ListFlowDefinitions": "

Returns information about the flow definitions in your account.

", - "ListHubContentVersions": "

List hub content versions.

", - "ListHubContents": "

List the contents of a hub.

", - "ListHubs": "

List all existing hubs.

", - "ListHumanTaskUis": "

Returns information about the human task user interfaces in your account.

", - "ListHyperParameterTuningJobs": "

Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.

", - "ListImageVersions": "

Lists the versions of a specified image and their properties. The list can be filtered by creation time or modified time.

", - "ListImages": "

Lists the images in your account and their properties. The list can be filtered by creation time or modified time, and whether the image name contains a specified string.

", - "ListInferenceComponents": "

Lists the inference components in your account and their properties.

", - "ListInferenceExperiments": "

Returns the list of all inference experiments.

", - "ListInferenceRecommendationsJobSteps": "

Returns a list of the subtasks for an Inference Recommender job.

The supported subtasks are benchmarks, which evaluate the performance of your model on different instance types.

", - "ListInferenceRecommendationsJobs": "

Lists recommendation jobs that satisfy various filters.

", - "ListJobSchemaVersions": "

Lists available configuration schema versions for a specified job category. Use the schema versions with DescribeJobSchemaVersion to retrieve the full schema document.

The following operations are related to ListJobSchemaVersions:

  • DescribeJobSchemaVersion

  • CreateJob

", - "ListJobs": "

Lists jobs in a specified category. You can filter results by creation time, last modified time, name, and status. Results are sorted by the field you specify in SortBy. Use pagination to retrieve large result sets efficiently.

The following operations are related to ListJobs:

  • CreateJob

  • DescribeJob

", - "ListLabelingJobs": "

Gets a list of labeling jobs.

", - "ListLabelingJobsForWorkteam": "

Gets a list of labeling jobs assigned to a specified work team.

", - "ListLineageGroups": "

A list of lineage groups shared with your Amazon Web Services account. For more information, see Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.

", - "ListMlflowApps": "

Lists all MLflow Apps

", - "ListMlflowTrackingServers": "

Lists all MLflow Tracking Servers.

", - "ListModelBiasJobDefinitions": "

Lists model bias jobs definitions that satisfy various filters.

", - "ListModelCardExportJobs": "

List the export jobs for the Amazon SageMaker Model Card.

", - "ListModelCardVersions": "

List existing versions of an Amazon SageMaker Model Card.

", - "ListModelCards": "

List existing model cards.

", - "ListModelExplainabilityJobDefinitions": "

Lists model explainability job definitions that satisfy various filters.

", - "ListModelMetadata": "

Lists the domain, framework, task, and model name of standard machine learning models found in common model zoos.

", - "ListModelPackageGroups": "

Gets a list of the model groups in your Amazon Web Services account.

", - "ListModelPackages": "

Lists the model packages that have been created.

", - "ListModelQualityJobDefinitions": "

Gets a list of model quality monitoring job definitions in your account.

", - "ListModels": "

Lists models created with the CreateModel API.

", - "ListMonitoringAlertHistory": "

Gets a list of past alerts in a model monitoring schedule.

", - "ListMonitoringAlerts": "

Gets the alerts for a single monitoring schedule.

", - "ListMonitoringExecutions": "

Returns list of all monitoring job executions.

", - "ListMonitoringSchedules": "

Returns list of all monitoring schedules.

", - "ListNotebookInstanceLifecycleConfigs": "

Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.

", - "ListNotebookInstances": "

Returns a list of the SageMaker AI notebook instances in the requester's account in an Amazon Web Services Region.

", - "ListOptimizationJobs": "

Lists the optimization jobs in your account and their properties.

", - "ListPartnerApps": "

Lists all of the SageMaker Partner AI Apps in an account.

", - "ListPipelineExecutionSteps": "

Gets a list of PipeLineExecutionStep objects.

", - "ListPipelineExecutions": "

Gets a list of the pipeline executions.

", - "ListPipelineParametersForExecution": "

Gets a list of parameters for a pipeline execution.

", - "ListPipelineVersions": "

Gets a list of all versions of the pipeline.

", - "ListPipelines": "

Gets a list of pipelines.

", - "ListProcessingJobs": "

Lists processing jobs that satisfy various filters.

", - "ListProjects": "

Gets a list of the projects in an Amazon Web Services account.

", - "ListResourceCatalogs": "

Lists Amazon SageMaker Catalogs based on given filters and orders. The maximum number of ResourceCatalogs viewable is 1000.

", - "ListSpaces": "

Lists spaces.

", - "ListStageDevices": "

Lists devices allocated to the stage, containing detailed device information and deployment status.

", - "ListStudioLifecycleConfigs": "

Lists the Amazon SageMaker AI Studio Lifecycle Configurations in your Amazon Web Services Account.

", - "ListSubscribedWorkteams": "

Gets a list of the work teams that you are subscribed to in the Amazon Web Services Marketplace. The list may be empty if no work team satisfies the filter specified in the NameContains parameter.

", - "ListTags": "

Returns the tags for the specified SageMaker resource.

", - "ListTrainingJobs": "

Lists training jobs.

When StatusEquals and MaxResults are set at the same time, the MaxResults number of training jobs are first retrieved ignoring the StatusEquals parameter and then they are filtered by the StatusEquals parameter, which is returned as a response.

For example, if ListTrainingJobs is invoked with the following parameters:

{ ... MaxResults: 100, StatusEquals: InProgress ... }

First, 100 trainings jobs with any status, including those other than InProgress, are selected (sorted according to the creation time, from the most current to the oldest). Next, those with a status of InProgress are returned.

You can quickly test the API using the following Amazon Web Services CLI code.

aws sagemaker list-training-jobs --max-results 100 --status-equals InProgress

", - "ListTrainingJobsForHyperParameterTuningJob": "

Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job launched.

", - "ListTrainingPlans": "

Retrieves a list of training plans for the current account.

", - "ListTransformJobs": "

Lists transform jobs.

", - "ListTrialComponents": "

Lists the trial components in your account. You can sort the list by trial component name or creation time. You can filter the list to show only components that were created in a specific time range. You can also filter on one of the following:

  • ExperimentName

  • SourceArn

  • TrialName

", - "ListTrials": "

Lists the trials in your account. Specify an experiment name to limit the list to the trials that are part of that experiment. Specify a trial component name to limit the list to the trials that associated with that trial component. The list can be filtered to show only trials that were created in a specific time range. The list can be sorted by trial name or creation time.

", - "ListUltraServersByReservedCapacity": "

Lists all UltraServers that are part of a specified reserved capacity.

", - "ListUserProfiles": "

Lists user profiles.

", - "ListWorkforces": "

Use this operation to list all private and vendor workforces in an Amazon Web Services Region. Note that you can only have one private workforce per Amazon Web Services Region.

", - "ListWorkteams": "

Gets a list of private work teams that you have defined in a region. The list may be empty if no work team satisfies the filter specified in the NameContains parameter.

", - "PutModelPackageGroupPolicy": "

Adds a resouce policy to control access to a model group. For information about resoure policies, see Identity-based policies and resource-based policies in the Amazon Web Services Identity and Access Management User Guide..

", - "QueryLineage": "

Use this action to inspect your lineage and discover relationships between entities. For more information, see Querying Lineage Entities in the Amazon SageMaker Developer Guide.

", - "RegisterDevices": "

Register devices.

", - "RenderUiTemplate": "

Renders the UI template so that you can preview the worker's experience.

", - "RetryPipelineExecution": "

Retry the execution of the pipeline.

", - "Search": "

Finds SageMaker resources that match a search query. Matching resources are returned as a list of SearchRecord objects in the response. You can sort the search results by any resource property in a ascending or descending order.

You can query against the following value types: numeric, text, Boolean, and timestamp.

The Search API may provide access to otherwise restricted data. See Amazon SageMaker API Permissions: Actions, Permissions, and Resources Reference for more information.

", - "SearchTrainingPlanOfferings": "

Searches for available training plan offerings based on specified criteria.

  • Users search for available plan offerings based on their requirements (e.g., instance type, count, start time, duration).

  • And then, they create a plan that best matches their needs using the ID of the plan offering they want to use.

For more information about how to reserve GPU capacity for your SageMaker training jobs or SageMaker HyperPod clusters using Amazon SageMaker Training Plan , see CreateTrainingPlan .

", - "SendPipelineExecutionStepFailure": "

Notifies the pipeline that the execution of a callback step failed, along with a message describing why. When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).

", - "SendPipelineExecutionStepSuccess": "

Notifies the pipeline that the execution of a callback step succeeded and provides a list of the step's output parameters. When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).

", - "StartClusterHealthCheck": "

Start deep health checks for a SageMaker HyperPod cluster. You can use DescribeClusterNode API to track progress of the deep health checks. The unhealthy nodes will be automatically rebooted or replaced. Please see Resilience-related Kubernetes labels by SageMaker HyperPod for details.

", - "StartEdgeDeploymentStage": "

Starts a stage in an edge deployment plan.

", - "StartInferenceExperiment": "

Starts an inference experiment.

", - "StartMlflowTrackingServer": "

Programmatically start an MLflow Tracking Server.

", - "StartMonitoringSchedule": "

Starts a previously stopped monitoring schedule.

By default, when you successfully create a new schedule, the status of a monitoring schedule is scheduled.

", - "StartNotebookInstance": "

Launches an ML compute instance with the latest version of the libraries and attaches your ML storage volume. After configuring the notebook instance, SageMaker AI sets the notebook instance status to InService. A notebook instance's status must be InService before you can connect to your Jupyter notebook.

", - "StartPipelineExecution": "

Starts a pipeline execution.

", - "StartSession": "

Initiates a remote connection session between a local integrated development environments (IDEs) and a remote SageMaker space.

", - "StopAIBenchmarkJob": "

Stops a running AI benchmark job.

", - "StopAIRecommendationJob": "

Stops a running AI recommendation job.

", - "StopAutoMLJob": "

A method for forcing a running job to shut down.

", - "StopCompilationJob": "

Stops a model compilation job.

To stop a job, Amazon SageMaker AI sends the algorithm the SIGTERM signal. This gracefully shuts the job down. If the job hasn't stopped, it sends the SIGKILL signal.

When it receives a StopCompilationJob request, Amazon SageMaker AI changes the CompilationJobStatus of the job to Stopping. After Amazon SageMaker stops the job, it sets the CompilationJobStatus to Stopped.

", - "StopEdgeDeploymentStage": "

Stops a stage in an edge deployment plan.

", - "StopEdgePackagingJob": "

Request to stop an edge packaging job.

", - "StopHyperParameterTuningJob": "

Stops a running hyperparameter tuning job and all running training jobs that the tuning job launched.

All model artifacts output from the training jobs are stored in Amazon Simple Storage Service (Amazon S3). All data that the training jobs write to Amazon CloudWatch Logs are still available in CloudWatch. After the tuning job moves to the Stopped state, it releases all reserved resources for the tuning job.

", - "StopInferenceExperiment": "

Stops an inference experiment.

", - "StopInferenceRecommendationsJob": "

Stops an Inference Recommender job.

", - "StopJob": "

Stops a running job. When you call StopJob, Amazon SageMaker sets the job status to Stopping. After the job stops, the status changes to Stopped. Partial results may be available in the output location if the job was in progress. To delete a stopped job, call DeleteJob.

The following operations are related to StopJob:

  • CreateJob

  • DescribeJob

  • DeleteJob

", - "StopLabelingJob": "

Stops a running labeling job. A job that is stopped cannot be restarted. Any results obtained before the job is stopped are placed in the Amazon S3 output bucket.

", - "StopMlflowTrackingServer": "

Programmatically stop an MLflow Tracking Server.

", - "StopMonitoringSchedule": "

Stops a previously started monitoring schedule.

", - "StopNotebookInstance": "

Terminates the ML compute instance. Before terminating the instance, SageMaker AI disconnects the ML storage volume from it. SageMaker AI preserves the ML storage volume. SageMaker AI stops charging you for the ML compute instance when you call StopNotebookInstance.

To access data on the ML storage volume for a notebook instance that has been terminated, call the StartNotebookInstance API. StartNotebookInstance launches another ML compute instance, configures it, and attaches the preserved ML storage volume so you can continue your work.

", - "StopOptimizationJob": "

Ends a running inference optimization job.

", - "StopPipelineExecution": "

Stops a pipeline execution.

Callback Step

A pipeline execution won't stop while a callback step is running. When you call StopPipelineExecution on a pipeline execution with a running callback step, SageMaker Pipelines sends an additional Amazon SQS message to the specified SQS queue. The body of the SQS message contains a \"Status\" field which is set to \"Stopping\".

You should add logic to your Amazon SQS message consumer to take any needed action (for example, resource cleanup) upon receipt of the message followed by a call to SendPipelineExecutionStepSuccess or SendPipelineExecutionStepFailure.

Only when SageMaker Pipelines receives one of these calls will it stop the pipeline execution.

Lambda Step

A pipeline execution can't be stopped while a lambda step is running because the Lambda function invoked by the lambda step can't be stopped. If you attempt to stop the execution while the Lambda function is running, the pipeline waits for the Lambda function to finish or until the timeout is hit, whichever occurs first, and then stops. If the Lambda function finishes, the pipeline execution status is Stopped. If the timeout is hit the pipeline execution status is Failed.

", - "StopProcessingJob": "

Stops a processing job.

", - "StopTrainingJob": "

Stops a training job. To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms might use this 120-second window to save the model artifacts, so the results of the training is not lost.

When it receives a StopTrainingJob request, SageMaker changes the status of the job to Stopping. After SageMaker stops the job, it sets the status to Stopped.

", - "StopTransformJob": "

Stops a batch transform job.

When Amazon SageMaker receives a StopTransformJob request, the status of the job changes to Stopping. After Amazon SageMaker stops the job, the status is set to Stopped. When you stop a batch transform job before it is completed, Amazon SageMaker doesn't store the job's output in Amazon S3.

", - "UpdateAction": "

Updates an action.

", - "UpdateAppImageConfig": "

Updates the properties of an AppImageConfig.

", - "UpdateArtifact": "

Updates an artifact.

", - "UpdateCluster": "

Updates a SageMaker HyperPod cluster.

", - "UpdateClusterSchedulerConfig": "

Update the cluster policy configuration.

", - "UpdateClusterSoftware": "

Updates the platform software of a SageMaker HyperPod cluster for security patching. To learn how to use this API, see Update the SageMaker HyperPod platform software of a cluster.

The UpgradeClusterSoftware API call may impact your SageMaker HyperPod cluster uptime and availability. Plan accordingly to mitigate potential disruptions to your workloads.

", - "UpdateCodeRepository": "

Updates the specified Git repository with the specified values.

", - "UpdateComputeQuota": "

Update the compute allocation definition.

", - "UpdateContext": "

Updates a context.

", - "UpdateDeviceFleet": "

Updates a fleet of devices.

", - "UpdateDevices": "

Updates one or more devices in a fleet.

", - "UpdateDomain": "

Updates the default settings for new user profiles in the domain.

", - "UpdateEndpoint": "

Deploys the EndpointConfig specified in the request to a new fleet of instances. SageMaker shifts endpoint traffic to the new instances with the updated endpoint configuration and then deletes the old instances using the previous EndpointConfig (there is no availability loss). For more information about how to control the update and traffic shifting process, see Update models in production.

When SageMaker receives the request, it sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.

You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.

If you delete the EndpointConfig of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges.

", - "UpdateEndpointWeightsAndCapacities": "

Updates variant weight of one or more variants associated with an existing endpoint, or capacity of one variant associated with an existing endpoint. When it receives the request, SageMaker sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.

", - "UpdateExperiment": "

Adds, updates, or removes the description of an experiment. Updates the display name of an experiment.

", - "UpdateFeatureGroup": "

Updates the feature group by either adding features or updating the online store configuration. Use one of the following request parameters at a time while using the UpdateFeatureGroup API.

You can add features for your feature group using the FeatureAdditions request parameter. Features cannot be removed from a feature group.

You can update the online store configuration by using the OnlineStoreConfig request parameter. If a TtlDuration is specified, the default TtlDuration applies for all records added to the feature group after the feature group is updated. If a record level TtlDuration exists from using the PutRecord API, the record level TtlDuration applies to that record instead of the default TtlDuration. To remove the default TtlDuration from an existing feature group, use the UpdateFeatureGroup API and set the TtlDuration Unit and Value to null.

", - "UpdateFeatureMetadata": "

Updates the description and parameters of the feature group.

", - "UpdateHub": "

Update a hub.

", - "UpdateHubContent": "

Updates SageMaker hub content (either a Model or Notebook resource).

You can update the metadata that describes the resource. In addition to the required request fields, specify at least one of the following fields to update:

  • HubContentDescription

  • HubContentDisplayName

  • HubContentMarkdown

  • HubContentSearchKeywords

  • SupportStatus

For more information about hubs, see Private curated hubs for foundation model access control in JumpStart.

If you want to update a ModelReference resource in your hub, use the UpdateHubContentResource API instead.

", - "UpdateHubContentReference": "

Updates the contents of a SageMaker hub for a ModelReference resource. A ModelReference allows you to access public SageMaker JumpStart models from within your private hub.

When using this API, you can update the MinVersion field for additional flexibility in the model version. You shouldn't update any additional fields when using this API, because the metadata in your private hub should match the public JumpStart model's metadata.

If you want to update a Model or Notebook resource in your hub, use the UpdateHubContent API instead.

For more information about adding model references to your hub, see Add models to a private hub.

", - "UpdateImage": "

Updates the properties of a SageMaker AI image. To change the image's tags, use the AddTags and DeleteTags APIs.

", - "UpdateImageVersion": "

Updates the properties of a SageMaker AI image version.

", - "UpdateInferenceComponent": "

Updates an inference component.

", - "UpdateInferenceComponentRuntimeConfig": "

Runtime settings for a model that is deployed with an inference component.

", - "UpdateInferenceExperiment": "

Updates an inference experiment that you created. The status of the inference experiment has to be either Created, Running. For more information on the status of an inference experiment, see DescribeInferenceExperiment.

", - "UpdateMlflowApp": "

Updates an MLflow App.

", - "UpdateMlflowTrackingServer": "

Updates properties of an existing MLflow Tracking Server.

", - "UpdateModelCard": "

Update an Amazon SageMaker Model Card.

You cannot update both model card content and model card status in a single call.

", - "UpdateModelPackage": "

Updates a versioned model.

", - "UpdateMonitoringAlert": "

Update the parameters of a model monitor alert.

", - "UpdateMonitoringSchedule": "

Updates a previously created schedule.

", - "UpdateNotebookInstance": "

Updates a notebook instance. NotebookInstance updates include upgrading or downgrading the ML compute instance used for your notebook instance to accommodate changes in your workload requirements.

This API can attach lifecycle configurations to notebook instances. Lifecycle configuration scripts execute with root access and the notebook instance's IAM execution role privileges. Principals with this permission and access to lifecycle configurations can execute code with the execution role's credentials. See Customize a Notebook Instance Using a Lifecycle Configuration Script for security best practices.

", - "UpdateNotebookInstanceLifecycleConfig": "

Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig API.

Updates to lifecycle configurations affect all notebook instances using that configuration upon their next start. Lifecycle configuration scripts execute with root access and the notebook instance's IAM execution role privileges. Grant this permission only to trusted principals. See Customize a Notebook Instance Using a Lifecycle Configuration Script for security best practices.

", - "UpdatePartnerApp": "

Updates all of the SageMaker Partner AI Apps in an account.

", - "UpdatePipeline": "

Updates a pipeline.

", - "UpdatePipelineExecution": "

Updates a pipeline execution.

", - "UpdatePipelineVersion": "

Updates a pipeline version.

", - "UpdateProject": "

Updates a machine learning (ML) project that is created from a template that sets up an ML pipeline from training to deploying an approved model.

You must not update a project that is in use. If you update the ServiceCatalogProvisioningUpdateDetails of a project that is active or being created, or updated, you may lose resources already created by the project.

", - "UpdateSpace": "

Updates the settings of a space.

You can't edit the app type of a space in the SpaceSettings.

", - "UpdateTrainingJob": "

Update a model training job to request a new Debugger profiling configuration or to change warm pool retention length.

", - "UpdateTrial": "

Updates the display name of a trial.

", - "UpdateTrialComponent": "

Updates one or more properties of a trial component.

", - "UpdateUserProfile": "

Updates a user profile.

", - "UpdateWorkforce": "

Use this operation to update your workforce. You can use this operation to require that workers use specific IP addresses to work on tasks and to update your OpenID Connect (OIDC) Identity Provider (IdP) workforce configuration.

The worker portal is now supported in VPC and public internet.

Use SourceIpConfig to restrict worker access to tasks to a specific range of IP addresses. You specify allowed IP addresses by creating a list of up to ten CIDRs. By default, a workforce isn't restricted to specific IP addresses. If you specify a range of IP addresses, workers who attempt to access tasks using any IP address outside the specified range are denied and get a Not Found error message on the worker portal.

To restrict public internet access for all workers, configure the SourceIpConfig CIDR value. For example, when using SourceIpConfig with an IpAddressType of IPv4, you can restrict access to the IPv4 CIDR block \"10.0.0.0/16\". When using an IpAddressType of dualstack, you can specify both the IPv4 and IPv6 CIDR blocks, such as \"10.0.0.0/16\" for IPv4 only, \"2001:db8:1234:1a00::/56\" for IPv6 only, or \"10.0.0.0/16\" and \"2001:db8:1234:1a00::/56\" for dual stack.

Amazon SageMaker does not support Source Ip restriction for worker portals in VPC.

Use OidcConfig to update the configuration of a workforce created using your own OIDC IdP.

You can only update your OIDC IdP configuration when there are no work teams associated with your workforce. You can delete work teams using the DeleteWorkteam operation.

After restricting access to a range of IP addresses or updating your OIDC IdP configuration with this operation, you can view details about your update workforce using the DescribeWorkforce operation.

This operation only applies to private workforces.

", - "UpdateWorkteam": "

Updates an existing work team with new member definitions or description.

" - }, - "shapes": { - "AIAdapterId": { - "base": "

A unique identifier for a LoRA adapter within a recommendation job request. The ID must start and end with an alphanumeric character, can contain hyphens between alphanumeric characters, and can be up to 63 characters long. This ID is used as the inference component name when the adapter is deployed.

", - "refs": { - "AIAdapterModelPackageEntry$AdapterId": "

A unique identifier for the adapter. This ID is used as the inference component name when the adapter is deployed. The ID must start and end with an alphanumeric character, can contain hyphens between alphanumeric characters, and can be up to 63 characters long.

", - "AIAdapterS3Entry$AdapterId": "

A unique identifier for the adapter. This ID is used as the inference component name when the adapter is deployed. The ID must start and end with an alphanumeric character, can contain hyphens between alphanumeric characters, and can be up to 63 characters long.

" - } - }, - "AIAdapterModelPackageEntry": { - "base": "

A LoRA adapter entry identified by a model package ARN.

", - "refs": { - "AIAdapterModelPackageEntryList$member": null - } - }, - "AIAdapterModelPackageEntryList": { - "base": null, - "refs": { - "AIAdapterSource$ModelPackageArns": "

A list of LoRA adapters identified by their model package ARNs. Use this when your adapters were produced by a SageMaker AI fine-tuning workflow that registers model packages.

", - "AIRecommendationAdapterDetails$ModelPackageArns": "

The list of LoRA adapters with their model package ARNs.

" - } - }, - "AIAdapterS3Entry": { - "base": "

A LoRA adapter entry identified by an Amazon S3 URI.

", - "refs": { - "AIAdapterS3EntryList$member": null - } - }, - "AIAdapterS3EntryList": { - "base": null, - "refs": { - "AIAdapterSource$S3Uris": "

A list of LoRA adapters identified by their Amazon S3 URIs. Use this when your adapters are stored as raw artifacts in Amazon S3.

", - "AIRecommendationAdapterDetails$S3Uris": "

The list of LoRA adapters with their Amazon S3 URIs.

" - } - }, - "AIAdapterSource": { - "base": "

The source of LoRA adapters for an AI recommendation job. This is a union type — specify exactly one of the members.

", - "refs": { - "CreateAIRecommendationJobRequest$AdapterSource": "

The LoRA adapter source for the recommendation job. Specify either a list of model package ARNs or Amazon S3 URIs for your LoRA adapters. When this parameter is absent, the recommendation job runs without LoRA adapter support.

", - "DescribeAIRecommendationJobResponse$AdapterSource": "

The LoRA adapter source that you specified when you created the recommendation job. This field is absent when you created the job without LoRA adapters.

" - } - }, - "AIBenchmarkEndpoint": { - "base": "

The SageMaker endpoint configuration for benchmarking.

", - "refs": { - "AIBenchmarkTarget$Endpoint": "

The SageMaker endpoint to benchmark.

" - } - }, - "AIBenchmarkInferenceComponent": { - "base": "

An inference component to benchmark.

", - "refs": { - "AIBenchmarkInferenceComponentList$member": null - } - }, - "AIBenchmarkInferenceComponentList": { - "base": null, - "refs": { - "AIBenchmarkEndpoint$InferenceComponents": "

The list of inference components to benchmark on the endpoint.

" - } - }, - "AIBenchmarkJobArn": { - "base": null, - "refs": { - "AIBenchmarkJobSummary$AIBenchmarkJobArn": "

The Amazon Resource Name (ARN) of the benchmark job.

", - "AIRecommendation$AIBenchmarkJobArn": "

The Amazon Resource Name (ARN) of the benchmark job associated with this recommendation.

", - "CreateAIBenchmarkJobResponse$AIBenchmarkJobArn": "

The Amazon Resource Name (ARN) of the created benchmark job.

", - "DeleteAIBenchmarkJobResponse$AIBenchmarkJobArn": "

The Amazon Resource Name (ARN) of the deleted benchmark job.

", - "DescribeAIBenchmarkJobResponse$AIBenchmarkJobArn": "

The Amazon Resource Name (ARN) of the AI benchmark job.

", - "StopAIBenchmarkJobResponse$AIBenchmarkJobArn": "

The Amazon Resource Name (ARN) of the stopped benchmark job.

" - } - }, - "AIBenchmarkJobStatus": { - "base": null, - "refs": { - "AIBenchmarkJobSummary$AIBenchmarkJobStatus": "

The status of the benchmark job.

", - "DescribeAIBenchmarkJobResponse$AIBenchmarkJobStatus": "

The status of the AI benchmark job.

", - "ListAIBenchmarkJobsRequest$StatusEquals": "

A filter that returns only benchmark jobs with the specified status.

" - } - }, - "AIBenchmarkJobSummary": { - "base": "

Summary information about an AI benchmark job.

", - "refs": { - "AIBenchmarkJobSummaryList$member": null - } - }, - "AIBenchmarkJobSummaryList": { - "base": null, - "refs": { - "ListAIBenchmarkJobsResponse$AIBenchmarkJobs": "

An array of AIBenchmarkJobSummary objects, one for each benchmark job that matches the specified filters.

" - } - }, - "AIBenchmarkNetworkConfig": { - "base": "

The network configuration for an AI benchmark job.

", - "refs": { - "CreateAIBenchmarkJobRequest$NetworkConfig": "

The network configuration for the benchmark job, including VPC settings.

", - "DescribeAIBenchmarkJobResponse$NetworkConfig": "

The network configuration for the benchmark job.

" - } - }, - "AIBenchmarkOutputConfig": { - "base": "

The output configuration for an AI benchmark job.

", - "refs": { - "CreateAIBenchmarkJobRequest$OutputConfig": "

The output configuration for the benchmark job, including the Amazon S3 location where benchmark results are stored.

" - } - }, - "AIBenchmarkOutputResult": { - "base": "

The output result of an AI benchmark job, including the Amazon S3 location and CloudWatch log information.

", - "refs": { - "DescribeAIBenchmarkJobResponse$OutputConfig": "

The output configuration for the benchmark job, including the Amazon S3 output location and CloudWatch log information.

" - } - }, - "AIBenchmarkTarget": { - "base": "

The target for an AI benchmark job. This is a union type — specify one of the members.

", - "refs": { - "CreateAIBenchmarkJobRequest$BenchmarkTarget": "

The target endpoint to benchmark. Specify a SageMaker endpoint by providing its name or Amazon Resource Name (ARN).

", - "DescribeAIBenchmarkJobResponse$BenchmarkTarget": "

The target endpoint that was benchmarked.

" - } - }, - "AICapacityReservationConfig": { - "base": "

The capacity reservation configuration for an AI recommendation job.

", - "refs": { - "AIRecommendationComputeSpec$CapacityReservationConfig": "

The capacity reservation configuration.

" - } - }, - "AICapacityReservationPreference": { - "base": null, - "refs": { - "AICapacityReservationConfig$CapacityReservationPreference": "

The capacity reservation preference. The only valid value is capacity-reservations-only.

" - } - }, - "AIChannelName": { - "base": null, - "refs": { - "AIRecommendationDeploymentS3Channel$ChannelName": "

A custom name for this Amazon S3 data channel.

", - "AIWorkloadInputDataConfig$ChannelName": "

The logical name for the data channel.

" - } - }, - "AICloudWatchLogs": { - "base": "

CloudWatch log information for an AI benchmark or recommendation job.

", - "refs": { - "AICloudWatchLogsList$member": null - } - }, - "AICloudWatchLogsList": { - "base": null, - "refs": { - "AIBenchmarkOutputResult$CloudWatchLogs": "

The CloudWatch log information for the benchmark job.

" - } - }, - "AIDatasetConfig": { - "base": "

The dataset configuration for an AI workload. This is a union type — specify one of the members.

", - "refs": { - "CreateAIWorkloadConfigRequest$DatasetConfig": "

The dataset configuration for the workload. Specify input data channels with their data sources for benchmark workloads.

", - "DescribeAIWorkloadConfigResponse$DatasetConfig": "

The dataset configuration for the workload.

" - } - }, - "AIEntityName": { - "base": null, - "refs": { - "AIBenchmarkJobSummary$AIBenchmarkJobName": "

The name of the benchmark job.

", - "AIBenchmarkJobSummary$AIWorkloadConfigName": "

The name of the AI workload configuration used by the benchmark job.

", - "AIRecommendationJobSummary$AIRecommendationJobName": "

The name of the recommendation job.

", - "AIWorkloadConfigSummary$AIWorkloadConfigName": "

The name of the AI workload configuration.

", - "CreateAIBenchmarkJobRequest$AIBenchmarkJobName": "

The name of the AI benchmark job. The name must be unique within your Amazon Web Services account in the current Amazon Web Services Region.

", - "CreateAIRecommendationJobRequest$AIRecommendationJobName": "

The name of the AI recommendation job. The name must be unique within your Amazon Web Services account in the current Amazon Web Services Region.

", - "CreateAIWorkloadConfigRequest$AIWorkloadConfigName": "

The name of the AI workload configuration. The name must be unique within your Amazon Web Services account in the current Amazon Web Services Region.

", - "DeleteAIBenchmarkJobRequest$AIBenchmarkJobName": "

The name of the AI benchmark job to delete.

", - "DeleteAIRecommendationJobRequest$AIRecommendationJobName": "

The name of the AI recommendation job to delete.

", - "DeleteAIWorkloadConfigRequest$AIWorkloadConfigName": "

The name of the AI workload configuration to delete.

", - "DescribeAIBenchmarkJobRequest$AIBenchmarkJobName": "

The name of the AI benchmark job to describe.

", - "DescribeAIBenchmarkJobResponse$AIBenchmarkJobName": "

The name of the AI benchmark job.

", - "DescribeAIRecommendationJobRequest$AIRecommendationJobName": "

The name of the AI recommendation job to describe.

", - "DescribeAIRecommendationJobResponse$AIRecommendationJobName": "

The name of the AI recommendation job.

", - "DescribeAIWorkloadConfigRequest$AIWorkloadConfigName": "

The name of the AI workload configuration to describe.

", - "DescribeAIWorkloadConfigResponse$AIWorkloadConfigName": "

The name of the AI workload configuration.

", - "StopAIBenchmarkJobRequest$AIBenchmarkJobName": "

The name of the AI benchmark job to stop.

", - "StopAIRecommendationJobRequest$AIRecommendationJobName": "

The name of the AI recommendation job to stop.

" - } - }, - "AIInferenceSpecificationName": { - "base": null, - "refs": { - "AIRecommendationModelDetails$InferenceSpecificationName": "

The name of the inference specification within the model package.

" - } - }, - "AIMlReservationArn": { - "base": null, - "refs": { - "AIMlReservationArnList$member": null - } - }, - "AIMlReservationArnList": { - "base": null, - "refs": { - "AICapacityReservationConfig$MlReservationArns": "

The list of ML reservation ARNs to use.

" - } - }, - "AIMlflowConfig": { - "base": "

The MLflow tracking configuration for logging metrics and parameters to a SageMaker managed MLflow tracking server.

", - "refs": { - "AIBenchmarkOutputConfig$MlflowConfig": "

The MLflow tracking configuration for the job. If you don't specify this parameter, MLflow tracking is disabled.

", - "AIBenchmarkOutputResult$MlflowConfig": "

The MLflow tracking configuration for the job.

", - "AIRecommendationOutputConfig$MlflowConfig": "

The MLflow tracking configuration for the job. If you don't specify this parameter, MLflow tracking is disabled.

", - "AIRecommendationOutputResult$MlflowConfig": "

The MLflow tracking configuration for the job.

" - } - }, - "AIMlflowExperimentName": { - "base": null, - "refs": { - "AIMlflowConfig$MlflowExperimentName": "

The MLflow experiment name used for tracking.

" - } - }, - "AIMlflowResourceArn": { - "base": null, - "refs": { - "AIMlflowConfig$MlflowResourceArn": "

The Amazon Resource Name (ARN) of the SageMaker managed MLflow resource.

" - } - }, - "AIMlflowRunName": { - "base": null, - "refs": { - "AIMlflowConfig$MlflowRunName": "

The MLflow run name used for tracking.

" - } - }, - "AIModelSource": { - "base": "

The source of the model for an AI recommendation job. This is a union type.

", - "refs": { - "CreateAIRecommendationJobRequest$ModelSource": "

The source of the model to optimize. Specify the Amazon S3 location of the model artifacts.

", - "DescribeAIRecommendationJobResponse$ModelSource": "

The source of the model that was analyzed.

" - } - }, - "AIModelSourceS3": { - "base": "

The Amazon S3 model source configuration.

", - "refs": { - "AIModelSource$S3": "

The Amazon S3 location of the model artifacts.

" - } - }, - "AIRecommendation": { - "base": "

An optimization recommendation generated by an AI recommendation job.

", - "refs": { - "AIRecommendationList$member": null - } - }, - "AIRecommendationAdapterDetails": { - "base": "

The per-recommendation LoRA adapter details. Contains both the model package ARNs and Amazon S3 URIs for each adapter, regardless of which form was originally supplied in the request. When you supply only Amazon S3 URIs, Amazon SageMaker AI creates model packages on your behalf.

", - "refs": { - "AIRecommendation$AdapterDetails": "

The LoRA adapter details for this recommendation. This field contains both the model package ARNs and Amazon S3 URIs for each adapter, regardless of which form was originally supplied. This field is absent when the job was created without LoRA adapters.

" - } - }, - "AIRecommendationAllowOptimization": { - "base": null, - "refs": { - "CreateAIRecommendationJobRequest$OptimizeModel": "

Whether to allow model optimization techniques such as quantization, speculative decoding, and kernel tuning. The default is true.

", - "DescribeAIRecommendationJobResponse$OptimizeModel": "

Whether model optimization techniques were allowed.

" - } - }, - "AIRecommendationComputeSpec": { - "base": "

The compute resource specification for an AI recommendation job.

", - "refs": { - "CreateAIRecommendationJobRequest$ComputeSpec": "

The compute resource specification for the recommendation job. You can specify up to 3 instance types to consider, and optionally provide capacity reservation configuration.

", - "DescribeAIRecommendationJobResponse$ComputeSpec": "

The compute resource specification for the recommendation job.

" - } - }, - "AIRecommendationConstraint": { - "base": "

A performance constraint for an AI recommendation job.

", - "refs": { - "AIRecommendationConstraintList$member": null - } - }, - "AIRecommendationConstraintList": { - "base": null, - "refs": { - "AIRecommendationPerformanceTarget$Constraints": "

An array of performance constraints that define the optimization objectives.

" - } - }, - "AIRecommendationCopyCountPerInstance": { - "base": null, - "refs": { - "AIRecommendationDeploymentConfiguration$CopyCountPerInstance": "

The number of model copies per instance.

", - "AIRecommendationInstanceDetail$CopyCountPerInstance": "

The number of model copies per instance.

" - } - }, - "AIRecommendationDeploymentConfiguration": { - "base": "

The deployment configuration for a recommendation.

", - "refs": { - "AIRecommendation$DeploymentConfiguration": "

The deployment configuration for this recommendation, including the container image, instance type, instance count, and environment variables.

" - } - }, - "AIRecommendationDeploymentS3Channel": { - "base": "

An Amazon S3 data channel for a recommended deployment configuration, containing model artifacts or optimized model outputs.

", - "refs": { - "AIRecommendationDeploymentS3ChannelList$member": null - } - }, - "AIRecommendationDeploymentS3ChannelList": { - "base": null, - "refs": { - "AIRecommendationDeploymentConfiguration$S3": "

The Amazon S3 data channels for the deployment.

" - } - }, - "AIRecommendationInferenceFramework": { - "base": null, - "refs": { - "AIRecommendationInferenceSpecification$Framework": "

The inference framework. Valid values are LMI and VLLM.

" - } - }, - "AIRecommendationInferenceSpecification": { - "base": "

The inference framework for an AI recommendation job.

", - "refs": { - "CreateAIRecommendationJobRequest$InferenceSpecification": "

The inference framework configuration. Specify the framework (such as LMI or vLLM) for the recommendation job.

", - "DescribeAIRecommendationJobResponse$InferenceSpecification": "

The inference framework configuration.

" - } - }, - "AIRecommendationInstanceCount": { - "base": null, - "refs": { - "AIRecommendationDeploymentConfiguration$InstanceCount": "

The recommended number of instances for the deployment.

", - "AIRecommendationInstanceDetail$InstanceCount": "

The recommended number of instances.

" - } - }, - "AIRecommendationInstanceDetail": { - "base": "

Instance details for a recommendation.

", - "refs": { - "AIRecommendationInstanceDetailList$member": null - } - }, - "AIRecommendationInstanceDetailList": { - "base": null, - "refs": { - "AIRecommendationModelDetails$InstanceDetails": "

The instance details for this recommendation, including instance type, count, and model copies per instance.

" - } - }, - "AIRecommendationInstanceType": { - "base": null, - "refs": { - "AIRecommendationDeploymentConfiguration$InstanceType": "

The recommended instance type for the deployment.

", - "AIRecommendationInstanceDetail$InstanceType": "

The recommended instance type.

", - "AIRecommendationInstanceTypeList$member": null - } - }, - "AIRecommendationInstanceTypeList": { - "base": null, - "refs": { - "AIRecommendationComputeSpec$InstanceTypes": "

The list of instance types to consider for recommendations. You can specify up to 3 instance types.

" - } - }, - "AIRecommendationJobArn": { - "base": null, - "refs": { - "AIRecommendationJobSummary$AIRecommendationJobArn": "

The Amazon Resource Name (ARN) of the recommendation job.

", - "CreateAIRecommendationJobResponse$AIRecommendationJobArn": "

The Amazon Resource Name (ARN) of the created recommendation job.

", - "DeleteAIRecommendationJobResponse$AIRecommendationJobArn": "

The Amazon Resource Name (ARN) of the deleted recommendation job.

", - "DescribeAIRecommendationJobResponse$AIRecommendationJobArn": "

The Amazon Resource Name (ARN) of the AI recommendation job.

", - "StopAIRecommendationJobResponse$AIRecommendationJobArn": "

The Amazon Resource Name (ARN) of the stopped recommendation job.

" - } - }, - "AIRecommendationJobStatus": { - "base": null, - "refs": { - "AIRecommendationJobSummary$AIRecommendationJobStatus": "

The status of the recommendation job.

", - "DescribeAIRecommendationJobResponse$AIRecommendationJobStatus": "

The status of the AI recommendation job.

", - "ListAIRecommendationJobsRequest$StatusEquals": "

A filter that returns only recommendation jobs with the specified status.

" - } - }, - "AIRecommendationJobSummary": { - "base": "

Summary information about an AI recommendation job.

", - "refs": { - "AIRecommendationJobSummaryList$member": null - } - }, - "AIRecommendationJobSummaryList": { - "base": null, - "refs": { - "ListAIRecommendationJobsResponse$AIRecommendationJobs": "

An array of AIRecommendationJobSummary objects, one for each recommendation job that matches the specified filters.

" - } - }, - "AIRecommendationList": { - "base": null, - "refs": { - "DescribeAIRecommendationJobResponse$Recommendations": "

The list of optimization recommendations generated by the job. Each recommendation includes optimization details, deployment configuration, expected performance metrics, and the associated benchmark job ARN.

" - } - }, - "AIRecommendationMetric": { - "base": null, - "refs": { - "AIRecommendationConstraint$Metric": "

The performance metric. Valid values are ttft-ms (time to first token in milliseconds), throughput, and cost.

" - } - }, - "AIRecommendationMinCpuMemoryRequiredInMb": { - "base": null, - "refs": { - "AIRecommendationDeploymentConfiguration$MinCpuMemoryRequiredInMb": "

The minimum host (CPU) memory, in MiB, to reserve for each model copy when deploying the recommendation as an Inference Component. This value maps to the Inference Component's ComputeResourceRequirements$MinMemoryRequiredInMb field.

" - } - }, - "AIRecommendationModelDetails": { - "base": "

Details about the model package in a recommendation.

", - "refs": { - "AIRecommendation$ModelDetails": "

Details about the model package associated with this recommendation.

" - } - }, - "AIRecommendationOptimizationConfigMap": { - "base": null, - "refs": { - "AIRecommendationOptimizationDetail$OptimizationConfig": "

A map of configuration parameters for the optimization technique.

" - } - }, - "AIRecommendationOptimizationDetail": { - "base": "

Details about an optimization technique applied in a recommendation.

", - "refs": { - "AIRecommendationOptimizationDetailList$member": null - } - }, - "AIRecommendationOptimizationDetailList": { - "base": null, - "refs": { - "AIRecommendation$OptimizationDetails": "

The optimization techniques applied in this recommendation.

" - } - }, - "AIRecommendationOptimizationType": { - "base": null, - "refs": { - "AIRecommendationOptimizationDetail$OptimizationType": "

The type of optimization. Valid values are SpeculativeDecoding and KernelTuning.

" - } - }, - "AIRecommendationOutputConfig": { - "base": "

The output configuration for an AI recommendation job.

", - "refs": { - "CreateAIRecommendationJobRequest$OutputConfig": "

The output configuration for the recommendation job, including the Amazon S3 location for results and an optional model package group where the optimized model is registered.

" - } - }, - "AIRecommendationOutputResult": { - "base": "

The output configuration for an AI recommendation job, including the S3 location for results and the model package group for deployment.

", - "refs": { - "DescribeAIRecommendationJobResponse$OutputConfig": "

The output configuration for the recommendation job.

" - } - }, - "AIRecommendationPerformanceMetric": { - "base": "

An expected performance metric for a recommendation.

", - "refs": { - "ExpectedPerformanceList$member": null - } - }, - "AIRecommendationPerformanceTarget": { - "base": "

The performance targets for an AI recommendation job.

", - "refs": { - "CreateAIRecommendationJobRequest$PerformanceTarget": "

The performance targets for the recommendation job. Specify constraints on metrics such as time to first token (ttft-ms), throughput, or cost.

", - "DescribeAIRecommendationJobResponse$PerformanceTarget": "

The performance targets specified for the recommendation job.

" - } - }, - "AIResourceIdentifier": { - "base": null, - "refs": { - "AIBenchmarkEndpoint$Identifier": "

The name or Amazon Resource Name (ARN) of the SageMaker endpoint to benchmark.

", - "AIBenchmarkInferenceComponent$Identifier": "

The name or Amazon Resource Name (ARN) of the inference component.

", - "AIRecommendationOutputConfig$ModelPackageGroupIdentifier": "

The name or Amazon Resource Name (ARN) of the model package group where the optimized model is registered as a new model package version.

", - "AIRecommendationOutputResult$ModelPackageGroupIdentifier": "

The name or Amazon Resource Name (ARN) of the model package group where deployment-ready model packages are registered.

", - "CreateAIBenchmarkJobRequest$AIWorkloadConfigIdentifier": "

The name or Amazon Resource Name (ARN) of the AI workload configuration to use for this benchmark job.

", - "CreateAIRecommendationJobRequest$AIWorkloadConfigIdentifier": "

The name or Amazon Resource Name (ARN) of the AI workload configuration to use for this recommendation job.

", - "DescribeAIBenchmarkJobResponse$AIWorkloadConfigIdentifier": "

The name or Amazon Resource Name (ARN) of the AI workload configuration used for this benchmark job.

", - "DescribeAIRecommendationJobResponse$AIWorkloadConfigIdentifier": "

The name or Amazon Resource Name (ARN) of the AI workload configuration used for this recommendation job.

" - } - }, - "AIWorkloadConfigArn": { - "base": null, - "refs": { - "AIWorkloadConfigSummary$AIWorkloadConfigArn": "

The Amazon Resource Name (ARN) of the AI workload configuration.

", - "CreateAIWorkloadConfigResponse$AIWorkloadConfigArn": "

The Amazon Resource Name (ARN) of the created AI workload configuration.

", - "DeleteAIWorkloadConfigResponse$AIWorkloadConfigArn": "

The Amazon Resource Name (ARN) of the deleted AI workload configuration.

", - "DescribeAIWorkloadConfigResponse$AIWorkloadConfigArn": "

The Amazon Resource Name (ARN) of the AI workload configuration.

" - } - }, - "AIWorkloadConfigSummary": { - "base": "

Summary information about an AI workload configuration.

", - "refs": { - "AIWorkloadConfigSummaryList$member": null - } - }, - "AIWorkloadConfigSummaryList": { - "base": null, - "refs": { - "ListAIWorkloadConfigsResponse$AIWorkloadConfigs": "

An array of AIWorkloadConfigSummary objects, one for each AI workload configuration that matches the specified filters.

" - } - }, - "AIWorkloadConfigs": { - "base": "

The benchmark tool configuration for an AI workload.

", - "refs": { - "CreateAIWorkloadConfigRequest$AIWorkloadConfigs": "

The benchmark tool configuration and workload specification. Provide the specification as an inline YAML or JSON string.

", - "DescribeAIWorkloadConfigResponse$AIWorkloadConfigs": "

The benchmark tool configuration and workload specification.

" - } - }, - "AIWorkloadDataSource": { - "base": "

The data source for an AI workload input data channel.

", - "refs": { - "AIWorkloadInputDataConfig$DataSource": "

The data source for this channel.

" - } - }, - "AIWorkloadInputDataConfig": { - "base": "

A channel of input data for an AI workload configuration. Each channel has a name and a data source.

", - "refs": { - "AIWorkloadInputDataConfigList$member": null - } - }, - "AIWorkloadInputDataConfigList": { - "base": null, - "refs": { - "AIDatasetConfig$InputDataConfig": "

An array of input data channel configurations for the workload.

" - } - }, - "AIWorkloadS3DataSource": { - "base": "

The Amazon S3 data source for an AI workload.

", - "refs": { - "AIWorkloadDataSource$S3DataSource": "

The Amazon S3 data source configuration.

" - } - }, - "AbsoluteBorrowLimitResourceList": { - "base": null, - "refs": { - "ResourceSharingConfig$AbsoluteBorrowLimits": "

The absolute limits on compute resources that can be borrowed from idle compute. When specified, these limits define the maximum amount of specific resource types (such as accelerators, vCPU, or memory) that an entity can borrow, regardless of the percentage-based BorrowLimit.

" - } - }, - "AcceleratorPartitionConfig": { - "base": "

Configuration for allocating accelerator partitions.

", - "refs": { - "ComputeQuotaResourceConfig$AcceleratorPartition": "

The accelerator partition configuration for fractional GPU allocation.

" - } - }, - "AcceleratorPartitionConfigCountInteger": { - "base": null, - "refs": { - "AcceleratorPartitionConfig$Count": "

The number of accelerator partitions to allocate with the specified partition type. If you don't specify a value for vCPU and MemoryInGiB, SageMaker AI automatically allocates ratio-based values for those parameters based on the accelerator partition count you provide.

" - } - }, - "AcceleratorsAmount": { - "base": null, - "refs": { - "ComputeQuotaResourceConfig$Accelerators": "

The number of accelerators to allocate. If you don't specify a value for vCPU and MemoryInGiB, SageMaker AI automatically allocates ratio-based values for those parameters based on the number of accelerators you provide. For example, if you allocate 16 out of 32 total accelerators, SageMaker AI uses the ratio of 0.5 and allocates values to vCPU and MemoryInGiB.

" - } - }, - "Accept": { - "base": null, - "refs": { - "TransformOutput$Accept": "

The MIME type used to specify the output data. Amazon SageMaker uses the MIME type with each http call to transfer data from the transform job.

" - } - }, - "AcceptEula": { - "base": null, - "refs": { - "ModelAccessConfig$AcceptEula": "

Specifies agreement to the model end-user license agreement (EULA). The AcceptEula value must be explicitly defined as True in order to accept the EULA that this model requires. You are responsible for reviewing and complying with any applicable license terms and making sure they are acceptable for your use case before downloading or using a model.

", - "ServerlessJobConfig$AcceptEula": "

Specifies agreement to the model end-user license agreement (EULA). The AcceptEula value must be explicitly defined as True in order to accept the EULA that this model requires. You are responsible for reviewing and complying with any applicable license terms and making sure they are acceptable for your use case before downloading or using a model. For more information, see End-user license agreements section for more details on accepting the EULA.

" - } - }, - "AccountDefaultStatus": { - "base": null, - "refs": { - "CreateMlflowAppRequest$AccountDefaultStatus": "

Indicates whether this MLflow app is the default for the entire account.

", - "DescribeMlflowAppResponse$AccountDefaultStatus": "

Indicates whether this MLflow app is the default for the entire account.

", - "ListMlflowAppsRequest$AccountDefaultStatus": "

Filter for MLflow Apps with the specified AccountDefaultStatus.

", - "UpdateMlflowAppRequest$AccountDefaultStatus": "

Indicates whether this this MLflow App is the default for the account.

" - } - }, - "AccountId": { - "base": null, - "refs": { - "CreateMlflowTrackingServerRequest$S3BucketOwnerAccountId": "

Expected Amazon Web Services account ID that owns the Amazon S3 bucket for artifact storage. Defaults to caller's account ID if not provided.

", - "DescribeMlflowTrackingServerResponse$S3BucketOwnerAccountId": "

Expected Amazon Web Services account ID that owns the Amazon S3 bucket for artifact storage.

", - "LabelingJobForWorkteamSummary$WorkRequesterAccountId": "

The Amazon Web Services account ID of the account used to start the labeling job.

", - "UnifiedStudioSettings$DomainAccountId": "

The ID of the Amazon Web Services account that has the Amazon SageMaker Unified Studio domain. The default value, if you don't specify an ID, is the ID of the account that has the Amazon SageMaker AI domain.

", - "UpdateMlflowTrackingServerRequest$S3BucketOwnerAccountId": "

The new expected Amazon Web Services account ID that owns the Amazon S3 bucket for artifact storage.

", - "VpcOnlyTrustedAccounts$member": null - } - }, - "ActionArn": { - "base": null, - "refs": { - "ActionSummary$ActionArn": "

The Amazon Resource Name (ARN) of the action.

", - "CreateActionResponse$ActionArn": "

The Amazon Resource Name (ARN) of the action.

", - "DeleteActionResponse$ActionArn": "

The Amazon Resource Name (ARN) of the action.

", - "DescribeActionResponse$ActionArn": "

The Amazon Resource Name (ARN) of the action.

", - "UpdateActionResponse$ActionArn": "

The Amazon Resource Name (ARN) of the action.

" - } - }, - "ActionSource": { - "base": "

A structure describing the source of an action.

", - "refs": { - "ActionSummary$Source": "

The source of the action.

", - "CreateActionRequest$Source": "

The source type, ID, and URI.

", - "DescribeActionResponse$Source": "

The source of the action.

" - } - }, - "ActionStatus": { - "base": null, - "refs": { - "ActionSummary$Status": "

The status of the action.

", - "CreateActionRequest$Status": "

The status of the action.

", - "DescribeActionResponse$Status": "

The status of the action.

", - "UpdateActionRequest$Status": "

The new status for the action.

" - } - }, - "ActionSummaries": { - "base": null, - "refs": { - "ListActionsResponse$ActionSummaries": "

A list of actions and their properties.

" - } - }, - "ActionSummary": { - "base": "

Lists the properties of an action. An action represents an action or activity. Some examples are a workflow step and a model deployment. Generally, an action involves at least one input artifact or output artifact.

", - "refs": { - "ActionSummaries$member": null - } - }, - "ActivationState": { - "base": null, - "refs": { - "ComputeQuotaSummary$ActivationState": "

The state of the compute allocation being described. Use to enable or disable compute allocation.

Default is Enabled.

", - "CreateComputeQuotaRequest$ActivationState": "

The state of the compute allocation being described. Use to enable or disable compute allocation.

Default is Enabled.

", - "DescribeComputeQuotaResponse$ActivationState": "

The state of the compute allocation being described. Use to enable or disable compute allocation.

Default is Enabled.

", - "UpdateComputeQuotaRequest$ActivationState": "

The state of the compute allocation being described. Use to enable or disable compute allocation.

Default is Enabled.

" - } - }, - "ActiveClusterOperationCount": { - "base": null, - "refs": { - "ActiveOperations$value": null - } - }, - "ActiveClusterOperationName": { - "base": null, - "refs": { - "ActiveOperations$key": null - } - }, - "ActiveOperations": { - "base": null, - "refs": { - "ClusterInstanceGroupDetails$ActiveOperations": "

A map indicating active operations currently in progress for the instance group of a SageMaker HyperPod cluster. When there is a scaling operation in progress, this map contains a key Scaling with value 1.

" - } - }, - "AddAssociationRequest": { - "base": null, - "refs": {} - }, - "AddAssociationResponse": { - "base": null, - "refs": {} - }, - "AddClusterNodeSpecification": { - "base": "

Specifies an instance group and the number of nodes to add to it.

", - "refs": { - "AddClusterNodeSpecificationList$member": null - } - }, - "AddClusterNodeSpecificationIncrementTargetCountByInteger": { - "base": null, - "refs": { - "AddClusterNodeSpecification$IncrementTargetCountBy": "

The number of nodes to add to the specified instance group. The total number of nodes across all instance groups in a single request cannot exceed 50.

" - } - }, - "AddClusterNodeSpecificationList": { - "base": null, - "refs": { - "BatchAddClusterNodesRequest$NodesToAdd": "

A list of instance groups and the number of nodes to add to each. You can specify up to 5 instance groups in a single request, with a maximum of 50 nodes total across all instance groups.

" - } - }, - "AddTagsInput": { - "base": null, - "refs": {} - }, - "AddTagsOutput": { - "base": null, - "refs": {} - }, - "AdditionalCodeRepositoryNamesOrUrls": { - "base": null, - "refs": { - "CreateNotebookInstanceInput$AdditionalCodeRepositories": "

An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker AI Notebook Instances.

", - "DescribeNotebookInstanceOutput$AdditionalCodeRepositories": "

An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker AI Notebook Instances.

", - "NotebookInstanceSummary$AdditionalCodeRepositories": "

An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker AI Notebook Instances.

", - "UpdateNotebookInstanceInput$AdditionalCodeRepositories": "

An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker AI Notebook Instances.

" - } - }, - "AdditionalEnis": { - "base": "

Information about additional Elastic Network Interfaces (ENIs) associated with an instance.

", - "refs": { - "InstanceMetadata$AdditionalEnis": "

Information about additional Elastic Network Interfaces (ENIs) associated with the instance.

", - "InstanceRequirementsEniConfiguration$AdditionalEnis": "

Information about additional Elastic Network Interfaces (ENIs) associated with the instance type category.

" - } - }, - "AdditionalInferenceSpecificationDefinition": { - "base": "

A structure of additional Inference Specification. Additional Inference Specification specifies details about inference jobs that can be run with models based on this model package

", - "refs": { - "AdditionalInferenceSpecifications$member": null - } - }, - "AdditionalInferenceSpecifications": { - "base": null, - "refs": { - "CreateModelPackageInput$AdditionalInferenceSpecifications": "

An array of additional Inference Specification objects. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

", - "DescribeModelPackageOutput$AdditionalInferenceSpecifications": "

An array of additional Inference Specification objects. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

", - "ModelPackage$AdditionalInferenceSpecifications": "

An array of additional Inference Specification objects.

", - "UpdateModelPackageInput$AdditionalInferenceSpecificationsToAdd": "

An array of additional Inference Specification objects to be added to the existing array additional Inference Specification. Total number of additional Inference Specifications can not exceed 15. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

" - } - }, - "AdditionalModelChannelName": { - "base": null, - "refs": { - "AdditionalModelDataSource$ChannelName": "

A custom name for this AdditionalModelDataSource object.

" - } - }, - "AdditionalModelDataSource": { - "base": "

Data sources that are available to your model in addition to the one that you specify for ModelDataSource when you use the CreateModel action.

", - "refs": { - "AdditionalModelDataSources$member": null - } - }, - "AdditionalModelDataSources": { - "base": null, - "refs": { - "ContainerDefinition$AdditionalModelDataSources": "

Data sources that are available to your model in addition to the one that you specify for ModelDataSource when you use the CreateModel action.

", - "ModelPackageContainerDefinition$AdditionalModelDataSources": "

Data sources that are available to your model in addition to the one that you specify for ModelDataSource when you use the CreateModelPackage action.

" - } - }, - "AdditionalS3DataSource": { - "base": "

A data source used for training or inference that is in addition to the input dataset or model data.

", - "refs": { - "ModelPackageContainerDefinition$AdditionalS3DataSource": "

The additional data source that is used during inference in the Docker container for your model package.

", - "TrainingSpecification$AdditionalS3DataSource": "

The additional data source used during the training job.

" - } - }, - "AdditionalS3DataSourceDataType": { - "base": null, - "refs": { - "AdditionalS3DataSource$S3DataType": "

The data type of the additional data source that you specify for use in inference or training.

" - } - }, - "AgentVersion": { - "base": "

Edge Manager agent version.

", - "refs": { - "AgentVersions$member": null - } - }, - "AgentVersions": { - "base": null, - "refs": { - "GetDeviceFleetReportResponse$AgentVersions": "

The versions of Edge Manager agent deployed on the fleet.

" - } - }, - "AggregationTransformationValue": { - "base": null, - "refs": { - "AggregationTransformations$value": null - } - }, - "AggregationTransformations": { - "base": null, - "refs": { - "TimeSeriesTransformations$Aggregation": "

A key value pair defining the aggregation method for a column, where the key is the column name and the value is the aggregation method.

The supported aggregation methods are sum (default), avg, first, min, max.

Aggregation is only supported for the target column.

" - } - }, - "Alarm": { - "base": "

An Amazon CloudWatch alarm configured to monitor metrics on an endpoint.

", - "refs": { - "AlarmList$member": null - } - }, - "AlarmDetails": { - "base": "

The details of the alarm to monitor during the AMI update.

", - "refs": { - "AutoRollbackAlarms$member": null - } - }, - "AlarmList": { - "base": null, - "refs": { - "AutoRollbackConfig$Alarms": "

List of CloudWatch alarms in your account that are configured to monitor metrics on an endpoint. If any alarms are tripped during a deployment, SageMaker rolls back the deployment.

" - } - }, - "AlarmName": { - "base": null, - "refs": { - "Alarm$AlarmName": "

The name of a CloudWatch alarm in your account.

", - "AlarmDetails$AlarmName": "

The name of the alarm.

" - } - }, - "AlgorithmArn": { - "base": null, - "refs": { - "AlgorithmSummary$AlgorithmArn": "

The Amazon Resource Name (ARN) of the algorithm.

", - "CreateAlgorithmOutput$AlgorithmArn": "

The Amazon Resource Name (ARN) of the new algorithm.

", - "DescribeAlgorithmOutput$AlgorithmArn": "

The Amazon Resource Name (ARN) of the algorithm.

" - } - }, - "AlgorithmImage": { - "base": null, - "refs": { - "AlgorithmSpecification$TrainingImage": "

The registry path of the Docker image that contains the training algorithm. For information about docker registry paths for SageMaker built-in algorithms, see Docker Registry Paths and Example Code in the Amazon SageMaker developer guide. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information about using your custom training container, see Using Your Own Algorithms with Amazon SageMaker.

You must specify either the algorithm name to the AlgorithmName parameter or the image URI of the algorithm container to the TrainingImage parameter.

For more information, see the note in the AlgorithmName parameter description.

", - "DebugRuleConfiguration$RuleEvaluatorImage": "

The Amazon Elastic Container (ECR) Image for the managed rule evaluation.

", - "HyperParameterAlgorithmSpecification$TrainingImage": "

The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

", - "ProfilerRuleConfiguration$RuleEvaluatorImage": "

The Amazon Elastic Container Registry Image for the managed rule evaluation.

" - } - }, - "AlgorithmSortBy": { - "base": null, - "refs": { - "ListAlgorithmsInput$SortBy": "

The parameter by which to sort the results. The default is CreationTime.

" - } - }, - "AlgorithmSpecification": { - "base": "

Specifies the training algorithm to use in a CreateTrainingJob request.

SageMaker uses its own SageMaker account credentials to pull and access built-in algorithms so built-in algorithms are universally accessible across all Amazon Web Services accounts. As a result, built-in algorithms have standard, unrestricted access. You cannot restrict built-in algorithms using IAM roles. Use custom algorithms if you require specific access controls.

For more information about algorithms provided by SageMaker, see Algorithms. For information about using your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.

", - "refs": { - "CreateTrainingJobRequest$AlgorithmSpecification": "

The registry path of the Docker image that contains the training algorithm and algorithm-specific metadata, including the input mode. For more information about algorithms provided by SageMaker, see Algorithms. For information about providing your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.

", - "DescribeTrainingJobResponse$AlgorithmSpecification": "

Information about the algorithm used for training, and algorithm metadata.

", - "TrainingJob$AlgorithmSpecification": "

Information about the algorithm used for training, and algorithm metadata.

" - } - }, - "AlgorithmStatus": { - "base": null, - "refs": { - "AlgorithmSummary$AlgorithmStatus": "

The overall status of the algorithm.

", - "DescribeAlgorithmOutput$AlgorithmStatus": "

The current status of the algorithm.

" - } - }, - "AlgorithmStatusDetails": { - "base": "

Specifies the validation and image scan statuses of the algorithm.

", - "refs": { - "DescribeAlgorithmOutput$AlgorithmStatusDetails": "

Details about the current status of the algorithm.

" - } - }, - "AlgorithmStatusItem": { - "base": "

Represents the overall status of an algorithm.

", - "refs": { - "AlgorithmStatusItemList$member": null - } - }, - "AlgorithmStatusItemList": { - "base": null, - "refs": { - "AlgorithmStatusDetails$ValidationStatuses": "

The status of algorithm validation.

", - "AlgorithmStatusDetails$ImageScanStatuses": "

The status of the scan of the algorithm's Docker image container.

" - } - }, - "AlgorithmSummary": { - "base": "

Provides summary information about an algorithm.

", - "refs": { - "AlgorithmSummaryList$member": null - } - }, - "AlgorithmSummaryList": { - "base": null, - "refs": { - "ListAlgorithmsOutput$AlgorithmSummaryList": "

>An array of AlgorithmSummary objects, each of which lists an algorithm.

" - } - }, - "AlgorithmValidationProfile": { - "base": "

Defines a training job and a batch transform job that SageMaker runs to validate your algorithm.

The data provided in the validation profile is made available to your buyers on Amazon Web Services Marketplace.

", - "refs": { - "AlgorithmValidationProfiles$member": null - } - }, - "AlgorithmValidationProfiles": { - "base": null, - "refs": { - "AlgorithmValidationSpecification$ValidationProfiles": "

An array of AlgorithmValidationProfile objects, each of which specifies a training job and batch transform job that SageMaker runs to validate your algorithm.

" - } - }, - "AlgorithmValidationSpecification": { - "base": "

Specifies configurations for one or more training jobs that SageMaker runs to test the algorithm.

", - "refs": { - "CreateAlgorithmInput$ValidationSpecification": "

Specifies configurations for one or more training jobs and that SageMaker runs to test the algorithm's training code and, optionally, one or more batch transform jobs that SageMaker runs to test the algorithm's inference code.

", - "DescribeAlgorithmOutput$ValidationSpecification": "

Details about configurations for one or more training jobs that SageMaker runs to test the algorithm.

" - } - }, - "AmazonQSettings": { - "base": "

A collection of settings that configure the Amazon Q experience within the domain.

", - "refs": { - "DomainSettings$AmazonQSettings": "

A collection of settings that configure the Amazon Q experience within the domain. The AuthMode that you use to create the domain must be SSO.

", - "DomainSettingsForUpdate$AmazonQSettings": "

A collection of settings that configure the Amazon Q experience within the domain.

" - } - }, - "AnnotationConsolidationConfig": { - "base": "

Configures how labels are consolidated across human workers and processes output data.

", - "refs": { - "HumanTaskConfig$AnnotationConsolidationConfig": "

Configures how labels are consolidated across human workers.

" - } - }, - "AppArn": { - "base": null, - "refs": { - "CreateAppResponse$AppArn": "

The Amazon Resource Name (ARN) of the app.

", - "DescribeAppResponse$AppArn": "

The Amazon Resource Name (ARN) of the app.

" - } - }, - "AppDetails": { - "base": "

Details about an Amazon SageMaker AI app.

", - "refs": { - "AppList$member": null - } - }, - "AppImageConfigArn": { - "base": null, - "refs": { - "AppImageConfigDetails$AppImageConfigArn": "

The ARN of the AppImageConfig.

", - "CreateAppImageConfigResponse$AppImageConfigArn": "

The ARN of the AppImageConfig.

", - "DescribeAppImageConfigResponse$AppImageConfigArn": "

The ARN of the AppImageConfig.

", - "UpdateAppImageConfigResponse$AppImageConfigArn": "

The ARN for the AppImageConfig.

" - } - }, - "AppImageConfigDetails": { - "base": "

The configuration for running a SageMaker AI image as a KernelGateway app.

", - "refs": { - "AppImageConfigList$member": null - } - }, - "AppImageConfigList": { - "base": null, - "refs": { - "ListAppImageConfigsResponse$AppImageConfigs": "

A list of AppImageConfigs and their properties.

" - } - }, - "AppImageConfigName": { - "base": null, - "refs": { - "AppImageConfigDetails$AppImageConfigName": "

The name of the AppImageConfig. Must be unique to your account.

", - "CreateAppImageConfigRequest$AppImageConfigName": "

The name of the AppImageConfig. Must be unique to your account.

", - "CustomImage$AppImageConfigName": "

The name of the AppImageConfig.

", - "DeleteAppImageConfigRequest$AppImageConfigName": "

The name of the AppImageConfig to delete.

", - "DescribeAppImageConfigRequest$AppImageConfigName": "

The name of the AppImageConfig to describe.

", - "DescribeAppImageConfigResponse$AppImageConfigName": "

The name of the AppImageConfig.

", - "ListAppImageConfigsRequest$NameContains": "

A filter that returns only AppImageConfigs whose name contains the specified string.

", - "UpdateAppImageConfigRequest$AppImageConfigName": "

The name of the AppImageConfig to update.

" - } - }, - "AppImageConfigSortKey": { - "base": null, - "refs": { - "ListAppImageConfigsRequest$SortBy": "

The property used to sort results. The default value is CreationTime.

" - } - }, - "AppInstanceType": { - "base": null, - "refs": { - "HiddenInstanceTypesList$member": null, - "ResourceSpec$InstanceType": "

The instance type that the image version runs on.

JupyterServer apps only support the system value.

For KernelGateway apps, the system value is translated to ml.t3.medium. KernelGateway apps also support all other values for available instance types.

" - } - }, - "AppLifecycleManagement": { - "base": "

Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio applications.

", - "refs": { - "CodeEditorAppSettings$AppLifecycleManagement": "

Settings that are used to configure and manage the lifecycle of CodeEditor applications.

", - "JupyterLabAppSettings$AppLifecycleManagement": "

Indicates whether idle shutdown is activated for JupyterLab applications.

" - } - }, - "AppList": { - "base": null, - "refs": { - "ListAppsResponse$Apps": "

The list of apps.

" - } - }, - "AppManaged": { - "base": null, - "refs": { - "ProcessingInput$AppManaged": "

When True, input operations such as data download are managed natively by the processing job application. When False (default), input operations are managed by Amazon SageMaker.

", - "ProcessingOutput$AppManaged": "

When True, output operations such as data upload are managed natively by the processing job application. When False (default), output operations are managed by Amazon SageMaker.

" - } - }, - "AppName": { - "base": null, - "refs": { - "AppDetails$AppName": "

The name of the app.

", - "CreateAppRequest$AppName": "

The name of the app.

", - "DeleteAppRequest$AppName": "

The name of the app.

", - "DescribeAppRequest$AppName": "

The name of the app.

", - "DescribeAppResponse$AppName": "

The name of the app.

" - } - }, - "AppNetworkAccessType": { - "base": null, - "refs": { - "CreateDomainRequest$AppNetworkAccessType": "

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.

  • PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access

  • VpcOnly - All traffic is through the specified VPC and subnets

", - "DescribeDomainResponse$AppNetworkAccessType": "

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.

  • PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access

  • VpcOnly - All traffic is through the specified VPC and subnets

", - "UpdateDomainRequest$AppNetworkAccessType": "

Specifies the VPC used for non-EFS traffic.

  • PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access.

  • VpcOnly - All Studio traffic is through the specified VPC and subnets.

This configuration can only be modified if there are no apps in the InService, Pending, or Deleting state. The configuration cannot be updated if DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is already set or DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided as part of the same request.

" - } - }, - "AppSecurityGroupManagement": { - "base": null, - "refs": { - "CreateDomainRequest$AppSecurityGroupManagement": "

The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided. If setting up the domain for use with RStudio, this value must be set to Service.

", - "DescribeDomainResponse$AppSecurityGroupManagement": "

The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided.

", - "UpdateDomainRequest$AppSecurityGroupManagement": "

The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided. If setting up the domain for use with RStudio, this value must be set to Service.

" - } - }, - "AppSortKey": { - "base": null, - "refs": { - "ListAppsRequest$SortBy": "

The parameter by which to sort the results. The default is CreationTime.

" - } - }, - "AppSpecification": { - "base": "

Configuration to run a processing job in a specified container image.

", - "refs": { - "CreateProcessingJobRequest$AppSpecification": "

Configures the processing job to run a specified Docker container image.

", - "DescribeProcessingJobResponse$AppSpecification": "

Configures the processing job to run a specified container image.

", - "ProcessingJob$AppSpecification": null - } - }, - "AppStatus": { - "base": null, - "refs": { - "AppDetails$Status": "

The status.

", - "DescribeAppResponse$Status": "

The status.

" - } - }, - "AppType": { - "base": null, - "refs": { - "AppDetails$AppType": "

The type of app.

", - "CreateAppRequest$AppType": "

The type of app.

", - "DeleteAppRequest$AppType": "

The type of app.

", - "DescribeAppRequest$AppType": "

The type of app.

", - "DescribeAppResponse$AppType": "

The type of app.

", - "HiddenAppTypesList$member": null, - "SpaceSettings$AppType": "

The type of app created within the space.

If using the UpdateSpace API, you can't change the app type of your space by specifying a different value for this field.

", - "SpaceSettingsSummary$AppType": "

The type of app created within the space.

" - } - }, - "ApprovalDescription": { - "base": null, - "refs": { - "DescribeModelPackageOutput$ApprovalDescription": "

A description provided for the model approval.

", - "ModelPackage$ApprovalDescription": "

A description provided when the model approval is set.

", - "UpdateModelPackageInput$ApprovalDescription": "

A description for the approval status of the model.

" - } - }, - "ArnOrName": { - "base": null, - "refs": { - "AlgorithmSpecification$AlgorithmName": "

The name of the algorithm resource to use for the training job. This must be an algorithm resource that you created or subscribe to on Amazon Web Services Marketplace.

You must specify either the algorithm name to the AlgorithmName parameter or the image URI of the algorithm container to the TrainingImage parameter.

Note that the AlgorithmName parameter is mutually exclusive with the TrainingImage parameter. If you specify a value for the AlgorithmName parameter, you can't specify a value for TrainingImage, and vice versa.

If you specify values for both parameters, the training job might break; if you don't specify any value for both parameters, the training job might raise a null error.

", - "CreateModelPackageInput$ModelPackageGroupName": "

The name or Amazon Resource Name (ARN) of the model package group that this model version belongs to.

This parameter is required for versioned models, and does not apply to unversioned models.

", - "DeleteModelPackageGroupInput$ModelPackageGroupName": "

The name of the model group to delete.

", - "DescribeAlgorithmInput$AlgorithmName": "

The name of the algorithm to describe.

", - "DescribeModelPackageGroupInput$ModelPackageGroupName": "

The name of the model group to describe.

", - "HyperParameterAlgorithmSpecification$AlgorithmName": "

The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for TrainingImage.

", - "ListModelPackagesInput$ModelPackageGroupName": "

A filter that returns only model versions that belong to the specified model group.

", - "SourceAlgorithm$AlgorithmName": "

The name of an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you are subscribed to.

" - } - }, - "ArtifactArn": { - "base": null, - "refs": { - "ArtifactSummary$ArtifactArn": "

The Amazon Resource Name (ARN) of the artifact.

", - "CreateArtifactResponse$ArtifactArn": "

The Amazon Resource Name (ARN) of the artifact.

", - "DeleteArtifactRequest$ArtifactArn": "

The Amazon Resource Name (ARN) of the artifact to delete.

", - "DeleteArtifactResponse$ArtifactArn": "

The Amazon Resource Name (ARN) of the artifact.

", - "DescribeArtifactRequest$ArtifactArn": "

The Amazon Resource Name (ARN) of the artifact to describe.

", - "DescribeArtifactResponse$ArtifactArn": "

The Amazon Resource Name (ARN) of the artifact.

", - "UpdateArtifactRequest$ArtifactArn": "

The Amazon Resource Name (ARN) of the artifact to update.

", - "UpdateArtifactResponse$ArtifactArn": "

The Amazon Resource Name (ARN) of the artifact.

" - } - }, - "ArtifactDigest": { - "base": null, - "refs": { - "ModelDigests$ArtifactDigest": "

Provides a hash value that uniquely identifies the stored model artifacts.

" - } - }, - "ArtifactProperties": { - "base": null, - "refs": { - "CreateArtifactRequest$Properties": "

A list of properties to add to the artifact.

", - "UpdateArtifactRequest$Properties": "

The new list of properties. Overwrites the current property list.

" - } - }, - "ArtifactPropertyValue": { - "base": null, - "refs": { - "ArtifactProperties$value": null - } - }, - "ArtifactSource": { - "base": "

A structure describing the source of an artifact.

", - "refs": { - "ArtifactSummary$Source": "

The source of the artifact.

", - "CreateArtifactRequest$Source": "

The ID, ID type, and URI of the source.

", - "DeleteArtifactRequest$Source": "

The URI of the source.

", - "DescribeArtifactResponse$Source": "

The source of the artifact.

" - } - }, - "ArtifactSourceIdType": { - "base": null, - "refs": { - "ArtifactSourceType$SourceIdType": "

The type of ID.

" - } - }, - "ArtifactSourceType": { - "base": "

The ID and ID type of an artifact source.

", - "refs": { - "ArtifactSourceTypes$member": null - } - }, - "ArtifactSourceTypes": { - "base": null, - "refs": { - "ArtifactSource$SourceTypes": "

A list of source types.

" - } - }, - "ArtifactSummaries": { - "base": null, - "refs": { - "ListArtifactsResponse$ArtifactSummaries": "

A list of artifacts and their properties.

" - } - }, - "ArtifactSummary": { - "base": "

Lists a summary of the properties of an artifact. An artifact represents a URI addressable object or data. Some examples are a dataset and a model.

", - "refs": { - "ArtifactSummaries$member": null - } - }, - "AssemblyType": { - "base": null, - "refs": { - "TransformOutput$AssembleWith": "

Defines how to assemble the results of the transform job as a single S3 object. Choose a format that is most convenient to you. To concatenate the results in binary format, specify None. To add a newline character at the end of every transformed record, specify Line.

" - } - }, - "AssignedGroupPatternsList": { - "base": null, - "refs": { - "PartnerAppConfig$AssignedGroupPatterns": "

A list of Amazon Web Services IAM Identity Center group patterns that can access the SageMaker Partner AI App. Group names support wildcard matching using *. An empty list indicates the app will not use Identity Center group features. All groups specified in RoleGroupAssignments must match patterns in this list.

" - } - }, - "AssociateTrialComponentRequest": { - "base": null, - "refs": {} - }, - "AssociateTrialComponentResponse": { - "base": null, - "refs": {} - }, - "AssociationEdgeType": { - "base": null, - "refs": { - "AddAssociationRequest$AssociationType": "

The type of association. The following are suggested uses for each type. Amazon SageMaker places no restrictions on their use.

  • ContributedTo - The source contributed to the destination or had a part in enabling the destination. For example, the training data contributed to the training job.

  • AssociatedWith - The source is connected to the destination. For example, an approval workflow is associated with a model deployment.

  • DerivedFrom - The destination is a modification of the source. For example, a digest output of a channel input for a processing job is derived from the original inputs.

  • Produced - The source generated the destination. For example, a training job produced a model artifact.

", - "AssociationSummary$AssociationType": "

The type of the association.

", - "Edge$AssociationType": "

The type of the Association(Edge) between the source and destination. For example ContributedTo, Produced, or DerivedFrom.

", - "ListAssociationsRequest$AssociationType": "

A filter that returns only associations of the specified type.

" - } - }, - "AssociationEntityArn": { - "base": null, - "refs": { - "AddAssociationRequest$SourceArn": "

The ARN of the source.

", - "AddAssociationRequest$DestinationArn": "

The Amazon Resource Name (ARN) of the destination.

", - "AddAssociationResponse$SourceArn": "

The ARN of the source.

", - "AddAssociationResponse$DestinationArn": "

The Amazon Resource Name (ARN) of the destination.

", - "AssociationSummary$SourceArn": "

The ARN of the source.

", - "AssociationSummary$DestinationArn": "

The Amazon Resource Name (ARN) of the destination.

", - "DeleteAssociationRequest$SourceArn": "

The ARN of the source.

", - "DeleteAssociationRequest$DestinationArn": "

The Amazon Resource Name (ARN) of the destination.

", - "DeleteAssociationResponse$SourceArn": "

The ARN of the source.

", - "DeleteAssociationResponse$DestinationArn": "

The Amazon Resource Name (ARN) of the destination.

", - "Edge$SourceArn": "

The Amazon Resource Name (ARN) of the source lineage entity of the directed edge.

", - "Edge$DestinationArn": "

The Amazon Resource Name (ARN) of the destination lineage entity of the directed edge.

", - "ListAssociationsRequest$SourceArn": "

A filter that returns only associations with the specified source ARN.

", - "ListAssociationsRequest$DestinationArn": "

A filter that returns only associations with the specified destination Amazon Resource Name (ARN).

", - "QueryLineageStartArns$member": null, - "Vertex$Arn": "

The Amazon Resource Name (ARN) of the lineage entity resource.

" - } - }, - "AssociationInfo": { - "base": "

The data type used to describe the relationship between different sources.

", - "refs": { - "AssociationInfoList$member": null - } - }, - "AssociationInfoList": { - "base": null, - "refs": { - "LineageMetadata$Associations": "

The lineage associations.

" - } - }, - "AssociationSummaries": { - "base": null, - "refs": { - "ListAssociationsResponse$AssociationSummaries": "

A list of associations and their properties.

" - } - }, - "AssociationSummary": { - "base": "

Lists a summary of the properties of an association. An association is an entity that links other lineage or experiment entities. An example would be an association between a training job and a model.

", - "refs": { - "AssociationSummaries$member": null - } - }, - "AssumableRoleArns": { - "base": null, - "refs": { - "EmrSettings$AssumableRoleArns": "

An array of Amazon Resource Names (ARNs) of the IAM roles that the execution role of SageMaker can assume for performing operations or tasks related to Amazon EMR clusters or Amazon EMR Serverless applications. These roles define the permissions and access policies required when performing Amazon EMR-related operations, such as listing, connecting to, or terminating Amazon EMR clusters or Amazon EMR Serverless applications. They are typically used in cross-account access scenarios, where the Amazon EMR resources (clusters or serverless applications) are located in a different Amazon Web Services account than the SageMaker domain.

" - } - }, - "AsyncInferenceClientConfig": { - "base": "

Configures the behavior of the client used by SageMaker to interact with the model container during asynchronous inference.

", - "refs": { - "AsyncInferenceConfig$ClientConfig": "

Configures the behavior of the client used by SageMaker to interact with the model container during asynchronous inference.

" - } - }, - "AsyncInferenceConfig": { - "base": "

Specifies configuration for how an endpoint performs asynchronous inference.

", - "refs": { - "CreateEndpointConfigInput$AsyncInferenceConfig": "

Specifies configuration for how an endpoint performs asynchronous inference. This is a required field in order for your Endpoint to be invoked using InvokeEndpointAsync.

", - "DescribeEndpointConfigOutput$AsyncInferenceConfig": "

Returns the description of an endpoint configuration created using the CreateEndpointConfig API.

", - "DescribeEndpointOutput$AsyncInferenceConfig": "

Returns the description of an endpoint configuration created using the CreateEndpointConfig API.

" - } - }, - "AsyncInferenceNotificationConfig": { - "base": "

Specifies the configuration for notifications of inference results for asynchronous inference.

", - "refs": { - "AsyncInferenceOutputConfig$NotificationConfig": "

Specifies the configuration for notifications of inference results for asynchronous inference.

" - } - }, - "AsyncInferenceOutputConfig": { - "base": "

Specifies the configuration for asynchronous inference invocation outputs.

", - "refs": { - "AsyncInferenceConfig$OutputConfig": "

Specifies the configuration for asynchronous inference invocation outputs.

" - } - }, - "AsyncNotificationTopicTypeList": { - "base": null, - "refs": { - "AsyncInferenceNotificationConfig$IncludeInferenceResponseIn": "

The Amazon SNS topics where you want the inference response to be included.

The inference response is included only if the response size is less than or equal to 128 KB.

" - } - }, - "AsyncNotificationTopicTypes": { - "base": null, - "refs": { - "AsyncNotificationTopicTypeList$member": null - } - }, - "AthenaCatalog": { - "base": "

The name of the data catalog used in Athena query execution.

", - "refs": { - "AthenaDatasetDefinition$Catalog": null - } - }, - "AthenaDatabase": { - "base": "

The name of the database used in the Athena query execution.

", - "refs": { - "AthenaDatasetDefinition$Database": null - } - }, - "AthenaDatasetDefinition": { - "base": "

Configuration for Athena Dataset Definition input.

", - "refs": { - "DatasetDefinition$AthenaDatasetDefinition": null - } - }, - "AthenaQueryString": { - "base": "

The SQL query statements, to be executed.

", - "refs": { - "AthenaDatasetDefinition$QueryString": null - } - }, - "AthenaResultCompressionType": { - "base": "

The compression used for Athena query results.

", - "refs": { - "AthenaDatasetDefinition$OutputCompression": null - } - }, - "AthenaResultFormat": { - "base": "

The data storage format for Athena query results.

", - "refs": { - "AthenaDatasetDefinition$OutputFormat": null - } - }, - "AthenaWorkGroup": { - "base": "

The name of the workgroup in which the Athena query is being started.

", - "refs": { - "AthenaDatasetDefinition$WorkGroup": null - } - }, - "AttachClusterNodeVolumeRequest": { - "base": null, - "refs": {} - }, - "AttachClusterNodeVolumeResponse": { - "base": null, - "refs": {} - }, - "AttributeName": { - "base": null, - "refs": { - "AttributeNames$member": null - } - }, - "AttributeNames": { - "base": null, - "refs": { - "S3DataSource$AttributeNames": "

A list of one or more attribute names to use that are found in a specified augmented manifest file.

" - } - }, - "AuthMode": { - "base": null, - "refs": { - "CreateDomainRequest$AuthMode": "

The mode of authentication that members use to access the domain.

", - "DescribeDomainResponse$AuthMode": "

The domain's authentication mode.

" - } - }, - "AuthenticationRequestExtraParams": { - "base": null, - "refs": { - "OidcConfig$AuthenticationRequestExtraParams": "

A string to string map of identifiers specific to the custom identity provider (IdP) being used.

", - "OidcConfigForResponse$AuthenticationRequestExtraParams": "

A string to string map of identifiers specific to the custom identity provider (IdP) being used.

" - } - }, - "AuthenticationRequestExtraParamsKey": { - "base": null, - "refs": { - "AuthenticationRequestExtraParams$key": null - } - }, - "AuthenticationRequestExtraParamsValue": { - "base": null, - "refs": { - "AuthenticationRequestExtraParams$value": null - } - }, - "AuthorizedUrl": { - "base": "

Contains a presigned URL and its associated local file path for downloading hub content artifacts.

", - "refs": { - "AuthorizedUrlConfigs$member": null - } - }, - "AuthorizedUrlConfigs": { - "base": null, - "refs": { - "CreateHubContentPresignedUrlsResponse$AuthorizedUrlConfigs": "

An array of authorized URL configurations, each containing a presigned URL and its corresponding local file path for proper file organization during download.

" - } - }, - "AutoGenerateEndpointName": { - "base": null, - "refs": { - "ModelDeployConfig$AutoGenerateEndpointName": "

Set to True to automatically generate an endpoint name for a one-click Autopilot model deployment; set to False otherwise. The default value is False.

If you set AutoGenerateEndpointName to True, do not specify the EndpointName; otherwise a 400 error is thrown.

" - } - }, - "AutoMLAlgorithm": { - "base": null, - "refs": { - "AutoMLAlgorithms$member": null - } - }, - "AutoMLAlgorithmConfig": { - "base": "

The selection of algorithms trained on your dataset to generate the model candidates for an Autopilot job.

", - "refs": { - "AutoMLAlgorithmsConfig$member": null - } - }, - "AutoMLAlgorithms": { - "base": null, - "refs": { - "AutoMLAlgorithmConfig$AutoMLAlgorithms": "

The selection of algorithms trained on your dataset to generate the model candidates for an Autopilot job.

  • For the tabular problem type TabularJobConfig:

    Selected algorithms must belong to the list corresponding to the training mode set in AutoMLJobConfig.Mode (ENSEMBLING or HYPERPARAMETER_TUNING). Choose a minimum of 1 algorithm.

    • In ENSEMBLING mode:

      • \"catboost\"

      • \"extra-trees\"

      • \"fastai\"

      • \"lightgbm\"

      • \"linear-learner\"

      • \"nn-torch\"

      • \"randomforest\"

      • \"xgboost\"

    • In HYPERPARAMETER_TUNING mode:

      • \"linear-learner\"

      • \"mlp\"

      • \"xgboost\"

  • For the time-series forecasting problem type TimeSeriesForecastingJobConfig:

    • Choose your algorithms from this list.

      • \"cnn-qr\"

      • \"deepar\"

      • \"prophet\"

      • \"arima\"

      • \"npts\"

      • \"ets\"

" - } - }, - "AutoMLAlgorithmsConfig": { - "base": null, - "refs": { - "AutoMLCandidateGenerationConfig$AlgorithmsConfig": "

Stores the configuration information for the selection of algorithms trained on tabular data.

The list of available algorithms to choose from depends on the training mode set in TabularJobConfig.Mode .

  • AlgorithmsConfig should not be set if the training mode is set on AUTO.

  • When AlgorithmsConfig is provided, one AutoMLAlgorithms attribute must be set and one only.

    If the list of algorithms provided as values for AutoMLAlgorithms is empty, CandidateGenerationConfig uses the full set of algorithms for the given training mode.

  • When AlgorithmsConfig is not provided, CandidateGenerationConfig uses the full set of algorithms for the given training mode.

For the list of all algorithms per problem type and training mode, see AutoMLAlgorithmConfig.

For more information on each algorithm, see the Algorithm support section in Autopilot developer guide.

", - "CandidateGenerationConfig$AlgorithmsConfig": "

Your Autopilot job trains a default set of algorithms on your dataset. For tabular and time-series data, you can customize the algorithm list by selecting a subset of algorithms for your problem type.

AlgorithmsConfig stores the customized selection of algorithms to train on your data.

  • For the tabular problem type TabularJobConfig, the list of available algorithms to choose from depends on the training mode set in AutoMLJobConfig.Mode .

    • AlgorithmsConfig should not be set when the training mode AutoMLJobConfig.Mode is set to AUTO.

    • When AlgorithmsConfig is provided, one AutoMLAlgorithms attribute must be set and one only.

      If the list of algorithms provided as values for AutoMLAlgorithms is empty, CandidateGenerationConfig uses the full set of algorithms for the given training mode.

    • When AlgorithmsConfig is not provided, CandidateGenerationConfig uses the full set of algorithms for the given training mode.

    For the list of all algorithms per training mode, see AlgorithmConfig.

    For more information on each algorithm, see the Algorithm support section in the Autopilot developer guide.

  • For the time-series forecasting problem type TimeSeriesForecastingJobConfig, choose your algorithms from the list provided in AlgorithmConfig.

    For more information on each algorithm, see the Algorithms support for time-series forecasting section in the Autopilot developer guide.

    • When AlgorithmsConfig is provided, one AutoMLAlgorithms attribute must be set and one only.

      If the list of algorithms provided as values for AutoMLAlgorithms is empty, CandidateGenerationConfig uses the full set of algorithms for time-series forecasting.

    • When AlgorithmsConfig is not provided, CandidateGenerationConfig uses the full set of algorithms for time-series forecasting.

" - } - }, - "AutoMLCandidate": { - "base": "

Information about a candidate produced by an AutoML training job, including its status, steps, and other properties.

", - "refs": { - "AutoMLCandidates$member": null, - "DescribeAutoMLJobResponse$BestCandidate": "

The best model candidate selected by SageMaker AI Autopilot using both the best objective metric and lowest InferenceLatency for an experiment.

", - "DescribeAutoMLJobV2Response$BestCandidate": "

Information about the candidate produced by an AutoML training job V2, including its status, steps, and other properties.

" - } - }, - "AutoMLCandidateGenerationConfig": { - "base": "

Stores the configuration information for how a candidate is generated (optional).

", - "refs": { - "AutoMLJobConfig$CandidateGenerationConfig": "

The configuration for generating a candidate for an AutoML job (optional).

" - } - }, - "AutoMLCandidateStep": { - "base": "

Information about the steps for a candidate and what step it is working on.

", - "refs": { - "CandidateSteps$member": null - } - }, - "AutoMLCandidates": { - "base": null, - "refs": { - "ListCandidatesForAutoMLJobResponse$Candidates": "

Summaries about the AutoMLCandidates.

" - } - }, - "AutoMLChannel": { - "base": "

A channel is a named input source that training algorithms can consume. The validation dataset size is limited to less than 2 GB. The training dataset size must be less than 100 GB. For more information, see Channel.

A validation dataset must contain the same headers as the training dataset.

", - "refs": { - "AutoMLInputDataConfig$member": null - } - }, - "AutoMLChannelType": { - "base": null, - "refs": { - "AutoMLChannel$ChannelType": "

The channel type (optional) is an enum string. The default value is training. Channels for training and validation must share the same ContentType and TargetAttributeName. For information on specifying training and validation channel types, see How to specify training and validation datasets.

", - "AutoMLJobChannel$ChannelType": "

The type of channel. Defines whether the data are used for training or validation. The default value is training. Channels for training and validation must share the same ContentType

The type of channel defaults to training for the time-series forecasting problem type.

" - } - }, - "AutoMLComputeConfig": { - "base": "

This data type is intended for use exclusively by SageMaker Canvas and cannot be used in other contexts at the moment.

Specifies the compute configuration for an AutoML job V2.

", - "refs": { - "CreateAutoMLJobV2Request$AutoMLComputeConfig": "

Specifies the compute configuration for the AutoML job V2.

", - "DescribeAutoMLJobV2Response$AutoMLComputeConfig": "

The compute configuration used for the AutoML job V2.

" - } - }, - "AutoMLContainerDefinition": { - "base": "

A list of container definitions that describe the different containers that make up an AutoML candidate. For more information, see ContainerDefinition.

", - "refs": { - "AutoMLContainerDefinitions$member": null - } - }, - "AutoMLContainerDefinitions": { - "base": null, - "refs": { - "AutoMLCandidate$InferenceContainers": "

Information about the recommended inference container definitions.

", - "AutoMLInferenceContainerDefinitions$value": "

Information about the recommended inference container definitions.

" - } - }, - "AutoMLDataSource": { - "base": "

The data source for the Autopilot job.

", - "refs": { - "AutoMLChannel$DataSource": "

The data source for an AutoML channel.

", - "AutoMLJobChannel$DataSource": "

The data source for an AutoML channel (Required).

" - } - }, - "AutoMLDataSplitConfig": { - "base": "

This structure specifies how to split the data into train and validation datasets.

The validation and training datasets must contain the same headers. For jobs created by calling CreateAutoMLJob, the validation dataset must be less than 2 GB in size.

", - "refs": { - "AutoMLJobConfig$DataSplitConfig": "

The configuration for splitting the input training dataset.

Type: AutoMLDataSplitConfig

", - "CreateAutoMLJobV2Request$DataSplitConfig": "

This structure specifies how to split the data into train and validation datasets.

The validation and training datasets must contain the same headers. For jobs created by calling CreateAutoMLJob, the validation dataset must be less than 2 GB in size.

This attribute must not be set for the time-series forecasting problem type, as Autopilot automatically splits the input dataset into training and validation sets.

", - "DescribeAutoMLJobV2Response$DataSplitConfig": "

Returns the configuration settings of how the data are split into train and validation datasets.

" - } - }, - "AutoMLFailureReason": { - "base": null, - "refs": { - "AutoMLCandidate$FailureReason": "

The failure reason.

", - "AutoMLJobSummary$FailureReason": "

The failure reason of an AutoML job.

", - "AutoMLPartialFailureReason$PartialFailureMessage": "

The message containing the reason for a partial failure of an AutoML job.

", - "DescribeAutoMLJobResponse$FailureReason": "

Returns the failure reason for an AutoML job, when applicable.

", - "DescribeAutoMLJobV2Response$FailureReason": "

Returns the reason for the failure of the AutoML job V2, when applicable.

" - } - }, - "AutoMLInferenceContainerDefinitions": { - "base": "

The mapping of all supported processing unit (CPU, GPU, etc...) to inference container definitions for the candidate. This field is populated for the V2 API only (for example, for jobs created by calling CreateAutoMLJobV2).

", - "refs": { - "AutoMLCandidate$InferenceContainerDefinitions": "

The mapping of all supported processing unit (CPU, GPU, etc...) to inference container definitions for the candidate. This field is populated for the AutoML jobs V2 (for example, for jobs created by calling CreateAutoMLJobV2) related to image or text classification problem types only.

" - } - }, - "AutoMLInputDataConfig": { - "base": null, - "refs": { - "CreateAutoMLJobRequest$InputDataConfig": "

An array of channel objects that describes the input data and its location. Each channel is a named input source. Similar to InputDataConfig supported by HyperParameterTrainingJobDefinition. Format(s) supported: CSV, Parquet. A minimum of 500 rows is required for the training dataset. There is not a minimum number of rows required for the validation dataset.

", - "DescribeAutoMLJobResponse$InputDataConfig": "

Returns the input data configuration for the AutoML job.

" - } - }, - "AutoMLJobArn": { - "base": null, - "refs": { - "AutoMLJobStepMetadata$Arn": "

The Amazon Resource Name (ARN) of the AutoML job.

", - "AutoMLJobSummary$AutoMLJobArn": "

The ARN of the AutoML job.

", - "CreateAutoMLJobResponse$AutoMLJobArn": "

The unique ARN assigned to the AutoML job when it is created.

", - "CreateAutoMLJobV2Response$AutoMLJobArn": "

The unique ARN assigned to the AutoMLJob when it is created.

", - "DescribeAutoMLJobResponse$AutoMLJobArn": "

Returns the ARN of the AutoML job.

", - "DescribeAutoMLJobV2Response$AutoMLJobArn": "

Returns the Amazon Resource Name (ARN) of the AutoML job V2.

", - "DescribeProcessingJobResponse$AutoMLJobArn": "

The ARN of an AutoML job associated with this processing job.

", - "DescribeTrainingJobResponse$AutoMLJobArn": "

The Amazon Resource Name (ARN) of an AutoML job.

", - "DescribeTransformJobResponse$AutoMLJobArn": "

The Amazon Resource Name (ARN) of the AutoML transform job.

", - "ProcessingJob$AutoMLJobArn": "

The Amazon Resource Name (ARN) of the AutoML job associated with this processing job.

", - "TrainingJob$AutoMLJobArn": "

The Amazon Resource Name (ARN) of the job.

", - "TransformJob$AutoMLJobArn": "

The Amazon Resource Name (ARN) of the AutoML job that created the transform job.

" - } - }, - "AutoMLJobArtifacts": { - "base": "

The artifacts that are generated during an AutoML job.

", - "refs": { - "DescribeAutoMLJobResponse$AutoMLJobArtifacts": "

Returns information on the job's artifacts found in AutoMLJobArtifacts.

", - "DescribeAutoMLJobV2Response$AutoMLJobArtifacts": null - } - }, - "AutoMLJobChannel": { - "base": "

A channel is a named input source that training algorithms can consume. This channel is used for AutoML jobs V2 (jobs created by calling CreateAutoMLJobV2).

", - "refs": { - "AutoMLJobInputDataConfig$member": null - } - }, - "AutoMLJobCompletionCriteria": { - "base": "

How long a job is allowed to run, or how many candidates a job is allowed to generate.

", - "refs": { - "AutoMLJobConfig$CompletionCriteria": "

How long an AutoML job is allowed to run, or how many candidates a job is allowed to generate.

", - "AutoMLResolvedAttributes$CompletionCriteria": null, - "ImageClassificationJobConfig$CompletionCriteria": "

How long a job is allowed to run, or how many candidates a job is allowed to generate.

", - "ResolvedAttributes$CompletionCriteria": null, - "TabularJobConfig$CompletionCriteria": null, - "TextClassificationJobConfig$CompletionCriteria": "

How long a job is allowed to run, or how many candidates a job is allowed to generate.

", - "TextGenerationJobConfig$CompletionCriteria": "

How long a fine-tuning job is allowed to run. For TextGenerationJobConfig problem types, the MaxRuntimePerTrainingJobInSeconds attribute of AutoMLJobCompletionCriteria defaults to 72h (259200s).

", - "TimeSeriesForecastingJobConfig$CompletionCriteria": null - } - }, - "AutoMLJobConfig": { - "base": "

A collection of settings used for an AutoML job.

", - "refs": { - "CreateAutoMLJobRequest$AutoMLJobConfig": "

A collection of settings used to configure an AutoML job.

", - "DescribeAutoMLJobResponse$AutoMLJobConfig": "

Returns the configuration for the AutoML job.

" - } - }, - "AutoMLJobInputDataConfig": { - "base": null, - "refs": { - "CreateAutoMLJobV2Request$AutoMLJobInputDataConfig": "

An array of channel objects describing the input data and their location. Each channel is a named input source. Similar to the InputDataConfig attribute in the CreateAutoMLJob input parameters. The supported formats depend on the problem type:

  • For tabular problem types: S3Prefix, ManifestFile.

  • For image classification: S3Prefix, ManifestFile, AugmentedManifestFile.

  • For text classification: S3Prefix.

  • For time-series forecasting: S3Prefix.

  • For text generation (LLMs fine-tuning): S3Prefix.

", - "DescribeAutoMLJobV2Response$AutoMLJobInputDataConfig": "

Returns an array of channel objects describing the input data and their location.

" - } - }, - "AutoMLJobName": { - "base": null, - "refs": { - "AutoMLJobSummary$AutoMLJobName": "

The name of the AutoML job you are requesting.

", - "CreateAutoMLJobRequest$AutoMLJobName": "

Identifies an Autopilot job. The name must be unique to your account and is case insensitive.

", - "CreateAutoMLJobV2Request$AutoMLJobName": "

Identifies an Autopilot job. The name must be unique to your account and is case insensitive.

", - "DescribeAutoMLJobRequest$AutoMLJobName": "

Requests information about an AutoML job using its unique name.

", - "DescribeAutoMLJobResponse$AutoMLJobName": "

Returns the name of the AutoML job.

", - "DescribeAutoMLJobV2Request$AutoMLJobName": "

Requests information about an AutoML job V2 using its unique name.

", - "DescribeAutoMLJobV2Response$AutoMLJobName": "

Returns the name of the AutoML job V2.

", - "ListCandidatesForAutoMLJobRequest$AutoMLJobName": "

List the candidates created for the job by providing the job's name.

", - "StopAutoMLJobRequest$AutoMLJobName": "

The name of the object you are requesting.

" - } - }, - "AutoMLJobObjective": { - "base": "

Specifies a metric to minimize or maximize as the objective of an AutoML job.

", - "refs": { - "AutoMLResolvedAttributes$AutoMLJobObjective": null, - "CreateAutoMLJobRequest$AutoMLJobObjective": "

Specifies a metric to minimize or maximize as the objective of a job. If not specified, the default objective metric depends on the problem type. See AutoMLJobObjective for the default values.

", - "CreateAutoMLJobV2Request$AutoMLJobObjective": "

Specifies a metric to minimize or maximize as the objective of a job. If not specified, the default objective metric depends on the problem type. For the list of default values per problem type, see AutoMLJobObjective.

  • For tabular problem types: You must either provide both the AutoMLJobObjective and indicate the type of supervised learning problem in AutoMLProblemTypeConfig (TabularJobConfig.ProblemType), or none at all.

  • For text generation problem types (LLMs fine-tuning): Fine-tuning language models in Autopilot does not require setting the AutoMLJobObjective field. Autopilot fine-tunes LLMs without requiring multiple candidates to be trained and evaluated. Instead, using your dataset, Autopilot directly fine-tunes your target model to enhance a default objective metric, the cross-entropy loss. After fine-tuning a language model, you can evaluate the quality of its generated text using different metrics. For a list of the available metrics, see Metrics for fine-tuning LLMs in Autopilot.

", - "DescribeAutoMLJobResponse$AutoMLJobObjective": "

Returns the job's objective.

", - "DescribeAutoMLJobV2Response$AutoMLJobObjective": "

Returns the job's objective.

", - "ResolvedAttributes$AutoMLJobObjective": null - } - }, - "AutoMLJobObjectiveType": { - "base": null, - "refs": { - "FinalAutoMLJobObjectiveMetric$Type": "

The type of metric with the best result.

" - } - }, - "AutoMLJobSecondaryStatus": { - "base": null, - "refs": { - "AutoMLJobSummary$AutoMLJobSecondaryStatus": "

The secondary status of the AutoML job.

", - "DescribeAutoMLJobResponse$AutoMLJobSecondaryStatus": "

Returns the secondary status of the AutoML job.

", - "DescribeAutoMLJobV2Response$AutoMLJobSecondaryStatus": "

Returns the secondary status of the AutoML job V2.

" - } - }, - "AutoMLJobStatus": { - "base": null, - "refs": { - "AutoMLJobSummary$AutoMLJobStatus": "

The status of the AutoML job.

", - "DescribeAutoMLJobResponse$AutoMLJobStatus": "

Returns the status of the AutoML job.

", - "DescribeAutoMLJobV2Response$AutoMLJobStatus": "

Returns the status of the AutoML job V2.

", - "ListAutoMLJobsRequest$StatusEquals": "

Request a list of jobs, using a filter for status.

" - } - }, - "AutoMLJobStepMetadata": { - "base": "

Metadata for an AutoML job step.

", - "refs": { - "PipelineExecutionStepMetadata$AutoMLJob": "

The Amazon Resource Name (ARN) of the AutoML job that was run by this step.

" - } - }, - "AutoMLJobSummaries": { - "base": null, - "refs": { - "ListAutoMLJobsResponse$AutoMLJobSummaries": "

Returns a summary list of jobs.

" - } - }, - "AutoMLJobSummary": { - "base": "

Provides a summary about an AutoML job.

", - "refs": { - "AutoMLJobSummaries$member": null - } - }, - "AutoMLMaxResults": { - "base": null, - "refs": { - "ListAutoMLJobsRequest$MaxResults": "

Request a list of jobs up to a specified limit.

" - } - }, - "AutoMLMaxResultsForTrials": { - "base": null, - "refs": { - "ListCandidatesForAutoMLJobRequest$MaxResults": "

List the job's candidates up to a specified limit.

" - } - }, - "AutoMLMetricEnum": { - "base": null, - "refs": { - "AutoMLJobObjective$MetricName": "

The name of the objective metric used to measure the predictive quality of a machine learning system. During training, the model's parameters are updated iteratively to optimize its performance based on the feedback provided by the objective metric when evaluating the model on the validation dataset.

The list of available metrics supported by Autopilot and the default metric applied when you do not specify a metric name explicitly depend on the problem type.

  • For tabular problem types:

    • List of available metrics:

      • Regression: MAE, MSE, R2, RMSE

      • Binary classification: Accuracy, AUC, BalancedAccuracy, F1, Precision, Recall

      • Multiclass classification: Accuracy, BalancedAccuracy, F1macro, PrecisionMacro, RecallMacro

      For a description of each metric, see Autopilot metrics for classification and regression.

    • Default objective metrics:

      • Regression: MSE.

      • Binary classification: F1.

      • Multiclass classification: Accuracy.

  • For image or text classification problem types:

  • For time-series forecasting problem types:

  • For text generation problem types (LLMs fine-tuning): Fine-tuning language models in Autopilot does not require setting the AutoMLJobObjective field. Autopilot fine-tunes LLMs without requiring multiple candidates to be trained and evaluated. Instead, using your dataset, Autopilot directly fine-tunes your target model to enhance a default objective metric, the cross-entropy loss. After fine-tuning a language model, you can evaluate the quality of its generated text using different metrics. For a list of the available metrics, see Metrics for fine-tuning LLMs in Autopilot.

", - "FinalAutoMLJobObjectiveMetric$MetricName": "

The name of the metric with the best result. For a description of the possible objective metrics, see AutoMLJobObjective$MetricName.

", - "FinalAutoMLJobObjectiveMetric$StandardMetricName": "

The name of the standard metric. For a description of the standard metrics, see Autopilot candidate metrics.

", - "MetricDatum$MetricName": "

The name of the metric.

" - } - }, - "AutoMLMetricExtendedEnum": { - "base": null, - "refs": { - "MetricDatum$StandardMetricName": "

The name of the standard metric.

For definitions of the standard metrics, see Autopilot candidate metrics .

" - } - }, - "AutoMLMode": { - "base": null, - "refs": { - "AutoMLJobConfig$Mode": "

The method that Autopilot uses to train the data. You can either specify the mode manually or let Autopilot choose for you based on the dataset size by selecting AUTO. In AUTO mode, Autopilot chooses ENSEMBLING for datasets smaller than 100 MB, and HYPERPARAMETER_TUNING for larger ones.

The ENSEMBLING mode uses a multi-stack ensemble model to predict classification and regression tasks directly from your dataset. This machine learning mode combines several base models to produce an optimal predictive model. It then uses a stacking ensemble method to combine predictions from contributing members. A multi-stack ensemble model can provide better performance over a single model by combining the predictive capabilities of multiple models. See Autopilot algorithm support for a list of algorithms supported by ENSEMBLING mode.

The HYPERPARAMETER_TUNING (HPO) mode uses the best hyperparameters to train the best version of a model. HPO automatically selects an algorithm for the type of problem you want to solve. Then HPO finds the best hyperparameters according to your objective metric. See Autopilot algorithm support for a list of algorithms supported by HYPERPARAMETER_TUNING mode.

", - "TabularJobConfig$Mode": "

The method that Autopilot uses to train the data. You can either specify the mode manually or let Autopilot choose for you based on the dataset size by selecting AUTO. In AUTO mode, Autopilot chooses ENSEMBLING for datasets smaller than 100 MB, and HYPERPARAMETER_TUNING for larger ones.

The ENSEMBLING mode uses a multi-stack ensemble model to predict classification and regression tasks directly from your dataset. This machine learning mode combines several base models to produce an optimal predictive model. It then uses a stacking ensemble method to combine predictions from contributing members. A multi-stack ensemble model can provide better performance over a single model by combining the predictive capabilities of multiple models. See Autopilot algorithm support for a list of algorithms supported by ENSEMBLING mode.

The HYPERPARAMETER_TUNING (HPO) mode uses the best hyperparameters to train the best version of a model. HPO automatically selects an algorithm for the type of problem you want to solve. Then HPO finds the best hyperparameters according to your objective metric. See Autopilot algorithm support for a list of algorithms supported by HYPERPARAMETER_TUNING mode.

" - } - }, - "AutoMLNameContains": { - "base": null, - "refs": { - "ListAutoMLJobsRequest$NameContains": "

Request a list of jobs, using a search filter for name.

" - } - }, - "AutoMLOutputDataConfig": { - "base": "

The output data configuration.

", - "refs": { - "CreateAutoMLJobRequest$OutputDataConfig": "

Provides information about encryption and the Amazon S3 output path needed to store artifacts from an AutoML job. Format(s) supported: CSV.

", - "CreateAutoMLJobV2Request$OutputDataConfig": "

Provides information about encryption and the Amazon S3 output path needed to store artifacts from an AutoML job.

", - "DescribeAutoMLJobResponse$OutputDataConfig": "

Returns the job's output data config.

", - "DescribeAutoMLJobV2Response$OutputDataConfig": "

Returns the job's output data config.

" - } - }, - "AutoMLPartialFailureReason": { - "base": "

The reason for a partial failure of an AutoML job.

", - "refs": { - "AutoMLPartialFailureReasons$member": null - } - }, - "AutoMLPartialFailureReasons": { - "base": null, - "refs": { - "AutoMLJobSummary$PartialFailureReasons": "

The list of reasons for partial failures within an AutoML job.

", - "DescribeAutoMLJobResponse$PartialFailureReasons": "

Returns a list of reasons for partial failures within an AutoML job.

", - "DescribeAutoMLJobV2Response$PartialFailureReasons": "

Returns a list of reasons for partial failures within an AutoML job V2.

" - } - }, - "AutoMLProblemTypeConfig": { - "base": "

A collection of settings specific to the problem type used to configure an AutoML job V2. There must be one and only one config of the following type.

", - "refs": { - "CreateAutoMLJobV2Request$AutoMLProblemTypeConfig": "

Defines the configuration settings of one of the supported problem types.

", - "DescribeAutoMLJobV2Response$AutoMLProblemTypeConfig": "

Returns the configuration settings of the problem type set for the AutoML job V2.

" - } - }, - "AutoMLProblemTypeConfigName": { - "base": null, - "refs": { - "DescribeAutoMLJobV2Response$AutoMLProblemTypeConfigName": "

Returns the name of the problem type configuration set for the AutoML job V2.

" - } - }, - "AutoMLProblemTypeResolvedAttributes": { - "base": "

Stores resolved attributes specific to the problem type of an AutoML job V2.

", - "refs": { - "AutoMLResolvedAttributes$AutoMLProblemTypeResolvedAttributes": "

Defines the resolved attributes specific to a problem type.

" - } - }, - "AutoMLProcessingUnit": { - "base": null, - "refs": { - "AutoMLInferenceContainerDefinitions$key": "

Processing unit for an inference container. Currently Autopilot only supports CPU or GPU.

" - } - }, - "AutoMLResolvedAttributes": { - "base": "

The resolved attributes used to configure an AutoML job V2.

", - "refs": { - "DescribeAutoMLJobV2Response$ResolvedAttributes": "

Returns the resolved attributes used by the AutoML job V2.

" - } - }, - "AutoMLS3DataSource": { - "base": "

Describes the Amazon S3 data source.

", - "refs": { - "AutoMLDataSource$S3DataSource": "

The Amazon S3 location of the input data.

" - } - }, - "AutoMLS3DataType": { - "base": null, - "refs": { - "AutoMLS3DataSource$S3DataType": "

The data type.

  • If you choose S3Prefix, S3Uri identifies a key name prefix. SageMaker AI uses all objects that match the specified key name prefix for model training.

    The S3Prefix should have the following format:

    s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER-OR-FILE

  • If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want SageMaker AI to use for model training.

    A ManifestFile should have the format shown below:

    [ {\"prefix\": \"s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/DOC-EXAMPLE-PREFIX/\"},

    \"DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-1\",

    \"DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-2\",

    ... \"DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-N\" ]

  • If you choose AugmentedManifestFile, S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. AugmentedManifestFile is available for V2 API jobs only (for example, for jobs created by calling CreateAutoMLJobV2).

    Here is a minimal, single-record example of an AugmentedManifestFile:

    {\"source-ref\": \"s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/cats/cat.jpg\",

    \"label-metadata\": {\"class-name\": \"cat\" }

    For more information on AugmentedManifestFile, see Provide Dataset Metadata to Training Jobs with an Augmented Manifest File.

" - } - }, - "AutoMLSecurityConfig": { - "base": "

Security options.

", - "refs": { - "AutoMLJobConfig$SecurityConfig": "

The security configuration for traffic encryption or Amazon VPC settings.

", - "CreateAutoMLJobV2Request$SecurityConfig": "

The security configuration for traffic encryption or Amazon VPC settings.

", - "DescribeAutoMLJobV2Response$SecurityConfig": "

Returns the security configuration for traffic encryption or Amazon VPC settings.

" - } - }, - "AutoMLSortBy": { - "base": null, - "refs": { - "ListAutoMLJobsRequest$SortBy": "

The parameter by which to sort the results. The default is Name.

" - } - }, - "AutoMLSortOrder": { - "base": null, - "refs": { - "ListAutoMLJobsRequest$SortOrder": "

The sort order for the results. The default is Descending.

", - "ListCandidatesForAutoMLJobRequest$SortOrder": "

The sort order for the results. The default is Ascending.

" - } - }, - "AutoMountHomeEFS": { - "base": null, - "refs": { - "UserSettings$AutoMountHomeEFS": "

Indicates whether auto-mounting of an EFS volume is supported for the user profile. The DefaultAsDomain value is only supported for user profiles. Do not use the DefaultAsDomain value when setting this parameter for a domain.

SageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn't apply this setting to shared spaces.

" - } - }, - "AutoParameter": { - "base": "

The name and an example value of the hyperparameter that you want to use in Autotune. If Automatic model tuning (AMT) determines that your hyperparameter is eligible for Autotune, an optimal hyperparameter range is selected for you.

", - "refs": { - "AutoParameters$member": null - } - }, - "AutoParameters": { - "base": null, - "refs": { - "ParameterRanges$AutoParameters": "

A list containing hyperparameter names and example values to be used by Autotune to determine optimal ranges for your tuning job.

" - } - }, - "AutoRollbackAlarms": { - "base": null, - "refs": { - "DeploymentConfiguration$AutoRollbackConfiguration": "

An array that contains the alarms that SageMaker monitors to know whether to roll back the AMI update.

" - } - }, - "AutoRollbackConfig": { - "base": "

Automatic rollback configuration for handling endpoint deployment failures and recovery.

", - "refs": { - "DeploymentConfig$AutoRollbackConfiguration": "

Automatic rollback configuration for handling endpoint deployment failures and recovery.

", - "InferenceComponentDeploymentConfig$AutoRollbackConfiguration": null - } - }, - "Autotune": { - "base": "

A flag to indicate if you want to use Autotune to automatically find optimal values for the following fields:

  • ParameterRanges: The names and ranges of parameters that a hyperparameter tuning job can optimize.

  • ResourceLimits: The maximum resources that can be used for a training job. These resources include the maximum number of training jobs, the maximum runtime of a tuning job, and the maximum number of training jobs to run at the same time.

  • TrainingJobEarlyStoppingType: A flag that specifies whether or not to use early stopping for training jobs launched by a hyperparameter tuning job.

  • RetryStrategy: The number of times to retry a training job.

  • Strategy: Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training jobs that it launches.

  • ConvergenceDetected: A flag to indicate that Automatic model tuning (AMT) has detected model convergence.

", - "refs": { - "CreateHyperParameterTuningJobRequest$Autotune": "

Configures SageMaker Automatic model tuning (AMT) to automatically find optimal parameters for the following fields:

  • ParameterRanges: The names and ranges of parameters that a hyperparameter tuning job can optimize.

  • ResourceLimits: The maximum resources that can be used for a training job. These resources include the maximum number of training jobs, the maximum runtime of a tuning job, and the maximum number of training jobs to run at the same time.

  • TrainingJobEarlyStoppingType: A flag that specifies whether or not to use early stopping for training jobs launched by a hyperparameter tuning job.

  • RetryStrategy: The number of times to retry a training job.

  • Strategy: Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training jobs that it launches.

  • ConvergenceDetected: A flag to indicate that Automatic model tuning (AMT) has detected model convergence.

", - "DescribeHyperParameterTuningJobResponse$Autotune": "

A flag to indicate if autotune is enabled for the hyperparameter tuning job.

" - } - }, - "AutotuneMode": { - "base": null, - "refs": { - "Autotune$Mode": "

Set Mode to Enabled if you want to use Autotune.

" - } - }, - "AvailabilityZone": { - "base": null, - "refs": { - "DescribeReservedCapacityResponse$AvailabilityZone": "

The Availability Zone where the reserved capacity is provisioned.

", - "ReservedCapacityOffering$AvailabilityZone": "

The availability zone for the reserved capacity offering.

", - "ReservedCapacitySummary$AvailabilityZone": "

The availability zone for the reserved capacity.

", - "UltraServer$AvailabilityZone": "

The name of the Availability Zone where the UltraServer is provisioned.

" - } - }, - "AvailabilityZoneBalanceEnforcementMode": { - "base": null, - "refs": { - "InferenceComponentAvailabilityZoneBalance$EnforcementMode": "

Determines how strictly the Availability Zone balance constraint is enforced.

PERMISSIVE

The endpoint attempts to balance copies across Availability Zones but proceeds with scheduling even if balance can't be achieved due to available capacity or instance distribution across Availability Zones.

" - } - }, - "AvailabilityZoneBalanceMaxImbalance": { - "base": null, - "refs": { - "InferenceComponentAvailabilityZoneBalance$MaxImbalance": "

The maximum allowed difference in the number of inference component copies between any two Availability Zones. This parameter applies only when the endpoint has instances across two or more Availability Zones. A copy placement is allowed if it reduces imbalance or the resulting imbalance is within this value.

Default value: 0.

" - } - }, - "AvailabilityZoneId": { - "base": null, - "refs": { - "ReservedCapacitySummary$AvailabilityZoneId": "

The Availability Zone ID of the reserved capacity.

", - "TrainingPlanExtension$AvailabilityZoneId": "

The Availability Zone ID of the extension.

" - } - }, - "AvailableInstanceCount": { - "base": null, - "refs": { - "DescribeReservedCapacityResponse$AvailableInstanceCount": "

The number of instances currently available for use in this reserved capacity.

", - "DescribeTrainingPlanResponse$AvailableInstanceCount": "

The number of instances currently available for use in this training plan.

", - "TrainingPlanSummary$AvailableInstanceCount": "

The number of instances currently available for use in this training plan.

", - "UltraServer$AvailableInstanceCount": "

The number of instances currently available for use in this UltraServer.

" - } - }, - "AvailableSpareInstanceCount": { - "base": null, - "refs": { - "DescribeTrainingPlanResponse$AvailableSpareInstanceCount": "

The number of available spare instances in the training plan.

", - "UltraServer$AvailableSpareInstanceCount": "

The number of available spare instances in the UltraServer.

", - "UltraServerSummary$AvailableSpareInstanceCount": "

The number of available spare instances in the UltraServers.

" - } - }, - "AvailableUpgrade": { - "base": "

Contains information about an available upgrade for a SageMaker Partner AI App, including the version number and release notes.

", - "refs": { - "DescribePartnerAppResponse$AvailableUpgrade": "

A map of available minor version upgrades for the SageMaker Partner AI App. The key is the semantic version number, and the value is a list of release notes for that version. A null value indicates no upgrades are available.

" - } - }, - "AwsManagedHumanLoopRequestSource": { - "base": null, - "refs": { - "HumanLoopRequestSource$AwsManagedHumanLoopRequestSource": "

Specifies whether Amazon Rekognition or Amazon Textract are used as the integration source. The default field settings and JSON parsing rules are different based on the integration source. Valid values:

" - } - }, - "BacktestResultsLocation": { - "base": null, - "refs": { - "CandidateArtifactLocations$BacktestResults": "

The Amazon S3 prefix to the accuracy metrics and the inference results observed over the testing window. Available only for the time-series forecasting problem type.

" - } - }, - "BaseModel": { - "base": "

Identifies the foundation model that was used as the starting point for model customization.

", - "refs": { - "ModelPackageContainerDefinition$BaseModel": "

Identifies the foundation model that was used as the starting point for model customization.

" - } - }, - "BaseModelName": { - "base": null, - "refs": { - "TextGenerationJobConfig$BaseModelName": "

The name of the base model to fine-tune. Autopilot supports fine-tuning a variety of large language models. For information on the list of supported models, see Text generation models supporting fine-tuning in Autopilot. If no BaseModelName is provided, the default model used is Falcon7BInstruct.

", - "TextGenerationResolvedAttributes$BaseModelName": "

The name of the base model to fine-tune.

" - } - }, - "BatchAddClusterNodesError": { - "base": "

Information about an error that occurred during the node addition operation.

", - "refs": { - "BatchAddClusterNodesErrorList$member": null - } - }, - "BatchAddClusterNodesErrorCode": { - "base": null, - "refs": { - "BatchAddClusterNodesError$ErrorCode": "

The error code associated with the failure. Possible values include InstanceGroupNotFound and InvalidInstanceGroupState.

" - } - }, - "BatchAddClusterNodesErrorList": { - "base": null, - "refs": { - "BatchAddClusterNodesResponse$Failed": "

A list of errors that occurred during the node addition operation. Each entry includes the instance group name, error code, number of failed additions, and an error message.

" - } - }, - "BatchAddClusterNodesRequest": { - "base": null, - "refs": {} - }, - "BatchAddClusterNodesRequestClientTokenString": { - "base": null, - "refs": { - "BatchAddClusterNodesRequest$ClientToken": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token is valid for 8 hours. If you retry the request with the same client token within this timeframe and the same parameters, the API returns the same set of NodeLogicalIds with their latest status.

" - } - }, - "BatchAddClusterNodesResponse": { - "base": null, - "refs": {} - }, - "BatchAddFailureCount": { - "base": null, - "refs": { - "BatchAddClusterNodesError$FailedCount": "

The number of nodes that failed to be added to the specified instance group.

" - } - }, - "BatchDataCaptureConfig": { - "base": "

Configuration to control how SageMaker captures inference data for batch transform jobs.

", - "refs": { - "CreateTransformJobRequest$DataCaptureConfig": "

Configuration to control how SageMaker captures inference data.

", - "DescribeTransformJobResponse$DataCaptureConfig": "

Configuration to control how SageMaker captures inference data.

", - "TransformJob$DataCaptureConfig": null - } - }, - "BatchDeleteClusterNodeLogicalIdsError": { - "base": "

Information about an error that occurred when attempting to delete a node identified by its NodeLogicalId.

", - "refs": { - "BatchDeleteClusterNodeLogicalIdsErrorList$member": null - } - }, - "BatchDeleteClusterNodeLogicalIdsErrorList": { - "base": null, - "refs": { - "BatchDeleteClusterNodesResponse$FailedNodeLogicalIds": "

A list of NodeLogicalIds that could not be deleted, along with error information explaining why the deletion failed.

" - } - }, - "BatchDeleteClusterNodesError": { - "base": "

Represents an error encountered when deleting a node from a SageMaker HyperPod cluster.

", - "refs": { - "BatchDeleteClusterNodesErrorList$member": null - } - }, - "BatchDeleteClusterNodesErrorCode": { - "base": null, - "refs": { - "BatchDeleteClusterNodeLogicalIdsError$Code": "

The error code associated with the failure. Possible values include NodeLogicalIdNotFound, InvalidNodeStatus, and InternalError.

", - "BatchDeleteClusterNodesError$Code": "

The error code associated with the error encountered when deleting a node.

The code provides information about the specific issue encountered, such as the node not being found, the node's status being invalid for deletion, or the node ID being in use by another process.

" - } - }, - "BatchDeleteClusterNodesErrorList": { - "base": null, - "refs": { - "BatchDeleteClusterNodesResponse$Failed": "

A list of errors encountered when deleting the specified nodes.

" - } - }, - "BatchDeleteClusterNodesRequest": { - "base": null, - "refs": {} - }, - "BatchDeleteClusterNodesResponse": { - "base": null, - "refs": {} - }, - "BatchDescribeModelPackageError": { - "base": "

The error code and error description associated with the resource.

", - "refs": { - "BatchDescribeModelPackageErrorMap$value": null - } - }, - "BatchDescribeModelPackageErrorMap": { - "base": null, - "refs": { - "BatchDescribeModelPackageOutput$BatchDescribeModelPackageErrorMap": "

A map of the resource and BatchDescribeModelPackageError objects reporting the error associated with describing the model package.

" - } - }, - "BatchDescribeModelPackageInput": { - "base": null, - "refs": {} - }, - "BatchDescribeModelPackageOutput": { - "base": null, - "refs": {} - }, - "BatchDescribeModelPackageSummary": { - "base": "

Provides summary information about the model package.

", - "refs": { - "ModelPackageSummaries$value": null - } - }, - "BatchRebootClusterNodeLogicalIdsError": { - "base": "

Represents an error encountered when rebooting a node (identified by its logical node ID) from a SageMaker HyperPod cluster.

", - "refs": { - "BatchRebootClusterNodeLogicalIdsErrors$member": null - } - }, - "BatchRebootClusterNodeLogicalIdsErrors": { - "base": null, - "refs": { - "BatchRebootClusterNodesResponse$FailedNodeLogicalIds": "

A list of errors encountered for logical node IDs that could not be rebooted. Each error includes the logical node ID, an error code, and a descriptive message. This field is only present when NodeLogicalIds were provided in the request.

" - } - }, - "BatchRebootClusterNodesError": { - "base": "

Represents an error encountered when rebooting a node from a SageMaker HyperPod cluster.

", - "refs": { - "BatchRebootClusterNodesErrors$member": null - } - }, - "BatchRebootClusterNodesErrorCode": { - "base": null, - "refs": { - "BatchRebootClusterNodeLogicalIdsError$ErrorCode": "

The error code associated with the error encountered when rebooting a node by logical node ID.

Possible values:

  • InstanceIdNotFound: The node does not exist in the specified cluster.

  • InvalidInstanceStatus: The node is in a state that does not allow rebooting. Wait for the node to finish any ongoing changes before retrying.

  • InstanceIdInUse: Another operation is already in progress for this node. Wait for the operation to complete before retrying.

  • InternalServerError: An internal error occurred while processing this node.

", - "BatchRebootClusterNodesError$ErrorCode": "

The error code associated with the error encountered when rebooting a node.

Possible values:

  • InstanceIdNotFound: The instance does not exist in the specified cluster.

  • InvalidInstanceStatus: The instance is in a state that does not allow rebooting. Wait for the instance to finish any ongoing changes before retrying.

  • InstanceIdInUse: Another operation is already in progress for this node. Wait for the operation to complete before retrying.

  • InternalServerError: An internal error occurred while processing this node.

" - } - }, - "BatchRebootClusterNodesErrors": { - "base": null, - "refs": { - "BatchRebootClusterNodesResponse$Failed": "

A list of errors encountered for EC2 instance IDs that could not be rebooted. Each error includes the instance ID, an error code, and a descriptive message.

" - } - }, - "BatchRebootClusterNodesRequest": { - "base": null, - "refs": {} - }, - "BatchRebootClusterNodesRequestNodeIdsList": { - "base": null, - "refs": { - "BatchRebootClusterNodesRequest$NodeIds": "

A list of EC2 instance IDs to reboot using soft recovery. You can specify between 1 and 25 instance IDs.

  • Either NodeIds or NodeLogicalIds must be provided (or both), but at least one is required.

  • Each instance ID must follow the pattern i- followed by 17 hexadecimal characters (for example, i-0123456789abcdef0).

" - } - }, - "BatchRebootClusterNodesRequestNodeLogicalIdsList": { - "base": null, - "refs": { - "BatchRebootClusterNodesRequest$NodeLogicalIds": "

A list of logical node IDs to reboot using soft recovery. You can specify between 1 and 25 logical node IDs.

The NodeLogicalId is a unique identifier that persists throughout the node's lifecycle and can be used to track nodes that are still being provisioned and don't yet have an EC2 instance ID assigned.

  • This parameter is only supported for clusters using Continuous as the NodeProvisioningMode. For clusters using the default provisioning mode, use NodeIds instead.

  • Either NodeIds or NodeLogicalIds must be provided (or both), but at least one is required.

" - } - }, - "BatchRebootClusterNodesResponse": { - "base": null, - "refs": {} - }, - "BatchReplaceClusterNodeLogicalIdsError": { - "base": "

Represents an error encountered when replacing a node (identified by its logical node ID) in a SageMaker HyperPod cluster.

", - "refs": { - "BatchReplaceClusterNodeLogicalIdsErrors$member": null - } - }, - "BatchReplaceClusterNodeLogicalIdsErrors": { - "base": null, - "refs": { - "BatchReplaceClusterNodesResponse$FailedNodeLogicalIds": "

A list of errors encountered for logical node IDs that could not be replaced. Each error includes the logical node ID, an error code, and a descriptive message. This field is only present when NodeLogicalIds were provided in the request.

" - } - }, - "BatchReplaceClusterNodesError": { - "base": "

Represents an error encountered when replacing a node in a SageMaker HyperPod cluster.

", - "refs": { - "BatchReplaceClusterNodesErrors$member": null - } - }, - "BatchReplaceClusterNodesErrorCode": { - "base": null, - "refs": { - "BatchReplaceClusterNodeLogicalIdsError$ErrorCode": "

The error code associated with the error encountered when replacing a node by logical node ID.

Possible values:

  • InstanceIdNotFound: The node does not exist in the specified cluster.

  • InvalidInstanceStatus: The node is in a state that does not allow replacement. Wait for the node to finish any ongoing changes before retrying.

  • InstanceIdInUse: Another operation is already in progress for this node. Wait for the operation to complete before retrying.

  • InternalServerError: An internal error occurred while processing this node.

", - "BatchReplaceClusterNodesError$ErrorCode": "

The error code associated with the error encountered when replacing a node.

Possible values:

  • InstanceIdNotFound: The instance does not exist in the specified cluster.

  • InvalidInstanceStatus: The instance is in a state that does not allow replacement. Wait for the instance to finish any ongoing changes before retrying.

  • InstanceIdInUse: Another operation is already in progress for this node. Wait for the operation to complete before retrying.

  • InternalServerError: An internal error occurred while processing this node.

" - } - }, - "BatchReplaceClusterNodesErrors": { - "base": null, - "refs": { - "BatchReplaceClusterNodesResponse$Failed": "

A list of errors encountered for EC2 instance IDs that could not be replaced. Each error includes the instance ID, an error code, and a descriptive message.

" - } - }, - "BatchReplaceClusterNodesRequest": { - "base": null, - "refs": {} - }, - "BatchReplaceClusterNodesRequestNodeIdsList": { - "base": null, - "refs": { - "BatchReplaceClusterNodesRequest$NodeIds": "

A list of EC2 instance IDs to replace with new hardware. You can specify between 1 and 25 instance IDs.

Replace operations destroy all instance volumes (root and secondary). Ensure you have backed up any important data before proceeding.

  • Either NodeIds or NodeLogicalIds must be provided (or both), but at least one is required.

  • Each instance ID must follow the pattern i- followed by 17 hexadecimal characters (for example, i-0123456789abcdef0).

  • For SageMaker HyperPod clusters using the Slurm workload manager, you cannot replace instances that are configured as Slurm controller nodes.

" - } - }, - "BatchReplaceClusterNodesRequestNodeLogicalIdsList": { - "base": null, - "refs": { - "BatchReplaceClusterNodesRequest$NodeLogicalIds": "

A list of logical node IDs to replace with new hardware. You can specify between 1 and 25 logical node IDs.

The NodeLogicalId is a unique identifier that persists throughout the node's lifecycle and can be used to track nodes that are still being provisioned and don't yet have an EC2 instance ID assigned.

  • Replace operations destroy all instance volumes (root and secondary). Ensure you have backed up any important data before proceeding.

  • This parameter is only supported for clusters using Continuous as the NodeProvisioningMode. For clusters using the default provisioning mode, use NodeIds instead.

  • Either NodeIds or NodeLogicalIds must be provided (or both), but at least one is required.

" - } - }, - "BatchReplaceClusterNodesResponse": { - "base": null, - "refs": {} - }, - "BatchStrategy": { - "base": null, - "refs": { - "CreateTransformJobRequest$BatchStrategy": "

Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.

To enable the batch strategy, you must set the SplitType property to Line, RecordIO, or TFRecord.

To use only one record when making an HTTP invocation request to a container, set BatchStrategy to SingleRecord and SplitType to Line.

To fit as many records in a mini-batch as can fit within the MaxPayloadInMB limit, set BatchStrategy to MultiRecord and SplitType to Line.

", - "DescribeTransformJobResponse$BatchStrategy": "

Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.

To enable the batch strategy, you must set SplitType to Line, RecordIO, or TFRecord.

", - "TransformJob$BatchStrategy": "

Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.

", - "TransformJobDefinition$BatchStrategy": "

A string that determines the number of records included in a single mini-batch.

SingleRecord means only one record is used per mini-batch. MultiRecord means a mini-batch is set to contain as many records that can fit within the MaxPayloadInMB limit.

" - } - }, - "BatchTransformInput": { - "base": "

Input object for the batch transform job.

", - "refs": { - "DataQualityJobInput$BatchTransformInput": "

Input object for the batch transform job.

", - "ModelBiasJobInput$BatchTransformInput": "

Input object for the batch transform job.

", - "ModelDashboardMonitoringSchedule$BatchTransformInput": null, - "ModelExplainabilityJobInput$BatchTransformInput": "

Input object for the batch transform job.

", - "ModelQualityJobInput$BatchTransformInput": "

Input object for the batch transform job.

", - "MonitoringInput$BatchTransformInput": "

Input object for the batch transform job.

" - } - }, - "BedrockCustomModelDeploymentMetadata": { - "base": "

The metadata of the Amazon Bedrock custom model deployment.

", - "refs": { - "PipelineExecutionStepMetadata$BedrockCustomModelDeployment": "

The metadata of the Amazon Bedrock custom model deployment used in pipeline execution step.

" - } - }, - "BedrockCustomModelMetadata": { - "base": "

The metadata of the Amazon Bedrock custom model.

", - "refs": { - "PipelineExecutionStepMetadata$BedrockCustomModel": "

The metadata of the Amazon Bedrock custom model used in the pipeline execution step.

" - } - }, - "BedrockModelImportMetadata": { - "base": "

The metadata of the Amazon Bedrock model import.

", - "refs": { - "PipelineExecutionStepMetadata$BedrockModelImport": "

The metadata of Amazon Bedrock model import used in pipeline execution step.

" - } - }, - "BedrockProvisionedModelThroughputMetadata": { - "base": "

The metadata of the Amazon Bedrock provisioned model throughput.

", - "refs": { - "PipelineExecutionStepMetadata$BedrockProvisionedModelThroughput": "

The metadata of the Amazon Bedrock provisioned model throughput used in the pipeline execution step.

" - } - }, - "BestObjectiveNotImproving": { - "base": "

A structure that keeps track of which training jobs launched by your hyperparameter tuning job are not improving model performance as evaluated against an objective function.

", - "refs": { - "TuningJobCompletionCriteria$BestObjectiveNotImproving": "

A flag to stop your hyperparameter tuning job if model performance fails to improve as evaluated against an objective function.

" - } - }, - "Bias": { - "base": "

Contains bias metrics for a model.

", - "refs": { - "ModelMetrics$Bias": "

Metrics that measure bias in a model.

" - } - }, - "BillableTimeInSeconds": { - "base": null, - "refs": { - "DescribeTrainingJobResponse$BillableTimeInSeconds": "

The billable time in seconds. Billable time refers to the absolute wall-clock time.

Multiply BillableTimeInSeconds by the number of instances (InstanceCount) in your training cluster to get the total compute time SageMaker bills you if you run distributed training. The formula is as follows: BillableTimeInSeconds * InstanceCount .

You can calculate the savings from using managed spot training using the formula (1 - BillableTimeInSeconds / TrainingTimeInSeconds) * 100. For example, if BillableTimeInSeconds is 100 and TrainingTimeInSeconds is 500, the savings is 80%.

", - "TrainingJob$BillableTimeInSeconds": "

The billable time in seconds.

" - } - }, - "BillableTokenCount": { - "base": null, - "refs": { - "DescribeTrainingJobResponse$BillableTokenCount": "

The billable token count for eligible serverless training jobs.

" - } - }, - "BlockedReason": { - "base": null, - "refs": { - "OfflineStoreStatus$BlockedReason": "

The justification for why the OfflineStoreStatus is Blocked (if applicable).

" - } - }, - "BlueGreenUpdatePolicy": { - "base": "

Update policy for a blue/green deployment. If this update policy is specified, SageMaker creates a new fleet during the deployment while maintaining the old fleet. SageMaker flips traffic to the new fleet according to the specified traffic routing configuration. Only one update policy should be used in the deployment configuration. If no update policy is specified, SageMaker uses a blue/green deployment strategy with all at once traffic shifting by default.

", - "refs": { - "DeploymentConfig$BlueGreenUpdatePolicy": "

Update policy for a blue/green deployment. If this update policy is specified, SageMaker creates a new fleet during the deployment while maintaining the old fleet. SageMaker flips traffic to the new fleet according to the specified traffic routing configuration. Only one update policy should be used in the deployment configuration. If no update policy is specified, SageMaker uses a blue/green deployment strategy with all at once traffic shifting by default.

" - } - }, - "Boolean": { - "base": null, - "refs": { - "AlgorithmSpecification$EnableSageMakerMetricsTimeSeries": "

To generate and save time-series metrics during training, set to true. The default is false and time-series metrics aren't generated except in the following cases:

", - "AutoMLSecurityConfig$EnableInterContainerTrafficEncryption": "

Whether to use traffic encryption between the container layers.

", - "BatchDataCaptureConfig$GenerateInferenceId": "

Flag that indicates whether to append inference id to the output.

", - "ChannelSpecification$IsRequired": "

Indicates whether the channel is required by the algorithm.

", - "ClarifyCheckStepMetadata$SkipCheck": "

This flag indicates if the drift check against the previous baseline will be skipped or not. If it is set to False, the previous baseline of the configured check type must be available.

", - "ClarifyCheckStepMetadata$RegisterNewBaseline": "

This flag indicates if a newly calculated baseline can be accessed through step properties BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. If it is set to False, the previous baseline of the configured check type must also be available. These can be accessed through the BaselineUsedForDriftCheckConstraints property.

", - "ClusterEbsVolumeConfig$RootVolume": "

Specifies whether the configuration is for the cluster's root or secondary Amazon EBS volume. You can specify two ClusterEbsVolumeConfig fields to configure both the root and secondary volumes. Set the value to True if you'd like to provide your own customer managed Amazon Web Services KMS key to encrypt the root volume. When True:

  • The configuration is applied to the root volume.

  • You can't specify the VolumeSizeInGB field. The size of the root volume is determined for you.

  • You must specify a KMS key ID for VolumeKmsKeyId to encrypt the root volume with your own KMS key instead of an Amazon Web Services owned KMS key.

Otherwise, by default, the value is False, and the following applies:

  • The configuration is applied to the secondary volume, while the root volume is encrypted with an Amazon Web Services owned key.

  • You must specify the VolumeSizeInGB field.

  • You can optionally specify the VolumeKmsKeyId to encrypt the secondary volume with your own KMS key instead of an Amazon Web Services owned KMS key.

", - "CreateAppRequest$RecoveryMode": "

Indicates whether the application is launched in recovery mode.

", - "CreateEndpointConfigInput$EnableNetworkIsolation": "

Sets whether all model containers deployed to the endpoint are isolated. If they are, no inbound or outbound network calls can be made to or from the model containers.

", - "CreateMlflowTrackingServerRequest$AutomaticModelRegistration": "

Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. To enable automatic model registration, set this value to True. To disable automatic model registration, set this value to False. If not specified, AutomaticModelRegistration defaults to False.

", - "CreateMlflowTrackingServerRequest$S3BucketOwnerVerification": "

Enable Amazon S3 Ownership checks when interacting with Amazon S3 buckets from a SageMaker Managed MLflow Tracking Server. Defaults to True if not provided.

", - "CreateModelInput$EnableNetworkIsolation": "

Isolates the model container. No inbound or outbound network calls can be made to or from the model container.

", - "CreatePartnerAppRequest$EnableIamSessionBasedIdentity": "

When set to TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user.

", - "CreatePartnerAppRequest$EnableAutoMinorVersionUpgrade": "

When set to TRUE, the SageMaker Partner AI App is automatically upgraded to the latest minor version during the next scheduled maintenance window, if one is available. Default is FALSE.

", - "CreateTrainingJobRequest$EnableNetworkIsolation": "

Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If you enable network isolation for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

", - "CreateTrainingJobRequest$EnableInterContainerTrafficEncryption": "

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training. For more information, see Protect Communications Between ML Compute Instances in a Distributed Training Job.

", - "CreateTrainingJobRequest$EnableManagedSpotTraining": "

To train models using managed spot training, choose True. Managed spot training provides a fully managed and scalable infrastructure for training machine learning models. this option is useful when training jobs can be interrupted and when there is flexibility when the training job is run.

The complete and intermediate results of jobs are stored in an Amazon S3 bucket, and can be used as a starting point to train models incrementally. Amazon SageMaker provides metrics and logs in CloudWatch. They can be used to see when managed spot training jobs are running, interrupted, resumed, or completed.

", - "DescribeAppResponse$RecoveryMode": "

Indicates whether the application is launched in recovery mode.

", - "DescribeEndpointConfigOutput$EnableNetworkIsolation": "

Indicates whether all model containers deployed to the endpoint are isolated. If they are, no inbound or outbound network calls can be made to or from the model containers.

", - "DescribeMlflowTrackingServerResponse$AutomaticModelRegistration": "

Whether automatic registration of new MLflow models to the SageMaker Model Registry is enabled.

", - "DescribeMlflowTrackingServerResponse$S3BucketOwnerVerification": "

Whether Amazon S3 Bucket Ownership checks are enabled whenever the tracking server interacts with Amazon Amazon S3.

", - "DescribeModelOutput$EnableNetworkIsolation": "

If True, no inbound or outbound network calls can be made to or from the model container.

", - "DescribePartnerAppRequest$IncludeAvailableUpgrade": "

When set to TRUE, the response includes available upgrade information for the SageMaker Partner AI App. Default is FALSE.

", - "DescribePartnerAppResponse$EnableIamSessionBasedIdentity": "

When set to TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user.

", - "DescribePartnerAppResponse$EnableAutoMinorVersionUpgrade": "

Indicates whether the SageMaker Partner AI App is configured for automatic minor version upgrades during scheduled maintenance windows.

", - "DescribeTrainingJobResponse$EnableNetworkIsolation": "

If you want to allow inbound or outbound network calls, except for calls between peers within a training cluster for distributed training, choose True. If you enable network isolation for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

", - "DescribeTrainingJobResponse$EnableInterContainerTrafficEncryption": "

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithms in distributed training.

", - "DescribeTrainingJobResponse$EnableManagedSpotTraining": "

A Boolean indicating whether managed spot training is enabled (True) or not (False).

", - "HyperParameterSpecification$IsTunable": "

Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.

", - "HyperParameterSpecification$IsRequired": "

Indicates whether this hyperparameter is required.

", - "HyperParameterTrainingJobDefinition$EnableNetworkIsolation": "

Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If network isolation is used for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

", - "HyperParameterTrainingJobDefinition$EnableInterContainerTrafficEncryption": "

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.

", - "HyperParameterTrainingJobDefinition$EnableManagedSpotTraining": "

A Boolean indicating whether managed spot training is enabled (True) or not (False).

", - "InstancePlacementConfig$EnableMultipleJobs": "

If set to true, allows multiple jobs to share the same UltraServer instances. If set to false, ensures this job's instances are placed on an UltraServer exclusively, with no other jobs sharing the same UltraServer. Default is false.

", - "ListStageDevicesRequest$ExcludeDevicesDeployedInOtherStage": "

Toggle for excluding devices deployed in other stages.

", - "Model$EnableNetworkIsolation": "

Isolates the model container. No inbound or outbound network calls can be made to or from the model container.

", - "ModelDashboardIndicatorAction$Enabled": "

Indicates whether the alert action is turned on.

", - "ModelPackageContainerDefinition$IsCheckpoint": "

Specifies whether the model data is a training checkpoint.

", - "MonitoringCsvDatasetFormat$Header": "

Indicates if the CSV data has a header.

", - "MonitoringJsonDatasetFormat$Line": "

Indicates if the file should be read as a JSON object per line.

", - "MonitoringNetworkConfig$EnableInterContainerTrafficEncryption": "

Whether to encrypt all communications between the instances used for the monitoring jobs. Choose True to encrypt communications. Encryption provides greater security for distributed jobs, but the processing might take longer.

", - "MonitoringNetworkConfig$EnableNetworkIsolation": "

Whether to allow inbound and outbound network calls to and from the containers used for the monitoring job.

", - "NetworkConfig$EnableInterContainerTrafficEncryption": "

Whether to encrypt all communications between distributed processing jobs. Choose True to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer.

", - "NetworkConfig$EnableNetworkIsolation": "

Whether to allow inbound and outbound network calls to and from the containers used for the processing job.

", - "OfflineStoreConfig$DisableGlueTableCreation": "

Set to True to disable the automatic creation of an Amazon Web Services Glue table when configuring an OfflineStore. If set to True and DataCatalogConfig is provided, Feature Store associates the provided catalog configuration with the feature group without creating a table. In this case, you are responsible for creating and managing the Glue table. If set to True without DataCatalogConfig, no Glue table is created or associated with the feature group. The Iceberg table format is only supported when this is set to False.

If set to False and DataCatalogConfig is provided, Feature Store creates the table using the specified names. If set to False without DataCatalogConfig, Feature Store auto-generates the table name following Athena's naming recommendations. This applies to both Glue and Apache Iceberg table formats.

The default value is False.

", - "OnlineStoreConfig$EnableOnlineStore": "

Turn OnlineStore off by specifying False for the EnableOnlineStore flag. Turn OnlineStore on by specifying True for the EnableOnlineStore flag.

The default value is False.

", - "PresignedUrlAccessConfig$AcceptEula": "

Indicates acceptance of the End User License Agreement (EULA) for gated models. Set to true to acknowledge acceptance of the license terms required for accessing gated content.

", - "QualityCheckStepMetadata$SkipCheck": "

This flag indicates if the drift check against the previous baseline will be skipped or not. If it is set to False, the previous baseline of the configured check type must be available.

", - "QualityCheckStepMetadata$RegisterNewBaseline": "

This flag indicates if a newly calculated baseline can be accessed through step properties BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. If it is set to False, the previous baseline of the configured check type must also be available. These can be accessed through the BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics properties.

", - "QueryLineageRequest$IncludeEdges": "

Setting this value to True retrieves not only the entities of interest but also the Associations and lineage entities on the path. Set to False to only return lineage entities that match your query.

", - "TrainingJob$EnableNetworkIsolation": "

If the TrainingJob was created with network isolation, the value is set to true. If network isolation is enabled, nodes can't communicate beyond the VPC they run in.

", - "TrainingJob$EnableInterContainerTrafficEncryption": "

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.

", - "TrainingJob$EnableManagedSpotTraining": "

When true, enables managed spot training using Amazon EC2 Spot instances to run training jobs instead of on-demand instances. For more information, see Managed Spot Training.

", - "TrainingSpecification$SupportsDistributedTraining": "

Indicates whether the algorithm supports distributed training. If set to false, buyers can't request more than one instance during training.

", - "UpdateEndpointInput$RetainAllVariantProperties": "

When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight. To retain the variant properties of an endpoint when updating it, set RetainAllVariantProperties to true. To use the variant properties specified in a new EndpointConfig call when updating an endpoint, set RetainAllVariantProperties to false. The default is false.

", - "UpdateEndpointInput$RetainDeploymentConfig": "

Specifies whether to reuse the last deployment configuration. The default value is false (the configuration is not reused).

", - "UpdateMlflowTrackingServerRequest$AutomaticModelRegistration": "

Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. To enable automatic model registration, set this value to True. To disable automatic model registration, set this value to False. If not specified, AutomaticModelRegistration defaults to False

", - "UpdateMlflowTrackingServerRequest$S3BucketOwnerVerification": "

Whether to enable or disable Amazon S3 Bucket Owenrship Verifaction whenever the MLflow Tracking Server interacts with Amazon Amazon S3.

", - "UpdatePartnerAppRequest$EnableIamSessionBasedIdentity": "

When set to TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user.

", - "UpdatePartnerAppRequest$EnableAutoMinorVersionUpgrade": "

When set to TRUE, the SageMaker Partner AI App is automatically upgraded to the latest minor version during the next scheduled maintenance window, if one is available.

" - } - }, - "BooleanOperator": { - "base": null, - "refs": { - "SearchExpression$Operator": "

A Boolean operator used to evaluate the search expression. If you want every conditional statement in all lists to be satisfied for the entire search expression to be true, specify And. If only a single conditional statement needs to be true for the entire search expression to be true, specify Or. The default value is And.

" - } - }, - "BorrowLimit": { - "base": null, - "refs": { - "ResourceSharingConfig$BorrowLimit": "

The limit on how much idle compute can be borrowed.The values can be 1 - 500 percent of idle compute that the team is allowed to borrow.

Default is 50.

" - } - }, - "Branch": { - "base": null, - "refs": { - "GitConfig$Branch": "

The default branch for the Git repository.

" - } - }, - "BucketName": { - "base": null, - "refs": { - "PipelineDefinitionS3Location$Bucket": "

Name of the S3 bucket.

" - } - }, - "CacheHitResult": { - "base": "

Details on the cache hit of a pipeline execution step.

", - "refs": { - "PipelineExecutionStep$CacheHitResult": "

If this pipeline execution step was cached, details on the cache hit.

" - } - }, - "CallbackStepMetadata": { - "base": "

Metadata about a callback step.

", - "refs": { - "PipelineExecutionStepMetadata$Callback": "

The URL of the Amazon SQS queue used by this step execution, the pipeline generated token, and a list of output parameters.

" - } - }, - "CallbackToken": { - "base": null, - "refs": { - "CallbackStepMetadata$CallbackToken": "

The pipeline generated token from the Amazon SQS queue.

", - "SendPipelineExecutionStepFailureRequest$CallbackToken": "

The pipeline generated token from the Amazon SQS queue.

", - "SendPipelineExecutionStepSuccessRequest$CallbackToken": "

The pipeline generated token from the Amazon SQS queue.

" - } - }, - "CandidateArtifactLocations": { - "base": "

The location of artifacts for an AutoML candidate job.

", - "refs": { - "CandidateProperties$CandidateArtifactLocations": "

The Amazon S3 prefix to the artifacts generated for an AutoML candidate.

" - } - }, - "CandidateDefinitionNotebookLocation": { - "base": null, - "refs": { - "AutoMLJobArtifacts$CandidateDefinitionNotebookLocation": "

The URL of the notebook location.

" - } - }, - "CandidateGenerationConfig": { - "base": "

Stores the configuration information for how model candidates are generated using an AutoML job V2.

", - "refs": { - "TabularJobConfig$CandidateGenerationConfig": "

The configuration information of how model candidates are generated.

", - "TimeSeriesForecastingJobConfig$CandidateGenerationConfig": null - } - }, - "CandidateName": { - "base": null, - "refs": { - "AutoMLCandidate$CandidateName": "

The name of the candidate.

", - "ListCandidatesForAutoMLJobRequest$CandidateNameEquals": "

List the candidates for the job and filter by candidate name.

" - } - }, - "CandidateProperties": { - "base": "

The properties of an AutoML candidate job.

", - "refs": { - "AutoMLCandidate$CandidateProperties": "

The properties of an AutoML candidate job.

" - } - }, - "CandidateSortBy": { - "base": null, - "refs": { - "ListCandidatesForAutoMLJobRequest$SortBy": "

The parameter by which to sort the results. The default is Descending.

" - } - }, - "CandidateStatus": { - "base": null, - "refs": { - "AutoMLCandidate$CandidateStatus": "

The candidate's status.

", - "ListCandidatesForAutoMLJobRequest$StatusEquals": "

List the candidates for the job and filter by status.

" - } - }, - "CandidateStepArn": { - "base": null, - "refs": { - "AutoMLCandidateStep$CandidateStepArn": "

The ARN for the candidate's step.

" - } - }, - "CandidateStepName": { - "base": null, - "refs": { - "AutoMLCandidateStep$CandidateStepName": "

The name for the candidate's step.

" - } - }, - "CandidateStepType": { - "base": null, - "refs": { - "AutoMLCandidateStep$CandidateStepType": "

Whether the candidate is at the transform, training, or processing step.

" - } - }, - "CandidateSteps": { - "base": null, - "refs": { - "AutoMLCandidate$CandidateSteps": "

Information about the candidate's steps.

" - } - }, - "CanvasAppSettings": { - "base": "

The SageMaker Canvas application settings.

", - "refs": { - "UserSettings$CanvasAppSettings": "

The Canvas app settings.

SageMaker applies these settings only to private spaces that SageMaker creates for the Canvas app.

" - } - }, - "CapacityReservation": { - "base": "

Information about the Capacity Reservation used by an instance or instance group.

", - "refs": { - "InstanceGroupMetadata$CapacityReservation": "

Information about the Capacity Reservation used by the instance group.

", - "InstanceMetadata$CapacityReservation": "

Information about the Capacity Reservation used by the instance.

" - } - }, - "CapacityReservationPreference": { - "base": null, - "refs": { - "ProductionVariantCapacityReservationConfig$CapacityReservationPreference": "

Options that you can choose for the capacity reservation. SageMaker AI supports the following options:

capacity-reservations-only

SageMaker AI launches instances only into an ML capacity reservation. If no capacity is available, the instances fail to launch.

", - "ProductionVariantCapacityReservationSummary$CapacityReservationPreference": "

The option that you chose for the capacity reservation. SageMaker AI supports the following options:

capacity-reservations-only

SageMaker AI launches instances only into an ML capacity reservation. If no capacity is available, the instances fail to launch.

" - } - }, - "CapacityReservationType": { - "base": null, - "refs": { - "CapacityReservation$Type": "

The type of Capacity Reservation. Valid values are ODCR (On-Demand Capacity Reservation) or CRG (Capacity Reservation Group).

" - } - }, - "CapacitySize": { - "base": "

Specifies the type and size of the endpoint capacity to activate for a blue/green deployment, a rolling deployment, or a rollback strategy. You can specify your batches as either instance count or the overall percentage or your fleet.

For a rollback strategy, if you don't specify the fields in this object, or if you set the Value to 100%, then SageMaker uses a blue/green rollback strategy and rolls all traffic back to the blue fleet.

", - "refs": { - "RollingUpdatePolicy$MaximumBatchSize": "

Batch size for each rolling step to provision capacity and turn on traffic on the new endpoint fleet, and terminate capacity on the old endpoint fleet. Value must be between 5% to 50% of the variant's total instance count.

", - "RollingUpdatePolicy$RollbackMaximumBatchSize": "

Batch size for rollback to the old endpoint fleet. Each rolling step to provision capacity and turn on traffic on the old endpoint fleet, and terminate capacity on the new endpoint fleet. If this field is absent, the default value will be set to 100% of total capacity which means to bring up the whole capacity of the old fleet at once during rollback.

", - "TrafficRoutingConfig$CanarySize": "

Batch size for the first step to turn on traffic on the new endpoint fleet. Value must be less than or equal to 50% of the variant's total instance count.

", - "TrafficRoutingConfig$LinearStepSize": "

Batch size for each step to turn on traffic on the new endpoint fleet. Value must be 10-50% of the variant's total instance count.

" - } - }, - "CapacitySizeConfig": { - "base": "

The configuration of the size measurements of the AMI update. Using this configuration, you can specify whether SageMaker should update your instance group by an amount or percentage of instances.

", - "refs": { - "RollingDeploymentPolicy$MaximumBatchSize": "

The maximum amount of instances in the cluster that SageMaker can update at a time.

", - "RollingDeploymentPolicy$RollbackMaximumBatchSize": "

The maximum amount of instances in the cluster that SageMaker can roll back at a time.

" - } - }, - "CapacitySizeType": { - "base": null, - "refs": { - "CapacitySize$Type": "

Specifies the endpoint capacity type.

  • INSTANCE_COUNT: The endpoint activates based on the number of instances.

  • CAPACITY_PERCENT: The endpoint activates based on the specified percentage of capacity.

" - } - }, - "CapacitySizeValue": { - "base": null, - "refs": { - "CapacitySize$Value": "

Defines the capacity size, either as a number of instances or a capacity percentage.

", - "InferenceComponentCapacitySize$Value": "

Defines the capacity size, either as a number of inference component copies or a capacity percentage.

" - } - }, - "CapacityUnit": { - "base": null, - "refs": { - "ThroughputConfig$ProvisionedReadCapacityUnits": "

For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.

This field is not applicable for on-demand feature groups.

", - "ThroughputConfig$ProvisionedWriteCapacityUnits": "

For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.

This field is not applicable for on-demand feature groups.

", - "ThroughputConfigDescription$ProvisionedReadCapacityUnits": "

For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.

This field is not applicable for on-demand feature groups.

", - "ThroughputConfigDescription$ProvisionedWriteCapacityUnits": "

For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.

This field is not applicable for on-demand feature groups.

", - "ThroughputConfigUpdate$ProvisionedReadCapacityUnits": "

For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.

", - "ThroughputConfigUpdate$ProvisionedWriteCapacityUnits": "

For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.

" - } - }, - "CaptureContentTypeHeader": { - "base": "

Configuration specifying how to treat different headers. If no headers are specified Amazon SageMaker AI will by default base64 encode when capturing the data.

", - "refs": { - "DataCaptureConfig$CaptureContentTypeHeader": "

Configuration specifying how to treat different headers. If no headers are specified SageMaker AI will by default base64 encode when capturing the data.

", - "InferenceExperimentDataStorageConfig$ContentType": null - } - }, - "CaptureMode": { - "base": null, - "refs": { - "CaptureOption$CaptureMode": "

Specify the boundary of data to capture.

" - } - }, - "CaptureOption": { - "base": "

Specifies data Model Monitor will capture.

", - "refs": { - "CaptureOptionList$member": null - } - }, - "CaptureOptionList": { - "base": null, - "refs": { - "DataCaptureConfig$CaptureOptions": "

Specifies data Model Monitor will capture. You can configure whether to collect only input, only output, or both

" - } - }, - "CaptureStatus": { - "base": null, - "refs": { - "DataCaptureConfigSummary$CaptureStatus": "

Whether data capture is currently functional.

" - } - }, - "Catalog": { - "base": null, - "refs": { - "DataCatalogConfig$Catalog": "

The name of the Glue table catalog.

" - } - }, - "CategoricalParameter": { - "base": "

Environment parameters you want to benchmark your load test against.

", - "refs": { - "CategoricalParameters$member": null - } - }, - "CategoricalParameterRange": { - "base": "

A list of categorical hyperparameters to tune.

", - "refs": { - "CategoricalParameterRanges$member": null - } - }, - "CategoricalParameterRangeSpecification": { - "base": "

Defines the possible values for a categorical hyperparameter.

", - "refs": { - "ParameterRange$CategoricalParameterRangeSpecification": "

A CategoricalParameterRangeSpecification object that defines the possible values for a categorical hyperparameter.

" - } - }, - "CategoricalParameterRangeValues": { - "base": null, - "refs": { - "CategoricalParameter$Value": "

The list of values you can pass.

" - } - }, - "CategoricalParameterRanges": { - "base": null, - "refs": { - "ParameterRanges$CategoricalParameterRanges": "

The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.

" - } - }, - "CategoricalParameters": { - "base": null, - "refs": { - "EnvironmentParameterRanges$CategoricalParameterRanges": "

Specified a list of parameters for each category.

" - } - }, - "Cents": { - "base": null, - "refs": { - "USD$Cents": "

The fractional portion, in cents, of the amount.

" - } - }, - "CertifyForMarketplace": { - "base": null, - "refs": { - "CreateAlgorithmInput$CertifyForMarketplace": "

Whether to certify the algorithm so that it can be listed in Amazon Web Services Marketplace.

", - "CreateModelPackageInput$CertifyForMarketplace": "

Whether to certify the model package for listing on Amazon Web Services Marketplace.

This parameter is optional for unversioned models, and does not apply to versioned models.

", - "DescribeAlgorithmOutput$CertifyForMarketplace": "

Whether the algorithm is certified to be listed in Amazon Web Services Marketplace.

", - "DescribeModelPackageOutput$CertifyForMarketplace": "

Whether the model package is certified for listing on Amazon Web Services Marketplace.

", - "ModelPackage$CertifyForMarketplace": "

Whether the model package is to be certified to be listed on Amazon Web Services Marketplace. For information about listing model packages on Amazon Web Services Marketplace, see List Your Algorithm or Model Package on Amazon Web Services Marketplace.

" - } - }, - "CfnCreateTemplateProvider": { - "base": "

The CloudFormation template provider configuration for creating infrastructure resources.

", - "refs": { - "CreateTemplateProvider$CfnTemplateProvider": "

The CloudFormation template provider configuration for creating infrastructure resources.

" - } - }, - "CfnStackCreateParameter": { - "base": "

A key-value pair that represents a parameter for the CloudFormation stack.

", - "refs": { - "CfnStackCreateParameters$member": null - } - }, - "CfnStackCreateParameters": { - "base": null, - "refs": { - "CfnCreateTemplateProvider$Parameters": "

An array of CloudFormation stack parameters.

" - } - }, - "CfnStackDetail": { - "base": "

Details about the CloudFormation stack.

", - "refs": { - "CfnTemplateProviderDetail$StackDetail": "

Information about the CloudFormation stack created by the template provider.

" - } - }, - "CfnStackId": { - "base": null, - "refs": { - "CfnStackDetail$Id": "

The unique identifier of the CloudFormation stack.

" - } - }, - "CfnStackName": { - "base": null, - "refs": { - "CfnStackDetail$Name": "

The name of the CloudFormation stack.

" - } - }, - "CfnStackParameter": { - "base": "

A key-value pair representing a parameter used in the CloudFormation stack.

", - "refs": { - "CfnStackParameters$member": null - } - }, - "CfnStackParameterKey": { - "base": null, - "refs": { - "CfnStackCreateParameter$Key": "

The name of the CloudFormation parameter.

", - "CfnStackParameter$Key": "

The name of the CloudFormation parameter.

", - "CfnStackUpdateParameter$Key": "

The name of the CloudFormation parameter.

" - } - }, - "CfnStackParameterValue": { - "base": null, - "refs": { - "CfnStackCreateParameter$Value": "

The value of the CloudFormation parameter.

", - "CfnStackParameter$Value": "

The value of the CloudFormation parameter.

", - "CfnStackUpdateParameter$Value": "

The value of the CloudFormation parameter.

" - } - }, - "CfnStackParameters": { - "base": null, - "refs": { - "CfnTemplateProviderDetail$Parameters": "

An array of CloudFormation stack parameters.

" - } - }, - "CfnStackStatusMessage": { - "base": null, - "refs": { - "CfnStackDetail$StatusMessage": "

A human-readable message about the stack's current status.

" - } - }, - "CfnStackUpdateParameter": { - "base": "

A key-value pair representing a parameter used in the CloudFormation stack.

", - "refs": { - "CfnStackUpdateParameters$member": null - } - }, - "CfnStackUpdateParameters": { - "base": null, - "refs": { - "CfnUpdateTemplateProvider$Parameters": "

An array of CloudFormation stack parameters.

" - } - }, - "CfnTemplateName": { - "base": null, - "refs": { - "CfnCreateTemplateProvider$TemplateName": "

A unique identifier for the template within the project.

", - "CfnTemplateProviderDetail$TemplateName": "

The unique identifier of the template within the project.

", - "CfnUpdateTemplateProvider$TemplateName": "

The unique identifier of the template to update within the project.

" - } - }, - "CfnTemplateProviderDetail": { - "base": "

Details about a CloudFormation template provider configuration and associated provisioning information.

", - "refs": { - "TemplateProviderDetail$CfnTemplateProviderDetail": "

Details about a CloudFormation template provider configuration and associated provisioning information.

" - } - }, - "CfnTemplateURL": { - "base": null, - "refs": { - "CfnCreateTemplateProvider$TemplateURL": "

The Amazon S3 URL of the CloudFormation template.

", - "CfnTemplateProviderDetail$TemplateURL": "

The Amazon S3 URL of the CloudFormation template.

", - "CfnUpdateTemplateProvider$TemplateURL": "

The Amazon S3 URL of the CloudFormation template.

" - } - }, - "CfnUpdateTemplateProvider": { - "base": "

Contains configuration details for updating an existing CloudFormation template provider in the project.

", - "refs": { - "UpdateTemplateProvider$CfnTemplateProvider": "

The CloudFormation template provider configuration to update.

" - } - }, - "Channel": { - "base": "

A channel is a named input source that training algorithms can consume.

", - "refs": { - "InputDataConfig$member": null - } - }, - "ChannelName": { - "base": null, - "refs": { - "Channel$ChannelName": "

The name of the channel.

", - "ChannelSpecification$Name": "

The name of the channel.

" - } - }, - "ChannelSpecification": { - "base": "

Defines a named input source, called a channel, to be used by an algorithm.

", - "refs": { - "ChannelSpecifications$member": null - } - }, - "ChannelSpecifications": { - "base": null, - "refs": { - "TrainingSpecification$TrainingChannels": "

A list of ChannelSpecification objects, which specify the input sources to be used by the algorithm.

" - } - }, - "CheckpointConfig": { - "base": "

Contains information about the output location for managed spot training checkpoint data.

", - "refs": { - "CreateTrainingJobRequest$CheckpointConfig": "

Contains information about the output location for managed spot training checkpoint data.

", - "DescribeTrainingJobResponse$CheckpointConfig": null, - "HyperParameterTrainingJobDefinition$CheckpointConfig": null, - "TrainingJob$CheckpointConfig": null - } - }, - "Cidr": { - "base": null, - "refs": { - "Cidrs$member": null - } - }, - "Cidrs": { - "base": null, - "refs": { - "SourceIpConfig$Cidrs": "

A list of one to ten Classless Inter-Domain Routing (CIDR) values.

Maximum: Ten CIDR values

The following Length Constraints apply to individual CIDR values in the CIDR value list.

" - } - }, - "ClarifyCheckStepMetadata": { - "base": "

The container for the metadata for the ClarifyCheck step. For more information, see the topic on ClarifyCheck step in the Amazon SageMaker Developer Guide.

", - "refs": { - "PipelineExecutionStepMetadata$ClarifyCheck": "

Container for the metadata for a Clarify check step. The configurations and outcomes of the check step execution. This includes:

  • The type of the check conducted,

  • The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.

  • The Amazon S3 URIs of newly calculated baseline constraints and statistics.

  • The model package group name provided.

  • The Amazon S3 URI of the violation report if violations detected.

  • The Amazon Resource Name (ARN) of check processing job initiated by the step execution.

  • The boolean flags indicating if the drift check is skipped.

  • If step property BaselineUsedForDriftCheck is set the same as CalculatedBaseline.

" - } - }, - "ClarifyContentTemplate": { - "base": null, - "refs": { - "ClarifyInferenceConfig$ContentTemplate": "

A template string used to format a JSON record into an acceptable model container input. For example, a ContentTemplate string '{\"myfeatures\":$features}' will format a list of features [1,2,3] into the record string '{\"myfeatures\":[1,2,3]}'. Required only when the model container input is in JSON Lines format.

" - } - }, - "ClarifyEnableExplanations": { - "base": null, - "refs": { - "ClarifyExplainerConfig$EnableExplanations": "

A JMESPath boolean expression used to filter which records to explain. Explanations are activated by default. See EnableExplanations for additional information.

" - } - }, - "ClarifyExplainerConfig": { - "base": "

The configuration parameters for the SageMaker Clarify explainer.

", - "refs": { - "ExplainerConfig$ClarifyExplainerConfig": "

A member of ExplainerConfig that contains configuration parameters for the SageMaker Clarify explainer.

" - } - }, - "ClarifyFeatureHeaders": { - "base": null, - "refs": { - "ClarifyInferenceConfig$FeatureHeaders": "

The names of the features. If provided, these are included in the endpoint response payload to help readability of the InvokeEndpoint output. See the Response section under Invoke the endpoint in the Developer Guide for more information.

" - } - }, - "ClarifyFeatureType": { - "base": null, - "refs": { - "ClarifyFeatureTypes$member": null - } - }, - "ClarifyFeatureTypes": { - "base": null, - "refs": { - "ClarifyInferenceConfig$FeatureTypes": "

A list of data types of the features (optional). Applicable only to NLP explainability. If provided, FeatureTypes must have at least one 'text' string (for example, ['text']). If FeatureTypes is not provided, the explainer infers the feature types based on the baseline data. The feature types are included in the endpoint response payload. For additional information see the response section under Invoke the endpoint in the Developer Guide for more information.

" - } - }, - "ClarifyFeaturesAttribute": { - "base": null, - "refs": { - "ClarifyInferenceConfig$FeaturesAttribute": "

Provides the JMESPath expression to extract the features from a model container input in JSON Lines format. For example, if FeaturesAttribute is the JMESPath expression 'myfeatures', it extracts a list of features [1,2,3] from request data '{\"myfeatures\":[1,2,3]}'.

" - } - }, - "ClarifyHeader": { - "base": null, - "refs": { - "ClarifyFeatureHeaders$member": null, - "ClarifyLabelHeaders$member": null - } - }, - "ClarifyInferenceConfig": { - "base": "

The inference configuration parameter for the model container.

", - "refs": { - "ClarifyExplainerConfig$InferenceConfig": "

The inference configuration parameter for the model container.

" - } - }, - "ClarifyLabelAttribute": { - "base": null, - "refs": { - "ClarifyInferenceConfig$LabelAttribute": "

A JMESPath expression used to locate the list of label headers in the model container output.

Example: If the model container output of a batch request is '{\"labels\":[\"cat\",\"dog\",\"fish\"],\"probability\":[0.6,0.3,0.1]}', then set LabelAttribute to 'labels' to extract the list of label headers [\"cat\",\"dog\",\"fish\"]

" - } - }, - "ClarifyLabelHeaders": { - "base": null, - "refs": { - "ClarifyInferenceConfig$LabelHeaders": "

For multiclass classification problems, the label headers are the names of the classes. Otherwise, the label header is the name of the predicted label. These are used to help readability for the output of the InvokeEndpoint API. See the response section under Invoke the endpoint in the Developer Guide for more information. If there are no label headers in the model container output, provide them manually using this parameter.

" - } - }, - "ClarifyLabelIndex": { - "base": null, - "refs": { - "ClarifyInferenceConfig$LabelIndex": "

A zero-based index used to extract a label header or list of label headers from model container output in CSV format.

Example for a multiclass model: If the model container output consists of label headers followed by probabilities: '\"[\\'cat\\',\\'dog\\',\\'fish\\']\",\"[0.1,0.6,0.3]\"', set LabelIndex to 0 to select the label headers ['cat','dog','fish'].

" - } - }, - "ClarifyMaxPayloadInMB": { - "base": null, - "refs": { - "ClarifyInferenceConfig$MaxPayloadInMB": "

The maximum payload size (MB) allowed of a request from the explainer to the model container. Defaults to 6 MB.

" - } - }, - "ClarifyMaxRecordCount": { - "base": null, - "refs": { - "ClarifyInferenceConfig$MaxRecordCount": "

The maximum number of records in a request that the model container can process when querying the model container for the predictions of a synthetic dataset. A record is a unit of input data that inference can be made on, for example, a single line in CSV data. If MaxRecordCount is 1, the model container expects one record per request. A value of 2 or greater means that the model expects batch requests, which can reduce overhead and speed up the inferencing process. If this parameter is not provided, the explainer will tune the record count per request according to the model container's capacity at runtime.

" - } - }, - "ClarifyMimeType": { - "base": null, - "refs": { - "ClarifyShapBaselineConfig$MimeType": "

The MIME type of the baseline data. Choose from 'text/csv' or 'application/jsonlines'. Defaults to 'text/csv'.

" - } - }, - "ClarifyProbabilityAttribute": { - "base": null, - "refs": { - "ClarifyInferenceConfig$ProbabilityAttribute": "

A JMESPath expression used to extract the probability (or score) from the model container output if the model container is in JSON Lines format.

Example: If the model container output of a single request is '{\"predicted_label\":1,\"probability\":0.6}', then set ProbabilityAttribute to 'probability'.

" - } - }, - "ClarifyProbabilityIndex": { - "base": null, - "refs": { - "ClarifyInferenceConfig$ProbabilityIndex": "

A zero-based index used to extract a probability value (score) or list from model container output in CSV format. If this value is not provided, the entire model container output will be treated as a probability value (score) or list.

Example for a single class model: If the model container output consists of a string-formatted prediction label followed by its probability: '1,0.6', set ProbabilityIndex to 1 to select the probability value 0.6.

Example for a multiclass model: If the model container output consists of a string-formatted prediction label followed by its probability: '\"[\\'cat\\',\\'dog\\',\\'fish\\']\",\"[0.1,0.6,0.3]\"', set ProbabilityIndex to 1 to select the probability values [0.1,0.6,0.3].

" - } - }, - "ClarifyShapBaseline": { - "base": null, - "refs": { - "ClarifyShapBaselineConfig$ShapBaseline": "

The inline SHAP baseline data in string format. ShapBaseline can have one or multiple records to be used as the baseline dataset. The format of the SHAP baseline file should be the same format as the training dataset. For example, if the training dataset is in CSV format and each record contains four features, and all features are numerical, then the format of the baseline data should also share these characteristics. For natural language processing (NLP) of text columns, the baseline value should be the value used to replace the unit of text specified by the Granularity of the TextConfig parameter. The size limit for ShapBasline is 4 KB. Use the ShapBaselineUri parameter if you want to provide more than 4 KB of baseline data.

" - } - }, - "ClarifyShapBaselineConfig": { - "base": "

The configuration for the SHAP baseline (also called the background or reference dataset) of the Kernal SHAP algorithm.

  • The number of records in the baseline data determines the size of the synthetic dataset, which has an impact on latency of explainability requests. For more information, see the Synthetic data of Configure and create an endpoint.

  • ShapBaseline and ShapBaselineUri are mutually exclusive parameters. One or the either is required to configure a SHAP baseline.

", - "refs": { - "ClarifyShapConfig$ShapBaselineConfig": "

The configuration for the SHAP baseline of the Kernal SHAP algorithm.

" - } - }, - "ClarifyShapConfig": { - "base": "

The configuration for SHAP analysis using SageMaker Clarify Explainer.

", - "refs": { - "ClarifyExplainerConfig$ShapConfig": "

The configuration for SHAP analysis.

" - } - }, - "ClarifyShapNumberOfSamples": { - "base": null, - "refs": { - "ClarifyShapConfig$NumberOfSamples": "

The number of samples to be used for analysis by the Kernal SHAP algorithm.

The number of samples determines the size of the synthetic dataset, which has an impact on latency of explainability requests. For more information, see the Synthetic data of Configure and create an endpoint.

" - } - }, - "ClarifyShapSeed": { - "base": null, - "refs": { - "ClarifyShapConfig$Seed": "

The starting value used to initialize the random number generator in the explainer. Provide a value for this parameter to obtain a deterministic SHAP result.

" - } - }, - "ClarifyShapUseLogit": { - "base": null, - "refs": { - "ClarifyShapConfig$UseLogit": "

A Boolean toggle to indicate if you want to use the logit function (true) or log-odds units (false) for model predictions. Defaults to false.

" - } - }, - "ClarifyTextConfig": { - "base": "

A parameter used to configure the SageMaker Clarify explainer to treat text features as text so that explanations are provided for individual units of text. Required only for natural language processing (NLP) explainability.

", - "refs": { - "ClarifyShapConfig$TextConfig": "

A parameter that indicates if text features are treated as text and explanations are provided for individual units of text. Required for natural language processing (NLP) explainability only.

" - } - }, - "ClarifyTextGranularity": { - "base": null, - "refs": { - "ClarifyTextConfig$Granularity": "

The unit of granularity for the analysis of text features. For example, if the unit is 'token', then each token (like a word in English) of the text is treated as a feature. SHAP values are computed for each unit/feature.

" - } - }, - "ClarifyTextLanguage": { - "base": null, - "refs": { - "ClarifyTextConfig$Language": "

Specifies the language of the text features in ISO 639-1 or ISO 639-3 code of a supported language.

For a mix of multiple languages, use code 'xx'.

" - } - }, - "ClientId": { - "base": null, - "refs": { - "CognitoConfig$ClientId": "

The client ID for your Amazon Cognito user pool.

", - "CognitoMemberDefinition$ClientId": "

An identifier for an application client. You must create the app client ID using Amazon Cognito.

", - "OidcConfig$ClientId": "

The OIDC IdP client ID used to configure your private workforce.

", - "OidcConfigForResponse$ClientId": "

The OIDC IdP client ID used to configure your private workforce.

" - } - }, - "ClientSecret": { - "base": null, - "refs": { - "OidcConfig$ClientSecret": "

The OIDC IdP client secret used to configure your private workforce.

" - } - }, - "ClientToken": { - "base": null, - "refs": { - "CreateImageVersionRequest$ClientToken": "

A unique ID. If not specified, the Amazon Web Services CLI and Amazon Web Services SDKs, such as the SDK for Python (Boto3), add a unique value to the call.

", - "CreateModelPackageInput$ClientToken": "

A unique token that guarantees that the call to this API is idempotent.

", - "CreatePartnerAppRequest$ClientToken": "

A unique token that guarantees that the call to this API is idempotent.

", - "DeletePartnerAppRequest$ClientToken": "

A unique token that guarantees that the call to this API is idempotent.

", - "UpdateModelPackageInput$ClientToken": "

A unique token that guarantees that the call to this API is idempotent.

", - "UpdatePartnerAppRequest$ClientToken": "

A unique token that guarantees that the call to this API is idempotent.

" - } - }, - "ClusterArn": { - "base": null, - "refs": { - "AttachClusterNodeVolumeRequest$ClusterArn": "

The Amazon Resource Name (ARN) of your SageMaker HyperPod cluster containing the target node. Your cluster must use EKS as the orchestration and be in the InService state.

", - "AttachClusterNodeVolumeResponse$ClusterArn": "

The Amazon Resource Name (ARN) of your SageMaker HyperPod cluster where the volume attachment operation was performed.

", - "ClusterEventDetail$ClusterArn": "

The Amazon Resource Name (ARN) of the HyperPod cluster associated with the event.

", - "ClusterEventSummary$ClusterArn": "

The Amazon Resource Name (ARN) of the HyperPod cluster associated with the event.

", - "ClusterSchedulerConfigSummary$ClusterArn": "

ARN of the cluster.

", - "ClusterSummary$ClusterArn": "

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

", - "ComputeQuotaSummary$ClusterArn": "

ARN of the cluster.

", - "CreateClusterResponse$ClusterArn": "

The Amazon Resource Name (ARN) of the cluster.

", - "CreateClusterSchedulerConfigRequest$ClusterArn": "

ARN of the cluster.

", - "CreateComputeQuotaRequest$ClusterArn": "

ARN of the cluster.

", - "DeleteClusterResponse$ClusterArn": "

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster to delete.

", - "DescribeClusterResponse$ClusterArn": "

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

", - "DescribeClusterSchedulerConfigResponse$ClusterArn": "

ARN of the cluster where the cluster policy is applied.

", - "DescribeComputeQuotaResponse$ClusterArn": "

ARN of the cluster.

", - "DetachClusterNodeVolumeRequest$ClusterArn": "

The Amazon Resource Name (ARN) of your SageMaker HyperPod cluster containing the target node. Your cluster must use EKS as the orchestration and be in the InService state.

", - "DetachClusterNodeVolumeResponse$ClusterArn": "

The Amazon Resource Name (ARN) of your SageMaker HyperPod cluster where the volume detachment operation was performed.

", - "ListClusterSchedulerConfigsRequest$ClusterArn": "

Filter for ARN of the cluster.

", - "ListComputeQuotasRequest$ClusterArn": "

Filter for ARN of the cluster.

", - "StartClusterHealthCheckResponse$ClusterArn": "

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster on which the deep health checks were initiated.

", - "UpdateClusterResponse$ClusterArn": "

The Amazon Resource Name (ARN) of the updated SageMaker HyperPod cluster.

", - "UpdateClusterSoftwareResponse$ClusterArn": "

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster being updated for security patching.

" - } - }, - "ClusterAutoPatchConfig": { - "base": "

The configuration for automatic patching of the instance group. When configured, the system automatically applies security patch AMI updates to the instance group.

", - "refs": { - "ClusterInstanceGroupSpecification$AutoPatchConfig": "

The configuration for automatic OS security patching. If present, the system automatically applies PATCH AMI updates to this instance group.

" - } - }, - "ClusterAutoPatchConfigDetails": { - "base": "

The auto-patching configuration details for the instance group, including the patching strategy and schedule.

", - "refs": { - "ClusterInstanceGroupDetails$AutoPatchConfig": "

The auto-patching configuration for the instance group, including the current patching strategy and next scheduled patch date.

" - } - }, - "ClusterAutoScalerType": { - "base": null, - "refs": { - "ClusterAutoScalingConfig$AutoScalerType": "

The type of autoscaler to use. Currently supported value is Karpenter.

", - "ClusterAutoScalingConfigOutput$AutoScalerType": "

The type of autoscaler configured for the cluster.

" - } - }, - "ClusterAutoScalingConfig": { - "base": "

Specifies the autoscaling configuration for a HyperPod cluster.

", - "refs": { - "CreateClusterRequest$AutoScaling": "

The autoscaling configuration for the cluster. Enables automatic scaling of cluster nodes based on workload demand using a Karpenter-based system.

", - "UpdateClusterRequest$AutoScaling": "

Updates the autoscaling configuration for the cluster. Use to enable or disable automatic node scaling.

" - } - }, - "ClusterAutoScalingConfigOutput": { - "base": "

The autoscaling configuration and status information for a HyperPod cluster.

", - "refs": { - "DescribeClusterResponse$AutoScaling": "

The current autoscaling configuration and status for the autoscaler.

" - } - }, - "ClusterAutoScalingMode": { - "base": null, - "refs": { - "ClusterAutoScalingConfig$Mode": "

Describes whether autoscaling is enabled or disabled for the cluster. Valid values are Enable and Disable.

", - "ClusterAutoScalingConfigOutput$Mode": "

Describes whether autoscaling is enabled or disabled for the cluster.

" - } - }, - "ClusterAutoScalingStatus": { - "base": null, - "refs": { - "ClusterAutoScalingConfigOutput$Status": "

The current status of the autoscaling configuration. Valid values are InService, Failed, Creating, and Deleting.

" - } - }, - "ClusterAvailabilityZone": { - "base": null, - "refs": { - "ClusterAvailabilityZones$member": null, - "ClusterInstancePlacement$AvailabilityZone": "

The Availability Zone where the node in the SageMaker HyperPod cluster is launched.

" - } - }, - "ClusterAvailabilityZoneId": { - "base": null, - "refs": { - "ClusterInstancePlacement$AvailabilityZoneId": "

The unique identifier (ID) of the Availability Zone where the node in the SageMaker HyperPod cluster is launched.

" - } - }, - "ClusterAvailabilityZones": { - "base": null, - "refs": { - "AddClusterNodeSpecification$AvailabilityZones": "

The availability zones in which to add nodes. Use this to target node placement in specific availability zones within a flexible instance group.

", - "BatchAddClusterNodesError$AvailabilityZones": "

The availability zones associated with the failed node addition request.

", - "NodeAdditionResult$AvailabilityZones": "

The availability zones associated with the successfully added node.

" - } - }, - "ClusterCapacityRequirements": { - "base": "

Defines the instance capacity requirements for an instance group, including configurations for both Spot and On-Demand capacity types.

", - "refs": { - "ClusterInstanceGroupDetails$CapacityRequirements": "

The instance capacity requirements for the instance group.

", - "ClusterInstanceGroupSpecification$CapacityRequirements": "

Specifies the capacity requirements for the instance group.

" - } - }, - "ClusterCapacityType": { - "base": null, - "refs": { - "ClusterNodeDetails$CapacityType": "

The capacity type of the node. Valid values are OnDemand and Spot. When set to OnDemand, the node is launched as an On-Demand instance. When set to Spot, the node is launched as a Spot instance.

" - } - }, - "ClusterConfigMode": { - "base": null, - "refs": { - "ClusterTieredStorageConfig$Mode": "

Specifies whether managed tier checkpointing is enabled or disabled for the HyperPod cluster. When set to Enable, the system installs a memory management daemon that provides disaggregated memory as a service for checkpoint storage. When set to Disable, the feature is turned off and the memory management daemon is removed from the cluster.

" - } - }, - "ClusterDnsName": { - "base": null, - "refs": { - "ClusterFsxLustreConfig$DnsName": "

The DNS name of the Amazon FSx for Lustre file system.

", - "ClusterFsxOpenZfsConfig$DnsName": "

The DNS name of the Amazon FSx for OpenZFS file system.

" - } - }, - "ClusterEbsVolumeConfig": { - "base": "

Defines the configuration for attaching an additional Amazon Elastic Block Store (EBS) volume to each instance of the SageMaker HyperPod cluster instance group. To learn more, see SageMaker HyperPod release notes: June 20, 2024.

", - "refs": { - "ClusterInstanceStorageConfig$EbsVolumeConfig": "

Defines the configuration for attaching additional Amazon Elastic Block Store (EBS) volumes to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each instance within the SageMaker HyperPod cluster instance group and mounted to /opt/sagemaker.

" - } - }, - "ClusterEbsVolumeSizeInGB": { - "base": null, - "refs": { - "ClusterEbsVolumeConfig$VolumeSizeInGB": "

The size in gigabytes (GB) of the additional EBS volume to be attached to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each instance within the SageMaker HyperPod cluster instance group and mounted to /opt/sagemaker.

" - } - }, - "ClusterEventDetail": { - "base": "

Detailed information about a specific event in a HyperPod cluster.

", - "refs": { - "DescribeClusterEventResponse$EventDetails": "

Detailed information about the requested cluster event, including event metadata for various resource types such as Cluster, InstanceGroup, Instance, and their associated attributes.

" - } - }, - "ClusterEventLevel": { - "base": "

The severity level for a HyperPod cluster event.

", - "refs": { - "ClusterEventDetail$EventLevel": "

The severity level of the event. Valid values are Info, Warn, and Error.

", - "ClusterEventSummary$EventLevel": "

The severity level of the event. Valid values are Info, Warn, and Error.

" - } - }, - "ClusterEventMaxResults": { - "base": null, - "refs": { - "ListClusterEventsRequest$MaxResults": "

The maximum number of events to return in the response. Valid range is 1 to 100.

" - } - }, - "ClusterEventResourceType": { - "base": null, - "refs": { - "ClusterEventDetail$ResourceType": "

The type of resource associated with the event. Valid values are Cluster, InstanceGroup, or Instance.

", - "ClusterEventSummary$ResourceType": "

The type of resource associated with the event. Valid values are Cluster, InstanceGroup, or Instance.

", - "ListClusterEventsRequest$ResourceType": "

The type of resource for which to filter events. Valid values are Cluster, InstanceGroup, or Instance.

" - } - }, - "ClusterEventSummaries": { - "base": null, - "refs": { - "ListClusterEventsResponse$Events": "

A list of event summaries matching the specified criteria.

" - } - }, - "ClusterEventSummary": { - "base": "

A summary of an event in a HyperPod cluster.

", - "refs": { - "ClusterEventSummaries$member": null - } - }, - "ClusterFSxLustreDeletionPolicy": { - "base": "

The deletion policy for the Amazon FSx for Lustre file system used in the shared environment of restricted instance groups (RIG).

", - "refs": { - "ClusterSharedEnvironmentConfig$FSxLustreDeletionPolicy": "

The deletion policy for the Amazon FSx for Lustre file system in the shared environment.

", - "ClusterSharedEnvironmentConfigDetails$CurrentFSxLustreDeletionPolicy": "

The current deletion policy for the Amazon FSx for Lustre file system in the shared environment.

", - "ClusterSharedEnvironmentConfigDetails$DesiredFSxLustreDeletionPolicy": "

The desired deletion policy for the Amazon FSx for Lustre file system in the shared environment.

" - } - }, - "ClusterFsxLustreConfig": { - "base": "

Defines the configuration for attaching an Amazon FSx for Lustre file system to instances in a SageMaker HyperPod cluster instance group.

", - "refs": { - "ClusterInstanceStorageConfig$FsxLustreConfig": "

Defines the configuration for attaching an Amazon FSx for Lustre file system to the instances in the SageMaker HyperPod cluster instance group.

" - } - }, - "ClusterFsxMountPath": { - "base": null, - "refs": { - "ClusterFsxLustreConfig$MountPath": "

The local path where the Amazon FSx for Lustre file system is mounted on instances.

", - "ClusterFsxOpenZfsConfig$MountPath": "

The local path where the Amazon FSx for OpenZFS file system is mounted on instances.

" - } - }, - "ClusterFsxOpenZfsConfig": { - "base": "

Defines the configuration for attaching an Amazon FSx for OpenZFS file system to instances in a SageMaker HyperPod cluster instance group.

", - "refs": { - "ClusterInstanceStorageConfig$FsxOpenZfsConfig": "

Defines the configuration for attaching an Amazon FSx for OpenZFS file system to the instances in the SageMaker HyperPod cluster instance group.

" - } - }, - "ClusterImageVersionStatus": { - "base": "

The status of the Amazon Machine Image (AMI) version for the HyperPod cluster instance group, node, or cluster. The AMI version is determined at the instance group level, and all nodes within an instance group run the same AMI. The cluster-level status is aggregated across all instance groups.

  • UpToDate: The resource is running the latest available AMI version.

  • UpdateAvailable: A newer AMI version is available for the resource.

  • SecurityUpdateRequired: The current AMI has known security vulnerabilities, and a patched version is available.

  • EndOfLife: The AMI variant has reached end of support and an upgrade is required.

", - "refs": { - "ClusterInstanceGroupDetails$ImageVersionStatus": "

The status of the image version for the instance group. Indicates whether the instance group is running the latest image version or if an update is available.

", - "ClusterNodeDetails$ImageVersionStatus": "

The status of the image version for the cluster node.

", - "ClusterNodeSummary$ImageVersionStatus": "

The status of the image version for the cluster node.

", - "ClusterSummary$ImageVersionStatus": "

The aggregate status of the image version across the cluster's instance groups.

" - } - }, - "ClusterInstanceCount": { - "base": null, - "refs": { - "ClusterInstanceGroupDetails$TargetCount": "

The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.

", - "ClusterInstanceGroupDetails$MinCount": "

The minimum number of instances that must be available in the instance group of a SageMaker HyperPod cluster before it transitions to InService status.

", - "ClusterInstanceGroupDetails$TargetStateCount": "

Represents the number of running nodes using the desired Image ID.

  1. During software update operations: This count shows the number of nodes running on the desired Image ID. If a rollback occurs, the current image ID and desired image ID (both included in the describe cluster response) swap values. The TargetStateCount then shows the number of nodes running on the newly designated desired image ID (which was previously the current image ID).

  2. During simultaneous scaling and software update operations: This count shows the number of instances running on the desired image ID, including any new instances created as part of the scaling request. New nodes are always created using the desired image ID, so TargetStateCount reflects the total count of nodes running on the desired image ID, even during rollback scenarios.

", - "ClusterInstanceGroupSpecification$InstanceCount": "

Specifies the number of instances to add to the instance group of a SageMaker HyperPod cluster.

", - "ClusterInstanceGroupSpecification$MinInstanceCount": "

Defines the minimum number of instances required for an instance group to become InService. If this threshold isn't met within 3 hours, the instance group rolls back to its previous state - zero instances for new instance groups, or previous settings for existing instance groups. MinInstanceCount only affects the initial transition to InService and does not guarantee maintaining this minimum afterward.

", - "ClusterRestrictedInstanceGroupDetails$TargetCount": "

The number of instances you specified to add to the restricted instance group of a SageMaker HyperPod cluster.

", - "ClusterRestrictedInstanceGroupSpecification$InstanceCount": "

Specifies the number of instances to add to the restricted instance group of a SageMaker HyperPod cluster.

" - } - }, - "ClusterInstanceGroupDetails": { - "base": "

Details of an instance group in a SageMaker HyperPod cluster.

", - "refs": { - "ClusterInstanceGroupDetailsList$member": null - } - }, - "ClusterInstanceGroupDetailsList": { - "base": null, - "refs": { - "DescribeClusterResponse$InstanceGroups": "

The instance groups of the SageMaker HyperPod cluster.

" - } - }, - "ClusterInstanceGroupName": { - "base": null, - "refs": { - "AddClusterNodeSpecification$InstanceGroupName": "

The name of the instance group to which you want to add nodes.

", - "ClusterEventDetail$InstanceGroupName": "

The name of the instance group associated with the event, if applicable.

", - "ClusterEventSummary$InstanceGroupName": "

The name of the instance group associated with the event, if applicable.

", - "ClusterInstanceGroupDetails$InstanceGroupName": "

The name of the instance group of a SageMaker HyperPod cluster.

", - "ClusterInstanceGroupSpecification$InstanceGroupName": "

Specifies the name of the instance group.

", - "ClusterInstanceGroupsToDelete$member": null, - "ClusterNodeDetails$InstanceGroupName": "

The instance group name in which the instance is.

", - "ClusterNodeSummary$InstanceGroupName": "

The name of the instance group in which the instance is.

", - "ClusterRestrictedInstanceGroupDetails$InstanceGroupName": "

The name of the restricted instance group of a SageMaker HyperPod cluster.

", - "ClusterRestrictedInstanceGroupSpecification$InstanceGroupName": "

Specifies the name of the restricted instance group.

", - "InstanceGroupHealthCheckConfiguration$InstanceGroupName": "

The name of the instance group.

", - "ListClusterEventsRequest$InstanceGroupName": "

The name of the instance group to filter events. If specified, only events related to this instance group are returned.

", - "ListClusterNodesRequest$InstanceGroupNameContains": "

A filter that returns the instance groups whose name contain a specified string.

", - "NodeAdditionResult$InstanceGroupName": "

The name of the instance group to which the node was added.

", - "UpdateClusterSoftwareInstanceGroupSpecification$InstanceGroupName": "

The name of the instance group to update.

" - } - }, - "ClusterInstanceGroupSpecification": { - "base": "

The specifications of an instance group that you need to define.

", - "refs": { - "ClusterInstanceGroupSpecifications$member": null - } - }, - "ClusterInstanceGroupSpecifications": { - "base": null, - "refs": { - "CreateClusterRequest$InstanceGroups": "

The instance groups to be created in the SageMaker HyperPod cluster.

", - "UpdateClusterRequest$InstanceGroups": "

Specify the instance groups to update.

" - } - }, - "ClusterInstanceGroupsToDelete": { - "base": null, - "refs": { - "UpdateClusterRequest$InstanceGroupsToDelete": "

Specify the names of the instance groups to delete. Use a single , as the separator between multiple names.

" - } - }, - "ClusterInstanceMemoryAllocationPercentage": { - "base": null, - "refs": { - "ClusterTieredStorageConfig$InstanceMemoryAllocationPercentage": "

The percentage (int) of cluster memory to allocate for checkpointing.

" - } - }, - "ClusterInstancePlacement": { - "base": "

Specifies the placement details for the node in the SageMaker HyperPod cluster, including the Availability Zone and the unique identifier (ID) of the Availability Zone.

", - "refs": { - "ClusterNodeDetails$Placement": "

The placement details of the SageMaker HyperPod cluster node.

" - } - }, - "ClusterInstanceRequirementDetails": { - "base": "

The instance requirement details for a flexible instance group, including the current and desired instance types.

", - "refs": { - "ClusterInstanceGroupDetails$InstanceRequirements": "

The instance requirements for the instance group, including the current and desired instance types. This field is present for flexible instance groups that support multiple instance types.

" - } - }, - "ClusterInstanceRequirements": { - "base": "

The instance requirements for a flexible instance group. Use this to specify multiple instance types that the instance group can use. The order of instance types in the list determines the priority for instance provisioning.

", - "refs": { - "ClusterInstanceGroupSpecification$InstanceRequirements": "

The instance requirements for the instance group, including the instance types to use. Use this to create a flexible instance group that supports multiple instance types. The InstanceType and InstanceRequirements properties are mutually exclusive.

" - } - }, - "ClusterInstanceStatus": { - "base": null, - "refs": { - "ClusterInstanceStatusDetails$Status": "

The status of an instance in a SageMaker HyperPod cluster.

", - "NodeAdditionResult$Status": "

The current status of the node. Possible values include Pending, Running, Failed, ShuttingDown, SystemUpdating, DeepHealthCheckInProgress, and NotFound.

" - } - }, - "ClusterInstanceStatusDetails": { - "base": "

Details of an instance in a SageMaker HyperPod cluster.

", - "refs": { - "ClusterNodeDetails$InstanceStatus": "

The status of the instance.

", - "ClusterNodeSummary$InstanceStatus": "

The status of the instance.

" - } - }, - "ClusterInstanceStorageConfig": { - "base": "

Defines the configuration for attaching additional storage to the instances in the SageMaker HyperPod cluster instance group. To learn more, see SageMaker HyperPod release notes: June 20, 2024.

", - "refs": { - "ClusterInstanceStorageConfigs$member": null - } - }, - "ClusterInstanceStorageConfigs": { - "base": null, - "refs": { - "ClusterInstanceGroupDetails$InstanceStorageConfigs": "

The additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.

", - "ClusterInstanceGroupSpecification$InstanceStorageConfigs": "

Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.

", - "ClusterNodeDetails$InstanceStorageConfigs": "

The configurations of additional storage specified to the instance group where the instance (node) is launched.

", - "ClusterRestrictedInstanceGroupDetails$InstanceStorageConfigs": "

The additional storage configurations for the instances in the SageMaker HyperPod cluster restricted instance group.

", - "ClusterRestrictedInstanceGroupSpecification$InstanceStorageConfigs": "

Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster restricted instance group.

" - } - }, - "ClusterInstanceType": { - "base": null, - "refs": { - "ClusterInstanceGroupDetails$InstanceType": "

The instance type of the instance group of a SageMaker HyperPod cluster.

", - "ClusterInstanceGroupSpecification$InstanceType": "

Specifies the instance type of the instance group.

", - "ClusterInstanceTypeDetail$InstanceType": "

The instance type.

", - "ClusterInstanceTypes$member": null, - "ClusterNodeDetails$InstanceType": "

The type of the instance.

", - "ClusterNodeSummary$InstanceType": "

The type of the instance.

", - "ClusterRestrictedInstanceGroupDetails$InstanceType": "

The instance type of the restricted instance group of a SageMaker HyperPod cluster.

", - "ClusterRestrictedInstanceGroupSpecification$InstanceType": "

Specifies the instance type of the restricted instance group.

", - "ComputeQuotaResourceConfig$InstanceType": "

The instance type of the instance group for the cluster.

" - } - }, - "ClusterInstanceTypeDetail": { - "base": "

Details about a specific instance type within a flexible instance group, including the count and configuration.

", - "refs": { - "ClusterInstanceTypeDetails$member": null - } - }, - "ClusterInstanceTypeDetails": { - "base": null, - "refs": { - "ClusterInstanceGroupDetails$InstanceTypeDetails": "

Details about the instance types in the instance group, including the count and configuration of each instance type. This field is present for flexible instance groups that support multiple instance types.

" - } - }, - "ClusterInstanceTypes": { - "base": null, - "refs": { - "AddClusterNodeSpecification$InstanceTypes": "

The instance types to use when adding nodes. Use this to target specific instance types within a flexible instance group.

", - "BatchAddClusterNodesError$InstanceTypes": "

The instance types associated with the failed node addition request.

", - "ClusterInstanceRequirementDetails$CurrentInstanceTypes": "

The instance types currently in use by the instance group.

", - "ClusterInstanceRequirementDetails$DesiredInstanceTypes": "

The desired instance types for the instance group, as specified in the most recent update request.

", - "ClusterInstanceRequirements$InstanceTypes": "

The list of instance types that the instance group can use. The order of instance types determines the priority—HyperPod attempts to provision instances using the first instance type in the list and falls back to subsequent types if capacity is unavailable.

", - "NodeAdditionResult$InstanceTypes": "

The instance types associated with the successfully added node.

" - } - }, - "ClusterInterfaceType": { - "base": null, - "refs": { - "ClusterNetworkInterface$InterfaceType": "

The type of network interface for the instance group. Valid values:

  • efa – An EFA with ENA interface, which provides both the EFA device for low-latency, high-throughput communication and the ENA device for IP networking.

  • efa-only – An EFA-only interface, which provides only the EFA device capabilities without the ENA device for traditional IP networking.

For more information, see Elastic Fabric Adapter.

", - "ClusterNetworkInterfaceDetails$InterfaceType": "

The type of network interface for the instance group. Valid values are efa and efa-only.

" - } - }, - "ClusterKubernetesConfig": { - "base": "

Kubernetes configuration that specifies labels and taints to be applied to cluster nodes in an instance group.

", - "refs": { - "ClusterInstanceGroupSpecification$KubernetesConfig": "

Specifies the Kubernetes configuration for the instance group. You describe what you want the labels and taints to look like, and the cluster works to reconcile the actual state with the declared state for nodes in this instance group.

" - } - }, - "ClusterKubernetesConfigDetails": { - "base": "

Detailed Kubernetes configuration showing both the current and desired state of labels and taints for cluster nodes.

", - "refs": { - "ClusterInstanceGroupDetails$KubernetesConfig": "

The Kubernetes configuration for the instance group that contains labels and taints to be applied for the nodes in this instance group.

" - } - }, - "ClusterKubernetesConfigNodeDetails": { - "base": "

Node-specific Kubernetes configuration showing both current and desired state of labels and taints for an individual cluster node.

", - "refs": { - "ClusterNodeDetails$KubernetesConfig": "

The Kubernetes configuration applied to this node, showing both the current and desired state of labels and taints. The cluster works to reconcile the actual state with the declared state.

" - } - }, - "ClusterKubernetesLabelKey": { - "base": null, - "refs": { - "ClusterKubernetesLabels$key": null - } - }, - "ClusterKubernetesLabelValue": { - "base": null, - "refs": { - "ClusterKubernetesLabels$value": null - } - }, - "ClusterKubernetesLabels": { - "base": null, - "refs": { - "ClusterKubernetesConfig$Labels": "

Key-value pairs of labels to be applied to cluster nodes.

", - "ClusterKubernetesConfigDetails$CurrentLabels": "

The current labels applied to cluster nodes of an instance group.

", - "ClusterKubernetesConfigDetails$DesiredLabels": "

The desired labels to be applied to cluster nodes of an instance group.

", - "ClusterKubernetesConfigNodeDetails$CurrentLabels": "

The current labels applied to the cluster node.

", - "ClusterKubernetesConfigNodeDetails$DesiredLabels": "

The desired labels to be applied to the cluster node.

" - } - }, - "ClusterKubernetesTaint": { - "base": "

A Kubernetes taint that can be applied to cluster nodes.

", - "refs": { - "ClusterKubernetesTaints$member": null - } - }, - "ClusterKubernetesTaintEffect": { - "base": null, - "refs": { - "ClusterKubernetesTaint$Effect": "

The effect of the taint. Valid values are NoSchedule, PreferNoSchedule, and NoExecute.

" - } - }, - "ClusterKubernetesTaintKey": { - "base": null, - "refs": { - "ClusterKubernetesTaint$Key": "

The key of the taint.

" - } - }, - "ClusterKubernetesTaintValue": { - "base": null, - "refs": { - "ClusterKubernetesTaint$Value": "

The value of the taint.

" - } - }, - "ClusterKubernetesTaints": { - "base": null, - "refs": { - "ClusterKubernetesConfig$Taints": "

List of taints to be applied to cluster nodes.

", - "ClusterKubernetesConfigDetails$CurrentTaints": "

The current taints applied to cluster nodes of an instance group.

", - "ClusterKubernetesConfigDetails$DesiredTaints": "

The desired taints to be applied to cluster nodes of an instance group.

", - "ClusterKubernetesConfigNodeDetails$CurrentTaints": "

The current taints applied to the cluster node.

", - "ClusterKubernetesConfigNodeDetails$DesiredTaints": "

The desired taints to be applied to the cluster node.

" - } - }, - "ClusterLifeCycleConfig": { - "base": "

The lifecycle configuration for a SageMaker HyperPod cluster.

", - "refs": { - "ClusterInstanceGroupDetails$LifeCycleConfig": "

Details of LifeCycle configuration for the instance group.

", - "ClusterInstanceGroupSpecification$LifeCycleConfig": "

Specifies the LifeCycle configuration for the instance group.

", - "ClusterNodeDetails$LifeCycleConfig": "

The LifeCycle configuration applied to the instance.

" - } - }, - "ClusterLifeCycleConfigFileName": { - "base": null, - "refs": { - "ClusterLifeCycleConfig$OnCreate": "

The file name of the entrypoint script of lifecycle scripts under SourceS3Uri. This entrypoint script runs during cluster creation.

", - "ClusterLifeCycleConfig$OnInitComplete": "

The file name of the entrypoint script of lifecycle scripts under SourceS3Uri. This script runs on the node after the AMI-based initialization is complete.

" - } - }, - "ClusterMetadata": { - "base": "

Metadata information about a HyperPod cluster showing information about the cluster level operations, such as creating, updating, and deleting.

", - "refs": { - "EventMetadata$Cluster": "

Metadata specific to cluster-level events.

" - } - }, - "ClusterMountName": { - "base": null, - "refs": { - "ClusterFsxLustreConfig$MountName": "

The mount name of the Amazon FSx for Lustre file system.

" - } - }, - "ClusterName": { - "base": null, - "refs": { - "ClusterEventDetail$ClusterName": "

The name of the HyperPod cluster associated with the event.

", - "ClusterEventSummary$ClusterName": "

The name of the HyperPod cluster associated with the event.

", - "ClusterSummary$ClusterName": "

The name of the SageMaker HyperPod cluster.

", - "CreateClusterRequest$ClusterName": "

The name for the new SageMaker HyperPod cluster.

", - "DescribeClusterResponse$ClusterName": "

The name of the SageMaker HyperPod cluster.

" - } - }, - "ClusterNameOrArn": { - "base": null, - "refs": { - "BatchAddClusterNodesRequest$ClusterName": "

The name of the HyperPod cluster to which you want to add nodes.

", - "BatchDeleteClusterNodesRequest$ClusterName": "

The name of the SageMaker HyperPod cluster from which to delete the specified nodes.

", - "BatchRebootClusterNodesRequest$ClusterName": "

The name or Amazon Resource Name (ARN) of the SageMaker HyperPod cluster containing the nodes to reboot.

", - "BatchReplaceClusterNodesRequest$ClusterName": "

The name or Amazon Resource Name (ARN) of the SageMaker HyperPod cluster containing the nodes to replace.

", - "DeleteClusterRequest$ClusterName": "

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster to delete.

", - "DescribeClusterEventRequest$ClusterName": "

The name or Amazon Resource Name (ARN) of the HyperPod cluster associated with the event.

", - "DescribeClusterNodeRequest$ClusterName": "

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which the node is.

", - "DescribeClusterRequest$ClusterName": "

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

", - "ListClusterEventsRequest$ClusterName": "

The name or Amazon Resource Name (ARN) of the HyperPod cluster for which to list events.

", - "ListClusterNodesRequest$ClusterName": "

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want to retrieve the list of nodes.

", - "StartClusterHealthCheckRequest$ClusterName": "

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

", - "UpdateClusterRequest$ClusterName": "

Specify the name of the SageMaker HyperPod cluster you want to update.

", - "UpdateClusterSoftwareRequest$ClusterName": "

Specify the name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster you want to update for security patching.

" - } - }, - "ClusterNetworkInterface": { - "base": "

The network interface configuration for a Amazon SageMaker HyperPod cluster instance group.

", - "refs": { - "ClusterInstanceGroupSpecification$NetworkInterface": "

The network interface configuration for the instance group.

" - } - }, - "ClusterNetworkInterfaceDetails": { - "base": "

The network interface configuration details for a Amazon SageMaker HyperPod cluster instance group.

", - "refs": { - "ClusterInstanceGroupDetails$NetworkInterface": "

The network interface configuration for the instance group.

", - "ClusterNodeDetails$NetworkInterface": "

The network interface configuration for the cluster node.

" - } - }, - "ClusterNodeDetails": { - "base": "

Details of an instance (also called a node interchangeably) in a SageMaker HyperPod cluster.

", - "refs": { - "DescribeClusterNodeResponse$NodeDetails": "

The details of the SageMaker HyperPod cluster node.

" - } - }, - "ClusterNodeId": { - "base": null, - "refs": { - "AttachClusterNodeVolumeRequest$NodeId": "

The unique identifier of the cluster node to which you want to attach the volume. The node must belong to your specified HyperPod cluster and cannot be part of a Restricted Instance Group (RIG).

", - "AttachClusterNodeVolumeResponse$NodeId": "

The unique identifier of the cluster node where your volume was attached.

", - "BatchDeleteClusterNodesError$NodeId": "

The ID of the node that encountered an error during the deletion process.

", - "BatchRebootClusterNodesError$NodeId": "

The EC2 instance ID of the node that encountered an error during the reboot operation.

", - "BatchRebootClusterNodesRequestNodeIdsList$member": null, - "BatchReplaceClusterNodesError$NodeId": "

The EC2 instance ID of the node that encountered an error during the replacement operation.

", - "BatchReplaceClusterNodesRequestNodeIdsList$member": null, - "ClusterNodeIds$member": null, - "DescribeClusterNodeRequest$NodeId": "

The ID of the SageMaker HyperPod cluster node.

", - "DetachClusterNodeVolumeRequest$NodeId": "

The unique identifier of the cluster node from which you want to detach the volume.

", - "DetachClusterNodeVolumeResponse$NodeId": "

The unique identifier of the cluster node from which your volume was detached.

", - "InstanceIds$member": null, - "ListClusterEventsRequest$NodeId": "

The EC2 instance ID to filter events. If specified, only events related to this instance are returned.

" - } - }, - "ClusterNodeIds": { - "base": null, - "refs": { - "BatchDeleteClusterNodesRequest$NodeIds": "

A list of node IDs to be deleted from the specified cluster.

  • For SageMaker HyperPod clusters using the Slurm workload manager, you cannot remove instances that are configured as Slurm controller nodes.

  • If you need to delete more than 99 instances, contact Support for assistance.

", - "BatchDeleteClusterNodesResponse$Successful": "

A list of node IDs that were successfully deleted from the specified cluster.

", - "BatchRebootClusterNodesResponse$Successful": "

A list of EC2 instance IDs for which the reboot operation was successfully initiated.

", - "BatchReplaceClusterNodesResponse$Successful": "

A list of EC2 instance IDs for which the replacement operation was successfully initiated.

" - } - }, - "ClusterNodeLogicalId": { - "base": null, - "refs": { - "BatchDeleteClusterNodeLogicalIdsError$NodeLogicalId": "

The NodeLogicalId of the node that could not be deleted.

", - "BatchRebootClusterNodeLogicalIdsError$NodeLogicalId": "

The logical node ID of the node that encountered an error during the reboot operation.

", - "BatchRebootClusterNodesRequestNodeLogicalIdsList$member": null, - "BatchReplaceClusterNodeLogicalIdsError$NodeLogicalId": "

The logical node ID of the node that encountered an error during the replacement operation.

", - "BatchReplaceClusterNodesRequestNodeLogicalIdsList$member": null, - "ClusterNodeDetails$NodeLogicalId": "

A unique identifier for the node that persists throughout its lifecycle, from provisioning request to termination. This identifier can be used to track the node even before it has an assigned InstanceId.

", - "ClusterNodeLogicalIdList$member": null, - "DescribeClusterNodeRequest$NodeLogicalId": "

The logical identifier of the node to describe. You can specify either NodeLogicalId or InstanceId, but not both. NodeLogicalId can be used to describe nodes that are still being provisioned and don't yet have an InstanceId assigned.

", - "InstanceMetadata$NodeLogicalId": "

The unique logical identifier of the node within the cluster. The ID used here is the same object as in the BatchAddClusterNodes API.

", - "NodeAdditionResult$NodeLogicalId": "

A unique identifier assigned to the node that can be used to track its provisioning status through the DescribeClusterNode operation.

" - } - }, - "ClusterNodeLogicalIdList": { - "base": null, - "refs": { - "BatchDeleteClusterNodesRequest$NodeLogicalIds": "

A list of NodeLogicalIds identifying the nodes to be deleted. You can specify up to 50 NodeLogicalIds. You must specify either NodeLogicalIds, InstanceIds, or both, with a combined maximum of 50 identifiers.

", - "BatchDeleteClusterNodesResponse$SuccessfulNodeLogicalIds": "

A list of NodeLogicalIds that were successfully deleted from the cluster.

", - "BatchRebootClusterNodesResponse$SuccessfulNodeLogicalIds": "

A list of logical node IDs for which the reboot operation was successfully initiated. This field is only present when NodeLogicalIds were provided in the request.

", - "BatchReplaceClusterNodesResponse$SuccessfulNodeLogicalIds": "

A list of logical node IDs for which the replacement operation was successfully initiated. This field is only present when NodeLogicalIds were provided in the request.

" - } - }, - "ClusterNodeProvisioningMode": { - "base": null, - "refs": { - "CreateClusterRequest$NodeProvisioningMode": "

The mode for provisioning nodes in the cluster. You can specify the following modes:

  • Continuous: Scaling behavior that enables 1) concurrent operation execution within instance groups, 2) continuous retry mechanisms for failed operations, 3) enhanced customer visibility into cluster events through detailed event streams, 4) partial provisioning capabilities. Your clusters and instance groups remain InService while scaling. This mode is only supported for EKS orchestrated clusters.

", - "DescribeClusterResponse$NodeProvisioningMode": "

The mode used for provisioning nodes in the cluster.

", - "UpdateClusterRequest$NodeProvisioningMode": "

Determines how instance provisioning is handled during cluster operations. In Continuous mode, the cluster provisions available instances incrementally and retries until the target count is reached. The cluster becomes operational once cluster-level resources are ready. Use CurrentCount and TargetCount in DescribeCluster to track provisioning progress.

" - } - }, - "ClusterNodeRecovery": { - "base": null, - "refs": { - "CreateClusterRequest$NodeRecovery": "

The node recovery mode for the SageMaker HyperPod cluster. When set to Automatic, SageMaker HyperPod will automatically reboot or replace faulty nodes when issues are detected. When set to None, cluster administrators will need to manually manage any faulty cluster instances.

", - "DescribeClusterResponse$NodeRecovery": "

The node recovery mode configured for the SageMaker HyperPod cluster.

", - "UpdateClusterRequest$NodeRecovery": "

The node recovery mode to be applied to the SageMaker HyperPod cluster.

" - } - }, - "ClusterNodeSummaries": { - "base": null, - "refs": { - "ListClusterNodesResponse$ClusterNodeSummaries": "

The summaries of listed instances in a SageMaker HyperPod cluster

" - } - }, - "ClusterNodeSummary": { - "base": "

Lists a summary of the properties of an instance (also called a node interchangeably) of a SageMaker HyperPod cluster.

", - "refs": { - "ClusterNodeSummaries$member": null - } - }, - "ClusterNonNegativeInstanceCount": { - "base": null, - "refs": { - "ClusterInstanceGroupDetails$CurrentCount": "

The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.

", - "ClusterInstanceTypeDetail$CurrentCount": "

The number of instances of this type currently running in the instance group.

", - "ClusterRestrictedInstanceGroupDetails$CurrentCount": "

The number of instances that are currently in the restricted instance group of a SageMaker HyperPod cluster.

" - } - }, - "ClusterOnDemandOptions": { - "base": "

Configuration options specific to On-Demand instances.

", - "refs": { - "ClusterCapacityRequirements$OnDemand": "

Configuration options specific to On-Demand instances.

" - } - }, - "ClusterOrchestrator": { - "base": "

The type of orchestrator used for the SageMaker HyperPod cluster.

", - "refs": { - "CreateClusterRequest$Orchestrator": "

The type of orchestrator to use for the SageMaker HyperPod cluster. Currently, supported values are \"Eks\" and \"Slurm\", which is to use an Amazon Elastic Kubernetes Service or Slurm cluster as the orchestrator.

If you specify the Orchestrator field, you must provide exactly one orchestrator configuration: either Eks or Slurm. Specifying both or providing an empty configuration returns a validation error.

", - "DescribeClusterResponse$Orchestrator": "

The type of orchestrator used for the SageMaker HyperPod cluster.

", - "UpdateClusterRequest$Orchestrator": null - } - }, - "ClusterOrchestratorEksConfig": { - "base": "

The configuration settings for the Amazon EKS cluster used as the orchestrator for the SageMaker HyperPod cluster.

", - "refs": { - "ClusterOrchestrator$Eks": "

The Amazon EKS cluster used as the orchestrator for the SageMaker HyperPod cluster.

" - } - }, - "ClusterOrchestratorSlurmConfig": { - "base": "

The configuration settings for the Slurm orchestrator used with the SageMaker HyperPod cluster.

", - "refs": { - "ClusterOrchestrator$Slurm": "

The Slurm orchestrator configuration for the SageMaker HyperPod cluster.

" - } - }, - "ClusterPartitionName": { - "base": null, - "refs": { - "ClusterPartitionNames$member": null - } - }, - "ClusterPartitionNames": { - "base": null, - "refs": { - "ClusterSlurmConfig$PartitionNames": "

The list of Slurm partition names that the instance group belongs to.

", - "ClusterSlurmConfigDetails$PartitionNames": "

The list of Slurm partition names that the instance group belongs to.

" - } - }, - "ClusterPatchSchedule": { - "base": "

The schedule configuration for automatic patching.

", - "refs": { - "ClusterAutoPatchConfig$PatchSchedule": "

The schedule for automatic patching, including the next patch date.

" - } - }, - "ClusterPatchScheduleDetails": { - "base": "

The schedule details for automatic patching, including the next scheduled patch date.

", - "refs": { - "ClusterAutoPatchConfigDetails$CurrentPatchSchedule": "

The currently active patch schedule that the system will execute.

", - "ClusterAutoPatchConfigDetails$DesiredPatchSchedule": "

The requested patch schedule. Differs from CurrentPatchSchedule when a reschedule request is pending.

" - } - }, - "ClusterPatchingStrategy": { - "base": "

The strategy for applying automatic patches to instances.

  • WhenIdle: Cordons all instances and patches each instance as it becomes idle (no running jobs). Each instance is uncordoned immediately after patching and becomes available for new jobs. If instances do not become idle, they remain on the previous AMI version. You can then use UpdateClusterSoftware with the desired ImageReleaseVersion to manually update the remaining instances.

  • WhenAllIdle: Cordons all instances and waits for all to become idle before patching. All instances are uncordoned after patching completes. If not all instances become idle, no patching occurs and all instances remain on the previous AMI version.

", - "refs": { - "ClusterAutoPatchConfig$PatchingStrategy": "

The strategy for applying patches to instances in the group.

  • WhenIdle: Cordons all instances and patches each instance as it becomes idle (no running jobs). Each instance is uncordoned immediately after patching and becomes available for new jobs. If instances do not become idle, they remain on the previous AMI version. You can then use UpdateClusterSoftware with the desired ImageReleaseVersion to manually update the remaining instances.

  • WhenAllIdle: Cordons all instances and waits for all to become idle before patching. All instances are uncordoned after patching completes. If not all instances become idle, no patching occurs and all instances remain on the previous AMI version.

", - "ClusterAutoPatchConfigDetails$PatchingStrategy": "

The strategy used for applying patches to instances in the group.

  • WhenIdle: Cordons all instances and patches each instance as it becomes idle (no running jobs). Each instance is uncordoned immediately after patching and becomes available for new jobs. If instances do not become idle, they remain on the previous AMI version. You can then use UpdateClusterSoftware with the desired ImageReleaseVersion to manually update the remaining instances.

  • WhenAllIdle: Cordons all instances and waits for all to become idle before patching. All instances are uncordoned after patching completes. If not all instances become idle, no patching occurs and all instances remain on the previous AMI version.

" - } - }, - "ClusterPrivateDnsHostname": { - "base": null, - "refs": { - "ClusterNodeDetails$PrivateDnsHostname": "

The private DNS hostname of the SageMaker HyperPod cluster node.

", - "ClusterNodeSummary$PrivateDnsHostname": "

The private DNS hostname of the SageMaker HyperPod cluster node.

" - } - }, - "ClusterPrivatePrimaryIp": { - "base": null, - "refs": { - "ClusterNodeDetails$PrivatePrimaryIp": "

The private primary IP address of the SageMaker HyperPod cluster node.

" - } - }, - "ClusterPrivatePrimaryIpv6": { - "base": null, - "refs": { - "ClusterNodeDetails$PrivatePrimaryIpv6": "

The private primary IPv6 address of the SageMaker HyperPod cluster node when configured with an Amazon VPC that supports IPv6 and includes subnets with IPv6 addressing enabled in either the cluster Amazon VPC configuration or the instance group Amazon VPC configuration.

" - } - }, - "ClusterRestrictedInstanceGroupDetails": { - "base": "

The instance group details of the restricted instance group (RIG).

", - "refs": { - "ClusterRestrictedInstanceGroupDetailsList$member": null - } - }, - "ClusterRestrictedInstanceGroupDetailsList": { - "base": null, - "refs": { - "DescribeClusterResponse$RestrictedInstanceGroups": "

The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.

" - } - }, - "ClusterRestrictedInstanceGroupSpecification": { - "base": "

The specifications of a restricted instance group that you need to define.

", - "refs": { - "ClusterRestrictedInstanceGroupSpecifications$member": null - } - }, - "ClusterRestrictedInstanceGroupSpecifications": { - "base": null, - "refs": { - "CreateClusterRequest$RestrictedInstanceGroups": "

The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.

", - "UpdateClusterRequest$RestrictedInstanceGroups": "

The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.

" - } - }, - "ClusterRestrictedInstanceGroupsConfig": { - "base": "

The configuration for the restricted instance groups (RIG) in the SageMaker HyperPod cluster.

", - "refs": { - "CreateClusterRequest$RestrictedInstanceGroupsConfig": "

The configuration for the restricted instance groups (RIG) in the SageMaker HyperPod cluster.

", - "UpdateClusterRequest$RestrictedInstanceGroupsConfig": "

The configuration for the restricted instance groups (RIG) in the SageMaker HyperPod cluster.

" - } - }, - "ClusterRestrictedInstanceGroupsConfigOutput": { - "base": "

The output configuration for the restricted instance groups (RIG) in the SageMaker HyperPod cluster.

", - "refs": { - "DescribeClusterResponse$RestrictedInstanceGroupsConfig": "

The configuration for the restricted instance groups (RIG) in the SageMaker HyperPod cluster.

" - } - }, - "ClusterSchedulerConfigArn": { - "base": null, - "refs": { - "ClusterSchedulerConfigSummary$ClusterSchedulerConfigArn": "

ARN of the cluster policy.

", - "CreateClusterSchedulerConfigResponse$ClusterSchedulerConfigArn": "

ARN of the cluster policy.

", - "DescribeClusterSchedulerConfigResponse$ClusterSchedulerConfigArn": "

ARN of the cluster policy.

", - "UpdateClusterSchedulerConfigResponse$ClusterSchedulerConfigArn": "

ARN of the cluster policy.

" - } - }, - "ClusterSchedulerConfigId": { - "base": null, - "refs": { - "ClusterSchedulerConfigSummary$ClusterSchedulerConfigId": "

ID of the cluster policy.

", - "CreateClusterSchedulerConfigResponse$ClusterSchedulerConfigId": "

ID of the cluster policy.

", - "DeleteClusterSchedulerConfigRequest$ClusterSchedulerConfigId": "

ID of the cluster policy.

", - "DescribeClusterSchedulerConfigRequest$ClusterSchedulerConfigId": "

ID of the cluster policy.

", - "DescribeClusterSchedulerConfigResponse$ClusterSchedulerConfigId": "

ID of the cluster policy.

", - "UpdateClusterSchedulerConfigRequest$ClusterSchedulerConfigId": "

ID of the cluster policy.

" - } - }, - "ClusterSchedulerConfigSummary": { - "base": "

Summary of the cluster policy.

", - "refs": { - "ClusterSchedulerConfigSummaryList$member": null - } - }, - "ClusterSchedulerConfigSummaryList": { - "base": null, - "refs": { - "ListClusterSchedulerConfigsResponse$ClusterSchedulerConfigSummaries": "

Summaries of the cluster policies.

" - } - }, - "ClusterSchedulerPriorityClassName": { - "base": null, - "refs": { - "PriorityClass$Name": "

Name of the priority class.

" - } - }, - "ClusterSharedEnvironmentConfig": { - "base": "

The shared environment configuration for the restricted instance groups (RIG).

", - "refs": { - "ClusterRestrictedInstanceGroupsConfig$SharedEnvironmentConfig": "

The shared environment configuration for the restricted instance groups (RIG).

" - } - }, - "ClusterSharedEnvironmentConfigDetails": { - "base": "

The shared environment configuration details for the restricted instance groups (RIG).

", - "refs": { - "ClusterRestrictedInstanceGroupsConfigOutput$SharedEnvironmentConfig": "

The shared environment configuration details for the restricted instance groups (RIG).

" - } - }, - "ClusterSlurmConfig": { - "base": "

The Slurm configuration for an instance group in a SageMaker HyperPod cluster.

", - "refs": { - "ClusterInstanceGroupSpecification$SlurmConfig": "

Specifies the Slurm configuration for the instance group.

" - } - }, - "ClusterSlurmConfigDetails": { - "base": "

The Slurm configuration details for an instance group in a SageMaker HyperPod cluster.

", - "refs": { - "ClusterInstanceGroupDetails$SlurmConfig": "

The Slurm configuration for the instance group.

" - } - }, - "ClusterSlurmConfigStrategy": { - "base": null, - "refs": { - "ClusterOrchestratorSlurmConfig$SlurmConfigStrategy": "

The strategy for managing partitions for the Slurm configuration. Valid values are Managed, Overwrite, and Merge.

" - } - }, - "ClusterSlurmNodeType": { - "base": null, - "refs": { - "ClusterSlurmConfig$NodeType": "

The type of Slurm node for the instance group. Valid values are Controller, Worker, and Login.

", - "ClusterSlurmConfigDetails$NodeType": "

The type of Slurm node for the instance group. Valid values are Controller, Worker, and Login.

" - } - }, - "ClusterSortBy": { - "base": null, - "refs": { - "ListClusterNodesRequest$SortBy": "

The field by which to sort results. The default value is CREATION_TIME.

", - "ListClustersRequest$SortBy": "

The field by which to sort results. The default value is CREATION_TIME.

" - } - }, - "ClusterSpotOptions": { - "base": "

Configuration options specific to Spot instances.

", - "refs": { - "ClusterCapacityRequirements$Spot": "

Configuration options specific to Spot instances.

" - } - }, - "ClusterStatus": { - "base": null, - "refs": { - "ClusterSummary$ClusterStatus": "

The status of the SageMaker HyperPod cluster.

", - "DescribeClusterResponse$ClusterStatus": "

The status of the SageMaker HyperPod cluster.

" - } - }, - "ClusterSummaries": { - "base": null, - "refs": { - "ListClustersResponse$ClusterSummaries": "

The summaries of listed SageMaker HyperPod clusters.

" - } - }, - "ClusterSummary": { - "base": "

Lists a summary of the properties of a SageMaker HyperPod cluster.

", - "refs": { - "ClusterSummaries$member": null - } - }, - "ClusterThreadsPerCore": { - "base": null, - "refs": { - "ClusterInstanceGroupDetails$ThreadsPerCore": "

The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.

", - "ClusterInstanceGroupSpecification$ThreadsPerCore": "

Specifies the value for Threads per core. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For instance types that doesn't support multithreading, specify 1. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.

", - "ClusterInstanceTypeDetail$ThreadsPerCore": "

The number of threads per CPU core for this instance type.

", - "ClusterNodeDetails$ThreadsPerCore": "

The number of threads per CPU core you specified under CreateCluster.

", - "ClusterRestrictedInstanceGroupDetails$ThreadsPerCore": "

The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.

", - "ClusterRestrictedInstanceGroupSpecification$ThreadsPerCore": "

The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.

" - } - }, - "ClusterTieredStorageConfig": { - "base": "

Defines the configuration for managed tier checkpointing in a HyperPod cluster. Managed tier checkpointing uses multiple storage tiers, including cluster CPU memory, to provide faster checkpoint operations and improved fault tolerance for large-scale model training. The system automatically saves checkpoints at high frequency to memory and periodically persists them to durable storage, like Amazon S3.

", - "refs": { - "CreateClusterRequest$TieredStorageConfig": "

The configuration for managed tier checkpointing on the HyperPod cluster. When enabled, this feature uses a multi-tier storage approach for storing model checkpoints, providing faster checkpoint operations and improved fault tolerance across cluster nodes.

", - "DescribeClusterResponse$TieredStorageConfig": "

The current configuration for managed tier checkpointing on the HyperPod cluster. For example, this shows whether the feature is enabled and the percentage of cluster memory allocated for checkpoint storage.

", - "UpdateClusterRequest$TieredStorageConfig": "

Updates the configuration for managed tier checkpointing on the HyperPod cluster. For example, you can enable or disable the feature and modify the percentage of cluster memory allocated for checkpoint storage.

" - } - }, - "CodeEditorAppImageConfig": { - "base": "

The configuration for the file system and kernels in a SageMaker image running as a Code Editor app. The FileSystemConfig object is not supported.

", - "refs": { - "AppImageConfigDetails$CodeEditorAppImageConfig": "

The configuration for the file system and the runtime, such as the environment variables and entry point.

", - "CreateAppImageConfigRequest$CodeEditorAppImageConfig": "

The CodeEditorAppImageConfig. You can only specify one image kernel in the AppImageConfig API. This kernel is shown to users before the image starts. After the image runs, all kernels are visible in Code Editor.

", - "DescribeAppImageConfigResponse$CodeEditorAppImageConfig": "

The configuration of the Code Editor app.

", - "UpdateAppImageConfigRequest$CodeEditorAppImageConfig": "

The Code Editor app running on the image.

" - } - }, - "CodeEditorAppSettings": { - "base": "

The Code Editor application settings.

For more information about Code Editor, see Get started with Code Editor in Amazon SageMaker.

", - "refs": { - "UserSettings$CodeEditorAppSettings": "

The Code Editor application settings.

SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

" - } - }, - "CodeRepositories": { - "base": null, - "refs": { - "JupyterLabAppSettings$CodeRepositories": "

A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.

", - "JupyterServerAppSettings$CodeRepositories": "

A list of Git repositories that SageMaker AI automatically displays to users for cloning in the JupyterServer application.

", - "SpaceJupyterLabAppSettings$CodeRepositories": "

A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.

" - } - }, - "CodeRepository": { - "base": "

A Git repository that SageMaker AI automatically displays to users for cloning in the JupyterServer application.

", - "refs": { - "CodeRepositories$member": null - } - }, - "CodeRepositoryArn": { - "base": null, - "refs": { - "CodeRepositorySummary$CodeRepositoryArn": "

The Amazon Resource Name (ARN) of the Git repository.

", - "CreateCodeRepositoryOutput$CodeRepositoryArn": "

The Amazon Resource Name (ARN) of the new repository.

", - "DescribeCodeRepositoryOutput$CodeRepositoryArn": "

The Amazon Resource Name (ARN) of the Git repository.

", - "UpdateCodeRepositoryOutput$CodeRepositoryArn": "

The ARN of the Git repository.

" - } - }, - "CodeRepositoryContains": { - "base": null, - "refs": { - "ListNotebookInstancesInput$DefaultCodeRepositoryContains": "

A string in the name or URL of a Git repository associated with this notebook instance. This filter returns only notebook instances associated with a git repository with a name that contains the specified string.

" - } - }, - "CodeRepositoryNameContains": { - "base": null, - "refs": { - "ListCodeRepositoriesInput$NameContains": "

A string in the Git repositories name. This filter returns only repositories whose name contains the specified string.

" - } - }, - "CodeRepositoryNameOrUrl": { - "base": null, - "refs": { - "AdditionalCodeRepositoryNamesOrUrls$member": null, - "CreateNotebookInstanceInput$DefaultCodeRepository": "

A Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker AI Notebook Instances.

", - "DescribeNotebookInstanceOutput$DefaultCodeRepository": "

The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker AI Notebook Instances.

", - "ListNotebookInstancesInput$AdditionalCodeRepositoryEquals": "

A filter that returns only notebook instances with associated with the specified git repository.

", - "NotebookInstanceSummary$DefaultCodeRepository": "

The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker AI Notebook Instances.

", - "UpdateNotebookInstanceInput$DefaultCodeRepository": "

The Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker AI Notebook Instances.

" - } - }, - "CodeRepositorySortBy": { - "base": null, - "refs": { - "ListCodeRepositoriesInput$SortBy": "

The field to sort results by. The default is Name.

" - } - }, - "CodeRepositorySortOrder": { - "base": null, - "refs": { - "ListCodeRepositoriesInput$SortOrder": "

The sort order for results. The default is Ascending.

" - } - }, - "CodeRepositorySummary": { - "base": "

Specifies summary information about a Git repository.

", - "refs": { - "CodeRepositorySummaryList$member": null - } - }, - "CodeRepositorySummaryList": { - "base": null, - "refs": { - "ListCodeRepositoriesOutput$CodeRepositorySummaryList": "

Gets a list of summaries of the Git repositories. Each summary specifies the following values for the repository:

  • Name

  • Amazon Resource Name (ARN)

  • Creation time

  • Last modified time

  • Configuration information, including the URL location of the repository and the ARN of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the repository.

" - } - }, - "CognitoConfig": { - "base": "

Use this parameter to configure your Amazon Cognito workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.

", - "refs": { - "CreateWorkforceRequest$CognitoConfig": "

Use this parameter to configure an Amazon Cognito private workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.

Do not use OidcConfig if you specify values for CognitoConfig.

", - "Workforce$CognitoConfig": "

The configuration of an Amazon Cognito workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.

" - } - }, - "CognitoMemberDefinition": { - "base": "

Identifies a Amazon Cognito user group. A user group can be used in on or more work teams.

", - "refs": { - "MemberDefinition$CognitoMemberDefinition": "

The Amazon Cognito user group that is part of the work team.

" - } - }, - "CognitoUserGroup": { - "base": null, - "refs": { - "CognitoMemberDefinition$UserGroup": "

An identifier for a user group.

" - } - }, - "CognitoUserPool": { - "base": null, - "refs": { - "CognitoConfig$UserPool": "

A user pool is a user directory in Amazon Cognito. With a user pool, your users can sign in to your web or mobile app through Amazon Cognito. Your users can also sign in through social identity providers like Google, Facebook, Amazon, or Apple, and through SAML identity providers.

", - "CognitoMemberDefinition$UserPool": "

An identifier for a user pool. The user pool must be in the same region as the service that you are calling.

" - } - }, - "CollectionConfig": { - "base": "

Configuration for your collection.

", - "refs": { - "FeatureDefinition$CollectionConfig": "

Configuration for your collection.

" - } - }, - "CollectionConfiguration": { - "base": "

Configuration information for the Amazon SageMaker Debugger output tensor collections.

", - "refs": { - "CollectionConfigurations$member": null - } - }, - "CollectionConfigurations": { - "base": null, - "refs": { - "DebugHookConfig$CollectionConfigurations": "

Configuration information for Amazon SageMaker Debugger tensor collections. To learn more about how to configure the CollectionConfiguration parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

" - } - }, - "CollectionName": { - "base": null, - "refs": { - "CollectionConfiguration$CollectionName": "

The name of the tensor collection. The name must be unique relative to other rule configuration names.

" - } - }, - "CollectionParameters": { - "base": null, - "refs": { - "CollectionConfiguration$CollectionParameters": "

Parameter values for the tensor collection. The allowed parameters are \"name\", \"include_regex\", \"reduction_config\", \"save_config\", \"tensor_names\", and \"save_histogram\".

" - } - }, - "CollectionType": { - "base": null, - "refs": { - "FeatureDefinition$CollectionType": "

A grouping of elements where each element within the collection must have the same feature type (String, Integral, or Fractional).

  • List: An ordered collection of elements.

  • Set: An unordered collection of unique elements.

  • Vector: A specialized list that represents a fixed-size array of elements. The vector dimension is determined by you. Must have elements with fractional feature types.

" - } - }, - "CompilationJobArn": { - "base": null, - "refs": { - "CompilationJobSummary$CompilationJobArn": "

The Amazon Resource Name (ARN) of the model compilation job.

", - "CreateCompilationJobResponse$CompilationJobArn": "

If the action is successful, the service sends back an HTTP 200 response. Amazon SageMaker AI returns the following data in JSON format:

  • CompilationJobArn: The Amazon Resource Name (ARN) of the compiled job.

", - "DescribeCompilationJobResponse$CompilationJobArn": "

The Amazon Resource Name (ARN) of the model compilation job.

" - } - }, - "CompilationJobStatus": { - "base": null, - "refs": { - "CompilationJobSummary$CompilationJobStatus": "

The status of the model compilation job.

", - "DescribeCompilationJobResponse$CompilationJobStatus": "

The status of the model compilation job.

", - "ListCompilationJobsRequest$StatusEquals": "

A filter that retrieves model compilation jobs with a specific CompilationJobStatus status.

" - } - }, - "CompilationJobSummaries": { - "base": null, - "refs": { - "ListCompilationJobsResponse$CompilationJobSummaries": "

An array of CompilationJobSummary objects, each describing a model compilation job.

" - } - }, - "CompilationJobSummary": { - "base": "

A summary of a model compilation job.

", - "refs": { - "CompilationJobSummaries$member": null - } - }, - "CompilerOptions": { - "base": null, - "refs": { - "OutputConfig$CompilerOptions": "

Specifies additional parameters for compiler options in JSON format. The compiler options are TargetPlatform specific. It is required for NVIDIA accelerators and highly recommended for CPU compilations. For any other cases, it is optional to specify CompilerOptions.

  • DTYPE: Specifies the data type for the input. When compiling for ml_* (except for ml_inf) instances using PyTorch framework, provide the data type (dtype) of the model's input. \"float32\" is used if \"DTYPE\" is not specified. Options for data type are:

    • float32: Use either \"float\" or \"float32\".

    • int64: Use either \"int64\" or \"long\".

    For example, {\"dtype\" : \"float32\"}.

  • CPU: Compilation for CPU supports the following compiler options.

    • mcpu: CPU micro-architecture. For example, {'mcpu': 'skylake-avx512'}

    • mattr: CPU flags. For example, {'mattr': ['+neon', '+vfpv4']}

  • ARM: Details of ARM CPU compilations.

    • NEON: NEON is an implementation of the Advanced SIMD extension used in ARMv7 processors.

      For example, add {'mattr': ['+neon']} to the compiler options if compiling for ARM 32-bit platform with the NEON support.

  • NVIDIA: Compilation for NVIDIA GPU supports the following compiler options.

    • gpu_code: Specifies the targeted architecture.

    • trt-ver: Specifies the TensorRT versions in x.y.z. format.

    • cuda-ver: Specifies the CUDA version in x.y format.

    For example, {'gpu-code': 'sm_72', 'trt-ver': '6.0.1', 'cuda-ver': '10.1'}

  • ANDROID: Compilation for the Android OS supports the following compiler options:

    • ANDROID_PLATFORM: Specifies the Android API levels. Available levels range from 21 to 29. For example, {'ANDROID_PLATFORM': 28}.

    • mattr: Add {'mattr': ['+neon']} to compiler options if compiling for ARM 32-bit platform with NEON support.

  • INFERENTIA: Compilation for target ml_inf1 uses compiler options passed in as a JSON string. For example, \"CompilerOptions\": \"\\\"--verbose 1 --num-neuroncores 2 -O2\\\"\".

    For information about supported compiler options, see Neuron Compiler CLI Reference Guide.

  • CoreML: Compilation for the CoreML OutputConfig TargetDevice supports the following compiler options:

    • class_labels: Specifies the classification labels file name inside input tar.gz file. For example, {\"class_labels\": \"imagenet_labels_1000.txt\"}. Labels inside the txt file should be separated by newlines.

" - } - }, - "CompleteOnConvergence": { - "base": null, - "refs": { - "ConvergenceDetected$CompleteOnConvergence": "

A flag to stop a tuning job once AMT has detected that the job has converged.

" - } - }, - "CompressionType": { - "base": null, - "refs": { - "AdditionalS3DataSource$CompressionType": "

The type of compression used for an additional data source used in inference or training. Specify None if your additional data source is not compressed.

", - "AutoMLChannel$CompressionType": "

You can use Gzip or None. The default value is None.

", - "AutoMLJobChannel$CompressionType": "

The allowed compression types depend on the input format and problem type. We allow the compression type Gzip for S3Prefix inputs on tabular data only. For all other inputs, the compression type should be None. If no compression type is provided, we default to None.

", - "Channel$CompressionType": "

If training data is compressed, the compression type. The default value is None. CompressionType is used only in Pipe input mode. In File mode, leave this field unset or set it to None.

", - "CompressionTypes$member": null, - "TransformInput$CompressionType": "

If your transform data is compressed, specify the compression type. Amazon SageMaker automatically decompresses the data for the transform job accordingly. The default value is None.

" - } - }, - "CompressionTypes": { - "base": null, - "refs": { - "ChannelSpecification$SupportedCompressionTypes": "

The allowed compression types, if data compression is used.

" - } - }, - "ComputeQuotaArn": { - "base": null, - "refs": { - "ComputeQuotaSummary$ComputeQuotaArn": "

ARN of the compute allocation definition.

", - "CreateComputeQuotaResponse$ComputeQuotaArn": "

ARN of the compute allocation definition.

", - "DescribeComputeQuotaResponse$ComputeQuotaArn": "

ARN of the compute allocation definition.

", - "UpdateComputeQuotaResponse$ComputeQuotaArn": "

ARN of the compute allocation definition.

" - } - }, - "ComputeQuotaConfig": { - "base": "

Configuration of the compute allocation definition for an entity. This includes the resource sharing option and the setting to preempt low priority tasks.

", - "refs": { - "ComputeQuotaSummary$ComputeQuotaConfig": "

Configuration of the compute allocation definition. This includes the resource sharing option, and the setting to preempt low priority tasks.

", - "CreateComputeQuotaRequest$ComputeQuotaConfig": "

Configuration of the compute allocation definition. This includes the resource sharing option, and the setting to preempt low priority tasks.

", - "DescribeComputeQuotaResponse$ComputeQuotaConfig": "

Configuration of the compute allocation definition. This includes the resource sharing option, and the setting to preempt low priority tasks.

", - "UpdateComputeQuotaRequest$ComputeQuotaConfig": "

Configuration of the compute allocation definition. This includes the resource sharing option, and the setting to preempt low priority tasks.

" - } - }, - "ComputeQuotaId": { - "base": null, - "refs": { - "ComputeQuotaSummary$ComputeQuotaId": "

ID of the compute allocation definition.

", - "CreateComputeQuotaResponse$ComputeQuotaId": "

ID of the compute allocation definition.

", - "DeleteComputeQuotaRequest$ComputeQuotaId": "

ID of the compute allocation definition.

", - "DescribeComputeQuotaRequest$ComputeQuotaId": "

ID of the compute allocation definition.

", - "DescribeComputeQuotaResponse$ComputeQuotaId": "

ID of the compute allocation definition.

", - "UpdateComputeQuotaRequest$ComputeQuotaId": "

ID of the compute allocation definition.

" - } - }, - "ComputeQuotaResourceConfig": { - "base": "

Configuration of the resources used for the compute allocation definition.

", - "refs": { - "AbsoluteBorrowLimitResourceList$member": null, - "ComputeQuotaResourceConfigList$member": null - } - }, - "ComputeQuotaResourceConfigList": { - "base": null, - "refs": { - "ComputeQuotaConfig$ComputeQuotaResources": "

Allocate compute resources by instance types.

" - } - }, - "ComputeQuotaSummary": { - "base": "

Summary of the compute allocation definition.

", - "refs": { - "ComputeQuotaSummaryList$member": null - } - }, - "ComputeQuotaSummaryList": { - "base": null, - "refs": { - "ListComputeQuotasResponse$ComputeQuotaSummaries": "

Summaries of the compute allocation definitions.

" - } - }, - "ComputeQuotaTarget": { - "base": "

The target entity to allocate compute resources to.

", - "refs": { - "ComputeQuotaSummary$ComputeQuotaTarget": "

The target entity to allocate compute resources to.

", - "CreateComputeQuotaRequest$ComputeQuotaTarget": "

The target entity to allocate compute resources to.

", - "DescribeComputeQuotaResponse$ComputeQuotaTarget": "

The target entity to allocate compute resources to.

", - "UpdateComputeQuotaRequest$ComputeQuotaTarget": "

The target entity to allocate compute resources to.

" - } - }, - "ComputeQuotaTargetTeamName": { - "base": null, - "refs": { - "ComputeQuotaTarget$TeamName": "

Name of the team to allocate compute resources to.

" - } - }, - "ConditionOutcome": { - "base": null, - "refs": { - "ConditionStepMetadata$Outcome": "

The outcome of the Condition step evaluation.

" - } - }, - "ConditionStepMetadata": { - "base": "

Metadata for a Condition step.

", - "refs": { - "PipelineExecutionStepMetadata$Condition": "

The outcome of the condition evaluation that was run by this step execution.

" - } - }, - "ConfigKey": { - "base": null, - "refs": { - "CollectionParameters$key": null, - "HookParameters$key": null, - "ProfilingParameters$key": null, - "RuleParameters$key": null - } - }, - "ConfigValue": { - "base": null, - "refs": { - "CollectionParameters$value": null, - "HookParameters$value": null, - "ProfilingParameters$value": null, - "RuleParameters$value": null - } - }, - "ConfiguredSpareInstanceCount": { - "base": null, - "refs": { - "UltraServer$ConfiguredSpareInstanceCount": "

The number of spare instances configured for this UltraServer to provide enhanced resiliency.

" - } - }, - "ConflictException": { - "base": "

There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.

", - "refs": {} - }, - "ContainerArgument": { - "base": null, - "refs": { - "ContainerArguments$member": null, - "MonitoringContainerArguments$member": null - } - }, - "ContainerArguments": { - "base": null, - "refs": { - "AppSpecification$ContainerArguments": "

The arguments for a container used to run a processing job.

" - } - }, - "ContainerConfig": { - "base": "

The configuration used to run the application image container.

", - "refs": { - "CodeEditorAppImageConfig$ContainerConfig": null, - "JupyterLabAppImageConfig$ContainerConfig": null - } - }, - "ContainerDefinition": { - "base": "

Describes the container, as part of model definition.

", - "refs": { - "ContainerDefinitionList$member": null, - "CreateModelInput$PrimaryContainer": "

The location of the primary docker image containing inference code, associated artifacts, and custom environment map that the inference code uses when the model is deployed for predictions.

", - "DescribeModelOutput$PrimaryContainer": "

The location of the primary inference code, associated artifacts, and custom environment map that the inference code uses when it is deployed in production.

", - "Model$PrimaryContainer": null - } - }, - "ContainerDefinitionList": { - "base": null, - "refs": { - "CreateModelInput$Containers": "

Specifies the containers in the inference pipeline.

", - "DescribeModelOutput$Containers": "

The containers in the inference pipeline.

", - "Model$Containers": "

The containers in the inference pipeline.

" - } - }, - "ContainerEntrypoint": { - "base": null, - "refs": { - "AppSpecification$ContainerEntrypoint": "

The entrypoint for a container used to run a processing job.

", - "DataQualityAppSpecification$ContainerEntrypoint": "

The entrypoint for a container used to run a monitoring job.

", - "ModelQualityAppSpecification$ContainerEntrypoint": "

Specifies the entrypoint for a container that the monitoring job runs.

", - "MonitoringAppSpecification$ContainerEntrypoint": "

Specifies the entrypoint for a container used to run the monitoring job.

" - } - }, - "ContainerEntrypointString": { - "base": null, - "refs": { - "ContainerEntrypoint$member": null - } - }, - "ContainerHostname": { - "base": null, - "refs": { - "ContainerDefinition$ContainerHostname": "

This parameter is ignored for models that contain only a PrimaryContainer.

When a ContainerDefinition is part of an inference pipeline, the value of the parameter uniquely identifies the container for the purposes of logging and metrics. For information, see Use Logs and Metrics to Monitor an Inference Pipeline. If you don't specify a value for this parameter for a ContainerDefinition that is part of an inference pipeline, a unique name is automatically assigned based on the position of the ContainerDefinition in the pipeline. If you specify a value for the ContainerHostName for any ContainerDefinition that is part of an inference pipeline, you must specify a value for the ContainerHostName parameter of every ContainerDefinition in that pipeline.

", - "ModelPackageContainerDefinition$ContainerHostname": "

The DNS host name for the Docker container.

" - } - }, - "ContainerImage": { - "base": null, - "refs": { - "AutoMLContainerDefinition$Image": "

The Amazon Elastic Container Registry (Amazon ECR) path of the container. For more information, see ContainerDefinition.

", - "ContainerDefinition$Image": "

The path where inference code is stored. This can be either in Amazon EC2 Container Registry or in a Docker registry that is accessible from the same VPC that you configure for your endpoint. If you are using your own custom algorithm instead of an algorithm provided by SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

The model artifacts in an Amazon S3 bucket and the Docker image for inference container in Amazon EC2 Container Registry must be in the same region as the model or endpoint you are creating.

", - "DeployedImage$SpecifiedImage": "

The image path you specified when you created the model.

", - "DeployedImage$ResolvedImage": "

The specific digest path of the image hosted in this ProductionVariant.

", - "InferenceComponentContainerSpecification$Image": "

The Amazon Elastic Container Registry (Amazon ECR) path where the Docker image for the model is stored.

", - "ModelPackageContainerDefinition$Image": "

The Amazon Elastic Container Registry (Amazon ECR) path where inference code is stored.

If you are using your own custom algorithm instead of an algorithm provided by SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

", - "TrainingSpecification$TrainingImage": "

The Amazon ECR registry path of the Docker image that contains the training algorithm.

" - } - }, - "ContainerMetricsConfig": { - "base": "

The configuration for container-level metrics scraping. Use this configuration to specify a custom metrics endpoint path and publishing frequency for container metrics. When EnableDetailedObservability is set to True in MetricsConfig, metrics are scraped from the container's Prometheus endpoint. If this configuration is not provided, the default path /metrics on port 8080 is used with a default publishing frequency of 60 seconds. For first-party and Deep Learning Containers (DLC), the endpoint path is determined automatically and this configuration is optional.

", - "refs": { - "ContainerDefinition$ContainerMetricsConfig": "

The configuration for container metrics scraping. Specifies the metrics endpoint path and publishing frequency. If not specified when EnableDetailedObservability is True, the default path /metrics on port 8080 is used. For first-party and Deep Learning Containers (DLC), the endpoint path is determined automatically and this configuration is optional.

", - "InferenceComponentContainerSpecification$ContainerMetricsConfig": "

The configuration for container metrics scraping. Specifies the metrics endpoint path and publishing frequency for the inference component's container. If not specified when EnableDetailedObservability is True, the default path /metrics on port 8080 is used. For first-party and Deep Learning Containers (DLC), the endpoint path is determined automatically and this configuration is optional.

", - "InferenceComponentContainerSpecificationSummary$ContainerMetricsConfig": "

The container metrics scraping configuration for this inference component, including the metrics endpoint path and publishing frequency.

" - } - }, - "ContainerMode": { - "base": null, - "refs": { - "ContainerDefinition$Mode": "

Whether the container hosts a single model or multiple models.

" - } - }, - "ContentClassifier": { - "base": null, - "refs": { - "ContentClassifiers$member": null - } - }, - "ContentClassifiers": { - "base": null, - "refs": { - "LabelingJobDataAttributes$ContentClassifiers": "

Declares that your content is free of personally identifiable information or adult content. SageMaker may restrict the Amazon Mechanical Turk workers that can view your task based on this information.

" - } - }, - "ContentColumn": { - "base": null, - "refs": { - "TextClassificationJobConfig$ContentColumn": "

The name of the column used to provide the sentences to be classified. It should not be the same as the target column.

" - } - }, - "ContentDigest": { - "base": null, - "refs": { - "FileSource$ContentDigest": "

The digest of the file source.

", - "MetricsSource$ContentDigest": "

The hash key used for the metrics source.

" - } - }, - "ContentType": { - "base": null, - "refs": { - "AutoMLChannel$ContentType": "

The content type of the data from the input source. You can use text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.

", - "AutoMLJobChannel$ContentType": "

The content type of the data from the input source. The following are the allowed content types for different problems:

  • For tabular problem types: text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.

  • For image classification: image/png, image/jpeg, or image/*. The default value is image/*.

  • For text classification: text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.

  • For time-series forecasting: text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.

  • For text generation (LLMs fine-tuning): text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.

", - "Channel$ContentType": "

The MIME type of the data.

", - "ContentTypes$member": null, - "FileSource$ContentType": "

The type of content stored in the file source.

", - "MetricsSource$ContentType": "

The metric source content type.

", - "TransformInput$ContentType": "

The multipurpose internet mail extension (MIME) type of the data. Amazon SageMaker uses the MIME type with each http call to transfer data to the transform job.

" - } - }, - "ContentTypes": { - "base": null, - "refs": { - "AdditionalInferenceSpecificationDefinition$SupportedContentTypes": "

The supported MIME types for the input data.

", - "ChannelSpecification$SupportedContentTypes": "

The supported MIME types for the data.

", - "InferenceSpecification$SupportedContentTypes": "

The supported MIME types for the input data.

" - } - }, - "ContextArn": { - "base": null, - "refs": { - "ContextSummary$ContextArn": "

The Amazon Resource Name (ARN) of the context.

", - "CreateContextResponse$ContextArn": "

The Amazon Resource Name (ARN) of the context.

", - "DeleteContextResponse$ContextArn": "

The Amazon Resource Name (ARN) of the context.

", - "DescribeContextResponse$ContextArn": "

The Amazon Resource Name (ARN) of the context.

", - "UpdateContextResponse$ContextArn": "

The Amazon Resource Name (ARN) of the context.

" - } - }, - "ContextName": { - "base": null, - "refs": { - "ContextSummary$ContextName": "

The name of the context.

", - "CreateContextRequest$ContextName": "

The name of the context. Must be unique to your account in an Amazon Web Services Region.

", - "DeleteContextRequest$ContextName": "

The name of the context to delete.

", - "DescribeContextResponse$ContextName": "

The name of the context.

", - "UpdateContextRequest$ContextName": "

The name of the context to update.

" - } - }, - "ContextNameOrArn": { - "base": null, - "refs": { - "DescribeContextRequest$ContextName": "

The name of the context to describe.

" - } - }, - "ContextSource": { - "base": "

A structure describing the source of a context.

", - "refs": { - "ContextSummary$Source": "

The source of the context.

", - "CreateContextRequest$Source": "

The source type, ID, and URI.

", - "DescribeContextResponse$Source": "

The source of the context.

" - } - }, - "ContextSummaries": { - "base": null, - "refs": { - "ListContextsResponse$ContextSummaries": "

A list of contexts and their properties.

" - } - }, - "ContextSummary": { - "base": "

Lists a summary of the properties of a context. A context provides a logical grouping of other entities.

", - "refs": { - "ContextSummaries$member": null - } - }, - "ContinuousParameterRange": { - "base": "

A list of continuous hyperparameters to tune.

", - "refs": { - "ContinuousParameterRanges$member": null - } - }, - "ContinuousParameterRangeSpecification": { - "base": "

Defines the possible values for a continuous hyperparameter.

", - "refs": { - "ParameterRange$ContinuousParameterRangeSpecification": "

A ContinuousParameterRangeSpecification object that defines the possible values for a continuous hyperparameter.

" - } - }, - "ContinuousParameterRanges": { - "base": null, - "refs": { - "ParameterRanges$ContinuousParameterRanges": "

The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.

" - } - }, - "ConvergenceDetected": { - "base": "

A flag to indicating that automatic model tuning (AMT) has detected model convergence, defined as a lack of significant improvement (1% or less) against an objective metric.

", - "refs": { - "TuningJobCompletionCriteria$ConvergenceDetected": "

A flag to top your hyperparameter tuning job if automatic model tuning (AMT) has detected that your model has converged as evaluated against your objective function.

" - } - }, - "CountryCode": { - "base": null, - "refs": { - "HolidayConfigAttributes$CountryCode": "

The country code for the holiday calendar.

For the list of public holiday calendars supported by AutoML job V2, see Country Codes. Use the country code corresponding to the country of your choice.

" - } - }, - "CreateAIBenchmarkJobRequest": { - "base": null, - "refs": {} - }, - "CreateAIBenchmarkJobResponse": { - "base": null, - "refs": {} - }, - "CreateAIRecommendationJobRequest": { - "base": null, - "refs": {} - }, - "CreateAIRecommendationJobResponse": { - "base": null, - "refs": {} - }, - "CreateAIWorkloadConfigRequest": { - "base": null, - "refs": {} - }, - "CreateAIWorkloadConfigResponse": { - "base": null, - "refs": {} - }, - "CreateActionRequest": { - "base": null, - "refs": {} - }, - "CreateActionResponse": { - "base": null, - "refs": {} - }, - "CreateAlgorithmInput": { - "base": null, - "refs": {} - }, - "CreateAlgorithmOutput": { - "base": null, - "refs": {} - }, - "CreateAppImageConfigRequest": { - "base": null, - "refs": {} - }, - "CreateAppImageConfigResponse": { - "base": null, - "refs": {} - }, - "CreateAppRequest": { - "base": null, - "refs": {} - }, - "CreateAppResponse": { - "base": null, - "refs": {} - }, - "CreateArtifactRequest": { - "base": null, - "refs": {} - }, - "CreateArtifactResponse": { - "base": null, - "refs": {} - }, - "CreateAutoMLJobRequest": { - "base": null, - "refs": {} - }, - "CreateAutoMLJobResponse": { - "base": null, - "refs": {} - }, - "CreateAutoMLJobV2Request": { - "base": null, - "refs": {} - }, - "CreateAutoMLJobV2Response": { - "base": null, - "refs": {} - }, - "CreateClusterRequest": { - "base": null, - "refs": {} - }, - "CreateClusterResponse": { - "base": null, - "refs": {} - }, - "CreateClusterSchedulerConfigRequest": { - "base": null, - "refs": {} - }, - "CreateClusterSchedulerConfigResponse": { - "base": null, - "refs": {} - }, - "CreateCodeRepositoryInput": { - "base": null, - "refs": {} - }, - "CreateCodeRepositoryOutput": { - "base": null, - "refs": {} - }, - "CreateCompilationJobRequest": { - "base": null, - "refs": {} - }, - "CreateCompilationJobResponse": { - "base": null, - "refs": {} - }, - "CreateComputeQuotaRequest": { - "base": null, - "refs": {} - }, - "CreateComputeQuotaResponse": { - "base": null, - "refs": {} - }, - "CreateContextRequest": { - "base": null, - "refs": {} - }, - "CreateContextResponse": { - "base": null, - "refs": {} - }, - "CreateDataQualityJobDefinitionRequest": { - "base": null, - "refs": {} - }, - "CreateDataQualityJobDefinitionResponse": { - "base": null, - "refs": {} - }, - "CreateDeviceFleetRequest": { - "base": null, - "refs": {} - }, - "CreateDomainRequest": { - "base": null, - "refs": {} - }, - "CreateDomainResponse": { - "base": null, - "refs": {} - }, - "CreateEdgeDeploymentPlanRequest": { - "base": null, - "refs": {} - }, - "CreateEdgeDeploymentPlanResponse": { - "base": null, - "refs": {} - }, - "CreateEdgeDeploymentStageRequest": { - "base": null, - "refs": {} - }, - "CreateEdgePackagingJobRequest": { - "base": null, - "refs": {} - }, - "CreateEndpointConfigInput": { - "base": null, - "refs": {} - }, - "CreateEndpointConfigOutput": { - "base": null, - "refs": {} - }, - "CreateEndpointInput": { - "base": null, - "refs": {} - }, - "CreateEndpointOutput": { - "base": null, - "refs": {} - }, - "CreateExperimentRequest": { - "base": null, - "refs": {} - }, - "CreateExperimentResponse": { - "base": null, - "refs": {} - }, - "CreateFeatureGroupRequest": { - "base": null, - "refs": {} - }, - "CreateFeatureGroupResponse": { - "base": null, - "refs": {} - }, - "CreateFlowDefinitionRequest": { - "base": null, - "refs": {} - }, - "CreateFlowDefinitionResponse": { - "base": null, - "refs": {} - }, - "CreateHubContentPresignedUrlsRequest": { - "base": null, - "refs": {} - }, - "CreateHubContentPresignedUrlsResponse": { - "base": null, - "refs": {} - }, - "CreateHubContentReferenceRequest": { - "base": null, - "refs": {} - }, - "CreateHubContentReferenceResponse": { - "base": null, - "refs": {} - }, - "CreateHubRequest": { - "base": null, - "refs": {} - }, - "CreateHubResponse": { - "base": null, - "refs": {} - }, - "CreateHumanTaskUiRequest": { - "base": null, - "refs": {} - }, - "CreateHumanTaskUiResponse": { - "base": null, - "refs": {} - }, - "CreateHyperParameterTuningJobRequest": { - "base": null, - "refs": {} - }, - "CreateHyperParameterTuningJobResponse": { - "base": null, - "refs": {} - }, - "CreateImageRequest": { - "base": null, - "refs": {} - }, - "CreateImageResponse": { - "base": null, - "refs": {} - }, - "CreateImageVersionRequest": { - "base": null, - "refs": {} - }, - "CreateImageVersionResponse": { - "base": null, - "refs": {} - }, - "CreateInferenceComponentInput": { - "base": null, - "refs": {} - }, - "CreateInferenceComponentOutput": { - "base": null, - "refs": {} - }, - "CreateInferenceExperimentRequest": { - "base": null, - "refs": {} - }, - "CreateInferenceExperimentResponse": { - "base": null, - "refs": {} - }, - "CreateInferenceRecommendationsJobRequest": { - "base": null, - "refs": {} - }, - "CreateInferenceRecommendationsJobResponse": { - "base": null, - "refs": {} - }, - "CreateJobRequest": { - "base": null, - "refs": {} - }, - "CreateJobResponse": { - "base": null, - "refs": {} - }, - "CreateLabelingJobRequest": { - "base": null, - "refs": {} - }, - "CreateLabelingJobResponse": { - "base": null, - "refs": {} - }, - "CreateMlflowAppRequest": { - "base": null, - "refs": {} - }, - "CreateMlflowAppResponse": { - "base": null, - "refs": {} - }, - "CreateMlflowTrackingServerRequest": { - "base": null, - "refs": {} - }, - "CreateMlflowTrackingServerResponse": { - "base": null, - "refs": {} - }, - "CreateModelBiasJobDefinitionRequest": { - "base": null, - "refs": {} - }, - "CreateModelBiasJobDefinitionResponse": { - "base": null, - "refs": {} - }, - "CreateModelCardExportJobRequest": { - "base": null, - "refs": {} - }, - "CreateModelCardExportJobResponse": { - "base": null, - "refs": {} - }, - "CreateModelCardRequest": { - "base": null, - "refs": {} - }, - "CreateModelCardResponse": { - "base": null, - "refs": {} - }, - "CreateModelExplainabilityJobDefinitionRequest": { - "base": null, - "refs": {} - }, - "CreateModelExplainabilityJobDefinitionResponse": { - "base": null, - "refs": {} - }, - "CreateModelInput": { - "base": null, - "refs": {} - }, - "CreateModelOutput": { - "base": null, - "refs": {} - }, - "CreateModelPackageGroupInput": { - "base": null, - "refs": {} - }, - "CreateModelPackageGroupOutput": { - "base": null, - "refs": {} - }, - "CreateModelPackageInput": { - "base": null, - "refs": {} - }, - "CreateModelPackageOutput": { - "base": null, - "refs": {} - }, - "CreateModelQualityJobDefinitionRequest": { - "base": null, - "refs": {} - }, - "CreateModelQualityJobDefinitionResponse": { - "base": null, - "refs": {} - }, - "CreateMonitoringScheduleRequest": { - "base": null, - "refs": {} - }, - "CreateMonitoringScheduleResponse": { - "base": null, - "refs": {} - }, - "CreateNotebookInstanceInput": { - "base": null, - "refs": {} - }, - "CreateNotebookInstanceLifecycleConfigInput": { - "base": null, - "refs": {} - }, - "CreateNotebookInstanceLifecycleConfigOutput": { - "base": null, - "refs": {} - }, - "CreateNotebookInstanceOutput": { - "base": null, - "refs": {} - }, - "CreateOptimizationJobRequest": { - "base": null, - "refs": {} - }, - "CreateOptimizationJobResponse": { - "base": null, - "refs": {} - }, - "CreatePartnerAppPresignedUrlRequest": { - "base": null, - "refs": {} - }, - "CreatePartnerAppPresignedUrlResponse": { - "base": null, - "refs": {} - }, - "CreatePartnerAppRequest": { - "base": null, - "refs": {} - }, - "CreatePartnerAppResponse": { - "base": null, - "refs": {} - }, - "CreatePipelineRequest": { - "base": null, - "refs": {} - }, - "CreatePipelineResponse": { - "base": null, - "refs": {} - }, - "CreatePresignedDomainUrlRequest": { - "base": null, - "refs": {} - }, - "CreatePresignedDomainUrlResponse": { - "base": null, - "refs": {} - }, - "CreatePresignedMlflowAppUrlRequest": { - "base": null, - "refs": {} - }, - "CreatePresignedMlflowAppUrlResponse": { - "base": null, - "refs": {} - }, - "CreatePresignedMlflowTrackingServerUrlRequest": { - "base": null, - "refs": {} - }, - "CreatePresignedMlflowTrackingServerUrlResponse": { - "base": null, - "refs": {} - }, - "CreatePresignedNotebookInstanceUrlInput": { - "base": null, - "refs": {} - }, - "CreatePresignedNotebookInstanceUrlOutput": { - "base": null, - "refs": {} - }, - "CreateProcessingJobRequest": { - "base": null, - "refs": {} - }, - "CreateProcessingJobResponse": { - "base": null, - "refs": {} - }, - "CreateProjectInput": { - "base": null, - "refs": {} - }, - "CreateProjectOutput": { - "base": null, - "refs": {} - }, - "CreateSpaceRequest": { - "base": null, - "refs": {} - }, - "CreateSpaceResponse": { - "base": null, - "refs": {} - }, - "CreateStudioLifecycleConfigRequest": { - "base": null, - "refs": {} - }, - "CreateStudioLifecycleConfigResponse": { - "base": null, - "refs": {} - }, - "CreateTemplateProvider": { - "base": "

Contains configuration details for a template provider. Only one type of template provider can be specified.

", - "refs": { - "CreateTemplateProviderList$member": null - } - }, - "CreateTemplateProviderList": { - "base": null, - "refs": { - "CreateProjectInput$TemplateProviders": "

An array of template provider configurations for creating infrastructure resources for the project.

" - } - }, - "CreateTrainingJobRequest": { - "base": null, - "refs": {} - }, - "CreateTrainingJobResponse": { - "base": null, - "refs": {} - }, - "CreateTrainingPlanRequest": { - "base": null, - "refs": {} - }, - "CreateTrainingPlanResponse": { - "base": null, - "refs": {} - }, - "CreateTransformJobRequest": { - "base": null, - "refs": {} - }, - "CreateTransformJobResponse": { - "base": null, - "refs": {} - }, - "CreateTrialComponentRequest": { - "base": null, - "refs": {} - }, - "CreateTrialComponentResponse": { - "base": null, - "refs": {} - }, - "CreateTrialRequest": { - "base": null, - "refs": {} - }, - "CreateTrialResponse": { - "base": null, - "refs": {} - }, - "CreateUserProfileRequest": { - "base": null, - "refs": {} - }, - "CreateUserProfileResponse": { - "base": null, - "refs": {} - }, - "CreateWorkforceRequest": { - "base": null, - "refs": {} - }, - "CreateWorkforceResponse": { - "base": null, - "refs": {} - }, - "CreateWorkteamRequest": { - "base": null, - "refs": {} - }, - "CreateWorkteamResponse": { - "base": null, - "refs": {} - }, - "CreationTime": { - "base": null, - "refs": { - "AlgorithmSummary$CreationTime": "

A timestamp that shows when the algorithm was created.

", - "AppDetails$CreationTime": "

The creation time.

", - "BatchDescribeModelPackageSummary$CreationTime": "

The creation time of the mortgage package summary.

", - "CodeRepositorySummary$CreationTime": "

The date and time that the Git repository was created.

", - "CompilationJobSummary$CreationTime": "

The time when the model compilation job was created.

", - "DescribeAlgorithmOutput$CreationTime": "

A timestamp specifying when the algorithm was created.

", - "DescribeCodeRepositoryOutput$CreationTime": "

The date and time that the repository was created.

", - "DescribeCompilationJobResponse$CreationTime": "

The time that the model compilation job was created.

", - "DescribeDomainResponse$CreationTime": "

The creation time.

", - "DescribeFeatureGroupResponse$CreationTime": "

A timestamp indicating when SageMaker created the FeatureGroup.

", - "DescribeFeatureMetadataResponse$CreationTime": "

A timestamp indicating when the feature was created.

", - "DescribeInferenceRecommendationsJobResponse$CreationTime": "

A timestamp that shows when the job was created.

", - "DescribeModelPackageGroupOutput$CreationTime": "

The time that the model group was created.

", - "DescribeModelPackageOutput$CreationTime": "

A timestamp specifying when the model package was created.

", - "DescribeNotebookInstanceLifecycleConfigOutput$CreationTime": "

A timestamp that tells when the lifecycle configuration was created.

", - "DescribeNotebookInstanceOutput$CreationTime": "

A timestamp. Use this parameter to return the time when the notebook instance was created

", - "DescribeOptimizationJobResponse$CreationTime": "

The time when you created the optimization job.

", - "DescribeSpaceResponse$CreationTime": "

The creation time.

", - "DescribeUserProfileResponse$CreationTime": "

The creation time.

", - "DomainDetails$CreationTime": "

The creation time.

", - "FeatureGroup$CreationTime": "

The time a FeatureGroup was created.

", - "FeatureMetadata$CreationTime": "

A timestamp indicating when the feature was created.

", - "InferenceRecommendationsJob$CreationTime": "

A timestamp that shows when the job was created.

", - "ListAlgorithmsInput$CreationTimeAfter": "

A filter that returns only algorithms created after the specified time (timestamp).

", - "ListAlgorithmsInput$CreationTimeBefore": "

A filter that returns only algorithms created before the specified time (timestamp).

", - "ListCodeRepositoriesInput$CreationTimeAfter": "

A filter that returns only Git repositories that were created after the specified time.

", - "ListCodeRepositoriesInput$CreationTimeBefore": "

A filter that returns only Git repositories that were created before the specified time.

", - "ListCompilationJobsRequest$CreationTimeAfter": "

A filter that returns the model compilation jobs that were created after a specified time.

", - "ListCompilationJobsRequest$CreationTimeBefore": "

A filter that returns the model compilation jobs that were created before a specified time.

", - "ListFeatureGroupsRequest$CreationTimeAfter": "

Use this parameter to search for FeatureGroupss created after a specific date and time.

", - "ListFeatureGroupsRequest$CreationTimeBefore": "

Use this parameter to search for FeatureGroupss created before a specific date and time.

", - "ListInferenceRecommendationsJobsRequest$CreationTimeAfter": "

A filter that returns only jobs created after the specified time (timestamp).

", - "ListInferenceRecommendationsJobsRequest$CreationTimeBefore": "

A filter that returns only jobs created before the specified time (timestamp).

", - "ListModelPackageGroupsInput$CreationTimeAfter": "

A filter that returns only model groups created after the specified time.

", - "ListModelPackageGroupsInput$CreationTimeBefore": "

A filter that returns only model groups created before the specified time.

", - "ListModelPackagesInput$CreationTimeAfter": "

A filter that returns only model packages created after the specified time (timestamp).

", - "ListModelPackagesInput$CreationTimeBefore": "

A filter that returns only model packages created before the specified time (timestamp).

", - "ListNotebookInstanceLifecycleConfigsInput$CreationTimeBefore": "

A filter that returns only lifecycle configurations that were created before the specified time (timestamp).

", - "ListNotebookInstanceLifecycleConfigsInput$CreationTimeAfter": "

A filter that returns only lifecycle configurations that were created after the specified time (timestamp).

", - "ListNotebookInstancesInput$CreationTimeBefore": "

A filter that returns only notebook instances that were created before the specified time (timestamp).

", - "ListNotebookInstancesInput$CreationTimeAfter": "

A filter that returns only notebook instances that were created after the specified time (timestamp).

", - "ListOptimizationJobsRequest$CreationTimeAfter": "

Filters the results to only those optimization jobs that were created after the specified time.

", - "ListOptimizationJobsRequest$CreationTimeBefore": "

Filters the results to only those optimization jobs that were created before the specified time.

", - "ModelPackage$CreationTime": "

The time that the model package was created.

", - "ModelPackageGroup$CreationTime": "

The time that the model group was created.

", - "ModelPackageGroupSummary$CreationTime": "

The time that the model group was created.

", - "ModelPackageSummary$CreationTime": "

A timestamp that shows when the model package was created.

", - "NotebookInstanceLifecycleConfigSummary$CreationTime": "

A timestamp that tells when the lifecycle configuration was created.

", - "NotebookInstanceSummary$CreationTime": "

A timestamp that shows when the notebook instance was created.

", - "OptimizationJobSummary$CreationTime": "

The time when you created the optimization job.

", - "SpaceDetails$CreationTime": "

The creation time.

", - "UserProfileDetails$CreationTime": "

The creation time.

" - } - }, - "CronScheduleExpression": { - "base": null, - "refs": { - "ScheduledUpdateConfig$ScheduleExpression": "

A cron expression that specifies the schedule that SageMaker follows when updating the AMI.

" - } - }, - "CrossAccountFilterOption": { - "base": null, - "refs": { - "ListModelPackageGroupsInput$CrossAccountFilterOption": "

A filter that returns either model groups shared with you or model groups in your own account. When the value is CrossAccount, the results show the resources made discoverable to you from other accounts. When the value is SameAccount or null, the results show resources from your account. The default is SameAccount.

", - "SearchRequest$CrossAccountFilterOption": "

A cross account filter option. When the value is \"CrossAccount\" the search results will only include resources made discoverable to you from other accounts. When the value is \"SameAccount\" or null the search results will only include resources from your account. Default is null. For more information on searching for resources made discoverable to your account, see Search discoverable resources in the SageMaker Developer Guide. The maximum number of ResourceCatalogs viewable is 1000.

" - } - }, - "CsvContentType": { - "base": null, - "refs": { - "CsvContentTypes$member": null - } - }, - "CsvContentTypes": { - "base": null, - "refs": { - "CaptureContentTypeHeader$CsvContentTypes": "

The list of all content type headers that Amazon SageMaker AI will treat as CSV and capture accordingly.

" - } - }, - "CurrencyCode": { - "base": null, - "refs": { - "DescribeTrainingPlanResponse$CurrencyCode": "

The currency code for the upfront fee (e.g., USD).

", - "TrainingPlanExtension$CurrencyCode": "

The currency code for the upfront fee (e.g., USD).

", - "TrainingPlanExtensionOffering$CurrencyCode": "

The currency code for the upfront fee (e.g., USD).

", - "TrainingPlanOffering$CurrencyCode": "

The currency code for the upfront fee (e.g., USD).

", - "TrainingPlanSummary$CurrencyCode": "

The currency code for the upfront fee (e.g., USD).

" - } - }, - "CustomFileSystem": { - "base": "

A file system, created by you, that you assign to a user profile or space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI Studio.

", - "refs": { - "CustomFileSystems$member": null - } - }, - "CustomFileSystemConfig": { - "base": "

The settings for assigning a custom file system to a user profile or space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI Studio.

", - "refs": { - "CustomFileSystemConfigs$member": null - } - }, - "CustomFileSystemConfigs": { - "base": null, - "refs": { - "DefaultSpaceSettings$CustomFileSystemConfigs": "

The settings for assigning a custom file system to a domain. Permitted users can access this file system in Amazon SageMaker AI Studio.

", - "UserSettings$CustomFileSystemConfigs": "

The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker AI Studio.

SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

" - } - }, - "CustomFileSystems": { - "base": null, - "refs": { - "SpaceSettings$CustomFileSystems": "

A file system, created by you, that you assign to a space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI Studio.

" - } - }, - "CustomImage": { - "base": "

A custom SageMaker AI image. For more information, see Bring your own SageMaker AI image.

", - "refs": { - "CustomImages$member": null - } - }, - "CustomImageContainerArguments": { - "base": null, - "refs": { - "ContainerConfig$ContainerArguments": "

The arguments for the container when you're running the application.

" - } - }, - "CustomImageContainerEntrypoint": { - "base": null, - "refs": { - "ContainerConfig$ContainerEntrypoint": "

The entrypoint used to run the application in the container.

" - } - }, - "CustomImageContainerEnvironmentVariables": { - "base": null, - "refs": { - "ContainerConfig$ContainerEnvironmentVariables": "

The environment variables to set in the container

" - } - }, - "CustomImages": { - "base": null, - "refs": { - "CodeEditorAppSettings$CustomImages": "

A list of custom SageMaker images that are configured to run as a Code Editor app.

", - "JupyterLabAppSettings$CustomImages": "

A list of custom SageMaker images that are configured to run as a JupyterLab app.

", - "KernelGatewayAppSettings$CustomImages": "

A list of custom SageMaker AI images that are configured to run as a KernelGateway app.

The maximum number of custom images are as follows.

  • On a domain level: 200

  • On a space level: 5

  • On a user profile level: 5

", - "RSessionAppSettings$CustomImages": "

A list of custom SageMaker AI images that are configured to run as a RSession app.

" - } - }, - "CustomPosixUserConfig": { - "base": "

Details about the POSIX identity that is used for file system operations.

", - "refs": { - "DefaultSpaceSettings$CustomPosixUserConfig": null, - "UserSettings$CustomPosixUserConfig": "

Details about the POSIX identity that is used for file system operations.

SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

" - } - }, - "CustomerMetadataKey": { - "base": null, - "refs": { - "CustomerMetadataKeyList$member": null, - "CustomerMetadataMap$key": null - } - }, - "CustomerMetadataKeyList": { - "base": null, - "refs": { - "UpdateModelPackageInput$CustomerMetadataPropertiesToRemove": "

The metadata properties associated with the model package versions to remove.

" - } - }, - "CustomerMetadataMap": { - "base": null, - "refs": { - "CreateModelPackageInput$CustomerMetadataProperties": "

The metadata properties associated with the model package versions.

", - "DescribeModelPackageOutput$CustomerMetadataProperties": "

The metadata properties associated with the model package versions.

", - "ModelPackage$CustomerMetadataProperties": "

The metadata properties for the model package.

", - "UpdateModelPackageInput$CustomerMetadataProperties": "

The metadata properties associated with the model package versions.

" - } - }, - "CustomerMetadataValue": { - "base": null, - "refs": { - "CustomerMetadataMap$value": null - } - }, - "CustomizationTechnique": { - "base": null, - "refs": { - "ServerlessJobConfig$CustomizationTechnique": "

The model customization technique.

" - } - }, - "CustomizedMetricSpecification": { - "base": "

A customized metric.

", - "refs": { - "MetricSpecification$Customized": "

Information about a customized metric.

" - } - }, - "DataCaptureConfig": { - "base": "

Configuration to control how SageMaker AI captures inference data.

", - "refs": { - "CreateEndpointConfigInput$DataCaptureConfig": null, - "DescribeEndpointConfigOutput$DataCaptureConfig": null - } - }, - "DataCaptureConfigSummary": { - "base": "

The currently active data capture configuration used by your Endpoint.

", - "refs": { - "DescribeEndpointOutput$DataCaptureConfig": null, - "Endpoint$DataCaptureConfig": null - } - }, - "DataCatalogConfig": { - "base": "

The meta data of the Glue table which serves as data catalog for the OfflineStore.

", - "refs": { - "OfflineStoreConfig$DataCatalogConfig": "

The meta data of the Glue table for the OfflineStore. If not provided, Feature Store auto-generates the table name, database, and catalog when the OfflineStore is created. You can optionally provide this configuration to specify custom values. This applies to both Glue and Apache Iceberg table formats.

" - } - }, - "DataDistributionType": { - "base": null, - "refs": { - "DatasetDefinition$DataDistributionType": "

Whether the generated dataset is FullyReplicated or ShardedByS3Key (default).

" - } - }, - "DataExplorationNotebookLocation": { - "base": null, - "refs": { - "AutoMLJobArtifacts$DataExplorationNotebookLocation": "

The URL of the notebook location.

" - } - }, - "DataInputConfig": { - "base": null, - "refs": { - "DerivedInformation$DerivedDataInputConfig": "

The data input configuration that SageMaker Neo automatically derived for the model. When SageMaker Neo derives this information, you don't need to specify the data input configuration when you create a compilation job.

", - "InputConfig$DataInputConfig": "

Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. The data inputs are Framework specific.

  • TensorFlow: You must specify the name and shape (NHWC format) of the expected data inputs using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different.

    • Examples for one input:

      • If using the console, {\"input\":[1,1024,1024,3]}

      • If using the CLI, {\\\"input\\\":[1,1024,1024,3]}

    • Examples for two inputs:

      • If using the console, {\"data1\": [1,28,28,1], \"data2\":[1,28,28,1]}

      • If using the CLI, {\\\"data1\\\": [1,28,28,1], \\\"data2\\\":[1,28,28,1]}

  • KERAS: You must specify the name and shape (NCHW format) of expected data inputs using a dictionary format for your trained model. Note that while Keras model artifacts should be uploaded in NHWC (channel-last) format, DataInputConfig should be specified in NCHW (channel-first) format. The dictionary formats required for the console and CLI are different.

    • Examples for one input:

      • If using the console, {\"input_1\":[1,3,224,224]}

      • If using the CLI, {\\\"input_1\\\":[1,3,224,224]}

    • Examples for two inputs:

      • If using the console, {\"input_1\": [1,3,224,224], \"input_2\":[1,3,224,224]}

      • If using the CLI, {\\\"input_1\\\": [1,3,224,224], \\\"input_2\\\":[1,3,224,224]}

  • MXNET/ONNX/DARKNET: You must specify the name and shape (NCHW format) of the expected data inputs in order using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different.

    • Examples for one input:

      • If using the console, {\"data\":[1,3,1024,1024]}

      • If using the CLI, {\\\"data\\\":[1,3,1024,1024]}

    • Examples for two inputs:

      • If using the console, {\"var1\": [1,1,28,28], \"var2\":[1,1,28,28]}

      • If using the CLI, {\\\"var1\\\": [1,1,28,28], \\\"var2\\\":[1,1,28,28]}

  • PyTorch: You can either specify the name and shape (NCHW format) of expected data inputs in order using a dictionary format for your trained model or you can specify the shape only using a list format. The dictionary formats required for the console and CLI are different. The list formats for the console and CLI are the same.

    • Examples for one input in dictionary format:

      • If using the console, {\"input0\":[1,3,224,224]}

      • If using the CLI, {\\\"input0\\\":[1,3,224,224]}

    • Example for one input in list format: [[1,3,224,224]]

    • Examples for two inputs in dictionary format:

      • If using the console, {\"input0\":[1,3,224,224], \"input1\":[1,3,224,224]}

      • If using the CLI, {\\\"input0\\\":[1,3,224,224], \\\"input1\\\":[1,3,224,224]}

    • Example for two inputs in list format: [[1,3,224,224], [1,3,224,224]]

  • XGBOOST: input data name and shape are not needed.

DataInputConfig supports the following parameters for CoreML TargetDevice (ML Model format):

  • shape: Input shape, for example {\"input_1\": {\"shape\": [1,224,224,3]}}. In addition to static input shapes, CoreML converter supports Flexible input shapes:

    • Range Dimension. You can use the Range Dimension feature if you know the input shape will be within some specific interval in that dimension, for example: {\"input_1\": {\"shape\": [\"1..10\", 224, 224, 3]}}

    • Enumerated shapes. Sometimes, the models are trained to work only on a select set of inputs. You can enumerate all supported input shapes, for example: {\"input_1\": {\"shape\": [[1, 224, 224, 3], [1, 160, 160, 3]]}}

  • default_shape: Default input shape. You can set a default shape during conversion for both Range Dimension and Enumerated Shapes. For example {\"input_1\": {\"shape\": [\"1..10\", 224, 224, 3], \"default_shape\": [1, 224, 224, 3]}}

  • type: Input type. Allowed values: Image and Tensor. By default, the converter generates an ML Model with inputs of type Tensor (MultiArray). User can set input type to be Image. Image input type requires additional input parameters such as bias and scale.

  • bias: If the input type is an Image, you need to provide the bias vector.

  • scale: If the input type is an Image, you need to provide a scale factor.

CoreML ClassifierConfig parameters can be specified using OutputConfig CompilerOptions. CoreML converter supports Tensorflow and PyTorch models. CoreML conversion examples:

  • Tensor type input:

    • \"DataInputConfig\": {\"input_1\": {\"shape\": [[1,224,224,3], [1,160,160,3]], \"default_shape\": [1,224,224,3]}}

  • Tensor type input without input name (PyTorch):

    • \"DataInputConfig\": [{\"shape\": [[1,3,224,224], [1,3,160,160]], \"default_shape\": [1,3,224,224]}]

  • Image type input:

    • \"DataInputConfig\": {\"input_1\": {\"shape\": [[1,224,224,3], [1,160,160,3]], \"default_shape\": [1,224,224,3], \"type\": \"Image\", \"bias\": [-1,-1,-1], \"scale\": 0.007843137255}}

    • \"CompilerOptions\": {\"class_labels\": \"imagenet_labels_1000.txt\"}

  • Image type input without input name (PyTorch):

    • \"DataInputConfig\": [{\"shape\": [[1,3,224,224], [1,3,160,160]], \"default_shape\": [1,3,224,224], \"type\": \"Image\", \"bias\": [-1,-1,-1], \"scale\": 0.007843137255}]

    • \"CompilerOptions\": {\"class_labels\": \"imagenet_labels_1000.txt\"}

Depending on the model format, DataInputConfig requires the following parameters for ml_eia2 OutputConfig:TargetDevice.

  • For TensorFlow models saved in the SavedModel format, specify the input names from signature_def_key and the input model shapes for DataInputConfig. Specify the signature_def_key in OutputConfig:CompilerOptions if the model does not use TensorFlow's default signature def key. For example:

    • \"DataInputConfig\": {\"inputs\": [1, 224, 224, 3]}

    • \"CompilerOptions\": {\"signature_def_key\": \"serving_custom\"}

  • For TensorFlow models saved as a frozen graph, specify the input tensor names and shapes in DataInputConfig and the output tensor names for output_names in OutputConfig:CompilerOptions . For example:

    • \"DataInputConfig\": {\"input_tensor:0\": [1, 224, 224, 3]}

    • \"CompilerOptions\": {\"output_names\": [\"output_tensor:0\"]}

", - "ModelInput$DataInputConfig": "

The input configuration object for the model.

" - } - }, - "DataProcessing": { - "base": "

The data structure used to specify the data to be used for inference in a batch transform job and to associate the data that is relevant to the prediction results in the output. The input filter provided allows you to exclude input data that is not needed for inference in a batch transform job. The output filter provided allows you to include input data relevant to interpreting the predictions in the output from the job. For more information, see Associate Prediction Results with their Corresponding Input Records.

", - "refs": { - "CreateTransformJobRequest$DataProcessing": "

The data structure used to specify the data to be used for inference in a batch transform job and to associate the data that is relevant to the prediction results in the output. The input filter provided allows you to exclude input data that is not needed for inference in a batch transform job. The output filter provided allows you to include input data relevant to interpreting the predictions in the output from the job. For more information, see Associate Prediction Results with their Corresponding Input Records.

", - "DescribeTransformJobResponse$DataProcessing": null, - "TransformJob$DataProcessing": null - } - }, - "DataQualityAppSpecification": { - "base": "

Information about the container that a data quality monitoring job runs.

", - "refs": { - "CreateDataQualityJobDefinitionRequest$DataQualityAppSpecification": "

Specifies the container that runs the monitoring job.

", - "DescribeDataQualityJobDefinitionResponse$DataQualityAppSpecification": "

Information about the container that runs the data quality monitoring job.

" - } - }, - "DataQualityBaselineConfig": { - "base": "

Configuration for monitoring constraints and monitoring statistics. These baseline resources are compared against the results of the current job from the series of jobs scheduled to collect data periodically.

", - "refs": { - "CreateDataQualityJobDefinitionRequest$DataQualityBaselineConfig": "

Configures the constraints and baselines for the monitoring job.

", - "DescribeDataQualityJobDefinitionResponse$DataQualityBaselineConfig": "

The constraints and baselines for the data quality monitoring job definition.

" - } - }, - "DataQualityJobInput": { - "base": "

The input for the data quality monitoring job. Currently endpoints are supported for input.

", - "refs": { - "CreateDataQualityJobDefinitionRequest$DataQualityJobInput": "

A list of inputs for the monitoring job. Currently endpoints are supported as monitoring inputs.

", - "DescribeDataQualityJobDefinitionResponse$DataQualityJobInput": "

The list of inputs for the data quality monitoring job. Currently endpoints are supported.

" - } - }, - "DataSource": { - "base": "

Describes the location of the channel data.

", - "refs": { - "Channel$DataSource": "

The location of the channel data.

" - } - }, - "DataSourceName": { - "base": null, - "refs": { - "IdentityProviderOAuthSetting$DataSourceName": "

The name of the data source that you're connecting to. Canvas currently supports OAuth for Snowflake and Salesforce Data Cloud.

" - } - }, - "Database": { - "base": null, - "refs": { - "DataCatalogConfig$Database": "

The name of the Glue table database.

" - } - }, - "DatasetDefinition": { - "base": "

Configuration for Dataset Definition inputs. The Dataset Definition input must specify exactly one of either AthenaDatasetDefinition or RedshiftDatasetDefinition types.

", - "refs": { - "ProcessingInput$DatasetDefinition": "

Configuration for a Dataset Definition input.

" - } - }, - "DatasetSource": { - "base": "

Specifies a dataset source for a channel.

", - "refs": { - "DataSource$DatasetSource": "

The dataset resource that's associated with a channel.

" - } - }, - "DebugHookConfig": { - "base": "

Configuration information for the Amazon SageMaker Debugger hook parameters, metric and tensor collections, and storage paths. To learn more about how to configure the DebugHookConfig parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

", - "refs": { - "CreateTrainingJobRequest$DebugHookConfig": null, - "DescribeTrainingJobResponse$DebugHookConfig": null, - "TrainingJob$DebugHookConfig": null - } - }, - "DebugRuleConfiguration": { - "base": "

Configuration information for SageMaker Debugger rules for debugging. To learn more about how to configure the DebugRuleConfiguration parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

", - "refs": { - "DebugRuleConfigurations$member": null - } - }, - "DebugRuleConfigurations": { - "base": null, - "refs": { - "CreateTrainingJobRequest$DebugRuleConfigurations": "

Configuration information for Amazon SageMaker Debugger rules for debugging output tensors.

", - "DescribeTrainingJobResponse$DebugRuleConfigurations": "

Configuration information for Amazon SageMaker Debugger rules for debugging output tensors.

", - "TrainingJob$DebugRuleConfigurations": "

Information about the debug rule configuration.

" - } - }, - "DebugRuleEvaluationStatus": { - "base": "

Information about the status of the rule evaluation.

", - "refs": { - "DebugRuleEvaluationStatuses$member": null - } - }, - "DebugRuleEvaluationStatuses": { - "base": null, - "refs": { - "DescribeTrainingJobResponse$DebugRuleEvaluationStatuses": "

Evaluation status of Amazon SageMaker Debugger rules for debugging on a training job.

", - "TrainingJob$DebugRuleEvaluationStatuses": "

Information about the evaluation status of the rules for the training job.

" - } - }, - "DeepHealthCheckConfigurations": { - "base": null, - "refs": { - "StartClusterHealthCheckRequest$DeepHealthCheckConfigurations": "

A list of configurations containing instance group names, EC2 instance IDs, and deep health checks to perform.

" - } - }, - "DeepHealthCheckType": { - "base": null, - "refs": { - "DeepHealthChecks$member": null, - "OnStartDeepHealthChecks$member": null - } - }, - "DeepHealthChecks": { - "base": null, - "refs": { - "InstanceGroupHealthCheckConfiguration$DeepHealthChecks": "

A list of deep health checks to be performed.

" - } - }, - "DefaultDomainIdList": { - "base": null, - "refs": { - "CreateMlflowAppRequest$DefaultDomainIdList": "

List of SageMaker domain IDs for which this MLflow App is used as the default.

", - "DescribeMlflowAppResponse$DefaultDomainIdList": "

List of SageMaker Domain IDs for which this MLflow App is the default.

", - "UpdateMlflowAppRequest$DefaultDomainIdList": "

List of SageMaker Domain IDs for which this MLflow App is the default.

" - } - }, - "DefaultEbsStorageSettings": { - "base": "

A collection of default EBS storage settings that apply to spaces created within a domain or user profile.

", - "refs": { - "DefaultSpaceStorageSettings$DefaultEbsStorageSettings": "

The default EBS storage settings for a space.

" - } - }, - "DefaultGid": { - "base": null, - "refs": { - "FileSystemConfig$DefaultGid": "

The default POSIX group ID (GID). If not specified, defaults to 100.

" - } - }, - "DefaultSpaceSettings": { - "base": "

The default settings for shared spaces that users create in the domain.

SageMaker applies these settings only to shared spaces. It doesn't apply them to private spaces.

", - "refs": { - "CreateDomainRequest$DefaultSpaceSettings": "

The default settings for shared spaces that users create in the domain.

", - "DescribeDomainResponse$DefaultSpaceSettings": "

The default settings for shared spaces that users create in the domain.

", - "UpdateDomainRequest$DefaultSpaceSettings": "

The default settings for shared spaces that users create in the domain.

" - } - }, - "DefaultSpaceStorageSettings": { - "base": "

The default storage settings for a space.

", - "refs": { - "DefaultSpaceSettings$SpaceStorageSettings": null, - "UserSettings$SpaceStorageSettings": "

The storage settings for a space.

SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

" - } - }, - "DefaultUid": { - "base": null, - "refs": { - "FileSystemConfig$DefaultUid": "

The default POSIX user ID (UID). If not specified, defaults to 1000.

" - } - }, - "DeleteAIBenchmarkJobRequest": { - "base": null, - "refs": {} - }, - "DeleteAIBenchmarkJobResponse": { - "base": null, - "refs": {} - }, - "DeleteAIRecommendationJobRequest": { - "base": null, - "refs": {} - }, - "DeleteAIRecommendationJobResponse": { - "base": null, - "refs": {} - }, - "DeleteAIWorkloadConfigRequest": { - "base": null, - "refs": {} - }, - "DeleteAIWorkloadConfigResponse": { - "base": null, - "refs": {} - }, - "DeleteActionRequest": { - "base": null, - "refs": {} - }, - "DeleteActionResponse": { - "base": null, - "refs": {} - }, - "DeleteAlgorithmInput": { - "base": null, - "refs": {} - }, - "DeleteAppImageConfigRequest": { - "base": null, - "refs": {} - }, - "DeleteAppRequest": { - "base": null, - "refs": {} - }, - "DeleteArtifactRequest": { - "base": null, - "refs": {} - }, - "DeleteArtifactResponse": { - "base": null, - "refs": {} - }, - "DeleteAssociationRequest": { - "base": null, - "refs": {} - }, - "DeleteAssociationResponse": { - "base": null, - "refs": {} - }, - "DeleteClusterRequest": { - "base": null, - "refs": {} - }, - "DeleteClusterResponse": { - "base": null, - "refs": {} - }, - "DeleteClusterSchedulerConfigRequest": { - "base": null, - "refs": {} - }, - "DeleteCodeRepositoryInput": { - "base": null, - "refs": {} - }, - "DeleteCompilationJobRequest": { - "base": null, - "refs": {} - }, - "DeleteComputeQuotaRequest": { - "base": null, - "refs": {} - }, - "DeleteContextRequest": { - "base": null, - "refs": {} - }, - "DeleteContextResponse": { - "base": null, - "refs": {} - }, - "DeleteDataQualityJobDefinitionRequest": { - "base": null, - "refs": {} - }, - "DeleteDeviceFleetRequest": { - "base": null, - "refs": {} - }, - "DeleteDomainRequest": { - "base": null, - "refs": {} - }, - "DeleteEdgeDeploymentPlanRequest": { - "base": null, - "refs": {} - }, - "DeleteEdgeDeploymentStageRequest": { - "base": null, - "refs": {} - }, - "DeleteEndpointConfigInput": { - "base": null, - "refs": {} - }, - "DeleteEndpointInput": { - "base": null, - "refs": {} - }, - "DeleteExperimentRequest": { - "base": null, - "refs": {} - }, - "DeleteExperimentResponse": { - "base": null, - "refs": {} - }, - "DeleteFeatureGroupRequest": { - "base": null, - "refs": {} - }, - "DeleteFlowDefinitionRequest": { - "base": null, - "refs": {} - }, - "DeleteFlowDefinitionResponse": { - "base": null, - "refs": {} - }, - "DeleteHubContentReferenceRequest": { - "base": null, - "refs": {} - }, - "DeleteHubContentRequest": { - "base": null, - "refs": {} - }, - "DeleteHubRequest": { - "base": null, - "refs": {} - }, - "DeleteHumanTaskUiRequest": { - "base": null, - "refs": {} - }, - "DeleteHumanTaskUiResponse": { - "base": null, - "refs": {} - }, - "DeleteHyperParameterTuningJobRequest": { - "base": null, - "refs": {} - }, - "DeleteImageRequest": { - "base": null, - "refs": {} - }, - "DeleteImageResponse": { - "base": null, - "refs": {} - }, - "DeleteImageVersionRequest": { - "base": null, - "refs": {} - }, - "DeleteImageVersionResponse": { - "base": null, - "refs": {} - }, - "DeleteInferenceComponentInput": { - "base": null, - "refs": {} - }, - "DeleteInferenceExperimentRequest": { - "base": null, - "refs": {} - }, - "DeleteInferenceExperimentResponse": { - "base": null, - "refs": {} - }, - "DeleteJobRequest": { - "base": null, - "refs": {} - }, - "DeleteJobResponse": { - "base": null, - "refs": {} - }, - "DeleteMlflowAppRequest": { - "base": null, - "refs": {} - }, - "DeleteMlflowAppResponse": { - "base": null, - "refs": {} - }, - "DeleteMlflowTrackingServerRequest": { - "base": null, - "refs": {} - }, - "DeleteMlflowTrackingServerResponse": { - "base": null, - "refs": {} - }, - "DeleteModelBiasJobDefinitionRequest": { - "base": null, - "refs": {} - }, - "DeleteModelCardRequest": { - "base": null, - "refs": {} - }, - "DeleteModelExplainabilityJobDefinitionRequest": { - "base": null, - "refs": {} - }, - "DeleteModelInput": { - "base": null, - "refs": {} - }, - "DeleteModelPackageGroupInput": { - "base": null, - "refs": {} - }, - "DeleteModelPackageGroupPolicyInput": { - "base": null, - "refs": {} - }, - "DeleteModelPackageInput": { - "base": null, - "refs": {} - }, - "DeleteModelQualityJobDefinitionRequest": { - "base": null, - "refs": {} - }, - "DeleteMonitoringScheduleRequest": { - "base": null, - "refs": {} - }, - "DeleteNotebookInstanceInput": { - "base": null, - "refs": {} - }, - "DeleteNotebookInstanceLifecycleConfigInput": { - "base": null, - "refs": {} - }, - "DeleteOptimizationJobRequest": { - "base": null, - "refs": {} - }, - "DeletePartnerAppRequest": { - "base": null, - "refs": {} - }, - "DeletePartnerAppResponse": { - "base": null, - "refs": {} - }, - "DeletePipelineRequest": { - "base": null, - "refs": {} - }, - "DeletePipelineResponse": { - "base": null, - "refs": {} - }, - "DeleteProcessingJobRequest": { - "base": null, - "refs": {} - }, - "DeleteProjectInput": { - "base": null, - "refs": {} - }, - "DeleteSpaceRequest": { - "base": null, - "refs": {} - }, - "DeleteStudioLifecycleConfigRequest": { - "base": null, - "refs": {} - }, - "DeleteTagsInput": { - "base": null, - "refs": {} - }, - "DeleteTagsOutput": { - "base": null, - "refs": {} - }, - "DeleteTrainingJobRequest": { - "base": null, - "refs": {} - }, - "DeleteTrialComponentRequest": { - "base": null, - "refs": {} - }, - "DeleteTrialComponentResponse": { - "base": null, - "refs": {} - }, - "DeleteTrialRequest": { - "base": null, - "refs": {} - }, - "DeleteTrialResponse": { - "base": null, - "refs": {} - }, - "DeleteUserProfileRequest": { - "base": null, - "refs": {} - }, - "DeleteWorkforceRequest": { - "base": null, - "refs": {} - }, - "DeleteWorkforceResponse": { - "base": null, - "refs": {} - }, - "DeleteWorkteamRequest": { - "base": null, - "refs": {} - }, - "DeleteWorkteamResponse": { - "base": null, - "refs": {} - }, - "DependencyCopyPath": { - "base": null, - "refs": { - "HubContentDependency$DependencyCopyPath": "

The hub content dependency copy path.

" - } - }, - "DependencyOriginPath": { - "base": null, - "refs": { - "HubContentDependency$DependencyOriginPath": "

The hub content dependency origin path.

" - } - }, - "DeployedImage": { - "base": "

Gets the Amazon EC2 Container Registry path of the docker image of the model that is hosted in this ProductionVariant.

If you used the registry/repository[:tag] form to specify the image path of the primary container when you created the model hosted in this ProductionVariant, the path resolves to a path of the form registry/repository[@digest]. A digest is a hash value that identifies a specific version of an image. For information about Amazon ECR paths, see Pulling an Image in the Amazon ECR User Guide.

", - "refs": { - "DeployedImages$member": null, - "InferenceComponentContainerSpecificationSummary$DeployedImage": null - } - }, - "DeployedImages": { - "base": null, - "refs": { - "PendingProductionVariantSummary$DeployedImages": "

An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the inference images deployed on instances of this ProductionVariant.

", - "ProductionVariantSummary$DeployedImages": "

An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the inference images deployed on instances of this ProductionVariant.

" - } - }, - "DeploymentConfig": { - "base": "

The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.

", - "refs": { - "CreateEndpointInput$DeploymentConfig": null, - "DescribeEndpointOutput$LastDeploymentConfig": "

The most recent deployment configuration for the endpoint.

", - "UpdateEndpointInput$DeploymentConfig": "

The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.

" - } - }, - "DeploymentConfiguration": { - "base": "

The configuration to use when updating the AMI versions.

", - "refs": { - "ClusterAutoPatchConfig$DeploymentConfig": "

The deployment configuration for rolling patch updates, including rollback settings and batch sizes. Only applicable when using a rolling patching strategy.

", - "ClusterAutoPatchConfigDetails$DeploymentConfig": "

The deployment configuration for rolling patch updates.

", - "ClusterInstanceGroupDetails$ActiveSoftwareUpdateConfig": null, - "ScheduledUpdateConfig$DeploymentConfig": "

The configuration to use when updating the AMI versions.

", - "UpdateClusterSoftwareRequest$DeploymentConfig": "

The configuration to use when updating the AMI versions.

" - } - }, - "DeploymentRecommendation": { - "base": "

A set of recommended deployment configurations for the model. To get more advanced recommendations, see CreateInferenceRecommendationsJob to create an inference recommendation job.

", - "refs": { - "DescribeModelOutput$DeploymentRecommendation": "

A set of recommended deployment configurations for the model.

", - "Model$DeploymentRecommendation": "

A set of recommended deployment configurations for the model.

" - } - }, - "DeploymentStage": { - "base": "

Contains information about a stage in an edge deployment plan.

", - "refs": { - "DeploymentStages$member": null - } - }, - "DeploymentStageMaxResults": { - "base": null, - "refs": { - "DescribeEdgeDeploymentPlanRequest$MaxResults": "

The maximum number of results to select (50 by default).

" - } - }, - "DeploymentStageStatusSummaries": { - "base": null, - "refs": { - "DescribeEdgeDeploymentPlanResponse$Stages": "

List of stages in the edge deployment plan.

" - } - }, - "DeploymentStageStatusSummary": { - "base": "

Contains information summarizing the deployment stage results.

", - "refs": { - "DeploymentStageStatusSummaries$member": null - } - }, - "DeploymentStages": { - "base": null, - "refs": { - "CreateEdgeDeploymentPlanRequest$Stages": "

List of stages of the edge deployment plan. The number of stages is limited to 10 per deployment.

", - "CreateEdgeDeploymentStageRequest$Stages": "

List of stages to be added to the edge deployment plan.

" - } - }, - "DeregisterDevicesRequest": { - "base": null, - "refs": {} - }, - "DerivedInformation": { - "base": "

Information that SageMaker Neo automatically derived about the model.

", - "refs": { - "DescribeCompilationJobResponse$DerivedInformation": "

Information that SageMaker Neo automatically derived about the model.

" - } - }, - "DescribeAIBenchmarkJobRequest": { - "base": null, - "refs": {} - }, - "DescribeAIBenchmarkJobResponse": { - "base": null, - "refs": {} - }, - "DescribeAIRecommendationJobRequest": { - "base": null, - "refs": {} - }, - "DescribeAIRecommendationJobResponse": { - "base": null, - "refs": {} - }, - "DescribeAIWorkloadConfigRequest": { - "base": null, - "refs": {} - }, - "DescribeAIWorkloadConfigResponse": { - "base": null, - "refs": {} - }, - "DescribeActionRequest": { - "base": null, - "refs": {} - }, - "DescribeActionResponse": { - "base": null, - "refs": {} - }, - "DescribeAlgorithmInput": { - "base": null, - "refs": {} - }, - "DescribeAlgorithmOutput": { - "base": null, - "refs": {} - }, - "DescribeAppImageConfigRequest": { - "base": null, - "refs": {} - }, - "DescribeAppImageConfigResponse": { - "base": null, - "refs": {} - }, - "DescribeAppRequest": { - "base": null, - "refs": {} - }, - "DescribeAppResponse": { - "base": null, - "refs": {} - }, - "DescribeArtifactRequest": { - "base": null, - "refs": {} - }, - "DescribeArtifactResponse": { - "base": null, - "refs": {} - }, - "DescribeAutoMLJobRequest": { - "base": null, - "refs": {} - }, - "DescribeAutoMLJobResponse": { - "base": null, - "refs": {} - }, - "DescribeAutoMLJobV2Request": { - "base": null, - "refs": {} - }, - "DescribeAutoMLJobV2Response": { - "base": null, - "refs": {} - }, - "DescribeClusterEventRequest": { - "base": null, - "refs": {} - }, - "DescribeClusterEventResponse": { - "base": null, - "refs": {} - }, - "DescribeClusterNodeRequest": { - "base": null, - "refs": {} - }, - "DescribeClusterNodeResponse": { - "base": null, - "refs": {} - }, - "DescribeClusterRequest": { - "base": null, - "refs": {} - }, - "DescribeClusterResponse": { - "base": null, - "refs": {} - }, - "DescribeClusterSchedulerConfigRequest": { - "base": null, - "refs": {} - }, - "DescribeClusterSchedulerConfigResponse": { - "base": null, - "refs": {} - }, - "DescribeCodeRepositoryInput": { - "base": null, - "refs": {} - }, - "DescribeCodeRepositoryOutput": { - "base": null, - "refs": {} - }, - "DescribeCompilationJobRequest": { - "base": null, - "refs": {} - }, - "DescribeCompilationJobResponse": { - "base": null, - "refs": {} - }, - "DescribeComputeQuotaRequest": { - "base": null, - "refs": {} - }, - "DescribeComputeQuotaResponse": { - "base": null, - "refs": {} - }, - "DescribeContextRequest": { - "base": null, - "refs": {} - }, - "DescribeContextResponse": { - "base": null, - "refs": {} - }, - "DescribeDataQualityJobDefinitionRequest": { - "base": null, - "refs": {} - }, - "DescribeDataQualityJobDefinitionResponse": { - "base": null, - "refs": {} - }, - "DescribeDeviceFleetRequest": { - "base": null, - "refs": {} - }, - "DescribeDeviceFleetResponse": { - "base": null, - "refs": {} - }, - "DescribeDeviceRequest": { - "base": null, - "refs": {} - }, - "DescribeDeviceResponse": { - "base": null, - "refs": {} - }, - "DescribeDomainRequest": { - "base": null, - "refs": {} - }, - "DescribeDomainResponse": { - "base": null, - "refs": {} - }, - "DescribeEdgeDeploymentPlanRequest": { - "base": null, - "refs": {} - }, - "DescribeEdgeDeploymentPlanResponse": { - "base": null, - "refs": {} - }, - "DescribeEdgePackagingJobRequest": { - "base": null, - "refs": {} - }, - "DescribeEdgePackagingJobResponse": { - "base": null, - "refs": {} - }, - "DescribeEndpointConfigInput": { - "base": null, - "refs": {} - }, - "DescribeEndpointConfigOutput": { - "base": null, - "refs": {} - }, - "DescribeEndpointInput": { - "base": null, - "refs": {} - }, - "DescribeEndpointOutput": { - "base": null, - "refs": {} - }, - "DescribeExperimentRequest": { - "base": null, - "refs": {} - }, - "DescribeExperimentResponse": { - "base": null, - "refs": {} - }, - "DescribeFeatureGroupRequest": { - "base": null, - "refs": {} - }, - "DescribeFeatureGroupResponse": { - "base": null, - "refs": {} - }, - "DescribeFeatureMetadataRequest": { - "base": null, - "refs": {} - }, - "DescribeFeatureMetadataResponse": { - "base": null, - "refs": {} - }, - "DescribeFlowDefinitionRequest": { - "base": null, - "refs": {} - }, - "DescribeFlowDefinitionResponse": { - "base": null, - "refs": {} - }, - "DescribeHubContentRequest": { - "base": null, - "refs": {} - }, - "DescribeHubContentResponse": { - "base": null, - "refs": {} - }, - "DescribeHubRequest": { - "base": null, - "refs": {} - }, - "DescribeHubResponse": { - "base": null, - "refs": {} - }, - "DescribeHumanTaskUiRequest": { - "base": null, - "refs": {} - }, - "DescribeHumanTaskUiResponse": { - "base": null, - "refs": {} - }, - "DescribeHyperParameterTuningJobRequest": { - "base": null, - "refs": {} - }, - "DescribeHyperParameterTuningJobResponse": { - "base": null, - "refs": {} - }, - "DescribeImageRequest": { - "base": null, - "refs": {} - }, - "DescribeImageResponse": { - "base": null, - "refs": {} - }, - "DescribeImageVersionRequest": { - "base": null, - "refs": {} - }, - "DescribeImageVersionResponse": { - "base": null, - "refs": {} - }, - "DescribeInferenceComponentInput": { - "base": null, - "refs": {} - }, - "DescribeInferenceComponentOutput": { - "base": null, - "refs": {} - }, - "DescribeInferenceExperimentRequest": { - "base": null, - "refs": {} - }, - "DescribeInferenceExperimentResponse": { - "base": null, - "refs": {} - }, - "DescribeInferenceRecommendationsJobRequest": { - "base": null, - "refs": {} - }, - "DescribeInferenceRecommendationsJobResponse": { - "base": null, - "refs": {} - }, - "DescribeJobRequest": { - "base": null, - "refs": {} - }, - "DescribeJobResponse": { - "base": null, - "refs": {} - }, - "DescribeJobSchemaVersionRequest": { - "base": null, - "refs": {} - }, - "DescribeJobSchemaVersionResponse": { - "base": null, - "refs": {} - }, - "DescribeLabelingJobRequest": { - "base": null, - "refs": {} - }, - "DescribeLabelingJobResponse": { - "base": null, - "refs": {} - }, - "DescribeLineageGroupRequest": { - "base": null, - "refs": {} - }, - "DescribeLineageGroupResponse": { - "base": null, - "refs": {} - }, - "DescribeMlflowAppRequest": { - "base": null, - "refs": {} - }, - "DescribeMlflowAppResponse": { - "base": null, - "refs": {} - }, - "DescribeMlflowTrackingServerRequest": { - "base": null, - "refs": {} - }, - "DescribeMlflowTrackingServerResponse": { - "base": null, - "refs": {} - }, - "DescribeModelBiasJobDefinitionRequest": { - "base": null, - "refs": {} - }, - "DescribeModelBiasJobDefinitionResponse": { - "base": null, - "refs": {} - }, - "DescribeModelCardExportJobRequest": { - "base": null, - "refs": {} - }, - "DescribeModelCardExportJobResponse": { - "base": null, - "refs": {} - }, - "DescribeModelCardRequest": { - "base": null, - "refs": {} - }, - "DescribeModelCardResponse": { - "base": null, - "refs": {} - }, - "DescribeModelExplainabilityJobDefinitionRequest": { - "base": null, - "refs": {} - }, - "DescribeModelExplainabilityJobDefinitionResponse": { - "base": null, - "refs": {} - }, - "DescribeModelInput": { - "base": null, - "refs": {} - }, - "DescribeModelOutput": { - "base": null, - "refs": {} - }, - "DescribeModelPackageGroupInput": { - "base": null, - "refs": {} - }, - "DescribeModelPackageGroupOutput": { - "base": null, - "refs": {} - }, - "DescribeModelPackageInput": { - "base": null, - "refs": {} - }, - "DescribeModelPackageOutput": { - "base": null, - "refs": {} - }, - "DescribeModelQualityJobDefinitionRequest": { - "base": null, - "refs": {} - }, - "DescribeModelQualityJobDefinitionResponse": { - "base": null, - "refs": {} - }, - "DescribeMonitoringScheduleRequest": { - "base": null, - "refs": {} - }, - "DescribeMonitoringScheduleResponse": { - "base": null, - "refs": {} - }, - "DescribeNotebookInstanceInput": { - "base": null, - "refs": {} - }, - "DescribeNotebookInstanceLifecycleConfigInput": { - "base": null, - "refs": {} - }, - "DescribeNotebookInstanceLifecycleConfigOutput": { - "base": null, - "refs": {} - }, - "DescribeNotebookInstanceOutput": { - "base": null, - "refs": {} - }, - "DescribeOptimizationJobRequest": { - "base": null, - "refs": {} - }, - "DescribeOptimizationJobResponse": { - "base": null, - "refs": {} - }, - "DescribePartnerAppRequest": { - "base": null, - "refs": {} - }, - "DescribePartnerAppResponse": { - "base": null, - "refs": {} - }, - "DescribePipelineDefinitionForExecutionRequest": { - "base": null, - "refs": {} - }, - "DescribePipelineDefinitionForExecutionResponse": { - "base": null, - "refs": {} - }, - "DescribePipelineExecutionRequest": { - "base": null, - "refs": {} - }, - "DescribePipelineExecutionResponse": { - "base": null, - "refs": {} - }, - "DescribePipelineRequest": { - "base": null, - "refs": {} - }, - "DescribePipelineResponse": { - "base": null, - "refs": {} - }, - "DescribeProcessingJobRequest": { - "base": null, - "refs": {} - }, - "DescribeProcessingJobResponse": { - "base": null, - "refs": {} - }, - "DescribeProjectInput": { - "base": null, - "refs": {} - }, - "DescribeProjectOutput": { - "base": null, - "refs": {} - }, - "DescribeReservedCapacityRequest": { - "base": null, - "refs": {} - }, - "DescribeReservedCapacityResponse": { - "base": null, - "refs": {} - }, - "DescribeSpaceRequest": { - "base": null, - "refs": {} - }, - "DescribeSpaceResponse": { - "base": null, - "refs": {} - }, - "DescribeStudioLifecycleConfigRequest": { - "base": null, - "refs": {} - }, - "DescribeStudioLifecycleConfigResponse": { - "base": null, - "refs": {} - }, - "DescribeSubscribedWorkteamRequest": { - "base": null, - "refs": {} - }, - "DescribeSubscribedWorkteamResponse": { - "base": null, - "refs": {} - }, - "DescribeTrainingJobRequest": { - "base": null, - "refs": {} - }, - "DescribeTrainingJobResponse": { - "base": null, - "refs": {} - }, - "DescribeTrainingPlanExtensionHistoryRequest": { - "base": null, - "refs": {} - }, - "DescribeTrainingPlanExtensionHistoryResponse": { - "base": null, - "refs": {} - }, - "DescribeTrainingPlanRequest": { - "base": null, - "refs": {} - }, - "DescribeTrainingPlanResponse": { - "base": null, - "refs": {} - }, - "DescribeTransformJobRequest": { - "base": null, - "refs": {} - }, - "DescribeTransformJobResponse": { - "base": null, - "refs": {} - }, - "DescribeTrialComponentRequest": { - "base": null, - "refs": {} - }, - "DescribeTrialComponentResponse": { - "base": null, - "refs": {} - }, - "DescribeTrialRequest": { - "base": null, - "refs": {} - }, - "DescribeTrialResponse": { - "base": null, - "refs": {} - }, - "DescribeUserProfileRequest": { - "base": null, - "refs": {} - }, - "DescribeUserProfileResponse": { - "base": null, - "refs": {} - }, - "DescribeWorkforceRequest": { - "base": null, - "refs": {} - }, - "DescribeWorkforceResponse": { - "base": null, - "refs": {} - }, - "DescribeWorkteamRequest": { - "base": null, - "refs": {} - }, - "DescribeWorkteamResponse": { - "base": null, - "refs": {} - }, - "Description": { - "base": null, - "refs": { - "CreateFeatureGroupRequest$Description": "

A free-form description of a FeatureGroup.

", - "DescribeFeatureGroupResponse$Description": "

A free form description of the feature group.

", - "FeatureGroup$Description": "

A free form description of a FeatureGroup.

" - } - }, - "DesiredWeightAndCapacity": { - "base": "

Specifies weight and capacity values for a production variant.

", - "refs": { - "DesiredWeightAndCapacityList$member": null - } - }, - "DesiredWeightAndCapacityList": { - "base": null, - "refs": { - "UpdateEndpointWeightsAndCapacitiesInput$DesiredWeightsAndCapacities": "

An object that provides new capacity and weight values for a variant.

" - } - }, - "DestinationS3Uri": { - "base": null, - "refs": { - "AsyncInferenceOutputConfig$S3OutputPath": "

The Amazon S3 location to upload inference responses to.

", - "AsyncInferenceOutputConfig$S3FailurePath": "

The Amazon S3 location to upload failure inference responses to.

", - "BatchTransformInput$DataCapturedDestinationS3Uri": "

The Amazon S3 location being used to capture the data.

", - "DataCaptureConfig$DestinationS3Uri": "

The Amazon S3 location used to capture the data.

", - "DataCaptureConfigSummary$DestinationS3Uri": "

The Amazon S3 location being used to capture the data.

", - "InferenceExperimentDataStorageConfig$Destination": "

The Amazon S3 bucket where the inference request and response data is stored.

", - "ProductionVariantCoreDumpConfig$DestinationS3Uri": "

The Amazon S3 bucket to send the core dump to.

" - } - }, - "DetachClusterNodeVolumeRequest": { - "base": null, - "refs": {} - }, - "DetachClusterNodeVolumeResponse": { - "base": null, - "refs": {} - }, - "DetailedAlgorithmStatus": { - "base": null, - "refs": { - "AlgorithmStatusItem$Status": "

The current status.

" - } - }, - "DetailedModelPackageStatus": { - "base": null, - "refs": { - "ModelPackageStatusItem$Status": "

The current status.

" - } - }, - "Device": { - "base": "

Information of a particular device.

", - "refs": { - "Devices$member": null - } - }, - "DeviceArn": { - "base": null, - "refs": { - "DescribeDeviceResponse$DeviceArn": "

The Amazon Resource Name (ARN) of the device.

", - "DeviceDeploymentSummary$DeviceArn": "

The ARN of the device.

", - "DeviceSummary$DeviceArn": "

Amazon Resource Name (ARN) of the device.

" - } - }, - "DeviceDeploymentStatus": { - "base": null, - "refs": { - "DeviceDeploymentSummary$DeviceDeploymentStatus": "

The deployment status of the device.

" - } - }, - "DeviceDeploymentSummaries": { - "base": null, - "refs": { - "ListStageDevicesResponse$DeviceDeploymentSummaries": "

List of summaries of devices allocated to the stage.

" - } - }, - "DeviceDeploymentSummary": { - "base": "

Contains information summarizing device details and deployment status.

", - "refs": { - "DeviceDeploymentSummaries$member": null - } - }, - "DeviceDescription": { - "base": null, - "refs": { - "DescribeDeviceResponse$Description": "

A description of the device.

", - "Device$Description": "

Description of the device.

", - "DeviceDeploymentSummary$Description": "

The description of the device.

", - "DeviceSummary$Description": "

A description of the device.

" - } - }, - "DeviceFleetArn": { - "base": null, - "refs": { - "DescribeDeviceFleetResponse$DeviceFleetArn": "

The The Amazon Resource Name (ARN) of the fleet.

", - "DeviceFleetSummary$DeviceFleetArn": "

Amazon Resource Name (ARN) of the device fleet.

", - "GetDeviceFleetReportResponse$DeviceFleetArn": "

The Amazon Resource Name (ARN) of the device.

" - } - }, - "DeviceFleetDescription": { - "base": null, - "refs": { - "CreateDeviceFleetRequest$Description": "

A description of the fleet.

", - "DescribeDeviceFleetResponse$Description": "

A description of the fleet.

", - "GetDeviceFleetReportResponse$Description": "

Description of the fleet.

", - "UpdateDeviceFleetRequest$Description": "

Description of the fleet.

" - } - }, - "DeviceFleetSummaries": { - "base": null, - "refs": { - "ListDeviceFleetsResponse$DeviceFleetSummaries": "

Summary of the device fleet.

" - } - }, - "DeviceFleetSummary": { - "base": "

Summary of the device fleet.

", - "refs": { - "DeviceFleetSummaries$member": null - } - }, - "DeviceName": { - "base": null, - "refs": { - "Device$DeviceName": "

The name of the device.

", - "DeviceDeploymentSummary$DeviceName": "

The name of the device.

", - "DeviceNames$member": null, - "DeviceSelectionConfig$DeviceNameContains": "

A filter to select devices with names containing this name.

" - } - }, - "DeviceNames": { - "base": null, - "refs": { - "DeregisterDevicesRequest$DeviceNames": "

The unique IDs of the devices.

", - "DeviceSelectionConfig$DeviceNames": "

List of devices chosen to deploy.

" - } - }, - "DeviceSelectionConfig": { - "base": "

Contains information about the configurations of selected devices.

", - "refs": { - "DeploymentStage$DeviceSelectionConfig": "

Configuration of the devices in the stage.

", - "DeploymentStageStatusSummary$DeviceSelectionConfig": "

Configuration of the devices in the stage.

" - } - }, - "DeviceStats": { - "base": "

Status of devices.

", - "refs": { - "GetDeviceFleetReportResponse$DeviceStats": "

Status of devices.

" - } - }, - "DeviceSubsetType": { - "base": null, - "refs": { - "DeviceSelectionConfig$DeviceSubsetType": "

Type of device subsets to deploy to the current stage.

" - } - }, - "DeviceSummaries": { - "base": null, - "refs": { - "ListDevicesResponse$DeviceSummaries": "

Summary of devices.

" - } - }, - "DeviceSummary": { - "base": "

Summary of the device.

", - "refs": { - "DeviceSummaries$member": null - } - }, - "Devices": { - "base": null, - "refs": { - "RegisterDevicesRequest$Devices": "

A list of devices to register with SageMaker Edge Manager.

", - "UpdateDevicesRequest$Devices": "

List of devices to register with Edge Manager agent.

" - } - }, - "Dimension": { - "base": null, - "refs": { - "VectorConfig$Dimension": "

The number of elements in your vector.

" - } - }, - "DirectDeploySettings": { - "base": "

The model deployment settings for the SageMaker Canvas application.

In order to enable model deployment for Canvas, the SageMaker Domain's or user profile's Amazon Web Services IAM execution role must have the AmazonSageMakerCanvasDirectDeployAccess policy attached. You can also turn on model deployment permissions through the SageMaker Domain's or user profile's settings in the SageMaker console.

", - "refs": { - "CanvasAppSettings$DirectDeploySettings": "

The model deployment settings for the SageMaker Canvas application.

" - } - }, - "DirectInternetAccess": { - "base": null, - "refs": { - "CreateNotebookInstanceInput$DirectInternetAccess": "

Sets whether SageMaker AI provides internet access to the notebook instance. If you set this to Disabled this notebook instance is able to access resources only in your VPC, and is not be able to connect to SageMaker AI training and endpoint services unless you configure a NAT Gateway in your VPC.

For more information, see Notebook Instances Are Internet-Enabled by Default. You can set the value of this parameter to Disabled only if you set a value for the SubnetId parameter.

", - "DescribeNotebookInstanceOutput$DirectInternetAccess": "

Describes whether SageMaker AI provides internet access to the notebook instance. If this value is set to Disabled, the notebook instance does not have internet access, and cannot connect to SageMaker AI training and endpoint services.

For more information, see Notebook Instances Are Internet-Enabled by Default.

" - } - }, - "Direction": { - "base": null, - "refs": { - "QueryLineageRequest$Direction": "

Associations between lineage entities have a direction. This parameter determines the direction from the StartArn(s) that the query traverses.

" - } - }, - "DirectoryPath": { - "base": null, - "refs": { - "CheckpointConfig$LocalPath": "

(Optional) The local directory where checkpoints are written. The default directory is /opt/ml/checkpoints/.

", - "DebugHookConfig$LocalPath": "

Path to local storage location for metrics and tensors. Defaults to /opt/ml/output/tensors/.

", - "DebugRuleConfiguration$LocalPath": "

Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.

", - "FileSystemDataSource$DirectoryPath": "

The full path to the directory to associate with the channel.

", - "ProfilerRuleConfiguration$LocalPath": "

Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.

", - "TensorBoardOutputConfig$LocalPath": "

Path to local storage location for tensorBoard output. Defaults to /opt/ml/output/tensorboard.

" - } - }, - "DisableProfiler": { - "base": null, - "refs": { - "ProfilerConfig$DisableProfiler": "

Configuration to turn off Amazon SageMaker Debugger's system monitoring and profiling functionality. To turn it off, set to True.

", - "ProfilerConfigForUpdate$DisableProfiler": "

To turn off Amazon SageMaker Debugger monitoring and profiling while a training job is in progress, set to True.

" - } - }, - "DisableSagemakerServicecatalogPortfolioInput": { - "base": null, - "refs": {} - }, - "DisableSagemakerServicecatalogPortfolioOutput": { - "base": null, - "refs": {} - }, - "DisassociateAdditionalCodeRepositories": { - "base": null, - "refs": { - "UpdateNotebookInstanceInput$DisassociateAdditionalCodeRepositories": "

A list of names or URLs of the default Git repositories to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.

" - } - }, - "DisassociateDefaultCodeRepository": { - "base": null, - "refs": { - "UpdateNotebookInstanceInput$DisassociateDefaultCodeRepository": "

The name or URL of the default Git repository to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.

" - } - }, - "DisassociateNotebookInstanceAcceleratorTypes": { - "base": null, - "refs": { - "UpdateNotebookInstanceInput$DisassociateAcceleratorTypes": "

This parameter is no longer supported. Elastic Inference (EI) is no longer available.

This parameter was used to specify a list of the EI instance types to remove from this notebook instance.

" - } - }, - "DisassociateNotebookInstanceLifecycleConfig": { - "base": null, - "refs": { - "UpdateNotebookInstanceInput$DisassociateLifecycleConfig": "

Set to true to remove the notebook instance lifecycle configuration currently associated with the notebook instance. This operation is idempotent. If you specify a lifecycle configuration that is not associated with the notebook instance when you call this method, it does not throw an error.

" - } - }, - "DisassociateTrialComponentRequest": { - "base": null, - "refs": {} - }, - "DisassociateTrialComponentResponse": { - "base": null, - "refs": {} - }, - "DockerSettings": { - "base": "

A collection of settings that configure the domain's Docker interaction.

", - "refs": { - "DomainSettings$DockerSettings": "

A collection of settings that configure the domain's Docker interaction.

", - "DomainSettingsForUpdate$DockerSettings": "

A collection of settings that configure the domain's Docker interaction.

" - } - }, - "DocumentSchemaVersion": { - "base": null, - "refs": { - "DescribeHubContentResponse$DocumentSchemaVersion": "

The document schema version for the hub content.

", - "HubContentInfo$DocumentSchemaVersion": "

The version of the hub content document schema.

", - "ImportHubContentRequest$DocumentSchemaVersion": "

The version of the hub content schema to import.

", - "ListHubContentVersionsRequest$MaxSchemaVersion": "

The upper bound of the hub content schema version.

", - "ListHubContentsRequest$MaxSchemaVersion": "

The upper bound of the hub content schema verion.

" - } - }, - "Dollars": { - "base": null, - "refs": { - "USD$Dollars": "

The whole number of dollars in the amount.

" - } - }, - "DomainArn": { - "base": null, - "refs": { - "CreateDomainResponse$DomainArn": "

The Amazon Resource Name (ARN) of the created domain.

", - "DescribeDomainResponse$DomainArn": "

The domain's Amazon Resource Name (ARN).

", - "DomainDetails$DomainArn": "

The domain's Amazon Resource Name (ARN).

", - "UpdateDomainResponse$DomainArn": "

The Amazon Resource Name (ARN) of the domain.

" - } - }, - "DomainDetails": { - "base": "

The domain's details.

", - "refs": { - "DomainList$member": null - } - }, - "DomainId": { - "base": null, - "refs": { - "AppDetails$DomainId": "

The domain ID.

", - "CreateAppRequest$DomainId": "

The domain ID.

", - "CreateDomainResponse$DomainId": "

The ID of the created domain.

", - "CreatePresignedDomainUrlRequest$DomainId": "

The domain ID.

", - "CreateSpaceRequest$DomainId": "

The ID of the associated domain.

", - "CreateUserProfileRequest$DomainId": "

The ID of the associated Domain.

", - "DefaultDomainIdList$member": null, - "DeleteAppRequest$DomainId": "

The domain ID.

", - "DeleteDomainRequest$DomainId": "

The domain ID.

", - "DeleteSpaceRequest$DomainId": "

The ID of the associated domain.

", - "DeleteUserProfileRequest$DomainId": "

The domain ID.

", - "DescribeAppRequest$DomainId": "

The domain ID.

", - "DescribeAppResponse$DomainId": "

The domain ID.

", - "DescribeDomainRequest$DomainId": "

The domain ID.

", - "DescribeDomainResponse$DomainId": "

The domain ID.

", - "DescribeSpaceRequest$DomainId": "

The ID of the associated domain.

", - "DescribeSpaceResponse$DomainId": "

The ID of the associated domain.

", - "DescribeUserProfileRequest$DomainId": "

The domain ID.

", - "DescribeUserProfileResponse$DomainId": "

The ID of the domain that contains the profile.

", - "DomainDetails$DomainId": "

The domain ID.

", - "ListAppsRequest$DomainIdEquals": "

A parameter to search for the domain ID.

", - "ListSpacesRequest$DomainIdEquals": "

A parameter to search for the domain ID.

", - "ListUserProfilesRequest$DomainIdEquals": "

A parameter by which to filter the results.

", - "SpaceDetails$DomainId": "

The ID of the associated domain.

", - "UpdateDomainRequest$DomainId": "

The ID of the domain to be updated.

", - "UpdateSpaceRequest$DomainId": "

The ID of the associated domain.

", - "UpdateUserProfileRequest$DomainId": "

The domain ID.

", - "UserProfileDetails$DomainId": "

The domain ID.

" - } - }, - "DomainList": { - "base": null, - "refs": { - "ListDomainsResponse$Domains": "

The list of domains.

" - } - }, - "DomainName": { - "base": null, - "refs": { - "CreateDomainRequest$DomainName": "

A name for the domain.

", - "DescribeDomainResponse$DomainName": "

The domain name.

", - "DomainDetails$DomainName": "

The domain name.

" - } - }, - "DomainSecurityGroupIds": { - "base": null, - "refs": { - "DomainSettings$SecurityGroupIds": "

The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

", - "DomainSettingsForUpdate$SecurityGroupIds": "

The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

" - } - }, - "DomainSettings": { - "base": "

A collection of settings that apply to the SageMaker Domain. These settings are specified through the CreateDomain API call.

", - "refs": { - "CreateDomainRequest$DomainSettings": "

A collection of Domain settings.

", - "DescribeDomainResponse$DomainSettings": "

A collection of Domain settings.

" - } - }, - "DomainSettingsForUpdate": { - "base": "

A collection of Domain configuration settings to update.

", - "refs": { - "UpdateDomainRequest$DomainSettingsForUpdate": "

A collection of DomainSettings configuration values to update.

" - } - }, - "DomainStatus": { - "base": null, - "refs": { - "DescribeDomainResponse$Status": "

The status.

", - "DomainDetails$Status": "

The status.

" - } - }, - "Double": { - "base": null, - "refs": { - "TargetTrackingScalingPolicyConfiguration$TargetValue": "

The recommended target value to specify for the metric when creating a scaling policy.

" - } - }, - "DoubleParameterValue": { - "base": null, - "refs": { - "TrialComponentParameterValue$NumberValue": "

The numeric value of a numeric hyperparameter. If you specify a value for this parameter, you can't specify the StringValue parameter.

" - } - }, - "DriftCheckBaselines": { - "base": "

Represents the drift check baselines that can be used when the model monitor is set using the model package.

", - "refs": { - "CreateModelPackageInput$DriftCheckBaselines": "

Represents the drift check baselines that can be used when the model monitor is set using the model package. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.

", - "DescribeModelPackageOutput$DriftCheckBaselines": "

Represents the drift check baselines that can be used when the model monitor is set using the model package. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.

", - "ModelPackage$DriftCheckBaselines": "

Represents the drift check baselines that can be used when the model monitor is set using the model package.

" - } - }, - "DriftCheckBias": { - "base": "

Represents the drift check bias baselines that can be used when the model monitor is set using the model package.

", - "refs": { - "DriftCheckBaselines$Bias": "

Represents the drift check bias baselines that can be used when the model monitor is set using the model package.

" - } - }, - "DriftCheckExplainability": { - "base": "

Represents the drift check explainability baselines that can be used when the model monitor is set using the model package.

", - "refs": { - "DriftCheckBaselines$Explainability": "

Represents the drift check explainability baselines that can be used when the model monitor is set using the model package.

" - } - }, - "DriftCheckModelDataQuality": { - "base": "

Represents the drift check data quality baselines that can be used when the model monitor is set using the model package.

", - "refs": { - "DriftCheckBaselines$ModelDataQuality": "

Represents the drift check model data quality baselines that can be used when the model monitor is set using the model package.

" - } - }, - "DriftCheckModelQuality": { - "base": "

Represents the drift check model quality baselines that can be used when the model monitor is set using the model package.

", - "refs": { - "DriftCheckBaselines$ModelQuality": "

Represents the drift check model quality baselines that can be used when the model monitor is set using the model package.

" - } - }, - "DynamicScalingConfiguration": { - "base": "

An object with the recommended values for you to specify when creating an autoscaling policy.

", - "refs": { - "GetScalingConfigurationRecommendationResponse$DynamicScalingConfiguration": "

An object with the recommended values for you to specify when creating an autoscaling policy.

" - } - }, - "EFSFileSystem": { - "base": "

A file system, created by you in Amazon EFS, that you assign to a user profile or space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI Studio.

", - "refs": { - "CustomFileSystem$EFSFileSystem": "

A custom file system in Amazon EFS.

" - } - }, - "EFSFileSystemConfig": { - "base": "

The settings for assigning a custom Amazon EFS file system to a user profile or space for an Amazon SageMaker AI Domain.

", - "refs": { - "CustomFileSystemConfig$EFSFileSystemConfig": "

The settings for a custom Amazon EFS file system.

" - } - }, - "EMRStepMetadata": { - "base": "

The configurations and outcomes of an Amazon EMR step execution.

", - "refs": { - "PipelineExecutionStepMetadata$EMR": "

The configurations and outcomes of an Amazon EMR step execution.

" - } - }, - "EbsStorageSettings": { - "base": "

A collection of EBS storage settings that apply to both private and shared spaces.

", - "refs": { - "SpaceStorageSettings$EbsStorageSettings": "

A collection of EBS storage settings for a space.

" - } - }, - "Ec2CapacityReservation": { - "base": "

The EC2 capacity reservations that are shared to an ML capacity reservation.

", - "refs": { - "Ec2CapacityReservationsList$member": null - } - }, - "Ec2CapacityReservationId": { - "base": null, - "refs": { - "Ec2CapacityReservation$Ec2CapacityReservationId": "

The unique identifier for an EC2 capacity reservation that's part of the ML capacity reservation.

" - } - }, - "Ec2CapacityReservationsList": { - "base": null, - "refs": { - "ProductionVariantCapacityReservationSummary$Ec2CapacityReservations": "

The EC2 capacity reservations that are shared to this ML capacity reservation, if any.

" - } - }, - "Edge": { - "base": "

A directed edge connecting two lineage entities.

", - "refs": { - "Edges$member": null - } - }, - "EdgeDeploymentConfig": { - "base": "

Contains information about the configuration of a deployment.

", - "refs": { - "DeploymentStage$DeploymentConfig": "

Configuration of the deployment details.

", - "DeploymentStageStatusSummary$DeploymentConfig": "

Configuration of the deployment details.

" - } - }, - "EdgeDeploymentModelConfig": { - "base": "

Contains information about the configuration of a model in a deployment.

", - "refs": { - "EdgeDeploymentModelConfigs$member": null - } - }, - "EdgeDeploymentModelConfigs": { - "base": null, - "refs": { - "CreateEdgeDeploymentPlanRequest$ModelConfigs": "

List of models associated with the edge deployment plan.

", - "DescribeEdgeDeploymentPlanResponse$ModelConfigs": "

List of models associated with the edge deployment plan.

" - } - }, - "EdgeDeploymentPlanArn": { - "base": null, - "refs": { - "CreateEdgeDeploymentPlanResponse$EdgeDeploymentPlanArn": "

The ARN of the edge deployment plan.

", - "DescribeEdgeDeploymentPlanResponse$EdgeDeploymentPlanArn": "

The ARN of edge deployment plan.

", - "DeviceDeploymentSummary$EdgeDeploymentPlanArn": "

The ARN of the edge deployment plan.

", - "EdgeDeploymentPlanSummary$EdgeDeploymentPlanArn": "

The ARN of the edge deployment plan.

" - } - }, - "EdgeDeploymentPlanSummaries": { - "base": null, - "refs": { - "ListEdgeDeploymentPlansResponse$EdgeDeploymentPlanSummaries": "

List of summaries of edge deployment plans.

" - } - }, - "EdgeDeploymentPlanSummary": { - "base": "

Contains information summarizing an edge deployment plan.

", - "refs": { - "EdgeDeploymentPlanSummaries$member": null - } - }, - "EdgeDeploymentStatus": { - "base": "

Contains information summarizing the deployment stage results.

", - "refs": { - "DeploymentStageStatusSummary$DeploymentStatus": "

General status of the current state.

" - } - }, - "EdgeModel": { - "base": "

The model on the edge device.

", - "refs": { - "EdgeModels$member": null - } - }, - "EdgeModelStat": { - "base": "

Status of edge devices with this model.

", - "refs": { - "EdgeModelStats$member": null - } - }, - "EdgeModelStats": { - "base": null, - "refs": { - "GetDeviceFleetReportResponse$ModelStats": "

Status of model on device.

" - } - }, - "EdgeModelSummaries": { - "base": null, - "refs": { - "DeviceSummary$Models": "

Models on the device.

" - } - }, - "EdgeModelSummary": { - "base": "

Summary of model on edge device.

", - "refs": { - "EdgeModelSummaries$member": null - } - }, - "EdgeModels": { - "base": null, - "refs": { - "DescribeDeviceResponse$Models": "

Models on the device.

" - } - }, - "EdgeOutputConfig": { - "base": "

The output configuration.

", - "refs": { - "CreateDeviceFleetRequest$OutputConfig": "

The output configuration for storing sample data collected by the fleet.

", - "CreateEdgePackagingJobRequest$OutputConfig": "

Provides information about the output location for the packaged model.

", - "DescribeDeviceFleetResponse$OutputConfig": "

The output configuration for storing sampled data.

", - "DescribeEdgePackagingJobResponse$OutputConfig": "

The output configuration for the edge packaging job.

", - "GetDeviceFleetReportResponse$OutputConfig": "

The output configuration for storing sample data collected by the fleet.

", - "UpdateDeviceFleetRequest$OutputConfig": "

Output configuration for storing sample data collected by the fleet.

" - } - }, - "EdgePackagingJobArn": { - "base": null, - "refs": { - "DescribeEdgePackagingJobResponse$EdgePackagingJobArn": "

The Amazon Resource Name (ARN) of the edge packaging job.

", - "EdgePackagingJobSummary$EdgePackagingJobArn": "

The Amazon Resource Name (ARN) of the edge packaging job.

" - } - }, - "EdgePackagingJobStatus": { - "base": null, - "refs": { - "DescribeEdgePackagingJobResponse$EdgePackagingJobStatus": "

The current status of the packaging job.

", - "EdgePackagingJobSummary$EdgePackagingJobStatus": "

The status of the edge packaging job.

", - "ListEdgePackagingJobsRequest$StatusEquals": "

The job status to filter for.

" - } - }, - "EdgePackagingJobSummaries": { - "base": null, - "refs": { - "ListEdgePackagingJobsResponse$EdgePackagingJobSummaries": "

Summaries of edge packaging jobs.

" - } - }, - "EdgePackagingJobSummary": { - "base": "

Summary of edge packaging job.

", - "refs": { - "EdgePackagingJobSummaries$member": null - } - }, - "EdgePresetDeploymentArtifact": { - "base": null, - "refs": { - "EdgePresetDeploymentOutput$Artifact": "

The Amazon Resource Name (ARN) of the generated deployable resource.

" - } - }, - "EdgePresetDeploymentOutput": { - "base": "

The output of a SageMaker Edge Manager deployable resource.

", - "refs": { - "DescribeEdgePackagingJobResponse$PresetDeploymentOutput": "

The output of a SageMaker Edge Manager deployable resource.

" - } - }, - "EdgePresetDeploymentStatus": { - "base": null, - "refs": { - "EdgePresetDeploymentOutput$Status": "

The status of the deployable resource.

" - } - }, - "EdgePresetDeploymentType": { - "base": null, - "refs": { - "EdgeOutputConfig$PresetDeploymentType": "

The deployment type SageMaker Edge Manager will create. Currently only supports Amazon Web Services IoT Greengrass Version 2 components.

", - "EdgePresetDeploymentOutput$Type": "

The deployment type created by SageMaker Edge Manager. Currently only supports Amazon Web Services IoT Greengrass Version 2 components.

" - } - }, - "EdgeVersion": { - "base": null, - "refs": { - "AgentVersion$Version": "

Version of the agent.

", - "CreateEdgePackagingJobRequest$ModelVersion": "

The version of the model.

", - "DescribeDeviceResponse$AgentVersion": "

Edge Manager agent version.

", - "DescribeEdgePackagingJobResponse$ModelVersion": "

The version of the model.

", - "DeviceSummary$AgentVersion": "

Edge Manager agent version.

", - "EdgeModel$ModelVersion": "

The model version.

", - "EdgeModelStat$ModelVersion": "

The model version.

", - "EdgeModelSummary$ModelVersion": "

The version model.

", - "EdgePackagingJobSummary$ModelVersion": "

The version of the model.

" - } - }, - "Edges": { - "base": null, - "refs": { - "QueryLineageResponse$Edges": "

A list of edges that connect vertices in the response.

" - } - }, - "EfaEnis": { - "base": null, - "refs": { - "AdditionalEnis$EfaEnis": "

A list of Elastic Fabric Adapter (EFA) ENIs associated with the instance.

" - } - }, - "EfsUid": { - "base": null, - "refs": { - "DescribeSpaceResponse$HomeEfsFileSystemUid": "

The ID of the space's profile in the Amazon EFS volume.

", - "DescribeUserProfileResponse$HomeEfsFileSystemUid": "

The ID of the user's profile in the Amazon Elastic File System volume.

" - } - }, - "EksClusterArn": { - "base": null, - "refs": { - "ClusterOrchestratorEksConfig$ClusterArn": "

The Amazon Resource Name (ARN) of the Amazon EKS cluster associated with the SageMaker HyperPod cluster.

" - } - }, - "EksRoleAccessEntries": { - "base": null, - "refs": { - "ClusterMetadata$EksRoleAccessEntries": "

A list of Amazon EKS IAM role ARNs associated with the cluster. This is created by HyperPod on your behalf and only applies for EKS orchestrated clusters.

" - } - }, - "EmrServerlessComputeConfig": { - "base": "

This data type is intended for use exclusively by SageMaker Canvas and cannot be used in other contexts at the moment.

Specifies the compute configuration for the EMR Serverless job.

", - "refs": { - "AutoMLComputeConfig$EmrServerlessComputeConfig": "

The configuration for using EMR Serverless to run the AutoML job V2.

To allow your AutoML job V2 to automatically initiate a remote job on EMR Serverless when additional compute resources are needed to process large datasets, you need to provide an EmrServerlessComputeConfig object, which includes an ExecutionRoleARN attribute, to the AutoMLComputeConfig of the AutoML job V2 input request.

By seamlessly transitioning to EMR Serverless when required, the AutoML job can handle datasets that would otherwise exceed the initially provisioned resources, without any manual intervention from you.

EMR Serverless is available for the tabular and time series problem types. We recommend setting up this option for tabular datasets larger than 5 GB and time series datasets larger than 30 GB.

" - } - }, - "EmrServerlessSettings": { - "base": "

The settings for running Amazon EMR Serverless jobs in SageMaker Canvas.

", - "refs": { - "CanvasAppSettings$EmrServerlessSettings": "

The settings for running Amazon EMR Serverless data processing jobs in SageMaker Canvas.

" - } - }, - "EmrSettings": { - "base": "

The configuration parameters that specify the IAM roles assumed by the execution role of SageMaker (assumable roles) and the cluster instances or job execution environments (execution roles or runtime roles) to manage and access resources required for running Amazon EMR clusters or Amazon EMR Serverless applications.

", - "refs": { - "JupyterLabAppSettings$EmrSettings": "

The configuration parameters that specify the IAM roles assumed by the execution role of SageMaker (assumable roles) and the cluster instances or job execution environments (execution roles or runtime roles) to manage and access resources required for running Amazon EMR clusters or Amazon EMR Serverless applications.

" - } - }, - "EnableCaching": { - "base": null, - "refs": { - "InferenceComponentDataCacheConfig$EnableCaching": "

Sets whether the endpoint that hosts the inference component caches the model artifacts and container image.

With caching enabled, the endpoint caches this data in each instance that it provisions for the inference component. That way, the inference component deploys faster during the auto scaling process. If caching isn't enabled, the inference component takes longer to deploy because of the time it spends downloading the data.

", - "InferenceComponentDataCacheConfigSummary$EnableCaching": "

Indicates whether the inference component caches model artifacts as part of the auto scaling process.

" - } - }, - "EnableCapture": { - "base": null, - "refs": { - "DataCaptureConfig$EnableCapture": "

Whether data capture should be enabled or disabled (defaults to enabled).

", - "DataCaptureConfigSummary$EnableCapture": "

Whether data capture is enabled or disabled.

" - } - }, - "EnableDetailedObservability": { - "base": null, - "refs": { - "MetricsConfig$EnableDetailedObservability": "

Indicates whether detailed observability is enabled for the endpoint. When set to True, the following metrics are published at the configured frequency:

  • Container-level inference metrics scraped from the container's Prometheus endpoint (such as request latency, error counts, and throughput). Available metrics vary by framework.

  • Per-GPU metrics (utilization, memory, and temperature) attributed to individual inference components.

  • Per-instance host metrics (CPU, memory, and disk utilization).

  • Inference component placement metrics (copy count per Availability Zone).

For first-party and Deep Learning Containers (DLC), the Prometheus endpoint path is determined automatically. For Bring-Your-Own-Container (BYOC) cases, you can optionally set ContainerMetricsConfig to specify a custom endpoint path. If not specified, the default path /metrics on port 8080 is used.

When set to False, these additional metrics are not published. Standard invocation and utilization metrics controlled by EnableEnhancedMetrics are unaffected.

The default value for new endpoint configurations is True. For existing endpoint configurations created before this feature, the value is False unless explicitly set.

" - } - }, - "EnableEnhancedMetrics": { - "base": null, - "refs": { - "MetricsConfig$EnableEnhancedMetrics": "

Specifies whether to enable enhanced metrics for the endpoint. Enhanced metrics provide utilization and invocation data at instance and container granularity. Container granularity is supported for Inference Components. The default is False.

" - } - }, - "EnableInfraCheck": { - "base": null, - "refs": { - "InfraCheckConfig$EnableInfraCheck": "

Enables an infrastructure health check.

" - } - }, - "EnableIotRoleAlias": { - "base": null, - "refs": { - "CreateDeviceFleetRequest$EnableIotRoleAlias": "

Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. The name of the role alias generated will match this pattern: \"SageMakerEdge-{DeviceFleetName}\".

For example, if your device fleet is called \"demo-fleet\", the name of the role alias will be \"SageMakerEdge-demo-fleet\".

", - "UpdateDeviceFleetRequest$EnableIotRoleAlias": "

Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. The name of the role alias generated will match this pattern: \"SageMakerEdge-{DeviceFleetName}\".

For example, if your device fleet is called \"demo-fleet\", the name of the role alias will be \"SageMakerEdge-demo-fleet\".

" - } - }, - "EnableRemoteDebug": { - "base": null, - "refs": { - "RemoteDebugConfig$EnableRemoteDebug": "

If set to True, enables remote debugging.

", - "RemoteDebugConfigForUpdate$EnableRemoteDebug": "

If set to True, enables remote debugging.

" - } - }, - "EnableSagemakerServicecatalogPortfolioInput": { - "base": null, - "refs": {} - }, - "EnableSagemakerServicecatalogPortfolioOutput": { - "base": null, - "refs": {} - }, - "EnableSessionTagChaining": { - "base": null, - "refs": { - "SessionChainingConfig$EnableSessionTagChaining": "

Set to True to allow SageMaker to extract session tags from a training job creation role and reuse these tags when assuming the training job execution role.

" - } - }, - "EnabledOrDisabled": { - "base": null, - "refs": { - "IamPolicyConstraints$SourceIp": "

When SourceIp is Enabled the worker's IP address when a task is rendered in the worker portal is added to the IAM policy as a Condition used to generate the Amazon S3 presigned URL. This IP address is checked by Amazon S3 and must match in order for the Amazon S3 resource to be rendered in the worker portal.

", - "IamPolicyConstraints$VpcSourceIp": "

When VpcSourceIp is Enabled the worker's IP address when a task is rendered in private worker portal inside the VPC is added to the IAM policy as a Condition used to generate the Amazon S3 presigned URL. To render the task successfully Amazon S3 checks that the presigned URL is being accessed over an Amazon S3 VPC Endpoint, and that the worker's IP address matches the IP address in the IAM policy. To learn more about configuring private worker portal, see Use Amazon VPC mode from a private worker portal.

" - } - }, - "Endpoint": { - "base": "

A hosted endpoint for real-time inference.

", - "refs": { - "SearchRecord$Endpoint": null - } - }, - "EndpointArn": { - "base": null, - "refs": { - "CreateEndpointOutput$EndpointArn": "

The Amazon Resource Name (ARN) of the endpoint.

", - "DescribeEndpointOutput$EndpointArn": "

The Amazon Resource Name (ARN) of the endpoint.

", - "DescribeInferenceComponentOutput$EndpointArn": "

The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.

", - "Endpoint$EndpointArn": "

The Amazon Resource Name (ARN) of the endpoint.

", - "EndpointStepMetadata$Arn": "

The Amazon Resource Name (ARN) of the endpoint in the step.

", - "EndpointSummary$EndpointArn": "

The Amazon Resource Name (ARN) of the endpoint.

", - "InferenceComponentSummary$EndpointArn": "

The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.

", - "ModelDashboardEndpoint$EndpointArn": "

The Amazon Resource Name (ARN) of the endpoint.

", - "UpdateEndpointOutput$EndpointArn": "

The Amazon Resource Name (ARN) of the endpoint.

", - "UpdateEndpointWeightsAndCapacitiesOutput$EndpointArn": "

The Amazon Resource Name (ARN) of the updated endpoint.

" - } - }, - "EndpointConfigArn": { - "base": null, - "refs": { - "CreateEndpointConfigOutput$EndpointConfigArn": "

The Amazon Resource Name (ARN) of the endpoint configuration.

", - "DescribeEndpointConfigOutput$EndpointConfigArn": "

The Amazon Resource Name (ARN) of the endpoint configuration.

", - "EndpointConfigStepMetadata$Arn": "

The Amazon Resource Name (ARN) of the endpoint configuration used in the step.

", - "EndpointConfigSummary$EndpointConfigArn": "

The Amazon Resource Name (ARN) of the endpoint configuration.

" - } - }, - "EndpointConfigName": { - "base": null, - "refs": { - "CreateEndpointConfigInput$EndpointConfigName": "

The name of the endpoint configuration. You specify this name in a CreateEndpoint request.

", - "CreateEndpointInput$EndpointConfigName": "

The name of an endpoint configuration. For more information, see CreateEndpointConfig.

", - "DeleteEndpointConfigInput$EndpointConfigName": "

The name of the endpoint configuration that you want to delete.

", - "DescribeEndpointConfigInput$EndpointConfigName": "

The name of the endpoint configuration.

", - "DescribeEndpointConfigOutput$EndpointConfigName": "

Name of the SageMaker endpoint configuration.

", - "DescribeEndpointOutput$EndpointConfigName": "

The name of the endpoint configuration associated with this endpoint.

", - "Endpoint$EndpointConfigName": "

The endpoint configuration associated with the endpoint.

", - "EndpointConfigSummary$EndpointConfigName": "

The name of the endpoint configuration.

", - "EndpointMetadata$EndpointConfigName": "

The name of the endpoint configuration.

", - "PendingDeploymentSummary$EndpointConfigName": "

The name of the endpoint configuration used in the deployment.

", - "UpdateEndpointInput$EndpointConfigName": "

The name of the new endpoint configuration.

" - } - }, - "EndpointConfigNameContains": { - "base": null, - "refs": { - "ListEndpointConfigsInput$NameContains": "

A string in the endpoint configuration name. This filter returns only endpoint configurations whose name contains the specified string.

" - } - }, - "EndpointConfigSortKey": { - "base": null, - "refs": { - "ListEndpointConfigsInput$SortBy": "

The field to sort results by. The default is CreationTime.

" - } - }, - "EndpointConfigStepMetadata": { - "base": "

Metadata for an endpoint configuration step.

", - "refs": { - "PipelineExecutionStepMetadata$EndpointConfig": "

The endpoint configuration used to create an endpoint during this step execution.

" - } - }, - "EndpointConfigSummary": { - "base": "

Provides summary information for an endpoint configuration.

", - "refs": { - "EndpointConfigSummaryList$member": null - } - }, - "EndpointConfigSummaryList": { - "base": null, - "refs": { - "ListEndpointConfigsOutput$EndpointConfigs": "

An array of endpoint configurations.

" - } - }, - "EndpointInfo": { - "base": "

Details about a customer endpoint that was compared in an Inference Recommender job.

", - "refs": { - "EndpointPerformance$EndpointInfo": null, - "Endpoints$member": null - } - }, - "EndpointInput": { - "base": "

Input object for the endpoint

", - "refs": { - "DataQualityJobInput$EndpointInput": null, - "ModelBiasJobInput$EndpointInput": null, - "ModelExplainabilityJobInput$EndpointInput": null, - "ModelQualityJobInput$EndpointInput": null, - "MonitoringInput$EndpointInput": "

The endpoint for a monitoring job.

" - } - }, - "EndpointInputConfiguration": { - "base": "

The endpoint configuration for the load test.

", - "refs": { - "EndpointInputConfigurations$member": null - } - }, - "EndpointInputConfigurations": { - "base": null, - "refs": { - "RecommendationJobInputConfig$EndpointConfigurations": "

Specifies the endpoint configuration to use for a job.

" - } - }, - "EndpointMetadata": { - "base": "

The metadata of the endpoint.

", - "refs": { - "DescribeInferenceExperimentResponse$EndpointMetadata": "

The metadata of the endpoint on which the inference experiment ran.

" - } - }, - "EndpointName": { - "base": null, - "refs": { - "CreateEndpointInput$EndpointName": "

The name of the endpoint.The name must be unique within an Amazon Web Services Region in your Amazon Web Services account. The name is case-insensitive in CreateEndpoint, but the case is preserved and must be matched in InvokeEndpoint.

", - "CreateInferenceComponentInput$EndpointName": "

The name of an existing endpoint where you host the inference component.

", - "CreateInferenceExperimentRequest$EndpointName": "

The name of the Amazon SageMaker endpoint on which you want to run the inference experiment.

", - "DeleteEndpointInput$EndpointName": "

The name of the endpoint that you want to delete.

", - "DescribeEndpointInput$EndpointName": "

The name of the endpoint.

", - "DescribeEndpointOutput$EndpointName": "

Name of the endpoint.

", - "DescribeInferenceComponentOutput$EndpointName": "

The name of the endpoint that hosts the inference component.

", - "DescribeMonitoringScheduleResponse$EndpointName": "

The name of the endpoint for the monitoring job.

", - "Endpoint$EndpointName": "

The name of the endpoint.

", - "EndpointInfo$EndpointName": "

The name of a customer's endpoint.

", - "EndpointInput$EndpointName": "

An endpoint in customer's account which has enabled DataCaptureConfig enabled.

", - "EndpointMetadata$EndpointName": "

The name of the endpoint.

", - "EndpointSummary$EndpointName": "

The name of the endpoint.

", - "GetScalingConfigurationRecommendationRequest$EndpointName": "

The name of an endpoint benchmarked during a previously completed inference recommendation job. This name should come from one of the recommendations returned by the job specified in the InferenceRecommendationsJobName field.

Specify either this field or the RecommendationId field.

", - "GetScalingConfigurationRecommendationResponse$EndpointName": "

The name of an endpoint benchmarked during a previously completed Inference Recommender job.

", - "InferenceComponentSummary$EndpointName": "

The name of the endpoint that hosts the inference component.

", - "ListDataQualityJobDefinitionsRequest$EndpointName": "

A filter that lists the data quality job definitions associated with the specified endpoint.

", - "ListInferenceComponentsInput$EndpointNameEquals": "

An endpoint name to filter the listed inference components. The response includes only those inference components that are hosted at the specified endpoint.

", - "ListModelBiasJobDefinitionsRequest$EndpointName": "

Name of the endpoint to monitor for model bias.

", - "ListModelExplainabilityJobDefinitionsRequest$EndpointName": "

Name of the endpoint to monitor for model explainability.

", - "ListModelQualityJobDefinitionsRequest$EndpointName": "

A filter that returns only model quality monitoring job definitions that are associated with the specified endpoint.

", - "ListMonitoringExecutionsRequest$EndpointName": "

Name of a specific endpoint to fetch jobs for.

", - "ListMonitoringSchedulesRequest$EndpointName": "

Name of a specific endpoint to fetch schedules for.

", - "ModelDashboardEndpoint$EndpointName": "

The endpoint name.

", - "ModelDashboardMonitoringSchedule$EndpointName": "

The endpoint which is monitored.

", - "ModelDeployConfig$EndpointName": "

Specifies the endpoint name to use for a one-click Autopilot model deployment if the endpoint name is not generated automatically.

Specify the EndpointName if and only if you set AutoGenerateEndpointName to False; otherwise a 400 error is thrown.

", - "ModelDeployResult$EndpointName": "

The name of the endpoint to which the model has been deployed.

If model deployment fails, this field is omitted from the response.

", - "MonitoringExecutionSummary$EndpointName": "

The name of the endpoint used to run the monitoring job.

", - "MonitoringJobDefinitionSummary$EndpointName": "

The name of the endpoint that the job monitors.

", - "MonitoringSchedule$EndpointName": "

The endpoint that hosts the model being monitored.

", - "MonitoringScheduleSummary$EndpointName": "

The name of the endpoint using the monitoring schedule.

", - "UpdateEndpointInput$EndpointName": "

The name of the endpoint whose configuration you want to update.

", - "UpdateEndpointWeightsAndCapacitiesInput$EndpointName": "

The name of an existing SageMaker endpoint.

" - } - }, - "EndpointNameContains": { - "base": null, - "refs": { - "ListEndpointsInput$NameContains": "

A string in endpoint names. This filter returns only endpoints whose name contains the specified string.

" - } - }, - "EndpointOutputConfiguration": { - "base": "

The endpoint configuration made by Inference Recommender during a recommendation job.

", - "refs": { - "InferenceRecommendation$EndpointConfiguration": "

Defines the endpoint configuration parameters.

", - "RecommendationJobInferenceBenchmark$EndpointConfiguration": null - } - }, - "EndpointPerformance": { - "base": "

The performance results from running an Inference Recommender job on an existing endpoint.

", - "refs": { - "EndpointPerformances$member": null - } - }, - "EndpointPerformances": { - "base": null, - "refs": { - "DescribeInferenceRecommendationsJobResponse$EndpointPerformances": "

The performance results from running an Inference Recommender job on an existing endpoint.

" - } - }, - "EndpointSortKey": { - "base": null, - "refs": { - "ListEndpointsInput$SortBy": "

Sorts the list of results. The default is CreationTime.

" - } - }, - "EndpointStatus": { - "base": null, - "refs": { - "DescribeEndpointOutput$EndpointStatus": "

The status of the endpoint.

  • OutOfService: Endpoint is not available to take incoming requests.

  • Creating: CreateEndpoint is executing.

  • Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

  • SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count.

  • RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an InService status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly.

  • InService: Endpoint is available to process incoming requests.

  • Deleting: DeleteEndpoint is executing.

  • Failed: Endpoint could not be created, updated, or re-scaled. Use the FailureReason value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.

  • UpdateRollbackFailed: Both the rolling deployment and auto-rollback failed. Your endpoint is in service with a mix of the old and new endpoint configurations. For information about how to remedy this issue and restore the endpoint's status to InService, see Rolling Deployments.

", - "Endpoint$EndpointStatus": "

The status of the endpoint.

", - "EndpointMetadata$EndpointStatus": "

The status of the endpoint. For possible values of the status of an endpoint, see EndpointSummary.

", - "EndpointSummary$EndpointStatus": "

The status of the endpoint.

  • OutOfService: Endpoint is not available to take incoming requests.

  • Creating: CreateEndpoint is executing.

  • Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

  • SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count.

  • RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an InService status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly.

  • InService: Endpoint is available to process incoming requests.

  • Deleting: DeleteEndpoint is executing.

  • Failed: Endpoint could not be created, updated, or re-scaled. Use DescribeEndpointOutput$FailureReason for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.

To get a list of endpoints with a specified status, use the StatusEquals filter with a call to ListEndpoints.

", - "ListEndpointsInput$StatusEquals": "

A filter that returns only endpoints with the specified status.

", - "ModelDashboardEndpoint$EndpointStatus": "

The endpoint status.

" - } - }, - "EndpointStepMetadata": { - "base": "

Metadata for an endpoint step.

", - "refs": { - "PipelineExecutionStepMetadata$Endpoint": "

The endpoint that was invoked during this step execution.

" - } - }, - "EndpointSummary": { - "base": "

Provides summary information for an endpoint.

", - "refs": { - "EndpointSummaryList$member": null - } - }, - "EndpointSummaryList": { - "base": null, - "refs": { - "ListEndpointsOutput$Endpoints": "

An array or endpoint objects.

" - } - }, - "Endpoints": { - "base": null, - "refs": { - "RecommendationJobInputConfig$Endpoints": "

Existing customer endpoints on which to run an Inference Recommender job.

" - } - }, - "EntityDescription": { - "base": null, - "refs": { - "AdditionalInferenceSpecificationDefinition$Description": "

A description of the additional Inference specification

", - "AlgorithmSummary$AlgorithmDescription": "

A brief description of the algorithm.

", - "BatchDescribeModelPackageSummary$ModelPackageDescription": "

The description of the model package.

", - "ChannelSpecification$Description": "

A brief description of the channel.

", - "CreateAlgorithmInput$AlgorithmDescription": "

A description of the algorithm.

", - "CreateClusterSchedulerConfigRequest$Description": "

Description of the cluster policy.

", - "CreateComputeQuotaRequest$Description": "

Description of the compute allocation definition.

", - "CreateModelPackageGroupInput$ModelPackageGroupDescription": "

A description for the model group.

", - "CreateModelPackageInput$ModelPackageDescription": "

A description of the model package.

", - "CreateProjectInput$ProjectDescription": "

A description for the project.

", - "DescribeAlgorithmOutput$AlgorithmDescription": "

A brief summary about the algorithm.

", - "DescribeClusterSchedulerConfigResponse$Description": "

Description of the cluster policy.

", - "DescribeComputeQuotaResponse$Description": "

Description of the compute allocation definition.

", - "DescribeModelPackageGroupOutput$ModelPackageGroupDescription": "

A description of the model group.

", - "DescribeModelPackageOutput$ModelPackageDescription": "

A brief summary of the model package.

", - "DescribeProjectOutput$ProjectDescription": "

The description of the project.

", - "HyperParameterSpecification$Description": "

A brief description of the hyperparameter.

", - "ModelPackage$ModelPackageDescription": "

The description of the model package.

", - "ModelPackageGroup$ModelPackageGroupDescription": "

The description for the model group.

", - "ModelPackageGroupSummary$ModelPackageGroupDescription": "

A description of the model group.

", - "ModelPackageSummary$ModelPackageDescription": "

A brief description of the model package.

", - "Project$ProjectDescription": "

The description of the project.

", - "ProjectSummary$ProjectDescription": "

The description of the project.

", - "UpdateClusterSchedulerConfigRequest$Description": "

Description of the cluster policy.

", - "UpdateComputeQuotaRequest$Description": "

Description of the compute allocation definition.

", - "UpdateProjectInput$ProjectDescription": "

The description for the project.

" - } - }, - "EntityName": { - "base": null, - "refs": { - "AdditionalInferenceSpecificationDefinition$Name": "

A unique name to identify the additional inference specification. The name must be unique within the list of your additional inference specifications for a particular model package.

", - "AlgorithmStatusItem$Name": "

The name of the algorithm for which the overall status is being reported.

", - "AlgorithmSummary$AlgorithmName": "

The name of the algorithm that is described by the summary.

", - "AlgorithmValidationProfile$ProfileName": "

The name of the profile for the algorithm. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

", - "BatchDescribeModelPackageSummary$ModelPackageGroupName": "

The group name for the model package

", - "ClusterSchedulerConfigSummary$Name": "

Name of the cluster policy.

", - "CodeRepositorySummary$CodeRepositoryName": "

The name of the Git repository.

", - "CompilationJobSummary$CompilationJobName": "

The name of the model compilation job that you want a summary for.

", - "ComputeQuotaSummary$Name": "

Name of the compute allocation definition.

", - "CreateAlgorithmInput$AlgorithmName": "

The name of the algorithm.

", - "CreateClusterSchedulerConfigRequest$Name": "

Name for the cluster policy.

", - "CreateCodeRepositoryInput$CodeRepositoryName": "

The name of the Git repository. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

", - "CreateCompilationJobRequest$CompilationJobName": "

A name for the model compilation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account.

", - "CreateComputeQuotaRequest$Name": "

Name to the compute allocation definition.

", - "CreateDeviceFleetRequest$DeviceFleetName": "

The name of the fleet that the device belongs to.

", - "CreateEdgeDeploymentPlanRequest$EdgeDeploymentPlanName": "

The name of the edge deployment plan.

", - "CreateEdgeDeploymentPlanRequest$DeviceFleetName": "

The device fleet used for this edge deployment plan.

", - "CreateEdgeDeploymentStageRequest$EdgeDeploymentPlanName": "

The name of the edge deployment plan.

", - "CreateEdgePackagingJobRequest$EdgePackagingJobName": "

The name of the edge packaging job.

", - "CreateEdgePackagingJobRequest$CompilationJobName": "

The name of the SageMaker Neo compilation job that will be used to locate model artifacts for packaging.

", - "CreateEdgePackagingJobRequest$ModelName": "

The name of the model.

", - "CreateModelCardExportJobRequest$ModelCardExportJobName": "

The name of the model card export job.

", - "CreateModelCardRequest$ModelCardName": "

The unique name of the model card.

", - "CreateModelPackageGroupInput$ModelPackageGroupName": "

The name of the model group.

", - "CreateModelPackageInput$ModelPackageName": "

The name of the model package. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

This parameter is required for unversioned models. It is not applicable to versioned models.

", - "CreateOptimizationJobRequest$OptimizationJobName": "

A custom name for the new optimization job.

", - "DeleteAlgorithmInput$AlgorithmName": "

The name of the algorithm to delete.

", - "DeleteCodeRepositoryInput$CodeRepositoryName": "

The name of the Git repository to delete.

", - "DeleteCompilationJobRequest$CompilationJobName": "

The name of the compilation job to delete.

", - "DeleteDeviceFleetRequest$DeviceFleetName": "

The name of the fleet to delete.

", - "DeleteEdgeDeploymentPlanRequest$EdgeDeploymentPlanName": "

The name of the edge deployment plan to delete.

", - "DeleteEdgeDeploymentStageRequest$EdgeDeploymentPlanName": "

The name of the edge deployment plan from which the stage will be deleted.

", - "DeleteEdgeDeploymentStageRequest$StageName": "

The name of the stage.

", - "DeleteModelCardRequest$ModelCardName": "

The name of the model card to delete.

", - "DeleteModelPackageGroupPolicyInput$ModelPackageGroupName": "

The name of the model group for which to delete the policy.

", - "DeleteOptimizationJobRequest$OptimizationJobName": "

The name that you assigned to the optimization job.

", - "DeploymentStage$StageName": "

The name of the stage.

", - "DeploymentStageStatusSummary$StageName": "

The name of the stage.

", - "DeregisterDevicesRequest$DeviceFleetName": "

The name of the fleet the devices belong to.

", - "DescribeAlgorithmOutput$AlgorithmName": "

The name of the algorithm being described.

", - "DescribeClusterSchedulerConfigResponse$Name": "

Name of the cluster policy.

", - "DescribeCodeRepositoryInput$CodeRepositoryName": "

The name of the Git repository to describe.

", - "DescribeCodeRepositoryOutput$CodeRepositoryName": "

The name of the Git repository.

", - "DescribeCompilationJobRequest$CompilationJobName": "

The name of the model compilation job that you want information about.

", - "DescribeCompilationJobResponse$CompilationJobName": "

The name of the model compilation job.

", - "DescribeComputeQuotaResponse$Name": "

Name of the compute allocation definition.

", - "DescribeDeviceFleetRequest$DeviceFleetName": "

The name of the fleet.

", - "DescribeDeviceFleetResponse$DeviceFleetName": "

The name of the fleet.

", - "DescribeDeviceRequest$DeviceName": "

The unique ID of the device.

", - "DescribeDeviceRequest$DeviceFleetName": "

The name of the fleet the devices belong to.

", - "DescribeDeviceResponse$DeviceName": "

The unique identifier of the device.

", - "DescribeDeviceResponse$DeviceFleetName": "

The name of the fleet the device belongs to.

", - "DescribeEdgeDeploymentPlanRequest$EdgeDeploymentPlanName": "

The name of the deployment plan to describe.

", - "DescribeEdgeDeploymentPlanResponse$EdgeDeploymentPlanName": "

The name of the edge deployment plan.

", - "DescribeEdgeDeploymentPlanResponse$DeviceFleetName": "

The device fleet used for this edge deployment plan.

", - "DescribeEdgePackagingJobRequest$EdgePackagingJobName": "

The name of the edge packaging job.

", - "DescribeEdgePackagingJobResponse$EdgePackagingJobName": "

The name of the edge packaging job.

", - "DescribeEdgePackagingJobResponse$CompilationJobName": "

The name of the SageMaker Neo compilation job that is used to locate model artifacts that are being packaged.

", - "DescribeEdgePackagingJobResponse$ModelName": "

The name of the model.

", - "DescribeModelCardExportJobResponse$ModelCardExportJobName": "

The name of the model card export job to describe.

", - "DescribeModelCardExportJobResponse$ModelCardName": "

The name or Amazon Resource Name (ARN) of the model card that the model export job exports.

", - "DescribeModelCardResponse$ModelCardName": "

The name of the model card.

", - "DescribeModelPackageGroupOutput$ModelPackageGroupName": "

The name of the model group.

", - "DescribeModelPackageOutput$ModelPackageName": "

The name of the model package being described.

", - "DescribeModelPackageOutput$ModelPackageGroupName": "

If the model is a versioned model, the name of the model group that the versioned model belongs to.

", - "DescribeOptimizationJobRequest$OptimizationJobName": "

The name that you assigned to the optimization job.

", - "DescribeOptimizationJobResponse$OptimizationJobName": "

The name that you assigned to the optimization job.

", - "DeviceDeploymentSummary$EdgeDeploymentPlanName": "

The name of the edge deployment plan.

", - "DeviceDeploymentSummary$StageName": "

The name of the stage in the edge deployment plan.

", - "DeviceDeploymentSummary$DeployedStageName": "

The name of the deployed stage.

", - "DeviceDeploymentSummary$DeviceFleetName": "

The name of the fleet to which the device belongs to.

", - "DeviceFleetSummary$DeviceFleetName": "

Name of the device fleet.

", - "DeviceSummary$DeviceName": "

The unique identifier of the device.

", - "DeviceSummary$DeviceFleetName": "

The name of the fleet the device belongs to.

", - "EdgeDeploymentModelConfig$ModelHandle": "

The name the device application uses to reference this model.

", - "EdgeDeploymentModelConfig$EdgePackagingJobName": "

The edge packaging job associated with this deployment.

", - "EdgeDeploymentPlanSummary$EdgeDeploymentPlanName": "

The name of the edge deployment plan.

", - "EdgeDeploymentPlanSummary$DeviceFleetName": "

The name of the device fleet used for the deployment.

", - "EdgeModel$ModelName": "

The name of the model.

", - "EdgeModelStat$ModelName": "

The name of the model.

", - "EdgeModelSummary$ModelName": "

The name of the model.

", - "EdgePackagingJobSummary$EdgePackagingJobName": "

The name of the edge packaging job.

", - "EdgePackagingJobSummary$CompilationJobName": "

The name of the SageMaker Neo compilation job.

", - "EdgePackagingJobSummary$ModelName": "

The name of the model.

", - "GetDeviceFleetReportRequest$DeviceFleetName": "

The name of the fleet.

", - "GetDeviceFleetReportResponse$DeviceFleetName": "

The name of the fleet.

", - "GetModelPackageGroupPolicyInput$ModelPackageGroupName": "

The name of the model group for which to get the resource policy.

", - "ListClusterSchedulerConfigsRequest$NameContains": "

Filter for name containing this string.

", - "ListComputeQuotasRequest$NameContains": "

Filter for name containing this string.

", - "ListDevicesRequest$ModelName": "

A filter that searches devices that contains this name in any of their models.

", - "ListDevicesRequest$DeviceFleetName": "

Filter for fleets containing this name in their device fleet name.

", - "ListModelCardExportJobsRequest$ModelCardName": "

List export jobs for the model card with the specified name.

", - "ListModelCardExportJobsRequest$ModelCardExportJobNameContains": "

Only list model card export jobs with names that contain the specified string.

", - "ListModelCardsRequest$NameContains": "

Only list model cards with names that contain the specified string.

", - "ListStageDevicesRequest$EdgeDeploymentPlanName": "

The name of the edge deployment plan.

", - "ListStageDevicesRequest$StageName": "

The name of the stage in the deployment.

", - "ModelCard$ModelCardName": "

The unique name of the model card.

", - "ModelCardExportJobSummary$ModelCardExportJobName": "

The name of the model card export job.

", - "ModelCardExportJobSummary$ModelCardName": "

The name of the model card that the export job exports.

", - "ModelCardSummary$ModelCardName": "

The name of the model card.

", - "ModelCardVersionSummary$ModelCardName": "

The name of the model card.

", - "ModelDashboardModelCard$ModelCardName": "

The name of a model card.

", - "ModelLifeCycle$Stage": "

The current stage in the model life cycle.

", - "ModelLifeCycle$StageStatus": "

The current status of a stage in model life cycle.

", - "ModelPackage$ModelPackageName": "

The name of the model package. The name can be as follows:

  • For a versioned model, the name is automatically generated by SageMaker Model Registry and follows the format 'ModelPackageGroupName/ModelPackageVersion'.

  • For an unversioned model, you must provide the name.

", - "ModelPackage$ModelPackageGroupName": "

The model group to which the model belongs.

", - "ModelPackageGroup$ModelPackageGroupName": "

The name of the model group.

", - "ModelPackageGroupSummary$ModelPackageGroupName": "

The name of the model group.

", - "ModelPackageStatusItem$Name": "

The name of the model package for which the overall status is being reported.

", - "ModelPackageSummary$ModelPackageName": "

The name of the model package.

", - "ModelPackageSummary$ModelPackageGroupName": "

If the model package is a versioned model, the model group that the versioned model belongs to.

", - "ModelPackageValidationProfile$ProfileName": "

The name of the profile for the model package.

", - "OptimizationJobSummary$OptimizationJobName": "

The name that you assigned to the optimization job.

", - "PutModelPackageGroupPolicyInput$ModelPackageGroupName": "

The name of the model group to add a resource policy to.

", - "RegisterDevicesRequest$DeviceFleetName": "

The name of the fleet.

", - "StartEdgeDeploymentStageRequest$EdgeDeploymentPlanName": "

The name of the edge deployment plan to start.

", - "StartEdgeDeploymentStageRequest$StageName": "

The name of the stage to start.

", - "StopCompilationJobRequest$CompilationJobName": "

The name of the model compilation job to stop.

", - "StopEdgeDeploymentStageRequest$EdgeDeploymentPlanName": "

The name of the edge deployment plan to stop.

", - "StopEdgeDeploymentStageRequest$StageName": "

The name of the stage to stop.

", - "StopEdgePackagingJobRequest$EdgePackagingJobName": "

The name of the edge packaging job.

", - "StopOptimizationJobRequest$OptimizationJobName": "

The name that you assigned to the optimization job.

", - "UpdateCodeRepositoryInput$CodeRepositoryName": "

The name of the Git repository to update.

", - "UpdateDeviceFleetRequest$DeviceFleetName": "

The name of the fleet.

", - "UpdateDevicesRequest$DeviceFleetName": "

The name of the fleet the devices belong to.

" - } - }, - "EnvironmentConfig": { - "base": "

The configuration for the restricted instance groups (RIG) environment.

", - "refs": { - "ClusterRestrictedInstanceGroupSpecification$EnvironmentConfig": "

The configuration for the restricted instance groups (RIG) environment.

" - } - }, - "EnvironmentConfigDetails": { - "base": "

The configuration details for the restricted instance groups (RIG) environment.

", - "refs": { - "ClusterRestrictedInstanceGroupDetails$EnvironmentConfig": "

The configuration for the restricted instance groups (RIG) environment.

" - } - }, - "EnvironmentKey": { - "base": null, - "refs": { - "EnvironmentMap$key": null - } - }, - "EnvironmentMap": { - "base": null, - "refs": { - "AIRecommendationDeploymentConfiguration$EnvironmentVariables": "

The environment variables for the deployment.

", - "AutoMLContainerDefinition$Environment": "

The environment variables to set in the container. For more information, see ContainerDefinition.

", - "ContainerDefinition$Environment": "

The environment variables to set in the Docker container. Don't include any sensitive data in your environment variables.

The maximum length of each key and value in the Environment map is 1024 bytes. The maximum length of all keys and values in the map, combined, is 32 KB. If you pass multiple containers to a CreateModel request, then the maximum length of all of their maps, combined, is also 32 KB.

", - "InferenceComponentContainerSpecification$Environment": "

The environment variables to set in the Docker container. Each key and value in the Environment string-to-string map can have length of up to 1024. We support up to 16 entries in the map.

", - "InferenceComponentContainerSpecificationSummary$Environment": "

The environment variables to set in the Docker container.

", - "ModelPackageContainerDefinition$Environment": "

The environment variables to set in the Docker container. Each key and value in the Environment string to string map can have length of up to 1024. We support up to 16 entries in the map.

", - "RealTimeInferenceRecommendation$Environment": "

The recommended environment variables to set in the model container for Real-Time Inference.

" - } - }, - "EnvironmentParameter": { - "base": "

A list of environment parameters suggested by the Amazon SageMaker Inference Recommender.

", - "refs": { - "EnvironmentParameters$member": null - } - }, - "EnvironmentParameterRanges": { - "base": "

Specifies the range of environment parameters

", - "refs": { - "EndpointInputConfiguration$EnvironmentParameterRanges": "

The parameter you want to benchmark against.

" - } - }, - "EnvironmentParameters": { - "base": null, - "refs": { - "ModelConfiguration$EnvironmentParameters": "

Defines the environment parameters that includes key, value types, and values.

" - } - }, - "EnvironmentValue": { - "base": null, - "refs": { - "EnvironmentMap$value": null - } - }, - "ErrorInfo": { - "base": "

This is an error field object that contains the error code and the reason for an operation failure.

", - "refs": { - "DescribePartnerAppResponse$Error": "

This is an error field object that contains the error code and the reason for an operation failure.

" - } - }, - "EvaluationType": { - "base": null, - "refs": { - "ServerlessJobConfig$EvaluationType": "

The evaluation job type. Required when serverless job type is Evaluation.

" - } - }, - "EvaluatorArn": { - "base": null, - "refs": { - "ServerlessJobConfig$EvaluatorArn": "

The evaluator Amazon Resource Name (ARN) used as reward function or reward prompt.

" - } - }, - "EventDetails": { - "base": "

Detailed information about a specific event, including event metadata.

", - "refs": { - "ClusterEventDetail$EventDetails": "

Additional details about the event, including event-specific metadata.

" - } - }, - "EventId": { - "base": null, - "refs": { - "ClusterEventDetail$EventId": "

The unique identifier (UUID) of the event.

", - "ClusterEventSummary$EventId": "

The unique identifier (UUID) of the event.

", - "DescribeClusterEventRequest$EventId": "

The unique identifier (UUID) of the event to describe. This ID can be obtained from the ListClusterEvents operation.

" - } - }, - "EventMetadata": { - "base": "

Metadata associated with a cluster event, which may include details about various resource types.

", - "refs": { - "EventDetails$EventMetadata": "

Metadata specific to the event, which may include information about the cluster, instance group, or instance involved.

" - } - }, - "EventSortBy": { - "base": null, - "refs": { - "ListClusterEventsRequest$SortBy": "

The field to use for sorting the event list. Currently, the only supported value is EventTime.

" - } - }, - "ExcludeFeaturesAttribute": { - "base": null, - "refs": { - "BatchTransformInput$ExcludeFeaturesAttribute": "

The attributes of the input data to exclude from the analysis.

", - "EndpointInput$ExcludeFeaturesAttribute": "

The attributes of the input data to exclude from the analysis.

" - } - }, - "ExecutionRoleArns": { - "base": null, - "refs": { - "EmrSettings$ExecutionRoleArns": "

An array of Amazon Resource Names (ARNs) of the IAM roles used by the Amazon EMR cluster instances or job execution environments to access other Amazon Web Services services and resources needed during the runtime of your Amazon EMR or Amazon EMR Serverless workloads, such as Amazon S3 for data access, Amazon CloudWatch for logging, or other Amazon Web Services services based on the particular workload requirements.

" - } - }, - "ExecutionRoleIdentityConfig": { - "base": null, - "refs": { - "DomainSettings$ExecutionRoleIdentityConfig": "

The configuration for attaching a SageMaker AI user profile name to the execution role as a sts:SourceIdentity key.

", - "DomainSettingsForUpdate$ExecutionRoleIdentityConfig": "

The configuration for attaching a SageMaker AI user profile name to the execution role as a sts:SourceIdentity key. This configuration can only be modified if there are no apps in the InService or Pending state.

" - } - }, - "ExecutionRoleSessionNameMode": { - "base": null, - "refs": { - "StudioWebPortalSettings$ExecutionRoleSessionNameMode": "

The execution role session name mode. If this value is set to USER_IDENTITY, the session name of the execution role corresponds to the user's identity. For IAM domains, the session name is the IAM session name used to generate the presigned URL. For IAM Identity Center domains, the session name is the username of the associated IAM Identity Center user. If this value is set to STATIC or is not set, the session name defaults to SageMaker.

" - } - }, - "ExecutionStatus": { - "base": null, - "refs": { - "ListMonitoringExecutionsRequest$StatusEquals": "

A filter that retrieves only jobs with a specific status.

", - "MonitoringExecutionSummary$MonitoringExecutionStatus": "

The status of the monitoring job.

" - } - }, - "ExitMessage": { - "base": null, - "refs": { - "DescribeProcessingJobResponse$ExitMessage": "

An optional string, up to one KB in size, that contains metadata from the processing container when the processing job exits.

", - "ProcessingJob$ExitMessage": "

A string, up to one KB in size, that contains metadata from the processing container when the processing job exits.

", - "ProcessingJobSummary$ExitMessage": "

An optional string, up to one KB in size, that contains metadata from the processing container when the processing job exits.

" - } - }, - "ExpectedPerformanceList": { - "base": null, - "refs": { - "AIRecommendation$ExpectedPerformance": "

The expected performance metrics for this recommendation.

" - } - }, - "Experiment": { - "base": "

The properties of an experiment as returned by the Search API. For information about experiments, see the CreateExperiment API.

", - "refs": { - "SearchRecord$Experiment": "

The properties of an experiment.

" - } - }, - "ExperimentArn": { - "base": null, - "refs": { - "CreateExperimentResponse$ExperimentArn": "

The Amazon Resource Name (ARN) of the experiment.

", - "DeleteExperimentResponse$ExperimentArn": "

The Amazon Resource Name (ARN) of the experiment that is being deleted.

", - "DescribeExperimentResponse$ExperimentArn": "

The Amazon Resource Name (ARN) of the experiment.

", - "Experiment$ExperimentArn": "

The Amazon Resource Name (ARN) of the experiment.

", - "ExperimentSummary$ExperimentArn": "

The Amazon Resource Name (ARN) of the experiment.

", - "UpdateExperimentResponse$ExperimentArn": "

The Amazon Resource Name (ARN) of the experiment.

" - } - }, - "ExperimentConfig": { - "base": "

Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs:

", - "refs": { - "CreateProcessingJobRequest$ExperimentConfig": null, - "CreateTrainingJobRequest$ExperimentConfig": null, - "CreateTransformJobRequest$ExperimentConfig": null, - "DescribeProcessingJobResponse$ExperimentConfig": "

The configuration information used to create an experiment.

", - "DescribeTrainingJobResponse$ExperimentConfig": null, - "DescribeTransformJobResponse$ExperimentConfig": null, - "ProcessingJob$ExperimentConfig": null, - "TrainingJob$ExperimentConfig": null, - "TransformJob$ExperimentConfig": null - } - }, - "ExperimentDescription": { - "base": null, - "refs": { - "CreateActionRequest$Description": "

The description of the action.

", - "CreateContextRequest$Description": "

The description of the context.

", - "CreateExperimentRequest$Description": "

The description of the experiment.

", - "DescribeActionResponse$Description": "

The description of the action.

", - "DescribeContextResponse$Description": "

The description of the context.

", - "DescribeExperimentResponse$Description": "

The description of the experiment.

", - "DescribeLineageGroupResponse$Description": "

The description of the lineage group.

", - "Experiment$Description": "

The description of the experiment.

", - "UpdateActionRequest$Description": "

The new description for the action.

", - "UpdateContextRequest$Description": "

The new description for the context.

", - "UpdateExperimentRequest$Description": "

The description of the experiment.

" - } - }, - "ExperimentEntityName": { - "base": null, - "refs": { - "ActionSummary$ActionName": "

The name of the action.

", - "ArtifactSummary$ArtifactName": "

The name of the artifact.

", - "AssociateTrialComponentRequest$TrialComponentName": "

The name of the component to associated with the trial.

", - "AssociateTrialComponentRequest$TrialName": "

The name of the trial to associate with.

", - "AssociationSummary$SourceName": "

The name of the source.

", - "AssociationSummary$DestinationName": "

The name of the destination.

", - "CreateActionRequest$ActionName": "

The name of the action. Must be unique to your account in an Amazon Web Services Region.

", - "CreateArtifactRequest$ArtifactName": "

The name of the artifact. Must be unique to your account in an Amazon Web Services Region.

", - "CreateExperimentRequest$ExperimentName": "

The name of the experiment. The name must be unique in your Amazon Web Services account and is not case-sensitive.

", - "CreateExperimentRequest$DisplayName": "

The name of the experiment as displayed. The name doesn't need to be unique. If you don't specify DisplayName, the value in ExperimentName is displayed.

", - "CreateTrialComponentRequest$TrialComponentName": "

The name of the component. The name must be unique in your Amazon Web Services account and is not case-sensitive.

", - "CreateTrialComponentRequest$DisplayName": "

The name of the component as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialComponentName is displayed.

", - "CreateTrialRequest$TrialName": "

The name of the trial. The name must be unique in your Amazon Web Services account and is not case-sensitive.

", - "CreateTrialRequest$DisplayName": "

The name of the trial as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialName is displayed.

", - "CreateTrialRequest$ExperimentName": "

The name of the experiment to associate the trial with.

", - "DeleteActionRequest$ActionName": "

The name of the action to delete.

", - "DeleteExperimentRequest$ExperimentName": "

The name of the experiment to delete.

", - "DeleteTrialComponentRequest$TrialComponentName": "

The name of the component to delete.

", - "DeleteTrialRequest$TrialName": "

The name of the trial to delete.

", - "DescribeExperimentRequest$ExperimentName": "

The name of the experiment to describe.

", - "DescribeExperimentResponse$ExperimentName": "

The name of the experiment.

", - "DescribeExperimentResponse$DisplayName": "

The name of the experiment as displayed. If DisplayName isn't specified, ExperimentName is displayed.

", - "DescribeLineageGroupRequest$LineageGroupName": "

The name of the lineage group.

", - "DescribeLineageGroupResponse$LineageGroupName": "

The name of the lineage group.

", - "DescribeLineageGroupResponse$DisplayName": "

The display name of the lineage group.

", - "DescribeTrialComponentResponse$TrialComponentName": "

The name of the trial component.

", - "DescribeTrialComponentResponse$DisplayName": "

The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.

", - "DescribeTrialRequest$TrialName": "

The name of the trial to describe.

", - "DescribeTrialResponse$TrialName": "

The name of the trial.

", - "DescribeTrialResponse$DisplayName": "

The name of the trial as displayed. If DisplayName isn't specified, TrialName is displayed.

", - "DescribeTrialResponse$ExperimentName": "

The name of the experiment the trial is part of.

", - "DisassociateTrialComponentRequest$TrialComponentName": "

The name of the component to disassociate from the trial.

", - "DisassociateTrialComponentRequest$TrialName": "

The name of the trial to disassociate from.

", - "Experiment$ExperimentName": "

The name of the experiment.

", - "Experiment$DisplayName": "

The name of the experiment as displayed. If DisplayName isn't specified, ExperimentName is displayed.

", - "ExperimentConfig$ExperimentName": "

The name of an existing experiment to associate with the trial component.

", - "ExperimentConfig$TrialName": "

The name of an existing trial to associate the trial component with. If not specified, a new trial is created.

", - "ExperimentConfig$TrialComponentDisplayName": "

The display name for the trial component. If this key isn't specified, the display name is the trial component name.

", - "ExperimentConfig$RunName": "

The name of the experiment run to associate with the trial component.

", - "ExperimentSummary$ExperimentName": "

The name of the experiment.

", - "ExperimentSummary$DisplayName": "

The name of the experiment as displayed. If DisplayName isn't specified, ExperimentName is displayed.

", - "LineageGroupSummary$LineageGroupName": "

The name or Amazon Resource Name (ARN) of the lineage group.

", - "LineageGroupSummary$DisplayName": "

The display name of the lineage group summary.

", - "ListTrialComponentsRequest$ExperimentName": "

A filter that returns only components that are part of the specified experiment. If you specify ExperimentName, you can't filter by SourceArn or TrialName.

", - "ListTrialComponentsRequest$TrialName": "

A filter that returns only components that are part of the specified trial. If you specify TrialName, you can't filter by ExperimentName or SourceArn.

", - "ListTrialsRequest$ExperimentName": "

A filter that returns only trials that are part of the specified experiment.

", - "ListTrialsRequest$TrialComponentName": "

A filter that returns only trials that are associated with the specified trial component.

", - "Parent$TrialName": "

The name of the trial.

", - "Parent$ExperimentName": "

The name of the experiment.

", - "PipelineExperimentConfig$ExperimentName": "

The name of the experiment.

", - "PipelineExperimentConfig$TrialName": "

The name of the trial.

", - "Trial$TrialName": "

The name of the trial.

", - "Trial$DisplayName": "

The name of the trial as displayed. If DisplayName isn't specified, TrialName is displayed.

", - "Trial$ExperimentName": "

The name of the experiment the trial is part of.

", - "TrialComponent$TrialComponentName": "

The name of the trial component.

", - "TrialComponent$DisplayName": "

The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.

", - "TrialComponent$RunName": "

The name of the experiment run.

", - "TrialComponentSimpleSummary$TrialComponentName": "

The name of the trial component.

", - "TrialComponentSummary$TrialComponentName": "

The name of the trial component.

", - "TrialComponentSummary$DisplayName": "

The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.

", - "TrialSummary$TrialName": "

The name of the trial.

", - "TrialSummary$DisplayName": "

The name of the trial as displayed. If DisplayName isn't specified, TrialName is displayed.

", - "UpdateActionRequest$ActionName": "

The name of the action to update.

", - "UpdateArtifactRequest$ArtifactName": "

The new name for the artifact.

", - "UpdateExperimentRequest$ExperimentName": "

The name of the experiment to update.

", - "UpdateExperimentRequest$DisplayName": "

The name of the experiment as displayed. The name doesn't need to be unique. If DisplayName isn't specified, ExperimentName is displayed.

", - "UpdateTrialComponentRequest$TrialComponentName": "

The name of the component to update.

", - "UpdateTrialComponentRequest$DisplayName": "

The name of the component as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialComponentName is displayed.

", - "UpdateTrialRequest$TrialName": "

The name of the trial to update.

", - "UpdateTrialRequest$DisplayName": "

The name of the trial as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialName is displayed.

" - } - }, - "ExperimentEntityNameOrArn": { - "base": null, - "refs": { - "DescribeActionRequest$ActionName": "

The name of the action to describe.

", - "DescribeActionResponse$ActionName": "

The name of the action.

", - "DescribeArtifactResponse$ArtifactName": "

The name of the artifact.

", - "DescribeTrialComponentRequest$TrialComponentName": "

The name of the trial component to describe.

" - } - }, - "ExperimentSource": { - "base": "

The source of the experiment.

", - "refs": { - "DescribeExperimentResponse$Source": "

The Amazon Resource Name (ARN) of the source and, optionally, the type.

", - "Experiment$Source": null, - "ExperimentSummary$ExperimentSource": null - } - }, - "ExperimentSourceArn": { - "base": null, - "refs": { - "ExperimentSource$SourceArn": "

The Amazon Resource Name (ARN) of the source.

" - } - }, - "ExperimentSummaries": { - "base": null, - "refs": { - "ListExperimentsResponse$ExperimentSummaries": "

A list of the summaries of your experiments.

" - } - }, - "ExperimentSummary": { - "base": "

A summary of the properties of an experiment. To get the complete set of properties, call the DescribeExperiment API and provide the ExperimentName.

", - "refs": { - "ExperimentSummaries$member": null - } - }, - "ExpiresInSeconds": { - "base": null, - "refs": { - "CreatePartnerAppPresignedUrlRequest$ExpiresInSeconds": "

The time that will pass before the presigned URL expires.

", - "CreatePresignedDomainUrlRequest$ExpiresInSeconds": "

The number of seconds until the pre-signed URL expires. This value defaults to 300.

", - "CreatePresignedMlflowAppUrlRequest$ExpiresInSeconds": "

The duration in seconds that your presigned URL is valid. The presigned URL can be used only once.

", - "CreatePresignedMlflowTrackingServerUrlRequest$ExpiresInSeconds": "

The duration in seconds that your presigned URL is valid. The presigned URL can be used only once.

" - } - }, - "Explainability": { - "base": "

Contains explainability metrics for a model.

", - "refs": { - "ModelMetrics$Explainability": "

Metrics that help explain a model.

" - } - }, - "ExplainabilityLocation": { - "base": null, - "refs": { - "CandidateArtifactLocations$Explainability": "

The Amazon S3 prefix to the explainability artifacts generated for the AutoML candidate.

" - } - }, - "ExplainerConfig": { - "base": "

A parameter to activate explainers.

", - "refs": { - "CreateEndpointConfigInput$ExplainerConfig": "

A member of CreateEndpointConfig that enables explainers.

", - "DescribeEndpointConfigOutput$ExplainerConfig": "

The configuration parameters for an explainer.

", - "DescribeEndpointOutput$ExplainerConfig": "

The configuration parameters for an explainer.

" - } - }, - "ExtendTrainingPlanRequest": { - "base": null, - "refs": {} - }, - "ExtendTrainingPlanResponse": { - "base": null, - "refs": {} - }, - "FSxLustreConfig": { - "base": "

Configuration settings for an Amazon FSx for Lustre file system to be used with the cluster.

", - "refs": { - "ClusterSharedEnvironmentConfig$FSxLustreConfig": "

Configuration settings for an Amazon FSx for Lustre file system in the shared environment.

", - "ClusterSharedEnvironmentConfigDetails$CurrentFSxLustreConfig": "

The current Amazon FSx for Lustre file system configuration in the shared environment.

", - "ClusterSharedEnvironmentConfigDetails$DesiredFSxLustreConfig": "

The desired Amazon FSx for Lustre file system configuration in the shared environment.

", - "EnvironmentConfig$FSxLustreConfig": "

Configuration settings for an Amazon FSx for Lustre file system to be used with the cluster.

", - "EnvironmentConfigDetails$FSxLustreConfig": "

Configuration settings for an Amazon FSx for Lustre file system to be used with the cluster.

" - } - }, - "FSxLustreFileSystem": { - "base": "

A custom file system in Amazon FSx for Lustre.

", - "refs": { - "CustomFileSystem$FSxLustreFileSystem": "

A custom file system in Amazon FSx for Lustre.

" - } - }, - "FSxLustreFileSystemConfig": { - "base": "

The settings for assigning a custom Amazon FSx for Lustre file system to a user profile or space for an Amazon SageMaker Domain.

", - "refs": { - "CustomFileSystemConfig$FSxLustreFileSystemConfig": "

The settings for a custom Amazon FSx for Lustre file system.

" - } - }, - "FSxLustrePerUnitStorageThroughput": { - "base": null, - "refs": { - "FSxLustreConfig$PerUnitStorageThroughput": "

The throughput capacity of the Amazon FSx for Lustre file system, measured in MB/s per TiB of storage.

" - } - }, - "FSxLustreSizeInGiB": { - "base": null, - "refs": { - "FSxLustreConfig$SizeInGiB": "

The storage capacity of the Amazon FSx for Lustre file system, specified in gibibytes (GiB).

" - } - }, - "FailStepMetadata": { - "base": "

The container for the metadata for Fail step.

", - "refs": { - "PipelineExecutionStepMetadata$Fail": "

The configurations and outcomes of a Fail step execution.

" - } - }, - "FailureHandlingPolicy": { - "base": null, - "refs": { - "EdgeDeploymentConfig$FailureHandlingPolicy": "

Toggle that determines whether to rollback to previous configuration if the current deployment fails. By default this is turned on. You may turn this off if you want to investigate the errors yourself.

" - } - }, - "FailureReason": { - "base": null, - "refs": { - "ConflictException$Message": null, - "DescribeAIBenchmarkJobResponse$FailureReason": "

If the benchmark job failed, the reason it failed.

", - "DescribeAIRecommendationJobResponse$FailureReason": "

If the recommendation job failed, the reason it failed.

", - "DescribeAppResponse$FailureReason": "

The failure reason.

", - "DescribeClusterSchedulerConfigResponse$FailureReason": "

Failure reason of the cluster policy.

", - "DescribeCompilationJobResponse$FailureReason": "

If a model compilation job failed, the reason it failed.

", - "DescribeComputeQuotaResponse$FailureReason": "

Failure reason of the compute allocation definition.

", - "DescribeDomainResponse$FailureReason": "

The failure reason.

", - "DescribeEndpointOutput$FailureReason": "

If the status of the endpoint is Failed, the reason why it failed.

", - "DescribeFeatureGroupResponse$FailureReason": "

The reason that the FeatureGroup failed to be replicated in the OfflineStore. This is failure can occur because:

  • The FeatureGroup could not be created in the OfflineStore.

  • The FeatureGroup could not be deleted from the OfflineStore.

", - "DescribeFlowDefinitionResponse$FailureReason": "

The reason your flow definition failed.

", - "DescribeHubContentResponse$FailureReason": "

The failure reason if importing hub content failed.

", - "DescribeHubResponse$FailureReason": "

The failure reason if importing hub content failed.

", - "DescribeHyperParameterTuningJobResponse$FailureReason": "

If the tuning job failed, the reason it failed.

", - "DescribeImageResponse$FailureReason": "

When a create, update, or delete operation fails, the reason for the failure.

", - "DescribeImageVersionResponse$FailureReason": "

When a create or delete operation fails, the reason for the failure.

", - "DescribeInferenceComponentOutput$FailureReason": "

If the inference component status is Failed, the reason for the failure.

", - "DescribeInferenceRecommendationsJobResponse$FailureReason": "

If the job fails, provides information why the job failed.

", - "DescribeJobResponse$FailureReason": "

If the job failed, the reason it failed.

", - "DescribeLabelingJobResponse$FailureReason": "

If the job failed, the reason that it failed.

", - "DescribeModelCardExportJobResponse$FailureReason": "

The failure reason if the model export job fails.

", - "DescribeMonitoringScheduleResponse$FailureReason": "

A string, up to one KB in size, that contains the reason a monitoring job failed, if it failed.

", - "DescribeNotebookInstanceOutput$FailureReason": "

If status is Failed, the reason it failed.

", - "DescribeOptimizationJobResponse$FailureReason": "

If the optimization job status is FAILED, the reason for the failure.

", - "DescribeProcessingJobResponse$FailureReason": "

A string, up to one KB in size, that contains the reason a processing job failed, if it failed.

", - "DescribeSpaceResponse$FailureReason": "

The failure reason.

", - "DescribeTrainingJobResponse$FailureReason": "

If the training job failed, the reason it failed.

", - "DescribeTransformJobResponse$FailureReason": "

If the transform job failed, FailureReason describes why it failed. A transform job creates a log file, which includes error messages, and stores it as an Amazon S3 object. For more information, see Log Amazon SageMaker Events with Amazon CloudWatch.

", - "DescribeUserProfileResponse$FailureReason": "

The failure reason.

", - "Endpoint$FailureReason": "

If the endpoint failed, the reason it failed.

", - "EndpointMetadata$FailureReason": "

If the status of the endpoint is Failed, or the status is InService but update operation fails, this provides the reason why it failed.

", - "FeatureGroup$FailureReason": "

The reason that the FeatureGroup failed to be replicated in the OfflineStore. This is failure may be due to a failure to create a FeatureGroup in or delete a FeatureGroup from the OfflineStore.

", - "FlowDefinitionSummary$FailureReason": "

The reason why the flow definition creation failed. A failure reason is returned only when the flow definition status is Failed.

", - "HyperParameterTrainingJobSummary$FailureReason": "

The reason that the training job failed.

", - "HyperParameterTuningJobSearchEntity$FailureReason": "

The error that was created when a hyperparameter tuning job failed.

", - "Image$FailureReason": "

When a create, update, or delete operation fails, the reason for the failure.

", - "ImageVersion$FailureReason": "

When a create or delete operation fails, the reason for the failure.

", - "InferenceRecommendationsJob$FailureReason": "

If the job fails, provides information why the job failed.

", - "Job$FailureReason": "

If the job failed, the reason it failed.

", - "LabelingJobSummary$FailureReason": "

If the LabelingJobStatus field is Failed, this field contains a description of the error.

", - "LastUpdateStatus$FailureReason": "

If the update wasn't successful, indicates the reason why it failed.

", - "ModelDashboardMonitoringSchedule$FailureReason": "

If a monitoring job failed, provides the reason.

", - "MonitoringExecutionSummary$FailureReason": "

Contains the reason a monitoring job failed, if it failed.

", - "MonitoringSchedule$FailureReason": "

If the monitoring schedule failed, the reason it failed.

", - "PipelineExecutionStep$FailureReason": "

The reason why the step failed execution. This is only returned if the step failed its execution.

", - "ProcessingJob$FailureReason": "

A string, up to one KB in size, that contains the reason a processing job failed, if it failed.

", - "ProcessingJobSummary$FailureReason": "

A string, up to one KB in size, that contains the reason a processing job failed, if it failed.

", - "ResourceInUse$Message": null, - "ResourceLimitExceeded$Message": null, - "ResourceNotFound$Message": null, - "TrainingJob$FailureReason": "

If the training job failed, the reason it failed.

", - "TransformJob$FailureReason": "

If the transform job failed, the reason it failed.

", - "TransformJobSummary$FailureReason": "

If the transform job failed, the reason it failed.

" - } - }, - "FairShare": { - "base": null, - "refs": { - "SchedulerConfig$FairShare": "

When enabled, entities borrow idle compute based on their assigned FairShareWeight.

When disabled, entities borrow idle compute based on a first-come first-serve basis.

Default is Enabled.

" - } - }, - "FairShareWeight": { - "base": null, - "refs": { - "ComputeQuotaTarget$FairShareWeight": "

Assigned entity fair-share weight. Idle compute will be shared across entities based on these assigned weights. This weight is only used when FairShare is enabled.

A weight of 0 is the lowest priority and 100 is the highest. Weight 0 is the default.

" - } - }, - "FeatureAdditions": { - "base": null, - "refs": { - "UpdateFeatureGroupRequest$FeatureAdditions": "

Updates the feature group. Updating a feature group is an asynchronous operation. When you get an HTTP 200 response, you've made a valid request. It takes some time after you've made a valid request for Feature Store to update the feature group.

" - } - }, - "FeatureDefinition": { - "base": "

A list of features. You must include FeatureName and FeatureType. Valid feature FeatureTypes are Integral, Fractional and String.

", - "refs": { - "FeatureAdditions$member": null, - "FeatureDefinitions$member": null - } - }, - "FeatureDefinitions": { - "base": null, - "refs": { - "CreateFeatureGroupRequest$FeatureDefinitions": "

A list of Feature names and types. Name and Type is compulsory per Feature.

Valid feature FeatureTypes are Integral, Fractional and String.

FeatureNames cannot be any of the following: is_deleted, write_time, api_invocation_time

You can create up to 2,500 FeatureDefinitions per FeatureGroup.

", - "DescribeFeatureGroupResponse$FeatureDefinitions": "

A list of the Features in the FeatureGroup. Each feature is defined by a FeatureName and FeatureType.

", - "FeatureGroup$FeatureDefinitions": "

A list of Features. Each Feature must include a FeatureName and a FeatureType.

Valid FeatureTypes are Integral, Fractional and String.

FeatureNames cannot be any of the following: is_deleted, write_time, api_invocation_time.

You can create up to 2,500 FeatureDefinitions per FeatureGroup.

" - } - }, - "FeatureDescription": { - "base": null, - "refs": { - "DescribeFeatureMetadataResponse$Description": "

The description you added to describe the feature.

", - "FeatureMetadata$Description": "

An optional description that you specify to better describe the feature.

", - "UpdateFeatureMetadataRequest$Description": "

A description that you can write to better describe the feature.

" - } - }, - "FeatureGroup": { - "base": "

Amazon SageMaker Feature Store stores features in a collection called Feature Group. A Feature Group can be visualized as a table which has rows, with a unique identifier for each row where each column in the table is a feature. In principle, a Feature Group is composed of features and values per features.

", - "refs": { - "SearchRecord$FeatureGroup": null - } - }, - "FeatureGroupArn": { - "base": null, - "refs": { - "CreateFeatureGroupResponse$FeatureGroupArn": "

The Amazon Resource Name (ARN) of the FeatureGroup. This is a unique identifier for the feature group.

", - "DescribeFeatureGroupResponse$FeatureGroupArn": "

The Amazon Resource Name (ARN) of the FeatureGroup.

", - "DescribeFeatureMetadataResponse$FeatureGroupArn": "

The Amazon Resource Number (ARN) of the feature group that contains the feature.

", - "FeatureGroup$FeatureGroupArn": "

The Amazon Resource Name (ARN) of a FeatureGroup.

", - "FeatureGroupSummary$FeatureGroupArn": "

Unique identifier for the FeatureGroup.

", - "FeatureMetadata$FeatureGroupArn": "

The Amazon Resource Number (ARN) of the feature group.

", - "UpdateFeatureGroupResponse$FeatureGroupArn": "

The Amazon Resource Number (ARN) of the feature group that you're updating.

" - } - }, - "FeatureGroupMaxResults": { - "base": null, - "refs": { - "ListFeatureGroupsRequest$MaxResults": "

The maximum number of results returned by ListFeatureGroups.

" - } - }, - "FeatureGroupName": { - "base": null, - "refs": { - "CreateFeatureGroupRequest$FeatureGroupName": "

The name of the FeatureGroup. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

The name:

  • Must start with an alphanumeric character.

  • Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed.

", - "DeleteFeatureGroupRequest$FeatureGroupName": "

The name of the FeatureGroup you want to delete. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

", - "DescribeFeatureGroupResponse$FeatureGroupName": "

he name of the FeatureGroup.

", - "DescribeFeatureMetadataResponse$FeatureGroupName": "

The name of the feature group that you've specified.

", - "FeatureGroup$FeatureGroupName": "

The name of the FeatureGroup.

", - "FeatureGroupSummary$FeatureGroupName": "

The name of FeatureGroup.

", - "FeatureMetadata$FeatureGroupName": "

The name of the feature group containing the feature.

", - "ProcessingFeatureStoreOutput$FeatureGroupName": "

The name of the Amazon SageMaker FeatureGroup to use as the destination for processing job output. Note that your processing script is responsible for putting records into your Feature Store.

" - } - }, - "FeatureGroupNameContains": { - "base": null, - "refs": { - "ListFeatureGroupsRequest$NameContains": "

A string that partially matches one or more FeatureGroups names. Filters FeatureGroups by name.

" - } - }, - "FeatureGroupNameOrArn": { - "base": null, - "refs": { - "DescribeFeatureGroupRequest$FeatureGroupName": "

The name or Amazon Resource Name (ARN) of the FeatureGroup you want described.

", - "DescribeFeatureMetadataRequest$FeatureGroupName": "

The name or Amazon Resource Name (ARN) of the feature group containing the feature.

", - "UpdateFeatureGroupRequest$FeatureGroupName": "

The name or Amazon Resource Name (ARN) of the feature group that you're updating.

", - "UpdateFeatureMetadataRequest$FeatureGroupName": "

The name or Amazon Resource Name (ARN) of the feature group containing the feature that you're updating.

" - } - }, - "FeatureGroupSortBy": { - "base": null, - "refs": { - "ListFeatureGroupsRequest$SortBy": "

The value on which the feature group list is sorted.

" - } - }, - "FeatureGroupSortOrder": { - "base": null, - "refs": { - "ListFeatureGroupsRequest$SortOrder": "

The order in which feature groups are listed.

" - } - }, - "FeatureGroupStatus": { - "base": null, - "refs": { - "DescribeFeatureGroupResponse$FeatureGroupStatus": "

The status of the feature group.

", - "FeatureGroup$FeatureGroupStatus": "

A FeatureGroup status.

", - "FeatureGroupSummary$FeatureGroupStatus": "

The status of a FeatureGroup. The status can be any of the following: Creating, Created, CreateFail, Deleting or DetailFail.

", - "ListFeatureGroupsRequest$FeatureGroupStatusEquals": "

A FeatureGroup status. Filters by FeatureGroup status.

" - } - }, - "FeatureGroupSummaries": { - "base": null, - "refs": { - "ListFeatureGroupsResponse$FeatureGroupSummaries": "

A summary of feature groups.

" - } - }, - "FeatureGroupSummary": { - "base": "

The name, ARN, CreationTime, FeatureGroup values, LastUpdatedTime and EnableOnlineStorage status of a FeatureGroup.

", - "refs": { - "FeatureGroupSummaries$member": null - } - }, - "FeatureMetadata": { - "base": "

The metadata for a feature. It can either be metadata that you specify, or metadata that is updated automatically.

", - "refs": { - "SearchRecord$FeatureMetadata": "

The feature metadata used to search through the features.

" - } - }, - "FeatureName": { - "base": null, - "refs": { - "CreateFeatureGroupRequest$RecordIdentifierFeatureName": "

The name of the Feature whose value uniquely identifies a Record defined in the FeatureStore. Only the latest record per identifier value will be stored in the OnlineStore. RecordIdentifierFeatureName must be one of feature definitions' names.

You use the RecordIdentifierFeatureName to access data in a FeatureStore.

This name:

  • Must start with an alphanumeric character.

  • Can only contains alphanumeric characters, hyphens, underscores. Spaces are not allowed.

", - "CreateFeatureGroupRequest$EventTimeFeatureName": "

The name of the feature that stores the EventTime of a Record in a FeatureGroup.

An EventTime is a point in time when a new event occurs that corresponds to the creation or update of a Record in a FeatureGroup. All Records in the FeatureGroup must have a corresponding EventTime.

An EventTime can be a String or Fractional.

  • Fractional: EventTime feature values must be a Unix timestamp in seconds.

  • String: EventTime feature values must be an ISO-8601 string in the format. The following formats are supported yyyy-MM-dd'T'HH:mm:ssZ and yyyy-MM-dd'T'HH:mm:ss.SSSZ where yyyy, MM, and dd represent the year, month, and day respectively and HH, mm, ss, and if applicable, SSS represent the hour, month, second and milliseconds respsectively. 'T' and Z are constants.

", - "DescribeFeatureGroupResponse$RecordIdentifierFeatureName": "

The name of the Feature used for RecordIdentifier, whose value uniquely identifies a record stored in the feature store.

", - "DescribeFeatureGroupResponse$EventTimeFeatureName": "

The name of the feature that stores the EventTime of a Record in a FeatureGroup.

An EventTime is a point in time when a new event occurs that corresponds to the creation or update of a Record in a FeatureGroup. All Records in the FeatureGroup have a corresponding EventTime.

", - "DescribeFeatureMetadataRequest$FeatureName": "

The name of the feature.

", - "DescribeFeatureMetadataResponse$FeatureName": "

The name of the feature that you've specified.

", - "FeatureDefinition$FeatureName": "

The name of a feature. The type must be a string. FeatureName cannot be any of the following: is_deleted, write_time, api_invocation_time.

The name:

  • Must start with an alphanumeric character.

  • Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed.

", - "FeatureGroup$RecordIdentifierFeatureName": "

The name of the Feature whose value uniquely identifies a Record defined in the FeatureGroup FeatureDefinitions.

", - "FeatureGroup$EventTimeFeatureName": "

The name of the feature that stores the EventTime of a Record in a FeatureGroup.

A EventTime is point in time when a new event occurs that corresponds to the creation or update of a Record in FeatureGroup. All Records in the FeatureGroup must have a corresponding EventTime.

", - "FeatureMetadata$FeatureName": "

The name of feature.

", - "UpdateFeatureMetadataRequest$FeatureName": "

The name of the feature that you're updating.

" - } - }, - "FeatureParameter": { - "base": "

A key-value pair that you specify to describe the feature.

", - "refs": { - "FeatureParameterAdditions$member": null, - "FeatureParameters$member": null - } - }, - "FeatureParameterAdditions": { - "base": null, - "refs": { - "UpdateFeatureMetadataRequest$ParameterAdditions": "

A list of key-value pairs that you can add to better describe the feature.

" - } - }, - "FeatureParameterKey": { - "base": null, - "refs": { - "FeatureParameter$Key": "

A key that must contain a value to describe the feature.

", - "FeatureParameterRemovals$member": null - } - }, - "FeatureParameterRemovals": { - "base": null, - "refs": { - "UpdateFeatureMetadataRequest$ParameterRemovals": "

A list of parameter keys that you can specify to remove parameters that describe your feature.

" - } - }, - "FeatureParameterValue": { - "base": null, - "refs": { - "FeatureParameter$Value": "

The value that belongs to a key.

" - } - }, - "FeatureParameters": { - "base": null, - "refs": { - "DescribeFeatureMetadataResponse$Parameters": "

The key-value pairs that you added to describe the feature.

", - "FeatureMetadata$Parameters": "

Optional key-value pairs that you specify to better describe the feature.

" - } - }, - "FeatureStatus": { - "base": null, - "refs": { - "AmazonQSettings$Status": "

Whether Amazon Q has been enabled within the domain.

", - "DescribeAppResponse$EffectiveTrustedIdentityPropagationStatus": "

The effective status of Trusted Identity Propagation (TIP) for this application. When enabled, user identities from IAM Identity Center are being propagated through the application to TIP enabled Amazon Web Services services. When disabled, standard IAM role-based access is used.

", - "DirectDeploySettings$Status": "

Describes whether model deployment permissions are enabled or disabled in the Canvas application.

", - "DockerSettings$EnableDockerAccess": "

Indicates whether the domain can access Docker.

", - "DockerSettings$RootlessDocker": "

Indicates whether to use rootless Docker.

", - "EmrServerlessSettings$Status": "

Describes whether Amazon EMR Serverless job capabilities are enabled or disabled in the SageMaker Canvas application.

", - "IdentityProviderOAuthSetting$Status": "

Describes whether OAuth for a data source is enabled or disabled in the Canvas application.

", - "KendraSettings$Status": "

Describes whether the document querying feature is enabled or disabled in the Canvas application.

", - "ModelRegisterSettings$Status": "

Describes whether the integration to the model registry is enabled or disabled in the Canvas application.

", - "SpaceSettings$SpaceManagedResources": "

If you enable this option, SageMaker AI creates the following resources on your behalf when you create the space:

  • The user profile that possesses the space.

  • The app that the space contains.

", - "SpaceSettings$RemoteAccess": "

A setting that enables or disables remote access for a SageMaker space. When enabled, this allows you to connect to the remote space from your local IDE.

", - "SpaceSettingsSummary$RemoteAccess": "

A setting that enables or disables remote access for a SageMaker space. When enabled, this allows you to connect to the remote space from your local IDE.

", - "TimeSeriesForecastingSettings$Status": "

Describes whether time series forecasting is enabled or disabled in the Canvas application.

", - "TrustedIdentityPropagationSettings$Status": "

The status of Trusted Identity Propagation (TIP) at the SageMaker domain level.

When disabled, standard IAM role-based access is used.

When enabled:

  • User identities from IAM Identity Center are propagated through the application to TIP enabled Amazon Web Services services.

  • New applications or existing applications that are automatically patched, will use the domain level configuration.

", - "UnifiedStudioSettings$StudioWebPortalAccess": "

Sets whether you can access the domain in Amazon SageMaker Studio:

ENABLED

You can access the domain in Amazon SageMaker Studio. If you migrate the domain to Amazon SageMaker Unified Studio, you can access it in both studio interfaces.

DISABLED

You can't access the domain in Amazon SageMaker Studio. If you migrate the domain to Amazon SageMaker Unified Studio, you can access it only in that studio interface.

To migrate a domain to Amazon SageMaker Unified Studio, you specify the UnifiedStudioSettings data type when you use the UpdateDomain action.

" - } - }, - "FeatureType": { - "base": null, - "refs": { - "DescribeFeatureMetadataResponse$FeatureType": "

The data type of the feature.

", - "FeatureDefinition$FeatureType": "

The value type of a feature. Valid values are Integral, Fractional, or String.

", - "FeatureMetadata$FeatureType": "

The data type of the feature.

" - } - }, - "FileSource": { - "base": "

Contains details regarding the file source.

", - "refs": { - "DriftCheckBias$ConfigFile": "

The bias config file for a model.

", - "DriftCheckExplainability$ConfigFile": "

The explainability config file for the model.

" - } - }, - "FileSystemAccessMode": { - "base": null, - "refs": { - "FileSystemDataSource$FileSystemAccessMode": "

The access mode of the mount of the directory associated with the channel. A directory can be mounted either in ro (read-only) or rw (read-write) mode.

" - } - }, - "FileSystemConfig": { - "base": "

The Amazon Elastic File System storage configuration for a SageMaker AI image.

", - "refs": { - "CodeEditorAppImageConfig$FileSystemConfig": null, - "JupyterLabAppImageConfig$FileSystemConfig": null, - "KernelGatewayImageConfig$FileSystemConfig": "

The Amazon Elastic File System storage configuration for a SageMaker AI image.

" - } - }, - "FileSystemDataSource": { - "base": "

Specifies a file system data source for a channel.

", - "refs": { - "DataSource$FileSystemDataSource": "

The file system that is associated with a channel.

" - } - }, - "FileSystemId": { - "base": null, - "refs": { - "EFSFileSystem$FileSystemId": "

The ID of your Amazon EFS file system.

", - "EFSFileSystemConfig$FileSystemId": "

The ID of your Amazon EFS file system.

", - "FSxLustreFileSystem$FileSystemId": "

Amazon FSx for Lustre file system ID.

", - "FSxLustreFileSystemConfig$FileSystemId": "

The globally unique, 17-digit, ID of the file system, assigned by Amazon FSx for Lustre.

", - "FileSystemDataSource$FileSystemId": "

The file system id.

" - } - }, - "FileSystemPath": { - "base": null, - "refs": { - "EFSFileSystemConfig$FileSystemPath": "

The path to the file system directory that is accessible in Amazon SageMaker AI Studio. Permitted users can access only this directory and below.

", - "FSxLustreFileSystemConfig$FileSystemPath": "

The path to the file system directory that is accessible in Amazon SageMaker Studio. Permitted users can access only this directory and below.

" - } - }, - "FileSystemType": { - "base": null, - "refs": { - "FileSystemDataSource$FileSystemType": "

The file system type.

" - } - }, - "FillingTransformationMap": { - "base": null, - "refs": { - "FillingTransformations$value": null - } - }, - "FillingTransformationValue": { - "base": null, - "refs": { - "FillingTransformationMap$value": null - } - }, - "FillingTransformations": { - "base": null, - "refs": { - "TimeSeriesTransformations$Filling": "

A key value pair defining the filling method for a column, where the key is the column name and the value is an object which defines the filling logic. You can specify multiple filling methods for a single column.

The supported filling methods and their corresponding options are:

  • frontfill: none (Supported only for target column)

  • middlefill: zero, value, median, mean, min, max

  • backfill: zero, value, median, mean, min, max

  • futurefill: zero, value, median, mean, min, max

To set a filling method to a specific value, set the fill parameter to the chosen filling method value (for example \"backfill\" : \"value\"), and define the filling value in an additional parameter prefixed with \"_value\". For example, to set backfill to a value of 2, you must include two parameters: \"backfill\": \"value\" and \"backfill_value\":\"2\".

" - } - }, - "FillingType": { - "base": null, - "refs": { - "FillingTransformationMap$key": null - } - }, - "Filter": { - "base": "

A conditional statement for a search expression that includes a resource property, a Boolean operator, and a value. Resources that match the statement are returned in the results from the Search API.

If you specify a Value, but not an Operator, SageMaker uses the equals operator.

In search, there are several property types:

Metrics

To define a metric filter, enter a value using the form \"Metrics.<name>\", where <name> is a metric name. For example, the following filter searches for training jobs with an \"accuracy\" metric greater than \"0.9\":

{

\"Name\": \"Metrics.accuracy\",

\"Operator\": \"GreaterThan\",

\"Value\": \"0.9\"

}

HyperParameters

To define a hyperparameter filter, enter a value with the form \"HyperParameters.<name>\". Decimal hyperparameter values are treated as a decimal in a comparison if the specified Value is also a decimal value. If the specified Value is an integer, the decimal hyperparameter values are treated as integers. For example, the following filter is satisfied by training jobs with a \"learning_rate\" hyperparameter that is less than \"0.5\":

{

\"Name\": \"HyperParameters.learning_rate\",

\"Operator\": \"LessThan\",

\"Value\": \"0.5\"

}

Tags

To define a tag filter, enter a value with the form Tags.<key>.

", - "refs": { - "FilterList$member": null - } - }, - "FilterList": { - "base": null, - "refs": { - "NestedFilters$Filters": "

A list of filters. Each filter acts on a property. Filters must contain at least one Filters value. For example, a NestedFilters call might include a filter on the PropertyName parameter of the InputDataConfig property: InputDataConfig.DataSource.S3DataSource.S3Uri.

", - "SearchExpression$Filters": "

A list of filter objects.

" - } - }, - "FilterValue": { - "base": null, - "refs": { - "Filter$Value": "

A value used with Name and Operator to determine which resources satisfy the filter's condition. For numerical properties, Value must be an integer or floating-point decimal. For timestamp properties, Value must be an ISO 8601 date-time string of the following format: YYYY-mm-dd'T'HH:MM:SS.

" - } - }, - "FinalAutoMLJobObjectiveMetric": { - "base": "

The best candidate result from an AutoML training job.

", - "refs": { - "AutoMLCandidate$FinalAutoMLJobObjectiveMetric": null - } - }, - "FinalHyperParameterTuningJobObjectiveMetric": { - "base": "

Shows the latest objective metric emitted by a training job that was launched by a hyperparameter tuning job. You define the objective metric in the HyperParameterTuningJobObjective parameter of HyperParameterTuningJobConfig.

", - "refs": { - "HyperParameterTrainingJobSummary$FinalHyperParameterTuningJobObjectiveMetric": "

The FinalHyperParameterTuningJobObjectiveMetric object that specifies the value of the objective metric of the tuning job that launched this training job.

" - } - }, - "FinalMetricDataList": { - "base": null, - "refs": { - "DescribeTrainingJobResponse$FinalMetricDataList": "

A collection of MetricData objects that specify the names, values, and dates and times that the training algorithm emitted to Amazon CloudWatch.

", - "TrainingJob$FinalMetricDataList": "

A list of final metric values that are set when the training job completes. Used only if the training job was configured to use metrics.

" - } - }, - "FlatInvocations": { - "base": null, - "refs": { - "RecommendationJobStoppingConditions$FlatInvocations": "

Stops a load test when the number of invocations (TPS) peaks and flattens, which means that the instance has reached capacity. The default value is Stop. If you want the load test to continue after invocations have flattened, set the value to Continue.

" - } - }, - "Float": { - "base": null, - "refs": { - "MetricData$Value": "

The value of the metric.

", - "MetricDatum$Value": "

The value of the metric.

", - "RecommendationMetrics$CostPerHour": "

Defines the cost per hour for the instance.

", - "RecommendationMetrics$CostPerInference": "

Defines the cost per inference for the instance .

" - } - }, - "FlowDefinitionArn": { - "base": null, - "refs": { - "CreateFlowDefinitionResponse$FlowDefinitionArn": "

The Amazon Resource Name (ARN) of the flow definition you create.

", - "DescribeFlowDefinitionResponse$FlowDefinitionArn": "

The Amazon Resource Name (ARN) of the flow defintion.

", - "FlowDefinitionSummary$FlowDefinitionArn": "

The Amazon Resource Name (ARN) of the flow definition.

" - } - }, - "FlowDefinitionName": { - "base": null, - "refs": { - "CreateFlowDefinitionRequest$FlowDefinitionName": "

The name of your flow definition.

", - "DeleteFlowDefinitionRequest$FlowDefinitionName": "

The name of the flow definition you are deleting.

", - "DescribeFlowDefinitionRequest$FlowDefinitionName": "

The name of the flow definition.

", - "DescribeFlowDefinitionResponse$FlowDefinitionName": "

The Amazon Resource Name (ARN) of the flow definition.

", - "FlowDefinitionSummary$FlowDefinitionName": "

The name of the flow definition.

" - } - }, - "FlowDefinitionOutputConfig": { - "base": "

Contains information about where human output will be stored.

", - "refs": { - "CreateFlowDefinitionRequest$OutputConfig": "

An object containing information about where the human review results will be uploaded.

", - "DescribeFlowDefinitionResponse$OutputConfig": "

An object containing information about the output file.

" - } - }, - "FlowDefinitionStatus": { - "base": null, - "refs": { - "DescribeFlowDefinitionResponse$FlowDefinitionStatus": "

The status of the flow definition. Valid values are listed below.

", - "FlowDefinitionSummary$FlowDefinitionStatus": "

The status of the flow definition. Valid values:

" - } - }, - "FlowDefinitionSummaries": { - "base": null, - "refs": { - "ListFlowDefinitionsResponse$FlowDefinitionSummaries": "

An array of objects describing the flow definitions.

" - } - }, - "FlowDefinitionSummary": { - "base": "

Contains summary information about the flow definition.

", - "refs": { - "FlowDefinitionSummaries$member": null - } - }, - "FlowDefinitionTaskAvailabilityLifetimeInSeconds": { - "base": null, - "refs": { - "HumanLoopConfig$TaskAvailabilityLifetimeInSeconds": "

The length of time that a task remains available for review by human workers.

" - } - }, - "FlowDefinitionTaskCount": { - "base": null, - "refs": { - "HumanLoopConfig$TaskCount": "

The number of distinct workers who will perform the same task on each object. For example, if TaskCount is set to 3 for an image classification labeling job, three workers will classify each input image. Increasing TaskCount can improve label accuracy.

" - } - }, - "FlowDefinitionTaskDescription": { - "base": null, - "refs": { - "HumanLoopConfig$TaskDescription": "

A description for the human worker task.

" - } - }, - "FlowDefinitionTaskKeyword": { - "base": null, - "refs": { - "FlowDefinitionTaskKeywords$member": null - } - }, - "FlowDefinitionTaskKeywords": { - "base": null, - "refs": { - "HumanLoopConfig$TaskKeywords": "

Keywords used to describe the task so that workers can discover the task.

" - } - }, - "FlowDefinitionTaskTimeLimitInSeconds": { - "base": null, - "refs": { - "HumanLoopConfig$TaskTimeLimitInSeconds": "

The amount of time that a worker has to complete a task. The default value is 3,600 seconds (1 hour).

" - } - }, - "FlowDefinitionTaskTitle": { - "base": null, - "refs": { - "HumanLoopConfig$TaskTitle": "

A title for the human worker task.

" - } - }, - "ForecastFrequency": { - "base": null, - "refs": { - "TimeSeriesForecastingJobConfig$ForecastFrequency": "

The frequency of predictions in a forecast.

Valid intervals are an integer followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min (Minute). For example, 1D indicates every day and 15min indicates every 15 minutes. The value of a frequency must not overlap with the next larger frequency. For example, you must use a frequency of 1H instead of 60min.

The valid values for each frequency are the following:

  • Minute - 1-59

  • Hour - 1-23

  • Day - 1-6

  • Week - 1-4

  • Month - 1-11

  • Year - 1

" - } - }, - "ForecastHorizon": { - "base": null, - "refs": { - "TimeSeriesForecastingJobConfig$ForecastHorizon": "

The number of time-steps that the model predicts. The forecast horizon is also called the prediction length. The maximum forecast horizon is the lesser of 500 time-steps or 1/4 of the time-steps in the dataset.

" - } - }, - "ForecastQuantile": { - "base": null, - "refs": { - "ForecastQuantiles$member": null - } - }, - "ForecastQuantiles": { - "base": null, - "refs": { - "TimeSeriesForecastingJobConfig$ForecastQuantiles": "

The quantiles used to train the model for forecasts at a specified quantile. You can specify quantiles from 0.01 (p1) to 0.99 (p99), by increments of 0.01 or higher. Up to five forecast quantiles can be specified. When ForecastQuantiles is not provided, the AutoML job uses the quantiles p10, p50, and p90 as default.

" - } - }, - "Framework": { - "base": null, - "refs": { - "InputConfig$Framework": "

Identifies the framework in which the model was trained. For example: TENSORFLOW.

" - } - }, - "FrameworkVersion": { - "base": null, - "refs": { - "InputConfig$FrameworkVersion": "

Specifies the framework version to use. This API field is only supported for the MXNet, PyTorch, TensorFlow and TensorFlow Lite frameworks.

For information about framework versions supported for cloud targets and edge devices, see Cloud Supported Instance Types and Frameworks and Edge Supported Frameworks.

" - } - }, - "GenerateCandidateDefinitionsOnly": { - "base": null, - "refs": { - "CreateAutoMLJobRequest$GenerateCandidateDefinitionsOnly": "

Generates possible candidates without training the models. A candidate is a combination of data preprocessors, algorithms, and algorithm parameter settings.

", - "DescribeAutoMLJobResponse$GenerateCandidateDefinitionsOnly": "

Indicates whether the output for an AutoML job generates candidate definitions only.

", - "TabularJobConfig$GenerateCandidateDefinitionsOnly": "

Generates possible candidates without training the models. A model candidate is a combination of data preprocessors, algorithms, and algorithm parameter settings.

" - } - }, - "GenerativeAiSettings": { - "base": "

The generative AI settings for the SageMaker Canvas application.

Configure these settings for Canvas users starting chats with generative AI foundation models. For more information, see Use generative AI with foundation models.

", - "refs": { - "CanvasAppSettings$GenerativeAiSettings": "

The generative AI settings for the SageMaker Canvas application.

" - } - }, - "GetDeviceFleetReportRequest": { - "base": null, - "refs": {} - }, - "GetDeviceFleetReportResponse": { - "base": null, - "refs": {} - }, - "GetLineageGroupPolicyRequest": { - "base": null, - "refs": {} - }, - "GetLineageGroupPolicyResponse": { - "base": null, - "refs": {} - }, - "GetModelPackageGroupPolicyInput": { - "base": null, - "refs": {} - }, - "GetModelPackageGroupPolicyOutput": { - "base": null, - "refs": {} - }, - "GetSagemakerServicecatalogPortfolioStatusInput": { - "base": null, - "refs": {} - }, - "GetSagemakerServicecatalogPortfolioStatusOutput": { - "base": null, - "refs": {} - }, - "GetScalingConfigurationRecommendationRequest": { - "base": null, - "refs": {} - }, - "GetScalingConfigurationRecommendationResponse": { - "base": null, - "refs": {} - }, - "GetSearchSuggestionsRequest": { - "base": null, - "refs": {} - }, - "GetSearchSuggestionsResponse": { - "base": null, - "refs": {} - }, - "Gid": { - "base": null, - "refs": { - "CustomPosixUserConfig$Gid": "

The POSIX group ID.

" - } - }, - "GitConfig": { - "base": "

Specifies configuration details for a Git repository in your Amazon Web Services account.

", - "refs": { - "CodeRepositorySummary$GitConfig": "

Configuration details for the Git repository, including the URL where it is located and the ARN of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the repository.

", - "CreateCodeRepositoryInput$GitConfig": "

Specifies details about the repository, including the URL where the repository is located, the default branch, and credentials to use to access the repository.

", - "DescribeCodeRepositoryOutput$GitConfig": "

Configuration details about the repository, including the URL where the repository is located, the default branch, and the Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the repository.

" - } - }, - "GitConfigForUpdate": { - "base": "

Specifies configuration details for a Git repository when the repository is updated.

", - "refs": { - "UpdateCodeRepositoryInput$GitConfig": "

The configuration of the git repository, including the URL and the Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the repository. The secret must have a staging label of AWSCURRENT and must be in the following format:

{\"username\": UserName, \"password\": Password}

" - } - }, - "GitConfigUrl": { - "base": null, - "refs": { - "GitConfig$RepositoryUrl": "

The URL where the Git repository is located.

" - } - }, - "Group": { - "base": null, - "refs": { - "Groups$member": null - } - }, - "GroupNamePattern": { - "base": null, - "refs": { - "AssignedGroupPatternsList$member": null, - "GroupPatternsList$member": null - } - }, - "GroupPatternsList": { - "base": null, - "refs": { - "RoleGroupAssignment$GroupPatterns": "

A list of Amazon Web Services IAM Identity Center group patterns that should be assigned to the specified role. Group patterns support wildcard matching using *.

" - } - }, - "GroupingAttributeName": { - "base": null, - "refs": { - "GroupingAttributeNames$member": null - } - }, - "GroupingAttributeNames": { - "base": null, - "refs": { - "TimeSeriesConfig$GroupingAttributeNames": "

A set of columns names that can be grouped with the item identifier column to create a composite key for which a target value is predicted.

" - } - }, - "Groups": { - "base": null, - "refs": { - "OidcMemberDefinition$Groups": "

A list of comma seperated strings that identifies user groups in your OIDC IdP. Each user group is made up of a group of private workers.

" - } - }, - "HiddenAppTypesList": { - "base": null, - "refs": { - "StudioWebPortalSettings$HiddenAppTypes": "

The Applications supported in Studio that are hidden from the Studio left navigation pane.

" - } - }, - "HiddenInstanceTypesList": { - "base": null, - "refs": { - "StudioWebPortalSettings$HiddenInstanceTypes": "

The instance types you are hiding from the Studio user interface.

" - } - }, - "HiddenMlToolsList": { - "base": null, - "refs": { - "StudioWebPortalSettings$HiddenMlTools": "

The machine learning tools that are hidden from the Studio left navigation pane.

" - } - }, - "HiddenSageMakerImage": { - "base": "

The SageMaker images that are hidden from the Studio user interface. You must specify the SageMaker image name and version aliases.

", - "refs": { - "HiddenSageMakerImageVersionAliasesList$member": null - } - }, - "HiddenSageMakerImageVersionAliasesList": { - "base": null, - "refs": { - "StudioWebPortalSettings$HiddenSageMakerImageVersionAliases": "

The version aliases you are hiding from the Studio user interface.

" - } - }, - "HolidayConfig": { - "base": null, - "refs": { - "TimeSeriesForecastingJobConfig$HolidayConfig": "

The collection of holiday featurization attributes used to incorporate national holiday information into your forecasting model.

" - } - }, - "HolidayConfigAttributes": { - "base": "

Stores the holiday featurization attributes applicable to each item of time-series datasets during the training of a forecasting model. This allows the model to identify patterns associated with specific holidays.

", - "refs": { - "HolidayConfig$member": null - } - }, - "HomeEfsFileSystemCreation": { - "base": "

Indicates whether a home EFS file system is created for the domain.

", - "refs": { - "CreateDomainRequest$HomeEfsFileSystemCreation": "

Indicates whether to create a home EFS file system for the domain. Defaults to Enabled. Set to Disabled to skip EFS creation and reduce domain creation time. You can enable EFS later by calling UpdateDomain.

", - "DescribeDomainResponse$HomeEfsFileSystemCreation": "

Indicates whether a home EFS file system is created for the domain.

", - "UpdateDomainRequest$HomeEfsFileSystemCreation": "

Indicates whether to create a home EFS file system for the domain. You can change from Disabled to Enabled to provision EFS on demand, but you cannot change from Enabled to Disabled.

" - } - }, - "HookParameters": { - "base": null, - "refs": { - "DebugHookConfig$HookParameters": "

Configuration information for the Amazon SageMaker Debugger hook parameters.

" - } - }, - "Horovod": { - "base": null, - "refs": { - "CreateImageVersionRequest$Horovod": "

Indicates Horovod compatibility.

", - "DescribeImageVersionResponse$Horovod": "

Indicates Horovod compatibility.

", - "UpdateImageVersionRequest$Horovod": "

Indicates Horovod compatibility.

" - } - }, - "HubAccessConfig": { - "base": "

The configuration for a private hub model reference that points to a public SageMaker JumpStart model.

For more information about private hubs, see Private curated hubs for foundation model access control in JumpStart.

", - "refs": { - "S3DataSource$HubAccessConfig": "

The configuration for a private hub model reference that points to a SageMaker JumpStart public hub model.

" - } - }, - "HubArn": { - "base": null, - "refs": { - "CreateHubContentReferenceResponse$HubArn": "

The ARN of the hub that the hub content reference was added to.

", - "CreateHubResponse$HubArn": "

The Amazon Resource Name (ARN) of the hub.

", - "DescribeHubContentResponse$HubArn": "

The Amazon Resource Name (ARN) of the hub that contains the content.

", - "DescribeHubResponse$HubArn": "

The Amazon Resource Name (ARN) of the hub.

", - "HubInfo$HubArn": "

The Amazon Resource Name (ARN) of the hub.

", - "ImportHubContentResponse$HubArn": "

The ARN of the hub that the content was imported into.

", - "UpdateHubContentReferenceResponse$HubArn": "

The ARN of the private model hub that contains the updated hub content.

", - "UpdateHubContentResponse$HubArn": "

The ARN of the private model hub that contains the updated hub content.

", - "UpdateHubResponse$HubArn": "

The Amazon Resource Name (ARN) of the updated hub.

" - } - }, - "HubContentArn": { - "base": null, - "refs": { - "CreateHubContentReferenceResponse$HubContentArn": "

The ARN of the hub content.

", - "DescribeHubContentResponse$HubContentArn": "

The Amazon Resource Name (ARN) of the hub content.

", - "HubAccessConfig$HubContentArn": "

The ARN of your private model hub content. This should be a ModelReference resource type that points to a SageMaker JumpStart public hub model.

", - "HubContentInfo$HubContentArn": "

The Amazon Resource Name (ARN) of the hub content.

", - "ImportHubContentResponse$HubContentArn": "

The ARN of the hub content that was imported.

", - "InferenceHubAccessConfig$HubContentArn": "

The ARN of the hub content for which deployment access is allowed.

", - "UpdateHubContentReferenceResponse$HubContentArn": "

The ARN of the hub content resource that was updated.

", - "UpdateHubContentResponse$HubContentArn": "

The ARN of the hub content resource that was updated.

" - } - }, - "HubContentDependency": { - "base": "

Any dependencies related to hub content, such as scripts, model artifacts, datasets, or notebooks.

", - "refs": { - "HubContentDependencyList$member": null - } - }, - "HubContentDependencyList": { - "base": null, - "refs": { - "DescribeHubContentResponse$HubContentDependencies": "

The location of any dependencies that the hub content has, such as scripts, model artifacts, datasets, or notebooks.

" - } - }, - "HubContentDescription": { - "base": null, - "refs": { - "DescribeHubContentResponse$HubContentDescription": "

A description of the hub content.

", - "HubContentInfo$HubContentDescription": "

A description of the hub content.

", - "ImportHubContentRequest$HubContentDescription": "

A description of the hub content to import.

", - "UpdateHubContentRequest$HubContentDescription": "

The description of the hub content.

" - } - }, - "HubContentDisplayName": { - "base": null, - "refs": { - "DescribeHubContentResponse$HubContentDisplayName": "

The display name of the hub content.

", - "HubContentInfo$HubContentDisplayName": "

The display name of the hub content.

", - "ImportHubContentRequest$HubContentDisplayName": "

The display name of the hub content to import.

", - "UpdateHubContentRequest$HubContentDisplayName": "

The display name of the hub content.

" - } - }, - "HubContentDocument": { - "base": null, - "refs": { - "DescribeHubContentResponse$HubContentDocument": "

The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.

", - "ImportHubContentRequest$HubContentDocument": "

The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.

" - } - }, - "HubContentInfo": { - "base": "

Information about hub content.

", - "refs": { - "HubContentInfoList$member": null - } - }, - "HubContentInfoList": { - "base": null, - "refs": { - "ListHubContentVersionsResponse$HubContentSummaries": "

The summaries of the listed hub content versions.

", - "ListHubContentsResponse$HubContentSummaries": "

The summaries of the listed hub content.

" - } - }, - "HubContentMarkdown": { - "base": null, - "refs": { - "DescribeHubContentResponse$HubContentMarkdown": "

A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.

", - "ImportHubContentRequest$HubContentMarkdown": "

A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.

", - "UpdateHubContentRequest$HubContentMarkdown": "

A string that provides a description of the hub content. This string can include links, tables, and standard markdown formatting.

" - } - }, - "HubContentName": { - "base": null, - "refs": { - "BaseModel$HubContentName": "

The hub content name of the base model.

", - "CreateHubContentPresignedUrlsRequest$HubContentName": "

The name of the hub content for which to generate presigned URLs. This identifies the specific model or content within the hub.

", - "CreateHubContentReferenceRequest$HubContentName": "

The name of the hub content to reference.

", - "DeleteHubContentReferenceRequest$HubContentName": "

The name of the hub content to delete.

", - "DeleteHubContentRequest$HubContentName": "

The name of the content that you want to delete from a hub.

", - "DescribeHubContentRequest$HubContentName": "

The name of the content to describe.

", - "DescribeHubContentResponse$HubContentName": "

The name of the hub content.

", - "HubContentInfo$HubContentName": "

The name of the hub content.

", - "ImportHubContentRequest$HubContentName": "

The name of the hub content to import.

", - "ListHubContentVersionsRequest$HubContentName": "

The name of the hub content.

", - "UpdateHubContentReferenceRequest$HubContentName": "

The name of the hub content resource that you want to update.

", - "UpdateHubContentRequest$HubContentName": "

The name of the hub content resource that you want to update.

" - } - }, - "HubContentSearchKeyword": { - "base": null, - "refs": { - "HubContentSearchKeywordList$member": null - } - }, - "HubContentSearchKeywordList": { - "base": null, - "refs": { - "DescribeHubContentResponse$HubContentSearchKeywords": "

The searchable keywords for the hub content.

", - "HubContentInfo$HubContentSearchKeywords": "

The searchable keywords for the hub content.

", - "ImportHubContentRequest$HubContentSearchKeywords": "

The searchable keywords of the hub content.

", - "UpdateHubContentRequest$HubContentSearchKeywords": "

The searchable keywords of the hub content.

" - } - }, - "HubContentSortBy": { - "base": null, - "refs": { - "ListHubContentVersionsRequest$SortBy": "

Sort hub content versions by either name or creation time.

", - "ListHubContentsRequest$SortBy": "

Sort hub content versions by either name or creation time.

" - } - }, - "HubContentStatus": { - "base": null, - "refs": { - "DescribeHubContentResponse$HubContentStatus": "

The status of the hub content.

", - "HubContentInfo$HubContentStatus": "

The status of the hub content.

" - } - }, - "HubContentSupportStatus": { - "base": null, - "refs": { - "DescribeHubContentResponse$SupportStatus": "

The support status of the hub content.

", - "HubContentInfo$SupportStatus": "

The support status of the hub content.

", - "ImportHubContentRequest$SupportStatus": "

The status of the hub content resource.

", - "UpdateHubContentRequest$SupportStatus": "

Indicates the current status of the hub content resource.

" - } - }, - "HubContentType": { - "base": null, - "refs": { - "CreateHubContentPresignedUrlsRequest$HubContentType": "

The type of hub content to access. Valid values include Model, Notebook, and ModelReference.

", - "DeleteHubContentReferenceRequest$HubContentType": "

The type of hub content reference to delete. The only supported type of hub content reference to delete is ModelReference.

", - "DeleteHubContentRequest$HubContentType": "

The type of content that you want to delete from a hub.

", - "DescribeHubContentRequest$HubContentType": "

The type of content in the hub.

", - "DescribeHubContentResponse$HubContentType": "

The type of hub content.

", - "HubContentInfo$HubContentType": "

The type of hub content.

", - "ImportHubContentRequest$HubContentType": "

The type of hub content to import.

", - "ListHubContentVersionsRequest$HubContentType": "

The type of hub content to list versions of.

", - "ListHubContentsRequest$HubContentType": "

The type of hub content to list.

", - "UpdateHubContentReferenceRequest$HubContentType": "

The content type of the resource that you want to update. Only specify a ModelReference resource for this API. To update a Model or Notebook resource, use the UpdateHubContent API instead.

", - "UpdateHubContentRequest$HubContentType": "

The content type of the resource that you want to update. Only specify a Model or Notebook resource for this API. To update a ModelReference, use the UpdateHubContentReference API instead.

" - } - }, - "HubContentVersion": { - "base": null, - "refs": { - "BaseModel$HubContentVersion": "

The hub content version of the base model.

", - "CreateHubContentPresignedUrlsRequest$HubContentVersion": "

The version of the hub content. If not specified, the latest version is used.

", - "CreateHubContentReferenceRequest$MinVersion": "

The minimum version of the hub content to reference.

", - "DeleteHubContentRequest$HubContentVersion": "

The version of the content that you want to delete from a hub.

", - "DescribeHubContentRequest$HubContentVersion": "

The version of the content to describe.

", - "DescribeHubContentResponse$HubContentVersion": "

The version of the hub content.

", - "HubContentInfo$HubContentVersion": "

The version of the hub content.

", - "ImportHubContentRequest$HubContentVersion": "

The version of the hub content to import.

", - "ListHubContentVersionsRequest$MinVersion": "

The lower bound of the hub content versions to list.

", - "UpdateHubContentReferenceRequest$MinVersion": "

The minimum hub content version of the referenced model that you want to use. The minimum version must be older than the latest available version of the referenced model. To support all versions of a model, set the value to 1.0.0.

", - "UpdateHubContentRequest$HubContentVersion": "

The hub content version that you want to update. For example, if you have two versions of a resource in your hub, you can update the second version.

" - } - }, - "HubDataSetArn": { - "base": null, - "refs": { - "DatasetSource$DatasetArn": "

The Amazon Resource Name (ARN) of the dataset resource.

" - } - }, - "HubDescription": { - "base": null, - "refs": { - "CreateHubRequest$HubDescription": "

A description of the hub.

", - "DescribeHubResponse$HubDescription": "

A description of the hub.

", - "HubInfo$HubDescription": "

A description of the hub.

", - "UpdateHubRequest$HubDescription": "

A description of the updated hub.

" - } - }, - "HubDisplayName": { - "base": null, - "refs": { - "CreateHubRequest$HubDisplayName": "

The display name of the hub.

", - "DescribeHubResponse$HubDisplayName": "

The display name of the hub.

", - "HubInfo$HubDisplayName": "

The display name of the hub.

", - "UpdateHubRequest$HubDisplayName": "

The display name of the hub.

" - } - }, - "HubInfo": { - "base": "

Information about a hub.

", - "refs": { - "HubInfoList$member": null - } - }, - "HubInfoList": { - "base": null, - "refs": { - "ListHubsResponse$HubSummaries": "

The summaries of the listed hubs.

" - } - }, - "HubName": { - "base": null, - "refs": { - "CreateHubRequest$HubName": "

The name of the hub to create.

", - "DescribeHubContentResponse$HubName": "

The name of the hub that contains the content.

", - "DescribeHubResponse$HubName": "

The name of the hub.

", - "HubInfo$HubName": "

The name of the hub.

" - } - }, - "HubNameOrArn": { - "base": null, - "refs": { - "CreateHubContentPresignedUrlsRequest$HubName": "

The name or Amazon Resource Name (ARN) of the hub that contains the content. For public content, use SageMakerPublicHub.

", - "CreateHubContentReferenceRequest$HubName": "

The name of the hub to add the hub content reference to.

", - "DeleteHubContentReferenceRequest$HubName": "

The name of the hub to delete the hub content reference from.

", - "DeleteHubContentRequest$HubName": "

The name of the hub that you want to delete content in.

", - "DeleteHubRequest$HubName": "

The name of the hub to delete.

", - "DescribeHubContentRequest$HubName": "

The name of the hub that contains the content to describe.

", - "DescribeHubRequest$HubName": "

The name of the hub to describe.

", - "ImportHubContentRequest$HubName": "

The name of the hub to import content into.

", - "ListHubContentVersionsRequest$HubName": "

The name of the hub to list the content versions of.

", - "ListHubContentsRequest$HubName": "

The name of the hub to list the contents of.

", - "UpdateHubContentReferenceRequest$HubName": "

The name of the SageMaker hub that contains the hub content you want to update. You can optionally use the hub ARN instead.

", - "UpdateHubContentRequest$HubName": "

The name of the SageMaker hub that contains the hub content you want to update. You can optionally use the hub ARN instead.

", - "UpdateHubRequest$HubName": "

The name of the hub to update.

" - } - }, - "HubS3StorageConfig": { - "base": "

The Amazon S3 storage configuration of a hub.

", - "refs": { - "CreateHubRequest$S3StorageConfig": "

The Amazon S3 storage configuration for the hub.

", - "DescribeHubResponse$S3StorageConfig": "

The Amazon S3 storage configuration for the hub.

" - } - }, - "HubSearchKeyword": { - "base": null, - "refs": { - "HubSearchKeywordList$member": null - } - }, - "HubSearchKeywordList": { - "base": null, - "refs": { - "CreateHubRequest$HubSearchKeywords": "

The searchable keywords for the hub.

", - "DescribeHubResponse$HubSearchKeywords": "

The searchable keywords for the hub.

", - "HubInfo$HubSearchKeywords": "

The searchable keywords for the hub.

", - "UpdateHubRequest$HubSearchKeywords": "

The searchable keywords for the hub.

" - } - }, - "HubSortBy": { - "base": null, - "refs": { - "ListHubsRequest$SortBy": "

Sort hubs by either name or creation time.

" - } - }, - "HubStatus": { - "base": null, - "refs": { - "DescribeHubResponse$HubStatus": "

The status of the hub.

", - "HubInfo$HubStatus": "

The status of the hub.

" - } - }, - "HumanLoopActivationConditions": { - "base": null, - "refs": { - "HumanLoopActivationConditionsConfig$HumanLoopActivationConditions": "

JSON expressing use-case specific conditions declaratively. If any condition is matched, atomic tasks are created against the configured work team. The set of conditions is different for Rekognition and Textract. For more information about how to structure the JSON, see JSON Schema for Human Loop Activation Conditions in Amazon Augmented AI in the Amazon SageMaker Developer Guide.

" - } - }, - "HumanLoopActivationConditionsConfig": { - "base": "

Defines under what conditions SageMaker creates a human loop. Used within CreateFlowDefinition. See HumanLoopActivationConditionsConfig for the required format of activation conditions.

", - "refs": { - "HumanLoopActivationConfig$HumanLoopActivationConditionsConfig": "

Container structure for defining under what conditions SageMaker creates a human loop.

" - } - }, - "HumanLoopActivationConfig": { - "base": "

Provides information about how and under what conditions SageMaker creates a human loop. If HumanLoopActivationConfig is not given, then all requests go to humans.

", - "refs": { - "CreateFlowDefinitionRequest$HumanLoopActivationConfig": "

An object containing information about the events that trigger a human workflow.

", - "DescribeFlowDefinitionResponse$HumanLoopActivationConfig": "

An object containing information about what triggers a human review workflow.

" - } - }, - "HumanLoopConfig": { - "base": "

Describes the work to be performed by human workers.

", - "refs": { - "CreateFlowDefinitionRequest$HumanLoopConfig": "

An object containing information about the tasks the human reviewers will perform.

", - "DescribeFlowDefinitionResponse$HumanLoopConfig": "

An object containing information about who works on the task, the workforce task price, and other task details.

" - } - }, - "HumanLoopRequestSource": { - "base": "

Container for configuring the source of human task requests.

", - "refs": { - "CreateFlowDefinitionRequest$HumanLoopRequestSource": "

Container for configuring the source of human task requests. Use to specify if Amazon Rekognition or Amazon Textract is used as an integration source.

", - "DescribeFlowDefinitionResponse$HumanLoopRequestSource": "

Container for configuring the source of human task requests. Used to specify if Amazon Rekognition or Amazon Textract is used as an integration source.

" - } - }, - "HumanTaskConfig": { - "base": "

Information required for human workers to complete a labeling task.

", - "refs": { - "CreateLabelingJobRequest$HumanTaskConfig": "

Configures the labeling task and how it is presented to workers; including, but not limited to price, keywords, and batch size (task count).

", - "DescribeLabelingJobResponse$HumanTaskConfig": "

Configuration information required for human workers to complete a labeling task.

" - } - }, - "HumanTaskUiArn": { - "base": null, - "refs": { - "CreateHumanTaskUiResponse$HumanTaskUiArn": "

The Amazon Resource Name (ARN) of the human review workflow user interface you create.

", - "DescribeHumanTaskUiResponse$HumanTaskUiArn": "

The Amazon Resource Name (ARN) of the human task user interface (worker task template).

", - "HumanLoopConfig$HumanTaskUiArn": "

The Amazon Resource Name (ARN) of the human task user interface.

You can use standard HTML and Crowd HTML Elements to create a custom worker task template. You use this template to create a human task UI.

To learn how to create a custom HTML template, see Create Custom Worker Task Template.

To learn how to create a human task UI, which is a worker task template that can be used in a flow definition, see Create and Delete a Worker Task Templates.

", - "HumanTaskUiSummary$HumanTaskUiArn": "

The Amazon Resource Name (ARN) of the human task user interface.

", - "RenderUiTemplateRequest$HumanTaskUiArn": "

The HumanTaskUiArn of the worker UI that you want to render. Do not provide a HumanTaskUiArn if you use the UiTemplate parameter.

See a list of available Human Ui Amazon Resource Names (ARNs) in UiConfig.

", - "UiConfig$HumanTaskUiArn": "

The ARN of the worker task template used to render the worker UI and tools for labeling job tasks.

Use this parameter when you are creating a labeling job for named entity recognition, 3D point cloud and video frame labeling jobs. Use your labeling job task type to select one of the following ARNs and use it with this parameter when you create a labeling job. Replace aws-region with the Amazon Web Services Region you are creating your labeling job in. For example, replace aws-region with us-west-1 if you create a labeling job in US West (N. California).

Named Entity Recognition

Use the following HumanTaskUiArn for named entity recognition labeling jobs:

arn:aws:sagemaker:aws-region:394669845002:human-task-ui/NamedEntityRecognition

3D Point Cloud HumanTaskUiArns

Use this HumanTaskUiArn for 3D point cloud object detection and 3D point cloud object detection adjustment labeling jobs.

  • arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectDetection

Use this HumanTaskUiArn for 3D point cloud object tracking and 3D point cloud object tracking adjustment labeling jobs.

  • arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectTracking

Use this HumanTaskUiArn for 3D point cloud semantic segmentation and 3D point cloud semantic segmentation adjustment labeling jobs.

  • arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudSemanticSegmentation

Video Frame HumanTaskUiArns

Use this HumanTaskUiArn for video frame object detection and video frame object detection adjustment labeling jobs.

  • arn:aws:sagemaker:region:394669845002:human-task-ui/VideoObjectDetection

Use this HumanTaskUiArn for video frame object tracking and video frame object tracking adjustment labeling jobs.

  • arn:aws:sagemaker:aws-region:394669845002:human-task-ui/VideoObjectTracking

" - } - }, - "HumanTaskUiName": { - "base": null, - "refs": { - "CreateHumanTaskUiRequest$HumanTaskUiName": "

The name of the user interface you are creating.

", - "DeleteHumanTaskUiRequest$HumanTaskUiName": "

The name of the human task user interface (work task template) you want to delete.

", - "DescribeHumanTaskUiRequest$HumanTaskUiName": "

The name of the human task user interface (worker task template) you want information about.

", - "DescribeHumanTaskUiResponse$HumanTaskUiName": "

The name of the human task user interface (worker task template).

", - "HumanTaskUiSummary$HumanTaskUiName": "

The name of the human task user interface.

" - } - }, - "HumanTaskUiStatus": { - "base": null, - "refs": { - "DescribeHumanTaskUiResponse$HumanTaskUiStatus": "

The status of the human task user interface (worker task template). Valid values are listed below.

" - } - }, - "HumanTaskUiSummaries": { - "base": null, - "refs": { - "ListHumanTaskUisResponse$HumanTaskUiSummaries": "

An array of objects describing the human task user interfaces.

" - } - }, - "HumanTaskUiSummary": { - "base": "

Container for human task user interface information.

", - "refs": { - "HumanTaskUiSummaries$member": null - } - }, - "HyperParameterAlgorithmSpecification": { - "base": "

Specifies which training algorithm to use for training jobs that a hyperparameter tuning job launches and the metrics to monitor.

", - "refs": { - "HyperParameterTrainingJobDefinition$AlgorithmSpecification": "

The HyperParameterAlgorithmSpecification object that specifies the resource algorithm to use for the training jobs that the tuning job launches.

" - } - }, - "HyperParameterKey": { - "base": null, - "refs": { - "HyperParameters$key": null - } - }, - "HyperParameterScalingType": { - "base": null, - "refs": { - "ContinuousParameterRange$ScalingType": "

The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

Auto

SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.

Linear

Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

Logarithmic

Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.

Logarithmic scaling works only for ranges that have only values greater than 0.

ReverseLogarithmic

Hyperparameter tuning searches the values in the hyperparameter range by using a reverse logarithmic scale.

Reverse logarithmic scaling works only for ranges that are entirely within the range 0<=x<1.0.

", - "IntegerParameterRange$ScalingType": "

The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

Auto

SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.

Linear

Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

Logarithmic

Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.

Logarithmic scaling works only for ranges that have only values greater than 0.

" - } - }, - "HyperParameterSpecification": { - "base": "

Defines a hyperparameter to be used by an algorithm.

", - "refs": { - "HyperParameterSpecifications$member": null - } - }, - "HyperParameterSpecifications": { - "base": null, - "refs": { - "TrainingSpecification$SupportedHyperParameters": "

A list of the HyperParameterSpecification objects, that define the supported hyperparameters. This is required if the algorithm supports automatic model tuning.>

" - } - }, - "HyperParameterTrainingJobDefinition": { - "base": "

Defines the training jobs launched by a hyperparameter tuning job.

", - "refs": { - "CreateHyperParameterTuningJobRequest$TrainingJobDefinition": "

The HyperParameterTrainingJobDefinition object that describes the training jobs that this tuning job launches, including static hyperparameters, input data configuration, output data configuration, resource configuration, and stopping condition.

", - "DescribeHyperParameterTuningJobResponse$TrainingJobDefinition": "

The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.

", - "HyperParameterTrainingJobDefinitions$member": null, - "HyperParameterTuningJobSearchEntity$TrainingJobDefinition": null - } - }, - "HyperParameterTrainingJobDefinitionName": { - "base": null, - "refs": { - "HyperParameterTrainingJobDefinition$DefinitionName": "

The job definition name.

", - "HyperParameterTrainingJobSummary$TrainingJobDefinitionName": "

The training job definition name.

" - } - }, - "HyperParameterTrainingJobDefinitions": { - "base": null, - "refs": { - "CreateHyperParameterTuningJobRequest$TrainingJobDefinitions": "

A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.

", - "DescribeHyperParameterTuningJobResponse$TrainingJobDefinitions": "

A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.

", - "HyperParameterTuningJobSearchEntity$TrainingJobDefinitions": "

The job definitions included in a hyperparameter tuning job.

" - } - }, - "HyperParameterTrainingJobEnvironmentKey": { - "base": null, - "refs": { - "HyperParameterTrainingJobEnvironmentMap$key": null - } - }, - "HyperParameterTrainingJobEnvironmentMap": { - "base": null, - "refs": { - "HyperParameterTrainingJobDefinition$Environment": "

An environment variable that you can pass into the SageMaker CreateTrainingJob API. You can use an existing environment variable from the training container or use your own. See Define metrics and variables for more information.

The maximum number of items specified for Map Entries refers to the maximum number of environment variables for each TrainingJobDefinition and also the maximum for the hyperparameter tuning job itself. That is, the sum of the number of environment variables for all the training job definitions can't exceed the maximum number specified.

" - } - }, - "HyperParameterTrainingJobEnvironmentValue": { - "base": null, - "refs": { - "HyperParameterTrainingJobEnvironmentMap$value": null - } - }, - "HyperParameterTrainingJobSummaries": { - "base": null, - "refs": { - "ListTrainingJobsForHyperParameterTuningJobResponse$TrainingJobSummaries": "

A list of TrainingJobSummary objects that describe the training jobs that the ListTrainingJobsForHyperParameterTuningJob request returned.

" - } - }, - "HyperParameterTrainingJobSummary": { - "base": "

The container for the summary information about a training job.

", - "refs": { - "DescribeHyperParameterTuningJobResponse$BestTrainingJob": "

A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.

", - "DescribeHyperParameterTuningJobResponse$OverallBestTrainingJob": "

If the hyperparameter tuning job is an warm start tuning job with a WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the TrainingJobSummary for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job.

", - "HyperParameterTrainingJobSummaries$member": null, - "HyperParameterTuningJobSearchEntity$BestTrainingJob": null, - "HyperParameterTuningJobSearchEntity$OverallBestTrainingJob": null - } - }, - "HyperParameterTuningAllocationStrategy": { - "base": null, - "refs": { - "HyperParameterTuningResourceConfig$AllocationStrategy": "

The strategy that determines the order of preference for resources specified in InstanceConfigs used in hyperparameter optimization.

" - } - }, - "HyperParameterTuningInstanceConfig": { - "base": "

The configuration for hyperparameter tuning resources for use in training jobs launched by the tuning job. These resources include compute instances and storage volumes. Specify one or more compute instance configurations and allocation strategies to select resources (optional).

", - "refs": { - "HyperParameterTuningInstanceConfigs$member": null - } - }, - "HyperParameterTuningInstanceConfigs": { - "base": null, - "refs": { - "HyperParameterTuningResourceConfig$InstanceConfigs": "

A list containing the configuration(s) for one or more resources for processing hyperparameter jobs. These resources include compute instances and storage volumes to use in model training jobs launched by hyperparameter tuning jobs. The AllocationStrategy controls the order in which multiple configurations provided in InstanceConfigs are used.

If you only want to use a single instance configuration inside the HyperParameterTuningResourceConfig API, do not provide a value for InstanceConfigs. Instead, use InstanceType, VolumeSizeInGB and InstanceCount. If you use InstanceConfigs, do not provide values for InstanceType, VolumeSizeInGB or InstanceCount.

" - } - }, - "HyperParameterTuningJobArn": { - "base": null, - "refs": { - "CreateHyperParameterTuningJobResponse$HyperParameterTuningJobArn": "

The Amazon Resource Name (ARN) of the tuning job. SageMaker assigns an ARN to a hyperparameter tuning job when you create it.

", - "DescribeHyperParameterTuningJobResponse$HyperParameterTuningJobArn": "

The Amazon Resource Name (ARN) of the tuning job.

", - "DescribeTrainingJobResponse$TuningJobArn": "

The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.

", - "HyperParameterTuningJobSearchEntity$HyperParameterTuningJobArn": "

The Amazon Resource Name (ARN) of a hyperparameter tuning job.

", - "HyperParameterTuningJobSummary$HyperParameterTuningJobArn": "

The Amazon Resource Name (ARN) of the tuning job.

", - "TrainingJob$TuningJobArn": "

The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.

", - "TuningJobStepMetaData$Arn": "

The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.

" - } - }, - "HyperParameterTuningJobCompletionDetails": { - "base": "

A structure that contains runtime information about both current and completed hyperparameter tuning jobs.

", - "refs": { - "DescribeHyperParameterTuningJobResponse$TuningJobCompletionDetails": "

Tuning job completion information returned as the response from a hyperparameter tuning job. This information tells if your tuning job has or has not converged. It also includes the number of training jobs that have not improved model performance as evaluated against the objective function.

", - "HyperParameterTuningJobSearchEntity$TuningJobCompletionDetails": "

Information about either a current or completed hyperparameter tuning job.

" - } - }, - "HyperParameterTuningJobConfig": { - "base": "

Configures a hyperparameter tuning job.

", - "refs": { - "CreateHyperParameterTuningJobRequest$HyperParameterTuningJobConfig": "

The HyperParameterTuningJobConfig object that describes the tuning job, including the search strategy, the objective metric used to evaluate training jobs, ranges of parameters to search, and resource limits for the tuning job. For more information, see How Hyperparameter Tuning Works.

", - "DescribeHyperParameterTuningJobResponse$HyperParameterTuningJobConfig": "

The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.

", - "HyperParameterTuningJobSearchEntity$HyperParameterTuningJobConfig": null - } - }, - "HyperParameterTuningJobConsumedResources": { - "base": "

The total resources consumed by your hyperparameter tuning job.

", - "refs": { - "DescribeHyperParameterTuningJobResponse$ConsumedResources": null, - "HyperParameterTuningJobSearchEntity$ConsumedResources": "

The total amount of resources consumed by a hyperparameter tuning job.

" - } - }, - "HyperParameterTuningJobName": { - "base": null, - "refs": { - "CreateHyperParameterTuningJobRequest$HyperParameterTuningJobName": "

The name of the tuning job. This name is the prefix for the names of all training jobs that this tuning job launches. The name must be unique within the same Amazon Web Services account and Amazon Web Services Region. The name must have 1 to 32 characters. Valid characters are a-z, A-Z, 0-9, and : + = @ _ % - (hyphen). The name is not case sensitive.

", - "DeleteHyperParameterTuningJobRequest$HyperParameterTuningJobName": "

The name of the hyperparameter tuning job that you want to delete.

", - "DescribeHyperParameterTuningJobRequest$HyperParameterTuningJobName": "

The name of the tuning job.

", - "DescribeHyperParameterTuningJobResponse$HyperParameterTuningJobName": "

The name of the hyperparameter tuning job.

", - "HyperParameterTrainingJobSummary$TuningJobName": "

The HyperParameter tuning job that launched the training job.

", - "HyperParameterTuningJobSearchEntity$HyperParameterTuningJobName": "

The name of a hyperparameter tuning job.

", - "HyperParameterTuningJobSummary$HyperParameterTuningJobName": "

The name of the tuning job.

", - "ListTrainingJobsForHyperParameterTuningJobRequest$HyperParameterTuningJobName": "

The name of the tuning job whose training jobs you want to list.

", - "ParentHyperParameterTuningJob$HyperParameterTuningJobName": "

The name of the hyperparameter tuning job to be used as a starting point for a new hyperparameter tuning job.

", - "StopHyperParameterTuningJobRequest$HyperParameterTuningJobName": "

The name of the tuning job to stop.

" - } - }, - "HyperParameterTuningJobObjective": { - "base": "

Defines the objective metric for a hyperparameter tuning job. Hyperparameter tuning uses the value of this metric to evaluate the training jobs it launches, and returns the training job that results in either the highest or lowest value for this metric, depending on the value you specify for the Type parameter. If you want to define a custom objective metric, see Define metrics and environment variables.

", - "refs": { - "HyperParameterTrainingJobDefinition$TuningObjective": null, - "HyperParameterTuningJobConfig$HyperParameterTuningJobObjective": "

The HyperParameterTuningJobObjective specifies the objective metric used to evaluate the performance of training jobs launched by this tuning job.

", - "HyperParameterTuningJobObjectives$member": null - } - }, - "HyperParameterTuningJobObjectiveType": { - "base": null, - "refs": { - "FinalHyperParameterTuningJobObjectiveMetric$Type": "

Select if you want to minimize or maximize the objective metric during hyperparameter tuning.

", - "HyperParameterTuningJobObjective$Type": "

Whether to minimize or maximize the objective metric.

" - } - }, - "HyperParameterTuningJobObjectives": { - "base": null, - "refs": { - "TrainingSpecification$SupportedTuningJobObjectiveMetrics": "

A list of the metrics that the algorithm emits that can be used as the objective metric in a hyperparameter tuning job.

" - } - }, - "HyperParameterTuningJobSearchEntity": { - "base": "

An entity returned by the SearchRecord API containing the properties of a hyperparameter tuning job.

", - "refs": { - "SearchRecord$HyperParameterTuningJob": "

The properties of a hyperparameter tuning job.

" - } - }, - "HyperParameterTuningJobSortByOptions": { - "base": null, - "refs": { - "ListHyperParameterTuningJobsRequest$SortBy": "

The field to sort results by. The default is Name.

" - } - }, - "HyperParameterTuningJobStatus": { - "base": null, - "refs": { - "DescribeHyperParameterTuningJobResponse$HyperParameterTuningJobStatus": "

The status of the tuning job.

", - "HyperParameterTuningJobSearchEntity$HyperParameterTuningJobStatus": "

The status of a hyperparameter tuning job.

", - "HyperParameterTuningJobSummary$HyperParameterTuningJobStatus": "

The status of the tuning job.

", - "ListHyperParameterTuningJobsRequest$StatusEquals": "

A filter that returns only tuning jobs with the specified status.

" - } - }, - "HyperParameterTuningJobStrategyConfig": { - "base": "

The configuration for a training job launched by a hyperparameter tuning job. Choose Bayesian for Bayesian optimization, and Random for random search optimization. For more advanced use cases, use Hyperband, which evaluates objective metrics for training jobs after every epoch. For more information about strategies, see How Hyperparameter Tuning Works.

", - "refs": { - "HyperParameterTuningJobConfig$StrategyConfig": "

The configuration for the Hyperband optimization strategy. This parameter should be provided only if Hyperband is selected as the strategy for HyperParameterTuningJobConfig.

" - } - }, - "HyperParameterTuningJobStrategyType": { - "base": "

The strategy hyperparameter tuning uses to find the best combination of hyperparameters for your model.

", - "refs": { - "HyperParameterTuningJobConfig$Strategy": "

Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training job it launches. For information about search strategies, see How Hyperparameter Tuning Works.

", - "HyperParameterTuningJobSummary$Strategy": "

Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to evaluate at each iteration.

" - } - }, - "HyperParameterTuningJobSummaries": { - "base": null, - "refs": { - "ListHyperParameterTuningJobsResponse$HyperParameterTuningJobSummaries": "

A list of HyperParameterTuningJobSummary objects that describe the tuning jobs that the ListHyperParameterTuningJobs request returned.

" - } - }, - "HyperParameterTuningJobSummary": { - "base": "

Provides summary information about a hyperparameter tuning job.

", - "refs": { - "HyperParameterTuningJobSummaries$member": null - } - }, - "HyperParameterTuningJobWarmStartConfig": { - "base": "

Specifies the configuration for a hyperparameter tuning job that uses one or more previous hyperparameter tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

All training jobs launched by the new hyperparameter tuning job are evaluated by using the objective metric, and the training job that performs the best is compared to the best training jobs from the parent tuning jobs. From these, the training job that performs the best as measured by the objective metric is returned as the overall best training job.

All training jobs launched by parent hyperparameter tuning jobs and the new hyperparameter tuning jobs count against the limit of training jobs for the tuning job.

", - "refs": { - "CreateHyperParameterTuningJobRequest$WarmStartConfig": "

Specifies the configuration for starting the hyperparameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

All training jobs launched by the new hyperparameter tuning job are evaluated by using the objective metric. If you specify IDENTICAL_DATA_AND_ALGORITHM as the WarmStartType value for the warm start configuration, the training job that performs the best in the new tuning job is compared to the best training jobs from the parent tuning jobs. From these, the training job that performs the best as measured by the objective metric is returned as the overall best training job.

All training jobs launched by parent hyperparameter tuning jobs and the new hyperparameter tuning jobs count against the limit of training jobs for the tuning job.

", - "DescribeHyperParameterTuningJobResponse$WarmStartConfig": "

The configuration for starting the hyperparameter parameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

", - "HyperParameterTuningJobSearchEntity$WarmStartConfig": null - } - }, - "HyperParameterTuningJobWarmStartType": { - "base": null, - "refs": { - "HyperParameterTuningJobWarmStartConfig$WarmStartType": "

Specifies one of the following:

IDENTICAL_DATA_AND_ALGORITHM

The new hyperparameter tuning job uses the same input data and training image as the parent tuning jobs. You can change the hyperparameter ranges to search and the maximum number of training jobs that the hyperparameter tuning job launches. You cannot use a new version of the training algorithm, unless the changes in the new version do not affect the algorithm itself. For example, changes that improve logging or adding support for a different data format are allowed. You can also change hyperparameters from tunable to static, and from static to tunable, but the total number of static plus tunable hyperparameters must remain the same as it is in all parent jobs. The objective metric for the new tuning job must be the same as for all parent jobs.

TRANSFER_LEARNING

The new hyperparameter tuning job can include input data, hyperparameter ranges, maximum number of concurrent training jobs, and maximum number of training jobs that are different than those of its parent hyperparameter tuning jobs. The training image can also be a different version from the version used in the parent hyperparameter tuning job. You can also change hyperparameters from tunable to static, and from static to tunable, but the total number of static plus tunable hyperparameters must remain the same as it is in all parent jobs. The objective metric for the new tuning job must be the same as for all parent jobs.

" - } - }, - "HyperParameterTuningMaxRuntimeInSeconds": { - "base": null, - "refs": { - "ResourceLimits$MaxRuntimeInSeconds": "

The maximum time in seconds that a hyperparameter tuning job can run.

" - } - }, - "HyperParameterTuningResourceConfig": { - "base": "

The configuration of resources, including compute instances and storage volumes for use in training jobs launched by hyperparameter tuning jobs. HyperParameterTuningResourceConfig is similar to ResourceConfig, but has the additional InstanceConfigs and AllocationStrategy fields to allow for flexible instance management. Specify one or more instance types, count, and the allocation strategy for instance selection.

HyperParameterTuningResourceConfig supports the capabilities of ResourceConfig with the exception of KeepAlivePeriodInSeconds. Hyperparameter tuning jobs use warm pools by default, which reuse clusters between training jobs.

", - "refs": { - "HyperParameterTrainingJobDefinition$HyperParameterTuningResourceConfig": "

The configuration for the hyperparameter tuning resources, including the compute instances and storage volumes, used for training jobs launched by the tuning job. By default, storage volumes hold model artifacts and incremental states. Choose File for TrainingInputMode in the AlgorithmSpecification parameter to additionally store training data in the storage volume (optional).

" - } - }, - "HyperParameterValue": { - "base": null, - "refs": { - "HyperParameterSpecification$DefaultValue": "

The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.

", - "HyperParameters$value": null - } - }, - "HyperParameters": { - "base": null, - "refs": { - "CreateTrainingJobRequest$HyperParameters": "

Algorithm-specific parameters that influence the quality of the model. You set hyperparameters before you start the learning process. For a list of hyperparameters for each training algorithm provided by SageMaker, see Algorithms.

You can specify a maximum of 100 hyperparameters. Each hyperparameter is a key-value pair. Each key and value is limited to 256 characters, as specified by the Length Constraint.

Do not include any security-sensitive information including account access IDs, secrets, or tokens in any hyperparameter fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by any security-sensitive information included in the request hyperparameter variable or plain text fields.

", - "DescribeTrainingJobResponse$HyperParameters": "

Algorithm-specific parameters.

", - "HyperParameterTrainingJobDefinition$StaticHyperParameters": "

Specifies the values of hyperparameters that do not change for the tuning job.

", - "HyperParameterTrainingJobSummary$TunedHyperParameters": "

A list of the hyperparameters for which you specified ranges to search.

", - "TrainingJob$HyperParameters": "

Algorithm-specific parameters.

", - "TrainingJobDefinition$HyperParameters": "

The hyperparameters used for the training job.

" - } - }, - "HyperbandStrategyConfig": { - "base": "

The configuration for Hyperband, a multi-fidelity based hyperparameter tuning strategy. Hyperband uses the final and intermediate results of a training job to dynamically allocate resources to utilized hyperparameter configurations while automatically stopping under-performing configurations. This parameter should be provided only if Hyperband is selected as the StrategyConfig under the HyperParameterTuningJobConfig API.

", - "refs": { - "HyperParameterTuningJobStrategyConfig$HyperbandStrategyConfig": "

The configuration for the object that specifies the Hyperband strategy. This parameter is only supported for the Hyperband selection for Strategy within the HyperParameterTuningJobConfig API.

" - } - }, - "HyperbandStrategyMaxResource": { - "base": null, - "refs": { - "HyperbandStrategyConfig$MaxResource": "

The maximum number of resources (such as epochs) that can be used by a training job launched by a hyperparameter tuning job. Once a job reaches the MaxResource value, it is stopped. If a value for MaxResource is not provided, and Hyperband is selected as the hyperparameter tuning strategy, HyperbandTraining attempts to infer MaxResource from the following keys (if present) in StaticsHyperParameters:

  • epochs

  • numepochs

  • n-epochs

  • n_epochs

  • num_epochs

If HyperbandStrategyConfig is unable to infer a value for MaxResource, it generates a validation error. The maximum value is 20,000 epochs. All metrics that correspond to an objective metric are used to derive early stopping decisions. For distributed training jobs, ensure that duplicate metrics are not printed in the logs across the individual nodes in a training job. If multiple nodes are publishing duplicate or incorrect metrics, training jobs may make an incorrect stopping decision and stop the job prematurely.

" - } - }, - "HyperbandStrategyMinResource": { - "base": null, - "refs": { - "HyperbandStrategyConfig$MinResource": "

The minimum number of resources (such as epochs) that can be used by a training job launched by a hyperparameter tuning job. If the value for MinResource has not been reached, the training job is not stopped by Hyperband.

" - } - }, - "IPAddressType": { - "base": null, - "refs": { - "CreateNotebookInstanceInput$IpAddressType": "

The IP address type for the notebook instance. Specify ipv4 for IPv4-only connectivity or dualstack for both IPv4 and IPv6 connectivity. When you specify dualstack, the subnet must support IPv6 CIDR blocks. If not specified, defaults to ipv4.

", - "DescribeNotebookInstanceOutput$IpAddressType": "

The IP address type configured for the notebook instance. Returns ipv4 for IPv4-only connectivity or dualstack for both IPv4 and IPv6 connectivity.

", - "DomainSettings$IpAddressType": "

The IP address type for the domain. Specify ipv4 for IPv4-only connectivity or dualstack for both IPv4 and IPv6 connectivity. When you specify dualstack, the subnet must support IPv6 CIDR blocks. If not specified, defaults to ipv4.

", - "DomainSettingsForUpdate$IpAddressType": "

The IP address type for the domain. Specify ipv4 for IPv4-only connectivity or dualstack for both IPv4 and IPv6 connectivity. When you specify dualstack, the subnet must support IPv6 CIDR blocks.

", - "UpdateNotebookInstanceInput$IpAddressType": "

The IP address type for the notebook instance. Specify ipv4 for IPv4-only connectivity or dualstack for both IPv4 and IPv6 connectivity. The notebook instance must be stopped before updating this setting. When you specify dualstack, the subnet must support IPv6 addressing.

" - } - }, - "IamIdentity": { - "base": "

The IAM Identity details associated with the user. These details are associated with model package groups, model packages and project entities only.

", - "refs": { - "UserContext$IamIdentity": "

The IAM Identity details associated with the user. These details are associated with model package groups, model packages, and project entities only.

" - } - }, - "IamPolicyConstraints": { - "base": "

Use this parameter to specify a supported global condition key that is added to the IAM policy.

", - "refs": { - "S3Presign$IamPolicyConstraints": "

Use this parameter to specify the allowed request source. Possible sources are either SourceIp or VpcSourceIp.

" - } - }, - "IdempotencyToken": { - "base": null, - "refs": { - "CreatePipelineRequest$ClientRequestToken": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.

", - "DeletePipelineRequest$ClientRequestToken": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.

", - "RetryPipelineExecutionRequest$ClientRequestToken": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.

", - "SendPipelineExecutionStepFailureRequest$ClientRequestToken": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.

", - "SendPipelineExecutionStepSuccessRequest$ClientRequestToken": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.

", - "StartPipelineExecutionRequest$ClientRequestToken": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.

", - "StopPipelineExecutionRequest$ClientRequestToken": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.

" - } - }, - "IdentityProviderOAuthSetting": { - "base": "

The Amazon SageMaker Canvas application setting where you configure OAuth for connecting to an external data source, such as Snowflake.

", - "refs": { - "IdentityProviderOAuthSettings$member": null - } - }, - "IdentityProviderOAuthSettings": { - "base": null, - "refs": { - "CanvasAppSettings$IdentityProviderOAuthSettings": "

The settings for connecting to an external data source with OAuth.

" - } - }, - "IdleResourceSharing": { - "base": null, - "refs": { - "SchedulerConfig$IdleResourceSharing": "

Configuration for sharing idle compute resources across entities in the cluster. When enabled, unallocated resources are automatically calculated and made available for entities to borrow.

" - } - }, - "IdleSettings": { - "base": "

Settings related to idle shutdown of Studio applications.

", - "refs": { - "AppLifecycleManagement$IdleSettings": "

Settings related to idle shutdown of Studio applications.

" - } - }, - "IdleTimeoutInMinutes": { - "base": null, - "refs": { - "IdleSettings$IdleTimeoutInMinutes": "

The time that SageMaker waits after the application becomes idle before shutting it down.

", - "IdleSettings$MinIdleTimeoutInMinutes": "

The minimum value in minutes that custom idle shutdown can be set to by the user.

", - "IdleSettings$MaxIdleTimeoutInMinutes": "

The maximum value in minutes that custom idle shutdown can be set to by the user.

", - "SpaceIdleSettings$IdleTimeoutInMinutes": "

The time that SageMaker waits after the application becomes idle before shutting it down.

" - } - }, - "Image": { - "base": "

A SageMaker AI image. A SageMaker AI image represents a set of container images that are derived from a common base container image. Each of these container images is represented by a SageMaker AI ImageVersion.

", - "refs": { - "Images$member": null - } - }, - "ImageArn": { - "base": null, - "refs": { - "CreateImageResponse$ImageArn": "

The ARN of the image.

", - "DescribeImageResponse$ImageArn": "

The ARN of the image.

", - "DescribeImageVersionResponse$ImageArn": "

The ARN of the image the version is based on.

", - "Image$ImageArn": "

The ARN of the image.

", - "ImageVersion$ImageArn": "

The ARN of the image the version is based on.

", - "ResourceSpec$SageMakerImageArn": "

The ARN of the SageMaker AI image that the image version belongs to.

", - "UpdateImageResponse$ImageArn": "

The ARN of the image.

" - } - }, - "ImageBaseImage": { - "base": null, - "refs": { - "CreateImageVersionRequest$BaseImage": "

The registry path of the container image to use as the starting point for this version. The path is an Amazon ECR URI in the following format:

<acct-id>.dkr.ecr.<region>.amazonaws.com/<repo-name[:tag] or [@digest]>

", - "DescribeImageVersionResponse$BaseImage": "

The registry path of the container image on which this image version is based.

" - } - }, - "ImageClassificationJobConfig": { - "base": "

The collection of settings used by an AutoML job V2 for the image classification problem type.

", - "refs": { - "AutoMLProblemTypeConfig$ImageClassificationJobConfig": "

Settings used to configure an AutoML job V2 for the image classification problem type.

" - } - }, - "ImageConfig": { - "base": "

Specifies whether the model container is in Amazon ECR or a private Docker registry accessible from your Amazon Virtual Private Cloud (VPC).

", - "refs": { - "ContainerDefinition$ImageConfig": "

Specifies whether the model container is in Amazon ECR or a private Docker registry accessible from your Amazon Virtual Private Cloud (VPC). For information about storing containers in a private Docker registry, see Use a Private Docker Registry for Real-Time Inference Containers.

The model artifacts in an Amazon S3 bucket and the Docker image for inference container in Amazon EC2 Container Registry must be in the same region as the model or endpoint you are creating.

" - } - }, - "ImageContainerImage": { - "base": null, - "refs": { - "DescribeImageVersionResponse$ContainerImage": "

The registry path of the container image that contains this image version.

" - } - }, - "ImageDeleteProperty": { - "base": null, - "refs": { - "ImageDeletePropertyList$member": null - } - }, - "ImageDeletePropertyList": { - "base": null, - "refs": { - "UpdateImageRequest$DeleteProperties": "

A list of properties to delete. Only the Description and DisplayName properties can be deleted.

" - } - }, - "ImageDescription": { - "base": null, - "refs": { - "CreateImageRequest$Description": "

The description of the image.

", - "DescribeImageResponse$Description": "

The description of the image.

", - "Image$Description": "

The description of the image.

", - "UpdateImageRequest$Description": "

The new description for the image.

" - } - }, - "ImageDigest": { - "base": null, - "refs": { - "ModelPackageContainerDefinition$ImageDigest": "

An MD5 hash of the training algorithm that identifies the Docker image used for training.

", - "TrainingSpecification$TrainingImageDigest": "

An MD5 hash of the training algorithm that identifies the Docker image used for training.

" - } - }, - "ImageDisplayName": { - "base": null, - "refs": { - "CreateImageRequest$DisplayName": "

The display name of the image. If not provided, ImageName is displayed.

", - "DescribeImageResponse$DisplayName": "

The name of the image as displayed.

", - "Image$DisplayName": "

The name of the image as displayed.

", - "UpdateImageRequest$DisplayName": "

The new display name for the image.

" - } - }, - "ImageId": { - "base": null, - "refs": { - "ClusterInstanceGroupDetails$CurrentImageId": "

The ID of the Amazon Machine Image (AMI) currently in use by the instance group.

", - "ClusterInstanceGroupDetails$DesiredImageId": "

The ID of the Amazon Machine Image (AMI) desired for the instance group.

", - "ClusterInstanceGroupSpecification$ImageId": "

When configuring your HyperPod cluster, you can specify an image ID using one of the following options:

  • HyperPodPublicAmiId: Use a HyperPod public AMI

  • CustomAmiId: Use your custom AMI

  • default: Use the default latest system image. For clusters with continuous scaling node provisioning mode, new instance groups inherit the AMI from the earliest existing instance group

If you choose to use a custom AMI (CustomAmiId), ensure it meets the following requirements:

  • Encryption: The custom AMI must be unencrypted.

  • Ownership: The custom AMI must be owned by the same Amazon Web Services account that is creating the HyperPod cluster.

  • Volume support: Only the primary AMI snapshot volume is supported; additional AMI volumes are not supported.

When updating the instance group's AMI through the UpdateClusterSoftware operation, if an instance group uses a custom AMI, you must provide an ImageId or use the default as input. Note that if you don't specify an instance group in your UpdateClusterSoftware request, then all of the instance groups are patched with the specified image.

", - "ClusterNodeDetails$CurrentImageId": "

The ID of the Amazon Machine Image (AMI) currently in use by the node.

", - "ClusterNodeDetails$DesiredImageId": "

The ID of the Amazon Machine Image (AMI) desired for the node.

", - "UpdateClusterSoftwareRequest$ImageId": "

When configuring your HyperPod cluster, you can specify an image ID using one of the following options:

  • HyperPodPublicAmiId: Use a HyperPod public AMI

  • CustomAmiId: Use your custom AMI

  • default: Use the default latest system image

If you choose to use a custom AMI (CustomAmiId), ensure it meets the following requirements:

  • Encryption: The custom AMI must be unencrypted.

  • Ownership: The custom AMI must be owned by the same Amazon Web Services account that is creating the HyperPod cluster.

  • Volume support: Only the primary AMI snapshot volume is supported; additional AMI volumes are not supported.

When updating the instance group's AMI through the UpdateClusterSoftware operation, if an instance group uses a custom AMI, you must provide an ImageId or use the default as input. Note that if you don't specify an instance group in your UpdateClusterSoftware request, then all of the instance groups are patched with the specified image.

" - } - }, - "ImageName": { - "base": null, - "refs": { - "CreateImageRequest$ImageName": "

The name of the image. Must be unique to your account.

", - "CreateImageVersionRequest$ImageName": "

The ImageName of the Image to create a version of.

", - "CustomImage$ImageName": "

The name of the CustomImage. Must be unique to your account.

", - "DeleteImageRequest$ImageName": "

The name of the image to delete.

", - "DeleteImageVersionRequest$ImageName": "

The name of the image to delete.

", - "DescribeImageRequest$ImageName": "

The name of the image to describe.

", - "DescribeImageResponse$ImageName": "

The name of the image.

", - "DescribeImageVersionRequest$ImageName": "

The name of the image.

", - "Image$ImageName": "

The name of the image.

", - "ListAliasesRequest$ImageName": "

The name of the image.

", - "ListImageVersionsRequest$ImageName": "

The name of the image to list the versions of.

", - "UpdateImageRequest$ImageName": "

The name of the image to update.

", - "UpdateImageVersionRequest$ImageName": "

The name of the image.

" - } - }, - "ImageNameContains": { - "base": null, - "refs": { - "ListImagesRequest$NameContains": "

A filter that returns only images whose name contains the specified string.

" - } - }, - "ImageReleaseVersion": { - "base": null, - "refs": { - "ClusterInstanceGroupDetails$CurrentImageReleaseVersion": "

The version of the HyperPod-managed AMI currently running on the instance group.

", - "ClusterInstanceGroupDetails$DesiredImageReleaseVersion": "

The desired version of the HyperPod-managed AMI for the instance group. This may differ from the current version when an update is pending.

", - "ClusterInstanceGroupSpecification$ImageReleaseVersion": "

The version of the HyperPod-managed AMI to use for the instance group. Uses semantic versioning in the format MAJOR.MINOR.PATCH (for example, 1.2.3). If omitted, the latest available version is used.

", - "ClusterNodeDetails$CurrentImageReleaseVersion": "

The version of the HyperPod-managed AMI currently running on the node.

", - "ClusterNodeDetails$DesiredImageReleaseVersion": "

The desired version of the HyperPod-managed AMI for the node. This may differ from the current version when an update is pending.

", - "ClusterNodeSummary$CurrentImageReleaseVersion": "

The version of the HyperPod-managed AMI currently running on the node.

", - "UpdateClusterSoftwareInstanceGroupSpecification$ImageReleaseVersion": "

The version of the HyperPod-managed AMI to update to for the instance group. Uses semantic versioning in the format MAJOR.MINOR.PATCH.

" - } - }, - "ImageSortBy": { - "base": null, - "refs": { - "ListImagesRequest$SortBy": "

The property used to sort results. The default value is CREATION_TIME.

" - } - }, - "ImageSortOrder": { - "base": null, - "refs": { - "ListImagesRequest$SortOrder": "

The sort order. The default value is DESCENDING.

" - } - }, - "ImageStatus": { - "base": null, - "refs": { - "DescribeImageResponse$ImageStatus": "

The status of the image.

", - "Image$ImageStatus": "

The status of the image.

" - } - }, - "ImageUri": { - "base": null, - "refs": { - "AppSpecification$ImageUri": "

The container image to be run by the processing job.

", - "DataQualityAppSpecification$ImageUri": "

The container image that the data quality monitoring job runs.

", - "ModelBiasAppSpecification$ImageUri": "

The container image to be run by the model bias job.

", - "ModelExplainabilityAppSpecification$ImageUri": "

The container image to be run by the model explainability job.

", - "ModelQualityAppSpecification$ImageUri": "

The address of the container image that the monitoring job runs.

", - "MonitoringAppSpecification$ImageUri": "

The container image to be run by the monitoring job.

" - } - }, - "ImageVersion": { - "base": "

A version of a SageMaker AI Image. A version represents an existing container image.

", - "refs": { - "ImageVersions$member": null - } - }, - "ImageVersionAlias": { - "base": null, - "refs": { - "ResourceSpec$SageMakerImageVersionAlias": "

The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.

" - } - }, - "ImageVersionAliasPattern": { - "base": null, - "refs": { - "VersionAliasesList$member": null - } - }, - "ImageVersionArn": { - "base": null, - "refs": { - "CreateImageVersionResponse$ImageVersionArn": "

The ARN of the image version.

", - "DescribeImageVersionResponse$ImageVersionArn": "

The ARN of the version.

", - "ImageVersion$ImageVersionArn": "

The ARN of the version.

", - "ResourceSpec$SageMakerImageVersionArn": "

The ARN of the image version created on the instance. To clear the value set for SageMakerImageVersionArn, pass None as the value.

", - "UpdateImageVersionResponse$ImageVersionArn": "

The ARN of the image version.

" - } - }, - "ImageVersionNumber": { - "base": null, - "refs": { - "CustomImage$ImageVersionNumber": "

The version number of the CustomImage.

", - "DeleteImageVersionRequest$Version": "

The version to delete.

", - "DescribeImageVersionRequest$Version": "

The version of the image. If not specified, the latest version is described.

", - "DescribeImageVersionResponse$Version": "

The version number.

", - "ImageVersion$Version": "

The version number.

", - "ListAliasesRequest$Version": "

The version of the image. If image version is not specified, the aliases of all versions of the image are listed.

", - "UpdateImageVersionRequest$Version": "

The version of the image.

" - } - }, - "ImageVersionSortBy": { - "base": null, - "refs": { - "ListImageVersionsRequest$SortBy": "

The property used to sort results. The default value is CREATION_TIME.

" - } - }, - "ImageVersionSortOrder": { - "base": null, - "refs": { - "ListImageVersionsRequest$SortOrder": "

The sort order. The default value is DESCENDING.

" - } - }, - "ImageVersionStatus": { - "base": null, - "refs": { - "DescribeImageVersionResponse$ImageVersionStatus": "

The status of the version.

", - "ImageVersion$ImageVersionStatus": "

The status of the version.

" - } - }, - "ImageVersions": { - "base": null, - "refs": { - "ListImageVersionsResponse$ImageVersions": "

A list of versions and their properties.

" - } - }, - "Images": { - "base": null, - "refs": { - "ListImagesResponse$Images": "

A list of images and their properties.

" - } - }, - "ImportHubContentRequest": { - "base": null, - "refs": {} - }, - "ImportHubContentResponse": { - "base": null, - "refs": {} - }, - "InUseInstanceCount": { - "base": null, - "refs": { - "DescribeReservedCapacityResponse$InUseInstanceCount": "

The number of instances currently in use from this reserved capacity.

", - "DescribeTrainingPlanResponse$InUseInstanceCount": "

The number of instances currently in use from this training plan.

", - "TrainingPlanSummary$InUseInstanceCount": "

The number of instances currently in use from this training plan.

", - "UltraServer$InUseInstanceCount": "

The number of instances currently in use in this UltraServer.

" - } - }, - "IncludeNodeLogicalIdsBoolean": { - "base": null, - "refs": { - "ListClusterNodesRequest$IncludeNodeLogicalIds": "

Specifies whether to include nodes that are still being provisioned in the response. When set to true, the response includes all nodes regardless of their provisioning status. When set to False (default), only nodes with assigned InstanceIds are returned.

" - } - }, - "IncludedData": { - "base": null, - "refs": { - "DescribeModelCardRequest$IncludedData": "

Specifies the level of model card data to include in the response. Use this parameter to call DescribeModelCard without requiring kms:Decrypt permission on the customer-managed Amazon Web Services KMS key.

  • AllData: Returns the full model card Content. This option requires kms:Decrypt permission on the customer-managed key, if one is associated with the model card. This is the default.

  • MetadataOnly: Returns the model card with sanitized Content that includes only a small set of unencrypted metadata fields. This option does not require kms:Decrypt permission. For the list of fields preserved in the response, see Content.

If you don't specify a value, SageMaker returns AllData.

", - "DescribeModelPackageInput$IncludedData": "

Specifies the level of model package data to include in the response. Use this parameter to call DescribeModelPackage on a model package that has an associated model card without requiring kms:Decrypt permission on the customer-managed KMS key associated with the embedded model card.

  • AllData: Returns the full model package response, including the unredacted ModelCard.ModelCardContent. This option requires kms:Decrypt permission on the customer-managed key, if one is associated with the embedded model card. This is the default.

  • MetadataOnly: Returns the full model package response, but with the embedded ModelCard.ModelCardContent sanitized to include only a small set of unencrypted metadata fields. This option does not require kms:Decrypt permission. All other top-level response fields, including InferenceSpecification, ModelMetrics, DriftCheckBaselines, and SecurityConfig, are returned unchanged. For the list of fields preserved within ModelCardContent, see ModelCard.

If you don't specify a value, SageMaker returns AllData.

" - } - }, - "InferenceComponentArn": { - "base": null, - "refs": { - "CreateInferenceComponentOutput$InferenceComponentArn": "

The Amazon Resource Name (ARN) of the inference component.

", - "DescribeInferenceComponentOutput$InferenceComponentArn": "

The Amazon Resource Name (ARN) of the inference component.

", - "InferenceComponentSummary$InferenceComponentArn": "

The Amazon Resource Name (ARN) of the inference component.

", - "UpdateInferenceComponentOutput$InferenceComponentArn": "

The Amazon Resource Name (ARN) of the inference component.

", - "UpdateInferenceComponentRuntimeConfigOutput$InferenceComponentArn": "

The Amazon Resource Name (ARN) of the inference component.

" - } - }, - "InferenceComponentAvailabilityZoneBalance": { - "base": "

Configuration for balancing inference component copies across Availability Zones.

", - "refs": { - "InferenceComponentSchedulingConfig$AvailabilityZoneBalance": "

Configuration for balancing inference component copies across Availability Zones.

" - } - }, - "InferenceComponentCapacitySize": { - "base": "

Specifies the type and size of the endpoint capacity to activate for a rolling deployment or a rollback strategy. You can specify your batches as either of the following:

  • A count of inference component copies

  • The overall percentage or your fleet

For a rollback strategy, if you don't specify the fields in this object, or if you set the Value parameter to 100%, then SageMaker AI uses a blue/green rollback strategy and rolls all traffic back to the blue fleet.

", - "refs": { - "InferenceComponentRollingUpdatePolicy$MaximumBatchSize": "

The batch size for each rolling step in the deployment process. For each step, SageMaker AI provisions capacity on the new endpoint fleet, routes traffic to that fleet, and terminates capacity on the old endpoint fleet. The value must be between 5% to 50% of the copy count of the inference component.

", - "InferenceComponentRollingUpdatePolicy$RollbackMaximumBatchSize": "

The batch size for a rollback to the old endpoint fleet. If this field is absent, the value is set to the default, which is 100% of the total capacity. When the default is used, SageMaker AI provisions the entire capacity of the old fleet at once during rollback.

" - } - }, - "InferenceComponentCapacitySizeType": { - "base": null, - "refs": { - "InferenceComponentCapacitySize$Type": "

Specifies the endpoint capacity type.

COPY_COUNT

The endpoint activates based on the number of inference component copies.

CAPACITY_PERCENT

The endpoint activates based on the specified percentage of capacity.

" - } - }, - "InferenceComponentComputeResourceRequirements": { - "base": "

Defines the compute resources to allocate to run a model, plus any adapter models, that you assign to an inference component. These resources include CPU cores, accelerators, and memory.

", - "refs": { - "InferenceComponentSpecification$ComputeResourceRequirements": "

The compute resources allocated to run the model, plus any adapter models, that you assign to the inference component.

Omit this parameter if your request is meant to create an adapter inference component. An adapter inference component is loaded by a base inference component, and it uses the compute resources of the base inference component.

", - "InferenceComponentSpecificationSummary$ComputeResourceRequirements": "

The compute resources allocated to run the model, plus any adapter models, that you assign to the inference component.

" - } - }, - "InferenceComponentContainerSpecification": { - "base": "

Defines a container that provides the runtime environment for a model that you deploy with an inference component.

", - "refs": { - "InferenceComponentSpecification$Container": "

Defines a container that provides the runtime environment for a model that you deploy with an inference component.

" - } - }, - "InferenceComponentContainerSpecificationSummary": { - "base": "

Details about the resources that are deployed with this inference component.

", - "refs": { - "InferenceComponentSpecificationSummary$Container": "

Details about the container that provides the runtime environment for the model that is deployed with the inference component.

" - } - }, - "InferenceComponentCopyCount": { - "base": null, - "refs": { - "InferenceComponentPlacementStatus$CurrentCopyCount": "

The number of inference component copies currently placed on instances of this type.

", - "InferenceComponentRuntimeConfig$CopyCount": "

The number of runtime copies of the model container to deploy with the inference component. Each copy can serve inference requests.

", - "InferenceComponentRuntimeConfigSummary$DesiredCopyCount": "

The number of runtime copies of the model container that you requested to deploy with the inference component.

", - "InferenceComponentRuntimeConfigSummary$CurrentCopyCount": "

The number of runtime copies of the model container that are currently deployed.

" - } - }, - "InferenceComponentDataCacheConfig": { - "base": "

Settings that affect how the inference component caches data.

", - "refs": { - "InferenceComponentSpecification$DataCacheConfig": "

Settings that affect how the inference component caches data.

" - } - }, - "InferenceComponentDataCacheConfigSummary": { - "base": "

Settings that affect how the inference component caches data.

", - "refs": { - "InferenceComponentSpecificationSummary$DataCacheConfig": "

Settings that affect how the inference component caches data.

" - } - }, - "InferenceComponentDeploymentConfig": { - "base": "

The deployment configuration for an endpoint that hosts inference components. The configuration includes the desired deployment strategy and rollback settings.

", - "refs": { - "DescribeInferenceComponentOutput$LastDeploymentConfig": "

The deployment and rollback settings that you assigned to the inference component.

", - "UpdateInferenceComponentInput$DeploymentConfig": "

The deployment configuration for the inference component. The configuration contains the desired deployment strategy and rollback settings.

" - } - }, - "InferenceComponentMetadata": { - "base": "

The metadata of the inference component.

", - "refs": { - "PipelineExecutionStepMetadata$InferenceComponent": "

The metadata of the inference component used in pipeline execution step.

" - } - }, - "InferenceComponentName": { - "base": null, - "refs": { - "CreateInferenceComponentInput$InferenceComponentName": "

A unique name to assign to the inference component.

", - "DeleteInferenceComponentInput$InferenceComponentName": "

The name of the inference component to delete.

", - "DescribeInferenceComponentInput$InferenceComponentName": "

The name of the inference component.

", - "DescribeInferenceComponentOutput$InferenceComponentName": "

The name of the inference component.

", - "InferenceComponentSpecification$BaseInferenceComponentName": "

The name of an existing inference component that is to contain the inference component that you're creating with your request.

Specify this parameter only if your request is meant to create an adapter inference component. An adapter inference component contains the path to an adapter model. The purpose of the adapter model is to tailor the inference output of a base foundation model, which is hosted by the base inference component. The adapter inference component uses the compute resources that you assigned to the base inference component.

When you create an adapter inference component, use the Container parameter to specify the location of the adapter artifacts. In the parameter value, use the ArtifactUrl parameter of the InferenceComponentContainerSpecification data type.

Before you can create an adapter inference component, you must have an existing inference component that contains the foundation model that you want to adapt.

", - "InferenceComponentSpecificationSummary$BaseInferenceComponentName": "

The name of the base inference component that contains this inference component.

", - "InferenceComponentSummary$InferenceComponentName": "

The name of the inference component.

", - "UpdateInferenceComponentInput$InferenceComponentName": "

The name of the inference component.

", - "UpdateInferenceComponentRuntimeConfigInput$InferenceComponentName": "

The name of the inference component to update.

" - } - }, - "InferenceComponentNameContains": { - "base": null, - "refs": { - "ListInferenceComponentsInput$NameContains": "

Filters the results to only those inference components with a name that contains the specified string.

" - } - }, - "InferenceComponentPlacementStatus": { - "base": "

The placement status of an inference component on a specific instance type. Shows the number of inference component copies currently placed on instances of a given type.

", - "refs": { - "InferenceComponentPlacementStatusList$member": null - } - }, - "InferenceComponentPlacementStatusList": { - "base": null, - "refs": { - "InferenceComponentRuntimeConfigSummary$PlacementStatus": "

The placement status of the inference component across instance types. Shows how the inference component copies are distributed across instance types.

" - } - }, - "InferenceComponentPlacementStrategy": { - "base": null, - "refs": { - "InferenceComponentSchedulingConfig$PlacementStrategy": "

The strategy for placing inference component copies across available instances. If you also set AvailabilityZoneBalance, this strategy applies to placement within each Availability Zone.

SPREAD

Distributes copies evenly across available instances for better resilience.

BINPACK

Packs copies onto fewer instances to optimize resource utilization.

" - } - }, - "InferenceComponentRollingUpdatePolicy": { - "base": "

Specifies a rolling deployment strategy for updating a SageMaker AI inference component.

", - "refs": { - "InferenceComponentDeploymentConfig$RollingUpdatePolicy": "

Specifies a rolling deployment strategy for updating a SageMaker AI endpoint.

" - } - }, - "InferenceComponentRuntimeConfig": { - "base": "

Runtime settings for a model that is deployed with an inference component.

", - "refs": { - "CreateInferenceComponentInput$RuntimeConfig": "

Runtime settings for a model that is deployed with an inference component.

", - "UpdateInferenceComponentInput$RuntimeConfig": "

Runtime settings for a model that is deployed with an inference component.

", - "UpdateInferenceComponentRuntimeConfigInput$DesiredRuntimeConfig": "

Runtime settings for a model that is deployed with an inference component.

" - } - }, - "InferenceComponentRuntimeConfigSummary": { - "base": "

Details about the runtime settings for the model that is deployed with the inference component.

", - "refs": { - "DescribeInferenceComponentOutput$RuntimeConfig": "

Details about the runtime settings for the model that is deployed with the inference component.

" - } - }, - "InferenceComponentSchedulingConfig": { - "base": "

The scheduling configuration that determines how inference component copies are placed across available instances when copies are added or removed.

", - "refs": { - "InferenceComponentSpecification$SchedulingConfig": "

The scheduling configuration that determines how inference component copies are placed across available instances when copies are added or removed.

", - "InferenceComponentSpecificationSummary$SchedulingConfig": "

The scheduling configuration that determines how inference component copies are placed across available instances when copies are added or removed.

" - } - }, - "InferenceComponentSortKey": { - "base": null, - "refs": { - "ListInferenceComponentsInput$SortBy": "

The field by which to sort the inference components in the response. The default is CreationTime.

" - } - }, - "InferenceComponentSpecification": { - "base": "

Details about the resources to deploy with this inference component, including the model, container, and compute resources.

", - "refs": { - "CreateInferenceComponentInput$Specification": "

Details about the resources to deploy with this inference component, including the model, container, and compute resources.

", - "InferenceComponentSpecificationList$member": null, - "UpdateInferenceComponentInput$Specification": "

Details about the resources to deploy with this inference component, including the model, container, and compute resources.

" - } - }, - "InferenceComponentSpecificationList": { - "base": null, - "refs": { - "CreateInferenceComponentInput$Specifications": "

A list of specification objects for the inference component, one per instance type. Use this parameter when you want to deploy a different model or resource configuration for the inference component on each instance type. You can use either this parameter or the singular Specification parameter, but not both.

", - "UpdateInferenceComponentInput$Specifications": "

A list of specification objects for the inference component, one per instance type. Use this parameter when you want to specify different model or resource configurations for the inference component on each instance type. You can use either this parameter or the singular Specification parameter, but not both.

" - } - }, - "InferenceComponentSpecificationSummary": { - "base": "

Details about the resources that are deployed with this inference component.

", - "refs": { - "DescribeInferenceComponentOutput$Specification": "

Details about the resources that are deployed with this inference component.

", - "InferenceComponentSpecificationSummaryList$member": null - } - }, - "InferenceComponentSpecificationSummaryList": { - "base": null, - "refs": { - "DescribeInferenceComponentOutput$Specifications": "

A list of specification summaries for the inference component, one per instance type. This parameter is populated when the inference component was created with multiple specifications. When this parameter is populated, the singular Specification parameter is not returned.

" - } - }, - "InferenceComponentStartupParameters": { - "base": "

Settings that take effect while the model container starts up.

", - "refs": { - "InferenceComponentSpecification$StartupParameters": "

Settings that take effect while the model container starts up.

", - "InferenceComponentSpecificationSummary$StartupParameters": "

Settings that take effect while the model container starts up.

" - } - }, - "InferenceComponentStatus": { - "base": null, - "refs": { - "DescribeInferenceComponentOutput$InferenceComponentStatus": "

The status of the inference component.

", - "InferenceComponentSummary$InferenceComponentStatus": "

The status of the inference component.

", - "ListInferenceComponentsInput$StatusEquals": "

Filters the results to only those inference components with the specified status.

" - } - }, - "InferenceComponentSummary": { - "base": "

A summary of the properties of an inference component.

", - "refs": { - "InferenceComponentSummaryList$member": null - } - }, - "InferenceComponentSummaryList": { - "base": null, - "refs": { - "ListInferenceComponentsOutput$InferenceComponents": "

A list of inference components and their properties that matches any of the filters you specified in the request.

" - } - }, - "InferenceExecutionConfig": { - "base": "

Specifies details about how containers in a multi-container endpoint are run.

", - "refs": { - "CreateModelInput$InferenceExecutionConfig": "

Specifies details of how containers in a multi-container endpoint are called.

", - "DescribeModelOutput$InferenceExecutionConfig": "

Specifies details of how containers in a multi-container endpoint are called.

", - "Model$InferenceExecutionConfig": null - } - }, - "InferenceExecutionMode": { - "base": null, - "refs": { - "InferenceExecutionConfig$Mode": "

How containers in a multi-container are run. The following values are valid.

  • SERIAL - Containers run as a serial pipeline.

  • DIRECT - Only the individual container that you specify is run.

" - } - }, - "InferenceExperimentArn": { - "base": null, - "refs": { - "CreateInferenceExperimentResponse$InferenceExperimentArn": "

The ARN for your inference experiment.

", - "DeleteInferenceExperimentResponse$InferenceExperimentArn": "

The ARN of the deleted inference experiment.

", - "DescribeInferenceExperimentResponse$Arn": "

The ARN of the inference experiment being described.

", - "StartInferenceExperimentResponse$InferenceExperimentArn": "

The ARN of the started inference experiment to start.

", - "StopInferenceExperimentResponse$InferenceExperimentArn": "

The ARN of the stopped inference experiment.

", - "UpdateInferenceExperimentResponse$InferenceExperimentArn": "

The ARN of the updated inference experiment.

" - } - }, - "InferenceExperimentDataStorageConfig": { - "base": "

The Amazon S3 location and configuration for storing inference request and response data.

", - "refs": { - "CreateInferenceExperimentRequest$DataStorageConfig": "

The Amazon S3 location and configuration for storing inference request and response data.

This is an optional parameter that you can use for data capture. For more information, see Capture data.

", - "DescribeInferenceExperimentResponse$DataStorageConfig": "

The Amazon S3 location and configuration for storing inference request and response data.

", - "UpdateInferenceExperimentRequest$DataStorageConfig": "

The Amazon S3 location and configuration for storing inference request and response data.

" - } - }, - "InferenceExperimentDescription": { - "base": null, - "refs": { - "CreateInferenceExperimentRequest$Description": "

A description for the inference experiment.

", - "DescribeInferenceExperimentResponse$Description": "

The description of the inference experiment.

", - "InferenceExperimentSummary$Description": "

The description of the inference experiment.

", - "UpdateInferenceExperimentRequest$Description": "

The description of the inference experiment.

" - } - }, - "InferenceExperimentList": { - "base": null, - "refs": { - "ListInferenceExperimentsResponse$InferenceExperiments": "

List of inference experiments.

" - } - }, - "InferenceExperimentName": { - "base": null, - "refs": { - "CreateInferenceExperimentRequest$Name": "

The name for the inference experiment.

", - "DeleteInferenceExperimentRequest$Name": "

The name of the inference experiment you want to delete.

", - "DescribeInferenceExperimentRequest$Name": "

The name of the inference experiment to describe.

", - "DescribeInferenceExperimentResponse$Name": "

The name of the inference experiment.

", - "InferenceExperimentSummary$Name": "

The name of the inference experiment.

", - "StartInferenceExperimentRequest$Name": "

The name of the inference experiment to start.

", - "StopInferenceExperimentRequest$Name": "

The name of the inference experiment to stop.

", - "UpdateInferenceExperimentRequest$Name": "

The name of the inference experiment to be updated.

" - } - }, - "InferenceExperimentSchedule": { - "base": "

The start and end times of an inference experiment.

The maximum duration that you can set for an inference experiment is 30 days.

", - "refs": { - "CreateInferenceExperimentRequest$Schedule": "

The duration for which you want the inference experiment to run. If you don't specify this field, the experiment automatically starts immediately upon creation and concludes after 7 days.

", - "DescribeInferenceExperimentResponse$Schedule": "

The duration for which the inference experiment ran or will run.

", - "InferenceExperimentSummary$Schedule": "

The duration for which the inference experiment ran or will run.

The maximum duration that you can set for an inference experiment is 30 days.

", - "UpdateInferenceExperimentRequest$Schedule": "

The duration for which the inference experiment will run. If the status of the inference experiment is Created, then you can update both the start and end dates. If the status of the inference experiment is Running, then you can update only the end date.

" - } - }, - "InferenceExperimentStatus": { - "base": null, - "refs": { - "DescribeInferenceExperimentResponse$Status": "

The status of the inference experiment. The following are the possible statuses for an inference experiment:

  • Creating - Amazon SageMaker is creating your experiment.

  • Created - Amazon SageMaker has finished the creation of your experiment and will begin the experiment at the scheduled time.

  • Updating - When you make changes to your experiment, your experiment shows as updating.

  • Starting - Amazon SageMaker is beginning your experiment.

  • Running - Your experiment is in progress.

  • Stopping - Amazon SageMaker is stopping your experiment.

  • Completed - Your experiment has completed.

  • Cancelled - When you conclude your experiment early using the StopInferenceExperiment API, or if any operation fails with an unexpected error, it shows as cancelled.

", - "InferenceExperimentSummary$Status": "

The status of the inference experiment.

", - "ListInferenceExperimentsRequest$StatusEquals": "

Selects inference experiments which are in this status. For the possible statuses, see DescribeInferenceExperiment.

" - } - }, - "InferenceExperimentStatusReason": { - "base": null, - "refs": { - "DescribeInferenceExperimentResponse$StatusReason": "

The error message or client-specified Reason from the StopInferenceExperiment API, that explains the status of the inference experiment.

", - "InferenceExperimentSummary$StatusReason": "

The error message for the inference experiment status result.

", - "StopInferenceExperimentRequest$Reason": "

The reason for stopping the experiment.

" - } - }, - "InferenceExperimentStopDesiredState": { - "base": null, - "refs": { - "StopInferenceExperimentRequest$DesiredState": "

The desired state of the experiment after stopping. The possible states are the following:

  • Completed: The experiment completed successfully

  • Cancelled: The experiment was canceled

" - } - }, - "InferenceExperimentSummary": { - "base": "

Lists a summary of properties of an inference experiment.

", - "refs": { - "InferenceExperimentList$member": null - } - }, - "InferenceExperimentType": { - "base": null, - "refs": { - "CreateInferenceExperimentRequest$Type": "

The type of the inference experiment that you want to run. The following types of experiments are possible:

  • ShadowMode: You can use this type to validate a shadow variant. For more information, see Shadow tests.

", - "DescribeInferenceExperimentResponse$Type": "

The type of the inference experiment.

", - "InferenceExperimentSummary$Type": "

The type of the inference experiment.

", - "ListInferenceExperimentsRequest$Type": "

Selects inference experiments of this type. For the possible types of inference experiments, see CreateInferenceExperiment.

" - } - }, - "InferenceHubAccessConfig": { - "base": "

Configuration information specifying which hub contents have accessible deployment options.

", - "refs": { - "S3ModelDataSource$HubAccessConfig": "

Configuration information for hub access.

" - } - }, - "InferenceImage": { - "base": null, - "refs": { - "DescribeCompilationJobResponse$InferenceImage": "

The inference image to use when compiling a model. Specify an image only if the target device is a cloud instance.

" - } - }, - "InferenceMetrics": { - "base": "

The metrics for an existing endpoint compared in an Inference Recommender job.

", - "refs": { - "EndpointPerformance$Metrics": "

The metrics for an existing endpoint.

", - "RecommendationJobInferenceBenchmark$EndpointMetrics": null - } - }, - "InferenceRecommendation": { - "base": "

A list of recommendations made by Amazon SageMaker Inference Recommender.

", - "refs": { - "InferenceRecommendations$member": null - } - }, - "InferenceRecommendations": { - "base": null, - "refs": { - "DescribeInferenceRecommendationsJobResponse$InferenceRecommendations": "

The recommendations made by Inference Recommender.

" - } - }, - "InferenceRecommendationsJob": { - "base": "

A structure that contains a list of recommendation jobs.

", - "refs": { - "InferenceRecommendationsJobs$member": null - } - }, - "InferenceRecommendationsJobStep": { - "base": "

A returned array object for the Steps response field in the ListInferenceRecommendationsJobSteps API command.

", - "refs": { - "InferenceRecommendationsJobSteps$member": null - } - }, - "InferenceRecommendationsJobSteps": { - "base": null, - "refs": { - "ListInferenceRecommendationsJobStepsResponse$Steps": "

A list of all subtask details in Inference Recommender.

" - } - }, - "InferenceRecommendationsJobs": { - "base": null, - "refs": { - "ListInferenceRecommendationsJobsResponse$InferenceRecommendationsJobs": "

The recommendations created from the Amazon SageMaker Inference Recommender job.

" - } - }, - "InferenceSpecification": { - "base": "

Defines how to perform inference generation after a training job is run.

", - "refs": { - "BatchDescribeModelPackageSummary$InferenceSpecification": null, - "CreateAlgorithmInput$InferenceSpecification": "

Specifies details about inference jobs that the algorithm runs, including the following:

  • The Amazon ECR paths of containers that contain the inference code and model artifacts.

  • The instance types that the algorithm supports for transform jobs and real-time endpoints used for inference.

  • The input and output content formats that the algorithm supports for inference.

", - "CreateModelPackageInput$InferenceSpecification": "

Specifies details about inference jobs that you can run with models based on this model package, including the following information:

  • The Amazon ECR paths of containers that contain the inference code and model artifacts.

  • The instance types that the model package supports for transform jobs and real-time endpoints used for inference.

  • The input and output content formats that the model package supports for inference.

", - "DescribeAlgorithmOutput$InferenceSpecification": "

Details about inference jobs that the algorithm runs.

", - "DescribeModelPackageOutput$InferenceSpecification": "

Details about inference jobs that you can run with models based on this model package.

", - "ModelPackage$InferenceSpecification": "

Defines how to perform inference generation after a training job is run.

", - "UpdateModelPackageInput$InferenceSpecification": "

Specifies details about inference jobs that you can run with models based on this model package, including the following information:

  • The Amazon ECR paths of containers that contain the inference code and model artifacts.

  • The instance types that the model package supports for transform jobs and real-time endpoints used for inference.

  • The input and output content formats that the model package supports for inference.

" - } - }, - "InferenceSpecificationName": { - "base": null, - "refs": { - "ContainerDefinition$InferenceSpecificationName": "

The inference specification name in the model package version.

", - "EndpointInputConfiguration$InferenceSpecificationName": "

The inference specification name in the model package version.

", - "ModelConfiguration$InferenceSpecificationName": "

The inference specification name in the model package version.

" - } - }, - "InfraCheckConfig": { - "base": "

Configuration information for the infrastructure health check of a training job. A SageMaker-provided health check tests the health of instance hardware and cluster network connectivity.

", - "refs": { - "CreateTrainingJobRequest$InfraCheckConfig": "

Contains information about the infrastructure health check configuration for the training job.

", - "DescribeTrainingJobResponse$InfraCheckConfig": "

Contains information about the infrastructure health check configuration for the training job.

" - } - }, - "InitialInstanceCount": { - "base": null, - "refs": { - "EndpointOutputConfiguration$InitialInstanceCount": "

The number of instances recommended to launch initially.

" - } - }, - "InitialNumberOfUsers": { - "base": null, - "refs": { - "Phase$InitialNumberOfUsers": "

Specifies how many concurrent users to start with. The value should be between 1 and 3.

" - } - }, - "InitialTaskCount": { - "base": null, - "refs": { - "ProductionVariant$InitialInstanceCount": "

Number of instances to launch initially.

" - } - }, - "InputConfig": { - "base": "

Contains information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

", - "refs": { - "CreateCompilationJobRequest$InputConfig": "

Provides information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

", - "DescribeCompilationJobResponse$InputConfig": "

Information about the location in Amazon S3 of the input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

" - } - }, - "InputDataConfig": { - "base": null, - "refs": { - "CreateTrainingJobRequest$InputDataConfig": "

An array of Channel objects. Each channel is a named input source. InputDataConfig describes the input data and its location.

Algorithms can accept input data from one or more channels. For example, an algorithm might have two channels of input data, training_data and validation_data. The configuration for each channel provides the S3, EFS, or FSx location where the input data is stored. It also provides information about the stored data: the MIME type, compression method, and whether the data is wrapped in RecordIO format.

Depending on the input mode that the algorithm supports, SageMaker either copies input data files from an S3 bucket to a local directory in the Docker container, or makes it available as input streams. For example, if you specify an EFS location, input data files are available as input streams. They do not need to be downloaded.

Your input must be in the same Amazon Web Services region as your training job.

", - "DescribeTrainingJobResponse$InputDataConfig": "

An array of Channel objects that describes each data input channel.

", - "HyperParameterTrainingJobDefinition$InputDataConfig": "

An array of Channel objects that specify the input for the training jobs that the tuning job launches.

", - "TrainingJob$InputDataConfig": "

An array of Channel objects that describes each data input channel.

Your input must be in the same Amazon Web Services region as your training job.

", - "TrainingJobDefinition$InputDataConfig": "

An array of Channel objects, each of which specifies an input source.

" - } - }, - "InputMode": { - "base": null, - "refs": { - "DatasetDefinition$InputMode": "

Whether to use File or Pipe input mode. In File (default) mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.

" - } - }, - "InputModes": { - "base": null, - "refs": { - "ChannelSpecification$SupportedInputModes": "

The allowed input mode, either FILE or PIPE.

In FILE mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode.

In PIPE mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.

" - } - }, - "InstanceCount": { - "base": null, - "refs": { - "ComputeQuotaResourceConfig$Count": "

The number of instances to add to the instance group of a SageMaker HyperPod cluster.

", - "InstanceGroupScalingMetadata$InstanceCount": "

The current number of instances in the group.

", - "InstanceGroupScalingMetadata$MinCount": "

Minimum instance count of the instance group.

" - } - }, - "InstanceGroup": { - "base": "

Defines an instance group for heterogeneous cluster training. When requesting a training job using the CreateTrainingJob API, you can configure multiple instance groups .

", - "refs": { - "InstanceGroups$member": null - } - }, - "InstanceGroupHealthCheckConfiguration": { - "base": "

The configuration of deep health checks for an instance group.

Overlapping deep health check configurations will be merged into a single operation.

", - "refs": { - "DeepHealthCheckConfigurations$member": null - } - }, - "InstanceGroupMetadata": { - "base": "

Metadata information about an instance group in a HyperPod cluster.

", - "refs": { - "EventMetadata$InstanceGroup": "

Metadata specific to instance group-level events.

" - } - }, - "InstanceGroupName": { - "base": null, - "refs": { - "BatchAddClusterNodesError$InstanceGroupName": "

The name of the instance group for which the error occurred.

", - "InstanceGroup$InstanceGroupName": "

Specifies the name of the instance group.

", - "InstanceGroupNames$member": null - } - }, - "InstanceGroupNames": { - "base": null, - "refs": { - "S3DataSource$InstanceGroupNames": "

A list of names of instance groups that get data from the S3 data source.

" - } - }, - "InstanceGroupScalingMetadata": { - "base": "

Metadata information about scaling operations for an instance group.

", - "refs": { - "EventMetadata$InstanceGroupScaling": "

Metadata related to instance group scaling events.

" - } - }, - "InstanceGroupStatus": { - "base": null, - "refs": { - "ClusterInstanceGroupDetails$Status": "

The current status of the cluster instance group.

  • InService: The instance group is active and healthy.

  • Creating: The instance group is being provisioned.

  • Updating: The instance group is being updated.

  • Failed: The instance group has failed to provision or is no longer healthy.

  • Degraded: The instance group is degraded, meaning that some instances have failed to provision or are no longer healthy.

  • Deleting: The instance group is being deleted.

", - "ClusterRestrictedInstanceGroupDetails$Status": "

The current status of the cluster's restricted instance group.

  • InService: The restricted instance group is active and healthy.

  • Creating: The restricted instance group is being provisioned.

  • Updating: The restricted instance group is being updated.

  • Failed: The restricted instance group has failed to provision or is no longer healthy.

  • Degraded: The restricted instance group is degraded, meaning that some instances have failed to provision or are no longer healthy.

  • Deleting: The restricted instance group is being deleted.

" - } - }, - "InstanceGroupTrainingPlanStatus": { - "base": null, - "refs": { - "ClusterInstanceGroupDetails$TrainingPlanStatus": "

The current status of the training plan associated with this cluster instance group.

", - "ClusterRestrictedInstanceGroupDetails$TrainingPlanStatus": "

The current status of the training plan associated with this cluster restricted instance group.

" - } - }, - "InstanceGroups": { - "base": null, - "refs": { - "ResourceConfig$InstanceGroups": "

The configuration of a heterogeneous cluster in JSON format.

" - } - }, - "InstanceIds": { - "base": null, - "refs": { - "InstanceGroupHealthCheckConfiguration$InstanceIds": "

A list of Amazon Elastic Compute Cloud (EC2) instance IDs on which to perform deep health checks.

Leave this field blank to perform deep health checks on the entire instance group.

" - } - }, - "InstanceMetadata": { - "base": "

Metadata information about an instance in a HyperPod cluster.

", - "refs": { - "EventMetadata$Instance": "

Metadata specific to instance-level events.

" - } - }, - "InstanceMetadataServiceConfiguration": { - "base": "

Information on the IMDS configuration of the notebook instance

", - "refs": { - "CreateNotebookInstanceInput$InstanceMetadataServiceConfiguration": "

Information on the IMDS configuration of the notebook instance

", - "DescribeNotebookInstanceOutput$InstanceMetadataServiceConfiguration": "

Information on the IMDS configuration of the notebook instance

", - "UpdateNotebookInstanceInput$InstanceMetadataServiceConfiguration": "

Information on the IMDS configuration of the notebook instance

" - } - }, - "InstancePlacementConfig": { - "base": "

Configuration for how instances are placed and allocated within UltraServers. This is only applicable for UltraServer capacity.

", - "refs": { - "ResourceConfig$InstancePlacementConfig": "

Configuration for how training job instances are placed and allocated within UltraServers. Only applicable for UltraServer capacity.

" - } - }, - "InstancePool": { - "base": "

Specifies an instance type and its priority for a heterogeneous endpoint. Use instance pools to configure a production variant with multiple instance types, enabling the endpoint to provision instances across different types based on priority.

", - "refs": { - "InstancePoolList$member": null - } - }, - "InstancePoolList": { - "base": null, - "refs": { - "ProductionVariant$InstancePools": "

A list of instance pools for the production variant. Each instance pool specifies an instance type and its priority for provisioning. Use instance pools to configure heterogeneous endpoints that deploy models across multiple instance types.

" - } - }, - "InstancePoolPriority": { - "base": null, - "refs": { - "InstancePool$Priority": "

The priority for the instance pool. SageMaker attempts to provision instances in order of priority, starting with the lowest value. If instances for a higher-priority pool are unavailable, SageMaker attempts to provision from the next pool.

Valid values: 1 to 5, where 1 is the highest priority.

" - } - }, - "InstancePoolSummary": { - "base": "

A summary of an instance pool for a production variant, including the instance type and the current number of instances.

", - "refs": { - "InstancePoolSummaryList$member": null - } - }, - "InstancePoolSummaryList": { - "base": null, - "refs": { - "PendingProductionVariantSummary$InstancePools": "

A list of instance pools for the production variant. Each pool indicates the instance type and the current number of instances of that type.

", - "ProductionVariantSummary$InstancePools": "

A list of instance pools for the production variant. Each pool indicates the instance type and the current number of instances of that type.

" - } - }, - "InstanceRequirementsEniConfiguration": { - "base": "

The customer ENI and additional ENIs associated with a network interface category.

", - "refs": { - "InstanceRequirementsEniConfigurations$member": null - } - }, - "InstanceRequirementsEniConfigurations": { - "base": null, - "refs": { - "InstanceMetadata$InstanceRequirementsEniConfigurations": "

The ENI configurations for the instance types in the instance requirements, grouped by network interface category (for example, ENI-only or EFA with ENIs). At most one configuration per category.

" - } - }, - "InstanceType": { - "base": null, - "refs": { - "CreateNotebookInstanceInput$InstanceType": "

The type of ML compute instance to launch for the notebook instance.

", - "DescribeNotebookInstanceOutput$InstanceType": "

The type of ML compute instance running on the notebook instance.

", - "NotebookInstanceSummary$InstanceType": "

The type of ML compute instance that the notebook instance is running on.

", - "UpdateNotebookInstanceInput$InstanceType": "

The Amazon ML compute instance type.

" - } - }, - "Integer": { - "base": null, - "refs": { - "ClusterSchedulerConfigSummary$ClusterSchedulerConfigVersion": "

Version of the cluster policy.

", - "ComputeQuotaSummary$ComputeQuotaVersion": "

Version of the compute allocation definition.

", - "CreateModelCardExportJobRequest$ModelCardVersion": "

The version of the model card to export. If a version is not provided, then the latest version of the model card is exported.

", - "DescribeClusterSchedulerConfigRequest$ClusterSchedulerConfigVersion": "

Version of the cluster policy.

", - "DescribeClusterSchedulerConfigResponse$ClusterSchedulerConfigVersion": "

Version of the cluster policy.

", - "DescribeComputeQuotaRequest$ComputeQuotaVersion": "

Version of the compute allocation definition.

", - "DescribeComputeQuotaResponse$ComputeQuotaVersion": "

Version of the compute allocation definition.

", - "DescribeDeviceResponse$MaxModels": "

The maximum number of models.

", - "DescribeEdgeDeploymentPlanResponse$EdgeDeploymentSuccess": "

The number of edge devices with the successful deployment.

", - "DescribeEdgeDeploymentPlanResponse$EdgeDeploymentPending": "

The number of edge devices yet to pick up deployment, or in progress.

", - "DescribeEdgeDeploymentPlanResponse$EdgeDeploymentFailed": "

The number of edge devices that failed the deployment.

", - "DescribeModelCardExportJobResponse$ModelCardVersion": "

The version of the model card that the model export job exports.

", - "DescribeModelCardRequest$ModelCardVersion": "

The version of the model card to describe. If a version is not provided, then the latest version of the model card is described.

", - "DescribeModelCardResponse$ModelCardVersion": "

The version of the model card.

", - "DynamicScalingConfiguration$MinCapacity": "

The recommended minimum capacity to specify for your autoscaling policy.

", - "DynamicScalingConfiguration$MaxCapacity": "

The recommended maximum capacity to specify for your autoscaling policy.

", - "DynamicScalingConfiguration$ScaleInCooldown": "

The recommended scale in cooldown time for your autoscaling policy.

", - "DynamicScalingConfiguration$ScaleOutCooldown": "

The recommended scale out cooldown time for your autoscaling policy.

", - "EdgeDeploymentPlanSummary$EdgeDeploymentSuccess": "

The number of edge devices with the successful deployment.

", - "EdgeDeploymentPlanSummary$EdgeDeploymentPending": "

The number of edge devices yet to pick up the deployment, or in progress.

", - "EdgeDeploymentPlanSummary$EdgeDeploymentFailed": "

The number of edge devices that failed the deployment.

", - "EdgeDeploymentStatus$EdgeDeploymentSuccessInStage": "

The number of edge devices with the successful deployment in the current stage.

", - "EdgeDeploymentStatus$EdgeDeploymentPendingInStage": "

The number of edge devices yet to pick up the deployment in current stage, or in progress.

", - "EdgeDeploymentStatus$EdgeDeploymentFailedInStage": "

The number of edge devices that failed the deployment in current stage.

", - "HyperParameterTuningJobCompletionDetails$NumberOfTrainingJobsObjectiveNotImproving": "

The number of training jobs launched by a tuning job that are not improving (1% or less) as measured by model performance evaluated against an objective function.

", - "HyperParameterTuningJobConsumedResources$RuntimeInSeconds": "

The wall clock runtime in seconds used by your hyperparameter tuning job.

", - "InferenceMetrics$MaxInvocations": "

The expected maximum number of requests per minute for the instance.

", - "InferenceMetrics$ModelLatency": "

The expected model latency at maximum invocations per minute for the instance.

", - "ListModelCardExportJobsRequest$ModelCardVersion": "

List export jobs for the model card with the specified version.

", - "ModelCard$ModelCardVersion": "

The version of the model card.

", - "ModelCardExportJobSummary$ModelCardVersion": "

The version of the model card that the export job exports.

", - "ModelCardVersionSummary$ModelCardVersion": "

A version of the model card.

", - "ModelDashboardModelCard$ModelCardVersion": "

The model card version.

", - "ModelLatencyThreshold$ValueInMilliseconds": "

The model latency percentile value in milliseconds.

", - "PipelineExecutionStep$AttemptCount": "

The current attempt of the execution step. For more information, see Retry Policy for SageMaker Pipelines steps.

", - "RecommendationJobStoppingConditions$MaxInvocations": "

The maximum number of requests per minute expected for the endpoint.

", - "RecommendationMetrics$MaxInvocations": "

The expected maximum number of requests per minute for the instance.

", - "RecommendationMetrics$ModelLatency": "

The expected model latency at maximum invocation per minute for the instance.

", - "ScalingPolicyMetric$InvocationsPerInstance": "

The number of invocations sent to a model, normalized by InstanceCount in each ProductionVariant. 1/numberOfInstances is sent as the value on each request, where numberOfInstances is the number of active instances for the ProductionVariant behind the endpoint at the time of the request.

", - "ScalingPolicyMetric$ModelLatency": "

The interval of time taken by a model to respond as viewed from SageMaker. This interval includes the local communication times taken to send the request and to fetch the response from the container of a model and the time taken to complete the inference in the container.

", - "ScalingPolicyObjective$MinInvocationsPerMinute": "

The minimum number of expected requests to your endpoint per minute.

", - "ScalingPolicyObjective$MaxInvocationsPerMinute": "

The maximum number of expected requests to your endpoint per minute.

", - "UpdateClusterSchedulerConfigRequest$TargetVersion": "

Target version.

", - "UpdateClusterSchedulerConfigResponse$ClusterSchedulerConfigVersion": "

Version of the cluster policy.

", - "UpdateComputeQuotaRequest$TargetVersion": "

Target version.

", - "UpdateComputeQuotaResponse$ComputeQuotaVersion": "

Version of the compute allocation definition.

" - } - }, - "IntegerParameterRange": { - "base": "

For a hyperparameter of the integer type, specifies the range that a hyperparameter tuning job searches.

", - "refs": { - "IntegerParameterRanges$member": null - } - }, - "IntegerParameterRangeSpecification": { - "base": "

Defines the possible values for an integer hyperparameter.

", - "refs": { - "ParameterRange$IntegerParameterRangeSpecification": "

A IntegerParameterRangeSpecification object that defines the possible values for an integer hyperparameter.

" - } - }, - "IntegerParameterRanges": { - "base": null, - "refs": { - "ParameterRanges$IntegerParameterRanges": "

The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.

" - } - }, - "InvocationEndTime": { - "base": null, - "refs": { - "InferenceRecommendation$InvocationEndTime": "

A timestamp that shows when the benchmark completed.

", - "RecommendationJobInferenceBenchmark$InvocationEndTime": "

A timestamp that shows when the benchmark completed.

" - } - }, - "InvocationStartTime": { - "base": null, - "refs": { - "InferenceRecommendation$InvocationStartTime": "

A timestamp that shows when the benchmark started.

", - "RecommendationJobInferenceBenchmark$InvocationStartTime": "

A timestamp that shows when the benchmark started.

" - } - }, - "InvocationsMaxRetries": { - "base": null, - "refs": { - "ModelClientConfig$InvocationsMaxRetries": "

The maximum number of retries when invocation requests are failing. The default value is 3.

" - } - }, - "InvocationsTimeoutInSeconds": { - "base": null, - "refs": { - "ModelClientConfig$InvocationsTimeoutInSeconds": "

The timeout value in seconds for an invocation request. The default value is 600.

" - } - }, - "IotRoleAlias": { - "base": null, - "refs": { - "DescribeDeviceFleetResponse$IotRoleAlias": "

The Amazon Resource Name (ARN) alias created in Amazon Web Services Internet of Things (IoT).

" - } - }, - "IsTrackingServerActive": { - "base": null, - "refs": { - "DescribeMlflowTrackingServerResponse$IsActive": "

Whether the described MLflow Tracking Server is currently active.

", - "TrackingServerSummary$IsActive": "

The activity status of a listed tracking server.

" - } - }, - "ItemIdentifierAttributeName": { - "base": null, - "refs": { - "TimeSeriesConfig$ItemIdentifierAttributeName": "

The name of the column that represents the set of item identifiers for which you want to predict the target value.

" - } - }, - "Job": { - "base": "

The properties of a job returned by the Search API.

", - "refs": { - "SearchRecord$Job": "

The properties of a job.

" - } - }, - "JobArn": { - "base": null, - "refs": { - "CreateJobResponse$JobArn": "

The Amazon Resource Name (ARN) of the job.

", - "DescribeJobResponse$JobArn": "

The Amazon Resource Name (ARN) of the job.

", - "Job$JobArn": "

The Amazon Resource Name (ARN) of the job.

", - "JobSummary$JobArn": "

The Amazon Resource Name (ARN) of the job.

" - } - }, - "JobCategory": { - "base": null, - "refs": { - "CreateJobRequest$JobCategory": "

The category of the job. The category determines the type of workload that the job runs.

", - "DeleteJobRequest$JobCategory": "

The category of the job to delete.

", - "DescribeJobRequest$JobCategory": "

The category of the job.

", - "DescribeJobResponse$JobCategory": "

The category of the job.

", - "DescribeJobSchemaVersionRequest$JobCategory": "

The category of the job schema to describe.

", - "DescribeJobSchemaVersionResponse$JobCategory": "

The category of the job schema.

", - "Job$JobCategory": "

The category of the job.

", - "JobSummary$JobCategory": "

The category of the job.

", - "ListJobSchemaVersionsRequest$JobCategory": "

The category of job schemas to list.

", - "ListJobsRequest$JobCategory": "

The category of jobs to list.

", - "StopJobRequest$JobCategory": "

The category of the job to stop.

" - } - }, - "JobConfigDocument": { - "base": null, - "refs": { - "CreateJobRequest$JobConfigDocument": "

The JSON configuration document for the job. The document must conform to the schema specified by JobConfigSchemaVersion. Use DescribeJobSchemaVersion to retrieve the schema for validation.

", - "DescribeJobResponse$JobConfigDocument": "

The JSON configuration document for the job.

", - "DescribeJobSchemaVersionResponse$JobConfigSchema": "

The JSON schema document that defines the structure of the job configuration.

", - "Job$JobConfigDocument": "

The JSON configuration document for the job.

" - } - }, - "JobConfigSchemaVersionSummary": { - "base": "

Provides summary information about a job configuration schema version.

", - "refs": { - "JobConfigSchemas$member": null - } - }, - "JobConfigSchemas": { - "base": null, - "refs": { - "ListJobSchemaVersionsResponse$JobConfigSchemas": "

An array of JobConfigSchemaVersionSummary objects listing the available schema versions.

" - } - }, - "JobDurationInSeconds": { - "base": null, - "refs": { - "RecommendationJobInputConfig$JobDurationInSeconds": "

Specifies the maximum duration of the job, in seconds. The maximum value is 18,000 seconds.

" - } - }, - "JobName": { - "base": null, - "refs": { - "CreateJobRequest$JobName": "

The name of the job. The name must be unique within your account and Amazon Web Services Region.

", - "DeleteJobRequest$JobName": "

The name of the job to delete.

", - "DescribeJobRequest$JobName": "

The name of the job to describe.

", - "DescribeJobResponse$JobName": "

The name of the job.

", - "Job$JobName": "

The name of the job.

", - "JobSummary$JobName": "

The name of the job.

", - "StopJobRequest$JobName": "

The name of the job to stop.

" - } - }, - "JobReferenceCode": { - "base": null, - "refs": { - "DescribeLabelingJobResponse$JobReferenceCode": "

A unique identifier for work done as part of a labeling job.

", - "LabelingJobForWorkteamSummary$JobReferenceCode": "

A unique identifier for a labeling job. You can use this to refer to a specific labeling job.

" - } - }, - "JobReferenceCodeContains": { - "base": null, - "refs": { - "ListLabelingJobsForWorkteamRequest$JobReferenceCodeContains": "

A filter the limits jobs to only the ones whose job reference code contains the specified string.

" - } - }, - "JobSchemaVersion": { - "base": null, - "refs": { - "CreateJobRequest$JobConfigSchemaVersion": "

The version of the configuration schema to use for the job configuration document. Use ListJobSchemaVersions to get available schema versions for a job category.

", - "DescribeJobResponse$JobConfigSchemaVersion": "

The schema version used for the job configuration document.

", - "DescribeJobSchemaVersionRequest$JobConfigSchemaVersion": "

The version of the schema to retrieve. If not specified, the latest version is returned.

", - "DescribeJobSchemaVersionResponse$JobConfigSchemaVersion": "

The version of the schema.

", - "Job$JobConfigSchemaVersion": "

The schema version used for the job configuration document.

", - "JobConfigSchemaVersionSummary$JobConfigSchemaVersion": "

The version of the job configuration schema.

" - } - }, - "JobSecondaryStatus": { - "base": null, - "refs": { - "DescribeJobResponse$SecondaryStatus": "

The detailed secondary status of the job, providing more granular information about the job's progress. Secondary statuses may change between releases.

", - "Job$SecondaryStatus": "

The detailed secondary status of the job, providing more granular information about the job's progress.

", - "JobSecondaryStatusTransition$Status": "

The secondary status of the job at this transition point.

", - "JobSummary$JobSecondaryStatus": "

The secondary status of the job, providing more granular information about the job's progress. Secondary statuses may change between releases.

" - } - }, - "JobSecondaryStatusTransition": { - "base": "

Represents a secondary status transition for a job. Jobs progress through multiple secondary statuses during execution. Each transition records the status, start time, optional end time, and an optional message with additional details.

", - "refs": { - "JobSecondaryStatusTransitions$member": null - } - }, - "JobSecondaryStatusTransitions": { - "base": null, - "refs": { - "DescribeJobResponse$SecondaryStatusTransitions": "

A list of secondary status transitions for the job, with timestamps and optional status messages.

", - "Job$SecondaryStatusTransitions": "

A list of secondary status transitions for the job, with timestamps and optional status messages.

" - } - }, - "JobStatus": { - "base": null, - "refs": { - "DescribeJobResponse$JobStatus": "

The current status of the job.

", - "Job$JobStatus": "

The current status of the job.

", - "JobSummary$JobStatus": "

The current status of the job.

", - "ListJobsRequest$StatusEquals": "

A filter that returns only jobs with the specified status.

" - } - }, - "JobStepMetadata": { - "base": "

Metadata for a SageMaker job step.

", - "refs": { - "PipelineExecutionStepMetadata$Job": "

The metadata for a SageMaker job used in a pipeline execution step.

" - } - }, - "JobSummaries": { - "base": null, - "refs": { - "ListJobsResponse$JobSummaries": "

An array of JobSummary objects that provide summary information about the jobs.

" - } - }, - "JobSummary": { - "base": "

Provides summary information about a job, returned by the ListJobs operation. Use DescribeJob to get full details for a specific job.

", - "refs": { - "JobSummaries$member": null - } - }, - "JobType": { - "base": null, - "refs": { - "CreateImageVersionRequest$JobType": "

Indicates SageMaker AI job type compatibility.

  • TRAINING: The image version is compatible with SageMaker AI training jobs.

  • INFERENCE: The image version is compatible with SageMaker AI inference jobs.

  • NOTEBOOK_KERNEL: The image version is compatible with SageMaker AI notebook kernels.

", - "DescribeImageVersionResponse$JobType": "

Indicates SageMaker AI job type compatibility.

  • TRAINING: The image version is compatible with SageMaker AI training jobs.

  • INFERENCE: The image version is compatible with SageMaker AI inference jobs.

  • NOTEBOOK_KERNEL: The image version is compatible with SageMaker AI notebook kernels.

", - "UpdateImageVersionRequest$JobType": "

Indicates SageMaker AI job type compatibility.

  • TRAINING: The image version is compatible with SageMaker AI training jobs.

  • INFERENCE: The image version is compatible with SageMaker AI inference jobs.

  • NOTEBOOK_KERNEL: The image version is compatible with SageMaker AI notebook kernels.

" - } - }, - "JoinSource": { - "base": null, - "refs": { - "DataProcessing$JoinSource": "

Specifies the source of the data to join with the transformed data. The valid values are None and Input. The default value is None, which specifies not to join the input with the transformed data. If you want the batch transform job to join the original input data with the transformed data, set JoinSource to Input. You can specify OutputFilter as an additional filter to select a portion of the joined dataset and store it in the output file.

For JSON or JSONLines objects, such as a JSON array, SageMaker adds the transformed data to the input JSON object in an attribute called SageMakerOutput. The joined result for JSON must be a key-value pair object. If the input is not a key-value pair object, SageMaker creates a new JSON file. In the new JSON file, and the input data is stored under the SageMakerInput key and the results are stored in SageMakerOutput.

For CSV data, SageMaker takes each row as a JSON array and joins the transformed data with the input by appending each transformed row to the end of the input. The joined data has the original input data followed by the transformed data and the output is a CSV file.

For information on how joining in applied, see Workflow for Associating Inferences with Input Records.

" - } - }, - "JsonContentType": { - "base": null, - "refs": { - "JsonContentTypes$member": null - } - }, - "JsonContentTypes": { - "base": null, - "refs": { - "CaptureContentTypeHeader$JsonContentTypes": "

The list of all content type headers that SageMaker AI will treat as JSON and capture accordingly.

" - } - }, - "JsonPath": { - "base": null, - "refs": { - "DataProcessing$InputFilter": "

A JSONPath expression used to select a portion of the input data to pass to the algorithm. Use the InputFilter parameter to exclude fields, such as an ID column, from the input. If you want SageMaker to pass the entire input dataset to the algorithm, accept the default value $.

Examples: \"$\", \"$[1:]\", \"$.features\"

", - "DataProcessing$OutputFilter": "

A JSONPath expression used to select a portion of the joined dataset to save in the output file for a batch transform job. If you want SageMaker to store the entire input dataset in the output file, leave the default value, $. If you specify indexes that aren't within the dimension size of the joined dataset, you get an error.

Examples: \"$\", \"$[0,5:]\", \"$['id','SageMakerOutput']\"

" - } - }, - "JupyterLabAppImageConfig": { - "base": "

The configuration for the file system and kernels in a SageMaker AI image running as a JupyterLab app. The FileSystemConfig object is not supported.

", - "refs": { - "AppImageConfigDetails$JupyterLabAppImageConfig": "

The configuration for the file system and the runtime, such as the environment variables and entry point.

", - "CreateAppImageConfigRequest$JupyterLabAppImageConfig": "

The JupyterLabAppImageConfig. You can only specify one image kernel in the AppImageConfig API. This kernel is shown to users before the image starts. After the image runs, all kernels are visible in JupyterLab.

", - "DescribeAppImageConfigResponse$JupyterLabAppImageConfig": "

The configuration of the JupyterLab app.

", - "UpdateAppImageConfigRequest$JupyterLabAppImageConfig": "

The JupyterLab app running on the image.

" - } - }, - "JupyterLabAppSettings": { - "base": "

The settings for the JupyterLab application.

", - "refs": { - "DefaultSpaceSettings$JupyterLabAppSettings": null, - "UserSettings$JupyterLabAppSettings": "

The settings for the JupyterLab application.

SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

" - } - }, - "JupyterServerAppSettings": { - "base": "

The JupyterServer app settings.

", - "refs": { - "DefaultSpaceSettings$JupyterServerAppSettings": null, - "SpaceSettings$JupyterServerAppSettings": null, - "UserSettings$JupyterServerAppSettings": "

The Jupyter server's app settings.

" - } - }, - "KeepAlivePeriodInSeconds": { - "base": "

Optional. Customer requested period in seconds for which the Training cluster is kept alive after the job is finished.

", - "refs": { - "ResourceConfig$KeepAlivePeriodInSeconds": "

The duration of time in seconds to retain configured resources in a warm pool for subsequent training jobs.

", - "ResourceConfigForUpdate$KeepAlivePeriodInSeconds": "

The KeepAlivePeriodInSeconds value specified in the ResourceConfig to update.

" - } - }, - "KendraSettings": { - "base": "

The Amazon SageMaker Canvas application setting where you configure document querying.

", - "refs": { - "CanvasAppSettings$KendraSettings": "

The settings for document querying.

" - } - }, - "KernelDisplayName": { - "base": null, - "refs": { - "KernelSpec$DisplayName": "

The display name of the kernel.

" - } - }, - "KernelGatewayAppSettings": { - "base": "

The KernelGateway app settings.

", - "refs": { - "DefaultSpaceSettings$KernelGatewayAppSettings": null, - "SpaceSettings$KernelGatewayAppSettings": null, - "UserSettings$KernelGatewayAppSettings": "

The kernel gateway app settings.

" - } - }, - "KernelGatewayImageConfig": { - "base": "

The configuration for the file system and kernels in a SageMaker AI image running as a KernelGateway app.

", - "refs": { - "AppImageConfigDetails$KernelGatewayImageConfig": "

The configuration for the file system and kernels in the SageMaker AI image.

", - "CreateAppImageConfigRequest$KernelGatewayImageConfig": "

The KernelGatewayImageConfig. You can only specify one image kernel in the AppImageConfig API. This kernel will be shown to users before the image starts. Once the image runs, all kernels are visible in JupyterLab.

", - "DescribeAppImageConfigResponse$KernelGatewayImageConfig": "

The configuration of a KernelGateway app.

", - "UpdateAppImageConfigRequest$KernelGatewayImageConfig": "

The new KernelGateway app to run on the image.

" - } - }, - "KernelName": { - "base": null, - "refs": { - "KernelSpec$Name": "

The name of the Jupyter kernel in the image. This value is case sensitive.

" - } - }, - "KernelSpec": { - "base": "

The specification of a Jupyter kernel.

", - "refs": { - "KernelSpecs$member": null - } - }, - "KernelSpecs": { - "base": null, - "refs": { - "KernelGatewayImageConfig$KernelSpecs": "

The specification of the Jupyter kernels in the image.

" - } - }, - "Key": { - "base": null, - "refs": { - "PipelineDefinitionS3Location$ObjectKey": "

The object key (or key name) uniquely identifies the object in an S3 bucket.

" - } - }, - "KmsKeyId": { - "base": null, - "refs": { - "AsyncInferenceOutputConfig$KmsKeyId": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the asynchronous inference output in Amazon S3.

", - "AthenaDatasetDefinition$KmsKeyId": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data generated from an Athena query execution.

", - "AutoMLOutputDataConfig$KmsKeyId": "

The Key Management Service encryption key ID.

", - "AutoMLSecurityConfig$VolumeKmsKeyId": "

The key used to encrypt stored data.

", - "BatchDataCaptureConfig$KmsKeyId": "

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the batch transform job.

The KmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

", - "ClusterEbsVolumeConfig$VolumeKmsKeyId": "

The ID of a KMS key to encrypt the Amazon EBS volume.

", - "CreateDomainRequest$HomeEfsFileSystemKmsKeyId": "

Use KmsKeyId.

", - "CreateDomainRequest$KmsKeyId": "

SageMaker AI uses Amazon Web Services KMS to encrypt EFS and EBS volumes attached to the domain with an Amazon Web Services managed key by default. For more control, specify a customer managed key.

", - "CreateEdgePackagingJobRequest$ResourceKey": "

The Amazon Web Services KMS key to use when encrypting the EBS volume the edge packaging job runs on.

", - "CreateEndpointConfigInput$KmsKeyId": "

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.

The KmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint, UpdateEndpoint requests. For more information, refer to the Amazon Web Services Key Management Service section Using Key Policies in Amazon Web Services KMS

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. If any of the models that you specify in the ProductionVariants parameter use nitro-based instances with local storage, the KmsKeyId parameter does not encrypt instance local storage.

For a list of instance types that support local instance storage, see Instance Store Volumes.

For more information about local instance storage encryption, see SSD Instance Store Volumes.

", - "CreateInferenceExperimentRequest$KmsKey": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. The KmsKey can be any of the following formats:

  • KMS key ID

    \"1234abcd-12ab-34cd-56ef-1234567890ab\"

  • Amazon Resource Name (ARN) of a KMS key

    \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

  • KMS key Alias

    \"alias/ExampleAlias\"

  • Amazon Resource Name (ARN) of a KMS key Alias

    \"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"

If you use a KMS key ID or an alias of your KMS key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to \"aws:kms\". For more information, see KMS managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint and UpdateEndpoint requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

", - "CreateNotebookInstanceInput$KmsKeyId": "

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker AI uses to encrypt data on the storage volume attached to your notebook instance. The KMS key you provide must be enabled. For information, see Enabling and Disabling Keys in the Amazon Web Services Key Management Service Developer Guide.

", - "CreatePartnerAppRequest$KmsKeyId": "

SageMaker Partner AI Apps uses Amazon Web Services KMS to encrypt data at rest using an Amazon Web Services managed key by default. For more control, specify a customer managed key.

", - "DataCaptureConfig$KmsKeyId": "

The Amazon Resource Name (ARN) of an Key Management Service key that SageMaker AI uses to encrypt the captured data at rest using Amazon S3 server-side encryption.

The KmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

", - "DataCaptureConfigSummary$KmsKeyId": "

The KMS key being used to encrypt the data in Amazon S3.

", - "DescribeDomainResponse$HomeEfsFileSystemKmsKeyId": "

Use KmsKeyId.

", - "DescribeDomainResponse$KmsKeyId": "

The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to the domain.

", - "DescribeEdgePackagingJobResponse$ResourceKey": "

The Amazon Web Services KMS key to use when encrypting the EBS volume the job run on.

", - "DescribeEndpointConfigOutput$KmsKeyId": "

Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.

", - "DescribeInferenceExperimentResponse$KmsKey": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. For more information, see CreateInferenceExperiment.

", - "DescribeNotebookInstanceOutput$KmsKeyId": "

The Amazon Web Services KMS key ID SageMaker AI uses to encrypt data when storing it on the ML storage volume attached to the instance.

", - "DescribePartnerAppResponse$KmsKeyId": "

The Amazon Web Services KMS customer managed key used to encrypt the data at rest associated with SageMaker Partner AI Apps.

", - "EdgeOutputConfig$KmsKeyId": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account.

", - "FlowDefinitionOutputConfig$KmsKeyId": "

The Amazon Key Management Service (KMS) key ID for server-side encryption.

", - "HyperParameterTuningResourceConfig$VolumeKmsKeyId": "

A key used by Amazon Web Services Key Management Service to encrypt data on the storage volume attached to the compute instances used to run the training job. You can use either of the following formats to specify a key.

KMS Key ID:

\"1234abcd-12ab-34cd-56ef-1234567890ab\"

Amazon Resource Name (ARN) of a KMS key:

\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

Some instances use local storage, which use a hardware module to encrypt storage volumes. If you choose one of these instance types, you cannot request a VolumeKmsKeyId. For a list of instance types that use local storage, see instance store volumes. For more information about Amazon Web Services Key Management Service, see KMS encryption for more information.

", - "InferenceExperimentDataStorageConfig$KmsKey": "

The Amazon Web Services Key Management Service key that Amazon SageMaker uses to encrypt captured data at rest using Amazon S3 server-side encryption.

", - "LabelingJobOutputConfig$KmsKeyId": "

The Amazon Web Services Key Management Service ID of the key used to encrypt the output data, if any.

If you provide your own KMS key ID, you must add the required permissions to your KMS key described in Encrypt Output Data and Storage Volume with Amazon Web Services KMS.

If you don't provide a KMS key ID, Amazon SageMaker uses the default Amazon Web Services KMS key for Amazon S3 for your role's account to encrypt your output data.

If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to \"aws:kms\". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

", - "LabelingJobResourceConfig$VolumeKmsKeyId": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training and inference jobs used for automated data labeling.

You can only specify a VolumeKmsKeyId when you create a labeling job with automated data labeling enabled using the API operation CreateLabelingJob. You cannot specify an Amazon Web Services KMS key to encrypt the storage volume used for automated data labeling model training and inference when you create a labeling job using the console. To learn more, see Output Data and Storage Volume Encryption.

The VolumeKmsKeyId can be any of the following formats:

  • KMS Key ID

    \"1234abcd-12ab-34cd-56ef-1234567890ab\"

  • Amazon Resource Name (ARN) of a KMS Key

    \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

", - "ModelCardSecurityConfig$KmsKeyId": "

A Key Management Service key ID to use for encrypting a model card.

", - "ModelPackageSecurityConfig$KmsKeyId": "

The KMS Key ID (KMSKeyId) used for encryption of model package information.

", - "MonitoringClusterConfig$VolumeKmsKeyId": "

The Key Management Service (KMS) key that Amazon SageMaker AI uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the model monitoring job.

", - "MonitoringOutputConfig$KmsKeyId": "

The Key Management Service (KMS) key that Amazon SageMaker AI uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.

", - "OnlineStoreSecurityConfig$KmsKeyId": "

The Amazon Web Services Key Management Service (KMS) key ARN that SageMaker Feature Store uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side encryption.

The caller (either user or IAM role) of CreateFeatureGroup must have below permissions to the OnlineStore KmsKeyId:

  • \"kms:Encrypt\"

  • \"kms:Decrypt\"

  • \"kms:DescribeKey\"

  • \"kms:CreateGrant\"

  • \"kms:RetireGrant\"

  • \"kms:ReEncryptFrom\"

  • \"kms:ReEncryptTo\"

  • \"kms:GenerateDataKey\"

  • \"kms:ListAliases\"

  • \"kms:ListGrants\"

  • \"kms:RevokeGrant\"

The caller (either user or IAM role) to all DataPlane operations (PutRecord, GetRecord, DeleteRecord) must have the following permissions to the KmsKeyId:

  • \"kms:Decrypt\"

", - "OptimizationJobOutputConfig$KmsKeyId": "

The Amazon Resource Name (ARN) of a key in Amazon Web Services KMS. SageMaker uses they key to encrypt the artifacts of the optimized model when SageMaker uploads the model to Amazon S3.

", - "OutputConfig$KmsKeyId": "

The Amazon Web Services Key Management Service key (Amazon Web Services KMS) that Amazon SageMaker AI uses to encrypt your output models with Amazon S3 server-side encryption after compilation job. If you don't provide a KMS key ID, Amazon SageMaker AI uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

The KmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

", - "OutputDataConfig$KmsKeyId": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

  • // KMS Key ID

    \"1234abcd-12ab-34cd-56ef-1234567890ab\"

  • // Amazon Resource Name (ARN) of a KMS Key

    \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

  • // KMS Key Alias

    \"alias/ExampleAlias\"

  • // Amazon Resource Name (ARN) of a KMS Key Alias

    \"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"

If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide. If the output data is stored in Amazon S3 Express One Zone, it is encrypted with server-side encryption with Amazon S3 managed keys (SSE-S3). KMS key is not supported for Amazon S3 Express One Zone

The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob, CreateTransformJob, or CreateHyperParameterTuningJob requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

", - "ProcessingClusterConfig$VolumeKmsKeyId": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the processing job.

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage.

For a list of instance types that support local instance storage, see Instance Store Volumes.

For more information about local instance storage encryption, see SSD Instance Store Volumes.

", - "ProcessingOutputConfig$KmsKeyId": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the processing job output. KmsKeyId can be an ID of a KMS key, ARN of a KMS key, or alias of a KMS key. The KmsKeyId is applied to all outputs.

", - "ProductionVariantCoreDumpConfig$KmsKeyId": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the core dump data at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

  • // KMS Key ID

    \"1234abcd-12ab-34cd-56ef-1234567890ab\"

  • // Amazon Resource Name (ARN) of a KMS Key

    \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

  • // KMS Key Alias

    \"alias/ExampleAlias\"

  • // Amazon Resource Name (ARN) of a KMS Key Alias

    \"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"

If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, SageMaker uses the default KMS key for Amazon S3 for your role's account. SageMaker uses server-side encryption with KMS-managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to \"aws:kms\". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint and UpdateEndpoint requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

", - "RecommendationJobInputConfig$VolumeKmsKeyId": "

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. This key will be passed to SageMaker Hosting for endpoint creation.

The SageMaker execution role must have kms:CreateGrant permission in order to encrypt data on the storage volume of the endpoints created for inference recommendation. The inference recommendation job will fail asynchronously during endpoint configuration creation if the role passed does not have kms:CreateGrant permission.

The KmsKeyId can be any of the following formats:

  • // KMS Key ID

    \"1234abcd-12ab-34cd-56ef-1234567890ab\"

  • // Amazon Resource Name (ARN) of a KMS Key

    \"arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>\"

  • // KMS Key Alias

    \"alias/ExampleAlias\"

  • // Amazon Resource Name (ARN) of a KMS Key Alias

    \"arn:aws:kms:<region>:<account>:alias/<ExampleAlias>\"

For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.

", - "RecommendationJobOutputConfig$KmsKeyId": "

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt your output artifacts with Amazon S3 server-side encryption. The SageMaker execution role must have kms:GenerateDataKey permission.

The KmsKeyId can be any of the following formats:

  • // KMS Key ID

    \"1234abcd-12ab-34cd-56ef-1234567890ab\"

  • // Amazon Resource Name (ARN) of a KMS Key

    \"arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>\"

  • // KMS Key Alias

    \"alias/ExampleAlias\"

  • // Amazon Resource Name (ARN) of a KMS Key Alias

    \"arn:aws:kms:<region>:<account>:alias/<ExampleAlias>\"

For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.

", - "RedshiftDatasetDefinition$KmsKeyId": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data from a Redshift execution.

", - "ResourceConfig$VolumeKmsKeyId": "

The Amazon Web Services KMS key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job.

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage.

For a list of instance types that support local instance storage, see Instance Store Volumes.

For more information about local instance storage encryption, see SSD Instance Store Volumes.

The VolumeKmsKeyId can be in any of the following formats:

  • // KMS Key ID

    \"1234abcd-12ab-34cd-56ef-1234567890ab\"

  • // Amazon Resource Name (ARN) of a KMS Key

    \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

", - "S3StorageConfig$KmsKeyId": "

The Amazon Web Services Key Management Service (KMS) key ARN of the key used to encrypt any objects written into the OfflineStore S3 location.

The IAM roleARN that is passed as a parameter to CreateFeatureGroup must have below permissions to the KmsKeyId:

  • \"kms:GenerateDataKey\"

", - "SharingSettings$S3KmsKeyId": "

When NotebookOutputOption is Allowed, the Amazon Web Services Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

", - "TransformOutput$KmsKeyId": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

The KMS key policy must grant permission to the IAM role that you specify in your CreateModel request. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

", - "TransformResources$VolumeKmsKeyId": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume attached to the ML compute instance(s) that run the batch transform job.

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage.

For a list of instance types that support local instance storage, see Instance Store Volumes.

For more information about local instance storage encryption, see SSD Instance Store Volumes.

The VolumeKmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

", - "WorkspaceSettings$S3KmsKeyId": "

The Amazon Web Services Key Management Service (KMS) encryption key ID that is used to encrypt artifacts generated by Canvas in the Amazon S3 bucket.

" - } - }, - "LabelAttributeName": { - "base": null, - "refs": { - "CreateLabelingJobRequest$LabelAttributeName": "

The attribute name to use for the label in the output manifest file. This is the key for the key/value pair formed with the label that a worker assigns to the object. The LabelAttributeName must meet the following requirements.

  • The name can't end with \"-metadata\".

  • If you are using one of the built-in task types or one of the following, the attribute name must end with \"-ref\".

    • Image semantic segmentation (SemanticSegmentation) and adjustment (AdjustmentSemanticSegmentation) labeling jobs for this task type. One exception is that verification (VerificationSemanticSegmentation) must not end with -\"ref\".

    • Video frame object detection (VideoObjectDetection), and adjustment and verification (AdjustmentVideoObjectDetection) labeling jobs for this task type.

    • Video frame object tracking (VideoObjectTracking), and adjustment and verification (AdjustmentVideoObjectTracking) labeling jobs for this task type.

    • 3D point cloud semantic segmentation (3DPointCloudSemanticSegmentation), and adjustment and verification (Adjustment3DPointCloudSemanticSegmentation) labeling jobs for this task type.

    • 3D point cloud object tracking (3DPointCloudObjectTracking), and adjustment and verification (Adjustment3DPointCloudObjectTracking) labeling jobs for this task type.

If you are creating an adjustment or verification labeling job, you must use a different LabelAttributeName than the one used in the original labeling job. The original labeling job is the Ground Truth labeling job that produced the labels that you want verified or adjusted. To learn more about adjustment and verification labeling jobs, see Verify and Adjust Labels.

", - "DescribeLabelingJobResponse$LabelAttributeName": "

The attribute used as the label in the output manifest file.

" - } - }, - "LabelCounter": { - "base": null, - "refs": { - "LabelCounters$TotalLabeled": "

The total number of objects labeled.

", - "LabelCounters$HumanLabeled": "

The total number of objects labeled by a human worker.

", - "LabelCounters$MachineLabeled": "

The total number of objects labeled by automated data labeling.

", - "LabelCounters$FailedNonRetryableError": "

The total number of objects that could not be labeled due to an error.

", - "LabelCounters$Unlabeled": "

The total number of objects not yet labeled.

", - "LabelCountersForWorkteam$HumanLabeled": "

The total number of data objects labeled by a human worker.

", - "LabelCountersForWorkteam$PendingHuman": "

The total number of data objects that need to be labeled by a human worker.

", - "LabelCountersForWorkteam$Total": "

The total number of tasks in the labeling job.

" - } - }, - "LabelCounters": { - "base": "

Provides a breakdown of the number of objects labeled.

", - "refs": { - "DescribeLabelingJobResponse$LabelCounters": "

Provides a breakdown of the number of data objects labeled by humans, the number of objects labeled by machine, the number of objects than couldn't be labeled, and the total number of objects labeled.

", - "LabelingJobSummary$LabelCounters": "

Counts showing the progress of the labeling job.

" - } - }, - "LabelCountersForWorkteam": { - "base": "

Provides counts for human-labeled tasks in the labeling job.

", - "refs": { - "LabelingJobForWorkteamSummary$LabelCounters": "

Provides information about the progress of a labeling job.

" - } - }, - "LabelingJobAlgorithmSpecificationArn": { - "base": null, - "refs": { - "LabelingJobAlgorithmsConfig$LabelingJobAlgorithmSpecificationArn": "

Specifies the Amazon Resource Name (ARN) of the algorithm used for auto-labeling. You must select one of the following ARNs:

  • Image classification

    arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/image-classification

  • Text classification

    arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/text-classification

  • Object detection

    arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/object-detection

  • Semantic Segmentation

    arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/semantic-segmentation

" - } - }, - "LabelingJobAlgorithmsConfig": { - "base": "

Provides configuration information for auto-labeling of your data objects. A LabelingJobAlgorithmsConfig object must be supplied in order to use auto-labeling.

", - "refs": { - "CreateLabelingJobRequest$LabelingJobAlgorithmsConfig": "

Configures the information required to perform automated data labeling.

", - "DescribeLabelingJobResponse$LabelingJobAlgorithmsConfig": "

Configuration information for automated data labeling.

" - } - }, - "LabelingJobArn": { - "base": null, - "refs": { - "CreateLabelingJobResponse$LabelingJobArn": "

The Amazon Resource Name (ARN) of the labeling job. You use this ARN to identify the labeling job.

", - "DescribeLabelingJobResponse$LabelingJobArn": "

The Amazon Resource Name (ARN) of the labeling job.

", - "DescribeTrainingJobResponse$LabelingJobArn": "

The Amazon Resource Name (ARN) of the SageMaker Ground Truth labeling job that created the transform or training job.

", - "DescribeTransformJobResponse$LabelingJobArn": "

The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.

", - "LabelingJobSummary$LabelingJobArn": "

The Amazon Resource Name (ARN) assigned to the labeling job when it was created.

", - "TrainingJob$LabelingJobArn": "

The Amazon Resource Name (ARN) of the labeling job.

", - "TransformJob$LabelingJobArn": "

The Amazon Resource Name (ARN) of the labeling job that created the transform job.

" - } - }, - "LabelingJobDataAttributes": { - "base": "

Attributes of the data specified by the customer. Use these to describe the data to be labeled.

", - "refs": { - "LabelingJobInputConfig$DataAttributes": "

Attributes of the data specified by the customer.

" - } - }, - "LabelingJobDataSource": { - "base": "

Provides information about the location of input data.

You must specify at least one of the following: S3DataSource or SnsDataSource.

Use SnsDataSource to specify an SNS input topic for a streaming labeling job. If you do not specify and SNS input topic ARN, Ground Truth will create a one-time labeling job.

Use S3DataSource to specify an input manifest file for both streaming and one-time labeling jobs. Adding an S3DataSource is optional if you use SnsDataSource to create a streaming labeling job.

", - "refs": { - "LabelingJobInputConfig$DataSource": "

The location of the input data.

" - } - }, - "LabelingJobForWorkteamSummary": { - "base": "

Provides summary information for a work team.

", - "refs": { - "LabelingJobForWorkteamSummaryList$member": null - } - }, - "LabelingJobForWorkteamSummaryList": { - "base": null, - "refs": { - "ListLabelingJobsForWorkteamResponse$LabelingJobSummaryList": "

An array of LabelingJobSummary objects, each describing a labeling job.

" - } - }, - "LabelingJobInputConfig": { - "base": "

Input configuration information for a labeling job.

", - "refs": { - "CreateLabelingJobRequest$InputConfig": "

Input data for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects.

You must specify at least one of the following: S3DataSource or SnsDataSource.

  • Use SnsDataSource to specify an SNS input topic for a streaming labeling job. If you do not specify and SNS input topic ARN, Ground Truth will create a one-time labeling job that stops after all data objects in the input manifest file have been labeled.

  • Use S3DataSource to specify an input manifest file for both streaming and one-time labeling jobs. Adding an S3DataSource is optional if you use SnsDataSource to create a streaming labeling job.

If you use the Amazon Mechanical Turk workforce, your input data should not include confidential information, personal information or protected health information. Use ContentClassifiers to specify that your data is free of personally identifiable information and adult content.

", - "DescribeLabelingJobResponse$InputConfig": "

Input configuration information for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects.

", - "LabelingJobSummary$InputConfig": "

Input configuration for the labeling job.

" - } - }, - "LabelingJobName": { - "base": null, - "refs": { - "CreateLabelingJobRequest$LabelingJobName": "

The name of the labeling job. This name is used to identify the job in a list of labeling jobs. Labeling job names must be unique within an Amazon Web Services account and region. LabelingJobName is not case sensitive. For example, Example-job and example-job are considered the same labeling job name by Ground Truth.

", - "DescribeLabelingJobRequest$LabelingJobName": "

The name of the labeling job to return information for.

", - "DescribeLabelingJobResponse$LabelingJobName": "

The name assigned to the labeling job when it was created.

", - "LabelingJobForWorkteamSummary$LabelingJobName": "

The name of the labeling job that the work team is assigned to.

", - "LabelingJobSummary$LabelingJobName": "

The name of the labeling job.

", - "StopLabelingJobRequest$LabelingJobName": "

The name of the labeling job to stop.

" - } - }, - "LabelingJobOutput": { - "base": "

Specifies the location of the output produced by the labeling job.

", - "refs": { - "DescribeLabelingJobResponse$LabelingJobOutput": "

The location of the output produced by the labeling job.

", - "LabelingJobSummary$LabelingJobOutput": "

The location of the output produced by the labeling job.

" - } - }, - "LabelingJobOutputConfig": { - "base": "

Output configuration information for a labeling job.

", - "refs": { - "CreateLabelingJobRequest$OutputConfig": "

The location of the output data and the Amazon Web Services Key Management Service key ID for the key used to encrypt the output data, if any.

", - "DescribeLabelingJobResponse$OutputConfig": "

The location of the job's output data and the Amazon Web Services Key Management Service key ID for the key used to encrypt the output data, if any.

" - } - }, - "LabelingJobResourceConfig": { - "base": "

Configure encryption on the storage volume attached to the ML compute instance used to run automated data labeling model training and inference.

", - "refs": { - "LabelingJobAlgorithmsConfig$LabelingJobResourceConfig": "

Provides configuration information for a labeling job.

" - } - }, - "LabelingJobS3DataSource": { - "base": "

The Amazon S3 location of the input data objects.

", - "refs": { - "LabelingJobDataSource$S3DataSource": "

The Amazon S3 location of the input data objects.

" - } - }, - "LabelingJobSnsDataSource": { - "base": "

An Amazon SNS data source used for streaming labeling jobs.

", - "refs": { - "LabelingJobDataSource$SnsDataSource": "

An Amazon SNS data source used for streaming labeling jobs. To learn more, see Send Data to a Streaming Labeling Job.

" - } - }, - "LabelingJobStatus": { - "base": null, - "refs": { - "DescribeLabelingJobResponse$LabelingJobStatus": "

The processing status of the labeling job.

", - "LabelingJobSummary$LabelingJobStatus": "

The current status of the labeling job.

", - "ListLabelingJobsRequest$StatusEquals": "

A filter that retrieves only labeling jobs with a specific status.

" - } - }, - "LabelingJobStoppingConditions": { - "base": "

A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped. You can use these conditions to control the cost of data labeling.

Labeling jobs fail after 30 days with an appropriate client error message.

", - "refs": { - "CreateLabelingJobRequest$StoppingConditions": "

A set of conditions for stopping the labeling job. If any of the conditions are met, the job is automatically stopped. You can use these conditions to control the cost of data labeling.

", - "DescribeLabelingJobResponse$StoppingConditions": "

A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped.

" - } - }, - "LabelingJobSummary": { - "base": "

Provides summary information about a labeling job.

", - "refs": { - "LabelingJobSummaryList$member": null - } - }, - "LabelingJobSummaryList": { - "base": null, - "refs": { - "ListLabelingJobsResponse$LabelingJobSummaryList": "

An array of LabelingJobSummary objects, each describing a labeling job.

" - } - }, - "LambdaFunctionArn": { - "base": null, - "refs": { - "AnnotationConsolidationConfig$AnnotationConsolidationLambdaArn": "

The Amazon Resource Name (ARN) of a Lambda function implements the logic for annotation consolidation and to process output data.

For built-in task types, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for AnnotationConsolidationLambdaArn. For custom labeling workflows, see Post-annotation Lambda.

Bounding box - Finds the most similar boxes from different workers based on the Jaccard index of the boxes.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-BoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-BoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-BoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-BoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-BoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-BoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-BoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-BoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-BoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-BoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-BoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-BoundingBox

Image classification - Uses a variant of the Expectation Maximization approach to estimate the true class of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClass

Multi-label image classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClassMultiLabel

Semantic segmentation - Treats each pixel in an image as a multi-class classification and treats pixel annotations from workers as \"votes\" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-SemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-SemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-SemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-SemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-SemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-SemanticSegmentation

Text classification - Uses a variant of the Expectation Maximization approach to estimate the true class of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClass

Multi-label text classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClassMultiLabel

Named entity recognition - Groups similar selections and calculates aggregate boundaries, resolving to most-assigned label.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-NamedEntityRecognition

Video Classification - Use this task type when you need workers to classify videos using predefined labels that you specify. Workers are shown videos and are asked to choose one label for each video.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoMultiClass

Video Frame Object Detection - Use this task type to have workers identify and locate objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to identify and localize various objects in a series of video frames, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectDetection

Video Frame Object Tracking - Use this task type to have workers track the movement of objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to track the movement of objects, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectTracking

3D Point Cloud Object Detection - Use this task type when you want workers to classify objects in a 3D point cloud by drawing 3D cuboids around objects. For example, you can use this task type to ask workers to identify different types of objects in a point cloud, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectDetection

3D Point Cloud Object Tracking - Use this task type when you want workers to draw 3D cuboids around objects that appear in a sequence of 3D point cloud frames. For example, you can use this task type to ask workers to track the movement of vehicles across multiple point cloud frames.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectTracking

3D Point Cloud Semantic Segmentation - Use this task type when you want workers to create a point-level semantic segmentation masks by painting objects in a 3D point cloud using different colors where each color is assigned to one of the classes you specify.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudSemanticSegmentation

Use the following ARNs for Label Verification and Adjustment Jobs

Use label verification and adjustment jobs to review and adjust labels. To learn more, see Verify and Adjust Labels .

Semantic Segmentation Adjustment - Treats each pixel in an image as a multi-class classification and treats pixel adjusted annotations from workers as \"votes\" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentSemanticSegmentation

Semantic Segmentation Verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgment for semantic segmentation labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationSemanticSegmentation

Bounding Box Adjustment - Finds the most similar boxes from different workers based on the Jaccard index of the adjusted annotations.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentBoundingBox

Bounding Box Verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgement for bounding box labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationBoundingBox

Video Frame Object Detection Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to classify and localize objects in a sequence of video frames.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectDetection

Video Frame Object Tracking Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to track object movement across a sequence of video frames.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectTracking

3D Point Cloud Object Detection Adjustment - Use this task type when you want workers to adjust 3D cuboids around objects in a 3D point cloud.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectDetection

3D Point Cloud Object Tracking Adjustment - Use this task type when you want workers to adjust 3D cuboids around objects that appear in a sequence of 3D point cloud frames.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectTracking

3D Point Cloud Semantic Segmentation Adjustment - Use this task type when you want workers to adjust a point-level semantic segmentation masks using a paint tool.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudSemanticSegmentation

Generative AI/Custom - Direct passthrough of output data without any transformation.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-PassThrough

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-PassThrough

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-PassThrough

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-PassThrough

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-PassThrough

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-PassThrough

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-PassThrough

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-PassThrough

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-PassThrough

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-PassThrough

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-PassThrough

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-PassThrough

", - "HumanTaskConfig$PreHumanTaskLambdaArn": "

The Amazon Resource Name (ARN) of a Lambda function that is run before a data object is sent to a human worker. Use this function to provide input to a custom labeling job.

For built-in task types, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for PreHumanTaskLambdaArn. For custom labeling workflows, see Pre-annotation Lambda.

Bounding box - Finds the most similar boxes from different workers based on the Jaccard index of the boxes.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-BoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-BoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-BoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-BoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-BoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-BoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-BoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-BoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-BoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-BoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-BoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-BoundingBox

Image classification - Uses a variant of the Expectation Maximization approach to estimate the true class of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClass

Multi-label image classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClassMultiLabel

Semantic segmentation - Treats each pixel in an image as a multi-class classification and treats pixel annotations from workers as \"votes\" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-SemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-SemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-SemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-SemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-SemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-SemanticSegmentation

Text classification - Uses a variant of the Expectation Maximization approach to estimate the true class of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClass

Multi-label text classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClassMultiLabel

Named entity recognition - Groups similar selections and calculates aggregate boundaries, resolving to most-assigned label.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-NamedEntityRecognition

Video Classification - Use this task type when you need workers to classify videos using predefined labels that you specify. Workers are shown videos and are asked to choose one label for each video.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoMultiClass

Video Frame Object Detection - Use this task type to have workers identify and locate objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to identify and localize various objects in a series of video frames, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectDetection

Video Frame Object Tracking - Use this task type to have workers track the movement of objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to track the movement of objects, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectTracking

3D Point Cloud Modalities

Use the following pre-annotation lambdas for 3D point cloud labeling modality tasks. See 3D Point Cloud Task types to learn more.

3D Point Cloud Object Detection - Use this task type when you want workers to classify objects in a 3D point cloud by drawing 3D cuboids around objects. For example, you can use this task type to ask workers to identify different types of objects in a point cloud, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectDetection

3D Point Cloud Object Tracking - Use this task type when you want workers to draw 3D cuboids around objects that appear in a sequence of 3D point cloud frames. For example, you can use this task type to ask workers to track the movement of vehicles across multiple point cloud frames.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectTracking

3D Point Cloud Semantic Segmentation - Use this task type when you want workers to create a point-level semantic segmentation masks by painting objects in a 3D point cloud using different colors where each color is assigned to one of the classes you specify.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudSemanticSegmentation

Use the following ARNs for Label Verification and Adjustment Jobs

Use label verification and adjustment jobs to review and adjust labels. To learn more, see Verify and Adjust Labels .

Bounding box verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgement for bounding box labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationBoundingBox

Bounding box adjustment - Finds the most similar boxes from different workers based on the Jaccard index of the adjusted annotations.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentBoundingBox

Semantic segmentation verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgment for semantic segmentation labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationSemanticSegmentation

Semantic segmentation adjustment - Treats each pixel in an image as a multi-class classification and treats pixel adjusted annotations from workers as \"votes\" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentSemanticSegmentation

Video Frame Object Detection Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to classify and localize objects in a sequence of video frames.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectDetection

Video Frame Object Tracking Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to track object movement across a sequence of video frames.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectTracking

3D point cloud object detection adjustment - Adjust 3D cuboids in a point cloud frame.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectDetection

3D point cloud object tracking adjustment - Adjust 3D cuboids across a sequence of point cloud frames.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectTracking

3D point cloud semantic segmentation adjustment - Adjust semantic segmentation masks in a 3D point cloud.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudSemanticSegmentation

Generative AI/Custom - Direct passthrough of input data without any transformation.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-PassThrough

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-PassThrough

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-PassThrough

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-PassThrough

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-PassThrough

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-PassThrough

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-PassThrough

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-PassThrough

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-PassThrough

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-PassThrough

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-PassThrough

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-PassThrough

", - "LabelingJobSummary$PreHumanTaskLambdaArn": "

The Amazon Resource Name (ARN) of a Lambda function. The function is run before each data object is sent to a worker.

", - "LabelingJobSummary$AnnotationConsolidationLambdaArn": "

The Amazon Resource Name (ARN) of the Lambda function used to consolidate the annotations from individual workers into a label for a data object. For more information, see Annotation Consolidation.

" - } - }, - "LambdaStepMetadata": { - "base": "

Metadata for a Lambda step.

", - "refs": { - "PipelineExecutionStepMetadata$Lambda": "

The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution and a list of output parameters.

" - } - }, - "LandingUri": { - "base": null, - "refs": { - "CreatePresignedDomainUrlRequest$LandingUri": "

The landing page that the user is directed to when accessing the presigned URL. Using this value, users can access Studio or Studio Classic, even if it is not the default experience for the domain. The supported values are:

  • studio::relative/path: Directs users to the relative path in Studio.

  • app:JupyterServer:relative/path: Directs users to the relative path in the Studio Classic application.

  • app:JupyterLab:relative/path: Directs users to the relative path in the JupyterLab application.

  • app:RStudioServerPro:relative/path: Directs users to the relative path in the RStudio application.

  • app:CodeEditor:relative/path: Directs users to the relative path in the Code Editor, based on Code-OSS, Visual Studio Code - Open Source application.

  • app:Canvas:relative/path: Directs users to the relative path in the Canvas application.

", - "UserSettings$DefaultLandingUri": "

The default experience that the user is directed to when accessing the domain. The supported values are:

  • studio::: Indicates that Studio is the default experience. This value can only be passed if StudioWebPortal is set to ENABLED.

  • app:JupyterServer:: Indicates that Studio Classic is the default experience.

" - } - }, - "LastModifiedTime": { - "base": null, - "refs": { - "CodeRepositorySummary$LastModifiedTime": "

The date and time that the Git repository was last modified.

", - "CompilationJobSummary$LastModifiedTime": "

The time when the model compilation job was last modified.

", - "DescribeCodeRepositoryOutput$LastModifiedTime": "

The date and time that the repository was last changed.

", - "DescribeCompilationJobResponse$LastModifiedTime": "

The time that the status of the model compilation job was last modified.

", - "DescribeDomainResponse$LastModifiedTime": "

The last modified time.

", - "DescribeFeatureGroupResponse$LastModifiedTime": "

A timestamp indicating when the feature group was last updated.

", - "DescribeFeatureMetadataResponse$LastModifiedTime": "

A timestamp indicating when the metadata for the feature group was modified. For example, if you add a parameter describing the feature, the timestamp changes to reflect the last time you

", - "DescribeInferenceRecommendationsJobResponse$LastModifiedTime": "

A timestamp that shows when the job was last modified.

", - "DescribeNotebookInstanceLifecycleConfigOutput$LastModifiedTime": "

A timestamp that tells when the lifecycle configuration was last modified.

", - "DescribeNotebookInstanceOutput$LastModifiedTime": "

A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.

", - "DescribeOptimizationJobResponse$LastModifiedTime": "

The time when the optimization job was last updated.

", - "DescribeSpaceResponse$LastModifiedTime": "

The last modified time.

", - "DescribeUserProfileResponse$LastModifiedTime": "

The last modified time.

", - "DomainDetails$LastModifiedTime": "

The last modified time.

", - "FeatureGroup$LastModifiedTime": "

A timestamp indicating the last time you updated the feature group.

", - "FeatureMetadata$LastModifiedTime": "

A timestamp indicating when the feature was last modified.

", - "InferenceRecommendationsJob$LastModifiedTime": "

A timestamp that shows when the job was last modified.

", - "ListCompilationJobsRequest$LastModifiedTimeAfter": "

A filter that returns the model compilation jobs that were modified after a specified time.

", - "ListCompilationJobsRequest$LastModifiedTimeBefore": "

A filter that returns the model compilation jobs that were modified before a specified time.

", - "ListInferenceRecommendationsJobsRequest$LastModifiedTimeAfter": "

A filter that returns only jobs that were last modified after the specified time (timestamp).

", - "ListInferenceRecommendationsJobsRequest$LastModifiedTimeBefore": "

A filter that returns only jobs that were last modified before the specified time (timestamp).

", - "ListNotebookInstanceLifecycleConfigsInput$LastModifiedTimeBefore": "

A filter that returns only lifecycle configurations that were modified before the specified time (timestamp).

", - "ListNotebookInstanceLifecycleConfigsInput$LastModifiedTimeAfter": "

A filter that returns only lifecycle configurations that were modified after the specified time (timestamp).

", - "ListNotebookInstancesInput$LastModifiedTimeBefore": "

A filter that returns only notebook instances that were modified before the specified time (timestamp).

", - "ListNotebookInstancesInput$LastModifiedTimeAfter": "

A filter that returns only notebook instances that were modified after the specified time (timestamp).

", - "ListOptimizationJobsRequest$LastModifiedTimeAfter": "

Filters the results to only those optimization jobs that were updated after the specified time.

", - "ListOptimizationJobsRequest$LastModifiedTimeBefore": "

Filters the results to only those optimization jobs that were updated before the specified time.

", - "NotebookInstanceLifecycleConfigSummary$LastModifiedTime": "

A timestamp that tells when the lifecycle configuration was last modified.

", - "NotebookInstanceSummary$LastModifiedTime": "

A timestamp that shows when the notebook instance was last modified.

", - "OptimizationJobSummary$LastModifiedTime": "

The time when the optimization job was last updated.

", - "SpaceDetails$LastModifiedTime": "

The last modified time.

", - "UserProfileDetails$LastModifiedTime": "

The last modified time.

" - } - }, - "LastUpdateStatus": { - "base": "

A value that indicates whether the update was successful.

", - "refs": { - "DescribeFeatureGroupResponse$LastUpdateStatus": "

A value indicating whether the update made to the feature group was successful.

", - "FeatureGroup$LastUpdateStatus": "

A value that indicates whether the feature group was updated successfully.

" - } - }, - "LastUpdateStatusValue": { - "base": null, - "refs": { - "LastUpdateStatus$Status": "

A value that indicates whether the update was made successful.

" - } - }, - "LifecycleConfigArns": { - "base": null, - "refs": { - "CodeEditorAppSettings$LifecycleConfigArns": "

The Amazon Resource Name (ARN) of the Code Editor application lifecycle configuration.

", - "JupyterLabAppSettings$LifecycleConfigArns": "

The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain. To remove a lifecycle config, you must set LifecycleConfigArns to an empty list.

", - "JupyterServerAppSettings$LifecycleConfigArns": "

The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp. If you use this parameter, the DefaultResourceSpec parameter is also required.

To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.

", - "KernelGatewayAppSettings$LifecycleConfigArns": "

The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.

To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.

" - } - }, - "LifecycleManagement": { - "base": null, - "refs": { - "IdleSettings$LifecycleManagement": "

Indicates whether idle shutdown is activated for the application type.

" - } - }, - "LineageEntityParameters": { - "base": null, - "refs": { - "CreateActionRequest$Properties": "

A list of properties to add to the action.

", - "CreateContextRequest$Properties": "

A list of properties to add to the context.

", - "DescribeActionResponse$Properties": "

A list of the action's properties.

", - "DescribeArtifactResponse$Properties": "

A list of the artifact's properties.

", - "DescribeContextResponse$Properties": "

A list of the context's properties.

", - "UpdateActionRequest$Properties": "

The new list of properties. Overwrites the current property list.

", - "UpdateContextRequest$Properties": "

The new list of properties. Overwrites the current property list.

" - } - }, - "LineageGroupArn": { - "base": null, - "refs": { - "DescribeActionResponse$LineageGroupArn": "

The Amazon Resource Name (ARN) of the lineage group.

", - "DescribeArtifactResponse$LineageGroupArn": "

The Amazon Resource Name (ARN) of the lineage group.

", - "DescribeContextResponse$LineageGroupArn": "

The Amazon Resource Name (ARN) of the lineage group.

", - "DescribeLineageGroupResponse$LineageGroupArn": "

The Amazon Resource Name (ARN) of the lineage group.

", - "DescribeTrialComponentResponse$LineageGroupArn": "

The Amazon Resource Name (ARN) of the lineage group.

", - "GetLineageGroupPolicyResponse$LineageGroupArn": "

The Amazon Resource Name (ARN) of the lineage group.

", - "LineageGroupSummary$LineageGroupArn": "

The Amazon Resource Name (ARN) of the lineage group resource.

", - "TrialComponent$LineageGroupArn": "

The Amazon Resource Name (ARN) of the lineage group resource.

" - } - }, - "LineageGroupNameOrArn": { - "base": null, - "refs": { - "GetLineageGroupPolicyRequest$LineageGroupName": "

The name or Amazon Resource Name (ARN) of the lineage group.

" - } - }, - "LineageGroupSummaries": { - "base": null, - "refs": { - "ListLineageGroupsResponse$LineageGroupSummaries": "

A list of lineage groups and their properties.

" - } - }, - "LineageGroupSummary": { - "base": "

Lists a summary of the properties of a lineage group. A lineage group provides a group of shareable lineage entity resources.

", - "refs": { - "LineageGroupSummaries$member": null - } - }, - "LineageMetadata": { - "base": "

The metadata that tracks relationships between ML artifacts, actions, and contexts.

", - "refs": { - "PipelineExecutionStepMetadata$Lineage": "

The metadata of the lineage used in pipeline execution step.

" - } - }, - "LineageType": { - "base": null, - "refs": { - "QueryLineageTypes$member": null, - "Vertex$LineageType": "

The type of resource of the lineage entity.

" - } - }, - "ListAIBenchmarkJobsRequest": { - "base": null, - "refs": {} - }, - "ListAIBenchmarkJobsResponse": { - "base": null, - "refs": {} - }, - "ListAIBenchmarkJobsSortBy": { - "base": null, - "refs": { - "ListAIBenchmarkJobsRequest$SortBy": "

The field to sort results by. The default is CreationTime.

" - } - }, - "ListAIRecommendationJobsRequest": { - "base": null, - "refs": {} - }, - "ListAIRecommendationJobsResponse": { - "base": null, - "refs": {} - }, - "ListAIRecommendationJobsSortBy": { - "base": null, - "refs": { - "ListAIRecommendationJobsRequest$SortBy": "

The field to sort results by. The default is CreationTime.

" - } - }, - "ListAIWorkloadConfigsRequest": { - "base": null, - "refs": {} - }, - "ListAIWorkloadConfigsResponse": { - "base": null, - "refs": {} - }, - "ListAIWorkloadConfigsSortBy": { - "base": null, - "refs": { - "ListAIWorkloadConfigsRequest$SortBy": "

The field to sort results by. The default is CreationTime.

" - } - }, - "ListActionsRequest": { - "base": null, - "refs": {} - }, - "ListActionsResponse": { - "base": null, - "refs": {} - }, - "ListAlgorithmsInput": { - "base": null, - "refs": {} - }, - "ListAlgorithmsOutput": { - "base": null, - "refs": {} - }, - "ListAliasesRequest": { - "base": null, - "refs": {} - }, - "ListAliasesResponse": { - "base": null, - "refs": {} - }, - "ListAppImageConfigsRequest": { - "base": null, - "refs": {} - }, - "ListAppImageConfigsResponse": { - "base": null, - "refs": {} - }, - "ListAppsRequest": { - "base": null, - "refs": {} - }, - "ListAppsResponse": { - "base": null, - "refs": {} - }, - "ListArtifactsRequest": { - "base": null, - "refs": {} - }, - "ListArtifactsResponse": { - "base": null, - "refs": {} - }, - "ListAssociationsRequest": { - "base": null, - "refs": {} - }, - "ListAssociationsResponse": { - "base": null, - "refs": {} - }, - "ListAutoMLJobsRequest": { - "base": null, - "refs": {} - }, - "ListAutoMLJobsResponse": { - "base": null, - "refs": {} - }, - "ListCandidatesForAutoMLJobRequest": { - "base": null, - "refs": {} - }, - "ListCandidatesForAutoMLJobResponse": { - "base": null, - "refs": {} - }, - "ListClusterEventsRequest": { - "base": null, - "refs": {} - }, - "ListClusterEventsResponse": { - "base": null, - "refs": {} - }, - "ListClusterNodesRequest": { - "base": null, - "refs": {} - }, - "ListClusterNodesResponse": { - "base": null, - "refs": {} - }, - "ListClusterSchedulerConfigsRequest": { - "base": null, - "refs": {} - }, - "ListClusterSchedulerConfigsResponse": { - "base": null, - "refs": {} - }, - "ListClustersRequest": { - "base": null, - "refs": {} - }, - "ListClustersResponse": { - "base": null, - "refs": {} - }, - "ListCodeRepositoriesInput": { - "base": null, - "refs": {} - }, - "ListCodeRepositoriesOutput": { - "base": null, - "refs": {} - }, - "ListCompilationJobsRequest": { - "base": null, - "refs": {} - }, - "ListCompilationJobsResponse": { - "base": null, - "refs": {} - }, - "ListCompilationJobsSortBy": { - "base": null, - "refs": { - "ListCompilationJobsRequest$SortBy": "

The field by which to sort results. The default is CreationTime.

" - } - }, - "ListComputeQuotasRequest": { - "base": null, - "refs": {} - }, - "ListComputeQuotasResponse": { - "base": null, - "refs": {} - }, - "ListContextsRequest": { - "base": null, - "refs": {} - }, - "ListContextsResponse": { - "base": null, - "refs": {} - }, - "ListDataQualityJobDefinitionsRequest": { - "base": null, - "refs": {} - }, - "ListDataQualityJobDefinitionsResponse": { - "base": null, - "refs": {} - }, - "ListDeviceFleetsRequest": { - "base": null, - "refs": {} - }, - "ListDeviceFleetsResponse": { - "base": null, - "refs": {} - }, - "ListDeviceFleetsSortBy": { - "base": null, - "refs": { - "ListDeviceFleetsRequest$SortBy": "

The column to sort by.

" - } - }, - "ListDevicesRequest": { - "base": null, - "refs": {} - }, - "ListDevicesResponse": { - "base": null, - "refs": {} - }, - "ListDomainsRequest": { - "base": null, - "refs": {} - }, - "ListDomainsResponse": { - "base": null, - "refs": {} - }, - "ListEdgeDeploymentPlansRequest": { - "base": null, - "refs": {} - }, - "ListEdgeDeploymentPlansResponse": { - "base": null, - "refs": {} - }, - "ListEdgeDeploymentPlansSortBy": { - "base": null, - "refs": { - "ListEdgeDeploymentPlansRequest$SortBy": "

The column by which to sort the edge deployment plans. Can be one of NAME, DEVICEFLEETNAME, CREATIONTIME, LASTMODIFIEDTIME.

" - } - }, - "ListEdgePackagingJobsRequest": { - "base": null, - "refs": {} - }, - "ListEdgePackagingJobsResponse": { - "base": null, - "refs": {} - }, - "ListEdgePackagingJobsSortBy": { - "base": null, - "refs": { - "ListEdgePackagingJobsRequest$SortBy": "

Use to specify what column to sort by.

" - } - }, - "ListEndpointConfigsInput": { - "base": null, - "refs": {} - }, - "ListEndpointConfigsOutput": { - "base": null, - "refs": {} - }, - "ListEndpointsInput": { - "base": null, - "refs": {} - }, - "ListEndpointsOutput": { - "base": null, - "refs": {} - }, - "ListExperimentsRequest": { - "base": null, - "refs": {} - }, - "ListExperimentsResponse": { - "base": null, - "refs": {} - }, - "ListFeatureGroupsRequest": { - "base": null, - "refs": {} - }, - "ListFeatureGroupsResponse": { - "base": null, - "refs": {} - }, - "ListFlowDefinitionsRequest": { - "base": null, - "refs": {} - }, - "ListFlowDefinitionsResponse": { - "base": null, - "refs": {} - }, - "ListHubContentVersionsRequest": { - "base": null, - "refs": {} - }, - "ListHubContentVersionsResponse": { - "base": null, - "refs": {} - }, - "ListHubContentsRequest": { - "base": null, - "refs": {} - }, - "ListHubContentsResponse": { - "base": null, - "refs": {} - }, - "ListHubsRequest": { - "base": null, - "refs": {} - }, - "ListHubsResponse": { - "base": null, - "refs": {} - }, - "ListHumanTaskUisRequest": { - "base": null, - "refs": {} - }, - "ListHumanTaskUisResponse": { - "base": null, - "refs": {} - }, - "ListHyperParameterTuningJobsRequest": { - "base": null, - "refs": {} - }, - "ListHyperParameterTuningJobsResponse": { - "base": null, - "refs": {} - }, - "ListImageVersionsRequest": { - "base": null, - "refs": {} - }, - "ListImageVersionsResponse": { - "base": null, - "refs": {} - }, - "ListImagesRequest": { - "base": null, - "refs": {} - }, - "ListImagesResponse": { - "base": null, - "refs": {} - }, - "ListInferenceComponentsInput": { - "base": null, - "refs": {} - }, - "ListInferenceComponentsOutput": { - "base": null, - "refs": {} - }, - "ListInferenceExperimentsRequest": { - "base": null, - "refs": {} - }, - "ListInferenceExperimentsResponse": { - "base": null, - "refs": {} - }, - "ListInferenceRecommendationsJobStepsRequest": { - "base": null, - "refs": {} - }, - "ListInferenceRecommendationsJobStepsResponse": { - "base": null, - "refs": {} - }, - "ListInferenceRecommendationsJobsRequest": { - "base": null, - "refs": {} - }, - "ListInferenceRecommendationsJobsResponse": { - "base": null, - "refs": {} - }, - "ListInferenceRecommendationsJobsSortBy": { - "base": null, - "refs": { - "ListInferenceRecommendationsJobsRequest$SortBy": "

The parameter by which to sort the results.

" - } - }, - "ListJobSchemaVersionsRequest": { - "base": null, - "refs": {} - }, - "ListJobSchemaVersionsResponse": { - "base": null, - "refs": {} - }, - "ListJobsRequest": { - "base": null, - "refs": {} - }, - "ListJobsResponse": { - "base": null, - "refs": {} - }, - "ListLabelingJobsForWorkteamRequest": { - "base": null, - "refs": {} - }, - "ListLabelingJobsForWorkteamResponse": { - "base": null, - "refs": {} - }, - "ListLabelingJobsForWorkteamSortByOptions": { - "base": null, - "refs": { - "ListLabelingJobsForWorkteamRequest$SortBy": "

The field to sort results by. The default is CreationTime.

" - } - }, - "ListLabelingJobsRequest": { - "base": null, - "refs": {} - }, - "ListLabelingJobsResponse": { - "base": null, - "refs": {} - }, - "ListLineageEntityParameterKey": { - "base": null, - "refs": { - "UpdateActionRequest$PropertiesToRemove": "

A list of properties to remove.

", - "UpdateArtifactRequest$PropertiesToRemove": "

A list of properties to remove.

", - "UpdateContextRequest$PropertiesToRemove": "

A list of properties to remove.

" - } - }, - "ListLineageGroupsRequest": { - "base": null, - "refs": {} - }, - "ListLineageGroupsResponse": { - "base": null, - "refs": {} - }, - "ListMaxResults": { - "base": null, - "refs": { - "ListDeviceFleetsRequest$MaxResults": "

The maximum number of results to select.

", - "ListDevicesRequest$MaxResults": "

Maximum number of results to select.

", - "ListEdgeDeploymentPlansRequest$MaxResults": "

The maximum number of results to select (50 by default).

", - "ListEdgePackagingJobsRequest$MaxResults": "

Maximum number of results to select.

", - "ListStageDevicesRequest$MaxResults": "

The maximum number of requests to select.

" - } - }, - "ListMlflowAppsRequest": { - "base": null, - "refs": {} - }, - "ListMlflowAppsResponse": { - "base": null, - "refs": {} - }, - "ListMlflowTrackingServersRequest": { - "base": null, - "refs": {} - }, - "ListMlflowTrackingServersResponse": { - "base": null, - "refs": {} - }, - "ListModelBiasJobDefinitionsRequest": { - "base": null, - "refs": {} - }, - "ListModelBiasJobDefinitionsResponse": { - "base": null, - "refs": {} - }, - "ListModelCardExportJobsRequest": { - "base": null, - "refs": {} - }, - "ListModelCardExportJobsResponse": { - "base": null, - "refs": {} - }, - "ListModelCardVersionsRequest": { - "base": null, - "refs": {} - }, - "ListModelCardVersionsResponse": { - "base": null, - "refs": {} - }, - "ListModelCardsRequest": { - "base": null, - "refs": {} - }, - "ListModelCardsResponse": { - "base": null, - "refs": {} - }, - "ListModelExplainabilityJobDefinitionsRequest": { - "base": null, - "refs": {} - }, - "ListModelExplainabilityJobDefinitionsResponse": { - "base": null, - "refs": {} - }, - "ListModelMetadataRequest": { - "base": null, - "refs": {} - }, - "ListModelMetadataResponse": { - "base": null, - "refs": {} - }, - "ListModelPackageGroupsInput": { - "base": null, - "refs": {} - }, - "ListModelPackageGroupsOutput": { - "base": null, - "refs": {} - }, - "ListModelPackagesInput": { - "base": null, - "refs": {} - }, - "ListModelPackagesOutput": { - "base": null, - "refs": {} - }, - "ListModelQualityJobDefinitionsRequest": { - "base": null, - "refs": {} - }, - "ListModelQualityJobDefinitionsResponse": { - "base": null, - "refs": {} - }, - "ListModelsInput": { - "base": null, - "refs": {} - }, - "ListModelsOutput": { - "base": null, - "refs": {} - }, - "ListMonitoringAlertHistoryRequest": { - "base": null, - "refs": {} - }, - "ListMonitoringAlertHistoryResponse": { - "base": null, - "refs": {} - }, - "ListMonitoringAlertsRequest": { - "base": null, - "refs": {} - }, - "ListMonitoringAlertsResponse": { - "base": null, - "refs": {} - }, - "ListMonitoringExecutionsRequest": { - "base": null, - "refs": {} - }, - "ListMonitoringExecutionsResponse": { - "base": null, - "refs": {} - }, - "ListMonitoringSchedulesRequest": { - "base": null, - "refs": {} - }, - "ListMonitoringSchedulesResponse": { - "base": null, - "refs": {} - }, - "ListNotebookInstanceLifecycleConfigsInput": { - "base": null, - "refs": {} - }, - "ListNotebookInstanceLifecycleConfigsOutput": { - "base": null, - "refs": {} - }, - "ListNotebookInstancesInput": { - "base": null, - "refs": {} - }, - "ListNotebookInstancesOutput": { - "base": null, - "refs": {} - }, - "ListOptimizationJobsRequest": { - "base": null, - "refs": {} - }, - "ListOptimizationJobsResponse": { - "base": null, - "refs": {} - }, - "ListOptimizationJobsSortBy": { - "base": null, - "refs": { - "ListOptimizationJobsRequest$SortBy": "

The field by which to sort the optimization jobs in the response. The default is CreationTime

" - } - }, - "ListPartnerAppsRequest": { - "base": null, - "refs": {} - }, - "ListPartnerAppsResponse": { - "base": null, - "refs": {} - }, - "ListPipelineExecutionStepsRequest": { - "base": null, - "refs": {} - }, - "ListPipelineExecutionStepsResponse": { - "base": null, - "refs": {} - }, - "ListPipelineExecutionsRequest": { - "base": null, - "refs": {} - }, - "ListPipelineExecutionsResponse": { - "base": null, - "refs": {} - }, - "ListPipelineParametersForExecutionRequest": { - "base": null, - "refs": {} - }, - "ListPipelineParametersForExecutionResponse": { - "base": null, - "refs": {} - }, - "ListPipelineVersionsRequest": { - "base": null, - "refs": {} - }, - "ListPipelineVersionsResponse": { - "base": null, - "refs": {} - }, - "ListPipelinesRequest": { - "base": null, - "refs": {} - }, - "ListPipelinesResponse": { - "base": null, - "refs": {} - }, - "ListProcessingJobsRequest": { - "base": null, - "refs": {} - }, - "ListProcessingJobsResponse": { - "base": null, - "refs": {} - }, - "ListProjectsInput": { - "base": null, - "refs": {} - }, - "ListProjectsOutput": { - "base": null, - "refs": {} - }, - "ListResourceCatalogsRequest": { - "base": null, - "refs": {} - }, - "ListResourceCatalogsResponse": { - "base": null, - "refs": {} - }, - "ListSpacesRequest": { - "base": null, - "refs": {} - }, - "ListSpacesResponse": { - "base": null, - "refs": {} - }, - "ListStageDevicesRequest": { - "base": null, - "refs": {} - }, - "ListStageDevicesResponse": { - "base": null, - "refs": {} - }, - "ListStudioLifecycleConfigsRequest": { - "base": null, - "refs": {} - }, - "ListStudioLifecycleConfigsResponse": { - "base": null, - "refs": {} - }, - "ListSubscribedWorkteamsRequest": { - "base": null, - "refs": {} - }, - "ListSubscribedWorkteamsResponse": { - "base": null, - "refs": {} - }, - "ListTagsInput": { - "base": null, - "refs": {} - }, - "ListTagsMaxResults": { - "base": null, - "refs": { - "ListTagsInput$MaxResults": "

Maximum number of tags to return.

" - } - }, - "ListTagsOutput": { - "base": null, - "refs": {} - }, - "ListTrainingJobsForHyperParameterTuningJobRequest": { - "base": null, - "refs": {} - }, - "ListTrainingJobsForHyperParameterTuningJobResponse": { - "base": null, - "refs": {} - }, - "ListTrainingJobsRequest": { - "base": null, - "refs": {} - }, - "ListTrainingJobsResponse": { - "base": null, - "refs": {} - }, - "ListTrainingPlansRequest": { - "base": null, - "refs": {} - }, - "ListTrainingPlansResponse": { - "base": null, - "refs": {} - }, - "ListTransformJobsRequest": { - "base": null, - "refs": {} - }, - "ListTransformJobsResponse": { - "base": null, - "refs": {} - }, - "ListTrialComponentKey256": { - "base": null, - "refs": { - "UpdateTrialComponentRequest$ParametersToRemove": "

The hyperparameters to remove from the component.

", - "UpdateTrialComponentRequest$InputArtifactsToRemove": "

The input artifacts to remove from the component.

", - "UpdateTrialComponentRequest$OutputArtifactsToRemove": "

The output artifacts to remove from the component.

" - } - }, - "ListTrialComponentsRequest": { - "base": null, - "refs": {} - }, - "ListTrialComponentsResponse": { - "base": null, - "refs": {} - }, - "ListTrialsRequest": { - "base": null, - "refs": {} - }, - "ListTrialsResponse": { - "base": null, - "refs": {} - }, - "ListUltraServersByReservedCapacityRequest": { - "base": null, - "refs": {} - }, - "ListUltraServersByReservedCapacityResponse": { - "base": null, - "refs": {} - }, - "ListUserProfilesRequest": { - "base": null, - "refs": {} - }, - "ListUserProfilesResponse": { - "base": null, - "refs": {} - }, - "ListWorkforcesRequest": { - "base": null, - "refs": {} - }, - "ListWorkforcesResponse": { - "base": null, - "refs": {} - }, - "ListWorkforcesSortByOptions": { - "base": null, - "refs": { - "ListWorkforcesRequest$SortBy": "

Sort workforces using the workforce name or creation date.

" - } - }, - "ListWorkteamsRequest": { - "base": null, - "refs": {} - }, - "ListWorkteamsResponse": { - "base": null, - "refs": {} - }, - "ListWorkteamsSortByOptions": { - "base": null, - "refs": { - "ListWorkteamsRequest$SortBy": "

The field to sort results by. The default is CreationTime.

" - } - }, - "LocalPath": { - "base": null, - "refs": { - "AuthorizedUrl$LocalPath": "

The recommended local file path where the downloaded file should be stored to maintain proper directory structure and file organization.

" - } - }, - "Long": { - "base": null, - "refs": { - "AgentVersion$AgentCount": "

The number of Edge Manager agents.

", - "DeviceStats$ConnectedDeviceCount": "

The number of devices connected with a heartbeat.

", - "DeviceStats$RegisteredDeviceCount": "

The number of registered devices.

", - "EdgeModelStat$OfflineDeviceCount": "

The number of devices that have this model version and do not have a heart beat.

", - "EdgeModelStat$ConnectedDeviceCount": "

The number of devices that have this model version and have a heart beat.

", - "EdgeModelStat$ActiveDeviceCount": "

The number of devices that have this model version, a heart beat, and are currently running.

", - "EdgeModelStat$SamplingDeviceCount": "

The number of devices with this model version and are producing sample data.

", - "TotalHits$Value": "

The total number of matching results. This value may be exact or an estimate, depending on the Relation field.

" - } - }, - "LongS3Uri": { - "base": null, - "refs": { - "AuthorizedUrl$Url": "

The presigned S3 URL that provides temporary, secure access to download the file. URLs expire within 15 minutes for security purposes.

" - } - }, - "MIGProfileType": { - "base": null, - "refs": { - "AcceleratorPartitionConfig$Type": "

The Multi-Instance GPU (MIG) profile type that defines the partition configuration. The profile specifies the compute and memory allocation for each partition instance. The available profile types depend on the instance type specified in the compute quota configuration.

" - } - }, - "MLFramework": { - "base": null, - "refs": { - "CreateImageVersionRequest$MLFramework": "

The machine learning framework vended in the image version.

", - "DescribeImageVersionResponse$MLFramework": "

The machine learning framework vended in the image version.

", - "UpdateImageVersionRequest$MLFramework": "

The machine learning framework vended in the image version.

" - } - }, - "MLflowArn": { - "base": null, - "refs": { - "MLflowConfiguration$MlflowResourceArn": "

The Amazon Resource Name (ARN) of MLflow configuration resource.

" - } - }, - "MLflowConfiguration": { - "base": "

The MLflow configuration.

", - "refs": { - "DescribePipelineExecutionResponse$MLflowConfig": "

The MLflow configuration of the pipeline execution.

" - } - }, - "MaintenanceStatus": { - "base": null, - "refs": { - "DescribeMlflowAppResponse$MaintenanceStatus": "

Current maintenance status of the MLflow App.

" - } - }, - "MajorMinorVersion": { - "base": null, - "refs": { - "AvailableUpgrade$Version": "

The semantic version number of the available upgrade for the SageMaker Partner AI App.

", - "UpdatePartnerAppRequest$AppVersion": "

The semantic version to upgrade the SageMaker Partner AI App to. Must be the same semantic version returned in the AvailableUpgrade field from DescribePartnerApp. Version skipping and downgrades are not supported.

" - } - }, - "ManagedConfiguration": { - "base": "

The managed configuration of a model package group.

", - "refs": { - "CreateModelPackageGroupInput$ManagedConfiguration": "

The managed configuration of the model package group.

", - "DescribeModelPackageGroupOutput$ManagedConfiguration": "

The managed configuration of the model package group.

", - "ModelPackageGroupSummary$ManagedConfiguration": "

The managed configuration of the model package group.

" - } - }, - "ManagedInstanceScalingCooldownInMinutes": { - "base": null, - "refs": { - "ProductionVariantManagedInstanceScalingScaleInPolicy$CooldownInMinutes": "

The cooldown period, in minutes, after the last endpoint operation before the endpoint evaluates consolidation scale-in opportunities.

Default value: 20.

" - } - }, - "ManagedInstanceScalingMaxInstanceCount": { - "base": null, - "refs": { - "ProductionVariantManagedInstanceScaling$MaxInstanceCount": "

The maximum number of instances that the endpoint can provision when it scales up to accommodate an increase in traffic.

" - } - }, - "ManagedInstanceScalingMaximumStepSize": { - "base": null, - "refs": { - "ProductionVariantManagedInstanceScalingScaleInPolicy$MaximumStepSize": "

The maximum number of instances that the endpoint can terminate at a time during a consolidation scale-in operation.

Default value: 1.

" - } - }, - "ManagedInstanceScalingMinInstanceCount": { - "base": null, - "refs": { - "ProductionVariantManagedInstanceScaling$MinInstanceCount": "

The minimum number of instances that the endpoint must retain when it scales down to accommodate a decrease in traffic.

" - } - }, - "ManagedInstanceScalingScaleInStrategy": { - "base": null, - "refs": { - "ProductionVariantManagedInstanceScalingScaleInPolicy$Strategy": "

The strategy for scaling in instances.

IDLE_RELEASE

Releases instances that have no hosted inference component copies.

CONSOLIDATION

Consolidates inference component copies onto fewer instances to release more instances. Consolidation honors the scheduling configuration of each inference component. For example, if an inference component specifies Availability Zone balance, consolidation only proceeds when the resulting distribution does not increase the imbalance.

" - } - }, - "ManagedInstanceScalingStatus": { - "base": null, - "refs": { - "ProductionVariantManagedInstanceScaling$Status": "

Indicates whether managed instance scaling is enabled.

" - } - }, - "ManagedStorageType": { - "base": null, - "refs": { - "CreateModelPackageInput$ManagedStorageType": "

The storage type of the model package.

", - "DescribeModelPackageOutput$ManagedStorageType": "

The storage type of the model package.

", - "ManagedConfiguration$ManagedStorageType": "

The storage type of the model package.

" - } - }, - "MapString2048": { - "base": null, - "refs": { - "LineageMetadata$ActionArns": "

The Amazon Resource Name (ARN) of the lineage action.

", - "LineageMetadata$ArtifactArns": "

The Amazon Resource Name (ARN) of the lineage artifact.

", - "LineageMetadata$ContextArns": "

The Amazon Resource Name (ARN) of the lineage context.

" - } - }, - "MaxAutoMLJobRuntimeInSeconds": { - "base": null, - "refs": { - "AutoMLJobCompletionCriteria$MaxAutoMLJobRuntimeInSeconds": "

The maximum runtime, in seconds, an AutoML job has to complete.

If an AutoML job exceeds the maximum runtime, the job is stopped automatically and its processing is ended gracefully. The AutoML job identifies the best model whose training was completed and marks it as the best-performing model. Any unfinished steps of the job, such as automatic one-click Autopilot model deployment, are not completed.

" - } - }, - "MaxCandidates": { - "base": null, - "refs": { - "AutoMLJobCompletionCriteria$MaxCandidates": "

The maximum number of times a training job is allowed to run.

For text and image classification, time-series forecasting, as well as text generation (LLMs fine-tuning) problem types, the supported value is 1. For tabular problem types, the maximum value is 750.

" - } - }, - "MaxConcurrentInvocationsPerInstance": { - "base": null, - "refs": { - "AsyncInferenceClientConfig$MaxConcurrentInvocationsPerInstance": "

The maximum number of concurrent requests sent by the SageMaker client to the model container. If no value is provided, SageMaker chooses an optimal value.

" - } - }, - "MaxConcurrentTaskCount": { - "base": null, - "refs": { - "HumanTaskConfig$MaxConcurrentTaskCount": "

Defines the maximum number of data objects that can be labeled by human workers at the same time. Also referred to as batch size. Each object may have more than one worker at one time. The default value is 1000 objects. To increase the maximum value to 5000 objects, contact Amazon Web Services Support.

" - } - }, - "MaxConcurrentTransforms": { - "base": null, - "refs": { - "CreateTransformJobRequest$MaxConcurrentTransforms": "

The maximum number of parallel requests that can be sent to each instance in a transform job. If MaxConcurrentTransforms is set to 0 or left unset, Amazon SageMaker checks the optional execution-parameters to determine the settings for your chosen algorithm. If the execution-parameters endpoint is not enabled, the default value is 1. For more information on execution-parameters, see How Containers Serve Requests. For built-in algorithms, you don't need to set a value for MaxConcurrentTransforms.

", - "DescribeTransformJobResponse$MaxConcurrentTransforms": "

The maximum number of parallel requests on each instance node that can be launched in a transform job. The default value is 1.

", - "TransformJob$MaxConcurrentTransforms": "

The maximum number of parallel requests that can be sent to each instance in a transform job. If MaxConcurrentTransforms is set to 0 or left unset, SageMaker checks the optional execution-parameters to determine the settings for your chosen algorithm. If the execution-parameters endpoint is not enabled, the default value is 1. For built-in algorithms, you don't need to set a value for MaxConcurrentTransforms.

", - "TransformJobDefinition$MaxConcurrentTransforms": "

The maximum number of parallel requests that can be sent to each instance in a transform job. The default value is 1.

" - } - }, - "MaxHumanLabeledObjectCount": { - "base": null, - "refs": { - "LabelingJobStoppingConditions$MaxHumanLabeledObjectCount": "

The maximum number of objects that can be labeled by human workers.

" - } - }, - "MaxNumberOfTests": { - "base": null, - "refs": { - "RecommendationJobResourceLimit$MaxNumberOfTests": "

Defines the maximum number of load tests.

" - } - }, - "MaxNumberOfTrainingJobs": { - "base": null, - "refs": { - "ResourceLimits$MaxNumberOfTrainingJobs": "

The maximum number of training jobs that a hyperparameter tuning job can launch.

" - } - }, - "MaxNumberOfTrainingJobsNotImproving": { - "base": null, - "refs": { - "BestObjectiveNotImproving$MaxNumberOfTrainingJobsNotImproving": "

The number of training jobs that have failed to improve model performance by 1% or greater over prior training jobs as evaluated against an objective function.

" - } - }, - "MaxParallelExecutionSteps": { - "base": null, - "refs": { - "ParallelismConfiguration$MaxParallelExecutionSteps": "

The max number of steps that can be executed in parallel.

" - } - }, - "MaxParallelOfTests": { - "base": null, - "refs": { - "RecommendationJobResourceLimit$MaxParallelOfTests": "

Defines the maximum number of parallel load tests.

" - } - }, - "MaxParallelTrainingJobs": { - "base": null, - "refs": { - "ResourceLimits$MaxParallelTrainingJobs": "

The maximum number of concurrent training jobs that a hyperparameter tuning job can launch.

" - } - }, - "MaxPayloadInMB": { - "base": null, - "refs": { - "CreateTransformJobRequest$MaxPayloadInMB": "

The maximum allowed size of the payload, in MB. A payload is the data portion of a record (without metadata). The value in MaxPayloadInMB must be greater than, or equal to, the size of a single record. To estimate the size of a record in MB, divide the size of your dataset by the number of records. To ensure that the records fit within the maximum payload size, we recommend using a slightly larger value. The default value is 6 MB.

The value of MaxPayloadInMB cannot be greater than 100 MB. If you specify the MaxConcurrentTransforms parameter, the value of (MaxConcurrentTransforms * MaxPayloadInMB) also cannot exceed 100 MB.

For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to 0. This feature works only in supported algorithms. Currently, Amazon SageMaker built-in algorithms do not support HTTP chunked encoding.

", - "DescribeTransformJobResponse$MaxPayloadInMB": "

The maximum payload size, in MB, used in the transform job.

", - "TransformJob$MaxPayloadInMB": "

The maximum allowed size of the payload, in MB. A payload is the data portion of a record (without metadata). The value in MaxPayloadInMB must be greater than, or equal to, the size of a single record. To estimate the size of a record in MB, divide the size of your dataset by the number of records. To ensure that the records fit within the maximum payload size, we recommend using a slightly larger value. The default value is 6 MB. For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to 0. This feature works only in supported algorithms. Currently, SageMaker built-in algorithms do not support HTTP chunked encoding.

", - "TransformJobDefinition$MaxPayloadInMB": "

The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata).

" - } - }, - "MaxPendingTimeInSeconds": { - "base": "

Maximum job scheduler pending time in seconds.

", - "refs": { - "StoppingCondition$MaxPendingTimeInSeconds": "

The maximum length of time, in seconds, that a training or compilation job can be pending before it is stopped.

When working with training jobs that use capacity from training plans, not all Pending job states count against the MaxPendingTimeInSeconds limit. The following scenarios do not increment the MaxPendingTimeInSeconds counter:

  • The plan is in a Scheduled state: Jobs queued (in Pending status) before a plan's start date (waiting for scheduled start time)

  • Between capacity reservations: Jobs temporarily back to Pending status between two capacity reservation periods

MaxPendingTimeInSeconds only increments when jobs are actively waiting for capacity in an Active plan.

" - } - }, - "MaxPercentageOfInputDatasetLabeled": { - "base": null, - "refs": { - "LabelingJobStoppingConditions$MaxPercentageOfInputDatasetLabeled": "

The maximum number of input data objects that should be labeled.

" - } - }, - "MaxResults": { - "base": null, - "refs": { - "CreateHubContentPresignedUrlsRequest$MaxResults": "

The maximum number of presigned URLs to return in the response. Default value is 100. Large models may contain hundreds of files, requiring pagination to retrieve all URLs.

", - "DescribeTrainingPlanExtensionHistoryRequest$MaxResults": "

The maximum number of extensions to return in the response.

", - "ListAIBenchmarkJobsRequest$MaxResults": "

The maximum number of benchmark jobs to return in the response.

", - "ListAIRecommendationJobsRequest$MaxResults": "

The maximum number of recommendation jobs to return in the response.

", - "ListAIWorkloadConfigsRequest$MaxResults": "

The maximum number of AI workload configurations to return in the response.

", - "ListActionsRequest$MaxResults": "

The maximum number of actions to return in the response. The default value is 10.

", - "ListAlgorithmsInput$MaxResults": "

The maximum number of algorithms to return in the response.

", - "ListAliasesRequest$MaxResults": "

The maximum number of aliases to return.

", - "ListAppImageConfigsRequest$MaxResults": "

The total number of items to return in the response. If the total number of items available is more than the value specified, a NextToken is provided in the response. To resume pagination, provide the NextToken value in the as part of a subsequent call. The default value is 10.

", - "ListAppsRequest$MaxResults": "

This parameter defines the maximum number of results that can be return in a single response. The MaxResults parameter is an upper bound, not a target. If there are more results available than the value specified, a NextToken is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.

", - "ListArtifactsRequest$MaxResults": "

The maximum number of artifacts to return in the response. The default value is 10.

", - "ListAssociationsRequest$MaxResults": "

The maximum number of associations to return in the response. The default value is 10.

", - "ListClusterNodesRequest$MaxResults": "

The maximum number of nodes to return in the response.

", - "ListClusterSchedulerConfigsRequest$MaxResults": "

The maximum number of cluster policies to list.

", - "ListClustersRequest$MaxResults": "

Specifies the maximum number of clusters to evaluate for the operation (not necessarily the number of matching items). After SageMaker processes the number of clusters up to MaxResults, it stops the operation and returns the matching clusters up to that point. If all the matching clusters are desired, SageMaker will go through all the clusters until NextToken is empty.

", - "ListCodeRepositoriesInput$MaxResults": "

The maximum number of Git repositories to return in the response.

", - "ListCompilationJobsRequest$MaxResults": "

The maximum number of model compilation jobs to return in the response.

", - "ListComputeQuotasRequest$MaxResults": "

The maximum number of compute allocation definitions to list.

", - "ListContextsRequest$MaxResults": "

The maximum number of contexts to return in the response. The default value is 10.

", - "ListDataQualityJobDefinitionsRequest$MaxResults": "

The maximum number of data quality monitoring job definitions to return in the response.

", - "ListDomainsRequest$MaxResults": "

This parameter defines the maximum number of results that can be return in a single response. The MaxResults parameter is an upper bound, not a target. If there are more results available than the value specified, a NextToken is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.

", - "ListEndpointConfigsInput$MaxResults": "

The maximum number of training jobs to return in the response.

", - "ListEndpointsInput$MaxResults": "

The maximum number of endpoints to return in the response. This value defaults to 10.

", - "ListExperimentsRequest$MaxResults": "

The maximum number of experiments to return in the response. The default value is 10.

", - "ListFlowDefinitionsRequest$MaxResults": "

The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.

", - "ListHubContentVersionsRequest$MaxResults": "

The maximum number of hub content versions to list.

", - "ListHubContentsRequest$MaxResults": "

The maximum amount of hub content to list.

", - "ListHubsRequest$MaxResults": "

The maximum number of hubs to list.

", - "ListHumanTaskUisRequest$MaxResults": "

The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.

", - "ListHyperParameterTuningJobsRequest$MaxResults": "

The maximum number of tuning jobs to return. The default value is 10.

", - "ListImageVersionsRequest$MaxResults": "

The maximum number of versions to return in the response. The default value is 10.

", - "ListImagesRequest$MaxResults": "

The maximum number of images to return in the response. The default value is 10.

", - "ListInferenceComponentsInput$MaxResults": "

The maximum number of inference components to return in the response. This value defaults to 10.

", - "ListInferenceExperimentsRequest$MaxResults": "

The maximum number of results to select.

", - "ListInferenceRecommendationsJobStepsRequest$MaxResults": "

The maximum number of results to return.

", - "ListInferenceRecommendationsJobsRequest$MaxResults": "

The maximum number of recommendations to return in the response.

", - "ListJobSchemaVersionsRequest$MaxResults": "

The maximum number of schema versions to return in the response. The default value is 5.

", - "ListJobsRequest$MaxResults": "

The maximum number of jobs to return in the response. The default value is 50.

", - "ListLabelingJobsForWorkteamRequest$MaxResults": "

The maximum number of labeling jobs to return in each page of the response.

", - "ListLabelingJobsRequest$MaxResults": "

The maximum number of labeling jobs to return in each page of the response.

", - "ListLineageGroupsRequest$MaxResults": "

The maximum number of endpoints to return in the response. This value defaults to 10.

", - "ListMlflowAppsRequest$MaxResults": "

The maximum number of MLflow Apps to list.

", - "ListMlflowTrackingServersRequest$MaxResults": "

The maximum number of tracking servers to list.

", - "ListModelBiasJobDefinitionsRequest$MaxResults": "

The maximum number of model bias jobs to return in the response. The default value is 10.

", - "ListModelCardExportJobsRequest$MaxResults": "

The maximum number of model card export jobs to list.

", - "ListModelCardVersionsRequest$MaxResults": "

The maximum number of model card versions to list.

", - "ListModelCardsRequest$MaxResults": "

The maximum number of model cards to list.

", - "ListModelExplainabilityJobDefinitionsRequest$MaxResults": "

The maximum number of jobs to return in the response. The default value is 10.

", - "ListModelMetadataRequest$MaxResults": "

The maximum number of models to return in the response.

", - "ListModelPackageGroupsInput$MaxResults": "

The maximum number of results to return in the response.

", - "ListModelPackagesInput$MaxResults": "

The maximum number of model packages to return in the response.

", - "ListModelQualityJobDefinitionsRequest$MaxResults": "

The maximum number of results to return in a call to ListModelQualityJobDefinitions.

", - "ListModelsInput$MaxResults": "

The maximum number of models to return in the response.

", - "ListMonitoringAlertHistoryRequest$MaxResults": "

The maximum number of results to display. The default is 100.

", - "ListMonitoringAlertsRequest$MaxResults": "

The maximum number of results to display. The default is 100.

", - "ListMonitoringExecutionsRequest$MaxResults": "

The maximum number of jobs to return in the response. The default value is 10.

", - "ListMonitoringSchedulesRequest$MaxResults": "

The maximum number of jobs to return in the response. The default value is 10.

", - "ListNotebookInstanceLifecycleConfigsInput$MaxResults": "

The maximum number of lifecycle configurations to return in the response.

", - "ListNotebookInstancesInput$MaxResults": "

The maximum number of notebook instances to return.

", - "ListOptimizationJobsRequest$MaxResults": "

The maximum number of optimization jobs to return in the response. The default is 50.

", - "ListPartnerAppsRequest$MaxResults": "

This parameter defines the maximum number of results that can be returned in a single response. The MaxResults parameter is an upper bound, not a target. If there are more results available than the value specified, a NextToken is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.

", - "ListPipelineExecutionStepsRequest$MaxResults": "

The maximum number of pipeline execution steps to return in the response.

", - "ListPipelineExecutionsRequest$MaxResults": "

The maximum number of pipeline executions to return in the response.

", - "ListPipelineParametersForExecutionRequest$MaxResults": "

The maximum number of parameters to return in the response.

", - "ListPipelineVersionsRequest$MaxResults": "

The maximum number of pipeline versions to return in the response.

", - "ListPipelinesRequest$MaxResults": "

The maximum number of pipelines to return in the response.

", - "ListProcessingJobsRequest$MaxResults": "

The maximum number of processing jobs to return in the response.

", - "ListProjectsInput$MaxResults": "

The maximum number of projects to return in the response.

", - "ListResourceCatalogsRequest$MaxResults": "

The maximum number of results returned by ListResourceCatalogs.

", - "ListSpacesRequest$MaxResults": "

This parameter defines the maximum number of results that can be return in a single response. The MaxResults parameter is an upper bound, not a target. If there are more results available than the value specified, a NextToken is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.

", - "ListStudioLifecycleConfigsRequest$MaxResults": "

The total number of items to return in the response. If the total number of items available is more than the value specified, a NextToken is provided in the response. To resume pagination, provide the NextToken value in the as part of a subsequent call. The default value is 10.

", - "ListSubscribedWorkteamsRequest$MaxResults": "

The maximum number of work teams to return in each page of the response.

", - "ListTrainingJobsForHyperParameterTuningJobRequest$MaxResults": "

The maximum number of training jobs to return. The default value is 10.

", - "ListTrainingJobsRequest$MaxResults": "

The maximum number of training jobs to return in the response.

", - "ListTrainingPlansRequest$MaxResults": "

The maximum number of results to return in the response.

", - "ListTransformJobsRequest$MaxResults": "

The maximum number of transform jobs to return in the response. The default value is 10.

", - "ListTrialComponentsRequest$MaxResults": "

The maximum number of components to return in the response. The default value is 10.

", - "ListTrialsRequest$MaxResults": "

The maximum number of trials to return in the response. The default value is 10.

", - "ListUltraServersByReservedCapacityRequest$MaxResults": "

The maximum number of UltraServers to return in the response. The default value is 10.

", - "ListUserProfilesRequest$MaxResults": "

This parameter defines the maximum number of results that can be return in a single response. The MaxResults parameter is an upper bound, not a target. If there are more results available than the value specified, a NextToken is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.

", - "ListWorkforcesRequest$MaxResults": "

The maximum number of workforces returned in the response.

", - "ListWorkteamsRequest$MaxResults": "

The maximum number of work teams to return in each page of the response.

", - "SearchRequest$MaxResults": "

The maximum number of results to return.

" - } - }, - "MaxRuntimeInSeconds": { - "base": null, - "refs": { - "StoppingCondition$MaxRuntimeInSeconds": "

The maximum length of time, in seconds, that a training or compilation job can run before it is stopped.

For compilation jobs, if the job does not complete during this time, a TimeOut error is generated. We recommend starting with 900 seconds and increasing as necessary based on your model.

For all other jobs, if the job does not complete during this time, SageMaker ends the job. When RetryStrategy is specified in the job request, MaxRuntimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.

The maximum time that a TrainingJob can run in total, including any time spent publishing metrics or archiving and uploading models after it has been stopped, is 30 days.

" - } - }, - "MaxRuntimePerTrainingJobInSeconds": { - "base": null, - "refs": { - "AutoMLJobCompletionCriteria$MaxRuntimePerTrainingJobInSeconds": "

The maximum time, in seconds, that each training job executed inside hyperparameter tuning is allowed to run as part of a hyperparameter tuning job. For more information, see the StoppingCondition used by the CreateHyperParameterTuningJob action.

For job V2s (jobs created by calling CreateAutoMLJobV2), this field controls the runtime of the job candidate.

For TextGenerationJobConfig problem types, the maximum time defaults to 72 hours (259200 seconds).

" - } - }, - "MaxWaitTimeInSeconds": { - "base": null, - "refs": { - "StoppingCondition$MaxWaitTimeInSeconds": "

The maximum length of time, in seconds, that a managed Spot training job has to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the job can run. It must be equal to or greater than MaxRuntimeInSeconds. If the job does not complete during this time, SageMaker ends the job.

When RetryStrategy is specified in the job request, MaxWaitTimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt.

" - } - }, - "MaximumExecutionTimeoutInSeconds": { - "base": null, - "refs": { - "BlueGreenUpdatePolicy$MaximumExecutionTimeoutInSeconds": "

Maximum execution timeout for the deployment. Note that the timeout value should be larger than the total waiting time specified in TerminationWaitInSeconds and WaitIntervalInSeconds.

", - "InferenceComponentRollingUpdatePolicy$MaximumExecutionTimeoutInSeconds": "

The time limit for the total deployment. Exceeding this limit causes a timeout.

", - "RollingUpdatePolicy$MaximumExecutionTimeoutInSeconds": "

The time limit for the total deployment. Exceeding this limit causes a timeout.

" - } - }, - "MaximumRetryAttempts": { - "base": null, - "refs": { - "RetryStrategy$MaximumRetryAttempts": "

The number of times to retry the job. When the job is retried, it's SecondaryStatus is changed to STARTING.

" - } - }, - "MediaType": { - "base": null, - "refs": { - "TrialComponentArtifact$MediaType": "

The media type of the artifact, which indicates the type of data in the artifact file. The media type consists of a type and a subtype concatenated with a slash (/) character, for example, text/csv, image/jpeg, and s3/uri. The type specifies the category of the media. The subtype specifies the kind of data.

" - } - }, - "MemberDefinition": { - "base": "

Defines an Amazon Cognito or your own OIDC IdP user group that is part of a work team.

", - "refs": { - "MemberDefinitions$member": null - } - }, - "MemberDefinitions": { - "base": null, - "refs": { - "CreateWorkteamRequest$MemberDefinitions": "

A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.

Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use CognitoMemberDefinition. For workforces created using your own OIDC identity provider (IdP) use OidcMemberDefinition. Do not provide input for both of these parameters in a single request.

For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito user groups within the user pool used to create a workforce. All of the CognitoMemberDefinition objects that make up the member definition must have the same ClientId and UserPool values. To add a Amazon Cognito user group to an existing worker pool, see Adding groups to a User Pool. For more information about user pools, see Amazon Cognito User Pools.

For workforces created using your own OIDC IdP, specify the user groups that you want to include in your private work team in OidcMemberDefinition by listing those groups in Groups.

", - "UpdateWorkteamRequest$MemberDefinitions": "

A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.

Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use CognitoMemberDefinition. For workforces created using your own OIDC identity provider (IdP) use OidcMemberDefinition. You should not provide input for both of these parameters in a single request.

For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito user groups within the user pool used to create a workforce. All of the CognitoMemberDefinition objects that make up the member definition must have the same ClientId and UserPool values. To add a Amazon Cognito user group to an existing worker pool, see Adding groups to a User Pool. For more information about user pools, see Amazon Cognito User Pools.

For workforces created using your own OIDC IdP, specify the user groups that you want to include in your private work team in OidcMemberDefinition by listing those groups in Groups. Be aware that user groups that are already in the work team must also be listed in Groups when you make this request to remain on the work team. If you do not include these user groups, they will no longer be associated with the work team you update.

", - "Workteam$MemberDefinitions": "

A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.

Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use CognitoMemberDefinition. For workforces created using your own OIDC identity provider (IdP) use OidcMemberDefinition.

" - } - }, - "MemoryInGiBAmount": { - "base": null, - "refs": { - "ComputeQuotaResourceConfig$MemoryInGiB": "

The amount of memory in GiB to allocate. If you specify a value only for this parameter, SageMaker AI automatically allocates a ratio-based value for vCPU based on this memory that you provide. For example, if you allocate 200 out of 400 total memory in GiB, SageMaker AI uses the ratio of 0.5 and allocates values to vCPU. Accelerators are set to 0.

" - } - }, - "MemoryInMb": { - "base": null, - "refs": { - "InferenceComponentComputeResourceRequirements$MinMemoryRequiredInMb": "

The minimum MB of memory to allocate to run a model that you assign to an inference component.

", - "InferenceComponentComputeResourceRequirements$MaxMemoryRequiredInMb": "

The maximum MB of memory to allocate to run a model that you assign to an inference component.

" - } - }, - "MetadataProperties": { - "base": "

Metadata properties of the tracking entity, trial, or trial component.

", - "refs": { - "CreateActionRequest$MetadataProperties": null, - "CreateArtifactRequest$MetadataProperties": null, - "CreateModelPackageInput$MetadataProperties": null, - "CreateTrialComponentRequest$MetadataProperties": null, - "CreateTrialRequest$MetadataProperties": null, - "DescribeActionResponse$MetadataProperties": null, - "DescribeArtifactResponse$MetadataProperties": null, - "DescribeModelPackageOutput$MetadataProperties": null, - "DescribeTrialComponentResponse$MetadataProperties": null, - "DescribeTrialResponse$MetadataProperties": null, - "ModelPackage$MetadataProperties": "

Metadata properties of the tracking entity, trial, or trial component.

", - "Trial$MetadataProperties": null, - "TrialComponent$MetadataProperties": null - } - }, - "MetadataPropertyValue": { - "base": null, - "refs": { - "MetadataProperties$CommitId": "

The commit ID.

", - "MetadataProperties$Repository": "

The repository.

", - "MetadataProperties$GeneratedBy": "

The entity this entity was generated by.

", - "MetadataProperties$ProjectId": "

The project ID.

" - } - }, - "MetricData": { - "base": "

The name, value, and date and time of a metric that was emitted to Amazon CloudWatch.

", - "refs": { - "FinalMetricDataList$member": null - } - }, - "MetricDataList": { - "base": null, - "refs": { - "CandidateProperties$CandidateMetrics": "

Information about the candidate metrics for an AutoML job.

" - } - }, - "MetricDatum": { - "base": "

Information about the metric for a candidate produced by an AutoML job.

", - "refs": { - "MetricDataList$member": null - } - }, - "MetricDefinition": { - "base": "

Specifies a metric that the training algorithm writes to stderr or stdout. You can view these logs to understand how your training job performs and check for any errors encountered during training. SageMaker hyperparameter tuning captures all defined metrics. Specify one of the defined metrics to use as an objective metric using the TuningObjective parameter in the HyperParameterTrainingJobDefinition API to evaluate job performance during hyperparameter tuning.

", - "refs": { - "MetricDefinitionList$member": null - } - }, - "MetricDefinitionList": { - "base": null, - "refs": { - "AlgorithmSpecification$MetricDefinitions": "

A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. SageMaker publishes each metric to Amazon CloudWatch.

", - "HyperParameterAlgorithmSpecification$MetricDefinitions": "

An array of MetricDefinition objects that specify the metrics that the algorithm emits.

", - "TrainingSpecification$MetricDefinitions": "

A list of MetricDefinition objects, which are used for parsing metrics generated by the algorithm.

" - } - }, - "MetricName": { - "base": null, - "refs": { - "FinalHyperParameterTuningJobObjectiveMetric$MetricName": "

The name of the objective metric. For SageMaker built-in algorithms, metrics are defined per algorithm. See the metrics for XGBoost as an example. You can also use a custom algorithm for training and define your own metrics. For more information, see Define metrics and environment variables.

", - "HyperParameterTuningJobObjective$MetricName": "

The name of the metric to use for the objective metric.

", - "MetricData$MetricName": "

The name of the metric.

", - "MetricDefinition$Name": "

The name of the metric.

", - "TrialComponentMetricSummary$MetricName": "

The name of the metric.

" - } - }, - "MetricPublishFrequencyInSeconds": { - "base": null, - "refs": { - "MetricsConfig$MetricPublishFrequencyInSeconds": "

The interval, in seconds, at which metrics are published to Amazon CloudWatch. Defaults to 60. Valid values: 10, 30, 60, 120, 180, 240, 300.

When EnableEnhancedMetrics is set to False, this interval applies to utilization metrics only. Invocation metrics continue to be published at the default 60-second interval. When EnableEnhancedMetrics is set to True, this interval applies to both utilization and invocation metrics.

When EnableDetailedObservability is set to True, this interval applies to per-GPU metrics, per-instance host metrics, container metrics, and fleet-level inference component lifecycle and placement metrics.

", - "MetricsEndpoint$MetricPublishFrequencyInSeconds": "

The interval, in seconds, at which container metrics scraped from the endpoint are published to Amazon CloudWatch. Valid values: 10, 30, 60, 120, 180, 240, 300. Defaults to 60.

" - } - }, - "MetricRegex": { - "base": null, - "refs": { - "MetricDefinition$Regex": "

A regular expression that searches the output of a training job and gets the value of the metric. For more information about using regular expressions to define metrics, see Defining metrics and environment variables.

" - } - }, - "MetricSetSource": { - "base": null, - "refs": { - "MetricDatum$Set": "

The dataset split from which the AutoML job produced the metric.

" - } - }, - "MetricSpecification": { - "base": "

An object containing information about a metric.

", - "refs": { - "TargetTrackingScalingPolicyConfiguration$MetricSpecification": "

An object containing information about a metric.

" - } - }, - "MetricValue": { - "base": null, - "refs": { - "FinalAutoMLJobObjectiveMetric$Value": "

The value of the metric with the best result.

", - "FinalHyperParameterTuningJobObjectiveMetric$Value": "

The value of the objective metric.

" - } - }, - "MetricsConfig": { - "base": "

The configuration for Utilization metrics.

", - "refs": { - "CreateEndpointConfigInput$MetricsConfig": "

The configuration parameters for utilization metrics.

", - "DescribeEndpointConfigOutput$MetricsConfig": "

The configuration parameters for utilization metrics.

", - "DescribeEndpointOutput$MetricsConfig": "

The configuration parameters for utilization metrics.

" - } - }, - "MetricsEndpoint": { - "base": "

Specifies a metrics endpoint for a container, including the path where the container exposes Prometheus-formatted metrics and the frequency at which to publish them to Amazon CloudWatch.

", - "refs": { - "MetricsEndpointList$member": null - } - }, - "MetricsEndpointList": { - "base": "

A list of metrics endpoints for a container.

", - "refs": { - "ContainerMetricsConfig$MetricsEndpoints": "

A list of metrics endpoints to scrape from the container. Each endpoint specifies the path where the container exposes Prometheus-formatted metrics and the frequency at which to publish them. You can specify a maximum of 1 endpoint.

" - } - }, - "MetricsEndpointPath": { - "base": "

Per-container Prometheus metrics scraping configuration

", - "refs": { - "MetricsEndpoint$MetricsEndpointPath": "

The path to the metrics endpoint exposed by the container. For example, /metrics or /server/metrics. The path must start with / and can contain alphanumeric characters, forward slashes, underscores, hyphens, and periods. Maximum length is 256 characters. If not specified, defaults to /metrics.

" - } - }, - "MetricsSource": { - "base": "

Details about the metrics source.

", - "refs": { - "Bias$Report": "

The bias report for a model

", - "Bias$PreTrainingReport": "

The pre-training bias report for a model.

", - "Bias$PostTrainingReport": "

The post-training bias report for a model.

", - "DriftCheckBias$PreTrainingConstraints": "

The pre-training constraints.

", - "DriftCheckBias$PostTrainingConstraints": "

The post-training constraints.

", - "DriftCheckExplainability$Constraints": "

The drift check explainability constraints.

", - "DriftCheckModelDataQuality$Statistics": "

The drift check model data quality statistics.

", - "DriftCheckModelDataQuality$Constraints": "

The drift check model data quality constraints.

", - "DriftCheckModelQuality$Statistics": "

The drift check model quality statistics.

", - "DriftCheckModelQuality$Constraints": "

The drift check model quality constraints.

", - "Explainability$Report": "

The explainability report for a model.

", - "ModelDataQuality$Statistics": "

Data quality statistics for a model.

", - "ModelDataQuality$Constraints": "

Data quality constraints for a model.

", - "ModelQuality$Statistics": "

Model quality statistics.

", - "ModelQuality$Constraints": "

Model quality constraints.

" - } - }, - "MinimumInstanceMetadataServiceVersion": { - "base": null, - "refs": { - "InstanceMetadataServiceConfiguration$MinimumInstanceMetadataServiceVersion": "

Indicates the minimum IMDS version that the notebook instance supports. When passed as part of CreateNotebookInstance, if no value is selected, then it defaults to IMDSv1. This means that both IMDSv1 and IMDSv2 are supported. If passed as part of UpdateNotebookInstance, there is no default.

" - } - }, - "MlFlowResourceArn": { - "base": "

MlflowDetails relevant fields

", - "refs": { - "MlflowConfig$MlflowResourceArn": "

The Amazon Resource Name (ARN) of the MLflow resource.

" - } - }, - "MlReservationArn": { - "base": null, - "refs": { - "ProductionVariantCapacityReservationConfig$MlReservationArn": "

The Amazon Resource Name (ARN) that uniquely identifies the ML capacity reservation that SageMaker AI applies when it deploys the endpoint.

", - "ProductionVariantCapacityReservationSummary$MlReservationArn": "

The Amazon Resource Name (ARN) that uniquely identifies the ML capacity reservation that SageMaker AI applies when it deploys the endpoint.

" - } - }, - "MlTools": { - "base": null, - "refs": { - "HiddenMlToolsList$member": null - } - }, - "MlflowAppArn": { - "base": null, - "refs": { - "CreateMlflowAppResponse$Arn": "

The ARN of the MLflow App.

", - "CreatePresignedMlflowAppUrlRequest$Arn": "

The ARN of the MLflow App to connect to your MLflow UI.

", - "DeleteMlflowAppRequest$Arn": "

The ARN of the MLflow App to delete.

", - "DeleteMlflowAppResponse$Arn": "

The ARN of the deleted MLflow App.

", - "DescribeMlflowAppRequest$Arn": "

The ARN of the MLflow App for which to get information.

", - "DescribeMlflowAppResponse$Arn": "

The ARN of the MLflow App.

", - "MlflowAppSummary$Arn": "

The ARN of a listed MLflow App.

", - "UpdateMlflowAppRequest$Arn": "

The ARN of the MLflow App to update.

", - "UpdateMlflowAppResponse$Arn": "

The ARN of the updated MLflow App.

" - } - }, - "MlflowAppName": { - "base": null, - "refs": { - "CreateMlflowAppRequest$Name": "

A string identifying the MLflow app name. This string is not part of the tracking server ARN.

", - "DescribeMlflowAppResponse$Name": "

The name of the MLflow App.

", - "MlflowAppSummary$Name": "

The name of the MLflow App.

", - "UpdateMlflowAppRequest$Name": "

The name of the MLflow App to update.

" - } - }, - "MlflowAppStatus": { - "base": null, - "refs": { - "DescribeMlflowAppResponse$Status": "

The current creation status of the described MLflow App.

", - "ListMlflowAppsRequest$Status": "

Filter for Mlflow apps with a specific creation status.

", - "MlflowAppSummary$Status": "

The status of the MLflow App.

" - } - }, - "MlflowAppSummaries": { - "base": null, - "refs": { - "ListMlflowAppsResponse$Summaries": "

A list of MLflow Apps according to chosen filters.

" - } - }, - "MlflowAppSummary": { - "base": "

The summary of the Mlflow App to list.

", - "refs": { - "MlflowAppSummaries$member": null - } - }, - "MlflowAppUrl": { - "base": null, - "refs": { - "CreatePresignedMlflowAppUrlResponse$AuthorizedUrl": "

A presigned URL with an authorization token.

" - } - }, - "MlflowConfig": { - "base": "

The MLflow configuration using SageMaker managed MLflow.

", - "refs": { - "CreateTrainingJobRequest$MlflowConfig": "

The MLflow configuration using SageMaker managed MLflow.

", - "DescribeTrainingJobResponse$MlflowConfig": "

The MLflow configuration using SageMaker managed MLflow.

" - } - }, - "MlflowDetails": { - "base": "

The MLflow details of this job.

", - "refs": { - "DescribeTrainingJobResponse$MlflowDetails": "

The MLflow details of this job.

" - } - }, - "MlflowExperimentEntityName": { - "base": null, - "refs": { - "MLflowConfiguration$MlflowExperimentName": "

The name of the MLflow configuration.

", - "StartPipelineExecutionRequest$MlflowExperimentName": "

The MLflow experiment name of the pipeline execution.

" - } - }, - "MlflowExperimentId": { - "base": null, - "refs": { - "MlflowDetails$MlflowExperimentId": "

The MLflow experiment ID used for this job.

" - } - }, - "MlflowExperimentName": { - "base": "

MlflowConfig relevant fields

", - "refs": { - "MlflowConfig$MlflowExperimentName": "

The MLflow experiment name used for this job.

" - } - }, - "MlflowRunId": { - "base": null, - "refs": { - "MlflowDetails$MlflowRunId": "

The MLflow run ID used for this job.

" - } - }, - "MlflowRunName": { - "base": null, - "refs": { - "MlflowConfig$MlflowRunName": "

The MLflow run name used for this job.

" - } - }, - "MlflowVersion": { - "base": null, - "refs": { - "CreateMlflowTrackingServerRequest$MlflowVersion": "

The version of MLflow that the tracking server uses. To see which MLflow versions are available to use, see How it works.

", - "DescribeMlflowAppResponse$MlflowVersion": "

The MLflow version used.

", - "DescribeMlflowTrackingServerResponse$MlflowVersion": "

The MLflow version used for the described tracking server.

", - "ListMlflowAppsRequest$MlflowVersion": "

Filter for Mlflow Apps with the specified version.

", - "ListMlflowTrackingServersRequest$MlflowVersion": "

Filter for tracking servers using the specified MLflow version.

", - "MlflowAppSummary$MlflowVersion": "

The version of a listed MLflow App.

", - "TrackingServerSummary$MlflowVersion": "

The MLflow version used for a listed tracking server.

" - } - }, - "Model": { - "base": "

The properties of a model as returned by the Search API.

", - "refs": { - "ModelDashboardModel$Model": "

A model displayed in the Model Dashboard.

" - } - }, - "ModelAccessConfig": { - "base": "

The access configuration file to control access to the ML model. You can explicitly accept the model end-user license agreement (EULA) within the ModelAccessConfig.

", - "refs": { - "S3DataSource$ModelAccessConfig": null, - "S3ModelDataSource$ModelAccessConfig": "

Specifies the access configuration file for the ML model. You can explicitly accept the model end-user license agreement (EULA) within the ModelAccessConfig. You are responsible for reviewing and complying with any applicable license terms and making sure they are acceptable for your use case before downloading or using a model.

", - "TextGenerationJobConfig$ModelAccessConfig": null - } - }, - "ModelApprovalStatus": { - "base": null, - "refs": { - "BatchDescribeModelPackageSummary$ModelApprovalStatus": "

The approval status of the model.

", - "CreateModelPackageInput$ModelApprovalStatus": "

Whether the model is approved for deployment.

This parameter is optional for versioned models, and does not apply to unversioned models.

For versioned models, the value of this parameter must be set to Approved to deploy the model.

", - "DescribeModelPackageOutput$ModelApprovalStatus": "

The approval status of the model package.

", - "ListModelPackagesInput$ModelApprovalStatus": "

A filter that returns only the model packages with the specified approval status.

", - "ModelPackage$ModelApprovalStatus": "

The approval status of the model. This can be one of the following values.

  • APPROVED - The model is approved

  • REJECTED - The model is rejected.

  • PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.

", - "ModelPackageSummary$ModelApprovalStatus": "

The approval status of the model. This can be one of the following values.

  • APPROVED - The model is approved

  • REJECTED - The model is rejected.

  • PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.

", - "UpdateModelPackageInput$ModelApprovalStatus": "

The approval status of the model.

" - } - }, - "ModelArn": { - "base": null, - "refs": { - "CreateModelOutput$ModelArn": "

The ARN of the model created in SageMaker.

", - "DescribeModelOutput$ModelArn": "

The Amazon Resource Name (ARN) of the model.

", - "LabelingJobAlgorithmsConfig$InitialActiveLearningModelArn": "

At the end of an auto-label job Ground Truth sends the Amazon Resource Name (ARN) of the final model used for auto-labeling. You can use this model as the starting point for subsequent similar jobs by providing the ARN of the model here.

", - "LabelingJobOutput$FinalActiveLearningModelArn": "

The Amazon Resource Name (ARN) for the most recent SageMaker model trained as part of automated data labeling.

", - "Model$ModelArn": "

The Amazon Resource Name (ARN) of the model.

", - "ModelSummary$ModelArn": "

The Amazon Resource Name (ARN) of the model.

" - } - }, - "ModelArtifacts": { - "base": "

Provides information about the location that is configured for storing model artifacts.

Model artifacts are outputs that result from training a model. They typically consist of trained parameters, a model definition that describes how to compute inferences, and other metadata. A SageMaker container stores your trained model artifacts in the /opt/ml/model directory. After training has completed, by default, these artifacts are uploaded to your Amazon S3 bucket as compressed files.

", - "refs": { - "DescribeCompilationJobResponse$ModelArtifacts": "

Information about the location in Amazon S3 that has been configured for storing the model artifacts used in the compilation job.

", - "DescribeTrainingJobResponse$ModelArtifacts": "

Information about the Amazon S3 location that is configured for storing model artifacts.

", - "TrainingJob$ModelArtifacts": "

Information about the Amazon S3 location that is configured for storing model artifacts.

" - } - }, - "ModelBiasAppSpecification": { - "base": "

Docker container image configuration object for the model bias job.

", - "refs": { - "CreateModelBiasJobDefinitionRequest$ModelBiasAppSpecification": "

Configures the model bias job to run a specified Docker container image.

", - "DescribeModelBiasJobDefinitionResponse$ModelBiasAppSpecification": "

Configures the model bias job to run a specified Docker container image.

" - } - }, - "ModelBiasBaselineConfig": { - "base": "

The configuration for a baseline model bias job.

", - "refs": { - "CreateModelBiasJobDefinitionRequest$ModelBiasBaselineConfig": "

The baseline configuration for a model bias job.

", - "DescribeModelBiasJobDefinitionResponse$ModelBiasBaselineConfig": "

The baseline configuration for a model bias job.

" - } - }, - "ModelBiasJobInput": { - "base": "

Inputs for the model bias job.

", - "refs": { - "CreateModelBiasJobDefinitionRequest$ModelBiasJobInput": "

Inputs for the model bias job.

", - "DescribeModelBiasJobDefinitionResponse$ModelBiasJobInput": "

Inputs for the model bias job.

" - } - }, - "ModelCacheSetting": { - "base": null, - "refs": { - "MultiModelConfig$ModelCacheSetting": "

Whether to cache models for a multi-model endpoint. By default, multi-model endpoints cache models so that a model does not have to be loaded into memory each time it is invoked. Some use cases do not benefit from model caching. For example, if an endpoint hosts a large number of models that are each invoked infrequently, the endpoint might perform better if you disable model caching. To disable model caching, set the value of this parameter to Disabled.

" - } - }, - "ModelCard": { - "base": "

An Amazon SageMaker Model Card.

", - "refs": { - "SearchRecord$ModelCard": "

An Amazon SageMaker Model Card that documents details about a machine learning model.

" - } - }, - "ModelCardArn": { - "base": null, - "refs": { - "CreateModelCardResponse$ModelCardArn": "

The Amazon Resource Name (ARN) of the successfully created model card.

", - "DescribeModelCardResponse$ModelCardArn": "

The Amazon Resource Name (ARN) of the model card.

", - "ModelCard$ModelCardArn": "

The Amazon Resource Name (ARN) of the model card.

", - "ModelCardSummary$ModelCardArn": "

The Amazon Resource Name (ARN) of the model card.

", - "ModelCardVersionSummary$ModelCardArn": "

The Amazon Resource Name (ARN) of the model card.

", - "ModelDashboardModelCard$ModelCardArn": "

The Amazon Resource Name (ARN) for a model card.

", - "UpdateModelCardResponse$ModelCardArn": "

The Amazon Resource Name (ARN) of the updated model card.

" - } - }, - "ModelCardContent": { - "base": null, - "refs": { - "CreateModelCardRequest$Content": "

The content of the model card. Content must be in model card JSON schema and provided as a string.

", - "DescribeModelCardResponse$Content": "

The content of the model card. Content is provided as a string in the model card JSON schema.

When you set IncludedData to MetadataOnly in the request, SageMaker returns a sanitized version of Content that includes only the following JSON paths, when present in the model card:

  • model_overview.model_id

  • model_overview.model_name

  • intended_uses.risk_rating

  • model_package_details.model_package_group_name

  • model_package_details.model_package_arn

All other fields are removed from Content when IncludedData is MetadataOnly, including model description, training details, evaluation details, business details, and additional information. To retrieve the complete Content, set IncludedData to AllData or omit the parameter.

", - "ModelCard$Content": "

The content of the model card. Content uses the model card JSON schema and provided as a string.

", - "ModelPackageModelCard$ModelCardContent": "

The content of the model card. The content must follow the schema described in Model Package Model Card Schema.

", - "UpdateModelCardRequest$Content": "

The updated model card content. Content must be in model card JSON schema and provided as a string.

When updating model card content, be sure to include the full content and not just updated content.

" - } - }, - "ModelCardExportArtifacts": { - "base": "

The artifacts of the model card export job.

", - "refs": { - "DescribeModelCardExportJobResponse$ExportArtifacts": "

The exported model card artifacts.

" - } - }, - "ModelCardExportJobArn": { - "base": null, - "refs": { - "CreateModelCardExportJobResponse$ModelCardExportJobArn": "

The Amazon Resource Name (ARN) of the model card export job.

", - "DescribeModelCardExportJobRequest$ModelCardExportJobArn": "

The Amazon Resource Name (ARN) of the model card export job to describe.

", - "DescribeModelCardExportJobResponse$ModelCardExportJobArn": "

The Amazon Resource Name (ARN) of the model card export job.

", - "ModelCardExportJobSummary$ModelCardExportJobArn": "

The Amazon Resource Name (ARN) of the model card export job.

" - } - }, - "ModelCardExportJobSortBy": { - "base": "

Attribute by which to sort returned export jobs.

", - "refs": { - "ListModelCardExportJobsRequest$SortBy": "

Sort model card export jobs by either name or creation time. Sorts by creation time by default.

" - } - }, - "ModelCardExportJobSortOrder": { - "base": null, - "refs": { - "ListModelCardExportJobsRequest$SortOrder": "

Sort model card export jobs by ascending or descending order.

" - } - }, - "ModelCardExportJobStatus": { - "base": null, - "refs": { - "DescribeModelCardExportJobResponse$Status": "

The completion status of the model card export job.

  • InProgress: The model card export job is in progress.

  • Completed: The model card export job is complete.

  • Failed: The model card export job failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeModelCardExportJob call.

", - "ListModelCardExportJobsRequest$StatusEquals": "

Only list model card export jobs with the specified status.

", - "ModelCardExportJobSummary$Status": "

The completion status of the model card export job.

" - } - }, - "ModelCardExportJobSummary": { - "base": "

The summary of the Amazon SageMaker Model Card export job.

", - "refs": { - "ModelCardExportJobSummaryList$member": null - } - }, - "ModelCardExportJobSummaryList": { - "base": null, - "refs": { - "ListModelCardExportJobsResponse$ModelCardExportJobSummaries": "

The summaries of the listed model card export jobs.

" - } - }, - "ModelCardExportOutputConfig": { - "base": "

Configure the export output details for an Amazon SageMaker Model Card.

", - "refs": { - "CreateModelCardExportJobRequest$OutputConfig": "

The model card output configuration that specifies the Amazon S3 path for exporting.

", - "DescribeModelCardExportJobResponse$OutputConfig": "

The export output details for the model card.

" - } - }, - "ModelCardNameOrArn": { - "base": null, - "refs": { - "CreateModelCardExportJobRequest$ModelCardName": "

The name or Amazon Resource Name (ARN) of the model card to export.

", - "DescribeModelCardRequest$ModelCardName": "

The name or Amazon Resource Name (ARN) of the model card to describe.

", - "ListModelCardVersionsRequest$ModelCardName": "

List model card versions for the model card with the specified name or Amazon Resource Name (ARN).

", - "UpdateModelCardRequest$ModelCardName": "

The name or Amazon Resource Name (ARN) of the model card to update.

" - } - }, - "ModelCardProcessingStatus": { - "base": null, - "refs": { - "DescribeModelCardResponse$ModelCardProcessingStatus": "

The processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps.

  • DeletePending: Model card deletion request received.

  • DeleteInProgress: Model card deletion is in progress.

  • ContentDeleted: Deleted model card content.

  • ExportJobsDeleted: Deleted all export jobs associated with the model card.

  • DeleteCompleted: Successfully deleted the model card.

  • DeleteFailed: The model card failed to delete.

" - } - }, - "ModelCardSecurityConfig": { - "base": "

Configure the security settings to protect model card data.

", - "refs": { - "CreateModelCardRequest$SecurityConfig": "

An optional Key Management Service key to encrypt, decrypt, and re-encrypt model card content for regulated workloads with highly sensitive data.

", - "DescribeModelCardResponse$SecurityConfig": "

The security configuration used to protect model card content.

", - "ModelCard$SecurityConfig": "

The security configuration used to protect model card data.

", - "ModelDashboardModelCard$SecurityConfig": "

The KMS Key ID (KMSKeyId) for encryption of model card information.

" - } - }, - "ModelCardSortBy": { - "base": null, - "refs": { - "ListModelCardsRequest$SortBy": "

Sort model cards by either name or creation time. Sorts by creation time by default.

" - } - }, - "ModelCardSortOrder": { - "base": null, - "refs": { - "ListModelCardVersionsRequest$SortOrder": "

Sort model card versions by ascending or descending order.

", - "ListModelCardsRequest$SortOrder": "

Sort model cards by ascending or descending order.

" - } - }, - "ModelCardStatus": { - "base": null, - "refs": { - "CreateModelCardRequest$ModelCardStatus": "

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

  • Draft: The model card is a work in progress.

  • PendingReview: The model card is pending review.

  • Approved: The model card is approved.

  • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

", - "DescribeModelCardResponse$ModelCardStatus": "

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

  • Draft: The model card is a work in progress.

  • PendingReview: The model card is pending review.

  • Approved: The model card is approved.

  • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

", - "ListModelCardVersionsRequest$ModelCardStatus": "

Only list model card versions with the specified approval status.

", - "ListModelCardsRequest$ModelCardStatus": "

Only list model cards with the specified approval status.

", - "ModelCard$ModelCardStatus": "

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

  • Draft: The model card is a work in progress.

  • PendingReview: The model card is pending review.

  • Approved: The model card is approved.

  • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

", - "ModelCardSummary$ModelCardStatus": "

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

  • Draft: The model card is a work in progress.

  • PendingReview: The model card is pending review.

  • Approved: The model card is approved.

  • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

", - "ModelCardVersionSummary$ModelCardStatus": "

The approval status of the model card version within your organization. Different organizations might have different criteria for model card review and approval.

  • Draft: The model card is a work in progress.

  • PendingReview: The model card is pending review.

  • Approved: The model card is approved.

  • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

", - "ModelDashboardModelCard$ModelCardStatus": "

The model card status.

", - "ModelPackageModelCard$ModelCardStatus": "

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

  • Draft: The model card is a work in progress.

  • PendingReview: The model card is pending review.

  • Approved: The model card is approved.

  • Archived: The model card is archived. No more updates can be made to the model card content. If you try to update the model card content, you will receive the message Model Card is in Archived state.

", - "UpdateModelCardRequest$ModelCardStatus": "

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

  • Draft: The model card is a work in progress.

  • PendingReview: The model card is pending review.

  • Approved: The model card is approved.

  • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

" - } - }, - "ModelCardSummary": { - "base": "

A summary of the model card.

", - "refs": { - "ModelCardSummaryList$member": null - } - }, - "ModelCardSummaryList": { - "base": null, - "refs": { - "ListModelCardsResponse$ModelCardSummaries": "

The summaries of the listed model cards.

" - } - }, - "ModelCardVersionSortBy": { - "base": null, - "refs": { - "ListModelCardVersionsRequest$SortBy": "

Sort listed model card versions by version. Sorts by version by default.

" - } - }, - "ModelCardVersionSummary": { - "base": "

A summary of a specific version of the model card.

", - "refs": { - "ModelCardVersionSummaryList$member": null - } - }, - "ModelCardVersionSummaryList": { - "base": null, - "refs": { - "ListModelCardVersionsResponse$ModelCardVersionSummaryList": "

The summaries of the listed versions of the model card.

" - } - }, - "ModelClientConfig": { - "base": "

Configures the timeout and maximum number of retries for processing a transform job invocation.

", - "refs": { - "CreateTransformJobRequest$ModelClientConfig": "

Configures the timeout and maximum number of retries for processing a transform job invocation.

", - "DescribeTransformJobResponse$ModelClientConfig": "

The timeout and maximum number of retries for processing a transform job invocation.

", - "TransformJob$ModelClientConfig": null - } - }, - "ModelCompilationConfig": { - "base": "

Settings for the model compilation technique that's applied by a model optimization job.

", - "refs": { - "OptimizationConfig$ModelCompilationConfig": "

Settings for the model compilation technique that's applied by a model optimization job.

" - } - }, - "ModelCompressionType": { - "base": null, - "refs": { - "S3ModelDataSource$CompressionType": "

Specifies how the ML model data is prepared.

If you choose Gzip and choose S3Object as the value of S3DataType, S3Uri identifies an object that is a gzip-compressed TAR archive. SageMaker will attempt to decompress and untar the object during model deployment.

If you choose None and chooose S3Object as the value of S3DataType, S3Uri identifies an object that represents an uncompressed ML model to deploy.

If you choose None and choose S3Prefix as the value of S3DataType, S3Uri identifies a key name prefix, under which all objects represents the uncompressed ML model to deploy.

If you choose None, then SageMaker will follow rules below when creating model data files under /opt/ml/model directory for use by your inference code:

  • If you choose S3Object as the value of S3DataType, then SageMaker will split the key of the S3 object referenced by S3Uri by slash (/), and use the last part as the filename of the file holding the content of the S3 object.

  • If you choose S3Prefix as the value of S3DataType, then for each S3 object under the key name pefix referenced by S3Uri, SageMaker will trim its key by the prefix, and use the remainder as the path (relative to /opt/ml/model) of the file holding the content of the S3 object. SageMaker will split the remainder by slash (/), using intermediate parts as directory names and the last part as filename of the file holding the content of the S3 object.

  • Do not use any of the following as file names or directory names:

    • An empty or blank string

    • A string which contains null bytes

    • A string longer than 255 bytes

    • A single dot (.)

    • A double dot (..)

  • Ambiguous file names will result in model deployment failure. For example, if your uncompressed ML model consists of two S3 objects s3://mybucket/model/weights and s3://mybucket/model/weights/part1 and you specify s3://mybucket/model/ as the value of S3Uri and S3Prefix as the value of S3DataType, then it will result in name clash between /opt/ml/model/weights (a regular file) and /opt/ml/model/weights/ (a directory).

  • Do not organize the model artifacts in S3 console using folders. When you create a folder in S3 console, S3 creates a 0-byte object with a key set to the folder name you provide. They key of the 0-byte object ends with a slash (/) which violates SageMaker restrictions on model artifact file names, leading to model deployment failure.

" - } - }, - "ModelConfiguration": { - "base": "

Defines the model configuration. Includes the specification name and environment parameters.

", - "refs": { - "InferenceRecommendation$ModelConfiguration": "

Defines the model configuration.

", - "RecommendationJobInferenceBenchmark$ModelConfiguration": null - } - }, - "ModelDashboardEndpoint": { - "base": "

An endpoint that hosts a model displayed in the Amazon SageMaker Model Dashboard.

", - "refs": { - "ModelDashboardEndpoints$member": null - } - }, - "ModelDashboardEndpoints": { - "base": null, - "refs": { - "ModelDashboardModel$Endpoints": "

The endpoints that host a model.

" - } - }, - "ModelDashboardIndicatorAction": { - "base": "

An alert action taken to light up an icon on the Amazon SageMaker Model Dashboard when an alert goes into InAlert status.

", - "refs": { - "MonitoringAlertActions$ModelDashboardIndicator": "

An alert action taken to light up an icon on the Model Dashboard when an alert goes into InAlert status.

" - } - }, - "ModelDashboardModel": { - "base": "

A model displayed in the Amazon SageMaker Model Dashboard.

", - "refs": { - "SearchRecord$Model": null - } - }, - "ModelDashboardModelCard": { - "base": "

The model card for a model displayed in the Amazon SageMaker Model Dashboard.

", - "refs": { - "ModelDashboardModel$ModelCard": "

The model card for a model.

" - } - }, - "ModelDashboardMonitoringSchedule": { - "base": "

A monitoring schedule for a model displayed in the Amazon SageMaker Model Dashboard.

", - "refs": { - "ModelDashboardMonitoringSchedules$member": null - } - }, - "ModelDashboardMonitoringSchedules": { - "base": null, - "refs": { - "ModelDashboardModel$MonitoringSchedules": "

The monitoring schedules for a model.

" - } - }, - "ModelDataQuality": { - "base": "

Data quality constraints and statistics for a model.

", - "refs": { - "ModelMetrics$ModelDataQuality": "

Metrics that measure the quality of the input data for a model.

" - } - }, - "ModelDataSource": { - "base": "

Specifies the location of ML model data to deploy. If specified, you must specify one and only one of the available data sources.

", - "refs": { - "ContainerDefinition$ModelDataSource": "

Specifies the location of ML model data to deploy.

Currently you cannot use ModelDataSource in conjunction with SageMaker batch transform, SageMaker serverless endpoints, SageMaker multi-model endpoints, and SageMaker Marketplace.

", - "ModelPackageContainerDefinition$ModelDataSource": "

Specifies the location of ML model data to deploy during endpoint creation.

", - "SourceAlgorithm$ModelDataSource": "

Specifies the location of ML model data to deploy during endpoint creation.

" - } - }, - "ModelDeployConfig": { - "base": "

Specifies how to generate the endpoint name for an automatic one-click Autopilot model deployment.

", - "refs": { - "CreateAutoMLJobRequest$ModelDeployConfig": "

Specifies how to generate the endpoint name for an automatic one-click Autopilot model deployment.

", - "CreateAutoMLJobV2Request$ModelDeployConfig": "

Specifies how to generate the endpoint name for an automatic one-click Autopilot model deployment.

", - "DescribeAutoMLJobResponse$ModelDeployConfig": "

Indicates whether the model was deployed automatically to an endpoint and the name of that endpoint if deployed automatically.

", - "DescribeAutoMLJobV2Response$ModelDeployConfig": "

Indicates whether the model was deployed automatically to an endpoint and the name of that endpoint if deployed automatically.

" - } - }, - "ModelDeployResult": { - "base": "

Provides information about the endpoint of the model deployment.

", - "refs": { - "DescribeAutoMLJobResponse$ModelDeployResult": "

Provides information about endpoint for the model deployment.

", - "DescribeAutoMLJobV2Response$ModelDeployResult": "

Provides information about endpoint for the model deployment.

" - } - }, - "ModelDigests": { - "base": "

Provides information to verify the integrity of stored model artifacts.

", - "refs": { - "DescribeCompilationJobResponse$ModelDigests": "

Provides a BLAKE2 hash value that identifies the compiled model artifacts in Amazon S3.

" - } - }, - "ModelExplainabilityAppSpecification": { - "base": "

Docker container image configuration object for the model explainability job.

", - "refs": { - "CreateModelExplainabilityJobDefinitionRequest$ModelExplainabilityAppSpecification": "

Configures the model explainability job to run a specified Docker container image.

", - "DescribeModelExplainabilityJobDefinitionResponse$ModelExplainabilityAppSpecification": "

Configures the model explainability job to run a specified Docker container image.

" - } - }, - "ModelExplainabilityBaselineConfig": { - "base": "

The configuration for a baseline model explainability job.

", - "refs": { - "CreateModelExplainabilityJobDefinitionRequest$ModelExplainabilityBaselineConfig": "

The baseline configuration for a model explainability job.

", - "DescribeModelExplainabilityJobDefinitionResponse$ModelExplainabilityBaselineConfig": "

The baseline configuration for a model explainability job.

" - } - }, - "ModelExplainabilityJobInput": { - "base": "

Inputs for the model explainability job.

", - "refs": { - "CreateModelExplainabilityJobDefinitionRequest$ModelExplainabilityJobInput": "

Inputs for the model explainability job.

", - "DescribeModelExplainabilityJobDefinitionResponse$ModelExplainabilityJobInput": "

Inputs for the model explainability job.

" - } - }, - "ModelInfrastructureConfig": { - "base": "

The configuration for the infrastructure that the model will be deployed to.

", - "refs": { - "ModelVariantConfig$InfrastructureConfig": "

The configuration for the infrastructure that the model will be deployed to.

", - "ModelVariantConfigSummary$InfrastructureConfig": "

The configuration of the infrastructure that the model has been deployed to.

" - } - }, - "ModelInfrastructureType": { - "base": null, - "refs": { - "ModelInfrastructureConfig$InfrastructureType": "

The inference option to which to deploy your model. Possible values are the following:

  • RealTime: Deploy to real-time inference.

" - } - }, - "ModelInput": { - "base": "

Input object for the model.

", - "refs": { - "ModelPackageContainerDefinition$ModelInput": "

A structure with Model Input details.

" - } - }, - "ModelInsightsLocation": { - "base": null, - "refs": { - "CandidateArtifactLocations$ModelInsights": "

The Amazon S3 prefix to the model insight artifacts generated for the AutoML candidate.

" - } - }, - "ModelLatencyThreshold": { - "base": "

The model latency threshold.

", - "refs": { - "ModelLatencyThresholds$member": null - } - }, - "ModelLatencyThresholds": { - "base": null, - "refs": { - "RecommendationJobStoppingConditions$ModelLatencyThresholds": "

The interval of time taken by a model to respond as viewed from SageMaker. The interval includes the local communication time taken to send the request and to fetch the response from the container of a model and the time taken to complete the inference in the container.

" - } - }, - "ModelLifeCycle": { - "base": "

A structure describing the current state of the model in its life cycle.

", - "refs": { - "CreateModelPackageInput$ModelLifeCycle": "

A structure describing the current state of the model in its life cycle.

", - "DescribeModelPackageOutput$ModelLifeCycle": "

A structure describing the current state of the model in its life cycle.

", - "ModelPackage$ModelLifeCycle": "

A structure describing the current state of the model in its life cycle.

", - "ModelPackageSummary$ModelLifeCycle": null, - "UpdateModelPackageInput$ModelLifeCycle": "

A structure describing the current state of the model in its life cycle.

" - } - }, - "ModelMetadataFilter": { - "base": "

Part of the search expression. You can specify the name and value (domain, task, framework, framework version, task, and model).

", - "refs": { - "ModelMetadataFilters$member": null - } - }, - "ModelMetadataFilterType": { - "base": null, - "refs": { - "ModelMetadataFilter$Name": "

The name of the of the model to filter by.

" - } - }, - "ModelMetadataFilters": { - "base": null, - "refs": { - "ModelMetadataSearchExpression$Filters": "

A list of filter objects.

" - } - }, - "ModelMetadataSearchExpression": { - "base": "

One or more filters that searches for the specified resource or resources in a search. All resource objects that satisfy the expression's condition are included in the search results

", - "refs": { - "ListModelMetadataRequest$SearchExpression": "

One or more filters that searches for the specified resource or resources in a search. All resource objects that satisfy the expression's condition are included in the search results. Specify the Framework, FrameworkVersion, Domain or Task to filter supported. Filter names and values are case-sensitive.

" - } - }, - "ModelMetadataSummaries": { - "base": null, - "refs": { - "ListModelMetadataResponse$ModelMetadataSummaries": "

A structure that holds model metadata.

" - } - }, - "ModelMetadataSummary": { - "base": "

A summary of the model metadata.

", - "refs": { - "ModelMetadataSummaries$member": null - } - }, - "ModelMetrics": { - "base": "

Contains metrics captured from a model.

", - "refs": { - "CreateModelPackageInput$ModelMetrics": "

A structure that contains model metrics reports.

", - "DescribeModelPackageOutput$ModelMetrics": "

Metrics for the model.

", - "ModelPackage$ModelMetrics": "

Metrics for the model.

" - } - }, - "ModelName": { - "base": null, - "refs": { - "CreateModelInput$ModelName": "

The name of the new model.

", - "CreateTransformJobRequest$ModelName": "

The name of the model that you want to use for the transform job. ModelName must be the name of an existing Amazon SageMaker model within an Amazon Web Services Region in an Amazon Web Services account.

", - "DeleteModelInput$ModelName": "

The name of the model to delete.

", - "DescribeModelInput$ModelName": "

The name of the model.

", - "DescribeModelOutput$ModelName": "

Name of the SageMaker model.

", - "DescribeTransformJobResponse$ModelName": "

The name of the model used in the transform job.

", - "InferenceComponentSpecification$ModelName": "

The name of an existing SageMaker AI model object in your account that you want to deploy with the inference component.

", - "InferenceComponentSpecificationSummary$ModelName": "

The name of the SageMaker AI model object that is deployed with the inference component.

", - "InferenceRecommendationsJob$ModelName": "

The name of the created model.

", - "InstancePool$ModelNameOverride": "

The name of a SageMaker model to use for this instance pool instead of the model specified for the production variant. Use this to deploy a different model optimized for the instance type in this pool.

", - "ListInferenceRecommendationsJobsRequest$ModelNameEquals": "

A filter that returns only jobs that were created for this model.

", - "Model$ModelName": "

The name of the model.

", - "ModelSummary$ModelName": "

The name of the model that you want a summary for.

", - "ModelVariantConfig$ModelName": "

The name of the Amazon SageMaker Model entity.

", - "ModelVariantConfigSummary$ModelName": "

The name of the Amazon SageMaker Model entity.

", - "OptimizationSageMakerModel$ModelName": "

The name of a SageMaker model.

", - "ProductionVariant$ModelName": "

The name of the model that you want to host. This is the name that you specified when creating the model.

", - "RecommendationJobInputConfig$ModelName": "

The name of the created model.

", - "TransformJob$ModelName": "

The name of the model associated with the transform job.

" - } - }, - "ModelNameContains": { - "base": null, - "refs": { - "ListModelsInput$NameContains": "

A string in the model name. This filter returns only models whose name contains the specified string.

" - } - }, - "ModelPackage": { - "base": "

A container for your trained model that can be deployed for SageMaker inference. This can include inference code, artifacts, and metadata. The model package type can be one of the following.

  • Versioned model: A part of a model package group in Model Registry.

  • Unversioned model: Not part of a model package group and used in Amazon Web Services Marketplace.

For more information, see CreateModelPackage .

", - "refs": { - "SearchRecord$ModelPackage": null - } - }, - "ModelPackageArn": { - "base": null, - "refs": { - "AIAdapterModelPackageEntry$ModelPackageArn": "

The Amazon Resource Name (ARN) of the model package that contains the LoRA adapter artifacts.

", - "AIRecommendationModelDetails$ModelPackageArn": "

The Amazon Resource Name (ARN) of the model package.

", - "BatchDescribeModelPackageErrorMap$key": null, - "BatchDescribeModelPackageSummary$ModelPackageArn": "

The Amazon Resource Name (ARN) of the model package.

", - "CreateCompilationJobRequest$ModelPackageVersionArn": "

The Amazon Resource Name (ARN) of a versioned model package. Provide either a ModelPackageVersionArn or an InputConfig object in the request syntax. The presence of both objects in the CreateCompilationJob request will return an exception.

", - "CreateModelPackageOutput$ModelPackageArn": "

The Amazon Resource Name (ARN) of the new model package.

", - "DescribeCompilationJobResponse$ModelPackageVersionArn": "

The Amazon Resource Name (ARN) of the versioned model package that was provided to SageMaker Neo when you initiated a compilation job.

", - "DescribeModelPackageOutput$ModelPackageArn": "

The Amazon Resource Name (ARN) of the model package.

", - "DescribeTrainingJobResponse$OutputModelPackageArn": "

The Amazon Resource Name (ARN) of the output model package containing model weights or checkpoints.

", - "InferenceRecommendationsJob$ModelPackageVersionArn": "

The Amazon Resource Name (ARN) of a versioned model package.

", - "ListInferenceRecommendationsJobsRequest$ModelPackageVersionArnEquals": "

A filter that returns only jobs that were created for this versioned model package.

", - "ModelPackage$ModelPackageArn": "

The Amazon Resource Name (ARN) of the model package.

", - "ModelPackageArnList$member": null, - "ModelPackageConfig$SourceModelPackageArn": "

The Amazon Resource Name (ARN) of the source model package used for continued fine-tuning and custom model evaluation.

", - "ModelPackageSummaries$key": null, - "ModelPackageSummary$ModelPackageArn": "

The Amazon Resource Name (ARN) of the model package.

", - "RecommendationJobInputConfig$ModelPackageVersionArn": "

The Amazon Resource Name (ARN) of a versioned model package.

", - "TrainingJob$OutputModelPackageArn": "

The output model package Amazon Resource Name (ARN) that contains model weights or checkpoint.

", - "UpdateModelPackageInput$ModelPackageArn": "

The Amazon Resource Name (ARN) of the model package.

", - "UpdateModelPackageOutput$ModelPackageArn": "

The Amazon Resource Name (ARN) of the model.

" - } - }, - "ModelPackageArnList": { - "base": null, - "refs": { - "BatchDescribeModelPackageInput$ModelPackageArnList": "

The list of Amazon Resource Name (ARN) of the model package groups.

" - } - }, - "ModelPackageConfig": { - "base": "

The configuration for the Model package.

", - "refs": { - "CreateTrainingJobRequest$ModelPackageConfig": "

The configuration for the model package.

", - "DescribeTrainingJobResponse$ModelPackageConfig": "

The configuration for the model package.

", - "TrainingJob$ModelPackageConfig": "

The model package configuration.

" - } - }, - "ModelPackageContainerDefinition": { - "base": "

Describes the Docker container for the model package.

", - "refs": { - "ModelPackageContainerDefinitionList$member": null - } - }, - "ModelPackageContainerDefinitionList": { - "base": null, - "refs": { - "AdditionalInferenceSpecificationDefinition$Containers": "

The Amazon ECR registry path of the Docker image that contains the inference code.

", - "InferenceSpecification$Containers": "

The Amazon ECR registry path of the Docker image that contains the inference code.

" - } - }, - "ModelPackageFrameworkVersion": { - "base": null, - "refs": { - "ModelPackageContainerDefinition$FrameworkVersion": "

The framework version of the Model Package Container Image.

" - } - }, - "ModelPackageGroup": { - "base": "

A group of versioned models in the Model Registry.

", - "refs": { - "SearchRecord$ModelPackageGroup": null - } - }, - "ModelPackageGroupArn": { - "base": null, - "refs": { - "CreateModelPackageGroupOutput$ModelPackageGroupArn": "

The Amazon Resource Name (ARN) of the model group.

", - "DescribeModelPackageGroupOutput$ModelPackageGroupArn": "

The Amazon Resource Name (ARN) of the model group.

", - "ModelPackageConfig$ModelPackageGroupArn": "

The Amazon Resource Name (ARN) of the model package group of output model package.

", - "ModelPackageGroup$ModelPackageGroupArn": "

The Amazon Resource Name (ARN) of the model group.

", - "ModelPackageGroupSummary$ModelPackageGroupArn": "

The Amazon Resource Name (ARN) of the model group.

", - "PutModelPackageGroupPolicyOutput$ModelPackageGroupArn": "

The Amazon Resource Name (ARN) of the model package group.

" - } - }, - "ModelPackageGroupSortBy": { - "base": null, - "refs": { - "ListModelPackageGroupsInput$SortBy": "

The field to sort results by. The default is CreationTime.

" - } - }, - "ModelPackageGroupStatus": { - "base": null, - "refs": { - "DescribeModelPackageGroupOutput$ModelPackageGroupStatus": "

The status of the model group.

", - "ModelPackageGroup$ModelPackageGroupStatus": "

The status of the model group. This can be one of the following values.

  • PENDING - The model group is pending being created.

  • IN_PROGRESS - The model group is in the process of being created.

  • COMPLETED - The model group was successfully created.

  • FAILED - The model group failed.

  • DELETING - The model group is in the process of being deleted.

  • DELETE_FAILED - SageMaker failed to delete the model group.

", - "ModelPackageGroupSummary$ModelPackageGroupStatus": "

The status of the model group.

" - } - }, - "ModelPackageGroupSummary": { - "base": "

Summary information about a model group.

", - "refs": { - "ModelPackageGroupSummaryList$member": null - } - }, - "ModelPackageGroupSummaryList": { - "base": null, - "refs": { - "ListModelPackageGroupsOutput$ModelPackageGroupSummaryList": "

A list of summaries of the model groups in your Amazon Web Services account.

" - } - }, - "ModelPackageModelCard": { - "base": "

The model card associated with the model package. Since ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version.

", - "refs": { - "CreateModelPackageInput$ModelCard": "

The model card associated with the model package. Since ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version.

", - "DescribeModelPackageOutput$ModelCard": "

The model card associated with the model package. Since ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version.

When you set IncludedData to MetadataOnly in the request, ModelCardStatus is preserved and ModelCardContent is sanitized to include only the following JSON paths, when present in the model card:

  • model_overview.model_id

  • model_overview.model_name

  • intended_uses.risk_rating

  • model_package_details.model_package_group_name

  • model_package_details.model_package_arn

Because the ModelPackageModelCard schema does not include model_package_details and limits model_overview to model_creator and model_artifact, the sanitized ModelCardContent for a model package typically contains only intended_uses.risk_rating if it was provided when the model card was created. To retrieve the complete ModelCardContent, set IncludedData to AllData or omit the parameter.

", - "ModelPackage$ModelCard": null, - "UpdateModelPackageInput$ModelCard": "

The model card associated with the model package. Since ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version.

" - } - }, - "ModelPackageRegistrationType": { - "base": null, - "refs": { - "BatchDescribeModelPackageSummary$ModelPackageRegistrationType": "

The package registration type of the model package summary.

", - "CreateModelPackageInput$ModelPackageRegistrationType": "

The package registration type of the model package input.

", - "DescribeModelPackageOutput$ModelPackageRegistrationType": "

The package registration type of the model package output.

", - "ModelPackage$ModelPackageRegistrationType": "

The package registration type of the model package.

", - "ModelPackageSummary$ModelPackageRegistrationType": "

The package registration type of the model package summary.

", - "UpdateModelPackageInput$ModelPackageRegistrationType": "

The package registration type of the model package input.

" - } - }, - "ModelPackageSecurityConfig": { - "base": "

An optional Key Management Service key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with highly sensitive data.

", - "refs": { - "CreateModelPackageInput$SecurityConfig": "

The KMS Key ID (KMSKeyId) used for encryption of model package information.

", - "DescribeModelPackageOutput$SecurityConfig": "

The KMS Key ID (KMSKeyId) used for encryption of model package information.

", - "ModelPackage$SecurityConfig": null - } - }, - "ModelPackageSortBy": { - "base": null, - "refs": { - "ListModelPackagesInput$SortBy": "

The parameter by which to sort the results. The default is CreationTime.

" - } - }, - "ModelPackageSourceUri": { - "base": null, - "refs": { - "CreateModelPackageInput$SourceUri": "

The URI of the source for the model package. If you want to clone a model package, set it to the model package Amazon Resource Name (ARN). If you want to register a model, set it to the model ARN.

", - "DescribeModelPackageOutput$SourceUri": "

The URI of the source for the model package.

", - "ModelPackage$SourceUri": "

The URI of the source for the model package.

", - "UpdateModelPackageInput$SourceUri": "

The URI of the source for the model package.

" - } - }, - "ModelPackageStatus": { - "base": null, - "refs": { - "BatchDescribeModelPackageSummary$ModelPackageStatus": "

The status of the mortgage package.

", - "DescribeModelPackageOutput$ModelPackageStatus": "

The current status of the model package.

", - "ModelPackage$ModelPackageStatus": "

The status of the model package. This can be one of the following values.

  • PENDING - The model package is pending being created.

  • IN_PROGRESS - The model package is in the process of being created.

  • COMPLETED - The model package was successfully created.

  • FAILED - The model package failed.

  • DELETING - The model package is in the process of being deleted.

", - "ModelPackageSummary$ModelPackageStatus": "

The overall status of the model package.

" - } - }, - "ModelPackageStatusDetails": { - "base": "

Specifies the validation and image scan statuses of the model package.

", - "refs": { - "DescribeModelPackageOutput$ModelPackageStatusDetails": "

Details about the current status of the model package.

", - "ModelPackage$ModelPackageStatusDetails": "

Specifies the validation and image scan statuses of the model package.

" - } - }, - "ModelPackageStatusItem": { - "base": "

Represents the overall status of a model package.

", - "refs": { - "ModelPackageStatusItemList$member": null - } - }, - "ModelPackageStatusItemList": { - "base": null, - "refs": { - "ModelPackageStatusDetails$ValidationStatuses": "

The validation status of the model package.

", - "ModelPackageStatusDetails$ImageScanStatuses": "

The status of the scan of the Docker image container for the model package.

" - } - }, - "ModelPackageSummaries": { - "base": null, - "refs": { - "BatchDescribeModelPackageOutput$ModelPackageSummaries": "

The summaries for the model package versions

" - } - }, - "ModelPackageSummary": { - "base": "

Provides summary information about a model package.

", - "refs": { - "ModelPackageSummaryList$member": null - } - }, - "ModelPackageSummaryList": { - "base": null, - "refs": { - "ListModelPackagesOutput$ModelPackageSummaryList": "

An array of ModelPackageSummary objects, each of which lists a model package.

" - } - }, - "ModelPackageType": { - "base": null, - "refs": { - "ListModelPackagesInput$ModelPackageType": "

A filter that returns only the model packages of the specified type. This can be one of the following values.

  • UNVERSIONED - List only unversioined models. This is the default value if no ModelPackageType is specified.

  • VERSIONED - List only versioned models.

  • BOTH - List both versioned and unversioned models.

" - } - }, - "ModelPackageValidationProfile": { - "base": "

Contains data, such as the inputs and targeted instance types that are used in the process of validating the model package.

The data provided in the validation profile is made available to your buyers on Amazon Web Services Marketplace.

", - "refs": { - "ModelPackageValidationProfiles$member": null - } - }, - "ModelPackageValidationProfiles": { - "base": null, - "refs": { - "ModelPackageValidationSpecification$ValidationProfiles": "

An array of ModelPackageValidationProfile objects, each of which specifies a batch transform job that SageMaker runs to validate your model package.

" - } - }, - "ModelPackageValidationSpecification": { - "base": "

Specifies batch transform jobs that SageMaker runs to validate your model package.

", - "refs": { - "CreateModelPackageInput$ValidationSpecification": "

Specifies configurations for one or more transform jobs that SageMaker runs to test the model package.

", - "DescribeModelPackageOutput$ValidationSpecification": "

Configurations for one or more transform jobs that SageMaker runs to test the model package.

", - "ModelPackage$ValidationSpecification": "

Specifies batch transform jobs that SageMaker runs to validate your model package.

" - } - }, - "ModelPackageVersion": { - "base": null, - "refs": { - "BatchDescribeModelPackageSummary$ModelPackageVersion": "

The version number of a versioned model.

", - "DescribeModelPackageOutput$ModelPackageVersion": "

The version of the model package.

", - "ModelPackage$ModelPackageVersion": "

The version number of a versioned model.

", - "ModelPackageSummary$ModelPackageVersion": "

If the model package is a versioned model, the version of the model.

" - } - }, - "ModelQuality": { - "base": "

Model quality statistics and constraints.

", - "refs": { - "ModelMetrics$ModelQuality": "

Metrics that measure the quality of a model.

" - } - }, - "ModelQualityAppSpecification": { - "base": "

Container image configuration object for the monitoring job.

", - "refs": { - "CreateModelQualityJobDefinitionRequest$ModelQualityAppSpecification": "

The container that runs the monitoring job.

", - "DescribeModelQualityJobDefinitionResponse$ModelQualityAppSpecification": "

Configures the model quality job to run a specified Docker container image.

" - } - }, - "ModelQualityBaselineConfig": { - "base": "

Configuration for monitoring constraints and monitoring statistics. These baseline resources are compared against the results of the current job from the series of jobs scheduled to collect data periodically.

", - "refs": { - "CreateModelQualityJobDefinitionRequest$ModelQualityBaselineConfig": "

Specifies the constraints and baselines for the monitoring job.

", - "DescribeModelQualityJobDefinitionResponse$ModelQualityBaselineConfig": "

The baseline configuration for a model quality job.

" - } - }, - "ModelQualityJobInput": { - "base": "

The input for the model quality monitoring job. Currently endpoints are supported for input for model quality monitoring jobs.

", - "refs": { - "CreateModelQualityJobDefinitionRequest$ModelQualityJobInput": "

A list of the inputs that are monitored. Currently endpoints are supported.

", - "DescribeModelQualityJobDefinitionResponse$ModelQualityJobInput": "

Inputs for the model quality job.

" - } - }, - "ModelQuantizationConfig": { - "base": "

Settings for the model quantization technique that's applied by a model optimization job.

", - "refs": { - "OptimizationConfig$ModelQuantizationConfig": "

Settings for the model quantization technique that's applied by a model optimization job.

" - } - }, - "ModelRegisterSettings": { - "base": "

The model registry settings for the SageMaker Canvas application.

", - "refs": { - "CanvasAppSettings$ModelRegisterSettings": "

The model registry settings for the SageMaker Canvas application.

" - } - }, - "ModelRegistrationMode": { - "base": null, - "refs": { - "CreateMlflowAppRequest$ModelRegistrationMode": "

Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. To enable automatic model registration, set this value to AutoModelRegistrationEnabled. To disable automatic model registration, set this value to AutoModelRegistrationDisabled. If not specified, AutomaticModelRegistration defaults to AutoModelRegistrationDisabled.

", - "DescribeMlflowAppResponse$ModelRegistrationMode": "

Whether automatic registration of new MLflow models to the SageMaker Model Registry is enabled.

", - "UpdateMlflowAppRequest$ModelRegistrationMode": "

Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. To enable automatic model registration, set this value to AutoModelRegistrationEnabled. To disable automatic model registration, set this value to AutoModelRegistrationDisabled. If not specified, AutomaticModelRegistration defaults to AutoModelRegistrationEnabled

" - } - }, - "ModelSetupTime": { - "base": null, - "refs": { - "RecommendationMetrics$ModelSetupTime": "

The time it takes to launch new compute resources for a serverless endpoint. The time can vary depending on the model size, how long it takes to download the model, and the start-up time of the container.

NaN indicates that the value is not available.

" - } - }, - "ModelShardingConfig": { - "base": "

Settings for the model sharding technique that's applied by a model optimization job.

", - "refs": { - "OptimizationConfig$ModelShardingConfig": "

Settings for the model sharding technique that's applied by a model optimization job.

" - } - }, - "ModelSortKey": { - "base": null, - "refs": { - "ListModelsInput$SortBy": "

Sorts the list of results. The default is CreationTime.

" - } - }, - "ModelSpeculativeDecodingConfig": { - "base": "

Settings for the model speculative decoding technique that's applied by a model optimization job.

", - "refs": { - "OptimizationConfig$ModelSpeculativeDecodingConfig": "

Settings for the model speculative decoding technique that's applied by a model optimization job.

" - } - }, - "ModelSpeculativeDecodingS3DataType": { - "base": null, - "refs": { - "ModelSpeculativeDecodingTrainingDataSource$S3DataType": "

The type of data stored in the Amazon S3 location. Valid values are S3Prefix or ManifestFile.

" - } - }, - "ModelSpeculativeDecodingTechnique": { - "base": null, - "refs": { - "ModelSpeculativeDecodingConfig$Technique": "

The speculative decoding technique to apply during model optimization.

" - } - }, - "ModelSpeculativeDecodingTrainingDataSource": { - "base": "

Contains information about the training data source for speculative decoding.

", - "refs": { - "ModelSpeculativeDecodingConfig$TrainingDataSource": "

The location of the training data to use for speculative decoding. The data must be formatted as ShareGPT, OpenAI Completions or OpenAI Chat Completions. The input can also be unencrypted captured data from a SageMaker endpoint as long as the endpoint uses one of the above formats.

" - } - }, - "ModelStepMetadata": { - "base": "

Metadata for Model steps.

", - "refs": { - "PipelineExecutionStepMetadata$Model": "

The Amazon Resource Name (ARN) of the model that was created by this step execution.

" - } - }, - "ModelSummary": { - "base": "

Provides summary information about a model.

", - "refs": { - "ModelSummaryList$member": null - } - }, - "ModelSummaryList": { - "base": null, - "refs": { - "ListModelsOutput$Models": "

An array of ModelSummary objects, each of which lists a model.

" - } - }, - "ModelVariantAction": { - "base": null, - "refs": { - "ModelVariantActionMap$value": null - } - }, - "ModelVariantActionMap": { - "base": null, - "refs": { - "StopInferenceExperimentRequest$ModelVariantActions": "

Array of key-value pairs, with names of variants mapped to actions. The possible actions are the following:

  • Promote - Promote the shadow variant to a production variant

  • Remove - Delete the variant

  • Retain - Keep the variant as it is

" - } - }, - "ModelVariantConfig": { - "base": "

Contains information about the deployment options of a model.

", - "refs": { - "ModelVariantConfigList$member": null - } - }, - "ModelVariantConfigList": { - "base": null, - "refs": { - "CreateInferenceExperimentRequest$ModelVariants": "

An array of ModelVariantConfig objects. There is one for each variant in the inference experiment. Each ModelVariantConfig object in the array describes the infrastructure configuration for the corresponding variant.

", - "StopInferenceExperimentRequest$DesiredModelVariants": "

An array of ModelVariantConfig objects. There is one for each variant that you want to deploy after the inference experiment stops. Each ModelVariantConfig describes the infrastructure configuration for deploying the corresponding variant.

", - "UpdateInferenceExperimentRequest$ModelVariants": "

An array of ModelVariantConfig objects. There is one for each variant, whose infrastructure configuration you want to update.

" - } - }, - "ModelVariantConfigSummary": { - "base": "

Summary of the deployment configuration of a model.

", - "refs": { - "ModelVariantConfigSummaryList$member": null - } - }, - "ModelVariantConfigSummaryList": { - "base": null, - "refs": { - "DescribeInferenceExperimentResponse$ModelVariants": "

An array of ModelVariantConfigSummary objects. There is one for each variant in the inference experiment. Each ModelVariantConfigSummary object in the array describes the infrastructure configuration for deploying the corresponding variant.

" - } - }, - "ModelVariantName": { - "base": null, - "refs": { - "ModelVariantActionMap$key": null, - "ModelVariantConfig$VariantName": "

The name of the variant.

", - "ModelVariantConfigSummary$VariantName": "

The name of the variant.

", - "ShadowModeConfig$SourceModelVariantName": "

The name of the production variant, which takes all the inference requests.

", - "ShadowModelVariantConfig$ShadowModelVariantName": "

The name of the shadow variant.

" - } - }, - "ModelVariantStatus": { - "base": null, - "refs": { - "ModelVariantConfigSummary$Status": "

The status of deployment for the model variant on the hosted inference endpoint.

  • Creating - Amazon SageMaker is preparing the model variant on the hosted inference endpoint.

  • InService - The model variant is running on the hosted inference endpoint.

  • Updating - Amazon SageMaker is updating the model variant on the hosted inference endpoint.

  • Deleting - Amazon SageMaker is deleting the model variant on the hosted inference endpoint.

  • Deleted - The model variant has been deleted on the hosted inference endpoint. This can only happen after stopping the experiment.

" - } - }, - "MonitoringAlertActions": { - "base": "

A list of alert actions taken in response to an alert going into InAlert status.

", - "refs": { - "MonitoringAlertSummary$Actions": "

A list of alert actions taken in response to an alert going into InAlert status.

" - } - }, - "MonitoringAlertHistoryList": { - "base": null, - "refs": { - "ListMonitoringAlertHistoryResponse$MonitoringAlertHistory": "

An alert history for a model monitoring schedule.

" - } - }, - "MonitoringAlertHistorySortKey": { - "base": null, - "refs": { - "ListMonitoringAlertHistoryRequest$SortBy": "

The field used to sort results. The default is CreationTime.

" - } - }, - "MonitoringAlertHistorySummary": { - "base": "

Provides summary information of an alert's history.

", - "refs": { - "MonitoringAlertHistoryList$member": null - } - }, - "MonitoringAlertName": { - "base": null, - "refs": { - "ListMonitoringAlertHistoryRequest$MonitoringAlertName": "

The name of a monitoring alert.

", - "MonitoringAlertHistorySummary$MonitoringAlertName": "

The name of a monitoring alert.

", - "MonitoringAlertSummary$MonitoringAlertName": "

The name of a monitoring alert.

", - "UpdateMonitoringAlertRequest$MonitoringAlertName": "

The name of a monitoring alert.

", - "UpdateMonitoringAlertResponse$MonitoringAlertName": "

The name of a monitoring alert.

" - } - }, - "MonitoringAlertStatus": { - "base": null, - "refs": { - "ListMonitoringAlertHistoryRequest$StatusEquals": "

A filter that retrieves only alerts with a specific status.

", - "MonitoringAlertHistorySummary$AlertStatus": "

The current alert status of an alert.

", - "MonitoringAlertSummary$AlertStatus": "

The current status of an alert.

" - } - }, - "MonitoringAlertSummary": { - "base": "

Provides summary information about a monitor alert.

", - "refs": { - "MonitoringAlertSummaryList$member": null - } - }, - "MonitoringAlertSummaryList": { - "base": null, - "refs": { - "ListMonitoringAlertsResponse$MonitoringAlertSummaries": "

A JSON array where each element is a summary for a monitoring alert.

", - "ModelDashboardMonitoringSchedule$MonitoringAlertSummaries": "

A JSON array where each element is a summary for a monitoring alert.

" - } - }, - "MonitoringAppSpecification": { - "base": "

Container image configuration object for the monitoring job.

", - "refs": { - "MonitoringJobDefinition$MonitoringAppSpecification": "

Configures the monitoring job to run a specified Docker container image.

" - } - }, - "MonitoringBaselineConfig": { - "base": "

Configuration for monitoring constraints and monitoring statistics. These baseline resources are compared against the results of the current job from the series of jobs scheduled to collect data periodically.

", - "refs": { - "MonitoringJobDefinition$BaselineConfig": "

Baseline configuration used to validate that the data conforms to the specified constraints and statistics

" - } - }, - "MonitoringClusterConfig": { - "base": "

Configuration for the cluster used to run model monitoring jobs.

", - "refs": { - "MonitoringResources$ClusterConfig": "

The configuration for the cluster resources used to run the processing job.

" - } - }, - "MonitoringConstraintsResource": { - "base": "

The constraints resource for a monitoring job.

", - "refs": { - "DataQualityBaselineConfig$ConstraintsResource": null, - "ModelBiasBaselineConfig$ConstraintsResource": null, - "ModelExplainabilityBaselineConfig$ConstraintsResource": null, - "ModelQualityBaselineConfig$ConstraintsResource": null, - "MonitoringBaselineConfig$ConstraintsResource": "

The baseline constraint file in Amazon S3 that the current monitoring job should validated against.

" - } - }, - "MonitoringContainerArguments": { - "base": null, - "refs": { - "DataQualityAppSpecification$ContainerArguments": "

The arguments to send to the container that the monitoring job runs.

", - "ModelQualityAppSpecification$ContainerArguments": "

An array of arguments for the container used to run the monitoring job.

", - "MonitoringAppSpecification$ContainerArguments": "

An array of arguments for the container used to run the monitoring job.

" - } - }, - "MonitoringCsvDatasetFormat": { - "base": "

Represents the CSV dataset format used when running a monitoring job.

", - "refs": { - "MonitoringDatasetFormat$Csv": "

The CSV dataset used in the monitoring job.

" - } - }, - "MonitoringDatapointsToAlert": { - "base": null, - "refs": { - "MonitoringAlertSummary$DatapointsToAlert": "

Within EvaluationPeriod, how many execution failures will raise an alert.

", - "UpdateMonitoringAlertRequest$DatapointsToAlert": "

Within EvaluationPeriod, how many execution failures will raise an alert.

" - } - }, - "MonitoringDatasetFormat": { - "base": "

Represents the dataset format used when running a monitoring job.

", - "refs": { - "BatchTransformInput$DatasetFormat": "

The dataset format for your batch transform job.

" - } - }, - "MonitoringEnvironmentMap": { - "base": null, - "refs": { - "DataQualityAppSpecification$Environment": "

Sets the environment variables in the container that the monitoring job runs.

", - "ModelBiasAppSpecification$Environment": "

Sets the environment variables in the Docker container.

", - "ModelExplainabilityAppSpecification$Environment": "

Sets the environment variables in the Docker container.

", - "ModelQualityAppSpecification$Environment": "

Sets the environment variables in the container that the monitoring job runs.

", - "MonitoringJobDefinition$Environment": "

Sets the environment variables in the Docker container.

" - } - }, - "MonitoringEvaluationPeriod": { - "base": null, - "refs": { - "MonitoringAlertSummary$EvaluationPeriod": "

The number of most recent monitoring executions to consider when evaluating alert status.

", - "UpdateMonitoringAlertRequest$EvaluationPeriod": "

The number of most recent monitoring executions to consider when evaluating alert status.

" - } - }, - "MonitoringExecutionSortKey": { - "base": null, - "refs": { - "ListMonitoringExecutionsRequest$SortBy": "

Whether to sort the results by the Status, CreationTime, or ScheduledTime field. The default is CreationTime.

" - } - }, - "MonitoringExecutionSummary": { - "base": "

Summary of information about the last monitoring job to run.

", - "refs": { - "DescribeMonitoringScheduleResponse$LastMonitoringExecutionSummary": "

Describes metadata on the last execution to run, if there was one.

", - "ModelDashboardMonitoringSchedule$LastMonitoringExecutionSummary": null, - "MonitoringExecutionSummaryList$member": null, - "MonitoringSchedule$LastMonitoringExecutionSummary": null - } - }, - "MonitoringExecutionSummaryList": { - "base": null, - "refs": { - "ListMonitoringExecutionsResponse$MonitoringExecutionSummaries": "

A JSON array in which each element is a summary for a monitoring execution.

" - } - }, - "MonitoringGroundTruthS3Input": { - "base": "

The ground truth labels for the dataset used for the monitoring job.

", - "refs": { - "ModelBiasJobInput$GroundTruthS3Input": "

Location of ground truth labels to use in model bias job.

", - "ModelQualityJobInput$GroundTruthS3Input": "

The ground truth label provided for the model.

" - } - }, - "MonitoringInput": { - "base": "

The inputs for a monitoring job.

", - "refs": { - "MonitoringInputs$member": null - } - }, - "MonitoringInputs": { - "base": null, - "refs": { - "MonitoringJobDefinition$MonitoringInputs": "

The array of inputs for the monitoring job. Currently we support monitoring an Amazon SageMaker AI Endpoint.

" - } - }, - "MonitoringJobDefinition": { - "base": "

Defines the monitoring job.

", - "refs": { - "MonitoringScheduleConfig$MonitoringJobDefinition": "

Defines the monitoring job.

" - } - }, - "MonitoringJobDefinitionArn": { - "base": null, - "refs": { - "CreateDataQualityJobDefinitionResponse$JobDefinitionArn": "

The Amazon Resource Name (ARN) of the job definition.

", - "CreateModelBiasJobDefinitionResponse$JobDefinitionArn": "

The Amazon Resource Name (ARN) of the model bias job.

", - "CreateModelExplainabilityJobDefinitionResponse$JobDefinitionArn": "

The Amazon Resource Name (ARN) of the model explainability job.

", - "CreateModelQualityJobDefinitionResponse$JobDefinitionArn": "

The Amazon Resource Name (ARN) of the model quality monitoring job.

", - "DescribeDataQualityJobDefinitionResponse$JobDefinitionArn": "

The Amazon Resource Name (ARN) of the data quality monitoring job definition.

", - "DescribeModelBiasJobDefinitionResponse$JobDefinitionArn": "

The Amazon Resource Name (ARN) of the model bias job.

", - "DescribeModelExplainabilityJobDefinitionResponse$JobDefinitionArn": "

The Amazon Resource Name (ARN) of the model explainability job.

", - "DescribeModelQualityJobDefinitionResponse$JobDefinitionArn": "

The Amazon Resource Name (ARN) of the model quality job.

", - "MonitoringJobDefinitionSummary$MonitoringJobDefinitionArn": "

The Amazon Resource Name (ARN) of the monitoring job.

" - } - }, - "MonitoringJobDefinitionName": { - "base": null, - "refs": { - "CreateDataQualityJobDefinitionRequest$JobDefinitionName": "

The name for the monitoring job definition.

", - "CreateModelBiasJobDefinitionRequest$JobDefinitionName": "

The name of the bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

", - "CreateModelExplainabilityJobDefinitionRequest$JobDefinitionName": "

The name of the model explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

", - "CreateModelQualityJobDefinitionRequest$JobDefinitionName": "

The name of the monitoring job definition.

", - "DeleteDataQualityJobDefinitionRequest$JobDefinitionName": "

The name of the data quality monitoring job definition to delete.

", - "DeleteModelBiasJobDefinitionRequest$JobDefinitionName": "

The name of the model bias job definition to delete.

", - "DeleteModelExplainabilityJobDefinitionRequest$JobDefinitionName": "

The name of the model explainability job definition to delete.

", - "DeleteModelQualityJobDefinitionRequest$JobDefinitionName": "

The name of the model quality monitoring job definition to delete.

", - "DescribeDataQualityJobDefinitionRequest$JobDefinitionName": "

The name of the data quality monitoring job definition to describe.

", - "DescribeDataQualityJobDefinitionResponse$JobDefinitionName": "

The name of the data quality monitoring job definition.

", - "DescribeModelBiasJobDefinitionRequest$JobDefinitionName": "

The name of the model bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

", - "DescribeModelBiasJobDefinitionResponse$JobDefinitionName": "

The name of the bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

", - "DescribeModelExplainabilityJobDefinitionRequest$JobDefinitionName": "

The name of the model explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

", - "DescribeModelExplainabilityJobDefinitionResponse$JobDefinitionName": "

The name of the explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

", - "DescribeModelQualityJobDefinitionRequest$JobDefinitionName": "

The name of the model quality job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

", - "DescribeModelQualityJobDefinitionResponse$JobDefinitionName": "

The name of the quality job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

", - "ListMonitoringExecutionsRequest$MonitoringJobDefinitionName": "

Gets a list of the monitoring job runs of the specified monitoring job definitions.

", - "ListMonitoringSchedulesRequest$MonitoringJobDefinitionName": "

Gets a list of the monitoring schedules for the specified monitoring job definition.

", - "MonitoringExecutionSummary$MonitoringJobDefinitionName": "

The name of the monitoring job.

", - "MonitoringJobDefinitionSummary$MonitoringJobDefinitionName": "

The name of the monitoring job.

", - "MonitoringScheduleConfig$MonitoringJobDefinitionName": "

The name of the monitoring job definition to schedule.

", - "MonitoringScheduleSummary$MonitoringJobDefinitionName": "

The name of the monitoring job definition that the schedule is for.

" - } - }, - "MonitoringJobDefinitionSortKey": { - "base": null, - "refs": { - "ListDataQualityJobDefinitionsRequest$SortBy": "

The field to sort results by. The default is CreationTime.

", - "ListModelBiasJobDefinitionsRequest$SortBy": "

Whether to sort results by the Name or CreationTime field. The default is CreationTime.

", - "ListModelExplainabilityJobDefinitionsRequest$SortBy": "

Whether to sort results by the Name or CreationTime field. The default is CreationTime.

", - "ListModelQualityJobDefinitionsRequest$SortBy": "

The field to sort results by. The default is CreationTime.

" - } - }, - "MonitoringJobDefinitionSummary": { - "base": "

Summary information about a monitoring job.

", - "refs": { - "MonitoringJobDefinitionSummaryList$member": null - } - }, - "MonitoringJobDefinitionSummaryList": { - "base": null, - "refs": { - "ListDataQualityJobDefinitionsResponse$JobDefinitionSummaries": "

A list of data quality monitoring job definitions.

", - "ListModelBiasJobDefinitionsResponse$JobDefinitionSummaries": "

A JSON array in which each element is a summary for a model bias jobs.

", - "ListModelExplainabilityJobDefinitionsResponse$JobDefinitionSummaries": "

A JSON array in which each element is a summary for a explainability bias jobs.

", - "ListModelQualityJobDefinitionsResponse$JobDefinitionSummaries": "

A list of summaries of model quality monitoring job definitions.

" - } - }, - "MonitoringJsonDatasetFormat": { - "base": "

Represents the JSON dataset format used when running a monitoring job.

", - "refs": { - "MonitoringDatasetFormat$Json": "

The JSON dataset used in the monitoring job

" - } - }, - "MonitoringMaxRuntimeInSeconds": { - "base": null, - "refs": { - "MonitoringStoppingCondition$MaxRuntimeInSeconds": "

The maximum runtime allowed in seconds.

The MaxRuntimeInSeconds cannot exceed the frequency of the job. For data quality and model explainability, this can be up to 3600 seconds for an hourly schedule. For model bias and model quality hourly schedules, this can be up to 1800 seconds.

" - } - }, - "MonitoringNetworkConfig": { - "base": "

The networking configuration for the monitoring job.

", - "refs": { - "CreateDataQualityJobDefinitionRequest$NetworkConfig": "

Specifies networking configuration for the monitoring job.

", - "CreateModelBiasJobDefinitionRequest$NetworkConfig": "

Networking options for a model bias job.

", - "CreateModelExplainabilityJobDefinitionRequest$NetworkConfig": "

Networking options for a model explainability job.

", - "CreateModelQualityJobDefinitionRequest$NetworkConfig": "

Specifies the network configuration for the monitoring job.

", - "DescribeDataQualityJobDefinitionResponse$NetworkConfig": "

The networking configuration for the data quality monitoring job.

", - "DescribeModelBiasJobDefinitionResponse$NetworkConfig": "

Networking options for a model bias job.

", - "DescribeModelExplainabilityJobDefinitionResponse$NetworkConfig": "

Networking options for a model explainability job.

", - "DescribeModelQualityJobDefinitionResponse$NetworkConfig": "

Networking options for a model quality job.

" - } - }, - "MonitoringOutput": { - "base": "

The output object for a monitoring job.

", - "refs": { - "MonitoringOutputs$member": null - } - }, - "MonitoringOutputConfig": { - "base": "

The output configuration for monitoring jobs.

", - "refs": { - "CreateDataQualityJobDefinitionRequest$DataQualityJobOutputConfig": null, - "CreateModelBiasJobDefinitionRequest$ModelBiasJobOutputConfig": null, - "CreateModelExplainabilityJobDefinitionRequest$ModelExplainabilityJobOutputConfig": null, - "CreateModelQualityJobDefinitionRequest$ModelQualityJobOutputConfig": null, - "DescribeDataQualityJobDefinitionResponse$DataQualityJobOutputConfig": null, - "DescribeModelBiasJobDefinitionResponse$ModelBiasJobOutputConfig": null, - "DescribeModelExplainabilityJobDefinitionResponse$ModelExplainabilityJobOutputConfig": null, - "DescribeModelQualityJobDefinitionResponse$ModelQualityJobOutputConfig": null, - "MonitoringJobDefinition$MonitoringOutputConfig": "

The array of outputs from the monitoring job to be uploaded to Amazon S3.

" - } - }, - "MonitoringOutputs": { - "base": null, - "refs": { - "MonitoringOutputConfig$MonitoringOutputs": "

Monitoring outputs for monitoring jobs. This is where the output of the periodic monitoring jobs is uploaded.

" - } - }, - "MonitoringParquetDatasetFormat": { - "base": "

Represents the Parquet dataset format used when running a monitoring job.

", - "refs": { - "MonitoringDatasetFormat$Parquet": "

The Parquet dataset used in the monitoring job

" - } - }, - "MonitoringProblemType": { - "base": null, - "refs": { - "ModelQualityAppSpecification$ProblemType": "

The machine learning problem type of the model that the monitoring job monitors.

" - } - }, - "MonitoringResources": { - "base": "

Identifies the resources to deploy for a monitoring job.

", - "refs": { - "CreateDataQualityJobDefinitionRequest$JobResources": null, - "CreateModelBiasJobDefinitionRequest$JobResources": null, - "CreateModelExplainabilityJobDefinitionRequest$JobResources": null, - "CreateModelQualityJobDefinitionRequest$JobResources": null, - "DescribeDataQualityJobDefinitionResponse$JobResources": null, - "DescribeModelBiasJobDefinitionResponse$JobResources": null, - "DescribeModelExplainabilityJobDefinitionResponse$JobResources": null, - "DescribeModelQualityJobDefinitionResponse$JobResources": null, - "MonitoringJobDefinition$MonitoringResources": "

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a monitoring job. In distributed processing, you specify more than one instance.

" - } - }, - "MonitoringS3Output": { - "base": "

Information about where and how you want to store the results of a monitoring job.

", - "refs": { - "MonitoringOutput$S3Output": "

The Amazon S3 storage location where the results of a monitoring job are saved.

" - } - }, - "MonitoringS3Uri": { - "base": null, - "refs": { - "MonitoringGroundTruthS3Input$S3Uri": "

The address of the Amazon S3 location of the ground truth labels.

", - "MonitoringS3Output$S3Uri": "

A URI that identifies the Amazon S3 storage location where Amazon SageMaker AI saves the results of a monitoring job.

" - } - }, - "MonitoringSchedule": { - "base": "

A schedule for a model monitoring job. For information about model monitor, see Amazon SageMaker Model Monitor.

", - "refs": { - "MonitoringScheduleList$member": null - } - }, - "MonitoringScheduleArn": { - "base": null, - "refs": { - "CreateMonitoringScheduleResponse$MonitoringScheduleArn": "

The Amazon Resource Name (ARN) of the monitoring schedule.

", - "DescribeMonitoringScheduleResponse$MonitoringScheduleArn": "

The Amazon Resource Name (ARN) of the monitoring schedule.

", - "DescribeProcessingJobResponse$MonitoringScheduleArn": "

The ARN of a monitoring schedule for an endpoint associated with this processing job.

", - "ModelDashboardMonitoringSchedule$MonitoringScheduleArn": "

The Amazon Resource Name (ARN) of a monitoring schedule.

", - "MonitoringSchedule$MonitoringScheduleArn": "

The Amazon Resource Name (ARN) of the monitoring schedule.

", - "MonitoringScheduleSummary$MonitoringScheduleArn": "

The Amazon Resource Name (ARN) of the monitoring schedule.

", - "ProcessingJob$MonitoringScheduleArn": "

The ARN of a monitoring schedule for an endpoint associated with this processing job.

", - "UpdateMonitoringAlertResponse$MonitoringScheduleArn": "

The Amazon Resource Name (ARN) of the monitoring schedule.

", - "UpdateMonitoringScheduleResponse$MonitoringScheduleArn": "

The Amazon Resource Name (ARN) of the monitoring schedule.

" - } - }, - "MonitoringScheduleConfig": { - "base": "

Configures the monitoring schedule and defines the monitoring job.

", - "refs": { - "CreateMonitoringScheduleRequest$MonitoringScheduleConfig": "

The configuration object that specifies the monitoring schedule and defines the monitoring job.

", - "DescribeMonitoringScheduleResponse$MonitoringScheduleConfig": "

The configuration object that specifies the monitoring schedule and defines the monitoring job.

", - "ModelDashboardMonitoringSchedule$MonitoringScheduleConfig": null, - "MonitoringSchedule$MonitoringScheduleConfig": null, - "UpdateMonitoringScheduleRequest$MonitoringScheduleConfig": "

The configuration object that specifies the monitoring schedule and defines the monitoring job.

" - } - }, - "MonitoringScheduleList": { - "base": null, - "refs": { - "Endpoint$MonitoringSchedules": "

A list of monitoring schedules for the endpoint. For information about model monitoring, see Amazon SageMaker Model Monitor.

" - } - }, - "MonitoringScheduleName": { - "base": null, - "refs": { - "CreateMonitoringScheduleRequest$MonitoringScheduleName": "

The name of the monitoring schedule. The name must be unique within an Amazon Web Services Region within an Amazon Web Services account.

", - "DeleteMonitoringScheduleRequest$MonitoringScheduleName": "

The name of the monitoring schedule to delete.

", - "DescribeMonitoringScheduleRequest$MonitoringScheduleName": "

Name of a previously created monitoring schedule.

", - "DescribeMonitoringScheduleResponse$MonitoringScheduleName": "

Name of the monitoring schedule.

", - "ListMonitoringAlertHistoryRequest$MonitoringScheduleName": "

The name of a monitoring schedule.

", - "ListMonitoringAlertsRequest$MonitoringScheduleName": "

The name of a monitoring schedule.

", - "ListMonitoringExecutionsRequest$MonitoringScheduleName": "

Name of a specific schedule to fetch jobs for.

", - "ModelDashboardMonitoringSchedule$MonitoringScheduleName": "

The name of a monitoring schedule.

", - "MonitoringAlertHistorySummary$MonitoringScheduleName": "

The name of a monitoring schedule.

", - "MonitoringExecutionSummary$MonitoringScheduleName": "

The name of the monitoring schedule.

", - "MonitoringSchedule$MonitoringScheduleName": "

The name of the monitoring schedule.

", - "MonitoringScheduleSummary$MonitoringScheduleName": "

The name of the monitoring schedule.

", - "StartMonitoringScheduleRequest$MonitoringScheduleName": "

The name of the schedule to start.

", - "StopMonitoringScheduleRequest$MonitoringScheduleName": "

The name of the schedule to stop.

", - "UpdateMonitoringAlertRequest$MonitoringScheduleName": "

The name of a monitoring schedule.

", - "UpdateMonitoringScheduleRequest$MonitoringScheduleName": "

The name of the monitoring schedule. The name must be unique within an Amazon Web Services Region within an Amazon Web Services account.

" - } - }, - "MonitoringScheduleSortKey": { - "base": null, - "refs": { - "ListMonitoringSchedulesRequest$SortBy": "

Whether to sort the results by the Status, CreationTime, or ScheduledTime field. The default is CreationTime.

" - } - }, - "MonitoringScheduleSummary": { - "base": "

Summarizes the monitoring schedule.

", - "refs": { - "MonitoringScheduleSummaryList$member": null - } - }, - "MonitoringScheduleSummaryList": { - "base": null, - "refs": { - "ListMonitoringSchedulesResponse$MonitoringScheduleSummaries": "

A JSON array in which each element is a summary for a monitoring schedule.

" - } - }, - "MonitoringStatisticsResource": { - "base": "

The statistics resource for a monitoring job.

", - "refs": { - "DataQualityBaselineConfig$StatisticsResource": null, - "MonitoringBaselineConfig$StatisticsResource": "

The baseline statistics file in Amazon S3 that the current monitoring job should be validated against.

" - } - }, - "MonitoringStoppingCondition": { - "base": "

A time limit for how long the monitoring job is allowed to run before stopping.

", - "refs": { - "CreateDataQualityJobDefinitionRequest$StoppingCondition": null, - "CreateModelBiasJobDefinitionRequest$StoppingCondition": null, - "CreateModelExplainabilityJobDefinitionRequest$StoppingCondition": null, - "CreateModelQualityJobDefinitionRequest$StoppingCondition": null, - "DescribeDataQualityJobDefinitionResponse$StoppingCondition": null, - "DescribeModelBiasJobDefinitionResponse$StoppingCondition": null, - "DescribeModelExplainabilityJobDefinitionResponse$StoppingCondition": null, - "DescribeModelQualityJobDefinitionResponse$StoppingCondition": null, - "MonitoringJobDefinition$StoppingCondition": "

Specifies a time limit for how long the monitoring job is allowed to run.

" - } - }, - "MonitoringTimeOffsetString": { - "base": null, - "refs": { - "BatchTransformInput$StartTimeOffset": "

If specified, monitoring jobs substract this time from the start time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.

", - "BatchTransformInput$EndTimeOffset": "

If specified, monitoring jobs subtract this time from the end time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.

", - "EndpointInput$StartTimeOffset": "

If specified, monitoring jobs substract this time from the start time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.

", - "EndpointInput$EndTimeOffset": "

If specified, monitoring jobs substract this time from the end time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.

" - } - }, - "MonitoringType": { - "base": null, - "refs": { - "DescribeMonitoringScheduleResponse$MonitoringType": "

The type of the monitoring job that this schedule runs. This is one of the following values.

  • DATA_QUALITY - The schedule is for a data quality monitoring job.

  • MODEL_QUALITY - The schedule is for a model quality monitoring job.

  • MODEL_BIAS - The schedule is for a bias monitoring job.

  • MODEL_EXPLAINABILITY - The schedule is for an explainability monitoring job.

", - "ListMonitoringExecutionsRequest$MonitoringTypeEquals": "

A filter that returns only the monitoring job runs of the specified monitoring type.

", - "ListMonitoringSchedulesRequest$MonitoringTypeEquals": "

A filter that returns only the monitoring schedules for the specified monitoring type.

", - "ModelDashboardMonitoringSchedule$MonitoringType": "

The monitor type of a model monitor.

", - "MonitoringExecutionSummary$MonitoringType": "

The type of the monitoring job.

", - "MonitoringSchedule$MonitoringType": "

The type of the monitoring job definition to schedule.

", - "MonitoringScheduleConfig$MonitoringType": "

The type of the monitoring job definition to schedule.

", - "MonitoringScheduleSummary$MonitoringType": "

The type of the monitoring job definition that the schedule is for.

" - } - }, - "MountPath": { - "base": null, - "refs": { - "FileSystemConfig$MountPath": "

The path within the image to mount the user's EFS home directory. The directory should be empty. If not specified, defaults to /home/sagemaker-user.

" - } - }, - "MultiModelConfig": { - "base": "

Specifies additional configuration for hosting multi-model endpoints.

", - "refs": { - "ContainerDefinition$MultiModelConfig": "

Specifies additional configuration for multi-model endpoints.

" - } - }, - "NameContains": { - "base": null, - "refs": { - "ListAIBenchmarkJobsRequest$NameContains": "

A string in the job name. This filter returns only jobs whose name contains the specified string.

", - "ListAIRecommendationJobsRequest$NameContains": "

A string in the job name. This filter returns only jobs whose name contains the specified string.

", - "ListAIWorkloadConfigsRequest$NameContains": "

A string in the configuration name. This filter returns only configurations whose name contains the specified string.

", - "ListAlgorithmsInput$NameContains": "

A string in the algorithm name. This filter returns only algorithms whose name contains the specified string.

", - "ListClustersRequest$NameContains": "

Set the maximum number of instances to print in the list.

", - "ListCompilationJobsRequest$NameContains": "

A filter that returns the model compilation jobs whose name contains a specified string.

", - "ListDataQualityJobDefinitionsRequest$NameContains": "

A string in the data quality monitoring job definition name. This filter returns only data quality monitoring job definitions whose name contains the specified string.

", - "ListDeviceFleetsRequest$NameContains": "

Filter for fleets containing this name in their fleet device name.

", - "ListEdgeDeploymentPlansRequest$NameContains": "

Selects edge deployment plans with names containing this name.

", - "ListEdgeDeploymentPlansRequest$DeviceFleetNameContains": "

Selects edge deployment plans with a device fleet name containing this name.

", - "ListEdgePackagingJobsRequest$NameContains": "

Filter for jobs containing this name in their packaging job name.

", - "ListEdgePackagingJobsRequest$ModelNameContains": "

Filter for jobs where the model name contains this string.

", - "ListHubContentsRequest$NameContains": "

Only list hub content if the name contains the specified string.

", - "ListHubsRequest$NameContains": "

Only list hubs with names that contain the specified string.

", - "ListHyperParameterTuningJobsRequest$NameContains": "

A string in the tuning job name. This filter returns only tuning jobs whose name contains the specified string.

", - "ListInferenceExperimentsRequest$NameContains": "

Selects inference experiments whose names contain this name.

", - "ListInferenceRecommendationsJobsRequest$NameContains": "

A string in the job name. This filter returns only recommendations whose name contains the specified string.

", - "ListJobsRequest$NameContains": "

A string in the job name to filter results. Only jobs whose name contains the specified string are returned.

", - "ListLabelingJobsRequest$NameContains": "

A string in the labeling job name. This filter returns only labeling jobs whose name contains the specified string.

", - "ListModelBiasJobDefinitionsRequest$NameContains": "

Filter for model bias jobs whose name contains a specified string.

", - "ListModelExplainabilityJobDefinitionsRequest$NameContains": "

Filter for model explainability jobs whose name contains a specified string.

", - "ListModelPackageGroupsInput$NameContains": "

A string in the model group name. This filter returns only model groups whose name contains the specified string.

", - "ListModelPackagesInput$NameContains": "

A string in the model package name. This filter returns only model packages whose name contains the specified string.

", - "ListModelQualityJobDefinitionsRequest$NameContains": "

A string in the transform job name. This filter returns only model quality monitoring job definitions whose name contains the specified string.

", - "ListMonitoringSchedulesRequest$NameContains": "

Filter for monitoring schedules whose name contains a specified string.

", - "ListOptimizationJobsRequest$OptimizationContains": "

Filters the results to only those optimization jobs that apply the specified optimization techniques. You can specify either Quantization or Compilation.

", - "ListOptimizationJobsRequest$NameContains": "

Filters the results to only those optimization jobs with a name that contains the specified string.

", - "ListTrainingJobsRequest$NameContains": "

A string in the training job name. This filter returns only training jobs whose name contains the specified string.

", - "ListTransformJobsRequest$NameContains": "

A string in the transform job name. This filter returns only transform jobs whose name contains the specified string.

" - } - }, - "NeoVpcConfig": { - "base": "

The VpcConfig configuration object that specifies the VPC that you want the compilation jobs to connect to. For more information on controlling access to your Amazon S3 buckets used for compilation job, see Give Amazon SageMaker AI Compilation Jobs Access to Resources in Your Amazon VPC.

", - "refs": { - "CreateCompilationJobRequest$VpcConfig": "

A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.

", - "DescribeCompilationJobResponse$VpcConfig": "

A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.

" - } - }, - "NeoVpcSecurityGroupId": { - "base": null, - "refs": { - "NeoVpcSecurityGroupIds$member": null - } - }, - "NeoVpcSecurityGroupIds": { - "base": null, - "refs": { - "NeoVpcConfig$SecurityGroupIds": "

The VPC security group IDs. IDs have the form of sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.

" - } - }, - "NeoVpcSubnetId": { - "base": null, - "refs": { - "NeoVpcSubnets$member": null - } - }, - "NeoVpcSubnets": { - "base": null, - "refs": { - "NeoVpcConfig$Subnets": "

The ID of the subnets in the VPC that you want to connect the compilation job to for accessing the model in Amazon S3.

" - } - }, - "NestedFilters": { - "base": "

A list of nested Filter objects. A resource must satisfy the conditions of all filters to be included in the results returned from the Search API.

For example, to filter on a training job's InputDataConfig property with a specific channel name and S3Uri prefix, define the following filters:

  • '{Name:\"InputDataConfig.ChannelName\", \"Operator\":\"Equals\", \"Value\":\"train\"}',

  • '{Name:\"InputDataConfig.DataSource.S3DataSource.S3Uri\", \"Operator\":\"Contains\", \"Value\":\"mybucket/catdata\"}'

", - "refs": { - "NestedFiltersList$member": null - } - }, - "NestedFiltersList": { - "base": null, - "refs": { - "SearchExpression$NestedFilters": "

A list of nested filter objects.

" - } - }, - "NetworkConfig": { - "base": "

Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.

", - "refs": { - "CreateProcessingJobRequest$NetworkConfig": "

Networking options for a processing job, such as whether to allow inbound and outbound network calls to and from processing containers, and the VPC subnets and security groups to use for VPC-enabled processing jobs.

", - "DescribeProcessingJobResponse$NetworkConfig": "

Networking options for a processing job.

", - "MonitoringJobDefinition$NetworkConfig": "

Specifies networking options for an monitoring job.

", - "ProcessingJob$NetworkConfig": null - } - }, - "NetworkInterfaceId": { - "base": null, - "refs": { - "DescribeNotebookInstanceOutput$NetworkInterfaceId": "

The network interface IDs that SageMaker AI created at the time of creating the instance.

" - } - }, - "NextToken": { - "base": null, - "refs": { - "CreateHubContentPresignedUrlsRequest$NextToken": "

A token for pagination. Use this token to retrieve the next set of presigned URLs when the response is truncated.

", - "CreateHubContentPresignedUrlsResponse$NextToken": "

A token for pagination. If present, indicates that more presigned URLs are available. Use this token in a subsequent request to retrieve additional URLs.

", - "DescribeDeviceRequest$NextToken": "

Next token of device description.

", - "DescribeDeviceResponse$NextToken": "

The response from the last list when returning a list large enough to need tokening.

", - "DescribeEdgeDeploymentPlanRequest$NextToken": "

If the edge deployment plan has enough stages to require tokening, then this is the response from the last list of stages returned.

", - "DescribeEdgeDeploymentPlanResponse$NextToken": "

Token to use when calling the next set of stages in the edge deployment plan.

", - "DescribeFeatureGroupRequest$NextToken": "

A token to resume pagination of the list of Features (FeatureDefinitions). 2,500 Features are returned by default.

", - "DescribeFeatureGroupResponse$NextToken": "

A token to resume pagination of the list of Features (FeatureDefinitions).

", - "DescribeTrainingPlanExtensionHistoryRequest$NextToken": "

A token to continue pagination if more results are available.

", - "DescribeTrainingPlanExtensionHistoryResponse$NextToken": "

A token to continue pagination if more results are available.

", - "ListAIBenchmarkJobsRequest$NextToken": "

If the previous call to ListAIBenchmarkJobs didn't return the full set of jobs, the call returns a token for getting the next set.

", - "ListAIBenchmarkJobsResponse$NextToken": "

If the response is truncated, Amazon SageMaker AI returns this token. To retrieve the next set of jobs, use it in the subsequent request.

", - "ListAIRecommendationJobsRequest$NextToken": "

If the previous call to ListAIRecommendationJobs didn't return the full set of jobs, the call returns a token for getting the next set.

", - "ListAIRecommendationJobsResponse$NextToken": "

If the response is truncated, Amazon SageMaker AI returns this token. To retrieve the next set of jobs, use it in the subsequent request.

", - "ListAIWorkloadConfigsRequest$NextToken": "

If the previous call to ListAIWorkloadConfigs didn't return the full set of configurations, the call returns a token for getting the next set of configurations.

", - "ListAIWorkloadConfigsResponse$NextToken": "

If the response is truncated, Amazon SageMaker AI returns this token. To retrieve the next set of configurations, use it in the subsequent request.

", - "ListActionsRequest$NextToken": "

If the previous call to ListActions didn't return the full set of actions, the call returns a token for getting the next set of actions.

", - "ListActionsResponse$NextToken": "

A token for getting the next set of actions, if there are any.

", - "ListAlgorithmsInput$NextToken": "

If the response to a previous ListAlgorithms request was truncated, the response includes a NextToken. To retrieve the next set of algorithms, use the token in the next request.

", - "ListAlgorithmsOutput$NextToken": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.

", - "ListAliasesRequest$NextToken": "

If the previous call to ListAliases didn't return the full set of aliases, the call returns a token for retrieving the next set of aliases.

", - "ListAliasesResponse$NextToken": "

A token for getting the next set of aliases, if more aliases exist.

", - "ListAppImageConfigsRequest$NextToken": "

If the previous call to ListImages didn't return the full set of AppImageConfigs, the call returns a token for getting the next set of AppImageConfigs.

", - "ListAppImageConfigsResponse$NextToken": "

A token for getting the next set of AppImageConfigs, if there are any.

", - "ListAppsRequest$NextToken": "

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

", - "ListAppsResponse$NextToken": "

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

", - "ListArtifactsRequest$NextToken": "

If the previous call to ListArtifacts didn't return the full set of artifacts, the call returns a token for getting the next set of artifacts.

", - "ListArtifactsResponse$NextToken": "

A token for getting the next set of artifacts, if there are any.

", - "ListAssociationsRequest$NextToken": "

If the previous call to ListAssociations didn't return the full set of associations, the call returns a token for getting the next set of associations.

", - "ListAssociationsResponse$NextToken": "

A token for getting the next set of associations, if there are any.

", - "ListAutoMLJobsRequest$NextToken": "

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

", - "ListAutoMLJobsResponse$NextToken": "

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

", - "ListCandidatesForAutoMLJobRequest$NextToken": "

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

", - "ListCandidatesForAutoMLJobResponse$NextToken": "

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

", - "ListClusterEventsRequest$NextToken": "

A token to retrieve the next set of results. This token is obtained from the output of a previous ListClusterEvents call.

", - "ListClusterEventsResponse$NextToken": "

A token to retrieve the next set of results. Include this token in subsequent ListClusterEvents calls to fetch more events.

", - "ListClusterNodesRequest$NextToken": "

If the result of the previous ListClusterNodes request was truncated, the response includes a NextToken. To retrieve the next set of cluster nodes, use the token in the next request.

", - "ListClusterNodesResponse$NextToken": "

The next token specified for listing instances in a SageMaker HyperPod cluster.

", - "ListClusterSchedulerConfigsRequest$NextToken": "

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

", - "ListClusterSchedulerConfigsResponse$NextToken": "

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

", - "ListClustersRequest$NextToken": "

Set the next token to retrieve the list of SageMaker HyperPod clusters.

", - "ListClustersResponse$NextToken": "

If the result of the previous ListClusters request was truncated, the response includes a NextToken. To retrieve the next set of clusters, use the token in the next request.

", - "ListCodeRepositoriesInput$NextToken": "

If the result of a ListCodeRepositoriesOutput request was truncated, the response includes a NextToken. To get the next set of Git repositories, use the token in the next request.

", - "ListCodeRepositoriesOutput$NextToken": "

If the result of a ListCodeRepositoriesOutput request was truncated, the response includes a NextToken. To get the next set of Git repositories, use the token in the next request.

", - "ListCompilationJobsRequest$NextToken": "

If the result of the previous ListCompilationJobs request was truncated, the response includes a NextToken. To retrieve the next set of model compilation jobs, use the token in the next request.

", - "ListCompilationJobsResponse$NextToken": "

If the response is truncated, Amazon SageMaker AI returns this NextToken. To retrieve the next set of model compilation jobs, use this token in the next request.

", - "ListComputeQuotasRequest$NextToken": "

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

", - "ListComputeQuotasResponse$NextToken": "

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

", - "ListContextsRequest$NextToken": "

If the previous call to ListContexts didn't return the full set of contexts, the call returns a token for getting the next set of contexts.

", - "ListContextsResponse$NextToken": "

A token for getting the next set of contexts, if there are any.

", - "ListDataQualityJobDefinitionsRequest$NextToken": "

If the result of the previous ListDataQualityJobDefinitions request was truncated, the response includes a NextToken. To retrieve the next set of transform jobs, use the token in the next request.>

", - "ListDataQualityJobDefinitionsResponse$NextToken": "

If the result of the previous ListDataQualityJobDefinitions request was truncated, the response includes a NextToken. To retrieve the next set of data quality monitoring job definitions, use the token in the next request.

", - "ListDeviceFleetsRequest$NextToken": "

The response from the last list when returning a list large enough to need tokening.

", - "ListDeviceFleetsResponse$NextToken": "

The response from the last list when returning a list large enough to need tokening.

", - "ListDevicesRequest$NextToken": "

The response from the last list when returning a list large enough to need tokening.

", - "ListDevicesResponse$NextToken": "

The response from the last list when returning a list large enough to need tokening.

", - "ListDomainsRequest$NextToken": "

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

", - "ListDomainsResponse$NextToken": "

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

", - "ListEdgeDeploymentPlansRequest$NextToken": "

The response from the last list when returning a list large enough to need tokening.

", - "ListEdgeDeploymentPlansResponse$NextToken": "

The token to use when calling the next page of results.

", - "ListEdgePackagingJobsRequest$NextToken": "

The response from the last list when returning a list large enough to need tokening.

", - "ListEdgePackagingJobsResponse$NextToken": "

Token to use when calling the next page of results.

", - "ListExperimentsRequest$NextToken": "

If the previous call to ListExperiments didn't return the full set of experiments, the call returns a token for getting the next set of experiments.

", - "ListExperimentsResponse$NextToken": "

A token for getting the next set of experiments, if there are any.

", - "ListFeatureGroupsRequest$NextToken": "

A token to resume pagination of ListFeatureGroups results.

", - "ListFeatureGroupsResponse$NextToken": "

A token to resume pagination of ListFeatureGroups results.

", - "ListFlowDefinitionsRequest$NextToken": "

A token to resume pagination.

", - "ListFlowDefinitionsResponse$NextToken": "

A token to resume pagination.

", - "ListHubContentVersionsRequest$NextToken": "

If the response to a previous ListHubContentVersions request was truncated, the response includes a NextToken. To retrieve the next set of hub content versions, use the token in the next request.

", - "ListHubContentVersionsResponse$NextToken": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content versions, use it in the subsequent request.

", - "ListHubContentsRequest$NextToken": "

If the response to a previous ListHubContents request was truncated, the response includes a NextToken. To retrieve the next set of hub content, use the token in the next request.

", - "ListHubContentsResponse$NextToken": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content, use it in the subsequent request.

", - "ListHubsRequest$NextToken": "

If the response to a previous ListHubs request was truncated, the response includes a NextToken. To retrieve the next set of hubs, use the token in the next request.

", - "ListHubsResponse$NextToken": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of hubs, use it in the subsequent request.

", - "ListHumanTaskUisRequest$NextToken": "

A token to resume pagination.

", - "ListHumanTaskUisResponse$NextToken": "

A token to resume pagination.

", - "ListHyperParameterTuningJobsRequest$NextToken": "

If the result of the previous ListHyperParameterTuningJobs request was truncated, the response includes a NextToken. To retrieve the next set of tuning jobs, use the token in the next request.

", - "ListHyperParameterTuningJobsResponse$NextToken": "

If the result of this ListHyperParameterTuningJobs request was truncated, the response includes a NextToken. To retrieve the next set of tuning jobs, use the token in the next request.

", - "ListImageVersionsRequest$NextToken": "

If the previous call to ListImageVersions didn't return the full set of versions, the call returns a token for getting the next set of versions.

", - "ListImageVersionsResponse$NextToken": "

A token for getting the next set of versions, if there are any.

", - "ListImagesRequest$NextToken": "

If the previous call to ListImages didn't return the full set of images, the call returns a token for getting the next set of images.

", - "ListImagesResponse$NextToken": "

A token for getting the next set of images, if there are any.

", - "ListInferenceExperimentsRequest$NextToken": "

The response from the last list when returning a list large enough to need tokening.

", - "ListInferenceExperimentsResponse$NextToken": "

The token to use when calling the next page of results.

", - "ListInferenceRecommendationsJobStepsRequest$NextToken": "

A token that you can specify to return more results from the list. Specify this field if you have a token that was returned from a previous request.

", - "ListInferenceRecommendationsJobStepsResponse$NextToken": "

A token that you can specify in your next request to return more results from the list.

", - "ListInferenceRecommendationsJobsRequest$NextToken": "

If the response to a previous ListInferenceRecommendationsJobsRequest request was truncated, the response includes a NextToken. To retrieve the next set of recommendations, use the token in the next request.

", - "ListInferenceRecommendationsJobsResponse$NextToken": "

A token for getting the next set of recommendations, if there are any.

", - "ListJobSchemaVersionsRequest$NextToken": "

If the previous response was truncated, this token retrieves the next set of results.

", - "ListJobSchemaVersionsResponse$NextToken": "

If the response is truncated, this token retrieves the next set of results.

", - "ListJobsRequest$NextToken": "

If the previous response was truncated, this token retrieves the next set of results.

", - "ListJobsResponse$NextToken": "

If the response is truncated, this token retrieves the next set of results.

", - "ListLabelingJobsForWorkteamRequest$NextToken": "

If the result of the previous ListLabelingJobsForWorkteam request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

", - "ListLabelingJobsForWorkteamResponse$NextToken": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.

", - "ListLabelingJobsRequest$NextToken": "

If the result of the previous ListLabelingJobs request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

", - "ListLabelingJobsResponse$NextToken": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.

", - "ListLineageGroupsRequest$NextToken": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.

", - "ListLineageGroupsResponse$NextToken": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.

", - "ListMlflowAppsRequest$NextToken": "

If the previous response was truncated, use this token in your next request to receive the next set of results.

", - "ListMlflowAppsResponse$NextToken": "

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

", - "ListMlflowTrackingServersRequest$NextToken": "

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

", - "ListMlflowTrackingServersResponse$NextToken": "

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

", - "ListModelBiasJobDefinitionsRequest$NextToken": "

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

", - "ListModelBiasJobDefinitionsResponse$NextToken": "

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

", - "ListModelCardExportJobsRequest$NextToken": "

If the response to a previous ListModelCardExportJobs request was truncated, the response includes a NextToken. To retrieve the next set of model card export jobs, use the token in the next request.

", - "ListModelCardExportJobsResponse$NextToken": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of model card export jobs, use it in the subsequent request.

", - "ListModelCardVersionsRequest$NextToken": "

If the response to a previous ListModelCardVersions request was truncated, the response includes a NextToken. To retrieve the next set of model card versions, use the token in the next request.

", - "ListModelCardVersionsResponse$NextToken": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of model card versions, use it in the subsequent request.

", - "ListModelCardsRequest$NextToken": "

If the response to a previous ListModelCards request was truncated, the response includes a NextToken. To retrieve the next set of model cards, use the token in the next request.

", - "ListModelCardsResponse$NextToken": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of model cards, use it in the subsequent request.

", - "ListModelExplainabilityJobDefinitionsRequest$NextToken": "

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

", - "ListModelExplainabilityJobDefinitionsResponse$NextToken": "

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

", - "ListModelMetadataRequest$NextToken": "

If the response to a previous ListModelMetadataResponse request was truncated, the response includes a NextToken. To retrieve the next set of model metadata, use the token in the next request.

", - "ListModelMetadataResponse$NextToken": "

A token for getting the next set of recommendations, if there are any.

", - "ListModelPackageGroupsInput$NextToken": "

If the result of the previous ListModelPackageGroups request was truncated, the response includes a NextToken. To retrieve the next set of model groups, use the token in the next request.

", - "ListModelPackageGroupsOutput$NextToken": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of model groups, use it in the subsequent request.

", - "ListModelPackagesInput$NextToken": "

If the response to a previous ListModelPackages request was truncated, the response includes a NextToken. To retrieve the next set of model packages, use the token in the next request.

", - "ListModelPackagesOutput$NextToken": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of model packages, use it in the subsequent request.

", - "ListModelQualityJobDefinitionsRequest$NextToken": "

If the result of the previous ListModelQualityJobDefinitions request was truncated, the response includes a NextToken. To retrieve the next set of model quality monitoring job definitions, use the token in the next request.

", - "ListModelQualityJobDefinitionsResponse$NextToken": "

If the response is truncated, Amazon SageMaker AI returns this token. To retrieve the next set of model quality monitoring job definitions, use it in the next request.

", - "ListMonitoringAlertHistoryRequest$NextToken": "

If the result of the previous ListMonitoringAlertHistory request was truncated, the response includes a NextToken. To retrieve the next set of alerts in the history, use the token in the next request.

", - "ListMonitoringAlertHistoryResponse$NextToken": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of alerts, use it in the subsequent request.

", - "ListMonitoringAlertsRequest$NextToken": "

If the result of the previous ListMonitoringAlerts request was truncated, the response includes a NextToken. To retrieve the next set of alerts in the history, use the token in the next request.

", - "ListMonitoringAlertsResponse$NextToken": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of alerts, use it in the subsequent request.

", - "ListMonitoringExecutionsRequest$NextToken": "

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

", - "ListMonitoringExecutionsResponse$NextToken": "

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

", - "ListMonitoringSchedulesRequest$NextToken": "

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

", - "ListMonitoringSchedulesResponse$NextToken": "

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

", - "ListNotebookInstanceLifecycleConfigsInput$NextToken": "

If the result of a ListNotebookInstanceLifecycleConfigs request was truncated, the response includes a NextToken. To get the next set of lifecycle configurations, use the token in the next request.

", - "ListNotebookInstanceLifecycleConfigsOutput$NextToken": "

If the response is truncated, SageMaker AI returns this token. To get the next set of lifecycle configurations, use it in the next request.

", - "ListNotebookInstancesInput$NextToken": "

If the previous call to the ListNotebookInstances is truncated, the response includes a NextToken. You can use this token in your subsequent ListNotebookInstances request to fetch the next set of notebook instances.

You might specify a filter or a sort order in your request. When response is truncated, you must use the same values for the filer and sort order in the next request.

", - "ListNotebookInstancesOutput$NextToken": "

If the response to the previous ListNotebookInstances request was truncated, SageMaker AI returns this token. To retrieve the next set of notebook instances, use the token in the next request.

", - "ListOptimizationJobsRequest$NextToken": "

A token that you use to get the next set of results following a truncated response. If the response to the previous request was truncated, that response provides the value for this token.

", - "ListOptimizationJobsResponse$NextToken": "

The token to use in a subsequent request to get the next set of results following a truncated response.

", - "ListPartnerAppsRequest$NextToken": "

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

", - "ListPartnerAppsResponse$NextToken": "

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

", - "ListPipelineExecutionStepsRequest$NextToken": "

If the result of the previous ListPipelineExecutionSteps request was truncated, the response includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the next request.

", - "ListPipelineExecutionStepsResponse$NextToken": "

If the result of the previous ListPipelineExecutionSteps request was truncated, the response includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the next request.

", - "ListPipelineExecutionsRequest$NextToken": "

If the result of the previous ListPipelineExecutions request was truncated, the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.

", - "ListPipelineExecutionsResponse$NextToken": "

If the result of the previous ListPipelineExecutions request was truncated, the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.

", - "ListPipelineParametersForExecutionRequest$NextToken": "

If the result of the previous ListPipelineParametersForExecution request was truncated, the response includes a NextToken. To retrieve the next set of parameters, use the token in the next request.

", - "ListPipelineParametersForExecutionResponse$NextToken": "

If the result of the previous ListPipelineParametersForExecution request was truncated, the response includes a NextToken. To retrieve the next set of parameters, use the token in the next request.

", - "ListPipelineVersionsRequest$NextToken": "

If the result of the previous ListPipelineVersions request was truncated, the response includes a NextToken. To retrieve the next set of pipeline versions, use this token in your next request.

", - "ListPipelineVersionsResponse$NextToken": "

If the result of the previous ListPipelineVersions request was truncated, the response includes a NextToken. To retrieve the next set of pipeline versions, use this token in your next request.

", - "ListPipelinesRequest$NextToken": "

If the result of the previous ListPipelines request was truncated, the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.

", - "ListPipelinesResponse$NextToken": "

If the result of the previous ListPipelines request was truncated, the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.

", - "ListProcessingJobsRequest$NextToken": "

If the result of the previous ListProcessingJobs request was truncated, the response includes a NextToken. To retrieve the next set of processing jobs, use the token in the next request.

", - "ListProcessingJobsResponse$NextToken": "

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of processing jobs, use it in the subsequent request.

", - "ListProjectsInput$NextToken": "

If the result of the previous ListProjects request was truncated, the response includes a NextToken. To retrieve the next set of projects, use the token in the next request.

", - "ListProjectsOutput$NextToken": "

If the result of the previous ListCompilationJobs request was truncated, the response includes a NextToken. To retrieve the next set of model compilation jobs, use the token in the next request.

", - "ListResourceCatalogsRequest$NextToken": "

A token to resume pagination of ListResourceCatalogs results.

", - "ListResourceCatalogsResponse$NextToken": "

A token to resume pagination of ListResourceCatalogs results.

", - "ListSpacesRequest$NextToken": "

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

", - "ListSpacesResponse$NextToken": "

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

", - "ListStageDevicesRequest$NextToken": "

The response from the last list when returning a list large enough to neeed tokening.

", - "ListStageDevicesResponse$NextToken": "

The token to use when calling the next page of results.

", - "ListStudioLifecycleConfigsRequest$NextToken": "

If the previous call to ListStudioLifecycleConfigs didn't return the full set of Lifecycle Configurations, the call returns a token for getting the next set of Lifecycle Configurations.

", - "ListStudioLifecycleConfigsResponse$NextToken": "

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

", - "ListSubscribedWorkteamsRequest$NextToken": "

If the result of the previous ListSubscribedWorkteams request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

", - "ListSubscribedWorkteamsResponse$NextToken": "

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request.

", - "ListTagsInput$NextToken": "

If the response to the previous ListTags request is truncated, SageMaker returns this token. To retrieve the next set of tags, use it in the subsequent request.

", - "ListTagsOutput$NextToken": "

If response is truncated, SageMaker includes a token in the response. You can use this token in your subsequent request to fetch next set of tokens.

", - "ListTrainingJobsForHyperParameterTuningJobRequest$NextToken": "

If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

", - "ListTrainingJobsForHyperParameterTuningJobResponse$NextToken": "

If the result of this ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

", - "ListTrainingJobsRequest$NextToken": "

If the result of the previous ListTrainingJobs request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

", - "ListTrainingJobsResponse$NextToken": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.

", - "ListTrainingPlansRequest$NextToken": "

A token to continue pagination if more results are available.

", - "ListTrainingPlansResponse$NextToken": "

A token to continue pagination if more results are available.

", - "ListTransformJobsRequest$NextToken": "

If the result of the previous ListTransformJobs request was truncated, the response includes a NextToken. To retrieve the next set of transform jobs, use the token in the next request.

", - "ListTransformJobsResponse$NextToken": "

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of transform jobs, use it in the next request.

", - "ListTrialComponentsRequest$NextToken": "

If the previous call to ListTrialComponents didn't return the full set of components, the call returns a token for getting the next set of components.

", - "ListTrialComponentsResponse$NextToken": "

A token for getting the next set of components, if there are any.

", - "ListTrialsRequest$NextToken": "

If the previous call to ListTrials didn't return the full set of trials, the call returns a token for getting the next set of trials.

", - "ListTrialsResponse$NextToken": "

A token for getting the next set of trials, if there are any.

", - "ListUltraServersByReservedCapacityRequest$NextToken": "

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

", - "ListUltraServersByReservedCapacityResponse$NextToken": "

If the response is truncated, SageMaker returns this token. Use it in the next request to retrieve the next set of UltraServers.

", - "ListUserProfilesRequest$NextToken": "

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

", - "ListUserProfilesResponse$NextToken": "

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

", - "ListWorkforcesRequest$NextToken": "

A token to resume pagination.

", - "ListWorkforcesResponse$NextToken": "

A token to resume pagination.

", - "ListWorkteamsRequest$NextToken": "

If the result of the previous ListWorkteams request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

", - "ListWorkteamsResponse$NextToken": "

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request.

", - "SearchRequest$NextToken": "

If more than MaxResults resources match the specified SearchExpression, the response includes a NextToken. The NextToken can be passed to the next SearchRequest to continue retrieving results.

", - "SearchResponse$NextToken": "

If the result of the previous Search request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request.

" - } - }, - "NodeAdditionResult": { - "base": "

Information about a node that was successfully added to the cluster.

", - "refs": { - "NodeAdditionResultList$member": null - } - }, - "NodeAdditionResultList": { - "base": null, - "refs": { - "BatchAddClusterNodesResponse$Successful": "

A list of NodeLogicalIDs that were successfully added to the cluster. The NodeLogicalID is unique per cluster and does not change between instance replacements. Each entry includes a NodeLogicalId that can be used to track the node's provisioning status (with DescribeClusterNode), the instance group name, and the current status of the node.

" - } - }, - "NodeUnavailabilityType": { - "base": null, - "refs": { - "CapacitySizeConfig$Type": "

Specifies whether SageMaker should process the update by amount or percentage of instances.

" - } - }, - "NodeUnavailabilityValue": { - "base": null, - "refs": { - "CapacitySizeConfig$Value": "

Specifies the amount or percentage of instances SageMaker updates at a time.

" - } - }, - "NonEmptyString256": { - "base": null, - "refs": { - "CustomImageContainerEntrypoint$member": null, - "CustomImageContainerEnvironmentVariables$key": null, - "ErrorInfo$Reason": "

The failure reason for the operation.

", - "OptimizationJobEnvironmentVariables$key": null, - "PartnerAppAdminUserList$member": null, - "PartnerAppArguments$key": null, - "RoleGroupAssignment$RoleName": "

The name of the in-app role within the SageMaker Partner AI App. The specific roles available depend on the app type and version.

", - "UltraServer$UltraServerId": "

The unique identifier for the UltraServer.

" - } - }, - "NonEmptyString64": { - "base": null, - "refs": { - "CreatePartnerAppRequest$Tier": "

Indicates the instance type and size of the cluster attached to the SageMaker Partner AI App.

", - "CreateSpaceRequest$SpaceDisplayName": "

The name of the space that appears in the SageMaker Studio UI.

", - "CustomImageContainerArguments$member": null, - "DescribePartnerAppResponse$Tier": "

The instance type and size of the cluster attached to the SageMaker Partner AI App.

", - "DescribePartnerAppResponse$Version": "

The version of the SageMaker Partner AI App.

", - "DescribeSpaceResponse$SpaceDisplayName": "

The name of the space that appears in the Amazon SageMaker Studio UI.

", - "ErrorInfo$Code": "

The error code for an invalid or failed operation.

", - "SpaceDetails$SpaceDisplayName": "

The name of the space that appears in the Studio UI.

", - "UpdatePartnerAppRequest$Tier": "

Indicates the instance type and size of the cluster attached to the SageMaker Partner AI App.

", - "UpdateSpaceRequest$SpaceDisplayName": "

The name of the space that appears in the Amazon SageMaker Studio UI.

" - } - }, - "NotebookInstanceAcceleratorType": { - "base": null, - "refs": { - "NotebookInstanceAcceleratorTypes$member": null - } - }, - "NotebookInstanceAcceleratorTypes": { - "base": null, - "refs": { - "CreateNotebookInstanceInput$AcceleratorTypes": "

This parameter is no longer supported. Elastic Inference (EI) is no longer available.

This parameter was used to specify a list of EI instance types to associate with this notebook instance.

", - "DescribeNotebookInstanceOutput$AcceleratorTypes": "

This parameter is no longer supported. Elastic Inference (EI) is no longer available.

This parameter was used to specify a list of the EI instance types associated with this notebook instance.

", - "UpdateNotebookInstanceInput$AcceleratorTypes": "

This parameter is no longer supported. Elastic Inference (EI) is no longer available.

This parameter was used to specify a list of the EI instance types to associate with this notebook instance.

" - } - }, - "NotebookInstanceArn": { - "base": null, - "refs": { - "CreateNotebookInstanceOutput$NotebookInstanceArn": "

The Amazon Resource Name (ARN) of the notebook instance.

", - "DescribeNotebookInstanceOutput$NotebookInstanceArn": "

The Amazon Resource Name (ARN) of the notebook instance.

", - "NotebookInstanceSummary$NotebookInstanceArn": "

The Amazon Resource Name (ARN) of the notebook instance.

" - } - }, - "NotebookInstanceLifecycleConfigArn": { - "base": null, - "refs": { - "CreateNotebookInstanceLifecycleConfigOutput$NotebookInstanceLifecycleConfigArn": "

The Amazon Resource Name (ARN) of the lifecycle configuration.

", - "DescribeNotebookInstanceLifecycleConfigOutput$NotebookInstanceLifecycleConfigArn": "

The Amazon Resource Name (ARN) of the lifecycle configuration.

", - "NotebookInstanceLifecycleConfigSummary$NotebookInstanceLifecycleConfigArn": "

The Amazon Resource Name (ARN) of the lifecycle configuration.

" - } - }, - "NotebookInstanceLifecycleConfigContent": { - "base": null, - "refs": { - "NotebookInstanceLifecycleHook$Content": "

A base64-encoded string that contains a shell script for a notebook instance lifecycle configuration.

" - } - }, - "NotebookInstanceLifecycleConfigList": { - "base": null, - "refs": { - "CreateNotebookInstanceLifecycleConfigInput$OnCreate": "

A shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.

", - "CreateNotebookInstanceLifecycleConfigInput$OnStart": "

A shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string.

", - "DescribeNotebookInstanceLifecycleConfigOutput$OnCreate": "

The shell script that runs only once, when you create a notebook instance.

", - "DescribeNotebookInstanceLifecycleConfigOutput$OnStart": "

The shell script that runs every time you start a notebook instance, including when you create the notebook instance.

", - "UpdateNotebookInstanceLifecycleConfigInput$OnCreate": "

The shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.

", - "UpdateNotebookInstanceLifecycleConfigInput$OnStart": "

The shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string.

" - } - }, - "NotebookInstanceLifecycleConfigName": { - "base": null, - "refs": { - "CreateNotebookInstanceInput$LifecycleConfigName": "

The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

", - "CreateNotebookInstanceLifecycleConfigInput$NotebookInstanceLifecycleConfigName": "

The name of the lifecycle configuration.

", - "DeleteNotebookInstanceLifecycleConfigInput$NotebookInstanceLifecycleConfigName": "

The name of the lifecycle configuration to delete.

", - "DescribeNotebookInstanceLifecycleConfigInput$NotebookInstanceLifecycleConfigName": "

The name of the lifecycle configuration to describe.

", - "DescribeNotebookInstanceLifecycleConfigOutput$NotebookInstanceLifecycleConfigName": "

The name of the lifecycle configuration.

", - "DescribeNotebookInstanceOutput$NotebookInstanceLifecycleConfigName": "

Returns the name of a notebook instance lifecycle configuration.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance

", - "ListNotebookInstancesInput$NotebookInstanceLifecycleConfigNameContains": "

A string in the name of a notebook instances lifecycle configuration associated with this notebook instance. This filter returns only notebook instances associated with a lifecycle configuration with a name that contains the specified string.

", - "NotebookInstanceLifecycleConfigSummary$NotebookInstanceLifecycleConfigName": "

The name of the lifecycle configuration.

", - "NotebookInstanceSummary$NotebookInstanceLifecycleConfigName": "

The name of a notebook instance lifecycle configuration associated with this notebook instance.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

", - "UpdateNotebookInstanceInput$LifecycleConfigName": "

The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

", - "UpdateNotebookInstanceLifecycleConfigInput$NotebookInstanceLifecycleConfigName": "

The name of the lifecycle configuration.

" - } - }, - "NotebookInstanceLifecycleConfigNameContains": { - "base": null, - "refs": { - "ListNotebookInstanceLifecycleConfigsInput$NameContains": "

A string in the lifecycle configuration name. This filter returns only lifecycle configurations whose name contains the specified string.

" - } - }, - "NotebookInstanceLifecycleConfigSortKey": { - "base": null, - "refs": { - "ListNotebookInstanceLifecycleConfigsInput$SortBy": "

Sorts the list of results. The default is CreationTime.

" - } - }, - "NotebookInstanceLifecycleConfigSortOrder": { - "base": null, - "refs": { - "ListNotebookInstanceLifecycleConfigsInput$SortOrder": "

The sort order for results.

" - } - }, - "NotebookInstanceLifecycleConfigSummary": { - "base": "

Provides a summary of a notebook instance lifecycle configuration.

", - "refs": { - "NotebookInstanceLifecycleConfigSummaryList$member": null - } - }, - "NotebookInstanceLifecycleConfigSummaryList": { - "base": null, - "refs": { - "ListNotebookInstanceLifecycleConfigsOutput$NotebookInstanceLifecycleConfigs": "

An array of NotebookInstanceLifecycleConfiguration objects, each listing a lifecycle configuration.

" - } - }, - "NotebookInstanceLifecycleHook": { - "base": "

Contains the notebook instance lifecycle configuration script.

Each lifecycle configuration script has a limit of 16384 characters.

The value of the $PATH environment variable that is available to both scripts is /sbin:bin:/usr/sbin:/usr/bin.

View Amazon CloudWatch Logs for notebook instance lifecycle configurations in log group /aws/sagemaker/NotebookInstances in log stream [notebook-instance-name]/[LifecycleConfigHook].

Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 minutes, it fails and the notebook instance is not created or started.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

", - "refs": { - "NotebookInstanceLifecycleConfigList$member": null - } - }, - "NotebookInstanceName": { - "base": null, - "refs": { - "CreateNotebookInstanceInput$NotebookInstanceName": "

The name of the new notebook instance.

", - "CreatePresignedNotebookInstanceUrlInput$NotebookInstanceName": "

The name of the notebook instance.

", - "DeleteNotebookInstanceInput$NotebookInstanceName": "

The name of the SageMaker AI notebook instance to delete.

", - "DescribeNotebookInstanceInput$NotebookInstanceName": "

The name of the notebook instance that you want information about.

", - "DescribeNotebookInstanceOutput$NotebookInstanceName": "

The name of the SageMaker AI notebook instance.

", - "NotebookInstanceSummary$NotebookInstanceName": "

The name of the notebook instance that you want a summary for.

", - "StartNotebookInstanceInput$NotebookInstanceName": "

The name of the notebook instance to start.

", - "StopNotebookInstanceInput$NotebookInstanceName": "

The name of the notebook instance to terminate.

", - "UpdateNotebookInstanceInput$NotebookInstanceName": "

The name of the notebook instance to update.

" - } - }, - "NotebookInstanceNameContains": { - "base": null, - "refs": { - "ListNotebookInstancesInput$NameContains": "

A string in the notebook instances' name. This filter returns only notebook instances whose name contains the specified string.

" - } - }, - "NotebookInstanceSortKey": { - "base": null, - "refs": { - "ListNotebookInstancesInput$SortBy": "

The field to sort results by. The default is Name.

" - } - }, - "NotebookInstanceSortOrder": { - "base": null, - "refs": { - "ListNotebookInstancesInput$SortOrder": "

The sort order for results.

" - } - }, - "NotebookInstanceStatus": { - "base": null, - "refs": { - "DescribeNotebookInstanceOutput$NotebookInstanceStatus": "

The status of the notebook instance.

", - "ListNotebookInstancesInput$StatusEquals": "

A filter that returns only notebook instances with the specified status.

", - "NotebookInstanceSummary$NotebookInstanceStatus": "

The status of the notebook instance.

" - } - }, - "NotebookInstanceSummary": { - "base": "

Provides summary information for an SageMaker AI notebook instance.

", - "refs": { - "NotebookInstanceSummaryList$member": null - } - }, - "NotebookInstanceSummaryList": { - "base": null, - "refs": { - "ListNotebookInstancesOutput$NotebookInstances": "

An array of NotebookInstanceSummary objects, one for each notebook instance.

" - } - }, - "NotebookInstanceUrl": { - "base": null, - "refs": { - "CreatePresignedNotebookInstanceUrlOutput$AuthorizedUrl": "

A JSON object that contains the URL string.

", - "DescribeNotebookInstanceOutput$Url": "

The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.

", - "NotebookInstanceSummary$Url": "

The URL that you use to connect to the Jupyter notebook running in your notebook instance.

" - } - }, - "NotebookInstanceVolumeSizeInGB": { - "base": null, - "refs": { - "CreateNotebookInstanceInput$VolumeSizeInGB": "

The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB.

", - "DescribeNotebookInstanceOutput$VolumeSizeInGB": "

The size, in GB, of the ML storage volume attached to the notebook instance.

", - "UpdateNotebookInstanceInput$VolumeSizeInGB": "

The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB. ML storage volumes are encrypted, so SageMaker AI can't determine the amount of available free space on the volume. Because of this, you can increase the volume size when you update a notebook instance, but you can't decrease the volume size. If you want to decrease the size of the ML storage volume in use, create a new notebook instance with the desired size.

" - } - }, - "NotebookOutputOption": { - "base": null, - "refs": { - "SharingSettings$NotebookOutputOption": "

Whether to include the notebook cell output when sharing the notebook. The default is Disabled.

" - } - }, - "NotificationConfiguration": { - "base": "

Configures Amazon SNS notifications of available or expiring work items for work teams.

", - "refs": { - "CreateWorkteamRequest$NotificationConfiguration": "

Configures notification of workers regarding available or expiring work items.

", - "UpdateWorkteamRequest$NotificationConfiguration": "

Configures SNS topic notifications for available or expiring work items

", - "Workteam$NotificationConfiguration": "

Configures SNS notifications of available or expiring work items for work teams.

" - } - }, - "NotificationTopicArn": { - "base": null, - "refs": { - "NotificationConfiguration$NotificationTopicArn": "

The ARN for the Amazon SNS topic to which notifications should be published.

" - } - }, - "NumberOfAcceleratorDevices": { - "base": null, - "refs": { - "InferenceComponentComputeResourceRequirements$NumberOfAcceleratorDevicesRequired": "

The number of accelerators to allocate to run a model that you assign to an inference component. Accelerators include GPUs and Amazon Web Services Inferentia.

" - } - }, - "NumberOfCpuCores": { - "base": null, - "refs": { - "InferenceComponentComputeResourceRequirements$NumberOfCpuCoresRequired": "

The number of CPU cores to allocate to run a model that you assign to an inference component.

" - } - }, - "NumberOfHumanWorkersPerDataObject": { - "base": null, - "refs": { - "HumanTaskConfig$NumberOfHumanWorkersPerDataObject": "

The number of human workers that will label an object.

", - "LabelingJobForWorkteamSummary$NumberOfHumanWorkersPerDataObject": "

The configured number of workers per data object.

" - } - }, - "NumberOfSteps": { - "base": null, - "refs": { - "Stairs$NumberOfSteps": "

Specifies how many steps to perform during traffic.

" - } - }, - "ObjectiveStatus": { - "base": null, - "refs": { - "AutoMLCandidate$ObjectiveStatus": "

The objective's status.

", - "HyperParameterTrainingJobSummary$ObjectiveStatus": "

The status of the objective metric for the training job:

  • Succeeded: The final objective metric for the training job was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.

  • Pending: The training job is in progress and evaluation of its final objective metric is pending.

  • Failed: The final objective metric for the training job was not evaluated, and was not used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.

" - } - }, - "ObjectiveStatusCounter": { - "base": null, - "refs": { - "ObjectiveStatusCounters$Succeeded": "

The number of training jobs whose final objective metric was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.

", - "ObjectiveStatusCounters$Pending": "

The number of training jobs that are in progress and pending evaluation of their final objective metric.

", - "ObjectiveStatusCounters$Failed": "

The number of training jobs whose final objective metric was not evaluated and used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.

" - } - }, - "ObjectiveStatusCounters": { - "base": "

Specifies the number of training jobs that this hyperparameter tuning job launched, categorized by the status of their objective metric. The objective metric status shows whether the final objective metric for the training job has been evaluated by the tuning job and used in the hyperparameter tuning process.

", - "refs": { - "DescribeHyperParameterTuningJobResponse$ObjectiveStatusCounters": "

The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.

", - "HyperParameterTuningJobSearchEntity$ObjectiveStatusCounters": null, - "HyperParameterTuningJobSummary$ObjectiveStatusCounters": "

The ObjectiveStatusCounters object that specifies the numbers of training jobs, categorized by objective metric status, that this tuning job launched.

" - } - }, - "OfflineStoreConfig": { - "base": "

The configuration of an OfflineStore.

Provide an OfflineStoreConfig in a request to CreateFeatureGroup to create an OfflineStore.

To encrypt an OfflineStore using at rest data encryption, specify Amazon Web Services Key Management Service (KMS) key ID, or KMSKeyId, in S3StorageConfig.

", - "refs": { - "CreateFeatureGroupRequest$OfflineStoreConfig": "

Use this to configure an OfflineFeatureStore. This parameter allows you to specify:

  • The Amazon Simple Storage Service (Amazon S3) location of an OfflineStore.

  • A configuration for an Amazon Web Services Glue or Amazon Web Services Hive data catalog.

  • An KMS encryption key to encrypt the Amazon S3 location used for OfflineStore. If KMS encryption key is not specified, by default we encrypt all data at rest using Amazon Web Services KMS key. By defining your bucket-level key for SSE, you can reduce Amazon Web Services KMS requests costs by up to 99 percent.

  • Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.

To learn more about this parameter, see OfflineStoreConfig.

", - "DescribeFeatureGroupResponse$OfflineStoreConfig": "

The configuration of the offline store. It includes the following configurations:

  • Amazon S3 location of the offline store.

  • Configuration of the Glue data catalog.

  • Table format of the offline store.

  • Option to disable the automatic creation of a Glue table for the offline store.

  • Encryption configuration.

", - "FeatureGroup$OfflineStoreConfig": null - } - }, - "OfflineStoreStatus": { - "base": "

The status of OfflineStore.

", - "refs": { - "DescribeFeatureGroupResponse$OfflineStoreStatus": "

The status of the OfflineStore. Notifies you if replicating data into the OfflineStore has failed. Returns either: Active or Blocked

", - "FeatureGroup$OfflineStoreStatus": null, - "FeatureGroupSummary$OfflineStoreStatus": "

Notifies you if replicating data into the OfflineStore has failed. Returns either: Active or Blocked.

" - } - }, - "OfflineStoreStatusValue": { - "base": null, - "refs": { - "ListFeatureGroupsRequest$OfflineStoreStatusEquals": "

An OfflineStore status. Filters by OfflineStore status.

", - "OfflineStoreStatus$Status": "

An OfflineStore status.

" - } - }, - "OidcConfig": { - "base": "

Use this parameter to configure your OIDC Identity Provider (IdP).

", - "refs": { - "CreateWorkforceRequest$OidcConfig": "

Use this parameter to configure a private workforce using your own OIDC Identity Provider.

Do not use CognitoConfig if you specify values for OidcConfig.

", - "UpdateWorkforceRequest$OidcConfig": "

Use this parameter to update your OIDC Identity Provider (IdP) configuration for a workforce made using your own IdP.

" - } - }, - "OidcConfigForResponse": { - "base": "

Your OIDC IdP workforce configuration.

", - "refs": { - "Workforce$OidcConfig": "

The configuration of an OIDC Identity Provider (IdP) private workforce.

" - } - }, - "OidcEndpoint": { - "base": null, - "refs": { - "OidcConfig$Issuer": "

The OIDC IdP issuer used to configure your private workforce.

", - "OidcConfig$AuthorizationEndpoint": "

The OIDC IdP authorization endpoint used to configure your private workforce.

", - "OidcConfig$TokenEndpoint": "

The OIDC IdP token endpoint used to configure your private workforce.

", - "OidcConfig$UserInfoEndpoint": "

The OIDC IdP user information endpoint used to configure your private workforce.

", - "OidcConfig$LogoutEndpoint": "

The OIDC IdP logout endpoint used to configure your private workforce.

", - "OidcConfig$JwksUri": "

The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.

", - "OidcConfigForResponse$Issuer": "

The OIDC IdP issuer used to configure your private workforce.

", - "OidcConfigForResponse$AuthorizationEndpoint": "

The OIDC IdP authorization endpoint used to configure your private workforce.

", - "OidcConfigForResponse$TokenEndpoint": "

The OIDC IdP token endpoint used to configure your private workforce.

", - "OidcConfigForResponse$UserInfoEndpoint": "

The OIDC IdP user information endpoint used to configure your private workforce.

", - "OidcConfigForResponse$LogoutEndpoint": "

The OIDC IdP logout endpoint used to configure your private workforce.

", - "OidcConfigForResponse$JwksUri": "

The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.

" - } - }, - "OidcMemberDefinition": { - "base": "

A list of user groups that exist in your OIDC Identity Provider (IdP). One to ten groups can be used to create a single private work team. When you add a user group to the list of Groups, you can add that user group to one or more private work teams. If you add a user group to a private work team, all workers in that user group are added to the work team.

", - "refs": { - "MemberDefinition$OidcMemberDefinition": "

A list user groups that exist in your OIDC Identity Provider (IdP). One to ten groups can be used to create a single private work team. When you add a user group to the list of Groups, you can add that user group to one or more private work teams. If you add a user group to a private work team, all workers in that user group are added to the work team.

" - } - }, - "OnStartDeepHealthChecks": { - "base": null, - "refs": { - "ClusterInstanceGroupDetails$OnStartDeepHealthChecks": "

A flag indicating whether deep health checks should be performed when the cluster instance group is created or updated.

", - "ClusterInstanceGroupSpecification$OnStartDeepHealthChecks": "

A flag indicating whether deep health checks should be performed when the cluster instance group is created or updated.

", - "ClusterRestrictedInstanceGroupDetails$OnStartDeepHealthChecks": "

A flag indicating whether deep health checks should be performed when the cluster's restricted instance group is created or updated.

", - "ClusterRestrictedInstanceGroupSpecification$OnStartDeepHealthChecks": "

A flag indicating whether deep health checks should be performed when the cluster restricted instance group is created or updated.

" - } - }, - "OnlineStoreConfig": { - "base": "

Use this to specify the Amazon Web Services Key Management Service (KMS) Key ID, or KMSKeyId, for at rest data encryption. You can turn OnlineStore on or off by specifying the EnableOnlineStore flag at General Assembly.

The default value is False.

", - "refs": { - "CreateFeatureGroupRequest$OnlineStoreConfig": "

You can turn the OnlineStore on or off by specifying True for the EnableOnlineStore flag in OnlineStoreConfig.

You can also include an Amazon Web Services KMS key ID (KMSKeyId) for at-rest encryption of the OnlineStore.

The default value is False.

", - "DescribeFeatureGroupResponse$OnlineStoreConfig": "

The configuration for the OnlineStore.

", - "FeatureGroup$OnlineStoreConfig": null - } - }, - "OnlineStoreConfigUpdate": { - "base": "

Updates the feature group online store configuration.

", - "refs": { - "UpdateFeatureGroupRequest$OnlineStoreConfig": "

Updates the feature group online store configuration.

" - } - }, - "OnlineStoreSecurityConfig": { - "base": "

The security configuration for OnlineStore.

", - "refs": { - "OnlineStoreConfig$SecurityConfig": "

Use to specify KMS Key ID (KMSKeyId) for at-rest encryption of your OnlineStore.

" - } - }, - "OnlineStoreTotalSizeBytes": { - "base": null, - "refs": { - "DescribeFeatureGroupResponse$OnlineStoreTotalSizeBytes": "

The size of the OnlineStore in bytes.

" - } - }, - "Operator": { - "base": null, - "refs": { - "Filter$Operator": "

A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:

Equals

The value of Name equals Value.

NotEquals

The value of Name doesn't equal Value.

Exists

The Name property exists.

NotExists

The Name property does not exist.

GreaterThan

The value of Name is greater than Value. Not supported for text properties.

GreaterThanOrEqualTo

The value of Name is greater than or equal to Value. Not supported for text properties.

LessThan

The value of Name is less than Value. Not supported for text properties.

LessThanOrEqualTo

The value of Name is less than or equal to Value. Not supported for text properties.

In

The value of Name is one of the comma delimited strings in Value. Only supported for text properties.

Contains

The value of Name contains the string Value. Only supported for text properties.

A SearchExpression can include the Contains operator multiple times when the value of Name is one of the following:

  • Experiment.DisplayName

  • Experiment.ExperimentName

  • Experiment.Tags

  • Trial.DisplayName

  • Trial.TrialName

  • Trial.Tags

  • TrialComponent.DisplayName

  • TrialComponent.TrialComponentName

  • TrialComponent.Tags

  • TrialComponent.InputArtifacts

  • TrialComponent.OutputArtifacts

A SearchExpression can include only one Contains operator for all other values of Name. In these cases, if you include multiple Contains operators in the SearchExpression, the result is the following error message: \"'CONTAINS' operator usage limit of 1 exceeded.\"

" - } - }, - "OptimizationConfig": { - "base": "

Settings for an optimization technique that you apply with a model optimization job.

", - "refs": { - "OptimizationConfigs$member": null - } - }, - "OptimizationConfigs": { - "base": null, - "refs": { - "CreateOptimizationJobRequest$OptimizationConfigs": "

Settings for each of the optimization techniques that the job applies.

", - "DescribeOptimizationJobResponse$OptimizationConfigs": "

Settings for each of the optimization techniques that the job applies.

" - } - }, - "OptimizationContainerImage": { - "base": null, - "refs": { - "ModelCompilationConfig$Image": "

The URI of an LMI DLC in Amazon ECR. SageMaker uses this image to run the optimization.

", - "ModelQuantizationConfig$Image": "

The URI of an LMI DLC in Amazon ECR. SageMaker uses this image to run the optimization.

", - "ModelShardingConfig$Image": "

The URI of an LMI DLC in Amazon ECR. SageMaker uses this image to run the optimization.

", - "OptimizationOutput$RecommendedInferenceImage": "

The image that SageMaker recommends that you use to host the optimized model that you created with an optimization job.

" - } - }, - "OptimizationJobArn": { - "base": null, - "refs": { - "CreateOptimizationJobResponse$OptimizationJobArn": "

The Amazon Resource Name (ARN) of the optimization job.

", - "DescribeOptimizationJobResponse$OptimizationJobArn": "

The Amazon Resource Name (ARN) of the optimization job.

", - "OptimizationJobSummary$OptimizationJobArn": "

The Amazon Resource Name (ARN) of the optimization job.

" - } - }, - "OptimizationJobDeploymentInstanceType": { - "base": null, - "refs": { - "CreateOptimizationJobRequest$DeploymentInstanceType": "

The type of instance that hosts the optimized model that you create with the optimization job.

", - "DescribeOptimizationJobResponse$DeploymentInstanceType": "

The type of instance that hosts the optimized model that you create with the optimization job.

", - "OptimizationJobSummary$DeploymentInstanceType": "

The type of instance that hosts the optimized model that you create with the optimization job.

" - } - }, - "OptimizationJobEnvironmentVariables": { - "base": null, - "refs": { - "CreateOptimizationJobRequest$OptimizationEnvironment": "

The environment variables to set in the model container.

", - "DescribeOptimizationJobResponse$OptimizationEnvironment": "

The environment variables to set in the model container.

", - "ModelCompilationConfig$OverrideEnvironment": "

Environment variables that override the default ones in the model container.

", - "ModelQuantizationConfig$OverrideEnvironment": "

Environment variables that override the default ones in the model container.

", - "ModelShardingConfig$OverrideEnvironment": "

Environment variables that override the default ones in the model container.

" - } - }, - "OptimizationJobMaxInstanceCount": { - "base": null, - "refs": { - "CreateOptimizationJobRequest$MaxInstanceCount": "

The maximum number of instances to use for the optimization job.

", - "DescribeOptimizationJobResponse$MaxInstanceCount": "

The maximum number of instances to use for the optimization job.

", - "OptimizationJobSummary$MaxInstanceCount": "

The maximum number of instances to use for the optimization job.

" - } - }, - "OptimizationJobModelSource": { - "base": "

The location of the source model to optimize with an optimization job.

", - "refs": { - "CreateOptimizationJobRequest$ModelSource": "

The location of the source model to optimize with an optimization job.

", - "DescribeOptimizationJobResponse$ModelSource": "

The location of the source model to optimize with an optimization job.

" - } - }, - "OptimizationJobModelSourceS3": { - "base": "

The Amazon S3 location of a source model to optimize with an optimization job.

", - "refs": { - "OptimizationJobModelSource$S3": "

The Amazon S3 location of a source model to optimize with an optimization job.

" - } - }, - "OptimizationJobOutputConfig": { - "base": "

Details for where to store the optimized model that you create with the optimization job.

", - "refs": { - "CreateOptimizationJobRequest$OutputConfig": "

Details for where to store the optimized model that you create with the optimization job.

", - "DescribeOptimizationJobResponse$OutputConfig": "

Details for where to store the optimized model that you create with the optimization job.

" - } - }, - "OptimizationJobStatus": { - "base": null, - "refs": { - "DescribeOptimizationJobResponse$OptimizationJobStatus": "

The current status of the optimization job.

", - "ListOptimizationJobsRequest$StatusEquals": "

Filters the results to only those optimization jobs with the specified status.

", - "OptimizationJobSummary$OptimizationJobStatus": "

The current status of the optimization job.

" - } - }, - "OptimizationJobSummaries": { - "base": null, - "refs": { - "ListOptimizationJobsResponse$OptimizationJobSummaries": "

A list of optimization jobs and their properties that matches any of the filters you specified in the request.

" - } - }, - "OptimizationJobSummary": { - "base": "

Summarizes an optimization job by providing some of its key properties.

", - "refs": { - "OptimizationJobSummaries$member": null - } - }, - "OptimizationJobTrainingPlanArns": { - "base": "

Amazon Resource Names (ARNs) of the training plans whose reserved capacity backs the optimization job. Bounded to a single plan for now; the list shape allows widening to multiple plans in the future without a breaking scalar-to-list change.

", - "refs": { - "CreateOptimizationJobRequest$TrainingPlanArns": "

The Amazon Resource Name (ARN) of the training plan to use for this optimization job.

When you use reserved capacity from a training plan, the optimization job runs on that reserved capacity instead of on-demand capacity. If you omit this field, the job uses on-demand capacity. You can specify at most one training plan.

For more information about how to reserve GPU capacity for your optimization jobs using Amazon SageMaker Training Plans, see Reserve capacity with training plans.

", - "DescribeOptimizationJobResponse$TrainingPlanArns": "

The Amazon Resource Name (ARN) of the training plan associated with this optimization job. This field appears only when you specified a training plan when you created the job. Optimization jobs that use on-demand capacity don't return this field.

" - } - }, - "OptimizationModelAcceptEula": { - "base": null, - "refs": { - "OptimizationModelAccessConfig$AcceptEula": "

Specifies agreement to the model end-user license agreement (EULA). The AcceptEula value must be explicitly defined as True in order to accept the EULA that this model requires. You are responsible for reviewing and complying with any applicable license terms and making sure they are acceptable for your use case before downloading or using a model.

" - } - }, - "OptimizationModelAccessConfig": { - "base": "

The access configuration settings for the source ML model for an optimization job, where you can accept the model end-user license agreement (EULA).

", - "refs": { - "OptimizationJobModelSourceS3$ModelAccessConfig": "

The access configuration settings for the source ML model for an optimization job, where you can accept the model end-user license agreement (EULA).

" - } - }, - "OptimizationOutput": { - "base": "

Output values produced by an optimization job.

", - "refs": { - "DescribeOptimizationJobResponse$OptimizationOutput": "

Output values produced by an optimization job.

" - } - }, - "OptimizationSageMakerModel": { - "base": "

A SageMaker model to use as the source or destination for an optimization job.

", - "refs": { - "OptimizationJobModelSource$SageMakerModel": "

The name of an existing SageMaker model to optimize with an optimization job.

", - "OptimizationJobOutputConfig$SageMakerModel": "

The name of a SageMaker model to use as the output destination for an optimization job.

" - } - }, - "OptimizationType": { - "base": null, - "refs": { - "OptimizationTypes$member": null - } - }, - "OptimizationTypes": { - "base": null, - "refs": { - "OptimizationJobSummary$OptimizationTypes": "

The optimization techniques that are applied by the optimization job.

" - } - }, - "OptimizationVpcConfig": { - "base": "

A VPC in Amazon VPC that's accessible to an optimized that you create with an optimization job. You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC.

", - "refs": { - "CreateOptimizationJobRequest$VpcConfig": "

A VPC in Amazon VPC that your optimized model has access to.

", - "DescribeOptimizationJobResponse$VpcConfig": "

A VPC in Amazon VPC that your optimized model has access to.

" - } - }, - "OptimizationVpcSecurityGroupId": { - "base": null, - "refs": { - "OptimizationVpcSecurityGroupIds$member": null - } - }, - "OptimizationVpcSecurityGroupIds": { - "base": null, - "refs": { - "OptimizationVpcConfig$SecurityGroupIds": "

The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.

" - } - }, - "OptimizationVpcSubnetId": { - "base": null, - "refs": { - "OptimizationVpcSubnets$member": null - } - }, - "OptimizationVpcSubnets": { - "base": null, - "refs": { - "OptimizationVpcConfig$Subnets": "

The ID of the subnets in the VPC to which you want to connect your optimized model.

" - } - }, - "OptionalDouble": { - "base": null, - "refs": { - "TrialComponentMetricSummary$Max": "

The maximum value of the metric.

", - "TrialComponentMetricSummary$Min": "

The minimum value of the metric.

", - "TrialComponentMetricSummary$Last": "

The most recent value of the metric.

", - "TrialComponentMetricSummary$Avg": "

The average value of the metric.

", - "TrialComponentMetricSummary$StdDev": "

The standard deviation of the metric.

" - } - }, - "OptionalInteger": { - "base": null, - "refs": { - "TrialComponentMetricSummary$Count": "

The number of samples used to generate the metric.

" - } - }, - "OptionalVolumeSizeInGB": { - "base": null, - "refs": { - "DebugRuleConfiguration$VolumeSizeInGB": "

The size, in GB, of the ML storage volume attached to the processing instance.

", - "HyperParameterTuningResourceConfig$VolumeSizeInGB": "

The volume size in GB for the storage volume to be used in processing hyperparameter optimization jobs (optional). These volumes store model artifacts, incremental states and optionally, scratch space for training algorithms. Do not provide a value for this parameter if a value for InstanceConfigs is also specified.

Some instance types have a fixed total local storage size. If you select one of these instances for training, VolumeSizeInGB cannot be greater than this total size. For a list of instance types with local instance storage and their sizes, see instance store volumes.

SageMaker supports only the General Purpose SSD (gp2) storage volume type.

", - "ProfilerRuleConfiguration$VolumeSizeInGB": "

The size, in GB, of the ML storage volume attached to the processing instance.

", - "ResourceConfig$VolumeSizeInGB": "

The size of the ML storage volume that you want to provision.

SageMaker automatically selects the volume size for serverless training jobs. You cannot customize this setting.

ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose File as the TrainingInputMode in the algorithm specification.

When using an ML instance with NVMe SSD volumes, SageMaker doesn't provision Amazon EBS General Purpose SSD (gp2) storage. Available storage is fixed to the NVMe-type instance's storage capacity. SageMaker configures storage paths for training datasets, checkpoints, model artifacts, and outputs to use the entire capacity of the instance storage. For example, ML instance families with the NVMe-type instance storage include ml.p4d, ml.g4dn, and ml.g5.

When using an ML instance with the EBS-only storage option and without instance storage, you must define the size of EBS volume through VolumeSizeInGB in the ResourceConfig API. For example, ML instance families that use EBS volumes include ml.c5 and ml.p2.

To look up instance types and their instance storage types and volumes, see Amazon EC2 Instance Types.

To find the default local paths defined by the SageMaker training platform, see Amazon SageMaker Training Storage Folders for Training Datasets, Checkpoints, Model Artifacts, and Outputs.

" - } - }, - "OrderKey": { - "base": null, - "refs": { - "ListEndpointConfigsInput$SortOrder": "

The sort order for results. The default is Descending.

", - "ListEndpointsInput$SortOrder": "

The sort order for results. The default is Descending.

", - "ListInferenceComponentsInput$SortOrder": "

The sort order for results. The default is Descending.

", - "ListModelsInput$SortOrder": "

The sort order for results. The default is Descending.

" - } - }, - "OutputCompressionType": { - "base": null, - "refs": { - "OutputDataConfig$CompressionType": "

The model output compression type. Select None to output an uncompressed model, recommended for large model outputs. Defaults to gzip.

" - } - }, - "OutputConfig": { - "base": "

Contains information about the output location for the compiled model and the target device that the model runs on. TargetDevice and TargetPlatform are mutually exclusive, so you need to choose one between the two to specify your target device or platform. If you cannot find your device you want to use from the TargetDevice list, use TargetPlatform to describe the platform of your edge device and CompilerOptions if there are specific settings that are required or recommended to use for particular TargetPlatform.

", - "refs": { - "CreateCompilationJobRequest$OutputConfig": "

Provides information about the output location for the compiled model and the target device the model runs on.

", - "DescribeCompilationJobResponse$OutputConfig": "

Information about the output location for the compiled model and the target device that the model runs on.

" - } - }, - "OutputDataConfig": { - "base": "

Provides information about how to store model training results (model artifacts).

", - "refs": { - "CreateTrainingJobRequest$OutputDataConfig": "

Specifies the path to the S3 location where you want to store model artifacts. SageMaker creates subfolders for the artifacts.

", - "DescribeTrainingJobResponse$OutputDataConfig": "

The S3 path where model artifacts that you configured when creating the job are stored. SageMaker creates subfolders for model artifacts.

", - "HyperParameterTrainingJobDefinition$OutputDataConfig": "

Specifies the path to the Amazon S3 bucket where you store model artifacts from the training jobs that the tuning job launches.

", - "TrainingJob$OutputDataConfig": "

The S3 path where model artifacts that you configured when creating the job are stored. SageMaker creates subfolders for model artifacts.

", - "TrainingJobDefinition$OutputDataConfig": "

the path to the S3 bucket where you want to store model artifacts. SageMaker creates subfolders for the artifacts.

" - } - }, - "OutputParameter": { - "base": "

An output parameter of a pipeline step.

", - "refs": { - "OutputParameterList$member": null - } - }, - "OutputParameterList": { - "base": null, - "refs": { - "CallbackStepMetadata$OutputParameters": "

A list of the output parameters of the callback step.

", - "LambdaStepMetadata$OutputParameters": "

A list of the output parameters of the Lambda step.

", - "SendPipelineExecutionStepSuccessRequest$OutputParameters": "

A list of the output parameters of the callback step.

" - } - }, - "OwnershipSettings": { - "base": "

The collection of ownership settings for a space.

", - "refs": { - "CreateSpaceRequest$OwnershipSettings": "

A collection of ownership settings.

", - "DescribeSpaceResponse$OwnershipSettings": "

The collection of ownership settings for a space.

" - } - }, - "OwnershipSettingsSummary": { - "base": "

Specifies summary information about the ownership settings.

", - "refs": { - "SpaceDetails$OwnershipSettingsSummary": "

Specifies summary information about the ownership settings.

" - } - }, - "PaginationToken": { - "base": null, - "refs": { - "ListEndpointConfigsInput$NextToken": "

If the result of the previous ListEndpointConfig request was truncated, the response includes a NextToken. To retrieve the next set of endpoint configurations, use the token in the next request.

", - "ListEndpointConfigsOutput$NextToken": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of endpoint configurations, use it in the subsequent request

", - "ListEndpointsInput$NextToken": "

If the result of a ListEndpoints request was truncated, the response includes a NextToken. To retrieve the next set of endpoints, use the token in the next request.

", - "ListEndpointsOutput$NextToken": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.

", - "ListInferenceComponentsInput$NextToken": "

A token that you use to get the next set of results following a truncated response. If the response to the previous request was truncated, that response provides the value for this token.

", - "ListInferenceComponentsOutput$NextToken": "

The token to use in a subsequent request to get the next set of results following a truncated response.

", - "ListModelsInput$NextToken": "

If the response to a previous ListModels request was truncated, the response includes a NextToken. To retrieve the next set of models, use the token in the next request.

", - "ListModelsOutput$NextToken": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of models, use it in the subsequent request.

" - } - }, - "ParallelismConfiguration": { - "base": "

Configuration that controls the parallelism of the pipeline. By default, the parallelism configuration specified applies to all executions of the pipeline unless overridden.

", - "refs": { - "CreatePipelineRequest$ParallelismConfiguration": "

This is the configuration that controls the parallelism of the pipeline. If specified, it applies to all runs of this pipeline by default.

", - "DescribePipelineExecutionResponse$ParallelismConfiguration": "

The parallelism configuration applied to the pipeline.

", - "DescribePipelineResponse$ParallelismConfiguration": "

Lists the parallelism configuration applied to the pipeline.

", - "Pipeline$ParallelismConfiguration": "

The parallelism configuration applied to the pipeline.

", - "PipelineExecution$ParallelismConfiguration": "

The parallelism configuration applied to the pipeline execution.

", - "RetryPipelineExecutionRequest$ParallelismConfiguration": "

This configuration, if specified, overrides the parallelism configuration of the parent pipeline.

", - "StartPipelineExecutionRequest$ParallelismConfiguration": "

This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run.

", - "UpdatePipelineExecutionRequest$ParallelismConfiguration": "

This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run.

", - "UpdatePipelineRequest$ParallelismConfiguration": "

If specified, it applies to all executions of this pipeline by default.

" - } - }, - "Parameter": { - "base": "

Assigns a value to a named Pipeline parameter.

", - "refs": { - "ParameterList$member": null - } - }, - "ParameterKey": { - "base": null, - "refs": { - "AutoParameter$Name": "

The name of the hyperparameter to optimize using Autotune.

", - "CategoricalParameterRange$Name": "

The name of the categorical hyperparameter to tune.

", - "ContinuousParameterRange$Name": "

The name of the continuous hyperparameter to tune.

", - "IntegerParameterRange$Name": "

The name of the hyperparameter to search.

" - } - }, - "ParameterList": { - "base": null, - "refs": { - "ListPipelineParametersForExecutionResponse$PipelineParameters": "

Contains a list of pipeline parameters. This list can be empty.

", - "PipelineExecution$PipelineParameters": "

Contains a list of pipeline parameters. This list can be empty.

", - "StartPipelineExecutionRequest$PipelineParameters": "

Contains a list of pipeline parameters. This list can be empty.

" - } - }, - "ParameterName": { - "base": null, - "refs": { - "HyperParameterSpecification$Name": "

The name of this hyperparameter. The name must be unique.

" - } - }, - "ParameterRange": { - "base": "

Defines the possible values for categorical, continuous, and integer hyperparameters to be used by an algorithm.

", - "refs": { - "HyperParameterSpecification$Range": "

The allowed range for this hyperparameter.

" - } - }, - "ParameterRanges": { - "base": "

Specifies ranges of integer, continuous, and categorical hyperparameters that a hyperparameter tuning job searches. The hyperparameter tuning job launches training jobs with hyperparameter values within these ranges to find the combination of values that result in the training job with the best performance as measured by the objective metric of the hyperparameter tuning job.

The maximum number of items specified for Array Members refers to the maximum number of hyperparameters for each range and also the maximum for the hyperparameter tuning job itself. That is, the sum of the number of hyperparameters for all the ranges can't exceed the maximum number specified.

", - "refs": { - "HyperParameterTrainingJobDefinition$HyperParameterRanges": null, - "HyperParameterTuningJobConfig$ParameterRanges": "

The ParameterRanges object that specifies the ranges of hyperparameters that this tuning job searches over to find the optimal configuration for the highest model performance against your chosen objective metric.

" - } - }, - "ParameterType": { - "base": null, - "refs": { - "HyperParameterSpecification$Type": "

The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.

" - } - }, - "ParameterValue": { - "base": null, - "refs": { - "AutoParameter$ValueHint": "

An example value of the hyperparameter to optimize using Autotune.

", - "ContinuousParameterRange$MinValue": "

The minimum value for the hyperparameter. The tuning job uses floating-point values between this value and MaxValuefor tuning.

", - "ContinuousParameterRange$MaxValue": "

The maximum value for the hyperparameter. The tuning job uses floating-point values between MinValue value and this value for tuning.

", - "ContinuousParameterRangeSpecification$MinValue": "

The minimum floating-point value allowed.

", - "ContinuousParameterRangeSpecification$MaxValue": "

The maximum floating-point value allowed.

", - "IntegerParameterRange$MinValue": "

The minimum value of the hyperparameter to search.

", - "IntegerParameterRange$MaxValue": "

The maximum value of the hyperparameter to search.

", - "IntegerParameterRangeSpecification$MinValue": "

The minimum integer value allowed.

", - "IntegerParameterRangeSpecification$MaxValue": "

The maximum integer value allowed.

", - "ParameterValues$member": null - } - }, - "ParameterValues": { - "base": null, - "refs": { - "CategoricalParameterRange$Values": "

A list of the categories for the hyperparameter.

", - "CategoricalParameterRangeSpecification$Values": "

The allowed categories for the hyperparameter.

" - } - }, - "Parent": { - "base": "

The trial that a trial component is associated with and the experiment the trial is part of. A component might not be associated with a trial. A component can be associated with multiple trials.

", - "refs": { - "Parents$member": null - } - }, - "ParentHyperParameterTuningJob": { - "base": "

A previously completed or stopped hyperparameter tuning job to be used as a starting point for a new hyperparameter tuning job.

", - "refs": { - "ParentHyperParameterTuningJobs$member": null - } - }, - "ParentHyperParameterTuningJobs": { - "base": null, - "refs": { - "HyperParameterTuningJobWarmStartConfig$ParentHyperParameterTuningJobs": "

An array of hyperparameter tuning jobs that are used as the starting point for the new hyperparameter tuning job. For more information about warm starting a hyperparameter tuning job, see Using a Previous Hyperparameter Tuning Job as a Starting Point.

Hyperparameter tuning jobs created before October 1, 2018 cannot be used as parent jobs for warm start tuning jobs.

" - } - }, - "Parents": { - "base": null, - "refs": { - "TrialComponent$Parents": "

An array of the parents of the component. A parent is a trial the component is associated with and the experiment the trial is part of. A component might not have any parents.

" - } - }, - "PartnerAppAdminUserList": { - "base": null, - "refs": { - "PartnerAppConfig$AdminUsers": "

The list of users that are given admin access to the SageMaker Partner AI App.

" - } - }, - "PartnerAppArguments": { - "base": null, - "refs": { - "PartnerAppConfig$Arguments": "

This is a map of required inputs for a SageMaker Partner AI App. Based on the application type, the map is populated with a key and value pair that is specific to the user and application.

" - } - }, - "PartnerAppArn": { - "base": null, - "refs": { - "CreatePartnerAppPresignedUrlRequest$Arn": "

The ARN of the SageMaker Partner AI App to create the presigned URL for.

", - "CreatePartnerAppResponse$Arn": "

The ARN of the SageMaker Partner AI App.

", - "DeletePartnerAppRequest$Arn": "

The ARN of the SageMaker Partner AI App to delete.

", - "DeletePartnerAppResponse$Arn": "

The ARN of the SageMaker Partner AI App that was deleted.

", - "DescribePartnerAppRequest$Arn": "

The ARN of the SageMaker Partner AI App to describe.

", - "DescribePartnerAppResponse$Arn": "

The ARN of the SageMaker Partner AI App that was described.

", - "PartnerAppSummary$Arn": "

The ARN of the SageMaker Partner AI App.

", - "UpdatePartnerAppRequest$Arn": "

The ARN of the SageMaker Partner AI App to update.

", - "UpdatePartnerAppResponse$Arn": "

The ARN of the SageMaker Partner AI App that was updated.

" - } - }, - "PartnerAppAuthType": { - "base": null, - "refs": { - "CreatePartnerAppRequest$AuthType": "

The authorization type that users use to access the SageMaker Partner AI App.

", - "DescribePartnerAppResponse$AuthType": "

The authorization type that users use to access the SageMaker Partner AI App.

" - } - }, - "PartnerAppConfig": { - "base": "

Configuration settings for the SageMaker Partner AI App.

", - "refs": { - "CreatePartnerAppRequest$ApplicationConfig": "

Configuration settings for the SageMaker Partner AI App.

", - "DescribePartnerAppResponse$ApplicationConfig": "

Configuration settings for the SageMaker Partner AI App.

", - "UpdatePartnerAppRequest$ApplicationConfig": "

Configuration settings for the SageMaker Partner AI App.

" - } - }, - "PartnerAppMaintenanceConfig": { - "base": "

Maintenance configuration settings for the SageMaker Partner AI App.

", - "refs": { - "CreatePartnerAppRequest$MaintenanceConfig": "

Maintenance configuration settings for the SageMaker Partner AI App.

", - "DescribePartnerAppResponse$MaintenanceConfig": "

Maintenance configuration settings for the SageMaker Partner AI App.

", - "UpdatePartnerAppRequest$MaintenanceConfig": "

Maintenance configuration settings for the SageMaker Partner AI App.

" - } - }, - "PartnerAppName": { - "base": null, - "refs": { - "CreatePartnerAppRequest$Name": "

The name to give the SageMaker Partner AI App.

", - "DescribePartnerAppResponse$Name": "

The name of the SageMaker Partner AI App.

", - "PartnerAppSummary$Name": "

The name of the SageMaker Partner AI App.

" - } - }, - "PartnerAppStatus": { - "base": null, - "refs": { - "DescribePartnerAppResponse$Status": "

The status of the SageMaker Partner AI App.

  • Creating: SageMaker AI is creating the partner AI app. The partner AI app is not available during creation.

  • Updating: SageMaker AI is updating the partner AI app. The partner AI app is not available when updating.

  • Deleting: SageMaker AI is deleting the partner AI app. The partner AI app is not available during deletion.

  • Available: The partner AI app is provisioned and accessible.

  • Failed: The partner AI app is in a failed state and isn't available. SageMaker AI is investigating the issue. For further guidance, contact Amazon Web Services Support.

  • UpdateFailed: The partner AI app couldn't be updated but is available.

  • Deleted: The partner AI app is permanently deleted and not available.

", - "PartnerAppSummary$Status": "

The status of the SageMaker Partner AI App.

" - } - }, - "PartnerAppSummaries": { - "base": null, - "refs": { - "ListPartnerAppsResponse$Summaries": "

The information related to each of the SageMaker Partner AI Apps in an account.

" - } - }, - "PartnerAppSummary": { - "base": "

A subset of information related to a SageMaker Partner AI App. This information is used as part of the ListPartnerApps API response.

", - "refs": { - "PartnerAppSummaries$member": null - } - }, - "PartnerAppType": { - "base": null, - "refs": { - "CreatePartnerAppRequest$Type": "

The type of SageMaker Partner AI App to create. Must be one of the following: lakera-guard, comet, deepchecks-llm-evaluation, or fiddler.

", - "DescribePartnerAppResponse$Type": "

The type of SageMaker Partner AI App. Must be one of the following: lakera-guard, comet, deepchecks-llm-evaluation, or fiddler.

", - "PartnerAppSummary$Type": "

The type of SageMaker Partner AI App to create. Must be one of the following: lakera-guard, comet, deepchecks-llm-evaluation, or fiddler.

" - } - }, - "Peft": { - "base": null, - "refs": { - "ServerlessJobConfig$Peft": "

The parameter-efficient fine-tuning configuration.

" - } - }, - "PendingDeploymentSummary": { - "base": "

The summary of an in-progress deployment when an endpoint is creating or updating with a new endpoint configuration.

", - "refs": { - "DescribeEndpointOutput$PendingDeploymentSummary": "

Returns the summary of an in-progress deployment. This field is only returned when the endpoint is creating or updating with a new endpoint configuration.

" - } - }, - "PendingProductionVariantSummary": { - "base": "

The production variant summary for a deployment when an endpoint is creating or updating with the CreateEndpoint or UpdateEndpoint operations. Describes the VariantStatus , weight and capacity for a production variant associated with an endpoint.

", - "refs": { - "PendingProductionVariantSummaryList$member": null - } - }, - "PendingProductionVariantSummaryList": { - "base": null, - "refs": { - "PendingDeploymentSummary$ProductionVariants": "

An array of PendingProductionVariantSummary objects, one for each model hosted behind this endpoint for the in-progress deployment.

", - "PendingDeploymentSummary$ShadowProductionVariants": "

An array of PendingProductionVariantSummary objects, one for each model hosted behind this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants for the in-progress deployment.

" - } - }, - "Percentage": { - "base": null, - "refs": { - "DeviceSelectionConfig$Percentage": "

Percentage of devices in the fleet to deploy to the current stage.

", - "ShadowModelVariantConfig$SamplingPercentage": "

The percentage of inference requests that Amazon SageMaker replicates from the production variant to the shadow variant.

" - } - }, - "Phase": { - "base": "

Defines the traffic pattern.

", - "refs": { - "Phases$member": null - } - }, - "Phases": { - "base": null, - "refs": { - "TrafficPattern$Phases": "

Defines the phases traffic specification.

" - } - }, - "Pipeline": { - "base": "

A SageMaker Model Building Pipeline instance.

", - "refs": { - "SearchRecord$Pipeline": null - } - }, - "PipelineArn": { - "base": null, - "refs": { - "CreatePipelineResponse$PipelineArn": "

The Amazon Resource Name (ARN) of the created pipeline.

", - "DeletePipelineResponse$PipelineArn": "

The Amazon Resource Name (ARN) of the pipeline to delete.

", - "DescribePipelineExecutionResponse$PipelineArn": "

The Amazon Resource Name (ARN) of the pipeline.

", - "DescribePipelineResponse$PipelineArn": "

The Amazon Resource Name (ARN) of the pipeline.

", - "Pipeline$PipelineArn": "

The Amazon Resource Name (ARN) of the pipeline.

", - "PipelineExecution$PipelineArn": "

The Amazon Resource Name (ARN) of the pipeline that was executed.

", - "PipelineSummary$PipelineArn": "

The Amazon Resource Name (ARN) of the pipeline.

", - "PipelineVersion$PipelineArn": "

The Amazon Resource Name (ARN) of the pipeline.

", - "PipelineVersionSummary$PipelineArn": "

The Amazon Resource Name (ARN) of the pipeline.

", - "UpdatePipelineResponse$PipelineArn": "

The Amazon Resource Name (ARN) of the updated pipeline.

", - "UpdatePipelineVersionRequest$PipelineArn": "

The Amazon Resource Name (ARN) of the pipeline.

", - "UpdatePipelineVersionResponse$PipelineArn": "

The Amazon Resource Name (ARN) of the pipeline.

" - } - }, - "PipelineDefinition": { - "base": null, - "refs": { - "CreatePipelineRequest$PipelineDefinition": "

The JSON pipeline definition of the pipeline.

", - "DescribePipelineDefinitionForExecutionResponse$PipelineDefinition": "

The JSON pipeline definition.

", - "DescribePipelineResponse$PipelineDefinition": "

The JSON pipeline definition.

", - "UpdatePipelineRequest$PipelineDefinition": "

The JSON pipeline definition.

" - } - }, - "PipelineDefinitionS3Location": { - "base": "

The location of the pipeline definition stored in Amazon S3.

", - "refs": { - "CreatePipelineRequest$PipelineDefinitionS3Location": "

The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location.

", - "UpdatePipelineRequest$PipelineDefinitionS3Location": "

The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location.

" - } - }, - "PipelineDescription": { - "base": null, - "refs": { - "CreatePipelineRequest$PipelineDescription": "

A description of the pipeline.

", - "DescribePipelineResponse$PipelineDescription": "

The description of the pipeline.

", - "Pipeline$PipelineDescription": "

The description of the pipeline.

", - "PipelineSummary$PipelineDescription": "

The description of the pipeline.

", - "UpdatePipelineRequest$PipelineDescription": "

The description of the pipeline.

" - } - }, - "PipelineExecution": { - "base": "

An execution of a pipeline.

", - "refs": { - "SearchRecord$PipelineExecution": null - } - }, - "PipelineExecutionArn": { - "base": null, - "refs": { - "CacheHitResult$SourcePipelineExecutionArn": "

The Amazon Resource Name (ARN) of the pipeline execution.

", - "DescribePipelineDefinitionForExecutionRequest$PipelineExecutionArn": "

The Amazon Resource Name (ARN) of the pipeline execution.

", - "DescribePipelineExecutionRequest$PipelineExecutionArn": "

The Amazon Resource Name (ARN) of the pipeline execution.

", - "DescribePipelineExecutionResponse$PipelineExecutionArn": "

The Amazon Resource Name (ARN) of the pipeline execution.

", - "ListPipelineExecutionStepsRequest$PipelineExecutionArn": "

The Amazon Resource Name (ARN) of the pipeline execution.

", - "ListPipelineParametersForExecutionRequest$PipelineExecutionArn": "

The Amazon Resource Name (ARN) of the pipeline execution.

", - "PipelineExecution$PipelineExecutionArn": "

The Amazon Resource Name (ARN) of the pipeline execution.

", - "PipelineExecutionSummary$PipelineExecutionArn": "

The Amazon Resource Name (ARN) of the pipeline execution.

", - "PipelineVersion$LastExecutedPipelineExecutionArn": "

The Amazon Resource Name (ARN) of the most recent pipeline execution created from this pipeline version.

", - "PipelineVersionSummary$LastExecutionPipelineExecutionArn": "

The Amazon Resource Name (ARN) of the most recent pipeline execution created from this pipeline version.

", - "RetryPipelineExecutionRequest$PipelineExecutionArn": "

The Amazon Resource Name (ARN) of the pipeline execution.

", - "RetryPipelineExecutionResponse$PipelineExecutionArn": "

The Amazon Resource Name (ARN) of the pipeline execution.

", - "SelectiveExecutionConfig$SourcePipelineExecutionArn": "

The ARN from a reference execution of the current pipeline. Used to copy input collaterals needed for the selected steps to run. The execution status of the pipeline can be either Failed or Success.

This field is required if the steps you specify for SelectedSteps depend on output collaterals from any non-specified pipeline steps. For more information, see Selective Execution for Pipeline Steps.

", - "SelectiveExecutionResult$SourcePipelineExecutionArn": "

The ARN from an execution of the current pipeline.

", - "SendPipelineExecutionStepFailureResponse$PipelineExecutionArn": "

The Amazon Resource Name (ARN) of the pipeline execution.

", - "SendPipelineExecutionStepSuccessResponse$PipelineExecutionArn": "

The Amazon Resource Name (ARN) of the pipeline execution.

", - "StartPipelineExecutionResponse$PipelineExecutionArn": "

The Amazon Resource Name (ARN) of the pipeline execution.

", - "StopPipelineExecutionRequest$PipelineExecutionArn": "

The Amazon Resource Name (ARN) of the pipeline execution.

", - "StopPipelineExecutionResponse$PipelineExecutionArn": "

The Amazon Resource Name (ARN) of the pipeline execution.

", - "UpdatePipelineExecutionRequest$PipelineExecutionArn": "

The Amazon Resource Name (ARN) of the pipeline execution.

", - "UpdatePipelineExecutionResponse$PipelineExecutionArn": "

The Amazon Resource Name (ARN) of the updated pipeline execution.

" - } - }, - "PipelineExecutionDescription": { - "base": null, - "refs": { - "DescribePipelineExecutionResponse$PipelineExecutionDescription": "

The description of the pipeline execution.

", - "PipelineExecution$PipelineExecutionDescription": "

The description of the pipeline execution.

", - "PipelineExecutionSummary$PipelineExecutionDescription": "

The description of the pipeline execution.

", - "StartPipelineExecutionRequest$PipelineExecutionDescription": "

The description of the pipeline execution.

", - "UpdatePipelineExecutionRequest$PipelineExecutionDescription": "

The description of the pipeline execution.

" - } - }, - "PipelineExecutionFailureReason": { - "base": null, - "refs": { - "DescribePipelineExecutionResponse$FailureReason": "

If the execution failed, a message describing why.

", - "PipelineExecution$FailureReason": "

If the execution failed, a message describing why.

" - } - }, - "PipelineExecutionName": { - "base": null, - "refs": { - "DescribePipelineExecutionResponse$PipelineExecutionDisplayName": "

The display name of the pipeline execution.

", - "PipelineExecution$PipelineExecutionDisplayName": "

The display name of the pipeline execution.

", - "PipelineExecutionSummary$PipelineExecutionDisplayName": "

The display name of the pipeline execution.

", - "PipelineVersion$LastExecutedPipelineExecutionDisplayName": "

The display name of the most recent pipeline execution created from this pipeline version.

", - "StartPipelineExecutionRequest$PipelineExecutionDisplayName": "

The display name of the pipeline execution.

", - "UpdatePipelineExecutionRequest$PipelineExecutionDisplayName": "

The display name of the pipeline execution.

" - } - }, - "PipelineExecutionStatus": { - "base": null, - "refs": { - "DescribePipelineExecutionResponse$PipelineExecutionStatus": "

The status of the pipeline execution.

", - "PipelineExecution$PipelineExecutionStatus": "

The status of the pipeline status.

", - "PipelineExecutionSummary$PipelineExecutionStatus": "

The status of the pipeline execution.

", - "PipelineVersion$LastExecutedPipelineExecutionStatus": "

The status of the most recent pipeline execution created from this pipeline version.

" - } - }, - "PipelineExecutionStep": { - "base": "

An execution of a step in a pipeline.

", - "refs": { - "PipelineExecutionStepList$member": null - } - }, - "PipelineExecutionStepList": { - "base": null, - "refs": { - "ListPipelineExecutionStepsResponse$PipelineExecutionSteps": "

A list of PipeLineExecutionStep objects. Each PipeLineExecutionStep consists of StepName, StartTime, EndTime, StepStatus, and Metadata. Metadata is an object with properties for each job that contains relevant information about the job created by the step.

" - } - }, - "PipelineExecutionStepMetadata": { - "base": "

Metadata for a step execution.

", - "refs": { - "PipelineExecutionStep$Metadata": "

Metadata to run the pipeline step.

" - } - }, - "PipelineExecutionSummary": { - "base": "

A pipeline execution summary.

", - "refs": { - "PipelineExecutionSummaryList$member": null - } - }, - "PipelineExecutionSummaryList": { - "base": null, - "refs": { - "ListPipelineExecutionsResponse$PipelineExecutionSummaries": "

Contains a sorted list of pipeline execution summary objects matching the specified filters. Each run summary includes the Amazon Resource Name (ARN) of the pipeline execution, the run date, and the status. This list can be empty.

" - } - }, - "PipelineExperimentConfig": { - "base": "

Specifies the names of the experiment and trial created by a pipeline.

", - "refs": { - "DescribePipelineExecutionResponse$PipelineExperimentConfig": null, - "PipelineExecution$PipelineExperimentConfig": null - } - }, - "PipelineName": { - "base": null, - "refs": { - "CreatePipelineRequest$PipelineName": "

The name of the pipeline.

", - "CreatePipelineRequest$PipelineDisplayName": "

The display name of the pipeline.

", - "DeletePipelineRequest$PipelineName": "

The name of the pipeline to delete.

", - "DescribePipelineResponse$PipelineName": "

The name of the pipeline.

", - "DescribePipelineResponse$PipelineDisplayName": "

The display name of the pipeline.

", - "ListPipelinesRequest$PipelineNamePrefix": "

The prefix of the pipeline name.

", - "Pipeline$PipelineName": "

The name of the pipeline.

", - "Pipeline$PipelineDisplayName": "

The display name of the pipeline.

", - "PipelineSummary$PipelineName": "

The name of the pipeline.

", - "PipelineSummary$PipelineDisplayName": "

The display name of the pipeline.

", - "UpdatePipelineRequest$PipelineName": "

The name of the pipeline to update.

", - "UpdatePipelineRequest$PipelineDisplayName": "

The display name of the pipeline.

" - } - }, - "PipelineNameOrArn": { - "base": null, - "refs": { - "DescribePipelineRequest$PipelineName": "

The name or Amazon Resource Name (ARN) of the pipeline to describe.

", - "ListPipelineExecutionsRequest$PipelineName": "

The name or Amazon Resource Name (ARN) of the pipeline.

", - "ListPipelineVersionsRequest$PipelineName": "

The Amazon Resource Name (ARN) of the pipeline.

", - "StartPipelineExecutionRequest$PipelineName": "

The name or Amazon Resource Name (ARN) of the pipeline.

" - } - }, - "PipelineParameterName": { - "base": null, - "refs": { - "Parameter$Name": "

The name of the parameter to assign a value to. This parameter name must match a named parameter in the pipeline definition.

" - } - }, - "PipelineStatus": { - "base": null, - "refs": { - "DescribePipelineResponse$PipelineStatus": "

The status of the pipeline execution.

", - "Pipeline$PipelineStatus": "

The status of the pipeline.

" - } - }, - "PipelineSummary": { - "base": "

A summary of a pipeline.

", - "refs": { - "PipelineSummaryList$member": null - } - }, - "PipelineSummaryList": { - "base": null, - "refs": { - "ListPipelinesResponse$PipelineSummaries": "

Contains a sorted list of PipelineSummary objects matching the specified filters. Each PipelineSummary consists of PipelineArn, PipelineName, ExperimentName, PipelineDescription, CreationTime, LastModifiedTime, LastRunTime, and RoleArn. This list can be empty.

" - } - }, - "PipelineVersion": { - "base": "

The version of the pipeline.

", - "refs": { - "SearchRecord$PipelineVersion": "

The version of the pipeline.

" - } - }, - "PipelineVersionDescription": { - "base": null, - "refs": { - "DescribePipelineResponse$PipelineVersionDescription": "

The description of the pipeline version.

", - "PipelineVersion$PipelineVersionDescription": "

The description of the pipeline version.

", - "PipelineVersionSummary$PipelineVersionDescription": "

The description of the pipeline version.

", - "UpdatePipelineVersionRequest$PipelineVersionDescription": "

The description of the pipeline version.

" - } - }, - "PipelineVersionId": { - "base": null, - "refs": { - "DescribePipelineExecutionResponse$PipelineVersionId": "

The ID of the pipeline version.

", - "DescribePipelineRequest$PipelineVersionId": "

The ID of the pipeline version to describe.

", - "PipelineExecution$PipelineVersionId": "

The ID of the pipeline version that started this execution.

", - "PipelineVersion$PipelineVersionId": "

The ID of the pipeline version.

", - "PipelineVersionSummary$PipelineVersionId": "

The ID of the pipeline version.

", - "StartPipelineExecutionRequest$PipelineVersionId": "

The ID of the pipeline version to start execution from.

", - "UpdatePipelineResponse$PipelineVersionId": "

The ID of the pipeline version.

", - "UpdatePipelineVersionRequest$PipelineVersionId": "

The pipeline version ID to update.

", - "UpdatePipelineVersionResponse$PipelineVersionId": "

The ID of the pipeline version.

" - } - }, - "PipelineVersionName": { - "base": null, - "refs": { - "DescribePipelineResponse$PipelineVersionDisplayName": "

The display name of the pipeline version.

", - "PipelineExecution$PipelineVersionDisplayName": "

The display name of the pipeline version that started this execution.

", - "PipelineVersion$PipelineVersionDisplayName": "

The display name of the pipeline version.

", - "PipelineVersionSummary$PipelineVersionDisplayName": "

The display name of the pipeline version.

", - "UpdatePipelineVersionRequest$PipelineVersionDisplayName": "

The display name of the pipeline version.

" - } - }, - "PipelineVersionSummary": { - "base": "

The summary of the pipeline version.

", - "refs": { - "PipelineVersionSummaryList$member": null - } - }, - "PipelineVersionSummaryList": { - "base": null, - "refs": { - "ListPipelineVersionsResponse$PipelineVersionSummaries": "

Contains a sorted list of pipeline version summary objects matching the specified filters. Each version summary includes the pipeline version ID, the creation date, and the last pipeline execution created from that version. This list can be empty.

" - } - }, - "PlacementSpecification": { - "base": "

Specifies how instances should be placed on a specific UltraServer.

", - "refs": { - "PlacementSpecifications$member": null - } - }, - "PlacementSpecifications": { - "base": null, - "refs": { - "InstancePlacementConfig$PlacementSpecifications": "

A list of specifications for how instances should be placed on specific UltraServers. Maximum of 10 items is supported.

" - } - }, - "PlatformIdentifier": { - "base": null, - "refs": { - "CreateNotebookInstanceInput$PlatformIdentifier": "

The platform identifier of the notebook instance runtime environment. The default value is notebook-al2023-v1.

", - "DescribeNotebookInstanceOutput$PlatformIdentifier": "

The platform identifier of the notebook instance runtime environment.

", - "UpdateNotebookInstanceInput$PlatformIdentifier": "

The platform identifier of the notebook instance runtime environment.

" - } - }, - "PolicyString": { - "base": null, - "refs": { - "GetModelPackageGroupPolicyOutput$ResourcePolicy": "

The resource policy for the model group.

", - "PutModelPackageGroupPolicyInput$ResourcePolicy": "

The resource policy for the model group.

" - } - }, - "PredefinedMetricSpecification": { - "base": "

A specification for a predefined metric.

", - "refs": { - "MetricSpecification$Predefined": "

Information about a predefined metric.

" - } - }, - "PreemptTeamTasks": { - "base": null, - "refs": { - "ComputeQuotaConfig$PreemptTeamTasks": "

Allows workloads from within an entity to preempt same-team workloads. When set to LowerPriority, the entity's lower priority tasks are preempted by their own higher priority tasks.

Default is LowerPriority.

" - } - }, - "PresignedDomainUrl": { - "base": null, - "refs": { - "CreatePresignedDomainUrlResponse$AuthorizedUrl": "

The presigned URL.

" - } - }, - "PresignedUrlAccessConfig": { - "base": "

Configuration for accessing hub content through presigned URLs, including license agreement acceptance and URL validation settings.

", - "refs": { - "CreateHubContentPresignedUrlsRequest$AccessConfig": "

Configuration settings for accessing the hub content, including end-user license agreement acceptance for gated models and expected S3 URL validation.

" - } - }, - "PriorityClass": { - "base": "

Priority class configuration. When included in PriorityClasses, these class configurations define how tasks are queued.

", - "refs": { - "PriorityClassList$member": null - } - }, - "PriorityClassList": { - "base": null, - "refs": { - "SchedulerConfig$PriorityClasses": "

List of the priority classes, PriorityClass, of the cluster policy. When specified, these class configurations define how tasks are queued.

" - } - }, - "PriorityWeight": { - "base": null, - "refs": { - "PriorityClass$Weight": "

Weight of the priority class. The value is within a range from 0 to 100, where 0 is the default.

A weight of 0 is the lowest priority and 100 is the highest. Weight 0 is the default.

" - } - }, - "ProbabilityThresholdAttribute": { - "base": null, - "refs": { - "BatchTransformInput$ProbabilityThresholdAttribute": "

The threshold for the class probability to be evaluated as a positive result.

", - "EndpointInput$ProbabilityThresholdAttribute": "

The threshold for the class probability to be evaluated as a positive result.

" - } - }, - "ProblemType": { - "base": null, - "refs": { - "CreateAutoMLJobRequest$ProblemType": "

Defines the type of supervised learning problem available for the candidates. For more information, see SageMaker Autopilot problem types.

", - "DescribeAutoMLJobResponse$ProblemType": "

Returns the job's problem type.

", - "ResolvedAttributes$ProblemType": "

The problem type.

", - "TabularJobConfig$ProblemType": "

The type of supervised learning problem available for the model candidates of the AutoML job V2. For more information, see SageMaker Autopilot problem types.

You must either specify the type of supervised learning problem in ProblemType and provide the AutoMLJobObjective metric, or none at all.

", - "TabularResolvedAttributes$ProblemType": "

The type of supervised learning problem available for the model candidates of the AutoML job V2 (Binary Classification, Multiclass Classification, Regression). For more information, see SageMaker Autopilot problem types.

" - } - }, - "ProcessingClusterConfig": { - "base": "

Configuration for the cluster used to run a processing job.

", - "refs": { - "ProcessingResources$ClusterConfig": "

The configuration for the resources in a cluster used to run the processing job.

" - } - }, - "ProcessingEnvironmentKey": { - "base": null, - "refs": { - "MonitoringEnvironmentMap$key": null, - "ProcessingEnvironmentMap$key": null - } - }, - "ProcessingEnvironmentMap": { - "base": null, - "refs": { - "CreateProcessingJobRequest$Environment": "

The environment variables to set in the Docker container. Up to 100 key and values entries in the map are supported.

Do not include any security-sensitive information including account access IDs, secrets, or tokens in any environment fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request environment variable or plain text fields.

", - "DescribeProcessingJobResponse$Environment": "

The environment variables set in the Docker container.

", - "ProcessingJob$Environment": "

Sets the environment variables in the Docker container.

" - } - }, - "ProcessingEnvironmentValue": { - "base": null, - "refs": { - "MonitoringEnvironmentMap$value": null, - "ProcessingEnvironmentMap$value": null - } - }, - "ProcessingFeatureStoreOutput": { - "base": "

Configuration for processing job outputs in Amazon SageMaker Feature Store.

", - "refs": { - "ProcessingOutput$FeatureStoreOutput": "

Configuration for processing job outputs in Amazon SageMaker Feature Store. This processing output type is only supported when AppManaged is specified.

" - } - }, - "ProcessingInput": { - "base": "

The inputs for a processing job. The processing input must specify exactly one of either S3Input or DatasetDefinition types.

", - "refs": { - "ProcessingInputs$member": null - } - }, - "ProcessingInputs": { - "base": null, - "refs": { - "CreateProcessingJobRequest$ProcessingInputs": "

An array of inputs configuring the data to download into the processing container.

", - "DescribeProcessingJobResponse$ProcessingInputs": "

The inputs for a processing job.

", - "ProcessingJob$ProcessingInputs": "

List of input configurations for the processing job.

" - } - }, - "ProcessingInstanceCount": { - "base": null, - "refs": { - "MonitoringClusterConfig$InstanceCount": "

The number of ML compute instances to use in the model monitoring job. For distributed processing jobs, specify a value greater than 1. The default value is 1.

", - "ProcessingClusterConfig$InstanceCount": "

The number of ML compute instances to use in the processing job. For distributed processing jobs, specify a value greater than 1. The default value is 1.

" - } - }, - "ProcessingInstanceType": { - "base": null, - "refs": { - "DebugRuleConfiguration$InstanceType": "

The instance type to deploy a custom rule for debugging a training job.

", - "MonitoringClusterConfig$InstanceType": "

The ML compute instance type for the processing job.

", - "ProcessingClusterConfig$InstanceType": "

The ML compute instance type for the processing job.

", - "ProfilerRuleConfiguration$InstanceType": "

The instance type to deploy a custom rule for profiling a training job.

" - } - }, - "ProcessingJob": { - "base": "

An Amazon SageMaker processing job that is used to analyze data and evaluate models. For more information, see Process Data and Evaluate Models.

", - "refs": { - "TrialComponentSourceDetail$ProcessingJob": "

Information about a processing job that's the source of a trial component.

" - } - }, - "ProcessingJobArn": { - "base": null, - "refs": { - "CreateProcessingJobResponse$ProcessingJobArn": "

The Amazon Resource Name (ARN) of the processing job.

", - "DebugRuleEvaluationStatus$RuleEvaluationJobArn": "

The Amazon Resource Name (ARN) of the rule evaluation job.

", - "DescribeProcessingJobResponse$ProcessingJobArn": "

The Amazon Resource Name (ARN) of the processing job.

", - "MonitoringExecutionSummary$ProcessingJobArn": "

The Amazon Resource Name (ARN) of the monitoring job.

", - "ProcessingJob$ProcessingJobArn": "

The ARN of the processing job.

", - "ProcessingJobStepMetadata$Arn": "

The Amazon Resource Name (ARN) of the processing job.

", - "ProcessingJobSummary$ProcessingJobArn": "

The Amazon Resource Name (ARN) of the processing job..

", - "ProfilerRuleEvaluationStatus$RuleEvaluationJobArn": "

The Amazon Resource Name (ARN) of the rule evaluation job.

" - } - }, - "ProcessingJobName": { - "base": null, - "refs": { - "CreateProcessingJobRequest$ProcessingJobName": "

The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

", - "DataQualityBaselineConfig$BaseliningJobName": "

The name of the job that performs baselining for the data quality monitoring job.

", - "DeleteProcessingJobRequest$ProcessingJobName": "

The name of the processing job to delete.

", - "DescribeProcessingJobRequest$ProcessingJobName": "

The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

", - "DescribeProcessingJobResponse$ProcessingJobName": "

The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

", - "ModelBiasBaselineConfig$BaseliningJobName": "

The name of the baseline model bias job.

", - "ModelExplainabilityBaselineConfig$BaseliningJobName": "

The name of the baseline model explainability job.

", - "ModelQualityBaselineConfig$BaseliningJobName": "

The name of the job that performs baselining for the monitoring job.

", - "MonitoringBaselineConfig$BaseliningJobName": "

The name of the job that performs baselining for the monitoring job.

", - "ProcessingJob$ProcessingJobName": "

The name of the processing job.

", - "ProcessingJobSummary$ProcessingJobName": "

The name of the processing job.

", - "StopProcessingJobRequest$ProcessingJobName": "

The name of the processing job to stop.

" - } - }, - "ProcessingJobStatus": { - "base": null, - "refs": { - "DescribeProcessingJobResponse$ProcessingJobStatus": "

Provides the status of a processing job.

", - "ListProcessingJobsRequest$StatusEquals": "

A filter that retrieves only processing jobs with a specific status.

", - "ProcessingJob$ProcessingJobStatus": "

The status of the processing job.

", - "ProcessingJobSummary$ProcessingJobStatus": "

The status of the processing job.

" - } - }, - "ProcessingJobStepMetadata": { - "base": "

Metadata for a processing job step.

", - "refs": { - "PipelineExecutionStepMetadata$ProcessingJob": "

The Amazon Resource Name (ARN) of the processing job that was run by this step execution.

" - } - }, - "ProcessingJobSummaries": { - "base": null, - "refs": { - "ListProcessingJobsResponse$ProcessingJobSummaries": "

An array of ProcessingJobSummary objects, each listing a processing job.

" - } - }, - "ProcessingJobSummary": { - "base": "

Summary of information about a processing job.

", - "refs": { - "ProcessingJobSummaries$member": null - } - }, - "ProcessingLocalPath": { - "base": null, - "refs": { - "BatchTransformInput$LocalPath": "

Path to the filesystem where the batch transform data is available to the container.

", - "DatasetDefinition$LocalPath": "

The local path where you want Amazon SageMaker to download the Dataset Definition inputs to run a processing job. LocalPath is an absolute path to the input data. This is a required parameter when AppManaged is False (default).

", - "EndpointInput$LocalPath": "

Path to the filesystem where the endpoint data is available to the container.

", - "MonitoringS3Output$LocalPath": "

The local path to the Amazon S3 storage location where Amazon SageMaker AI saves the results of a monitoring job. LocalPath is an absolute path for the output data.

", - "ProcessingS3Input$LocalPath": "

The local path in your container where you want Amazon SageMaker to write input data to. LocalPath is an absolute path to the input data and must begin with /opt/ml/processing/. LocalPath is a required parameter when AppManaged is False (default).

", - "ProcessingS3Output$LocalPath": "

The local path of a directory where you want Amazon SageMaker to upload its contents to Amazon S3. LocalPath is an absolute path to a directory containing output files. This directory will be created by the platform and exist when your container's entrypoint is invoked.

" - } - }, - "ProcessingMaxRuntimeInSeconds": { - "base": null, - "refs": { - "ProcessingStoppingCondition$MaxRuntimeInSeconds": "

Specifies the maximum runtime in seconds.

" - } - }, - "ProcessingOutput": { - "base": "

Describes the results of a processing job. The processing output must specify exactly one of either S3Output or FeatureStoreOutput types.

", - "refs": { - "ProcessingOutputs$member": null - } - }, - "ProcessingOutputConfig": { - "base": "

Configuration for uploading output from the processing container.

", - "refs": { - "CreateProcessingJobRequest$ProcessingOutputConfig": "

Output configuration for the processing job.

", - "DescribeProcessingJobResponse$ProcessingOutputConfig": "

Output configuration for the processing job.

", - "ProcessingJob$ProcessingOutputConfig": null - } - }, - "ProcessingOutputs": { - "base": null, - "refs": { - "ProcessingOutputConfig$Outputs": "

An array of outputs configuring the data to upload from the processing container.

" - } - }, - "ProcessingResources": { - "base": "

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.

", - "refs": { - "CreateProcessingJobRequest$ProcessingResources": "

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.

", - "DescribeProcessingJobResponse$ProcessingResources": "

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.

", - "ProcessingJob$ProcessingResources": null - } - }, - "ProcessingS3CompressionType": { - "base": null, - "refs": { - "ProcessingS3Input$S3CompressionType": "

Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing container. Gzip can only be used when Pipe mode is specified as the S3InputMode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your container without using the EBS volume.

" - } - }, - "ProcessingS3DataDistributionType": { - "base": null, - "refs": { - "BatchTransformInput$S3DataDistributionType": "

Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defaults to FullyReplicated

", - "EndpointInput$S3DataDistributionType": "

Whether input data distributed in Amazon S3 is fully replicated or sharded by an Amazon S3 key. Defaults to FullyReplicated

", - "ProcessingS3Input$S3DataDistributionType": "

Whether to distribute the data from Amazon S3 to all processing instances with FullyReplicated, or whether the data from Amazon S3 is sharded by Amazon S3 key, downloading one shard of data to each processing instance.

" - } - }, - "ProcessingS3DataType": { - "base": null, - "refs": { - "ProcessingS3Input$S3DataType": "

Whether you use an S3Prefix or a ManifestFile for the data type. If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for the processing job. If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for the processing job.

" - } - }, - "ProcessingS3Input": { - "base": "

Configuration for downloading input data from Amazon S3 into the processing container.

", - "refs": { - "ProcessingInput$S3Input": "

Configuration for downloading input data from Amazon S3 into the processing container.

" - } - }, - "ProcessingS3InputMode": { - "base": null, - "refs": { - "BatchTransformInput$S3InputMode": "

Whether the Pipe or File is used as the input mode for transferring data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File.

", - "EndpointInput$S3InputMode": "

Whether the Pipe or File is used as the input mode for transferring data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File.

", - "ProcessingS3Input$S3InputMode": "

Whether to use File or Pipe input mode. In File mode, Amazon SageMaker copies the data from the input source onto the local ML storage volume before starting your processing container. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your processing container into named pipes without using the ML storage volume.

" - } - }, - "ProcessingS3Output": { - "base": "

Configuration for uploading output data to Amazon S3 from the processing container.

", - "refs": { - "ProcessingOutput$S3Output": "

Configuration for processing job outputs in Amazon S3.

" - } - }, - "ProcessingS3UploadMode": { - "base": null, - "refs": { - "MonitoringS3Output$S3UploadMode": "

Whether to upload the results of the monitoring job continuously or after the job completes.

", - "ProcessingS3Output$S3UploadMode": "

Whether to upload the results of the processing job continuously or after the job completes.

" - } - }, - "ProcessingStoppingCondition": { - "base": "

Configures conditions under which the processing job should be stopped, such as how long the processing job has been running. After the condition is met, the processing job is stopped.

", - "refs": { - "CreateProcessingJobRequest$StoppingCondition": "

The time limit for how long the processing job is allowed to run.

", - "DescribeProcessingJobResponse$StoppingCondition": "

The time limit for how long the processing job is allowed to run.

", - "ProcessingJob$StoppingCondition": null - } - }, - "ProcessingVolumeSizeInGB": { - "base": null, - "refs": { - "MonitoringClusterConfig$VolumeSizeInGB": "

The size of the ML storage volume, in gigabytes, that you want to provision. You must specify sufficient ML storage for your scenario.

", - "ProcessingClusterConfig$VolumeSizeInGB": "

The size of the ML storage volume in gigabytes that you want to provision. You must specify sufficient ML storage for your scenario.

Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for processing, Amazon SageMaker mounts the local instance storage instead of Amazon EBS gp2 storage. You can't request a VolumeSizeInGB greater than the total size of the local instance storage.

For a list of instance types that support local instance storage, including the total size per instance type, see Instance Store Volumes.

" - } - }, - "Processor": { - "base": null, - "refs": { - "CreateImageVersionRequest$Processor": "

Indicates CPU or GPU compatibility.

  • CPU: The image version is compatible with CPU.

  • GPU: The image version is compatible with GPU.

", - "DescribeImageVersionResponse$Processor": "

Indicates CPU or GPU compatibility.

  • CPU: The image version is compatible with CPU.

  • GPU: The image version is compatible with GPU.

", - "UpdateImageVersionRequest$Processor": "

Indicates CPU or GPU compatibility.

  • CPU: The image version is compatible with CPU.

  • GPU: The image version is compatible with GPU.

" - } - }, - "ProductId": { - "base": null, - "refs": { - "DescribeAlgorithmOutput$ProductId": "

The product identifier of the algorithm.

", - "ModelPackageContainerDefinition$ProductId": "

The Amazon Web Services Marketplace product ID of the model package.

" - } - }, - "ProductListings": { - "base": null, - "refs": { - "Workteam$ProductListingIds": "

The Amazon Marketplace identifier for a vendor's work team.

" - } - }, - "ProductionVariant": { - "base": "

Identifies a model that you want to host and the resources chosen to deploy for hosting it. If you are deploying multiple models, tell SageMaker how to distribute traffic among the models by specifying variant weights. For more information on production variants, check Production variants.

", - "refs": { - "ProductionVariantList$member": null - } - }, - "ProductionVariantAcceleratorType": { - "base": null, - "refs": { - "PendingProductionVariantSummary$AcceleratorType": "

This parameter is no longer supported. Elastic Inference (EI) is no longer available.

This parameter was used to specify the size of the EI instance to use for the production variant.

", - "ProductionVariant$AcceleratorType": "

This parameter is no longer supported. Elastic Inference (EI) is no longer available.

This parameter was used to specify the size of the EI instance to use for the production variant.

" - } - }, - "ProductionVariantCapacityReservationConfig": { - "base": "

Settings for the capacity reservation for the compute instances that SageMaker AI reserves for an endpoint.

", - "refs": { - "ProductionVariant$CapacityReservationConfig": "

Settings for the capacity reservation for the compute instances that SageMaker AI reserves for an endpoint.

" - } - }, - "ProductionVariantCapacityReservationSummary": { - "base": "

Details about an ML capacity reservation.

", - "refs": { - "ProductionVariantSummary$CapacityReservationConfig": "

Settings for the capacity reservation for the compute instances that SageMaker AI reserves for an endpoint.

" - } - }, - "ProductionVariantContainerStartupHealthCheckTimeoutInSeconds": { - "base": null, - "refs": { - "InferenceComponentStartupParameters$ContainerStartupHealthCheckTimeoutInSeconds": "

The timeout value, in seconds, for your inference container to pass health check by Amazon S3 Hosting. For more information about health check, see How Your Container Should Respond to Health Check (Ping) Requests.

", - "ProductionVariant$ContainerStartupHealthCheckTimeoutInSeconds": "

The timeout value, in seconds, for your inference container to pass health check by SageMaker Hosting. For more information about health check, see How Your Container Should Respond to Health Check (Ping) Requests.

" - } - }, - "ProductionVariantCoreDumpConfig": { - "base": "

Specifies configuration for a core dump from the model container when the process crashes.

", - "refs": { - "ProductionVariant$CoreDumpConfig": "

Specifies configuration for a core dump from the model container when the process crashes.

" - } - }, - "ProductionVariantInferenceAmiVersion": { - "base": null, - "refs": { - "ProductionVariant$InferenceAmiVersion": "

Specifies an option from a collection of preconfigured Amazon Machine Image (AMI) images. Each image is configured by Amazon Web Services with a set of software and driver versions. Amazon Web Services optimizes these configurations for different machine learning workloads.

By selecting an AMI version, you can ensure that your inference environment is compatible with specific software requirements, such as CUDA driver versions, Linux kernel versions, or Amazon Web Services Neuron driver versions.

The AMI version names, and their configurations, are the following:

al2-ami-sagemaker-inference-gpu-2

  • Accelerator: GPU

  • NVIDIA driver version: 535

  • CUDA version: 12.2

al2-ami-sagemaker-inference-gpu-2-1

  • Accelerator: GPU

  • NVIDIA driver version: 535

  • CUDA version: 12.2

  • NVIDIA Container Toolkit with disabled CUDA-compat mounting

al2-ami-sagemaker-inference-gpu-3-1

  • Accelerator: GPU

  • NVIDIA driver version: 550

  • CUDA version: 12.4

  • NVIDIA Container Toolkit with disabled CUDA-compat mounting

al2023-ami-sagemaker-inference-gpu-4-1

  • Accelerator: GPU

  • NVIDIA driver version: 580

  • CUDA version: 13.0

  • NVIDIA Container Toolkit with disabled CUDA-compat mounting

al2-ami-sagemaker-inference-neuron-2

  • Accelerator: Inferentia2 and Trainium

  • Neuron driver version: 2.19

" - } - }, - "ProductionVariantInstanceType": { - "base": null, - "refs": { - "EndpointInputConfiguration$InstanceType": "

The instance types to use for the load test.

", - "EndpointOutputConfiguration$InstanceType": "

The instance type recommended by Amazon SageMaker Inference Recommender.

", - "InferenceComponentPlacementStatus$InstanceType": "

The ML compute instance type where the inference component copies are placed.

", - "InferenceComponentSpecification$InstanceType": "

The ML compute instance type for the inference component specification. Specifies which instance type this specification applies to. Required when using the Specifications parameter with multiple entries.

", - "InferenceComponentSpecificationSummary$InstanceType": "

The ML compute instance type associated with this inference component specification.

", - "InstancePool$InstanceType": "

The ML compute instance type for the instance pool.

", - "InstancePoolSummary$InstanceType": "

The ML compute instance type for the instance pool.

", - "PendingProductionVariantSummary$InstanceType": "

The type of instances associated with the variant.

", - "ProductionVariant$InstanceType": "

The ML compute instance type.

", - "RealTimeInferenceConfig$InstanceType": "

The instance type the model is deployed to.

", - "RealTimeInferenceRecommendation$InstanceType": "

The recommended instance type for Real-Time Inference.

", - "RealtimeInferenceInstanceTypes$member": null - } - }, - "ProductionVariantList": { - "base": null, - "refs": { - "CreateEndpointConfigInput$ProductionVariants": "

An array of ProductionVariant objects, one for each model that you want to host at this endpoint.

", - "CreateEndpointConfigInput$ShadowProductionVariants": "

An array of ProductionVariant objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants. If you use this field, you can only specify one variant for ProductionVariants and one variant for ShadowProductionVariants.

", - "DescribeEndpointConfigOutput$ProductionVariants": "

An array of ProductionVariant objects, one for each model that you want to host at this endpoint.

", - "DescribeEndpointConfigOutput$ShadowProductionVariants": "

An array of ProductionVariant objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants.

" - } - }, - "ProductionVariantManagedInstanceScaling": { - "base": "

Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.

", - "refs": { - "PendingProductionVariantSummary$ManagedInstanceScaling": "

Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.

", - "ProductionVariant$ManagedInstanceScaling": "

Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.

", - "ProductionVariantSummary$ManagedInstanceScaling": "

Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.

" - } - }, - "ProductionVariantManagedInstanceScalingScaleInPolicy": { - "base": "

Configures the scale-in behavior for managed instance scaling.

", - "refs": { - "ProductionVariantManagedInstanceScaling$ScaleInPolicy": "

Configures the scale-in behavior for managed instance scaling.

" - } - }, - "ProductionVariantModelDataDownloadTimeoutInSeconds": { - "base": null, - "refs": { - "InferenceComponentStartupParameters$ModelDataDownloadTimeoutInSeconds": "

The timeout value, in seconds, to download and extract the model that you want to host from Amazon S3 to the individual inference instance associated with this inference component.

", - "ProductionVariant$ModelDataDownloadTimeoutInSeconds": "

The timeout value, in seconds, to download and extract the model that you want to host from Amazon S3 to the individual inference instance associated with this production variant.

" - } - }, - "ProductionVariantRoutingConfig": { - "base": "

Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.

", - "refs": { - "PendingProductionVariantSummary$RoutingConfig": "

Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.

", - "ProductionVariant$RoutingConfig": "

Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.

", - "ProductionVariantSummary$RoutingConfig": "

Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.

" - } - }, - "ProductionVariantSSMAccess": { - "base": null, - "refs": { - "ProductionVariant$EnableSSMAccess": "

You can use this parameter to turn on native Amazon Web Services Systems Manager (SSM) access for a production variant behind an endpoint. By default, SSM access is disabled for all production variants behind an endpoint. You can turn on or turn off SSM access for a production variant behind an existing endpoint by creating a new endpoint configuration and calling UpdateEndpoint.

" - } - }, - "ProductionVariantServerlessConfig": { - "base": "

Specifies the serverless configuration for an endpoint variant.

", - "refs": { - "EndpointInputConfiguration$ServerlessConfig": null, - "EndpointOutputConfiguration$ServerlessConfig": null, - "PendingProductionVariantSummary$CurrentServerlessConfig": "

The serverless configuration for the endpoint.

", - "PendingProductionVariantSummary$DesiredServerlessConfig": "

The serverless configuration requested for this deployment, as specified in the endpoint configuration for the endpoint.

", - "ProductionVariant$ServerlessConfig": "

The serverless configuration for an endpoint. Specifies a serverless endpoint configuration instead of an instance-based endpoint configuration.

", - "ProductionVariantSummary$CurrentServerlessConfig": "

The serverless configuration for the endpoint.

", - "ProductionVariantSummary$DesiredServerlessConfig": "

The serverless configuration requested for the endpoint update.

" - } - }, - "ProductionVariantServerlessUpdateConfig": { - "base": "

Specifies the serverless update concurrency configuration for an endpoint variant.

", - "refs": { - "DesiredWeightAndCapacity$ServerlessUpdateConfig": "

Specifies the serverless update concurrency configuration for an endpoint variant.

" - } - }, - "ProductionVariantStatus": { - "base": "

Describes the status of the production variant.

", - "refs": { - "ProductionVariantStatusList$member": null - } - }, - "ProductionVariantStatusList": { - "base": null, - "refs": { - "PendingProductionVariantSummary$VariantStatus": "

The endpoint variant status which describes the current deployment stage status or operational status.

", - "ProductionVariantSummary$VariantStatus": "

The endpoint variant status which describes the current deployment stage status or operational status.

" - } - }, - "ProductionVariantSummary": { - "base": "

Describes weight and capacities for a production variant associated with an endpoint. If you sent a request to the UpdateEndpointWeightsAndCapacities API and the endpoint status is Updating, you get different desired and current values.

", - "refs": { - "ProductionVariantSummaryList$member": null - } - }, - "ProductionVariantSummaryList": { - "base": null, - "refs": { - "DescribeEndpointOutput$ProductionVariants": "

An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.

", - "DescribeEndpointOutput$ShadowProductionVariants": "

An array of ProductionVariantSummary objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants.

", - "Endpoint$ProductionVariants": "

A list of the production variants hosted on the endpoint. Each production variant is a model.

", - "Endpoint$ShadowProductionVariants": "

A list of the shadow variants hosted on the endpoint. Each shadow variant is a model in shadow mode with production traffic replicated from the production variant.

" - } - }, - "ProductionVariantVolumeSizeInGB": { - "base": null, - "refs": { - "ProductionVariant$VolumeSizeInGB": "

The size, in GB, of the ML storage volume attached to individual inference instance associated with the production variant. Currently only Amazon EBS gp2 storage volumes are supported.

" - } - }, - "ProfilerConfig": { - "base": "

Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and storage paths.

", - "refs": { - "CreateTrainingJobRequest$ProfilerConfig": null, - "DescribeTrainingJobResponse$ProfilerConfig": null, - "TrainingJob$ProfilerConfig": null - } - }, - "ProfilerConfigForUpdate": { - "base": "

Configuration information for updating the Amazon SageMaker Debugger profile parameters, system and framework metrics configurations, and storage paths.

", - "refs": { - "UpdateTrainingJobRequest$ProfilerConfig": "

Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and storage paths.

" - } - }, - "ProfilerRuleConfiguration": { - "base": "

Configuration information for profiling rules.

", - "refs": { - "ProfilerRuleConfigurations$member": null - } - }, - "ProfilerRuleConfigurations": { - "base": null, - "refs": { - "CreateTrainingJobRequest$ProfilerRuleConfigurations": "

Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics.

", - "DescribeTrainingJobResponse$ProfilerRuleConfigurations": "

Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics.

", - "UpdateTrainingJobRequest$ProfilerRuleConfigurations": "

Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics.

" - } - }, - "ProfilerRuleEvaluationStatus": { - "base": "

Information about the status of the rule evaluation.

", - "refs": { - "ProfilerRuleEvaluationStatuses$member": null - } - }, - "ProfilerRuleEvaluationStatuses": { - "base": null, - "refs": { - "DescribeTrainingJobResponse$ProfilerRuleEvaluationStatuses": "

Evaluation status of Amazon SageMaker Debugger rules for profiling on a training job.

" - } - }, - "ProfilingIntervalInMilliseconds": { - "base": null, - "refs": { - "ProfilerConfig$ProfilingIntervalInMilliseconds": "

A time interval for capturing system metrics in milliseconds. Available values are 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.

", - "ProfilerConfigForUpdate$ProfilingIntervalInMilliseconds": "

A time interval for capturing system metrics in milliseconds. Available values are 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.

" - } - }, - "ProfilingParameters": { - "base": null, - "refs": { - "ProfilerConfig$ProfilingParameters": "

Configuration information for capturing framework metrics. Available key strings for different profiling options are DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig. The following codes are configuration structures for the ProfilingParameters parameter. To learn more about how to configure the ProfilingParameters parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

", - "ProfilerConfigForUpdate$ProfilingParameters": "

Configuration information for capturing framework metrics. Available key strings for different profiling options are DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig. The following codes are configuration structures for the ProfilingParameters parameter. To learn more about how to configure the ProfilingParameters parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

" - } - }, - "ProfilingStatus": { - "base": null, - "refs": { - "DescribeTrainingJobResponse$ProfilingStatus": "

Profiling status of a training job.

" - } - }, - "ProgrammingLang": { - "base": null, - "refs": { - "CreateImageVersionRequest$ProgrammingLang": "

The supported programming language and its version.

", - "DescribeImageVersionResponse$ProgrammingLang": "

The supported programming language and its version.

", - "UpdateImageVersionRequest$ProgrammingLang": "

The supported programming language and its version.

" - } - }, - "Project": { - "base": "

The properties of a project as returned by the Search API.

", - "refs": { - "SearchRecord$Project": "

The properties of a project.

" - } - }, - "ProjectArn": { - "base": null, - "refs": { - "CreateProjectOutput$ProjectArn": "

The Amazon Resource Name (ARN) of the project.

", - "DescribeProjectOutput$ProjectArn": "

The Amazon Resource Name (ARN) of the project.

", - "Project$ProjectArn": "

The Amazon Resource Name (ARN) of the project.

", - "ProjectSummary$ProjectArn": "

The Amazon Resource Name (ARN) of the project.

", - "UpdateProjectOutput$ProjectArn": "

The Amazon Resource Name (ARN) of the project.

" - } - }, - "ProjectEntityName": { - "base": null, - "refs": { - "CreateProjectInput$ProjectName": "

The name of the project.

", - "DeleteProjectInput$ProjectName": "

The name of the project to delete.

", - "DescribeProjectInput$ProjectName": "

The name of the project to describe.

", - "DescribeProjectOutput$ProjectName": "

The name of the project.

", - "ListProjectsInput$NameContains": "

A filter that returns the projects whose name contains a specified string.

", - "Project$ProjectName": "

The name of the project.

", - "ProjectSummary$ProjectName": "

The name of the project.

", - "UpdateProjectInput$ProjectName": "

The name of the project.

" - } - }, - "ProjectId": { - "base": null, - "refs": { - "CreateProjectOutput$ProjectId": "

The ID of the new project.

", - "DescribeProjectOutput$ProjectId": "

The ID of the project.

", - "Project$ProjectId": "

The ID of the project.

", - "ProjectSummary$ProjectId": "

The ID of the project.

" - } - }, - "ProjectSortBy": { - "base": null, - "refs": { - "ListProjectsInput$SortBy": "

The field by which to sort results. The default is CreationTime.

" - } - }, - "ProjectSortOrder": { - "base": null, - "refs": { - "ListProjectsInput$SortOrder": "

The sort order for results. The default is Ascending.

" - } - }, - "ProjectStatus": { - "base": null, - "refs": { - "DescribeProjectOutput$ProjectStatus": "

The status of the project.

", - "Project$ProjectStatus": "

The status of the project.

", - "ProjectSummary$ProjectStatus": "

The status of the project.

" - } - }, - "ProjectSummary": { - "base": "

Information about a project.

", - "refs": { - "ProjectSummaryList$member": null - } - }, - "ProjectSummaryList": { - "base": null, - "refs": { - "ListProjectsOutput$ProjectSummaryList": "

A list of summaries of projects.

" - } - }, - "PropertyNameHint": { - "base": null, - "refs": { - "PropertyNameQuery$PropertyNameHint": "

Text that begins a property's name.

" - } - }, - "PropertyNameQuery": { - "base": "

Part of the SuggestionQuery type. Specifies a hint for retrieving property names that begin with the specified text.

", - "refs": { - "SuggestionQuery$PropertyNameQuery": "

Defines a property name hint. Only property names that begin with the specified hint are included in the response.

" - } - }, - "PropertyNameSuggestion": { - "base": "

A property name returned from a GetSearchSuggestions call that specifies a value in the PropertyNameQuery field.

", - "refs": { - "PropertyNameSuggestionList$member": null - } - }, - "PropertyNameSuggestionList": { - "base": null, - "refs": { - "GetSearchSuggestionsResponse$PropertyNameSuggestions": "

A list of property names for a Resource that match a SuggestionQuery.

" - } - }, - "ProvisionedProductStatusMessage": { - "base": null, - "refs": { - "ServiceCatalogProvisionedProductDetails$ProvisionedProductStatusMessage": "

The current status of the product.

  • AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.

  • UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.

  • TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.

  • ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.

  • PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.

" - } - }, - "ProvisioningParameter": { - "base": "

A key value pair used when you provision a project as a service catalog product. For information, see What is Amazon Web Services Service Catalog.

", - "refs": { - "ProvisioningParameters$member": null - } - }, - "ProvisioningParameterKey": { - "base": null, - "refs": { - "ProvisioningParameter$Key": "

The key that identifies a provisioning parameter.

" - } - }, - "ProvisioningParameterValue": { - "base": null, - "refs": { - "ProvisioningParameter$Value": "

The value of the provisioning parameter.

" - } - }, - "ProvisioningParameters": { - "base": null, - "refs": { - "ServiceCatalogProvisioningDetails$ProvisioningParameters": "

A list of key value pairs that you specify when you provision a product.

", - "ServiceCatalogProvisioningUpdateDetails$ProvisioningParameters": "

A list of key value pairs that you specify when you provision a product.

" - } - }, - "PublicWorkforceTaskPrice": { - "base": "

Defines the amount of money paid to an Amazon Mechanical Turk worker for each task performed.

Use one of the following prices for bounding box tasks. Prices are in US dollars and should be based on the complexity of the task; the longer it takes in your initial testing, the more you should offer.

  • 0.036

  • 0.048

  • 0.060

  • 0.072

  • 0.120

  • 0.240

  • 0.360

  • 0.480

  • 0.600

  • 0.720

  • 0.840

  • 0.960

  • 1.080

  • 1.200

Use one of the following prices for image classification, text classification, and custom tasks. Prices are in US dollars.

  • 0.012

  • 0.024

  • 0.036

  • 0.048

  • 0.060

  • 0.072

  • 0.120

  • 0.240

  • 0.360

  • 0.480

  • 0.600

  • 0.720

  • 0.840

  • 0.960

  • 1.080

  • 1.200

Use one of the following prices for semantic segmentation tasks. Prices are in US dollars.

  • 0.840

  • 0.960

  • 1.080

  • 1.200

Use one of the following prices for Textract AnalyzeDocument Important Form Key Amazon Augmented AI review tasks. Prices are in US dollars.

  • 2.400

  • 2.280

  • 2.160

  • 2.040

  • 1.920

  • 1.800

  • 1.680

  • 1.560

  • 1.440

  • 1.320

  • 1.200

  • 1.080

  • 0.960

  • 0.840

  • 0.720

  • 0.600

  • 0.480

  • 0.360

  • 0.240

  • 0.120

  • 0.072

  • 0.060

  • 0.048

  • 0.036

  • 0.024

  • 0.012

Use one of the following prices for Rekognition DetectModerationLabels Amazon Augmented AI review tasks. Prices are in US dollars.

  • 1.200

  • 1.080

  • 0.960

  • 0.840

  • 0.720

  • 0.600

  • 0.480

  • 0.360

  • 0.240

  • 0.120

  • 0.072

  • 0.060

  • 0.048

  • 0.036

  • 0.024

  • 0.012

Use one of the following prices for Amazon Augmented AI custom human review tasks. Prices are in US dollars.

  • 1.200

  • 1.080

  • 0.960

  • 0.840

  • 0.720

  • 0.600

  • 0.480

  • 0.360

  • 0.240

  • 0.120

  • 0.072

  • 0.060

  • 0.048

  • 0.036

  • 0.024

  • 0.012

", - "refs": { - "HumanLoopConfig$PublicWorkforceTaskPrice": null, - "HumanTaskConfig$PublicWorkforceTaskPrice": "

The price that you pay for each task performed by an Amazon Mechanical Turk worker.

" - } - }, - "PutModelPackageGroupPolicyInput": { - "base": null, - "refs": {} - }, - "PutModelPackageGroupPolicyOutput": { - "base": null, - "refs": {} - }, - "QProfileArn": { - "base": null, - "refs": { - "AmazonQSettings$QProfileArn": "

The ARN of the Amazon Q profile used within the domain.

" - } - }, - "QualityCheckStepMetadata": { - "base": "

Container for the metadata for a Quality check step. For more information, see the topic on QualityCheck step in the Amazon SageMaker Developer Guide.

", - "refs": { - "PipelineExecutionStepMetadata$QualityCheck": "

The configurations and outcomes of the check step execution. This includes:

  • The type of the check conducted.

  • The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.

  • The Amazon S3 URIs of newly calculated baseline constraints and statistics.

  • The model package group name provided.

  • The Amazon S3 URI of the violation report if violations detected.

  • The Amazon Resource Name (ARN) of check processing job initiated by the step execution.

  • The Boolean flags indicating if the drift check is skipped.

  • If step property BaselineUsedForDriftCheck is set the same as CalculatedBaseline.

" - } - }, - "QueryFilters": { - "base": "

A set of filters to narrow the set of lineage entities connected to the StartArn(s) returned by the QueryLineage API action.

", - "refs": { - "QueryLineageRequest$Filters": "

A set of filtering parameters that allow you to specify which entities should be returned.

  • Properties - Key-value pairs to match on the lineage entities' properties.

  • LineageTypes - A set of lineage entity types to match on. For example: TrialComponent, Artifact, or Context.

  • CreatedBefore - Filter entities created before this date.

  • ModifiedBefore - Filter entities modified before this date.

  • ModifiedAfter - Filter entities modified after this date.

" - } - }, - "QueryLineageMaxDepth": { - "base": null, - "refs": { - "QueryLineageRequest$MaxDepth": "

The maximum depth in lineage relationships from the StartArns that are traversed. Depth is a measure of the number of Associations from the StartArn entity to the matched results.

" - } - }, - "QueryLineageMaxResults": { - "base": null, - "refs": { - "QueryLineageRequest$MaxResults": "

Limits the number of vertices in the results. Use the NextToken in a response to to retrieve the next page of results.

" - } - }, - "QueryLineageRequest": { - "base": null, - "refs": {} - }, - "QueryLineageResponse": { - "base": null, - "refs": {} - }, - "QueryLineageStartArns": { - "base": null, - "refs": { - "QueryLineageRequest$StartArns": "

A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.

" - } - }, - "QueryLineageTypes": { - "base": null, - "refs": { - "QueryFilters$LineageTypes": "

Filter the lineage entities connected to the StartArn(s) by the type of the lineage entity.

" - } - }, - "QueryProperties": { - "base": null, - "refs": { - "QueryFilters$Properties": "

Filter the lineage entities connected to the StartArn(s) by a set if property key value pairs. If multiple pairs are provided, an entity is included in the results if it matches any of the provided pairs.

" - } - }, - "QueryTypes": { - "base": null, - "refs": { - "QueryFilters$Types": "

Filter the lineage entities connected to the StartArn by type. For example: DataSet, Model, Endpoint, or ModelDeployment.

" - } - }, - "RSessionAppSettings": { - "base": "

A collection of settings that apply to an RSessionGateway app.

", - "refs": { - "UserSettings$RSessionAppSettings": "

A collection of settings that configure the RSessionGateway app.

" - } - }, - "RStudioServerProAccessStatus": { - "base": null, - "refs": { - "RStudioServerProAppSettings$AccessStatus": "

Indicates whether the current user has access to the RStudioServerPro app.

" - } - }, - "RStudioServerProAppSettings": { - "base": "

A collection of settings that configure user interaction with the RStudioServerPro app.

", - "refs": { - "UserSettings$RStudioServerProAppSettings": "

A collection of settings that configure user interaction with the RStudioServerPro app.

" - } - }, - "RStudioServerProDomainSettings": { - "base": "

A collection of settings that configure the RStudioServerPro Domain-level app.

", - "refs": { - "DomainSettings$RStudioServerProDomainSettings": "

A collection of settings that configure the RStudioServerPro Domain-level app.

" - } - }, - "RStudioServerProDomainSettingsForUpdate": { - "base": "

A collection of settings that update the current configuration for the RStudioServerPro Domain-level app.

", - "refs": { - "DomainSettingsForUpdate$RStudioServerProDomainSettingsForUpdate": "

A collection of RStudioServerPro Domain-level app settings to update. A single RStudioServerPro application is created for a domain.

" - } - }, - "RStudioServerProUserGroup": { - "base": null, - "refs": { - "RStudioServerProAppSettings$UserGroup": "

The level of permissions that the user has within the RStudioServerPro app. This value defaults to `User`. The `Admin` value allows the user access to the RStudio Administrative Dashboard.

" - } - }, - "RandomSeed": { - "base": null, - "refs": { - "HyperParameterTuningJobConfig$RandomSeed": "

A value used to initialize a pseudo-random number generator. Setting a random seed and using the same seed later for the same tuning job will allow hyperparameter optimization to find more a consistent hyperparameter configuration between the two runs.

" - } - }, - "RealTimeInferenceConfig": { - "base": "

The infrastructure configuration for deploying the model to a real-time inference endpoint.

", - "refs": { - "ModelInfrastructureConfig$RealTimeInferenceConfig": "

The infrastructure configuration for deploying the model to real-time inference.

" - } - }, - "RealTimeInferenceRecommendation": { - "base": "

The recommended configuration to use for Real-Time Inference.

", - "refs": { - "RealTimeInferenceRecommendations$member": null - } - }, - "RealTimeInferenceRecommendations": { - "base": null, - "refs": { - "DeploymentRecommendation$RealTimeInferenceRecommendations": "

A list of RealTimeInferenceRecommendation items.

" - } - }, - "RealtimeInferenceInstanceTypes": { - "base": null, - "refs": { - "AdditionalInferenceSpecificationDefinition$SupportedRealtimeInferenceInstanceTypes": "

A list of the instance types that are used to generate inferences in real-time.

", - "InferenceSpecification$SupportedRealtimeInferenceInstanceTypes": "

A list of the instance types that are used to generate inferences in real-time.

This parameter is required for unversioned models, and optional for versioned models.

" - } - }, - "RecipeName": { - "base": null, - "refs": { - "BaseModel$RecipeName": "

The recipe name of the base model.

" - } - }, - "RecommendationFailureReason": { - "base": null, - "refs": { - "RecommendationJobInferenceBenchmark$FailureReason": "

The reason why a benchmark failed.

" - } - }, - "RecommendationJobArn": { - "base": null, - "refs": { - "CreateInferenceRecommendationsJobResponse$JobArn": "

The Amazon Resource Name (ARN) of the recommendation job.

", - "DescribeInferenceRecommendationsJobResponse$JobArn": "

The Amazon Resource Name (ARN) of the job.

", - "InferenceRecommendationsJob$JobArn": "

The Amazon Resource Name (ARN) of the recommendation job.

" - } - }, - "RecommendationJobCompilationJobName": { - "base": null, - "refs": { - "ModelConfiguration$CompilationJobName": "

The name of the compilation job used to create the recommended model artifacts.

" - } - }, - "RecommendationJobCompiledOutputConfig": { - "base": "

Provides information about the output configuration for the compiled model.

", - "refs": { - "RecommendationJobOutputConfig$CompiledOutputConfig": "

Provides information about the output configuration for the compiled model.

" - } - }, - "RecommendationJobContainerConfig": { - "base": "

Specifies mandatory fields for running an Inference Recommender job directly in the CreateInferenceRecommendationsJob API. The fields specified in ContainerConfig override the corresponding fields in the model package. Use ContainerConfig if you want to specify these fields for the recommendation job but don't want to edit them in your model package.

", - "refs": { - "RecommendationJobInputConfig$ContainerConfig": "

Specifies mandatory fields for running an Inference Recommender job. The fields specified in ContainerConfig override the corresponding fields in the model package.

" - } - }, - "RecommendationJobDataInputConfig": { - "base": null, - "refs": { - "RecommendationJobContainerConfig$DataInputConfig": "

Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. This field is used for optimizing your model using SageMaker Neo. For more information, see DataInputConfig.

" - } - }, - "RecommendationJobDescription": { - "base": null, - "refs": { - "CreateInferenceRecommendationsJobRequest$JobDescription": "

Description of the recommendation job.

", - "DescribeInferenceRecommendationsJobResponse$JobDescription": "

The job description that you provided when you initiated the job.

", - "InferenceRecommendationsJob$JobDescription": "

The job description.

" - } - }, - "RecommendationJobFrameworkVersion": { - "base": null, - "refs": { - "RecommendationJobContainerConfig$FrameworkVersion": "

The framework version of the container image.

" - } - }, - "RecommendationJobInferenceBenchmark": { - "base": "

The details for a specific benchmark from an Inference Recommender job.

", - "refs": { - "InferenceRecommendationsJobStep$InferenceBenchmark": "

The details for a specific benchmark.

" - } - }, - "RecommendationJobInputConfig": { - "base": "

The input configuration of the recommendation job.

", - "refs": { - "CreateInferenceRecommendationsJobRequest$InputConfig": "

Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.

", - "DescribeInferenceRecommendationsJobResponse$InputConfig": "

Returns information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations you provided when you initiated the job.

" - } - }, - "RecommendationJobName": { - "base": null, - "refs": { - "CreateInferenceRecommendationsJobRequest$JobName": "

A name for the recommendation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account. The job name is passed down to the resources created by the recommendation job. The names of resources (such as the model, endpoint configuration, endpoint, and compilation) that are prefixed with the job name are truncated at 40 characters.

", - "DescribeInferenceRecommendationsJobRequest$JobName": "

The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

", - "DescribeInferenceRecommendationsJobResponse$JobName": "

The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

", - "GetScalingConfigurationRecommendationRequest$InferenceRecommendationsJobName": "

The name of a previously completed Inference Recommender job.

", - "GetScalingConfigurationRecommendationResponse$InferenceRecommendationsJobName": "

The name of a previously completed Inference Recommender job.

", - "InferenceRecommendationsJob$JobName": "

The name of the job.

", - "InferenceRecommendationsJobStep$JobName": "

The name of the Inference Recommender job.

", - "ListInferenceRecommendationsJobStepsRequest$JobName": "

The name for the Inference Recommender job.

", - "StopInferenceRecommendationsJobRequest$JobName": "

The name of the job you want to stop.

" - } - }, - "RecommendationJobOutputConfig": { - "base": "

Provides information about the output configuration for the compiled model.

", - "refs": { - "CreateInferenceRecommendationsJobRequest$OutputConfig": "

Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.

" - } - }, - "RecommendationJobPayloadConfig": { - "base": "

The configuration for the payload for a recommendation job.

", - "refs": { - "RecommendationJobContainerConfig$PayloadConfig": "

Specifies the SamplePayloadUrl and all other sample payload-related fields.

" - } - }, - "RecommendationJobResourceLimit": { - "base": "

Specifies the maximum number of jobs that can run in parallel and the maximum number of jobs that can run.

", - "refs": { - "RecommendationJobInputConfig$ResourceLimit": "

Defines the resource limit of the job.

" - } - }, - "RecommendationJobStatus": { - "base": null, - "refs": { - "DescribeInferenceRecommendationsJobResponse$Status": "

The status of the job.

", - "InferenceRecommendationsJob$Status": "

The status of the job.

", - "InferenceRecommendationsJobStep$Status": "

The current status of the benchmark.

", - "ListInferenceRecommendationsJobStepsRequest$Status": "

A filter to return benchmarks of a specified status. If this field is left empty, then all benchmarks are returned.

", - "ListInferenceRecommendationsJobsRequest$StatusEquals": "

A filter that retrieves only inference recommendations jobs with a specific status.

" - } - }, - "RecommendationJobStoppingConditions": { - "base": "

Specifies conditions for stopping a job. When a job reaches a stopping condition limit, SageMaker ends the job.

", - "refs": { - "CreateInferenceRecommendationsJobRequest$StoppingConditions": "

A set of conditions for stopping a recommendation job. If any of the conditions are met, the job is automatically stopped.

", - "DescribeInferenceRecommendationsJobResponse$StoppingConditions": "

The stopping conditions that you provided when you initiated the job.

" - } - }, - "RecommendationJobSupportedContentType": { - "base": null, - "refs": { - "RecommendationJobSupportedContentTypes$member": null - } - }, - "RecommendationJobSupportedContentTypes": { - "base": null, - "refs": { - "RecommendationJobPayloadConfig$SupportedContentTypes": "

The supported MIME types for the input data.

" - } - }, - "RecommendationJobSupportedEndpointType": { - "base": null, - "refs": { - "RecommendationJobContainerConfig$SupportedEndpointType": "

The endpoint type to receive recommendations for. By default this is null, and the results of the inference recommendation job return a combined list of both real-time and serverless benchmarks. By specifying a value for this field, you can receive a longer list of benchmarks for the desired endpoint type.

" - } - }, - "RecommendationJobSupportedInstanceTypes": { - "base": null, - "refs": { - "RecommendationJobContainerConfig$SupportedInstanceTypes": "

A list of the instance types that are used to generate inferences in real-time.

" - } - }, - "RecommendationJobSupportedResponseMIMEType": { - "base": null, - "refs": { - "RecommendationJobSupportedResponseMIMETypes$member": null - } - }, - "RecommendationJobSupportedResponseMIMETypes": { - "base": null, - "refs": { - "RecommendationJobContainerConfig$SupportedResponseMIMETypes": "

The supported MIME types for the output data.

" - } - }, - "RecommendationJobType": { - "base": null, - "refs": { - "CreateInferenceRecommendationsJobRequest$JobType": "

Defines the type of recommendation job. Specify Default to initiate an instance recommendation and Advanced to initiate a load test. If left unspecified, Amazon SageMaker Inference Recommender will run an instance recommendation (DEFAULT) job.

", - "DescribeInferenceRecommendationsJobResponse$JobType": "

The job type that you provided when you initiated the job.

", - "InferenceRecommendationsJob$JobType": "

The recommendation job type.

" - } - }, - "RecommendationJobVpcConfig": { - "base": "

Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.

", - "refs": { - "RecommendationJobInputConfig$VpcConfig": "

Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.

" - } - }, - "RecommendationJobVpcSecurityGroupId": { - "base": null, - "refs": { - "RecommendationJobVpcSecurityGroupIds$member": null - } - }, - "RecommendationJobVpcSecurityGroupIds": { - "base": null, - "refs": { - "RecommendationJobVpcConfig$SecurityGroupIds": "

The VPC security group IDs. IDs have the form of sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.

" - } - }, - "RecommendationJobVpcSubnetId": { - "base": null, - "refs": { - "RecommendationJobVpcSubnets$member": null - } - }, - "RecommendationJobVpcSubnets": { - "base": null, - "refs": { - "RecommendationJobVpcConfig$Subnets": "

The ID of the subnets in the VPC to which you want to connect your model.

" - } - }, - "RecommendationMetrics": { - "base": "

The metrics of recommendations.

", - "refs": { - "InferenceRecommendation$Metrics": "

The metrics used to decide what recommendation to make.

", - "RecommendationJobInferenceBenchmark$Metrics": null - } - }, - "RecommendationStatus": { - "base": null, - "refs": { - "DeploymentRecommendation$RecommendationStatus": "

Status of the deployment recommendation. The status NOT_APPLICABLE means that SageMaker is unable to provide a default recommendation for the model using the information provided. If the deployment status is IN_PROGRESS, retry your API call after a few seconds to get a COMPLETED deployment recommendation.

" - } - }, - "RecommendationStepType": { - "base": null, - "refs": { - "InferenceRecommendationsJobStep$StepType": "

The type of the subtask.

BENCHMARK: Evaluate the performance of your model on different instance types.

", - "ListInferenceRecommendationsJobStepsRequest$StepType": "

A filter to return details about the specified type of subtask.

BENCHMARK: Evaluate the performance of your model on different instance types.

" - } - }, - "RecordWrapper": { - "base": null, - "refs": { - "Channel$RecordWrapperType": "

Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don't need to set this attribute. For more information, see Create a Dataset Using RecordIO.

In File mode, leave this field unset or set it to None.

" - } - }, - "RedshiftClusterId": { - "base": "

The Redshift cluster Identifier.

", - "refs": { - "RedshiftDatasetDefinition$ClusterId": null - } - }, - "RedshiftDatabase": { - "base": "

The name of the Redshift database used in Redshift query execution.

", - "refs": { - "RedshiftDatasetDefinition$Database": null - } - }, - "RedshiftDatasetDefinition": { - "base": "

Configuration for Redshift Dataset Definition input.

", - "refs": { - "DatasetDefinition$RedshiftDatasetDefinition": null - } - }, - "RedshiftQueryString": { - "base": "

The SQL query statements to be executed.

", - "refs": { - "RedshiftDatasetDefinition$QueryString": null - } - }, - "RedshiftResultCompressionType": { - "base": "

The compression used for Redshift query results.

", - "refs": { - "RedshiftDatasetDefinition$OutputCompression": null - } - }, - "RedshiftResultFormat": { - "base": "

The data storage format for Redshift query results.

", - "refs": { - "RedshiftDatasetDefinition$OutputFormat": null - } - }, - "RedshiftUserName": { - "base": "

The database user name used in Redshift query execution.

", - "refs": { - "RedshiftDatasetDefinition$DbUser": null - } - }, - "ReferenceMinVersion": { - "base": null, - "refs": { - "DescribeHubContentResponse$ReferenceMinVersion": "

The minimum version of the hub content.

" - } - }, - "RegionName": { - "base": null, - "refs": { - "UnifiedStudioSettings$DomainRegion": "

The Amazon Web Services Region where the domain is located in Amazon SageMaker Unified Studio. The default value, if you don't specify a Region, is the Region where the Amazon SageMaker AI domain is located.

" - } - }, - "RegisterDevicesRequest": { - "base": null, - "refs": {} - }, - "RegisterModelStepMetadata": { - "base": "

Metadata for a register model job step.

", - "refs": { - "PipelineExecutionStepMetadata$RegisterModel": "

The Amazon Resource Name (ARN) of the model package that the model was registered to by this step execution.

" - } - }, - "Relation": { - "base": null, - "refs": { - "TotalHits$Relation": "

Indicates the relationship between the returned Value and the actual total number of matching results. Possible values are:

  • EqualTo: The Value is the exact count of matching results.

  • GreaterThanOrEqualTo: The Value is a lower bound of the actual count of matching results.

" - } - }, - "ReleaseNotes": { - "base": null, - "refs": { - "CreateImageVersionRequest$ReleaseNotes": "

The maintainer description of the image version.

", - "DescribeImageVersionResponse$ReleaseNotes": "

The maintainer description of the image version.

", - "UpdateImageVersionRequest$ReleaseNotes": "

The maintainer description of the image version.

" - } - }, - "ReleaseNotesList": { - "base": null, - "refs": { - "AvailableUpgrade$ReleaseNotes": "

A list of release notes describing the changes and improvements included in the available upgrade version.

" - } - }, - "RemoteDebugConfig": { - "base": "

Configuration for remote debugging for the CreateTrainingJob API. To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.

", - "refs": { - "CreateTrainingJobRequest$RemoteDebugConfig": "

Configuration for remote debugging. To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.

", - "DescribeTrainingJobResponse$RemoteDebugConfig": "

Configuration for remote debugging. To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.

" - } - }, - "RemoteDebugConfigForUpdate": { - "base": "

Configuration for remote debugging for the UpdateTrainingJob API. To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.

", - "refs": { - "UpdateTrainingJobRequest$RemoteDebugConfig": "

Configuration for remote debugging while the training job is running. You can update the remote debugging configuration when the SecondaryStatus of the job is Downloading or Training.To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.

" - } - }, - "RenderUiTemplateRequest": { - "base": null, - "refs": {} - }, - "RenderUiTemplateResponse": { - "base": null, - "refs": {} - }, - "RenderableTask": { - "base": "

Contains input values for a task.

", - "refs": { - "RenderUiTemplateRequest$Task": "

A RenderableTask object containing a representative task to render.

" - } - }, - "RenderingError": { - "base": "

A description of an error that occurred while rendering the template.

", - "refs": { - "RenderingErrorList$member": null - } - }, - "RenderingErrorList": { - "base": null, - "refs": { - "RenderUiTemplateResponse$Errors": "

A list of one or more RenderingError objects if any were encountered while rendering the template. If there were no errors, the list is empty.

" - } - }, - "RepositoryAccessMode": { - "base": null, - "refs": { - "ImageConfig$RepositoryAccessMode": "

Set this to one of the following values:

  • Platform - The model image is hosted in Amazon ECR.

  • Vpc - The model image is hosted in a private Docker registry in your VPC.

" - } - }, - "RepositoryAuthConfig": { - "base": "

Specifies an authentication configuration for the private docker registry where your model image is hosted. Specify a value for this property only if you specified Vpc as the value for the RepositoryAccessMode field of the ImageConfig object that you passed to a call to CreateModel and the private Docker registry where the model image is hosted requires authentication.

", - "refs": { - "ImageConfig$RepositoryAuthConfig": "

(Optional) Specifies an authentication configuration for the private docker registry where your model image is hosted. Specify a value for this property only if you specified Vpc as the value for the RepositoryAccessMode field, and the private Docker registry where the model image is hosted requires authentication.

" - } - }, - "RepositoryCredentialsProviderArn": { - "base": null, - "refs": { - "RepositoryAuthConfig$RepositoryCredentialsProviderArn": "

The Amazon Resource Name (ARN) of an Amazon Web Services Lambda function that provides credentials to authenticate to the private Docker registry where your model image is hosted. For information about how to create an Amazon Web Services Lambda function, see Create a Lambda function with the console in the Amazon Web Services Lambda Developer Guide.

" - } - }, - "RepositoryUrl": { - "base": null, - "refs": { - "CodeRepository$RepositoryUrl": "

The URL of the Git repository.

" - } - }, - "ReservedCapacityArn": { - "base": null, - "refs": { - "DescribeReservedCapacityRequest$ReservedCapacityArn": "

ARN of the reserved capacity to describe.

", - "DescribeReservedCapacityResponse$ReservedCapacityArn": "

ARN of the reserved capacity.

", - "ListUltraServersByReservedCapacityRequest$ReservedCapacityArn": "

The ARN of the reserved capacity to list UltraServers for.

", - "ReservedCapacitySummary$ReservedCapacityArn": "

The Amazon Resource Name (ARN); of the reserved capacity.

" - } - }, - "ReservedCapacityDurationHours": { - "base": null, - "refs": { - "DescribeReservedCapacityResponse$DurationHours": "

The total duration of the reserved capacity in hours.

", - "ReservedCapacityOffering$DurationHours": "

The number of whole hours in the total duration for this reserved capacity offering.

", - "ReservedCapacitySummary$DurationHours": "

The number of whole hours in the total duration for this reserved capacity.

" - } - }, - "ReservedCapacityDurationMinutes": { - "base": null, - "refs": { - "DescribeReservedCapacityResponse$DurationMinutes": "

The number of minutes for the duration of the reserved capacity. For example, if a reserved capacity starts at 08:55 and ends at 11:30, the minutes field would be 35.

", - "ReservedCapacityOffering$DurationMinutes": "

The additional minutes beyond whole hours in the total duration for this reserved capacity offering.

", - "ReservedCapacitySummary$DurationMinutes": "

The additional minutes beyond whole hours in the total duration for this reserved capacity.

" - } - }, - "ReservedCapacityInstanceCount": { - "base": null, - "refs": { - "ReservedCapacityOffering$InstanceCount": "

The number of instances in the reserved capacity offering.

", - "SearchTrainingPlanOfferingsRequest$InstanceCount": "

The number of instances you want to reserve in the training plan offerings. This allows you to specify the quantity of compute resources needed for your SageMaker training jobs or SageMaker HyperPod clusters, helping you find reserved capacity offerings that match your requirements.

" - } - }, - "ReservedCapacityInstanceType": { - "base": null, - "refs": { - "DescribeReservedCapacityResponse$InstanceType": "

The Amazon EC2 instance type used in the reserved capacity.

", - "ReservedCapacityOffering$InstanceType": "

The instance type for the reserved capacity offering.

", - "ReservedCapacitySummary$InstanceType": "

The instance type for the reserved capacity.

", - "SearchTrainingPlanOfferingsRequest$InstanceType": "

The type of instance you want to search for in the available training plan offerings. This field allows you to filter the search results based on the specific compute resources you require for your SageMaker training jobs or SageMaker HyperPod clusters. When searching for training plan offerings, specifying the instance type helps you find Reserved Instances that match your computational needs.

", - "UltraServer$InstanceType": "

The Amazon EC2 instance type used in the UltraServer.

", - "UltraServerSummary$InstanceType": "

The Amazon EC2 instance type used in the UltraServer.

" - } - }, - "ReservedCapacityOffering": { - "base": "

Details about a reserved capacity offering for a training plan offering.

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

", - "refs": { - "ReservedCapacityOfferings$member": null - } - }, - "ReservedCapacityOfferings": { - "base": null, - "refs": { - "TrainingPlanOffering$ReservedCapacityOfferings": "

A list of reserved capacity offerings associated with this training plan offering.

" - } - }, - "ReservedCapacityStatus": { - "base": null, - "refs": { - "DescribeReservedCapacityResponse$Status": "

The current status of the reserved capacity.

", - "ReservedCapacitySummary$Status": "

The current status of the reserved capacity.

" - } - }, - "ReservedCapacitySummaries": { - "base": null, - "refs": { - "DescribeTrainingPlanResponse$ReservedCapacitySummaries": "

The list of Reserved Capacity providing the underlying compute resources of the plan.

", - "TrainingPlanSummary$ReservedCapacitySummaries": "

A list of reserved capacities associated with this training plan, including details such as instance types, counts, and availability zones.

" - } - }, - "ReservedCapacitySummary": { - "base": "

Details of a reserved capacity for the training plan.

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

", - "refs": { - "ReservedCapacitySummaries$member": null - } - }, - "ReservedCapacityType": { - "base": null, - "refs": { - "DescribeReservedCapacityResponse$ReservedCapacityType": "

The type of reserved capacity.

", - "ReservedCapacityOffering$ReservedCapacityType": "

The type of reserved capacity offering.

", - "ReservedCapacitySummary$ReservedCapacityType": "

The type of reserved capacity.

" - } - }, - "ResolvedAttributes": { - "base": "

The resolved attributes.

", - "refs": { - "DescribeAutoMLJobResponse$ResolvedAttributes": "

Contains ProblemType, AutoMLJobObjective, and CompletionCriteria. If you do not provide these values, they are inferred.

" - } - }, - "ResourceArn": { - "base": null, - "refs": { - "AddTagsInput$ResourceArn": "

The Amazon Resource Name (ARN) of the resource that you want to tag.

", - "DeleteTagsInput$ResourceArn": "

The Amazon Resource Name (ARN) of the resource whose tags you want to delete.

", - "ListTagsInput$ResourceArn": "

The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.

" - } - }, - "ResourceCatalog": { - "base": "

A resource catalog containing all of the resources of a specific resource type within a resource owner account. For an example on sharing the Amazon SageMaker Feature Store DefaultFeatureGroupCatalog, see Share Amazon SageMaker Catalog resource type in the Amazon SageMaker Developer Guide.

", - "refs": { - "ResourceCatalogList$member": null - } - }, - "ResourceCatalogArn": { - "base": null, - "refs": { - "ResourceCatalog$ResourceCatalogArn": "

The Amazon Resource Name (ARN) of the ResourceCatalog.

" - } - }, - "ResourceCatalogDescription": { - "base": null, - "refs": { - "ResourceCatalog$Description": "

A free form description of the ResourceCatalog.

" - } - }, - "ResourceCatalogList": { - "base": null, - "refs": { - "ListResourceCatalogsResponse$ResourceCatalogs": "

A list of the requested ResourceCatalogs.

" - } - }, - "ResourceCatalogName": { - "base": null, - "refs": { - "ListResourceCatalogsRequest$NameContains": "

A string that partially matches one or more ResourceCatalogs names. Filters ResourceCatalog by name.

", - "ResourceCatalog$ResourceCatalogName": "

The name of the ResourceCatalog.

" - } - }, - "ResourceCatalogSortBy": { - "base": null, - "refs": { - "ListResourceCatalogsRequest$SortBy": "

The value on which the resource catalog list is sorted.

" - } - }, - "ResourceCatalogSortOrder": { - "base": null, - "refs": { - "ListResourceCatalogsRequest$SortOrder": "

The order in which the resource catalogs are listed.

" - } - }, - "ResourceConfig": { - "base": "

Describes the resources, including machine learning (ML) compute instances and ML storage volumes, to use for model training.

", - "refs": { - "CreateTrainingJobRequest$ResourceConfig": "

The resources, including the ML compute instances and ML storage volumes, to use for model training.

ML storage volumes store model artifacts and incremental states. Training algorithms might also use ML storage volumes for scratch space. If you want SageMaker to use the ML storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.

", - "DescribeTrainingJobResponse$ResourceConfig": "

Resources, including ML compute instances and ML storage volumes, that are configured for model training.

", - "HyperParameterTrainingJobDefinition$ResourceConfig": "

The resources, including the compute instances and storage volumes, to use for the training jobs that the tuning job launches.

Storage volumes store model artifacts and incremental states. Training algorithms might also use storage volumes for scratch space. If you want SageMaker to use the storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.

If you want to use hyperparameter optimization with instance type flexibility, use HyperParameterTuningResourceConfig instead.

", - "TrainingJob$ResourceConfig": "

Resources, including ML compute instances and ML storage volumes, that are configured for model training.

", - "TrainingJobDefinition$ResourceConfig": "

The resources, including the ML compute instances and ML storage volumes, to use for model training.

" - } - }, - "ResourceConfigForUpdate": { - "base": "

The ResourceConfig to update KeepAlivePeriodInSeconds. Other fields in the ResourceConfig cannot be updated.

", - "refs": { - "UpdateTrainingJobRequest$ResourceConfig": "

The training job ResourceConfig to update warm pool retention length.

" - } - }, - "ResourceId": { - "base": null, - "refs": { - "DescribeDomainResponse$HomeEfsFileSystemId": "

The ID of the Amazon Elastic File System managed by this Domain.

" - } - }, - "ResourceIdentifier": { - "base": null, - "refs": { - "StartSessionRequest$ResourceIdentifier": "

The Amazon Resource Name (ARN) of the resource to which the remote connection will be established. For example, this identifies the specific ARN space application you want to connect to from your local IDE.

" - } - }, - "ResourceInUse": { - "base": "

Resource being accessed is in use.

", - "refs": {} - }, - "ResourceLimitExceeded": { - "base": "

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

", - "refs": {} - }, - "ResourceLimits": { - "base": "

Specifies the maximum number of training jobs and parallel training jobs that a hyperparameter tuning job can launch.

", - "refs": { - "HyperParameterTuningJobConfig$ResourceLimits": "

The ResourceLimits object that specifies the maximum number of training and parallel training jobs that can be used for this hyperparameter tuning job.

", - "HyperParameterTuningJobSummary$ResourceLimits": "

The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs allowed for this tuning job.

" - } - }, - "ResourceNotFound": { - "base": "

Resource being access is not found.

", - "refs": {} - }, - "ResourcePolicyString": { - "base": null, - "refs": { - "GetLineageGroupPolicyResponse$ResourcePolicy": "

The resource policy that gives access to the lineage group in another account.

" - } - }, - "ResourcePropertyName": { - "base": null, - "refs": { - "Filter$Name": "

A resource property name. For example, TrainingJobName. For valid property names, see SearchRecord. You must specify a valid property for the resource.

", - "NestedFilters$NestedPropertyName": "

The name of the property to use in the nested filters. The value must match a listed property name, such as InputDataConfig.

", - "PropertyNameSuggestion$PropertyName": "

A suggested property name based on what you entered in the search textbox in the SageMaker console.

", - "SearchRequest$SortBy": "

The name of the resource property used to sort the SearchResults. The default is LastModifiedTime.

" - } - }, - "ResourceRetainedBillableTimeInSeconds": { - "base": "

Optional. Indicates how many seconds the resource stayed in ResourceRetained state. Populated only after resource reaches ResourceReused or ResourceReleased state.

", - "refs": { - "WarmPoolStatus$ResourceRetainedBillableTimeInSeconds": "

The billable time in seconds used by the warm pool. Billable time refers to the absolute wall-clock time.

Multiply ResourceRetainedBillableTimeInSeconds by the number of instances (InstanceCount) in your training cluster to get the total compute time SageMaker bills you if you run warm pool training. The formula is as follows: ResourceRetainedBillableTimeInSeconds * InstanceCount.

" - } - }, - "ResourceSharingConfig": { - "base": "

Resource sharing configuration.

", - "refs": { - "ComputeQuotaConfig$ResourceSharingConfig": "

Resource sharing configuration. This defines how an entity can lend and borrow idle compute with other entities within the cluster.

" - } - }, - "ResourceSharingStrategy": { - "base": null, - "refs": { - "ResourceSharingConfig$Strategy": "

The strategy of how idle compute is shared within the cluster. The following are the options of strategies.

  • DontLend: entities do not lend idle compute.

  • Lend: entities can lend idle compute to entities that can borrow.

  • LendandBorrow: entities can lend idle compute and borrow idle compute from other entities.

Default is LendandBorrow.

" - } - }, - "ResourceSpec": { - "base": "

Specifies the ARN's of a SageMaker AI image and SageMaker AI image version, and the instance type that the version runs on.

When both SageMakerImageVersionArn and SageMakerImageArn are passed, SageMakerImageVersionArn is used. Any updates to SageMakerImageArn will not take effect if SageMakerImageVersionArn already exists in the ResourceSpec because SageMakerImageVersionArn always takes precedence. To clear the value set for SageMakerImageVersionArn, pass None as the value.

", - "refs": { - "AppDetails$ResourceSpec": null, - "CodeEditorAppSettings$DefaultResourceSpec": null, - "CreateAppRequest$ResourceSpec": "

The instance type and the Amazon Resource Name (ARN) of the SageMaker AI image created on the instance.

The value of InstanceType passed as part of the ResourceSpec in the CreateApp call overrides the value passed as part of the ResourceSpec configured for the user profile or the domain. If InstanceType is not specified in any of those three ResourceSpec values for a KernelGateway app, the CreateApp call fails with a request validation error.

", - "DescribeAppResponse$ResourceSpec": "

The instance type and the Amazon Resource Name (ARN) of the SageMaker AI image created on the instance.

", - "JupyterLabAppSettings$DefaultResourceSpec": null, - "JupyterServerAppSettings$DefaultResourceSpec": "

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker AI image used by the JupyterServer app. If you use the LifecycleConfigArns parameter, then this parameter is also required.

", - "KernelGatewayAppSettings$DefaultResourceSpec": "

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker AI image used by the KernelGateway app.

The Amazon SageMaker AI Studio UI does not use the default instance type value set here. The default instance type set here is used when Apps are created using the CLI or CloudFormation and the instance type parameter value is not passed.

", - "RSessionAppSettings$DefaultResourceSpec": null, - "RStudioServerProDomainSettings$DefaultResourceSpec": null, - "RStudioServerProDomainSettingsForUpdate$DefaultResourceSpec": null, - "SpaceCodeEditorAppSettings$DefaultResourceSpec": null, - "SpaceJupyterLabAppSettings$DefaultResourceSpec": null, - "TensorBoardAppSettings$DefaultResourceSpec": "

The default instance type and the Amazon Resource Name (ARN) of the SageMaker AI image created on the instance.

" - } - }, - "ResourceType": { - "base": null, - "refs": { - "GetSearchSuggestionsRequest$Resource": "

The name of the SageMaker resource to search for.

", - "SearchRequest$Resource": "

The name of the SageMaker resource to search for.

" - } - }, - "ResponseMIMEType": { - "base": null, - "refs": { - "ResponseMIMETypes$member": null - } - }, - "ResponseMIMETypes": { - "base": null, - "refs": { - "AdditionalInferenceSpecificationDefinition$SupportedResponseMIMETypes": "

The supported MIME types for the output data.

", - "InferenceSpecification$SupportedResponseMIMETypes": "

The supported MIME types for the output data.

" - } - }, - "RetentionPolicy": { - "base": "

The retention policy for data stored on an Amazon Elastic File System volume.

", - "refs": { - "DeleteDomainRequest$RetentionPolicy": "

The retention policy for this domain, which specifies whether resources will be retained after the Domain is deleted. By default, all resources are retained (not automatically deleted).

" - } - }, - "RetentionType": { - "base": null, - "refs": { - "RetentionPolicy$HomeEfsFileSystem": "

The default is Retain, which specifies to keep the data stored on the Amazon EFS volume.

Specify Delete to delete the data stored on the Amazon EFS volume.

" - } - }, - "RetryPipelineExecutionRequest": { - "base": null, - "refs": {} - }, - "RetryPipelineExecutionResponse": { - "base": null, - "refs": {} - }, - "RetryStrategy": { - "base": "

The retry strategy to use when a training job fails due to an InternalServerError. RetryStrategy is specified as part of the CreateTrainingJob and CreateHyperParameterTuningJob requests. You can add the StoppingCondition parameter to the request to limit the training time for the complete job.

", - "refs": { - "CreateTrainingJobRequest$RetryStrategy": "

The number of times to retry the job when the job fails due to an InternalServerError.

", - "DescribeTrainingJobResponse$RetryStrategy": "

The number of times to retry the job when the job fails due to an InternalServerError.

", - "HyperParameterTrainingJobDefinition$RetryStrategy": "

The number of times to retry the job when the job fails due to an InternalServerError.

", - "TrainingJob$RetryStrategy": "

The number of times to retry the job when the job fails due to an InternalServerError.

" - } - }, - "RoleArn": { - "base": null, - "refs": { - "AlgorithmValidationSpecification$ValidationRole": "

The IAM roles that SageMaker uses to run the training jobs.

", - "AssumableRoleArns$member": null, - "CfnCreateTemplateProvider$RoleARN": "

The IAM role that CloudFormation assumes when creating the stack.

", - "CfnTemplateProviderDetail$RoleARN": "

The IAM role used by CloudFormation to create the stack.

", - "ClusterInstanceGroupDetails$ExecutionRole": "

The execution role for the instance group to assume.

", - "ClusterInstanceGroupSpecification$ExecutionRole": "

Specifies an IAM execution role to be assumed by the instance group.

", - "ClusterRestrictedInstanceGroupDetails$ExecutionRole": "

The execution role for the restricted instance group to assume.

", - "ClusterRestrictedInstanceGroupSpecification$ExecutionRole": "

Specifies an IAM execution role to be assumed by the restricted instance group.

", - "CreateAIBenchmarkJobRequest$RoleArn": "

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.

", - "CreateAIRecommendationJobRequest$RoleArn": "

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.

", - "CreateAutoMLJobRequest$RoleArn": "

The ARN of the role that is used to access the data.

", - "CreateAutoMLJobV2Request$RoleArn": "

The ARN of the role that is used to access the data.

", - "CreateClusterRequest$ClusterRole": "

The Amazon Resource Name (ARN) of the IAM role that HyperPod assumes to perform cluster autoscaling operations. This role must have permissions for sagemaker:BatchAddClusterNodes and sagemaker:BatchDeleteClusterNodes. This is only required when autoscaling is enabled and when HyperPod is performing autoscaling operations.

", - "CreateCompilationJobRequest$RoleArn": "

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.

During model compilation, Amazon SageMaker AI needs your permission to:

  • Read input data from an S3 bucket

  • Write model artifacts to an S3 bucket

  • Write logs to Amazon CloudWatch Logs

  • Publish metrics to Amazon CloudWatch

You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker AI, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker AI Roles.

", - "CreateDataQualityJobDefinitionRequest$RoleArn": "

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.

", - "CreateDeviceFleetRequest$RoleArn": "

The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).

", - "CreateEdgePackagingJobRequest$RoleArn": "

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact SageMaker Neo.

", - "CreateEndpointConfigInput$ExecutionRoleArn": "

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform actions on your behalf. For more information, see SageMaker AI Roles.

To be able to pass this role to Amazon SageMaker AI, the caller of this action must have the iam:PassRole permission.

", - "CreateFeatureGroupRequest$RoleArn": "

The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.

", - "CreateFlowDefinitionRequest$RoleArn": "

The Amazon Resource Name (ARN) of the role needed to call other services on your behalf. For example, arn:aws:iam::1234567890:role/service-role/AmazonSageMaker-ExecutionRole-20180111T151298.

", - "CreateImageRequest$RoleArn": "

The ARN of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.

", - "CreateInferenceExperimentRequest$RoleArn": "

The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.

", - "CreateInferenceRecommendationsJobRequest$RoleArn": "

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

", - "CreateJobRequest$RoleArn": "

The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to perform the job. The role must have the necessary permissions to access the resources required by the job configuration.

", - "CreateLabelingJobRequest$RoleArn": "

The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete data labeling.

", - "CreateMlflowAppRequest$RoleArn": "

The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow App uses to access the artifact store in Amazon S3. The role should have the AmazonS3FullAccess permission.

", - "CreateMlflowTrackingServerRequest$RoleArn": "

The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow Tracking Server uses to access the artifact store in Amazon S3. The role should have AmazonS3FullAccess permissions. For more information on IAM permissions for tracking server creation, see Set up IAM permissions for MLflow.

", - "CreateModelBiasJobDefinitionRequest$RoleArn": "

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.

", - "CreateModelExplainabilityJobDefinitionRequest$RoleArn": "

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.

", - "CreateModelInput$ExecutionRoleArn": "

The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access model artifacts and docker image for deployment on ML compute instances or for batch transform jobs. Deploying on ML compute instances is part of model hosting. For more information, see SageMaker Roles.

To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.

", - "CreateModelQualityJobDefinitionRequest$RoleArn": "

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.

", - "CreateNotebookInstanceInput$RoleArn": "

When you send any requests to Amazon Web Services resources from the notebook instance, SageMaker AI assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so SageMaker AI can perform these tasks. The policy must allow the SageMaker AI service principal (sagemaker.amazonaws.com) permissions to assume this role. For more information, see SageMaker AI Roles.

To be able to pass this role to SageMaker AI, the caller of this API must have the iam:PassRole permission.

", - "CreateOptimizationJobRequest$RoleArn": "

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.

During model optimization, Amazon SageMaker AI needs your permission to:

  • Read input data from an S3 bucket

  • Write model artifacts to an S3 bucket

  • Write logs to Amazon CloudWatch Logs

  • Publish metrics to Amazon CloudWatch

You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker AI, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker AI Roles.

", - "CreatePartnerAppRequest$ExecutionRoleArn": "

The ARN of the IAM role that the partner application uses.

", - "CreatePipelineRequest$RoleArn": "

The Amazon Resource Name (ARN) of the role used by the pipeline to access and create resources.

", - "CreateProcessingJobRequest$RoleArn": "

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

", - "CreateTrainingJobRequest$RoleArn": "

The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to perform tasks on your behalf.

During model training, SageMaker needs your permission to read input data from an S3 bucket, download a Docker image that contains training code, write model artifacts to an S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant permissions for all of these tasks to an IAM role. For more information, see SageMaker Roles.

To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.

", - "DefaultSpaceSettings$ExecutionRole": "

The ARN of the execution role for the space.

", - "DescribeAIBenchmarkJobResponse$RoleArn": "

The Amazon Resource Name (ARN) of the IAM role used by the benchmark job.

", - "DescribeAIRecommendationJobResponse$RoleArn": "

The Amazon Resource Name (ARN) of the IAM role used by the recommendation job.

", - "DescribeAutoMLJobResponse$RoleArn": "

The ARN of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3.

", - "DescribeAutoMLJobV2Response$RoleArn": "

The ARN of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3.

", - "DescribeClusterResponse$ClusterRole": "

The Amazon Resource Name (ARN) of the IAM role that HyperPod uses for cluster autoscaling operations.

", - "DescribeCompilationJobResponse$RoleArn": "

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI assumes to perform the model compilation job.

", - "DescribeDataQualityJobDefinitionResponse$RoleArn": "

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.

", - "DescribeDeviceFleetResponse$RoleArn": "

The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).

", - "DescribeEdgePackagingJobResponse$RoleArn": "

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact Neo.

", - "DescribeEndpointConfigOutput$ExecutionRoleArn": "

The Amazon Resource Name (ARN) of the IAM role that you assigned to the endpoint configuration.

", - "DescribeFeatureGroupResponse$RoleArn": "

The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.

", - "DescribeFlowDefinitionResponse$RoleArn": "

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) execution role for the flow definition.

", - "DescribeImageResponse$RoleArn": "

The ARN of the IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.

", - "DescribeInferenceExperimentResponse$RoleArn": "

The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.

", - "DescribeInferenceRecommendationsJobResponse$RoleArn": "

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role you provided when you initiated the job.

", - "DescribeJobResponse$RoleArn": "

The ARN of the IAM role associated with the job.

", - "DescribeLabelingJobResponse$RoleArn": "

The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during data labeling.

", - "DescribeMlflowAppResponse$RoleArn": "

The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow App uses to access the artifact store in Amazon S3.

", - "DescribeMlflowTrackingServerResponse$RoleArn": "

The Amazon Resource Name (ARN) for an IAM role in your account that the described MLflow Tracking Server uses to access the artifact store in Amazon S3.

", - "DescribeModelBiasJobDefinitionResponse$RoleArn": "

The Amazon Resource Name (ARN) of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3.

", - "DescribeModelExplainabilityJobDefinitionResponse$RoleArn": "

The Amazon Resource Name (ARN) of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3.

", - "DescribeModelOutput$ExecutionRoleArn": "

The Amazon Resource Name (ARN) of the IAM role that you specified for the model.

", - "DescribeModelQualityJobDefinitionResponse$RoleArn": "

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.

", - "DescribeNotebookInstanceOutput$RoleArn": "

The Amazon Resource Name (ARN) of the IAM role associated with the instance.

", - "DescribeOptimizationJobResponse$RoleArn": "

The ARN of the IAM role that you assigned to the optimization job.

", - "DescribePartnerAppResponse$ExecutionRoleArn": "

The ARN of the IAM role associated with the SageMaker Partner AI App.

", - "DescribePipelineResponse$RoleArn": "

The Amazon Resource Name (ARN) that the pipeline uses to execute.

", - "DescribeProcessingJobResponse$RoleArn": "

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

", - "DescribeTrainingJobResponse$RoleArn": "

The Amazon Web Services Identity and Access Management (IAM) role configured for the training job.

", - "EmrServerlessComputeConfig$ExecutionRoleARN": "

The ARN of the IAM role granting the AutoML job V2 the necessary permissions access policies to list, connect to, or manage EMR Serverless jobs. For detailed information about the required permissions of this role, see \"How to configure AutoML to initiate a remote job on EMR Serverless for large datasets\" in Create a regression or classification job for tabular data using the AutoML API or Create an AutoML job for time-series forecasting using the API.

", - "EmrServerlessSettings$ExecutionRoleArn": "

The Amazon Resource Name (ARN) of the Amazon Web Services IAM role that is assumed for running Amazon EMR Serverless jobs in SageMaker Canvas. This role should have the necessary permissions to read and write data attached and a trust relationship with EMR Serverless.

", - "ExecutionRoleArns$member": null, - "FeatureGroup$RoleArn": "

The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.

", - "GenerativeAiSettings$AmazonBedrockRoleArn": "

The ARN of an Amazon Web Services IAM role that allows fine-tuning of large language models (LLMs) in Amazon Bedrock. The IAM role should have Amazon S3 read and write permissions, as well as a trust relationship that establishes bedrock.amazonaws.com as a service principal.

", - "HyperParameterTrainingJobDefinition$RoleArn": "

The Amazon Resource Name (ARN) of the IAM role associated with the training jobs that the tuning job launches.

", - "InferenceExperimentSummary$RoleArn": "

The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.

", - "InferenceRecommendationsJob$RoleArn": "

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

", - "Job$RoleArn": "

The ARN of the IAM role associated with the job.

", - "Model$ExecutionRoleArn": "

The Amazon Resource Name (ARN) of the IAM role that you specified for the model.

", - "ModelPackageValidationSpecification$ValidationRole": "

The IAM roles to be used for the validation of the model package.

", - "ModelRegisterSettings$CrossAccountModelRegisterRoleArn": "

The Amazon Resource Name (ARN) of the SageMaker model registry account. Required only to register model versions created by a different SageMaker Canvas Amazon Web Services account than the Amazon Web Services account in which SageMaker model registry is set up.

", - "MonitoringJobDefinition$RoleArn": "

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.

", - "Pipeline$RoleArn": "

The Amazon Resource Name (ARN) of the role that created the pipeline.

", - "PipelineSummary$RoleArn": "

The Amazon Resource Name (ARN) that the pipeline used to execute.

", - "ProcessingJob$RoleArn": "

The ARN of the role used to create the processing job.

", - "RStudioServerProDomainSettings$DomainExecutionRoleArn": "

The ARN of the execution role for the RStudioServerPro Domain-level app.

", - "RStudioServerProDomainSettingsForUpdate$DomainExecutionRoleArn": "

The execution role for the RStudioServerPro Domain-level app.

", - "RedshiftDatasetDefinition$ClusterRoleArn": "

The IAM role attached to your Redshift cluster that Amazon SageMaker uses to generate datasets.

", - "RenderUiTemplateRequest$RoleArn": "

The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the template.

", - "TimeSeriesForecastingSettings$AmazonForecastRoleArn": "

The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default, Canvas uses the execution role specified in the UserProfile that launches the Canvas application. If an execution role is not specified in the UserProfile, Canvas uses the execution role specified in the Domain that owns the UserProfile. To allow time series forecasting, this IAM role should have the AmazonSageMakerCanvasForecastAccess policy attached and forecast.amazonaws.com added in the trust relationship as a service principal.

", - "TrainingJob$RoleArn": "

The Amazon Web Services Identity and Access Management (IAM) role configured for the training job.

", - "UpdateClusterRequest$ClusterRole": "

The Amazon Resource Name (ARN) of the IAM role that HyperPod assumes for cluster autoscaling operations. Cannot be updated while autoscaling is enabled.

", - "UpdateDeviceFleetRequest$RoleArn": "

The Amazon Resource Name (ARN) of the device.

", - "UpdateImageRequest$RoleArn": "

The new ARN for the IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.

", - "UpdateNotebookInstanceInput$RoleArn": "

The Amazon Resource Name (ARN) of the IAM role that SageMaker AI can assume to access the notebook instance. For more information, see SageMaker AI Roles.

To be able to pass this role to SageMaker AI, the caller of this API must have the iam:PassRole permission.

", - "UpdatePipelineRequest$RoleArn": "

The Amazon Resource Name (ARN) that the pipeline uses to execute.

", - "UserSettings$ExecutionRole": "

The execution role for the user.

SageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn't apply this setting to shared spaces.

" - } - }, - "RoleGroupAssignment": { - "base": "

Defines the mapping between an in-app role and the Amazon Web Services IAM Identity Center group patterns that should be assigned to that role within the SageMaker Partner AI App.

", - "refs": { - "RoleGroupAssignmentsList$member": null - } - }, - "RoleGroupAssignmentsList": { - "base": null, - "refs": { - "PartnerAppConfig$RoleGroupAssignments": "

A map of in-app roles to Amazon Web Services IAM Identity Center group patterns. Groups assigned to specific roles receive those permissions, while groups in AssignedGroupPatterns but not in this map receive default in-app role depending on app type. Group patterns support wildcard matching using *. Currently supported by Fiddler version 1.3 and later with roles: ORG_MEMBER (default) and ORG_ADMIN.

" - } - }, - "RollingDeploymentPolicy": { - "base": "

The configurations that SageMaker uses when updating the AMI versions.

", - "refs": { - "DeploymentConfiguration$RollingUpdatePolicy": "

The policy that SageMaker uses when updating the AMI versions of the cluster.

" - } - }, - "RollingUpdatePolicy": { - "base": "

Specifies a rolling deployment strategy for updating a SageMaker endpoint.

", - "refs": { - "DeploymentConfig$RollingUpdatePolicy": "

Specifies a rolling deployment strategy for updating a SageMaker endpoint.

" - } - }, - "RootAccess": { - "base": null, - "refs": { - "CreateNotebookInstanceInput$RootAccess": "

Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled.

Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.

", - "DescribeNotebookInstanceOutput$RootAccess": "

Whether root access is enabled or disabled for users of the notebook instance.

Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.

", - "UpdateNotebookInstanceInput$RootAccess": "

Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled.

If you set this to Disabled, users don't have root access on the notebook instance, but lifecycle configuration scripts still run with root permissions.

" - } - }, - "RoutingStrategy": { - "base": null, - "refs": { - "ProductionVariantRoutingConfig$RoutingStrategy": "

Sets how the endpoint routes incoming traffic:

  • LEAST_OUTSTANDING_REQUESTS: The endpoint routes requests to the specific instances that have more capacity to process them.

  • RANDOM: The endpoint routes each request to a randomly chosen instance.

" - } - }, - "RuleConfigurationName": { - "base": null, - "refs": { - "DebugRuleConfiguration$RuleConfigurationName": "

The name of the rule configuration. It must be unique relative to other rule configuration names.

", - "DebugRuleEvaluationStatus$RuleConfigurationName": "

The name of the rule configuration.

", - "ProfilerRuleConfiguration$RuleConfigurationName": "

The name of the rule configuration. It must be unique relative to other rule configuration names.

", - "ProfilerRuleEvaluationStatus$RuleConfigurationName": "

The name of the rule configuration.

" - } - }, - "RuleEvaluationStatus": { - "base": null, - "refs": { - "DebugRuleEvaluationStatus$RuleEvaluationStatus": "

Status of the rule evaluation.

", - "ProfilerRuleEvaluationStatus$RuleEvaluationStatus": "

Status of the rule evaluation.

" - } - }, - "RuleParameters": { - "base": null, - "refs": { - "DebugRuleConfiguration$RuleParameters": "

Runtime configuration for rule container.

", - "ProfilerRuleConfiguration$RuleParameters": "

Runtime configuration for rule container.

" - } - }, - "S3DataDistribution": { - "base": null, - "refs": { - "S3DataSource$S3DataDistributionType": "

If you want SageMaker to replicate the entire dataset on each ML compute instance that is launched for model training, specify FullyReplicated.

If you want SageMaker to replicate a subset of data on each ML compute instance that is launched for model training, specify ShardedByS3Key. If there are n ML compute instances launched for a training job, each instance gets approximately 1/n of the number of S3 objects. In this case, model training on each machine uses only the subset of training data.

Don't choose more ML compute instances for training than available S3 objects. If you do, some nodes won't get any data and you will pay for nodes that aren't getting any training data. This applies in both File and Pipe modes. Keep this in mind when developing algorithms.

In distributed training, where you use multiple ML compute EC2 instances, you might choose ShardedByS3Key. If the algorithm requires copying training data to the ML storage volume (when TrainingInputMode is set to File), this copies 1/n of the number of objects.

" - } - }, - "S3DataSource": { - "base": "

Describes the S3 data source.

Your input bucket must be in the same Amazon Web Services region as your training job.

", - "refs": { - "DataSource$S3DataSource": "

The S3 location of the data source that is associated with a channel.

" - } - }, - "S3DataType": { - "base": null, - "refs": { - "S3DataSource$S3DataType": "

If you choose S3Prefix, S3Uri identifies a key name prefix. SageMaker uses all objects that match the specified key name prefix for model training.

If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want SageMaker to use for model training.

If you choose AugmentedManifestFile, S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. AugmentedManifestFile can only be used if the Channel's input mode is Pipe.

If you choose Converse, S3Uri identifies an Amazon S3 location that contains data formatted according to Converse format. This format structures conversational messages with specific roles and content types used for training and fine-tuning foundational models.

", - "TransformS3DataSource$S3DataType": "

If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for batch transform.

If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for batch transform.

The following values are compatible: ManifestFile, S3Prefix

The following value is not compatible: AugmentedManifestFile

" - } - }, - "S3FileSystem": { - "base": "

A custom file system in Amazon S3. This is only supported in Amazon SageMaker Unified Studio.

", - "refs": { - "CustomFileSystem$S3FileSystem": "

A custom file system in Amazon S3. This is only supported in Amazon SageMaker Unified Studio.

" - } - }, - "S3FileSystemConfig": { - "base": "

Configuration for the custom Amazon S3 file system.

", - "refs": { - "CustomFileSystemConfig$S3FileSystemConfig": "

Configuration settings for a custom Amazon S3 file system.

" - } - }, - "S3ModelDataSource": { - "base": "

Specifies the S3 location of ML model data to deploy.

", - "refs": { - "AdditionalModelDataSource$S3DataSource": null, - "ModelDataSource$S3DataSource": "

Specifies the S3 location of ML model data to deploy.

" - } - }, - "S3ModelDataType": { - "base": null, - "refs": { - "S3ModelDataSource$S3DataType": "

Specifies the type of ML model data to deploy.

If you choose S3Prefix, S3Uri identifies a key name prefix. SageMaker uses all objects that match the specified key name prefix as part of the ML model data to deploy. A valid key name prefix identified by S3Uri always ends with a forward slash (/).

If you choose S3Object, S3Uri identifies an object that is the ML model data to deploy.

" - } - }, - "S3ModelUri": { - "base": null, - "refs": { - "PresignedUrlAccessConfig$ExpectedS3Url": "

The expected S3 URL prefix for validation purposes. This parameter helps ensure consistency between the resolved S3 URIs and the deployment configuration, reducing potential compatibility issues.

", - "S3ModelDataSource$S3Uri": "

Specifies the S3 path of ML model data to deploy.

", - "S3ModelDataSource$ManifestS3Uri": "

The Amazon S3 URI of the manifest file. The manifest file is a CSV file that stores the artifact locations.

" - } - }, - "S3OutputPath": { - "base": null, - "refs": { - "HubS3StorageConfig$S3OutputPath": "

The Amazon S3 bucket prefix for hosting hub content.

" - } - }, - "S3Presign": { - "base": "

This object defines the access restrictions to Amazon S3 resources that are included in custom worker task templates using the Liquid filter, grant_read_access.

To learn more about how custom templates are created, see Create custom worker task templates.

", - "refs": { - "WorkerAccessConfiguration$S3Presign": "

Defines any Amazon S3 resource constraints.

" - } - }, - "S3SchemaUri": { - "base": null, - "refs": { - "S3FileSystem$S3Uri": "

The Amazon S3 URI that specifies the location in S3 where files are stored, which is mounted within the Studio environment. For example: s3://<bucket-name>/<prefix>/.

", - "S3FileSystemConfig$S3Uri": "

The Amazon S3 URI of the S3 file system configuration.

" - } - }, - "S3StorageConfig": { - "base": "

The Amazon Simple Storage (Amazon S3) location and security configuration for OfflineStore.

", - "refs": { - "OfflineStoreConfig$S3StorageConfig": "

The Amazon Simple Storage (Amazon S3) location of OfflineStore.

" - } - }, - "S3Uri": { - "base": null, - "refs": { - "AIAdapterS3Entry$S3Uri": "

The Amazon S3 URI of the directory that contains the LoRA adapter artifacts in PEFT format.

", - "AIBenchmarkOutputConfig$S3OutputLocation": "

The Amazon S3 URI where benchmark results are stored.

", - "AIBenchmarkOutputResult$S3OutputLocation": "

The Amazon S3 URI where benchmark results are stored.

", - "AIModelSourceS3$S3Uri": "

The Amazon S3 URI of the model artifacts.

", - "AIRecommendationDeploymentS3Channel$Uri": "

The Amazon S3 URI of the data for this channel.

", - "AIRecommendationOutputConfig$S3OutputLocation": "

The Amazon S3 URI where recommendation results are stored.

", - "AIRecommendationOutputResult$S3OutputLocation": "

The Amazon S3 URI where the recommendation job writes its output results.

", - "AIWorkloadS3DataSource$S3Uri": "

The Amazon S3 URI of the data.

", - "AdditionalS3DataSource$S3Uri": "

The uniform resource identifier (URI) used to identify an additional data source used in inference or training.

", - "AthenaDatasetDefinition$OutputS3Uri": "

The location in Amazon S3 where Athena query results are stored.

", - "AutoMLCandidateGenerationConfig$FeatureSpecificationS3Uri": "

A URL to the Amazon S3 data source containing selected features from the input data source to run an Autopilot job. You can input FeatureAttributeNames (optional) in JSON format as shown below:

{ \"FeatureAttributeNames\":[\"col1\", \"col2\", ...] }.

You can also specify the data type of the feature (optional) in the format shown below:

{ \"FeatureDataTypes\":{\"col1\":\"numeric\", \"col2\":\"categorical\" ... } }

These column keys may not include the target column.

In ensembling mode, Autopilot only supports the following data types: numeric, categorical, text, and datetime. In HPO mode, Autopilot can support numeric, categorical, text, datetime, and sequence.

If only FeatureDataTypes is provided, the column keys (col1, col2,..) should be a subset of the column names in the input data.

If both FeatureDataTypes and FeatureAttributeNames are provided, then the column keys should be a subset of the column names provided in FeatureAttributeNames.

The key name FeatureAttributeNames is fixed. The values listed in [\"col1\", \"col2\", ...] are case sensitive and should be a list of strings containing unique values that are a subset of the column names in the input data. The list of columns provided must not include the target column.

", - "AutoMLOutputDataConfig$S3OutputPath": "

The Amazon S3 output path. Must be 512 characters or less.

", - "AutoMLS3DataSource$S3Uri": "

The URL to the Amazon S3 data source. The Uri refers to the Amazon S3 prefix or ManifestFile depending on the data type.

", - "BatchDataCaptureConfig$DestinationS3Uri": "

The Amazon S3 location being used to capture the data.

", - "CheckpointConfig$S3Uri": "

Identifies the S3 path where you want SageMaker to store checkpoints. For example, s3://bucket-name/key-name-prefix.

", - "ClusterLifeCycleConfig$SourceS3Uri": "

An Amazon S3 bucket path where your lifecycle scripts are stored.

Make sure that the S3 bucket path starts with s3://sagemaker-. The IAM role for SageMaker HyperPod has the managed AmazonSageMakerClusterInstanceRolePolicy attached, which allows access to S3 buckets with the specific prefix sagemaker-.

", - "CreateLabelingJobRequest$LabelCategoryConfigS3Uri": "

The S3 URI of the file, referred to as a label category configuration file, that defines the categories used to label the data objects.

For 3D point cloud and video frame task types, you can add label category attributes and frame attributes to your label category configuration file. To learn how, see Create a Labeling Category Configuration File for 3D Point Cloud Labeling Jobs.

For named entity recognition jobs, in addition to \"labels\", you must provide worker instructions in the label category configuration file using the \"instructions\" parameter: \"instructions\": {\"shortInstruction\":\"<h1>Add header</h1><p>Add Instructions</p>\", \"fullInstruction\":\"<p>Add additional instructions.</p>\"}. For details and an example, see Create a Named Entity Recognition Labeling Job (API) .

For all other built-in task types and custom tasks, your label category configuration file must be a JSON file in the following format. Identify the labels you want to use by replacing label_1, label_2,...,label_n with your label categories.

{

\"document-version\": \"2018-11-28\",

\"labels\": [{\"label\": \"label_1\"},{\"label\": \"label_2\"},...{\"label\": \"label_n\"}]

}

Note the following about the label category configuration file:

  • For image classification and text classification (single and multi-label) you must specify at least two label categories. For all other task types, the minimum number of label categories required is one.

  • Each label category must be unique, you cannot specify duplicate label categories.

  • If you create a 3D point cloud or video frame adjustment or verification labeling job, you must include auditLabelAttributeName in the label category configuration. Use this parameter to enter the LabelAttributeName of the labeling job you want to adjust or verify annotations of.

", - "CreateMlflowAppRequest$ArtifactStoreUri": "

The S3 URI for a general purpose bucket to use as the MLflow App artifact store.

", - "CreateMlflowTrackingServerRequest$ArtifactStoreUri": "

The S3 URI for a general purpose bucket to use as the MLflow Tracking Server artifact store.

", - "CreateModelPackageInput$SamplePayloadUrl": "

The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). This archive can hold multiple files that are all equally used in the load test. Each file in the archive must satisfy the size constraints of the InvokeEndpoint call.

", - "DataQualityAppSpecification$RecordPreprocessorSourceUri": "

An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flattened JSON so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.

", - "DataQualityAppSpecification$PostAnalyticsProcessorSourceUri": "

An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.

", - "DebugHookConfig$S3OutputPath": "

Path to Amazon S3 storage location for metrics and tensors.

", - "DebugRuleConfiguration$S3OutputPath": "

Path to Amazon S3 storage location for rules.

", - "DescribeEdgePackagingJobResponse$ModelArtifact": "

The Amazon Simple Storage (S3) URI where model artifacts ares stored.

", - "DescribeLabelingJobResponse$LabelCategoryConfigS3Uri": "

The S3 location of the JSON file that defines the categories used to label data objects. Please note the following label-category limits:

  • Semantic segmentation labeling jobs using automated labeling: 20 labels

  • Box bounding labeling jobs (all): 10 labels

The file is a JSON structure in the following format:

{

\"document-version\": \"2018-11-28\"

\"labels\": [

{

\"label\": \"label 1\"

},

{

\"label\": \"label 2\"

},

...

{

\"label\": \"label n\"

}

]

}

", - "DescribeMlflowAppResponse$ArtifactStoreUri": "

The S3 URI of the general purpose bucket used as the MLflow App artifact store.

", - "DescribeMlflowTrackingServerResponse$ArtifactStoreUri": "

The S3 URI of the general purpose bucket used as the MLflow Tracking Server artifact store.

", - "EdgeOutputConfig$S3OutputLocation": "

The Amazon Simple Storage (S3) bucker URI.

", - "EnvironmentConfigDetails$S3OutputPath": "

The Amazon S3 path where output data from the restricted instance group (RIG) environment will be stored.

", - "FileSource$S3Uri": "

The Amazon S3 URI for the file source.

", - "FlowDefinitionOutputConfig$S3OutputPath": "

The Amazon S3 path where the object containing human output will be made available.

To learn more about the format of Amazon A2I output data, see Amazon A2I Output Data.

", - "InferenceRecommendationsJob$SamplePayloadUrl": "

The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

", - "InputConfig$S3Uri": "

The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

", - "LabelingJobOutput$OutputDatasetS3Uri": "

The Amazon S3 bucket location of the manifest file for labeled data.

", - "LabelingJobOutputConfig$S3OutputPath": "

The Amazon S3 location to write output data.

", - "LabelingJobS3DataSource$ManifestS3Uri": "

The Amazon S3 location of the manifest file that describes the input data objects.

The input manifest file referenced in ManifestS3Uri must contain one of the following keys: source-ref or source. The value of the keys are interpreted as follows:

  • source-ref: The source of the object is the Amazon S3 object specified in the value. Use this value when the object is a binary object, such as an image.

  • source: The source of the object is the value. Use this value when the object is a text value.

If you are a new user of Ground Truth, it is recommended you review Use an Input Manifest File in the Amazon SageMaker Developer Guide to learn how to create an input manifest file.

", - "MetricsSource$S3Uri": "

The S3 URI for the metrics source.

", - "ModelArtifacts$S3ModelArtifacts": "

The path of the S3 object that contains the model artifacts. For example, s3://bucket-name/keynameprefix/model.tar.gz.

", - "ModelBiasAppSpecification$ConfigUri": "

JSON formatted S3 file that defines bias parameters. For more information on this JSON configuration file, see Configure bias parameters.

", - "ModelCardExportArtifacts$S3ExportArtifacts": "

The Amazon S3 URI of the exported model artifacts.

", - "ModelCardExportOutputConfig$S3OutputPath": "

The Amazon S3 output path to export your model card PDF.

", - "ModelExplainabilityAppSpecification$ConfigUri": "

JSON formatted Amazon S3 file that defines explainability parameters. For more information on this JSON configuration file, see Configure model explainability parameters.

", - "ModelQualityAppSpecification$RecordPreprocessorSourceUri": "

An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flattened JSON so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.

", - "ModelQualityAppSpecification$PostAnalyticsProcessorSourceUri": "

An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.

", - "ModelSpeculativeDecodingTrainingDataSource$S3Uri": "

The Amazon S3 URI that points to the training data for speculative decoding.

", - "MonitoringAppSpecification$RecordPreprocessorSourceUri": "

An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flattened JSON so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.

", - "MonitoringAppSpecification$PostAnalyticsProcessorSourceUri": "

An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.

", - "MonitoringConstraintsResource$S3Uri": "

The Amazon S3 URI for the constraints resource.

", - "MonitoringStatisticsResource$S3Uri": "

The Amazon S3 URI for the statistics resource.

", - "OptimizationJobModelSourceS3$S3Uri": "

An Amazon S3 URI that locates a source model to optimize with an optimization job.

", - "OptimizationJobOutputConfig$S3OutputLocation": "

The Amazon S3 URI for where to store the optimized model that you create with an optimization job.

", - "OutputConfig$S3OutputLocation": "

Identifies the S3 bucket where you want Amazon SageMaker AI to store the model artifacts. For example, s3://bucket-name/key-name-prefix.

", - "OutputDataConfig$S3OutputPath": "

Identifies the S3 path where you want SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.

", - "ProcessingS3Input$S3Uri": "

The URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.

", - "ProcessingS3Output$S3Uri": "

A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of a processing job.

", - "ProfilerConfig$S3OutputPath": "

Path to Amazon S3 storage location for system and framework metrics.

", - "ProfilerConfigForUpdate$S3OutputPath": "

Path to Amazon S3 storage location for system and framework metrics.

", - "ProfilerRuleConfiguration$S3OutputPath": "

Path to Amazon S3 storage location for rules.

", - "RecommendationJobCompiledOutputConfig$S3OutputUri": "

Identifies the Amazon S3 bucket where you want SageMaker to store the compiled model artifacts.

", - "RecommendationJobPayloadConfig$SamplePayloadUrl": "

The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

", - "RedshiftDatasetDefinition$OutputS3Uri": "

The location in Amazon S3 where the Redshift query results are stored.

", - "S3DataSource$S3Uri": "

Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:

  • A key name prefix might look like this: s3://bucketname/exampleprefix/

  • A manifest might look like this: s3://bucketname/example.manifest

    A manifest is an S3 object which is a JSON file consisting of an array of elements. The first element is a prefix which is followed by one or more suffixes. SageMaker appends the suffix elements to the prefix to get a full set of S3Uri. Note that the prefix must be a valid non-empty S3Uri that precludes users from specifying a manifest whose individual S3Uri is sourced from different S3 buckets.

    The following code example shows a valid manifest format:

    [ {\"prefix\": \"s3://customer_bucket/some/prefix/\"},

    \"relative/path/to/custdata-1\",

    \"relative/path/custdata-2\",

    ...

    \"relative/path/custdata-N\"

    ]

    This JSON is equivalent to the following S3Uri list:

    s3://customer_bucket/some/prefix/relative/path/to/custdata-1

    s3://customer_bucket/some/prefix/relative/path/custdata-2

    ...

    s3://customer_bucket/some/prefix/relative/path/custdata-N

    The complete set of S3Uri in this manifest is the input data for the channel for this data source. The object that each S3Uri points to must be readable by the IAM role that SageMaker uses to perform tasks on your behalf.

Your input bucket must be located in same Amazon Web Services region as your training job.

", - "S3StorageConfig$S3Uri": "

The S3 URI, or location in Amazon S3, of OfflineStore.

S3 URIs have a format similar to the following: s3://example-bucket/prefix/.

", - "S3StorageConfig$ResolvedOutputS3Uri": "

The S3 path where offline records are written.

", - "SharingSettings$S3OutputPath": "

When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.

", - "TabularJobConfig$FeatureSpecificationS3Uri": "

A URL to the Amazon S3 data source containing selected features from the input data source to run an Autopilot job V2. You can input FeatureAttributeNames (optional) in JSON format as shown below:

{ \"FeatureAttributeNames\":[\"col1\", \"col2\", ...] }.

You can also specify the data type of the feature (optional) in the format shown below:

{ \"FeatureDataTypes\":{\"col1\":\"numeric\", \"col2\":\"categorical\" ... } }

These column keys may not include the target column.

In ensembling mode, Autopilot only supports the following data types: numeric, categorical, text, and datetime. In HPO mode, Autopilot can support numeric, categorical, text, datetime, and sequence.

If only FeatureDataTypes is provided, the column keys (col1, col2,..) should be a subset of the column names in the input data.

If both FeatureDataTypes and FeatureAttributeNames are provided, then the column keys should be a subset of the column names provided in FeatureAttributeNames.

The key name FeatureAttributeNames is fixed. The values listed in [\"col1\", \"col2\", ...] are case sensitive and should be a list of strings containing unique values that are a subset of the column names in the input data. The list of columns provided must not include the target column.

", - "TensorBoardOutputConfig$S3OutputPath": "

Path to Amazon S3 storage location for TensorBoard output.

", - "TimeSeriesForecastingJobConfig$FeatureSpecificationS3Uri": "

A URL to the Amazon S3 data source containing additional selected features that complement the target, itemID, timestamp, and grouped columns set in TimeSeriesConfig. When not provided, the AutoML job V2 includes all the columns from the original dataset that are not already declared in TimeSeriesConfig. If provided, the AutoML job V2 only considers these additional columns as a complement to the ones declared in TimeSeriesConfig.

You can input FeatureAttributeNames (optional) in JSON format as shown below:

{ \"FeatureAttributeNames\":[\"col1\", \"col2\", ...] }.

You can also specify the data type of the feature (optional) in the format shown below:

{ \"FeatureDataTypes\":{\"col1\":\"numeric\", \"col2\":\"categorical\" ... } }

Autopilot supports the following data types: numeric, categorical, text, and datetime.

These column keys must not include any column set in TimeSeriesConfig.

", - "TransformOutput$S3OutputPath": "

The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job. For example, s3://bucket-name/key-name-prefix.

For every S3 object used as input for the transform job, batch transform stores the transformed data with an .out suffix in a corresponding subfolder in the location in the output prefix. For example, for the input data stored at s3://bucket-name/input-name-prefix/dataset01/data.csv, batch transform stores the transformed data at s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out. Batch transform doesn't upload partially processed objects. For an input S3 object that contains multiple records, it creates an .out file only if the transform job succeeds on the entire file. When the input contains multiple S3 objects, the batch transform job processes the listed S3 objects and uploads only the output for successfully processed objects. If any object fails in the transform job batch transform marks the job as failed to prompt investigation.

", - "TransformS3DataSource$S3Uri": "

Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:

  • A key name prefix might look like this: s3://bucketname/exampleprefix/.

  • A manifest might look like this: s3://bucketname/example.manifest

    The manifest is an S3 object which is a JSON file with the following format:

    [ {\"prefix\": \"s3://customer_bucket/some/prefix/\"},

    \"relative/path/to/custdata-1\",

    \"relative/path/custdata-2\",

    ...

    \"relative/path/custdata-N\"

    ]

    The preceding JSON matches the following S3Uris:

    s3://customer_bucket/some/prefix/relative/path/to/custdata-1

    s3://customer_bucket/some/prefix/relative/path/custdata-2

    ...

    s3://customer_bucket/some/prefix/relative/path/custdata-N

    The complete set of S3Uris in this manifest constitutes the input data for the channel for this datasource. The object that each S3Uris points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.

", - "UiConfig$UiTemplateS3Uri": "

The Amazon S3 bucket location of the UI template, or worker task template. This is the template used to render the worker UI and tools for labeling job tasks. For more information about the contents of a UI template, see Creating Your Custom Labeling Task Template.

", - "UnifiedStudioSettings$ProjectS3Path": "

The location where Amazon S3 stores temporary execution data and other artifacts for the project that corresponds to the domain.

", - "UpdateMlflowAppRequest$ArtifactStoreUri": "

The new S3 URI for the general purpose bucket to use as the artifact store for the MLflow App.

", - "UpdateMlflowTrackingServerRequest$ArtifactStoreUri": "

The new S3 URI for the general purpose bucket to use as the artifact store for the MLflow Tracking Server.

", - "WorkspaceSettings$S3ArtifactPath": "

The Amazon S3 bucket used to store artifacts generated by Canvas. Updating the Amazon S3 location impacts existing configuration settings, and Canvas users no longer have access to their artifacts. Canvas users must log out and log back in to apply the new location.

" - } - }, - "SageMakerImageName": { - "base": null, - "refs": { - "HiddenSageMakerImage$SageMakerImageName": "

The SageMaker image name that you are hiding from the Studio user interface.

" - } - }, - "SageMakerImageVersionAlias": { - "base": null, - "refs": { - "DeleteImageVersionRequest$Alias": "

The alias of the image to delete.

", - "DescribeImageVersionRequest$Alias": "

The alias of the image version.

", - "ListAliasesRequest$Alias": "

The alias of the image version.

", - "SageMakerImageVersionAliases$member": null, - "UpdateImageVersionRequest$Alias": "

The alias of the image version.

" - } - }, - "SageMakerImageVersionAliases": { - "base": null, - "refs": { - "CreateImageVersionRequest$Aliases": "

A list of aliases created with the image version.

", - "ListAliasesResponse$SageMakerImageVersionAliases": "

A list of SageMaker AI image version aliases.

", - "UpdateImageVersionRequest$AliasesToAdd": "

A list of aliases to add.

", - "UpdateImageVersionRequest$AliasesToDelete": "

A list of aliases to delete.

" - } - }, - "SageMakerPublicHubContentArn": { - "base": null, - "refs": { - "CreateHubContentReferenceRequest$SageMakerPublicHubContentArn": "

The ARN of the public hub content to reference.

", - "DescribeHubContentResponse$SageMakerPublicHubContentArn": "

The ARN of the public hub content.

", - "HubContentInfo$SageMakerPublicHubContentArn": "

The ARN of the public hub content.

" - } - }, - "SageMakerResourceName": { - "base": null, - "refs": { - "SageMakerResourceNames$member": null - } - }, - "SageMakerResourceNames": { - "base": null, - "refs": { - "DescribeTrainingPlanResponse$TargetResources": "

The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod, SageMaker Endpoints, Studio apps) that can use this training plan.

Training plans are specific to their target resource.

  • A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs.

  • A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster's instance group.

  • A training plan for SageMaker endpoints can be used exclusively to provide compute resources to SageMaker endpoints for model deployment.

  • A training plan for Studio apps can be used to launch JupyterLab and Code Editor apps on reserved training plan capacity.

", - "SearchTrainingPlanOfferingsRequest$TargetResources": "

The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod, SageMaker Endpoints, Studio apps) to search for in the offerings.

Training plans are specific to their target resource.

  • A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs.

  • A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster's instance group.

  • A training plan for SageMaker endpoints can be used exclusively to provide compute resources to SageMaker endpoints for model deployment.

  • A training plan for Studio apps can be used to launch JupyterLab and Code Editor apps on reserved training plan capacity.

", - "TrainingPlanOffering$TargetResources": "

The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod, SageMaker Endpoints, Studio apps) for this training plan offering.

Training plans are specific to their target resource.

  • A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs.

  • A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster's instance group.

  • A training plan for SageMaker endpoints can be used exclusively to provide compute resources to SageMaker endpoints for model deployment.

  • A training plan for Studio apps can be used to launch JupyterLab and Code Editor apps on reserved training plan capacity.

", - "TrainingPlanSummary$TargetResources": "

The target resources (e.g., training jobs, HyperPod clusters, Endpoints, Studio apps) that can use this training plan.

Training plans are specific to their target resource.

  • A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs.

  • A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster's instance group.

  • A training plan for SageMaker endpoints can be used exclusively to provide compute resources to SageMaker endpoints for model deployment.

  • A training plan for Studio apps can be used to launch JupyterLab and Code Editor apps on reserved training plan capacity.

" - } - }, - "SagemakerServicecatalogStatus": { - "base": null, - "refs": { - "GetSagemakerServicecatalogPortfolioStatusOutput$Status": "

Whether Service Catalog is enabled or disabled in SageMaker.

" - } - }, - "SampleWeightAttributeName": { - "base": null, - "refs": { - "AutoMLChannel$SampleWeightAttributeName": "

If specified, this column name indicates which column of the dataset should be treated as sample weights for use by the objective metric during the training, evaluation, and the selection of the best model. This column is not considered as a predictive feature. For more information on Autopilot metrics, see Metrics and validation.

Sample weights should be numeric, non-negative, with larger values indicating which rows are more important than others. Data points that have invalid or no weight value are excluded.

Support for sample weights is available in Ensembling mode only.

", - "TabularJobConfig$SampleWeightAttributeName": "

If specified, this column name indicates which column of the dataset should be treated as sample weights for use by the objective metric during the training, evaluation, and the selection of the best model. This column is not considered as a predictive feature. For more information on Autopilot metrics, see Metrics and validation.

Sample weights should be numeric, non-negative, with larger values indicating which rows are more important than others. Data points that have invalid or no weight value are excluded.

Support for sample weights is available in Ensembling mode only.

" - } - }, - "SamplingPercentage": { - "base": null, - "refs": { - "DataCaptureConfig$InitialSamplingPercentage": "

The percentage of requests SageMaker AI will capture. A lower value is recommended for Endpoints with high traffic.

", - "DataCaptureConfigSummary$CurrentSamplingPercentage": "

The percentage of requests being captured by your Endpoint.

" - } - }, - "ScalingPolicies": { - "base": null, - "refs": { - "DynamicScalingConfiguration$ScalingPolicies": "

An object of the scaling policies for each metric.

" - } - }, - "ScalingPolicy": { - "base": "

An object containing a recommended scaling policy.

", - "refs": { - "ScalingPolicies$member": null - } - }, - "ScalingPolicyMetric": { - "base": "

The metric for a scaling policy.

", - "refs": { - "GetScalingConfigurationRecommendationResponse$Metric": "

An object with a list of metrics that were benchmarked during the previously completed Inference Recommender job.

" - } - }, - "ScalingPolicyObjective": { - "base": "

An object where you specify the anticipated traffic pattern for an endpoint.

", - "refs": { - "GetScalingConfigurationRecommendationRequest$ScalingPolicyObjective": "

An object where you specify the anticipated traffic pattern for an endpoint.

", - "GetScalingConfigurationRecommendationResponse$ScalingPolicyObjective": "

An object representing the anticipated traffic pattern for an endpoint that you specified in the request.

" - } - }, - "ScheduleConfig": { - "base": "

Configuration details about the monitoring schedule.

", - "refs": { - "MonitoringScheduleConfig$ScheduleConfig": "

Configures the monitoring schedule.

" - } - }, - "ScheduleExpression": { - "base": null, - "refs": { - "ScheduleConfig$ScheduleExpression": "

A cron expression that describes details about the monitoring schedule.

The supported cron expressions are:

  • If you want to set the job to start every hour, use the following:

    Hourly: cron(0 * ? * * *)

  • If you want to start the job daily:

    cron(0 [00-23] ? * * *)

  • If you want to run the job one time, immediately, use the following keyword:

    NOW

For example, the following are valid cron expressions:

  • Daily at noon UTC: cron(0 12 ? * * *)

  • Daily at midnight UTC: cron(0 0 ? * * *)

To support running every 6, 12 hours, the following are also supported:

cron(0 [00-23]/[01-24] ? * * *)

For example, the following are valid cron expressions:

  • Every 12 hours, starting at 5pm UTC: cron(0 17/12 ? * * *)

  • Every two hours starting at midnight: cron(0 0/2 ? * * *)

  • Even though the cron expression is set to start at 5PM UTC, note that there could be a delay of 0-20 minutes from the actual requested time to run the execution.

  • We recommend that if you would like a daily schedule, you do not provide this parameter. Amazon SageMaker AI will pick a time for running every day.

You can also specify the keyword NOW to run the monitoring job immediately, one time, without recurring.

" - } - }, - "ScheduleStatus": { - "base": null, - "refs": { - "DescribeMonitoringScheduleResponse$MonitoringScheduleStatus": "

The status of an monitoring job.

", - "ListMonitoringSchedulesRequest$StatusEquals": "

A filter that returns only monitoring schedules modified before a specified time.

", - "ModelDashboardMonitoringSchedule$MonitoringScheduleStatus": "

The status of the monitoring schedule.

", - "MonitoringSchedule$MonitoringScheduleStatus": "

The status of the monitoring schedule. This can be one of the following values.

  • PENDING - The schedule is pending being created.

  • FAILED - The schedule failed.

  • SCHEDULED - The schedule was successfully created.

  • STOPPED - The schedule was stopped.

", - "MonitoringScheduleSummary$MonitoringScheduleStatus": "

The status of the monitoring schedule.

" - } - }, - "ScheduledUpdateConfig": { - "base": "

The configuration object of the schedule that SageMaker follows when updating the AMI.

", - "refs": { - "ClusterInstanceGroupDetails$ScheduledUpdateConfig": "

The configuration object of the schedule that SageMaker follows when updating the AMI.

", - "ClusterInstanceGroupSpecification$ScheduledUpdateConfig": "

The configuration object of the schedule that SageMaker uses to update the AMI.

", - "ClusterRestrictedInstanceGroupDetails$ScheduledUpdateConfig": null, - "ClusterRestrictedInstanceGroupSpecification$ScheduledUpdateConfig": null - } - }, - "SchedulerConfig": { - "base": "

Cluster policy configuration. This policy is used for task prioritization and fair-share allocation. This helps prioritize critical workloads and distributes idle compute across entities.

", - "refs": { - "CreateClusterSchedulerConfigRequest$SchedulerConfig": "

Configuration about the monitoring schedule.

", - "DescribeClusterSchedulerConfigResponse$SchedulerConfig": "

Cluster policy configuration. This policy is used for task prioritization and fair-share allocation. This helps prioritize critical workloads and distributes idle compute across entities.

", - "UpdateClusterSchedulerConfigRequest$SchedulerConfig": "

Cluster policy configuration.

" - } - }, - "SchedulerConfigComponent": { - "base": null, - "refs": { - "StatusDetailsMap$key": null - } - }, - "SchedulerResourceStatus": { - "base": null, - "refs": { - "ClusterSchedulerConfigSummary$Status": "

Status of the cluster policy.

", - "ComputeQuotaSummary$Status": "

Status of the compute allocation definition.

", - "DescribeClusterSchedulerConfigResponse$Status": "

Status of the cluster policy.

", - "DescribeComputeQuotaResponse$Status": "

Status of the compute allocation definition.

", - "ListClusterSchedulerConfigsRequest$Status": "

Filter for status.

", - "ListComputeQuotasRequest$Status": "

Filter for status.

", - "StatusDetailsMap$value": null - } - }, - "Scope": { - "base": null, - "refs": { - "OidcConfig$Scope": "

An array of string identifiers used to refer to the specific pieces of user data or claims that the client application wants to access.

", - "OidcConfigForResponse$Scope": "

An array of string identifiers used to refer to the specific pieces of user data or claims that the client application wants to access.

" - } - }, - "SearchExpression": { - "base": "

A multi-expression that searches for the specified resource or resources in a search. All resource objects that satisfy the expression's condition are included in the search results. You must specify at least one subexpression, filter, or nested filter. A SearchExpression can contain up to twenty elements.

A SearchExpression contains the following components:

  • A list of Filter objects. Each filter defines a simple Boolean expression comprised of a resource property name, Boolean operator, and value.

  • A list of NestedFilter objects. Each nested filter defines a list of Boolean expressions using a list of resource properties. A nested filter is satisfied if a single object in the list satisfies all Boolean expressions.

  • A list of SearchExpression objects. A search expression object can be nested in a list of search expression objects.

  • A Boolean operator: And or Or.

", - "refs": { - "SearchExpressionList$member": null, - "SearchRequest$SearchExpression": "

A Boolean conditional statement. Resources must satisfy this condition to be included in search results. You must provide at least one subexpression, filter, or nested filter. The maximum number of recursive SubExpressions, NestedFilters, and Filters that can be included in a SearchExpression object is 50.

" - } - }, - "SearchExpressionList": { - "base": null, - "refs": { - "SearchExpression$SubExpressions": "

A list of search expression objects.

" - } - }, - "SearchRecord": { - "base": "

A single resource returned as part of the Search API response.

", - "refs": { - "SearchResultsList$member": null - } - }, - "SearchRequest": { - "base": null, - "refs": {} - }, - "SearchResponse": { - "base": null, - "refs": {} - }, - "SearchResultsList": { - "base": null, - "refs": { - "SearchResponse$Results": "

A list of SearchRecord objects.

" - } - }, - "SearchSortOrder": { - "base": null, - "refs": { - "SearchRequest$SortOrder": "

How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.

" - } - }, - "SearchTrainingPlanOfferingsRequest": { - "base": null, - "refs": {} - }, - "SearchTrainingPlanOfferingsResponse": { - "base": null, - "refs": {} - }, - "SecondaryStatus": { - "base": null, - "refs": { - "DescribeTrainingJobResponse$SecondaryStatus": "

Provides detailed information about the state of the training job. For detailed information on the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.

SageMaker provides primary statuses and secondary statuses that apply to each of them:

InProgress

  • Starting - Starting the training job.

  • Pending - The training job is waiting for compute capacity or compute resource provision.

  • Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.

  • Training - Training is in progress.

  • Interrupted - The job stopped because the managed spot training instances were interrupted.

  • Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.

Completed

  • Completed - The training job has completed.

Failed

  • Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.

Stopped

  • MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.

  • MaxWaitTimeExceeded - The job stopped because it exceeded the maximum allowed wait time.

  • Stopped - The training job has stopped.

Stopping

  • Stopping - Stopping the training job.

Valid values for SecondaryStatus are subject to change.

We no longer support the following secondary statuses:

  • LaunchingMLInstances

  • PreparingTraining

  • DownloadingTrainingImage

", - "SecondaryStatusTransition$Status": "

Contains a secondary status information from a training job.

Status might be one of the following secondary statuses:

InProgress

  • Starting - Starting the training job.

  • Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.

  • Training - Training is in progress.

  • Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.

Completed

  • Completed - The training job has completed.

Failed

  • Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.

Stopped

  • MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.

  • Stopped - The training job has stopped.

Stopping

  • Stopping - Stopping the training job.

We no longer support the following secondary statuses:

  • LaunchingMLInstances

  • PreparingTrainingStack

  • DownloadingTrainingImage

", - "TrainingJob$SecondaryStatus": "

Provides detailed information about the state of the training job. For detailed information about the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.

SageMaker provides primary statuses and secondary statuses that apply to each of them:

InProgress

  • Starting - Starting the training job.

  • Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.

  • Training - Training is in progress.

  • Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.

Completed

  • Completed - The training job has completed.

Failed

  • Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.

Stopped

  • MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.

  • Stopped - The training job has stopped.

Stopping

  • Stopping - Stopping the training job.

Valid values for SecondaryStatus are subject to change.

We no longer support the following secondary statuses:

  • LaunchingMLInstances

  • PreparingTrainingStack

  • DownloadingTrainingImage

", - "TrainingJobSummary$SecondaryStatus": "

The secondary status of the training job.

" - } - }, - "SecondaryStatusTransition": { - "base": "

An array element of SecondaryStatusTransitions for DescribeTrainingJob. It provides additional details about a status that the training job has transitioned through. A training job can be in one of several states, for example, starting, downloading, training, or uploading. Within each state, there are a number of intermediate states. For example, within the starting state, SageMaker could be starting the training job or launching the ML instances. These transitional states are referred to as the job's secondary status.

", - "refs": { - "SecondaryStatusTransitions$member": null - } - }, - "SecondaryStatusTransitions": { - "base": null, - "refs": { - "DescribeTrainingJobResponse$SecondaryStatusTransitions": "

A history of all of the secondary statuses that the training job has transitioned through.

", - "TrainingJob$SecondaryStatusTransitions": "

A history of all of the secondary statuses that the training job has transitioned through.

" - } - }, - "SecretArn": { - "base": null, - "refs": { - "GitConfig$SecretArn": "

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the git repository. The secret must have a staging label of AWSCURRENT and must be in the following format:

{\"username\": UserName, \"password\": Password}

", - "GitConfigForUpdate$SecretArn": "

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the git repository. The secret must have a staging label of AWSCURRENT and must be in the following format:

{\"username\": UserName, \"password\": Password}

", - "IdentityProviderOAuthSetting$SecretArn": "

The ARN of an Amazon Web Services Secrets Manager secret that stores the credentials from your identity provider, such as the client ID and secret, authorization URL, and token URL.

" - } - }, - "SecurityGroupId": { - "base": null, - "refs": { - "DescribeDomainResponse$SecurityGroupIdForDomainBoundary": "

The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.

", - "DomainSecurityGroupIds$member": null, - "SecurityGroupIds$member": null, - "VpcSecurityGroupIds$member": null - } - }, - "SecurityGroupIds": { - "base": null, - "refs": { - "CreateNotebookInstanceInput$SecurityGroupIds": "

The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.

", - "DefaultSpaceSettings$SecurityGroups": "

The security group IDs for the Amazon VPC that the space uses for communication.

", - "DescribeNotebookInstanceOutput$SecurityGroups": "

The IDs of the VPC security groups.

", - "InstanceGroupMetadata$SecurityGroupIds": "

A list of security group IDs associated with the instance group.

", - "UserSettings$SecurityGroups": "

The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly.

Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly, unless specified as part of the DefaultUserSettings for the domain.

Amazon SageMaker AI adds a security group to allow NFS traffic from Amazon SageMaker AI Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.

SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

" - } - }, - "Seed": { - "base": null, - "refs": { - "ShuffleConfig$Seed": "

Determines the shuffling order in ShuffleConfig value.

" - } - }, - "SelectedStep": { - "base": "

A step selected to run in selective execution mode.

", - "refs": { - "SelectedStepList$member": null - } - }, - "SelectedStepList": { - "base": null, - "refs": { - "SelectiveExecutionConfig$SelectedSteps": "

A list of pipeline steps to run. All step(s) in all path(s) between two selected steps should be included.

" - } - }, - "SelectiveExecutionConfig": { - "base": "

The selective execution configuration applied to the pipeline run.

", - "refs": { - "DescribePipelineExecutionResponse$SelectiveExecutionConfig": "

The selective execution configuration applied to the pipeline run.

", - "PipelineExecution$SelectiveExecutionConfig": "

The selective execution configuration applied to the pipeline run.

", - "StartPipelineExecutionRequest$SelectiveExecutionConfig": "

The selective execution configuration applied to the pipeline run.

" - } - }, - "SelectiveExecutionResult": { - "base": "

The ARN from an execution of the current pipeline.

", - "refs": { - "PipelineExecutionStep$SelectiveExecutionResult": "

The ARN from an execution of the current pipeline from which results are reused for this step.

" - } - }, - "SendPipelineExecutionStepFailureRequest": { - "base": null, - "refs": {} - }, - "SendPipelineExecutionStepFailureResponse": { - "base": null, - "refs": {} - }, - "SendPipelineExecutionStepSuccessRequest": { - "base": null, - "refs": {} - }, - "SendPipelineExecutionStepSuccessResponse": { - "base": null, - "refs": {} - }, - "ServerlessJobBaseModelArn": { - "base": "

ServerlessJobConfig relevant fields

", - "refs": { - "ServerlessJobConfig$BaseModelArn": "

The base model Amazon Resource Name (ARN) in SageMaker Public Hub. SageMaker always selects the latest version of the provided model.

" - } - }, - "ServerlessJobConfig": { - "base": "

The configuration for the serverless training job.

", - "refs": { - "CreateTrainingJobRequest$ServerlessJobConfig": "

The configuration for serverless training jobs.

", - "DescribeTrainingJobResponse$ServerlessJobConfig": "

The configuration for serverless training jobs.

" - } - }, - "ServerlessJobType": { - "base": null, - "refs": { - "ServerlessJobConfig$JobType": "

The serverless training job type.

" - } - }, - "ServerlessMaxConcurrency": { - "base": null, - "refs": { - "ProductionVariantServerlessConfig$MaxConcurrency": "

The maximum number of concurrent invocations your serverless endpoint can process.

", - "ProductionVariantServerlessUpdateConfig$MaxConcurrency": "

The updated maximum number of concurrent invocations your serverless endpoint can process.

" - } - }, - "ServerlessMemorySizeInMB": { - "base": null, - "refs": { - "ProductionVariantServerlessConfig$MemorySizeInMB": "

The memory size of your serverless endpoint. Valid values are in 1 GB increments: 1024 MB, 2048 MB, 3072 MB, 4096 MB, 5120 MB, or 6144 MB.

" - } - }, - "ServerlessProvisionedConcurrency": { - "base": null, - "refs": { - "ProductionVariantServerlessConfig$ProvisionedConcurrency": "

The amount of provisioned concurrency to allocate for the serverless endpoint. Should be less than or equal to MaxConcurrency.

This field is not supported for serverless endpoint recommendations for Inference Recommender jobs. For more information about creating an Inference Recommender job, see CreateInferenceRecommendationsJobs.

", - "ProductionVariantServerlessUpdateConfig$ProvisionedConcurrency": "

The updated amount of provisioned concurrency to allocate for the serverless endpoint. Should be less than or equal to MaxConcurrency.

" - } - }, - "ServiceCatalogEntityId": { - "base": null, - "refs": { - "ServiceCatalogProvisionedProductDetails$ProvisionedProductId": "

The ID of the provisioned product.

", - "ServiceCatalogProvisioningDetails$ProductId": "

The ID of the product to provision.

", - "ServiceCatalogProvisioningDetails$ProvisioningArtifactId": "

The ID of the provisioning artifact.

", - "ServiceCatalogProvisioningDetails$PathId": "

The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path.

", - "ServiceCatalogProvisioningUpdateDetails$ProvisioningArtifactId": "

The ID of the provisioning artifact.

" - } - }, - "ServiceCatalogProvisionedProductDetails": { - "base": "

Details of a provisioned service catalog product. For information about service catalog, see What is Amazon Web Services Service Catalog.

", - "refs": { - "DescribeProjectOutput$ServiceCatalogProvisionedProductDetails": "

Information about a provisioned service catalog product.

", - "Project$ServiceCatalogProvisionedProductDetails": null - } - }, - "ServiceCatalogProvisioningDetails": { - "base": "

Details that you specify to provision a service catalog product. For information about service catalog, see What is Amazon Web Services Service Catalog.

", - "refs": { - "CreateProjectInput$ServiceCatalogProvisioningDetails": "

The product ID and provisioning artifact ID to provision a service catalog. The provisioning artifact ID will default to the latest provisioning artifact ID of the product, if you don't provide the provisioning artifact ID. For more information, see What is Amazon Web Services Service Catalog.

", - "DescribeProjectOutput$ServiceCatalogProvisioningDetails": "

Information used to provision a service catalog product. For information, see What is Amazon Web Services Service Catalog.

", - "Project$ServiceCatalogProvisioningDetails": null - } - }, - "ServiceCatalogProvisioningUpdateDetails": { - "base": "

Details that you specify to provision a service catalog product. For information about service catalog, see What is Amazon Web Services Service Catalog.

", - "refs": { - "UpdateProjectInput$ServiceCatalogProvisioningUpdateDetails": "

The product ID and provisioning artifact ID to provision a service catalog. The provisioning artifact ID will default to the latest provisioning artifact ID of the product, if you don't provide the provisioning artifact ID. For more information, see What is Amazon Web Services Service Catalog.

" - } - }, - "SessionChainingConfig": { - "base": "

Contains information about attribute-based access control (ABAC) for a training job. The session chaining configuration uses Amazon Security Token Service (STS) for your training job to request temporary, limited-privilege credentials to tenants. For more information, see Attribute-based access control (ABAC) for multi-tenancy training.

", - "refs": { - "CreateTrainingJobRequest$SessionChainingConfig": "

Contains information about attribute-based access control (ABAC) for the training job.

" - } - }, - "SessionExpirationDurationInSeconds": { - "base": null, - "refs": { - "CreatePartnerAppPresignedUrlRequest$SessionExpirationDurationInSeconds": "

Indicates how long the Amazon SageMaker Partner AI App session can be accessed for after logging in.

", - "CreatePresignedDomainUrlRequest$SessionExpirationDurationInSeconds": "

The session expiration duration in seconds. This value defaults to 43200.

", - "CreatePresignedMlflowAppUrlRequest$SessionExpirationDurationInSeconds": "

The duration in seconds that your presigned URL is valid. The presigned URL can be used only once.

", - "CreatePresignedMlflowTrackingServerUrlRequest$SessionExpirationDurationInSeconds": "

The duration in seconds that your MLflow UI session is valid.

", - "CreatePresignedNotebookInstanceUrlInput$SessionExpirationDurationInSeconds": "

The duration of the session, in seconds. The default is 12 hours.

" - } - }, - "SessionId": { - "base": null, - "refs": { - "StartSessionResponse$SessionId": "

A unique identifier for the established remote connection session.

" - } - }, - "ShadowModeConfig": { - "base": "

The configuration of ShadowMode inference experiment type, which specifies a production variant to take all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant it also specifies the percentage of requests that Amazon SageMaker replicates.

", - "refs": { - "CreateInferenceExperimentRequest$ShadowModeConfig": "

The configuration of ShadowMode inference experiment type. Use this field to specify a production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant also specify the percentage of requests that Amazon SageMaker replicates.

", - "DescribeInferenceExperimentResponse$ShadowModeConfig": "

The configuration of ShadowMode inference experiment type, which shows the production variant that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant it also shows the percentage of requests that Amazon SageMaker replicates.

", - "UpdateInferenceExperimentRequest$ShadowModeConfig": "

The configuration of ShadowMode inference experiment type. Use this field to specify a production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant also specify the percentage of requests that Amazon SageMaker replicates.

" - } - }, - "ShadowModelVariantConfig": { - "base": "

The name and sampling percentage of a shadow variant.

", - "refs": { - "ShadowModelVariantConfigList$member": null - } - }, - "ShadowModelVariantConfigList": { - "base": null, - "refs": { - "ShadowModeConfig$ShadowModelVariants": "

List of shadow variant configurations.

" - } - }, - "SharingSettings": { - "base": "

Specifies options for sharing Amazon SageMaker AI Studio notebooks. These settings are specified as part of DefaultUserSettings when the CreateDomain API is called, and as part of UserSettings when the CreateUserProfile API is called. When SharingSettings is not specified, notebook sharing isn't allowed.

", - "refs": { - "UserSettings$SharingSettings": "

Specifies options for sharing Amazon SageMaker AI Studio notebooks.

" - } - }, - "SharingType": { - "base": null, - "refs": { - "SpaceSharingSettings$SharingType": "

Specifies the sharing type of the space.

", - "SpaceSharingSettingsSummary$SharingType": "

Specifies the sharing type of the space.

" - } - }, - "ShuffleConfig": { - "base": "

A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType, the results of the S3 key prefix matches are shuffled. If you use ManifestFile, the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile, the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value.

For Pipe input mode, when ShuffleConfig is specified shuffling is done at the start of every epoch. With large datasets, this ensures that the order of the training data is different for each epoch, and it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key, the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.

", - "refs": { - "Channel$ShuffleConfig": "

A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType, this shuffles the results of the S3 key prefix matches. If you use ManifestFile, the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile, the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value.

For Pipe input mode, shuffling is done at the start of every epoch. With large datasets this ensures that the order of the training data is different for each epoch, it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key, the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.

" - } - }, - "SingleSignOnApplicationArn": { - "base": null, - "refs": { - "DescribeDomainResponse$SingleSignOnApplicationArn": "

The ARN of the application managed by SageMaker AI in IAM Identity Center. This value is only returned for domains created after October 1, 2023.

", - "UnifiedStudioSettings$SingleSignOnApplicationArn": "

The ARN of the Amazon DataZone application managed by Amazon SageMaker Unified Studio in the Amazon Web Services IAM Identity Center.

" - } - }, - "SingleSignOnUserIdentifier": { - "base": null, - "refs": { - "CreateUserProfileRequest$SingleSignOnUserIdentifier": "

A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is \"UserName\". If the Domain's AuthMode is IAM Identity Center, this field is required. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.

", - "DescribeUserProfileResponse$SingleSignOnUserIdentifier": "

The IAM Identity Center user identifier.

" - } - }, - "SkipModelValidation": { - "base": null, - "refs": { - "CreateModelPackageInput$SkipModelValidation": "

Indicates if you want to skip model validation.

", - "DescribeModelPackageOutput$SkipModelValidation": "

Indicates if you want to skip model validation.

", - "ModelPackage$SkipModelValidation": "

Indicates if you want to skip model validation.

" - } - }, - "SnsTopicArn": { - "base": null, - "refs": { - "AsyncInferenceNotificationConfig$SuccessTopic": "

Amazon SNS topic to post a notification to when inference completes successfully. If no topic is provided, no notification is sent on success.

", - "AsyncInferenceNotificationConfig$ErrorTopic": "

Amazon SNS topic to post a notification to when inference fails. If no topic is provided, no notification is sent on failure.

", - "LabelingJobOutputConfig$SnsTopicArn": "

An Amazon Simple Notification Service (Amazon SNS) output topic ARN. Provide a SnsTopicArn if you want to do real time chaining to another streaming job and receive an Amazon SNS notifications each time a data object is submitted by a worker.

If you provide an SnsTopicArn in OutputConfig, when workers complete labeling tasks, Ground Truth will send labeling task output data to the SNS output topic you specify here.

To learn more, see Receive Output Data from a Streaming Labeling Job.

", - "LabelingJobSnsDataSource$SnsTopicArn": "

The Amazon SNS input topic Amazon Resource Name (ARN). Specify the ARN of the input topic you will use to send new data objects to a streaming labeling job.

" - } - }, - "SoftwareUpdateStatus": { - "base": null, - "refs": { - "ClusterInstanceGroupDetails$SoftwareUpdateStatus": "

Status of the last software udpate request.

Status transitions follow these possible sequences:

  • Pending -> InProgress -> Succeeded

  • Pending -> InProgress -> RollbackInProgress -> RollbackComplete

  • Pending -> InProgress -> RollbackInProgress -> Failed

" - } - }, - "SortActionsBy": { - "base": null, - "refs": { - "ListActionsRequest$SortBy": "

The property used to sort results. The default value is CreationTime.

" - } - }, - "SortArtifactsBy": { - "base": null, - "refs": { - "ListArtifactsRequest$SortBy": "

The property used to sort results. The default value is CreationTime.

" - } - }, - "SortAssociationsBy": { - "base": null, - "refs": { - "ListAssociationsRequest$SortBy": "

The property used to sort results. The default value is CreationTime.

" - } - }, - "SortBy": { - "base": null, - "refs": { - "ListJobsRequest$SortBy": "

The field to sort results by.

", - "ListLabelingJobsRequest$SortBy": "

The field to sort results by. The default is CreationTime.

", - "ListProcessingJobsRequest$SortBy": "

The field to sort results by. The default is CreationTime.

", - "ListTrainingJobsRequest$SortBy": "

The field to sort results by. The default is CreationTime.

", - "ListTransformJobsRequest$SortBy": "

The field to sort results by. The default is CreationTime.

" - } - }, - "SortClusterSchedulerConfigBy": { - "base": null, - "refs": { - "ListClusterSchedulerConfigsRequest$SortBy": "

Filter for sorting the list by a given value. For example, sort by name, creation time, or status.

" - } - }, - "SortContextsBy": { - "base": null, - "refs": { - "ListContextsRequest$SortBy": "

The property used to sort results. The default value is CreationTime.

" - } - }, - "SortExperimentsBy": { - "base": null, - "refs": { - "ListExperimentsRequest$SortBy": "

The property used to sort results. The default value is CreationTime.

" - } - }, - "SortInferenceExperimentsBy": { - "base": null, - "refs": { - "ListInferenceExperimentsRequest$SortBy": "

The column by which to sort the listed inference experiments.

" - } - }, - "SortLineageGroupsBy": { - "base": null, - "refs": { - "ListLineageGroupsRequest$SortBy": "

The parameter by which to sort the results. The default is CreationTime.

" - } - }, - "SortMlflowAppBy": { - "base": null, - "refs": { - "ListMlflowAppsRequest$SortBy": "

Filter for MLflow Apps sorting by name, creation time, or creation status.

" - } - }, - "SortOrder": { - "base": null, - "refs": { - "ListAIBenchmarkJobsRequest$SortOrder": "

The sort order for results. The default is Descending.

", - "ListAIRecommendationJobsRequest$SortOrder": "

The sort order for results. The default is Descending.

", - "ListAIWorkloadConfigsRequest$SortOrder": "

The sort order for results. The default is Descending.

", - "ListActionsRequest$SortOrder": "

The sort order. The default value is Descending.

", - "ListAlgorithmsInput$SortOrder": "

The sort order for the results. The default is Ascending.

", - "ListAppImageConfigsRequest$SortOrder": "

The sort order. The default value is Descending.

", - "ListAppsRequest$SortOrder": "

The sort order for the results. The default is Ascending.

", - "ListArtifactsRequest$SortOrder": "

The sort order. The default value is Descending.

", - "ListAssociationsRequest$SortOrder": "

The sort order. The default value is Descending.

", - "ListClusterEventsRequest$SortOrder": "

The order in which to sort the results. Valid values are Ascending or Descending (the default is Descending).

", - "ListClusterNodesRequest$SortOrder": "

The sort order for results. The default value is Ascending.

", - "ListClusterSchedulerConfigsRequest$SortOrder": "

The order of the list. By default, listed in Descending order according to by SortBy. To change the list order, you can specify SortOrder to be Ascending.

", - "ListClustersRequest$SortOrder": "

The sort order for results. The default value is Ascending.

", - "ListCompilationJobsRequest$SortOrder": "

The sort order for results. The default is Ascending.

", - "ListComputeQuotasRequest$SortOrder": "

The order of the list. By default, listed in Descending order according to by SortBy. To change the list order, you can specify SortOrder to be Ascending.

", - "ListContextsRequest$SortOrder": "

The sort order. The default value is Descending.

", - "ListDataQualityJobDefinitionsRequest$SortOrder": "

Whether to sort the results in Ascending or Descending order. The default is Descending.

", - "ListDeviceFleetsRequest$SortOrder": "

What direction to sort in.

", - "ListEdgeDeploymentPlansRequest$SortOrder": "

The direction of the sorting (ascending or descending).

", - "ListEdgePackagingJobsRequest$SortOrder": "

What direction to sort by.

", - "ListExperimentsRequest$SortOrder": "

The sort order. The default value is Descending.

", - "ListFlowDefinitionsRequest$SortOrder": "

An optional value that specifies whether you want the results sorted in Ascending or Descending order.

", - "ListHubContentVersionsRequest$SortOrder": "

Sort hub content versions by ascending or descending order.

", - "ListHubContentsRequest$SortOrder": "

Sort hubs by ascending or descending order.

", - "ListHubsRequest$SortOrder": "

Sort hubs by ascending or descending order.

", - "ListHumanTaskUisRequest$SortOrder": "

An optional value that specifies whether you want the results sorted in Ascending or Descending order.

", - "ListHyperParameterTuningJobsRequest$SortOrder": "

The sort order for results. The default is Ascending.

", - "ListInferenceExperimentsRequest$SortOrder": "

The direction of sorting (ascending or descending).

", - "ListInferenceRecommendationsJobsRequest$SortOrder": "

The sort order for the results.

", - "ListJobsRequest$SortOrder": "

The sort order for results. Valid values are Ascending and Descending.

", - "ListLabelingJobsForWorkteamRequest$SortOrder": "

The sort order for results. The default is Ascending.

", - "ListLabelingJobsRequest$SortOrder": "

The sort order for results. The default is Ascending.

", - "ListLineageGroupsRequest$SortOrder": "

The sort order for the results. The default is Ascending.

", - "ListMlflowAppsRequest$SortOrder": "

Change the order of the listed MLflow Apps. By default, MLflow Apps are listed in Descending order by creation time. To change the list order, specify SortOrder to be Ascending.

", - "ListMlflowTrackingServersRequest$SortOrder": "

Change the order of the listed tracking servers. By default, tracking servers are listed in Descending order by creation time. To change the list order, you can specify SortOrder to be Ascending.

", - "ListModelBiasJobDefinitionsRequest$SortOrder": "

Whether to sort the results in Ascending or Descending order. The default is Descending.

", - "ListModelExplainabilityJobDefinitionsRequest$SortOrder": "

Whether to sort the results in Ascending or Descending order. The default is Descending.

", - "ListModelPackageGroupsInput$SortOrder": "

The sort order for results. The default is Ascending.

", - "ListModelPackagesInput$SortOrder": "

The sort order for the results. The default is Ascending.

", - "ListModelQualityJobDefinitionsRequest$SortOrder": "

Whether to sort the results in Ascending or Descending order. The default is Descending.

", - "ListMonitoringAlertHistoryRequest$SortOrder": "

The sort order, whether Ascending or Descending, of the alert history. The default is Descending.

", - "ListMonitoringExecutionsRequest$SortOrder": "

Whether to sort the results in Ascending or Descending order. The default is Descending.

", - "ListMonitoringSchedulesRequest$SortOrder": "

Whether to sort the results in Ascending or Descending order. The default is Descending.

", - "ListOptimizationJobsRequest$SortOrder": "

The sort order for results. The default is Ascending

", - "ListPipelineExecutionStepsRequest$SortOrder": "

The field by which to sort results. The default is CreatedTime.

", - "ListPipelineExecutionsRequest$SortOrder": "

The sort order for results.

", - "ListPipelineVersionsRequest$SortOrder": "

The sort order for the results.

", - "ListPipelinesRequest$SortOrder": "

The sort order for results.

", - "ListProcessingJobsRequest$SortOrder": "

The sort order for results. The default is Ascending.

", - "ListSpacesRequest$SortOrder": "

The sort order for the results. The default is Ascending.

", - "ListStudioLifecycleConfigsRequest$SortOrder": "

The sort order. The default value is Descending.

", - "ListTrainingJobsForHyperParameterTuningJobRequest$SortOrder": "

The sort order for results. The default is Ascending.

", - "ListTrainingJobsRequest$SortOrder": "

The sort order for results. The default is Ascending.

", - "ListTransformJobsRequest$SortOrder": "

The sort order for results. The default is Descending.

", - "ListTrialComponentsRequest$SortOrder": "

The sort order. The default value is Descending.

", - "ListTrialsRequest$SortOrder": "

The sort order. The default value is Descending.

", - "ListUserProfilesRequest$SortOrder": "

The sort order for the results. The default is Ascending.

", - "ListWorkforcesRequest$SortOrder": "

Sort workforces in ascending or descending order.

", - "ListWorkteamsRequest$SortOrder": "

The sort order for results. The default is Ascending.

" - } - }, - "SortPipelineExecutionsBy": { - "base": null, - "refs": { - "ListPipelineExecutionsRequest$SortBy": "

The field by which to sort results. The default is CreatedTime.

" - } - }, - "SortPipelinesBy": { - "base": null, - "refs": { - "ListPipelinesRequest$SortBy": "

The field by which to sort results. The default is CreatedTime.

" - } - }, - "SortQuotaBy": { - "base": null, - "refs": { - "ListComputeQuotasRequest$SortBy": "

Filter for sorting the list by a given value. For example, sort by name, creation time, or status.

" - } - }, - "SortTrackingServerBy": { - "base": null, - "refs": { - "ListMlflowTrackingServersRequest$SortBy": "

Filter for trackings servers sorting by name, creation time, or creation status.

" - } - }, - "SortTrialComponentsBy": { - "base": null, - "refs": { - "ListTrialComponentsRequest$SortBy": "

The property used to sort results. The default value is CreationTime.

" - } - }, - "SortTrialsBy": { - "base": null, - "refs": { - "ListTrialsRequest$SortBy": "

The property used to sort results. The default value is CreationTime.

" - } - }, - "SourceAlgorithm": { - "base": "

Specifies an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you are subscribed to.

", - "refs": { - "SourceAlgorithmList$member": null - } - }, - "SourceAlgorithmList": { - "base": null, - "refs": { - "SourceAlgorithmSpecification$SourceAlgorithms": "

A list of the algorithms that were used to create a model package.

" - } - }, - "SourceAlgorithmSpecification": { - "base": "

A list of algorithms that were used to create a model package.

", - "refs": { - "CreateModelPackageInput$SourceAlgorithmSpecification": "

Details about the algorithm that was used to create the model package.

", - "DescribeModelPackageOutput$SourceAlgorithmSpecification": "

Details about the algorithm that was used to create the model package.

", - "ModelPackage$SourceAlgorithmSpecification": "

A list of algorithms that were used to create a model package.

" - } - }, - "SourceIpConfig": { - "base": "

A list of IP address ranges (CIDRs). Used to create an allow list of IP addresses for a private workforce. Workers will only be able to log in to their worker portal from an IP address within this range. By default, a workforce isn't restricted to specific IP addresses.

", - "refs": { - "CreateWorkforceRequest$SourceIpConfig": null, - "UpdateWorkforceRequest$SourceIpConfig": "

A list of one to ten worker IP address ranges (CIDRs) that can be used to access tasks assigned to this workforce.

Maximum: Ten CIDR values

", - "Workforce$SourceIpConfig": "

A list of one to ten IP address ranges (CIDRs) to be added to the workforce allow list. By default, a workforce isn't restricted to specific IP addresses.

" - } - }, - "SourceType": { - "base": null, - "refs": { - "ExperimentSource$SourceType": "

The source type.

", - "TrialComponentSource$SourceType": "

The source job type.

", - "TrialSource$SourceType": "

The source job type.

" - } - }, - "SourceUri": { - "base": null, - "refs": { - "ActionSource$SourceUri": "

The URI of the source.

", - "ArtifactSource$SourceUri": "

The URI of the source.

", - "ContextSource$SourceUri": "

The URI of the source.

", - "ListActionsRequest$SourceUri": "

A filter that returns only actions with the specified source URI.

", - "ListArtifactsRequest$SourceUri": "

A filter that returns only artifacts with the specified source URI.

", - "ListContextsRequest$SourceUri": "

A filter that returns only contexts with the specified source URI.

" - } - }, - "SpaceAppLifecycleManagement": { - "base": "

Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio applications in a space.

", - "refs": { - "SpaceCodeEditorAppSettings$AppLifecycleManagement": "

Settings that are used to configure and manage the lifecycle of CodeEditor applications in a space.

", - "SpaceJupyterLabAppSettings$AppLifecycleManagement": "

Settings that are used to configure and manage the lifecycle of JupyterLab applications in a space.

" - } - }, - "SpaceArn": { - "base": null, - "refs": { - "CreateSpaceResponse$SpaceArn": "

The space's Amazon Resource Name (ARN).

", - "DescribeSpaceResponse$SpaceArn": "

The space's Amazon Resource Name (ARN).

", - "UpdateSpaceResponse$SpaceArn": "

The space's Amazon Resource Name (ARN).

" - } - }, - "SpaceCodeEditorAppSettings": { - "base": "

The application settings for a Code Editor space.

", - "refs": { - "SpaceSettings$CodeEditorAppSettings": "

The Code Editor application settings.

" - } - }, - "SpaceDetails": { - "base": "

The space's details.

", - "refs": { - "SpaceList$member": null - } - }, - "SpaceEbsVolumeSizeInGb": { - "base": null, - "refs": { - "DefaultEbsStorageSettings$DefaultEbsVolumeSizeInGb": "

The default size of the EBS storage volume for a space.

", - "DefaultEbsStorageSettings$MaximumEbsVolumeSizeInGb": "

The maximum size of the EBS storage volume for a space.

", - "EbsStorageSettings$EbsVolumeSizeInGb": "

The size of an EBS storage volume for a space.

" - } - }, - "SpaceIdleSettings": { - "base": "

Settings related to idle shutdown of Studio applications in a space.

", - "refs": { - "SpaceAppLifecycleManagement$IdleSettings": "

Settings related to idle shutdown of Studio applications.

" - } - }, - "SpaceJupyterLabAppSettings": { - "base": "

The settings for the JupyterLab application within a space.

", - "refs": { - "SpaceSettings$JupyterLabAppSettings": "

The settings for the JupyterLab application.

" - } - }, - "SpaceList": { - "base": null, - "refs": { - "ListSpacesResponse$Spaces": "

The list of spaces.

" - } - }, - "SpaceName": { - "base": null, - "refs": { - "AppDetails$SpaceName": "

The name of the space.

", - "CreateAppRequest$SpaceName": "

The name of the space. If this value is not set, then UserProfileName must be set.

", - "CreatePresignedDomainUrlRequest$SpaceName": "

The name of the space.

", - "CreateSpaceRequest$SpaceName": "

The name of the space.

", - "DeleteAppRequest$SpaceName": "

The name of the space. If this value is not set, then UserProfileName must be set.

", - "DeleteSpaceRequest$SpaceName": "

The name of the space.

", - "DescribeAppRequest$SpaceName": "

The name of the space.

", - "DescribeAppResponse$SpaceName": "

The name of the space. If this value is not set, then UserProfileName must be set.

", - "DescribeSpaceRequest$SpaceName": "

The name of the space.

", - "DescribeSpaceResponse$SpaceName": "

The name of the space.

", - "ListAppsRequest$SpaceNameEquals": "

A parameter to search by space name. If UserProfileNameEquals is set, then this value cannot be set.

", - "ListSpacesRequest$SpaceNameContains": "

A parameter by which to filter the results.

", - "SpaceDetails$SpaceName": "

The name of the space.

", - "UpdateSpaceRequest$SpaceName": "

The name of the space.

" - } - }, - "SpaceSettings": { - "base": "

A collection of space settings.

", - "refs": { - "CreateSpaceRequest$SpaceSettings": "

A collection of space settings.

", - "DescribeSpaceResponse$SpaceSettings": "

A collection of space settings.

", - "UpdateSpaceRequest$SpaceSettings": "

A collection of space settings.

" - } - }, - "SpaceSettingsSummary": { - "base": "

Specifies summary information about the space settings.

", - "refs": { - "SpaceDetails$SpaceSettingsSummary": "

Specifies summary information about the space settings.

" - } - }, - "SpaceSharingSettings": { - "base": "

A collection of space sharing settings.

", - "refs": { - "CreateSpaceRequest$SpaceSharingSettings": "

A collection of space sharing settings.

", - "DescribeSpaceResponse$SpaceSharingSettings": "

The collection of space sharing settings for a space.

" - } - }, - "SpaceSharingSettingsSummary": { - "base": "

Specifies summary information about the space sharing settings.

", - "refs": { - "SpaceDetails$SpaceSharingSettingsSummary": "

Specifies summary information about the space sharing settings.

" - } - }, - "SpaceSortKey": { - "base": null, - "refs": { - "ListSpacesRequest$SortBy": "

The parameter by which to sort the results. The default is CreationTime.

" - } - }, - "SpaceStatus": { - "base": null, - "refs": { - "DescribeSpaceResponse$Status": "

The status.

", - "SpaceDetails$Status": "

The status.

" - } - }, - "SpaceStorageSettings": { - "base": "

The storage settings for a space.

", - "refs": { - "SpaceSettings$SpaceStorageSettings": "

The storage settings for a space.

", - "SpaceSettingsSummary$SpaceStorageSettings": "

The storage settings for a space.

" - } - }, - "SpareInstanceCountPerUltraServer": { - "base": null, - "refs": { - "CreateTrainingPlanRequest$SpareInstanceCountPerUltraServer": "

Number of spare instances to reserve per UltraServer for enhanced resiliency. Default is 1.

" - } - }, - "SpawnRate": { - "base": null, - "refs": { - "Phase$SpawnRate": "

Specified how many new users to spawn in a minute.

" - } - }, - "SplitType": { - "base": null, - "refs": { - "TransformInput$SplitType": "

The method to use to split the transform job's data files into smaller batches. Splitting is necessary when the total size of each object is too large to fit in a single request. You can also use data splitting to improve performance by processing multiple concurrent mini-batches. The default value for SplitType is None, which indicates that input data files are not split, and request payloads contain the entire contents of an input object. Set the value of this parameter to Line to split records on a newline character boundary. SplitType also supports a number of record-oriented binary data formats. Currently, the supported record formats are:

  • RecordIO

  • TFRecord

When splitting is enabled, the size of a mini-batch depends on the values of the BatchStrategy and MaxPayloadInMB parameters. When the value of BatchStrategy is MultiRecord, Amazon SageMaker sends the maximum number of records in each request, up to the MaxPayloadInMB limit. If the value of BatchStrategy is SingleRecord, Amazon SageMaker sends individual records in each request.

Some data formats represent a record as a binary payload wrapped with extra padding bytes. When splitting is applied to a binary data format, padding is removed if the value of BatchStrategy is set to SingleRecord. Padding is not removed if the value of BatchStrategy is set to MultiRecord.

For more information about RecordIO, see Create a Dataset Using RecordIO in the MXNet documentation. For more information about TFRecord, see Consuming TFRecord data in the TensorFlow documentation.

" - } - }, - "StageDescription": { - "base": null, - "refs": { - "ModelLifeCycle$StageDescription": "

Describes the stage related details.

" - } - }, - "StageStatus": { - "base": null, - "refs": { - "EdgeDeploymentStatus$StageStatus": "

The general status of the current stage.

" - } - }, - "Stairs": { - "base": "

Defines the stairs traffic pattern for an Inference Recommender load test. This pattern type consists of multiple steps where the number of users increases at each step.

Specify either the stairs or phases traffic pattern.

", - "refs": { - "TrafficPattern$Stairs": "

Defines the stairs traffic pattern.

" - } - }, - "StartClusterHealthCheckRequest": { - "base": null, - "refs": {} - }, - "StartClusterHealthCheckResponse": { - "base": null, - "refs": {} - }, - "StartEdgeDeploymentStageRequest": { - "base": null, - "refs": {} - }, - "StartInferenceExperimentRequest": { - "base": null, - "refs": {} - }, - "StartInferenceExperimentResponse": { - "base": null, - "refs": {} - }, - "StartMlflowTrackingServerRequest": { - "base": null, - "refs": {} - }, - "StartMlflowTrackingServerResponse": { - "base": null, - "refs": {} - }, - "StartMonitoringScheduleRequest": { - "base": null, - "refs": {} - }, - "StartNotebookInstanceInput": { - "base": null, - "refs": {} - }, - "StartPipelineExecutionRequest": { - "base": null, - "refs": {} - }, - "StartPipelineExecutionResponse": { - "base": null, - "refs": {} - }, - "StartSessionRequest": { - "base": null, - "refs": {} - }, - "StartSessionResponse": { - "base": null, - "refs": {} - }, - "Statistic": { - "base": null, - "refs": { - "CustomizedMetricSpecification$Statistic": "

The statistic of the customized metric.

" - } - }, - "StatusDetails": { - "base": null, - "refs": { - "DebugRuleEvaluationStatus$StatusDetails": "

Details from the rule evaluation.

", - "ProfilerRuleEvaluationStatus$StatusDetails": "

Details from the rule evaluation.

" - } - }, - "StatusDetailsMap": { - "base": null, - "refs": { - "DescribeClusterSchedulerConfigResponse$StatusDetails": "

Additional details about the status of the cluster policy. This field provides context when the policy is in a non-active state, such as during creation, updates, or if failures occur.

" - } - }, - "StatusMessage": { - "base": null, - "refs": { - "SecondaryStatusTransition$StatusMessage": "

A detailed description of the progress within a secondary status.

SageMaker provides secondary statuses and status messages that apply to each of them:

Starting

  • Starting the training job.

  • Launching requested ML instances.

  • Insufficient capacity error from EC2 while launching instances, retrying!

  • Launched instance was unhealthy, replacing it!

  • Preparing the instances for training.

Training

  • Training image download completed. Training in progress.

Status messages are subject to change. Therefore, we recommend not including them in code that programmatically initiates actions. For examples, don't use status messages in if statements.

To have an overview of your training job's progress, view TrainingJobStatus and SecondaryStatus in DescribeTrainingJob, and StatusMessage together. For example, at the start of a training job, you might see the following:

  • TrainingJobStatus - InProgress

  • SecondaryStatus - Training

  • StatusMessage - Downloading the training image

" - } - }, - "StepDescription": { - "base": null, - "refs": { - "PipelineExecutionStep$StepDescription": "

The description of the step.

" - } - }, - "StepDisplayName": { - "base": null, - "refs": { - "PipelineExecutionStep$StepDisplayName": "

The display name of the step.

" - } - }, - "StepName": { - "base": null, - "refs": { - "PipelineExecutionStep$StepName": "

The name of the step that is executed.

" - } - }, - "StepStatus": { - "base": null, - "refs": { - "PipelineExecutionStep$StepStatus": "

The status of the step execution.

" - } - }, - "StopAIBenchmarkJobRequest": { - "base": null, - "refs": {} - }, - "StopAIBenchmarkJobResponse": { - "base": null, - "refs": {} - }, - "StopAIRecommendationJobRequest": { - "base": null, - "refs": {} - }, - "StopAIRecommendationJobResponse": { - "base": null, - "refs": {} - }, - "StopAutoMLJobRequest": { - "base": null, - "refs": {} - }, - "StopCompilationJobRequest": { - "base": null, - "refs": {} - }, - "StopEdgeDeploymentStageRequest": { - "base": null, - "refs": {} - }, - "StopEdgePackagingJobRequest": { - "base": null, - "refs": {} - }, - "StopHyperParameterTuningJobRequest": { - "base": null, - "refs": {} - }, - "StopInferenceExperimentRequest": { - "base": null, - "refs": {} - }, - "StopInferenceExperimentResponse": { - "base": null, - "refs": {} - }, - "StopInferenceRecommendationsJobRequest": { - "base": null, - "refs": {} - }, - "StopJobRequest": { - "base": null, - "refs": {} - }, - "StopJobResponse": { - "base": null, - "refs": {} - }, - "StopLabelingJobRequest": { - "base": null, - "refs": {} - }, - "StopMlflowTrackingServerRequest": { - "base": null, - "refs": {} - }, - "StopMlflowTrackingServerResponse": { - "base": null, - "refs": {} - }, - "StopMonitoringScheduleRequest": { - "base": null, - "refs": {} - }, - "StopNotebookInstanceInput": { - "base": null, - "refs": {} - }, - "StopOptimizationJobRequest": { - "base": null, - "refs": {} - }, - "StopPipelineExecutionRequest": { - "base": null, - "refs": {} - }, - "StopPipelineExecutionResponse": { - "base": null, - "refs": {} - }, - "StopProcessingJobRequest": { - "base": null, - "refs": {} - }, - "StopTrainingJobRequest": { - "base": null, - "refs": {} - }, - "StopTransformJobRequest": { - "base": null, - "refs": {} - }, - "StoppingCondition": { - "base": "

Specifies a limit to how long a job can run. When the job reaches the time limit, SageMaker ends the job. Use this API to cap costs.

To stop a training job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

The training algorithms provided by SageMaker automatically save the intermediate results of a model training job when possible. This attempt to save artifacts is only a best effort case as model might not be in a state from which it can be saved. For example, if training has just started, the model might not be ready to save. When saved, this intermediate data is a valid model artifact. You can use it to create a model with CreateModel.

The Neural Topic Model (NTM) currently does not support saving intermediate model artifacts. When training NTMs, make sure that the maximum runtime is sufficient for the training job to complete.

", - "refs": { - "CreateCompilationJobRequest$StoppingCondition": "

Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker AI ends the compilation job. Use this API to cap model training costs.

", - "CreateOptimizationJobRequest$StoppingCondition": null, - "CreateTrainingJobRequest$StoppingCondition": "

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

", - "DescribeCompilationJobResponse$StoppingCondition": "

Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker AI ends the compilation job. Use this API to cap model training costs.

", - "DescribeOptimizationJobResponse$StoppingCondition": null, - "DescribeTrainingJobResponse$StoppingCondition": "

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

", - "HyperParameterTrainingJobDefinition$StoppingCondition": "

Specifies a limit to how long a model hyperparameter training job can run. It also specifies how long a managed spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

", - "TrainingJob$StoppingCondition": "

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

", - "TrainingJobDefinition$StoppingCondition": "

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts.

" - } - }, - "StorageType": { - "base": null, - "refs": { - "OnlineStoreConfig$StorageType": "

Option for different tiers of low latency storage for real-time data retrieval.

  • Standard: A managed low latency data store for feature groups.

  • InMemory: A managed data store for feature groups that supports very low latency retrieval.

" - } - }, - "StreamUrl": { - "base": null, - "refs": { - "StartSessionResponse$StreamUrl": "

A WebSocket URL used to establish a SSH connection between the local IDE and remote SageMaker space.

" - } - }, - "String": { - "base": null, - "refs": { - "AIBenchmarkEndpoint$TargetContainerHostname": "

The hostname of the specific container to target within a multi-container endpoint.

", - "AICloudWatchLogs$LogGroupArn": "

The Amazon Resource Name (ARN) of the CloudWatch log group.

", - "AICloudWatchLogs$LogStreamName": "

The name of the CloudWatch log stream.

", - "AIRecommendation$RecommendationDescription": "

A description of the recommendation.

", - "AIRecommendationDeploymentConfiguration$ImageUri": "

The URI of the container image for the deployment.

", - "AIRecommendationOptimizationConfigMap$key": null, - "AIRecommendationOptimizationConfigMap$value": null, - "AIRecommendationPerformanceMetric$Metric": "

The name of the performance metric.

", - "AIRecommendationPerformanceMetric$Stat": "

The statistical measure for the metric.

", - "AIRecommendationPerformanceMetric$Value": "

The value of the metric.

", - "AIRecommendationPerformanceMetric$Unit": "

The unit of the metric value.

", - "AdditionalS3DataSource$ETag": "

The ETag associated with S3 URI.

", - "AlgorithmStatusItem$FailureReason": "

if the overall status is Failed, the reason for the failure.

", - "BatchAddClusterNodesError$Message": "

A descriptive message providing additional details about the error.

", - "BatchDeleteClusterNodeLogicalIdsError$Message": "

A descriptive message providing additional details about the error.

", - "BatchDeleteClusterNodesError$Message": "

A message describing the error encountered when deleting a node.

", - "BatchDescribeModelPackageError$ErrorCode": "

", - "BatchDescribeModelPackageError$ErrorResponse": "

", - "BatchRebootClusterNodeLogicalIdsError$Message": "

A human-readable message describing the error encountered when rebooting a node by logical node ID.

", - "BatchRebootClusterNodesError$Message": "

A human-readable message describing the error encountered when rebooting a node.

", - "BatchReplaceClusterNodeLogicalIdsError$Message": "

A human-readable message describing the error encountered when replacing a node by logical node ID.

", - "BatchReplaceClusterNodesError$Message": "

A human-readable message describing the error encountered when replacing a node.

", - "BatchTransformInput$FeaturesAttribute": "

The attributes of the input data that are the input features.

", - "BatchTransformInput$InferenceAttribute": "

The attribute of the input data that represents the ground truth label.

", - "BatchTransformInput$ProbabilityAttribute": "

In a classification problem, the attribute that represents the class probability.

", - "CapacityReservation$Arn": "

The Amazon Resource Name (ARN) of the Capacity Reservation.

", - "ClusterAutoScalingConfigOutput$FailureMessage": "

If the autoscaling status is Failed, this field contains a message describing the failure.

", - "ClusterEventDetail$InstanceId": "

The EC2 instance ID associated with the event, if applicable.

", - "ClusterEventDetail$Description": "

A human-readable description of the event.

", - "ClusterEventSummary$InstanceId": "

The Amazon Elastic Compute Cloud (EC2) instance ID associated with the event, if applicable.

", - "ClusterEventSummary$Description": "

A brief, human-readable description of the event.

", - "ClusterInstanceStatusDetails$Message": "

The message from an instance in a SageMaker HyperPod cluster.

", - "ClusterMetadata$FailureMessage": "

An error message describing why the cluster level operation (such as creating, updating, or deleting) failed.

", - "ClusterMetadata$SlrAccessEntry": "

The Service-Linked Role (SLR) associated with the cluster. This is created by HyperPod on your behalf and only applies for EKS orchestrated clusters.

", - "ClusterNodeDetails$InstanceId": "

The ID of the instance.

", - "ClusterNodeSummary$InstanceId": "

The ID of the instance.

", - "ClusterNodeSummary$NodeLogicalId": "

A unique identifier for the node that persists throughout its lifecycle, from provisioning request to termination. This identifier can be used to track the node even before it has an assigned InstanceId. This field is only included when IncludeNodeLogicalIds is set to True in the ListClusterNodes request.

", - "CreateModelPackageInput$Domain": "

The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.

", - "CreateModelPackageInput$Task": "

The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification. The following tasks are supported by Inference Recommender: \"IMAGE_CLASSIFICATION\" | \"OBJECT_DETECTION\" | \"TEXT_GENERATION\" |\"IMAGE_SEGMENTATION\" | \"FILL_MASK\" | \"CLASSIFICATION\" | \"REGRESSION\" | \"OTHER\".

Specify \"OTHER\" if none of the tasks listed fit your use case.

", - "CustomizedMetricSpecification$MetricName": "

The name of the customized metric.

", - "CustomizedMetricSpecification$Namespace": "

The namespace of the customized metric.

", - "DescribeClusterResponse$FailureMessage": "

The failure message of the SageMaker HyperPod cluster.

", - "DescribeEdgePackagingJobResponse$EdgePackagingJobStatusMessage": "

Returns a message describing the job status and error messages.

", - "DescribeEdgePackagingJobResponse$ModelSignature": "

The signature document of files in the model artifact.

", - "DescribeModelPackageOutput$Domain": "

The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.

", - "DescribeModelPackageOutput$Task": "

The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification.

", - "DescribeModelPackageOutput$SamplePayloadUrl": "

The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path points to a single gzip compressed tar archive (.tar.gz suffix).

", - "DeviceDeploymentSummary$DeviceDeploymentStatusMessage": "

The detailed error message for the deployoment status result.

", - "EdgeDeploymentStatus$EdgeDeploymentStatusMessage": "

A detailed message about deployment status in current stage.

", - "EdgeOutputConfig$PresetDeploymentConfig": "

The configuration used to create deployment artifacts. Specify configuration options with a JSON string. The available configuration options for each type are:

  • ComponentName (optional) - Name of the GreenGrass V2 component. If not specified, the default name generated consists of \"SagemakerEdgeManager\" and the name of your SageMaker Edge Manager packaging job.

  • ComponentDescription (optional) - Description of the component.

  • ComponentVersion (optional) - The version of the component.

    Amazon Web Services IoT Greengrass uses semantic versions for components. Semantic versions follow a major.minor.patch number system. For example, version 1.0.0 represents the first major release for a component. For more information, see the semantic version specification.

  • PlatformOS (optional) - The name of the operating system for the platform. Supported platforms include Windows and Linux.

  • PlatformArchitecture (optional) - The processor architecture for the platform.

    Supported architectures Windows include: Windows32_x86, Windows64_x64.

    Supported architectures for Linux include: Linux x86_64, Linux ARMV8.

", - "EdgePresetDeploymentOutput$StatusMessage": "

Returns a message describing the status of the deployed resource.

", - "EfaEnis$member": null, - "EksRoleAccessEntries$member": null, - "EndpointInput$FeaturesAttribute": "

The attributes of the input data that are the input features.

", - "EndpointInput$InferenceAttribute": "

The attribute of the input data that represents the ground truth label.

", - "EndpointInput$ProbabilityAttribute": "

In a classification problem, the attribute that represents the class probability.

", - "EndpointOutputConfiguration$EndpointName": "

The name of the endpoint made during a recommendation job.

", - "EndpointOutputConfiguration$VariantName": "

The name of the production variant (deployed model) made during a recommendation job.

", - "EnvironmentParameter$Key": "

The environment key suggested by the Amazon SageMaker Inference Recommender.

", - "EnvironmentParameter$ValueType": "

The value type suggested by the Amazon SageMaker Inference Recommender.

", - "EnvironmentParameter$Value": "

The value suggested by the Amazon SageMaker Inference Recommender.

", - "GetScalingConfigurationRecommendationRequest$RecommendationId": "

The recommendation ID of a previously completed inference recommendation. This ID should come from one of the recommendations returned by the job specified in the InferenceRecommendationsJobName field.

Specify either this field or the EndpointName field.

", - "GetScalingConfigurationRecommendationResponse$RecommendationId": "

The recommendation ID of a previously completed inference recommendation.

", - "IamIdentity$Arn": "

The Amazon Resource Name (ARN) of the IAM identity.

", - "IamIdentity$PrincipalId": "

The ID of the principal that assumes the IAM identity.

", - "IamIdentity$SourceIdentity": "

The person or application which assumes the IAM identity.

", - "InferenceRecommendation$RecommendationId": "

The recommendation ID which uniquely identifies each recommendation.

", - "InstanceGroupMetadata$FailureMessage": "

An error message describing why the instance group level operation (such as creating, scaling, or deleting) failed.

", - "InstanceGroupMetadata$AvailabilityZoneId": "

The ID of the Availability Zone where the instance group is located.

", - "InstanceGroupMetadata$SubnetId": "

The ID of the subnet where the instance group is located.

", - "InstanceGroupMetadata$AmiOverride": "

If you use a custom Amazon Machine Image (AMI) for the instance group, this field shows the ID of the custom AMI.

", - "InstanceGroupScalingMetadata$FailureMessage": "

An error message describing why the scaling operation failed, if applicable.

", - "InstanceMetadata$CustomerEni": "

The ID of the customer-managed Elastic Network Interface (ENI) associated with the instance.

", - "InstanceMetadata$FailureMessage": "

An error message describing why the instance creation or update failed, if applicable.

", - "InstanceMetadata$LcsExecutionState": "

The execution state of the Lifecycle Script (LCS) for the instance.

", - "InstanceRequirementsEniConfiguration$CustomerEni": "

The ID of the customer-managed Elastic Network Interface (ENI) associated with the instance type category.

", - "JobSecondaryStatusTransition$StatusMessage": "

A detailed message about the status transition.

", - "ListMlflowAppsRequest$DefaultForDomainId": "

Filter for MLflow Apps with the specified default SageMaker Domain ID.

", - "ListProcessingJobsRequest$NameContains": "

A string in the processing job name. This filter returns only processing jobs whose name contains the specified string.

", - "ModelCard$ModelId": "

The unique name (ID) of the model.

", - "ModelCard$RiskRating": "

The risk rating of the model. Different organizations might have different criteria for model card risk ratings. For more information, see Risk ratings.

", - "ModelCard$ModelPackageGroupName": "

The model package group that contains the model package. Only relevant for model cards created for model packages in the Amazon SageMaker Model Registry.

", - "ModelDashboardModelCard$ModelId": "

For models created in SageMaker, this is the model ARN. For models created outside of SageMaker, this is a user-customized string.

", - "ModelDashboardModelCard$RiskRating": "

A model card's risk rating. Can be low, medium, or high.

", - "ModelMetadataSummary$Domain": "

The machine learning domain of the model.

", - "ModelMetadataSummary$Framework": "

The machine learning framework of the model.

", - "ModelMetadataSummary$Task": "

The machine learning task of the model.

", - "ModelMetadataSummary$Model": "

The name of the model.

", - "ModelMetadataSummary$FrameworkVersion": "

The framework version of the model.

", - "ModelPackage$Domain": "

The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.

", - "ModelPackage$Task": "

The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification.

", - "ModelPackage$SamplePayloadUrl": "

The Amazon Simple Storage Service path where the sample payload are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

", - "ModelPackageContainerDefinition$Framework": "

The machine learning framework of the model package container image.

", - "ModelPackageContainerDefinition$NearestModelName": "

The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model. You can find a list of benchmarked models by calling ListModelMetadata.

", - "ModelPackageContainerDefinition$ModelDataETag": "

The ETag associated with Model Data URL.

", - "ModelPackageStatusItem$FailureReason": "

if the overall status is Failed, the reason for the failure.

", - "PredefinedMetricSpecification$PredefinedMetricType": "

The metric type. You can only apply SageMaker metric types to SageMaker endpoints.

", - "ProcessingInput$InputName": "

The name for the processing job input.

", - "ProcessingOutput$OutputName": "

The name for the processing job output.

", - "ProductListings$member": null, - "RStudioServerProDomainSettings$RStudioConnectUrl": "

A URL pointing to an RStudio Connect server.

", - "RStudioServerProDomainSettings$RStudioPackageManagerUrl": "

A URL pointing to an RStudio Package Manager server.

", - "RStudioServerProDomainSettingsForUpdate$RStudioConnectUrl": "

A URL pointing to an RStudio Connect server.

", - "RStudioServerProDomainSettingsForUpdate$RStudioPackageManagerUrl": "

A URL pointing to an RStudio Package Manager server.

", - "RealTimeInferenceRecommendation$RecommendationId": "

The recommendation ID which uniquely identifies each recommendation.

", - "RecommendationJobContainerConfig$Domain": "

The machine learning domain of the model and its components.

Valid Values: COMPUTER_VISION | NATURAL_LANGUAGE_PROCESSING | MACHINE_LEARNING

", - "RecommendationJobContainerConfig$Task": "

The machine learning task that the model accomplishes.

Valid Values: IMAGE_CLASSIFICATION | OBJECT_DETECTION | TEXT_GENERATION | IMAGE_SEGMENTATION | FILL_MASK | CLASSIFICATION | REGRESSION | OTHER

", - "RecommendationJobContainerConfig$Framework": "

The machine learning framework of the container image.

Valid Values: TENSORFLOW | PYTORCH | XGBOOST | SAGEMAKER-SCIKIT-LEARN

", - "RecommendationJobContainerConfig$NearestModelName": "

The name of a pre-trained machine learning model benchmarked by Amazon SageMaker Inference Recommender that matches your model.

Valid Values: efficientnetb7 | unet | xgboost | faster-rcnn-resnet101 | nasnetlarge | vgg16 | inception-v3 | mask-rcnn | sagemaker-scikit-learn | densenet201-gluon | resnet18v2-gluon | xception | densenet201 | yolov4 | resnet152 | bert-base-cased | xceptionV1-keras | resnet50 | retinanet

", - "RecommendationJobSupportedInstanceTypes$member": null, - "RenderUiTemplateResponse$RenderedContent": "

A Liquid template that renders the HTML for the worker UI.

", - "RenderingError$Code": "

A unique identifier for a specific class of errors.

", - "RenderingError$Message": "

A human-readable message describing the error.

", - "S3ModelDataSource$ETag": "

The ETag associated with S3 URI.

", - "S3ModelDataSource$ManifestEtag": "

The ETag associated with Manifest S3 URI.

", - "ScheduleConfig$DataAnalysisStartTime": "

Sets the start time for a monitoring job window. Express this time as an offset to the times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the ScheduleExpression parameter. Specify this offset in ISO 8601 duration format. For example, if you want to monitor the five hours of data in your dataset that precede the start of each monitoring job, you would specify: \"-PT5H\".

The start time that you specify must not precede the end time that you specify by more than 24 hours. You specify the end time with the DataAnalysisEndTime parameter.

If you set ScheduleExpression to NOW, this parameter is required.

", - "ScheduleConfig$DataAnalysisEndTime": "

Sets the end time for a monitoring job window. Express this time as an offset to the times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the ScheduleExpression parameter. Specify this offset in ISO 8601 duration format. For example, if you want to end the window one hour before the start of each monitoring job, you would specify: \"-PT1H\".

The end time that you specify must not follow the start time that you specify by more than 24 hours. You specify the start time with the DataAnalysisStartTime parameter.

If you set ScheduleExpression to NOW, this parameter is required.

", - "SearchTrainingPlanOfferingsRequest$TrainingPlanArn": "

The Amazon Resource Name (ARN); of an existing training plan to search for extension offerings. When specified, the API returns extension offerings that can be used to extend the specified training plan.

", - "SourceAlgorithm$ModelDataETag": "

The ETag associated with Model Data URL.

", - "SubscribedWorkteam$SellerName": "

The name of the vendor in the Amazon Marketplace.

", - "SubscribedWorkteam$ListingId": "

Marketplace product listing ID.

", - "UltraServerInfo$Id": "

The unique identifier of the UltraServer.

", - "UltraServerInfo$Type": "

The type of the UltraServer.

", - "UserContext$UserProfileArn": "

The Amazon Resource Name (ARN) of the user's profile.

", - "UserContext$UserProfileName": "

The name of the user's profile.

", - "UserContext$DomainId": "

The domain associated with the user.

", - "Workforce$SubDomain": "

The subdomain for your OIDC Identity Provider.

", - "WorkloadSpec$Inline": "

An inline YAML or JSON string that defines benchmark parameters.

", - "Workteam$SubDomain": "

The URI of the labeling job's user interface. Workers open this URI to start labeling your data objects.

" - } - }, - "String1024": { - "base": null, - "refs": { - "BedrockCustomModelDeploymentMetadata$Arn": "

The Amazon Resource Name (ARN) for the Amazon Bedrock custom model deployment.

", - "BedrockCustomModelMetadata$Arn": "

The Amazon Resource Name (ARN) of the Amazon Bedrock custom model.

", - "BedrockModelImportMetadata$Arn": "

The Amazon Resource Name (ARN) of the Amazon Bedrock model import.

", - "BedrockProvisionedModelThroughputMetadata$Arn": "

The Amazon Resource Name (ARN) of the Amazon Bedrock provisioned model throughput.

", - "ClarifyCheckStepMetadata$BaselineUsedForDriftCheckConstraints": "

The Amazon S3 URI of baseline constraints file to be used for the drift check.

", - "ClarifyCheckStepMetadata$CalculatedBaselineConstraints": "

The Amazon S3 URI of the newly calculated baseline constraints file.

", - "ClarifyCheckStepMetadata$ViolationReport": "

The Amazon S3 URI of the violation report if violations are detected.

", - "CreateDomainResponse$Url": "

The URL to the created domain.

", - "DescribeDomainResponse$Url": "

The domain's URL.

", - "DescribeSpaceResponse$Url": "

Returns the URL of the space. If the space is created with Amazon Web Services IAM Identity Center (Successor to Amazon Web Services Single Sign-On) authentication, users can navigate to the URL after appending the respective redirect parameter for the application type to be federated through Amazon Web Services IAM Identity Center.

The following application types are supported:

  • Studio Classic: &redirect=JupyterServer

  • JupyterLab: &redirect=JupyterLab

  • Code Editor, based on Code-OSS, Visual Studio Code - Open Source: &redirect=CodeEditor

", - "DomainDetails$Url": "

The domain's URL.

", - "EMRStepMetadata$LogFilePath": "

The path to the log file where the cluster step's failure root cause is recorded.

", - "JobStepMetadata$Arn": "

The Amazon Resource Name (ARN) of the SageMaker job that was run by this step execution.

", - "OutputParameter$Value": "

The value of the output parameter.

", - "Parameter$Value": "

The literal value for the parameter.

", - "PartnerAppArguments$value": null, - "QualityCheckStepMetadata$BaselineUsedForDriftCheckStatistics": "

The Amazon S3 URI of the baseline statistics file used for the drift check.

", - "QualityCheckStepMetadata$BaselineUsedForDriftCheckConstraints": "

The Amazon S3 URI of the baseline constraints file used for the drift check.

", - "QualityCheckStepMetadata$CalculatedBaselineStatistics": "

The Amazon S3 URI of the newly calculated baseline statistics file.

", - "QualityCheckStepMetadata$CalculatedBaselineConstraints": "

The Amazon S3 URI of the newly calculated baseline constraints file.

", - "QualityCheckStepMetadata$ViolationReport": "

The Amazon S3 URI of violation report if violations are detected.

", - "ReleaseNotesList$member": null, - "S3FileSystemConfig$MountPath": "

The file system path where the Amazon S3 storage location will be mounted within the Amazon SageMaker Studio environment.

" - } - }, - "String128": { - "base": null, - "refs": { - "CategoricalParameterRangeValues$member": null - } - }, - "String200": { - "base": null, - "refs": { - "CreateWorkteamRequest$Description": "

A description of the work team.

", - "SubscribedWorkteam$MarketplaceTitle": "

The title of the service provided by the vendor in the Amazon Marketplace.

", - "SubscribedWorkteam$MarketplaceDescription": "

The description of the vendor from the Amazon Marketplace.

", - "UpdateWorkteamRequest$Description": "

An updated description for the work team.

", - "Workteam$Description": "

A description of the work team.

" - } - }, - "String2048": { - "base": null, - "refs": { - "AssociationInfo$SourceArn": "

The Amazon Resource Name (ARN) of the AssociationInfo source.

", - "AssociationInfo$DestinationArn": "

The Amazon Resource Name (ARN) of the AssociationInfo destination.

", - "CreatePartnerAppPresignedUrlResponse$Url": "

The presigned URL that you can use to access the SageMaker Partner AI App.

", - "DescribePartnerAppResponse$BaseUrl": "

The URL of the SageMaker Partner AI App that the Application SDK uses to support in-app calls for the user.

", - "InferenceComponentMetadata$Arn": "

The Amazon Resource Name (ARN) of the inference component.

", - "MapString2048$key": null, - "MapString2048$value": null - } - }, - "String256": { - "base": null, - "refs": { - "ActionSource$SourceType": "

The type of the source.

", - "ActionSource$SourceId": "

The ID of the source.

", - "ArtifactSourceType$Value": "

The ID.

", - "ArtifactSummary$ArtifactType": "

The type of the artifact.

", - "AssociationSummary$SourceType": "

The source type.

", - "AssociationSummary$DestinationType": "

The destination type.

", - "CallbackStepMetadata$SqsQueueUrl": "

The URL of the Amazon Simple Queue Service (Amazon SQS) queue used by the callback step.

", - "ClarifyCheckStepMetadata$CheckType": "

The type of the Clarify Check step

", - "ClarifyCheckStepMetadata$ModelPackageGroupName": "

The model package group name.

", - "ClarifyCheckStepMetadata$CheckJobArn": "

The Amazon Resource Name (ARN) of the check processing job that was run by this step's execution.

", - "ContextSource$SourceType": "

The type of the source.

", - "ContextSource$SourceId": "

The ID of the source.

", - "ContextSummary$ContextType": "

The type of the context.

", - "CreateActionRequest$ActionType": "

The action type.

", - "CreateArtifactRequest$ArtifactType": "

The artifact type.

", - "CreateContextRequest$ContextType": "

The context type.

", - "CreateUserProfileRequest$SingleSignOnUserValue": "

The username of the associated Amazon Web Services Single Sign-On User for this UserProfile. If the Domain's AuthMode is IAM Identity Center, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.

", - "CustomImageContainerEnvironmentVariables$value": null, - "DescribeActionResponse$ActionType": "

The type of the action.

", - "DescribeArtifactResponse$ArtifactType": "

The type of the artifact.

", - "DescribeContextResponse$ContextType": "

The type of the context.

", - "DescribeDomainResponse$SingleSignOnManagedApplicationInstanceId": "

The IAM Identity Center managed application instance ID.

", - "DescribeTrainingPlanResponse$UpfrontFee": "

The upfront fee for the training plan.

", - "DescribeUserProfileResponse$SingleSignOnUserValue": "

The IAM Identity Center user value.

", - "EMRStepMetadata$ClusterId": "

The identifier of the EMR cluster.

", - "EMRStepMetadata$StepId": "

The identifier of the EMR cluster step.

", - "EMRStepMetadata$StepName": "

The name of the EMR cluster step.

", - "LambdaStepMetadata$Arn": "

The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution.

", - "ListActionsRequest$ActionType": "

A filter that returns only actions of the specified type.

", - "ListArtifactsRequest$ArtifactType": "

A filter that returns only artifacts of the specified type.

", - "ListAssociationsRequest$SourceType": "

A filter that returns only associations with the specified source type.

", - "ListAssociationsRequest$DestinationType": "

A filter that returns only associations with the specified destination type.

", - "ListContextsRequest$ContextType": "

A filter that returns only contexts of the specified type.

", - "ListTrialComponentsRequest$SourceArn": "

A filter that returns only components that have the specified source Amazon Resource Name (ARN). If you specify SourceArn, you can't filter by ExperimentName or TrialName.

", - "ModelMetadataFilter$Value": "

The value to filter the model metadata.

", - "ModelStepMetadata$Arn": "

The Amazon Resource Name (ARN) of the created model.

", - "OptimizationJobEnvironmentVariables$value": null, - "OutputParameter$Name": "

The name of the output parameter.

", - "PlacementSpecification$UltraServerId": "

The unique identifier of the UltraServer where instances should be placed.

", - "QualityCheckStepMetadata$CheckType": "

The type of the Quality check step.

", - "QualityCheckStepMetadata$ModelPackageGroupName": "

The model package group name.

", - "QualityCheckStepMetadata$CheckJobArn": "

The Amazon Resource Name (ARN) of the Quality check processing job that was run by this step execution.

", - "QueryProperties$key": null, - "QueryProperties$value": null, - "RegisterModelStepMetadata$Arn": "

The Amazon Resource Name (ARN) of the model package.

", - "SelectedStep$StepName": "

The name of the pipeline step.

", - "SendPipelineExecutionStepFailureRequest$FailureReason": "

A message describing why the step failed.

", - "TrainingPlanExtension$Status": "

The current status of the extension (e.g., Pending, Active, Scheduled, Failed, Expired).

", - "TrainingPlanExtension$PaymentStatus": "

The payment processing status of the extension.

", - "TrainingPlanExtension$AvailabilityZone": "

The Availability Zone of the extension.

", - "TrainingPlanExtension$UpfrontFee": "

The upfront fee for the extension.

", - "TrainingPlanExtensionOffering$AvailabilityZone": "

The Availability Zone for this extension offering.

", - "TrainingPlanExtensionOffering$UpfrontFee": "

The upfront fee for this extension offering.

", - "TrainingPlanOffering$UpfrontFee": "

The upfront fee for this training plan offering.

", - "TrainingPlanSummary$UpfrontFee": "

The upfront fee for the training plan.

" - } - }, - "String3072": { - "base": null, - "refs": { - "FailStepMetadata$ErrorMessage": "

A message that you define and then is processed and rendered by the Fail step when the error occurs.

", - "PipelineExecutionSummary$PipelineExecutionFailureReason": "

A message generated by SageMaker Pipelines describing why the pipeline execution failed.

" - } - }, - "String40": { - "base": null, - "refs": { - "QueryTypes$member": null, - "Vertex$Type": "

The type of the lineage entity resource. For example: DataSet, Model, Endpoint, etc...

" - } - }, - "String64": { - "base": null, - "refs": { - "ActionSummary$ActionType": "

The type of the action.

", - "CategoricalParameter$Name": "

The Name of the environment variable.

", - "ModelLatencyThreshold$Percentile": "

The model latency percentile threshold. Acceptable values are P95 and P99. For custom load tests, specify the value as P95.

", - "TrainingPlanFilter$Value": "

The value to filter by for the specified field.

" - } - }, - "String8192": { - "base": null, - "refs": { - "QueryLineageRequest$NextToken": "

Limits the number of vertices in the request. Use the NextToken in a response to to retrieve the next page of results.

", - "QueryLineageResponse$NextToken": "

Limits the number of vertices in the response. Use the NextToken in a response to to retrieve the next page of results.

" - } - }, - "StringParameterValue": { - "base": null, - "refs": { - "ArtifactProperties$key": null, - "LineageEntityParameters$key": null, - "LineageEntityParameters$value": null, - "ListLineageEntityParameterKey$member": null, - "TrialComponentParameterValue$StringValue": "

The string value of a categorical hyperparameter. If you specify a value for this parameter, you can't specify the NumberValue parameter.

" - } - }, - "StudioLifecycleConfigAppType": { - "base": null, - "refs": { - "CreateStudioLifecycleConfigRequest$StudioLifecycleConfigAppType": "

The App type that the Lifecycle Configuration is attached to.

", - "DescribeStudioLifecycleConfigResponse$StudioLifecycleConfigAppType": "

The App type that the Lifecycle Configuration is attached to.

", - "ListStudioLifecycleConfigsRequest$AppTypeEquals": "

A parameter to search for the App Type to which the Lifecycle Configuration is attached.

", - "StudioLifecycleConfigDetails$StudioLifecycleConfigAppType": "

The App type to which the Lifecycle Configuration is attached.

" - } - }, - "StudioLifecycleConfigArn": { - "base": null, - "refs": { - "CodeEditorAppSettings$BuiltInLifecycleConfigArn": "

The lifecycle configuration that runs before the default lifecycle configuration. It can override changes made in the default lifecycle configuration.

", - "CreateStudioLifecycleConfigResponse$StudioLifecycleConfigArn": "

The ARN of your created Lifecycle Configuration.

", - "DescribeAppResponse$BuiltInLifecycleConfigArn": "

The lifecycle configuration that runs before the default lifecycle configuration

", - "DescribeStudioLifecycleConfigResponse$StudioLifecycleConfigArn": "

The ARN of the Lifecycle Configuration to describe.

", - "JupyterLabAppSettings$BuiltInLifecycleConfigArn": "

The lifecycle configuration that runs before the default lifecycle configuration. It can override changes made in the default lifecycle configuration.

", - "LifecycleConfigArns$member": null, - "ResourceSpec$LifecycleConfigArn": "

The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

", - "StudioLifecycleConfigDetails$StudioLifecycleConfigArn": "

The Amazon Resource Name (ARN) of the Lifecycle Configuration.

" - } - }, - "StudioLifecycleConfigContent": { - "base": null, - "refs": { - "CreateStudioLifecycleConfigRequest$StudioLifecycleConfigContent": "

The content of your Amazon SageMaker AI Studio Lifecycle Configuration script. This content must be base64 encoded.

", - "DescribeStudioLifecycleConfigResponse$StudioLifecycleConfigContent": "

The content of your Amazon SageMaker AI Studio Lifecycle Configuration script.

" - } - }, - "StudioLifecycleConfigDetails": { - "base": "

Details of the Amazon SageMaker AI Studio Lifecycle Configuration.

", - "refs": { - "StudioLifecycleConfigsList$member": null - } - }, - "StudioLifecycleConfigName": { - "base": null, - "refs": { - "CreateStudioLifecycleConfigRequest$StudioLifecycleConfigName": "

The name of the Amazon SageMaker AI Studio Lifecycle Configuration to create.

", - "DeleteStudioLifecycleConfigRequest$StudioLifecycleConfigName": "

The name of the Amazon SageMaker AI Studio Lifecycle Configuration to delete.

", - "DescribeStudioLifecycleConfigRequest$StudioLifecycleConfigName": "

The name of the Amazon SageMaker AI Studio Lifecycle Configuration to describe.

", - "DescribeStudioLifecycleConfigResponse$StudioLifecycleConfigName": "

The name of the Amazon SageMaker AI Studio Lifecycle Configuration that is described.

", - "ListStudioLifecycleConfigsRequest$NameContains": "

A string in the Lifecycle Configuration name. This filter returns only Lifecycle Configurations whose name contains the specified string.

", - "StudioLifecycleConfigDetails$StudioLifecycleConfigName": "

The name of the Amazon SageMaker AI Studio Lifecycle Configuration.

" - } - }, - "StudioLifecycleConfigSortKey": { - "base": null, - "refs": { - "ListStudioLifecycleConfigsRequest$SortBy": "

The property used to sort results. The default value is CreationTime.

" - } - }, - "StudioLifecycleConfigsList": { - "base": null, - "refs": { - "ListStudioLifecycleConfigsResponse$StudioLifecycleConfigs": "

A list of Lifecycle Configurations and their properties.

" - } - }, - "StudioResourceSpecTrainingPlanArn": { - "base": "

TrainingPlanArn variant for ResourceSpec that allows "None" to detach a training plan. Based on TrainingPlanArn (min:50, max:2048) but with min:0 and "None" in pattern.

", - "refs": { - "ResourceSpec$TrainingPlanArn": "

The ARN of the SageMaker AI Training Plan to use for this app. When you specify a training plan, the app launches on reserved GPU capacity. This field is supported for JupyterLab and CodeEditor app types.

For more information about how to reserve GPU capacity with SageMaker AI Training Plans, see Using training plans in Studio applications.

" - } - }, - "StudioWebPortal": { - "base": null, - "refs": { - "UserSettings$StudioWebPortal": "

Whether the user can access Studio. If this value is set to DISABLED, the user cannot access Studio, even if that is the default experience for the domain.

" - } - }, - "StudioWebPortalSettings": { - "base": "

Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.

", - "refs": { - "UserSettings$StudioWebPortalSettings": "

Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.

" - } - }, - "SubnetId": { - "base": null, - "refs": { - "CreateNotebookInstanceInput$SubnetId": "

The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.

", - "DescribeNotebookInstanceOutput$SubnetId": "

The ID of the VPC subnet.

", - "Subnets$member": null - } - }, - "Subnets": { - "base": null, - "refs": { - "CreateDomainRequest$SubnetIds": "

The VPC subnets that the domain uses for communication.

The field is optional when the AppNetworkAccessType parameter is set to PublicInternetOnly for domains created from Amazon SageMaker Unified Studio.

", - "DescribeDomainResponse$SubnetIds": "

The VPC subnets that the domain uses for communication.

", - "UpdateDomainRequest$SubnetIds": "

The VPC subnets that Studio uses for communication.

If removing subnets, ensure there are no apps in the InService, Pending, or Deleting state.

", - "VpcConfig$Subnets": "

The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.

" - } - }, - "SubscribedWorkteam": { - "base": "

Describes a work team of a vendor that does the labelling job.

", - "refs": { - "DescribeSubscribedWorkteamResponse$SubscribedWorkteam": "

A Workteam instance that contains information about the work team.

", - "SubscribedWorkteams$member": null - } - }, - "SubscribedWorkteams": { - "base": null, - "refs": { - "ListSubscribedWorkteamsResponse$SubscribedWorkteams": "

An array of Workteam objects, each describing a work team.

" - } - }, - "Success": { - "base": null, - "refs": { - "DeleteWorkteamResponse$Success": "

Returns true if the work team was successfully deleted; otherwise, returns false.

" - } - }, - "SuggestionQuery": { - "base": "

Specified in the GetSearchSuggestions request. Limits the property names that are included in the response.

", - "refs": { - "GetSearchSuggestionsRequest$SuggestionQuery": "

Limits the property names that are included in the response.

" - } - }, - "TableFormat": { - "base": null, - "refs": { - "OfflineStoreConfig$TableFormat": "

Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.

" - } - }, - "TableName": { - "base": null, - "refs": { - "DataCatalogConfig$TableName": "

The name of the Glue table.

" - } - }, - "TabularJobConfig": { - "base": "

The collection of settings used by an AutoML job V2 for the tabular problem type.

", - "refs": { - "AutoMLProblemTypeConfig$TabularJobConfig": "

Settings used to configure an AutoML job V2 for the tabular problem type (regression, classification).

" - } - }, - "TabularResolvedAttributes": { - "base": "

The resolved attributes specific to the tabular problem type.

", - "refs": { - "AutoMLProblemTypeResolvedAttributes$TabularResolvedAttributes": "

The resolved attributes for the tabular problem type.

" - } - }, - "Tag": { - "base": "

A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.

You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.

For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.

", - "refs": { - "TagList$member": null - } - }, - "TagKey": { - "base": null, - "refs": { - "Tag$Key": "

The tag key. Tag keys must be unique per resource.

", - "TagKeyList$member": null - } - }, - "TagKeyList": { - "base": null, - "refs": { - "DeleteTagsInput$TagKeys": "

An array or one or more tag keys to delete.

" - } - }, - "TagList": { - "base": null, - "refs": { - "AddTagsInput$Tags": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

", - "AddTagsOutput$Tags": "

A list of tags associated with the SageMaker resource.

", - "CreateAIBenchmarkJobRequest$Tags": "

The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define.

", - "CreateAIRecommendationJobRequest$Tags": "

The metadata that you apply to Amazon Web Services resources to help you categorize and organize them.

", - "CreateAIWorkloadConfigRequest$Tags": "

The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

", - "CreateActionRequest$Tags": "

A list of tags to apply to the action.

", - "CreateAlgorithmInput$Tags": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

", - "CreateAppImageConfigRequest$Tags": "

A list of tags to apply to the AppImageConfig.

", - "CreateAppRequest$Tags": "

Each tag consists of a key and an optional value. Tag keys must be unique per resource.

", - "CreateArtifactRequest$Tags": "

A list of tags to apply to the artifact.

", - "CreateAutoMLJobRequest$Tags": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web ServicesResources. Tag keys must be unique per resource.

", - "CreateAutoMLJobV2Request$Tags": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, such as by purpose, owner, or environment. For more information, see Tagging Amazon Web ServicesResources. Tag keys must be unique per resource.

", - "CreateClusterRequest$Tags": "

Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource. You can add tags to your cluster in the same way you add them in other Amazon Web Services services that support tagging. To learn more about tagging Amazon Web Services resources in general, see Tagging Amazon Web Services Resources User Guide.

", - "CreateClusterSchedulerConfigRequest$Tags": "

Tags of the cluster policy.

", - "CreateCodeRepositoryInput$Tags": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

", - "CreateCompilationJobRequest$Tags": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

", - "CreateComputeQuotaRequest$Tags": "

Tags of the compute allocation definition.

", - "CreateContextRequest$Tags": "

A list of tags to apply to the context.

", - "CreateDataQualityJobDefinitionRequest$Tags": "

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

", - "CreateDeviceFleetRequest$Tags": "

Creates tags for the specified fleet.

", - "CreateDomainRequest$Tags": "

Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.

Tags that you specify for the Domain are also added to all Apps that the Domain launches.

", - "CreateEdgeDeploymentPlanRequest$Tags": "

List of tags with which to tag the edge deployment plan.

", - "CreateEdgePackagingJobRequest$Tags": "

Creates tags for the packaging job.

", - "CreateEndpointConfigInput$Tags": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

", - "CreateEndpointInput$Tags": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

", - "CreateExperimentRequest$Tags": "

A list of tags to associate with the experiment. You can use Search API to search on the tags.

", - "CreateFeatureGroupRequest$Tags": "

Tags used to identify Features in each FeatureGroup.

", - "CreateFlowDefinitionRequest$Tags": "

An array of key-value pairs that contain metadata to help you categorize and organize a flow definition. Each tag consists of a key and a value, both of which you define.

", - "CreateHubContentReferenceRequest$Tags": "

Any tags associated with the hub content to reference.

", - "CreateHubRequest$Tags": "

Any tags to associate with the hub.

", - "CreateHumanTaskUiRequest$Tags": "

An array of key-value pairs that contain metadata to help you categorize and organize a human review workflow user interface. Each tag consists of a key and a value, both of which you define.

", - "CreateHyperParameterTuningJobRequest$Tags": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

Tags that you specify for the tuning job are also added to all training jobs that the tuning job launches.

", - "CreateImageRequest$Tags": "

A list of tags to apply to the image.

", - "CreateInferenceComponentInput$Tags": "

A list of key-value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

", - "CreateInferenceExperimentRequest$Tags": "

Array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging your Amazon Web Services Resources.

", - "CreateInferenceRecommendationsJobRequest$Tags": "

The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

", - "CreateJobRequest$Tags": "

An array of key-value pairs to apply to the job as tags. For more information, see Tagging Amazon Web Services Resources.

", - "CreateLabelingJobRequest$Tags": "

An array of key/value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

", - "CreateMlflowAppRequest$Tags": "

Tags consisting of key-value pairs used to manage metadata for the MLflow App.

", - "CreateMlflowTrackingServerRequest$Tags": "

Tags consisting of key-value pairs used to manage metadata for the tracking server.

", - "CreateModelBiasJobDefinitionRequest$Tags": "

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

", - "CreateModelCardRequest$Tags": "

Key-value pairs used to manage metadata for model cards.

", - "CreateModelExplainabilityJobDefinitionRequest$Tags": "

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

", - "CreateModelInput$Tags": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

", - "CreateModelPackageGroupInput$Tags": "

A list of key value pairs associated with the model group. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

", - "CreateModelPackageInput$Tags": "

A list of key value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

If you supply ModelPackageGroupName, your model package belongs to the model group you specify and uses the tags associated with the model group. In this case, you cannot supply a tag argument.

", - "CreateModelQualityJobDefinitionRequest$Tags": "

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

", - "CreateMonitoringScheduleRequest$Tags": "

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

", - "CreateNotebookInstanceInput$Tags": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

", - "CreateNotebookInstanceLifecycleConfigInput$Tags": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

", - "CreateOptimizationJobRequest$Tags": "

A list of key-value pairs associated with the optimization job. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

", - "CreatePartnerAppRequest$Tags": "

Each tag consists of a key and an optional value. Tag keys must be unique per resource.

", - "CreatePipelineRequest$Tags": "

A list of tags to apply to the created pipeline.

", - "CreateProcessingJobRequest$Tags": "

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

Do not include any security-sensitive information including account access IDs, secrets, or tokens in any tags. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request tag variable or plain text fields.

", - "CreateProjectInput$Tags": "

An array of key-value pairs that you want to use to organize and track your Amazon Web Services resource costs. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

", - "CreateSpaceRequest$Tags": "

Tags to associated with the space. Each tag consists of a key and an optional value. Tag keys must be unique for each resource. Tags are searchable using the Search API.

", - "CreateStudioLifecycleConfigRequest$Tags": "

Tags to be associated with the Lifecycle Configuration. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.

", - "CreateTrainingJobRequest$Tags": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

Do not include any security-sensitive information including account access IDs, secrets, or tokens in any tags. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by any security-sensitive information included in the request tag variable or plain text fields.

", - "CreateTrainingPlanRequest$Tags": "

An array of key-value pairs to apply to this training plan.

", - "CreateTransformJobRequest$Tags": "

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

", - "CreateTrialComponentRequest$Tags": "

A list of tags to associate with the component. You can use Search API to search on the tags.

", - "CreateTrialRequest$Tags": "

A list of tags to associate with the trial. You can use Search API to search on the tags.

", - "CreateUserProfileRequest$Tags": "

Each tag consists of a key and an optional value. Tag keys must be unique per resource.

Tags that you specify for the User Profile are also added to all Apps that the User Profile launches.

", - "CreateWorkforceRequest$Tags": "

An array of key-value pairs that contain metadata to help you categorize and organize our workforce. Each tag consists of a key and a value, both of which you define.

", - "CreateWorkteamRequest$Tags": "

An array of key-value pairs.

For more information, see Resource Tag and Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

", - "DescribeAIBenchmarkJobResponse$Tags": "

The tags associated with the benchmark job.

", - "DescribeAIRecommendationJobResponse$Tags": "

The tags associated with the recommendation job.

", - "DescribeAIWorkloadConfigResponse$Tags": "

The tags associated with the AI workload configuration.

", - "DescribeJobResponse$Tags": "

The tags associated with the job.

", - "DescribeLabelingJobResponse$Tags": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

", - "Endpoint$Tags": "

A list of the tags associated with the endpoint. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

", - "Experiment$Tags": "

The list of tags that are associated with the experiment. You can use Search API to search on the tags.

", - "FeatureGroup$Tags": "

Tags used to define a FeatureGroup.

", - "HyperParameterTuningJobSearchEntity$Tags": "

The tags associated with a hyperparameter tuning job. For more information see Tagging Amazon Web Services resources.

", - "ImportHubContentRequest$Tags": "

Any tags associated with the hub content.

", - "Job$Tags": "

The tags associated with the job.

", - "ListTagsOutput$Tags": "

An array of Tag objects, each with a tag key and a value.

", - "Model$Tags": "

A list of key-value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

", - "ModelCard$Tags": "

Key-value pairs used to manage metadata for the model card.

", - "ModelDashboardModelCard$Tags": "

The tags associated with a model card.

", - "ModelPackage$Tags": "

A list of the tags associated with the model package. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

", - "ModelPackageGroup$Tags": "

A list of the tags associated with the model group. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

", - "MonitoringSchedule$Tags": "

A list of the tags associated with the monitoring schedlue. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

", - "Pipeline$Tags": "

A list of tags that apply to the pipeline.

", - "ProcessingJob$Tags": "

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

", - "Project$Tags": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

", - "RegisterDevicesRequest$Tags": "

The tags associated with devices.

", - "TrainingJob$Tags": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

", - "TransformJob$Tags": "

A list of tags associated with the transform job.

", - "Trial$Tags": "

The list of tags that are associated with the trial. You can use Search API to search on the tags.

", - "TrialComponent$Tags": "

The list of tags that are associated with the component. You can use Search API to search on the tags.

", - "UpdatePartnerAppRequest$Tags": "

Each tag consists of a key and an optional value. Tag keys must be unique per resource.

", - "UpdateProjectInput$Tags": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources. In addition, the project must have tag update constraints set in order to include this parameter in the request. For more information, see Amazon Web Services Service Catalog Tag Update Constraints.

" - } - }, - "TagPropagation": { - "base": null, - "refs": { - "CreateDomainRequest$TagPropagation": "

Indicates whether custom tag propagation is supported for the domain. Defaults to DISABLED.

", - "DescribeDomainResponse$TagPropagation": "

Indicates whether custom tag propagation is supported for the domain.

", - "UpdateDomainRequest$TagPropagation": "

Indicates whether custom tag propagation is supported for the domain. Defaults to DISABLED.

" - } - }, - "TagValue": { - "base": null, - "refs": { - "Tag$Value": "

The tag value.

" - } - }, - "TargetAttributeName": { - "base": null, - "refs": { - "AutoMLChannel$TargetAttributeName": "

The name of the target variable in supervised learning, usually represented by 'y'.

", - "TabularJobConfig$TargetAttributeName": "

The name of the target variable in supervised learning, usually represented by 'y'.

", - "TimeSeriesConfig$TargetAttributeName": "

The name of the column representing the target variable that you want to predict for each item in your dataset. The data type of the target variable must be numerical.

" - } - }, - "TargetCount": { - "base": null, - "refs": { - "InstanceGroupScalingMetadata$TargetCount": "

The desired number of instances for the group after scaling.

" - } - }, - "TargetDevice": { - "base": null, - "refs": { - "CompilationJobSummary$CompilationTargetDevice": "

The type of device that the model will run on after the compilation job has completed.

", - "OutputConfig$TargetDevice": "

Identifies the target device or the machine learning instance that you want to run your model on after the compilation has completed. Alternatively, you can specify OS, architecture, and accelerator using TargetPlatform fields. It can be used instead of TargetPlatform.

Currently ml_trn1 is available only in US East (N. Virginia) Region, and ml_inf2 is available only in US East (Ohio) Region.

" - } - }, - "TargetLabelColumn": { - "base": null, - "refs": { - "TextClassificationJobConfig$TargetLabelColumn": "

The name of the column used to provide the class labels. It should not be same as the content column.

" - } - }, - "TargetObjectiveMetricValue": { - "base": null, - "refs": { - "TuningJobCompletionCriteria$TargetObjectiveMetricValue": "

The value of the objective metric.

" - } - }, - "TargetPlatform": { - "base": "

Contains information about a target platform that you want your model to run on, such as OS, architecture, and accelerators. It is an alternative of TargetDevice.

", - "refs": { - "OutputConfig$TargetPlatform": "

Contains information about a target platform that you want your model to run on, such as OS, architecture, and accelerators. It is an alternative of TargetDevice.

The following examples show how to configure the TargetPlatform and CompilerOptions JSON strings for popular target platforms:

  • Raspberry Pi 3 Model B+

    \"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"ARM_EABIHF\"},

    \"CompilerOptions\": {'mattr': ['+neon']}

  • Jetson TX2

    \"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"ARM64\", \"Accelerator\": \"NVIDIA\"},

    \"CompilerOptions\": {'gpu-code': 'sm_62', 'trt-ver': '6.0.1', 'cuda-ver': '10.0'}

  • EC2 m5.2xlarge instance OS

    \"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"X86_64\", \"Accelerator\": \"NVIDIA\"},

    \"CompilerOptions\": {'mcpu': 'skylake-avx512'}

  • RK3399

    \"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"ARM64\", \"Accelerator\": \"MALI\"}

  • ARMv7 phone (CPU)

    \"TargetPlatform\": {\"Os\": \"ANDROID\", \"Arch\": \"ARM_EABI\"},

    \"CompilerOptions\": {'ANDROID_PLATFORM': 25, 'mattr': ['+neon']}

  • ARMv8 phone (CPU)

    \"TargetPlatform\": {\"Os\": \"ANDROID\", \"Arch\": \"ARM64\"},

    \"CompilerOptions\": {'ANDROID_PLATFORM': 29}

" - } - }, - "TargetPlatformAccelerator": { - "base": null, - "refs": { - "CompilationJobSummary$CompilationTargetPlatformAccelerator": "

The type of accelerator that the model will run on after the compilation job has completed.

", - "TargetPlatform$Accelerator": "

Specifies a target platform accelerator (optional).

  • NVIDIA: Nvidia graphics processing unit. It also requires gpu-code, trt-ver, cuda-ver compiler options

  • MALI: ARM Mali graphics processor

  • INTEL_GRAPHICS: Integrated Intel graphics

" - } - }, - "TargetPlatformArch": { - "base": null, - "refs": { - "CompilationJobSummary$CompilationTargetPlatformArch": "

The type of architecture that the model will run on after the compilation job has completed.

", - "TargetPlatform$Arch": "

Specifies a target platform architecture.

  • X86_64: 64-bit version of the x86 instruction set.

  • X86: 32-bit version of the x86 instruction set.

  • ARM64: ARMv8 64-bit CPU.

  • ARM_EABIHF: ARMv7 32-bit, Hard Float.

  • ARM_EABI: ARMv7 32-bit, Soft Float. Used by Android 32-bit ARM platform.

" - } - }, - "TargetPlatformOs": { - "base": null, - "refs": { - "CompilationJobSummary$CompilationTargetPlatformOs": "

The type of OS that the model will run on after the compilation job has completed.

", - "TargetPlatform$Os": "

Specifies a target platform OS.

  • LINUX: Linux-based operating systems.

  • ANDROID: Android operating systems. Android API level can be specified using the ANDROID_PLATFORM compiler option. For example, \"CompilerOptions\": {'ANDROID_PLATFORM': 28}

" - } - }, - "TargetTrackingScalingPolicyConfiguration": { - "base": "

A target tracking scaling policy. Includes support for predefined or customized metrics.

When using the PutScalingPolicy API, this parameter is required when you are creating a policy with the policy type TargetTrackingScaling.

", - "refs": { - "ScalingPolicy$TargetTracking": "

A target tracking scaling policy. Includes support for predefined or customized metrics.

" - } - }, - "TaskAvailabilityLifetimeInSeconds": { - "base": null, - "refs": { - "HumanTaskConfig$TaskAvailabilityLifetimeInSeconds": "

The length of time that a task remains available for labeling by human workers. The default and maximum values for this parameter depend on the type of workforce you use.

  • If you choose the Amazon Mechanical Turk workforce, the maximum is 12 hours (43,200 seconds). The default is 6 hours (21,600 seconds).

  • If you choose a private or vendor workforce, the default value is 30 days (2592,000 seconds) for non-AL mode. For most users, the maximum is also 30 days.

" - } - }, - "TaskCount": { - "base": null, - "refs": { - "DesiredWeightAndCapacity$DesiredInstanceCount": "

The variant's capacity.

", - "Ec2CapacityReservation$TotalInstanceCount": "

The number of instances that you allocated to the EC2 capacity reservation.

", - "Ec2CapacityReservation$AvailableInstanceCount": "

The number of instances that are currently available in the EC2 capacity reservation.

", - "Ec2CapacityReservation$UsedByCurrentEndpoint": "

The number of instances from the EC2 capacity reservation that are being used by the endpoint.

", - "InstancePoolSummary$CurrentInstanceCount": "

The current number of instances of this type in the instance pool.

", - "PendingProductionVariantSummary$CurrentInstanceCount": "

The number of instances associated with the variant.

", - "PendingProductionVariantSummary$DesiredInstanceCount": "

The number of instances requested in this deployment, as specified in the endpoint configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.

", - "ProductionVariantCapacityReservationSummary$TotalInstanceCount": "

The number of instances that you allocated to the ML capacity reservation.

", - "ProductionVariantCapacityReservationSummary$AvailableInstanceCount": "

The number of instances that are currently available in the ML capacity reservation.

", - "ProductionVariantCapacityReservationSummary$UsedByCurrentEndpoint": "

The number of instances from the ML capacity reservation that are being used by the endpoint.

", - "ProductionVariantSummary$CurrentInstanceCount": "

The number of instances associated with the variant.

", - "ProductionVariantSummary$DesiredInstanceCount": "

The number of instances requested in the UpdateEndpointWeightsAndCapacities request.

", - "RealTimeInferenceConfig$InstanceCount": "

The number of instances of the type specified by InstanceType.

" - } - }, - "TaskDescription": { - "base": null, - "refs": { - "HumanTaskConfig$TaskDescription": "

A description of the task for your human workers.

" - } - }, - "TaskInput": { - "base": null, - "refs": { - "RenderableTask$Input": "

A JSON object that contains values for the variables defined in the template. It is made available to the template under the substitution variable task.input. For example, if you define a variable task.input.text in your template, you can supply the variable in the JSON object as \"text\": \"sample text\".

" - } - }, - "TaskKeyword": { - "base": null, - "refs": { - "TaskKeywords$member": null - } - }, - "TaskKeywords": { - "base": null, - "refs": { - "HumanTaskConfig$TaskKeywords": "

Keywords used to describe the task so that workers on Amazon Mechanical Turk can discover the task.

" - } - }, - "TaskTimeLimitInSeconds": { - "base": null, - "refs": { - "HumanTaskConfig$TaskTimeLimitInSeconds": "

The amount of time that a worker has to complete a task.

If you create a custom labeling job, the maximum value for this parameter is 8 hours (28,800 seconds).

If you create a labeling job using a built-in task type the maximum for this parameter depends on the task type you use:

  • For image and text labeling jobs, the maximum is 8 hours (28,800 seconds).

  • For 3D point cloud and video frame labeling jobs, the maximum is 30 days (2952,000 seconds) for non-AL mode. For most users, the maximum is also 30 days.

" - } - }, - "TaskTitle": { - "base": null, - "refs": { - "HumanTaskConfig$TaskTitle": "

A title for the task for your human workers.

" - } - }, - "TemplateContent": { - "base": null, - "refs": { - "UiTemplate$Content": "

The content of the Liquid template for the worker user interface.

" - } - }, - "TemplateContentSha256": { - "base": null, - "refs": { - "UiTemplateInfo$ContentSha256": "

The SHA-256 digest of the contents of the template.

" - } - }, - "TemplateProviderDetail": { - "base": "

Details about a template provider configuration and associated provisioning information.

", - "refs": { - "TemplateProviderDetailList$member": null - } - }, - "TemplateProviderDetailList": { - "base": null, - "refs": { - "DescribeProjectOutput$TemplateProviderDetails": "

An array of template providers associated with the project.

", - "Project$TemplateProviderDetails": "

An array of template providers associated with the project.

" - } - }, - "TemplateUrl": { - "base": null, - "refs": { - "UiTemplateInfo$Url": "

The URL for the user interface template.

" - } - }, - "TensorBoardAppSettings": { - "base": "

The TensorBoard app settings.

", - "refs": { - "UserSettings$TensorBoardAppSettings": "

The TensorBoard app settings.

" - } - }, - "TensorBoardOutputConfig": { - "base": "

Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard output data.

", - "refs": { - "CreateTrainingJobRequest$TensorBoardOutputConfig": null, - "DescribeTrainingJobResponse$TensorBoardOutputConfig": null, - "TrainingJob$TensorBoardOutputConfig": null - } - }, - "TenthFractionsOfACent": { - "base": null, - "refs": { - "USD$TenthFractionsOfACent": "

Fractions of a cent, in tenths.

" - } - }, - "TerminationWaitInSeconds": { - "base": null, - "refs": { - "BlueGreenUpdatePolicy$TerminationWaitInSeconds": "

Additional waiting time in seconds after the completion of an endpoint deployment before terminating the old endpoint fleet. Default is 0.

" - } - }, - "TextClassificationJobConfig": { - "base": "

The collection of settings used by an AutoML job V2 for the text classification problem type.

", - "refs": { - "AutoMLProblemTypeConfig$TextClassificationJobConfig": "

Settings used to configure an AutoML job V2 for the text classification problem type.

" - } - }, - "TextGenerationHyperParameterKey": { - "base": null, - "refs": { - "TextGenerationHyperParameters$key": null - } - }, - "TextGenerationHyperParameterValue": { - "base": null, - "refs": { - "TextGenerationHyperParameters$value": null - } - }, - "TextGenerationHyperParameters": { - "base": null, - "refs": { - "TextGenerationJobConfig$TextGenerationHyperParameters": "

The hyperparameters used to configure and optimize the learning process of the base model. You can set any combination of the following hyperparameters for all base models. For more information on each supported hyperparameter, see Optimize the learning process of your text generation models with hyperparameters.

  • \"epochCount\": The number of times the model goes through the entire training dataset. Its value should be a string containing an integer value within the range of \"1\" to \"10\".

  • \"batchSize\": The number of data samples used in each iteration of training. Its value should be a string containing an integer value within the range of \"1\" to \"64\".

  • \"learningRate\": The step size at which a model's parameters are updated during training. Its value should be a string containing a floating-point value within the range of \"0\" to \"1\".

  • \"learningRateWarmupSteps\": The number of training steps during which the learning rate gradually increases before reaching its target or maximum value. Its value should be a string containing an integer value within the range of \"0\" to \"250\".

Here is an example where all four hyperparameters are configured.

{ \"epochCount\":\"5\", \"learningRate\":\"0.5\", \"batchSize\": \"32\", \"learningRateWarmupSteps\": \"10\" }

" - } - }, - "TextGenerationJobConfig": { - "base": "

The collection of settings used by an AutoML job V2 for the text generation problem type.

The text generation models that support fine-tuning in Autopilot are currently accessible exclusively in regions supported by Canvas. Refer to the documentation of Canvas for the full list of its supported Regions.

", - "refs": { - "AutoMLProblemTypeConfig$TextGenerationJobConfig": "

Settings used to configure an AutoML job V2 for the text generation (LLMs fine-tuning) problem type.

The text generation models that support fine-tuning in Autopilot are currently accessible exclusively in regions supported by Canvas. Refer to the documentation of Canvas for the full list of its supported Regions.

" - } - }, - "TextGenerationResolvedAttributes": { - "base": "

The resolved attributes specific to the text generation problem type.

", - "refs": { - "AutoMLProblemTypeResolvedAttributes$TextGenerationResolvedAttributes": "

The resolved attributes for the text generation problem type.

" - } - }, - "ThingName": { - "base": null, - "refs": { - "DescribeDeviceResponse$IotThingName": "

The Amazon Web Services Internet of Things (IoT) object thing name associated with the device.

", - "Device$IotThingName": "

Amazon Web Services Internet of Things (IoT) object name.

", - "DeviceSummary$IotThingName": "

The Amazon Web Services Internet of Things (IoT) object thing name associated with the device..

" - } - }, - "ThroughputConfig": { - "base": "

Used to set feature group throughput configuration. There are two modes: ON_DEMAND and PROVISIONED. With on-demand mode, you are charged for data reads and writes that your application performs on your feature group. You do not need to specify read and write throughput because Feature Store accommodates your workloads as they ramp up and down. You can switch a feature group to on-demand only once in a 24 hour period. With provisioned throughput mode, you specify the read and write capacity per second that you expect your application to require, and you are billed based on those limits. Exceeding provisioned throughput will result in your requests being throttled.

Note: PROVISIONED throughput mode is supported only for feature groups that are offline-only, or use the Standard tier online store.

", - "refs": { - "CreateFeatureGroupRequest$ThroughputConfig": null - } - }, - "ThroughputConfigDescription": { - "base": "

Active throughput configuration of the feature group. There are two modes: ON_DEMAND and PROVISIONED. With on-demand mode, you are charged for data reads and writes that your application performs on your feature group. You do not need to specify read and write throughput because Feature Store accommodates your workloads as they ramp up and down. You can switch a feature group to on-demand only once in a 24 hour period. With provisioned throughput mode, you specify the read and write capacity per second that you expect your application to require, and you are billed based on those limits. Exceeding provisioned throughput will result in your requests being throttled.

Note: PROVISIONED throughput mode is supported only for feature groups that are offline-only, or use the Standard tier online store.

", - "refs": { - "DescribeFeatureGroupResponse$ThroughputConfig": null - } - }, - "ThroughputConfigUpdate": { - "base": "

The new throughput configuration for the feature group. You can switch between on-demand and provisioned modes or update the read / write capacity of provisioned feature groups. You can switch a feature group to on-demand only once in a 24 hour period.

", - "refs": { - "UpdateFeatureGroupRequest$ThroughputConfig": null - } - }, - "ThroughputMode": { - "base": null, - "refs": { - "ThroughputConfig$ThroughputMode": "

The mode used for your feature group throughput: ON_DEMAND or PROVISIONED.

", - "ThroughputConfigDescription$ThroughputMode": "

The mode used for your feature group throughput: ON_DEMAND or PROVISIONED.

", - "ThroughputConfigUpdate$ThroughputMode": "

Target throughput mode of the feature group. Throughput update is an asynchronous operation, and the outcome should be monitored by polling LastUpdateStatus field in DescribeFeatureGroup response. You cannot update a feature group's throughput while another update is in progress.

" - } - }, - "TimeSeriesConfig": { - "base": "

The collection of components that defines the time-series.

", - "refs": { - "TimeSeriesForecastingJobConfig$TimeSeriesConfig": "

The collection of components that defines the time-series.

" - } - }, - "TimeSeriesForecastingJobConfig": { - "base": "

The collection of settings used by an AutoML job V2 for the time-series forecasting problem type.

", - "refs": { - "AutoMLProblemTypeConfig$TimeSeriesForecastingJobConfig": "

Settings used to configure an AutoML job V2 for the time-series forecasting problem type.

" - } - }, - "TimeSeriesForecastingSettings": { - "base": "

Time series forecast settings for the SageMaker Canvas application.

", - "refs": { - "CanvasAppSettings$TimeSeriesForecastingSettings": "

Time series forecast settings for the SageMaker Canvas application.

" - } - }, - "TimeSeriesTransformations": { - "base": "

Transformations allowed on the dataset. Supported transformations are Filling and Aggregation. Filling specifies how to add values to missing values in the dataset. Aggregation defines how to aggregate data that does not align with forecast frequency.

", - "refs": { - "TimeSeriesForecastingJobConfig$Transformations": "

The transformations modifying specific attributes of the time-series, such as filling strategies for missing values.

" - } - }, - "Timestamp": { - "base": null, - "refs": { - "AIBenchmarkJobSummary$CreationTime": "

A timestamp that indicates when the benchmark job was created.

", - "AIBenchmarkJobSummary$EndTime": "

A timestamp that indicates when the benchmark job completed.

", - "AIRecommendationJobSummary$CreationTime": "

A timestamp that indicates when the recommendation job was created.

", - "AIRecommendationJobSummary$EndTime": "

A timestamp that indicates when the recommendation job completed.

", - "AIWorkloadConfigSummary$CreationTime": "

A timestamp that indicates when the configuration was created.

", - "ActionSummary$CreationTime": "

When the action was created.

", - "ActionSummary$LastModifiedTime": "

When the action was last modified.

", - "AppImageConfigDetails$CreationTime": "

When the AppImageConfig was created.

", - "AppImageConfigDetails$LastModifiedTime": "

When the AppImageConfig was last modified.

", - "ArtifactSummary$CreationTime": "

When the artifact was created.

", - "ArtifactSummary$LastModifiedTime": "

When the artifact was last modified.

", - "AssociationSummary$CreationTime": "

When the association was created.

", - "AttachClusterNodeVolumeResponse$AttachTime": "

The timestamp when the volume attachment operation was initiated by the SageMaker HyperPod service.

", - "AutoMLCandidate$CreationTime": "

The creation time.

", - "AutoMLCandidate$EndTime": "

The end time.

", - "AutoMLCandidate$LastModifiedTime": "

The last modified time.

", - "AutoMLJobSummary$CreationTime": "

When the AutoML job was created.

", - "AutoMLJobSummary$EndTime": "

The end time of an AutoML job.

", - "AutoMLJobSummary$LastModifiedTime": "

When the AutoML job was last modified.

", - "ClusterEventDetail$EventTime": "

The timestamp when the event occurred.

", - "ClusterEventSummary$EventTime": "

The timestamp when the event occurred.

", - "ClusterNodeDetails$LaunchTime": "

The time when the instance is launched.

", - "ClusterNodeDetails$LastSoftwareUpdateTime": "

The time when the cluster was last updated.

", - "ClusterNodeSummary$LaunchTime": "

The time when the instance is launched.

", - "ClusterNodeSummary$LastSoftwareUpdateTime": "

The time when SageMaker last updated the software of the instances in the cluster.

", - "ClusterPatchSchedule$NextPatchDate": "

The date and time of the next scheduled automatic patch. The system sets this automatically when a patch is detected. Use this field to reschedule the patch to a different date.

", - "ClusterPatchScheduleDetails$NextPatchDate": "

The date and time of the next scheduled automatic patch.

", - "ClusterSchedulerConfigSummary$CreationTime": "

Creation time of the cluster policy.

", - "ClusterSchedulerConfigSummary$LastModifiedTime": "

Last modified time of the cluster policy.

", - "ClusterSummary$CreationTime": "

The time when the SageMaker HyperPod cluster is created.

", - "CompilationJobSummary$CompilationStartTime": "

The time when the model compilation job started.

", - "CompilationJobSummary$CompilationEndTime": "

The time when the model compilation job completed.

", - "ComputeQuotaSummary$CreationTime": "

Creation time of the compute allocation definition.

", - "ComputeQuotaSummary$LastModifiedTime": "

Last modified time of the compute allocation definition.

", - "ContextSummary$CreationTime": "

When the context was created.

", - "ContextSummary$LastModifiedTime": "

When the context was last modified.

", - "CreateTrialComponentRequest$StartTime": "

When the component started.

", - "CreateTrialComponentRequest$EndTime": "

When the component ended.

", - "DebugRuleEvaluationStatus$LastModifiedTime": "

Timestamp when the rule evaluation status was last modified.

", - "DeployedImage$ResolutionTime": "

The date and time when the image path for the model resolved to the ResolvedImage

", - "DescribeAIBenchmarkJobResponse$CreationTime": "

A timestamp that indicates when the benchmark job was created.

", - "DescribeAIBenchmarkJobResponse$StartTime": "

A timestamp that indicates when the benchmark job started running.

", - "DescribeAIBenchmarkJobResponse$EndTime": "

A timestamp that indicates when the benchmark job completed.

", - "DescribeAIRecommendationJobResponse$CreationTime": "

A timestamp that indicates when the recommendation job was created.

", - "DescribeAIRecommendationJobResponse$StartTime": "

A timestamp that indicates when the recommendation job started running.

", - "DescribeAIRecommendationJobResponse$EndTime": "

A timestamp that indicates when the recommendation job completed.

", - "DescribeAIWorkloadConfigResponse$CreationTime": "

A timestamp that indicates when the AI workload configuration was created.

", - "DescribeActionResponse$CreationTime": "

When the action was created.

", - "DescribeActionResponse$LastModifiedTime": "

When the action was last modified.

", - "DescribeAppImageConfigResponse$CreationTime": "

When the AppImageConfig was created.

", - "DescribeAppImageConfigResponse$LastModifiedTime": "

When the AppImageConfig was last modified.

", - "DescribeAppResponse$LastHealthCheckTimestamp": "

The timestamp of the last health check.

", - "DescribeAppResponse$LastUserActivityTimestamp": "

The timestamp of the last user's activity. LastUserActivityTimestamp is also updated when SageMaker AI performs health checks without user activity. As a result, this value is set to the same value as LastHealthCheckTimestamp.

", - "DescribeAppResponse$CreationTime": "

The creation time of the application.

After an application has been shut down for 24 hours, SageMaker AI deletes all metadata for the application. To be considered an update and retain application metadata, applications must be restarted within 24 hours after the previous application has been shut down. After this time window, creation of an application is considered a new application rather than an update of the previous application.

", - "DescribeArtifactResponse$CreationTime": "

When the artifact was created.

", - "DescribeArtifactResponse$LastModifiedTime": "

When the artifact was last modified.

", - "DescribeAutoMLJobResponse$CreationTime": "

Returns the creation time of the AutoML job.

", - "DescribeAutoMLJobResponse$EndTime": "

Returns the end time of the AutoML job.

", - "DescribeAutoMLJobResponse$LastModifiedTime": "

Returns the job's last modified time.

", - "DescribeAutoMLJobV2Response$CreationTime": "

Returns the creation time of the AutoML job V2.

", - "DescribeAutoMLJobV2Response$EndTime": "

Returns the end time of the AutoML job V2.

", - "DescribeAutoMLJobV2Response$LastModifiedTime": "

Returns the job's last modified time.

", - "DescribeClusterResponse$CreationTime": "

The time when the SageMaker Cluster is created.

", - "DescribeClusterSchedulerConfigResponse$CreationTime": "

Creation time of the cluster policy.

", - "DescribeClusterSchedulerConfigResponse$LastModifiedTime": "

Last modified time of the cluster policy.

", - "DescribeCompilationJobResponse$CompilationStartTime": "

The time when the model compilation job started the CompilationJob instances.

You are billed for the time between this timestamp and the timestamp in the CompilationEndTime field. In Amazon CloudWatch Logs, the start time might be later than this time. That's because it takes time to download the compilation job, which depends on the size of the compilation job container.

", - "DescribeCompilationJobResponse$CompilationEndTime": "

The time when the model compilation job on a compilation job instance ended. For a successful or stopped job, this is when the job's model artifacts have finished uploading. For a failed job, this is when Amazon SageMaker AI detected that the job failed.

", - "DescribeComputeQuotaResponse$CreationTime": "

Creation time of the compute allocation configuration.

", - "DescribeComputeQuotaResponse$LastModifiedTime": "

Last modified time of the compute allocation configuration.

", - "DescribeContextResponse$CreationTime": "

When the context was created.

", - "DescribeContextResponse$LastModifiedTime": "

When the context was last modified.

", - "DescribeDataQualityJobDefinitionResponse$CreationTime": "

The time that the data quality monitoring job definition was created.

", - "DescribeDeviceFleetResponse$CreationTime": "

Timestamp of when the device fleet was created.

", - "DescribeDeviceFleetResponse$LastModifiedTime": "

Timestamp of when the device fleet was last updated.

", - "DescribeDeviceResponse$RegistrationTime": "

The timestamp of the last registration or de-reregistration.

", - "DescribeDeviceResponse$LatestHeartbeat": "

The last heartbeat received from the device.

", - "DescribeEdgeDeploymentPlanResponse$CreationTime": "

The time when the edge deployment plan was created.

", - "DescribeEdgeDeploymentPlanResponse$LastModifiedTime": "

The time when the edge deployment plan was last updated.

", - "DescribeEdgePackagingJobResponse$CreationTime": "

The timestamp of when the packaging job was created.

", - "DescribeEdgePackagingJobResponse$LastModifiedTime": "

The timestamp of when the job was last updated.

", - "DescribeEndpointConfigOutput$CreationTime": "

A timestamp that shows when the endpoint configuration was created.

", - "DescribeEndpointOutput$CreationTime": "

A timestamp that shows when the endpoint was created.

", - "DescribeEndpointOutput$LastModifiedTime": "

A timestamp that shows when the endpoint was last modified.

", - "DescribeExperimentResponse$CreationTime": "

When the experiment was created.

", - "DescribeExperimentResponse$LastModifiedTime": "

When the experiment was last modified.

", - "DescribeFlowDefinitionResponse$CreationTime": "

The timestamp when the flow definition was created.

", - "DescribeHubContentResponse$CreationTime": "

The date and time that hub content was created.

", - "DescribeHubContentResponse$LastModifiedTime": "

The last modified time of the hub content.

", - "DescribeHubResponse$CreationTime": "

The date and time that the hub was created.

", - "DescribeHubResponse$LastModifiedTime": "

The date and time that the hub was last modified.

", - "DescribeHumanTaskUiResponse$CreationTime": "

The timestamp when the human task user interface was created.

", - "DescribeHyperParameterTuningJobResponse$CreationTime": "

The date and time that the tuning job started.

", - "DescribeHyperParameterTuningJobResponse$HyperParameterTuningEndTime": "

The date and time that the tuning job ended.

", - "DescribeHyperParameterTuningJobResponse$LastModifiedTime": "

The date and time that the status of the tuning job was modified.

", - "DescribeImageResponse$CreationTime": "

When the image was created.

", - "DescribeImageResponse$LastModifiedTime": "

When the image was last modified.

", - "DescribeImageVersionResponse$CreationTime": "

When the version was created.

", - "DescribeImageVersionResponse$LastModifiedTime": "

When the version was last modified.

", - "DescribeInferenceComponentOutput$CreationTime": "

The time when the inference component was created.

", - "DescribeInferenceComponentOutput$LastModifiedTime": "

The time when the inference component was last updated.

", - "DescribeInferenceExperimentResponse$CreationTime": "

The timestamp at which you created the inference experiment.

", - "DescribeInferenceExperimentResponse$CompletionTime": "

The timestamp at which the inference experiment was completed.

", - "DescribeInferenceExperimentResponse$LastModifiedTime": "

The timestamp at which you last modified the inference experiment.

", - "DescribeInferenceRecommendationsJobResponse$CompletionTime": "

A timestamp that shows when the job completed.

", - "DescribeJobResponse$CreationTime": "

The date and time that the job was created.

", - "DescribeJobResponse$LastModifiedTime": "

The date and time that the job was last modified.

", - "DescribeJobResponse$EndTime": "

The date and time that the job ended.

", - "DescribeLabelingJobResponse$CreationTime": "

The date and time that the labeling job was created.

", - "DescribeLabelingJobResponse$LastModifiedTime": "

The date and time that the labeling job was last updated.

", - "DescribeLineageGroupResponse$CreationTime": "

The creation time of lineage group.

", - "DescribeLineageGroupResponse$LastModifiedTime": "

The last modified time of the lineage group.

", - "DescribeMlflowAppResponse$CreationTime": "

The timestamp when the MLflow App was created.

", - "DescribeMlflowAppResponse$LastModifiedTime": "

The timestamp when the MLflow App was last modified.

", - "DescribeMlflowTrackingServerResponse$CreationTime": "

The timestamp of when the described MLflow Tracking Server was created.

", - "DescribeMlflowTrackingServerResponse$LastModifiedTime": "

The timestamp of when the described MLflow Tracking Server was last modified.

", - "DescribeModelBiasJobDefinitionResponse$CreationTime": "

The time at which the model bias job was created.

", - "DescribeModelCardExportJobResponse$CreatedAt": "

The date and time that the model export job was created.

", - "DescribeModelCardExportJobResponse$LastModifiedAt": "

The date and time that the model export job was last modified.

", - "DescribeModelCardResponse$CreationTime": "

The date and time the model card was created.

", - "DescribeModelCardResponse$LastModifiedTime": "

The date and time the model card was last modified.

", - "DescribeModelExplainabilityJobDefinitionResponse$CreationTime": "

The time at which the model explainability job was created.

", - "DescribeModelOutput$CreationTime": "

A timestamp that shows when the model was created.

", - "DescribeModelPackageOutput$LastModifiedTime": "

The last time that the model package was modified.

", - "DescribeModelQualityJobDefinitionResponse$CreationTime": "

The time at which the model quality job was created.

", - "DescribeMonitoringScheduleResponse$CreationTime": "

The time at which the monitoring job was created.

", - "DescribeMonitoringScheduleResponse$LastModifiedTime": "

The time at which the monitoring job was last modified.

", - "DescribeOptimizationJobResponse$OptimizationStartTime": "

The time when the optimization job started.

", - "DescribeOptimizationJobResponse$OptimizationEndTime": "

The time when the optimization job finished processing.

", - "DescribePartnerAppResponse$CreationTime": "

The time that the SageMaker Partner AI App was created.

", - "DescribePartnerAppResponse$LastModifiedTime": "

The time that the SageMaker Partner AI App was last modified.

", - "DescribePartnerAppResponse$CurrentVersionEolDate": "

The end-of-life date for the current version of the SageMaker Partner AI App.

", - "DescribePipelineDefinitionForExecutionResponse$CreationTime": "

The time when the pipeline was created.

", - "DescribePipelineExecutionResponse$CreationTime": "

The time when the pipeline execution was created.

", - "DescribePipelineExecutionResponse$LastModifiedTime": "

The time when the pipeline execution was modified last.

", - "DescribePipelineResponse$CreationTime": "

The time when the pipeline was created.

", - "DescribePipelineResponse$LastModifiedTime": "

The time when the pipeline was last modified.

", - "DescribePipelineResponse$LastRunTime": "

The time when the pipeline was last run.

", - "DescribeProcessingJobResponse$ProcessingEndTime": "

The time at which the processing job completed.

", - "DescribeProcessingJobResponse$ProcessingStartTime": "

The time at which the processing job started.

", - "DescribeProcessingJobResponse$LastModifiedTime": "

The time at which the processing job was last modified.

", - "DescribeProcessingJobResponse$CreationTime": "

The time at which the processing job was created.

", - "DescribeProjectOutput$CreationTime": "

The time when the project was created.

", - "DescribeProjectOutput$LastModifiedTime": "

The timestamp when project was last modified.

", - "DescribeReservedCapacityResponse$StartTime": "

The timestamp when the reserved capacity becomes active.

", - "DescribeReservedCapacityResponse$EndTime": "

The timestamp when the reserved capacity expires.

", - "DescribeStudioLifecycleConfigResponse$CreationTime": "

The creation time of the Amazon SageMaker AI Studio Lifecycle Configuration.

", - "DescribeStudioLifecycleConfigResponse$LastModifiedTime": "

This value is equivalent to CreationTime because Amazon SageMaker AI Studio Lifecycle Configurations are immutable.

", - "DescribeTrainingJobResponse$CreationTime": "

A timestamp that indicates when the training job was created.

", - "DescribeTrainingJobResponse$TrainingStartTime": "

Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.

", - "DescribeTrainingJobResponse$TrainingEndTime": "

Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when SageMaker detects a job failure.

", - "DescribeTrainingJobResponse$LastModifiedTime": "

A timestamp that indicates when the status of the training job was last modified.

", - "DescribeTrainingPlanResponse$StartTime": "

The start time of the training plan.

", - "DescribeTrainingPlanResponse$EndTime": "

The end time of the training plan.

", - "DescribeTransformJobResponse$CreationTime": "

A timestamp that shows when the transform Job was created.

", - "DescribeTransformJobResponse$TransformStartTime": "

Indicates when the transform job starts on ML instances. You are billed for the time interval between this time and the value of TransformEndTime.

", - "DescribeTransformJobResponse$TransformEndTime": "

Indicates when the transform job has been completed, or has stopped or failed. You are billed for the time interval between this time and the value of TransformStartTime.

", - "DescribeTrialComponentResponse$StartTime": "

When the component started.

", - "DescribeTrialComponentResponse$EndTime": "

When the component ended.

", - "DescribeTrialComponentResponse$CreationTime": "

When the component was created.

", - "DescribeTrialComponentResponse$LastModifiedTime": "

When the component was last modified.

", - "DescribeTrialResponse$CreationTime": "

When the trial was created.

", - "DescribeTrialResponse$LastModifiedTime": "

When the trial was last modified.

", - "DetachClusterNodeVolumeResponse$AttachTime": "

The original timestamp when your volume was initially attached to the node.

", - "DeviceDeploymentSummary$DeploymentStartTime": "

The time when the deployment on the device started.

", - "DeviceFleetSummary$CreationTime": "

Timestamp of when the device fleet was created.

", - "DeviceFleetSummary$LastModifiedTime": "

Timestamp of when the device fleet was last updated.

", - "DeviceSummary$RegistrationTime": "

The timestamp of the last registration or de-reregistration.

", - "DeviceSummary$LatestHeartbeat": "

The last heartbeat received from the device.

", - "EdgeDeploymentPlanSummary$CreationTime": "

The time when the edge deployment plan was created.

", - "EdgeDeploymentPlanSummary$LastModifiedTime": "

The time when the edge deployment plan was last updated.

", - "EdgeDeploymentStatus$EdgeDeploymentStageStartTime": "

The time when the deployment API started.

", - "EdgeModel$LatestSampleTime": "

The timestamp of the last data sample taken.

", - "EdgeModel$LatestInference": "

The timestamp of the last inference that was made.

", - "EdgePackagingJobSummary$CreationTime": "

The timestamp of when the job was created.

", - "EdgePackagingJobSummary$LastModifiedTime": "

The timestamp of when the edge packaging job was last updated.

", - "Endpoint$CreationTime": "

The time that the endpoint was created.

", - "Endpoint$LastModifiedTime": "

The last time the endpoint was modified.

", - "EndpointConfigSummary$CreationTime": "

A timestamp that shows when the endpoint configuration was created.

", - "EndpointSummary$CreationTime": "

A timestamp that shows when the endpoint was created.

", - "EndpointSummary$LastModifiedTime": "

A timestamp that shows when the endpoint was last modified.

", - "Experiment$CreationTime": "

When the experiment was created.

", - "Experiment$LastModifiedTime": "

When the experiment was last modified.

", - "ExperimentSummary$CreationTime": "

When the experiment was created.

", - "ExperimentSummary$LastModifiedTime": "

When the experiment was last modified.

", - "FeatureGroupSummary$CreationTime": "

A timestamp indicating the time of creation time of the FeatureGroup.

", - "FlowDefinitionSummary$CreationTime": "

The timestamp when SageMaker created the flow definition.

", - "GetDeviceFleetReportResponse$ReportGenerated": "

Timestamp of when the report was generated.

", - "HubContentInfo$CreationTime": "

The date and time that the hub content was created.

", - "HubContentInfo$OriginalCreationTime": "

The date and time when the hub content was originally created, before any updates or revisions.

", - "HubInfo$CreationTime": "

The date and time that the hub was created.

", - "HubInfo$LastModifiedTime": "

The date and time that the hub was last modified.

", - "HumanTaskUiSummary$CreationTime": "

A timestamp when SageMaker created the human task user interface.

", - "HyperParameterTrainingJobSummary$CreationTime": "

The date and time that the training job was created.

", - "HyperParameterTrainingJobSummary$TrainingStartTime": "

The date and time that the training job started.

", - "HyperParameterTrainingJobSummary$TrainingEndTime": "

Specifies the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when SageMaker detects a job failure.

", - "HyperParameterTuningJobCompletionDetails$ConvergenceDetectedTime": "

The time in timestamp format that AMT detected model convergence, as defined by a lack of significant improvement over time based on criteria developed over a wide range of diverse benchmarking tests.

", - "HyperParameterTuningJobSearchEntity$CreationTime": "

The time that a hyperparameter tuning job was created.

", - "HyperParameterTuningJobSearchEntity$HyperParameterTuningEndTime": "

The time that a hyperparameter tuning job ended.

", - "HyperParameterTuningJobSearchEntity$LastModifiedTime": "

The time that a hyperparameter tuning job was last modified.

", - "HyperParameterTuningJobSummary$CreationTime": "

The date and time that the tuning job was created.

", - "HyperParameterTuningJobSummary$HyperParameterTuningEndTime": "

The date and time that the tuning job ended.

", - "HyperParameterTuningJobSummary$LastModifiedTime": "

The date and time that the tuning job was modified.

", - "Image$CreationTime": "

When the image was created.

", - "Image$LastModifiedTime": "

When the image was last modified.

", - "ImageVersion$CreationTime": "

When the version was created.

", - "ImageVersion$LastModifiedTime": "

When the version was last modified.

", - "InferenceComponentSummary$CreationTime": "

The time when the inference component was created.

", - "InferenceComponentSummary$LastModifiedTime": "

The time when the inference component was last updated.

", - "InferenceExperimentSchedule$StartTime": "

The timestamp at which the inference experiment started or will start.

", - "InferenceExperimentSchedule$EndTime": "

The timestamp at which the inference experiment ended or will end.

", - "InferenceExperimentSummary$CreationTime": "

The timestamp at which the inference experiment was created.

", - "InferenceExperimentSummary$CompletionTime": "

The timestamp at which the inference experiment was completed.

", - "InferenceExperimentSummary$LastModifiedTime": "

The timestamp when you last modified the inference experiment.

", - "InferenceRecommendationsJob$CompletionTime": "

A timestamp that shows when the job completed.

", - "Job$CreationTime": "

The date and time that the job was created.

", - "Job$LastModifiedTime": "

The date and time that the job was last modified.

", - "Job$EndTime": "

The date and time that the job ended.

", - "JobSecondaryStatusTransition$StartTime": "

The date and time that the status transition started.

", - "JobSecondaryStatusTransition$EndTime": "

The date and time that the status transition ended.

", - "JobSummary$CreationTime": "

The date and time that the job was created.

", - "JobSummary$LastModifiedTime": "

The date and time that the job was last modified.

", - "JobSummary$EndTime": "

The date and time that the job ended.

", - "LabelingJobForWorkteamSummary$CreationTime": "

The date and time that the labeling job was created.

", - "LabelingJobSummary$CreationTime": "

The date and time that the job was created (timestamp).

", - "LabelingJobSummary$LastModifiedTime": "

The date and time that the job was last modified (timestamp).

", - "LineageGroupSummary$CreationTime": "

The creation time of the lineage group summary.

", - "LineageGroupSummary$LastModifiedTime": "

The last modified time of the lineage group summary.

", - "ListAIBenchmarkJobsRequest$CreationTimeAfter": "

A filter that returns only jobs created after the specified time.

", - "ListAIBenchmarkJobsRequest$CreationTimeBefore": "

A filter that returns only jobs created before the specified time.

", - "ListAIRecommendationJobsRequest$CreationTimeAfter": "

A filter that returns only jobs created after the specified time.

", - "ListAIRecommendationJobsRequest$CreationTimeBefore": "

A filter that returns only jobs created before the specified time.

", - "ListAIWorkloadConfigsRequest$CreationTimeAfter": "

A filter that returns only configurations created after the specified time.

", - "ListAIWorkloadConfigsRequest$CreationTimeBefore": "

A filter that returns only configurations created before the specified time.

", - "ListActionsRequest$CreatedAfter": "

A filter that returns only actions created on or after the specified time.

", - "ListActionsRequest$CreatedBefore": "

A filter that returns only actions created on or before the specified time.

", - "ListAppImageConfigsRequest$CreationTimeBefore": "

A filter that returns only AppImageConfigs created on or before the specified time.

", - "ListAppImageConfigsRequest$CreationTimeAfter": "

A filter that returns only AppImageConfigs created on or after the specified time.

", - "ListAppImageConfigsRequest$ModifiedTimeBefore": "

A filter that returns only AppImageConfigs modified on or before the specified time.

", - "ListAppImageConfigsRequest$ModifiedTimeAfter": "

A filter that returns only AppImageConfigs modified on or after the specified time.

", - "ListArtifactsRequest$CreatedAfter": "

A filter that returns only artifacts created on or after the specified time.

", - "ListArtifactsRequest$CreatedBefore": "

A filter that returns only artifacts created on or before the specified time.

", - "ListAssociationsRequest$CreatedAfter": "

A filter that returns only associations created on or after the specified time.

", - "ListAssociationsRequest$CreatedBefore": "

A filter that returns only associations created on or before the specified time.

", - "ListAutoMLJobsRequest$CreationTimeAfter": "

Request a list of jobs, using a filter for time.

", - "ListAutoMLJobsRequest$CreationTimeBefore": "

Request a list of jobs, using a filter for time.

", - "ListAutoMLJobsRequest$LastModifiedTimeAfter": "

Request a list of jobs, using a filter for time.

", - "ListAutoMLJobsRequest$LastModifiedTimeBefore": "

Request a list of jobs, using a filter for time.

", - "ListClusterEventsRequest$EventTimeAfter": "

The start of the time range for filtering events. Only events that occurred after this time are included in the results.

", - "ListClusterEventsRequest$EventTimeBefore": "

The end of the time range for filtering events. Only events that occurred before this time are included in the results.

", - "ListClusterNodesRequest$CreationTimeAfter": "

A filter that returns nodes in a SageMaker HyperPod cluster created after the specified time. Timestamps are formatted according to the ISO 8601 standard.

Acceptable formats include:

  • YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example, 2014-10-01T20:30:00.000Z

  • YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example, 2014-10-01T12:30:00.000-08:00

  • YYYY-MM-DD, for example, 2014-10-01

  • Unix time in seconds, for example, 1412195400. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC.

For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.

", - "ListClusterNodesRequest$CreationTimeBefore": "

A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The acceptable formats are the same as the timestamp formats for CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.

", - "ListClusterSchedulerConfigsRequest$CreatedAfter": "

Filter for after this creation time. The input for this parameter is a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.

", - "ListClusterSchedulerConfigsRequest$CreatedBefore": "

Filter for before this creation time. The input for this parameter is a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.

", - "ListClustersRequest$CreationTimeAfter": "

Set a start time for the time range during which you want to list SageMaker HyperPod clusters. Timestamps are formatted according to the ISO 8601 standard.

Acceptable formats include:

  • YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example, 2014-10-01T20:30:00.000Z

  • YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example, 2014-10-01T12:30:00.000-08:00

  • YYYY-MM-DD, for example, 2014-10-01

  • Unix time in seconds, for example, 1412195400. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC.

For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.

", - "ListClustersRequest$CreationTimeBefore": "

Set an end time for the time range during which you want to list SageMaker HyperPod clusters. A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The acceptable formats are the same as the timestamp formats for CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.

", - "ListCodeRepositoriesInput$LastModifiedTimeAfter": "

A filter that returns only Git repositories that were last modified after the specified time.

", - "ListCodeRepositoriesInput$LastModifiedTimeBefore": "

A filter that returns only Git repositories that were last modified before the specified time.

", - "ListComputeQuotasRequest$CreatedAfter": "

Filter for after this creation time. The input for this parameter is a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.

", - "ListComputeQuotasRequest$CreatedBefore": "

Filter for before this creation time. The input for this parameter is a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.

", - "ListContextsRequest$CreatedAfter": "

A filter that returns only contexts created on or after the specified time.

", - "ListContextsRequest$CreatedBefore": "

A filter that returns only contexts created on or before the specified time.

", - "ListDataQualityJobDefinitionsRequest$CreationTimeBefore": "

A filter that returns only data quality monitoring job definitions created before the specified time.

", - "ListDataQualityJobDefinitionsRequest$CreationTimeAfter": "

A filter that returns only data quality monitoring job definitions created after the specified time.

", - "ListDeviceFleetsRequest$CreationTimeAfter": "

Filter fleets where packaging job was created after specified time.

", - "ListDeviceFleetsRequest$CreationTimeBefore": "

Filter fleets where the edge packaging job was created before specified time.

", - "ListDeviceFleetsRequest$LastModifiedTimeAfter": "

Select fleets where the job was updated after X

", - "ListDeviceFleetsRequest$LastModifiedTimeBefore": "

Select fleets where the job was updated before X

", - "ListDevicesRequest$LatestHeartbeatAfter": "

Select fleets where the job was updated after X

", - "ListEdgeDeploymentPlansRequest$CreationTimeAfter": "

Selects edge deployment plans created after this time.

", - "ListEdgeDeploymentPlansRequest$CreationTimeBefore": "

Selects edge deployment plans created before this time.

", - "ListEdgeDeploymentPlansRequest$LastModifiedTimeAfter": "

Selects edge deployment plans that were last updated after this time.

", - "ListEdgeDeploymentPlansRequest$LastModifiedTimeBefore": "

Selects edge deployment plans that were last updated before this time.

", - "ListEdgePackagingJobsRequest$CreationTimeAfter": "

Select jobs where the job was created after specified time.

", - "ListEdgePackagingJobsRequest$CreationTimeBefore": "

Select jobs where the job was created before specified time.

", - "ListEdgePackagingJobsRequest$LastModifiedTimeAfter": "

Select jobs where the job was updated after specified time.

", - "ListEdgePackagingJobsRequest$LastModifiedTimeBefore": "

Select jobs where the job was updated before specified time.

", - "ListEndpointConfigsInput$CreationTimeBefore": "

A filter that returns only endpoint configurations created before the specified time (timestamp).

", - "ListEndpointConfigsInput$CreationTimeAfter": "

A filter that returns only endpoint configurations with a creation time greater than or equal to the specified time (timestamp).

", - "ListEndpointsInput$CreationTimeBefore": "

A filter that returns only endpoints that were created before the specified time (timestamp).

", - "ListEndpointsInput$CreationTimeAfter": "

A filter that returns only endpoints with a creation time greater than or equal to the specified time (timestamp).

", - "ListEndpointsInput$LastModifiedTimeBefore": "

A filter that returns only endpoints that were modified before the specified timestamp.

", - "ListEndpointsInput$LastModifiedTimeAfter": "

A filter that returns only endpoints that were modified after the specified timestamp.

", - "ListExperimentsRequest$CreatedAfter": "

A filter that returns only experiments created after the specified time.

", - "ListExperimentsRequest$CreatedBefore": "

A filter that returns only experiments created before the specified time.

", - "ListFlowDefinitionsRequest$CreationTimeAfter": "

A filter that returns only flow definitions with a creation time greater than or equal to the specified timestamp.

", - "ListFlowDefinitionsRequest$CreationTimeBefore": "

A filter that returns only flow definitions that were created before the specified timestamp.

", - "ListHubContentVersionsRequest$CreationTimeBefore": "

Only list hub content versions that were created before the time specified.

", - "ListHubContentVersionsRequest$CreationTimeAfter": "

Only list hub content versions that were created after the time specified.

", - "ListHubContentsRequest$CreationTimeBefore": "

Only list hub content that was created before the time specified.

", - "ListHubContentsRequest$CreationTimeAfter": "

Only list hub content that was created after the time specified.

", - "ListHubsRequest$CreationTimeBefore": "

Only list hubs that were created before the time specified.

", - "ListHubsRequest$CreationTimeAfter": "

Only list hubs that were created after the time specified.

", - "ListHubsRequest$LastModifiedTimeBefore": "

Only list hubs that were last modified before the time specified.

", - "ListHubsRequest$LastModifiedTimeAfter": "

Only list hubs that were last modified after the time specified.

", - "ListHumanTaskUisRequest$CreationTimeAfter": "

A filter that returns only human task user interfaces with a creation time greater than or equal to the specified timestamp.

", - "ListHumanTaskUisRequest$CreationTimeBefore": "

A filter that returns only human task user interfaces that were created before the specified timestamp.

", - "ListHyperParameterTuningJobsRequest$CreationTimeAfter": "

A filter that returns only tuning jobs that were created after the specified time.

", - "ListHyperParameterTuningJobsRequest$CreationTimeBefore": "

A filter that returns only tuning jobs that were created before the specified time.

", - "ListHyperParameterTuningJobsRequest$LastModifiedTimeAfter": "

A filter that returns only tuning jobs that were modified after the specified time.

", - "ListHyperParameterTuningJobsRequest$LastModifiedTimeBefore": "

A filter that returns only tuning jobs that were modified before the specified time.

", - "ListImageVersionsRequest$CreationTimeAfter": "

A filter that returns only versions created on or after the specified time.

", - "ListImageVersionsRequest$CreationTimeBefore": "

A filter that returns only versions created on or before the specified time.

", - "ListImageVersionsRequest$LastModifiedTimeAfter": "

A filter that returns only versions modified on or after the specified time.

", - "ListImageVersionsRequest$LastModifiedTimeBefore": "

A filter that returns only versions modified on or before the specified time.

", - "ListImagesRequest$CreationTimeAfter": "

A filter that returns only images created on or after the specified time.

", - "ListImagesRequest$CreationTimeBefore": "

A filter that returns only images created on or before the specified time.

", - "ListImagesRequest$LastModifiedTimeAfter": "

A filter that returns only images modified on or after the specified time.

", - "ListImagesRequest$LastModifiedTimeBefore": "

A filter that returns only images modified on or before the specified time.

", - "ListInferenceComponentsInput$CreationTimeBefore": "

Filters the results to only those inference components that were created before the specified time.

", - "ListInferenceComponentsInput$CreationTimeAfter": "

Filters the results to only those inference components that were created after the specified time.

", - "ListInferenceComponentsInput$LastModifiedTimeBefore": "

Filters the results to only those inference components that were updated before the specified time.

", - "ListInferenceComponentsInput$LastModifiedTimeAfter": "

Filters the results to only those inference components that were updated after the specified time.

", - "ListInferenceExperimentsRequest$CreationTimeAfter": "

Selects inference experiments which were created after this timestamp.

", - "ListInferenceExperimentsRequest$CreationTimeBefore": "

Selects inference experiments which were created before this timestamp.

", - "ListInferenceExperimentsRequest$LastModifiedTimeAfter": "

Selects inference experiments which were last modified after this timestamp.

", - "ListInferenceExperimentsRequest$LastModifiedTimeBefore": "

Selects inference experiments which were last modified before this timestamp.

", - "ListJobsRequest$CreationTimeAfter": "

A filter that returns only jobs created after the specified time.

", - "ListJobsRequest$CreationTimeBefore": "

A filter that returns only jobs created before the specified time.

", - "ListJobsRequest$LastModifiedTimeAfter": "

A filter that returns only jobs modified after the specified time.

", - "ListJobsRequest$LastModifiedTimeBefore": "

A filter that returns only jobs modified before the specified time.

", - "ListLabelingJobsForWorkteamRequest$CreationTimeAfter": "

A filter that returns only labeling jobs created after the specified time (timestamp).

", - "ListLabelingJobsForWorkteamRequest$CreationTimeBefore": "

A filter that returns only labeling jobs created before the specified time (timestamp).

", - "ListLabelingJobsRequest$CreationTimeAfter": "

A filter that returns only labeling jobs created after the specified time (timestamp).

", - "ListLabelingJobsRequest$CreationTimeBefore": "

A filter that returns only labeling jobs created before the specified time (timestamp).

", - "ListLabelingJobsRequest$LastModifiedTimeAfter": "

A filter that returns only labeling jobs modified after the specified time (timestamp).

", - "ListLabelingJobsRequest$LastModifiedTimeBefore": "

A filter that returns only labeling jobs modified before the specified time (timestamp).

", - "ListLineageGroupsRequest$CreatedAfter": "

A timestamp to filter against lineage groups created after a certain point in time.

", - "ListLineageGroupsRequest$CreatedBefore": "

A timestamp to filter against lineage groups created before a certain point in time.

", - "ListMlflowAppsRequest$CreatedAfter": "

Use the CreatedAfter filter to only list MLflow Apps created after a specific date and time. Listed MLflow Apps are shown with a date and time such as \"2024-03-16T01:46:56+00:00\". The CreatedAfter parameter takes in a Unix timestamp.

", - "ListMlflowAppsRequest$CreatedBefore": "

Use the CreatedBefore filter to only list MLflow Apps created before a specific date and time. Listed MLflow Apps are shown with a date and time such as \"2024-03-16T01:46:56+00:00\". The CreatedAfter parameter takes in a Unix timestamp.

", - "ListMlflowTrackingServersRequest$CreatedAfter": "

Use the CreatedAfter filter to only list tracking servers created after a specific date and time. Listed tracking servers are shown with a date and time such as \"2024-03-16T01:46:56+00:00\". The CreatedAfter parameter takes in a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.

", - "ListMlflowTrackingServersRequest$CreatedBefore": "

Use the CreatedBefore filter to only list tracking servers created before a specific date and time. Listed tracking servers are shown with a date and time such as \"2024-03-16T01:46:56+00:00\". The CreatedBefore parameter takes in a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.

", - "ListModelBiasJobDefinitionsRequest$CreationTimeBefore": "

A filter that returns only model bias jobs created before a specified time.

", - "ListModelBiasJobDefinitionsRequest$CreationTimeAfter": "

A filter that returns only model bias jobs created after a specified time.

", - "ListModelCardExportJobsRequest$CreationTimeAfter": "

Only list model card export jobs that were created after the time specified.

", - "ListModelCardExportJobsRequest$CreationTimeBefore": "

Only list model card export jobs that were created before the time specified.

", - "ListModelCardVersionsRequest$CreationTimeAfter": "

Only list model card versions that were created after the time specified.

", - "ListModelCardVersionsRequest$CreationTimeBefore": "

Only list model card versions that were created before the time specified.

", - "ListModelCardsRequest$CreationTimeAfter": "

Only list model cards that were created after the time specified.

", - "ListModelCardsRequest$CreationTimeBefore": "

Only list model cards that were created before the time specified.

", - "ListModelExplainabilityJobDefinitionsRequest$CreationTimeBefore": "

A filter that returns only model explainability jobs created before a specified time.

", - "ListModelExplainabilityJobDefinitionsRequest$CreationTimeAfter": "

A filter that returns only model explainability jobs created after a specified time.

", - "ListModelQualityJobDefinitionsRequest$CreationTimeBefore": "

A filter that returns only model quality monitoring job definitions created before the specified time.

", - "ListModelQualityJobDefinitionsRequest$CreationTimeAfter": "

A filter that returns only model quality monitoring job definitions created after the specified time.

", - "ListModelsInput$CreationTimeBefore": "

A filter that returns only models created before the specified time (timestamp).

", - "ListModelsInput$CreationTimeAfter": "

A filter that returns only models with a creation time greater than or equal to the specified time (timestamp).

", - "ListMonitoringAlertHistoryRequest$CreationTimeBefore": "

A filter that returns only alerts created on or before the specified time.

", - "ListMonitoringAlertHistoryRequest$CreationTimeAfter": "

A filter that returns only alerts created on or after the specified time.

", - "ListMonitoringExecutionsRequest$ScheduledTimeBefore": "

Filter for jobs scheduled before a specified time.

", - "ListMonitoringExecutionsRequest$ScheduledTimeAfter": "

Filter for jobs scheduled after a specified time.

", - "ListMonitoringExecutionsRequest$CreationTimeBefore": "

A filter that returns only jobs created before a specified time.

", - "ListMonitoringExecutionsRequest$CreationTimeAfter": "

A filter that returns only jobs created after a specified time.

", - "ListMonitoringExecutionsRequest$LastModifiedTimeBefore": "

A filter that returns only jobs modified after a specified time.

", - "ListMonitoringExecutionsRequest$LastModifiedTimeAfter": "

A filter that returns only jobs modified before a specified time.

", - "ListMonitoringSchedulesRequest$CreationTimeBefore": "

A filter that returns only monitoring schedules created before a specified time.

", - "ListMonitoringSchedulesRequest$CreationTimeAfter": "

A filter that returns only monitoring schedules created after a specified time.

", - "ListMonitoringSchedulesRequest$LastModifiedTimeBefore": "

A filter that returns only monitoring schedules modified before a specified time.

", - "ListMonitoringSchedulesRequest$LastModifiedTimeAfter": "

A filter that returns only monitoring schedules modified after a specified time.

", - "ListPipelineExecutionsRequest$CreatedAfter": "

A filter that returns the pipeline executions that were created after a specified time.

", - "ListPipelineExecutionsRequest$CreatedBefore": "

A filter that returns the pipeline executions that were created before a specified time.

", - "ListPipelineVersionsRequest$CreatedAfter": "

A filter that returns the pipeline versions that were created after a specified time.

", - "ListPipelineVersionsRequest$CreatedBefore": "

A filter that returns the pipeline versions that were created before a specified time.

", - "ListPipelinesRequest$CreatedAfter": "

A filter that returns the pipelines that were created after a specified time.

", - "ListPipelinesRequest$CreatedBefore": "

A filter that returns the pipelines that were created before a specified time.

", - "ListProcessingJobsRequest$CreationTimeAfter": "

A filter that returns only processing jobs created after the specified time.

", - "ListProcessingJobsRequest$CreationTimeBefore": "

A filter that returns only processing jobs created after the specified time.

", - "ListProcessingJobsRequest$LastModifiedTimeAfter": "

A filter that returns only processing jobs modified after the specified time.

", - "ListProcessingJobsRequest$LastModifiedTimeBefore": "

A filter that returns only processing jobs modified before the specified time.

", - "ListProjectsInput$CreationTimeAfter": "

A filter that returns the projects that were created after a specified time.

", - "ListProjectsInput$CreationTimeBefore": "

A filter that returns the projects that were created before a specified time.

", - "ListResourceCatalogsRequest$CreationTimeAfter": "

Use this parameter to search for ResourceCatalogs created after a specific date and time.

", - "ListResourceCatalogsRequest$CreationTimeBefore": "

Use this parameter to search for ResourceCatalogs created before a specific date and time.

", - "ListStudioLifecycleConfigsRequest$CreationTimeBefore": "

A filter that returns only Lifecycle Configurations created on or before the specified time.

", - "ListStudioLifecycleConfigsRequest$CreationTimeAfter": "

A filter that returns only Lifecycle Configurations created on or after the specified time.

", - "ListStudioLifecycleConfigsRequest$ModifiedTimeBefore": "

A filter that returns only Lifecycle Configurations modified before the specified time.

", - "ListStudioLifecycleConfigsRequest$ModifiedTimeAfter": "

A filter that returns only Lifecycle Configurations modified after the specified time.

", - "ListTrainingJobsRequest$CreationTimeAfter": "

A filter that returns only training jobs created after the specified time (timestamp).

", - "ListTrainingJobsRequest$CreationTimeBefore": "

A filter that returns only training jobs created before the specified time (timestamp).

", - "ListTrainingJobsRequest$LastModifiedTimeAfter": "

A filter that returns only training jobs modified after the specified time (timestamp).

", - "ListTrainingJobsRequest$LastModifiedTimeBefore": "

A filter that returns only training jobs modified before the specified time (timestamp).

", - "ListTrainingPlansRequest$StartTimeAfter": "

Filter to list only training plans with an actual start time after this date.

", - "ListTrainingPlansRequest$StartTimeBefore": "

Filter to list only training plans with an actual start time before this date.

", - "ListTransformJobsRequest$CreationTimeAfter": "

A filter that returns only transform jobs created after the specified time.

", - "ListTransformJobsRequest$CreationTimeBefore": "

A filter that returns only transform jobs created before the specified time.

", - "ListTransformJobsRequest$LastModifiedTimeAfter": "

A filter that returns only transform jobs modified after the specified time.

", - "ListTransformJobsRequest$LastModifiedTimeBefore": "

A filter that returns only transform jobs modified before the specified time.

", - "ListTrialComponentsRequest$CreatedAfter": "

A filter that returns only components created after the specified time.

", - "ListTrialComponentsRequest$CreatedBefore": "

A filter that returns only components created before the specified time.

", - "ListTrialsRequest$CreatedAfter": "

A filter that returns only trials created after the specified time.

", - "ListTrialsRequest$CreatedBefore": "

A filter that returns only trials created before the specified time.

", - "MetricData$Timestamp": "

The date and time that the algorithm emitted the metric.

", - "MlflowAppSummary$CreationTime": "

The creation time of a listed MLflow App.

", - "MlflowAppSummary$LastModifiedTime": "

The last modified time of a listed MLflow App.

", - "Model$CreationTime": "

A timestamp that indicates when the model was created.

", - "ModelCard$CreationTime": "

The date and time that the model card was created.

", - "ModelCard$LastModifiedTime": "

The date and time that the model card was last modified.

", - "ModelCardExportJobSummary$CreatedAt": "

The date and time that the model card export job was created.

", - "ModelCardExportJobSummary$LastModifiedAt": "

The date and time that the model card export job was last modified..

", - "ModelCardSummary$CreationTime": "

The date and time that the model card was created.

", - "ModelCardSummary$LastModifiedTime": "

The date and time that the model card was last modified.

", - "ModelCardVersionSummary$CreationTime": "

The date and time that the model card version was created.

", - "ModelCardVersionSummary$LastModifiedTime": "

The time date and time that the model card version was last modified.

", - "ModelDashboardEndpoint$CreationTime": "

A timestamp that indicates when the endpoint was created.

", - "ModelDashboardEndpoint$LastModifiedTime": "

The last time the endpoint was modified.

", - "ModelDashboardModelCard$CreationTime": "

A timestamp that indicates when the model card was created.

", - "ModelDashboardModelCard$LastModifiedTime": "

A timestamp that indicates when the model card was last updated.

", - "ModelDashboardMonitoringSchedule$CreationTime": "

A timestamp that indicates when the monitoring schedule was created.

", - "ModelDashboardMonitoringSchedule$LastModifiedTime": "

A timestamp that indicates when the monitoring schedule was last updated.

", - "ModelPackage$LastModifiedTime": "

The last time the model package was modified.

", - "ModelSummary$CreationTime": "

A timestamp that indicates when the model was created.

", - "MonitoringAlertHistorySummary$CreationTime": "

A timestamp that indicates when the first alert transition occurred in an alert history. An alert transition can be from status InAlert to OK, or from OK to InAlert.

", - "MonitoringAlertSummary$CreationTime": "

A timestamp that indicates when a monitor alert was created.

", - "MonitoringAlertSummary$LastModifiedTime": "

A timestamp that indicates when a monitor alert was last updated.

", - "MonitoringExecutionSummary$ScheduledTime": "

The time the monitoring job was scheduled.

", - "MonitoringExecutionSummary$CreationTime": "

The time at which the monitoring job was created.

", - "MonitoringExecutionSummary$LastModifiedTime": "

A timestamp that indicates the last time the monitoring job was modified.

", - "MonitoringJobDefinitionSummary$CreationTime": "

The time that the monitoring job was created.

", - "MonitoringSchedule$CreationTime": "

The time that the monitoring schedule was created.

", - "MonitoringSchedule$LastModifiedTime": "

The last time the monitoring schedule was changed.

", - "MonitoringScheduleSummary$CreationTime": "

The creation time of the monitoring schedule.

", - "MonitoringScheduleSummary$LastModifiedTime": "

The last time the monitoring schedule was modified.

", - "OptimizationJobSummary$OptimizationStartTime": "

The time when the optimization job started.

", - "OptimizationJobSummary$OptimizationEndTime": "

The time when the optimization job finished processing.

", - "PartnerAppSummary$CreationTime": "

The creation time of the SageMaker Partner AI App.

", - "PendingDeploymentSummary$StartTime": "

The start time of the deployment.

", - "Pipeline$CreationTime": "

The creation time of the pipeline.

", - "Pipeline$LastModifiedTime": "

The time that the pipeline was last modified.

", - "Pipeline$LastRunTime": "

The time when the pipeline was last run.

", - "PipelineExecution$CreationTime": "

The creation time of the pipeline execution.

", - "PipelineExecution$LastModifiedTime": "

The time that the pipeline execution was last modified.

", - "PipelineExecutionStep$StartTime": "

The time that the step started executing.

", - "PipelineExecutionStep$EndTime": "

The time that the step stopped executing.

", - "PipelineExecutionSummary$StartTime": "

The start time of the pipeline execution.

", - "PipelineSummary$CreationTime": "

The creation time of the pipeline.

", - "PipelineSummary$LastModifiedTime": "

The time that the pipeline was last modified.

", - "PipelineSummary$LastExecutionTime": "

The last time that a pipeline execution began.

", - "PipelineVersion$CreationTime": "

The creation time of the pipeline version.

", - "PipelineVersion$LastModifiedTime": "

The time when the pipeline version was last modified.

", - "PipelineVersionSummary$CreationTime": "

The creation time of the pipeline version.

", - "ProcessingJob$ProcessingEndTime": "

The time that the processing job ended.

", - "ProcessingJob$ProcessingStartTime": "

The time that the processing job started.

", - "ProcessingJob$LastModifiedTime": "

The time the processing job was last modified.

", - "ProcessingJob$CreationTime": "

The time the processing job was created.

", - "ProcessingJobSummary$CreationTime": "

The time at which the processing job was created.

", - "ProcessingJobSummary$ProcessingEndTime": "

The time at which the processing job completed.

", - "ProcessingJobSummary$LastModifiedTime": "

A timestamp that indicates the last time the processing job was modified.

", - "ProductionVariantStatus$StartTime": "

The start time of the current status change.

", - "ProfilerRuleEvaluationStatus$LastModifiedTime": "

Timestamp when the rule evaluation status was last modified.

", - "Project$CreationTime": "

A timestamp specifying when the project was created.

", - "Project$LastModifiedTime": "

A timestamp container for when the project was last modified.

", - "ProjectSummary$CreationTime": "

The time that the project was created.

", - "QueryFilters$CreatedBefore": "

Filter the lineage entities connected to the StartArn(s) by created date.

", - "QueryFilters$CreatedAfter": "

Filter the lineage entities connected to the StartArn(s) after the create date.

", - "QueryFilters$ModifiedBefore": "

Filter the lineage entities connected to the StartArn(s) before the last modified date.

", - "QueryFilters$ModifiedAfter": "

Filter the lineage entities connected to the StartArn(s) after the last modified date.

", - "ReservedCapacityOffering$StartTime": "

The start time of the reserved capacity offering.

", - "ReservedCapacityOffering$EndTime": "

The end time of the reserved capacity offering.

", - "ReservedCapacityOffering$ExtensionStartTime": "

The start time of the extension for the reserved capacity offering.

", - "ReservedCapacityOffering$ExtensionEndTime": "

The end time of the extension for the reserved capacity offering.

", - "ReservedCapacitySummary$StartTime": "

The start time of the reserved capacity.

", - "ReservedCapacitySummary$EndTime": "

The end time of the reserved capacity.

", - "ResourceCatalog$CreationTime": "

The time the ResourceCatalog was created.

", - "SearchTrainingPlanOfferingsRequest$StartTimeAfter": "

A filter to search for training plan offerings with a start time after a specified date.

", - "SearchTrainingPlanOfferingsRequest$EndTimeBefore": "

A filter to search for reserved capacity offerings with an end time before a specified date.

", - "SecondaryStatusTransition$StartTime": "

A timestamp that shows when the training job transitioned to the current secondary status state.

", - "SecondaryStatusTransition$EndTime": "

A timestamp that shows when the training job transitioned out of this secondary status state into another secondary status state or when the training job has ended.

", - "StudioLifecycleConfigDetails$CreationTime": "

The creation time of the Amazon SageMaker AI Studio Lifecycle Configuration.

", - "StudioLifecycleConfigDetails$LastModifiedTime": "

This value is equivalent to CreationTime because Amazon SageMaker AI Studio Lifecycle Configurations are immutable.

", - "TrackingServerSummary$CreationTime": "

The creation time of a listed tracking server.

", - "TrackingServerSummary$LastModifiedTime": "

The last modified time of a listed tracking server.

", - "TrainingJob$CreationTime": "

A timestamp that indicates when the training job was created.

", - "TrainingJob$TrainingStartTime": "

Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.

", - "TrainingJob$TrainingEndTime": "

Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when SageMaker detects a job failure.

", - "TrainingJob$LastModifiedTime": "

A timestamp that indicates when the status of the training job was last modified.

", - "TrainingJobSummary$CreationTime": "

A timestamp that shows when the training job was created.

", - "TrainingJobSummary$TrainingEndTime": "

A timestamp that shows when the training job ended. This field is set only if the training job has one of the terminal statuses (Completed, Failed, or Stopped).

", - "TrainingJobSummary$LastModifiedTime": "

Timestamp when the training job was last modified.

", - "TrainingPlanExtension$ExtendedAt": "

The timestamp when the extension was created.

", - "TrainingPlanExtension$StartDate": "

The start date of the extension period.

", - "TrainingPlanExtension$EndDate": "

The end date of the extension period.

", - "TrainingPlanExtensionOffering$StartDate": "

The start date of this extension offering.

", - "TrainingPlanExtensionOffering$EndDate": "

The end date of this extension offering.

", - "TrainingPlanOffering$RequestedStartTimeAfter": "

The requested start time that the user specified when searching for the training plan offering.

", - "TrainingPlanOffering$RequestedEndTimeBefore": "

The requested end time that the user specified when searching for the training plan offering.

", - "TrainingPlanSummary$StartTime": "

The start time of the training plan.

", - "TrainingPlanSummary$EndTime": "

The end time of the training plan.

", - "TransformJob$CreationTime": "

A timestamp that shows when the transform Job was created.

", - "TransformJob$TransformStartTime": "

Indicates when the transform job starts on ML instances. You are billed for the time interval between this time and the value of TransformEndTime.

", - "TransformJob$TransformEndTime": "

Indicates when the transform job has been completed, or has stopped or failed. You are billed for the time interval between this time and the value of TransformStartTime.

", - "TransformJobSummary$CreationTime": "

A timestamp that shows when the transform Job was created.

", - "TransformJobSummary$TransformEndTime": "

Indicates when the transform job ends on compute instances. For successful jobs and stopped jobs, this is the exact time recorded after the results are uploaded. For failed jobs, this is when Amazon SageMaker detected that the job failed.

", - "TransformJobSummary$LastModifiedTime": "

Indicates when the transform job was last modified.

", - "Trial$CreationTime": "

When the trial was created.

", - "Trial$LastModifiedTime": "

Who last modified the trial.

", - "TrialComponent$StartTime": "

When the component started.

", - "TrialComponent$EndTime": "

When the component ended.

", - "TrialComponent$CreationTime": "

When the component was created.

", - "TrialComponent$LastModifiedTime": "

When the component was last modified.

", - "TrialComponentMetricSummary$TimeStamp": "

When the metric was last updated.

", - "TrialComponentSimpleSummary$CreationTime": "

When the component was created.

", - "TrialComponentSummary$StartTime": "

When the component started.

", - "TrialComponentSummary$EndTime": "

When the component ended.

", - "TrialComponentSummary$CreationTime": "

When the component was created.

", - "TrialComponentSummary$LastModifiedTime": "

When the component was last modified.

", - "TrialSummary$CreationTime": "

When the trial was created.

", - "TrialSummary$LastModifiedTime": "

When the trial was last modified.

", - "UpdateTrialComponentRequest$StartTime": "

When the component started.

", - "UpdateTrialComponentRequest$EndTime": "

When the component ended.

", - "Workforce$LastUpdatedDate": "

The most recent date that UpdateWorkforce was used to successfully add one or more IP address ranges (CIDRs) to a private workforce's allow list.

", - "Workforce$CreateDate": "

The date that the workforce is created.

", - "Workteam$CreateDate": "

The date and time that the work team was created (timestamp).

", - "Workteam$LastUpdatedDate": "

The date and time that the work team was last updated (timestamp).

" - } - }, - "TimestampAttributeName": { - "base": null, - "refs": { - "TimeSeriesConfig$TimestampAttributeName": "

The name of the column indicating a point in time at which the target value of a given item is recorded.

" - } - }, - "TokenValue": { - "base": null, - "refs": { - "StartSessionResponse$TokenValue": "

An encrypted token value containing session and caller information.

" - } - }, - "TotalHits": { - "base": "

Represents the total number of matching results and indicates how accurate that count is.

The Value field provides the count, which may be exact or estimated. The Relation field indicates whether it's an exact figure or a lower bound. This helps understand the full scope of search results, especially when dealing with large result sets.

", - "refs": { - "SearchResponse$TotalHits": "

The total number of matching results.

" - } - }, - "TotalInstanceCount": { - "base": null, - "refs": { - "DescribeReservedCapacityResponse$TotalInstanceCount": "

The total number of instances allocated to this reserved capacity.

", - "DescribeTrainingPlanResponse$TotalInstanceCount": "

The total number of instances reserved in this training plan.

", - "ReservedCapacitySummary$TotalInstanceCount": "

The total number of instances in the reserved capacity.

", - "TrainingPlanSummary$TotalInstanceCount": "

The total number of instances reserved in this training plan.

", - "UltraServer$TotalInstanceCount": "

The total number of instances in this UltraServer.

" - } - }, - "TotalStepCountPerEpoch": { - "base": "

TrainingProgressInfo relevant fields

", - "refs": { - "TrainingProgressInfo$TotalStepCountPerEpoch": "

The total step count per epoch.

" - } - }, - "TrackingServerArn": { - "base": null, - "refs": { - "CreateMlflowTrackingServerResponse$TrackingServerArn": "

The ARN of the tracking server.

", - "DeleteMlflowTrackingServerResponse$TrackingServerArn": "

A TrackingServerArn object, the ARN of the tracking server that is deleted if successfully found.

", - "DescribeMlflowTrackingServerResponse$TrackingServerArn": "

The ARN of the described tracking server.

", - "StartMlflowTrackingServerResponse$TrackingServerArn": "

The ARN of the started tracking server.

", - "StopMlflowTrackingServerResponse$TrackingServerArn": "

The ARN of the stopped tracking server.

", - "TrackingServerSummary$TrackingServerArn": "

The ARN of a listed tracking server.

", - "UpdateMlflowTrackingServerResponse$TrackingServerArn": "

The ARN of the updated MLflow Tracking Server.

" - } - }, - "TrackingServerMaintenanceStatus": { - "base": null, - "refs": { - "DescribeMlflowTrackingServerResponse$TrackingServerMaintenanceStatus": "

The current maintenance status of the described MLflow Tracking Server.

" - } - }, - "TrackingServerName": { - "base": null, - "refs": { - "CreateMlflowTrackingServerRequest$TrackingServerName": "

A unique string identifying the tracking server name. This string is part of the tracking server ARN.

", - "CreatePresignedMlflowTrackingServerUrlRequest$TrackingServerName": "

The name of the tracking server to connect to your MLflow UI.

", - "DeleteMlflowTrackingServerRequest$TrackingServerName": "

The name of the the tracking server to delete.

", - "DescribeMlflowTrackingServerRequest$TrackingServerName": "

The name of the MLflow Tracking Server to describe.

", - "DescribeMlflowTrackingServerResponse$TrackingServerName": "

The name of the described tracking server.

", - "StartMlflowTrackingServerRequest$TrackingServerName": "

The name of the tracking server to start.

", - "StopMlflowTrackingServerRequest$TrackingServerName": "

The name of the tracking server to stop.

", - "TrackingServerSummary$TrackingServerName": "

The name of a listed tracking server.

", - "UpdateMlflowTrackingServerRequest$TrackingServerName": "

The name of the MLflow Tracking Server to update.

" - } - }, - "TrackingServerSize": { - "base": null, - "refs": { - "CreateMlflowTrackingServerRequest$TrackingServerSize": "

The size of the tracking server you want to create. You can choose between \"Small\", \"Medium\", and \"Large\". The default MLflow Tracking Server configuration size is \"Small\". You can choose a size depending on the projected use of the tracking server such as the volume of data logged, number of users, and frequency of use.

We recommend using a small tracking server for teams of up to 25 users, a medium tracking server for teams of up to 50 users, and a large tracking server for teams of up to 100 users.

", - "DescribeMlflowTrackingServerResponse$TrackingServerSize": "

The size of the described tracking server.

", - "UpdateMlflowTrackingServerRequest$TrackingServerSize": "

The new size for the MLflow Tracking Server.

" - } - }, - "TrackingServerStatus": { - "base": null, - "refs": { - "DescribeMlflowTrackingServerResponse$TrackingServerStatus": "

The current creation status of the described MLflow Tracking Server.

", - "ListMlflowTrackingServersRequest$TrackingServerStatus": "

Filter for tracking servers with a specified creation status.

", - "TrackingServerSummary$TrackingServerStatus": "

The creation status of a listed tracking server.

" - } - }, - "TrackingServerSummary": { - "base": "

The summary of the tracking server to list.

", - "refs": { - "TrackingServerSummaryList$member": null - } - }, - "TrackingServerSummaryList": { - "base": null, - "refs": { - "ListMlflowTrackingServersResponse$TrackingServerSummaries": "

A list of tracking servers according to chosen filters.

" - } - }, - "TrackingServerUrl": { - "base": null, - "refs": { - "CreatePresignedMlflowTrackingServerUrlResponse$AuthorizedUrl": "

A presigned URL with an authorization token.

", - "DescribeMlflowTrackingServerResponse$TrackingServerUrl": "

The URL to connect to the MLflow user interface for the described tracking server.

" - } - }, - "TrafficDurationInSeconds": { - "base": null, - "refs": { - "Phase$DurationInSeconds": "

Specifies how long a traffic phase should be. For custom load tests, the value should be between 120 and 3600. This value should not exceed JobDurationInSeconds.

", - "Stairs$DurationInSeconds": "

Defines how long each traffic step should be.

" - } - }, - "TrafficPattern": { - "base": "

Defines the traffic pattern of the load test.

", - "refs": { - "RecommendationJobInputConfig$TrafficPattern": "

Specifies the traffic pattern of the job.

" - } - }, - "TrafficRoutingConfig": { - "base": "

Defines the traffic routing strategy during an endpoint deployment to shift traffic from the old fleet to the new fleet.

", - "refs": { - "BlueGreenUpdatePolicy$TrafficRoutingConfiguration": "

Defines the traffic routing strategy to shift traffic from the old fleet to the new fleet during an endpoint deployment.

" - } - }, - "TrafficRoutingConfigType": { - "base": null, - "refs": { - "TrafficRoutingConfig$Type": "

Traffic routing strategy type.

  • ALL_AT_ONCE: Endpoint traffic shifts to the new fleet in a single step.

  • CANARY: Endpoint traffic shifts to the new fleet in two steps. The first step is the canary, which is a small portion of the traffic. The second step is the remainder of the traffic.

  • LINEAR: Endpoint traffic shifts to the new fleet in n steps of a configurable size.

" - } - }, - "TrafficType": { - "base": null, - "refs": { - "TrafficPattern$TrafficType": "

Defines the traffic patterns. Choose either PHASES or STAIRS.

" - } - }, - "TrainingContainerArgument": { - "base": null, - "refs": { - "TrainingContainerArguments$member": null - } - }, - "TrainingContainerArguments": { - "base": null, - "refs": { - "AlgorithmSpecification$ContainerArguments": "

The arguments for a container used to run a training job. See How Amazon SageMaker Runs Your Training Image for additional information.

" - } - }, - "TrainingContainerEntrypoint": { - "base": null, - "refs": { - "AlgorithmSpecification$ContainerEntrypoint": "

The entrypoint script for a Docker container used to run a training job. This script takes precedence over the default train processing instructions. See How Amazon SageMaker Runs Your Training Image for more information.

" - } - }, - "TrainingContainerEntrypointString": { - "base": null, - "refs": { - "TrainingContainerEntrypoint$member": null - } - }, - "TrainingEnvironmentKey": { - "base": null, - "refs": { - "TrainingEnvironmentMap$key": null - } - }, - "TrainingEnvironmentMap": { - "base": null, - "refs": { - "CreateTrainingJobRequest$Environment": "

The environment variables to set in the Docker container.

Do not include any security-sensitive information including account access IDs, secrets, or tokens in any environment fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request environment variable or plain text fields.

", - "DescribeTrainingJobResponse$Environment": "

The environment variables to set in the Docker container.

Do not include any security-sensitive information including account access IDs, secrets, or tokens in any environment fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request environment variable or plain text fields.

", - "TrainingJob$Environment": "

The environment variables to set in the Docker container.

" - } - }, - "TrainingEnvironmentValue": { - "base": null, - "refs": { - "TrainingEnvironmentMap$value": null - } - }, - "TrainingEpochCount": { - "base": null, - "refs": { - "TrainingProgressInfo$MaxEpoch": "

The maximum number of epochs for this job.

" - } - }, - "TrainingEpochIndex": { - "base": null, - "refs": { - "TrainingProgressInfo$CurrentEpoch": "

The current epoch number.

" - } - }, - "TrainingImageConfig": { - "base": "

The configuration to use an image from a private Docker registry for a training job.

", - "refs": { - "AlgorithmSpecification$TrainingImageConfig": "

The configuration to use an image from a private Docker registry for a training job.

" - } - }, - "TrainingInputMode": { - "base": "

The training input mode that the algorithm supports. For more information about input modes, see Algorithms.

Pipe mode

If an algorithm supports Pipe mode, Amazon SageMaker streams data directly from Amazon S3 to the container.

File mode

If an algorithm supports File mode, SageMaker downloads the training data from S3 to the provisioned ML storage volume, and mounts the directory to the Docker volume for the training container.

You must provision the ML storage volume with sufficient capacity to accommodate the data downloaded from S3. In addition to the training data, the ML storage volume also stores the output model. The algorithm container uses the ML storage volume to also store intermediate information, if any.

For distributed algorithms, training data is distributed uniformly. Your training duration is predictable if the input data objects sizes are approximately the same. SageMaker does not split the files any further for model training. If the object sizes are skewed, training won't be optimal as the data distribution is also skewed when one host in a training cluster is overloaded, thus becoming a bottleneck in training.

FastFile mode

If an algorithm supports FastFile mode, SageMaker streams data directly from S3 to the container with no code changes, and provides file system access to the data. Users can author their training script to interact with these files as if they were stored on disk.

FastFile mode works best when the data is read sequentially. Augmented manifest files aren't supported. The startup time is lower when there are fewer files in the S3 bucket provided.

", - "refs": { - "AlgorithmSpecification$TrainingInputMode": null, - "Channel$InputMode": "

(Optional) The input mode to use for the data channel in a training job. If you don't set a value for InputMode, SageMaker uses the value set for TrainingInputMode. Use this parameter to override the TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode.

To use a model for incremental training, choose File input model.

", - "HyperParameterAlgorithmSpecification$TrainingInputMode": null, - "InputModes$member": null, - "TrainingJobDefinition$TrainingInputMode": null - } - }, - "TrainingInstanceCount": { - "base": null, - "refs": { - "HyperParameterTuningInstanceConfig$InstanceCount": "

The number of instances of the type specified by InstanceType. Choose an instance count larger than 1 for distributed training algorithms. See Step 2: Launch a SageMaker Distributed Training Job Using the SageMaker Python SDK for more information.

", - "HyperParameterTuningResourceConfig$InstanceCount": "

The number of compute instances of type InstanceType to use. For distributed training, select a value greater than 1.

", - "InstanceGroup$InstanceCount": "

Specifies the number of instances of the instance group.

", - "PlacementSpecification$InstanceCount": "

The number of ML compute instances required to be placed together on the same UltraServer. Minimum value of 1.

", - "ResourceConfig$InstanceCount": "

The number of ML compute instances to use. For distributed training, provide a value greater than 1.

" - } - }, - "TrainingInstanceType": { - "base": null, - "refs": { - "HyperParameterTuningInstanceConfig$InstanceType": "

The instance type used for processing of hyperparameter optimization jobs. Choose from general purpose (no GPUs) instance types: ml.m5.xlarge, ml.m5.2xlarge, and ml.m5.4xlarge or compute optimized (no GPUs) instance types: ml.c5.xlarge and ml.c5.2xlarge. For more information about instance types, see instance type descriptions.

", - "HyperParameterTuningResourceConfig$InstanceType": "

The instance type used to run hyperparameter optimization tuning jobs. See descriptions of instance types for more information.

", - "InstanceGroup$InstanceType": "

Specifies the instance type of the instance group.

", - "ResourceConfig$InstanceType": "

The ML compute instance type.

", - "TrainingInstanceTypes$member": null - } - }, - "TrainingInstanceTypes": { - "base": null, - "refs": { - "TrainingSpecification$SupportedTrainingInstanceTypes": "

A list of the instance types that this algorithm can use for training.

" - } - }, - "TrainingJob": { - "base": "

Contains information about a training job.

", - "refs": { - "SearchRecord$TrainingJob": "

The properties of a training job.

", - "TrialComponentSourceDetail$TrainingJob": "

Information about a training job that's the source of a trial component.

" - } - }, - "TrainingJobArn": { - "base": null, - "refs": { - "CreateTrainingJobResponse$TrainingJobArn": "

The Amazon Resource Name (ARN) of the training job.

", - "DescribeProcessingJobResponse$TrainingJobArn": "

The ARN of a training job associated with this processing job.

", - "DescribeTrainingJobResponse$TrainingJobArn": "

The Amazon Resource Name (ARN) of the training job.

", - "HyperParameterTrainingJobSummary$TrainingJobArn": "

The Amazon Resource Name (ARN) of the training job.

", - "ProcessingJob$TrainingJobArn": "

The ARN of the training job associated with this processing job.

", - "TrainingJob$TrainingJobArn": "

The Amazon Resource Name (ARN) of the training job.

", - "TrainingJobStepMetadata$Arn": "

The Amazon Resource Name (ARN) of the training job that was run by this step execution.

", - "TrainingJobSummary$TrainingJobArn": "

The Amazon Resource Name (ARN) of the training job.

", - "UpdateTrainingJobResponse$TrainingJobArn": "

The Amazon Resource Name (ARN) of the training job.

" - } - }, - "TrainingJobDefinition": { - "base": "

Defines the input needed to run a training job using the algorithm.

", - "refs": { - "AlgorithmValidationProfile$TrainingJobDefinition": "

The TrainingJobDefinition object that describes the training job that SageMaker runs to validate your algorithm.

" - } - }, - "TrainingJobEarlyStoppingType": { - "base": null, - "refs": { - "HyperParameterTuningJobConfig$TrainingJobEarlyStoppingType": "

Specifies whether to use early stopping for training jobs launched by the hyperparameter tuning job. Because the Hyperband strategy has its own advanced internal early stopping mechanism, TrainingJobEarlyStoppingType must be OFF to use Hyperband. This parameter can take on one of the following values (the default value is OFF):

OFF

Training jobs launched by the hyperparameter tuning job do not use early stopping.

AUTO

SageMaker stops training jobs launched by the hyperparameter tuning job when they are unlikely to perform better than previously completed training jobs. For more information, see Stop Training Jobs Early.

" - } - }, - "TrainingJobName": { - "base": null, - "refs": { - "CreateTrainingJobRequest$TrainingJobName": "

The name of the training job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

", - "DeleteTrainingJobRequest$TrainingJobName": "

The name of the training job to delete.

", - "DescribeTrainingJobRequest$TrainingJobName": "

The name of the training job.

", - "DescribeTrainingJobResponse$TrainingJobName": "

Name of the model training job.

", - "HyperParameterTrainingJobSummary$TrainingJobName": "

The name of the training job.

", - "StopTrainingJobRequest$TrainingJobName": "

The name of the training job to stop.

", - "TrainingJob$TrainingJobName": "

The name of the training job.

", - "TrainingJobSummary$TrainingJobName": "

The name of the training job that you want a summary for.

", - "UpdateTrainingJobRequest$TrainingJobName": "

The name of a training job to update the Debugger profiling configuration.

", - "WarmPoolStatus$ReusedByJob": "

The name of the matching training job that reused the warm pool.

" - } - }, - "TrainingJobSortByOptions": { - "base": null, - "refs": { - "ListTrainingJobsForHyperParameterTuningJobRequest$SortBy": "

The field to sort results by. The default is Name.

If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an objective metric are not listed.

" - } - }, - "TrainingJobStatus": { - "base": null, - "refs": { - "DescribeTrainingJobResponse$TrainingJobStatus": "

The status of the training job.

SageMaker provides the following training job statuses:

  • InProgress - The training is in progress.

  • Completed - The training job has completed.

  • Failed - The training job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTrainingJobResponse call.

  • Stopping - The training job is stopping.

  • Stopped - The training job has stopped.

For more detailed information, see SecondaryStatus.

", - "HyperParameterTrainingJobSummary$TrainingJobStatus": "

The status of the training job.

", - "ListTrainingJobsForHyperParameterTuningJobRequest$StatusEquals": "

A filter that returns only training jobs with the specified status.

", - "ListTrainingJobsRequest$StatusEquals": "

A filter that retrieves only training jobs with a specific status.

", - "TrainingJob$TrainingJobStatus": "

The status of the training job.

Training job statuses are:

  • InProgress - The training is in progress.

  • Completed - The training job has completed.

  • Failed - The training job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTrainingJobResponse call.

  • Stopping - The training job is stopping.

  • Stopped - The training job has stopped.

For more detailed information, see SecondaryStatus.

", - "TrainingJobSummary$TrainingJobStatus": "

The status of the training job.

" - } - }, - "TrainingJobStatusCounter": { - "base": null, - "refs": { - "TrainingJobStatusCounters$Completed": "

The number of completed training jobs launched by the hyperparameter tuning job.

", - "TrainingJobStatusCounters$InProgress": "

The number of in-progress training jobs launched by a hyperparameter tuning job.

", - "TrainingJobStatusCounters$RetryableError": "

The number of training jobs that failed, but can be retried. A failed training job can be retried only if it failed because an internal service error occurred.

", - "TrainingJobStatusCounters$NonRetryableError": "

The number of training jobs that failed and can't be retried. A failed training job can't be retried if it failed because a client error occurred.

", - "TrainingJobStatusCounters$Stopped": "

The number of training jobs launched by a hyperparameter tuning job that were manually stopped.

" - } - }, - "TrainingJobStatusCounters": { - "base": "

The numbers of training jobs launched by a hyperparameter tuning job, categorized by status.

", - "refs": { - "DescribeHyperParameterTuningJobResponse$TrainingJobStatusCounters": "

The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.

", - "HyperParameterTuningJobSearchEntity$TrainingJobStatusCounters": null, - "HyperParameterTuningJobSummary$TrainingJobStatusCounters": "

The TrainingJobStatusCounters object that specifies the numbers of training jobs, categorized by status, that this tuning job launched.

" - } - }, - "TrainingJobStepMetadata": { - "base": "

Metadata for a training job step.

", - "refs": { - "PipelineExecutionStepMetadata$TrainingJob": "

The Amazon Resource Name (ARN) of the training job that was run by this step execution.

" - } - }, - "TrainingJobSummaries": { - "base": null, - "refs": { - "ListTrainingJobsResponse$TrainingJobSummaries": "

An array of TrainingJobSummary objects, each listing a training job.

" - } - }, - "TrainingJobSummary": { - "base": "

Provides summary information about a training job.

", - "refs": { - "TrainingJobSummaries$member": null - } - }, - "TrainingPlanArn": { - "base": null, - "refs": { - "ClusterInstanceGroupDetails$TrainingPlanArn": "

The Amazon Resource Name (ARN); of the training plan associated with this cluster instance group.

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

", - "ClusterInstanceGroupSpecification$TrainingPlanArn": "

The Amazon Resource Name (ARN); of the training plan to use for this cluster instance group.

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

", - "ClusterRestrictedInstanceGroupDetails$TrainingPlanArn": "

The Amazon Resource Name (ARN) of the training plan to filter clusters by. For more information about reserving GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

", - "ClusterRestrictedInstanceGroupSpecification$TrainingPlanArn": "

The Amazon Resource Name (ARN) of the training plan to filter clusters by. For more information about reserving GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

", - "CreateTrainingPlanResponse$TrainingPlanArn": "

The Amazon Resource Name (ARN); of the created training plan.

", - "DescribeTrainingPlanExtensionHistoryRequest$TrainingPlanArn": "

The Amazon Resource Name (ARN); of the training plan to retrieve extension history for.

", - "DescribeTrainingPlanResponse$TrainingPlanArn": "

The Amazon Resource Name (ARN); of the training plan.

", - "ListClustersRequest$TrainingPlanArn": "

The Amazon Resource Name (ARN); of the training plan to filter clusters by. For more information about reserving GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

", - "ListTrainingJobsRequest$TrainingPlanArnEquals": "

The Amazon Resource Name (ARN); of the training plan to filter training jobs by. For more information about reserving GPU capacity for your SageMaker training jobs using Amazon SageMaker Training Plan, see CreateTrainingPlan .

", - "OptimizationJobTrainingPlanArns$member": null, - "ResourceConfig$TrainingPlanArn": "

The Amazon Resource Name (ARN); of the training plan to use for this resource configuration.

", - "TrainingJobSummary$TrainingPlanArn": "

The Amazon Resource Name (ARN); of the training plan associated with this training job.

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

", - "TrainingPlanArns$member": null, - "TrainingPlanSummary$TrainingPlanArn": "

The Amazon Resource Name (ARN); of the training plan.

" - } - }, - "TrainingPlanArns": { - "base": null, - "refs": { - "ClusterSummary$TrainingPlanArns": "

A list of Amazon Resource Names (ARNs) of the training plans associated with this cluster.

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

" - } - }, - "TrainingPlanDurationHours": { - "base": null, - "refs": { - "DescribeTrainingPlanResponse$DurationHours": "

The number of whole hours in the total duration for this training plan.

", - "TrainingPlanOffering$DurationHours": "

The number of whole hours in the total duration for this training plan offering.

", - "TrainingPlanSummary$DurationHours": "

The number of whole hours in the total duration for this training plan.

" - } - }, - "TrainingPlanDurationHoursInput": { - "base": null, - "refs": { - "SearchTrainingPlanOfferingsRequest$DurationHours": "

The desired duration in hours for the training plan offerings.

" - } - }, - "TrainingPlanDurationMinutes": { - "base": null, - "refs": { - "DescribeTrainingPlanResponse$DurationMinutes": "

The additional minutes beyond whole hours in the total duration for this training plan.

", - "TrainingPlanOffering$DurationMinutes": "

The additional minutes beyond whole hours in the total duration for this training plan offering.

", - "TrainingPlanSummary$DurationMinutes": "

The additional minutes beyond whole hours in the total duration for this training plan.

" - } - }, - "TrainingPlanExtension": { - "base": "

Details about an extension to a training plan, including the offering ID, dates, status, and cost information.

", - "refs": { - "TrainingPlanExtensions$member": null - } - }, - "TrainingPlanExtensionDurationHours": { - "base": null, - "refs": { - "TrainingPlanExtension$DurationHours": "

The duration of the extension in hours.

", - "TrainingPlanExtensionOffering$DurationHours": "

The duration of this extension offering in hours.

" - } - }, - "TrainingPlanExtensionOffering": { - "base": "

Details about an available extension offering for a training plan. Use the offering ID with the ExtendTrainingPlan API to extend a training plan.

", - "refs": { - "TrainingPlanExtensionOfferings$member": null - } - }, - "TrainingPlanExtensionOfferingId": { - "base": null, - "refs": { - "ExtendTrainingPlanRequest$TrainingPlanExtensionOfferingId": "

The unique identifier of the extension offering to purchase. You can retrieve this ID from the TrainingPlanExtensionOfferings in the response of the SearchTrainingPlanOfferings API.

", - "TrainingPlanExtension$TrainingPlanExtensionOfferingId": "

The unique identifier of the extension offering that was used to create this extension.

", - "TrainingPlanExtensionOffering$TrainingPlanExtensionOfferingId": "

The unique identifier for this extension offering.

" - } - }, - "TrainingPlanExtensionOfferings": { - "base": null, - "refs": { - "SearchTrainingPlanOfferingsResponse$TrainingPlanExtensionOfferings": "

A list of extension offerings available for the specified training plan. These offerings can be used with the ExtendTrainingPlan API to extend an existing training plan.

" - } - }, - "TrainingPlanExtensions": { - "base": null, - "refs": { - "DescribeTrainingPlanExtensionHistoryResponse$TrainingPlanExtensions": "

A list of extensions for the specified training plan.

", - "ExtendTrainingPlanResponse$TrainingPlanExtensions": "

The list of extensions for the training plan, including the newly created extension.

" - } - }, - "TrainingPlanFilter": { - "base": "

A filter to apply when listing or searching for training plans.

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

", - "refs": { - "TrainingPlanFilters$member": null - } - }, - "TrainingPlanFilterName": { - "base": null, - "refs": { - "TrainingPlanFilter$Name": "

The name of the filter field (e.g., Status, InstanceType).

" - } - }, - "TrainingPlanFilters": { - "base": null, - "refs": { - "ListTrainingPlansRequest$Filters": "

Additional filters to apply to the list of training plans.

" - } - }, - "TrainingPlanName": { - "base": null, - "refs": { - "CreateTrainingPlanRequest$TrainingPlanName": "

The name of the training plan to create.

", - "DescribeTrainingPlanRequest$TrainingPlanName": "

The name of the training plan to describe.

", - "DescribeTrainingPlanResponse$TrainingPlanName": "

The name of the training plan.

", - "TrainingPlanSummary$TrainingPlanName": "

The name of the training plan.

" - } - }, - "TrainingPlanOffering": { - "base": "

Details about a training plan offering.

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

", - "refs": { - "TrainingPlanOfferings$member": null - } - }, - "TrainingPlanOfferingId": { - "base": null, - "refs": { - "CreateTrainingPlanRequest$TrainingPlanOfferingId": "

The unique identifier of the training plan offering to use for creating this plan.

", - "TrainingPlanOffering$TrainingPlanOfferingId": "

The unique identifier for this training plan offering.

" - } - }, - "TrainingPlanOfferings": { - "base": null, - "refs": { - "SearchTrainingPlanOfferingsResponse$TrainingPlanOfferings": "

A list of training plan offerings that match the search criteria.

" - } - }, - "TrainingPlanSortBy": { - "base": null, - "refs": { - "ListTrainingPlansRequest$SortBy": "

The training plan field to sort the results by (e.g., StartTime, Status).

" - } - }, - "TrainingPlanSortOrder": { - "base": null, - "refs": { - "ListTrainingPlansRequest$SortOrder": "

The order to sort the results (Ascending or Descending).

" - } - }, - "TrainingPlanStatus": { - "base": null, - "refs": { - "DescribeTrainingPlanResponse$Status": "

The current status of the training plan (e.g., Pending, Active, Expired). To see the complete list of status values available for a training plan, refer to the Status attribute within the TrainingPlanSummary object.

", - "TrainingPlanSummary$Status": "

The current status of the training plan (e.g., Pending, Active, Expired). To see the complete list of status values available for a training plan, refer to the Status attribute within the TrainingPlanSummary object.

" - } - }, - "TrainingPlanStatusMessage": { - "base": null, - "refs": { - "DescribeTrainingPlanResponse$StatusMessage": "

A message providing additional information about the current status of the training plan.

", - "TrainingPlanSummary$StatusMessage": "

A message providing additional information about the current status of the training plan.

" - } - }, - "TrainingPlanSummaries": { - "base": null, - "refs": { - "ListTrainingPlansResponse$TrainingPlanSummaries": "

A list of summary information for the training plans.

" - } - }, - "TrainingPlanSummary": { - "base": "

Details of the training plan.

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

", - "refs": { - "TrainingPlanSummaries$member": null - } - }, - "TrainingProgressInfo": { - "base": "

The serverless training job progress information.

", - "refs": { - "DescribeTrainingJobResponse$ProgressInfo": "

The Serverless training job progress information.

" - } - }, - "TrainingRepositoryAccessMode": { - "base": null, - "refs": { - "TrainingImageConfig$TrainingRepositoryAccessMode": "

The method that your training job will use to gain access to the images in your private Docker registry. For access to an image in a private Docker registry, set to Vpc.

" - } - }, - "TrainingRepositoryAuthConfig": { - "base": "

An object containing authentication information for a private Docker registry.

", - "refs": { - "TrainingImageConfig$TrainingRepositoryAuthConfig": "

An object containing authentication information for a private Docker registry containing your training images.

" - } - }, - "TrainingRepositoryCredentialsProviderArn": { - "base": null, - "refs": { - "TrainingRepositoryAuthConfig$TrainingRepositoryCredentialsProviderArn": "

The Amazon Resource Name (ARN) of an Amazon Web Services Lambda function used to give SageMaker access credentials to your private Docker registry.

" - } - }, - "TrainingSpecification": { - "base": "

Defines how the algorithm is used for a training job.

", - "refs": { - "CreateAlgorithmInput$TrainingSpecification": "

Specifies details about training jobs run by this algorithm, including the following:

  • The Amazon ECR path of the container and the version digest of the algorithm.

  • The hyperparameters that the algorithm supports.

  • The instance types that the algorithm supports for training.

  • Whether the algorithm supports distributed training.

  • The metrics that the algorithm emits to Amazon CloudWatch.

  • Which metrics that the algorithm emits can be used as the objective metric for hyperparameter tuning jobs.

  • The input channels that the algorithm supports for training data. For example, an algorithm might support train, validation, and test channels.

", - "DescribeAlgorithmOutput$TrainingSpecification": "

Details about training jobs run by this algorithm.

" - } - }, - "TrainingStepIndex": { - "base": null, - "refs": { - "TrainingProgressInfo$CurrentStep": "

The current step number.

" - } - }, - "TrainingTimeInSeconds": { - "base": null, - "refs": { - "DescribeTrainingJobResponse$TrainingTimeInSeconds": "

The training time in seconds.

", - "TrainingJob$TrainingTimeInSeconds": "

The training time in seconds.

" - } - }, - "TransformAmiVersion": { - "base": null, - "refs": { - "TransformResources$TransformAmiVersion": "

Specifies an option from a collection of preconfigured Amazon Machine Image (AMI) images. Each image is configured by Amazon Web Services with a set of software and driver versions.

al2-ami-sagemaker-batch-gpu-470

  • Accelerator: GPU

  • NVIDIA driver version: 470

al2-ami-sagemaker-batch-gpu-535

  • Accelerator: GPU

  • NVIDIA driver version: 535

" - } - }, - "TransformDataSource": { - "base": "

Describes the location of the channel data.

", - "refs": { - "TransformInput$DataSource": "

Describes the location of the channel data, which is, the S3 location of the input data that the model can consume.

" - } - }, - "TransformEnvironmentKey": { - "base": null, - "refs": { - "TransformEnvironmentMap$key": null - } - }, - "TransformEnvironmentMap": { - "base": null, - "refs": { - "CreateTransformJobRequest$Environment": "

The environment variables to set in the Docker container. Don't include any sensitive data in your environment variables. We support up to 16 key and values entries in the map.

", - "DescribeTransformJobResponse$Environment": "

The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

", - "TransformJob$Environment": "

The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

", - "TransformJobDefinition$Environment": "

The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

" - } - }, - "TransformEnvironmentValue": { - "base": null, - "refs": { - "TransformEnvironmentMap$value": null - } - }, - "TransformInput": { - "base": "

Describes the input source of a transform job and the way the transform job consumes it.

", - "refs": { - "CreateTransformJobRequest$TransformInput": "

Describes the input source and the way the transform job consumes it.

", - "DescribeTransformJobResponse$TransformInput": "

Describes the dataset to be transformed and the Amazon S3 location where it is stored.

", - "TransformJob$TransformInput": null, - "TransformJobDefinition$TransformInput": "

A description of the input source and the way the transform job consumes it.

" - } - }, - "TransformInstanceCount": { - "base": null, - "refs": { - "TransformResources$InstanceCount": "

The number of ML compute instances to use in the transform job. The default value is 1, and the maximum is 100. For distributed transform jobs, specify a value greater than 1.

" - } - }, - "TransformInstanceType": { - "base": null, - "refs": { - "TransformInstanceTypes$member": null, - "TransformResources$InstanceType": "

The ML compute instance type for the transform job. If you are using built-in algorithms to transform moderately sized datasets, we recommend using ml.m4.xlarge or ml.m5.largeinstance types.

" - } - }, - "TransformInstanceTypes": { - "base": null, - "refs": { - "AdditionalInferenceSpecificationDefinition$SupportedTransformInstanceTypes": "

A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.

", - "InferenceSpecification$SupportedTransformInstanceTypes": "

A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.

This parameter is required for unversioned models, and optional for versioned models.

" - } - }, - "TransformJob": { - "base": "

A batch transform job. For information about SageMaker batch transform, see Use Batch Transform.

", - "refs": { - "ModelDashboardModel$LastBatchTransformJob": null, - "TrialComponentSourceDetail$TransformJob": "

Information about a transform job that's the source of a trial component.

" - } - }, - "TransformJobArn": { - "base": null, - "refs": { - "CreateTransformJobResponse$TransformJobArn": "

The Amazon Resource Name (ARN) of the transform job.

", - "DescribeTransformJobResponse$TransformJobArn": "

The Amazon Resource Name (ARN) of the transform job.

", - "TransformJob$TransformJobArn": "

The Amazon Resource Name (ARN) of the transform job.

", - "TransformJobStepMetadata$Arn": "

The Amazon Resource Name (ARN) of the transform job that was run by this step execution.

", - "TransformJobSummary$TransformJobArn": "

The Amazon Resource Name (ARN) of the transform job.

" - } - }, - "TransformJobDefinition": { - "base": "

Defines the input needed to run a transform job using the inference specification specified in the algorithm.

", - "refs": { - "AlgorithmValidationProfile$TransformJobDefinition": "

The TransformJobDefinition object that describes the transform job that SageMaker runs to validate your algorithm.

", - "ModelPackageValidationProfile$TransformJobDefinition": "

The TransformJobDefinition object that describes the transform job used for the validation of the model package.

" - } - }, - "TransformJobName": { - "base": null, - "refs": { - "CreateTransformJobRequest$TransformJobName": "

The name of the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

", - "DescribeTransformJobRequest$TransformJobName": "

The name of the transform job that you want to view details of.

", - "DescribeTransformJobResponse$TransformJobName": "

The name of the transform job.

", - "StopTransformJobRequest$TransformJobName": "

The name of the batch transform job to stop.

", - "TransformJob$TransformJobName": "

The name of the transform job.

", - "TransformJobSummary$TransformJobName": "

The name of the transform job.

" - } - }, - "TransformJobStatus": { - "base": null, - "refs": { - "DescribeTransformJobResponse$TransformJobStatus": "

The status of the transform job. If the transform job failed, the reason is returned in the FailureReason field.

", - "ListTransformJobsRequest$StatusEquals": "

A filter that retrieves only transform jobs with a specific status.

", - "TransformJob$TransformJobStatus": "

The status of the transform job.

Transform job statuses are:

  • InProgress - The job is in progress.

  • Completed - The job has completed.

  • Failed - The transform job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTransformJob call.

  • Stopping - The transform job is stopping.

  • Stopped - The transform job has stopped.

", - "TransformJobSummary$TransformJobStatus": "

The status of the transform job.

" - } - }, - "TransformJobStepMetadata": { - "base": "

Metadata for a transform job step.

", - "refs": { - "PipelineExecutionStepMetadata$TransformJob": "

The Amazon Resource Name (ARN) of the transform job that was run by this step execution.

" - } - }, - "TransformJobSummaries": { - "base": null, - "refs": { - "ListTransformJobsResponse$TransformJobSummaries": "

An array of TransformJobSummary objects.

" - } - }, - "TransformJobSummary": { - "base": "

Provides a summary of a transform job. Multiple TransformJobSummary objects are returned as a list after in response to a ListTransformJobs call.

", - "refs": { - "TransformJobSummaries$member": null - } - }, - "TransformOutput": { - "base": "

Describes the results of a transform job.

", - "refs": { - "CreateTransformJobRequest$TransformOutput": "

Describes the results of the transform job.

", - "DescribeTransformJobResponse$TransformOutput": "

Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

", - "TransformJob$TransformOutput": null, - "TransformJobDefinition$TransformOutput": "

Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

" - } - }, - "TransformResources": { - "base": "

Describes the resources, including ML instance types and ML instance count, to use for transform job.

", - "refs": { - "CreateTransformJobRequest$TransformResources": "

Describes the resources, including ML instance types and ML instance count, to use for the transform job.

", - "DescribeTransformJobResponse$TransformResources": "

Describes the resources, including ML instance types and ML instance count, to use for the transform job.

", - "TransformJob$TransformResources": null, - "TransformJobDefinition$TransformResources": "

Identifies the ML compute instances for the transform job.

" - } - }, - "TransformS3DataSource": { - "base": "

Describes the S3 data source.

", - "refs": { - "TransformDataSource$S3DataSource": "

The S3 location of the data source that is associated with a channel.

" - } - }, - "TransformationAttributeName": { - "base": null, - "refs": { - "AggregationTransformations$key": null, - "FillingTransformations$key": null - } - }, - "Trial": { - "base": "

The properties of a trial as returned by the Search API.

", - "refs": { - "SearchRecord$Trial": "

The properties of a trial.

" - } - }, - "TrialArn": { - "base": null, - "refs": { - "AssociateTrialComponentResponse$TrialArn": "

The Amazon Resource Name (ARN) of the trial.

", - "CreateTrialResponse$TrialArn": "

The Amazon Resource Name (ARN) of the trial.

", - "DeleteTrialResponse$TrialArn": "

The Amazon Resource Name (ARN) of the trial that is being deleted.

", - "DescribeTrialResponse$TrialArn": "

The Amazon Resource Name (ARN) of the trial.

", - "DisassociateTrialComponentResponse$TrialArn": "

The Amazon Resource Name (ARN) of the trial.

", - "Trial$TrialArn": "

The Amazon Resource Name (ARN) of the trial.

", - "TrialSummary$TrialArn": "

The Amazon Resource Name (ARN) of the trial.

", - "UpdateTrialResponse$TrialArn": "

The Amazon Resource Name (ARN) of the trial.

" - } - }, - "TrialComponent": { - "base": "

The properties of a trial component as returned by the Search API.

", - "refs": { - "SearchRecord$TrialComponent": "

The properties of a trial component.

" - } - }, - "TrialComponentArn": { - "base": null, - "refs": { - "AssociateTrialComponentResponse$TrialComponentArn": "

The Amazon Resource Name (ARN) of the trial component.

", - "CreateTrialComponentResponse$TrialComponentArn": "

The Amazon Resource Name (ARN) of the trial component.

", - "DeleteTrialComponentResponse$TrialComponentArn": "

The Amazon Resource Name (ARN) of the component is being deleted.

", - "DescribeTrialComponentResponse$TrialComponentArn": "

The Amazon Resource Name (ARN) of the trial component.

", - "DisassociateTrialComponentResponse$TrialComponentArn": "

The Amazon Resource Name (ARN) of the trial component.

", - "TrialComponent$TrialComponentArn": "

The Amazon Resource Name (ARN) of the trial component.

", - "TrialComponentSimpleSummary$TrialComponentArn": "

The Amazon Resource Name (ARN) of the trial component.

", - "TrialComponentSummary$TrialComponentArn": "

The Amazon Resource Name (ARN) of the trial component.

", - "UpdateTrialComponentResponse$TrialComponentArn": "

The Amazon Resource Name (ARN) of the trial component.

" - } - }, - "TrialComponentArtifact": { - "base": "

Represents an input or output artifact of a trial component. You specify TrialComponentArtifact as part of the InputArtifacts and OutputArtifacts parameters in the CreateTrialComponent request.

Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types. Examples of output artifacts are metrics, snapshots, logs, and images.

", - "refs": { - "TrialComponentArtifacts$value": null - } - }, - "TrialComponentArtifactValue": { - "base": null, - "refs": { - "TrialComponentArtifact$Value": "

The location of the artifact.

" - } - }, - "TrialComponentArtifacts": { - "base": null, - "refs": { - "CreateTrialComponentRequest$InputArtifacts": "

The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.

", - "CreateTrialComponentRequest$OutputArtifacts": "

The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.

", - "DescribeTrialComponentResponse$InputArtifacts": "

The input artifacts of the component.

", - "DescribeTrialComponentResponse$OutputArtifacts": "

The output artifacts of the component.

", - "TrialComponent$InputArtifacts": "

The input artifacts of the component.

", - "TrialComponent$OutputArtifacts": "

The output artifacts of the component.

", - "UpdateTrialComponentRequest$InputArtifacts": "

Replaces all of the component's input artifacts with the specified artifacts or adds new input artifacts. Existing input artifacts are replaced if the trial component is updated with an identical input artifact key.

", - "UpdateTrialComponentRequest$OutputArtifacts": "

Replaces all of the component's output artifacts with the specified artifacts or adds new output artifacts. Existing output artifacts are replaced if the trial component is updated with an identical output artifact key.

" - } - }, - "TrialComponentKey128": { - "base": null, - "refs": { - "TrialComponentArtifacts$key": null - } - }, - "TrialComponentKey256": { - "base": null, - "refs": { - "ListTrialComponentKey256$member": null - } - }, - "TrialComponentKey320": { - "base": null, - "refs": { - "TrialComponentParameters$key": null - } - }, - "TrialComponentMetricSummaries": { - "base": null, - "refs": { - "DescribeTrialComponentResponse$Metrics": "

The metrics for the component.

", - "TrialComponent$Metrics": "

The metrics for the component.

" - } - }, - "TrialComponentMetricSummary": { - "base": "

A summary of the metrics of a trial component.

", - "refs": { - "TrialComponentMetricSummaries$member": null - } - }, - "TrialComponentParameterValue": { - "base": "

The value of a hyperparameter. Only one of NumberValue or StringValue can be specified.

This object is specified in the CreateTrialComponent request.

", - "refs": { - "TrialComponentParameters$value": null - } - }, - "TrialComponentParameters": { - "base": null, - "refs": { - "CreateTrialComponentRequest$Parameters": "

The hyperparameters for the component.

", - "DescribeTrialComponentResponse$Parameters": "

The hyperparameters of the component.

", - "TrialComponent$Parameters": "

The hyperparameters of the component.

", - "UpdateTrialComponentRequest$Parameters": "

Replaces all of the component's hyperparameters with the specified hyperparameters or add new hyperparameters. Existing hyperparameters are replaced if the trial component is updated with an identical hyperparameter key.

" - } - }, - "TrialComponentPrimaryStatus": { - "base": null, - "refs": { - "TrialComponentStatus$PrimaryStatus": "

The status of the trial component.

" - } - }, - "TrialComponentSimpleSummaries": { - "base": null, - "refs": { - "Trial$TrialComponentSummaries": "

A list of the components associated with the trial. For each component, a summary of the component's properties is included.

" - } - }, - "TrialComponentSimpleSummary": { - "base": "

A short summary of a trial component.

", - "refs": { - "TrialComponentSimpleSummaries$member": null - } - }, - "TrialComponentSource": { - "base": "

The Amazon Resource Name (ARN) and job type of the source of a trial component.

", - "refs": { - "DescribeTrialComponentResponse$Source": "

The Amazon Resource Name (ARN) of the source and, optionally, the job type.

", - "TrialComponent$Source": "

The Amazon Resource Name (ARN) and job type of the source of the component.

", - "TrialComponentSimpleSummary$TrialComponentSource": null, - "TrialComponentSources$member": null, - "TrialComponentSummary$TrialComponentSource": null - } - }, - "TrialComponentSourceArn": { - "base": null, - "refs": { - "TrialComponentMetricSummary$SourceArn": "

The Amazon Resource Name (ARN) of the source.

", - "TrialComponentSource$SourceArn": "

The source Amazon Resource Name (ARN).

", - "TrialComponentSourceDetail$SourceArn": "

The Amazon Resource Name (ARN) of the source.

" - } - }, - "TrialComponentSourceDetail": { - "base": "

Detailed information about the source of a trial component. Either ProcessingJob or TrainingJob is returned.

", - "refs": { - "TrialComponent$SourceDetail": "

Details of the source of the component.

" - } - }, - "TrialComponentSources": { - "base": null, - "refs": { - "DescribeTrialComponentResponse$Sources": "

A list of ARNs and, if applicable, job types for multiple sources of an experiment run.

" - } - }, - "TrialComponentStatus": { - "base": "

The status of the trial component.

", - "refs": { - "CreateTrialComponentRequest$Status": "

The status of the component. States include:

  • InProgress

  • Completed

  • Failed

", - "DescribeTrialComponentResponse$Status": "

The status of the component. States include:

  • InProgress

  • Completed

  • Failed

", - "TrialComponent$Status": null, - "TrialComponentSummary$Status": "

The status of the component. States include:

  • InProgress

  • Completed

  • Failed

", - "UpdateTrialComponentRequest$Status": "

The new status of the component.

" - } - }, - "TrialComponentStatusMessage": { - "base": null, - "refs": { - "TrialComponentStatus$Message": "

If the component failed, a message describing why.

" - } - }, - "TrialComponentSummaries": { - "base": null, - "refs": { - "ListTrialComponentsResponse$TrialComponentSummaries": "

A list of the summaries of your trial components.

" - } - }, - "TrialComponentSummary": { - "base": "

A summary of the properties of a trial component. To get all the properties, call the DescribeTrialComponent API and provide the TrialComponentName.

", - "refs": { - "TrialComponentSummaries$member": null - } - }, - "TrialSource": { - "base": "

The source of the trial.

", - "refs": { - "DescribeTrialResponse$Source": "

The Amazon Resource Name (ARN) of the source and, optionally, the job type.

", - "Trial$Source": null, - "TrialSummary$TrialSource": null - } - }, - "TrialSourceArn": { - "base": null, - "refs": { - "TrialSource$SourceArn": "

The Amazon Resource Name (ARN) of the source.

" - } - }, - "TrialSummaries": { - "base": null, - "refs": { - "ListTrialsResponse$TrialSummaries": "

A list of the summaries of your trials.

" - } - }, - "TrialSummary": { - "base": "

A summary of the properties of a trial. To get the complete set of properties, call the DescribeTrial API and provide the TrialName.

", - "refs": { - "TrialSummaries$member": null - } - }, - "TrustedIdentityPropagationSettings": { - "base": "

The Trusted Identity Propagation (TIP) settings for the SageMaker domain. These settings determine how user identities from IAM Identity Center are propagated through the domain to TIP enabled Amazon Web Services services.

", - "refs": { - "DomainSettings$TrustedIdentityPropagationSettings": "

The Trusted Identity Propagation (TIP) settings for the SageMaker domain. These settings determine how user identities from IAM Identity Center are propagated through the domain to TIP enabled Amazon Web Services services.

", - "DomainSettingsForUpdate$TrustedIdentityPropagationSettings": "

The Trusted Identity Propagation (TIP) settings for the SageMaker domain. These settings determine how user identities from IAM Identity Center are propagated through the domain to TIP enabled Amazon Web Services services.

" - } - }, - "TtlDuration": { - "base": "

Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration. For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

", - "refs": { - "OnlineStoreConfig$TtlDuration": "

Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration. For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

", - "OnlineStoreConfigUpdate$TtlDuration": "

Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration. For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

" - } - }, - "TtlDurationUnit": { - "base": null, - "refs": { - "TtlDuration$Unit": "

TtlDuration time unit.

" - } - }, - "TtlDurationValue": { - "base": null, - "refs": { - "TtlDuration$Value": "

TtlDuration time value.

" - } - }, - "TuningJobCompletionCriteria": { - "base": "

The job completion criteria.

", - "refs": { - "HyperParameterTuningJobConfig$TuningJobCompletionCriteria": "

The tuning job's completion criteria.

" - } - }, - "TuningJobStepMetaData": { - "base": "

Metadata for a tuning step.

", - "refs": { - "PipelineExecutionStepMetadata$TuningJob": "

The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.

" - } - }, - "USD": { - "base": "

Represents an amount of money in United States dollars.

", - "refs": { - "PublicWorkforceTaskPrice$AmountInUsd": "

Defines the amount of money paid to an Amazon Mechanical Turk worker in United States dollars.

" - } - }, - "UiConfig": { - "base": "

Provided configuration information for the worker UI for a labeling job. Provide either HumanTaskUiArn or UiTemplateS3Uri.

For named entity recognition, 3D point cloud and video frame labeling jobs, use HumanTaskUiArn.

For all other Ground Truth built-in task types and custom task types, use UiTemplateS3Uri to specify the location of a worker task template in Amazon S3.

", - "refs": { - "HumanTaskConfig$UiConfig": "

Information about the user interface that workers use to complete the labeling task.

" - } - }, - "UiTemplate": { - "base": "

The Liquid template for the worker user interface.

", - "refs": { - "CreateHumanTaskUiRequest$UiTemplate": null, - "RenderUiTemplateRequest$UiTemplate": "

A Template object containing the worker UI template to render.

" - } - }, - "UiTemplateInfo": { - "base": "

Container for user interface template information.

", - "refs": { - "DescribeHumanTaskUiResponse$UiTemplate": null - } - }, - "Uid": { - "base": null, - "refs": { - "CustomPosixUserConfig$Uid": "

The POSIX user ID.

" - } - }, - "UltraServer": { - "base": "

Represents a high-performance compute server used for distributed training in SageMaker AI. An UltraServer consists of multiple instances within a shared NVLink interconnect domain.

", - "refs": { - "UltraServers$member": null - } - }, - "UltraServerCount": { - "base": null, - "refs": { - "DescribeTrainingPlanResponse$TotalUltraServerCount": "

The total number of UltraServers reserved to this training plan.

", - "ReservedCapacityOffering$UltraServerCount": "

The number of UltraServers included in this reserved capacity offering.

", - "ReservedCapacitySummary$UltraServerCount": "

The number of UltraServers included in this reserved capacity.

", - "SearchTrainingPlanOfferingsRequest$UltraServerCount": "

The number of UltraServers to search for.

", - "TrainingPlanSummary$TotalUltraServerCount": "

The total number of UltraServers allocated to this training plan.

", - "UltraServerSummary$UltraServerCount": "

The number of UltraServers of this type.

" - } - }, - "UltraServerHealthStatus": { - "base": null, - "refs": { - "UltraServer$HealthStatus": "

The overall health status of the UltraServer.

" - } - }, - "UltraServerInfo": { - "base": "

Contains information about the UltraServer object.

", - "refs": { - "ClusterNodeDetails$UltraServerInfo": "

Contains information about the UltraServer.

", - "ClusterNodeSummary$UltraServerInfo": "

Contains information about the UltraServer.

" - } - }, - "UltraServerSummary": { - "base": "

A summary of UltraServer resources and their current status.

", - "refs": { - "DescribeReservedCapacityResponse$UltraServerSummary": "

A summary of the UltraServer associated with this reserved capacity.

" - } - }, - "UltraServerType": { - "base": null, - "refs": { - "ReservedCapacityOffering$UltraServerType": "

The type of UltraServer included in this reserved capacity offering, such as ml.u-p6e-gb200x72.

", - "ReservedCapacitySummary$UltraServerType": "

The type of UltraServer included in this reserved capacity, such as ml.u-p6e-gb200x72.

", - "SearchTrainingPlanOfferingsRequest$UltraServerType": "

The type of UltraServer to search for, such as ml.u-p6e-gb200x72.

", - "UltraServer$UltraServerType": "

The type of UltraServer, such as ml.u-p6e-gb200x72.

", - "UltraServerSummary$UltraServerType": "

The type of UltraServer, such as ml.u-p6e-gb200x72.

" - } - }, - "UltraServers": { - "base": null, - "refs": { - "ListUltraServersByReservedCapacityResponse$UltraServers": "

A list of UltraServers that are part of the specified reserved capacity.

" - } - }, - "UnhealthyInstanceCount": { - "base": null, - "refs": { - "DescribeTrainingPlanResponse$UnhealthyInstanceCount": "

The number of instances in the training plan that are currently in an unhealthy state.

", - "UltraServer$UnhealthyInstanceCount": "

The number of instances in this UltraServer that are currently in an unhealthy state.

", - "UltraServerSummary$UnhealthyInstanceCount": "

The total number of instances across all UltraServers of this type that are currently in an unhealthy state.

" - } - }, - "UnifiedStudioDomainId": { - "base": null, - "refs": { - "UnifiedStudioSettings$DomainId": "

The ID of the Amazon SageMaker Unified Studio domain associated with this domain.

" - } - }, - "UnifiedStudioEnvironmentId": { - "base": null, - "refs": { - "UnifiedStudioSettings$EnvironmentId": "

The ID of the environment that Amazon SageMaker Unified Studio associates with the domain.

" - } - }, - "UnifiedStudioProjectId": { - "base": null, - "refs": { - "UnifiedStudioSettings$ProjectId": "

The ID of the Amazon SageMaker Unified Studio project that corresponds to the domain.

" - } - }, - "UnifiedStudioSettings": { - "base": "

The settings that apply to an Amazon SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.

", - "refs": { - "DomainSettings$UnifiedStudioSettings": "

The settings that apply to an SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.

", - "DomainSettingsForUpdate$UnifiedStudioSettings": "

The settings that apply to an SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.

" - } - }, - "UpdateActionRequest": { - "base": null, - "refs": {} - }, - "UpdateActionResponse": { - "base": null, - "refs": {} - }, - "UpdateAppImageConfigRequest": { - "base": null, - "refs": {} - }, - "UpdateAppImageConfigResponse": { - "base": null, - "refs": {} - }, - "UpdateArtifactRequest": { - "base": null, - "refs": {} - }, - "UpdateArtifactResponse": { - "base": null, - "refs": {} - }, - "UpdateClusterRequest": { - "base": null, - "refs": {} - }, - "UpdateClusterResponse": { - "base": null, - "refs": {} - }, - "UpdateClusterSchedulerConfigRequest": { - "base": null, - "refs": {} - }, - "UpdateClusterSchedulerConfigResponse": { - "base": null, - "refs": {} - }, - "UpdateClusterSoftwareInstanceGroupSpecification": { - "base": "

The configuration that describes specifications of the instance groups to update.

", - "refs": { - "UpdateClusterSoftwareInstanceGroups$member": null - } - }, - "UpdateClusterSoftwareInstanceGroups": { - "base": null, - "refs": { - "UpdateClusterSoftwareRequest$InstanceGroups": "

The array of instance groups for which to update AMI versions.

" - } - }, - "UpdateClusterSoftwareRequest": { - "base": null, - "refs": {} - }, - "UpdateClusterSoftwareResponse": { - "base": null, - "refs": {} - }, - "UpdateCodeRepositoryInput": { - "base": null, - "refs": {} - }, - "UpdateCodeRepositoryOutput": { - "base": null, - "refs": {} - }, - "UpdateComputeQuotaRequest": { - "base": null, - "refs": {} - }, - "UpdateComputeQuotaResponse": { - "base": null, - "refs": {} - }, - "UpdateContextRequest": { - "base": null, - "refs": {} - }, - "UpdateContextResponse": { - "base": null, - "refs": {} - }, - "UpdateDeviceFleetRequest": { - "base": null, - "refs": {} - }, - "UpdateDevicesRequest": { - "base": null, - "refs": {} - }, - "UpdateDomainRequest": { - "base": null, - "refs": {} - }, - "UpdateDomainResponse": { - "base": null, - "refs": {} - }, - "UpdateEndpointInput": { - "base": null, - "refs": {} - }, - "UpdateEndpointOutput": { - "base": null, - "refs": {} - }, - "UpdateEndpointWeightsAndCapacitiesInput": { - "base": null, - "refs": {} - }, - "UpdateEndpointWeightsAndCapacitiesOutput": { - "base": null, - "refs": {} - }, - "UpdateExperimentRequest": { - "base": null, - "refs": {} - }, - "UpdateExperimentResponse": { - "base": null, - "refs": {} - }, - "UpdateFeatureGroupRequest": { - "base": null, - "refs": {} - }, - "UpdateFeatureGroupResponse": { - "base": null, - "refs": {} - }, - "UpdateFeatureMetadataRequest": { - "base": null, - "refs": {} - }, - "UpdateHubContentReferenceRequest": { - "base": null, - "refs": {} - }, - "UpdateHubContentReferenceResponse": { - "base": null, - "refs": {} - }, - "UpdateHubContentRequest": { - "base": null, - "refs": {} - }, - "UpdateHubContentResponse": { - "base": null, - "refs": {} - }, - "UpdateHubRequest": { - "base": null, - "refs": {} - }, - "UpdateHubResponse": { - "base": null, - "refs": {} - }, - "UpdateImageRequest": { - "base": null, - "refs": {} - }, - "UpdateImageResponse": { - "base": null, - "refs": {} - }, - "UpdateImageVersionRequest": { - "base": null, - "refs": {} - }, - "UpdateImageVersionResponse": { - "base": null, - "refs": {} - }, - "UpdateInferenceComponentInput": { - "base": null, - "refs": {} - }, - "UpdateInferenceComponentOutput": { - "base": null, - "refs": {} - }, - "UpdateInferenceComponentRuntimeConfigInput": { - "base": null, - "refs": {} - }, - "UpdateInferenceComponentRuntimeConfigOutput": { - "base": null, - "refs": {} - }, - "UpdateInferenceExperimentRequest": { - "base": null, - "refs": {} - }, - "UpdateInferenceExperimentResponse": { - "base": null, - "refs": {} - }, - "UpdateMlflowAppRequest": { - "base": null, - "refs": {} - }, - "UpdateMlflowAppResponse": { - "base": null, - "refs": {} - }, - "UpdateMlflowTrackingServerRequest": { - "base": null, - "refs": {} - }, - "UpdateMlflowTrackingServerResponse": { - "base": null, - "refs": {} - }, - "UpdateModelCardRequest": { - "base": null, - "refs": {} - }, - "UpdateModelCardResponse": { - "base": null, - "refs": {} - }, - "UpdateModelPackageInput": { - "base": null, - "refs": {} - }, - "UpdateModelPackageOutput": { - "base": null, - "refs": {} - }, - "UpdateMonitoringAlertRequest": { - "base": null, - "refs": {} - }, - "UpdateMonitoringAlertResponse": { - "base": null, - "refs": {} - }, - "UpdateMonitoringScheduleRequest": { - "base": null, - "refs": {} - }, - "UpdateMonitoringScheduleResponse": { - "base": null, - "refs": {} - }, - "UpdateNotebookInstanceInput": { - "base": null, - "refs": {} - }, - "UpdateNotebookInstanceLifecycleConfigInput": { - "base": null, - "refs": {} - }, - "UpdateNotebookInstanceLifecycleConfigOutput": { - "base": null, - "refs": {} - }, - "UpdateNotebookInstanceOutput": { - "base": null, - "refs": {} - }, - "UpdatePartnerAppRequest": { - "base": null, - "refs": {} - }, - "UpdatePartnerAppResponse": { - "base": null, - "refs": {} - }, - "UpdatePipelineExecutionRequest": { - "base": null, - "refs": {} - }, - "UpdatePipelineExecutionResponse": { - "base": null, - "refs": {} - }, - "UpdatePipelineRequest": { - "base": null, - "refs": {} - }, - "UpdatePipelineResponse": { - "base": null, - "refs": {} - }, - "UpdatePipelineVersionRequest": { - "base": null, - "refs": {} - }, - "UpdatePipelineVersionResponse": { - "base": null, - "refs": {} - }, - "UpdateProjectInput": { - "base": null, - "refs": {} - }, - "UpdateProjectOutput": { - "base": null, - "refs": {} - }, - "UpdateSpaceRequest": { - "base": null, - "refs": {} - }, - "UpdateSpaceResponse": { - "base": null, - "refs": {} - }, - "UpdateTemplateProvider": { - "base": "

Contains configuration details for updating an existing template provider in the project.

", - "refs": { - "UpdateTemplateProviderList$member": null - } - }, - "UpdateTemplateProviderList": { - "base": null, - "refs": { - "UpdateProjectInput$TemplateProvidersToUpdate": "

The template providers to update in the project.

" - } - }, - "UpdateTrainingJobRequest": { - "base": null, - "refs": {} - }, - "UpdateTrainingJobResponse": { - "base": null, - "refs": {} - }, - "UpdateTrialComponentRequest": { - "base": null, - "refs": {} - }, - "UpdateTrialComponentResponse": { - "base": null, - "refs": {} - }, - "UpdateTrialRequest": { - "base": null, - "refs": {} - }, - "UpdateTrialResponse": { - "base": null, - "refs": {} - }, - "UpdateUserProfileRequest": { - "base": null, - "refs": {} - }, - "UpdateUserProfileResponse": { - "base": null, - "refs": {} - }, - "UpdateWorkforceRequest": { - "base": null, - "refs": {} - }, - "UpdateWorkforceResponse": { - "base": null, - "refs": {} - }, - "UpdateWorkteamRequest": { - "base": null, - "refs": {} - }, - "UpdateWorkteamResponse": { - "base": null, - "refs": {} - }, - "Url": { - "base": null, - "refs": { - "AutoMLContainerDefinition$ModelDataUrl": "

The location of the model artifacts. For more information, see ContainerDefinition.

", - "ClarifyShapBaselineConfig$ShapBaselineUri": "

The uniform resource identifier (URI) of the S3 bucket where the SHAP baseline file is stored. The format of the SHAP baseline file should be the same format as the format of the training dataset. For example, if the training dataset is in CSV format, and each record in the training dataset has four features, and all features are numerical, then the baseline file should also have this same format. Each record should contain only the features. If you are using a virtual private cloud (VPC), the ShapBaselineUri should be accessible to the VPC. For more information about setting up endpoints with Amazon Virtual Private Cloud, see Give SageMaker access to Resources in your Amazon Virtual Private Cloud.

", - "ContainerDefinition$ModelDataUrl": "

The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3 path is required for SageMaker built-in algorithms, but not if you use your own algorithms. For more information on built-in algorithms, see Common Parameters.

The model artifacts must be in an S3 bucket that is in the same region as the model or endpoint you are creating.

If you provide a value for this parameter, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provide. Amazon Web Services STS is activated in your Amazon Web Services account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide.

If you use a built-in algorithm to create a model, SageMaker requires that you provide a S3 path to the model artifacts in ModelDataUrl.

", - "InferenceComponentContainerSpecification$ArtifactUrl": "

The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

", - "InferenceComponentContainerSpecificationSummary$ArtifactUrl": "

The Amazon S3 path where the model artifacts are stored.

", - "ModelPackageContainerDefinition$ModelDataUrl": "

The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

The model artifacts must be in an S3 bucket that is in the same region as the model package.

", - "SourceAlgorithm$ModelDataUrl": "

The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

The model artifacts must be in an S3 bucket that is in the same Amazon Web Services region as the algorithm.

" - } - }, - "UserContext": { - "base": "

Information about the user who created or modified a SageMaker resource.

", - "refs": { - "AssociationSummary$CreatedBy": null, - "DescribeActionResponse$CreatedBy": null, - "DescribeActionResponse$LastModifiedBy": null, - "DescribeArtifactResponse$CreatedBy": null, - "DescribeArtifactResponse$LastModifiedBy": null, - "DescribeClusterSchedulerConfigResponse$CreatedBy": null, - "DescribeClusterSchedulerConfigResponse$LastModifiedBy": null, - "DescribeComputeQuotaResponse$CreatedBy": null, - "DescribeComputeQuotaResponse$LastModifiedBy": null, - "DescribeContextResponse$CreatedBy": null, - "DescribeContextResponse$LastModifiedBy": null, - "DescribeExperimentResponse$CreatedBy": "

Who created the experiment.

", - "DescribeExperimentResponse$LastModifiedBy": "

Who last modified the experiment.

", - "DescribeLineageGroupResponse$CreatedBy": null, - "DescribeLineageGroupResponse$LastModifiedBy": null, - "DescribeMlflowAppResponse$CreatedBy": null, - "DescribeMlflowAppResponse$LastModifiedBy": null, - "DescribeMlflowTrackingServerResponse$CreatedBy": null, - "DescribeMlflowTrackingServerResponse$LastModifiedBy": null, - "DescribeModelCardResponse$CreatedBy": null, - "DescribeModelCardResponse$LastModifiedBy": null, - "DescribeModelPackageGroupOutput$CreatedBy": null, - "DescribeModelPackageOutput$CreatedBy": null, - "DescribeModelPackageOutput$LastModifiedBy": null, - "DescribePipelineExecutionResponse$CreatedBy": null, - "DescribePipelineExecutionResponse$LastModifiedBy": null, - "DescribePipelineResponse$CreatedBy": null, - "DescribePipelineResponse$LastModifiedBy": null, - "DescribeProjectOutput$CreatedBy": null, - "DescribeProjectOutput$LastModifiedBy": null, - "DescribeTrialComponentResponse$CreatedBy": "

Who created the trial component.

", - "DescribeTrialComponentResponse$LastModifiedBy": "

Who last modified the component.

", - "DescribeTrialResponse$CreatedBy": "

Who created the trial.

", - "DescribeTrialResponse$LastModifiedBy": "

Who last modified the trial.

", - "Experiment$CreatedBy": "

Who created the experiment.

", - "Experiment$LastModifiedBy": null, - "ModelCard$CreatedBy": null, - "ModelCard$LastModifiedBy": null, - "ModelDashboardModelCard$CreatedBy": null, - "ModelDashboardModelCard$LastModifiedBy": null, - "ModelPackage$CreatedBy": "

Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.

", - "ModelPackage$LastModifiedBy": "

Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.

", - "ModelPackageGroup$CreatedBy": null, - "Pipeline$CreatedBy": null, - "Pipeline$LastModifiedBy": null, - "PipelineExecution$CreatedBy": null, - "PipelineExecution$LastModifiedBy": null, - "PipelineVersion$CreatedBy": null, - "PipelineVersion$LastModifiedBy": null, - "Project$CreatedBy": "

Who created the project.

", - "Project$LastModifiedBy": null, - "Trial$CreatedBy": "

Who created the trial.

", - "Trial$LastModifiedBy": null, - "TrialComponent$CreatedBy": "

Who created the trial component.

", - "TrialComponent$LastModifiedBy": null, - "TrialComponentSimpleSummary$CreatedBy": null, - "TrialComponentSummary$CreatedBy": "

Who created the trial component.

", - "TrialComponentSummary$LastModifiedBy": "

Who last modified the component.

" - } - }, - "UserProfileArn": { - "base": null, - "refs": { - "CreateUserProfileResponse$UserProfileArn": "

The user profile Amazon Resource Name (ARN).

", - "DescribeUserProfileResponse$UserProfileArn": "

The user profile Amazon Resource Name (ARN).

", - "UpdateUserProfileResponse$UserProfileArn": "

The user profile Amazon Resource Name (ARN).

" - } - }, - "UserProfileDetails": { - "base": "

The user profile details.

", - "refs": { - "UserProfileList$member": null - } - }, - "UserProfileList": { - "base": null, - "refs": { - "ListUserProfilesResponse$UserProfiles": "

The list of user profiles.

" - } - }, - "UserProfileName": { - "base": null, - "refs": { - "AppDetails$UserProfileName": "

The user profile name.

", - "CreateAppRequest$UserProfileName": "

The user profile name. If this value is not set, then SpaceName must be set.

", - "CreatePresignedDomainUrlRequest$UserProfileName": "

The name of the UserProfile to sign-in as.

", - "CreateUserProfileRequest$UserProfileName": "

A name for the UserProfile. This value is not case sensitive.

", - "DeleteAppRequest$UserProfileName": "

The user profile name. If this value is not set, then SpaceName must be set.

", - "DeleteUserProfileRequest$UserProfileName": "

The user profile name.

", - "DescribeAppRequest$UserProfileName": "

The user profile name. If this value is not set, then SpaceName must be set.

", - "DescribeAppResponse$UserProfileName": "

The user profile name.

", - "DescribeUserProfileRequest$UserProfileName": "

The user profile name. This value is not case sensitive.

", - "DescribeUserProfileResponse$UserProfileName": "

The user profile name.

", - "ListAppsRequest$UserProfileNameEquals": "

A parameter to search by user profile name. If SpaceNameEquals is set, then this value cannot be set.

", - "ListUserProfilesRequest$UserProfileNameContains": "

A parameter by which to filter the results.

", - "OwnershipSettings$OwnerUserProfileName": "

The user profile who is the owner of the space.

", - "OwnershipSettingsSummary$OwnerUserProfileName": "

The user profile who is the owner of the space.

", - "UpdateUserProfileRequest$UserProfileName": "

The user profile name.

", - "UserProfileDetails$UserProfileName": "

The user profile name.

" - } - }, - "UserProfileSortKey": { - "base": null, - "refs": { - "ListUserProfilesRequest$SortBy": "

The parameter by which to sort the results. The default is CreationTime.

" - } - }, - "UserProfileStatus": { - "base": null, - "refs": { - "DescribeUserProfileResponse$Status": "

The status.

", - "UserProfileDetails$Status": "

The status.

" - } - }, - "UserSettings": { - "base": "

A collection of settings that apply to users in a domain. These settings are specified when the CreateUserProfile API is called, and as DefaultUserSettings when the CreateDomain API is called.

SecurityGroups is aggregated when specified in both calls. For all other settings in UserSettings, the values specified in CreateUserProfile take precedence over those specified in CreateDomain.

", - "refs": { - "CreateDomainRequest$DefaultUserSettings": "

The default settings to use to create a user profile when UserSettings isn't specified in the call to the CreateUserProfile API.

SecurityGroups is aggregated when specified in both calls. For all other settings in UserSettings, the values specified in CreateUserProfile take precedence over those specified in CreateDomain.

", - "CreateUserProfileRequest$UserSettings": "

A collection of settings.

", - "DescribeDomainResponse$DefaultUserSettings": "

Settings which are applied to UserProfiles in this domain if settings are not explicitly specified in a given UserProfile.

", - "DescribeUserProfileResponse$UserSettings": "

A collection of settings.

", - "UpdateDomainRequest$DefaultUserSettings": "

A collection of settings.

", - "UpdateUserProfileRequest$UserSettings": "

A collection of settings.

" - } - }, - "UsersPerStep": { - "base": null, - "refs": { - "Stairs$UsersPerStep": "

Specifies how many new users to spawn in each step.

" - } - }, - "UtilizationMetric": { - "base": null, - "refs": { - "RecommendationMetrics$CpuUtilization": "

The expected CPU utilization at maximum invocations per minute for the instance.

NaN indicates that the value is not available.

", - "RecommendationMetrics$MemoryUtilization": "

The expected memory utilization at maximum invocations per minute for the instance.

NaN indicates that the value is not available.

" - } - }, - "UtilizationPercentagePerCore": { - "base": null, - "refs": { - "GetScalingConfigurationRecommendationRequest$TargetCpuUtilizationPerCore": "

The percentage of how much utilization you want an instance to use before autoscaling. The default value is 50%.

", - "GetScalingConfigurationRecommendationResponse$TargetCpuUtilizationPerCore": "

The percentage of how much utilization you want an instance to use before autoscaling, which you specified in the request. The default value is 50%.

" - } - }, - "VCpuAmount": { - "base": null, - "refs": { - "ComputeQuotaResourceConfig$VCpu": "

The number of vCPU to allocate. If you specify a value only for vCPU, SageMaker AI automatically allocates ratio-based values for MemoryInGiB based on this vCPU parameter. For example, if you allocate 20 out of 40 total vCPU, SageMaker AI uses the ratio of 0.5 and allocates values to MemoryInGiB. Accelerators are set to 0.

" - } - }, - "ValidationFraction": { - "base": null, - "refs": { - "AutoMLDataSplitConfig$ValidationFraction": "

The validation fraction (optional) is a float that specifies the portion of the training dataset to be used for validation. The default value is 0.2, and values must be greater than 0 and less than 1. We recommend setting this value to be less than 0.5.

" - } - }, - "VariantInstanceProvisionTimeoutInSeconds": { - "base": null, - "refs": { - "ProductionVariant$VariantInstanceProvisionTimeoutInSeconds": "

The timeout value, in seconds, for provisioning instances for the production variant. When SageMaker encounters an insufficient capacity error while provisioning instances, it retries with the next instance pool (if configured) or waits until the timeout expires. This timeout applies only to capacity provisioning and does not include the time for model download or container startup.

Valid values: 300 to 3600.

" - } - }, - "VariantName": { - "base": null, - "refs": { - "CreateInferenceComponentInput$VariantName": "

The name of an existing production variant where you host the inference component.

", - "DescribeInferenceComponentOutput$VariantName": "

The name of the production variant that hosts the inference component.

", - "DesiredWeightAndCapacity$VariantName": "

The name of the variant to update.

", - "InferenceComponentSummary$VariantName": "

The name of the production variant that hosts the inference component.

", - "ListInferenceComponentsInput$VariantNameEquals": "

A production variant name to filter the listed inference components. The response includes only those inference components that are hosted at the specified variant.

", - "PendingProductionVariantSummary$VariantName": "

The name of the variant.

", - "ProductionVariant$VariantName": "

The name of the production variant.

", - "ProductionVariantSummary$VariantName": "

The name of the variant.

" - } - }, - "VariantProperty": { - "base": "

Specifies a production variant property type for an Endpoint.

If you are updating an endpoint with the RetainAllVariantProperties option of UpdateEndpointInput set to true, the VariantProperty objects listed in the ExcludeRetainedVariantProperties parameter of UpdateEndpointInput override the existing variant properties of the endpoint.

", - "refs": { - "VariantPropertyList$member": null - } - }, - "VariantPropertyList": { - "base": null, - "refs": { - "UpdateEndpointInput$ExcludeRetainedVariantProperties": "

When you are updating endpoint resources with RetainAllVariantProperties, whose value is set to true, ExcludeRetainedVariantProperties specifies the list of type VariantProperty to override with the values provided by EndpointConfig. If you don't specify a value for ExcludeRetainedVariantProperties, no variant properties are overridden.

" - } - }, - "VariantPropertyType": { - "base": null, - "refs": { - "VariantProperty$VariantPropertyType": "

The type of variant property. The supported values are:

  • DesiredInstanceCount: Overrides the existing variant instance counts using the InitialInstanceCount values in the ProductionVariants of CreateEndpointConfig.

  • DesiredWeight: Overrides the existing variant weights using the InitialVariantWeight values in the ProductionVariants of CreateEndpointConfig.

  • DataCaptureConfig: (Not currently supported.)

" - } - }, - "VariantStatus": { - "base": null, - "refs": { - "ProductionVariantStatus$Status": "

The endpoint variant status which describes the current deployment stage status or operational status.

  • Creating: Creating inference resources for the production variant.

  • Deleting: Terminating inference resources for the production variant.

  • Updating: Updating capacity for the production variant.

  • ActivatingTraffic: Turning on traffic for the production variant.

  • Baking: Waiting period to monitor the CloudWatch alarms in the automatic rollback configuration.

" - } - }, - "VariantStatusMessage": { - "base": null, - "refs": { - "ProductionVariantStatus$StatusMessage": "

A message that describes the status of the production variant.

" - } - }, - "VariantWeight": { - "base": null, - "refs": { - "DesiredWeightAndCapacity$DesiredWeight": "

The variant's weight.

", - "PendingProductionVariantSummary$CurrentWeight": "

The weight associated with the variant.

", - "PendingProductionVariantSummary$DesiredWeight": "

The requested weight for the variant in this deployment, as specified in the endpoint configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.

", - "ProductionVariant$InitialVariantWeight": "

Determines initial traffic distribution among all of the models that you specify in the endpoint configuration. The traffic to a production variant is determined by the ratio of the VariantWeight to the sum of all VariantWeight values across all ProductionVariants. If unspecified, it defaults to 1.0.

", - "ProductionVariantSummary$CurrentWeight": "

The weight associated with the variant.

", - "ProductionVariantSummary$DesiredWeight": "

The requested weight, as specified in the UpdateEndpointWeightsAndCapacities request.

" - } - }, - "VectorConfig": { - "base": "

Configuration for your vector collection type.

", - "refs": { - "CollectionConfig$VectorConfig": "

Configuration for your vector collection type.

  • Dimension: The number of elements in your vector.

" - } - }, - "VendorGuidance": { - "base": null, - "refs": { - "CreateImageVersionRequest$VendorGuidance": "

The stability of the image version, specified by the maintainer.

  • NOT_PROVIDED: The maintainers did not provide a status for image version stability.

  • STABLE: The image version is stable.

  • TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

  • ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

", - "DescribeImageVersionResponse$VendorGuidance": "

The stability of the image version specified by the maintainer.

  • NOT_PROVIDED: The maintainers did not provide a status for image version stability.

  • STABLE: The image version is stable.

  • TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

  • ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

", - "UpdateImageVersionRequest$VendorGuidance": "

The availability of the image version specified by the maintainer.

  • NOT_PROVIDED: The maintainers did not provide a status for image version stability.

  • STABLE: The image version is stable.

  • TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

  • ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

" - } - }, - "VersionAliasesList": { - "base": null, - "refs": { - "HiddenSageMakerImage$VersionAliases": "

The version aliases you are hiding from the Studio user interface.

" - } - }, - "VersionId": { - "base": null, - "refs": { - "PipelineDefinitionS3Location$VersionId": "

Version Id of the pipeline definition file. If not specified, Amazon SageMaker will retrieve the latest version.

" - } - }, - "VersionedArnOrName": { - "base": null, - "refs": { - "ContainerDefinition$ModelPackageName": "

The name or Amazon Resource Name (ARN) of the model package to use to create the model.

", - "DeleteModelPackageInput$ModelPackageName": "

The name or Amazon Resource Name (ARN) of the model package to delete.

When you specify a name, the name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

", - "DescribeModelPackageInput$ModelPackageName": "

The name or Amazon Resource Name (ARN) of the model package to describe.

When you specify a name, the name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

" - } - }, - "Vertex": { - "base": "

A lineage entity connected to the starting entity(ies).

", - "refs": { - "Vertices$member": null - } - }, - "Vertices": { - "base": null, - "refs": { - "QueryLineageResponse$Vertices": "

A list of vertices connected to the start entity(ies) in the lineage graph.

" - } - }, - "VisibilityConditions": { - "base": "

The list of key-value pairs used to filter your search results. If a search result contains a key from your list, it is included in the final search response if the value associated with the key in the result matches the value you specified. If the value doesn't match, the result is excluded from the search response. Any resources that don't have a key from the list that you've provided will also be included in the search response.

", - "refs": { - "VisibilityConditionsList$member": null - } - }, - "VisibilityConditionsKey": { - "base": null, - "refs": { - "VisibilityConditions$Key": "

The key that specifies the tag that you're using to filter the search results. It must be in the following format: Tags.<key>.

" - } - }, - "VisibilityConditionsList": { - "base": null, - "refs": { - "SearchRequest$VisibilityConditions": "

Limits the results of your search request to the resources that you can access.

" - } - }, - "VisibilityConditionsValue": { - "base": null, - "refs": { - "VisibilityConditions$Value": "

The value for the tag that you're using to filter the search results.

" - } - }, - "VolumeAttachmentStatus": { - "base": null, - "refs": { - "AttachClusterNodeVolumeResponse$Status": "

The current status of your volume attachment operation.

", - "DetachClusterNodeVolumeResponse$Status": "

The current status of your volume detachment operation.

" - } - }, - "VolumeDeviceName": { - "base": null, - "refs": { - "AttachClusterNodeVolumeResponse$DeviceName": "

The device name assigned to your attached volume on the target instance.

", - "DetachClusterNodeVolumeResponse$DeviceName": "

The device name assigned to your attached volume on the target instance.

" - } - }, - "VolumeId": { - "base": null, - "refs": { - "AttachClusterNodeVolumeRequest$VolumeId": "

The unique identifier of your EBS volume to attach. The volume must be in the available state.

", - "AttachClusterNodeVolumeResponse$VolumeId": "

The unique identifier of your EBS volume that was attached.

", - "DetachClusterNodeVolumeRequest$VolumeId": "

The unique identifier of your EBS volume that you want to detach. Your volume must be currently attached to the specified node.

", - "DetachClusterNodeVolumeResponse$VolumeId": "

The unique identifier of your EBS volume that was detached.

" - } - }, - "VolumeSizeInGB": { - "base": null, - "refs": { - "HyperParameterTuningInstanceConfig$VolumeSizeInGB": "

The volume size in GB of the data to be processed for hyperparameter optimization (optional).

" - } - }, - "VpcConfig": { - "base": "

Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC.

", - "refs": { - "AIBenchmarkNetworkConfig$VpcConfig": "

The VPC configuration, including security group IDs and subnet IDs.

", - "AutoMLSecurityConfig$VpcConfig": "

The VPC configuration.

", - "ClusterInstanceGroupDetails$OverrideVpcConfig": "

The customized Amazon VPC configuration at the instance group level that overrides the default Amazon VPC configuration of the SageMaker HyperPod cluster.

", - "ClusterInstanceGroupSpecification$OverrideVpcConfig": "

To configure multi-AZ deployments, customize the Amazon VPC configuration at the instance group level. You can specify different subnets and security groups across different AZs in the instance group specification to override a SageMaker HyperPod cluster's default Amazon VPC configuration. For more information about deploying a cluster in multiple AZs, see Setting up SageMaker HyperPod clusters across multiple AZs.

When your Amazon VPC and subnets support IPv6, network communications differ based on the cluster orchestration platform:

  • Slurm-orchestrated clusters automatically configure nodes with dual IPv6 and IPv4 addresses, allowing immediate IPv6 network communications.

  • In Amazon EKS-orchestrated clusters, nodes receive dual-stack addressing, but pods can only use IPv6 when the Amazon EKS cluster is explicitly IPv6-enabled. For information about deploying an IPv6 Amazon EKS cluster, see Amazon EKS IPv6 Cluster Deployment.

Additional resources for IPv6 configuration:

", - "ClusterNodeDetails$OverrideVpcConfig": "

The customized Amazon VPC configuration at the instance group level that overrides the default Amazon VPC configuration of the SageMaker HyperPod cluster.

", - "ClusterRestrictedInstanceGroupDetails$OverrideVpcConfig": null, - "ClusterRestrictedInstanceGroupSpecification$OverrideVpcConfig": null, - "CreateClusterRequest$VpcConfig": "

Specifies the Amazon Virtual Private Cloud (VPC) that is associated with the Amazon SageMaker HyperPod cluster. You can control access to and from your resources by configuring your VPC. For more information, see Give SageMaker access to resources in your Amazon VPC.

When your Amazon VPC and subnets support IPv6, network communications differ based on the cluster orchestration platform:

  • Slurm-orchestrated clusters automatically configure nodes with dual IPv6 and IPv4 addresses, allowing immediate IPv6 network communications.

  • In Amazon EKS-orchestrated clusters, nodes receive dual-stack addressing, but pods can only use IPv6 when the Amazon EKS cluster is explicitly IPv6-enabled. For information about deploying an IPv6 Amazon EKS cluster, see Amazon EKS IPv6 Cluster Deployment.

Additional resources for IPv6 configuration:

", - "CreateEndpointConfigInput$VpcConfig": null, - "CreateModelInput$VpcConfig": "

A VpcConfig object that specifies the VPC that you want your model to connect to. Control access to and from your model container by configuring the VPC. VpcConfig is used in hosting services and in batch transform. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private Cloud.

", - "CreateTrainingJobRequest$VpcConfig": "

A VpcConfig object that specifies the VPC that you want your training job to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

", - "DescribeClusterResponse$VpcConfig": null, - "DescribeEndpointConfigOutput$VpcConfig": null, - "DescribeModelOutput$VpcConfig": "

A VpcConfig object that specifies the VPC that this model has access to. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud

", - "DescribeTrainingJobResponse$VpcConfig": "

A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

", - "HyperParameterTrainingJobDefinition$VpcConfig": "

The VpcConfig object that specifies the VPC that you want the training jobs that this hyperparameter tuning job launches to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

", - "LabelingJobResourceConfig$VpcConfig": null, - "Model$VpcConfig": null, - "MonitoringNetworkConfig$VpcConfig": null, - "NetworkConfig$VpcConfig": null, - "TrainingJob$VpcConfig": "

A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

" - } - }, - "VpcId": { - "base": null, - "refs": { - "CreateDomainRequest$VpcId": "

The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

The field is optional when the AppNetworkAccessType parameter is set to PublicInternetOnly for domains created from Amazon SageMaker Unified Studio.

", - "DescribeDomainResponse$VpcId": "

The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

", - "UpdateDomainRequest$VpcId": "

The identifier for the VPC used by the domain for network communication. Use this field only when adding VPC configuration to a SageMaker AI domain used in Amazon SageMaker Unified Studio that was created without VPC settings. SageMaker AI doesn't automatically apply VPC updates to existing applications. Stop and restart your applications to apply the changes.

" - } - }, - "VpcOnlyTrustedAccounts": { - "base": null, - "refs": { - "DockerSettings$VpcOnlyTrustedAccounts": "

The list of Amazon Web Services accounts that are trusted when the domain is created in VPC-only mode.

" - } - }, - "VpcSecurityGroupIds": { - "base": null, - "refs": { - "VpcConfig$SecurityGroupIds": "

The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.

" - } - }, - "WaitIntervalInSeconds": { - "base": null, - "refs": { - "InferenceComponentRollingUpdatePolicy$WaitIntervalInSeconds": "

The length of the baking period, during which SageMaker AI monitors alarms for each batch on the new fleet.

", - "RollingUpdatePolicy$WaitIntervalInSeconds": "

The length of the baking period, during which SageMaker monitors alarms for each batch on the new fleet.

", - "TrafficRoutingConfig$WaitIntervalInSeconds": "

The waiting time (in seconds) between incremental steps to turn on traffic on the new endpoint fleet.

" - } - }, - "WaitTimeIntervalInSeconds": { - "base": null, - "refs": { - "DeploymentConfiguration$WaitIntervalInSeconds": "

The duration in seconds that SageMaker waits before updating more instances in the cluster.

" - } - }, - "WarmPoolResourceStatus": { - "base": null, - "refs": { - "ListTrainingJobsRequest$WarmPoolStatusEquals": "

A filter that retrieves only training jobs with a specific warm pool status.

", - "WarmPoolStatus$Status": "

The status of the warm pool.

  • InUse: The warm pool is in use for the training job.

  • Available: The warm pool is available to reuse for a matching training job.

  • Reused: The warm pool moved to a matching training job for reuse.

  • Terminated: The warm pool is no longer available. Warm pools are unavailable if they are terminated by a user, terminated for a patch update, or terminated for exceeding the specified KeepAlivePeriodInSeconds.

" - } - }, - "WarmPoolStatus": { - "base": "

Status and billing information about the warm pool.

", - "refs": { - "DescribeTrainingJobResponse$WarmPoolStatus": "

The status of the warm pool associated with the training job.

", - "TrainingJob$WarmPoolStatus": "

The status of the warm pool associated with the training job.

", - "TrainingJobSummary$WarmPoolStatus": "

The status of the warm pool associated with the training job.

" - } - }, - "WeeklyMaintenanceWindowStart": { - "base": null, - "refs": { - "CreateMlflowAppRequest$WeeklyMaintenanceWindowStart": "

The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. For example: TUE:03:30.

", - "CreateMlflowTrackingServerRequest$WeeklyMaintenanceWindowStart": "

The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. For example: TUE:03:30.

", - "DescribeMlflowAppResponse$WeeklyMaintenanceWindowStart": "

The day and time of the week when weekly maintenance occurs.

", - "DescribeMlflowTrackingServerResponse$WeeklyMaintenanceWindowStart": "

The day and time of the week when weekly maintenance occurs on the described tracking server.

", - "UpdateMlflowAppRequest$WeeklyMaintenanceWindowStart": "

The new weekly maintenance window start day and time to update. The maintenance window day and time should be in Coordinated Universal Time (UTC) 24-hour standard time. For example: TUE:03:30.

", - "UpdateMlflowTrackingServerRequest$WeeklyMaintenanceWindowStart": "

The new weekly maintenance window start day and time to update. The maintenance window day and time should be in Coordinated Universal Time (UTC) 24-hour standard time. For example: TUE:03:30.

" - } - }, - "WeeklyScheduleTimeFormat": { - "base": null, - "refs": { - "PartnerAppMaintenanceConfig$MaintenanceWindowStart": "

The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. This value must take the following format: 3-letter-day:24-h-hour:minute. For example: TUE:03:30.

" - } - }, - "WorkerAccessConfiguration": { - "base": "

Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL.

", - "refs": { - "CreateWorkteamRequest$WorkerAccessConfiguration": "

Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL.

", - "UpdateWorkteamRequest$WorkerAccessConfiguration": "

Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL.

", - "Workteam$WorkerAccessConfiguration": "

Describes any access constraints that have been defined for Amazon S3 resources.

" - } - }, - "Workforce": { - "base": "

A single private workforce, which is automatically created when you create your first private work team. You can create one private work force in each Amazon Web Services Region. By default, any workforce-related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

", - "refs": { - "DescribeWorkforceResponse$Workforce": "

A single private workforce, which is automatically created when you create your first private work team. You can create one private work force in each Amazon Web Services Region. By default, any workforce-related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

", - "UpdateWorkforceResponse$Workforce": "

A single private workforce. You can create one private work force in each Amazon Web Services Region. By default, any workforce-related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

", - "Workforces$member": null - } - }, - "WorkforceArn": { - "base": null, - "refs": { - "CreateWorkforceResponse$WorkforceArn": "

The Amazon Resource Name (ARN) of the workforce.

", - "Workforce$WorkforceArn": "

The Amazon Resource Name (ARN) of the private workforce.

", - "Workteam$WorkforceArn": "

The Amazon Resource Name (ARN) of the workforce.

" - } - }, - "WorkforceFailureReason": { - "base": null, - "refs": { - "Workforce$FailureReason": "

The reason your workforce failed.

" - } - }, - "WorkforceIpAddressType": { - "base": null, - "refs": { - "CreateWorkforceRequest$IpAddressType": "

Use this parameter to specify whether you want IPv4 only or dualstack (IPv4 and IPv6) to support your labeling workforce.

", - "UpdateWorkforceRequest$IpAddressType": "

Use this parameter to specify whether you want IPv4 only or dualstack (IPv4 and IPv6) to support your labeling workforce.

", - "Workforce$IpAddressType": "

The IP address type you specify - either IPv4 only or dualstack (IPv4 and IPv6) - to support your labeling workforce.

" - } - }, - "WorkforceName": { - "base": null, - "refs": { - "CreateWorkforceRequest$WorkforceName": "

The name of the private workforce.

", - "CreateWorkteamRequest$WorkforceName": "

The name of the workforce.

", - "DeleteWorkforceRequest$WorkforceName": "

The name of the workforce.

", - "DescribeWorkforceRequest$WorkforceName": "

The name of the private workforce whose access you want to restrict. WorkforceName is automatically set to default when a workforce is created and cannot be modified.

", - "ListWorkforcesRequest$NameContains": "

A filter you can use to search for workforces using part of the workforce name.

", - "UpdateWorkforceRequest$WorkforceName": "

The name of the private workforce that you want to update. You can find your workforce name by using the ListWorkforces operation.

", - "Workforce$WorkforceName": "

The name of the private workforce.

" - } - }, - "WorkforceSecurityGroupId": { - "base": null, - "refs": { - "WorkforceSecurityGroupIds$member": null - } - }, - "WorkforceSecurityGroupIds": { - "base": null, - "refs": { - "WorkforceVpcConfigRequest$SecurityGroupIds": "

The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.

", - "WorkforceVpcConfigResponse$SecurityGroupIds": "

The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.

" - } - }, - "WorkforceStatus": { - "base": null, - "refs": { - "Workforce$Status": "

The status of your workforce.

" - } - }, - "WorkforceSubnetId": { - "base": null, - "refs": { - "WorkforceSubnets$member": null - } - }, - "WorkforceSubnets": { - "base": null, - "refs": { - "WorkforceVpcConfigRequest$Subnets": "

The ID of the subnets in the VPC that you want to connect.

", - "WorkforceVpcConfigResponse$Subnets": "

The ID of the subnets in the VPC that you want to connect.

" - } - }, - "WorkforceVpcConfigRequest": { - "base": "

The VPC object you use to create or update a workforce.

", - "refs": { - "CreateWorkforceRequest$WorkforceVpcConfig": "

Use this parameter to configure a workforce using VPC.

", - "UpdateWorkforceRequest$WorkforceVpcConfig": "

Use this parameter to update your VPC configuration for a workforce.

" - } - }, - "WorkforceVpcConfigResponse": { - "base": "

A VpcConfig object that specifies the VPC that you want your workforce to connect to.

", - "refs": { - "Workforce$WorkforceVpcConfig": "

The configuration of a VPC workforce.

" - } - }, - "WorkforceVpcEndpointId": { - "base": null, - "refs": { - "WorkforceVpcConfigResponse$VpcEndpointId": "

The IDs for the VPC service endpoints of your VPC workforce when it is created and updated.

" - } - }, - "WorkforceVpcId": { - "base": null, - "refs": { - "WorkforceVpcConfigRequest$VpcId": "

The ID of the VPC that the workforce uses for communication.

", - "WorkforceVpcConfigResponse$VpcId": "

The ID of the VPC that the workforce uses for communication.

" - } - }, - "Workforces": { - "base": null, - "refs": { - "ListWorkforcesResponse$Workforces": "

A list containing information about your workforce.

" - } - }, - "WorkloadSpec": { - "base": "

The workload specification for benchmark tool configuration. Provide an inline YAML or JSON string.

", - "refs": { - "AIWorkloadConfigs$WorkloadSpec": "

The workload specification that defines benchmark parameters.

" - } - }, - "WorkspaceSettings": { - "base": "

The workspace settings for the SageMaker Canvas application.

", - "refs": { - "CanvasAppSettings$WorkspaceSettings": "

The workspace settings for the SageMaker Canvas application.

" - } - }, - "Workteam": { - "base": "

Provides details about a labeling work team.

", - "refs": { - "DescribeWorkteamResponse$Workteam": "

A Workteam instance that contains information about the work team.

", - "UpdateWorkteamResponse$Workteam": "

A Workteam object that describes the updated work team.

", - "Workteams$member": null - } - }, - "WorkteamArn": { - "base": null, - "refs": { - "CreateWorkteamResponse$WorkteamArn": "

The Amazon Resource Name (ARN) of the work team. You can use this ARN to identify the work team.

", - "DescribeSubscribedWorkteamRequest$WorkteamArn": "

The Amazon Resource Name (ARN) of the subscribed work team to describe.

", - "HumanLoopConfig$WorkteamArn": "

Amazon Resource Name (ARN) of a team of workers. To learn more about the types of workforces and work teams you can create and use with Amazon A2I, see Create and Manage Workforces.

", - "HumanTaskConfig$WorkteamArn": "

The Amazon Resource Name (ARN) of the work team assigned to complete the tasks.

", - "LabelingJobSummary$WorkteamArn": "

The Amazon Resource Name (ARN) of the work team assigned to the job.

", - "ListLabelingJobsForWorkteamRequest$WorkteamArn": "

The Amazon Resource Name (ARN) of the work team for which you want to see labeling jobs for.

", - "SubscribedWorkteam$WorkteamArn": "

The Amazon Resource Name (ARN) of the vendor that you have subscribed.

", - "Workteam$WorkteamArn": "

The Amazon Resource Name (ARN) that identifies the work team.

" - } - }, - "WorkteamName": { - "base": null, - "refs": { - "CreateWorkteamRequest$WorkteamName": "

The name of the work team. Use this name to identify the work team.

", - "DeleteWorkteamRequest$WorkteamName": "

The name of the work team to delete.

", - "DescribeWorkteamRequest$WorkteamName": "

The name of the work team to return a description of.

", - "ListSubscribedWorkteamsRequest$NameContains": "

A string in the work team name. This filter returns only work teams whose name contains the specified string.

", - "ListWorkteamsRequest$NameContains": "

A string in the work team's name. This filter returns only work teams whose name contains the specified string.

", - "UpdateWorkteamRequest$WorkteamName": "

The name of the work team to update.

", - "Workteam$WorkteamName": "

The name of the work team.

" - } - }, - "Workteams": { - "base": null, - "refs": { - "ListWorkteamsResponse$Workteams": "

An array of Workteam objects, each describing a work team.

" - } - } - } -} diff --git a/tools/code-generation/api-descriptions/sagemaker/2017-07-24/endpoint-bdd-1.json b/tools/code-generation/api-descriptions/sagemaker/2017-07-24/endpoint-bdd-1.json deleted file mode 100644 index 2afcd85a9ada..000000000000 --- a/tools/code-generation/api-descriptions/sagemaker/2017-07-24/endpoint-bdd-1.json +++ /dev/null @@ -1,227 +0,0 @@ -{ - "version": "1.1", - "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" - } - }, - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - }, - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - }, - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - }, - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws" - ] - }, - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws-us-gov" - ] - } - ], - "results": [ - { - "conditions": [], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://api.sagemaker-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": "https://api-fips.sagemaker.{Region}.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://api.sagemaker-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": "https://api.sagemaker.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": "https://api.sagemaker.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ], - "root": 2, - "nodeCount": 15, - "nodes": "/////wAAAAH/////AAAAAAAAAA4AAAADAAAAAQAAAAQF9eEMAAAAAgAAAAUF9eEMAAAAAwAAAAgAAAAGAAAABAAAAAcF9eELAAAABQX14QkF9eEKAAAABAAAAAwAAAAJAAAABgAAAAoF9eEIAAAABwX14QYAAAALAAAACAX14QYF9eEHAAAABQAAAA0F9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAAPAAAABAX14QIF9eED" -} \ No newline at end of file diff --git a/tools/code-generation/api-descriptions/sagemaker/2017-07-24/endpoint-rule-set-1.json b/tools/code-generation/api-descriptions/sagemaker/2017-07-24/endpoint-rule-set-1.json deleted file mode 100644 index c252a1bea3ab..000000000000 --- a/tools/code-generation/api-descriptions/sagemaker/2017-07-24/endpoint-rule-set-1.json +++ /dev/null @@ -1,364 +0,0 @@ -{ - "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": [ - { - "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" - }, - { - "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": [], - "endpoint": { - "url": "https://api.sagemaker-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "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": [ - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws" - ] - } - ], - "endpoint": { - "url": "https://api-fips.sagemaker.{Region}.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws-us-gov" - ] - } - ], - "endpoint": { - "url": "https://api-fips.sagemaker.{Region}.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://api.sagemaker-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "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": [], - "endpoint": { - "url": "https://api.sagemaker.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://api.sagemaker.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] -} \ No newline at end of file diff --git a/tools/code-generation/api-descriptions/sagemaker/2017-07-24/endpoint-tests-1.json b/tools/code-generation/api-descriptions/sagemaker/2017-07-24/endpoint-tests-1.json deleted file mode 100644 index c90a30871769..000000000000 --- a/tools/code-generation/api-descriptions/sagemaker/2017-07-24/endpoint-tests-1.json +++ /dev/null @@ -1,608 +0,0 @@ -{ - "testCases": [ - { - "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.sagemaker.af-south-1.amazonaws.com" - } - }, - "params": { - "Region": "af-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.sagemaker.ap-east-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.sagemaker.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.sagemaker.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.sagemaker.ap-northeast-3.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.sagemaker.ap-south-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.sagemaker.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.sagemaker.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.sagemaker.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.sagemaker.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.sagemaker.eu-north-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.sagemaker.eu-south-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.sagemaker.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.sagemaker.eu-west-2.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.sagemaker.eu-west-3.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.sagemaker.me-south-1.amazonaws.com" - } - }, - "params": { - "Region": "me-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.sagemaker.sa-east-1.amazonaws.com" - } - }, - "params": { - "Region": "sa-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.sagemaker.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api-fips.sagemaker.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.sagemaker.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api-fips.sagemaker.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.sagemaker.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api-fips.sagemaker.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.sagemaker.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api-fips.sagemaker.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://api.sagemaker-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://api.sagemaker.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.sagemaker.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.sagemaker.cn-northwest-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-northwest-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://api.sagemaker-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://api.sagemaker-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://api.sagemaker.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.sagemaker.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api-fips.sagemaker.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://api.sagemaker-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://api-fips.sagemaker.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://api.sagemaker.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://api.sagemaker.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 disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.sagemaker.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.sagemaker-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.sagemaker-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 disabled", - "expect": { - "endpoint": { - "url": "https://api.sagemaker.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" -} \ No newline at end of file diff --git a/tools/code-generation/api-descriptions/sagemaker/2017-07-24/examples-1.json b/tools/code-generation/api-descriptions/sagemaker/2017-07-24/examples-1.json deleted file mode 100644 index 2fb77604d1be..000000000000 --- a/tools/code-generation/api-descriptions/sagemaker/2017-07-24/examples-1.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "version": "1.0", - "examples": {} -} diff --git a/tools/code-generation/api-descriptions/sagemaker/2017-07-24/paginators-1.json b/tools/code-generation/api-descriptions/sagemaker/2017-07-24/paginators-1.json deleted file mode 100644 index 28671a237e9b..000000000000 --- a/tools/code-generation/api-descriptions/sagemaker/2017-07-24/paginators-1.json +++ /dev/null @@ -1,548 +0,0 @@ -{ - "pagination": { - "CreateHubContentPresignedUrls": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "AuthorizedUrlConfigs" - }, - "DescribeTrainingPlanExtensionHistory": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "TrainingPlanExtensions" - }, - "ListAIBenchmarkJobs": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "AIBenchmarkJobs" - }, - "ListAIRecommendationJobs": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "AIRecommendationJobs" - }, - "ListAIWorkloadConfigs": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "AIWorkloadConfigs" - }, - "ListActions": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "ActionSummaries" - }, - "ListAlgorithms": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "AlgorithmSummaryList" - }, - "ListAliases": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "SageMakerImageVersionAliases" - }, - "ListAppImageConfigs": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "AppImageConfigs" - }, - "ListApps": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "Apps" - }, - "ListArtifacts": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "ArtifactSummaries" - }, - "ListAssociations": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "AssociationSummaries" - }, - "ListAutoMLJobs": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "AutoMLJobSummaries" - }, - "ListCandidatesForAutoMLJob": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "Candidates" - }, - "ListClusterEvents": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "Events" - }, - "ListClusterNodes": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "ClusterNodeSummaries" - }, - "ListClusterSchedulerConfigs": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "ClusterSchedulerConfigSummaries" - }, - "ListClusters": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "ClusterSummaries" - }, - "ListCodeRepositories": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "CodeRepositorySummaryList" - }, - "ListCompilationJobs": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "CompilationJobSummaries" - }, - "ListComputeQuotas": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "ComputeQuotaSummaries" - }, - "ListContexts": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "ContextSummaries" - }, - "ListDataQualityJobDefinitions": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "JobDefinitionSummaries" - }, - "ListDeviceFleets": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "DeviceFleetSummaries" - }, - "ListDevices": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "DeviceSummaries" - }, - "ListDomains": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "Domains" - }, - "ListEdgeDeploymentPlans": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "EdgeDeploymentPlanSummaries" - }, - "ListEdgePackagingJobs": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "EdgePackagingJobSummaries" - }, - "ListEndpointConfigs": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "EndpointConfigs" - }, - "ListEndpoints": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "Endpoints" - }, - "ListExperiments": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "ExperimentSummaries" - }, - "ListFeatureGroups": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "FeatureGroupSummaries" - }, - "ListFlowDefinitions": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "FlowDefinitionSummaries" - }, - "ListHumanTaskUis": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "HumanTaskUiSummaries" - }, - "ListHyperParameterTuningJobs": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "HyperParameterTuningJobSummaries" - }, - "ListImageVersions": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "ImageVersions" - }, - "ListImages": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "Images" - }, - "ListInferenceComponents": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "InferenceComponents" - }, - "ListInferenceExperiments": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "InferenceExperiments" - }, - "ListInferenceRecommendationsJobSteps": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "Steps" - }, - "ListInferenceRecommendationsJobs": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "InferenceRecommendationsJobs" - }, - "ListJobSchemaVersions": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "JobConfigSchemas" - }, - "ListJobs": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "JobSummaries" - }, - "ListLabelingJobs": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "LabelingJobSummaryList" - }, - "ListLabelingJobsForWorkteam": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "LabelingJobSummaryList" - }, - "ListLineageGroups": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "LineageGroupSummaries" - }, - "ListMlflowApps": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "Summaries" - }, - "ListMlflowTrackingServers": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "TrackingServerSummaries" - }, - "ListModelBiasJobDefinitions": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "JobDefinitionSummaries" - }, - "ListModelCardExportJobs": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "ModelCardExportJobSummaries" - }, - "ListModelCardVersions": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "ModelCardVersionSummaryList" - }, - "ListModelCards": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "ModelCardSummaries" - }, - "ListModelExplainabilityJobDefinitions": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "JobDefinitionSummaries" - }, - "ListModelMetadata": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "ModelMetadataSummaries" - }, - "ListModelPackageGroups": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "ModelPackageGroupSummaryList" - }, - "ListModelPackages": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "ModelPackageSummaryList" - }, - "ListModelQualityJobDefinitions": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "JobDefinitionSummaries" - }, - "ListModels": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "Models" - }, - "ListMonitoringAlertHistory": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "MonitoringAlertHistory" - }, - "ListMonitoringAlerts": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "MonitoringAlertSummaries" - }, - "ListMonitoringExecutions": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "MonitoringExecutionSummaries" - }, - "ListMonitoringSchedules": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "MonitoringScheduleSummaries" - }, - "ListNotebookInstanceLifecycleConfigs": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "NotebookInstanceLifecycleConfigs" - }, - "ListNotebookInstances": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "NotebookInstances" - }, - "ListOptimizationJobs": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "OptimizationJobSummaries" - }, - "ListPartnerApps": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "Summaries" - }, - "ListPipelineExecutionSteps": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "PipelineExecutionSteps" - }, - "ListPipelineExecutions": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "PipelineExecutionSummaries" - }, - "ListPipelineParametersForExecution": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "PipelineParameters" - }, - "ListPipelineVersions": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "PipelineVersionSummaries" - }, - "ListPipelines": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "PipelineSummaries" - }, - "ListProcessingJobs": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "ProcessingJobSummaries" - }, - "ListProjects": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults" - }, - "ListResourceCatalogs": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "ResourceCatalogs" - }, - "ListSpaces": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "Spaces" - }, - "ListStageDevices": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "DeviceDeploymentSummaries" - }, - "ListStudioLifecycleConfigs": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "StudioLifecycleConfigs" - }, - "ListSubscribedWorkteams": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "SubscribedWorkteams" - }, - "ListTags": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "Tags" - }, - "ListTrainingJobs": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "TrainingJobSummaries" - }, - "ListTrainingJobsForHyperParameterTuningJob": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "TrainingJobSummaries" - }, - "ListTrainingPlans": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "TrainingPlanSummaries" - }, - "ListTransformJobs": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "TransformJobSummaries" - }, - "ListTrialComponents": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "TrialComponentSummaries" - }, - "ListTrials": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "TrialSummaries" - }, - "ListUltraServersByReservedCapacity": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "UltraServers" - }, - "ListUserProfiles": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "UserProfiles" - }, - "ListWorkforces": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "Workforces" - }, - "ListWorkteams": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "Workteams" - }, - "QueryLineage": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults" - }, - "Search": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "Results" - } - } -} diff --git a/tools/code-generation/api-descriptions/sagemaker/2017-07-24/service-2.json b/tools/code-generation/api-descriptions/sagemaker/2017-07-24/service-2.json deleted file mode 100644 index df971da5be34..000000000000 --- a/tools/code-generation/api-descriptions/sagemaker/2017-07-24/service-2.json +++ /dev/null @@ -1,51631 +0,0 @@ -{ - "version":"2.0", - "metadata":{ - "apiVersion":"2017-07-24", - "auth":["aws.auth#sigv4"], - "endpointPrefix":"api.sagemaker", - "jsonVersion":"1.1", - "protocol":"json", - "protocols":["json"], - "serviceAbbreviation":"SageMaker", - "serviceFullName":"Amazon SageMaker Service", - "serviceId":"SageMaker", - "signatureVersion":"v4", - "signingName":"sagemaker", - "targetPrefix":"SageMaker", - "uid":"sagemaker-2017-07-24" - }, - "operations":{ - "AddAssociation":{ - "name":"AddAssociation", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AddAssociationRequest"}, - "output":{"shape":"AddAssociationResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates an association between the source and the destination. A source can be associated with multiple destinations, and a destination can be associated with multiple sources. An association is a lineage tracking entity. For more information, see Amazon SageMaker ML Lineage Tracking.

" - }, - "AddTags":{ - "name":"AddTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AddTagsInput"}, - "output":{"shape":"AddTagsOutput"}, - "documentation":"

Adds or overwrites one or more tags for the specified SageMaker resource. You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints.

Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see For more information, see Amazon Web Services Tagging Strategies.

Tags that you add to a hyperparameter tuning job by calling this API are also added to any training jobs that the hyperparameter tuning job launches after you call this API, but not to training jobs that the hyperparameter tuning job launched before you called this API. To make sure that the tags associated with a hyperparameter tuning job are also added to all training jobs that the hyperparameter tuning job launches, add the tags when you first create the tuning job by specifying them in the Tags parameter of CreateHyperParameterTuningJob

Tags that you add to a SageMaker Domain or User Profile by calling this API are also added to any Apps that the Domain or User Profile launches after you call this API, but not to Apps that the Domain or User Profile launched before you called this API. To make sure that the tags associated with a Domain or User Profile are also added to all Apps that the Domain or User Profile launches, add the tags when you first create the Domain or User Profile by specifying them in the Tags parameter of CreateDomain or CreateUserProfile.

" - }, - "AssociateTrialComponent":{ - "name":"AssociateTrialComponent", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AssociateTrialComponentRequest"}, - "output":{"shape":"AssociateTrialComponentResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Associates a trial component with a trial. A trial component can be associated with multiple trials. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.

" - }, - "AttachClusterNodeVolume":{ - "name":"AttachClusterNodeVolume", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AttachClusterNodeVolumeRequest"}, - "output":{"shape":"AttachClusterNodeVolumeResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Attaches your Amazon Elastic Block Store (Amazon EBS) volume to a node in your EKS orchestrated HyperPod cluster.

This API works with the Amazon Elastic Block Store (Amazon EBS) Container Storage Interface (CSI) driver to manage the lifecycle of persistent storage in your HyperPod EKS clusters.

" - }, - "BatchAddClusterNodes":{ - "name":"BatchAddClusterNodes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"BatchAddClusterNodesRequest"}, - "output":{"shape":"BatchAddClusterNodesResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Adds nodes to a HyperPod cluster by incrementing the target count for one or more instance groups. This operation returns a unique NodeLogicalId for each node being added, which can be used to track the provisioning status of the node. This API provides a safer alternative to UpdateCluster for scaling operations by avoiding unintended configuration changes.

This API is only supported for clusters using Continuous as the NodeProvisioningMode.

" - }, - "BatchDeleteClusterNodes":{ - "name":"BatchDeleteClusterNodes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"BatchDeleteClusterNodesRequest"}, - "output":{"shape":"BatchDeleteClusterNodesResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Deletes specific nodes within a SageMaker HyperPod cluster. BatchDeleteClusterNodes accepts a cluster name and a list of node IDs.

" - }, - "BatchDescribeModelPackage":{ - "name":"BatchDescribeModelPackage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"BatchDescribeModelPackageInput"}, - "output":{"shape":"BatchDescribeModelPackageOutput"}, - "documentation":"

This action batch describes a list of versioned model packages

" - }, - "BatchRebootClusterNodes":{ - "name":"BatchRebootClusterNodes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"BatchRebootClusterNodesRequest"}, - "output":{"shape":"BatchRebootClusterNodesResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Reboots specific nodes within a SageMaker HyperPod cluster using a soft recovery mechanism. BatchRebootClusterNodes performs a graceful reboot of the specified nodes by calling the Amazon Elastic Compute Cloud RebootInstances API, which attempts to cleanly shut down the operating system before restarting the instance.

This operation is useful for recovering from transient issues or applying certain configuration changes that require a restart.

  • Rebooting a node may cause temporary service interruption for workloads running on that node. Ensure your workloads can handle node restarts or use appropriate scheduling to minimize impact.

  • You can reboot up to 25 nodes in a single request.

  • For SageMaker HyperPod clusters using the Slurm workload manager, ensure rebooting nodes will not disrupt critical cluster operations.

" - }, - "BatchReplaceClusterNodes":{ - "name":"BatchReplaceClusterNodes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"BatchReplaceClusterNodesRequest"}, - "output":{"shape":"BatchReplaceClusterNodesResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Replaces specific nodes within a SageMaker HyperPod cluster with new hardware. BatchReplaceClusterNodes terminates the specified instances and provisions new replacement instances with the same configuration but fresh hardware. The Amazon Machine Image (AMI) and instance configuration remain the same.

This operation is useful for recovering from hardware failures or persistent issues that cannot be resolved through a reboot.

  • Data Loss Warning: Replacing nodes destroys all instance volumes, including both root and secondary volumes. All data stored on these volumes will be permanently lost and cannot be recovered.

  • To safeguard your work, back up your data to Amazon S3 or an FSx for Lustre file system before invoking the API on a worker node group. This will help prevent any potential data loss from the instance root volume. For more information about backup, see Use the backup script provided by SageMaker HyperPod.

  • If you want to invoke this API on an existing cluster, you'll first need to patch the cluster by running the UpdateClusterSoftware API. For more information about patching a cluster, see Update the SageMaker HyperPod platform software of a cluster.

  • You can replace up to 25 nodes in a single request.

" - }, - "CreateAIBenchmarkJob":{ - "name":"CreateAIBenchmarkJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateAIBenchmarkJobRequest"}, - "output":{"shape":"CreateAIBenchmarkJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates a benchmark job that runs performance benchmarks against inference infrastructure using a predefined AI workload configuration. The benchmark job measures metrics such as latency, throughput, and cost for your generative AI inference endpoints.

" - }, - "CreateAIRecommendationJob":{ - "name":"CreateAIRecommendationJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateAIRecommendationJobRequest"}, - "output":{"shape":"CreateAIRecommendationJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates a recommendation job that generates intelligent optimization recommendations for generative AI inference deployments. The job analyzes your model, workload configuration, and performance targets to recommend optimal instance types, model optimization techniques (such as quantization and speculative decoding), and deployment configurations.

" - }, - "CreateAIWorkloadConfig":{ - "name":"CreateAIWorkloadConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateAIWorkloadConfigRequest"}, - "output":{"shape":"CreateAIWorkloadConfigResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates a reusable AI workload configuration that defines datasets, data sources, and benchmark tool settings for consistent performance testing of generative AI inference deployments on Amazon SageMaker AI.

" - }, - "CreateAction":{ - "name":"CreateAction", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateActionRequest"}, - "output":{"shape":"CreateActionResponse"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates an action. An action is a lineage tracking entity that represents an action or activity. For example, a model deployment or an HPO job. Generally, an action involves at least one input or output artifact. For more information, see Amazon SageMaker ML Lineage Tracking.

" - }, - "CreateAlgorithm":{ - "name":"CreateAlgorithm", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateAlgorithmInput"}, - "output":{"shape":"CreateAlgorithmOutput"}, - "documentation":"

Create a machine learning algorithm that you can use in SageMaker and list in the Amazon Web Services Marketplace.

" - }, - "CreateApp":{ - "name":"CreateApp", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateAppRequest"}, - "output":{"shape":"CreateAppResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates a running app for the specified UserProfile. This operation is automatically invoked by Amazon SageMaker AI upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously.

" - }, - "CreateAppImageConfig":{ - "name":"CreateAppImageConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateAppImageConfigRequest"}, - "output":{"shape":"CreateAppImageConfigResponse"}, - "errors":[ - {"shape":"ResourceInUse"} - ], - "documentation":"

Creates a configuration for running a SageMaker AI image as a KernelGateway app. The configuration specifies the Amazon Elastic File System storage volume on the image, and a list of the kernels in the image.

" - }, - "CreateArtifact":{ - "name":"CreateArtifact", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateArtifactRequest"}, - "output":{"shape":"CreateArtifactResponse"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates an artifact. An artifact is a lineage tracking entity that represents a URI addressable object or data. Some examples are the S3 URI of a dataset and the ECR registry path of an image. For more information, see Amazon SageMaker ML Lineage Tracking.

" - }, - "CreateAutoMLJob":{ - "name":"CreateAutoMLJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateAutoMLJobRequest"}, - "output":{"shape":"CreateAutoMLJobResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates an Autopilot job also referred to as Autopilot experiment or AutoML job.

An AutoML job in SageMaker AI is a fully automated process that allows you to build machine learning models with minimal effort and machine learning expertise. When initiating an AutoML job, you provide your data and optionally specify parameters tailored to your use case. SageMaker AI then automates the entire model development lifecycle, including data preprocessing, model training, tuning, and evaluation. AutoML jobs are designed to simplify and accelerate the model building process by automating various tasks and exploring different combinations of machine learning algorithms, data preprocessing techniques, and hyperparameter values. The output of an AutoML job comprises one or more trained models ready for deployment and inference. Additionally, SageMaker AI AutoML jobs generate a candidate model leaderboard, allowing you to select the best-performing model for deployment.

For more information about AutoML jobs, see https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development.html in the SageMaker AI developer guide.

We recommend using the new versions CreateAutoMLJobV2 and DescribeAutoMLJobV2, which offer backward compatibility.

CreateAutoMLJobV2 can manage tabular problem types identical to those of its previous version CreateAutoMLJob, as well as time-series forecasting, non-tabular problem types such as image or text classification, and text generation (LLMs fine-tuning).

Find guidelines about how to migrate a CreateAutoMLJob to CreateAutoMLJobV2 in Migrate a CreateAutoMLJob to CreateAutoMLJobV2.

You can find the best-performing model after you run an AutoML job by calling DescribeAutoMLJobV2 (recommended) or DescribeAutoMLJob.

" - }, - "CreateAutoMLJobV2":{ - "name":"CreateAutoMLJobV2", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateAutoMLJobV2Request"}, - "output":{"shape":"CreateAutoMLJobV2Response"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates an Autopilot job also referred to as Autopilot experiment or AutoML job V2.

An AutoML job in SageMaker AI is a fully automated process that allows you to build machine learning models with minimal effort and machine learning expertise. When initiating an AutoML job, you provide your data and optionally specify parameters tailored to your use case. SageMaker AI then automates the entire model development lifecycle, including data preprocessing, model training, tuning, and evaluation. AutoML jobs are designed to simplify and accelerate the model building process by automating various tasks and exploring different combinations of machine learning algorithms, data preprocessing techniques, and hyperparameter values. The output of an AutoML job comprises one or more trained models ready for deployment and inference. Additionally, SageMaker AI AutoML jobs generate a candidate model leaderboard, allowing you to select the best-performing model for deployment.

For more information about AutoML jobs, see https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development.html in the SageMaker AI developer guide.

AutoML jobs V2 support various problem types such as regression, binary, and multiclass classification with tabular data, text and image classification, time-series forecasting, and fine-tuning of large language models (LLMs) for text generation.

CreateAutoMLJobV2 and DescribeAutoMLJobV2 are new versions of CreateAutoMLJob and DescribeAutoMLJob which offer backward compatibility.

CreateAutoMLJobV2 can manage tabular problem types identical to those of its previous version CreateAutoMLJob, as well as time-series forecasting, non-tabular problem types such as image or text classification, and text generation (LLMs fine-tuning).

Find guidelines about how to migrate a CreateAutoMLJob to CreateAutoMLJobV2 in Migrate a CreateAutoMLJob to CreateAutoMLJobV2.

For the list of available problem types supported by CreateAutoMLJobV2, see AutoMLProblemTypeConfig.

You can find the best-performing model after you run an AutoML job V2 by calling DescribeAutoMLJobV2.

" - }, - "CreateCluster":{ - "name":"CreateCluster", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateClusterRequest"}, - "output":{"shape":"CreateClusterResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates an Amazon SageMaker HyperPod cluster. SageMaker HyperPod is a capability of SageMaker for creating and managing persistent clusters for developing large machine learning models, such as large language models (LLMs) and diffusion models. To learn more, see Amazon SageMaker HyperPod in the Amazon SageMaker Developer Guide.

" - }, - "CreateClusterSchedulerConfig":{ - "name":"CreateClusterSchedulerConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateClusterSchedulerConfigRequest"}, - "output":{"shape":"CreateClusterSchedulerConfigResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Create cluster policy configuration. This policy is used for task prioritization and fair-share allocation of idle compute. This helps prioritize critical workloads and distributes idle compute across entities.

" - }, - "CreateCodeRepository":{ - "name":"CreateCodeRepository", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateCodeRepositoryInput"}, - "output":{"shape":"CreateCodeRepositoryOutput"}, - "documentation":"

Creates a Git repository as a resource in your SageMaker AI account. You can associate the repository with notebook instances so that you can use Git source control for the notebooks you create. The Git repository is a resource in your SageMaker AI account, so it can be associated with more than one notebook instance, and it persists independently from the lifecycle of any notebook instances it is associated with.

The repository can be hosted either in Amazon Web Services CodeCommit or in any other Git repository.

" - }, - "CreateCompilationJob":{ - "name":"CreateCompilationJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateCompilationJobRequest"}, - "output":{"shape":"CreateCompilationJobResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Starts a model compilation job. After the model has been compiled, Amazon SageMaker AI saves the resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify.

If you choose to host your model using Amazon SageMaker AI hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts with Amazon Web Services IoT Greengrass. In that case, deploy them as an ML resource.

In the request body, you provide the following:

  • A name for the compilation job

  • Information about the input model artifacts

  • The output location for the compiled model and the device (target) that the model runs on

  • The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker AI assumes to perform the model compilation job.

You can also provide a Tag to track the model compilation job's resource use and costs. The response body contains the CompilationJobArn for the compiled job.

To stop a model compilation job, use StopCompilationJob. To get information about a particular model compilation job, use DescribeCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.

" - }, - "CreateComputeQuota":{ - "name":"CreateComputeQuota", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateComputeQuotaRequest"}, - "output":{"shape":"CreateComputeQuotaResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Create compute allocation definition. This defines how compute is allocated, shared, and borrowed for specified entities. Specifically, how to lend and borrow idle compute and assign a fair-share weight to the specified entities.

" - }, - "CreateContext":{ - "name":"CreateContext", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateContextRequest"}, - "output":{"shape":"CreateContextResponse"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates a context. A context is a lineage tracking entity that represents a logical grouping of other tracking or experiment entities. Some examples are an endpoint and a model package. For more information, see Amazon SageMaker ML Lineage Tracking.

" - }, - "CreateDataQualityJobDefinition":{ - "name":"CreateDataQualityJobDefinition", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateDataQualityJobDefinitionRequest"}, - "output":{"shape":"CreateDataQualityJobDefinitionResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates a definition for a job that monitors data quality and drift. For information about model monitor, see Amazon SageMaker AI Model Monitor.

" - }, - "CreateDeviceFleet":{ - "name":"CreateDeviceFleet", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateDeviceFleetRequest"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates a device fleet.

" - }, - "CreateDomain":{ - "name":"CreateDomain", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateDomainRequest"}, - "output":{"shape":"CreateDomainResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates a Domain. A domain consists of an associated Amazon Elastic File System volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations. Users within a domain can share notebook files and other artifacts with each other.

EFS storage

When a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files.

SageMaker AI uses the Amazon Web Services Key Management Service (Amazon Web Services KMS) to encrypt the EFS volume attached to the domain with an Amazon Web Services managed key by default. For more control, you can specify a customer managed key. For more information, see Protect Data at Rest Using Encryption.

VPC configuration

All traffic between the domain and the Amazon EFS volume is through the specified VPC and subnets. For other traffic, you can specify the AppNetworkAccessType parameter. AppNetworkAccessType corresponds to the network access type that you choose when you onboard to the domain. The following options are available:

  • PublicInternetOnly - Non-EFS traffic goes through a VPC managed by Amazon SageMaker AI, which allows internet access. This is the default value.

  • VpcOnly - All traffic is through the specified VPC and subnets. Internet access is disabled by default. To allow internet access, you must specify a NAT gateway.

    When internet access is disabled, you won't be able to run a Amazon SageMaker AI Studio notebook or to train or host models unless your VPC has an interface endpoint to the SageMaker AI API and runtime or a NAT gateway and your security groups allow outbound connections.

NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules in order to launch a Amazon SageMaker AI Studio app successfully.

For more information, see Connect Amazon SageMaker AI Studio Notebooks to Resources in a VPC.

" - }, - "CreateEdgeDeploymentPlan":{ - "name":"CreateEdgeDeploymentPlan", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateEdgeDeploymentPlanRequest"}, - "output":{"shape":"CreateEdgeDeploymentPlanResponse"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates an edge deployment plan, consisting of multiple stages. Each stage may have a different deployment configuration and devices.

" - }, - "CreateEdgeDeploymentStage":{ - "name":"CreateEdgeDeploymentStage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateEdgeDeploymentStageRequest"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates a new stage in an existing edge deployment plan.

" - }, - "CreateEdgePackagingJob":{ - "name":"CreateEdgePackagingJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateEdgePackagingJobRequest"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Starts a SageMaker Edge Manager model packaging job. Edge Manager will use the model artifacts from the Amazon Simple Storage Service bucket that you specify. After the model has been packaged, Amazon SageMaker saves the resulting artifacts to an S3 bucket that you specify.

" - }, - "CreateEndpoint":{ - "name":"CreateEndpoint", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateEndpointInput"}, - "output":{"shape":"CreateEndpointOutput"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates an endpoint using the endpoint configuration specified in the request. SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the CreateEndpointConfig API.

Use this API to deploy models using SageMaker hosting services.

You must not delete an EndpointConfig that is in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.

The endpoint name must be unique within an Amazon Web Services Region in your Amazon Web Services account.

When it receives the request, SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them.

When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.

When SageMaker receives the request, it sets the endpoint status to Creating. After it creates the endpoint, it sets the status to InService. SageMaker can then process incoming requests for inferences. To check the status of an endpoint, use the DescribeEndpoint API.

If any of the models hosted at this endpoint get model data from an Amazon S3 location, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provided. Amazon Web Services STS is activated in your Amazon Web Services account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide.

To add the IAM role policies for using this API operation, go to the IAM console, and choose Roles in the left navigation pane. Search the IAM role that you want to grant access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to the role.

  • Option 1: For a full SageMaker access, search and attach the AmazonSageMakerFullAccess policy.

  • Option 2: For granting a limited access to an IAM role, paste the following Action elements manually into the JSON file of the IAM role:

    \"Action\": [\"sagemaker:CreateEndpoint\", \"sagemaker:CreateEndpointConfig\"]

    \"Resource\": [

    \"arn:aws:sagemaker:region:account-id:endpoint/endpointName\"

    \"arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName\"

    ]

    For more information, see SageMaker API Permissions: Actions, Permissions, and Resources Reference.

" - }, - "CreateEndpointConfig":{ - "name":"CreateEndpointConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateEndpointConfigInput"}, - "output":{"shape":"CreateEndpointConfigOutput"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates an endpoint configuration that SageMaker hosting services uses to deploy models. In the configuration, you identify one or more models, created using the CreateModel API, to deploy and the resources that you want SageMaker to provision. Then you call the CreateEndpoint API.

Use this API if you want to use SageMaker hosting services to deploy models into production.

In the request, you define a ProductionVariant, for each model that you want to deploy. Each ProductionVariant parameter also describes the resources that you want SageMaker to provision. This includes the number and type of ML compute instances to deploy.

If you are hosting multiple models, you also assign a VariantWeight to specify how much traffic you want to allocate to each model. For example, suppose that you want to host two models, A and B, and you assign traffic weight 2 for model A and 1 for model B. SageMaker distributes two-thirds of the traffic to Model A, and one-third to model B.

When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.

" - }, - "CreateExperiment":{ - "name":"CreateExperiment", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateExperimentRequest"}, - "output":{"shape":"CreateExperimentResponse"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates a SageMaker experiment. An experiment is a collection of trials that are observed, compared and evaluated as a group. A trial is a set of steps, called trial components, that produce a machine learning model.

In the Studio UI, trials are referred to as run groups and trial components are referred to as runs.

The goal of an experiment is to determine the components that produce the best model. Multiple trials are performed, each one isolating and measuring the impact of a change to one or more inputs, while keeping the remaining inputs constant.

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.

You can add tags to experiments, trials, trial components and then use the Search API to search for the tags.

To add a description to an experiment, specify the optional Description parameter. To add a description later, or to change the description, call the UpdateExperiment API.

To get a list of all your experiments, call the ListExperiments API. To view an experiment's properties, call the DescribeExperiment API. To get a list of all the trials associated with an experiment, call the ListTrials API. To create a trial call the CreateTrial API.

" - }, - "CreateFeatureGroup":{ - "name":"CreateFeatureGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateFeatureGroupRequest"}, - "output":{"shape":"CreateFeatureGroupResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Create a new FeatureGroup. A FeatureGroup is a group of Features defined in the FeatureStore to describe a Record.

The FeatureGroup defines the schema and features contained in the FeatureGroup. A FeatureGroup definition is composed of a list of Features, a RecordIdentifierFeatureName, an EventTimeFeatureName and configurations for its OnlineStore and OfflineStore. Check Amazon Web Services service quotas to see the FeatureGroups quota for your Amazon Web Services account.

Note that it can take approximately 10-15 minutes to provision an OnlineStore FeatureGroup with the InMemory StorageType.

You must include at least one of OnlineStoreConfig and OfflineStoreConfig to create a FeatureGroup.

" - }, - "CreateFlowDefinition":{ - "name":"CreateFlowDefinition", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateFlowDefinitionRequest"}, - "output":{"shape":"CreateFlowDefinitionResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates a flow definition.

" - }, - "CreateHub":{ - "name":"CreateHub", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateHubRequest"}, - "output":{"shape":"CreateHubResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Create a hub.

" - }, - "CreateHubContentPresignedUrls":{ - "name":"CreateHubContentPresignedUrls", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateHubContentPresignedUrlsRequest"}, - "output":{"shape":"CreateHubContentPresignedUrlsResponse"}, - "documentation":"

Creates presigned URLs for accessing hub content artifacts. This operation generates time-limited, secure URLs that allow direct download of model artifacts and associated files from Amazon SageMaker hub content, including gated models that require end-user license agreement acceptance.

" - }, - "CreateHubContentReference":{ - "name":"CreateHubContentReference", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateHubContentReferenceRequest"}, - "output":{"shape":"CreateHubContentReferenceResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Create a hub content reference in order to add a model in the JumpStart public hub to a private hub.

" - }, - "CreateHumanTaskUi":{ - "name":"CreateHumanTaskUi", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateHumanTaskUiRequest"}, - "output":{"shape":"CreateHumanTaskUiResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Defines the settings you will use for the human review workflow user interface. Reviewers will see a three-panel interface with an instruction area, the item to review, and an input area.

" - }, - "CreateHyperParameterTuningJob":{ - "name":"CreateHyperParameterTuningJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateHyperParameterTuningJobRequest"}, - "output":{"shape":"CreateHyperParameterTuningJobResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Starts a hyperparameter tuning job. A hyperparameter tuning job finds the best version of a model by running many training jobs on your dataset using the algorithm you choose and values for hyperparameters within ranges that you specify. It then chooses the hyperparameter values that result in a model that performs the best, as measured by an objective metric that you choose.

A hyperparameter tuning job automatically creates Amazon SageMaker experiments, trials, and trial components for each training job that it runs. You can view these entities in Amazon SageMaker Studio. For more information, see View Experiments, Trials, and Trial Components.

Do not include any security-sensitive information including account access IDs, secrets, or tokens in any hyperparameter fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by any security-sensitive information included in the request hyperparameter variable or plain text fields..

" - }, - "CreateImage":{ - "name":"CreateImage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateImageRequest"}, - "output":{"shape":"CreateImageResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates a custom SageMaker AI image. A SageMaker AI image is a set of image versions. Each image version represents a container image stored in Amazon ECR. For more information, see Bring your own SageMaker AI image.

" - }, - "CreateImageVersion":{ - "name":"CreateImageVersion", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateImageVersionRequest"}, - "output":{"shape":"CreateImageVersionResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates a version of the SageMaker AI image specified by ImageName. The version represents the Amazon ECR container image specified by BaseImage.

" - }, - "CreateInferenceComponent":{ - "name":"CreateInferenceComponent", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateInferenceComponentInput"}, - "output":{"shape":"CreateInferenceComponentOutput"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates an inference component, which is a SageMaker AI hosting object that you can use to deploy a model to an endpoint. In the inference component settings, you specify the model, the endpoint, and how the model utilizes the resources that the endpoint hosts. You can optimize resource utilization by tailoring how the required CPU cores, accelerators, and memory are allocated. You can deploy multiple inference components to an endpoint, where each inference component contains one model and the resource utilization needs for that individual model. After you deploy an inference component, you can directly invoke the associated model when you use the InvokeEndpoint API action.

" - }, - "CreateInferenceExperiment":{ - "name":"CreateInferenceExperiment", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateInferenceExperimentRequest"}, - "output":{"shape":"CreateInferenceExperimentResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates an inference experiment using the configurations specified in the request.

Use this API to setup and schedule an experiment to compare model variants on a Amazon SageMaker inference endpoint. For more information about inference experiments, see Shadow tests.

Amazon SageMaker begins your experiment at the scheduled time and routes traffic to your endpoint's model variants based on your specified configuration.

While the experiment is in progress or after it has concluded, you can view metrics that compare your model variants. For more information, see View, monitor, and edit shadow tests.

" - }, - "CreateInferenceRecommendationsJob":{ - "name":"CreateInferenceRecommendationsJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateInferenceRecommendationsJobRequest"}, - "output":{"shape":"CreateInferenceRecommendationsJobResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Starts a recommendation job. You can create either an instance recommendation or load test job.

" - }, - "CreateJob":{ - "name":"CreateJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateJobRequest"}, - "output":{"shape":"CreateJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates a model customization job in Amazon SageMaker. A job runs a workload based on the job category and configuration you provide. You specify the job category, a schema-versioned configuration document, and an IAM role that grants Amazon SageMaker permission to access resources on your behalf.

Use the AgentRFT category to fine-tune a model using multi-turn reinforcement learning with reward signals. Use the AgentRFTEvaluation category to evaluate a fine-tuned or base model by running multi-turn rollouts against a held-out prompt dataset and computing metrics such as pass@k and mean reward.

Before creating a job, call ListJobSchemaVersions and DescribeJobSchemaVersion to retrieve the configuration schema for your job category. The JobConfigDocument must conform to the schema specified by JobConfigSchemaVersion.

The following operations are related to CreateJob:

  • DescribeJob

  • ListJobs

  • StopJob

  • DeleteJob

  • ListJobSchemaVersions

  • DescribeJobSchemaVersion

" - }, - "CreateLabelingJob":{ - "name":"CreateLabelingJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateLabelingJobRequest"}, - "output":{"shape":"CreateLabelingJobResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates a job that uses workers to label the data objects in your input dataset. You can use the labeled data to train machine learning models.

You can select your workforce from one of three providers:

  • A private workforce that you create. It can include employees, contractors, and outside experts. Use a private workforce when want the data to stay within your organization or when a specific set of skills is required.

  • One or more vendors that you select from the Amazon Web Services Marketplace. Vendors provide expertise in specific areas.

  • The Amazon Mechanical Turk workforce. This is the largest workforce, but it should only be used for public data or data that has been stripped of any personally identifiable information.

You can also use automated data labeling to reduce the number of data objects that need to be labeled by a human. Automated data labeling uses active learning to determine if a data object can be labeled by machine or if it needs to be sent to a human worker. For more information, see Using Automated Data Labeling.

The data objects to be labeled are contained in an Amazon S3 bucket. You create a manifest file that describes the location of each object. For more information, see Using Input and Output Data.

The output can be used as the manifest file for another labeling job or as training data for your machine learning models.

You can use this operation to create a static labeling job or a streaming labeling job. A static labeling job stops if all data objects in the input manifest file identified in ManifestS3Uri have been labeled. A streaming labeling job runs perpetually until it is manually stopped, or remains idle for 10 days. You can send new data objects to an active (InProgress) streaming labeling job in real time. To learn how to create a static labeling job, see Create a Labeling Job (API) in the Amazon SageMaker Developer Guide. To learn how to create a streaming labeling job, see Create a Streaming Labeling Job.

" - }, - "CreateMlflowApp":{ - "name":"CreateMlflowApp", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateMlflowAppRequest"}, - "output":{"shape":"CreateMlflowAppResponse"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates an MLflow Tracking Server using a general purpose Amazon S3 bucket as the artifact store.

" - }, - "CreateMlflowTrackingServer":{ - "name":"CreateMlflowTrackingServer", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateMlflowTrackingServerRequest"}, - "output":{"shape":"CreateMlflowTrackingServerResponse"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates an MLflow Tracking Server using a general purpose Amazon S3 bucket as the artifact store. For more information, see Create an MLflow Tracking Server.

" - }, - "CreateModel":{ - "name":"CreateModel", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateModelInput"}, - "output":{"shape":"CreateModelOutput"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates a model in SageMaker. In the request, you name the model and describe a primary container. For the primary container, you specify the Docker image that contains inference code, artifacts (from prior training), and a custom environment map that the inference code uses when you deploy the model for predictions.

Use this API to create a model if you want to use SageMaker hosting services or run a batch transform job.

To host your model, you create an endpoint configuration with the CreateEndpointConfig API, and then create an endpoint with the CreateEndpoint API. SageMaker then deploys all of the containers that you defined for the model in the hosting environment.

To run a batch transform using your model, you start a job with the CreateTransformJob API. SageMaker uses your model and your dataset to get inferences which are then saved to a specified S3 location.

In the request, you also provide an IAM role that SageMaker can assume to access model artifacts and docker image for deployment on ML compute hosting instances or for batch transform jobs. In addition, you also use the IAM role to manage permissions the inference code needs. For example, if the inference code access any other Amazon Web Services resources, you grant necessary permissions via this role.

" - }, - "CreateModelBiasJobDefinition":{ - "name":"CreateModelBiasJobDefinition", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateModelBiasJobDefinitionRequest"}, - "output":{"shape":"CreateModelBiasJobDefinitionResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates the definition for a model bias job.

" - }, - "CreateModelCard":{ - "name":"CreateModelCard", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateModelCardRequest"}, - "output":{"shape":"CreateModelCardResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates an Amazon SageMaker Model Card.

For information about how to use model cards, see Amazon SageMaker Model Card.

" - }, - "CreateModelCardExportJob":{ - "name":"CreateModelCardExportJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateModelCardExportJobRequest"}, - "output":{"shape":"CreateModelCardExportJobResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates an Amazon SageMaker Model Card export job.

" - }, - "CreateModelExplainabilityJobDefinition":{ - "name":"CreateModelExplainabilityJobDefinition", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateModelExplainabilityJobDefinitionRequest"}, - "output":{"shape":"CreateModelExplainabilityJobDefinitionResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates the definition for a model explainability job.

" - }, - "CreateModelPackage":{ - "name":"CreateModelPackage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateModelPackageInput"}, - "output":{"shape":"CreateModelPackageOutput"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates a model package that you can use to create SageMaker models or list on Amazon Web Services Marketplace, or a versioned model that is part of a model group. Buyers can subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker.

To create a model package by specifying a Docker container that contains your inference code and the Amazon S3 location of your model artifacts, provide values for InferenceSpecification. To create a model from an algorithm resource that you created or subscribed to in Amazon Web Services Marketplace, provide a value for SourceAlgorithmSpecification.

There are two types of model packages:

  • Versioned - a model that is part of a model group in the model registry.

  • Unversioned - a model package that is not part of a model group.

" - }, - "CreateModelPackageGroup":{ - "name":"CreateModelPackageGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateModelPackageGroupInput"}, - "output":{"shape":"CreateModelPackageGroupOutput"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates a model group. A model group contains a group of model versions.

" - }, - "CreateModelQualityJobDefinition":{ - "name":"CreateModelQualityJobDefinition", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateModelQualityJobDefinitionRequest"}, - "output":{"shape":"CreateModelQualityJobDefinitionResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates a definition for a job that monitors model quality and drift. For information about model monitor, see Amazon SageMaker AI Model Monitor.

" - }, - "CreateMonitoringSchedule":{ - "name":"CreateMonitoringSchedule", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateMonitoringScheduleRequest"}, - "output":{"shape":"CreateMonitoringScheduleResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates a schedule that regularly starts Amazon SageMaker AI Processing Jobs to monitor the data captured for an Amazon SageMaker AI Endpoint.

" - }, - "CreateNotebookInstance":{ - "name":"CreateNotebookInstance", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateNotebookInstanceInput"}, - "output":{"shape":"CreateNotebookInstanceOutput"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates an SageMaker AI notebook instance. A notebook instance is a machine learning (ML) compute instance running on a Jupyter notebook.

In a CreateNotebookInstance request, specify the type of ML compute instance that you want to run. SageMaker AI launches the instance, installs common libraries that you can use to explore datasets for model training, and attaches an ML storage volume to the notebook instance.

SageMaker AI also provides a set of example notebooks. Each notebook demonstrates how to use SageMaker AI with a specific algorithm or with a machine learning framework.

After receiving the request, SageMaker AI does the following:

  1. Creates a network interface in the SageMaker AI VPC.

  2. (Option) If you specified SubnetId, SageMaker AI creates a network interface in your own VPC, which is inferred from the subnet ID that you provide in the input. When creating this network interface, SageMaker AI attaches the security group that you specified in the request to the network interface that it creates in your VPC.

  3. Launches an EC2 instance of the type specified in the request in the SageMaker AI VPC. If you specified SubnetId of your VPC, SageMaker AI specifies both network interfaces when launching this instance. This enables inbound traffic from your own VPC to the notebook instance, assuming that the security groups allow it.

After creating the notebook instance, SageMaker AI returns its Amazon Resource Name (ARN). You can't change the name of a notebook instance after you create it.

After SageMaker AI creates the notebook instance, you can connect to the Jupyter server and work in Jupyter notebooks. For example, you can write code to explore a dataset that you can use for model training, train a model, host models by creating SageMaker AI endpoints, and validate hosted models.

For more information, see How It Works.

" - }, - "CreateNotebookInstanceLifecycleConfig":{ - "name":"CreateNotebookInstanceLifecycleConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateNotebookInstanceLifecycleConfigInput"}, - "output":{"shape":"CreateNotebookInstanceLifecycleConfigOutput"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates a lifecycle configuration that you can associate with a notebook instance. A lifecycle configuration is a collection of shell scripts that run when you create or start a notebook instance.

Each lifecycle configuration script has a limit of 16384 characters.

The value of the $PATH environment variable that is available to both scripts is /sbin:bin:/usr/sbin:/usr/bin.

View Amazon CloudWatch Logs for notebook instance lifecycle configurations in log group /aws/sagemaker/NotebookInstances in log stream [notebook-instance-name]/[LifecycleConfigHook].

Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 minutes, it fails and the notebook instance is not created or started.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

Lifecycle configuration scripts execute with root access and the notebook instance's IAM execution role privileges. Grant this permission only to trusted principals. See Customize a Notebook Instance Using a Lifecycle Configuration Script for security best practices.

" - }, - "CreateOptimizationJob":{ - "name":"CreateOptimizationJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateOptimizationJobRequest"}, - "output":{"shape":"CreateOptimizationJobResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates a job that optimizes a model for inference performance. To create the job, you provide the location of a source model, and you provide the settings for the optimization techniques that you want the job to apply. When the job completes successfully, SageMaker uploads the new optimized model to the output destination that you specify.

For more information about how to use this action, and about the supported optimization techniques, see Optimize model inference with Amazon SageMaker.

" - }, - "CreatePartnerApp":{ - "name":"CreatePartnerApp", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreatePartnerAppRequest"}, - "output":{"shape":"CreatePartnerAppResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates an Amazon SageMaker Partner AI App.

" - }, - "CreatePartnerAppPresignedUrl":{ - "name":"CreatePartnerAppPresignedUrl", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreatePartnerAppPresignedUrlRequest"}, - "output":{"shape":"CreatePartnerAppPresignedUrlResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Creates a presigned URL to access an Amazon SageMaker Partner AI App.

" - }, - "CreatePipeline":{ - "name":"CreatePipeline", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreatePipelineRequest"}, - "output":{"shape":"CreatePipelineResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates a pipeline using a JSON pipeline definition.

" - }, - "CreatePresignedDomainUrl":{ - "name":"CreatePresignedDomainUrl", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreatePresignedDomainUrlRequest"}, - "output":{"shape":"CreatePresignedDomainUrlResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser, the user will be automatically signed in to the domain, and granted access to all of the Apps and files associated with the Domain's Amazon Elastic File System volume. This operation can only be called when the authentication mode equals IAM.

The IAM role or user passed to this API defines the permissions to access the app. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the app.

You can restrict access to this API and to the URL that it returns to a list of IP addresses, Amazon VPCs or Amazon VPC Endpoints that you specify. For more information, see Connect to Amazon SageMaker AI Studio Through an Interface VPC Endpoint .

  • The URL that you get from a call to CreatePresignedDomainUrl has a default timeout of 5 minutes. You can configure this value using ExpiresInSeconds. If you try to use the URL after the timeout limit expires, you are directed to the Amazon Web Services console sign-in page.

  • The JupyterLab session default expiration time is 12 hours. You can configure this value using SessionExpirationDurationInSeconds.

" - }, - "CreatePresignedMlflowAppUrl":{ - "name":"CreatePresignedMlflowAppUrl", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreatePresignedMlflowAppUrlRequest"}, - "output":{"shape":"CreatePresignedMlflowAppUrlResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Returns a presigned URL that you can use to connect to the MLflow UI attached to your MLflow App. For more information, see Launch the MLflow UI using a presigned URL.

" - }, - "CreatePresignedMlflowTrackingServerUrl":{ - "name":"CreatePresignedMlflowTrackingServerUrl", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreatePresignedMlflowTrackingServerUrlRequest"}, - "output":{"shape":"CreatePresignedMlflowTrackingServerUrlResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Returns a presigned URL that you can use to connect to the MLflow UI attached to your tracking server. For more information, see Launch the MLflow UI using a presigned URL.

" - }, - "CreatePresignedNotebookInstanceUrl":{ - "name":"CreatePresignedNotebookInstanceUrl", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreatePresignedNotebookInstanceUrlInput"}, - "output":{"shape":"CreatePresignedNotebookInstanceUrlOutput"}, - "documentation":"

Returns a URL that you can use to connect to the Jupyter server from a notebook instance. In the SageMaker AI console, when you choose Open next to a notebook instance, SageMaker AI opens a new tab showing the Jupyter server home page from the notebook instance. The console uses this API to get the URL and show the page.

The IAM role or user used to call this API defines the permissions to access the notebook instance. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the notebook instance.

You can restrict access to this API and to the URL that it returns to a list of IP addresses that you specify. Use the NotIpAddress condition operator and the aws:SourceIP condition context key to specify the list of IP addresses that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address.

The URL that you get from a call to CreatePresignedNotebookInstanceUrl is valid only for 5 minutes. If you try to use the URL after the 5-minute limit expires, you are directed to the Amazon Web Services console sign-in page.

" - }, - "CreateProcessingJob":{ - "name":"CreateProcessingJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateProcessingJobRequest"}, - "output":{"shape":"CreateProcessingJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates a processing job.

" - }, - "CreateProject":{ - "name":"CreateProject", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateProjectInput"}, - "output":{"shape":"CreateProjectOutput"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates a machine learning (ML) project that can contain one or more templates that set up an ML pipeline from training to deploying an approved model.

" - }, - "CreateSpace":{ - "name":"CreateSpace", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateSpaceRequest"}, - "output":{"shape":"CreateSpaceResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates a private space or a space used for real time collaboration in a domain.

" - }, - "CreateStudioLifecycleConfig":{ - "name":"CreateStudioLifecycleConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateStudioLifecycleConfigRequest"}, - "output":{"shape":"CreateStudioLifecycleConfigResponse"}, - "errors":[ - {"shape":"ResourceInUse"} - ], - "documentation":"

Creates a new Amazon SageMaker AI Studio Lifecycle Configuration.

" - }, - "CreateTrainingJob":{ - "name":"CreateTrainingJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateTrainingJobRequest"}, - "output":{"shape":"CreateTrainingJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Starts a model training job. After training completes, SageMaker saves the resulting model artifacts to an Amazon S3 location that you specify.

If you choose to host your model using SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts in a machine learning service other than SageMaker, provided that you know how to use them for inference.

In the request body, you provide the following:

  • AlgorithmSpecification - Identifies the training algorithm to use.

  • HyperParameters - Specify these algorithm-specific parameters to enable the estimation of model parameters during training. Hyperparameters can be tuned to optimize this learning process. For a list of hyperparameters for each training algorithm provided by SageMaker, see Algorithms.

    Do not include any security-sensitive information including account access IDs, secrets, or tokens in any hyperparameter fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request hyperparameter variable or plain text fields.

  • InputDataConfig - Describes the input required by the training job and the Amazon S3, EFS, or FSx location where it is stored.

  • OutputDataConfig - Identifies the Amazon S3 bucket where you want SageMaker to save the results of model training.

  • ResourceConfig - Identifies the resources, ML compute instances, and ML storage volumes to deploy for model training. In distributed training, you specify more than one instance.

  • EnableManagedSpotTraining - Optimize the cost of training machine learning models by up to 80% by using Amazon EC2 Spot instances. For more information, see Managed Spot Training.

  • RoleArn - The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during model training. You must grant this role the necessary permissions so that SageMaker can successfully complete model training.

  • StoppingCondition - To help cap training costs, use MaxRuntimeInSeconds to set a time limit for training. Use MaxWaitTimeInSeconds to specify how long a managed spot training job has to complete.

  • Environment - The environment variables to set in the Docker container.

    Do not include any security-sensitive information including account access IDs, secrets, or tokens in any environment fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request environment variable or plain text fields.

  • RetryStrategy - The number of times to retry the job when the job fails due to an InternalServerError.

For more information about SageMaker, see How It Works.

" - }, - "CreateTrainingPlan":{ - "name":"CreateTrainingPlan", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateTrainingPlanRequest"}, - "output":{"shape":"CreateTrainingPlanResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates a new training plan in SageMaker to reserve compute capacity.

Amazon SageMaker Training Plan is a capability within SageMaker that allows customers to reserve and manage GPU capacity for large-scale AI model training. It provides a way to secure predictable access to computational resources within specific timelines and budgets, without the need to manage underlying infrastructure.

How it works

Plans can be created for specific resources such as SageMaker Training Jobs or SageMaker HyperPod clusters, automatically provisioning resources, setting up infrastructure, executing workloads, and handling infrastructure failures.

Plan creation workflow

  • Users search for available plan offerings based on their requirements (e.g., instance type, count, start time, duration) using the SearchTrainingPlanOfferings API operation.

  • They create a plan that best matches their needs using the ID of the plan offering they want to use.

  • After successful upfront payment, the plan's status becomes Scheduled.

  • The plan can be used to:

    • Queue training jobs.

    • Allocate to an instance group of a SageMaker HyperPod cluster.

  • When the plan start date arrives, it becomes Active. Based on available reserved capacity:

    • Training jobs are launched.

    • Instance groups are provisioned.

Plan composition

A plan can consist of one or more Reserved Capacities, each defined by a specific instance type, quantity, Availability Zone, duration, and start and end times. For more information about Reserved Capacity, see ReservedCapacitySummary .

" - }, - "CreateTransformJob":{ - "name":"CreateTransformJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateTransformJobRequest"}, - "output":{"shape":"CreateTransformJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Starts a transform job. A transform job uses a trained model to get inferences on a dataset and saves these results to an Amazon S3 location that you specify.

To perform batch transformations, you create a transform job and use the data that you have readily available.

In the request body, you provide the following:

  • TransformJobName - Identifies the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

  • ModelName - Identifies the model to use. ModelName must be the name of an existing Amazon SageMaker model in the same Amazon Web Services Region and Amazon Web Services account. For information on creating a model, see CreateModel.

  • TransformInput - Describes the dataset to be transformed and the Amazon S3 location where it is stored.

  • TransformOutput - Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

  • TransformResources - Identifies the ML compute instances and AMI image versions for the transform job.

For more information about how batch transformation works, see Batch Transform.

" - }, - "CreateTrial":{ - "name":"CreateTrial", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateTrialRequest"}, - "output":{"shape":"CreateTrialResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates an SageMaker trial. A trial is a set of steps called trial components that produce a machine learning model. A trial is part of a single SageMaker experiment.

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.

You can add tags to a trial and then use the Search API to search for the tags.

To get a list of all your trials, call the ListTrials API. To view a trial's properties, call the DescribeTrial API. To create a trial component, call the CreateTrialComponent API.

" - }, - "CreateTrialComponent":{ - "name":"CreateTrialComponent", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateTrialComponentRequest"}, - "output":{"shape":"CreateTrialComponentResponse"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates a trial component, which is a stage of a machine learning trial. A trial is composed of one or more trial components. A trial component can be used in multiple trials.

Trial components include pre-processing jobs, training jobs, and batch transform jobs.

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.

You can add tags to a trial component and then use the Search API to search for the tags.

" - }, - "CreateUserProfile":{ - "name":"CreateUserProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateUserProfileRequest"}, - "output":{"shape":"CreateUserProfileResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates a user profile. A user profile represents a single user within a domain, and is the main way to reference a \"person\" for the purposes of sharing, reporting, and other user-oriented features. This entity is created when a user onboards to a domain. If an administrator invites a person by email or imports them from IAM Identity Center, a user profile is automatically created. A user profile is the primary holder of settings for an individual user and has a reference to the user's private Amazon Elastic File System home directory.

" - }, - "CreateWorkforce":{ - "name":"CreateWorkforce", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateWorkforceRequest"}, - "output":{"shape":"CreateWorkforceResponse"}, - "documentation":"

Use this operation to create a workforce. This operation will return an error if a workforce already exists in the Amazon Web Services Region that you specify. You can only create one workforce in each Amazon Web Services Region per Amazon Web Services account.

If you want to create a new workforce in an Amazon Web Services Region where a workforce already exists, use the DeleteWorkforce API operation to delete the existing workforce and then use CreateWorkforce to create a new workforce.

To create a private workforce using Amazon Cognito, you must specify a Cognito user pool in CognitoConfig. You can also create an Amazon Cognito workforce using the Amazon SageMaker console. For more information, see Create a Private Workforce (Amazon Cognito).

To create a private workforce using your own OIDC Identity Provider (IdP), specify your IdP configuration in OidcConfig. Your OIDC IdP must support groups because groups are used by Ground Truth and Amazon A2I to create work teams. For more information, see Create a Private Workforce (OIDC IdP).

" - }, - "CreateWorkteam":{ - "name":"CreateWorkteam", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateWorkteamRequest"}, - "output":{"shape":"CreateWorkteamResponse"}, - "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Creates a new work team for labeling your data. A work team is defined by one or more Amazon Cognito user pools. You must first create the user pools before you can create a work team.

You cannot create more than 25 work teams in an account and region.

" - }, - "DeleteAIBenchmarkJob":{ - "name":"DeleteAIBenchmarkJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteAIBenchmarkJobRequest"}, - "output":{"shape":"DeleteAIBenchmarkJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Deletes the specified AI benchmark job.

" - }, - "DeleteAIRecommendationJob":{ - "name":"DeleteAIRecommendationJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteAIRecommendationJobRequest"}, - "output":{"shape":"DeleteAIRecommendationJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Deletes the specified AI recommendation job.

" - }, - "DeleteAIWorkloadConfig":{ - "name":"DeleteAIWorkloadConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteAIWorkloadConfigRequest"}, - "output":{"shape":"DeleteAIWorkloadConfigResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"} - ], - "documentation":"

Deletes the specified AI workload configuration. You cannot delete a configuration that is referenced by an active benchmark job.

" - }, - "DeleteAction":{ - "name":"DeleteAction", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteActionRequest"}, - "output":{"shape":"DeleteActionResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Deletes an action.

" - }, - "DeleteAlgorithm":{ - "name":"DeleteAlgorithm", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteAlgorithmInput"}, - "errors":[ - {"shape":"ConflictException"} - ], - "documentation":"

Removes the specified algorithm from your account.

" - }, - "DeleteApp":{ - "name":"DeleteApp", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteAppRequest"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"} - ], - "documentation":"

Used to stop and delete an app.

" - }, - "DeleteAppImageConfig":{ - "name":"DeleteAppImageConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteAppImageConfigRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Deletes an AppImageConfig.

" - }, - "DeleteArtifact":{ - "name":"DeleteArtifact", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteArtifactRequest"}, - "output":{"shape":"DeleteArtifactResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Deletes an artifact. Either ArtifactArn or Source must be specified.

" - }, - "DeleteAssociation":{ - "name":"DeleteAssociation", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteAssociationRequest"}, - "output":{"shape":"DeleteAssociationResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Deletes an association.

" - }, - "DeleteCluster":{ - "name":"DeleteCluster", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteClusterRequest"}, - "output":{"shape":"DeleteClusterResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ], - "documentation":"

Delete a SageMaker HyperPod cluster.

" - }, - "DeleteClusterSchedulerConfig":{ - "name":"DeleteClusterSchedulerConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteClusterSchedulerConfigRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Deletes the cluster policy of the cluster.

" - }, - "DeleteCodeRepository":{ - "name":"DeleteCodeRepository", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteCodeRepositoryInput"}, - "documentation":"

Deletes the specified Git repository from your account.

" - }, - "DeleteCompilationJob":{ - "name":"DeleteCompilationJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteCompilationJobRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Deletes the specified compilation job. This action deletes only the compilation job resource in Amazon SageMaker AI. It doesn't delete other resources that are related to that job, such as the model artifacts that the job creates, the compilation logs in CloudWatch, the compiled model, or the IAM role.

You can delete a compilation job only if its current status is COMPLETED, FAILED, or STOPPED. If the job status is STARTING or INPROGRESS, stop the job, and then delete it after its status becomes STOPPED.

" - }, - "DeleteComputeQuota":{ - "name":"DeleteComputeQuota", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteComputeQuotaRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Deletes the compute allocation from the cluster.

" - }, - "DeleteContext":{ - "name":"DeleteContext", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteContextRequest"}, - "output":{"shape":"DeleteContextResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Deletes an context.

" - }, - "DeleteDataQualityJobDefinition":{ - "name":"DeleteDataQualityJobDefinition", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteDataQualityJobDefinitionRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Deletes a data quality monitoring job definition.

" - }, - "DeleteDeviceFleet":{ - "name":"DeleteDeviceFleet", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteDeviceFleetRequest"}, - "errors":[ - {"shape":"ResourceInUse"} - ], - "documentation":"

Deletes a fleet.

" - }, - "DeleteDomain":{ - "name":"DeleteDomain", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteDomainRequest"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"} - ], - "documentation":"

Used to delete a domain. If you onboarded with IAM mode, you will need to delete your domain to onboard again using IAM Identity Center. Use with caution. All of the members of the domain will lose access to their EFS volume, including data, notebooks, and other artifacts.

" - }, - "DeleteEdgeDeploymentPlan":{ - "name":"DeleteEdgeDeploymentPlan", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteEdgeDeploymentPlanRequest"}, - "errors":[ - {"shape":"ResourceInUse"} - ], - "documentation":"

Deletes an edge deployment plan if (and only if) all the stages in the plan are inactive or there are no stages in the plan.

" - }, - "DeleteEdgeDeploymentStage":{ - "name":"DeleteEdgeDeploymentStage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteEdgeDeploymentStageRequest"}, - "errors":[ - {"shape":"ResourceInUse"} - ], - "documentation":"

Delete a stage in an edge deployment plan if (and only if) the stage is inactive.

" - }, - "DeleteEndpoint":{ - "name":"DeleteEndpoint", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteEndpointInput"}, - "documentation":"

Deletes an endpoint. SageMaker frees up all of the resources that were deployed when the endpoint was created.

SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't need to use the RevokeGrant API call.

When you delete your endpoint, SageMaker asynchronously deletes associated endpoint resources such as KMS key grants. You might still see these resources in your account for a few minutes after deleting your endpoint. Do not delete or revoke the permissions for your ExecutionRoleArn , otherwise SageMaker cannot delete these resources.

" - }, - "DeleteEndpointConfig":{ - "name":"DeleteEndpointConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteEndpointConfigInput"}, - "documentation":"

Deletes an endpoint configuration. The DeleteEndpointConfig API deletes only the specified configuration. It does not delete endpoints created using the configuration.

You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. If you delete the EndpointConfig of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges.

" - }, - "DeleteExperiment":{ - "name":"DeleteExperiment", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteExperimentRequest"}, - "output":{"shape":"DeleteExperimentResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Deletes an SageMaker experiment. All trials associated with the experiment must be deleted first. Use the ListTrials API to get a list of the trials associated with the experiment.

" - }, - "DeleteFeatureGroup":{ - "name":"DeleteFeatureGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteFeatureGroupRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Delete the FeatureGroup and any data that was written to the OnlineStore of the FeatureGroup. Data cannot be accessed from the OnlineStore immediately after DeleteFeatureGroup is called.

Data written into the OfflineStore will not be deleted. The Amazon Web Services Glue database and tables that are automatically created for your OfflineStore are not deleted.

Note that it can take approximately 10-15 minutes to delete an OnlineStore FeatureGroup with the InMemory StorageType.

" - }, - "DeleteFlowDefinition":{ - "name":"DeleteFlowDefinition", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteFlowDefinitionRequest"}, - "output":{"shape":"DeleteFlowDefinitionResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"} - ], - "documentation":"

Deletes the specified flow definition.

" - }, - "DeleteHub":{ - "name":"DeleteHub", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteHubRequest"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"} - ], - "documentation":"

Delete a hub.

" - }, - "DeleteHubContent":{ - "name":"DeleteHubContent", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteHubContentRequest"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"} - ], - "documentation":"

Delete the contents of a hub.

" - }, - "DeleteHubContentReference":{ - "name":"DeleteHubContentReference", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteHubContentReferenceRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Delete a hub content reference in order to remove a model from a private hub.

" - }, - "DeleteHumanTaskUi":{ - "name":"DeleteHumanTaskUi", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteHumanTaskUiRequest"}, - "output":{"shape":"DeleteHumanTaskUiResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Use this operation to delete a human task user interface (worker task template).

To see a list of human task user interfaces (work task templates) in your account, use ListHumanTaskUis. When you delete a worker task template, it no longer appears when you call ListHumanTaskUis.

" - }, - "DeleteHyperParameterTuningJob":{ - "name":"DeleteHyperParameterTuningJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteHyperParameterTuningJobRequest"}, - "documentation":"

Deletes a hyperparameter tuning job. The DeleteHyperParameterTuningJob API deletes only the tuning job entry that was created in SageMaker when you called the CreateHyperParameterTuningJob API. It does not delete training jobs, artifacts, or the IAM role that you specified when creating the model.

" - }, - "DeleteImage":{ - "name":"DeleteImage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteImageRequest"}, - "output":{"shape":"DeleteImageResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"} - ], - "documentation":"

Deletes a SageMaker AI image and all versions of the image. The container images aren't deleted.

" - }, - "DeleteImageVersion":{ - "name":"DeleteImageVersion", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteImageVersionRequest"}, - "output":{"shape":"DeleteImageVersionResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"} - ], - "documentation":"

Deletes a version of a SageMaker AI image. The container image the version represents isn't deleted.

" - }, - "DeleteInferenceComponent":{ - "name":"DeleteInferenceComponent", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteInferenceComponentInput"}, - "documentation":"

Deletes an inference component.

" - }, - "DeleteInferenceExperiment":{ - "name":"DeleteInferenceExperiment", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteInferenceExperimentRequest"}, - "output":{"shape":"DeleteInferenceExperimentResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ], - "documentation":"

Deletes an inference experiment.

This operation does not delete your endpoint, variants, or any underlying resources. This operation only deletes the metadata of your experiment.

" - }, - "DeleteJob":{ - "name":"DeleteJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteJobRequest"}, - "output":{"shape":"DeleteJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"} - ], - "documentation":"

Deletes a job. This operation is idempotent. If the job is currently running, you must stop it before deleting it by calling StopJob.

The following operations are related to DeleteJob:

  • CreateJob

  • StopJob

  • DescribeJob

", - "idempotent":true - }, - "DeleteMlflowApp":{ - "name":"DeleteMlflowApp", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteMlflowAppRequest"}, - "output":{"shape":"DeleteMlflowAppResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Deletes an MLflow App.

" - }, - "DeleteMlflowTrackingServer":{ - "name":"DeleteMlflowTrackingServer", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteMlflowTrackingServerRequest"}, - "output":{"shape":"DeleteMlflowTrackingServerResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Deletes an MLflow Tracking Server. For more information, see Clean up MLflow resources.

" - }, - "DeleteModel":{ - "name":"DeleteModel", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteModelInput"}, - "documentation":"

Deletes a model. The DeleteModel API deletes only the model entry that was created in SageMaker when you called the CreateModel API. It does not delete model artifacts, inference code, or the IAM role that you specified when creating the model.

" - }, - "DeleteModelBiasJobDefinition":{ - "name":"DeleteModelBiasJobDefinition", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteModelBiasJobDefinitionRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Deletes an Amazon SageMaker AI model bias job definition.

" - }, - "DeleteModelCard":{ - "name":"DeleteModelCard", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteModelCardRequest"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ], - "documentation":"

Deletes an Amazon SageMaker Model Card.

" - }, - "DeleteModelExplainabilityJobDefinition":{ - "name":"DeleteModelExplainabilityJobDefinition", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteModelExplainabilityJobDefinitionRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Deletes an Amazon SageMaker AI model explainability job definition.

" - }, - "DeleteModelPackage":{ - "name":"DeleteModelPackage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteModelPackageInput"}, - "errors":[ - {"shape":"ConflictException"} - ], - "documentation":"

Deletes a model package.

A model package is used to create SageMaker models or list on Amazon Web Services Marketplace. Buyers can subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker.

" - }, - "DeleteModelPackageGroup":{ - "name":"DeleteModelPackageGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteModelPackageGroupInput"}, - "errors":[ - {"shape":"ConflictException"} - ], - "documentation":"

Deletes the specified model group.

" - }, - "DeleteModelPackageGroupPolicy":{ - "name":"DeleteModelPackageGroupPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteModelPackageGroupPolicyInput"}, - "documentation":"

Deletes a model group resource policy.

" - }, - "DeleteModelQualityJobDefinition":{ - "name":"DeleteModelQualityJobDefinition", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteModelQualityJobDefinitionRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Deletes the secified model quality monitoring job definition.

" - }, - "DeleteMonitoringSchedule":{ - "name":"DeleteMonitoringSchedule", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteMonitoringScheduleRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Deletes a monitoring schedule. Also stops the schedule had not already been stopped. This does not delete the job execution history of the monitoring schedule.

" - }, - "DeleteNotebookInstance":{ - "name":"DeleteNotebookInstance", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteNotebookInstanceInput"}, - "documentation":"

Deletes an SageMaker AI notebook instance. Before you can delete a notebook instance, you must call the StopNotebookInstance API.

When you delete a notebook instance, you lose all of your data. SageMaker AI removes the ML compute instance, and deletes the ML storage volume and the network interface associated with the notebook instance.

" - }, - "DeleteNotebookInstanceLifecycleConfig":{ - "name":"DeleteNotebookInstanceLifecycleConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteNotebookInstanceLifecycleConfigInput"}, - "documentation":"

Deletes a notebook instance lifecycle configuration.

" - }, - "DeleteOptimizationJob":{ - "name":"DeleteOptimizationJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteOptimizationJobRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Deletes an optimization job.

" - }, - "DeletePartnerApp":{ - "name":"DeletePartnerApp", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeletePartnerAppRequest"}, - "output":{"shape":"DeletePartnerAppResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ], - "documentation":"

Deletes a SageMaker Partner AI App.

" - }, - "DeletePipeline":{ - "name":"DeletePipeline", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeletePipelineRequest"}, - "output":{"shape":"DeletePipelineResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ], - "documentation":"

Deletes a pipeline if there are no running instances of the pipeline. To delete a pipeline, you must stop all running instances of the pipeline using the StopPipelineExecution API. When you delete a pipeline, all instances of the pipeline are deleted.

" - }, - "DeleteProcessingJob":{ - "name":"DeleteProcessingJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteProcessingJobRequest"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"} - ], - "documentation":"

Deletes a processing job. After Amazon SageMaker deletes a processing job, all of the metadata for the processing job is lost. You can delete only processing jobs that are in a terminal state (Stopped, Failed, or Completed). You cannot delete a job that is in the InProgress or Stopping state. After deleting the job, you can reuse its name to create another processing job.

" - }, - "DeleteProject":{ - "name":"DeleteProject", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteProjectInput"}, - "errors":[ - {"shape":"ConflictException"} - ], - "documentation":"

Delete the specified project.

" - }, - "DeleteSpace":{ - "name":"DeleteSpace", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteSpaceRequest"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"} - ], - "documentation":"

Used to delete a space.

" - }, - "DeleteStudioLifecycleConfig":{ - "name":"DeleteStudioLifecycleConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteStudioLifecycleConfigRequest"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"} - ], - "documentation":"

Deletes the Amazon SageMaker AI Studio Lifecycle Configuration. In order to delete the Lifecycle Configuration, there must be no running apps using the Lifecycle Configuration. You must also remove the Lifecycle Configuration from UserSettings in all Domains and UserProfiles.

" - }, - "DeleteTags":{ - "name":"DeleteTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteTagsInput"}, - "output":{"shape":"DeleteTagsOutput"}, - "documentation":"

Deletes the specified tags from an SageMaker resource.

To list a resource's tags, use the ListTags API.

When you call this API to delete tags from a hyperparameter tuning job, the deleted tags are not removed from training jobs that the hyperparameter tuning job launched before you called this API.

When you call this API to delete tags from a SageMaker Domain or User Profile, the deleted tags are not removed from Apps that the SageMaker Domain or User Profile launched before you called this API.

" - }, - "DeleteTrainingJob":{ - "name":"DeleteTrainingJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteTrainingJobRequest"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"} - ], - "documentation":"

Deletes a training job. After SageMaker deletes a training job, all of the metadata for the training job is lost. You can delete only training jobs that are in a terminal state (Stopped, Failed, or Completed) and don't retain an Available managed warm pool. You cannot delete a job that is in the InProgress or Stopping state. After deleting the job, you can reuse its name to create another training job.

" - }, - "DeleteTrial":{ - "name":"DeleteTrial", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteTrialRequest"}, - "output":{"shape":"DeleteTrialResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Deletes the specified trial. All trial components that make up the trial must be deleted first. Use the DescribeTrialComponent API to get the list of trial components.

" - }, - "DeleteTrialComponent":{ - "name":"DeleteTrialComponent", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteTrialComponentRequest"}, - "output":{"shape":"DeleteTrialComponentResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Deletes the specified trial component. A trial component must be disassociated from all trials before the trial component can be deleted. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.

" - }, - "DeleteUserProfile":{ - "name":"DeleteUserProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteUserProfileRequest"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"} - ], - "documentation":"

Deletes a user profile. When a user profile is deleted, the user loses access to their EFS volume, including data, notebooks, and other artifacts.

" - }, - "DeleteWorkforce":{ - "name":"DeleteWorkforce", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteWorkforceRequest"}, - "output":{"shape":"DeleteWorkforceResponse"}, - "documentation":"

Use this operation to delete a workforce.

If you want to create a new workforce in an Amazon Web Services Region where a workforce already exists, use this operation to delete the existing workforce and then use CreateWorkforce to create a new workforce.

If a private workforce contains one or more work teams, you must use the DeleteWorkteam operation to delete all work teams before you delete the workforce. If you try to delete a workforce that contains one or more work teams, you will receive a ResourceInUse error.

" - }, - "DeleteWorkteam":{ - "name":"DeleteWorkteam", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteWorkteamRequest"}, - "output":{"shape":"DeleteWorkteamResponse"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Deletes an existing work team. This operation can't be undone.

" - }, - "DeregisterDevices":{ - "name":"DeregisterDevices", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeregisterDevicesRequest"}, - "documentation":"

Deregisters the specified devices. After you deregister a device, you will need to re-register the devices.

" - }, - "DescribeAIBenchmarkJob":{ - "name":"DescribeAIBenchmarkJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeAIBenchmarkJobRequest"}, - "output":{"shape":"DescribeAIBenchmarkJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Returns details of an AI benchmark job, including its status, configuration, target endpoint, and timing information.

" - }, - "DescribeAIRecommendationJob":{ - "name":"DescribeAIRecommendationJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeAIRecommendationJobRequest"}, - "output":{"shape":"DescribeAIRecommendationJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Returns details of an AI recommendation job, including its status, model source, performance targets, optimization recommendations, and deployment configurations.

" - }, - "DescribeAIWorkloadConfig":{ - "name":"DescribeAIWorkloadConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeAIWorkloadConfigRequest"}, - "output":{"shape":"DescribeAIWorkloadConfigResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Returns details of an AI workload configuration, including the dataset configuration, benchmark tool settings, tags, and creation time.

" - }, - "DescribeAction":{ - "name":"DescribeAction", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeActionRequest"}, - "output":{"shape":"DescribeActionResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Describes an action.

" - }, - "DescribeAlgorithm":{ - "name":"DescribeAlgorithm", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeAlgorithmInput"}, - "output":{"shape":"DescribeAlgorithmOutput"}, - "documentation":"

Returns a description of the specified algorithm that is in your account.

" - }, - "DescribeApp":{ - "name":"DescribeApp", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeAppRequest"}, - "output":{"shape":"DescribeAppResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Describes the app.

" - }, - "DescribeAppImageConfig":{ - "name":"DescribeAppImageConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeAppImageConfigRequest"}, - "output":{"shape":"DescribeAppImageConfigResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Describes an AppImageConfig.

" - }, - "DescribeArtifact":{ - "name":"DescribeArtifact", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeArtifactRequest"}, - "output":{"shape":"DescribeArtifactResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Describes an artifact.

" - }, - "DescribeAutoMLJob":{ - "name":"DescribeAutoMLJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeAutoMLJobRequest"}, - "output":{"shape":"DescribeAutoMLJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Returns information about an AutoML job created by calling CreateAutoMLJob.

AutoML jobs created by calling CreateAutoMLJobV2 cannot be described by DescribeAutoMLJob.

" - }, - "DescribeAutoMLJobV2":{ - "name":"DescribeAutoMLJobV2", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeAutoMLJobV2Request"}, - "output":{"shape":"DescribeAutoMLJobV2Response"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Returns information about an AutoML job created by calling CreateAutoMLJobV2 or CreateAutoMLJob.

" - }, - "DescribeCluster":{ - "name":"DescribeCluster", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeClusterRequest"}, - "output":{"shape":"DescribeClusterResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Retrieves information of a SageMaker HyperPod cluster.

" - }, - "DescribeClusterEvent":{ - "name":"DescribeClusterEvent", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeClusterEventRequest"}, - "output":{"shape":"DescribeClusterEventResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Retrieves detailed information about a specific event for a given HyperPod cluster. This functionality is only supported when the NodeProvisioningMode is set to Continuous.

" - }, - "DescribeClusterNode":{ - "name":"DescribeClusterNode", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeClusterNodeRequest"}, - "output":{"shape":"DescribeClusterNodeResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Retrieves information of a node (also called a instance interchangeably) of a SageMaker HyperPod cluster.

" - }, - "DescribeClusterSchedulerConfig":{ - "name":"DescribeClusterSchedulerConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeClusterSchedulerConfigRequest"}, - "output":{"shape":"DescribeClusterSchedulerConfigResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Description of the cluster policy. This policy is used for task prioritization and fair-share allocation. This helps prioritize critical workloads and distributes idle compute across entities.

" - }, - "DescribeCodeRepository":{ - "name":"DescribeCodeRepository", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeCodeRepositoryInput"}, - "output":{"shape":"DescribeCodeRepositoryOutput"}, - "documentation":"

Gets details about the specified Git repository.

" - }, - "DescribeCompilationJob":{ - "name":"DescribeCompilationJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeCompilationJobRequest"}, - "output":{"shape":"DescribeCompilationJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Returns information about a model compilation job.

To create a model compilation job, use CreateCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.

" - }, - "DescribeComputeQuota":{ - "name":"DescribeComputeQuota", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeComputeQuotaRequest"}, - "output":{"shape":"DescribeComputeQuotaResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Description of the compute allocation definition.

" - }, - "DescribeContext":{ - "name":"DescribeContext", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeContextRequest"}, - "output":{"shape":"DescribeContextResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Describes a context.

" - }, - "DescribeDataQualityJobDefinition":{ - "name":"DescribeDataQualityJobDefinition", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeDataQualityJobDefinitionRequest"}, - "output":{"shape":"DescribeDataQualityJobDefinitionResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Gets the details of a data quality monitoring job definition.

" - }, - "DescribeDevice":{ - "name":"DescribeDevice", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeDeviceRequest"}, - "output":{"shape":"DescribeDeviceResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Describes the device.

" - }, - "DescribeDeviceFleet":{ - "name":"DescribeDeviceFleet", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeDeviceFleetRequest"}, - "output":{"shape":"DescribeDeviceFleetResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

A description of the fleet the device belongs to.

" - }, - "DescribeDomain":{ - "name":"DescribeDomain", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeDomainRequest"}, - "output":{"shape":"DescribeDomainResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

The description of the domain.

" - }, - "DescribeEdgeDeploymentPlan":{ - "name":"DescribeEdgeDeploymentPlan", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeEdgeDeploymentPlanRequest"}, - "output":{"shape":"DescribeEdgeDeploymentPlanResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Describes an edge deployment plan with deployment status per stage.

" - }, - "DescribeEdgePackagingJob":{ - "name":"DescribeEdgePackagingJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeEdgePackagingJobRequest"}, - "output":{"shape":"DescribeEdgePackagingJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

A description of edge packaging jobs.

" - }, - "DescribeEndpoint":{ - "name":"DescribeEndpoint", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeEndpointInput"}, - "output":{"shape":"DescribeEndpointOutput"}, - "documentation":"

Returns the description of an endpoint.

" - }, - "DescribeEndpointConfig":{ - "name":"DescribeEndpointConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeEndpointConfigInput"}, - "output":{"shape":"DescribeEndpointConfigOutput"}, - "documentation":"

Returns the description of an endpoint configuration created using the CreateEndpointConfig API.

" - }, - "DescribeExperiment":{ - "name":"DescribeExperiment", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeExperimentRequest"}, - "output":{"shape":"DescribeExperimentResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Provides a list of an experiment's properties.

" - }, - "DescribeFeatureGroup":{ - "name":"DescribeFeatureGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeFeatureGroupRequest"}, - "output":{"shape":"DescribeFeatureGroupResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Use this operation to describe a FeatureGroup. The response includes information on the creation time, FeatureGroup name, the unique identifier for each FeatureGroup, and more.

" - }, - "DescribeFeatureMetadata":{ - "name":"DescribeFeatureMetadata", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeFeatureMetadataRequest"}, - "output":{"shape":"DescribeFeatureMetadataResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Shows the metadata for a feature within a feature group.

" - }, - "DescribeFlowDefinition":{ - "name":"DescribeFlowDefinition", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeFlowDefinitionRequest"}, - "output":{"shape":"DescribeFlowDefinitionResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Returns information about the specified flow definition.

" - }, - "DescribeHub":{ - "name":"DescribeHub", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeHubRequest"}, - "output":{"shape":"DescribeHubResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Describes a hub.

" - }, - "DescribeHubContent":{ - "name":"DescribeHubContent", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeHubContentRequest"}, - "output":{"shape":"DescribeHubContentResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Describe the content of a hub.

" - }, - "DescribeHumanTaskUi":{ - "name":"DescribeHumanTaskUi", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeHumanTaskUiRequest"}, - "output":{"shape":"DescribeHumanTaskUiResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Returns information about the requested human task user interface (worker task template).

" - }, - "DescribeHyperParameterTuningJob":{ - "name":"DescribeHyperParameterTuningJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeHyperParameterTuningJobRequest"}, - "output":{"shape":"DescribeHyperParameterTuningJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Returns a description of a hyperparameter tuning job, depending on the fields selected. These fields can include the name, Amazon Resource Name (ARN), job status of your tuning job and more.

" - }, - "DescribeImage":{ - "name":"DescribeImage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeImageRequest"}, - "output":{"shape":"DescribeImageResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Describes a SageMaker AI image.

" - }, - "DescribeImageVersion":{ - "name":"DescribeImageVersion", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeImageVersionRequest"}, - "output":{"shape":"DescribeImageVersionResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Describes a version of a SageMaker AI image.

" - }, - "DescribeInferenceComponent":{ - "name":"DescribeInferenceComponent", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeInferenceComponentInput"}, - "output":{"shape":"DescribeInferenceComponentOutput"}, - "documentation":"

Returns information about an inference component.

" - }, - "DescribeInferenceExperiment":{ - "name":"DescribeInferenceExperiment", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeInferenceExperimentRequest"}, - "output":{"shape":"DescribeInferenceExperimentResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Returns details about an inference experiment.

" - }, - "DescribeInferenceRecommendationsJob":{ - "name":"DescribeInferenceRecommendationsJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeInferenceRecommendationsJobRequest"}, - "output":{"shape":"DescribeInferenceRecommendationsJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Provides the results of the Inference Recommender job. One or more recommendation jobs are returned.

" - }, - "DescribeJob":{ - "name":"DescribeJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeJobRequest"}, - "output":{"shape":"DescribeJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Returns detailed information about a job, including its current status, secondary status, configuration, and timestamps. Use SecondaryStatus for granular progress tracking and SecondaryStatusTransitions to see the full history of status changes with timestamps.

The following operations are related to DescribeJob:

  • CreateJob

  • ListJobs

  • StopJob

  • DeleteJob

", - "readonly":true - }, - "DescribeJobSchemaVersion":{ - "name":"DescribeJobSchemaVersion", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeJobSchemaVersionRequest"}, - "output":{"shape":"DescribeJobSchemaVersionResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Returns the JSON schema for a specified job category and schema version. Use this schema to validate your JobConfigDocument before calling CreateJob. If you don't specify a schema version, the latest version is returned. The schema defines required fields, allowed values, and constraints for the job configuration.

The following operations are related to DescribeJobSchemaVersion:

  • ListJobSchemaVersions

  • CreateJob

", - "readonly":true - }, - "DescribeLabelingJob":{ - "name":"DescribeLabelingJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeLabelingJobRequest"}, - "output":{"shape":"DescribeLabelingJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Gets information about a labeling job.

" - }, - "DescribeLineageGroup":{ - "name":"DescribeLineageGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeLineageGroupRequest"}, - "output":{"shape":"DescribeLineageGroupResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Provides a list of properties for the requested lineage group. For more information, see Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.

" - }, - "DescribeMlflowApp":{ - "name":"DescribeMlflowApp", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeMlflowAppRequest"}, - "output":{"shape":"DescribeMlflowAppResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Returns information about an MLflow App.

" - }, - "DescribeMlflowTrackingServer":{ - "name":"DescribeMlflowTrackingServer", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeMlflowTrackingServerRequest"}, - "output":{"shape":"DescribeMlflowTrackingServerResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Returns information about an MLflow Tracking Server.

" - }, - "DescribeModel":{ - "name":"DescribeModel", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeModelInput"}, - "output":{"shape":"DescribeModelOutput"}, - "documentation":"

Describes a model that you created using the CreateModel API.

" - }, - "DescribeModelBiasJobDefinition":{ - "name":"DescribeModelBiasJobDefinition", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeModelBiasJobDefinitionRequest"}, - "output":{"shape":"DescribeModelBiasJobDefinitionResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Returns a description of a model bias job definition.

" - }, - "DescribeModelCard":{ - "name":"DescribeModelCard", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeModelCardRequest"}, - "output":{"shape":"DescribeModelCardResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Describes the content, creation time, and security configuration of an Amazon SageMaker Model Card.

To retrieve only metadata about a model card without requiring kms:Decrypt permission on the associated customer-managed Amazon Web Services KMS key, set IncludedData to MetadataOnly. The default is AllData, which returns the full model card Content and requires kms:Decrypt permission when a customer-managed key is configured.

" - }, - "DescribeModelCardExportJob":{ - "name":"DescribeModelCardExportJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeModelCardExportJobRequest"}, - "output":{"shape":"DescribeModelCardExportJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Describes an Amazon SageMaker Model Card export job.

" - }, - "DescribeModelExplainabilityJobDefinition":{ - "name":"DescribeModelExplainabilityJobDefinition", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeModelExplainabilityJobDefinitionRequest"}, - "output":{"shape":"DescribeModelExplainabilityJobDefinitionResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Returns a description of a model explainability job definition.

" - }, - "DescribeModelPackage":{ - "name":"DescribeModelPackage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeModelPackageInput"}, - "output":{"shape":"DescribeModelPackageOutput"}, - "documentation":"

Returns a description of the specified model package, which is used to create SageMaker models or list them on Amazon Web Services Marketplace.

If you provided a KMS Key ID when you created your model package, you will see the KMS Decrypt API call in your CloudTrail logs when you use this API. To call this operation without requiring kms:Decrypt permission on the customer-managed key, set IncludedData to MetadataOnly; the response is returned with the embedded ModelCard.ModelCardContent field sanitized.

To create models in SageMaker, buyers can subscribe to model packages listed on Amazon Web Services Marketplace.

" - }, - "DescribeModelPackageGroup":{ - "name":"DescribeModelPackageGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeModelPackageGroupInput"}, - "output":{"shape":"DescribeModelPackageGroupOutput"}, - "documentation":"

Gets a description for the specified model group.

" - }, - "DescribeModelQualityJobDefinition":{ - "name":"DescribeModelQualityJobDefinition", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeModelQualityJobDefinitionRequest"}, - "output":{"shape":"DescribeModelQualityJobDefinitionResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Returns a description of a model quality job definition.

" - }, - "DescribeMonitoringSchedule":{ - "name":"DescribeMonitoringSchedule", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeMonitoringScheduleRequest"}, - "output":{"shape":"DescribeMonitoringScheduleResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Describes the schedule for a monitoring job.

" - }, - "DescribeNotebookInstance":{ - "name":"DescribeNotebookInstance", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeNotebookInstanceInput"}, - "output":{"shape":"DescribeNotebookInstanceOutput"}, - "documentation":"

Returns information about a notebook instance.

" - }, - "DescribeNotebookInstanceLifecycleConfig":{ - "name":"DescribeNotebookInstanceLifecycleConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeNotebookInstanceLifecycleConfigInput"}, - "output":{"shape":"DescribeNotebookInstanceLifecycleConfigOutput"}, - "documentation":"

Returns a description of a notebook instance lifecycle configuration.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

" - }, - "DescribeOptimizationJob":{ - "name":"DescribeOptimizationJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeOptimizationJobRequest"}, - "output":{"shape":"DescribeOptimizationJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Provides the properties of the specified optimization job.

" - }, - "DescribePartnerApp":{ - "name":"DescribePartnerApp", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribePartnerAppRequest"}, - "output":{"shape":"DescribePartnerAppResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Gets information about a SageMaker Partner AI App.

" - }, - "DescribePipeline":{ - "name":"DescribePipeline", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribePipelineRequest"}, - "output":{"shape":"DescribePipelineResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Describes the details of a pipeline.

" - }, - "DescribePipelineDefinitionForExecution":{ - "name":"DescribePipelineDefinitionForExecution", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribePipelineDefinitionForExecutionRequest"}, - "output":{"shape":"DescribePipelineDefinitionForExecutionResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Describes the details of an execution's pipeline definition.

" - }, - "DescribePipelineExecution":{ - "name":"DescribePipelineExecution", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribePipelineExecutionRequest"}, - "output":{"shape":"DescribePipelineExecutionResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Describes the details of a pipeline execution.

" - }, - "DescribeProcessingJob":{ - "name":"DescribeProcessingJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeProcessingJobRequest"}, - "output":{"shape":"DescribeProcessingJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Returns a description of a processing job.

" - }, - "DescribeProject":{ - "name":"DescribeProject", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeProjectInput"}, - "output":{"shape":"DescribeProjectOutput"}, - "documentation":"

Describes the details of a project.

" - }, - "DescribeReservedCapacity":{ - "name":"DescribeReservedCapacity", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeReservedCapacityRequest"}, - "output":{"shape":"DescribeReservedCapacityResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Retrieves details about a reserved capacity.

" - }, - "DescribeSpace":{ - "name":"DescribeSpace", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeSpaceRequest"}, - "output":{"shape":"DescribeSpaceResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Describes the space.

" - }, - "DescribeStudioLifecycleConfig":{ - "name":"DescribeStudioLifecycleConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeStudioLifecycleConfigRequest"}, - "output":{"shape":"DescribeStudioLifecycleConfigResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Describes the Amazon SageMaker AI Studio Lifecycle Configuration.

" - }, - "DescribeSubscribedWorkteam":{ - "name":"DescribeSubscribedWorkteam", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeSubscribedWorkteamRequest"}, - "output":{"shape":"DescribeSubscribedWorkteamResponse"}, - "documentation":"

Gets information about a work team provided by a vendor. It returns details about the subscription with a vendor in the Amazon Web Services Marketplace.

" - }, - "DescribeTrainingJob":{ - "name":"DescribeTrainingJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeTrainingJobRequest"}, - "output":{"shape":"DescribeTrainingJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Returns information about a training job.

Some of the attributes below only appear if the training job successfully starts. If the training job fails, TrainingJobStatus is Failed and, depending on the FailureReason, attributes like TrainingStartTime, TrainingTimeInSeconds, TrainingEndTime, and BillableTimeInSeconds may not be present in the response.

" - }, - "DescribeTrainingPlan":{ - "name":"DescribeTrainingPlan", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeTrainingPlanRequest"}, - "output":{"shape":"DescribeTrainingPlanResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Retrieves detailed information about a specific training plan.

" - }, - "DescribeTrainingPlanExtensionHistory":{ - "name":"DescribeTrainingPlanExtensionHistory", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeTrainingPlanExtensionHistoryRequest"}, - "output":{"shape":"DescribeTrainingPlanExtensionHistoryResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Retrieves the extension history for a specified training plan. The response includes details about each extension, such as the offering ID, start and end dates, status, payment status, and cost information.

" - }, - "DescribeTransformJob":{ - "name":"DescribeTransformJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeTransformJobRequest"}, - "output":{"shape":"DescribeTransformJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Returns information about a transform job.

" - }, - "DescribeTrial":{ - "name":"DescribeTrial", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeTrialRequest"}, - "output":{"shape":"DescribeTrialResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Provides a list of a trial's properties.

" - }, - "DescribeTrialComponent":{ - "name":"DescribeTrialComponent", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeTrialComponentRequest"}, - "output":{"shape":"DescribeTrialComponentResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Provides a list of a trials component's properties.

" - }, - "DescribeUserProfile":{ - "name":"DescribeUserProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeUserProfileRequest"}, - "output":{"shape":"DescribeUserProfileResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Describes a user profile. For more information, see CreateUserProfile.

" - }, - "DescribeWorkforce":{ - "name":"DescribeWorkforce", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeWorkforceRequest"}, - "output":{"shape":"DescribeWorkforceResponse"}, - "documentation":"

Lists private workforce information, including workforce name, Amazon Resource Name (ARN), and, if applicable, allowed IP address ranges (CIDRs). Allowable IP address ranges are the IP addresses that workers can use to access tasks.

This operation applies only to private workforces.

" - }, - "DescribeWorkteam":{ - "name":"DescribeWorkteam", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeWorkteamRequest"}, - "output":{"shape":"DescribeWorkteamResponse"}, - "documentation":"

Gets information about a specific work team. You can see information such as the creation date, the last updated date, membership information, and the work team's Amazon Resource Name (ARN).

" - }, - "DetachClusterNodeVolume":{ - "name":"DetachClusterNodeVolume", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DetachClusterNodeVolumeRequest"}, - "output":{"shape":"DetachClusterNodeVolumeResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Detaches your Amazon Elastic Block Store (Amazon EBS) volume from a node in your EKS orchestrated SageMaker HyperPod cluster.

This API works with the Amazon Elastic Block Store (Amazon EBS) Container Storage Interface (CSI) driver to manage the lifecycle of persistent storage in your HyperPod EKS clusters.

" - }, - "DisableSagemakerServicecatalogPortfolio":{ - "name":"DisableSagemakerServicecatalogPortfolio", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DisableSagemakerServicecatalogPortfolioInput"}, - "output":{"shape":"DisableSagemakerServicecatalogPortfolioOutput"}, - "documentation":"

Disables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.

" - }, - "DisassociateTrialComponent":{ - "name":"DisassociateTrialComponent", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DisassociateTrialComponentRequest"}, - "output":{"shape":"DisassociateTrialComponentResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Disassociates a trial component from a trial. This doesn't effect other trials the component is associated with. Before you can delete a component, you must disassociate the component from all trials it is associated with. To associate a trial component with a trial, call the AssociateTrialComponent API.

To get a list of the trials a component is associated with, use the Search API. Specify ExperimentTrialComponent for the Resource parameter. The list appears in the response under Results.TrialComponent.Parents.

" - }, - "EnableSagemakerServicecatalogPortfolio":{ - "name":"EnableSagemakerServicecatalogPortfolio", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"EnableSagemakerServicecatalogPortfolioInput"}, - "output":{"shape":"EnableSagemakerServicecatalogPortfolioOutput"}, - "documentation":"

Enables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.

" - }, - "ExtendTrainingPlan":{ - "name":"ExtendTrainingPlan", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ExtendTrainingPlanRequest"}, - "output":{"shape":"ExtendTrainingPlanResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Extends an existing training plan by purchasing an extension offering. This allows you to add additional compute capacity time to your training plan without creating a new plan or reconfiguring your workloads.

To find available extension offerings, use the SearchTrainingPlanOfferings API with the TrainingPlanArn parameter.

To view the history of extensions for a training plan, use the DescribeTrainingPlanExtensionHistory API.

" - }, - "GetDeviceFleetReport":{ - "name":"GetDeviceFleetReport", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetDeviceFleetReportRequest"}, - "output":{"shape":"GetDeviceFleetReportResponse"}, - "documentation":"

Describes a fleet.

" - }, - "GetLineageGroupPolicy":{ - "name":"GetLineageGroupPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetLineageGroupPolicyRequest"}, - "output":{"shape":"GetLineageGroupPolicyResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

The resource policy for the lineage group.

" - }, - "GetModelPackageGroupPolicy":{ - "name":"GetModelPackageGroupPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetModelPackageGroupPolicyInput"}, - "output":{"shape":"GetModelPackageGroupPolicyOutput"}, - "documentation":"

Gets a resource policy that manages access for a model group. For information about resource policies, see Identity-based policies and resource-based policies in the Amazon Web Services Identity and Access Management User Guide..

" - }, - "GetSagemakerServicecatalogPortfolioStatus":{ - "name":"GetSagemakerServicecatalogPortfolioStatus", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetSagemakerServicecatalogPortfolioStatusInput"}, - "output":{"shape":"GetSagemakerServicecatalogPortfolioStatusOutput"}, - "documentation":"

Gets the status of Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.

" - }, - "GetScalingConfigurationRecommendation":{ - "name":"GetScalingConfigurationRecommendation", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetScalingConfigurationRecommendationRequest"}, - "output":{"shape":"GetScalingConfigurationRecommendationResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Starts an Amazon SageMaker Inference Recommender autoscaling recommendation job. Returns recommendations for autoscaling policies that you can apply to your SageMaker endpoint.

" - }, - "GetSearchSuggestions":{ - "name":"GetSearchSuggestions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetSearchSuggestionsRequest"}, - "output":{"shape":"GetSearchSuggestionsResponse"}, - "documentation":"

An auto-complete API for the search functionality in the SageMaker console. It returns suggestions of possible matches for the property name to use in Search queries. Provides suggestions for HyperParameters, Tags, and Metrics.

" - }, - "ImportHubContent":{ - "name":"ImportHubContent", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ImportHubContentRequest"}, - "output":{"shape":"ImportHubContentResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Import hub content.

" - }, - "ListAIBenchmarkJobs":{ - "name":"ListAIBenchmarkJobs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListAIBenchmarkJobsRequest"}, - "output":{"shape":"ListAIBenchmarkJobsResponse"}, - "documentation":"

Returns a list of AI benchmark jobs in your account. You can filter the results by name, status, and creation time, and sort the results. The response is paginated.

" - }, - "ListAIRecommendationJobs":{ - "name":"ListAIRecommendationJobs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListAIRecommendationJobsRequest"}, - "output":{"shape":"ListAIRecommendationJobsResponse"}, - "documentation":"

Returns a list of AI recommendation jobs in your account. You can filter the results by name, status, and creation time, and sort the results. The response is paginated.

" - }, - "ListAIWorkloadConfigs":{ - "name":"ListAIWorkloadConfigs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListAIWorkloadConfigsRequest"}, - "output":{"shape":"ListAIWorkloadConfigsResponse"}, - "documentation":"

Returns a list of AI workload configurations in your account. You can filter the results by name and creation time, and sort the results. The response is paginated.

" - }, - "ListActions":{ - "name":"ListActions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListActionsRequest"}, - "output":{"shape":"ListActionsResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Lists the actions in your account and their properties.

" - }, - "ListAlgorithms":{ - "name":"ListAlgorithms", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListAlgorithmsInput"}, - "output":{"shape":"ListAlgorithmsOutput"}, - "documentation":"

Lists the machine learning algorithms that have been created.

" - }, - "ListAliases":{ - "name":"ListAliases", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListAliasesRequest"}, - "output":{"shape":"ListAliasesResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Lists the aliases of a specified image or image version.

" - }, - "ListAppImageConfigs":{ - "name":"ListAppImageConfigs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListAppImageConfigsRequest"}, - "output":{"shape":"ListAppImageConfigsResponse"}, - "documentation":"

Lists the AppImageConfigs in your account and their properties. The list can be filtered by creation time or modified time, and whether the AppImageConfig name contains a specified string.

" - }, - "ListApps":{ - "name":"ListApps", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListAppsRequest"}, - "output":{"shape":"ListAppsResponse"}, - "documentation":"

Lists apps.

" - }, - "ListArtifacts":{ - "name":"ListArtifacts", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListArtifactsRequest"}, - "output":{"shape":"ListArtifactsResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Lists the artifacts in your account and their properties.

" - }, - "ListAssociations":{ - "name":"ListAssociations", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListAssociationsRequest"}, - "output":{"shape":"ListAssociationsResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Lists the associations in your account and their properties.

" - }, - "ListAutoMLJobs":{ - "name":"ListAutoMLJobs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListAutoMLJobsRequest"}, - "output":{"shape":"ListAutoMLJobsResponse"}, - "documentation":"

Request a list of jobs.

" - }, - "ListCandidatesForAutoMLJob":{ - "name":"ListCandidatesForAutoMLJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListCandidatesForAutoMLJobRequest"}, - "output":{"shape":"ListCandidatesForAutoMLJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

List the candidates created for the job.

" - }, - "ListClusterEvents":{ - "name":"ListClusterEvents", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListClusterEventsRequest"}, - "output":{"shape":"ListClusterEventsResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Retrieves a list of event summaries for a specified HyperPod cluster. The operation supports filtering, sorting, and pagination of results. This functionality is only supported when the NodeProvisioningMode is set to Continuous.

" - }, - "ListClusterNodes":{ - "name":"ListClusterNodes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListClusterNodesRequest"}, - "output":{"shape":"ListClusterNodesResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Retrieves the list of instances (also called nodes interchangeably) in a SageMaker HyperPod cluster.

" - }, - "ListClusterSchedulerConfigs":{ - "name":"ListClusterSchedulerConfigs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListClusterSchedulerConfigsRequest"}, - "output":{"shape":"ListClusterSchedulerConfigsResponse"}, - "documentation":"

List the cluster policy configurations.

" - }, - "ListClusters":{ - "name":"ListClusters", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListClustersRequest"}, - "output":{"shape":"ListClustersResponse"}, - "documentation":"

Retrieves the list of SageMaker HyperPod clusters.

" - }, - "ListCodeRepositories":{ - "name":"ListCodeRepositories", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListCodeRepositoriesInput"}, - "output":{"shape":"ListCodeRepositoriesOutput"}, - "documentation":"

Gets a list of the Git repositories in your account.

" - }, - "ListCompilationJobs":{ - "name":"ListCompilationJobs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListCompilationJobsRequest"}, - "output":{"shape":"ListCompilationJobsResponse"}, - "documentation":"

Lists model compilation jobs that satisfy various filters.

To create a model compilation job, use CreateCompilationJob. To get information about a particular model compilation job you have created, use DescribeCompilationJob.

" - }, - "ListComputeQuotas":{ - "name":"ListComputeQuotas", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListComputeQuotasRequest"}, - "output":{"shape":"ListComputeQuotasResponse"}, - "documentation":"

List the resource allocation definitions.

" - }, - "ListContexts":{ - "name":"ListContexts", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListContextsRequest"}, - "output":{"shape":"ListContextsResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Lists the contexts in your account and their properties.

" - }, - "ListDataQualityJobDefinitions":{ - "name":"ListDataQualityJobDefinitions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListDataQualityJobDefinitionsRequest"}, - "output":{"shape":"ListDataQualityJobDefinitionsResponse"}, - "documentation":"

Lists the data quality job definitions in your account.

" - }, - "ListDeviceFleets":{ - "name":"ListDeviceFleets", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListDeviceFleetsRequest"}, - "output":{"shape":"ListDeviceFleetsResponse"}, - "documentation":"

Returns a list of devices in the fleet.

" - }, - "ListDevices":{ - "name":"ListDevices", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListDevicesRequest"}, - "output":{"shape":"ListDevicesResponse"}, - "documentation":"

A list of devices.

" - }, - "ListDomains":{ - "name":"ListDomains", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListDomainsRequest"}, - "output":{"shape":"ListDomainsResponse"}, - "documentation":"

Lists the domains.

" - }, - "ListEdgeDeploymentPlans":{ - "name":"ListEdgeDeploymentPlans", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListEdgeDeploymentPlansRequest"}, - "output":{"shape":"ListEdgeDeploymentPlansResponse"}, - "documentation":"

Lists all edge deployment plans.

" - }, - "ListEdgePackagingJobs":{ - "name":"ListEdgePackagingJobs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListEdgePackagingJobsRequest"}, - "output":{"shape":"ListEdgePackagingJobsResponse"}, - "documentation":"

Returns a list of edge packaging jobs.

" - }, - "ListEndpointConfigs":{ - "name":"ListEndpointConfigs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListEndpointConfigsInput"}, - "output":{"shape":"ListEndpointConfigsOutput"}, - "documentation":"

Lists endpoint configurations.

" - }, - "ListEndpoints":{ - "name":"ListEndpoints", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListEndpointsInput"}, - "output":{"shape":"ListEndpointsOutput"}, - "documentation":"

Lists endpoints.

" - }, - "ListExperiments":{ - "name":"ListExperiments", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListExperimentsRequest"}, - "output":{"shape":"ListExperimentsResponse"}, - "documentation":"

Lists all the experiments in your account. The list can be filtered to show only experiments that were created in a specific time range. The list can be sorted by experiment name or creation time.

" - }, - "ListFeatureGroups":{ - "name":"ListFeatureGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListFeatureGroupsRequest"}, - "output":{"shape":"ListFeatureGroupsResponse"}, - "documentation":"

List FeatureGroups based on given filter and order.

" - }, - "ListFlowDefinitions":{ - "name":"ListFlowDefinitions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListFlowDefinitionsRequest"}, - "output":{"shape":"ListFlowDefinitionsResponse"}, - "documentation":"

Returns information about the flow definitions in your account.

" - }, - "ListHubContentVersions":{ - "name":"ListHubContentVersions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListHubContentVersionsRequest"}, - "output":{"shape":"ListHubContentVersionsResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

List hub content versions.

" - }, - "ListHubContents":{ - "name":"ListHubContents", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListHubContentsRequest"}, - "output":{"shape":"ListHubContentsResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

List the contents of a hub.

" - }, - "ListHubs":{ - "name":"ListHubs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListHubsRequest"}, - "output":{"shape":"ListHubsResponse"}, - "documentation":"

List all existing hubs.

" - }, - "ListHumanTaskUis":{ - "name":"ListHumanTaskUis", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListHumanTaskUisRequest"}, - "output":{"shape":"ListHumanTaskUisResponse"}, - "documentation":"

Returns information about the human task user interfaces in your account.

" - }, - "ListHyperParameterTuningJobs":{ - "name":"ListHyperParameterTuningJobs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListHyperParameterTuningJobsRequest"}, - "output":{"shape":"ListHyperParameterTuningJobsResponse"}, - "documentation":"

Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.

" - }, - "ListImageVersions":{ - "name":"ListImageVersions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListImageVersionsRequest"}, - "output":{"shape":"ListImageVersionsResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Lists the versions of a specified image and their properties. The list can be filtered by creation time or modified time.

" - }, - "ListImages":{ - "name":"ListImages", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListImagesRequest"}, - "output":{"shape":"ListImagesResponse"}, - "documentation":"

Lists the images in your account and their properties. The list can be filtered by creation time or modified time, and whether the image name contains a specified string.

" - }, - "ListInferenceComponents":{ - "name":"ListInferenceComponents", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListInferenceComponentsInput"}, - "output":{"shape":"ListInferenceComponentsOutput"}, - "documentation":"

Lists the inference components in your account and their properties.

" - }, - "ListInferenceExperiments":{ - "name":"ListInferenceExperiments", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListInferenceExperimentsRequest"}, - "output":{"shape":"ListInferenceExperimentsResponse"}, - "documentation":"

Returns the list of all inference experiments.

" - }, - "ListInferenceRecommendationsJobSteps":{ - "name":"ListInferenceRecommendationsJobSteps", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListInferenceRecommendationsJobStepsRequest"}, - "output":{"shape":"ListInferenceRecommendationsJobStepsResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Returns a list of the subtasks for an Inference Recommender job.

The supported subtasks are benchmarks, which evaluate the performance of your model on different instance types.

" - }, - "ListInferenceRecommendationsJobs":{ - "name":"ListInferenceRecommendationsJobs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListInferenceRecommendationsJobsRequest"}, - "output":{"shape":"ListInferenceRecommendationsJobsResponse"}, - "documentation":"

Lists recommendation jobs that satisfy various filters.

" - }, - "ListJobSchemaVersions":{ - "name":"ListJobSchemaVersions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListJobSchemaVersionsRequest"}, - "output":{"shape":"ListJobSchemaVersionsResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Lists available configuration schema versions for a specified job category. Use the schema versions with DescribeJobSchemaVersion to retrieve the full schema document.

The following operations are related to ListJobSchemaVersions:

  • DescribeJobSchemaVersion

  • CreateJob

", - "readonly":true - }, - "ListJobs":{ - "name":"ListJobs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListJobsRequest"}, - "output":{"shape":"ListJobsResponse"}, - "documentation":"

Lists jobs in a specified category. You can filter results by creation time, last modified time, name, and status. Results are sorted by the field you specify in SortBy. Use pagination to retrieve large result sets efficiently.

The following operations are related to ListJobs:

  • CreateJob

  • DescribeJob

", - "readonly":true - }, - "ListLabelingJobs":{ - "name":"ListLabelingJobs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListLabelingJobsRequest"}, - "output":{"shape":"ListLabelingJobsResponse"}, - "documentation":"

Gets a list of labeling jobs.

" - }, - "ListLabelingJobsForWorkteam":{ - "name":"ListLabelingJobsForWorkteam", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListLabelingJobsForWorkteamRequest"}, - "output":{"shape":"ListLabelingJobsForWorkteamResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Gets a list of labeling jobs assigned to a specified work team.

" - }, - "ListLineageGroups":{ - "name":"ListLineageGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListLineageGroupsRequest"}, - "output":{"shape":"ListLineageGroupsResponse"}, - "documentation":"

A list of lineage groups shared with your Amazon Web Services account. For more information, see Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.

" - }, - "ListMlflowApps":{ - "name":"ListMlflowApps", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListMlflowAppsRequest"}, - "output":{"shape":"ListMlflowAppsResponse"}, - "documentation":"

Lists all MLflow Apps

" - }, - "ListMlflowTrackingServers":{ - "name":"ListMlflowTrackingServers", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListMlflowTrackingServersRequest"}, - "output":{"shape":"ListMlflowTrackingServersResponse"}, - "documentation":"

Lists all MLflow Tracking Servers.

" - }, - "ListModelBiasJobDefinitions":{ - "name":"ListModelBiasJobDefinitions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListModelBiasJobDefinitionsRequest"}, - "output":{"shape":"ListModelBiasJobDefinitionsResponse"}, - "documentation":"

Lists model bias jobs definitions that satisfy various filters.

" - }, - "ListModelCardExportJobs":{ - "name":"ListModelCardExportJobs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListModelCardExportJobsRequest"}, - "output":{"shape":"ListModelCardExportJobsResponse"}, - "documentation":"

List the export jobs for the Amazon SageMaker Model Card.

" - }, - "ListModelCardVersions":{ - "name":"ListModelCardVersions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListModelCardVersionsRequest"}, - "output":{"shape":"ListModelCardVersionsResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

List existing versions of an Amazon SageMaker Model Card.

" - }, - "ListModelCards":{ - "name":"ListModelCards", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListModelCardsRequest"}, - "output":{"shape":"ListModelCardsResponse"}, - "documentation":"

List existing model cards.

" - }, - "ListModelExplainabilityJobDefinitions":{ - "name":"ListModelExplainabilityJobDefinitions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListModelExplainabilityJobDefinitionsRequest"}, - "output":{"shape":"ListModelExplainabilityJobDefinitionsResponse"}, - "documentation":"

Lists model explainability job definitions that satisfy various filters.

" - }, - "ListModelMetadata":{ - "name":"ListModelMetadata", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListModelMetadataRequest"}, - "output":{"shape":"ListModelMetadataResponse"}, - "documentation":"

Lists the domain, framework, task, and model name of standard machine learning models found in common model zoos.

" - }, - "ListModelPackageGroups":{ - "name":"ListModelPackageGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListModelPackageGroupsInput"}, - "output":{"shape":"ListModelPackageGroupsOutput"}, - "documentation":"

Gets a list of the model groups in your Amazon Web Services account.

" - }, - "ListModelPackages":{ - "name":"ListModelPackages", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListModelPackagesInput"}, - "output":{"shape":"ListModelPackagesOutput"}, - "documentation":"

Lists the model packages that have been created.

" - }, - "ListModelQualityJobDefinitions":{ - "name":"ListModelQualityJobDefinitions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListModelQualityJobDefinitionsRequest"}, - "output":{"shape":"ListModelQualityJobDefinitionsResponse"}, - "documentation":"

Gets a list of model quality monitoring job definitions in your account.

" - }, - "ListModels":{ - "name":"ListModels", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListModelsInput"}, - "output":{"shape":"ListModelsOutput"}, - "documentation":"

Lists models created with the CreateModel API.

" - }, - "ListMonitoringAlertHistory":{ - "name":"ListMonitoringAlertHistory", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListMonitoringAlertHistoryRequest"}, - "output":{"shape":"ListMonitoringAlertHistoryResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Gets a list of past alerts in a model monitoring schedule.

" - }, - "ListMonitoringAlerts":{ - "name":"ListMonitoringAlerts", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListMonitoringAlertsRequest"}, - "output":{"shape":"ListMonitoringAlertsResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Gets the alerts for a single monitoring schedule.

" - }, - "ListMonitoringExecutions":{ - "name":"ListMonitoringExecutions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListMonitoringExecutionsRequest"}, - "output":{"shape":"ListMonitoringExecutionsResponse"}, - "documentation":"

Returns list of all monitoring job executions.

" - }, - "ListMonitoringSchedules":{ - "name":"ListMonitoringSchedules", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListMonitoringSchedulesRequest"}, - "output":{"shape":"ListMonitoringSchedulesResponse"}, - "documentation":"

Returns list of all monitoring schedules.

" - }, - "ListNotebookInstanceLifecycleConfigs":{ - "name":"ListNotebookInstanceLifecycleConfigs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListNotebookInstanceLifecycleConfigsInput"}, - "output":{"shape":"ListNotebookInstanceLifecycleConfigsOutput"}, - "documentation":"

Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.

" - }, - "ListNotebookInstances":{ - "name":"ListNotebookInstances", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListNotebookInstancesInput"}, - "output":{"shape":"ListNotebookInstancesOutput"}, - "documentation":"

Returns a list of the SageMaker AI notebook instances in the requester's account in an Amazon Web Services Region.

" - }, - "ListOptimizationJobs":{ - "name":"ListOptimizationJobs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListOptimizationJobsRequest"}, - "output":{"shape":"ListOptimizationJobsResponse"}, - "documentation":"

Lists the optimization jobs in your account and their properties.

" - }, - "ListPartnerApps":{ - "name":"ListPartnerApps", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListPartnerAppsRequest"}, - "output":{"shape":"ListPartnerAppsResponse"}, - "documentation":"

Lists all of the SageMaker Partner AI Apps in an account.

" - }, - "ListPipelineExecutionSteps":{ - "name":"ListPipelineExecutionSteps", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListPipelineExecutionStepsRequest"}, - "output":{"shape":"ListPipelineExecutionStepsResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Gets a list of PipeLineExecutionStep objects.

" - }, - "ListPipelineExecutions":{ - "name":"ListPipelineExecutions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListPipelineExecutionsRequest"}, - "output":{"shape":"ListPipelineExecutionsResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Gets a list of the pipeline executions.

" - }, - "ListPipelineParametersForExecution":{ - "name":"ListPipelineParametersForExecution", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListPipelineParametersForExecutionRequest"}, - "output":{"shape":"ListPipelineParametersForExecutionResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Gets a list of parameters for a pipeline execution.

" - }, - "ListPipelineVersions":{ - "name":"ListPipelineVersions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListPipelineVersionsRequest"}, - "output":{"shape":"ListPipelineVersionsResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Gets a list of all versions of the pipeline.

" - }, - "ListPipelines":{ - "name":"ListPipelines", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListPipelinesRequest"}, - "output":{"shape":"ListPipelinesResponse"}, - "documentation":"

Gets a list of pipelines.

" - }, - "ListProcessingJobs":{ - "name":"ListProcessingJobs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListProcessingJobsRequest"}, - "output":{"shape":"ListProcessingJobsResponse"}, - "documentation":"

Lists processing jobs that satisfy various filters.

" - }, - "ListProjects":{ - "name":"ListProjects", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListProjectsInput"}, - "output":{"shape":"ListProjectsOutput"}, - "documentation":"

Gets a list of the projects in an Amazon Web Services account.

" - }, - "ListResourceCatalogs":{ - "name":"ListResourceCatalogs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListResourceCatalogsRequest"}, - "output":{"shape":"ListResourceCatalogsResponse"}, - "documentation":"

Lists Amazon SageMaker Catalogs based on given filters and orders. The maximum number of ResourceCatalogs viewable is 1000.

" - }, - "ListSpaces":{ - "name":"ListSpaces", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListSpacesRequest"}, - "output":{"shape":"ListSpacesResponse"}, - "documentation":"

Lists spaces.

" - }, - "ListStageDevices":{ - "name":"ListStageDevices", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListStageDevicesRequest"}, - "output":{"shape":"ListStageDevicesResponse"}, - "documentation":"

Lists devices allocated to the stage, containing detailed device information and deployment status.

" - }, - "ListStudioLifecycleConfigs":{ - "name":"ListStudioLifecycleConfigs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListStudioLifecycleConfigsRequest"}, - "output":{"shape":"ListStudioLifecycleConfigsResponse"}, - "errors":[ - {"shape":"ResourceInUse"} - ], - "documentation":"

Lists the Amazon SageMaker AI Studio Lifecycle Configurations in your Amazon Web Services Account.

" - }, - "ListSubscribedWorkteams":{ - "name":"ListSubscribedWorkteams", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListSubscribedWorkteamsRequest"}, - "output":{"shape":"ListSubscribedWorkteamsResponse"}, - "documentation":"

Gets a list of the work teams that you are subscribed to in the Amazon Web Services Marketplace. The list may be empty if no work team satisfies the filter specified in the NameContains parameter.

" - }, - "ListTags":{ - "name":"ListTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListTagsInput"}, - "output":{"shape":"ListTagsOutput"}, - "documentation":"

Returns the tags for the specified SageMaker resource.

" - }, - "ListTrainingJobs":{ - "name":"ListTrainingJobs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListTrainingJobsRequest"}, - "output":{"shape":"ListTrainingJobsResponse"}, - "documentation":"

Lists training jobs.

When StatusEquals and MaxResults are set at the same time, the MaxResults number of training jobs are first retrieved ignoring the StatusEquals parameter and then they are filtered by the StatusEquals parameter, which is returned as a response.

For example, if ListTrainingJobs is invoked with the following parameters:

{ ... MaxResults: 100, StatusEquals: InProgress ... }

First, 100 trainings jobs with any status, including those other than InProgress, are selected (sorted according to the creation time, from the most current to the oldest). Next, those with a status of InProgress are returned.

You can quickly test the API using the following Amazon Web Services CLI code.

aws sagemaker list-training-jobs --max-results 100 --status-equals InProgress

" - }, - "ListTrainingJobsForHyperParameterTuningJob":{ - "name":"ListTrainingJobsForHyperParameterTuningJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListTrainingJobsForHyperParameterTuningJobRequest"}, - "output":{"shape":"ListTrainingJobsForHyperParameterTuningJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job launched.

" - }, - "ListTrainingPlans":{ - "name":"ListTrainingPlans", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListTrainingPlansRequest"}, - "output":{"shape":"ListTrainingPlansResponse"}, - "documentation":"

Retrieves a list of training plans for the current account.

" - }, - "ListTransformJobs":{ - "name":"ListTransformJobs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListTransformJobsRequest"}, - "output":{"shape":"ListTransformJobsResponse"}, - "documentation":"

Lists transform jobs.

" - }, - "ListTrialComponents":{ - "name":"ListTrialComponents", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListTrialComponentsRequest"}, - "output":{"shape":"ListTrialComponentsResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Lists the trial components in your account. You can sort the list by trial component name or creation time. You can filter the list to show only components that were created in a specific time range. You can also filter on one of the following:

  • ExperimentName

  • SourceArn

  • TrialName

" - }, - "ListTrials":{ - "name":"ListTrials", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListTrialsRequest"}, - "output":{"shape":"ListTrialsResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Lists the trials in your account. Specify an experiment name to limit the list to the trials that are part of that experiment. Specify a trial component name to limit the list to the trials that associated with that trial component. The list can be filtered to show only trials that were created in a specific time range. The list can be sorted by trial name or creation time.

" - }, - "ListUltraServersByReservedCapacity":{ - "name":"ListUltraServersByReservedCapacity", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListUltraServersByReservedCapacityRequest"}, - "output":{"shape":"ListUltraServersByReservedCapacityResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Lists all UltraServers that are part of a specified reserved capacity.

" - }, - "ListUserProfiles":{ - "name":"ListUserProfiles", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListUserProfilesRequest"}, - "output":{"shape":"ListUserProfilesResponse"}, - "documentation":"

Lists user profiles.

" - }, - "ListWorkforces":{ - "name":"ListWorkforces", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListWorkforcesRequest"}, - "output":{"shape":"ListWorkforcesResponse"}, - "documentation":"

Use this operation to list all private and vendor workforces in an Amazon Web Services Region. Note that you can only have one private workforce per Amazon Web Services Region.

" - }, - "ListWorkteams":{ - "name":"ListWorkteams", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListWorkteamsRequest"}, - "output":{"shape":"ListWorkteamsResponse"}, - "documentation":"

Gets a list of private work teams that you have defined in a region. The list may be empty if no work team satisfies the filter specified in the NameContains parameter.

" - }, - "PutModelPackageGroupPolicy":{ - "name":"PutModelPackageGroupPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"PutModelPackageGroupPolicyInput"}, - "output":{"shape":"PutModelPackageGroupPolicyOutput"}, - "errors":[ - {"shape":"ConflictException"} - ], - "documentation":"

Adds a resouce policy to control access to a model group. For information about resoure policies, see Identity-based policies and resource-based policies in the Amazon Web Services Identity and Access Management User Guide..

" - }, - "QueryLineage":{ - "name":"QueryLineage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"QueryLineageRequest"}, - "output":{"shape":"QueryLineageResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Use this action to inspect your lineage and discover relationships between entities. For more information, see Querying Lineage Entities in the Amazon SageMaker Developer Guide.

" - }, - "RegisterDevices":{ - "name":"RegisterDevices", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RegisterDevicesRequest"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Register devices.

" - }, - "RenderUiTemplate":{ - "name":"RenderUiTemplate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RenderUiTemplateRequest"}, - "output":{"shape":"RenderUiTemplateResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Renders the UI template so that you can preview the worker's experience.

" - }, - "RetryPipelineExecution":{ - "name":"RetryPipelineExecution", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RetryPipelineExecutionRequest"}, - "output":{"shape":"RetryPipelineExecutionResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Retry the execution of the pipeline.

" - }, - "Search":{ - "name":"Search", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"SearchRequest"}, - "output":{"shape":"SearchResponse"}, - "documentation":"

Finds SageMaker resources that match a search query. Matching resources are returned as a list of SearchRecord objects in the response. You can sort the search results by any resource property in a ascending or descending order.

You can query against the following value types: numeric, text, Boolean, and timestamp.

The Search API may provide access to otherwise restricted data. See Amazon SageMaker API Permissions: Actions, Permissions, and Resources Reference for more information.

" - }, - "SearchTrainingPlanOfferings":{ - "name":"SearchTrainingPlanOfferings", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"SearchTrainingPlanOfferingsRequest"}, - "output":{"shape":"SearchTrainingPlanOfferingsResponse"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Searches for available training plan offerings based on specified criteria.

  • Users search for available plan offerings based on their requirements (e.g., instance type, count, start time, duration).

  • And then, they create a plan that best matches their needs using the ID of the plan offering they want to use.

For more information about how to reserve GPU capacity for your SageMaker training jobs or SageMaker HyperPod clusters using Amazon SageMaker Training Plan , see CreateTrainingPlan .

" - }, - "SendPipelineExecutionStepFailure":{ - "name":"SendPipelineExecutionStepFailure", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"SendPipelineExecutionStepFailureRequest"}, - "output":{"shape":"SendPipelineExecutionStepFailureResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Notifies the pipeline that the execution of a callback step failed, along with a message describing why. When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).

" - }, - "SendPipelineExecutionStepSuccess":{ - "name":"SendPipelineExecutionStepSuccess", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"SendPipelineExecutionStepSuccessRequest"}, - "output":{"shape":"SendPipelineExecutionStepSuccessResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Notifies the pipeline that the execution of a callback step succeeded and provides a list of the step's output parameters. When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).

" - }, - "StartClusterHealthCheck":{ - "name":"StartClusterHealthCheck", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StartClusterHealthCheckRequest"}, - "output":{"shape":"StartClusterHealthCheckResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Start deep health checks for a SageMaker HyperPod cluster. You can use DescribeClusterNode API to track progress of the deep health checks. The unhealthy nodes will be automatically rebooted or replaced. Please see Resilience-related Kubernetes labels by SageMaker HyperPod for details.

" - }, - "StartEdgeDeploymentStage":{ - "name":"StartEdgeDeploymentStage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StartEdgeDeploymentStageRequest"}, - "documentation":"

Starts a stage in an edge deployment plan.

" - }, - "StartInferenceExperiment":{ - "name":"StartInferenceExperiment", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StartInferenceExperimentRequest"}, - "output":{"shape":"StartInferenceExperimentResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ], - "documentation":"

Starts an inference experiment.

" - }, - "StartMlflowTrackingServer":{ - "name":"StartMlflowTrackingServer", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StartMlflowTrackingServerRequest"}, - "output":{"shape":"StartMlflowTrackingServerResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ], - "documentation":"

Programmatically start an MLflow Tracking Server.

" - }, - "StartMonitoringSchedule":{ - "name":"StartMonitoringSchedule", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StartMonitoringScheduleRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Starts a previously stopped monitoring schedule.

By default, when you successfully create a new schedule, the status of a monitoring schedule is scheduled.

" - }, - "StartNotebookInstance":{ - "name":"StartNotebookInstance", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StartNotebookInstanceInput"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Launches an ML compute instance with the latest version of the libraries and attaches your ML storage volume. After configuring the notebook instance, SageMaker AI sets the notebook instance status to InService. A notebook instance's status must be InService before you can connect to your Jupyter notebook.

" - }, - "StartPipelineExecution":{ - "name":"StartPipelineExecution", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StartPipelineExecutionRequest"}, - "output":{"shape":"StartPipelineExecutionResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Starts a pipeline execution.

" - }, - "StartSession":{ - "name":"StartSession", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StartSessionRequest"}, - "output":{"shape":"StartSessionResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Initiates a remote connection session between a local integrated development environments (IDEs) and a remote SageMaker space.

" - }, - "StopAIBenchmarkJob":{ - "name":"StopAIBenchmarkJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopAIBenchmarkJobRequest"}, - "output":{"shape":"StopAIBenchmarkJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Stops a running AI benchmark job.

" - }, - "StopAIRecommendationJob":{ - "name":"StopAIRecommendationJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopAIRecommendationJobRequest"}, - "output":{"shape":"StopAIRecommendationJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Stops a running AI recommendation job.

" - }, - "StopAutoMLJob":{ - "name":"StopAutoMLJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopAutoMLJobRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

A method for forcing a running job to shut down.

" - }, - "StopCompilationJob":{ - "name":"StopCompilationJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopCompilationJobRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Stops a model compilation job.

To stop a job, Amazon SageMaker AI sends the algorithm the SIGTERM signal. This gracefully shuts the job down. If the job hasn't stopped, it sends the SIGKILL signal.

When it receives a StopCompilationJob request, Amazon SageMaker AI changes the CompilationJobStatus of the job to Stopping. After Amazon SageMaker stops the job, it sets the CompilationJobStatus to Stopped.

" - }, - "StopEdgeDeploymentStage":{ - "name":"StopEdgeDeploymentStage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopEdgeDeploymentStageRequest"}, - "documentation":"

Stops a stage in an edge deployment plan.

" - }, - "StopEdgePackagingJob":{ - "name":"StopEdgePackagingJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopEdgePackagingJobRequest"}, - "documentation":"

Request to stop an edge packaging job.

" - }, - "StopHyperParameterTuningJob":{ - "name":"StopHyperParameterTuningJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopHyperParameterTuningJobRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Stops a running hyperparameter tuning job and all running training jobs that the tuning job launched.

All model artifacts output from the training jobs are stored in Amazon Simple Storage Service (Amazon S3). All data that the training jobs write to Amazon CloudWatch Logs are still available in CloudWatch. After the tuning job moves to the Stopped state, it releases all reserved resources for the tuning job.

" - }, - "StopInferenceExperiment":{ - "name":"StopInferenceExperiment", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopInferenceExperimentRequest"}, - "output":{"shape":"StopInferenceExperimentResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ], - "documentation":"

Stops an inference experiment.

" - }, - "StopInferenceRecommendationsJob":{ - "name":"StopInferenceRecommendationsJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopInferenceRecommendationsJobRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Stops an Inference Recommender job.

" - }, - "StopJob":{ - "name":"StopJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopJobRequest"}, - "output":{"shape":"StopJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Stops a running job. When you call StopJob, Amazon SageMaker sets the job status to Stopping. After the job stops, the status changes to Stopped. Partial results may be available in the output location if the job was in progress. To delete a stopped job, call DeleteJob.

The following operations are related to StopJob:

  • CreateJob

  • DescribeJob

  • DeleteJob

" - }, - "StopLabelingJob":{ - "name":"StopLabelingJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopLabelingJobRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Stops a running labeling job. A job that is stopped cannot be restarted. Any results obtained before the job is stopped are placed in the Amazon S3 output bucket.

" - }, - "StopMlflowTrackingServer":{ - "name":"StopMlflowTrackingServer", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopMlflowTrackingServerRequest"}, - "output":{"shape":"StopMlflowTrackingServerResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ], - "documentation":"

Programmatically stop an MLflow Tracking Server.

" - }, - "StopMonitoringSchedule":{ - "name":"StopMonitoringSchedule", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopMonitoringScheduleRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Stops a previously started monitoring schedule.

" - }, - "StopNotebookInstance":{ - "name":"StopNotebookInstance", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopNotebookInstanceInput"}, - "documentation":"

Terminates the ML compute instance. Before terminating the instance, SageMaker AI disconnects the ML storage volume from it. SageMaker AI preserves the ML storage volume. SageMaker AI stops charging you for the ML compute instance when you call StopNotebookInstance.

To access data on the ML storage volume for a notebook instance that has been terminated, call the StartNotebookInstance API. StartNotebookInstance launches another ML compute instance, configures it, and attaches the preserved ML storage volume so you can continue your work.

" - }, - "StopOptimizationJob":{ - "name":"StopOptimizationJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopOptimizationJobRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Ends a running inference optimization job.

" - }, - "StopPipelineExecution":{ - "name":"StopPipelineExecution", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopPipelineExecutionRequest"}, - "output":{"shape":"StopPipelineExecutionResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ], - "documentation":"

Stops a pipeline execution.

Callback Step

A pipeline execution won't stop while a callback step is running. When you call StopPipelineExecution on a pipeline execution with a running callback step, SageMaker Pipelines sends an additional Amazon SQS message to the specified SQS queue. The body of the SQS message contains a \"Status\" field which is set to \"Stopping\".

You should add logic to your Amazon SQS message consumer to take any needed action (for example, resource cleanup) upon receipt of the message followed by a call to SendPipelineExecutionStepSuccess or SendPipelineExecutionStepFailure.

Only when SageMaker Pipelines receives one of these calls will it stop the pipeline execution.

Lambda Step

A pipeline execution can't be stopped while a lambda step is running because the Lambda function invoked by the lambda step can't be stopped. If you attempt to stop the execution while the Lambda function is running, the pipeline waits for the Lambda function to finish or until the timeout is hit, whichever occurs first, and then stops. If the Lambda function finishes, the pipeline execution status is Stopped. If the timeout is hit the pipeline execution status is Failed.

" - }, - "StopProcessingJob":{ - "name":"StopProcessingJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopProcessingJobRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Stops a processing job.

" - }, - "StopTrainingJob":{ - "name":"StopTrainingJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopTrainingJobRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Stops a training job. To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms might use this 120-second window to save the model artifacts, so the results of the training is not lost.

When it receives a StopTrainingJob request, SageMaker changes the status of the job to Stopping. After SageMaker stops the job, it sets the status to Stopped.

" - }, - "StopTransformJob":{ - "name":"StopTransformJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopTransformJobRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Stops a batch transform job.

When Amazon SageMaker receives a StopTransformJob request, the status of the job changes to Stopping. After Amazon SageMaker stops the job, the status is set to Stopped. When you stop a batch transform job before it is completed, Amazon SageMaker doesn't store the job's output in Amazon S3.

" - }, - "UpdateAction":{ - "name":"UpdateAction", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateActionRequest"}, - "output":{"shape":"UpdateActionResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ], - "documentation":"

Updates an action.

" - }, - "UpdateAppImageConfig":{ - "name":"UpdateAppImageConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateAppImageConfigRequest"}, - "output":{"shape":"UpdateAppImageConfigResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Updates the properties of an AppImageConfig.

" - }, - "UpdateArtifact":{ - "name":"UpdateArtifact", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateArtifactRequest"}, - "output":{"shape":"UpdateArtifactResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ], - "documentation":"

Updates an artifact.

" - }, - "UpdateCluster":{ - "name":"UpdateCluster", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateClusterRequest"}, - "output":{"shape":"UpdateClusterResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Updates a SageMaker HyperPod cluster.

" - }, - "UpdateClusterSchedulerConfig":{ - "name":"UpdateClusterSchedulerConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateClusterSchedulerConfigRequest"}, - "output":{"shape":"UpdateClusterSchedulerConfigResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Update the cluster policy configuration.

" - }, - "UpdateClusterSoftware":{ - "name":"UpdateClusterSoftware", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateClusterSoftwareRequest"}, - "output":{"shape":"UpdateClusterSoftwareResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ], - "documentation":"

Updates the platform software of a SageMaker HyperPod cluster for security patching. To learn how to use this API, see Update the SageMaker HyperPod platform software of a cluster.

The UpgradeClusterSoftware API call may impact your SageMaker HyperPod cluster uptime and availability. Plan accordingly to mitigate potential disruptions to your workloads.

" - }, - "UpdateCodeRepository":{ - "name":"UpdateCodeRepository", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateCodeRepositoryInput"}, - "output":{"shape":"UpdateCodeRepositoryOutput"}, - "errors":[ - {"shape":"ConflictException"} - ], - "documentation":"

Updates the specified Git repository with the specified values.

" - }, - "UpdateComputeQuota":{ - "name":"UpdateComputeQuota", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateComputeQuotaRequest"}, - "output":{"shape":"UpdateComputeQuotaResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Update the compute allocation definition.

" - }, - "UpdateContext":{ - "name":"UpdateContext", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateContextRequest"}, - "output":{"shape":"UpdateContextResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ], - "documentation":"

Updates a context.

" - }, - "UpdateDeviceFleet":{ - "name":"UpdateDeviceFleet", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateDeviceFleetRequest"}, - "errors":[ - {"shape":"ResourceInUse"} - ], - "documentation":"

Updates a fleet of devices.

" - }, - "UpdateDevices":{ - "name":"UpdateDevices", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateDevicesRequest"}, - "documentation":"

Updates one or more devices in a fleet.

" - }, - "UpdateDomain":{ - "name":"UpdateDomain", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateDomainRequest"}, - "output":{"shape":"UpdateDomainResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Updates the default settings for new user profiles in the domain.

" - }, - "UpdateEndpoint":{ - "name":"UpdateEndpoint", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateEndpointInput"}, - "output":{"shape":"UpdateEndpointOutput"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Deploys the EndpointConfig specified in the request to a new fleet of instances. SageMaker shifts endpoint traffic to the new instances with the updated endpoint configuration and then deletes the old instances using the previous EndpointConfig (there is no availability loss). For more information about how to control the update and traffic shifting process, see Update models in production.

When SageMaker receives the request, it sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.

You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.

If you delete the EndpointConfig of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges.

" - }, - "UpdateEndpointWeightsAndCapacities":{ - "name":"UpdateEndpointWeightsAndCapacities", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateEndpointWeightsAndCapacitiesInput"}, - "output":{"shape":"UpdateEndpointWeightsAndCapacitiesOutput"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Updates variant weight of one or more variants associated with an existing endpoint, or capacity of one variant associated with an existing endpoint. When it receives the request, SageMaker sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.

" - }, - "UpdateExperiment":{ - "name":"UpdateExperiment", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateExperimentRequest"}, - "output":{"shape":"UpdateExperimentResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ], - "documentation":"

Adds, updates, or removes the description of an experiment. Updates the display name of an experiment.

" - }, - "UpdateFeatureGroup":{ - "name":"UpdateFeatureGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateFeatureGroupRequest"}, - "output":{"shape":"UpdateFeatureGroupResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Updates the feature group by either adding features or updating the online store configuration. Use one of the following request parameters at a time while using the UpdateFeatureGroup API.

You can add features for your feature group using the FeatureAdditions request parameter. Features cannot be removed from a feature group.

You can update the online store configuration by using the OnlineStoreConfig request parameter. If a TtlDuration is specified, the default TtlDuration applies for all records added to the feature group after the feature group is updated. If a record level TtlDuration exists from using the PutRecord API, the record level TtlDuration applies to that record instead of the default TtlDuration. To remove the default TtlDuration from an existing feature group, use the UpdateFeatureGroup API and set the TtlDuration Unit and Value to null.

" - }, - "UpdateFeatureMetadata":{ - "name":"UpdateFeatureMetadata", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateFeatureMetadataRequest"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Updates the description and parameters of the feature group.

" - }, - "UpdateHub":{ - "name":"UpdateHub", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateHubRequest"}, - "output":{"shape":"UpdateHubResponse"}, - "errors":[ - {"shape":"ResourceNotFound"} - ], - "documentation":"

Update a hub.

" - }, - "UpdateHubContent":{ - "name":"UpdateHubContent", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateHubContentRequest"}, - "output":{"shape":"UpdateHubContentResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"} - ], - "documentation":"

Updates SageMaker hub content (either a Model or Notebook resource).

You can update the metadata that describes the resource. In addition to the required request fields, specify at least one of the following fields to update:

  • HubContentDescription

  • HubContentDisplayName

  • HubContentMarkdown

  • HubContentSearchKeywords

  • SupportStatus

For more information about hubs, see Private curated hubs for foundation model access control in JumpStart.

If you want to update a ModelReference resource in your hub, use the UpdateHubContentResource API instead.

" - }, - "UpdateHubContentReference":{ - "name":"UpdateHubContentReference", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateHubContentReferenceRequest"}, - "output":{"shape":"UpdateHubContentReferenceResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"} - ], - "documentation":"

Updates the contents of a SageMaker hub for a ModelReference resource. A ModelReference allows you to access public SageMaker JumpStart models from within your private hub.

When using this API, you can update the MinVersion field for additional flexibility in the model version. You shouldn't update any additional fields when using this API, because the metadata in your private hub should match the public JumpStart model's metadata.

If you want to update a Model or Notebook resource in your hub, use the UpdateHubContent API instead.

For more information about adding model references to your hub, see Add models to a private hub.

" - }, - "UpdateImage":{ - "name":"UpdateImage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateImageRequest"}, - "output":{"shape":"UpdateImageResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"} - ], - "documentation":"

Updates the properties of a SageMaker AI image. To change the image's tags, use the AddTags and DeleteTags APIs.

" - }, - "UpdateImageVersion":{ - "name":"UpdateImageVersion", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateImageVersionRequest"}, - "output":{"shape":"UpdateImageVersionResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"} - ], - "documentation":"

Updates the properties of a SageMaker AI image version.

" - }, - "UpdateInferenceComponent":{ - "name":"UpdateInferenceComponent", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateInferenceComponentInput"}, - "output":{"shape":"UpdateInferenceComponentOutput"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Updates an inference component.

" - }, - "UpdateInferenceComponentRuntimeConfig":{ - "name":"UpdateInferenceComponentRuntimeConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateInferenceComponentRuntimeConfigInput"}, - "output":{"shape":"UpdateInferenceComponentRuntimeConfigOutput"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Runtime settings for a model that is deployed with an inference component.

" - }, - "UpdateInferenceExperiment":{ - "name":"UpdateInferenceExperiment", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateInferenceExperimentRequest"}, - "output":{"shape":"UpdateInferenceExperimentResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ], - "documentation":"

Updates an inference experiment that you created. The status of the inference experiment has to be either Created, Running. For more information on the status of an inference experiment, see DescribeInferenceExperiment.

" - }, - "UpdateMlflowApp":{ - "name":"UpdateMlflowApp", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateMlflowAppRequest"}, - "output":{"shape":"UpdateMlflowAppResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ], - "documentation":"

Updates an MLflow App.

" - }, - "UpdateMlflowTrackingServer":{ - "name":"UpdateMlflowTrackingServer", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateMlflowTrackingServerRequest"}, - "output":{"shape":"UpdateMlflowTrackingServerResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Updates properties of an existing MLflow Tracking Server.

" - }, - "UpdateModelCard":{ - "name":"UpdateModelCard", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateModelCardRequest"}, - "output":{"shape":"UpdateModelCardResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Update an Amazon SageMaker Model Card.

You cannot update both model card content and model card status in a single call.

" - }, - "UpdateModelPackage":{ - "name":"UpdateModelPackage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateModelPackageInput"}, - "output":{"shape":"UpdateModelPackageOutput"}, - "errors":[ - {"shape":"ConflictException"} - ], - "documentation":"

Updates a versioned model.

" - }, - "UpdateMonitoringAlert":{ - "name":"UpdateMonitoringAlert", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateMonitoringAlertRequest"}, - "output":{"shape":"UpdateMonitoringAlertResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Update the parameters of a model monitor alert.

" - }, - "UpdateMonitoringSchedule":{ - "name":"UpdateMonitoringSchedule", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateMonitoringScheduleRequest"}, - "output":{"shape":"UpdateMonitoringScheduleResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Updates a previously created schedule.

" - }, - "UpdateNotebookInstance":{ - "name":"UpdateNotebookInstance", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateNotebookInstanceInput"}, - "output":{"shape":"UpdateNotebookInstanceOutput"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Updates a notebook instance. NotebookInstance updates include upgrading or downgrading the ML compute instance used for your notebook instance to accommodate changes in your workload requirements.

This API can attach lifecycle configurations to notebook instances. Lifecycle configuration scripts execute with root access and the notebook instance's IAM execution role privileges. Principals with this permission and access to lifecycle configurations can execute code with the execution role's credentials. See Customize a Notebook Instance Using a Lifecycle Configuration Script for security best practices.

" - }, - "UpdateNotebookInstanceLifecycleConfig":{ - "name":"UpdateNotebookInstanceLifecycleConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateNotebookInstanceLifecycleConfigInput"}, - "output":{"shape":"UpdateNotebookInstanceLifecycleConfigOutput"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig API.

Updates to lifecycle configurations affect all notebook instances using that configuration upon their next start. Lifecycle configuration scripts execute with root access and the notebook instance's IAM execution role privileges. Grant this permission only to trusted principals. See Customize a Notebook Instance Using a Lifecycle Configuration Script for security best practices.

" - }, - "UpdatePartnerApp":{ - "name":"UpdatePartnerApp", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdatePartnerAppRequest"}, - "output":{"shape":"UpdatePartnerAppResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ], - "documentation":"

Updates all of the SageMaker Partner AI Apps in an account.

" - }, - "UpdatePipeline":{ - "name":"UpdatePipeline", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdatePipelineRequest"}, - "output":{"shape":"UpdatePipelineResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ], - "documentation":"

Updates a pipeline.

" - }, - "UpdatePipelineExecution":{ - "name":"UpdatePipelineExecution", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdatePipelineExecutionRequest"}, - "output":{"shape":"UpdatePipelineExecutionResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ], - "documentation":"

Updates a pipeline execution.

" - }, - "UpdatePipelineVersion":{ - "name":"UpdatePipelineVersion", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdatePipelineVersionRequest"}, - "output":{"shape":"UpdatePipelineVersionResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ], - "documentation":"

Updates a pipeline version.

" - }, - "UpdateProject":{ - "name":"UpdateProject", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateProjectInput"}, - "output":{"shape":"UpdateProjectOutput"}, - "errors":[ - {"shape":"ConflictException"} - ], - "documentation":"

Updates a machine learning (ML) project that is created from a template that sets up an ML pipeline from training to deploying an approved model.

You must not update a project that is in use. If you update the ServiceCatalogProvisioningUpdateDetails of a project that is active or being created, or updated, you may lose resources already created by the project.

" - }, - "UpdateSpace":{ - "name":"UpdateSpace", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateSpaceRequest"}, - "output":{"shape":"UpdateSpaceResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Updates the settings of a space.

You can't edit the app type of a space in the SpaceSettings.

" - }, - "UpdateTrainingJob":{ - "name":"UpdateTrainingJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateTrainingJobRequest"}, - "output":{"shape":"UpdateTrainingJobResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Update a model training job to request a new Debugger profiling configuration or to change warm pool retention length.

" - }, - "UpdateTrial":{ - "name":"UpdateTrial", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateTrialRequest"}, - "output":{"shape":"UpdateTrialResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ], - "documentation":"

Updates the display name of a trial.

" - }, - "UpdateTrialComponent":{ - "name":"UpdateTrialComponent", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateTrialComponentRequest"}, - "output":{"shape":"UpdateTrialComponentResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFound"} - ], - "documentation":"

Updates one or more properties of a trial component.

" - }, - "UpdateUserProfile":{ - "name":"UpdateUserProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateUserProfileRequest"}, - "output":{"shape":"UpdateUserProfileResponse"}, - "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Updates a user profile.

" - }, - "UpdateWorkforce":{ - "name":"UpdateWorkforce", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateWorkforceRequest"}, - "output":{"shape":"UpdateWorkforceResponse"}, - "errors":[ - {"shape":"ConflictException"} - ], - "documentation":"

Use this operation to update your workforce. You can use this operation to require that workers use specific IP addresses to work on tasks and to update your OpenID Connect (OIDC) Identity Provider (IdP) workforce configuration.

The worker portal is now supported in VPC and public internet.

Use SourceIpConfig to restrict worker access to tasks to a specific range of IP addresses. You specify allowed IP addresses by creating a list of up to ten CIDRs. By default, a workforce isn't restricted to specific IP addresses. If you specify a range of IP addresses, workers who attempt to access tasks using any IP address outside the specified range are denied and get a Not Found error message on the worker portal.

To restrict public internet access for all workers, configure the SourceIpConfig CIDR value. For example, when using SourceIpConfig with an IpAddressType of IPv4, you can restrict access to the IPv4 CIDR block \"10.0.0.0/16\". When using an IpAddressType of dualstack, you can specify both the IPv4 and IPv6 CIDR blocks, such as \"10.0.0.0/16\" for IPv4 only, \"2001:db8:1234:1a00::/56\" for IPv6 only, or \"10.0.0.0/16\" and \"2001:db8:1234:1a00::/56\" for dual stack.

Amazon SageMaker does not support Source Ip restriction for worker portals in VPC.

Use OidcConfig to update the configuration of a workforce created using your own OIDC IdP.

You can only update your OIDC IdP configuration when there are no work teams associated with your workforce. You can delete work teams using the DeleteWorkteam operation.

After restricting access to a range of IP addresses or updating your OIDC IdP configuration with this operation, you can view details about your update workforce using the DescribeWorkforce operation.

This operation only applies to private workforces.

" - }, - "UpdateWorkteam":{ - "name":"UpdateWorkteam", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateWorkteamRequest"}, - "output":{"shape":"UpdateWorkteamResponse"}, - "errors":[ - {"shape":"ResourceLimitExceeded"} - ], - "documentation":"

Updates an existing work team with new member definitions or description.

" - } - }, - "shapes":{ - "AIAdapterId":{ - "type":"string", - "documentation":"

A unique identifier for a LoRA adapter within a recommendation job request. The ID must start and end with an alphanumeric character, can contain hyphens between alphanumeric characters, and can be up to 63 characters long. This ID is used as the inference component name when the adapter is deployed.

", - "max":63, - "min":1, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9])*" - }, - "AIAdapterModelPackageEntry":{ - "type":"structure", - "required":[ - "AdapterId", - "ModelPackageArn" - ], - "members":{ - "AdapterId":{ - "shape":"AIAdapterId", - "documentation":"

A unique identifier for the adapter. This ID is used as the inference component name when the adapter is deployed. The ID must start and end with an alphanumeric character, can contain hyphens between alphanumeric characters, and can be up to 63 characters long.

" - }, - "ModelPackageArn":{ - "shape":"ModelPackageArn", - "documentation":"

The Amazon Resource Name (ARN) of the model package that contains the LoRA adapter artifacts.

" - } - }, - "documentation":"

A LoRA adapter entry identified by a model package ARN.

" - }, - "AIAdapterModelPackageEntryList":{ - "type":"list", - "member":{"shape":"AIAdapterModelPackageEntry"}, - "max":10, - "min":1 - }, - "AIAdapterS3Entry":{ - "type":"structure", - "required":[ - "AdapterId", - "S3Uri" - ], - "members":{ - "AdapterId":{ - "shape":"AIAdapterId", - "documentation":"

A unique identifier for the adapter. This ID is used as the inference component name when the adapter is deployed. The ID must start and end with an alphanumeric character, can contain hyphens between alphanumeric characters, and can be up to 63 characters long.

" - }, - "S3Uri":{ - "shape":"S3Uri", - "documentation":"

The Amazon S3 URI of the directory that contains the LoRA adapter artifacts in PEFT format.

" - } - }, - "documentation":"

A LoRA adapter entry identified by an Amazon S3 URI.

" - }, - "AIAdapterS3EntryList":{ - "type":"list", - "member":{"shape":"AIAdapterS3Entry"}, - "max":10, - "min":1 - }, - "AIAdapterSource":{ - "type":"structure", - "members":{ - "ModelPackageArns":{ - "shape":"AIAdapterModelPackageEntryList", - "documentation":"

A list of LoRA adapters identified by their model package ARNs. Use this when your adapters were produced by a SageMaker AI fine-tuning workflow that registers model packages.

" - }, - "S3Uris":{ - "shape":"AIAdapterS3EntryList", - "documentation":"

A list of LoRA adapters identified by their Amazon S3 URIs. Use this when your adapters are stored as raw artifacts in Amazon S3.

" - } - }, - "documentation":"

The source of LoRA adapters for an AI recommendation job. This is a union type — specify exactly one of the members.

", - "union":true - }, - "AIBenchmarkEndpoint":{ - "type":"structure", - "required":["Identifier"], - "members":{ - "Identifier":{ - "shape":"AIResourceIdentifier", - "documentation":"

The name or Amazon Resource Name (ARN) of the SageMaker endpoint to benchmark.

" - }, - "TargetContainerHostname":{ - "shape":"String", - "documentation":"

The hostname of the specific container to target within a multi-container endpoint.

" - }, - "InferenceComponents":{ - "shape":"AIBenchmarkInferenceComponentList", - "documentation":"

The list of inference components to benchmark on the endpoint.

" - } - }, - "documentation":"

The SageMaker endpoint configuration for benchmarking.

" - }, - "AIBenchmarkInferenceComponent":{ - "type":"structure", - "required":["Identifier"], - "members":{ - "Identifier":{ - "shape":"AIResourceIdentifier", - "documentation":"

The name or Amazon Resource Name (ARN) of the inference component.

" - } - }, - "documentation":"

An inference component to benchmark.

" - }, - "AIBenchmarkInferenceComponentList":{ - "type":"list", - "member":{"shape":"AIBenchmarkInferenceComponent"} - }, - "AIBenchmarkJobArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:ai-benchmark-job/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" - }, - "AIBenchmarkJobStatus":{ - "type":"string", - "enum":[ - "InProgress", - "Completed", - "Failed", - "Stopping", - "Stopped" - ] - }, - "AIBenchmarkJobSummary":{ - "type":"structure", - "required":[ - "AIBenchmarkJobName", - "AIBenchmarkJobArn", - "AIBenchmarkJobStatus", - "CreationTime" - ], - "members":{ - "AIBenchmarkJobName":{ - "shape":"AIEntityName", - "documentation":"

The name of the benchmark job.

" - }, - "AIBenchmarkJobArn":{ - "shape":"AIBenchmarkJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the benchmark job.

" - }, - "AIBenchmarkJobStatus":{ - "shape":"AIBenchmarkJobStatus", - "documentation":"

The status of the benchmark job.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that indicates when the benchmark job was created.

" - }, - "EndTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that indicates when the benchmark job completed.

" - }, - "AIWorkloadConfigName":{ - "shape":"AIEntityName", - "documentation":"

The name of the AI workload configuration used by the benchmark job.

" - } - }, - "documentation":"

Summary information about an AI benchmark job.

" - }, - "AIBenchmarkJobSummaryList":{ - "type":"list", - "member":{"shape":"AIBenchmarkJobSummary"} - }, - "AIBenchmarkNetworkConfig":{ - "type":"structure", - "members":{ - "VpcConfig":{ - "shape":"VpcConfig", - "documentation":"

The VPC configuration, including security group IDs and subnet IDs.

" - } - }, - "documentation":"

The network configuration for an AI benchmark job.

" - }, - "AIBenchmarkOutputConfig":{ - "type":"structure", - "required":["S3OutputLocation"], - "members":{ - "S3OutputLocation":{ - "shape":"S3Uri", - "documentation":"

The Amazon S3 URI where benchmark results are stored.

" - }, - "MlflowConfig":{ - "shape":"AIMlflowConfig", - "documentation":"

The MLflow tracking configuration for the job. If you don't specify this parameter, MLflow tracking is disabled.

" - } - }, - "documentation":"

The output configuration for an AI benchmark job.

" - }, - "AIBenchmarkOutputResult":{ - "type":"structure", - "required":["S3OutputLocation"], - "members":{ - "S3OutputLocation":{ - "shape":"S3Uri", - "documentation":"

The Amazon S3 URI where benchmark results are stored.

" - }, - "CloudWatchLogs":{ - "shape":"AICloudWatchLogsList", - "documentation":"

The CloudWatch log information for the benchmark job.

" - }, - "MlflowConfig":{ - "shape":"AIMlflowConfig", - "documentation":"

The MLflow tracking configuration for the job.

" - } - }, - "documentation":"

The output result of an AI benchmark job, including the Amazon S3 location and CloudWatch log information.

" - }, - "AIBenchmarkTarget":{ - "type":"structure", - "members":{ - "Endpoint":{ - "shape":"AIBenchmarkEndpoint", - "documentation":"

The SageMaker endpoint to benchmark.

" - } - }, - "documentation":"

The target for an AI benchmark job. This is a union type — specify one of the members.

", - "union":true - }, - "AICapacityReservationConfig":{ - "type":"structure", - "members":{ - "CapacityReservationPreference":{ - "shape":"AICapacityReservationPreference", - "documentation":"

The capacity reservation preference. The only valid value is capacity-reservations-only.

" - }, - "MlReservationArns":{ - "shape":"AIMlReservationArnList", - "documentation":"

The list of ML reservation ARNs to use.

" - } - }, - "documentation":"

The capacity reservation configuration for an AI recommendation job.

" - }, - "AICapacityReservationPreference":{ - "type":"string", - "enum":["capacity-reservations-only"] - }, - "AIChannelName":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[A-Za-z0-9\\.\\-_]+" - }, - "AICloudWatchLogs":{ - "type":"structure", - "members":{ - "LogGroupArn":{ - "shape":"String", - "documentation":"

The Amazon Resource Name (ARN) of the CloudWatch log group.

" - }, - "LogStreamName":{ - "shape":"String", - "documentation":"

The name of the CloudWatch log stream.

" - } - }, - "documentation":"

CloudWatch log information for an AI benchmark or recommendation job.

" - }, - "AICloudWatchLogsList":{ - "type":"list", - "member":{"shape":"AICloudWatchLogs"} - }, - "AIDatasetConfig":{ - "type":"structure", - "members":{ - "InputDataConfig":{ - "shape":"AIWorkloadInputDataConfigList", - "documentation":"

An array of input data channel configurations for the workload.

" - } - }, - "documentation":"

The dataset configuration for an AI workload. This is a union type — specify one of the members.

", - "union":true - }, - "AIEntityName":{ - "type":"string", - "max":63, - "min":1, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" - }, - "AIInferenceSpecificationName":{ - "type":"string", - "max":63, - "min":0, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" - }, - "AIMlReservationArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:[a-z0-9\\-]{1,14}/.*" - }, - "AIMlReservationArnList":{ - "type":"list", - "member":{"shape":"AIMlReservationArn"} - }, - "AIMlflowConfig":{ - "type":"structure", - "required":["MlflowResourceArn"], - "members":{ - "MlflowResourceArn":{ - "shape":"AIMlflowResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the SageMaker managed MLflow resource.

" - }, - "MlflowExperimentName":{ - "shape":"AIMlflowExperimentName", - "documentation":"

The MLflow experiment name used for tracking.

" - }, - "MlflowRunName":{ - "shape":"AIMlflowRunName", - "documentation":"

The MLflow run name used for tracking.

" - } - }, - "documentation":"

The MLflow tracking configuration for logging metrics and parameters to a SageMaker managed MLflow tracking server.

" - }, - "AIMlflowExperimentName":{ - "type":"string", - "max":256, - "min":1, - "pattern":"[a-zA-Z0-9\\-_./]+" - }, - "AIMlflowResourceArn":{ - "type":"string", - "max":2048, - "min":20, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:mlflow-(app|tracking-server)/.*" - }, - "AIMlflowRunName":{ - "type":"string", - "max":256, - "min":1, - "pattern":"[a-zA-Z0-9\\-_./]+" - }, - "AIModelSource":{ - "type":"structure", - "members":{ - "S3":{ - "shape":"AIModelSourceS3", - "documentation":"

The Amazon S3 location of the model artifacts.

" - } - }, - "documentation":"

The source of the model for an AI recommendation job. This is a union type.

", - "union":true - }, - "AIModelSourceS3":{ - "type":"structure", - "members":{ - "S3Uri":{ - "shape":"S3Uri", - "documentation":"

The Amazon S3 URI of the model artifacts.

" - } - }, - "documentation":"

The Amazon S3 model source configuration.

" - }, - "AIRecommendation":{ - "type":"structure", - "members":{ - "RecommendationDescription":{ - "shape":"String", - "documentation":"

A description of the recommendation.

" - }, - "OptimizationDetails":{ - "shape":"AIRecommendationOptimizationDetailList", - "documentation":"

The optimization techniques applied in this recommendation.

" - }, - "ModelDetails":{ - "shape":"AIRecommendationModelDetails", - "documentation":"

Details about the model package associated with this recommendation.

" - }, - "DeploymentConfiguration":{ - "shape":"AIRecommendationDeploymentConfiguration", - "documentation":"

The deployment configuration for this recommendation, including the container image, instance type, instance count, and environment variables.

" - }, - "AIBenchmarkJobArn":{ - "shape":"AIBenchmarkJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the benchmark job associated with this recommendation.

" - }, - "ExpectedPerformance":{ - "shape":"ExpectedPerformanceList", - "documentation":"

The expected performance metrics for this recommendation.

" - }, - "AdapterDetails":{ - "shape":"AIRecommendationAdapterDetails", - "documentation":"

The LoRA adapter details for this recommendation. This field contains both the model package ARNs and Amazon S3 URIs for each adapter, regardless of which form was originally supplied. This field is absent when the job was created without LoRA adapters.

" - } - }, - "documentation":"

An optimization recommendation generated by an AI recommendation job.

" - }, - "AIRecommendationAdapterDetails":{ - "type":"structure", - "required":[ - "ModelPackageArns", - "S3Uris" - ], - "members":{ - "ModelPackageArns":{ - "shape":"AIAdapterModelPackageEntryList", - "documentation":"

The list of LoRA adapters with their model package ARNs.

" - }, - "S3Uris":{ - "shape":"AIAdapterS3EntryList", - "documentation":"

The list of LoRA adapters with their Amazon S3 URIs.

" - } - }, - "documentation":"

The per-recommendation LoRA adapter details. Contains both the model package ARNs and Amazon S3 URIs for each adapter, regardless of which form was originally supplied in the request. When you supply only Amazon S3 URIs, Amazon SageMaker AI creates model packages on your behalf.

" - }, - "AIRecommendationAllowOptimization":{ - "type":"boolean", - "box":true - }, - "AIRecommendationComputeSpec":{ - "type":"structure", - "members":{ - "InstanceTypes":{ - "shape":"AIRecommendationInstanceTypeList", - "documentation":"

The list of instance types to consider for recommendations. You can specify up to 3 instance types.

" - }, - "CapacityReservationConfig":{ - "shape":"AICapacityReservationConfig", - "documentation":"

The capacity reservation configuration.

" - } - }, - "documentation":"

The compute resource specification for an AI recommendation job.

" - }, - "AIRecommendationConstraint":{ - "type":"structure", - "required":["Metric"], - "members":{ - "Metric":{ - "shape":"AIRecommendationMetric", - "documentation":"

The performance metric. Valid values are ttft-ms (time to first token in milliseconds), throughput, and cost.

" - } - }, - "documentation":"

A performance constraint for an AI recommendation job.

" - }, - "AIRecommendationConstraintList":{ - "type":"list", - "member":{"shape":"AIRecommendationConstraint"} - }, - "AIRecommendationCopyCountPerInstance":{ - "type":"integer", - "box":true - }, - "AIRecommendationDeploymentConfiguration":{ - "type":"structure", - "members":{ - "S3":{ - "shape":"AIRecommendationDeploymentS3ChannelList", - "documentation":"

The Amazon S3 data channels for the deployment.

" - }, - "ImageUri":{ - "shape":"String", - "documentation":"

The URI of the container image for the deployment.

" - }, - "InstanceType":{ - "shape":"AIRecommendationInstanceType", - "documentation":"

The recommended instance type for the deployment.

" - }, - "InstanceCount":{ - "shape":"AIRecommendationInstanceCount", - "documentation":"

The recommended number of instances for the deployment.

" - }, - "CopyCountPerInstance":{ - "shape":"AIRecommendationCopyCountPerInstance", - "documentation":"

The number of model copies per instance.

" - }, - "EnvironmentVariables":{ - "shape":"EnvironmentMap", - "documentation":"

The environment variables for the deployment.

" - }, - "MinCpuMemoryRequiredInMb":{ - "shape":"AIRecommendationMinCpuMemoryRequiredInMb", - "documentation":"

The minimum host (CPU) memory, in MiB, to reserve for each model copy when deploying the recommendation as an Inference Component. This value maps to the Inference Component's ComputeResourceRequirements$MinMemoryRequiredInMb field.

" - } - }, - "documentation":"

The deployment configuration for a recommendation.

" - }, - "AIRecommendationDeploymentS3Channel":{ - "type":"structure", - "members":{ - "ChannelName":{ - "shape":"AIChannelName", - "documentation":"

A custom name for this Amazon S3 data channel.

" - }, - "Uri":{ - "shape":"S3Uri", - "documentation":"

The Amazon S3 URI of the data for this channel.

" - } - }, - "documentation":"

An Amazon S3 data channel for a recommended deployment configuration, containing model artifacts or optimized model outputs.

" - }, - "AIRecommendationDeploymentS3ChannelList":{ - "type":"list", - "member":{"shape":"AIRecommendationDeploymentS3Channel"} - }, - "AIRecommendationInferenceFramework":{ - "type":"string", - "enum":[ - "LMI", - "VLLM" - ] - }, - "AIRecommendationInferenceSpecification":{ - "type":"structure", - "members":{ - "Framework":{ - "shape":"AIRecommendationInferenceFramework", - "documentation":"

The inference framework. Valid values are LMI and VLLM.

" - } - }, - "documentation":"

The inference framework for an AI recommendation job.

" - }, - "AIRecommendationInstanceCount":{ - "type":"integer", - "box":true - }, - "AIRecommendationInstanceDetail":{ - "type":"structure", - "members":{ - "InstanceType":{ - "shape":"AIRecommendationInstanceType", - "documentation":"

The recommended instance type.

" - }, - "InstanceCount":{ - "shape":"AIRecommendationInstanceCount", - "documentation":"

The recommended number of instances.

" - }, - "CopyCountPerInstance":{ - "shape":"AIRecommendationCopyCountPerInstance", - "documentation":"

The number of model copies per instance.

" - } - }, - "documentation":"

Instance details for a recommendation.

" - }, - "AIRecommendationInstanceDetailList":{ - "type":"list", - "member":{"shape":"AIRecommendationInstanceDetail"} - }, - "AIRecommendationInstanceType":{ - "type":"string", - "enum":[ - "ml.g5.xlarge", - "ml.g5.2xlarge", - "ml.g5.4xlarge", - "ml.g5.8xlarge", - "ml.g5.12xlarge", - "ml.g5.16xlarge", - "ml.g5.24xlarge", - "ml.g5.48xlarge", - "ml.g6.xlarge", - "ml.g6.2xlarge", - "ml.g6.4xlarge", - "ml.g6.8xlarge", - "ml.g6.12xlarge", - "ml.g6.16xlarge", - "ml.g6.24xlarge", - "ml.g6.48xlarge", - "ml.g6e.xlarge", - "ml.g6e.2xlarge", - "ml.g6e.4xlarge", - "ml.g6e.8xlarge", - "ml.g6e.12xlarge", - "ml.g6e.16xlarge", - "ml.g6e.24xlarge", - "ml.g6e.48xlarge", - "ml.g7e.2xlarge", - "ml.g7e.4xlarge", - "ml.g7e.8xlarge", - "ml.g7e.12xlarge", - "ml.g7e.24xlarge", - "ml.g7e.48xlarge", - "ml.p3.2xlarge", - "ml.p3.8xlarge", - "ml.p3.16xlarge", - "ml.p4d.24xlarge", - "ml.p4de.24xlarge", - "ml.p5.4xlarge", - "ml.p5.48xlarge", - "ml.p5e.48xlarge", - "ml.p5en.48xlarge", - "ml.p6-b200.48xlarge" - ] - }, - "AIRecommendationInstanceTypeList":{ - "type":"list", - "member":{"shape":"AIRecommendationInstanceType"}, - "max":3, - "min":0 - }, - "AIRecommendationJobArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:ai-recommendation-job/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" - }, - "AIRecommendationJobStatus":{ - "type":"string", - "enum":[ - "InProgress", - "Completed", - "Failed", - "Stopping", - "Stopped" - ] - }, - "AIRecommendationJobSummary":{ - "type":"structure", - "required":[ - "AIRecommendationJobName", - "AIRecommendationJobArn", - "AIRecommendationJobStatus", - "CreationTime" - ], - "members":{ - "AIRecommendationJobName":{ - "shape":"AIEntityName", - "documentation":"

The name of the recommendation job.

" - }, - "AIRecommendationJobArn":{ - "shape":"AIRecommendationJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the recommendation job.

" - }, - "AIRecommendationJobStatus":{ - "shape":"AIRecommendationJobStatus", - "documentation":"

The status of the recommendation job.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that indicates when the recommendation job was created.

" - }, - "EndTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that indicates when the recommendation job completed.

" - } - }, - "documentation":"

Summary information about an AI recommendation job.

" - }, - "AIRecommendationJobSummaryList":{ - "type":"list", - "member":{"shape":"AIRecommendationJobSummary"} - }, - "AIRecommendationList":{ - "type":"list", - "member":{"shape":"AIRecommendation"} - }, - "AIRecommendationMetric":{ - "type":"string", - "enum":[ - "ttft-ms", - "throughput", - "cost" - ] - }, - "AIRecommendationMinCpuMemoryRequiredInMb":{ - "type":"integer", - "box":true, - "min":1 - }, - "AIRecommendationModelDetails":{ - "type":"structure", - "members":{ - "ModelPackageArn":{ - "shape":"ModelPackageArn", - "documentation":"

The Amazon Resource Name (ARN) of the model package.

" - }, - "InferenceSpecificationName":{ - "shape":"AIInferenceSpecificationName", - "documentation":"

The name of the inference specification within the model package.

" - }, - "InstanceDetails":{ - "shape":"AIRecommendationInstanceDetailList", - "documentation":"

The instance details for this recommendation, including instance type, count, and model copies per instance.

" - } - }, - "documentation":"

Details about the model package in a recommendation.

" - }, - "AIRecommendationOptimizationConfigMap":{ - "type":"map", - "key":{"shape":"String"}, - "value":{"shape":"String"} - }, - "AIRecommendationOptimizationDetail":{ - "type":"structure", - "required":["OptimizationType"], - "members":{ - "OptimizationType":{ - "shape":"AIRecommendationOptimizationType", - "documentation":"

The type of optimization. Valid values are SpeculativeDecoding and KernelTuning.

" - }, - "OptimizationConfig":{ - "shape":"AIRecommendationOptimizationConfigMap", - "documentation":"

A map of configuration parameters for the optimization technique.

" - } - }, - "documentation":"

Details about an optimization technique applied in a recommendation.

" - }, - "AIRecommendationOptimizationDetailList":{ - "type":"list", - "member":{"shape":"AIRecommendationOptimizationDetail"} - }, - "AIRecommendationOptimizationType":{ - "type":"string", - "enum":[ - "SpeculativeDecoding", - "KernelTuning" - ] - }, - "AIRecommendationOutputConfig":{ - "type":"structure", - "members":{ - "S3OutputLocation":{ - "shape":"S3Uri", - "documentation":"

The Amazon S3 URI where recommendation results are stored.

" - }, - "ModelPackageGroupIdentifier":{ - "shape":"AIResourceIdentifier", - "documentation":"

The name or Amazon Resource Name (ARN) of the model package group where the optimized model is registered as a new model package version.

" - }, - "MlflowConfig":{ - "shape":"AIMlflowConfig", - "documentation":"

The MLflow tracking configuration for the job. If you don't specify this parameter, MLflow tracking is disabled.

" - } - }, - "documentation":"

The output configuration for an AI recommendation job.

" - }, - "AIRecommendationOutputResult":{ - "type":"structure", - "required":["S3OutputLocation"], - "members":{ - "S3OutputLocation":{ - "shape":"S3Uri", - "documentation":"

The Amazon S3 URI where the recommendation job writes its output results.

" - }, - "ModelPackageGroupIdentifier":{ - "shape":"AIResourceIdentifier", - "documentation":"

The name or Amazon Resource Name (ARN) of the model package group where deployment-ready model packages are registered.

" - }, - "MlflowConfig":{ - "shape":"AIMlflowConfig", - "documentation":"

The MLflow tracking configuration for the job.

" - } - }, - "documentation":"

The output configuration for an AI recommendation job, including the S3 location for results and the model package group for deployment.

" - }, - "AIRecommendationPerformanceMetric":{ - "type":"structure", - "required":[ - "Metric", - "Value" - ], - "members":{ - "Metric":{ - "shape":"String", - "documentation":"

The name of the performance metric.

" - }, - "Stat":{ - "shape":"String", - "documentation":"

The statistical measure for the metric.

" - }, - "Value":{ - "shape":"String", - "documentation":"

The value of the metric.

" - }, - "Unit":{ - "shape":"String", - "documentation":"

The unit of the metric value.

" - } - }, - "documentation":"

An expected performance metric for a recommendation.

" - }, - "AIRecommendationPerformanceTarget":{ - "type":"structure", - "required":["Constraints"], - "members":{ - "Constraints":{ - "shape":"AIRecommendationConstraintList", - "documentation":"

An array of performance constraints that define the optimization objectives.

" - } - }, - "documentation":"

The performance targets for an AI recommendation job.

" - }, - "AIResourceIdentifier":{ - "type":"string", - "max":256, - "min":1, - "pattern":"(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:[a-z\\-]*/)?([a-zA-Z0-9]([a-zA-Z0-9\\-]){0,62})(?The name of the AI workload configuration.

" - }, - "AIWorkloadConfigArn":{ - "shape":"AIWorkloadConfigArn", - "documentation":"

The Amazon Resource Name (ARN) of the AI workload configuration.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that indicates when the configuration was created.

" - } - }, - "documentation":"

Summary information about an AI workload configuration.

" - }, - "AIWorkloadConfigSummaryList":{ - "type":"list", - "member":{"shape":"AIWorkloadConfigSummary"} - }, - "AIWorkloadConfigs":{ - "type":"structure", - "required":["WorkloadSpec"], - "members":{ - "WorkloadSpec":{ - "shape":"WorkloadSpec", - "documentation":"

The workload specification that defines benchmark parameters.

" - } - }, - "documentation":"

The benchmark tool configuration for an AI workload.

" - }, - "AIWorkloadDataSource":{ - "type":"structure", - "members":{ - "S3DataSource":{ - "shape":"AIWorkloadS3DataSource", - "documentation":"

The Amazon S3 data source configuration.

" - } - }, - "documentation":"

The data source for an AI workload input data channel.

" - }, - "AIWorkloadInputDataConfig":{ - "type":"structure", - "required":[ - "ChannelName", - "DataSource" - ], - "members":{ - "ChannelName":{ - "shape":"AIChannelName", - "documentation":"

The logical name for the data channel.

" - }, - "DataSource":{ - "shape":"AIWorkloadDataSource", - "documentation":"

The data source for this channel.

" - } - }, - "documentation":"

A channel of input data for an AI workload configuration. Each channel has a name and a data source.

" - }, - "AIWorkloadInputDataConfigList":{ - "type":"list", - "member":{"shape":"AIWorkloadInputDataConfig"} - }, - "AIWorkloadS3DataSource":{ - "type":"structure", - "required":["S3Uri"], - "members":{ - "S3Uri":{ - "shape":"S3Uri", - "documentation":"

The Amazon S3 URI of the data.

" - } - }, - "documentation":"

The Amazon S3 data source for an AI workload.

" - }, - "AbsoluteBorrowLimitResourceList":{ - "type":"list", - "member":{"shape":"ComputeQuotaResourceConfig"}, - "max":15, - "min":0 - }, - "AcceleratorPartitionConfig":{ - "type":"structure", - "required":[ - "Type", - "Count" - ], - "members":{ - "Type":{ - "shape":"MIGProfileType", - "documentation":"

The Multi-Instance GPU (MIG) profile type that defines the partition configuration. The profile specifies the compute and memory allocation for each partition instance. The available profile types depend on the instance type specified in the compute quota configuration.

" - }, - "Count":{ - "shape":"AcceleratorPartitionConfigCountInteger", - "documentation":"

The number of accelerator partitions to allocate with the specified partition type. If you don't specify a value for vCPU and MemoryInGiB, SageMaker AI automatically allocates ratio-based values for those parameters based on the accelerator partition count you provide.

", - "box":true - } - }, - "documentation":"

Configuration for allocating accelerator partitions.

" - }, - "AcceleratorPartitionConfigCountInteger":{ - "type":"integer", - "max":10000000, - "min":0 - }, - "AcceleratorsAmount":{ - "type":"integer", - "box":true, - "max":10000000, - "min":0 - }, - "Accept":{ - "type":"string", - "max":256, - "min":0, - "pattern":".*" - }, - "AcceptEula":{"type":"boolean"}, - "AccountDefaultStatus":{ - "type":"string", - "enum":[ - "ENABLED", - "DISABLED" - ] - }, - "AccountId":{ - "type":"string", - "max":12, - "min":12, - "pattern":"\\d+" - }, - "ActionArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:action/.*" - }, - "ActionSource":{ - "type":"structure", - "required":["SourceUri"], - "members":{ - "SourceUri":{ - "shape":"SourceUri", - "documentation":"

The URI of the source.

" - }, - "SourceType":{ - "shape":"String256", - "documentation":"

The type of the source.

" - }, - "SourceId":{ - "shape":"String256", - "documentation":"

The ID of the source.

" - } - }, - "documentation":"

A structure describing the source of an action.

" - }, - "ActionStatus":{ - "type":"string", - "enum":[ - "Unknown", - "InProgress", - "Completed", - "Failed", - "Stopping", - "Stopped" - ] - }, - "ActionSummaries":{ - "type":"list", - "member":{"shape":"ActionSummary"} - }, - "ActionSummary":{ - "type":"structure", - "members":{ - "ActionArn":{ - "shape":"ActionArn", - "documentation":"

The Amazon Resource Name (ARN) of the action.

" - }, - "ActionName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the action.

" - }, - "Source":{ - "shape":"ActionSource", - "documentation":"

The source of the action.

" - }, - "ActionType":{ - "shape":"String64", - "documentation":"

The type of the action.

" - }, - "Status":{ - "shape":"ActionStatus", - "documentation":"

The status of the action.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

When the action was created.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

When the action was last modified.

" - } - }, - "documentation":"

Lists the properties of an action. An action represents an action or activity. Some examples are a workflow step and a model deployment. Generally, an action involves at least one input artifact or output artifact.

" - }, - "ActivationState":{ - "type":"string", - "enum":[ - "Enabled", - "Disabled" - ] - }, - "ActiveClusterOperationCount":{ - "type":"integer", - "box":true, - "min":1 - }, - "ActiveClusterOperationName":{ - "type":"string", - "enum":["Scaling"] - }, - "ActiveOperations":{ - "type":"map", - "key":{"shape":"ActiveClusterOperationName"}, - "value":{"shape":"ActiveClusterOperationCount"} - }, - "AddAssociationRequest":{ - "type":"structure", - "required":[ - "SourceArn", - "DestinationArn" - ], - "members":{ - "SourceArn":{ - "shape":"AssociationEntityArn", - "documentation":"

The ARN of the source.

" - }, - "DestinationArn":{ - "shape":"AssociationEntityArn", - "documentation":"

The Amazon Resource Name (ARN) of the destination.

" - }, - "AssociationType":{ - "shape":"AssociationEdgeType", - "documentation":"

The type of association. The following are suggested uses for each type. Amazon SageMaker places no restrictions on their use.

  • ContributedTo - The source contributed to the destination or had a part in enabling the destination. For example, the training data contributed to the training job.

  • AssociatedWith - The source is connected to the destination. For example, an approval workflow is associated with a model deployment.

  • DerivedFrom - The destination is a modification of the source. For example, a digest output of a channel input for a processing job is derived from the original inputs.

  • Produced - The source generated the destination. For example, a training job produced a model artifact.

" - } - } - }, - "AddAssociationResponse":{ - "type":"structure", - "members":{ - "SourceArn":{ - "shape":"AssociationEntityArn", - "documentation":"

The ARN of the source.

" - }, - "DestinationArn":{ - "shape":"AssociationEntityArn", - "documentation":"

The Amazon Resource Name (ARN) of the destination.

" - } - } - }, - "AddClusterNodeSpecification":{ - "type":"structure", - "required":[ - "InstanceGroupName", - "IncrementTargetCountBy" - ], - "members":{ - "InstanceGroupName":{ - "shape":"ClusterInstanceGroupName", - "documentation":"

The name of the instance group to which you want to add nodes.

" - }, - "IncrementTargetCountBy":{ - "shape":"AddClusterNodeSpecificationIncrementTargetCountByInteger", - "documentation":"

The number of nodes to add to the specified instance group. The total number of nodes across all instance groups in a single request cannot exceed 50.

" - }, - "AvailabilityZones":{ - "shape":"ClusterAvailabilityZones", - "documentation":"

The availability zones in which to add nodes. Use this to target node placement in specific availability zones within a flexible instance group.

" - }, - "InstanceTypes":{ - "shape":"ClusterInstanceTypes", - "documentation":"

The instance types to use when adding nodes. Use this to target specific instance types within a flexible instance group.

" - } - }, - "documentation":"

Specifies an instance group and the number of nodes to add to it.

" - }, - "AddClusterNodeSpecificationIncrementTargetCountByInteger":{ - "type":"integer", - "box":true, - "max":50, - "min":1 - }, - "AddClusterNodeSpecificationList":{ - "type":"list", - "member":{"shape":"AddClusterNodeSpecification"}, - "max":5, - "min":1 - }, - "AddTagsInput":{ - "type":"structure", - "required":[ - "ResourceArn", - "Tags" - ], - "members":{ - "ResourceArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the resource that you want to tag.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

" - } - } - }, - "AddTagsOutput":{ - "type":"structure", - "members":{ - "Tags":{ - "shape":"TagList", - "documentation":"

A list of tags associated with the SageMaker resource.

" - } - } - }, - "AdditionalCodeRepositoryNamesOrUrls":{ - "type":"list", - "member":{"shape":"CodeRepositoryNameOrUrl"}, - "max":3, - "min":0 - }, - "AdditionalEnis":{ - "type":"structure", - "members":{ - "EfaEnis":{ - "shape":"EfaEnis", - "documentation":"

A list of Elastic Fabric Adapter (EFA) ENIs associated with the instance.

" - } - }, - "documentation":"

Information about additional Elastic Network Interfaces (ENIs) associated with an instance.

" - }, - "AdditionalInferenceSpecificationDefinition":{ - "type":"structure", - "required":[ - "Name", - "Containers" - ], - "members":{ - "Name":{ - "shape":"EntityName", - "documentation":"

A unique name to identify the additional inference specification. The name must be unique within the list of your additional inference specifications for a particular model package.

" - }, - "Description":{ - "shape":"EntityDescription", - "documentation":"

A description of the additional Inference specification

" - }, - "Containers":{ - "shape":"ModelPackageContainerDefinitionList", - "documentation":"

The Amazon ECR registry path of the Docker image that contains the inference code.

" - }, - "SupportedTransformInstanceTypes":{ - "shape":"TransformInstanceTypes", - "documentation":"

A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.

" - }, - "SupportedRealtimeInferenceInstanceTypes":{ - "shape":"RealtimeInferenceInstanceTypes", - "documentation":"

A list of the instance types that are used to generate inferences in real-time.

" - }, - "SupportedContentTypes":{ - "shape":"ContentTypes", - "documentation":"

The supported MIME types for the input data.

" - }, - "SupportedResponseMIMETypes":{ - "shape":"ResponseMIMETypes", - "documentation":"

The supported MIME types for the output data.

" - } - }, - "documentation":"

A structure of additional Inference Specification. Additional Inference Specification specifies details about inference jobs that can be run with models based on this model package

" - }, - "AdditionalInferenceSpecifications":{ - "type":"list", - "member":{"shape":"AdditionalInferenceSpecificationDefinition"}, - "max":15, - "min":1 - }, - "AdditionalModelChannelName":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[A-Za-z0-9\\.\\-_]+" - }, - "AdditionalModelDataSource":{ - "type":"structure", - "required":[ - "ChannelName", - "S3DataSource" - ], - "members":{ - "ChannelName":{ - "shape":"AdditionalModelChannelName", - "documentation":"

A custom name for this AdditionalModelDataSource object.

" - }, - "S3DataSource":{"shape":"S3ModelDataSource"} - }, - "documentation":"

Data sources that are available to your model in addition to the one that you specify for ModelDataSource when you use the CreateModel action.

" - }, - "AdditionalModelDataSources":{ - "type":"list", - "member":{"shape":"AdditionalModelDataSource"}, - "max":5, - "min":0 - }, - "AdditionalS3DataSource":{ - "type":"structure", - "required":[ - "S3DataType", - "S3Uri" - ], - "members":{ - "S3DataType":{ - "shape":"AdditionalS3DataSourceDataType", - "documentation":"

The data type of the additional data source that you specify for use in inference or training.

" - }, - "S3Uri":{ - "shape":"S3Uri", - "documentation":"

The uniform resource identifier (URI) used to identify an additional data source used in inference or training.

" - }, - "CompressionType":{ - "shape":"CompressionType", - "documentation":"

The type of compression used for an additional data source used in inference or training. Specify None if your additional data source is not compressed.

" - }, - "ETag":{ - "shape":"String", - "documentation":"

The ETag associated with S3 URI.

" - } - }, - "documentation":"

A data source used for training or inference that is in addition to the input dataset or model data.

" - }, - "AdditionalS3DataSourceDataType":{ - "type":"string", - "enum":[ - "S3Object", - "S3Prefix" - ] - }, - "AgentVersion":{ - "type":"structure", - "required":[ - "Version", - "AgentCount" - ], - "members":{ - "Version":{ - "shape":"EdgeVersion", - "documentation":"

Version of the agent.

" - }, - "AgentCount":{ - "shape":"Long", - "documentation":"

The number of Edge Manager agents.

", - "box":true - } - }, - "documentation":"

Edge Manager agent version.

" - }, - "AgentVersions":{ - "type":"list", - "member":{"shape":"AgentVersion"} - }, - "AggregationTransformationValue":{ - "type":"string", - "enum":[ - "sum", - "avg", - "first", - "min", - "max" - ] - }, - "AggregationTransformations":{ - "type":"map", - "key":{"shape":"TransformationAttributeName"}, - "value":{"shape":"AggregationTransformationValue"}, - "max":50, - "min":1 - }, - "Alarm":{ - "type":"structure", - "members":{ - "AlarmName":{ - "shape":"AlarmName", - "documentation":"

The name of a CloudWatch alarm in your account.

" - } - }, - "documentation":"

An Amazon CloudWatch alarm configured to monitor metrics on an endpoint.

" - }, - "AlarmDetails":{ - "type":"structure", - "required":["AlarmName"], - "members":{ - "AlarmName":{ - "shape":"AlarmName", - "documentation":"

The name of the alarm.

" - } - }, - "documentation":"

The details of the alarm to monitor during the AMI update.

" - }, - "AlarmList":{ - "type":"list", - "member":{"shape":"Alarm"}, - "max":10, - "min":1 - }, - "AlarmName":{ - "type":"string", - "max":255, - "min":1, - "pattern":"(?!\\s*$).+" - }, - "AlgorithmArn":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:algorithm/[\\S]{1,2048}" - }, - "AlgorithmImage":{ - "type":"string", - "max":255, - "min":0, - "pattern":".*" - }, - "AlgorithmSortBy":{ - "type":"string", - "enum":[ - "Name", - "CreationTime" - ] - }, - "AlgorithmSpecification":{ - "type":"structure", - "required":["TrainingInputMode"], - "members":{ - "TrainingImage":{ - "shape":"AlgorithmImage", - "documentation":"

The registry path of the Docker image that contains the training algorithm. For information about docker registry paths for SageMaker built-in algorithms, see Docker Registry Paths and Example Code in the Amazon SageMaker developer guide. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information about using your custom training container, see Using Your Own Algorithms with Amazon SageMaker.

You must specify either the algorithm name to the AlgorithmName parameter or the image URI of the algorithm container to the TrainingImage parameter.

For more information, see the note in the AlgorithmName parameter description.

" - }, - "AlgorithmName":{ - "shape":"ArnOrName", - "documentation":"

The name of the algorithm resource to use for the training job. This must be an algorithm resource that you created or subscribe to on Amazon Web Services Marketplace.

You must specify either the algorithm name to the AlgorithmName parameter or the image URI of the algorithm container to the TrainingImage parameter.

Note that the AlgorithmName parameter is mutually exclusive with the TrainingImage parameter. If you specify a value for the AlgorithmName parameter, you can't specify a value for TrainingImage, and vice versa.

If you specify values for both parameters, the training job might break; if you don't specify any value for both parameters, the training job might raise a null error.

" - }, - "TrainingInputMode":{"shape":"TrainingInputMode"}, - "MetricDefinitions":{ - "shape":"MetricDefinitionList", - "documentation":"

A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. SageMaker publishes each metric to Amazon CloudWatch.

" - }, - "EnableSageMakerMetricsTimeSeries":{ - "shape":"Boolean", - "documentation":"

To generate and save time-series metrics during training, set to true. The default is false and time-series metrics aren't generated except in the following cases:

", - "box":true - }, - "ContainerEntrypoint":{ - "shape":"TrainingContainerEntrypoint", - "documentation":"

The entrypoint script for a Docker container used to run a training job. This script takes precedence over the default train processing instructions. See How Amazon SageMaker Runs Your Training Image for more information.

" - }, - "ContainerArguments":{ - "shape":"TrainingContainerArguments", - "documentation":"

The arguments for a container used to run a training job. See How Amazon SageMaker Runs Your Training Image for additional information.

" - }, - "TrainingImageConfig":{ - "shape":"TrainingImageConfig", - "documentation":"

The configuration to use an image from a private Docker registry for a training job.

" - } - }, - "documentation":"

Specifies the training algorithm to use in a CreateTrainingJob request.

SageMaker uses its own SageMaker account credentials to pull and access built-in algorithms so built-in algorithms are universally accessible across all Amazon Web Services accounts. As a result, built-in algorithms have standard, unrestricted access. You cannot restrict built-in algorithms using IAM roles. Use custom algorithms if you require specific access controls.

For more information about algorithms provided by SageMaker, see Algorithms. For information about using your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.

" - }, - "AlgorithmStatus":{ - "type":"string", - "enum":[ - "Pending", - "InProgress", - "Completed", - "Failed", - "Deleting" - ] - }, - "AlgorithmStatusDetails":{ - "type":"structure", - "members":{ - "ValidationStatuses":{ - "shape":"AlgorithmStatusItemList", - "documentation":"

The status of algorithm validation.

" - }, - "ImageScanStatuses":{ - "shape":"AlgorithmStatusItemList", - "documentation":"

The status of the scan of the algorithm's Docker image container.

" - } - }, - "documentation":"

Specifies the validation and image scan statuses of the algorithm.

" - }, - "AlgorithmStatusItem":{ - "type":"structure", - "required":[ - "Name", - "Status" - ], - "members":{ - "Name":{ - "shape":"EntityName", - "documentation":"

The name of the algorithm for which the overall status is being reported.

" - }, - "Status":{ - "shape":"DetailedAlgorithmStatus", - "documentation":"

The current status.

" - }, - "FailureReason":{ - "shape":"String", - "documentation":"

if the overall status is Failed, the reason for the failure.

" - } - }, - "documentation":"

Represents the overall status of an algorithm.

" - }, - "AlgorithmStatusItemList":{ - "type":"list", - "member":{"shape":"AlgorithmStatusItem"} - }, - "AlgorithmSummary":{ - "type":"structure", - "required":[ - "AlgorithmName", - "AlgorithmArn", - "CreationTime", - "AlgorithmStatus" - ], - "members":{ - "AlgorithmName":{ - "shape":"EntityName", - "documentation":"

The name of the algorithm that is described by the summary.

" - }, - "AlgorithmArn":{ - "shape":"AlgorithmArn", - "documentation":"

The Amazon Resource Name (ARN) of the algorithm.

" - }, - "AlgorithmDescription":{ - "shape":"EntityDescription", - "documentation":"

A brief description of the algorithm.

" - }, - "CreationTime":{ - "shape":"CreationTime", - "documentation":"

A timestamp that shows when the algorithm was created.

" - }, - "AlgorithmStatus":{ - "shape":"AlgorithmStatus", - "documentation":"

The overall status of the algorithm.

" - } - }, - "documentation":"

Provides summary information about an algorithm.

" - }, - "AlgorithmSummaryList":{ - "type":"list", - "member":{"shape":"AlgorithmSummary"} - }, - "AlgorithmValidationProfile":{ - "type":"structure", - "required":[ - "ProfileName", - "TrainingJobDefinition" - ], - "members":{ - "ProfileName":{ - "shape":"EntityName", - "documentation":"

The name of the profile for the algorithm. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

" - }, - "TrainingJobDefinition":{ - "shape":"TrainingJobDefinition", - "documentation":"

The TrainingJobDefinition object that describes the training job that SageMaker runs to validate your algorithm.

" - }, - "TransformJobDefinition":{ - "shape":"TransformJobDefinition", - "documentation":"

The TransformJobDefinition object that describes the transform job that SageMaker runs to validate your algorithm.

" - } - }, - "documentation":"

Defines a training job and a batch transform job that SageMaker runs to validate your algorithm.

The data provided in the validation profile is made available to your buyers on Amazon Web Services Marketplace.

" - }, - "AlgorithmValidationProfiles":{ - "type":"list", - "member":{"shape":"AlgorithmValidationProfile"}, - "max":1, - "min":1 - }, - "AlgorithmValidationSpecification":{ - "type":"structure", - "required":[ - "ValidationRole", - "ValidationProfiles" - ], - "members":{ - "ValidationRole":{ - "shape":"RoleArn", - "documentation":"

The IAM roles that SageMaker uses to run the training jobs.

" - }, - "ValidationProfiles":{ - "shape":"AlgorithmValidationProfiles", - "documentation":"

An array of AlgorithmValidationProfile objects, each of which specifies a training job and batch transform job that SageMaker runs to validate your algorithm.

" - } - }, - "documentation":"

Specifies configurations for one or more training jobs that SageMaker runs to test the algorithm.

" - }, - "AmazonQSettings":{ - "type":"structure", - "members":{ - "Status":{ - "shape":"FeatureStatus", - "documentation":"

Whether Amazon Q has been enabled within the domain.

" - }, - "QProfileArn":{ - "shape":"QProfileArn", - "documentation":"

The ARN of the Amazon Q profile used within the domain.

" - } - }, - "documentation":"

A collection of settings that configure the Amazon Q experience within the domain.

" - }, - "AnnotationConsolidationConfig":{ - "type":"structure", - "required":["AnnotationConsolidationLambdaArn"], - "members":{ - "AnnotationConsolidationLambdaArn":{ - "shape":"LambdaFunctionArn", - "documentation":"

The Amazon Resource Name (ARN) of a Lambda function implements the logic for annotation consolidation and to process output data.

For built-in task types, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for AnnotationConsolidationLambdaArn. For custom labeling workflows, see Post-annotation Lambda.

Bounding box - Finds the most similar boxes from different workers based on the Jaccard index of the boxes.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-BoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-BoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-BoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-BoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-BoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-BoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-BoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-BoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-BoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-BoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-BoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-BoundingBox

Image classification - Uses a variant of the Expectation Maximization approach to estimate the true class of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClass

Multi-label image classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClassMultiLabel

Semantic segmentation - Treats each pixel in an image as a multi-class classification and treats pixel annotations from workers as \"votes\" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-SemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-SemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-SemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-SemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-SemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-SemanticSegmentation

Text classification - Uses a variant of the Expectation Maximization approach to estimate the true class of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClass

Multi-label text classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClassMultiLabel

Named entity recognition - Groups similar selections and calculates aggregate boundaries, resolving to most-assigned label.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-NamedEntityRecognition

Video Classification - Use this task type when you need workers to classify videos using predefined labels that you specify. Workers are shown videos and are asked to choose one label for each video.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoMultiClass

Video Frame Object Detection - Use this task type to have workers identify and locate objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to identify and localize various objects in a series of video frames, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectDetection

Video Frame Object Tracking - Use this task type to have workers track the movement of objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to track the movement of objects, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectTracking

3D Point Cloud Object Detection - Use this task type when you want workers to classify objects in a 3D point cloud by drawing 3D cuboids around objects. For example, you can use this task type to ask workers to identify different types of objects in a point cloud, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectDetection

3D Point Cloud Object Tracking - Use this task type when you want workers to draw 3D cuboids around objects that appear in a sequence of 3D point cloud frames. For example, you can use this task type to ask workers to track the movement of vehicles across multiple point cloud frames.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectTracking

3D Point Cloud Semantic Segmentation - Use this task type when you want workers to create a point-level semantic segmentation masks by painting objects in a 3D point cloud using different colors where each color is assigned to one of the classes you specify.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudSemanticSegmentation

Use the following ARNs for Label Verification and Adjustment Jobs

Use label verification and adjustment jobs to review and adjust labels. To learn more, see Verify and Adjust Labels .

Semantic Segmentation Adjustment - Treats each pixel in an image as a multi-class classification and treats pixel adjusted annotations from workers as \"votes\" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentSemanticSegmentation

Semantic Segmentation Verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgment for semantic segmentation labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationSemanticSegmentation

Bounding Box Adjustment - Finds the most similar boxes from different workers based on the Jaccard index of the adjusted annotations.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentBoundingBox

Bounding Box Verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgement for bounding box labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationBoundingBox

Video Frame Object Detection Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to classify and localize objects in a sequence of video frames.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectDetection

Video Frame Object Tracking Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to track object movement across a sequence of video frames.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectTracking

3D Point Cloud Object Detection Adjustment - Use this task type when you want workers to adjust 3D cuboids around objects in a 3D point cloud.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectDetection

3D Point Cloud Object Tracking Adjustment - Use this task type when you want workers to adjust 3D cuboids around objects that appear in a sequence of 3D point cloud frames.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectTracking

3D Point Cloud Semantic Segmentation Adjustment - Use this task type when you want workers to adjust a point-level semantic segmentation masks using a paint tool.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudSemanticSegmentation

Generative AI/Custom - Direct passthrough of output data without any transformation.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-PassThrough

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-PassThrough

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-PassThrough

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-PassThrough

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-PassThrough

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-PassThrough

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-PassThrough

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-PassThrough

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-PassThrough

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-PassThrough

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-PassThrough

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-PassThrough

" - } - }, - "documentation":"

Configures how labels are consolidated across human workers and processes output data.

" - }, - "AppArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:app/.*" - }, - "AppDetails":{ - "type":"structure", - "members":{ - "DomainId":{ - "shape":"DomainId", - "documentation":"

The domain ID.

" - }, - "UserProfileName":{ - "shape":"UserProfileName", - "documentation":"

The user profile name.

" - }, - "SpaceName":{ - "shape":"SpaceName", - "documentation":"

The name of the space.

" - }, - "AppType":{ - "shape":"AppType", - "documentation":"

The type of app.

" - }, - "AppName":{ - "shape":"AppName", - "documentation":"

The name of the app.

" - }, - "Status":{ - "shape":"AppStatus", - "documentation":"

The status.

" - }, - "CreationTime":{ - "shape":"CreationTime", - "documentation":"

The creation time.

" - }, - "ResourceSpec":{"shape":"ResourceSpec"} - }, - "documentation":"

Details about an Amazon SageMaker AI app.

" - }, - "AppImageConfigArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:app-image-config/.*" - }, - "AppImageConfigDetails":{ - "type":"structure", - "members":{ - "AppImageConfigArn":{ - "shape":"AppImageConfigArn", - "documentation":"

The ARN of the AppImageConfig.

" - }, - "AppImageConfigName":{ - "shape":"AppImageConfigName", - "documentation":"

The name of the AppImageConfig. Must be unique to your account.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

When the AppImageConfig was created.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

When the AppImageConfig was last modified.

" - }, - "KernelGatewayImageConfig":{ - "shape":"KernelGatewayImageConfig", - "documentation":"

The configuration for the file system and kernels in the SageMaker AI image.

" - }, - "JupyterLabAppImageConfig":{ - "shape":"JupyterLabAppImageConfig", - "documentation":"

The configuration for the file system and the runtime, such as the environment variables and entry point.

" - }, - "CodeEditorAppImageConfig":{ - "shape":"CodeEditorAppImageConfig", - "documentation":"

The configuration for the file system and the runtime, such as the environment variables and entry point.

" - } - }, - "documentation":"

The configuration for running a SageMaker AI image as a KernelGateway app.

" - }, - "AppImageConfigList":{ - "type":"list", - "member":{"shape":"AppImageConfigDetails"} - }, - "AppImageConfigName":{ - "type":"string", - "max":63, - "min":0, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" - }, - "AppImageConfigSortKey":{ - "type":"string", - "enum":[ - "CreationTime", - "LastModifiedTime", - "Name" - ] - }, - "AppInstanceType":{ - "type":"string", - "enum":[ - "system", - "ml.t3.micro", - "ml.t3.small", - "ml.t3.medium", - "ml.t3.large", - "ml.t3.xlarge", - "ml.t3.2xlarge", - "ml.m5.large", - "ml.m5.xlarge", - "ml.m5.2xlarge", - "ml.m5.4xlarge", - "ml.m5.8xlarge", - "ml.m5.12xlarge", - "ml.m5.16xlarge", - "ml.m5.24xlarge", - "ml.m5d.large", - "ml.m5d.xlarge", - "ml.m5d.2xlarge", - "ml.m5d.4xlarge", - "ml.m5d.8xlarge", - "ml.m5d.12xlarge", - "ml.m5d.16xlarge", - "ml.m5d.24xlarge", - "ml.c5.large", - "ml.c5.xlarge", - "ml.c5.2xlarge", - "ml.c5.4xlarge", - "ml.c5.9xlarge", - "ml.c5.12xlarge", - "ml.c5.18xlarge", - "ml.c5.24xlarge", - "ml.p3.2xlarge", - "ml.p3.8xlarge", - "ml.p3.16xlarge", - "ml.p3dn.24xlarge", - "ml.g4dn.xlarge", - "ml.g4dn.2xlarge", - "ml.g4dn.4xlarge", - "ml.g4dn.8xlarge", - "ml.g4dn.12xlarge", - "ml.g4dn.16xlarge", - "ml.r5.large", - "ml.r5.xlarge", - "ml.r5.2xlarge", - "ml.r5.4xlarge", - "ml.r5.8xlarge", - "ml.r5.12xlarge", - "ml.r5.16xlarge", - "ml.r5.24xlarge", - "ml.g5.xlarge", - "ml.g5.2xlarge", - "ml.g5.4xlarge", - "ml.g5.8xlarge", - "ml.g5.16xlarge", - "ml.g5.12xlarge", - "ml.g5.24xlarge", - "ml.g5.48xlarge", - "ml.g6.xlarge", - "ml.g6.2xlarge", - "ml.g6.4xlarge", - "ml.g6.8xlarge", - "ml.g6.12xlarge", - "ml.g6.16xlarge", - "ml.g6.24xlarge", - "ml.g6.48xlarge", - "ml.g6e.xlarge", - "ml.g6e.2xlarge", - "ml.g6e.4xlarge", - "ml.g6e.8xlarge", - "ml.g6e.12xlarge", - "ml.g6e.16xlarge", - "ml.g6e.24xlarge", - "ml.g6e.48xlarge", - "ml.geospatial.interactive", - "ml.p4d.24xlarge", - "ml.p4de.24xlarge", - "ml.trn1.2xlarge", - "ml.trn1.32xlarge", - "ml.trn1n.32xlarge", - "ml.p5.48xlarge", - "ml.p5en.48xlarge", - "ml.p6-b200.48xlarge", - "ml.m6i.large", - "ml.m6i.xlarge", - "ml.m6i.2xlarge", - "ml.m6i.4xlarge", - "ml.m6i.8xlarge", - "ml.m6i.12xlarge", - "ml.m6i.16xlarge", - "ml.m6i.24xlarge", - "ml.m6i.32xlarge", - "ml.m7i.large", - "ml.m7i.xlarge", - "ml.m7i.2xlarge", - "ml.m7i.4xlarge", - "ml.m7i.8xlarge", - "ml.m7i.12xlarge", - "ml.m7i.16xlarge", - "ml.m7i.24xlarge", - "ml.m7i.48xlarge", - "ml.c6i.large", - "ml.c6i.xlarge", - "ml.c6i.2xlarge", - "ml.c6i.4xlarge", - "ml.c6i.8xlarge", - "ml.c6i.12xlarge", - "ml.c6i.16xlarge", - "ml.c6i.24xlarge", - "ml.c6i.32xlarge", - "ml.c7i.large", - "ml.c7i.xlarge", - "ml.c7i.2xlarge", - "ml.c7i.4xlarge", - "ml.c7i.8xlarge", - "ml.c7i.12xlarge", - "ml.c7i.16xlarge", - "ml.c7i.24xlarge", - "ml.c7i.48xlarge", - "ml.r6i.large", - "ml.r6i.xlarge", - "ml.r6i.2xlarge", - "ml.r6i.4xlarge", - "ml.r6i.8xlarge", - "ml.r6i.12xlarge", - "ml.r6i.16xlarge", - "ml.r6i.24xlarge", - "ml.r6i.32xlarge", - "ml.r7i.large", - "ml.r7i.xlarge", - "ml.r7i.2xlarge", - "ml.r7i.4xlarge", - "ml.r7i.8xlarge", - "ml.r7i.12xlarge", - "ml.r7i.16xlarge", - "ml.r7i.24xlarge", - "ml.r7i.48xlarge", - "ml.m6id.large", - "ml.m6id.xlarge", - "ml.m6id.2xlarge", - "ml.m6id.4xlarge", - "ml.m6id.8xlarge", - "ml.m6id.12xlarge", - "ml.m6id.16xlarge", - "ml.m6id.24xlarge", - "ml.m6id.32xlarge", - "ml.c6id.large", - "ml.c6id.xlarge", - "ml.c6id.2xlarge", - "ml.c6id.4xlarge", - "ml.c6id.8xlarge", - "ml.c6id.12xlarge", - "ml.c6id.16xlarge", - "ml.c6id.24xlarge", - "ml.c6id.32xlarge", - "ml.r6id.large", - "ml.r6id.xlarge", - "ml.r6id.2xlarge", - "ml.r6id.4xlarge", - "ml.r6id.8xlarge", - "ml.r6id.12xlarge", - "ml.r6id.16xlarge", - "ml.r6id.24xlarge", - "ml.r6id.32xlarge", - "ml.p5.4xlarge", - "ml.g7.2xlarge", - "ml.g7.4xlarge", - "ml.g7.8xlarge", - "ml.g7.12xlarge", - "ml.g7.24xlarge", - "ml.g7.48xlarge", - "ml.g7e.2xlarge", - "ml.g7e.4xlarge", - "ml.g7e.8xlarge", - "ml.g7e.12xlarge", - "ml.g7e.24xlarge", - "ml.g7e.48xlarge" - ] - }, - "AppLifecycleManagement":{ - "type":"structure", - "members":{ - "IdleSettings":{ - "shape":"IdleSettings", - "documentation":"

Settings related to idle shutdown of Studio applications.

" - } - }, - "documentation":"

Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio applications.

" - }, - "AppList":{ - "type":"list", - "member":{"shape":"AppDetails"} - }, - "AppManaged":{"type":"boolean"}, - "AppName":{ - "type":"string", - "max":63, - "min":0, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" - }, - "AppNetworkAccessType":{ - "type":"string", - "enum":[ - "PublicInternetOnly", - "VpcOnly" - ] - }, - "AppSecurityGroupManagement":{ - "type":"string", - "enum":[ - "Service", - "Customer" - ] - }, - "AppSortKey":{ - "type":"string", - "enum":["CreationTime"] - }, - "AppSpecification":{ - "type":"structure", - "required":["ImageUri"], - "members":{ - "ImageUri":{ - "shape":"ImageUri", - "documentation":"

The container image to be run by the processing job.

" - }, - "ContainerEntrypoint":{ - "shape":"ContainerEntrypoint", - "documentation":"

The entrypoint for a container used to run a processing job.

" - }, - "ContainerArguments":{ - "shape":"ContainerArguments", - "documentation":"

The arguments for a container used to run a processing job.

" - } - }, - "documentation":"

Configuration to run a processing job in a specified container image.

" - }, - "AppStatus":{ - "type":"string", - "enum":[ - "Deleted", - "Deleting", - "Failed", - "InService", - "Pending" - ] - }, - "AppType":{ - "type":"string", - "enum":[ - "JupyterServer", - "KernelGateway", - "DetailedProfiler", - "TensorBoard", - "CodeEditor", - "JupyterLab", - "RStudioServerPro", - "RSessionGateway", - "Canvas" - ] - }, - "ApprovalDescription":{ - "type":"string", - "max":1024, - "min":0, - "pattern":".*" - }, - "ArnOrName":{ - "type":"string", - "max":170, - "min":1, - "pattern":"(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:[a-z\\-]*\\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(?The URI of the source.

" - }, - "SourceTypes":{ - "shape":"ArtifactSourceTypes", - "documentation":"

A list of source types.

" - } - }, - "documentation":"

A structure describing the source of an artifact.

" - }, - "ArtifactSourceIdType":{ - "type":"string", - "enum":[ - "MD5Hash", - "S3ETag", - "S3Version", - "Custom" - ] - }, - "ArtifactSourceType":{ - "type":"structure", - "required":[ - "SourceIdType", - "Value" - ], - "members":{ - "SourceIdType":{ - "shape":"ArtifactSourceIdType", - "documentation":"

The type of ID.

" - }, - "Value":{ - "shape":"String256", - "documentation":"

The ID.

" - } - }, - "documentation":"

The ID and ID type of an artifact source.

" - }, - "ArtifactSourceTypes":{ - "type":"list", - "member":{"shape":"ArtifactSourceType"} - }, - "ArtifactSummaries":{ - "type":"list", - "member":{"shape":"ArtifactSummary"} - }, - "ArtifactSummary":{ - "type":"structure", - "members":{ - "ArtifactArn":{ - "shape":"ArtifactArn", - "documentation":"

The Amazon Resource Name (ARN) of the artifact.

" - }, - "ArtifactName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the artifact.

" - }, - "Source":{ - "shape":"ArtifactSource", - "documentation":"

The source of the artifact.

" - }, - "ArtifactType":{ - "shape":"String256", - "documentation":"

The type of the artifact.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

When the artifact was created.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

When the artifact was last modified.

" - } - }, - "documentation":"

Lists a summary of the properties of an artifact. An artifact represents a URI addressable object or data. Some examples are a dataset and a model.

" - }, - "AssemblyType":{ - "type":"string", - "enum":[ - "None", - "Line" - ] - }, - "AssignedGroupPatternsList":{ - "type":"list", - "member":{"shape":"GroupNamePattern"}, - "max":10, - "min":0 - }, - "AssociateTrialComponentRequest":{ - "type":"structure", - "required":[ - "TrialComponentName", - "TrialName" - ], - "members":{ - "TrialComponentName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the component to associated with the trial.

" - }, - "TrialName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the trial to associate with.

" - } - } - }, - "AssociateTrialComponentResponse":{ - "type":"structure", - "members":{ - "TrialComponentArn":{ - "shape":"TrialComponentArn", - "documentation":"

The Amazon Resource Name (ARN) of the trial component.

" - }, - "TrialArn":{ - "shape":"TrialArn", - "documentation":"

The Amazon Resource Name (ARN) of the trial.

" - } - } - }, - "AssociationEdgeType":{ - "type":"string", - "enum":[ - "ContributedTo", - "AssociatedWith", - "DerivedFrom", - "Produced", - "SameAs" - ] - }, - "AssociationEntityArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:(experiment|experiment-trial-component|artifact|action|context)/.*" - }, - "AssociationInfo":{ - "type":"structure", - "required":[ - "SourceArn", - "DestinationArn" - ], - "members":{ - "SourceArn":{ - "shape":"String2048", - "documentation":"

The Amazon Resource Name (ARN) of the AssociationInfo source.

" - }, - "DestinationArn":{ - "shape":"String2048", - "documentation":"

The Amazon Resource Name (ARN) of the AssociationInfo destination.

" - } - }, - "documentation":"

The data type used to describe the relationship between different sources.

" - }, - "AssociationInfoList":{ - "type":"list", - "member":{"shape":"AssociationInfo"}, - "max":10, - "min":0 - }, - "AssociationSummaries":{ - "type":"list", - "member":{"shape":"AssociationSummary"} - }, - "AssociationSummary":{ - "type":"structure", - "members":{ - "SourceArn":{ - "shape":"AssociationEntityArn", - "documentation":"

The ARN of the source.

" - }, - "DestinationArn":{ - "shape":"AssociationEntityArn", - "documentation":"

The Amazon Resource Name (ARN) of the destination.

" - }, - "SourceType":{ - "shape":"String256", - "documentation":"

The source type.

" - }, - "DestinationType":{ - "shape":"String256", - "documentation":"

The destination type.

" - }, - "AssociationType":{ - "shape":"AssociationEdgeType", - "documentation":"

The type of the association.

" - }, - "SourceName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the source.

" - }, - "DestinationName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the destination.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

When the association was created.

" - }, - "CreatedBy":{"shape":"UserContext"} - }, - "documentation":"

Lists a summary of the properties of an association. An association is an entity that links other lineage or experiment entities. An example would be an association between a training job and a model.

" - }, - "AssumableRoleArns":{ - "type":"list", - "member":{"shape":"RoleArn"}, - "max":5, - "min":0 - }, - "AsyncInferenceClientConfig":{ - "type":"structure", - "members":{ - "MaxConcurrentInvocationsPerInstance":{ - "shape":"MaxConcurrentInvocationsPerInstance", - "documentation":"

The maximum number of concurrent requests sent by the SageMaker client to the model container. If no value is provided, SageMaker chooses an optimal value.

" - } - }, - "documentation":"

Configures the behavior of the client used by SageMaker to interact with the model container during asynchronous inference.

" - }, - "AsyncInferenceConfig":{ - "type":"structure", - "required":["OutputConfig"], - "members":{ - "ClientConfig":{ - "shape":"AsyncInferenceClientConfig", - "documentation":"

Configures the behavior of the client used by SageMaker to interact with the model container during asynchronous inference.

" - }, - "OutputConfig":{ - "shape":"AsyncInferenceOutputConfig", - "documentation":"

Specifies the configuration for asynchronous inference invocation outputs.

" - } - }, - "documentation":"

Specifies configuration for how an endpoint performs asynchronous inference.

" - }, - "AsyncInferenceNotificationConfig":{ - "type":"structure", - "members":{ - "SuccessTopic":{ - "shape":"SnsTopicArn", - "documentation":"

Amazon SNS topic to post a notification to when inference completes successfully. If no topic is provided, no notification is sent on success.

" - }, - "ErrorTopic":{ - "shape":"SnsTopicArn", - "documentation":"

Amazon SNS topic to post a notification to when inference fails. If no topic is provided, no notification is sent on failure.

" - }, - "IncludeInferenceResponseIn":{ - "shape":"AsyncNotificationTopicTypeList", - "documentation":"

The Amazon SNS topics where you want the inference response to be included.

The inference response is included only if the response size is less than or equal to 128 KB.

" - } - }, - "documentation":"

Specifies the configuration for notifications of inference results for asynchronous inference.

" - }, - "AsyncInferenceOutputConfig":{ - "type":"structure", - "members":{ - "KmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the asynchronous inference output in Amazon S3.

" - }, - "S3OutputPath":{ - "shape":"DestinationS3Uri", - "documentation":"

The Amazon S3 location to upload inference responses to.

" - }, - "NotificationConfig":{ - "shape":"AsyncInferenceNotificationConfig", - "documentation":"

Specifies the configuration for notifications of inference results for asynchronous inference.

" - }, - "S3FailurePath":{ - "shape":"DestinationS3Uri", - "documentation":"

The Amazon S3 location to upload failure inference responses to.

" - } - }, - "documentation":"

Specifies the configuration for asynchronous inference invocation outputs.

" - }, - "AsyncNotificationTopicTypeList":{ - "type":"list", - "member":{"shape":"AsyncNotificationTopicTypes"}, - "max":2, - "min":0 - }, - "AsyncNotificationTopicTypes":{ - "type":"string", - "enum":[ - "SUCCESS_NOTIFICATION_TOPIC", - "ERROR_NOTIFICATION_TOPIC" - ] - }, - "AthenaCatalog":{ - "type":"string", - "documentation":"

The name of the data catalog used in Athena query execution.

", - "max":256, - "min":1, - "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" - }, - "AthenaDatabase":{ - "type":"string", - "documentation":"

The name of the database used in the Athena query execution.

", - "max":255, - "min":1, - "pattern":".*" - }, - "AthenaDatasetDefinition":{ - "type":"structure", - "required":[ - "Catalog", - "Database", - "QueryString", - "OutputS3Uri", - "OutputFormat" - ], - "members":{ - "Catalog":{"shape":"AthenaCatalog"}, - "Database":{"shape":"AthenaDatabase"}, - "QueryString":{"shape":"AthenaQueryString"}, - "WorkGroup":{"shape":"AthenaWorkGroup"}, - "OutputS3Uri":{ - "shape":"S3Uri", - "documentation":"

The location in Amazon S3 where Athena query results are stored.

" - }, - "KmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data generated from an Athena query execution.

" - }, - "OutputFormat":{"shape":"AthenaResultFormat"}, - "OutputCompression":{"shape":"AthenaResultCompressionType"} - }, - "documentation":"

Configuration for Athena Dataset Definition input.

" - }, - "AthenaQueryString":{ - "type":"string", - "documentation":"

The SQL query statements, to be executed.

", - "max":4096, - "min":1, - "pattern":"[\\s\\S]+" - }, - "AthenaResultCompressionType":{ - "type":"string", - "documentation":"

The compression used for Athena query results.

", - "enum":[ - "GZIP", - "SNAPPY", - "ZLIB" - ] - }, - "AthenaResultFormat":{ - "type":"string", - "documentation":"

The data storage format for Athena query results.

", - "enum":[ - "PARQUET", - "ORC", - "AVRO", - "JSON", - "TEXTFILE" - ] - }, - "AthenaWorkGroup":{ - "type":"string", - "documentation":"

The name of the workgroup in which the Athena query is being started.

", - "max":128, - "min":1, - "pattern":"[a-zA-Z0-9._-]+" - }, - "AttachClusterNodeVolumeRequest":{ - "type":"structure", - "required":[ - "ClusterArn", - "NodeId", - "VolumeId" - ], - "members":{ - "ClusterArn":{ - "shape":"ClusterArn", - "documentation":"

The Amazon Resource Name (ARN) of your SageMaker HyperPod cluster containing the target node. Your cluster must use EKS as the orchestration and be in the InService state.

" - }, - "NodeId":{ - "shape":"ClusterNodeId", - "documentation":"

The unique identifier of the cluster node to which you want to attach the volume. The node must belong to your specified HyperPod cluster and cannot be part of a Restricted Instance Group (RIG).

" - }, - "VolumeId":{ - "shape":"VolumeId", - "documentation":"

The unique identifier of your EBS volume to attach. The volume must be in the available state.

" - } - } - }, - "AttachClusterNodeVolumeResponse":{ - "type":"structure", - "required":[ - "ClusterArn", - "NodeId", - "VolumeId", - "AttachTime", - "Status", - "DeviceName" - ], - "members":{ - "ClusterArn":{ - "shape":"ClusterArn", - "documentation":"

The Amazon Resource Name (ARN) of your SageMaker HyperPod cluster where the volume attachment operation was performed.

" - }, - "NodeId":{ - "shape":"ClusterNodeId", - "documentation":"

The unique identifier of the cluster node where your volume was attached.

" - }, - "VolumeId":{ - "shape":"VolumeId", - "documentation":"

The unique identifier of your EBS volume that was attached.

" - }, - "AttachTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the volume attachment operation was initiated by the SageMaker HyperPod service.

" - }, - "Status":{ - "shape":"VolumeAttachmentStatus", - "documentation":"

The current status of your volume attachment operation.

" - }, - "DeviceName":{ - "shape":"VolumeDeviceName", - "documentation":"

The device name assigned to your attached volume on the target instance.

" - } - } - }, - "AttributeName":{ - "type":"string", - "max":256, - "min":1, - "pattern":".+" - }, - "AttributeNames":{ - "type":"list", - "member":{"shape":"AttributeName"}, - "max":16, - "min":0 - }, - "AuthMode":{ - "type":"string", - "enum":[ - "SSO", - "IAM" - ] - }, - "AuthenticationRequestExtraParams":{ - "type":"map", - "key":{"shape":"AuthenticationRequestExtraParamsKey"}, - "value":{"shape":"AuthenticationRequestExtraParamsValue"}, - "max":10, - "min":0 - }, - "AuthenticationRequestExtraParamsKey":{ - "type":"string", - "max":512, - "min":0, - "pattern":".*" - }, - "AuthenticationRequestExtraParamsValue":{ - "type":"string", - "max":512, - "min":0, - "pattern":".*" - }, - "AuthorizedUrl":{ - "type":"structure", - "members":{ - "Url":{ - "shape":"LongS3Uri", - "documentation":"

The presigned S3 URL that provides temporary, secure access to download the file. URLs expire within 15 minutes for security purposes.

" - }, - "LocalPath":{ - "shape":"LocalPath", - "documentation":"

The recommended local file path where the downloaded file should be stored to maintain proper directory structure and file organization.

" - } - }, - "documentation":"

Contains a presigned URL and its associated local file path for downloading hub content artifacts.

" - }, - "AuthorizedUrlConfigs":{ - "type":"list", - "member":{"shape":"AuthorizedUrl"} - }, - "AutoGenerateEndpointName":{"type":"boolean"}, - "AutoMLAlgorithm":{ - "type":"string", - "enum":[ - "xgboost", - "linear-learner", - "mlp", - "lightgbm", - "catboost", - "randomforest", - "extra-trees", - "nn-torch", - "fastai", - "cnn-qr", - "deepar", - "prophet", - "npts", - "arima", - "ets" - ] - }, - "AutoMLAlgorithmConfig":{ - "type":"structure", - "required":["AutoMLAlgorithms"], - "members":{ - "AutoMLAlgorithms":{ - "shape":"AutoMLAlgorithms", - "documentation":"

The selection of algorithms trained on your dataset to generate the model candidates for an Autopilot job.

  • For the tabular problem type TabularJobConfig:

    Selected algorithms must belong to the list corresponding to the training mode set in AutoMLJobConfig.Mode (ENSEMBLING or HYPERPARAMETER_TUNING). Choose a minimum of 1 algorithm.

    • In ENSEMBLING mode:

      • \"catboost\"

      • \"extra-trees\"

      • \"fastai\"

      • \"lightgbm\"

      • \"linear-learner\"

      • \"nn-torch\"

      • \"randomforest\"

      • \"xgboost\"

    • In HYPERPARAMETER_TUNING mode:

      • \"linear-learner\"

      • \"mlp\"

      • \"xgboost\"

  • For the time-series forecasting problem type TimeSeriesForecastingJobConfig:

    • Choose your algorithms from this list.

      • \"cnn-qr\"

      • \"deepar\"

      • \"prophet\"

      • \"arima\"

      • \"npts\"

      • \"ets\"

" - } - }, - "documentation":"

The selection of algorithms trained on your dataset to generate the model candidates for an Autopilot job.

" - }, - "AutoMLAlgorithms":{ - "type":"list", - "member":{"shape":"AutoMLAlgorithm"}, - "max":11, - "min":0 - }, - "AutoMLAlgorithmsConfig":{ - "type":"list", - "member":{"shape":"AutoMLAlgorithmConfig"}, - "max":1, - "min":0 - }, - "AutoMLCandidate":{ - "type":"structure", - "required":[ - "CandidateName", - "ObjectiveStatus", - "CandidateSteps", - "CandidateStatus", - "CreationTime", - "LastModifiedTime" - ], - "members":{ - "CandidateName":{ - "shape":"CandidateName", - "documentation":"

The name of the candidate.

" - }, - "FinalAutoMLJobObjectiveMetric":{"shape":"FinalAutoMLJobObjectiveMetric"}, - "ObjectiveStatus":{ - "shape":"ObjectiveStatus", - "documentation":"

The objective's status.

" - }, - "CandidateSteps":{ - "shape":"CandidateSteps", - "documentation":"

Information about the candidate's steps.

" - }, - "CandidateStatus":{ - "shape":"CandidateStatus", - "documentation":"

The candidate's status.

" - }, - "InferenceContainers":{ - "shape":"AutoMLContainerDefinitions", - "documentation":"

Information about the recommended inference container definitions.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The creation time.

" - }, - "EndTime":{ - "shape":"Timestamp", - "documentation":"

The end time.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The last modified time.

" - }, - "FailureReason":{ - "shape":"AutoMLFailureReason", - "documentation":"

The failure reason.

" - }, - "CandidateProperties":{ - "shape":"CandidateProperties", - "documentation":"

The properties of an AutoML candidate job.

" - }, - "InferenceContainerDefinitions":{ - "shape":"AutoMLInferenceContainerDefinitions", - "documentation":"

The mapping of all supported processing unit (CPU, GPU, etc...) to inference container definitions for the candidate. This field is populated for the AutoML jobs V2 (for example, for jobs created by calling CreateAutoMLJobV2) related to image or text classification problem types only.

" - } - }, - "documentation":"

Information about a candidate produced by an AutoML training job, including its status, steps, and other properties.

" - }, - "AutoMLCandidateGenerationConfig":{ - "type":"structure", - "members":{ - "FeatureSpecificationS3Uri":{ - "shape":"S3Uri", - "documentation":"

A URL to the Amazon S3 data source containing selected features from the input data source to run an Autopilot job. You can input FeatureAttributeNames (optional) in JSON format as shown below:

{ \"FeatureAttributeNames\":[\"col1\", \"col2\", ...] }.

You can also specify the data type of the feature (optional) in the format shown below:

{ \"FeatureDataTypes\":{\"col1\":\"numeric\", \"col2\":\"categorical\" ... } }

These column keys may not include the target column.

In ensembling mode, Autopilot only supports the following data types: numeric, categorical, text, and datetime. In HPO mode, Autopilot can support numeric, categorical, text, datetime, and sequence.

If only FeatureDataTypes is provided, the column keys (col1, col2,..) should be a subset of the column names in the input data.

If both FeatureDataTypes and FeatureAttributeNames are provided, then the column keys should be a subset of the column names provided in FeatureAttributeNames.

The key name FeatureAttributeNames is fixed. The values listed in [\"col1\", \"col2\", ...] are case sensitive and should be a list of strings containing unique values that are a subset of the column names in the input data. The list of columns provided must not include the target column.

" - }, - "AlgorithmsConfig":{ - "shape":"AutoMLAlgorithmsConfig", - "documentation":"

Stores the configuration information for the selection of algorithms trained on tabular data.

The list of available algorithms to choose from depends on the training mode set in TabularJobConfig.Mode .

  • AlgorithmsConfig should not be set if the training mode is set on AUTO.

  • When AlgorithmsConfig is provided, one AutoMLAlgorithms attribute must be set and one only.

    If the list of algorithms provided as values for AutoMLAlgorithms is empty, CandidateGenerationConfig uses the full set of algorithms for the given training mode.

  • When AlgorithmsConfig is not provided, CandidateGenerationConfig uses the full set of algorithms for the given training mode.

For the list of all algorithms per problem type and training mode, see AutoMLAlgorithmConfig.

For more information on each algorithm, see the Algorithm support section in Autopilot developer guide.

" - } - }, - "documentation":"

Stores the configuration information for how a candidate is generated (optional).

" - }, - "AutoMLCandidateStep":{ - "type":"structure", - "required":[ - "CandidateStepType", - "CandidateStepArn", - "CandidateStepName" - ], - "members":{ - "CandidateStepType":{ - "shape":"CandidateStepType", - "documentation":"

Whether the candidate is at the transform, training, or processing step.

" - }, - "CandidateStepArn":{ - "shape":"CandidateStepArn", - "documentation":"

The ARN for the candidate's step.

" - }, - "CandidateStepName":{ - "shape":"CandidateStepName", - "documentation":"

The name for the candidate's step.

" - } - }, - "documentation":"

Information about the steps for a candidate and what step it is working on.

" - }, - "AutoMLCandidates":{ - "type":"list", - "member":{"shape":"AutoMLCandidate"} - }, - "AutoMLChannel":{ - "type":"structure", - "required":["TargetAttributeName"], - "members":{ - "DataSource":{ - "shape":"AutoMLDataSource", - "documentation":"

The data source for an AutoML channel.

" - }, - "CompressionType":{ - "shape":"CompressionType", - "documentation":"

You can use Gzip or None. The default value is None.

" - }, - "TargetAttributeName":{ - "shape":"TargetAttributeName", - "documentation":"

The name of the target variable in supervised learning, usually represented by 'y'.

" - }, - "ContentType":{ - "shape":"ContentType", - "documentation":"

The content type of the data from the input source. You can use text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.

" - }, - "ChannelType":{ - "shape":"AutoMLChannelType", - "documentation":"

The channel type (optional) is an enum string. The default value is training. Channels for training and validation must share the same ContentType and TargetAttributeName. For information on specifying training and validation channel types, see How to specify training and validation datasets.

" - }, - "SampleWeightAttributeName":{ - "shape":"SampleWeightAttributeName", - "documentation":"

If specified, this column name indicates which column of the dataset should be treated as sample weights for use by the objective metric during the training, evaluation, and the selection of the best model. This column is not considered as a predictive feature. For more information on Autopilot metrics, see Metrics and validation.

Sample weights should be numeric, non-negative, with larger values indicating which rows are more important than others. Data points that have invalid or no weight value are excluded.

Support for sample weights is available in Ensembling mode only.

" - } - }, - "documentation":"

A channel is a named input source that training algorithms can consume. The validation dataset size is limited to less than 2 GB. The training dataset size must be less than 100 GB. For more information, see Channel.

A validation dataset must contain the same headers as the training dataset.

" - }, - "AutoMLChannelType":{ - "type":"string", - "enum":[ - "training", - "validation" - ] - }, - "AutoMLComputeConfig":{ - "type":"structure", - "members":{ - "EmrServerlessComputeConfig":{ - "shape":"EmrServerlessComputeConfig", - "documentation":"

The configuration for using EMR Serverless to run the AutoML job V2.

To allow your AutoML job V2 to automatically initiate a remote job on EMR Serverless when additional compute resources are needed to process large datasets, you need to provide an EmrServerlessComputeConfig object, which includes an ExecutionRoleARN attribute, to the AutoMLComputeConfig of the AutoML job V2 input request.

By seamlessly transitioning to EMR Serverless when required, the AutoML job can handle datasets that would otherwise exceed the initially provisioned resources, without any manual intervention from you.

EMR Serverless is available for the tabular and time series problem types. We recommend setting up this option for tabular datasets larger than 5 GB and time series datasets larger than 30 GB.

" - } - }, - "documentation":"

This data type is intended for use exclusively by SageMaker Canvas and cannot be used in other contexts at the moment.

Specifies the compute configuration for an AutoML job V2.

" - }, - "AutoMLContainerDefinition":{ - "type":"structure", - "required":[ - "Image", - "ModelDataUrl" - ], - "members":{ - "Image":{ - "shape":"ContainerImage", - "documentation":"

The Amazon Elastic Container Registry (Amazon ECR) path of the container. For more information, see ContainerDefinition.

" - }, - "ModelDataUrl":{ - "shape":"Url", - "documentation":"

The location of the model artifacts. For more information, see ContainerDefinition.

" - }, - "Environment":{ - "shape":"EnvironmentMap", - "documentation":"

The environment variables to set in the container. For more information, see ContainerDefinition.

" - } - }, - "documentation":"

A list of container definitions that describe the different containers that make up an AutoML candidate. For more information, see ContainerDefinition.

" - }, - "AutoMLContainerDefinitions":{ - "type":"list", - "member":{"shape":"AutoMLContainerDefinition"}, - "max":5, - "min":0 - }, - "AutoMLDataSource":{ - "type":"structure", - "required":["S3DataSource"], - "members":{ - "S3DataSource":{ - "shape":"AutoMLS3DataSource", - "documentation":"

The Amazon S3 location of the input data.

" - } - }, - "documentation":"

The data source for the Autopilot job.

" - }, - "AutoMLDataSplitConfig":{ - "type":"structure", - "members":{ - "ValidationFraction":{ - "shape":"ValidationFraction", - "documentation":"

The validation fraction (optional) is a float that specifies the portion of the training dataset to be used for validation. The default value is 0.2, and values must be greater than 0 and less than 1. We recommend setting this value to be less than 0.5.

" - } - }, - "documentation":"

This structure specifies how to split the data into train and validation datasets.

The validation and training datasets must contain the same headers. For jobs created by calling CreateAutoMLJob, the validation dataset must be less than 2 GB in size.

" - }, - "AutoMLFailureReason":{ - "type":"string", - "max":1024, - "min":0 - }, - "AutoMLInferenceContainerDefinitions":{ - "type":"map", - "key":{ - "shape":"AutoMLProcessingUnit", - "documentation":"

Processing unit for an inference container. Currently Autopilot only supports CPU or GPU.

" - }, - "value":{ - "shape":"AutoMLContainerDefinitions", - "documentation":"

Information about the recommended inference container definitions.

" - }, - "documentation":"

The mapping of all supported processing unit (CPU, GPU, etc...) to inference container definitions for the candidate. This field is populated for the V2 API only (for example, for jobs created by calling CreateAutoMLJobV2).

", - "max":2, - "min":0 - }, - "AutoMLInputDataConfig":{ - "type":"list", - "member":{"shape":"AutoMLChannel"}, - "max":2, - "min":1 - }, - "AutoMLJobArn":{ - "type":"string", - "max":256, - "min":1, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:automl-job/.*" - }, - "AutoMLJobArtifacts":{ - "type":"structure", - "members":{ - "CandidateDefinitionNotebookLocation":{ - "shape":"CandidateDefinitionNotebookLocation", - "documentation":"

The URL of the notebook location.

" - }, - "DataExplorationNotebookLocation":{ - "shape":"DataExplorationNotebookLocation", - "documentation":"

The URL of the notebook location.

" - } - }, - "documentation":"

The artifacts that are generated during an AutoML job.

" - }, - "AutoMLJobChannel":{ - "type":"structure", - "members":{ - "ChannelType":{ - "shape":"AutoMLChannelType", - "documentation":"

The type of channel. Defines whether the data are used for training or validation. The default value is training. Channels for training and validation must share the same ContentType

The type of channel defaults to training for the time-series forecasting problem type.

" - }, - "ContentType":{ - "shape":"ContentType", - "documentation":"

The content type of the data from the input source. The following are the allowed content types for different problems:

  • For tabular problem types: text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.

  • For image classification: image/png, image/jpeg, or image/*. The default value is image/*.

  • For text classification: text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.

  • For time-series forecasting: text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.

  • For text generation (LLMs fine-tuning): text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.

" - }, - "CompressionType":{ - "shape":"CompressionType", - "documentation":"

The allowed compression types depend on the input format and problem type. We allow the compression type Gzip for S3Prefix inputs on tabular data only. For all other inputs, the compression type should be None. If no compression type is provided, we default to None.

" - }, - "DataSource":{ - "shape":"AutoMLDataSource", - "documentation":"

The data source for an AutoML channel (Required).

" - } - }, - "documentation":"

A channel is a named input source that training algorithms can consume. This channel is used for AutoML jobs V2 (jobs created by calling CreateAutoMLJobV2).

" - }, - "AutoMLJobCompletionCriteria":{ - "type":"structure", - "members":{ - "MaxCandidates":{ - "shape":"MaxCandidates", - "documentation":"

The maximum number of times a training job is allowed to run.

For text and image classification, time-series forecasting, as well as text generation (LLMs fine-tuning) problem types, the supported value is 1. For tabular problem types, the maximum value is 750.

" - }, - "MaxRuntimePerTrainingJobInSeconds":{ - "shape":"MaxRuntimePerTrainingJobInSeconds", - "documentation":"

The maximum time, in seconds, that each training job executed inside hyperparameter tuning is allowed to run as part of a hyperparameter tuning job. For more information, see the StoppingCondition used by the CreateHyperParameterTuningJob action.

For job V2s (jobs created by calling CreateAutoMLJobV2), this field controls the runtime of the job candidate.

For TextGenerationJobConfig problem types, the maximum time defaults to 72 hours (259200 seconds).

" - }, - "MaxAutoMLJobRuntimeInSeconds":{ - "shape":"MaxAutoMLJobRuntimeInSeconds", - "documentation":"

The maximum runtime, in seconds, an AutoML job has to complete.

If an AutoML job exceeds the maximum runtime, the job is stopped automatically and its processing is ended gracefully. The AutoML job identifies the best model whose training was completed and marks it as the best-performing model. Any unfinished steps of the job, such as automatic one-click Autopilot model deployment, are not completed.

" - } - }, - "documentation":"

How long a job is allowed to run, or how many candidates a job is allowed to generate.

" - }, - "AutoMLJobConfig":{ - "type":"structure", - "members":{ - "CompletionCriteria":{ - "shape":"AutoMLJobCompletionCriteria", - "documentation":"

How long an AutoML job is allowed to run, or how many candidates a job is allowed to generate.

" - }, - "SecurityConfig":{ - "shape":"AutoMLSecurityConfig", - "documentation":"

The security configuration for traffic encryption or Amazon VPC settings.

" - }, - "CandidateGenerationConfig":{ - "shape":"AutoMLCandidateGenerationConfig", - "documentation":"

The configuration for generating a candidate for an AutoML job (optional).

" - }, - "DataSplitConfig":{ - "shape":"AutoMLDataSplitConfig", - "documentation":"

The configuration for splitting the input training dataset.

Type: AutoMLDataSplitConfig

" - }, - "Mode":{ - "shape":"AutoMLMode", - "documentation":"

The method that Autopilot uses to train the data. You can either specify the mode manually or let Autopilot choose for you based on the dataset size by selecting AUTO. In AUTO mode, Autopilot chooses ENSEMBLING for datasets smaller than 100 MB, and HYPERPARAMETER_TUNING for larger ones.

The ENSEMBLING mode uses a multi-stack ensemble model to predict classification and regression tasks directly from your dataset. This machine learning mode combines several base models to produce an optimal predictive model. It then uses a stacking ensemble method to combine predictions from contributing members. A multi-stack ensemble model can provide better performance over a single model by combining the predictive capabilities of multiple models. See Autopilot algorithm support for a list of algorithms supported by ENSEMBLING mode.

The HYPERPARAMETER_TUNING (HPO) mode uses the best hyperparameters to train the best version of a model. HPO automatically selects an algorithm for the type of problem you want to solve. Then HPO finds the best hyperparameters according to your objective metric. See Autopilot algorithm support for a list of algorithms supported by HYPERPARAMETER_TUNING mode.

" - } - }, - "documentation":"

A collection of settings used for an AutoML job.

" - }, - "AutoMLJobInputDataConfig":{ - "type":"list", - "member":{"shape":"AutoMLJobChannel"}, - "max":2, - "min":1 - }, - "AutoMLJobName":{ - "type":"string", - "max":32, - "min":1, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}" - }, - "AutoMLJobObjective":{ - "type":"structure", - "required":["MetricName"], - "members":{ - "MetricName":{ - "shape":"AutoMLMetricEnum", - "documentation":"

The name of the objective metric used to measure the predictive quality of a machine learning system. During training, the model's parameters are updated iteratively to optimize its performance based on the feedback provided by the objective metric when evaluating the model on the validation dataset.

The list of available metrics supported by Autopilot and the default metric applied when you do not specify a metric name explicitly depend on the problem type.

  • For tabular problem types:

    • List of available metrics:

      • Regression: MAE, MSE, R2, RMSE

      • Binary classification: Accuracy, AUC, BalancedAccuracy, F1, Precision, Recall

      • Multiclass classification: Accuracy, BalancedAccuracy, F1macro, PrecisionMacro, RecallMacro

      For a description of each metric, see Autopilot metrics for classification and regression.

    • Default objective metrics:

      • Regression: MSE.

      • Binary classification: F1.

      • Multiclass classification: Accuracy.

  • For image or text classification problem types:

  • For time-series forecasting problem types:

  • For text generation problem types (LLMs fine-tuning): Fine-tuning language models in Autopilot does not require setting the AutoMLJobObjective field. Autopilot fine-tunes LLMs without requiring multiple candidates to be trained and evaluated. Instead, using your dataset, Autopilot directly fine-tunes your target model to enhance a default objective metric, the cross-entropy loss. After fine-tuning a language model, you can evaluate the quality of its generated text using different metrics. For a list of the available metrics, see Metrics for fine-tuning LLMs in Autopilot.

" - } - }, - "documentation":"

Specifies a metric to minimize or maximize as the objective of an AutoML job.

" - }, - "AutoMLJobObjectiveType":{ - "type":"string", - "enum":[ - "Maximize", - "Minimize" - ] - }, - "AutoMLJobSecondaryStatus":{ - "type":"string", - "enum":[ - "Starting", - "MaxCandidatesReached", - "Failed", - "Stopped", - "MaxAutoMLJobRuntimeReached", - "Stopping", - "CandidateDefinitionsGenerated", - "Completed", - "ExplainabilityError", - "DeployingModel", - "ModelDeploymentError", - "GeneratingModelInsightsReport", - "ModelInsightsError", - "AnalyzingData", - "FeatureEngineering", - "ModelTuning", - "GeneratingExplainabilityReport", - "TrainingModels", - "PreTraining" - ] - }, - "AutoMLJobStatus":{ - "type":"string", - "enum":[ - "Completed", - "InProgress", - "Failed", - "Stopped", - "Stopping" - ] - }, - "AutoMLJobStepMetadata":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"AutoMLJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the AutoML job.

" - } - }, - "documentation":"

Metadata for an AutoML job step.

" - }, - "AutoMLJobSummaries":{ - "type":"list", - "member":{"shape":"AutoMLJobSummary"} - }, - "AutoMLJobSummary":{ - "type":"structure", - "required":[ - "AutoMLJobName", - "AutoMLJobArn", - "AutoMLJobStatus", - "AutoMLJobSecondaryStatus", - "CreationTime", - "LastModifiedTime" - ], - "members":{ - "AutoMLJobName":{ - "shape":"AutoMLJobName", - "documentation":"

The name of the AutoML job you are requesting.

" - }, - "AutoMLJobArn":{ - "shape":"AutoMLJobArn", - "documentation":"

The ARN of the AutoML job.

" - }, - "AutoMLJobStatus":{ - "shape":"AutoMLJobStatus", - "documentation":"

The status of the AutoML job.

" - }, - "AutoMLJobSecondaryStatus":{ - "shape":"AutoMLJobSecondaryStatus", - "documentation":"

The secondary status of the AutoML job.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

When the AutoML job was created.

" - }, - "EndTime":{ - "shape":"Timestamp", - "documentation":"

The end time of an AutoML job.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

When the AutoML job was last modified.

" - }, - "FailureReason":{ - "shape":"AutoMLFailureReason", - "documentation":"

The failure reason of an AutoML job.

" - }, - "PartialFailureReasons":{ - "shape":"AutoMLPartialFailureReasons", - "documentation":"

The list of reasons for partial failures within an AutoML job.

" - } - }, - "documentation":"

Provides a summary about an AutoML job.

" - }, - "AutoMLMaxResults":{ - "type":"integer", - "max":100, - "min":1 - }, - "AutoMLMaxResultsForTrials":{ - "type":"integer", - "max":300, - "min":1 - }, - "AutoMLMetricEnum":{ - "type":"string", - "enum":[ - "Accuracy", - "MSE", - "F1", - "F1macro", - "AUC", - "RMSE", - "BalancedAccuracy", - "R2", - "Recall", - "RecallMacro", - "Precision", - "PrecisionMacro", - "MAE", - "MAPE", - "MASE", - "WAPE", - "AverageWeightedQuantileLoss" - ] - }, - "AutoMLMetricExtendedEnum":{ - "type":"string", - "enum":[ - "Accuracy", - "MSE", - "F1", - "F1macro", - "AUC", - "RMSE", - "MAE", - "R2", - "BalancedAccuracy", - "Precision", - "PrecisionMacro", - "Recall", - "RecallMacro", - "LogLoss", - "InferenceLatency", - "MAPE", - "MASE", - "WAPE", - "AverageWeightedQuantileLoss", - "Rouge1", - "Rouge2", - "RougeL", - "RougeLSum", - "Perplexity", - "ValidationLoss", - "TrainingLoss" - ] - }, - "AutoMLMode":{ - "type":"string", - "enum":[ - "AUTO", - "ENSEMBLING", - "HYPERPARAMETER_TUNING" - ] - }, - "AutoMLNameContains":{ - "type":"string", - "max":63, - "min":0, - "pattern":"[a-zA-Z0-9\\-]+" - }, - "AutoMLOutputDataConfig":{ - "type":"structure", - "required":["S3OutputPath"], - "members":{ - "KmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The Key Management Service encryption key ID.

" - }, - "S3OutputPath":{ - "shape":"S3Uri", - "documentation":"

The Amazon S3 output path. Must be 512 characters or less.

" - } - }, - "documentation":"

The output data configuration.

" - }, - "AutoMLPartialFailureReason":{ - "type":"structure", - "members":{ - "PartialFailureMessage":{ - "shape":"AutoMLFailureReason", - "documentation":"

The message containing the reason for a partial failure of an AutoML job.

" - } - }, - "documentation":"

The reason for a partial failure of an AutoML job.

" - }, - "AutoMLPartialFailureReasons":{ - "type":"list", - "member":{"shape":"AutoMLPartialFailureReason"}, - "max":5, - "min":1 - }, - "AutoMLProblemTypeConfig":{ - "type":"structure", - "members":{ - "ImageClassificationJobConfig":{ - "shape":"ImageClassificationJobConfig", - "documentation":"

Settings used to configure an AutoML job V2 for the image classification problem type.

" - }, - "TextClassificationJobConfig":{ - "shape":"TextClassificationJobConfig", - "documentation":"

Settings used to configure an AutoML job V2 for the text classification problem type.

" - }, - "TimeSeriesForecastingJobConfig":{ - "shape":"TimeSeriesForecastingJobConfig", - "documentation":"

Settings used to configure an AutoML job V2 for the time-series forecasting problem type.

" - }, - "TabularJobConfig":{ - "shape":"TabularJobConfig", - "documentation":"

Settings used to configure an AutoML job V2 for the tabular problem type (regression, classification).

" - }, - "TextGenerationJobConfig":{ - "shape":"TextGenerationJobConfig", - "documentation":"

Settings used to configure an AutoML job V2 for the text generation (LLMs fine-tuning) problem type.

The text generation models that support fine-tuning in Autopilot are currently accessible exclusively in regions supported by Canvas. Refer to the documentation of Canvas for the full list of its supported Regions.

" - } - }, - "documentation":"

A collection of settings specific to the problem type used to configure an AutoML job V2. There must be one and only one config of the following type.

", - "union":true - }, - "AutoMLProblemTypeConfigName":{ - "type":"string", - "enum":[ - "ImageClassification", - "TextClassification", - "TimeSeriesForecasting", - "Tabular", - "TextGeneration" - ] - }, - "AutoMLProblemTypeResolvedAttributes":{ - "type":"structure", - "members":{ - "TabularResolvedAttributes":{ - "shape":"TabularResolvedAttributes", - "documentation":"

The resolved attributes for the tabular problem type.

" - }, - "TextGenerationResolvedAttributes":{ - "shape":"TextGenerationResolvedAttributes", - "documentation":"

The resolved attributes for the text generation problem type.

" - } - }, - "documentation":"

Stores resolved attributes specific to the problem type of an AutoML job V2.

", - "union":true - }, - "AutoMLProcessingUnit":{ - "type":"string", - "enum":[ - "CPU", - "GPU" - ] - }, - "AutoMLResolvedAttributes":{ - "type":"structure", - "members":{ - "AutoMLJobObjective":{"shape":"AutoMLJobObjective"}, - "CompletionCriteria":{"shape":"AutoMLJobCompletionCriteria"}, - "AutoMLProblemTypeResolvedAttributes":{ - "shape":"AutoMLProblemTypeResolvedAttributes", - "documentation":"

Defines the resolved attributes specific to a problem type.

" - } - }, - "documentation":"

The resolved attributes used to configure an AutoML job V2.

" - }, - "AutoMLS3DataSource":{ - "type":"structure", - "required":[ - "S3DataType", - "S3Uri" - ], - "members":{ - "S3DataType":{ - "shape":"AutoMLS3DataType", - "documentation":"

The data type.

  • If you choose S3Prefix, S3Uri identifies a key name prefix. SageMaker AI uses all objects that match the specified key name prefix for model training.

    The S3Prefix should have the following format:

    s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER-OR-FILE

  • If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want SageMaker AI to use for model training.

    A ManifestFile should have the format shown below:

    [ {\"prefix\": \"s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/DOC-EXAMPLE-PREFIX/\"},

    \"DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-1\",

    \"DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-2\",

    ... \"DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-N\" ]

  • If you choose AugmentedManifestFile, S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. AugmentedManifestFile is available for V2 API jobs only (for example, for jobs created by calling CreateAutoMLJobV2).

    Here is a minimal, single-record example of an AugmentedManifestFile:

    {\"source-ref\": \"s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/cats/cat.jpg\",

    \"label-metadata\": {\"class-name\": \"cat\" }

    For more information on AugmentedManifestFile, see Provide Dataset Metadata to Training Jobs with an Augmented Manifest File.

" - }, - "S3Uri":{ - "shape":"S3Uri", - "documentation":"

The URL to the Amazon S3 data source. The Uri refers to the Amazon S3 prefix or ManifestFile depending on the data type.

" - } - }, - "documentation":"

Describes the Amazon S3 data source.

" - }, - "AutoMLS3DataType":{ - "type":"string", - "enum":[ - "ManifestFile", - "S3Prefix", - "AugmentedManifestFile" - ] - }, - "AutoMLSecurityConfig":{ - "type":"structure", - "members":{ - "VolumeKmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The key used to encrypt stored data.

" - }, - "EnableInterContainerTrafficEncryption":{ - "shape":"Boolean", - "documentation":"

Whether to use traffic encryption between the container layers.

", - "box":true - }, - "VpcConfig":{ - "shape":"VpcConfig", - "documentation":"

The VPC configuration.

" - } - }, - "documentation":"

Security options.

" - }, - "AutoMLSortBy":{ - "type":"string", - "enum":[ - "Name", - "CreationTime", - "Status" - ] - }, - "AutoMLSortOrder":{ - "type":"string", - "enum":[ - "Ascending", - "Descending" - ] - }, - "AutoMountHomeEFS":{ - "type":"string", - "enum":[ - "Enabled", - "Disabled", - "DefaultAsDomain" - ] - }, - "AutoParameter":{ - "type":"structure", - "required":[ - "Name", - "ValueHint" - ], - "members":{ - "Name":{ - "shape":"ParameterKey", - "documentation":"

The name of the hyperparameter to optimize using Autotune.

" - }, - "ValueHint":{ - "shape":"ParameterValue", - "documentation":"

An example value of the hyperparameter to optimize using Autotune.

" - } - }, - "documentation":"

The name and an example value of the hyperparameter that you want to use in Autotune. If Automatic model tuning (AMT) determines that your hyperparameter is eligible for Autotune, an optimal hyperparameter range is selected for you.

" - }, - "AutoParameters":{ - "type":"list", - "member":{"shape":"AutoParameter"}, - "max":100, - "min":0 - }, - "AutoRollbackAlarms":{ - "type":"list", - "member":{"shape":"AlarmDetails"}, - "max":10, - "min":1 - }, - "AutoRollbackConfig":{ - "type":"structure", - "members":{ - "Alarms":{ - "shape":"AlarmList", - "documentation":"

List of CloudWatch alarms in your account that are configured to monitor metrics on an endpoint. If any alarms are tripped during a deployment, SageMaker rolls back the deployment.

" - } - }, - "documentation":"

Automatic rollback configuration for handling endpoint deployment failures and recovery.

" - }, - "Autotune":{ - "type":"structure", - "required":["Mode"], - "members":{ - "Mode":{ - "shape":"AutotuneMode", - "documentation":"

Set Mode to Enabled if you want to use Autotune.

" - } - }, - "documentation":"

A flag to indicate if you want to use Autotune to automatically find optimal values for the following fields:

  • ParameterRanges: The names and ranges of parameters that a hyperparameter tuning job can optimize.

  • ResourceLimits: The maximum resources that can be used for a training job. These resources include the maximum number of training jobs, the maximum runtime of a tuning job, and the maximum number of training jobs to run at the same time.

  • TrainingJobEarlyStoppingType: A flag that specifies whether or not to use early stopping for training jobs launched by a hyperparameter tuning job.

  • RetryStrategy: The number of times to retry a training job.

  • Strategy: Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training jobs that it launches.

  • ConvergenceDetected: A flag to indicate that Automatic model tuning (AMT) has detected model convergence.

" - }, - "AutotuneMode":{ - "type":"string", - "enum":["Enabled"] - }, - "AvailabilityZone":{ - "type":"string", - "max":32, - "min":1, - "pattern":"[a-z]+\\-[0-9a-z\\-]+" - }, - "AvailabilityZoneBalanceEnforcementMode":{ - "type":"string", - "enum":["PERMISSIVE"] - }, - "AvailabilityZoneBalanceMaxImbalance":{ - "type":"integer", - "box":true, - "max":100, - "min":0 - }, - "AvailabilityZoneId":{ - "type":"string", - "pattern":"[a-z]{3}\\d-az\\d" - }, - "AvailableInstanceCount":{ - "type":"integer", - "box":true, - "min":0 - }, - "AvailableSpareInstanceCount":{ - "type":"integer", - "box":true, - "min":0 - }, - "AvailableUpgrade":{ - "type":"structure", - "members":{ - "Version":{ - "shape":"MajorMinorVersion", - "documentation":"

The semantic version number of the available upgrade for the SageMaker Partner AI App.

" - }, - "ReleaseNotes":{ - "shape":"ReleaseNotesList", - "documentation":"

A list of release notes describing the changes and improvements included in the available upgrade version.

" - } - }, - "documentation":"

Contains information about an available upgrade for a SageMaker Partner AI App, including the version number and release notes.

" - }, - "AwsManagedHumanLoopRequestSource":{ - "type":"string", - "enum":[ - "AWS/Rekognition/DetectModerationLabels/Image/V3", - "AWS/Textract/AnalyzeDocument/Forms/V1" - ] - }, - "BacktestResultsLocation":{ - "type":"string", - "min":1 - }, - "BaseModel":{ - "type":"structure", - "members":{ - "HubContentName":{ - "shape":"HubContentName", - "documentation":"

The hub content name of the base model.

" - }, - "HubContentVersion":{ - "shape":"HubContentVersion", - "documentation":"

The hub content version of the base model.

" - }, - "RecipeName":{ - "shape":"RecipeName", - "documentation":"

The recipe name of the base model.

" - } - }, - "documentation":"

Identifies the foundation model that was used as the starting point for model customization.

" - }, - "BaseModelName":{ - "type":"string", - "max":256, - "min":1, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9])*" - }, - "BatchAddClusterNodesError":{ - "type":"structure", - "required":[ - "InstanceGroupName", - "ErrorCode", - "FailedCount" - ], - "members":{ - "InstanceGroupName":{ - "shape":"InstanceGroupName", - "documentation":"

The name of the instance group for which the error occurred.

" - }, - "ErrorCode":{ - "shape":"BatchAddClusterNodesErrorCode", - "documentation":"

The error code associated with the failure. Possible values include InstanceGroupNotFound and InvalidInstanceGroupState.

" - }, - "FailedCount":{ - "shape":"BatchAddFailureCount", - "documentation":"

The number of nodes that failed to be added to the specified instance group.

" - }, - "AvailabilityZones":{ - "shape":"ClusterAvailabilityZones", - "documentation":"

The availability zones associated with the failed node addition request.

" - }, - "InstanceTypes":{ - "shape":"ClusterInstanceTypes", - "documentation":"

The instance types associated with the failed node addition request.

" - }, - "Message":{ - "shape":"String", - "documentation":"

A descriptive message providing additional details about the error.

" - } - }, - "documentation":"

Information about an error that occurred during the node addition operation.

" - }, - "BatchAddClusterNodesErrorCode":{ - "type":"string", - "enum":[ - "InstanceGroupNotFound", - "InvalidInstanceGroupStatus", - "IncompatibleAvailabilityZones", - "IncompatibleInstanceTypes" - ] - }, - "BatchAddClusterNodesErrorList":{ - "type":"list", - "member":{"shape":"BatchAddClusterNodesError"} - }, - "BatchAddClusterNodesRequest":{ - "type":"structure", - "required":[ - "ClusterName", - "NodesToAdd" - ], - "members":{ - "ClusterName":{ - "shape":"ClusterNameOrArn", - "documentation":"

The name of the HyperPod cluster to which you want to add nodes.

" - }, - "ClientToken":{ - "shape":"BatchAddClusterNodesRequestClientTokenString", - "documentation":"

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token is valid for 8 hours. If you retry the request with the same client token within this timeframe and the same parameters, the API returns the same set of NodeLogicalIds with their latest status.

", - "idempotencyToken":true - }, - "NodesToAdd":{ - "shape":"AddClusterNodeSpecificationList", - "documentation":"

A list of instance groups and the number of nodes to add to each. You can specify up to 5 instance groups in a single request, with a maximum of 50 nodes total across all instance groups.

" - } - } - }, - "BatchAddClusterNodesRequestClientTokenString":{ - "type":"string", - "max":64, - "min":0, - "pattern":"[\\x21-\\x7E]+" - }, - "BatchAddClusterNodesResponse":{ - "type":"structure", - "required":[ - "Successful", - "Failed" - ], - "members":{ - "Successful":{ - "shape":"NodeAdditionResultList", - "documentation":"

A list of NodeLogicalIDs that were successfully added to the cluster. The NodeLogicalID is unique per cluster and does not change between instance replacements. Each entry includes a NodeLogicalId that can be used to track the node's provisioning status (with DescribeClusterNode), the instance group name, and the current status of the node.

" - }, - "Failed":{ - "shape":"BatchAddClusterNodesErrorList", - "documentation":"

A list of errors that occurred during the node addition operation. Each entry includes the instance group name, error code, number of failed additions, and an error message.

" - } - } - }, - "BatchAddFailureCount":{ - "type":"integer", - "box":true, - "min":1 - }, - "BatchDataCaptureConfig":{ - "type":"structure", - "required":["DestinationS3Uri"], - "members":{ - "DestinationS3Uri":{ - "shape":"S3Uri", - "documentation":"

The Amazon S3 location being used to capture the data.

" - }, - "KmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the batch transform job.

The KmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

" - }, - "GenerateInferenceId":{ - "shape":"Boolean", - "documentation":"

Flag that indicates whether to append inference id to the output.

", - "box":true - } - }, - "documentation":"

Configuration to control how SageMaker captures inference data for batch transform jobs.

" - }, - "BatchDeleteClusterNodeLogicalIdsError":{ - "type":"structure", - "required":[ - "Code", - "Message", - "NodeLogicalId" - ], - "members":{ - "Code":{ - "shape":"BatchDeleteClusterNodesErrorCode", - "documentation":"

The error code associated with the failure. Possible values include NodeLogicalIdNotFound, InvalidNodeStatus, and InternalError.

" - }, - "Message":{ - "shape":"String", - "documentation":"

A descriptive message providing additional details about the error.

" - }, - "NodeLogicalId":{ - "shape":"ClusterNodeLogicalId", - "documentation":"

The NodeLogicalId of the node that could not be deleted.

" - } - }, - "documentation":"

Information about an error that occurred when attempting to delete a node identified by its NodeLogicalId.

" - }, - "BatchDeleteClusterNodeLogicalIdsErrorList":{ - "type":"list", - "member":{"shape":"BatchDeleteClusterNodeLogicalIdsError"}, - "max":99, - "min":1 - }, - "BatchDeleteClusterNodesError":{ - "type":"structure", - "required":[ - "Code", - "Message", - "NodeId" - ], - "members":{ - "Code":{ - "shape":"BatchDeleteClusterNodesErrorCode", - "documentation":"

The error code associated with the error encountered when deleting a node.

The code provides information about the specific issue encountered, such as the node not being found, the node's status being invalid for deletion, or the node ID being in use by another process.

" - }, - "Message":{ - "shape":"String", - "documentation":"

A message describing the error encountered when deleting a node.

" - }, - "NodeId":{ - "shape":"ClusterNodeId", - "documentation":"

The ID of the node that encountered an error during the deletion process.

" - } - }, - "documentation":"

Represents an error encountered when deleting a node from a SageMaker HyperPod cluster.

" - }, - "BatchDeleteClusterNodesErrorCode":{ - "type":"string", - "enum":[ - "NodeIdNotFound", - "InvalidNodeStatus", - "NodeIdInUse" - ] - }, - "BatchDeleteClusterNodesErrorList":{ - "type":"list", - "member":{"shape":"BatchDeleteClusterNodesError"}, - "max":3000, - "min":1 - }, - "BatchDeleteClusterNodesRequest":{ - "type":"structure", - "required":["ClusterName"], - "members":{ - "ClusterName":{ - "shape":"ClusterNameOrArn", - "documentation":"

The name of the SageMaker HyperPod cluster from which to delete the specified nodes.

" - }, - "NodeIds":{ - "shape":"ClusterNodeIds", - "documentation":"

A list of node IDs to be deleted from the specified cluster.

  • For SageMaker HyperPod clusters using the Slurm workload manager, you cannot remove instances that are configured as Slurm controller nodes.

  • If you need to delete more than 99 instances, contact Support for assistance.

" - }, - "NodeLogicalIds":{ - "shape":"ClusterNodeLogicalIdList", - "documentation":"

A list of NodeLogicalIds identifying the nodes to be deleted. You can specify up to 50 NodeLogicalIds. You must specify either NodeLogicalIds, InstanceIds, or both, with a combined maximum of 50 identifiers.

" - } - } - }, - "BatchDeleteClusterNodesResponse":{ - "type":"structure", - "members":{ - "Failed":{ - "shape":"BatchDeleteClusterNodesErrorList", - "documentation":"

A list of errors encountered when deleting the specified nodes.

" - }, - "Successful":{ - "shape":"ClusterNodeIds", - "documentation":"

A list of node IDs that were successfully deleted from the specified cluster.

" - }, - "FailedNodeLogicalIds":{ - "shape":"BatchDeleteClusterNodeLogicalIdsErrorList", - "documentation":"

A list of NodeLogicalIds that could not be deleted, along with error information explaining why the deletion failed.

" - }, - "SuccessfulNodeLogicalIds":{ - "shape":"ClusterNodeLogicalIdList", - "documentation":"

A list of NodeLogicalIds that were successfully deleted from the cluster.

" - } - } - }, - "BatchDescribeModelPackageError":{ - "type":"structure", - "required":[ - "ErrorCode", - "ErrorResponse" - ], - "members":{ - "ErrorCode":{ - "shape":"String", - "documentation":"

" - }, - "ErrorResponse":{ - "shape":"String", - "documentation":"

" - } - }, - "documentation":"

The error code and error description associated with the resource.

" - }, - "BatchDescribeModelPackageErrorMap":{ - "type":"map", - "key":{"shape":"ModelPackageArn"}, - "value":{"shape":"BatchDescribeModelPackageError"} - }, - "BatchDescribeModelPackageInput":{ - "type":"structure", - "required":["ModelPackageArnList"], - "members":{ - "ModelPackageArnList":{ - "shape":"ModelPackageArnList", - "documentation":"

The list of Amazon Resource Name (ARN) of the model package groups.

" - } - } - }, - "BatchDescribeModelPackageOutput":{ - "type":"structure", - "members":{ - "ModelPackageSummaries":{ - "shape":"ModelPackageSummaries", - "documentation":"

The summaries for the model package versions

" - }, - "BatchDescribeModelPackageErrorMap":{ - "shape":"BatchDescribeModelPackageErrorMap", - "documentation":"

A map of the resource and BatchDescribeModelPackageError objects reporting the error associated with describing the model package.

" - } - } - }, - "BatchDescribeModelPackageSummary":{ - "type":"structure", - "required":[ - "ModelPackageGroupName", - "ModelPackageArn", - "CreationTime", - "InferenceSpecification", - "ModelPackageStatus" - ], - "members":{ - "ModelPackageGroupName":{ - "shape":"EntityName", - "documentation":"

The group name for the model package

" - }, - "ModelPackageVersion":{ - "shape":"ModelPackageVersion", - "documentation":"

The version number of a versioned model.

" - }, - "ModelPackageArn":{ - "shape":"ModelPackageArn", - "documentation":"

The Amazon Resource Name (ARN) of the model package.

" - }, - "ModelPackageDescription":{ - "shape":"EntityDescription", - "documentation":"

The description of the model package.

" - }, - "CreationTime":{ - "shape":"CreationTime", - "documentation":"

The creation time of the mortgage package summary.

" - }, - "InferenceSpecification":{"shape":"InferenceSpecification"}, - "ModelPackageStatus":{ - "shape":"ModelPackageStatus", - "documentation":"

The status of the mortgage package.

" - }, - "ModelApprovalStatus":{ - "shape":"ModelApprovalStatus", - "documentation":"

The approval status of the model.

" - }, - "ModelPackageRegistrationType":{ - "shape":"ModelPackageRegistrationType", - "documentation":"

The package registration type of the model package summary.

" - } - }, - "documentation":"

Provides summary information about the model package.

" - }, - "BatchRebootClusterNodeLogicalIdsError":{ - "type":"structure", - "required":[ - "NodeLogicalId", - "ErrorCode", - "Message" - ], - "members":{ - "NodeLogicalId":{ - "shape":"ClusterNodeLogicalId", - "documentation":"

The logical node ID of the node that encountered an error during the reboot operation.

" - }, - "ErrorCode":{ - "shape":"BatchRebootClusterNodesErrorCode", - "documentation":"

The error code associated with the error encountered when rebooting a node by logical node ID.

Possible values:

  • InstanceIdNotFound: The node does not exist in the specified cluster.

  • InvalidInstanceStatus: The node is in a state that does not allow rebooting. Wait for the node to finish any ongoing changes before retrying.

  • InstanceIdInUse: Another operation is already in progress for this node. Wait for the operation to complete before retrying.

  • InternalServerError: An internal error occurred while processing this node.

" - }, - "Message":{ - "shape":"String", - "documentation":"

A human-readable message describing the error encountered when rebooting a node by logical node ID.

" - } - }, - "documentation":"

Represents an error encountered when rebooting a node (identified by its logical node ID) from a SageMaker HyperPod cluster.

" - }, - "BatchRebootClusterNodeLogicalIdsErrors":{ - "type":"list", - "member":{"shape":"BatchRebootClusterNodeLogicalIdsError"}, - "max":25, - "min":0 - }, - "BatchRebootClusterNodesError":{ - "type":"structure", - "required":[ - "NodeId", - "ErrorCode", - "Message" - ], - "members":{ - "NodeId":{ - "shape":"ClusterNodeId", - "documentation":"

The EC2 instance ID of the node that encountered an error during the reboot operation.

" - }, - "ErrorCode":{ - "shape":"BatchRebootClusterNodesErrorCode", - "documentation":"

The error code associated with the error encountered when rebooting a node.

Possible values:

  • InstanceIdNotFound: The instance does not exist in the specified cluster.

  • InvalidInstanceStatus: The instance is in a state that does not allow rebooting. Wait for the instance to finish any ongoing changes before retrying.

  • InstanceIdInUse: Another operation is already in progress for this node. Wait for the operation to complete before retrying.

  • InternalServerError: An internal error occurred while processing this node.

" - }, - "Message":{ - "shape":"String", - "documentation":"

A human-readable message describing the error encountered when rebooting a node.

" - } - }, - "documentation":"

Represents an error encountered when rebooting a node from a SageMaker HyperPod cluster.

" - }, - "BatchRebootClusterNodesErrorCode":{ - "type":"string", - "enum":[ - "InstanceIdNotFound", - "InvalidInstanceStatus", - "InstanceIdInUse", - "InternalServerError" - ] - }, - "BatchRebootClusterNodesErrors":{ - "type":"list", - "member":{"shape":"BatchRebootClusterNodesError"}, - "max":25, - "min":0 - }, - "BatchRebootClusterNodesRequest":{ - "type":"structure", - "required":["ClusterName"], - "members":{ - "ClusterName":{ - "shape":"ClusterNameOrArn", - "documentation":"

The name or Amazon Resource Name (ARN) of the SageMaker HyperPod cluster containing the nodes to reboot.

" - }, - "NodeIds":{ - "shape":"BatchRebootClusterNodesRequestNodeIdsList", - "documentation":"

A list of EC2 instance IDs to reboot using soft recovery. You can specify between 1 and 25 instance IDs.

  • Either NodeIds or NodeLogicalIds must be provided (or both), but at least one is required.

  • Each instance ID must follow the pattern i- followed by 17 hexadecimal characters (for example, i-0123456789abcdef0).

" - }, - "NodeLogicalIds":{ - "shape":"BatchRebootClusterNodesRequestNodeLogicalIdsList", - "documentation":"

A list of logical node IDs to reboot using soft recovery. You can specify between 1 and 25 logical node IDs.

The NodeLogicalId is a unique identifier that persists throughout the node's lifecycle and can be used to track nodes that are still being provisioned and don't yet have an EC2 instance ID assigned.

  • This parameter is only supported for clusters using Continuous as the NodeProvisioningMode. For clusters using the default provisioning mode, use NodeIds instead.

  • Either NodeIds or NodeLogicalIds must be provided (or both), but at least one is required.

" - } - } - }, - "BatchRebootClusterNodesRequestNodeIdsList":{ - "type":"list", - "member":{"shape":"ClusterNodeId"}, - "max":25, - "min":1 - }, - "BatchRebootClusterNodesRequestNodeLogicalIdsList":{ - "type":"list", - "member":{"shape":"ClusterNodeLogicalId"}, - "max":25, - "min":1 - }, - "BatchRebootClusterNodesResponse":{ - "type":"structure", - "members":{ - "Successful":{ - "shape":"ClusterNodeIds", - "documentation":"

A list of EC2 instance IDs for which the reboot operation was successfully initiated.

" - }, - "Failed":{ - "shape":"BatchRebootClusterNodesErrors", - "documentation":"

A list of errors encountered for EC2 instance IDs that could not be rebooted. Each error includes the instance ID, an error code, and a descriptive message.

" - }, - "FailedNodeLogicalIds":{ - "shape":"BatchRebootClusterNodeLogicalIdsErrors", - "documentation":"

A list of errors encountered for logical node IDs that could not be rebooted. Each error includes the logical node ID, an error code, and a descriptive message. This field is only present when NodeLogicalIds were provided in the request.

" - }, - "SuccessfulNodeLogicalIds":{ - "shape":"ClusterNodeLogicalIdList", - "documentation":"

A list of logical node IDs for which the reboot operation was successfully initiated. This field is only present when NodeLogicalIds were provided in the request.

" - } - } - }, - "BatchReplaceClusterNodeLogicalIdsError":{ - "type":"structure", - "required":[ - "NodeLogicalId", - "ErrorCode", - "Message" - ], - "members":{ - "NodeLogicalId":{ - "shape":"ClusterNodeLogicalId", - "documentation":"

The logical node ID of the node that encountered an error during the replacement operation.

" - }, - "ErrorCode":{ - "shape":"BatchReplaceClusterNodesErrorCode", - "documentation":"

The error code associated with the error encountered when replacing a node by logical node ID.

Possible values:

  • InstanceIdNotFound: The node does not exist in the specified cluster.

  • InvalidInstanceStatus: The node is in a state that does not allow replacement. Wait for the node to finish any ongoing changes before retrying.

  • InstanceIdInUse: Another operation is already in progress for this node. Wait for the operation to complete before retrying.

  • InternalServerError: An internal error occurred while processing this node.

" - }, - "Message":{ - "shape":"String", - "documentation":"

A human-readable message describing the error encountered when replacing a node by logical node ID.

" - } - }, - "documentation":"

Represents an error encountered when replacing a node (identified by its logical node ID) in a SageMaker HyperPod cluster.

" - }, - "BatchReplaceClusterNodeLogicalIdsErrors":{ - "type":"list", - "member":{"shape":"BatchReplaceClusterNodeLogicalIdsError"}, - "max":25, - "min":0 - }, - "BatchReplaceClusterNodesError":{ - "type":"structure", - "required":[ - "NodeId", - "ErrorCode", - "Message" - ], - "members":{ - "NodeId":{ - "shape":"ClusterNodeId", - "documentation":"

The EC2 instance ID of the node that encountered an error during the replacement operation.

" - }, - "ErrorCode":{ - "shape":"BatchReplaceClusterNodesErrorCode", - "documentation":"

The error code associated with the error encountered when replacing a node.

Possible values:

  • InstanceIdNotFound: The instance does not exist in the specified cluster.

  • InvalidInstanceStatus: The instance is in a state that does not allow replacement. Wait for the instance to finish any ongoing changes before retrying.

  • InstanceIdInUse: Another operation is already in progress for this node. Wait for the operation to complete before retrying.

  • InternalServerError: An internal error occurred while processing this node.

" - }, - "Message":{ - "shape":"String", - "documentation":"

A human-readable message describing the error encountered when replacing a node.

" - } - }, - "documentation":"

Represents an error encountered when replacing a node in a SageMaker HyperPod cluster.

" - }, - "BatchReplaceClusterNodesErrorCode":{ - "type":"string", - "enum":[ - "InstanceIdNotFound", - "InvalidInstanceStatus", - "InstanceIdInUse", - "InternalServerError" - ] - }, - "BatchReplaceClusterNodesErrors":{ - "type":"list", - "member":{"shape":"BatchReplaceClusterNodesError"}, - "max":25, - "min":0 - }, - "BatchReplaceClusterNodesRequest":{ - "type":"structure", - "required":["ClusterName"], - "members":{ - "ClusterName":{ - "shape":"ClusterNameOrArn", - "documentation":"

The name or Amazon Resource Name (ARN) of the SageMaker HyperPod cluster containing the nodes to replace.

" - }, - "NodeIds":{ - "shape":"BatchReplaceClusterNodesRequestNodeIdsList", - "documentation":"

A list of EC2 instance IDs to replace with new hardware. You can specify between 1 and 25 instance IDs.

Replace operations destroy all instance volumes (root and secondary). Ensure you have backed up any important data before proceeding.

  • Either NodeIds or NodeLogicalIds must be provided (or both), but at least one is required.

  • Each instance ID must follow the pattern i- followed by 17 hexadecimal characters (for example, i-0123456789abcdef0).

  • For SageMaker HyperPod clusters using the Slurm workload manager, you cannot replace instances that are configured as Slurm controller nodes.

" - }, - "NodeLogicalIds":{ - "shape":"BatchReplaceClusterNodesRequestNodeLogicalIdsList", - "documentation":"

A list of logical node IDs to replace with new hardware. You can specify between 1 and 25 logical node IDs.

The NodeLogicalId is a unique identifier that persists throughout the node's lifecycle and can be used to track nodes that are still being provisioned and don't yet have an EC2 instance ID assigned.

  • Replace operations destroy all instance volumes (root and secondary). Ensure you have backed up any important data before proceeding.

  • This parameter is only supported for clusters using Continuous as the NodeProvisioningMode. For clusters using the default provisioning mode, use NodeIds instead.

  • Either NodeIds or NodeLogicalIds must be provided (or both), but at least one is required.

" - } - } - }, - "BatchReplaceClusterNodesRequestNodeIdsList":{ - "type":"list", - "member":{"shape":"ClusterNodeId"}, - "max":25, - "min":1 - }, - "BatchReplaceClusterNodesRequestNodeLogicalIdsList":{ - "type":"list", - "member":{"shape":"ClusterNodeLogicalId"}, - "max":25, - "min":1 - }, - "BatchReplaceClusterNodesResponse":{ - "type":"structure", - "members":{ - "Successful":{ - "shape":"ClusterNodeIds", - "documentation":"

A list of EC2 instance IDs for which the replacement operation was successfully initiated.

" - }, - "Failed":{ - "shape":"BatchReplaceClusterNodesErrors", - "documentation":"

A list of errors encountered for EC2 instance IDs that could not be replaced. Each error includes the instance ID, an error code, and a descriptive message.

" - }, - "FailedNodeLogicalIds":{ - "shape":"BatchReplaceClusterNodeLogicalIdsErrors", - "documentation":"

A list of errors encountered for logical node IDs that could not be replaced. Each error includes the logical node ID, an error code, and a descriptive message. This field is only present when NodeLogicalIds were provided in the request.

" - }, - "SuccessfulNodeLogicalIds":{ - "shape":"ClusterNodeLogicalIdList", - "documentation":"

A list of logical node IDs for which the replacement operation was successfully initiated. This field is only present when NodeLogicalIds were provided in the request.

" - } - } - }, - "BatchStrategy":{ - "type":"string", - "enum":[ - "MultiRecord", - "SingleRecord" - ] - }, - "BatchTransformInput":{ - "type":"structure", - "required":[ - "DataCapturedDestinationS3Uri", - "DatasetFormat", - "LocalPath" - ], - "members":{ - "DataCapturedDestinationS3Uri":{ - "shape":"DestinationS3Uri", - "documentation":"

The Amazon S3 location being used to capture the data.

" - }, - "DatasetFormat":{ - "shape":"MonitoringDatasetFormat", - "documentation":"

The dataset format for your batch transform job.

" - }, - "LocalPath":{ - "shape":"ProcessingLocalPath", - "documentation":"

Path to the filesystem where the batch transform data is available to the container.

" - }, - "S3InputMode":{ - "shape":"ProcessingS3InputMode", - "documentation":"

Whether the Pipe or File is used as the input mode for transferring data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File.

" - }, - "S3DataDistributionType":{ - "shape":"ProcessingS3DataDistributionType", - "documentation":"

Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defaults to FullyReplicated

" - }, - "FeaturesAttribute":{ - "shape":"String", - "documentation":"

The attributes of the input data that are the input features.

" - }, - "InferenceAttribute":{ - "shape":"String", - "documentation":"

The attribute of the input data that represents the ground truth label.

" - }, - "ProbabilityAttribute":{ - "shape":"String", - "documentation":"

In a classification problem, the attribute that represents the class probability.

" - }, - "ProbabilityThresholdAttribute":{ - "shape":"ProbabilityThresholdAttribute", - "documentation":"

The threshold for the class probability to be evaluated as a positive result.

" - }, - "StartTimeOffset":{ - "shape":"MonitoringTimeOffsetString", - "documentation":"

If specified, monitoring jobs substract this time from the start time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.

" - }, - "EndTimeOffset":{ - "shape":"MonitoringTimeOffsetString", - "documentation":"

If specified, monitoring jobs subtract this time from the end time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.

" - }, - "ExcludeFeaturesAttribute":{ - "shape":"ExcludeFeaturesAttribute", - "documentation":"

The attributes of the input data to exclude from the analysis.

" - } - }, - "documentation":"

Input object for the batch transform job.

" - }, - "BedrockCustomModelDeploymentMetadata":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"String1024", - "documentation":"

The Amazon Resource Name (ARN) for the Amazon Bedrock custom model deployment.

" - } - }, - "documentation":"

The metadata of the Amazon Bedrock custom model deployment.

" - }, - "BedrockCustomModelMetadata":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"String1024", - "documentation":"

The Amazon Resource Name (ARN) of the Amazon Bedrock custom model.

" - } - }, - "documentation":"

The metadata of the Amazon Bedrock custom model.

" - }, - "BedrockModelImportMetadata":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"String1024", - "documentation":"

The Amazon Resource Name (ARN) of the Amazon Bedrock model import.

" - } - }, - "documentation":"

The metadata of the Amazon Bedrock model import.

" - }, - "BedrockProvisionedModelThroughputMetadata":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"String1024", - "documentation":"

The Amazon Resource Name (ARN) of the Amazon Bedrock provisioned model throughput.

" - } - }, - "documentation":"

The metadata of the Amazon Bedrock provisioned model throughput.

" - }, - "BestObjectiveNotImproving":{ - "type":"structure", - "members":{ - "MaxNumberOfTrainingJobsNotImproving":{ - "shape":"MaxNumberOfTrainingJobsNotImproving", - "documentation":"

The number of training jobs that have failed to improve model performance by 1% or greater over prior training jobs as evaluated against an objective function.

" - } - }, - "documentation":"

A structure that keeps track of which training jobs launched by your hyperparameter tuning job are not improving model performance as evaluated against an objective function.

" - }, - "Bias":{ - "type":"structure", - "members":{ - "Report":{ - "shape":"MetricsSource", - "documentation":"

The bias report for a model

" - }, - "PreTrainingReport":{ - "shape":"MetricsSource", - "documentation":"

The pre-training bias report for a model.

" - }, - "PostTrainingReport":{ - "shape":"MetricsSource", - "documentation":"

The post-training bias report for a model.

" - } - }, - "documentation":"

Contains bias metrics for a model.

" - }, - "BillableTimeInSeconds":{ - "type":"integer", - "box":true, - "min":1 - }, - "BillableTokenCount":{ - "type":"long", - "box":true, - "min":0 - }, - "BlockedReason":{ - "type":"string", - "max":1024, - "min":0 - }, - "BlueGreenUpdatePolicy":{ - "type":"structure", - "required":["TrafficRoutingConfiguration"], - "members":{ - "TrafficRoutingConfiguration":{ - "shape":"TrafficRoutingConfig", - "documentation":"

Defines the traffic routing strategy to shift traffic from the old fleet to the new fleet during an endpoint deployment.

" - }, - "TerminationWaitInSeconds":{ - "shape":"TerminationWaitInSeconds", - "documentation":"

Additional waiting time in seconds after the completion of an endpoint deployment before terminating the old endpoint fleet. Default is 0.

" - }, - "MaximumExecutionTimeoutInSeconds":{ - "shape":"MaximumExecutionTimeoutInSeconds", - "documentation":"

Maximum execution timeout for the deployment. Note that the timeout value should be larger than the total waiting time specified in TerminationWaitInSeconds and WaitIntervalInSeconds.

" - } - }, - "documentation":"

Update policy for a blue/green deployment. If this update policy is specified, SageMaker creates a new fleet during the deployment while maintaining the old fleet. SageMaker flips traffic to the new fleet according to the specified traffic routing configuration. Only one update policy should be used in the deployment configuration. If no update policy is specified, SageMaker uses a blue/green deployment strategy with all at once traffic shifting by default.

" - }, - "Boolean":{"type":"boolean"}, - "BooleanOperator":{ - "type":"string", - "enum":[ - "And", - "Or" - ] - }, - "BorrowLimit":{ - "type":"integer", - "box":true, - "max":10000, - "min":0 - }, - "Branch":{ - "type":"string", - "max":1024, - "min":1, - "pattern":"[^ ~^:?*\\[]+" - }, - "BucketName":{ - "type":"string", - "max":63, - "min":3, - "pattern":"[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]" - }, - "CacheHitResult":{ - "type":"structure", - "members":{ - "SourcePipelineExecutionArn":{ - "shape":"PipelineExecutionArn", - "documentation":"

The Amazon Resource Name (ARN) of the pipeline execution.

" - } - }, - "documentation":"

Details on the cache hit of a pipeline execution step.

" - }, - "CallbackStepMetadata":{ - "type":"structure", - "members":{ - "CallbackToken":{ - "shape":"CallbackToken", - "documentation":"

The pipeline generated token from the Amazon SQS queue.

" - }, - "SqsQueueUrl":{ - "shape":"String256", - "documentation":"

The URL of the Amazon Simple Queue Service (Amazon SQS) queue used by the callback step.

" - }, - "OutputParameters":{ - "shape":"OutputParameterList", - "documentation":"

A list of the output parameters of the callback step.

" - } - }, - "documentation":"

Metadata about a callback step.

" - }, - "CallbackToken":{ - "type":"string", - "max":10, - "min":10, - "pattern":"[a-zA-Z0-9]+" - }, - "CandidateArtifactLocations":{ - "type":"structure", - "required":["Explainability"], - "members":{ - "Explainability":{ - "shape":"ExplainabilityLocation", - "documentation":"

The Amazon S3 prefix to the explainability artifacts generated for the AutoML candidate.

" - }, - "ModelInsights":{ - "shape":"ModelInsightsLocation", - "documentation":"

The Amazon S3 prefix to the model insight artifacts generated for the AutoML candidate.

" - }, - "BacktestResults":{ - "shape":"BacktestResultsLocation", - "documentation":"

The Amazon S3 prefix to the accuracy metrics and the inference results observed over the testing window. Available only for the time-series forecasting problem type.

" - } - }, - "documentation":"

The location of artifacts for an AutoML candidate job.

" - }, - "CandidateDefinitionNotebookLocation":{ - "type":"string", - "min":1 - }, - "CandidateGenerationConfig":{ - "type":"structure", - "members":{ - "AlgorithmsConfig":{ - "shape":"AutoMLAlgorithmsConfig", - "documentation":"

Your Autopilot job trains a default set of algorithms on your dataset. For tabular and time-series data, you can customize the algorithm list by selecting a subset of algorithms for your problem type.

AlgorithmsConfig stores the customized selection of algorithms to train on your data.

  • For the tabular problem type TabularJobConfig, the list of available algorithms to choose from depends on the training mode set in AutoMLJobConfig.Mode .

    • AlgorithmsConfig should not be set when the training mode AutoMLJobConfig.Mode is set to AUTO.

    • When AlgorithmsConfig is provided, one AutoMLAlgorithms attribute must be set and one only.

      If the list of algorithms provided as values for AutoMLAlgorithms is empty, CandidateGenerationConfig uses the full set of algorithms for the given training mode.

    • When AlgorithmsConfig is not provided, CandidateGenerationConfig uses the full set of algorithms for the given training mode.

    For the list of all algorithms per training mode, see AlgorithmConfig.

    For more information on each algorithm, see the Algorithm support section in the Autopilot developer guide.

  • For the time-series forecasting problem type TimeSeriesForecastingJobConfig, choose your algorithms from the list provided in AlgorithmConfig.

    For more information on each algorithm, see the Algorithms support for time-series forecasting section in the Autopilot developer guide.

    • When AlgorithmsConfig is provided, one AutoMLAlgorithms attribute must be set and one only.

      If the list of algorithms provided as values for AutoMLAlgorithms is empty, CandidateGenerationConfig uses the full set of algorithms for time-series forecasting.

    • When AlgorithmsConfig is not provided, CandidateGenerationConfig uses the full set of algorithms for time-series forecasting.

" - } - }, - "documentation":"

Stores the configuration information for how model candidates are generated using an AutoML job V2.

" - }, - "CandidateName":{ - "type":"string", - "max":64, - "min":1 - }, - "CandidateProperties":{ - "type":"structure", - "members":{ - "CandidateArtifactLocations":{ - "shape":"CandidateArtifactLocations", - "documentation":"

The Amazon S3 prefix to the artifacts generated for an AutoML candidate.

" - }, - "CandidateMetrics":{ - "shape":"MetricDataList", - "documentation":"

Information about the candidate metrics for an AutoML job.

" - } - }, - "documentation":"

The properties of an AutoML candidate job.

" - }, - "CandidateSortBy":{ - "type":"string", - "enum":[ - "CreationTime", - "Status", - "FinalObjectiveMetricValue" - ] - }, - "CandidateStatus":{ - "type":"string", - "enum":[ - "Completed", - "InProgress", - "Failed", - "Stopped", - "Stopping" - ] - }, - "CandidateStepArn":{ - "type":"string", - "max":256, - "min":1, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:.*/.*" - }, - "CandidateStepName":{ - "type":"string", - "max":64, - "min":1 - }, - "CandidateStepType":{ - "type":"string", - "enum":[ - "AWS::SageMaker::TrainingJob", - "AWS::SageMaker::TransformJob", - "AWS::SageMaker::ProcessingJob" - ] - }, - "CandidateSteps":{ - "type":"list", - "member":{"shape":"AutoMLCandidateStep"} - }, - "CanvasAppSettings":{ - "type":"structure", - "members":{ - "TimeSeriesForecastingSettings":{ - "shape":"TimeSeriesForecastingSettings", - "documentation":"

Time series forecast settings for the SageMaker Canvas application.

" - }, - "ModelRegisterSettings":{ - "shape":"ModelRegisterSettings", - "documentation":"

The model registry settings for the SageMaker Canvas application.

" - }, - "WorkspaceSettings":{ - "shape":"WorkspaceSettings", - "documentation":"

The workspace settings for the SageMaker Canvas application.

" - }, - "IdentityProviderOAuthSettings":{ - "shape":"IdentityProviderOAuthSettings", - "documentation":"

The settings for connecting to an external data source with OAuth.

" - }, - "DirectDeploySettings":{ - "shape":"DirectDeploySettings", - "documentation":"

The model deployment settings for the SageMaker Canvas application.

" - }, - "KendraSettings":{ - "shape":"KendraSettings", - "documentation":"

The settings for document querying.

" - }, - "GenerativeAiSettings":{ - "shape":"GenerativeAiSettings", - "documentation":"

The generative AI settings for the SageMaker Canvas application.

" - }, - "EmrServerlessSettings":{ - "shape":"EmrServerlessSettings", - "documentation":"

The settings for running Amazon EMR Serverless data processing jobs in SageMaker Canvas.

" - } - }, - "documentation":"

The SageMaker Canvas application settings.

" - }, - "CapacityReservation":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"String", - "documentation":"

The Amazon Resource Name (ARN) of the Capacity Reservation.

" - }, - "Type":{ - "shape":"CapacityReservationType", - "documentation":"

The type of Capacity Reservation. Valid values are ODCR (On-Demand Capacity Reservation) or CRG (Capacity Reservation Group).

" - } - }, - "documentation":"

Information about the Capacity Reservation used by an instance or instance group.

" - }, - "CapacityReservationPreference":{ - "type":"string", - "enum":["capacity-reservations-only"] - }, - "CapacityReservationType":{ - "type":"string", - "enum":[ - "ODCR", - "CRG" - ] - }, - "CapacitySize":{ - "type":"structure", - "required":[ - "Type", - "Value" - ], - "members":{ - "Type":{ - "shape":"CapacitySizeType", - "documentation":"

Specifies the endpoint capacity type.

  • INSTANCE_COUNT: The endpoint activates based on the number of instances.

  • CAPACITY_PERCENT: The endpoint activates based on the specified percentage of capacity.

" - }, - "Value":{ - "shape":"CapacitySizeValue", - "documentation":"

Defines the capacity size, either as a number of instances or a capacity percentage.

" - } - }, - "documentation":"

Specifies the type and size of the endpoint capacity to activate for a blue/green deployment, a rolling deployment, or a rollback strategy. You can specify your batches as either instance count or the overall percentage or your fleet.

For a rollback strategy, if you don't specify the fields in this object, or if you set the Value to 100%, then SageMaker uses a blue/green rollback strategy and rolls all traffic back to the blue fleet.

" - }, - "CapacitySizeConfig":{ - "type":"structure", - "required":[ - "Type", - "Value" - ], - "members":{ - "Type":{ - "shape":"NodeUnavailabilityType", - "documentation":"

Specifies whether SageMaker should process the update by amount or percentage of instances.

" - }, - "Value":{ - "shape":"NodeUnavailabilityValue", - "documentation":"

Specifies the amount or percentage of instances SageMaker updates at a time.

" - } - }, - "documentation":"

The configuration of the size measurements of the AMI update. Using this configuration, you can specify whether SageMaker should update your instance group by an amount or percentage of instances.

" - }, - "CapacitySizeType":{ - "type":"string", - "enum":[ - "INSTANCE_COUNT", - "CAPACITY_PERCENT" - ] - }, - "CapacitySizeValue":{ - "type":"integer", - "box":true, - "min":1 - }, - "CapacityUnit":{ - "type":"integer", - "box":true, - "max":10000000, - "min":0 - }, - "CaptureContentTypeHeader":{ - "type":"structure", - "members":{ - "CsvContentTypes":{ - "shape":"CsvContentTypes", - "documentation":"

The list of all content type headers that Amazon SageMaker AI will treat as CSV and capture accordingly.

" - }, - "JsonContentTypes":{ - "shape":"JsonContentTypes", - "documentation":"

The list of all content type headers that SageMaker AI will treat as JSON and capture accordingly.

" - } - }, - "documentation":"

Configuration specifying how to treat different headers. If no headers are specified Amazon SageMaker AI will by default base64 encode when capturing the data.

" - }, - "CaptureMode":{ - "type":"string", - "enum":[ - "Input", - "Output", - "InputAndOutput" - ] - }, - "CaptureOption":{ - "type":"structure", - "required":["CaptureMode"], - "members":{ - "CaptureMode":{ - "shape":"CaptureMode", - "documentation":"

Specify the boundary of data to capture.

" - } - }, - "documentation":"

Specifies data Model Monitor will capture.

" - }, - "CaptureOptionList":{ - "type":"list", - "member":{"shape":"CaptureOption"}, - "max":32, - "min":1 - }, - "CaptureStatus":{ - "type":"string", - "enum":[ - "Started", - "Stopped" - ] - }, - "Catalog":{ - "type":"string", - "max":255, - "min":1, - "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" - }, - "CategoricalParameter":{ - "type":"structure", - "required":[ - "Name", - "Value" - ], - "members":{ - "Name":{ - "shape":"String64", - "documentation":"

The Name of the environment variable.

" - }, - "Value":{ - "shape":"CategoricalParameterRangeValues", - "documentation":"

The list of values you can pass.

" - } - }, - "documentation":"

Environment parameters you want to benchmark your load test against.

" - }, - "CategoricalParameterRange":{ - "type":"structure", - "required":[ - "Name", - "Values" - ], - "members":{ - "Name":{ - "shape":"ParameterKey", - "documentation":"

The name of the categorical hyperparameter to tune.

" - }, - "Values":{ - "shape":"ParameterValues", - "documentation":"

A list of the categories for the hyperparameter.

" - } - }, - "documentation":"

A list of categorical hyperparameters to tune.

" - }, - "CategoricalParameterRangeSpecification":{ - "type":"structure", - "required":["Values"], - "members":{ - "Values":{ - "shape":"ParameterValues", - "documentation":"

The allowed categories for the hyperparameter.

" - } - }, - "documentation":"

Defines the possible values for a categorical hyperparameter.

" - }, - "CategoricalParameterRangeValues":{ - "type":"list", - "member":{"shape":"String128"}, - "max":3, - "min":1 - }, - "CategoricalParameterRanges":{ - "type":"list", - "member":{"shape":"CategoricalParameterRange"}, - "max":30, - "min":0 - }, - "CategoricalParameters":{ - "type":"list", - "member":{"shape":"CategoricalParameter"}, - "max":5, - "min":1 - }, - "Cents":{ - "type":"integer", - "max":99, - "min":0 - }, - "CertifyForMarketplace":{"type":"boolean"}, - "CfnCreateTemplateProvider":{ - "type":"structure", - "required":[ - "TemplateName", - "TemplateURL" - ], - "members":{ - "TemplateName":{ - "shape":"CfnTemplateName", - "documentation":"

A unique identifier for the template within the project.

" - }, - "TemplateURL":{ - "shape":"CfnTemplateURL", - "documentation":"

The Amazon S3 URL of the CloudFormation template.

" - }, - "RoleARN":{ - "shape":"RoleArn", - "documentation":"

The IAM role that CloudFormation assumes when creating the stack.

" - }, - "Parameters":{ - "shape":"CfnStackCreateParameters", - "documentation":"

An array of CloudFormation stack parameters.

" - } - }, - "documentation":"

The CloudFormation template provider configuration for creating infrastructure resources.

" - }, - "CfnStackCreateParameter":{ - "type":"structure", - "required":["Key"], - "members":{ - "Key":{ - "shape":"CfnStackParameterKey", - "documentation":"

The name of the CloudFormation parameter.

" - }, - "Value":{ - "shape":"CfnStackParameterValue", - "documentation":"

The value of the CloudFormation parameter.

" - } - }, - "documentation":"

A key-value pair that represents a parameter for the CloudFormation stack.

" - }, - "CfnStackCreateParameters":{ - "type":"list", - "member":{"shape":"CfnStackCreateParameter"}, - "max":180, - "min":0 - }, - "CfnStackDetail":{ - "type":"structure", - "required":["StatusMessage"], - "members":{ - "Name":{ - "shape":"CfnStackName", - "documentation":"

The name of the CloudFormation stack.

" - }, - "Id":{ - "shape":"CfnStackId", - "documentation":"

The unique identifier of the CloudFormation stack.

" - }, - "StatusMessage":{ - "shape":"CfnStackStatusMessage", - "documentation":"

A human-readable message about the stack's current status.

" - } - }, - "documentation":"

Details about the CloudFormation stack.

" - }, - "CfnStackId":{ - "type":"string", - "max":256, - "min":1, - "pattern":"(?=.{1,256}$)arn:aws[a-z\\-]*:cloudformation:[a-z0-9\\-]*:[0-9]{12}:stack/[a-zA-Z][a-zA-Z0-9-]{0,127}/.*" - }, - "CfnStackName":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[A-Za-z][A-Za-z0-9-]{0,127}" - }, - "CfnStackParameter":{ - "type":"structure", - "required":["Key"], - "members":{ - "Key":{ - "shape":"CfnStackParameterKey", - "documentation":"

The name of the CloudFormation parameter.

" - }, - "Value":{ - "shape":"CfnStackParameterValue", - "documentation":"

The value of the CloudFormation parameter.

" - } - }, - "documentation":"

A key-value pair representing a parameter used in the CloudFormation stack.

" - }, - "CfnStackParameterKey":{ - "type":"string", - "max":255, - "min":1, - "pattern":".{1,255}" - }, - "CfnStackParameterValue":{ - "type":"string", - "max":4096, - "min":0, - "pattern":".{0,4096}" - }, - "CfnStackParameters":{ - "type":"list", - "member":{"shape":"CfnStackParameter"}, - "max":180, - "min":0 - }, - "CfnStackStatusMessage":{ - "type":"string", - "max":4096, - "min":1, - "pattern":".{1,4096}" - }, - "CfnStackUpdateParameter":{ - "type":"structure", - "required":["Key"], - "members":{ - "Key":{ - "shape":"CfnStackParameterKey", - "documentation":"

The name of the CloudFormation parameter.

" - }, - "Value":{ - "shape":"CfnStackParameterValue", - "documentation":"

The value of the CloudFormation parameter.

" - } - }, - "documentation":"

A key-value pair representing a parameter used in the CloudFormation stack.

" - }, - "CfnStackUpdateParameters":{ - "type":"list", - "member":{"shape":"CfnStackUpdateParameter"}, - "max":180, - "min":0 - }, - "CfnTemplateName":{ - "type":"string", - "max":32, - "min":1, - "pattern":"(?=.{1,32}$)[a-zA-Z0-9](-*[a-zA-Z0-9])*" - }, - "CfnTemplateProviderDetail":{ - "type":"structure", - "required":[ - "TemplateName", - "TemplateURL" - ], - "members":{ - "TemplateName":{ - "shape":"CfnTemplateName", - "documentation":"

The unique identifier of the template within the project.

" - }, - "TemplateURL":{ - "shape":"CfnTemplateURL", - "documentation":"

The Amazon S3 URL of the CloudFormation template.

" - }, - "RoleARN":{ - "shape":"RoleArn", - "documentation":"

The IAM role used by CloudFormation to create the stack.

" - }, - "Parameters":{ - "shape":"CfnStackParameters", - "documentation":"

An array of CloudFormation stack parameters.

" - }, - "StackDetail":{ - "shape":"CfnStackDetail", - "documentation":"

Information about the CloudFormation stack created by the template provider.

" - } - }, - "documentation":"

Details about a CloudFormation template provider configuration and associated provisioning information.

" - }, - "CfnTemplateURL":{ - "type":"string", - "max":1024, - "min":1, - "pattern":"(?=.{1,1024}$)(https)://([^/]+)/(.+)" - }, - "CfnUpdateTemplateProvider":{ - "type":"structure", - "required":[ - "TemplateName", - "TemplateURL" - ], - "members":{ - "TemplateName":{ - "shape":"CfnTemplateName", - "documentation":"

The unique identifier of the template to update within the project.

" - }, - "TemplateURL":{ - "shape":"CfnTemplateURL", - "documentation":"

The Amazon S3 URL of the CloudFormation template.

" - }, - "Parameters":{ - "shape":"CfnStackUpdateParameters", - "documentation":"

An array of CloudFormation stack parameters.

" - } - }, - "documentation":"

Contains configuration details for updating an existing CloudFormation template provider in the project.

" - }, - "Channel":{ - "type":"structure", - "required":[ - "ChannelName", - "DataSource" - ], - "members":{ - "ChannelName":{ - "shape":"ChannelName", - "documentation":"

The name of the channel.

" - }, - "DataSource":{ - "shape":"DataSource", - "documentation":"

The location of the channel data.

" - }, - "ContentType":{ - "shape":"ContentType", - "documentation":"

The MIME type of the data.

" - }, - "CompressionType":{ - "shape":"CompressionType", - "documentation":"

If training data is compressed, the compression type. The default value is None. CompressionType is used only in Pipe input mode. In File mode, leave this field unset or set it to None.

" - }, - "RecordWrapperType":{ - "shape":"RecordWrapper", - "documentation":"

Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don't need to set this attribute. For more information, see Create a Dataset Using RecordIO.

In File mode, leave this field unset or set it to None.

" - }, - "InputMode":{ - "shape":"TrainingInputMode", - "documentation":"

(Optional) The input mode to use for the data channel in a training job. If you don't set a value for InputMode, SageMaker uses the value set for TrainingInputMode. Use this parameter to override the TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode.

To use a model for incremental training, choose File input model.

" - }, - "ShuffleConfig":{ - "shape":"ShuffleConfig", - "documentation":"

A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType, this shuffles the results of the S3 key prefix matches. If you use ManifestFile, the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile, the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value.

For Pipe input mode, shuffling is done at the start of every epoch. With large datasets this ensures that the order of the training data is different for each epoch, it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key, the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.

" - } - }, - "documentation":"

A channel is a named input source that training algorithms can consume.

" - }, - "ChannelName":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[A-Za-z0-9\\.\\-_]+" - }, - "ChannelSpecification":{ - "type":"structure", - "required":[ - "Name", - "SupportedContentTypes", - "SupportedInputModes" - ], - "members":{ - "Name":{ - "shape":"ChannelName", - "documentation":"

The name of the channel.

" - }, - "Description":{ - "shape":"EntityDescription", - "documentation":"

A brief description of the channel.

" - }, - "IsRequired":{ - "shape":"Boolean", - "documentation":"

Indicates whether the channel is required by the algorithm.

", - "box":true - }, - "SupportedContentTypes":{ - "shape":"ContentTypes", - "documentation":"

The supported MIME types for the data.

" - }, - "SupportedCompressionTypes":{ - "shape":"CompressionTypes", - "documentation":"

The allowed compression types, if data compression is used.

" - }, - "SupportedInputModes":{ - "shape":"InputModes", - "documentation":"

The allowed input mode, either FILE or PIPE.

In FILE mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode.

In PIPE mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.

" - } - }, - "documentation":"

Defines a named input source, called a channel, to be used by an algorithm.

" - }, - "ChannelSpecifications":{ - "type":"list", - "member":{"shape":"ChannelSpecification"}, - "max":8, - "min":1 - }, - "CheckpointConfig":{ - "type":"structure", - "required":["S3Uri"], - "members":{ - "S3Uri":{ - "shape":"S3Uri", - "documentation":"

Identifies the S3 path where you want SageMaker to store checkpoints. For example, s3://bucket-name/key-name-prefix.

" - }, - "LocalPath":{ - "shape":"DirectoryPath", - "documentation":"

(Optional) The local directory where checkpoints are written. The default directory is /opt/ml/checkpoints/.

" - } - }, - "documentation":"

Contains information about the output location for managed spot training checkpoint data.

" - }, - "Cidr":{ - "type":"string", - "max":64, - "min":4, - "pattern":"(^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\\/(3[0-2]|[1-2][0-9]|[0-9]))$)|(^s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:)))(%.+)?s*(\\/(12[0-8]|1[0-1][0-9]|[1-9][0-9]|[0-9]))$)" - }, - "Cidrs":{ - "type":"list", - "member":{"shape":"Cidr"} - }, - "ClarifyCheckStepMetadata":{ - "type":"structure", - "members":{ - "CheckType":{ - "shape":"String256", - "documentation":"

The type of the Clarify Check step

" - }, - "BaselineUsedForDriftCheckConstraints":{ - "shape":"String1024", - "documentation":"

The Amazon S3 URI of baseline constraints file to be used for the drift check.

" - }, - "CalculatedBaselineConstraints":{ - "shape":"String1024", - "documentation":"

The Amazon S3 URI of the newly calculated baseline constraints file.

" - }, - "ModelPackageGroupName":{ - "shape":"String256", - "documentation":"

The model package group name.

" - }, - "ViolationReport":{ - "shape":"String1024", - "documentation":"

The Amazon S3 URI of the violation report if violations are detected.

" - }, - "CheckJobArn":{ - "shape":"String256", - "documentation":"

The Amazon Resource Name (ARN) of the check processing job that was run by this step's execution.

" - }, - "SkipCheck":{ - "shape":"Boolean", - "documentation":"

This flag indicates if the drift check against the previous baseline will be skipped or not. If it is set to False, the previous baseline of the configured check type must be available.

", - "box":true - }, - "RegisterNewBaseline":{ - "shape":"Boolean", - "documentation":"

This flag indicates if a newly calculated baseline can be accessed through step properties BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. If it is set to False, the previous baseline of the configured check type must also be available. These can be accessed through the BaselineUsedForDriftCheckConstraints property.

", - "box":true - } - }, - "documentation":"

The container for the metadata for the ClarifyCheck step. For more information, see the topic on ClarifyCheck step in the Amazon SageMaker Developer Guide.

" - }, - "ClarifyContentTemplate":{ - "type":"string", - "max":64, - "min":1, - "pattern":".*" - }, - "ClarifyEnableExplanations":{ - "type":"string", - "max":64, - "min":1, - "pattern":".*" - }, - "ClarifyExplainerConfig":{ - "type":"structure", - "required":["ShapConfig"], - "members":{ - "EnableExplanations":{ - "shape":"ClarifyEnableExplanations", - "documentation":"

A JMESPath boolean expression used to filter which records to explain. Explanations are activated by default. See EnableExplanations for additional information.

" - }, - "InferenceConfig":{ - "shape":"ClarifyInferenceConfig", - "documentation":"

The inference configuration parameter for the model container.

" - }, - "ShapConfig":{ - "shape":"ClarifyShapConfig", - "documentation":"

The configuration for SHAP analysis.

" - } - }, - "documentation":"

The configuration parameters for the SageMaker Clarify explainer.

" - }, - "ClarifyFeatureHeaders":{ - "type":"list", - "member":{"shape":"ClarifyHeader"}, - "max":256, - "min":1 - }, - "ClarifyFeatureType":{ - "type":"string", - "enum":[ - "numerical", - "categorical", - "text" - ] - }, - "ClarifyFeatureTypes":{ - "type":"list", - "member":{"shape":"ClarifyFeatureType"}, - "max":256, - "min":1 - }, - "ClarifyFeaturesAttribute":{ - "type":"string", - "max":64, - "min":1, - "pattern":".*" - }, - "ClarifyHeader":{ - "type":"string", - "max":64, - "min":1, - "pattern":".*" - }, - "ClarifyInferenceConfig":{ - "type":"structure", - "members":{ - "FeaturesAttribute":{ - "shape":"ClarifyFeaturesAttribute", - "documentation":"

Provides the JMESPath expression to extract the features from a model container input in JSON Lines format. For example, if FeaturesAttribute is the JMESPath expression 'myfeatures', it extracts a list of features [1,2,3] from request data '{\"myfeatures\":[1,2,3]}'.

" - }, - "ContentTemplate":{ - "shape":"ClarifyContentTemplate", - "documentation":"

A template string used to format a JSON record into an acceptable model container input. For example, a ContentTemplate string '{\"myfeatures\":$features}' will format a list of features [1,2,3] into the record string '{\"myfeatures\":[1,2,3]}'. Required only when the model container input is in JSON Lines format.

" - }, - "MaxRecordCount":{ - "shape":"ClarifyMaxRecordCount", - "documentation":"

The maximum number of records in a request that the model container can process when querying the model container for the predictions of a synthetic dataset. A record is a unit of input data that inference can be made on, for example, a single line in CSV data. If MaxRecordCount is 1, the model container expects one record per request. A value of 2 or greater means that the model expects batch requests, which can reduce overhead and speed up the inferencing process. If this parameter is not provided, the explainer will tune the record count per request according to the model container's capacity at runtime.

" - }, - "MaxPayloadInMB":{ - "shape":"ClarifyMaxPayloadInMB", - "documentation":"

The maximum payload size (MB) allowed of a request from the explainer to the model container. Defaults to 6 MB.

" - }, - "ProbabilityIndex":{ - "shape":"ClarifyProbabilityIndex", - "documentation":"

A zero-based index used to extract a probability value (score) or list from model container output in CSV format. If this value is not provided, the entire model container output will be treated as a probability value (score) or list.

Example for a single class model: If the model container output consists of a string-formatted prediction label followed by its probability: '1,0.6', set ProbabilityIndex to 1 to select the probability value 0.6.

Example for a multiclass model: If the model container output consists of a string-formatted prediction label followed by its probability: '\"[\\'cat\\',\\'dog\\',\\'fish\\']\",\"[0.1,0.6,0.3]\"', set ProbabilityIndex to 1 to select the probability values [0.1,0.6,0.3].

" - }, - "LabelIndex":{ - "shape":"ClarifyLabelIndex", - "documentation":"

A zero-based index used to extract a label header or list of label headers from model container output in CSV format.

Example for a multiclass model: If the model container output consists of label headers followed by probabilities: '\"[\\'cat\\',\\'dog\\',\\'fish\\']\",\"[0.1,0.6,0.3]\"', set LabelIndex to 0 to select the label headers ['cat','dog','fish'].

" - }, - "ProbabilityAttribute":{ - "shape":"ClarifyProbabilityAttribute", - "documentation":"

A JMESPath expression used to extract the probability (or score) from the model container output if the model container is in JSON Lines format.

Example: If the model container output of a single request is '{\"predicted_label\":1,\"probability\":0.6}', then set ProbabilityAttribute to 'probability'.

" - }, - "LabelAttribute":{ - "shape":"ClarifyLabelAttribute", - "documentation":"

A JMESPath expression used to locate the list of label headers in the model container output.

Example: If the model container output of a batch request is '{\"labels\":[\"cat\",\"dog\",\"fish\"],\"probability\":[0.6,0.3,0.1]}', then set LabelAttribute to 'labels' to extract the list of label headers [\"cat\",\"dog\",\"fish\"]

" - }, - "LabelHeaders":{ - "shape":"ClarifyLabelHeaders", - "documentation":"

For multiclass classification problems, the label headers are the names of the classes. Otherwise, the label header is the name of the predicted label. These are used to help readability for the output of the InvokeEndpoint API. See the response section under Invoke the endpoint in the Developer Guide for more information. If there are no label headers in the model container output, provide them manually using this parameter.

" - }, - "FeatureHeaders":{ - "shape":"ClarifyFeatureHeaders", - "documentation":"

The names of the features. If provided, these are included in the endpoint response payload to help readability of the InvokeEndpoint output. See the Response section under Invoke the endpoint in the Developer Guide for more information.

" - }, - "FeatureTypes":{ - "shape":"ClarifyFeatureTypes", - "documentation":"

A list of data types of the features (optional). Applicable only to NLP explainability. If provided, FeatureTypes must have at least one 'text' string (for example, ['text']). If FeatureTypes is not provided, the explainer infers the feature types based on the baseline data. The feature types are included in the endpoint response payload. For additional information see the response section under Invoke the endpoint in the Developer Guide for more information.

" - } - }, - "documentation":"

The inference configuration parameter for the model container.

" - }, - "ClarifyLabelAttribute":{ - "type":"string", - "max":64, - "min":1, - "pattern":".*" - }, - "ClarifyLabelHeaders":{ - "type":"list", - "member":{"shape":"ClarifyHeader"}, - "max":16, - "min":1 - }, - "ClarifyLabelIndex":{ - "type":"integer", - "box":true, - "min":0 - }, - "ClarifyMaxPayloadInMB":{ - "type":"integer", - "box":true, - "max":25, - "min":1 - }, - "ClarifyMaxRecordCount":{ - "type":"integer", - "box":true, - "min":1 - }, - "ClarifyMimeType":{ - "type":"string", - "max":255, - "min":0, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9])*\\/[a-zA-Z0-9](-*[a-zA-Z0-9+.])*" - }, - "ClarifyProbabilityAttribute":{ - "type":"string", - "max":64, - "min":1, - "pattern":".*" - }, - "ClarifyProbabilityIndex":{ - "type":"integer", - "box":true, - "min":0 - }, - "ClarifyShapBaseline":{ - "type":"string", - "max":4096, - "min":1, - "pattern":"[\\s\\S]+" - }, - "ClarifyShapBaselineConfig":{ - "type":"structure", - "members":{ - "MimeType":{ - "shape":"ClarifyMimeType", - "documentation":"

The MIME type of the baseline data. Choose from 'text/csv' or 'application/jsonlines'. Defaults to 'text/csv'.

" - }, - "ShapBaseline":{ - "shape":"ClarifyShapBaseline", - "documentation":"

The inline SHAP baseline data in string format. ShapBaseline can have one or multiple records to be used as the baseline dataset. The format of the SHAP baseline file should be the same format as the training dataset. For example, if the training dataset is in CSV format and each record contains four features, and all features are numerical, then the format of the baseline data should also share these characteristics. For natural language processing (NLP) of text columns, the baseline value should be the value used to replace the unit of text specified by the Granularity of the TextConfig parameter. The size limit for ShapBasline is 4 KB. Use the ShapBaselineUri parameter if you want to provide more than 4 KB of baseline data.

" - }, - "ShapBaselineUri":{ - "shape":"Url", - "documentation":"

The uniform resource identifier (URI) of the S3 bucket where the SHAP baseline file is stored. The format of the SHAP baseline file should be the same format as the format of the training dataset. For example, if the training dataset is in CSV format, and each record in the training dataset has four features, and all features are numerical, then the baseline file should also have this same format. Each record should contain only the features. If you are using a virtual private cloud (VPC), the ShapBaselineUri should be accessible to the VPC. For more information about setting up endpoints with Amazon Virtual Private Cloud, see Give SageMaker access to Resources in your Amazon Virtual Private Cloud.

" - } - }, - "documentation":"

The configuration for the SHAP baseline (also called the background or reference dataset) of the Kernal SHAP algorithm.

  • The number of records in the baseline data determines the size of the synthetic dataset, which has an impact on latency of explainability requests. For more information, see the Synthetic data of Configure and create an endpoint.

  • ShapBaseline and ShapBaselineUri are mutually exclusive parameters. One or the either is required to configure a SHAP baseline.

" - }, - "ClarifyShapConfig":{ - "type":"structure", - "required":["ShapBaselineConfig"], - "members":{ - "ShapBaselineConfig":{ - "shape":"ClarifyShapBaselineConfig", - "documentation":"

The configuration for the SHAP baseline of the Kernal SHAP algorithm.

" - }, - "NumberOfSamples":{ - "shape":"ClarifyShapNumberOfSamples", - "documentation":"

The number of samples to be used for analysis by the Kernal SHAP algorithm.

The number of samples determines the size of the synthetic dataset, which has an impact on latency of explainability requests. For more information, see the Synthetic data of Configure and create an endpoint.

" - }, - "UseLogit":{ - "shape":"ClarifyShapUseLogit", - "documentation":"

A Boolean toggle to indicate if you want to use the logit function (true) or log-odds units (false) for model predictions. Defaults to false.

" - }, - "Seed":{ - "shape":"ClarifyShapSeed", - "documentation":"

The starting value used to initialize the random number generator in the explainer. Provide a value for this parameter to obtain a deterministic SHAP result.

" - }, - "TextConfig":{ - "shape":"ClarifyTextConfig", - "documentation":"

A parameter that indicates if text features are treated as text and explanations are provided for individual units of text. Required for natural language processing (NLP) explainability only.

" - } - }, - "documentation":"

The configuration for SHAP analysis using SageMaker Clarify Explainer.

" - }, - "ClarifyShapNumberOfSamples":{ - "type":"integer", - "box":true, - "min":1 - }, - "ClarifyShapSeed":{ - "type":"integer", - "box":true - }, - "ClarifyShapUseLogit":{ - "type":"boolean", - "box":true - }, - "ClarifyTextConfig":{ - "type":"structure", - "required":[ - "Language", - "Granularity" - ], - "members":{ - "Language":{ - "shape":"ClarifyTextLanguage", - "documentation":"

Specifies the language of the text features in ISO 639-1 or ISO 639-3 code of a supported language.

For a mix of multiple languages, use code 'xx'.

" - }, - "Granularity":{ - "shape":"ClarifyTextGranularity", - "documentation":"

The unit of granularity for the analysis of text features. For example, if the unit is 'token', then each token (like a word in English) of the text is treated as a feature. SHAP values are computed for each unit/feature.

" - } - }, - "documentation":"

A parameter used to configure the SageMaker Clarify explainer to treat text features as text so that explanations are provided for individual units of text. Required only for natural language processing (NLP) explainability.

" - }, - "ClarifyTextGranularity":{ - "type":"string", - "enum":[ - "token", - "sentence", - "paragraph" - ] - }, - "ClarifyTextLanguage":{ - "type":"string", - "enum":[ - "af", - "sq", - "ar", - "hy", - "eu", - "bn", - "bg", - "ca", - "zh", - "hr", - "cs", - "da", - "nl", - "en", - "et", - "fi", - "fr", - "de", - "el", - "gu", - "he", - "hi", - "hu", - "is", - "id", - "ga", - "it", - "kn", - "ky", - "lv", - "lt", - "lb", - "mk", - "ml", - "mr", - "ne", - "nb", - "fa", - "pl", - "pt", - "ro", - "ru", - "sa", - "sr", - "tn", - "si", - "sk", - "sl", - "es", - "sv", - "tl", - "ta", - "tt", - "te", - "tr", - "uk", - "ur", - "yo", - "lij", - "xx" - ] - }, - "ClientId":{ - "type":"string", - "max":1024, - "min":1, - "pattern":"[ -~]+" - }, - "ClientSecret":{ - "type":"string", - "max":1024, - "min":1, - "pattern":"[ -~]+", - "sensitive":true - }, - "ClientToken":{ - "type":"string", - "max":36, - "min":1, - "pattern":"[a-zA-Z0-9-]+" - }, - "ClusterArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:cluster/[a-z0-9]{12}" - }, - "ClusterAutoPatchConfig":{ - "type":"structure", - "required":["PatchingStrategy"], - "members":{ - "PatchingStrategy":{ - "shape":"ClusterPatchingStrategy", - "documentation":"

The strategy for applying patches to instances in the group.

  • WhenIdle: Cordons all instances and patches each instance as it becomes idle (no running jobs). Each instance is uncordoned immediately after patching and becomes available for new jobs. If instances do not become idle, they remain on the previous AMI version. You can then use UpdateClusterSoftware with the desired ImageReleaseVersion to manually update the remaining instances.

  • WhenAllIdle: Cordons all instances and waits for all to become idle before patching. All instances are uncordoned after patching completes. If not all instances become idle, no patching occurs and all instances remain on the previous AMI version.

" - }, - "PatchSchedule":{ - "shape":"ClusterPatchSchedule", - "documentation":"

The schedule for automatic patching, including the next patch date.

" - }, - "DeploymentConfig":{ - "shape":"DeploymentConfiguration", - "documentation":"

The deployment configuration for rolling patch updates, including rollback settings and batch sizes. Only applicable when using a rolling patching strategy.

" - } - }, - "documentation":"

The configuration for automatic patching of the instance group. When configured, the system automatically applies security patch AMI updates to the instance group.

" - }, - "ClusterAutoPatchConfigDetails":{ - "type":"structure", - "members":{ - "PatchingStrategy":{ - "shape":"ClusterPatchingStrategy", - "documentation":"

The strategy used for applying patches to instances in the group.

  • WhenIdle: Cordons all instances and patches each instance as it becomes idle (no running jobs). Each instance is uncordoned immediately after patching and becomes available for new jobs. If instances do not become idle, they remain on the previous AMI version. You can then use UpdateClusterSoftware with the desired ImageReleaseVersion to manually update the remaining instances.

  • WhenAllIdle: Cordons all instances and waits for all to become idle before patching. All instances are uncordoned after patching completes. If not all instances become idle, no patching occurs and all instances remain on the previous AMI version.

" - }, - "CurrentPatchSchedule":{ - "shape":"ClusterPatchScheduleDetails", - "documentation":"

The currently active patch schedule that the system will execute.

" - }, - "DesiredPatchSchedule":{ - "shape":"ClusterPatchScheduleDetails", - "documentation":"

The requested patch schedule. Differs from CurrentPatchSchedule when a reschedule request is pending.

" - }, - "DeploymentConfig":{ - "shape":"DeploymentConfiguration", - "documentation":"

The deployment configuration for rolling patch updates.

" - } - }, - "documentation":"

The auto-patching configuration details for the instance group, including the patching strategy and schedule.

" - }, - "ClusterAutoScalerType":{ - "type":"string", - "enum":["Karpenter"] - }, - "ClusterAutoScalingConfig":{ - "type":"structure", - "required":["Mode"], - "members":{ - "Mode":{ - "shape":"ClusterAutoScalingMode", - "documentation":"

Describes whether autoscaling is enabled or disabled for the cluster. Valid values are Enable and Disable.

" - }, - "AutoScalerType":{ - "shape":"ClusterAutoScalerType", - "documentation":"

The type of autoscaler to use. Currently supported value is Karpenter.

" - } - }, - "documentation":"

Specifies the autoscaling configuration for a HyperPod cluster.

" - }, - "ClusterAutoScalingConfigOutput":{ - "type":"structure", - "required":[ - "Mode", - "Status" - ], - "members":{ - "Mode":{ - "shape":"ClusterAutoScalingMode", - "documentation":"

Describes whether autoscaling is enabled or disabled for the cluster.

" - }, - "AutoScalerType":{ - "shape":"ClusterAutoScalerType", - "documentation":"

The type of autoscaler configured for the cluster.

" - }, - "Status":{ - "shape":"ClusterAutoScalingStatus", - "documentation":"

The current status of the autoscaling configuration. Valid values are InService, Failed, Creating, and Deleting.

" - }, - "FailureMessage":{ - "shape":"String", - "documentation":"

If the autoscaling status is Failed, this field contains a message describing the failure.

" - } - }, - "documentation":"

The autoscaling configuration and status information for a HyperPod cluster.

" - }, - "ClusterAutoScalingMode":{ - "type":"string", - "enum":[ - "Enable", - "Disable" - ] - }, - "ClusterAutoScalingStatus":{ - "type":"string", - "enum":[ - "InService", - "Failed", - "Creating", - "Deleting" - ] - }, - "ClusterAvailabilityZone":{ - "type":"string", - "pattern":"[a-z]{2}-[a-z]+-\\d[a-z]" - }, - "ClusterAvailabilityZoneId":{ - "type":"string", - "pattern":"[a-z]{3}\\d-az\\d" - }, - "ClusterAvailabilityZones":{ - "type":"list", - "member":{"shape":"ClusterAvailabilityZone"}, - "max":10, - "min":1 - }, - "ClusterCapacityRequirements":{ - "type":"structure", - "members":{ - "Spot":{ - "shape":"ClusterSpotOptions", - "documentation":"

Configuration options specific to Spot instances.

" - }, - "OnDemand":{ - "shape":"ClusterOnDemandOptions", - "documentation":"

Configuration options specific to On-Demand instances.

" - } - }, - "documentation":"

Defines the instance capacity requirements for an instance group, including configurations for both Spot and On-Demand capacity types.

" - }, - "ClusterCapacityType":{ - "type":"string", - "enum":[ - "Spot", - "OnDemand" - ] - }, - "ClusterConfigMode":{ - "type":"string", - "enum":[ - "Enable", - "Disable" - ] - }, - "ClusterDnsName":{ - "type":"string", - "max":275, - "min":16, - "pattern":"((fs|fc)i?-[0-9a-f]{8,}\\..{4,253})" - }, - "ClusterEbsVolumeConfig":{ - "type":"structure", - "members":{ - "VolumeSizeInGB":{ - "shape":"ClusterEbsVolumeSizeInGB", - "documentation":"

The size in gigabytes (GB) of the additional EBS volume to be attached to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each instance within the SageMaker HyperPod cluster instance group and mounted to /opt/sagemaker.

" - }, - "VolumeKmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The ID of a KMS key to encrypt the Amazon EBS volume.

" - }, - "RootVolume":{ - "shape":"Boolean", - "documentation":"

Specifies whether the configuration is for the cluster's root or secondary Amazon EBS volume. You can specify two ClusterEbsVolumeConfig fields to configure both the root and secondary volumes. Set the value to True if you'd like to provide your own customer managed Amazon Web Services KMS key to encrypt the root volume. When True:

  • The configuration is applied to the root volume.

  • You can't specify the VolumeSizeInGB field. The size of the root volume is determined for you.

  • You must specify a KMS key ID for VolumeKmsKeyId to encrypt the root volume with your own KMS key instead of an Amazon Web Services owned KMS key.

Otherwise, by default, the value is False, and the following applies:

  • The configuration is applied to the secondary volume, while the root volume is encrypted with an Amazon Web Services owned key.

  • You must specify the VolumeSizeInGB field.

  • You can optionally specify the VolumeKmsKeyId to encrypt the secondary volume with your own KMS key instead of an Amazon Web Services owned KMS key.

", - "box":true - } - }, - "documentation":"

Defines the configuration for attaching an additional Amazon Elastic Block Store (EBS) volume to each instance of the SageMaker HyperPod cluster instance group. To learn more, see SageMaker HyperPod release notes: June 20, 2024.

" - }, - "ClusterEbsVolumeSizeInGB":{ - "type":"integer", - "box":true, - "max":16384, - "min":1 - }, - "ClusterEventDetail":{ - "type":"structure", - "required":[ - "EventId", - "ClusterArn", - "ClusterName", - "ResourceType", - "EventTime" - ], - "members":{ - "EventId":{ - "shape":"EventId", - "documentation":"

The unique identifier (UUID) of the event.

" - }, - "ClusterArn":{ - "shape":"ClusterArn", - "documentation":"

The Amazon Resource Name (ARN) of the HyperPod cluster associated with the event.

" - }, - "ClusterName":{ - "shape":"ClusterName", - "documentation":"

The name of the HyperPod cluster associated with the event.

" - }, - "InstanceGroupName":{ - "shape":"ClusterInstanceGroupName", - "documentation":"

The name of the instance group associated with the event, if applicable.

" - }, - "InstanceId":{ - "shape":"String", - "documentation":"

The EC2 instance ID associated with the event, if applicable.

" - }, - "ResourceType":{ - "shape":"ClusterEventResourceType", - "documentation":"

The type of resource associated with the event. Valid values are Cluster, InstanceGroup, or Instance.

" - }, - "EventTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the event occurred.

" - }, - "EventDetails":{ - "shape":"EventDetails", - "documentation":"

Additional details about the event, including event-specific metadata.

" - }, - "Description":{ - "shape":"String", - "documentation":"

A human-readable description of the event.

" - }, - "EventLevel":{ - "shape":"ClusterEventLevel", - "documentation":"

The severity level of the event. Valid values are Info, Warn, and Error.

" - } - }, - "documentation":"

Detailed information about a specific event in a HyperPod cluster.

" - }, - "ClusterEventLevel":{ - "type":"string", - "documentation":"

The severity level for a HyperPod cluster event.

", - "enum":[ - "Info", - "Warn", - "Error" - ] - }, - "ClusterEventMaxResults":{ - "type":"integer", - "box":true, - "max":100, - "min":1 - }, - "ClusterEventResourceType":{ - "type":"string", - "enum":[ - "Cluster", - "InstanceGroup", - "Instance" - ] - }, - "ClusterEventSummaries":{ - "type":"list", - "member":{"shape":"ClusterEventSummary"}, - "max":100, - "min":0 - }, - "ClusterEventSummary":{ - "type":"structure", - "required":[ - "EventId", - "ClusterArn", - "ClusterName", - "ResourceType", - "EventTime" - ], - "members":{ - "EventId":{ - "shape":"EventId", - "documentation":"

The unique identifier (UUID) of the event.

" - }, - "ClusterArn":{ - "shape":"ClusterArn", - "documentation":"

The Amazon Resource Name (ARN) of the HyperPod cluster associated with the event.

" - }, - "ClusterName":{ - "shape":"ClusterName", - "documentation":"

The name of the HyperPod cluster associated with the event.

" - }, - "InstanceGroupName":{ - "shape":"ClusterInstanceGroupName", - "documentation":"

The name of the instance group associated with the event, if applicable.

" - }, - "InstanceId":{ - "shape":"String", - "documentation":"

The Amazon Elastic Compute Cloud (EC2) instance ID associated with the event, if applicable.

" - }, - "ResourceType":{ - "shape":"ClusterEventResourceType", - "documentation":"

The type of resource associated with the event. Valid values are Cluster, InstanceGroup, or Instance.

" - }, - "EventTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the event occurred.

" - }, - "Description":{ - "shape":"String", - "documentation":"

A brief, human-readable description of the event.

" - }, - "EventLevel":{ - "shape":"ClusterEventLevel", - "documentation":"

The severity level of the event. Valid values are Info, Warn, and Error.

" - } - }, - "documentation":"

A summary of an event in a HyperPod cluster.

" - }, - "ClusterFSxLustreDeletionPolicy":{ - "type":"string", - "documentation":"

The deletion policy for the Amazon FSx for Lustre file system used in the shared environment of restricted instance groups (RIG).

", - "enum":[ - "DeleteIfNotUsed", - "Keep" - ] - }, - "ClusterFsxLustreConfig":{ - "type":"structure", - "required":[ - "DnsName", - "MountName" - ], - "members":{ - "DnsName":{ - "shape":"ClusterDnsName", - "documentation":"

The DNS name of the Amazon FSx for Lustre file system.

" - }, - "MountName":{ - "shape":"ClusterMountName", - "documentation":"

The mount name of the Amazon FSx for Lustre file system.

" - }, - "MountPath":{ - "shape":"ClusterFsxMountPath", - "documentation":"

The local path where the Amazon FSx for Lustre file system is mounted on instances.

" - } - }, - "documentation":"

Defines the configuration for attaching an Amazon FSx for Lustre file system to instances in a SageMaker HyperPod cluster instance group.

" - }, - "ClusterFsxMountPath":{ - "type":"string", - "max":1024, - "min":1, - "pattern":"/[a-zA-Z0-9._/-]+" - }, - "ClusterFsxOpenZfsConfig":{ - "type":"structure", - "required":["DnsName"], - "members":{ - "DnsName":{ - "shape":"ClusterDnsName", - "documentation":"

The DNS name of the Amazon FSx for OpenZFS file system.

" - }, - "MountPath":{ - "shape":"ClusterFsxMountPath", - "documentation":"

The local path where the Amazon FSx for OpenZFS file system is mounted on instances.

" - } - }, - "documentation":"

Defines the configuration for attaching an Amazon FSx for OpenZFS file system to instances in a SageMaker HyperPod cluster instance group.

" - }, - "ClusterImageVersionStatus":{ - "type":"string", - "documentation":"

The status of the Amazon Machine Image (AMI) version for the HyperPod cluster instance group, node, or cluster. The AMI version is determined at the instance group level, and all nodes within an instance group run the same AMI. The cluster-level status is aggregated across all instance groups.

  • UpToDate: The resource is running the latest available AMI version.

  • UpdateAvailable: A newer AMI version is available for the resource.

  • SecurityUpdateRequired: The current AMI has known security vulnerabilities, and a patched version is available.

  • EndOfLife: The AMI variant has reached end of support and an upgrade is required.

", - "enum":[ - "UpToDate", - "UpdateAvailable", - "SecurityUpdateRequired", - "EndOfLife" - ] - }, - "ClusterInstanceCount":{ - "type":"integer", - "box":true, - "max":6758, - "min":0 - }, - "ClusterInstanceGroupDetails":{ - "type":"structure", - "members":{ - "CurrentCount":{ - "shape":"ClusterNonNegativeInstanceCount", - "documentation":"

The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.

" - }, - "TargetCount":{ - "shape":"ClusterInstanceCount", - "documentation":"

The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.

" - }, - "MinCount":{ - "shape":"ClusterInstanceCount", - "documentation":"

The minimum number of instances that must be available in the instance group of a SageMaker HyperPod cluster before it transitions to InService status.

" - }, - "InstanceGroupName":{ - "shape":"ClusterInstanceGroupName", - "documentation":"

The name of the instance group of a SageMaker HyperPod cluster.

" - }, - "InstanceType":{ - "shape":"ClusterInstanceType", - "documentation":"

The instance type of the instance group of a SageMaker HyperPod cluster.

" - }, - "InstanceRequirements":{ - "shape":"ClusterInstanceRequirementDetails", - "documentation":"

The instance requirements for the instance group, including the current and desired instance types. This field is present for flexible instance groups that support multiple instance types.

" - }, - "InstanceTypeDetails":{ - "shape":"ClusterInstanceTypeDetails", - "documentation":"

Details about the instance types in the instance group, including the count and configuration of each instance type. This field is present for flexible instance groups that support multiple instance types.

" - }, - "LifeCycleConfig":{ - "shape":"ClusterLifeCycleConfig", - "documentation":"

Details of LifeCycle configuration for the instance group.

" - }, - "ExecutionRole":{ - "shape":"RoleArn", - "documentation":"

The execution role for the instance group to assume.

" - }, - "ThreadsPerCore":{ - "shape":"ClusterThreadsPerCore", - "documentation":"

The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.

" - }, - "InstanceStorageConfigs":{ - "shape":"ClusterInstanceStorageConfigs", - "documentation":"

The additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.

" - }, - "OnStartDeepHealthChecks":{ - "shape":"OnStartDeepHealthChecks", - "documentation":"

A flag indicating whether deep health checks should be performed when the cluster instance group is created or updated.

" - }, - "Status":{ - "shape":"InstanceGroupStatus", - "documentation":"

The current status of the cluster instance group.

  • InService: The instance group is active and healthy.

  • Creating: The instance group is being provisioned.

  • Updating: The instance group is being updated.

  • Failed: The instance group has failed to provision or is no longer healthy.

  • Degraded: The instance group is degraded, meaning that some instances have failed to provision or are no longer healthy.

  • Deleting: The instance group is being deleted.

" - }, - "TrainingPlanArn":{ - "shape":"TrainingPlanArn", - "documentation":"

The Amazon Resource Name (ARN); of the training plan associated with this cluster instance group.

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

" - }, - "TrainingPlanStatus":{ - "shape":"InstanceGroupTrainingPlanStatus", - "documentation":"

The current status of the training plan associated with this cluster instance group.

" - }, - "OverrideVpcConfig":{ - "shape":"VpcConfig", - "documentation":"

The customized Amazon VPC configuration at the instance group level that overrides the default Amazon VPC configuration of the SageMaker HyperPod cluster.

" - }, - "ScheduledUpdateConfig":{ - "shape":"ScheduledUpdateConfig", - "documentation":"

The configuration object of the schedule that SageMaker follows when updating the AMI.

" - }, - "AutoPatchConfig":{ - "shape":"ClusterAutoPatchConfigDetails", - "documentation":"

The auto-patching configuration for the instance group, including the current patching strategy and next scheduled patch date.

" - }, - "CurrentImageId":{ - "shape":"ImageId", - "documentation":"

The ID of the Amazon Machine Image (AMI) currently in use by the instance group.

" - }, - "DesiredImageId":{ - "shape":"ImageId", - "documentation":"

The ID of the Amazon Machine Image (AMI) desired for the instance group.

" - }, - "CurrentImageReleaseVersion":{ - "shape":"ImageReleaseVersion", - "documentation":"

The version of the HyperPod-managed AMI currently running on the instance group.

" - }, - "DesiredImageReleaseVersion":{ - "shape":"ImageReleaseVersion", - "documentation":"

The desired version of the HyperPod-managed AMI for the instance group. This may differ from the current version when an update is pending.

" - }, - "ImageVersionStatus":{ - "shape":"ClusterImageVersionStatus", - "documentation":"

The status of the image version for the instance group. Indicates whether the instance group is running the latest image version or if an update is available.

" - }, - "ActiveOperations":{ - "shape":"ActiveOperations", - "documentation":"

A map indicating active operations currently in progress for the instance group of a SageMaker HyperPod cluster. When there is a scaling operation in progress, this map contains a key Scaling with value 1.

" - }, - "KubernetesConfig":{ - "shape":"ClusterKubernetesConfigDetails", - "documentation":"

The Kubernetes configuration for the instance group that contains labels and taints to be applied for the nodes in this instance group.

" - }, - "CapacityRequirements":{ - "shape":"ClusterCapacityRequirements", - "documentation":"

The instance capacity requirements for the instance group.

" - }, - "TargetStateCount":{ - "shape":"ClusterInstanceCount", - "documentation":"

Represents the number of running nodes using the desired Image ID.

  1. During software update operations: This count shows the number of nodes running on the desired Image ID. If a rollback occurs, the current image ID and desired image ID (both included in the describe cluster response) swap values. The TargetStateCount then shows the number of nodes running on the newly designated desired image ID (which was previously the current image ID).

  2. During simultaneous scaling and software update operations: This count shows the number of instances running on the desired image ID, including any new instances created as part of the scaling request. New nodes are always created using the desired image ID, so TargetStateCount reflects the total count of nodes running on the desired image ID, even during rollback scenarios.

" - }, - "SoftwareUpdateStatus":{ - "shape":"SoftwareUpdateStatus", - "documentation":"

Status of the last software udpate request.

Status transitions follow these possible sequences:

  • Pending -> InProgress -> Succeeded

  • Pending -> InProgress -> RollbackInProgress -> RollbackComplete

  • Pending -> InProgress -> RollbackInProgress -> Failed

" - }, - "ActiveSoftwareUpdateConfig":{"shape":"DeploymentConfiguration"}, - "SlurmConfig":{ - "shape":"ClusterSlurmConfigDetails", - "documentation":"

The Slurm configuration for the instance group.

" - }, - "NetworkInterface":{ - "shape":"ClusterNetworkInterfaceDetails", - "documentation":"

The network interface configuration for the instance group.

" - } - }, - "documentation":"

Details of an instance group in a SageMaker HyperPod cluster.

" - }, - "ClusterInstanceGroupDetailsList":{ - "type":"list", - "member":{"shape":"ClusterInstanceGroupDetails"} - }, - "ClusterInstanceGroupName":{ - "type":"string", - "max":63, - "min":1, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9])*" - }, - "ClusterInstanceGroupSpecification":{ - "type":"structure", - "required":[ - "InstanceCount", - "InstanceGroupName", - "ExecutionRole" - ], - "members":{ - "InstanceCount":{ - "shape":"ClusterInstanceCount", - "documentation":"

Specifies the number of instances to add to the instance group of a SageMaker HyperPod cluster.

" - }, - "MinInstanceCount":{ - "shape":"ClusterInstanceCount", - "documentation":"

Defines the minimum number of instances required for an instance group to become InService. If this threshold isn't met within 3 hours, the instance group rolls back to its previous state - zero instances for new instance groups, or previous settings for existing instance groups. MinInstanceCount only affects the initial transition to InService and does not guarantee maintaining this minimum afterward.

" - }, - "InstanceGroupName":{ - "shape":"ClusterInstanceGroupName", - "documentation":"

Specifies the name of the instance group.

" - }, - "InstanceType":{ - "shape":"ClusterInstanceType", - "documentation":"

Specifies the instance type of the instance group.

" - }, - "InstanceRequirements":{ - "shape":"ClusterInstanceRequirements", - "documentation":"

The instance requirements for the instance group, including the instance types to use. Use this to create a flexible instance group that supports multiple instance types. The InstanceType and InstanceRequirements properties are mutually exclusive.

" - }, - "LifeCycleConfig":{ - "shape":"ClusterLifeCycleConfig", - "documentation":"

Specifies the LifeCycle configuration for the instance group.

" - }, - "ExecutionRole":{ - "shape":"RoleArn", - "documentation":"

Specifies an IAM execution role to be assumed by the instance group.

" - }, - "ThreadsPerCore":{ - "shape":"ClusterThreadsPerCore", - "documentation":"

Specifies the value for Threads per core. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For instance types that doesn't support multithreading, specify 1. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.

" - }, - "InstanceStorageConfigs":{ - "shape":"ClusterInstanceStorageConfigs", - "documentation":"

Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.

" - }, - "OnStartDeepHealthChecks":{ - "shape":"OnStartDeepHealthChecks", - "documentation":"

A flag indicating whether deep health checks should be performed when the cluster instance group is created or updated.

" - }, - "TrainingPlanArn":{ - "shape":"TrainingPlanArn", - "documentation":"

The Amazon Resource Name (ARN); of the training plan to use for this cluster instance group.

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

" - }, - "OverrideVpcConfig":{ - "shape":"VpcConfig", - "documentation":"

To configure multi-AZ deployments, customize the Amazon VPC configuration at the instance group level. You can specify different subnets and security groups across different AZs in the instance group specification to override a SageMaker HyperPod cluster's default Amazon VPC configuration. For more information about deploying a cluster in multiple AZs, see Setting up SageMaker HyperPod clusters across multiple AZs.

When your Amazon VPC and subnets support IPv6, network communications differ based on the cluster orchestration platform:

  • Slurm-orchestrated clusters automatically configure nodes with dual IPv6 and IPv4 addresses, allowing immediate IPv6 network communications.

  • In Amazon EKS-orchestrated clusters, nodes receive dual-stack addressing, but pods can only use IPv6 when the Amazon EKS cluster is explicitly IPv6-enabled. For information about deploying an IPv6 Amazon EKS cluster, see Amazon EKS IPv6 Cluster Deployment.

Additional resources for IPv6 configuration:

" - }, - "ScheduledUpdateConfig":{ - "shape":"ScheduledUpdateConfig", - "documentation":"

The configuration object of the schedule that SageMaker uses to update the AMI.

" - }, - "ImageId":{ - "shape":"ImageId", - "documentation":"

When configuring your HyperPod cluster, you can specify an image ID using one of the following options:

  • HyperPodPublicAmiId: Use a HyperPod public AMI

  • CustomAmiId: Use your custom AMI

  • default: Use the default latest system image. For clusters with continuous scaling node provisioning mode, new instance groups inherit the AMI from the earliest existing instance group

If you choose to use a custom AMI (CustomAmiId), ensure it meets the following requirements:

  • Encryption: The custom AMI must be unencrypted.

  • Ownership: The custom AMI must be owned by the same Amazon Web Services account that is creating the HyperPod cluster.

  • Volume support: Only the primary AMI snapshot volume is supported; additional AMI volumes are not supported.

When updating the instance group's AMI through the UpdateClusterSoftware operation, if an instance group uses a custom AMI, you must provide an ImageId or use the default as input. Note that if you don't specify an instance group in your UpdateClusterSoftware request, then all of the instance groups are patched with the specified image.

" - }, - "AutoPatchConfig":{ - "shape":"ClusterAutoPatchConfig", - "documentation":"

The configuration for automatic OS security patching. If present, the system automatically applies PATCH AMI updates to this instance group.

" - }, - "ImageReleaseVersion":{ - "shape":"ImageReleaseVersion", - "documentation":"

The version of the HyperPod-managed AMI to use for the instance group. Uses semantic versioning in the format MAJOR.MINOR.PATCH (for example, 1.2.3). If omitted, the latest available version is used.

" - }, - "KubernetesConfig":{ - "shape":"ClusterKubernetesConfig", - "documentation":"

Specifies the Kubernetes configuration for the instance group. You describe what you want the labels and taints to look like, and the cluster works to reconcile the actual state with the declared state for nodes in this instance group.

" - }, - "SlurmConfig":{ - "shape":"ClusterSlurmConfig", - "documentation":"

Specifies the Slurm configuration for the instance group.

" - }, - "CapacityRequirements":{ - "shape":"ClusterCapacityRequirements", - "documentation":"

Specifies the capacity requirements for the instance group.

" - }, - "NetworkInterface":{ - "shape":"ClusterNetworkInterface", - "documentation":"

The network interface configuration for the instance group.

" - } - }, - "documentation":"

The specifications of an instance group that you need to define.

" - }, - "ClusterInstanceGroupSpecifications":{ - "type":"list", - "member":{"shape":"ClusterInstanceGroupSpecification"}, - "max":100, - "min":1 - }, - "ClusterInstanceGroupsToDelete":{ - "type":"list", - "member":{"shape":"ClusterInstanceGroupName"}, - "max":100, - "min":0 - }, - "ClusterInstanceMemoryAllocationPercentage":{ - "type":"integer", - "box":true, - "max":100, - "min":0 - }, - "ClusterInstancePlacement":{ - "type":"structure", - "members":{ - "AvailabilityZone":{ - "shape":"ClusterAvailabilityZone", - "documentation":"

The Availability Zone where the node in the SageMaker HyperPod cluster is launched.

" - }, - "AvailabilityZoneId":{ - "shape":"ClusterAvailabilityZoneId", - "documentation":"

The unique identifier (ID) of the Availability Zone where the node in the SageMaker HyperPod cluster is launched.

" - } - }, - "documentation":"

Specifies the placement details for the node in the SageMaker HyperPod cluster, including the Availability Zone and the unique identifier (ID) of the Availability Zone.

" - }, - "ClusterInstanceRequirementDetails":{ - "type":"structure", - "members":{ - "CurrentInstanceTypes":{ - "shape":"ClusterInstanceTypes", - "documentation":"

The instance types currently in use by the instance group.

" - }, - "DesiredInstanceTypes":{ - "shape":"ClusterInstanceTypes", - "documentation":"

The desired instance types for the instance group, as specified in the most recent update request.

" - } - }, - "documentation":"

The instance requirement details for a flexible instance group, including the current and desired instance types.

" - }, - "ClusterInstanceRequirements":{ - "type":"structure", - "required":["InstanceTypes"], - "members":{ - "InstanceTypes":{ - "shape":"ClusterInstanceTypes", - "documentation":"

The list of instance types that the instance group can use. The order of instance types determines the priority—HyperPod attempts to provision instances using the first instance type in the list and falls back to subsequent types if capacity is unavailable.

" - } - }, - "documentation":"

The instance requirements for a flexible instance group. Use this to specify multiple instance types that the instance group can use. The order of instance types in the list determines the priority for instance provisioning.

" - }, - "ClusterInstanceStatus":{ - "type":"string", - "enum":[ - "Running", - "Failure", - "Pending", - "ShuttingDown", - "SystemUpdating", - "DeepHealthCheckInProgress", - "NotFound" - ] - }, - "ClusterInstanceStatusDetails":{ - "type":"structure", - "required":["Status"], - "members":{ - "Status":{ - "shape":"ClusterInstanceStatus", - "documentation":"

The status of an instance in a SageMaker HyperPod cluster.

" - }, - "Message":{ - "shape":"String", - "documentation":"

The message from an instance in a SageMaker HyperPod cluster.

" - } - }, - "documentation":"

Details of an instance in a SageMaker HyperPod cluster.

" - }, - "ClusterInstanceStorageConfig":{ - "type":"structure", - "members":{ - "EbsVolumeConfig":{ - "shape":"ClusterEbsVolumeConfig", - "documentation":"

Defines the configuration for attaching additional Amazon Elastic Block Store (EBS) volumes to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each instance within the SageMaker HyperPod cluster instance group and mounted to /opt/sagemaker.

" - }, - "FsxLustreConfig":{ - "shape":"ClusterFsxLustreConfig", - "documentation":"

Defines the configuration for attaching an Amazon FSx for Lustre file system to the instances in the SageMaker HyperPod cluster instance group.

" - }, - "FsxOpenZfsConfig":{ - "shape":"ClusterFsxOpenZfsConfig", - "documentation":"

Defines the configuration for attaching an Amazon FSx for OpenZFS file system to the instances in the SageMaker HyperPod cluster instance group.

" - } - }, - "documentation":"

Defines the configuration for attaching additional storage to the instances in the SageMaker HyperPod cluster instance group. To learn more, see SageMaker HyperPod release notes: June 20, 2024.

", - "union":true - }, - "ClusterInstanceStorageConfigs":{ - "type":"list", - "member":{"shape":"ClusterInstanceStorageConfig"}, - "max":4, - "min":0 - }, - "ClusterInstanceType":{ - "type":"string", - "enum":[ - "ml.p4d.24xlarge", - "ml.p4de.24xlarge", - "ml.p5.48xlarge", - "ml.p5.4xlarge", - "ml.p6e-gb200.36xlarge", - "ml.trn1.32xlarge", - "ml.trn1n.32xlarge", - "ml.g5.xlarge", - "ml.g5.2xlarge", - "ml.g5.4xlarge", - "ml.g5.8xlarge", - "ml.g5.12xlarge", - "ml.g5.16xlarge", - "ml.g5.24xlarge", - "ml.g5.48xlarge", - "ml.c5.large", - "ml.c5.xlarge", - "ml.c5.2xlarge", - "ml.c5.4xlarge", - "ml.c5.9xlarge", - "ml.c5.12xlarge", - "ml.c5.18xlarge", - "ml.c5.24xlarge", - "ml.c5n.large", - "ml.c5n.2xlarge", - "ml.c5n.4xlarge", - "ml.c5n.9xlarge", - "ml.c5n.18xlarge", - "ml.m5.large", - "ml.m5.xlarge", - "ml.m5.2xlarge", - "ml.m5.4xlarge", - "ml.m5.8xlarge", - "ml.m5.12xlarge", - "ml.m5.16xlarge", - "ml.m5.24xlarge", - "ml.t3.medium", - "ml.t3.large", - "ml.t3.xlarge", - "ml.t3.2xlarge", - "ml.g6.xlarge", - "ml.g6.2xlarge", - "ml.g6.4xlarge", - "ml.g6.8xlarge", - "ml.g6.16xlarge", - "ml.g6.12xlarge", - "ml.g6.24xlarge", - "ml.g6.48xlarge", - "ml.gr6.4xlarge", - "ml.gr6.8xlarge", - "ml.g6e.xlarge", - "ml.g6e.2xlarge", - "ml.g6e.4xlarge", - "ml.g6e.8xlarge", - "ml.g6e.16xlarge", - "ml.g6e.12xlarge", - "ml.g6e.24xlarge", - "ml.g6e.48xlarge", - "ml.p5e.48xlarge", - "ml.p5en.48xlarge", - "ml.p6-b200.48xlarge", - "ml.trn2.3xlarge", - "ml.trn2.48xlarge", - "ml.c6i.large", - "ml.c6i.xlarge", - "ml.c6i.2xlarge", - "ml.c6i.4xlarge", - "ml.c6i.8xlarge", - "ml.c6i.12xlarge", - "ml.c6i.16xlarge", - "ml.c6i.24xlarge", - "ml.c6i.32xlarge", - "ml.m6i.large", - "ml.m6i.xlarge", - "ml.m6i.2xlarge", - "ml.m6i.4xlarge", - "ml.m6i.8xlarge", - "ml.m6i.12xlarge", - "ml.m6i.16xlarge", - "ml.m6i.24xlarge", - "ml.m6i.32xlarge", - "ml.r6i.large", - "ml.r6i.xlarge", - "ml.r6i.2xlarge", - "ml.r6i.4xlarge", - "ml.r6i.8xlarge", - "ml.r6i.12xlarge", - "ml.r6i.16xlarge", - "ml.r6i.24xlarge", - "ml.r6i.32xlarge", - "ml.i3en.large", - "ml.i3en.xlarge", - "ml.i3en.2xlarge", - "ml.i3en.3xlarge", - "ml.i3en.6xlarge", - "ml.i3en.12xlarge", - "ml.i3en.24xlarge", - "ml.m7i.large", - "ml.m7i.xlarge", - "ml.m7i.2xlarge", - "ml.m7i.4xlarge", - "ml.m7i.8xlarge", - "ml.m7i.12xlarge", - "ml.m7i.16xlarge", - "ml.m7i.24xlarge", - "ml.m7i.48xlarge", - "ml.r7i.large", - "ml.r7i.xlarge", - "ml.r7i.2xlarge", - "ml.r7i.4xlarge", - "ml.r7i.8xlarge", - "ml.r7i.12xlarge", - "ml.r7i.16xlarge", - "ml.r7i.24xlarge", - "ml.r7i.48xlarge", - "ml.r5d.16xlarge", - "ml.g7e.2xlarge", - "ml.g7e.4xlarge", - "ml.g7e.8xlarge", - "ml.g7e.12xlarge", - "ml.g7e.24xlarge", - "ml.g7e.48xlarge", - "ml.p6-b300.48xlarge", - "ml.g4dn.xlarge", - "ml.g4dn.2xlarge", - "ml.g4dn.4xlarge", - "ml.g4dn.8xlarge", - "ml.g4dn.12xlarge", - "ml.g4dn.16xlarge", - "ml.c6g.medium", - "ml.c6g.large", - "ml.c6g.xlarge", - "ml.c6g.2xlarge", - "ml.c6g.4xlarge", - "ml.c6g.8xlarge", - "ml.c6g.12xlarge", - "ml.c6g.16xlarge", - "ml.c7g.medium", - "ml.c7g.large", - "ml.c7g.xlarge", - "ml.c7g.2xlarge", - "ml.c7g.4xlarge", - "ml.c7g.8xlarge", - "ml.c7g.12xlarge", - "ml.c7g.16xlarge", - "ml.c8g.medium", - "ml.c8g.large", - "ml.c8g.xlarge", - "ml.c8g.2xlarge", - "ml.c8g.4xlarge", - "ml.c8g.8xlarge", - "ml.c8g.12xlarge", - "ml.c8g.16xlarge", - "ml.c8g.24xlarge", - "ml.c8g.48xlarge", - "ml.c6a.large", - "ml.c6a.xlarge", - "ml.c6a.2xlarge", - "ml.c6a.4xlarge", - "ml.c6a.8xlarge", - "ml.c6a.12xlarge", - "ml.c6a.16xlarge", - "ml.c6a.24xlarge", - "ml.c6a.32xlarge", - "ml.c6a.48xlarge", - "ml.m6a.large", - "ml.m6a.xlarge", - "ml.m6a.2xlarge", - "ml.m6a.4xlarge", - "ml.m6a.8xlarge", - "ml.m6a.12xlarge", - "ml.m6a.16xlarge", - "ml.m6a.24xlarge", - "ml.m6a.32xlarge", - "ml.m6a.48xlarge", - "ml.m6g.medium", - "ml.m6g.large", - "ml.m6g.xlarge", - "ml.m6g.2xlarge", - "ml.m6g.4xlarge", - "ml.m6g.8xlarge", - "ml.m6g.12xlarge", - "ml.m6g.16xlarge", - "ml.m7g.medium", - "ml.m7g.large", - "ml.m7g.xlarge", - "ml.m7g.2xlarge", - "ml.m7g.4xlarge", - "ml.m7g.8xlarge", - "ml.m7g.12xlarge", - "ml.m7g.16xlarge", - "ml.m8g.medium", - "ml.m8g.large", - "ml.m8g.xlarge", - "ml.m8g.2xlarge", - "ml.m8g.4xlarge", - "ml.m8g.8xlarge", - "ml.m8g.12xlarge", - "ml.m8g.16xlarge", - "ml.m8g.24xlarge", - "ml.m8g.48xlarge" - ] - }, - "ClusterInstanceTypeDetail":{ - "type":"structure", - "members":{ - "InstanceType":{ - "shape":"ClusterInstanceType", - "documentation":"

The instance type.

" - }, - "CurrentCount":{ - "shape":"ClusterNonNegativeInstanceCount", - "documentation":"

The number of instances of this type currently running in the instance group.

" - }, - "ThreadsPerCore":{ - "shape":"ClusterThreadsPerCore", - "documentation":"

The number of threads per CPU core for this instance type.

" - } - }, - "documentation":"

Details about a specific instance type within a flexible instance group, including the count and configuration.

" - }, - "ClusterInstanceTypeDetails":{ - "type":"list", - "member":{"shape":"ClusterInstanceTypeDetail"}, - "max":20, - "min":0 - }, - "ClusterInstanceTypes":{ - "type":"list", - "member":{"shape":"ClusterInstanceType"}, - "max":20, - "min":1 - }, - "ClusterInterfaceType":{ - "type":"string", - "enum":[ - "efa", - "efa-only" - ] - }, - "ClusterKubernetesConfig":{ - "type":"structure", - "members":{ - "Labels":{ - "shape":"ClusterKubernetesLabels", - "documentation":"

Key-value pairs of labels to be applied to cluster nodes.

" - }, - "Taints":{ - "shape":"ClusterKubernetesTaints", - "documentation":"

List of taints to be applied to cluster nodes.

" - } - }, - "documentation":"

Kubernetes configuration that specifies labels and taints to be applied to cluster nodes in an instance group.

" - }, - "ClusterKubernetesConfigDetails":{ - "type":"structure", - "members":{ - "CurrentLabels":{ - "shape":"ClusterKubernetesLabels", - "documentation":"

The current labels applied to cluster nodes of an instance group.

" - }, - "DesiredLabels":{ - "shape":"ClusterKubernetesLabels", - "documentation":"

The desired labels to be applied to cluster nodes of an instance group.

" - }, - "CurrentTaints":{ - "shape":"ClusterKubernetesTaints", - "documentation":"

The current taints applied to cluster nodes of an instance group.

" - }, - "DesiredTaints":{ - "shape":"ClusterKubernetesTaints", - "documentation":"

The desired taints to be applied to cluster nodes of an instance group.

" - } - }, - "documentation":"

Detailed Kubernetes configuration showing both the current and desired state of labels and taints for cluster nodes.

" - }, - "ClusterKubernetesConfigNodeDetails":{ - "type":"structure", - "members":{ - "CurrentLabels":{ - "shape":"ClusterKubernetesLabels", - "documentation":"

The current labels applied to the cluster node.

" - }, - "DesiredLabels":{ - "shape":"ClusterKubernetesLabels", - "documentation":"

The desired labels to be applied to the cluster node.

" - }, - "CurrentTaints":{ - "shape":"ClusterKubernetesTaints", - "documentation":"

The current taints applied to the cluster node.

" - }, - "DesiredTaints":{ - "shape":"ClusterKubernetesTaints", - "documentation":"

The desired taints to be applied to the cluster node.

" - } - }, - "documentation":"

Node-specific Kubernetes configuration showing both current and desired state of labels and taints for an individual cluster node.

" - }, - "ClusterKubernetesLabelKey":{ - "type":"string", - "max":317, - "min":1, - "pattern":"([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?[A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?" - }, - "ClusterKubernetesLabelValue":{ - "type":"string", - "max":63, - "min":1, - "pattern":"(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?" - }, - "ClusterKubernetesLabels":{ - "type":"map", - "key":{"shape":"ClusterKubernetesLabelKey"}, - "value":{"shape":"ClusterKubernetesLabelValue"}, - "max":50, - "min":0 - }, - "ClusterKubernetesTaint":{ - "type":"structure", - "required":[ - "Key", - "Effect" - ], - "members":{ - "Key":{ - "shape":"ClusterKubernetesTaintKey", - "documentation":"

The key of the taint.

" - }, - "Value":{ - "shape":"ClusterKubernetesTaintValue", - "documentation":"

The value of the taint.

" - }, - "Effect":{ - "shape":"ClusterKubernetesTaintEffect", - "documentation":"

The effect of the taint. Valid values are NoSchedule, PreferNoSchedule, and NoExecute.

" - } - }, - "documentation":"

A Kubernetes taint that can be applied to cluster nodes.

" - }, - "ClusterKubernetesTaintEffect":{ - "type":"string", - "enum":[ - "NoSchedule", - "PreferNoSchedule", - "NoExecute" - ] - }, - "ClusterKubernetesTaintKey":{ - "type":"string", - "max":317, - "min":1, - "pattern":"([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?[A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?" - }, - "ClusterKubernetesTaintValue":{ - "type":"string", - "max":63, - "min":1, - "pattern":"(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?" - }, - "ClusterKubernetesTaints":{ - "type":"list", - "member":{"shape":"ClusterKubernetesTaint"}, - "max":50, - "min":0 - }, - "ClusterLifeCycleConfig":{ - "type":"structure", - "members":{ - "SourceS3Uri":{ - "shape":"S3Uri", - "documentation":"

An Amazon S3 bucket path where your lifecycle scripts are stored.

Make sure that the S3 bucket path starts with s3://sagemaker-. The IAM role for SageMaker HyperPod has the managed AmazonSageMakerClusterInstanceRolePolicy attached, which allows access to S3 buckets with the specific prefix sagemaker-.

" - }, - "OnCreate":{ - "shape":"ClusterLifeCycleConfigFileName", - "documentation":"

The file name of the entrypoint script of lifecycle scripts under SourceS3Uri. This entrypoint script runs during cluster creation.

" - }, - "OnInitComplete":{ - "shape":"ClusterLifeCycleConfigFileName", - "documentation":"

The file name of the entrypoint script of lifecycle scripts under SourceS3Uri. This script runs on the node after the AMI-based initialization is complete.

" - } - }, - "documentation":"

The lifecycle configuration for a SageMaker HyperPod cluster.

" - }, - "ClusterLifeCycleConfigFileName":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[\\S\\s]+" - }, - "ClusterMetadata":{ - "type":"structure", - "members":{ - "FailureMessage":{ - "shape":"String", - "documentation":"

An error message describing why the cluster level operation (such as creating, updating, or deleting) failed.

" - }, - "EksRoleAccessEntries":{ - "shape":"EksRoleAccessEntries", - "documentation":"

A list of Amazon EKS IAM role ARNs associated with the cluster. This is created by HyperPod on your behalf and only applies for EKS orchestrated clusters.

" - }, - "SlrAccessEntry":{ - "shape":"String", - "documentation":"

The Service-Linked Role (SLR) associated with the cluster. This is created by HyperPod on your behalf and only applies for EKS orchestrated clusters.

" - } - }, - "documentation":"

Metadata information about a HyperPod cluster showing information about the cluster level operations, such as creating, updating, and deleting.

" - }, - "ClusterMountName":{ - "type":"string", - "max":8, - "min":1, - "pattern":"([A-Za-z0-9_-]{1,8})" - }, - "ClusterName":{ - "type":"string", - "max":63, - "min":1, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9])*" - }, - "ClusterNameOrArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:cluster/[a-z0-9]{12})|([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62})" - }, - "ClusterNetworkInterface":{ - "type":"structure", - "members":{ - "InterfaceType":{ - "shape":"ClusterInterfaceType", - "documentation":"

The type of network interface for the instance group. Valid values:

  • efa – An EFA with ENA interface, which provides both the EFA device for low-latency, high-throughput communication and the ENA device for IP networking.

  • efa-only – An EFA-only interface, which provides only the EFA device capabilities without the ENA device for traditional IP networking.

For more information, see Elastic Fabric Adapter.

" - } - }, - "documentation":"

The network interface configuration for a Amazon SageMaker HyperPod cluster instance group.

" - }, - "ClusterNetworkInterfaceDetails":{ - "type":"structure", - "members":{ - "InterfaceType":{ - "shape":"ClusterInterfaceType", - "documentation":"

The type of network interface for the instance group. Valid values are efa and efa-only.

" - } - }, - "documentation":"

The network interface configuration details for a Amazon SageMaker HyperPod cluster instance group.

" - }, - "ClusterNodeDetails":{ - "type":"structure", - "members":{ - "InstanceGroupName":{ - "shape":"ClusterInstanceGroupName", - "documentation":"

The instance group name in which the instance is.

" - }, - "InstanceId":{ - "shape":"String", - "documentation":"

The ID of the instance.

" - }, - "NodeLogicalId":{ - "shape":"ClusterNodeLogicalId", - "documentation":"

A unique identifier for the node that persists throughout its lifecycle, from provisioning request to termination. This identifier can be used to track the node even before it has an assigned InstanceId.

" - }, - "InstanceStatus":{ - "shape":"ClusterInstanceStatusDetails", - "documentation":"

The status of the instance.

" - }, - "InstanceType":{ - "shape":"ClusterInstanceType", - "documentation":"

The type of the instance.

" - }, - "LaunchTime":{ - "shape":"Timestamp", - "documentation":"

The time when the instance is launched.

" - }, - "LastSoftwareUpdateTime":{ - "shape":"Timestamp", - "documentation":"

The time when the cluster was last updated.

" - }, - "LifeCycleConfig":{ - "shape":"ClusterLifeCycleConfig", - "documentation":"

The LifeCycle configuration applied to the instance.

" - }, - "OverrideVpcConfig":{ - "shape":"VpcConfig", - "documentation":"

The customized Amazon VPC configuration at the instance group level that overrides the default Amazon VPC configuration of the SageMaker HyperPod cluster.

" - }, - "ThreadsPerCore":{ - "shape":"ClusterThreadsPerCore", - "documentation":"

The number of threads per CPU core you specified under CreateCluster.

" - }, - "InstanceStorageConfigs":{ - "shape":"ClusterInstanceStorageConfigs", - "documentation":"

The configurations of additional storage specified to the instance group where the instance (node) is launched.

" - }, - "PrivatePrimaryIp":{ - "shape":"ClusterPrivatePrimaryIp", - "documentation":"

The private primary IP address of the SageMaker HyperPod cluster node.

" - }, - "PrivatePrimaryIpv6":{ - "shape":"ClusterPrivatePrimaryIpv6", - "documentation":"

The private primary IPv6 address of the SageMaker HyperPod cluster node when configured with an Amazon VPC that supports IPv6 and includes subnets with IPv6 addressing enabled in either the cluster Amazon VPC configuration or the instance group Amazon VPC configuration.

" - }, - "PrivateDnsHostname":{ - "shape":"ClusterPrivateDnsHostname", - "documentation":"

The private DNS hostname of the SageMaker HyperPod cluster node.

" - }, - "Placement":{ - "shape":"ClusterInstancePlacement", - "documentation":"

The placement details of the SageMaker HyperPod cluster node.

" - }, - "CurrentImageId":{ - "shape":"ImageId", - "documentation":"

The ID of the Amazon Machine Image (AMI) currently in use by the node.

" - }, - "DesiredImageId":{ - "shape":"ImageId", - "documentation":"

The ID of the Amazon Machine Image (AMI) desired for the node.

" - }, - "CurrentImageReleaseVersion":{ - "shape":"ImageReleaseVersion", - "documentation":"

The version of the HyperPod-managed AMI currently running on the node.

" - }, - "DesiredImageReleaseVersion":{ - "shape":"ImageReleaseVersion", - "documentation":"

The desired version of the HyperPod-managed AMI for the node. This may differ from the current version when an update is pending.

" - }, - "ImageVersionStatus":{ - "shape":"ClusterImageVersionStatus", - "documentation":"

The status of the image version for the cluster node.

" - }, - "UltraServerInfo":{ - "shape":"UltraServerInfo", - "documentation":"

Contains information about the UltraServer.

" - }, - "KubernetesConfig":{ - "shape":"ClusterKubernetesConfigNodeDetails", - "documentation":"

The Kubernetes configuration applied to this node, showing both the current and desired state of labels and taints. The cluster works to reconcile the actual state with the declared state.

" - }, - "CapacityType":{ - "shape":"ClusterCapacityType", - "documentation":"

The capacity type of the node. Valid values are OnDemand and Spot. When set to OnDemand, the node is launched as an On-Demand instance. When set to Spot, the node is launched as a Spot instance.

" - }, - "NetworkInterface":{ - "shape":"ClusterNetworkInterfaceDetails", - "documentation":"

The network interface configuration for the cluster node.

" - } - }, - "documentation":"

Details of an instance (also called a node interchangeably) in a SageMaker HyperPod cluster.

" - }, - "ClusterNodeId":{ - "type":"string", - "max":256, - "min":1, - "pattern":"i-[a-f0-9]{8}(?:[a-f0-9]{9})?" - }, - "ClusterNodeIds":{ - "type":"list", - "member":{"shape":"ClusterNodeId"}, - "max":3000, - "min":1 - }, - "ClusterNodeLogicalId":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9]" - }, - "ClusterNodeLogicalIdList":{ - "type":"list", - "member":{"shape":"ClusterNodeLogicalId"}, - "max":99, - "min":1 - }, - "ClusterNodeProvisioningMode":{ - "type":"string", - "enum":["Continuous"] - }, - "ClusterNodeRecovery":{ - "type":"string", - "enum":[ - "Automatic", - "None" - ] - }, - "ClusterNodeSummaries":{ - "type":"list", - "member":{"shape":"ClusterNodeSummary"} - }, - "ClusterNodeSummary":{ - "type":"structure", - "required":[ - "InstanceGroupName", - "InstanceId", - "InstanceType", - "LaunchTime", - "InstanceStatus" - ], - "members":{ - "InstanceGroupName":{ - "shape":"ClusterInstanceGroupName", - "documentation":"

The name of the instance group in which the instance is.

" - }, - "InstanceId":{ - "shape":"String", - "documentation":"

The ID of the instance.

" - }, - "NodeLogicalId":{ - "shape":"String", - "documentation":"

A unique identifier for the node that persists throughout its lifecycle, from provisioning request to termination. This identifier can be used to track the node even before it has an assigned InstanceId. This field is only included when IncludeNodeLogicalIds is set to True in the ListClusterNodes request.

" - }, - "InstanceType":{ - "shape":"ClusterInstanceType", - "documentation":"

The type of the instance.

" - }, - "LaunchTime":{ - "shape":"Timestamp", - "documentation":"

The time when the instance is launched.

" - }, - "LastSoftwareUpdateTime":{ - "shape":"Timestamp", - "documentation":"

The time when SageMaker last updated the software of the instances in the cluster.

" - }, - "InstanceStatus":{ - "shape":"ClusterInstanceStatusDetails", - "documentation":"

The status of the instance.

" - }, - "UltraServerInfo":{ - "shape":"UltraServerInfo", - "documentation":"

Contains information about the UltraServer.

" - }, - "PrivateDnsHostname":{ - "shape":"ClusterPrivateDnsHostname", - "documentation":"

The private DNS hostname of the SageMaker HyperPod cluster node.

" - }, - "CurrentImageReleaseVersion":{ - "shape":"ImageReleaseVersion", - "documentation":"

The version of the HyperPod-managed AMI currently running on the node.

" - }, - "ImageVersionStatus":{ - "shape":"ClusterImageVersionStatus", - "documentation":"

The status of the image version for the cluster node.

" - } - }, - "documentation":"

Lists a summary of the properties of an instance (also called a node interchangeably) of a SageMaker HyperPod cluster.

" - }, - "ClusterNonNegativeInstanceCount":{ - "type":"integer", - "box":true, - "min":0 - }, - "ClusterOnDemandOptions":{ - "type":"structure", - "members":{}, - "documentation":"

Configuration options specific to On-Demand instances.

" - }, - "ClusterOrchestrator":{ - "type":"structure", - "members":{ - "Eks":{ - "shape":"ClusterOrchestratorEksConfig", - "documentation":"

The Amazon EKS cluster used as the orchestrator for the SageMaker HyperPod cluster.

" - }, - "Slurm":{ - "shape":"ClusterOrchestratorSlurmConfig", - "documentation":"

The Slurm orchestrator configuration for the SageMaker HyperPod cluster.

" - } - }, - "documentation":"

The type of orchestrator used for the SageMaker HyperPod cluster.

" - }, - "ClusterOrchestratorEksConfig":{ - "type":"structure", - "required":["ClusterArn"], - "members":{ - "ClusterArn":{ - "shape":"EksClusterArn", - "documentation":"

The Amazon Resource Name (ARN) of the Amazon EKS cluster associated with the SageMaker HyperPod cluster.

" - } - }, - "documentation":"

The configuration settings for the Amazon EKS cluster used as the orchestrator for the SageMaker HyperPod cluster.

" - }, - "ClusterOrchestratorSlurmConfig":{ - "type":"structure", - "members":{ - "SlurmConfigStrategy":{ - "shape":"ClusterSlurmConfigStrategy", - "documentation":"

The strategy for managing partitions for the Slurm configuration. Valid values are Managed, Overwrite, and Merge.

" - } - }, - "documentation":"

The configuration settings for the Slurm orchestrator used with the SageMaker HyperPod cluster.

" - }, - "ClusterPartitionName":{ - "type":"string", - "max":1024, - "min":0, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9])*" - }, - "ClusterPartitionNames":{ - "type":"list", - "member":{"shape":"ClusterPartitionName"}, - "max":1, - "min":0 - }, - "ClusterPatchSchedule":{ - "type":"structure", - "members":{ - "NextPatchDate":{ - "shape":"Timestamp", - "documentation":"

The date and time of the next scheduled automatic patch. The system sets this automatically when a patch is detected. Use this field to reschedule the patch to a different date.

" - } - }, - "documentation":"

The schedule configuration for automatic patching.

" - }, - "ClusterPatchScheduleDetails":{ - "type":"structure", - "members":{ - "NextPatchDate":{ - "shape":"Timestamp", - "documentation":"

The date and time of the next scheduled automatic patch.

" - } - }, - "documentation":"

The schedule details for automatic patching, including the next scheduled patch date.

" - }, - "ClusterPatchingStrategy":{ - "type":"string", - "documentation":"

The strategy for applying automatic patches to instances.

  • WhenIdle: Cordons all instances and patches each instance as it becomes idle (no running jobs). Each instance is uncordoned immediately after patching and becomes available for new jobs. If instances do not become idle, they remain on the previous AMI version. You can then use UpdateClusterSoftware with the desired ImageReleaseVersion to manually update the remaining instances.

  • WhenAllIdle: Cordons all instances and waits for all to become idle before patching. All instances are uncordoned after patching completes. If not all instances become idle, no patching occurs and all instances remain on the previous AMI version.

", - "enum":[ - "WhenIdle", - "WhenAllIdle" - ] - }, - "ClusterPrivateDnsHostname":{ - "type":"string", - "pattern":"ip-((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)-?\\b){4}\\..*" - }, - "ClusterPrivatePrimaryIp":{ - "type":"string", - "pattern":"((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)\\.?\\b){4}" - }, - "ClusterPrivatePrimaryIpv6":{"type":"string"}, - "ClusterRestrictedInstanceGroupDetails":{ - "type":"structure", - "members":{ - "CurrentCount":{ - "shape":"ClusterNonNegativeInstanceCount", - "documentation":"

The number of instances that are currently in the restricted instance group of a SageMaker HyperPod cluster.

" - }, - "TargetCount":{ - "shape":"ClusterInstanceCount", - "documentation":"

The number of instances you specified to add to the restricted instance group of a SageMaker HyperPod cluster.

" - }, - "InstanceGroupName":{ - "shape":"ClusterInstanceGroupName", - "documentation":"

The name of the restricted instance group of a SageMaker HyperPod cluster.

" - }, - "InstanceType":{ - "shape":"ClusterInstanceType", - "documentation":"

The instance type of the restricted instance group of a SageMaker HyperPod cluster.

" - }, - "ExecutionRole":{ - "shape":"RoleArn", - "documentation":"

The execution role for the restricted instance group to assume.

" - }, - "ThreadsPerCore":{ - "shape":"ClusterThreadsPerCore", - "documentation":"

The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.

" - }, - "InstanceStorageConfigs":{ - "shape":"ClusterInstanceStorageConfigs", - "documentation":"

The additional storage configurations for the instances in the SageMaker HyperPod cluster restricted instance group.

" - }, - "OnStartDeepHealthChecks":{ - "shape":"OnStartDeepHealthChecks", - "documentation":"

A flag indicating whether deep health checks should be performed when the cluster's restricted instance group is created or updated.

" - }, - "Status":{ - "shape":"InstanceGroupStatus", - "documentation":"

The current status of the cluster's restricted instance group.

  • InService: The restricted instance group is active and healthy.

  • Creating: The restricted instance group is being provisioned.

  • Updating: The restricted instance group is being updated.

  • Failed: The restricted instance group has failed to provision or is no longer healthy.

  • Degraded: The restricted instance group is degraded, meaning that some instances have failed to provision or are no longer healthy.

  • Deleting: The restricted instance group is being deleted.

" - }, - "TrainingPlanArn":{ - "shape":"TrainingPlanArn", - "documentation":"

The Amazon Resource Name (ARN) of the training plan to filter clusters by. For more information about reserving GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

" - }, - "TrainingPlanStatus":{ - "shape":"InstanceGroupTrainingPlanStatus", - "documentation":"

The current status of the training plan associated with this cluster restricted instance group.

" - }, - "OverrideVpcConfig":{"shape":"VpcConfig"}, - "ScheduledUpdateConfig":{"shape":"ScheduledUpdateConfig"}, - "EnvironmentConfig":{ - "shape":"EnvironmentConfigDetails", - "documentation":"

The configuration for the restricted instance groups (RIG) environment.

" - } - }, - "documentation":"

The instance group details of the restricted instance group (RIG).

" - }, - "ClusterRestrictedInstanceGroupDetailsList":{ - "type":"list", - "member":{"shape":"ClusterRestrictedInstanceGroupDetails"} - }, - "ClusterRestrictedInstanceGroupSpecification":{ - "type":"structure", - "required":[ - "InstanceCount", - "InstanceGroupName", - "InstanceType", - "ExecutionRole" - ], - "members":{ - "InstanceCount":{ - "shape":"ClusterInstanceCount", - "documentation":"

Specifies the number of instances to add to the restricted instance group of a SageMaker HyperPod cluster.

" - }, - "InstanceGroupName":{ - "shape":"ClusterInstanceGroupName", - "documentation":"

Specifies the name of the restricted instance group.

" - }, - "InstanceType":{ - "shape":"ClusterInstanceType", - "documentation":"

Specifies the instance type of the restricted instance group.

" - }, - "ExecutionRole":{ - "shape":"RoleArn", - "documentation":"

Specifies an IAM execution role to be assumed by the restricted instance group.

" - }, - "ThreadsPerCore":{ - "shape":"ClusterThreadsPerCore", - "documentation":"

The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.

" - }, - "InstanceStorageConfigs":{ - "shape":"ClusterInstanceStorageConfigs", - "documentation":"

Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster restricted instance group.

" - }, - "OnStartDeepHealthChecks":{ - "shape":"OnStartDeepHealthChecks", - "documentation":"

A flag indicating whether deep health checks should be performed when the cluster restricted instance group is created or updated.

" - }, - "TrainingPlanArn":{ - "shape":"TrainingPlanArn", - "documentation":"

The Amazon Resource Name (ARN) of the training plan to filter clusters by. For more information about reserving GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

" - }, - "OverrideVpcConfig":{"shape":"VpcConfig"}, - "ScheduledUpdateConfig":{"shape":"ScheduledUpdateConfig"}, - "EnvironmentConfig":{ - "shape":"EnvironmentConfig", - "documentation":"

The configuration for the restricted instance groups (RIG) environment.

" - } - }, - "documentation":"

The specifications of a restricted instance group that you need to define.

" - }, - "ClusterRestrictedInstanceGroupSpecifications":{ - "type":"list", - "member":{"shape":"ClusterRestrictedInstanceGroupSpecification"}, - "max":100, - "min":1 - }, - "ClusterRestrictedInstanceGroupsConfig":{ - "type":"structure", - "required":["SharedEnvironmentConfig"], - "members":{ - "SharedEnvironmentConfig":{ - "shape":"ClusterSharedEnvironmentConfig", - "documentation":"

The shared environment configuration for the restricted instance groups (RIG).

" - } - }, - "documentation":"

The configuration for the restricted instance groups (RIG) in the SageMaker HyperPod cluster.

" - }, - "ClusterRestrictedInstanceGroupsConfigOutput":{ - "type":"structure", - "required":["SharedEnvironmentConfig"], - "members":{ - "SharedEnvironmentConfig":{ - "shape":"ClusterSharedEnvironmentConfigDetails", - "documentation":"

The shared environment configuration details for the restricted instance groups (RIG).

" - } - }, - "documentation":"

The output configuration for the restricted instance groups (RIG) in the SageMaker HyperPod cluster.

" - }, - "ClusterSchedulerConfigArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:cluster-scheduler-config/[a-z0-9]{12}" - }, - "ClusterSchedulerConfigId":{ - "type":"string", - "max":12, - "min":0, - "pattern":"[a-z0-9]{12}" - }, - "ClusterSchedulerConfigSummary":{ - "type":"structure", - "required":[ - "ClusterSchedulerConfigArn", - "ClusterSchedulerConfigId", - "Name", - "CreationTime", - "Status" - ], - "members":{ - "ClusterSchedulerConfigArn":{ - "shape":"ClusterSchedulerConfigArn", - "documentation":"

ARN of the cluster policy.

" - }, - "ClusterSchedulerConfigId":{ - "shape":"ClusterSchedulerConfigId", - "documentation":"

ID of the cluster policy.

" - }, - "ClusterSchedulerConfigVersion":{ - "shape":"Integer", - "documentation":"

Version of the cluster policy.

", - "box":true - }, - "Name":{ - "shape":"EntityName", - "documentation":"

Name of the cluster policy.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

Creation time of the cluster policy.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

Last modified time of the cluster policy.

" - }, - "Status":{ - "shape":"SchedulerResourceStatus", - "documentation":"

Status of the cluster policy.

" - }, - "ClusterArn":{ - "shape":"ClusterArn", - "documentation":"

ARN of the cluster.

" - } - }, - "documentation":"

Summary of the cluster policy.

" - }, - "ClusterSchedulerConfigSummaryList":{ - "type":"list", - "member":{"shape":"ClusterSchedulerConfigSummary"}, - "max":100, - "min":0 - }, - "ClusterSchedulerPriorityClassName":{ - "type":"string", - "pattern":"[a-z0-9]([-a-z0-9]*[a-z0-9]){0,39}?" - }, - "ClusterSharedEnvironmentConfig":{ - "type":"structure", - "required":[ - "FSxLustreDeletionPolicy", - "FSxLustreConfig" - ], - "members":{ - "FSxLustreDeletionPolicy":{ - "shape":"ClusterFSxLustreDeletionPolicy", - "documentation":"

The deletion policy for the Amazon FSx for Lustre file system in the shared environment.

" - }, - "FSxLustreConfig":{ - "shape":"FSxLustreConfig", - "documentation":"

Configuration settings for an Amazon FSx for Lustre file system in the shared environment.

" - } - }, - "documentation":"

The shared environment configuration for the restricted instance groups (RIG).

" - }, - "ClusterSharedEnvironmentConfigDetails":{ - "type":"structure", - "members":{ - "CurrentFSxLustreConfig":{ - "shape":"FSxLustreConfig", - "documentation":"

The current Amazon FSx for Lustre file system configuration in the shared environment.

" - }, - "DesiredFSxLustreConfig":{ - "shape":"FSxLustreConfig", - "documentation":"

The desired Amazon FSx for Lustre file system configuration in the shared environment.

" - }, - "CurrentFSxLustreDeletionPolicy":{ - "shape":"ClusterFSxLustreDeletionPolicy", - "documentation":"

The current deletion policy for the Amazon FSx for Lustre file system in the shared environment.

" - }, - "DesiredFSxLustreDeletionPolicy":{ - "shape":"ClusterFSxLustreDeletionPolicy", - "documentation":"

The desired deletion policy for the Amazon FSx for Lustre file system in the shared environment.

" - } - }, - "documentation":"

The shared environment configuration details for the restricted instance groups (RIG).

" - }, - "ClusterSlurmConfig":{ - "type":"structure", - "required":["NodeType"], - "members":{ - "NodeType":{ - "shape":"ClusterSlurmNodeType", - "documentation":"

The type of Slurm node for the instance group. Valid values are Controller, Worker, and Login.

" - }, - "PartitionNames":{ - "shape":"ClusterPartitionNames", - "documentation":"

The list of Slurm partition names that the instance group belongs to.

" - } - }, - "documentation":"

The Slurm configuration for an instance group in a SageMaker HyperPod cluster.

" - }, - "ClusterSlurmConfigDetails":{ - "type":"structure", - "required":["NodeType"], - "members":{ - "NodeType":{ - "shape":"ClusterSlurmNodeType", - "documentation":"

The type of Slurm node for the instance group. Valid values are Controller, Worker, and Login.

" - }, - "PartitionNames":{ - "shape":"ClusterPartitionNames", - "documentation":"

The list of Slurm partition names that the instance group belongs to.

" - } - }, - "documentation":"

The Slurm configuration details for an instance group in a SageMaker HyperPod cluster.

" - }, - "ClusterSlurmConfigStrategy":{ - "type":"string", - "enum":[ - "Overwrite", - "Managed", - "Merge" - ] - }, - "ClusterSlurmNodeType":{ - "type":"string", - "enum":[ - "Controller", - "Login", - "Compute" - ] - }, - "ClusterSortBy":{ - "type":"string", - "enum":[ - "CREATION_TIME", - "NAME" - ] - }, - "ClusterSpotOptions":{ - "type":"structure", - "members":{}, - "documentation":"

Configuration options specific to Spot instances.

" - }, - "ClusterStatus":{ - "type":"string", - "enum":[ - "Creating", - "Deleting", - "Failed", - "InService", - "RollingBack", - "SystemUpdating", - "Updating" - ] - }, - "ClusterSummaries":{ - "type":"list", - "member":{"shape":"ClusterSummary"} - }, - "ClusterSummary":{ - "type":"structure", - "required":[ - "ClusterArn", - "ClusterName", - "CreationTime", - "ClusterStatus" - ], - "members":{ - "ClusterArn":{ - "shape":"ClusterArn", - "documentation":"

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

" - }, - "ClusterName":{ - "shape":"ClusterName", - "documentation":"

The name of the SageMaker HyperPod cluster.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The time when the SageMaker HyperPod cluster is created.

" - }, - "ClusterStatus":{ - "shape":"ClusterStatus", - "documentation":"

The status of the SageMaker HyperPod cluster.

" - }, - "TrainingPlanArns":{ - "shape":"TrainingPlanArns", - "documentation":"

A list of Amazon Resource Names (ARNs) of the training plans associated with this cluster.

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

" - }, - "ImageVersionStatus":{ - "shape":"ClusterImageVersionStatus", - "documentation":"

The aggregate status of the image version across the cluster's instance groups.

" - } - }, - "documentation":"

Lists a summary of the properties of a SageMaker HyperPod cluster.

" - }, - "ClusterThreadsPerCore":{ - "type":"integer", - "box":true, - "max":2, - "min":1 - }, - "ClusterTieredStorageConfig":{ - "type":"structure", - "required":["Mode"], - "members":{ - "Mode":{ - "shape":"ClusterConfigMode", - "documentation":"

Specifies whether managed tier checkpointing is enabled or disabled for the HyperPod cluster. When set to Enable, the system installs a memory management daemon that provides disaggregated memory as a service for checkpoint storage. When set to Disable, the feature is turned off and the memory management daemon is removed from the cluster.

" - }, - "InstanceMemoryAllocationPercentage":{ - "shape":"ClusterInstanceMemoryAllocationPercentage", - "documentation":"

The percentage (int) of cluster memory to allocate for checkpointing.

" - } - }, - "documentation":"

Defines the configuration for managed tier checkpointing in a HyperPod cluster. Managed tier checkpointing uses multiple storage tiers, including cluster CPU memory, to provide faster checkpoint operations and improved fault tolerance for large-scale model training. The system automatically saves checkpoints at high frequency to memory and periodically persists them to durable storage, like Amazon S3.

" - }, - "CodeEditorAppImageConfig":{ - "type":"structure", - "members":{ - "FileSystemConfig":{"shape":"FileSystemConfig"}, - "ContainerConfig":{"shape":"ContainerConfig"} - }, - "documentation":"

The configuration for the file system and kernels in a SageMaker image running as a Code Editor app. The FileSystemConfig object is not supported.

" - }, - "CodeEditorAppSettings":{ - "type":"structure", - "members":{ - "DefaultResourceSpec":{"shape":"ResourceSpec"}, - "CustomImages":{ - "shape":"CustomImages", - "documentation":"

A list of custom SageMaker images that are configured to run as a Code Editor app.

" - }, - "LifecycleConfigArns":{ - "shape":"LifecycleConfigArns", - "documentation":"

The Amazon Resource Name (ARN) of the Code Editor application lifecycle configuration.

" - }, - "AppLifecycleManagement":{ - "shape":"AppLifecycleManagement", - "documentation":"

Settings that are used to configure and manage the lifecycle of CodeEditor applications.

" - }, - "BuiltInLifecycleConfigArn":{ - "shape":"StudioLifecycleConfigArn", - "documentation":"

The lifecycle configuration that runs before the default lifecycle configuration. It can override changes made in the default lifecycle configuration.

" - } - }, - "documentation":"

The Code Editor application settings.

For more information about Code Editor, see Get started with Code Editor in Amazon SageMaker.

" - }, - "CodeRepositories":{ - "type":"list", - "member":{"shape":"CodeRepository"}, - "max":10, - "min":0 - }, - "CodeRepository":{ - "type":"structure", - "required":["RepositoryUrl"], - "members":{ - "RepositoryUrl":{ - "shape":"RepositoryUrl", - "documentation":"

The URL of the Git repository.

" - } - }, - "documentation":"

A Git repository that SageMaker AI automatically displays to users for cloning in the JupyterServer application.

" - }, - "CodeRepositoryArn":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:code-repository/[\\S]{1,2048}" - }, - "CodeRepositoryContains":{ - "type":"string", - "max":1024, - "min":0, - "pattern":"[a-zA-Z0-9-]+" - }, - "CodeRepositoryNameContains":{ - "type":"string", - "max":63, - "min":0, - "pattern":"[a-zA-Z0-9-]+" - }, - "CodeRepositoryNameOrUrl":{ - "type":"string", - "max":1024, - "min":1, - "pattern":"https://([^/]+)/?(.*)$|^[a-zA-Z0-9](-*[a-zA-Z0-9])*" - }, - "CodeRepositorySortBy":{ - "type":"string", - "enum":[ - "Name", - "CreationTime", - "LastModifiedTime" - ] - }, - "CodeRepositorySortOrder":{ - "type":"string", - "enum":[ - "Ascending", - "Descending" - ] - }, - "CodeRepositorySummary":{ - "type":"structure", - "required":[ - "CodeRepositoryName", - "CodeRepositoryArn", - "CreationTime", - "LastModifiedTime" - ], - "members":{ - "CodeRepositoryName":{ - "shape":"EntityName", - "documentation":"

The name of the Git repository.

" - }, - "CodeRepositoryArn":{ - "shape":"CodeRepositoryArn", - "documentation":"

The Amazon Resource Name (ARN) of the Git repository.

" - }, - "CreationTime":{ - "shape":"CreationTime", - "documentation":"

The date and time that the Git repository was created.

" - }, - "LastModifiedTime":{ - "shape":"LastModifiedTime", - "documentation":"

The date and time that the Git repository was last modified.

" - }, - "GitConfig":{ - "shape":"GitConfig", - "documentation":"

Configuration details for the Git repository, including the URL where it is located and the ARN of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the repository.

" - } - }, - "documentation":"

Specifies summary information about a Git repository.

" - }, - "CodeRepositorySummaryList":{ - "type":"list", - "member":{"shape":"CodeRepositorySummary"} - }, - "CognitoConfig":{ - "type":"structure", - "required":[ - "UserPool", - "ClientId" - ], - "members":{ - "UserPool":{ - "shape":"CognitoUserPool", - "documentation":"

A user pool is a user directory in Amazon Cognito. With a user pool, your users can sign in to your web or mobile app through Amazon Cognito. Your users can also sign in through social identity providers like Google, Facebook, Amazon, or Apple, and through SAML identity providers.

" - }, - "ClientId":{ - "shape":"ClientId", - "documentation":"

The client ID for your Amazon Cognito user pool.

" - } - }, - "documentation":"

Use this parameter to configure your Amazon Cognito workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.

" - }, - "CognitoMemberDefinition":{ - "type":"structure", - "required":[ - "UserPool", - "UserGroup", - "ClientId" - ], - "members":{ - "UserPool":{ - "shape":"CognitoUserPool", - "documentation":"

An identifier for a user pool. The user pool must be in the same region as the service that you are calling.

" - }, - "UserGroup":{ - "shape":"CognitoUserGroup", - "documentation":"

An identifier for a user group.

" - }, - "ClientId":{ - "shape":"ClientId", - "documentation":"

An identifier for an application client. You must create the app client ID using Amazon Cognito.

" - } - }, - "documentation":"

Identifies a Amazon Cognito user group. A user group can be used in on or more work teams.

" - }, - "CognitoUserGroup":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+" - }, - "CognitoUserPool":{ - "type":"string", - "max":55, - "min":1, - "pattern":"[\\w-]+_[0-9a-zA-Z]+" - }, - "CollectionConfig":{ - "type":"structure", - "members":{ - "VectorConfig":{ - "shape":"VectorConfig", - "documentation":"

Configuration for your vector collection type.

  • Dimension: The number of elements in your vector.

" - } - }, - "documentation":"

Configuration for your collection.

", - "union":true - }, - "CollectionConfiguration":{ - "type":"structure", - "members":{ - "CollectionName":{ - "shape":"CollectionName", - "documentation":"

The name of the tensor collection. The name must be unique relative to other rule configuration names.

" - }, - "CollectionParameters":{ - "shape":"CollectionParameters", - "documentation":"

Parameter values for the tensor collection. The allowed parameters are \"name\", \"include_regex\", \"reduction_config\", \"save_config\", \"tensor_names\", and \"save_histogram\".

" - } - }, - "documentation":"

Configuration information for the Amazon SageMaker Debugger output tensor collections.

" - }, - "CollectionConfigurations":{ - "type":"list", - "member":{"shape":"CollectionConfiguration"}, - "max":20, - "min":0 - }, - "CollectionName":{ - "type":"string", - "max":256, - "min":1, - "pattern":".*" - }, - "CollectionParameters":{ - "type":"map", - "key":{"shape":"ConfigKey"}, - "value":{"shape":"ConfigValue"}, - "max":20, - "min":0 - }, - "CollectionType":{ - "type":"string", - "enum":[ - "List", - "Set", - "Vector" - ] - }, - "CompilationJobArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:compilation-job/.*" - }, - "CompilationJobStatus":{ - "type":"string", - "enum":[ - "INPROGRESS", - "COMPLETED", - "FAILED", - "STARTING", - "STOPPING", - "STOPPED" - ] - }, - "CompilationJobSummaries":{ - "type":"list", - "member":{"shape":"CompilationJobSummary"} - }, - "CompilationJobSummary":{ - "type":"structure", - "required":[ - "CompilationJobName", - "CompilationJobArn", - "CreationTime", - "CompilationJobStatus" - ], - "members":{ - "CompilationJobName":{ - "shape":"EntityName", - "documentation":"

The name of the model compilation job that you want a summary for.

" - }, - "CompilationJobArn":{ - "shape":"CompilationJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the model compilation job.

" - }, - "CreationTime":{ - "shape":"CreationTime", - "documentation":"

The time when the model compilation job was created.

" - }, - "CompilationStartTime":{ - "shape":"Timestamp", - "documentation":"

The time when the model compilation job started.

" - }, - "CompilationEndTime":{ - "shape":"Timestamp", - "documentation":"

The time when the model compilation job completed.

" - }, - "CompilationTargetDevice":{ - "shape":"TargetDevice", - "documentation":"

The type of device that the model will run on after the compilation job has completed.

" - }, - "CompilationTargetPlatformOs":{ - "shape":"TargetPlatformOs", - "documentation":"

The type of OS that the model will run on after the compilation job has completed.

" - }, - "CompilationTargetPlatformArch":{ - "shape":"TargetPlatformArch", - "documentation":"

The type of architecture that the model will run on after the compilation job has completed.

" - }, - "CompilationTargetPlatformAccelerator":{ - "shape":"TargetPlatformAccelerator", - "documentation":"

The type of accelerator that the model will run on after the compilation job has completed.

" - }, - "LastModifiedTime":{ - "shape":"LastModifiedTime", - "documentation":"

The time when the model compilation job was last modified.

" - }, - "CompilationJobStatus":{ - "shape":"CompilationJobStatus", - "documentation":"

The status of the model compilation job.

" - } - }, - "documentation":"

A summary of a model compilation job.

" - }, - "CompilerOptions":{ - "type":"string", - "max":1024, - "min":3, - "pattern":".*" - }, - "CompleteOnConvergence":{ - "type":"string", - "enum":[ - "Disabled", - "Enabled" - ] - }, - "CompressionType":{ - "type":"string", - "enum":[ - "None", - "Gzip" - ] - }, - "CompressionTypes":{ - "type":"list", - "member":{"shape":"CompressionType"} - }, - "ComputeQuotaArn":{ - "type":"string", - "max":2048, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:compute-quota/[a-z0-9]{12}" - }, - "ComputeQuotaConfig":{ - "type":"structure", - "members":{ - "ComputeQuotaResources":{ - "shape":"ComputeQuotaResourceConfigList", - "documentation":"

Allocate compute resources by instance types.

" - }, - "ResourceSharingConfig":{ - "shape":"ResourceSharingConfig", - "documentation":"

Resource sharing configuration. This defines how an entity can lend and borrow idle compute with other entities within the cluster.

" - }, - "PreemptTeamTasks":{ - "shape":"PreemptTeamTasks", - "documentation":"

Allows workloads from within an entity to preempt same-team workloads. When set to LowerPriority, the entity's lower priority tasks are preempted by their own higher priority tasks.

Default is LowerPriority.

" - } - }, - "documentation":"

Configuration of the compute allocation definition for an entity. This includes the resource sharing option and the setting to preempt low priority tasks.

" - }, - "ComputeQuotaId":{ - "type":"string", - "pattern":"[a-z0-9]{12}" - }, - "ComputeQuotaResourceConfig":{ - "type":"structure", - "required":["InstanceType"], - "members":{ - "InstanceType":{ - "shape":"ClusterInstanceType", - "documentation":"

The instance type of the instance group for the cluster.

" - }, - "Count":{ - "shape":"InstanceCount", - "documentation":"

The number of instances to add to the instance group of a SageMaker HyperPod cluster.

" - }, - "Accelerators":{ - "shape":"AcceleratorsAmount", - "documentation":"

The number of accelerators to allocate. If you don't specify a value for vCPU and MemoryInGiB, SageMaker AI automatically allocates ratio-based values for those parameters based on the number of accelerators you provide. For example, if you allocate 16 out of 32 total accelerators, SageMaker AI uses the ratio of 0.5 and allocates values to vCPU and MemoryInGiB.

" - }, - "VCpu":{ - "shape":"VCpuAmount", - "documentation":"

The number of vCPU to allocate. If you specify a value only for vCPU, SageMaker AI automatically allocates ratio-based values for MemoryInGiB based on this vCPU parameter. For example, if you allocate 20 out of 40 total vCPU, SageMaker AI uses the ratio of 0.5 and allocates values to MemoryInGiB. Accelerators are set to 0.

" - }, - "MemoryInGiB":{ - "shape":"MemoryInGiBAmount", - "documentation":"

The amount of memory in GiB to allocate. If you specify a value only for this parameter, SageMaker AI automatically allocates a ratio-based value for vCPU based on this memory that you provide. For example, if you allocate 200 out of 400 total memory in GiB, SageMaker AI uses the ratio of 0.5 and allocates values to vCPU. Accelerators are set to 0.

" - }, - "AcceleratorPartition":{ - "shape":"AcceleratorPartitionConfig", - "documentation":"

The accelerator partition configuration for fractional GPU allocation.

" - } - }, - "documentation":"

Configuration of the resources used for the compute allocation definition.

" - }, - "ComputeQuotaResourceConfigList":{ - "type":"list", - "member":{"shape":"ComputeQuotaResourceConfig"}, - "max":15, - "min":0 - }, - "ComputeQuotaSummary":{ - "type":"structure", - "required":[ - "ComputeQuotaArn", - "ComputeQuotaId", - "Name", - "Status", - "ComputeQuotaTarget", - "CreationTime" - ], - "members":{ - "ComputeQuotaArn":{ - "shape":"ComputeQuotaArn", - "documentation":"

ARN of the compute allocation definition.

" - }, - "ComputeQuotaId":{ - "shape":"ComputeQuotaId", - "documentation":"

ID of the compute allocation definition.

" - }, - "Name":{ - "shape":"EntityName", - "documentation":"

Name of the compute allocation definition.

" - }, - "ComputeQuotaVersion":{ - "shape":"Integer", - "documentation":"

Version of the compute allocation definition.

", - "box":true - }, - "Status":{ - "shape":"SchedulerResourceStatus", - "documentation":"

Status of the compute allocation definition.

" - }, - "ClusterArn":{ - "shape":"ClusterArn", - "documentation":"

ARN of the cluster.

" - }, - "ComputeQuotaConfig":{ - "shape":"ComputeQuotaConfig", - "documentation":"

Configuration of the compute allocation definition. This includes the resource sharing option, and the setting to preempt low priority tasks.

" - }, - "ComputeQuotaTarget":{ - "shape":"ComputeQuotaTarget", - "documentation":"

The target entity to allocate compute resources to.

" - }, - "ActivationState":{ - "shape":"ActivationState", - "documentation":"

The state of the compute allocation being described. Use to enable or disable compute allocation.

Default is Enabled.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

Creation time of the compute allocation definition.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

Last modified time of the compute allocation definition.

" - } - }, - "documentation":"

Summary of the compute allocation definition.

" - }, - "ComputeQuotaSummaryList":{ - "type":"list", - "member":{"shape":"ComputeQuotaSummary"}, - "max":100, - "min":0 - }, - "ComputeQuotaTarget":{ - "type":"structure", - "required":["TeamName"], - "members":{ - "TeamName":{ - "shape":"ComputeQuotaTargetTeamName", - "documentation":"

Name of the team to allocate compute resources to.

" - }, - "FairShareWeight":{ - "shape":"FairShareWeight", - "documentation":"

Assigned entity fair-share weight. Idle compute will be shared across entities based on these assigned weights. This weight is only used when FairShare is enabled.

A weight of 0 is the lowest priority and 100 is the highest. Weight 0 is the default.

" - } - }, - "documentation":"

The target entity to allocate compute resources to.

" - }, - "ComputeQuotaTargetTeamName":{ - "type":"string", - "pattern":"[a-z0-9]([-a-z0-9]*[a-z0-9]){0,39}?" - }, - "ConditionOutcome":{ - "type":"string", - "enum":[ - "True", - "False" - ] - }, - "ConditionStepMetadata":{ - "type":"structure", - "members":{ - "Outcome":{ - "shape":"ConditionOutcome", - "documentation":"

The outcome of the Condition step evaluation.

" - } - }, - "documentation":"

Metadata for a Condition step.

" - }, - "ConfigKey":{ - "type":"string", - "max":256, - "min":1, - "pattern":".*" - }, - "ConfigValue":{ - "type":"string", - "max":256, - "min":0, - "pattern":".*" - }, - "ConfiguredSpareInstanceCount":{ - "type":"integer", - "box":true, - "min":0 - }, - "ConflictException":{ - "type":"structure", - "members":{ - "Message":{"shape":"FailureReason"} - }, - "documentation":"

There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.

", - "exception":true - }, - "ContainerArgument":{ - "type":"string", - "max":256, - "min":0, - "pattern":".*" - }, - "ContainerArguments":{ - "type":"list", - "member":{"shape":"ContainerArgument"}, - "max":100, - "min":1 - }, - "ContainerConfig":{ - "type":"structure", - "members":{ - "ContainerArguments":{ - "shape":"CustomImageContainerArguments", - "documentation":"

The arguments for the container when you're running the application.

" - }, - "ContainerEntrypoint":{ - "shape":"CustomImageContainerEntrypoint", - "documentation":"

The entrypoint used to run the application in the container.

" - }, - "ContainerEnvironmentVariables":{ - "shape":"CustomImageContainerEnvironmentVariables", - "documentation":"

The environment variables to set in the container

" - } - }, - "documentation":"

The configuration used to run the application image container.

" - }, - "ContainerDefinition":{ - "type":"structure", - "members":{ - "ContainerHostname":{ - "shape":"ContainerHostname", - "documentation":"

This parameter is ignored for models that contain only a PrimaryContainer.

When a ContainerDefinition is part of an inference pipeline, the value of the parameter uniquely identifies the container for the purposes of logging and metrics. For information, see Use Logs and Metrics to Monitor an Inference Pipeline. If you don't specify a value for this parameter for a ContainerDefinition that is part of an inference pipeline, a unique name is automatically assigned based on the position of the ContainerDefinition in the pipeline. If you specify a value for the ContainerHostName for any ContainerDefinition that is part of an inference pipeline, you must specify a value for the ContainerHostName parameter of every ContainerDefinition in that pipeline.

" - }, - "Image":{ - "shape":"ContainerImage", - "documentation":"

The path where inference code is stored. This can be either in Amazon EC2 Container Registry or in a Docker registry that is accessible from the same VPC that you configure for your endpoint. If you are using your own custom algorithm instead of an algorithm provided by SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

The model artifacts in an Amazon S3 bucket and the Docker image for inference container in Amazon EC2 Container Registry must be in the same region as the model or endpoint you are creating.

" - }, - "ImageConfig":{ - "shape":"ImageConfig", - "documentation":"

Specifies whether the model container is in Amazon ECR or a private Docker registry accessible from your Amazon Virtual Private Cloud (VPC). For information about storing containers in a private Docker registry, see Use a Private Docker Registry for Real-Time Inference Containers.

The model artifacts in an Amazon S3 bucket and the Docker image for inference container in Amazon EC2 Container Registry must be in the same region as the model or endpoint you are creating.

" - }, - "Mode":{ - "shape":"ContainerMode", - "documentation":"

Whether the container hosts a single model or multiple models.

" - }, - "ModelDataUrl":{ - "shape":"Url", - "documentation":"

The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3 path is required for SageMaker built-in algorithms, but not if you use your own algorithms. For more information on built-in algorithms, see Common Parameters.

The model artifacts must be in an S3 bucket that is in the same region as the model or endpoint you are creating.

If you provide a value for this parameter, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provide. Amazon Web Services STS is activated in your Amazon Web Services account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide.

If you use a built-in algorithm to create a model, SageMaker requires that you provide a S3 path to the model artifacts in ModelDataUrl.

" - }, - "ModelDataSource":{ - "shape":"ModelDataSource", - "documentation":"

Specifies the location of ML model data to deploy.

Currently you cannot use ModelDataSource in conjunction with SageMaker batch transform, SageMaker serverless endpoints, SageMaker multi-model endpoints, and SageMaker Marketplace.

" - }, - "AdditionalModelDataSources":{ - "shape":"AdditionalModelDataSources", - "documentation":"

Data sources that are available to your model in addition to the one that you specify for ModelDataSource when you use the CreateModel action.

" - }, - "Environment":{ - "shape":"EnvironmentMap", - "documentation":"

The environment variables to set in the Docker container. Don't include any sensitive data in your environment variables.

The maximum length of each key and value in the Environment map is 1024 bytes. The maximum length of all keys and values in the map, combined, is 32 KB. If you pass multiple containers to a CreateModel request, then the maximum length of all of their maps, combined, is also 32 KB.

" - }, - "ModelPackageName":{ - "shape":"VersionedArnOrName", - "documentation":"

The name or Amazon Resource Name (ARN) of the model package to use to create the model.

" - }, - "InferenceSpecificationName":{ - "shape":"InferenceSpecificationName", - "documentation":"

The inference specification name in the model package version.

" - }, - "MultiModelConfig":{ - "shape":"MultiModelConfig", - "documentation":"

Specifies additional configuration for multi-model endpoints.

" - }, - "ContainerMetricsConfig":{ - "shape":"ContainerMetricsConfig", - "documentation":"

The configuration for container metrics scraping. Specifies the metrics endpoint path and publishing frequency. If not specified when EnableDetailedObservability is True, the default path /metrics on port 8080 is used. For first-party and Deep Learning Containers (DLC), the endpoint path is determined automatically and this configuration is optional.

" - } - }, - "documentation":"

Describes the container, as part of model definition.

" - }, - "ContainerDefinitionList":{ - "type":"list", - "member":{"shape":"ContainerDefinition"}, - "max":15, - "min":0 - }, - "ContainerEntrypoint":{ - "type":"list", - "member":{"shape":"ContainerEntrypointString"}, - "max":100, - "min":1 - }, - "ContainerEntrypointString":{ - "type":"string", - "max":256, - "min":0, - "pattern":".*" - }, - "ContainerHostname":{ - "type":"string", - "max":63, - "min":0, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" - }, - "ContainerImage":{ - "type":"string", - "max":255, - "min":0, - "pattern":"[\\S]+" - }, - "ContainerMetricsConfig":{ - "type":"structure", - "members":{ - "MetricsEndpoints":{ - "shape":"MetricsEndpointList", - "documentation":"

A list of metrics endpoints to scrape from the container. Each endpoint specifies the path where the container exposes Prometheus-formatted metrics and the frequency at which to publish them. You can specify a maximum of 1 endpoint.

" - } - }, - "documentation":"

The configuration for container-level metrics scraping. Use this configuration to specify a custom metrics endpoint path and publishing frequency for container metrics. When EnableDetailedObservability is set to True in MetricsConfig, metrics are scraped from the container's Prometheus endpoint. If this configuration is not provided, the default path /metrics on port 8080 is used with a default publishing frequency of 60 seconds. For first-party and Deep Learning Containers (DLC), the endpoint path is determined automatically and this configuration is optional.

" - }, - "ContainerMode":{ - "type":"string", - "enum":[ - "SingleModel", - "MultiModel" - ] - }, - "ContentClassifier":{ - "type":"string", - "enum":[ - "FreeOfPersonallyIdentifiableInformation", - "FreeOfAdultContent" - ] - }, - "ContentClassifiers":{ - "type":"list", - "member":{"shape":"ContentClassifier"}, - "max":256, - "min":0 - }, - "ContentColumn":{ - "type":"string", - "max":256, - "min":1 - }, - "ContentDigest":{ - "type":"string", - "max":72, - "min":0, - "pattern":"[Ss][Hh][Aa]256:[0-9a-fA-F]{64}" - }, - "ContentType":{ - "type":"string", - "max":256, - "min":0, - "pattern":".*" - }, - "ContentTypes":{ - "type":"list", - "member":{"shape":"ContentType"} - }, - "ContextArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:context/.*" - }, - "ContextName":{ - "type":"string", - "max":120, - "min":1, - "pattern":"[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,119}" - }, - "ContextNameOrArn":{ - "type":"string", - "max":256, - "min":1, - "pattern":"(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:context\\/)?([a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,119})" - }, - "ContextSource":{ - "type":"structure", - "required":["SourceUri"], - "members":{ - "SourceUri":{ - "shape":"SourceUri", - "documentation":"

The URI of the source.

" - }, - "SourceType":{ - "shape":"String256", - "documentation":"

The type of the source.

" - }, - "SourceId":{ - "shape":"String256", - "documentation":"

The ID of the source.

" - } - }, - "documentation":"

A structure describing the source of a context.

" - }, - "ContextSummaries":{ - "type":"list", - "member":{"shape":"ContextSummary"} - }, - "ContextSummary":{ - "type":"structure", - "members":{ - "ContextArn":{ - "shape":"ContextArn", - "documentation":"

The Amazon Resource Name (ARN) of the context.

" - }, - "ContextName":{ - "shape":"ContextName", - "documentation":"

The name of the context.

" - }, - "Source":{ - "shape":"ContextSource", - "documentation":"

The source of the context.

" - }, - "ContextType":{ - "shape":"String256", - "documentation":"

The type of the context.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

When the context was created.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

When the context was last modified.

" - } - }, - "documentation":"

Lists a summary of the properties of a context. A context provides a logical grouping of other entities.

" - }, - "ContinuousParameterRange":{ - "type":"structure", - "required":[ - "Name", - "MinValue", - "MaxValue" - ], - "members":{ - "Name":{ - "shape":"ParameterKey", - "documentation":"

The name of the continuous hyperparameter to tune.

" - }, - "MinValue":{ - "shape":"ParameterValue", - "documentation":"

The minimum value for the hyperparameter. The tuning job uses floating-point values between this value and MaxValuefor tuning.

" - }, - "MaxValue":{ - "shape":"ParameterValue", - "documentation":"

The maximum value for the hyperparameter. The tuning job uses floating-point values between MinValue value and this value for tuning.

" - }, - "ScalingType":{ - "shape":"HyperParameterScalingType", - "documentation":"

The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

Auto

SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.

Linear

Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

Logarithmic

Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.

Logarithmic scaling works only for ranges that have only values greater than 0.

ReverseLogarithmic

Hyperparameter tuning searches the values in the hyperparameter range by using a reverse logarithmic scale.

Reverse logarithmic scaling works only for ranges that are entirely within the range 0<=x<1.0.

" - } - }, - "documentation":"

A list of continuous hyperparameters to tune.

" - }, - "ContinuousParameterRangeSpecification":{ - "type":"structure", - "required":[ - "MinValue", - "MaxValue" - ], - "members":{ - "MinValue":{ - "shape":"ParameterValue", - "documentation":"

The minimum floating-point value allowed.

" - }, - "MaxValue":{ - "shape":"ParameterValue", - "documentation":"

The maximum floating-point value allowed.

" - } - }, - "documentation":"

Defines the possible values for a continuous hyperparameter.

" - }, - "ContinuousParameterRanges":{ - "type":"list", - "member":{"shape":"ContinuousParameterRange"}, - "max":30, - "min":0 - }, - "ConvergenceDetected":{ - "type":"structure", - "members":{ - "CompleteOnConvergence":{ - "shape":"CompleteOnConvergence", - "documentation":"

A flag to stop a tuning job once AMT has detected that the job has converged.

" - } - }, - "documentation":"

A flag to indicating that automatic model tuning (AMT) has detected model convergence, defined as a lack of significant improvement (1% or less) against an objective metric.

" - }, - "CountryCode":{ - "type":"string", - "max":2, - "min":2, - "pattern":"[A-Z]{2}" - }, - "CreateAIBenchmarkJobRequest":{ - "type":"structure", - "required":[ - "AIBenchmarkJobName", - "BenchmarkTarget", - "OutputConfig", - "AIWorkloadConfigIdentifier", - "RoleArn" - ], - "members":{ - "AIBenchmarkJobName":{ - "shape":"AIEntityName", - "documentation":"

The name of the AI benchmark job. The name must be unique within your Amazon Web Services account in the current Amazon Web Services Region.

" - }, - "BenchmarkTarget":{ - "shape":"AIBenchmarkTarget", - "documentation":"

The target endpoint to benchmark. Specify a SageMaker endpoint by providing its name or Amazon Resource Name (ARN).

" - }, - "OutputConfig":{ - "shape":"AIBenchmarkOutputConfig", - "documentation":"

The output configuration for the benchmark job, including the Amazon S3 location where benchmark results are stored.

" - }, - "AIWorkloadConfigIdentifier":{ - "shape":"AIResourceIdentifier", - "documentation":"

The name or Amazon Resource Name (ARN) of the AI workload configuration to use for this benchmark job.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.

" - }, - "NetworkConfig":{ - "shape":"AIBenchmarkNetworkConfig", - "documentation":"

The network configuration for the benchmark job, including VPC settings.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define.

" - } - } - }, - "CreateAIBenchmarkJobResponse":{ - "type":"structure", - "required":["AIBenchmarkJobArn"], - "members":{ - "AIBenchmarkJobArn":{ - "shape":"AIBenchmarkJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the created benchmark job.

" - } - } - }, - "CreateAIRecommendationJobRequest":{ - "type":"structure", - "required":[ - "AIRecommendationJobName", - "ModelSource", - "OutputConfig", - "AIWorkloadConfigIdentifier", - "PerformanceTarget", - "RoleArn" - ], - "members":{ - "AIRecommendationJobName":{ - "shape":"AIEntityName", - "documentation":"

The name of the AI recommendation job. The name must be unique within your Amazon Web Services account in the current Amazon Web Services Region.

" - }, - "ModelSource":{ - "shape":"AIModelSource", - "documentation":"

The source of the model to optimize. Specify the Amazon S3 location of the model artifacts.

" - }, - "OutputConfig":{ - "shape":"AIRecommendationOutputConfig", - "documentation":"

The output configuration for the recommendation job, including the Amazon S3 location for results and an optional model package group where the optimized model is registered.

" - }, - "AIWorkloadConfigIdentifier":{ - "shape":"AIResourceIdentifier", - "documentation":"

The name or Amazon Resource Name (ARN) of the AI workload configuration to use for this recommendation job.

" - }, - "PerformanceTarget":{ - "shape":"AIRecommendationPerformanceTarget", - "documentation":"

The performance targets for the recommendation job. Specify constraints on metrics such as time to first token (ttft-ms), throughput, or cost.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.

" - }, - "InferenceSpecification":{ - "shape":"AIRecommendationInferenceSpecification", - "documentation":"

The inference framework configuration. Specify the framework (such as LMI or vLLM) for the recommendation job.

" - }, - "OptimizeModel":{ - "shape":"AIRecommendationAllowOptimization", - "documentation":"

Whether to allow model optimization techniques such as quantization, speculative decoding, and kernel tuning. The default is true.

" - }, - "ComputeSpec":{ - "shape":"AIRecommendationComputeSpec", - "documentation":"

The compute resource specification for the recommendation job. You can specify up to 3 instance types to consider, and optionally provide capacity reservation configuration.

" - }, - "AdapterSource":{ - "shape":"AIAdapterSource", - "documentation":"

The LoRA adapter source for the recommendation job. Specify either a list of model package ARNs or Amazon S3 URIs for your LoRA adapters. When this parameter is absent, the recommendation job runs without LoRA adapter support.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The metadata that you apply to Amazon Web Services resources to help you categorize and organize them.

" - } - } - }, - "CreateAIRecommendationJobResponse":{ - "type":"structure", - "required":["AIRecommendationJobArn"], - "members":{ - "AIRecommendationJobArn":{ - "shape":"AIRecommendationJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the created recommendation job.

" - } - } - }, - "CreateAIWorkloadConfigRequest":{ - "type":"structure", - "required":["AIWorkloadConfigName"], - "members":{ - "AIWorkloadConfigName":{ - "shape":"AIEntityName", - "documentation":"

The name of the AI workload configuration. The name must be unique within your Amazon Web Services account in the current Amazon Web Services Region.

" - }, - "DatasetConfig":{ - "shape":"AIDatasetConfig", - "documentation":"

The dataset configuration for the workload. Specify input data channels with their data sources for benchmark workloads.

" - }, - "AIWorkloadConfigs":{ - "shape":"AIWorkloadConfigs", - "documentation":"

The benchmark tool configuration and workload specification. Provide the specification as an inline YAML or JSON string.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

" - } - } - }, - "CreateAIWorkloadConfigResponse":{ - "type":"structure", - "required":["AIWorkloadConfigArn"], - "members":{ - "AIWorkloadConfigArn":{ - "shape":"AIWorkloadConfigArn", - "documentation":"

The Amazon Resource Name (ARN) of the created AI workload configuration.

" - } - } - }, - "CreateActionRequest":{ - "type":"structure", - "required":[ - "ActionName", - "Source", - "ActionType" - ], - "members":{ - "ActionName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the action. Must be unique to your account in an Amazon Web Services Region.

" - }, - "Source":{ - "shape":"ActionSource", - "documentation":"

The source type, ID, and URI.

" - }, - "ActionType":{ - "shape":"String256", - "documentation":"

The action type.

" - }, - "Description":{ - "shape":"ExperimentDescription", - "documentation":"

The description of the action.

" - }, - "Status":{ - "shape":"ActionStatus", - "documentation":"

The status of the action.

" - }, - "Properties":{ - "shape":"LineageEntityParameters", - "documentation":"

A list of properties to add to the action.

" - }, - "MetadataProperties":{"shape":"MetadataProperties"}, - "Tags":{ - "shape":"TagList", - "documentation":"

A list of tags to apply to the action.

" - } - } - }, - "CreateActionResponse":{ - "type":"structure", - "members":{ - "ActionArn":{ - "shape":"ActionArn", - "documentation":"

The Amazon Resource Name (ARN) of the action.

" - } - } - }, - "CreateAlgorithmInput":{ - "type":"structure", - "required":[ - "AlgorithmName", - "TrainingSpecification" - ], - "members":{ - "AlgorithmName":{ - "shape":"EntityName", - "documentation":"

The name of the algorithm.

" - }, - "AlgorithmDescription":{ - "shape":"EntityDescription", - "documentation":"

A description of the algorithm.

" - }, - "TrainingSpecification":{ - "shape":"TrainingSpecification", - "documentation":"

Specifies details about training jobs run by this algorithm, including the following:

  • The Amazon ECR path of the container and the version digest of the algorithm.

  • The hyperparameters that the algorithm supports.

  • The instance types that the algorithm supports for training.

  • Whether the algorithm supports distributed training.

  • The metrics that the algorithm emits to Amazon CloudWatch.

  • Which metrics that the algorithm emits can be used as the objective metric for hyperparameter tuning jobs.

  • The input channels that the algorithm supports for training data. For example, an algorithm might support train, validation, and test channels.

" - }, - "InferenceSpecification":{ - "shape":"InferenceSpecification", - "documentation":"

Specifies details about inference jobs that the algorithm runs, including the following:

  • The Amazon ECR paths of containers that contain the inference code and model artifacts.

  • The instance types that the algorithm supports for transform jobs and real-time endpoints used for inference.

  • The input and output content formats that the algorithm supports for inference.

" - }, - "ValidationSpecification":{ - "shape":"AlgorithmValidationSpecification", - "documentation":"

Specifies configurations for one or more training jobs and that SageMaker runs to test the algorithm's training code and, optionally, one or more batch transform jobs that SageMaker runs to test the algorithm's inference code.

" - }, - "CertifyForMarketplace":{ - "shape":"CertifyForMarketplace", - "documentation":"

Whether to certify the algorithm so that it can be listed in Amazon Web Services Marketplace.

", - "box":true - }, - "Tags":{ - "shape":"TagList", - "documentation":"

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

" - } - } - }, - "CreateAlgorithmOutput":{ - "type":"structure", - "required":["AlgorithmArn"], - "members":{ - "AlgorithmArn":{ - "shape":"AlgorithmArn", - "documentation":"

The Amazon Resource Name (ARN) of the new algorithm.

" - } - } - }, - "CreateAppImageConfigRequest":{ - "type":"structure", - "required":["AppImageConfigName"], - "members":{ - "AppImageConfigName":{ - "shape":"AppImageConfigName", - "documentation":"

The name of the AppImageConfig. Must be unique to your account.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

A list of tags to apply to the AppImageConfig.

" - }, - "KernelGatewayImageConfig":{ - "shape":"KernelGatewayImageConfig", - "documentation":"

The KernelGatewayImageConfig. You can only specify one image kernel in the AppImageConfig API. This kernel will be shown to users before the image starts. Once the image runs, all kernels are visible in JupyterLab.

" - }, - "JupyterLabAppImageConfig":{ - "shape":"JupyterLabAppImageConfig", - "documentation":"

The JupyterLabAppImageConfig. You can only specify one image kernel in the AppImageConfig API. This kernel is shown to users before the image starts. After the image runs, all kernels are visible in JupyterLab.

" - }, - "CodeEditorAppImageConfig":{ - "shape":"CodeEditorAppImageConfig", - "documentation":"

The CodeEditorAppImageConfig. You can only specify one image kernel in the AppImageConfig API. This kernel is shown to users before the image starts. After the image runs, all kernels are visible in Code Editor.

" - } - } - }, - "CreateAppImageConfigResponse":{ - "type":"structure", - "members":{ - "AppImageConfigArn":{ - "shape":"AppImageConfigArn", - "documentation":"

The ARN of the AppImageConfig.

" - } - } - }, - "CreateAppRequest":{ - "type":"structure", - "required":[ - "DomainId", - "AppType", - "AppName" - ], - "members":{ - "DomainId":{ - "shape":"DomainId", - "documentation":"

The domain ID.

" - }, - "UserProfileName":{ - "shape":"UserProfileName", - "documentation":"

The user profile name. If this value is not set, then SpaceName must be set.

" - }, - "SpaceName":{ - "shape":"SpaceName", - "documentation":"

The name of the space. If this value is not set, then UserProfileName must be set.

" - }, - "AppType":{ - "shape":"AppType", - "documentation":"

The type of app.

" - }, - "AppName":{ - "shape":"AppName", - "documentation":"

The name of the app.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

Each tag consists of a key and an optional value. Tag keys must be unique per resource.

" - }, - "ResourceSpec":{ - "shape":"ResourceSpec", - "documentation":"

The instance type and the Amazon Resource Name (ARN) of the SageMaker AI image created on the instance.

The value of InstanceType passed as part of the ResourceSpec in the CreateApp call overrides the value passed as part of the ResourceSpec configured for the user profile or the domain. If InstanceType is not specified in any of those three ResourceSpec values for a KernelGateway app, the CreateApp call fails with a request validation error.

" - }, - "RecoveryMode":{ - "shape":"Boolean", - "documentation":"

Indicates whether the application is launched in recovery mode.

", - "box":true - } - } - }, - "CreateAppResponse":{ - "type":"structure", - "members":{ - "AppArn":{ - "shape":"AppArn", - "documentation":"

The Amazon Resource Name (ARN) of the app.

" - } - } - }, - "CreateArtifactRequest":{ - "type":"structure", - "required":[ - "Source", - "ArtifactType" - ], - "members":{ - "ArtifactName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the artifact. Must be unique to your account in an Amazon Web Services Region.

" - }, - "Source":{ - "shape":"ArtifactSource", - "documentation":"

The ID, ID type, and URI of the source.

" - }, - "ArtifactType":{ - "shape":"String256", - "documentation":"

The artifact type.

" - }, - "Properties":{ - "shape":"ArtifactProperties", - "documentation":"

A list of properties to add to the artifact.

" - }, - "MetadataProperties":{"shape":"MetadataProperties"}, - "Tags":{ - "shape":"TagList", - "documentation":"

A list of tags to apply to the artifact.

" - } - } - }, - "CreateArtifactResponse":{ - "type":"structure", - "members":{ - "ArtifactArn":{ - "shape":"ArtifactArn", - "documentation":"

The Amazon Resource Name (ARN) of the artifact.

" - } - } - }, - "CreateAutoMLJobRequest":{ - "type":"structure", - "required":[ - "AutoMLJobName", - "InputDataConfig", - "OutputDataConfig", - "RoleArn" - ], - "members":{ - "AutoMLJobName":{ - "shape":"AutoMLJobName", - "documentation":"

Identifies an Autopilot job. The name must be unique to your account and is case insensitive.

" - }, - "InputDataConfig":{ - "shape":"AutoMLInputDataConfig", - "documentation":"

An array of channel objects that describes the input data and its location. Each channel is a named input source. Similar to InputDataConfig supported by HyperParameterTrainingJobDefinition. Format(s) supported: CSV, Parquet. A minimum of 500 rows is required for the training dataset. There is not a minimum number of rows required for the validation dataset.

" - }, - "OutputDataConfig":{ - "shape":"AutoMLOutputDataConfig", - "documentation":"

Provides information about encryption and the Amazon S3 output path needed to store artifacts from an AutoML job. Format(s) supported: CSV.

" - }, - "ProblemType":{ - "shape":"ProblemType", - "documentation":"

Defines the type of supervised learning problem available for the candidates. For more information, see SageMaker Autopilot problem types.

" - }, - "AutoMLJobObjective":{ - "shape":"AutoMLJobObjective", - "documentation":"

Specifies a metric to minimize or maximize as the objective of a job. If not specified, the default objective metric depends on the problem type. See AutoMLJobObjective for the default values.

" - }, - "AutoMLJobConfig":{ - "shape":"AutoMLJobConfig", - "documentation":"

A collection of settings used to configure an AutoML job.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The ARN of the role that is used to access the data.

" - }, - "GenerateCandidateDefinitionsOnly":{ - "shape":"GenerateCandidateDefinitionsOnly", - "documentation":"

Generates possible candidates without training the models. A candidate is a combination of data preprocessors, algorithms, and algorithm parameter settings.

", - "box":true - }, - "Tags":{ - "shape":"TagList", - "documentation":"

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web ServicesResources. Tag keys must be unique per resource.

" - }, - "ModelDeployConfig":{ - "shape":"ModelDeployConfig", - "documentation":"

Specifies how to generate the endpoint name for an automatic one-click Autopilot model deployment.

" - } - } - }, - "CreateAutoMLJobResponse":{ - "type":"structure", - "required":["AutoMLJobArn"], - "members":{ - "AutoMLJobArn":{ - "shape":"AutoMLJobArn", - "documentation":"

The unique ARN assigned to the AutoML job when it is created.

" - } - } - }, - "CreateAutoMLJobV2Request":{ - "type":"structure", - "required":[ - "AutoMLJobName", - "AutoMLJobInputDataConfig", - "OutputDataConfig", - "AutoMLProblemTypeConfig", - "RoleArn" - ], - "members":{ - "AutoMLJobName":{ - "shape":"AutoMLJobName", - "documentation":"

Identifies an Autopilot job. The name must be unique to your account and is case insensitive.

" - }, - "AutoMLJobInputDataConfig":{ - "shape":"AutoMLJobInputDataConfig", - "documentation":"

An array of channel objects describing the input data and their location. Each channel is a named input source. Similar to the InputDataConfig attribute in the CreateAutoMLJob input parameters. The supported formats depend on the problem type:

  • For tabular problem types: S3Prefix, ManifestFile.

  • For image classification: S3Prefix, ManifestFile, AugmentedManifestFile.

  • For text classification: S3Prefix.

  • For time-series forecasting: S3Prefix.

  • For text generation (LLMs fine-tuning): S3Prefix.

" - }, - "OutputDataConfig":{ - "shape":"AutoMLOutputDataConfig", - "documentation":"

Provides information about encryption and the Amazon S3 output path needed to store artifacts from an AutoML job.

" - }, - "AutoMLProblemTypeConfig":{ - "shape":"AutoMLProblemTypeConfig", - "documentation":"

Defines the configuration settings of one of the supported problem types.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The ARN of the role that is used to access the data.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, such as by purpose, owner, or environment. For more information, see Tagging Amazon Web ServicesResources. Tag keys must be unique per resource.

" - }, - "SecurityConfig":{ - "shape":"AutoMLSecurityConfig", - "documentation":"

The security configuration for traffic encryption or Amazon VPC settings.

" - }, - "AutoMLJobObjective":{ - "shape":"AutoMLJobObjective", - "documentation":"

Specifies a metric to minimize or maximize as the objective of a job. If not specified, the default objective metric depends on the problem type. For the list of default values per problem type, see AutoMLJobObjective.

  • For tabular problem types: You must either provide both the AutoMLJobObjective and indicate the type of supervised learning problem in AutoMLProblemTypeConfig (TabularJobConfig.ProblemType), or none at all.

  • For text generation problem types (LLMs fine-tuning): Fine-tuning language models in Autopilot does not require setting the AutoMLJobObjective field. Autopilot fine-tunes LLMs without requiring multiple candidates to be trained and evaluated. Instead, using your dataset, Autopilot directly fine-tunes your target model to enhance a default objective metric, the cross-entropy loss. After fine-tuning a language model, you can evaluate the quality of its generated text using different metrics. For a list of the available metrics, see Metrics for fine-tuning LLMs in Autopilot.

" - }, - "ModelDeployConfig":{ - "shape":"ModelDeployConfig", - "documentation":"

Specifies how to generate the endpoint name for an automatic one-click Autopilot model deployment.

" - }, - "DataSplitConfig":{ - "shape":"AutoMLDataSplitConfig", - "documentation":"

This structure specifies how to split the data into train and validation datasets.

The validation and training datasets must contain the same headers. For jobs created by calling CreateAutoMLJob, the validation dataset must be less than 2 GB in size.

This attribute must not be set for the time-series forecasting problem type, as Autopilot automatically splits the input dataset into training and validation sets.

" - }, - "AutoMLComputeConfig":{ - "shape":"AutoMLComputeConfig", - "documentation":"

Specifies the compute configuration for the AutoML job V2.

" - } - } - }, - "CreateAutoMLJobV2Response":{ - "type":"structure", - "required":["AutoMLJobArn"], - "members":{ - "AutoMLJobArn":{ - "shape":"AutoMLJobArn", - "documentation":"

The unique ARN assigned to the AutoMLJob when it is created.

" - } - } - }, - "CreateClusterRequest":{ - "type":"structure", - "required":["ClusterName"], - "members":{ - "ClusterName":{ - "shape":"ClusterName", - "documentation":"

The name for the new SageMaker HyperPod cluster.

" - }, - "InstanceGroups":{ - "shape":"ClusterInstanceGroupSpecifications", - "documentation":"

The instance groups to be created in the SageMaker HyperPod cluster.

" - }, - "RestrictedInstanceGroups":{ - "shape":"ClusterRestrictedInstanceGroupSpecifications", - "documentation":"

The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.

" - }, - "RestrictedInstanceGroupsConfig":{ - "shape":"ClusterRestrictedInstanceGroupsConfig", - "documentation":"

The configuration for the restricted instance groups (RIG) in the SageMaker HyperPod cluster.

" - }, - "VpcConfig":{ - "shape":"VpcConfig", - "documentation":"

Specifies the Amazon Virtual Private Cloud (VPC) that is associated with the Amazon SageMaker HyperPod cluster. You can control access to and from your resources by configuring your VPC. For more information, see Give SageMaker access to resources in your Amazon VPC.

When your Amazon VPC and subnets support IPv6, network communications differ based on the cluster orchestration platform:

  • Slurm-orchestrated clusters automatically configure nodes with dual IPv6 and IPv4 addresses, allowing immediate IPv6 network communications.

  • In Amazon EKS-orchestrated clusters, nodes receive dual-stack addressing, but pods can only use IPv6 when the Amazon EKS cluster is explicitly IPv6-enabled. For information about deploying an IPv6 Amazon EKS cluster, see Amazon EKS IPv6 Cluster Deployment.

Additional resources for IPv6 configuration:

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource. You can add tags to your cluster in the same way you add them in other Amazon Web Services services that support tagging. To learn more about tagging Amazon Web Services resources in general, see Tagging Amazon Web Services Resources User Guide.

" - }, - "Orchestrator":{ - "shape":"ClusterOrchestrator", - "documentation":"

The type of orchestrator to use for the SageMaker HyperPod cluster. Currently, supported values are \"Eks\" and \"Slurm\", which is to use an Amazon Elastic Kubernetes Service or Slurm cluster as the orchestrator.

If you specify the Orchestrator field, you must provide exactly one orchestrator configuration: either Eks or Slurm. Specifying both or providing an empty configuration returns a validation error.

" - }, - "NodeRecovery":{ - "shape":"ClusterNodeRecovery", - "documentation":"

The node recovery mode for the SageMaker HyperPod cluster. When set to Automatic, SageMaker HyperPod will automatically reboot or replace faulty nodes when issues are detected. When set to None, cluster administrators will need to manually manage any faulty cluster instances.

" - }, - "TieredStorageConfig":{ - "shape":"ClusterTieredStorageConfig", - "documentation":"

The configuration for managed tier checkpointing on the HyperPod cluster. When enabled, this feature uses a multi-tier storage approach for storing model checkpoints, providing faster checkpoint operations and improved fault tolerance across cluster nodes.

" - }, - "NodeProvisioningMode":{ - "shape":"ClusterNodeProvisioningMode", - "documentation":"

The mode for provisioning nodes in the cluster. You can specify the following modes:

  • Continuous: Scaling behavior that enables 1) concurrent operation execution within instance groups, 2) continuous retry mechanisms for failed operations, 3) enhanced customer visibility into cluster events through detailed event streams, 4) partial provisioning capabilities. Your clusters and instance groups remain InService while scaling. This mode is only supported for EKS orchestrated clusters.

" - }, - "ClusterRole":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the IAM role that HyperPod assumes to perform cluster autoscaling operations. This role must have permissions for sagemaker:BatchAddClusterNodes and sagemaker:BatchDeleteClusterNodes. This is only required when autoscaling is enabled and when HyperPod is performing autoscaling operations.

" - }, - "AutoScaling":{ - "shape":"ClusterAutoScalingConfig", - "documentation":"

The autoscaling configuration for the cluster. Enables automatic scaling of cluster nodes based on workload demand using a Karpenter-based system.

" - } - } - }, - "CreateClusterResponse":{ - "type":"structure", - "required":["ClusterArn"], - "members":{ - "ClusterArn":{ - "shape":"ClusterArn", - "documentation":"

The Amazon Resource Name (ARN) of the cluster.

" - } - } - }, - "CreateClusterSchedulerConfigRequest":{ - "type":"structure", - "required":[ - "Name", - "ClusterArn", - "SchedulerConfig" - ], - "members":{ - "Name":{ - "shape":"EntityName", - "documentation":"

Name for the cluster policy.

" - }, - "ClusterArn":{ - "shape":"ClusterArn", - "documentation":"

ARN of the cluster.

" - }, - "SchedulerConfig":{ - "shape":"SchedulerConfig", - "documentation":"

Configuration about the monitoring schedule.

" - }, - "Description":{ - "shape":"EntityDescription", - "documentation":"

Description of the cluster policy.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

Tags of the cluster policy.

" - } - } - }, - "CreateClusterSchedulerConfigResponse":{ - "type":"structure", - "required":[ - "ClusterSchedulerConfigArn", - "ClusterSchedulerConfigId" - ], - "members":{ - "ClusterSchedulerConfigArn":{ - "shape":"ClusterSchedulerConfigArn", - "documentation":"

ARN of the cluster policy.

" - }, - "ClusterSchedulerConfigId":{ - "shape":"ClusterSchedulerConfigId", - "documentation":"

ID of the cluster policy.

" - } - } - }, - "CreateCodeRepositoryInput":{ - "type":"structure", - "required":[ - "CodeRepositoryName", - "GitConfig" - ], - "members":{ - "CodeRepositoryName":{ - "shape":"EntityName", - "documentation":"

The name of the Git repository. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

" - }, - "GitConfig":{ - "shape":"GitConfig", - "documentation":"

Specifies details about the repository, including the URL where the repository is located, the default branch, and credentials to use to access the repository.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

" - } - } - }, - "CreateCodeRepositoryOutput":{ - "type":"structure", - "required":["CodeRepositoryArn"], - "members":{ - "CodeRepositoryArn":{ - "shape":"CodeRepositoryArn", - "documentation":"

The Amazon Resource Name (ARN) of the new repository.

" - } - } - }, - "CreateCompilationJobRequest":{ - "type":"structure", - "required":[ - "CompilationJobName", - "RoleArn", - "OutputConfig", - "StoppingCondition" - ], - "members":{ - "CompilationJobName":{ - "shape":"EntityName", - "documentation":"

A name for the model compilation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.

During model compilation, Amazon SageMaker AI needs your permission to:

  • Read input data from an S3 bucket

  • Write model artifacts to an S3 bucket

  • Write logs to Amazon CloudWatch Logs

  • Publish metrics to Amazon CloudWatch

You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker AI, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker AI Roles.

" - }, - "ModelPackageVersionArn":{ - "shape":"ModelPackageArn", - "documentation":"

The Amazon Resource Name (ARN) of a versioned model package. Provide either a ModelPackageVersionArn or an InputConfig object in the request syntax. The presence of both objects in the CreateCompilationJob request will return an exception.

" - }, - "InputConfig":{ - "shape":"InputConfig", - "documentation":"

Provides information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

" - }, - "OutputConfig":{ - "shape":"OutputConfig", - "documentation":"

Provides information about the output location for the compiled model and the target device the model runs on.

" - }, - "VpcConfig":{ - "shape":"NeoVpcConfig", - "documentation":"

A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.

" - }, - "StoppingCondition":{ - "shape":"StoppingCondition", - "documentation":"

Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker AI ends the compilation job. Use this API to cap model training costs.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

" - } - } - }, - "CreateCompilationJobResponse":{ - "type":"structure", - "required":["CompilationJobArn"], - "members":{ - "CompilationJobArn":{ - "shape":"CompilationJobArn", - "documentation":"

If the action is successful, the service sends back an HTTP 200 response. Amazon SageMaker AI returns the following data in JSON format:

  • CompilationJobArn: The Amazon Resource Name (ARN) of the compiled job.

" - } - } - }, - "CreateComputeQuotaRequest":{ - "type":"structure", - "required":[ - "Name", - "ClusterArn", - "ComputeQuotaConfig", - "ComputeQuotaTarget" - ], - "members":{ - "Name":{ - "shape":"EntityName", - "documentation":"

Name to the compute allocation definition.

" - }, - "Description":{ - "shape":"EntityDescription", - "documentation":"

Description of the compute allocation definition.

" - }, - "ClusterArn":{ - "shape":"ClusterArn", - "documentation":"

ARN of the cluster.

" - }, - "ComputeQuotaConfig":{ - "shape":"ComputeQuotaConfig", - "documentation":"

Configuration of the compute allocation definition. This includes the resource sharing option, and the setting to preempt low priority tasks.

" - }, - "ComputeQuotaTarget":{ - "shape":"ComputeQuotaTarget", - "documentation":"

The target entity to allocate compute resources to.

" - }, - "ActivationState":{ - "shape":"ActivationState", - "documentation":"

The state of the compute allocation being described. Use to enable or disable compute allocation.

Default is Enabled.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

Tags of the compute allocation definition.

" - } - } - }, - "CreateComputeQuotaResponse":{ - "type":"structure", - "required":[ - "ComputeQuotaArn", - "ComputeQuotaId" - ], - "members":{ - "ComputeQuotaArn":{ - "shape":"ComputeQuotaArn", - "documentation":"

ARN of the compute allocation definition.

" - }, - "ComputeQuotaId":{ - "shape":"ComputeQuotaId", - "documentation":"

ID of the compute allocation definition.

" - } - } - }, - "CreateContextRequest":{ - "type":"structure", - "required":[ - "ContextName", - "Source", - "ContextType" - ], - "members":{ - "ContextName":{ - "shape":"ContextName", - "documentation":"

The name of the context. Must be unique to your account in an Amazon Web Services Region.

" - }, - "Source":{ - "shape":"ContextSource", - "documentation":"

The source type, ID, and URI.

" - }, - "ContextType":{ - "shape":"String256", - "documentation":"

The context type.

" - }, - "Description":{ - "shape":"ExperimentDescription", - "documentation":"

The description of the context.

" - }, - "Properties":{ - "shape":"LineageEntityParameters", - "documentation":"

A list of properties to add to the context.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

A list of tags to apply to the context.

" - } - } - }, - "CreateContextResponse":{ - "type":"structure", - "members":{ - "ContextArn":{ - "shape":"ContextArn", - "documentation":"

The Amazon Resource Name (ARN) of the context.

" - } - } - }, - "CreateDataQualityJobDefinitionRequest":{ - "type":"structure", - "required":[ - "JobDefinitionName", - "DataQualityAppSpecification", - "DataQualityJobInput", - "DataQualityJobOutputConfig", - "JobResources", - "RoleArn" - ], - "members":{ - "JobDefinitionName":{ - "shape":"MonitoringJobDefinitionName", - "documentation":"

The name for the monitoring job definition.

" - }, - "DataQualityBaselineConfig":{ - "shape":"DataQualityBaselineConfig", - "documentation":"

Configures the constraints and baselines for the monitoring job.

" - }, - "DataQualityAppSpecification":{ - "shape":"DataQualityAppSpecification", - "documentation":"

Specifies the container that runs the monitoring job.

" - }, - "DataQualityJobInput":{ - "shape":"DataQualityJobInput", - "documentation":"

A list of inputs for the monitoring job. Currently endpoints are supported as monitoring inputs.

" - }, - "DataQualityJobOutputConfig":{"shape":"MonitoringOutputConfig"}, - "JobResources":{"shape":"MonitoringResources"}, - "NetworkConfig":{ - "shape":"MonitoringNetworkConfig", - "documentation":"

Specifies networking configuration for the monitoring job.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.

" - }, - "StoppingCondition":{"shape":"MonitoringStoppingCondition"}, - "Tags":{ - "shape":"TagList", - "documentation":"

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

" - } - } - }, - "CreateDataQualityJobDefinitionResponse":{ - "type":"structure", - "required":["JobDefinitionArn"], - "members":{ - "JobDefinitionArn":{ - "shape":"MonitoringJobDefinitionArn", - "documentation":"

The Amazon Resource Name (ARN) of the job definition.

" - } - } - }, - "CreateDeviceFleetRequest":{ - "type":"structure", - "required":[ - "DeviceFleetName", - "OutputConfig" - ], - "members":{ - "DeviceFleetName":{ - "shape":"EntityName", - "documentation":"

The name of the fleet that the device belongs to.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).

" - }, - "Description":{ - "shape":"DeviceFleetDescription", - "documentation":"

A description of the fleet.

" - }, - "OutputConfig":{ - "shape":"EdgeOutputConfig", - "documentation":"

The output configuration for storing sample data collected by the fleet.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

Creates tags for the specified fleet.

" - }, - "EnableIotRoleAlias":{ - "shape":"EnableIotRoleAlias", - "documentation":"

Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. The name of the role alias generated will match this pattern: \"SageMakerEdge-{DeviceFleetName}\".

For example, if your device fleet is called \"demo-fleet\", the name of the role alias will be \"SageMakerEdge-demo-fleet\".

" - } - } - }, - "CreateDomainRequest":{ - "type":"structure", - "required":[ - "DomainName", - "AuthMode", - "DefaultUserSettings" - ], - "members":{ - "DomainName":{ - "shape":"DomainName", - "documentation":"

A name for the domain.

" - }, - "AuthMode":{ - "shape":"AuthMode", - "documentation":"

The mode of authentication that members use to access the domain.

" - }, - "DefaultUserSettings":{ - "shape":"UserSettings", - "documentation":"

The default settings to use to create a user profile when UserSettings isn't specified in the call to the CreateUserProfile API.

SecurityGroups is aggregated when specified in both calls. For all other settings in UserSettings, the values specified in CreateUserProfile take precedence over those specified in CreateDomain.

" - }, - "DomainSettings":{ - "shape":"DomainSettings", - "documentation":"

A collection of Domain settings.

" - }, - "SubnetIds":{ - "shape":"Subnets", - "documentation":"

The VPC subnets that the domain uses for communication.

The field is optional when the AppNetworkAccessType parameter is set to PublicInternetOnly for domains created from Amazon SageMaker Unified Studio.

" - }, - "VpcId":{ - "shape":"VpcId", - "documentation":"

The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

The field is optional when the AppNetworkAccessType parameter is set to PublicInternetOnly for domains created from Amazon SageMaker Unified Studio.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.

Tags that you specify for the Domain are also added to all Apps that the Domain launches.

" - }, - "AppNetworkAccessType":{ - "shape":"AppNetworkAccessType", - "documentation":"

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.

  • PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access

  • VpcOnly - All traffic is through the specified VPC and subnets

" - }, - "HomeEfsFileSystemKmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

Use KmsKeyId.

", - "deprecated":true, - "deprecatedMessage":"This property is deprecated, use KmsKeyId instead." - }, - "KmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

SageMaker AI uses Amazon Web Services KMS to encrypt EFS and EBS volumes attached to the domain with an Amazon Web Services managed key by default. For more control, specify a customer managed key.

" - }, - "AppSecurityGroupManagement":{ - "shape":"AppSecurityGroupManagement", - "documentation":"

The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided. If setting up the domain for use with RStudio, this value must be set to Service.

" - }, - "HomeEfsFileSystemCreation":{ - "shape":"HomeEfsFileSystemCreation", - "documentation":"

Indicates whether to create a home EFS file system for the domain. Defaults to Enabled. Set to Disabled to skip EFS creation and reduce domain creation time. You can enable EFS later by calling UpdateDomain.

" - }, - "TagPropagation":{ - "shape":"TagPropagation", - "documentation":"

Indicates whether custom tag propagation is supported for the domain. Defaults to DISABLED.

" - }, - "DefaultSpaceSettings":{ - "shape":"DefaultSpaceSettings", - "documentation":"

The default settings for shared spaces that users create in the domain.

" - } - } - }, - "CreateDomainResponse":{ - "type":"structure", - "members":{ - "DomainArn":{ - "shape":"DomainArn", - "documentation":"

The Amazon Resource Name (ARN) of the created domain.

" - }, - "DomainId":{ - "shape":"DomainId", - "documentation":"

The ID of the created domain.

" - }, - "Url":{ - "shape":"String1024", - "documentation":"

The URL to the created domain.

" - } - } - }, - "CreateEdgeDeploymentPlanRequest":{ - "type":"structure", - "required":[ - "EdgeDeploymentPlanName", - "ModelConfigs", - "DeviceFleetName" - ], - "members":{ - "EdgeDeploymentPlanName":{ - "shape":"EntityName", - "documentation":"

The name of the edge deployment plan.

" - }, - "ModelConfigs":{ - "shape":"EdgeDeploymentModelConfigs", - "documentation":"

List of models associated with the edge deployment plan.

" - }, - "DeviceFleetName":{ - "shape":"EntityName", - "documentation":"

The device fleet used for this edge deployment plan.

" - }, - "Stages":{ - "shape":"DeploymentStages", - "documentation":"

List of stages of the edge deployment plan. The number of stages is limited to 10 per deployment.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

List of tags with which to tag the edge deployment plan.

" - } - } - }, - "CreateEdgeDeploymentPlanResponse":{ - "type":"structure", - "required":["EdgeDeploymentPlanArn"], - "members":{ - "EdgeDeploymentPlanArn":{ - "shape":"EdgeDeploymentPlanArn", - "documentation":"

The ARN of the edge deployment plan.

" - } - } - }, - "CreateEdgeDeploymentStageRequest":{ - "type":"structure", - "required":[ - "EdgeDeploymentPlanName", - "Stages" - ], - "members":{ - "EdgeDeploymentPlanName":{ - "shape":"EntityName", - "documentation":"

The name of the edge deployment plan.

" - }, - "Stages":{ - "shape":"DeploymentStages", - "documentation":"

List of stages to be added to the edge deployment plan.

" - } - } - }, - "CreateEdgePackagingJobRequest":{ - "type":"structure", - "required":[ - "EdgePackagingJobName", - "CompilationJobName", - "ModelName", - "ModelVersion", - "RoleArn", - "OutputConfig" - ], - "members":{ - "EdgePackagingJobName":{ - "shape":"EntityName", - "documentation":"

The name of the edge packaging job.

" - }, - "CompilationJobName":{ - "shape":"EntityName", - "documentation":"

The name of the SageMaker Neo compilation job that will be used to locate model artifacts for packaging.

" - }, - "ModelName":{ - "shape":"EntityName", - "documentation":"

The name of the model.

" - }, - "ModelVersion":{ - "shape":"EdgeVersion", - "documentation":"

The version of the model.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact SageMaker Neo.

" - }, - "OutputConfig":{ - "shape":"EdgeOutputConfig", - "documentation":"

Provides information about the output location for the packaged model.

" - }, - "ResourceKey":{ - "shape":"KmsKeyId", - "documentation":"

The Amazon Web Services KMS key to use when encrypting the EBS volume the edge packaging job runs on.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

Creates tags for the packaging job.

" - } - } - }, - "CreateEndpointConfigInput":{ - "type":"structure", - "required":[ - "EndpointConfigName", - "ProductionVariants" - ], - "members":{ - "EndpointConfigName":{ - "shape":"EndpointConfigName", - "documentation":"

The name of the endpoint configuration. You specify this name in a CreateEndpoint request.

" - }, - "ProductionVariants":{ - "shape":"ProductionVariantList", - "documentation":"

An array of ProductionVariant objects, one for each model that you want to host at this endpoint.

" - }, - "DataCaptureConfig":{"shape":"DataCaptureConfig"}, - "Tags":{ - "shape":"TagList", - "documentation":"

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

" - }, - "KmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.

The KmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint, UpdateEndpoint requests. For more information, refer to the Amazon Web Services Key Management Service section Using Key Policies in Amazon Web Services KMS

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. If any of the models that you specify in the ProductionVariants parameter use nitro-based instances with local storage, the KmsKeyId parameter does not encrypt instance local storage.

For a list of instance types that support local instance storage, see Instance Store Volumes.

For more information about local instance storage encryption, see SSD Instance Store Volumes.

" - }, - "AsyncInferenceConfig":{ - "shape":"AsyncInferenceConfig", - "documentation":"

Specifies configuration for how an endpoint performs asynchronous inference. This is a required field in order for your Endpoint to be invoked using InvokeEndpointAsync.

" - }, - "ExplainerConfig":{ - "shape":"ExplainerConfig", - "documentation":"

A member of CreateEndpointConfig that enables explainers.

" - }, - "ShadowProductionVariants":{ - "shape":"ProductionVariantList", - "documentation":"

An array of ProductionVariant objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants. If you use this field, you can only specify one variant for ProductionVariants and one variant for ShadowProductionVariants.

" - }, - "ExecutionRoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform actions on your behalf. For more information, see SageMaker AI Roles.

To be able to pass this role to Amazon SageMaker AI, the caller of this action must have the iam:PassRole permission.

" - }, - "VpcConfig":{"shape":"VpcConfig"}, - "EnableNetworkIsolation":{ - "shape":"Boolean", - "documentation":"

Sets whether all model containers deployed to the endpoint are isolated. If they are, no inbound or outbound network calls can be made to or from the model containers.

", - "box":true - }, - "MetricsConfig":{ - "shape":"MetricsConfig", - "documentation":"

The configuration parameters for utilization metrics.

" - } - } - }, - "CreateEndpointConfigOutput":{ - "type":"structure", - "required":["EndpointConfigArn"], - "members":{ - "EndpointConfigArn":{ - "shape":"EndpointConfigArn", - "documentation":"

The Amazon Resource Name (ARN) of the endpoint configuration.

" - } - } - }, - "CreateEndpointInput":{ - "type":"structure", - "required":[ - "EndpointName", - "EndpointConfigName" - ], - "members":{ - "EndpointName":{ - "shape":"EndpointName", - "documentation":"

The name of the endpoint.The name must be unique within an Amazon Web Services Region in your Amazon Web Services account. The name is case-insensitive in CreateEndpoint, but the case is preserved and must be matched in InvokeEndpoint.

" - }, - "EndpointConfigName":{ - "shape":"EndpointConfigName", - "documentation":"

The name of an endpoint configuration. For more information, see CreateEndpointConfig.

" - }, - "DeploymentConfig":{"shape":"DeploymentConfig"}, - "Tags":{ - "shape":"TagList", - "documentation":"

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

" - } - } - }, - "CreateEndpointOutput":{ - "type":"structure", - "required":["EndpointArn"], - "members":{ - "EndpointArn":{ - "shape":"EndpointArn", - "documentation":"

The Amazon Resource Name (ARN) of the endpoint.

" - } - } - }, - "CreateExperimentRequest":{ - "type":"structure", - "required":["ExperimentName"], - "members":{ - "ExperimentName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the experiment. The name must be unique in your Amazon Web Services account and is not case-sensitive.

" - }, - "DisplayName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the experiment as displayed. The name doesn't need to be unique. If you don't specify DisplayName, the value in ExperimentName is displayed.

" - }, - "Description":{ - "shape":"ExperimentDescription", - "documentation":"

The description of the experiment.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

A list of tags to associate with the experiment. You can use Search API to search on the tags.

" - } - } - }, - "CreateExperimentResponse":{ - "type":"structure", - "members":{ - "ExperimentArn":{ - "shape":"ExperimentArn", - "documentation":"

The Amazon Resource Name (ARN) of the experiment.

" - } - } - }, - "CreateFeatureGroupRequest":{ - "type":"structure", - "required":[ - "FeatureGroupName", - "RecordIdentifierFeatureName", - "EventTimeFeatureName", - "FeatureDefinitions" - ], - "members":{ - "FeatureGroupName":{ - "shape":"FeatureGroupName", - "documentation":"

The name of the FeatureGroup. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

The name:

  • Must start with an alphanumeric character.

  • Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed.

" - }, - "RecordIdentifierFeatureName":{ - "shape":"FeatureName", - "documentation":"

The name of the Feature whose value uniquely identifies a Record defined in the FeatureStore. Only the latest record per identifier value will be stored in the OnlineStore. RecordIdentifierFeatureName must be one of feature definitions' names.

You use the RecordIdentifierFeatureName to access data in a FeatureStore.

This name:

  • Must start with an alphanumeric character.

  • Can only contains alphanumeric characters, hyphens, underscores. Spaces are not allowed.

" - }, - "EventTimeFeatureName":{ - "shape":"FeatureName", - "documentation":"

The name of the feature that stores the EventTime of a Record in a FeatureGroup.

An EventTime is a point in time when a new event occurs that corresponds to the creation or update of a Record in a FeatureGroup. All Records in the FeatureGroup must have a corresponding EventTime.

An EventTime can be a String or Fractional.

  • Fractional: EventTime feature values must be a Unix timestamp in seconds.

  • String: EventTime feature values must be an ISO-8601 string in the format. The following formats are supported yyyy-MM-dd'T'HH:mm:ssZ and yyyy-MM-dd'T'HH:mm:ss.SSSZ where yyyy, MM, and dd represent the year, month, and day respectively and HH, mm, ss, and if applicable, SSS represent the hour, month, second and milliseconds respsectively. 'T' and Z are constants.

" - }, - "FeatureDefinitions":{ - "shape":"FeatureDefinitions", - "documentation":"

A list of Feature names and types. Name and Type is compulsory per Feature.

Valid feature FeatureTypes are Integral, Fractional and String.

FeatureNames cannot be any of the following: is_deleted, write_time, api_invocation_time

You can create up to 2,500 FeatureDefinitions per FeatureGroup.

" - }, - "OnlineStoreConfig":{ - "shape":"OnlineStoreConfig", - "documentation":"

You can turn the OnlineStore on or off by specifying True for the EnableOnlineStore flag in OnlineStoreConfig.

You can also include an Amazon Web Services KMS key ID (KMSKeyId) for at-rest encryption of the OnlineStore.

The default value is False.

" - }, - "OfflineStoreConfig":{ - "shape":"OfflineStoreConfig", - "documentation":"

Use this to configure an OfflineFeatureStore. This parameter allows you to specify:

  • The Amazon Simple Storage Service (Amazon S3) location of an OfflineStore.

  • A configuration for an Amazon Web Services Glue or Amazon Web Services Hive data catalog.

  • An KMS encryption key to encrypt the Amazon S3 location used for OfflineStore. If KMS encryption key is not specified, by default we encrypt all data at rest using Amazon Web Services KMS key. By defining your bucket-level key for SSE, you can reduce Amazon Web Services KMS requests costs by up to 99 percent.

  • Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.

To learn more about this parameter, see OfflineStoreConfig.

" - }, - "ThroughputConfig":{"shape":"ThroughputConfig"}, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.

" - }, - "Description":{ - "shape":"Description", - "documentation":"

A free-form description of a FeatureGroup.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

Tags used to identify Features in each FeatureGroup.

" - } - } - }, - "CreateFeatureGroupResponse":{ - "type":"structure", - "required":["FeatureGroupArn"], - "members":{ - "FeatureGroupArn":{ - "shape":"FeatureGroupArn", - "documentation":"

The Amazon Resource Name (ARN) of the FeatureGroup. This is a unique identifier for the feature group.

" - } - } - }, - "CreateFlowDefinitionRequest":{ - "type":"structure", - "required":[ - "FlowDefinitionName", - "OutputConfig", - "RoleArn" - ], - "members":{ - "FlowDefinitionName":{ - "shape":"FlowDefinitionName", - "documentation":"

The name of your flow definition.

" - }, - "HumanLoopRequestSource":{ - "shape":"HumanLoopRequestSource", - "documentation":"

Container for configuring the source of human task requests. Use to specify if Amazon Rekognition or Amazon Textract is used as an integration source.

" - }, - "HumanLoopActivationConfig":{ - "shape":"HumanLoopActivationConfig", - "documentation":"

An object containing information about the events that trigger a human workflow.

" - }, - "HumanLoopConfig":{ - "shape":"HumanLoopConfig", - "documentation":"

An object containing information about the tasks the human reviewers will perform.

" - }, - "OutputConfig":{ - "shape":"FlowDefinitionOutputConfig", - "documentation":"

An object containing information about where the human review results will be uploaded.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the role needed to call other services on your behalf. For example, arn:aws:iam::1234567890:role/service-role/AmazonSageMaker-ExecutionRole-20180111T151298.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

An array of key-value pairs that contain metadata to help you categorize and organize a flow definition. Each tag consists of a key and a value, both of which you define.

" - } - } - }, - "CreateFlowDefinitionResponse":{ - "type":"structure", - "required":["FlowDefinitionArn"], - "members":{ - "FlowDefinitionArn":{ - "shape":"FlowDefinitionArn", - "documentation":"

The Amazon Resource Name (ARN) of the flow definition you create.

" - } - } - }, - "CreateHubContentPresignedUrlsRequest":{ - "type":"structure", - "required":[ - "HubName", - "HubContentType", - "HubContentName" - ], - "members":{ - "HubName":{ - "shape":"HubNameOrArn", - "documentation":"

The name or Amazon Resource Name (ARN) of the hub that contains the content. For public content, use SageMakerPublicHub.

" - }, - "HubContentType":{ - "shape":"HubContentType", - "documentation":"

The type of hub content to access. Valid values include Model, Notebook, and ModelReference.

" - }, - "HubContentName":{ - "shape":"HubContentName", - "documentation":"

The name of the hub content for which to generate presigned URLs. This identifies the specific model or content within the hub.

" - }, - "HubContentVersion":{ - "shape":"HubContentVersion", - "documentation":"

The version of the hub content. If not specified, the latest version is used.

" - }, - "AccessConfig":{ - "shape":"PresignedUrlAccessConfig", - "documentation":"

Configuration settings for accessing the hub content, including end-user license agreement acceptance for gated models and expected S3 URL validation.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of presigned URLs to return in the response. Default value is 100. Large models may contain hundreds of files, requiring pagination to retrieve all URLs.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

A token for pagination. Use this token to retrieve the next set of presigned URLs when the response is truncated.

" - } - } - }, - "CreateHubContentPresignedUrlsResponse":{ - "type":"structure", - "required":["AuthorizedUrlConfigs"], - "members":{ - "AuthorizedUrlConfigs":{ - "shape":"AuthorizedUrlConfigs", - "documentation":"

An array of authorized URL configurations, each containing a presigned URL and its corresponding local file path for proper file organization during download.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

A token for pagination. If present, indicates that more presigned URLs are available. Use this token in a subsequent request to retrieve additional URLs.

" - } - } - }, - "CreateHubContentReferenceRequest":{ - "type":"structure", - "required":[ - "HubName", - "SageMakerPublicHubContentArn" - ], - "members":{ - "HubName":{ - "shape":"HubNameOrArn", - "documentation":"

The name of the hub to add the hub content reference to.

" - }, - "SageMakerPublicHubContentArn":{ - "shape":"SageMakerPublicHubContentArn", - "documentation":"

The ARN of the public hub content to reference.

" - }, - "HubContentName":{ - "shape":"HubContentName", - "documentation":"

The name of the hub content to reference.

" - }, - "MinVersion":{ - "shape":"HubContentVersion", - "documentation":"

The minimum version of the hub content to reference.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

Any tags associated with the hub content to reference.

" - } - } - }, - "CreateHubContentReferenceResponse":{ - "type":"structure", - "required":[ - "HubArn", - "HubContentArn" - ], - "members":{ - "HubArn":{ - "shape":"HubArn", - "documentation":"

The ARN of the hub that the hub content reference was added to.

" - }, - "HubContentArn":{ - "shape":"HubContentArn", - "documentation":"

The ARN of the hub content.

" - } - } - }, - "CreateHubRequest":{ - "type":"structure", - "required":[ - "HubName", - "HubDescription" - ], - "members":{ - "HubName":{ - "shape":"HubName", - "documentation":"

The name of the hub to create.

" - }, - "HubDescription":{ - "shape":"HubDescription", - "documentation":"

A description of the hub.

" - }, - "HubDisplayName":{ - "shape":"HubDisplayName", - "documentation":"

The display name of the hub.

" - }, - "HubSearchKeywords":{ - "shape":"HubSearchKeywordList", - "documentation":"

The searchable keywords for the hub.

" - }, - "S3StorageConfig":{ - "shape":"HubS3StorageConfig", - "documentation":"

The Amazon S3 storage configuration for the hub.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

Any tags to associate with the hub.

" - } - } - }, - "CreateHubResponse":{ - "type":"structure", - "required":["HubArn"], - "members":{ - "HubArn":{ - "shape":"HubArn", - "documentation":"

The Amazon Resource Name (ARN) of the hub.

" - } - } - }, - "CreateHumanTaskUiRequest":{ - "type":"structure", - "required":[ - "HumanTaskUiName", - "UiTemplate" - ], - "members":{ - "HumanTaskUiName":{ - "shape":"HumanTaskUiName", - "documentation":"

The name of the user interface you are creating.

" - }, - "UiTemplate":{"shape":"UiTemplate"}, - "Tags":{ - "shape":"TagList", - "documentation":"

An array of key-value pairs that contain metadata to help you categorize and organize a human review workflow user interface. Each tag consists of a key and a value, both of which you define.

" - } - } - }, - "CreateHumanTaskUiResponse":{ - "type":"structure", - "required":["HumanTaskUiArn"], - "members":{ - "HumanTaskUiArn":{ - "shape":"HumanTaskUiArn", - "documentation":"

The Amazon Resource Name (ARN) of the human review workflow user interface you create.

" - } - } - }, - "CreateHyperParameterTuningJobRequest":{ - "type":"structure", - "required":[ - "HyperParameterTuningJobName", - "HyperParameterTuningJobConfig" - ], - "members":{ - "HyperParameterTuningJobName":{ - "shape":"HyperParameterTuningJobName", - "documentation":"

The name of the tuning job. This name is the prefix for the names of all training jobs that this tuning job launches. The name must be unique within the same Amazon Web Services account and Amazon Web Services Region. The name must have 1 to 32 characters. Valid characters are a-z, A-Z, 0-9, and : + = @ _ % - (hyphen). The name is not case sensitive.

" - }, - "HyperParameterTuningJobConfig":{ - "shape":"HyperParameterTuningJobConfig", - "documentation":"

The HyperParameterTuningJobConfig object that describes the tuning job, including the search strategy, the objective metric used to evaluate training jobs, ranges of parameters to search, and resource limits for the tuning job. For more information, see How Hyperparameter Tuning Works.

" - }, - "TrainingJobDefinition":{ - "shape":"HyperParameterTrainingJobDefinition", - "documentation":"

The HyperParameterTrainingJobDefinition object that describes the training jobs that this tuning job launches, including static hyperparameters, input data configuration, output data configuration, resource configuration, and stopping condition.

" - }, - "TrainingJobDefinitions":{ - "shape":"HyperParameterTrainingJobDefinitions", - "documentation":"

A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.

" - }, - "WarmStartConfig":{ - "shape":"HyperParameterTuningJobWarmStartConfig", - "documentation":"

Specifies the configuration for starting the hyperparameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

All training jobs launched by the new hyperparameter tuning job are evaluated by using the objective metric. If you specify IDENTICAL_DATA_AND_ALGORITHM as the WarmStartType value for the warm start configuration, the training job that performs the best in the new tuning job is compared to the best training jobs from the parent tuning jobs. From these, the training job that performs the best as measured by the objective metric is returned as the overall best training job.

All training jobs launched by parent hyperparameter tuning jobs and the new hyperparameter tuning jobs count against the limit of training jobs for the tuning job.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

Tags that you specify for the tuning job are also added to all training jobs that the tuning job launches.

" - }, - "Autotune":{ - "shape":"Autotune", - "documentation":"

Configures SageMaker Automatic model tuning (AMT) to automatically find optimal parameters for the following fields:

  • ParameterRanges: The names and ranges of parameters that a hyperparameter tuning job can optimize.

  • ResourceLimits: The maximum resources that can be used for a training job. These resources include the maximum number of training jobs, the maximum runtime of a tuning job, and the maximum number of training jobs to run at the same time.

  • TrainingJobEarlyStoppingType: A flag that specifies whether or not to use early stopping for training jobs launched by a hyperparameter tuning job.

  • RetryStrategy: The number of times to retry a training job.

  • Strategy: Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training jobs that it launches.

  • ConvergenceDetected: A flag to indicate that Automatic model tuning (AMT) has detected model convergence.

" - } - } - }, - "CreateHyperParameterTuningJobResponse":{ - "type":"structure", - "required":["HyperParameterTuningJobArn"], - "members":{ - "HyperParameterTuningJobArn":{ - "shape":"HyperParameterTuningJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the tuning job. SageMaker assigns an ARN to a hyperparameter tuning job when you create it.

" - } - } - }, - "CreateImageRequest":{ - "type":"structure", - "required":[ - "ImageName", - "RoleArn" - ], - "members":{ - "Description":{ - "shape":"ImageDescription", - "documentation":"

The description of the image.

" - }, - "DisplayName":{ - "shape":"ImageDisplayName", - "documentation":"

The display name of the image. If not provided, ImageName is displayed.

" - }, - "ImageName":{ - "shape":"ImageName", - "documentation":"

The name of the image. Must be unique to your account.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The ARN of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

A list of tags to apply to the image.

" - } - } - }, - "CreateImageResponse":{ - "type":"structure", - "members":{ - "ImageArn":{ - "shape":"ImageArn", - "documentation":"

The ARN of the image.

" - } - } - }, - "CreateImageVersionRequest":{ - "type":"structure", - "required":[ - "BaseImage", - "ClientToken", - "ImageName" - ], - "members":{ - "BaseImage":{ - "shape":"ImageBaseImage", - "documentation":"

The registry path of the container image to use as the starting point for this version. The path is an Amazon ECR URI in the following format:

<acct-id>.dkr.ecr.<region>.amazonaws.com/<repo-name[:tag] or [@digest]>

" - }, - "ClientToken":{ - "shape":"ClientToken", - "documentation":"

A unique ID. If not specified, the Amazon Web Services CLI and Amazon Web Services SDKs, such as the SDK for Python (Boto3), add a unique value to the call.

", - "idempotencyToken":true - }, - "ImageName":{ - "shape":"ImageName", - "documentation":"

The ImageName of the Image to create a version of.

" - }, - "Aliases":{ - "shape":"SageMakerImageVersionAliases", - "documentation":"

A list of aliases created with the image version.

" - }, - "VendorGuidance":{ - "shape":"VendorGuidance", - "documentation":"

The stability of the image version, specified by the maintainer.

  • NOT_PROVIDED: The maintainers did not provide a status for image version stability.

  • STABLE: The image version is stable.

  • TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

  • ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

" - }, - "JobType":{ - "shape":"JobType", - "documentation":"

Indicates SageMaker AI job type compatibility.

  • TRAINING: The image version is compatible with SageMaker AI training jobs.

  • INFERENCE: The image version is compatible with SageMaker AI inference jobs.

  • NOTEBOOK_KERNEL: The image version is compatible with SageMaker AI notebook kernels.

" - }, - "MLFramework":{ - "shape":"MLFramework", - "documentation":"

The machine learning framework vended in the image version.

" - }, - "ProgrammingLang":{ - "shape":"ProgrammingLang", - "documentation":"

The supported programming language and its version.

" - }, - "Processor":{ - "shape":"Processor", - "documentation":"

Indicates CPU or GPU compatibility.

  • CPU: The image version is compatible with CPU.

  • GPU: The image version is compatible with GPU.

" - }, - "Horovod":{ - "shape":"Horovod", - "documentation":"

Indicates Horovod compatibility.

", - "box":true - }, - "ReleaseNotes":{ - "shape":"ReleaseNotes", - "documentation":"

The maintainer description of the image version.

" - } - } - }, - "CreateImageVersionResponse":{ - "type":"structure", - "members":{ - "ImageVersionArn":{ - "shape":"ImageVersionArn", - "documentation":"

The ARN of the image version.

" - } - } - }, - "CreateInferenceComponentInput":{ - "type":"structure", - "required":[ - "InferenceComponentName", - "EndpointName" - ], - "members":{ - "InferenceComponentName":{ - "shape":"InferenceComponentName", - "documentation":"

A unique name to assign to the inference component.

" - }, - "EndpointName":{ - "shape":"EndpointName", - "documentation":"

The name of an existing endpoint where you host the inference component.

" - }, - "VariantName":{ - "shape":"VariantName", - "documentation":"

The name of an existing production variant where you host the inference component.

" - }, - "Specification":{ - "shape":"InferenceComponentSpecification", - "documentation":"

Details about the resources to deploy with this inference component, including the model, container, and compute resources.

" - }, - "Specifications":{ - "shape":"InferenceComponentSpecificationList", - "documentation":"

A list of specification objects for the inference component, one per instance type. Use this parameter when you want to deploy a different model or resource configuration for the inference component on each instance type. You can use either this parameter or the singular Specification parameter, but not both.

" - }, - "RuntimeConfig":{ - "shape":"InferenceComponentRuntimeConfig", - "documentation":"

Runtime settings for a model that is deployed with an inference component.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

A list of key-value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

" - } - } - }, - "CreateInferenceComponentOutput":{ - "type":"structure", - "required":["InferenceComponentArn"], - "members":{ - "InferenceComponentArn":{ - "shape":"InferenceComponentArn", - "documentation":"

The Amazon Resource Name (ARN) of the inference component.

" - } - } - }, - "CreateInferenceExperimentRequest":{ - "type":"structure", - "required":[ - "Name", - "Type", - "RoleArn", - "EndpointName", - "ModelVariants", - "ShadowModeConfig" - ], - "members":{ - "Name":{ - "shape":"InferenceExperimentName", - "documentation":"

The name for the inference experiment.

" - }, - "Type":{ - "shape":"InferenceExperimentType", - "documentation":"

The type of the inference experiment that you want to run. The following types of experiments are possible:

  • ShadowMode: You can use this type to validate a shadow variant. For more information, see Shadow tests.

" - }, - "Schedule":{ - "shape":"InferenceExperimentSchedule", - "documentation":"

The duration for which you want the inference experiment to run. If you don't specify this field, the experiment automatically starts immediately upon creation and concludes after 7 days.

" - }, - "Description":{ - "shape":"InferenceExperimentDescription", - "documentation":"

A description for the inference experiment.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.

" - }, - "EndpointName":{ - "shape":"EndpointName", - "documentation":"

The name of the Amazon SageMaker endpoint on which you want to run the inference experiment.

" - }, - "ModelVariants":{ - "shape":"ModelVariantConfigList", - "documentation":"

An array of ModelVariantConfig objects. There is one for each variant in the inference experiment. Each ModelVariantConfig object in the array describes the infrastructure configuration for the corresponding variant.

" - }, - "DataStorageConfig":{ - "shape":"InferenceExperimentDataStorageConfig", - "documentation":"

The Amazon S3 location and configuration for storing inference request and response data.

This is an optional parameter that you can use for data capture. For more information, see Capture data.

" - }, - "ShadowModeConfig":{ - "shape":"ShadowModeConfig", - "documentation":"

The configuration of ShadowMode inference experiment type. Use this field to specify a production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant also specify the percentage of requests that Amazon SageMaker replicates.

" - }, - "KmsKey":{ - "shape":"KmsKeyId", - "documentation":"

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. The KmsKey can be any of the following formats:

  • KMS key ID

    \"1234abcd-12ab-34cd-56ef-1234567890ab\"

  • Amazon Resource Name (ARN) of a KMS key

    \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

  • KMS key Alias

    \"alias/ExampleAlias\"

  • Amazon Resource Name (ARN) of a KMS key Alias

    \"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"

If you use a KMS key ID or an alias of your KMS key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to \"aws:kms\". For more information, see KMS managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint and UpdateEndpoint requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

Array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging your Amazon Web Services Resources.

" - } - } - }, - "CreateInferenceExperimentResponse":{ - "type":"structure", - "required":["InferenceExperimentArn"], - "members":{ - "InferenceExperimentArn":{ - "shape":"InferenceExperimentArn", - "documentation":"

The ARN for your inference experiment.

" - } - } - }, - "CreateInferenceRecommendationsJobRequest":{ - "type":"structure", - "required":[ - "JobName", - "JobType", - "RoleArn", - "InputConfig" - ], - "members":{ - "JobName":{ - "shape":"RecommendationJobName", - "documentation":"

A name for the recommendation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account. The job name is passed down to the resources created by the recommendation job. The names of resources (such as the model, endpoint configuration, endpoint, and compilation) that are prefixed with the job name are truncated at 40 characters.

" - }, - "JobType":{ - "shape":"RecommendationJobType", - "documentation":"

Defines the type of recommendation job. Specify Default to initiate an instance recommendation and Advanced to initiate a load test. If left unspecified, Amazon SageMaker Inference Recommender will run an instance recommendation (DEFAULT) job.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

" - }, - "InputConfig":{ - "shape":"RecommendationJobInputConfig", - "documentation":"

Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.

" - }, - "JobDescription":{ - "shape":"RecommendationJobDescription", - "documentation":"

Description of the recommendation job.

" - }, - "StoppingConditions":{ - "shape":"RecommendationJobStoppingConditions", - "documentation":"

A set of conditions for stopping a recommendation job. If any of the conditions are met, the job is automatically stopped.

" - }, - "OutputConfig":{ - "shape":"RecommendationJobOutputConfig", - "documentation":"

Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

" - } - } - }, - "CreateInferenceRecommendationsJobResponse":{ - "type":"structure", - "required":["JobArn"], - "members":{ - "JobArn":{ - "shape":"RecommendationJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the recommendation job.

" - } - } - }, - "CreateJobRequest":{ - "type":"structure", - "required":[ - "JobName", - "RoleArn", - "JobCategory", - "JobConfigSchemaVersion", - "JobConfigDocument" - ], - "members":{ - "JobName":{ - "shape":"JobName", - "documentation":"

The name of the job. The name must be unique within your account and Amazon Web Services Region.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to perform the job. The role must have the necessary permissions to access the resources required by the job configuration.

" - }, - "JobCategory":{ - "shape":"JobCategory", - "documentation":"

The category of the job. The category determines the type of workload that the job runs.

" - }, - "JobConfigSchemaVersion":{ - "shape":"JobSchemaVersion", - "documentation":"

The version of the configuration schema to use for the job configuration document. Use ListJobSchemaVersions to get available schema versions for a job category.

" - }, - "JobConfigDocument":{ - "shape":"JobConfigDocument", - "documentation":"

The JSON configuration document for the job. The document must conform to the schema specified by JobConfigSchemaVersion. Use DescribeJobSchemaVersion to retrieve the schema for validation.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

An array of key-value pairs to apply to the job as tags. For more information, see Tagging Amazon Web Services Resources.

" - } - } - }, - "CreateJobResponse":{ - "type":"structure", - "required":["JobArn"], - "members":{ - "JobArn":{ - "shape":"JobArn", - "documentation":"

The Amazon Resource Name (ARN) of the job.

" - } - } - }, - "CreateLabelingJobRequest":{ - "type":"structure", - "required":[ - "LabelingJobName", - "LabelAttributeName", - "InputConfig", - "OutputConfig", - "RoleArn", - "HumanTaskConfig" - ], - "members":{ - "LabelingJobName":{ - "shape":"LabelingJobName", - "documentation":"

The name of the labeling job. This name is used to identify the job in a list of labeling jobs. Labeling job names must be unique within an Amazon Web Services account and region. LabelingJobName is not case sensitive. For example, Example-job and example-job are considered the same labeling job name by Ground Truth.

" - }, - "LabelAttributeName":{ - "shape":"LabelAttributeName", - "documentation":"

The attribute name to use for the label in the output manifest file. This is the key for the key/value pair formed with the label that a worker assigns to the object. The LabelAttributeName must meet the following requirements.

  • The name can't end with \"-metadata\".

  • If you are using one of the built-in task types or one of the following, the attribute name must end with \"-ref\".

    • Image semantic segmentation (SemanticSegmentation) and adjustment (AdjustmentSemanticSegmentation) labeling jobs for this task type. One exception is that verification (VerificationSemanticSegmentation) must not end with -\"ref\".

    • Video frame object detection (VideoObjectDetection), and adjustment and verification (AdjustmentVideoObjectDetection) labeling jobs for this task type.

    • Video frame object tracking (VideoObjectTracking), and adjustment and verification (AdjustmentVideoObjectTracking) labeling jobs for this task type.

    • 3D point cloud semantic segmentation (3DPointCloudSemanticSegmentation), and adjustment and verification (Adjustment3DPointCloudSemanticSegmentation) labeling jobs for this task type.

    • 3D point cloud object tracking (3DPointCloudObjectTracking), and adjustment and verification (Adjustment3DPointCloudObjectTracking) labeling jobs for this task type.

If you are creating an adjustment or verification labeling job, you must use a different LabelAttributeName than the one used in the original labeling job. The original labeling job is the Ground Truth labeling job that produced the labels that you want verified or adjusted. To learn more about adjustment and verification labeling jobs, see Verify and Adjust Labels.

" - }, - "InputConfig":{ - "shape":"LabelingJobInputConfig", - "documentation":"

Input data for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects.

You must specify at least one of the following: S3DataSource or SnsDataSource.

  • Use SnsDataSource to specify an SNS input topic for a streaming labeling job. If you do not specify and SNS input topic ARN, Ground Truth will create a one-time labeling job that stops after all data objects in the input manifest file have been labeled.

  • Use S3DataSource to specify an input manifest file for both streaming and one-time labeling jobs. Adding an S3DataSource is optional if you use SnsDataSource to create a streaming labeling job.

If you use the Amazon Mechanical Turk workforce, your input data should not include confidential information, personal information or protected health information. Use ContentClassifiers to specify that your data is free of personally identifiable information and adult content.

" - }, - "OutputConfig":{ - "shape":"LabelingJobOutputConfig", - "documentation":"

The location of the output data and the Amazon Web Services Key Management Service key ID for the key used to encrypt the output data, if any.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete data labeling.

" - }, - "LabelCategoryConfigS3Uri":{ - "shape":"S3Uri", - "documentation":"

The S3 URI of the file, referred to as a label category configuration file, that defines the categories used to label the data objects.

For 3D point cloud and video frame task types, you can add label category attributes and frame attributes to your label category configuration file. To learn how, see Create a Labeling Category Configuration File for 3D Point Cloud Labeling Jobs.

For named entity recognition jobs, in addition to \"labels\", you must provide worker instructions in the label category configuration file using the \"instructions\" parameter: \"instructions\": {\"shortInstruction\":\"<h1>Add header</h1><p>Add Instructions</p>\", \"fullInstruction\":\"<p>Add additional instructions.</p>\"}. For details and an example, see Create a Named Entity Recognition Labeling Job (API) .

For all other built-in task types and custom tasks, your label category configuration file must be a JSON file in the following format. Identify the labels you want to use by replacing label_1, label_2,...,label_n with your label categories.

{

\"document-version\": \"2018-11-28\",

\"labels\": [{\"label\": \"label_1\"},{\"label\": \"label_2\"},...{\"label\": \"label_n\"}]

}

Note the following about the label category configuration file:

  • For image classification and text classification (single and multi-label) you must specify at least two label categories. For all other task types, the minimum number of label categories required is one.

  • Each label category must be unique, you cannot specify duplicate label categories.

  • If you create a 3D point cloud or video frame adjustment or verification labeling job, you must include auditLabelAttributeName in the label category configuration. Use this parameter to enter the LabelAttributeName of the labeling job you want to adjust or verify annotations of.

" - }, - "StoppingConditions":{ - "shape":"LabelingJobStoppingConditions", - "documentation":"

A set of conditions for stopping the labeling job. If any of the conditions are met, the job is automatically stopped. You can use these conditions to control the cost of data labeling.

" - }, - "LabelingJobAlgorithmsConfig":{ - "shape":"LabelingJobAlgorithmsConfig", - "documentation":"

Configures the information required to perform automated data labeling.

" - }, - "HumanTaskConfig":{ - "shape":"HumanTaskConfig", - "documentation":"

Configures the labeling task and how it is presented to workers; including, but not limited to price, keywords, and batch size (task count).

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

An array of key/value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

" - } - } - }, - "CreateLabelingJobResponse":{ - "type":"structure", - "required":["LabelingJobArn"], - "members":{ - "LabelingJobArn":{ - "shape":"LabelingJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the labeling job. You use this ARN to identify the labeling job.

" - } - } - }, - "CreateMlflowAppRequest":{ - "type":"structure", - "required":[ - "Name", - "ArtifactStoreUri", - "RoleArn" - ], - "members":{ - "Name":{ - "shape":"MlflowAppName", - "documentation":"

A string identifying the MLflow app name. This string is not part of the tracking server ARN.

" - }, - "ArtifactStoreUri":{ - "shape":"S3Uri", - "documentation":"

The S3 URI for a general purpose bucket to use as the MLflow App artifact store.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow App uses to access the artifact store in Amazon S3. The role should have the AmazonS3FullAccess permission.

" - }, - "ModelRegistrationMode":{ - "shape":"ModelRegistrationMode", - "documentation":"

Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. To enable automatic model registration, set this value to AutoModelRegistrationEnabled. To disable automatic model registration, set this value to AutoModelRegistrationDisabled. If not specified, AutomaticModelRegistration defaults to AutoModelRegistrationDisabled.

" - }, - "WeeklyMaintenanceWindowStart":{ - "shape":"WeeklyMaintenanceWindowStart", - "documentation":"

The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. For example: TUE:03:30.

" - }, - "AccountDefaultStatus":{ - "shape":"AccountDefaultStatus", - "documentation":"

Indicates whether this MLflow app is the default for the entire account.

" - }, - "DefaultDomainIdList":{ - "shape":"DefaultDomainIdList", - "documentation":"

List of SageMaker domain IDs for which this MLflow App is used as the default.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

Tags consisting of key-value pairs used to manage metadata for the MLflow App.

" - } - } - }, - "CreateMlflowAppResponse":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"MlflowAppArn", - "documentation":"

The ARN of the MLflow App.

" - } - } - }, - "CreateMlflowTrackingServerRequest":{ - "type":"structure", - "required":[ - "TrackingServerName", - "ArtifactStoreUri", - "RoleArn" - ], - "members":{ - "TrackingServerName":{ - "shape":"TrackingServerName", - "documentation":"

A unique string identifying the tracking server name. This string is part of the tracking server ARN.

" - }, - "ArtifactStoreUri":{ - "shape":"S3Uri", - "documentation":"

The S3 URI for a general purpose bucket to use as the MLflow Tracking Server artifact store.

" - }, - "TrackingServerSize":{ - "shape":"TrackingServerSize", - "documentation":"

The size of the tracking server you want to create. You can choose between \"Small\", \"Medium\", and \"Large\". The default MLflow Tracking Server configuration size is \"Small\". You can choose a size depending on the projected use of the tracking server such as the volume of data logged, number of users, and frequency of use.

We recommend using a small tracking server for teams of up to 25 users, a medium tracking server for teams of up to 50 users, and a large tracking server for teams of up to 100 users.

" - }, - "MlflowVersion":{ - "shape":"MlflowVersion", - "documentation":"

The version of MLflow that the tracking server uses. To see which MLflow versions are available to use, see How it works.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow Tracking Server uses to access the artifact store in Amazon S3. The role should have AmazonS3FullAccess permissions. For more information on IAM permissions for tracking server creation, see Set up IAM permissions for MLflow.

" - }, - "AutomaticModelRegistration":{ - "shape":"Boolean", - "documentation":"

Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. To enable automatic model registration, set this value to True. To disable automatic model registration, set this value to False. If not specified, AutomaticModelRegistration defaults to False.

", - "box":true - }, - "WeeklyMaintenanceWindowStart":{ - "shape":"WeeklyMaintenanceWindowStart", - "documentation":"

The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. For example: TUE:03:30.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

Tags consisting of key-value pairs used to manage metadata for the tracking server.

" - }, - "S3BucketOwnerAccountId":{ - "shape":"AccountId", - "documentation":"

Expected Amazon Web Services account ID that owns the Amazon S3 bucket for artifact storage. Defaults to caller's account ID if not provided.

" - }, - "S3BucketOwnerVerification":{ - "shape":"Boolean", - "documentation":"

Enable Amazon S3 Ownership checks when interacting with Amazon S3 buckets from a SageMaker Managed MLflow Tracking Server. Defaults to True if not provided.

", - "box":true - } - } - }, - "CreateMlflowTrackingServerResponse":{ - "type":"structure", - "members":{ - "TrackingServerArn":{ - "shape":"TrackingServerArn", - "documentation":"

The ARN of the tracking server.

" - } - } - }, - "CreateModelBiasJobDefinitionRequest":{ - "type":"structure", - "required":[ - "JobDefinitionName", - "ModelBiasAppSpecification", - "ModelBiasJobInput", - "ModelBiasJobOutputConfig", - "JobResources", - "RoleArn" - ], - "members":{ - "JobDefinitionName":{ - "shape":"MonitoringJobDefinitionName", - "documentation":"

The name of the bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

" - }, - "ModelBiasBaselineConfig":{ - "shape":"ModelBiasBaselineConfig", - "documentation":"

The baseline configuration for a model bias job.

" - }, - "ModelBiasAppSpecification":{ - "shape":"ModelBiasAppSpecification", - "documentation":"

Configures the model bias job to run a specified Docker container image.

" - }, - "ModelBiasJobInput":{ - "shape":"ModelBiasJobInput", - "documentation":"

Inputs for the model bias job.

" - }, - "ModelBiasJobOutputConfig":{"shape":"MonitoringOutputConfig"}, - "JobResources":{"shape":"MonitoringResources"}, - "NetworkConfig":{ - "shape":"MonitoringNetworkConfig", - "documentation":"

Networking options for a model bias job.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.

" - }, - "StoppingCondition":{"shape":"MonitoringStoppingCondition"}, - "Tags":{ - "shape":"TagList", - "documentation":"

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

" - } - } - }, - "CreateModelBiasJobDefinitionResponse":{ - "type":"structure", - "required":["JobDefinitionArn"], - "members":{ - "JobDefinitionArn":{ - "shape":"MonitoringJobDefinitionArn", - "documentation":"

The Amazon Resource Name (ARN) of the model bias job.

" - } - } - }, - "CreateModelCardExportJobRequest":{ - "type":"structure", - "required":[ - "ModelCardName", - "ModelCardExportJobName", - "OutputConfig" - ], - "members":{ - "ModelCardName":{ - "shape":"ModelCardNameOrArn", - "documentation":"

The name or Amazon Resource Name (ARN) of the model card to export.

" - }, - "ModelCardVersion":{ - "shape":"Integer", - "documentation":"

The version of the model card to export. If a version is not provided, then the latest version of the model card is exported.

", - "box":true - }, - "ModelCardExportJobName":{ - "shape":"EntityName", - "documentation":"

The name of the model card export job.

" - }, - "OutputConfig":{ - "shape":"ModelCardExportOutputConfig", - "documentation":"

The model card output configuration that specifies the Amazon S3 path for exporting.

" - } - } - }, - "CreateModelCardExportJobResponse":{ - "type":"structure", - "required":["ModelCardExportJobArn"], - "members":{ - "ModelCardExportJobArn":{ - "shape":"ModelCardExportJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the model card export job.

" - } - } - }, - "CreateModelCardRequest":{ - "type":"structure", - "required":[ - "ModelCardName", - "Content", - "ModelCardStatus" - ], - "members":{ - "ModelCardName":{ - "shape":"EntityName", - "documentation":"

The unique name of the model card.

" - }, - "SecurityConfig":{ - "shape":"ModelCardSecurityConfig", - "documentation":"

An optional Key Management Service key to encrypt, decrypt, and re-encrypt model card content for regulated workloads with highly sensitive data.

" - }, - "Content":{ - "shape":"ModelCardContent", - "documentation":"

The content of the model card. Content must be in model card JSON schema and provided as a string.

" - }, - "ModelCardStatus":{ - "shape":"ModelCardStatus", - "documentation":"

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

  • Draft: The model card is a work in progress.

  • PendingReview: The model card is pending review.

  • Approved: The model card is approved.

  • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

Key-value pairs used to manage metadata for model cards.

" - } - } - }, - "CreateModelCardResponse":{ - "type":"structure", - "required":["ModelCardArn"], - "members":{ - "ModelCardArn":{ - "shape":"ModelCardArn", - "documentation":"

The Amazon Resource Name (ARN) of the successfully created model card.

" - } - } - }, - "CreateModelExplainabilityJobDefinitionRequest":{ - "type":"structure", - "required":[ - "JobDefinitionName", - "ModelExplainabilityAppSpecification", - "ModelExplainabilityJobInput", - "ModelExplainabilityJobOutputConfig", - "JobResources", - "RoleArn" - ], - "members":{ - "JobDefinitionName":{ - "shape":"MonitoringJobDefinitionName", - "documentation":"

The name of the model explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

" - }, - "ModelExplainabilityBaselineConfig":{ - "shape":"ModelExplainabilityBaselineConfig", - "documentation":"

The baseline configuration for a model explainability job.

" - }, - "ModelExplainabilityAppSpecification":{ - "shape":"ModelExplainabilityAppSpecification", - "documentation":"

Configures the model explainability job to run a specified Docker container image.

" - }, - "ModelExplainabilityJobInput":{ - "shape":"ModelExplainabilityJobInput", - "documentation":"

Inputs for the model explainability job.

" - }, - "ModelExplainabilityJobOutputConfig":{"shape":"MonitoringOutputConfig"}, - "JobResources":{"shape":"MonitoringResources"}, - "NetworkConfig":{ - "shape":"MonitoringNetworkConfig", - "documentation":"

Networking options for a model explainability job.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.

" - }, - "StoppingCondition":{"shape":"MonitoringStoppingCondition"}, - "Tags":{ - "shape":"TagList", - "documentation":"

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

" - } - } - }, - "CreateModelExplainabilityJobDefinitionResponse":{ - "type":"structure", - "required":["JobDefinitionArn"], - "members":{ - "JobDefinitionArn":{ - "shape":"MonitoringJobDefinitionArn", - "documentation":"

The Amazon Resource Name (ARN) of the model explainability job.

" - } - } - }, - "CreateModelInput":{ - "type":"structure", - "required":["ModelName"], - "members":{ - "ModelName":{ - "shape":"ModelName", - "documentation":"

The name of the new model.

" - }, - "PrimaryContainer":{ - "shape":"ContainerDefinition", - "documentation":"

The location of the primary docker image containing inference code, associated artifacts, and custom environment map that the inference code uses when the model is deployed for predictions.

" - }, - "Containers":{ - "shape":"ContainerDefinitionList", - "documentation":"

Specifies the containers in the inference pipeline.

" - }, - "InferenceExecutionConfig":{ - "shape":"InferenceExecutionConfig", - "documentation":"

Specifies details of how containers in a multi-container endpoint are called.

" - }, - "ExecutionRoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access model artifacts and docker image for deployment on ML compute instances or for batch transform jobs. Deploying on ML compute instances is part of model hosting. For more information, see SageMaker Roles.

To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

" - }, - "VpcConfig":{ - "shape":"VpcConfig", - "documentation":"

A VpcConfig object that specifies the VPC that you want your model to connect to. Control access to and from your model container by configuring the VPC. VpcConfig is used in hosting services and in batch transform. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private Cloud.

" - }, - "EnableNetworkIsolation":{ - "shape":"Boolean", - "documentation":"

Isolates the model container. No inbound or outbound network calls can be made to or from the model container.

", - "box":true - } - } - }, - "CreateModelOutput":{ - "type":"structure", - "required":["ModelArn"], - "members":{ - "ModelArn":{ - "shape":"ModelArn", - "documentation":"

The ARN of the model created in SageMaker.

" - } - } - }, - "CreateModelPackageGroupInput":{ - "type":"structure", - "required":["ModelPackageGroupName"], - "members":{ - "ModelPackageGroupName":{ - "shape":"EntityName", - "documentation":"

The name of the model group.

" - }, - "ModelPackageGroupDescription":{ - "shape":"EntityDescription", - "documentation":"

A description for the model group.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

A list of key value pairs associated with the model group. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

" - }, - "ManagedConfiguration":{ - "shape":"ManagedConfiguration", - "documentation":"

The managed configuration of the model package group.

" - } - } - }, - "CreateModelPackageGroupOutput":{ - "type":"structure", - "required":["ModelPackageGroupArn"], - "members":{ - "ModelPackageGroupArn":{ - "shape":"ModelPackageGroupArn", - "documentation":"

The Amazon Resource Name (ARN) of the model group.

" - } - } - }, - "CreateModelPackageInput":{ - "type":"structure", - "members":{ - "ModelPackageName":{ - "shape":"EntityName", - "documentation":"

The name of the model package. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

This parameter is required for unversioned models. It is not applicable to versioned models.

" - }, - "ModelPackageGroupName":{ - "shape":"ArnOrName", - "documentation":"

The name or Amazon Resource Name (ARN) of the model package group that this model version belongs to.

This parameter is required for versioned models, and does not apply to unversioned models.

" - }, - "ModelPackageDescription":{ - "shape":"EntityDescription", - "documentation":"

A description of the model package.

" - }, - "ModelPackageRegistrationType":{ - "shape":"ModelPackageRegistrationType", - "documentation":"

The package registration type of the model package input.

" - }, - "InferenceSpecification":{ - "shape":"InferenceSpecification", - "documentation":"

Specifies details about inference jobs that you can run with models based on this model package, including the following information:

  • The Amazon ECR paths of containers that contain the inference code and model artifacts.

  • The instance types that the model package supports for transform jobs and real-time endpoints used for inference.

  • The input and output content formats that the model package supports for inference.

" - }, - "ValidationSpecification":{ - "shape":"ModelPackageValidationSpecification", - "documentation":"

Specifies configurations for one or more transform jobs that SageMaker runs to test the model package.

" - }, - "SourceAlgorithmSpecification":{ - "shape":"SourceAlgorithmSpecification", - "documentation":"

Details about the algorithm that was used to create the model package.

" - }, - "CertifyForMarketplace":{ - "shape":"CertifyForMarketplace", - "documentation":"

Whether to certify the model package for listing on Amazon Web Services Marketplace.

This parameter is optional for unversioned models, and does not apply to versioned models.

", - "box":true - }, - "Tags":{ - "shape":"TagList", - "documentation":"

A list of key value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

If you supply ModelPackageGroupName, your model package belongs to the model group you specify and uses the tags associated with the model group. In this case, you cannot supply a tag argument.

" - }, - "ModelApprovalStatus":{ - "shape":"ModelApprovalStatus", - "documentation":"

Whether the model is approved for deployment.

This parameter is optional for versioned models, and does not apply to unversioned models.

For versioned models, the value of this parameter must be set to Approved to deploy the model.

" - }, - "MetadataProperties":{"shape":"MetadataProperties"}, - "ModelMetrics":{ - "shape":"ModelMetrics", - "documentation":"

A structure that contains model metrics reports.

" - }, - "ClientToken":{ - "shape":"ClientToken", - "documentation":"

A unique token that guarantees that the call to this API is idempotent.

", - "idempotencyToken":true - }, - "Domain":{ - "shape":"String", - "documentation":"

The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.

" - }, - "Task":{ - "shape":"String", - "documentation":"

The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification. The following tasks are supported by Inference Recommender: \"IMAGE_CLASSIFICATION\" | \"OBJECT_DETECTION\" | \"TEXT_GENERATION\" |\"IMAGE_SEGMENTATION\" | \"FILL_MASK\" | \"CLASSIFICATION\" | \"REGRESSION\" | \"OTHER\".

Specify \"OTHER\" if none of the tasks listed fit your use case.

" - }, - "SamplePayloadUrl":{ - "shape":"S3Uri", - "documentation":"

The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). This archive can hold multiple files that are all equally used in the load test. Each file in the archive must satisfy the size constraints of the InvokeEndpoint call.

" - }, - "CustomerMetadataProperties":{ - "shape":"CustomerMetadataMap", - "documentation":"

The metadata properties associated with the model package versions.

" - }, - "DriftCheckBaselines":{ - "shape":"DriftCheckBaselines", - "documentation":"

Represents the drift check baselines that can be used when the model monitor is set using the model package. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.

" - }, - "AdditionalInferenceSpecifications":{ - "shape":"AdditionalInferenceSpecifications", - "documentation":"

An array of additional Inference Specification objects. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

" - }, - "SkipModelValidation":{ - "shape":"SkipModelValidation", - "documentation":"

Indicates if you want to skip model validation.

" - }, - "SourceUri":{ - "shape":"ModelPackageSourceUri", - "documentation":"

The URI of the source for the model package. If you want to clone a model package, set it to the model package Amazon Resource Name (ARN). If you want to register a model, set it to the model ARN.

" - }, - "SecurityConfig":{ - "shape":"ModelPackageSecurityConfig", - "documentation":"

The KMS Key ID (KMSKeyId) used for encryption of model package information.

" - }, - "ModelCard":{ - "shape":"ModelPackageModelCard", - "documentation":"

The model card associated with the model package. Since ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version.

" - }, - "ModelLifeCycle":{ - "shape":"ModelLifeCycle", - "documentation":"

A structure describing the current state of the model in its life cycle.

" - }, - "ManagedStorageType":{ - "shape":"ManagedStorageType", - "documentation":"

The storage type of the model package.

" - } - } - }, - "CreateModelPackageOutput":{ - "type":"structure", - "required":["ModelPackageArn"], - "members":{ - "ModelPackageArn":{ - "shape":"ModelPackageArn", - "documentation":"

The Amazon Resource Name (ARN) of the new model package.

" - } - } - }, - "CreateModelQualityJobDefinitionRequest":{ - "type":"structure", - "required":[ - "JobDefinitionName", - "ModelQualityAppSpecification", - "ModelQualityJobInput", - "ModelQualityJobOutputConfig", - "JobResources", - "RoleArn" - ], - "members":{ - "JobDefinitionName":{ - "shape":"MonitoringJobDefinitionName", - "documentation":"

The name of the monitoring job definition.

" - }, - "ModelQualityBaselineConfig":{ - "shape":"ModelQualityBaselineConfig", - "documentation":"

Specifies the constraints and baselines for the monitoring job.

" - }, - "ModelQualityAppSpecification":{ - "shape":"ModelQualityAppSpecification", - "documentation":"

The container that runs the monitoring job.

" - }, - "ModelQualityJobInput":{ - "shape":"ModelQualityJobInput", - "documentation":"

A list of the inputs that are monitored. Currently endpoints are supported.

" - }, - "ModelQualityJobOutputConfig":{"shape":"MonitoringOutputConfig"}, - "JobResources":{"shape":"MonitoringResources"}, - "NetworkConfig":{ - "shape":"MonitoringNetworkConfig", - "documentation":"

Specifies the network configuration for the monitoring job.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.

" - }, - "StoppingCondition":{"shape":"MonitoringStoppingCondition"}, - "Tags":{ - "shape":"TagList", - "documentation":"

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

" - } - } - }, - "CreateModelQualityJobDefinitionResponse":{ - "type":"structure", - "required":["JobDefinitionArn"], - "members":{ - "JobDefinitionArn":{ - "shape":"MonitoringJobDefinitionArn", - "documentation":"

The Amazon Resource Name (ARN) of the model quality monitoring job.

" - } - } - }, - "CreateMonitoringScheduleRequest":{ - "type":"structure", - "required":[ - "MonitoringScheduleName", - "MonitoringScheduleConfig" - ], - "members":{ - "MonitoringScheduleName":{ - "shape":"MonitoringScheduleName", - "documentation":"

The name of the monitoring schedule. The name must be unique within an Amazon Web Services Region within an Amazon Web Services account.

" - }, - "MonitoringScheduleConfig":{ - "shape":"MonitoringScheduleConfig", - "documentation":"

The configuration object that specifies the monitoring schedule and defines the monitoring job.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

" - } - } - }, - "CreateMonitoringScheduleResponse":{ - "type":"structure", - "required":["MonitoringScheduleArn"], - "members":{ - "MonitoringScheduleArn":{ - "shape":"MonitoringScheduleArn", - "documentation":"

The Amazon Resource Name (ARN) of the monitoring schedule.

" - } - } - }, - "CreateNotebookInstanceInput":{ - "type":"structure", - "required":[ - "NotebookInstanceName", - "InstanceType", - "RoleArn" - ], - "members":{ - "NotebookInstanceName":{ - "shape":"NotebookInstanceName", - "documentation":"

The name of the new notebook instance.

" - }, - "InstanceType":{ - "shape":"InstanceType", - "documentation":"

The type of ML compute instance to launch for the notebook instance.

" - }, - "SubnetId":{ - "shape":"SubnetId", - "documentation":"

The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.

" - }, - "SecurityGroupIds":{ - "shape":"SecurityGroupIds", - "documentation":"

The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.

" - }, - "IpAddressType":{ - "shape":"IPAddressType", - "documentation":"

The IP address type for the notebook instance. Specify ipv4 for IPv4-only connectivity or dualstack for both IPv4 and IPv6 connectivity. When you specify dualstack, the subnet must support IPv6 CIDR blocks. If not specified, defaults to ipv4.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

When you send any requests to Amazon Web Services resources from the notebook instance, SageMaker AI assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so SageMaker AI can perform these tasks. The policy must allow the SageMaker AI service principal (sagemaker.amazonaws.com) permissions to assume this role. For more information, see SageMaker AI Roles.

To be able to pass this role to SageMaker AI, the caller of this API must have the iam:PassRole permission.

" - }, - "KmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker AI uses to encrypt data on the storage volume attached to your notebook instance. The KMS key you provide must be enabled. For information, see Enabling and Disabling Keys in the Amazon Web Services Key Management Service Developer Guide.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

" - }, - "LifecycleConfigName":{ - "shape":"NotebookInstanceLifecycleConfigName", - "documentation":"

The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

" - }, - "DirectInternetAccess":{ - "shape":"DirectInternetAccess", - "documentation":"

Sets whether SageMaker AI provides internet access to the notebook instance. If you set this to Disabled this notebook instance is able to access resources only in your VPC, and is not be able to connect to SageMaker AI training and endpoint services unless you configure a NAT Gateway in your VPC.

For more information, see Notebook Instances Are Internet-Enabled by Default. You can set the value of this parameter to Disabled only if you set a value for the SubnetId parameter.

" - }, - "VolumeSizeInGB":{ - "shape":"NotebookInstanceVolumeSizeInGB", - "documentation":"

The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB.

" - }, - "AcceleratorTypes":{ - "shape":"NotebookInstanceAcceleratorTypes", - "documentation":"

This parameter is no longer supported. Elastic Inference (EI) is no longer available.

This parameter was used to specify a list of EI instance types to associate with this notebook instance.

" - }, - "DefaultCodeRepository":{ - "shape":"CodeRepositoryNameOrUrl", - "documentation":"

A Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker AI Notebook Instances.

" - }, - "AdditionalCodeRepositories":{ - "shape":"AdditionalCodeRepositoryNamesOrUrls", - "documentation":"

An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker AI Notebook Instances.

" - }, - "RootAccess":{ - "shape":"RootAccess", - "documentation":"

Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled.

Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.

" - }, - "PlatformIdentifier":{ - "shape":"PlatformIdentifier", - "documentation":"

The platform identifier of the notebook instance runtime environment. The default value is notebook-al2023-v1.

" - }, - "InstanceMetadataServiceConfiguration":{ - "shape":"InstanceMetadataServiceConfiguration", - "documentation":"

Information on the IMDS configuration of the notebook instance

" - } - } - }, - "CreateNotebookInstanceLifecycleConfigInput":{ - "type":"structure", - "required":["NotebookInstanceLifecycleConfigName"], - "members":{ - "NotebookInstanceLifecycleConfigName":{ - "shape":"NotebookInstanceLifecycleConfigName", - "documentation":"

The name of the lifecycle configuration.

" - }, - "OnCreate":{ - "shape":"NotebookInstanceLifecycleConfigList", - "documentation":"

A shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.

" - }, - "OnStart":{ - "shape":"NotebookInstanceLifecycleConfigList", - "documentation":"

A shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

" - } - } - }, - "CreateNotebookInstanceLifecycleConfigOutput":{ - "type":"structure", - "members":{ - "NotebookInstanceLifecycleConfigArn":{ - "shape":"NotebookInstanceLifecycleConfigArn", - "documentation":"

The Amazon Resource Name (ARN) of the lifecycle configuration.

" - } - } - }, - "CreateNotebookInstanceOutput":{ - "type":"structure", - "members":{ - "NotebookInstanceArn":{ - "shape":"NotebookInstanceArn", - "documentation":"

The Amazon Resource Name (ARN) of the notebook instance.

" - } - } - }, - "CreateOptimizationJobRequest":{ - "type":"structure", - "required":[ - "OptimizationJobName", - "RoleArn", - "ModelSource", - "DeploymentInstanceType", - "OptimizationConfigs", - "OutputConfig", - "StoppingCondition" - ], - "members":{ - "OptimizationJobName":{ - "shape":"EntityName", - "documentation":"

A custom name for the new optimization job.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.

During model optimization, Amazon SageMaker AI needs your permission to:

  • Read input data from an S3 bucket

  • Write model artifacts to an S3 bucket

  • Write logs to Amazon CloudWatch Logs

  • Publish metrics to Amazon CloudWatch

You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker AI, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker AI Roles.

" - }, - "ModelSource":{ - "shape":"OptimizationJobModelSource", - "documentation":"

The location of the source model to optimize with an optimization job.

" - }, - "DeploymentInstanceType":{ - "shape":"OptimizationJobDeploymentInstanceType", - "documentation":"

The type of instance that hosts the optimized model that you create with the optimization job.

" - }, - "MaxInstanceCount":{ - "shape":"OptimizationJobMaxInstanceCount", - "documentation":"

The maximum number of instances to use for the optimization job.

" - }, - "OptimizationEnvironment":{ - "shape":"OptimizationJobEnvironmentVariables", - "documentation":"

The environment variables to set in the model container.

" - }, - "OptimizationConfigs":{ - "shape":"OptimizationConfigs", - "documentation":"

Settings for each of the optimization techniques that the job applies.

" - }, - "OutputConfig":{ - "shape":"OptimizationJobOutputConfig", - "documentation":"

Details for where to store the optimized model that you create with the optimization job.

" - }, - "StoppingCondition":{"shape":"StoppingCondition"}, - "Tags":{ - "shape":"TagList", - "documentation":"

A list of key-value pairs associated with the optimization job. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

" - }, - "VpcConfig":{ - "shape":"OptimizationVpcConfig", - "documentation":"

A VPC in Amazon VPC that your optimized model has access to.

" - }, - "TrainingPlanArns":{ - "shape":"OptimizationJobTrainingPlanArns", - "documentation":"

The Amazon Resource Name (ARN) of the training plan to use for this optimization job.

When you use reserved capacity from a training plan, the optimization job runs on that reserved capacity instead of on-demand capacity. If you omit this field, the job uses on-demand capacity. You can specify at most one training plan.

For more information about how to reserve GPU capacity for your optimization jobs using Amazon SageMaker Training Plans, see Reserve capacity with training plans.

" - } - } - }, - "CreateOptimizationJobResponse":{ - "type":"structure", - "required":["OptimizationJobArn"], - "members":{ - "OptimizationJobArn":{ - "shape":"OptimizationJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the optimization job.

" - } - } - }, - "CreatePartnerAppPresignedUrlRequest":{ - "type":"structure", - "required":["Arn"], - "members":{ - "Arn":{ - "shape":"PartnerAppArn", - "documentation":"

The ARN of the SageMaker Partner AI App to create the presigned URL for.

" - }, - "ExpiresInSeconds":{ - "shape":"ExpiresInSeconds", - "documentation":"

The time that will pass before the presigned URL expires.

" - }, - "SessionExpirationDurationInSeconds":{ - "shape":"SessionExpirationDurationInSeconds", - "documentation":"

Indicates how long the Amazon SageMaker Partner AI App session can be accessed for after logging in.

" - } - } - }, - "CreatePartnerAppPresignedUrlResponse":{ - "type":"structure", - "members":{ - "Url":{ - "shape":"String2048", - "documentation":"

The presigned URL that you can use to access the SageMaker Partner AI App.

" - } - } - }, - "CreatePartnerAppRequest":{ - "type":"structure", - "required":[ - "Name", - "Type", - "ExecutionRoleArn", - "Tier", - "AuthType" - ], - "members":{ - "Name":{ - "shape":"PartnerAppName", - "documentation":"

The name to give the SageMaker Partner AI App.

" - }, - "Type":{ - "shape":"PartnerAppType", - "documentation":"

The type of SageMaker Partner AI App to create. Must be one of the following: lakera-guard, comet, deepchecks-llm-evaluation, or fiddler.

" - }, - "ExecutionRoleArn":{ - "shape":"RoleArn", - "documentation":"

The ARN of the IAM role that the partner application uses.

" - }, - "KmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

SageMaker Partner AI Apps uses Amazon Web Services KMS to encrypt data at rest using an Amazon Web Services managed key by default. For more control, specify a customer managed key.

" - }, - "MaintenanceConfig":{ - "shape":"PartnerAppMaintenanceConfig", - "documentation":"

Maintenance configuration settings for the SageMaker Partner AI App.

" - }, - "Tier":{ - "shape":"NonEmptyString64", - "documentation":"

Indicates the instance type and size of the cluster attached to the SageMaker Partner AI App.

" - }, - "ApplicationConfig":{ - "shape":"PartnerAppConfig", - "documentation":"

Configuration settings for the SageMaker Partner AI App.

" - }, - "AuthType":{ - "shape":"PartnerAppAuthType", - "documentation":"

The authorization type that users use to access the SageMaker Partner AI App.

" - }, - "EnableIamSessionBasedIdentity":{ - "shape":"Boolean", - "documentation":"

When set to TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user.

", - "box":true - }, - "EnableAutoMinorVersionUpgrade":{ - "shape":"Boolean", - "documentation":"

When set to TRUE, the SageMaker Partner AI App is automatically upgraded to the latest minor version during the next scheduled maintenance window, if one is available. Default is FALSE.

", - "box":true - }, - "ClientToken":{ - "shape":"ClientToken", - "documentation":"

A unique token that guarantees that the call to this API is idempotent.

", - "idempotencyToken":true - }, - "Tags":{ - "shape":"TagList", - "documentation":"

Each tag consists of a key and an optional value. Tag keys must be unique per resource.

" - } - } - }, - "CreatePartnerAppResponse":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"PartnerAppArn", - "documentation":"

The ARN of the SageMaker Partner AI App.

" - } - } - }, - "CreatePipelineRequest":{ - "type":"structure", - "required":[ - "PipelineName", - "ClientRequestToken", - "RoleArn" - ], - "members":{ - "PipelineName":{ - "shape":"PipelineName", - "documentation":"

The name of the pipeline.

" - }, - "PipelineDisplayName":{ - "shape":"PipelineName", - "documentation":"

The display name of the pipeline.

" - }, - "PipelineDefinition":{ - "shape":"PipelineDefinition", - "documentation":"

The JSON pipeline definition of the pipeline.

" - }, - "PipelineDefinitionS3Location":{ - "shape":"PipelineDefinitionS3Location", - "documentation":"

The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location.

" - }, - "PipelineDescription":{ - "shape":"PipelineDescription", - "documentation":"

A description of the pipeline.

" - }, - "ClientRequestToken":{ - "shape":"IdempotencyToken", - "documentation":"

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.

", - "idempotencyToken":true - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the role used by the pipeline to access and create resources.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

A list of tags to apply to the created pipeline.

" - }, - "ParallelismConfiguration":{ - "shape":"ParallelismConfiguration", - "documentation":"

This is the configuration that controls the parallelism of the pipeline. If specified, it applies to all runs of this pipeline by default.

" - } - } - }, - "CreatePipelineResponse":{ - "type":"structure", - "members":{ - "PipelineArn":{ - "shape":"PipelineArn", - "documentation":"

The Amazon Resource Name (ARN) of the created pipeline.

" - } - } - }, - "CreatePresignedDomainUrlRequest":{ - "type":"structure", - "required":[ - "DomainId", - "UserProfileName" - ], - "members":{ - "DomainId":{ - "shape":"DomainId", - "documentation":"

The domain ID.

" - }, - "UserProfileName":{ - "shape":"UserProfileName", - "documentation":"

The name of the UserProfile to sign-in as.

" - }, - "SessionExpirationDurationInSeconds":{ - "shape":"SessionExpirationDurationInSeconds", - "documentation":"

The session expiration duration in seconds. This value defaults to 43200.

" - }, - "ExpiresInSeconds":{ - "shape":"ExpiresInSeconds", - "documentation":"

The number of seconds until the pre-signed URL expires. This value defaults to 300.

" - }, - "SpaceName":{ - "shape":"SpaceName", - "documentation":"

The name of the space.

" - }, - "LandingUri":{ - "shape":"LandingUri", - "documentation":"

The landing page that the user is directed to when accessing the presigned URL. Using this value, users can access Studio or Studio Classic, even if it is not the default experience for the domain. The supported values are:

  • studio::relative/path: Directs users to the relative path in Studio.

  • app:JupyterServer:relative/path: Directs users to the relative path in the Studio Classic application.

  • app:JupyterLab:relative/path: Directs users to the relative path in the JupyterLab application.

  • app:RStudioServerPro:relative/path: Directs users to the relative path in the RStudio application.

  • app:CodeEditor:relative/path: Directs users to the relative path in the Code Editor, based on Code-OSS, Visual Studio Code - Open Source application.

  • app:Canvas:relative/path: Directs users to the relative path in the Canvas application.

" - } - } - }, - "CreatePresignedDomainUrlResponse":{ - "type":"structure", - "members":{ - "AuthorizedUrl":{ - "shape":"PresignedDomainUrl", - "documentation":"

The presigned URL.

" - } - } - }, - "CreatePresignedMlflowAppUrlRequest":{ - "type":"structure", - "required":["Arn"], - "members":{ - "Arn":{ - "shape":"MlflowAppArn", - "documentation":"

The ARN of the MLflow App to connect to your MLflow UI.

" - }, - "ExpiresInSeconds":{ - "shape":"ExpiresInSeconds", - "documentation":"

The duration in seconds that your presigned URL is valid. The presigned URL can be used only once.

" - }, - "SessionExpirationDurationInSeconds":{ - "shape":"SessionExpirationDurationInSeconds", - "documentation":"

The duration in seconds that your presigned URL is valid. The presigned URL can be used only once.

" - } - } - }, - "CreatePresignedMlflowAppUrlResponse":{ - "type":"structure", - "members":{ - "AuthorizedUrl":{ - "shape":"MlflowAppUrl", - "documentation":"

A presigned URL with an authorization token.

" - } - } - }, - "CreatePresignedMlflowTrackingServerUrlRequest":{ - "type":"structure", - "required":["TrackingServerName"], - "members":{ - "TrackingServerName":{ - "shape":"TrackingServerName", - "documentation":"

The name of the tracking server to connect to your MLflow UI.

" - }, - "ExpiresInSeconds":{ - "shape":"ExpiresInSeconds", - "documentation":"

The duration in seconds that your presigned URL is valid. The presigned URL can be used only once.

" - }, - "SessionExpirationDurationInSeconds":{ - "shape":"SessionExpirationDurationInSeconds", - "documentation":"

The duration in seconds that your MLflow UI session is valid.

" - } - } - }, - "CreatePresignedMlflowTrackingServerUrlResponse":{ - "type":"structure", - "members":{ - "AuthorizedUrl":{ - "shape":"TrackingServerUrl", - "documentation":"

A presigned URL with an authorization token.

" - } - } - }, - "CreatePresignedNotebookInstanceUrlInput":{ - "type":"structure", - "required":["NotebookInstanceName"], - "members":{ - "NotebookInstanceName":{ - "shape":"NotebookInstanceName", - "documentation":"

The name of the notebook instance.

" - }, - "SessionExpirationDurationInSeconds":{ - "shape":"SessionExpirationDurationInSeconds", - "documentation":"

The duration of the session, in seconds. The default is 12 hours.

" - } - } - }, - "CreatePresignedNotebookInstanceUrlOutput":{ - "type":"structure", - "members":{ - "AuthorizedUrl":{ - "shape":"NotebookInstanceUrl", - "documentation":"

A JSON object that contains the URL string.

" - } - } - }, - "CreateProcessingJobRequest":{ - "type":"structure", - "required":[ - "ProcessingJobName", - "ProcessingResources", - "AppSpecification", - "RoleArn" - ], - "members":{ - "ProcessingInputs":{ - "shape":"ProcessingInputs", - "documentation":"

An array of inputs configuring the data to download into the processing container.

" - }, - "ProcessingOutputConfig":{ - "shape":"ProcessingOutputConfig", - "documentation":"

Output configuration for the processing job.

" - }, - "ProcessingJobName":{ - "shape":"ProcessingJobName", - "documentation":"

The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

" - }, - "ProcessingResources":{ - "shape":"ProcessingResources", - "documentation":"

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.

" - }, - "StoppingCondition":{ - "shape":"ProcessingStoppingCondition", - "documentation":"

The time limit for how long the processing job is allowed to run.

" - }, - "AppSpecification":{ - "shape":"AppSpecification", - "documentation":"

Configures the processing job to run a specified Docker container image.

" - }, - "Environment":{ - "shape":"ProcessingEnvironmentMap", - "documentation":"

The environment variables to set in the Docker container. Up to 100 key and values entries in the map are supported.

Do not include any security-sensitive information including account access IDs, secrets, or tokens in any environment fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request environment variable or plain text fields.

" - }, - "NetworkConfig":{ - "shape":"NetworkConfig", - "documentation":"

Networking options for a processing job, such as whether to allow inbound and outbound network calls to and from processing containers, and the VPC subnets and security groups to use for VPC-enabled processing jobs.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

Do not include any security-sensitive information including account access IDs, secrets, or tokens in any tags. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request tag variable or plain text fields.

" - }, - "ExperimentConfig":{"shape":"ExperimentConfig"} - } - }, - "CreateProcessingJobResponse":{ - "type":"structure", - "required":["ProcessingJobArn"], - "members":{ - "ProcessingJobArn":{ - "shape":"ProcessingJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the processing job.

" - } - } - }, - "CreateProjectInput":{ - "type":"structure", - "required":["ProjectName"], - "members":{ - "ProjectName":{ - "shape":"ProjectEntityName", - "documentation":"

The name of the project.

" - }, - "ProjectDescription":{ - "shape":"EntityDescription", - "documentation":"

A description for the project.

" - }, - "ServiceCatalogProvisioningDetails":{ - "shape":"ServiceCatalogProvisioningDetails", - "documentation":"

The product ID and provisioning artifact ID to provision a service catalog. The provisioning artifact ID will default to the latest provisioning artifact ID of the product, if you don't provide the provisioning artifact ID. For more information, see What is Amazon Web Services Service Catalog.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

An array of key-value pairs that you want to use to organize and track your Amazon Web Services resource costs. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

" - }, - "TemplateProviders":{ - "shape":"CreateTemplateProviderList", - "documentation":"

An array of template provider configurations for creating infrastructure resources for the project.

" - } - } - }, - "CreateProjectOutput":{ - "type":"structure", - "required":[ - "ProjectArn", - "ProjectId" - ], - "members":{ - "ProjectArn":{ - "shape":"ProjectArn", - "documentation":"

The Amazon Resource Name (ARN) of the project.

" - }, - "ProjectId":{ - "shape":"ProjectId", - "documentation":"

The ID of the new project.

" - } - } - }, - "CreateSpaceRequest":{ - "type":"structure", - "required":[ - "DomainId", - "SpaceName" - ], - "members":{ - "DomainId":{ - "shape":"DomainId", - "documentation":"

The ID of the associated domain.

" - }, - "SpaceName":{ - "shape":"SpaceName", - "documentation":"

The name of the space.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

Tags to associated with the space. Each tag consists of a key and an optional value. Tag keys must be unique for each resource. Tags are searchable using the Search API.

" - }, - "SpaceSettings":{ - "shape":"SpaceSettings", - "documentation":"

A collection of space settings.

" - }, - "OwnershipSettings":{ - "shape":"OwnershipSettings", - "documentation":"

A collection of ownership settings.

" - }, - "SpaceSharingSettings":{ - "shape":"SpaceSharingSettings", - "documentation":"

A collection of space sharing settings.

" - }, - "SpaceDisplayName":{ - "shape":"NonEmptyString64", - "documentation":"

The name of the space that appears in the SageMaker Studio UI.

" - } - } - }, - "CreateSpaceResponse":{ - "type":"structure", - "members":{ - "SpaceArn":{ - "shape":"SpaceArn", - "documentation":"

The space's Amazon Resource Name (ARN).

" - } - } - }, - "CreateStudioLifecycleConfigRequest":{ - "type":"structure", - "required":[ - "StudioLifecycleConfigName", - "StudioLifecycleConfigContent", - "StudioLifecycleConfigAppType" - ], - "members":{ - "StudioLifecycleConfigName":{ - "shape":"StudioLifecycleConfigName", - "documentation":"

The name of the Amazon SageMaker AI Studio Lifecycle Configuration to create.

" - }, - "StudioLifecycleConfigContent":{ - "shape":"StudioLifecycleConfigContent", - "documentation":"

The content of your Amazon SageMaker AI Studio Lifecycle Configuration script. This content must be base64 encoded.

" - }, - "StudioLifecycleConfigAppType":{ - "shape":"StudioLifecycleConfigAppType", - "documentation":"

The App type that the Lifecycle Configuration is attached to.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

Tags to be associated with the Lifecycle Configuration. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.

" - } - } - }, - "CreateStudioLifecycleConfigResponse":{ - "type":"structure", - "members":{ - "StudioLifecycleConfigArn":{ - "shape":"StudioLifecycleConfigArn", - "documentation":"

The ARN of your created Lifecycle Configuration.

" - } - } - }, - "CreateTemplateProvider":{ - "type":"structure", - "members":{ - "CfnTemplateProvider":{ - "shape":"CfnCreateTemplateProvider", - "documentation":"

The CloudFormation template provider configuration for creating infrastructure resources.

" - } - }, - "documentation":"

Contains configuration details for a template provider. Only one type of template provider can be specified.

" - }, - "CreateTemplateProviderList":{ - "type":"list", - "member":{"shape":"CreateTemplateProvider"}, - "max":1, - "min":1 - }, - "CreateTrainingJobRequest":{ - "type":"structure", - "required":[ - "TrainingJobName", - "RoleArn", - "OutputDataConfig" - ], - "members":{ - "TrainingJobName":{ - "shape":"TrainingJobName", - "documentation":"

The name of the training job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

" - }, - "HyperParameters":{ - "shape":"HyperParameters", - "documentation":"

Algorithm-specific parameters that influence the quality of the model. You set hyperparameters before you start the learning process. For a list of hyperparameters for each training algorithm provided by SageMaker, see Algorithms.

You can specify a maximum of 100 hyperparameters. Each hyperparameter is a key-value pair. Each key and value is limited to 256 characters, as specified by the Length Constraint.

Do not include any security-sensitive information including account access IDs, secrets, or tokens in any hyperparameter fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by any security-sensitive information included in the request hyperparameter variable or plain text fields.

" - }, - "AlgorithmSpecification":{ - "shape":"AlgorithmSpecification", - "documentation":"

The registry path of the Docker image that contains the training algorithm and algorithm-specific metadata, including the input mode. For more information about algorithms provided by SageMaker, see Algorithms. For information about providing your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to perform tasks on your behalf.

During model training, SageMaker needs your permission to read input data from an S3 bucket, download a Docker image that contains training code, write model artifacts to an S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant permissions for all of these tasks to an IAM role. For more information, see SageMaker Roles.

To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.

" - }, - "InputDataConfig":{ - "shape":"InputDataConfig", - "documentation":"

An array of Channel objects. Each channel is a named input source. InputDataConfig describes the input data and its location.

Algorithms can accept input data from one or more channels. For example, an algorithm might have two channels of input data, training_data and validation_data. The configuration for each channel provides the S3, EFS, or FSx location where the input data is stored. It also provides information about the stored data: the MIME type, compression method, and whether the data is wrapped in RecordIO format.

Depending on the input mode that the algorithm supports, SageMaker either copies input data files from an S3 bucket to a local directory in the Docker container, or makes it available as input streams. For example, if you specify an EFS location, input data files are available as input streams. They do not need to be downloaded.

Your input must be in the same Amazon Web Services region as your training job.

" - }, - "OutputDataConfig":{ - "shape":"OutputDataConfig", - "documentation":"

Specifies the path to the S3 location where you want to store model artifacts. SageMaker creates subfolders for the artifacts.

" - }, - "ResourceConfig":{ - "shape":"ResourceConfig", - "documentation":"

The resources, including the ML compute instances and ML storage volumes, to use for model training.

ML storage volumes store model artifacts and incremental states. Training algorithms might also use ML storage volumes for scratch space. If you want SageMaker to use the ML storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.

" - }, - "VpcConfig":{ - "shape":"VpcConfig", - "documentation":"

A VpcConfig object that specifies the VPC that you want your training job to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

" - }, - "StoppingCondition":{ - "shape":"StoppingCondition", - "documentation":"

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

Do not include any security-sensitive information including account access IDs, secrets, or tokens in any tags. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by any security-sensitive information included in the request tag variable or plain text fields.

" - }, - "EnableNetworkIsolation":{ - "shape":"Boolean", - "documentation":"

Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If you enable network isolation for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

", - "box":true - }, - "EnableInterContainerTrafficEncryption":{ - "shape":"Boolean", - "documentation":"

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training. For more information, see Protect Communications Between ML Compute Instances in a Distributed Training Job.

", - "box":true - }, - "EnableManagedSpotTraining":{ - "shape":"Boolean", - "documentation":"

To train models using managed spot training, choose True. Managed spot training provides a fully managed and scalable infrastructure for training machine learning models. this option is useful when training jobs can be interrupted and when there is flexibility when the training job is run.

The complete and intermediate results of jobs are stored in an Amazon S3 bucket, and can be used as a starting point to train models incrementally. Amazon SageMaker provides metrics and logs in CloudWatch. They can be used to see when managed spot training jobs are running, interrupted, resumed, or completed.

", - "box":true - }, - "CheckpointConfig":{ - "shape":"CheckpointConfig", - "documentation":"

Contains information about the output location for managed spot training checkpoint data.

" - }, - "DebugHookConfig":{"shape":"DebugHookConfig"}, - "DebugRuleConfigurations":{ - "shape":"DebugRuleConfigurations", - "documentation":"

Configuration information for Amazon SageMaker Debugger rules for debugging output tensors.

" - }, - "TensorBoardOutputConfig":{"shape":"TensorBoardOutputConfig"}, - "ExperimentConfig":{"shape":"ExperimentConfig"}, - "ProfilerConfig":{"shape":"ProfilerConfig"}, - "ProfilerRuleConfigurations":{ - "shape":"ProfilerRuleConfigurations", - "documentation":"

Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics.

" - }, - "Environment":{ - "shape":"TrainingEnvironmentMap", - "documentation":"

The environment variables to set in the Docker container.

Do not include any security-sensitive information including account access IDs, secrets, or tokens in any environment fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request environment variable or plain text fields.

" - }, - "RetryStrategy":{ - "shape":"RetryStrategy", - "documentation":"

The number of times to retry the job when the job fails due to an InternalServerError.

" - }, - "RemoteDebugConfig":{ - "shape":"RemoteDebugConfig", - "documentation":"

Configuration for remote debugging. To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.

" - }, - "InfraCheckConfig":{ - "shape":"InfraCheckConfig", - "documentation":"

Contains information about the infrastructure health check configuration for the training job.

" - }, - "SessionChainingConfig":{ - "shape":"SessionChainingConfig", - "documentation":"

Contains information about attribute-based access control (ABAC) for the training job.

" - }, - "ServerlessJobConfig":{ - "shape":"ServerlessJobConfig", - "documentation":"

The configuration for serverless training jobs.

" - }, - "MlflowConfig":{ - "shape":"MlflowConfig", - "documentation":"

The MLflow configuration using SageMaker managed MLflow.

" - }, - "ModelPackageConfig":{ - "shape":"ModelPackageConfig", - "documentation":"

The configuration for the model package.

" - } - } - }, - "CreateTrainingJobResponse":{ - "type":"structure", - "required":["TrainingJobArn"], - "members":{ - "TrainingJobArn":{ - "shape":"TrainingJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the training job.

" - } - } - }, - "CreateTrainingPlanRequest":{ - "type":"structure", - "required":[ - "TrainingPlanName", - "TrainingPlanOfferingId" - ], - "members":{ - "TrainingPlanName":{ - "shape":"TrainingPlanName", - "documentation":"

The name of the training plan to create.

" - }, - "TrainingPlanOfferingId":{ - "shape":"TrainingPlanOfferingId", - "documentation":"

The unique identifier of the training plan offering to use for creating this plan.

" - }, - "SpareInstanceCountPerUltraServer":{ - "shape":"SpareInstanceCountPerUltraServer", - "documentation":"

Number of spare instances to reserve per UltraServer for enhanced resiliency. Default is 1.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

An array of key-value pairs to apply to this training plan.

" - } - } - }, - "CreateTrainingPlanResponse":{ - "type":"structure", - "required":["TrainingPlanArn"], - "members":{ - "TrainingPlanArn":{ - "shape":"TrainingPlanArn", - "documentation":"

The Amazon Resource Name (ARN); of the created training plan.

" - } - } - }, - "CreateTransformJobRequest":{ - "type":"structure", - "required":[ - "TransformJobName", - "ModelName", - "TransformInput", - "TransformOutput", - "TransformResources" - ], - "members":{ - "TransformJobName":{ - "shape":"TransformJobName", - "documentation":"

The name of the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

" - }, - "ModelName":{ - "shape":"ModelName", - "documentation":"

The name of the model that you want to use for the transform job. ModelName must be the name of an existing Amazon SageMaker model within an Amazon Web Services Region in an Amazon Web Services account.

" - }, - "MaxConcurrentTransforms":{ - "shape":"MaxConcurrentTransforms", - "documentation":"

The maximum number of parallel requests that can be sent to each instance in a transform job. If MaxConcurrentTransforms is set to 0 or left unset, Amazon SageMaker checks the optional execution-parameters to determine the settings for your chosen algorithm. If the execution-parameters endpoint is not enabled, the default value is 1. For more information on execution-parameters, see How Containers Serve Requests. For built-in algorithms, you don't need to set a value for MaxConcurrentTransforms.

" - }, - "ModelClientConfig":{ - "shape":"ModelClientConfig", - "documentation":"

Configures the timeout and maximum number of retries for processing a transform job invocation.

" - }, - "MaxPayloadInMB":{ - "shape":"MaxPayloadInMB", - "documentation":"

The maximum allowed size of the payload, in MB. A payload is the data portion of a record (without metadata). The value in MaxPayloadInMB must be greater than, or equal to, the size of a single record. To estimate the size of a record in MB, divide the size of your dataset by the number of records. To ensure that the records fit within the maximum payload size, we recommend using a slightly larger value. The default value is 6 MB.

The value of MaxPayloadInMB cannot be greater than 100 MB. If you specify the MaxConcurrentTransforms parameter, the value of (MaxConcurrentTransforms * MaxPayloadInMB) also cannot exceed 100 MB.

For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to 0. This feature works only in supported algorithms. Currently, Amazon SageMaker built-in algorithms do not support HTTP chunked encoding.

" - }, - "BatchStrategy":{ - "shape":"BatchStrategy", - "documentation":"

Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.

To enable the batch strategy, you must set the SplitType property to Line, RecordIO, or TFRecord.

To use only one record when making an HTTP invocation request to a container, set BatchStrategy to SingleRecord and SplitType to Line.

To fit as many records in a mini-batch as can fit within the MaxPayloadInMB limit, set BatchStrategy to MultiRecord and SplitType to Line.

" - }, - "Environment":{ - "shape":"TransformEnvironmentMap", - "documentation":"

The environment variables to set in the Docker container. Don't include any sensitive data in your environment variables. We support up to 16 key and values entries in the map.

" - }, - "TransformInput":{ - "shape":"TransformInput", - "documentation":"

Describes the input source and the way the transform job consumes it.

" - }, - "TransformOutput":{ - "shape":"TransformOutput", - "documentation":"

Describes the results of the transform job.

" - }, - "DataCaptureConfig":{ - "shape":"BatchDataCaptureConfig", - "documentation":"

Configuration to control how SageMaker captures inference data.

" - }, - "TransformResources":{ - "shape":"TransformResources", - "documentation":"

Describes the resources, including ML instance types and ML instance count, to use for the transform job.

" - }, - "DataProcessing":{ - "shape":"DataProcessing", - "documentation":"

The data structure used to specify the data to be used for inference in a batch transform job and to associate the data that is relevant to the prediction results in the output. The input filter provided allows you to exclude input data that is not needed for inference in a batch transform job. The output filter provided allows you to include input data relevant to interpreting the predictions in the output from the job. For more information, see Associate Prediction Results with their Corresponding Input Records.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

" - }, - "ExperimentConfig":{"shape":"ExperimentConfig"} - } - }, - "CreateTransformJobResponse":{ - "type":"structure", - "required":["TransformJobArn"], - "members":{ - "TransformJobArn":{ - "shape":"TransformJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the transform job.

" - } - } - }, - "CreateTrialComponentRequest":{ - "type":"structure", - "required":["TrialComponentName"], - "members":{ - "TrialComponentName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the component. The name must be unique in your Amazon Web Services account and is not case-sensitive.

" - }, - "DisplayName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the component as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialComponentName is displayed.

" - }, - "Status":{ - "shape":"TrialComponentStatus", - "documentation":"

The status of the component. States include:

  • InProgress

  • Completed

  • Failed

" - }, - "StartTime":{ - "shape":"Timestamp", - "documentation":"

When the component started.

" - }, - "EndTime":{ - "shape":"Timestamp", - "documentation":"

When the component ended.

" - }, - "Parameters":{ - "shape":"TrialComponentParameters", - "documentation":"

The hyperparameters for the component.

" - }, - "InputArtifacts":{ - "shape":"TrialComponentArtifacts", - "documentation":"

The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.

" - }, - "OutputArtifacts":{ - "shape":"TrialComponentArtifacts", - "documentation":"

The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.

" - }, - "MetadataProperties":{"shape":"MetadataProperties"}, - "Tags":{ - "shape":"TagList", - "documentation":"

A list of tags to associate with the component. You can use Search API to search on the tags.

" - } - } - }, - "CreateTrialComponentResponse":{ - "type":"structure", - "members":{ - "TrialComponentArn":{ - "shape":"TrialComponentArn", - "documentation":"

The Amazon Resource Name (ARN) of the trial component.

" - } - } - }, - "CreateTrialRequest":{ - "type":"structure", - "required":[ - "TrialName", - "ExperimentName" - ], - "members":{ - "TrialName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the trial. The name must be unique in your Amazon Web Services account and is not case-sensitive.

" - }, - "DisplayName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the trial as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialName is displayed.

" - }, - "ExperimentName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the experiment to associate the trial with.

" - }, - "MetadataProperties":{"shape":"MetadataProperties"}, - "Tags":{ - "shape":"TagList", - "documentation":"

A list of tags to associate with the trial. You can use Search API to search on the tags.

" - } - } - }, - "CreateTrialResponse":{ - "type":"structure", - "members":{ - "TrialArn":{ - "shape":"TrialArn", - "documentation":"

The Amazon Resource Name (ARN) of the trial.

" - } - } - }, - "CreateUserProfileRequest":{ - "type":"structure", - "required":[ - "DomainId", - "UserProfileName" - ], - "members":{ - "DomainId":{ - "shape":"DomainId", - "documentation":"

The ID of the associated Domain.

" - }, - "UserProfileName":{ - "shape":"UserProfileName", - "documentation":"

A name for the UserProfile. This value is not case sensitive.

" - }, - "SingleSignOnUserIdentifier":{ - "shape":"SingleSignOnUserIdentifier", - "documentation":"

A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is \"UserName\". If the Domain's AuthMode is IAM Identity Center, this field is required. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.

" - }, - "SingleSignOnUserValue":{ - "shape":"String256", - "documentation":"

The username of the associated Amazon Web Services Single Sign-On User for this UserProfile. If the Domain's AuthMode is IAM Identity Center, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

Each tag consists of a key and an optional value. Tag keys must be unique per resource.

Tags that you specify for the User Profile are also added to all Apps that the User Profile launches.

" - }, - "UserSettings":{ - "shape":"UserSettings", - "documentation":"

A collection of settings.

" - } - } - }, - "CreateUserProfileResponse":{ - "type":"structure", - "members":{ - "UserProfileArn":{ - "shape":"UserProfileArn", - "documentation":"

The user profile Amazon Resource Name (ARN).

" - } - } - }, - "CreateWorkforceRequest":{ - "type":"structure", - "required":["WorkforceName"], - "members":{ - "CognitoConfig":{ - "shape":"CognitoConfig", - "documentation":"

Use this parameter to configure an Amazon Cognito private workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.

Do not use OidcConfig if you specify values for CognitoConfig.

" - }, - "OidcConfig":{ - "shape":"OidcConfig", - "documentation":"

Use this parameter to configure a private workforce using your own OIDC Identity Provider.

Do not use CognitoConfig if you specify values for OidcConfig.

" - }, - "SourceIpConfig":{"shape":"SourceIpConfig"}, - "WorkforceName":{ - "shape":"WorkforceName", - "documentation":"

The name of the private workforce.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

An array of key-value pairs that contain metadata to help you categorize and organize our workforce. Each tag consists of a key and a value, both of which you define.

" - }, - "WorkforceVpcConfig":{ - "shape":"WorkforceVpcConfigRequest", - "documentation":"

Use this parameter to configure a workforce using VPC.

" - }, - "IpAddressType":{ - "shape":"WorkforceIpAddressType", - "documentation":"

Use this parameter to specify whether you want IPv4 only or dualstack (IPv4 and IPv6) to support your labeling workforce.

" - } - } - }, - "CreateWorkforceResponse":{ - "type":"structure", - "required":["WorkforceArn"], - "members":{ - "WorkforceArn":{ - "shape":"WorkforceArn", - "documentation":"

The Amazon Resource Name (ARN) of the workforce.

" - } - } - }, - "CreateWorkteamRequest":{ - "type":"structure", - "required":[ - "WorkteamName", - "MemberDefinitions", - "Description" - ], - "members":{ - "WorkteamName":{ - "shape":"WorkteamName", - "documentation":"

The name of the work team. Use this name to identify the work team.

" - }, - "WorkforceName":{ - "shape":"WorkforceName", - "documentation":"

The name of the workforce.

" - }, - "MemberDefinitions":{ - "shape":"MemberDefinitions", - "documentation":"

A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.

Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use CognitoMemberDefinition. For workforces created using your own OIDC identity provider (IdP) use OidcMemberDefinition. Do not provide input for both of these parameters in a single request.

For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito user groups within the user pool used to create a workforce. All of the CognitoMemberDefinition objects that make up the member definition must have the same ClientId and UserPool values. To add a Amazon Cognito user group to an existing worker pool, see Adding groups to a User Pool. For more information about user pools, see Amazon Cognito User Pools.

For workforces created using your own OIDC IdP, specify the user groups that you want to include in your private work team in OidcMemberDefinition by listing those groups in Groups.

" - }, - "Description":{ - "shape":"String200", - "documentation":"

A description of the work team.

" - }, - "NotificationConfiguration":{ - "shape":"NotificationConfiguration", - "documentation":"

Configures notification of workers regarding available or expiring work items.

" - }, - "WorkerAccessConfiguration":{ - "shape":"WorkerAccessConfiguration", - "documentation":"

Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

An array of key-value pairs.

For more information, see Resource Tag and Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

" - } - } - }, - "CreateWorkteamResponse":{ - "type":"structure", - "members":{ - "WorkteamArn":{ - "shape":"WorkteamArn", - "documentation":"

The Amazon Resource Name (ARN) of the work team. You can use this ARN to identify the work team.

" - } - } - }, - "CreationTime":{"type":"timestamp"}, - "CronScheduleExpression":{ - "type":"string", - "max":256, - "min":1 - }, - "CrossAccountFilterOption":{ - "type":"string", - "enum":[ - "SameAccount", - "CrossAccount" - ] - }, - "CsvContentType":{ - "type":"string", - "max":256, - "min":1, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9])*\\/[a-zA-Z0-9](-*[a-zA-Z0-9.])*" - }, - "CsvContentTypes":{ - "type":"list", - "member":{"shape":"CsvContentType"}, - "max":10, - "min":1 - }, - "CurrencyCode":{"type":"string"}, - "CustomFileSystem":{ - "type":"structure", - "members":{ - "EFSFileSystem":{ - "shape":"EFSFileSystem", - "documentation":"

A custom file system in Amazon EFS.

" - }, - "FSxLustreFileSystem":{ - "shape":"FSxLustreFileSystem", - "documentation":"

A custom file system in Amazon FSx for Lustre.

" - }, - "S3FileSystem":{ - "shape":"S3FileSystem", - "documentation":"

A custom file system in Amazon S3. This is only supported in Amazon SageMaker Unified Studio.

" - } - }, - "documentation":"

A file system, created by you, that you assign to a user profile or space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI Studio.

", - "union":true - }, - "CustomFileSystemConfig":{ - "type":"structure", - "members":{ - "EFSFileSystemConfig":{ - "shape":"EFSFileSystemConfig", - "documentation":"

The settings for a custom Amazon EFS file system.

" - }, - "FSxLustreFileSystemConfig":{ - "shape":"FSxLustreFileSystemConfig", - "documentation":"

The settings for a custom Amazon FSx for Lustre file system.

" - }, - "S3FileSystemConfig":{ - "shape":"S3FileSystemConfig", - "documentation":"

Configuration settings for a custom Amazon S3 file system.

" - } - }, - "documentation":"

The settings for assigning a custom file system to a user profile or space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI Studio.

", - "union":true - }, - "CustomFileSystemConfigs":{ - "type":"list", - "member":{"shape":"CustomFileSystemConfig"}, - "max":10, - "min":0 - }, - "CustomFileSystems":{ - "type":"list", - "member":{"shape":"CustomFileSystem"}, - "max":5, - "min":0 - }, - "CustomImage":{ - "type":"structure", - "required":[ - "ImageName", - "AppImageConfigName" - ], - "members":{ - "ImageName":{ - "shape":"ImageName", - "documentation":"

The name of the CustomImage. Must be unique to your account.

" - }, - "ImageVersionNumber":{ - "shape":"ImageVersionNumber", - "documentation":"

The version number of the CustomImage.

" - }, - "AppImageConfigName":{ - "shape":"AppImageConfigName", - "documentation":"

The name of the AppImageConfig.

" - } - }, - "documentation":"

A custom SageMaker AI image. For more information, see Bring your own SageMaker AI image.

" - }, - "CustomImageContainerArguments":{ - "type":"list", - "member":{"shape":"NonEmptyString64"}, - "max":50, - "min":0 - }, - "CustomImageContainerEntrypoint":{ - "type":"list", - "member":{"shape":"NonEmptyString256"}, - "max":1, - "min":0 - }, - "CustomImageContainerEnvironmentVariables":{ - "type":"map", - "key":{"shape":"NonEmptyString256"}, - "value":{"shape":"String256"}, - "max":25, - "min":0 - }, - "CustomImages":{ - "type":"list", - "member":{"shape":"CustomImage"}, - "max":200, - "min":0 - }, - "CustomPosixUserConfig":{ - "type":"structure", - "required":[ - "Uid", - "Gid" - ], - "members":{ - "Uid":{ - "shape":"Uid", - "documentation":"

The POSIX user ID.

" - }, - "Gid":{ - "shape":"Gid", - "documentation":"

The POSIX group ID.

" - } - }, - "documentation":"

Details about the POSIX identity that is used for file system operations.

" - }, - "CustomerMetadataKey":{ - "type":"string", - "max":128, - "min":1, - "pattern":"([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)${1,128}" - }, - "CustomerMetadataKeyList":{ - "type":"list", - "member":{"shape":"CustomerMetadataKey"} - }, - "CustomerMetadataMap":{ - "type":"map", - "key":{"shape":"CustomerMetadataKey"}, - "value":{"shape":"CustomerMetadataValue"}, - "max":50, - "min":1 - }, - "CustomerMetadataValue":{ - "type":"string", - "max":256, - "min":1, - "pattern":"([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)${1,256}" - }, - "CustomizationTechnique":{ - "type":"string", - "enum":[ - "SFT", - "DPO", - "RLVR", - "RLAIF" - ] - }, - "CustomizedMetricSpecification":{ - "type":"structure", - "members":{ - "MetricName":{ - "shape":"String", - "documentation":"

The name of the customized metric.

" - }, - "Namespace":{ - "shape":"String", - "documentation":"

The namespace of the customized metric.

" - }, - "Statistic":{ - "shape":"Statistic", - "documentation":"

The statistic of the customized metric.

" - } - }, - "documentation":"

A customized metric.

" - }, - "DataCaptureConfig":{ - "type":"structure", - "required":[ - "InitialSamplingPercentage", - "DestinationS3Uri", - "CaptureOptions" - ], - "members":{ - "EnableCapture":{ - "shape":"EnableCapture", - "documentation":"

Whether data capture should be enabled or disabled (defaults to enabled).

", - "box":true - }, - "InitialSamplingPercentage":{ - "shape":"SamplingPercentage", - "documentation":"

The percentage of requests SageMaker AI will capture. A lower value is recommended for Endpoints with high traffic.

" - }, - "DestinationS3Uri":{ - "shape":"DestinationS3Uri", - "documentation":"

The Amazon S3 location used to capture the data.

" - }, - "KmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The Amazon Resource Name (ARN) of an Key Management Service key that SageMaker AI uses to encrypt the captured data at rest using Amazon S3 server-side encryption.

The KmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

" - }, - "CaptureOptions":{ - "shape":"CaptureOptionList", - "documentation":"

Specifies data Model Monitor will capture. You can configure whether to collect only input, only output, or both

" - }, - "CaptureContentTypeHeader":{ - "shape":"CaptureContentTypeHeader", - "documentation":"

Configuration specifying how to treat different headers. If no headers are specified SageMaker AI will by default base64 encode when capturing the data.

" - } - }, - "documentation":"

Configuration to control how SageMaker AI captures inference data.

" - }, - "DataCaptureConfigSummary":{ - "type":"structure", - "required":[ - "EnableCapture", - "CaptureStatus", - "CurrentSamplingPercentage", - "DestinationS3Uri", - "KmsKeyId" - ], - "members":{ - "EnableCapture":{ - "shape":"EnableCapture", - "documentation":"

Whether data capture is enabled or disabled.

", - "box":true - }, - "CaptureStatus":{ - "shape":"CaptureStatus", - "documentation":"

Whether data capture is currently functional.

" - }, - "CurrentSamplingPercentage":{ - "shape":"SamplingPercentage", - "documentation":"

The percentage of requests being captured by your Endpoint.

" - }, - "DestinationS3Uri":{ - "shape":"DestinationS3Uri", - "documentation":"

The Amazon S3 location being used to capture the data.

" - }, - "KmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The KMS key being used to encrypt the data in Amazon S3.

" - } - }, - "documentation":"

The currently active data capture configuration used by your Endpoint.

" - }, - "DataCatalogConfig":{ - "type":"structure", - "required":[ - "TableName", - "Catalog", - "Database" - ], - "members":{ - "TableName":{ - "shape":"TableName", - "documentation":"

The name of the Glue table.

" - }, - "Catalog":{ - "shape":"Catalog", - "documentation":"

The name of the Glue table catalog.

" - }, - "Database":{ - "shape":"Database", - "documentation":"

The name of the Glue table database.

" - } - }, - "documentation":"

The meta data of the Glue table which serves as data catalog for the OfflineStore.

" - }, - "DataDistributionType":{ - "type":"string", - "enum":[ - "FullyReplicated", - "ShardedByS3Key" - ] - }, - "DataExplorationNotebookLocation":{ - "type":"string", - "min":1 - }, - "DataInputConfig":{ - "type":"string", - "max":16384, - "min":1, - "pattern":"[\\S\\s]+" - }, - "DataProcessing":{ - "type":"structure", - "members":{ - "InputFilter":{ - "shape":"JsonPath", - "documentation":"

A JSONPath expression used to select a portion of the input data to pass to the algorithm. Use the InputFilter parameter to exclude fields, such as an ID column, from the input. If you want SageMaker to pass the entire input dataset to the algorithm, accept the default value $.

Examples: \"$\", \"$[1:]\", \"$.features\"

" - }, - "OutputFilter":{ - "shape":"JsonPath", - "documentation":"

A JSONPath expression used to select a portion of the joined dataset to save in the output file for a batch transform job. If you want SageMaker to store the entire input dataset in the output file, leave the default value, $. If you specify indexes that aren't within the dimension size of the joined dataset, you get an error.

Examples: \"$\", \"$[0,5:]\", \"$['id','SageMakerOutput']\"

" - }, - "JoinSource":{ - "shape":"JoinSource", - "documentation":"

Specifies the source of the data to join with the transformed data. The valid values are None and Input. The default value is None, which specifies not to join the input with the transformed data. If you want the batch transform job to join the original input data with the transformed data, set JoinSource to Input. You can specify OutputFilter as an additional filter to select a portion of the joined dataset and store it in the output file.

For JSON or JSONLines objects, such as a JSON array, SageMaker adds the transformed data to the input JSON object in an attribute called SageMakerOutput. The joined result for JSON must be a key-value pair object. If the input is not a key-value pair object, SageMaker creates a new JSON file. In the new JSON file, and the input data is stored under the SageMakerInput key and the results are stored in SageMakerOutput.

For CSV data, SageMaker takes each row as a JSON array and joins the transformed data with the input by appending each transformed row to the end of the input. The joined data has the original input data followed by the transformed data and the output is a CSV file.

For information on how joining in applied, see Workflow for Associating Inferences with Input Records.

" - } - }, - "documentation":"

The data structure used to specify the data to be used for inference in a batch transform job and to associate the data that is relevant to the prediction results in the output. The input filter provided allows you to exclude input data that is not needed for inference in a batch transform job. The output filter provided allows you to include input data relevant to interpreting the predictions in the output from the job. For more information, see Associate Prediction Results with their Corresponding Input Records.

" - }, - "DataQualityAppSpecification":{ - "type":"structure", - "required":["ImageUri"], - "members":{ - "ImageUri":{ - "shape":"ImageUri", - "documentation":"

The container image that the data quality monitoring job runs.

" - }, - "ContainerEntrypoint":{ - "shape":"ContainerEntrypoint", - "documentation":"

The entrypoint for a container used to run a monitoring job.

" - }, - "ContainerArguments":{ - "shape":"MonitoringContainerArguments", - "documentation":"

The arguments to send to the container that the monitoring job runs.

" - }, - "RecordPreprocessorSourceUri":{ - "shape":"S3Uri", - "documentation":"

An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flattened JSON so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.

" - }, - "PostAnalyticsProcessorSourceUri":{ - "shape":"S3Uri", - "documentation":"

An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.

" - }, - "Environment":{ - "shape":"MonitoringEnvironmentMap", - "documentation":"

Sets the environment variables in the container that the monitoring job runs.

" - } - }, - "documentation":"

Information about the container that a data quality monitoring job runs.

" - }, - "DataQualityBaselineConfig":{ - "type":"structure", - "members":{ - "BaseliningJobName":{ - "shape":"ProcessingJobName", - "documentation":"

The name of the job that performs baselining for the data quality monitoring job.

" - }, - "ConstraintsResource":{"shape":"MonitoringConstraintsResource"}, - "StatisticsResource":{"shape":"MonitoringStatisticsResource"} - }, - "documentation":"

Configuration for monitoring constraints and monitoring statistics. These baseline resources are compared against the results of the current job from the series of jobs scheduled to collect data periodically.

" - }, - "DataQualityJobInput":{ - "type":"structure", - "members":{ - "EndpointInput":{"shape":"EndpointInput"}, - "BatchTransformInput":{ - "shape":"BatchTransformInput", - "documentation":"

Input object for the batch transform job.

" - } - }, - "documentation":"

The input for the data quality monitoring job. Currently endpoints are supported for input.

" - }, - "DataSource":{ - "type":"structure", - "members":{ - "S3DataSource":{ - "shape":"S3DataSource", - "documentation":"

The S3 location of the data source that is associated with a channel.

" - }, - "FileSystemDataSource":{ - "shape":"FileSystemDataSource", - "documentation":"

The file system that is associated with a channel.

" - }, - "DatasetSource":{ - "shape":"DatasetSource", - "documentation":"

The dataset resource that's associated with a channel.

" - } - }, - "documentation":"

Describes the location of the channel data.

" - }, - "DataSourceName":{ - "type":"string", - "enum":[ - "SalesforceGenie", - "Snowflake" - ] - }, - "Database":{ - "type":"string", - "max":255, - "min":1, - "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" - }, - "DatasetDefinition":{ - "type":"structure", - "members":{ - "AthenaDatasetDefinition":{"shape":"AthenaDatasetDefinition"}, - "RedshiftDatasetDefinition":{"shape":"RedshiftDatasetDefinition"}, - "LocalPath":{ - "shape":"ProcessingLocalPath", - "documentation":"

The local path where you want Amazon SageMaker to download the Dataset Definition inputs to run a processing job. LocalPath is an absolute path to the input data. This is a required parameter when AppManaged is False (default).

" - }, - "DataDistributionType":{ - "shape":"DataDistributionType", - "documentation":"

Whether the generated dataset is FullyReplicated or ShardedByS3Key (default).

" - }, - "InputMode":{ - "shape":"InputMode", - "documentation":"

Whether to use File or Pipe input mode. In File (default) mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.

" - } - }, - "documentation":"

Configuration for Dataset Definition inputs. The Dataset Definition input must specify exactly one of either AthenaDatasetDefinition or RedshiftDatasetDefinition types.

" - }, - "DatasetSource":{ - "type":"structure", - "required":["DatasetArn"], - "members":{ - "DatasetArn":{ - "shape":"HubDataSetArn", - "documentation":"

The Amazon Resource Name (ARN) of the dataset resource.

" - } - }, - "documentation":"

Specifies a dataset source for a channel.

" - }, - "DebugHookConfig":{ - "type":"structure", - "required":["S3OutputPath"], - "members":{ - "LocalPath":{ - "shape":"DirectoryPath", - "documentation":"

Path to local storage location for metrics and tensors. Defaults to /opt/ml/output/tensors/.

" - }, - "S3OutputPath":{ - "shape":"S3Uri", - "documentation":"

Path to Amazon S3 storage location for metrics and tensors.

" - }, - "HookParameters":{ - "shape":"HookParameters", - "documentation":"

Configuration information for the Amazon SageMaker Debugger hook parameters.

" - }, - "CollectionConfigurations":{ - "shape":"CollectionConfigurations", - "documentation":"

Configuration information for Amazon SageMaker Debugger tensor collections. To learn more about how to configure the CollectionConfiguration parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

" - } - }, - "documentation":"

Configuration information for the Amazon SageMaker Debugger hook parameters, metric and tensor collections, and storage paths. To learn more about how to configure the DebugHookConfig parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

" - }, - "DebugRuleConfiguration":{ - "type":"structure", - "required":[ - "RuleConfigurationName", - "RuleEvaluatorImage" - ], - "members":{ - "RuleConfigurationName":{ - "shape":"RuleConfigurationName", - "documentation":"

The name of the rule configuration. It must be unique relative to other rule configuration names.

" - }, - "LocalPath":{ - "shape":"DirectoryPath", - "documentation":"

Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.

" - }, - "S3OutputPath":{ - "shape":"S3Uri", - "documentation":"

Path to Amazon S3 storage location for rules.

" - }, - "RuleEvaluatorImage":{ - "shape":"AlgorithmImage", - "documentation":"

The Amazon Elastic Container (ECR) Image for the managed rule evaluation.

" - }, - "InstanceType":{ - "shape":"ProcessingInstanceType", - "documentation":"

The instance type to deploy a custom rule for debugging a training job.

" - }, - "VolumeSizeInGB":{ - "shape":"OptionalVolumeSizeInGB", - "documentation":"

The size, in GB, of the ML storage volume attached to the processing instance.

", - "box":true - }, - "RuleParameters":{ - "shape":"RuleParameters", - "documentation":"

Runtime configuration for rule container.

" - } - }, - "documentation":"

Configuration information for SageMaker Debugger rules for debugging. To learn more about how to configure the DebugRuleConfiguration parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

" - }, - "DebugRuleConfigurations":{ - "type":"list", - "member":{"shape":"DebugRuleConfiguration"}, - "max":20, - "min":0 - }, - "DebugRuleEvaluationStatus":{ - "type":"structure", - "members":{ - "RuleConfigurationName":{ - "shape":"RuleConfigurationName", - "documentation":"

The name of the rule configuration.

" - }, - "RuleEvaluationJobArn":{ - "shape":"ProcessingJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the rule evaluation job.

" - }, - "RuleEvaluationStatus":{ - "shape":"RuleEvaluationStatus", - "documentation":"

Status of the rule evaluation.

" - }, - "StatusDetails":{ - "shape":"StatusDetails", - "documentation":"

Details from the rule evaluation.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

Timestamp when the rule evaluation status was last modified.

" - } - }, - "documentation":"

Information about the status of the rule evaluation.

" - }, - "DebugRuleEvaluationStatuses":{ - "type":"list", - "member":{"shape":"DebugRuleEvaluationStatus"}, - "max":20, - "min":0 - }, - "DeepHealthCheckConfigurations":{ - "type":"list", - "member":{"shape":"InstanceGroupHealthCheckConfiguration"}, - "max":99, - "min":1 - }, - "DeepHealthCheckType":{ - "type":"string", - "enum":[ - "InstanceStress", - "InstanceConnectivity" - ] - }, - "DeepHealthChecks":{ - "type":"list", - "member":{"shape":"DeepHealthCheckType"}, - "max":2, - "min":1 - }, - "DefaultDomainIdList":{ - "type":"list", - "member":{"shape":"DomainId"} - }, - "DefaultEbsStorageSettings":{ - "type":"structure", - "required":[ - "DefaultEbsVolumeSizeInGb", - "MaximumEbsVolumeSizeInGb" - ], - "members":{ - "DefaultEbsVolumeSizeInGb":{ - "shape":"SpaceEbsVolumeSizeInGb", - "documentation":"

The default size of the EBS storage volume for a space.

" - }, - "MaximumEbsVolumeSizeInGb":{ - "shape":"SpaceEbsVolumeSizeInGb", - "documentation":"

The maximum size of the EBS storage volume for a space.

" - } - }, - "documentation":"

A collection of default EBS storage settings that apply to spaces created within a domain or user profile.

" - }, - "DefaultGid":{ - "type":"integer", - "max":65535, - "min":0 - }, - "DefaultSpaceSettings":{ - "type":"structure", - "members":{ - "ExecutionRole":{ - "shape":"RoleArn", - "documentation":"

The ARN of the execution role for the space.

" - }, - "SecurityGroups":{ - "shape":"SecurityGroupIds", - "documentation":"

The security group IDs for the Amazon VPC that the space uses for communication.

" - }, - "JupyterServerAppSettings":{"shape":"JupyterServerAppSettings"}, - "KernelGatewayAppSettings":{"shape":"KernelGatewayAppSettings"}, - "JupyterLabAppSettings":{"shape":"JupyterLabAppSettings"}, - "SpaceStorageSettings":{"shape":"DefaultSpaceStorageSettings"}, - "CustomPosixUserConfig":{"shape":"CustomPosixUserConfig"}, - "CustomFileSystemConfigs":{ - "shape":"CustomFileSystemConfigs", - "documentation":"

The settings for assigning a custom file system to a domain. Permitted users can access this file system in Amazon SageMaker AI Studio.

" - } - }, - "documentation":"

The default settings for shared spaces that users create in the domain.

SageMaker applies these settings only to shared spaces. It doesn't apply them to private spaces.

" - }, - "DefaultSpaceStorageSettings":{ - "type":"structure", - "members":{ - "DefaultEbsStorageSettings":{ - "shape":"DefaultEbsStorageSettings", - "documentation":"

The default EBS storage settings for a space.

" - } - }, - "documentation":"

The default storage settings for a space.

" - }, - "DefaultUid":{ - "type":"integer", - "max":65535, - "min":0 - }, - "DeleteAIBenchmarkJobRequest":{ - "type":"structure", - "required":["AIBenchmarkJobName"], - "members":{ - "AIBenchmarkJobName":{ - "shape":"AIEntityName", - "documentation":"

The name of the AI benchmark job to delete.

" - } - } - }, - "DeleteAIBenchmarkJobResponse":{ - "type":"structure", - "members":{ - "AIBenchmarkJobArn":{ - "shape":"AIBenchmarkJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the deleted benchmark job.

" - } - } - }, - "DeleteAIRecommendationJobRequest":{ - "type":"structure", - "required":["AIRecommendationJobName"], - "members":{ - "AIRecommendationJobName":{ - "shape":"AIEntityName", - "documentation":"

The name of the AI recommendation job to delete.

" - } - } - }, - "DeleteAIRecommendationJobResponse":{ - "type":"structure", - "members":{ - "AIRecommendationJobArn":{ - "shape":"AIRecommendationJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the deleted recommendation job.

" - } - } - }, - "DeleteAIWorkloadConfigRequest":{ - "type":"structure", - "required":["AIWorkloadConfigName"], - "members":{ - "AIWorkloadConfigName":{ - "shape":"AIEntityName", - "documentation":"

The name of the AI workload configuration to delete.

" - } - } - }, - "DeleteAIWorkloadConfigResponse":{ - "type":"structure", - "members":{ - "AIWorkloadConfigArn":{ - "shape":"AIWorkloadConfigArn", - "documentation":"

The Amazon Resource Name (ARN) of the deleted AI workload configuration.

" - } - } - }, - "DeleteActionRequest":{ - "type":"structure", - "required":["ActionName"], - "members":{ - "ActionName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the action to delete.

" - } - } - }, - "DeleteActionResponse":{ - "type":"structure", - "members":{ - "ActionArn":{ - "shape":"ActionArn", - "documentation":"

The Amazon Resource Name (ARN) of the action.

" - } - } - }, - "DeleteAlgorithmInput":{ - "type":"structure", - "required":["AlgorithmName"], - "members":{ - "AlgorithmName":{ - "shape":"EntityName", - "documentation":"

The name of the algorithm to delete.

" - } - } - }, - "DeleteAppImageConfigRequest":{ - "type":"structure", - "required":["AppImageConfigName"], - "members":{ - "AppImageConfigName":{ - "shape":"AppImageConfigName", - "documentation":"

The name of the AppImageConfig to delete.

" - } - } - }, - "DeleteAppRequest":{ - "type":"structure", - "required":[ - "DomainId", - "AppType", - "AppName" - ], - "members":{ - "DomainId":{ - "shape":"DomainId", - "documentation":"

The domain ID.

" - }, - "UserProfileName":{ - "shape":"UserProfileName", - "documentation":"

The user profile name. If this value is not set, then SpaceName must be set.

" - }, - "SpaceName":{ - "shape":"SpaceName", - "documentation":"

The name of the space. If this value is not set, then UserProfileName must be set.

" - }, - "AppType":{ - "shape":"AppType", - "documentation":"

The type of app.

" - }, - "AppName":{ - "shape":"AppName", - "documentation":"

The name of the app.

" - } - } - }, - "DeleteArtifactRequest":{ - "type":"structure", - "members":{ - "ArtifactArn":{ - "shape":"ArtifactArn", - "documentation":"

The Amazon Resource Name (ARN) of the artifact to delete.

" - }, - "Source":{ - "shape":"ArtifactSource", - "documentation":"

The URI of the source.

" - } - } - }, - "DeleteArtifactResponse":{ - "type":"structure", - "members":{ - "ArtifactArn":{ - "shape":"ArtifactArn", - "documentation":"

The Amazon Resource Name (ARN) of the artifact.

" - } - } - }, - "DeleteAssociationRequest":{ - "type":"structure", - "required":[ - "SourceArn", - "DestinationArn" - ], - "members":{ - "SourceArn":{ - "shape":"AssociationEntityArn", - "documentation":"

The ARN of the source.

" - }, - "DestinationArn":{ - "shape":"AssociationEntityArn", - "documentation":"

The Amazon Resource Name (ARN) of the destination.

" - } - } - }, - "DeleteAssociationResponse":{ - "type":"structure", - "members":{ - "SourceArn":{ - "shape":"AssociationEntityArn", - "documentation":"

The ARN of the source.

" - }, - "DestinationArn":{ - "shape":"AssociationEntityArn", - "documentation":"

The Amazon Resource Name (ARN) of the destination.

" - } - } - }, - "DeleteClusterRequest":{ - "type":"structure", - "required":["ClusterName"], - "members":{ - "ClusterName":{ - "shape":"ClusterNameOrArn", - "documentation":"

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster to delete.

" - } - } - }, - "DeleteClusterResponse":{ - "type":"structure", - "required":["ClusterArn"], - "members":{ - "ClusterArn":{ - "shape":"ClusterArn", - "documentation":"

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster to delete.

" - } - } - }, - "DeleteClusterSchedulerConfigRequest":{ - "type":"structure", - "required":["ClusterSchedulerConfigId"], - "members":{ - "ClusterSchedulerConfigId":{ - "shape":"ClusterSchedulerConfigId", - "documentation":"

ID of the cluster policy.

" - } - } - }, - "DeleteCodeRepositoryInput":{ - "type":"structure", - "required":["CodeRepositoryName"], - "members":{ - "CodeRepositoryName":{ - "shape":"EntityName", - "documentation":"

The name of the Git repository to delete.

" - } - } - }, - "DeleteCompilationJobRequest":{ - "type":"structure", - "required":["CompilationJobName"], - "members":{ - "CompilationJobName":{ - "shape":"EntityName", - "documentation":"

The name of the compilation job to delete.

" - } - } - }, - "DeleteComputeQuotaRequest":{ - "type":"structure", - "required":["ComputeQuotaId"], - "members":{ - "ComputeQuotaId":{ - "shape":"ComputeQuotaId", - "documentation":"

ID of the compute allocation definition.

" - } - } - }, - "DeleteContextRequest":{ - "type":"structure", - "required":["ContextName"], - "members":{ - "ContextName":{ - "shape":"ContextName", - "documentation":"

The name of the context to delete.

" - } - } - }, - "DeleteContextResponse":{ - "type":"structure", - "members":{ - "ContextArn":{ - "shape":"ContextArn", - "documentation":"

The Amazon Resource Name (ARN) of the context.

" - } - } - }, - "DeleteDataQualityJobDefinitionRequest":{ - "type":"structure", - "required":["JobDefinitionName"], - "members":{ - "JobDefinitionName":{ - "shape":"MonitoringJobDefinitionName", - "documentation":"

The name of the data quality monitoring job definition to delete.

" - } - } - }, - "DeleteDeviceFleetRequest":{ - "type":"structure", - "required":["DeviceFleetName"], - "members":{ - "DeviceFleetName":{ - "shape":"EntityName", - "documentation":"

The name of the fleet to delete.

" - } - } - }, - "DeleteDomainRequest":{ - "type":"structure", - "required":["DomainId"], - "members":{ - "DomainId":{ - "shape":"DomainId", - "documentation":"

The domain ID.

" - }, - "RetentionPolicy":{ - "shape":"RetentionPolicy", - "documentation":"

The retention policy for this domain, which specifies whether resources will be retained after the Domain is deleted. By default, all resources are retained (not automatically deleted).

" - } - } - }, - "DeleteEdgeDeploymentPlanRequest":{ - "type":"structure", - "required":["EdgeDeploymentPlanName"], - "members":{ - "EdgeDeploymentPlanName":{ - "shape":"EntityName", - "documentation":"

The name of the edge deployment plan to delete.

" - } - } - }, - "DeleteEdgeDeploymentStageRequest":{ - "type":"structure", - "required":[ - "EdgeDeploymentPlanName", - "StageName" - ], - "members":{ - "EdgeDeploymentPlanName":{ - "shape":"EntityName", - "documentation":"

The name of the edge deployment plan from which the stage will be deleted.

" - }, - "StageName":{ - "shape":"EntityName", - "documentation":"

The name of the stage.

" - } - } - }, - "DeleteEndpointConfigInput":{ - "type":"structure", - "required":["EndpointConfigName"], - "members":{ - "EndpointConfigName":{ - "shape":"EndpointConfigName", - "documentation":"

The name of the endpoint configuration that you want to delete.

" - } - } - }, - "DeleteEndpointInput":{ - "type":"structure", - "required":["EndpointName"], - "members":{ - "EndpointName":{ - "shape":"EndpointName", - "documentation":"

The name of the endpoint that you want to delete.

" - } - } - }, - "DeleteExperimentRequest":{ - "type":"structure", - "required":["ExperimentName"], - "members":{ - "ExperimentName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the experiment to delete.

" - } - } - }, - "DeleteExperimentResponse":{ - "type":"structure", - "members":{ - "ExperimentArn":{ - "shape":"ExperimentArn", - "documentation":"

The Amazon Resource Name (ARN) of the experiment that is being deleted.

" - } - } - }, - "DeleteFeatureGroupRequest":{ - "type":"structure", - "required":["FeatureGroupName"], - "members":{ - "FeatureGroupName":{ - "shape":"FeatureGroupName", - "documentation":"

The name of the FeatureGroup you want to delete. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

" - } - } - }, - "DeleteFlowDefinitionRequest":{ - "type":"structure", - "required":["FlowDefinitionName"], - "members":{ - "FlowDefinitionName":{ - "shape":"FlowDefinitionName", - "documentation":"

The name of the flow definition you are deleting.

" - } - } - }, - "DeleteFlowDefinitionResponse":{ - "type":"structure", - "members":{} - }, - "DeleteHubContentReferenceRequest":{ - "type":"structure", - "required":[ - "HubName", - "HubContentType", - "HubContentName" - ], - "members":{ - "HubName":{ - "shape":"HubNameOrArn", - "documentation":"

The name of the hub to delete the hub content reference from.

" - }, - "HubContentType":{ - "shape":"HubContentType", - "documentation":"

The type of hub content reference to delete. The only supported type of hub content reference to delete is ModelReference.

" - }, - "HubContentName":{ - "shape":"HubContentName", - "documentation":"

The name of the hub content to delete.

" - } - } - }, - "DeleteHubContentRequest":{ - "type":"structure", - "required":[ - "HubName", - "HubContentType", - "HubContentName", - "HubContentVersion" - ], - "members":{ - "HubName":{ - "shape":"HubNameOrArn", - "documentation":"

The name of the hub that you want to delete content in.

" - }, - "HubContentType":{ - "shape":"HubContentType", - "documentation":"

The type of content that you want to delete from a hub.

" - }, - "HubContentName":{ - "shape":"HubContentName", - "documentation":"

The name of the content that you want to delete from a hub.

" - }, - "HubContentVersion":{ - "shape":"HubContentVersion", - "documentation":"

The version of the content that you want to delete from a hub.

" - } - } - }, - "DeleteHubRequest":{ - "type":"structure", - "required":["HubName"], - "members":{ - "HubName":{ - "shape":"HubNameOrArn", - "documentation":"

The name of the hub to delete.

" - } - } - }, - "DeleteHumanTaskUiRequest":{ - "type":"structure", - "required":["HumanTaskUiName"], - "members":{ - "HumanTaskUiName":{ - "shape":"HumanTaskUiName", - "documentation":"

The name of the human task user interface (work task template) you want to delete.

" - } - } - }, - "DeleteHumanTaskUiResponse":{ - "type":"structure", - "members":{} - }, - "DeleteHyperParameterTuningJobRequest":{ - "type":"structure", - "required":["HyperParameterTuningJobName"], - "members":{ - "HyperParameterTuningJobName":{ - "shape":"HyperParameterTuningJobName", - "documentation":"

The name of the hyperparameter tuning job that you want to delete.

" - } - } - }, - "DeleteImageRequest":{ - "type":"structure", - "required":["ImageName"], - "members":{ - "ImageName":{ - "shape":"ImageName", - "documentation":"

The name of the image to delete.

" - } - } - }, - "DeleteImageResponse":{ - "type":"structure", - "members":{} - }, - "DeleteImageVersionRequest":{ - "type":"structure", - "required":["ImageName"], - "members":{ - "ImageName":{ - "shape":"ImageName", - "documentation":"

The name of the image to delete.

" - }, - "Version":{ - "shape":"ImageVersionNumber", - "documentation":"

The version to delete.

" - }, - "Alias":{ - "shape":"SageMakerImageVersionAlias", - "documentation":"

The alias of the image to delete.

" - } - } - }, - "DeleteImageVersionResponse":{ - "type":"structure", - "members":{} - }, - "DeleteInferenceComponentInput":{ - "type":"structure", - "required":["InferenceComponentName"], - "members":{ - "InferenceComponentName":{ - "shape":"InferenceComponentName", - "documentation":"

The name of the inference component to delete.

" - } - } - }, - "DeleteInferenceExperimentRequest":{ - "type":"structure", - "required":["Name"], - "members":{ - "Name":{ - "shape":"InferenceExperimentName", - "documentation":"

The name of the inference experiment you want to delete.

" - } - } - }, - "DeleteInferenceExperimentResponse":{ - "type":"structure", - "required":["InferenceExperimentArn"], - "members":{ - "InferenceExperimentArn":{ - "shape":"InferenceExperimentArn", - "documentation":"

The ARN of the deleted inference experiment.

" - } - } - }, - "DeleteJobRequest":{ - "type":"structure", - "required":[ - "JobName", - "JobCategory" - ], - "members":{ - "JobName":{ - "shape":"JobName", - "documentation":"

The name of the job to delete.

" - }, - "JobCategory":{ - "shape":"JobCategory", - "documentation":"

The category of the job to delete.

" - } - } - }, - "DeleteJobResponse":{ - "type":"structure", - "members":{} - }, - "DeleteMlflowAppRequest":{ - "type":"structure", - "required":["Arn"], - "members":{ - "Arn":{ - "shape":"MlflowAppArn", - "documentation":"

The ARN of the MLflow App to delete.

" - } - } - }, - "DeleteMlflowAppResponse":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"MlflowAppArn", - "documentation":"

The ARN of the deleted MLflow App.

" - } - } - }, - "DeleteMlflowTrackingServerRequest":{ - "type":"structure", - "required":["TrackingServerName"], - "members":{ - "TrackingServerName":{ - "shape":"TrackingServerName", - "documentation":"

The name of the the tracking server to delete.

" - } - } - }, - "DeleteMlflowTrackingServerResponse":{ - "type":"structure", - "members":{ - "TrackingServerArn":{ - "shape":"TrackingServerArn", - "documentation":"

A TrackingServerArn object, the ARN of the tracking server that is deleted if successfully found.

" - } - } - }, - "DeleteModelBiasJobDefinitionRequest":{ - "type":"structure", - "required":["JobDefinitionName"], - "members":{ - "JobDefinitionName":{ - "shape":"MonitoringJobDefinitionName", - "documentation":"

The name of the model bias job definition to delete.

" - } - } - }, - "DeleteModelCardRequest":{ - "type":"structure", - "required":["ModelCardName"], - "members":{ - "ModelCardName":{ - "shape":"EntityName", - "documentation":"

The name of the model card to delete.

" - } - } - }, - "DeleteModelExplainabilityJobDefinitionRequest":{ - "type":"structure", - "required":["JobDefinitionName"], - "members":{ - "JobDefinitionName":{ - "shape":"MonitoringJobDefinitionName", - "documentation":"

The name of the model explainability job definition to delete.

" - } - } - }, - "DeleteModelInput":{ - "type":"structure", - "required":["ModelName"], - "members":{ - "ModelName":{ - "shape":"ModelName", - "documentation":"

The name of the model to delete.

" - } - } - }, - "DeleteModelPackageGroupInput":{ - "type":"structure", - "required":["ModelPackageGroupName"], - "members":{ - "ModelPackageGroupName":{ - "shape":"ArnOrName", - "documentation":"

The name of the model group to delete.

" - } - } - }, - "DeleteModelPackageGroupPolicyInput":{ - "type":"structure", - "required":["ModelPackageGroupName"], - "members":{ - "ModelPackageGroupName":{ - "shape":"EntityName", - "documentation":"

The name of the model group for which to delete the policy.

" - } - } - }, - "DeleteModelPackageInput":{ - "type":"structure", - "required":["ModelPackageName"], - "members":{ - "ModelPackageName":{ - "shape":"VersionedArnOrName", - "documentation":"

The name or Amazon Resource Name (ARN) of the model package to delete.

When you specify a name, the name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

" - } - } - }, - "DeleteModelQualityJobDefinitionRequest":{ - "type":"structure", - "required":["JobDefinitionName"], - "members":{ - "JobDefinitionName":{ - "shape":"MonitoringJobDefinitionName", - "documentation":"

The name of the model quality monitoring job definition to delete.

" - } - } - }, - "DeleteMonitoringScheduleRequest":{ - "type":"structure", - "required":["MonitoringScheduleName"], - "members":{ - "MonitoringScheduleName":{ - "shape":"MonitoringScheduleName", - "documentation":"

The name of the monitoring schedule to delete.

" - } - } - }, - "DeleteNotebookInstanceInput":{ - "type":"structure", - "required":["NotebookInstanceName"], - "members":{ - "NotebookInstanceName":{ - "shape":"NotebookInstanceName", - "documentation":"

The name of the SageMaker AI notebook instance to delete.

" - } - } - }, - "DeleteNotebookInstanceLifecycleConfigInput":{ - "type":"structure", - "required":["NotebookInstanceLifecycleConfigName"], - "members":{ - "NotebookInstanceLifecycleConfigName":{ - "shape":"NotebookInstanceLifecycleConfigName", - "documentation":"

The name of the lifecycle configuration to delete.

" - } - } - }, - "DeleteOptimizationJobRequest":{ - "type":"structure", - "required":["OptimizationJobName"], - "members":{ - "OptimizationJobName":{ - "shape":"EntityName", - "documentation":"

The name that you assigned to the optimization job.

" - } - } - }, - "DeletePartnerAppRequest":{ - "type":"structure", - "required":["Arn"], - "members":{ - "Arn":{ - "shape":"PartnerAppArn", - "documentation":"

The ARN of the SageMaker Partner AI App to delete.

" - }, - "ClientToken":{ - "shape":"ClientToken", - "documentation":"

A unique token that guarantees that the call to this API is idempotent.

", - "idempotencyToken":true - } - } - }, - "DeletePartnerAppResponse":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"PartnerAppArn", - "documentation":"

The ARN of the SageMaker Partner AI App that was deleted.

" - } - } - }, - "DeletePipelineRequest":{ - "type":"structure", - "required":[ - "PipelineName", - "ClientRequestToken" - ], - "members":{ - "PipelineName":{ - "shape":"PipelineName", - "documentation":"

The name of the pipeline to delete.

" - }, - "ClientRequestToken":{ - "shape":"IdempotencyToken", - "documentation":"

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.

", - "idempotencyToken":true - } - } - }, - "DeletePipelineResponse":{ - "type":"structure", - "members":{ - "PipelineArn":{ - "shape":"PipelineArn", - "documentation":"

The Amazon Resource Name (ARN) of the pipeline to delete.

" - } - } - }, - "DeleteProcessingJobRequest":{ - "type":"structure", - "required":["ProcessingJobName"], - "members":{ - "ProcessingJobName":{ - "shape":"ProcessingJobName", - "documentation":"

The name of the processing job to delete.

" - } - } - }, - "DeleteProjectInput":{ - "type":"structure", - "required":["ProjectName"], - "members":{ - "ProjectName":{ - "shape":"ProjectEntityName", - "documentation":"

The name of the project to delete.

" - } - } - }, - "DeleteSpaceRequest":{ - "type":"structure", - "required":[ - "DomainId", - "SpaceName" - ], - "members":{ - "DomainId":{ - "shape":"DomainId", - "documentation":"

The ID of the associated domain.

" - }, - "SpaceName":{ - "shape":"SpaceName", - "documentation":"

The name of the space.

" - } - } - }, - "DeleteStudioLifecycleConfigRequest":{ - "type":"structure", - "required":["StudioLifecycleConfigName"], - "members":{ - "StudioLifecycleConfigName":{ - "shape":"StudioLifecycleConfigName", - "documentation":"

The name of the Amazon SageMaker AI Studio Lifecycle Configuration to delete.

" - } - } - }, - "DeleteTagsInput":{ - "type":"structure", - "required":[ - "ResourceArn", - "TagKeys" - ], - "members":{ - "ResourceArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the resource whose tags you want to delete.

" - }, - "TagKeys":{ - "shape":"TagKeyList", - "documentation":"

An array or one or more tag keys to delete.

" - } - } - }, - "DeleteTagsOutput":{ - "type":"structure", - "members":{} - }, - "DeleteTrainingJobRequest":{ - "type":"structure", - "required":["TrainingJobName"], - "members":{ - "TrainingJobName":{ - "shape":"TrainingJobName", - "documentation":"

The name of the training job to delete.

" - } - } - }, - "DeleteTrialComponentRequest":{ - "type":"structure", - "required":["TrialComponentName"], - "members":{ - "TrialComponentName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the component to delete.

" - } - } - }, - "DeleteTrialComponentResponse":{ - "type":"structure", - "members":{ - "TrialComponentArn":{ - "shape":"TrialComponentArn", - "documentation":"

The Amazon Resource Name (ARN) of the component is being deleted.

" - } - } - }, - "DeleteTrialRequest":{ - "type":"structure", - "required":["TrialName"], - "members":{ - "TrialName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the trial to delete.

" - } - } - }, - "DeleteTrialResponse":{ - "type":"structure", - "members":{ - "TrialArn":{ - "shape":"TrialArn", - "documentation":"

The Amazon Resource Name (ARN) of the trial that is being deleted.

" - } - } - }, - "DeleteUserProfileRequest":{ - "type":"structure", - "required":[ - "DomainId", - "UserProfileName" - ], - "members":{ - "DomainId":{ - "shape":"DomainId", - "documentation":"

The domain ID.

" - }, - "UserProfileName":{ - "shape":"UserProfileName", - "documentation":"

The user profile name.

" - } - } - }, - "DeleteWorkforceRequest":{ - "type":"structure", - "required":["WorkforceName"], - "members":{ - "WorkforceName":{ - "shape":"WorkforceName", - "documentation":"

The name of the workforce.

" - } - } - }, - "DeleteWorkforceResponse":{ - "type":"structure", - "members":{} - }, - "DeleteWorkteamRequest":{ - "type":"structure", - "required":["WorkteamName"], - "members":{ - "WorkteamName":{ - "shape":"WorkteamName", - "documentation":"

The name of the work team to delete.

" - } - } - }, - "DeleteWorkteamResponse":{ - "type":"structure", - "required":["Success"], - "members":{ - "Success":{ - "shape":"Success", - "documentation":"

Returns true if the work team was successfully deleted; otherwise, returns false.

", - "box":true - } - } - }, - "DependencyCopyPath":{ - "type":"string", - "max":1023, - "min":0, - "pattern":".*" - }, - "DependencyOriginPath":{ - "type":"string", - "max":1023, - "min":0, - "pattern":".*" - }, - "DeployedImage":{ - "type":"structure", - "members":{ - "SpecifiedImage":{ - "shape":"ContainerImage", - "documentation":"

The image path you specified when you created the model.

" - }, - "ResolvedImage":{ - "shape":"ContainerImage", - "documentation":"

The specific digest path of the image hosted in this ProductionVariant.

" - }, - "ResolutionTime":{ - "shape":"Timestamp", - "documentation":"

The date and time when the image path for the model resolved to the ResolvedImage

" - } - }, - "documentation":"

Gets the Amazon EC2 Container Registry path of the docker image of the model that is hosted in this ProductionVariant.

If you used the registry/repository[:tag] form to specify the image path of the primary container when you created the model hosted in this ProductionVariant, the path resolves to a path of the form registry/repository[@digest]. A digest is a hash value that identifies a specific version of an image. For information about Amazon ECR paths, see Pulling an Image in the Amazon ECR User Guide.

" - }, - "DeployedImages":{ - "type":"list", - "member":{"shape":"DeployedImage"} - }, - "DeploymentConfig":{ - "type":"structure", - "members":{ - "BlueGreenUpdatePolicy":{ - "shape":"BlueGreenUpdatePolicy", - "documentation":"

Update policy for a blue/green deployment. If this update policy is specified, SageMaker creates a new fleet during the deployment while maintaining the old fleet. SageMaker flips traffic to the new fleet according to the specified traffic routing configuration. Only one update policy should be used in the deployment configuration. If no update policy is specified, SageMaker uses a blue/green deployment strategy with all at once traffic shifting by default.

" - }, - "RollingUpdatePolicy":{ - "shape":"RollingUpdatePolicy", - "documentation":"

Specifies a rolling deployment strategy for updating a SageMaker endpoint.

" - }, - "AutoRollbackConfiguration":{ - "shape":"AutoRollbackConfig", - "documentation":"

Automatic rollback configuration for handling endpoint deployment failures and recovery.

" - } - }, - "documentation":"

The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.

" - }, - "DeploymentConfiguration":{ - "type":"structure", - "members":{ - "RollingUpdatePolicy":{ - "shape":"RollingDeploymentPolicy", - "documentation":"

The policy that SageMaker uses when updating the AMI versions of the cluster.

" - }, - "WaitIntervalInSeconds":{ - "shape":"WaitTimeIntervalInSeconds", - "documentation":"

The duration in seconds that SageMaker waits before updating more instances in the cluster.

" - }, - "AutoRollbackConfiguration":{ - "shape":"AutoRollbackAlarms", - "documentation":"

An array that contains the alarms that SageMaker monitors to know whether to roll back the AMI update.

" - } - }, - "documentation":"

The configuration to use when updating the AMI versions.

" - }, - "DeploymentRecommendation":{ - "type":"structure", - "required":["RecommendationStatus"], - "members":{ - "RecommendationStatus":{ - "shape":"RecommendationStatus", - "documentation":"

Status of the deployment recommendation. The status NOT_APPLICABLE means that SageMaker is unable to provide a default recommendation for the model using the information provided. If the deployment status is IN_PROGRESS, retry your API call after a few seconds to get a COMPLETED deployment recommendation.

" - }, - "RealTimeInferenceRecommendations":{ - "shape":"RealTimeInferenceRecommendations", - "documentation":"

A list of RealTimeInferenceRecommendation items.

" - } - }, - "documentation":"

A set of recommended deployment configurations for the model. To get more advanced recommendations, see CreateInferenceRecommendationsJob to create an inference recommendation job.

" - }, - "DeploymentStage":{ - "type":"structure", - "required":[ - "StageName", - "DeviceSelectionConfig" - ], - "members":{ - "StageName":{ - "shape":"EntityName", - "documentation":"

The name of the stage.

" - }, - "DeviceSelectionConfig":{ - "shape":"DeviceSelectionConfig", - "documentation":"

Configuration of the devices in the stage.

" - }, - "DeploymentConfig":{ - "shape":"EdgeDeploymentConfig", - "documentation":"

Configuration of the deployment details.

" - } - }, - "documentation":"

Contains information about a stage in an edge deployment plan.

" - }, - "DeploymentStageMaxResults":{ - "type":"integer", - "max":10 - }, - "DeploymentStageStatusSummaries":{ - "type":"list", - "member":{"shape":"DeploymentStageStatusSummary"} - }, - "DeploymentStageStatusSummary":{ - "type":"structure", - "required":[ - "StageName", - "DeviceSelectionConfig", - "DeploymentConfig", - "DeploymentStatus" - ], - "members":{ - "StageName":{ - "shape":"EntityName", - "documentation":"

The name of the stage.

" - }, - "DeviceSelectionConfig":{ - "shape":"DeviceSelectionConfig", - "documentation":"

Configuration of the devices in the stage.

" - }, - "DeploymentConfig":{ - "shape":"EdgeDeploymentConfig", - "documentation":"

Configuration of the deployment details.

" - }, - "DeploymentStatus":{ - "shape":"EdgeDeploymentStatus", - "documentation":"

General status of the current state.

" - } - }, - "documentation":"

Contains information summarizing the deployment stage results.

" - }, - "DeploymentStages":{ - "type":"list", - "member":{"shape":"DeploymentStage"} - }, - "DeregisterDevicesRequest":{ - "type":"structure", - "required":[ - "DeviceFleetName", - "DeviceNames" - ], - "members":{ - "DeviceFleetName":{ - "shape":"EntityName", - "documentation":"

The name of the fleet the devices belong to.

" - }, - "DeviceNames":{ - "shape":"DeviceNames", - "documentation":"

The unique IDs of the devices.

" - } - } - }, - "DerivedInformation":{ - "type":"structure", - "members":{ - "DerivedDataInputConfig":{ - "shape":"DataInputConfig", - "documentation":"

The data input configuration that SageMaker Neo automatically derived for the model. When SageMaker Neo derives this information, you don't need to specify the data input configuration when you create a compilation job.

" - } - }, - "documentation":"

Information that SageMaker Neo automatically derived about the model.

" - }, - "DescribeAIBenchmarkJobRequest":{ - "type":"structure", - "required":["AIBenchmarkJobName"], - "members":{ - "AIBenchmarkJobName":{ - "shape":"AIEntityName", - "documentation":"

The name of the AI benchmark job to describe.

" - } - } - }, - "DescribeAIBenchmarkJobResponse":{ - "type":"structure", - "required":[ - "AIBenchmarkJobName", - "AIBenchmarkJobArn", - "AIBenchmarkJobStatus", - "BenchmarkTarget", - "OutputConfig", - "AIWorkloadConfigIdentifier", - "RoleArn", - "CreationTime" - ], - "members":{ - "AIBenchmarkJobName":{ - "shape":"AIEntityName", - "documentation":"

The name of the AI benchmark job.

" - }, - "AIBenchmarkJobArn":{ - "shape":"AIBenchmarkJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the AI benchmark job.

" - }, - "AIBenchmarkJobStatus":{ - "shape":"AIBenchmarkJobStatus", - "documentation":"

The status of the AI benchmark job.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

If the benchmark job failed, the reason it failed.

" - }, - "BenchmarkTarget":{ - "shape":"AIBenchmarkTarget", - "documentation":"

The target endpoint that was benchmarked.

" - }, - "OutputConfig":{ - "shape":"AIBenchmarkOutputResult", - "documentation":"

The output configuration for the benchmark job, including the Amazon S3 output location and CloudWatch log information.

" - }, - "AIWorkloadConfigIdentifier":{ - "shape":"AIResourceIdentifier", - "documentation":"

The name or Amazon Resource Name (ARN) of the AI workload configuration used for this benchmark job.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the IAM role used by the benchmark job.

" - }, - "NetworkConfig":{ - "shape":"AIBenchmarkNetworkConfig", - "documentation":"

The network configuration for the benchmark job.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that indicates when the benchmark job was created.

" - }, - "StartTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that indicates when the benchmark job started running.

" - }, - "EndTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that indicates when the benchmark job completed.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The tags associated with the benchmark job.

" - } - } - }, - "DescribeAIRecommendationJobRequest":{ - "type":"structure", - "required":["AIRecommendationJobName"], - "members":{ - "AIRecommendationJobName":{ - "shape":"AIEntityName", - "documentation":"

The name of the AI recommendation job to describe.

" - } - } - }, - "DescribeAIRecommendationJobResponse":{ - "type":"structure", - "required":[ - "AIRecommendationJobName", - "AIRecommendationJobArn", - "AIRecommendationJobStatus", - "ModelSource", - "OutputConfig", - "AIWorkloadConfigIdentifier", - "RoleArn", - "CreationTime" - ], - "members":{ - "AIRecommendationJobName":{ - "shape":"AIEntityName", - "documentation":"

The name of the AI recommendation job.

" - }, - "AIRecommendationJobArn":{ - "shape":"AIRecommendationJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the AI recommendation job.

" - }, - "AIRecommendationJobStatus":{ - "shape":"AIRecommendationJobStatus", - "documentation":"

The status of the AI recommendation job.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

If the recommendation job failed, the reason it failed.

" - }, - "ModelSource":{ - "shape":"AIModelSource", - "documentation":"

The source of the model that was analyzed.

" - }, - "OutputConfig":{ - "shape":"AIRecommendationOutputResult", - "documentation":"

The output configuration for the recommendation job.

" - }, - "InferenceSpecification":{ - "shape":"AIRecommendationInferenceSpecification", - "documentation":"

The inference framework configuration.

" - }, - "AIWorkloadConfigIdentifier":{ - "shape":"AIResourceIdentifier", - "documentation":"

The name or Amazon Resource Name (ARN) of the AI workload configuration used for this recommendation job.

" - }, - "OptimizeModel":{ - "shape":"AIRecommendationAllowOptimization", - "documentation":"

Whether model optimization techniques were allowed.

" - }, - "PerformanceTarget":{ - "shape":"AIRecommendationPerformanceTarget", - "documentation":"

The performance targets specified for the recommendation job.

" - }, - "Recommendations":{ - "shape":"AIRecommendationList", - "documentation":"

The list of optimization recommendations generated by the job. Each recommendation includes optimization details, deployment configuration, expected performance metrics, and the associated benchmark job ARN.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the IAM role used by the recommendation job.

" - }, - "ComputeSpec":{ - "shape":"AIRecommendationComputeSpec", - "documentation":"

The compute resource specification for the recommendation job.

" - }, - "AdapterSource":{ - "shape":"AIAdapterSource", - "documentation":"

The LoRA adapter source that you specified when you created the recommendation job. This field is absent when you created the job without LoRA adapters.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that indicates when the recommendation job was created.

" - }, - "StartTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that indicates when the recommendation job started running.

" - }, - "EndTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that indicates when the recommendation job completed.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The tags associated with the recommendation job.

" - } - } - }, - "DescribeAIWorkloadConfigRequest":{ - "type":"structure", - "required":["AIWorkloadConfigName"], - "members":{ - "AIWorkloadConfigName":{ - "shape":"AIEntityName", - "documentation":"

The name of the AI workload configuration to describe.

" - } - } - }, - "DescribeAIWorkloadConfigResponse":{ - "type":"structure", - "required":[ - "AIWorkloadConfigName", - "AIWorkloadConfigArn", - "CreationTime" - ], - "members":{ - "AIWorkloadConfigName":{ - "shape":"AIEntityName", - "documentation":"

The name of the AI workload configuration.

" - }, - "AIWorkloadConfigArn":{ - "shape":"AIWorkloadConfigArn", - "documentation":"

The Amazon Resource Name (ARN) of the AI workload configuration.

" - }, - "DatasetConfig":{ - "shape":"AIDatasetConfig", - "documentation":"

The dataset configuration for the workload.

" - }, - "AIWorkloadConfigs":{ - "shape":"AIWorkloadConfigs", - "documentation":"

The benchmark tool configuration and workload specification.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The tags associated with the AI workload configuration.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that indicates when the AI workload configuration was created.

" - } - } - }, - "DescribeActionRequest":{ - "type":"structure", - "required":["ActionName"], - "members":{ - "ActionName":{ - "shape":"ExperimentEntityNameOrArn", - "documentation":"

The name of the action to describe.

" - } - } - }, - "DescribeActionResponse":{ - "type":"structure", - "members":{ - "ActionName":{ - "shape":"ExperimentEntityNameOrArn", - "documentation":"

The name of the action.

" - }, - "ActionArn":{ - "shape":"ActionArn", - "documentation":"

The Amazon Resource Name (ARN) of the action.

" - }, - "Source":{ - "shape":"ActionSource", - "documentation":"

The source of the action.

" - }, - "ActionType":{ - "shape":"String256", - "documentation":"

The type of the action.

" - }, - "Description":{ - "shape":"ExperimentDescription", - "documentation":"

The description of the action.

" - }, - "Status":{ - "shape":"ActionStatus", - "documentation":"

The status of the action.

" - }, - "Properties":{ - "shape":"LineageEntityParameters", - "documentation":"

A list of the action's properties.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

When the action was created.

" - }, - "CreatedBy":{"shape":"UserContext"}, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

When the action was last modified.

" - }, - "LastModifiedBy":{"shape":"UserContext"}, - "MetadataProperties":{"shape":"MetadataProperties"}, - "LineageGroupArn":{ - "shape":"LineageGroupArn", - "documentation":"

The Amazon Resource Name (ARN) of the lineage group.

" - } - } - }, - "DescribeAlgorithmInput":{ - "type":"structure", - "required":["AlgorithmName"], - "members":{ - "AlgorithmName":{ - "shape":"ArnOrName", - "documentation":"

The name of the algorithm to describe.

" - } - } - }, - "DescribeAlgorithmOutput":{ - "type":"structure", - "required":[ - "AlgorithmName", - "AlgorithmArn", - "CreationTime", - "TrainingSpecification", - "AlgorithmStatus", - "AlgorithmStatusDetails" - ], - "members":{ - "AlgorithmName":{ - "shape":"EntityName", - "documentation":"

The name of the algorithm being described.

" - }, - "AlgorithmArn":{ - "shape":"AlgorithmArn", - "documentation":"

The Amazon Resource Name (ARN) of the algorithm.

" - }, - "AlgorithmDescription":{ - "shape":"EntityDescription", - "documentation":"

A brief summary about the algorithm.

" - }, - "CreationTime":{ - "shape":"CreationTime", - "documentation":"

A timestamp specifying when the algorithm was created.

" - }, - "TrainingSpecification":{ - "shape":"TrainingSpecification", - "documentation":"

Details about training jobs run by this algorithm.

" - }, - "InferenceSpecification":{ - "shape":"InferenceSpecification", - "documentation":"

Details about inference jobs that the algorithm runs.

" - }, - "ValidationSpecification":{ - "shape":"AlgorithmValidationSpecification", - "documentation":"

Details about configurations for one or more training jobs that SageMaker runs to test the algorithm.

" - }, - "AlgorithmStatus":{ - "shape":"AlgorithmStatus", - "documentation":"

The current status of the algorithm.

" - }, - "AlgorithmStatusDetails":{ - "shape":"AlgorithmStatusDetails", - "documentation":"

Details about the current status of the algorithm.

" - }, - "ProductId":{ - "shape":"ProductId", - "documentation":"

The product identifier of the algorithm.

" - }, - "CertifyForMarketplace":{ - "shape":"CertifyForMarketplace", - "documentation":"

Whether the algorithm is certified to be listed in Amazon Web Services Marketplace.

", - "box":true - } - } - }, - "DescribeAppImageConfigRequest":{ - "type":"structure", - "required":["AppImageConfigName"], - "members":{ - "AppImageConfigName":{ - "shape":"AppImageConfigName", - "documentation":"

The name of the AppImageConfig to describe.

" - } - } - }, - "DescribeAppImageConfigResponse":{ - "type":"structure", - "members":{ - "AppImageConfigArn":{ - "shape":"AppImageConfigArn", - "documentation":"

The ARN of the AppImageConfig.

" - }, - "AppImageConfigName":{ - "shape":"AppImageConfigName", - "documentation":"

The name of the AppImageConfig.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

When the AppImageConfig was created.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

When the AppImageConfig was last modified.

" - }, - "KernelGatewayImageConfig":{ - "shape":"KernelGatewayImageConfig", - "documentation":"

The configuration of a KernelGateway app.

" - }, - "JupyterLabAppImageConfig":{ - "shape":"JupyterLabAppImageConfig", - "documentation":"

The configuration of the JupyterLab app.

" - }, - "CodeEditorAppImageConfig":{ - "shape":"CodeEditorAppImageConfig", - "documentation":"

The configuration of the Code Editor app.

" - } - } - }, - "DescribeAppRequest":{ - "type":"structure", - "required":[ - "DomainId", - "AppType", - "AppName" - ], - "members":{ - "DomainId":{ - "shape":"DomainId", - "documentation":"

The domain ID.

" - }, - "UserProfileName":{ - "shape":"UserProfileName", - "documentation":"

The user profile name. If this value is not set, then SpaceName must be set.

" - }, - "SpaceName":{ - "shape":"SpaceName", - "documentation":"

The name of the space.

" - }, - "AppType":{ - "shape":"AppType", - "documentation":"

The type of app.

" - }, - "AppName":{ - "shape":"AppName", - "documentation":"

The name of the app.

" - } - } - }, - "DescribeAppResponse":{ - "type":"structure", - "members":{ - "AppArn":{ - "shape":"AppArn", - "documentation":"

The Amazon Resource Name (ARN) of the app.

" - }, - "AppType":{ - "shape":"AppType", - "documentation":"

The type of app.

" - }, - "AppName":{ - "shape":"AppName", - "documentation":"

The name of the app.

" - }, - "DomainId":{ - "shape":"DomainId", - "documentation":"

The domain ID.

" - }, - "UserProfileName":{ - "shape":"UserProfileName", - "documentation":"

The user profile name.

" - }, - "SpaceName":{ - "shape":"SpaceName", - "documentation":"

The name of the space. If this value is not set, then UserProfileName must be set.

" - }, - "Status":{ - "shape":"AppStatus", - "documentation":"

The status.

" - }, - "EffectiveTrustedIdentityPropagationStatus":{ - "shape":"FeatureStatus", - "documentation":"

The effective status of Trusted Identity Propagation (TIP) for this application. When enabled, user identities from IAM Identity Center are being propagated through the application to TIP enabled Amazon Web Services services. When disabled, standard IAM role-based access is used.

" - }, - "RecoveryMode":{ - "shape":"Boolean", - "documentation":"

Indicates whether the application is launched in recovery mode.

", - "box":true - }, - "LastHealthCheckTimestamp":{ - "shape":"Timestamp", - "documentation":"

The timestamp of the last health check.

" - }, - "LastUserActivityTimestamp":{ - "shape":"Timestamp", - "documentation":"

The timestamp of the last user's activity. LastUserActivityTimestamp is also updated when SageMaker AI performs health checks without user activity. As a result, this value is set to the same value as LastHealthCheckTimestamp.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The creation time of the application.

After an application has been shut down for 24 hours, SageMaker AI deletes all metadata for the application. To be considered an update and retain application metadata, applications must be restarted within 24 hours after the previous application has been shut down. After this time window, creation of an application is considered a new application rather than an update of the previous application.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

The failure reason.

" - }, - "ResourceSpec":{ - "shape":"ResourceSpec", - "documentation":"

The instance type and the Amazon Resource Name (ARN) of the SageMaker AI image created on the instance.

" - }, - "BuiltInLifecycleConfigArn":{ - "shape":"StudioLifecycleConfigArn", - "documentation":"

The lifecycle configuration that runs before the default lifecycle configuration

" - } - } - }, - "DescribeArtifactRequest":{ - "type":"structure", - "required":["ArtifactArn"], - "members":{ - "ArtifactArn":{ - "shape":"ArtifactArn", - "documentation":"

The Amazon Resource Name (ARN) of the artifact to describe.

" - } - } - }, - "DescribeArtifactResponse":{ - "type":"structure", - "members":{ - "ArtifactName":{ - "shape":"ExperimentEntityNameOrArn", - "documentation":"

The name of the artifact.

" - }, - "ArtifactArn":{ - "shape":"ArtifactArn", - "documentation":"

The Amazon Resource Name (ARN) of the artifact.

" - }, - "Source":{ - "shape":"ArtifactSource", - "documentation":"

The source of the artifact.

" - }, - "ArtifactType":{ - "shape":"String256", - "documentation":"

The type of the artifact.

" - }, - "Properties":{ - "shape":"LineageEntityParameters", - "documentation":"

A list of the artifact's properties.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

When the artifact was created.

" - }, - "CreatedBy":{"shape":"UserContext"}, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

When the artifact was last modified.

" - }, - "LastModifiedBy":{"shape":"UserContext"}, - "MetadataProperties":{"shape":"MetadataProperties"}, - "LineageGroupArn":{ - "shape":"LineageGroupArn", - "documentation":"

The Amazon Resource Name (ARN) of the lineage group.

" - } - } - }, - "DescribeAutoMLJobRequest":{ - "type":"structure", - "required":["AutoMLJobName"], - "members":{ - "AutoMLJobName":{ - "shape":"AutoMLJobName", - "documentation":"

Requests information about an AutoML job using its unique name.

" - } - } - }, - "DescribeAutoMLJobResponse":{ - "type":"structure", - "required":[ - "AutoMLJobName", - "AutoMLJobArn", - "InputDataConfig", - "OutputDataConfig", - "RoleArn", - "CreationTime", - "LastModifiedTime", - "AutoMLJobStatus", - "AutoMLJobSecondaryStatus" - ], - "members":{ - "AutoMLJobName":{ - "shape":"AutoMLJobName", - "documentation":"

Returns the name of the AutoML job.

" - }, - "AutoMLJobArn":{ - "shape":"AutoMLJobArn", - "documentation":"

Returns the ARN of the AutoML job.

" - }, - "InputDataConfig":{ - "shape":"AutoMLInputDataConfig", - "documentation":"

Returns the input data configuration for the AutoML job.

" - }, - "OutputDataConfig":{ - "shape":"AutoMLOutputDataConfig", - "documentation":"

Returns the job's output data config.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The ARN of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3.

" - }, - "AutoMLJobObjective":{ - "shape":"AutoMLJobObjective", - "documentation":"

Returns the job's objective.

" - }, - "ProblemType":{ - "shape":"ProblemType", - "documentation":"

Returns the job's problem type.

" - }, - "AutoMLJobConfig":{ - "shape":"AutoMLJobConfig", - "documentation":"

Returns the configuration for the AutoML job.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

Returns the creation time of the AutoML job.

" - }, - "EndTime":{ - "shape":"Timestamp", - "documentation":"

Returns the end time of the AutoML job.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

Returns the job's last modified time.

" - }, - "FailureReason":{ - "shape":"AutoMLFailureReason", - "documentation":"

Returns the failure reason for an AutoML job, when applicable.

" - }, - "PartialFailureReasons":{ - "shape":"AutoMLPartialFailureReasons", - "documentation":"

Returns a list of reasons for partial failures within an AutoML job.

" - }, - "BestCandidate":{ - "shape":"AutoMLCandidate", - "documentation":"

The best model candidate selected by SageMaker AI Autopilot using both the best objective metric and lowest InferenceLatency for an experiment.

" - }, - "AutoMLJobStatus":{ - "shape":"AutoMLJobStatus", - "documentation":"

Returns the status of the AutoML job.

" - }, - "AutoMLJobSecondaryStatus":{ - "shape":"AutoMLJobSecondaryStatus", - "documentation":"

Returns the secondary status of the AutoML job.

" - }, - "GenerateCandidateDefinitionsOnly":{ - "shape":"GenerateCandidateDefinitionsOnly", - "documentation":"

Indicates whether the output for an AutoML job generates candidate definitions only.

", - "box":true - }, - "AutoMLJobArtifacts":{ - "shape":"AutoMLJobArtifacts", - "documentation":"

Returns information on the job's artifacts found in AutoMLJobArtifacts.

" - }, - "ResolvedAttributes":{ - "shape":"ResolvedAttributes", - "documentation":"

Contains ProblemType, AutoMLJobObjective, and CompletionCriteria. If you do not provide these values, they are inferred.

" - }, - "ModelDeployConfig":{ - "shape":"ModelDeployConfig", - "documentation":"

Indicates whether the model was deployed automatically to an endpoint and the name of that endpoint if deployed automatically.

" - }, - "ModelDeployResult":{ - "shape":"ModelDeployResult", - "documentation":"

Provides information about endpoint for the model deployment.

" - } - } - }, - "DescribeAutoMLJobV2Request":{ - "type":"structure", - "required":["AutoMLJobName"], - "members":{ - "AutoMLJobName":{ - "shape":"AutoMLJobName", - "documentation":"

Requests information about an AutoML job V2 using its unique name.

" - } - } - }, - "DescribeAutoMLJobV2Response":{ - "type":"structure", - "required":[ - "AutoMLJobName", - "AutoMLJobArn", - "AutoMLJobInputDataConfig", - "OutputDataConfig", - "RoleArn", - "CreationTime", - "LastModifiedTime", - "AutoMLJobStatus", - "AutoMLJobSecondaryStatus" - ], - "members":{ - "AutoMLJobName":{ - "shape":"AutoMLJobName", - "documentation":"

Returns the name of the AutoML job V2.

" - }, - "AutoMLJobArn":{ - "shape":"AutoMLJobArn", - "documentation":"

Returns the Amazon Resource Name (ARN) of the AutoML job V2.

" - }, - "AutoMLJobInputDataConfig":{ - "shape":"AutoMLJobInputDataConfig", - "documentation":"

Returns an array of channel objects describing the input data and their location.

" - }, - "OutputDataConfig":{ - "shape":"AutoMLOutputDataConfig", - "documentation":"

Returns the job's output data config.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The ARN of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3.

" - }, - "AutoMLJobObjective":{ - "shape":"AutoMLJobObjective", - "documentation":"

Returns the job's objective.

" - }, - "AutoMLProblemTypeConfig":{ - "shape":"AutoMLProblemTypeConfig", - "documentation":"

Returns the configuration settings of the problem type set for the AutoML job V2.

" - }, - "AutoMLProblemTypeConfigName":{ - "shape":"AutoMLProblemTypeConfigName", - "documentation":"

Returns the name of the problem type configuration set for the AutoML job V2.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

Returns the creation time of the AutoML job V2.

" - }, - "EndTime":{ - "shape":"Timestamp", - "documentation":"

Returns the end time of the AutoML job V2.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

Returns the job's last modified time.

" - }, - "FailureReason":{ - "shape":"AutoMLFailureReason", - "documentation":"

Returns the reason for the failure of the AutoML job V2, when applicable.

" - }, - "PartialFailureReasons":{ - "shape":"AutoMLPartialFailureReasons", - "documentation":"

Returns a list of reasons for partial failures within an AutoML job V2.

" - }, - "BestCandidate":{ - "shape":"AutoMLCandidate", - "documentation":"

Information about the candidate produced by an AutoML training job V2, including its status, steps, and other properties.

" - }, - "AutoMLJobStatus":{ - "shape":"AutoMLJobStatus", - "documentation":"

Returns the status of the AutoML job V2.

" - }, - "AutoMLJobSecondaryStatus":{ - "shape":"AutoMLJobSecondaryStatus", - "documentation":"

Returns the secondary status of the AutoML job V2.

" - }, - "AutoMLJobArtifacts":{"shape":"AutoMLJobArtifacts"}, - "ResolvedAttributes":{ - "shape":"AutoMLResolvedAttributes", - "documentation":"

Returns the resolved attributes used by the AutoML job V2.

" - }, - "ModelDeployConfig":{ - "shape":"ModelDeployConfig", - "documentation":"

Indicates whether the model was deployed automatically to an endpoint and the name of that endpoint if deployed automatically.

" - }, - "ModelDeployResult":{ - "shape":"ModelDeployResult", - "documentation":"

Provides information about endpoint for the model deployment.

" - }, - "DataSplitConfig":{ - "shape":"AutoMLDataSplitConfig", - "documentation":"

Returns the configuration settings of how the data are split into train and validation datasets.

" - }, - "SecurityConfig":{ - "shape":"AutoMLSecurityConfig", - "documentation":"

Returns the security configuration for traffic encryption or Amazon VPC settings.

" - }, - "AutoMLComputeConfig":{ - "shape":"AutoMLComputeConfig", - "documentation":"

The compute configuration used for the AutoML job V2.

" - } - } - }, - "DescribeClusterEventRequest":{ - "type":"structure", - "required":[ - "EventId", - "ClusterName" - ], - "members":{ - "EventId":{ - "shape":"EventId", - "documentation":"

The unique identifier (UUID) of the event to describe. This ID can be obtained from the ListClusterEvents operation.

" - }, - "ClusterName":{ - "shape":"ClusterNameOrArn", - "documentation":"

The name or Amazon Resource Name (ARN) of the HyperPod cluster associated with the event.

" - } - } - }, - "DescribeClusterEventResponse":{ - "type":"structure", - "members":{ - "EventDetails":{ - "shape":"ClusterEventDetail", - "documentation":"

Detailed information about the requested cluster event, including event metadata for various resource types such as Cluster, InstanceGroup, Instance, and their associated attributes.

" - } - } - }, - "DescribeClusterNodeRequest":{ - "type":"structure", - "required":["ClusterName"], - "members":{ - "ClusterName":{ - "shape":"ClusterNameOrArn", - "documentation":"

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which the node is.

" - }, - "NodeId":{ - "shape":"ClusterNodeId", - "documentation":"

The ID of the SageMaker HyperPod cluster node.

" - }, - "NodeLogicalId":{ - "shape":"ClusterNodeLogicalId", - "documentation":"

The logical identifier of the node to describe. You can specify either NodeLogicalId or InstanceId, but not both. NodeLogicalId can be used to describe nodes that are still being provisioned and don't yet have an InstanceId assigned.

" - } - } - }, - "DescribeClusterNodeResponse":{ - "type":"structure", - "required":["NodeDetails"], - "members":{ - "NodeDetails":{ - "shape":"ClusterNodeDetails", - "documentation":"

The details of the SageMaker HyperPod cluster node.

" - } - } - }, - "DescribeClusterRequest":{ - "type":"structure", - "required":["ClusterName"], - "members":{ - "ClusterName":{ - "shape":"ClusterNameOrArn", - "documentation":"

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

" - } - } - }, - "DescribeClusterResponse":{ - "type":"structure", - "required":[ - "ClusterArn", - "ClusterStatus", - "InstanceGroups" - ], - "members":{ - "ClusterArn":{ - "shape":"ClusterArn", - "documentation":"

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

" - }, - "ClusterName":{ - "shape":"ClusterName", - "documentation":"

The name of the SageMaker HyperPod cluster.

" - }, - "ClusterStatus":{ - "shape":"ClusterStatus", - "documentation":"

The status of the SageMaker HyperPod cluster.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The time when the SageMaker Cluster is created.

" - }, - "FailureMessage":{ - "shape":"String", - "documentation":"

The failure message of the SageMaker HyperPod cluster.

" - }, - "InstanceGroups":{ - "shape":"ClusterInstanceGroupDetailsList", - "documentation":"

The instance groups of the SageMaker HyperPod cluster.

" - }, - "RestrictedInstanceGroups":{ - "shape":"ClusterRestrictedInstanceGroupDetailsList", - "documentation":"

The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.

" - }, - "RestrictedInstanceGroupsConfig":{ - "shape":"ClusterRestrictedInstanceGroupsConfigOutput", - "documentation":"

The configuration for the restricted instance groups (RIG) in the SageMaker HyperPod cluster.

" - }, - "VpcConfig":{"shape":"VpcConfig"}, - "Orchestrator":{ - "shape":"ClusterOrchestrator", - "documentation":"

The type of orchestrator used for the SageMaker HyperPod cluster.

" - }, - "TieredStorageConfig":{ - "shape":"ClusterTieredStorageConfig", - "documentation":"

The current configuration for managed tier checkpointing on the HyperPod cluster. For example, this shows whether the feature is enabled and the percentage of cluster memory allocated for checkpoint storage.

" - }, - "NodeRecovery":{ - "shape":"ClusterNodeRecovery", - "documentation":"

The node recovery mode configured for the SageMaker HyperPod cluster.

" - }, - "NodeProvisioningMode":{ - "shape":"ClusterNodeProvisioningMode", - "documentation":"

The mode used for provisioning nodes in the cluster.

" - }, - "ClusterRole":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the IAM role that HyperPod uses for cluster autoscaling operations.

" - }, - "AutoScaling":{ - "shape":"ClusterAutoScalingConfigOutput", - "documentation":"

The current autoscaling configuration and status for the autoscaler.

" - } - } - }, - "DescribeClusterSchedulerConfigRequest":{ - "type":"structure", - "required":["ClusterSchedulerConfigId"], - "members":{ - "ClusterSchedulerConfigId":{ - "shape":"ClusterSchedulerConfigId", - "documentation":"

ID of the cluster policy.

" - }, - "ClusterSchedulerConfigVersion":{ - "shape":"Integer", - "documentation":"

Version of the cluster policy.

", - "box":true - } - } - }, - "DescribeClusterSchedulerConfigResponse":{ - "type":"structure", - "required":[ - "ClusterSchedulerConfigArn", - "ClusterSchedulerConfigId", - "Name", - "ClusterSchedulerConfigVersion", - "Status", - "CreationTime" - ], - "members":{ - "ClusterSchedulerConfigArn":{ - "shape":"ClusterSchedulerConfigArn", - "documentation":"

ARN of the cluster policy.

" - }, - "ClusterSchedulerConfigId":{ - "shape":"ClusterSchedulerConfigId", - "documentation":"

ID of the cluster policy.

" - }, - "Name":{ - "shape":"EntityName", - "documentation":"

Name of the cluster policy.

" - }, - "ClusterSchedulerConfigVersion":{ - "shape":"Integer", - "documentation":"

Version of the cluster policy.

", - "box":true - }, - "Status":{ - "shape":"SchedulerResourceStatus", - "documentation":"

Status of the cluster policy.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

Failure reason of the cluster policy.

" - }, - "StatusDetails":{ - "shape":"StatusDetailsMap", - "documentation":"

Additional details about the status of the cluster policy. This field provides context when the policy is in a non-active state, such as during creation, updates, or if failures occur.

" - }, - "ClusterArn":{ - "shape":"ClusterArn", - "documentation":"

ARN of the cluster where the cluster policy is applied.

" - }, - "SchedulerConfig":{ - "shape":"SchedulerConfig", - "documentation":"

Cluster policy configuration. This policy is used for task prioritization and fair-share allocation. This helps prioritize critical workloads and distributes idle compute across entities.

" - }, - "Description":{ - "shape":"EntityDescription", - "documentation":"

Description of the cluster policy.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

Creation time of the cluster policy.

" - }, - "CreatedBy":{"shape":"UserContext"}, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

Last modified time of the cluster policy.

" - }, - "LastModifiedBy":{"shape":"UserContext"} - } - }, - "DescribeCodeRepositoryInput":{ - "type":"structure", - "required":["CodeRepositoryName"], - "members":{ - "CodeRepositoryName":{ - "shape":"EntityName", - "documentation":"

The name of the Git repository to describe.

" - } - } - }, - "DescribeCodeRepositoryOutput":{ - "type":"structure", - "required":[ - "CodeRepositoryName", - "CodeRepositoryArn", - "CreationTime", - "LastModifiedTime" - ], - "members":{ - "CodeRepositoryName":{ - "shape":"EntityName", - "documentation":"

The name of the Git repository.

" - }, - "CodeRepositoryArn":{ - "shape":"CodeRepositoryArn", - "documentation":"

The Amazon Resource Name (ARN) of the Git repository.

" - }, - "CreationTime":{ - "shape":"CreationTime", - "documentation":"

The date and time that the repository was created.

" - }, - "LastModifiedTime":{ - "shape":"LastModifiedTime", - "documentation":"

The date and time that the repository was last changed.

" - }, - "GitConfig":{ - "shape":"GitConfig", - "documentation":"

Configuration details about the repository, including the URL where the repository is located, the default branch, and the Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the repository.

" - } - } - }, - "DescribeCompilationJobRequest":{ - "type":"structure", - "required":["CompilationJobName"], - "members":{ - "CompilationJobName":{ - "shape":"EntityName", - "documentation":"

The name of the model compilation job that you want information about.

" - } - } - }, - "DescribeCompilationJobResponse":{ - "type":"structure", - "required":[ - "CompilationJobName", - "CompilationJobArn", - "CompilationJobStatus", - "StoppingCondition", - "CreationTime", - "LastModifiedTime", - "FailureReason", - "ModelArtifacts", - "RoleArn", - "InputConfig", - "OutputConfig" - ], - "members":{ - "CompilationJobName":{ - "shape":"EntityName", - "documentation":"

The name of the model compilation job.

" - }, - "CompilationJobArn":{ - "shape":"CompilationJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the model compilation job.

" - }, - "CompilationJobStatus":{ - "shape":"CompilationJobStatus", - "documentation":"

The status of the model compilation job.

" - }, - "CompilationStartTime":{ - "shape":"Timestamp", - "documentation":"

The time when the model compilation job started the CompilationJob instances.

You are billed for the time between this timestamp and the timestamp in the CompilationEndTime field. In Amazon CloudWatch Logs, the start time might be later than this time. That's because it takes time to download the compilation job, which depends on the size of the compilation job container.

" - }, - "CompilationEndTime":{ - "shape":"Timestamp", - "documentation":"

The time when the model compilation job on a compilation job instance ended. For a successful or stopped job, this is when the job's model artifacts have finished uploading. For a failed job, this is when Amazon SageMaker AI detected that the job failed.

" - }, - "StoppingCondition":{ - "shape":"StoppingCondition", - "documentation":"

Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker AI ends the compilation job. Use this API to cap model training costs.

" - }, - "InferenceImage":{ - "shape":"InferenceImage", - "documentation":"

The inference image to use when compiling a model. Specify an image only if the target device is a cloud instance.

" - }, - "ModelPackageVersionArn":{ - "shape":"ModelPackageArn", - "documentation":"

The Amazon Resource Name (ARN) of the versioned model package that was provided to SageMaker Neo when you initiated a compilation job.

" - }, - "CreationTime":{ - "shape":"CreationTime", - "documentation":"

The time that the model compilation job was created.

" - }, - "LastModifiedTime":{ - "shape":"LastModifiedTime", - "documentation":"

The time that the status of the model compilation job was last modified.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

If a model compilation job failed, the reason it failed.

" - }, - "ModelArtifacts":{ - "shape":"ModelArtifacts", - "documentation":"

Information about the location in Amazon S3 that has been configured for storing the model artifacts used in the compilation job.

" - }, - "ModelDigests":{ - "shape":"ModelDigests", - "documentation":"

Provides a BLAKE2 hash value that identifies the compiled model artifacts in Amazon S3.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI assumes to perform the model compilation job.

" - }, - "InputConfig":{ - "shape":"InputConfig", - "documentation":"

Information about the location in Amazon S3 of the input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

" - }, - "OutputConfig":{ - "shape":"OutputConfig", - "documentation":"

Information about the output location for the compiled model and the target device that the model runs on.

" - }, - "VpcConfig":{ - "shape":"NeoVpcConfig", - "documentation":"

A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.

" - }, - "DerivedInformation":{ - "shape":"DerivedInformation", - "documentation":"

Information that SageMaker Neo automatically derived about the model.

" - } - } - }, - "DescribeComputeQuotaRequest":{ - "type":"structure", - "required":["ComputeQuotaId"], - "members":{ - "ComputeQuotaId":{ - "shape":"ComputeQuotaId", - "documentation":"

ID of the compute allocation definition.

" - }, - "ComputeQuotaVersion":{ - "shape":"Integer", - "documentation":"

Version of the compute allocation definition.

", - "box":true - } - } - }, - "DescribeComputeQuotaResponse":{ - "type":"structure", - "required":[ - "ComputeQuotaArn", - "ComputeQuotaId", - "Name", - "ComputeQuotaVersion", - "Status", - "ComputeQuotaTarget", - "CreationTime" - ], - "members":{ - "ComputeQuotaArn":{ - "shape":"ComputeQuotaArn", - "documentation":"

ARN of the compute allocation definition.

" - }, - "ComputeQuotaId":{ - "shape":"ComputeQuotaId", - "documentation":"

ID of the compute allocation definition.

" - }, - "Name":{ - "shape":"EntityName", - "documentation":"

Name of the compute allocation definition.

" - }, - "Description":{ - "shape":"EntityDescription", - "documentation":"

Description of the compute allocation definition.

" - }, - "ComputeQuotaVersion":{ - "shape":"Integer", - "documentation":"

Version of the compute allocation definition.

", - "box":true - }, - "Status":{ - "shape":"SchedulerResourceStatus", - "documentation":"

Status of the compute allocation definition.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

Failure reason of the compute allocation definition.

" - }, - "ClusterArn":{ - "shape":"ClusterArn", - "documentation":"

ARN of the cluster.

" - }, - "ComputeQuotaConfig":{ - "shape":"ComputeQuotaConfig", - "documentation":"

Configuration of the compute allocation definition. This includes the resource sharing option, and the setting to preempt low priority tasks.

" - }, - "ComputeQuotaTarget":{ - "shape":"ComputeQuotaTarget", - "documentation":"

The target entity to allocate compute resources to.

" - }, - "ActivationState":{ - "shape":"ActivationState", - "documentation":"

The state of the compute allocation being described. Use to enable or disable compute allocation.

Default is Enabled.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

Creation time of the compute allocation configuration.

" - }, - "CreatedBy":{"shape":"UserContext"}, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

Last modified time of the compute allocation configuration.

" - }, - "LastModifiedBy":{"shape":"UserContext"} - } - }, - "DescribeContextRequest":{ - "type":"structure", - "required":["ContextName"], - "members":{ - "ContextName":{ - "shape":"ContextNameOrArn", - "documentation":"

The name of the context to describe.

" - } - } - }, - "DescribeContextResponse":{ - "type":"structure", - "members":{ - "ContextName":{ - "shape":"ContextName", - "documentation":"

The name of the context.

" - }, - "ContextArn":{ - "shape":"ContextArn", - "documentation":"

The Amazon Resource Name (ARN) of the context.

" - }, - "Source":{ - "shape":"ContextSource", - "documentation":"

The source of the context.

" - }, - "ContextType":{ - "shape":"String256", - "documentation":"

The type of the context.

" - }, - "Description":{ - "shape":"ExperimentDescription", - "documentation":"

The description of the context.

" - }, - "Properties":{ - "shape":"LineageEntityParameters", - "documentation":"

A list of the context's properties.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

When the context was created.

" - }, - "CreatedBy":{"shape":"UserContext"}, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

When the context was last modified.

" - }, - "LastModifiedBy":{"shape":"UserContext"}, - "LineageGroupArn":{ - "shape":"LineageGroupArn", - "documentation":"

The Amazon Resource Name (ARN) of the lineage group.

" - } - } - }, - "DescribeDataQualityJobDefinitionRequest":{ - "type":"structure", - "required":["JobDefinitionName"], - "members":{ - "JobDefinitionName":{ - "shape":"MonitoringJobDefinitionName", - "documentation":"

The name of the data quality monitoring job definition to describe.

" - } - } - }, - "DescribeDataQualityJobDefinitionResponse":{ - "type":"structure", - "required":[ - "JobDefinitionArn", - "JobDefinitionName", - "CreationTime", - "DataQualityAppSpecification", - "DataQualityJobInput", - "DataQualityJobOutputConfig", - "JobResources", - "RoleArn" - ], - "members":{ - "JobDefinitionArn":{ - "shape":"MonitoringJobDefinitionArn", - "documentation":"

The Amazon Resource Name (ARN) of the data quality monitoring job definition.

" - }, - "JobDefinitionName":{ - "shape":"MonitoringJobDefinitionName", - "documentation":"

The name of the data quality monitoring job definition.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The time that the data quality monitoring job definition was created.

" - }, - "DataQualityBaselineConfig":{ - "shape":"DataQualityBaselineConfig", - "documentation":"

The constraints and baselines for the data quality monitoring job definition.

" - }, - "DataQualityAppSpecification":{ - "shape":"DataQualityAppSpecification", - "documentation":"

Information about the container that runs the data quality monitoring job.

" - }, - "DataQualityJobInput":{ - "shape":"DataQualityJobInput", - "documentation":"

The list of inputs for the data quality monitoring job. Currently endpoints are supported.

" - }, - "DataQualityJobOutputConfig":{"shape":"MonitoringOutputConfig"}, - "JobResources":{"shape":"MonitoringResources"}, - "NetworkConfig":{ - "shape":"MonitoringNetworkConfig", - "documentation":"

The networking configuration for the data quality monitoring job.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.

" - }, - "StoppingCondition":{"shape":"MonitoringStoppingCondition"} - } - }, - "DescribeDeviceFleetRequest":{ - "type":"structure", - "required":["DeviceFleetName"], - "members":{ - "DeviceFleetName":{ - "shape":"EntityName", - "documentation":"

The name of the fleet.

" - } - } - }, - "DescribeDeviceFleetResponse":{ - "type":"structure", - "required":[ - "DeviceFleetName", - "DeviceFleetArn", - "OutputConfig", - "CreationTime", - "LastModifiedTime" - ], - "members":{ - "DeviceFleetName":{ - "shape":"EntityName", - "documentation":"

The name of the fleet.

" - }, - "DeviceFleetArn":{ - "shape":"DeviceFleetArn", - "documentation":"

The The Amazon Resource Name (ARN) of the fleet.

" - }, - "OutputConfig":{ - "shape":"EdgeOutputConfig", - "documentation":"

The output configuration for storing sampled data.

" - }, - "Description":{ - "shape":"DeviceFleetDescription", - "documentation":"

A description of the fleet.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

Timestamp of when the device fleet was created.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

Timestamp of when the device fleet was last updated.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).

" - }, - "IotRoleAlias":{ - "shape":"IotRoleAlias", - "documentation":"

The Amazon Resource Name (ARN) alias created in Amazon Web Services Internet of Things (IoT).

" - } - } - }, - "DescribeDeviceRequest":{ - "type":"structure", - "required":[ - "DeviceName", - "DeviceFleetName" - ], - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"

Next token of device description.

" - }, - "DeviceName":{ - "shape":"EntityName", - "documentation":"

The unique ID of the device.

" - }, - "DeviceFleetName":{ - "shape":"EntityName", - "documentation":"

The name of the fleet the devices belong to.

" - } - } - }, - "DescribeDeviceResponse":{ - "type":"structure", - "required":[ - "DeviceName", - "DeviceFleetName", - "RegistrationTime" - ], - "members":{ - "DeviceArn":{ - "shape":"DeviceArn", - "documentation":"

The Amazon Resource Name (ARN) of the device.

" - }, - "DeviceName":{ - "shape":"EntityName", - "documentation":"

The unique identifier of the device.

" - }, - "Description":{ - "shape":"DeviceDescription", - "documentation":"

A description of the device.

" - }, - "DeviceFleetName":{ - "shape":"EntityName", - "documentation":"

The name of the fleet the device belongs to.

" - }, - "IotThingName":{ - "shape":"ThingName", - "documentation":"

The Amazon Web Services Internet of Things (IoT) object thing name associated with the device.

" - }, - "RegistrationTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp of the last registration or de-reregistration.

" - }, - "LatestHeartbeat":{ - "shape":"Timestamp", - "documentation":"

The last heartbeat received from the device.

" - }, - "Models":{ - "shape":"EdgeModels", - "documentation":"

Models on the device.

" - }, - "MaxModels":{ - "shape":"Integer", - "documentation":"

The maximum number of models.

", - "box":true - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

The response from the last list when returning a list large enough to need tokening.

" - }, - "AgentVersion":{ - "shape":"EdgeVersion", - "documentation":"

Edge Manager agent version.

" - } - } - }, - "DescribeDomainRequest":{ - "type":"structure", - "required":["DomainId"], - "members":{ - "DomainId":{ - "shape":"DomainId", - "documentation":"

The domain ID.

" - } - } - }, - "DescribeDomainResponse":{ - "type":"structure", - "members":{ - "DomainArn":{ - "shape":"DomainArn", - "documentation":"

The domain's Amazon Resource Name (ARN).

" - }, - "DomainId":{ - "shape":"DomainId", - "documentation":"

The domain ID.

" - }, - "DomainName":{ - "shape":"DomainName", - "documentation":"

The domain name.

" - }, - "HomeEfsFileSystemId":{ - "shape":"ResourceId", - "documentation":"

The ID of the Amazon Elastic File System managed by this Domain.

" - }, - "SingleSignOnManagedApplicationInstanceId":{ - "shape":"String256", - "documentation":"

The IAM Identity Center managed application instance ID.

" - }, - "SingleSignOnApplicationArn":{ - "shape":"SingleSignOnApplicationArn", - "documentation":"

The ARN of the application managed by SageMaker AI in IAM Identity Center. This value is only returned for domains created after October 1, 2023.

" - }, - "Status":{ - "shape":"DomainStatus", - "documentation":"

The status.

" - }, - "CreationTime":{ - "shape":"CreationTime", - "documentation":"

The creation time.

" - }, - "LastModifiedTime":{ - "shape":"LastModifiedTime", - "documentation":"

The last modified time.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

The failure reason.

" - }, - "SecurityGroupIdForDomainBoundary":{ - "shape":"SecurityGroupId", - "documentation":"

The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.

" - }, - "AuthMode":{ - "shape":"AuthMode", - "documentation":"

The domain's authentication mode.

" - }, - "DefaultUserSettings":{ - "shape":"UserSettings", - "documentation":"

Settings which are applied to UserProfiles in this domain if settings are not explicitly specified in a given UserProfile.

" - }, - "DomainSettings":{ - "shape":"DomainSettings", - "documentation":"

A collection of Domain settings.

" - }, - "AppNetworkAccessType":{ - "shape":"AppNetworkAccessType", - "documentation":"

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.

  • PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access

  • VpcOnly - All traffic is through the specified VPC and subnets

" - }, - "HomeEfsFileSystemKmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

Use KmsKeyId.

", - "deprecated":true, - "deprecatedMessage":"This property is deprecated, use KmsKeyId instead." - }, - "SubnetIds":{ - "shape":"Subnets", - "documentation":"

The VPC subnets that the domain uses for communication.

" - }, - "Url":{ - "shape":"String1024", - "documentation":"

The domain's URL.

" - }, - "VpcId":{ - "shape":"VpcId", - "documentation":"

The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

" - }, - "KmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to the domain.

" - }, - "AppSecurityGroupManagement":{ - "shape":"AppSecurityGroupManagement", - "documentation":"

The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided.

" - }, - "HomeEfsFileSystemCreation":{ - "shape":"HomeEfsFileSystemCreation", - "documentation":"

Indicates whether a home EFS file system is created for the domain.

" - }, - "TagPropagation":{ - "shape":"TagPropagation", - "documentation":"

Indicates whether custom tag propagation is supported for the domain.

" - }, - "DefaultSpaceSettings":{ - "shape":"DefaultSpaceSettings", - "documentation":"

The default settings for shared spaces that users create in the domain.

" - } - } - }, - "DescribeEdgeDeploymentPlanRequest":{ - "type":"structure", - "required":["EdgeDeploymentPlanName"], - "members":{ - "EdgeDeploymentPlanName":{ - "shape":"EntityName", - "documentation":"

The name of the deployment plan to describe.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the edge deployment plan has enough stages to require tokening, then this is the response from the last list of stages returned.

" - }, - "MaxResults":{ - "shape":"DeploymentStageMaxResults", - "documentation":"

The maximum number of results to select (50 by default).

", - "box":true - } - } - }, - "DescribeEdgeDeploymentPlanResponse":{ - "type":"structure", - "required":[ - "EdgeDeploymentPlanArn", - "EdgeDeploymentPlanName", - "ModelConfigs", - "DeviceFleetName", - "Stages" - ], - "members":{ - "EdgeDeploymentPlanArn":{ - "shape":"EdgeDeploymentPlanArn", - "documentation":"

The ARN of edge deployment plan.

" - }, - "EdgeDeploymentPlanName":{ - "shape":"EntityName", - "documentation":"

The name of the edge deployment plan.

" - }, - "ModelConfigs":{ - "shape":"EdgeDeploymentModelConfigs", - "documentation":"

List of models associated with the edge deployment plan.

" - }, - "DeviceFleetName":{ - "shape":"EntityName", - "documentation":"

The device fleet used for this edge deployment plan.

" - }, - "EdgeDeploymentSuccess":{ - "shape":"Integer", - "documentation":"

The number of edge devices with the successful deployment.

", - "box":true - }, - "EdgeDeploymentPending":{ - "shape":"Integer", - "documentation":"

The number of edge devices yet to pick up deployment, or in progress.

", - "box":true - }, - "EdgeDeploymentFailed":{ - "shape":"Integer", - "documentation":"

The number of edge devices that failed the deployment.

", - "box":true - }, - "Stages":{ - "shape":"DeploymentStageStatusSummaries", - "documentation":"

List of stages in the edge deployment plan.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

Token to use when calling the next set of stages in the edge deployment plan.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The time when the edge deployment plan was created.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The time when the edge deployment plan was last updated.

" - } - } - }, - "DescribeEdgePackagingJobRequest":{ - "type":"structure", - "required":["EdgePackagingJobName"], - "members":{ - "EdgePackagingJobName":{ - "shape":"EntityName", - "documentation":"

The name of the edge packaging job.

" - } - } - }, - "DescribeEdgePackagingJobResponse":{ - "type":"structure", - "required":[ - "EdgePackagingJobArn", - "EdgePackagingJobName", - "EdgePackagingJobStatus" - ], - "members":{ - "EdgePackagingJobArn":{ - "shape":"EdgePackagingJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the edge packaging job.

" - }, - "EdgePackagingJobName":{ - "shape":"EntityName", - "documentation":"

The name of the edge packaging job.

" - }, - "CompilationJobName":{ - "shape":"EntityName", - "documentation":"

The name of the SageMaker Neo compilation job that is used to locate model artifacts that are being packaged.

" - }, - "ModelName":{ - "shape":"EntityName", - "documentation":"

The name of the model.

" - }, - "ModelVersion":{ - "shape":"EdgeVersion", - "documentation":"

The version of the model.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact Neo.

" - }, - "OutputConfig":{ - "shape":"EdgeOutputConfig", - "documentation":"

The output configuration for the edge packaging job.

" - }, - "ResourceKey":{ - "shape":"KmsKeyId", - "documentation":"

The Amazon Web Services KMS key to use when encrypting the EBS volume the job run on.

" - }, - "EdgePackagingJobStatus":{ - "shape":"EdgePackagingJobStatus", - "documentation":"

The current status of the packaging job.

" - }, - "EdgePackagingJobStatusMessage":{ - "shape":"String", - "documentation":"

Returns a message describing the job status and error messages.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp of when the packaging job was created.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp of when the job was last updated.

" - }, - "ModelArtifact":{ - "shape":"S3Uri", - "documentation":"

The Amazon Simple Storage (S3) URI where model artifacts ares stored.

" - }, - "ModelSignature":{ - "shape":"String", - "documentation":"

The signature document of files in the model artifact.

" - }, - "PresetDeploymentOutput":{ - "shape":"EdgePresetDeploymentOutput", - "documentation":"

The output of a SageMaker Edge Manager deployable resource.

" - } - } - }, - "DescribeEndpointConfigInput":{ - "type":"structure", - "required":["EndpointConfigName"], - "members":{ - "EndpointConfigName":{ - "shape":"EndpointConfigName", - "documentation":"

The name of the endpoint configuration.

" - } - } - }, - "DescribeEndpointConfigOutput":{ - "type":"structure", - "required":[ - "EndpointConfigName", - "EndpointConfigArn", - "ProductionVariants", - "CreationTime" - ], - "members":{ - "EndpointConfigName":{ - "shape":"EndpointConfigName", - "documentation":"

Name of the SageMaker endpoint configuration.

" - }, - "EndpointConfigArn":{ - "shape":"EndpointConfigArn", - "documentation":"

The Amazon Resource Name (ARN) of the endpoint configuration.

" - }, - "ProductionVariants":{ - "shape":"ProductionVariantList", - "documentation":"

An array of ProductionVariant objects, one for each model that you want to host at this endpoint.

" - }, - "DataCaptureConfig":{"shape":"DataCaptureConfig"}, - "KmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that shows when the endpoint configuration was created.

" - }, - "AsyncInferenceConfig":{ - "shape":"AsyncInferenceConfig", - "documentation":"

Returns the description of an endpoint configuration created using the CreateEndpointConfig API.

" - }, - "ExplainerConfig":{ - "shape":"ExplainerConfig", - "documentation":"

The configuration parameters for an explainer.

" - }, - "ShadowProductionVariants":{ - "shape":"ProductionVariantList", - "documentation":"

An array of ProductionVariant objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants.

" - }, - "ExecutionRoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the IAM role that you assigned to the endpoint configuration.

" - }, - "VpcConfig":{"shape":"VpcConfig"}, - "EnableNetworkIsolation":{ - "shape":"Boolean", - "documentation":"

Indicates whether all model containers deployed to the endpoint are isolated. If they are, no inbound or outbound network calls can be made to or from the model containers.

", - "box":true - }, - "MetricsConfig":{ - "shape":"MetricsConfig", - "documentation":"

The configuration parameters for utilization metrics.

" - } - } - }, - "DescribeEndpointInput":{ - "type":"structure", - "required":["EndpointName"], - "members":{ - "EndpointName":{ - "shape":"EndpointName", - "documentation":"

The name of the endpoint.

" - } - } - }, - "DescribeEndpointOutput":{ - "type":"structure", - "required":[ - "EndpointName", - "EndpointArn", - "EndpointStatus", - "CreationTime", - "LastModifiedTime" - ], - "members":{ - "EndpointName":{ - "shape":"EndpointName", - "documentation":"

Name of the endpoint.

" - }, - "EndpointArn":{ - "shape":"EndpointArn", - "documentation":"

The Amazon Resource Name (ARN) of the endpoint.

" - }, - "EndpointConfigName":{ - "shape":"EndpointConfigName", - "documentation":"

The name of the endpoint configuration associated with this endpoint.

" - }, - "ProductionVariants":{ - "shape":"ProductionVariantSummaryList", - "documentation":"

An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.

" - }, - "DataCaptureConfig":{"shape":"DataCaptureConfigSummary"}, - "EndpointStatus":{ - "shape":"EndpointStatus", - "documentation":"

The status of the endpoint.

  • OutOfService: Endpoint is not available to take incoming requests.

  • Creating: CreateEndpoint is executing.

  • Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

  • SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count.

  • RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an InService status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly.

  • InService: Endpoint is available to process incoming requests.

  • Deleting: DeleteEndpoint is executing.

  • Failed: Endpoint could not be created, updated, or re-scaled. Use the FailureReason value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.

  • UpdateRollbackFailed: Both the rolling deployment and auto-rollback failed. Your endpoint is in service with a mix of the old and new endpoint configurations. For information about how to remedy this issue and restore the endpoint's status to InService, see Rolling Deployments.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

If the status of the endpoint is Failed, the reason why it failed.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that shows when the endpoint was created.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that shows when the endpoint was last modified.

" - }, - "LastDeploymentConfig":{ - "shape":"DeploymentConfig", - "documentation":"

The most recent deployment configuration for the endpoint.

" - }, - "AsyncInferenceConfig":{ - "shape":"AsyncInferenceConfig", - "documentation":"

Returns the description of an endpoint configuration created using the CreateEndpointConfig API.

" - }, - "PendingDeploymentSummary":{ - "shape":"PendingDeploymentSummary", - "documentation":"

Returns the summary of an in-progress deployment. This field is only returned when the endpoint is creating or updating with a new endpoint configuration.

" - }, - "ExplainerConfig":{ - "shape":"ExplainerConfig", - "documentation":"

The configuration parameters for an explainer.

" - }, - "ShadowProductionVariants":{ - "shape":"ProductionVariantSummaryList", - "documentation":"

An array of ProductionVariantSummary objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants.

" - }, - "MetricsConfig":{ - "shape":"MetricsConfig", - "documentation":"

The configuration parameters for utilization metrics.

" - } - } - }, - "DescribeExperimentRequest":{ - "type":"structure", - "required":["ExperimentName"], - "members":{ - "ExperimentName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the experiment to describe.

" - } - } - }, - "DescribeExperimentResponse":{ - "type":"structure", - "members":{ - "ExperimentName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the experiment.

" - }, - "ExperimentArn":{ - "shape":"ExperimentArn", - "documentation":"

The Amazon Resource Name (ARN) of the experiment.

" - }, - "DisplayName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the experiment as displayed. If DisplayName isn't specified, ExperimentName is displayed.

" - }, - "Source":{ - "shape":"ExperimentSource", - "documentation":"

The Amazon Resource Name (ARN) of the source and, optionally, the type.

" - }, - "Description":{ - "shape":"ExperimentDescription", - "documentation":"

The description of the experiment.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

When the experiment was created.

" - }, - "CreatedBy":{ - "shape":"UserContext", - "documentation":"

Who created the experiment.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

When the experiment was last modified.

" - }, - "LastModifiedBy":{ - "shape":"UserContext", - "documentation":"

Who last modified the experiment.

" - } - } - }, - "DescribeFeatureGroupRequest":{ - "type":"structure", - "required":["FeatureGroupName"], - "members":{ - "FeatureGroupName":{ - "shape":"FeatureGroupNameOrArn", - "documentation":"

The name or Amazon Resource Name (ARN) of the FeatureGroup you want described.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

A token to resume pagination of the list of Features (FeatureDefinitions). 2,500 Features are returned by default.

" - } - } - }, - "DescribeFeatureGroupResponse":{ - "type":"structure", - "required":[ - "FeatureGroupArn", - "FeatureGroupName", - "RecordIdentifierFeatureName", - "EventTimeFeatureName", - "FeatureDefinitions", - "CreationTime", - "NextToken" - ], - "members":{ - "FeatureGroupArn":{ - "shape":"FeatureGroupArn", - "documentation":"

The Amazon Resource Name (ARN) of the FeatureGroup.

" - }, - "FeatureGroupName":{ - "shape":"FeatureGroupName", - "documentation":"

he name of the FeatureGroup.

" - }, - "RecordIdentifierFeatureName":{ - "shape":"FeatureName", - "documentation":"

The name of the Feature used for RecordIdentifier, whose value uniquely identifies a record stored in the feature store.

" - }, - "EventTimeFeatureName":{ - "shape":"FeatureName", - "documentation":"

The name of the feature that stores the EventTime of a Record in a FeatureGroup.

An EventTime is a point in time when a new event occurs that corresponds to the creation or update of a Record in a FeatureGroup. All Records in the FeatureGroup have a corresponding EventTime.

" - }, - "FeatureDefinitions":{ - "shape":"FeatureDefinitions", - "documentation":"

A list of the Features in the FeatureGroup. Each feature is defined by a FeatureName and FeatureType.

" - }, - "CreationTime":{ - "shape":"CreationTime", - "documentation":"

A timestamp indicating when SageMaker created the FeatureGroup.

" - }, - "LastModifiedTime":{ - "shape":"LastModifiedTime", - "documentation":"

A timestamp indicating when the feature group was last updated.

" - }, - "OnlineStoreConfig":{ - "shape":"OnlineStoreConfig", - "documentation":"

The configuration for the OnlineStore.

" - }, - "OfflineStoreConfig":{ - "shape":"OfflineStoreConfig", - "documentation":"

The configuration of the offline store. It includes the following configurations:

  • Amazon S3 location of the offline store.

  • Configuration of the Glue data catalog.

  • Table format of the offline store.

  • Option to disable the automatic creation of a Glue table for the offline store.

  • Encryption configuration.

" - }, - "ThroughputConfig":{"shape":"ThroughputConfigDescription"}, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.

" - }, - "FeatureGroupStatus":{ - "shape":"FeatureGroupStatus", - "documentation":"

The status of the feature group.

" - }, - "OfflineStoreStatus":{ - "shape":"OfflineStoreStatus", - "documentation":"

The status of the OfflineStore. Notifies you if replicating data into the OfflineStore has failed. Returns either: Active or Blocked

" - }, - "LastUpdateStatus":{ - "shape":"LastUpdateStatus", - "documentation":"

A value indicating whether the update made to the feature group was successful.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

The reason that the FeatureGroup failed to be replicated in the OfflineStore. This is failure can occur because:

  • The FeatureGroup could not be created in the OfflineStore.

  • The FeatureGroup could not be deleted from the OfflineStore.

" - }, - "Description":{ - "shape":"Description", - "documentation":"

A free form description of the feature group.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

A token to resume pagination of the list of Features (FeatureDefinitions).

" - }, - "OnlineStoreTotalSizeBytes":{ - "shape":"OnlineStoreTotalSizeBytes", - "documentation":"

The size of the OnlineStore in bytes.

" - } - } - }, - "DescribeFeatureMetadataRequest":{ - "type":"structure", - "required":[ - "FeatureGroupName", - "FeatureName" - ], - "members":{ - "FeatureGroupName":{ - "shape":"FeatureGroupNameOrArn", - "documentation":"

The name or Amazon Resource Name (ARN) of the feature group containing the feature.

" - }, - "FeatureName":{ - "shape":"FeatureName", - "documentation":"

The name of the feature.

" - } - } - }, - "DescribeFeatureMetadataResponse":{ - "type":"structure", - "required":[ - "FeatureGroupArn", - "FeatureGroupName", - "FeatureName", - "FeatureType", - "CreationTime", - "LastModifiedTime" - ], - "members":{ - "FeatureGroupArn":{ - "shape":"FeatureGroupArn", - "documentation":"

The Amazon Resource Number (ARN) of the feature group that contains the feature.

" - }, - "FeatureGroupName":{ - "shape":"FeatureGroupName", - "documentation":"

The name of the feature group that you've specified.

" - }, - "FeatureName":{ - "shape":"FeatureName", - "documentation":"

The name of the feature that you've specified.

" - }, - "FeatureType":{ - "shape":"FeatureType", - "documentation":"

The data type of the feature.

" - }, - "CreationTime":{ - "shape":"CreationTime", - "documentation":"

A timestamp indicating when the feature was created.

" - }, - "LastModifiedTime":{ - "shape":"LastModifiedTime", - "documentation":"

A timestamp indicating when the metadata for the feature group was modified. For example, if you add a parameter describing the feature, the timestamp changes to reflect the last time you

" - }, - "Description":{ - "shape":"FeatureDescription", - "documentation":"

The description you added to describe the feature.

" - }, - "Parameters":{ - "shape":"FeatureParameters", - "documentation":"

The key-value pairs that you added to describe the feature.

" - } - } - }, - "DescribeFlowDefinitionRequest":{ - "type":"structure", - "required":["FlowDefinitionName"], - "members":{ - "FlowDefinitionName":{ - "shape":"FlowDefinitionName", - "documentation":"

The name of the flow definition.

" - } - } - }, - "DescribeFlowDefinitionResponse":{ - "type":"structure", - "required":[ - "FlowDefinitionArn", - "FlowDefinitionName", - "FlowDefinitionStatus", - "CreationTime", - "OutputConfig", - "RoleArn" - ], - "members":{ - "FlowDefinitionArn":{ - "shape":"FlowDefinitionArn", - "documentation":"

The Amazon Resource Name (ARN) of the flow defintion.

" - }, - "FlowDefinitionName":{ - "shape":"FlowDefinitionName", - "documentation":"

The Amazon Resource Name (ARN) of the flow definition.

" - }, - "FlowDefinitionStatus":{ - "shape":"FlowDefinitionStatus", - "documentation":"

The status of the flow definition. Valid values are listed below.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the flow definition was created.

" - }, - "HumanLoopRequestSource":{ - "shape":"HumanLoopRequestSource", - "documentation":"

Container for configuring the source of human task requests. Used to specify if Amazon Rekognition or Amazon Textract is used as an integration source.

" - }, - "HumanLoopActivationConfig":{ - "shape":"HumanLoopActivationConfig", - "documentation":"

An object containing information about what triggers a human review workflow.

" - }, - "HumanLoopConfig":{ - "shape":"HumanLoopConfig", - "documentation":"

An object containing information about who works on the task, the workforce task price, and other task details.

" - }, - "OutputConfig":{ - "shape":"FlowDefinitionOutputConfig", - "documentation":"

An object containing information about the output file.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) execution role for the flow definition.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

The reason your flow definition failed.

" - } - } - }, - "DescribeHubContentRequest":{ - "type":"structure", - "required":[ - "HubName", - "HubContentType", - "HubContentName" - ], - "members":{ - "HubName":{ - "shape":"HubNameOrArn", - "documentation":"

The name of the hub that contains the content to describe.

" - }, - "HubContentType":{ - "shape":"HubContentType", - "documentation":"

The type of content in the hub.

" - }, - "HubContentName":{ - "shape":"HubContentName", - "documentation":"

The name of the content to describe.

" - }, - "HubContentVersion":{ - "shape":"HubContentVersion", - "documentation":"

The version of the content to describe.

" - } - } - }, - "DescribeHubContentResponse":{ - "type":"structure", - "required":[ - "HubContentName", - "HubContentArn", - "HubContentVersion", - "HubContentType", - "DocumentSchemaVersion", - "HubName", - "HubArn", - "HubContentDocument", - "HubContentStatus", - "CreationTime" - ], - "members":{ - "HubContentName":{ - "shape":"HubContentName", - "documentation":"

The name of the hub content.

" - }, - "HubContentArn":{ - "shape":"HubContentArn", - "documentation":"

The Amazon Resource Name (ARN) of the hub content.

" - }, - "HubContentVersion":{ - "shape":"HubContentVersion", - "documentation":"

The version of the hub content.

" - }, - "HubContentType":{ - "shape":"HubContentType", - "documentation":"

The type of hub content.

" - }, - "DocumentSchemaVersion":{ - "shape":"DocumentSchemaVersion", - "documentation":"

The document schema version for the hub content.

" - }, - "HubName":{ - "shape":"HubName", - "documentation":"

The name of the hub that contains the content.

" - }, - "HubArn":{ - "shape":"HubArn", - "documentation":"

The Amazon Resource Name (ARN) of the hub that contains the content.

" - }, - "HubContentDisplayName":{ - "shape":"HubContentDisplayName", - "documentation":"

The display name of the hub content.

" - }, - "HubContentDescription":{ - "shape":"HubContentDescription", - "documentation":"

A description of the hub content.

" - }, - "HubContentMarkdown":{ - "shape":"HubContentMarkdown", - "documentation":"

A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.

" - }, - "HubContentDocument":{ - "shape":"HubContentDocument", - "documentation":"

The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.

" - }, - "SageMakerPublicHubContentArn":{ - "shape":"SageMakerPublicHubContentArn", - "documentation":"

The ARN of the public hub content.

" - }, - "ReferenceMinVersion":{ - "shape":"ReferenceMinVersion", - "documentation":"

The minimum version of the hub content.

" - }, - "SupportStatus":{ - "shape":"HubContentSupportStatus", - "documentation":"

The support status of the hub content.

" - }, - "HubContentSearchKeywords":{ - "shape":"HubContentSearchKeywordList", - "documentation":"

The searchable keywords for the hub content.

" - }, - "HubContentDependencies":{ - "shape":"HubContentDependencyList", - "documentation":"

The location of any dependencies that the hub content has, such as scripts, model artifacts, datasets, or notebooks.

" - }, - "HubContentStatus":{ - "shape":"HubContentStatus", - "documentation":"

The status of the hub content.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

The failure reason if importing hub content failed.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The date and time that hub content was created.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The last modified time of the hub content.

" - } - } - }, - "DescribeHubRequest":{ - "type":"structure", - "required":["HubName"], - "members":{ - "HubName":{ - "shape":"HubNameOrArn", - "documentation":"

The name of the hub to describe.

" - } - } - }, - "DescribeHubResponse":{ - "type":"structure", - "required":[ - "HubName", - "HubArn", - "HubStatus", - "CreationTime", - "LastModifiedTime" - ], - "members":{ - "HubName":{ - "shape":"HubName", - "documentation":"

The name of the hub.

" - }, - "HubArn":{ - "shape":"HubArn", - "documentation":"

The Amazon Resource Name (ARN) of the hub.

" - }, - "HubDisplayName":{ - "shape":"HubDisplayName", - "documentation":"

The display name of the hub.

" - }, - "HubDescription":{ - "shape":"HubDescription", - "documentation":"

A description of the hub.

" - }, - "HubSearchKeywords":{ - "shape":"HubSearchKeywordList", - "documentation":"

The searchable keywords for the hub.

" - }, - "S3StorageConfig":{ - "shape":"HubS3StorageConfig", - "documentation":"

The Amazon S3 storage configuration for the hub.

" - }, - "HubStatus":{ - "shape":"HubStatus", - "documentation":"

The status of the hub.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

The failure reason if importing hub content failed.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The date and time that the hub was created.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The date and time that the hub was last modified.

" - } - } - }, - "DescribeHumanTaskUiRequest":{ - "type":"structure", - "required":["HumanTaskUiName"], - "members":{ - "HumanTaskUiName":{ - "shape":"HumanTaskUiName", - "documentation":"

The name of the human task user interface (worker task template) you want information about.

" - } - } - }, - "DescribeHumanTaskUiResponse":{ - "type":"structure", - "required":[ - "HumanTaskUiArn", - "HumanTaskUiName", - "CreationTime", - "UiTemplate" - ], - "members":{ - "HumanTaskUiArn":{ - "shape":"HumanTaskUiArn", - "documentation":"

The Amazon Resource Name (ARN) of the human task user interface (worker task template).

" - }, - "HumanTaskUiName":{ - "shape":"HumanTaskUiName", - "documentation":"

The name of the human task user interface (worker task template).

" - }, - "HumanTaskUiStatus":{ - "shape":"HumanTaskUiStatus", - "documentation":"

The status of the human task user interface (worker task template). Valid values are listed below.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the human task user interface was created.

" - }, - "UiTemplate":{"shape":"UiTemplateInfo"} - } - }, - "DescribeHyperParameterTuningJobRequest":{ - "type":"structure", - "required":["HyperParameterTuningJobName"], - "members":{ - "HyperParameterTuningJobName":{ - "shape":"HyperParameterTuningJobName", - "documentation":"

The name of the tuning job.

" - } - } - }, - "DescribeHyperParameterTuningJobResponse":{ - "type":"structure", - "required":[ - "HyperParameterTuningJobName", - "HyperParameterTuningJobArn", - "HyperParameterTuningJobConfig", - "HyperParameterTuningJobStatus", - "CreationTime", - "TrainingJobStatusCounters", - "ObjectiveStatusCounters" - ], - "members":{ - "HyperParameterTuningJobName":{ - "shape":"HyperParameterTuningJobName", - "documentation":"

The name of the hyperparameter tuning job.

" - }, - "HyperParameterTuningJobArn":{ - "shape":"HyperParameterTuningJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the tuning job.

" - }, - "HyperParameterTuningJobConfig":{ - "shape":"HyperParameterTuningJobConfig", - "documentation":"

The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.

" - }, - "TrainingJobDefinition":{ - "shape":"HyperParameterTrainingJobDefinition", - "documentation":"

The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.

" - }, - "TrainingJobDefinitions":{ - "shape":"HyperParameterTrainingJobDefinitions", - "documentation":"

A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.

" - }, - "HyperParameterTuningJobStatus":{ - "shape":"HyperParameterTuningJobStatus", - "documentation":"

The status of the tuning job.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The date and time that the tuning job started.

" - }, - "HyperParameterTuningEndTime":{ - "shape":"Timestamp", - "documentation":"

The date and time that the tuning job ended.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The date and time that the status of the tuning job was modified.

" - }, - "TrainingJobStatusCounters":{ - "shape":"TrainingJobStatusCounters", - "documentation":"

The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.

" - }, - "ObjectiveStatusCounters":{ - "shape":"ObjectiveStatusCounters", - "documentation":"

The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.

" - }, - "BestTrainingJob":{ - "shape":"HyperParameterTrainingJobSummary", - "documentation":"

A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.

" - }, - "OverallBestTrainingJob":{ - "shape":"HyperParameterTrainingJobSummary", - "documentation":"

If the hyperparameter tuning job is an warm start tuning job with a WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the TrainingJobSummary for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job.

" - }, - "WarmStartConfig":{ - "shape":"HyperParameterTuningJobWarmStartConfig", - "documentation":"

The configuration for starting the hyperparameter parameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

" - }, - "Autotune":{ - "shape":"Autotune", - "documentation":"

A flag to indicate if autotune is enabled for the hyperparameter tuning job.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

If the tuning job failed, the reason it failed.

" - }, - "TuningJobCompletionDetails":{ - "shape":"HyperParameterTuningJobCompletionDetails", - "documentation":"

Tuning job completion information returned as the response from a hyperparameter tuning job. This information tells if your tuning job has or has not converged. It also includes the number of training jobs that have not improved model performance as evaluated against the objective function.

" - }, - "ConsumedResources":{"shape":"HyperParameterTuningJobConsumedResources"} - } - }, - "DescribeImageRequest":{ - "type":"structure", - "required":["ImageName"], - "members":{ - "ImageName":{ - "shape":"ImageName", - "documentation":"

The name of the image to describe.

" - } - } - }, - "DescribeImageResponse":{ - "type":"structure", - "members":{ - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

When the image was created.

" - }, - "Description":{ - "shape":"ImageDescription", - "documentation":"

The description of the image.

" - }, - "DisplayName":{ - "shape":"ImageDisplayName", - "documentation":"

The name of the image as displayed.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

When a create, update, or delete operation fails, the reason for the failure.

" - }, - "ImageArn":{ - "shape":"ImageArn", - "documentation":"

The ARN of the image.

" - }, - "ImageName":{ - "shape":"ImageName", - "documentation":"

The name of the image.

" - }, - "ImageStatus":{ - "shape":"ImageStatus", - "documentation":"

The status of the image.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

When the image was last modified.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The ARN of the IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.

" - } - } - }, - "DescribeImageVersionRequest":{ - "type":"structure", - "required":["ImageName"], - "members":{ - "ImageName":{ - "shape":"ImageName", - "documentation":"

The name of the image.

" - }, - "Version":{ - "shape":"ImageVersionNumber", - "documentation":"

The version of the image. If not specified, the latest version is described.

" - }, - "Alias":{ - "shape":"SageMakerImageVersionAlias", - "documentation":"

The alias of the image version.

" - } - } - }, - "DescribeImageVersionResponse":{ - "type":"structure", - "members":{ - "BaseImage":{ - "shape":"ImageBaseImage", - "documentation":"

The registry path of the container image on which this image version is based.

" - }, - "ContainerImage":{ - "shape":"ImageContainerImage", - "documentation":"

The registry path of the container image that contains this image version.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

When the version was created.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

When a create or delete operation fails, the reason for the failure.

" - }, - "ImageArn":{ - "shape":"ImageArn", - "documentation":"

The ARN of the image the version is based on.

" - }, - "ImageVersionArn":{ - "shape":"ImageVersionArn", - "documentation":"

The ARN of the version.

" - }, - "ImageVersionStatus":{ - "shape":"ImageVersionStatus", - "documentation":"

The status of the version.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

When the version was last modified.

" - }, - "Version":{ - "shape":"ImageVersionNumber", - "documentation":"

The version number.

" - }, - "VendorGuidance":{ - "shape":"VendorGuidance", - "documentation":"

The stability of the image version specified by the maintainer.

  • NOT_PROVIDED: The maintainers did not provide a status for image version stability.

  • STABLE: The image version is stable.

  • TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

  • ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

" - }, - "JobType":{ - "shape":"JobType", - "documentation":"

Indicates SageMaker AI job type compatibility.

  • TRAINING: The image version is compatible with SageMaker AI training jobs.

  • INFERENCE: The image version is compatible with SageMaker AI inference jobs.

  • NOTEBOOK_KERNEL: The image version is compatible with SageMaker AI notebook kernels.

" - }, - "MLFramework":{ - "shape":"MLFramework", - "documentation":"

The machine learning framework vended in the image version.

" - }, - "ProgrammingLang":{ - "shape":"ProgrammingLang", - "documentation":"

The supported programming language and its version.

" - }, - "Processor":{ - "shape":"Processor", - "documentation":"

Indicates CPU or GPU compatibility.

  • CPU: The image version is compatible with CPU.

  • GPU: The image version is compatible with GPU.

" - }, - "Horovod":{ - "shape":"Horovod", - "documentation":"

Indicates Horovod compatibility.

", - "box":true - }, - "ReleaseNotes":{ - "shape":"ReleaseNotes", - "documentation":"

The maintainer description of the image version.

" - } - } - }, - "DescribeInferenceComponentInput":{ - "type":"structure", - "required":["InferenceComponentName"], - "members":{ - "InferenceComponentName":{ - "shape":"InferenceComponentName", - "documentation":"

The name of the inference component.

" - } - } - }, - "DescribeInferenceComponentOutput":{ - "type":"structure", - "required":[ - "InferenceComponentName", - "InferenceComponentArn", - "EndpointName", - "EndpointArn", - "CreationTime", - "LastModifiedTime" - ], - "members":{ - "InferenceComponentName":{ - "shape":"InferenceComponentName", - "documentation":"

The name of the inference component.

" - }, - "InferenceComponentArn":{ - "shape":"InferenceComponentArn", - "documentation":"

The Amazon Resource Name (ARN) of the inference component.

" - }, - "EndpointName":{ - "shape":"EndpointName", - "documentation":"

The name of the endpoint that hosts the inference component.

" - }, - "EndpointArn":{ - "shape":"EndpointArn", - "documentation":"

The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.

" - }, - "VariantName":{ - "shape":"VariantName", - "documentation":"

The name of the production variant that hosts the inference component.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

If the inference component status is Failed, the reason for the failure.

" - }, - "Specification":{ - "shape":"InferenceComponentSpecificationSummary", - "documentation":"

Details about the resources that are deployed with this inference component.

" - }, - "Specifications":{ - "shape":"InferenceComponentSpecificationSummaryList", - "documentation":"

A list of specification summaries for the inference component, one per instance type. This parameter is populated when the inference component was created with multiple specifications. When this parameter is populated, the singular Specification parameter is not returned.

" - }, - "RuntimeConfig":{ - "shape":"InferenceComponentRuntimeConfigSummary", - "documentation":"

Details about the runtime settings for the model that is deployed with the inference component.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The time when the inference component was created.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The time when the inference component was last updated.

" - }, - "InferenceComponentStatus":{ - "shape":"InferenceComponentStatus", - "documentation":"

The status of the inference component.

" - }, - "LastDeploymentConfig":{ - "shape":"InferenceComponentDeploymentConfig", - "documentation":"

The deployment and rollback settings that you assigned to the inference component.

" - } - } - }, - "DescribeInferenceExperimentRequest":{ - "type":"structure", - "required":["Name"], - "members":{ - "Name":{ - "shape":"InferenceExperimentName", - "documentation":"

The name of the inference experiment to describe.

" - } - } - }, - "DescribeInferenceExperimentResponse":{ - "type":"structure", - "required":[ - "Arn", - "Name", - "Type", - "Status", - "EndpointMetadata", - "ModelVariants" - ], - "members":{ - "Arn":{ - "shape":"InferenceExperimentArn", - "documentation":"

The ARN of the inference experiment being described.

" - }, - "Name":{ - "shape":"InferenceExperimentName", - "documentation":"

The name of the inference experiment.

" - }, - "Type":{ - "shape":"InferenceExperimentType", - "documentation":"

The type of the inference experiment.

" - }, - "Schedule":{ - "shape":"InferenceExperimentSchedule", - "documentation":"

The duration for which the inference experiment ran or will run.

" - }, - "Status":{ - "shape":"InferenceExperimentStatus", - "documentation":"

The status of the inference experiment. The following are the possible statuses for an inference experiment:

  • Creating - Amazon SageMaker is creating your experiment.

  • Created - Amazon SageMaker has finished the creation of your experiment and will begin the experiment at the scheduled time.

  • Updating - When you make changes to your experiment, your experiment shows as updating.

  • Starting - Amazon SageMaker is beginning your experiment.

  • Running - Your experiment is in progress.

  • Stopping - Amazon SageMaker is stopping your experiment.

  • Completed - Your experiment has completed.

  • Cancelled - When you conclude your experiment early using the StopInferenceExperiment API, or if any operation fails with an unexpected error, it shows as cancelled.

" - }, - "StatusReason":{ - "shape":"InferenceExperimentStatusReason", - "documentation":"

The error message or client-specified Reason from the StopInferenceExperiment API, that explains the status of the inference experiment.

" - }, - "Description":{ - "shape":"InferenceExperimentDescription", - "documentation":"

The description of the inference experiment.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp at which you created the inference experiment.

" - }, - "CompletionTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp at which the inference experiment was completed.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp at which you last modified the inference experiment.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.

" - }, - "EndpointMetadata":{ - "shape":"EndpointMetadata", - "documentation":"

The metadata of the endpoint on which the inference experiment ran.

" - }, - "ModelVariants":{ - "shape":"ModelVariantConfigSummaryList", - "documentation":"

An array of ModelVariantConfigSummary objects. There is one for each variant in the inference experiment. Each ModelVariantConfigSummary object in the array describes the infrastructure configuration for deploying the corresponding variant.

" - }, - "DataStorageConfig":{ - "shape":"InferenceExperimentDataStorageConfig", - "documentation":"

The Amazon S3 location and configuration for storing inference request and response data.

" - }, - "ShadowModeConfig":{ - "shape":"ShadowModeConfig", - "documentation":"

The configuration of ShadowMode inference experiment type, which shows the production variant that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant it also shows the percentage of requests that Amazon SageMaker replicates.

" - }, - "KmsKey":{ - "shape":"KmsKeyId", - "documentation":"

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. For more information, see CreateInferenceExperiment.

" - } - } - }, - "DescribeInferenceRecommendationsJobRequest":{ - "type":"structure", - "required":["JobName"], - "members":{ - "JobName":{ - "shape":"RecommendationJobName", - "documentation":"

The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

" - } - } - }, - "DescribeInferenceRecommendationsJobResponse":{ - "type":"structure", - "required":[ - "JobName", - "JobType", - "JobArn", - "RoleArn", - "Status", - "CreationTime", - "LastModifiedTime", - "InputConfig" - ], - "members":{ - "JobName":{ - "shape":"RecommendationJobName", - "documentation":"

The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

" - }, - "JobDescription":{ - "shape":"RecommendationJobDescription", - "documentation":"

The job description that you provided when you initiated the job.

" - }, - "JobType":{ - "shape":"RecommendationJobType", - "documentation":"

The job type that you provided when you initiated the job.

" - }, - "JobArn":{ - "shape":"RecommendationJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the job.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role you provided when you initiated the job.

" - }, - "Status":{ - "shape":"RecommendationJobStatus", - "documentation":"

The status of the job.

" - }, - "CreationTime":{ - "shape":"CreationTime", - "documentation":"

A timestamp that shows when the job was created.

" - }, - "CompletionTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that shows when the job completed.

" - }, - "LastModifiedTime":{ - "shape":"LastModifiedTime", - "documentation":"

A timestamp that shows when the job was last modified.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

If the job fails, provides information why the job failed.

" - }, - "InputConfig":{ - "shape":"RecommendationJobInputConfig", - "documentation":"

Returns information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations you provided when you initiated the job.

" - }, - "StoppingConditions":{ - "shape":"RecommendationJobStoppingConditions", - "documentation":"

The stopping conditions that you provided when you initiated the job.

" - }, - "InferenceRecommendations":{ - "shape":"InferenceRecommendations", - "documentation":"

The recommendations made by Inference Recommender.

" - }, - "EndpointPerformances":{ - "shape":"EndpointPerformances", - "documentation":"

The performance results from running an Inference Recommender job on an existing endpoint.

" - } - } - }, - "DescribeJobRequest":{ - "type":"structure", - "required":[ - "JobName", - "JobCategory" - ], - "members":{ - "JobName":{ - "shape":"JobName", - "documentation":"

The name of the job to describe.

" - }, - "JobCategory":{ - "shape":"JobCategory", - "documentation":"

The category of the job.

" - } - } - }, - "DescribeJobResponse":{ - "type":"structure", - "required":[ - "JobName", - "JobArn", - "RoleArn", - "JobCategory", - "JobConfigSchemaVersion", - "CreationTime", - "LastModifiedTime", - "JobStatus", - "SecondaryStatus", - "SecondaryStatusTransitions" - ], - "members":{ - "JobName":{ - "shape":"JobName", - "documentation":"

The name of the job.

" - }, - "JobArn":{ - "shape":"JobArn", - "documentation":"

The Amazon Resource Name (ARN) of the job.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The ARN of the IAM role associated with the job.

" - }, - "JobCategory":{ - "shape":"JobCategory", - "documentation":"

The category of the job.

" - }, - "JobConfigSchemaVersion":{ - "shape":"JobSchemaVersion", - "documentation":"

The schema version used for the job configuration document.

" - }, - "JobConfigDocument":{ - "shape":"JobConfigDocument", - "documentation":"

The JSON configuration document for the job.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The date and time that the job was created.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The date and time that the job was last modified.

" - }, - "EndTime":{ - "shape":"Timestamp", - "documentation":"

The date and time that the job ended.

" - }, - "JobStatus":{ - "shape":"JobStatus", - "documentation":"

The current status of the job.

" - }, - "SecondaryStatus":{ - "shape":"JobSecondaryStatus", - "documentation":"

The detailed secondary status of the job, providing more granular information about the job's progress. Secondary statuses may change between releases.

" - }, - "SecondaryStatusTransitions":{ - "shape":"JobSecondaryStatusTransitions", - "documentation":"

A list of secondary status transitions for the job, with timestamps and optional status messages.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

If the job failed, the reason it failed.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The tags associated with the job.

" - } - } - }, - "DescribeJobSchemaVersionRequest":{ - "type":"structure", - "required":["JobCategory"], - "members":{ - "JobCategory":{ - "shape":"JobCategory", - "documentation":"

The category of the job schema to describe.

" - }, - "JobConfigSchemaVersion":{ - "shape":"JobSchemaVersion", - "documentation":"

The version of the schema to retrieve. If not specified, the latest version is returned.

" - } - } - }, - "DescribeJobSchemaVersionResponse":{ - "type":"structure", - "required":[ - "JobCategory", - "JobConfigSchemaVersion", - "JobConfigSchema" - ], - "members":{ - "JobCategory":{ - "shape":"JobCategory", - "documentation":"

The category of the job schema.

" - }, - "JobConfigSchemaVersion":{ - "shape":"JobSchemaVersion", - "documentation":"

The version of the schema.

" - }, - "JobConfigSchema":{ - "shape":"JobConfigDocument", - "documentation":"

The JSON schema document that defines the structure of the job configuration.

" - } - } - }, - "DescribeLabelingJobRequest":{ - "type":"structure", - "required":["LabelingJobName"], - "members":{ - "LabelingJobName":{ - "shape":"LabelingJobName", - "documentation":"

The name of the labeling job to return information for.

" - } - } - }, - "DescribeLabelingJobResponse":{ - "type":"structure", - "required":[ - "LabelingJobStatus", - "LabelCounters", - "CreationTime", - "LastModifiedTime", - "JobReferenceCode", - "LabelingJobName", - "LabelingJobArn", - "InputConfig", - "OutputConfig", - "RoleArn", - "HumanTaskConfig" - ], - "members":{ - "LabelingJobStatus":{ - "shape":"LabelingJobStatus", - "documentation":"

The processing status of the labeling job.

" - }, - "LabelCounters":{ - "shape":"LabelCounters", - "documentation":"

Provides a breakdown of the number of data objects labeled by humans, the number of objects labeled by machine, the number of objects than couldn't be labeled, and the total number of objects labeled.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

If the job failed, the reason that it failed.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The date and time that the labeling job was created.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The date and time that the labeling job was last updated.

" - }, - "JobReferenceCode":{ - "shape":"JobReferenceCode", - "documentation":"

A unique identifier for work done as part of a labeling job.

" - }, - "LabelingJobName":{ - "shape":"LabelingJobName", - "documentation":"

The name assigned to the labeling job when it was created.

" - }, - "LabelingJobArn":{ - "shape":"LabelingJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the labeling job.

" - }, - "LabelAttributeName":{ - "shape":"LabelAttributeName", - "documentation":"

The attribute used as the label in the output manifest file.

" - }, - "InputConfig":{ - "shape":"LabelingJobInputConfig", - "documentation":"

Input configuration information for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects.

" - }, - "OutputConfig":{ - "shape":"LabelingJobOutputConfig", - "documentation":"

The location of the job's output data and the Amazon Web Services Key Management Service key ID for the key used to encrypt the output data, if any.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during data labeling.

" - }, - "LabelCategoryConfigS3Uri":{ - "shape":"S3Uri", - "documentation":"

The S3 location of the JSON file that defines the categories used to label data objects. Please note the following label-category limits:

  • Semantic segmentation labeling jobs using automated labeling: 20 labels

  • Box bounding labeling jobs (all): 10 labels

The file is a JSON structure in the following format:

{

\"document-version\": \"2018-11-28\"

\"labels\": [

{

\"label\": \"label 1\"

},

{

\"label\": \"label 2\"

},

...

{

\"label\": \"label n\"

}

]

}

" - }, - "StoppingConditions":{ - "shape":"LabelingJobStoppingConditions", - "documentation":"

A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped.

" - }, - "LabelingJobAlgorithmsConfig":{ - "shape":"LabelingJobAlgorithmsConfig", - "documentation":"

Configuration information for automated data labeling.

" - }, - "HumanTaskConfig":{ - "shape":"HumanTaskConfig", - "documentation":"

Configuration information required for human workers to complete a labeling task.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

" - }, - "LabelingJobOutput":{ - "shape":"LabelingJobOutput", - "documentation":"

The location of the output produced by the labeling job.

" - } - } - }, - "DescribeLineageGroupRequest":{ - "type":"structure", - "required":["LineageGroupName"], - "members":{ - "LineageGroupName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the lineage group.

" - } - } - }, - "DescribeLineageGroupResponse":{ - "type":"structure", - "members":{ - "LineageGroupName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the lineage group.

" - }, - "LineageGroupArn":{ - "shape":"LineageGroupArn", - "documentation":"

The Amazon Resource Name (ARN) of the lineage group.

" - }, - "DisplayName":{ - "shape":"ExperimentEntityName", - "documentation":"

The display name of the lineage group.

" - }, - "Description":{ - "shape":"ExperimentDescription", - "documentation":"

The description of the lineage group.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The creation time of lineage group.

" - }, - "CreatedBy":{"shape":"UserContext"}, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The last modified time of the lineage group.

" - }, - "LastModifiedBy":{"shape":"UserContext"} - } - }, - "DescribeMlflowAppRequest":{ - "type":"structure", - "required":["Arn"], - "members":{ - "Arn":{ - "shape":"MlflowAppArn", - "documentation":"

The ARN of the MLflow App for which to get information.

" - } - } - }, - "DescribeMlflowAppResponse":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"MlflowAppArn", - "documentation":"

The ARN of the MLflow App.

" - }, - "Name":{ - "shape":"MlflowAppName", - "documentation":"

The name of the MLflow App.

" - }, - "ArtifactStoreUri":{ - "shape":"S3Uri", - "documentation":"

The S3 URI of the general purpose bucket used as the MLflow App artifact store.

" - }, - "MlflowVersion":{ - "shape":"MlflowVersion", - "documentation":"

The MLflow version used.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow App uses to access the artifact store in Amazon S3.

" - }, - "Status":{ - "shape":"MlflowAppStatus", - "documentation":"

The current creation status of the described MLflow App.

" - }, - "ModelRegistrationMode":{ - "shape":"ModelRegistrationMode", - "documentation":"

Whether automatic registration of new MLflow models to the SageMaker Model Registry is enabled.

" - }, - "AccountDefaultStatus":{ - "shape":"AccountDefaultStatus", - "documentation":"

Indicates whether this MLflow app is the default for the entire account.

" - }, - "DefaultDomainIdList":{ - "shape":"DefaultDomainIdList", - "documentation":"

List of SageMaker Domain IDs for which this MLflow App is the default.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the MLflow App was created.

" - }, - "CreatedBy":{"shape":"UserContext"}, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the MLflow App was last modified.

" - }, - "LastModifiedBy":{"shape":"UserContext"}, - "WeeklyMaintenanceWindowStart":{ - "shape":"WeeklyMaintenanceWindowStart", - "documentation":"

The day and time of the week when weekly maintenance occurs.

" - }, - "MaintenanceStatus":{ - "shape":"MaintenanceStatus", - "documentation":"

Current maintenance status of the MLflow App.

" - } - } - }, - "DescribeMlflowTrackingServerRequest":{ - "type":"structure", - "required":["TrackingServerName"], - "members":{ - "TrackingServerName":{ - "shape":"TrackingServerName", - "documentation":"

The name of the MLflow Tracking Server to describe.

" - } - } - }, - "DescribeMlflowTrackingServerResponse":{ - "type":"structure", - "members":{ - "TrackingServerArn":{ - "shape":"TrackingServerArn", - "documentation":"

The ARN of the described tracking server.

" - }, - "TrackingServerName":{ - "shape":"TrackingServerName", - "documentation":"

The name of the described tracking server.

" - }, - "ArtifactStoreUri":{ - "shape":"S3Uri", - "documentation":"

The S3 URI of the general purpose bucket used as the MLflow Tracking Server artifact store.

" - }, - "TrackingServerSize":{ - "shape":"TrackingServerSize", - "documentation":"

The size of the described tracking server.

" - }, - "MlflowVersion":{ - "shape":"MlflowVersion", - "documentation":"

The MLflow version used for the described tracking server.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) for an IAM role in your account that the described MLflow Tracking Server uses to access the artifact store in Amazon S3.

" - }, - "TrackingServerStatus":{ - "shape":"TrackingServerStatus", - "documentation":"

The current creation status of the described MLflow Tracking Server.

" - }, - "TrackingServerMaintenanceStatus":{ - "shape":"TrackingServerMaintenanceStatus", - "documentation":"

The current maintenance status of the described MLflow Tracking Server.

" - }, - "IsActive":{ - "shape":"IsTrackingServerActive", - "documentation":"

Whether the described MLflow Tracking Server is currently active.

" - }, - "TrackingServerUrl":{ - "shape":"TrackingServerUrl", - "documentation":"

The URL to connect to the MLflow user interface for the described tracking server.

" - }, - "WeeklyMaintenanceWindowStart":{ - "shape":"WeeklyMaintenanceWindowStart", - "documentation":"

The day and time of the week when weekly maintenance occurs on the described tracking server.

" - }, - "AutomaticModelRegistration":{ - "shape":"Boolean", - "documentation":"

Whether automatic registration of new MLflow models to the SageMaker Model Registry is enabled.

", - "box":true - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp of when the described MLflow Tracking Server was created.

" - }, - "CreatedBy":{"shape":"UserContext"}, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp of when the described MLflow Tracking Server was last modified.

" - }, - "LastModifiedBy":{"shape":"UserContext"}, - "S3BucketOwnerAccountId":{ - "shape":"AccountId", - "documentation":"

Expected Amazon Web Services account ID that owns the Amazon S3 bucket for artifact storage.

" - }, - "S3BucketOwnerVerification":{ - "shape":"Boolean", - "documentation":"

Whether Amazon S3 Bucket Ownership checks are enabled whenever the tracking server interacts with Amazon Amazon S3.

", - "box":true - } - } - }, - "DescribeModelBiasJobDefinitionRequest":{ - "type":"structure", - "required":["JobDefinitionName"], - "members":{ - "JobDefinitionName":{ - "shape":"MonitoringJobDefinitionName", - "documentation":"

The name of the model bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

" - } - } - }, - "DescribeModelBiasJobDefinitionResponse":{ - "type":"structure", - "required":[ - "JobDefinitionArn", - "JobDefinitionName", - "CreationTime", - "ModelBiasAppSpecification", - "ModelBiasJobInput", - "ModelBiasJobOutputConfig", - "JobResources", - "RoleArn" - ], - "members":{ - "JobDefinitionArn":{ - "shape":"MonitoringJobDefinitionArn", - "documentation":"

The Amazon Resource Name (ARN) of the model bias job.

" - }, - "JobDefinitionName":{ - "shape":"MonitoringJobDefinitionName", - "documentation":"

The name of the bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The time at which the model bias job was created.

" - }, - "ModelBiasBaselineConfig":{ - "shape":"ModelBiasBaselineConfig", - "documentation":"

The baseline configuration for a model bias job.

" - }, - "ModelBiasAppSpecification":{ - "shape":"ModelBiasAppSpecification", - "documentation":"

Configures the model bias job to run a specified Docker container image.

" - }, - "ModelBiasJobInput":{ - "shape":"ModelBiasJobInput", - "documentation":"

Inputs for the model bias job.

" - }, - "ModelBiasJobOutputConfig":{"shape":"MonitoringOutputConfig"}, - "JobResources":{"shape":"MonitoringResources"}, - "NetworkConfig":{ - "shape":"MonitoringNetworkConfig", - "documentation":"

Networking options for a model bias job.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3.

" - }, - "StoppingCondition":{"shape":"MonitoringStoppingCondition"} - } - }, - "DescribeModelCardExportJobRequest":{ - "type":"structure", - "required":["ModelCardExportJobArn"], - "members":{ - "ModelCardExportJobArn":{ - "shape":"ModelCardExportJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the model card export job to describe.

" - } - } - }, - "DescribeModelCardExportJobResponse":{ - "type":"structure", - "required":[ - "ModelCardExportJobName", - "ModelCardExportJobArn", - "Status", - "ModelCardName", - "ModelCardVersion", - "OutputConfig", - "CreatedAt", - "LastModifiedAt" - ], - "members":{ - "ModelCardExportJobName":{ - "shape":"EntityName", - "documentation":"

The name of the model card export job to describe.

" - }, - "ModelCardExportJobArn":{ - "shape":"ModelCardExportJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the model card export job.

" - }, - "Status":{ - "shape":"ModelCardExportJobStatus", - "documentation":"

The completion status of the model card export job.

  • InProgress: The model card export job is in progress.

  • Completed: The model card export job is complete.

  • Failed: The model card export job failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeModelCardExportJob call.

" - }, - "ModelCardName":{ - "shape":"EntityName", - "documentation":"

The name or Amazon Resource Name (ARN) of the model card that the model export job exports.

" - }, - "ModelCardVersion":{ - "shape":"Integer", - "documentation":"

The version of the model card that the model export job exports.

", - "box":true - }, - "OutputConfig":{ - "shape":"ModelCardExportOutputConfig", - "documentation":"

The export output details for the model card.

" - }, - "CreatedAt":{ - "shape":"Timestamp", - "documentation":"

The date and time that the model export job was created.

" - }, - "LastModifiedAt":{ - "shape":"Timestamp", - "documentation":"

The date and time that the model export job was last modified.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

The failure reason if the model export job fails.

" - }, - "ExportArtifacts":{ - "shape":"ModelCardExportArtifacts", - "documentation":"

The exported model card artifacts.

" - } - } - }, - "DescribeModelCardRequest":{ - "type":"structure", - "required":["ModelCardName"], - "members":{ - "ModelCardName":{ - "shape":"ModelCardNameOrArn", - "documentation":"

The name or Amazon Resource Name (ARN) of the model card to describe.

" - }, - "ModelCardVersion":{ - "shape":"Integer", - "documentation":"

The version of the model card to describe. If a version is not provided, then the latest version of the model card is described.

", - "box":true - }, - "IncludedData":{ - "shape":"IncludedData", - "documentation":"

Specifies the level of model card data to include in the response. Use this parameter to call DescribeModelCard without requiring kms:Decrypt permission on the customer-managed Amazon Web Services KMS key.

  • AllData: Returns the full model card Content. This option requires kms:Decrypt permission on the customer-managed key, if one is associated with the model card. This is the default.

  • MetadataOnly: Returns the model card with sanitized Content that includes only a small set of unencrypted metadata fields. This option does not require kms:Decrypt permission. For the list of fields preserved in the response, see Content.

If you don't specify a value, SageMaker returns AllData.

" - } - } - }, - "DescribeModelCardResponse":{ - "type":"structure", - "required":[ - "ModelCardArn", - "ModelCardName", - "ModelCardVersion", - "Content", - "ModelCardStatus", - "CreationTime", - "CreatedBy" - ], - "members":{ - "ModelCardArn":{ - "shape":"ModelCardArn", - "documentation":"

The Amazon Resource Name (ARN) of the model card.

" - }, - "ModelCardName":{ - "shape":"EntityName", - "documentation":"

The name of the model card.

" - }, - "ModelCardVersion":{ - "shape":"Integer", - "documentation":"

The version of the model card.

", - "box":true - }, - "Content":{ - "shape":"ModelCardContent", - "documentation":"

The content of the model card. Content is provided as a string in the model card JSON schema.

When you set IncludedData to MetadataOnly in the request, SageMaker returns a sanitized version of Content that includes only the following JSON paths, when present in the model card:

  • model_overview.model_id

  • model_overview.model_name

  • intended_uses.risk_rating

  • model_package_details.model_package_group_name

  • model_package_details.model_package_arn

All other fields are removed from Content when IncludedData is MetadataOnly, including model description, training details, evaluation details, business details, and additional information. To retrieve the complete Content, set IncludedData to AllData or omit the parameter.

" - }, - "ModelCardStatus":{ - "shape":"ModelCardStatus", - "documentation":"

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

  • Draft: The model card is a work in progress.

  • PendingReview: The model card is pending review.

  • Approved: The model card is approved.

  • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

" - }, - "SecurityConfig":{ - "shape":"ModelCardSecurityConfig", - "documentation":"

The security configuration used to protect model card content.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The date and time the model card was created.

" - }, - "CreatedBy":{"shape":"UserContext"}, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The date and time the model card was last modified.

" - }, - "LastModifiedBy":{"shape":"UserContext"}, - "ModelCardProcessingStatus":{ - "shape":"ModelCardProcessingStatus", - "documentation":"

The processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps.

  • DeletePending: Model card deletion request received.

  • DeleteInProgress: Model card deletion is in progress.

  • ContentDeleted: Deleted model card content.

  • ExportJobsDeleted: Deleted all export jobs associated with the model card.

  • DeleteCompleted: Successfully deleted the model card.

  • DeleteFailed: The model card failed to delete.

" - } - } - }, - "DescribeModelExplainabilityJobDefinitionRequest":{ - "type":"structure", - "required":["JobDefinitionName"], - "members":{ - "JobDefinitionName":{ - "shape":"MonitoringJobDefinitionName", - "documentation":"

The name of the model explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

" - } - } - }, - "DescribeModelExplainabilityJobDefinitionResponse":{ - "type":"structure", - "required":[ - "JobDefinitionArn", - "JobDefinitionName", - "CreationTime", - "ModelExplainabilityAppSpecification", - "ModelExplainabilityJobInput", - "ModelExplainabilityJobOutputConfig", - "JobResources", - "RoleArn" - ], - "members":{ - "JobDefinitionArn":{ - "shape":"MonitoringJobDefinitionArn", - "documentation":"

The Amazon Resource Name (ARN) of the model explainability job.

" - }, - "JobDefinitionName":{ - "shape":"MonitoringJobDefinitionName", - "documentation":"

The name of the explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The time at which the model explainability job was created.

" - }, - "ModelExplainabilityBaselineConfig":{ - "shape":"ModelExplainabilityBaselineConfig", - "documentation":"

The baseline configuration for a model explainability job.

" - }, - "ModelExplainabilityAppSpecification":{ - "shape":"ModelExplainabilityAppSpecification", - "documentation":"

Configures the model explainability job to run a specified Docker container image.

" - }, - "ModelExplainabilityJobInput":{ - "shape":"ModelExplainabilityJobInput", - "documentation":"

Inputs for the model explainability job.

" - }, - "ModelExplainabilityJobOutputConfig":{"shape":"MonitoringOutputConfig"}, - "JobResources":{"shape":"MonitoringResources"}, - "NetworkConfig":{ - "shape":"MonitoringNetworkConfig", - "documentation":"

Networking options for a model explainability job.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3.

" - }, - "StoppingCondition":{"shape":"MonitoringStoppingCondition"} - } - }, - "DescribeModelInput":{ - "type":"structure", - "required":["ModelName"], - "members":{ - "ModelName":{ - "shape":"ModelName", - "documentation":"

The name of the model.

" - } - } - }, - "DescribeModelOutput":{ - "type":"structure", - "required":[ - "ModelName", - "CreationTime", - "ModelArn" - ], - "members":{ - "ModelName":{ - "shape":"ModelName", - "documentation":"

Name of the SageMaker model.

" - }, - "PrimaryContainer":{ - "shape":"ContainerDefinition", - "documentation":"

The location of the primary inference code, associated artifacts, and custom environment map that the inference code uses when it is deployed in production.

" - }, - "Containers":{ - "shape":"ContainerDefinitionList", - "documentation":"

The containers in the inference pipeline.

" - }, - "InferenceExecutionConfig":{ - "shape":"InferenceExecutionConfig", - "documentation":"

Specifies details of how containers in a multi-container endpoint are called.

" - }, - "ExecutionRoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the IAM role that you specified for the model.

" - }, - "VpcConfig":{ - "shape":"VpcConfig", - "documentation":"

A VpcConfig object that specifies the VPC that this model has access to. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that shows when the model was created.

" - }, - "ModelArn":{ - "shape":"ModelArn", - "documentation":"

The Amazon Resource Name (ARN) of the model.

" - }, - "EnableNetworkIsolation":{ - "shape":"Boolean", - "documentation":"

If True, no inbound or outbound network calls can be made to or from the model container.

", - "box":true - }, - "DeploymentRecommendation":{ - "shape":"DeploymentRecommendation", - "documentation":"

A set of recommended deployment configurations for the model.

" - } - } - }, - "DescribeModelPackageGroupInput":{ - "type":"structure", - "required":["ModelPackageGroupName"], - "members":{ - "ModelPackageGroupName":{ - "shape":"ArnOrName", - "documentation":"

The name of the model group to describe.

" - } - } - }, - "DescribeModelPackageGroupOutput":{ - "type":"structure", - "required":[ - "ModelPackageGroupName", - "ModelPackageGroupArn", - "CreationTime", - "CreatedBy", - "ModelPackageGroupStatus" - ], - "members":{ - "ModelPackageGroupName":{ - "shape":"EntityName", - "documentation":"

The name of the model group.

" - }, - "ModelPackageGroupArn":{ - "shape":"ModelPackageGroupArn", - "documentation":"

The Amazon Resource Name (ARN) of the model group.

" - }, - "ModelPackageGroupDescription":{ - "shape":"EntityDescription", - "documentation":"

A description of the model group.

" - }, - "CreationTime":{ - "shape":"CreationTime", - "documentation":"

The time that the model group was created.

" - }, - "CreatedBy":{"shape":"UserContext"}, - "ModelPackageGroupStatus":{ - "shape":"ModelPackageGroupStatus", - "documentation":"

The status of the model group.

" - }, - "ManagedConfiguration":{ - "shape":"ManagedConfiguration", - "documentation":"

The managed configuration of the model package group.

" - } - } - }, - "DescribeModelPackageInput":{ - "type":"structure", - "required":["ModelPackageName"], - "members":{ - "ModelPackageName":{ - "shape":"VersionedArnOrName", - "documentation":"

The name or Amazon Resource Name (ARN) of the model package to describe.

When you specify a name, the name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

" - }, - "IncludedData":{ - "shape":"IncludedData", - "documentation":"

Specifies the level of model package data to include in the response. Use this parameter to call DescribeModelPackage on a model package that has an associated model card without requiring kms:Decrypt permission on the customer-managed KMS key associated with the embedded model card.

  • AllData: Returns the full model package response, including the unredacted ModelCard.ModelCardContent. This option requires kms:Decrypt permission on the customer-managed key, if one is associated with the embedded model card. This is the default.

  • MetadataOnly: Returns the full model package response, but with the embedded ModelCard.ModelCardContent sanitized to include only a small set of unencrypted metadata fields. This option does not require kms:Decrypt permission. All other top-level response fields, including InferenceSpecification, ModelMetrics, DriftCheckBaselines, and SecurityConfig, are returned unchanged. For the list of fields preserved within ModelCardContent, see ModelCard.

If you don't specify a value, SageMaker returns AllData.

" - } - } - }, - "DescribeModelPackageOutput":{ - "type":"structure", - "required":[ - "ModelPackageName", - "ModelPackageArn", - "CreationTime", - "ModelPackageStatus", - "ModelPackageStatusDetails" - ], - "members":{ - "ModelPackageName":{ - "shape":"EntityName", - "documentation":"

The name of the model package being described.

" - }, - "ModelPackageGroupName":{ - "shape":"EntityName", - "documentation":"

If the model is a versioned model, the name of the model group that the versioned model belongs to.

" - }, - "ModelPackageVersion":{ - "shape":"ModelPackageVersion", - "documentation":"

The version of the model package.

" - }, - "ModelPackageRegistrationType":{ - "shape":"ModelPackageRegistrationType", - "documentation":"

The package registration type of the model package output.

" - }, - "ModelPackageArn":{ - "shape":"ModelPackageArn", - "documentation":"

The Amazon Resource Name (ARN) of the model package.

" - }, - "ModelPackageDescription":{ - "shape":"EntityDescription", - "documentation":"

A brief summary of the model package.

" - }, - "CreationTime":{ - "shape":"CreationTime", - "documentation":"

A timestamp specifying when the model package was created.

" - }, - "InferenceSpecification":{ - "shape":"InferenceSpecification", - "documentation":"

Details about inference jobs that you can run with models based on this model package.

" - }, - "SourceAlgorithmSpecification":{ - "shape":"SourceAlgorithmSpecification", - "documentation":"

Details about the algorithm that was used to create the model package.

" - }, - "ValidationSpecification":{ - "shape":"ModelPackageValidationSpecification", - "documentation":"

Configurations for one or more transform jobs that SageMaker runs to test the model package.

" - }, - "ModelPackageStatus":{ - "shape":"ModelPackageStatus", - "documentation":"

The current status of the model package.

" - }, - "ModelPackageStatusDetails":{ - "shape":"ModelPackageStatusDetails", - "documentation":"

Details about the current status of the model package.

" - }, - "CertifyForMarketplace":{ - "shape":"CertifyForMarketplace", - "documentation":"

Whether the model package is certified for listing on Amazon Web Services Marketplace.

", - "box":true - }, - "ModelApprovalStatus":{ - "shape":"ModelApprovalStatus", - "documentation":"

The approval status of the model package.

" - }, - "CreatedBy":{"shape":"UserContext"}, - "MetadataProperties":{"shape":"MetadataProperties"}, - "ModelMetrics":{ - "shape":"ModelMetrics", - "documentation":"

Metrics for the model.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The last time that the model package was modified.

" - }, - "LastModifiedBy":{"shape":"UserContext"}, - "ApprovalDescription":{ - "shape":"ApprovalDescription", - "documentation":"

A description provided for the model approval.

" - }, - "Domain":{ - "shape":"String", - "documentation":"

The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.

" - }, - "Task":{ - "shape":"String", - "documentation":"

The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification.

" - }, - "SamplePayloadUrl":{ - "shape":"String", - "documentation":"

The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path points to a single gzip compressed tar archive (.tar.gz suffix).

" - }, - "CustomerMetadataProperties":{ - "shape":"CustomerMetadataMap", - "documentation":"

The metadata properties associated with the model package versions.

" - }, - "DriftCheckBaselines":{ - "shape":"DriftCheckBaselines", - "documentation":"

Represents the drift check baselines that can be used when the model monitor is set using the model package. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.

" - }, - "AdditionalInferenceSpecifications":{ - "shape":"AdditionalInferenceSpecifications", - "documentation":"

An array of additional Inference Specification objects. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

" - }, - "SkipModelValidation":{ - "shape":"SkipModelValidation", - "documentation":"

Indicates if you want to skip model validation.

" - }, - "SourceUri":{ - "shape":"ModelPackageSourceUri", - "documentation":"

The URI of the source for the model package.

" - }, - "SecurityConfig":{ - "shape":"ModelPackageSecurityConfig", - "documentation":"

The KMS Key ID (KMSKeyId) used for encryption of model package information.

" - }, - "ModelCard":{ - "shape":"ModelPackageModelCard", - "documentation":"

The model card associated with the model package. Since ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version.

When you set IncludedData to MetadataOnly in the request, ModelCardStatus is preserved and ModelCardContent is sanitized to include only the following JSON paths, when present in the model card:

  • model_overview.model_id

  • model_overview.model_name

  • intended_uses.risk_rating

  • model_package_details.model_package_group_name

  • model_package_details.model_package_arn

Because the ModelPackageModelCard schema does not include model_package_details and limits model_overview to model_creator and model_artifact, the sanitized ModelCardContent for a model package typically contains only intended_uses.risk_rating if it was provided when the model card was created. To retrieve the complete ModelCardContent, set IncludedData to AllData or omit the parameter.

" - }, - "ModelLifeCycle":{ - "shape":"ModelLifeCycle", - "documentation":"

A structure describing the current state of the model in its life cycle.

" - }, - "ManagedStorageType":{ - "shape":"ManagedStorageType", - "documentation":"

The storage type of the model package.

" - } - } - }, - "DescribeModelQualityJobDefinitionRequest":{ - "type":"structure", - "required":["JobDefinitionName"], - "members":{ - "JobDefinitionName":{ - "shape":"MonitoringJobDefinitionName", - "documentation":"

The name of the model quality job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

" - } - } - }, - "DescribeModelQualityJobDefinitionResponse":{ - "type":"structure", - "required":[ - "JobDefinitionArn", - "JobDefinitionName", - "CreationTime", - "ModelQualityAppSpecification", - "ModelQualityJobInput", - "ModelQualityJobOutputConfig", - "JobResources", - "RoleArn" - ], - "members":{ - "JobDefinitionArn":{ - "shape":"MonitoringJobDefinitionArn", - "documentation":"

The Amazon Resource Name (ARN) of the model quality job.

" - }, - "JobDefinitionName":{ - "shape":"MonitoringJobDefinitionName", - "documentation":"

The name of the quality job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The time at which the model quality job was created.

" - }, - "ModelQualityBaselineConfig":{ - "shape":"ModelQualityBaselineConfig", - "documentation":"

The baseline configuration for a model quality job.

" - }, - "ModelQualityAppSpecification":{ - "shape":"ModelQualityAppSpecification", - "documentation":"

Configures the model quality job to run a specified Docker container image.

" - }, - "ModelQualityJobInput":{ - "shape":"ModelQualityJobInput", - "documentation":"

Inputs for the model quality job.

" - }, - "ModelQualityJobOutputConfig":{"shape":"MonitoringOutputConfig"}, - "JobResources":{"shape":"MonitoringResources"}, - "NetworkConfig":{ - "shape":"MonitoringNetworkConfig", - "documentation":"

Networking options for a model quality job.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.

" - }, - "StoppingCondition":{"shape":"MonitoringStoppingCondition"} - } - }, - "DescribeMonitoringScheduleRequest":{ - "type":"structure", - "required":["MonitoringScheduleName"], - "members":{ - "MonitoringScheduleName":{ - "shape":"MonitoringScheduleName", - "documentation":"

Name of a previously created monitoring schedule.

" - } - } - }, - "DescribeMonitoringScheduleResponse":{ - "type":"structure", - "required":[ - "MonitoringScheduleArn", - "MonitoringScheduleName", - "MonitoringScheduleStatus", - "CreationTime", - "LastModifiedTime", - "MonitoringScheduleConfig" - ], - "members":{ - "MonitoringScheduleArn":{ - "shape":"MonitoringScheduleArn", - "documentation":"

The Amazon Resource Name (ARN) of the monitoring schedule.

" - }, - "MonitoringScheduleName":{ - "shape":"MonitoringScheduleName", - "documentation":"

Name of the monitoring schedule.

" - }, - "MonitoringScheduleStatus":{ - "shape":"ScheduleStatus", - "documentation":"

The status of an monitoring job.

" - }, - "MonitoringType":{ - "shape":"MonitoringType", - "documentation":"

The type of the monitoring job that this schedule runs. This is one of the following values.

  • DATA_QUALITY - The schedule is for a data quality monitoring job.

  • MODEL_QUALITY - The schedule is for a model quality monitoring job.

  • MODEL_BIAS - The schedule is for a bias monitoring job.

  • MODEL_EXPLAINABILITY - The schedule is for an explainability monitoring job.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

A string, up to one KB in size, that contains the reason a monitoring job failed, if it failed.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The time at which the monitoring job was created.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The time at which the monitoring job was last modified.

" - }, - "MonitoringScheduleConfig":{ - "shape":"MonitoringScheduleConfig", - "documentation":"

The configuration object that specifies the monitoring schedule and defines the monitoring job.

" - }, - "EndpointName":{ - "shape":"EndpointName", - "documentation":"

The name of the endpoint for the monitoring job.

" - }, - "LastMonitoringExecutionSummary":{ - "shape":"MonitoringExecutionSummary", - "documentation":"

Describes metadata on the last execution to run, if there was one.

" - } - } - }, - "DescribeNotebookInstanceInput":{ - "type":"structure", - "required":["NotebookInstanceName"], - "members":{ - "NotebookInstanceName":{ - "shape":"NotebookInstanceName", - "documentation":"

The name of the notebook instance that you want information about.

" - } - } - }, - "DescribeNotebookInstanceLifecycleConfigInput":{ - "type":"structure", - "required":["NotebookInstanceLifecycleConfigName"], - "members":{ - "NotebookInstanceLifecycleConfigName":{ - "shape":"NotebookInstanceLifecycleConfigName", - "documentation":"

The name of the lifecycle configuration to describe.

" - } - } - }, - "DescribeNotebookInstanceLifecycleConfigOutput":{ - "type":"structure", - "members":{ - "NotebookInstanceLifecycleConfigArn":{ - "shape":"NotebookInstanceLifecycleConfigArn", - "documentation":"

The Amazon Resource Name (ARN) of the lifecycle configuration.

" - }, - "NotebookInstanceLifecycleConfigName":{ - "shape":"NotebookInstanceLifecycleConfigName", - "documentation":"

The name of the lifecycle configuration.

" - }, - "OnCreate":{ - "shape":"NotebookInstanceLifecycleConfigList", - "documentation":"

The shell script that runs only once, when you create a notebook instance.

" - }, - "OnStart":{ - "shape":"NotebookInstanceLifecycleConfigList", - "documentation":"

The shell script that runs every time you start a notebook instance, including when you create the notebook instance.

" - }, - "LastModifiedTime":{ - "shape":"LastModifiedTime", - "documentation":"

A timestamp that tells when the lifecycle configuration was last modified.

" - }, - "CreationTime":{ - "shape":"CreationTime", - "documentation":"

A timestamp that tells when the lifecycle configuration was created.

" - } - } - }, - "DescribeNotebookInstanceOutput":{ - "type":"structure", - "members":{ - "NotebookInstanceArn":{ - "shape":"NotebookInstanceArn", - "documentation":"

The Amazon Resource Name (ARN) of the notebook instance.

" - }, - "NotebookInstanceName":{ - "shape":"NotebookInstanceName", - "documentation":"

The name of the SageMaker AI notebook instance.

" - }, - "NotebookInstanceStatus":{ - "shape":"NotebookInstanceStatus", - "documentation":"

The status of the notebook instance.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

If status is Failed, the reason it failed.

" - }, - "Url":{ - "shape":"NotebookInstanceUrl", - "documentation":"

The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.

" - }, - "InstanceType":{ - "shape":"InstanceType", - "documentation":"

The type of ML compute instance running on the notebook instance.

" - }, - "IpAddressType":{ - "shape":"IPAddressType", - "documentation":"

The IP address type configured for the notebook instance. Returns ipv4 for IPv4-only connectivity or dualstack for both IPv4 and IPv6 connectivity.

" - }, - "SubnetId":{ - "shape":"SubnetId", - "documentation":"

The ID of the VPC subnet.

" - }, - "SecurityGroups":{ - "shape":"SecurityGroupIds", - "documentation":"

The IDs of the VPC security groups.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the IAM role associated with the instance.

" - }, - "KmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The Amazon Web Services KMS key ID SageMaker AI uses to encrypt data when storing it on the ML storage volume attached to the instance.

" - }, - "NetworkInterfaceId":{ - "shape":"NetworkInterfaceId", - "documentation":"

The network interface IDs that SageMaker AI created at the time of creating the instance.

" - }, - "LastModifiedTime":{ - "shape":"LastModifiedTime", - "documentation":"

A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.

" - }, - "CreationTime":{ - "shape":"CreationTime", - "documentation":"

A timestamp. Use this parameter to return the time when the notebook instance was created

" - }, - "NotebookInstanceLifecycleConfigName":{ - "shape":"NotebookInstanceLifecycleConfigName", - "documentation":"

Returns the name of a notebook instance lifecycle configuration.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance

" - }, - "DirectInternetAccess":{ - "shape":"DirectInternetAccess", - "documentation":"

Describes whether SageMaker AI provides internet access to the notebook instance. If this value is set to Disabled, the notebook instance does not have internet access, and cannot connect to SageMaker AI training and endpoint services.

For more information, see Notebook Instances Are Internet-Enabled by Default.

" - }, - "VolumeSizeInGB":{ - "shape":"NotebookInstanceVolumeSizeInGB", - "documentation":"

The size, in GB, of the ML storage volume attached to the notebook instance.

" - }, - "AcceleratorTypes":{ - "shape":"NotebookInstanceAcceleratorTypes", - "documentation":"

This parameter is no longer supported. Elastic Inference (EI) is no longer available.

This parameter was used to specify a list of the EI instance types associated with this notebook instance.

" - }, - "DefaultCodeRepository":{ - "shape":"CodeRepositoryNameOrUrl", - "documentation":"

The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker AI Notebook Instances.

" - }, - "AdditionalCodeRepositories":{ - "shape":"AdditionalCodeRepositoryNamesOrUrls", - "documentation":"

An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker AI Notebook Instances.

" - }, - "RootAccess":{ - "shape":"RootAccess", - "documentation":"

Whether root access is enabled or disabled for users of the notebook instance.

Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.

" - }, - "PlatformIdentifier":{ - "shape":"PlatformIdentifier", - "documentation":"

The platform identifier of the notebook instance runtime environment.

" - }, - "InstanceMetadataServiceConfiguration":{ - "shape":"InstanceMetadataServiceConfiguration", - "documentation":"

Information on the IMDS configuration of the notebook instance

" - } - } - }, - "DescribeOptimizationJobRequest":{ - "type":"structure", - "required":["OptimizationJobName"], - "members":{ - "OptimizationJobName":{ - "shape":"EntityName", - "documentation":"

The name that you assigned to the optimization job.

" - } - } - }, - "DescribeOptimizationJobResponse":{ - "type":"structure", - "required":[ - "OptimizationJobArn", - "OptimizationJobStatus", - "CreationTime", - "LastModifiedTime", - "OptimizationJobName", - "ModelSource", - "DeploymentInstanceType", - "OptimizationConfigs", - "OutputConfig", - "RoleArn", - "StoppingCondition" - ], - "members":{ - "OptimizationJobArn":{ - "shape":"OptimizationJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the optimization job.

" - }, - "OptimizationJobStatus":{ - "shape":"OptimizationJobStatus", - "documentation":"

The current status of the optimization job.

" - }, - "OptimizationStartTime":{ - "shape":"Timestamp", - "documentation":"

The time when the optimization job started.

" - }, - "OptimizationEndTime":{ - "shape":"Timestamp", - "documentation":"

The time when the optimization job finished processing.

" - }, - "CreationTime":{ - "shape":"CreationTime", - "documentation":"

The time when you created the optimization job.

" - }, - "LastModifiedTime":{ - "shape":"LastModifiedTime", - "documentation":"

The time when the optimization job was last updated.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

If the optimization job status is FAILED, the reason for the failure.

" - }, - "OptimizationJobName":{ - "shape":"EntityName", - "documentation":"

The name that you assigned to the optimization job.

" - }, - "ModelSource":{ - "shape":"OptimizationJobModelSource", - "documentation":"

The location of the source model to optimize with an optimization job.

" - }, - "OptimizationEnvironment":{ - "shape":"OptimizationJobEnvironmentVariables", - "documentation":"

The environment variables to set in the model container.

" - }, - "DeploymentInstanceType":{ - "shape":"OptimizationJobDeploymentInstanceType", - "documentation":"

The type of instance that hosts the optimized model that you create with the optimization job.

" - }, - "MaxInstanceCount":{ - "shape":"OptimizationJobMaxInstanceCount", - "documentation":"

The maximum number of instances to use for the optimization job.

" - }, - "OptimizationConfigs":{ - "shape":"OptimizationConfigs", - "documentation":"

Settings for each of the optimization techniques that the job applies.

" - }, - "OutputConfig":{ - "shape":"OptimizationJobOutputConfig", - "documentation":"

Details for where to store the optimized model that you create with the optimization job.

" - }, - "OptimizationOutput":{ - "shape":"OptimizationOutput", - "documentation":"

Output values produced by an optimization job.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The ARN of the IAM role that you assigned to the optimization job.

" - }, - "StoppingCondition":{"shape":"StoppingCondition"}, - "VpcConfig":{ - "shape":"OptimizationVpcConfig", - "documentation":"

A VPC in Amazon VPC that your optimized model has access to.

" - }, - "TrainingPlanArns":{ - "shape":"OptimizationJobTrainingPlanArns", - "documentation":"

The Amazon Resource Name (ARN) of the training plan associated with this optimization job. This field appears only when you specified a training plan when you created the job. Optimization jobs that use on-demand capacity don't return this field.

" - } - } - }, - "DescribePartnerAppRequest":{ - "type":"structure", - "required":["Arn"], - "members":{ - "Arn":{ - "shape":"PartnerAppArn", - "documentation":"

The ARN of the SageMaker Partner AI App to describe.

" - }, - "IncludeAvailableUpgrade":{ - "shape":"Boolean", - "documentation":"

When set to TRUE, the response includes available upgrade information for the SageMaker Partner AI App. Default is FALSE.

", - "box":true - } - } - }, - "DescribePartnerAppResponse":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"PartnerAppArn", - "documentation":"

The ARN of the SageMaker Partner AI App that was described.

" - }, - "Name":{ - "shape":"PartnerAppName", - "documentation":"

The name of the SageMaker Partner AI App.

" - }, - "Type":{ - "shape":"PartnerAppType", - "documentation":"

The type of SageMaker Partner AI App. Must be one of the following: lakera-guard, comet, deepchecks-llm-evaluation, or fiddler.

" - }, - "Status":{ - "shape":"PartnerAppStatus", - "documentation":"

The status of the SageMaker Partner AI App.

  • Creating: SageMaker AI is creating the partner AI app. The partner AI app is not available during creation.

  • Updating: SageMaker AI is updating the partner AI app. The partner AI app is not available when updating.

  • Deleting: SageMaker AI is deleting the partner AI app. The partner AI app is not available during deletion.

  • Available: The partner AI app is provisioned and accessible.

  • Failed: The partner AI app is in a failed state and isn't available. SageMaker AI is investigating the issue. For further guidance, contact Amazon Web Services Support.

  • UpdateFailed: The partner AI app couldn't be updated but is available.

  • Deleted: The partner AI app is permanently deleted and not available.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The time that the SageMaker Partner AI App was created.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The time that the SageMaker Partner AI App was last modified.

" - }, - "ExecutionRoleArn":{ - "shape":"RoleArn", - "documentation":"

The ARN of the IAM role associated with the SageMaker Partner AI App.

" - }, - "KmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The Amazon Web Services KMS customer managed key used to encrypt the data at rest associated with SageMaker Partner AI Apps.

" - }, - "BaseUrl":{ - "shape":"String2048", - "documentation":"

The URL of the SageMaker Partner AI App that the Application SDK uses to support in-app calls for the user.

" - }, - "MaintenanceConfig":{ - "shape":"PartnerAppMaintenanceConfig", - "documentation":"

Maintenance configuration settings for the SageMaker Partner AI App.

" - }, - "Tier":{ - "shape":"NonEmptyString64", - "documentation":"

The instance type and size of the cluster attached to the SageMaker Partner AI App.

" - }, - "Version":{ - "shape":"NonEmptyString64", - "documentation":"

The version of the SageMaker Partner AI App.

" - }, - "ApplicationConfig":{ - "shape":"PartnerAppConfig", - "documentation":"

Configuration settings for the SageMaker Partner AI App.

" - }, - "AuthType":{ - "shape":"PartnerAppAuthType", - "documentation":"

The authorization type that users use to access the SageMaker Partner AI App.

" - }, - "EnableIamSessionBasedIdentity":{ - "shape":"Boolean", - "documentation":"

When set to TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user.

", - "box":true - }, - "Error":{ - "shape":"ErrorInfo", - "documentation":"

This is an error field object that contains the error code and the reason for an operation failure.

" - }, - "EnableAutoMinorVersionUpgrade":{ - "shape":"Boolean", - "documentation":"

Indicates whether the SageMaker Partner AI App is configured for automatic minor version upgrades during scheduled maintenance windows.

", - "box":true - }, - "CurrentVersionEolDate":{ - "shape":"Timestamp", - "documentation":"

The end-of-life date for the current version of the SageMaker Partner AI App.

" - }, - "AvailableUpgrade":{ - "shape":"AvailableUpgrade", - "documentation":"

A map of available minor version upgrades for the SageMaker Partner AI App. The key is the semantic version number, and the value is a list of release notes for that version. A null value indicates no upgrades are available.

" - } - } - }, - "DescribePipelineDefinitionForExecutionRequest":{ - "type":"structure", - "required":["PipelineExecutionArn"], - "members":{ - "PipelineExecutionArn":{ - "shape":"PipelineExecutionArn", - "documentation":"

The Amazon Resource Name (ARN) of the pipeline execution.

" - } - } - }, - "DescribePipelineDefinitionForExecutionResponse":{ - "type":"structure", - "members":{ - "PipelineDefinition":{ - "shape":"PipelineDefinition", - "documentation":"

The JSON pipeline definition.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The time when the pipeline was created.

" - } - } - }, - "DescribePipelineExecutionRequest":{ - "type":"structure", - "required":["PipelineExecutionArn"], - "members":{ - "PipelineExecutionArn":{ - "shape":"PipelineExecutionArn", - "documentation":"

The Amazon Resource Name (ARN) of the pipeline execution.

" - } - } - }, - "DescribePipelineExecutionResponse":{ - "type":"structure", - "members":{ - "PipelineArn":{ - "shape":"PipelineArn", - "documentation":"

The Amazon Resource Name (ARN) of the pipeline.

" - }, - "PipelineExecutionArn":{ - "shape":"PipelineExecutionArn", - "documentation":"

The Amazon Resource Name (ARN) of the pipeline execution.

" - }, - "PipelineExecutionDisplayName":{ - "shape":"PipelineExecutionName", - "documentation":"

The display name of the pipeline execution.

" - }, - "PipelineExecutionStatus":{ - "shape":"PipelineExecutionStatus", - "documentation":"

The status of the pipeline execution.

" - }, - "PipelineExecutionDescription":{ - "shape":"PipelineExecutionDescription", - "documentation":"

The description of the pipeline execution.

" - }, - "PipelineExperimentConfig":{"shape":"PipelineExperimentConfig"}, - "FailureReason":{ - "shape":"PipelineExecutionFailureReason", - "documentation":"

If the execution failed, a message describing why.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The time when the pipeline execution was created.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The time when the pipeline execution was modified last.

" - }, - "CreatedBy":{"shape":"UserContext"}, - "LastModifiedBy":{"shape":"UserContext"}, - "ParallelismConfiguration":{ - "shape":"ParallelismConfiguration", - "documentation":"

The parallelism configuration applied to the pipeline.

" - }, - "SelectiveExecutionConfig":{ - "shape":"SelectiveExecutionConfig", - "documentation":"

The selective execution configuration applied to the pipeline run.

" - }, - "PipelineVersionId":{ - "shape":"PipelineVersionId", - "documentation":"

The ID of the pipeline version.

" - }, - "MLflowConfig":{ - "shape":"MLflowConfiguration", - "documentation":"

The MLflow configuration of the pipeline execution.

" - } - } - }, - "DescribePipelineRequest":{ - "type":"structure", - "required":["PipelineName"], - "members":{ - "PipelineName":{ - "shape":"PipelineNameOrArn", - "documentation":"

The name or Amazon Resource Name (ARN) of the pipeline to describe.

" - }, - "PipelineVersionId":{ - "shape":"PipelineVersionId", - "documentation":"

The ID of the pipeline version to describe.

" - } - } - }, - "DescribePipelineResponse":{ - "type":"structure", - "members":{ - "PipelineArn":{ - "shape":"PipelineArn", - "documentation":"

The Amazon Resource Name (ARN) of the pipeline.

" - }, - "PipelineName":{ - "shape":"PipelineName", - "documentation":"

The name of the pipeline.

" - }, - "PipelineDisplayName":{ - "shape":"PipelineName", - "documentation":"

The display name of the pipeline.

" - }, - "PipelineDefinition":{ - "shape":"PipelineDefinition", - "documentation":"

The JSON pipeline definition.

" - }, - "PipelineDescription":{ - "shape":"PipelineDescription", - "documentation":"

The description of the pipeline.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) that the pipeline uses to execute.

" - }, - "PipelineStatus":{ - "shape":"PipelineStatus", - "documentation":"

The status of the pipeline execution.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The time when the pipeline was created.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The time when the pipeline was last modified.

" - }, - "LastRunTime":{ - "shape":"Timestamp", - "documentation":"

The time when the pipeline was last run.

" - }, - "CreatedBy":{"shape":"UserContext"}, - "LastModifiedBy":{"shape":"UserContext"}, - "ParallelismConfiguration":{ - "shape":"ParallelismConfiguration", - "documentation":"

Lists the parallelism configuration applied to the pipeline.

" - }, - "PipelineVersionDisplayName":{ - "shape":"PipelineVersionName", - "documentation":"

The display name of the pipeline version.

" - }, - "PipelineVersionDescription":{ - "shape":"PipelineVersionDescription", - "documentation":"

The description of the pipeline version.

" - } - } - }, - "DescribeProcessingJobRequest":{ - "type":"structure", - "required":["ProcessingJobName"], - "members":{ - "ProcessingJobName":{ - "shape":"ProcessingJobName", - "documentation":"

The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

" - } - } - }, - "DescribeProcessingJobResponse":{ - "type":"structure", - "required":[ - "ProcessingJobName", - "ProcessingResources", - "AppSpecification", - "ProcessingJobArn", - "ProcessingJobStatus", - "CreationTime" - ], - "members":{ - "ProcessingInputs":{ - "shape":"ProcessingInputs", - "documentation":"

The inputs for a processing job.

" - }, - "ProcessingOutputConfig":{ - "shape":"ProcessingOutputConfig", - "documentation":"

Output configuration for the processing job.

" - }, - "ProcessingJobName":{ - "shape":"ProcessingJobName", - "documentation":"

The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

" - }, - "ProcessingResources":{ - "shape":"ProcessingResources", - "documentation":"

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.

" - }, - "StoppingCondition":{ - "shape":"ProcessingStoppingCondition", - "documentation":"

The time limit for how long the processing job is allowed to run.

" - }, - "AppSpecification":{ - "shape":"AppSpecification", - "documentation":"

Configures the processing job to run a specified container image.

" - }, - "Environment":{ - "shape":"ProcessingEnvironmentMap", - "documentation":"

The environment variables set in the Docker container.

" - }, - "NetworkConfig":{ - "shape":"NetworkConfig", - "documentation":"

Networking options for a processing job.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

" - }, - "ExperimentConfig":{ - "shape":"ExperimentConfig", - "documentation":"

The configuration information used to create an experiment.

" - }, - "ProcessingJobArn":{ - "shape":"ProcessingJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the processing job.

" - }, - "ProcessingJobStatus":{ - "shape":"ProcessingJobStatus", - "documentation":"

Provides the status of a processing job.

" - }, - "ExitMessage":{ - "shape":"ExitMessage", - "documentation":"

An optional string, up to one KB in size, that contains metadata from the processing container when the processing job exits.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

A string, up to one KB in size, that contains the reason a processing job failed, if it failed.

" - }, - "ProcessingEndTime":{ - "shape":"Timestamp", - "documentation":"

The time at which the processing job completed.

" - }, - "ProcessingStartTime":{ - "shape":"Timestamp", - "documentation":"

The time at which the processing job started.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The time at which the processing job was last modified.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The time at which the processing job was created.

" - }, - "MonitoringScheduleArn":{ - "shape":"MonitoringScheduleArn", - "documentation":"

The ARN of a monitoring schedule for an endpoint associated with this processing job.

" - }, - "AutoMLJobArn":{ - "shape":"AutoMLJobArn", - "documentation":"

The ARN of an AutoML job associated with this processing job.

" - }, - "TrainingJobArn":{ - "shape":"TrainingJobArn", - "documentation":"

The ARN of a training job associated with this processing job.

" - } - } - }, - "DescribeProjectInput":{ - "type":"structure", - "required":["ProjectName"], - "members":{ - "ProjectName":{ - "shape":"ProjectEntityName", - "documentation":"

The name of the project to describe.

" - } - } - }, - "DescribeProjectOutput":{ - "type":"structure", - "required":[ - "ProjectArn", - "ProjectName", - "ProjectId", - "ProjectStatus", - "CreationTime" - ], - "members":{ - "ProjectArn":{ - "shape":"ProjectArn", - "documentation":"

The Amazon Resource Name (ARN) of the project.

" - }, - "ProjectName":{ - "shape":"ProjectEntityName", - "documentation":"

The name of the project.

" - }, - "ProjectId":{ - "shape":"ProjectId", - "documentation":"

The ID of the project.

" - }, - "ProjectDescription":{ - "shape":"EntityDescription", - "documentation":"

The description of the project.

" - }, - "ServiceCatalogProvisioningDetails":{ - "shape":"ServiceCatalogProvisioningDetails", - "documentation":"

Information used to provision a service catalog product. For information, see What is Amazon Web Services Service Catalog.

" - }, - "ServiceCatalogProvisionedProductDetails":{ - "shape":"ServiceCatalogProvisionedProductDetails", - "documentation":"

Information about a provisioned service catalog product.

" - }, - "ProjectStatus":{ - "shape":"ProjectStatus", - "documentation":"

The status of the project.

" - }, - "TemplateProviderDetails":{ - "shape":"TemplateProviderDetailList", - "documentation":"

An array of template providers associated with the project.

" - }, - "CreatedBy":{"shape":"UserContext"}, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The time when the project was created.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp when project was last modified.

" - }, - "LastModifiedBy":{"shape":"UserContext"} - } - }, - "DescribeReservedCapacityRequest":{ - "type":"structure", - "required":["ReservedCapacityArn"], - "members":{ - "ReservedCapacityArn":{ - "shape":"ReservedCapacityArn", - "documentation":"

ARN of the reserved capacity to describe.

" - } - } - }, - "DescribeReservedCapacityResponse":{ - "type":"structure", - "required":[ - "ReservedCapacityArn", - "InstanceType", - "TotalInstanceCount" - ], - "members":{ - "ReservedCapacityArn":{ - "shape":"ReservedCapacityArn", - "documentation":"

ARN of the reserved capacity.

" - }, - "ReservedCapacityType":{ - "shape":"ReservedCapacityType", - "documentation":"

The type of reserved capacity.

" - }, - "Status":{ - "shape":"ReservedCapacityStatus", - "documentation":"

The current status of the reserved capacity.

" - }, - "AvailabilityZone":{ - "shape":"AvailabilityZone", - "documentation":"

The Availability Zone where the reserved capacity is provisioned.

" - }, - "DurationHours":{ - "shape":"ReservedCapacityDurationHours", - "documentation":"

The total duration of the reserved capacity in hours.

" - }, - "DurationMinutes":{ - "shape":"ReservedCapacityDurationMinutes", - "documentation":"

The number of minutes for the duration of the reserved capacity. For example, if a reserved capacity starts at 08:55 and ends at 11:30, the minutes field would be 35.

" - }, - "StartTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the reserved capacity becomes active.

" - }, - "EndTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the reserved capacity expires.

" - }, - "InstanceType":{ - "shape":"ReservedCapacityInstanceType", - "documentation":"

The Amazon EC2 instance type used in the reserved capacity.

" - }, - "TotalInstanceCount":{ - "shape":"TotalInstanceCount", - "documentation":"

The total number of instances allocated to this reserved capacity.

" - }, - "AvailableInstanceCount":{ - "shape":"AvailableInstanceCount", - "documentation":"

The number of instances currently available for use in this reserved capacity.

" - }, - "InUseInstanceCount":{ - "shape":"InUseInstanceCount", - "documentation":"

The number of instances currently in use from this reserved capacity.

" - }, - "UltraServerSummary":{ - "shape":"UltraServerSummary", - "documentation":"

A summary of the UltraServer associated with this reserved capacity.

" - } - } - }, - "DescribeSpaceRequest":{ - "type":"structure", - "required":[ - "DomainId", - "SpaceName" - ], - "members":{ - "DomainId":{ - "shape":"DomainId", - "documentation":"

The ID of the associated domain.

" - }, - "SpaceName":{ - "shape":"SpaceName", - "documentation":"

The name of the space.

" - } - } - }, - "DescribeSpaceResponse":{ - "type":"structure", - "members":{ - "DomainId":{ - "shape":"DomainId", - "documentation":"

The ID of the associated domain.

" - }, - "SpaceArn":{ - "shape":"SpaceArn", - "documentation":"

The space's Amazon Resource Name (ARN).

" - }, - "SpaceName":{ - "shape":"SpaceName", - "documentation":"

The name of the space.

" - }, - "HomeEfsFileSystemUid":{ - "shape":"EfsUid", - "documentation":"

The ID of the space's profile in the Amazon EFS volume.

" - }, - "Status":{ - "shape":"SpaceStatus", - "documentation":"

The status.

" - }, - "LastModifiedTime":{ - "shape":"LastModifiedTime", - "documentation":"

The last modified time.

" - }, - "CreationTime":{ - "shape":"CreationTime", - "documentation":"

The creation time.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

The failure reason.

" - }, - "SpaceSettings":{ - "shape":"SpaceSettings", - "documentation":"

A collection of space settings.

" - }, - "OwnershipSettings":{ - "shape":"OwnershipSettings", - "documentation":"

The collection of ownership settings for a space.

" - }, - "SpaceSharingSettings":{ - "shape":"SpaceSharingSettings", - "documentation":"

The collection of space sharing settings for a space.

" - }, - "SpaceDisplayName":{ - "shape":"NonEmptyString64", - "documentation":"

The name of the space that appears in the Amazon SageMaker Studio UI.

" - }, - "Url":{ - "shape":"String1024", - "documentation":"

Returns the URL of the space. If the space is created with Amazon Web Services IAM Identity Center (Successor to Amazon Web Services Single Sign-On) authentication, users can navigate to the URL after appending the respective redirect parameter for the application type to be federated through Amazon Web Services IAM Identity Center.

The following application types are supported:

  • Studio Classic: &redirect=JupyterServer

  • JupyterLab: &redirect=JupyterLab

  • Code Editor, based on Code-OSS, Visual Studio Code - Open Source: &redirect=CodeEditor

" - } - } - }, - "DescribeStudioLifecycleConfigRequest":{ - "type":"structure", - "required":["StudioLifecycleConfigName"], - "members":{ - "StudioLifecycleConfigName":{ - "shape":"StudioLifecycleConfigName", - "documentation":"

The name of the Amazon SageMaker AI Studio Lifecycle Configuration to describe.

" - } - } - }, - "DescribeStudioLifecycleConfigResponse":{ - "type":"structure", - "members":{ - "StudioLifecycleConfigArn":{ - "shape":"StudioLifecycleConfigArn", - "documentation":"

The ARN of the Lifecycle Configuration to describe.

" - }, - "StudioLifecycleConfigName":{ - "shape":"StudioLifecycleConfigName", - "documentation":"

The name of the Amazon SageMaker AI Studio Lifecycle Configuration that is described.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The creation time of the Amazon SageMaker AI Studio Lifecycle Configuration.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

This value is equivalent to CreationTime because Amazon SageMaker AI Studio Lifecycle Configurations are immutable.

" - }, - "StudioLifecycleConfigContent":{ - "shape":"StudioLifecycleConfigContent", - "documentation":"

The content of your Amazon SageMaker AI Studio Lifecycle Configuration script.

" - }, - "StudioLifecycleConfigAppType":{ - "shape":"StudioLifecycleConfigAppType", - "documentation":"

The App type that the Lifecycle Configuration is attached to.

" - } - } - }, - "DescribeSubscribedWorkteamRequest":{ - "type":"structure", - "required":["WorkteamArn"], - "members":{ - "WorkteamArn":{ - "shape":"WorkteamArn", - "documentation":"

The Amazon Resource Name (ARN) of the subscribed work team to describe.

" - } - } - }, - "DescribeSubscribedWorkteamResponse":{ - "type":"structure", - "required":["SubscribedWorkteam"], - "members":{ - "SubscribedWorkteam":{ - "shape":"SubscribedWorkteam", - "documentation":"

A Workteam instance that contains information about the work team.

" - } - } - }, - "DescribeTrainingJobRequest":{ - "type":"structure", - "required":["TrainingJobName"], - "members":{ - "TrainingJobName":{ - "shape":"TrainingJobName", - "documentation":"

The name of the training job.

" - } - } - }, - "DescribeTrainingJobResponse":{ - "type":"structure", - "required":[ - "TrainingJobName", - "TrainingJobArn", - "ModelArtifacts", - "TrainingJobStatus", - "SecondaryStatus", - "StoppingCondition", - "CreationTime" - ], - "members":{ - "TrainingJobName":{ - "shape":"TrainingJobName", - "documentation":"

Name of the model training job.

" - }, - "TrainingJobArn":{ - "shape":"TrainingJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the training job.

" - }, - "TuningJobArn":{ - "shape":"HyperParameterTuningJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.

" - }, - "LabelingJobArn":{ - "shape":"LabelingJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the SageMaker Ground Truth labeling job that created the transform or training job.

" - }, - "AutoMLJobArn":{ - "shape":"AutoMLJobArn", - "documentation":"

The Amazon Resource Name (ARN) of an AutoML job.

" - }, - "ModelArtifacts":{ - "shape":"ModelArtifacts", - "documentation":"

Information about the Amazon S3 location that is configured for storing model artifacts.

" - }, - "TrainingJobStatus":{ - "shape":"TrainingJobStatus", - "documentation":"

The status of the training job.

SageMaker provides the following training job statuses:

  • InProgress - The training is in progress.

  • Completed - The training job has completed.

  • Failed - The training job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTrainingJobResponse call.

  • Stopping - The training job is stopping.

  • Stopped - The training job has stopped.

For more detailed information, see SecondaryStatus.

" - }, - "SecondaryStatus":{ - "shape":"SecondaryStatus", - "documentation":"

Provides detailed information about the state of the training job. For detailed information on the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.

SageMaker provides primary statuses and secondary statuses that apply to each of them:

InProgress

  • Starting - Starting the training job.

  • Pending - The training job is waiting for compute capacity or compute resource provision.

  • Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.

  • Training - Training is in progress.

  • Interrupted - The job stopped because the managed spot training instances were interrupted.

  • Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.

Completed

  • Completed - The training job has completed.

Failed

  • Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.

Stopped

  • MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.

  • MaxWaitTimeExceeded - The job stopped because it exceeded the maximum allowed wait time.

  • Stopped - The training job has stopped.

Stopping

  • Stopping - Stopping the training job.

Valid values for SecondaryStatus are subject to change.

We no longer support the following secondary statuses:

  • LaunchingMLInstances

  • PreparingTraining

  • DownloadingTrainingImage

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

If the training job failed, the reason it failed.

" - }, - "HyperParameters":{ - "shape":"HyperParameters", - "documentation":"

Algorithm-specific parameters.

" - }, - "AlgorithmSpecification":{ - "shape":"AlgorithmSpecification", - "documentation":"

Information about the algorithm used for training, and algorithm metadata.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Web Services Identity and Access Management (IAM) role configured for the training job.

" - }, - "InputDataConfig":{ - "shape":"InputDataConfig", - "documentation":"

An array of Channel objects that describes each data input channel.

" - }, - "OutputDataConfig":{ - "shape":"OutputDataConfig", - "documentation":"

The S3 path where model artifacts that you configured when creating the job are stored. SageMaker creates subfolders for model artifacts.

" - }, - "ResourceConfig":{ - "shape":"ResourceConfig", - "documentation":"

Resources, including ML compute instances and ML storage volumes, that are configured for model training.

" - }, - "WarmPoolStatus":{ - "shape":"WarmPoolStatus", - "documentation":"

The status of the warm pool associated with the training job.

" - }, - "VpcConfig":{ - "shape":"VpcConfig", - "documentation":"

A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

" - }, - "StoppingCondition":{ - "shape":"StoppingCondition", - "documentation":"

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that indicates when the training job was created.

" - }, - "TrainingStartTime":{ - "shape":"Timestamp", - "documentation":"

Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.

" - }, - "TrainingEndTime":{ - "shape":"Timestamp", - "documentation":"

Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when SageMaker detects a job failure.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that indicates when the status of the training job was last modified.

" - }, - "SecondaryStatusTransitions":{ - "shape":"SecondaryStatusTransitions", - "documentation":"

A history of all of the secondary statuses that the training job has transitioned through.

" - }, - "FinalMetricDataList":{ - "shape":"FinalMetricDataList", - "documentation":"

A collection of MetricData objects that specify the names, values, and dates and times that the training algorithm emitted to Amazon CloudWatch.

" - }, - "EnableNetworkIsolation":{ - "shape":"Boolean", - "documentation":"

If you want to allow inbound or outbound network calls, except for calls between peers within a training cluster for distributed training, choose True. If you enable network isolation for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

", - "box":true - }, - "EnableInterContainerTrafficEncryption":{ - "shape":"Boolean", - "documentation":"

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithms in distributed training.

", - "box":true - }, - "EnableManagedSpotTraining":{ - "shape":"Boolean", - "documentation":"

A Boolean indicating whether managed spot training is enabled (True) or not (False).

", - "box":true - }, - "CheckpointConfig":{"shape":"CheckpointConfig"}, - "TrainingTimeInSeconds":{ - "shape":"TrainingTimeInSeconds", - "documentation":"

The training time in seconds.

" - }, - "BillableTimeInSeconds":{ - "shape":"BillableTimeInSeconds", - "documentation":"

The billable time in seconds. Billable time refers to the absolute wall-clock time.

Multiply BillableTimeInSeconds by the number of instances (InstanceCount) in your training cluster to get the total compute time SageMaker bills you if you run distributed training. The formula is as follows: BillableTimeInSeconds * InstanceCount .

You can calculate the savings from using managed spot training using the formula (1 - BillableTimeInSeconds / TrainingTimeInSeconds) * 100. For example, if BillableTimeInSeconds is 100 and TrainingTimeInSeconds is 500, the savings is 80%.

" - }, - "BillableTokenCount":{ - "shape":"BillableTokenCount", - "documentation":"

The billable token count for eligible serverless training jobs.

" - }, - "DebugHookConfig":{"shape":"DebugHookConfig"}, - "ExperimentConfig":{"shape":"ExperimentConfig"}, - "DebugRuleConfigurations":{ - "shape":"DebugRuleConfigurations", - "documentation":"

Configuration information for Amazon SageMaker Debugger rules for debugging output tensors.

" - }, - "TensorBoardOutputConfig":{"shape":"TensorBoardOutputConfig"}, - "DebugRuleEvaluationStatuses":{ - "shape":"DebugRuleEvaluationStatuses", - "documentation":"

Evaluation status of Amazon SageMaker Debugger rules for debugging on a training job.

" - }, - "ProfilerConfig":{"shape":"ProfilerConfig"}, - "ProfilerRuleConfigurations":{ - "shape":"ProfilerRuleConfigurations", - "documentation":"

Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics.

" - }, - "ProfilerRuleEvaluationStatuses":{ - "shape":"ProfilerRuleEvaluationStatuses", - "documentation":"

Evaluation status of Amazon SageMaker Debugger rules for profiling on a training job.

" - }, - "ProfilingStatus":{ - "shape":"ProfilingStatus", - "documentation":"

Profiling status of a training job.

" - }, - "Environment":{ - "shape":"TrainingEnvironmentMap", - "documentation":"

The environment variables to set in the Docker container.

Do not include any security-sensitive information including account access IDs, secrets, or tokens in any environment fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request environment variable or plain text fields.

" - }, - "RetryStrategy":{ - "shape":"RetryStrategy", - "documentation":"

The number of times to retry the job when the job fails due to an InternalServerError.

" - }, - "RemoteDebugConfig":{ - "shape":"RemoteDebugConfig", - "documentation":"

Configuration for remote debugging. To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.

" - }, - "InfraCheckConfig":{ - "shape":"InfraCheckConfig", - "documentation":"

Contains information about the infrastructure health check configuration for the training job.

" - }, - "ServerlessJobConfig":{ - "shape":"ServerlessJobConfig", - "documentation":"

The configuration for serverless training jobs.

" - }, - "MlflowConfig":{ - "shape":"MlflowConfig", - "documentation":"

The MLflow configuration using SageMaker managed MLflow.

" - }, - "ModelPackageConfig":{ - "shape":"ModelPackageConfig", - "documentation":"

The configuration for the model package.

" - }, - "MlflowDetails":{ - "shape":"MlflowDetails", - "documentation":"

The MLflow details of this job.

" - }, - "ProgressInfo":{ - "shape":"TrainingProgressInfo", - "documentation":"

The Serverless training job progress information.

" - }, - "OutputModelPackageArn":{ - "shape":"ModelPackageArn", - "documentation":"

The Amazon Resource Name (ARN) of the output model package containing model weights or checkpoints.

" - } - } - }, - "DescribeTrainingPlanExtensionHistoryRequest":{ - "type":"structure", - "required":["TrainingPlanArn"], - "members":{ - "TrainingPlanArn":{ - "shape":"TrainingPlanArn", - "documentation":"

The Amazon Resource Name (ARN); of the training plan to retrieve extension history for.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

A token to continue pagination if more results are available.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of extensions to return in the response.

" - } - } - }, - "DescribeTrainingPlanExtensionHistoryResponse":{ - "type":"structure", - "required":["TrainingPlanExtensions"], - "members":{ - "TrainingPlanExtensions":{ - "shape":"TrainingPlanExtensions", - "documentation":"

A list of extensions for the specified training plan.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

A token to continue pagination if more results are available.

" - } - } - }, - "DescribeTrainingPlanRequest":{ - "type":"structure", - "required":["TrainingPlanName"], - "members":{ - "TrainingPlanName":{ - "shape":"TrainingPlanName", - "documentation":"

The name of the training plan to describe.

" - } - } - }, - "DescribeTrainingPlanResponse":{ - "type":"structure", - "required":[ - "TrainingPlanArn", - "TrainingPlanName", - "Status" - ], - "members":{ - "TrainingPlanArn":{ - "shape":"TrainingPlanArn", - "documentation":"

The Amazon Resource Name (ARN); of the training plan.

" - }, - "TrainingPlanName":{ - "shape":"TrainingPlanName", - "documentation":"

The name of the training plan.

" - }, - "Status":{ - "shape":"TrainingPlanStatus", - "documentation":"

The current status of the training plan (e.g., Pending, Active, Expired). To see the complete list of status values available for a training plan, refer to the Status attribute within the TrainingPlanSummary object.

" - }, - "StatusMessage":{ - "shape":"TrainingPlanStatusMessage", - "documentation":"

A message providing additional information about the current status of the training plan.

" - }, - "DurationHours":{ - "shape":"TrainingPlanDurationHours", - "documentation":"

The number of whole hours in the total duration for this training plan.

" - }, - "DurationMinutes":{ - "shape":"TrainingPlanDurationMinutes", - "documentation":"

The additional minutes beyond whole hours in the total duration for this training plan.

" - }, - "StartTime":{ - "shape":"Timestamp", - "documentation":"

The start time of the training plan.

" - }, - "EndTime":{ - "shape":"Timestamp", - "documentation":"

The end time of the training plan.

" - }, - "UpfrontFee":{ - "shape":"String256", - "documentation":"

The upfront fee for the training plan.

" - }, - "CurrencyCode":{ - "shape":"CurrencyCode", - "documentation":"

The currency code for the upfront fee (e.g., USD).

" - }, - "TotalInstanceCount":{ - "shape":"TotalInstanceCount", - "documentation":"

The total number of instances reserved in this training plan.

" - }, - "AvailableInstanceCount":{ - "shape":"AvailableInstanceCount", - "documentation":"

The number of instances currently available for use in this training plan.

" - }, - "InUseInstanceCount":{ - "shape":"InUseInstanceCount", - "documentation":"

The number of instances currently in use from this training plan.

" - }, - "UnhealthyInstanceCount":{ - "shape":"UnhealthyInstanceCount", - "documentation":"

The number of instances in the training plan that are currently in an unhealthy state.

" - }, - "AvailableSpareInstanceCount":{ - "shape":"AvailableSpareInstanceCount", - "documentation":"

The number of available spare instances in the training plan.

" - }, - "TotalUltraServerCount":{ - "shape":"UltraServerCount", - "documentation":"

The total number of UltraServers reserved to this training plan.

" - }, - "TargetResources":{ - "shape":"SageMakerResourceNames", - "documentation":"

The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod, SageMaker Endpoints, Studio apps) that can use this training plan.

Training plans are specific to their target resource.

  • A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs.

  • A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster's instance group.

  • A training plan for SageMaker endpoints can be used exclusively to provide compute resources to SageMaker endpoints for model deployment.

  • A training plan for Studio apps can be used to launch JupyterLab and Code Editor apps on reserved training plan capacity.

" - }, - "ReservedCapacitySummaries":{ - "shape":"ReservedCapacitySummaries", - "documentation":"

The list of Reserved Capacity providing the underlying compute resources of the plan.

" - } - } - }, - "DescribeTransformJobRequest":{ - "type":"structure", - "required":["TransformJobName"], - "members":{ - "TransformJobName":{ - "shape":"TransformJobName", - "documentation":"

The name of the transform job that you want to view details of.

" - } - } - }, - "DescribeTransformJobResponse":{ - "type":"structure", - "required":[ - "TransformJobName", - "TransformJobArn", - "TransformJobStatus", - "ModelName", - "TransformInput", - "TransformResources", - "CreationTime" - ], - "members":{ - "TransformJobName":{ - "shape":"TransformJobName", - "documentation":"

The name of the transform job.

" - }, - "TransformJobArn":{ - "shape":"TransformJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the transform job.

" - }, - "TransformJobStatus":{ - "shape":"TransformJobStatus", - "documentation":"

The status of the transform job. If the transform job failed, the reason is returned in the FailureReason field.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

If the transform job failed, FailureReason describes why it failed. A transform job creates a log file, which includes error messages, and stores it as an Amazon S3 object. For more information, see Log Amazon SageMaker Events with Amazon CloudWatch.

" - }, - "ModelName":{ - "shape":"ModelName", - "documentation":"

The name of the model used in the transform job.

" - }, - "MaxConcurrentTransforms":{ - "shape":"MaxConcurrentTransforms", - "documentation":"

The maximum number of parallel requests on each instance node that can be launched in a transform job. The default value is 1.

" - }, - "ModelClientConfig":{ - "shape":"ModelClientConfig", - "documentation":"

The timeout and maximum number of retries for processing a transform job invocation.

" - }, - "MaxPayloadInMB":{ - "shape":"MaxPayloadInMB", - "documentation":"

The maximum payload size, in MB, used in the transform job.

" - }, - "BatchStrategy":{ - "shape":"BatchStrategy", - "documentation":"

Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.

To enable the batch strategy, you must set SplitType to Line, RecordIO, or TFRecord.

" - }, - "Environment":{ - "shape":"TransformEnvironmentMap", - "documentation":"

The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

" - }, - "TransformInput":{ - "shape":"TransformInput", - "documentation":"

Describes the dataset to be transformed and the Amazon S3 location where it is stored.

" - }, - "TransformOutput":{ - "shape":"TransformOutput", - "documentation":"

Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

" - }, - "DataCaptureConfig":{ - "shape":"BatchDataCaptureConfig", - "documentation":"

Configuration to control how SageMaker captures inference data.

" - }, - "TransformResources":{ - "shape":"TransformResources", - "documentation":"

Describes the resources, including ML instance types and ML instance count, to use for the transform job.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that shows when the transform Job was created.

" - }, - "TransformStartTime":{ - "shape":"Timestamp", - "documentation":"

Indicates when the transform job starts on ML instances. You are billed for the time interval between this time and the value of TransformEndTime.

" - }, - "TransformEndTime":{ - "shape":"Timestamp", - "documentation":"

Indicates when the transform job has been completed, or has stopped or failed. You are billed for the time interval between this time and the value of TransformStartTime.

" - }, - "LabelingJobArn":{ - "shape":"LabelingJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.

" - }, - "AutoMLJobArn":{ - "shape":"AutoMLJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the AutoML transform job.

" - }, - "DataProcessing":{"shape":"DataProcessing"}, - "ExperimentConfig":{"shape":"ExperimentConfig"} - } - }, - "DescribeTrialComponentRequest":{ - "type":"structure", - "required":["TrialComponentName"], - "members":{ - "TrialComponentName":{ - "shape":"ExperimentEntityNameOrArn", - "documentation":"

The name of the trial component to describe.

" - } - } - }, - "DescribeTrialComponentResponse":{ - "type":"structure", - "members":{ - "TrialComponentName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the trial component.

" - }, - "TrialComponentArn":{ - "shape":"TrialComponentArn", - "documentation":"

The Amazon Resource Name (ARN) of the trial component.

" - }, - "DisplayName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.

" - }, - "Source":{ - "shape":"TrialComponentSource", - "documentation":"

The Amazon Resource Name (ARN) of the source and, optionally, the job type.

" - }, - "Status":{ - "shape":"TrialComponentStatus", - "documentation":"

The status of the component. States include:

  • InProgress

  • Completed

  • Failed

" - }, - "StartTime":{ - "shape":"Timestamp", - "documentation":"

When the component started.

" - }, - "EndTime":{ - "shape":"Timestamp", - "documentation":"

When the component ended.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

When the component was created.

" - }, - "CreatedBy":{ - "shape":"UserContext", - "documentation":"

Who created the trial component.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

When the component was last modified.

" - }, - "LastModifiedBy":{ - "shape":"UserContext", - "documentation":"

Who last modified the component.

" - }, - "Parameters":{ - "shape":"TrialComponentParameters", - "documentation":"

The hyperparameters of the component.

" - }, - "InputArtifacts":{ - "shape":"TrialComponentArtifacts", - "documentation":"

The input artifacts of the component.

" - }, - "OutputArtifacts":{ - "shape":"TrialComponentArtifacts", - "documentation":"

The output artifacts of the component.

" - }, - "MetadataProperties":{"shape":"MetadataProperties"}, - "Metrics":{ - "shape":"TrialComponentMetricSummaries", - "documentation":"

The metrics for the component.

" - }, - "LineageGroupArn":{ - "shape":"LineageGroupArn", - "documentation":"

The Amazon Resource Name (ARN) of the lineage group.

" - }, - "Sources":{ - "shape":"TrialComponentSources", - "documentation":"

A list of ARNs and, if applicable, job types for multiple sources of an experiment run.

" - } - } - }, - "DescribeTrialRequest":{ - "type":"structure", - "required":["TrialName"], - "members":{ - "TrialName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the trial to describe.

" - } - } - }, - "DescribeTrialResponse":{ - "type":"structure", - "members":{ - "TrialName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the trial.

" - }, - "TrialArn":{ - "shape":"TrialArn", - "documentation":"

The Amazon Resource Name (ARN) of the trial.

" - }, - "DisplayName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the trial as displayed. If DisplayName isn't specified, TrialName is displayed.

" - }, - "ExperimentName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the experiment the trial is part of.

" - }, - "Source":{ - "shape":"TrialSource", - "documentation":"

The Amazon Resource Name (ARN) of the source and, optionally, the job type.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

When the trial was created.

" - }, - "CreatedBy":{ - "shape":"UserContext", - "documentation":"

Who created the trial.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

When the trial was last modified.

" - }, - "LastModifiedBy":{ - "shape":"UserContext", - "documentation":"

Who last modified the trial.

" - }, - "MetadataProperties":{"shape":"MetadataProperties"} - } - }, - "DescribeUserProfileRequest":{ - "type":"structure", - "required":[ - "DomainId", - "UserProfileName" - ], - "members":{ - "DomainId":{ - "shape":"DomainId", - "documentation":"

The domain ID.

" - }, - "UserProfileName":{ - "shape":"UserProfileName", - "documentation":"

The user profile name. This value is not case sensitive.

" - } - } - }, - "DescribeUserProfileResponse":{ - "type":"structure", - "members":{ - "DomainId":{ - "shape":"DomainId", - "documentation":"

The ID of the domain that contains the profile.

" - }, - "UserProfileArn":{ - "shape":"UserProfileArn", - "documentation":"

The user profile Amazon Resource Name (ARN).

" - }, - "UserProfileName":{ - "shape":"UserProfileName", - "documentation":"

The user profile name.

" - }, - "HomeEfsFileSystemUid":{ - "shape":"EfsUid", - "documentation":"

The ID of the user's profile in the Amazon Elastic File System volume.

" - }, - "Status":{ - "shape":"UserProfileStatus", - "documentation":"

The status.

" - }, - "LastModifiedTime":{ - "shape":"LastModifiedTime", - "documentation":"

The last modified time.

" - }, - "CreationTime":{ - "shape":"CreationTime", - "documentation":"

The creation time.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

The failure reason.

" - }, - "SingleSignOnUserIdentifier":{ - "shape":"SingleSignOnUserIdentifier", - "documentation":"

The IAM Identity Center user identifier.

" - }, - "SingleSignOnUserValue":{ - "shape":"String256", - "documentation":"

The IAM Identity Center user value.

" - }, - "UserSettings":{ - "shape":"UserSettings", - "documentation":"

A collection of settings.

" - } - } - }, - "DescribeWorkforceRequest":{ - "type":"structure", - "required":["WorkforceName"], - "members":{ - "WorkforceName":{ - "shape":"WorkforceName", - "documentation":"

The name of the private workforce whose access you want to restrict. WorkforceName is automatically set to default when a workforce is created and cannot be modified.

" - } - } - }, - "DescribeWorkforceResponse":{ - "type":"structure", - "required":["Workforce"], - "members":{ - "Workforce":{ - "shape":"Workforce", - "documentation":"

A single private workforce, which is automatically created when you create your first private work team. You can create one private work force in each Amazon Web Services Region. By default, any workforce-related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

" - } - } - }, - "DescribeWorkteamRequest":{ - "type":"structure", - "required":["WorkteamName"], - "members":{ - "WorkteamName":{ - "shape":"WorkteamName", - "documentation":"

The name of the work team to return a description of.

" - } - } - }, - "DescribeWorkteamResponse":{ - "type":"structure", - "required":["Workteam"], - "members":{ - "Workteam":{ - "shape":"Workteam", - "documentation":"

A Workteam instance that contains information about the work team.

" - } - } - }, - "Description":{ - "type":"string", - "max":128, - "min":0 - }, - "DesiredWeightAndCapacity":{ - "type":"structure", - "required":["VariantName"], - "members":{ - "VariantName":{ - "shape":"VariantName", - "documentation":"

The name of the variant to update.

" - }, - "DesiredWeight":{ - "shape":"VariantWeight", - "documentation":"

The variant's weight.

" - }, - "DesiredInstanceCount":{ - "shape":"TaskCount", - "documentation":"

The variant's capacity.

" - }, - "ServerlessUpdateConfig":{ - "shape":"ProductionVariantServerlessUpdateConfig", - "documentation":"

Specifies the serverless update concurrency configuration for an endpoint variant.

" - } - }, - "documentation":"

Specifies weight and capacity values for a production variant.

" - }, - "DesiredWeightAndCapacityList":{ - "type":"list", - "member":{"shape":"DesiredWeightAndCapacity"}, - "min":1 - }, - "DestinationS3Uri":{ - "type":"string", - "max":512, - "min":0, - "pattern":"(https|s3)://([^/])/?(.*)" - }, - "DetachClusterNodeVolumeRequest":{ - "type":"structure", - "required":[ - "ClusterArn", - "NodeId", - "VolumeId" - ], - "members":{ - "ClusterArn":{ - "shape":"ClusterArn", - "documentation":"

The Amazon Resource Name (ARN) of your SageMaker HyperPod cluster containing the target node. Your cluster must use EKS as the orchestration and be in the InService state.

" - }, - "NodeId":{ - "shape":"ClusterNodeId", - "documentation":"

The unique identifier of the cluster node from which you want to detach the volume.

" - }, - "VolumeId":{ - "shape":"VolumeId", - "documentation":"

The unique identifier of your EBS volume that you want to detach. Your volume must be currently attached to the specified node.

" - } - } - }, - "DetachClusterNodeVolumeResponse":{ - "type":"structure", - "required":[ - "ClusterArn", - "NodeId", - "VolumeId", - "AttachTime", - "Status", - "DeviceName" - ], - "members":{ - "ClusterArn":{ - "shape":"ClusterArn", - "documentation":"

The Amazon Resource Name (ARN) of your SageMaker HyperPod cluster where the volume detachment operation was performed.

" - }, - "NodeId":{ - "shape":"ClusterNodeId", - "documentation":"

The unique identifier of the cluster node from which your volume was detached.

" - }, - "VolumeId":{ - "shape":"VolumeId", - "documentation":"

The unique identifier of your EBS volume that was detached.

" - }, - "AttachTime":{ - "shape":"Timestamp", - "documentation":"

The original timestamp when your volume was initially attached to the node.

" - }, - "Status":{ - "shape":"VolumeAttachmentStatus", - "documentation":"

The current status of your volume detachment operation.

" - }, - "DeviceName":{ - "shape":"VolumeDeviceName", - "documentation":"

The device name assigned to your attached volume on the target instance.

" - } - } - }, - "DetailedAlgorithmStatus":{ - "type":"string", - "enum":[ - "NotStarted", - "InProgress", - "Completed", - "Failed" - ] - }, - "DetailedModelPackageStatus":{ - "type":"string", - "enum":[ - "NotStarted", - "InProgress", - "Completed", - "Failed" - ] - }, - "Device":{ - "type":"structure", - "required":["DeviceName"], - "members":{ - "DeviceName":{ - "shape":"DeviceName", - "documentation":"

The name of the device.

" - }, - "Description":{ - "shape":"DeviceDescription", - "documentation":"

Description of the device.

" - }, - "IotThingName":{ - "shape":"ThingName", - "documentation":"

Amazon Web Services Internet of Things (IoT) object name.

" - } - }, - "documentation":"

Information of a particular device.

" - }, - "DeviceArn":{ - "type":"string", - "max":2048, - "min":20, - "pattern":"arn:aws[a-z\\-]*:[a-z\\-]*:[a-z\\-]*:\\d{12}:[a-z\\-]*/?[a-zA-Z_0-9+=,.@\\-_/]+" - }, - "DeviceDeploymentStatus":{ - "type":"string", - "enum":[ - "READYTODEPLOY", - "INPROGRESS", - "DEPLOYED", - "FAILED", - "STOPPING", - "STOPPED" - ] - }, - "DeviceDeploymentSummaries":{ - "type":"list", - "member":{"shape":"DeviceDeploymentSummary"} - }, - "DeviceDeploymentSummary":{ - "type":"structure", - "required":[ - "EdgeDeploymentPlanArn", - "EdgeDeploymentPlanName", - "StageName", - "DeviceName", - "DeviceArn" - ], - "members":{ - "EdgeDeploymentPlanArn":{ - "shape":"EdgeDeploymentPlanArn", - "documentation":"

The ARN of the edge deployment plan.

" - }, - "EdgeDeploymentPlanName":{ - "shape":"EntityName", - "documentation":"

The name of the edge deployment plan.

" - }, - "StageName":{ - "shape":"EntityName", - "documentation":"

The name of the stage in the edge deployment plan.

" - }, - "DeployedStageName":{ - "shape":"EntityName", - "documentation":"

The name of the deployed stage.

" - }, - "DeviceFleetName":{ - "shape":"EntityName", - "documentation":"

The name of the fleet to which the device belongs to.

" - }, - "DeviceName":{ - "shape":"DeviceName", - "documentation":"

The name of the device.

" - }, - "DeviceArn":{ - "shape":"DeviceArn", - "documentation":"

The ARN of the device.

" - }, - "DeviceDeploymentStatus":{ - "shape":"DeviceDeploymentStatus", - "documentation":"

The deployment status of the device.

" - }, - "DeviceDeploymentStatusMessage":{ - "shape":"String", - "documentation":"

The detailed error message for the deployoment status result.

" - }, - "Description":{ - "shape":"DeviceDescription", - "documentation":"

The description of the device.

" - }, - "DeploymentStartTime":{ - "shape":"Timestamp", - "documentation":"

The time when the deployment on the device started.

" - } - }, - "documentation":"

Contains information summarizing device details and deployment status.

" - }, - "DeviceDescription":{ - "type":"string", - "max":40, - "min":1, - "pattern":"[-a-zA-Z0-9_.,;:! ]*" - }, - "DeviceFleetArn":{ - "type":"string", - "pattern":"arn:aws[a-z\\-]*:iam::\\d{12}:device-fleet/?[a-zA-Z_0-9+=,.@\\-_/]+" - }, - "DeviceFleetDescription":{ - "type":"string", - "max":800, - "min":1, - "pattern":"[-a-zA-Z0-9_.,;:! ]*" - }, - "DeviceFleetSummaries":{ - "type":"list", - "member":{"shape":"DeviceFleetSummary"} - }, - "DeviceFleetSummary":{ - "type":"structure", - "required":[ - "DeviceFleetArn", - "DeviceFleetName" - ], - "members":{ - "DeviceFleetArn":{ - "shape":"DeviceFleetArn", - "documentation":"

Amazon Resource Name (ARN) of the device fleet.

" - }, - "DeviceFleetName":{ - "shape":"EntityName", - "documentation":"

Name of the device fleet.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

Timestamp of when the device fleet was created.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

Timestamp of when the device fleet was last updated.

" - } - }, - "documentation":"

Summary of the device fleet.

" - }, - "DeviceName":{ - "type":"string", - "max":63, - "min":1, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" - }, - "DeviceNames":{ - "type":"list", - "member":{"shape":"DeviceName"} - }, - "DeviceSelectionConfig":{ - "type":"structure", - "required":["DeviceSubsetType"], - "members":{ - "DeviceSubsetType":{ - "shape":"DeviceSubsetType", - "documentation":"

Type of device subsets to deploy to the current stage.

" - }, - "Percentage":{ - "shape":"Percentage", - "documentation":"

Percentage of devices in the fleet to deploy to the current stage.

", - "box":true - }, - "DeviceNames":{ - "shape":"DeviceNames", - "documentation":"

List of devices chosen to deploy.

" - }, - "DeviceNameContains":{ - "shape":"DeviceName", - "documentation":"

A filter to select devices with names containing this name.

" - } - }, - "documentation":"

Contains information about the configurations of selected devices.

" - }, - "DeviceStats":{ - "type":"structure", - "required":[ - "ConnectedDeviceCount", - "RegisteredDeviceCount" - ], - "members":{ - "ConnectedDeviceCount":{ - "shape":"Long", - "documentation":"

The number of devices connected with a heartbeat.

", - "box":true - }, - "RegisteredDeviceCount":{ - "shape":"Long", - "documentation":"

The number of registered devices.

", - "box":true - } - }, - "documentation":"

Status of devices.

" - }, - "DeviceSubsetType":{ - "type":"string", - "enum":[ - "PERCENTAGE", - "SELECTION", - "NAMECONTAINS" - ] - }, - "DeviceSummaries":{ - "type":"list", - "member":{"shape":"DeviceSummary"} - }, - "DeviceSummary":{ - "type":"structure", - "required":[ - "DeviceName", - "DeviceArn" - ], - "members":{ - "DeviceName":{ - "shape":"EntityName", - "documentation":"

The unique identifier of the device.

" - }, - "DeviceArn":{ - "shape":"DeviceArn", - "documentation":"

Amazon Resource Name (ARN) of the device.

" - }, - "Description":{ - "shape":"DeviceDescription", - "documentation":"

A description of the device.

" - }, - "DeviceFleetName":{ - "shape":"EntityName", - "documentation":"

The name of the fleet the device belongs to.

" - }, - "IotThingName":{ - "shape":"ThingName", - "documentation":"

The Amazon Web Services Internet of Things (IoT) object thing name associated with the device..

" - }, - "RegistrationTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp of the last registration or de-reregistration.

" - }, - "LatestHeartbeat":{ - "shape":"Timestamp", - "documentation":"

The last heartbeat received from the device.

" - }, - "Models":{ - "shape":"EdgeModelSummaries", - "documentation":"

Models on the device.

" - }, - "AgentVersion":{ - "shape":"EdgeVersion", - "documentation":"

Edge Manager agent version.

" - } - }, - "documentation":"

Summary of the device.

" - }, - "Devices":{ - "type":"list", - "member":{"shape":"Device"} - }, - "Dimension":{ - "type":"integer", - "box":true, - "max":8192, - "min":1 - }, - "DirectDeploySettings":{ - "type":"structure", - "members":{ - "Status":{ - "shape":"FeatureStatus", - "documentation":"

Describes whether model deployment permissions are enabled or disabled in the Canvas application.

" - } - }, - "documentation":"

The model deployment settings for the SageMaker Canvas application.

In order to enable model deployment for Canvas, the SageMaker Domain's or user profile's Amazon Web Services IAM execution role must have the AmazonSageMakerCanvasDirectDeployAccess policy attached. You can also turn on model deployment permissions through the SageMaker Domain's or user profile's settings in the SageMaker console.

" - }, - "DirectInternetAccess":{ - "type":"string", - "enum":[ - "Enabled", - "Disabled" - ] - }, - "Direction":{ - "type":"string", - "enum":[ - "Both", - "Ascendants", - "Descendants" - ] - }, - "DirectoryPath":{ - "type":"string", - "max":4096, - "min":0, - "pattern":".*" - }, - "DisableProfiler":{"type":"boolean"}, - "DisableSagemakerServicecatalogPortfolioInput":{ - "type":"structure", - "members":{} - }, - "DisableSagemakerServicecatalogPortfolioOutput":{ - "type":"structure", - "members":{} - }, - "DisassociateAdditionalCodeRepositories":{"type":"boolean"}, - "DisassociateDefaultCodeRepository":{"type":"boolean"}, - "DisassociateNotebookInstanceAcceleratorTypes":{"type":"boolean"}, - "DisassociateNotebookInstanceLifecycleConfig":{"type":"boolean"}, - "DisassociateTrialComponentRequest":{ - "type":"structure", - "required":[ - "TrialComponentName", - "TrialName" - ], - "members":{ - "TrialComponentName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the component to disassociate from the trial.

" - }, - "TrialName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the trial to disassociate from.

" - } - } - }, - "DisassociateTrialComponentResponse":{ - "type":"structure", - "members":{ - "TrialComponentArn":{ - "shape":"TrialComponentArn", - "documentation":"

The Amazon Resource Name (ARN) of the trial component.

" - }, - "TrialArn":{ - "shape":"TrialArn", - "documentation":"

The Amazon Resource Name (ARN) of the trial.

" - } - } - }, - "DockerSettings":{ - "type":"structure", - "members":{ - "EnableDockerAccess":{ - "shape":"FeatureStatus", - "documentation":"

Indicates whether the domain can access Docker.

" - }, - "VpcOnlyTrustedAccounts":{ - "shape":"VpcOnlyTrustedAccounts", - "documentation":"

The list of Amazon Web Services accounts that are trusted when the domain is created in VPC-only mode.

" - }, - "RootlessDocker":{ - "shape":"FeatureStatus", - "documentation":"

Indicates whether to use rootless Docker.

" - } - }, - "documentation":"

A collection of settings that configure the domain's Docker interaction.

" - }, - "DocumentSchemaVersion":{ - "type":"string", - "max":14, - "min":5, - "pattern":"\\d{1,4}.\\d{1,4}.\\d{1,4}" - }, - "Dollars":{ - "type":"integer", - "max":2, - "min":0 - }, - "DomainArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:domain/.*" - }, - "DomainDetails":{ - "type":"structure", - "members":{ - "DomainArn":{ - "shape":"DomainArn", - "documentation":"

The domain's Amazon Resource Name (ARN).

" - }, - "DomainId":{ - "shape":"DomainId", - "documentation":"

The domain ID.

" - }, - "DomainName":{ - "shape":"DomainName", - "documentation":"

The domain name.

" - }, - "Status":{ - "shape":"DomainStatus", - "documentation":"

The status.

" - }, - "CreationTime":{ - "shape":"CreationTime", - "documentation":"

The creation time.

" - }, - "LastModifiedTime":{ - "shape":"LastModifiedTime", - "documentation":"

The last modified time.

" - }, - "Url":{ - "shape":"String1024", - "documentation":"

The domain's URL.

" - } - }, - "documentation":"

The domain's details.

" - }, - "DomainId":{ - "type":"string", - "max":63, - "min":0, - "pattern":"d-(-*[a-z0-9]){1,61}" - }, - "DomainList":{ - "type":"list", - "member":{"shape":"DomainDetails"} - }, - "DomainName":{ - "type":"string", - "max":63, - "min":0, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" - }, - "DomainSecurityGroupIds":{ - "type":"list", - "member":{"shape":"SecurityGroupId"}, - "max":3, - "min":0 - }, - "DomainSettings":{ - "type":"structure", - "members":{ - "SecurityGroupIds":{ - "shape":"DomainSecurityGroupIds", - "documentation":"

The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

" - }, - "RStudioServerProDomainSettings":{ - "shape":"RStudioServerProDomainSettings", - "documentation":"

A collection of settings that configure the RStudioServerPro Domain-level app.

" - }, - "ExecutionRoleIdentityConfig":{ - "shape":"ExecutionRoleIdentityConfig", - "documentation":"

The configuration for attaching a SageMaker AI user profile name to the execution role as a sts:SourceIdentity key.

" - }, - "TrustedIdentityPropagationSettings":{ - "shape":"TrustedIdentityPropagationSettings", - "documentation":"

The Trusted Identity Propagation (TIP) settings for the SageMaker domain. These settings determine how user identities from IAM Identity Center are propagated through the domain to TIP enabled Amazon Web Services services.

" - }, - "DockerSettings":{ - "shape":"DockerSettings", - "documentation":"

A collection of settings that configure the domain's Docker interaction.

" - }, - "AmazonQSettings":{ - "shape":"AmazonQSettings", - "documentation":"

A collection of settings that configure the Amazon Q experience within the domain. The AuthMode that you use to create the domain must be SSO.

" - }, - "UnifiedStudioSettings":{ - "shape":"UnifiedStudioSettings", - "documentation":"

The settings that apply to an SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.

" - }, - "IpAddressType":{ - "shape":"IPAddressType", - "documentation":"

The IP address type for the domain. Specify ipv4 for IPv4-only connectivity or dualstack for both IPv4 and IPv6 connectivity. When you specify dualstack, the subnet must support IPv6 CIDR blocks. If not specified, defaults to ipv4.

" - } - }, - "documentation":"

A collection of settings that apply to the SageMaker Domain. These settings are specified through the CreateDomain API call.

" - }, - "DomainSettingsForUpdate":{ - "type":"structure", - "members":{ - "RStudioServerProDomainSettingsForUpdate":{ - "shape":"RStudioServerProDomainSettingsForUpdate", - "documentation":"

A collection of RStudioServerPro Domain-level app settings to update. A single RStudioServerPro application is created for a domain.

" - }, - "ExecutionRoleIdentityConfig":{ - "shape":"ExecutionRoleIdentityConfig", - "documentation":"

The configuration for attaching a SageMaker AI user profile name to the execution role as a sts:SourceIdentity key. This configuration can only be modified if there are no apps in the InService or Pending state.

" - }, - "SecurityGroupIds":{ - "shape":"DomainSecurityGroupIds", - "documentation":"

The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

" - }, - "TrustedIdentityPropagationSettings":{ - "shape":"TrustedIdentityPropagationSettings", - "documentation":"

The Trusted Identity Propagation (TIP) settings for the SageMaker domain. These settings determine how user identities from IAM Identity Center are propagated through the domain to TIP enabled Amazon Web Services services.

" - }, - "DockerSettings":{ - "shape":"DockerSettings", - "documentation":"

A collection of settings that configure the domain's Docker interaction.

" - }, - "AmazonQSettings":{ - "shape":"AmazonQSettings", - "documentation":"

A collection of settings that configure the Amazon Q experience within the domain.

" - }, - "UnifiedStudioSettings":{ - "shape":"UnifiedStudioSettings", - "documentation":"

The settings that apply to an SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.

" - }, - "IpAddressType":{ - "shape":"IPAddressType", - "documentation":"

The IP address type for the domain. Specify ipv4 for IPv4-only connectivity or dualstack for both IPv4 and IPv6 connectivity. When you specify dualstack, the subnet must support IPv6 CIDR blocks.

" - } - }, - "documentation":"

A collection of Domain configuration settings to update.

" - }, - "DomainStatus":{ - "type":"string", - "enum":[ - "Deleting", - "Failed", - "InService", - "Pending", - "Updating", - "Update_Failed", - "Delete_Failed" - ] - }, - "Double":{"type":"double"}, - "DoubleParameterValue":{ - "type":"double", - "box":true - }, - "DriftCheckBaselines":{ - "type":"structure", - "members":{ - "Bias":{ - "shape":"DriftCheckBias", - "documentation":"

Represents the drift check bias baselines that can be used when the model monitor is set using the model package.

" - }, - "Explainability":{ - "shape":"DriftCheckExplainability", - "documentation":"

Represents the drift check explainability baselines that can be used when the model monitor is set using the model package.

" - }, - "ModelQuality":{ - "shape":"DriftCheckModelQuality", - "documentation":"

Represents the drift check model quality baselines that can be used when the model monitor is set using the model package.

" - }, - "ModelDataQuality":{ - "shape":"DriftCheckModelDataQuality", - "documentation":"

Represents the drift check model data quality baselines that can be used when the model monitor is set using the model package.

" - } - }, - "documentation":"

Represents the drift check baselines that can be used when the model monitor is set using the model package.

" - }, - "DriftCheckBias":{ - "type":"structure", - "members":{ - "ConfigFile":{ - "shape":"FileSource", - "documentation":"

The bias config file for a model.

" - }, - "PreTrainingConstraints":{ - "shape":"MetricsSource", - "documentation":"

The pre-training constraints.

" - }, - "PostTrainingConstraints":{ - "shape":"MetricsSource", - "documentation":"

The post-training constraints.

" - } - }, - "documentation":"

Represents the drift check bias baselines that can be used when the model monitor is set using the model package.

" - }, - "DriftCheckExplainability":{ - "type":"structure", - "members":{ - "Constraints":{ - "shape":"MetricsSource", - "documentation":"

The drift check explainability constraints.

" - }, - "ConfigFile":{ - "shape":"FileSource", - "documentation":"

The explainability config file for the model.

" - } - }, - "documentation":"

Represents the drift check explainability baselines that can be used when the model monitor is set using the model package.

" - }, - "DriftCheckModelDataQuality":{ - "type":"structure", - "members":{ - "Statistics":{ - "shape":"MetricsSource", - "documentation":"

The drift check model data quality statistics.

" - }, - "Constraints":{ - "shape":"MetricsSource", - "documentation":"

The drift check model data quality constraints.

" - } - }, - "documentation":"

Represents the drift check data quality baselines that can be used when the model monitor is set using the model package.

" - }, - "DriftCheckModelQuality":{ - "type":"structure", - "members":{ - "Statistics":{ - "shape":"MetricsSource", - "documentation":"

The drift check model quality statistics.

" - }, - "Constraints":{ - "shape":"MetricsSource", - "documentation":"

The drift check model quality constraints.

" - } - }, - "documentation":"

Represents the drift check model quality baselines that can be used when the model monitor is set using the model package.

" - }, - "DynamicScalingConfiguration":{ - "type":"structure", - "members":{ - "MinCapacity":{ - "shape":"Integer", - "documentation":"

The recommended minimum capacity to specify for your autoscaling policy.

", - "box":true - }, - "MaxCapacity":{ - "shape":"Integer", - "documentation":"

The recommended maximum capacity to specify for your autoscaling policy.

", - "box":true - }, - "ScaleInCooldown":{ - "shape":"Integer", - "documentation":"

The recommended scale in cooldown time for your autoscaling policy.

", - "box":true - }, - "ScaleOutCooldown":{ - "shape":"Integer", - "documentation":"

The recommended scale out cooldown time for your autoscaling policy.

", - "box":true - }, - "ScalingPolicies":{ - "shape":"ScalingPolicies", - "documentation":"

An object of the scaling policies for each metric.

" - } - }, - "documentation":"

An object with the recommended values for you to specify when creating an autoscaling policy.

" - }, - "EFSFileSystem":{ - "type":"structure", - "required":["FileSystemId"], - "members":{ - "FileSystemId":{ - "shape":"FileSystemId", - "documentation":"

The ID of your Amazon EFS file system.

" - } - }, - "documentation":"

A file system, created by you in Amazon EFS, that you assign to a user profile or space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI Studio.

" - }, - "EFSFileSystemConfig":{ - "type":"structure", - "required":["FileSystemId"], - "members":{ - "FileSystemId":{ - "shape":"FileSystemId", - "documentation":"

The ID of your Amazon EFS file system.

" - }, - "FileSystemPath":{ - "shape":"FileSystemPath", - "documentation":"

The path to the file system directory that is accessible in Amazon SageMaker AI Studio. Permitted users can access only this directory and below.

" - } - }, - "documentation":"

The settings for assigning a custom Amazon EFS file system to a user profile or space for an Amazon SageMaker AI Domain.

" - }, - "EMRStepMetadata":{ - "type":"structure", - "members":{ - "ClusterId":{ - "shape":"String256", - "documentation":"

The identifier of the EMR cluster.

" - }, - "StepId":{ - "shape":"String256", - "documentation":"

The identifier of the EMR cluster step.

" - }, - "StepName":{ - "shape":"String256", - "documentation":"

The name of the EMR cluster step.

" - }, - "LogFilePath":{ - "shape":"String1024", - "documentation":"

The path to the log file where the cluster step's failure root cause is recorded.

" - } - }, - "documentation":"

The configurations and outcomes of an Amazon EMR step execution.

" - }, - "EbsStorageSettings":{ - "type":"structure", - "required":["EbsVolumeSizeInGb"], - "members":{ - "EbsVolumeSizeInGb":{ - "shape":"SpaceEbsVolumeSizeInGb", - "documentation":"

The size of an EBS storage volume for a space.

" - } - }, - "documentation":"

A collection of EBS storage settings that apply to both private and shared spaces.

" - }, - "Ec2CapacityReservation":{ - "type":"structure", - "members":{ - "Ec2CapacityReservationId":{ - "shape":"Ec2CapacityReservationId", - "documentation":"

The unique identifier for an EC2 capacity reservation that's part of the ML capacity reservation.

" - }, - "TotalInstanceCount":{ - "shape":"TaskCount", - "documentation":"

The number of instances that you allocated to the EC2 capacity reservation.

" - }, - "AvailableInstanceCount":{ - "shape":"TaskCount", - "documentation":"

The number of instances that are currently available in the EC2 capacity reservation.

" - }, - "UsedByCurrentEndpoint":{ - "shape":"TaskCount", - "documentation":"

The number of instances from the EC2 capacity reservation that are being used by the endpoint.

" - } - }, - "documentation":"

The EC2 capacity reservations that are shared to an ML capacity reservation.

" - }, - "Ec2CapacityReservationId":{"type":"string"}, - "Ec2CapacityReservationsList":{ - "type":"list", - "member":{"shape":"Ec2CapacityReservation"} - }, - "Edge":{ - "type":"structure", - "members":{ - "SourceArn":{ - "shape":"AssociationEntityArn", - "documentation":"

The Amazon Resource Name (ARN) of the source lineage entity of the directed edge.

" - }, - "DestinationArn":{ - "shape":"AssociationEntityArn", - "documentation":"

The Amazon Resource Name (ARN) of the destination lineage entity of the directed edge.

" - }, - "AssociationType":{ - "shape":"AssociationEdgeType", - "documentation":"

The type of the Association(Edge) between the source and destination. For example ContributedTo, Produced, or DerivedFrom.

" - } - }, - "documentation":"

A directed edge connecting two lineage entities.

" - }, - "EdgeDeploymentConfig":{ - "type":"structure", - "required":["FailureHandlingPolicy"], - "members":{ - "FailureHandlingPolicy":{ - "shape":"FailureHandlingPolicy", - "documentation":"

Toggle that determines whether to rollback to previous configuration if the current deployment fails. By default this is turned on. You may turn this off if you want to investigate the errors yourself.

" - } - }, - "documentation":"

Contains information about the configuration of a deployment.

" - }, - "EdgeDeploymentModelConfig":{ - "type":"structure", - "required":[ - "ModelHandle", - "EdgePackagingJobName" - ], - "members":{ - "ModelHandle":{ - "shape":"EntityName", - "documentation":"

The name the device application uses to reference this model.

" - }, - "EdgePackagingJobName":{ - "shape":"EntityName", - "documentation":"

The edge packaging job associated with this deployment.

" - } - }, - "documentation":"

Contains information about the configuration of a model in a deployment.

" - }, - "EdgeDeploymentModelConfigs":{ - "type":"list", - "member":{"shape":"EdgeDeploymentModelConfig"} - }, - "EdgeDeploymentPlanArn":{ - "type":"string", - "max":2048, - "min":20, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z\\-]*:\\d{12}:edge-deployment/?[a-zA-Z_0-9+=,.@\\-_/]+" - }, - "EdgeDeploymentPlanSummaries":{ - "type":"list", - "member":{"shape":"EdgeDeploymentPlanSummary"} - }, - "EdgeDeploymentPlanSummary":{ - "type":"structure", - "required":[ - "EdgeDeploymentPlanArn", - "EdgeDeploymentPlanName", - "DeviceFleetName", - "EdgeDeploymentSuccess", - "EdgeDeploymentPending", - "EdgeDeploymentFailed" - ], - "members":{ - "EdgeDeploymentPlanArn":{ - "shape":"EdgeDeploymentPlanArn", - "documentation":"

The ARN of the edge deployment plan.

" - }, - "EdgeDeploymentPlanName":{ - "shape":"EntityName", - "documentation":"

The name of the edge deployment plan.

" - }, - "DeviceFleetName":{ - "shape":"EntityName", - "documentation":"

The name of the device fleet used for the deployment.

" - }, - "EdgeDeploymentSuccess":{ - "shape":"Integer", - "documentation":"

The number of edge devices with the successful deployment.

", - "box":true - }, - "EdgeDeploymentPending":{ - "shape":"Integer", - "documentation":"

The number of edge devices yet to pick up the deployment, or in progress.

", - "box":true - }, - "EdgeDeploymentFailed":{ - "shape":"Integer", - "documentation":"

The number of edge devices that failed the deployment.

", - "box":true - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The time when the edge deployment plan was created.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The time when the edge deployment plan was last updated.

" - } - }, - "documentation":"

Contains information summarizing an edge deployment plan.

" - }, - "EdgeDeploymentStatus":{ - "type":"structure", - "required":[ - "StageStatus", - "EdgeDeploymentSuccessInStage", - "EdgeDeploymentPendingInStage", - "EdgeDeploymentFailedInStage" - ], - "members":{ - "StageStatus":{ - "shape":"StageStatus", - "documentation":"

The general status of the current stage.

" - }, - "EdgeDeploymentSuccessInStage":{ - "shape":"Integer", - "documentation":"

The number of edge devices with the successful deployment in the current stage.

", - "box":true - }, - "EdgeDeploymentPendingInStage":{ - "shape":"Integer", - "documentation":"

The number of edge devices yet to pick up the deployment in current stage, or in progress.

", - "box":true - }, - "EdgeDeploymentFailedInStage":{ - "shape":"Integer", - "documentation":"

The number of edge devices that failed the deployment in current stage.

", - "box":true - }, - "EdgeDeploymentStatusMessage":{ - "shape":"String", - "documentation":"

A detailed message about deployment status in current stage.

" - }, - "EdgeDeploymentStageStartTime":{ - "shape":"Timestamp", - "documentation":"

The time when the deployment API started.

" - } - }, - "documentation":"

Contains information summarizing the deployment stage results.

" - }, - "EdgeModel":{ - "type":"structure", - "required":[ - "ModelName", - "ModelVersion" - ], - "members":{ - "ModelName":{ - "shape":"EntityName", - "documentation":"

The name of the model.

" - }, - "ModelVersion":{ - "shape":"EdgeVersion", - "documentation":"

The model version.

" - }, - "LatestSampleTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp of the last data sample taken.

" - }, - "LatestInference":{ - "shape":"Timestamp", - "documentation":"

The timestamp of the last inference that was made.

" - } - }, - "documentation":"

The model on the edge device.

" - }, - "EdgeModelStat":{ - "type":"structure", - "required":[ - "ModelName", - "ModelVersion", - "OfflineDeviceCount", - "ConnectedDeviceCount", - "ActiveDeviceCount", - "SamplingDeviceCount" - ], - "members":{ - "ModelName":{ - "shape":"EntityName", - "documentation":"

The name of the model.

" - }, - "ModelVersion":{ - "shape":"EdgeVersion", - "documentation":"

The model version.

" - }, - "OfflineDeviceCount":{ - "shape":"Long", - "documentation":"

The number of devices that have this model version and do not have a heart beat.

", - "box":true - }, - "ConnectedDeviceCount":{ - "shape":"Long", - "documentation":"

The number of devices that have this model version and have a heart beat.

", - "box":true - }, - "ActiveDeviceCount":{ - "shape":"Long", - "documentation":"

The number of devices that have this model version, a heart beat, and are currently running.

", - "box":true - }, - "SamplingDeviceCount":{ - "shape":"Long", - "documentation":"

The number of devices with this model version and are producing sample data.

", - "box":true - } - }, - "documentation":"

Status of edge devices with this model.

" - }, - "EdgeModelStats":{ - "type":"list", - "member":{"shape":"EdgeModelStat"} - }, - "EdgeModelSummaries":{ - "type":"list", - "member":{"shape":"EdgeModelSummary"} - }, - "EdgeModelSummary":{ - "type":"structure", - "required":[ - "ModelName", - "ModelVersion" - ], - "members":{ - "ModelName":{ - "shape":"EntityName", - "documentation":"

The name of the model.

" - }, - "ModelVersion":{ - "shape":"EdgeVersion", - "documentation":"

The version model.

" - } - }, - "documentation":"

Summary of model on edge device.

" - }, - "EdgeModels":{ - "type":"list", - "member":{"shape":"EdgeModel"} - }, - "EdgeOutputConfig":{ - "type":"structure", - "required":["S3OutputLocation"], - "members":{ - "S3OutputLocation":{ - "shape":"S3Uri", - "documentation":"

The Amazon Simple Storage (S3) bucker URI.

" - }, - "KmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account.

" - }, - "PresetDeploymentType":{ - "shape":"EdgePresetDeploymentType", - "documentation":"

The deployment type SageMaker Edge Manager will create. Currently only supports Amazon Web Services IoT Greengrass Version 2 components.

" - }, - "PresetDeploymentConfig":{ - "shape":"String", - "documentation":"

The configuration used to create deployment artifacts. Specify configuration options with a JSON string. The available configuration options for each type are:

  • ComponentName (optional) - Name of the GreenGrass V2 component. If not specified, the default name generated consists of \"SagemakerEdgeManager\" and the name of your SageMaker Edge Manager packaging job.

  • ComponentDescription (optional) - Description of the component.

  • ComponentVersion (optional) - The version of the component.

    Amazon Web Services IoT Greengrass uses semantic versions for components. Semantic versions follow a major.minor.patch number system. For example, version 1.0.0 represents the first major release for a component. For more information, see the semantic version specification.

  • PlatformOS (optional) - The name of the operating system for the platform. Supported platforms include Windows and Linux.

  • PlatformArchitecture (optional) - The processor architecture for the platform.

    Supported architectures Windows include: Windows32_x86, Windows64_x64.

    Supported architectures for Linux include: Linux x86_64, Linux ARMV8.

" - } - }, - "documentation":"

The output configuration.

" - }, - "EdgePackagingJobArn":{ - "type":"string", - "max":2048, - "min":20, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z\\-]*:\\d{12}:edge-packaging-job/?[a-zA-Z_0-9+=,.@\\-_/]+" - }, - "EdgePackagingJobStatus":{ - "type":"string", - "enum":[ - "STARTING", - "INPROGRESS", - "COMPLETED", - "FAILED", - "STOPPING", - "STOPPED" - ] - }, - "EdgePackagingJobSummaries":{ - "type":"list", - "member":{"shape":"EdgePackagingJobSummary"} - }, - "EdgePackagingJobSummary":{ - "type":"structure", - "required":[ - "EdgePackagingJobArn", - "EdgePackagingJobName", - "EdgePackagingJobStatus" - ], - "members":{ - "EdgePackagingJobArn":{ - "shape":"EdgePackagingJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the edge packaging job.

" - }, - "EdgePackagingJobName":{ - "shape":"EntityName", - "documentation":"

The name of the edge packaging job.

" - }, - "EdgePackagingJobStatus":{ - "shape":"EdgePackagingJobStatus", - "documentation":"

The status of the edge packaging job.

" - }, - "CompilationJobName":{ - "shape":"EntityName", - "documentation":"

The name of the SageMaker Neo compilation job.

" - }, - "ModelName":{ - "shape":"EntityName", - "documentation":"

The name of the model.

" - }, - "ModelVersion":{ - "shape":"EdgeVersion", - "documentation":"

The version of the model.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp of when the job was created.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp of when the edge packaging job was last updated.

" - } - }, - "documentation":"

Summary of edge packaging job.

" - }, - "EdgePresetDeploymentArtifact":{ - "type":"string", - "max":2048, - "min":20 - }, - "EdgePresetDeploymentOutput":{ - "type":"structure", - "required":["Type"], - "members":{ - "Type":{ - "shape":"EdgePresetDeploymentType", - "documentation":"

The deployment type created by SageMaker Edge Manager. Currently only supports Amazon Web Services IoT Greengrass Version 2 components.

" - }, - "Artifact":{ - "shape":"EdgePresetDeploymentArtifact", - "documentation":"

The Amazon Resource Name (ARN) of the generated deployable resource.

" - }, - "Status":{ - "shape":"EdgePresetDeploymentStatus", - "documentation":"

The status of the deployable resource.

" - }, - "StatusMessage":{ - "shape":"String", - "documentation":"

Returns a message describing the status of the deployed resource.

" - } - }, - "documentation":"

The output of a SageMaker Edge Manager deployable resource.

" - }, - "EdgePresetDeploymentStatus":{ - "type":"string", - "enum":[ - "COMPLETED", - "FAILED" - ] - }, - "EdgePresetDeploymentType":{ - "type":"string", - "enum":["GreengrassV2Component"] - }, - "EdgeVersion":{ - "type":"string", - "max":30, - "min":1, - "pattern":"[a-zA-Z0-9\\ \\_\\.]+" - }, - "Edges":{ - "type":"list", - "member":{"shape":"Edge"} - }, - "EfaEnis":{ - "type":"list", - "member":{"shape":"String"} - }, - "EfsUid":{ - "type":"string", - "max":10, - "min":0, - "pattern":"\\d+" - }, - "EksClusterArn":{ - "type":"string", - "max":2048, - "min":20, - "pattern":"arn:aws[a-z\\-]*:eks:[a-z0-9\\-]*:[0-9]{12}:cluster\\/[0-9A-Za-z][A-Za-z0-9\\-_]{0,99}" - }, - "EksRoleAccessEntries":{ - "type":"list", - "member":{"shape":"String"} - }, - "EmrServerlessComputeConfig":{ - "type":"structure", - "required":["ExecutionRoleARN"], - "members":{ - "ExecutionRoleARN":{ - "shape":"RoleArn", - "documentation":"

The ARN of the IAM role granting the AutoML job V2 the necessary permissions access policies to list, connect to, or manage EMR Serverless jobs. For detailed information about the required permissions of this role, see \"How to configure AutoML to initiate a remote job on EMR Serverless for large datasets\" in Create a regression or classification job for tabular data using the AutoML API or Create an AutoML job for time-series forecasting using the API.

" - } - }, - "documentation":"

This data type is intended for use exclusively by SageMaker Canvas and cannot be used in other contexts at the moment.

Specifies the compute configuration for the EMR Serverless job.

" - }, - "EmrServerlessSettings":{ - "type":"structure", - "members":{ - "ExecutionRoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the Amazon Web Services IAM role that is assumed for running Amazon EMR Serverless jobs in SageMaker Canvas. This role should have the necessary permissions to read and write data attached and a trust relationship with EMR Serverless.

" - }, - "Status":{ - "shape":"FeatureStatus", - "documentation":"

Describes whether Amazon EMR Serverless job capabilities are enabled or disabled in the SageMaker Canvas application.

" - } - }, - "documentation":"

The settings for running Amazon EMR Serverless jobs in SageMaker Canvas.

" - }, - "EmrSettings":{ - "type":"structure", - "members":{ - "AssumableRoleArns":{ - "shape":"AssumableRoleArns", - "documentation":"

An array of Amazon Resource Names (ARNs) of the IAM roles that the execution role of SageMaker can assume for performing operations or tasks related to Amazon EMR clusters or Amazon EMR Serverless applications. These roles define the permissions and access policies required when performing Amazon EMR-related operations, such as listing, connecting to, or terminating Amazon EMR clusters or Amazon EMR Serverless applications. They are typically used in cross-account access scenarios, where the Amazon EMR resources (clusters or serverless applications) are located in a different Amazon Web Services account than the SageMaker domain.

" - }, - "ExecutionRoleArns":{ - "shape":"ExecutionRoleArns", - "documentation":"

An array of Amazon Resource Names (ARNs) of the IAM roles used by the Amazon EMR cluster instances or job execution environments to access other Amazon Web Services services and resources needed during the runtime of your Amazon EMR or Amazon EMR Serverless workloads, such as Amazon S3 for data access, Amazon CloudWatch for logging, or other Amazon Web Services services based on the particular workload requirements.

" - } - }, - "documentation":"

The configuration parameters that specify the IAM roles assumed by the execution role of SageMaker (assumable roles) and the cluster instances or job execution environments (execution roles or runtime roles) to manage and access resources required for running Amazon EMR clusters or Amazon EMR Serverless applications.

" - }, - "EnableCaching":{"type":"boolean"}, - "EnableCapture":{"type":"boolean"}, - "EnableDetailedObservability":{ - "type":"boolean", - "box":true - }, - "EnableEnhancedMetrics":{ - "type":"boolean", - "box":true - }, - "EnableInfraCheck":{ - "type":"boolean", - "box":true - }, - "EnableIotRoleAlias":{ - "type":"boolean", - "box":true - }, - "EnableRemoteDebug":{ - "type":"boolean", - "box":true - }, - "EnableSagemakerServicecatalogPortfolioInput":{ - "type":"structure", - "members":{} - }, - "EnableSagemakerServicecatalogPortfolioOutput":{ - "type":"structure", - "members":{} - }, - "EnableSessionTagChaining":{ - "type":"boolean", - "box":true - }, - "EnabledOrDisabled":{ - "type":"string", - "enum":[ - "Enabled", - "Disabled" - ] - }, - "Endpoint":{ - "type":"structure", - "required":[ - "EndpointName", - "EndpointArn", - "EndpointConfigName", - "EndpointStatus", - "CreationTime", - "LastModifiedTime" - ], - "members":{ - "EndpointName":{ - "shape":"EndpointName", - "documentation":"

The name of the endpoint.

" - }, - "EndpointArn":{ - "shape":"EndpointArn", - "documentation":"

The Amazon Resource Name (ARN) of the endpoint.

" - }, - "EndpointConfigName":{ - "shape":"EndpointConfigName", - "documentation":"

The endpoint configuration associated with the endpoint.

" - }, - "ProductionVariants":{ - "shape":"ProductionVariantSummaryList", - "documentation":"

A list of the production variants hosted on the endpoint. Each production variant is a model.

" - }, - "DataCaptureConfig":{"shape":"DataCaptureConfigSummary"}, - "EndpointStatus":{ - "shape":"EndpointStatus", - "documentation":"

The status of the endpoint.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

If the endpoint failed, the reason it failed.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The time that the endpoint was created.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The last time the endpoint was modified.

" - }, - "MonitoringSchedules":{ - "shape":"MonitoringScheduleList", - "documentation":"

A list of monitoring schedules for the endpoint. For information about model monitoring, see Amazon SageMaker Model Monitor.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

A list of the tags associated with the endpoint. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

" - }, - "ShadowProductionVariants":{ - "shape":"ProductionVariantSummaryList", - "documentation":"

A list of the shadow variants hosted on the endpoint. Each shadow variant is a model in shadow mode with production traffic replicated from the production variant.

" - } - }, - "documentation":"

A hosted endpoint for real-time inference.

" - }, - "EndpointArn":{ - "type":"string", - "max":2048, - "min":20, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:endpoint/.*" - }, - "EndpointConfigArn":{ - "type":"string", - "max":2048, - "min":20, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:endpoint-config/.*" - }, - "EndpointConfigName":{ - "type":"string", - "max":63, - "min":0, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" - }, - "EndpointConfigNameContains":{ - "type":"string", - "max":63, - "min":0, - "pattern":"[a-zA-Z0-9-]+" - }, - "EndpointConfigSortKey":{ - "type":"string", - "enum":[ - "Name", - "CreationTime" - ] - }, - "EndpointConfigStepMetadata":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"EndpointConfigArn", - "documentation":"

The Amazon Resource Name (ARN) of the endpoint configuration used in the step.

" - } - }, - "documentation":"

Metadata for an endpoint configuration step.

" - }, - "EndpointConfigSummary":{ - "type":"structure", - "required":[ - "EndpointConfigName", - "EndpointConfigArn", - "CreationTime" - ], - "members":{ - "EndpointConfigName":{ - "shape":"EndpointConfigName", - "documentation":"

The name of the endpoint configuration.

" - }, - "EndpointConfigArn":{ - "shape":"EndpointConfigArn", - "documentation":"

The Amazon Resource Name (ARN) of the endpoint configuration.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that shows when the endpoint configuration was created.

" - } - }, - "documentation":"

Provides summary information for an endpoint configuration.

" - }, - "EndpointConfigSummaryList":{ - "type":"list", - "member":{"shape":"EndpointConfigSummary"} - }, - "EndpointInfo":{ - "type":"structure", - "members":{ - "EndpointName":{ - "shape":"EndpointName", - "documentation":"

The name of a customer's endpoint.

" - } - }, - "documentation":"

Details about a customer endpoint that was compared in an Inference Recommender job.

" - }, - "EndpointInput":{ - "type":"structure", - "required":[ - "EndpointName", - "LocalPath" - ], - "members":{ - "EndpointName":{ - "shape":"EndpointName", - "documentation":"

An endpoint in customer's account which has enabled DataCaptureConfig enabled.

" - }, - "LocalPath":{ - "shape":"ProcessingLocalPath", - "documentation":"

Path to the filesystem where the endpoint data is available to the container.

" - }, - "S3InputMode":{ - "shape":"ProcessingS3InputMode", - "documentation":"

Whether the Pipe or File is used as the input mode for transferring data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File.

" - }, - "S3DataDistributionType":{ - "shape":"ProcessingS3DataDistributionType", - "documentation":"

Whether input data distributed in Amazon S3 is fully replicated or sharded by an Amazon S3 key. Defaults to FullyReplicated

" - }, - "FeaturesAttribute":{ - "shape":"String", - "documentation":"

The attributes of the input data that are the input features.

" - }, - "InferenceAttribute":{ - "shape":"String", - "documentation":"

The attribute of the input data that represents the ground truth label.

" - }, - "ProbabilityAttribute":{ - "shape":"String", - "documentation":"

In a classification problem, the attribute that represents the class probability.

" - }, - "ProbabilityThresholdAttribute":{ - "shape":"ProbabilityThresholdAttribute", - "documentation":"

The threshold for the class probability to be evaluated as a positive result.

" - }, - "StartTimeOffset":{ - "shape":"MonitoringTimeOffsetString", - "documentation":"

If specified, monitoring jobs substract this time from the start time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.

" - }, - "EndTimeOffset":{ - "shape":"MonitoringTimeOffsetString", - "documentation":"

If specified, monitoring jobs substract this time from the end time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.

" - }, - "ExcludeFeaturesAttribute":{ - "shape":"ExcludeFeaturesAttribute", - "documentation":"

The attributes of the input data to exclude from the analysis.

" - } - }, - "documentation":"

Input object for the endpoint

" - }, - "EndpointInputConfiguration":{ - "type":"structure", - "members":{ - "InstanceType":{ - "shape":"ProductionVariantInstanceType", - "documentation":"

The instance types to use for the load test.

" - }, - "ServerlessConfig":{"shape":"ProductionVariantServerlessConfig"}, - "InferenceSpecificationName":{ - "shape":"InferenceSpecificationName", - "documentation":"

The inference specification name in the model package version.

" - }, - "EnvironmentParameterRanges":{ - "shape":"EnvironmentParameterRanges", - "documentation":"

The parameter you want to benchmark against.

" - } - }, - "documentation":"

The endpoint configuration for the load test.

" - }, - "EndpointInputConfigurations":{ - "type":"list", - "member":{"shape":"EndpointInputConfiguration"}, - "max":10, - "min":1 - }, - "EndpointMetadata":{ - "type":"structure", - "required":["EndpointName"], - "members":{ - "EndpointName":{ - "shape":"EndpointName", - "documentation":"

The name of the endpoint.

" - }, - "EndpointConfigName":{ - "shape":"EndpointConfigName", - "documentation":"

The name of the endpoint configuration.

" - }, - "EndpointStatus":{ - "shape":"EndpointStatus", - "documentation":"

The status of the endpoint. For possible values of the status of an endpoint, see EndpointSummary.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

If the status of the endpoint is Failed, or the status is InService but update operation fails, this provides the reason why it failed.

" - } - }, - "documentation":"

The metadata of the endpoint.

" - }, - "EndpointName":{ - "type":"string", - "max":63, - "min":0, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" - }, - "EndpointNameContains":{ - "type":"string", - "max":63, - "min":0, - "pattern":"[a-zA-Z0-9-]+" - }, - "EndpointOutputConfiguration":{ - "type":"structure", - "required":[ - "EndpointName", - "VariantName" - ], - "members":{ - "EndpointName":{ - "shape":"String", - "documentation":"

The name of the endpoint made during a recommendation job.

" - }, - "VariantName":{ - "shape":"String", - "documentation":"

The name of the production variant (deployed model) made during a recommendation job.

" - }, - "InstanceType":{ - "shape":"ProductionVariantInstanceType", - "documentation":"

The instance type recommended by Amazon SageMaker Inference Recommender.

" - }, - "InitialInstanceCount":{ - "shape":"InitialInstanceCount", - "documentation":"

The number of instances recommended to launch initially.

" - }, - "ServerlessConfig":{"shape":"ProductionVariantServerlessConfig"} - }, - "documentation":"

The endpoint configuration made by Inference Recommender during a recommendation job.

" - }, - "EndpointPerformance":{ - "type":"structure", - "required":[ - "Metrics", - "EndpointInfo" - ], - "members":{ - "Metrics":{ - "shape":"InferenceMetrics", - "documentation":"

The metrics for an existing endpoint.

" - }, - "EndpointInfo":{"shape":"EndpointInfo"} - }, - "documentation":"

The performance results from running an Inference Recommender job on an existing endpoint.

" - }, - "EndpointPerformances":{ - "type":"list", - "member":{"shape":"EndpointPerformance"}, - "max":1, - "min":0 - }, - "EndpointSortKey":{ - "type":"string", - "enum":[ - "Name", - "CreationTime", - "Status" - ] - }, - "EndpointStatus":{ - "type":"string", - "enum":[ - "OutOfService", - "Creating", - "Updating", - "SystemUpdating", - "RollingBack", - "InService", - "Deleting", - "Failed", - "UpdateRollbackFailed" - ] - }, - "EndpointStepMetadata":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"EndpointArn", - "documentation":"

The Amazon Resource Name (ARN) of the endpoint in the step.

" - } - }, - "documentation":"

Metadata for an endpoint step.

" - }, - "EndpointSummary":{ - "type":"structure", - "required":[ - "EndpointName", - "EndpointArn", - "CreationTime", - "LastModifiedTime", - "EndpointStatus" - ], - "members":{ - "EndpointName":{ - "shape":"EndpointName", - "documentation":"

The name of the endpoint.

" - }, - "EndpointArn":{ - "shape":"EndpointArn", - "documentation":"

The Amazon Resource Name (ARN) of the endpoint.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that shows when the endpoint was created.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that shows when the endpoint was last modified.

" - }, - "EndpointStatus":{ - "shape":"EndpointStatus", - "documentation":"

The status of the endpoint.

  • OutOfService: Endpoint is not available to take incoming requests.

  • Creating: CreateEndpoint is executing.

  • Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

  • SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count.

  • RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an InService status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly.

  • InService: Endpoint is available to process incoming requests.

  • Deleting: DeleteEndpoint is executing.

  • Failed: Endpoint could not be created, updated, or re-scaled. Use DescribeEndpointOutput$FailureReason for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.

To get a list of endpoints with a specified status, use the StatusEquals filter with a call to ListEndpoints.

" - } - }, - "documentation":"

Provides summary information for an endpoint.

" - }, - "EndpointSummaryList":{ - "type":"list", - "member":{"shape":"EndpointSummary"} - }, - "Endpoints":{ - "type":"list", - "member":{"shape":"EndpointInfo"}, - "max":1, - "min":0 - }, - "EntityDescription":{ - "type":"string", - "max":1024, - "min":0, - "pattern":"[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*" - }, - "EntityName":{ - "type":"string", - "max":63, - "min":1, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" - }, - "EnvironmentConfig":{ - "type":"structure", - "members":{ - "FSxLustreConfig":{ - "shape":"FSxLustreConfig", - "documentation":"

Configuration settings for an Amazon FSx for Lustre file system to be used with the cluster.

" - } - }, - "documentation":"

The configuration for the restricted instance groups (RIG) environment.

" - }, - "EnvironmentConfigDetails":{ - "type":"structure", - "members":{ - "FSxLustreConfig":{ - "shape":"FSxLustreConfig", - "documentation":"

Configuration settings for an Amazon FSx for Lustre file system to be used with the cluster.

" - }, - "S3OutputPath":{ - "shape":"S3Uri", - "documentation":"

The Amazon S3 path where output data from the restricted instance group (RIG) environment will be stored.

" - } - }, - "documentation":"

The configuration details for the restricted instance groups (RIG) environment.

" - }, - "EnvironmentKey":{ - "type":"string", - "max":1024, - "min":0, - "pattern":"[a-zA-Z_][a-zA-Z0-9_]*" - }, - "EnvironmentMap":{ - "type":"map", - "key":{"shape":"EnvironmentKey"}, - "value":{"shape":"EnvironmentValue"}, - "max":100, - "min":0 - }, - "EnvironmentParameter":{ - "type":"structure", - "required":[ - "Key", - "ValueType", - "Value" - ], - "members":{ - "Key":{ - "shape":"String", - "documentation":"

The environment key suggested by the Amazon SageMaker Inference Recommender.

" - }, - "ValueType":{ - "shape":"String", - "documentation":"

The value type suggested by the Amazon SageMaker Inference Recommender.

" - }, - "Value":{ - "shape":"String", - "documentation":"

The value suggested by the Amazon SageMaker Inference Recommender.

" - } - }, - "documentation":"

A list of environment parameters suggested by the Amazon SageMaker Inference Recommender.

" - }, - "EnvironmentParameterRanges":{ - "type":"structure", - "members":{ - "CategoricalParameterRanges":{ - "shape":"CategoricalParameters", - "documentation":"

Specified a list of parameters for each category.

" - } - }, - "documentation":"

Specifies the range of environment parameters

" - }, - "EnvironmentParameters":{ - "type":"list", - "member":{"shape":"EnvironmentParameter"}, - "max":10, - "min":1 - }, - "EnvironmentValue":{ - "type":"string", - "max":1024, - "min":0, - "pattern":"[\\S\\s]*" - }, - "ErrorInfo":{ - "type":"structure", - "members":{ - "Code":{ - "shape":"NonEmptyString64", - "documentation":"

The error code for an invalid or failed operation.

" - }, - "Reason":{ - "shape":"NonEmptyString256", - "documentation":"

The failure reason for the operation.

" - } - }, - "documentation":"

This is an error field object that contains the error code and the reason for an operation failure.

" - }, - "EvaluationType":{ - "type":"string", - "enum":[ - "LLMAJEvaluation", - "CustomScorerEvaluation", - "BenchmarkEvaluation" - ] - }, - "EvaluatorArn":{ - "type":"string", - "pattern":".*" - }, - "EventDetails":{ - "type":"structure", - "members":{ - "EventMetadata":{ - "shape":"EventMetadata", - "documentation":"

Metadata specific to the event, which may include information about the cluster, instance group, or instance involved.

" - } - }, - "documentation":"

Detailed information about a specific event, including event metadata.

" - }, - "EventId":{ - "type":"string", - "pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" - }, - "EventMetadata":{ - "type":"structure", - "members":{ - "Cluster":{ - "shape":"ClusterMetadata", - "documentation":"

Metadata specific to cluster-level events.

" - }, - "InstanceGroup":{ - "shape":"InstanceGroupMetadata", - "documentation":"

Metadata specific to instance group-level events.

" - }, - "InstanceGroupScaling":{ - "shape":"InstanceGroupScalingMetadata", - "documentation":"

Metadata related to instance group scaling events.

" - }, - "Instance":{ - "shape":"InstanceMetadata", - "documentation":"

Metadata specific to instance-level events.

" - } - }, - "documentation":"

Metadata associated with a cluster event, which may include details about various resource types.

", - "union":true - }, - "EventSortBy":{ - "type":"string", - "enum":["EventTime"] - }, - "ExcludeFeaturesAttribute":{ - "type":"string", - "max":100, - "min":0 - }, - "ExecutionRoleArns":{ - "type":"list", - "member":{"shape":"RoleArn"}, - "max":5, - "min":0 - }, - "ExecutionRoleIdentityConfig":{ - "type":"string", - "enum":[ - "USER_PROFILE_NAME", - "DISABLED" - ] - }, - "ExecutionRoleSessionNameMode":{ - "type":"string", - "enum":[ - "STATIC", - "USER_IDENTITY" - ] - }, - "ExecutionStatus":{ - "type":"string", - "enum":[ - "Pending", - "Completed", - "CompletedWithViolations", - "InProgress", - "Failed", - "Stopping", - "Stopped" - ] - }, - "ExitMessage":{ - "type":"string", - "max":1024, - "min":0, - "pattern":"[\\S\\s]*" - }, - "ExpectedPerformanceList":{ - "type":"list", - "member":{"shape":"AIRecommendationPerformanceMetric"} - }, - "Experiment":{ - "type":"structure", - "members":{ - "ExperimentName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the experiment.

" - }, - "ExperimentArn":{ - "shape":"ExperimentArn", - "documentation":"

The Amazon Resource Name (ARN) of the experiment.

" - }, - "DisplayName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the experiment as displayed. If DisplayName isn't specified, ExperimentName is displayed.

" - }, - "Source":{"shape":"ExperimentSource"}, - "Description":{ - "shape":"ExperimentDescription", - "documentation":"

The description of the experiment.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

When the experiment was created.

" - }, - "CreatedBy":{ - "shape":"UserContext", - "documentation":"

Who created the experiment.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

When the experiment was last modified.

" - }, - "LastModifiedBy":{"shape":"UserContext"}, - "Tags":{ - "shape":"TagList", - "documentation":"

The list of tags that are associated with the experiment. You can use Search API to search on the tags.

" - } - }, - "documentation":"

The properties of an experiment as returned by the Search API. For information about experiments, see the CreateExperiment API.

" - }, - "ExperimentArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:experiment/.*" - }, - "ExperimentConfig":{ - "type":"structure", - "members":{ - "ExperimentName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of an existing experiment to associate with the trial component.

" - }, - "TrialName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of an existing trial to associate the trial component with. If not specified, a new trial is created.

" - }, - "TrialComponentDisplayName":{ - "shape":"ExperimentEntityName", - "documentation":"

The display name for the trial component. If this key isn't specified, the display name is the trial component name.

" - }, - "RunName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the experiment run to associate with the trial component.

" - } - }, - "documentation":"

Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs:

" - }, - "ExperimentDescription":{ - "type":"string", - "max":3072, - "min":0, - "pattern":".*" - }, - "ExperimentEntityName":{ - "type":"string", - "max":120, - "min":1, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}" - }, - "ExperimentEntityNameOrArn":{ - "type":"string", - "max":256, - "min":1, - "pattern":"(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:(experiment|experiment-trial|experiment-trial-component|artifact|action|context)\\/)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,119})" - }, - "ExperimentSource":{ - "type":"structure", - "required":["SourceArn"], - "members":{ - "SourceArn":{ - "shape":"ExperimentSourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the source.

" - }, - "SourceType":{ - "shape":"SourceType", - "documentation":"

The source type.

" - } - }, - "documentation":"

The source of the experiment.

" - }, - "ExperimentSourceArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:.*" - }, - "ExperimentSummaries":{ - "type":"list", - "member":{"shape":"ExperimentSummary"} - }, - "ExperimentSummary":{ - "type":"structure", - "members":{ - "ExperimentArn":{ - "shape":"ExperimentArn", - "documentation":"

The Amazon Resource Name (ARN) of the experiment.

" - }, - "ExperimentName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the experiment.

" - }, - "DisplayName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the experiment as displayed. If DisplayName isn't specified, ExperimentName is displayed.

" - }, - "ExperimentSource":{"shape":"ExperimentSource"}, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

When the experiment was created.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

When the experiment was last modified.

" - } - }, - "documentation":"

A summary of the properties of an experiment. To get the complete set of properties, call the DescribeExperiment API and provide the ExperimentName.

" - }, - "ExpiresInSeconds":{ - "type":"integer", - "box":true, - "max":300, - "min":5 - }, - "Explainability":{ - "type":"structure", - "members":{ - "Report":{ - "shape":"MetricsSource", - "documentation":"

The explainability report for a model.

" - } - }, - "documentation":"

Contains explainability metrics for a model.

" - }, - "ExplainabilityLocation":{ - "type":"string", - "min":1 - }, - "ExplainerConfig":{ - "type":"structure", - "members":{ - "ClarifyExplainerConfig":{ - "shape":"ClarifyExplainerConfig", - "documentation":"

A member of ExplainerConfig that contains configuration parameters for the SageMaker Clarify explainer.

" - } - }, - "documentation":"

A parameter to activate explainers.

" - }, - "ExtendTrainingPlanRequest":{ - "type":"structure", - "required":["TrainingPlanExtensionOfferingId"], - "members":{ - "TrainingPlanExtensionOfferingId":{ - "shape":"TrainingPlanExtensionOfferingId", - "documentation":"

The unique identifier of the extension offering to purchase. You can retrieve this ID from the TrainingPlanExtensionOfferings in the response of the SearchTrainingPlanOfferings API.

" - } - } - }, - "ExtendTrainingPlanResponse":{ - "type":"structure", - "required":["TrainingPlanExtensions"], - "members":{ - "TrainingPlanExtensions":{ - "shape":"TrainingPlanExtensions", - "documentation":"

The list of extensions for the training plan, including the newly created extension.

" - } - } - }, - "FSxLustreConfig":{ - "type":"structure", - "required":[ - "SizeInGiB", - "PerUnitStorageThroughput" - ], - "members":{ - "SizeInGiB":{ - "shape":"FSxLustreSizeInGiB", - "documentation":"

The storage capacity of the Amazon FSx for Lustre file system, specified in gibibytes (GiB).

" - }, - "PerUnitStorageThroughput":{ - "shape":"FSxLustrePerUnitStorageThroughput", - "documentation":"

The throughput capacity of the Amazon FSx for Lustre file system, measured in MB/s per TiB of storage.

" - } - }, - "documentation":"

Configuration settings for an Amazon FSx for Lustre file system to be used with the cluster.

" - }, - "FSxLustreFileSystem":{ - "type":"structure", - "required":["FileSystemId"], - "members":{ - "FileSystemId":{ - "shape":"FileSystemId", - "documentation":"

Amazon FSx for Lustre file system ID.

" - } - }, - "documentation":"

A custom file system in Amazon FSx for Lustre.

" - }, - "FSxLustreFileSystemConfig":{ - "type":"structure", - "required":["FileSystemId"], - "members":{ - "FileSystemId":{ - "shape":"FileSystemId", - "documentation":"

The globally unique, 17-digit, ID of the file system, assigned by Amazon FSx for Lustre.

" - }, - "FileSystemPath":{ - "shape":"FileSystemPath", - "documentation":"

The path to the file system directory that is accessible in Amazon SageMaker Studio. Permitted users can access only this directory and below.

" - } - }, - "documentation":"

The settings for assigning a custom Amazon FSx for Lustre file system to a user profile or space for an Amazon SageMaker Domain.

" - }, - "FSxLustrePerUnitStorageThroughput":{ - "type":"integer", - "box":true, - "max":1000, - "min":125 - }, - "FSxLustreSizeInGiB":{ - "type":"integer", - "box":true, - "max":100800, - "min":1200 - }, - "FailStepMetadata":{ - "type":"structure", - "members":{ - "ErrorMessage":{ - "shape":"String3072", - "documentation":"

A message that you define and then is processed and rendered by the Fail step when the error occurs.

" - } - }, - "documentation":"

The container for the metadata for Fail step.

" - }, - "FailureHandlingPolicy":{ - "type":"string", - "enum":[ - "ROLLBACK_ON_FAILURE", - "DO_NOTHING" - ] - }, - "FailureReason":{ - "type":"string", - "max":1024, - "min":0 - }, - "FairShare":{ - "type":"string", - "enum":[ - "Enabled", - "Disabled" - ] - }, - "FairShareWeight":{ - "type":"integer", - "box":true, - "max":100, - "min":0 - }, - "FeatureAdditions":{ - "type":"list", - "member":{"shape":"FeatureDefinition"}, - "max":100, - "min":1 - }, - "FeatureDefinition":{ - "type":"structure", - "required":[ - "FeatureName", - "FeatureType" - ], - "members":{ - "FeatureName":{ - "shape":"FeatureName", - "documentation":"

The name of a feature. The type must be a string. FeatureName cannot be any of the following: is_deleted, write_time, api_invocation_time.

The name:

  • Must start with an alphanumeric character.

  • Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed.

" - }, - "FeatureType":{ - "shape":"FeatureType", - "documentation":"

The value type of a feature. Valid values are Integral, Fractional, or String.

" - }, - "CollectionType":{ - "shape":"CollectionType", - "documentation":"

A grouping of elements where each element within the collection must have the same feature type (String, Integral, or Fractional).

  • List: An ordered collection of elements.

  • Set: An unordered collection of unique elements.

  • Vector: A specialized list that represents a fixed-size array of elements. The vector dimension is determined by you. Must have elements with fractional feature types.

" - }, - "CollectionConfig":{ - "shape":"CollectionConfig", - "documentation":"

Configuration for your collection.

" - } - }, - "documentation":"

A list of features. You must include FeatureName and FeatureType. Valid feature FeatureTypes are Integral, Fractional and String.

" - }, - "FeatureDefinitions":{ - "type":"list", - "member":{"shape":"FeatureDefinition"}, - "max":2500, - "min":1 - }, - "FeatureDescription":{ - "type":"string", - "max":255, - "min":0, - "pattern":".*" - }, - "FeatureGroup":{ - "type":"structure", - "members":{ - "FeatureGroupArn":{ - "shape":"FeatureGroupArn", - "documentation":"

The Amazon Resource Name (ARN) of a FeatureGroup.

" - }, - "FeatureGroupName":{ - "shape":"FeatureGroupName", - "documentation":"

The name of the FeatureGroup.

" - }, - "RecordIdentifierFeatureName":{ - "shape":"FeatureName", - "documentation":"

The name of the Feature whose value uniquely identifies a Record defined in the FeatureGroup FeatureDefinitions.

" - }, - "EventTimeFeatureName":{ - "shape":"FeatureName", - "documentation":"

The name of the feature that stores the EventTime of a Record in a FeatureGroup.

A EventTime is point in time when a new event occurs that corresponds to the creation or update of a Record in FeatureGroup. All Records in the FeatureGroup must have a corresponding EventTime.

" - }, - "FeatureDefinitions":{ - "shape":"FeatureDefinitions", - "documentation":"

A list of Features. Each Feature must include a FeatureName and a FeatureType.

Valid FeatureTypes are Integral, Fractional and String.

FeatureNames cannot be any of the following: is_deleted, write_time, api_invocation_time.

You can create up to 2,500 FeatureDefinitions per FeatureGroup.

" - }, - "CreationTime":{ - "shape":"CreationTime", - "documentation":"

The time a FeatureGroup was created.

" - }, - "LastModifiedTime":{ - "shape":"LastModifiedTime", - "documentation":"

A timestamp indicating the last time you updated the feature group.

" - }, - "OnlineStoreConfig":{"shape":"OnlineStoreConfig"}, - "OfflineStoreConfig":{"shape":"OfflineStoreConfig"}, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.

" - }, - "FeatureGroupStatus":{ - "shape":"FeatureGroupStatus", - "documentation":"

A FeatureGroup status.

" - }, - "OfflineStoreStatus":{"shape":"OfflineStoreStatus"}, - "LastUpdateStatus":{ - "shape":"LastUpdateStatus", - "documentation":"

A value that indicates whether the feature group was updated successfully.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

The reason that the FeatureGroup failed to be replicated in the OfflineStore. This is failure may be due to a failure to create a FeatureGroup in or delete a FeatureGroup from the OfflineStore.

" - }, - "Description":{ - "shape":"Description", - "documentation":"

A free form description of a FeatureGroup.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

Tags used to define a FeatureGroup.

" - } - }, - "documentation":"

Amazon SageMaker Feature Store stores features in a collection called Feature Group. A Feature Group can be visualized as a table which has rows, with a unique identifier for each row where each column in the table is a feature. In principle, a Feature Group is composed of features and values per features.

" - }, - "FeatureGroupArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:feature-group/.*" - }, - "FeatureGroupMaxResults":{ - "type":"integer", - "box":true, - "max":100, - "min":1 - }, - "FeatureGroupName":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[a-zA-Z0-9]([_-]*[a-zA-Z0-9]){0,63}" - }, - "FeatureGroupNameContains":{ - "type":"string", - "max":64, - "min":1 - }, - "FeatureGroupNameOrArn":{ - "type":"string", - "max":256, - "min":1, - "pattern":"(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:feature-group\\/)?([a-zA-Z0-9]([_-]*[a-zA-Z0-9]){0,63})" - }, - "FeatureGroupSortBy":{ - "type":"string", - "enum":[ - "Name", - "FeatureGroupStatus", - "OfflineStoreStatus", - "CreationTime" - ] - }, - "FeatureGroupSortOrder":{ - "type":"string", - "enum":[ - "Ascending", - "Descending" - ] - }, - "FeatureGroupStatus":{ - "type":"string", - "enum":[ - "Creating", - "Created", - "CreateFailed", - "Deleting", - "DeleteFailed" - ] - }, - "FeatureGroupSummaries":{ - "type":"list", - "member":{"shape":"FeatureGroupSummary"} - }, - "FeatureGroupSummary":{ - "type":"structure", - "required":[ - "FeatureGroupName", - "FeatureGroupArn", - "CreationTime" - ], - "members":{ - "FeatureGroupName":{ - "shape":"FeatureGroupName", - "documentation":"

The name of FeatureGroup.

" - }, - "FeatureGroupArn":{ - "shape":"FeatureGroupArn", - "documentation":"

Unique identifier for the FeatureGroup.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp indicating the time of creation time of the FeatureGroup.

" - }, - "FeatureGroupStatus":{ - "shape":"FeatureGroupStatus", - "documentation":"

The status of a FeatureGroup. The status can be any of the following: Creating, Created, CreateFail, Deleting or DetailFail.

" - }, - "OfflineStoreStatus":{ - "shape":"OfflineStoreStatus", - "documentation":"

Notifies you if replicating data into the OfflineStore has failed. Returns either: Active or Blocked.

" - } - }, - "documentation":"

The name, ARN, CreationTime, FeatureGroup values, LastUpdatedTime and EnableOnlineStorage status of a FeatureGroup.

" - }, - "FeatureMetadata":{ - "type":"structure", - "members":{ - "FeatureGroupArn":{ - "shape":"FeatureGroupArn", - "documentation":"

The Amazon Resource Number (ARN) of the feature group.

" - }, - "FeatureGroupName":{ - "shape":"FeatureGroupName", - "documentation":"

The name of the feature group containing the feature.

" - }, - "FeatureName":{ - "shape":"FeatureName", - "documentation":"

The name of feature.

" - }, - "FeatureType":{ - "shape":"FeatureType", - "documentation":"

The data type of the feature.

" - }, - "CreationTime":{ - "shape":"CreationTime", - "documentation":"

A timestamp indicating when the feature was created.

" - }, - "LastModifiedTime":{ - "shape":"LastModifiedTime", - "documentation":"

A timestamp indicating when the feature was last modified.

" - }, - "Description":{ - "shape":"FeatureDescription", - "documentation":"

An optional description that you specify to better describe the feature.

" - }, - "Parameters":{ - "shape":"FeatureParameters", - "documentation":"

Optional key-value pairs that you specify to better describe the feature.

" - } - }, - "documentation":"

The metadata for a feature. It can either be metadata that you specify, or metadata that is updated automatically.

" - }, - "FeatureName":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63}" - }, - "FeatureParameter":{ - "type":"structure", - "members":{ - "Key":{ - "shape":"FeatureParameterKey", - "documentation":"

A key that must contain a value to describe the feature.

" - }, - "Value":{ - "shape":"FeatureParameterValue", - "documentation":"

The value that belongs to a key.

" - } - }, - "documentation":"

A key-value pair that you specify to describe the feature.

" - }, - "FeatureParameterAdditions":{ - "type":"list", - "member":{"shape":"FeatureParameter"}, - "max":25, - "min":0 - }, - "FeatureParameterKey":{ - "type":"string", - "max":255, - "min":1, - "pattern":"([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)" - }, - "FeatureParameterRemovals":{ - "type":"list", - "member":{"shape":"FeatureParameterKey"}, - "max":25, - "min":0 - }, - "FeatureParameterValue":{ - "type":"string", - "max":255, - "min":1, - "pattern":"([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)" - }, - "FeatureParameters":{ - "type":"list", - "member":{"shape":"FeatureParameter"}, - "max":25, - "min":0 - }, - "FeatureStatus":{ - "type":"string", - "enum":[ - "ENABLED", - "DISABLED" - ] - }, - "FeatureType":{ - "type":"string", - "enum":[ - "Integral", - "Fractional", - "String" - ] - }, - "FileSource":{ - "type":"structure", - "required":["S3Uri"], - "members":{ - "ContentType":{ - "shape":"ContentType", - "documentation":"

The type of content stored in the file source.

" - }, - "ContentDigest":{ - "shape":"ContentDigest", - "documentation":"

The digest of the file source.

" - }, - "S3Uri":{ - "shape":"S3Uri", - "documentation":"

The Amazon S3 URI for the file source.

" - } - }, - "documentation":"

Contains details regarding the file source.

" - }, - "FileSystemAccessMode":{ - "type":"string", - "enum":[ - "rw", - "ro" - ] - }, - "FileSystemConfig":{ - "type":"structure", - "members":{ - "MountPath":{ - "shape":"MountPath", - "documentation":"

The path within the image to mount the user's EFS home directory. The directory should be empty. If not specified, defaults to /home/sagemaker-user.

" - }, - "DefaultUid":{ - "shape":"DefaultUid", - "documentation":"

The default POSIX user ID (UID). If not specified, defaults to 1000.

", - "box":true - }, - "DefaultGid":{ - "shape":"DefaultGid", - "documentation":"

The default POSIX group ID (GID). If not specified, defaults to 100.

", - "box":true - } - }, - "documentation":"

The Amazon Elastic File System storage configuration for a SageMaker AI image.

" - }, - "FileSystemDataSource":{ - "type":"structure", - "required":[ - "FileSystemId", - "FileSystemAccessMode", - "FileSystemType", - "DirectoryPath" - ], - "members":{ - "FileSystemId":{ - "shape":"FileSystemId", - "documentation":"

The file system id.

" - }, - "FileSystemAccessMode":{ - "shape":"FileSystemAccessMode", - "documentation":"

The access mode of the mount of the directory associated with the channel. A directory can be mounted either in ro (read-only) or rw (read-write) mode.

" - }, - "FileSystemType":{ - "shape":"FileSystemType", - "documentation":"

The file system type.

" - }, - "DirectoryPath":{ - "shape":"DirectoryPath", - "documentation":"

The full path to the directory to associate with the channel.

" - } - }, - "documentation":"

Specifies a file system data source for a channel.

" - }, - "FileSystemId":{ - "type":"string", - "max":21, - "min":11, - "pattern":"(fs-[0-9a-f]{8,})" - }, - "FileSystemPath":{ - "type":"string", - "max":256, - "min":1, - "pattern":"\\/\\S*" - }, - "FileSystemType":{ - "type":"string", - "enum":[ - "EFS", - "FSxLustre" - ] - }, - "FillingTransformationMap":{ - "type":"map", - "key":{"shape":"FillingType"}, - "value":{"shape":"FillingTransformationValue"}, - "max":6, - "min":1 - }, - "FillingTransformationValue":{ - "type":"string", - "max":256, - "min":1, - "pattern":"[a-zA-Z0-9\\_\\-]+" - }, - "FillingTransformations":{ - "type":"map", - "key":{"shape":"TransformationAttributeName"}, - "value":{"shape":"FillingTransformationMap"}, - "max":50, - "min":1 - }, - "FillingType":{ - "type":"string", - "enum":[ - "frontfill", - "middlefill", - "backfill", - "futurefill", - "frontfill_value", - "middlefill_value", - "backfill_value", - "futurefill_value" - ] - }, - "Filter":{ - "type":"structure", - "required":["Name"], - "members":{ - "Name":{ - "shape":"ResourcePropertyName", - "documentation":"

A resource property name. For example, TrainingJobName. For valid property names, see SearchRecord. You must specify a valid property for the resource.

" - }, - "Operator":{ - "shape":"Operator", - "documentation":"

A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:

Equals

The value of Name equals Value.

NotEquals

The value of Name doesn't equal Value.

Exists

The Name property exists.

NotExists

The Name property does not exist.

GreaterThan

The value of Name is greater than Value. Not supported for text properties.

GreaterThanOrEqualTo

The value of Name is greater than or equal to Value. Not supported for text properties.

LessThan

The value of Name is less than Value. Not supported for text properties.

LessThanOrEqualTo

The value of Name is less than or equal to Value. Not supported for text properties.

In

The value of Name is one of the comma delimited strings in Value. Only supported for text properties.

Contains

The value of Name contains the string Value. Only supported for text properties.

A SearchExpression can include the Contains operator multiple times when the value of Name is one of the following:

  • Experiment.DisplayName

  • Experiment.ExperimentName

  • Experiment.Tags

  • Trial.DisplayName

  • Trial.TrialName

  • Trial.Tags

  • TrialComponent.DisplayName

  • TrialComponent.TrialComponentName

  • TrialComponent.Tags

  • TrialComponent.InputArtifacts

  • TrialComponent.OutputArtifacts

A SearchExpression can include only one Contains operator for all other values of Name. In these cases, if you include multiple Contains operators in the SearchExpression, the result is the following error message: \"'CONTAINS' operator usage limit of 1 exceeded.\"

" - }, - "Value":{ - "shape":"FilterValue", - "documentation":"

A value used with Name and Operator to determine which resources satisfy the filter's condition. For numerical properties, Value must be an integer or floating-point decimal. For timestamp properties, Value must be an ISO 8601 date-time string of the following format: YYYY-mm-dd'T'HH:MM:SS.

" - } - }, - "documentation":"

A conditional statement for a search expression that includes a resource property, a Boolean operator, and a value. Resources that match the statement are returned in the results from the Search API.

If you specify a Value, but not an Operator, SageMaker uses the equals operator.

In search, there are several property types:

Metrics

To define a metric filter, enter a value using the form \"Metrics.<name>\", where <name> is a metric name. For example, the following filter searches for training jobs with an \"accuracy\" metric greater than \"0.9\":

{

\"Name\": \"Metrics.accuracy\",

\"Operator\": \"GreaterThan\",

\"Value\": \"0.9\"

}

HyperParameters

To define a hyperparameter filter, enter a value with the form \"HyperParameters.<name>\". Decimal hyperparameter values are treated as a decimal in a comparison if the specified Value is also a decimal value. If the specified Value is an integer, the decimal hyperparameter values are treated as integers. For example, the following filter is satisfied by training jobs with a \"learning_rate\" hyperparameter that is less than \"0.5\":

{

\"Name\": \"HyperParameters.learning_rate\",

\"Operator\": \"LessThan\",

\"Value\": \"0.5\"

}

Tags

To define a tag filter, enter a value with the form Tags.<key>.

" - }, - "FilterList":{ - "type":"list", - "member":{"shape":"Filter"}, - "max":20, - "min":1 - }, - "FilterValue":{ - "type":"string", - "max":1024, - "min":1, - "pattern":".+" - }, - "FinalAutoMLJobObjectiveMetric":{ - "type":"structure", - "required":[ - "MetricName", - "Value" - ], - "members":{ - "Type":{ - "shape":"AutoMLJobObjectiveType", - "documentation":"

The type of metric with the best result.

" - }, - "MetricName":{ - "shape":"AutoMLMetricEnum", - "documentation":"

The name of the metric with the best result. For a description of the possible objective metrics, see AutoMLJobObjective$MetricName.

" - }, - "Value":{ - "shape":"MetricValue", - "documentation":"

The value of the metric with the best result.

", - "box":true - }, - "StandardMetricName":{ - "shape":"AutoMLMetricEnum", - "documentation":"

The name of the standard metric. For a description of the standard metrics, see Autopilot candidate metrics.

" - } - }, - "documentation":"

The best candidate result from an AutoML training job.

" - }, - "FinalHyperParameterTuningJobObjectiveMetric":{ - "type":"structure", - "required":[ - "MetricName", - "Value" - ], - "members":{ - "Type":{ - "shape":"HyperParameterTuningJobObjectiveType", - "documentation":"

Select if you want to minimize or maximize the objective metric during hyperparameter tuning.

" - }, - "MetricName":{ - "shape":"MetricName", - "documentation":"

The name of the objective metric. For SageMaker built-in algorithms, metrics are defined per algorithm. See the metrics for XGBoost as an example. You can also use a custom algorithm for training and define your own metrics. For more information, see Define metrics and environment variables.

" - }, - "Value":{ - "shape":"MetricValue", - "documentation":"

The value of the objective metric.

", - "box":true - } - }, - "documentation":"

Shows the latest objective metric emitted by a training job that was launched by a hyperparameter tuning job. You define the objective metric in the HyperParameterTuningJobObjective parameter of HyperParameterTuningJobConfig.

" - }, - "FinalMetricDataList":{ - "type":"list", - "member":{"shape":"MetricData"}, - "max":40, - "min":0 - }, - "FlatInvocations":{ - "type":"string", - "enum":[ - "Continue", - "Stop" - ] - }, - "Float":{"type":"float"}, - "FlowDefinitionArn":{ - "type":"string", - "max":1024, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]+:[0-9]{12}:flow-definition/.*" - }, - "FlowDefinitionName":{ - "type":"string", - "max":63, - "min":1, - "pattern":"[a-z0-9](-*[a-z0-9]){0,62}" - }, - "FlowDefinitionOutputConfig":{ - "type":"structure", - "required":["S3OutputPath"], - "members":{ - "S3OutputPath":{ - "shape":"S3Uri", - "documentation":"

The Amazon S3 path where the object containing human output will be made available.

To learn more about the format of Amazon A2I output data, see Amazon A2I Output Data.

" - }, - "KmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The Amazon Key Management Service (KMS) key ID for server-side encryption.

" - } - }, - "documentation":"

Contains information about where human output will be stored.

" - }, - "FlowDefinitionStatus":{ - "type":"string", - "enum":[ - "Initializing", - "Active", - "Failed", - "Deleting" - ] - }, - "FlowDefinitionSummaries":{ - "type":"list", - "member":{"shape":"FlowDefinitionSummary"} - }, - "FlowDefinitionSummary":{ - "type":"structure", - "required":[ - "FlowDefinitionName", - "FlowDefinitionArn", - "FlowDefinitionStatus", - "CreationTime" - ], - "members":{ - "FlowDefinitionName":{ - "shape":"FlowDefinitionName", - "documentation":"

The name of the flow definition.

" - }, - "FlowDefinitionArn":{ - "shape":"FlowDefinitionArn", - "documentation":"

The Amazon Resource Name (ARN) of the flow definition.

" - }, - "FlowDefinitionStatus":{ - "shape":"FlowDefinitionStatus", - "documentation":"

The status of the flow definition. Valid values:

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp when SageMaker created the flow definition.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

The reason why the flow definition creation failed. A failure reason is returned only when the flow definition status is Failed.

" - } - }, - "documentation":"

Contains summary information about the flow definition.

" - }, - "FlowDefinitionTaskAvailabilityLifetimeInSeconds":{ - "type":"integer", - "box":true, - "min":1 - }, - "FlowDefinitionTaskCount":{ - "type":"integer", - "box":true, - "max":3, - "min":1 - }, - "FlowDefinitionTaskDescription":{ - "type":"string", - "max":255, - "min":1, - "pattern":".+" - }, - "FlowDefinitionTaskKeyword":{ - "type":"string", - "max":30, - "min":1, - "pattern":"[A-Za-z0-9]+( [A-Za-z0-9]+)*" - }, - "FlowDefinitionTaskKeywords":{ - "type":"list", - "member":{"shape":"FlowDefinitionTaskKeyword"}, - "max":5, - "min":1 - }, - "FlowDefinitionTaskTimeLimitInSeconds":{ - "type":"integer", - "box":true, - "min":30 - }, - "FlowDefinitionTaskTitle":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[\\t\\n\\r -\\uD7FF\\uE000-\\uFFFD]*" - }, - "ForecastFrequency":{ - "type":"string", - "max":5, - "min":1, - "pattern":"1Y|Y|([1-9]|1[0-1])M|M|[1-4]W|W|[1-6]D|D|([1-9]|1[0-9]|2[0-3])H|H|([1-9]|[1-5][0-9])min" - }, - "ForecastHorizon":{ - "type":"integer", - "box":true, - "min":1 - }, - "ForecastQuantile":{ - "type":"string", - "max":4, - "min":2, - "pattern":"(^p[1-9]\\d?$)" - }, - "ForecastQuantiles":{ - "type":"list", - "member":{"shape":"ForecastQuantile"}, - "max":5, - "min":1 - }, - "Framework":{ - "type":"string", - "enum":[ - "TENSORFLOW", - "KERAS", - "MXNET", - "ONNX", - "PYTORCH", - "XGBOOST", - "TFLITE", - "DARKNET", - "SKLEARN" - ] - }, - "FrameworkVersion":{ - "type":"string", - "max":10, - "min":3, - "pattern":"[0-9]\\.[A-Za-z0-9.]+" - }, - "GenerateCandidateDefinitionsOnly":{"type":"boolean"}, - "GenerativeAiSettings":{ - "type":"structure", - "members":{ - "AmazonBedrockRoleArn":{ - "shape":"RoleArn", - "documentation":"

The ARN of an Amazon Web Services IAM role that allows fine-tuning of large language models (LLMs) in Amazon Bedrock. The IAM role should have Amazon S3 read and write permissions, as well as a trust relationship that establishes bedrock.amazonaws.com as a service principal.

" - } - }, - "documentation":"

The generative AI settings for the SageMaker Canvas application.

Configure these settings for Canvas users starting chats with generative AI foundation models. For more information, see Use generative AI with foundation models.

" - }, - "GetDeviceFleetReportRequest":{ - "type":"structure", - "required":["DeviceFleetName"], - "members":{ - "DeviceFleetName":{ - "shape":"EntityName", - "documentation":"

The name of the fleet.

" - } - } - }, - "GetDeviceFleetReportResponse":{ - "type":"structure", - "required":[ - "DeviceFleetArn", - "DeviceFleetName" - ], - "members":{ - "DeviceFleetArn":{ - "shape":"DeviceFleetArn", - "documentation":"

The Amazon Resource Name (ARN) of the device.

" - }, - "DeviceFleetName":{ - "shape":"EntityName", - "documentation":"

The name of the fleet.

" - }, - "OutputConfig":{ - "shape":"EdgeOutputConfig", - "documentation":"

The output configuration for storing sample data collected by the fleet.

" - }, - "Description":{ - "shape":"DeviceFleetDescription", - "documentation":"

Description of the fleet.

" - }, - "ReportGenerated":{ - "shape":"Timestamp", - "documentation":"

Timestamp of when the report was generated.

" - }, - "DeviceStats":{ - "shape":"DeviceStats", - "documentation":"

Status of devices.

" - }, - "AgentVersions":{ - "shape":"AgentVersions", - "documentation":"

The versions of Edge Manager agent deployed on the fleet.

" - }, - "ModelStats":{ - "shape":"EdgeModelStats", - "documentation":"

Status of model on device.

" - } - } - }, - "GetLineageGroupPolicyRequest":{ - "type":"structure", - "required":["LineageGroupName"], - "members":{ - "LineageGroupName":{ - "shape":"LineageGroupNameOrArn", - "documentation":"

The name or Amazon Resource Name (ARN) of the lineage group.

" - } - } - }, - "GetLineageGroupPolicyResponse":{ - "type":"structure", - "members":{ - "LineageGroupArn":{ - "shape":"LineageGroupArn", - "documentation":"

The Amazon Resource Name (ARN) of the lineage group.

" - }, - "ResourcePolicy":{ - "shape":"ResourcePolicyString", - "documentation":"

The resource policy that gives access to the lineage group in another account.

" - } - } - }, - "GetModelPackageGroupPolicyInput":{ - "type":"structure", - "required":["ModelPackageGroupName"], - "members":{ - "ModelPackageGroupName":{ - "shape":"EntityName", - "documentation":"

The name of the model group for which to get the resource policy.

" - } - } - }, - "GetModelPackageGroupPolicyOutput":{ - "type":"structure", - "required":["ResourcePolicy"], - "members":{ - "ResourcePolicy":{ - "shape":"PolicyString", - "documentation":"

The resource policy for the model group.

" - } - } - }, - "GetSagemakerServicecatalogPortfolioStatusInput":{ - "type":"structure", - "members":{} - }, - "GetSagemakerServicecatalogPortfolioStatusOutput":{ - "type":"structure", - "members":{ - "Status":{ - "shape":"SagemakerServicecatalogStatus", - "documentation":"

Whether Service Catalog is enabled or disabled in SageMaker.

" - } - } - }, - "GetScalingConfigurationRecommendationRequest":{ - "type":"structure", - "required":["InferenceRecommendationsJobName"], - "members":{ - "InferenceRecommendationsJobName":{ - "shape":"RecommendationJobName", - "documentation":"

The name of a previously completed Inference Recommender job.

" - }, - "RecommendationId":{ - "shape":"String", - "documentation":"

The recommendation ID of a previously completed inference recommendation. This ID should come from one of the recommendations returned by the job specified in the InferenceRecommendationsJobName field.

Specify either this field or the EndpointName field.

" - }, - "EndpointName":{ - "shape":"EndpointName", - "documentation":"

The name of an endpoint benchmarked during a previously completed inference recommendation job. This name should come from one of the recommendations returned by the job specified in the InferenceRecommendationsJobName field.

Specify either this field or the RecommendationId field.

" - }, - "TargetCpuUtilizationPerCore":{ - "shape":"UtilizationPercentagePerCore", - "documentation":"

The percentage of how much utilization you want an instance to use before autoscaling. The default value is 50%.

" - }, - "ScalingPolicyObjective":{ - "shape":"ScalingPolicyObjective", - "documentation":"

An object where you specify the anticipated traffic pattern for an endpoint.

" - } - } - }, - "GetScalingConfigurationRecommendationResponse":{ - "type":"structure", - "members":{ - "InferenceRecommendationsJobName":{ - "shape":"RecommendationJobName", - "documentation":"

The name of a previously completed Inference Recommender job.

" - }, - "RecommendationId":{ - "shape":"String", - "documentation":"

The recommendation ID of a previously completed inference recommendation.

" - }, - "EndpointName":{ - "shape":"EndpointName", - "documentation":"

The name of an endpoint benchmarked during a previously completed Inference Recommender job.

" - }, - "TargetCpuUtilizationPerCore":{ - "shape":"UtilizationPercentagePerCore", - "documentation":"

The percentage of how much utilization you want an instance to use before autoscaling, which you specified in the request. The default value is 50%.

" - }, - "ScalingPolicyObjective":{ - "shape":"ScalingPolicyObjective", - "documentation":"

An object representing the anticipated traffic pattern for an endpoint that you specified in the request.

" - }, - "Metric":{ - "shape":"ScalingPolicyMetric", - "documentation":"

An object with a list of metrics that were benchmarked during the previously completed Inference Recommender job.

" - }, - "DynamicScalingConfiguration":{ - "shape":"DynamicScalingConfiguration", - "documentation":"

An object with the recommended values for you to specify when creating an autoscaling policy.

" - } - } - }, - "GetSearchSuggestionsRequest":{ - "type":"structure", - "required":["Resource"], - "members":{ - "Resource":{ - "shape":"ResourceType", - "documentation":"

The name of the SageMaker resource to search for.

" - }, - "SuggestionQuery":{ - "shape":"SuggestionQuery", - "documentation":"

Limits the property names that are included in the response.

" - } - } - }, - "GetSearchSuggestionsResponse":{ - "type":"structure", - "members":{ - "PropertyNameSuggestions":{ - "shape":"PropertyNameSuggestionList", - "documentation":"

A list of property names for a Resource that match a SuggestionQuery.

" - } - } - }, - "Gid":{ - "type":"long", - "box":true, - "max":4000000, - "min":1001 - }, - "GitConfig":{ - "type":"structure", - "required":["RepositoryUrl"], - "members":{ - "RepositoryUrl":{ - "shape":"GitConfigUrl", - "documentation":"

The URL where the Git repository is located.

" - }, - "Branch":{ - "shape":"Branch", - "documentation":"

The default branch for the Git repository.

" - }, - "SecretArn":{ - "shape":"SecretArn", - "documentation":"

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the git repository. The secret must have a staging label of AWSCURRENT and must be in the following format:

{\"username\": UserName, \"password\": Password}

" - } - }, - "documentation":"

Specifies configuration details for a Git repository in your Amazon Web Services account.

" - }, - "GitConfigForUpdate":{ - "type":"structure", - "members":{ - "SecretArn":{ - "shape":"SecretArn", - "documentation":"

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the git repository. The secret must have a staging label of AWSCURRENT and must be in the following format:

{\"username\": UserName, \"password\": Password}

" - } - }, - "documentation":"

Specifies configuration details for a Git repository when the repository is updated.

" - }, - "GitConfigUrl":{ - "type":"string", - "max":1024, - "min":11, - "pattern":"https://([^/]+)/?.{3,1016}" - }, - "Group":{ - "type":"string", - "max":63, - "min":1, - "pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+" - }, - "GroupNamePattern":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[\\w+=,.@*-]+" - }, - "GroupPatternsList":{ - "type":"list", - "member":{"shape":"GroupNamePattern"}, - "max":10, - "min":1 - }, - "GroupingAttributeName":{ - "type":"string", - "max":256, - "min":1 - }, - "GroupingAttributeNames":{ - "type":"list", - "member":{"shape":"GroupingAttributeName"}, - "max":5, - "min":1 - }, - "Groups":{ - "type":"list", - "member":{"shape":"Group"}, - "max":10, - "min":1 - }, - "HiddenAppTypesList":{ - "type":"list", - "member":{"shape":"AppType"} - }, - "HiddenInstanceTypesList":{ - "type":"list", - "member":{"shape":"AppInstanceType"} - }, - "HiddenMlToolsList":{ - "type":"list", - "member":{"shape":"MlTools"} - }, - "HiddenSageMakerImage":{ - "type":"structure", - "members":{ - "SageMakerImageName":{ - "shape":"SageMakerImageName", - "documentation":"

The SageMaker image name that you are hiding from the Studio user interface.

" - }, - "VersionAliases":{ - "shape":"VersionAliasesList", - "documentation":"

The version aliases you are hiding from the Studio user interface.

" - } - }, - "documentation":"

The SageMaker images that are hidden from the Studio user interface. You must specify the SageMaker image name and version aliases.

" - }, - "HiddenSageMakerImageVersionAliasesList":{ - "type":"list", - "member":{"shape":"HiddenSageMakerImage"}, - "max":5, - "min":0 - }, - "HolidayConfig":{ - "type":"list", - "member":{"shape":"HolidayConfigAttributes"}, - "max":1, - "min":1 - }, - "HolidayConfigAttributes":{ - "type":"structure", - "members":{ - "CountryCode":{ - "shape":"CountryCode", - "documentation":"

The country code for the holiday calendar.

For the list of public holiday calendars supported by AutoML job V2, see Country Codes. Use the country code corresponding to the country of your choice.

" - } - }, - "documentation":"

Stores the holiday featurization attributes applicable to each item of time-series datasets during the training of a forecasting model. This allows the model to identify patterns associated with specific holidays.

" - }, - "HomeEfsFileSystemCreation":{ - "type":"string", - "documentation":"

Indicates whether a home EFS file system is created for the domain.

", - "enum":[ - "Enabled", - "Disabled" - ] - }, - "HookParameters":{ - "type":"map", - "key":{"shape":"ConfigKey"}, - "value":{"shape":"ConfigValue"}, - "max":20, - "min":0 - }, - "Horovod":{"type":"boolean"}, - "HubAccessConfig":{ - "type":"structure", - "required":["HubContentArn"], - "members":{ - "HubContentArn":{ - "shape":"HubContentArn", - "documentation":"

The ARN of your private model hub content. This should be a ModelReference resource type that points to a SageMaker JumpStart public hub model.

" - } - }, - "documentation":"

The configuration for a private hub model reference that points to a public SageMaker JumpStart model.

For more information about private hubs, see Private curated hubs for foundation model access control in JumpStart.

" - }, - "HubArn":{ - "type":"string", - "max":255, - "min":0, - "pattern":".*" - }, - "HubContentArn":{ - "type":"string", - "max":255, - "min":0, - "pattern":".*" - }, - "HubContentDependency":{ - "type":"structure", - "members":{ - "DependencyOriginPath":{ - "shape":"DependencyOriginPath", - "documentation":"

The hub content dependency origin path.

" - }, - "DependencyCopyPath":{ - "shape":"DependencyCopyPath", - "documentation":"

The hub content dependency copy path.

" - } - }, - "documentation":"

Any dependencies related to hub content, such as scripts, model artifacts, datasets, or notebooks.

" - }, - "HubContentDependencyList":{ - "type":"list", - "member":{"shape":"HubContentDependency"}, - "max":50, - "min":0 - }, - "HubContentDescription":{ - "type":"string", - "max":1023, - "min":0, - "pattern":".*" - }, - "HubContentDisplayName":{ - "type":"string", - "max":255, - "min":0, - "pattern":".*" - }, - "HubContentDocument":{ - "type":"string", - "max":327680, - "min":0, - "pattern":".*" - }, - "HubContentInfo":{ - "type":"structure", - "required":[ - "HubContentName", - "HubContentArn", - "HubContentVersion", - "HubContentType", - "DocumentSchemaVersion", - "HubContentStatus", - "CreationTime" - ], - "members":{ - "HubContentName":{ - "shape":"HubContentName", - "documentation":"

The name of the hub content.

" - }, - "HubContentArn":{ - "shape":"HubContentArn", - "documentation":"

The Amazon Resource Name (ARN) of the hub content.

" - }, - "SageMakerPublicHubContentArn":{ - "shape":"SageMakerPublicHubContentArn", - "documentation":"

The ARN of the public hub content.

" - }, - "HubContentVersion":{ - "shape":"HubContentVersion", - "documentation":"

The version of the hub content.

" - }, - "HubContentType":{ - "shape":"HubContentType", - "documentation":"

The type of hub content.

" - }, - "DocumentSchemaVersion":{ - "shape":"DocumentSchemaVersion", - "documentation":"

The version of the hub content document schema.

" - }, - "HubContentDisplayName":{ - "shape":"HubContentDisplayName", - "documentation":"

The display name of the hub content.

" - }, - "HubContentDescription":{ - "shape":"HubContentDescription", - "documentation":"

A description of the hub content.

" - }, - "SupportStatus":{ - "shape":"HubContentSupportStatus", - "documentation":"

The support status of the hub content.

" - }, - "HubContentSearchKeywords":{ - "shape":"HubContentSearchKeywordList", - "documentation":"

The searchable keywords for the hub content.

" - }, - "HubContentStatus":{ - "shape":"HubContentStatus", - "documentation":"

The status of the hub content.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The date and time that the hub content was created.

" - }, - "OriginalCreationTime":{ - "shape":"Timestamp", - "documentation":"

The date and time when the hub content was originally created, before any updates or revisions.

" - } - }, - "documentation":"

Information about hub content.

" - }, - "HubContentInfoList":{ - "type":"list", - "member":{"shape":"HubContentInfo"} - }, - "HubContentMarkdown":{ - "type":"string", - "max":170391, - "min":0 - }, - "HubContentName":{ - "type":"string", - "max":63, - "min":0, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" - }, - "HubContentSearchKeyword":{ - "type":"string", - "max":255, - "min":0, - "pattern":".*" - }, - "HubContentSearchKeywordList":{ - "type":"list", - "member":{"shape":"HubContentSearchKeyword"}, - "max":50, - "min":0 - }, - "HubContentSortBy":{ - "type":"string", - "enum":[ - "HubContentName", - "CreationTime", - "HubContentStatus" - ] - }, - "HubContentStatus":{ - "type":"string", - "enum":[ - "Available", - "Importing", - "Deleting", - "ImportFailed", - "DeleteFailed", - "PendingImport", - "PendingDelete" - ] - }, - "HubContentSupportStatus":{ - "type":"string", - "enum":[ - "Supported", - "Deprecated", - "Restricted" - ] - }, - "HubContentType":{ - "type":"string", - "enum":[ - "Model", - "Notebook", - "ModelReference", - "DataSet", - "JsonDoc" - ] - }, - "HubContentVersion":{ - "type":"string", - "max":14, - "min":5, - "pattern":"\\d{1,4}.\\d{1,4}.\\d{1,4}" - }, - "HubDataSetArn":{ - "type":"string", - "max":2048, - "min":0, - "pattern":"(arn:[a-z0-9-\\.]{1,63}:sagemaker:\\w+(?:-\\w+)+:(\\d{12}|aws):hub-content\\/)[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}\\/DataSet\\/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}(\\/\\d{1,4}.\\d{1,4}.\\d{1,4})?" - }, - "HubDescription":{ - "type":"string", - "max":1023, - "min":0, - "pattern":".*" - }, - "HubDisplayName":{ - "type":"string", - "max":255, - "min":0, - "pattern":".*" - }, - "HubInfo":{ - "type":"structure", - "required":[ - "HubName", - "HubArn", - "HubStatus", - "CreationTime", - "LastModifiedTime" - ], - "members":{ - "HubName":{ - "shape":"HubName", - "documentation":"

The name of the hub.

" - }, - "HubArn":{ - "shape":"HubArn", - "documentation":"

The Amazon Resource Name (ARN) of the hub.

" - }, - "HubDisplayName":{ - "shape":"HubDisplayName", - "documentation":"

The display name of the hub.

" - }, - "HubDescription":{ - "shape":"HubDescription", - "documentation":"

A description of the hub.

" - }, - "HubSearchKeywords":{ - "shape":"HubSearchKeywordList", - "documentation":"

The searchable keywords for the hub.

" - }, - "HubStatus":{ - "shape":"HubStatus", - "documentation":"

The status of the hub.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The date and time that the hub was created.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The date and time that the hub was last modified.

" - } - }, - "documentation":"

Information about a hub.

" - }, - "HubInfoList":{ - "type":"list", - "member":{"shape":"HubInfo"} - }, - "HubName":{ - "type":"string", - "max":63, - "min":0, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" - }, - "HubNameOrArn":{ - "type":"string", - "pattern":"(arn:[a-z0-9-\\.]{1,63}:sagemaker:\\w+(?:-\\w+)+:(\\d{12}|aws):hub\\/)?[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" - }, - "HubS3StorageConfig":{ - "type":"structure", - "members":{ - "S3OutputPath":{ - "shape":"S3OutputPath", - "documentation":"

The Amazon S3 bucket prefix for hosting hub content.

" - } - }, - "documentation":"

The Amazon S3 storage configuration of a hub.

" - }, - "HubSearchKeyword":{ - "type":"string", - "max":255, - "min":0, - "pattern":"[^A-Z]*" - }, - "HubSearchKeywordList":{ - "type":"list", - "member":{"shape":"HubSearchKeyword"}, - "max":50, - "min":0 - }, - "HubSortBy":{ - "type":"string", - "enum":[ - "HubName", - "CreationTime", - "HubStatus", - "AccountIdOwner" - ] - }, - "HubStatus":{ - "type":"string", - "enum":[ - "InService", - "Creating", - "Updating", - "Deleting", - "CreateFailed", - "UpdateFailed", - "DeleteFailed" - ] - }, - "HumanLoopActivationConditions":{ - "type":"string", - "max":10240, - "min":0 - }, - "HumanLoopActivationConditionsConfig":{ - "type":"structure", - "required":["HumanLoopActivationConditions"], - "members":{ - "HumanLoopActivationConditions":{ - "shape":"HumanLoopActivationConditions", - "documentation":"

JSON expressing use-case specific conditions declaratively. If any condition is matched, atomic tasks are created against the configured work team. The set of conditions is different for Rekognition and Textract. For more information about how to structure the JSON, see JSON Schema for Human Loop Activation Conditions in Amazon Augmented AI in the Amazon SageMaker Developer Guide.

", - "jsonvalue":true - } - }, - "documentation":"

Defines under what conditions SageMaker creates a human loop. Used within CreateFlowDefinition. See HumanLoopActivationConditionsConfig for the required format of activation conditions.

" - }, - "HumanLoopActivationConfig":{ - "type":"structure", - "required":["HumanLoopActivationConditionsConfig"], - "members":{ - "HumanLoopActivationConditionsConfig":{ - "shape":"HumanLoopActivationConditionsConfig", - "documentation":"

Container structure for defining under what conditions SageMaker creates a human loop.

" - } - }, - "documentation":"

Provides information about how and under what conditions SageMaker creates a human loop. If HumanLoopActivationConfig is not given, then all requests go to humans.

" - }, - "HumanLoopConfig":{ - "type":"structure", - "required":[ - "WorkteamArn", - "HumanTaskUiArn", - "TaskTitle", - "TaskDescription", - "TaskCount" - ], - "members":{ - "WorkteamArn":{ - "shape":"WorkteamArn", - "documentation":"

Amazon Resource Name (ARN) of a team of workers. To learn more about the types of workforces and work teams you can create and use with Amazon A2I, see Create and Manage Workforces.

" - }, - "HumanTaskUiArn":{ - "shape":"HumanTaskUiArn", - "documentation":"

The Amazon Resource Name (ARN) of the human task user interface.

You can use standard HTML and Crowd HTML Elements to create a custom worker task template. You use this template to create a human task UI.

To learn how to create a custom HTML template, see Create Custom Worker Task Template.

To learn how to create a human task UI, which is a worker task template that can be used in a flow definition, see Create and Delete a Worker Task Templates.

" - }, - "TaskTitle":{ - "shape":"FlowDefinitionTaskTitle", - "documentation":"

A title for the human worker task.

" - }, - "TaskDescription":{ - "shape":"FlowDefinitionTaskDescription", - "documentation":"

A description for the human worker task.

" - }, - "TaskCount":{ - "shape":"FlowDefinitionTaskCount", - "documentation":"

The number of distinct workers who will perform the same task on each object. For example, if TaskCount is set to 3 for an image classification labeling job, three workers will classify each input image. Increasing TaskCount can improve label accuracy.

" - }, - "TaskAvailabilityLifetimeInSeconds":{ - "shape":"FlowDefinitionTaskAvailabilityLifetimeInSeconds", - "documentation":"

The length of time that a task remains available for review by human workers.

" - }, - "TaskTimeLimitInSeconds":{ - "shape":"FlowDefinitionTaskTimeLimitInSeconds", - "documentation":"

The amount of time that a worker has to complete a task. The default value is 3,600 seconds (1 hour).

" - }, - "TaskKeywords":{ - "shape":"FlowDefinitionTaskKeywords", - "documentation":"

Keywords used to describe the task so that workers can discover the task.

" - }, - "PublicWorkforceTaskPrice":{"shape":"PublicWorkforceTaskPrice"} - }, - "documentation":"

Describes the work to be performed by human workers.

" - }, - "HumanLoopRequestSource":{ - "type":"structure", - "required":["AwsManagedHumanLoopRequestSource"], - "members":{ - "AwsManagedHumanLoopRequestSource":{ - "shape":"AwsManagedHumanLoopRequestSource", - "documentation":"

Specifies whether Amazon Rekognition or Amazon Textract are used as the integration source. The default field settings and JSON parsing rules are different based on the integration source. Valid values:

" - } - }, - "documentation":"

Container for configuring the source of human task requests.

" - }, - "HumanTaskConfig":{ - "type":"structure", - "required":[ - "WorkteamArn", - "UiConfig", - "TaskTitle", - "TaskDescription", - "NumberOfHumanWorkersPerDataObject", - "TaskTimeLimitInSeconds" - ], - "members":{ - "WorkteamArn":{ - "shape":"WorkteamArn", - "documentation":"

The Amazon Resource Name (ARN) of the work team assigned to complete the tasks.

" - }, - "UiConfig":{ - "shape":"UiConfig", - "documentation":"

Information about the user interface that workers use to complete the labeling task.

" - }, - "PreHumanTaskLambdaArn":{ - "shape":"LambdaFunctionArn", - "documentation":"

The Amazon Resource Name (ARN) of a Lambda function that is run before a data object is sent to a human worker. Use this function to provide input to a custom labeling job.

For built-in task types, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for PreHumanTaskLambdaArn. For custom labeling workflows, see Pre-annotation Lambda.

Bounding box - Finds the most similar boxes from different workers based on the Jaccard index of the boxes.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-BoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-BoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-BoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-BoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-BoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-BoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-BoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-BoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-BoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-BoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-BoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-BoundingBox

Image classification - Uses a variant of the Expectation Maximization approach to estimate the true class of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClass

Multi-label image classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClassMultiLabel

Semantic segmentation - Treats each pixel in an image as a multi-class classification and treats pixel annotations from workers as \"votes\" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-SemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-SemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-SemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-SemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-SemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-SemanticSegmentation

Text classification - Uses a variant of the Expectation Maximization approach to estimate the true class of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClass

Multi-label text classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClassMultiLabel

Named entity recognition - Groups similar selections and calculates aggregate boundaries, resolving to most-assigned label.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-NamedEntityRecognition

Video Classification - Use this task type when you need workers to classify videos using predefined labels that you specify. Workers are shown videos and are asked to choose one label for each video.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoMultiClass

Video Frame Object Detection - Use this task type to have workers identify and locate objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to identify and localize various objects in a series of video frames, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectDetection

Video Frame Object Tracking - Use this task type to have workers track the movement of objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to track the movement of objects, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectTracking

3D Point Cloud Modalities

Use the following pre-annotation lambdas for 3D point cloud labeling modality tasks. See 3D Point Cloud Task types to learn more.

3D Point Cloud Object Detection - Use this task type when you want workers to classify objects in a 3D point cloud by drawing 3D cuboids around objects. For example, you can use this task type to ask workers to identify different types of objects in a point cloud, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectDetection

3D Point Cloud Object Tracking - Use this task type when you want workers to draw 3D cuboids around objects that appear in a sequence of 3D point cloud frames. For example, you can use this task type to ask workers to track the movement of vehicles across multiple point cloud frames.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectTracking

3D Point Cloud Semantic Segmentation - Use this task type when you want workers to create a point-level semantic segmentation masks by painting objects in a 3D point cloud using different colors where each color is assigned to one of the classes you specify.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudSemanticSegmentation

Use the following ARNs for Label Verification and Adjustment Jobs

Use label verification and adjustment jobs to review and adjust labels. To learn more, see Verify and Adjust Labels .

Bounding box verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgement for bounding box labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationBoundingBox

Bounding box adjustment - Finds the most similar boxes from different workers based on the Jaccard index of the adjusted annotations.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentBoundingBox

Semantic segmentation verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgment for semantic segmentation labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationSemanticSegmentation

Semantic segmentation adjustment - Treats each pixel in an image as a multi-class classification and treats pixel adjusted annotations from workers as \"votes\" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentSemanticSegmentation

Video Frame Object Detection Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to classify and localize objects in a sequence of video frames.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectDetection

Video Frame Object Tracking Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to track object movement across a sequence of video frames.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectTracking

3D point cloud object detection adjustment - Adjust 3D cuboids in a point cloud frame.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectDetection

3D point cloud object tracking adjustment - Adjust 3D cuboids across a sequence of point cloud frames.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectTracking

3D point cloud semantic segmentation adjustment - Adjust semantic segmentation masks in a 3D point cloud.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudSemanticSegmentation

Generative AI/Custom - Direct passthrough of input data without any transformation.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-PassThrough

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-PassThrough

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-PassThrough

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-PassThrough

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-PassThrough

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-PassThrough

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-PassThrough

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-PassThrough

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-PassThrough

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-PassThrough

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-PassThrough

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-PassThrough

" - }, - "TaskKeywords":{ - "shape":"TaskKeywords", - "documentation":"

Keywords used to describe the task so that workers on Amazon Mechanical Turk can discover the task.

" - }, - "TaskTitle":{ - "shape":"TaskTitle", - "documentation":"

A title for the task for your human workers.

" - }, - "TaskDescription":{ - "shape":"TaskDescription", - "documentation":"

A description of the task for your human workers.

" - }, - "NumberOfHumanWorkersPerDataObject":{ - "shape":"NumberOfHumanWorkersPerDataObject", - "documentation":"

The number of human workers that will label an object.

" - }, - "TaskTimeLimitInSeconds":{ - "shape":"TaskTimeLimitInSeconds", - "documentation":"

The amount of time that a worker has to complete a task.

If you create a custom labeling job, the maximum value for this parameter is 8 hours (28,800 seconds).

If you create a labeling job using a built-in task type the maximum for this parameter depends on the task type you use:

  • For image and text labeling jobs, the maximum is 8 hours (28,800 seconds).

  • For 3D point cloud and video frame labeling jobs, the maximum is 30 days (2952,000 seconds) for non-AL mode. For most users, the maximum is also 30 days.

" - }, - "TaskAvailabilityLifetimeInSeconds":{ - "shape":"TaskAvailabilityLifetimeInSeconds", - "documentation":"

The length of time that a task remains available for labeling by human workers. The default and maximum values for this parameter depend on the type of workforce you use.

  • If you choose the Amazon Mechanical Turk workforce, the maximum is 12 hours (43,200 seconds). The default is 6 hours (21,600 seconds).

  • If you choose a private or vendor workforce, the default value is 30 days (2592,000 seconds) for non-AL mode. For most users, the maximum is also 30 days.

" - }, - "MaxConcurrentTaskCount":{ - "shape":"MaxConcurrentTaskCount", - "documentation":"

Defines the maximum number of data objects that can be labeled by human workers at the same time. Also referred to as batch size. Each object may have more than one worker at one time. The default value is 1000 objects. To increase the maximum value to 5000 objects, contact Amazon Web Services Support.

" - }, - "AnnotationConsolidationConfig":{ - "shape":"AnnotationConsolidationConfig", - "documentation":"

Configures how labels are consolidated across human workers.

" - }, - "PublicWorkforceTaskPrice":{ - "shape":"PublicWorkforceTaskPrice", - "documentation":"

The price that you pay for each task performed by an Amazon Mechanical Turk worker.

" - } - }, - "documentation":"

Information required for human workers to complete a labeling task.

" - }, - "HumanTaskUiArn":{ - "type":"string", - "max":1024, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]+:[0-9]{12}:human-task-ui/.*" - }, - "HumanTaskUiName":{ - "type":"string", - "max":63, - "min":1, - "pattern":"[a-z0-9](-*[a-z0-9])*" - }, - "HumanTaskUiStatus":{ - "type":"string", - "enum":[ - "Active", - "Deleting" - ] - }, - "HumanTaskUiSummaries":{ - "type":"list", - "member":{"shape":"HumanTaskUiSummary"} - }, - "HumanTaskUiSummary":{ - "type":"structure", - "required":[ - "HumanTaskUiName", - "HumanTaskUiArn", - "CreationTime" - ], - "members":{ - "HumanTaskUiName":{ - "shape":"HumanTaskUiName", - "documentation":"

The name of the human task user interface.

" - }, - "HumanTaskUiArn":{ - "shape":"HumanTaskUiArn", - "documentation":"

The Amazon Resource Name (ARN) of the human task user interface.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp when SageMaker created the human task user interface.

" - } - }, - "documentation":"

Container for human task user interface information.

" - }, - "HyperParameterAlgorithmSpecification":{ - "type":"structure", - "required":["TrainingInputMode"], - "members":{ - "TrainingImage":{ - "shape":"AlgorithmImage", - "documentation":"

The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

" - }, - "TrainingInputMode":{"shape":"TrainingInputMode"}, - "AlgorithmName":{ - "shape":"ArnOrName", - "documentation":"

The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for TrainingImage.

" - }, - "MetricDefinitions":{ - "shape":"MetricDefinitionList", - "documentation":"

An array of MetricDefinition objects that specify the metrics that the algorithm emits.

" - } - }, - "documentation":"

Specifies which training algorithm to use for training jobs that a hyperparameter tuning job launches and the metrics to monitor.

" - }, - "HyperParameterKey":{ - "type":"string", - "max":256, - "min":0, - "pattern":".*" - }, - "HyperParameterScalingType":{ - "type":"string", - "enum":[ - "Auto", - "Linear", - "Logarithmic", - "ReverseLogarithmic" - ] - }, - "HyperParameterSpecification":{ - "type":"structure", - "required":[ - "Name", - "Type" - ], - "members":{ - "Name":{ - "shape":"ParameterName", - "documentation":"

The name of this hyperparameter. The name must be unique.

" - }, - "Description":{ - "shape":"EntityDescription", - "documentation":"

A brief description of the hyperparameter.

" - }, - "Type":{ - "shape":"ParameterType", - "documentation":"

The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.

" - }, - "Range":{ - "shape":"ParameterRange", - "documentation":"

The allowed range for this hyperparameter.

" - }, - "IsTunable":{ - "shape":"Boolean", - "documentation":"

Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.

", - "box":true - }, - "IsRequired":{ - "shape":"Boolean", - "documentation":"

Indicates whether this hyperparameter is required.

", - "box":true - }, - "DefaultValue":{ - "shape":"HyperParameterValue", - "documentation":"

The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.

" - } - }, - "documentation":"

Defines a hyperparameter to be used by an algorithm.

" - }, - "HyperParameterSpecifications":{ - "type":"list", - "member":{"shape":"HyperParameterSpecification"}, - "max":100, - "min":0 - }, - "HyperParameterTrainingJobDefinition":{ - "type":"structure", - "required":[ - "AlgorithmSpecification", - "RoleArn", - "OutputDataConfig", - "StoppingCondition" - ], - "members":{ - "DefinitionName":{ - "shape":"HyperParameterTrainingJobDefinitionName", - "documentation":"

The job definition name.

" - }, - "TuningObjective":{"shape":"HyperParameterTuningJobObjective"}, - "HyperParameterRanges":{"shape":"ParameterRanges"}, - "StaticHyperParameters":{ - "shape":"HyperParameters", - "documentation":"

Specifies the values of hyperparameters that do not change for the tuning job.

" - }, - "AlgorithmSpecification":{ - "shape":"HyperParameterAlgorithmSpecification", - "documentation":"

The HyperParameterAlgorithmSpecification object that specifies the resource algorithm to use for the training jobs that the tuning job launches.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the IAM role associated with the training jobs that the tuning job launches.

" - }, - "InputDataConfig":{ - "shape":"InputDataConfig", - "documentation":"

An array of Channel objects that specify the input for the training jobs that the tuning job launches.

" - }, - "VpcConfig":{ - "shape":"VpcConfig", - "documentation":"

The VpcConfig object that specifies the VPC that you want the training jobs that this hyperparameter tuning job launches to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

" - }, - "OutputDataConfig":{ - "shape":"OutputDataConfig", - "documentation":"

Specifies the path to the Amazon S3 bucket where you store model artifacts from the training jobs that the tuning job launches.

" - }, - "ResourceConfig":{ - "shape":"ResourceConfig", - "documentation":"

The resources, including the compute instances and storage volumes, to use for the training jobs that the tuning job launches.

Storage volumes store model artifacts and incremental states. Training algorithms might also use storage volumes for scratch space. If you want SageMaker to use the storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.

If you want to use hyperparameter optimization with instance type flexibility, use HyperParameterTuningResourceConfig instead.

" - }, - "HyperParameterTuningResourceConfig":{ - "shape":"HyperParameterTuningResourceConfig", - "documentation":"

The configuration for the hyperparameter tuning resources, including the compute instances and storage volumes, used for training jobs launched by the tuning job. By default, storage volumes hold model artifacts and incremental states. Choose File for TrainingInputMode in the AlgorithmSpecification parameter to additionally store training data in the storage volume (optional).

" - }, - "StoppingCondition":{ - "shape":"StoppingCondition", - "documentation":"

Specifies a limit to how long a model hyperparameter training job can run. It also specifies how long a managed spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

" - }, - "EnableNetworkIsolation":{ - "shape":"Boolean", - "documentation":"

Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If network isolation is used for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

", - "box":true - }, - "EnableInterContainerTrafficEncryption":{ - "shape":"Boolean", - "documentation":"

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.

", - "box":true - }, - "EnableManagedSpotTraining":{ - "shape":"Boolean", - "documentation":"

A Boolean indicating whether managed spot training is enabled (True) or not (False).

", - "box":true - }, - "CheckpointConfig":{"shape":"CheckpointConfig"}, - "RetryStrategy":{ - "shape":"RetryStrategy", - "documentation":"

The number of times to retry the job when the job fails due to an InternalServerError.

" - }, - "Environment":{ - "shape":"HyperParameterTrainingJobEnvironmentMap", - "documentation":"

An environment variable that you can pass into the SageMaker CreateTrainingJob API. You can use an existing environment variable from the training container or use your own. See Define metrics and variables for more information.

The maximum number of items specified for Map Entries refers to the maximum number of environment variables for each TrainingJobDefinition and also the maximum for the hyperparameter tuning job itself. That is, the sum of the number of environment variables for all the training job definitions can't exceed the maximum number specified.

" - } - }, - "documentation":"

Defines the training jobs launched by a hyperparameter tuning job.

" - }, - "HyperParameterTrainingJobDefinitionName":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}" - }, - "HyperParameterTrainingJobDefinitions":{ - "type":"list", - "member":{"shape":"HyperParameterTrainingJobDefinition"}, - "max":10, - "min":1 - }, - "HyperParameterTrainingJobEnvironmentKey":{ - "type":"string", - "max":512, - "min":0, - "pattern":"[a-zA-Z_][a-zA-Z0-9_]*" - }, - "HyperParameterTrainingJobEnvironmentMap":{ - "type":"map", - "key":{"shape":"HyperParameterTrainingJobEnvironmentKey"}, - "value":{"shape":"HyperParameterTrainingJobEnvironmentValue"}, - "max":48, - "min":0 - }, - "HyperParameterTrainingJobEnvironmentValue":{ - "type":"string", - "max":512, - "min":0, - "pattern":"[\\S\\s]*" - }, - "HyperParameterTrainingJobSummaries":{ - "type":"list", - "member":{"shape":"HyperParameterTrainingJobSummary"} - }, - "HyperParameterTrainingJobSummary":{ - "type":"structure", - "required":[ - "TrainingJobName", - "TrainingJobArn", - "CreationTime", - "TrainingJobStatus", - "TunedHyperParameters" - ], - "members":{ - "TrainingJobDefinitionName":{ - "shape":"HyperParameterTrainingJobDefinitionName", - "documentation":"

The training job definition name.

" - }, - "TrainingJobName":{ - "shape":"TrainingJobName", - "documentation":"

The name of the training job.

" - }, - "TrainingJobArn":{ - "shape":"TrainingJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the training job.

" - }, - "TuningJobName":{ - "shape":"HyperParameterTuningJobName", - "documentation":"

The HyperParameter tuning job that launched the training job.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The date and time that the training job was created.

" - }, - "TrainingStartTime":{ - "shape":"Timestamp", - "documentation":"

The date and time that the training job started.

" - }, - "TrainingEndTime":{ - "shape":"Timestamp", - "documentation":"

Specifies the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when SageMaker detects a job failure.

" - }, - "TrainingJobStatus":{ - "shape":"TrainingJobStatus", - "documentation":"

The status of the training job.

" - }, - "TunedHyperParameters":{ - "shape":"HyperParameters", - "documentation":"

A list of the hyperparameters for which you specified ranges to search.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

The reason that the training job failed.

" - }, - "FinalHyperParameterTuningJobObjectiveMetric":{ - "shape":"FinalHyperParameterTuningJobObjectiveMetric", - "documentation":"

The FinalHyperParameterTuningJobObjectiveMetric object that specifies the value of the objective metric of the tuning job that launched this training job.

" - }, - "ObjectiveStatus":{ - "shape":"ObjectiveStatus", - "documentation":"

The status of the objective metric for the training job:

  • Succeeded: The final objective metric for the training job was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.

  • Pending: The training job is in progress and evaluation of its final objective metric is pending.

  • Failed: The final objective metric for the training job was not evaluated, and was not used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.

" - } - }, - "documentation":"

The container for the summary information about a training job.

" - }, - "HyperParameterTuningAllocationStrategy":{ - "type":"string", - "enum":["Prioritized"] - }, - "HyperParameterTuningInstanceConfig":{ - "type":"structure", - "required":[ - "InstanceType", - "InstanceCount", - "VolumeSizeInGB" - ], - "members":{ - "InstanceType":{ - "shape":"TrainingInstanceType", - "documentation":"

The instance type used for processing of hyperparameter optimization jobs. Choose from general purpose (no GPUs) instance types: ml.m5.xlarge, ml.m5.2xlarge, and ml.m5.4xlarge or compute optimized (no GPUs) instance types: ml.c5.xlarge and ml.c5.2xlarge. For more information about instance types, see instance type descriptions.

" - }, - "InstanceCount":{ - "shape":"TrainingInstanceCount", - "documentation":"

The number of instances of the type specified by InstanceType. Choose an instance count larger than 1 for distributed training algorithms. See Step 2: Launch a SageMaker Distributed Training Job Using the SageMaker Python SDK for more information.

", - "box":true - }, - "VolumeSizeInGB":{ - "shape":"VolumeSizeInGB", - "documentation":"

The volume size in GB of the data to be processed for hyperparameter optimization (optional).

", - "box":true - } - }, - "documentation":"

The configuration for hyperparameter tuning resources for use in training jobs launched by the tuning job. These resources include compute instances and storage volumes. Specify one or more compute instance configurations and allocation strategies to select resources (optional).

" - }, - "HyperParameterTuningInstanceConfigs":{ - "type":"list", - "member":{"shape":"HyperParameterTuningInstanceConfig"}, - "max":6, - "min":1 - }, - "HyperParameterTuningJobArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:hyper-parameter-tuning-job/.*" - }, - "HyperParameterTuningJobCompletionDetails":{ - "type":"structure", - "members":{ - "NumberOfTrainingJobsObjectiveNotImproving":{ - "shape":"Integer", - "documentation":"

The number of training jobs launched by a tuning job that are not improving (1% or less) as measured by model performance evaluated against an objective function.

", - "box":true - }, - "ConvergenceDetectedTime":{ - "shape":"Timestamp", - "documentation":"

The time in timestamp format that AMT detected model convergence, as defined by a lack of significant improvement over time based on criteria developed over a wide range of diverse benchmarking tests.

" - } - }, - "documentation":"

A structure that contains runtime information about both current and completed hyperparameter tuning jobs.

" - }, - "HyperParameterTuningJobConfig":{ - "type":"structure", - "required":[ - "Strategy", - "ResourceLimits" - ], - "members":{ - "Strategy":{ - "shape":"HyperParameterTuningJobStrategyType", - "documentation":"

Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training job it launches. For information about search strategies, see How Hyperparameter Tuning Works.

" - }, - "StrategyConfig":{ - "shape":"HyperParameterTuningJobStrategyConfig", - "documentation":"

The configuration for the Hyperband optimization strategy. This parameter should be provided only if Hyperband is selected as the strategy for HyperParameterTuningJobConfig.

" - }, - "HyperParameterTuningJobObjective":{ - "shape":"HyperParameterTuningJobObjective", - "documentation":"

The HyperParameterTuningJobObjective specifies the objective metric used to evaluate the performance of training jobs launched by this tuning job.

" - }, - "ResourceLimits":{ - "shape":"ResourceLimits", - "documentation":"

The ResourceLimits object that specifies the maximum number of training and parallel training jobs that can be used for this hyperparameter tuning job.

" - }, - "ParameterRanges":{ - "shape":"ParameterRanges", - "documentation":"

The ParameterRanges object that specifies the ranges of hyperparameters that this tuning job searches over to find the optimal configuration for the highest model performance against your chosen objective metric.

" - }, - "TrainingJobEarlyStoppingType":{ - "shape":"TrainingJobEarlyStoppingType", - "documentation":"

Specifies whether to use early stopping for training jobs launched by the hyperparameter tuning job. Because the Hyperband strategy has its own advanced internal early stopping mechanism, TrainingJobEarlyStoppingType must be OFF to use Hyperband. This parameter can take on one of the following values (the default value is OFF):

OFF

Training jobs launched by the hyperparameter tuning job do not use early stopping.

AUTO

SageMaker stops training jobs launched by the hyperparameter tuning job when they are unlikely to perform better than previously completed training jobs. For more information, see Stop Training Jobs Early.

" - }, - "TuningJobCompletionCriteria":{ - "shape":"TuningJobCompletionCriteria", - "documentation":"

The tuning job's completion criteria.

" - }, - "RandomSeed":{ - "shape":"RandomSeed", - "documentation":"

A value used to initialize a pseudo-random number generator. Setting a random seed and using the same seed later for the same tuning job will allow hyperparameter optimization to find more a consistent hyperparameter configuration between the two runs.

" - } - }, - "documentation":"

Configures a hyperparameter tuning job.

" - }, - "HyperParameterTuningJobConsumedResources":{ - "type":"structure", - "members":{ - "RuntimeInSeconds":{ - "shape":"Integer", - "documentation":"

The wall clock runtime in seconds used by your hyperparameter tuning job.

", - "box":true - } - }, - "documentation":"

The total resources consumed by your hyperparameter tuning job.

" - }, - "HyperParameterTuningJobName":{ - "type":"string", - "max":32, - "min":1, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}" - }, - "HyperParameterTuningJobObjective":{ - "type":"structure", - "required":[ - "Type", - "MetricName" - ], - "members":{ - "Type":{ - "shape":"HyperParameterTuningJobObjectiveType", - "documentation":"

Whether to minimize or maximize the objective metric.

" - }, - "MetricName":{ - "shape":"MetricName", - "documentation":"

The name of the metric to use for the objective metric.

" - } - }, - "documentation":"

Defines the objective metric for a hyperparameter tuning job. Hyperparameter tuning uses the value of this metric to evaluate the training jobs it launches, and returns the training job that results in either the highest or lowest value for this metric, depending on the value you specify for the Type parameter. If you want to define a custom objective metric, see Define metrics and environment variables.

" - }, - "HyperParameterTuningJobObjectiveType":{ - "type":"string", - "enum":[ - "Maximize", - "Minimize" - ] - }, - "HyperParameterTuningJobObjectives":{ - "type":"list", - "member":{"shape":"HyperParameterTuningJobObjective"} - }, - "HyperParameterTuningJobSearchEntity":{ - "type":"structure", - "members":{ - "HyperParameterTuningJobName":{ - "shape":"HyperParameterTuningJobName", - "documentation":"

The name of a hyperparameter tuning job.

" - }, - "HyperParameterTuningJobArn":{ - "shape":"HyperParameterTuningJobArn", - "documentation":"

The Amazon Resource Name (ARN) of a hyperparameter tuning job.

" - }, - "HyperParameterTuningJobConfig":{"shape":"HyperParameterTuningJobConfig"}, - "TrainingJobDefinition":{"shape":"HyperParameterTrainingJobDefinition"}, - "TrainingJobDefinitions":{ - "shape":"HyperParameterTrainingJobDefinitions", - "documentation":"

The job definitions included in a hyperparameter tuning job.

" - }, - "HyperParameterTuningJobStatus":{ - "shape":"HyperParameterTuningJobStatus", - "documentation":"

The status of a hyperparameter tuning job.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The time that a hyperparameter tuning job was created.

" - }, - "HyperParameterTuningEndTime":{ - "shape":"Timestamp", - "documentation":"

The time that a hyperparameter tuning job ended.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The time that a hyperparameter tuning job was last modified.

" - }, - "TrainingJobStatusCounters":{"shape":"TrainingJobStatusCounters"}, - "ObjectiveStatusCounters":{"shape":"ObjectiveStatusCounters"}, - "BestTrainingJob":{"shape":"HyperParameterTrainingJobSummary"}, - "OverallBestTrainingJob":{"shape":"HyperParameterTrainingJobSummary"}, - "WarmStartConfig":{"shape":"HyperParameterTuningJobWarmStartConfig"}, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

The error that was created when a hyperparameter tuning job failed.

" - }, - "TuningJobCompletionDetails":{ - "shape":"HyperParameterTuningJobCompletionDetails", - "documentation":"

Information about either a current or completed hyperparameter tuning job.

" - }, - "ConsumedResources":{ - "shape":"HyperParameterTuningJobConsumedResources", - "documentation":"

The total amount of resources consumed by a hyperparameter tuning job.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The tags associated with a hyperparameter tuning job. For more information see Tagging Amazon Web Services resources.

" - } - }, - "documentation":"

An entity returned by the SearchRecord API containing the properties of a hyperparameter tuning job.

" - }, - "HyperParameterTuningJobSortByOptions":{ - "type":"string", - "enum":[ - "Name", - "Status", - "CreationTime" - ] - }, - "HyperParameterTuningJobStatus":{ - "type":"string", - "enum":[ - "Completed", - "InProgress", - "Failed", - "Stopped", - "Stopping", - "Deleting", - "DeleteFailed" - ] - }, - "HyperParameterTuningJobStrategyConfig":{ - "type":"structure", - "members":{ - "HyperbandStrategyConfig":{ - "shape":"HyperbandStrategyConfig", - "documentation":"

The configuration for the object that specifies the Hyperband strategy. This parameter is only supported for the Hyperband selection for Strategy within the HyperParameterTuningJobConfig API.

" - } - }, - "documentation":"

The configuration for a training job launched by a hyperparameter tuning job. Choose Bayesian for Bayesian optimization, and Random for random search optimization. For more advanced use cases, use Hyperband, which evaluates objective metrics for training jobs after every epoch. For more information about strategies, see How Hyperparameter Tuning Works.

" - }, - "HyperParameterTuningJobStrategyType":{ - "type":"string", - "documentation":"

The strategy hyperparameter tuning uses to find the best combination of hyperparameters for your model.

", - "enum":[ - "Bayesian", - "Random", - "Hyperband", - "Grid" - ] - }, - "HyperParameterTuningJobSummaries":{ - "type":"list", - "member":{"shape":"HyperParameterTuningJobSummary"} - }, - "HyperParameterTuningJobSummary":{ - "type":"structure", - "required":[ - "HyperParameterTuningJobName", - "HyperParameterTuningJobArn", - "HyperParameterTuningJobStatus", - "Strategy", - "CreationTime", - "TrainingJobStatusCounters", - "ObjectiveStatusCounters" - ], - "members":{ - "HyperParameterTuningJobName":{ - "shape":"HyperParameterTuningJobName", - "documentation":"

The name of the tuning job.

" - }, - "HyperParameterTuningJobArn":{ - "shape":"HyperParameterTuningJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the tuning job.

" - }, - "HyperParameterTuningJobStatus":{ - "shape":"HyperParameterTuningJobStatus", - "documentation":"

The status of the tuning job.

" - }, - "Strategy":{ - "shape":"HyperParameterTuningJobStrategyType", - "documentation":"

Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to evaluate at each iteration.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The date and time that the tuning job was created.

" - }, - "HyperParameterTuningEndTime":{ - "shape":"Timestamp", - "documentation":"

The date and time that the tuning job ended.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The date and time that the tuning job was modified.

" - }, - "TrainingJobStatusCounters":{ - "shape":"TrainingJobStatusCounters", - "documentation":"

The TrainingJobStatusCounters object that specifies the numbers of training jobs, categorized by status, that this tuning job launched.

" - }, - "ObjectiveStatusCounters":{ - "shape":"ObjectiveStatusCounters", - "documentation":"

The ObjectiveStatusCounters object that specifies the numbers of training jobs, categorized by objective metric status, that this tuning job launched.

" - }, - "ResourceLimits":{ - "shape":"ResourceLimits", - "documentation":"

The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs allowed for this tuning job.

" - } - }, - "documentation":"

Provides summary information about a hyperparameter tuning job.

" - }, - "HyperParameterTuningJobWarmStartConfig":{ - "type":"structure", - "required":[ - "ParentHyperParameterTuningJobs", - "WarmStartType" - ], - "members":{ - "ParentHyperParameterTuningJobs":{ - "shape":"ParentHyperParameterTuningJobs", - "documentation":"

An array of hyperparameter tuning jobs that are used as the starting point for the new hyperparameter tuning job. For more information about warm starting a hyperparameter tuning job, see Using a Previous Hyperparameter Tuning Job as a Starting Point.

Hyperparameter tuning jobs created before October 1, 2018 cannot be used as parent jobs for warm start tuning jobs.

" - }, - "WarmStartType":{ - "shape":"HyperParameterTuningJobWarmStartType", - "documentation":"

Specifies one of the following:

IDENTICAL_DATA_AND_ALGORITHM

The new hyperparameter tuning job uses the same input data and training image as the parent tuning jobs. You can change the hyperparameter ranges to search and the maximum number of training jobs that the hyperparameter tuning job launches. You cannot use a new version of the training algorithm, unless the changes in the new version do not affect the algorithm itself. For example, changes that improve logging or adding support for a different data format are allowed. You can also change hyperparameters from tunable to static, and from static to tunable, but the total number of static plus tunable hyperparameters must remain the same as it is in all parent jobs. The objective metric for the new tuning job must be the same as for all parent jobs.

TRANSFER_LEARNING

The new hyperparameter tuning job can include input data, hyperparameter ranges, maximum number of concurrent training jobs, and maximum number of training jobs that are different than those of its parent hyperparameter tuning jobs. The training image can also be a different version from the version used in the parent hyperparameter tuning job. You can also change hyperparameters from tunable to static, and from static to tunable, but the total number of static plus tunable hyperparameters must remain the same as it is in all parent jobs. The objective metric for the new tuning job must be the same as for all parent jobs.

" - } - }, - "documentation":"

Specifies the configuration for a hyperparameter tuning job that uses one or more previous hyperparameter tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

All training jobs launched by the new hyperparameter tuning job are evaluated by using the objective metric, and the training job that performs the best is compared to the best training jobs from the parent tuning jobs. From these, the training job that performs the best as measured by the objective metric is returned as the overall best training job.

All training jobs launched by parent hyperparameter tuning jobs and the new hyperparameter tuning jobs count against the limit of training jobs for the tuning job.

" - }, - "HyperParameterTuningJobWarmStartType":{ - "type":"string", - "enum":[ - "IdenticalDataAndAlgorithm", - "TransferLearning" - ] - }, - "HyperParameterTuningMaxRuntimeInSeconds":{ - "type":"integer", - "box":true, - "max":15768000, - "min":120 - }, - "HyperParameterTuningResourceConfig":{ - "type":"structure", - "members":{ - "InstanceType":{ - "shape":"TrainingInstanceType", - "documentation":"

The instance type used to run hyperparameter optimization tuning jobs. See descriptions of instance types for more information.

" - }, - "InstanceCount":{ - "shape":"TrainingInstanceCount", - "documentation":"

The number of compute instances of type InstanceType to use. For distributed training, select a value greater than 1.

", - "box":true - }, - "VolumeSizeInGB":{ - "shape":"OptionalVolumeSizeInGB", - "documentation":"

The volume size in GB for the storage volume to be used in processing hyperparameter optimization jobs (optional). These volumes store model artifacts, incremental states and optionally, scratch space for training algorithms. Do not provide a value for this parameter if a value for InstanceConfigs is also specified.

Some instance types have a fixed total local storage size. If you select one of these instances for training, VolumeSizeInGB cannot be greater than this total size. For a list of instance types with local instance storage and their sizes, see instance store volumes.

SageMaker supports only the General Purpose SSD (gp2) storage volume type.

", - "box":true - }, - "VolumeKmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

A key used by Amazon Web Services Key Management Service to encrypt data on the storage volume attached to the compute instances used to run the training job. You can use either of the following formats to specify a key.

KMS Key ID:

\"1234abcd-12ab-34cd-56ef-1234567890ab\"

Amazon Resource Name (ARN) of a KMS key:

\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

Some instances use local storage, which use a hardware module to encrypt storage volumes. If you choose one of these instance types, you cannot request a VolumeKmsKeyId. For a list of instance types that use local storage, see instance store volumes. For more information about Amazon Web Services Key Management Service, see KMS encryption for more information.

" - }, - "AllocationStrategy":{ - "shape":"HyperParameterTuningAllocationStrategy", - "documentation":"

The strategy that determines the order of preference for resources specified in InstanceConfigs used in hyperparameter optimization.

" - }, - "InstanceConfigs":{ - "shape":"HyperParameterTuningInstanceConfigs", - "documentation":"

A list containing the configuration(s) for one or more resources for processing hyperparameter jobs. These resources include compute instances and storage volumes to use in model training jobs launched by hyperparameter tuning jobs. The AllocationStrategy controls the order in which multiple configurations provided in InstanceConfigs are used.

If you only want to use a single instance configuration inside the HyperParameterTuningResourceConfig API, do not provide a value for InstanceConfigs. Instead, use InstanceType, VolumeSizeInGB and InstanceCount. If you use InstanceConfigs, do not provide values for InstanceType, VolumeSizeInGB or InstanceCount.

" - } - }, - "documentation":"

The configuration of resources, including compute instances and storage volumes for use in training jobs launched by hyperparameter tuning jobs. HyperParameterTuningResourceConfig is similar to ResourceConfig, but has the additional InstanceConfigs and AllocationStrategy fields to allow for flexible instance management. Specify one or more instance types, count, and the allocation strategy for instance selection.

HyperParameterTuningResourceConfig supports the capabilities of ResourceConfig with the exception of KeepAlivePeriodInSeconds. Hyperparameter tuning jobs use warm pools by default, which reuse clusters between training jobs.

" - }, - "HyperParameterValue":{ - "type":"string", - "max":2500, - "min":0, - "pattern":".*" - }, - "HyperParameters":{ - "type":"map", - "key":{"shape":"HyperParameterKey"}, - "value":{"shape":"HyperParameterValue"}, - "max":100, - "min":0 - }, - "HyperbandStrategyConfig":{ - "type":"structure", - "members":{ - "MinResource":{ - "shape":"HyperbandStrategyMinResource", - "documentation":"

The minimum number of resources (such as epochs) that can be used by a training job launched by a hyperparameter tuning job. If the value for MinResource has not been reached, the training job is not stopped by Hyperband.

" - }, - "MaxResource":{ - "shape":"HyperbandStrategyMaxResource", - "documentation":"

The maximum number of resources (such as epochs) that can be used by a training job launched by a hyperparameter tuning job. Once a job reaches the MaxResource value, it is stopped. If a value for MaxResource is not provided, and Hyperband is selected as the hyperparameter tuning strategy, HyperbandTraining attempts to infer MaxResource from the following keys (if present) in StaticsHyperParameters:

  • epochs

  • numepochs

  • n-epochs

  • n_epochs

  • num_epochs

If HyperbandStrategyConfig is unable to infer a value for MaxResource, it generates a validation error. The maximum value is 20,000 epochs. All metrics that correspond to an objective metric are used to derive early stopping decisions. For distributed training jobs, ensure that duplicate metrics are not printed in the logs across the individual nodes in a training job. If multiple nodes are publishing duplicate or incorrect metrics, training jobs may make an incorrect stopping decision and stop the job prematurely.

" - } - }, - "documentation":"

The configuration for Hyperband, a multi-fidelity based hyperparameter tuning strategy. Hyperband uses the final and intermediate results of a training job to dynamically allocate resources to utilized hyperparameter configurations while automatically stopping under-performing configurations. This parameter should be provided only if Hyperband is selected as the StrategyConfig under the HyperParameterTuningJobConfig API.

" - }, - "HyperbandStrategyMaxResource":{ - "type":"integer", - "box":true, - "min":1 - }, - "HyperbandStrategyMinResource":{ - "type":"integer", - "box":true, - "min":1 - }, - "IPAddressType":{ - "type":"string", - "enum":[ - "ipv4", - "dualstack" - ] - }, - "IamIdentity":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"String", - "documentation":"

The Amazon Resource Name (ARN) of the IAM identity.

" - }, - "PrincipalId":{ - "shape":"String", - "documentation":"

The ID of the principal that assumes the IAM identity.

" - }, - "SourceIdentity":{ - "shape":"String", - "documentation":"

The person or application which assumes the IAM identity.

" - } - }, - "documentation":"

The IAM Identity details associated with the user. These details are associated with model package groups, model packages and project entities only.

" - }, - "IamPolicyConstraints":{ - "type":"structure", - "members":{ - "SourceIp":{ - "shape":"EnabledOrDisabled", - "documentation":"

When SourceIp is Enabled the worker's IP address when a task is rendered in the worker portal is added to the IAM policy as a Condition used to generate the Amazon S3 presigned URL. This IP address is checked by Amazon S3 and must match in order for the Amazon S3 resource to be rendered in the worker portal.

" - }, - "VpcSourceIp":{ - "shape":"EnabledOrDisabled", - "documentation":"

When VpcSourceIp is Enabled the worker's IP address when a task is rendered in private worker portal inside the VPC is added to the IAM policy as a Condition used to generate the Amazon S3 presigned URL. To render the task successfully Amazon S3 checks that the presigned URL is being accessed over an Amazon S3 VPC Endpoint, and that the worker's IP address matches the IP address in the IAM policy. To learn more about configuring private worker portal, see Use Amazon VPC mode from a private worker portal.

" - } - }, - "documentation":"

Use this parameter to specify a supported global condition key that is added to the IAM policy.

" - }, - "IdempotencyToken":{ - "type":"string", - "max":128, - "min":32 - }, - "IdentityProviderOAuthSetting":{ - "type":"structure", - "members":{ - "DataSourceName":{ - "shape":"DataSourceName", - "documentation":"

The name of the data source that you're connecting to. Canvas currently supports OAuth for Snowflake and Salesforce Data Cloud.

" - }, - "Status":{ - "shape":"FeatureStatus", - "documentation":"

Describes whether OAuth for a data source is enabled or disabled in the Canvas application.

" - }, - "SecretArn":{ - "shape":"SecretArn", - "documentation":"

The ARN of an Amazon Web Services Secrets Manager secret that stores the credentials from your identity provider, such as the client ID and secret, authorization URL, and token URL.

" - } - }, - "documentation":"

The Amazon SageMaker Canvas application setting where you configure OAuth for connecting to an external data source, such as Snowflake.

" - }, - "IdentityProviderOAuthSettings":{ - "type":"list", - "member":{"shape":"IdentityProviderOAuthSetting"}, - "max":20, - "min":0 - }, - "IdleResourceSharing":{ - "type":"string", - "enum":[ - "Enabled", - "Disabled" - ] - }, - "IdleSettings":{ - "type":"structure", - "members":{ - "LifecycleManagement":{ - "shape":"LifecycleManagement", - "documentation":"

Indicates whether idle shutdown is activated for the application type.

" - }, - "IdleTimeoutInMinutes":{ - "shape":"IdleTimeoutInMinutes", - "documentation":"

The time that SageMaker waits after the application becomes idle before shutting it down.

" - }, - "MinIdleTimeoutInMinutes":{ - "shape":"IdleTimeoutInMinutes", - "documentation":"

The minimum value in minutes that custom idle shutdown can be set to by the user.

" - }, - "MaxIdleTimeoutInMinutes":{ - "shape":"IdleTimeoutInMinutes", - "documentation":"

The maximum value in minutes that custom idle shutdown can be set to by the user.

" - } - }, - "documentation":"

Settings related to idle shutdown of Studio applications.

" - }, - "IdleTimeoutInMinutes":{ - "type":"integer", - "box":true, - "max":525600, - "min":60 - }, - "Image":{ - "type":"structure", - "required":[ - "CreationTime", - "ImageArn", - "ImageName", - "ImageStatus", - "LastModifiedTime" - ], - "members":{ - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

When the image was created.

" - }, - "Description":{ - "shape":"ImageDescription", - "documentation":"

The description of the image.

" - }, - "DisplayName":{ - "shape":"ImageDisplayName", - "documentation":"

The name of the image as displayed.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

When a create, update, or delete operation fails, the reason for the failure.

" - }, - "ImageArn":{ - "shape":"ImageArn", - "documentation":"

The ARN of the image.

" - }, - "ImageName":{ - "shape":"ImageName", - "documentation":"

The name of the image.

" - }, - "ImageStatus":{ - "shape":"ImageStatus", - "documentation":"

The status of the image.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

When the image was last modified.

" - } - }, - "documentation":"

A SageMaker AI image. A SageMaker AI image represents a set of container images that are derived from a common base container image. Each of these container images is represented by a SageMaker AI ImageVersion.

" - }, - "ImageArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-zA-Z0-9]([-.]?[a-zA-Z0-9])*" - }, - "ImageBaseImage":{ - "type":"string", - "max":255, - "min":1, - "pattern":".*" - }, - "ImageClassificationJobConfig":{ - "type":"structure", - "members":{ - "CompletionCriteria":{ - "shape":"AutoMLJobCompletionCriteria", - "documentation":"

How long a job is allowed to run, or how many candidates a job is allowed to generate.

" - } - }, - "documentation":"

The collection of settings used by an AutoML job V2 for the image classification problem type.

" - }, - "ImageConfig":{ - "type":"structure", - "required":["RepositoryAccessMode"], - "members":{ - "RepositoryAccessMode":{ - "shape":"RepositoryAccessMode", - "documentation":"

Set this to one of the following values:

  • Platform - The model image is hosted in Amazon ECR.

  • Vpc - The model image is hosted in a private Docker registry in your VPC.

" - }, - "RepositoryAuthConfig":{ - "shape":"RepositoryAuthConfig", - "documentation":"

(Optional) Specifies an authentication configuration for the private docker registry where your model image is hosted. Specify a value for this property only if you specified Vpc as the value for the RepositoryAccessMode field, and the private Docker registry where the model image is hosted requires authentication.

" - } - }, - "documentation":"

Specifies whether the model container is in Amazon ECR or a private Docker registry accessible from your Amazon Virtual Private Cloud (VPC).

" - }, - "ImageContainerImage":{ - "type":"string", - "max":255, - "min":1 - }, - "ImageDeleteProperty":{ - "type":"string", - "max":11, - "min":1, - "pattern":"(^DisplayName$)|(^Description$)" - }, - "ImageDeletePropertyList":{ - "type":"list", - "member":{"shape":"ImageDeleteProperty"}, - "max":2, - "min":0 - }, - "ImageDescription":{ - "type":"string", - "max":512, - "min":1, - "pattern":".*" - }, - "ImageDigest":{ - "type":"string", - "max":72, - "min":0, - "pattern":"[Ss][Hh][Aa]256:[0-9a-fA-F]{64}" - }, - "ImageDisplayName":{ - "type":"string", - "max":128, - "min":1, - "pattern":"\\S(.*\\S)?" - }, - "ImageId":{ - "type":"string", - "max":21, - "min":7, - "pattern":"ami-[0-9a-fA-F]{8,17}|default" - }, - "ImageName":{ - "type":"string", - "max":63, - "min":1, - "pattern":"[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}" - }, - "ImageNameContains":{ - "type":"string", - "max":63, - "min":0, - "pattern":"[a-zA-Z0-9\\-.]+" - }, - "ImageReleaseVersion":{ - "type":"string", - "max":64, - "min":0, - "pattern":"[0-9]+\\.[0-9]+\\.[0-9]+" - }, - "ImageSortBy":{ - "type":"string", - "enum":[ - "CREATION_TIME", - "LAST_MODIFIED_TIME", - "IMAGE_NAME" - ] - }, - "ImageSortOrder":{ - "type":"string", - "enum":[ - "ASCENDING", - "DESCENDING" - ] - }, - "ImageStatus":{ - "type":"string", - "enum":[ - "CREATING", - "CREATED", - "CREATE_FAILED", - "UPDATING", - "UPDATE_FAILED", - "DELETING", - "DELETE_FAILED" - ] - }, - "ImageUri":{ - "type":"string", - "max":255, - "min":0, - "pattern":".*" - }, - "ImageVersion":{ - "type":"structure", - "required":[ - "CreationTime", - "ImageArn", - "ImageVersionArn", - "ImageVersionStatus", - "LastModifiedTime", - "Version" - ], - "members":{ - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

When the version was created.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

When a create or delete operation fails, the reason for the failure.

" - }, - "ImageArn":{ - "shape":"ImageArn", - "documentation":"

The ARN of the image the version is based on.

" - }, - "ImageVersionArn":{ - "shape":"ImageVersionArn", - "documentation":"

The ARN of the version.

" - }, - "ImageVersionStatus":{ - "shape":"ImageVersionStatus", - "documentation":"

The status of the version.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

When the version was last modified.

" - }, - "Version":{ - "shape":"ImageVersionNumber", - "documentation":"

The version number.

" - } - }, - "documentation":"

A version of a SageMaker AI Image. A version represents an existing container image.

" - }, - "ImageVersionAlias":{ - "type":"string", - "max":128, - "min":1, - "pattern":"(^\\d+$)|(^\\d+.\\d+$)|(^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$)" - }, - "ImageVersionAliasPattern":{ - "type":"string", - "max":128, - "min":1, - "pattern":"(0|[1-9]\\d*)\\.(0|[1-9]\\d*)" - }, - "ImageVersionArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"(arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+|None)" - }, - "ImageVersionNumber":{ - "type":"integer", - "box":true, - "min":0 - }, - "ImageVersionSortBy":{ - "type":"string", - "enum":[ - "CREATION_TIME", - "LAST_MODIFIED_TIME", - "VERSION" - ] - }, - "ImageVersionSortOrder":{ - "type":"string", - "enum":[ - "ASCENDING", - "DESCENDING" - ] - }, - "ImageVersionStatus":{ - "type":"string", - "enum":[ - "CREATING", - "CREATED", - "CREATE_FAILED", - "DELETING", - "DELETE_FAILED" - ] - }, - "ImageVersions":{ - "type":"list", - "member":{"shape":"ImageVersion"} - }, - "Images":{ - "type":"list", - "member":{"shape":"Image"} - }, - "ImportHubContentRequest":{ - "type":"structure", - "required":[ - "HubContentName", - "HubContentType", - "DocumentSchemaVersion", - "HubName", - "HubContentDocument" - ], - "members":{ - "HubContentName":{ - "shape":"HubContentName", - "documentation":"

The name of the hub content to import.

" - }, - "HubContentVersion":{ - "shape":"HubContentVersion", - "documentation":"

The version of the hub content to import.

" - }, - "HubContentType":{ - "shape":"HubContentType", - "documentation":"

The type of hub content to import.

" - }, - "DocumentSchemaVersion":{ - "shape":"DocumentSchemaVersion", - "documentation":"

The version of the hub content schema to import.

" - }, - "HubName":{ - "shape":"HubNameOrArn", - "documentation":"

The name of the hub to import content into.

" - }, - "HubContentDisplayName":{ - "shape":"HubContentDisplayName", - "documentation":"

The display name of the hub content to import.

" - }, - "HubContentDescription":{ - "shape":"HubContentDescription", - "documentation":"

A description of the hub content to import.

" - }, - "HubContentMarkdown":{ - "shape":"HubContentMarkdown", - "documentation":"

A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.

" - }, - "HubContentDocument":{ - "shape":"HubContentDocument", - "documentation":"

The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.

" - }, - "SupportStatus":{ - "shape":"HubContentSupportStatus", - "documentation":"

The status of the hub content resource.

" - }, - "HubContentSearchKeywords":{ - "shape":"HubContentSearchKeywordList", - "documentation":"

The searchable keywords of the hub content.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

Any tags associated with the hub content.

" - } - } - }, - "ImportHubContentResponse":{ - "type":"structure", - "required":[ - "HubArn", - "HubContentArn" - ], - "members":{ - "HubArn":{ - "shape":"HubArn", - "documentation":"

The ARN of the hub that the content was imported into.

" - }, - "HubContentArn":{ - "shape":"HubContentArn", - "documentation":"

The ARN of the hub content that was imported.

" - } - } - }, - "InUseInstanceCount":{ - "type":"integer", - "box":true, - "min":0 - }, - "IncludeNodeLogicalIdsBoolean":{ - "type":"boolean", - "box":true - }, - "IncludedData":{ - "type":"string", - "enum":[ - "AllData", - "MetadataOnly" - ] - }, - "InferenceComponentArn":{ - "type":"string", - "max":2048, - "min":20 - }, - "InferenceComponentAvailabilityZoneBalance":{ - "type":"structure", - "required":["EnforcementMode"], - "members":{ - "EnforcementMode":{ - "shape":"AvailabilityZoneBalanceEnforcementMode", - "documentation":"

Determines how strictly the Availability Zone balance constraint is enforced.

PERMISSIVE

The endpoint attempts to balance copies across Availability Zones but proceeds with scheduling even if balance can't be achieved due to available capacity or instance distribution across Availability Zones.

" - }, - "MaxImbalance":{ - "shape":"AvailabilityZoneBalanceMaxImbalance", - "documentation":"

The maximum allowed difference in the number of inference component copies between any two Availability Zones. This parameter applies only when the endpoint has instances across two or more Availability Zones. A copy placement is allowed if it reduces imbalance or the resulting imbalance is within this value.

Default value: 0.

" - } - }, - "documentation":"

Configuration for balancing inference component copies across Availability Zones.

" - }, - "InferenceComponentCapacitySize":{ - "type":"structure", - "required":[ - "Type", - "Value" - ], - "members":{ - "Type":{ - "shape":"InferenceComponentCapacitySizeType", - "documentation":"

Specifies the endpoint capacity type.

COPY_COUNT

The endpoint activates based on the number of inference component copies.

CAPACITY_PERCENT

The endpoint activates based on the specified percentage of capacity.

" - }, - "Value":{ - "shape":"CapacitySizeValue", - "documentation":"

Defines the capacity size, either as a number of inference component copies or a capacity percentage.

" - } - }, - "documentation":"

Specifies the type and size of the endpoint capacity to activate for a rolling deployment or a rollback strategy. You can specify your batches as either of the following:

  • A count of inference component copies

  • The overall percentage or your fleet

For a rollback strategy, if you don't specify the fields in this object, or if you set the Value parameter to 100%, then SageMaker AI uses a blue/green rollback strategy and rolls all traffic back to the blue fleet.

" - }, - "InferenceComponentCapacitySizeType":{ - "type":"string", - "enum":[ - "COPY_COUNT", - "CAPACITY_PERCENT" - ] - }, - "InferenceComponentComputeResourceRequirements":{ - "type":"structure", - "required":["MinMemoryRequiredInMb"], - "members":{ - "NumberOfCpuCoresRequired":{ - "shape":"NumberOfCpuCores", - "documentation":"

The number of CPU cores to allocate to run a model that you assign to an inference component.

" - }, - "NumberOfAcceleratorDevicesRequired":{ - "shape":"NumberOfAcceleratorDevices", - "documentation":"

The number of accelerators to allocate to run a model that you assign to an inference component. Accelerators include GPUs and Amazon Web Services Inferentia.

" - }, - "MinMemoryRequiredInMb":{ - "shape":"MemoryInMb", - "documentation":"

The minimum MB of memory to allocate to run a model that you assign to an inference component.

" - }, - "MaxMemoryRequiredInMb":{ - "shape":"MemoryInMb", - "documentation":"

The maximum MB of memory to allocate to run a model that you assign to an inference component.

" - } - }, - "documentation":"

Defines the compute resources to allocate to run a model, plus any adapter models, that you assign to an inference component. These resources include CPU cores, accelerators, and memory.

" - }, - "InferenceComponentContainerSpecification":{ - "type":"structure", - "members":{ - "Image":{ - "shape":"ContainerImage", - "documentation":"

The Amazon Elastic Container Registry (Amazon ECR) path where the Docker image for the model is stored.

" - }, - "ArtifactUrl":{ - "shape":"Url", - "documentation":"

The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

" - }, - "Environment":{ - "shape":"EnvironmentMap", - "documentation":"

The environment variables to set in the Docker container. Each key and value in the Environment string-to-string map can have length of up to 1024. We support up to 16 entries in the map.

" - }, - "ContainerMetricsConfig":{ - "shape":"ContainerMetricsConfig", - "documentation":"

The configuration for container metrics scraping. Specifies the metrics endpoint path and publishing frequency for the inference component's container. If not specified when EnableDetailedObservability is True, the default path /metrics on port 8080 is used. For first-party and Deep Learning Containers (DLC), the endpoint path is determined automatically and this configuration is optional.

" - } - }, - "documentation":"

Defines a container that provides the runtime environment for a model that you deploy with an inference component.

" - }, - "InferenceComponentContainerSpecificationSummary":{ - "type":"structure", - "members":{ - "DeployedImage":{"shape":"DeployedImage"}, - "ArtifactUrl":{ - "shape":"Url", - "documentation":"

The Amazon S3 path where the model artifacts are stored.

" - }, - "Environment":{ - "shape":"EnvironmentMap", - "documentation":"

The environment variables to set in the Docker container.

" - }, - "ContainerMetricsConfig":{ - "shape":"ContainerMetricsConfig", - "documentation":"

The container metrics scraping configuration for this inference component, including the metrics endpoint path and publishing frequency.

" - } - }, - "documentation":"

Details about the resources that are deployed with this inference component.

" - }, - "InferenceComponentCopyCount":{ - "type":"integer", - "box":true, - "min":0 - }, - "InferenceComponentDataCacheConfig":{ - "type":"structure", - "required":["EnableCaching"], - "members":{ - "EnableCaching":{ - "shape":"EnableCaching", - "documentation":"

Sets whether the endpoint that hosts the inference component caches the model artifacts and container image.

With caching enabled, the endpoint caches this data in each instance that it provisions for the inference component. That way, the inference component deploys faster during the auto scaling process. If caching isn't enabled, the inference component takes longer to deploy because of the time it spends downloading the data.

", - "box":true - } - }, - "documentation":"

Settings that affect how the inference component caches data.

" - }, - "InferenceComponentDataCacheConfigSummary":{ - "type":"structure", - "required":["EnableCaching"], - "members":{ - "EnableCaching":{ - "shape":"EnableCaching", - "documentation":"

Indicates whether the inference component caches model artifacts as part of the auto scaling process.

", - "box":true - } - }, - "documentation":"

Settings that affect how the inference component caches data.

" - }, - "InferenceComponentDeploymentConfig":{ - "type":"structure", - "required":["RollingUpdatePolicy"], - "members":{ - "RollingUpdatePolicy":{ - "shape":"InferenceComponentRollingUpdatePolicy", - "documentation":"

Specifies a rolling deployment strategy for updating a SageMaker AI endpoint.

" - }, - "AutoRollbackConfiguration":{"shape":"AutoRollbackConfig"} - }, - "documentation":"

The deployment configuration for an endpoint that hosts inference components. The configuration includes the desired deployment strategy and rollback settings.

" - }, - "InferenceComponentMetadata":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"String2048", - "documentation":"

The Amazon Resource Name (ARN) of the inference component.

" - } - }, - "documentation":"

The metadata of the inference component.

" - }, - "InferenceComponentName":{ - "type":"string", - "max":63, - "min":0, - "pattern":"[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?" - }, - "InferenceComponentNameContains":{ - "type":"string", - "max":63, - "min":0, - "pattern":"[a-zA-Z0-9-]+" - }, - "InferenceComponentPlacementStatus":{ - "type":"structure", - "required":[ - "InstanceType", - "CurrentCopyCount" - ], - "members":{ - "InstanceType":{ - "shape":"ProductionVariantInstanceType", - "documentation":"

The ML compute instance type where the inference component copies are placed.

" - }, - "CurrentCopyCount":{ - "shape":"InferenceComponentCopyCount", - "documentation":"

The number of inference component copies currently placed on instances of this type.

" - } - }, - "documentation":"

The placement status of an inference component on a specific instance type. Shows the number of inference component copies currently placed on instances of a given type.

" - }, - "InferenceComponentPlacementStatusList":{ - "type":"list", - "member":{"shape":"InferenceComponentPlacementStatus"}, - "min":1 - }, - "InferenceComponentPlacementStrategy":{ - "type":"string", - "enum":[ - "SPREAD", - "BINPACK" - ] - }, - "InferenceComponentRollingUpdatePolicy":{ - "type":"structure", - "required":[ - "MaximumBatchSize", - "WaitIntervalInSeconds" - ], - "members":{ - "MaximumBatchSize":{ - "shape":"InferenceComponentCapacitySize", - "documentation":"

The batch size for each rolling step in the deployment process. For each step, SageMaker AI provisions capacity on the new endpoint fleet, routes traffic to that fleet, and terminates capacity on the old endpoint fleet. The value must be between 5% to 50% of the copy count of the inference component.

" - }, - "WaitIntervalInSeconds":{ - "shape":"WaitIntervalInSeconds", - "documentation":"

The length of the baking period, during which SageMaker AI monitors alarms for each batch on the new fleet.

" - }, - "MaximumExecutionTimeoutInSeconds":{ - "shape":"MaximumExecutionTimeoutInSeconds", - "documentation":"

The time limit for the total deployment. Exceeding this limit causes a timeout.

" - }, - "RollbackMaximumBatchSize":{ - "shape":"InferenceComponentCapacitySize", - "documentation":"

The batch size for a rollback to the old endpoint fleet. If this field is absent, the value is set to the default, which is 100% of the total capacity. When the default is used, SageMaker AI provisions the entire capacity of the old fleet at once during rollback.

" - } - }, - "documentation":"

Specifies a rolling deployment strategy for updating a SageMaker AI inference component.

" - }, - "InferenceComponentRuntimeConfig":{ - "type":"structure", - "required":["CopyCount"], - "members":{ - "CopyCount":{ - "shape":"InferenceComponentCopyCount", - "documentation":"

The number of runtime copies of the model container to deploy with the inference component. Each copy can serve inference requests.

" - } - }, - "documentation":"

Runtime settings for a model that is deployed with an inference component.

" - }, - "InferenceComponentRuntimeConfigSummary":{ - "type":"structure", - "members":{ - "DesiredCopyCount":{ - "shape":"InferenceComponentCopyCount", - "documentation":"

The number of runtime copies of the model container that you requested to deploy with the inference component.

" - }, - "CurrentCopyCount":{ - "shape":"InferenceComponentCopyCount", - "documentation":"

The number of runtime copies of the model container that are currently deployed.

" - }, - "PlacementStatus":{ - "shape":"InferenceComponentPlacementStatusList", - "documentation":"

The placement status of the inference component across instance types. Shows how the inference component copies are distributed across instance types.

" - } - }, - "documentation":"

Details about the runtime settings for the model that is deployed with the inference component.

" - }, - "InferenceComponentSchedulingConfig":{ - "type":"structure", - "required":["PlacementStrategy"], - "members":{ - "PlacementStrategy":{ - "shape":"InferenceComponentPlacementStrategy", - "documentation":"

The strategy for placing inference component copies across available instances. If you also set AvailabilityZoneBalance, this strategy applies to placement within each Availability Zone.

SPREAD

Distributes copies evenly across available instances for better resilience.

BINPACK

Packs copies onto fewer instances to optimize resource utilization.

" - }, - "AvailabilityZoneBalance":{ - "shape":"InferenceComponentAvailabilityZoneBalance", - "documentation":"

Configuration for balancing inference component copies across Availability Zones.

" - } - }, - "documentation":"

The scheduling configuration that determines how inference component copies are placed across available instances when copies are added or removed.

" - }, - "InferenceComponentSortKey":{ - "type":"string", - "enum":[ - "Name", - "CreationTime", - "Status" - ] - }, - "InferenceComponentSpecification":{ - "type":"structure", - "members":{ - "InstanceType":{ - "shape":"ProductionVariantInstanceType", - "documentation":"

The ML compute instance type for the inference component specification. Specifies which instance type this specification applies to. Required when using the Specifications parameter with multiple entries.

" - }, - "ModelName":{ - "shape":"ModelName", - "documentation":"

The name of an existing SageMaker AI model object in your account that you want to deploy with the inference component.

" - }, - "Container":{ - "shape":"InferenceComponentContainerSpecification", - "documentation":"

Defines a container that provides the runtime environment for a model that you deploy with an inference component.

" - }, - "StartupParameters":{ - "shape":"InferenceComponentStartupParameters", - "documentation":"

Settings that take effect while the model container starts up.

" - }, - "ComputeResourceRequirements":{ - "shape":"InferenceComponentComputeResourceRequirements", - "documentation":"

The compute resources allocated to run the model, plus any adapter models, that you assign to the inference component.

Omit this parameter if your request is meant to create an adapter inference component. An adapter inference component is loaded by a base inference component, and it uses the compute resources of the base inference component.

" - }, - "BaseInferenceComponentName":{ - "shape":"InferenceComponentName", - "documentation":"

The name of an existing inference component that is to contain the inference component that you're creating with your request.

Specify this parameter only if your request is meant to create an adapter inference component. An adapter inference component contains the path to an adapter model. The purpose of the adapter model is to tailor the inference output of a base foundation model, which is hosted by the base inference component. The adapter inference component uses the compute resources that you assigned to the base inference component.

When you create an adapter inference component, use the Container parameter to specify the location of the adapter artifacts. In the parameter value, use the ArtifactUrl parameter of the InferenceComponentContainerSpecification data type.

Before you can create an adapter inference component, you must have an existing inference component that contains the foundation model that you want to adapt.

" - }, - "DataCacheConfig":{ - "shape":"InferenceComponentDataCacheConfig", - "documentation":"

Settings that affect how the inference component caches data.

" - }, - "SchedulingConfig":{ - "shape":"InferenceComponentSchedulingConfig", - "documentation":"

The scheduling configuration that determines how inference component copies are placed across available instances when copies are added or removed.

" - } - }, - "documentation":"

Details about the resources to deploy with this inference component, including the model, container, and compute resources.

" - }, - "InferenceComponentSpecificationList":{ - "type":"list", - "member":{"shape":"InferenceComponentSpecification"}, - "max":5, - "min":1 - }, - "InferenceComponentSpecificationSummary":{ - "type":"structure", - "members":{ - "InstanceType":{ - "shape":"ProductionVariantInstanceType", - "documentation":"

The ML compute instance type associated with this inference component specification.

" - }, - "ModelName":{ - "shape":"ModelName", - "documentation":"

The name of the SageMaker AI model object that is deployed with the inference component.

" - }, - "Container":{ - "shape":"InferenceComponentContainerSpecificationSummary", - "documentation":"

Details about the container that provides the runtime environment for the model that is deployed with the inference component.

" - }, - "StartupParameters":{ - "shape":"InferenceComponentStartupParameters", - "documentation":"

Settings that take effect while the model container starts up.

" - }, - "ComputeResourceRequirements":{ - "shape":"InferenceComponentComputeResourceRequirements", - "documentation":"

The compute resources allocated to run the model, plus any adapter models, that you assign to the inference component.

" - }, - "BaseInferenceComponentName":{ - "shape":"InferenceComponentName", - "documentation":"

The name of the base inference component that contains this inference component.

" - }, - "DataCacheConfig":{ - "shape":"InferenceComponentDataCacheConfigSummary", - "documentation":"

Settings that affect how the inference component caches data.

" - }, - "SchedulingConfig":{ - "shape":"InferenceComponentSchedulingConfig", - "documentation":"

The scheduling configuration that determines how inference component copies are placed across available instances when copies are added or removed.

" - } - }, - "documentation":"

Details about the resources that are deployed with this inference component.

" - }, - "InferenceComponentSpecificationSummaryList":{ - "type":"list", - "member":{"shape":"InferenceComponentSpecificationSummary"}, - "min":1 - }, - "InferenceComponentStartupParameters":{ - "type":"structure", - "members":{ - "ModelDataDownloadTimeoutInSeconds":{ - "shape":"ProductionVariantModelDataDownloadTimeoutInSeconds", - "documentation":"

The timeout value, in seconds, to download and extract the model that you want to host from Amazon S3 to the individual inference instance associated with this inference component.

" - }, - "ContainerStartupHealthCheckTimeoutInSeconds":{ - "shape":"ProductionVariantContainerStartupHealthCheckTimeoutInSeconds", - "documentation":"

The timeout value, in seconds, for your inference container to pass health check by Amazon S3 Hosting. For more information about health check, see How Your Container Should Respond to Health Check (Ping) Requests.

" - } - }, - "documentation":"

Settings that take effect while the model container starts up.

" - }, - "InferenceComponentStatus":{ - "type":"string", - "enum":[ - "InService", - "Creating", - "Updating", - "Failed", - "Deleting" - ] - }, - "InferenceComponentSummary":{ - "type":"structure", - "required":[ - "CreationTime", - "InferenceComponentArn", - "InferenceComponentName", - "EndpointArn", - "EndpointName", - "VariantName", - "LastModifiedTime" - ], - "members":{ - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The time when the inference component was created.

" - }, - "InferenceComponentArn":{ - "shape":"InferenceComponentArn", - "documentation":"

The Amazon Resource Name (ARN) of the inference component.

" - }, - "InferenceComponentName":{ - "shape":"InferenceComponentName", - "documentation":"

The name of the inference component.

" - }, - "EndpointArn":{ - "shape":"EndpointArn", - "documentation":"

The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.

" - }, - "EndpointName":{ - "shape":"EndpointName", - "documentation":"

The name of the endpoint that hosts the inference component.

" - }, - "VariantName":{ - "shape":"VariantName", - "documentation":"

The name of the production variant that hosts the inference component.

" - }, - "InferenceComponentStatus":{ - "shape":"InferenceComponentStatus", - "documentation":"

The status of the inference component.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The time when the inference component was last updated.

" - } - }, - "documentation":"

A summary of the properties of an inference component.

" - }, - "InferenceComponentSummaryList":{ - "type":"list", - "member":{"shape":"InferenceComponentSummary"} - }, - "InferenceExecutionConfig":{ - "type":"structure", - "required":["Mode"], - "members":{ - "Mode":{ - "shape":"InferenceExecutionMode", - "documentation":"

How containers in a multi-container are run. The following values are valid.

  • SERIAL - Containers run as a serial pipeline.

  • DIRECT - Only the individual container that you specify is run.

" - } - }, - "documentation":"

Specifies details about how containers in a multi-container endpoint are run.

" - }, - "InferenceExecutionMode":{ - "type":"string", - "enum":[ - "Serial", - "Direct" - ] - }, - "InferenceExperimentArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:inference-experiment/.*" - }, - "InferenceExperimentDataStorageConfig":{ - "type":"structure", - "required":["Destination"], - "members":{ - "Destination":{ - "shape":"DestinationS3Uri", - "documentation":"

The Amazon S3 bucket where the inference request and response data is stored.

" - }, - "KmsKey":{ - "shape":"KmsKeyId", - "documentation":"

The Amazon Web Services Key Management Service key that Amazon SageMaker uses to encrypt captured data at rest using Amazon S3 server-side encryption.

" - }, - "ContentType":{"shape":"CaptureContentTypeHeader"} - }, - "documentation":"

The Amazon S3 location and configuration for storing inference request and response data.

" - }, - "InferenceExperimentDescription":{ - "type":"string", - "max":1024, - "min":0, - "pattern":".*" - }, - "InferenceExperimentList":{ - "type":"list", - "member":{"shape":"InferenceExperimentSummary"} - }, - "InferenceExperimentName":{ - "type":"string", - "max":120, - "min":1, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}" - }, - "InferenceExperimentSchedule":{ - "type":"structure", - "members":{ - "StartTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp at which the inference experiment started or will start.

" - }, - "EndTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp at which the inference experiment ended or will end.

" - } - }, - "documentation":"

The start and end times of an inference experiment.

The maximum duration that you can set for an inference experiment is 30 days.

" - }, - "InferenceExperimentStatus":{ - "type":"string", - "enum":[ - "Creating", - "Created", - "Updating", - "Running", - "Starting", - "Stopping", - "Completed", - "Cancelled" - ] - }, - "InferenceExperimentStatusReason":{ - "type":"string", - "max":1024, - "min":0, - "pattern":".*" - }, - "InferenceExperimentStopDesiredState":{ - "type":"string", - "enum":[ - "Completed", - "Cancelled" - ] - }, - "InferenceExperimentSummary":{ - "type":"structure", - "required":[ - "Name", - "Type", - "Status", - "CreationTime", - "LastModifiedTime" - ], - "members":{ - "Name":{ - "shape":"InferenceExperimentName", - "documentation":"

The name of the inference experiment.

" - }, - "Type":{ - "shape":"InferenceExperimentType", - "documentation":"

The type of the inference experiment.

" - }, - "Schedule":{ - "shape":"InferenceExperimentSchedule", - "documentation":"

The duration for which the inference experiment ran or will run.

The maximum duration that you can set for an inference experiment is 30 days.

" - }, - "Status":{ - "shape":"InferenceExperimentStatus", - "documentation":"

The status of the inference experiment.

" - }, - "StatusReason":{ - "shape":"InferenceExperimentStatusReason", - "documentation":"

The error message for the inference experiment status result.

" - }, - "Description":{ - "shape":"InferenceExperimentDescription", - "documentation":"

The description of the inference experiment.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp at which the inference experiment was created.

" - }, - "CompletionTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp at which the inference experiment was completed.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The timestamp when you last modified the inference experiment.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.

" - } - }, - "documentation":"

Lists a summary of properties of an inference experiment.

" - }, - "InferenceExperimentType":{ - "type":"string", - "enum":["ShadowMode"] - }, - "InferenceHubAccessConfig":{ - "type":"structure", - "required":["HubContentArn"], - "members":{ - "HubContentArn":{ - "shape":"HubContentArn", - "documentation":"

The ARN of the hub content for which deployment access is allowed.

" - } - }, - "documentation":"

Configuration information specifying which hub contents have accessible deployment options.

" - }, - "InferenceImage":{ - "type":"string", - "max":256, - "min":0 - }, - "InferenceMetrics":{ - "type":"structure", - "required":[ - "MaxInvocations", - "ModelLatency" - ], - "members":{ - "MaxInvocations":{ - "shape":"Integer", - "documentation":"

The expected maximum number of requests per minute for the instance.

", - "box":true - }, - "ModelLatency":{ - "shape":"Integer", - "documentation":"

The expected model latency at maximum invocations per minute for the instance.

", - "box":true - } - }, - "documentation":"

The metrics for an existing endpoint compared in an Inference Recommender job.

" - }, - "InferenceRecommendation":{ - "type":"structure", - "required":[ - "EndpointConfiguration", - "ModelConfiguration" - ], - "members":{ - "RecommendationId":{ - "shape":"String", - "documentation":"

The recommendation ID which uniquely identifies each recommendation.

" - }, - "Metrics":{ - "shape":"RecommendationMetrics", - "documentation":"

The metrics used to decide what recommendation to make.

" - }, - "EndpointConfiguration":{ - "shape":"EndpointOutputConfiguration", - "documentation":"

Defines the endpoint configuration parameters.

" - }, - "ModelConfiguration":{ - "shape":"ModelConfiguration", - "documentation":"

Defines the model configuration.

" - }, - "InvocationEndTime":{ - "shape":"InvocationEndTime", - "documentation":"

A timestamp that shows when the benchmark completed.

" - }, - "InvocationStartTime":{ - "shape":"InvocationStartTime", - "documentation":"

A timestamp that shows when the benchmark started.

" - } - }, - "documentation":"

A list of recommendations made by Amazon SageMaker Inference Recommender.

" - }, - "InferenceRecommendations":{ - "type":"list", - "member":{"shape":"InferenceRecommendation"}, - "max":10, - "min":1 - }, - "InferenceRecommendationsJob":{ - "type":"structure", - "required":[ - "JobName", - "JobDescription", - "JobType", - "JobArn", - "Status", - "CreationTime", - "RoleArn", - "LastModifiedTime" - ], - "members":{ - "JobName":{ - "shape":"RecommendationJobName", - "documentation":"

The name of the job.

" - }, - "JobDescription":{ - "shape":"RecommendationJobDescription", - "documentation":"

The job description.

" - }, - "JobType":{ - "shape":"RecommendationJobType", - "documentation":"

The recommendation job type.

" - }, - "JobArn":{ - "shape":"RecommendationJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the recommendation job.

" - }, - "Status":{ - "shape":"RecommendationJobStatus", - "documentation":"

The status of the job.

" - }, - "CreationTime":{ - "shape":"CreationTime", - "documentation":"

A timestamp that shows when the job was created.

" - }, - "CompletionTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that shows when the job completed.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

" - }, - "LastModifiedTime":{ - "shape":"LastModifiedTime", - "documentation":"

A timestamp that shows when the job was last modified.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

If the job fails, provides information why the job failed.

" - }, - "ModelName":{ - "shape":"ModelName", - "documentation":"

The name of the created model.

" - }, - "SamplePayloadUrl":{ - "shape":"S3Uri", - "documentation":"

The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

" - }, - "ModelPackageVersionArn":{ - "shape":"ModelPackageArn", - "documentation":"

The Amazon Resource Name (ARN) of a versioned model package.

" - } - }, - "documentation":"

A structure that contains a list of recommendation jobs.

" - }, - "InferenceRecommendationsJobStep":{ - "type":"structure", - "required":[ - "StepType", - "JobName", - "Status" - ], - "members":{ - "StepType":{ - "shape":"RecommendationStepType", - "documentation":"

The type of the subtask.

BENCHMARK: Evaluate the performance of your model on different instance types.

" - }, - "JobName":{ - "shape":"RecommendationJobName", - "documentation":"

The name of the Inference Recommender job.

" - }, - "Status":{ - "shape":"RecommendationJobStatus", - "documentation":"

The current status of the benchmark.

" - }, - "InferenceBenchmark":{ - "shape":"RecommendationJobInferenceBenchmark", - "documentation":"

The details for a specific benchmark.

" - } - }, - "documentation":"

A returned array object for the Steps response field in the ListInferenceRecommendationsJobSteps API command.

" - }, - "InferenceRecommendationsJobSteps":{ - "type":"list", - "member":{"shape":"InferenceRecommendationsJobStep"} - }, - "InferenceRecommendationsJobs":{ - "type":"list", - "member":{"shape":"InferenceRecommendationsJob"} - }, - "InferenceSpecification":{ - "type":"structure", - "required":["Containers"], - "members":{ - "Containers":{ - "shape":"ModelPackageContainerDefinitionList", - "documentation":"

The Amazon ECR registry path of the Docker image that contains the inference code.

" - }, - "SupportedTransformInstanceTypes":{ - "shape":"TransformInstanceTypes", - "documentation":"

A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.

This parameter is required for unversioned models, and optional for versioned models.

" - }, - "SupportedRealtimeInferenceInstanceTypes":{ - "shape":"RealtimeInferenceInstanceTypes", - "documentation":"

A list of the instance types that are used to generate inferences in real-time.

This parameter is required for unversioned models, and optional for versioned models.

" - }, - "SupportedContentTypes":{ - "shape":"ContentTypes", - "documentation":"

The supported MIME types for the input data.

" - }, - "SupportedResponseMIMETypes":{ - "shape":"ResponseMIMETypes", - "documentation":"

The supported MIME types for the output data.

" - } - }, - "documentation":"

Defines how to perform inference generation after a training job is run.

" - }, - "InferenceSpecificationName":{ - "type":"string", - "max":63, - "min":1, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" - }, - "InfraCheckConfig":{ - "type":"structure", - "members":{ - "EnableInfraCheck":{ - "shape":"EnableInfraCheck", - "documentation":"

Enables an infrastructure health check.

" - } - }, - "documentation":"

Configuration information for the infrastructure health check of a training job. A SageMaker-provided health check tests the health of instance hardware and cluster network connectivity.

" - }, - "InitialInstanceCount":{ - "type":"integer", - "box":true, - "min":1 - }, - "InitialNumberOfUsers":{ - "type":"integer", - "box":true, - "min":1 - }, - "InitialTaskCount":{ - "type":"integer", - "box":true, - "min":1 - }, - "InputConfig":{ - "type":"structure", - "required":[ - "S3Uri", - "Framework" - ], - "members":{ - "S3Uri":{ - "shape":"S3Uri", - "documentation":"

The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

" - }, - "DataInputConfig":{ - "shape":"DataInputConfig", - "documentation":"

Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. The data inputs are Framework specific.

  • TensorFlow: You must specify the name and shape (NHWC format) of the expected data inputs using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different.

    • Examples for one input:

      • If using the console, {\"input\":[1,1024,1024,3]}

      • If using the CLI, {\\\"input\\\":[1,1024,1024,3]}

    • Examples for two inputs:

      • If using the console, {\"data1\": [1,28,28,1], \"data2\":[1,28,28,1]}

      • If using the CLI, {\\\"data1\\\": [1,28,28,1], \\\"data2\\\":[1,28,28,1]}

  • KERAS: You must specify the name and shape (NCHW format) of expected data inputs using a dictionary format for your trained model. Note that while Keras model artifacts should be uploaded in NHWC (channel-last) format, DataInputConfig should be specified in NCHW (channel-first) format. The dictionary formats required for the console and CLI are different.

    • Examples for one input:

      • If using the console, {\"input_1\":[1,3,224,224]}

      • If using the CLI, {\\\"input_1\\\":[1,3,224,224]}

    • Examples for two inputs:

      • If using the console, {\"input_1\": [1,3,224,224], \"input_2\":[1,3,224,224]}

      • If using the CLI, {\\\"input_1\\\": [1,3,224,224], \\\"input_2\\\":[1,3,224,224]}

  • MXNET/ONNX/DARKNET: You must specify the name and shape (NCHW format) of the expected data inputs in order using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different.

    • Examples for one input:

      • If using the console, {\"data\":[1,3,1024,1024]}

      • If using the CLI, {\\\"data\\\":[1,3,1024,1024]}

    • Examples for two inputs:

      • If using the console, {\"var1\": [1,1,28,28], \"var2\":[1,1,28,28]}

      • If using the CLI, {\\\"var1\\\": [1,1,28,28], \\\"var2\\\":[1,1,28,28]}

  • PyTorch: You can either specify the name and shape (NCHW format) of expected data inputs in order using a dictionary format for your trained model or you can specify the shape only using a list format. The dictionary formats required for the console and CLI are different. The list formats for the console and CLI are the same.

    • Examples for one input in dictionary format:

      • If using the console, {\"input0\":[1,3,224,224]}

      • If using the CLI, {\\\"input0\\\":[1,3,224,224]}

    • Example for one input in list format: [[1,3,224,224]]

    • Examples for two inputs in dictionary format:

      • If using the console, {\"input0\":[1,3,224,224], \"input1\":[1,3,224,224]}

      • If using the CLI, {\\\"input0\\\":[1,3,224,224], \\\"input1\\\":[1,3,224,224]}

    • Example for two inputs in list format: [[1,3,224,224], [1,3,224,224]]

  • XGBOOST: input data name and shape are not needed.

DataInputConfig supports the following parameters for CoreML TargetDevice (ML Model format):

  • shape: Input shape, for example {\"input_1\": {\"shape\": [1,224,224,3]}}. In addition to static input shapes, CoreML converter supports Flexible input shapes:

    • Range Dimension. You can use the Range Dimension feature if you know the input shape will be within some specific interval in that dimension, for example: {\"input_1\": {\"shape\": [\"1..10\", 224, 224, 3]}}

    • Enumerated shapes. Sometimes, the models are trained to work only on a select set of inputs. You can enumerate all supported input shapes, for example: {\"input_1\": {\"shape\": [[1, 224, 224, 3], [1, 160, 160, 3]]}}

  • default_shape: Default input shape. You can set a default shape during conversion for both Range Dimension and Enumerated Shapes. For example {\"input_1\": {\"shape\": [\"1..10\", 224, 224, 3], \"default_shape\": [1, 224, 224, 3]}}

  • type: Input type. Allowed values: Image and Tensor. By default, the converter generates an ML Model with inputs of type Tensor (MultiArray). User can set input type to be Image. Image input type requires additional input parameters such as bias and scale.

  • bias: If the input type is an Image, you need to provide the bias vector.

  • scale: If the input type is an Image, you need to provide a scale factor.

CoreML ClassifierConfig parameters can be specified using OutputConfig CompilerOptions. CoreML converter supports Tensorflow and PyTorch models. CoreML conversion examples:

  • Tensor type input:

    • \"DataInputConfig\": {\"input_1\": {\"shape\": [[1,224,224,3], [1,160,160,3]], \"default_shape\": [1,224,224,3]}}

  • Tensor type input without input name (PyTorch):

    • \"DataInputConfig\": [{\"shape\": [[1,3,224,224], [1,3,160,160]], \"default_shape\": [1,3,224,224]}]

  • Image type input:

    • \"DataInputConfig\": {\"input_1\": {\"shape\": [[1,224,224,3], [1,160,160,3]], \"default_shape\": [1,224,224,3], \"type\": \"Image\", \"bias\": [-1,-1,-1], \"scale\": 0.007843137255}}

    • \"CompilerOptions\": {\"class_labels\": \"imagenet_labels_1000.txt\"}

  • Image type input without input name (PyTorch):

    • \"DataInputConfig\": [{\"shape\": [[1,3,224,224], [1,3,160,160]], \"default_shape\": [1,3,224,224], \"type\": \"Image\", \"bias\": [-1,-1,-1], \"scale\": 0.007843137255}]

    • \"CompilerOptions\": {\"class_labels\": \"imagenet_labels_1000.txt\"}

Depending on the model format, DataInputConfig requires the following parameters for ml_eia2 OutputConfig:TargetDevice.

  • For TensorFlow models saved in the SavedModel format, specify the input names from signature_def_key and the input model shapes for DataInputConfig. Specify the signature_def_key in OutputConfig:CompilerOptions if the model does not use TensorFlow's default signature def key. For example:

    • \"DataInputConfig\": {\"inputs\": [1, 224, 224, 3]}

    • \"CompilerOptions\": {\"signature_def_key\": \"serving_custom\"}

  • For TensorFlow models saved as a frozen graph, specify the input tensor names and shapes in DataInputConfig and the output tensor names for output_names in OutputConfig:CompilerOptions . For example:

    • \"DataInputConfig\": {\"input_tensor:0\": [1, 224, 224, 3]}

    • \"CompilerOptions\": {\"output_names\": [\"output_tensor:0\"]}

" - }, - "Framework":{ - "shape":"Framework", - "documentation":"

Identifies the framework in which the model was trained. For example: TENSORFLOW.

" - }, - "FrameworkVersion":{ - "shape":"FrameworkVersion", - "documentation":"

Specifies the framework version to use. This API field is only supported for the MXNet, PyTorch, TensorFlow and TensorFlow Lite frameworks.

For information about framework versions supported for cloud targets and edge devices, see Cloud Supported Instance Types and Frameworks and Edge Supported Frameworks.

" - } - }, - "documentation":"

Contains information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

" - }, - "InputDataConfig":{ - "type":"list", - "member":{"shape":"Channel"}, - "max":20, - "min":1 - }, - "InputMode":{ - "type":"string", - "enum":[ - "Pipe", - "File" - ] - }, - "InputModes":{ - "type":"list", - "member":{"shape":"TrainingInputMode"}, - "min":1 - }, - "InstanceCount":{ - "type":"integer", - "box":true, - "max":10000000, - "min":0 - }, - "InstanceGroup":{ - "type":"structure", - "required":[ - "InstanceType", - "InstanceCount", - "InstanceGroupName" - ], - "members":{ - "InstanceType":{ - "shape":"TrainingInstanceType", - "documentation":"

Specifies the instance type of the instance group.

" - }, - "InstanceCount":{ - "shape":"TrainingInstanceCount", - "documentation":"

Specifies the number of instances of the instance group.

", - "box":true - }, - "InstanceGroupName":{ - "shape":"InstanceGroupName", - "documentation":"

Specifies the name of the instance group.

" - } - }, - "documentation":"

Defines an instance group for heterogeneous cluster training. When requesting a training job using the CreateTrainingJob API, you can configure multiple instance groups .

" - }, - "InstanceGroupHealthCheckConfiguration":{ - "type":"structure", - "required":[ - "InstanceGroupName", - "DeepHealthChecks" - ], - "members":{ - "InstanceGroupName":{ - "shape":"ClusterInstanceGroupName", - "documentation":"

The name of the instance group.

" - }, - "InstanceIds":{ - "shape":"InstanceIds", - "documentation":"

A list of Amazon Elastic Compute Cloud (EC2) instance IDs on which to perform deep health checks.

Leave this field blank to perform deep health checks on the entire instance group.

" - }, - "DeepHealthChecks":{ - "shape":"DeepHealthChecks", - "documentation":"

A list of deep health checks to be performed.

" - } - }, - "documentation":"

The configuration of deep health checks for an instance group.

Overlapping deep health check configurations will be merged into a single operation.

" - }, - "InstanceGroupMetadata":{ - "type":"structure", - "members":{ - "FailureMessage":{ - "shape":"String", - "documentation":"

An error message describing why the instance group level operation (such as creating, scaling, or deleting) failed.

" - }, - "AvailabilityZoneId":{ - "shape":"String", - "documentation":"

The ID of the Availability Zone where the instance group is located.

" - }, - "CapacityReservation":{ - "shape":"CapacityReservation", - "documentation":"

Information about the Capacity Reservation used by the instance group.

" - }, - "SubnetId":{ - "shape":"String", - "documentation":"

The ID of the subnet where the instance group is located.

" - }, - "SecurityGroupIds":{ - "shape":"SecurityGroupIds", - "documentation":"

A list of security group IDs associated with the instance group.

" - }, - "AmiOverride":{ - "shape":"String", - "documentation":"

If you use a custom Amazon Machine Image (AMI) for the instance group, this field shows the ID of the custom AMI.

" - } - }, - "documentation":"

Metadata information about an instance group in a HyperPod cluster.

" - }, - "InstanceGroupName":{ - "type":"string", - "max":64, - "min":1, - "pattern":".+" - }, - "InstanceGroupNames":{ - "type":"list", - "member":{"shape":"InstanceGroupName"}, - "max":5, - "min":0 - }, - "InstanceGroupScalingMetadata":{ - "type":"structure", - "members":{ - "InstanceCount":{ - "shape":"InstanceCount", - "documentation":"

The current number of instances in the group.

" - }, - "TargetCount":{ - "shape":"TargetCount", - "documentation":"

The desired number of instances for the group after scaling.

" - }, - "MinCount":{ - "shape":"InstanceCount", - "documentation":"

Minimum instance count of the instance group.

" - }, - "FailureMessage":{ - "shape":"String", - "documentation":"

An error message describing why the scaling operation failed, if applicable.

" - } - }, - "documentation":"

Metadata information about scaling operations for an instance group.

" - }, - "InstanceGroupStatus":{ - "type":"string", - "enum":[ - "InService", - "Creating", - "Updating", - "Failed", - "Degraded", - "SystemUpdating", - "Deleting" - ] - }, - "InstanceGroupTrainingPlanStatus":{ - "type":"string", - "max":63, - "min":1 - }, - "InstanceGroups":{ - "type":"list", - "member":{"shape":"InstanceGroup"}, - "max":5, - "min":0 - }, - "InstanceIds":{ - "type":"list", - "member":{"shape":"ClusterNodeId"}, - "max":500, - "min":1 - }, - "InstanceMetadata":{ - "type":"structure", - "members":{ - "CustomerEni":{ - "shape":"String", - "documentation":"

The ID of the customer-managed Elastic Network Interface (ENI) associated with the instance.

" - }, - "AdditionalEnis":{ - "shape":"AdditionalEnis", - "documentation":"

Information about additional Elastic Network Interfaces (ENIs) associated with the instance.

" - }, - "InstanceRequirementsEniConfigurations":{ - "shape":"InstanceRequirementsEniConfigurations", - "documentation":"

The ENI configurations for the instance types in the instance requirements, grouped by network interface category (for example, ENI-only or EFA with ENIs). At most one configuration per category.

" - }, - "CapacityReservation":{ - "shape":"CapacityReservation", - "documentation":"

Information about the Capacity Reservation used by the instance.

" - }, - "FailureMessage":{ - "shape":"String", - "documentation":"

An error message describing why the instance creation or update failed, if applicable.

" - }, - "LcsExecutionState":{ - "shape":"String", - "documentation":"

The execution state of the Lifecycle Script (LCS) for the instance.

" - }, - "NodeLogicalId":{ - "shape":"ClusterNodeLogicalId", - "documentation":"

The unique logical identifier of the node within the cluster. The ID used here is the same object as in the BatchAddClusterNodes API.

" - } - }, - "documentation":"

Metadata information about an instance in a HyperPod cluster.

" - }, - "InstanceMetadataServiceConfiguration":{ - "type":"structure", - "required":["MinimumInstanceMetadataServiceVersion"], - "members":{ - "MinimumInstanceMetadataServiceVersion":{ - "shape":"MinimumInstanceMetadataServiceVersion", - "documentation":"

Indicates the minimum IMDS version that the notebook instance supports. When passed as part of CreateNotebookInstance, if no value is selected, then it defaults to IMDSv1. This means that both IMDSv1 and IMDSv2 are supported. If passed as part of UpdateNotebookInstance, there is no default.

" - } - }, - "documentation":"

Information on the IMDS configuration of the notebook instance

" - }, - "InstancePlacementConfig":{ - "type":"structure", - "members":{ - "EnableMultipleJobs":{ - "shape":"Boolean", - "documentation":"

If set to true, allows multiple jobs to share the same UltraServer instances. If set to false, ensures this job's instances are placed on an UltraServer exclusively, with no other jobs sharing the same UltraServer. Default is false.

", - "box":true - }, - "PlacementSpecifications":{ - "shape":"PlacementSpecifications", - "documentation":"

A list of specifications for how instances should be placed on specific UltraServers. Maximum of 10 items is supported.

" - } - }, - "documentation":"

Configuration for how instances are placed and allocated within UltraServers. This is only applicable for UltraServer capacity.

" - }, - "InstancePool":{ - "type":"structure", - "required":[ - "InstanceType", - "Priority" - ], - "members":{ - "InstanceType":{ - "shape":"ProductionVariantInstanceType", - "documentation":"

The ML compute instance type for the instance pool.

" - }, - "ModelNameOverride":{ - "shape":"ModelName", - "documentation":"

The name of a SageMaker model to use for this instance pool instead of the model specified for the production variant. Use this to deploy a different model optimized for the instance type in this pool.

" - }, - "Priority":{ - "shape":"InstancePoolPriority", - "documentation":"

The priority for the instance pool. SageMaker attempts to provision instances in order of priority, starting with the lowest value. If instances for a higher-priority pool are unavailable, SageMaker attempts to provision from the next pool.

Valid values: 1 to 5, where 1 is the highest priority.

" - } - }, - "documentation":"

Specifies an instance type and its priority for a heterogeneous endpoint. Use instance pools to configure a production variant with multiple instance types, enabling the endpoint to provision instances across different types based on priority.

" - }, - "InstancePoolList":{ - "type":"list", - "member":{"shape":"InstancePool"}, - "max":5, - "min":1 - }, - "InstancePoolPriority":{ - "type":"integer", - "box":true, - "max":5, - "min":1 - }, - "InstancePoolSummary":{ - "type":"structure", - "required":[ - "InstanceType", - "CurrentInstanceCount" - ], - "members":{ - "InstanceType":{ - "shape":"ProductionVariantInstanceType", - "documentation":"

The ML compute instance type for the instance pool.

" - }, - "CurrentInstanceCount":{ - "shape":"TaskCount", - "documentation":"

The current number of instances of this type in the instance pool.

" - } - }, - "documentation":"

A summary of an instance pool for a production variant, including the instance type and the current number of instances.

" - }, - "InstancePoolSummaryList":{ - "type":"list", - "member":{"shape":"InstancePoolSummary"}, - "min":1 - }, - "InstanceRequirementsEniConfiguration":{ - "type":"structure", - "members":{ - "CustomerEni":{ - "shape":"String", - "documentation":"

The ID of the customer-managed Elastic Network Interface (ENI) associated with the instance type category.

" - }, - "AdditionalEnis":{ - "shape":"AdditionalEnis", - "documentation":"

Information about additional Elastic Network Interfaces (ENIs) associated with the instance type category.

" - } - }, - "documentation":"

The customer ENI and additional ENIs associated with a network interface category.

" - }, - "InstanceRequirementsEniConfigurations":{ - "type":"list", - "member":{"shape":"InstanceRequirementsEniConfiguration"} - }, - "InstanceType":{ - "type":"string", - "enum":[ - "ml.t2.medium", - "ml.t2.large", - "ml.t2.xlarge", - "ml.t2.2xlarge", - "ml.t3.medium", - "ml.t3.large", - "ml.t3.xlarge", - "ml.t3.2xlarge", - "ml.m4.xlarge", - "ml.m4.2xlarge", - "ml.m4.4xlarge", - "ml.m4.10xlarge", - "ml.m4.16xlarge", - "ml.m5.xlarge", - "ml.m5.2xlarge", - "ml.m5.4xlarge", - "ml.m5.12xlarge", - "ml.m5.24xlarge", - "ml.m5d.large", - "ml.m5d.xlarge", - "ml.m5d.2xlarge", - "ml.m5d.4xlarge", - "ml.m5d.8xlarge", - "ml.m5d.12xlarge", - "ml.m5d.16xlarge", - "ml.m5d.24xlarge", - "ml.c4.xlarge", - "ml.c4.2xlarge", - "ml.c4.4xlarge", - "ml.c4.8xlarge", - "ml.c5.xlarge", - "ml.c5.2xlarge", - "ml.c5.4xlarge", - "ml.c5.9xlarge", - "ml.c5.18xlarge", - "ml.c5d.xlarge", - "ml.c5d.2xlarge", - "ml.c5d.4xlarge", - "ml.c5d.9xlarge", - "ml.c5d.18xlarge", - "ml.p2.xlarge", - "ml.p2.8xlarge", - "ml.p2.16xlarge", - "ml.p3.2xlarge", - "ml.p3.8xlarge", - "ml.p3.16xlarge", - "ml.p3dn.24xlarge", - "ml.g4dn.xlarge", - "ml.g4dn.2xlarge", - "ml.g4dn.4xlarge", - "ml.g4dn.8xlarge", - "ml.g4dn.12xlarge", - "ml.g4dn.16xlarge", - "ml.r5.large", - "ml.r5.xlarge", - "ml.r5.2xlarge", - "ml.r5.4xlarge", - "ml.r5.8xlarge", - "ml.r5.12xlarge", - "ml.r5.16xlarge", - "ml.r5.24xlarge", - "ml.g5.xlarge", - "ml.g5.2xlarge", - "ml.g5.4xlarge", - "ml.g5.8xlarge", - "ml.g5.16xlarge", - "ml.g5.12xlarge", - "ml.g5.24xlarge", - "ml.g5.48xlarge", - "ml.inf1.xlarge", - "ml.inf1.2xlarge", - "ml.inf1.6xlarge", - "ml.inf1.24xlarge", - "ml.trn1.2xlarge", - "ml.trn1.32xlarge", - "ml.trn1n.32xlarge", - "ml.inf2.xlarge", - "ml.inf2.8xlarge", - "ml.inf2.24xlarge", - "ml.inf2.48xlarge", - "ml.p4d.24xlarge", - "ml.p4de.24xlarge", - "ml.p5.48xlarge", - "ml.p6-b200.48xlarge", - "ml.m6i.large", - "ml.m6i.xlarge", - "ml.m6i.2xlarge", - "ml.m6i.4xlarge", - "ml.m6i.8xlarge", - "ml.m6i.12xlarge", - "ml.m6i.16xlarge", - "ml.m6i.24xlarge", - "ml.m6i.32xlarge", - "ml.m7i.large", - "ml.m7i.xlarge", - "ml.m7i.2xlarge", - "ml.m7i.4xlarge", - "ml.m7i.8xlarge", - "ml.m7i.12xlarge", - "ml.m7i.16xlarge", - "ml.m7i.24xlarge", - "ml.m7i.48xlarge", - "ml.c6i.large", - "ml.c6i.xlarge", - "ml.c6i.2xlarge", - "ml.c6i.4xlarge", - "ml.c6i.8xlarge", - "ml.c6i.12xlarge", - "ml.c6i.16xlarge", - "ml.c6i.24xlarge", - "ml.c6i.32xlarge", - "ml.c7i.large", - "ml.c7i.xlarge", - "ml.c7i.2xlarge", - "ml.c7i.4xlarge", - "ml.c7i.8xlarge", - "ml.c7i.12xlarge", - "ml.c7i.16xlarge", - "ml.c7i.24xlarge", - "ml.c7i.48xlarge", - "ml.r6i.large", - "ml.r6i.xlarge", - "ml.r6i.2xlarge", - "ml.r6i.4xlarge", - "ml.r6i.8xlarge", - "ml.r6i.12xlarge", - "ml.r6i.16xlarge", - "ml.r6i.24xlarge", - "ml.r6i.32xlarge", - "ml.r7i.large", - "ml.r7i.xlarge", - "ml.r7i.2xlarge", - "ml.r7i.4xlarge", - "ml.r7i.8xlarge", - "ml.r7i.12xlarge", - "ml.r7i.16xlarge", - "ml.r7i.24xlarge", - "ml.r7i.48xlarge", - "ml.m6id.large", - "ml.m6id.xlarge", - "ml.m6id.2xlarge", - "ml.m6id.4xlarge", - "ml.m6id.8xlarge", - "ml.m6id.12xlarge", - "ml.m6id.16xlarge", - "ml.m6id.24xlarge", - "ml.m6id.32xlarge", - "ml.c6id.large", - "ml.c6id.xlarge", - "ml.c6id.2xlarge", - "ml.c6id.4xlarge", - "ml.c6id.8xlarge", - "ml.c6id.12xlarge", - "ml.c6id.16xlarge", - "ml.c6id.24xlarge", - "ml.c6id.32xlarge", - "ml.r6id.large", - "ml.r6id.xlarge", - "ml.r6id.2xlarge", - "ml.r6id.4xlarge", - "ml.r6id.8xlarge", - "ml.r6id.12xlarge", - "ml.r6id.16xlarge", - "ml.r6id.24xlarge", - "ml.r6id.32xlarge", - "ml.g6.xlarge", - "ml.g6.2xlarge", - "ml.g6.4xlarge", - "ml.g6.8xlarge", - "ml.g6.12xlarge", - "ml.g6.16xlarge", - "ml.g6.24xlarge", - "ml.g6.48xlarge", - "ml.g7e.2xlarge", - "ml.g7e.4xlarge", - "ml.g7e.8xlarge", - "ml.g7e.12xlarge", - "ml.g7e.24xlarge", - "ml.g7e.48xlarge", - "ml.p5.4xlarge", - "ml.p5en.48xlarge", - "ml.g6e.xlarge", - "ml.g6e.2xlarge", - "ml.g6e.4xlarge", - "ml.g6e.8xlarge", - "ml.g6e.12xlarge", - "ml.g6e.16xlarge", - "ml.g6e.24xlarge", - "ml.g6e.48xlarge" - ] - }, - "Integer":{"type":"integer"}, - "IntegerParameterRange":{ - "type":"structure", - "required":[ - "Name", - "MinValue", - "MaxValue" - ], - "members":{ - "Name":{ - "shape":"ParameterKey", - "documentation":"

The name of the hyperparameter to search.

" - }, - "MinValue":{ - "shape":"ParameterValue", - "documentation":"

The minimum value of the hyperparameter to search.

" - }, - "MaxValue":{ - "shape":"ParameterValue", - "documentation":"

The maximum value of the hyperparameter to search.

" - }, - "ScalingType":{ - "shape":"HyperParameterScalingType", - "documentation":"

The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

Auto

SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.

Linear

Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

Logarithmic

Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.

Logarithmic scaling works only for ranges that have only values greater than 0.

" - } - }, - "documentation":"

For a hyperparameter of the integer type, specifies the range that a hyperparameter tuning job searches.

" - }, - "IntegerParameterRangeSpecification":{ - "type":"structure", - "required":[ - "MinValue", - "MaxValue" - ], - "members":{ - "MinValue":{ - "shape":"ParameterValue", - "documentation":"

The minimum integer value allowed.

" - }, - "MaxValue":{ - "shape":"ParameterValue", - "documentation":"

The maximum integer value allowed.

" - } - }, - "documentation":"

Defines the possible values for an integer hyperparameter.

" - }, - "IntegerParameterRanges":{ - "type":"list", - "member":{"shape":"IntegerParameterRange"}, - "max":30, - "min":0 - }, - "InvocationEndTime":{"type":"timestamp"}, - "InvocationStartTime":{"type":"timestamp"}, - "InvocationsMaxRetries":{ - "type":"integer", - "box":true, - "max":3, - "min":0 - }, - "InvocationsTimeoutInSeconds":{ - "type":"integer", - "box":true, - "max":3600, - "min":1 - }, - "IotRoleAlias":{ - "type":"string", - "pattern":"arn:aws[a-z\\-]*:iam::\\d{12}:rolealias/?[a-zA-Z_0-9+=,.@\\-_/]+" - }, - "IsTrackingServerActive":{ - "type":"string", - "enum":[ - "Active", - "Inactive" - ] - }, - "ItemIdentifierAttributeName":{ - "type":"string", - "max":256, - "min":1 - }, - "Job":{ - "type":"structure", - "members":{ - "JobName":{ - "shape":"JobName", - "documentation":"

The name of the job.

" - }, - "JobArn":{ - "shape":"JobArn", - "documentation":"

The Amazon Resource Name (ARN) of the job.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The ARN of the IAM role associated with the job.

" - }, - "JobCategory":{ - "shape":"JobCategory", - "documentation":"

The category of the job.

" - }, - "JobConfigSchemaVersion":{ - "shape":"JobSchemaVersion", - "documentation":"

The schema version used for the job configuration document.

" - }, - "JobConfigDocument":{ - "shape":"JobConfigDocument", - "documentation":"

The JSON configuration document for the job.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The date and time that the job was created.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The date and time that the job was last modified.

" - }, - "EndTime":{ - "shape":"Timestamp", - "documentation":"

The date and time that the job ended.

" - }, - "JobStatus":{ - "shape":"JobStatus", - "documentation":"

The current status of the job.

" - }, - "SecondaryStatus":{ - "shape":"JobSecondaryStatus", - "documentation":"

The detailed secondary status of the job, providing more granular information about the job's progress.

" - }, - "SecondaryStatusTransitions":{ - "shape":"JobSecondaryStatusTransitions", - "documentation":"

A list of secondary status transitions for the job, with timestamps and optional status messages.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

If the job failed, the reason it failed.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The tags associated with the job.

" - } - }, - "documentation":"

The properties of a job returned by the Search API.

" - }, - "JobArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:(aws[a-z\\-]*):sagemaker:[a-z0-9\\-]+:[0-9]{12}:job/[a-zA-Z0-9]+/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" - }, - "JobCategory":{ - "type":"string", - "enum":[ - "AgentRFT", - "AgentRFTEvaluation" - ] - }, - "JobConfigDocument":{ - "type":"string", - "max":262144, - "min":1 - }, - "JobConfigSchemaVersionSummary":{ - "type":"structure", - "required":["JobConfigSchemaVersion"], - "members":{ - "JobConfigSchemaVersion":{ - "shape":"JobSchemaVersion", - "documentation":"

The version of the job configuration schema.

" - } - }, - "documentation":"

Provides summary information about a job configuration schema version.

" - }, - "JobConfigSchemas":{ - "type":"list", - "member":{"shape":"JobConfigSchemaVersionSummary"}, - "max":100, - "min":0 - }, - "JobDurationInSeconds":{ - "type":"integer", - "box":true, - "min":1 - }, - "JobName":{ - "type":"string", - "max":63, - "min":1, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" - }, - "JobReferenceCode":{ - "type":"string", - "min":1, - "pattern":".+" - }, - "JobReferenceCodeContains":{ - "type":"string", - "max":255, - "min":1, - "pattern":".+" - }, - "JobSchemaVersion":{ - "type":"string", - "max":16, - "min":5, - "pattern":"\\d+\\.\\d+\\.\\d+" - }, - "JobSecondaryStatus":{ - "type":"string", - "enum":[ - "Starting", - "Downloading", - "Training", - "Uploading", - "Stopping", - "Stopped", - "MaxRuntimeExceeded", - "Interrupted", - "Failed", - "Completed", - "Restarting", - "Pending", - "Evaluating", - "Deleting", - "DeleteFailed" - ] - }, - "JobSecondaryStatusTransition":{ - "type":"structure", - "required":[ - "Status", - "StartTime" - ], - "members":{ - "Status":{ - "shape":"JobSecondaryStatus", - "documentation":"

The secondary status of the job at this transition point.

" - }, - "StartTime":{ - "shape":"Timestamp", - "documentation":"

The date and time that the status transition started.

" - }, - "EndTime":{ - "shape":"Timestamp", - "documentation":"

The date and time that the status transition ended.

" - }, - "StatusMessage":{ - "shape":"String", - "documentation":"

A detailed message about the status transition.

" - } - }, - "documentation":"

Represents a secondary status transition for a job. Jobs progress through multiple secondary statuses during execution. Each transition records the status, start time, optional end time, and an optional message with additional details.

" - }, - "JobSecondaryStatusTransitions":{ - "type":"list", - "member":{"shape":"JobSecondaryStatusTransition"}, - "max":100, - "min":0 - }, - "JobStatus":{ - "type":"string", - "enum":[ - "InProgress", - "Completed", - "Failed", - "Stopping", - "Stopped", - "Deleting", - "DeleteFailed" - ] - }, - "JobStepMetadata":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"String1024", - "documentation":"

The Amazon Resource Name (ARN) of the SageMaker job that was run by this step execution.

" - } - }, - "documentation":"

Metadata for a SageMaker job step.

" - }, - "JobSummaries":{ - "type":"list", - "member":{"shape":"JobSummary"}, - "max":100, - "min":0 - }, - "JobSummary":{ - "type":"structure", - "required":[ - "JobArn", - "JobName", - "JobCategory", - "JobStatus", - "JobSecondaryStatus", - "CreationTime", - "LastModifiedTime" - ], - "members":{ - "JobArn":{ - "shape":"JobArn", - "documentation":"

The Amazon Resource Name (ARN) of the job.

" - }, - "JobName":{ - "shape":"JobName", - "documentation":"

The name of the job.

" - }, - "JobCategory":{ - "shape":"JobCategory", - "documentation":"

The category of the job.

" - }, - "JobStatus":{ - "shape":"JobStatus", - "documentation":"

The current status of the job.

" - }, - "JobSecondaryStatus":{ - "shape":"JobSecondaryStatus", - "documentation":"

The secondary status of the job, providing more granular information about the job's progress. Secondary statuses may change between releases.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The date and time that the job was created.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The date and time that the job was last modified.

" - }, - "EndTime":{ - "shape":"Timestamp", - "documentation":"

The date and time that the job ended.

" - } - }, - "documentation":"

Provides summary information about a job, returned by the ListJobs operation. Use DescribeJob to get full details for a specific job.

" - }, - "JobType":{ - "type":"string", - "enum":[ - "TRAINING", - "INFERENCE", - "NOTEBOOK_KERNEL" - ] - }, - "JoinSource":{ - "type":"string", - "enum":[ - "Input", - "None" - ] - }, - "JsonContentType":{ - "type":"string", - "max":256, - "min":1, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9])*\\/[a-zA-Z0-9](-*[a-zA-Z0-9.])*" - }, - "JsonContentTypes":{ - "type":"list", - "member":{"shape":"JsonContentType"}, - "max":10, - "min":1 - }, - "JsonPath":{ - "type":"string", - "max":63, - "min":0 - }, - "JupyterLabAppImageConfig":{ - "type":"structure", - "members":{ - "FileSystemConfig":{"shape":"FileSystemConfig"}, - "ContainerConfig":{"shape":"ContainerConfig"} - }, - "documentation":"

The configuration for the file system and kernels in a SageMaker AI image running as a JupyterLab app. The FileSystemConfig object is not supported.

" - }, - "JupyterLabAppSettings":{ - "type":"structure", - "members":{ - "DefaultResourceSpec":{"shape":"ResourceSpec"}, - "CustomImages":{ - "shape":"CustomImages", - "documentation":"

A list of custom SageMaker images that are configured to run as a JupyterLab app.

" - }, - "LifecycleConfigArns":{ - "shape":"LifecycleConfigArns", - "documentation":"

The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain. To remove a lifecycle config, you must set LifecycleConfigArns to an empty list.

" - }, - "CodeRepositories":{ - "shape":"CodeRepositories", - "documentation":"

A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.

" - }, - "AppLifecycleManagement":{ - "shape":"AppLifecycleManagement", - "documentation":"

Indicates whether idle shutdown is activated for JupyterLab applications.

" - }, - "EmrSettings":{ - "shape":"EmrSettings", - "documentation":"

The configuration parameters that specify the IAM roles assumed by the execution role of SageMaker (assumable roles) and the cluster instances or job execution environments (execution roles or runtime roles) to manage and access resources required for running Amazon EMR clusters or Amazon EMR Serverless applications.

" - }, - "BuiltInLifecycleConfigArn":{ - "shape":"StudioLifecycleConfigArn", - "documentation":"

The lifecycle configuration that runs before the default lifecycle configuration. It can override changes made in the default lifecycle configuration.

" - } - }, - "documentation":"

The settings for the JupyterLab application.

" - }, - "JupyterServerAppSettings":{ - "type":"structure", - "members":{ - "DefaultResourceSpec":{ - "shape":"ResourceSpec", - "documentation":"

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker AI image used by the JupyterServer app. If you use the LifecycleConfigArns parameter, then this parameter is also required.

" - }, - "LifecycleConfigArns":{ - "shape":"LifecycleConfigArns", - "documentation":"

The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp. If you use this parameter, the DefaultResourceSpec parameter is also required.

To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.

" - }, - "CodeRepositories":{ - "shape":"CodeRepositories", - "documentation":"

A list of Git repositories that SageMaker AI automatically displays to users for cloning in the JupyterServer application.

" - } - }, - "documentation":"

The JupyterServer app settings.

" - }, - "KeepAlivePeriodInSeconds":{ - "type":"integer", - "documentation":"

Optional. Customer requested period in seconds for which the Training cluster is kept alive after the job is finished.

", - "box":true, - "max":21600, - "min":0 - }, - "KendraSettings":{ - "type":"structure", - "members":{ - "Status":{ - "shape":"FeatureStatus", - "documentation":"

Describes whether the document querying feature is enabled or disabled in the Canvas application.

" - } - }, - "documentation":"

The Amazon SageMaker Canvas application setting where you configure document querying.

" - }, - "KernelDisplayName":{ - "type":"string", - "max":1024, - "min":0 - }, - "KernelGatewayAppSettings":{ - "type":"structure", - "members":{ - "DefaultResourceSpec":{ - "shape":"ResourceSpec", - "documentation":"

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker AI image used by the KernelGateway app.

The Amazon SageMaker AI Studio UI does not use the default instance type value set here. The default instance type set here is used when Apps are created using the CLI or CloudFormation and the instance type parameter value is not passed.

" - }, - "CustomImages":{ - "shape":"CustomImages", - "documentation":"

A list of custom SageMaker AI images that are configured to run as a KernelGateway app.

The maximum number of custom images are as follows.

  • On a domain level: 200

  • On a space level: 5

  • On a user profile level: 5

" - }, - "LifecycleConfigArns":{ - "shape":"LifecycleConfigArns", - "documentation":"

The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.

To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.

" - } - }, - "documentation":"

The KernelGateway app settings.

" - }, - "KernelGatewayImageConfig":{ - "type":"structure", - "required":["KernelSpecs"], - "members":{ - "KernelSpecs":{ - "shape":"KernelSpecs", - "documentation":"

The specification of the Jupyter kernels in the image.

" - }, - "FileSystemConfig":{ - "shape":"FileSystemConfig", - "documentation":"

The Amazon Elastic File System storage configuration for a SageMaker AI image.

" - } - }, - "documentation":"

The configuration for the file system and kernels in a SageMaker AI image running as a KernelGateway app.

" - }, - "KernelName":{ - "type":"string", - "max":1024, - "min":0 - }, - "KernelSpec":{ - "type":"structure", - "required":["Name"], - "members":{ - "Name":{ - "shape":"KernelName", - "documentation":"

The name of the Jupyter kernel in the image. This value is case sensitive.

" - }, - "DisplayName":{ - "shape":"KernelDisplayName", - "documentation":"

The display name of the kernel.

" - } - }, - "documentation":"

The specification of a Jupyter kernel.

" - }, - "KernelSpecs":{ - "type":"list", - "member":{"shape":"KernelSpec"}, - "max":5, - "min":1 - }, - "Key":{ - "type":"string", - "max":1024, - "min":1, - "pattern":".+" - }, - "KmsKeyId":{ - "type":"string", - "max":2048, - "min":0, - "pattern":"[a-zA-Z0-9:/_-]*" - }, - "LabelAttributeName":{ - "type":"string", - "max":127, - "min":1, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,126}" - }, - "LabelCounter":{ - "type":"integer", - "min":0 - }, - "LabelCounters":{ - "type":"structure", - "members":{ - "TotalLabeled":{ - "shape":"LabelCounter", - "documentation":"

The total number of objects labeled.

", - "box":true - }, - "HumanLabeled":{ - "shape":"LabelCounter", - "documentation":"

The total number of objects labeled by a human worker.

", - "box":true - }, - "MachineLabeled":{ - "shape":"LabelCounter", - "documentation":"

The total number of objects labeled by automated data labeling.

", - "box":true - }, - "FailedNonRetryableError":{ - "shape":"LabelCounter", - "documentation":"

The total number of objects that could not be labeled due to an error.

", - "box":true - }, - "Unlabeled":{ - "shape":"LabelCounter", - "documentation":"

The total number of objects not yet labeled.

", - "box":true - } - }, - "documentation":"

Provides a breakdown of the number of objects labeled.

" - }, - "LabelCountersForWorkteam":{ - "type":"structure", - "members":{ - "HumanLabeled":{ - "shape":"LabelCounter", - "documentation":"

The total number of data objects labeled by a human worker.

", - "box":true - }, - "PendingHuman":{ - "shape":"LabelCounter", - "documentation":"

The total number of data objects that need to be labeled by a human worker.

", - "box":true - }, - "Total":{ - "shape":"LabelCounter", - "documentation":"

The total number of tasks in the labeling job.

", - "box":true - } - }, - "documentation":"

Provides counts for human-labeled tasks in the labeling job.

" - }, - "LabelingJobAlgorithmSpecificationArn":{ - "type":"string", - "max":2048, - "min":0, - "pattern":"arn:.*" - }, - "LabelingJobAlgorithmsConfig":{ - "type":"structure", - "required":["LabelingJobAlgorithmSpecificationArn"], - "members":{ - "LabelingJobAlgorithmSpecificationArn":{ - "shape":"LabelingJobAlgorithmSpecificationArn", - "documentation":"

Specifies the Amazon Resource Name (ARN) of the algorithm used for auto-labeling. You must select one of the following ARNs:

  • Image classification

    arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/image-classification

  • Text classification

    arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/text-classification

  • Object detection

    arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/object-detection

  • Semantic Segmentation

    arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/semantic-segmentation

" - }, - "InitialActiveLearningModelArn":{ - "shape":"ModelArn", - "documentation":"

At the end of an auto-label job Ground Truth sends the Amazon Resource Name (ARN) of the final model used for auto-labeling. You can use this model as the starting point for subsequent similar jobs by providing the ARN of the model here.

" - }, - "LabelingJobResourceConfig":{ - "shape":"LabelingJobResourceConfig", - "documentation":"

Provides configuration information for a labeling job.

" - } - }, - "documentation":"

Provides configuration information for auto-labeling of your data objects. A LabelingJobAlgorithmsConfig object must be supplied in order to use auto-labeling.

" - }, - "LabelingJobArn":{ - "type":"string", - "max":2048, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:labeling-job/.*" - }, - "LabelingJobDataAttributes":{ - "type":"structure", - "members":{ - "ContentClassifiers":{ - "shape":"ContentClassifiers", - "documentation":"

Declares that your content is free of personally identifiable information or adult content. SageMaker may restrict the Amazon Mechanical Turk workers that can view your task based on this information.

" - } - }, - "documentation":"

Attributes of the data specified by the customer. Use these to describe the data to be labeled.

" - }, - "LabelingJobDataSource":{ - "type":"structure", - "members":{ - "S3DataSource":{ - "shape":"LabelingJobS3DataSource", - "documentation":"

The Amazon S3 location of the input data objects.

" - }, - "SnsDataSource":{ - "shape":"LabelingJobSnsDataSource", - "documentation":"

An Amazon SNS data source used for streaming labeling jobs. To learn more, see Send Data to a Streaming Labeling Job.

" - } - }, - "documentation":"

Provides information about the location of input data.

You must specify at least one of the following: S3DataSource or SnsDataSource.

Use SnsDataSource to specify an SNS input topic for a streaming labeling job. If you do not specify and SNS input topic ARN, Ground Truth will create a one-time labeling job.

Use S3DataSource to specify an input manifest file for both streaming and one-time labeling jobs. Adding an S3DataSource is optional if you use SnsDataSource to create a streaming labeling job.

" - }, - "LabelingJobForWorkteamSummary":{ - "type":"structure", - "required":[ - "JobReferenceCode", - "WorkRequesterAccountId", - "CreationTime" - ], - "members":{ - "LabelingJobName":{ - "shape":"LabelingJobName", - "documentation":"

The name of the labeling job that the work team is assigned to.

" - }, - "JobReferenceCode":{ - "shape":"JobReferenceCode", - "documentation":"

A unique identifier for a labeling job. You can use this to refer to a specific labeling job.

" - }, - "WorkRequesterAccountId":{ - "shape":"AccountId", - "documentation":"

The Amazon Web Services account ID of the account used to start the labeling job.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The date and time that the labeling job was created.

" - }, - "LabelCounters":{ - "shape":"LabelCountersForWorkteam", - "documentation":"

Provides information about the progress of a labeling job.

" - }, - "NumberOfHumanWorkersPerDataObject":{ - "shape":"NumberOfHumanWorkersPerDataObject", - "documentation":"

The configured number of workers per data object.

" - } - }, - "documentation":"

Provides summary information for a work team.

" - }, - "LabelingJobForWorkteamSummaryList":{ - "type":"list", - "member":{"shape":"LabelingJobForWorkteamSummary"} - }, - "LabelingJobInputConfig":{ - "type":"structure", - "required":["DataSource"], - "members":{ - "DataSource":{ - "shape":"LabelingJobDataSource", - "documentation":"

The location of the input data.

" - }, - "DataAttributes":{ - "shape":"LabelingJobDataAttributes", - "documentation":"

Attributes of the data specified by the customer.

" - } - }, - "documentation":"

Input configuration information for a labeling job.

" - }, - "LabelingJobName":{ - "type":"string", - "max":63, - "min":1, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" - }, - "LabelingJobOutput":{ - "type":"structure", - "required":["OutputDatasetS3Uri"], - "members":{ - "OutputDatasetS3Uri":{ - "shape":"S3Uri", - "documentation":"

The Amazon S3 bucket location of the manifest file for labeled data.

" - }, - "FinalActiveLearningModelArn":{ - "shape":"ModelArn", - "documentation":"

The Amazon Resource Name (ARN) for the most recent SageMaker model trained as part of automated data labeling.

" - } - }, - "documentation":"

Specifies the location of the output produced by the labeling job.

" - }, - "LabelingJobOutputConfig":{ - "type":"structure", - "required":["S3OutputPath"], - "members":{ - "S3OutputPath":{ - "shape":"S3Uri", - "documentation":"

The Amazon S3 location to write output data.

" - }, - "KmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The Amazon Web Services Key Management Service ID of the key used to encrypt the output data, if any.

If you provide your own KMS key ID, you must add the required permissions to your KMS key described in Encrypt Output Data and Storage Volume with Amazon Web Services KMS.

If you don't provide a KMS key ID, Amazon SageMaker uses the default Amazon Web Services KMS key for Amazon S3 for your role's account to encrypt your output data.

If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to \"aws:kms\". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

" - }, - "SnsTopicArn":{ - "shape":"SnsTopicArn", - "documentation":"

An Amazon Simple Notification Service (Amazon SNS) output topic ARN. Provide a SnsTopicArn if you want to do real time chaining to another streaming job and receive an Amazon SNS notifications each time a data object is submitted by a worker.

If you provide an SnsTopicArn in OutputConfig, when workers complete labeling tasks, Ground Truth will send labeling task output data to the SNS output topic you specify here.

To learn more, see Receive Output Data from a Streaming Labeling Job.

" - } - }, - "documentation":"

Output configuration information for a labeling job.

" - }, - "LabelingJobResourceConfig":{ - "type":"structure", - "members":{ - "VolumeKmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training and inference jobs used for automated data labeling.

You can only specify a VolumeKmsKeyId when you create a labeling job with automated data labeling enabled using the API operation CreateLabelingJob. You cannot specify an Amazon Web Services KMS key to encrypt the storage volume used for automated data labeling model training and inference when you create a labeling job using the console. To learn more, see Output Data and Storage Volume Encryption.

The VolumeKmsKeyId can be any of the following formats:

  • KMS Key ID

    \"1234abcd-12ab-34cd-56ef-1234567890ab\"

  • Amazon Resource Name (ARN) of a KMS Key

    \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

" - }, - "VpcConfig":{"shape":"VpcConfig"} - }, - "documentation":"

Configure encryption on the storage volume attached to the ML compute instance used to run automated data labeling model training and inference.

" - }, - "LabelingJobS3DataSource":{ - "type":"structure", - "required":["ManifestS3Uri"], - "members":{ - "ManifestS3Uri":{ - "shape":"S3Uri", - "documentation":"

The Amazon S3 location of the manifest file that describes the input data objects.

The input manifest file referenced in ManifestS3Uri must contain one of the following keys: source-ref or source. The value of the keys are interpreted as follows:

  • source-ref: The source of the object is the Amazon S3 object specified in the value. Use this value when the object is a binary object, such as an image.

  • source: The source of the object is the value. Use this value when the object is a text value.

If you are a new user of Ground Truth, it is recommended you review Use an Input Manifest File in the Amazon SageMaker Developer Guide to learn how to create an input manifest file.

" - } - }, - "documentation":"

The Amazon S3 location of the input data objects.

" - }, - "LabelingJobSnsDataSource":{ - "type":"structure", - "required":["SnsTopicArn"], - "members":{ - "SnsTopicArn":{ - "shape":"SnsTopicArn", - "documentation":"

The Amazon SNS input topic Amazon Resource Name (ARN). Specify the ARN of the input topic you will use to send new data objects to a streaming labeling job.

" - } - }, - "documentation":"

An Amazon SNS data source used for streaming labeling jobs.

" - }, - "LabelingJobStatus":{ - "type":"string", - "enum":[ - "Initializing", - "InProgress", - "Completed", - "Failed", - "Stopping", - "Stopped" - ] - }, - "LabelingJobStoppingConditions":{ - "type":"structure", - "members":{ - "MaxHumanLabeledObjectCount":{ - "shape":"MaxHumanLabeledObjectCount", - "documentation":"

The maximum number of objects that can be labeled by human workers.

" - }, - "MaxPercentageOfInputDatasetLabeled":{ - "shape":"MaxPercentageOfInputDatasetLabeled", - "documentation":"

The maximum number of input data objects that should be labeled.

" - } - }, - "documentation":"

A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped. You can use these conditions to control the cost of data labeling.

Labeling jobs fail after 30 days with an appropriate client error message.

" - }, - "LabelingJobSummary":{ - "type":"structure", - "required":[ - "LabelingJobName", - "LabelingJobArn", - "CreationTime", - "LastModifiedTime", - "LabelingJobStatus", - "LabelCounters", - "WorkteamArn" - ], - "members":{ - "LabelingJobName":{ - "shape":"LabelingJobName", - "documentation":"

The name of the labeling job.

" - }, - "LabelingJobArn":{ - "shape":"LabelingJobArn", - "documentation":"

The Amazon Resource Name (ARN) assigned to the labeling job when it was created.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The date and time that the job was created (timestamp).

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The date and time that the job was last modified (timestamp).

" - }, - "LabelingJobStatus":{ - "shape":"LabelingJobStatus", - "documentation":"

The current status of the labeling job.

" - }, - "LabelCounters":{ - "shape":"LabelCounters", - "documentation":"

Counts showing the progress of the labeling job.

" - }, - "WorkteamArn":{ - "shape":"WorkteamArn", - "documentation":"

The Amazon Resource Name (ARN) of the work team assigned to the job.

" - }, - "PreHumanTaskLambdaArn":{ - "shape":"LambdaFunctionArn", - "documentation":"

The Amazon Resource Name (ARN) of a Lambda function. The function is run before each data object is sent to a worker.

" - }, - "AnnotationConsolidationLambdaArn":{ - "shape":"LambdaFunctionArn", - "documentation":"

The Amazon Resource Name (ARN) of the Lambda function used to consolidate the annotations from individual workers into a label for a data object. For more information, see Annotation Consolidation.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

If the LabelingJobStatus field is Failed, this field contains a description of the error.

" - }, - "LabelingJobOutput":{ - "shape":"LabelingJobOutput", - "documentation":"

The location of the output produced by the labeling job.

" - }, - "InputConfig":{ - "shape":"LabelingJobInputConfig", - "documentation":"

Input configuration for the labeling job.

" - } - }, - "documentation":"

Provides summary information about a labeling job.

" - }, - "LabelingJobSummaryList":{ - "type":"list", - "member":{"shape":"LabelingJobSummary"} - }, - "LambdaFunctionArn":{ - "type":"string", - "max":2048, - "min":0, - "pattern":"arn:aws[a-z\\-]*:lambda:[a-z0-9\\-]*:[0-9]{12}:function:.*" - }, - "LambdaStepMetadata":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"String256", - "documentation":"

The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution.

" - }, - "OutputParameters":{ - "shape":"OutputParameterList", - "documentation":"

A list of the output parameters of the Lambda step.

" - } - }, - "documentation":"

Metadata for a Lambda step.

" - }, - "LandingUri":{ - "type":"string", - "max":1023, - "min":0 - }, - "LastModifiedTime":{"type":"timestamp"}, - "LastUpdateStatus":{ - "type":"structure", - "required":["Status"], - "members":{ - "Status":{ - "shape":"LastUpdateStatusValue", - "documentation":"

A value that indicates whether the update was made successful.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

If the update wasn't successful, indicates the reason why it failed.

" - } - }, - "documentation":"

A value that indicates whether the update was successful.

" - }, - "LastUpdateStatusValue":{ - "type":"string", - "enum":[ - "Successful", - "Failed", - "InProgress" - ] - }, - "LifecycleConfigArns":{ - "type":"list", - "member":{"shape":"StudioLifecycleConfigArn"} - }, - "LifecycleManagement":{ - "type":"string", - "enum":[ - "ENABLED", - "DISABLED" - ] - }, - "LineageEntityParameters":{ - "type":"map", - "key":{"shape":"StringParameterValue"}, - "value":{"shape":"StringParameterValue"}, - "max":30, - "min":0 - }, - "LineageGroupArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:lineage-group/.*" - }, - "LineageGroupNameOrArn":{ - "type":"string", - "max":256, - "min":1, - "pattern":"(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:lineage-group\\/)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,119})" - }, - "LineageGroupSummaries":{ - "type":"list", - "member":{"shape":"LineageGroupSummary"} - }, - "LineageGroupSummary":{ - "type":"structure", - "members":{ - "LineageGroupArn":{ - "shape":"LineageGroupArn", - "documentation":"

The Amazon Resource Name (ARN) of the lineage group resource.

" - }, - "LineageGroupName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name or Amazon Resource Name (ARN) of the lineage group.

" - }, - "DisplayName":{ - "shape":"ExperimentEntityName", - "documentation":"

The display name of the lineage group summary.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The creation time of the lineage group summary.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The last modified time of the lineage group summary.

" - } - }, - "documentation":"

Lists a summary of the properties of a lineage group. A lineage group provides a group of shareable lineage entity resources.

" - }, - "LineageMetadata":{ - "type":"structure", - "members":{ - "ActionArns":{ - "shape":"MapString2048", - "documentation":"

The Amazon Resource Name (ARN) of the lineage action.

" - }, - "ArtifactArns":{ - "shape":"MapString2048", - "documentation":"

The Amazon Resource Name (ARN) of the lineage artifact.

" - }, - "ContextArns":{ - "shape":"MapString2048", - "documentation":"

The Amazon Resource Name (ARN) of the lineage context.

" - }, - "Associations":{ - "shape":"AssociationInfoList", - "documentation":"

The lineage associations.

" - } - }, - "documentation":"

The metadata that tracks relationships between ML artifacts, actions, and contexts.

" - }, - "LineageType":{ - "type":"string", - "enum":[ - "TrialComponent", - "Artifact", - "Context", - "Action" - ] - }, - "ListAIBenchmarkJobsRequest":{ - "type":"structure", - "members":{ - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of benchmark jobs to return in the response.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous call to ListAIBenchmarkJobs didn't return the full set of jobs, the call returns a token for getting the next set.

" - }, - "NameContains":{ - "shape":"NameContains", - "documentation":"

A string in the job name. This filter returns only jobs whose name contains the specified string.

" - }, - "StatusEquals":{ - "shape":"AIBenchmarkJobStatus", - "documentation":"

A filter that returns only benchmark jobs with the specified status.

" - }, - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only jobs created after the specified time.

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only jobs created before the specified time.

" - }, - "SortBy":{ - "shape":"ListAIBenchmarkJobsSortBy", - "documentation":"

The field to sort results by. The default is CreationTime.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The sort order for results. The default is Descending.

" - } - } - }, - "ListAIBenchmarkJobsResponse":{ - "type":"structure", - "required":["AIBenchmarkJobs"], - "members":{ - "AIBenchmarkJobs":{ - "shape":"AIBenchmarkJobSummaryList", - "documentation":"

An array of AIBenchmarkJobSummary objects, one for each benchmark job that matches the specified filters.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the response is truncated, Amazon SageMaker AI returns this token. To retrieve the next set of jobs, use it in the subsequent request.

" - } - } - }, - "ListAIBenchmarkJobsSortBy":{ - "type":"string", - "enum":[ - "Name", - "CreationTime", - "Status" - ] - }, - "ListAIRecommendationJobsRequest":{ - "type":"structure", - "members":{ - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of recommendation jobs to return in the response.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous call to ListAIRecommendationJobs didn't return the full set of jobs, the call returns a token for getting the next set.

" - }, - "NameContains":{ - "shape":"NameContains", - "documentation":"

A string in the job name. This filter returns only jobs whose name contains the specified string.

" - }, - "StatusEquals":{ - "shape":"AIRecommendationJobStatus", - "documentation":"

A filter that returns only recommendation jobs with the specified status.

" - }, - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only jobs created after the specified time.

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only jobs created before the specified time.

" - }, - "SortBy":{ - "shape":"ListAIRecommendationJobsSortBy", - "documentation":"

The field to sort results by. The default is CreationTime.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The sort order for results. The default is Descending.

" - } - } - }, - "ListAIRecommendationJobsResponse":{ - "type":"structure", - "required":["AIRecommendationJobs"], - "members":{ - "AIRecommendationJobs":{ - "shape":"AIRecommendationJobSummaryList", - "documentation":"

An array of AIRecommendationJobSummary objects, one for each recommendation job that matches the specified filters.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the response is truncated, Amazon SageMaker AI returns this token. To retrieve the next set of jobs, use it in the subsequent request.

" - } - } - }, - "ListAIRecommendationJobsSortBy":{ - "type":"string", - "enum":[ - "Name", - "CreationTime", - "Status" - ] - }, - "ListAIWorkloadConfigsRequest":{ - "type":"structure", - "members":{ - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of AI workload configurations to return in the response.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous call to ListAIWorkloadConfigs didn't return the full set of configurations, the call returns a token for getting the next set of configurations.

" - }, - "NameContains":{ - "shape":"NameContains", - "documentation":"

A string in the configuration name. This filter returns only configurations whose name contains the specified string.

" - }, - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only configurations created after the specified time.

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only configurations created before the specified time.

" - }, - "SortBy":{ - "shape":"ListAIWorkloadConfigsSortBy", - "documentation":"

The field to sort results by. The default is CreationTime.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The sort order for results. The default is Descending.

" - } - } - }, - "ListAIWorkloadConfigsResponse":{ - "type":"structure", - "required":["AIWorkloadConfigs"], - "members":{ - "AIWorkloadConfigs":{ - "shape":"AIWorkloadConfigSummaryList", - "documentation":"

An array of AIWorkloadConfigSummary objects, one for each AI workload configuration that matches the specified filters.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the response is truncated, Amazon SageMaker AI returns this token. To retrieve the next set of configurations, use it in the subsequent request.

" - } - } - }, - "ListAIWorkloadConfigsSortBy":{ - "type":"string", - "enum":[ - "Name", - "CreationTime" - ] - }, - "ListActionsRequest":{ - "type":"structure", - "members":{ - "SourceUri":{ - "shape":"SourceUri", - "documentation":"

A filter that returns only actions with the specified source URI.

" - }, - "ActionType":{ - "shape":"String256", - "documentation":"

A filter that returns only actions of the specified type.

" - }, - "CreatedAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only actions created on or after the specified time.

" - }, - "CreatedBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only actions created on or before the specified time.

" - }, - "SortBy":{ - "shape":"SortActionsBy", - "documentation":"

The property used to sort results. The default value is CreationTime.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The sort order. The default value is Descending.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous call to ListActions didn't return the full set of actions, the call returns a token for getting the next set of actions.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of actions to return in the response. The default value is 10.

" - } - } - }, - "ListActionsResponse":{ - "type":"structure", - "members":{ - "ActionSummaries":{ - "shape":"ActionSummaries", - "documentation":"

A list of actions and their properties.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

A token for getting the next set of actions, if there are any.

" - } - } - }, - "ListAlgorithmsInput":{ - "type":"structure", - "members":{ - "CreationTimeAfter":{ - "shape":"CreationTime", - "documentation":"

A filter that returns only algorithms created after the specified time (timestamp).

" - }, - "CreationTimeBefore":{ - "shape":"CreationTime", - "documentation":"

A filter that returns only algorithms created before the specified time (timestamp).

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of algorithms to return in the response.

" - }, - "NameContains":{ - "shape":"NameContains", - "documentation":"

A string in the algorithm name. This filter returns only algorithms whose name contains the specified string.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the response to a previous ListAlgorithms request was truncated, the response includes a NextToken. To retrieve the next set of algorithms, use the token in the next request.

" - }, - "SortBy":{ - "shape":"AlgorithmSortBy", - "documentation":"

The parameter by which to sort the results. The default is CreationTime.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The sort order for the results. The default is Ascending.

" - } - } - }, - "ListAlgorithmsOutput":{ - "type":"structure", - "required":["AlgorithmSummaryList"], - "members":{ - "AlgorithmSummaryList":{ - "shape":"AlgorithmSummaryList", - "documentation":"

>An array of AlgorithmSummary objects, each of which lists an algorithm.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.

" - } - } - }, - "ListAliasesRequest":{ - "type":"structure", - "required":["ImageName"], - "members":{ - "ImageName":{ - "shape":"ImageName", - "documentation":"

The name of the image.

" - }, - "Alias":{ - "shape":"SageMakerImageVersionAlias", - "documentation":"

The alias of the image version.

" - }, - "Version":{ - "shape":"ImageVersionNumber", - "documentation":"

The version of the image. If image version is not specified, the aliases of all versions of the image are listed.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of aliases to return.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous call to ListAliases didn't return the full set of aliases, the call returns a token for retrieving the next set of aliases.

" - } - } - }, - "ListAliasesResponse":{ - "type":"structure", - "members":{ - "SageMakerImageVersionAliases":{ - "shape":"SageMakerImageVersionAliases", - "documentation":"

A list of SageMaker AI image version aliases.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

A token for getting the next set of aliases, if more aliases exist.

" - } - } - }, - "ListAppImageConfigsRequest":{ - "type":"structure", - "members":{ - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The total number of items to return in the response. If the total number of items available is more than the value specified, a NextToken is provided in the response. To resume pagination, provide the NextToken value in the as part of a subsequent call. The default value is 10.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous call to ListImages didn't return the full set of AppImageConfigs, the call returns a token for getting the next set of AppImageConfigs.

" - }, - "NameContains":{ - "shape":"AppImageConfigName", - "documentation":"

A filter that returns only AppImageConfigs whose name contains the specified string.

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only AppImageConfigs created on or before the specified time.

" - }, - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only AppImageConfigs created on or after the specified time.

" - }, - "ModifiedTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only AppImageConfigs modified on or before the specified time.

" - }, - "ModifiedTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only AppImageConfigs modified on or after the specified time.

" - }, - "SortBy":{ - "shape":"AppImageConfigSortKey", - "documentation":"

The property used to sort results. The default value is CreationTime.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The sort order. The default value is Descending.

" - } - } - }, - "ListAppImageConfigsResponse":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"

A token for getting the next set of AppImageConfigs, if there are any.

" - }, - "AppImageConfigs":{ - "shape":"AppImageConfigList", - "documentation":"

A list of AppImageConfigs and their properties.

" - } - } - }, - "ListAppsRequest":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

This parameter defines the maximum number of results that can be return in a single response. The MaxResults parameter is an upper bound, not a target. If there are more results available than the value specified, a NextToken is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The sort order for the results. The default is Ascending.

" - }, - "SortBy":{ - "shape":"AppSortKey", - "documentation":"

The parameter by which to sort the results. The default is CreationTime.

" - }, - "DomainIdEquals":{ - "shape":"DomainId", - "documentation":"

A parameter to search for the domain ID.

" - }, - "UserProfileNameEquals":{ - "shape":"UserProfileName", - "documentation":"

A parameter to search by user profile name. If SpaceNameEquals is set, then this value cannot be set.

" - }, - "SpaceNameEquals":{ - "shape":"SpaceName", - "documentation":"

A parameter to search by space name. If UserProfileNameEquals is set, then this value cannot be set.

" - } - } - }, - "ListAppsResponse":{ - "type":"structure", - "members":{ - "Apps":{ - "shape":"AppList", - "documentation":"

The list of apps.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

" - } - } - }, - "ListArtifactsRequest":{ - "type":"structure", - "members":{ - "SourceUri":{ - "shape":"SourceUri", - "documentation":"

A filter that returns only artifacts with the specified source URI.

" - }, - "ArtifactType":{ - "shape":"String256", - "documentation":"

A filter that returns only artifacts of the specified type.

" - }, - "CreatedAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only artifacts created on or after the specified time.

" - }, - "CreatedBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only artifacts created on or before the specified time.

" - }, - "SortBy":{ - "shape":"SortArtifactsBy", - "documentation":"

The property used to sort results. The default value is CreationTime.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The sort order. The default value is Descending.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous call to ListArtifacts didn't return the full set of artifacts, the call returns a token for getting the next set of artifacts.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of artifacts to return in the response. The default value is 10.

" - } - } - }, - "ListArtifactsResponse":{ - "type":"structure", - "members":{ - "ArtifactSummaries":{ - "shape":"ArtifactSummaries", - "documentation":"

A list of artifacts and their properties.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

A token for getting the next set of artifacts, if there are any.

" - } - } - }, - "ListAssociationsRequest":{ - "type":"structure", - "members":{ - "SourceArn":{ - "shape":"AssociationEntityArn", - "documentation":"

A filter that returns only associations with the specified source ARN.

" - }, - "DestinationArn":{ - "shape":"AssociationEntityArn", - "documentation":"

A filter that returns only associations with the specified destination Amazon Resource Name (ARN).

" - }, - "SourceType":{ - "shape":"String256", - "documentation":"

A filter that returns only associations with the specified source type.

" - }, - "DestinationType":{ - "shape":"String256", - "documentation":"

A filter that returns only associations with the specified destination type.

" - }, - "AssociationType":{ - "shape":"AssociationEdgeType", - "documentation":"

A filter that returns only associations of the specified type.

" - }, - "CreatedAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only associations created on or after the specified time.

" - }, - "CreatedBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only associations created on or before the specified time.

" - }, - "SortBy":{ - "shape":"SortAssociationsBy", - "documentation":"

The property used to sort results. The default value is CreationTime.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The sort order. The default value is Descending.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous call to ListAssociations didn't return the full set of associations, the call returns a token for getting the next set of associations.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of associations to return in the response. The default value is 10.

" - } - } - }, - "ListAssociationsResponse":{ - "type":"structure", - "members":{ - "AssociationSummaries":{ - "shape":"AssociationSummaries", - "documentation":"

A list of associations and their properties.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

A token for getting the next set of associations, if there are any.

" - } - } - }, - "ListAutoMLJobsRequest":{ - "type":"structure", - "members":{ - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

Request a list of jobs, using a filter for time.

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

Request a list of jobs, using a filter for time.

" - }, - "LastModifiedTimeAfter":{ - "shape":"Timestamp", - "documentation":"

Request a list of jobs, using a filter for time.

" - }, - "LastModifiedTimeBefore":{ - "shape":"Timestamp", - "documentation":"

Request a list of jobs, using a filter for time.

" - }, - "NameContains":{ - "shape":"AutoMLNameContains", - "documentation":"

Request a list of jobs, using a search filter for name.

" - }, - "StatusEquals":{ - "shape":"AutoMLJobStatus", - "documentation":"

Request a list of jobs, using a filter for status.

" - }, - "SortOrder":{ - "shape":"AutoMLSortOrder", - "documentation":"

The sort order for the results. The default is Descending.

" - }, - "SortBy":{ - "shape":"AutoMLSortBy", - "documentation":"

The parameter by which to sort the results. The default is Name.

" - }, - "MaxResults":{ - "shape":"AutoMLMaxResults", - "documentation":"

Request a list of jobs up to a specified limit.

", - "box":true - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

" - } - } - }, - "ListAutoMLJobsResponse":{ - "type":"structure", - "required":["AutoMLJobSummaries"], - "members":{ - "AutoMLJobSummaries":{ - "shape":"AutoMLJobSummaries", - "documentation":"

Returns a summary list of jobs.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

" - } - } - }, - "ListCandidatesForAutoMLJobRequest":{ - "type":"structure", - "required":["AutoMLJobName"], - "members":{ - "AutoMLJobName":{ - "shape":"AutoMLJobName", - "documentation":"

List the candidates created for the job by providing the job's name.

" - }, - "StatusEquals":{ - "shape":"CandidateStatus", - "documentation":"

List the candidates for the job and filter by status.

" - }, - "CandidateNameEquals":{ - "shape":"CandidateName", - "documentation":"

List the candidates for the job and filter by candidate name.

" - }, - "SortOrder":{ - "shape":"AutoMLSortOrder", - "documentation":"

The sort order for the results. The default is Ascending.

" - }, - "SortBy":{ - "shape":"CandidateSortBy", - "documentation":"

The parameter by which to sort the results. The default is Descending.

" - }, - "MaxResults":{ - "shape":"AutoMLMaxResultsForTrials", - "documentation":"

List the job's candidates up to a specified limit.

", - "box":true - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

" - } - } - }, - "ListCandidatesForAutoMLJobResponse":{ - "type":"structure", - "required":["Candidates"], - "members":{ - "Candidates":{ - "shape":"AutoMLCandidates", - "documentation":"

Summaries about the AutoMLCandidates.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

" - } - } - }, - "ListClusterEventsRequest":{ - "type":"structure", - "required":["ClusterName"], - "members":{ - "ClusterName":{ - "shape":"ClusterNameOrArn", - "documentation":"

The name or Amazon Resource Name (ARN) of the HyperPod cluster for which to list events.

" - }, - "InstanceGroupName":{ - "shape":"ClusterInstanceGroupName", - "documentation":"

The name of the instance group to filter events. If specified, only events related to this instance group are returned.

" - }, - "NodeId":{ - "shape":"ClusterNodeId", - "documentation":"

The EC2 instance ID to filter events. If specified, only events related to this instance are returned.

" - }, - "EventTimeAfter":{ - "shape":"Timestamp", - "documentation":"

The start of the time range for filtering events. Only events that occurred after this time are included in the results.

" - }, - "EventTimeBefore":{ - "shape":"Timestamp", - "documentation":"

The end of the time range for filtering events. Only events that occurred before this time are included in the results.

" - }, - "SortBy":{ - "shape":"EventSortBy", - "documentation":"

The field to use for sorting the event list. Currently, the only supported value is EventTime.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The order in which to sort the results. Valid values are Ascending or Descending (the default is Descending).

" - }, - "ResourceType":{ - "shape":"ClusterEventResourceType", - "documentation":"

The type of resource for which to filter events. Valid values are Cluster, InstanceGroup, or Instance.

" - }, - "MaxResults":{ - "shape":"ClusterEventMaxResults", - "documentation":"

The maximum number of events to return in the response. Valid range is 1 to 100.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

A token to retrieve the next set of results. This token is obtained from the output of a previous ListClusterEvents call.

" - } - } - }, - "ListClusterEventsResponse":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"

A token to retrieve the next set of results. Include this token in subsequent ListClusterEvents calls to fetch more events.

" - }, - "Events":{ - "shape":"ClusterEventSummaries", - "documentation":"

A list of event summaries matching the specified criteria.

" - } - } - }, - "ListClusterNodesRequest":{ - "type":"structure", - "required":["ClusterName"], - "members":{ - "ClusterName":{ - "shape":"ClusterNameOrArn", - "documentation":"

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want to retrieve the list of nodes.

" - }, - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns nodes in a SageMaker HyperPod cluster created after the specified time. Timestamps are formatted according to the ISO 8601 standard.

Acceptable formats include:

  • YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example, 2014-10-01T20:30:00.000Z

  • YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example, 2014-10-01T12:30:00.000-08:00

  • YYYY-MM-DD, for example, 2014-10-01

  • Unix time in seconds, for example, 1412195400. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC.

For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The acceptable formats are the same as the timestamp formats for CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.

" - }, - "InstanceGroupNameContains":{ - "shape":"ClusterInstanceGroupName", - "documentation":"

A filter that returns the instance groups whose name contain a specified string.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of nodes to return in the response.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the result of the previous ListClusterNodes request was truncated, the response includes a NextToken. To retrieve the next set of cluster nodes, use the token in the next request.

" - }, - "SortBy":{ - "shape":"ClusterSortBy", - "documentation":"

The field by which to sort results. The default value is CREATION_TIME.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The sort order for results. The default value is Ascending.

" - }, - "IncludeNodeLogicalIds":{ - "shape":"IncludeNodeLogicalIdsBoolean", - "documentation":"

Specifies whether to include nodes that are still being provisioned in the response. When set to true, the response includes all nodes regardless of their provisioning status. When set to False (default), only nodes with assigned InstanceIds are returned.

" - } - } - }, - "ListClusterNodesResponse":{ - "type":"structure", - "required":["ClusterNodeSummaries"], - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"

The next token specified for listing instances in a SageMaker HyperPod cluster.

" - }, - "ClusterNodeSummaries":{ - "shape":"ClusterNodeSummaries", - "documentation":"

The summaries of listed instances in a SageMaker HyperPod cluster

" - } - } - }, - "ListClusterSchedulerConfigsRequest":{ - "type":"structure", - "members":{ - "CreatedAfter":{ - "shape":"Timestamp", - "documentation":"

Filter for after this creation time. The input for this parameter is a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.

" - }, - "CreatedBefore":{ - "shape":"Timestamp", - "documentation":"

Filter for before this creation time. The input for this parameter is a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.

" - }, - "NameContains":{ - "shape":"EntityName", - "documentation":"

Filter for name containing this string.

" - }, - "ClusterArn":{ - "shape":"ClusterArn", - "documentation":"

Filter for ARN of the cluster.

" - }, - "Status":{ - "shape":"SchedulerResourceStatus", - "documentation":"

Filter for status.

" - }, - "SortBy":{ - "shape":"SortClusterSchedulerConfigBy", - "documentation":"

Filter for sorting the list by a given value. For example, sort by name, creation time, or status.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The order of the list. By default, listed in Descending order according to by SortBy. To change the list order, you can specify SortOrder to be Ascending.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of cluster policies to list.

" - } - } - }, - "ListClusterSchedulerConfigsResponse":{ - "type":"structure", - "members":{ - "ClusterSchedulerConfigSummaries":{ - "shape":"ClusterSchedulerConfigSummaryList", - "documentation":"

Summaries of the cluster policies.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

" - } - } - }, - "ListClustersRequest":{ - "type":"structure", - "members":{ - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

Set a start time for the time range during which you want to list SageMaker HyperPod clusters. Timestamps are formatted according to the ISO 8601 standard.

Acceptable formats include:

  • YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example, 2014-10-01T20:30:00.000Z

  • YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example, 2014-10-01T12:30:00.000-08:00

  • YYYY-MM-DD, for example, 2014-10-01

  • Unix time in seconds, for example, 1412195400. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC.

For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

Set an end time for the time range during which you want to list SageMaker HyperPod clusters. A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The acceptable formats are the same as the timestamp formats for CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

Specifies the maximum number of clusters to evaluate for the operation (not necessarily the number of matching items). After SageMaker processes the number of clusters up to MaxResults, it stops the operation and returns the matching clusters up to that point. If all the matching clusters are desired, SageMaker will go through all the clusters until NextToken is empty.

" - }, - "NameContains":{ - "shape":"NameContains", - "documentation":"

Set the maximum number of instances to print in the list.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

Set the next token to retrieve the list of SageMaker HyperPod clusters.

" - }, - "SortBy":{ - "shape":"ClusterSortBy", - "documentation":"

The field by which to sort results. The default value is CREATION_TIME.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The sort order for results. The default value is Ascending.

" - }, - "TrainingPlanArn":{ - "shape":"TrainingPlanArn", - "documentation":"

The Amazon Resource Name (ARN); of the training plan to filter clusters by. For more information about reserving GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

" - } - } - }, - "ListClustersResponse":{ - "type":"structure", - "required":["ClusterSummaries"], - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the result of the previous ListClusters request was truncated, the response includes a NextToken. To retrieve the next set of clusters, use the token in the next request.

" - }, - "ClusterSummaries":{ - "shape":"ClusterSummaries", - "documentation":"

The summaries of listed SageMaker HyperPod clusters.

" - } - } - }, - "ListCodeRepositoriesInput":{ - "type":"structure", - "members":{ - "CreationTimeAfter":{ - "shape":"CreationTime", - "documentation":"

A filter that returns only Git repositories that were created after the specified time.

" - }, - "CreationTimeBefore":{ - "shape":"CreationTime", - "documentation":"

A filter that returns only Git repositories that were created before the specified time.

" - }, - "LastModifiedTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only Git repositories that were last modified after the specified time.

" - }, - "LastModifiedTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only Git repositories that were last modified before the specified time.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of Git repositories to return in the response.

" - }, - "NameContains":{ - "shape":"CodeRepositoryNameContains", - "documentation":"

A string in the Git repositories name. This filter returns only repositories whose name contains the specified string.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the result of a ListCodeRepositoriesOutput request was truncated, the response includes a NextToken. To get the next set of Git repositories, use the token in the next request.

" - }, - "SortBy":{ - "shape":"CodeRepositorySortBy", - "documentation":"

The field to sort results by. The default is Name.

" - }, - "SortOrder":{ - "shape":"CodeRepositorySortOrder", - "documentation":"

The sort order for results. The default is Ascending.

" - } - } - }, - "ListCodeRepositoriesOutput":{ - "type":"structure", - "required":["CodeRepositorySummaryList"], - "members":{ - "CodeRepositorySummaryList":{ - "shape":"CodeRepositorySummaryList", - "documentation":"

Gets a list of summaries of the Git repositories. Each summary specifies the following values for the repository:

  • Name

  • Amazon Resource Name (ARN)

  • Creation time

  • Last modified time

  • Configuration information, including the URL location of the repository and the ARN of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the repository.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the result of a ListCodeRepositoriesOutput request was truncated, the response includes a NextToken. To get the next set of Git repositories, use the token in the next request.

" - } - } - }, - "ListCompilationJobsRequest":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the result of the previous ListCompilationJobs request was truncated, the response includes a NextToken. To retrieve the next set of model compilation jobs, use the token in the next request.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of model compilation jobs to return in the response.

" - }, - "CreationTimeAfter":{ - "shape":"CreationTime", - "documentation":"

A filter that returns the model compilation jobs that were created after a specified time.

" - }, - "CreationTimeBefore":{ - "shape":"CreationTime", - "documentation":"

A filter that returns the model compilation jobs that were created before a specified time.

" - }, - "LastModifiedTimeAfter":{ - "shape":"LastModifiedTime", - "documentation":"

A filter that returns the model compilation jobs that were modified after a specified time.

" - }, - "LastModifiedTimeBefore":{ - "shape":"LastModifiedTime", - "documentation":"

A filter that returns the model compilation jobs that were modified before a specified time.

" - }, - "NameContains":{ - "shape":"NameContains", - "documentation":"

A filter that returns the model compilation jobs whose name contains a specified string.

" - }, - "StatusEquals":{ - "shape":"CompilationJobStatus", - "documentation":"

A filter that retrieves model compilation jobs with a specific CompilationJobStatus status.

" - }, - "SortBy":{ - "shape":"ListCompilationJobsSortBy", - "documentation":"

The field by which to sort results. The default is CreationTime.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The sort order for results. The default is Ascending.

" - } - } - }, - "ListCompilationJobsResponse":{ - "type":"structure", - "required":["CompilationJobSummaries"], - "members":{ - "CompilationJobSummaries":{ - "shape":"CompilationJobSummaries", - "documentation":"

An array of CompilationJobSummary objects, each describing a model compilation job.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the response is truncated, Amazon SageMaker AI returns this NextToken. To retrieve the next set of model compilation jobs, use this token in the next request.

" - } - } - }, - "ListCompilationJobsSortBy":{ - "type":"string", - "enum":[ - "Name", - "CreationTime", - "Status" - ] - }, - "ListComputeQuotasRequest":{ - "type":"structure", - "members":{ - "CreatedAfter":{ - "shape":"Timestamp", - "documentation":"

Filter for after this creation time. The input for this parameter is a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.

" - }, - "CreatedBefore":{ - "shape":"Timestamp", - "documentation":"

Filter for before this creation time. The input for this parameter is a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.

" - }, - "NameContains":{ - "shape":"EntityName", - "documentation":"

Filter for name containing this string.

" - }, - "Status":{ - "shape":"SchedulerResourceStatus", - "documentation":"

Filter for status.

" - }, - "ClusterArn":{ - "shape":"ClusterArn", - "documentation":"

Filter for ARN of the cluster.

" - }, - "SortBy":{ - "shape":"SortQuotaBy", - "documentation":"

Filter for sorting the list by a given value. For example, sort by name, creation time, or status.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The order of the list. By default, listed in Descending order according to by SortBy. To change the list order, you can specify SortOrder to be Ascending.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of compute allocation definitions to list.

" - } - } - }, - "ListComputeQuotasResponse":{ - "type":"structure", - "members":{ - "ComputeQuotaSummaries":{ - "shape":"ComputeQuotaSummaryList", - "documentation":"

Summaries of the compute allocation definitions.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

" - } - } - }, - "ListContextsRequest":{ - "type":"structure", - "members":{ - "SourceUri":{ - "shape":"SourceUri", - "documentation":"

A filter that returns only contexts with the specified source URI.

" - }, - "ContextType":{ - "shape":"String256", - "documentation":"

A filter that returns only contexts of the specified type.

" - }, - "CreatedAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only contexts created on or after the specified time.

" - }, - "CreatedBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only contexts created on or before the specified time.

" - }, - "SortBy":{ - "shape":"SortContextsBy", - "documentation":"

The property used to sort results. The default value is CreationTime.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The sort order. The default value is Descending.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous call to ListContexts didn't return the full set of contexts, the call returns a token for getting the next set of contexts.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of contexts to return in the response. The default value is 10.

" - } - } - }, - "ListContextsResponse":{ - "type":"structure", - "members":{ - "ContextSummaries":{ - "shape":"ContextSummaries", - "documentation":"

A list of contexts and their properties.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

A token for getting the next set of contexts, if there are any.

" - } - } - }, - "ListDataQualityJobDefinitionsRequest":{ - "type":"structure", - "members":{ - "EndpointName":{ - "shape":"EndpointName", - "documentation":"

A filter that lists the data quality job definitions associated with the specified endpoint.

" - }, - "SortBy":{ - "shape":"MonitoringJobDefinitionSortKey", - "documentation":"

The field to sort results by. The default is CreationTime.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

Whether to sort the results in Ascending or Descending order. The default is Descending.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the result of the previous ListDataQualityJobDefinitions request was truncated, the response includes a NextToken. To retrieve the next set of transform jobs, use the token in the next request.>

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of data quality monitoring job definitions to return in the response.

" - }, - "NameContains":{ - "shape":"NameContains", - "documentation":"

A string in the data quality monitoring job definition name. This filter returns only data quality monitoring job definitions whose name contains the specified string.

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only data quality monitoring job definitions created before the specified time.

" - }, - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only data quality monitoring job definitions created after the specified time.

" - } - } - }, - "ListDataQualityJobDefinitionsResponse":{ - "type":"structure", - "required":["JobDefinitionSummaries"], - "members":{ - "JobDefinitionSummaries":{ - "shape":"MonitoringJobDefinitionSummaryList", - "documentation":"

A list of data quality monitoring job definitions.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the result of the previous ListDataQualityJobDefinitions request was truncated, the response includes a NextToken. To retrieve the next set of data quality monitoring job definitions, use the token in the next request.

" - } - } - }, - "ListDeviceFleetsRequest":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"

The response from the last list when returning a list large enough to need tokening.

" - }, - "MaxResults":{ - "shape":"ListMaxResults", - "documentation":"

The maximum number of results to select.

", - "box":true - }, - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

Filter fleets where packaging job was created after specified time.

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

Filter fleets where the edge packaging job was created before specified time.

" - }, - "LastModifiedTimeAfter":{ - "shape":"Timestamp", - "documentation":"

Select fleets where the job was updated after X

" - }, - "LastModifiedTimeBefore":{ - "shape":"Timestamp", - "documentation":"

Select fleets where the job was updated before X

" - }, - "NameContains":{ - "shape":"NameContains", - "documentation":"

Filter for fleets containing this name in their fleet device name.

" - }, - "SortBy":{ - "shape":"ListDeviceFleetsSortBy", - "documentation":"

The column to sort by.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

What direction to sort in.

" - } - } - }, - "ListDeviceFleetsResponse":{ - "type":"structure", - "required":["DeviceFleetSummaries"], - "members":{ - "DeviceFleetSummaries":{ - "shape":"DeviceFleetSummaries", - "documentation":"

Summary of the device fleet.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

The response from the last list when returning a list large enough to need tokening.

" - } - } - }, - "ListDeviceFleetsSortBy":{ - "type":"string", - "enum":[ - "NAME", - "CREATION_TIME", - "LAST_MODIFIED_TIME" - ] - }, - "ListDevicesRequest":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"

The response from the last list when returning a list large enough to need tokening.

" - }, - "MaxResults":{ - "shape":"ListMaxResults", - "documentation":"

Maximum number of results to select.

", - "box":true - }, - "LatestHeartbeatAfter":{ - "shape":"Timestamp", - "documentation":"

Select fleets where the job was updated after X

" - }, - "ModelName":{ - "shape":"EntityName", - "documentation":"

A filter that searches devices that contains this name in any of their models.

" - }, - "DeviceFleetName":{ - "shape":"EntityName", - "documentation":"

Filter for fleets containing this name in their device fleet name.

" - } - } - }, - "ListDevicesResponse":{ - "type":"structure", - "required":["DeviceSummaries"], - "members":{ - "DeviceSummaries":{ - "shape":"DeviceSummaries", - "documentation":"

Summary of devices.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

The response from the last list when returning a list large enough to need tokening.

" - } - } - }, - "ListDomainsRequest":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

This parameter defines the maximum number of results that can be return in a single response. The MaxResults parameter is an upper bound, not a target. If there are more results available than the value specified, a NextToken is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.

" - } - } - }, - "ListDomainsResponse":{ - "type":"structure", - "members":{ - "Domains":{ - "shape":"DomainList", - "documentation":"

The list of domains.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

" - } - } - }, - "ListEdgeDeploymentPlansRequest":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"

The response from the last list when returning a list large enough to need tokening.

" - }, - "MaxResults":{ - "shape":"ListMaxResults", - "documentation":"

The maximum number of results to select (50 by default).

", - "box":true - }, - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

Selects edge deployment plans created after this time.

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

Selects edge deployment plans created before this time.

" - }, - "LastModifiedTimeAfter":{ - "shape":"Timestamp", - "documentation":"

Selects edge deployment plans that were last updated after this time.

" - }, - "LastModifiedTimeBefore":{ - "shape":"Timestamp", - "documentation":"

Selects edge deployment plans that were last updated before this time.

" - }, - "NameContains":{ - "shape":"NameContains", - "documentation":"

Selects edge deployment plans with names containing this name.

" - }, - "DeviceFleetNameContains":{ - "shape":"NameContains", - "documentation":"

Selects edge deployment plans with a device fleet name containing this name.

" - }, - "SortBy":{ - "shape":"ListEdgeDeploymentPlansSortBy", - "documentation":"

The column by which to sort the edge deployment plans. Can be one of NAME, DEVICEFLEETNAME, CREATIONTIME, LASTMODIFIEDTIME.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The direction of the sorting (ascending or descending).

" - } - } - }, - "ListEdgeDeploymentPlansResponse":{ - "type":"structure", - "required":["EdgeDeploymentPlanSummaries"], - "members":{ - "EdgeDeploymentPlanSummaries":{ - "shape":"EdgeDeploymentPlanSummaries", - "documentation":"

List of summaries of edge deployment plans.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

The token to use when calling the next page of results.

" - } - } - }, - "ListEdgeDeploymentPlansSortBy":{ - "type":"string", - "enum":[ - "NAME", - "DEVICE_FLEET_NAME", - "CREATION_TIME", - "LAST_MODIFIED_TIME" - ] - }, - "ListEdgePackagingJobsRequest":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"

The response from the last list when returning a list large enough to need tokening.

" - }, - "MaxResults":{ - "shape":"ListMaxResults", - "documentation":"

Maximum number of results to select.

", - "box":true - }, - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

Select jobs where the job was created after specified time.

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

Select jobs where the job was created before specified time.

" - }, - "LastModifiedTimeAfter":{ - "shape":"Timestamp", - "documentation":"

Select jobs where the job was updated after specified time.

" - }, - "LastModifiedTimeBefore":{ - "shape":"Timestamp", - "documentation":"

Select jobs where the job was updated before specified time.

" - }, - "NameContains":{ - "shape":"NameContains", - "documentation":"

Filter for jobs containing this name in their packaging job name.

" - }, - "ModelNameContains":{ - "shape":"NameContains", - "documentation":"

Filter for jobs where the model name contains this string.

" - }, - "StatusEquals":{ - "shape":"EdgePackagingJobStatus", - "documentation":"

The job status to filter for.

" - }, - "SortBy":{ - "shape":"ListEdgePackagingJobsSortBy", - "documentation":"

Use to specify what column to sort by.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

What direction to sort by.

" - } - } - }, - "ListEdgePackagingJobsResponse":{ - "type":"structure", - "required":["EdgePackagingJobSummaries"], - "members":{ - "EdgePackagingJobSummaries":{ - "shape":"EdgePackagingJobSummaries", - "documentation":"

Summaries of edge packaging jobs.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

Token to use when calling the next page of results.

" - } - } - }, - "ListEdgePackagingJobsSortBy":{ - "type":"string", - "enum":[ - "NAME", - "MODEL_NAME", - "CREATION_TIME", - "LAST_MODIFIED_TIME", - "STATUS" - ] - }, - "ListEndpointConfigsInput":{ - "type":"structure", - "members":{ - "SortBy":{ - "shape":"EndpointConfigSortKey", - "documentation":"

The field to sort results by. The default is CreationTime.

" - }, - "SortOrder":{ - "shape":"OrderKey", - "documentation":"

The sort order for results. The default is Descending.

" - }, - "NextToken":{ - "shape":"PaginationToken", - "documentation":"

If the result of the previous ListEndpointConfig request was truncated, the response includes a NextToken. To retrieve the next set of endpoint configurations, use the token in the next request.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of training jobs to return in the response.

" - }, - "NameContains":{ - "shape":"EndpointConfigNameContains", - "documentation":"

A string in the endpoint configuration name. This filter returns only endpoint configurations whose name contains the specified string.

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only endpoint configurations created before the specified time (timestamp).

" - }, - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only endpoint configurations with a creation time greater than or equal to the specified time (timestamp).

" - } - } - }, - "ListEndpointConfigsOutput":{ - "type":"structure", - "required":["EndpointConfigs"], - "members":{ - "EndpointConfigs":{ - "shape":"EndpointConfigSummaryList", - "documentation":"

An array of endpoint configurations.

" - }, - "NextToken":{ - "shape":"PaginationToken", - "documentation":"

If the response is truncated, SageMaker returns this token. To retrieve the next set of endpoint configurations, use it in the subsequent request

" - } - } - }, - "ListEndpointsInput":{ - "type":"structure", - "members":{ - "SortBy":{ - "shape":"EndpointSortKey", - "documentation":"

Sorts the list of results. The default is CreationTime.

" - }, - "SortOrder":{ - "shape":"OrderKey", - "documentation":"

The sort order for results. The default is Descending.

" - }, - "NextToken":{ - "shape":"PaginationToken", - "documentation":"

If the result of a ListEndpoints request was truncated, the response includes a NextToken. To retrieve the next set of endpoints, use the token in the next request.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of endpoints to return in the response. This value defaults to 10.

" - }, - "NameContains":{ - "shape":"EndpointNameContains", - "documentation":"

A string in endpoint names. This filter returns only endpoints whose name contains the specified string.

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only endpoints that were created before the specified time (timestamp).

" - }, - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only endpoints with a creation time greater than or equal to the specified time (timestamp).

" - }, - "LastModifiedTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only endpoints that were modified before the specified timestamp.

" - }, - "LastModifiedTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only endpoints that were modified after the specified timestamp.

" - }, - "StatusEquals":{ - "shape":"EndpointStatus", - "documentation":"

A filter that returns only endpoints with the specified status.

" - } - } - }, - "ListEndpointsOutput":{ - "type":"structure", - "required":["Endpoints"], - "members":{ - "Endpoints":{ - "shape":"EndpointSummaryList", - "documentation":"

An array or endpoint objects.

" - }, - "NextToken":{ - "shape":"PaginationToken", - "documentation":"

If the response is truncated, SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.

" - } - } - }, - "ListExperimentsRequest":{ - "type":"structure", - "members":{ - "CreatedAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only experiments created after the specified time.

" - }, - "CreatedBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only experiments created before the specified time.

" - }, - "SortBy":{ - "shape":"SortExperimentsBy", - "documentation":"

The property used to sort results. The default value is CreationTime.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The sort order. The default value is Descending.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous call to ListExperiments didn't return the full set of experiments, the call returns a token for getting the next set of experiments.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of experiments to return in the response. The default value is 10.

" - } - } - }, - "ListExperimentsResponse":{ - "type":"structure", - "members":{ - "ExperimentSummaries":{ - "shape":"ExperimentSummaries", - "documentation":"

A list of the summaries of your experiments.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

A token for getting the next set of experiments, if there are any.

" - } - } - }, - "ListFeatureGroupsRequest":{ - "type":"structure", - "members":{ - "NameContains":{ - "shape":"FeatureGroupNameContains", - "documentation":"

A string that partially matches one or more FeatureGroups names. Filters FeatureGroups by name.

" - }, - "FeatureGroupStatusEquals":{ - "shape":"FeatureGroupStatus", - "documentation":"

A FeatureGroup status. Filters by FeatureGroup status.

" - }, - "OfflineStoreStatusEquals":{ - "shape":"OfflineStoreStatusValue", - "documentation":"

An OfflineStore status. Filters by OfflineStore status.

" - }, - "CreationTimeAfter":{ - "shape":"CreationTime", - "documentation":"

Use this parameter to search for FeatureGroupss created after a specific date and time.

" - }, - "CreationTimeBefore":{ - "shape":"CreationTime", - "documentation":"

Use this parameter to search for FeatureGroupss created before a specific date and time.

" - }, - "SortOrder":{ - "shape":"FeatureGroupSortOrder", - "documentation":"

The order in which feature groups are listed.

" - }, - "SortBy":{ - "shape":"FeatureGroupSortBy", - "documentation":"

The value on which the feature group list is sorted.

" - }, - "MaxResults":{ - "shape":"FeatureGroupMaxResults", - "documentation":"

The maximum number of results returned by ListFeatureGroups.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

A token to resume pagination of ListFeatureGroups results.

" - } - } - }, - "ListFeatureGroupsResponse":{ - "type":"structure", - "required":["FeatureGroupSummaries"], - "members":{ - "FeatureGroupSummaries":{ - "shape":"FeatureGroupSummaries", - "documentation":"

A summary of feature groups.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

A token to resume pagination of ListFeatureGroups results.

" - } - } - }, - "ListFlowDefinitionsRequest":{ - "type":"structure", - "members":{ - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only flow definitions with a creation time greater than or equal to the specified timestamp.

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only flow definitions that were created before the specified timestamp.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

An optional value that specifies whether you want the results sorted in Ascending or Descending order.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

A token to resume pagination.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.

" - } - } - }, - "ListFlowDefinitionsResponse":{ - "type":"structure", - "required":["FlowDefinitionSummaries"], - "members":{ - "FlowDefinitionSummaries":{ - "shape":"FlowDefinitionSummaries", - "documentation":"

An array of objects describing the flow definitions.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

A token to resume pagination.

" - } - } - }, - "ListHubContentVersionsRequest":{ - "type":"structure", - "required":[ - "HubName", - "HubContentType", - "HubContentName" - ], - "members":{ - "HubName":{ - "shape":"HubNameOrArn", - "documentation":"

The name of the hub to list the content versions of.

" - }, - "HubContentType":{ - "shape":"HubContentType", - "documentation":"

The type of hub content to list versions of.

" - }, - "HubContentName":{ - "shape":"HubContentName", - "documentation":"

The name of the hub content.

" - }, - "MinVersion":{ - "shape":"HubContentVersion", - "documentation":"

The lower bound of the hub content versions to list.

" - }, - "MaxSchemaVersion":{ - "shape":"DocumentSchemaVersion", - "documentation":"

The upper bound of the hub content schema version.

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

Only list hub content versions that were created before the time specified.

" - }, - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

Only list hub content versions that were created after the time specified.

" - }, - "SortBy":{ - "shape":"HubContentSortBy", - "documentation":"

Sort hub content versions by either name or creation time.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

Sort hub content versions by ascending or descending order.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of hub content versions to list.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the response to a previous ListHubContentVersions request was truncated, the response includes a NextToken. To retrieve the next set of hub content versions, use the token in the next request.

" - } - } - }, - "ListHubContentVersionsResponse":{ - "type":"structure", - "required":["HubContentSummaries"], - "members":{ - "HubContentSummaries":{ - "shape":"HubContentInfoList", - "documentation":"

The summaries of the listed hub content versions.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content versions, use it in the subsequent request.

" - } - } - }, - "ListHubContentsRequest":{ - "type":"structure", - "required":[ - "HubName", - "HubContentType" - ], - "members":{ - "HubName":{ - "shape":"HubNameOrArn", - "documentation":"

The name of the hub to list the contents of.

" - }, - "HubContentType":{ - "shape":"HubContentType", - "documentation":"

The type of hub content to list.

" - }, - "NameContains":{ - "shape":"NameContains", - "documentation":"

Only list hub content if the name contains the specified string.

" - }, - "MaxSchemaVersion":{ - "shape":"DocumentSchemaVersion", - "documentation":"

The upper bound of the hub content schema verion.

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

Only list hub content that was created before the time specified.

" - }, - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

Only list hub content that was created after the time specified.

" - }, - "SortBy":{ - "shape":"HubContentSortBy", - "documentation":"

Sort hub content versions by either name or creation time.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

Sort hubs by ascending or descending order.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum amount of hub content to list.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the response to a previous ListHubContents request was truncated, the response includes a NextToken. To retrieve the next set of hub content, use the token in the next request.

" - } - } - }, - "ListHubContentsResponse":{ - "type":"structure", - "required":["HubContentSummaries"], - "members":{ - "HubContentSummaries":{ - "shape":"HubContentInfoList", - "documentation":"

The summaries of the listed hub content.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content, use it in the subsequent request.

" - } - } - }, - "ListHubsRequest":{ - "type":"structure", - "members":{ - "NameContains":{ - "shape":"NameContains", - "documentation":"

Only list hubs with names that contain the specified string.

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

Only list hubs that were created before the time specified.

" - }, - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

Only list hubs that were created after the time specified.

" - }, - "LastModifiedTimeBefore":{ - "shape":"Timestamp", - "documentation":"

Only list hubs that were last modified before the time specified.

" - }, - "LastModifiedTimeAfter":{ - "shape":"Timestamp", - "documentation":"

Only list hubs that were last modified after the time specified.

" - }, - "SortBy":{ - "shape":"HubSortBy", - "documentation":"

Sort hubs by either name or creation time.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

Sort hubs by ascending or descending order.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of hubs to list.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the response to a previous ListHubs request was truncated, the response includes a NextToken. To retrieve the next set of hubs, use the token in the next request.

" - } - } - }, - "ListHubsResponse":{ - "type":"structure", - "required":["HubSummaries"], - "members":{ - "HubSummaries":{ - "shape":"HubInfoList", - "documentation":"

The summaries of the listed hubs.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the response is truncated, SageMaker returns this token. To retrieve the next set of hubs, use it in the subsequent request.

" - } - } - }, - "ListHumanTaskUisRequest":{ - "type":"structure", - "members":{ - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only human task user interfaces with a creation time greater than or equal to the specified timestamp.

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only human task user interfaces that were created before the specified timestamp.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

An optional value that specifies whether you want the results sorted in Ascending or Descending order.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

A token to resume pagination.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.

" - } - } - }, - "ListHumanTaskUisResponse":{ - "type":"structure", - "required":["HumanTaskUiSummaries"], - "members":{ - "HumanTaskUiSummaries":{ - "shape":"HumanTaskUiSummaries", - "documentation":"

An array of objects describing the human task user interfaces.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

A token to resume pagination.

" - } - } - }, - "ListHyperParameterTuningJobsRequest":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the result of the previous ListHyperParameterTuningJobs request was truncated, the response includes a NextToken. To retrieve the next set of tuning jobs, use the token in the next request.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of tuning jobs to return. The default value is 10.

" - }, - "SortBy":{ - "shape":"HyperParameterTuningJobSortByOptions", - "documentation":"

The field to sort results by. The default is Name.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The sort order for results. The default is Ascending.

" - }, - "NameContains":{ - "shape":"NameContains", - "documentation":"

A string in the tuning job name. This filter returns only tuning jobs whose name contains the specified string.

" - }, - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only tuning jobs that were created after the specified time.

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only tuning jobs that were created before the specified time.

" - }, - "LastModifiedTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only tuning jobs that were modified after the specified time.

" - }, - "LastModifiedTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only tuning jobs that were modified before the specified time.

" - }, - "StatusEquals":{ - "shape":"HyperParameterTuningJobStatus", - "documentation":"

A filter that returns only tuning jobs with the specified status.

" - } - } - }, - "ListHyperParameterTuningJobsResponse":{ - "type":"structure", - "required":["HyperParameterTuningJobSummaries"], - "members":{ - "HyperParameterTuningJobSummaries":{ - "shape":"HyperParameterTuningJobSummaries", - "documentation":"

A list of HyperParameterTuningJobSummary objects that describe the tuning jobs that the ListHyperParameterTuningJobs request returned.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the result of this ListHyperParameterTuningJobs request was truncated, the response includes a NextToken. To retrieve the next set of tuning jobs, use the token in the next request.

" - } - } - }, - "ListImageVersionsRequest":{ - "type":"structure", - "required":["ImageName"], - "members":{ - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only versions created on or after the specified time.

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only versions created on or before the specified time.

" - }, - "ImageName":{ - "shape":"ImageName", - "documentation":"

The name of the image to list the versions of.

" - }, - "LastModifiedTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only versions modified on or after the specified time.

" - }, - "LastModifiedTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only versions modified on or before the specified time.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of versions to return in the response. The default value is 10.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous call to ListImageVersions didn't return the full set of versions, the call returns a token for getting the next set of versions.

" - }, - "SortBy":{ - "shape":"ImageVersionSortBy", - "documentation":"

The property used to sort results. The default value is CREATION_TIME.

" - }, - "SortOrder":{ - "shape":"ImageVersionSortOrder", - "documentation":"

The sort order. The default value is DESCENDING.

" - } - } - }, - "ListImageVersionsResponse":{ - "type":"structure", - "members":{ - "ImageVersions":{ - "shape":"ImageVersions", - "documentation":"

A list of versions and their properties.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

A token for getting the next set of versions, if there are any.

" - } - } - }, - "ListImagesRequest":{ - "type":"structure", - "members":{ - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only images created on or after the specified time.

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only images created on or before the specified time.

" - }, - "LastModifiedTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only images modified on or after the specified time.

" - }, - "LastModifiedTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only images modified on or before the specified time.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of images to return in the response. The default value is 10.

" - }, - "NameContains":{ - "shape":"ImageNameContains", - "documentation":"

A filter that returns only images whose name contains the specified string.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous call to ListImages didn't return the full set of images, the call returns a token for getting the next set of images.

" - }, - "SortBy":{ - "shape":"ImageSortBy", - "documentation":"

The property used to sort results. The default value is CREATION_TIME.

" - }, - "SortOrder":{ - "shape":"ImageSortOrder", - "documentation":"

The sort order. The default value is DESCENDING.

" - } - } - }, - "ListImagesResponse":{ - "type":"structure", - "members":{ - "Images":{ - "shape":"Images", - "documentation":"

A list of images and their properties.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

A token for getting the next set of images, if there are any.

" - } - } - }, - "ListInferenceComponentsInput":{ - "type":"structure", - "members":{ - "SortBy":{ - "shape":"InferenceComponentSortKey", - "documentation":"

The field by which to sort the inference components in the response. The default is CreationTime.

" - }, - "SortOrder":{ - "shape":"OrderKey", - "documentation":"

The sort order for results. The default is Descending.

" - }, - "NextToken":{ - "shape":"PaginationToken", - "documentation":"

A token that you use to get the next set of results following a truncated response. If the response to the previous request was truncated, that response provides the value for this token.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of inference components to return in the response. This value defaults to 10.

" - }, - "NameContains":{ - "shape":"InferenceComponentNameContains", - "documentation":"

Filters the results to only those inference components with a name that contains the specified string.

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

Filters the results to only those inference components that were created before the specified time.

" - }, - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

Filters the results to only those inference components that were created after the specified time.

" - }, - "LastModifiedTimeBefore":{ - "shape":"Timestamp", - "documentation":"

Filters the results to only those inference components that were updated before the specified time.

" - }, - "LastModifiedTimeAfter":{ - "shape":"Timestamp", - "documentation":"

Filters the results to only those inference components that were updated after the specified time.

" - }, - "StatusEquals":{ - "shape":"InferenceComponentStatus", - "documentation":"

Filters the results to only those inference components with the specified status.

" - }, - "EndpointNameEquals":{ - "shape":"EndpointName", - "documentation":"

An endpoint name to filter the listed inference components. The response includes only those inference components that are hosted at the specified endpoint.

" - }, - "VariantNameEquals":{ - "shape":"VariantName", - "documentation":"

A production variant name to filter the listed inference components. The response includes only those inference components that are hosted at the specified variant.

" - } - } - }, - "ListInferenceComponentsOutput":{ - "type":"structure", - "required":["InferenceComponents"], - "members":{ - "InferenceComponents":{ - "shape":"InferenceComponentSummaryList", - "documentation":"

A list of inference components and their properties that matches any of the filters you specified in the request.

" - }, - "NextToken":{ - "shape":"PaginationToken", - "documentation":"

The token to use in a subsequent request to get the next set of results following a truncated response.

" - } - } - }, - "ListInferenceExperimentsRequest":{ - "type":"structure", - "members":{ - "NameContains":{ - "shape":"NameContains", - "documentation":"

Selects inference experiments whose names contain this name.

" - }, - "Type":{ - "shape":"InferenceExperimentType", - "documentation":"

Selects inference experiments of this type. For the possible types of inference experiments, see CreateInferenceExperiment.

" - }, - "StatusEquals":{ - "shape":"InferenceExperimentStatus", - "documentation":"

Selects inference experiments which are in this status. For the possible statuses, see DescribeInferenceExperiment.

" - }, - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

Selects inference experiments which were created after this timestamp.

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

Selects inference experiments which were created before this timestamp.

" - }, - "LastModifiedTimeAfter":{ - "shape":"Timestamp", - "documentation":"

Selects inference experiments which were last modified after this timestamp.

" - }, - "LastModifiedTimeBefore":{ - "shape":"Timestamp", - "documentation":"

Selects inference experiments which were last modified before this timestamp.

" - }, - "SortBy":{ - "shape":"SortInferenceExperimentsBy", - "documentation":"

The column by which to sort the listed inference experiments.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The direction of sorting (ascending or descending).

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

The response from the last list when returning a list large enough to need tokening.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to select.

" - } - } - }, - "ListInferenceExperimentsResponse":{ - "type":"structure", - "members":{ - "InferenceExperiments":{ - "shape":"InferenceExperimentList", - "documentation":"

List of inference experiments.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

The token to use when calling the next page of results.

" - } - } - }, - "ListInferenceRecommendationsJobStepsRequest":{ - "type":"structure", - "required":["JobName"], - "members":{ - "JobName":{ - "shape":"RecommendationJobName", - "documentation":"

The name for the Inference Recommender job.

" - }, - "Status":{ - "shape":"RecommendationJobStatus", - "documentation":"

A filter to return benchmarks of a specified status. If this field is left empty, then all benchmarks are returned.

" - }, - "StepType":{ - "shape":"RecommendationStepType", - "documentation":"

A filter to return details about the specified type of subtask.

BENCHMARK: Evaluate the performance of your model on different instance types.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

A token that you can specify to return more results from the list. Specify this field if you have a token that was returned from a previous request.

" - } - } - }, - "ListInferenceRecommendationsJobStepsResponse":{ - "type":"structure", - "members":{ - "Steps":{ - "shape":"InferenceRecommendationsJobSteps", - "documentation":"

A list of all subtask details in Inference Recommender.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

A token that you can specify in your next request to return more results from the list.

" - } - } - }, - "ListInferenceRecommendationsJobsRequest":{ - "type":"structure", - "members":{ - "CreationTimeAfter":{ - "shape":"CreationTime", - "documentation":"

A filter that returns only jobs created after the specified time (timestamp).

" - }, - "CreationTimeBefore":{ - "shape":"CreationTime", - "documentation":"

A filter that returns only jobs created before the specified time (timestamp).

" - }, - "LastModifiedTimeAfter":{ - "shape":"LastModifiedTime", - "documentation":"

A filter that returns only jobs that were last modified after the specified time (timestamp).

" - }, - "LastModifiedTimeBefore":{ - "shape":"LastModifiedTime", - "documentation":"

A filter that returns only jobs that were last modified before the specified time (timestamp).

" - }, - "NameContains":{ - "shape":"NameContains", - "documentation":"

A string in the job name. This filter returns only recommendations whose name contains the specified string.

" - }, - "StatusEquals":{ - "shape":"RecommendationJobStatus", - "documentation":"

A filter that retrieves only inference recommendations jobs with a specific status.

" - }, - "SortBy":{ - "shape":"ListInferenceRecommendationsJobsSortBy", - "documentation":"

The parameter by which to sort the results.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The sort order for the results.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the response to a previous ListInferenceRecommendationsJobsRequest request was truncated, the response includes a NextToken. To retrieve the next set of recommendations, use the token in the next request.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of recommendations to return in the response.

" - }, - "ModelNameEquals":{ - "shape":"ModelName", - "documentation":"

A filter that returns only jobs that were created for this model.

" - }, - "ModelPackageVersionArnEquals":{ - "shape":"ModelPackageArn", - "documentation":"

A filter that returns only jobs that were created for this versioned model package.

" - } - } - }, - "ListInferenceRecommendationsJobsResponse":{ - "type":"structure", - "required":["InferenceRecommendationsJobs"], - "members":{ - "InferenceRecommendationsJobs":{ - "shape":"InferenceRecommendationsJobs", - "documentation":"

The recommendations created from the Amazon SageMaker Inference Recommender job.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

A token for getting the next set of recommendations, if there are any.

" - } - } - }, - "ListInferenceRecommendationsJobsSortBy":{ - "type":"string", - "enum":[ - "Name", - "CreationTime", - "Status" - ] - }, - "ListJobSchemaVersionsRequest":{ - "type":"structure", - "required":["JobCategory"], - "members":{ - "JobCategory":{ - "shape":"JobCategory", - "documentation":"

The category of job schemas to list.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous response was truncated, this token retrieves the next set of results.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of schema versions to return in the response. The default value is 5.

" - } - } - }, - "ListJobSchemaVersionsResponse":{ - "type":"structure", - "required":["JobConfigSchemas"], - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the response is truncated, this token retrieves the next set of results.

" - }, - "JobConfigSchemas":{ - "shape":"JobConfigSchemas", - "documentation":"

An array of JobConfigSchemaVersionSummary objects listing the available schema versions.

" - } - } - }, - "ListJobsRequest":{ - "type":"structure", - "required":["JobCategory"], - "members":{ - "JobCategory":{ - "shape":"JobCategory", - "documentation":"

The category of jobs to list.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous response was truncated, this token retrieves the next set of results.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of jobs to return in the response. The default value is 50.

" - }, - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only jobs created after the specified time.

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only jobs created before the specified time.

" - }, - "LastModifiedTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only jobs modified after the specified time.

" - }, - "LastModifiedTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only jobs modified before the specified time.

" - }, - "NameContains":{ - "shape":"NameContains", - "documentation":"

A string in the job name to filter results. Only jobs whose name contains the specified string are returned.

" - }, - "SortBy":{ - "shape":"SortBy", - "documentation":"

The field to sort results by.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The sort order for results. Valid values are Ascending and Descending.

" - }, - "StatusEquals":{ - "shape":"JobStatus", - "documentation":"

A filter that returns only jobs with the specified status.

" - } - } - }, - "ListJobsResponse":{ - "type":"structure", - "required":["JobSummaries"], - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the response is truncated, this token retrieves the next set of results.

" - }, - "JobSummaries":{ - "shape":"JobSummaries", - "documentation":"

An array of JobSummary objects that provide summary information about the jobs.

" - } - } - }, - "ListLabelingJobsForWorkteamRequest":{ - "type":"structure", - "required":["WorkteamArn"], - "members":{ - "WorkteamArn":{ - "shape":"WorkteamArn", - "documentation":"

The Amazon Resource Name (ARN) of the work team for which you want to see labeling jobs for.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of labeling jobs to return in each page of the response.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the result of the previous ListLabelingJobsForWorkteam request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

" - }, - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only labeling jobs created after the specified time (timestamp).

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only labeling jobs created before the specified time (timestamp).

" - }, - "JobReferenceCodeContains":{ - "shape":"JobReferenceCodeContains", - "documentation":"

A filter the limits jobs to only the ones whose job reference code contains the specified string.

" - }, - "SortBy":{ - "shape":"ListLabelingJobsForWorkteamSortByOptions", - "documentation":"

The field to sort results by. The default is CreationTime.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The sort order for results. The default is Ascending.

" - } - } - }, - "ListLabelingJobsForWorkteamResponse":{ - "type":"structure", - "required":["LabelingJobSummaryList"], - "members":{ - "LabelingJobSummaryList":{ - "shape":"LabelingJobForWorkteamSummaryList", - "documentation":"

An array of LabelingJobSummary objects, each describing a labeling job.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the response is truncated, SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.

" - } - } - }, - "ListLabelingJobsForWorkteamSortByOptions":{ - "type":"string", - "enum":["CreationTime"] - }, - "ListLabelingJobsRequest":{ - "type":"structure", - "members":{ - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only labeling jobs created after the specified time (timestamp).

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only labeling jobs created before the specified time (timestamp).

" - }, - "LastModifiedTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only labeling jobs modified after the specified time (timestamp).

" - }, - "LastModifiedTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only labeling jobs modified before the specified time (timestamp).

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of labeling jobs to return in each page of the response.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the result of the previous ListLabelingJobs request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

" - }, - "NameContains":{ - "shape":"NameContains", - "documentation":"

A string in the labeling job name. This filter returns only labeling jobs whose name contains the specified string.

" - }, - "SortBy":{ - "shape":"SortBy", - "documentation":"

The field to sort results by. The default is CreationTime.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The sort order for results. The default is Ascending.

" - }, - "StatusEquals":{ - "shape":"LabelingJobStatus", - "documentation":"

A filter that retrieves only labeling jobs with a specific status.

" - } - } - }, - "ListLabelingJobsResponse":{ - "type":"structure", - "members":{ - "LabelingJobSummaryList":{ - "shape":"LabelingJobSummaryList", - "documentation":"

An array of LabelingJobSummary objects, each describing a labeling job.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the response is truncated, SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.

" - } - } - }, - "ListLineageEntityParameterKey":{ - "type":"list", - "member":{"shape":"StringParameterValue"} - }, - "ListLineageGroupsRequest":{ - "type":"structure", - "members":{ - "CreatedAfter":{ - "shape":"Timestamp", - "documentation":"

A timestamp to filter against lineage groups created after a certain point in time.

" - }, - "CreatedBefore":{ - "shape":"Timestamp", - "documentation":"

A timestamp to filter against lineage groups created before a certain point in time.

" - }, - "SortBy":{ - "shape":"SortLineageGroupsBy", - "documentation":"

The parameter by which to sort the results. The default is CreationTime.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The sort order for the results. The default is Ascending.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of endpoints to return in the response. This value defaults to 10.

" - } - } - }, - "ListLineageGroupsResponse":{ - "type":"structure", - "members":{ - "LineageGroupSummaries":{ - "shape":"LineageGroupSummaries", - "documentation":"

A list of lineage groups and their properties.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.

" - } - } - }, - "ListMaxResults":{ - "type":"integer", - "max":100 - }, - "ListMlflowAppsRequest":{ - "type":"structure", - "members":{ - "CreatedAfter":{ - "shape":"Timestamp", - "documentation":"

Use the CreatedAfter filter to only list MLflow Apps created after a specific date and time. Listed MLflow Apps are shown with a date and time such as \"2024-03-16T01:46:56+00:00\". The CreatedAfter parameter takes in a Unix timestamp.

" - }, - "CreatedBefore":{ - "shape":"Timestamp", - "documentation":"

Use the CreatedBefore filter to only list MLflow Apps created before a specific date and time. Listed MLflow Apps are shown with a date and time such as \"2024-03-16T01:46:56+00:00\". The CreatedAfter parameter takes in a Unix timestamp.

" - }, - "Status":{ - "shape":"MlflowAppStatus", - "documentation":"

Filter for Mlflow apps with a specific creation status.

" - }, - "MlflowVersion":{ - "shape":"MlflowVersion", - "documentation":"

Filter for Mlflow Apps with the specified version.

" - }, - "DefaultForDomainId":{ - "shape":"String", - "documentation":"

Filter for MLflow Apps with the specified default SageMaker Domain ID.

" - }, - "AccountDefaultStatus":{ - "shape":"AccountDefaultStatus", - "documentation":"

Filter for MLflow Apps with the specified AccountDefaultStatus.

" - }, - "SortBy":{ - "shape":"SortMlflowAppBy", - "documentation":"

Filter for MLflow Apps sorting by name, creation time, or creation status.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

Change the order of the listed MLflow Apps. By default, MLflow Apps are listed in Descending order by creation time. To change the list order, specify SortOrder to be Ascending.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous response was truncated, use this token in your next request to receive the next set of results.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of MLflow Apps to list.

" - } - } - }, - "ListMlflowAppsResponse":{ - "type":"structure", - "members":{ - "Summaries":{ - "shape":"MlflowAppSummaries", - "documentation":"

A list of MLflow Apps according to chosen filters.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

" - } - } - }, - "ListMlflowTrackingServersRequest":{ - "type":"structure", - "members":{ - "CreatedAfter":{ - "shape":"Timestamp", - "documentation":"

Use the CreatedAfter filter to only list tracking servers created after a specific date and time. Listed tracking servers are shown with a date and time such as \"2024-03-16T01:46:56+00:00\". The CreatedAfter parameter takes in a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.

" - }, - "CreatedBefore":{ - "shape":"Timestamp", - "documentation":"

Use the CreatedBefore filter to only list tracking servers created before a specific date and time. Listed tracking servers are shown with a date and time such as \"2024-03-16T01:46:56+00:00\". The CreatedBefore parameter takes in a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.

" - }, - "TrackingServerStatus":{ - "shape":"TrackingServerStatus", - "documentation":"

Filter for tracking servers with a specified creation status.

" - }, - "MlflowVersion":{ - "shape":"MlflowVersion", - "documentation":"

Filter for tracking servers using the specified MLflow version.

" - }, - "SortBy":{ - "shape":"SortTrackingServerBy", - "documentation":"

Filter for trackings servers sorting by name, creation time, or creation status.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

Change the order of the listed tracking servers. By default, tracking servers are listed in Descending order by creation time. To change the list order, you can specify SortOrder to be Ascending.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of tracking servers to list.

" - } - } - }, - "ListMlflowTrackingServersResponse":{ - "type":"structure", - "members":{ - "TrackingServerSummaries":{ - "shape":"TrackingServerSummaryList", - "documentation":"

A list of tracking servers according to chosen filters.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

" - } - } - }, - "ListModelBiasJobDefinitionsRequest":{ - "type":"structure", - "members":{ - "EndpointName":{ - "shape":"EndpointName", - "documentation":"

Name of the endpoint to monitor for model bias.

" - }, - "SortBy":{ - "shape":"MonitoringJobDefinitionSortKey", - "documentation":"

Whether to sort results by the Name or CreationTime field. The default is CreationTime.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

Whether to sort the results in Ascending or Descending order. The default is Descending.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of model bias jobs to return in the response. The default value is 10.

" - }, - "NameContains":{ - "shape":"NameContains", - "documentation":"

Filter for model bias jobs whose name contains a specified string.

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only model bias jobs created before a specified time.

" - }, - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only model bias jobs created after a specified time.

" - } - } - }, - "ListModelBiasJobDefinitionsResponse":{ - "type":"structure", - "required":["JobDefinitionSummaries"], - "members":{ - "JobDefinitionSummaries":{ - "shape":"MonitoringJobDefinitionSummaryList", - "documentation":"

A JSON array in which each element is a summary for a model bias jobs.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

" - } - } - }, - "ListModelCardExportJobsRequest":{ - "type":"structure", - "required":["ModelCardName"], - "members":{ - "ModelCardName":{ - "shape":"EntityName", - "documentation":"

List export jobs for the model card with the specified name.

" - }, - "ModelCardVersion":{ - "shape":"Integer", - "documentation":"

List export jobs for the model card with the specified version.

", - "box":true - }, - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

Only list model card export jobs that were created after the time specified.

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

Only list model card export jobs that were created before the time specified.

" - }, - "ModelCardExportJobNameContains":{ - "shape":"EntityName", - "documentation":"

Only list model card export jobs with names that contain the specified string.

" - }, - "StatusEquals":{ - "shape":"ModelCardExportJobStatus", - "documentation":"

Only list model card export jobs with the specified status.

" - }, - "SortBy":{ - "shape":"ModelCardExportJobSortBy", - "documentation":"

Sort model card export jobs by either name or creation time. Sorts by creation time by default.

" - }, - "SortOrder":{ - "shape":"ModelCardExportJobSortOrder", - "documentation":"

Sort model card export jobs by ascending or descending order.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the response to a previous ListModelCardExportJobs request was truncated, the response includes a NextToken. To retrieve the next set of model card export jobs, use the token in the next request.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of model card export jobs to list.

" - } - } - }, - "ListModelCardExportJobsResponse":{ - "type":"structure", - "required":["ModelCardExportJobSummaries"], - "members":{ - "ModelCardExportJobSummaries":{ - "shape":"ModelCardExportJobSummaryList", - "documentation":"

The summaries of the listed model card export jobs.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the response is truncated, SageMaker returns this token. To retrieve the next set of model card export jobs, use it in the subsequent request.

" - } - } - }, - "ListModelCardVersionsRequest":{ - "type":"structure", - "required":["ModelCardName"], - "members":{ - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

Only list model card versions that were created after the time specified.

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

Only list model card versions that were created before the time specified.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of model card versions to list.

" - }, - "ModelCardName":{ - "shape":"ModelCardNameOrArn", - "documentation":"

List model card versions for the model card with the specified name or Amazon Resource Name (ARN).

" - }, - "ModelCardStatus":{ - "shape":"ModelCardStatus", - "documentation":"

Only list model card versions with the specified approval status.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the response to a previous ListModelCardVersions request was truncated, the response includes a NextToken. To retrieve the next set of model card versions, use the token in the next request.

" - }, - "SortBy":{ - "shape":"ModelCardVersionSortBy", - "documentation":"

Sort listed model card versions by version. Sorts by version by default.

" - }, - "SortOrder":{ - "shape":"ModelCardSortOrder", - "documentation":"

Sort model card versions by ascending or descending order.

" - } - } - }, - "ListModelCardVersionsResponse":{ - "type":"structure", - "required":["ModelCardVersionSummaryList"], - "members":{ - "ModelCardVersionSummaryList":{ - "shape":"ModelCardVersionSummaryList", - "documentation":"

The summaries of the listed versions of the model card.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the response is truncated, SageMaker returns this token. To retrieve the next set of model card versions, use it in the subsequent request.

" - } - } - }, - "ListModelCardsRequest":{ - "type":"structure", - "members":{ - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

Only list model cards that were created after the time specified.

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

Only list model cards that were created before the time specified.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of model cards to list.

" - }, - "NameContains":{ - "shape":"EntityName", - "documentation":"

Only list model cards with names that contain the specified string.

" - }, - "ModelCardStatus":{ - "shape":"ModelCardStatus", - "documentation":"

Only list model cards with the specified approval status.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the response to a previous ListModelCards request was truncated, the response includes a NextToken. To retrieve the next set of model cards, use the token in the next request.

" - }, - "SortBy":{ - "shape":"ModelCardSortBy", - "documentation":"

Sort model cards by either name or creation time. Sorts by creation time by default.

" - }, - "SortOrder":{ - "shape":"ModelCardSortOrder", - "documentation":"

Sort model cards by ascending or descending order.

" - } - } - }, - "ListModelCardsResponse":{ - "type":"structure", - "required":["ModelCardSummaries"], - "members":{ - "ModelCardSummaries":{ - "shape":"ModelCardSummaryList", - "documentation":"

The summaries of the listed model cards.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the response is truncated, SageMaker returns this token. To retrieve the next set of model cards, use it in the subsequent request.

" - } - } - }, - "ListModelExplainabilityJobDefinitionsRequest":{ - "type":"structure", - "members":{ - "EndpointName":{ - "shape":"EndpointName", - "documentation":"

Name of the endpoint to monitor for model explainability.

" - }, - "SortBy":{ - "shape":"MonitoringJobDefinitionSortKey", - "documentation":"

Whether to sort results by the Name or CreationTime field. The default is CreationTime.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

Whether to sort the results in Ascending or Descending order. The default is Descending.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of jobs to return in the response. The default value is 10.

" - }, - "NameContains":{ - "shape":"NameContains", - "documentation":"

Filter for model explainability jobs whose name contains a specified string.

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only model explainability jobs created before a specified time.

" - }, - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only model explainability jobs created after a specified time.

" - } - } - }, - "ListModelExplainabilityJobDefinitionsResponse":{ - "type":"structure", - "required":["JobDefinitionSummaries"], - "members":{ - "JobDefinitionSummaries":{ - "shape":"MonitoringJobDefinitionSummaryList", - "documentation":"

A JSON array in which each element is a summary for a explainability bias jobs.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

" - } - } - }, - "ListModelMetadataRequest":{ - "type":"structure", - "members":{ - "SearchExpression":{ - "shape":"ModelMetadataSearchExpression", - "documentation":"

One or more filters that searches for the specified resource or resources in a search. All resource objects that satisfy the expression's condition are included in the search results. Specify the Framework, FrameworkVersion, Domain or Task to filter supported. Filter names and values are case-sensitive.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the response to a previous ListModelMetadataResponse request was truncated, the response includes a NextToken. To retrieve the next set of model metadata, use the token in the next request.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of models to return in the response.

" - } - } - }, - "ListModelMetadataResponse":{ - "type":"structure", - "required":["ModelMetadataSummaries"], - "members":{ - "ModelMetadataSummaries":{ - "shape":"ModelMetadataSummaries", - "documentation":"

A structure that holds model metadata.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

A token for getting the next set of recommendations, if there are any.

" - } - } - }, - "ListModelPackageGroupsInput":{ - "type":"structure", - "members":{ - "CreationTimeAfter":{ - "shape":"CreationTime", - "documentation":"

A filter that returns only model groups created after the specified time.

" - }, - "CreationTimeBefore":{ - "shape":"CreationTime", - "documentation":"

A filter that returns only model groups created before the specified time.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return in the response.

" - }, - "NameContains":{ - "shape":"NameContains", - "documentation":"

A string in the model group name. This filter returns only model groups whose name contains the specified string.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the result of the previous ListModelPackageGroups request was truncated, the response includes a NextToken. To retrieve the next set of model groups, use the token in the next request.

" - }, - "SortBy":{ - "shape":"ModelPackageGroupSortBy", - "documentation":"

The field to sort results by. The default is CreationTime.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The sort order for results. The default is Ascending.

" - }, - "CrossAccountFilterOption":{ - "shape":"CrossAccountFilterOption", - "documentation":"

A filter that returns either model groups shared with you or model groups in your own account. When the value is CrossAccount, the results show the resources made discoverable to you from other accounts. When the value is SameAccount or null, the results show resources from your account. The default is SameAccount.

" - } - } - }, - "ListModelPackageGroupsOutput":{ - "type":"structure", - "required":["ModelPackageGroupSummaryList"], - "members":{ - "ModelPackageGroupSummaryList":{ - "shape":"ModelPackageGroupSummaryList", - "documentation":"

A list of summaries of the model groups in your Amazon Web Services account.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the response is truncated, SageMaker returns this token. To retrieve the next set of model groups, use it in the subsequent request.

" - } - } - }, - "ListModelPackagesInput":{ - "type":"structure", - "members":{ - "CreationTimeAfter":{ - "shape":"CreationTime", - "documentation":"

A filter that returns only model packages created after the specified time (timestamp).

" - }, - "CreationTimeBefore":{ - "shape":"CreationTime", - "documentation":"

A filter that returns only model packages created before the specified time (timestamp).

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of model packages to return in the response.

" - }, - "NameContains":{ - "shape":"NameContains", - "documentation":"

A string in the model package name. This filter returns only model packages whose name contains the specified string.

" - }, - "ModelApprovalStatus":{ - "shape":"ModelApprovalStatus", - "documentation":"

A filter that returns only the model packages with the specified approval status.

" - }, - "ModelPackageGroupName":{ - "shape":"ArnOrName", - "documentation":"

A filter that returns only model versions that belong to the specified model group.

" - }, - "ModelPackageType":{ - "shape":"ModelPackageType", - "documentation":"

A filter that returns only the model packages of the specified type. This can be one of the following values.

  • UNVERSIONED - List only unversioined models. This is the default value if no ModelPackageType is specified.

  • VERSIONED - List only versioned models.

  • BOTH - List both versioned and unversioned models.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the response to a previous ListModelPackages request was truncated, the response includes a NextToken. To retrieve the next set of model packages, use the token in the next request.

" - }, - "SortBy":{ - "shape":"ModelPackageSortBy", - "documentation":"

The parameter by which to sort the results. The default is CreationTime.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The sort order for the results. The default is Ascending.

" - } - } - }, - "ListModelPackagesOutput":{ - "type":"structure", - "required":["ModelPackageSummaryList"], - "members":{ - "ModelPackageSummaryList":{ - "shape":"ModelPackageSummaryList", - "documentation":"

An array of ModelPackageSummary objects, each of which lists a model package.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the response is truncated, SageMaker returns this token. To retrieve the next set of model packages, use it in the subsequent request.

" - } - } - }, - "ListModelQualityJobDefinitionsRequest":{ - "type":"structure", - "members":{ - "EndpointName":{ - "shape":"EndpointName", - "documentation":"

A filter that returns only model quality monitoring job definitions that are associated with the specified endpoint.

" - }, - "SortBy":{ - "shape":"MonitoringJobDefinitionSortKey", - "documentation":"

The field to sort results by. The default is CreationTime.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

Whether to sort the results in Ascending or Descending order. The default is Descending.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the result of the previous ListModelQualityJobDefinitions request was truncated, the response includes a NextToken. To retrieve the next set of model quality monitoring job definitions, use the token in the next request.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return in a call to ListModelQualityJobDefinitions.

" - }, - "NameContains":{ - "shape":"NameContains", - "documentation":"

A string in the transform job name. This filter returns only model quality monitoring job definitions whose name contains the specified string.

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only model quality monitoring job definitions created before the specified time.

" - }, - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only model quality monitoring job definitions created after the specified time.

" - } - } - }, - "ListModelQualityJobDefinitionsResponse":{ - "type":"structure", - "required":["JobDefinitionSummaries"], - "members":{ - "JobDefinitionSummaries":{ - "shape":"MonitoringJobDefinitionSummaryList", - "documentation":"

A list of summaries of model quality monitoring job definitions.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the response is truncated, Amazon SageMaker AI returns this token. To retrieve the next set of model quality monitoring job definitions, use it in the next request.

" - } - } - }, - "ListModelsInput":{ - "type":"structure", - "members":{ - "SortBy":{ - "shape":"ModelSortKey", - "documentation":"

Sorts the list of results. The default is CreationTime.

" - }, - "SortOrder":{ - "shape":"OrderKey", - "documentation":"

The sort order for results. The default is Descending.

" - }, - "NextToken":{ - "shape":"PaginationToken", - "documentation":"

If the response to a previous ListModels request was truncated, the response includes a NextToken. To retrieve the next set of models, use the token in the next request.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of models to return in the response.

" - }, - "NameContains":{ - "shape":"ModelNameContains", - "documentation":"

A string in the model name. This filter returns only models whose name contains the specified string.

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only models created before the specified time (timestamp).

" - }, - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only models with a creation time greater than or equal to the specified time (timestamp).

" - } - } - }, - "ListModelsOutput":{ - "type":"structure", - "required":["Models"], - "members":{ - "Models":{ - "shape":"ModelSummaryList", - "documentation":"

An array of ModelSummary objects, each of which lists a model.

" - }, - "NextToken":{ - "shape":"PaginationToken", - "documentation":"

If the response is truncated, SageMaker returns this token. To retrieve the next set of models, use it in the subsequent request.

" - } - } - }, - "ListMonitoringAlertHistoryRequest":{ - "type":"structure", - "members":{ - "MonitoringScheduleName":{ - "shape":"MonitoringScheduleName", - "documentation":"

The name of a monitoring schedule.

" - }, - "MonitoringAlertName":{ - "shape":"MonitoringAlertName", - "documentation":"

The name of a monitoring alert.

" - }, - "SortBy":{ - "shape":"MonitoringAlertHistorySortKey", - "documentation":"

The field used to sort results. The default is CreationTime.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The sort order, whether Ascending or Descending, of the alert history. The default is Descending.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the result of the previous ListMonitoringAlertHistory request was truncated, the response includes a NextToken. To retrieve the next set of alerts in the history, use the token in the next request.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to display. The default is 100.

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only alerts created on or before the specified time.

" - }, - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only alerts created on or after the specified time.

" - }, - "StatusEquals":{ - "shape":"MonitoringAlertStatus", - "documentation":"

A filter that retrieves only alerts with a specific status.

" - } - } - }, - "ListMonitoringAlertHistoryResponse":{ - "type":"structure", - "members":{ - "MonitoringAlertHistory":{ - "shape":"MonitoringAlertHistoryList", - "documentation":"

An alert history for a model monitoring schedule.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the response is truncated, SageMaker returns this token. To retrieve the next set of alerts, use it in the subsequent request.

" - } - } - }, - "ListMonitoringAlertsRequest":{ - "type":"structure", - "required":["MonitoringScheduleName"], - "members":{ - "MonitoringScheduleName":{ - "shape":"MonitoringScheduleName", - "documentation":"

The name of a monitoring schedule.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the result of the previous ListMonitoringAlerts request was truncated, the response includes a NextToken. To retrieve the next set of alerts in the history, use the token in the next request.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to display. The default is 100.

" - } - } - }, - "ListMonitoringAlertsResponse":{ - "type":"structure", - "members":{ - "MonitoringAlertSummaries":{ - "shape":"MonitoringAlertSummaryList", - "documentation":"

A JSON array where each element is a summary for a monitoring alert.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the response is truncated, SageMaker returns this token. To retrieve the next set of alerts, use it in the subsequent request.

" - } - } - }, - "ListMonitoringExecutionsRequest":{ - "type":"structure", - "members":{ - "MonitoringScheduleName":{ - "shape":"MonitoringScheduleName", - "documentation":"

Name of a specific schedule to fetch jobs for.

" - }, - "EndpointName":{ - "shape":"EndpointName", - "documentation":"

Name of a specific endpoint to fetch jobs for.

" - }, - "SortBy":{ - "shape":"MonitoringExecutionSortKey", - "documentation":"

Whether to sort the results by the Status, CreationTime, or ScheduledTime field. The default is CreationTime.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

Whether to sort the results in Ascending or Descending order. The default is Descending.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of jobs to return in the response. The default value is 10.

" - }, - "ScheduledTimeBefore":{ - "shape":"Timestamp", - "documentation":"

Filter for jobs scheduled before a specified time.

" - }, - "ScheduledTimeAfter":{ - "shape":"Timestamp", - "documentation":"

Filter for jobs scheduled after a specified time.

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only jobs created before a specified time.

" - }, - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only jobs created after a specified time.

" - }, - "LastModifiedTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only jobs modified after a specified time.

" - }, - "LastModifiedTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only jobs modified before a specified time.

" - }, - "StatusEquals":{ - "shape":"ExecutionStatus", - "documentation":"

A filter that retrieves only jobs with a specific status.

" - }, - "MonitoringJobDefinitionName":{ - "shape":"MonitoringJobDefinitionName", - "documentation":"

Gets a list of the monitoring job runs of the specified monitoring job definitions.

" - }, - "MonitoringTypeEquals":{ - "shape":"MonitoringType", - "documentation":"

A filter that returns only the monitoring job runs of the specified monitoring type.

" - } - } - }, - "ListMonitoringExecutionsResponse":{ - "type":"structure", - "required":["MonitoringExecutionSummaries"], - "members":{ - "MonitoringExecutionSummaries":{ - "shape":"MonitoringExecutionSummaryList", - "documentation":"

A JSON array in which each element is a summary for a monitoring execution.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

" - } - } - }, - "ListMonitoringSchedulesRequest":{ - "type":"structure", - "members":{ - "EndpointName":{ - "shape":"EndpointName", - "documentation":"

Name of a specific endpoint to fetch schedules for.

" - }, - "SortBy":{ - "shape":"MonitoringScheduleSortKey", - "documentation":"

Whether to sort the results by the Status, CreationTime, or ScheduledTime field. The default is CreationTime.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

Whether to sort the results in Ascending or Descending order. The default is Descending.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of jobs to return in the response. The default value is 10.

" - }, - "NameContains":{ - "shape":"NameContains", - "documentation":"

Filter for monitoring schedules whose name contains a specified string.

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only monitoring schedules created before a specified time.

" - }, - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only monitoring schedules created after a specified time.

" - }, - "LastModifiedTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only monitoring schedules modified before a specified time.

" - }, - "LastModifiedTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only monitoring schedules modified after a specified time.

" - }, - "StatusEquals":{ - "shape":"ScheduleStatus", - "documentation":"

A filter that returns only monitoring schedules modified before a specified time.

" - }, - "MonitoringJobDefinitionName":{ - "shape":"MonitoringJobDefinitionName", - "documentation":"

Gets a list of the monitoring schedules for the specified monitoring job definition.

" - }, - "MonitoringTypeEquals":{ - "shape":"MonitoringType", - "documentation":"

A filter that returns only the monitoring schedules for the specified monitoring type.

" - } - } - }, - "ListMonitoringSchedulesResponse":{ - "type":"structure", - "required":["MonitoringScheduleSummaries"], - "members":{ - "MonitoringScheduleSummaries":{ - "shape":"MonitoringScheduleSummaryList", - "documentation":"

A JSON array in which each element is a summary for a monitoring schedule.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

" - } - } - }, - "ListNotebookInstanceLifecycleConfigsInput":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the result of a ListNotebookInstanceLifecycleConfigs request was truncated, the response includes a NextToken. To get the next set of lifecycle configurations, use the token in the next request.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of lifecycle configurations to return in the response.

" - }, - "SortBy":{ - "shape":"NotebookInstanceLifecycleConfigSortKey", - "documentation":"

Sorts the list of results. The default is CreationTime.

" - }, - "SortOrder":{ - "shape":"NotebookInstanceLifecycleConfigSortOrder", - "documentation":"

The sort order for results.

" - }, - "NameContains":{ - "shape":"NotebookInstanceLifecycleConfigNameContains", - "documentation":"

A string in the lifecycle configuration name. This filter returns only lifecycle configurations whose name contains the specified string.

" - }, - "CreationTimeBefore":{ - "shape":"CreationTime", - "documentation":"

A filter that returns only lifecycle configurations that were created before the specified time (timestamp).

" - }, - "CreationTimeAfter":{ - "shape":"CreationTime", - "documentation":"

A filter that returns only lifecycle configurations that were created after the specified time (timestamp).

" - }, - "LastModifiedTimeBefore":{ - "shape":"LastModifiedTime", - "documentation":"

A filter that returns only lifecycle configurations that were modified before the specified time (timestamp).

" - }, - "LastModifiedTimeAfter":{ - "shape":"LastModifiedTime", - "documentation":"

A filter that returns only lifecycle configurations that were modified after the specified time (timestamp).

" - } - } - }, - "ListNotebookInstanceLifecycleConfigsOutput":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the response is truncated, SageMaker AI returns this token. To get the next set of lifecycle configurations, use it in the next request.

" - }, - "NotebookInstanceLifecycleConfigs":{ - "shape":"NotebookInstanceLifecycleConfigSummaryList", - "documentation":"

An array of NotebookInstanceLifecycleConfiguration objects, each listing a lifecycle configuration.

" - } - } - }, - "ListNotebookInstancesInput":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous call to the ListNotebookInstances is truncated, the response includes a NextToken. You can use this token in your subsequent ListNotebookInstances request to fetch the next set of notebook instances.

You might specify a filter or a sort order in your request. When response is truncated, you must use the same values for the filer and sort order in the next request.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of notebook instances to return.

" - }, - "SortBy":{ - "shape":"NotebookInstanceSortKey", - "documentation":"

The field to sort results by. The default is Name.

" - }, - "SortOrder":{ - "shape":"NotebookInstanceSortOrder", - "documentation":"

The sort order for results.

" - }, - "NameContains":{ - "shape":"NotebookInstanceNameContains", - "documentation":"

A string in the notebook instances' name. This filter returns only notebook instances whose name contains the specified string.

" - }, - "CreationTimeBefore":{ - "shape":"CreationTime", - "documentation":"

A filter that returns only notebook instances that were created before the specified time (timestamp).

" - }, - "CreationTimeAfter":{ - "shape":"CreationTime", - "documentation":"

A filter that returns only notebook instances that were created after the specified time (timestamp).

" - }, - "LastModifiedTimeBefore":{ - "shape":"LastModifiedTime", - "documentation":"

A filter that returns only notebook instances that were modified before the specified time (timestamp).

" - }, - "LastModifiedTimeAfter":{ - "shape":"LastModifiedTime", - "documentation":"

A filter that returns only notebook instances that were modified after the specified time (timestamp).

" - }, - "StatusEquals":{ - "shape":"NotebookInstanceStatus", - "documentation":"

A filter that returns only notebook instances with the specified status.

" - }, - "NotebookInstanceLifecycleConfigNameContains":{ - "shape":"NotebookInstanceLifecycleConfigName", - "documentation":"

A string in the name of a notebook instances lifecycle configuration associated with this notebook instance. This filter returns only notebook instances associated with a lifecycle configuration with a name that contains the specified string.

" - }, - "DefaultCodeRepositoryContains":{ - "shape":"CodeRepositoryContains", - "documentation":"

A string in the name or URL of a Git repository associated with this notebook instance. This filter returns only notebook instances associated with a git repository with a name that contains the specified string.

" - }, - "AdditionalCodeRepositoryEquals":{ - "shape":"CodeRepositoryNameOrUrl", - "documentation":"

A filter that returns only notebook instances with associated with the specified git repository.

" - } - } - }, - "ListNotebookInstancesOutput":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the response to the previous ListNotebookInstances request was truncated, SageMaker AI returns this token. To retrieve the next set of notebook instances, use the token in the next request.

" - }, - "NotebookInstances":{ - "shape":"NotebookInstanceSummaryList", - "documentation":"

An array of NotebookInstanceSummary objects, one for each notebook instance.

" - } - } - }, - "ListOptimizationJobsRequest":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"

A token that you use to get the next set of results following a truncated response. If the response to the previous request was truncated, that response provides the value for this token.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of optimization jobs to return in the response. The default is 50.

" - }, - "CreationTimeAfter":{ - "shape":"CreationTime", - "documentation":"

Filters the results to only those optimization jobs that were created after the specified time.

" - }, - "CreationTimeBefore":{ - "shape":"CreationTime", - "documentation":"

Filters the results to only those optimization jobs that were created before the specified time.

" - }, - "LastModifiedTimeAfter":{ - "shape":"LastModifiedTime", - "documentation":"

Filters the results to only those optimization jobs that were updated after the specified time.

" - }, - "LastModifiedTimeBefore":{ - "shape":"LastModifiedTime", - "documentation":"

Filters the results to only those optimization jobs that were updated before the specified time.

" - }, - "OptimizationContains":{ - "shape":"NameContains", - "documentation":"

Filters the results to only those optimization jobs that apply the specified optimization techniques. You can specify either Quantization or Compilation.

" - }, - "NameContains":{ - "shape":"NameContains", - "documentation":"

Filters the results to only those optimization jobs with a name that contains the specified string.

" - }, - "StatusEquals":{ - "shape":"OptimizationJobStatus", - "documentation":"

Filters the results to only those optimization jobs with the specified status.

" - }, - "SortBy":{ - "shape":"ListOptimizationJobsSortBy", - "documentation":"

The field by which to sort the optimization jobs in the response. The default is CreationTime

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The sort order for results. The default is Ascending

" - } - } - }, - "ListOptimizationJobsResponse":{ - "type":"structure", - "required":["OptimizationJobSummaries"], - "members":{ - "OptimizationJobSummaries":{ - "shape":"OptimizationJobSummaries", - "documentation":"

A list of optimization jobs and their properties that matches any of the filters you specified in the request.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

The token to use in a subsequent request to get the next set of results following a truncated response.

" - } - } - }, - "ListOptimizationJobsSortBy":{ - "type":"string", - "enum":[ - "Name", - "CreationTime", - "Status" - ] - }, - "ListPartnerAppsRequest":{ - "type":"structure", - "members":{ - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

This parameter defines the maximum number of results that can be returned in a single response. The MaxResults parameter is an upper bound, not a target. If there are more results available than the value specified, a NextToken is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

" - } - } - }, - "ListPartnerAppsResponse":{ - "type":"structure", - "members":{ - "Summaries":{ - "shape":"PartnerAppSummaries", - "documentation":"

The information related to each of the SageMaker Partner AI Apps in an account.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

" - } - } - }, - "ListPipelineExecutionStepsRequest":{ - "type":"structure", - "members":{ - "PipelineExecutionArn":{ - "shape":"PipelineExecutionArn", - "documentation":"

The Amazon Resource Name (ARN) of the pipeline execution.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the result of the previous ListPipelineExecutionSteps request was truncated, the response includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the next request.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of pipeline execution steps to return in the response.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The field by which to sort results. The default is CreatedTime.

" - } - } - }, - "ListPipelineExecutionStepsResponse":{ - "type":"structure", - "members":{ - "PipelineExecutionSteps":{ - "shape":"PipelineExecutionStepList", - "documentation":"

A list of PipeLineExecutionStep objects. Each PipeLineExecutionStep consists of StepName, StartTime, EndTime, StepStatus, and Metadata. Metadata is an object with properties for each job that contains relevant information about the job created by the step.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the result of the previous ListPipelineExecutionSteps request was truncated, the response includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the next request.

" - } - } - }, - "ListPipelineExecutionsRequest":{ - "type":"structure", - "required":["PipelineName"], - "members":{ - "PipelineName":{ - "shape":"PipelineNameOrArn", - "documentation":"

The name or Amazon Resource Name (ARN) of the pipeline.

" - }, - "CreatedAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns the pipeline executions that were created after a specified time.

" - }, - "CreatedBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns the pipeline executions that were created before a specified time.

" - }, - "SortBy":{ - "shape":"SortPipelineExecutionsBy", - "documentation":"

The field by which to sort results. The default is CreatedTime.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The sort order for results.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the result of the previous ListPipelineExecutions request was truncated, the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of pipeline executions to return in the response.

" - } - } - }, - "ListPipelineExecutionsResponse":{ - "type":"structure", - "members":{ - "PipelineExecutionSummaries":{ - "shape":"PipelineExecutionSummaryList", - "documentation":"

Contains a sorted list of pipeline execution summary objects matching the specified filters. Each run summary includes the Amazon Resource Name (ARN) of the pipeline execution, the run date, and the status. This list can be empty.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the result of the previous ListPipelineExecutions request was truncated, the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.

" - } - } - }, - "ListPipelineParametersForExecutionRequest":{ - "type":"structure", - "required":["PipelineExecutionArn"], - "members":{ - "PipelineExecutionArn":{ - "shape":"PipelineExecutionArn", - "documentation":"

The Amazon Resource Name (ARN) of the pipeline execution.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the result of the previous ListPipelineParametersForExecution request was truncated, the response includes a NextToken. To retrieve the next set of parameters, use the token in the next request.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of parameters to return in the response.

" - } - } - }, - "ListPipelineParametersForExecutionResponse":{ - "type":"structure", - "members":{ - "PipelineParameters":{ - "shape":"ParameterList", - "documentation":"

Contains a list of pipeline parameters. This list can be empty.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the result of the previous ListPipelineParametersForExecution request was truncated, the response includes a NextToken. To retrieve the next set of parameters, use the token in the next request.

" - } - } - }, - "ListPipelineVersionsRequest":{ - "type":"structure", - "required":["PipelineName"], - "members":{ - "PipelineName":{ - "shape":"PipelineNameOrArn", - "documentation":"

The Amazon Resource Name (ARN) of the pipeline.

" - }, - "CreatedAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns the pipeline versions that were created after a specified time.

" - }, - "CreatedBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns the pipeline versions that were created before a specified time.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The sort order for the results.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the result of the previous ListPipelineVersions request was truncated, the response includes a NextToken. To retrieve the next set of pipeline versions, use this token in your next request.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of pipeline versions to return in the response.

" - } - } - }, - "ListPipelineVersionsResponse":{ - "type":"structure", - "members":{ - "PipelineVersionSummaries":{ - "shape":"PipelineVersionSummaryList", - "documentation":"

Contains a sorted list of pipeline version summary objects matching the specified filters. Each version summary includes the pipeline version ID, the creation date, and the last pipeline execution created from that version. This list can be empty.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the result of the previous ListPipelineVersions request was truncated, the response includes a NextToken. To retrieve the next set of pipeline versions, use this token in your next request.

" - } - } - }, - "ListPipelinesRequest":{ - "type":"structure", - "members":{ - "PipelineNamePrefix":{ - "shape":"PipelineName", - "documentation":"

The prefix of the pipeline name.

" - }, - "CreatedAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns the pipelines that were created after a specified time.

" - }, - "CreatedBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns the pipelines that were created before a specified time.

" - }, - "SortBy":{ - "shape":"SortPipelinesBy", - "documentation":"

The field by which to sort results. The default is CreatedTime.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The sort order for results.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the result of the previous ListPipelines request was truncated, the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of pipelines to return in the response.

" - } - } - }, - "ListPipelinesResponse":{ - "type":"structure", - "members":{ - "PipelineSummaries":{ - "shape":"PipelineSummaryList", - "documentation":"

Contains a sorted list of PipelineSummary objects matching the specified filters. Each PipelineSummary consists of PipelineArn, PipelineName, ExperimentName, PipelineDescription, CreationTime, LastModifiedTime, LastRunTime, and RoleArn. This list can be empty.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the result of the previous ListPipelines request was truncated, the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.

" - } - } - }, - "ListProcessingJobsRequest":{ - "type":"structure", - "members":{ - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only processing jobs created after the specified time.

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only processing jobs created after the specified time.

" - }, - "LastModifiedTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only processing jobs modified after the specified time.

" - }, - "LastModifiedTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only processing jobs modified before the specified time.

" - }, - "NameContains":{ - "shape":"String", - "documentation":"

A string in the processing job name. This filter returns only processing jobs whose name contains the specified string.

" - }, - "StatusEquals":{ - "shape":"ProcessingJobStatus", - "documentation":"

A filter that retrieves only processing jobs with a specific status.

" - }, - "SortBy":{ - "shape":"SortBy", - "documentation":"

The field to sort results by. The default is CreationTime.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The sort order for results. The default is Ascending.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the result of the previous ListProcessingJobs request was truncated, the response includes a NextToken. To retrieve the next set of processing jobs, use the token in the next request.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of processing jobs to return in the response.

" - } - } - }, - "ListProcessingJobsResponse":{ - "type":"structure", - "required":["ProcessingJobSummaries"], - "members":{ - "ProcessingJobSummaries":{ - "shape":"ProcessingJobSummaries", - "documentation":"

An array of ProcessingJobSummary objects, each listing a processing job.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of processing jobs, use it in the subsequent request.

" - } - } - }, - "ListProjectsInput":{ - "type":"structure", - "members":{ - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns the projects that were created after a specified time.

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns the projects that were created before a specified time.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of projects to return in the response.

" - }, - "NameContains":{ - "shape":"ProjectEntityName", - "documentation":"

A filter that returns the projects whose name contains a specified string.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the result of the previous ListProjects request was truncated, the response includes a NextToken. To retrieve the next set of projects, use the token in the next request.

" - }, - "SortBy":{ - "shape":"ProjectSortBy", - "documentation":"

The field by which to sort results. The default is CreationTime.

" - }, - "SortOrder":{ - "shape":"ProjectSortOrder", - "documentation":"

The sort order for results. The default is Ascending.

" - } - } - }, - "ListProjectsOutput":{ - "type":"structure", - "required":["ProjectSummaryList"], - "members":{ - "ProjectSummaryList":{ - "shape":"ProjectSummaryList", - "documentation":"

A list of summaries of projects.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the result of the previous ListCompilationJobs request was truncated, the response includes a NextToken. To retrieve the next set of model compilation jobs, use the token in the next request.

" - } - } - }, - "ListResourceCatalogsRequest":{ - "type":"structure", - "members":{ - "NameContains":{ - "shape":"ResourceCatalogName", - "documentation":"

A string that partially matches one or more ResourceCatalogs names. Filters ResourceCatalog by name.

" - }, - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

Use this parameter to search for ResourceCatalogs created after a specific date and time.

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

Use this parameter to search for ResourceCatalogs created before a specific date and time.

" - }, - "SortOrder":{ - "shape":"ResourceCatalogSortOrder", - "documentation":"

The order in which the resource catalogs are listed.

" - }, - "SortBy":{ - "shape":"ResourceCatalogSortBy", - "documentation":"

The value on which the resource catalog list is sorted.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results returned by ListResourceCatalogs.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

A token to resume pagination of ListResourceCatalogs results.

" - } - } - }, - "ListResourceCatalogsResponse":{ - "type":"structure", - "members":{ - "ResourceCatalogs":{ - "shape":"ResourceCatalogList", - "documentation":"

A list of the requested ResourceCatalogs.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

A token to resume pagination of ListResourceCatalogs results.

" - } - } - }, - "ListSpacesRequest":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

This parameter defines the maximum number of results that can be return in a single response. The MaxResults parameter is an upper bound, not a target. If there are more results available than the value specified, a NextToken is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The sort order for the results. The default is Ascending.

" - }, - "SortBy":{ - "shape":"SpaceSortKey", - "documentation":"

The parameter by which to sort the results. The default is CreationTime.

" - }, - "DomainIdEquals":{ - "shape":"DomainId", - "documentation":"

A parameter to search for the domain ID.

" - }, - "SpaceNameContains":{ - "shape":"SpaceName", - "documentation":"

A parameter by which to filter the results.

" - } - } - }, - "ListSpacesResponse":{ - "type":"structure", - "members":{ - "Spaces":{ - "shape":"SpaceList", - "documentation":"

The list of spaces.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

" - } - } - }, - "ListStageDevicesRequest":{ - "type":"structure", - "required":[ - "EdgeDeploymentPlanName", - "StageName" - ], - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"

The response from the last list when returning a list large enough to neeed tokening.

" - }, - "MaxResults":{ - "shape":"ListMaxResults", - "documentation":"

The maximum number of requests to select.

", - "box":true - }, - "EdgeDeploymentPlanName":{ - "shape":"EntityName", - "documentation":"

The name of the edge deployment plan.

" - }, - "ExcludeDevicesDeployedInOtherStage":{ - "shape":"Boolean", - "documentation":"

Toggle for excluding devices deployed in other stages.

", - "box":true - }, - "StageName":{ - "shape":"EntityName", - "documentation":"

The name of the stage in the deployment.

" - } - } - }, - "ListStageDevicesResponse":{ - "type":"structure", - "required":["DeviceDeploymentSummaries"], - "members":{ - "DeviceDeploymentSummaries":{ - "shape":"DeviceDeploymentSummaries", - "documentation":"

List of summaries of devices allocated to the stage.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

The token to use when calling the next page of results.

" - } - } - }, - "ListStudioLifecycleConfigsRequest":{ - "type":"structure", - "members":{ - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The total number of items to return in the response. If the total number of items available is more than the value specified, a NextToken is provided in the response. To resume pagination, provide the NextToken value in the as part of a subsequent call. The default value is 10.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous call to ListStudioLifecycleConfigs didn't return the full set of Lifecycle Configurations, the call returns a token for getting the next set of Lifecycle Configurations.

" - }, - "NameContains":{ - "shape":"StudioLifecycleConfigName", - "documentation":"

A string in the Lifecycle Configuration name. This filter returns only Lifecycle Configurations whose name contains the specified string.

" - }, - "AppTypeEquals":{ - "shape":"StudioLifecycleConfigAppType", - "documentation":"

A parameter to search for the App Type to which the Lifecycle Configuration is attached.

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only Lifecycle Configurations created on or before the specified time.

" - }, - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only Lifecycle Configurations created on or after the specified time.

" - }, - "ModifiedTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only Lifecycle Configurations modified before the specified time.

" - }, - "ModifiedTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only Lifecycle Configurations modified after the specified time.

" - }, - "SortBy":{ - "shape":"StudioLifecycleConfigSortKey", - "documentation":"

The property used to sort results. The default value is CreationTime.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The sort order. The default value is Descending.

" - } - } - }, - "ListStudioLifecycleConfigsResponse":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

" - }, - "StudioLifecycleConfigs":{ - "shape":"StudioLifecycleConfigsList", - "documentation":"

A list of Lifecycle Configurations and their properties.

" - } - } - }, - "ListSubscribedWorkteamsRequest":{ - "type":"structure", - "members":{ - "NameContains":{ - "shape":"WorkteamName", - "documentation":"

A string in the work team name. This filter returns only work teams whose name contains the specified string.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the result of the previous ListSubscribedWorkteams request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of work teams to return in each page of the response.

" - } - } - }, - "ListSubscribedWorkteamsResponse":{ - "type":"structure", - "required":["SubscribedWorkteams"], - "members":{ - "SubscribedWorkteams":{ - "shape":"SubscribedWorkteams", - "documentation":"

An array of Workteam objects, each describing a work team.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request.

" - } - } - }, - "ListTagsInput":{ - "type":"structure", - "required":["ResourceArn"], - "members":{ - "ResourceArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the response to the previous ListTags request is truncated, SageMaker returns this token. To retrieve the next set of tags, use it in the subsequent request.

" - }, - "MaxResults":{ - "shape":"ListTagsMaxResults", - "documentation":"

Maximum number of tags to return.

" - } - } - }, - "ListTagsMaxResults":{ - "type":"integer", - "box":true, - "min":50 - }, - "ListTagsOutput":{ - "type":"structure", - "members":{ - "Tags":{ - "shape":"TagList", - "documentation":"

An array of Tag objects, each with a tag key and a value.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If response is truncated, SageMaker includes a token in the response. You can use this token in your subsequent request to fetch next set of tokens.

" - } - } - }, - "ListTrainingJobsForHyperParameterTuningJobRequest":{ - "type":"structure", - "required":["HyperParameterTuningJobName"], - "members":{ - "HyperParameterTuningJobName":{ - "shape":"HyperParameterTuningJobName", - "documentation":"

The name of the tuning job whose training jobs you want to list.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of training jobs to return. The default value is 10.

" - }, - "StatusEquals":{ - "shape":"TrainingJobStatus", - "documentation":"

A filter that returns only training jobs with the specified status.

" - }, - "SortBy":{ - "shape":"TrainingJobSortByOptions", - "documentation":"

The field to sort results by. The default is Name.

If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an objective metric are not listed.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The sort order for results. The default is Ascending.

" - } - } - }, - "ListTrainingJobsForHyperParameterTuningJobResponse":{ - "type":"structure", - "required":["TrainingJobSummaries"], - "members":{ - "TrainingJobSummaries":{ - "shape":"HyperParameterTrainingJobSummaries", - "documentation":"

A list of TrainingJobSummary objects that describe the training jobs that the ListTrainingJobsForHyperParameterTuningJob request returned.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the result of this ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

" - } - } - }, - "ListTrainingJobsRequest":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the result of the previous ListTrainingJobs request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of training jobs to return in the response.

" - }, - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only training jobs created after the specified time (timestamp).

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only training jobs created before the specified time (timestamp).

" - }, - "LastModifiedTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only training jobs modified after the specified time (timestamp).

" - }, - "LastModifiedTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only training jobs modified before the specified time (timestamp).

" - }, - "NameContains":{ - "shape":"NameContains", - "documentation":"

A string in the training job name. This filter returns only training jobs whose name contains the specified string.

" - }, - "StatusEquals":{ - "shape":"TrainingJobStatus", - "documentation":"

A filter that retrieves only training jobs with a specific status.

" - }, - "SortBy":{ - "shape":"SortBy", - "documentation":"

The field to sort results by. The default is CreationTime.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The sort order for results. The default is Ascending.

" - }, - "WarmPoolStatusEquals":{ - "shape":"WarmPoolResourceStatus", - "documentation":"

A filter that retrieves only training jobs with a specific warm pool status.

" - }, - "TrainingPlanArnEquals":{ - "shape":"TrainingPlanArn", - "documentation":"

The Amazon Resource Name (ARN); of the training plan to filter training jobs by. For more information about reserving GPU capacity for your SageMaker training jobs using Amazon SageMaker Training Plan, see CreateTrainingPlan .

" - } - } - }, - "ListTrainingJobsResponse":{ - "type":"structure", - "required":["TrainingJobSummaries"], - "members":{ - "TrainingJobSummaries":{ - "shape":"TrainingJobSummaries", - "documentation":"

An array of TrainingJobSummary objects, each listing a training job.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the response is truncated, SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.

" - } - } - }, - "ListTrainingPlansRequest":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"

A token to continue pagination if more results are available.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return in the response.

" - }, - "StartTimeAfter":{ - "shape":"Timestamp", - "documentation":"

Filter to list only training plans with an actual start time after this date.

" - }, - "StartTimeBefore":{ - "shape":"Timestamp", - "documentation":"

Filter to list only training plans with an actual start time before this date.

" - }, - "SortBy":{ - "shape":"TrainingPlanSortBy", - "documentation":"

The training plan field to sort the results by (e.g., StartTime, Status).

" - }, - "SortOrder":{ - "shape":"TrainingPlanSortOrder", - "documentation":"

The order to sort the results (Ascending or Descending).

" - }, - "Filters":{ - "shape":"TrainingPlanFilters", - "documentation":"

Additional filters to apply to the list of training plans.

" - } - } - }, - "ListTrainingPlansResponse":{ - "type":"structure", - "required":["TrainingPlanSummaries"], - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"

A token to continue pagination if more results are available.

" - }, - "TrainingPlanSummaries":{ - "shape":"TrainingPlanSummaries", - "documentation":"

A list of summary information for the training plans.

" - } - } - }, - "ListTransformJobsRequest":{ - "type":"structure", - "members":{ - "CreationTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only transform jobs created after the specified time.

" - }, - "CreationTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only transform jobs created before the specified time.

" - }, - "LastModifiedTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only transform jobs modified after the specified time.

" - }, - "LastModifiedTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only transform jobs modified before the specified time.

" - }, - "NameContains":{ - "shape":"NameContains", - "documentation":"

A string in the transform job name. This filter returns only transform jobs whose name contains the specified string.

" - }, - "StatusEquals":{ - "shape":"TransformJobStatus", - "documentation":"

A filter that retrieves only transform jobs with a specific status.

" - }, - "SortBy":{ - "shape":"SortBy", - "documentation":"

The field to sort results by. The default is CreationTime.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The sort order for results. The default is Descending.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the result of the previous ListTransformJobs request was truncated, the response includes a NextToken. To retrieve the next set of transform jobs, use the token in the next request.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of transform jobs to return in the response. The default value is 10.

" - } - } - }, - "ListTransformJobsResponse":{ - "type":"structure", - "required":["TransformJobSummaries"], - "members":{ - "TransformJobSummaries":{ - "shape":"TransformJobSummaries", - "documentation":"

An array of TransformJobSummary objects.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of transform jobs, use it in the next request.

" - } - } - }, - "ListTrialComponentKey256":{ - "type":"list", - "member":{"shape":"TrialComponentKey256"} - }, - "ListTrialComponentsRequest":{ - "type":"structure", - "members":{ - "ExperimentName":{ - "shape":"ExperimentEntityName", - "documentation":"

A filter that returns only components that are part of the specified experiment. If you specify ExperimentName, you can't filter by SourceArn or TrialName.

" - }, - "TrialName":{ - "shape":"ExperimentEntityName", - "documentation":"

A filter that returns only components that are part of the specified trial. If you specify TrialName, you can't filter by ExperimentName or SourceArn.

" - }, - "SourceArn":{ - "shape":"String256", - "documentation":"

A filter that returns only components that have the specified source Amazon Resource Name (ARN). If you specify SourceArn, you can't filter by ExperimentName or TrialName.

" - }, - "CreatedAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only components created after the specified time.

" - }, - "CreatedBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only components created before the specified time.

" - }, - "SortBy":{ - "shape":"SortTrialComponentsBy", - "documentation":"

The property used to sort results. The default value is CreationTime.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The sort order. The default value is Descending.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of components to return in the response. The default value is 10.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous call to ListTrialComponents didn't return the full set of components, the call returns a token for getting the next set of components.

" - } - } - }, - "ListTrialComponentsResponse":{ - "type":"structure", - "members":{ - "TrialComponentSummaries":{ - "shape":"TrialComponentSummaries", - "documentation":"

A list of the summaries of your trial components.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

A token for getting the next set of components, if there are any.

" - } - } - }, - "ListTrialsRequest":{ - "type":"structure", - "members":{ - "ExperimentName":{ - "shape":"ExperimentEntityName", - "documentation":"

A filter that returns only trials that are part of the specified experiment.

" - }, - "TrialComponentName":{ - "shape":"ExperimentEntityName", - "documentation":"

A filter that returns only trials that are associated with the specified trial component.

" - }, - "CreatedAfter":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only trials created after the specified time.

" - }, - "CreatedBefore":{ - "shape":"Timestamp", - "documentation":"

A filter that returns only trials created before the specified time.

" - }, - "SortBy":{ - "shape":"SortTrialsBy", - "documentation":"

The property used to sort results. The default value is CreationTime.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The sort order. The default value is Descending.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of trials to return in the response. The default value is 10.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous call to ListTrials didn't return the full set of trials, the call returns a token for getting the next set of trials.

" - } - } - }, - "ListTrialsResponse":{ - "type":"structure", - "members":{ - "TrialSummaries":{ - "shape":"TrialSummaries", - "documentation":"

A list of the summaries of your trials.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

A token for getting the next set of trials, if there are any.

" - } - } - }, - "ListUltraServersByReservedCapacityRequest":{ - "type":"structure", - "required":["ReservedCapacityArn"], - "members":{ - "ReservedCapacityArn":{ - "shape":"ReservedCapacityArn", - "documentation":"

The ARN of the reserved capacity to list UltraServers for.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of UltraServers to return in the response. The default value is 10.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

" - } - } - }, - "ListUltraServersByReservedCapacityResponse":{ - "type":"structure", - "required":["UltraServers"], - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the response is truncated, SageMaker returns this token. Use it in the next request to retrieve the next set of UltraServers.

" - }, - "UltraServers":{ - "shape":"UltraServers", - "documentation":"

A list of UltraServers that are part of the specified reserved capacity.

" - } - } - }, - "ListUserProfilesRequest":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

This parameter defines the maximum number of results that can be return in a single response. The MaxResults parameter is an upper bound, not a target. If there are more results available than the value specified, a NextToken is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The sort order for the results. The default is Ascending.

" - }, - "SortBy":{ - "shape":"UserProfileSortKey", - "documentation":"

The parameter by which to sort the results. The default is CreationTime.

" - }, - "DomainIdEquals":{ - "shape":"DomainId", - "documentation":"

A parameter by which to filter the results.

" - }, - "UserProfileNameContains":{ - "shape":"UserProfileName", - "documentation":"

A parameter by which to filter the results.

" - } - } - }, - "ListUserProfilesResponse":{ - "type":"structure", - "members":{ - "UserProfiles":{ - "shape":"UserProfileList", - "documentation":"

The list of user profiles.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

" - } - } - }, - "ListWorkforcesRequest":{ - "type":"structure", - "members":{ - "SortBy":{ - "shape":"ListWorkforcesSortByOptions", - "documentation":"

Sort workforces using the workforce name or creation date.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

Sort workforces in ascending or descending order.

" - }, - "NameContains":{ - "shape":"WorkforceName", - "documentation":"

A filter you can use to search for workforces using part of the workforce name.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

A token to resume pagination.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of workforces returned in the response.

" - } - } - }, - "ListWorkforcesResponse":{ - "type":"structure", - "required":["Workforces"], - "members":{ - "Workforces":{ - "shape":"Workforces", - "documentation":"

A list containing information about your workforce.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

A token to resume pagination.

" - } - } - }, - "ListWorkforcesSortByOptions":{ - "type":"string", - "enum":[ - "Name", - "CreateDate" - ] - }, - "ListWorkteamsRequest":{ - "type":"structure", - "members":{ - "SortBy":{ - "shape":"ListWorkteamsSortByOptions", - "documentation":"

The field to sort results by. The default is CreationTime.

" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"

The sort order for results. The default is Ascending.

" - }, - "NameContains":{ - "shape":"WorkteamName", - "documentation":"

A string in the work team's name. This filter returns only work teams whose name contains the specified string.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the result of the previous ListWorkteams request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of work teams to return in each page of the response.

" - } - } - }, - "ListWorkteamsResponse":{ - "type":"structure", - "required":["Workteams"], - "members":{ - "Workteams":{ - "shape":"Workteams", - "documentation":"

An array of Workteam objects, each describing a work team.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request.

" - } - } - }, - "ListWorkteamsSortByOptions":{ - "type":"string", - "enum":[ - "Name", - "CreateDate" - ] - }, - "LocalPath":{ - "type":"string", - "max":1024, - "min":0, - "pattern":"\\/.*" - }, - "Long":{"type":"long"}, - "LongS3Uri":{ - "type":"string", - "max":2048, - "min":0, - "pattern":"(https|s3)://([^/]+)/?(.*)" - }, - "MIGProfileType":{ - "type":"string", - "enum":[ - "mig-1g.5gb", - "mig-1g.10gb", - "mig-1g.18gb", - "mig-1g.20gb", - "mig-1g.23gb", - "mig-1g.35gb", - "mig-1g.45gb", - "mig-1g.47gb", - "mig-2g.10gb", - "mig-2g.20gb", - "mig-2g.35gb", - "mig-2g.45gb", - "mig-2g.47gb", - "mig-3g.20gb", - "mig-3g.40gb", - "mig-3g.71gb", - "mig-3g.90gb", - "mig-3g.93gb", - "mig-4g.20gb", - "mig-4g.40gb", - "mig-4g.71gb", - "mig-4g.90gb", - "mig-4g.93gb", - "mig-7g.40gb", - "mig-7g.80gb", - "mig-7g.141gb", - "mig-7g.180gb", - "mig-7g.186gb" - ] - }, - "MLFramework":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[a-zA-Z]+ ?\\d+\\.\\d+(\\.\\d+)?" - }, - "MLflowArn":{ - "type":"string", - "max":2048, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:mlflow-[a-zA-Z-]*/.*" - }, - "MLflowConfiguration":{ - "type":"structure", - "members":{ - "MlflowResourceArn":{ - "shape":"MLflowArn", - "documentation":"

The Amazon Resource Name (ARN) of MLflow configuration resource.

" - }, - "MlflowExperimentName":{ - "shape":"MlflowExperimentEntityName", - "documentation":"

The name of the MLflow configuration.

" - } - }, - "documentation":"

The MLflow configuration.

" - }, - "MaintenanceStatus":{ - "type":"string", - "enum":[ - "MaintenanceInProgress", - "MaintenanceComplete", - "MaintenanceFailed" - ] - }, - "MajorMinorVersion":{ - "type":"string", - "max":64, - "min":0, - "pattern":"\\d+\\.\\d+" - }, - "ManagedConfiguration":{ - "type":"structure", - "members":{ - "ManagedStorageType":{ - "shape":"ManagedStorageType", - "documentation":"

The storage type of the model package.

" - } - }, - "documentation":"

The managed configuration of a model package group.

" - }, - "ManagedInstanceScalingCooldownInMinutes":{ - "type":"integer", - "box":true, - "max":1440, - "min":5 - }, - "ManagedInstanceScalingMaxInstanceCount":{ - "type":"integer", - "box":true, - "min":1 - }, - "ManagedInstanceScalingMaximumStepSize":{ - "type":"integer", - "box":true, - "max":100, - "min":1 - }, - "ManagedInstanceScalingMinInstanceCount":{ - "type":"integer", - "box":true, - "min":0 - }, - "ManagedInstanceScalingScaleInStrategy":{ - "type":"string", - "enum":[ - "IDLE_RELEASE", - "CONSOLIDATION" - ] - }, - "ManagedInstanceScalingStatus":{ - "type":"string", - "enum":[ - "ENABLED", - "DISABLED" - ] - }, - "ManagedStorageType":{ - "type":"string", - "enum":["Restricted"] - }, - "MapString2048":{ - "type":"map", - "key":{"shape":"String2048"}, - "value":{"shape":"String2048"}, - "max":5, - "min":0 - }, - "MaxAutoMLJobRuntimeInSeconds":{ - "type":"integer", - "box":true, - "min":1 - }, - "MaxCandidates":{ - "type":"integer", - "box":true, - "max":750, - "min":1 - }, - "MaxConcurrentInvocationsPerInstance":{ - "type":"integer", - "box":true, - "max":1000, - "min":1 - }, - "MaxConcurrentTaskCount":{ - "type":"integer", - "box":true, - "max":5000, - "min":1 - }, - "MaxConcurrentTransforms":{ - "type":"integer", - "box":true, - "min":0 - }, - "MaxHumanLabeledObjectCount":{ - "type":"integer", - "box":true, - "min":1 - }, - "MaxNumberOfTests":{ - "type":"integer", - "box":true, - "min":1 - }, - "MaxNumberOfTrainingJobs":{ - "type":"integer", - "box":true, - "min":1 - }, - "MaxNumberOfTrainingJobsNotImproving":{ - "type":"integer", - "box":true, - "min":3 - }, - "MaxParallelExecutionSteps":{ - "type":"integer", - "min":1 - }, - "MaxParallelOfTests":{ - "type":"integer", - "box":true, - "min":1 - }, - "MaxParallelTrainingJobs":{ - "type":"integer", - "min":1 - }, - "MaxPayloadInMB":{ - "type":"integer", - "box":true, - "min":0 - }, - "MaxPendingTimeInSeconds":{ - "type":"integer", - "documentation":"

Maximum job scheduler pending time in seconds.

", - "box":true, - "max":2419200, - "min":7200 - }, - "MaxPercentageOfInputDatasetLabeled":{ - "type":"integer", - "box":true, - "max":100, - "min":1 - }, - "MaxResults":{ - "type":"integer", - "box":true, - "max":100, - "min":1 - }, - "MaxRuntimeInSeconds":{ - "type":"integer", - "min":1 - }, - "MaxRuntimePerTrainingJobInSeconds":{ - "type":"integer", - "box":true, - "min":1 - }, - "MaxWaitTimeInSeconds":{ - "type":"integer", - "box":true, - "min":1 - }, - "MaximumExecutionTimeoutInSeconds":{ - "type":"integer", - "box":true, - "max":28800, - "min":600 - }, - "MaximumRetryAttempts":{ - "type":"integer", - "max":30, - "min":1 - }, - "MediaType":{ - "type":"string", - "max":64, - "min":0, - "pattern":"[-\\w]+\\/[-\\w+]+" - }, - "MemberDefinition":{ - "type":"structure", - "members":{ - "CognitoMemberDefinition":{ - "shape":"CognitoMemberDefinition", - "documentation":"

The Amazon Cognito user group that is part of the work team.

" - }, - "OidcMemberDefinition":{ - "shape":"OidcMemberDefinition", - "documentation":"

A list user groups that exist in your OIDC Identity Provider (IdP). One to ten groups can be used to create a single private work team. When you add a user group to the list of Groups, you can add that user group to one or more private work teams. If you add a user group to a private work team, all workers in that user group are added to the work team.

" - } - }, - "documentation":"

Defines an Amazon Cognito or your own OIDC IdP user group that is part of a work team.

" - }, - "MemberDefinitions":{ - "type":"list", - "member":{"shape":"MemberDefinition"}, - "max":10, - "min":1 - }, - "MemoryInGiBAmount":{ - "type":"float", - "box":true, - "max":10000000, - "min":0 - }, - "MemoryInMb":{ - "type":"integer", - "box":true, - "min":128 - }, - "MetadataProperties":{ - "type":"structure", - "members":{ - "CommitId":{ - "shape":"MetadataPropertyValue", - "documentation":"

The commit ID.

" - }, - "Repository":{ - "shape":"MetadataPropertyValue", - "documentation":"

The repository.

" - }, - "GeneratedBy":{ - "shape":"MetadataPropertyValue", - "documentation":"

The entity this entity was generated by.

" - }, - "ProjectId":{ - "shape":"MetadataPropertyValue", - "documentation":"

The project ID.

" - } - }, - "documentation":"

Metadata properties of the tracking entity, trial, or trial component.

" - }, - "MetadataPropertyValue":{ - "type":"string", - "max":1024, - "min":0, - "pattern":".*" - }, - "MetricData":{ - "type":"structure", - "members":{ - "MetricName":{ - "shape":"MetricName", - "documentation":"

The name of the metric.

" - }, - "Value":{ - "shape":"Float", - "documentation":"

The value of the metric.

", - "box":true - }, - "Timestamp":{ - "shape":"Timestamp", - "documentation":"

The date and time that the algorithm emitted the metric.

" - } - }, - "documentation":"

The name, value, and date and time of a metric that was emitted to Amazon CloudWatch.

" - }, - "MetricDataList":{ - "type":"list", - "member":{"shape":"MetricDatum"}, - "max":40, - "min":0 - }, - "MetricDatum":{ - "type":"structure", - "members":{ - "MetricName":{ - "shape":"AutoMLMetricEnum", - "documentation":"

The name of the metric.

" - }, - "StandardMetricName":{ - "shape":"AutoMLMetricExtendedEnum", - "documentation":"

The name of the standard metric.

For definitions of the standard metrics, see Autopilot candidate metrics .

" - }, - "Value":{ - "shape":"Float", - "documentation":"

The value of the metric.

", - "box":true - }, - "Set":{ - "shape":"MetricSetSource", - "documentation":"

The dataset split from which the AutoML job produced the metric.

" - } - }, - "documentation":"

Information about the metric for a candidate produced by an AutoML job.

" - }, - "MetricDefinition":{ - "type":"structure", - "required":[ - "Name", - "Regex" - ], - "members":{ - "Name":{ - "shape":"MetricName", - "documentation":"

The name of the metric.

" - }, - "Regex":{ - "shape":"MetricRegex", - "documentation":"

A regular expression that searches the output of a training job and gets the value of the metric. For more information about using regular expressions to define metrics, see Defining metrics and environment variables.

" - } - }, - "documentation":"

Specifies a metric that the training algorithm writes to stderr or stdout. You can view these logs to understand how your training job performs and check for any errors encountered during training. SageMaker hyperparameter tuning captures all defined metrics. Specify one of the defined metrics to use as an objective metric using the TuningObjective parameter in the HyperParameterTrainingJobDefinition API to evaluate job performance during hyperparameter tuning.

" - }, - "MetricDefinitionList":{ - "type":"list", - "member":{"shape":"MetricDefinition"}, - "max":40, - "min":0 - }, - "MetricName":{ - "type":"string", - "max":255, - "min":1, - "pattern":".+" - }, - "MetricPublishFrequencyInSeconds":{ - "type":"integer", - "box":true - }, - "MetricRegex":{ - "type":"string", - "max":500, - "min":1, - "pattern":".+" - }, - "MetricSetSource":{ - "type":"string", - "enum":[ - "Train", - "Validation", - "Test" - ] - }, - "MetricSpecification":{ - "type":"structure", - "members":{ - "Predefined":{ - "shape":"PredefinedMetricSpecification", - "documentation":"

Information about a predefined metric.

" - }, - "Customized":{ - "shape":"CustomizedMetricSpecification", - "documentation":"

Information about a customized metric.

" - } - }, - "documentation":"

An object containing information about a metric.

", - "union":true - }, - "MetricValue":{"type":"float"}, - "MetricsConfig":{ - "type":"structure", - "members":{ - "EnableEnhancedMetrics":{ - "shape":"EnableEnhancedMetrics", - "documentation":"

Specifies whether to enable enhanced metrics for the endpoint. Enhanced metrics provide utilization and invocation data at instance and container granularity. Container granularity is supported for Inference Components. The default is False.

" - }, - "EnableDetailedObservability":{ - "shape":"EnableDetailedObservability", - "documentation":"

Indicates whether detailed observability is enabled for the endpoint. When set to True, the following metrics are published at the configured frequency:

  • Container-level inference metrics scraped from the container's Prometheus endpoint (such as request latency, error counts, and throughput). Available metrics vary by framework.

  • Per-GPU metrics (utilization, memory, and temperature) attributed to individual inference components.

  • Per-instance host metrics (CPU, memory, and disk utilization).

  • Inference component placement metrics (copy count per Availability Zone).

For first-party and Deep Learning Containers (DLC), the Prometheus endpoint path is determined automatically. For Bring-Your-Own-Container (BYOC) cases, you can optionally set ContainerMetricsConfig to specify a custom endpoint path. If not specified, the default path /metrics on port 8080 is used.

When set to False, these additional metrics are not published. Standard invocation and utilization metrics controlled by EnableEnhancedMetrics are unaffected.

The default value for new endpoint configurations is True. For existing endpoint configurations created before this feature, the value is False unless explicitly set.

" - }, - "MetricPublishFrequencyInSeconds":{ - "shape":"MetricPublishFrequencyInSeconds", - "documentation":"

The interval, in seconds, at which metrics are published to Amazon CloudWatch. Defaults to 60. Valid values: 10, 30, 60, 120, 180, 240, 300.

When EnableEnhancedMetrics is set to False, this interval applies to utilization metrics only. Invocation metrics continue to be published at the default 60-second interval. When EnableEnhancedMetrics is set to True, this interval applies to both utilization and invocation metrics.

When EnableDetailedObservability is set to True, this interval applies to per-GPU metrics, per-instance host metrics, container metrics, and fleet-level inference component lifecycle and placement metrics.

" - } - }, - "documentation":"

The configuration for Utilization metrics.

" - }, - "MetricsEndpoint":{ - "type":"structure", - "required":["MetricsEndpointPath"], - "members":{ - "MetricsEndpointPath":{ - "shape":"MetricsEndpointPath", - "documentation":"

The path to the metrics endpoint exposed by the container. For example, /metrics or /server/metrics. The path must start with / and can contain alphanumeric characters, forward slashes, underscores, hyphens, and periods. Maximum length is 256 characters. If not specified, defaults to /metrics.

" - }, - "MetricPublishFrequencyInSeconds":{ - "shape":"MetricPublishFrequencyInSeconds", - "documentation":"

The interval, in seconds, at which container metrics scraped from the endpoint are published to Amazon CloudWatch. Valid values: 10, 30, 60, 120, 180, 240, 300. Defaults to 60.

" - } - }, - "documentation":"

Specifies a metrics endpoint for a container, including the path where the container exposes Prometheus-formatted metrics and the frequency at which to publish them to Amazon CloudWatch.

" - }, - "MetricsEndpointList":{ - "type":"list", - "member":{"shape":"MetricsEndpoint"}, - "documentation":"

A list of metrics endpoints for a container.

", - "max":1, - "min":0 - }, - "MetricsEndpointPath":{ - "type":"string", - "documentation":"

Per-container Prometheus metrics scraping configuration

", - "max":256, - "min":0, - "pattern":"/(?!.*\\.\\.)[a-zA-Z0-9/_.\\-]+" - }, - "MetricsSource":{ - "type":"structure", - "required":[ - "ContentType", - "S3Uri" - ], - "members":{ - "ContentType":{ - "shape":"ContentType", - "documentation":"

The metric source content type.

" - }, - "ContentDigest":{ - "shape":"ContentDigest", - "documentation":"

The hash key used for the metrics source.

" - }, - "S3Uri":{ - "shape":"S3Uri", - "documentation":"

The S3 URI for the metrics source.

" - } - }, - "documentation":"

Details about the metrics source.

" - }, - "MinimumInstanceMetadataServiceVersion":{ - "type":"string", - "max":1, - "min":0, - "pattern":"1|2" - }, - "MlFlowResourceArn":{ - "type":"string", - "documentation":"

MlflowDetails relevant fields

", - "max":2048, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:mlflow-[a-zA-Z-]*/.*" - }, - "MlReservationArn":{ - "type":"string", - "max":258, - "min":20, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:[a-z0-9\\-]{1,14}/.*" - }, - "MlTools":{ - "type":"string", - "enum":[ - "DataWrangler", - "FeatureStore", - "EmrClusters", - "AutoMl", - "Experiments", - "Training", - "ModelEvaluation", - "Pipelines", - "Models", - "JumpStart", - "InferenceRecommender", - "Endpoints", - "Projects", - "InferenceOptimization", - "PerformanceEvaluation", - "LakeraGuard", - "Comet", - "DeepchecksLLMEvaluation", - "Fiddler", - "HyperPodClusters", - "RunningInstances", - "Datasets", - "Evaluators" - ] - }, - "MlflowAppArn":{ - "type":"string", - "max":128, - "min":1, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:mlflow-app/.*" - }, - "MlflowAppName":{ - "type":"string", - "max":256, - "min":1, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}" - }, - "MlflowAppStatus":{ - "type":"string", - "enum":[ - "Creating", - "Created", - "CreateFailed", - "Updating", - "Updated", - "UpdateFailed", - "Deleting", - "DeleteFailed", - "Deleted" - ] - }, - "MlflowAppSummaries":{ - "type":"list", - "member":{"shape":"MlflowAppSummary"}, - "max":100, - "min":0 - }, - "MlflowAppSummary":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"MlflowAppArn", - "documentation":"

The ARN of a listed MLflow App.

" - }, - "Name":{ - "shape":"MlflowAppName", - "documentation":"

The name of the MLflow App.

" - }, - "Status":{ - "shape":"MlflowAppStatus", - "documentation":"

The status of the MLflow App.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The creation time of a listed MLflow App.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The last modified time of a listed MLflow App.

" - }, - "MlflowVersion":{ - "shape":"MlflowVersion", - "documentation":"

The version of a listed MLflow App.

" - } - }, - "documentation":"

The summary of the Mlflow App to list.

" - }, - "MlflowAppUrl":{ - "type":"string", - "max":2048, - "min":0 - }, - "MlflowConfig":{ - "type":"structure", - "required":["MlflowResourceArn"], - "members":{ - "MlflowResourceArn":{ - "shape":"MlFlowResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the MLflow resource.

" - }, - "MlflowExperimentName":{ - "shape":"MlflowExperimentName", - "documentation":"

The MLflow experiment name used for this job.

" - }, - "MlflowRunName":{ - "shape":"MlflowRunName", - "documentation":"

The MLflow run name used for this job.

" - } - }, - "documentation":"

The MLflow configuration using SageMaker managed MLflow.

" - }, - "MlflowDetails":{ - "type":"structure", - "members":{ - "MlflowExperimentId":{ - "shape":"MlflowExperimentId", - "documentation":"

The MLflow experiment ID used for this job.

" - }, - "MlflowRunId":{ - "shape":"MlflowRunId", - "documentation":"

The MLflow run ID used for this job.

" - } - }, - "documentation":"

The MLflow details of this job.

" - }, - "MlflowExperimentEntityName":{ - "type":"string", - "max":256, - "min":1, - "pattern":".*" - }, - "MlflowExperimentId":{ - "type":"string", - "max":256, - "min":1, - "pattern":".*" - }, - "MlflowExperimentName":{ - "type":"string", - "documentation":"

MlflowConfig relevant fields

", - "max":256, - "min":1, - "pattern":".*" - }, - "MlflowRunId":{ - "type":"string", - "max":256, - "min":1, - "pattern":".*" - }, - "MlflowRunName":{ - "type":"string", - "max":256, - "min":1, - "pattern":".*" - }, - "MlflowVersion":{ - "type":"string", - "max":16, - "min":0, - "pattern":"[0-9]*.[0-9]*.[0-9]*" - }, - "Model":{ - "type":"structure", - "members":{ - "ModelName":{ - "shape":"ModelName", - "documentation":"

The name of the model.

" - }, - "PrimaryContainer":{"shape":"ContainerDefinition"}, - "Containers":{ - "shape":"ContainerDefinitionList", - "documentation":"

The containers in the inference pipeline.

" - }, - "InferenceExecutionConfig":{"shape":"InferenceExecutionConfig"}, - "ExecutionRoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the IAM role that you specified for the model.

" - }, - "VpcConfig":{"shape":"VpcConfig"}, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that indicates when the model was created.

" - }, - "ModelArn":{ - "shape":"ModelArn", - "documentation":"

The Amazon Resource Name (ARN) of the model.

" - }, - "EnableNetworkIsolation":{ - "shape":"Boolean", - "documentation":"

Isolates the model container. No inbound or outbound network calls can be made to or from the model container.

", - "box":true - }, - "Tags":{ - "shape":"TagList", - "documentation":"

A list of key-value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

" - }, - "DeploymentRecommendation":{ - "shape":"DeploymentRecommendation", - "documentation":"

A set of recommended deployment configurations for the model.

" - } - }, - "documentation":"

The properties of a model as returned by the Search API.

" - }, - "ModelAccessConfig":{ - "type":"structure", - "required":["AcceptEula"], - "members":{ - "AcceptEula":{ - "shape":"AcceptEula", - "documentation":"

Specifies agreement to the model end-user license agreement (EULA). The AcceptEula value must be explicitly defined as True in order to accept the EULA that this model requires. You are responsible for reviewing and complying with any applicable license terms and making sure they are acceptable for your use case before downloading or using a model.

", - "box":true - } - }, - "documentation":"

The access configuration file to control access to the ML model. You can explicitly accept the model end-user license agreement (EULA) within the ModelAccessConfig.

" - }, - "ModelApprovalStatus":{ - "type":"string", - "enum":[ - "Approved", - "Rejected", - "PendingManualApproval" - ] - }, - "ModelArn":{ - "type":"string", - "max":2048, - "min":20, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:model/.*" - }, - "ModelArtifacts":{ - "type":"structure", - "required":["S3ModelArtifacts"], - "members":{ - "S3ModelArtifacts":{ - "shape":"S3Uri", - "documentation":"

The path of the S3 object that contains the model artifacts. For example, s3://bucket-name/keynameprefix/model.tar.gz.

" - } - }, - "documentation":"

Provides information about the location that is configured for storing model artifacts.

Model artifacts are outputs that result from training a model. They typically consist of trained parameters, a model definition that describes how to compute inferences, and other metadata. A SageMaker container stores your trained model artifacts in the /opt/ml/model directory. After training has completed, by default, these artifacts are uploaded to your Amazon S3 bucket as compressed files.

" - }, - "ModelBiasAppSpecification":{ - "type":"structure", - "required":[ - "ImageUri", - "ConfigUri" - ], - "members":{ - "ImageUri":{ - "shape":"ImageUri", - "documentation":"

The container image to be run by the model bias job.

" - }, - "ConfigUri":{ - "shape":"S3Uri", - "documentation":"

JSON formatted S3 file that defines bias parameters. For more information on this JSON configuration file, see Configure bias parameters.

" - }, - "Environment":{ - "shape":"MonitoringEnvironmentMap", - "documentation":"

Sets the environment variables in the Docker container.

" - } - }, - "documentation":"

Docker container image configuration object for the model bias job.

" - }, - "ModelBiasBaselineConfig":{ - "type":"structure", - "members":{ - "BaseliningJobName":{ - "shape":"ProcessingJobName", - "documentation":"

The name of the baseline model bias job.

" - }, - "ConstraintsResource":{"shape":"MonitoringConstraintsResource"} - }, - "documentation":"

The configuration for a baseline model bias job.

" - }, - "ModelBiasJobInput":{ - "type":"structure", - "required":["GroundTruthS3Input"], - "members":{ - "EndpointInput":{"shape":"EndpointInput"}, - "BatchTransformInput":{ - "shape":"BatchTransformInput", - "documentation":"

Input object for the batch transform job.

" - }, - "GroundTruthS3Input":{ - "shape":"MonitoringGroundTruthS3Input", - "documentation":"

Location of ground truth labels to use in model bias job.

" - } - }, - "documentation":"

Inputs for the model bias job.

" - }, - "ModelCacheSetting":{ - "type":"string", - "enum":[ - "Enabled", - "Disabled" - ] - }, - "ModelCard":{ - "type":"structure", - "members":{ - "ModelCardArn":{ - "shape":"ModelCardArn", - "documentation":"

The Amazon Resource Name (ARN) of the model card.

" - }, - "ModelCardName":{ - "shape":"EntityName", - "documentation":"

The unique name of the model card.

" - }, - "ModelCardVersion":{ - "shape":"Integer", - "documentation":"

The version of the model card.

", - "box":true - }, - "Content":{ - "shape":"ModelCardContent", - "documentation":"

The content of the model card. Content uses the model card JSON schema and provided as a string.

" - }, - "ModelCardStatus":{ - "shape":"ModelCardStatus", - "documentation":"

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

  • Draft: The model card is a work in progress.

  • PendingReview: The model card is pending review.

  • Approved: The model card is approved.

  • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

" - }, - "SecurityConfig":{ - "shape":"ModelCardSecurityConfig", - "documentation":"

The security configuration used to protect model card data.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The date and time that the model card was created.

" - }, - "CreatedBy":{"shape":"UserContext"}, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The date and time that the model card was last modified.

" - }, - "LastModifiedBy":{"shape":"UserContext"}, - "Tags":{ - "shape":"TagList", - "documentation":"

Key-value pairs used to manage metadata for the model card.

" - }, - "ModelId":{ - "shape":"String", - "documentation":"

The unique name (ID) of the model.

" - }, - "RiskRating":{ - "shape":"String", - "documentation":"

The risk rating of the model. Different organizations might have different criteria for model card risk ratings. For more information, see Risk ratings.

" - }, - "ModelPackageGroupName":{ - "shape":"String", - "documentation":"

The model package group that contains the model package. Only relevant for model cards created for model packages in the Amazon SageMaker Model Registry.

" - } - }, - "documentation":"

An Amazon SageMaker Model Card.

" - }, - "ModelCardArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-card/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" - }, - "ModelCardContent":{ - "type":"string", - "max":100000, - "min":0, - "pattern":".*", - "sensitive":true - }, - "ModelCardExportArtifacts":{ - "type":"structure", - "required":["S3ExportArtifacts"], - "members":{ - "S3ExportArtifacts":{ - "shape":"S3Uri", - "documentation":"

The Amazon S3 URI of the exported model artifacts.

" - } - }, - "documentation":"

The artifacts of the model card export job.

" - }, - "ModelCardExportJobArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-card/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}/export-job/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" - }, - "ModelCardExportJobSortBy":{ - "type":"string", - "documentation":"

Attribute by which to sort returned export jobs.

", - "enum":[ - "Name", - "CreationTime", - "Status" - ] - }, - "ModelCardExportJobSortOrder":{ - "type":"string", - "enum":[ - "Ascending", - "Descending" - ] - }, - "ModelCardExportJobStatus":{ - "type":"string", - "enum":[ - "InProgress", - "Completed", - "Failed" - ] - }, - "ModelCardExportJobSummary":{ - "type":"structure", - "required":[ - "ModelCardExportJobName", - "ModelCardExportJobArn", - "Status", - "ModelCardName", - "ModelCardVersion", - "CreatedAt", - "LastModifiedAt" - ], - "members":{ - "ModelCardExportJobName":{ - "shape":"EntityName", - "documentation":"

The name of the model card export job.

" - }, - "ModelCardExportJobArn":{ - "shape":"ModelCardExportJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the model card export job.

" - }, - "Status":{ - "shape":"ModelCardExportJobStatus", - "documentation":"

The completion status of the model card export job.

" - }, - "ModelCardName":{ - "shape":"EntityName", - "documentation":"

The name of the model card that the export job exports.

" - }, - "ModelCardVersion":{ - "shape":"Integer", - "documentation":"

The version of the model card that the export job exports.

", - "box":true - }, - "CreatedAt":{ - "shape":"Timestamp", - "documentation":"

The date and time that the model card export job was created.

" - }, - "LastModifiedAt":{ - "shape":"Timestamp", - "documentation":"

The date and time that the model card export job was last modified..

" - } - }, - "documentation":"

The summary of the Amazon SageMaker Model Card export job.

" - }, - "ModelCardExportJobSummaryList":{ - "type":"list", - "member":{"shape":"ModelCardExportJobSummary"} - }, - "ModelCardExportOutputConfig":{ - "type":"structure", - "required":["S3OutputPath"], - "members":{ - "S3OutputPath":{ - "shape":"S3Uri", - "documentation":"

The Amazon S3 output path to export your model card PDF.

" - } - }, - "documentation":"

Configure the export output details for an Amazon SageMaker Model Card.

" - }, - "ModelCardNameOrArn":{ - "type":"string", - "max":256, - "min":1, - "pattern":"(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:model-card/.*)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62})" - }, - "ModelCardProcessingStatus":{ - "type":"string", - "enum":[ - "DeleteInProgress", - "DeletePending", - "ContentDeleted", - "ExportJobsDeleted", - "DeleteCompleted", - "DeleteFailed" - ] - }, - "ModelCardSecurityConfig":{ - "type":"structure", - "members":{ - "KmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

A Key Management Service key ID to use for encrypting a model card.

" - } - }, - "documentation":"

Configure the security settings to protect model card data.

" - }, - "ModelCardSortBy":{ - "type":"string", - "enum":[ - "Name", - "CreationTime" - ] - }, - "ModelCardSortOrder":{ - "type":"string", - "enum":[ - "Ascending", - "Descending" - ] - }, - "ModelCardStatus":{ - "type":"string", - "enum":[ - "Draft", - "PendingReview", - "Approved", - "Archived" - ] - }, - "ModelCardSummary":{ - "type":"structure", - "required":[ - "ModelCardName", - "ModelCardArn", - "ModelCardStatus", - "CreationTime" - ], - "members":{ - "ModelCardName":{ - "shape":"EntityName", - "documentation":"

The name of the model card.

" - }, - "ModelCardArn":{ - "shape":"ModelCardArn", - "documentation":"

The Amazon Resource Name (ARN) of the model card.

" - }, - "ModelCardStatus":{ - "shape":"ModelCardStatus", - "documentation":"

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

  • Draft: The model card is a work in progress.

  • PendingReview: The model card is pending review.

  • Approved: The model card is approved.

  • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The date and time that the model card was created.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The date and time that the model card was last modified.

" - } - }, - "documentation":"

A summary of the model card.

" - }, - "ModelCardSummaryList":{ - "type":"list", - "member":{"shape":"ModelCardSummary"} - }, - "ModelCardVersionSortBy":{ - "type":"string", - "enum":["Version"] - }, - "ModelCardVersionSummary":{ - "type":"structure", - "required":[ - "ModelCardName", - "ModelCardArn", - "ModelCardStatus", - "ModelCardVersion", - "CreationTime" - ], - "members":{ - "ModelCardName":{ - "shape":"EntityName", - "documentation":"

The name of the model card.

" - }, - "ModelCardArn":{ - "shape":"ModelCardArn", - "documentation":"

The Amazon Resource Name (ARN) of the model card.

" - }, - "ModelCardStatus":{ - "shape":"ModelCardStatus", - "documentation":"

The approval status of the model card version within your organization. Different organizations might have different criteria for model card review and approval.

  • Draft: The model card is a work in progress.

  • PendingReview: The model card is pending review.

  • Approved: The model card is approved.

  • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

" - }, - "ModelCardVersion":{ - "shape":"Integer", - "documentation":"

A version of the model card.

", - "box":true - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The date and time that the model card version was created.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The time date and time that the model card version was last modified.

" - } - }, - "documentation":"

A summary of a specific version of the model card.

" - }, - "ModelCardVersionSummaryList":{ - "type":"list", - "member":{"shape":"ModelCardVersionSummary"} - }, - "ModelClientConfig":{ - "type":"structure", - "members":{ - "InvocationsTimeoutInSeconds":{ - "shape":"InvocationsTimeoutInSeconds", - "documentation":"

The timeout value in seconds for an invocation request. The default value is 600.

" - }, - "InvocationsMaxRetries":{ - "shape":"InvocationsMaxRetries", - "documentation":"

The maximum number of retries when invocation requests are failing. The default value is 3.

" - } - }, - "documentation":"

Configures the timeout and maximum number of retries for processing a transform job invocation.

" - }, - "ModelCompilationConfig":{ - "type":"structure", - "members":{ - "Image":{ - "shape":"OptimizationContainerImage", - "documentation":"

The URI of an LMI DLC in Amazon ECR. SageMaker uses this image to run the optimization.

" - }, - "OverrideEnvironment":{ - "shape":"OptimizationJobEnvironmentVariables", - "documentation":"

Environment variables that override the default ones in the model container.

" - } - }, - "documentation":"

Settings for the model compilation technique that's applied by a model optimization job.

" - }, - "ModelCompressionType":{ - "type":"string", - "enum":[ - "None", - "Gzip" - ] - }, - "ModelConfiguration":{ - "type":"structure", - "members":{ - "InferenceSpecificationName":{ - "shape":"InferenceSpecificationName", - "documentation":"

The inference specification name in the model package version.

" - }, - "EnvironmentParameters":{ - "shape":"EnvironmentParameters", - "documentation":"

Defines the environment parameters that includes key, value types, and values.

" - }, - "CompilationJobName":{ - "shape":"RecommendationJobCompilationJobName", - "documentation":"

The name of the compilation job used to create the recommended model artifacts.

" - } - }, - "documentation":"

Defines the model configuration. Includes the specification name and environment parameters.

" - }, - "ModelDashboardEndpoint":{ - "type":"structure", - "required":[ - "EndpointName", - "EndpointArn", - "CreationTime", - "LastModifiedTime", - "EndpointStatus" - ], - "members":{ - "EndpointName":{ - "shape":"EndpointName", - "documentation":"

The endpoint name.

" - }, - "EndpointArn":{ - "shape":"EndpointArn", - "documentation":"

The Amazon Resource Name (ARN) of the endpoint.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that indicates when the endpoint was created.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The last time the endpoint was modified.

" - }, - "EndpointStatus":{ - "shape":"EndpointStatus", - "documentation":"

The endpoint status.

" - } - }, - "documentation":"

An endpoint that hosts a model displayed in the Amazon SageMaker Model Dashboard.

" - }, - "ModelDashboardEndpoints":{ - "type":"list", - "member":{"shape":"ModelDashboardEndpoint"} - }, - "ModelDashboardIndicatorAction":{ - "type":"structure", - "members":{ - "Enabled":{ - "shape":"Boolean", - "documentation":"

Indicates whether the alert action is turned on.

", - "box":true - } - }, - "documentation":"

An alert action taken to light up an icon on the Amazon SageMaker Model Dashboard when an alert goes into InAlert status.

" - }, - "ModelDashboardModel":{ - "type":"structure", - "members":{ - "Model":{ - "shape":"Model", - "documentation":"

A model displayed in the Model Dashboard.

" - }, - "Endpoints":{ - "shape":"ModelDashboardEndpoints", - "documentation":"

The endpoints that host a model.

" - }, - "LastBatchTransformJob":{"shape":"TransformJob"}, - "MonitoringSchedules":{ - "shape":"ModelDashboardMonitoringSchedules", - "documentation":"

The monitoring schedules for a model.

" - }, - "ModelCard":{ - "shape":"ModelDashboardModelCard", - "documentation":"

The model card for a model.

" - } - }, - "documentation":"

A model displayed in the Amazon SageMaker Model Dashboard.

" - }, - "ModelDashboardModelCard":{ - "type":"structure", - "members":{ - "ModelCardArn":{ - "shape":"ModelCardArn", - "documentation":"

The Amazon Resource Name (ARN) for a model card.

" - }, - "ModelCardName":{ - "shape":"EntityName", - "documentation":"

The name of a model card.

" - }, - "ModelCardVersion":{ - "shape":"Integer", - "documentation":"

The model card version.

", - "box":true - }, - "ModelCardStatus":{ - "shape":"ModelCardStatus", - "documentation":"

The model card status.

" - }, - "SecurityConfig":{ - "shape":"ModelCardSecurityConfig", - "documentation":"

The KMS Key ID (KMSKeyId) for encryption of model card information.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that indicates when the model card was created.

" - }, - "CreatedBy":{"shape":"UserContext"}, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that indicates when the model card was last updated.

" - }, - "LastModifiedBy":{"shape":"UserContext"}, - "Tags":{ - "shape":"TagList", - "documentation":"

The tags associated with a model card.

" - }, - "ModelId":{ - "shape":"String", - "documentation":"

For models created in SageMaker, this is the model ARN. For models created outside of SageMaker, this is a user-customized string.

" - }, - "RiskRating":{ - "shape":"String", - "documentation":"

A model card's risk rating. Can be low, medium, or high.

" - } - }, - "documentation":"

The model card for a model displayed in the Amazon SageMaker Model Dashboard.

" - }, - "ModelDashboardMonitoringSchedule":{ - "type":"structure", - "members":{ - "MonitoringScheduleArn":{ - "shape":"MonitoringScheduleArn", - "documentation":"

The Amazon Resource Name (ARN) of a monitoring schedule.

" - }, - "MonitoringScheduleName":{ - "shape":"MonitoringScheduleName", - "documentation":"

The name of a monitoring schedule.

" - }, - "MonitoringScheduleStatus":{ - "shape":"ScheduleStatus", - "documentation":"

The status of the monitoring schedule.

" - }, - "MonitoringType":{ - "shape":"MonitoringType", - "documentation":"

The monitor type of a model monitor.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

If a monitoring job failed, provides the reason.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that indicates when the monitoring schedule was created.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that indicates when the monitoring schedule was last updated.

" - }, - "MonitoringScheduleConfig":{"shape":"MonitoringScheduleConfig"}, - "EndpointName":{ - "shape":"EndpointName", - "documentation":"

The endpoint which is monitored.

" - }, - "MonitoringAlertSummaries":{ - "shape":"MonitoringAlertSummaryList", - "documentation":"

A JSON array where each element is a summary for a monitoring alert.

" - }, - "LastMonitoringExecutionSummary":{"shape":"MonitoringExecutionSummary"}, - "BatchTransformInput":{"shape":"BatchTransformInput"} - }, - "documentation":"

A monitoring schedule for a model displayed in the Amazon SageMaker Model Dashboard.

" - }, - "ModelDashboardMonitoringSchedules":{ - "type":"list", - "member":{"shape":"ModelDashboardMonitoringSchedule"} - }, - "ModelDataQuality":{ - "type":"structure", - "members":{ - "Statistics":{ - "shape":"MetricsSource", - "documentation":"

Data quality statistics for a model.

" - }, - "Constraints":{ - "shape":"MetricsSource", - "documentation":"

Data quality constraints for a model.

" - } - }, - "documentation":"

Data quality constraints and statistics for a model.

" - }, - "ModelDataSource":{ - "type":"structure", - "members":{ - "S3DataSource":{ - "shape":"S3ModelDataSource", - "documentation":"

Specifies the S3 location of ML model data to deploy.

" - } - }, - "documentation":"

Specifies the location of ML model data to deploy. If specified, you must specify one and only one of the available data sources.

" - }, - "ModelDeployConfig":{ - "type":"structure", - "members":{ - "AutoGenerateEndpointName":{ - "shape":"AutoGenerateEndpointName", - "documentation":"

Set to True to automatically generate an endpoint name for a one-click Autopilot model deployment; set to False otherwise. The default value is False.

If you set AutoGenerateEndpointName to True, do not specify the EndpointName; otherwise a 400 error is thrown.

", - "box":true - }, - "EndpointName":{ - "shape":"EndpointName", - "documentation":"

Specifies the endpoint name to use for a one-click Autopilot model deployment if the endpoint name is not generated automatically.

Specify the EndpointName if and only if you set AutoGenerateEndpointName to False; otherwise a 400 error is thrown.

" - } - }, - "documentation":"

Specifies how to generate the endpoint name for an automatic one-click Autopilot model deployment.

" - }, - "ModelDeployResult":{ - "type":"structure", - "members":{ - "EndpointName":{ - "shape":"EndpointName", - "documentation":"

The name of the endpoint to which the model has been deployed.

If model deployment fails, this field is omitted from the response.

" - } - }, - "documentation":"

Provides information about the endpoint of the model deployment.

" - }, - "ModelDigests":{ - "type":"structure", - "members":{ - "ArtifactDigest":{ - "shape":"ArtifactDigest", - "documentation":"

Provides a hash value that uniquely identifies the stored model artifacts.

" - } - }, - "documentation":"

Provides information to verify the integrity of stored model artifacts.

" - }, - "ModelExplainabilityAppSpecification":{ - "type":"structure", - "required":[ - "ImageUri", - "ConfigUri" - ], - "members":{ - "ImageUri":{ - "shape":"ImageUri", - "documentation":"

The container image to be run by the model explainability job.

" - }, - "ConfigUri":{ - "shape":"S3Uri", - "documentation":"

JSON formatted Amazon S3 file that defines explainability parameters. For more information on this JSON configuration file, see Configure model explainability parameters.

" - }, - "Environment":{ - "shape":"MonitoringEnvironmentMap", - "documentation":"

Sets the environment variables in the Docker container.

" - } - }, - "documentation":"

Docker container image configuration object for the model explainability job.

" - }, - "ModelExplainabilityBaselineConfig":{ - "type":"structure", - "members":{ - "BaseliningJobName":{ - "shape":"ProcessingJobName", - "documentation":"

The name of the baseline model explainability job.

" - }, - "ConstraintsResource":{"shape":"MonitoringConstraintsResource"} - }, - "documentation":"

The configuration for a baseline model explainability job.

" - }, - "ModelExplainabilityJobInput":{ - "type":"structure", - "members":{ - "EndpointInput":{"shape":"EndpointInput"}, - "BatchTransformInput":{ - "shape":"BatchTransformInput", - "documentation":"

Input object for the batch transform job.

" - } - }, - "documentation":"

Inputs for the model explainability job.

" - }, - "ModelInfrastructureConfig":{ - "type":"structure", - "required":[ - "InfrastructureType", - "RealTimeInferenceConfig" - ], - "members":{ - "InfrastructureType":{ - "shape":"ModelInfrastructureType", - "documentation":"

The inference option to which to deploy your model. Possible values are the following:

  • RealTime: Deploy to real-time inference.

" - }, - "RealTimeInferenceConfig":{ - "shape":"RealTimeInferenceConfig", - "documentation":"

The infrastructure configuration for deploying the model to real-time inference.

" - } - }, - "documentation":"

The configuration for the infrastructure that the model will be deployed to.

" - }, - "ModelInfrastructureType":{ - "type":"string", - "enum":["RealTimeInference"] - }, - "ModelInput":{ - "type":"structure", - "required":["DataInputConfig"], - "members":{ - "DataInputConfig":{ - "shape":"DataInputConfig", - "documentation":"

The input configuration object for the model.

" - } - }, - "documentation":"

Input object for the model.

" - }, - "ModelInsightsLocation":{ - "type":"string", - "min":1 - }, - "ModelLatencyThreshold":{ - "type":"structure", - "members":{ - "Percentile":{ - "shape":"String64", - "documentation":"

The model latency percentile threshold. Acceptable values are P95 and P99. For custom load tests, specify the value as P95.

" - }, - "ValueInMilliseconds":{ - "shape":"Integer", - "documentation":"

The model latency percentile value in milliseconds.

", - "box":true - } - }, - "documentation":"

The model latency threshold.

" - }, - "ModelLatencyThresholds":{ - "type":"list", - "member":{"shape":"ModelLatencyThreshold"}, - "max":1, - "min":1 - }, - "ModelLifeCycle":{ - "type":"structure", - "required":[ - "Stage", - "StageStatus" - ], - "members":{ - "Stage":{ - "shape":"EntityName", - "documentation":"

The current stage in the model life cycle.

" - }, - "StageStatus":{ - "shape":"EntityName", - "documentation":"

The current status of a stage in model life cycle.

" - }, - "StageDescription":{ - "shape":"StageDescription", - "documentation":"

Describes the stage related details.

" - } - }, - "documentation":"

A structure describing the current state of the model in its life cycle.

" - }, - "ModelMetadataFilter":{ - "type":"structure", - "required":[ - "Name", - "Value" - ], - "members":{ - "Name":{ - "shape":"ModelMetadataFilterType", - "documentation":"

The name of the of the model to filter by.

" - }, - "Value":{ - "shape":"String256", - "documentation":"

The value to filter the model metadata.

" - } - }, - "documentation":"

Part of the search expression. You can specify the name and value (domain, task, framework, framework version, task, and model).

" - }, - "ModelMetadataFilterType":{ - "type":"string", - "enum":[ - "Domain", - "Framework", - "Task", - "FrameworkVersion" - ] - }, - "ModelMetadataFilters":{ - "type":"list", - "member":{"shape":"ModelMetadataFilter"}, - "max":4, - "min":1 - }, - "ModelMetadataSearchExpression":{ - "type":"structure", - "members":{ - "Filters":{ - "shape":"ModelMetadataFilters", - "documentation":"

A list of filter objects.

" - } - }, - "documentation":"

One or more filters that searches for the specified resource or resources in a search. All resource objects that satisfy the expression's condition are included in the search results

" - }, - "ModelMetadataSummaries":{ - "type":"list", - "member":{"shape":"ModelMetadataSummary"} - }, - "ModelMetadataSummary":{ - "type":"structure", - "required":[ - "Domain", - "Framework", - "Task", - "Model", - "FrameworkVersion" - ], - "members":{ - "Domain":{ - "shape":"String", - "documentation":"

The machine learning domain of the model.

" - }, - "Framework":{ - "shape":"String", - "documentation":"

The machine learning framework of the model.

" - }, - "Task":{ - "shape":"String", - "documentation":"

The machine learning task of the model.

" - }, - "Model":{ - "shape":"String", - "documentation":"

The name of the model.

" - }, - "FrameworkVersion":{ - "shape":"String", - "documentation":"

The framework version of the model.

" - } - }, - "documentation":"

A summary of the model metadata.

" - }, - "ModelMetrics":{ - "type":"structure", - "members":{ - "ModelQuality":{ - "shape":"ModelQuality", - "documentation":"

Metrics that measure the quality of a model.

" - }, - "ModelDataQuality":{ - "shape":"ModelDataQuality", - "documentation":"

Metrics that measure the quality of the input data for a model.

" - }, - "Bias":{ - "shape":"Bias", - "documentation":"

Metrics that measure bias in a model.

" - }, - "Explainability":{ - "shape":"Explainability", - "documentation":"

Metrics that help explain a model.

" - } - }, - "documentation":"

Contains metrics captured from a model.

" - }, - "ModelName":{ - "type":"string", - "max":63, - "min":0, - "pattern":"[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?" - }, - "ModelNameContains":{ - "type":"string", - "max":63, - "min":0, - "pattern":"[a-zA-Z0-9-]+" - }, - "ModelPackage":{ - "type":"structure", - "members":{ - "ModelPackageName":{ - "shape":"EntityName", - "documentation":"

The name of the model package. The name can be as follows:

  • For a versioned model, the name is automatically generated by SageMaker Model Registry and follows the format 'ModelPackageGroupName/ModelPackageVersion'.

  • For an unversioned model, you must provide the name.

" - }, - "ModelPackageGroupName":{ - "shape":"EntityName", - "documentation":"

The model group to which the model belongs.

" - }, - "ModelPackageVersion":{ - "shape":"ModelPackageVersion", - "documentation":"

The version number of a versioned model.

" - }, - "ModelPackageRegistrationType":{ - "shape":"ModelPackageRegistrationType", - "documentation":"

The package registration type of the model package.

" - }, - "ModelPackageArn":{ - "shape":"ModelPackageArn", - "documentation":"

The Amazon Resource Name (ARN) of the model package.

" - }, - "ModelPackageDescription":{ - "shape":"EntityDescription", - "documentation":"

The description of the model package.

" - }, - "CreationTime":{ - "shape":"CreationTime", - "documentation":"

The time that the model package was created.

" - }, - "InferenceSpecification":{ - "shape":"InferenceSpecification", - "documentation":"

Defines how to perform inference generation after a training job is run.

" - }, - "SourceAlgorithmSpecification":{ - "shape":"SourceAlgorithmSpecification", - "documentation":"

A list of algorithms that were used to create a model package.

" - }, - "ValidationSpecification":{ - "shape":"ModelPackageValidationSpecification", - "documentation":"

Specifies batch transform jobs that SageMaker runs to validate your model package.

" - }, - "ModelPackageStatus":{ - "shape":"ModelPackageStatus", - "documentation":"

The status of the model package. This can be one of the following values.

  • PENDING - The model package is pending being created.

  • IN_PROGRESS - The model package is in the process of being created.

  • COMPLETED - The model package was successfully created.

  • FAILED - The model package failed.

  • DELETING - The model package is in the process of being deleted.

" - }, - "ModelPackageStatusDetails":{ - "shape":"ModelPackageStatusDetails", - "documentation":"

Specifies the validation and image scan statuses of the model package.

" - }, - "CertifyForMarketplace":{ - "shape":"CertifyForMarketplace", - "documentation":"

Whether the model package is to be certified to be listed on Amazon Web Services Marketplace. For information about listing model packages on Amazon Web Services Marketplace, see List Your Algorithm or Model Package on Amazon Web Services Marketplace.

", - "box":true - }, - "ModelApprovalStatus":{ - "shape":"ModelApprovalStatus", - "documentation":"

The approval status of the model. This can be one of the following values.

  • APPROVED - The model is approved

  • REJECTED - The model is rejected.

  • PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.

" - }, - "CreatedBy":{ - "shape":"UserContext", - "documentation":"

Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.

" - }, - "MetadataProperties":{ - "shape":"MetadataProperties", - "documentation":"

Metadata properties of the tracking entity, trial, or trial component.

" - }, - "ModelMetrics":{ - "shape":"ModelMetrics", - "documentation":"

Metrics for the model.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The last time the model package was modified.

" - }, - "LastModifiedBy":{ - "shape":"UserContext", - "documentation":"

Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.

" - }, - "ApprovalDescription":{ - "shape":"ApprovalDescription", - "documentation":"

A description provided when the model approval is set.

" - }, - "Domain":{ - "shape":"String", - "documentation":"

The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.

" - }, - "Task":{ - "shape":"String", - "documentation":"

The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification.

" - }, - "SamplePayloadUrl":{ - "shape":"String", - "documentation":"

The Amazon Simple Storage Service path where the sample payload are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

" - }, - "AdditionalInferenceSpecifications":{ - "shape":"AdditionalInferenceSpecifications", - "documentation":"

An array of additional Inference Specification objects.

" - }, - "SourceUri":{ - "shape":"ModelPackageSourceUri", - "documentation":"

The URI of the source for the model package.

" - }, - "SecurityConfig":{"shape":"ModelPackageSecurityConfig"}, - "ModelCard":{"shape":"ModelPackageModelCard"}, - "ModelLifeCycle":{ - "shape":"ModelLifeCycle", - "documentation":"

A structure describing the current state of the model in its life cycle.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

A list of the tags associated with the model package. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

" - }, - "CustomerMetadataProperties":{ - "shape":"CustomerMetadataMap", - "documentation":"

The metadata properties for the model package.

" - }, - "DriftCheckBaselines":{ - "shape":"DriftCheckBaselines", - "documentation":"

Represents the drift check baselines that can be used when the model monitor is set using the model package.

" - }, - "SkipModelValidation":{ - "shape":"SkipModelValidation", - "documentation":"

Indicates if you want to skip model validation.

" - } - }, - "documentation":"

A container for your trained model that can be deployed for SageMaker inference. This can include inference code, artifacts, and metadata. The model package type can be one of the following.

  • Versioned model: A part of a model package group in Model Registry.

  • Unversioned model: Not part of a model package group and used in Amazon Web Services Marketplace.

For more information, see CreateModelPackage .

" - }, - "ModelPackageArn":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-package/[\\S]{1,2048}" - }, - "ModelPackageArnList":{ - "type":"list", - "member":{"shape":"ModelPackageArn"}, - "max":100, - "min":1 - }, - "ModelPackageConfig":{ - "type":"structure", - "required":["ModelPackageGroupArn"], - "members":{ - "ModelPackageGroupArn":{ - "shape":"ModelPackageGroupArn", - "documentation":"

The Amazon Resource Name (ARN) of the model package group of output model package.

" - }, - "SourceModelPackageArn":{ - "shape":"ModelPackageArn", - "documentation":"

The Amazon Resource Name (ARN) of the source model package used for continued fine-tuning and custom model evaluation.

" - } - }, - "documentation":"

The configuration for the Model package.

" - }, - "ModelPackageContainerDefinition":{ - "type":"structure", - "members":{ - "ContainerHostname":{ - "shape":"ContainerHostname", - "documentation":"

The DNS host name for the Docker container.

" - }, - "Image":{ - "shape":"ContainerImage", - "documentation":"

The Amazon Elastic Container Registry (Amazon ECR) path where inference code is stored.

If you are using your own custom algorithm instead of an algorithm provided by SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

" - }, - "ImageDigest":{ - "shape":"ImageDigest", - "documentation":"

An MD5 hash of the training algorithm that identifies the Docker image used for training.

" - }, - "ModelDataUrl":{ - "shape":"Url", - "documentation":"

The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

The model artifacts must be in an S3 bucket that is in the same region as the model package.

" - }, - "ModelDataSource":{ - "shape":"ModelDataSource", - "documentation":"

Specifies the location of ML model data to deploy during endpoint creation.

" - }, - "ProductId":{ - "shape":"ProductId", - "documentation":"

The Amazon Web Services Marketplace product ID of the model package.

" - }, - "Environment":{ - "shape":"EnvironmentMap", - "documentation":"

The environment variables to set in the Docker container. Each key and value in the Environment string to string map can have length of up to 1024. We support up to 16 entries in the map.

" - }, - "ModelInput":{ - "shape":"ModelInput", - "documentation":"

A structure with Model Input details.

" - }, - "Framework":{ - "shape":"String", - "documentation":"

The machine learning framework of the model package container image.

" - }, - "FrameworkVersion":{ - "shape":"ModelPackageFrameworkVersion", - "documentation":"

The framework version of the Model Package Container Image.

" - }, - "NearestModelName":{ - "shape":"String", - "documentation":"

The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model. You can find a list of benchmarked models by calling ListModelMetadata.

" - }, - "AdditionalModelDataSources":{ - "shape":"AdditionalModelDataSources", - "documentation":"

Data sources that are available to your model in addition to the one that you specify for ModelDataSource when you use the CreateModelPackage action.

" - }, - "AdditionalS3DataSource":{ - "shape":"AdditionalS3DataSource", - "documentation":"

The additional data source that is used during inference in the Docker container for your model package.

" - }, - "ModelDataETag":{ - "shape":"String", - "documentation":"

The ETag associated with Model Data URL.

" - }, - "IsCheckpoint":{ - "shape":"Boolean", - "documentation":"

Specifies whether the model data is a training checkpoint.

", - "box":true - }, - "BaseModel":{ - "shape":"BaseModel", - "documentation":"

Identifies the foundation model that was used as the starting point for model customization.

" - } - }, - "documentation":"

Describes the Docker container for the model package.

" - }, - "ModelPackageContainerDefinitionList":{ - "type":"list", - "member":{"shape":"ModelPackageContainerDefinition"}, - "max":15, - "min":1 - }, - "ModelPackageFrameworkVersion":{ - "type":"string", - "max":10, - "min":3, - "pattern":"[0-9]\\.[A-Za-z0-9.-]+" - }, - "ModelPackageGroup":{ - "type":"structure", - "members":{ - "ModelPackageGroupName":{ - "shape":"EntityName", - "documentation":"

The name of the model group.

" - }, - "ModelPackageGroupArn":{ - "shape":"ModelPackageGroupArn", - "documentation":"

The Amazon Resource Name (ARN) of the model group.

" - }, - "ModelPackageGroupDescription":{ - "shape":"EntityDescription", - "documentation":"

The description for the model group.

" - }, - "CreationTime":{ - "shape":"CreationTime", - "documentation":"

The time that the model group was created.

" - }, - "CreatedBy":{"shape":"UserContext"}, - "ModelPackageGroupStatus":{ - "shape":"ModelPackageGroupStatus", - "documentation":"

The status of the model group. This can be one of the following values.

  • PENDING - The model group is pending being created.

  • IN_PROGRESS - The model group is in the process of being created.

  • COMPLETED - The model group was successfully created.

  • FAILED - The model group failed.

  • DELETING - The model group is in the process of being deleted.

  • DELETE_FAILED - SageMaker failed to delete the model group.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

A list of the tags associated with the model group. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

" - } - }, - "documentation":"

A group of versioned models in the Model Registry.

" - }, - "ModelPackageGroupArn":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-package-group/[\\S]{1,2048}" - }, - "ModelPackageGroupSortBy":{ - "type":"string", - "enum":[ - "Name", - "CreationTime" - ] - }, - "ModelPackageGroupStatus":{ - "type":"string", - "enum":[ - "Pending", - "InProgress", - "Completed", - "Failed", - "Deleting", - "DeleteFailed" - ] - }, - "ModelPackageGroupSummary":{ - "type":"structure", - "required":[ - "ModelPackageGroupName", - "ModelPackageGroupArn", - "CreationTime", - "ModelPackageGroupStatus" - ], - "members":{ - "ModelPackageGroupName":{ - "shape":"EntityName", - "documentation":"

The name of the model group.

" - }, - "ModelPackageGroupArn":{ - "shape":"ModelPackageGroupArn", - "documentation":"

The Amazon Resource Name (ARN) of the model group.

" - }, - "ModelPackageGroupDescription":{ - "shape":"EntityDescription", - "documentation":"

A description of the model group.

" - }, - "CreationTime":{ - "shape":"CreationTime", - "documentation":"

The time that the model group was created.

" - }, - "ModelPackageGroupStatus":{ - "shape":"ModelPackageGroupStatus", - "documentation":"

The status of the model group.

" - }, - "ManagedConfiguration":{ - "shape":"ManagedConfiguration", - "documentation":"

The managed configuration of the model package group.

" - } - }, - "documentation":"

Summary information about a model group.

" - }, - "ModelPackageGroupSummaryList":{ - "type":"list", - "member":{"shape":"ModelPackageGroupSummary"} - }, - "ModelPackageModelCard":{ - "type":"structure", - "members":{ - "ModelCardContent":{ - "shape":"ModelCardContent", - "documentation":"

The content of the model card. The content must follow the schema described in Model Package Model Card Schema.

" - }, - "ModelCardStatus":{ - "shape":"ModelCardStatus", - "documentation":"

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

  • Draft: The model card is a work in progress.

  • PendingReview: The model card is pending review.

  • Approved: The model card is approved.

  • Archived: The model card is archived. No more updates can be made to the model card content. If you try to update the model card content, you will receive the message Model Card is in Archived state.

" - } - }, - "documentation":"

The model card associated with the model package. Since ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version.

" - }, - "ModelPackageRegistrationType":{ - "type":"string", - "enum":[ - "Logged", - "Registered" - ] - }, - "ModelPackageSecurityConfig":{ - "type":"structure", - "required":["KmsKeyId"], - "members":{ - "KmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The KMS Key ID (KMSKeyId) used for encryption of model package information.

" - } - }, - "documentation":"

An optional Key Management Service key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with highly sensitive data.

" - }, - "ModelPackageSortBy":{ - "type":"string", - "enum":[ - "Name", - "CreationTime" - ] - }, - "ModelPackageSourceUri":{ - "type":"string", - "max":1024, - "min":0, - "pattern":"[\\p{L}\\p{M}\\p{Z}\\p{N}\\p{P}]{0,1024}" - }, - "ModelPackageStatus":{ - "type":"string", - "enum":[ - "Pending", - "InProgress", - "Completed", - "Failed", - "Deleting" - ] - }, - "ModelPackageStatusDetails":{ - "type":"structure", - "required":["ValidationStatuses"], - "members":{ - "ValidationStatuses":{ - "shape":"ModelPackageStatusItemList", - "documentation":"

The validation status of the model package.

" - }, - "ImageScanStatuses":{ - "shape":"ModelPackageStatusItemList", - "documentation":"

The status of the scan of the Docker image container for the model package.

" - } - }, - "documentation":"

Specifies the validation and image scan statuses of the model package.

" - }, - "ModelPackageStatusItem":{ - "type":"structure", - "required":[ - "Name", - "Status" - ], - "members":{ - "Name":{ - "shape":"EntityName", - "documentation":"

The name of the model package for which the overall status is being reported.

" - }, - "Status":{ - "shape":"DetailedModelPackageStatus", - "documentation":"

The current status.

" - }, - "FailureReason":{ - "shape":"String", - "documentation":"

if the overall status is Failed, the reason for the failure.

" - } - }, - "documentation":"

Represents the overall status of a model package.

" - }, - "ModelPackageStatusItemList":{ - "type":"list", - "member":{"shape":"ModelPackageStatusItem"} - }, - "ModelPackageSummaries":{ - "type":"map", - "key":{"shape":"ModelPackageArn"}, - "value":{"shape":"BatchDescribeModelPackageSummary"} - }, - "ModelPackageSummary":{ - "type":"structure", - "required":[ - "ModelPackageArn", - "CreationTime", - "ModelPackageStatus" - ], - "members":{ - "ModelPackageName":{ - "shape":"EntityName", - "documentation":"

The name of the model package.

" - }, - "ModelPackageGroupName":{ - "shape":"EntityName", - "documentation":"

If the model package is a versioned model, the model group that the versioned model belongs to.

" - }, - "ModelPackageVersion":{ - "shape":"ModelPackageVersion", - "documentation":"

If the model package is a versioned model, the version of the model.

" - }, - "ModelPackageArn":{ - "shape":"ModelPackageArn", - "documentation":"

The Amazon Resource Name (ARN) of the model package.

" - }, - "ModelPackageDescription":{ - "shape":"EntityDescription", - "documentation":"

A brief description of the model package.

" - }, - "CreationTime":{ - "shape":"CreationTime", - "documentation":"

A timestamp that shows when the model package was created.

" - }, - "ModelPackageStatus":{ - "shape":"ModelPackageStatus", - "documentation":"

The overall status of the model package.

" - }, - "ModelApprovalStatus":{ - "shape":"ModelApprovalStatus", - "documentation":"

The approval status of the model. This can be one of the following values.

  • APPROVED - The model is approved

  • REJECTED - The model is rejected.

  • PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.

" - }, - "ModelLifeCycle":{"shape":"ModelLifeCycle"}, - "ModelPackageRegistrationType":{ - "shape":"ModelPackageRegistrationType", - "documentation":"

The package registration type of the model package summary.

" - } - }, - "documentation":"

Provides summary information about a model package.

" - }, - "ModelPackageSummaryList":{ - "type":"list", - "member":{"shape":"ModelPackageSummary"} - }, - "ModelPackageType":{ - "type":"string", - "enum":[ - "Versioned", - "Unversioned", - "Both" - ] - }, - "ModelPackageValidationProfile":{ - "type":"structure", - "required":[ - "ProfileName", - "TransformJobDefinition" - ], - "members":{ - "ProfileName":{ - "shape":"EntityName", - "documentation":"

The name of the profile for the model package.

" - }, - "TransformJobDefinition":{ - "shape":"TransformJobDefinition", - "documentation":"

The TransformJobDefinition object that describes the transform job used for the validation of the model package.

" - } - }, - "documentation":"

Contains data, such as the inputs and targeted instance types that are used in the process of validating the model package.

The data provided in the validation profile is made available to your buyers on Amazon Web Services Marketplace.

" - }, - "ModelPackageValidationProfiles":{ - "type":"list", - "member":{"shape":"ModelPackageValidationProfile"}, - "max":1, - "min":0 - }, - "ModelPackageValidationSpecification":{ - "type":"structure", - "required":[ - "ValidationRole", - "ValidationProfiles" - ], - "members":{ - "ValidationRole":{ - "shape":"RoleArn", - "documentation":"

The IAM roles to be used for the validation of the model package.

" - }, - "ValidationProfiles":{ - "shape":"ModelPackageValidationProfiles", - "documentation":"

An array of ModelPackageValidationProfile objects, each of which specifies a batch transform job that SageMaker runs to validate your model package.

" - } - }, - "documentation":"

Specifies batch transform jobs that SageMaker runs to validate your model package.

" - }, - "ModelPackageVersion":{ - "type":"integer", - "box":true, - "min":1 - }, - "ModelQuality":{ - "type":"structure", - "members":{ - "Statistics":{ - "shape":"MetricsSource", - "documentation":"

Model quality statistics.

" - }, - "Constraints":{ - "shape":"MetricsSource", - "documentation":"

Model quality constraints.

" - } - }, - "documentation":"

Model quality statistics and constraints.

" - }, - "ModelQualityAppSpecification":{ - "type":"structure", - "required":["ImageUri"], - "members":{ - "ImageUri":{ - "shape":"ImageUri", - "documentation":"

The address of the container image that the monitoring job runs.

" - }, - "ContainerEntrypoint":{ - "shape":"ContainerEntrypoint", - "documentation":"

Specifies the entrypoint for a container that the monitoring job runs.

" - }, - "ContainerArguments":{ - "shape":"MonitoringContainerArguments", - "documentation":"

An array of arguments for the container used to run the monitoring job.

" - }, - "RecordPreprocessorSourceUri":{ - "shape":"S3Uri", - "documentation":"

An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flattened JSON so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.

" - }, - "PostAnalyticsProcessorSourceUri":{ - "shape":"S3Uri", - "documentation":"

An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.

" - }, - "ProblemType":{ - "shape":"MonitoringProblemType", - "documentation":"

The machine learning problem type of the model that the monitoring job monitors.

" - }, - "Environment":{ - "shape":"MonitoringEnvironmentMap", - "documentation":"

Sets the environment variables in the container that the monitoring job runs.

" - } - }, - "documentation":"

Container image configuration object for the monitoring job.

" - }, - "ModelQualityBaselineConfig":{ - "type":"structure", - "members":{ - "BaseliningJobName":{ - "shape":"ProcessingJobName", - "documentation":"

The name of the job that performs baselining for the monitoring job.

" - }, - "ConstraintsResource":{"shape":"MonitoringConstraintsResource"} - }, - "documentation":"

Configuration for monitoring constraints and monitoring statistics. These baseline resources are compared against the results of the current job from the series of jobs scheduled to collect data periodically.

" - }, - "ModelQualityJobInput":{ - "type":"structure", - "required":["GroundTruthS3Input"], - "members":{ - "EndpointInput":{"shape":"EndpointInput"}, - "BatchTransformInput":{ - "shape":"BatchTransformInput", - "documentation":"

Input object for the batch transform job.

" - }, - "GroundTruthS3Input":{ - "shape":"MonitoringGroundTruthS3Input", - "documentation":"

The ground truth label provided for the model.

" - } - }, - "documentation":"

The input for the model quality monitoring job. Currently endpoints are supported for input for model quality monitoring jobs.

" - }, - "ModelQuantizationConfig":{ - "type":"structure", - "members":{ - "Image":{ - "shape":"OptimizationContainerImage", - "documentation":"

The URI of an LMI DLC in Amazon ECR. SageMaker uses this image to run the optimization.

" - }, - "OverrideEnvironment":{ - "shape":"OptimizationJobEnvironmentVariables", - "documentation":"

Environment variables that override the default ones in the model container.

" - } - }, - "documentation":"

Settings for the model quantization technique that's applied by a model optimization job.

" - }, - "ModelRegisterSettings":{ - "type":"structure", - "members":{ - "Status":{ - "shape":"FeatureStatus", - "documentation":"

Describes whether the integration to the model registry is enabled or disabled in the Canvas application.

" - }, - "CrossAccountModelRegisterRoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the SageMaker model registry account. Required only to register model versions created by a different SageMaker Canvas Amazon Web Services account than the Amazon Web Services account in which SageMaker model registry is set up.

" - } - }, - "documentation":"

The model registry settings for the SageMaker Canvas application.

" - }, - "ModelRegistrationMode":{ - "type":"string", - "enum":[ - "AutoModelRegistrationEnabled", - "AutoModelRegistrationDisabled" - ] - }, - "ModelSetupTime":{ - "type":"integer", - "box":true, - "min":0 - }, - "ModelShardingConfig":{ - "type":"structure", - "members":{ - "Image":{ - "shape":"OptimizationContainerImage", - "documentation":"

The URI of an LMI DLC in Amazon ECR. SageMaker uses this image to run the optimization.

" - }, - "OverrideEnvironment":{ - "shape":"OptimizationJobEnvironmentVariables", - "documentation":"

Environment variables that override the default ones in the model container.

" - } - }, - "documentation":"

Settings for the model sharding technique that's applied by a model optimization job.

" - }, - "ModelSortKey":{ - "type":"string", - "enum":[ - "Name", - "CreationTime" - ] - }, - "ModelSpeculativeDecodingConfig":{ - "type":"structure", - "required":["Technique"], - "members":{ - "Technique":{ - "shape":"ModelSpeculativeDecodingTechnique", - "documentation":"

The speculative decoding technique to apply during model optimization.

" - }, - "TrainingDataSource":{ - "shape":"ModelSpeculativeDecodingTrainingDataSource", - "documentation":"

The location of the training data to use for speculative decoding. The data must be formatted as ShareGPT, OpenAI Completions or OpenAI Chat Completions. The input can also be unencrypted captured data from a SageMaker endpoint as long as the endpoint uses one of the above formats.

" - } - }, - "documentation":"

Settings for the model speculative decoding technique that's applied by a model optimization job.

" - }, - "ModelSpeculativeDecodingS3DataType":{ - "type":"string", - "enum":[ - "S3Prefix", - "ManifestFile" - ] - }, - "ModelSpeculativeDecodingTechnique":{ - "type":"string", - "enum":["EAGLE"] - }, - "ModelSpeculativeDecodingTrainingDataSource":{ - "type":"structure", - "required":[ - "S3Uri", - "S3DataType" - ], - "members":{ - "S3Uri":{ - "shape":"S3Uri", - "documentation":"

The Amazon S3 URI that points to the training data for speculative decoding.

" - }, - "S3DataType":{ - "shape":"ModelSpeculativeDecodingS3DataType", - "documentation":"

The type of data stored in the Amazon S3 location. Valid values are S3Prefix or ManifestFile.

" - } - }, - "documentation":"

Contains information about the training data source for speculative decoding.

" - }, - "ModelStepMetadata":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"String256", - "documentation":"

The Amazon Resource Name (ARN) of the created model.

" - } - }, - "documentation":"

Metadata for Model steps.

" - }, - "ModelSummary":{ - "type":"structure", - "required":[ - "ModelName", - "ModelArn", - "CreationTime" - ], - "members":{ - "ModelName":{ - "shape":"ModelName", - "documentation":"

The name of the model that you want a summary for.

" - }, - "ModelArn":{ - "shape":"ModelArn", - "documentation":"

The Amazon Resource Name (ARN) of the model.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that indicates when the model was created.

" - } - }, - "documentation":"

Provides summary information about a model.

" - }, - "ModelSummaryList":{ - "type":"list", - "member":{"shape":"ModelSummary"} - }, - "ModelVariantAction":{ - "type":"string", - "enum":[ - "Retain", - "Remove", - "Promote" - ] - }, - "ModelVariantActionMap":{ - "type":"map", - "key":{"shape":"ModelVariantName"}, - "value":{"shape":"ModelVariantAction"}, - "max":2, - "min":1 - }, - "ModelVariantConfig":{ - "type":"structure", - "required":[ - "ModelName", - "VariantName", - "InfrastructureConfig" - ], - "members":{ - "ModelName":{ - "shape":"ModelName", - "documentation":"

The name of the Amazon SageMaker Model entity.

" - }, - "VariantName":{ - "shape":"ModelVariantName", - "documentation":"

The name of the variant.

" - }, - "InfrastructureConfig":{ - "shape":"ModelInfrastructureConfig", - "documentation":"

The configuration for the infrastructure that the model will be deployed to.

" - } - }, - "documentation":"

Contains information about the deployment options of a model.

" - }, - "ModelVariantConfigList":{ - "type":"list", - "member":{"shape":"ModelVariantConfig"}, - "max":2, - "min":1 - }, - "ModelVariantConfigSummary":{ - "type":"structure", - "required":[ - "ModelName", - "VariantName", - "InfrastructureConfig", - "Status" - ], - "members":{ - "ModelName":{ - "shape":"ModelName", - "documentation":"

The name of the Amazon SageMaker Model entity.

" - }, - "VariantName":{ - "shape":"ModelVariantName", - "documentation":"

The name of the variant.

" - }, - "InfrastructureConfig":{ - "shape":"ModelInfrastructureConfig", - "documentation":"

The configuration of the infrastructure that the model has been deployed to.

" - }, - "Status":{ - "shape":"ModelVariantStatus", - "documentation":"

The status of deployment for the model variant on the hosted inference endpoint.

  • Creating - Amazon SageMaker is preparing the model variant on the hosted inference endpoint.

  • InService - The model variant is running on the hosted inference endpoint.

  • Updating - Amazon SageMaker is updating the model variant on the hosted inference endpoint.

  • Deleting - Amazon SageMaker is deleting the model variant on the hosted inference endpoint.

  • Deleted - The model variant has been deleted on the hosted inference endpoint. This can only happen after stopping the experiment.

" - } - }, - "documentation":"

Summary of the deployment configuration of a model.

" - }, - "ModelVariantConfigSummaryList":{ - "type":"list", - "member":{"shape":"ModelVariantConfigSummary"} - }, - "ModelVariantName":{ - "type":"string", - "max":63, - "min":0, - "pattern":"[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?" - }, - "ModelVariantStatus":{ - "type":"string", - "enum":[ - "Creating", - "Updating", - "InService", - "Deleting", - "Deleted" - ] - }, - "MonitoringAlertActions":{ - "type":"structure", - "members":{ - "ModelDashboardIndicator":{ - "shape":"ModelDashboardIndicatorAction", - "documentation":"

An alert action taken to light up an icon on the Model Dashboard when an alert goes into InAlert status.

" - } - }, - "documentation":"

A list of alert actions taken in response to an alert going into InAlert status.

" - }, - "MonitoringAlertHistoryList":{ - "type":"list", - "member":{"shape":"MonitoringAlertHistorySummary"} - }, - "MonitoringAlertHistorySortKey":{ - "type":"string", - "enum":[ - "CreationTime", - "Status" - ] - }, - "MonitoringAlertHistorySummary":{ - "type":"structure", - "required":[ - "MonitoringScheduleName", - "MonitoringAlertName", - "CreationTime", - "AlertStatus" - ], - "members":{ - "MonitoringScheduleName":{ - "shape":"MonitoringScheduleName", - "documentation":"

The name of a monitoring schedule.

" - }, - "MonitoringAlertName":{ - "shape":"MonitoringAlertName", - "documentation":"

The name of a monitoring alert.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that indicates when the first alert transition occurred in an alert history. An alert transition can be from status InAlert to OK, or from OK to InAlert.

" - }, - "AlertStatus":{ - "shape":"MonitoringAlertStatus", - "documentation":"

The current alert status of an alert.

" - } - }, - "documentation":"

Provides summary information of an alert's history.

" - }, - "MonitoringAlertName":{ - "type":"string", - "max":63, - "min":1, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" - }, - "MonitoringAlertStatus":{ - "type":"string", - "enum":[ - "InAlert", - "OK" - ] - }, - "MonitoringAlertSummary":{ - "type":"structure", - "required":[ - "MonitoringAlertName", - "CreationTime", - "LastModifiedTime", - "AlertStatus", - "DatapointsToAlert", - "EvaluationPeriod", - "Actions" - ], - "members":{ - "MonitoringAlertName":{ - "shape":"MonitoringAlertName", - "documentation":"

The name of a monitoring alert.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that indicates when a monitor alert was created.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that indicates when a monitor alert was last updated.

" - }, - "AlertStatus":{ - "shape":"MonitoringAlertStatus", - "documentation":"

The current status of an alert.

" - }, - "DatapointsToAlert":{ - "shape":"MonitoringDatapointsToAlert", - "documentation":"

Within EvaluationPeriod, how many execution failures will raise an alert.

" - }, - "EvaluationPeriod":{ - "shape":"MonitoringEvaluationPeriod", - "documentation":"

The number of most recent monitoring executions to consider when evaluating alert status.

" - }, - "Actions":{ - "shape":"MonitoringAlertActions", - "documentation":"

A list of alert actions taken in response to an alert going into InAlert status.

" - } - }, - "documentation":"

Provides summary information about a monitor alert.

" - }, - "MonitoringAlertSummaryList":{ - "type":"list", - "member":{"shape":"MonitoringAlertSummary"}, - "max":100, - "min":1 - }, - "MonitoringAppSpecification":{ - "type":"structure", - "required":["ImageUri"], - "members":{ - "ImageUri":{ - "shape":"ImageUri", - "documentation":"

The container image to be run by the monitoring job.

" - }, - "ContainerEntrypoint":{ - "shape":"ContainerEntrypoint", - "documentation":"

Specifies the entrypoint for a container used to run the monitoring job.

" - }, - "ContainerArguments":{ - "shape":"MonitoringContainerArguments", - "documentation":"

An array of arguments for the container used to run the monitoring job.

" - }, - "RecordPreprocessorSourceUri":{ - "shape":"S3Uri", - "documentation":"

An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flattened JSON so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.

" - }, - "PostAnalyticsProcessorSourceUri":{ - "shape":"S3Uri", - "documentation":"

An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.

" - } - }, - "documentation":"

Container image configuration object for the monitoring job.

" - }, - "MonitoringBaselineConfig":{ - "type":"structure", - "members":{ - "BaseliningJobName":{ - "shape":"ProcessingJobName", - "documentation":"

The name of the job that performs baselining for the monitoring job.

" - }, - "ConstraintsResource":{ - "shape":"MonitoringConstraintsResource", - "documentation":"

The baseline constraint file in Amazon S3 that the current monitoring job should validated against.

" - }, - "StatisticsResource":{ - "shape":"MonitoringStatisticsResource", - "documentation":"

The baseline statistics file in Amazon S3 that the current monitoring job should be validated against.

" - } - }, - "documentation":"

Configuration for monitoring constraints and monitoring statistics. These baseline resources are compared against the results of the current job from the series of jobs scheduled to collect data periodically.

" - }, - "MonitoringClusterConfig":{ - "type":"structure", - "required":[ - "InstanceCount", - "InstanceType", - "VolumeSizeInGB" - ], - "members":{ - "InstanceCount":{ - "shape":"ProcessingInstanceCount", - "documentation":"

The number of ML compute instances to use in the model monitoring job. For distributed processing jobs, specify a value greater than 1. The default value is 1.

" - }, - "InstanceType":{ - "shape":"ProcessingInstanceType", - "documentation":"

The ML compute instance type for the processing job.

" - }, - "VolumeSizeInGB":{ - "shape":"ProcessingVolumeSizeInGB", - "documentation":"

The size of the ML storage volume, in gigabytes, that you want to provision. You must specify sufficient ML storage for your scenario.

" - }, - "VolumeKmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The Key Management Service (KMS) key that Amazon SageMaker AI uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the model monitoring job.

" - } - }, - "documentation":"

Configuration for the cluster used to run model monitoring jobs.

" - }, - "MonitoringConstraintsResource":{ - "type":"structure", - "members":{ - "S3Uri":{ - "shape":"S3Uri", - "documentation":"

The Amazon S3 URI for the constraints resource.

" - } - }, - "documentation":"

The constraints resource for a monitoring job.

" - }, - "MonitoringContainerArguments":{ - "type":"list", - "member":{"shape":"ContainerArgument"}, - "max":50, - "min":1 - }, - "MonitoringCsvDatasetFormat":{ - "type":"structure", - "members":{ - "Header":{ - "shape":"Boolean", - "documentation":"

Indicates if the CSV data has a header.

", - "box":true - } - }, - "documentation":"

Represents the CSV dataset format used when running a monitoring job.

" - }, - "MonitoringDatapointsToAlert":{ - "type":"integer", - "box":true, - "max":100, - "min":1 - }, - "MonitoringDatasetFormat":{ - "type":"structure", - "members":{ - "Csv":{ - "shape":"MonitoringCsvDatasetFormat", - "documentation":"

The CSV dataset used in the monitoring job.

" - }, - "Json":{ - "shape":"MonitoringJsonDatasetFormat", - "documentation":"

The JSON dataset used in the monitoring job

" - }, - "Parquet":{ - "shape":"MonitoringParquetDatasetFormat", - "documentation":"

The Parquet dataset used in the monitoring job

" - } - }, - "documentation":"

Represents the dataset format used when running a monitoring job.

" - }, - "MonitoringEnvironmentMap":{ - "type":"map", - "key":{"shape":"ProcessingEnvironmentKey"}, - "value":{"shape":"ProcessingEnvironmentValue"}, - "max":50, - "min":0 - }, - "MonitoringEvaluationPeriod":{ - "type":"integer", - "box":true, - "max":100, - "min":1 - }, - "MonitoringExecutionSortKey":{ - "type":"string", - "enum":[ - "CreationTime", - "ScheduledTime", - "Status" - ] - }, - "MonitoringExecutionSummary":{ - "type":"structure", - "required":[ - "MonitoringScheduleName", - "ScheduledTime", - "CreationTime", - "LastModifiedTime", - "MonitoringExecutionStatus" - ], - "members":{ - "MonitoringScheduleName":{ - "shape":"MonitoringScheduleName", - "documentation":"

The name of the monitoring schedule.

" - }, - "ScheduledTime":{ - "shape":"Timestamp", - "documentation":"

The time the monitoring job was scheduled.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The time at which the monitoring job was created.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that indicates the last time the monitoring job was modified.

" - }, - "MonitoringExecutionStatus":{ - "shape":"ExecutionStatus", - "documentation":"

The status of the monitoring job.

" - }, - "ProcessingJobArn":{ - "shape":"ProcessingJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the monitoring job.

" - }, - "EndpointName":{ - "shape":"EndpointName", - "documentation":"

The name of the endpoint used to run the monitoring job.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

Contains the reason a monitoring job failed, if it failed.

" - }, - "MonitoringJobDefinitionName":{ - "shape":"MonitoringJobDefinitionName", - "documentation":"

The name of the monitoring job.

" - }, - "MonitoringType":{ - "shape":"MonitoringType", - "documentation":"

The type of the monitoring job.

" - } - }, - "documentation":"

Summary of information about the last monitoring job to run.

" - }, - "MonitoringExecutionSummaryList":{ - "type":"list", - "member":{"shape":"MonitoringExecutionSummary"} - }, - "MonitoringGroundTruthS3Input":{ - "type":"structure", - "members":{ - "S3Uri":{ - "shape":"MonitoringS3Uri", - "documentation":"

The address of the Amazon S3 location of the ground truth labels.

" - } - }, - "documentation":"

The ground truth labels for the dataset used for the monitoring job.

" - }, - "MonitoringInput":{ - "type":"structure", - "members":{ - "EndpointInput":{ - "shape":"EndpointInput", - "documentation":"

The endpoint for a monitoring job.

" - }, - "BatchTransformInput":{ - "shape":"BatchTransformInput", - "documentation":"

Input object for the batch transform job.

" - } - }, - "documentation":"

The inputs for a monitoring job.

" - }, - "MonitoringInputs":{ - "type":"list", - "member":{"shape":"MonitoringInput"}, - "max":1, - "min":1 - }, - "MonitoringJobDefinition":{ - "type":"structure", - "required":[ - "MonitoringInputs", - "MonitoringOutputConfig", - "MonitoringResources", - "MonitoringAppSpecification", - "RoleArn" - ], - "members":{ - "BaselineConfig":{ - "shape":"MonitoringBaselineConfig", - "documentation":"

Baseline configuration used to validate that the data conforms to the specified constraints and statistics

" - }, - "MonitoringInputs":{ - "shape":"MonitoringInputs", - "documentation":"

The array of inputs for the monitoring job. Currently we support monitoring an Amazon SageMaker AI Endpoint.

" - }, - "MonitoringOutputConfig":{ - "shape":"MonitoringOutputConfig", - "documentation":"

The array of outputs from the monitoring job to be uploaded to Amazon S3.

" - }, - "MonitoringResources":{ - "shape":"MonitoringResources", - "documentation":"

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a monitoring job. In distributed processing, you specify more than one instance.

" - }, - "MonitoringAppSpecification":{ - "shape":"MonitoringAppSpecification", - "documentation":"

Configures the monitoring job to run a specified Docker container image.

" - }, - "StoppingCondition":{ - "shape":"MonitoringStoppingCondition", - "documentation":"

Specifies a time limit for how long the monitoring job is allowed to run.

" - }, - "Environment":{ - "shape":"MonitoringEnvironmentMap", - "documentation":"

Sets the environment variables in the Docker container.

" - }, - "NetworkConfig":{ - "shape":"NetworkConfig", - "documentation":"

Specifies networking options for an monitoring job.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.

" - } - }, - "documentation":"

Defines the monitoring job.

" - }, - "MonitoringJobDefinitionArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":".*" - }, - "MonitoringJobDefinitionName":{ - "type":"string", - "max":63, - "min":1, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" - }, - "MonitoringJobDefinitionSortKey":{ - "type":"string", - "enum":[ - "Name", - "CreationTime" - ] - }, - "MonitoringJobDefinitionSummary":{ - "type":"structure", - "required":[ - "MonitoringJobDefinitionName", - "MonitoringJobDefinitionArn", - "CreationTime", - "EndpointName" - ], - "members":{ - "MonitoringJobDefinitionName":{ - "shape":"MonitoringJobDefinitionName", - "documentation":"

The name of the monitoring job.

" - }, - "MonitoringJobDefinitionArn":{ - "shape":"MonitoringJobDefinitionArn", - "documentation":"

The Amazon Resource Name (ARN) of the monitoring job.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The time that the monitoring job was created.

" - }, - "EndpointName":{ - "shape":"EndpointName", - "documentation":"

The name of the endpoint that the job monitors.

" - } - }, - "documentation":"

Summary information about a monitoring job.

" - }, - "MonitoringJobDefinitionSummaryList":{ - "type":"list", - "member":{"shape":"MonitoringJobDefinitionSummary"} - }, - "MonitoringJsonDatasetFormat":{ - "type":"structure", - "members":{ - "Line":{ - "shape":"Boolean", - "documentation":"

Indicates if the file should be read as a JSON object per line.

", - "box":true - } - }, - "documentation":"

Represents the JSON dataset format used when running a monitoring job.

" - }, - "MonitoringMaxRuntimeInSeconds":{ - "type":"integer", - "max":86400, - "min":1 - }, - "MonitoringNetworkConfig":{ - "type":"structure", - "members":{ - "EnableInterContainerTrafficEncryption":{ - "shape":"Boolean", - "documentation":"

Whether to encrypt all communications between the instances used for the monitoring jobs. Choose True to encrypt communications. Encryption provides greater security for distributed jobs, but the processing might take longer.

", - "box":true - }, - "EnableNetworkIsolation":{ - "shape":"Boolean", - "documentation":"

Whether to allow inbound and outbound network calls to and from the containers used for the monitoring job.

", - "box":true - }, - "VpcConfig":{"shape":"VpcConfig"} - }, - "documentation":"

The networking configuration for the monitoring job.

" - }, - "MonitoringOutput":{ - "type":"structure", - "required":["S3Output"], - "members":{ - "S3Output":{ - "shape":"MonitoringS3Output", - "documentation":"

The Amazon S3 storage location where the results of a monitoring job are saved.

" - } - }, - "documentation":"

The output object for a monitoring job.

" - }, - "MonitoringOutputConfig":{ - "type":"structure", - "required":["MonitoringOutputs"], - "members":{ - "MonitoringOutputs":{ - "shape":"MonitoringOutputs", - "documentation":"

Monitoring outputs for monitoring jobs. This is where the output of the periodic monitoring jobs is uploaded.

" - }, - "KmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The Key Management Service (KMS) key that Amazon SageMaker AI uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.

" - } - }, - "documentation":"

The output configuration for monitoring jobs.

" - }, - "MonitoringOutputs":{ - "type":"list", - "member":{"shape":"MonitoringOutput"}, - "max":1, - "min":1 - }, - "MonitoringParquetDatasetFormat":{ - "type":"structure", - "members":{}, - "documentation":"

Represents the Parquet dataset format used when running a monitoring job.

" - }, - "MonitoringProblemType":{ - "type":"string", - "enum":[ - "BinaryClassification", - "MulticlassClassification", - "Regression" - ] - }, - "MonitoringResources":{ - "type":"structure", - "required":["ClusterConfig"], - "members":{ - "ClusterConfig":{ - "shape":"MonitoringClusterConfig", - "documentation":"

The configuration for the cluster resources used to run the processing job.

" - } - }, - "documentation":"

Identifies the resources to deploy for a monitoring job.

" - }, - "MonitoringS3Output":{ - "type":"structure", - "required":[ - "S3Uri", - "LocalPath" - ], - "members":{ - "S3Uri":{ - "shape":"MonitoringS3Uri", - "documentation":"

A URI that identifies the Amazon S3 storage location where Amazon SageMaker AI saves the results of a monitoring job.

" - }, - "LocalPath":{ - "shape":"ProcessingLocalPath", - "documentation":"

The local path to the Amazon S3 storage location where Amazon SageMaker AI saves the results of a monitoring job. LocalPath is an absolute path for the output data.

" - }, - "S3UploadMode":{ - "shape":"ProcessingS3UploadMode", - "documentation":"

Whether to upload the results of the monitoring job continuously or after the job completes.

" - } - }, - "documentation":"

Information about where and how you want to store the results of a monitoring job.

" - }, - "MonitoringS3Uri":{ - "type":"string", - "max":512, - "min":0, - "pattern":"(https|s3)://([^/]+)/?(.*)" - }, - "MonitoringSchedule":{ - "type":"structure", - "members":{ - "MonitoringScheduleArn":{ - "shape":"MonitoringScheduleArn", - "documentation":"

The Amazon Resource Name (ARN) of the monitoring schedule.

" - }, - "MonitoringScheduleName":{ - "shape":"MonitoringScheduleName", - "documentation":"

The name of the monitoring schedule.

" - }, - "MonitoringScheduleStatus":{ - "shape":"ScheduleStatus", - "documentation":"

The status of the monitoring schedule. This can be one of the following values.

  • PENDING - The schedule is pending being created.

  • FAILED - The schedule failed.

  • SCHEDULED - The schedule was successfully created.

  • STOPPED - The schedule was stopped.

" - }, - "MonitoringType":{ - "shape":"MonitoringType", - "documentation":"

The type of the monitoring job definition to schedule.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

If the monitoring schedule failed, the reason it failed.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The time that the monitoring schedule was created.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The last time the monitoring schedule was changed.

" - }, - "MonitoringScheduleConfig":{"shape":"MonitoringScheduleConfig"}, - "EndpointName":{ - "shape":"EndpointName", - "documentation":"

The endpoint that hosts the model being monitored.

" - }, - "LastMonitoringExecutionSummary":{"shape":"MonitoringExecutionSummary"}, - "Tags":{ - "shape":"TagList", - "documentation":"

A list of the tags associated with the monitoring schedlue. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

" - } - }, - "documentation":"

A schedule for a model monitoring job. For information about model monitor, see Amazon SageMaker Model Monitor.

" - }, - "MonitoringScheduleArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":".*" - }, - "MonitoringScheduleConfig":{ - "type":"structure", - "members":{ - "ScheduleConfig":{ - "shape":"ScheduleConfig", - "documentation":"

Configures the monitoring schedule.

" - }, - "MonitoringJobDefinition":{ - "shape":"MonitoringJobDefinition", - "documentation":"

Defines the monitoring job.

" - }, - "MonitoringJobDefinitionName":{ - "shape":"MonitoringJobDefinitionName", - "documentation":"

The name of the monitoring job definition to schedule.

" - }, - "MonitoringType":{ - "shape":"MonitoringType", - "documentation":"

The type of the monitoring job definition to schedule.

" - } - }, - "documentation":"

Configures the monitoring schedule and defines the monitoring job.

" - }, - "MonitoringScheduleList":{ - "type":"list", - "member":{"shape":"MonitoringSchedule"} - }, - "MonitoringScheduleName":{ - "type":"string", - "max":63, - "min":1, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" - }, - "MonitoringScheduleSortKey":{ - "type":"string", - "enum":[ - "Name", - "CreationTime", - "Status" - ] - }, - "MonitoringScheduleSummary":{ - "type":"structure", - "required":[ - "MonitoringScheduleName", - "MonitoringScheduleArn", - "CreationTime", - "LastModifiedTime", - "MonitoringScheduleStatus" - ], - "members":{ - "MonitoringScheduleName":{ - "shape":"MonitoringScheduleName", - "documentation":"

The name of the monitoring schedule.

" - }, - "MonitoringScheduleArn":{ - "shape":"MonitoringScheduleArn", - "documentation":"

The Amazon Resource Name (ARN) of the monitoring schedule.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The creation time of the monitoring schedule.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The last time the monitoring schedule was modified.

" - }, - "MonitoringScheduleStatus":{ - "shape":"ScheduleStatus", - "documentation":"

The status of the monitoring schedule.

" - }, - "EndpointName":{ - "shape":"EndpointName", - "documentation":"

The name of the endpoint using the monitoring schedule.

" - }, - "MonitoringJobDefinitionName":{ - "shape":"MonitoringJobDefinitionName", - "documentation":"

The name of the monitoring job definition that the schedule is for.

" - }, - "MonitoringType":{ - "shape":"MonitoringType", - "documentation":"

The type of the monitoring job definition that the schedule is for.

" - } - }, - "documentation":"

Summarizes the monitoring schedule.

" - }, - "MonitoringScheduleSummaryList":{ - "type":"list", - "member":{"shape":"MonitoringScheduleSummary"} - }, - "MonitoringStatisticsResource":{ - "type":"structure", - "members":{ - "S3Uri":{ - "shape":"S3Uri", - "documentation":"

The Amazon S3 URI for the statistics resource.

" - } - }, - "documentation":"

The statistics resource for a monitoring job.

" - }, - "MonitoringStoppingCondition":{ - "type":"structure", - "required":["MaxRuntimeInSeconds"], - "members":{ - "MaxRuntimeInSeconds":{ - "shape":"MonitoringMaxRuntimeInSeconds", - "documentation":"

The maximum runtime allowed in seconds.

The MaxRuntimeInSeconds cannot exceed the frequency of the job. For data quality and model explainability, this can be up to 3600 seconds for an hourly schedule. For model bias and model quality hourly schedules, this can be up to 1800 seconds.

", - "box":true - } - }, - "documentation":"

A time limit for how long the monitoring job is allowed to run before stopping.

" - }, - "MonitoringTimeOffsetString":{ - "type":"string", - "max":15, - "min":1, - "pattern":".?P.*" - }, - "MonitoringType":{ - "type":"string", - "enum":[ - "DataQuality", - "ModelQuality", - "ModelBias", - "ModelExplainability" - ] - }, - "MountPath":{ - "type":"string", - "max":1024, - "min":0, - "pattern":"\\/.*" - }, - "MultiModelConfig":{ - "type":"structure", - "members":{ - "ModelCacheSetting":{ - "shape":"ModelCacheSetting", - "documentation":"

Whether to cache models for a multi-model endpoint. By default, multi-model endpoints cache models so that a model does not have to be loaded into memory each time it is invoked. Some use cases do not benefit from model caching. For example, if an endpoint hosts a large number of models that are each invoked infrequently, the endpoint might perform better if you disable model caching. To disable model caching, set the value of this parameter to Disabled.

" - } - }, - "documentation":"

Specifies additional configuration for hosting multi-model endpoints.

" - }, - "NameContains":{ - "type":"string", - "max":63, - "min":0, - "pattern":"[a-zA-Z0-9\\-]+" - }, - "NeoVpcConfig":{ - "type":"structure", - "required":[ - "SecurityGroupIds", - "Subnets" - ], - "members":{ - "SecurityGroupIds":{ - "shape":"NeoVpcSecurityGroupIds", - "documentation":"

The VPC security group IDs. IDs have the form of sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.

" - }, - "Subnets":{ - "shape":"NeoVpcSubnets", - "documentation":"

The ID of the subnets in the VPC that you want to connect the compilation job to for accessing the model in Amazon S3.

" - } - }, - "documentation":"

The VpcConfig configuration object that specifies the VPC that you want the compilation jobs to connect to. For more information on controlling access to your Amazon S3 buckets used for compilation job, see Give Amazon SageMaker AI Compilation Jobs Access to Resources in Your Amazon VPC.

" - }, - "NeoVpcSecurityGroupId":{ - "type":"string", - "max":32, - "min":0, - "pattern":"[-0-9a-zA-Z]+" - }, - "NeoVpcSecurityGroupIds":{ - "type":"list", - "member":{"shape":"NeoVpcSecurityGroupId"}, - "max":5, - "min":1 - }, - "NeoVpcSubnetId":{ - "type":"string", - "max":32, - "min":0, - "pattern":"[-0-9a-zA-Z]+" - }, - "NeoVpcSubnets":{ - "type":"list", - "member":{"shape":"NeoVpcSubnetId"}, - "max":16, - "min":1 - }, - "NestedFilters":{ - "type":"structure", - "required":[ - "NestedPropertyName", - "Filters" - ], - "members":{ - "NestedPropertyName":{ - "shape":"ResourcePropertyName", - "documentation":"

The name of the property to use in the nested filters. The value must match a listed property name, such as InputDataConfig.

" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"

A list of filters. Each filter acts on a property. Filters must contain at least one Filters value. For example, a NestedFilters call might include a filter on the PropertyName parameter of the InputDataConfig property: InputDataConfig.DataSource.S3DataSource.S3Uri.

" - } - }, - "documentation":"

A list of nested Filter objects. A resource must satisfy the conditions of all filters to be included in the results returned from the Search API.

For example, to filter on a training job's InputDataConfig property with a specific channel name and S3Uri prefix, define the following filters:

  • '{Name:\"InputDataConfig.ChannelName\", \"Operator\":\"Equals\", \"Value\":\"train\"}',

  • '{Name:\"InputDataConfig.DataSource.S3DataSource.S3Uri\", \"Operator\":\"Contains\", \"Value\":\"mybucket/catdata\"}'

" - }, - "NestedFiltersList":{ - "type":"list", - "member":{"shape":"NestedFilters"}, - "max":20, - "min":1 - }, - "NetworkConfig":{ - "type":"structure", - "members":{ - "EnableInterContainerTrafficEncryption":{ - "shape":"Boolean", - "documentation":"

Whether to encrypt all communications between distributed processing jobs. Choose True to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer.

", - "box":true - }, - "EnableNetworkIsolation":{ - "shape":"Boolean", - "documentation":"

Whether to allow inbound and outbound network calls to and from the containers used for the processing job.

", - "box":true - }, - "VpcConfig":{"shape":"VpcConfig"} - }, - "documentation":"

Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.

" - }, - "NetworkInterfaceId":{"type":"string"}, - "NextToken":{ - "type":"string", - "max":8192, - "min":0, - "pattern":".*" - }, - "NodeAdditionResult":{ - "type":"structure", - "required":[ - "NodeLogicalId", - "InstanceGroupName", - "Status" - ], - "members":{ - "NodeLogicalId":{ - "shape":"ClusterNodeLogicalId", - "documentation":"

A unique identifier assigned to the node that can be used to track its provisioning status through the DescribeClusterNode operation.

" - }, - "InstanceGroupName":{ - "shape":"ClusterInstanceGroupName", - "documentation":"

The name of the instance group to which the node was added.

" - }, - "Status":{ - "shape":"ClusterInstanceStatus", - "documentation":"

The current status of the node. Possible values include Pending, Running, Failed, ShuttingDown, SystemUpdating, DeepHealthCheckInProgress, and NotFound.

" - }, - "AvailabilityZones":{ - "shape":"ClusterAvailabilityZones", - "documentation":"

The availability zones associated with the successfully added node.

" - }, - "InstanceTypes":{ - "shape":"ClusterInstanceTypes", - "documentation":"

The instance types associated with the successfully added node.

" - } - }, - "documentation":"

Information about a node that was successfully added to the cluster.

" - }, - "NodeAdditionResultList":{ - "type":"list", - "member":{"shape":"NodeAdditionResult"} - }, - "NodeUnavailabilityType":{ - "type":"string", - "enum":[ - "INSTANCE_COUNT", - "CAPACITY_PERCENTAGE" - ] - }, - "NodeUnavailabilityValue":{ - "type":"integer", - "box":true, - "min":1 - }, - "NonEmptyString256":{ - "type":"string", - "max":256, - "min":0, - "pattern":"(?!\\s*$).+" - }, - "NonEmptyString64":{ - "type":"string", - "max":64, - "min":0, - "pattern":"(?!\\s*$).+" - }, - "NotebookInstanceAcceleratorType":{ - "type":"string", - "enum":[ - "ml.eia1.medium", - "ml.eia1.large", - "ml.eia1.xlarge", - "ml.eia2.medium", - "ml.eia2.large", - "ml.eia2.xlarge" - ] - }, - "NotebookInstanceAcceleratorTypes":{ - "type":"list", - "member":{"shape":"NotebookInstanceAcceleratorType"} - }, - "NotebookInstanceArn":{ - "type":"string", - "max":256, - "min":0 - }, - "NotebookInstanceLifecycleConfigArn":{ - "type":"string", - "max":256, - "min":0 - }, - "NotebookInstanceLifecycleConfigContent":{ - "type":"string", - "max":16384, - "min":1, - "pattern":"[\\S\\s]+" - }, - "NotebookInstanceLifecycleConfigList":{ - "type":"list", - "member":{"shape":"NotebookInstanceLifecycleHook"}, - "max":1, - "min":0 - }, - "NotebookInstanceLifecycleConfigName":{ - "type":"string", - "max":63, - "min":0, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9])*" - }, - "NotebookInstanceLifecycleConfigNameContains":{ - "type":"string", - "max":63, - "min":0, - "pattern":"[a-zA-Z0-9-]+" - }, - "NotebookInstanceLifecycleConfigSortKey":{ - "type":"string", - "enum":[ - "Name", - "CreationTime", - "LastModifiedTime" - ] - }, - "NotebookInstanceLifecycleConfigSortOrder":{ - "type":"string", - "enum":[ - "Ascending", - "Descending" - ] - }, - "NotebookInstanceLifecycleConfigSummary":{ - "type":"structure", - "required":[ - "NotebookInstanceLifecycleConfigName", - "NotebookInstanceLifecycleConfigArn" - ], - "members":{ - "NotebookInstanceLifecycleConfigName":{ - "shape":"NotebookInstanceLifecycleConfigName", - "documentation":"

The name of the lifecycle configuration.

" - }, - "NotebookInstanceLifecycleConfigArn":{ - "shape":"NotebookInstanceLifecycleConfigArn", - "documentation":"

The Amazon Resource Name (ARN) of the lifecycle configuration.

" - }, - "CreationTime":{ - "shape":"CreationTime", - "documentation":"

A timestamp that tells when the lifecycle configuration was created.

" - }, - "LastModifiedTime":{ - "shape":"LastModifiedTime", - "documentation":"

A timestamp that tells when the lifecycle configuration was last modified.

" - } - }, - "documentation":"

Provides a summary of a notebook instance lifecycle configuration.

" - }, - "NotebookInstanceLifecycleConfigSummaryList":{ - "type":"list", - "member":{"shape":"NotebookInstanceLifecycleConfigSummary"} - }, - "NotebookInstanceLifecycleHook":{ - "type":"structure", - "members":{ - "Content":{ - "shape":"NotebookInstanceLifecycleConfigContent", - "documentation":"

A base64-encoded string that contains a shell script for a notebook instance lifecycle configuration.

" - } - }, - "documentation":"

Contains the notebook instance lifecycle configuration script.

Each lifecycle configuration script has a limit of 16384 characters.

The value of the $PATH environment variable that is available to both scripts is /sbin:bin:/usr/sbin:/usr/bin.

View Amazon CloudWatch Logs for notebook instance lifecycle configurations in log group /aws/sagemaker/NotebookInstances in log stream [notebook-instance-name]/[LifecycleConfigHook].

Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 minutes, it fails and the notebook instance is not created or started.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

" - }, - "NotebookInstanceName":{ - "type":"string", - "max":63, - "min":0, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9])*" - }, - "NotebookInstanceNameContains":{ - "type":"string", - "max":63, - "min":0, - "pattern":"[a-zA-Z0-9-]+" - }, - "NotebookInstanceSortKey":{ - "type":"string", - "enum":[ - "Name", - "CreationTime", - "Status" - ] - }, - "NotebookInstanceSortOrder":{ - "type":"string", - "enum":[ - "Ascending", - "Descending" - ] - }, - "NotebookInstanceStatus":{ - "type":"string", - "enum":[ - "Pending", - "InService", - "Stopping", - "Stopped", - "Failed", - "Deleting", - "Updating" - ] - }, - "NotebookInstanceSummary":{ - "type":"structure", - "required":[ - "NotebookInstanceName", - "NotebookInstanceArn" - ], - "members":{ - "NotebookInstanceName":{ - "shape":"NotebookInstanceName", - "documentation":"

The name of the notebook instance that you want a summary for.

" - }, - "NotebookInstanceArn":{ - "shape":"NotebookInstanceArn", - "documentation":"

The Amazon Resource Name (ARN) of the notebook instance.

" - }, - "NotebookInstanceStatus":{ - "shape":"NotebookInstanceStatus", - "documentation":"

The status of the notebook instance.

" - }, - "Url":{ - "shape":"NotebookInstanceUrl", - "documentation":"

The URL that you use to connect to the Jupyter notebook running in your notebook instance.

" - }, - "InstanceType":{ - "shape":"InstanceType", - "documentation":"

The type of ML compute instance that the notebook instance is running on.

" - }, - "CreationTime":{ - "shape":"CreationTime", - "documentation":"

A timestamp that shows when the notebook instance was created.

" - }, - "LastModifiedTime":{ - "shape":"LastModifiedTime", - "documentation":"

A timestamp that shows when the notebook instance was last modified.

" - }, - "NotebookInstanceLifecycleConfigName":{ - "shape":"NotebookInstanceLifecycleConfigName", - "documentation":"

The name of a notebook instance lifecycle configuration associated with this notebook instance.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

" - }, - "DefaultCodeRepository":{ - "shape":"CodeRepositoryNameOrUrl", - "documentation":"

The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker AI Notebook Instances.

" - }, - "AdditionalCodeRepositories":{ - "shape":"AdditionalCodeRepositoryNamesOrUrls", - "documentation":"

An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker AI Notebook Instances.

" - } - }, - "documentation":"

Provides summary information for an SageMaker AI notebook instance.

" - }, - "NotebookInstanceSummaryList":{ - "type":"list", - "member":{"shape":"NotebookInstanceSummary"} - }, - "NotebookInstanceUrl":{"type":"string"}, - "NotebookInstanceVolumeSizeInGB":{ - "type":"integer", - "box":true, - "max":16384, - "min":5 - }, - "NotebookOutputOption":{ - "type":"string", - "enum":[ - "Allowed", - "Disabled" - ] - }, - "NotificationConfiguration":{ - "type":"structure", - "members":{ - "NotificationTopicArn":{ - "shape":"NotificationTopicArn", - "documentation":"

The ARN for the Amazon SNS topic to which notifications should be published.

" - } - }, - "documentation":"

Configures Amazon SNS notifications of available or expiring work items for work teams.

" - }, - "NotificationTopicArn":{ - "type":"string", - "pattern":"arn:aws[a-z\\-]*:sns:[a-z0-9\\-]*:[0-9]{12}:[a-zA-Z0-9_.-]*" - }, - "NumberOfAcceleratorDevices":{ - "type":"float", - "box":true, - "min":1 - }, - "NumberOfCpuCores":{ - "type":"float", - "box":true, - "min":0.25 - }, - "NumberOfHumanWorkersPerDataObject":{ - "type":"integer", - "box":true, - "max":9, - "min":1 - }, - "NumberOfSteps":{ - "type":"integer", - "box":true, - "min":1 - }, - "ObjectiveStatus":{ - "type":"string", - "enum":[ - "Succeeded", - "Pending", - "Failed" - ] - }, - "ObjectiveStatusCounter":{ - "type":"integer", - "min":0 - }, - "ObjectiveStatusCounters":{ - "type":"structure", - "members":{ - "Succeeded":{ - "shape":"ObjectiveStatusCounter", - "documentation":"

The number of training jobs whose final objective metric was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.

", - "box":true - }, - "Pending":{ - "shape":"ObjectiveStatusCounter", - "documentation":"

The number of training jobs that are in progress and pending evaluation of their final objective metric.

", - "box":true - }, - "Failed":{ - "shape":"ObjectiveStatusCounter", - "documentation":"

The number of training jobs whose final objective metric was not evaluated and used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.

", - "box":true - } - }, - "documentation":"

Specifies the number of training jobs that this hyperparameter tuning job launched, categorized by the status of their objective metric. The objective metric status shows whether the final objective metric for the training job has been evaluated by the tuning job and used in the hyperparameter tuning process.

" - }, - "OfflineStoreConfig":{ - "type":"structure", - "required":["S3StorageConfig"], - "members":{ - "S3StorageConfig":{ - "shape":"S3StorageConfig", - "documentation":"

The Amazon Simple Storage (Amazon S3) location of OfflineStore.

" - }, - "DisableGlueTableCreation":{ - "shape":"Boolean", - "documentation":"

Set to True to disable the automatic creation of an Amazon Web Services Glue table when configuring an OfflineStore. If set to True and DataCatalogConfig is provided, Feature Store associates the provided catalog configuration with the feature group without creating a table. In this case, you are responsible for creating and managing the Glue table. If set to True without DataCatalogConfig, no Glue table is created or associated with the feature group. The Iceberg table format is only supported when this is set to False.

If set to False and DataCatalogConfig is provided, Feature Store creates the table using the specified names. If set to False without DataCatalogConfig, Feature Store auto-generates the table name following Athena's naming recommendations. This applies to both Glue and Apache Iceberg table formats.

The default value is False.

", - "box":true - }, - "DataCatalogConfig":{ - "shape":"DataCatalogConfig", - "documentation":"

The meta data of the Glue table for the OfflineStore. If not provided, Feature Store auto-generates the table name, database, and catalog when the OfflineStore is created. You can optionally provide this configuration to specify custom values. This applies to both Glue and Apache Iceberg table formats.

" - }, - "TableFormat":{ - "shape":"TableFormat", - "documentation":"

Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.

" - } - }, - "documentation":"

The configuration of an OfflineStore.

Provide an OfflineStoreConfig in a request to CreateFeatureGroup to create an OfflineStore.

To encrypt an OfflineStore using at rest data encryption, specify Amazon Web Services Key Management Service (KMS) key ID, or KMSKeyId, in S3StorageConfig.

" - }, - "OfflineStoreStatus":{ - "type":"structure", - "required":["Status"], - "members":{ - "Status":{ - "shape":"OfflineStoreStatusValue", - "documentation":"

An OfflineStore status.

" - }, - "BlockedReason":{ - "shape":"BlockedReason", - "documentation":"

The justification for why the OfflineStoreStatus is Blocked (if applicable).

" - } - }, - "documentation":"

The status of OfflineStore.

" - }, - "OfflineStoreStatusValue":{ - "type":"string", - "enum":[ - "Active", - "Blocked", - "Disabled" - ] - }, - "OidcConfig":{ - "type":"structure", - "required":[ - "ClientId", - "ClientSecret", - "Issuer", - "AuthorizationEndpoint", - "TokenEndpoint", - "UserInfoEndpoint", - "LogoutEndpoint", - "JwksUri" - ], - "members":{ - "ClientId":{ - "shape":"ClientId", - "documentation":"

The OIDC IdP client ID used to configure your private workforce.

" - }, - "ClientSecret":{ - "shape":"ClientSecret", - "documentation":"

The OIDC IdP client secret used to configure your private workforce.

" - }, - "Issuer":{ - "shape":"OidcEndpoint", - "documentation":"

The OIDC IdP issuer used to configure your private workforce.

" - }, - "AuthorizationEndpoint":{ - "shape":"OidcEndpoint", - "documentation":"

The OIDC IdP authorization endpoint used to configure your private workforce.

" - }, - "TokenEndpoint":{ - "shape":"OidcEndpoint", - "documentation":"

The OIDC IdP token endpoint used to configure your private workforce.

" - }, - "UserInfoEndpoint":{ - "shape":"OidcEndpoint", - "documentation":"

The OIDC IdP user information endpoint used to configure your private workforce.

" - }, - "LogoutEndpoint":{ - "shape":"OidcEndpoint", - "documentation":"

The OIDC IdP logout endpoint used to configure your private workforce.

" - }, - "JwksUri":{ - "shape":"OidcEndpoint", - "documentation":"

The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.

" - }, - "Scope":{ - "shape":"Scope", - "documentation":"

An array of string identifiers used to refer to the specific pieces of user data or claims that the client application wants to access.

" - }, - "AuthenticationRequestExtraParams":{ - "shape":"AuthenticationRequestExtraParams", - "documentation":"

A string to string map of identifiers specific to the custom identity provider (IdP) being used.

" - } - }, - "documentation":"

Use this parameter to configure your OIDC Identity Provider (IdP).

" - }, - "OidcConfigForResponse":{ - "type":"structure", - "members":{ - "ClientId":{ - "shape":"ClientId", - "documentation":"

The OIDC IdP client ID used to configure your private workforce.

" - }, - "Issuer":{ - "shape":"OidcEndpoint", - "documentation":"

The OIDC IdP issuer used to configure your private workforce.

" - }, - "AuthorizationEndpoint":{ - "shape":"OidcEndpoint", - "documentation":"

The OIDC IdP authorization endpoint used to configure your private workforce.

" - }, - "TokenEndpoint":{ - "shape":"OidcEndpoint", - "documentation":"

The OIDC IdP token endpoint used to configure your private workforce.

" - }, - "UserInfoEndpoint":{ - "shape":"OidcEndpoint", - "documentation":"

The OIDC IdP user information endpoint used to configure your private workforce.

" - }, - "LogoutEndpoint":{ - "shape":"OidcEndpoint", - "documentation":"

The OIDC IdP logout endpoint used to configure your private workforce.

" - }, - "JwksUri":{ - "shape":"OidcEndpoint", - "documentation":"

The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.

" - }, - "Scope":{ - "shape":"Scope", - "documentation":"

An array of string identifiers used to refer to the specific pieces of user data or claims that the client application wants to access.

" - }, - "AuthenticationRequestExtraParams":{ - "shape":"AuthenticationRequestExtraParams", - "documentation":"

A string to string map of identifiers specific to the custom identity provider (IdP) being used.

" - } - }, - "documentation":"

Your OIDC IdP workforce configuration.

" - }, - "OidcEndpoint":{ - "type":"string", - "max":500, - "min":0, - "pattern":"https://\\S+" - }, - "OidcMemberDefinition":{ - "type":"structure", - "members":{ - "Groups":{ - "shape":"Groups", - "documentation":"

A list of comma seperated strings that identifies user groups in your OIDC IdP. Each user group is made up of a group of private workers.

" - } - }, - "documentation":"

A list of user groups that exist in your OIDC Identity Provider (IdP). One to ten groups can be used to create a single private work team. When you add a user group to the list of Groups, you can add that user group to one or more private work teams. If you add a user group to a private work team, all workers in that user group are added to the work team.

" - }, - "OnStartDeepHealthChecks":{ - "type":"list", - "member":{"shape":"DeepHealthCheckType"}, - "max":2, - "min":1 - }, - "OnlineStoreConfig":{ - "type":"structure", - "members":{ - "SecurityConfig":{ - "shape":"OnlineStoreSecurityConfig", - "documentation":"

Use to specify KMS Key ID (KMSKeyId) for at-rest encryption of your OnlineStore.

" - }, - "EnableOnlineStore":{ - "shape":"Boolean", - "documentation":"

Turn OnlineStore off by specifying False for the EnableOnlineStore flag. Turn OnlineStore on by specifying True for the EnableOnlineStore flag.

The default value is False.

", - "box":true - }, - "TtlDuration":{ - "shape":"TtlDuration", - "documentation":"

Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration. For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

" - }, - "StorageType":{ - "shape":"StorageType", - "documentation":"

Option for different tiers of low latency storage for real-time data retrieval.

  • Standard: A managed low latency data store for feature groups.

  • InMemory: A managed data store for feature groups that supports very low latency retrieval.

" - } - }, - "documentation":"

Use this to specify the Amazon Web Services Key Management Service (KMS) Key ID, or KMSKeyId, for at rest data encryption. You can turn OnlineStore on or off by specifying the EnableOnlineStore flag at General Assembly.

The default value is False.

" - }, - "OnlineStoreConfigUpdate":{ - "type":"structure", - "members":{ - "TtlDuration":{ - "shape":"TtlDuration", - "documentation":"

Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration. For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

" - } - }, - "documentation":"

Updates the feature group online store configuration.

" - }, - "OnlineStoreSecurityConfig":{ - "type":"structure", - "members":{ - "KmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The Amazon Web Services Key Management Service (KMS) key ARN that SageMaker Feature Store uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side encryption.

The caller (either user or IAM role) of CreateFeatureGroup must have below permissions to the OnlineStore KmsKeyId:

  • \"kms:Encrypt\"

  • \"kms:Decrypt\"

  • \"kms:DescribeKey\"

  • \"kms:CreateGrant\"

  • \"kms:RetireGrant\"

  • \"kms:ReEncryptFrom\"

  • \"kms:ReEncryptTo\"

  • \"kms:GenerateDataKey\"

  • \"kms:ListAliases\"

  • \"kms:ListGrants\"

  • \"kms:RevokeGrant\"

The caller (either user or IAM role) to all DataPlane operations (PutRecord, GetRecord, DeleteRecord) must have the following permissions to the KmsKeyId:

  • \"kms:Decrypt\"

" - } - }, - "documentation":"

The security configuration for OnlineStore.

" - }, - "OnlineStoreTotalSizeBytes":{ - "type":"long", - "box":true - }, - "Operator":{ - "type":"string", - "enum":[ - "Equals", - "NotEquals", - "GreaterThan", - "GreaterThanOrEqualTo", - "LessThan", - "LessThanOrEqualTo", - "Contains", - "Exists", - "NotExists", - "In" - ] - }, - "OptimizationConfig":{ - "type":"structure", - "members":{ - "ModelQuantizationConfig":{ - "shape":"ModelQuantizationConfig", - "documentation":"

Settings for the model quantization technique that's applied by a model optimization job.

" - }, - "ModelCompilationConfig":{ - "shape":"ModelCompilationConfig", - "documentation":"

Settings for the model compilation technique that's applied by a model optimization job.

" - }, - "ModelShardingConfig":{ - "shape":"ModelShardingConfig", - "documentation":"

Settings for the model sharding technique that's applied by a model optimization job.

" - }, - "ModelSpeculativeDecodingConfig":{ - "shape":"ModelSpeculativeDecodingConfig", - "documentation":"

Settings for the model speculative decoding technique that's applied by a model optimization job.

" - } - }, - "documentation":"

Settings for an optimization technique that you apply with a model optimization job.

", - "union":true - }, - "OptimizationConfigs":{ - "type":"list", - "member":{"shape":"OptimizationConfig"}, - "max":10, - "min":0 - }, - "OptimizationContainerImage":{ - "type":"string", - "max":255, - "min":0, - "pattern":"[\\S]+" - }, - "OptimizationJobArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:optimization-job/.*" - }, - "OptimizationJobDeploymentInstanceType":{ - "type":"string", - "enum":[ - "ml.p4d.24xlarge", - "ml.p4de.24xlarge", - "ml.p5.48xlarge", - "ml.p5e.48xlarge", - "ml.p5en.48xlarge", - "ml.g4dn.xlarge", - "ml.g4dn.2xlarge", - "ml.g4dn.4xlarge", - "ml.g4dn.8xlarge", - "ml.g4dn.12xlarge", - "ml.g4dn.16xlarge", - "ml.g5.xlarge", - "ml.g5.2xlarge", - "ml.g5.4xlarge", - "ml.g5.8xlarge", - "ml.g5.12xlarge", - "ml.g5.16xlarge", - "ml.g5.24xlarge", - "ml.g5.48xlarge", - "ml.g6.xlarge", - "ml.g6.2xlarge", - "ml.g6.4xlarge", - "ml.g6.8xlarge", - "ml.g6.12xlarge", - "ml.g6.16xlarge", - "ml.g6.24xlarge", - "ml.g6.48xlarge", - "ml.g6e.xlarge", - "ml.g6e.2xlarge", - "ml.g6e.4xlarge", - "ml.g6e.8xlarge", - "ml.g6e.12xlarge", - "ml.g6e.16xlarge", - "ml.g6e.24xlarge", - "ml.g6e.48xlarge", - "ml.inf2.xlarge", - "ml.inf2.8xlarge", - "ml.inf2.24xlarge", - "ml.inf2.48xlarge", - "ml.trn1.2xlarge", - "ml.trn1.32xlarge", - "ml.trn1n.32xlarge", - "ml.p6-b200.48xlarge", - "ml.g7e.2xlarge", - "ml.g7e.4xlarge", - "ml.g7e.8xlarge", - "ml.g7e.12xlarge", - "ml.g7e.24xlarge", - "ml.g7e.48xlarge" - ] - }, - "OptimizationJobEnvironmentVariables":{ - "type":"map", - "key":{"shape":"NonEmptyString256"}, - "value":{"shape":"String256"}, - "max":25, - "min":0 - }, - "OptimizationJobMaxInstanceCount":{ - "type":"integer", - "box":true, - "min":1 - }, - "OptimizationJobModelSource":{ - "type":"structure", - "members":{ - "S3":{ - "shape":"OptimizationJobModelSourceS3", - "documentation":"

The Amazon S3 location of a source model to optimize with an optimization job.

" - }, - "SageMakerModel":{ - "shape":"OptimizationSageMakerModel", - "documentation":"

The name of an existing SageMaker model to optimize with an optimization job.

" - } - }, - "documentation":"

The location of the source model to optimize with an optimization job.

" - }, - "OptimizationJobModelSourceS3":{ - "type":"structure", - "members":{ - "S3Uri":{ - "shape":"S3Uri", - "documentation":"

An Amazon S3 URI that locates a source model to optimize with an optimization job.

" - }, - "ModelAccessConfig":{ - "shape":"OptimizationModelAccessConfig", - "documentation":"

The access configuration settings for the source ML model for an optimization job, where you can accept the model end-user license agreement (EULA).

" - } - }, - "documentation":"

The Amazon S3 location of a source model to optimize with an optimization job.

" - }, - "OptimizationJobOutputConfig":{ - "type":"structure", - "required":["S3OutputLocation"], - "members":{ - "KmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The Amazon Resource Name (ARN) of a key in Amazon Web Services KMS. SageMaker uses they key to encrypt the artifacts of the optimized model when SageMaker uploads the model to Amazon S3.

" - }, - "S3OutputLocation":{ - "shape":"S3Uri", - "documentation":"

The Amazon S3 URI for where to store the optimized model that you create with an optimization job.

" - }, - "SageMakerModel":{ - "shape":"OptimizationSageMakerModel", - "documentation":"

The name of a SageMaker model to use as the output destination for an optimization job.

" - } - }, - "documentation":"

Details for where to store the optimized model that you create with the optimization job.

" - }, - "OptimizationJobStatus":{ - "type":"string", - "enum":[ - "INPROGRESS", - "COMPLETED", - "FAILED", - "STARTING", - "STOPPING", - "STOPPED" - ] - }, - "OptimizationJobSummaries":{ - "type":"list", - "member":{"shape":"OptimizationJobSummary"} - }, - "OptimizationJobSummary":{ - "type":"structure", - "required":[ - "OptimizationJobName", - "OptimizationJobArn", - "CreationTime", - "OptimizationJobStatus", - "DeploymentInstanceType", - "OptimizationTypes" - ], - "members":{ - "OptimizationJobName":{ - "shape":"EntityName", - "documentation":"

The name that you assigned to the optimization job.

" - }, - "OptimizationJobArn":{ - "shape":"OptimizationJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the optimization job.

" - }, - "CreationTime":{ - "shape":"CreationTime", - "documentation":"

The time when you created the optimization job.

" - }, - "OptimizationJobStatus":{ - "shape":"OptimizationJobStatus", - "documentation":"

The current status of the optimization job.

" - }, - "OptimizationStartTime":{ - "shape":"Timestamp", - "documentation":"

The time when the optimization job started.

" - }, - "OptimizationEndTime":{ - "shape":"Timestamp", - "documentation":"

The time when the optimization job finished processing.

" - }, - "LastModifiedTime":{ - "shape":"LastModifiedTime", - "documentation":"

The time when the optimization job was last updated.

" - }, - "DeploymentInstanceType":{ - "shape":"OptimizationJobDeploymentInstanceType", - "documentation":"

The type of instance that hosts the optimized model that you create with the optimization job.

" - }, - "MaxInstanceCount":{ - "shape":"OptimizationJobMaxInstanceCount", - "documentation":"

The maximum number of instances to use for the optimization job.

" - }, - "OptimizationTypes":{ - "shape":"OptimizationTypes", - "documentation":"

The optimization techniques that are applied by the optimization job.

" - } - }, - "documentation":"

Summarizes an optimization job by providing some of its key properties.

" - }, - "OptimizationJobTrainingPlanArns":{ - "type":"list", - "member":{"shape":"TrainingPlanArn"}, - "documentation":"

Amazon Resource Names (ARNs) of the training plans whose reserved capacity backs the optimization job. Bounded to a single plan for now; the list shape allows widening to multiple plans in the future without a breaking scalar-to-list change.

", - "max":1, - "min":0 - }, - "OptimizationModelAcceptEula":{"type":"boolean"}, - "OptimizationModelAccessConfig":{ - "type":"structure", - "required":["AcceptEula"], - "members":{ - "AcceptEula":{ - "shape":"OptimizationModelAcceptEula", - "documentation":"

Specifies agreement to the model end-user license agreement (EULA). The AcceptEula value must be explicitly defined as True in order to accept the EULA that this model requires. You are responsible for reviewing and complying with any applicable license terms and making sure they are acceptable for your use case before downloading or using a model.

", - "box":true - } - }, - "documentation":"

The access configuration settings for the source ML model for an optimization job, where you can accept the model end-user license agreement (EULA).

" - }, - "OptimizationOutput":{ - "type":"structure", - "members":{ - "RecommendedInferenceImage":{ - "shape":"OptimizationContainerImage", - "documentation":"

The image that SageMaker recommends that you use to host the optimized model that you created with an optimization job.

" - } - }, - "documentation":"

Output values produced by an optimization job.

" - }, - "OptimizationSageMakerModel":{ - "type":"structure", - "members":{ - "ModelName":{ - "shape":"ModelName", - "documentation":"

The name of a SageMaker model.

" - } - }, - "documentation":"

A SageMaker model to use as the source or destination for an optimization job.

" - }, - "OptimizationType":{"type":"string"}, - "OptimizationTypes":{ - "type":"list", - "member":{"shape":"OptimizationType"} - }, - "OptimizationVpcConfig":{ - "type":"structure", - "required":[ - "SecurityGroupIds", - "Subnets" - ], - "members":{ - "SecurityGroupIds":{ - "shape":"OptimizationVpcSecurityGroupIds", - "documentation":"

The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.

" - }, - "Subnets":{ - "shape":"OptimizationVpcSubnets", - "documentation":"

The ID of the subnets in the VPC to which you want to connect your optimized model.

" - } - }, - "documentation":"

A VPC in Amazon VPC that's accessible to an optimized that you create with an optimization job. You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC.

" - }, - "OptimizationVpcSecurityGroupId":{ - "type":"string", - "max":32, - "min":0, - "pattern":"[-0-9a-zA-Z]+" - }, - "OptimizationVpcSecurityGroupIds":{ - "type":"list", - "member":{"shape":"OptimizationVpcSecurityGroupId"}, - "max":5, - "min":1 - }, - "OptimizationVpcSubnetId":{ - "type":"string", - "max":32, - "min":0, - "pattern":"[-0-9a-zA-Z]+" - }, - "OptimizationVpcSubnets":{ - "type":"list", - "member":{"shape":"OptimizationVpcSubnetId"}, - "max":16, - "min":1 - }, - "OptionalDouble":{ - "type":"double", - "box":true - }, - "OptionalInteger":{ - "type":"integer", - "box":true - }, - "OptionalVolumeSizeInGB":{ - "type":"integer", - "min":0 - }, - "OrderKey":{ - "type":"string", - "enum":[ - "Ascending", - "Descending" - ] - }, - "OutputCompressionType":{ - "type":"string", - "enum":[ - "GZIP", - "NONE" - ] - }, - "OutputConfig":{ - "type":"structure", - "required":["S3OutputLocation"], - "members":{ - "S3OutputLocation":{ - "shape":"S3Uri", - "documentation":"

Identifies the S3 bucket where you want Amazon SageMaker AI to store the model artifacts. For example, s3://bucket-name/key-name-prefix.

" - }, - "TargetDevice":{ - "shape":"TargetDevice", - "documentation":"

Identifies the target device or the machine learning instance that you want to run your model on after the compilation has completed. Alternatively, you can specify OS, architecture, and accelerator using TargetPlatform fields. It can be used instead of TargetPlatform.

Currently ml_trn1 is available only in US East (N. Virginia) Region, and ml_inf2 is available only in US East (Ohio) Region.

" - }, - "TargetPlatform":{ - "shape":"TargetPlatform", - "documentation":"

Contains information about a target platform that you want your model to run on, such as OS, architecture, and accelerators. It is an alternative of TargetDevice.

The following examples show how to configure the TargetPlatform and CompilerOptions JSON strings for popular target platforms:

  • Raspberry Pi 3 Model B+

    \"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"ARM_EABIHF\"},

    \"CompilerOptions\": {'mattr': ['+neon']}

  • Jetson TX2

    \"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"ARM64\", \"Accelerator\": \"NVIDIA\"},

    \"CompilerOptions\": {'gpu-code': 'sm_62', 'trt-ver': '6.0.1', 'cuda-ver': '10.0'}

  • EC2 m5.2xlarge instance OS

    \"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"X86_64\", \"Accelerator\": \"NVIDIA\"},

    \"CompilerOptions\": {'mcpu': 'skylake-avx512'}

  • RK3399

    \"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"ARM64\", \"Accelerator\": \"MALI\"}

  • ARMv7 phone (CPU)

    \"TargetPlatform\": {\"Os\": \"ANDROID\", \"Arch\": \"ARM_EABI\"},

    \"CompilerOptions\": {'ANDROID_PLATFORM': 25, 'mattr': ['+neon']}

  • ARMv8 phone (CPU)

    \"TargetPlatform\": {\"Os\": \"ANDROID\", \"Arch\": \"ARM64\"},

    \"CompilerOptions\": {'ANDROID_PLATFORM': 29}

" - }, - "CompilerOptions":{ - "shape":"CompilerOptions", - "documentation":"

Specifies additional parameters for compiler options in JSON format. The compiler options are TargetPlatform specific. It is required for NVIDIA accelerators and highly recommended for CPU compilations. For any other cases, it is optional to specify CompilerOptions.

  • DTYPE: Specifies the data type for the input. When compiling for ml_* (except for ml_inf) instances using PyTorch framework, provide the data type (dtype) of the model's input. \"float32\" is used if \"DTYPE\" is not specified. Options for data type are:

    • float32: Use either \"float\" or \"float32\".

    • int64: Use either \"int64\" or \"long\".

    For example, {\"dtype\" : \"float32\"}.

  • CPU: Compilation for CPU supports the following compiler options.

    • mcpu: CPU micro-architecture. For example, {'mcpu': 'skylake-avx512'}

    • mattr: CPU flags. For example, {'mattr': ['+neon', '+vfpv4']}

  • ARM: Details of ARM CPU compilations.

    • NEON: NEON is an implementation of the Advanced SIMD extension used in ARMv7 processors.

      For example, add {'mattr': ['+neon']} to the compiler options if compiling for ARM 32-bit platform with the NEON support.

  • NVIDIA: Compilation for NVIDIA GPU supports the following compiler options.

    • gpu_code: Specifies the targeted architecture.

    • trt-ver: Specifies the TensorRT versions in x.y.z. format.

    • cuda-ver: Specifies the CUDA version in x.y format.

    For example, {'gpu-code': 'sm_72', 'trt-ver': '6.0.1', 'cuda-ver': '10.1'}

  • ANDROID: Compilation for the Android OS supports the following compiler options:

    • ANDROID_PLATFORM: Specifies the Android API levels. Available levels range from 21 to 29. For example, {'ANDROID_PLATFORM': 28}.

    • mattr: Add {'mattr': ['+neon']} to compiler options if compiling for ARM 32-bit platform with NEON support.

  • INFERENTIA: Compilation for target ml_inf1 uses compiler options passed in as a JSON string. For example, \"CompilerOptions\": \"\\\"--verbose 1 --num-neuroncores 2 -O2\\\"\".

    For information about supported compiler options, see Neuron Compiler CLI Reference Guide.

  • CoreML: Compilation for the CoreML OutputConfig TargetDevice supports the following compiler options:

    • class_labels: Specifies the classification labels file name inside input tar.gz file. For example, {\"class_labels\": \"imagenet_labels_1000.txt\"}. Labels inside the txt file should be separated by newlines.

" - }, - "KmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The Amazon Web Services Key Management Service key (Amazon Web Services KMS) that Amazon SageMaker AI uses to encrypt your output models with Amazon S3 server-side encryption after compilation job. If you don't provide a KMS key ID, Amazon SageMaker AI uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

The KmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

" - } - }, - "documentation":"

Contains information about the output location for the compiled model and the target device that the model runs on. TargetDevice and TargetPlatform are mutually exclusive, so you need to choose one between the two to specify your target device or platform. If you cannot find your device you want to use from the TargetDevice list, use TargetPlatform to describe the platform of your edge device and CompilerOptions if there are specific settings that are required or recommended to use for particular TargetPlatform.

" - }, - "OutputDataConfig":{ - "type":"structure", - "required":["S3OutputPath"], - "members":{ - "KmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

  • // KMS Key ID

    \"1234abcd-12ab-34cd-56ef-1234567890ab\"

  • // Amazon Resource Name (ARN) of a KMS Key

    \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

  • // KMS Key Alias

    \"alias/ExampleAlias\"

  • // Amazon Resource Name (ARN) of a KMS Key Alias

    \"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"

If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide. If the output data is stored in Amazon S3 Express One Zone, it is encrypted with server-side encryption with Amazon S3 managed keys (SSE-S3). KMS key is not supported for Amazon S3 Express One Zone

The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob, CreateTransformJob, or CreateHyperParameterTuningJob requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

" - }, - "S3OutputPath":{ - "shape":"S3Uri", - "documentation":"

Identifies the S3 path where you want SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.

" - }, - "CompressionType":{ - "shape":"OutputCompressionType", - "documentation":"

The model output compression type. Select None to output an uncompressed model, recommended for large model outputs. Defaults to gzip.

" - } - }, - "documentation":"

Provides information about how to store model training results (model artifacts).

" - }, - "OutputParameter":{ - "type":"structure", - "required":[ - "Name", - "Value" - ], - "members":{ - "Name":{ - "shape":"String256", - "documentation":"

The name of the output parameter.

" - }, - "Value":{ - "shape":"String1024", - "documentation":"

The value of the output parameter.

" - } - }, - "documentation":"

An output parameter of a pipeline step.

" - }, - "OutputParameterList":{ - "type":"list", - "member":{"shape":"OutputParameter"}, - "max":50, - "min":0 - }, - "OwnershipSettings":{ - "type":"structure", - "required":["OwnerUserProfileName"], - "members":{ - "OwnerUserProfileName":{ - "shape":"UserProfileName", - "documentation":"

The user profile who is the owner of the space.

" - } - }, - "documentation":"

The collection of ownership settings for a space.

" - }, - "OwnershipSettingsSummary":{ - "type":"structure", - "members":{ - "OwnerUserProfileName":{ - "shape":"UserProfileName", - "documentation":"

The user profile who is the owner of the space.

" - } - }, - "documentation":"

Specifies summary information about the ownership settings.

" - }, - "PaginationToken":{ - "type":"string", - "max":8192, - "min":0, - "pattern":".*" - }, - "ParallelismConfiguration":{ - "type":"structure", - "required":["MaxParallelExecutionSteps"], - "members":{ - "MaxParallelExecutionSteps":{ - "shape":"MaxParallelExecutionSteps", - "documentation":"

The max number of steps that can be executed in parallel.

", - "box":true - } - }, - "documentation":"

Configuration that controls the parallelism of the pipeline. By default, the parallelism configuration specified applies to all executions of the pipeline unless overridden.

" - }, - "Parameter":{ - "type":"structure", - "required":[ - "Name", - "Value" - ], - "members":{ - "Name":{ - "shape":"PipelineParameterName", - "documentation":"

The name of the parameter to assign a value to. This parameter name must match a named parameter in the pipeline definition.

" - }, - "Value":{ - "shape":"String1024", - "documentation":"

The literal value for the parameter.

" - } - }, - "documentation":"

Assigns a value to a named Pipeline parameter.

" - }, - "ParameterKey":{ - "type":"string", - "max":256, - "min":0, - "pattern":".*" - }, - "ParameterList":{ - "type":"list", - "member":{"shape":"Parameter"}, - "max":200, - "min":0 - }, - "ParameterName":{ - "type":"string", - "max":256, - "min":0, - "pattern":"[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*" - }, - "ParameterRange":{ - "type":"structure", - "members":{ - "IntegerParameterRangeSpecification":{ - "shape":"IntegerParameterRangeSpecification", - "documentation":"

A IntegerParameterRangeSpecification object that defines the possible values for an integer hyperparameter.

" - }, - "ContinuousParameterRangeSpecification":{ - "shape":"ContinuousParameterRangeSpecification", - "documentation":"

A ContinuousParameterRangeSpecification object that defines the possible values for a continuous hyperparameter.

" - }, - "CategoricalParameterRangeSpecification":{ - "shape":"CategoricalParameterRangeSpecification", - "documentation":"

A CategoricalParameterRangeSpecification object that defines the possible values for a categorical hyperparameter.

" - } - }, - "documentation":"

Defines the possible values for categorical, continuous, and integer hyperparameters to be used by an algorithm.

" - }, - "ParameterRanges":{ - "type":"structure", - "members":{ - "IntegerParameterRanges":{ - "shape":"IntegerParameterRanges", - "documentation":"

The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.

" - }, - "ContinuousParameterRanges":{ - "shape":"ContinuousParameterRanges", - "documentation":"

The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.

" - }, - "CategoricalParameterRanges":{ - "shape":"CategoricalParameterRanges", - "documentation":"

The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.

" - }, - "AutoParameters":{ - "shape":"AutoParameters", - "documentation":"

A list containing hyperparameter names and example values to be used by Autotune to determine optimal ranges for your tuning job.

" - } - }, - "documentation":"

Specifies ranges of integer, continuous, and categorical hyperparameters that a hyperparameter tuning job searches. The hyperparameter tuning job launches training jobs with hyperparameter values within these ranges to find the combination of values that result in the training job with the best performance as measured by the objective metric of the hyperparameter tuning job.

The maximum number of items specified for Array Members refers to the maximum number of hyperparameters for each range and also the maximum for the hyperparameter tuning job itself. That is, the sum of the number of hyperparameters for all the ranges can't exceed the maximum number specified.

" - }, - "ParameterType":{ - "type":"string", - "enum":[ - "Integer", - "Continuous", - "Categorical", - "FreeText" - ] - }, - "ParameterValue":{ - "type":"string", - "max":256, - "min":0, - "pattern":".*" - }, - "ParameterValues":{ - "type":"list", - "member":{"shape":"ParameterValue"}, - "max":30, - "min":1 - }, - "Parent":{ - "type":"structure", - "members":{ - "TrialName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the trial.

" - }, - "ExperimentName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the experiment.

" - } - }, - "documentation":"

The trial that a trial component is associated with and the experiment the trial is part of. A component might not be associated with a trial. A component can be associated with multiple trials.

" - }, - "ParentHyperParameterTuningJob":{ - "type":"structure", - "members":{ - "HyperParameterTuningJobName":{ - "shape":"HyperParameterTuningJobName", - "documentation":"

The name of the hyperparameter tuning job to be used as a starting point for a new hyperparameter tuning job.

" - } - }, - "documentation":"

A previously completed or stopped hyperparameter tuning job to be used as a starting point for a new hyperparameter tuning job.

" - }, - "ParentHyperParameterTuningJobs":{ - "type":"list", - "member":{"shape":"ParentHyperParameterTuningJob"}, - "max":5, - "min":1 - }, - "Parents":{ - "type":"list", - "member":{"shape":"Parent"} - }, - "PartnerAppAdminUserList":{ - "type":"list", - "member":{"shape":"NonEmptyString256"}, - "max":5, - "min":0 - }, - "PartnerAppArguments":{ - "type":"map", - "key":{"shape":"NonEmptyString256"}, - "value":{"shape":"String1024"}, - "max":5, - "min":0 - }, - "PartnerAppArn":{ - "type":"string", - "max":128, - "min":1, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:partner-app\\/app-[A-Z0-9]{12}" - }, - "PartnerAppAuthType":{ - "type":"string", - "enum":["IAM"] - }, - "PartnerAppConfig":{ - "type":"structure", - "members":{ - "AdminUsers":{ - "shape":"PartnerAppAdminUserList", - "documentation":"

The list of users that are given admin access to the SageMaker Partner AI App.

" - }, - "Arguments":{ - "shape":"PartnerAppArguments", - "documentation":"

This is a map of required inputs for a SageMaker Partner AI App. Based on the application type, the map is populated with a key and value pair that is specific to the user and application.

" - }, - "AssignedGroupPatterns":{ - "shape":"AssignedGroupPatternsList", - "documentation":"

A list of Amazon Web Services IAM Identity Center group patterns that can access the SageMaker Partner AI App. Group names support wildcard matching using *. An empty list indicates the app will not use Identity Center group features. All groups specified in RoleGroupAssignments must match patterns in this list.

" - }, - "RoleGroupAssignments":{ - "shape":"RoleGroupAssignmentsList", - "documentation":"

A map of in-app roles to Amazon Web Services IAM Identity Center group patterns. Groups assigned to specific roles receive those permissions, while groups in AssignedGroupPatterns but not in this map receive default in-app role depending on app type. Group patterns support wildcard matching using *. Currently supported by Fiddler version 1.3 and later with roles: ORG_MEMBER (default) and ORG_ADMIN.

" - } - }, - "documentation":"

Configuration settings for the SageMaker Partner AI App.

" - }, - "PartnerAppMaintenanceConfig":{ - "type":"structure", - "members":{ - "MaintenanceWindowStart":{ - "shape":"WeeklyScheduleTimeFormat", - "documentation":"

The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. This value must take the following format: 3-letter-day:24-h-hour:minute. For example: TUE:03:30.

" - } - }, - "documentation":"

Maintenance configuration settings for the SageMaker Partner AI App.

" - }, - "PartnerAppName":{ - "type":"string", - "max":256, - "min":1, - "pattern":"[a-zA-Z0-9]+" - }, - "PartnerAppStatus":{ - "type":"string", - "enum":[ - "Creating", - "Updating", - "Deleting", - "Available", - "Failed", - "UpdateFailed", - "Deleted" - ] - }, - "PartnerAppSummaries":{ - "type":"list", - "member":{"shape":"PartnerAppSummary"} - }, - "PartnerAppSummary":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"PartnerAppArn", - "documentation":"

The ARN of the SageMaker Partner AI App.

" - }, - "Name":{ - "shape":"PartnerAppName", - "documentation":"

The name of the SageMaker Partner AI App.

" - }, - "Type":{ - "shape":"PartnerAppType", - "documentation":"

The type of SageMaker Partner AI App to create. Must be one of the following: lakera-guard, comet, deepchecks-llm-evaluation, or fiddler.

" - }, - "Status":{ - "shape":"PartnerAppStatus", - "documentation":"

The status of the SageMaker Partner AI App.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The creation time of the SageMaker Partner AI App.

" - } - }, - "documentation":"

A subset of information related to a SageMaker Partner AI App. This information is used as part of the ListPartnerApps API response.

" - }, - "PartnerAppType":{ - "type":"string", - "enum":[ - "lakera-guard", - "comet", - "deepchecks-llm-evaluation", - "fiddler" - ] - }, - "Peft":{ - "type":"string", - "enum":["LORA"] - }, - "PendingDeploymentSummary":{ - "type":"structure", - "required":["EndpointConfigName"], - "members":{ - "EndpointConfigName":{ - "shape":"EndpointConfigName", - "documentation":"

The name of the endpoint configuration used in the deployment.

" - }, - "ProductionVariants":{ - "shape":"PendingProductionVariantSummaryList", - "documentation":"

An array of PendingProductionVariantSummary objects, one for each model hosted behind this endpoint for the in-progress deployment.

" - }, - "StartTime":{ - "shape":"Timestamp", - "documentation":"

The start time of the deployment.

" - }, - "ShadowProductionVariants":{ - "shape":"PendingProductionVariantSummaryList", - "documentation":"

An array of PendingProductionVariantSummary objects, one for each model hosted behind this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants for the in-progress deployment.

" - } - }, - "documentation":"

The summary of an in-progress deployment when an endpoint is creating or updating with a new endpoint configuration.

" - }, - "PendingProductionVariantSummary":{ - "type":"structure", - "required":["VariantName"], - "members":{ - "VariantName":{ - "shape":"VariantName", - "documentation":"

The name of the variant.

" - }, - "DeployedImages":{ - "shape":"DeployedImages", - "documentation":"

An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the inference images deployed on instances of this ProductionVariant.

" - }, - "CurrentWeight":{ - "shape":"VariantWeight", - "documentation":"

The weight associated with the variant.

" - }, - "DesiredWeight":{ - "shape":"VariantWeight", - "documentation":"

The requested weight for the variant in this deployment, as specified in the endpoint configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.

" - }, - "CurrentInstanceCount":{ - "shape":"TaskCount", - "documentation":"

The number of instances associated with the variant.

" - }, - "DesiredInstanceCount":{ - "shape":"TaskCount", - "documentation":"

The number of instances requested in this deployment, as specified in the endpoint configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.

" - }, - "InstanceType":{ - "shape":"ProductionVariantInstanceType", - "documentation":"

The type of instances associated with the variant.

" - }, - "InstancePools":{ - "shape":"InstancePoolSummaryList", - "documentation":"

A list of instance pools for the production variant. Each pool indicates the instance type and the current number of instances of that type.

" - }, - "AcceleratorType":{ - "shape":"ProductionVariantAcceleratorType", - "documentation":"

This parameter is no longer supported. Elastic Inference (EI) is no longer available.

This parameter was used to specify the size of the EI instance to use for the production variant.

" - }, - "VariantStatus":{ - "shape":"ProductionVariantStatusList", - "documentation":"

The endpoint variant status which describes the current deployment stage status or operational status.

" - }, - "CurrentServerlessConfig":{ - "shape":"ProductionVariantServerlessConfig", - "documentation":"

The serverless configuration for the endpoint.

" - }, - "DesiredServerlessConfig":{ - "shape":"ProductionVariantServerlessConfig", - "documentation":"

The serverless configuration requested for this deployment, as specified in the endpoint configuration for the endpoint.

" - }, - "ManagedInstanceScaling":{ - "shape":"ProductionVariantManagedInstanceScaling", - "documentation":"

Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.

" - }, - "RoutingConfig":{ - "shape":"ProductionVariantRoutingConfig", - "documentation":"

Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.

" - } - }, - "documentation":"

The production variant summary for a deployment when an endpoint is creating or updating with the CreateEndpoint or UpdateEndpoint operations. Describes the VariantStatus , weight and capacity for a production variant associated with an endpoint.

" - }, - "PendingProductionVariantSummaryList":{ - "type":"list", - "member":{"shape":"PendingProductionVariantSummary"}, - "min":1 - }, - "Percentage":{ - "type":"integer", - "max":100 - }, - "Phase":{ - "type":"structure", - "members":{ - "InitialNumberOfUsers":{ - "shape":"InitialNumberOfUsers", - "documentation":"

Specifies how many concurrent users to start with. The value should be between 1 and 3.

" - }, - "SpawnRate":{ - "shape":"SpawnRate", - "documentation":"

Specified how many new users to spawn in a minute.

" - }, - "DurationInSeconds":{ - "shape":"TrafficDurationInSeconds", - "documentation":"

Specifies how long a traffic phase should be. For custom load tests, the value should be between 120 and 3600. This value should not exceed JobDurationInSeconds.

" - } - }, - "documentation":"

Defines the traffic pattern.

" - }, - "Phases":{ - "type":"list", - "member":{"shape":"Phase"}, - "min":1 - }, - "Pipeline":{ - "type":"structure", - "members":{ - "PipelineArn":{ - "shape":"PipelineArn", - "documentation":"

The Amazon Resource Name (ARN) of the pipeline.

" - }, - "PipelineName":{ - "shape":"PipelineName", - "documentation":"

The name of the pipeline.

" - }, - "PipelineDisplayName":{ - "shape":"PipelineName", - "documentation":"

The display name of the pipeline.

" - }, - "PipelineDescription":{ - "shape":"PipelineDescription", - "documentation":"

The description of the pipeline.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the role that created the pipeline.

" - }, - "PipelineStatus":{ - "shape":"PipelineStatus", - "documentation":"

The status of the pipeline.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The creation time of the pipeline.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The time that the pipeline was last modified.

" - }, - "LastRunTime":{ - "shape":"Timestamp", - "documentation":"

The time when the pipeline was last run.

" - }, - "CreatedBy":{"shape":"UserContext"}, - "LastModifiedBy":{"shape":"UserContext"}, - "ParallelismConfiguration":{ - "shape":"ParallelismConfiguration", - "documentation":"

The parallelism configuration applied to the pipeline.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

A list of tags that apply to the pipeline.

" - } - }, - "documentation":"

A SageMaker Model Building Pipeline instance.

" - }, - "PipelineArn":{ - "type":"string", - "max":2048, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:([0-9]{12}|aws):pipeline/.*" - }, - "PipelineDefinition":{ - "type":"string", - "max":1048576, - "min":1, - "pattern":".*(?:[ \\r\\n\\t].*)*" - }, - "PipelineDefinitionS3Location":{ - "type":"structure", - "required":[ - "Bucket", - "ObjectKey" - ], - "members":{ - "Bucket":{ - "shape":"BucketName", - "documentation":"

Name of the S3 bucket.

" - }, - "ObjectKey":{ - "shape":"Key", - "documentation":"

The object key (or key name) uniquely identifies the object in an S3 bucket.

" - }, - "VersionId":{ - "shape":"VersionId", - "documentation":"

Version Id of the pipeline definition file. If not specified, Amazon SageMaker will retrieve the latest version.

" - } - }, - "documentation":"

The location of the pipeline definition stored in Amazon S3.

" - }, - "PipelineDescription":{ - "type":"string", - "max":3072, - "min":0, - "pattern":".*" - }, - "PipelineExecution":{ - "type":"structure", - "members":{ - "PipelineArn":{ - "shape":"PipelineArn", - "documentation":"

The Amazon Resource Name (ARN) of the pipeline that was executed.

" - }, - "PipelineExecutionArn":{ - "shape":"PipelineExecutionArn", - "documentation":"

The Amazon Resource Name (ARN) of the pipeline execution.

" - }, - "PipelineExecutionDisplayName":{ - "shape":"PipelineExecutionName", - "documentation":"

The display name of the pipeline execution.

" - }, - "PipelineExecutionStatus":{ - "shape":"PipelineExecutionStatus", - "documentation":"

The status of the pipeline status.

" - }, - "PipelineExecutionDescription":{ - "shape":"PipelineExecutionDescription", - "documentation":"

The description of the pipeline execution.

" - }, - "PipelineExperimentConfig":{"shape":"PipelineExperimentConfig"}, - "FailureReason":{ - "shape":"PipelineExecutionFailureReason", - "documentation":"

If the execution failed, a message describing why.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The creation time of the pipeline execution.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The time that the pipeline execution was last modified.

" - }, - "CreatedBy":{"shape":"UserContext"}, - "LastModifiedBy":{"shape":"UserContext"}, - "ParallelismConfiguration":{ - "shape":"ParallelismConfiguration", - "documentation":"

The parallelism configuration applied to the pipeline execution.

" - }, - "SelectiveExecutionConfig":{ - "shape":"SelectiveExecutionConfig", - "documentation":"

The selective execution configuration applied to the pipeline run.

" - }, - "PipelineParameters":{ - "shape":"ParameterList", - "documentation":"

Contains a list of pipeline parameters. This list can be empty.

" - }, - "PipelineVersionId":{ - "shape":"PipelineVersionId", - "documentation":"

The ID of the pipeline version that started this execution.

" - }, - "PipelineVersionDisplayName":{ - "shape":"PipelineVersionName", - "documentation":"

The display name of the pipeline version that started this execution.

" - } - }, - "documentation":"

An execution of a pipeline.

" - }, - "PipelineExecutionArn":{ - "type":"string", - "max":2048, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:pipeline\\/.*\\/execution\\/.*" - }, - "PipelineExecutionDescription":{ - "type":"string", - "max":3072, - "min":0, - "pattern":".*" - }, - "PipelineExecutionFailureReason":{ - "type":"string", - "max":1300, - "min":0, - "pattern":".*" - }, - "PipelineExecutionName":{ - "type":"string", - "max":82, - "min":1, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,81}" - }, - "PipelineExecutionStatus":{ - "type":"string", - "enum":[ - "Executing", - "Stopping", - "Stopped", - "Failed", - "Succeeded" - ] - }, - "PipelineExecutionStep":{ - "type":"structure", - "members":{ - "StepName":{ - "shape":"StepName", - "documentation":"

The name of the step that is executed.

" - }, - "StepDisplayName":{ - "shape":"StepDisplayName", - "documentation":"

The display name of the step.

" - }, - "StepDescription":{ - "shape":"StepDescription", - "documentation":"

The description of the step.

" - }, - "StartTime":{ - "shape":"Timestamp", - "documentation":"

The time that the step started executing.

" - }, - "EndTime":{ - "shape":"Timestamp", - "documentation":"

The time that the step stopped executing.

" - }, - "StepStatus":{ - "shape":"StepStatus", - "documentation":"

The status of the step execution.

" - }, - "CacheHitResult":{ - "shape":"CacheHitResult", - "documentation":"

If this pipeline execution step was cached, details on the cache hit.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

The reason why the step failed execution. This is only returned if the step failed its execution.

" - }, - "Metadata":{ - "shape":"PipelineExecutionStepMetadata", - "documentation":"

Metadata to run the pipeline step.

" - }, - "AttemptCount":{ - "shape":"Integer", - "documentation":"

The current attempt of the execution step. For more information, see Retry Policy for SageMaker Pipelines steps.

", - "box":true - }, - "SelectiveExecutionResult":{ - "shape":"SelectiveExecutionResult", - "documentation":"

The ARN from an execution of the current pipeline from which results are reused for this step.

" - } - }, - "documentation":"

An execution of a step in a pipeline.

" - }, - "PipelineExecutionStepList":{ - "type":"list", - "member":{"shape":"PipelineExecutionStep"}, - "max":100, - "min":0 - }, - "PipelineExecutionStepMetadata":{ - "type":"structure", - "members":{ - "TrainingJob":{ - "shape":"TrainingJobStepMetadata", - "documentation":"

The Amazon Resource Name (ARN) of the training job that was run by this step execution.

" - }, - "ProcessingJob":{ - "shape":"ProcessingJobStepMetadata", - "documentation":"

The Amazon Resource Name (ARN) of the processing job that was run by this step execution.

" - }, - "TransformJob":{ - "shape":"TransformJobStepMetadata", - "documentation":"

The Amazon Resource Name (ARN) of the transform job that was run by this step execution.

" - }, - "TuningJob":{ - "shape":"TuningJobStepMetaData", - "documentation":"

The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.

" - }, - "Model":{ - "shape":"ModelStepMetadata", - "documentation":"

The Amazon Resource Name (ARN) of the model that was created by this step execution.

" - }, - "RegisterModel":{ - "shape":"RegisterModelStepMetadata", - "documentation":"

The Amazon Resource Name (ARN) of the model package that the model was registered to by this step execution.

" - }, - "Condition":{ - "shape":"ConditionStepMetadata", - "documentation":"

The outcome of the condition evaluation that was run by this step execution.

" - }, - "Callback":{ - "shape":"CallbackStepMetadata", - "documentation":"

The URL of the Amazon SQS queue used by this step execution, the pipeline generated token, and a list of output parameters.

" - }, - "Lambda":{ - "shape":"LambdaStepMetadata", - "documentation":"

The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution and a list of output parameters.

" - }, - "EMR":{ - "shape":"EMRStepMetadata", - "documentation":"

The configurations and outcomes of an Amazon EMR step execution.

" - }, - "QualityCheck":{ - "shape":"QualityCheckStepMetadata", - "documentation":"

The configurations and outcomes of the check step execution. This includes:

  • The type of the check conducted.

  • The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.

  • The Amazon S3 URIs of newly calculated baseline constraints and statistics.

  • The model package group name provided.

  • The Amazon S3 URI of the violation report if violations detected.

  • The Amazon Resource Name (ARN) of check processing job initiated by the step execution.

  • The Boolean flags indicating if the drift check is skipped.

  • If step property BaselineUsedForDriftCheck is set the same as CalculatedBaseline.

" - }, - "ClarifyCheck":{ - "shape":"ClarifyCheckStepMetadata", - "documentation":"

Container for the metadata for a Clarify check step. The configurations and outcomes of the check step execution. This includes:

  • The type of the check conducted,

  • The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.

  • The Amazon S3 URIs of newly calculated baseline constraints and statistics.

  • The model package group name provided.

  • The Amazon S3 URI of the violation report if violations detected.

  • The Amazon Resource Name (ARN) of check processing job initiated by the step execution.

  • The boolean flags indicating if the drift check is skipped.

  • If step property BaselineUsedForDriftCheck is set the same as CalculatedBaseline.

" - }, - "Fail":{ - "shape":"FailStepMetadata", - "documentation":"

The configurations and outcomes of a Fail step execution.

" - }, - "AutoMLJob":{ - "shape":"AutoMLJobStepMetadata", - "documentation":"

The Amazon Resource Name (ARN) of the AutoML job that was run by this step.

" - }, - "Endpoint":{ - "shape":"EndpointStepMetadata", - "documentation":"

The endpoint that was invoked during this step execution.

" - }, - "EndpointConfig":{ - "shape":"EndpointConfigStepMetadata", - "documentation":"

The endpoint configuration used to create an endpoint during this step execution.

" - }, - "BedrockCustomModel":{ - "shape":"BedrockCustomModelMetadata", - "documentation":"

The metadata of the Amazon Bedrock custom model used in the pipeline execution step.

" - }, - "BedrockCustomModelDeployment":{ - "shape":"BedrockCustomModelDeploymentMetadata", - "documentation":"

The metadata of the Amazon Bedrock custom model deployment used in pipeline execution step.

" - }, - "BedrockProvisionedModelThroughput":{ - "shape":"BedrockProvisionedModelThroughputMetadata", - "documentation":"

The metadata of the Amazon Bedrock provisioned model throughput used in the pipeline execution step.

" - }, - "BedrockModelImport":{ - "shape":"BedrockModelImportMetadata", - "documentation":"

The metadata of Amazon Bedrock model import used in pipeline execution step.

" - }, - "InferenceComponent":{ - "shape":"InferenceComponentMetadata", - "documentation":"

The metadata of the inference component used in pipeline execution step.

" - }, - "Lineage":{ - "shape":"LineageMetadata", - "documentation":"

The metadata of the lineage used in pipeline execution step.

" - }, - "Job":{ - "shape":"JobStepMetadata", - "documentation":"

The metadata for a SageMaker job used in a pipeline execution step.

" - } - }, - "documentation":"

Metadata for a step execution.

" - }, - "PipelineExecutionSummary":{ - "type":"structure", - "members":{ - "PipelineExecutionArn":{ - "shape":"PipelineExecutionArn", - "documentation":"

The Amazon Resource Name (ARN) of the pipeline execution.

" - }, - "StartTime":{ - "shape":"Timestamp", - "documentation":"

The start time of the pipeline execution.

" - }, - "PipelineExecutionStatus":{ - "shape":"PipelineExecutionStatus", - "documentation":"

The status of the pipeline execution.

" - }, - "PipelineExecutionDescription":{ - "shape":"PipelineExecutionDescription", - "documentation":"

The description of the pipeline execution.

" - }, - "PipelineExecutionDisplayName":{ - "shape":"PipelineExecutionName", - "documentation":"

The display name of the pipeline execution.

" - }, - "PipelineExecutionFailureReason":{ - "shape":"String3072", - "documentation":"

A message generated by SageMaker Pipelines describing why the pipeline execution failed.

" - } - }, - "documentation":"

A pipeline execution summary.

" - }, - "PipelineExecutionSummaryList":{ - "type":"list", - "member":{"shape":"PipelineExecutionSummary"}, - "max":100, - "min":0 - }, - "PipelineExperimentConfig":{ - "type":"structure", - "members":{ - "ExperimentName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the experiment.

" - }, - "TrialName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the trial.

" - } - }, - "documentation":"

Specifies the names of the experiment and trial created by a pipeline.

" - }, - "PipelineName":{ - "type":"string", - "max":256, - "min":1, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}" - }, - "PipelineNameOrArn":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:([0-9]{12}|aws):pipeline/.*)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,255})" - }, - "PipelineParameterName":{ - "type":"string", - "max":256, - "min":1, - "pattern":"[A-Za-z0-9\\-_]*" - }, - "PipelineStatus":{ - "type":"string", - "enum":[ - "Active", - "Deleting" - ] - }, - "PipelineSummary":{ - "type":"structure", - "members":{ - "PipelineArn":{ - "shape":"PipelineArn", - "documentation":"

The Amazon Resource Name (ARN) of the pipeline.

" - }, - "PipelineName":{ - "shape":"PipelineName", - "documentation":"

The name of the pipeline.

" - }, - "PipelineDisplayName":{ - "shape":"PipelineName", - "documentation":"

The display name of the pipeline.

" - }, - "PipelineDescription":{ - "shape":"PipelineDescription", - "documentation":"

The description of the pipeline.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) that the pipeline used to execute.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The creation time of the pipeline.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The time that the pipeline was last modified.

" - }, - "LastExecutionTime":{ - "shape":"Timestamp", - "documentation":"

The last time that a pipeline execution began.

" - } - }, - "documentation":"

A summary of a pipeline.

" - }, - "PipelineSummaryList":{ - "type":"list", - "member":{"shape":"PipelineSummary"}, - "max":100, - "min":0 - }, - "PipelineVersion":{ - "type":"structure", - "members":{ - "PipelineArn":{ - "shape":"PipelineArn", - "documentation":"

The Amazon Resource Name (ARN) of the pipeline.

" - }, - "PipelineVersionId":{ - "shape":"PipelineVersionId", - "documentation":"

The ID of the pipeline version.

" - }, - "PipelineVersionDisplayName":{ - "shape":"PipelineVersionName", - "documentation":"

The display name of the pipeline version.

" - }, - "PipelineVersionDescription":{ - "shape":"PipelineVersionDescription", - "documentation":"

The description of the pipeline version.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The creation time of the pipeline version.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The time when the pipeline version was last modified.

" - }, - "CreatedBy":{"shape":"UserContext"}, - "LastModifiedBy":{"shape":"UserContext"}, - "LastExecutedPipelineExecutionArn":{ - "shape":"PipelineExecutionArn", - "documentation":"

The Amazon Resource Name (ARN) of the most recent pipeline execution created from this pipeline version.

" - }, - "LastExecutedPipelineExecutionDisplayName":{ - "shape":"PipelineExecutionName", - "documentation":"

The display name of the most recent pipeline execution created from this pipeline version.

" - }, - "LastExecutedPipelineExecutionStatus":{ - "shape":"PipelineExecutionStatus", - "documentation":"

The status of the most recent pipeline execution created from this pipeline version.

" - } - }, - "documentation":"

The version of the pipeline.

" - }, - "PipelineVersionDescription":{ - "type":"string", - "max":3072, - "min":0, - "pattern":".*" - }, - "PipelineVersionId":{ - "type":"long", - "box":true, - "min":1 - }, - "PipelineVersionName":{ - "type":"string", - "max":82, - "min":1, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,81}" - }, - "PipelineVersionSummary":{ - "type":"structure", - "members":{ - "PipelineArn":{ - "shape":"PipelineArn", - "documentation":"

The Amazon Resource Name (ARN) of the pipeline.

" - }, - "PipelineVersionId":{ - "shape":"PipelineVersionId", - "documentation":"

The ID of the pipeline version.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The creation time of the pipeline version.

" - }, - "PipelineVersionDescription":{ - "shape":"PipelineVersionDescription", - "documentation":"

The description of the pipeline version.

" - }, - "PipelineVersionDisplayName":{ - "shape":"PipelineVersionName", - "documentation":"

The display name of the pipeline version.

" - }, - "LastExecutionPipelineExecutionArn":{ - "shape":"PipelineExecutionArn", - "documentation":"

The Amazon Resource Name (ARN) of the most recent pipeline execution created from this pipeline version.

" - } - }, - "documentation":"

The summary of the pipeline version.

" - }, - "PipelineVersionSummaryList":{ - "type":"list", - "member":{"shape":"PipelineVersionSummary"}, - "max":100, - "min":0 - }, - "PlacementSpecification":{ - "type":"structure", - "required":["InstanceCount"], - "members":{ - "UltraServerId":{ - "shape":"String256", - "documentation":"

The unique identifier of the UltraServer where instances should be placed.

" - }, - "InstanceCount":{ - "shape":"TrainingInstanceCount", - "documentation":"

The number of ML compute instances required to be placed together on the same UltraServer. Minimum value of 1.

", - "box":true - } - }, - "documentation":"

Specifies how instances should be placed on a specific UltraServer.

" - }, - "PlacementSpecifications":{ - "type":"list", - "member":{"shape":"PlacementSpecification"}, - "max":10, - "min":0 - }, - "PlatformIdentifier":{ - "type":"string", - "max":20, - "min":0, - "pattern":"(notebook-al1-v1|notebook-al2-v1|notebook-al2-v2|notebook-al2-v3|notebook-al2023-v1)" - }, - "PolicyString":{ - "type":"string", - "max":20480, - "min":1, - "pattern":".*" - }, - "PredefinedMetricSpecification":{ - "type":"structure", - "members":{ - "PredefinedMetricType":{ - "shape":"String", - "documentation":"

The metric type. You can only apply SageMaker metric types to SageMaker endpoints.

" - } - }, - "documentation":"

A specification for a predefined metric.

" - }, - "PreemptTeamTasks":{ - "type":"string", - "enum":[ - "Never", - "LowerPriority" - ] - }, - "PresignedDomainUrl":{"type":"string"}, - "PresignedUrlAccessConfig":{ - "type":"structure", - "members":{ - "AcceptEula":{ - "shape":"Boolean", - "documentation":"

Indicates acceptance of the End User License Agreement (EULA) for gated models. Set to true to acknowledge acceptance of the license terms required for accessing gated content.

", - "box":true - }, - "ExpectedS3Url":{ - "shape":"S3ModelUri", - "documentation":"

The expected S3 URL prefix for validation purposes. This parameter helps ensure consistency between the resolved S3 URIs and the deployment configuration, reducing potential compatibility issues.

" - } - }, - "documentation":"

Configuration for accessing hub content through presigned URLs, including license agreement acceptance and URL validation settings.

" - }, - "PriorityClass":{ - "type":"structure", - "required":[ - "Name", - "Weight" - ], - "members":{ - "Name":{ - "shape":"ClusterSchedulerPriorityClassName", - "documentation":"

Name of the priority class.

" - }, - "Weight":{ - "shape":"PriorityWeight", - "documentation":"

Weight of the priority class. The value is within a range from 0 to 100, where 0 is the default.

A weight of 0 is the lowest priority and 100 is the highest. Weight 0 is the default.

" - } - }, - "documentation":"

Priority class configuration. When included in PriorityClasses, these class configurations define how tasks are queued.

" - }, - "PriorityClassList":{ - "type":"list", - "member":{"shape":"PriorityClass"}, - "max":10, - "min":0 - }, - "PriorityWeight":{ - "type":"integer", - "box":true, - "max":100, - "min":0 - }, - "ProbabilityThresholdAttribute":{ - "type":"double", - "box":true - }, - "ProblemType":{ - "type":"string", - "enum":[ - "BinaryClassification", - "MulticlassClassification", - "Regression" - ] - }, - "ProcessingClusterConfig":{ - "type":"structure", - "required":[ - "InstanceCount", - "InstanceType", - "VolumeSizeInGB" - ], - "members":{ - "InstanceCount":{ - "shape":"ProcessingInstanceCount", - "documentation":"

The number of ML compute instances to use in the processing job. For distributed processing jobs, specify a value greater than 1. The default value is 1.

" - }, - "InstanceType":{ - "shape":"ProcessingInstanceType", - "documentation":"

The ML compute instance type for the processing job.

" - }, - "VolumeSizeInGB":{ - "shape":"ProcessingVolumeSizeInGB", - "documentation":"

The size of the ML storage volume in gigabytes that you want to provision. You must specify sufficient ML storage for your scenario.

Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for processing, Amazon SageMaker mounts the local instance storage instead of Amazon EBS gp2 storage. You can't request a VolumeSizeInGB greater than the total size of the local instance storage.

For a list of instance types that support local instance storage, including the total size per instance type, see Instance Store Volumes.

" - }, - "VolumeKmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the processing job.

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage.

For a list of instance types that support local instance storage, see Instance Store Volumes.

For more information about local instance storage encryption, see SSD Instance Store Volumes.

" - } - }, - "documentation":"

Configuration for the cluster used to run a processing job.

" - }, - "ProcessingEnvironmentKey":{ - "type":"string", - "max":256, - "min":0, - "pattern":"[a-zA-Z_][a-zA-Z0-9_]*" - }, - "ProcessingEnvironmentMap":{ - "type":"map", - "key":{"shape":"ProcessingEnvironmentKey"}, - "value":{"shape":"ProcessingEnvironmentValue"}, - "max":100, - "min":0 - }, - "ProcessingEnvironmentValue":{ - "type":"string", - "max":256, - "min":0, - "pattern":"[\\S\\s]*" - }, - "ProcessingFeatureStoreOutput":{ - "type":"structure", - "required":["FeatureGroupName"], - "members":{ - "FeatureGroupName":{ - "shape":"FeatureGroupName", - "documentation":"

The name of the Amazon SageMaker FeatureGroup to use as the destination for processing job output. Note that your processing script is responsible for putting records into your Feature Store.

" - } - }, - "documentation":"

Configuration for processing job outputs in Amazon SageMaker Feature Store.

" - }, - "ProcessingInput":{ - "type":"structure", - "required":["InputName"], - "members":{ - "InputName":{ - "shape":"String", - "documentation":"

The name for the processing job input.

" - }, - "AppManaged":{ - "shape":"AppManaged", - "documentation":"

When True, input operations such as data download are managed natively by the processing job application. When False (default), input operations are managed by Amazon SageMaker.

", - "box":true - }, - "S3Input":{ - "shape":"ProcessingS3Input", - "documentation":"

Configuration for downloading input data from Amazon S3 into the processing container.

" - }, - "DatasetDefinition":{ - "shape":"DatasetDefinition", - "documentation":"

Configuration for a Dataset Definition input.

" - } - }, - "documentation":"

The inputs for a processing job. The processing input must specify exactly one of either S3Input or DatasetDefinition types.

" - }, - "ProcessingInputs":{ - "type":"list", - "member":{"shape":"ProcessingInput"}, - "max":10, - "min":0 - }, - "ProcessingInstanceCount":{ - "type":"integer", - "box":true, - "max":100, - "min":1 - }, - "ProcessingInstanceType":{ - "type":"string", - "enum":[ - "ml.t3.medium", - "ml.t3.large", - "ml.t3.xlarge", - "ml.t3.2xlarge", - "ml.m4.xlarge", - "ml.m4.2xlarge", - "ml.m4.4xlarge", - "ml.m4.10xlarge", - "ml.m4.16xlarge", - "ml.c4.xlarge", - "ml.c4.2xlarge", - "ml.c4.4xlarge", - "ml.c4.8xlarge", - "ml.p2.xlarge", - "ml.p2.8xlarge", - "ml.p2.16xlarge", - "ml.p3.2xlarge", - "ml.p3.8xlarge", - "ml.p3.16xlarge", - "ml.c5.xlarge", - "ml.c5.2xlarge", - "ml.c5.4xlarge", - "ml.c5.9xlarge", - "ml.c5.18xlarge", - "ml.m5.large", - "ml.m5.xlarge", - "ml.m5.2xlarge", - "ml.m5.4xlarge", - "ml.m5.12xlarge", - "ml.m5.24xlarge", - "ml.r5.large", - "ml.r5.xlarge", - "ml.r5.2xlarge", - "ml.r5.4xlarge", - "ml.r5.8xlarge", - "ml.r5.12xlarge", - "ml.r5.16xlarge", - "ml.r5.24xlarge", - "ml.g4dn.xlarge", - "ml.g4dn.2xlarge", - "ml.g4dn.4xlarge", - "ml.g4dn.8xlarge", - "ml.g4dn.12xlarge", - "ml.g4dn.16xlarge", - "ml.g5.xlarge", - "ml.g5.2xlarge", - "ml.g5.4xlarge", - "ml.g5.8xlarge", - "ml.g5.16xlarge", - "ml.g5.12xlarge", - "ml.g5.24xlarge", - "ml.g5.48xlarge", - "ml.r5d.large", - "ml.r5d.xlarge", - "ml.r5d.2xlarge", - "ml.r5d.4xlarge", - "ml.r5d.8xlarge", - "ml.r5d.12xlarge", - "ml.r5d.16xlarge", - "ml.r5d.24xlarge", - "ml.g6.xlarge", - "ml.g6.2xlarge", - "ml.g6.4xlarge", - "ml.g6.8xlarge", - "ml.g6.12xlarge", - "ml.g6.16xlarge", - "ml.g6.24xlarge", - "ml.g6.48xlarge", - "ml.g6e.xlarge", - "ml.g6e.2xlarge", - "ml.g6e.4xlarge", - "ml.g6e.8xlarge", - "ml.g6e.12xlarge", - "ml.g6e.16xlarge", - "ml.g6e.24xlarge", - "ml.g6e.48xlarge", - "ml.m6i.large", - "ml.m6i.xlarge", - "ml.m6i.2xlarge", - "ml.m6i.4xlarge", - "ml.m6i.8xlarge", - "ml.m6i.12xlarge", - "ml.m6i.16xlarge", - "ml.m6i.24xlarge", - "ml.m6i.32xlarge", - "ml.c6i.xlarge", - "ml.c6i.2xlarge", - "ml.c6i.4xlarge", - "ml.c6i.8xlarge", - "ml.c6i.12xlarge", - "ml.c6i.16xlarge", - "ml.c6i.24xlarge", - "ml.c6i.32xlarge", - "ml.m7i.large", - "ml.m7i.xlarge", - "ml.m7i.2xlarge", - "ml.m7i.4xlarge", - "ml.m7i.8xlarge", - "ml.m7i.12xlarge", - "ml.m7i.16xlarge", - "ml.m7i.24xlarge", - "ml.m7i.48xlarge", - "ml.c7i.large", - "ml.c7i.xlarge", - "ml.c7i.2xlarge", - "ml.c7i.4xlarge", - "ml.c7i.8xlarge", - "ml.c7i.12xlarge", - "ml.c7i.16xlarge", - "ml.c7i.24xlarge", - "ml.c7i.48xlarge", - "ml.r7i.large", - "ml.r7i.xlarge", - "ml.r7i.2xlarge", - "ml.r7i.4xlarge", - "ml.r7i.8xlarge", - "ml.r7i.12xlarge", - "ml.r7i.16xlarge", - "ml.r7i.24xlarge", - "ml.r7i.48xlarge", - "ml.p5.4xlarge", - "ml.g7e.2xlarge", - "ml.g7e.4xlarge", - "ml.g7e.8xlarge", - "ml.g7e.12xlarge", - "ml.g7e.24xlarge", - "ml.g7e.48xlarge" - ] - }, - "ProcessingJob":{ - "type":"structure", - "members":{ - "ProcessingInputs":{ - "shape":"ProcessingInputs", - "documentation":"

List of input configurations for the processing job.

" - }, - "ProcessingOutputConfig":{"shape":"ProcessingOutputConfig"}, - "ProcessingJobName":{ - "shape":"ProcessingJobName", - "documentation":"

The name of the processing job.

" - }, - "ProcessingResources":{"shape":"ProcessingResources"}, - "StoppingCondition":{"shape":"ProcessingStoppingCondition"}, - "AppSpecification":{"shape":"AppSpecification"}, - "Environment":{ - "shape":"ProcessingEnvironmentMap", - "documentation":"

Sets the environment variables in the Docker container.

" - }, - "NetworkConfig":{"shape":"NetworkConfig"}, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The ARN of the role used to create the processing job.

" - }, - "ExperimentConfig":{"shape":"ExperimentConfig"}, - "ProcessingJobArn":{ - "shape":"ProcessingJobArn", - "documentation":"

The ARN of the processing job.

" - }, - "ProcessingJobStatus":{ - "shape":"ProcessingJobStatus", - "documentation":"

The status of the processing job.

" - }, - "ExitMessage":{ - "shape":"ExitMessage", - "documentation":"

A string, up to one KB in size, that contains metadata from the processing container when the processing job exits.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

A string, up to one KB in size, that contains the reason a processing job failed, if it failed.

" - }, - "ProcessingEndTime":{ - "shape":"Timestamp", - "documentation":"

The time that the processing job ended.

" - }, - "ProcessingStartTime":{ - "shape":"Timestamp", - "documentation":"

The time that the processing job started.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The time the processing job was last modified.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The time the processing job was created.

" - }, - "MonitoringScheduleArn":{ - "shape":"MonitoringScheduleArn", - "documentation":"

The ARN of a monitoring schedule for an endpoint associated with this processing job.

" - }, - "AutoMLJobArn":{ - "shape":"AutoMLJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the AutoML job associated with this processing job.

" - }, - "TrainingJobArn":{ - "shape":"TrainingJobArn", - "documentation":"

The ARN of the training job associated with this processing job.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

" - } - }, - "documentation":"

An Amazon SageMaker processing job that is used to analyze data and evaluate models. For more information, see Process Data and Evaluate Models.

" - }, - "ProcessingJobArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:processing-job/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" - }, - "ProcessingJobName":{ - "type":"string", - "max":63, - "min":1, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" - }, - "ProcessingJobStatus":{ - "type":"string", - "enum":[ - "InProgress", - "Completed", - "Failed", - "Stopping", - "Stopped" - ] - }, - "ProcessingJobStepMetadata":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"ProcessingJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the processing job.

" - } - }, - "documentation":"

Metadata for a processing job step.

" - }, - "ProcessingJobSummaries":{ - "type":"list", - "member":{"shape":"ProcessingJobSummary"} - }, - "ProcessingJobSummary":{ - "type":"structure", - "required":[ - "ProcessingJobName", - "ProcessingJobArn", - "CreationTime", - "ProcessingJobStatus" - ], - "members":{ - "ProcessingJobName":{ - "shape":"ProcessingJobName", - "documentation":"

The name of the processing job.

" - }, - "ProcessingJobArn":{ - "shape":"ProcessingJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the processing job..

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The time at which the processing job was created.

" - }, - "ProcessingEndTime":{ - "shape":"Timestamp", - "documentation":"

The time at which the processing job completed.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that indicates the last time the processing job was modified.

" - }, - "ProcessingJobStatus":{ - "shape":"ProcessingJobStatus", - "documentation":"

The status of the processing job.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

A string, up to one KB in size, that contains the reason a processing job failed, if it failed.

" - }, - "ExitMessage":{ - "shape":"ExitMessage", - "documentation":"

An optional string, up to one KB in size, that contains metadata from the processing container when the processing job exits.

" - } - }, - "documentation":"

Summary of information about a processing job.

" - }, - "ProcessingLocalPath":{ - "type":"string", - "max":256, - "min":0, - "pattern":".*" - }, - "ProcessingMaxRuntimeInSeconds":{ - "type":"integer", - "max":777600, - "min":1 - }, - "ProcessingOutput":{ - "type":"structure", - "required":["OutputName"], - "members":{ - "OutputName":{ - "shape":"String", - "documentation":"

The name for the processing job output.

" - }, - "S3Output":{ - "shape":"ProcessingS3Output", - "documentation":"

Configuration for processing job outputs in Amazon S3.

" - }, - "FeatureStoreOutput":{ - "shape":"ProcessingFeatureStoreOutput", - "documentation":"

Configuration for processing job outputs in Amazon SageMaker Feature Store. This processing output type is only supported when AppManaged is specified.

" - }, - "AppManaged":{ - "shape":"AppManaged", - "documentation":"

When True, output operations such as data upload are managed natively by the processing job application. When False (default), output operations are managed by Amazon SageMaker.

", - "box":true - } - }, - "documentation":"

Describes the results of a processing job. The processing output must specify exactly one of either S3Output or FeatureStoreOutput types.

" - }, - "ProcessingOutputConfig":{ - "type":"structure", - "required":["Outputs"], - "members":{ - "Outputs":{ - "shape":"ProcessingOutputs", - "documentation":"

An array of outputs configuring the data to upload from the processing container.

" - }, - "KmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the processing job output. KmsKeyId can be an ID of a KMS key, ARN of a KMS key, or alias of a KMS key. The KmsKeyId is applied to all outputs.

" - } - }, - "documentation":"

Configuration for uploading output from the processing container.

" - }, - "ProcessingOutputs":{ - "type":"list", - "member":{"shape":"ProcessingOutput"}, - "max":10, - "min":0 - }, - "ProcessingResources":{ - "type":"structure", - "required":["ClusterConfig"], - "members":{ - "ClusterConfig":{ - "shape":"ProcessingClusterConfig", - "documentation":"

The configuration for the resources in a cluster used to run the processing job.

" - } - }, - "documentation":"

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.

" - }, - "ProcessingS3CompressionType":{ - "type":"string", - "enum":[ - "None", - "Gzip" - ] - }, - "ProcessingS3DataDistributionType":{ - "type":"string", - "enum":[ - "FullyReplicated", - "ShardedByS3Key" - ] - }, - "ProcessingS3DataType":{ - "type":"string", - "enum":[ - "ManifestFile", - "S3Prefix" - ] - }, - "ProcessingS3Input":{ - "type":"structure", - "required":[ - "S3Uri", - "S3DataType" - ], - "members":{ - "S3Uri":{ - "shape":"S3Uri", - "documentation":"

The URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.

" - }, - "LocalPath":{ - "shape":"ProcessingLocalPath", - "documentation":"

The local path in your container where you want Amazon SageMaker to write input data to. LocalPath is an absolute path to the input data and must begin with /opt/ml/processing/. LocalPath is a required parameter when AppManaged is False (default).

" - }, - "S3DataType":{ - "shape":"ProcessingS3DataType", - "documentation":"

Whether you use an S3Prefix or a ManifestFile for the data type. If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for the processing job. If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for the processing job.

" - }, - "S3InputMode":{ - "shape":"ProcessingS3InputMode", - "documentation":"

Whether to use File or Pipe input mode. In File mode, Amazon SageMaker copies the data from the input source onto the local ML storage volume before starting your processing container. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your processing container into named pipes without using the ML storage volume.

" - }, - "S3DataDistributionType":{ - "shape":"ProcessingS3DataDistributionType", - "documentation":"

Whether to distribute the data from Amazon S3 to all processing instances with FullyReplicated, or whether the data from Amazon S3 is sharded by Amazon S3 key, downloading one shard of data to each processing instance.

" - }, - "S3CompressionType":{ - "shape":"ProcessingS3CompressionType", - "documentation":"

Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing container. Gzip can only be used when Pipe mode is specified as the S3InputMode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your container without using the EBS volume.

" - } - }, - "documentation":"

Configuration for downloading input data from Amazon S3 into the processing container.

" - }, - "ProcessingS3InputMode":{ - "type":"string", - "enum":[ - "Pipe", - "File" - ] - }, - "ProcessingS3Output":{ - "type":"structure", - "required":[ - "S3Uri", - "S3UploadMode" - ], - "members":{ - "S3Uri":{ - "shape":"S3Uri", - "documentation":"

A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of a processing job.

" - }, - "LocalPath":{ - "shape":"ProcessingLocalPath", - "documentation":"

The local path of a directory where you want Amazon SageMaker to upload its contents to Amazon S3. LocalPath is an absolute path to a directory containing output files. This directory will be created by the platform and exist when your container's entrypoint is invoked.

" - }, - "S3UploadMode":{ - "shape":"ProcessingS3UploadMode", - "documentation":"

Whether to upload the results of the processing job continuously or after the job completes.

" - } - }, - "documentation":"

Configuration for uploading output data to Amazon S3 from the processing container.

" - }, - "ProcessingS3UploadMode":{ - "type":"string", - "enum":[ - "Continuous", - "EndOfJob" - ] - }, - "ProcessingStoppingCondition":{ - "type":"structure", - "required":["MaxRuntimeInSeconds"], - "members":{ - "MaxRuntimeInSeconds":{ - "shape":"ProcessingMaxRuntimeInSeconds", - "documentation":"

Specifies the maximum runtime in seconds.

", - "box":true - } - }, - "documentation":"

Configures conditions under which the processing job should be stopped, such as how long the processing job has been running. After the condition is met, the processing job is stopped.

" - }, - "ProcessingVolumeSizeInGB":{ - "type":"integer", - "box":true, - "max":16384, - "min":1 - }, - "Processor":{ - "type":"string", - "enum":[ - "CPU", - "GPU" - ] - }, - "ProductId":{ - "type":"string", - "max":256, - "min":0, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9])*" - }, - "ProductListings":{ - "type":"list", - "member":{"shape":"String"} - }, - "ProductionVariant":{ - "type":"structure", - "required":["VariantName"], - "members":{ - "VariantName":{ - "shape":"VariantName", - "documentation":"

The name of the production variant.

" - }, - "ModelName":{ - "shape":"ModelName", - "documentation":"

The name of the model that you want to host. This is the name that you specified when creating the model.

" - }, - "InitialInstanceCount":{ - "shape":"InitialTaskCount", - "documentation":"

Number of instances to launch initially.

" - }, - "InstanceType":{ - "shape":"ProductionVariantInstanceType", - "documentation":"

The ML compute instance type.

" - }, - "InstancePools":{ - "shape":"InstancePoolList", - "documentation":"

A list of instance pools for the production variant. Each instance pool specifies an instance type and its priority for provisioning. Use instance pools to configure heterogeneous endpoints that deploy models across multiple instance types.

" - }, - "VariantInstanceProvisionTimeoutInSeconds":{ - "shape":"VariantInstanceProvisionTimeoutInSeconds", - "documentation":"

The timeout value, in seconds, for provisioning instances for the production variant. When SageMaker encounters an insufficient capacity error while provisioning instances, it retries with the next instance pool (if configured) or waits until the timeout expires. This timeout applies only to capacity provisioning and does not include the time for model download or container startup.

Valid values: 300 to 3600.

" - }, - "InitialVariantWeight":{ - "shape":"VariantWeight", - "documentation":"

Determines initial traffic distribution among all of the models that you specify in the endpoint configuration. The traffic to a production variant is determined by the ratio of the VariantWeight to the sum of all VariantWeight values across all ProductionVariants. If unspecified, it defaults to 1.0.

" - }, - "AcceleratorType":{ - "shape":"ProductionVariantAcceleratorType", - "documentation":"

This parameter is no longer supported. Elastic Inference (EI) is no longer available.

This parameter was used to specify the size of the EI instance to use for the production variant.

" - }, - "CoreDumpConfig":{ - "shape":"ProductionVariantCoreDumpConfig", - "documentation":"

Specifies configuration for a core dump from the model container when the process crashes.

" - }, - "ServerlessConfig":{ - "shape":"ProductionVariantServerlessConfig", - "documentation":"

The serverless configuration for an endpoint. Specifies a serverless endpoint configuration instead of an instance-based endpoint configuration.

" - }, - "VolumeSizeInGB":{ - "shape":"ProductionVariantVolumeSizeInGB", - "documentation":"

The size, in GB, of the ML storage volume attached to individual inference instance associated with the production variant. Currently only Amazon EBS gp2 storage volumes are supported.

" - }, - "ModelDataDownloadTimeoutInSeconds":{ - "shape":"ProductionVariantModelDataDownloadTimeoutInSeconds", - "documentation":"

The timeout value, in seconds, to download and extract the model that you want to host from Amazon S3 to the individual inference instance associated with this production variant.

" - }, - "ContainerStartupHealthCheckTimeoutInSeconds":{ - "shape":"ProductionVariantContainerStartupHealthCheckTimeoutInSeconds", - "documentation":"

The timeout value, in seconds, for your inference container to pass health check by SageMaker Hosting. For more information about health check, see How Your Container Should Respond to Health Check (Ping) Requests.

" - }, - "EnableSSMAccess":{ - "shape":"ProductionVariantSSMAccess", - "documentation":"

You can use this parameter to turn on native Amazon Web Services Systems Manager (SSM) access for a production variant behind an endpoint. By default, SSM access is disabled for all production variants behind an endpoint. You can turn on or turn off SSM access for a production variant behind an existing endpoint by creating a new endpoint configuration and calling UpdateEndpoint.

" - }, - "ManagedInstanceScaling":{ - "shape":"ProductionVariantManagedInstanceScaling", - "documentation":"

Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.

" - }, - "RoutingConfig":{ - "shape":"ProductionVariantRoutingConfig", - "documentation":"

Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.

" - }, - "InferenceAmiVersion":{ - "shape":"ProductionVariantInferenceAmiVersion", - "documentation":"

Specifies an option from a collection of preconfigured Amazon Machine Image (AMI) images. Each image is configured by Amazon Web Services with a set of software and driver versions. Amazon Web Services optimizes these configurations for different machine learning workloads.

By selecting an AMI version, you can ensure that your inference environment is compatible with specific software requirements, such as CUDA driver versions, Linux kernel versions, or Amazon Web Services Neuron driver versions.

The AMI version names, and their configurations, are the following:

al2-ami-sagemaker-inference-gpu-2

  • Accelerator: GPU

  • NVIDIA driver version: 535

  • CUDA version: 12.2

al2-ami-sagemaker-inference-gpu-2-1

  • Accelerator: GPU

  • NVIDIA driver version: 535

  • CUDA version: 12.2

  • NVIDIA Container Toolkit with disabled CUDA-compat mounting

al2-ami-sagemaker-inference-gpu-3-1

  • Accelerator: GPU

  • NVIDIA driver version: 550

  • CUDA version: 12.4

  • NVIDIA Container Toolkit with disabled CUDA-compat mounting

al2023-ami-sagemaker-inference-gpu-4-1

  • Accelerator: GPU

  • NVIDIA driver version: 580

  • CUDA version: 13.0

  • NVIDIA Container Toolkit with disabled CUDA-compat mounting

al2-ami-sagemaker-inference-neuron-2

  • Accelerator: Inferentia2 and Trainium

  • Neuron driver version: 2.19

" - }, - "CapacityReservationConfig":{ - "shape":"ProductionVariantCapacityReservationConfig", - "documentation":"

Settings for the capacity reservation for the compute instances that SageMaker AI reserves for an endpoint.

" - } - }, - "documentation":"

Identifies a model that you want to host and the resources chosen to deploy for hosting it. If you are deploying multiple models, tell SageMaker how to distribute traffic among the models by specifying variant weights. For more information on production variants, check Production variants.

" - }, - "ProductionVariantAcceleratorType":{ - "type":"string", - "enum":[ - "ml.eia1.medium", - "ml.eia1.large", - "ml.eia1.xlarge", - "ml.eia2.medium", - "ml.eia2.large", - "ml.eia2.xlarge" - ] - }, - "ProductionVariantCapacityReservationConfig":{ - "type":"structure", - "members":{ - "CapacityReservationPreference":{ - "shape":"CapacityReservationPreference", - "documentation":"

Options that you can choose for the capacity reservation. SageMaker AI supports the following options:

capacity-reservations-only

SageMaker AI launches instances only into an ML capacity reservation. If no capacity is available, the instances fail to launch.

" - }, - "MlReservationArn":{ - "shape":"MlReservationArn", - "documentation":"

The Amazon Resource Name (ARN) that uniquely identifies the ML capacity reservation that SageMaker AI applies when it deploys the endpoint.

" - } - }, - "documentation":"

Settings for the capacity reservation for the compute instances that SageMaker AI reserves for an endpoint.

" - }, - "ProductionVariantCapacityReservationSummary":{ - "type":"structure", - "members":{ - "MlReservationArn":{ - "shape":"MlReservationArn", - "documentation":"

The Amazon Resource Name (ARN) that uniquely identifies the ML capacity reservation that SageMaker AI applies when it deploys the endpoint.

" - }, - "CapacityReservationPreference":{ - "shape":"CapacityReservationPreference", - "documentation":"

The option that you chose for the capacity reservation. SageMaker AI supports the following options:

capacity-reservations-only

SageMaker AI launches instances only into an ML capacity reservation. If no capacity is available, the instances fail to launch.

" - }, - "TotalInstanceCount":{ - "shape":"TaskCount", - "documentation":"

The number of instances that you allocated to the ML capacity reservation.

" - }, - "AvailableInstanceCount":{ - "shape":"TaskCount", - "documentation":"

The number of instances that are currently available in the ML capacity reservation.

" - }, - "UsedByCurrentEndpoint":{ - "shape":"TaskCount", - "documentation":"

The number of instances from the ML capacity reservation that are being used by the endpoint.

" - }, - "Ec2CapacityReservations":{ - "shape":"Ec2CapacityReservationsList", - "documentation":"

The EC2 capacity reservations that are shared to this ML capacity reservation, if any.

" - } - }, - "documentation":"

Details about an ML capacity reservation.

" - }, - "ProductionVariantContainerStartupHealthCheckTimeoutInSeconds":{ - "type":"integer", - "box":true, - "max":3600, - "min":60 - }, - "ProductionVariantCoreDumpConfig":{ - "type":"structure", - "required":["DestinationS3Uri"], - "members":{ - "DestinationS3Uri":{ - "shape":"DestinationS3Uri", - "documentation":"

The Amazon S3 bucket to send the core dump to.

" - }, - "KmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the core dump data at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

  • // KMS Key ID

    \"1234abcd-12ab-34cd-56ef-1234567890ab\"

  • // Amazon Resource Name (ARN) of a KMS Key

    \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

  • // KMS Key Alias

    \"alias/ExampleAlias\"

  • // Amazon Resource Name (ARN) of a KMS Key Alias

    \"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"

If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, SageMaker uses the default KMS key for Amazon S3 for your role's account. SageMaker uses server-side encryption with KMS-managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to \"aws:kms\". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint and UpdateEndpoint requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

" - } - }, - "documentation":"

Specifies configuration for a core dump from the model container when the process crashes.

" - }, - "ProductionVariantInferenceAmiVersion":{ - "type":"string", - "enum":[ - "al2-ami-sagemaker-inference-gpu-2", - "al2-ami-sagemaker-inference-gpu-2-1", - "al2-ami-sagemaker-inference-gpu-3-1", - "al2-ami-sagemaker-inference-neuron-2", - "al2023-ami-sagemaker-inference-gpu-4-1" - ] - }, - "ProductionVariantInstanceType":{ - "type":"string", - "enum":[ - "ml.t2.medium", - "ml.t2.large", - "ml.t2.xlarge", - "ml.t2.2xlarge", - "ml.m4.xlarge", - "ml.m4.2xlarge", - "ml.m4.4xlarge", - "ml.m4.10xlarge", - "ml.m4.16xlarge", - "ml.m5.large", - "ml.m5.xlarge", - "ml.m5.2xlarge", - "ml.m5.4xlarge", - "ml.m5.12xlarge", - "ml.m5.24xlarge", - "ml.m5d.large", - "ml.m5d.xlarge", - "ml.m5d.2xlarge", - "ml.m5d.4xlarge", - "ml.m5d.12xlarge", - "ml.m5d.24xlarge", - "ml.c4.large", - "ml.c4.xlarge", - "ml.c4.2xlarge", - "ml.c4.4xlarge", - "ml.c4.8xlarge", - "ml.p2.xlarge", - "ml.p2.8xlarge", - "ml.p2.16xlarge", - "ml.p3.2xlarge", - "ml.p3.8xlarge", - "ml.p3.16xlarge", - "ml.c5.large", - "ml.c5.xlarge", - "ml.c5.2xlarge", - "ml.c5.4xlarge", - "ml.c5.9xlarge", - "ml.c5.18xlarge", - "ml.c5d.large", - "ml.c5d.xlarge", - "ml.c5d.2xlarge", - "ml.c5d.4xlarge", - "ml.c5d.9xlarge", - "ml.c5d.18xlarge", - "ml.g4dn.xlarge", - "ml.g4dn.2xlarge", - "ml.g4dn.4xlarge", - "ml.g4dn.8xlarge", - "ml.g4dn.12xlarge", - "ml.g4dn.16xlarge", - "ml.r5.large", - "ml.r5.xlarge", - "ml.r5.2xlarge", - "ml.r5.4xlarge", - "ml.r5.12xlarge", - "ml.r5.24xlarge", - "ml.r5d.large", - "ml.r5d.xlarge", - "ml.r5d.2xlarge", - "ml.r5d.4xlarge", - "ml.r5d.12xlarge", - "ml.r5d.24xlarge", - "ml.inf1.xlarge", - "ml.inf1.2xlarge", - "ml.inf1.6xlarge", - "ml.inf1.24xlarge", - "ml.dl1.24xlarge", - "ml.c6i.large", - "ml.c6i.xlarge", - "ml.c6i.2xlarge", - "ml.c6i.4xlarge", - "ml.c6i.8xlarge", - "ml.c6i.12xlarge", - "ml.c6i.16xlarge", - "ml.c6i.24xlarge", - "ml.c6i.32xlarge", - "ml.m6i.large", - "ml.m6i.xlarge", - "ml.m6i.2xlarge", - "ml.m6i.4xlarge", - "ml.m6i.8xlarge", - "ml.m6i.12xlarge", - "ml.m6i.16xlarge", - "ml.m6i.24xlarge", - "ml.m6i.32xlarge", - "ml.r6i.large", - "ml.r6i.xlarge", - "ml.r6i.2xlarge", - "ml.r6i.4xlarge", - "ml.r6i.8xlarge", - "ml.r6i.12xlarge", - "ml.r6i.16xlarge", - "ml.r6i.24xlarge", - "ml.r6i.32xlarge", - "ml.g5.xlarge", - "ml.g5.2xlarge", - "ml.g5.4xlarge", - "ml.g5.8xlarge", - "ml.g5.12xlarge", - "ml.g5.16xlarge", - "ml.g5.24xlarge", - "ml.g5.48xlarge", - "ml.g6.xlarge", - "ml.g6.2xlarge", - "ml.g6.4xlarge", - "ml.g6.8xlarge", - "ml.g6.12xlarge", - "ml.g6.16xlarge", - "ml.g6.24xlarge", - "ml.g6.48xlarge", - "ml.r8g.medium", - "ml.r8g.large", - "ml.r8g.xlarge", - "ml.r8g.2xlarge", - "ml.r8g.4xlarge", - "ml.r8g.8xlarge", - "ml.r8g.12xlarge", - "ml.r8g.16xlarge", - "ml.r8g.24xlarge", - "ml.r8g.48xlarge", - "ml.g6e.xlarge", - "ml.g6e.2xlarge", - "ml.g6e.4xlarge", - "ml.g6e.8xlarge", - "ml.g6e.12xlarge", - "ml.g6e.16xlarge", - "ml.g6e.24xlarge", - "ml.g6e.48xlarge", - "ml.g7e.2xlarge", - "ml.g7e.4xlarge", - "ml.g7e.8xlarge", - "ml.g7e.12xlarge", - "ml.g7e.24xlarge", - "ml.g7e.48xlarge", - "ml.g7.2xlarge", - "ml.g7.4xlarge", - "ml.g7.8xlarge", - "ml.g7.12xlarge", - "ml.g7.24xlarge", - "ml.g7.48xlarge", - "ml.p4d.24xlarge", - "ml.c7g.large", - "ml.c7g.xlarge", - "ml.c7g.2xlarge", - "ml.c7g.4xlarge", - "ml.c7g.8xlarge", - "ml.c7g.12xlarge", - "ml.c7g.16xlarge", - "ml.m6g.large", - "ml.m6g.xlarge", - "ml.m6g.2xlarge", - "ml.m6g.4xlarge", - "ml.m6g.8xlarge", - "ml.m6g.12xlarge", - "ml.m6g.16xlarge", - "ml.m6gd.large", - "ml.m6gd.xlarge", - "ml.m6gd.2xlarge", - "ml.m6gd.4xlarge", - "ml.m6gd.8xlarge", - "ml.m6gd.12xlarge", - "ml.m6gd.16xlarge", - "ml.c6g.large", - "ml.c6g.xlarge", - "ml.c6g.2xlarge", - "ml.c6g.4xlarge", - "ml.c6g.8xlarge", - "ml.c6g.12xlarge", - "ml.c6g.16xlarge", - "ml.c6gd.large", - "ml.c6gd.xlarge", - "ml.c6gd.2xlarge", - "ml.c6gd.4xlarge", - "ml.c6gd.8xlarge", - "ml.c6gd.12xlarge", - "ml.c6gd.16xlarge", - "ml.c6gn.large", - "ml.c6gn.xlarge", - "ml.c6gn.2xlarge", - "ml.c6gn.4xlarge", - "ml.c6gn.8xlarge", - "ml.c6gn.12xlarge", - "ml.c6gn.16xlarge", - "ml.r6g.large", - "ml.r6g.xlarge", - "ml.r6g.2xlarge", - "ml.r6g.4xlarge", - "ml.r6g.8xlarge", - "ml.r6g.12xlarge", - "ml.r6g.16xlarge", - "ml.r6gd.large", - "ml.r6gd.xlarge", - "ml.r6gd.2xlarge", - "ml.r6gd.4xlarge", - "ml.r6gd.8xlarge", - "ml.r6gd.12xlarge", - "ml.r6gd.16xlarge", - "ml.p4de.24xlarge", - "ml.trn1.2xlarge", - "ml.trn1.32xlarge", - "ml.trn1n.32xlarge", - "ml.trn2.48xlarge", - "ml.inf2.xlarge", - "ml.inf2.8xlarge", - "ml.inf2.24xlarge", - "ml.inf2.48xlarge", - "ml.p5.48xlarge", - "ml.p5e.48xlarge", - "ml.p5en.48xlarge", - "ml.m7i.large", - "ml.m7i.xlarge", - "ml.m7i.2xlarge", - "ml.m7i.4xlarge", - "ml.m7i.8xlarge", - "ml.m7i.12xlarge", - "ml.m7i.16xlarge", - "ml.m7i.24xlarge", - "ml.m7i.48xlarge", - "ml.c7i.large", - "ml.c7i.xlarge", - "ml.c7i.2xlarge", - "ml.c7i.4xlarge", - "ml.c7i.8xlarge", - "ml.c7i.12xlarge", - "ml.c7i.16xlarge", - "ml.c7i.24xlarge", - "ml.c7i.48xlarge", - "ml.r7i.large", - "ml.r7i.xlarge", - "ml.r7i.2xlarge", - "ml.r7i.4xlarge", - "ml.r7i.8xlarge", - "ml.r7i.12xlarge", - "ml.r7i.16xlarge", - "ml.r7i.24xlarge", - "ml.r7i.48xlarge", - "ml.c8g.medium", - "ml.c8g.large", - "ml.c8g.xlarge", - "ml.c8g.2xlarge", - "ml.c8g.4xlarge", - "ml.c8g.8xlarge", - "ml.c8g.12xlarge", - "ml.c8g.16xlarge", - "ml.c8g.24xlarge", - "ml.c8g.48xlarge", - "ml.r7gd.medium", - "ml.r7gd.large", - "ml.r7gd.xlarge", - "ml.r7gd.2xlarge", - "ml.r7gd.4xlarge", - "ml.r7gd.8xlarge", - "ml.r7gd.12xlarge", - "ml.r7gd.16xlarge", - "ml.m8g.medium", - "ml.m8g.large", - "ml.m8g.xlarge", - "ml.m8g.2xlarge", - "ml.m8g.4xlarge", - "ml.m8g.8xlarge", - "ml.m8g.12xlarge", - "ml.m8g.16xlarge", - "ml.m8g.24xlarge", - "ml.m8g.48xlarge", - "ml.c6in.large", - "ml.c6in.xlarge", - "ml.c6in.2xlarge", - "ml.c6in.4xlarge", - "ml.c6in.8xlarge", - "ml.c6in.12xlarge", - "ml.c6in.16xlarge", - "ml.c6in.24xlarge", - "ml.c6in.32xlarge", - "ml.p6-b200.48xlarge", - "ml.p6-b300.48xlarge", - "ml.p6e-gb200.36xlarge", - "ml.p5.4xlarge" - ] - }, - "ProductionVariantList":{ - "type":"list", - "member":{"shape":"ProductionVariant"}, - "max":10, - "min":1 - }, - "ProductionVariantManagedInstanceScaling":{ - "type":"structure", - "members":{ - "Status":{ - "shape":"ManagedInstanceScalingStatus", - "documentation":"

Indicates whether managed instance scaling is enabled.

" - }, - "MinInstanceCount":{ - "shape":"ManagedInstanceScalingMinInstanceCount", - "documentation":"

The minimum number of instances that the endpoint must retain when it scales down to accommodate a decrease in traffic.

" - }, - "MaxInstanceCount":{ - "shape":"ManagedInstanceScalingMaxInstanceCount", - "documentation":"

The maximum number of instances that the endpoint can provision when it scales up to accommodate an increase in traffic.

" - }, - "ScaleInPolicy":{ - "shape":"ProductionVariantManagedInstanceScalingScaleInPolicy", - "documentation":"

Configures the scale-in behavior for managed instance scaling.

" - } - }, - "documentation":"

Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.

" - }, - "ProductionVariantManagedInstanceScalingScaleInPolicy":{ - "type":"structure", - "required":["Strategy"], - "members":{ - "Strategy":{ - "shape":"ManagedInstanceScalingScaleInStrategy", - "documentation":"

The strategy for scaling in instances.

IDLE_RELEASE

Releases instances that have no hosted inference component copies.

CONSOLIDATION

Consolidates inference component copies onto fewer instances to release more instances. Consolidation honors the scheduling configuration of each inference component. For example, if an inference component specifies Availability Zone balance, consolidation only proceeds when the resulting distribution does not increase the imbalance.

" - }, - "MaximumStepSize":{ - "shape":"ManagedInstanceScalingMaximumStepSize", - "documentation":"

The maximum number of instances that the endpoint can terminate at a time during a consolidation scale-in operation.

Default value: 1.

" - }, - "CooldownInMinutes":{ - "shape":"ManagedInstanceScalingCooldownInMinutes", - "documentation":"

The cooldown period, in minutes, after the last endpoint operation before the endpoint evaluates consolidation scale-in opportunities.

Default value: 20.

" - } - }, - "documentation":"

Configures the scale-in behavior for managed instance scaling.

" - }, - "ProductionVariantModelDataDownloadTimeoutInSeconds":{ - "type":"integer", - "box":true, - "max":3600, - "min":60 - }, - "ProductionVariantRoutingConfig":{ - "type":"structure", - "required":["RoutingStrategy"], - "members":{ - "RoutingStrategy":{ - "shape":"RoutingStrategy", - "documentation":"

Sets how the endpoint routes incoming traffic:

  • LEAST_OUTSTANDING_REQUESTS: The endpoint routes requests to the specific instances that have more capacity to process them.

  • RANDOM: The endpoint routes each request to a randomly chosen instance.

" - } - }, - "documentation":"

Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.

" - }, - "ProductionVariantSSMAccess":{ - "type":"boolean", - "box":true - }, - "ProductionVariantServerlessConfig":{ - "type":"structure", - "required":[ - "MemorySizeInMB", - "MaxConcurrency" - ], - "members":{ - "MemorySizeInMB":{ - "shape":"ServerlessMemorySizeInMB", - "documentation":"

The memory size of your serverless endpoint. Valid values are in 1 GB increments: 1024 MB, 2048 MB, 3072 MB, 4096 MB, 5120 MB, or 6144 MB.

" - }, - "MaxConcurrency":{ - "shape":"ServerlessMaxConcurrency", - "documentation":"

The maximum number of concurrent invocations your serverless endpoint can process.

" - }, - "ProvisionedConcurrency":{ - "shape":"ServerlessProvisionedConcurrency", - "documentation":"

The amount of provisioned concurrency to allocate for the serverless endpoint. Should be less than or equal to MaxConcurrency.

This field is not supported for serverless endpoint recommendations for Inference Recommender jobs. For more information about creating an Inference Recommender job, see CreateInferenceRecommendationsJobs.

" - } - }, - "documentation":"

Specifies the serverless configuration for an endpoint variant.

" - }, - "ProductionVariantServerlessUpdateConfig":{ - "type":"structure", - "members":{ - "MaxConcurrency":{ - "shape":"ServerlessMaxConcurrency", - "documentation":"

The updated maximum number of concurrent invocations your serverless endpoint can process.

" - }, - "ProvisionedConcurrency":{ - "shape":"ServerlessProvisionedConcurrency", - "documentation":"

The updated amount of provisioned concurrency to allocate for the serverless endpoint. Should be less than or equal to MaxConcurrency.

" - } - }, - "documentation":"

Specifies the serverless update concurrency configuration for an endpoint variant.

" - }, - "ProductionVariantStatus":{ - "type":"structure", - "required":["Status"], - "members":{ - "Status":{ - "shape":"VariantStatus", - "documentation":"

The endpoint variant status which describes the current deployment stage status or operational status.

  • Creating: Creating inference resources for the production variant.

  • Deleting: Terminating inference resources for the production variant.

  • Updating: Updating capacity for the production variant.

  • ActivatingTraffic: Turning on traffic for the production variant.

  • Baking: Waiting period to monitor the CloudWatch alarms in the automatic rollback configuration.

" - }, - "StatusMessage":{ - "shape":"VariantStatusMessage", - "documentation":"

A message that describes the status of the production variant.

" - }, - "StartTime":{ - "shape":"Timestamp", - "documentation":"

The start time of the current status change.

" - } - }, - "documentation":"

Describes the status of the production variant.

" - }, - "ProductionVariantStatusList":{ - "type":"list", - "member":{"shape":"ProductionVariantStatus"}, - "max":5, - "min":0 - }, - "ProductionVariantSummary":{ - "type":"structure", - "required":["VariantName"], - "members":{ - "VariantName":{ - "shape":"VariantName", - "documentation":"

The name of the variant.

" - }, - "DeployedImages":{ - "shape":"DeployedImages", - "documentation":"

An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the inference images deployed on instances of this ProductionVariant.

" - }, - "CurrentWeight":{ - "shape":"VariantWeight", - "documentation":"

The weight associated with the variant.

" - }, - "DesiredWeight":{ - "shape":"VariantWeight", - "documentation":"

The requested weight, as specified in the UpdateEndpointWeightsAndCapacities request.

" - }, - "CurrentInstanceCount":{ - "shape":"TaskCount", - "documentation":"

The number of instances associated with the variant.

" - }, - "DesiredInstanceCount":{ - "shape":"TaskCount", - "documentation":"

The number of instances requested in the UpdateEndpointWeightsAndCapacities request.

" - }, - "InstancePools":{ - "shape":"InstancePoolSummaryList", - "documentation":"

A list of instance pools for the production variant. Each pool indicates the instance type and the current number of instances of that type.

" - }, - "VariantStatus":{ - "shape":"ProductionVariantStatusList", - "documentation":"

The endpoint variant status which describes the current deployment stage status or operational status.

" - }, - "CurrentServerlessConfig":{ - "shape":"ProductionVariantServerlessConfig", - "documentation":"

The serverless configuration for the endpoint.

" - }, - "DesiredServerlessConfig":{ - "shape":"ProductionVariantServerlessConfig", - "documentation":"

The serverless configuration requested for the endpoint update.

" - }, - "ManagedInstanceScaling":{ - "shape":"ProductionVariantManagedInstanceScaling", - "documentation":"

Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.

" - }, - "RoutingConfig":{ - "shape":"ProductionVariantRoutingConfig", - "documentation":"

Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.

" - }, - "CapacityReservationConfig":{ - "shape":"ProductionVariantCapacityReservationSummary", - "documentation":"

Settings for the capacity reservation for the compute instances that SageMaker AI reserves for an endpoint.

" - } - }, - "documentation":"

Describes weight and capacities for a production variant associated with an endpoint. If you sent a request to the UpdateEndpointWeightsAndCapacities API and the endpoint status is Updating, you get different desired and current values.

" - }, - "ProductionVariantSummaryList":{ - "type":"list", - "member":{"shape":"ProductionVariantSummary"}, - "min":1 - }, - "ProductionVariantVolumeSizeInGB":{ - "type":"integer", - "box":true, - "max":512, - "min":1 - }, - "ProfilerConfig":{ - "type":"structure", - "members":{ - "S3OutputPath":{ - "shape":"S3Uri", - "documentation":"

Path to Amazon S3 storage location for system and framework metrics.

" - }, - "ProfilingIntervalInMilliseconds":{ - "shape":"ProfilingIntervalInMilliseconds", - "documentation":"

A time interval for capturing system metrics in milliseconds. Available values are 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.

" - }, - "ProfilingParameters":{ - "shape":"ProfilingParameters", - "documentation":"

Configuration information for capturing framework metrics. Available key strings for different profiling options are DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig. The following codes are configuration structures for the ProfilingParameters parameter. To learn more about how to configure the ProfilingParameters parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

" - }, - "DisableProfiler":{ - "shape":"DisableProfiler", - "documentation":"

Configuration to turn off Amazon SageMaker Debugger's system monitoring and profiling functionality. To turn it off, set to True.

", - "box":true - } - }, - "documentation":"

Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and storage paths.

" - }, - "ProfilerConfigForUpdate":{ - "type":"structure", - "members":{ - "S3OutputPath":{ - "shape":"S3Uri", - "documentation":"

Path to Amazon S3 storage location for system and framework metrics.

" - }, - "ProfilingIntervalInMilliseconds":{ - "shape":"ProfilingIntervalInMilliseconds", - "documentation":"

A time interval for capturing system metrics in milliseconds. Available values are 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.

" - }, - "ProfilingParameters":{ - "shape":"ProfilingParameters", - "documentation":"

Configuration information for capturing framework metrics. Available key strings for different profiling options are DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig. The following codes are configuration structures for the ProfilingParameters parameter. To learn more about how to configure the ProfilingParameters parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

" - }, - "DisableProfiler":{ - "shape":"DisableProfiler", - "documentation":"

To turn off Amazon SageMaker Debugger monitoring and profiling while a training job is in progress, set to True.

", - "box":true - } - }, - "documentation":"

Configuration information for updating the Amazon SageMaker Debugger profile parameters, system and framework metrics configurations, and storage paths.

" - }, - "ProfilerRuleConfiguration":{ - "type":"structure", - "required":[ - "RuleConfigurationName", - "RuleEvaluatorImage" - ], - "members":{ - "RuleConfigurationName":{ - "shape":"RuleConfigurationName", - "documentation":"

The name of the rule configuration. It must be unique relative to other rule configuration names.

" - }, - "LocalPath":{ - "shape":"DirectoryPath", - "documentation":"

Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.

" - }, - "S3OutputPath":{ - "shape":"S3Uri", - "documentation":"

Path to Amazon S3 storage location for rules.

" - }, - "RuleEvaluatorImage":{ - "shape":"AlgorithmImage", - "documentation":"

The Amazon Elastic Container Registry Image for the managed rule evaluation.

" - }, - "InstanceType":{ - "shape":"ProcessingInstanceType", - "documentation":"

The instance type to deploy a custom rule for profiling a training job.

" - }, - "VolumeSizeInGB":{ - "shape":"OptionalVolumeSizeInGB", - "documentation":"

The size, in GB, of the ML storage volume attached to the processing instance.

", - "box":true - }, - "RuleParameters":{ - "shape":"RuleParameters", - "documentation":"

Runtime configuration for rule container.

" - } - }, - "documentation":"

Configuration information for profiling rules.

" - }, - "ProfilerRuleConfigurations":{ - "type":"list", - "member":{"shape":"ProfilerRuleConfiguration"}, - "max":20, - "min":0 - }, - "ProfilerRuleEvaluationStatus":{ - "type":"structure", - "members":{ - "RuleConfigurationName":{ - "shape":"RuleConfigurationName", - "documentation":"

The name of the rule configuration.

" - }, - "RuleEvaluationJobArn":{ - "shape":"ProcessingJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the rule evaluation job.

" - }, - "RuleEvaluationStatus":{ - "shape":"RuleEvaluationStatus", - "documentation":"

Status of the rule evaluation.

" - }, - "StatusDetails":{ - "shape":"StatusDetails", - "documentation":"

Details from the rule evaluation.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

Timestamp when the rule evaluation status was last modified.

" - } - }, - "documentation":"

Information about the status of the rule evaluation.

" - }, - "ProfilerRuleEvaluationStatuses":{ - "type":"list", - "member":{"shape":"ProfilerRuleEvaluationStatus"}, - "max":20, - "min":0 - }, - "ProfilingIntervalInMilliseconds":{ - "type":"long", - "box":true - }, - "ProfilingParameters":{ - "type":"map", - "key":{"shape":"ConfigKey"}, - "value":{"shape":"ConfigValue"}, - "max":20, - "min":0 - }, - "ProfilingStatus":{ - "type":"string", - "enum":[ - "Enabled", - "Disabled" - ] - }, - "ProgrammingLang":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[a-zA-Z]+ ?\\d+\\.\\d+(\\.\\d+)?" - }, - "Project":{ - "type":"structure", - "members":{ - "ProjectArn":{ - "shape":"ProjectArn", - "documentation":"

The Amazon Resource Name (ARN) of the project.

" - }, - "ProjectName":{ - "shape":"ProjectEntityName", - "documentation":"

The name of the project.

" - }, - "ProjectId":{ - "shape":"ProjectId", - "documentation":"

The ID of the project.

" - }, - "ProjectDescription":{ - "shape":"EntityDescription", - "documentation":"

The description of the project.

" - }, - "ServiceCatalogProvisioningDetails":{"shape":"ServiceCatalogProvisioningDetails"}, - "ServiceCatalogProvisionedProductDetails":{"shape":"ServiceCatalogProvisionedProductDetails"}, - "ProjectStatus":{ - "shape":"ProjectStatus", - "documentation":"

The status of the project.

" - }, - "CreatedBy":{ - "shape":"UserContext", - "documentation":"

Who created the project.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp specifying when the project was created.

" - }, - "TemplateProviderDetails":{ - "shape":"TemplateProviderDetailList", - "documentation":"

An array of template providers associated with the project.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp container for when the project was last modified.

" - }, - "LastModifiedBy":{"shape":"UserContext"} - }, - "documentation":"

The properties of a project as returned by the Search API.

" - }, - "ProjectArn":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:project/[\\S]{1,2048}" - }, - "ProjectEntityName":{ - "type":"string", - "max":32, - "min":1, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}" - }, - "ProjectId":{ - "type":"string", - "max":20, - "min":1, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9])*" - }, - "ProjectSortBy":{ - "type":"string", - "enum":[ - "Name", - "CreationTime" - ] - }, - "ProjectSortOrder":{ - "type":"string", - "enum":[ - "Ascending", - "Descending" - ] - }, - "ProjectStatus":{ - "type":"string", - "enum":[ - "Pending", - "CreateInProgress", - "CreateCompleted", - "CreateFailed", - "DeleteInProgress", - "DeleteFailed", - "DeleteCompleted", - "UpdateInProgress", - "UpdateCompleted", - "UpdateFailed" - ] - }, - "ProjectSummary":{ - "type":"structure", - "required":[ - "ProjectName", - "ProjectArn", - "ProjectId", - "CreationTime", - "ProjectStatus" - ], - "members":{ - "ProjectName":{ - "shape":"ProjectEntityName", - "documentation":"

The name of the project.

" - }, - "ProjectDescription":{ - "shape":"EntityDescription", - "documentation":"

The description of the project.

" - }, - "ProjectArn":{ - "shape":"ProjectArn", - "documentation":"

The Amazon Resource Name (ARN) of the project.

" - }, - "ProjectId":{ - "shape":"ProjectId", - "documentation":"

The ID of the project.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The time that the project was created.

" - }, - "ProjectStatus":{ - "shape":"ProjectStatus", - "documentation":"

The status of the project.

" - } - }, - "documentation":"

Information about a project.

" - }, - "ProjectSummaryList":{ - "type":"list", - "member":{"shape":"ProjectSummary"} - }, - "PropertyNameHint":{ - "type":"string", - "max":100, - "min":0, - "pattern":".*" - }, - "PropertyNameQuery":{ - "type":"structure", - "required":["PropertyNameHint"], - "members":{ - "PropertyNameHint":{ - "shape":"PropertyNameHint", - "documentation":"

Text that begins a property's name.

" - } - }, - "documentation":"

Part of the SuggestionQuery type. Specifies a hint for retrieving property names that begin with the specified text.

" - }, - "PropertyNameSuggestion":{ - "type":"structure", - "members":{ - "PropertyName":{ - "shape":"ResourcePropertyName", - "documentation":"

A suggested property name based on what you entered in the search textbox in the SageMaker console.

" - } - }, - "documentation":"

A property name returned from a GetSearchSuggestions call that specifies a value in the PropertyNameQuery field.

" - }, - "PropertyNameSuggestionList":{ - "type":"list", - "member":{"shape":"PropertyNameSuggestion"} - }, - "ProvisionedProductStatusMessage":{ - "type":"string", - "pattern":".*" - }, - "ProvisioningParameter":{ - "type":"structure", - "members":{ - "Key":{ - "shape":"ProvisioningParameterKey", - "documentation":"

The key that identifies a provisioning parameter.

" - }, - "Value":{ - "shape":"ProvisioningParameterValue", - "documentation":"

The value of the provisioning parameter.

" - } - }, - "documentation":"

A key value pair used when you provision a project as a service catalog product. For information, see What is Amazon Web Services Service Catalog.

" - }, - "ProvisioningParameterKey":{ - "type":"string", - "max":1000, - "min":1, - "pattern":".*" - }, - "ProvisioningParameterValue":{ - "type":"string", - "max":4096, - "min":0, - "pattern":".*" - }, - "ProvisioningParameters":{ - "type":"list", - "member":{"shape":"ProvisioningParameter"} - }, - "PublicWorkforceTaskPrice":{ - "type":"structure", - "members":{ - "AmountInUsd":{ - "shape":"USD", - "documentation":"

Defines the amount of money paid to an Amazon Mechanical Turk worker in United States dollars.

" - } - }, - "documentation":"

Defines the amount of money paid to an Amazon Mechanical Turk worker for each task performed.

Use one of the following prices for bounding box tasks. Prices are in US dollars and should be based on the complexity of the task; the longer it takes in your initial testing, the more you should offer.

  • 0.036

  • 0.048

  • 0.060

  • 0.072

  • 0.120

  • 0.240

  • 0.360

  • 0.480

  • 0.600

  • 0.720

  • 0.840

  • 0.960

  • 1.080

  • 1.200

Use one of the following prices for image classification, text classification, and custom tasks. Prices are in US dollars.

  • 0.012

  • 0.024

  • 0.036

  • 0.048

  • 0.060

  • 0.072

  • 0.120

  • 0.240

  • 0.360

  • 0.480

  • 0.600

  • 0.720

  • 0.840

  • 0.960

  • 1.080

  • 1.200

Use one of the following prices for semantic segmentation tasks. Prices are in US dollars.

  • 0.840

  • 0.960

  • 1.080

  • 1.200

Use one of the following prices for Textract AnalyzeDocument Important Form Key Amazon Augmented AI review tasks. Prices are in US dollars.

  • 2.400

  • 2.280

  • 2.160

  • 2.040

  • 1.920

  • 1.800

  • 1.680

  • 1.560

  • 1.440

  • 1.320

  • 1.200

  • 1.080

  • 0.960

  • 0.840

  • 0.720

  • 0.600

  • 0.480

  • 0.360

  • 0.240

  • 0.120

  • 0.072

  • 0.060

  • 0.048

  • 0.036

  • 0.024

  • 0.012

Use one of the following prices for Rekognition DetectModerationLabels Amazon Augmented AI review tasks. Prices are in US dollars.

  • 1.200

  • 1.080

  • 0.960

  • 0.840

  • 0.720

  • 0.600

  • 0.480

  • 0.360

  • 0.240

  • 0.120

  • 0.072

  • 0.060

  • 0.048

  • 0.036

  • 0.024

  • 0.012

Use one of the following prices for Amazon Augmented AI custom human review tasks. Prices are in US dollars.

  • 1.200

  • 1.080

  • 0.960

  • 0.840

  • 0.720

  • 0.600

  • 0.480

  • 0.360

  • 0.240

  • 0.120

  • 0.072

  • 0.060

  • 0.048

  • 0.036

  • 0.024

  • 0.012

" - }, - "PutModelPackageGroupPolicyInput":{ - "type":"structure", - "required":[ - "ModelPackageGroupName", - "ResourcePolicy" - ], - "members":{ - "ModelPackageGroupName":{ - "shape":"EntityName", - "documentation":"

The name of the model group to add a resource policy to.

" - }, - "ResourcePolicy":{ - "shape":"PolicyString", - "documentation":"

The resource policy for the model group.

" - } - } - }, - "PutModelPackageGroupPolicyOutput":{ - "type":"structure", - "required":["ModelPackageGroupArn"], - "members":{ - "ModelPackageGroupArn":{ - "shape":"ModelPackageGroupArn", - "documentation":"

The Amazon Resource Name (ARN) of the model package group.

" - } - } - }, - "QProfileArn":{ - "type":"string", - "pattern":"arn:[-.a-z0-9]{1,63}:codewhisperer:([-.a-z0-9]{0,63}:){2}([a-zA-Z0-9-_:/]){1,1023}" - }, - "QualityCheckStepMetadata":{ - "type":"structure", - "members":{ - "CheckType":{ - "shape":"String256", - "documentation":"

The type of the Quality check step.

" - }, - "BaselineUsedForDriftCheckStatistics":{ - "shape":"String1024", - "documentation":"

The Amazon S3 URI of the baseline statistics file used for the drift check.

" - }, - "BaselineUsedForDriftCheckConstraints":{ - "shape":"String1024", - "documentation":"

The Amazon S3 URI of the baseline constraints file used for the drift check.

" - }, - "CalculatedBaselineStatistics":{ - "shape":"String1024", - "documentation":"

The Amazon S3 URI of the newly calculated baseline statistics file.

" - }, - "CalculatedBaselineConstraints":{ - "shape":"String1024", - "documentation":"

The Amazon S3 URI of the newly calculated baseline constraints file.

" - }, - "ModelPackageGroupName":{ - "shape":"String256", - "documentation":"

The model package group name.

" - }, - "ViolationReport":{ - "shape":"String1024", - "documentation":"

The Amazon S3 URI of violation report if violations are detected.

" - }, - "CheckJobArn":{ - "shape":"String256", - "documentation":"

The Amazon Resource Name (ARN) of the Quality check processing job that was run by this step execution.

" - }, - "SkipCheck":{ - "shape":"Boolean", - "documentation":"

This flag indicates if the drift check against the previous baseline will be skipped or not. If it is set to False, the previous baseline of the configured check type must be available.

", - "box":true - }, - "RegisterNewBaseline":{ - "shape":"Boolean", - "documentation":"

This flag indicates if a newly calculated baseline can be accessed through step properties BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. If it is set to False, the previous baseline of the configured check type must also be available. These can be accessed through the BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics properties.

", - "box":true - } - }, - "documentation":"

Container for the metadata for a Quality check step. For more information, see the topic on QualityCheck step in the Amazon SageMaker Developer Guide.

" - }, - "QueryFilters":{ - "type":"structure", - "members":{ - "Types":{ - "shape":"QueryTypes", - "documentation":"

Filter the lineage entities connected to the StartArn by type. For example: DataSet, Model, Endpoint, or ModelDeployment.

" - }, - "LineageTypes":{ - "shape":"QueryLineageTypes", - "documentation":"

Filter the lineage entities connected to the StartArn(s) by the type of the lineage entity.

" - }, - "CreatedBefore":{ - "shape":"Timestamp", - "documentation":"

Filter the lineage entities connected to the StartArn(s) by created date.

" - }, - "CreatedAfter":{ - "shape":"Timestamp", - "documentation":"

Filter the lineage entities connected to the StartArn(s) after the create date.

" - }, - "ModifiedBefore":{ - "shape":"Timestamp", - "documentation":"

Filter the lineage entities connected to the StartArn(s) before the last modified date.

" - }, - "ModifiedAfter":{ - "shape":"Timestamp", - "documentation":"

Filter the lineage entities connected to the StartArn(s) after the last modified date.

" - }, - "Properties":{ - "shape":"QueryProperties", - "documentation":"

Filter the lineage entities connected to the StartArn(s) by a set if property key value pairs. If multiple pairs are provided, an entity is included in the results if it matches any of the provided pairs.

" - } - }, - "documentation":"

A set of filters to narrow the set of lineage entities connected to the StartArn(s) returned by the QueryLineage API action.

" - }, - "QueryLineageMaxDepth":{ - "type":"integer", - "box":true, - "max":10 - }, - "QueryLineageMaxResults":{ - "type":"integer", - "box":true, - "max":50 - }, - "QueryLineageRequest":{ - "type":"structure", - "members":{ - "StartArns":{ - "shape":"QueryLineageStartArns", - "documentation":"

A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.

" - }, - "Direction":{ - "shape":"Direction", - "documentation":"

Associations between lineage entities have a direction. This parameter determines the direction from the StartArn(s) that the query traverses.

" - }, - "IncludeEdges":{ - "shape":"Boolean", - "documentation":"

Setting this value to True retrieves not only the entities of interest but also the Associations and lineage entities on the path. Set to False to only return lineage entities that match your query.

", - "box":true - }, - "Filters":{ - "shape":"QueryFilters", - "documentation":"

A set of filtering parameters that allow you to specify which entities should be returned.

  • Properties - Key-value pairs to match on the lineage entities' properties.

  • LineageTypes - A set of lineage entity types to match on. For example: TrialComponent, Artifact, or Context.

  • CreatedBefore - Filter entities created before this date.

  • ModifiedBefore - Filter entities modified before this date.

  • ModifiedAfter - Filter entities modified after this date.

" - }, - "MaxDepth":{ - "shape":"QueryLineageMaxDepth", - "documentation":"

The maximum depth in lineage relationships from the StartArns that are traversed. Depth is a measure of the number of Associations from the StartArn entity to the matched results.

" - }, - "MaxResults":{ - "shape":"QueryLineageMaxResults", - "documentation":"

Limits the number of vertices in the results. Use the NextToken in a response to to retrieve the next page of results.

" - }, - "NextToken":{ - "shape":"String8192", - "documentation":"

Limits the number of vertices in the request. Use the NextToken in a response to to retrieve the next page of results.

" - } - } - }, - "QueryLineageResponse":{ - "type":"structure", - "members":{ - "Vertices":{ - "shape":"Vertices", - "documentation":"

A list of vertices connected to the start entity(ies) in the lineage graph.

" - }, - "Edges":{ - "shape":"Edges", - "documentation":"

A list of edges that connect vertices in the response.

" - }, - "NextToken":{ - "shape":"String8192", - "documentation":"

Limits the number of vertices in the response. Use the NextToken in a response to to retrieve the next page of results.

" - } - } - }, - "QueryLineageStartArns":{ - "type":"list", - "member":{"shape":"AssociationEntityArn"}, - "max":1, - "min":0 - }, - "QueryLineageTypes":{ - "type":"list", - "member":{"shape":"LineageType"}, - "max":4, - "min":0 - }, - "QueryProperties":{ - "type":"map", - "key":{"shape":"String256"}, - "value":{"shape":"String256"}, - "max":5, - "min":0 - }, - "QueryTypes":{ - "type":"list", - "member":{"shape":"String40"}, - "max":5, - "min":0 - }, - "RSessionAppSettings":{ - "type":"structure", - "members":{ - "DefaultResourceSpec":{"shape":"ResourceSpec"}, - "CustomImages":{ - "shape":"CustomImages", - "documentation":"

A list of custom SageMaker AI images that are configured to run as a RSession app.

" - } - }, - "documentation":"

A collection of settings that apply to an RSessionGateway app.

" - }, - "RStudioServerProAccessStatus":{ - "type":"string", - "enum":[ - "ENABLED", - "DISABLED" - ] - }, - "RStudioServerProAppSettings":{ - "type":"structure", - "members":{ - "AccessStatus":{ - "shape":"RStudioServerProAccessStatus", - "documentation":"

Indicates whether the current user has access to the RStudioServerPro app.

" - }, - "UserGroup":{ - "shape":"RStudioServerProUserGroup", - "documentation":"

The level of permissions that the user has within the RStudioServerPro app. This value defaults to `User`. The `Admin` value allows the user access to the RStudio Administrative Dashboard.

" - } - }, - "documentation":"

A collection of settings that configure user interaction with the RStudioServerPro app.

" - }, - "RStudioServerProDomainSettings":{ - "type":"structure", - "required":["DomainExecutionRoleArn"], - "members":{ - "DomainExecutionRoleArn":{ - "shape":"RoleArn", - "documentation":"

The ARN of the execution role for the RStudioServerPro Domain-level app.

" - }, - "RStudioConnectUrl":{ - "shape":"String", - "documentation":"

A URL pointing to an RStudio Connect server.

" - }, - "RStudioPackageManagerUrl":{ - "shape":"String", - "documentation":"

A URL pointing to an RStudio Package Manager server.

" - }, - "DefaultResourceSpec":{"shape":"ResourceSpec"} - }, - "documentation":"

A collection of settings that configure the RStudioServerPro Domain-level app.

" - }, - "RStudioServerProDomainSettingsForUpdate":{ - "type":"structure", - "required":["DomainExecutionRoleArn"], - "members":{ - "DomainExecutionRoleArn":{ - "shape":"RoleArn", - "documentation":"

The execution role for the RStudioServerPro Domain-level app.

" - }, - "DefaultResourceSpec":{"shape":"ResourceSpec"}, - "RStudioConnectUrl":{ - "shape":"String", - "documentation":"

A URL pointing to an RStudio Connect server.

" - }, - "RStudioPackageManagerUrl":{ - "shape":"String", - "documentation":"

A URL pointing to an RStudio Package Manager server.

" - } - }, - "documentation":"

A collection of settings that update the current configuration for the RStudioServerPro Domain-level app.

" - }, - "RStudioServerProUserGroup":{ - "type":"string", - "enum":[ - "R_STUDIO_ADMIN", - "R_STUDIO_USER" - ] - }, - "RandomSeed":{ - "type":"integer", - "box":true, - "min":0 - }, - "RealTimeInferenceConfig":{ - "type":"structure", - "required":[ - "InstanceType", - "InstanceCount" - ], - "members":{ - "InstanceType":{ - "shape":"ProductionVariantInstanceType", - "documentation":"

The instance type the model is deployed to.

" - }, - "InstanceCount":{ - "shape":"TaskCount", - "documentation":"

The number of instances of the type specified by InstanceType.

" - } - }, - "documentation":"

The infrastructure configuration for deploying the model to a real-time inference endpoint.

" - }, - "RealTimeInferenceRecommendation":{ - "type":"structure", - "required":[ - "RecommendationId", - "InstanceType" - ], - "members":{ - "RecommendationId":{ - "shape":"String", - "documentation":"

The recommendation ID which uniquely identifies each recommendation.

" - }, - "InstanceType":{ - "shape":"ProductionVariantInstanceType", - "documentation":"

The recommended instance type for Real-Time Inference.

" - }, - "Environment":{ - "shape":"EnvironmentMap", - "documentation":"

The recommended environment variables to set in the model container for Real-Time Inference.

" - } - }, - "documentation":"

The recommended configuration to use for Real-Time Inference.

" - }, - "RealTimeInferenceRecommendations":{ - "type":"list", - "member":{"shape":"RealTimeInferenceRecommendation"}, - "max":3, - "min":0 - }, - "RealtimeInferenceInstanceTypes":{ - "type":"list", - "member":{"shape":"ProductionVariantInstanceType"} - }, - "RecipeName":{ - "type":"string", - "max":255, - "min":0 - }, - "RecommendationFailureReason":{"type":"string"}, - "RecommendationJobArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:inference-recommendations-job/.*" - }, - "RecommendationJobCompilationJobName":{ - "type":"string", - "max":63, - "min":1, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" - }, - "RecommendationJobCompiledOutputConfig":{ - "type":"structure", - "members":{ - "S3OutputUri":{ - "shape":"S3Uri", - "documentation":"

Identifies the Amazon S3 bucket where you want SageMaker to store the compiled model artifacts.

" - } - }, - "documentation":"

Provides information about the output configuration for the compiled model.

" - }, - "RecommendationJobContainerConfig":{ - "type":"structure", - "members":{ - "Domain":{ - "shape":"String", - "documentation":"

The machine learning domain of the model and its components.

Valid Values: COMPUTER_VISION | NATURAL_LANGUAGE_PROCESSING | MACHINE_LEARNING

" - }, - "Task":{ - "shape":"String", - "documentation":"

The machine learning task that the model accomplishes.

Valid Values: IMAGE_CLASSIFICATION | OBJECT_DETECTION | TEXT_GENERATION | IMAGE_SEGMENTATION | FILL_MASK | CLASSIFICATION | REGRESSION | OTHER

" - }, - "Framework":{ - "shape":"String", - "documentation":"

The machine learning framework of the container image.

Valid Values: TENSORFLOW | PYTORCH | XGBOOST | SAGEMAKER-SCIKIT-LEARN

" - }, - "FrameworkVersion":{ - "shape":"RecommendationJobFrameworkVersion", - "documentation":"

The framework version of the container image.

" - }, - "PayloadConfig":{ - "shape":"RecommendationJobPayloadConfig", - "documentation":"

Specifies the SamplePayloadUrl and all other sample payload-related fields.

" - }, - "NearestModelName":{ - "shape":"String", - "documentation":"

The name of a pre-trained machine learning model benchmarked by Amazon SageMaker Inference Recommender that matches your model.

Valid Values: efficientnetb7 | unet | xgboost | faster-rcnn-resnet101 | nasnetlarge | vgg16 | inception-v3 | mask-rcnn | sagemaker-scikit-learn | densenet201-gluon | resnet18v2-gluon | xception | densenet201 | yolov4 | resnet152 | bert-base-cased | xceptionV1-keras | resnet50 | retinanet

" - }, - "SupportedInstanceTypes":{ - "shape":"RecommendationJobSupportedInstanceTypes", - "documentation":"

A list of the instance types that are used to generate inferences in real-time.

" - }, - "SupportedEndpointType":{ - "shape":"RecommendationJobSupportedEndpointType", - "documentation":"

The endpoint type to receive recommendations for. By default this is null, and the results of the inference recommendation job return a combined list of both real-time and serverless benchmarks. By specifying a value for this field, you can receive a longer list of benchmarks for the desired endpoint type.

" - }, - "DataInputConfig":{ - "shape":"RecommendationJobDataInputConfig", - "documentation":"

Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. This field is used for optimizing your model using SageMaker Neo. For more information, see DataInputConfig.

" - }, - "SupportedResponseMIMETypes":{ - "shape":"RecommendationJobSupportedResponseMIMETypes", - "documentation":"

The supported MIME types for the output data.

" - } - }, - "documentation":"

Specifies mandatory fields for running an Inference Recommender job directly in the CreateInferenceRecommendationsJob API. The fields specified in ContainerConfig override the corresponding fields in the model package. Use ContainerConfig if you want to specify these fields for the recommendation job but don't want to edit them in your model package.

" - }, - "RecommendationJobDataInputConfig":{ - "type":"string", - "max":1024, - "min":1, - "pattern":"[\\S\\s]+" - }, - "RecommendationJobDescription":{ - "type":"string", - "max":128, - "min":0 - }, - "RecommendationJobFrameworkVersion":{ - "type":"string", - "max":10, - "min":3, - "pattern":"[0-9]\\.[A-Za-z0-9.-]+" - }, - "RecommendationJobInferenceBenchmark":{ - "type":"structure", - "required":["ModelConfiguration"], - "members":{ - "Metrics":{"shape":"RecommendationMetrics"}, - "EndpointMetrics":{"shape":"InferenceMetrics"}, - "EndpointConfiguration":{"shape":"EndpointOutputConfiguration"}, - "ModelConfiguration":{"shape":"ModelConfiguration"}, - "FailureReason":{ - "shape":"RecommendationFailureReason", - "documentation":"

The reason why a benchmark failed.

" - }, - "InvocationEndTime":{ - "shape":"InvocationEndTime", - "documentation":"

A timestamp that shows when the benchmark completed.

" - }, - "InvocationStartTime":{ - "shape":"InvocationStartTime", - "documentation":"

A timestamp that shows when the benchmark started.

" - } - }, - "documentation":"

The details for a specific benchmark from an Inference Recommender job.

" - }, - "RecommendationJobInputConfig":{ - "type":"structure", - "members":{ - "ModelPackageVersionArn":{ - "shape":"ModelPackageArn", - "documentation":"

The Amazon Resource Name (ARN) of a versioned model package.

" - }, - "ModelName":{ - "shape":"ModelName", - "documentation":"

The name of the created model.

" - }, - "JobDurationInSeconds":{ - "shape":"JobDurationInSeconds", - "documentation":"

Specifies the maximum duration of the job, in seconds. The maximum value is 18,000 seconds.

" - }, - "TrafficPattern":{ - "shape":"TrafficPattern", - "documentation":"

Specifies the traffic pattern of the job.

" - }, - "ResourceLimit":{ - "shape":"RecommendationJobResourceLimit", - "documentation":"

Defines the resource limit of the job.

" - }, - "EndpointConfigurations":{ - "shape":"EndpointInputConfigurations", - "documentation":"

Specifies the endpoint configuration to use for a job.

" - }, - "VolumeKmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. This key will be passed to SageMaker Hosting for endpoint creation.

The SageMaker execution role must have kms:CreateGrant permission in order to encrypt data on the storage volume of the endpoints created for inference recommendation. The inference recommendation job will fail asynchronously during endpoint configuration creation if the role passed does not have kms:CreateGrant permission.

The KmsKeyId can be any of the following formats:

  • // KMS Key ID

    \"1234abcd-12ab-34cd-56ef-1234567890ab\"

  • // Amazon Resource Name (ARN) of a KMS Key

    \"arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>\"

  • // KMS Key Alias

    \"alias/ExampleAlias\"

  • // Amazon Resource Name (ARN) of a KMS Key Alias

    \"arn:aws:kms:<region>:<account>:alias/<ExampleAlias>\"

For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.

" - }, - "ContainerConfig":{ - "shape":"RecommendationJobContainerConfig", - "documentation":"

Specifies mandatory fields for running an Inference Recommender job. The fields specified in ContainerConfig override the corresponding fields in the model package.

" - }, - "Endpoints":{ - "shape":"Endpoints", - "documentation":"

Existing customer endpoints on which to run an Inference Recommender job.

" - }, - "VpcConfig":{ - "shape":"RecommendationJobVpcConfig", - "documentation":"

Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.

" - } - }, - "documentation":"

The input configuration of the recommendation job.

" - }, - "RecommendationJobName":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}" - }, - "RecommendationJobOutputConfig":{ - "type":"structure", - "members":{ - "KmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt your output artifacts with Amazon S3 server-side encryption. The SageMaker execution role must have kms:GenerateDataKey permission.

The KmsKeyId can be any of the following formats:

  • // KMS Key ID

    \"1234abcd-12ab-34cd-56ef-1234567890ab\"

  • // Amazon Resource Name (ARN) of a KMS Key

    \"arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>\"

  • // KMS Key Alias

    \"alias/ExampleAlias\"

  • // Amazon Resource Name (ARN) of a KMS Key Alias

    \"arn:aws:kms:<region>:<account>:alias/<ExampleAlias>\"

For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.

" - }, - "CompiledOutputConfig":{ - "shape":"RecommendationJobCompiledOutputConfig", - "documentation":"

Provides information about the output configuration for the compiled model.

" - } - }, - "documentation":"

Provides information about the output configuration for the compiled model.

" - }, - "RecommendationJobPayloadConfig":{ - "type":"structure", - "members":{ - "SamplePayloadUrl":{ - "shape":"S3Uri", - "documentation":"

The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

" - }, - "SupportedContentTypes":{ - "shape":"RecommendationJobSupportedContentTypes", - "documentation":"

The supported MIME types for the input data.

" - } - }, - "documentation":"

The configuration for the payload for a recommendation job.

" - }, - "RecommendationJobResourceLimit":{ - "type":"structure", - "members":{ - "MaxNumberOfTests":{ - "shape":"MaxNumberOfTests", - "documentation":"

Defines the maximum number of load tests.

" - }, - "MaxParallelOfTests":{ - "shape":"MaxParallelOfTests", - "documentation":"

Defines the maximum number of parallel load tests.

" - } - }, - "documentation":"

Specifies the maximum number of jobs that can run in parallel and the maximum number of jobs that can run.

" - }, - "RecommendationJobStatus":{ - "type":"string", - "enum":[ - "PENDING", - "IN_PROGRESS", - "COMPLETED", - "FAILED", - "STOPPING", - "STOPPED", - "DELETING", - "DELETED" - ] - }, - "RecommendationJobStoppingConditions":{ - "type":"structure", - "members":{ - "MaxInvocations":{ - "shape":"Integer", - "documentation":"

The maximum number of requests per minute expected for the endpoint.

", - "box":true - }, - "ModelLatencyThresholds":{ - "shape":"ModelLatencyThresholds", - "documentation":"

The interval of time taken by a model to respond as viewed from SageMaker. The interval includes the local communication time taken to send the request and to fetch the response from the container of a model and the time taken to complete the inference in the container.

" - }, - "FlatInvocations":{ - "shape":"FlatInvocations", - "documentation":"

Stops a load test when the number of invocations (TPS) peaks and flattens, which means that the instance has reached capacity. The default value is Stop. If you want the load test to continue after invocations have flattened, set the value to Continue.

" - } - }, - "documentation":"

Specifies conditions for stopping a job. When a job reaches a stopping condition limit, SageMaker ends the job.

" - }, - "RecommendationJobSupportedContentType":{ - "type":"string", - "max":256, - "min":0, - "pattern":".*" - }, - "RecommendationJobSupportedContentTypes":{ - "type":"list", - "member":{"shape":"RecommendationJobSupportedContentType"} - }, - "RecommendationJobSupportedEndpointType":{ - "type":"string", - "enum":[ - "RealTime", - "Serverless" - ] - }, - "RecommendationJobSupportedInstanceTypes":{ - "type":"list", - "member":{"shape":"String"} - }, - "RecommendationJobSupportedResponseMIMEType":{ - "type":"string", - "max":1024, - "min":0, - "pattern":"[-\\w]+\\/.+" - }, - "RecommendationJobSupportedResponseMIMETypes":{ - "type":"list", - "member":{"shape":"RecommendationJobSupportedResponseMIMEType"} - }, - "RecommendationJobType":{ - "type":"string", - "enum":[ - "Default", - "Advanced" - ] - }, - "RecommendationJobVpcConfig":{ - "type":"structure", - "required":[ - "SecurityGroupIds", - "Subnets" - ], - "members":{ - "SecurityGroupIds":{ - "shape":"RecommendationJobVpcSecurityGroupIds", - "documentation":"

The VPC security group IDs. IDs have the form of sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.

" - }, - "Subnets":{ - "shape":"RecommendationJobVpcSubnets", - "documentation":"

The ID of the subnets in the VPC to which you want to connect your model.

" - } - }, - "documentation":"

Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.

" - }, - "RecommendationJobVpcSecurityGroupId":{ - "type":"string", - "max":32, - "min":0, - "pattern":"[-0-9a-zA-Z]+" - }, - "RecommendationJobVpcSecurityGroupIds":{ - "type":"list", - "member":{"shape":"RecommendationJobVpcSecurityGroupId"}, - "max":5, - "min":1 - }, - "RecommendationJobVpcSubnetId":{ - "type":"string", - "max":32, - "min":0, - "pattern":"[-0-9a-zA-Z]+" - }, - "RecommendationJobVpcSubnets":{ - "type":"list", - "member":{"shape":"RecommendationJobVpcSubnetId"}, - "max":16, - "min":1 - }, - "RecommendationMetrics":{ - "type":"structure", - "members":{ - "CostPerHour":{ - "shape":"Float", - "documentation":"

Defines the cost per hour for the instance.

", - "box":true - }, - "CostPerInference":{ - "shape":"Float", - "documentation":"

Defines the cost per inference for the instance .

", - "box":true - }, - "MaxInvocations":{ - "shape":"Integer", - "documentation":"

The expected maximum number of requests per minute for the instance.

", - "box":true - }, - "ModelLatency":{ - "shape":"Integer", - "documentation":"

The expected model latency at maximum invocation per minute for the instance.

", - "box":true - }, - "CpuUtilization":{ - "shape":"UtilizationMetric", - "documentation":"

The expected CPU utilization at maximum invocations per minute for the instance.

NaN indicates that the value is not available.

" - }, - "MemoryUtilization":{ - "shape":"UtilizationMetric", - "documentation":"

The expected memory utilization at maximum invocations per minute for the instance.

NaN indicates that the value is not available.

" - }, - "ModelSetupTime":{ - "shape":"ModelSetupTime", - "documentation":"

The time it takes to launch new compute resources for a serverless endpoint. The time can vary depending on the model size, how long it takes to download the model, and the start-up time of the container.

NaN indicates that the value is not available.

" - } - }, - "documentation":"

The metrics of recommendations.

" - }, - "RecommendationStatus":{ - "type":"string", - "enum":[ - "IN_PROGRESS", - "COMPLETED", - "FAILED", - "NOT_APPLICABLE" - ] - }, - "RecommendationStepType":{ - "type":"string", - "enum":["BENCHMARK"] - }, - "RecordWrapper":{ - "type":"string", - "enum":[ - "None", - "RecordIO" - ] - }, - "RedshiftClusterId":{ - "type":"string", - "documentation":"

The Redshift cluster Identifier.

", - "max":63, - "min":1, - "pattern":".*" - }, - "RedshiftDatabase":{ - "type":"string", - "documentation":"

The name of the Redshift database used in Redshift query execution.

", - "max":64, - "min":1, - "pattern":".*" - }, - "RedshiftDatasetDefinition":{ - "type":"structure", - "required":[ - "ClusterId", - "Database", - "DbUser", - "QueryString", - "ClusterRoleArn", - "OutputS3Uri", - "OutputFormat" - ], - "members":{ - "ClusterId":{"shape":"RedshiftClusterId"}, - "Database":{"shape":"RedshiftDatabase"}, - "DbUser":{"shape":"RedshiftUserName"}, - "QueryString":{"shape":"RedshiftQueryString"}, - "ClusterRoleArn":{ - "shape":"RoleArn", - "documentation":"

The IAM role attached to your Redshift cluster that Amazon SageMaker uses to generate datasets.

" - }, - "OutputS3Uri":{ - "shape":"S3Uri", - "documentation":"

The location in Amazon S3 where the Redshift query results are stored.

" - }, - "KmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data from a Redshift execution.

" - }, - "OutputFormat":{"shape":"RedshiftResultFormat"}, - "OutputCompression":{"shape":"RedshiftResultCompressionType"} - }, - "documentation":"

Configuration for Redshift Dataset Definition input.

" - }, - "RedshiftQueryString":{ - "type":"string", - "documentation":"

The SQL query statements to be executed.

", - "max":4096, - "min":1, - "pattern":"[\\s\\S]+" - }, - "RedshiftResultCompressionType":{ - "type":"string", - "documentation":"

The compression used for Redshift query results.

", - "enum":[ - "None", - "GZIP", - "BZIP2", - "ZSTD", - "SNAPPY" - ] - }, - "RedshiftResultFormat":{ - "type":"string", - "documentation":"

The data storage format for Redshift query results.

", - "enum":[ - "PARQUET", - "CSV" - ] - }, - "RedshiftUserName":{ - "type":"string", - "documentation":"

The database user name used in Redshift query execution.

", - "max":128, - "min":1, - "pattern":".*" - }, - "ReferenceMinVersion":{ - "type":"string", - "max":14, - "min":5, - "pattern":"\\d{1,4}.\\d{1,4}.\\d{1,4}" - }, - "RegionName":{ - "type":"string", - "max":24, - "min":1 - }, - "RegisterDevicesRequest":{ - "type":"structure", - "required":[ - "DeviceFleetName", - "Devices" - ], - "members":{ - "DeviceFleetName":{ - "shape":"EntityName", - "documentation":"

The name of the fleet.

" - }, - "Devices":{ - "shape":"Devices", - "documentation":"

A list of devices to register with SageMaker Edge Manager.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The tags associated with devices.

" - } - } - }, - "RegisterModelStepMetadata":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"String256", - "documentation":"

The Amazon Resource Name (ARN) of the model package.

" - } - }, - "documentation":"

Metadata for a register model job step.

" - }, - "Relation":{ - "type":"string", - "enum":[ - "EqualTo", - "GreaterThanOrEqualTo" - ] - }, - "ReleaseNotes":{ - "type":"string", - "max":255, - "min":1, - "pattern":".*" - }, - "ReleaseNotesList":{ - "type":"list", - "member":{"shape":"String1024"}, - "max":10, - "min":0 - }, - "RemoteDebugConfig":{ - "type":"structure", - "members":{ - "EnableRemoteDebug":{ - "shape":"EnableRemoteDebug", - "documentation":"

If set to True, enables remote debugging.

" - } - }, - "documentation":"

Configuration for remote debugging for the CreateTrainingJob API. To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.

" - }, - "RemoteDebugConfigForUpdate":{ - "type":"structure", - "members":{ - "EnableRemoteDebug":{ - "shape":"EnableRemoteDebug", - "documentation":"

If set to True, enables remote debugging.

" - } - }, - "documentation":"

Configuration for remote debugging for the UpdateTrainingJob API. To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.

" - }, - "RenderUiTemplateRequest":{ - "type":"structure", - "required":[ - "Task", - "RoleArn" - ], - "members":{ - "UiTemplate":{ - "shape":"UiTemplate", - "documentation":"

A Template object containing the worker UI template to render.

" - }, - "Task":{ - "shape":"RenderableTask", - "documentation":"

A RenderableTask object containing a representative task to render.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the template.

" - }, - "HumanTaskUiArn":{ - "shape":"HumanTaskUiArn", - "documentation":"

The HumanTaskUiArn of the worker UI that you want to render. Do not provide a HumanTaskUiArn if you use the UiTemplate parameter.

See a list of available Human Ui Amazon Resource Names (ARNs) in UiConfig.

" - } - } - }, - "RenderUiTemplateResponse":{ - "type":"structure", - "required":[ - "RenderedContent", - "Errors" - ], - "members":{ - "RenderedContent":{ - "shape":"String", - "documentation":"

A Liquid template that renders the HTML for the worker UI.

" - }, - "Errors":{ - "shape":"RenderingErrorList", - "documentation":"

A list of one or more RenderingError objects if any were encountered while rendering the template. If there were no errors, the list is empty.

" - } - } - }, - "RenderableTask":{ - "type":"structure", - "required":["Input"], - "members":{ - "Input":{ - "shape":"TaskInput", - "documentation":"

A JSON object that contains values for the variables defined in the template. It is made available to the template under the substitution variable task.input. For example, if you define a variable task.input.text in your template, you can supply the variable in the JSON object as \"text\": \"sample text\".

" - } - }, - "documentation":"

Contains input values for a task.

" - }, - "RenderingError":{ - "type":"structure", - "required":[ - "Code", - "Message" - ], - "members":{ - "Code":{ - "shape":"String", - "documentation":"

A unique identifier for a specific class of errors.

" - }, - "Message":{ - "shape":"String", - "documentation":"

A human-readable message describing the error.

" - } - }, - "documentation":"

A description of an error that occurred while rendering the template.

" - }, - "RenderingErrorList":{ - "type":"list", - "member":{"shape":"RenderingError"} - }, - "RepositoryAccessMode":{ - "type":"string", - "enum":[ - "Platform", - "Vpc" - ] - }, - "RepositoryAuthConfig":{ - "type":"structure", - "required":["RepositoryCredentialsProviderArn"], - "members":{ - "RepositoryCredentialsProviderArn":{ - "shape":"RepositoryCredentialsProviderArn", - "documentation":"

The Amazon Resource Name (ARN) of an Amazon Web Services Lambda function that provides credentials to authenticate to the private Docker registry where your model image is hosted. For information about how to create an Amazon Web Services Lambda function, see Create a Lambda function with the console in the Amazon Web Services Lambda Developer Guide.

" - } - }, - "documentation":"

Specifies an authentication configuration for the private docker registry where your model image is hosted. Specify a value for this property only if you specified Vpc as the value for the RepositoryAccessMode field of the ImageConfig object that you passed to a call to CreateModel and the private Docker registry where the model image is hosted requires authentication.

" - }, - "RepositoryCredentialsProviderArn":{ - "type":"string", - "max":2048, - "min":1, - "pattern":".*" - }, - "RepositoryUrl":{ - "type":"string", - "max":1024, - "min":0, - "pattern":"https://([.\\-_a-zA-Z0-9]+/?){3,1016}" - }, - "ReservedCapacityArn":{ - "type":"string", - "max":2048, - "min":50, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:reserved-capacity/.*" - }, - "ReservedCapacityDurationHours":{ - "type":"long", - "box":true, - "max":87600, - "min":0 - }, - "ReservedCapacityDurationMinutes":{ - "type":"long", - "box":true, - "max":59, - "min":0 - }, - "ReservedCapacityInstanceCount":{ - "type":"integer", - "max":256, - "min":0 - }, - "ReservedCapacityInstanceType":{ - "type":"string", - "enum":[ - "ml.p4d.24xlarge", - "ml.p5.48xlarge", - "ml.p5e.48xlarge", - "ml.p5en.48xlarge", - "ml.trn1.32xlarge", - "ml.trn2.48xlarge", - "ml.p6-b200.48xlarge", - "ml.p4de.24xlarge", - "ml.p6e-gb200.36xlarge", - "ml.p5.4xlarge", - "ml.p6-b300.48xlarge" - ] - }, - "ReservedCapacityOffering":{ - "type":"structure", - "required":[ - "InstanceType", - "InstanceCount" - ], - "members":{ - "ReservedCapacityType":{ - "shape":"ReservedCapacityType", - "documentation":"

The type of reserved capacity offering.

" - }, - "UltraServerType":{ - "shape":"UltraServerType", - "documentation":"

The type of UltraServer included in this reserved capacity offering, such as ml.u-p6e-gb200x72.

" - }, - "UltraServerCount":{ - "shape":"UltraServerCount", - "documentation":"

The number of UltraServers included in this reserved capacity offering.

" - }, - "InstanceType":{ - "shape":"ReservedCapacityInstanceType", - "documentation":"

The instance type for the reserved capacity offering.

" - }, - "InstanceCount":{ - "shape":"ReservedCapacityInstanceCount", - "documentation":"

The number of instances in the reserved capacity offering.

", - "box":true - }, - "AvailabilityZone":{ - "shape":"AvailabilityZone", - "documentation":"

The availability zone for the reserved capacity offering.

" - }, - "DurationHours":{ - "shape":"ReservedCapacityDurationHours", - "documentation":"

The number of whole hours in the total duration for this reserved capacity offering.

" - }, - "DurationMinutes":{ - "shape":"ReservedCapacityDurationMinutes", - "documentation":"

The additional minutes beyond whole hours in the total duration for this reserved capacity offering.

" - }, - "StartTime":{ - "shape":"Timestamp", - "documentation":"

The start time of the reserved capacity offering.

" - }, - "EndTime":{ - "shape":"Timestamp", - "documentation":"

The end time of the reserved capacity offering.

" - }, - "ExtensionStartTime":{ - "shape":"Timestamp", - "documentation":"

The start time of the extension for the reserved capacity offering.

" - }, - "ExtensionEndTime":{ - "shape":"Timestamp", - "documentation":"

The end time of the extension for the reserved capacity offering.

" - } - }, - "documentation":"

Details about a reserved capacity offering for a training plan offering.

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

" - }, - "ReservedCapacityOfferings":{ - "type":"list", - "member":{"shape":"ReservedCapacityOffering"}, - "max":5, - "min":0 - }, - "ReservedCapacityStatus":{ - "type":"string", - "enum":[ - "Pending", - "Active", - "Scheduled", - "Expired", - "Failed" - ] - }, - "ReservedCapacitySummaries":{ - "type":"list", - "member":{"shape":"ReservedCapacitySummary"}, - "max":5, - "min":0 - }, - "ReservedCapacitySummary":{ - "type":"structure", - "required":[ - "ReservedCapacityArn", - "InstanceType", - "TotalInstanceCount", - "Status" - ], - "members":{ - "ReservedCapacityArn":{ - "shape":"ReservedCapacityArn", - "documentation":"

The Amazon Resource Name (ARN); of the reserved capacity.

" - }, - "ReservedCapacityType":{ - "shape":"ReservedCapacityType", - "documentation":"

The type of reserved capacity.

" - }, - "UltraServerType":{ - "shape":"UltraServerType", - "documentation":"

The type of UltraServer included in this reserved capacity, such as ml.u-p6e-gb200x72.

" - }, - "UltraServerCount":{ - "shape":"UltraServerCount", - "documentation":"

The number of UltraServers included in this reserved capacity.

" - }, - "InstanceType":{ - "shape":"ReservedCapacityInstanceType", - "documentation":"

The instance type for the reserved capacity.

" - }, - "TotalInstanceCount":{ - "shape":"TotalInstanceCount", - "documentation":"

The total number of instances in the reserved capacity.

" - }, - "Status":{ - "shape":"ReservedCapacityStatus", - "documentation":"

The current status of the reserved capacity.

" - }, - "AvailabilityZone":{ - "shape":"AvailabilityZone", - "documentation":"

The availability zone for the reserved capacity.

" - }, - "AvailabilityZoneId":{ - "shape":"AvailabilityZoneId", - "documentation":"

The Availability Zone ID of the reserved capacity.

" - }, - "DurationHours":{ - "shape":"ReservedCapacityDurationHours", - "documentation":"

The number of whole hours in the total duration for this reserved capacity.

" - }, - "DurationMinutes":{ - "shape":"ReservedCapacityDurationMinutes", - "documentation":"

The additional minutes beyond whole hours in the total duration for this reserved capacity.

" - }, - "StartTime":{ - "shape":"Timestamp", - "documentation":"

The start time of the reserved capacity.

" - }, - "EndTime":{ - "shape":"Timestamp", - "documentation":"

The end time of the reserved capacity.

" - } - }, - "documentation":"

Details of a reserved capacity for the training plan.

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

" - }, - "ReservedCapacityType":{ - "type":"string", - "enum":[ - "UltraServer", - "Instance" - ] - }, - "ResolvedAttributes":{ - "type":"structure", - "members":{ - "AutoMLJobObjective":{"shape":"AutoMLJobObjective"}, - "ProblemType":{ - "shape":"ProblemType", - "documentation":"

The problem type.

" - }, - "CompletionCriteria":{"shape":"AutoMLJobCompletionCriteria"} - }, - "documentation":"

The resolved attributes.

" - }, - "ResourceArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[a-z-]*:sagemaker:[a-z0-9-]*:[0-9]{12}:.+" - }, - "ResourceCatalog":{ - "type":"structure", - "required":[ - "ResourceCatalogArn", - "ResourceCatalogName", - "Description", - "CreationTime" - ], - "members":{ - "ResourceCatalogArn":{ - "shape":"ResourceCatalogArn", - "documentation":"

The Amazon Resource Name (ARN) of the ResourceCatalog.

" - }, - "ResourceCatalogName":{ - "shape":"ResourceCatalogName", - "documentation":"

The name of the ResourceCatalog.

" - }, - "Description":{ - "shape":"ResourceCatalogDescription", - "documentation":"

A free form description of the ResourceCatalog.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The time the ResourceCatalog was created.

" - } - }, - "documentation":"

A resource catalog containing all of the resources of a specific resource type within a resource owner account. For an example on sharing the Amazon SageMaker Feature Store DefaultFeatureGroupCatalog, see Share Amazon SageMaker Catalog resource type in the Amazon SageMaker Developer Guide.

" - }, - "ResourceCatalogArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:sagemaker-catalog/.*" - }, - "ResourceCatalogDescription":{ - "type":"string", - "max":256, - "min":0 - }, - "ResourceCatalogList":{ - "type":"list", - "member":{"shape":"ResourceCatalog"} - }, - "ResourceCatalogName":{ - "type":"string", - "max":64, - "min":1 - }, - "ResourceCatalogSortBy":{ - "type":"string", - "enum":["CreationTime"] - }, - "ResourceCatalogSortOrder":{ - "type":"string", - "enum":[ - "Ascending", - "Descending" - ] - }, - "ResourceConfig":{ - "type":"structure", - "members":{ - "InstanceType":{ - "shape":"TrainingInstanceType", - "documentation":"

The ML compute instance type.

" - }, - "InstanceCount":{ - "shape":"TrainingInstanceCount", - "documentation":"

The number of ML compute instances to use. For distributed training, provide a value greater than 1.

", - "box":true - }, - "VolumeSizeInGB":{ - "shape":"OptionalVolumeSizeInGB", - "documentation":"

The size of the ML storage volume that you want to provision.

SageMaker automatically selects the volume size for serverless training jobs. You cannot customize this setting.

ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose File as the TrainingInputMode in the algorithm specification.

When using an ML instance with NVMe SSD volumes, SageMaker doesn't provision Amazon EBS General Purpose SSD (gp2) storage. Available storage is fixed to the NVMe-type instance's storage capacity. SageMaker configures storage paths for training datasets, checkpoints, model artifacts, and outputs to use the entire capacity of the instance storage. For example, ML instance families with the NVMe-type instance storage include ml.p4d, ml.g4dn, and ml.g5.

When using an ML instance with the EBS-only storage option and without instance storage, you must define the size of EBS volume through VolumeSizeInGB in the ResourceConfig API. For example, ML instance families that use EBS volumes include ml.c5 and ml.p2.

To look up instance types and their instance storage types and volumes, see Amazon EC2 Instance Types.

To find the default local paths defined by the SageMaker training platform, see Amazon SageMaker Training Storage Folders for Training Datasets, Checkpoints, Model Artifacts, and Outputs.

", - "box":true - }, - "VolumeKmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The Amazon Web Services KMS key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job.

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage.

For a list of instance types that support local instance storage, see Instance Store Volumes.

For more information about local instance storage encryption, see SSD Instance Store Volumes.

The VolumeKmsKeyId can be in any of the following formats:

  • // KMS Key ID

    \"1234abcd-12ab-34cd-56ef-1234567890ab\"

  • // Amazon Resource Name (ARN) of a KMS Key

    \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

" - }, - "KeepAlivePeriodInSeconds":{ - "shape":"KeepAlivePeriodInSeconds", - "documentation":"

The duration of time in seconds to retain configured resources in a warm pool for subsequent training jobs.

" - }, - "InstanceGroups":{ - "shape":"InstanceGroups", - "documentation":"

The configuration of a heterogeneous cluster in JSON format.

" - }, - "TrainingPlanArn":{ - "shape":"TrainingPlanArn", - "documentation":"

The Amazon Resource Name (ARN); of the training plan to use for this resource configuration.

" - }, - "InstancePlacementConfig":{ - "shape":"InstancePlacementConfig", - "documentation":"

Configuration for how training job instances are placed and allocated within UltraServers. Only applicable for UltraServer capacity.

" - } - }, - "documentation":"

Describes the resources, including machine learning (ML) compute instances and ML storage volumes, to use for model training.

" - }, - "ResourceConfigForUpdate":{ - "type":"structure", - "required":["KeepAlivePeriodInSeconds"], - "members":{ - "KeepAlivePeriodInSeconds":{ - "shape":"KeepAlivePeriodInSeconds", - "documentation":"

The KeepAlivePeriodInSeconds value specified in the ResourceConfig to update.

" - } - }, - "documentation":"

The ResourceConfig to update KeepAlivePeriodInSeconds. Other fields in the ResourceConfig cannot be updated.

" - }, - "ResourceId":{ - "type":"string", - "max":32, - "min":0 - }, - "ResourceIdentifier":{ - "type":"string", - "max":256, - "min":1, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:.*\\/.*" - }, - "ResourceInUse":{ - "type":"structure", - "members":{ - "Message":{"shape":"FailureReason"} - }, - "documentation":"

Resource being accessed is in use.

", - "exception":true - }, - "ResourceLimitExceeded":{ - "type":"structure", - "members":{ - "Message":{"shape":"FailureReason"} - }, - "documentation":"

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

", - "exception":true - }, - "ResourceLimits":{ - "type":"structure", - "required":["MaxParallelTrainingJobs"], - "members":{ - "MaxNumberOfTrainingJobs":{ - "shape":"MaxNumberOfTrainingJobs", - "documentation":"

The maximum number of training jobs that a hyperparameter tuning job can launch.

" - }, - "MaxParallelTrainingJobs":{ - "shape":"MaxParallelTrainingJobs", - "documentation":"

The maximum number of concurrent training jobs that a hyperparameter tuning job can launch.

", - "box":true - }, - "MaxRuntimeInSeconds":{ - "shape":"HyperParameterTuningMaxRuntimeInSeconds", - "documentation":"

The maximum time in seconds that a hyperparameter tuning job can run.

" - } - }, - "documentation":"

Specifies the maximum number of training jobs and parallel training jobs that a hyperparameter tuning job can launch.

" - }, - "ResourceNotFound":{ - "type":"structure", - "members":{ - "Message":{"shape":"FailureReason"} - }, - "documentation":"

Resource being access is not found.

", - "exception":true - }, - "ResourcePolicyString":{ - "type":"string", - "max":20480, - "min":0, - "pattern":".*(?:[ \\r\\n\\t].*)*" - }, - "ResourcePropertyName":{ - "type":"string", - "max":255, - "min":1, - "pattern":".+" - }, - "ResourceRetainedBillableTimeInSeconds":{ - "type":"integer", - "documentation":"

Optional. Indicates how many seconds the resource stayed in ResourceRetained state. Populated only after resource reaches ResourceReused or ResourceReleased state.

", - "box":true, - "min":0 - }, - "ResourceSharingConfig":{ - "type":"structure", - "required":["Strategy"], - "members":{ - "Strategy":{ - "shape":"ResourceSharingStrategy", - "documentation":"

The strategy of how idle compute is shared within the cluster. The following are the options of strategies.

  • DontLend: entities do not lend idle compute.

  • Lend: entities can lend idle compute to entities that can borrow.

  • LendandBorrow: entities can lend idle compute and borrow idle compute from other entities.

Default is LendandBorrow.

" - }, - "BorrowLimit":{ - "shape":"BorrowLimit", - "documentation":"

The limit on how much idle compute can be borrowed.The values can be 1 - 500 percent of idle compute that the team is allowed to borrow.

Default is 50.

" - }, - "AbsoluteBorrowLimits":{ - "shape":"AbsoluteBorrowLimitResourceList", - "documentation":"

The absolute limits on compute resources that can be borrowed from idle compute. When specified, these limits define the maximum amount of specific resource types (such as accelerators, vCPU, or memory) that an entity can borrow, regardless of the percentage-based BorrowLimit.

" - } - }, - "documentation":"

Resource sharing configuration.

" - }, - "ResourceSharingStrategy":{ - "type":"string", - "enum":[ - "Lend", - "DontLend", - "LendAndBorrow" - ] - }, - "ResourceSpec":{ - "type":"structure", - "members":{ - "SageMakerImageArn":{ - "shape":"ImageArn", - "documentation":"

The ARN of the SageMaker AI image that the image version belongs to.

" - }, - "SageMakerImageVersionArn":{ - "shape":"ImageVersionArn", - "documentation":"

The ARN of the image version created on the instance. To clear the value set for SageMakerImageVersionArn, pass None as the value.

" - }, - "SageMakerImageVersionAlias":{ - "shape":"ImageVersionAlias", - "documentation":"

The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.

" - }, - "InstanceType":{ - "shape":"AppInstanceType", - "documentation":"

The instance type that the image version runs on.

JupyterServer apps only support the system value.

For KernelGateway apps, the system value is translated to ml.t3.medium. KernelGateway apps also support all other values for available instance types.

" - }, - "LifecycleConfigArn":{ - "shape":"StudioLifecycleConfigArn", - "documentation":"

The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

" - }, - "TrainingPlanArn":{ - "shape":"StudioResourceSpecTrainingPlanArn", - "documentation":"

The ARN of the SageMaker AI Training Plan to use for this app. When you specify a training plan, the app launches on reserved GPU capacity. This field is supported for JupyterLab and CodeEditor app types.

For more information about how to reserve GPU capacity with SageMaker AI Training Plans, see Using training plans in Studio applications.

" - } - }, - "documentation":"

Specifies the ARN's of a SageMaker AI image and SageMaker AI image version, and the instance type that the version runs on.

When both SageMakerImageVersionArn and SageMakerImageArn are passed, SageMakerImageVersionArn is used. Any updates to SageMakerImageArn will not take effect if SageMakerImageVersionArn already exists in the ResourceSpec because SageMakerImageVersionArn always takes precedence. To clear the value set for SageMakerImageVersionArn, pass None as the value.

" - }, - "ResourceType":{ - "type":"string", - "enum":[ - "TrainingJob", - "Experiment", - "ExperimentTrial", - "ExperimentTrialComponent", - "Endpoint", - "Model", - "ModelPackage", - "ModelPackageGroup", - "Pipeline", - "PipelineExecution", - "FeatureGroup", - "FeatureMetadata", - "Image", - "ImageVersion", - "Project", - "HyperParameterTuningJob", - "ModelCard", - "PipelineVersion", - "Job" - ] - }, - "ResponseMIMEType":{ - "type":"string", - "max":1024, - "min":0, - "pattern":"[-\\w]+\\/.+" - }, - "ResponseMIMETypes":{ - "type":"list", - "member":{"shape":"ResponseMIMEType"} - }, - "RetentionPolicy":{ - "type":"structure", - "members":{ - "HomeEfsFileSystem":{ - "shape":"RetentionType", - "documentation":"

The default is Retain, which specifies to keep the data stored on the Amazon EFS volume.

Specify Delete to delete the data stored on the Amazon EFS volume.

" - } - }, - "documentation":"

The retention policy for data stored on an Amazon Elastic File System volume.

" - }, - "RetentionType":{ - "type":"string", - "enum":[ - "Retain", - "Delete" - ] - }, - "RetryPipelineExecutionRequest":{ - "type":"structure", - "required":[ - "PipelineExecutionArn", - "ClientRequestToken" - ], - "members":{ - "PipelineExecutionArn":{ - "shape":"PipelineExecutionArn", - "documentation":"

The Amazon Resource Name (ARN) of the pipeline execution.

" - }, - "ClientRequestToken":{ - "shape":"IdempotencyToken", - "documentation":"

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.

", - "idempotencyToken":true - }, - "ParallelismConfiguration":{ - "shape":"ParallelismConfiguration", - "documentation":"

This configuration, if specified, overrides the parallelism configuration of the parent pipeline.

" - } - } - }, - "RetryPipelineExecutionResponse":{ - "type":"structure", - "members":{ - "PipelineExecutionArn":{ - "shape":"PipelineExecutionArn", - "documentation":"

The Amazon Resource Name (ARN) of the pipeline execution.

" - } - } - }, - "RetryStrategy":{ - "type":"structure", - "required":["MaximumRetryAttempts"], - "members":{ - "MaximumRetryAttempts":{ - "shape":"MaximumRetryAttempts", - "documentation":"

The number of times to retry the job. When the job is retried, it's SecondaryStatus is changed to STARTING.

", - "box":true - } - }, - "documentation":"

The retry strategy to use when a training job fails due to an InternalServerError. RetryStrategy is specified as part of the CreateTrainingJob and CreateHyperParameterTuningJob requests. You can add the StoppingCondition parameter to the request to limit the training time for the complete job.

" - }, - "RoleArn":{ - "type":"string", - "max":2048, - "min":20, - "pattern":"arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+" - }, - "RoleGroupAssignment":{ - "type":"structure", - "required":[ - "RoleName", - "GroupPatterns" - ], - "members":{ - "RoleName":{ - "shape":"NonEmptyString256", - "documentation":"

The name of the in-app role within the SageMaker Partner AI App. The specific roles available depend on the app type and version.

" - }, - "GroupPatterns":{ - "shape":"GroupPatternsList", - "documentation":"

A list of Amazon Web Services IAM Identity Center group patterns that should be assigned to the specified role. Group patterns support wildcard matching using *.

" - } - }, - "documentation":"

Defines the mapping between an in-app role and the Amazon Web Services IAM Identity Center group patterns that should be assigned to that role within the SageMaker Partner AI App.

" - }, - "RoleGroupAssignmentsList":{ - "type":"list", - "member":{"shape":"RoleGroupAssignment"}, - "max":10, - "min":0 - }, - "RollingDeploymentPolicy":{ - "type":"structure", - "required":["MaximumBatchSize"], - "members":{ - "MaximumBatchSize":{ - "shape":"CapacitySizeConfig", - "documentation":"

The maximum amount of instances in the cluster that SageMaker can update at a time.

" - }, - "RollbackMaximumBatchSize":{ - "shape":"CapacitySizeConfig", - "documentation":"

The maximum amount of instances in the cluster that SageMaker can roll back at a time.

" - } - }, - "documentation":"

The configurations that SageMaker uses when updating the AMI versions.

" - }, - "RollingUpdatePolicy":{ - "type":"structure", - "required":[ - "MaximumBatchSize", - "WaitIntervalInSeconds" - ], - "members":{ - "MaximumBatchSize":{ - "shape":"CapacitySize", - "documentation":"

Batch size for each rolling step to provision capacity and turn on traffic on the new endpoint fleet, and terminate capacity on the old endpoint fleet. Value must be between 5% to 50% of the variant's total instance count.

" - }, - "WaitIntervalInSeconds":{ - "shape":"WaitIntervalInSeconds", - "documentation":"

The length of the baking period, during which SageMaker monitors alarms for each batch on the new fleet.

" - }, - "MaximumExecutionTimeoutInSeconds":{ - "shape":"MaximumExecutionTimeoutInSeconds", - "documentation":"

The time limit for the total deployment. Exceeding this limit causes a timeout.

" - }, - "RollbackMaximumBatchSize":{ - "shape":"CapacitySize", - "documentation":"

Batch size for rollback to the old endpoint fleet. Each rolling step to provision capacity and turn on traffic on the old endpoint fleet, and terminate capacity on the new endpoint fleet. If this field is absent, the default value will be set to 100% of total capacity which means to bring up the whole capacity of the old fleet at once during rollback.

" - } - }, - "documentation":"

Specifies a rolling deployment strategy for updating a SageMaker endpoint.

" - }, - "RootAccess":{ - "type":"string", - "enum":[ - "Enabled", - "Disabled" - ] - }, - "RoutingStrategy":{ - "type":"string", - "enum":[ - "LEAST_OUTSTANDING_REQUESTS", - "RANDOM" - ] - }, - "RuleConfigurationName":{ - "type":"string", - "max":256, - "min":1, - "pattern":".*" - }, - "RuleEvaluationStatus":{ - "type":"string", - "enum":[ - "InProgress", - "NoIssuesFound", - "IssuesFound", - "Error", - "Stopping", - "Stopped" - ] - }, - "RuleParameters":{ - "type":"map", - "key":{"shape":"ConfigKey"}, - "value":{"shape":"ConfigValue"}, - "max":100, - "min":0 - }, - "S3DataDistribution":{ - "type":"string", - "enum":[ - "FullyReplicated", - "ShardedByS3Key" - ] - }, - "S3DataSource":{ - "type":"structure", - "required":[ - "S3DataType", - "S3Uri" - ], - "members":{ - "S3DataType":{ - "shape":"S3DataType", - "documentation":"

If you choose S3Prefix, S3Uri identifies a key name prefix. SageMaker uses all objects that match the specified key name prefix for model training.

If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want SageMaker to use for model training.

If you choose AugmentedManifestFile, S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. AugmentedManifestFile can only be used if the Channel's input mode is Pipe.

If you choose Converse, S3Uri identifies an Amazon S3 location that contains data formatted according to Converse format. This format structures conversational messages with specific roles and content types used for training and fine-tuning foundational models.

" - }, - "S3Uri":{ - "shape":"S3Uri", - "documentation":"

Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:

  • A key name prefix might look like this: s3://bucketname/exampleprefix/

  • A manifest might look like this: s3://bucketname/example.manifest

    A manifest is an S3 object which is a JSON file consisting of an array of elements. The first element is a prefix which is followed by one or more suffixes. SageMaker appends the suffix elements to the prefix to get a full set of S3Uri. Note that the prefix must be a valid non-empty S3Uri that precludes users from specifying a manifest whose individual S3Uri is sourced from different S3 buckets.

    The following code example shows a valid manifest format:

    [ {\"prefix\": \"s3://customer_bucket/some/prefix/\"},

    \"relative/path/to/custdata-1\",

    \"relative/path/custdata-2\",

    ...

    \"relative/path/custdata-N\"

    ]

    This JSON is equivalent to the following S3Uri list:

    s3://customer_bucket/some/prefix/relative/path/to/custdata-1

    s3://customer_bucket/some/prefix/relative/path/custdata-2

    ...

    s3://customer_bucket/some/prefix/relative/path/custdata-N

    The complete set of S3Uri in this manifest is the input data for the channel for this data source. The object that each S3Uri points to must be readable by the IAM role that SageMaker uses to perform tasks on your behalf.

Your input bucket must be located in same Amazon Web Services region as your training job.

" - }, - "S3DataDistributionType":{ - "shape":"S3DataDistribution", - "documentation":"

If you want SageMaker to replicate the entire dataset on each ML compute instance that is launched for model training, specify FullyReplicated.

If you want SageMaker to replicate a subset of data on each ML compute instance that is launched for model training, specify ShardedByS3Key. If there are n ML compute instances launched for a training job, each instance gets approximately 1/n of the number of S3 objects. In this case, model training on each machine uses only the subset of training data.

Don't choose more ML compute instances for training than available S3 objects. If you do, some nodes won't get any data and you will pay for nodes that aren't getting any training data. This applies in both File and Pipe modes. Keep this in mind when developing algorithms.

In distributed training, where you use multiple ML compute EC2 instances, you might choose ShardedByS3Key. If the algorithm requires copying training data to the ML storage volume (when TrainingInputMode is set to File), this copies 1/n of the number of objects.

" - }, - "AttributeNames":{ - "shape":"AttributeNames", - "documentation":"

A list of one or more attribute names to use that are found in a specified augmented manifest file.

" - }, - "InstanceGroupNames":{ - "shape":"InstanceGroupNames", - "documentation":"

A list of names of instance groups that get data from the S3 data source.

" - }, - "ModelAccessConfig":{"shape":"ModelAccessConfig"}, - "HubAccessConfig":{ - "shape":"HubAccessConfig", - "documentation":"

The configuration for a private hub model reference that points to a SageMaker JumpStart public hub model.

" - } - }, - "documentation":"

Describes the S3 data source.

Your input bucket must be in the same Amazon Web Services region as your training job.

" - }, - "S3DataType":{ - "type":"string", - "enum":[ - "ManifestFile", - "S3Prefix", - "AugmentedManifestFile", - "Converse" - ] - }, - "S3FileSystem":{ - "type":"structure", - "required":["S3Uri"], - "members":{ - "S3Uri":{ - "shape":"S3SchemaUri", - "documentation":"

The Amazon S3 URI that specifies the location in S3 where files are stored, which is mounted within the Studio environment. For example: s3://<bucket-name>/<prefix>/.

" - } - }, - "documentation":"

A custom file system in Amazon S3. This is only supported in Amazon SageMaker Unified Studio.

" - }, - "S3FileSystemConfig":{ - "type":"structure", - "required":["S3Uri"], - "members":{ - "MountPath":{ - "shape":"String1024", - "documentation":"

The file system path where the Amazon S3 storage location will be mounted within the Amazon SageMaker Studio environment.

" - }, - "S3Uri":{ - "shape":"S3SchemaUri", - "documentation":"

The Amazon S3 URI of the S3 file system configuration.

" - } - }, - "documentation":"

Configuration for the custom Amazon S3 file system.

" - }, - "S3ModelDataSource":{ - "type":"structure", - "required":[ - "S3Uri", - "S3DataType", - "CompressionType" - ], - "members":{ - "S3Uri":{ - "shape":"S3ModelUri", - "documentation":"

Specifies the S3 path of ML model data to deploy.

" - }, - "S3DataType":{ - "shape":"S3ModelDataType", - "documentation":"

Specifies the type of ML model data to deploy.

If you choose S3Prefix, S3Uri identifies a key name prefix. SageMaker uses all objects that match the specified key name prefix as part of the ML model data to deploy. A valid key name prefix identified by S3Uri always ends with a forward slash (/).

If you choose S3Object, S3Uri identifies an object that is the ML model data to deploy.

" - }, - "CompressionType":{ - "shape":"ModelCompressionType", - "documentation":"

Specifies how the ML model data is prepared.

If you choose Gzip and choose S3Object as the value of S3DataType, S3Uri identifies an object that is a gzip-compressed TAR archive. SageMaker will attempt to decompress and untar the object during model deployment.

If you choose None and chooose S3Object as the value of S3DataType, S3Uri identifies an object that represents an uncompressed ML model to deploy.

If you choose None and choose S3Prefix as the value of S3DataType, S3Uri identifies a key name prefix, under which all objects represents the uncompressed ML model to deploy.

If you choose None, then SageMaker will follow rules below when creating model data files under /opt/ml/model directory for use by your inference code:

  • If you choose S3Object as the value of S3DataType, then SageMaker will split the key of the S3 object referenced by S3Uri by slash (/), and use the last part as the filename of the file holding the content of the S3 object.

  • If you choose S3Prefix as the value of S3DataType, then for each S3 object under the key name pefix referenced by S3Uri, SageMaker will trim its key by the prefix, and use the remainder as the path (relative to /opt/ml/model) of the file holding the content of the S3 object. SageMaker will split the remainder by slash (/), using intermediate parts as directory names and the last part as filename of the file holding the content of the S3 object.

  • Do not use any of the following as file names or directory names:

    • An empty or blank string

    • A string which contains null bytes

    • A string longer than 255 bytes

    • A single dot (.)

    • A double dot (..)

  • Ambiguous file names will result in model deployment failure. For example, if your uncompressed ML model consists of two S3 objects s3://mybucket/model/weights and s3://mybucket/model/weights/part1 and you specify s3://mybucket/model/ as the value of S3Uri and S3Prefix as the value of S3DataType, then it will result in name clash between /opt/ml/model/weights (a regular file) and /opt/ml/model/weights/ (a directory).

  • Do not organize the model artifacts in S3 console using folders. When you create a folder in S3 console, S3 creates a 0-byte object with a key set to the folder name you provide. They key of the 0-byte object ends with a slash (/) which violates SageMaker restrictions on model artifact file names, leading to model deployment failure.

" - }, - "ModelAccessConfig":{ - "shape":"ModelAccessConfig", - "documentation":"

Specifies the access configuration file for the ML model. You can explicitly accept the model end-user license agreement (EULA) within the ModelAccessConfig. You are responsible for reviewing and complying with any applicable license terms and making sure they are acceptable for your use case before downloading or using a model.

" - }, - "HubAccessConfig":{ - "shape":"InferenceHubAccessConfig", - "documentation":"

Configuration information for hub access.

" - }, - "ManifestS3Uri":{ - "shape":"S3ModelUri", - "documentation":"

The Amazon S3 URI of the manifest file. The manifest file is a CSV file that stores the artifact locations.

" - }, - "ETag":{ - "shape":"String", - "documentation":"

The ETag associated with S3 URI.

" - }, - "ManifestEtag":{ - "shape":"String", - "documentation":"

The ETag associated with Manifest S3 URI.

" - } - }, - "documentation":"

Specifies the S3 location of ML model data to deploy.

" - }, - "S3ModelDataType":{ - "type":"string", - "enum":[ - "S3Prefix", - "S3Object" - ] - }, - "S3ModelUri":{ - "type":"string", - "max":1024, - "min":0, - "pattern":"(https|s3)://([^/]+)/?(.*)" - }, - "S3OutputPath":{ - "type":"string", - "max":1024, - "min":0, - "pattern":"(https|s3)://([^/]+)/?(.*)" - }, - "S3Presign":{ - "type":"structure", - "members":{ - "IamPolicyConstraints":{ - "shape":"IamPolicyConstraints", - "documentation":"

Use this parameter to specify the allowed request source. Possible sources are either SourceIp or VpcSourceIp.

" - } - }, - "documentation":"

This object defines the access restrictions to Amazon S3 resources that are included in custom worker task templates using the Liquid filter, grant_read_access.

To learn more about how custom templates are created, see Create custom worker task templates.

" - }, - "S3SchemaUri":{ - "type":"string", - "max":1024, - "min":0, - "pattern":"(s3)://([^/]+)/?(.*)" - }, - "S3StorageConfig":{ - "type":"structure", - "required":["S3Uri"], - "members":{ - "S3Uri":{ - "shape":"S3Uri", - "documentation":"

The S3 URI, or location in Amazon S3, of OfflineStore.

S3 URIs have a format similar to the following: s3://example-bucket/prefix/.

" - }, - "KmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The Amazon Web Services Key Management Service (KMS) key ARN of the key used to encrypt any objects written into the OfflineStore S3 location.

The IAM roleARN that is passed as a parameter to CreateFeatureGroup must have below permissions to the KmsKeyId:

  • \"kms:GenerateDataKey\"

" - }, - "ResolvedOutputS3Uri":{ - "shape":"S3Uri", - "documentation":"

The S3 path where offline records are written.

" - } - }, - "documentation":"

The Amazon Simple Storage (Amazon S3) location and security configuration for OfflineStore.

" - }, - "S3Uri":{ - "type":"string", - "max":1024, - "min":0, - "pattern":"(https|s3)://([^/]+)/?(.*)" - }, - "SageMakerImageName":{ - "type":"string", - "enum":["sagemaker_distribution"] - }, - "SageMakerImageVersionAlias":{ - "type":"string", - "max":128, - "min":1, - "pattern":"(?!^[.-])^([a-zA-Z0-9-_.]+)" - }, - "SageMakerImageVersionAliases":{ - "type":"list", - "member":{"shape":"SageMakerImageVersionAlias"} - }, - "SageMakerPublicHubContentArn":{ - "type":"string", - "max":255, - "min":0, - "pattern":"arn:[a-z0-9-\\.]{1,63}:sagemaker:\\w+(?:-\\w+)+:aws:hub-content\\/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}\\/Model\\/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}" - }, - "SageMakerResourceName":{ - "type":"string", - "enum":[ - "training-job", - "hyperpod-cluster", - "endpoint", - "studio-apps" - ] - }, - "SageMakerResourceNames":{ - "type":"list", - "member":{"shape":"SageMakerResourceName"}, - "min":1 - }, - "SagemakerServicecatalogStatus":{ - "type":"string", - "enum":[ - "Enabled", - "Disabled" - ] - }, - "SampleWeightAttributeName":{ - "type":"string", - "max":256, - "min":1, - "pattern":"[a-zA-Z0-9_-]+" - }, - "SamplingPercentage":{ - "type":"integer", - "box":true, - "max":100, - "min":0 - }, - "ScalingPolicies":{ - "type":"list", - "member":{"shape":"ScalingPolicy"} - }, - "ScalingPolicy":{ - "type":"structure", - "members":{ - "TargetTracking":{ - "shape":"TargetTrackingScalingPolicyConfiguration", - "documentation":"

A target tracking scaling policy. Includes support for predefined or customized metrics.

" - } - }, - "documentation":"

An object containing a recommended scaling policy.

", - "union":true - }, - "ScalingPolicyMetric":{ - "type":"structure", - "members":{ - "InvocationsPerInstance":{ - "shape":"Integer", - "documentation":"

The number of invocations sent to a model, normalized by InstanceCount in each ProductionVariant. 1/numberOfInstances is sent as the value on each request, where numberOfInstances is the number of active instances for the ProductionVariant behind the endpoint at the time of the request.

", - "box":true - }, - "ModelLatency":{ - "shape":"Integer", - "documentation":"

The interval of time taken by a model to respond as viewed from SageMaker. This interval includes the local communication times taken to send the request and to fetch the response from the container of a model and the time taken to complete the inference in the container.

", - "box":true - } - }, - "documentation":"

The metric for a scaling policy.

" - }, - "ScalingPolicyObjective":{ - "type":"structure", - "members":{ - "MinInvocationsPerMinute":{ - "shape":"Integer", - "documentation":"

The minimum number of expected requests to your endpoint per minute.

", - "box":true - }, - "MaxInvocationsPerMinute":{ - "shape":"Integer", - "documentation":"

The maximum number of expected requests to your endpoint per minute.

", - "box":true - } - }, - "documentation":"

An object where you specify the anticipated traffic pattern for an endpoint.

" - }, - "ScheduleConfig":{ - "type":"structure", - "required":["ScheduleExpression"], - "members":{ - "ScheduleExpression":{ - "shape":"ScheduleExpression", - "documentation":"

A cron expression that describes details about the monitoring schedule.

The supported cron expressions are:

  • If you want to set the job to start every hour, use the following:

    Hourly: cron(0 * ? * * *)

  • If you want to start the job daily:

    cron(0 [00-23] ? * * *)

  • If you want to run the job one time, immediately, use the following keyword:

    NOW

For example, the following are valid cron expressions:

  • Daily at noon UTC: cron(0 12 ? * * *)

  • Daily at midnight UTC: cron(0 0 ? * * *)

To support running every 6, 12 hours, the following are also supported:

cron(0 [00-23]/[01-24] ? * * *)

For example, the following are valid cron expressions:

  • Every 12 hours, starting at 5pm UTC: cron(0 17/12 ? * * *)

  • Every two hours starting at midnight: cron(0 0/2 ? * * *)

  • Even though the cron expression is set to start at 5PM UTC, note that there could be a delay of 0-20 minutes from the actual requested time to run the execution.

  • We recommend that if you would like a daily schedule, you do not provide this parameter. Amazon SageMaker AI will pick a time for running every day.

You can also specify the keyword NOW to run the monitoring job immediately, one time, without recurring.

" - }, - "DataAnalysisStartTime":{ - "shape":"String", - "documentation":"

Sets the start time for a monitoring job window. Express this time as an offset to the times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the ScheduleExpression parameter. Specify this offset in ISO 8601 duration format. For example, if you want to monitor the five hours of data in your dataset that precede the start of each monitoring job, you would specify: \"-PT5H\".

The start time that you specify must not precede the end time that you specify by more than 24 hours. You specify the end time with the DataAnalysisEndTime parameter.

If you set ScheduleExpression to NOW, this parameter is required.

" - }, - "DataAnalysisEndTime":{ - "shape":"String", - "documentation":"

Sets the end time for a monitoring job window. Express this time as an offset to the times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the ScheduleExpression parameter. Specify this offset in ISO 8601 duration format. For example, if you want to end the window one hour before the start of each monitoring job, you would specify: \"-PT1H\".

The end time that you specify must not follow the start time that you specify by more than 24 hours. You specify the start time with the DataAnalysisStartTime parameter.

If you set ScheduleExpression to NOW, this parameter is required.

" - } - }, - "documentation":"

Configuration details about the monitoring schedule.

" - }, - "ScheduleExpression":{ - "type":"string", - "max":256, - "min":1 - }, - "ScheduleStatus":{ - "type":"string", - "enum":[ - "Pending", - "Failed", - "Scheduled", - "Stopped" - ] - }, - "ScheduledUpdateConfig":{ - "type":"structure", - "required":["ScheduleExpression"], - "members":{ - "ScheduleExpression":{ - "shape":"CronScheduleExpression", - "documentation":"

A cron expression that specifies the schedule that SageMaker follows when updating the AMI.

" - }, - "DeploymentConfig":{ - "shape":"DeploymentConfiguration", - "documentation":"

The configuration to use when updating the AMI versions.

" - } - }, - "documentation":"

The configuration object of the schedule that SageMaker follows when updating the AMI.

" - }, - "SchedulerConfig":{ - "type":"structure", - "members":{ - "PriorityClasses":{ - "shape":"PriorityClassList", - "documentation":"

List of the priority classes, PriorityClass, of the cluster policy. When specified, these class configurations define how tasks are queued.

" - }, - "FairShare":{ - "shape":"FairShare", - "documentation":"

When enabled, entities borrow idle compute based on their assigned FairShareWeight.

When disabled, entities borrow idle compute based on a first-come first-serve basis.

Default is Enabled.

" - }, - "IdleResourceSharing":{ - "shape":"IdleResourceSharing", - "documentation":"

Configuration for sharing idle compute resources across entities in the cluster. When enabled, unallocated resources are automatically calculated and made available for entities to borrow.

" - } - }, - "documentation":"

Cluster policy configuration. This policy is used for task prioritization and fair-share allocation. This helps prioritize critical workloads and distributes idle compute across entities.

" - }, - "SchedulerConfigComponent":{ - "type":"string", - "enum":[ - "PriorityClasses", - "FairShare", - "IdleResourceSharing" - ] - }, - "SchedulerResourceStatus":{ - "type":"string", - "enum":[ - "Creating", - "CreateFailed", - "CreateRollbackFailed", - "Created", - "Updating", - "UpdateFailed", - "UpdateRollbackFailed", - "Updated", - "Deleting", - "DeleteFailed", - "DeleteRollbackFailed", - "Deleted" - ] - }, - "Scope":{ - "type":"string", - "max":1024, - "min":0, - "pattern":"[!#-\\[\\]-~]+( [!#-\\[\\]-~]+)*" - }, - "SearchExpression":{ - "type":"structure", - "members":{ - "Filters":{ - "shape":"FilterList", - "documentation":"

A list of filter objects.

" - }, - "NestedFilters":{ - "shape":"NestedFiltersList", - "documentation":"

A list of nested filter objects.

" - }, - "SubExpressions":{ - "shape":"SearchExpressionList", - "documentation":"

A list of search expression objects.

" - }, - "Operator":{ - "shape":"BooleanOperator", - "documentation":"

A Boolean operator used to evaluate the search expression. If you want every conditional statement in all lists to be satisfied for the entire search expression to be true, specify And. If only a single conditional statement needs to be true for the entire search expression to be true, specify Or. The default value is And.

" - } - }, - "documentation":"

A multi-expression that searches for the specified resource or resources in a search. All resource objects that satisfy the expression's condition are included in the search results. You must specify at least one subexpression, filter, or nested filter. A SearchExpression can contain up to twenty elements.

A SearchExpression contains the following components:

  • A list of Filter objects. Each filter defines a simple Boolean expression comprised of a resource property name, Boolean operator, and value.

  • A list of NestedFilter objects. Each nested filter defines a list of Boolean expressions using a list of resource properties. A nested filter is satisfied if a single object in the list satisfies all Boolean expressions.

  • A list of SearchExpression objects. A search expression object can be nested in a list of search expression objects.

  • A Boolean operator: And or Or.

" - }, - "SearchExpressionList":{ - "type":"list", - "member":{"shape":"SearchExpression"}, - "max":20, - "min":1 - }, - "SearchRecord":{ - "type":"structure", - "members":{ - "TrainingJob":{ - "shape":"TrainingJob", - "documentation":"

The properties of a training job.

" - }, - "Experiment":{ - "shape":"Experiment", - "documentation":"

The properties of an experiment.

" - }, - "Trial":{ - "shape":"Trial", - "documentation":"

The properties of a trial.

" - }, - "TrialComponent":{ - "shape":"TrialComponent", - "documentation":"

The properties of a trial component.

" - }, - "Endpoint":{"shape":"Endpoint"}, - "ModelPackage":{"shape":"ModelPackage"}, - "ModelPackageGroup":{"shape":"ModelPackageGroup"}, - "Pipeline":{"shape":"Pipeline"}, - "PipelineExecution":{"shape":"PipelineExecution"}, - "PipelineVersion":{ - "shape":"PipelineVersion", - "documentation":"

The version of the pipeline.

" - }, - "FeatureGroup":{"shape":"FeatureGroup"}, - "FeatureMetadata":{ - "shape":"FeatureMetadata", - "documentation":"

The feature metadata used to search through the features.

" - }, - "Project":{ - "shape":"Project", - "documentation":"

The properties of a project.

" - }, - "HyperParameterTuningJob":{ - "shape":"HyperParameterTuningJobSearchEntity", - "documentation":"

The properties of a hyperparameter tuning job.

" - }, - "ModelCard":{ - "shape":"ModelCard", - "documentation":"

An Amazon SageMaker Model Card that documents details about a machine learning model.

" - }, - "Model":{"shape":"ModelDashboardModel"}, - "Job":{ - "shape":"Job", - "documentation":"

The properties of a job.

" - } - }, - "documentation":"

A single resource returned as part of the Search API response.

" - }, - "SearchRequest":{ - "type":"structure", - "required":["Resource"], - "members":{ - "Resource":{ - "shape":"ResourceType", - "documentation":"

The name of the SageMaker resource to search for.

" - }, - "SearchExpression":{ - "shape":"SearchExpression", - "documentation":"

A Boolean conditional statement. Resources must satisfy this condition to be included in search results. You must provide at least one subexpression, filter, or nested filter. The maximum number of recursive SubExpressions, NestedFilters, and Filters that can be included in a SearchExpression object is 50.

" - }, - "SortBy":{ - "shape":"ResourcePropertyName", - "documentation":"

The name of the resource property used to sort the SearchResults. The default is LastModifiedTime.

" - }, - "SortOrder":{ - "shape":"SearchSortOrder", - "documentation":"

How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If more than MaxResults resources match the specified SearchExpression, the response includes a NextToken. The NextToken can be passed to the next SearchRequest to continue retrieving results.

" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return.

" - }, - "CrossAccountFilterOption":{ - "shape":"CrossAccountFilterOption", - "documentation":"

A cross account filter option. When the value is \"CrossAccount\" the search results will only include resources made discoverable to you from other accounts. When the value is \"SameAccount\" or null the search results will only include resources from your account. Default is null. For more information on searching for resources made discoverable to your account, see Search discoverable resources in the SageMaker Developer Guide. The maximum number of ResourceCatalogs viewable is 1000.

" - }, - "VisibilityConditions":{ - "shape":"VisibilityConditionsList", - "documentation":"

Limits the results of your search request to the resources that you can access.

" - } - } - }, - "SearchResponse":{ - "type":"structure", - "members":{ - "Results":{ - "shape":"SearchResultsList", - "documentation":"

A list of SearchRecord objects.

" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"

If the result of the previous Search request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request.

" - }, - "TotalHits":{ - "shape":"TotalHits", - "documentation":"

The total number of matching results.

" - } - } - }, - "SearchResultsList":{ - "type":"list", - "member":{"shape":"SearchRecord"} - }, - "SearchSortOrder":{ - "type":"string", - "enum":[ - "Ascending", - "Descending" - ] - }, - "SearchTrainingPlanOfferingsRequest":{ - "type":"structure", - "members":{ - "InstanceType":{ - "shape":"ReservedCapacityInstanceType", - "documentation":"

The type of instance you want to search for in the available training plan offerings. This field allows you to filter the search results based on the specific compute resources you require for your SageMaker training jobs or SageMaker HyperPod clusters. When searching for training plan offerings, specifying the instance type helps you find Reserved Instances that match your computational needs.

" - }, - "InstanceCount":{ - "shape":"ReservedCapacityInstanceCount", - "documentation":"

The number of instances you want to reserve in the training plan offerings. This allows you to specify the quantity of compute resources needed for your SageMaker training jobs or SageMaker HyperPod clusters, helping you find reserved capacity offerings that match your requirements.

", - "box":true - }, - "UltraServerType":{ - "shape":"UltraServerType", - "documentation":"

The type of UltraServer to search for, such as ml.u-p6e-gb200x72.

" - }, - "UltraServerCount":{ - "shape":"UltraServerCount", - "documentation":"

The number of UltraServers to search for.

" - }, - "StartTimeAfter":{ - "shape":"Timestamp", - "documentation":"

A filter to search for training plan offerings with a start time after a specified date.

" - }, - "EndTimeBefore":{ - "shape":"Timestamp", - "documentation":"

A filter to search for reserved capacity offerings with an end time before a specified date.

" - }, - "DurationHours":{ - "shape":"TrainingPlanDurationHoursInput", - "documentation":"

The desired duration in hours for the training plan offerings.

" - }, - "TargetResources":{ - "shape":"SageMakerResourceNames", - "documentation":"

The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod, SageMaker Endpoints, Studio apps) to search for in the offerings.

Training plans are specific to their target resource.

  • A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs.

  • A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster's instance group.

  • A training plan for SageMaker endpoints can be used exclusively to provide compute resources to SageMaker endpoints for model deployment.

  • A training plan for Studio apps can be used to launch JupyterLab and Code Editor apps on reserved training plan capacity.

" - }, - "TrainingPlanArn":{ - "shape":"String", - "documentation":"

The Amazon Resource Name (ARN); of an existing training plan to search for extension offerings. When specified, the API returns extension offerings that can be used to extend the specified training plan.

" - } - } - }, - "SearchTrainingPlanOfferingsResponse":{ - "type":"structure", - "required":["TrainingPlanOfferings"], - "members":{ - "TrainingPlanOfferings":{ - "shape":"TrainingPlanOfferings", - "documentation":"

A list of training plan offerings that match the search criteria.

" - }, - "TrainingPlanExtensionOfferings":{ - "shape":"TrainingPlanExtensionOfferings", - "documentation":"

A list of extension offerings available for the specified training plan. These offerings can be used with the ExtendTrainingPlan API to extend an existing training plan.

" - } - } - }, - "SecondaryStatus":{ - "type":"string", - "enum":[ - "Starting", - "LaunchingMLInstances", - "PreparingTrainingStack", - "Downloading", - "DownloadingTrainingImage", - "Training", - "Uploading", - "Stopping", - "Stopped", - "MaxRuntimeExceeded", - "Completed", - "Failed", - "Interrupted", - "MaxWaitTimeExceeded", - "Updating", - "Restarting", - "Pending" - ] - }, - "SecondaryStatusTransition":{ - "type":"structure", - "required":[ - "Status", - "StartTime" - ], - "members":{ - "Status":{ - "shape":"SecondaryStatus", - "documentation":"

Contains a secondary status information from a training job.

Status might be one of the following secondary statuses:

InProgress

  • Starting - Starting the training job.

  • Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.

  • Training - Training is in progress.

  • Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.

Completed

  • Completed - The training job has completed.

Failed

  • Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.

Stopped

  • MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.

  • Stopped - The training job has stopped.

Stopping

  • Stopping - Stopping the training job.

We no longer support the following secondary statuses:

  • LaunchingMLInstances

  • PreparingTrainingStack

  • DownloadingTrainingImage

" - }, - "StartTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that shows when the training job transitioned to the current secondary status state.

" - }, - "EndTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that shows when the training job transitioned out of this secondary status state into another secondary status state or when the training job has ended.

" - }, - "StatusMessage":{ - "shape":"StatusMessage", - "documentation":"

A detailed description of the progress within a secondary status.

SageMaker provides secondary statuses and status messages that apply to each of them:

Starting

  • Starting the training job.

  • Launching requested ML instances.

  • Insufficient capacity error from EC2 while launching instances, retrying!

  • Launched instance was unhealthy, replacing it!

  • Preparing the instances for training.

Training

  • Training image download completed. Training in progress.

Status messages are subject to change. Therefore, we recommend not including them in code that programmatically initiates actions. For examples, don't use status messages in if statements.

To have an overview of your training job's progress, view TrainingJobStatus and SecondaryStatus in DescribeTrainingJob, and StatusMessage together. For example, at the start of a training job, you might see the following:

  • TrainingJobStatus - InProgress

  • SecondaryStatus - Training

  • StatusMessage - Downloading the training image

" - } - }, - "documentation":"

An array element of SecondaryStatusTransitions for DescribeTrainingJob. It provides additional details about a status that the training job has transitioned through. A training job can be in one of several states, for example, starting, downloading, training, or uploading. Within each state, there are a number of intermediate states. For example, within the starting state, SageMaker could be starting the training job or launching the ML instances. These transitional states are referred to as the job's secondary status.

" - }, - "SecondaryStatusTransitions":{ - "type":"list", - "member":{"shape":"SecondaryStatusTransition"} - }, - "SecretArn":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"arn:aws[a-z\\-]*:secretsmanager:[a-z0-9\\-]*:[0-9]{12}:secret:.*" - }, - "SecurityGroupId":{ - "type":"string", - "max":32, - "min":0, - "pattern":"[-0-9a-zA-Z]+" - }, - "SecurityGroupIds":{ - "type":"list", - "member":{"shape":"SecurityGroupId"}, - "max":5, - "min":0 - }, - "Seed":{"type":"long"}, - "SelectedStep":{ - "type":"structure", - "required":["StepName"], - "members":{ - "StepName":{ - "shape":"String256", - "documentation":"

The name of the pipeline step.

" - } - }, - "documentation":"

A step selected to run in selective execution mode.

" - }, - "SelectedStepList":{ - "type":"list", - "member":{"shape":"SelectedStep"}, - "max":50, - "min":1 - }, - "SelectiveExecutionConfig":{ - "type":"structure", - "required":["SelectedSteps"], - "members":{ - "SourcePipelineExecutionArn":{ - "shape":"PipelineExecutionArn", - "documentation":"

The ARN from a reference execution of the current pipeline. Used to copy input collaterals needed for the selected steps to run. The execution status of the pipeline can be either Failed or Success.

This field is required if the steps you specify for SelectedSteps depend on output collaterals from any non-specified pipeline steps. For more information, see Selective Execution for Pipeline Steps.

" - }, - "SelectedSteps":{ - "shape":"SelectedStepList", - "documentation":"

A list of pipeline steps to run. All step(s) in all path(s) between two selected steps should be included.

" - } - }, - "documentation":"

The selective execution configuration applied to the pipeline run.

" - }, - "SelectiveExecutionResult":{ - "type":"structure", - "members":{ - "SourcePipelineExecutionArn":{ - "shape":"PipelineExecutionArn", - "documentation":"

The ARN from an execution of the current pipeline.

" - } - }, - "documentation":"

The ARN from an execution of the current pipeline.

" - }, - "SendPipelineExecutionStepFailureRequest":{ - "type":"structure", - "required":["CallbackToken"], - "members":{ - "CallbackToken":{ - "shape":"CallbackToken", - "documentation":"

The pipeline generated token from the Amazon SQS queue.

" - }, - "FailureReason":{ - "shape":"String256", - "documentation":"

A message describing why the step failed.

" - }, - "ClientRequestToken":{ - "shape":"IdempotencyToken", - "documentation":"

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.

", - "idempotencyToken":true - } - } - }, - "SendPipelineExecutionStepFailureResponse":{ - "type":"structure", - "members":{ - "PipelineExecutionArn":{ - "shape":"PipelineExecutionArn", - "documentation":"

The Amazon Resource Name (ARN) of the pipeline execution.

" - } - } - }, - "SendPipelineExecutionStepSuccessRequest":{ - "type":"structure", - "required":["CallbackToken"], - "members":{ - "CallbackToken":{ - "shape":"CallbackToken", - "documentation":"

The pipeline generated token from the Amazon SQS queue.

" - }, - "OutputParameters":{ - "shape":"OutputParameterList", - "documentation":"

A list of the output parameters of the callback step.

" - }, - "ClientRequestToken":{ - "shape":"IdempotencyToken", - "documentation":"

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.

", - "idempotencyToken":true - } - } - }, - "SendPipelineExecutionStepSuccessResponse":{ - "type":"structure", - "members":{ - "PipelineExecutionArn":{ - "shape":"PipelineExecutionArn", - "documentation":"

The Amazon Resource Name (ARN) of the pipeline execution.

" - } - } - }, - "ServerlessJobBaseModelArn":{ - "type":"string", - "documentation":"

ServerlessJobConfig relevant fields

", - "max":2048, - "min":1, - "pattern":"(arn:[a-z0-9-\\.]{1,63}:sagemaker:\\w+(?:-\\w+)+:(\\d{12}|aws):hub-content\\/)[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}\\/Model\\/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}(\\/\\d{1,4}.\\d{1,4}.\\d{1,4})?" - }, - "ServerlessJobConfig":{ - "type":"structure", - "required":[ - "BaseModelArn", - "JobType" - ], - "members":{ - "BaseModelArn":{ - "shape":"ServerlessJobBaseModelArn", - "documentation":"

The base model Amazon Resource Name (ARN) in SageMaker Public Hub. SageMaker always selects the latest version of the provided model.

" - }, - "AcceptEula":{ - "shape":"AcceptEula", - "documentation":"

Specifies agreement to the model end-user license agreement (EULA). The AcceptEula value must be explicitly defined as True in order to accept the EULA that this model requires. You are responsible for reviewing and complying with any applicable license terms and making sure they are acceptable for your use case before downloading or using a model. For more information, see End-user license agreements section for more details on accepting the EULA.

", - "box":true - }, - "JobType":{ - "shape":"ServerlessJobType", - "documentation":"

The serverless training job type.

" - }, - "CustomizationTechnique":{ - "shape":"CustomizationTechnique", - "documentation":"

The model customization technique.

" - }, - "Peft":{ - "shape":"Peft", - "documentation":"

The parameter-efficient fine-tuning configuration.

" - }, - "EvaluationType":{ - "shape":"EvaluationType", - "documentation":"

The evaluation job type. Required when serverless job type is Evaluation.

" - }, - "EvaluatorArn":{ - "shape":"EvaluatorArn", - "documentation":"

The evaluator Amazon Resource Name (ARN) used as reward function or reward prompt.

" - } - }, - "documentation":"

The configuration for the serverless training job.

" - }, - "ServerlessJobType":{ - "type":"string", - "enum":[ - "FineTuning", - "Evaluation" - ] - }, - "ServerlessMaxConcurrency":{ - "type":"integer", - "box":true, - "max":200, - "min":1 - }, - "ServerlessMemorySizeInMB":{ - "type":"integer", - "box":true, - "max":6144, - "min":1024 - }, - "ServerlessProvisionedConcurrency":{ - "type":"integer", - "box":true, - "max":200, - "min":1 - }, - "ServiceCatalogEntityId":{ - "type":"string", - "max":100, - "min":1, - "pattern":"[a-zA-Z0-9_\\-]*" - }, - "ServiceCatalogProvisionedProductDetails":{ - "type":"structure", - "members":{ - "ProvisionedProductId":{ - "shape":"ServiceCatalogEntityId", - "documentation":"

The ID of the provisioned product.

" - }, - "ProvisionedProductStatusMessage":{ - "shape":"ProvisionedProductStatusMessage", - "documentation":"

The current status of the product.

  • AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.

  • UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.

  • TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.

  • ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.

  • PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.

" - } - }, - "documentation":"

Details of a provisioned service catalog product. For information about service catalog, see What is Amazon Web Services Service Catalog.

" - }, - "ServiceCatalogProvisioningDetails":{ - "type":"structure", - "required":["ProductId"], - "members":{ - "ProductId":{ - "shape":"ServiceCatalogEntityId", - "documentation":"

The ID of the product to provision.

" - }, - "ProvisioningArtifactId":{ - "shape":"ServiceCatalogEntityId", - "documentation":"

The ID of the provisioning artifact.

" - }, - "PathId":{ - "shape":"ServiceCatalogEntityId", - "documentation":"

The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path.

" - }, - "ProvisioningParameters":{ - "shape":"ProvisioningParameters", - "documentation":"

A list of key value pairs that you specify when you provision a product.

" - } - }, - "documentation":"

Details that you specify to provision a service catalog product. For information about service catalog, see What is Amazon Web Services Service Catalog.

" - }, - "ServiceCatalogProvisioningUpdateDetails":{ - "type":"structure", - "members":{ - "ProvisioningArtifactId":{ - "shape":"ServiceCatalogEntityId", - "documentation":"

The ID of the provisioning artifact.

" - }, - "ProvisioningParameters":{ - "shape":"ProvisioningParameters", - "documentation":"

A list of key value pairs that you specify when you provision a product.

" - } - }, - "documentation":"

Details that you specify to provision a service catalog product. For information about service catalog, see What is Amazon Web Services Service Catalog.

" - }, - "SessionChainingConfig":{ - "type":"structure", - "members":{ - "EnableSessionTagChaining":{ - "shape":"EnableSessionTagChaining", - "documentation":"

Set to True to allow SageMaker to extract session tags from a training job creation role and reuse these tags when assuming the training job execution role.

" - } - }, - "documentation":"

Contains information about attribute-based access control (ABAC) for a training job. The session chaining configuration uses Amazon Security Token Service (STS) for your training job to request temporary, limited-privilege credentials to tenants. For more information, see Attribute-based access control (ABAC) for multi-tenancy training.

" - }, - "SessionExpirationDurationInSeconds":{ - "type":"integer", - "box":true, - "max":43200, - "min":1800 - }, - "SessionId":{ - "type":"string", - "max":256, - "min":1 - }, - "ShadowModeConfig":{ - "type":"structure", - "required":[ - "SourceModelVariantName", - "ShadowModelVariants" - ], - "members":{ - "SourceModelVariantName":{ - "shape":"ModelVariantName", - "documentation":"

The name of the production variant, which takes all the inference requests.

" - }, - "ShadowModelVariants":{ - "shape":"ShadowModelVariantConfigList", - "documentation":"

List of shadow variant configurations.

" - } - }, - "documentation":"

The configuration of ShadowMode inference experiment type, which specifies a production variant to take all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant it also specifies the percentage of requests that Amazon SageMaker replicates.

" - }, - "ShadowModelVariantConfig":{ - "type":"structure", - "required":[ - "ShadowModelVariantName", - "SamplingPercentage" - ], - "members":{ - "ShadowModelVariantName":{ - "shape":"ModelVariantName", - "documentation":"

The name of the shadow variant.

" - }, - "SamplingPercentage":{ - "shape":"Percentage", - "documentation":"

The percentage of inference requests that Amazon SageMaker replicates from the production variant to the shadow variant.

", - "box":true - } - }, - "documentation":"

The name and sampling percentage of a shadow variant.

" - }, - "ShadowModelVariantConfigList":{ - "type":"list", - "member":{"shape":"ShadowModelVariantConfig"}, - "max":1, - "min":1 - }, - "SharingSettings":{ - "type":"structure", - "members":{ - "NotebookOutputOption":{ - "shape":"NotebookOutputOption", - "documentation":"

Whether to include the notebook cell output when sharing the notebook. The default is Disabled.

" - }, - "S3OutputPath":{ - "shape":"S3Uri", - "documentation":"

When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.

" - }, - "S3KmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

When NotebookOutputOption is Allowed, the Amazon Web Services Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

" - } - }, - "documentation":"

Specifies options for sharing Amazon SageMaker AI Studio notebooks. These settings are specified as part of DefaultUserSettings when the CreateDomain API is called, and as part of UserSettings when the CreateUserProfile API is called. When SharingSettings is not specified, notebook sharing isn't allowed.

" - }, - "SharingType":{ - "type":"string", - "enum":[ - "Private", - "Shared" - ] - }, - "ShuffleConfig":{ - "type":"structure", - "required":["Seed"], - "members":{ - "Seed":{ - "shape":"Seed", - "documentation":"

Determines the shuffling order in ShuffleConfig value.

", - "box":true - } - }, - "documentation":"

A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType, the results of the S3 key prefix matches are shuffled. If you use ManifestFile, the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile, the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value.

For Pipe input mode, when ShuffleConfig is specified shuffling is done at the start of every epoch. With large datasets, this ensures that the order of the training data is different for each epoch, and it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key, the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.

" - }, - "SingleSignOnApplicationArn":{ - "type":"string", - "pattern":"arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::[0-9]+:application\\/[a-zA-Z0-9-_.]+\\/apl-[a-zA-Z0-9]+" - }, - "SingleSignOnUserIdentifier":{ - "type":"string", - "pattern":"UserName" - }, - "SkipModelValidation":{ - "type":"string", - "enum":[ - "All", - "None" - ] - }, - "SnsTopicArn":{ - "type":"string", - "max":2048, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sns:[a-z0-9\\-]*:[0-9]{12}:[a-zA-Z0-9_.-]+" - }, - "SoftwareUpdateStatus":{ - "type":"string", - "enum":[ - "Pending", - "InProgress", - "Succeeded", - "Failed", - "RollbackInProgress", - "RollbackComplete" - ] - }, - "SortActionsBy":{ - "type":"string", - "enum":[ - "Name", - "CreationTime" - ] - }, - "SortArtifactsBy":{ - "type":"string", - "enum":["CreationTime"] - }, - "SortAssociationsBy":{ - "type":"string", - "enum":[ - "SourceArn", - "DestinationArn", - "SourceType", - "DestinationType", - "CreationTime" - ] - }, - "SortBy":{ - "type":"string", - "enum":[ - "Name", - "CreationTime", - "Status" - ] - }, - "SortClusterSchedulerConfigBy":{ - "type":"string", - "enum":[ - "Name", - "CreationTime", - "Status" - ] - }, - "SortContextsBy":{ - "type":"string", - "enum":[ - "Name", - "CreationTime" - ] - }, - "SortExperimentsBy":{ - "type":"string", - "enum":[ - "Name", - "CreationTime" - ] - }, - "SortInferenceExperimentsBy":{ - "type":"string", - "enum":[ - "Name", - "CreationTime", - "Status" - ] - }, - "SortLineageGroupsBy":{ - "type":"string", - "enum":[ - "Name", - "CreationTime" - ] - }, - "SortMlflowAppBy":{ - "type":"string", - "enum":[ - "Name", - "CreationTime", - "Status" - ] - }, - "SortOrder":{ - "type":"string", - "enum":[ - "Ascending", - "Descending" - ] - }, - "SortPipelineExecutionsBy":{ - "type":"string", - "enum":[ - "CreationTime", - "PipelineExecutionArn" - ] - }, - "SortPipelinesBy":{ - "type":"string", - "enum":[ - "Name", - "CreationTime" - ] - }, - "SortQuotaBy":{ - "type":"string", - "enum":[ - "Name", - "CreationTime", - "Status", - "ClusterArn" - ] - }, - "SortTrackingServerBy":{ - "type":"string", - "enum":[ - "Name", - "CreationTime", - "Status" - ] - }, - "SortTrialComponentsBy":{ - "type":"string", - "enum":[ - "Name", - "CreationTime" - ] - }, - "SortTrialsBy":{ - "type":"string", - "enum":[ - "Name", - "CreationTime" - ] - }, - "SourceAlgorithm":{ - "type":"structure", - "required":["AlgorithmName"], - "members":{ - "ModelDataUrl":{ - "shape":"Url", - "documentation":"

The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

The model artifacts must be in an S3 bucket that is in the same Amazon Web Services region as the algorithm.

" - }, - "ModelDataSource":{ - "shape":"ModelDataSource", - "documentation":"

Specifies the location of ML model data to deploy during endpoint creation.

" - }, - "ModelDataETag":{ - "shape":"String", - "documentation":"

The ETag associated with Model Data URL.

" - }, - "AlgorithmName":{ - "shape":"ArnOrName", - "documentation":"

The name of an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you are subscribed to.

" - } - }, - "documentation":"

Specifies an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you are subscribed to.

" - }, - "SourceAlgorithmList":{ - "type":"list", - "member":{"shape":"SourceAlgorithm"}, - "max":1, - "min":1 - }, - "SourceAlgorithmSpecification":{ - "type":"structure", - "required":["SourceAlgorithms"], - "members":{ - "SourceAlgorithms":{ - "shape":"SourceAlgorithmList", - "documentation":"

A list of the algorithms that were used to create a model package.

" - } - }, - "documentation":"

A list of algorithms that were used to create a model package.

" - }, - "SourceIpConfig":{ - "type":"structure", - "required":["Cidrs"], - "members":{ - "Cidrs":{ - "shape":"Cidrs", - "documentation":"

A list of one to ten Classless Inter-Domain Routing (CIDR) values.

Maximum: Ten CIDR values

The following Length Constraints apply to individual CIDR values in the CIDR value list.

" - } - }, - "documentation":"

A list of IP address ranges (CIDRs). Used to create an allow list of IP addresses for a private workforce. Workers will only be able to log in to their worker portal from an IP address within this range. By default, a workforce isn't restricted to specific IP addresses.

" - }, - "SourceType":{ - "type":"string", - "max":128, - "min":0 - }, - "SourceUri":{ - "type":"string", - "max":2048, - "min":1, - "pattern":".*" - }, - "SpaceAppLifecycleManagement":{ - "type":"structure", - "members":{ - "IdleSettings":{ - "shape":"SpaceIdleSettings", - "documentation":"

Settings related to idle shutdown of Studio applications.

" - } - }, - "documentation":"

Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio applications in a space.

" - }, - "SpaceArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:space/.*" - }, - "SpaceCodeEditorAppSettings":{ - "type":"structure", - "members":{ - "DefaultResourceSpec":{"shape":"ResourceSpec"}, - "AppLifecycleManagement":{ - "shape":"SpaceAppLifecycleManagement", - "documentation":"

Settings that are used to configure and manage the lifecycle of CodeEditor applications in a space.

" - } - }, - "documentation":"

The application settings for a Code Editor space.

" - }, - "SpaceDetails":{ - "type":"structure", - "members":{ - "DomainId":{ - "shape":"DomainId", - "documentation":"

The ID of the associated domain.

" - }, - "SpaceName":{ - "shape":"SpaceName", - "documentation":"

The name of the space.

" - }, - "Status":{ - "shape":"SpaceStatus", - "documentation":"

The status.

" - }, - "CreationTime":{ - "shape":"CreationTime", - "documentation":"

The creation time.

" - }, - "LastModifiedTime":{ - "shape":"LastModifiedTime", - "documentation":"

The last modified time.

" - }, - "SpaceSettingsSummary":{ - "shape":"SpaceSettingsSummary", - "documentation":"

Specifies summary information about the space settings.

" - }, - "SpaceSharingSettingsSummary":{ - "shape":"SpaceSharingSettingsSummary", - "documentation":"

Specifies summary information about the space sharing settings.

" - }, - "OwnershipSettingsSummary":{ - "shape":"OwnershipSettingsSummary", - "documentation":"

Specifies summary information about the ownership settings.

" - }, - "SpaceDisplayName":{ - "shape":"NonEmptyString64", - "documentation":"

The name of the space that appears in the Studio UI.

" - } - }, - "documentation":"

The space's details.

" - }, - "SpaceEbsVolumeSizeInGb":{ - "type":"integer", - "box":true, - "max":16384, - "min":5 - }, - "SpaceIdleSettings":{ - "type":"structure", - "members":{ - "IdleTimeoutInMinutes":{ - "shape":"IdleTimeoutInMinutes", - "documentation":"

The time that SageMaker waits after the application becomes idle before shutting it down.

" - } - }, - "documentation":"

Settings related to idle shutdown of Studio applications in a space.

" - }, - "SpaceJupyterLabAppSettings":{ - "type":"structure", - "members":{ - "DefaultResourceSpec":{"shape":"ResourceSpec"}, - "CodeRepositories":{ - "shape":"CodeRepositories", - "documentation":"

A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.

" - }, - "AppLifecycleManagement":{ - "shape":"SpaceAppLifecycleManagement", - "documentation":"

Settings that are used to configure and manage the lifecycle of JupyterLab applications in a space.

" - } - }, - "documentation":"

The settings for the JupyterLab application within a space.

" - }, - "SpaceList":{ - "type":"list", - "member":{"shape":"SpaceDetails"} - }, - "SpaceName":{ - "type":"string", - "max":63, - "min":0, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" - }, - "SpaceSettings":{ - "type":"structure", - "members":{ - "JupyterServerAppSettings":{"shape":"JupyterServerAppSettings"}, - "KernelGatewayAppSettings":{"shape":"KernelGatewayAppSettings"}, - "CodeEditorAppSettings":{ - "shape":"SpaceCodeEditorAppSettings", - "documentation":"

The Code Editor application settings.

" - }, - "JupyterLabAppSettings":{ - "shape":"SpaceJupyterLabAppSettings", - "documentation":"

The settings for the JupyterLab application.

" - }, - "AppType":{ - "shape":"AppType", - "documentation":"

The type of app created within the space.

If using the UpdateSpace API, you can't change the app type of your space by specifying a different value for this field.

" - }, - "SpaceStorageSettings":{ - "shape":"SpaceStorageSettings", - "documentation":"

The storage settings for a space.

" - }, - "SpaceManagedResources":{ - "shape":"FeatureStatus", - "documentation":"

If you enable this option, SageMaker AI creates the following resources on your behalf when you create the space:

  • The user profile that possesses the space.

  • The app that the space contains.

" - }, - "CustomFileSystems":{ - "shape":"CustomFileSystems", - "documentation":"

A file system, created by you, that you assign to a space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI Studio.

" - }, - "RemoteAccess":{ - "shape":"FeatureStatus", - "documentation":"

A setting that enables or disables remote access for a SageMaker space. When enabled, this allows you to connect to the remote space from your local IDE.

" - } - }, - "documentation":"

A collection of space settings.

" - }, - "SpaceSettingsSummary":{ - "type":"structure", - "members":{ - "AppType":{ - "shape":"AppType", - "documentation":"

The type of app created within the space.

" - }, - "RemoteAccess":{ - "shape":"FeatureStatus", - "documentation":"

A setting that enables or disables remote access for a SageMaker space. When enabled, this allows you to connect to the remote space from your local IDE.

" - }, - "SpaceStorageSettings":{ - "shape":"SpaceStorageSettings", - "documentation":"

The storage settings for a space.

" - } - }, - "documentation":"

Specifies summary information about the space settings.

" - }, - "SpaceSharingSettings":{ - "type":"structure", - "required":["SharingType"], - "members":{ - "SharingType":{ - "shape":"SharingType", - "documentation":"

Specifies the sharing type of the space.

" - } - }, - "documentation":"

A collection of space sharing settings.

" - }, - "SpaceSharingSettingsSummary":{ - "type":"structure", - "members":{ - "SharingType":{ - "shape":"SharingType", - "documentation":"

Specifies the sharing type of the space.

" - } - }, - "documentation":"

Specifies summary information about the space sharing settings.

" - }, - "SpaceSortKey":{ - "type":"string", - "enum":[ - "CreationTime", - "LastModifiedTime" - ] - }, - "SpaceStatus":{ - "type":"string", - "enum":[ - "Deleting", - "Failed", - "InService", - "Pending", - "Updating", - "Update_Failed", - "Delete_Failed" - ] - }, - "SpaceStorageSettings":{ - "type":"structure", - "members":{ - "EbsStorageSettings":{ - "shape":"EbsStorageSettings", - "documentation":"

A collection of EBS storage settings for a space.

" - } - }, - "documentation":"

The storage settings for a space.

" - }, - "SpareInstanceCountPerUltraServer":{ - "type":"integer", - "box":true, - "min":0 - }, - "SpawnRate":{ - "type":"integer", - "box":true, - "min":0 - }, - "SplitType":{ - "type":"string", - "enum":[ - "None", - "Line", - "RecordIO", - "TFRecord" - ] - }, - "StageDescription":{ - "type":"string", - "max":1024, - "min":0, - "pattern":".{0,1024}" - }, - "StageStatus":{ - "type":"string", - "enum":[ - "CREATING", - "READYTODEPLOY", - "STARTING", - "INPROGRESS", - "DEPLOYED", - "FAILED", - "STOPPING", - "STOPPED" - ] - }, - "Stairs":{ - "type":"structure", - "members":{ - "DurationInSeconds":{ - "shape":"TrafficDurationInSeconds", - "documentation":"

Defines how long each traffic step should be.

" - }, - "NumberOfSteps":{ - "shape":"NumberOfSteps", - "documentation":"

Specifies how many steps to perform during traffic.

" - }, - "UsersPerStep":{ - "shape":"UsersPerStep", - "documentation":"

Specifies how many new users to spawn in each step.

" - } - }, - "documentation":"

Defines the stairs traffic pattern for an Inference Recommender load test. This pattern type consists of multiple steps where the number of users increases at each step.

Specify either the stairs or phases traffic pattern.

" - }, - "StartClusterHealthCheckRequest":{ - "type":"structure", - "required":[ - "ClusterName", - "DeepHealthCheckConfigurations" - ], - "members":{ - "ClusterName":{ - "shape":"ClusterNameOrArn", - "documentation":"

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

" - }, - "DeepHealthCheckConfigurations":{ - "shape":"DeepHealthCheckConfigurations", - "documentation":"

A list of configurations containing instance group names, EC2 instance IDs, and deep health checks to perform.

" - } - } - }, - "StartClusterHealthCheckResponse":{ - "type":"structure", - "required":["ClusterArn"], - "members":{ - "ClusterArn":{ - "shape":"ClusterArn", - "documentation":"

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster on which the deep health checks were initiated.

" - } - } - }, - "StartEdgeDeploymentStageRequest":{ - "type":"structure", - "required":[ - "EdgeDeploymentPlanName", - "StageName" - ], - "members":{ - "EdgeDeploymentPlanName":{ - "shape":"EntityName", - "documentation":"

The name of the edge deployment plan to start.

" - }, - "StageName":{ - "shape":"EntityName", - "documentation":"

The name of the stage to start.

" - } - } - }, - "StartInferenceExperimentRequest":{ - "type":"structure", - "required":["Name"], - "members":{ - "Name":{ - "shape":"InferenceExperimentName", - "documentation":"

The name of the inference experiment to start.

" - } - } - }, - "StartInferenceExperimentResponse":{ - "type":"structure", - "required":["InferenceExperimentArn"], - "members":{ - "InferenceExperimentArn":{ - "shape":"InferenceExperimentArn", - "documentation":"

The ARN of the started inference experiment to start.

" - } - } - }, - "StartMlflowTrackingServerRequest":{ - "type":"structure", - "required":["TrackingServerName"], - "members":{ - "TrackingServerName":{ - "shape":"TrackingServerName", - "documentation":"

The name of the tracking server to start.

" - } - } - }, - "StartMlflowTrackingServerResponse":{ - "type":"structure", - "members":{ - "TrackingServerArn":{ - "shape":"TrackingServerArn", - "documentation":"

The ARN of the started tracking server.

" - } - } - }, - "StartMonitoringScheduleRequest":{ - "type":"structure", - "required":["MonitoringScheduleName"], - "members":{ - "MonitoringScheduleName":{ - "shape":"MonitoringScheduleName", - "documentation":"

The name of the schedule to start.

" - } - } - }, - "StartNotebookInstanceInput":{ - "type":"structure", - "required":["NotebookInstanceName"], - "members":{ - "NotebookInstanceName":{ - "shape":"NotebookInstanceName", - "documentation":"

The name of the notebook instance to start.

" - } - } - }, - "StartPipelineExecutionRequest":{ - "type":"structure", - "required":[ - "PipelineName", - "ClientRequestToken" - ], - "members":{ - "PipelineName":{ - "shape":"PipelineNameOrArn", - "documentation":"

The name or Amazon Resource Name (ARN) of the pipeline.

" - }, - "PipelineExecutionDisplayName":{ - "shape":"PipelineExecutionName", - "documentation":"

The display name of the pipeline execution.

" - }, - "PipelineParameters":{ - "shape":"ParameterList", - "documentation":"

Contains a list of pipeline parameters. This list can be empty.

" - }, - "PipelineExecutionDescription":{ - "shape":"PipelineExecutionDescription", - "documentation":"

The description of the pipeline execution.

" - }, - "ClientRequestToken":{ - "shape":"IdempotencyToken", - "documentation":"

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.

", - "idempotencyToken":true - }, - "ParallelismConfiguration":{ - "shape":"ParallelismConfiguration", - "documentation":"

This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run.

" - }, - "SelectiveExecutionConfig":{ - "shape":"SelectiveExecutionConfig", - "documentation":"

The selective execution configuration applied to the pipeline run.

" - }, - "PipelineVersionId":{ - "shape":"PipelineVersionId", - "documentation":"

The ID of the pipeline version to start execution from.

" - }, - "MlflowExperimentName":{ - "shape":"MlflowExperimentEntityName", - "documentation":"

The MLflow experiment name of the pipeline execution.

" - } - } - }, - "StartPipelineExecutionResponse":{ - "type":"structure", - "members":{ - "PipelineExecutionArn":{ - "shape":"PipelineExecutionArn", - "documentation":"

The Amazon Resource Name (ARN) of the pipeline execution.

" - } - } - }, - "StartSessionRequest":{ - "type":"structure", - "required":["ResourceIdentifier"], - "members":{ - "ResourceIdentifier":{ - "shape":"ResourceIdentifier", - "documentation":"

The Amazon Resource Name (ARN) of the resource to which the remote connection will be established. For example, this identifies the specific ARN space application you want to connect to from your local IDE.

" - } - } - }, - "StartSessionResponse":{ - "type":"structure", - "members":{ - "SessionId":{ - "shape":"SessionId", - "documentation":"

A unique identifier for the established remote connection session.

" - }, - "StreamUrl":{ - "shape":"StreamUrl", - "documentation":"

A WebSocket URL used to establish a SSH connection between the local IDE and remote SageMaker space.

" - }, - "TokenValue":{ - "shape":"TokenValue", - "documentation":"

An encrypted token value containing session and caller information.

" - } - } - }, - "Statistic":{ - "type":"string", - "enum":[ - "Average", - "Minimum", - "Maximum", - "SampleCount", - "Sum" - ] - }, - "StatusDetails":{ - "type":"string", - "max":1024, - "min":0, - "pattern":".*" - }, - "StatusDetailsMap":{ - "type":"map", - "key":{"shape":"SchedulerConfigComponent"}, - "value":{"shape":"SchedulerResourceStatus"} - }, - "StatusMessage":{"type":"string"}, - "StepDescription":{ - "type":"string", - "max":3072, - "min":0, - "pattern":".*" - }, - "StepDisplayName":{ - "type":"string", - "max":256, - "min":0, - "pattern":".*" - }, - "StepName":{ - "type":"string", - "max":64, - "min":0, - "pattern":"[A-Za-z0-9\\-_]*" - }, - "StepStatus":{ - "type":"string", - "enum":[ - "Starting", - "Executing", - "Stopping", - "Stopped", - "Failed", - "Succeeded" - ] - }, - "StopAIBenchmarkJobRequest":{ - "type":"structure", - "required":["AIBenchmarkJobName"], - "members":{ - "AIBenchmarkJobName":{ - "shape":"AIEntityName", - "documentation":"

The name of the AI benchmark job to stop.

" - } - } - }, - "StopAIBenchmarkJobResponse":{ - "type":"structure", - "required":["AIBenchmarkJobArn"], - "members":{ - "AIBenchmarkJobArn":{ - "shape":"AIBenchmarkJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the stopped benchmark job.

" - } - } - }, - "StopAIRecommendationJobRequest":{ - "type":"structure", - "required":["AIRecommendationJobName"], - "members":{ - "AIRecommendationJobName":{ - "shape":"AIEntityName", - "documentation":"

The name of the AI recommendation job to stop.

" - } - } - }, - "StopAIRecommendationJobResponse":{ - "type":"structure", - "required":["AIRecommendationJobArn"], - "members":{ - "AIRecommendationJobArn":{ - "shape":"AIRecommendationJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the stopped recommendation job.

" - } - } - }, - "StopAutoMLJobRequest":{ - "type":"structure", - "required":["AutoMLJobName"], - "members":{ - "AutoMLJobName":{ - "shape":"AutoMLJobName", - "documentation":"

The name of the object you are requesting.

" - } - } - }, - "StopCompilationJobRequest":{ - "type":"structure", - "required":["CompilationJobName"], - "members":{ - "CompilationJobName":{ - "shape":"EntityName", - "documentation":"

The name of the model compilation job to stop.

" - } - } - }, - "StopEdgeDeploymentStageRequest":{ - "type":"structure", - "required":[ - "EdgeDeploymentPlanName", - "StageName" - ], - "members":{ - "EdgeDeploymentPlanName":{ - "shape":"EntityName", - "documentation":"

The name of the edge deployment plan to stop.

" - }, - "StageName":{ - "shape":"EntityName", - "documentation":"

The name of the stage to stop.

" - } - } - }, - "StopEdgePackagingJobRequest":{ - "type":"structure", - "required":["EdgePackagingJobName"], - "members":{ - "EdgePackagingJobName":{ - "shape":"EntityName", - "documentation":"

The name of the edge packaging job.

" - } - } - }, - "StopHyperParameterTuningJobRequest":{ - "type":"structure", - "required":["HyperParameterTuningJobName"], - "members":{ - "HyperParameterTuningJobName":{ - "shape":"HyperParameterTuningJobName", - "documentation":"

The name of the tuning job to stop.

" - } - } - }, - "StopInferenceExperimentRequest":{ - "type":"structure", - "required":[ - "Name", - "ModelVariantActions" - ], - "members":{ - "Name":{ - "shape":"InferenceExperimentName", - "documentation":"

The name of the inference experiment to stop.

" - }, - "ModelVariantActions":{ - "shape":"ModelVariantActionMap", - "documentation":"

Array of key-value pairs, with names of variants mapped to actions. The possible actions are the following:

  • Promote - Promote the shadow variant to a production variant

  • Remove - Delete the variant

  • Retain - Keep the variant as it is

" - }, - "DesiredModelVariants":{ - "shape":"ModelVariantConfigList", - "documentation":"

An array of ModelVariantConfig objects. There is one for each variant that you want to deploy after the inference experiment stops. Each ModelVariantConfig describes the infrastructure configuration for deploying the corresponding variant.

" - }, - "DesiredState":{ - "shape":"InferenceExperimentStopDesiredState", - "documentation":"

The desired state of the experiment after stopping. The possible states are the following:

  • Completed: The experiment completed successfully

  • Cancelled: The experiment was canceled

" - }, - "Reason":{ - "shape":"InferenceExperimentStatusReason", - "documentation":"

The reason for stopping the experiment.

" - } - } - }, - "StopInferenceExperimentResponse":{ - "type":"structure", - "required":["InferenceExperimentArn"], - "members":{ - "InferenceExperimentArn":{ - "shape":"InferenceExperimentArn", - "documentation":"

The ARN of the stopped inference experiment.

" - } - } - }, - "StopInferenceRecommendationsJobRequest":{ - "type":"structure", - "required":["JobName"], - "members":{ - "JobName":{ - "shape":"RecommendationJobName", - "documentation":"

The name of the job you want to stop.

" - } - } - }, - "StopJobRequest":{ - "type":"structure", - "required":[ - "JobName", - "JobCategory" - ], - "members":{ - "JobName":{ - "shape":"JobName", - "documentation":"

The name of the job to stop.

" - }, - "JobCategory":{ - "shape":"JobCategory", - "documentation":"

The category of the job to stop.

" - } - } - }, - "StopJobResponse":{ - "type":"structure", - "members":{} - }, - "StopLabelingJobRequest":{ - "type":"structure", - "required":["LabelingJobName"], - "members":{ - "LabelingJobName":{ - "shape":"LabelingJobName", - "documentation":"

The name of the labeling job to stop.

" - } - } - }, - "StopMlflowTrackingServerRequest":{ - "type":"structure", - "required":["TrackingServerName"], - "members":{ - "TrackingServerName":{ - "shape":"TrackingServerName", - "documentation":"

The name of the tracking server to stop.

" - } - } - }, - "StopMlflowTrackingServerResponse":{ - "type":"structure", - "members":{ - "TrackingServerArn":{ - "shape":"TrackingServerArn", - "documentation":"

The ARN of the stopped tracking server.

" - } - } - }, - "StopMonitoringScheduleRequest":{ - "type":"structure", - "required":["MonitoringScheduleName"], - "members":{ - "MonitoringScheduleName":{ - "shape":"MonitoringScheduleName", - "documentation":"

The name of the schedule to stop.

" - } - } - }, - "StopNotebookInstanceInput":{ - "type":"structure", - "required":["NotebookInstanceName"], - "members":{ - "NotebookInstanceName":{ - "shape":"NotebookInstanceName", - "documentation":"

The name of the notebook instance to terminate.

" - } - } - }, - "StopOptimizationJobRequest":{ - "type":"structure", - "required":["OptimizationJobName"], - "members":{ - "OptimizationJobName":{ - "shape":"EntityName", - "documentation":"

The name that you assigned to the optimization job.

" - } - } - }, - "StopPipelineExecutionRequest":{ - "type":"structure", - "required":[ - "PipelineExecutionArn", - "ClientRequestToken" - ], - "members":{ - "PipelineExecutionArn":{ - "shape":"PipelineExecutionArn", - "documentation":"

The Amazon Resource Name (ARN) of the pipeline execution.

" - }, - "ClientRequestToken":{ - "shape":"IdempotencyToken", - "documentation":"

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.

", - "idempotencyToken":true - } - } - }, - "StopPipelineExecutionResponse":{ - "type":"structure", - "members":{ - "PipelineExecutionArn":{ - "shape":"PipelineExecutionArn", - "documentation":"

The Amazon Resource Name (ARN) of the pipeline execution.

" - } - } - }, - "StopProcessingJobRequest":{ - "type":"structure", - "required":["ProcessingJobName"], - "members":{ - "ProcessingJobName":{ - "shape":"ProcessingJobName", - "documentation":"

The name of the processing job to stop.

" - } - } - }, - "StopTrainingJobRequest":{ - "type":"structure", - "required":["TrainingJobName"], - "members":{ - "TrainingJobName":{ - "shape":"TrainingJobName", - "documentation":"

The name of the training job to stop.

" - } - } - }, - "StopTransformJobRequest":{ - "type":"structure", - "required":["TransformJobName"], - "members":{ - "TransformJobName":{ - "shape":"TransformJobName", - "documentation":"

The name of the batch transform job to stop.

" - } - } - }, - "StoppingCondition":{ - "type":"structure", - "members":{ - "MaxRuntimeInSeconds":{ - "shape":"MaxRuntimeInSeconds", - "documentation":"

The maximum length of time, in seconds, that a training or compilation job can run before it is stopped.

For compilation jobs, if the job does not complete during this time, a TimeOut error is generated. We recommend starting with 900 seconds and increasing as necessary based on your model.

For all other jobs, if the job does not complete during this time, SageMaker ends the job. When RetryStrategy is specified in the job request, MaxRuntimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.

The maximum time that a TrainingJob can run in total, including any time spent publishing metrics or archiving and uploading models after it has been stopped, is 30 days.

", - "box":true - }, - "MaxWaitTimeInSeconds":{ - "shape":"MaxWaitTimeInSeconds", - "documentation":"

The maximum length of time, in seconds, that a managed Spot training job has to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the job can run. It must be equal to or greater than MaxRuntimeInSeconds. If the job does not complete during this time, SageMaker ends the job.

When RetryStrategy is specified in the job request, MaxWaitTimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt.

" - }, - "MaxPendingTimeInSeconds":{ - "shape":"MaxPendingTimeInSeconds", - "documentation":"

The maximum length of time, in seconds, that a training or compilation job can be pending before it is stopped.

When working with training jobs that use capacity from training plans, not all Pending job states count against the MaxPendingTimeInSeconds limit. The following scenarios do not increment the MaxPendingTimeInSeconds counter:

  • The plan is in a Scheduled state: Jobs queued (in Pending status) before a plan's start date (waiting for scheduled start time)

  • Between capacity reservations: Jobs temporarily back to Pending status between two capacity reservation periods

MaxPendingTimeInSeconds only increments when jobs are actively waiting for capacity in an Active plan.

" - } - }, - "documentation":"

Specifies a limit to how long a job can run. When the job reaches the time limit, SageMaker ends the job. Use this API to cap costs.

To stop a training job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

The training algorithms provided by SageMaker automatically save the intermediate results of a model training job when possible. This attempt to save artifacts is only a best effort case as model might not be in a state from which it can be saved. For example, if training has just started, the model might not be ready to save. When saved, this intermediate data is a valid model artifact. You can use it to create a model with CreateModel.

The Neural Topic Model (NTM) currently does not support saving intermediate model artifacts. When training NTMs, make sure that the maximum runtime is sufficient for the training job to complete.

" - }, - "StorageType":{ - "type":"string", - "enum":[ - "Standard", - "InMemory" - ] - }, - "StreamUrl":{"type":"string"}, - "String":{"type":"string"}, - "String1024":{ - "type":"string", - "max":1024, - "min":0 - }, - "String128":{ - "type":"string", - "max":128, - "min":0 - }, - "String200":{ - "type":"string", - "max":200, - "min":1, - "pattern":".+" - }, - "String2048":{ - "type":"string", - "max":2048, - "min":0 - }, - "String256":{ - "type":"string", - "max":256, - "min":0 - }, - "String3072":{ - "type":"string", - "max":3072, - "min":0 - }, - "String40":{ - "type":"string", - "max":40, - "min":0 - }, - "String64":{ - "type":"string", - "max":64, - "min":0 - }, - "String8192":{ - "type":"string", - "max":8192, - "min":0 - }, - "StringParameterValue":{ - "type":"string", - "max":2500, - "min":0, - "pattern":".*" - }, - "StudioLifecycleConfigAppType":{ - "type":"string", - "enum":[ - "JupyterServer", - "KernelGateway", - "CodeEditor", - "JupyterLab" - ] - }, - "StudioLifecycleConfigArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:studio-lifecycle-config/.*|None)" - }, - "StudioLifecycleConfigContent":{ - "type":"string", - "max":16384, - "min":1, - "pattern":"[\\S\\s]+" - }, - "StudioLifecycleConfigDetails":{ - "type":"structure", - "members":{ - "StudioLifecycleConfigArn":{ - "shape":"StudioLifecycleConfigArn", - "documentation":"

The Amazon Resource Name (ARN) of the Lifecycle Configuration.

" - }, - "StudioLifecycleConfigName":{ - "shape":"StudioLifecycleConfigName", - "documentation":"

The name of the Amazon SageMaker AI Studio Lifecycle Configuration.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The creation time of the Amazon SageMaker AI Studio Lifecycle Configuration.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

This value is equivalent to CreationTime because Amazon SageMaker AI Studio Lifecycle Configurations are immutable.

" - }, - "StudioLifecycleConfigAppType":{ - "shape":"StudioLifecycleConfigAppType", - "documentation":"

The App type to which the Lifecycle Configuration is attached.

" - } - }, - "documentation":"

Details of the Amazon SageMaker AI Studio Lifecycle Configuration.

" - }, - "StudioLifecycleConfigName":{ - "type":"string", - "max":63, - "min":0, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" - }, - "StudioLifecycleConfigSortKey":{ - "type":"string", - "enum":[ - "CreationTime", - "LastModifiedTime", - "Name" - ] - }, - "StudioLifecycleConfigsList":{ - "type":"list", - "member":{"shape":"StudioLifecycleConfigDetails"} - }, - "StudioResourceSpecTrainingPlanArn":{ - "type":"string", - "documentation":"

TrainingPlanArn variant for ResourceSpec that allows "None" to detach a training plan. Based on TrainingPlanArn (min:50, max:2048) but with min:0 and "None" in pattern.

", - "max":2048, - "min":0, - "pattern":"(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:training-plan/.*|None)" - }, - "StudioWebPortal":{ - "type":"string", - "enum":[ - "ENABLED", - "DISABLED" - ] - }, - "StudioWebPortalSettings":{ - "type":"structure", - "members":{ - "HiddenMlTools":{ - "shape":"HiddenMlToolsList", - "documentation":"

The machine learning tools that are hidden from the Studio left navigation pane.

" - }, - "HiddenAppTypes":{ - "shape":"HiddenAppTypesList", - "documentation":"

The Applications supported in Studio that are hidden from the Studio left navigation pane.

" - }, - "HiddenInstanceTypes":{ - "shape":"HiddenInstanceTypesList", - "documentation":"

The instance types you are hiding from the Studio user interface.

" - }, - "HiddenSageMakerImageVersionAliases":{ - "shape":"HiddenSageMakerImageVersionAliasesList", - "documentation":"

The version aliases you are hiding from the Studio user interface.

" - }, - "ExecutionRoleSessionNameMode":{ - "shape":"ExecutionRoleSessionNameMode", - "documentation":"

The execution role session name mode. If this value is set to USER_IDENTITY, the session name of the execution role corresponds to the user's identity. For IAM domains, the session name is the IAM session name used to generate the presigned URL. For IAM Identity Center domains, the session name is the username of the associated IAM Identity Center user. If this value is set to STATIC or is not set, the session name defaults to SageMaker.

" - } - }, - "documentation":"

Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.

" - }, - "SubnetId":{ - "type":"string", - "max":32, - "min":0, - "pattern":"[-0-9a-zA-Z]+" - }, - "Subnets":{ - "type":"list", - "member":{"shape":"SubnetId"}, - "max":16, - "min":1 - }, - "SubscribedWorkteam":{ - "type":"structure", - "required":["WorkteamArn"], - "members":{ - "WorkteamArn":{ - "shape":"WorkteamArn", - "documentation":"

The Amazon Resource Name (ARN) of the vendor that you have subscribed.

" - }, - "MarketplaceTitle":{ - "shape":"String200", - "documentation":"

The title of the service provided by the vendor in the Amazon Marketplace.

" - }, - "SellerName":{ - "shape":"String", - "documentation":"

The name of the vendor in the Amazon Marketplace.

" - }, - "MarketplaceDescription":{ - "shape":"String200", - "documentation":"

The description of the vendor from the Amazon Marketplace.

" - }, - "ListingId":{ - "shape":"String", - "documentation":"

Marketplace product listing ID.

" - } - }, - "documentation":"

Describes a work team of a vendor that does the labelling job.

" - }, - "SubscribedWorkteams":{ - "type":"list", - "member":{"shape":"SubscribedWorkteam"} - }, - "Success":{"type":"boolean"}, - "SuggestionQuery":{ - "type":"structure", - "members":{ - "PropertyNameQuery":{ - "shape":"PropertyNameQuery", - "documentation":"

Defines a property name hint. Only property names that begin with the specified hint are included in the response.

" - } - }, - "documentation":"

Specified in the GetSearchSuggestions request. Limits the property names that are included in the response.

" - }, - "TableFormat":{ - "type":"string", - "enum":[ - "Default", - "Glue", - "Iceberg" - ] - }, - "TableName":{ - "type":"string", - "max":255, - "min":1, - "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" - }, - "TabularJobConfig":{ - "type":"structure", - "required":["TargetAttributeName"], - "members":{ - "CandidateGenerationConfig":{ - "shape":"CandidateGenerationConfig", - "documentation":"

The configuration information of how model candidates are generated.

" - }, - "CompletionCriteria":{"shape":"AutoMLJobCompletionCriteria"}, - "FeatureSpecificationS3Uri":{ - "shape":"S3Uri", - "documentation":"

A URL to the Amazon S3 data source containing selected features from the input data source to run an Autopilot job V2. You can input FeatureAttributeNames (optional) in JSON format as shown below:

{ \"FeatureAttributeNames\":[\"col1\", \"col2\", ...] }.

You can also specify the data type of the feature (optional) in the format shown below:

{ \"FeatureDataTypes\":{\"col1\":\"numeric\", \"col2\":\"categorical\" ... } }

These column keys may not include the target column.

In ensembling mode, Autopilot only supports the following data types: numeric, categorical, text, and datetime. In HPO mode, Autopilot can support numeric, categorical, text, datetime, and sequence.

If only FeatureDataTypes is provided, the column keys (col1, col2,..) should be a subset of the column names in the input data.

If both FeatureDataTypes and FeatureAttributeNames are provided, then the column keys should be a subset of the column names provided in FeatureAttributeNames.

The key name FeatureAttributeNames is fixed. The values listed in [\"col1\", \"col2\", ...] are case sensitive and should be a list of strings containing unique values that are a subset of the column names in the input data. The list of columns provided must not include the target column.

" - }, - "Mode":{ - "shape":"AutoMLMode", - "documentation":"

The method that Autopilot uses to train the data. You can either specify the mode manually or let Autopilot choose for you based on the dataset size by selecting AUTO. In AUTO mode, Autopilot chooses ENSEMBLING for datasets smaller than 100 MB, and HYPERPARAMETER_TUNING for larger ones.

The ENSEMBLING mode uses a multi-stack ensemble model to predict classification and regression tasks directly from your dataset. This machine learning mode combines several base models to produce an optimal predictive model. It then uses a stacking ensemble method to combine predictions from contributing members. A multi-stack ensemble model can provide better performance over a single model by combining the predictive capabilities of multiple models. See Autopilot algorithm support for a list of algorithms supported by ENSEMBLING mode.

The HYPERPARAMETER_TUNING (HPO) mode uses the best hyperparameters to train the best version of a model. HPO automatically selects an algorithm for the type of problem you want to solve. Then HPO finds the best hyperparameters according to your objective metric. See Autopilot algorithm support for a list of algorithms supported by HYPERPARAMETER_TUNING mode.

" - }, - "GenerateCandidateDefinitionsOnly":{ - "shape":"GenerateCandidateDefinitionsOnly", - "documentation":"

Generates possible candidates without training the models. A model candidate is a combination of data preprocessors, algorithms, and algorithm parameter settings.

", - "box":true - }, - "ProblemType":{ - "shape":"ProblemType", - "documentation":"

The type of supervised learning problem available for the model candidates of the AutoML job V2. For more information, see SageMaker Autopilot problem types.

You must either specify the type of supervised learning problem in ProblemType and provide the AutoMLJobObjective metric, or none at all.

" - }, - "TargetAttributeName":{ - "shape":"TargetAttributeName", - "documentation":"

The name of the target variable in supervised learning, usually represented by 'y'.

" - }, - "SampleWeightAttributeName":{ - "shape":"SampleWeightAttributeName", - "documentation":"

If specified, this column name indicates which column of the dataset should be treated as sample weights for use by the objective metric during the training, evaluation, and the selection of the best model. This column is not considered as a predictive feature. For more information on Autopilot metrics, see Metrics and validation.

Sample weights should be numeric, non-negative, with larger values indicating which rows are more important than others. Data points that have invalid or no weight value are excluded.

Support for sample weights is available in Ensembling mode only.

" - } - }, - "documentation":"

The collection of settings used by an AutoML job V2 for the tabular problem type.

" - }, - "TabularResolvedAttributes":{ - "type":"structure", - "members":{ - "ProblemType":{ - "shape":"ProblemType", - "documentation":"

The type of supervised learning problem available for the model candidates of the AutoML job V2 (Binary Classification, Multiclass Classification, Regression). For more information, see SageMaker Autopilot problem types.

" - } - }, - "documentation":"

The resolved attributes specific to the tabular problem type.

" - }, - "Tag":{ - "type":"structure", - "required":[ - "Key", - "Value" - ], - "members":{ - "Key":{ - "shape":"TagKey", - "documentation":"

The tag key. Tag keys must be unique per resource.

" - }, - "Value":{ - "shape":"TagValue", - "documentation":"

The tag value.

" - } - }, - "documentation":"

A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.

You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.

For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.

" - }, - "TagKey":{ - "type":"string", - "max":128, - "min":1, - "pattern":"([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)" - }, - "TagKeyList":{ - "type":"list", - "member":{"shape":"TagKey"}, - "max":50, - "min":1 - }, - "TagList":{ - "type":"list", - "member":{"shape":"Tag"}, - "max":50, - "min":0 - }, - "TagPropagation":{ - "type":"string", - "enum":[ - "ENABLED", - "DISABLED" - ] - }, - "TagValue":{ - "type":"string", - "max":256, - "min":0, - "pattern":"([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)" - }, - "TargetAttributeName":{ - "type":"string", - "min":1 - }, - "TargetCount":{ - "type":"integer", - "box":true, - "min":0 - }, - "TargetDevice":{ - "type":"string", - "enum":[ - "lambda", - "ml_m4", - "ml_m5", - "ml_m6g", - "ml_c4", - "ml_c5", - "ml_c6g", - "ml_p2", - "ml_p3", - "ml_g4dn", - "ml_inf1", - "ml_inf2", - "ml_trn1", - "ml_eia2", - "jetson_tx1", - "jetson_tx2", - "jetson_nano", - "jetson_xavier", - "rasp3b", - "rasp4b", - "imx8qm", - "deeplens", - "rk3399", - "rk3288", - "aisage", - "sbe_c", - "qcs605", - "qcs603", - "sitara_am57x", - "amba_cv2", - "amba_cv22", - "amba_cv25", - "x86_win32", - "x86_win64", - "coreml", - "jacinto_tda4vm", - "imx8mplus" - ] - }, - "TargetLabelColumn":{ - "type":"string", - "max":256, - "min":1 - }, - "TargetObjectiveMetricValue":{ - "type":"float", - "box":true - }, - "TargetPlatform":{ - "type":"structure", - "required":[ - "Os", - "Arch" - ], - "members":{ - "Os":{ - "shape":"TargetPlatformOs", - "documentation":"

Specifies a target platform OS.

  • LINUX: Linux-based operating systems.

  • ANDROID: Android operating systems. Android API level can be specified using the ANDROID_PLATFORM compiler option. For example, \"CompilerOptions\": {'ANDROID_PLATFORM': 28}

" - }, - "Arch":{ - "shape":"TargetPlatformArch", - "documentation":"

Specifies a target platform architecture.

  • X86_64: 64-bit version of the x86 instruction set.

  • X86: 32-bit version of the x86 instruction set.

  • ARM64: ARMv8 64-bit CPU.

  • ARM_EABIHF: ARMv7 32-bit, Hard Float.

  • ARM_EABI: ARMv7 32-bit, Soft Float. Used by Android 32-bit ARM platform.

" - }, - "Accelerator":{ - "shape":"TargetPlatformAccelerator", - "documentation":"

Specifies a target platform accelerator (optional).

  • NVIDIA: Nvidia graphics processing unit. It also requires gpu-code, trt-ver, cuda-ver compiler options

  • MALI: ARM Mali graphics processor

  • INTEL_GRAPHICS: Integrated Intel graphics

" - } - }, - "documentation":"

Contains information about a target platform that you want your model to run on, such as OS, architecture, and accelerators. It is an alternative of TargetDevice.

" - }, - "TargetPlatformAccelerator":{ - "type":"string", - "enum":[ - "INTEL_GRAPHICS", - "MALI", - "NVIDIA", - "NNA" - ] - }, - "TargetPlatformArch":{ - "type":"string", - "enum":[ - "X86_64", - "X86", - "ARM64", - "ARM_EABI", - "ARM_EABIHF" - ] - }, - "TargetPlatformOs":{ - "type":"string", - "enum":[ - "ANDROID", - "LINUX" - ] - }, - "TargetTrackingScalingPolicyConfiguration":{ - "type":"structure", - "members":{ - "MetricSpecification":{ - "shape":"MetricSpecification", - "documentation":"

An object containing information about a metric.

" - }, - "TargetValue":{ - "shape":"Double", - "documentation":"

The recommended target value to specify for the metric when creating a scaling policy.

", - "box":true - } - }, - "documentation":"

A target tracking scaling policy. Includes support for predefined or customized metrics.

When using the PutScalingPolicy API, this parameter is required when you are creating a policy with the policy type TargetTrackingScaling.

" - }, - "TaskAvailabilityLifetimeInSeconds":{ - "type":"integer", - "box":true, - "min":60 - }, - "TaskCount":{ - "type":"integer", - "box":true, - "min":0 - }, - "TaskDescription":{ - "type":"string", - "max":255, - "min":1, - "pattern":".+" - }, - "TaskInput":{ - "type":"string", - "max":128000, - "min":2, - "pattern":"[\\S\\s]+" - }, - "TaskKeyword":{ - "type":"string", - "max":30, - "min":1, - "pattern":"[A-Za-z0-9]+( [A-Za-z0-9]+)*" - }, - "TaskKeywords":{ - "type":"list", - "member":{"shape":"TaskKeyword"}, - "max":5, - "min":1 - }, - "TaskTimeLimitInSeconds":{ - "type":"integer", - "box":true, - "min":30 - }, - "TaskTitle":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[\\t\\n\\r -\\uD7FF\\uE000-\\uFFFD]*" - }, - "TemplateContent":{ - "type":"string", - "max":128000, - "min":1, - "pattern":"[\\S\\s]+" - }, - "TemplateContentSha256":{ - "type":"string", - "max":128000, - "min":1 - }, - "TemplateProviderDetail":{ - "type":"structure", - "members":{ - "CfnTemplateProviderDetail":{ - "shape":"CfnTemplateProviderDetail", - "documentation":"

Details about a CloudFormation template provider configuration and associated provisioning information.

" - } - }, - "documentation":"

Details about a template provider configuration and associated provisioning information.

" - }, - "TemplateProviderDetailList":{ - "type":"list", - "member":{"shape":"TemplateProviderDetail"}, - "max":1, - "min":1 - }, - "TemplateUrl":{ - "type":"string", - "max":2048, - "min":1 - }, - "TensorBoardAppSettings":{ - "type":"structure", - "members":{ - "DefaultResourceSpec":{ - "shape":"ResourceSpec", - "documentation":"

The default instance type and the Amazon Resource Name (ARN) of the SageMaker AI image created on the instance.

" - } - }, - "documentation":"

The TensorBoard app settings.

" - }, - "TensorBoardOutputConfig":{ - "type":"structure", - "required":["S3OutputPath"], - "members":{ - "LocalPath":{ - "shape":"DirectoryPath", - "documentation":"

Path to local storage location for tensorBoard output. Defaults to /opt/ml/output/tensorboard.

" - }, - "S3OutputPath":{ - "shape":"S3Uri", - "documentation":"

Path to Amazon S3 storage location for TensorBoard output.

" - } - }, - "documentation":"

Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard output data.

" - }, - "TenthFractionsOfACent":{ - "type":"integer", - "max":9, - "min":0 - }, - "TerminationWaitInSeconds":{ - "type":"integer", - "box":true, - "max":3600, - "min":0 - }, - "TextClassificationJobConfig":{ - "type":"structure", - "required":[ - "ContentColumn", - "TargetLabelColumn" - ], - "members":{ - "CompletionCriteria":{ - "shape":"AutoMLJobCompletionCriteria", - "documentation":"

How long a job is allowed to run, or how many candidates a job is allowed to generate.

" - }, - "ContentColumn":{ - "shape":"ContentColumn", - "documentation":"

The name of the column used to provide the sentences to be classified. It should not be the same as the target column.

" - }, - "TargetLabelColumn":{ - "shape":"TargetLabelColumn", - "documentation":"

The name of the column used to provide the class labels. It should not be same as the content column.

" - } - }, - "documentation":"

The collection of settings used by an AutoML job V2 for the text classification problem type.

" - }, - "TextGenerationHyperParameterKey":{ - "type":"string", - "max":32, - "min":0, - "pattern":"[a-zA-Z0-9._-]+" - }, - "TextGenerationHyperParameterValue":{ - "type":"string", - "max":16, - "min":0, - "pattern":"[a-zA-Z0-9._-]+" - }, - "TextGenerationHyperParameters":{ - "type":"map", - "key":{"shape":"TextGenerationHyperParameterKey"}, - "value":{"shape":"TextGenerationHyperParameterValue"}, - "max":30, - "min":0 - }, - "TextGenerationJobConfig":{ - "type":"structure", - "members":{ - "CompletionCriteria":{ - "shape":"AutoMLJobCompletionCriteria", - "documentation":"

How long a fine-tuning job is allowed to run. For TextGenerationJobConfig problem types, the MaxRuntimePerTrainingJobInSeconds attribute of AutoMLJobCompletionCriteria defaults to 72h (259200s).

" - }, - "BaseModelName":{ - "shape":"BaseModelName", - "documentation":"

The name of the base model to fine-tune. Autopilot supports fine-tuning a variety of large language models. For information on the list of supported models, see Text generation models supporting fine-tuning in Autopilot. If no BaseModelName is provided, the default model used is Falcon7BInstruct.

" - }, - "TextGenerationHyperParameters":{ - "shape":"TextGenerationHyperParameters", - "documentation":"

The hyperparameters used to configure and optimize the learning process of the base model. You can set any combination of the following hyperparameters for all base models. For more information on each supported hyperparameter, see Optimize the learning process of your text generation models with hyperparameters.

  • \"epochCount\": The number of times the model goes through the entire training dataset. Its value should be a string containing an integer value within the range of \"1\" to \"10\".

  • \"batchSize\": The number of data samples used in each iteration of training. Its value should be a string containing an integer value within the range of \"1\" to \"64\".

  • \"learningRate\": The step size at which a model's parameters are updated during training. Its value should be a string containing a floating-point value within the range of \"0\" to \"1\".

  • \"learningRateWarmupSteps\": The number of training steps during which the learning rate gradually increases before reaching its target or maximum value. Its value should be a string containing an integer value within the range of \"0\" to \"250\".

Here is an example where all four hyperparameters are configured.

{ \"epochCount\":\"5\", \"learningRate\":\"0.5\", \"batchSize\": \"32\", \"learningRateWarmupSteps\": \"10\" }

" - }, - "ModelAccessConfig":{"shape":"ModelAccessConfig"} - }, - "documentation":"

The collection of settings used by an AutoML job V2 for the text generation problem type.

The text generation models that support fine-tuning in Autopilot are currently accessible exclusively in regions supported by Canvas. Refer to the documentation of Canvas for the full list of its supported Regions.

" - }, - "TextGenerationResolvedAttributes":{ - "type":"structure", - "members":{ - "BaseModelName":{ - "shape":"BaseModelName", - "documentation":"

The name of the base model to fine-tune.

" - } - }, - "documentation":"

The resolved attributes specific to the text generation problem type.

" - }, - "ThingName":{ - "type":"string", - "max":128, - "min":0, - "pattern":"[a-zA-Z0-9:_-]+" - }, - "ThroughputConfig":{ - "type":"structure", - "required":["ThroughputMode"], - "members":{ - "ThroughputMode":{ - "shape":"ThroughputMode", - "documentation":"

The mode used for your feature group throughput: ON_DEMAND or PROVISIONED.

" - }, - "ProvisionedReadCapacityUnits":{ - "shape":"CapacityUnit", - "documentation":"

For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.

This field is not applicable for on-demand feature groups.

" - }, - "ProvisionedWriteCapacityUnits":{ - "shape":"CapacityUnit", - "documentation":"

For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.

This field is not applicable for on-demand feature groups.

" - } - }, - "documentation":"

Used to set feature group throughput configuration. There are two modes: ON_DEMAND and PROVISIONED. With on-demand mode, you are charged for data reads and writes that your application performs on your feature group. You do not need to specify read and write throughput because Feature Store accommodates your workloads as they ramp up and down. You can switch a feature group to on-demand only once in a 24 hour period. With provisioned throughput mode, you specify the read and write capacity per second that you expect your application to require, and you are billed based on those limits. Exceeding provisioned throughput will result in your requests being throttled.

Note: PROVISIONED throughput mode is supported only for feature groups that are offline-only, or use the Standard tier online store.

" - }, - "ThroughputConfigDescription":{ - "type":"structure", - "required":["ThroughputMode"], - "members":{ - "ThroughputMode":{ - "shape":"ThroughputMode", - "documentation":"

The mode used for your feature group throughput: ON_DEMAND or PROVISIONED.

" - }, - "ProvisionedReadCapacityUnits":{ - "shape":"CapacityUnit", - "documentation":"

For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.

This field is not applicable for on-demand feature groups.

" - }, - "ProvisionedWriteCapacityUnits":{ - "shape":"CapacityUnit", - "documentation":"

For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.

This field is not applicable for on-demand feature groups.

" - } - }, - "documentation":"

Active throughput configuration of the feature group. There are two modes: ON_DEMAND and PROVISIONED. With on-demand mode, you are charged for data reads and writes that your application performs on your feature group. You do not need to specify read and write throughput because Feature Store accommodates your workloads as they ramp up and down. You can switch a feature group to on-demand only once in a 24 hour period. With provisioned throughput mode, you specify the read and write capacity per second that you expect your application to require, and you are billed based on those limits. Exceeding provisioned throughput will result in your requests being throttled.

Note: PROVISIONED throughput mode is supported only for feature groups that are offline-only, or use the Standard tier online store.

" - }, - "ThroughputConfigUpdate":{ - "type":"structure", - "members":{ - "ThroughputMode":{ - "shape":"ThroughputMode", - "documentation":"

Target throughput mode of the feature group. Throughput update is an asynchronous operation, and the outcome should be monitored by polling LastUpdateStatus field in DescribeFeatureGroup response. You cannot update a feature group's throughput while another update is in progress.

" - }, - "ProvisionedReadCapacityUnits":{ - "shape":"CapacityUnit", - "documentation":"

For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.

" - }, - "ProvisionedWriteCapacityUnits":{ - "shape":"CapacityUnit", - "documentation":"

For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.

" - } - }, - "documentation":"

The new throughput configuration for the feature group. You can switch between on-demand and provisioned modes or update the read / write capacity of provisioned feature groups. You can switch a feature group to on-demand only once in a 24 hour period.

" - }, - "ThroughputMode":{ - "type":"string", - "enum":[ - "OnDemand", - "Provisioned" - ] - }, - "TimeSeriesConfig":{ - "type":"structure", - "required":[ - "TargetAttributeName", - "TimestampAttributeName", - "ItemIdentifierAttributeName" - ], - "members":{ - "TargetAttributeName":{ - "shape":"TargetAttributeName", - "documentation":"

The name of the column representing the target variable that you want to predict for each item in your dataset. The data type of the target variable must be numerical.

" - }, - "TimestampAttributeName":{ - "shape":"TimestampAttributeName", - "documentation":"

The name of the column indicating a point in time at which the target value of a given item is recorded.

" - }, - "ItemIdentifierAttributeName":{ - "shape":"ItemIdentifierAttributeName", - "documentation":"

The name of the column that represents the set of item identifiers for which you want to predict the target value.

" - }, - "GroupingAttributeNames":{ - "shape":"GroupingAttributeNames", - "documentation":"

A set of columns names that can be grouped with the item identifier column to create a composite key for which a target value is predicted.

" - } - }, - "documentation":"

The collection of components that defines the time-series.

" - }, - "TimeSeriesForecastingJobConfig":{ - "type":"structure", - "required":[ - "ForecastFrequency", - "ForecastHorizon", - "TimeSeriesConfig" - ], - "members":{ - "FeatureSpecificationS3Uri":{ - "shape":"S3Uri", - "documentation":"

A URL to the Amazon S3 data source containing additional selected features that complement the target, itemID, timestamp, and grouped columns set in TimeSeriesConfig. When not provided, the AutoML job V2 includes all the columns from the original dataset that are not already declared in TimeSeriesConfig. If provided, the AutoML job V2 only considers these additional columns as a complement to the ones declared in TimeSeriesConfig.

You can input FeatureAttributeNames (optional) in JSON format as shown below:

{ \"FeatureAttributeNames\":[\"col1\", \"col2\", ...] }.

You can also specify the data type of the feature (optional) in the format shown below:

{ \"FeatureDataTypes\":{\"col1\":\"numeric\", \"col2\":\"categorical\" ... } }

Autopilot supports the following data types: numeric, categorical, text, and datetime.

These column keys must not include any column set in TimeSeriesConfig.

" - }, - "CompletionCriteria":{"shape":"AutoMLJobCompletionCriteria"}, - "ForecastFrequency":{ - "shape":"ForecastFrequency", - "documentation":"

The frequency of predictions in a forecast.

Valid intervals are an integer followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min (Minute). For example, 1D indicates every day and 15min indicates every 15 minutes. The value of a frequency must not overlap with the next larger frequency. For example, you must use a frequency of 1H instead of 60min.

The valid values for each frequency are the following:

  • Minute - 1-59

  • Hour - 1-23

  • Day - 1-6

  • Week - 1-4

  • Month - 1-11

  • Year - 1

" - }, - "ForecastHorizon":{ - "shape":"ForecastHorizon", - "documentation":"

The number of time-steps that the model predicts. The forecast horizon is also called the prediction length. The maximum forecast horizon is the lesser of 500 time-steps or 1/4 of the time-steps in the dataset.

" - }, - "ForecastQuantiles":{ - "shape":"ForecastQuantiles", - "documentation":"

The quantiles used to train the model for forecasts at a specified quantile. You can specify quantiles from 0.01 (p1) to 0.99 (p99), by increments of 0.01 or higher. Up to five forecast quantiles can be specified. When ForecastQuantiles is not provided, the AutoML job uses the quantiles p10, p50, and p90 as default.

" - }, - "Transformations":{ - "shape":"TimeSeriesTransformations", - "documentation":"

The transformations modifying specific attributes of the time-series, such as filling strategies for missing values.

" - }, - "TimeSeriesConfig":{ - "shape":"TimeSeriesConfig", - "documentation":"

The collection of components that defines the time-series.

" - }, - "HolidayConfig":{ - "shape":"HolidayConfig", - "documentation":"

The collection of holiday featurization attributes used to incorporate national holiday information into your forecasting model.

" - }, - "CandidateGenerationConfig":{"shape":"CandidateGenerationConfig"} - }, - "documentation":"

The collection of settings used by an AutoML job V2 for the time-series forecasting problem type.

" - }, - "TimeSeriesForecastingSettings":{ - "type":"structure", - "members":{ - "Status":{ - "shape":"FeatureStatus", - "documentation":"

Describes whether time series forecasting is enabled or disabled in the Canvas application.

" - }, - "AmazonForecastRoleArn":{ - "shape":"RoleArn", - "documentation":"

The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default, Canvas uses the execution role specified in the UserProfile that launches the Canvas application. If an execution role is not specified in the UserProfile, Canvas uses the execution role specified in the Domain that owns the UserProfile. To allow time series forecasting, this IAM role should have the AmazonSageMakerCanvasForecastAccess policy attached and forecast.amazonaws.com added in the trust relationship as a service principal.

" - } - }, - "documentation":"

Time series forecast settings for the SageMaker Canvas application.

" - }, - "TimeSeriesTransformations":{ - "type":"structure", - "members":{ - "Filling":{ - "shape":"FillingTransformations", - "documentation":"

A key value pair defining the filling method for a column, where the key is the column name and the value is an object which defines the filling logic. You can specify multiple filling methods for a single column.

The supported filling methods and their corresponding options are:

  • frontfill: none (Supported only for target column)

  • middlefill: zero, value, median, mean, min, max

  • backfill: zero, value, median, mean, min, max

  • futurefill: zero, value, median, mean, min, max

To set a filling method to a specific value, set the fill parameter to the chosen filling method value (for example \"backfill\" : \"value\"), and define the filling value in an additional parameter prefixed with \"_value\". For example, to set backfill to a value of 2, you must include two parameters: \"backfill\": \"value\" and \"backfill_value\":\"2\".

" - }, - "Aggregation":{ - "shape":"AggregationTransformations", - "documentation":"

A key value pair defining the aggregation method for a column, where the key is the column name and the value is the aggregation method.

The supported aggregation methods are sum (default), avg, first, min, max.

Aggregation is only supported for the target column.

" - } - }, - "documentation":"

Transformations allowed on the dataset. Supported transformations are Filling and Aggregation. Filling specifies how to add values to missing values in the dataset. Aggregation defines how to aggregate data that does not align with forecast frequency.

" - }, - "Timestamp":{"type":"timestamp"}, - "TimestampAttributeName":{ - "type":"string", - "max":256, - "min":1 - }, - "TokenValue":{ - "type":"string", - "max":1024, - "min":0 - }, - "TotalHits":{ - "type":"structure", - "members":{ - "Value":{ - "shape":"Long", - "documentation":"

The total number of matching results. This value may be exact or an estimate, depending on the Relation field.

", - "box":true - }, - "Relation":{ - "shape":"Relation", - "documentation":"

Indicates the relationship between the returned Value and the actual total number of matching results. Possible values are:

  • EqualTo: The Value is the exact count of matching results.

  • GreaterThanOrEqualTo: The Value is a lower bound of the actual count of matching results.

" - } - }, - "documentation":"

Represents the total number of matching results and indicates how accurate that count is.

The Value field provides the count, which may be exact or estimated. The Relation field indicates whether it's an exact figure or a lower bound. This helps understand the full scope of search results, especially when dealing with large result sets.

" - }, - "TotalInstanceCount":{ - "type":"integer", - "box":true, - "min":0 - }, - "TotalStepCountPerEpoch":{ - "type":"long", - "documentation":"

TrainingProgressInfo relevant fields

", - "box":true, - "min":0 - }, - "TrackingServerArn":{ - "type":"string", - "max":2048, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:mlflow-tracking-server/.*" - }, - "TrackingServerMaintenanceStatus":{ - "type":"string", - "enum":[ - "MaintenanceInProgress", - "MaintenanceComplete", - "MaintenanceFailed" - ] - }, - "TrackingServerName":{ - "type":"string", - "max":256, - "min":1, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}" - }, - "TrackingServerSize":{ - "type":"string", - "enum":[ - "Small", - "Medium", - "Large" - ] - }, - "TrackingServerStatus":{ - "type":"string", - "enum":[ - "Creating", - "Created", - "CreateFailed", - "Updating", - "Updated", - "UpdateFailed", - "Deleting", - "DeleteFailed", - "Stopping", - "Stopped", - "StopFailed", - "Starting", - "Started", - "StartFailed", - "MaintenanceInProgress", - "MaintenanceComplete", - "MaintenanceFailed" - ] - }, - "TrackingServerSummary":{ - "type":"structure", - "members":{ - "TrackingServerArn":{ - "shape":"TrackingServerArn", - "documentation":"

The ARN of a listed tracking server.

" - }, - "TrackingServerName":{ - "shape":"TrackingServerName", - "documentation":"

The name of a listed tracking server.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

The creation time of a listed tracking server.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

The last modified time of a listed tracking server.

" - }, - "TrackingServerStatus":{ - "shape":"TrackingServerStatus", - "documentation":"

The creation status of a listed tracking server.

" - }, - "IsActive":{ - "shape":"IsTrackingServerActive", - "documentation":"

The activity status of a listed tracking server.

" - }, - "MlflowVersion":{ - "shape":"MlflowVersion", - "documentation":"

The MLflow version used for a listed tracking server.

" - } - }, - "documentation":"

The summary of the tracking server to list.

" - }, - "TrackingServerSummaryList":{ - "type":"list", - "member":{"shape":"TrackingServerSummary"}, - "max":100, - "min":0 - }, - "TrackingServerUrl":{ - "type":"string", - "max":2048, - "min":0 - }, - "TrafficDurationInSeconds":{ - "type":"integer", - "box":true, - "min":1 - }, - "TrafficPattern":{ - "type":"structure", - "members":{ - "TrafficType":{ - "shape":"TrafficType", - "documentation":"

Defines the traffic patterns. Choose either PHASES or STAIRS.

" - }, - "Phases":{ - "shape":"Phases", - "documentation":"

Defines the phases traffic specification.

" - }, - "Stairs":{ - "shape":"Stairs", - "documentation":"

Defines the stairs traffic pattern.

" - } - }, - "documentation":"

Defines the traffic pattern of the load test.

" - }, - "TrafficRoutingConfig":{ - "type":"structure", - "required":[ - "Type", - "WaitIntervalInSeconds" - ], - "members":{ - "Type":{ - "shape":"TrafficRoutingConfigType", - "documentation":"

Traffic routing strategy type.

  • ALL_AT_ONCE: Endpoint traffic shifts to the new fleet in a single step.

  • CANARY: Endpoint traffic shifts to the new fleet in two steps. The first step is the canary, which is a small portion of the traffic. The second step is the remainder of the traffic.

  • LINEAR: Endpoint traffic shifts to the new fleet in n steps of a configurable size.

" - }, - "WaitIntervalInSeconds":{ - "shape":"WaitIntervalInSeconds", - "documentation":"

The waiting time (in seconds) between incremental steps to turn on traffic on the new endpoint fleet.

" - }, - "CanarySize":{ - "shape":"CapacitySize", - "documentation":"

Batch size for the first step to turn on traffic on the new endpoint fleet. Value must be less than or equal to 50% of the variant's total instance count.

" - }, - "LinearStepSize":{ - "shape":"CapacitySize", - "documentation":"

Batch size for each step to turn on traffic on the new endpoint fleet. Value must be 10-50% of the variant's total instance count.

" - } - }, - "documentation":"

Defines the traffic routing strategy during an endpoint deployment to shift traffic from the old fleet to the new fleet.

" - }, - "TrafficRoutingConfigType":{ - "type":"string", - "enum":[ - "ALL_AT_ONCE", - "CANARY", - "LINEAR" - ] - }, - "TrafficType":{ - "type":"string", - "enum":[ - "PHASES", - "STAIRS" - ] - }, - "TrainingContainerArgument":{ - "type":"string", - "max":256, - "min":0, - "pattern":".*" - }, - "TrainingContainerArguments":{ - "type":"list", - "member":{"shape":"TrainingContainerArgument"}, - "max":100, - "min":1 - }, - "TrainingContainerEntrypoint":{ - "type":"list", - "member":{"shape":"TrainingContainerEntrypointString"}, - "max":100, - "min":1 - }, - "TrainingContainerEntrypointString":{ - "type":"string", - "max":256, - "min":0, - "pattern":".*" - }, - "TrainingEnvironmentKey":{ - "type":"string", - "max":512, - "min":0, - "pattern":"[a-zA-Z_][a-zA-Z0-9_]*" - }, - "TrainingEnvironmentMap":{ - "type":"map", - "key":{"shape":"TrainingEnvironmentKey"}, - "value":{"shape":"TrainingEnvironmentValue"}, - "max":100, - "min":0 - }, - "TrainingEnvironmentValue":{ - "type":"string", - "max":512, - "min":0, - "pattern":"[\\S\\s]*" - }, - "TrainingEpochCount":{ - "type":"long", - "box":true, - "min":0 - }, - "TrainingEpochIndex":{ - "type":"long", - "box":true, - "min":0 - }, - "TrainingImageConfig":{ - "type":"structure", - "required":["TrainingRepositoryAccessMode"], - "members":{ - "TrainingRepositoryAccessMode":{ - "shape":"TrainingRepositoryAccessMode", - "documentation":"

The method that your training job will use to gain access to the images in your private Docker registry. For access to an image in a private Docker registry, set to Vpc.

" - }, - "TrainingRepositoryAuthConfig":{ - "shape":"TrainingRepositoryAuthConfig", - "documentation":"

An object containing authentication information for a private Docker registry containing your training images.

" - } - }, - "documentation":"

The configuration to use an image from a private Docker registry for a training job.

" - }, - "TrainingInputMode":{ - "type":"string", - "documentation":"

The training input mode that the algorithm supports. For more information about input modes, see Algorithms.

Pipe mode

If an algorithm supports Pipe mode, Amazon SageMaker streams data directly from Amazon S3 to the container.

File mode

If an algorithm supports File mode, SageMaker downloads the training data from S3 to the provisioned ML storage volume, and mounts the directory to the Docker volume for the training container.

You must provision the ML storage volume with sufficient capacity to accommodate the data downloaded from S3. In addition to the training data, the ML storage volume also stores the output model. The algorithm container uses the ML storage volume to also store intermediate information, if any.

For distributed algorithms, training data is distributed uniformly. Your training duration is predictable if the input data objects sizes are approximately the same. SageMaker does not split the files any further for model training. If the object sizes are skewed, training won't be optimal as the data distribution is also skewed when one host in a training cluster is overloaded, thus becoming a bottleneck in training.

FastFile mode

If an algorithm supports FastFile mode, SageMaker streams data directly from S3 to the container with no code changes, and provides file system access to the data. Users can author their training script to interact with these files as if they were stored on disk.

FastFile mode works best when the data is read sequentially. Augmented manifest files aren't supported. The startup time is lower when there are fewer files in the S3 bucket provided.

", - "enum":[ - "Pipe", - "File", - "FastFile" - ] - }, - "TrainingInstanceCount":{ - "type":"integer", - "min":0 - }, - "TrainingInstanceType":{ - "type":"string", - "enum":[ - "ml.m4.xlarge", - "ml.m4.2xlarge", - "ml.m4.4xlarge", - "ml.m4.10xlarge", - "ml.m4.16xlarge", - "ml.g4dn.xlarge", - "ml.g4dn.2xlarge", - "ml.g4dn.4xlarge", - "ml.g4dn.8xlarge", - "ml.g4dn.12xlarge", - "ml.g4dn.16xlarge", - "ml.m5.large", - "ml.m5.xlarge", - "ml.m5.2xlarge", - "ml.m5.4xlarge", - "ml.m5.12xlarge", - "ml.m5.24xlarge", - "ml.c4.xlarge", - "ml.c4.2xlarge", - "ml.c4.4xlarge", - "ml.c4.8xlarge", - "ml.p2.xlarge", - "ml.p2.8xlarge", - "ml.p2.16xlarge", - "ml.p3.2xlarge", - "ml.p3.8xlarge", - "ml.p3.16xlarge", - "ml.p3dn.24xlarge", - "ml.p4d.24xlarge", - "ml.p4de.24xlarge", - "ml.p5.48xlarge", - "ml.p5e.48xlarge", - "ml.p5en.48xlarge", - "ml.c5.xlarge", - "ml.c5.2xlarge", - "ml.c5.4xlarge", - "ml.c5.9xlarge", - "ml.c5.18xlarge", - "ml.c5n.xlarge", - "ml.c5n.2xlarge", - "ml.c5n.4xlarge", - "ml.c5n.9xlarge", - "ml.c5n.18xlarge", - "ml.g5.xlarge", - "ml.g5.2xlarge", - "ml.g5.4xlarge", - "ml.g5.8xlarge", - "ml.g5.16xlarge", - "ml.g5.12xlarge", - "ml.g5.24xlarge", - "ml.g5.48xlarge", - "ml.g6.xlarge", - "ml.g6.2xlarge", - "ml.g6.4xlarge", - "ml.g6.8xlarge", - "ml.g6.16xlarge", - "ml.g6.12xlarge", - "ml.g6.24xlarge", - "ml.g6.48xlarge", - "ml.g6e.xlarge", - "ml.g6e.2xlarge", - "ml.g6e.4xlarge", - "ml.g6e.8xlarge", - "ml.g6e.16xlarge", - "ml.g6e.12xlarge", - "ml.g6e.24xlarge", - "ml.g6e.48xlarge", - "ml.trn1.2xlarge", - "ml.trn1.32xlarge", - "ml.trn1n.32xlarge", - "ml.trn2.48xlarge", - "ml.m6i.large", - "ml.m6i.xlarge", - "ml.m6i.2xlarge", - "ml.m6i.4xlarge", - "ml.m6i.8xlarge", - "ml.m6i.12xlarge", - "ml.m6i.16xlarge", - "ml.m6i.24xlarge", - "ml.m6i.32xlarge", - "ml.c6i.xlarge", - "ml.c6i.2xlarge", - "ml.c6i.8xlarge", - "ml.c6i.4xlarge", - "ml.c6i.12xlarge", - "ml.c6i.16xlarge", - "ml.c6i.24xlarge", - "ml.c6i.32xlarge", - "ml.r5d.large", - "ml.r5d.xlarge", - "ml.r5d.2xlarge", - "ml.r5d.4xlarge", - "ml.r5d.8xlarge", - "ml.r5d.12xlarge", - "ml.r5d.16xlarge", - "ml.r5d.24xlarge", - "ml.t3.medium", - "ml.t3.large", - "ml.t3.xlarge", - "ml.t3.2xlarge", - "ml.r5.large", - "ml.r5.xlarge", - "ml.r5.2xlarge", - "ml.r5.4xlarge", - "ml.r5.8xlarge", - "ml.r5.12xlarge", - "ml.r5.16xlarge", - "ml.r5.24xlarge", - "ml.p6-b200.48xlarge", - "ml.m7i.large", - "ml.m7i.xlarge", - "ml.m7i.2xlarge", - "ml.m7i.4xlarge", - "ml.m7i.8xlarge", - "ml.m7i.12xlarge", - "ml.m7i.16xlarge", - "ml.m7i.24xlarge", - "ml.m7i.48xlarge", - "ml.c7i.large", - "ml.c7i.xlarge", - "ml.c7i.2xlarge", - "ml.c7i.4xlarge", - "ml.c7i.8xlarge", - "ml.c7i.12xlarge", - "ml.c7i.16xlarge", - "ml.c7i.24xlarge", - "ml.c7i.48xlarge", - "ml.r7i.large", - "ml.r7i.xlarge", - "ml.r7i.2xlarge", - "ml.r7i.4xlarge", - "ml.r7i.8xlarge", - "ml.r7i.12xlarge", - "ml.r7i.16xlarge", - "ml.r7i.24xlarge", - "ml.r7i.48xlarge", - "ml.p6e-gb200.36xlarge", - "ml.p5.4xlarge", - "ml.p6-b300.48xlarge", - "ml.g7e.2xlarge", - "ml.g7e.4xlarge", - "ml.g7e.8xlarge", - "ml.g7e.12xlarge", - "ml.g7e.24xlarge", - "ml.g7e.48xlarge" - ] - }, - "TrainingInstanceTypes":{ - "type":"list", - "member":{"shape":"TrainingInstanceType"} - }, - "TrainingJob":{ - "type":"structure", - "members":{ - "TrainingJobName":{ - "shape":"TrainingJobName", - "documentation":"

The name of the training job.

" - }, - "TrainingJobArn":{ - "shape":"TrainingJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the training job.

" - }, - "TuningJobArn":{ - "shape":"HyperParameterTuningJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.

" - }, - "LabelingJobArn":{ - "shape":"LabelingJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the labeling job.

" - }, - "AutoMLJobArn":{ - "shape":"AutoMLJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the job.

" - }, - "ModelArtifacts":{ - "shape":"ModelArtifacts", - "documentation":"

Information about the Amazon S3 location that is configured for storing model artifacts.

" - }, - "TrainingJobStatus":{ - "shape":"TrainingJobStatus", - "documentation":"

The status of the training job.

Training job statuses are:

  • InProgress - The training is in progress.

  • Completed - The training job has completed.

  • Failed - The training job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTrainingJobResponse call.

  • Stopping - The training job is stopping.

  • Stopped - The training job has stopped.

For more detailed information, see SecondaryStatus.

" - }, - "SecondaryStatus":{ - "shape":"SecondaryStatus", - "documentation":"

Provides detailed information about the state of the training job. For detailed information about the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.

SageMaker provides primary statuses and secondary statuses that apply to each of them:

InProgress

  • Starting - Starting the training job.

  • Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.

  • Training - Training is in progress.

  • Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.

Completed

  • Completed - The training job has completed.

Failed

  • Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.

Stopped

  • MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.

  • Stopped - The training job has stopped.

Stopping

  • Stopping - Stopping the training job.

Valid values for SecondaryStatus are subject to change.

We no longer support the following secondary statuses:

  • LaunchingMLInstances

  • PreparingTrainingStack

  • DownloadingTrainingImage

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

If the training job failed, the reason it failed.

" - }, - "HyperParameters":{ - "shape":"HyperParameters", - "documentation":"

Algorithm-specific parameters.

" - }, - "AlgorithmSpecification":{ - "shape":"AlgorithmSpecification", - "documentation":"

Information about the algorithm used for training, and algorithm metadata.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Web Services Identity and Access Management (IAM) role configured for the training job.

" - }, - "InputDataConfig":{ - "shape":"InputDataConfig", - "documentation":"

An array of Channel objects that describes each data input channel.

Your input must be in the same Amazon Web Services region as your training job.

" - }, - "OutputDataConfig":{ - "shape":"OutputDataConfig", - "documentation":"

The S3 path where model artifacts that you configured when creating the job are stored. SageMaker creates subfolders for model artifacts.

" - }, - "ResourceConfig":{ - "shape":"ResourceConfig", - "documentation":"

Resources, including ML compute instances and ML storage volumes, that are configured for model training.

" - }, - "WarmPoolStatus":{ - "shape":"WarmPoolStatus", - "documentation":"

The status of the warm pool associated with the training job.

" - }, - "VpcConfig":{ - "shape":"VpcConfig", - "documentation":"

A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

" - }, - "StoppingCondition":{ - "shape":"StoppingCondition", - "documentation":"

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that indicates when the training job was created.

" - }, - "TrainingStartTime":{ - "shape":"Timestamp", - "documentation":"

Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.

" - }, - "TrainingEndTime":{ - "shape":"Timestamp", - "documentation":"

Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when SageMaker detects a job failure.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that indicates when the status of the training job was last modified.

" - }, - "SecondaryStatusTransitions":{ - "shape":"SecondaryStatusTransitions", - "documentation":"

A history of all of the secondary statuses that the training job has transitioned through.

" - }, - "FinalMetricDataList":{ - "shape":"FinalMetricDataList", - "documentation":"

A list of final metric values that are set when the training job completes. Used only if the training job was configured to use metrics.

" - }, - "EnableNetworkIsolation":{ - "shape":"Boolean", - "documentation":"

If the TrainingJob was created with network isolation, the value is set to true. If network isolation is enabled, nodes can't communicate beyond the VPC they run in.

", - "box":true - }, - "EnableInterContainerTrafficEncryption":{ - "shape":"Boolean", - "documentation":"

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.

", - "box":true - }, - "EnableManagedSpotTraining":{ - "shape":"Boolean", - "documentation":"

When true, enables managed spot training using Amazon EC2 Spot instances to run training jobs instead of on-demand instances. For more information, see Managed Spot Training.

", - "box":true - }, - "CheckpointConfig":{"shape":"CheckpointConfig"}, - "TrainingTimeInSeconds":{ - "shape":"TrainingTimeInSeconds", - "documentation":"

The training time in seconds.

" - }, - "BillableTimeInSeconds":{ - "shape":"BillableTimeInSeconds", - "documentation":"

The billable time in seconds.

" - }, - "DebugHookConfig":{"shape":"DebugHookConfig"}, - "ExperimentConfig":{"shape":"ExperimentConfig"}, - "DebugRuleConfigurations":{ - "shape":"DebugRuleConfigurations", - "documentation":"

Information about the debug rule configuration.

" - }, - "TensorBoardOutputConfig":{"shape":"TensorBoardOutputConfig"}, - "DebugRuleEvaluationStatuses":{ - "shape":"DebugRuleEvaluationStatuses", - "documentation":"

Information about the evaluation status of the rules for the training job.

" - }, - "OutputModelPackageArn":{ - "shape":"ModelPackageArn", - "documentation":"

The output model package Amazon Resource Name (ARN) that contains model weights or checkpoint.

" - }, - "ModelPackageConfig":{ - "shape":"ModelPackageConfig", - "documentation":"

The model package configuration.

" - }, - "ProfilerConfig":{"shape":"ProfilerConfig"}, - "Environment":{ - "shape":"TrainingEnvironmentMap", - "documentation":"

The environment variables to set in the Docker container.

" - }, - "RetryStrategy":{ - "shape":"RetryStrategy", - "documentation":"

The number of times to retry the job when the job fails due to an InternalServerError.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

" - } - }, - "documentation":"

Contains information about a training job.

" - }, - "TrainingJobArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:training-job/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" - }, - "TrainingJobDefinition":{ - "type":"structure", - "required":[ - "TrainingInputMode", - "InputDataConfig", - "OutputDataConfig", - "ResourceConfig", - "StoppingCondition" - ], - "members":{ - "TrainingInputMode":{"shape":"TrainingInputMode"}, - "HyperParameters":{ - "shape":"HyperParameters", - "documentation":"

The hyperparameters used for the training job.

" - }, - "InputDataConfig":{ - "shape":"InputDataConfig", - "documentation":"

An array of Channel objects, each of which specifies an input source.

" - }, - "OutputDataConfig":{ - "shape":"OutputDataConfig", - "documentation":"

the path to the S3 bucket where you want to store model artifacts. SageMaker creates subfolders for the artifacts.

" - }, - "ResourceConfig":{ - "shape":"ResourceConfig", - "documentation":"

The resources, including the ML compute instances and ML storage volumes, to use for model training.

" - }, - "StoppingCondition":{ - "shape":"StoppingCondition", - "documentation":"

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts.

" - } - }, - "documentation":"

Defines the input needed to run a training job using the algorithm.

" - }, - "TrainingJobEarlyStoppingType":{ - "type":"string", - "enum":[ - "Off", - "Auto" - ] - }, - "TrainingJobName":{ - "type":"string", - "max":63, - "min":1, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" - }, - "TrainingJobSortByOptions":{ - "type":"string", - "enum":[ - "Name", - "CreationTime", - "Status", - "FinalObjectiveMetricValue" - ] - }, - "TrainingJobStatus":{ - "type":"string", - "enum":[ - "InProgress", - "Completed", - "Failed", - "Stopping", - "Stopped", - "Deleting" - ] - }, - "TrainingJobStatusCounter":{ - "type":"integer", - "min":0 - }, - "TrainingJobStatusCounters":{ - "type":"structure", - "members":{ - "Completed":{ - "shape":"TrainingJobStatusCounter", - "documentation":"

The number of completed training jobs launched by the hyperparameter tuning job.

", - "box":true - }, - "InProgress":{ - "shape":"TrainingJobStatusCounter", - "documentation":"

The number of in-progress training jobs launched by a hyperparameter tuning job.

", - "box":true - }, - "RetryableError":{ - "shape":"TrainingJobStatusCounter", - "documentation":"

The number of training jobs that failed, but can be retried. A failed training job can be retried only if it failed because an internal service error occurred.

", - "box":true - }, - "NonRetryableError":{ - "shape":"TrainingJobStatusCounter", - "documentation":"

The number of training jobs that failed and can't be retried. A failed training job can't be retried if it failed because a client error occurred.

", - "box":true - }, - "Stopped":{ - "shape":"TrainingJobStatusCounter", - "documentation":"

The number of training jobs launched by a hyperparameter tuning job that were manually stopped.

", - "box":true - } - }, - "documentation":"

The numbers of training jobs launched by a hyperparameter tuning job, categorized by status.

" - }, - "TrainingJobStepMetadata":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"TrainingJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the training job that was run by this step execution.

" - } - }, - "documentation":"

Metadata for a training job step.

" - }, - "TrainingJobSummaries":{ - "type":"list", - "member":{"shape":"TrainingJobSummary"} - }, - "TrainingJobSummary":{ - "type":"structure", - "required":[ - "TrainingJobName", - "TrainingJobArn", - "CreationTime", - "TrainingJobStatus" - ], - "members":{ - "TrainingJobName":{ - "shape":"TrainingJobName", - "documentation":"

The name of the training job that you want a summary for.

" - }, - "TrainingJobArn":{ - "shape":"TrainingJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the training job.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that shows when the training job was created.

" - }, - "TrainingEndTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that shows when the training job ended. This field is set only if the training job has one of the terminal statuses (Completed, Failed, or Stopped).

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

Timestamp when the training job was last modified.

" - }, - "TrainingJobStatus":{ - "shape":"TrainingJobStatus", - "documentation":"

The status of the training job.

" - }, - "SecondaryStatus":{ - "shape":"SecondaryStatus", - "documentation":"

The secondary status of the training job.

" - }, - "WarmPoolStatus":{ - "shape":"WarmPoolStatus", - "documentation":"

The status of the warm pool associated with the training job.

" - }, - "TrainingPlanArn":{ - "shape":"TrainingPlanArn", - "documentation":"

The Amazon Resource Name (ARN); of the training plan associated with this training job.

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

" - } - }, - "documentation":"

Provides summary information about a training job.

" - }, - "TrainingPlanArn":{ - "type":"string", - "max":2048, - "min":50, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:training-plan/.*" - }, - "TrainingPlanArns":{ - "type":"list", - "member":{"shape":"TrainingPlanArn"} - }, - "TrainingPlanDurationHours":{ - "type":"long", - "box":true, - "max":87600, - "min":0 - }, - "TrainingPlanDurationHoursInput":{ - "type":"long", - "box":true, - "max":87600, - "min":1 - }, - "TrainingPlanDurationMinutes":{ - "type":"long", - "box":true, - "max":59, - "min":0 - }, - "TrainingPlanExtension":{ - "type":"structure", - "required":["TrainingPlanExtensionOfferingId"], - "members":{ - "TrainingPlanExtensionOfferingId":{ - "shape":"TrainingPlanExtensionOfferingId", - "documentation":"

The unique identifier of the extension offering that was used to create this extension.

" - }, - "ExtendedAt":{ - "shape":"Timestamp", - "documentation":"

The timestamp when the extension was created.

" - }, - "StartDate":{ - "shape":"Timestamp", - "documentation":"

The start date of the extension period.

" - }, - "EndDate":{ - "shape":"Timestamp", - "documentation":"

The end date of the extension period.

" - }, - "Status":{ - "shape":"String256", - "documentation":"

The current status of the extension (e.g., Pending, Active, Scheduled, Failed, Expired).

" - }, - "PaymentStatus":{ - "shape":"String256", - "documentation":"

The payment processing status of the extension.

" - }, - "AvailabilityZone":{ - "shape":"String256", - "documentation":"

The Availability Zone of the extension.

" - }, - "AvailabilityZoneId":{ - "shape":"AvailabilityZoneId", - "documentation":"

The Availability Zone ID of the extension.

" - }, - "DurationHours":{ - "shape":"TrainingPlanExtensionDurationHours", - "documentation":"

The duration of the extension in hours.

" - }, - "UpfrontFee":{ - "shape":"String256", - "documentation":"

The upfront fee for the extension.

" - }, - "CurrencyCode":{ - "shape":"CurrencyCode", - "documentation":"

The currency code for the upfront fee (e.g., USD).

" - } - }, - "documentation":"

Details about an extension to a training plan, including the offering ID, dates, status, and cost information.

" - }, - "TrainingPlanExtensionDurationHours":{ - "type":"integer", - "box":true, - "max":4368, - "min":0 - }, - "TrainingPlanExtensionOffering":{ - "type":"structure", - "required":["TrainingPlanExtensionOfferingId"], - "members":{ - "TrainingPlanExtensionOfferingId":{ - "shape":"TrainingPlanExtensionOfferingId", - "documentation":"

The unique identifier for this extension offering.

" - }, - "AvailabilityZone":{ - "shape":"String256", - "documentation":"

The Availability Zone for this extension offering.

" - }, - "StartDate":{ - "shape":"Timestamp", - "documentation":"

The start date of this extension offering.

" - }, - "EndDate":{ - "shape":"Timestamp", - "documentation":"

The end date of this extension offering.

" - }, - "DurationHours":{ - "shape":"TrainingPlanExtensionDurationHours", - "documentation":"

The duration of this extension offering in hours.

" - }, - "UpfrontFee":{ - "shape":"String256", - "documentation":"

The upfront fee for this extension offering.

" - }, - "CurrencyCode":{ - "shape":"CurrencyCode", - "documentation":"

The currency code for the upfront fee (e.g., USD).

" - } - }, - "documentation":"

Details about an available extension offering for a training plan. Use the offering ID with the ExtendTrainingPlan API to extend a training plan.

" - }, - "TrainingPlanExtensionOfferingId":{"type":"string"}, - "TrainingPlanExtensionOfferings":{ - "type":"list", - "member":{"shape":"TrainingPlanExtensionOffering"}, - "min":0 - }, - "TrainingPlanExtensions":{ - "type":"list", - "member":{"shape":"TrainingPlanExtension"}, - "min":0 - }, - "TrainingPlanFilter":{ - "type":"structure", - "required":[ - "Name", - "Value" - ], - "members":{ - "Name":{ - "shape":"TrainingPlanFilterName", - "documentation":"

The name of the filter field (e.g., Status, InstanceType).

" - }, - "Value":{ - "shape":"String64", - "documentation":"

The value to filter by for the specified field.

" - } - }, - "documentation":"

A filter to apply when listing or searching for training plans.

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

" - }, - "TrainingPlanFilterName":{ - "type":"string", - "enum":["Status"] - }, - "TrainingPlanFilters":{ - "type":"list", - "member":{"shape":"TrainingPlanFilter"}, - "max":5, - "min":1 - }, - "TrainingPlanName":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}" - }, - "TrainingPlanOffering":{ - "type":"structure", - "required":[ - "TrainingPlanOfferingId", - "TargetResources" - ], - "members":{ - "TrainingPlanOfferingId":{ - "shape":"TrainingPlanOfferingId", - "documentation":"

The unique identifier for this training plan offering.

" - }, - "TargetResources":{ - "shape":"SageMakerResourceNames", - "documentation":"

The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod, SageMaker Endpoints, Studio apps) for this training plan offering.

Training plans are specific to their target resource.

  • A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs.

  • A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster's instance group.

  • A training plan for SageMaker endpoints can be used exclusively to provide compute resources to SageMaker endpoints for model deployment.

  • A training plan for Studio apps can be used to launch JupyterLab and Code Editor apps on reserved training plan capacity.

" - }, - "RequestedStartTimeAfter":{ - "shape":"Timestamp", - "documentation":"

The requested start time that the user specified when searching for the training plan offering.

" - }, - "RequestedEndTimeBefore":{ - "shape":"Timestamp", - "documentation":"

The requested end time that the user specified when searching for the training plan offering.

" - }, - "DurationHours":{ - "shape":"TrainingPlanDurationHours", - "documentation":"

The number of whole hours in the total duration for this training plan offering.

" - }, - "DurationMinutes":{ - "shape":"TrainingPlanDurationMinutes", - "documentation":"

The additional minutes beyond whole hours in the total duration for this training plan offering.

" - }, - "UpfrontFee":{ - "shape":"String256", - "documentation":"

The upfront fee for this training plan offering.

" - }, - "CurrencyCode":{ - "shape":"CurrencyCode", - "documentation":"

The currency code for the upfront fee (e.g., USD).

" - }, - "ReservedCapacityOfferings":{ - "shape":"ReservedCapacityOfferings", - "documentation":"

A list of reserved capacity offerings associated with this training plan offering.

" - } - }, - "documentation":"

Details about a training plan offering.

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

" - }, - "TrainingPlanOfferingId":{ - "type":"string", - "max":256, - "min":1, - "pattern":"[a-z0-9\\-]+" - }, - "TrainingPlanOfferings":{ - "type":"list", - "member":{"shape":"TrainingPlanOffering"}, - "min":0 - }, - "TrainingPlanSortBy":{ - "type":"string", - "enum":[ - "TrainingPlanName", - "StartTime", - "Status" - ] - }, - "TrainingPlanSortOrder":{ - "type":"string", - "enum":[ - "Ascending", - "Descending" - ] - }, - "TrainingPlanStatus":{ - "type":"string", - "enum":[ - "Pending", - "Active", - "Scheduled", - "Expired", - "Failed" - ] - }, - "TrainingPlanStatusMessage":{ - "type":"string", - "max":1024, - "min":0 - }, - "TrainingPlanSummaries":{ - "type":"list", - "member":{"shape":"TrainingPlanSummary"} - }, - "TrainingPlanSummary":{ - "type":"structure", - "required":[ - "TrainingPlanArn", - "TrainingPlanName", - "Status" - ], - "members":{ - "TrainingPlanArn":{ - "shape":"TrainingPlanArn", - "documentation":"

The Amazon Resource Name (ARN); of the training plan.

" - }, - "TrainingPlanName":{ - "shape":"TrainingPlanName", - "documentation":"

The name of the training plan.

" - }, - "Status":{ - "shape":"TrainingPlanStatus", - "documentation":"

The current status of the training plan (e.g., Pending, Active, Expired). To see the complete list of status values available for a training plan, refer to the Status attribute within the TrainingPlanSummary object.

" - }, - "StatusMessage":{ - "shape":"TrainingPlanStatusMessage", - "documentation":"

A message providing additional information about the current status of the training plan.

" - }, - "DurationHours":{ - "shape":"TrainingPlanDurationHours", - "documentation":"

The number of whole hours in the total duration for this training plan.

" - }, - "DurationMinutes":{ - "shape":"TrainingPlanDurationMinutes", - "documentation":"

The additional minutes beyond whole hours in the total duration for this training plan.

" - }, - "StartTime":{ - "shape":"Timestamp", - "documentation":"

The start time of the training plan.

" - }, - "EndTime":{ - "shape":"Timestamp", - "documentation":"

The end time of the training plan.

" - }, - "UpfrontFee":{ - "shape":"String256", - "documentation":"

The upfront fee for the training plan.

" - }, - "CurrencyCode":{ - "shape":"CurrencyCode", - "documentation":"

The currency code for the upfront fee (e.g., USD).

" - }, - "TotalInstanceCount":{ - "shape":"TotalInstanceCount", - "documentation":"

The total number of instances reserved in this training plan.

" - }, - "AvailableInstanceCount":{ - "shape":"AvailableInstanceCount", - "documentation":"

The number of instances currently available for use in this training plan.

" - }, - "InUseInstanceCount":{ - "shape":"InUseInstanceCount", - "documentation":"

The number of instances currently in use from this training plan.

" - }, - "TotalUltraServerCount":{ - "shape":"UltraServerCount", - "documentation":"

The total number of UltraServers allocated to this training plan.

" - }, - "TargetResources":{ - "shape":"SageMakerResourceNames", - "documentation":"

The target resources (e.g., training jobs, HyperPod clusters, Endpoints, Studio apps) that can use this training plan.

Training plans are specific to their target resource.

  • A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs.

  • A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster's instance group.

  • A training plan for SageMaker endpoints can be used exclusively to provide compute resources to SageMaker endpoints for model deployment.

  • A training plan for Studio apps can be used to launch JupyterLab and Code Editor apps on reserved training plan capacity.

" - }, - "ReservedCapacitySummaries":{ - "shape":"ReservedCapacitySummaries", - "documentation":"

A list of reserved capacities associated with this training plan, including details such as instance types, counts, and availability zones.

" - } - }, - "documentation":"

Details of the training plan.

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

" - }, - "TrainingProgressInfo":{ - "type":"structure", - "members":{ - "TotalStepCountPerEpoch":{ - "shape":"TotalStepCountPerEpoch", - "documentation":"

The total step count per epoch.

" - }, - "CurrentStep":{ - "shape":"TrainingStepIndex", - "documentation":"

The current step number.

" - }, - "CurrentEpoch":{ - "shape":"TrainingEpochIndex", - "documentation":"

The current epoch number.

" - }, - "MaxEpoch":{ - "shape":"TrainingEpochCount", - "documentation":"

The maximum number of epochs for this job.

" - } - }, - "documentation":"

The serverless training job progress information.

" - }, - "TrainingRepositoryAccessMode":{ - "type":"string", - "enum":[ - "Platform", - "Vpc" - ] - }, - "TrainingRepositoryAuthConfig":{ - "type":"structure", - "required":["TrainingRepositoryCredentialsProviderArn"], - "members":{ - "TrainingRepositoryCredentialsProviderArn":{ - "shape":"TrainingRepositoryCredentialsProviderArn", - "documentation":"

The Amazon Resource Name (ARN) of an Amazon Web Services Lambda function used to give SageMaker access credentials to your private Docker registry.

" - } - }, - "documentation":"

An object containing authentication information for a private Docker registry.

" - }, - "TrainingRepositoryCredentialsProviderArn":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"arn:[\\p{Alnum}\\-]+:lambda:[\\p{Alnum}\\-]+:[0-9]{12}:function:.*" - }, - "TrainingSpecification":{ - "type":"structure", - "required":[ - "TrainingImage", - "SupportedTrainingInstanceTypes", - "TrainingChannels" - ], - "members":{ - "TrainingImage":{ - "shape":"ContainerImage", - "documentation":"

The Amazon ECR registry path of the Docker image that contains the training algorithm.

" - }, - "TrainingImageDigest":{ - "shape":"ImageDigest", - "documentation":"

An MD5 hash of the training algorithm that identifies the Docker image used for training.

" - }, - "SupportedHyperParameters":{ - "shape":"HyperParameterSpecifications", - "documentation":"

A list of the HyperParameterSpecification objects, that define the supported hyperparameters. This is required if the algorithm supports automatic model tuning.>

" - }, - "SupportedTrainingInstanceTypes":{ - "shape":"TrainingInstanceTypes", - "documentation":"

A list of the instance types that this algorithm can use for training.

" - }, - "SupportsDistributedTraining":{ - "shape":"Boolean", - "documentation":"

Indicates whether the algorithm supports distributed training. If set to false, buyers can't request more than one instance during training.

", - "box":true - }, - "MetricDefinitions":{ - "shape":"MetricDefinitionList", - "documentation":"

A list of MetricDefinition objects, which are used for parsing metrics generated by the algorithm.

" - }, - "TrainingChannels":{ - "shape":"ChannelSpecifications", - "documentation":"

A list of ChannelSpecification objects, which specify the input sources to be used by the algorithm.

" - }, - "SupportedTuningJobObjectiveMetrics":{ - "shape":"HyperParameterTuningJobObjectives", - "documentation":"

A list of the metrics that the algorithm emits that can be used as the objective metric in a hyperparameter tuning job.

" - }, - "AdditionalS3DataSource":{ - "shape":"AdditionalS3DataSource", - "documentation":"

The additional data source used during the training job.

" - } - }, - "documentation":"

Defines how the algorithm is used for a training job.

" - }, - "TrainingStepIndex":{ - "type":"long", - "box":true, - "min":0 - }, - "TrainingTimeInSeconds":{ - "type":"integer", - "box":true, - "min":1 - }, - "TransformAmiVersion":{ - "type":"string", - "max":63, - "min":1, - "pattern":"[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*" - }, - "TransformDataSource":{ - "type":"structure", - "required":["S3DataSource"], - "members":{ - "S3DataSource":{ - "shape":"TransformS3DataSource", - "documentation":"

The S3 location of the data source that is associated with a channel.

" - } - }, - "documentation":"

Describes the location of the channel data.

" - }, - "TransformEnvironmentKey":{ - "type":"string", - "max":1024, - "min":0, - "pattern":"[a-zA-Z_][a-zA-Z0-9_]{0,1023}" - }, - "TransformEnvironmentMap":{ - "type":"map", - "key":{"shape":"TransformEnvironmentKey"}, - "value":{"shape":"TransformEnvironmentValue"}, - "max":16, - "min":0 - }, - "TransformEnvironmentValue":{ - "type":"string", - "max":10240, - "min":0, - "pattern":"[\\S\\s]*" - }, - "TransformInput":{ - "type":"structure", - "required":["DataSource"], - "members":{ - "DataSource":{ - "shape":"TransformDataSource", - "documentation":"

Describes the location of the channel data, which is, the S3 location of the input data that the model can consume.

" - }, - "ContentType":{ - "shape":"ContentType", - "documentation":"

The multipurpose internet mail extension (MIME) type of the data. Amazon SageMaker uses the MIME type with each http call to transfer data to the transform job.

" - }, - "CompressionType":{ - "shape":"CompressionType", - "documentation":"

If your transform data is compressed, specify the compression type. Amazon SageMaker automatically decompresses the data for the transform job accordingly. The default value is None.

" - }, - "SplitType":{ - "shape":"SplitType", - "documentation":"

The method to use to split the transform job's data files into smaller batches. Splitting is necessary when the total size of each object is too large to fit in a single request. You can also use data splitting to improve performance by processing multiple concurrent mini-batches. The default value for SplitType is None, which indicates that input data files are not split, and request payloads contain the entire contents of an input object. Set the value of this parameter to Line to split records on a newline character boundary. SplitType also supports a number of record-oriented binary data formats. Currently, the supported record formats are:

  • RecordIO

  • TFRecord

When splitting is enabled, the size of a mini-batch depends on the values of the BatchStrategy and MaxPayloadInMB parameters. When the value of BatchStrategy is MultiRecord, Amazon SageMaker sends the maximum number of records in each request, up to the MaxPayloadInMB limit. If the value of BatchStrategy is SingleRecord, Amazon SageMaker sends individual records in each request.

Some data formats represent a record as a binary payload wrapped with extra padding bytes. When splitting is applied to a binary data format, padding is removed if the value of BatchStrategy is set to SingleRecord. Padding is not removed if the value of BatchStrategy is set to MultiRecord.

For more information about RecordIO, see Create a Dataset Using RecordIO in the MXNet documentation. For more information about TFRecord, see Consuming TFRecord data in the TensorFlow documentation.

" - } - }, - "documentation":"

Describes the input source of a transform job and the way the transform job consumes it.

" - }, - "TransformInstanceCount":{ - "type":"integer", - "box":true, - "min":1 - }, - "TransformInstanceType":{ - "type":"string", - "enum":[ - "ml.m4.xlarge", - "ml.m4.2xlarge", - "ml.m4.4xlarge", - "ml.m4.10xlarge", - "ml.m4.16xlarge", - "ml.c4.xlarge", - "ml.c4.2xlarge", - "ml.c4.4xlarge", - "ml.c4.8xlarge", - "ml.p2.xlarge", - "ml.p2.8xlarge", - "ml.p2.16xlarge", - "ml.p3.2xlarge", - "ml.p3.8xlarge", - "ml.p3.16xlarge", - "ml.c5.xlarge", - "ml.c5.2xlarge", - "ml.c5.4xlarge", - "ml.c5.9xlarge", - "ml.c5.18xlarge", - "ml.m5.large", - "ml.m5.xlarge", - "ml.m5.2xlarge", - "ml.m5.4xlarge", - "ml.m5.12xlarge", - "ml.m5.24xlarge", - "ml.m6i.large", - "ml.m6i.xlarge", - "ml.m6i.2xlarge", - "ml.m6i.4xlarge", - "ml.m6i.8xlarge", - "ml.m6i.12xlarge", - "ml.m6i.16xlarge", - "ml.m6i.24xlarge", - "ml.m6i.32xlarge", - "ml.c6i.large", - "ml.c6i.xlarge", - "ml.c6i.2xlarge", - "ml.c6i.4xlarge", - "ml.c6i.8xlarge", - "ml.c6i.12xlarge", - "ml.c6i.16xlarge", - "ml.c6i.24xlarge", - "ml.c6i.32xlarge", - "ml.r6i.large", - "ml.r6i.xlarge", - "ml.r6i.2xlarge", - "ml.r6i.4xlarge", - "ml.r6i.8xlarge", - "ml.r6i.12xlarge", - "ml.r6i.16xlarge", - "ml.r6i.24xlarge", - "ml.r6i.32xlarge", - "ml.m7i.large", - "ml.m7i.xlarge", - "ml.m7i.2xlarge", - "ml.m7i.4xlarge", - "ml.m7i.8xlarge", - "ml.m7i.12xlarge", - "ml.m7i.16xlarge", - "ml.m7i.24xlarge", - "ml.m7i.48xlarge", - "ml.c7i.large", - "ml.c7i.xlarge", - "ml.c7i.2xlarge", - "ml.c7i.4xlarge", - "ml.c7i.8xlarge", - "ml.c7i.12xlarge", - "ml.c7i.16xlarge", - "ml.c7i.24xlarge", - "ml.c7i.48xlarge", - "ml.r7i.large", - "ml.r7i.xlarge", - "ml.r7i.2xlarge", - "ml.r7i.4xlarge", - "ml.r7i.8xlarge", - "ml.r7i.12xlarge", - "ml.r7i.16xlarge", - "ml.r7i.24xlarge", - "ml.r7i.48xlarge", - "ml.g4dn.xlarge", - "ml.g4dn.2xlarge", - "ml.g4dn.4xlarge", - "ml.g4dn.8xlarge", - "ml.g4dn.12xlarge", - "ml.g4dn.16xlarge", - "ml.g5.xlarge", - "ml.g5.2xlarge", - "ml.g5.4xlarge", - "ml.g5.8xlarge", - "ml.g5.12xlarge", - "ml.g5.16xlarge", - "ml.g5.24xlarge", - "ml.g5.48xlarge", - "ml.trn1.2xlarge", - "ml.trn1.32xlarge", - "ml.inf2.xlarge", - "ml.inf2.8xlarge", - "ml.inf2.24xlarge", - "ml.inf2.48xlarge", - "ml.g6.xlarge", - "ml.g6.2xlarge", - "ml.g6.4xlarge", - "ml.g6.8xlarge", - "ml.g6.12xlarge", - "ml.g6.16xlarge", - "ml.g6.24xlarge", - "ml.g6.48xlarge" - ] - }, - "TransformInstanceTypes":{ - "type":"list", - "member":{"shape":"TransformInstanceType"}, - "min":1 - }, - "TransformJob":{ - "type":"structure", - "members":{ - "TransformJobName":{ - "shape":"TransformJobName", - "documentation":"

The name of the transform job.

" - }, - "TransformJobArn":{ - "shape":"TransformJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the transform job.

" - }, - "TransformJobStatus":{ - "shape":"TransformJobStatus", - "documentation":"

The status of the transform job.

Transform job statuses are:

  • InProgress - The job is in progress.

  • Completed - The job has completed.

  • Failed - The transform job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTransformJob call.

  • Stopping - The transform job is stopping.

  • Stopped - The transform job has stopped.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

If the transform job failed, the reason it failed.

" - }, - "ModelName":{ - "shape":"ModelName", - "documentation":"

The name of the model associated with the transform job.

" - }, - "MaxConcurrentTransforms":{ - "shape":"MaxConcurrentTransforms", - "documentation":"

The maximum number of parallel requests that can be sent to each instance in a transform job. If MaxConcurrentTransforms is set to 0 or left unset, SageMaker checks the optional execution-parameters to determine the settings for your chosen algorithm. If the execution-parameters endpoint is not enabled, the default value is 1. For built-in algorithms, you don't need to set a value for MaxConcurrentTransforms.

" - }, - "ModelClientConfig":{"shape":"ModelClientConfig"}, - "MaxPayloadInMB":{ - "shape":"MaxPayloadInMB", - "documentation":"

The maximum allowed size of the payload, in MB. A payload is the data portion of a record (without metadata). The value in MaxPayloadInMB must be greater than, or equal to, the size of a single record. To estimate the size of a record in MB, divide the size of your dataset by the number of records. To ensure that the records fit within the maximum payload size, we recommend using a slightly larger value. The default value is 6 MB. For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to 0. This feature works only in supported algorithms. Currently, SageMaker built-in algorithms do not support HTTP chunked encoding.

" - }, - "BatchStrategy":{ - "shape":"BatchStrategy", - "documentation":"

Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.

" - }, - "Environment":{ - "shape":"TransformEnvironmentMap", - "documentation":"

The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

" - }, - "TransformInput":{"shape":"TransformInput"}, - "TransformOutput":{"shape":"TransformOutput"}, - "DataCaptureConfig":{"shape":"BatchDataCaptureConfig"}, - "TransformResources":{"shape":"TransformResources"}, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that shows when the transform Job was created.

" - }, - "TransformStartTime":{ - "shape":"Timestamp", - "documentation":"

Indicates when the transform job starts on ML instances. You are billed for the time interval between this time and the value of TransformEndTime.

" - }, - "TransformEndTime":{ - "shape":"Timestamp", - "documentation":"

Indicates when the transform job has been completed, or has stopped or failed. You are billed for the time interval between this time and the value of TransformStartTime.

" - }, - "LabelingJobArn":{ - "shape":"LabelingJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the labeling job that created the transform job.

" - }, - "AutoMLJobArn":{ - "shape":"AutoMLJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the AutoML job that created the transform job.

" - }, - "DataProcessing":{"shape":"DataProcessing"}, - "ExperimentConfig":{"shape":"ExperimentConfig"}, - "Tags":{ - "shape":"TagList", - "documentation":"

A list of tags associated with the transform job.

" - } - }, - "documentation":"

A batch transform job. For information about SageMaker batch transform, see Use Batch Transform.

" - }, - "TransformJobArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:transform-job/.*" - }, - "TransformJobDefinition":{ - "type":"structure", - "required":[ - "TransformInput", - "TransformOutput", - "TransformResources" - ], - "members":{ - "MaxConcurrentTransforms":{ - "shape":"MaxConcurrentTransforms", - "documentation":"

The maximum number of parallel requests that can be sent to each instance in a transform job. The default value is 1.

" - }, - "MaxPayloadInMB":{ - "shape":"MaxPayloadInMB", - "documentation":"

The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata).

" - }, - "BatchStrategy":{ - "shape":"BatchStrategy", - "documentation":"

A string that determines the number of records included in a single mini-batch.

SingleRecord means only one record is used per mini-batch. MultiRecord means a mini-batch is set to contain as many records that can fit within the MaxPayloadInMB limit.

" - }, - "Environment":{ - "shape":"TransformEnvironmentMap", - "documentation":"

The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

" - }, - "TransformInput":{ - "shape":"TransformInput", - "documentation":"

A description of the input source and the way the transform job consumes it.

" - }, - "TransformOutput":{ - "shape":"TransformOutput", - "documentation":"

Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

" - }, - "TransformResources":{ - "shape":"TransformResources", - "documentation":"

Identifies the ML compute instances for the transform job.

" - } - }, - "documentation":"

Defines the input needed to run a transform job using the inference specification specified in the algorithm.

" - }, - "TransformJobName":{ - "type":"string", - "max":63, - "min":1, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" - }, - "TransformJobStatus":{ - "type":"string", - "enum":[ - "InProgress", - "Completed", - "Failed", - "Stopping", - "Stopped" - ] - }, - "TransformJobStepMetadata":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"TransformJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the transform job that was run by this step execution.

" - } - }, - "documentation":"

Metadata for a transform job step.

" - }, - "TransformJobSummaries":{ - "type":"list", - "member":{"shape":"TransformJobSummary"} - }, - "TransformJobSummary":{ - "type":"structure", - "required":[ - "TransformJobName", - "TransformJobArn", - "CreationTime", - "TransformJobStatus" - ], - "members":{ - "TransformJobName":{ - "shape":"TransformJobName", - "documentation":"

The name of the transform job.

" - }, - "TransformJobArn":{ - "shape":"TransformJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the transform job.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

A timestamp that shows when the transform Job was created.

" - }, - "TransformEndTime":{ - "shape":"Timestamp", - "documentation":"

Indicates when the transform job ends on compute instances. For successful jobs and stopped jobs, this is the exact time recorded after the results are uploaded. For failed jobs, this is when Amazon SageMaker detected that the job failed.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

Indicates when the transform job was last modified.

" - }, - "TransformJobStatus":{ - "shape":"TransformJobStatus", - "documentation":"

The status of the transform job.

" - }, - "FailureReason":{ - "shape":"FailureReason", - "documentation":"

If the transform job failed, the reason it failed.

" - } - }, - "documentation":"

Provides a summary of a transform job. Multiple TransformJobSummary objects are returned as a list after in response to a ListTransformJobs call.

" - }, - "TransformOutput":{ - "type":"structure", - "required":["S3OutputPath"], - "members":{ - "S3OutputPath":{ - "shape":"S3Uri", - "documentation":"

The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job. For example, s3://bucket-name/key-name-prefix.

For every S3 object used as input for the transform job, batch transform stores the transformed data with an .out suffix in a corresponding subfolder in the location in the output prefix. For example, for the input data stored at s3://bucket-name/input-name-prefix/dataset01/data.csv, batch transform stores the transformed data at s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out. Batch transform doesn't upload partially processed objects. For an input S3 object that contains multiple records, it creates an .out file only if the transform job succeeds on the entire file. When the input contains multiple S3 objects, the batch transform job processes the listed S3 objects and uploads only the output for successfully processed objects. If any object fails in the transform job batch transform marks the job as failed to prompt investigation.

" - }, - "Accept":{ - "shape":"Accept", - "documentation":"

The MIME type used to specify the output data. Amazon SageMaker uses the MIME type with each http call to transfer data from the transform job.

" - }, - "AssembleWith":{ - "shape":"AssemblyType", - "documentation":"

Defines how to assemble the results of the transform job as a single S3 object. Choose a format that is most convenient to you. To concatenate the results in binary format, specify None. To add a newline character at the end of every transformed record, specify Line.

" - }, - "KmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

The KMS key policy must grant permission to the IAM role that you specify in your CreateModel request. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

" - } - }, - "documentation":"

Describes the results of a transform job.

" - }, - "TransformResources":{ - "type":"structure", - "required":[ - "InstanceType", - "InstanceCount" - ], - "members":{ - "InstanceType":{ - "shape":"TransformInstanceType", - "documentation":"

The ML compute instance type for the transform job. If you are using built-in algorithms to transform moderately sized datasets, we recommend using ml.m4.xlarge or ml.m5.largeinstance types.

" - }, - "InstanceCount":{ - "shape":"TransformInstanceCount", - "documentation":"

The number of ML compute instances to use in the transform job. The default value is 1, and the maximum is 100. For distributed transform jobs, specify a value greater than 1.

" - }, - "VolumeKmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume attached to the ML compute instance(s) that run the batch transform job.

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage.

For a list of instance types that support local instance storage, see Instance Store Volumes.

For more information about local instance storage encryption, see SSD Instance Store Volumes.

The VolumeKmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

" - }, - "TransformAmiVersion":{ - "shape":"TransformAmiVersion", - "documentation":"

Specifies an option from a collection of preconfigured Amazon Machine Image (AMI) images. Each image is configured by Amazon Web Services with a set of software and driver versions.

al2-ami-sagemaker-batch-gpu-470

  • Accelerator: GPU

  • NVIDIA driver version: 470

al2-ami-sagemaker-batch-gpu-535

  • Accelerator: GPU

  • NVIDIA driver version: 535

" - } - }, - "documentation":"

Describes the resources, including ML instance types and ML instance count, to use for transform job.

" - }, - "TransformS3DataSource":{ - "type":"structure", - "required":[ - "S3DataType", - "S3Uri" - ], - "members":{ - "S3DataType":{ - "shape":"S3DataType", - "documentation":"

If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for batch transform.

If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for batch transform.

The following values are compatible: ManifestFile, S3Prefix

The following value is not compatible: AugmentedManifestFile

" - }, - "S3Uri":{ - "shape":"S3Uri", - "documentation":"

Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:

  • A key name prefix might look like this: s3://bucketname/exampleprefix/.

  • A manifest might look like this: s3://bucketname/example.manifest

    The manifest is an S3 object which is a JSON file with the following format:

    [ {\"prefix\": \"s3://customer_bucket/some/prefix/\"},

    \"relative/path/to/custdata-1\",

    \"relative/path/custdata-2\",

    ...

    \"relative/path/custdata-N\"

    ]

    The preceding JSON matches the following S3Uris:

    s3://customer_bucket/some/prefix/relative/path/to/custdata-1

    s3://customer_bucket/some/prefix/relative/path/custdata-2

    ...

    s3://customer_bucket/some/prefix/relative/path/custdata-N

    The complete set of S3Uris in this manifest constitutes the input data for the channel for this datasource. The object that each S3Uris points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.

" - } - }, - "documentation":"

Describes the S3 data source.

" - }, - "TransformationAttributeName":{ - "type":"string", - "max":256, - "min":1 - }, - "Trial":{ - "type":"structure", - "members":{ - "TrialName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the trial.

" - }, - "TrialArn":{ - "shape":"TrialArn", - "documentation":"

The Amazon Resource Name (ARN) of the trial.

" - }, - "DisplayName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the trial as displayed. If DisplayName isn't specified, TrialName is displayed.

" - }, - "ExperimentName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the experiment the trial is part of.

" - }, - "Source":{"shape":"TrialSource"}, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

When the trial was created.

" - }, - "CreatedBy":{ - "shape":"UserContext", - "documentation":"

Who created the trial.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

Who last modified the trial.

" - }, - "LastModifiedBy":{"shape":"UserContext"}, - "MetadataProperties":{"shape":"MetadataProperties"}, - "Tags":{ - "shape":"TagList", - "documentation":"

The list of tags that are associated with the trial. You can use Search API to search on the tags.

" - }, - "TrialComponentSummaries":{ - "shape":"TrialComponentSimpleSummaries", - "documentation":"

A list of the components associated with the trial. For each component, a summary of the component's properties is included.

" - } - }, - "documentation":"

The properties of a trial as returned by the Search API.

" - }, - "TrialArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:experiment-trial/.*" - }, - "TrialComponent":{ - "type":"structure", - "members":{ - "TrialComponentName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the trial component.

" - }, - "DisplayName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.

" - }, - "TrialComponentArn":{ - "shape":"TrialComponentArn", - "documentation":"

The Amazon Resource Name (ARN) of the trial component.

" - }, - "Source":{ - "shape":"TrialComponentSource", - "documentation":"

The Amazon Resource Name (ARN) and job type of the source of the component.

" - }, - "Status":{"shape":"TrialComponentStatus"}, - "StartTime":{ - "shape":"Timestamp", - "documentation":"

When the component started.

" - }, - "EndTime":{ - "shape":"Timestamp", - "documentation":"

When the component ended.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

When the component was created.

" - }, - "CreatedBy":{ - "shape":"UserContext", - "documentation":"

Who created the trial component.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

When the component was last modified.

" - }, - "LastModifiedBy":{"shape":"UserContext"}, - "Parameters":{ - "shape":"TrialComponentParameters", - "documentation":"

The hyperparameters of the component.

" - }, - "InputArtifacts":{ - "shape":"TrialComponentArtifacts", - "documentation":"

The input artifacts of the component.

" - }, - "OutputArtifacts":{ - "shape":"TrialComponentArtifacts", - "documentation":"

The output artifacts of the component.

" - }, - "Metrics":{ - "shape":"TrialComponentMetricSummaries", - "documentation":"

The metrics for the component.

" - }, - "MetadataProperties":{"shape":"MetadataProperties"}, - "SourceDetail":{ - "shape":"TrialComponentSourceDetail", - "documentation":"

Details of the source of the component.

" - }, - "LineageGroupArn":{ - "shape":"LineageGroupArn", - "documentation":"

The Amazon Resource Name (ARN) of the lineage group resource.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

The list of tags that are associated with the component. You can use Search API to search on the tags.

" - }, - "Parents":{ - "shape":"Parents", - "documentation":"

An array of the parents of the component. A parent is a trial the component is associated with and the experiment the trial is part of. A component might not have any parents.

" - }, - "RunName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the experiment run.

" - } - }, - "documentation":"

The properties of a trial component as returned by the Search API.

" - }, - "TrialComponentArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:experiment-trial-component/.*" - }, - "TrialComponentArtifact":{ - "type":"structure", - "required":["Value"], - "members":{ - "MediaType":{ - "shape":"MediaType", - "documentation":"

The media type of the artifact, which indicates the type of data in the artifact file. The media type consists of a type and a subtype concatenated with a slash (/) character, for example, text/csv, image/jpeg, and s3/uri. The type specifies the category of the media. The subtype specifies the kind of data.

" - }, - "Value":{ - "shape":"TrialComponentArtifactValue", - "documentation":"

The location of the artifact.

" - } - }, - "documentation":"

Represents an input or output artifact of a trial component. You specify TrialComponentArtifact as part of the InputArtifacts and OutputArtifacts parameters in the CreateTrialComponent request.

Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types. Examples of output artifacts are metrics, snapshots, logs, and images.

" - }, - "TrialComponentArtifactValue":{ - "type":"string", - "max":2048, - "min":0, - "pattern":".*" - }, - "TrialComponentArtifacts":{ - "type":"map", - "key":{"shape":"TrialComponentKey128"}, - "value":{"shape":"TrialComponentArtifact"}, - "max":60, - "min":0 - }, - "TrialComponentKey128":{ - "type":"string", - "max":128, - "min":0, - "pattern":".*" - }, - "TrialComponentKey256":{ - "type":"string", - "max":256, - "min":0, - "pattern":".*" - }, - "TrialComponentKey320":{ - "type":"string", - "max":320, - "min":0, - "pattern":".*" - }, - "TrialComponentMetricSummaries":{ - "type":"list", - "member":{"shape":"TrialComponentMetricSummary"} - }, - "TrialComponentMetricSummary":{ - "type":"structure", - "members":{ - "MetricName":{ - "shape":"MetricName", - "documentation":"

The name of the metric.

" - }, - "SourceArn":{ - "shape":"TrialComponentSourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the source.

" - }, - "TimeStamp":{ - "shape":"Timestamp", - "documentation":"

When the metric was last updated.

" - }, - "Max":{ - "shape":"OptionalDouble", - "documentation":"

The maximum value of the metric.

" - }, - "Min":{ - "shape":"OptionalDouble", - "documentation":"

The minimum value of the metric.

" - }, - "Last":{ - "shape":"OptionalDouble", - "documentation":"

The most recent value of the metric.

" - }, - "Count":{ - "shape":"OptionalInteger", - "documentation":"

The number of samples used to generate the metric.

" - }, - "Avg":{ - "shape":"OptionalDouble", - "documentation":"

The average value of the metric.

" - }, - "StdDev":{ - "shape":"OptionalDouble", - "documentation":"

The standard deviation of the metric.

" - } - }, - "documentation":"

A summary of the metrics of a trial component.

" - }, - "TrialComponentParameterValue":{ - "type":"structure", - "members":{ - "StringValue":{ - "shape":"StringParameterValue", - "documentation":"

The string value of a categorical hyperparameter. If you specify a value for this parameter, you can't specify the NumberValue parameter.

" - }, - "NumberValue":{ - "shape":"DoubleParameterValue", - "documentation":"

The numeric value of a numeric hyperparameter. If you specify a value for this parameter, you can't specify the StringValue parameter.

" - } - }, - "documentation":"

The value of a hyperparameter. Only one of NumberValue or StringValue can be specified.

This object is specified in the CreateTrialComponent request.

" - }, - "TrialComponentParameters":{ - "type":"map", - "key":{"shape":"TrialComponentKey320"}, - "value":{"shape":"TrialComponentParameterValue"}, - "max":300, - "min":0 - }, - "TrialComponentPrimaryStatus":{ - "type":"string", - "enum":[ - "InProgress", - "Completed", - "Failed", - "Stopping", - "Stopped" - ] - }, - "TrialComponentSimpleSummaries":{ - "type":"list", - "member":{"shape":"TrialComponentSimpleSummary"} - }, - "TrialComponentSimpleSummary":{ - "type":"structure", - "members":{ - "TrialComponentName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the trial component.

" - }, - "TrialComponentArn":{ - "shape":"TrialComponentArn", - "documentation":"

The Amazon Resource Name (ARN) of the trial component.

" - }, - "TrialComponentSource":{"shape":"TrialComponentSource"}, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

When the component was created.

" - }, - "CreatedBy":{"shape":"UserContext"} - }, - "documentation":"

A short summary of a trial component.

" - }, - "TrialComponentSource":{ - "type":"structure", - "required":["SourceArn"], - "members":{ - "SourceArn":{ - "shape":"TrialComponentSourceArn", - "documentation":"

The source Amazon Resource Name (ARN).

" - }, - "SourceType":{ - "shape":"SourceType", - "documentation":"

The source job type.

" - } - }, - "documentation":"

The Amazon Resource Name (ARN) and job type of the source of a trial component.

" - }, - "TrialComponentSourceArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:.*" - }, - "TrialComponentSourceDetail":{ - "type":"structure", - "members":{ - "SourceArn":{ - "shape":"TrialComponentSourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the source.

" - }, - "TrainingJob":{ - "shape":"TrainingJob", - "documentation":"

Information about a training job that's the source of a trial component.

" - }, - "ProcessingJob":{ - "shape":"ProcessingJob", - "documentation":"

Information about a processing job that's the source of a trial component.

" - }, - "TransformJob":{ - "shape":"TransformJob", - "documentation":"

Information about a transform job that's the source of a trial component.

" - } - }, - "documentation":"

Detailed information about the source of a trial component. Either ProcessingJob or TrainingJob is returned.

" - }, - "TrialComponentSources":{ - "type":"list", - "member":{"shape":"TrialComponentSource"} - }, - "TrialComponentStatus":{ - "type":"structure", - "members":{ - "PrimaryStatus":{ - "shape":"TrialComponentPrimaryStatus", - "documentation":"

The status of the trial component.

" - }, - "Message":{ - "shape":"TrialComponentStatusMessage", - "documentation":"

If the component failed, a message describing why.

" - } - }, - "documentation":"

The status of the trial component.

" - }, - "TrialComponentStatusMessage":{ - "type":"string", - "max":1024, - "min":0, - "pattern":".*" - }, - "TrialComponentSummaries":{ - "type":"list", - "member":{"shape":"TrialComponentSummary"} - }, - "TrialComponentSummary":{ - "type":"structure", - "members":{ - "TrialComponentName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the trial component.

" - }, - "TrialComponentArn":{ - "shape":"TrialComponentArn", - "documentation":"

The Amazon Resource Name (ARN) of the trial component.

" - }, - "DisplayName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.

" - }, - "TrialComponentSource":{"shape":"TrialComponentSource"}, - "Status":{ - "shape":"TrialComponentStatus", - "documentation":"

The status of the component. States include:

  • InProgress

  • Completed

  • Failed

" - }, - "StartTime":{ - "shape":"Timestamp", - "documentation":"

When the component started.

" - }, - "EndTime":{ - "shape":"Timestamp", - "documentation":"

When the component ended.

" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

When the component was created.

" - }, - "CreatedBy":{ - "shape":"UserContext", - "documentation":"

Who created the trial component.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

When the component was last modified.

" - }, - "LastModifiedBy":{ - "shape":"UserContext", - "documentation":"

Who last modified the component.

" - } - }, - "documentation":"

A summary of the properties of a trial component. To get all the properties, call the DescribeTrialComponent API and provide the TrialComponentName.

" - }, - "TrialSource":{ - "type":"structure", - "required":["SourceArn"], - "members":{ - "SourceArn":{ - "shape":"TrialSourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the source.

" - }, - "SourceType":{ - "shape":"SourceType", - "documentation":"

The source job type.

" - } - }, - "documentation":"

The source of the trial.

" - }, - "TrialSourceArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:.*" - }, - "TrialSummaries":{ - "type":"list", - "member":{"shape":"TrialSummary"} - }, - "TrialSummary":{ - "type":"structure", - "members":{ - "TrialArn":{ - "shape":"TrialArn", - "documentation":"

The Amazon Resource Name (ARN) of the trial.

" - }, - "TrialName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the trial.

" - }, - "DisplayName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the trial as displayed. If DisplayName isn't specified, TrialName is displayed.

" - }, - "TrialSource":{"shape":"TrialSource"}, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"

When the trial was created.

" - }, - "LastModifiedTime":{ - "shape":"Timestamp", - "documentation":"

When the trial was last modified.

" - } - }, - "documentation":"

A summary of the properties of a trial. To get the complete set of properties, call the DescribeTrial API and provide the TrialName.

" - }, - "TrustedIdentityPropagationSettings":{ - "type":"structure", - "required":["Status"], - "members":{ - "Status":{ - "shape":"FeatureStatus", - "documentation":"

The status of Trusted Identity Propagation (TIP) at the SageMaker domain level.

When disabled, standard IAM role-based access is used.

When enabled:

  • User identities from IAM Identity Center are propagated through the application to TIP enabled Amazon Web Services services.

  • New applications or existing applications that are automatically patched, will use the domain level configuration.

" - } - }, - "documentation":"

The Trusted Identity Propagation (TIP) settings for the SageMaker domain. These settings determine how user identities from IAM Identity Center are propagated through the domain to TIP enabled Amazon Web Services services.

" - }, - "TtlDuration":{ - "type":"structure", - "members":{ - "Unit":{ - "shape":"TtlDurationUnit", - "documentation":"

TtlDuration time unit.

" - }, - "Value":{ - "shape":"TtlDurationValue", - "documentation":"

TtlDuration time value.

" - } - }, - "documentation":"

Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration. For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

" - }, - "TtlDurationUnit":{ - "type":"string", - "enum":[ - "Seconds", - "Minutes", - "Hours", - "Days", - "Weeks" - ] - }, - "TtlDurationValue":{ - "type":"integer", - "box":true, - "min":1 - }, - "TuningJobCompletionCriteria":{ - "type":"structure", - "members":{ - "TargetObjectiveMetricValue":{ - "shape":"TargetObjectiveMetricValue", - "documentation":"

The value of the objective metric.

" - }, - "BestObjectiveNotImproving":{ - "shape":"BestObjectiveNotImproving", - "documentation":"

A flag to stop your hyperparameter tuning job if model performance fails to improve as evaluated against an objective function.

" - }, - "ConvergenceDetected":{ - "shape":"ConvergenceDetected", - "documentation":"

A flag to top your hyperparameter tuning job if automatic model tuning (AMT) has detected that your model has converged as evaluated against your objective function.

" - } - }, - "documentation":"

The job completion criteria.

" - }, - "TuningJobStepMetaData":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"HyperParameterTuningJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.

" - } - }, - "documentation":"

Metadata for a tuning step.

" - }, - "USD":{ - "type":"structure", - "members":{ - "Dollars":{ - "shape":"Dollars", - "documentation":"

The whole number of dollars in the amount.

", - "box":true - }, - "Cents":{ - "shape":"Cents", - "documentation":"

The fractional portion, in cents, of the amount.

", - "box":true - }, - "TenthFractionsOfACent":{ - "shape":"TenthFractionsOfACent", - "documentation":"

Fractions of a cent, in tenths.

", - "box":true - } - }, - "documentation":"

Represents an amount of money in United States dollars.

" - }, - "UiConfig":{ - "type":"structure", - "members":{ - "UiTemplateS3Uri":{ - "shape":"S3Uri", - "documentation":"

The Amazon S3 bucket location of the UI template, or worker task template. This is the template used to render the worker UI and tools for labeling job tasks. For more information about the contents of a UI template, see Creating Your Custom Labeling Task Template.

" - }, - "HumanTaskUiArn":{ - "shape":"HumanTaskUiArn", - "documentation":"

The ARN of the worker task template used to render the worker UI and tools for labeling job tasks.

Use this parameter when you are creating a labeling job for named entity recognition, 3D point cloud and video frame labeling jobs. Use your labeling job task type to select one of the following ARNs and use it with this parameter when you create a labeling job. Replace aws-region with the Amazon Web Services Region you are creating your labeling job in. For example, replace aws-region with us-west-1 if you create a labeling job in US West (N. California).

Named Entity Recognition

Use the following HumanTaskUiArn for named entity recognition labeling jobs:

arn:aws:sagemaker:aws-region:394669845002:human-task-ui/NamedEntityRecognition

3D Point Cloud HumanTaskUiArns

Use this HumanTaskUiArn for 3D point cloud object detection and 3D point cloud object detection adjustment labeling jobs.

  • arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectDetection

Use this HumanTaskUiArn for 3D point cloud object tracking and 3D point cloud object tracking adjustment labeling jobs.

  • arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectTracking

Use this HumanTaskUiArn for 3D point cloud semantic segmentation and 3D point cloud semantic segmentation adjustment labeling jobs.

  • arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudSemanticSegmentation

Video Frame HumanTaskUiArns

Use this HumanTaskUiArn for video frame object detection and video frame object detection adjustment labeling jobs.

  • arn:aws:sagemaker:region:394669845002:human-task-ui/VideoObjectDetection

Use this HumanTaskUiArn for video frame object tracking and video frame object tracking adjustment labeling jobs.

  • arn:aws:sagemaker:aws-region:394669845002:human-task-ui/VideoObjectTracking

" - } - }, - "documentation":"

Provided configuration information for the worker UI for a labeling job. Provide either HumanTaskUiArn or UiTemplateS3Uri.

For named entity recognition, 3D point cloud and video frame labeling jobs, use HumanTaskUiArn.

For all other Ground Truth built-in task types and custom task types, use UiTemplateS3Uri to specify the location of a worker task template in Amazon S3.

" - }, - "UiTemplate":{ - "type":"structure", - "required":["Content"], - "members":{ - "Content":{ - "shape":"TemplateContent", - "documentation":"

The content of the Liquid template for the worker user interface.

" - } - }, - "documentation":"

The Liquid template for the worker user interface.

" - }, - "UiTemplateInfo":{ - "type":"structure", - "members":{ - "Url":{ - "shape":"TemplateUrl", - "documentation":"

The URL for the user interface template.

" - }, - "ContentSha256":{ - "shape":"TemplateContentSha256", - "documentation":"

The SHA-256 digest of the contents of the template.

" - } - }, - "documentation":"

Container for user interface template information.

" - }, - "Uid":{ - "type":"long", - "box":true, - "max":4000000, - "min":10000 - }, - "UltraServer":{ - "type":"structure", - "required":[ - "UltraServerId", - "UltraServerType", - "AvailabilityZone", - "InstanceType", - "TotalInstanceCount" - ], - "members":{ - "UltraServerId":{ - "shape":"NonEmptyString256", - "documentation":"

The unique identifier for the UltraServer.

" - }, - "UltraServerType":{ - "shape":"UltraServerType", - "documentation":"

The type of UltraServer, such as ml.u-p6e-gb200x72.

" - }, - "AvailabilityZone":{ - "shape":"AvailabilityZone", - "documentation":"

The name of the Availability Zone where the UltraServer is provisioned.

" - }, - "InstanceType":{ - "shape":"ReservedCapacityInstanceType", - "documentation":"

The Amazon EC2 instance type used in the UltraServer.

" - }, - "TotalInstanceCount":{ - "shape":"TotalInstanceCount", - "documentation":"

The total number of instances in this UltraServer.

" - }, - "ConfiguredSpareInstanceCount":{ - "shape":"ConfiguredSpareInstanceCount", - "documentation":"

The number of spare instances configured for this UltraServer to provide enhanced resiliency.

" - }, - "AvailableInstanceCount":{ - "shape":"AvailableInstanceCount", - "documentation":"

The number of instances currently available for use in this UltraServer.

" - }, - "InUseInstanceCount":{ - "shape":"InUseInstanceCount", - "documentation":"

The number of instances currently in use in this UltraServer.

" - }, - "AvailableSpareInstanceCount":{ - "shape":"AvailableSpareInstanceCount", - "documentation":"

The number of available spare instances in the UltraServer.

" - }, - "UnhealthyInstanceCount":{ - "shape":"UnhealthyInstanceCount", - "documentation":"

The number of instances in this UltraServer that are currently in an unhealthy state.

" - }, - "HealthStatus":{ - "shape":"UltraServerHealthStatus", - "documentation":"

The overall health status of the UltraServer.

" - } - }, - "documentation":"

Represents a high-performance compute server used for distributed training in SageMaker AI. An UltraServer consists of multiple instances within a shared NVLink interconnect domain.

" - }, - "UltraServerCount":{ - "type":"integer", - "box":true, - "min":1 - }, - "UltraServerHealthStatus":{ - "type":"string", - "enum":[ - "OK", - "Impaired", - "Insufficient-Data" - ] - }, - "UltraServerInfo":{ - "type":"structure", - "members":{ - "Id":{ - "shape":"String", - "documentation":"

The unique identifier of the UltraServer.

" - }, - "Type":{ - "shape":"String", - "documentation":"

The type of the UltraServer.

" - } - }, - "documentation":"

Contains information about the UltraServer object.

" - }, - "UltraServerSummary":{ - "type":"structure", - "required":[ - "UltraServerType", - "InstanceType" - ], - "members":{ - "UltraServerType":{ - "shape":"UltraServerType", - "documentation":"

The type of UltraServer, such as ml.u-p6e-gb200x72.

" - }, - "InstanceType":{ - "shape":"ReservedCapacityInstanceType", - "documentation":"

The Amazon EC2 instance type used in the UltraServer.

" - }, - "UltraServerCount":{ - "shape":"UltraServerCount", - "documentation":"

The number of UltraServers of this type.

" - }, - "AvailableSpareInstanceCount":{ - "shape":"AvailableSpareInstanceCount", - "documentation":"

The number of available spare instances in the UltraServers.

" - }, - "UnhealthyInstanceCount":{ - "shape":"UnhealthyInstanceCount", - "documentation":"

The total number of instances across all UltraServers of this type that are currently in an unhealthy state.

" - } - }, - "documentation":"

A summary of UltraServer resources and their current status.

" - }, - "UltraServerType":{ - "type":"string", - "max":64, - "min":1, - "pattern":"ml.[a-z0-9\\-.]+" - }, - "UltraServers":{ - "type":"list", - "member":{"shape":"UltraServer"}, - "max":100, - "min":0 - }, - "UnhealthyInstanceCount":{ - "type":"integer", - "box":true, - "min":0 - }, - "UnifiedStudioDomainId":{ - "type":"string", - "pattern":"dzd[-_][a-zA-Z0-9_-]{1,36}" - }, - "UnifiedStudioEnvironmentId":{ - "type":"string", - "pattern":"[a-zA-Z0-9_-]{1,36}" - }, - "UnifiedStudioProjectId":{ - "type":"string", - "pattern":"[a-zA-Z0-9_-]{1,36}" - }, - "UnifiedStudioSettings":{ - "type":"structure", - "members":{ - "StudioWebPortalAccess":{ - "shape":"FeatureStatus", - "documentation":"

Sets whether you can access the domain in Amazon SageMaker Studio:

ENABLED

You can access the domain in Amazon SageMaker Studio. If you migrate the domain to Amazon SageMaker Unified Studio, you can access it in both studio interfaces.

DISABLED

You can't access the domain in Amazon SageMaker Studio. If you migrate the domain to Amazon SageMaker Unified Studio, you can access it only in that studio interface.

To migrate a domain to Amazon SageMaker Unified Studio, you specify the UnifiedStudioSettings data type when you use the UpdateDomain action.

" - }, - "DomainAccountId":{ - "shape":"AccountId", - "documentation":"

The ID of the Amazon Web Services account that has the Amazon SageMaker Unified Studio domain. The default value, if you don't specify an ID, is the ID of the account that has the Amazon SageMaker AI domain.

" - }, - "DomainRegion":{ - "shape":"RegionName", - "documentation":"

The Amazon Web Services Region where the domain is located in Amazon SageMaker Unified Studio. The default value, if you don't specify a Region, is the Region where the Amazon SageMaker AI domain is located.

" - }, - "DomainId":{ - "shape":"UnifiedStudioDomainId", - "documentation":"

The ID of the Amazon SageMaker Unified Studio domain associated with this domain.

" - }, - "ProjectId":{ - "shape":"UnifiedStudioProjectId", - "documentation":"

The ID of the Amazon SageMaker Unified Studio project that corresponds to the domain.

" - }, - "EnvironmentId":{ - "shape":"UnifiedStudioEnvironmentId", - "documentation":"

The ID of the environment that Amazon SageMaker Unified Studio associates with the domain.

" - }, - "ProjectS3Path":{ - "shape":"S3Uri", - "documentation":"

The location where Amazon S3 stores temporary execution data and other artifacts for the project that corresponds to the domain.

" - }, - "SingleSignOnApplicationArn":{ - "shape":"SingleSignOnApplicationArn", - "documentation":"

The ARN of the Amazon DataZone application managed by Amazon SageMaker Unified Studio in the Amazon Web Services IAM Identity Center.

" - } - }, - "documentation":"

The settings that apply to an Amazon SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.

" - }, - "UpdateActionRequest":{ - "type":"structure", - "required":["ActionName"], - "members":{ - "ActionName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the action to update.

" - }, - "Description":{ - "shape":"ExperimentDescription", - "documentation":"

The new description for the action.

" - }, - "Status":{ - "shape":"ActionStatus", - "documentation":"

The new status for the action.

" - }, - "Properties":{ - "shape":"LineageEntityParameters", - "documentation":"

The new list of properties. Overwrites the current property list.

" - }, - "PropertiesToRemove":{ - "shape":"ListLineageEntityParameterKey", - "documentation":"

A list of properties to remove.

" - } - } - }, - "UpdateActionResponse":{ - "type":"structure", - "members":{ - "ActionArn":{ - "shape":"ActionArn", - "documentation":"

The Amazon Resource Name (ARN) of the action.

" - } - } - }, - "UpdateAppImageConfigRequest":{ - "type":"structure", - "required":["AppImageConfigName"], - "members":{ - "AppImageConfigName":{ - "shape":"AppImageConfigName", - "documentation":"

The name of the AppImageConfig to update.

" - }, - "KernelGatewayImageConfig":{ - "shape":"KernelGatewayImageConfig", - "documentation":"

The new KernelGateway app to run on the image.

" - }, - "JupyterLabAppImageConfig":{ - "shape":"JupyterLabAppImageConfig", - "documentation":"

The JupyterLab app running on the image.

" - }, - "CodeEditorAppImageConfig":{ - "shape":"CodeEditorAppImageConfig", - "documentation":"

The Code Editor app running on the image.

" - } - } - }, - "UpdateAppImageConfigResponse":{ - "type":"structure", - "members":{ - "AppImageConfigArn":{ - "shape":"AppImageConfigArn", - "documentation":"

The ARN for the AppImageConfig.

" - } - } - }, - "UpdateArtifactRequest":{ - "type":"structure", - "required":["ArtifactArn"], - "members":{ - "ArtifactArn":{ - "shape":"ArtifactArn", - "documentation":"

The Amazon Resource Name (ARN) of the artifact to update.

" - }, - "ArtifactName":{ - "shape":"ExperimentEntityName", - "documentation":"

The new name for the artifact.

" - }, - "Properties":{ - "shape":"ArtifactProperties", - "documentation":"

The new list of properties. Overwrites the current property list.

" - }, - "PropertiesToRemove":{ - "shape":"ListLineageEntityParameterKey", - "documentation":"

A list of properties to remove.

" - } - } - }, - "UpdateArtifactResponse":{ - "type":"structure", - "members":{ - "ArtifactArn":{ - "shape":"ArtifactArn", - "documentation":"

The Amazon Resource Name (ARN) of the artifact.

" - } - } - }, - "UpdateClusterRequest":{ - "type":"structure", - "required":["ClusterName"], - "members":{ - "ClusterName":{ - "shape":"ClusterNameOrArn", - "documentation":"

Specify the name of the SageMaker HyperPod cluster you want to update.

" - }, - "InstanceGroups":{ - "shape":"ClusterInstanceGroupSpecifications", - "documentation":"

Specify the instance groups to update.

" - }, - "RestrictedInstanceGroups":{ - "shape":"ClusterRestrictedInstanceGroupSpecifications", - "documentation":"

The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.

" - }, - "RestrictedInstanceGroupsConfig":{ - "shape":"ClusterRestrictedInstanceGroupsConfig", - "documentation":"

The configuration for the restricted instance groups (RIG) in the SageMaker HyperPod cluster.

" - }, - "TieredStorageConfig":{ - "shape":"ClusterTieredStorageConfig", - "documentation":"

Updates the configuration for managed tier checkpointing on the HyperPod cluster. For example, you can enable or disable the feature and modify the percentage of cluster memory allocated for checkpoint storage.

" - }, - "NodeRecovery":{ - "shape":"ClusterNodeRecovery", - "documentation":"

The node recovery mode to be applied to the SageMaker HyperPod cluster.

" - }, - "InstanceGroupsToDelete":{ - "shape":"ClusterInstanceGroupsToDelete", - "documentation":"

Specify the names of the instance groups to delete. Use a single , as the separator between multiple names.

" - }, - "NodeProvisioningMode":{ - "shape":"ClusterNodeProvisioningMode", - "documentation":"

Determines how instance provisioning is handled during cluster operations. In Continuous mode, the cluster provisions available instances incrementally and retries until the target count is reached. The cluster becomes operational once cluster-level resources are ready. Use CurrentCount and TargetCount in DescribeCluster to track provisioning progress.

" - }, - "ClusterRole":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the IAM role that HyperPod assumes for cluster autoscaling operations. Cannot be updated while autoscaling is enabled.

" - }, - "AutoScaling":{ - "shape":"ClusterAutoScalingConfig", - "documentation":"

Updates the autoscaling configuration for the cluster. Use to enable or disable automatic node scaling.

" - }, - "Orchestrator":{"shape":"ClusterOrchestrator"} - } - }, - "UpdateClusterResponse":{ - "type":"structure", - "required":["ClusterArn"], - "members":{ - "ClusterArn":{ - "shape":"ClusterArn", - "documentation":"

The Amazon Resource Name (ARN) of the updated SageMaker HyperPod cluster.

" - } - } - }, - "UpdateClusterSchedulerConfigRequest":{ - "type":"structure", - "required":[ - "ClusterSchedulerConfigId", - "TargetVersion" - ], - "members":{ - "ClusterSchedulerConfigId":{ - "shape":"ClusterSchedulerConfigId", - "documentation":"

ID of the cluster policy.

" - }, - "TargetVersion":{ - "shape":"Integer", - "documentation":"

Target version.

", - "box":true - }, - "SchedulerConfig":{ - "shape":"SchedulerConfig", - "documentation":"

Cluster policy configuration.

" - }, - "Description":{ - "shape":"EntityDescription", - "documentation":"

Description of the cluster policy.

" - } - } - }, - "UpdateClusterSchedulerConfigResponse":{ - "type":"structure", - "required":[ - "ClusterSchedulerConfigArn", - "ClusterSchedulerConfigVersion" - ], - "members":{ - "ClusterSchedulerConfigArn":{ - "shape":"ClusterSchedulerConfigArn", - "documentation":"

ARN of the cluster policy.

" - }, - "ClusterSchedulerConfigVersion":{ - "shape":"Integer", - "documentation":"

Version of the cluster policy.

", - "box":true - } - } - }, - "UpdateClusterSoftwareInstanceGroupSpecification":{ - "type":"structure", - "required":["InstanceGroupName"], - "members":{ - "InstanceGroupName":{ - "shape":"ClusterInstanceGroupName", - "documentation":"

The name of the instance group to update.

" - }, - "ImageReleaseVersion":{ - "shape":"ImageReleaseVersion", - "documentation":"

The version of the HyperPod-managed AMI to update to for the instance group. Uses semantic versioning in the format MAJOR.MINOR.PATCH.

" - } - }, - "documentation":"

The configuration that describes specifications of the instance groups to update.

" - }, - "UpdateClusterSoftwareInstanceGroups":{ - "type":"list", - "member":{"shape":"UpdateClusterSoftwareInstanceGroupSpecification"}, - "max":100, - "min":1 - }, - "UpdateClusterSoftwareRequest":{ - "type":"structure", - "required":["ClusterName"], - "members":{ - "ClusterName":{ - "shape":"ClusterNameOrArn", - "documentation":"

Specify the name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster you want to update for security patching.

" - }, - "InstanceGroups":{ - "shape":"UpdateClusterSoftwareInstanceGroups", - "documentation":"

The array of instance groups for which to update AMI versions.

" - }, - "DeploymentConfig":{ - "shape":"DeploymentConfiguration", - "documentation":"

The configuration to use when updating the AMI versions.

" - }, - "ImageId":{ - "shape":"ImageId", - "documentation":"

When configuring your HyperPod cluster, you can specify an image ID using one of the following options:

  • HyperPodPublicAmiId: Use a HyperPod public AMI

  • CustomAmiId: Use your custom AMI

  • default: Use the default latest system image

If you choose to use a custom AMI (CustomAmiId), ensure it meets the following requirements:

  • Encryption: The custom AMI must be unencrypted.

  • Ownership: The custom AMI must be owned by the same Amazon Web Services account that is creating the HyperPod cluster.

  • Volume support: Only the primary AMI snapshot volume is supported; additional AMI volumes are not supported.

When updating the instance group's AMI through the UpdateClusterSoftware operation, if an instance group uses a custom AMI, you must provide an ImageId or use the default as input. Note that if you don't specify an instance group in your UpdateClusterSoftware request, then all of the instance groups are patched with the specified image.

" - } - } - }, - "UpdateClusterSoftwareResponse":{ - "type":"structure", - "required":["ClusterArn"], - "members":{ - "ClusterArn":{ - "shape":"ClusterArn", - "documentation":"

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster being updated for security patching.

" - } - } - }, - "UpdateCodeRepositoryInput":{ - "type":"structure", - "required":["CodeRepositoryName"], - "members":{ - "CodeRepositoryName":{ - "shape":"EntityName", - "documentation":"

The name of the Git repository to update.

" - }, - "GitConfig":{ - "shape":"GitConfigForUpdate", - "documentation":"

The configuration of the git repository, including the URL and the Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the repository. The secret must have a staging label of AWSCURRENT and must be in the following format:

{\"username\": UserName, \"password\": Password}

" - } - } - }, - "UpdateCodeRepositoryOutput":{ - "type":"structure", - "required":["CodeRepositoryArn"], - "members":{ - "CodeRepositoryArn":{ - "shape":"CodeRepositoryArn", - "documentation":"

The ARN of the Git repository.

" - } - } - }, - "UpdateComputeQuotaRequest":{ - "type":"structure", - "required":[ - "ComputeQuotaId", - "TargetVersion" - ], - "members":{ - "ComputeQuotaId":{ - "shape":"ComputeQuotaId", - "documentation":"

ID of the compute allocation definition.

" - }, - "TargetVersion":{ - "shape":"Integer", - "documentation":"

Target version.

", - "box":true - }, - "ComputeQuotaConfig":{ - "shape":"ComputeQuotaConfig", - "documentation":"

Configuration of the compute allocation definition. This includes the resource sharing option, and the setting to preempt low priority tasks.

" - }, - "ComputeQuotaTarget":{ - "shape":"ComputeQuotaTarget", - "documentation":"

The target entity to allocate compute resources to.

" - }, - "ActivationState":{ - "shape":"ActivationState", - "documentation":"

The state of the compute allocation being described. Use to enable or disable compute allocation.

Default is Enabled.

" - }, - "Description":{ - "shape":"EntityDescription", - "documentation":"

Description of the compute allocation definition.

" - } - } - }, - "UpdateComputeQuotaResponse":{ - "type":"structure", - "required":[ - "ComputeQuotaArn", - "ComputeQuotaVersion" - ], - "members":{ - "ComputeQuotaArn":{ - "shape":"ComputeQuotaArn", - "documentation":"

ARN of the compute allocation definition.

" - }, - "ComputeQuotaVersion":{ - "shape":"Integer", - "documentation":"

Version of the compute allocation definition.

", - "box":true - } - } - }, - "UpdateContextRequest":{ - "type":"structure", - "required":["ContextName"], - "members":{ - "ContextName":{ - "shape":"ContextName", - "documentation":"

The name of the context to update.

" - }, - "Description":{ - "shape":"ExperimentDescription", - "documentation":"

The new description for the context.

" - }, - "Properties":{ - "shape":"LineageEntityParameters", - "documentation":"

The new list of properties. Overwrites the current property list.

" - }, - "PropertiesToRemove":{ - "shape":"ListLineageEntityParameterKey", - "documentation":"

A list of properties to remove.

" - } - } - }, - "UpdateContextResponse":{ - "type":"structure", - "members":{ - "ContextArn":{ - "shape":"ContextArn", - "documentation":"

The Amazon Resource Name (ARN) of the context.

" - } - } - }, - "UpdateDeviceFleetRequest":{ - "type":"structure", - "required":[ - "DeviceFleetName", - "OutputConfig" - ], - "members":{ - "DeviceFleetName":{ - "shape":"EntityName", - "documentation":"

The name of the fleet.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the device.

" - }, - "Description":{ - "shape":"DeviceFleetDescription", - "documentation":"

Description of the fleet.

" - }, - "OutputConfig":{ - "shape":"EdgeOutputConfig", - "documentation":"

Output configuration for storing sample data collected by the fleet.

" - }, - "EnableIotRoleAlias":{ - "shape":"EnableIotRoleAlias", - "documentation":"

Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. The name of the role alias generated will match this pattern: \"SageMakerEdge-{DeviceFleetName}\".

For example, if your device fleet is called \"demo-fleet\", the name of the role alias will be \"SageMakerEdge-demo-fleet\".

" - } - } - }, - "UpdateDevicesRequest":{ - "type":"structure", - "required":[ - "DeviceFleetName", - "Devices" - ], - "members":{ - "DeviceFleetName":{ - "shape":"EntityName", - "documentation":"

The name of the fleet the devices belong to.

" - }, - "Devices":{ - "shape":"Devices", - "documentation":"

List of devices to register with Edge Manager agent.

" - } - } - }, - "UpdateDomainRequest":{ - "type":"structure", - "required":["DomainId"], - "members":{ - "DomainId":{ - "shape":"DomainId", - "documentation":"

The ID of the domain to be updated.

" - }, - "DefaultUserSettings":{ - "shape":"UserSettings", - "documentation":"

A collection of settings.

" - }, - "DomainSettingsForUpdate":{ - "shape":"DomainSettingsForUpdate", - "documentation":"

A collection of DomainSettings configuration values to update.

" - }, - "AppSecurityGroupManagement":{ - "shape":"AppSecurityGroupManagement", - "documentation":"

The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided. If setting up the domain for use with RStudio, this value must be set to Service.

" - }, - "DefaultSpaceSettings":{ - "shape":"DefaultSpaceSettings", - "documentation":"

The default settings for shared spaces that users create in the domain.

" - }, - "SubnetIds":{ - "shape":"Subnets", - "documentation":"

The VPC subnets that Studio uses for communication.

If removing subnets, ensure there are no apps in the InService, Pending, or Deleting state.

" - }, - "AppNetworkAccessType":{ - "shape":"AppNetworkAccessType", - "documentation":"

Specifies the VPC used for non-EFS traffic.

  • PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access.

  • VpcOnly - All Studio traffic is through the specified VPC and subnets.

This configuration can only be modified if there are no apps in the InService, Pending, or Deleting state. The configuration cannot be updated if DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is already set or DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided as part of the same request.

" - }, - "TagPropagation":{ - "shape":"TagPropagation", - "documentation":"

Indicates whether custom tag propagation is supported for the domain. Defaults to DISABLED.

" - }, - "HomeEfsFileSystemCreation":{ - "shape":"HomeEfsFileSystemCreation", - "documentation":"

Indicates whether to create a home EFS file system for the domain. You can change from Disabled to Enabled to provision EFS on demand, but you cannot change from Enabled to Disabled.

" - }, - "VpcId":{ - "shape":"VpcId", - "documentation":"

The identifier for the VPC used by the domain for network communication. Use this field only when adding VPC configuration to a SageMaker AI domain used in Amazon SageMaker Unified Studio that was created without VPC settings. SageMaker AI doesn't automatically apply VPC updates to existing applications. Stop and restart your applications to apply the changes.

" - } - } - }, - "UpdateDomainResponse":{ - "type":"structure", - "members":{ - "DomainArn":{ - "shape":"DomainArn", - "documentation":"

The Amazon Resource Name (ARN) of the domain.

" - } - } - }, - "UpdateEndpointInput":{ - "type":"structure", - "required":[ - "EndpointName", - "EndpointConfigName" - ], - "members":{ - "EndpointName":{ - "shape":"EndpointName", - "documentation":"

The name of the endpoint whose configuration you want to update.

" - }, - "EndpointConfigName":{ - "shape":"EndpointConfigName", - "documentation":"

The name of the new endpoint configuration.

" - }, - "RetainAllVariantProperties":{ - "shape":"Boolean", - "documentation":"

When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight. To retain the variant properties of an endpoint when updating it, set RetainAllVariantProperties to true. To use the variant properties specified in a new EndpointConfig call when updating an endpoint, set RetainAllVariantProperties to false. The default is false.

", - "box":true - }, - "ExcludeRetainedVariantProperties":{ - "shape":"VariantPropertyList", - "documentation":"

When you are updating endpoint resources with RetainAllVariantProperties, whose value is set to true, ExcludeRetainedVariantProperties specifies the list of type VariantProperty to override with the values provided by EndpointConfig. If you don't specify a value for ExcludeRetainedVariantProperties, no variant properties are overridden.

" - }, - "DeploymentConfig":{ - "shape":"DeploymentConfig", - "documentation":"

The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.

" - }, - "RetainDeploymentConfig":{ - "shape":"Boolean", - "documentation":"

Specifies whether to reuse the last deployment configuration. The default value is false (the configuration is not reused).

", - "box":true - } - } - }, - "UpdateEndpointOutput":{ - "type":"structure", - "required":["EndpointArn"], - "members":{ - "EndpointArn":{ - "shape":"EndpointArn", - "documentation":"

The Amazon Resource Name (ARN) of the endpoint.

" - } - } - }, - "UpdateEndpointWeightsAndCapacitiesInput":{ - "type":"structure", - "required":[ - "EndpointName", - "DesiredWeightsAndCapacities" - ], - "members":{ - "EndpointName":{ - "shape":"EndpointName", - "documentation":"

The name of an existing SageMaker endpoint.

" - }, - "DesiredWeightsAndCapacities":{ - "shape":"DesiredWeightAndCapacityList", - "documentation":"

An object that provides new capacity and weight values for a variant.

" - } - } - }, - "UpdateEndpointWeightsAndCapacitiesOutput":{ - "type":"structure", - "required":["EndpointArn"], - "members":{ - "EndpointArn":{ - "shape":"EndpointArn", - "documentation":"

The Amazon Resource Name (ARN) of the updated endpoint.

" - } - } - }, - "UpdateExperimentRequest":{ - "type":"structure", - "required":["ExperimentName"], - "members":{ - "ExperimentName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the experiment to update.

" - }, - "DisplayName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the experiment as displayed. The name doesn't need to be unique. If DisplayName isn't specified, ExperimentName is displayed.

" - }, - "Description":{ - "shape":"ExperimentDescription", - "documentation":"

The description of the experiment.

" - } - } - }, - "UpdateExperimentResponse":{ - "type":"structure", - "members":{ - "ExperimentArn":{ - "shape":"ExperimentArn", - "documentation":"

The Amazon Resource Name (ARN) of the experiment.

" - } - } - }, - "UpdateFeatureGroupRequest":{ - "type":"structure", - "required":["FeatureGroupName"], - "members":{ - "FeatureGroupName":{ - "shape":"FeatureGroupNameOrArn", - "documentation":"

The name or Amazon Resource Name (ARN) of the feature group that you're updating.

" - }, - "FeatureAdditions":{ - "shape":"FeatureAdditions", - "documentation":"

Updates the feature group. Updating a feature group is an asynchronous operation. When you get an HTTP 200 response, you've made a valid request. It takes some time after you've made a valid request for Feature Store to update the feature group.

" - }, - "OnlineStoreConfig":{ - "shape":"OnlineStoreConfigUpdate", - "documentation":"

Updates the feature group online store configuration.

" - }, - "ThroughputConfig":{"shape":"ThroughputConfigUpdate"} - } - }, - "UpdateFeatureGroupResponse":{ - "type":"structure", - "required":["FeatureGroupArn"], - "members":{ - "FeatureGroupArn":{ - "shape":"FeatureGroupArn", - "documentation":"

The Amazon Resource Number (ARN) of the feature group that you're updating.

" - } - } - }, - "UpdateFeatureMetadataRequest":{ - "type":"structure", - "required":[ - "FeatureGroupName", - "FeatureName" - ], - "members":{ - "FeatureGroupName":{ - "shape":"FeatureGroupNameOrArn", - "documentation":"

The name or Amazon Resource Name (ARN) of the feature group containing the feature that you're updating.

" - }, - "FeatureName":{ - "shape":"FeatureName", - "documentation":"

The name of the feature that you're updating.

" - }, - "Description":{ - "shape":"FeatureDescription", - "documentation":"

A description that you can write to better describe the feature.

" - }, - "ParameterAdditions":{ - "shape":"FeatureParameterAdditions", - "documentation":"

A list of key-value pairs that you can add to better describe the feature.

" - }, - "ParameterRemovals":{ - "shape":"FeatureParameterRemovals", - "documentation":"

A list of parameter keys that you can specify to remove parameters that describe your feature.

" - } - } - }, - "UpdateHubContentReferenceRequest":{ - "type":"structure", - "required":[ - "HubName", - "HubContentName", - "HubContentType" - ], - "members":{ - "HubName":{ - "shape":"HubNameOrArn", - "documentation":"

The name of the SageMaker hub that contains the hub content you want to update. You can optionally use the hub ARN instead.

" - }, - "HubContentName":{ - "shape":"HubContentName", - "documentation":"

The name of the hub content resource that you want to update.

" - }, - "HubContentType":{ - "shape":"HubContentType", - "documentation":"

The content type of the resource that you want to update. Only specify a ModelReference resource for this API. To update a Model or Notebook resource, use the UpdateHubContent API instead.

" - }, - "MinVersion":{ - "shape":"HubContentVersion", - "documentation":"

The minimum hub content version of the referenced model that you want to use. The minimum version must be older than the latest available version of the referenced model. To support all versions of a model, set the value to 1.0.0.

" - } - } - }, - "UpdateHubContentReferenceResponse":{ - "type":"structure", - "required":[ - "HubArn", - "HubContentArn" - ], - "members":{ - "HubArn":{ - "shape":"HubArn", - "documentation":"

The ARN of the private model hub that contains the updated hub content.

" - }, - "HubContentArn":{ - "shape":"HubContentArn", - "documentation":"

The ARN of the hub content resource that was updated.

" - } - } - }, - "UpdateHubContentRequest":{ - "type":"structure", - "required":[ - "HubName", - "HubContentName", - "HubContentType", - "HubContentVersion" - ], - "members":{ - "HubName":{ - "shape":"HubNameOrArn", - "documentation":"

The name of the SageMaker hub that contains the hub content you want to update. You can optionally use the hub ARN instead.

" - }, - "HubContentName":{ - "shape":"HubContentName", - "documentation":"

The name of the hub content resource that you want to update.

" - }, - "HubContentType":{ - "shape":"HubContentType", - "documentation":"

The content type of the resource that you want to update. Only specify a Model or Notebook resource for this API. To update a ModelReference, use the UpdateHubContentReference API instead.

" - }, - "HubContentVersion":{ - "shape":"HubContentVersion", - "documentation":"

The hub content version that you want to update. For example, if you have two versions of a resource in your hub, you can update the second version.

" - }, - "HubContentDisplayName":{ - "shape":"HubContentDisplayName", - "documentation":"

The display name of the hub content.

" - }, - "HubContentDescription":{ - "shape":"HubContentDescription", - "documentation":"

The description of the hub content.

" - }, - "HubContentMarkdown":{ - "shape":"HubContentMarkdown", - "documentation":"

A string that provides a description of the hub content. This string can include links, tables, and standard markdown formatting.

" - }, - "HubContentSearchKeywords":{ - "shape":"HubContentSearchKeywordList", - "documentation":"

The searchable keywords of the hub content.

" - }, - "SupportStatus":{ - "shape":"HubContentSupportStatus", - "documentation":"

Indicates the current status of the hub content resource.

" - } - } - }, - "UpdateHubContentResponse":{ - "type":"structure", - "required":[ - "HubArn", - "HubContentArn" - ], - "members":{ - "HubArn":{ - "shape":"HubArn", - "documentation":"

The ARN of the private model hub that contains the updated hub content.

" - }, - "HubContentArn":{ - "shape":"HubContentArn", - "documentation":"

The ARN of the hub content resource that was updated.

" - } - } - }, - "UpdateHubRequest":{ - "type":"structure", - "required":["HubName"], - "members":{ - "HubName":{ - "shape":"HubNameOrArn", - "documentation":"

The name of the hub to update.

" - }, - "HubDescription":{ - "shape":"HubDescription", - "documentation":"

A description of the updated hub.

" - }, - "HubDisplayName":{ - "shape":"HubDisplayName", - "documentation":"

The display name of the hub.

" - }, - "HubSearchKeywords":{ - "shape":"HubSearchKeywordList", - "documentation":"

The searchable keywords for the hub.

" - } - } - }, - "UpdateHubResponse":{ - "type":"structure", - "required":["HubArn"], - "members":{ - "HubArn":{ - "shape":"HubArn", - "documentation":"

The Amazon Resource Name (ARN) of the updated hub.

" - } - } - }, - "UpdateImageRequest":{ - "type":"structure", - "required":["ImageName"], - "members":{ - "DeleteProperties":{ - "shape":"ImageDeletePropertyList", - "documentation":"

A list of properties to delete. Only the Description and DisplayName properties can be deleted.

" - }, - "Description":{ - "shape":"ImageDescription", - "documentation":"

The new description for the image.

" - }, - "DisplayName":{ - "shape":"ImageDisplayName", - "documentation":"

The new display name for the image.

" - }, - "ImageName":{ - "shape":"ImageName", - "documentation":"

The name of the image to update.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The new ARN for the IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.

" - } - } - }, - "UpdateImageResponse":{ - "type":"structure", - "members":{ - "ImageArn":{ - "shape":"ImageArn", - "documentation":"

The ARN of the image.

" - } - } - }, - "UpdateImageVersionRequest":{ - "type":"structure", - "required":["ImageName"], - "members":{ - "ImageName":{ - "shape":"ImageName", - "documentation":"

The name of the image.

" - }, - "Alias":{ - "shape":"SageMakerImageVersionAlias", - "documentation":"

The alias of the image version.

" - }, - "Version":{ - "shape":"ImageVersionNumber", - "documentation":"

The version of the image.

" - }, - "AliasesToAdd":{ - "shape":"SageMakerImageVersionAliases", - "documentation":"

A list of aliases to add.

" - }, - "AliasesToDelete":{ - "shape":"SageMakerImageVersionAliases", - "documentation":"

A list of aliases to delete.

" - }, - "VendorGuidance":{ - "shape":"VendorGuidance", - "documentation":"

The availability of the image version specified by the maintainer.

  • NOT_PROVIDED: The maintainers did not provide a status for image version stability.

  • STABLE: The image version is stable.

  • TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

  • ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

" - }, - "JobType":{ - "shape":"JobType", - "documentation":"

Indicates SageMaker AI job type compatibility.

  • TRAINING: The image version is compatible with SageMaker AI training jobs.

  • INFERENCE: The image version is compatible with SageMaker AI inference jobs.

  • NOTEBOOK_KERNEL: The image version is compatible with SageMaker AI notebook kernels.

" - }, - "MLFramework":{ - "shape":"MLFramework", - "documentation":"

The machine learning framework vended in the image version.

" - }, - "ProgrammingLang":{ - "shape":"ProgrammingLang", - "documentation":"

The supported programming language and its version.

" - }, - "Processor":{ - "shape":"Processor", - "documentation":"

Indicates CPU or GPU compatibility.

  • CPU: The image version is compatible with CPU.

  • GPU: The image version is compatible with GPU.

" - }, - "Horovod":{ - "shape":"Horovod", - "documentation":"

Indicates Horovod compatibility.

", - "box":true - }, - "ReleaseNotes":{ - "shape":"ReleaseNotes", - "documentation":"

The maintainer description of the image version.

" - } - } - }, - "UpdateImageVersionResponse":{ - "type":"structure", - "members":{ - "ImageVersionArn":{ - "shape":"ImageVersionArn", - "documentation":"

The ARN of the image version.

" - } - } - }, - "UpdateInferenceComponentInput":{ - "type":"structure", - "required":["InferenceComponentName"], - "members":{ - "InferenceComponentName":{ - "shape":"InferenceComponentName", - "documentation":"

The name of the inference component.

" - }, - "Specification":{ - "shape":"InferenceComponentSpecification", - "documentation":"

Details about the resources to deploy with this inference component, including the model, container, and compute resources.

" - }, - "Specifications":{ - "shape":"InferenceComponentSpecificationList", - "documentation":"

A list of specification objects for the inference component, one per instance type. Use this parameter when you want to specify different model or resource configurations for the inference component on each instance type. You can use either this parameter or the singular Specification parameter, but not both.

" - }, - "RuntimeConfig":{ - "shape":"InferenceComponentRuntimeConfig", - "documentation":"

Runtime settings for a model that is deployed with an inference component.

" - }, - "DeploymentConfig":{ - "shape":"InferenceComponentDeploymentConfig", - "documentation":"

The deployment configuration for the inference component. The configuration contains the desired deployment strategy and rollback settings.

" - } - } - }, - "UpdateInferenceComponentOutput":{ - "type":"structure", - "required":["InferenceComponentArn"], - "members":{ - "InferenceComponentArn":{ - "shape":"InferenceComponentArn", - "documentation":"

The Amazon Resource Name (ARN) of the inference component.

" - } - } - }, - "UpdateInferenceComponentRuntimeConfigInput":{ - "type":"structure", - "required":[ - "InferenceComponentName", - "DesiredRuntimeConfig" - ], - "members":{ - "InferenceComponentName":{ - "shape":"InferenceComponentName", - "documentation":"

The name of the inference component to update.

" - }, - "DesiredRuntimeConfig":{ - "shape":"InferenceComponentRuntimeConfig", - "documentation":"

Runtime settings for a model that is deployed with an inference component.

" - } - } - }, - "UpdateInferenceComponentRuntimeConfigOutput":{ - "type":"structure", - "required":["InferenceComponentArn"], - "members":{ - "InferenceComponentArn":{ - "shape":"InferenceComponentArn", - "documentation":"

The Amazon Resource Name (ARN) of the inference component.

" - } - } - }, - "UpdateInferenceExperimentRequest":{ - "type":"structure", - "required":["Name"], - "members":{ - "Name":{ - "shape":"InferenceExperimentName", - "documentation":"

The name of the inference experiment to be updated.

" - }, - "Schedule":{ - "shape":"InferenceExperimentSchedule", - "documentation":"

The duration for which the inference experiment will run. If the status of the inference experiment is Created, then you can update both the start and end dates. If the status of the inference experiment is Running, then you can update only the end date.

" - }, - "Description":{ - "shape":"InferenceExperimentDescription", - "documentation":"

The description of the inference experiment.

" - }, - "ModelVariants":{ - "shape":"ModelVariantConfigList", - "documentation":"

An array of ModelVariantConfig objects. There is one for each variant, whose infrastructure configuration you want to update.

" - }, - "DataStorageConfig":{ - "shape":"InferenceExperimentDataStorageConfig", - "documentation":"

The Amazon S3 location and configuration for storing inference request and response data.

" - }, - "ShadowModeConfig":{ - "shape":"ShadowModeConfig", - "documentation":"

The configuration of ShadowMode inference experiment type. Use this field to specify a production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant also specify the percentage of requests that Amazon SageMaker replicates.

" - } - } - }, - "UpdateInferenceExperimentResponse":{ - "type":"structure", - "required":["InferenceExperimentArn"], - "members":{ - "InferenceExperimentArn":{ - "shape":"InferenceExperimentArn", - "documentation":"

The ARN of the updated inference experiment.

" - } - } - }, - "UpdateMlflowAppRequest":{ - "type":"structure", - "required":["Arn"], - "members":{ - "Arn":{ - "shape":"MlflowAppArn", - "documentation":"

The ARN of the MLflow App to update.

" - }, - "Name":{ - "shape":"MlflowAppName", - "documentation":"

The name of the MLflow App to update.

" - }, - "ArtifactStoreUri":{ - "shape":"S3Uri", - "documentation":"

The new S3 URI for the general purpose bucket to use as the artifact store for the MLflow App.

" - }, - "ModelRegistrationMode":{ - "shape":"ModelRegistrationMode", - "documentation":"

Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. To enable automatic model registration, set this value to AutoModelRegistrationEnabled. To disable automatic model registration, set this value to AutoModelRegistrationDisabled. If not specified, AutomaticModelRegistration defaults to AutoModelRegistrationEnabled

" - }, - "WeeklyMaintenanceWindowStart":{ - "shape":"WeeklyMaintenanceWindowStart", - "documentation":"

The new weekly maintenance window start day and time to update. The maintenance window day and time should be in Coordinated Universal Time (UTC) 24-hour standard time. For example: TUE:03:30.

" - }, - "DefaultDomainIdList":{ - "shape":"DefaultDomainIdList", - "documentation":"

List of SageMaker Domain IDs for which this MLflow App is the default.

" - }, - "AccountDefaultStatus":{ - "shape":"AccountDefaultStatus", - "documentation":"

Indicates whether this this MLflow App is the default for the account.

" - } - } - }, - "UpdateMlflowAppResponse":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"MlflowAppArn", - "documentation":"

The ARN of the updated MLflow App.

" - } - } - }, - "UpdateMlflowTrackingServerRequest":{ - "type":"structure", - "required":["TrackingServerName"], - "members":{ - "TrackingServerName":{ - "shape":"TrackingServerName", - "documentation":"

The name of the MLflow Tracking Server to update.

" - }, - "ArtifactStoreUri":{ - "shape":"S3Uri", - "documentation":"

The new S3 URI for the general purpose bucket to use as the artifact store for the MLflow Tracking Server.

" - }, - "TrackingServerSize":{ - "shape":"TrackingServerSize", - "documentation":"

The new size for the MLflow Tracking Server.

" - }, - "AutomaticModelRegistration":{ - "shape":"Boolean", - "documentation":"

Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. To enable automatic model registration, set this value to True. To disable automatic model registration, set this value to False. If not specified, AutomaticModelRegistration defaults to False

", - "box":true - }, - "WeeklyMaintenanceWindowStart":{ - "shape":"WeeklyMaintenanceWindowStart", - "documentation":"

The new weekly maintenance window start day and time to update. The maintenance window day and time should be in Coordinated Universal Time (UTC) 24-hour standard time. For example: TUE:03:30.

" - }, - "S3BucketOwnerAccountId":{ - "shape":"AccountId", - "documentation":"

The new expected Amazon Web Services account ID that owns the Amazon S3 bucket for artifact storage.

" - }, - "S3BucketOwnerVerification":{ - "shape":"Boolean", - "documentation":"

Whether to enable or disable Amazon S3 Bucket Owenrship Verifaction whenever the MLflow Tracking Server interacts with Amazon Amazon S3.

", - "box":true - } - } - }, - "UpdateMlflowTrackingServerResponse":{ - "type":"structure", - "members":{ - "TrackingServerArn":{ - "shape":"TrackingServerArn", - "documentation":"

The ARN of the updated MLflow Tracking Server.

" - } - } - }, - "UpdateModelCardRequest":{ - "type":"structure", - "required":["ModelCardName"], - "members":{ - "ModelCardName":{ - "shape":"ModelCardNameOrArn", - "documentation":"

The name or Amazon Resource Name (ARN) of the model card to update.

" - }, - "Content":{ - "shape":"ModelCardContent", - "documentation":"

The updated model card content. Content must be in model card JSON schema and provided as a string.

When updating model card content, be sure to include the full content and not just updated content.

" - }, - "ModelCardStatus":{ - "shape":"ModelCardStatus", - "documentation":"

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

  • Draft: The model card is a work in progress.

  • PendingReview: The model card is pending review.

  • Approved: The model card is approved.

  • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

" - } - } - }, - "UpdateModelCardResponse":{ - "type":"structure", - "required":["ModelCardArn"], - "members":{ - "ModelCardArn":{ - "shape":"ModelCardArn", - "documentation":"

The Amazon Resource Name (ARN) of the updated model card.

" - } - } - }, - "UpdateModelPackageInput":{ - "type":"structure", - "required":["ModelPackageArn"], - "members":{ - "ModelPackageArn":{ - "shape":"ModelPackageArn", - "documentation":"

The Amazon Resource Name (ARN) of the model package.

" - }, - "ModelApprovalStatus":{ - "shape":"ModelApprovalStatus", - "documentation":"

The approval status of the model.

" - }, - "ModelPackageRegistrationType":{ - "shape":"ModelPackageRegistrationType", - "documentation":"

The package registration type of the model package input.

" - }, - "ApprovalDescription":{ - "shape":"ApprovalDescription", - "documentation":"

A description for the approval status of the model.

" - }, - "CustomerMetadataProperties":{ - "shape":"CustomerMetadataMap", - "documentation":"

The metadata properties associated with the model package versions.

" - }, - "CustomerMetadataPropertiesToRemove":{ - "shape":"CustomerMetadataKeyList", - "documentation":"

The metadata properties associated with the model package versions to remove.

" - }, - "AdditionalInferenceSpecificationsToAdd":{ - "shape":"AdditionalInferenceSpecifications", - "documentation":"

An array of additional Inference Specification objects to be added to the existing array additional Inference Specification. Total number of additional Inference Specifications can not exceed 15. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

" - }, - "InferenceSpecification":{ - "shape":"InferenceSpecification", - "documentation":"

Specifies details about inference jobs that you can run with models based on this model package, including the following information:

  • The Amazon ECR paths of containers that contain the inference code and model artifacts.

  • The instance types that the model package supports for transform jobs and real-time endpoints used for inference.

  • The input and output content formats that the model package supports for inference.

" - }, - "SourceUri":{ - "shape":"ModelPackageSourceUri", - "documentation":"

The URI of the source for the model package.

" - }, - "ModelCard":{ - "shape":"ModelPackageModelCard", - "documentation":"

The model card associated with the model package. Since ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version.

" - }, - "ModelLifeCycle":{ - "shape":"ModelLifeCycle", - "documentation":"

A structure describing the current state of the model in its life cycle.

" - }, - "ClientToken":{ - "shape":"ClientToken", - "documentation":"

A unique token that guarantees that the call to this API is idempotent.

" - } - } - }, - "UpdateModelPackageOutput":{ - "type":"structure", - "required":["ModelPackageArn"], - "members":{ - "ModelPackageArn":{ - "shape":"ModelPackageArn", - "documentation":"

The Amazon Resource Name (ARN) of the model.

" - } - } - }, - "UpdateMonitoringAlertRequest":{ - "type":"structure", - "required":[ - "MonitoringScheduleName", - "MonitoringAlertName", - "DatapointsToAlert", - "EvaluationPeriod" - ], - "members":{ - "MonitoringScheduleName":{ - "shape":"MonitoringScheduleName", - "documentation":"

The name of a monitoring schedule.

" - }, - "MonitoringAlertName":{ - "shape":"MonitoringAlertName", - "documentation":"

The name of a monitoring alert.

" - }, - "DatapointsToAlert":{ - "shape":"MonitoringDatapointsToAlert", - "documentation":"

Within EvaluationPeriod, how many execution failures will raise an alert.

" - }, - "EvaluationPeriod":{ - "shape":"MonitoringEvaluationPeriod", - "documentation":"

The number of most recent monitoring executions to consider when evaluating alert status.

" - } - } - }, - "UpdateMonitoringAlertResponse":{ - "type":"structure", - "required":["MonitoringScheduleArn"], - "members":{ - "MonitoringScheduleArn":{ - "shape":"MonitoringScheduleArn", - "documentation":"

The Amazon Resource Name (ARN) of the monitoring schedule.

" - }, - "MonitoringAlertName":{ - "shape":"MonitoringAlertName", - "documentation":"

The name of a monitoring alert.

" - } - } - }, - "UpdateMonitoringScheduleRequest":{ - "type":"structure", - "required":[ - "MonitoringScheduleName", - "MonitoringScheduleConfig" - ], - "members":{ - "MonitoringScheduleName":{ - "shape":"MonitoringScheduleName", - "documentation":"

The name of the monitoring schedule. The name must be unique within an Amazon Web Services Region within an Amazon Web Services account.

" - }, - "MonitoringScheduleConfig":{ - "shape":"MonitoringScheduleConfig", - "documentation":"

The configuration object that specifies the monitoring schedule and defines the monitoring job.

" - } - } - }, - "UpdateMonitoringScheduleResponse":{ - "type":"structure", - "required":["MonitoringScheduleArn"], - "members":{ - "MonitoringScheduleArn":{ - "shape":"MonitoringScheduleArn", - "documentation":"

The Amazon Resource Name (ARN) of the monitoring schedule.

" - } - } - }, - "UpdateNotebookInstanceInput":{ - "type":"structure", - "required":["NotebookInstanceName"], - "members":{ - "NotebookInstanceName":{ - "shape":"NotebookInstanceName", - "documentation":"

The name of the notebook instance to update.

" - }, - "InstanceType":{ - "shape":"InstanceType", - "documentation":"

The Amazon ML compute instance type.

" - }, - "IpAddressType":{ - "shape":"IPAddressType", - "documentation":"

The IP address type for the notebook instance. Specify ipv4 for IPv4-only connectivity or dualstack for both IPv4 and IPv6 connectivity. The notebook instance must be stopped before updating this setting. When you specify dualstack, the subnet must support IPv6 addressing.

" - }, - "PlatformIdentifier":{ - "shape":"PlatformIdentifier", - "documentation":"

The platform identifier of the notebook instance runtime environment.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the IAM role that SageMaker AI can assume to access the notebook instance. For more information, see SageMaker AI Roles.

To be able to pass this role to SageMaker AI, the caller of this API must have the iam:PassRole permission.

" - }, - "LifecycleConfigName":{ - "shape":"NotebookInstanceLifecycleConfigName", - "documentation":"

The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

" - }, - "DisassociateLifecycleConfig":{ - "shape":"DisassociateNotebookInstanceLifecycleConfig", - "documentation":"

Set to true to remove the notebook instance lifecycle configuration currently associated with the notebook instance. This operation is idempotent. If you specify a lifecycle configuration that is not associated with the notebook instance when you call this method, it does not throw an error.

", - "box":true - }, - "VolumeSizeInGB":{ - "shape":"NotebookInstanceVolumeSizeInGB", - "documentation":"

The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB. ML storage volumes are encrypted, so SageMaker AI can't determine the amount of available free space on the volume. Because of this, you can increase the volume size when you update a notebook instance, but you can't decrease the volume size. If you want to decrease the size of the ML storage volume in use, create a new notebook instance with the desired size.

" - }, - "DefaultCodeRepository":{ - "shape":"CodeRepositoryNameOrUrl", - "documentation":"

The Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker AI Notebook Instances.

" - }, - "AdditionalCodeRepositories":{ - "shape":"AdditionalCodeRepositoryNamesOrUrls", - "documentation":"

An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker AI Notebook Instances.

" - }, - "AcceleratorTypes":{ - "shape":"NotebookInstanceAcceleratorTypes", - "documentation":"

This parameter is no longer supported. Elastic Inference (EI) is no longer available.

This parameter was used to specify a list of the EI instance types to associate with this notebook instance.

" - }, - "DisassociateAcceleratorTypes":{ - "shape":"DisassociateNotebookInstanceAcceleratorTypes", - "documentation":"

This parameter is no longer supported. Elastic Inference (EI) is no longer available.

This parameter was used to specify a list of the EI instance types to remove from this notebook instance.

", - "box":true - }, - "DisassociateDefaultCodeRepository":{ - "shape":"DisassociateDefaultCodeRepository", - "documentation":"

The name or URL of the default Git repository to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.

", - "box":true - }, - "DisassociateAdditionalCodeRepositories":{ - "shape":"DisassociateAdditionalCodeRepositories", - "documentation":"

A list of names or URLs of the default Git repositories to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.

", - "box":true - }, - "RootAccess":{ - "shape":"RootAccess", - "documentation":"

Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled.

If you set this to Disabled, users don't have root access on the notebook instance, but lifecycle configuration scripts still run with root permissions.

" - }, - "InstanceMetadataServiceConfiguration":{ - "shape":"InstanceMetadataServiceConfiguration", - "documentation":"

Information on the IMDS configuration of the notebook instance

" - } - } - }, - "UpdateNotebookInstanceLifecycleConfigInput":{ - "type":"structure", - "required":["NotebookInstanceLifecycleConfigName"], - "members":{ - "NotebookInstanceLifecycleConfigName":{ - "shape":"NotebookInstanceLifecycleConfigName", - "documentation":"

The name of the lifecycle configuration.

" - }, - "OnCreate":{ - "shape":"NotebookInstanceLifecycleConfigList", - "documentation":"

The shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.

" - }, - "OnStart":{ - "shape":"NotebookInstanceLifecycleConfigList", - "documentation":"

The shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string.

" - } - } - }, - "UpdateNotebookInstanceLifecycleConfigOutput":{ - "type":"structure", - "members":{} - }, - "UpdateNotebookInstanceOutput":{ - "type":"structure", - "members":{} - }, - "UpdatePartnerAppRequest":{ - "type":"structure", - "required":["Arn"], - "members":{ - "Arn":{ - "shape":"PartnerAppArn", - "documentation":"

The ARN of the SageMaker Partner AI App to update.

" - }, - "MaintenanceConfig":{ - "shape":"PartnerAppMaintenanceConfig", - "documentation":"

Maintenance configuration settings for the SageMaker Partner AI App.

" - }, - "Tier":{ - "shape":"NonEmptyString64", - "documentation":"

Indicates the instance type and size of the cluster attached to the SageMaker Partner AI App.

" - }, - "ApplicationConfig":{ - "shape":"PartnerAppConfig", - "documentation":"

Configuration settings for the SageMaker Partner AI App.

" - }, - "EnableIamSessionBasedIdentity":{ - "shape":"Boolean", - "documentation":"

When set to TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user.

", - "box":true - }, - "EnableAutoMinorVersionUpgrade":{ - "shape":"Boolean", - "documentation":"

When set to TRUE, the SageMaker Partner AI App is automatically upgraded to the latest minor version during the next scheduled maintenance window, if one is available.

", - "box":true - }, - "AppVersion":{ - "shape":"MajorMinorVersion", - "documentation":"

The semantic version to upgrade the SageMaker Partner AI App to. Must be the same semantic version returned in the AvailableUpgrade field from DescribePartnerApp. Version skipping and downgrades are not supported.

" - }, - "ClientToken":{ - "shape":"ClientToken", - "documentation":"

A unique token that guarantees that the call to this API is idempotent.

", - "idempotencyToken":true - }, - "Tags":{ - "shape":"TagList", - "documentation":"

Each tag consists of a key and an optional value. Tag keys must be unique per resource.

" - } - } - }, - "UpdatePartnerAppResponse":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"PartnerAppArn", - "documentation":"

The ARN of the SageMaker Partner AI App that was updated.

" - } - } - }, - "UpdatePipelineExecutionRequest":{ - "type":"structure", - "required":["PipelineExecutionArn"], - "members":{ - "PipelineExecutionArn":{ - "shape":"PipelineExecutionArn", - "documentation":"

The Amazon Resource Name (ARN) of the pipeline execution.

" - }, - "PipelineExecutionDescription":{ - "shape":"PipelineExecutionDescription", - "documentation":"

The description of the pipeline execution.

" - }, - "PipelineExecutionDisplayName":{ - "shape":"PipelineExecutionName", - "documentation":"

The display name of the pipeline execution.

" - }, - "ParallelismConfiguration":{ - "shape":"ParallelismConfiguration", - "documentation":"

This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run.

" - } - } - }, - "UpdatePipelineExecutionResponse":{ - "type":"structure", - "members":{ - "PipelineExecutionArn":{ - "shape":"PipelineExecutionArn", - "documentation":"

The Amazon Resource Name (ARN) of the updated pipeline execution.

" - } - } - }, - "UpdatePipelineRequest":{ - "type":"structure", - "required":["PipelineName"], - "members":{ - "PipelineName":{ - "shape":"PipelineName", - "documentation":"

The name of the pipeline to update.

" - }, - "PipelineDisplayName":{ - "shape":"PipelineName", - "documentation":"

The display name of the pipeline.

" - }, - "PipelineDefinition":{ - "shape":"PipelineDefinition", - "documentation":"

The JSON pipeline definition.

" - }, - "PipelineDefinitionS3Location":{ - "shape":"PipelineDefinitionS3Location", - "documentation":"

The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location.

" - }, - "PipelineDescription":{ - "shape":"PipelineDescription", - "documentation":"

The description of the pipeline.

" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) that the pipeline uses to execute.

" - }, - "ParallelismConfiguration":{ - "shape":"ParallelismConfiguration", - "documentation":"

If specified, it applies to all executions of this pipeline by default.

" - } - } - }, - "UpdatePipelineResponse":{ - "type":"structure", - "members":{ - "PipelineArn":{ - "shape":"PipelineArn", - "documentation":"

The Amazon Resource Name (ARN) of the updated pipeline.

" - }, - "PipelineVersionId":{ - "shape":"PipelineVersionId", - "documentation":"

The ID of the pipeline version.

" - } - } - }, - "UpdatePipelineVersionRequest":{ - "type":"structure", - "required":[ - "PipelineArn", - "PipelineVersionId" - ], - "members":{ - "PipelineArn":{ - "shape":"PipelineArn", - "documentation":"

The Amazon Resource Name (ARN) of the pipeline.

" - }, - "PipelineVersionId":{ - "shape":"PipelineVersionId", - "documentation":"

The pipeline version ID to update.

" - }, - "PipelineVersionDisplayName":{ - "shape":"PipelineVersionName", - "documentation":"

The display name of the pipeline version.

" - }, - "PipelineVersionDescription":{ - "shape":"PipelineVersionDescription", - "documentation":"

The description of the pipeline version.

" - } - } - }, - "UpdatePipelineVersionResponse":{ - "type":"structure", - "members":{ - "PipelineArn":{ - "shape":"PipelineArn", - "documentation":"

The Amazon Resource Name (ARN) of the pipeline.

" - }, - "PipelineVersionId":{ - "shape":"PipelineVersionId", - "documentation":"

The ID of the pipeline version.

" - } - } - }, - "UpdateProjectInput":{ - "type":"structure", - "required":["ProjectName"], - "members":{ - "ProjectName":{ - "shape":"ProjectEntityName", - "documentation":"

The name of the project.

" - }, - "ProjectDescription":{ - "shape":"EntityDescription", - "documentation":"

The description for the project.

" - }, - "ServiceCatalogProvisioningUpdateDetails":{ - "shape":"ServiceCatalogProvisioningUpdateDetails", - "documentation":"

The product ID and provisioning artifact ID to provision a service catalog. The provisioning artifact ID will default to the latest provisioning artifact ID of the product, if you don't provide the provisioning artifact ID. For more information, see What is Amazon Web Services Service Catalog.

" - }, - "Tags":{ - "shape":"TagList", - "documentation":"

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources. In addition, the project must have tag update constraints set in order to include this parameter in the request. For more information, see Amazon Web Services Service Catalog Tag Update Constraints.

" - }, - "TemplateProvidersToUpdate":{ - "shape":"UpdateTemplateProviderList", - "documentation":"

The template providers to update in the project.

" - } - } - }, - "UpdateProjectOutput":{ - "type":"structure", - "required":["ProjectArn"], - "members":{ - "ProjectArn":{ - "shape":"ProjectArn", - "documentation":"

The Amazon Resource Name (ARN) of the project.

" - } - } - }, - "UpdateSpaceRequest":{ - "type":"structure", - "required":[ - "DomainId", - "SpaceName" - ], - "members":{ - "DomainId":{ - "shape":"DomainId", - "documentation":"

The ID of the associated domain.

" - }, - "SpaceName":{ - "shape":"SpaceName", - "documentation":"

The name of the space.

" - }, - "SpaceSettings":{ - "shape":"SpaceSettings", - "documentation":"

A collection of space settings.

" - }, - "SpaceDisplayName":{ - "shape":"NonEmptyString64", - "documentation":"

The name of the space that appears in the Amazon SageMaker Studio UI.

" - } - } - }, - "UpdateSpaceResponse":{ - "type":"structure", - "members":{ - "SpaceArn":{ - "shape":"SpaceArn", - "documentation":"

The space's Amazon Resource Name (ARN).

" - } - } - }, - "UpdateTemplateProvider":{ - "type":"structure", - "members":{ - "CfnTemplateProvider":{ - "shape":"CfnUpdateTemplateProvider", - "documentation":"

The CloudFormation template provider configuration to update.

" - } - }, - "documentation":"

Contains configuration details for updating an existing template provider in the project.

" - }, - "UpdateTemplateProviderList":{ - "type":"list", - "member":{"shape":"UpdateTemplateProvider"}, - "max":1, - "min":1 - }, - "UpdateTrainingJobRequest":{ - "type":"structure", - "required":["TrainingJobName"], - "members":{ - "TrainingJobName":{ - "shape":"TrainingJobName", - "documentation":"

The name of a training job to update the Debugger profiling configuration.

" - }, - "ProfilerConfig":{ - "shape":"ProfilerConfigForUpdate", - "documentation":"

Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and storage paths.

" - }, - "ProfilerRuleConfigurations":{ - "shape":"ProfilerRuleConfigurations", - "documentation":"

Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics.

" - }, - "ResourceConfig":{ - "shape":"ResourceConfigForUpdate", - "documentation":"

The training job ResourceConfig to update warm pool retention length.

" - }, - "RemoteDebugConfig":{ - "shape":"RemoteDebugConfigForUpdate", - "documentation":"

Configuration for remote debugging while the training job is running. You can update the remote debugging configuration when the SecondaryStatus of the job is Downloading or Training.To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.

" - } - } - }, - "UpdateTrainingJobResponse":{ - "type":"structure", - "required":["TrainingJobArn"], - "members":{ - "TrainingJobArn":{ - "shape":"TrainingJobArn", - "documentation":"

The Amazon Resource Name (ARN) of the training job.

" - } - } - }, - "UpdateTrialComponentRequest":{ - "type":"structure", - "required":["TrialComponentName"], - "members":{ - "TrialComponentName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the component to update.

" - }, - "DisplayName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the component as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialComponentName is displayed.

" - }, - "Status":{ - "shape":"TrialComponentStatus", - "documentation":"

The new status of the component.

" - }, - "StartTime":{ - "shape":"Timestamp", - "documentation":"

When the component started.

" - }, - "EndTime":{ - "shape":"Timestamp", - "documentation":"

When the component ended.

" - }, - "Parameters":{ - "shape":"TrialComponentParameters", - "documentation":"

Replaces all of the component's hyperparameters with the specified hyperparameters or add new hyperparameters. Existing hyperparameters are replaced if the trial component is updated with an identical hyperparameter key.

" - }, - "ParametersToRemove":{ - "shape":"ListTrialComponentKey256", - "documentation":"

The hyperparameters to remove from the component.

" - }, - "InputArtifacts":{ - "shape":"TrialComponentArtifacts", - "documentation":"

Replaces all of the component's input artifacts with the specified artifacts or adds new input artifacts. Existing input artifacts are replaced if the trial component is updated with an identical input artifact key.

" - }, - "InputArtifactsToRemove":{ - "shape":"ListTrialComponentKey256", - "documentation":"

The input artifacts to remove from the component.

" - }, - "OutputArtifacts":{ - "shape":"TrialComponentArtifacts", - "documentation":"

Replaces all of the component's output artifacts with the specified artifacts or adds new output artifacts. Existing output artifacts are replaced if the trial component is updated with an identical output artifact key.

" - }, - "OutputArtifactsToRemove":{ - "shape":"ListTrialComponentKey256", - "documentation":"

The output artifacts to remove from the component.

" - } - } - }, - "UpdateTrialComponentResponse":{ - "type":"structure", - "members":{ - "TrialComponentArn":{ - "shape":"TrialComponentArn", - "documentation":"

The Amazon Resource Name (ARN) of the trial component.

" - } - } - }, - "UpdateTrialRequest":{ - "type":"structure", - "required":["TrialName"], - "members":{ - "TrialName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the trial to update.

" - }, - "DisplayName":{ - "shape":"ExperimentEntityName", - "documentation":"

The name of the trial as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialName is displayed.

" - } - } - }, - "UpdateTrialResponse":{ - "type":"structure", - "members":{ - "TrialArn":{ - "shape":"TrialArn", - "documentation":"

The Amazon Resource Name (ARN) of the trial.

" - } - } - }, - "UpdateUserProfileRequest":{ - "type":"structure", - "required":[ - "DomainId", - "UserProfileName" - ], - "members":{ - "DomainId":{ - "shape":"DomainId", - "documentation":"

The domain ID.

" - }, - "UserProfileName":{ - "shape":"UserProfileName", - "documentation":"

The user profile name.

" - }, - "UserSettings":{ - "shape":"UserSettings", - "documentation":"

A collection of settings.

" - } - } - }, - "UpdateUserProfileResponse":{ - "type":"structure", - "members":{ - "UserProfileArn":{ - "shape":"UserProfileArn", - "documentation":"

The user profile Amazon Resource Name (ARN).

" - } - } - }, - "UpdateWorkforceRequest":{ - "type":"structure", - "required":["WorkforceName"], - "members":{ - "WorkforceName":{ - "shape":"WorkforceName", - "documentation":"

The name of the private workforce that you want to update. You can find your workforce name by using the ListWorkforces operation.

" - }, - "SourceIpConfig":{ - "shape":"SourceIpConfig", - "documentation":"

A list of one to ten worker IP address ranges (CIDRs) that can be used to access tasks assigned to this workforce.

Maximum: Ten CIDR values

" - }, - "OidcConfig":{ - "shape":"OidcConfig", - "documentation":"

Use this parameter to update your OIDC Identity Provider (IdP) configuration for a workforce made using your own IdP.

" - }, - "WorkforceVpcConfig":{ - "shape":"WorkforceVpcConfigRequest", - "documentation":"

Use this parameter to update your VPC configuration for a workforce.

" - }, - "IpAddressType":{ - "shape":"WorkforceIpAddressType", - "documentation":"

Use this parameter to specify whether you want IPv4 only or dualstack (IPv4 and IPv6) to support your labeling workforce.

" - } - } - }, - "UpdateWorkforceResponse":{ - "type":"structure", - "required":["Workforce"], - "members":{ - "Workforce":{ - "shape":"Workforce", - "documentation":"

A single private workforce. You can create one private work force in each Amazon Web Services Region. By default, any workforce-related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

" - } - } - }, - "UpdateWorkteamRequest":{ - "type":"structure", - "required":["WorkteamName"], - "members":{ - "WorkteamName":{ - "shape":"WorkteamName", - "documentation":"

The name of the work team to update.

" - }, - "MemberDefinitions":{ - "shape":"MemberDefinitions", - "documentation":"

A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.

Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use CognitoMemberDefinition. For workforces created using your own OIDC identity provider (IdP) use OidcMemberDefinition. You should not provide input for both of these parameters in a single request.

For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito user groups within the user pool used to create a workforce. All of the CognitoMemberDefinition objects that make up the member definition must have the same ClientId and UserPool values. To add a Amazon Cognito user group to an existing worker pool, see Adding groups to a User Pool. For more information about user pools, see Amazon Cognito User Pools.

For workforces created using your own OIDC IdP, specify the user groups that you want to include in your private work team in OidcMemberDefinition by listing those groups in Groups. Be aware that user groups that are already in the work team must also be listed in Groups when you make this request to remain on the work team. If you do not include these user groups, they will no longer be associated with the work team you update.

" - }, - "Description":{ - "shape":"String200", - "documentation":"

An updated description for the work team.

" - }, - "NotificationConfiguration":{ - "shape":"NotificationConfiguration", - "documentation":"

Configures SNS topic notifications for available or expiring work items

" - }, - "WorkerAccessConfiguration":{ - "shape":"WorkerAccessConfiguration", - "documentation":"

Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL.

" - } - } - }, - "UpdateWorkteamResponse":{ - "type":"structure", - "required":["Workteam"], - "members":{ - "Workteam":{ - "shape":"Workteam", - "documentation":"

A Workteam object that describes the updated work team.

" - } - } - }, - "Url":{ - "type":"string", - "max":1024, - "min":0, - "pattern":"(https|s3)://([^/]+)/?(.*)" - }, - "UserContext":{ - "type":"structure", - "members":{ - "UserProfileArn":{ - "shape":"String", - "documentation":"

The Amazon Resource Name (ARN) of the user's profile.

" - }, - "UserProfileName":{ - "shape":"String", - "documentation":"

The name of the user's profile.

" - }, - "DomainId":{ - "shape":"String", - "documentation":"

The domain associated with the user.

" - }, - "IamIdentity":{ - "shape":"IamIdentity", - "documentation":"

The IAM Identity details associated with the user. These details are associated with model package groups, model packages, and project entities only.

" - } - }, - "documentation":"

Information about the user who created or modified a SageMaker resource.

" - }, - "UserProfileArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:user-profile/.*" - }, - "UserProfileDetails":{ - "type":"structure", - "members":{ - "DomainId":{ - "shape":"DomainId", - "documentation":"

The domain ID.

" - }, - "UserProfileName":{ - "shape":"UserProfileName", - "documentation":"

The user profile name.

" - }, - "Status":{ - "shape":"UserProfileStatus", - "documentation":"

The status.

" - }, - "CreationTime":{ - "shape":"CreationTime", - "documentation":"

The creation time.

" - }, - "LastModifiedTime":{ - "shape":"LastModifiedTime", - "documentation":"

The last modified time.

" - } - }, - "documentation":"

The user profile details.

" - }, - "UserProfileList":{ - "type":"list", - "member":{"shape":"UserProfileDetails"} - }, - "UserProfileName":{ - "type":"string", - "max":63, - "min":0, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" - }, - "UserProfileSortKey":{ - "type":"string", - "enum":[ - "CreationTime", - "LastModifiedTime" - ] - }, - "UserProfileStatus":{ - "type":"string", - "enum":[ - "Deleting", - "Failed", - "InService", - "Pending", - "Updating", - "Update_Failed", - "Delete_Failed" - ] - }, - "UserSettings":{ - "type":"structure", - "members":{ - "ExecutionRole":{ - "shape":"RoleArn", - "documentation":"

The execution role for the user.

SageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn't apply this setting to shared spaces.

" - }, - "SecurityGroups":{ - "shape":"SecurityGroupIds", - "documentation":"

The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly.

Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly, unless specified as part of the DefaultUserSettings for the domain.

Amazon SageMaker AI adds a security group to allow NFS traffic from Amazon SageMaker AI Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.

SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

" - }, - "SharingSettings":{ - "shape":"SharingSettings", - "documentation":"

Specifies options for sharing Amazon SageMaker AI Studio notebooks.

" - }, - "JupyterServerAppSettings":{ - "shape":"JupyterServerAppSettings", - "documentation":"

The Jupyter server's app settings.

" - }, - "KernelGatewayAppSettings":{ - "shape":"KernelGatewayAppSettings", - "documentation":"

The kernel gateway app settings.

" - }, - "TensorBoardAppSettings":{ - "shape":"TensorBoardAppSettings", - "documentation":"

The TensorBoard app settings.

" - }, - "RStudioServerProAppSettings":{ - "shape":"RStudioServerProAppSettings", - "documentation":"

A collection of settings that configure user interaction with the RStudioServerPro app.

" - }, - "RSessionAppSettings":{ - "shape":"RSessionAppSettings", - "documentation":"

A collection of settings that configure the RSessionGateway app.

" - }, - "CanvasAppSettings":{ - "shape":"CanvasAppSettings", - "documentation":"

The Canvas app settings.

SageMaker applies these settings only to private spaces that SageMaker creates for the Canvas app.

" - }, - "CodeEditorAppSettings":{ - "shape":"CodeEditorAppSettings", - "documentation":"

The Code Editor application settings.

SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

" - }, - "JupyterLabAppSettings":{ - "shape":"JupyterLabAppSettings", - "documentation":"

The settings for the JupyterLab application.

SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

" - }, - "SpaceStorageSettings":{ - "shape":"DefaultSpaceStorageSettings", - "documentation":"

The storage settings for a space.

SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

" - }, - "DefaultLandingUri":{ - "shape":"LandingUri", - "documentation":"

The default experience that the user is directed to when accessing the domain. The supported values are:

  • studio::: Indicates that Studio is the default experience. This value can only be passed if StudioWebPortal is set to ENABLED.

  • app:JupyterServer:: Indicates that Studio Classic is the default experience.

" - }, - "StudioWebPortal":{ - "shape":"StudioWebPortal", - "documentation":"

Whether the user can access Studio. If this value is set to DISABLED, the user cannot access Studio, even if that is the default experience for the domain.

" - }, - "CustomPosixUserConfig":{ - "shape":"CustomPosixUserConfig", - "documentation":"

Details about the POSIX identity that is used for file system operations.

SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

" - }, - "CustomFileSystemConfigs":{ - "shape":"CustomFileSystemConfigs", - "documentation":"

The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker AI Studio.

SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

" - }, - "StudioWebPortalSettings":{ - "shape":"StudioWebPortalSettings", - "documentation":"

Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.

" - }, - "AutoMountHomeEFS":{ - "shape":"AutoMountHomeEFS", - "documentation":"

Indicates whether auto-mounting of an EFS volume is supported for the user profile. The DefaultAsDomain value is only supported for user profiles. Do not use the DefaultAsDomain value when setting this parameter for a domain.

SageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn't apply this setting to shared spaces.

" - } - }, - "documentation":"

A collection of settings that apply to users in a domain. These settings are specified when the CreateUserProfile API is called, and as DefaultUserSettings when the CreateDomain API is called.

SecurityGroups is aggregated when specified in both calls. For all other settings in UserSettings, the values specified in CreateUserProfile take precedence over those specified in CreateDomain.

" - }, - "UsersPerStep":{ - "type":"integer", - "box":true, - "max":3, - "min":1 - }, - "UtilizationMetric":{ - "type":"float", - "box":true, - "min":0.0 - }, - "UtilizationPercentagePerCore":{ - "type":"integer", - "box":true, - "max":100, - "min":1 - }, - "VCpuAmount":{ - "type":"float", - "box":true, - "max":10000000, - "min":0 - }, - "ValidationFraction":{ - "type":"float", - "box":true, - "max":1, - "min":0 - }, - "VariantInstanceProvisionTimeoutInSeconds":{ - "type":"integer", - "box":true, - "max":3600, - "min":300 - }, - "VariantName":{ - "type":"string", - "max":63, - "min":0, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" - }, - "VariantProperty":{ - "type":"structure", - "required":["VariantPropertyType"], - "members":{ - "VariantPropertyType":{ - "shape":"VariantPropertyType", - "documentation":"

The type of variant property. The supported values are:

  • DesiredInstanceCount: Overrides the existing variant instance counts using the InitialInstanceCount values in the ProductionVariants of CreateEndpointConfig.

  • DesiredWeight: Overrides the existing variant weights using the InitialVariantWeight values in the ProductionVariants of CreateEndpointConfig.

  • DataCaptureConfig: (Not currently supported.)

" - } - }, - "documentation":"

Specifies a production variant property type for an Endpoint.

If you are updating an endpoint with the RetainAllVariantProperties option of UpdateEndpointInput set to true, the VariantProperty objects listed in the ExcludeRetainedVariantProperties parameter of UpdateEndpointInput override the existing variant properties of the endpoint.

" - }, - "VariantPropertyList":{ - "type":"list", - "member":{"shape":"VariantProperty"}, - "max":3, - "min":0 - }, - "VariantPropertyType":{ - "type":"string", - "enum":[ - "DesiredInstanceCount", - "DesiredWeight", - "DataCaptureConfig" - ] - }, - "VariantStatus":{ - "type":"string", - "enum":[ - "Creating", - "Updating", - "Deleting", - "ActivatingTraffic", - "Baking" - ] - }, - "VariantStatusMessage":{ - "type":"string", - "max":1024, - "min":0 - }, - "VariantWeight":{ - "type":"float", - "box":true, - "min":0 - }, - "VectorConfig":{ - "type":"structure", - "required":["Dimension"], - "members":{ - "Dimension":{ - "shape":"Dimension", - "documentation":"

The number of elements in your vector.

" - } - }, - "documentation":"

Configuration for your vector collection type.

" - }, - "VendorGuidance":{ - "type":"string", - "enum":[ - "NOT_PROVIDED", - "STABLE", - "TO_BE_ARCHIVED", - "ARCHIVED" - ] - }, - "VersionAliasesList":{ - "type":"list", - "member":{"shape":"ImageVersionAliasPattern"}, - "max":20, - "min":0 - }, - "VersionId":{ - "type":"string", - "max":1024, - "min":1, - "pattern":".+" - }, - "VersionedArnOrName":{ - "type":"string", - "max":176, - "min":1, - "pattern":"(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:[a-z\\-]*\\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(?The Amazon Resource Name (ARN) of the lineage entity resource.

" - }, - "Type":{ - "shape":"String40", - "documentation":"

The type of the lineage entity resource. For example: DataSet, Model, Endpoint, etc...

" - }, - "LineageType":{ - "shape":"LineageType", - "documentation":"

The type of resource of the lineage entity.

" - } - }, - "documentation":"

A lineage entity connected to the starting entity(ies).

" - }, - "Vertices":{ - "type":"list", - "member":{"shape":"Vertex"} - }, - "VisibilityConditions":{ - "type":"structure", - "members":{ - "Key":{ - "shape":"VisibilityConditionsKey", - "documentation":"

The key that specifies the tag that you're using to filter the search results. It must be in the following format: Tags.<key>.

" - }, - "Value":{ - "shape":"VisibilityConditionsValue", - "documentation":"

The value for the tag that you're using to filter the search results.

" - } - }, - "documentation":"

The list of key-value pairs used to filter your search results. If a search result contains a key from your list, it is included in the final search response if the value associated with the key in the result matches the value you specified. If the value doesn't match, the result is excluded from the search response. Any resources that don't have a key from the list that you've provided will also be included in the search response.

" - }, - "VisibilityConditionsKey":{ - "type":"string", - "max":128, - "min":1, - "pattern":"([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)" - }, - "VisibilityConditionsList":{ - "type":"list", - "member":{"shape":"VisibilityConditions"}, - "max":5, - "min":1 - }, - "VisibilityConditionsValue":{ - "type":"string", - "max":256, - "min":0, - "pattern":"([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)" - }, - "VolumeAttachmentStatus":{ - "type":"string", - "enum":[ - "attaching", - "attached", - "detaching", - "detached", - "busy" - ] - }, - "VolumeDeviceName":{ - "type":"string", - "max":32, - "min":1, - "pattern":"/dev/(xvd[a-z]|sd[b-z]|sd[f-p][1-6])" - }, - "VolumeId":{ - "type":"string", - "max":256, - "min":1, - "pattern":"vol-[a-f0-9]{8}(?:[a-f0-9]{9})?" - }, - "VolumeSizeInGB":{ - "type":"integer", - "min":1 - }, - "VpcConfig":{ - "type":"structure", - "required":[ - "SecurityGroupIds", - "Subnets" - ], - "members":{ - "SecurityGroupIds":{ - "shape":"VpcSecurityGroupIds", - "documentation":"

The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.

" - }, - "Subnets":{ - "shape":"Subnets", - "documentation":"

The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.

" - } - }, - "documentation":"

Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC.

" - }, - "VpcId":{ - "type":"string", - "max":32, - "min":0, - "pattern":"[-0-9a-zA-Z]+" - }, - "VpcOnlyTrustedAccounts":{ - "type":"list", - "member":{"shape":"AccountId"}, - "max":20, - "min":0 - }, - "VpcSecurityGroupIds":{ - "type":"list", - "member":{"shape":"SecurityGroupId"}, - "max":5, - "min":1 - }, - "WaitIntervalInSeconds":{ - "type":"integer", - "box":true, - "max":3600, - "min":0 - }, - "WaitTimeIntervalInSeconds":{ - "type":"integer", - "box":true, - "max":3600, - "min":0 - }, - "WarmPoolResourceStatus":{ - "type":"string", - "enum":[ - "Available", - "Terminated", - "Reused", - "InUse" - ] - }, - "WarmPoolStatus":{ - "type":"structure", - "required":["Status"], - "members":{ - "Status":{ - "shape":"WarmPoolResourceStatus", - "documentation":"

The status of the warm pool.

  • InUse: The warm pool is in use for the training job.

  • Available: The warm pool is available to reuse for a matching training job.

  • Reused: The warm pool moved to a matching training job for reuse.

  • Terminated: The warm pool is no longer available. Warm pools are unavailable if they are terminated by a user, terminated for a patch update, or terminated for exceeding the specified KeepAlivePeriodInSeconds.

" - }, - "ResourceRetainedBillableTimeInSeconds":{ - "shape":"ResourceRetainedBillableTimeInSeconds", - "documentation":"

The billable time in seconds used by the warm pool. Billable time refers to the absolute wall-clock time.

Multiply ResourceRetainedBillableTimeInSeconds by the number of instances (InstanceCount) in your training cluster to get the total compute time SageMaker bills you if you run warm pool training. The formula is as follows: ResourceRetainedBillableTimeInSeconds * InstanceCount.

" - }, - "ReusedByJob":{ - "shape":"TrainingJobName", - "documentation":"

The name of the matching training job that reused the warm pool.

" - } - }, - "documentation":"

Status and billing information about the warm pool.

" - }, - "WeeklyMaintenanceWindowStart":{ - "type":"string", - "max":9, - "min":0, - "pattern":"(Mon|Tue|Wed|Thu|Fri|Sat|Sun):([01]\\d|2[0-3]):([0-5]\\d)" - }, - "WeeklyScheduleTimeFormat":{ - "type":"string", - "max":9, - "min":0, - "pattern":"(Mon|Tue|Wed|Thu|Fri|Sat|Sun):([01]\\d|2[0-3]):([0-5]\\d)" - }, - "WorkerAccessConfiguration":{ - "type":"structure", - "members":{ - "S3Presign":{ - "shape":"S3Presign", - "documentation":"

Defines any Amazon S3 resource constraints.

" - } - }, - "documentation":"

Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL.

" - }, - "Workforce":{ - "type":"structure", - "required":[ - "WorkforceName", - "WorkforceArn" - ], - "members":{ - "WorkforceName":{ - "shape":"WorkforceName", - "documentation":"

The name of the private workforce.

" - }, - "WorkforceArn":{ - "shape":"WorkforceArn", - "documentation":"

The Amazon Resource Name (ARN) of the private workforce.

" - }, - "LastUpdatedDate":{ - "shape":"Timestamp", - "documentation":"

The most recent date that UpdateWorkforce was used to successfully add one or more IP address ranges (CIDRs) to a private workforce's allow list.

" - }, - "SourceIpConfig":{ - "shape":"SourceIpConfig", - "documentation":"

A list of one to ten IP address ranges (CIDRs) to be added to the workforce allow list. By default, a workforce isn't restricted to specific IP addresses.

" - }, - "SubDomain":{ - "shape":"String", - "documentation":"

The subdomain for your OIDC Identity Provider.

" - }, - "CognitoConfig":{ - "shape":"CognitoConfig", - "documentation":"

The configuration of an Amazon Cognito workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.

" - }, - "OidcConfig":{ - "shape":"OidcConfigForResponse", - "documentation":"

The configuration of an OIDC Identity Provider (IdP) private workforce.

" - }, - "CreateDate":{ - "shape":"Timestamp", - "documentation":"

The date that the workforce is created.

" - }, - "WorkforceVpcConfig":{ - "shape":"WorkforceVpcConfigResponse", - "documentation":"

The configuration of a VPC workforce.

" - }, - "Status":{ - "shape":"WorkforceStatus", - "documentation":"

The status of your workforce.

" - }, - "FailureReason":{ - "shape":"WorkforceFailureReason", - "documentation":"

The reason your workforce failed.

" - }, - "IpAddressType":{ - "shape":"WorkforceIpAddressType", - "documentation":"

The IP address type you specify - either IPv4 only or dualstack (IPv4 and IPv6) - to support your labeling workforce.

" - } - }, - "documentation":"

A single private workforce, which is automatically created when you create your first private work team. You can create one private work force in each Amazon Web Services Region. By default, any workforce-related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

" - }, - "WorkforceArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:workforce/.*" - }, - "WorkforceFailureReason":{ - "type":"string", - "max":1024, - "min":1, - "pattern":".+" - }, - "WorkforceIpAddressType":{ - "type":"string", - "enum":[ - "ipv4", - "dualstack" - ] - }, - "WorkforceName":{ - "type":"string", - "max":63, - "min":1, - "pattern":"[a-zA-Z0-9]([a-zA-Z0-9\\-]){0,62}" - }, - "WorkforceSecurityGroupId":{ - "type":"string", - "max":32, - "min":0, - "pattern":"sg-[0-9a-z]*" - }, - "WorkforceSecurityGroupIds":{ - "type":"list", - "member":{"shape":"WorkforceSecurityGroupId"}, - "max":5, - "min":1 - }, - "WorkforceStatus":{ - "type":"string", - "enum":[ - "Initializing", - "Updating", - "Deleting", - "Failed", - "Active" - ] - }, - "WorkforceSubnetId":{ - "type":"string", - "max":32, - "min":0, - "pattern":"subnet-[0-9a-z]*" - }, - "WorkforceSubnets":{ - "type":"list", - "member":{"shape":"WorkforceSubnetId"}, - "max":16, - "min":1 - }, - "WorkforceVpcConfigRequest":{ - "type":"structure", - "members":{ - "VpcId":{ - "shape":"WorkforceVpcId", - "documentation":"

The ID of the VPC that the workforce uses for communication.

" - }, - "SecurityGroupIds":{ - "shape":"WorkforceSecurityGroupIds", - "documentation":"

The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.

" - }, - "Subnets":{ - "shape":"WorkforceSubnets", - "documentation":"

The ID of the subnets in the VPC that you want to connect.

" - } - }, - "documentation":"

The VPC object you use to create or update a workforce.

" - }, - "WorkforceVpcConfigResponse":{ - "type":"structure", - "required":[ - "VpcId", - "SecurityGroupIds", - "Subnets" - ], - "members":{ - "VpcId":{ - "shape":"WorkforceVpcId", - "documentation":"

The ID of the VPC that the workforce uses for communication.

" - }, - "SecurityGroupIds":{ - "shape":"WorkforceSecurityGroupIds", - "documentation":"

The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.

" - }, - "Subnets":{ - "shape":"WorkforceSubnets", - "documentation":"

The ID of the subnets in the VPC that you want to connect.

" - }, - "VpcEndpointId":{ - "shape":"WorkforceVpcEndpointId", - "documentation":"

The IDs for the VPC service endpoints of your VPC workforce when it is created and updated.

" - } - }, - "documentation":"

A VpcConfig object that specifies the VPC that you want your workforce to connect to.

" - }, - "WorkforceVpcEndpointId":{ - "type":"string", - "max":255, - "min":1, - "pattern":"vpce-[0-9a-z]*" - }, - "WorkforceVpcId":{ - "type":"string", - "max":32, - "min":0, - "pattern":"vpc-[0-9a-z]*" - }, - "Workforces":{ - "type":"list", - "member":{"shape":"Workforce"} - }, - "WorkloadSpec":{ - "type":"structure", - "members":{ - "Inline":{ - "shape":"String", - "documentation":"

An inline YAML or JSON string that defines benchmark parameters.

" - } - }, - "documentation":"

The workload specification for benchmark tool configuration. Provide an inline YAML or JSON string.

", - "union":true - }, - "WorkspaceSettings":{ - "type":"structure", - "members":{ - "S3ArtifactPath":{ - "shape":"S3Uri", - "documentation":"

The Amazon S3 bucket used to store artifacts generated by Canvas. Updating the Amazon S3 location impacts existing configuration settings, and Canvas users no longer have access to their artifacts. Canvas users must log out and log back in to apply the new location.

" - }, - "S3KmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The Amazon Web Services Key Management Service (KMS) encryption key ID that is used to encrypt artifacts generated by Canvas in the Amazon S3 bucket.

" - } - }, - "documentation":"

The workspace settings for the SageMaker Canvas application.

" - }, - "Workteam":{ - "type":"structure", - "required":[ - "WorkteamName", - "MemberDefinitions", - "WorkteamArn", - "Description" - ], - "members":{ - "WorkteamName":{ - "shape":"WorkteamName", - "documentation":"

The name of the work team.

" - }, - "MemberDefinitions":{ - "shape":"MemberDefinitions", - "documentation":"

A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.

Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use CognitoMemberDefinition. For workforces created using your own OIDC identity provider (IdP) use OidcMemberDefinition.

" - }, - "WorkteamArn":{ - "shape":"WorkteamArn", - "documentation":"

The Amazon Resource Name (ARN) that identifies the work team.

" - }, - "WorkforceArn":{ - "shape":"WorkforceArn", - "documentation":"

The Amazon Resource Name (ARN) of the workforce.

" - }, - "ProductListingIds":{ - "shape":"ProductListings", - "documentation":"

The Amazon Marketplace identifier for a vendor's work team.

" - }, - "Description":{ - "shape":"String200", - "documentation":"

A description of the work team.

" - }, - "SubDomain":{ - "shape":"String", - "documentation":"

The URI of the labeling job's user interface. Workers open this URI to start labeling your data objects.

" - }, - "CreateDate":{ - "shape":"Timestamp", - "documentation":"

The date and time that the work team was created (timestamp).

" - }, - "LastUpdatedDate":{ - "shape":"Timestamp", - "documentation":"

The date and time that the work team was last updated (timestamp).

" - }, - "NotificationConfiguration":{ - "shape":"NotificationConfiguration", - "documentation":"

Configures SNS notifications of available or expiring work items for work teams.

" - }, - "WorkerAccessConfiguration":{ - "shape":"WorkerAccessConfiguration", - "documentation":"

Describes any access constraints that have been defined for Amazon S3 resources.

" - } - }, - "documentation":"

Provides details about a labeling work team.

" - }, - "WorkteamArn":{ - "type":"string", - "max":256, - "min":0, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:workteam/.*" - }, - "WorkteamName":{ - "type":"string", - "max":63, - "min":1, - "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" - }, - "Workteams":{ - "type":"list", - "member":{"shape":"Workteam"} - } - }, - "documentation":"

Provides APIs for creating and managing SageMaker resources.

Other Resources:

" -} diff --git a/tools/code-generation/api-descriptions/sagemaker/2017-07-24/waiters-2.json b/tools/code-generation/api-descriptions/sagemaker/2017-07-24/waiters-2.json deleted file mode 100644 index d01aa3fe062e..000000000000 --- a/tools/code-generation/api-descriptions/sagemaker/2017-07-24/waiters-2.json +++ /dev/null @@ -1,260 +0,0 @@ -{ - "version" : 2, - "waiters" : { - "EndpointDeleted" : { - "delay" : 30, - "maxAttempts" : 60, - "operation" : "DescribeEndpoint", - "acceptors" : [ { - "matcher" : "error", - "state" : "success", - "expected" : "ValidationException" - }, { - "matcher" : "path", - "argument" : "EndpointStatus", - "state" : "failure", - "expected" : "Failed" - } ] - }, - "EndpointInService" : { - "delay" : 30, - "maxAttempts" : 120, - "operation" : "DescribeEndpoint", - "acceptors" : [ { - "matcher" : "path", - "argument" : "EndpointStatus", - "state" : "success", - "expected" : "InService" - }, { - "matcher" : "path", - "argument" : "EndpointStatus", - "state" : "failure", - "expected" : "Failed" - }, { - "matcher" : "error", - "state" : "failure", - "expected" : "ValidationException" - } ] - }, - "ImageCreated" : { - "delay" : 60, - "maxAttempts" : 60, - "operation" : "DescribeImage", - "acceptors" : [ { - "matcher" : "path", - "argument" : "ImageStatus", - "state" : "success", - "expected" : "CREATED" - }, { - "matcher" : "path", - "argument" : "ImageStatus", - "state" : "failure", - "expected" : "CREATE_FAILED" - }, { - "matcher" : "error", - "state" : "failure", - "expected" : "ValidationException" - } ] - }, - "ImageDeleted" : { - "delay" : 60, - "maxAttempts" : 60, - "operation" : "DescribeImage", - "acceptors" : [ { - "matcher" : "error", - "state" : "success", - "expected" : "ResourceNotFoundException" - }, { - "matcher" : "path", - "argument" : "ImageStatus", - "state" : "failure", - "expected" : "DELETE_FAILED" - }, { - "matcher" : "error", - "state" : "failure", - "expected" : "ValidationException" - } ] - }, - "ImageUpdated" : { - "delay" : 60, - "maxAttempts" : 60, - "operation" : "DescribeImage", - "acceptors" : [ { - "matcher" : "path", - "argument" : "ImageStatus", - "state" : "success", - "expected" : "CREATED" - }, { - "matcher" : "path", - "argument" : "ImageStatus", - "state" : "failure", - "expected" : "UPDATE_FAILED" - }, { - "matcher" : "error", - "state" : "failure", - "expected" : "ValidationException" - } ] - }, - "ImageVersionCreated" : { - "delay" : 60, - "maxAttempts" : 60, - "operation" : "DescribeImageVersion", - "acceptors" : [ { - "matcher" : "path", - "argument" : "ImageVersionStatus", - "state" : "success", - "expected" : "CREATED" - }, { - "matcher" : "path", - "argument" : "ImageVersionStatus", - "state" : "failure", - "expected" : "CREATE_FAILED" - }, { - "matcher" : "error", - "state" : "failure", - "expected" : "ValidationException" - } ] - }, - "ImageVersionDeleted" : { - "delay" : 60, - "maxAttempts" : 60, - "operation" : "DescribeImageVersion", - "acceptors" : [ { - "matcher" : "error", - "state" : "success", - "expected" : "ResourceNotFoundException" - }, { - "matcher" : "path", - "argument" : "ImageVersionStatus", - "state" : "failure", - "expected" : "DELETE_FAILED" - }, { - "matcher" : "error", - "state" : "failure", - "expected" : "ValidationException" - } ] - }, - "NotebookInstanceDeleted" : { - "delay" : 30, - "maxAttempts" : 60, - "operation" : "DescribeNotebookInstance", - "acceptors" : [ { - "matcher" : "error", - "state" : "success", - "expected" : "ValidationException" - }, { - "matcher" : "path", - "argument" : "NotebookInstanceStatus", - "state" : "failure", - "expected" : "Failed" - } ] - }, - "NotebookInstanceInService" : { - "delay" : 30, - "maxAttempts" : 60, - "operation" : "DescribeNotebookInstance", - "acceptors" : [ { - "matcher" : "path", - "argument" : "NotebookInstanceStatus", - "state" : "success", - "expected" : "InService" - }, { - "matcher" : "path", - "argument" : "NotebookInstanceStatus", - "state" : "failure", - "expected" : "Failed" - } ] - }, - "NotebookInstanceStopped" : { - "delay" : 30, - "maxAttempts" : 60, - "operation" : "DescribeNotebookInstance", - "acceptors" : [ { - "matcher" : "path", - "argument" : "NotebookInstanceStatus", - "state" : "success", - "expected" : "Stopped" - }, { - "matcher" : "path", - "argument" : "NotebookInstanceStatus", - "state" : "failure", - "expected" : "Failed" - } ] - }, - "ProcessingJobCompletedOrStopped" : { - "delay" : 60, - "maxAttempts" : 60, - "operation" : "DescribeProcessingJob", - "acceptors" : [ { - "matcher" : "path", - "argument" : "ProcessingJobStatus", - "state" : "success", - "expected" : "Completed" - }, { - "matcher" : "path", - "argument" : "ProcessingJobStatus", - "state" : "success", - "expected" : "Stopped" - }, { - "matcher" : "path", - "argument" : "ProcessingJobStatus", - "state" : "failure", - "expected" : "Failed" - }, { - "matcher" : "error", - "state" : "failure", - "expected" : "ValidationException" - } ] - }, - "TrainingJobCompletedOrStopped" : { - "delay" : 120, - "maxAttempts" : 180, - "operation" : "DescribeTrainingJob", - "acceptors" : [ { - "matcher" : "path", - "argument" : "TrainingJobStatus", - "state" : "success", - "expected" : "Completed" - }, { - "matcher" : "path", - "argument" : "TrainingJobStatus", - "state" : "success", - "expected" : "Stopped" - }, { - "matcher" : "path", - "argument" : "TrainingJobStatus", - "state" : "failure", - "expected" : "Failed" - }, { - "matcher" : "error", - "state" : "failure", - "expected" : "ValidationException" - } ] - }, - "TransformJobCompletedOrStopped" : { - "delay" : 60, - "maxAttempts" : 60, - "operation" : "DescribeTransformJob", - "acceptors" : [ { - "matcher" : "path", - "argument" : "TransformJobStatus", - "state" : "success", - "expected" : "Completed" - }, { - "matcher" : "path", - "argument" : "TransformJobStatus", - "state" : "success", - "expected" : "Stopped" - }, { - "matcher" : "path", - "argument" : "TransformJobStatus", - "state" : "failure", - "expected" : "Failed" - }, { - "matcher" : "error", - "state" : "failure", - "expected" : "ValidationException" - } ] - } - } -} \ No newline at end of file diff --git a/tools/code-generation/api-descriptions/securityagent-2025-09-06.normal.json b/tools/code-generation/api-descriptions/securityagent-2025-09-06.normal.json index fc3ff69c5118..f15fc17b0a5d 100644 --- a/tools/code-generation/api-descriptions/securityagent-2025-09-06.normal.json +++ b/tools/code-generation/api-descriptions/securityagent-2025-09-06.normal.json @@ -5282,6 +5282,10 @@ "providerResourceId":{ "shape":"String", "documentation":"

The provider-specific resource identifier for the repository.

" + }, + "branch":{ + "shape":"String", + "documentation":"

An optional override for the repository branch.

" } }, "documentation":"

Represents a code repository that is integrated with the service through a third-party provider.

" diff --git a/tools/code-generation/api-descriptions/securityagent/2025-09-06/api-2.json b/tools/code-generation/api-descriptions/securityagent/2025-09-06/api-2.json deleted file mode 100644 index f9e1b4535f5b..000000000000 --- a/tools/code-generation/api-descriptions/securityagent/2025-09-06/api-2.json +++ /dev/null @@ -1,5456 +0,0 @@ -{ - "version":"2.0", - "metadata":{ - "apiVersion":"2025-09-06", - "auth":["aws.auth#sigv4"], - "endpointPrefix":"securityagent", - "protocol":"rest-json", - "protocols":["rest-json"], - "serviceFullName":"AWS Security Agent", - "serviceId":"SecurityAgent", - "signatureVersion":"v4", - "signingName":"securityagent", - "uid":"securityagent-2025-09-06" - }, - "operations":{ - "AddArtifact":{ - "name":"AddArtifact", - "http":{ - "method":"POST", - "requestUri":"/AddArtifact", - "responseCode":201 - }, - "input":{"shape":"AddArtifactInput"}, - "output":{"shape":"AddArtifactOutput"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ] - }, - "BatchCreateSecurityRequirements":{ - "name":"BatchCreateSecurityRequirements", - "http":{ - "method":"POST", - "requestUri":"/BatchCreateSecurityRequirements", - "responseCode":201 - }, - "input":{"shape":"BatchCreateSecurityRequirementsInput"}, - "output":{"shape":"BatchCreateSecurityRequirementsOutput"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ServiceQuotaExceededException"} - ] - }, - "BatchDeleteCodeReviews":{ - "name":"BatchDeleteCodeReviews", - "http":{ - "method":"POST", - "requestUri":"/BatchDeleteCodeReviews", - "responseCode":200 - }, - "input":{"shape":"BatchDeleteCodeReviewsInput"}, - "output":{"shape":"BatchDeleteCodeReviewsOutput"} - }, - "BatchDeletePentests":{ - "name":"BatchDeletePentests", - "http":{ - "method":"POST", - "requestUri":"/BatchDeletePentests", - "responseCode":200 - }, - "input":{"shape":"BatchDeletePentestsInput"}, - "output":{"shape":"BatchDeletePentestsOutput"} - }, - "BatchDeleteSecurityRequirements":{ - "name":"BatchDeleteSecurityRequirements", - "http":{ - "method":"POST", - "requestUri":"/BatchDeleteSecurityRequirements", - "responseCode":200 - }, - "input":{"shape":"BatchDeleteSecurityRequirementsInput"}, - "output":{"shape":"BatchDeleteSecurityRequirementsOutput"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ] - }, - "BatchDeleteThreatModels":{ - "name":"BatchDeleteThreatModels", - "http":{ - "method":"POST", - "requestUri":"/BatchDeleteThreatModels", - "responseCode":200 - }, - "input":{"shape":"BatchDeleteThreatModelsInput"}, - "output":{"shape":"BatchDeleteThreatModelsOutput"} - }, - "BatchGetAgentSpaces":{ - "name":"BatchGetAgentSpaces", - "http":{ - "method":"POST", - "requestUri":"/BatchGetAgentSpaces", - "responseCode":200 - }, - "input":{"shape":"BatchGetAgentSpacesInput"}, - "output":{"shape":"BatchGetAgentSpacesOutput"}, - "readonly":true - }, - "BatchGetArtifactMetadata":{ - "name":"BatchGetArtifactMetadata", - "http":{ - "method":"POST", - "requestUri":"/BatchGetArtifactMetadata", - "responseCode":200 - }, - "input":{"shape":"BatchGetArtifactMetadataInput"}, - "output":{"shape":"BatchGetArtifactMetadataOutput"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ] - }, - "BatchGetCodeReviewJobTasks":{ - "name":"BatchGetCodeReviewJobTasks", - "http":{ - "method":"POST", - "requestUri":"/BatchGetCodeReviewJobTasks", - "responseCode":200 - }, - "input":{"shape":"BatchGetCodeReviewJobTasksInput"}, - "output":{"shape":"BatchGetCodeReviewJobTasksOutput"} - }, - "BatchGetCodeReviewJobs":{ - "name":"BatchGetCodeReviewJobs", - "http":{ - "method":"POST", - "requestUri":"/BatchGetCodeReviewJobs", - "responseCode":200 - }, - "input":{"shape":"BatchGetCodeReviewJobsInput"}, - "output":{"shape":"BatchGetCodeReviewJobsOutput"} - }, - "BatchGetCodeReviews":{ - "name":"BatchGetCodeReviews", - "http":{ - "method":"POST", - "requestUri":"/BatchGetCodeReviews", - "responseCode":200 - }, - "input":{"shape":"BatchGetCodeReviewsInput"}, - "output":{"shape":"BatchGetCodeReviewsOutput"} - }, - "BatchGetFindings":{ - "name":"BatchGetFindings", - "http":{ - "method":"POST", - "requestUri":"/BatchGetFindings", - "responseCode":200 - }, - "input":{"shape":"BatchGetFindingsInput"}, - "output":{"shape":"BatchGetFindingsOutput"} - }, - "BatchGetPentestJobTasks":{ - "name":"BatchGetPentestJobTasks", - "http":{ - "method":"POST", - "requestUri":"/BatchGetPentestJobTasks", - "responseCode":200 - }, - "input":{"shape":"BatchGetPentestJobTasksInput"}, - "output":{"shape":"BatchGetPentestJobTasksOutput"} - }, - "BatchGetPentestJobs":{ - "name":"BatchGetPentestJobs", - "http":{ - "method":"POST", - "requestUri":"/BatchGetPentestJobs", - "responseCode":200 - }, - "input":{"shape":"BatchGetPentestJobsInput"}, - "output":{"shape":"BatchGetPentestJobsOutput"} - }, - "BatchGetPentests":{ - "name":"BatchGetPentests", - "http":{ - "method":"POST", - "requestUri":"/BatchGetPentests", - "responseCode":200 - }, - "input":{"shape":"BatchGetPentestsInput"}, - "output":{"shape":"BatchGetPentestsOutput"} - }, - "BatchGetSecurityRequirements":{ - "name":"BatchGetSecurityRequirements", - "http":{ - "method":"POST", - "requestUri":"/BatchGetSecurityRequirements", - "responseCode":200 - }, - "input":{"shape":"BatchGetSecurityRequirementsInput"}, - "output":{"shape":"BatchGetSecurityRequirementsOutput"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ], - "readonly":true - }, - "BatchGetTargetDomains":{ - "name":"BatchGetTargetDomains", - "http":{ - "method":"POST", - "requestUri":"/BatchGetTargetDomains", - "responseCode":200 - }, - "input":{"shape":"BatchGetTargetDomainsInput"}, - "output":{"shape":"BatchGetTargetDomainsOutput"}, - "readonly":true - }, - "BatchGetThreatModelJobTasks":{ - "name":"BatchGetThreatModelJobTasks", - "http":{ - "method":"POST", - "requestUri":"/BatchGetThreatModelJobTasks", - "responseCode":200 - }, - "input":{"shape":"BatchGetThreatModelJobTasksInput"}, - "output":{"shape":"BatchGetThreatModelJobTasksOutput"}, - "readonly":true - }, - "BatchGetThreatModelJobs":{ - "name":"BatchGetThreatModelJobs", - "http":{ - "method":"POST", - "requestUri":"/BatchGetThreatModelJobs", - "responseCode":200 - }, - "input":{"shape":"BatchGetThreatModelJobsInput"}, - "output":{"shape":"BatchGetThreatModelJobsOutput"} - }, - "BatchGetThreatModels":{ - "name":"BatchGetThreatModels", - "http":{ - "method":"POST", - "requestUri":"/BatchGetThreatModels", - "responseCode":200 - }, - "input":{"shape":"BatchGetThreatModelsInput"}, - "output":{"shape":"BatchGetThreatModelsOutput"} - }, - "BatchGetThreats":{ - "name":"BatchGetThreats", - "http":{ - "method":"POST", - "requestUri":"/BatchGetThreats", - "responseCode":200 - }, - "input":{"shape":"BatchGetThreatsInput"}, - "output":{"shape":"BatchGetThreatsOutput"} - }, - "BatchUpdateSecurityRequirements":{ - "name":"BatchUpdateSecurityRequirements", - "http":{ - "method":"POST", - "requestUri":"/BatchUpdateSecurityRequirements", - "responseCode":200 - }, - "input":{"shape":"BatchUpdateSecurityRequirementsInput"}, - "output":{"shape":"BatchUpdateSecurityRequirementsOutput"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ] - }, - "CreateAgentSpace":{ - "name":"CreateAgentSpace", - "http":{ - "method":"POST", - "requestUri":"/CreateAgentSpace", - "responseCode":200 - }, - "input":{"shape":"CreateAgentSpaceInput"}, - "output":{"shape":"CreateAgentSpaceOutput"} - }, - "CreateApplication":{ - "name":"CreateApplication", - "http":{ - "method":"POST", - "requestUri":"/CreateApplication", - "responseCode":200 - }, - "input":{"shape":"CreateApplicationRequest"}, - "output":{"shape":"CreateApplicationResponse"} - }, - "CreateCodeReview":{ - "name":"CreateCodeReview", - "http":{ - "method":"POST", - "requestUri":"/CreateCodeReview", - "responseCode":200 - }, - "input":{"shape":"CreateCodeReviewInput"}, - "output":{"shape":"CreateCodeReviewOutput"} - }, - "CreateIntegration":{ - "name":"CreateIntegration", - "http":{ - "method":"POST", - "requestUri":"/CreateIntegration", - "responseCode":201 - }, - "input":{"shape":"CreateIntegrationInput"}, - "output":{"shape":"CreateIntegrationOutput"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ] - }, - "CreateMembership":{ - "name":"CreateMembership", - "http":{ - "method":"POST", - "requestUri":"/CreateMembership", - "responseCode":200 - }, - "input":{"shape":"CreateMembershipRequest"}, - "output":{"shape":"CreateMembershipResponse"} - }, - "CreatePentest":{ - "name":"CreatePentest", - "http":{ - "method":"POST", - "requestUri":"/CreatePentest", - "responseCode":200 - }, - "input":{"shape":"CreatePentestInput"}, - "output":{"shape":"CreatePentestOutput"} - }, - "CreatePrivateConnection":{ - "name":"CreatePrivateConnection", - "http":{ - "method":"POST", - "requestUri":"/CreatePrivateConnection", - "responseCode":201 - }, - "input":{"shape":"CreatePrivateConnectionInput"}, - "output":{"shape":"CreatePrivateConnectionOutput"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ] - }, - "CreateSecurityRequirementPack":{ - "name":"CreateSecurityRequirementPack", - "http":{ - "method":"POST", - "requestUri":"/CreateSecurityRequirementPack", - "responseCode":201 - }, - "input":{"shape":"CreateSecurityRequirementPackInput"}, - "output":{"shape":"CreateSecurityRequirementPackOutput"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ServiceQuotaExceededException"} - ] - }, - "CreateTargetDomain":{ - "name":"CreateTargetDomain", - "http":{ - "method":"POST", - "requestUri":"/CreateTargetDomain", - "responseCode":200 - }, - "input":{"shape":"CreateTargetDomainInput"}, - "output":{"shape":"CreateTargetDomainOutput"} - }, - "CreateThreat":{ - "name":"CreateThreat", - "http":{ - "method":"POST", - "requestUri":"/CreateThreat", - "responseCode":200 - }, - "input":{"shape":"CreateThreatInput"}, - "output":{"shape":"CreateThreatOutput"} - }, - "CreateThreatModel":{ - "name":"CreateThreatModel", - "http":{ - "method":"POST", - "requestUri":"/CreateThreatModel", - "responseCode":200 - }, - "input":{"shape":"CreateThreatModelInput"}, - "output":{"shape":"CreateThreatModelOutput"} - }, - "DeleteAgentSpace":{ - "name":"DeleteAgentSpace", - "http":{ - "method":"POST", - "requestUri":"/DeleteAgentSpace", - "responseCode":200 - }, - "input":{"shape":"DeleteAgentSpaceInput"}, - "output":{"shape":"DeleteAgentSpaceOutput"}, - "idempotent":true - }, - "DeleteApplication":{ - "name":"DeleteApplication", - "http":{ - "method":"POST", - "requestUri":"/DeleteApplication", - "responseCode":200 - }, - "input":{"shape":"DeleteApplicationRequest"}, - "idempotent":true - }, - "DeleteArtifact":{ - "name":"DeleteArtifact", - "http":{ - "method":"POST", - "requestUri":"/DeleteArtifact", - "responseCode":200 - }, - "input":{"shape":"DeleteArtifactInput"}, - "output":{"shape":"DeleteArtifactOutput"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ] - }, - "DeleteIntegration":{ - "name":"DeleteIntegration", - "http":{ - "method":"POST", - "requestUri":"/DeleteIntegration", - "responseCode":200 - }, - "input":{"shape":"DeleteIntegrationInput"}, - "output":{"shape":"DeleteIntegrationOutput"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ], - "idempotent":true - }, - "DeleteMembership":{ - "name":"DeleteMembership", - "http":{ - "method":"POST", - "requestUri":"/DeleteMembership", - "responseCode":200 - }, - "input":{"shape":"DeleteMembershipRequest"}, - "output":{"shape":"DeleteMembershipResponse"} - }, - "DeletePrivateConnection":{ - "name":"DeletePrivateConnection", - "http":{ - "method":"POST", - "requestUri":"/DeletePrivateConnection", - "responseCode":200 - }, - "input":{"shape":"DeletePrivateConnectionInput"}, - "output":{"shape":"DeletePrivateConnectionOutput"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ], - "idempotent":true - }, - "DeleteSecurityRequirementPack":{ - "name":"DeleteSecurityRequirementPack", - "http":{ - "method":"POST", - "requestUri":"/DeleteSecurityRequirementPack", - "responseCode":200 - }, - "input":{"shape":"DeleteSecurityRequirementPackInput"}, - "output":{"shape":"DeleteSecurityRequirementPackOutput"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ], - "idempotent":true - }, - "DeleteTargetDomain":{ - "name":"DeleteTargetDomain", - "http":{ - "method":"POST", - "requestUri":"/DeleteTargetDomain", - "responseCode":200 - }, - "input":{"shape":"DeleteTargetDomainInput"}, - "output":{"shape":"DeleteTargetDomainOutput"}, - "idempotent":true - }, - "DescribePrivateConnection":{ - "name":"DescribePrivateConnection", - "http":{ - "method":"POST", - "requestUri":"/DescribePrivateConnection", - "responseCode":200 - }, - "input":{"shape":"DescribePrivateConnectionInput"}, - "output":{"shape":"DescribePrivateConnectionOutput"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ], - "readonly":true - }, - "GetApplication":{ - "name":"GetApplication", - "http":{ - "method":"POST", - "requestUri":"/GetApplication", - "responseCode":200 - }, - "input":{"shape":"GetApplicationRequest"}, - "output":{"shape":"GetApplicationResponse"}, - "readonly":true - }, - "GetArtifact":{ - "name":"GetArtifact", - "http":{ - "method":"POST", - "requestUri":"/GetArtifact", - "responseCode":200 - }, - "input":{"shape":"GetArtifactInput"}, - "output":{"shape":"GetArtifactOutput"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ] - }, - "GetIntegration":{ - "name":"GetIntegration", - "http":{ - "method":"POST", - "requestUri":"/GetIntegration", - "responseCode":200 - }, - "input":{"shape":"GetIntegrationInput"}, - "output":{"shape":"GetIntegrationOutput"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ], - "readonly":true - }, - "GetSecurityRequirementPack":{ - "name":"GetSecurityRequirementPack", - "http":{ - "method":"POST", - "requestUri":"/GetSecurityRequirementPack", - "responseCode":200 - }, - "input":{"shape":"GetSecurityRequirementPackInput"}, - "output":{"shape":"GetSecurityRequirementPackOutput"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ], - "readonly":true - }, - "ImportSecurityRequirements":{ - "name":"ImportSecurityRequirements", - "http":{ - "method":"POST", - "requestUri":"/ImportSecurityRequirements", - "responseCode":201 - }, - "input":{"shape":"ImportSecurityRequirementsInput"}, - "output":{"shape":"ImportSecurityRequirementsOutput"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ServiceQuotaExceededException"} - ] - }, - "InitiateProviderRegistration":{ - "name":"InitiateProviderRegistration", - "http":{ - "method":"POST", - "requestUri":"/oauth2/provider/register", - "responseCode":200 - }, - "input":{"shape":"InitiateProviderRegistrationInput"}, - "output":{"shape":"InitiateProviderRegistrationOutput"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ] - }, - "ListAgentSpaces":{ - "name":"ListAgentSpaces", - "http":{ - "method":"POST", - "requestUri":"/ListAgentSpaces", - "responseCode":200 - }, - "input":{"shape":"ListAgentSpacesInput"}, - "output":{"shape":"ListAgentSpacesOutput"}, - "readonly":true - }, - "ListApplications":{ - "name":"ListApplications", - "http":{ - "method":"POST", - "requestUri":"/ListApplications", - "responseCode":200 - }, - "input":{"shape":"ListApplicationsRequest"}, - "output":{"shape":"ListApplicationsResponse"}, - "readonly":true - }, - "ListArtifacts":{ - "name":"ListArtifacts", - "http":{ - "method":"POST", - "requestUri":"/ListArtifacts", - "responseCode":200 - }, - "input":{"shape":"ListArtifactsInput"}, - "output":{"shape":"ListArtifactsOutput"}, - "errors":[ - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ], - "readonly":true - }, - "ListCodeReviewJobTasks":{ - "name":"ListCodeReviewJobTasks", - "http":{ - "method":"POST", - "requestUri":"/ListCodeReviewJobTasks", - "responseCode":200 - }, - "input":{"shape":"ListCodeReviewJobTasksInput"}, - "output":{"shape":"ListCodeReviewJobTasksOutput"} - }, - "ListCodeReviewJobsForCodeReview":{ - "name":"ListCodeReviewJobsForCodeReview", - "http":{ - "method":"POST", - "requestUri":"/ListCodeReviewJobsForCodeReview", - "responseCode":200 - }, - "input":{"shape":"ListCodeReviewJobsForCodeReviewInput"}, - "output":{"shape":"ListCodeReviewJobsForCodeReviewOutput"} - }, - "ListCodeReviews":{ - "name":"ListCodeReviews", - "http":{ - "method":"POST", - "requestUri":"/ListCodeReviews", - "responseCode":200 - }, - "input":{"shape":"ListCodeReviewsInput"}, - "output":{"shape":"ListCodeReviewsOutput"} - }, - "ListDiscoveredEndpoints":{ - "name":"ListDiscoveredEndpoints", - "http":{ - "method":"POST", - "requestUri":"/ListDiscoveredEndpoints", - "responseCode":200 - }, - "input":{"shape":"ListDiscoveredEndpointsInput"}, - "output":{"shape":"ListDiscoveredEndpointsOutput"} - }, - "ListFindings":{ - "name":"ListFindings", - "http":{ - "method":"POST", - "requestUri":"/ListFindings", - "responseCode":200 - }, - "input":{"shape":"ListFindingsInput"}, - "output":{"shape":"ListFindingsOutput"} - }, - "ListIntegratedResources":{ - "name":"ListIntegratedResources", - "http":{ - "method":"POST", - "requestUri":"/ListIntegratedResources", - "responseCode":200 - }, - "input":{"shape":"ListIntegratedResourcesInput"}, - "output":{"shape":"ListIntegratedResourcesOutput"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ] - }, - "ListIntegrations":{ - "name":"ListIntegrations", - "http":{ - "method":"POST", - "requestUri":"/ListIntegrations", - "responseCode":200 - }, - "input":{"shape":"ListIntegrationsInput"}, - "output":{"shape":"ListIntegrationsOutput"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ], - "readonly":true - }, - "ListMemberships":{ - "name":"ListMemberships", - "http":{ - "method":"POST", - "requestUri":"/ListMemberships", - "responseCode":200 - }, - "input":{"shape":"ListMembershipsRequest"}, - "output":{"shape":"ListMembershipsResponse"} - }, - "ListPentestJobTasks":{ - "name":"ListPentestJobTasks", - "http":{ - "method":"POST", - "requestUri":"/ListPentestJobTasks", - "responseCode":200 - }, - "input":{"shape":"ListPentestJobTasksInput"}, - "output":{"shape":"ListPentestJobTasksOutput"} - }, - "ListPentestJobsForPentest":{ - "name":"ListPentestJobsForPentest", - "http":{ - "method":"POST", - "requestUri":"/ListPentestJobsForPentest", - "responseCode":200 - }, - "input":{"shape":"ListPentestJobsForPentestInput"}, - "output":{"shape":"ListPentestJobsForPentestOutput"} - }, - "ListPentests":{ - "name":"ListPentests", - "http":{ - "method":"POST", - "requestUri":"/ListPentests", - "responseCode":200 - }, - "input":{"shape":"ListPentestsInput"}, - "output":{"shape":"ListPentestsOutput"} - }, - "ListPrivateConnections":{ - "name":"ListPrivateConnections", - "http":{ - "method":"POST", - "requestUri":"/ListPrivateConnections", - "responseCode":200 - }, - "input":{"shape":"ListPrivateConnectionsInput"}, - "output":{"shape":"ListPrivateConnectionsOutput"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ], - "readonly":true - }, - "ListSecurityRequirementPacks":{ - "name":"ListSecurityRequirementPacks", - "http":{ - "method":"POST", - "requestUri":"/ListSecurityRequirementPacks", - "responseCode":200 - }, - "input":{"shape":"ListSecurityRequirementPacksInput"}, - "output":{"shape":"ListSecurityRequirementPacksOutput"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ], - "readonly":true - }, - "ListSecurityRequirements":{ - "name":"ListSecurityRequirements", - "http":{ - "method":"POST", - "requestUri":"/ListSecurityRequirements", - "responseCode":200 - }, - "input":{"shape":"ListSecurityRequirementsInput"}, - "output":{"shape":"ListSecurityRequirementsOutput"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ], - "readonly":true - }, - "ListTagsForResource":{ - "name":"ListTagsForResource", - "http":{ - "method":"GET", - "requestUri":"/tags/{resourceArn}", - "responseCode":200 - }, - "input":{"shape":"ListTagsForResourceInput"}, - "output":{"shape":"ListTagsForResourceOutput"}, - "readonly":true - }, - "ListTargetDomains":{ - "name":"ListTargetDomains", - "http":{ - "method":"POST", - "requestUri":"/ListTargetDomains", - "responseCode":200 - }, - "input":{"shape":"ListTargetDomainsInput"}, - "output":{"shape":"ListTargetDomainsOutput"}, - "readonly":true - }, - "ListThreatModelJobTasks":{ - "name":"ListThreatModelJobTasks", - "http":{ - "method":"POST", - "requestUri":"/ListThreatModelJobTasks", - "responseCode":200 - }, - "input":{"shape":"ListThreatModelJobTasksInput"}, - "output":{"shape":"ListThreatModelJobTasksOutput"}, - "readonly":true - }, - "ListThreatModelJobs":{ - "name":"ListThreatModelJobs", - "http":{ - "method":"POST", - "requestUri":"/ListThreatModelJobs", - "responseCode":200 - }, - "input":{"shape":"ListThreatModelJobsInput"}, - "output":{"shape":"ListThreatModelJobsOutput"}, - "readonly":true - }, - "ListThreatModels":{ - "name":"ListThreatModels", - "http":{ - "method":"POST", - "requestUri":"/ListThreatModels", - "responseCode":200 - }, - "input":{"shape":"ListThreatModelsInput"}, - "output":{"shape":"ListThreatModelsOutput"}, - "readonly":true - }, - "ListThreats":{ - "name":"ListThreats", - "http":{ - "method":"POST", - "requestUri":"/ListThreats", - "responseCode":200 - }, - "input":{"shape":"ListThreatsInput"}, - "output":{"shape":"ListThreatsOutput"}, - "readonly":true - }, - "StartCodeRemediation":{ - "name":"StartCodeRemediation", - "http":{ - "method":"POST", - "requestUri":"/StartCodeRemediation", - "responseCode":200 - }, - "input":{"shape":"StartCodeRemediationInput"}, - "output":{"shape":"StartCodeRemediationOutput"} - }, - "StartCodeReviewJob":{ - "name":"StartCodeReviewJob", - "http":{ - "method":"POST", - "requestUri":"/StartCodeReviewJob", - "responseCode":200 - }, - "input":{"shape":"StartCodeReviewJobInput"}, - "output":{"shape":"StartCodeReviewJobOutput"} - }, - "StartPentestJob":{ - "name":"StartPentestJob", - "http":{ - "method":"POST", - "requestUri":"/StartPentestJob", - "responseCode":200 - }, - "input":{"shape":"StartPentestJobInput"}, - "output":{"shape":"StartPentestJobOutput"} - }, - "StartThreatModelJob":{ - "name":"StartThreatModelJob", - "http":{ - "method":"POST", - "requestUri":"/StartThreatModelJob", - "responseCode":200 - }, - "input":{"shape":"StartThreatModelJobInput"}, - "output":{"shape":"StartThreatModelJobOutput"} - }, - "StopCodeReviewJob":{ - "name":"StopCodeReviewJob", - "http":{ - "method":"POST", - "requestUri":"/StopCodeReviewJob", - "responseCode":200 - }, - "input":{"shape":"StopCodeReviewJobInput"}, - "output":{"shape":"StopCodeReviewJobOutput"} - }, - "StopPentestJob":{ - "name":"StopPentestJob", - "http":{ - "method":"POST", - "requestUri":"/StopPentestJob", - "responseCode":200 - }, - "input":{"shape":"StopPentestJobInput"}, - "output":{"shape":"StopPentestJobOutput"} - }, - "StopThreatModelJob":{ - "name":"StopThreatModelJob", - "http":{ - "method":"POST", - "requestUri":"/StopThreatModelJob", - "responseCode":200 - }, - "input":{"shape":"StopThreatModelJobInput"}, - "output":{"shape":"StopThreatModelJobOutput"} - }, - "TagResource":{ - "name":"TagResource", - "http":{ - "method":"POST", - "requestUri":"/tags/{resourceArn}", - "responseCode":204 - }, - "input":{"shape":"TagResourceInput"}, - "output":{"shape":"TagResourceOutput"} - }, - "UntagResource":{ - "name":"UntagResource", - "http":{ - "method":"DELETE", - "requestUri":"/tags/{resourceArn}", - "responseCode":204 - }, - "input":{"shape":"UntagResourceInput"}, - "output":{"shape":"UntagResourceOutput"}, - "idempotent":true - }, - "UpdateAgentSpace":{ - "name":"UpdateAgentSpace", - "http":{ - "method":"POST", - "requestUri":"/UpdateAgentSpace", - "responseCode":200 - }, - "input":{"shape":"UpdateAgentSpaceInput"}, - "output":{"shape":"UpdateAgentSpaceOutput"} - }, - "UpdateApplication":{ - "name":"UpdateApplication", - "http":{ - "method":"POST", - "requestUri":"/UpdateApplication", - "responseCode":200 - }, - "input":{"shape":"UpdateApplicationRequest"}, - "output":{"shape":"UpdateApplicationResponse"}, - "idempotent":true - }, - "UpdateCodeReview":{ - "name":"UpdateCodeReview", - "http":{ - "method":"POST", - "requestUri":"/UpdateCodeReview", - "responseCode":200 - }, - "input":{"shape":"UpdateCodeReviewInput"}, - "output":{"shape":"UpdateCodeReviewOutput"} - }, - "UpdateFinding":{ - "name":"UpdateFinding", - "http":{ - "method":"POST", - "requestUri":"/UpdateFinding", - "responseCode":200 - }, - "input":{"shape":"UpdateFindingInput"}, - "output":{"shape":"UpdateFindingOutput"} - }, - "UpdateIntegratedResources":{ - "name":"UpdateIntegratedResources", - "http":{ - "method":"POST", - "requestUri":"/UpdateIntegratedResources", - "responseCode":200 - }, - "input":{"shape":"UpdateIntegratedResourcesInput"}, - "output":{"shape":"UpdateIntegratedResourcesOutput"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ] - }, - "UpdatePentest":{ - "name":"UpdatePentest", - "http":{ - "method":"POST", - "requestUri":"/UpdatePentest", - "responseCode":200 - }, - "input":{"shape":"UpdatePentestInput"}, - "output":{"shape":"UpdatePentestOutput"} - }, - "UpdatePrivateConnectionCertificate":{ - "name":"UpdatePrivateConnectionCertificate", - "http":{ - "method":"POST", - "requestUri":"/UpdatePrivateConnectionCertificate", - "responseCode":200 - }, - "input":{"shape":"UpdatePrivateConnectionCertificateInput"}, - "output":{"shape":"UpdatePrivateConnectionCertificateOutput"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ] - }, - "UpdateSecurityRequirementPack":{ - "name":"UpdateSecurityRequirementPack", - "http":{ - "method":"POST", - "requestUri":"/UpdateSecurityRequirementPack", - "responseCode":200 - }, - "input":{"shape":"UpdateSecurityRequirementPackInput"}, - "output":{"shape":"UpdateSecurityRequirementPackOutput"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ] - }, - "UpdateTargetDomain":{ - "name":"UpdateTargetDomain", - "http":{ - "method":"POST", - "requestUri":"/UpdateTargetDomain", - "responseCode":200 - }, - "input":{"shape":"UpdateTargetDomainInput"}, - "output":{"shape":"UpdateTargetDomainOutput"} - }, - "UpdateThreat":{ - "name":"UpdateThreat", - "http":{ - "method":"POST", - "requestUri":"/UpdateThreat", - "responseCode":200 - }, - "input":{"shape":"UpdateThreatInput"}, - "output":{"shape":"UpdateThreatOutput"} - }, - "UpdateThreatModel":{ - "name":"UpdateThreatModel", - "http":{ - "method":"POST", - "requestUri":"/UpdateThreatModel", - "responseCode":200 - }, - "input":{"shape":"UpdateThreatModelInput"}, - "output":{"shape":"UpdateThreatModelOutput"} - }, - "VerifyTargetDomain":{ - "name":"VerifyTargetDomain", - "http":{ - "method":"POST", - "requestUri":"/VerifyTargetDomain", - "responseCode":200 - }, - "input":{"shape":"VerifyTargetDomainInput"}, - "output":{"shape":"VerifyTargetDomainOutput"} - } - }, - "shapes":{ - "AWSResources":{ - "type":"structure", - "members":{ - "vpcs":{"shape":"VpcConfigs"}, - "logGroups":{"shape":"LogGroupArns"}, - "s3Buckets":{"shape":"S3BucketArns"}, - "secretArns":{"shape":"SecretArns"}, - "lambdaFunctionArns":{"shape":"LambdaFunctionArns"}, - "iamRoles":{"shape":"IamRoles"} - } - }, - "AccessDeniedException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"} - }, - "error":{ - "httpStatusCode":403, - "senderFault":true - }, - "exception":true - }, - "AccessToken":{ - "type":"string", - "sensitive":true - }, - "AccessType":{ - "type":"string", - "enum":[ - "PRIVATE", - "PUBLIC" - ] - }, - "Actor":{ - "type":"structure", - "members":{ - "identifier":{"shape":"String"}, - "uris":{"shape":"UriList"}, - "authentication":{"shape":"Authentication"}, - "description":{"shape":"String"} - } - }, - "ActorList":{ - "type":"list", - "member":{"shape":"Actor"} - }, - "AddArtifactInput":{ - "type":"structure", - "required":[ - "agentSpaceId", - "artifactContent", - "artifactType", - "fileName" - ], - "members":{ - "agentSpaceId":{"shape":"AgentSpaceId"}, - "artifactContent":{"shape":"Blob"}, - "artifactType":{"shape":"ArtifactType"}, - "fileName":{"shape":"String"} - } - }, - "AddArtifactOutput":{ - "type":"structure", - "required":["artifactId"], - "members":{ - "artifactId":{"shape":"ArtifactId"} - } - }, - "AgentName":{"type":"string"}, - "AgentSpace":{ - "type":"structure", - "required":[ - "agentSpaceId", - "name" - ], - "members":{ - "agentSpaceId":{"shape":"AgentSpaceId"}, - "name":{"shape":"String"}, - "description":{"shape":"String"}, - "awsResources":{"shape":"AWSResources"}, - "targetDomainIds":{"shape":"TargetDomainIdList"}, - "codeReviewSettings":{"shape":"CodeReviewSettings"}, - "kmsKeyId":{"shape":"KmsKeyId"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"} - } - }, - "AgentSpaceId":{"type":"string"}, - "AgentSpaceIdList":{ - "type":"list", - "member":{"shape":"AgentSpaceId"} - }, - "AgentSpaceList":{ - "type":"list", - "member":{"shape":"AgentSpace"} - }, - "AgentSpaceSummary":{ - "type":"structure", - "required":[ - "agentSpaceId", - "name" - ], - "members":{ - "agentSpaceId":{"shape":"AgentSpaceId"}, - "name":{"shape":"String"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"} - } - }, - "AgentSpaceSummaryList":{ - "type":"list", - "member":{"shape":"AgentSpaceSummary"} - }, - "ApplicationDomain":{"type":"string"}, - "ApplicationId":{"type":"string"}, - "ApplicationSummary":{ - "type":"structure", - "required":[ - "applicationId", - "applicationName", - "domain" - ], - "members":{ - "applicationId":{"shape":"ApplicationId"}, - "applicationName":{"shape":"String"}, - "domain":{"shape":"ApplicationDomain"}, - "defaultKmsKeyId":{"shape":"DefaultKmsKeyId"} - } - }, - "ApplicationSummaryList":{ - "type":"list", - "member":{"shape":"ApplicationSummary"} - }, - "Artifact":{ - "type":"structure", - "required":[ - "contents", - "type" - ], - "members":{ - "contents":{"shape":"String"}, - "type":{"shape":"ArtifactType"} - } - }, - "ArtifactId":{"type":"string"}, - "ArtifactIds":{ - "type":"list", - "member":{"shape":"ArtifactId"} - }, - "ArtifactMetadataItem":{ - "type":"structure", - "required":[ - "agentSpaceId", - "artifactId", - "fileName", - "updatedAt" - ], - "members":{ - "agentSpaceId":{"shape":"AgentSpaceId"}, - "artifactId":{"shape":"ArtifactId"}, - "fileName":{"shape":"String"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"} - } - }, - "ArtifactMetadataList":{ - "type":"list", - "member":{"shape":"ArtifactMetadataItem"} - }, - "ArtifactSummary":{ - "type":"structure", - "required":[ - "artifactId", - "fileName", - "artifactType" - ], - "members":{ - "artifactId":{"shape":"ArtifactId"}, - "fileName":{"shape":"String"}, - "artifactType":{"shape":"ArtifactType"} - } - }, - "ArtifactSummaryList":{ - "type":"list", - "member":{"shape":"ArtifactSummary"} - }, - "ArtifactType":{ - "type":"string", - "enum":[ - "TXT", - "PNG", - "JPEG", - "MD", - "PDF", - "DOCX", - "DOC", - "JSON", - "YAML" - ] - }, - "Assets":{ - "type":"structure", - "members":{ - "endpoints":{"shape":"EndpointList"}, - "actors":{"shape":"ActorList"}, - "documents":{"shape":"DocumentList"}, - "sourceCode":{"shape":"SourceCodeRepositoryList"}, - "integratedRepositories":{"shape":"IntegratedRepositoryList"} - } - }, - "AuthCode":{"type":"string"}, - "Authentication":{ - "type":"structure", - "members":{ - "providerType":{"shape":"AuthenticationProviderType"}, - "value":{"shape":"String"} - } - }, - "AuthenticationProviderType":{ - "type":"string", - "enum":[ - "SECRETS_MANAGER", - "AWS_LAMBDA", - "AWS_IAM_ROLE", - "AWS_INTERNAL" - ] - }, - "BatchCreateSecurityRequirementResult":{ - "type":"structure", - "required":[ - "packId", - "name", - "description", - "domain", - "evaluation", - "createdAt", - "updatedAt" - ], - "members":{ - "packId":{"shape":"SecurityRequirementPackId"}, - "name":{"shape":"SecurityRequirementName"}, - "description":{"shape":"String"}, - "domain":{"shape":"String"}, - "evaluation":{"shape":"String"}, - "remediation":{"shape":"String"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"} - } - }, - "BatchCreateSecurityRequirementResultList":{ - "type":"list", - "member":{"shape":"BatchCreateSecurityRequirementResult"} - }, - "BatchCreateSecurityRequirementsInput":{ - "type":"structure", - "required":[ - "packId", - "securityRequirements" - ], - "members":{ - "packId":{"shape":"SecurityRequirementPackId"}, - "securityRequirements":{"shape":"CreateSecurityRequirementEntryList"} - } - }, - "BatchCreateSecurityRequirementsOutput":{ - "type":"structure", - "required":[ - "securityRequirements", - "errors" - ], - "members":{ - "securityRequirements":{"shape":"BatchCreateSecurityRequirementResultList"}, - "errors":{"shape":"BatchSecurityRequirementErrors"} - } - }, - "BatchDeleteCodeReviewsInput":{ - "type":"structure", - "required":[ - "codeReviewIds", - "agentSpaceId" - ], - "members":{ - "codeReviewIds":{"shape":"CodeReviewIdList"}, - "agentSpaceId":{"shape":"String"} - } - }, - "BatchDeleteCodeReviewsOutput":{ - "type":"structure", - "members":{ - "deleted":{"shape":"CodeReviewIdList"}, - "failed":{"shape":"DeleteCodeReviewFailureList"} - } - }, - "BatchDeletePentestsInput":{ - "type":"structure", - "required":[ - "pentestIds", - "agentSpaceId" - ], - "members":{ - "pentestIds":{"shape":"PentestIdList"}, - "agentSpaceId":{"shape":"String"} - } - }, - "BatchDeletePentestsOutput":{ - "type":"structure", - "members":{ - "deleted":{"shape":"PentestList"}, - "failed":{"shape":"DeletePentestFailureList"} - } - }, - "BatchDeleteSecurityRequirementsInput":{ - "type":"structure", - "required":[ - "packId", - "securityRequirementNames" - ], - "members":{ - "packId":{"shape":"SecurityRequirementPackId"}, - "securityRequirementNames":{"shape":"SecurityRequirementNameList"} - } - }, - "BatchDeleteSecurityRequirementsOutput":{ - "type":"structure", - "required":[ - "deletedSecurityRequirementNames", - "errors" - ], - "members":{ - "deletedSecurityRequirementNames":{"shape":"SecurityRequirementNameList"}, - "errors":{"shape":"BatchSecurityRequirementErrors"} - } - }, - "BatchDeleteThreatModelsInput":{ - "type":"structure", - "required":[ - "threatModelIds", - "agentSpaceId" - ], - "members":{ - "threatModelIds":{"shape":"ThreatModelIdList"}, - "agentSpaceId":{"shape":"String"} - } - }, - "BatchDeleteThreatModelsOutput":{ - "type":"structure", - "members":{ - "deleted":{"shape":"ThreatModelIdList"}, - "failed":{"shape":"DeleteThreatModelFailureList"} - } - }, - "BatchGetAgentSpacesInput":{ - "type":"structure", - "required":["agentSpaceIds"], - "members":{ - "agentSpaceIds":{"shape":"AgentSpaceIdList"} - } - }, - "BatchGetAgentSpacesOutput":{ - "type":"structure", - "members":{ - "agentSpaces":{"shape":"AgentSpaceList"}, - "notFound":{"shape":"AgentSpaceIdList"} - } - }, - "BatchGetArtifactMetadataInput":{ - "type":"structure", - "required":[ - "agentSpaceId", - "artifactIds" - ], - "members":{ - "agentSpaceId":{"shape":"AgentSpaceId"}, - "artifactIds":{"shape":"ArtifactIds"} - } - }, - "BatchGetArtifactMetadataOutput":{ - "type":"structure", - "required":["artifactMetadataList"], - "members":{ - "artifactMetadataList":{"shape":"ArtifactMetadataList"} - } - }, - "BatchGetCodeReviewJobTasksInput":{ - "type":"structure", - "required":[ - "agentSpaceId", - "codeReviewJobTaskIds" - ], - "members":{ - "agentSpaceId":{"shape":"String"}, - "codeReviewJobTaskIds":{"shape":"TaskIdList"} - } - }, - "BatchGetCodeReviewJobTasksOutput":{ - "type":"structure", - "members":{ - "codeReviewJobTasks":{"shape":"CodeReviewJobTaskList"}, - "notFound":{"shape":"TaskIdList"} - } - }, - "BatchGetCodeReviewJobsInput":{ - "type":"structure", - "required":[ - "codeReviewJobIds", - "agentSpaceId" - ], - "members":{ - "codeReviewJobIds":{"shape":"CodeReviewJobIdList"}, - "agentSpaceId":{"shape":"String"} - } - }, - "BatchGetCodeReviewJobsOutput":{ - "type":"structure", - "members":{ - "codeReviewJobs":{"shape":"CodeReviewJobList"}, - "notFound":{"shape":"CodeReviewJobIdList"} - } - }, - "BatchGetCodeReviewsInput":{ - "type":"structure", - "required":[ - "codeReviewIds", - "agentSpaceId" - ], - "members":{ - "codeReviewIds":{"shape":"CodeReviewIdList"}, - "agentSpaceId":{"shape":"String"} - } - }, - "BatchGetCodeReviewsOutput":{ - "type":"structure", - "members":{ - "codeReviews":{"shape":"CodeReviewList"}, - "notFound":{"shape":"CodeReviewIdList"} - } - }, - "BatchGetFindingsInput":{ - "type":"structure", - "required":[ - "findingIds", - "agentSpaceId" - ], - "members":{ - "findingIds":{"shape":"FindingIdList"}, - "agentSpaceId":{"shape":"String"} - } - }, - "BatchGetFindingsOutput":{ - "type":"structure", - "members":{ - "findings":{"shape":"FindingList"}, - "notFound":{"shape":"FindingIdList"} - } - }, - "BatchGetPentestJobTasksInput":{ - "type":"structure", - "required":[ - "agentSpaceId", - "taskIds" - ], - "members":{ - "agentSpaceId":{"shape":"String"}, - "taskIds":{"shape":"TaskIdList"} - } - }, - "BatchGetPentestJobTasksOutput":{ - "type":"structure", - "members":{ - "tasks":{"shape":"TaskList"}, - "notFound":{"shape":"TaskIdList"} - } - }, - "BatchGetPentestJobsInput":{ - "type":"structure", - "required":[ - "pentestJobIds", - "agentSpaceId" - ], - "members":{ - "pentestJobIds":{"shape":"PentestJobIdList"}, - "agentSpaceId":{"shape":"String"} - } - }, - "BatchGetPentestJobsOutput":{ - "type":"structure", - "members":{ - "pentestJobs":{"shape":"PentestJobList"}, - "notFound":{"shape":"PentestJobIdList"} - } - }, - "BatchGetPentestsInput":{ - "type":"structure", - "required":[ - "pentestIds", - "agentSpaceId" - ], - "members":{ - "pentestIds":{"shape":"PentestIdList"}, - "agentSpaceId":{"shape":"String"} - } - }, - "BatchGetPentestsOutput":{ - "type":"structure", - "members":{ - "pentests":{"shape":"PentestList"}, - "notFound":{"shape":"PentestIdList"} - } - }, - "BatchGetSecurityRequirementResult":{ - "type":"structure", - "required":[ - "packId", - "name", - "description", - "domain", - "evaluation", - "createdAt", - "updatedAt" - ], - "members":{ - "packId":{"shape":"SecurityRequirementPackId"}, - "name":{"shape":"SecurityRequirementName"}, - "description":{"shape":"String"}, - "domain":{"shape":"String"}, - "evaluation":{"shape":"String"}, - "remediation":{"shape":"String"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"} - } - }, - "BatchGetSecurityRequirementResultList":{ - "type":"list", - "member":{"shape":"BatchGetSecurityRequirementResult"} - }, - "BatchGetSecurityRequirementsInput":{ - "type":"structure", - "required":[ - "packId", - "securityRequirementNames" - ], - "members":{ - "packId":{"shape":"SecurityRequirementPackId"}, - "securityRequirementNames":{"shape":"SecurityRequirementNameList"} - } - }, - "BatchGetSecurityRequirementsOutput":{ - "type":"structure", - "required":[ - "securityRequirements", - "errors" - ], - "members":{ - "securityRequirements":{"shape":"BatchGetSecurityRequirementResultList"}, - "errors":{"shape":"BatchSecurityRequirementErrors"} - } - }, - "BatchGetTargetDomainsInput":{ - "type":"structure", - "required":["targetDomainIds"], - "members":{ - "targetDomainIds":{"shape":"TargetDomainIdList"} - } - }, - "BatchGetTargetDomainsOutput":{ - "type":"structure", - "members":{ - "targetDomains":{"shape":"TargetDomainList"}, - "notFound":{"shape":"TargetDomainIdList"} - } - }, - "BatchGetThreatModelJobTasksInput":{ - "type":"structure", - "required":[ - "agentSpaceId", - "threatModelJobTaskIds" - ], - "members":{ - "agentSpaceId":{"shape":"String"}, - "threatModelJobTaskIds":{"shape":"TaskIdList"} - } - }, - "BatchGetThreatModelJobTasksOutput":{ - "type":"structure", - "members":{ - "threatModelJobTasks":{"shape":"ThreatModelJobTaskList"}, - "notFound":{"shape":"TaskIdList"} - } - }, - "BatchGetThreatModelJobsInput":{ - "type":"structure", - "required":[ - "threatModelJobIds", - "agentSpaceId" - ], - "members":{ - "threatModelJobIds":{"shape":"ThreatModelJobIdList"}, - "agentSpaceId":{"shape":"String"} - } - }, - "BatchGetThreatModelJobsOutput":{ - "type":"structure", - "members":{ - "threatModelJobs":{"shape":"ThreatModelJobList"}, - "notFound":{"shape":"ThreatModelJobIdList"} - } - }, - "BatchGetThreatModelsInput":{ - "type":"structure", - "required":[ - "threatModelIds", - "agentSpaceId" - ], - "members":{ - "threatModelIds":{"shape":"ThreatModelIdList"}, - "agentSpaceId":{"shape":"String"} - } - }, - "BatchGetThreatModelsOutput":{ - "type":"structure", - "members":{ - "threatModels":{"shape":"ThreatModelList"}, - "notFound":{"shape":"ThreatModelIdList"} - } - }, - "BatchGetThreatsInput":{ - "type":"structure", - "required":[ - "threatIds", - "agentSpaceId" - ], - "members":{ - "threatIds":{"shape":"ThreatIdList"}, - "agentSpaceId":{"shape":"String"} - } - }, - "BatchGetThreatsOutput":{ - "type":"structure", - "members":{ - "threats":{"shape":"ThreatList"}, - "notFound":{"shape":"ThreatIdList"} - } - }, - "BatchSecurityRequirementError":{ - "type":"structure", - "required":[ - "securityRequirementName", - "code", - "message" - ], - "members":{ - "securityRequirementName":{"shape":"SecurityRequirementName"}, - "code":{"shape":"String"}, - "message":{"shape":"String"} - } - }, - "BatchSecurityRequirementErrors":{ - "type":"list", - "member":{"shape":"BatchSecurityRequirementError"} - }, - "BatchUpdateSecurityRequirementsInput":{ - "type":"structure", - "required":[ - "packId", - "securityRequirements" - ], - "members":{ - "packId":{"shape":"SecurityRequirementPackId"}, - "securityRequirements":{"shape":"UpdateSecurityRequirementEntryList"} - } - }, - "BatchUpdateSecurityRequirementsOutput":{ - "type":"structure", - "required":[ - "updatedSecurityRequirementNames", - "errors" - ], - "members":{ - "updatedSecurityRequirementNames":{"shape":"SecurityRequirementNameList"}, - "errors":{"shape":"BatchSecurityRequirementErrors"} - } - }, - "BitbucketInstallationId":{"type":"string"}, - "BitbucketIntegrationInput":{ - "type":"structure", - "required":[ - "installationId", - "workspace", - "code", - "state" - ], - "members":{ - "installationId":{"shape":"BitbucketInstallationId"}, - "workspace":{"shape":"BitbucketWorkspace"}, - "code":{"shape":"AuthCode"}, - "state":{"shape":"CsrfState"} - } - }, - "BitbucketRepositoryMetadata":{ - "type":"structure", - "required":[ - "name", - "providerResourceId", - "workspace" - ], - "members":{ - "name":{"shape":"ProviderResourceName"}, - "providerResourceId":{"shape":"ProviderResourceId"}, - "workspace":{"shape":"BitbucketWorkspace"}, - "accessType":{"shape":"AccessType"} - } - }, - "BitbucketRepositoryResource":{ - "type":"structure", - "required":[ - "name", - "workspace" - ], - "members":{ - "name":{"shape":"ProviderResourceName"}, - "workspace":{"shape":"BitbucketWorkspace"} - } - }, - "BitbucketResourceCapabilities":{ - "type":"structure", - "members":{ - "leaveComments":{"shape":"Boolean"}, - "remediateCode":{"shape":"Boolean"} - } - }, - "BitbucketWorkspace":{"type":"string"}, - "Blob":{"type":"blob"}, - "Boolean":{ - "type":"boolean", - "box":true - }, - "Category":{ - "type":"structure", - "members":{ - "name":{"shape":"String"}, - "isPrimary":{"shape":"Boolean"} - } - }, - "CategoryList":{ - "type":"list", - "member":{"shape":"Category"} - }, - "CertificateChain":{ - "type":"string", - "sensitive":true - }, - "CleanUpStrategy":{ - "type":"string", - "enum":[ - "BEST_EFFORT_DELETE", - "RETAIN_ALL" - ] - }, - "CloudWatchLog":{ - "type":"structure", - "members":{ - "logGroup":{"shape":"String"}, - "logStream":{"shape":"String"} - } - }, - "CodeLocation":{ - "type":"structure", - "required":["filePath"], - "members":{ - "filePath":{"shape":"String"}, - "lineStart":{"shape":"Integer"}, - "lineEnd":{"shape":"Integer"}, - "label":{"shape":"String"} - } - }, - "CodeLocationList":{ - "type":"list", - "member":{"shape":"CodeLocation"} - }, - "CodeRemediationStrategy":{ - "type":"string", - "enum":[ - "AUTOMATIC", - "DISABLED" - ] - }, - "CodeRemediationTask":{ - "type":"structure", - "required":["status"], - "members":{ - "status":{"shape":"CodeRemediationTaskStatus"}, - "statusReason":{"shape":"String"}, - "taskDetails":{"shape":"CodeRemediationTaskDetailsList"} - } - }, - "CodeRemediationTaskDetails":{ - "type":"structure", - "members":{ - "repoName":{"shape":"String"}, - "codeDiffLink":{"shape":"String"}, - "pullRequestLink":{"shape":"String"} - } - }, - "CodeRemediationTaskDetailsList":{ - "type":"list", - "member":{"shape":"CodeRemediationTaskDetails"} - }, - "CodeRemediationTaskStatus":{ - "type":"string", - "enum":[ - "IN_PROGRESS", - "COMPLETED", - "FAILED" - ] - }, - "CodeReview":{ - "type":"structure", - "required":[ - "codeReviewId", - "agentSpaceId", - "title", - "assets" - ], - "members":{ - "codeReviewId":{"shape":"String"}, - "agentSpaceId":{"shape":"String"}, - "title":{"shape":"String"}, - "assets":{"shape":"Assets"}, - "serviceRole":{"shape":"ServiceRole"}, - "logConfig":{"shape":"CloudWatchLog"}, - "codeRemediationStrategy":{"shape":"CodeRemediationStrategy"}, - "validationMode":{"shape":"ValidationMode"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"} - } - }, - "CodeReviewIdList":{ - "type":"list", - "member":{"shape":"String"} - }, - "CodeReviewJob":{ - "type":"structure", - "members":{ - "codeReviewJobId":{"shape":"String"}, - "codeReviewId":{"shape":"String"}, - "title":{"shape":"String"}, - "overview":{"shape":"String"}, - "status":{"shape":"JobStatus"}, - "documents":{"shape":"DocumentList"}, - "sourceCode":{"shape":"SourceCodeRepositoryList"}, - "steps":{"shape":"StepList"}, - "executionContext":{"shape":"ExecutionContextList"}, - "serviceRole":{"shape":"ServiceRole"}, - "logConfig":{"shape":"CloudWatchLog"}, - "errorInformation":{"shape":"ErrorInformation"}, - "integratedRepositories":{"shape":"IntegratedRepositoryList"}, - "codeRemediationStrategy":{"shape":"CodeRemediationStrategy"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"} - } - }, - "CodeReviewJobIdList":{ - "type":"list", - "member":{"shape":"String"} - }, - "CodeReviewJobList":{ - "type":"list", - "member":{"shape":"CodeReviewJob"} - }, - "CodeReviewJobSummary":{ - "type":"structure", - "required":[ - "codeReviewJobId", - "codeReviewId" - ], - "members":{ - "codeReviewJobId":{"shape":"String"}, - "codeReviewId":{"shape":"String"}, - "title":{"shape":"String"}, - "status":{"shape":"JobStatus"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"} - } - }, - "CodeReviewJobSummaryList":{ - "type":"list", - "member":{"shape":"CodeReviewJobSummary"} - }, - "CodeReviewJobTask":{ - "type":"structure", - "required":["taskId"], - "members":{ - "taskId":{"shape":"String"}, - "codeReviewId":{"shape":"String"}, - "codeReviewJobId":{"shape":"String"}, - "agentSpaceId":{"shape":"String"}, - "title":{"shape":"String"}, - "description":{"shape":"String"}, - "categories":{"shape":"CategoryList"}, - "riskType":{"shape":"RiskType"}, - "executionStatus":{"shape":"TaskExecutionStatus"}, - "logsLocation":{"shape":"LogLocation"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"} - } - }, - "CodeReviewJobTaskList":{ - "type":"list", - "member":{"shape":"CodeReviewJobTask"} - }, - "CodeReviewJobTaskSummary":{ - "type":"structure", - "required":["taskId"], - "members":{ - "taskId":{"shape":"String"}, - "codeReviewId":{"shape":"String"}, - "codeReviewJobId":{"shape":"String"}, - "agentSpaceId":{"shape":"String"}, - "title":{"shape":"String"}, - "riskType":{"shape":"RiskType"}, - "executionStatus":{"shape":"TaskExecutionStatus"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"} - } - }, - "CodeReviewJobTaskSummaryList":{ - "type":"list", - "member":{"shape":"CodeReviewJobTaskSummary"} - }, - "CodeReviewList":{ - "type":"list", - "member":{"shape":"CodeReview"} - }, - "CodeReviewSettings":{ - "type":"structure", - "required":[ - "controlsScanning", - "generalPurposeScanning" - ], - "members":{ - "controlsScanning":{"shape":"Boolean"}, - "generalPurposeScanning":{"shape":"Boolean"} - } - }, - "CodeReviewSummary":{ - "type":"structure", - "required":[ - "codeReviewId", - "agentSpaceId", - "title" - ], - "members":{ - "codeReviewId":{"shape":"String"}, - "agentSpaceId":{"shape":"String"}, - "title":{"shape":"String"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"} - } - }, - "CodeReviewSummaryList":{ - "type":"list", - "member":{"shape":"CodeReviewSummary"} - }, - "ConfidenceLevel":{ - "type":"string", - "enum":[ - "FALSE_POSITIVE", - "UNCONFIRMED", - "LOW", - "MEDIUM", - "HIGH" - ] - }, - "ConflictException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"} - }, - "error":{ - "httpStatusCode":409, - "senderFault":true - }, - "exception":true - }, - "ConfluenceDocumentMetadata":{ - "type":"structure", - "required":[ - "name", - "providerResourceId", - "spaceKey", - "pageId" - ], - "members":{ - "name":{"shape":"ProviderResourceName"}, - "providerResourceId":{"shape":"ProviderResourceId"}, - "spaceKey":{"shape":"String"}, - "pageId":{"shape":"String"}, - "title":{"shape":"String"}, - "spaceTitle":{"shape":"String"} - } - }, - "ConfluenceDocumentResource":{ - "type":"structure", - "required":[ - "name", - "spaceKey", - "pageId" - ], - "members":{ - "name":{"shape":"ProviderResourceName"}, - "spaceKey":{"shape":"String"}, - "pageId":{"shape":"String"}, - "title":{"shape":"String"}, - "spaceTitle":{"shape":"String"} - } - }, - "ConfluenceInstallationId":{"type":"string"}, - "ConfluenceIntegrationInput":{ - "type":"structure", - "required":[ - "installationId", - "code", - "state", - "siteUrl" - ], - "members":{ - "installationId":{"shape":"ConfluenceInstallationId"}, - "code":{"shape":"AuthCode"}, - "state":{"shape":"CsrfState"}, - "siteUrl":{"shape":"ConfluenceSiteUrl"} - } - }, - "ConfluenceResourceCapabilities":{ - "type":"structure", - "members":{ - "fetchDocument":{"shape":"Boolean"}, - "createDocument":{"shape":"Boolean"}, - "updateDocument":{"shape":"Boolean"} - } - }, - "ConfluenceSiteUrl":{"type":"string"}, - "ContextType":{ - "type":"string", - "enum":[ - "ERROR", - "CLIENT_ERROR", - "WARNING", - "INFO" - ] - }, - "CreateAgentSpaceInput":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{"shape":"AgentName"}, - "description":{"shape":"String"}, - "awsResources":{"shape":"AWSResources"}, - "targetDomainIds":{"shape":"TargetDomainIdList"}, - "codeReviewSettings":{"shape":"CodeReviewSettings"}, - "kmsKeyId":{"shape":"KmsKeyId"}, - "tags":{"shape":"TagMap"} - } - }, - "CreateAgentSpaceOutput":{ - "type":"structure", - "required":[ - "agentSpaceId", - "name" - ], - "members":{ - "agentSpaceId":{"shape":"AgentSpaceId"}, - "name":{"shape":"AgentName"}, - "description":{"shape":"String"}, - "awsResources":{"shape":"AWSResources"}, - "targetDomainIds":{"shape":"TargetDomainIdList"}, - "codeReviewSettings":{"shape":"CodeReviewSettings"}, - "kmsKeyId":{"shape":"KmsKeyId"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"} - } - }, - "CreateApplicationRequest":{ - "type":"structure", - "members":{ - "idcInstanceArn":{"shape":"IdCInstanceArn"}, - "roleArn":{"shape":"RoleArn"}, - "defaultKmsKeyId":{"shape":"DefaultKmsKeyId"}, - "tags":{"shape":"TagMap"} - } - }, - "CreateApplicationResponse":{ - "type":"structure", - "required":["applicationId"], - "members":{ - "applicationId":{"shape":"ApplicationId"} - } - }, - "CreateCodeReviewInput":{ - "type":"structure", - "required":[ - "title", - "agentSpaceId", - "assets" - ], - "members":{ - "title":{"shape":"String"}, - "agentSpaceId":{"shape":"String"}, - "assets":{"shape":"Assets"}, - "serviceRole":{"shape":"ServiceRole"}, - "logConfig":{"shape":"CloudWatchLog"}, - "codeRemediationStrategy":{"shape":"CodeRemediationStrategy"}, - "validationMode":{"shape":"ValidationMode"} - } - }, - "CreateCodeReviewOutput":{ - "type":"structure", - "required":["codeReviewId"], - "members":{ - "codeReviewId":{"shape":"String"}, - "title":{"shape":"String"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"}, - "assets":{"shape":"Assets"}, - "serviceRole":{"shape":"ServiceRole"}, - "logConfig":{"shape":"CloudWatchLog"}, - "agentSpaceId":{"shape":"String"}, - "codeRemediationStrategy":{"shape":"CodeRemediationStrategy"}, - "validationMode":{"shape":"ValidationMode"} - } - }, - "CreateIntegrationInput":{ - "type":"structure", - "required":[ - "provider", - "input", - "integrationDisplayName" - ], - "members":{ - "provider":{"shape":"Provider"}, - "input":{"shape":"ProviderInput"}, - "integrationDisplayName":{"shape":"String"}, - "kmsKeyId":{"shape":"KmsKeyId"}, - "tags":{"shape":"TagMap"}, - "privateConnectionName":{"shape":"PrivateConnectionName"} - } - }, - "CreateIntegrationOutput":{ - "type":"structure", - "required":["integrationId"], - "members":{ - "integrationId":{"shape":"IntegrationId"} - } - }, - "CreateMembershipRequest":{ - "type":"structure", - "required":[ - "applicationId", - "agentSpaceId", - "membershipId", - "memberType" - ], - "members":{ - "applicationId":{"shape":"ApplicationId"}, - "agentSpaceId":{"shape":"AgentSpaceId"}, - "membershipId":{"shape":"MembershipId"}, - "memberType":{"shape":"MembershipType"}, - "config":{"shape":"MembershipConfig"} - } - }, - "CreateMembershipResponse":{ - "type":"structure", - "members":{} - }, - "CreatePentestInput":{ - "type":"structure", - "required":[ - "title", - "agentSpaceId" - ], - "members":{ - "title":{"shape":"String"}, - "agentSpaceId":{"shape":"String"}, - "assets":{"shape":"Assets"}, - "excludeRiskTypes":{"shape":"RiskTypeList"}, - "serviceRole":{"shape":"ServiceRole"}, - "logConfig":{"shape":"CloudWatchLog"}, - "vpcConfig":{"shape":"VpcConfig"}, - "networkTrafficConfig":{"shape":"NetworkTrafficConfig"}, - "codeRemediationStrategy":{"shape":"CodeRemediationStrategy"}, - "disableManagedSkills":{"shape":"SkillTypeList"} - } - }, - "CreatePentestOutput":{ - "type":"structure", - "members":{ - "pentestId":{"shape":"String"}, - "title":{"shape":"String"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"}, - "assets":{"shape":"Assets"}, - "excludeRiskTypes":{"shape":"RiskTypeList"}, - "serviceRole":{"shape":"ServiceRole"}, - "logConfig":{"shape":"CloudWatchLog"}, - "agentSpaceId":{"shape":"String"} - } - }, - "CreatePrivateConnectionInput":{ - "type":"structure", - "required":[ - "privateConnectionName", - "mode" - ], - "members":{ - "privateConnectionName":{"shape":"PrivateConnectionName"}, - "mode":{"shape":"PrivateConnectionMode"}, - "tags":{"shape":"TagMap"} - } - }, - "CreatePrivateConnectionOutput":{ - "type":"structure", - "required":[ - "name", - "type", - "status" - ], - "members":{ - "name":{"shape":"PrivateConnectionName"}, - "type":{"shape":"PrivateConnectionType"}, - "status":{"shape":"PrivateConnectionStatus"}, - "resourceGatewayId":{"shape":"ResourceGatewayId"}, - "hostAddress":{"shape":"HostAddress"}, - "vpcId":{"shape":"PrivateConnectionVpcId"}, - "resourceConfigurationId":{"shape":"ResourceConfigurationId"}, - "certificateExpiryTime":{"shape":"SyntheticTimestamp_date_time"}, - "dnsResolution":{"shape":"ResourceConfigDnsResolution"}, - "failureMessage":{"shape":"String"}, - "tags":{"shape":"TagMap"} - } - }, - "CreateSecurityRequirementEntry":{ - "type":"structure", - "required":[ - "name", - "description", - "domain", - "evaluation" - ], - "members":{ - "name":{"shape":"SecurityRequirementName"}, - "description":{"shape":"String"}, - "domain":{"shape":"String"}, - "evaluation":{"shape":"String"}, - "remediation":{"shape":"String"} - } - }, - "CreateSecurityRequirementEntryList":{ - "type":"list", - "member":{"shape":"CreateSecurityRequirementEntry"} - }, - "CreateSecurityRequirementPackInput":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{"shape":"SecurityRequirementPackName"}, - "description":{"shape":"String"}, - "status":{"shape":"SecurityRequirementPackStatus"}, - "kmsKeyId":{"shape":"KmsKeyId"}, - "tags":{"shape":"TagMap"} - } - }, - "CreateSecurityRequirementPackOutput":{ - "type":"structure", - "required":[ - "packId", - "status" - ], - "members":{ - "packId":{"shape":"SecurityRequirementPackId"}, - "status":{"shape":"SecurityRequirementPackStatus"}, - "kmsKeyId":{"shape":"KmsKeyId"} - } - }, - "CreateTargetDomainInput":{ - "type":"structure", - "required":[ - "targetDomainName", - "verificationMethod" - ], - "members":{ - "targetDomainName":{"shape":"String"}, - "verificationMethod":{"shape":"DomainVerificationMethod"}, - "tags":{"shape":"TagMap"} - } - }, - "CreateTargetDomainOutput":{ - "type":"structure", - "required":[ - "targetDomainId", - "domainName", - "verificationStatus" - ], - "members":{ - "targetDomainId":{"shape":"TargetDomainId"}, - "domainName":{"shape":"String"}, - "verificationStatus":{"shape":"TargetDomainStatus"}, - "verificationStatusReason":{"shape":"String"}, - "verificationDetails":{"shape":"VerificationDetails"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "verifiedAt":{"shape":"SyntheticTimestamp_date_time"} - } - }, - "CreateThreatInput":{ - "type":"structure", - "required":[ - "agentSpaceId", - "threatJobId" - ], - "members":{ - "agentSpaceId":{"shape":"String"}, - "threatJobId":{"shape":"String"}, - "title":{"shape":"String"}, - "statement":{"shape":"String"}, - "severity":{"shape":"ThreatSeverity"}, - "comments":{"shape":"String"}, - "stride":{"shape":"StrideCategoryList"}, - "threatSource":{"shape":"String"}, - "prerequisites":{"shape":"String"}, - "threatAction":{"shape":"String"}, - "threatImpact":{"shape":"String"}, - "impactedGoal":{"shape":"StringList"}, - "impactedAssets":{"shape":"StringList"}, - "anchor":{"shape":"ThreatAnchorShape"}, - "evidence":{"shape":"ThreatEvidenceList"}, - "recommendation":{"shape":"String"} - } - }, - "CreateThreatModelInput":{ - "type":"structure", - "required":[ - "title", - "agentSpaceId", - "serviceRole" - ], - "members":{ - "title":{"shape":"String"}, - "agentSpaceId":{"shape":"String"}, - "description":{"shape":"String"}, - "assets":{"shape":"Assets"}, - "scopeDocs":{"shape":"DocumentList"}, - "serviceRole":{"shape":"ServiceRole"}, - "logConfig":{"shape":"CloudWatchLog"}, - "reportDestination":{"shape":"ReportDestination"} - } - }, - "CreateThreatModelOutput":{ - "type":"structure", - "required":["threatModelId"], - "members":{ - "threatModelId":{"shape":"String"}, - "title":{"shape":"String"}, - "agentSpaceId":{"shape":"String"}, - "description":{"shape":"String"}, - "assets":{"shape":"Assets"}, - "scopeDocs":{"shape":"DocumentList"}, - "serviceRole":{"shape":"ServiceRole"}, - "logConfig":{"shape":"CloudWatchLog"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"} - } - }, - "CreateThreatOutput":{ - "type":"structure", - "required":[ - "threatId", - "threatJobId" - ], - "members":{ - "threatId":{"shape":"String"}, - "threatJobId":{"shape":"String"}, - "title":{"shape":"String"}, - "statement":{"shape":"String"}, - "severity":{"shape":"ThreatSeverity"}, - "status":{"shape":"ThreatStatus"}, - "comments":{"shape":"String"}, - "stride":{"shape":"StrideCategoryList"}, - "threatSource":{"shape":"String"}, - "prerequisites":{"shape":"String"}, - "threatAction":{"shape":"String"}, - "threatImpact":{"shape":"String"}, - "impactedGoal":{"shape":"StringList"}, - "impactedAssets":{"shape":"StringList"}, - "anchor":{"shape":"ThreatAnchorShape"}, - "evidence":{"shape":"ThreatEvidenceList"}, - "recommendation":{"shape":"String"}, - "createdBy":{"shape":"ThreatActor"}, - "updatedBy":{"shape":"ThreatActor"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"} - } - }, - "CsrfState":{"type":"string"}, - "CustomHeader":{ - "type":"structure", - "members":{ - "name":{"shape":"String"}, - "value":{"shape":"String"} - } - }, - "CustomHeaderList":{ - "type":"list", - "member":{"shape":"CustomHeader"} - }, - "DNSRecordType":{ - "type":"string", - "enum":["TXT"] - }, - "DefaultKmsKeyId":{"type":"string"}, - "DeleteAgentSpaceInput":{ - "type":"structure", - "required":["agentSpaceId"], - "members":{ - "agentSpaceId":{"shape":"AgentSpaceId"} - } - }, - "DeleteAgentSpaceOutput":{ - "type":"structure", - "members":{ - "agentSpaceId":{"shape":"AgentSpaceId"} - } - }, - "DeleteApplicationRequest":{ - "type":"structure", - "required":["applicationId"], - "members":{ - "applicationId":{"shape":"ApplicationId"} - } - }, - "DeleteArtifactInput":{ - "type":"structure", - "required":[ - "agentSpaceId", - "artifactId" - ], - "members":{ - "agentSpaceId":{"shape":"AgentSpaceId"}, - "artifactId":{"shape":"ArtifactId"} - } - }, - "DeleteArtifactOutput":{ - "type":"structure", - "members":{} - }, - "DeleteCodeReviewFailure":{ - "type":"structure", - "members":{ - "codeReviewId":{"shape":"String"}, - "reason":{"shape":"String"} - } - }, - "DeleteCodeReviewFailureList":{ - "type":"list", - "member":{"shape":"DeleteCodeReviewFailure"} - }, - "DeleteIntegrationInput":{ - "type":"structure", - "required":["integrationId"], - "members":{ - "integrationId":{"shape":"IntegrationId"} - } - }, - "DeleteIntegrationOutput":{ - "type":"structure", - "members":{} - }, - "DeleteMembershipRequest":{ - "type":"structure", - "required":[ - "applicationId", - "agentSpaceId", - "membershipId" - ], - "members":{ - "applicationId":{"shape":"ApplicationId"}, - "agentSpaceId":{"shape":"AgentSpaceId"}, - "membershipId":{"shape":"MembershipId"}, - "memberType":{"shape":"MembershipType"} - } - }, - "DeleteMembershipResponse":{ - "type":"structure", - "members":{} - }, - "DeletePentestFailure":{ - "type":"structure", - "members":{ - "pentestId":{"shape":"String"}, - "reason":{"shape":"String"} - } - }, - "DeletePentestFailureList":{ - "type":"list", - "member":{"shape":"DeletePentestFailure"} - }, - "DeletePrivateConnectionInput":{ - "type":"structure", - "required":["privateConnectionName"], - "members":{ - "privateConnectionName":{"shape":"PrivateConnectionName"} - } - }, - "DeletePrivateConnectionOutput":{ - "type":"structure", - "required":[ - "name", - "type", - "status" - ], - "members":{ - "name":{"shape":"PrivateConnectionName"}, - "type":{"shape":"PrivateConnectionType"}, - "status":{"shape":"PrivateConnectionStatus"}, - "resourceGatewayId":{"shape":"ResourceGatewayId"}, - "hostAddress":{"shape":"HostAddress"}, - "vpcId":{"shape":"PrivateConnectionVpcId"}, - "resourceConfigurationId":{"shape":"ResourceConfigurationId"}, - "certificateExpiryTime":{"shape":"SyntheticTimestamp_date_time"}, - "dnsResolution":{"shape":"ResourceConfigDnsResolution"}, - "failureMessage":{"shape":"String"}, - "tags":{"shape":"TagMap"} - } - }, - "DeleteSecurityRequirementPackInput":{ - "type":"structure", - "required":["packId"], - "members":{ - "packId":{"shape":"SecurityRequirementPackId"} - } - }, - "DeleteSecurityRequirementPackOutput":{ - "type":"structure", - "members":{} - }, - "DeleteTargetDomainInput":{ - "type":"structure", - "required":["targetDomainId"], - "members":{ - "targetDomainId":{"shape":"TargetDomainId"} - } - }, - "DeleteTargetDomainOutput":{ - "type":"structure", - "members":{ - "targetDomainId":{"shape":"TargetDomainId"} - } - }, - "DeleteThreatModelFailure":{ - "type":"structure", - "members":{ - "threatModelId":{"shape":"String"}, - "reason":{"shape":"String"} - } - }, - "DeleteThreatModelFailureList":{ - "type":"list", - "member":{"shape":"DeleteThreatModelFailure"} - }, - "DescribePrivateConnectionInput":{ - "type":"structure", - "required":["privateConnectionName"], - "members":{ - "privateConnectionName":{"shape":"PrivateConnectionName"} - } - }, - "DescribePrivateConnectionOutput":{ - "type":"structure", - "required":[ - "name", - "type", - "status" - ], - "members":{ - "name":{"shape":"PrivateConnectionName"}, - "type":{"shape":"PrivateConnectionType"}, - "status":{"shape":"PrivateConnectionStatus"}, - "resourceGatewayId":{"shape":"ResourceGatewayId"}, - "hostAddress":{"shape":"HostAddress"}, - "vpcId":{"shape":"PrivateConnectionVpcId"}, - "resourceConfigurationId":{"shape":"ResourceConfigurationId"}, - "certificateExpiryTime":{"shape":"SyntheticTimestamp_date_time"}, - "dnsResolution":{"shape":"ResourceConfigDnsResolution"}, - "failureMessage":{"shape":"String"}, - "tags":{"shape":"TagMap"} - } - }, - "DiffSource":{ - "type":"structure", - "members":{ - "s3Uri":{"shape":"String"} - }, - "union":true - }, - "DiscoveredEndpoint":{ - "type":"structure", - "required":[ - "uri", - "pentestJobId", - "taskId", - "agentSpaceId" - ], - "members":{ - "uri":{"shape":"String"}, - "pentestJobId":{"shape":"String"}, - "taskId":{"shape":"String"}, - "agentSpaceId":{"shape":"String"}, - "evidence":{"shape":"String"}, - "operation":{"shape":"String"}, - "description":{"shape":"String"} - } - }, - "DiscoveredEndpointList":{ - "type":"list", - "member":{"shape":"DiscoveredEndpoint"} - }, - "DnsVerification":{ - "type":"structure", - "members":{ - "token":{"shape":"String"}, - "dnsRecordName":{"shape":"String"}, - "dnsRecordType":{"shape":"DNSRecordType"} - } - }, - "DocumentInfo":{ - "type":"structure", - "members":{ - "s3Location":{"shape":"String"}, - "artifactId":{"shape":"String"}, - "integratedDocument":{"shape":"IntegratedDocument"} - } - }, - "DocumentList":{ - "type":"list", - "member":{"shape":"DocumentInfo"} - }, - "DomainVerificationMethod":{ - "type":"string", - "enum":[ - "DNS_TXT", - "HTTP_ROUTE", - "PRIVATE_VPC" - ] - }, - "Double":{ - "type":"double", - "box":true - }, - "Endpoint":{ - "type":"structure", - "members":{ - "uri":{"shape":"String"} - } - }, - "EndpointList":{ - "type":"list", - "member":{"shape":"Endpoint"} - }, - "ErrorCode":{ - "type":"string", - "enum":[ - "CLIENT_ERROR", - "INTERNAL_ERROR", - "STOPPED_BY_USER" - ] - }, - "ErrorInformation":{ - "type":"structure", - "members":{ - "code":{"shape":"ErrorCode"}, - "message":{"shape":"String"} - } - }, - "ExecutionContext":{ - "type":"structure", - "members":{ - "contextType":{"shape":"ContextType"}, - "context":{"shape":"String"}, - "timestamp":{"shape":"SyntheticTimestamp_date_time"} - } - }, - "ExecutionContextList":{ - "type":"list", - "member":{"shape":"ExecutionContext"} - }, - "Finding":{ - "type":"structure", - "required":[ - "findingId", - "agentSpaceId" - ], - "members":{ - "findingId":{"shape":"String"}, - "agentSpaceId":{"shape":"String"}, - "pentestId":{"shape":"String"}, - "pentestJobId":{"shape":"String"}, - "codeReviewId":{"shape":"String"}, - "codeReviewJobId":{"shape":"String"}, - "taskId":{"shape":"String"}, - "name":{"shape":"String"}, - "description":{"shape":"String"}, - "status":{"shape":"FindingStatus"}, - "riskType":{"shape":"String"}, - "riskLevel":{"shape":"RiskLevel"}, - "riskScore":{"shape":"String"}, - "reasoning":{"shape":"String"}, - "confidence":{"shape":"ConfidenceLevel"}, - "validationStatus":{"shape":"ValidationStatus"}, - "attackScript":{"shape":"String"}, - "codeRemediationTask":{"shape":"CodeRemediationTask"}, - "lastUpdatedBy":{"shape":"String"}, - "customerNote":{"shape":"String"}, - "codeLocations":{"shape":"CodeLocationList"}, - "verificationScript":{"shape":"VerificationScript"}, - "alignmentRationale":{"shape":"String"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"} - } - }, - "FindingIdList":{ - "type":"list", - "member":{"shape":"String"} - }, - "FindingList":{ - "type":"list", - "member":{"shape":"Finding"} - }, - "FindingStatus":{ - "type":"string", - "enum":[ - "ACTIVE", - "RESOLVED", - "ACCEPTED", - "FALSE_POSITIVE" - ] - }, - "FindingSummary":{ - "type":"structure", - "required":[ - "findingId", - "agentSpaceId" - ], - "members":{ - "findingId":{"shape":"String"}, - "agentSpaceId":{"shape":"String"}, - "pentestId":{"shape":"String"}, - "pentestJobId":{"shape":"String"}, - "codeReviewId":{"shape":"String"}, - "codeReviewJobId":{"shape":"String"}, - "name":{"shape":"String"}, - "status":{"shape":"FindingStatus"}, - "riskType":{"shape":"String"}, - "riskLevel":{"shape":"RiskLevel"}, - "confidence":{"shape":"ConfidenceLevel"}, - "validationStatus":{"shape":"ValidationStatus"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"} - } - }, - "FindingSummaryList":{ - "type":"list", - "member":{"shape":"FindingSummary"} - }, - "GetApplicationRequest":{ - "type":"structure", - "required":["applicationId"], - "members":{ - "applicationId":{"shape":"ApplicationId"} - } - }, - "GetApplicationResponse":{ - "type":"structure", - "required":[ - "applicationId", - "domain" - ], - "members":{ - "applicationId":{"shape":"ApplicationId"}, - "domain":{"shape":"ApplicationDomain"}, - "applicationName":{"shape":"String"}, - "idcConfiguration":{"shape":"IdCConfiguration"}, - "roleArn":{"shape":"RoleArn"}, - "defaultKmsKeyId":{"shape":"DefaultKmsKeyId"} - } - }, - "GetArtifactInput":{ - "type":"structure", - "required":[ - "agentSpaceId", - "artifactId" - ], - "members":{ - "agentSpaceId":{"shape":"AgentSpaceId"}, - "artifactId":{"shape":"ArtifactId"} - } - }, - "GetArtifactOutput":{ - "type":"structure", - "required":[ - "agentSpaceId", - "artifactId", - "artifact", - "fileName", - "updatedAt" - ], - "members":{ - "agentSpaceId":{"shape":"AgentSpaceId"}, - "artifactId":{"shape":"ArtifactId"}, - "artifact":{"shape":"Artifact"}, - "fileName":{"shape":"String"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"} - } - }, - "GetIntegrationInput":{ - "type":"structure", - "required":["integrationId"], - "members":{ - "integrationId":{"shape":"IntegrationId"} - } - }, - "GetIntegrationOutput":{ - "type":"structure", - "required":[ - "integrationId", - "installationId", - "provider", - "providerType" - ], - "members":{ - "integrationId":{"shape":"IntegrationId"}, - "installationId":{"shape":"String"}, - "provider":{"shape":"Provider"}, - "providerType":{"shape":"ProviderType"}, - "displayName":{"shape":"String"}, - "kmsKeyId":{"shape":"KmsKeyId"}, - "targetUrl":{"shape":"TargetUrl"}, - "privateConnectionName":{"shape":"PrivateConnectionName"} - } - }, - "GetSecurityRequirementPackInput":{ - "type":"structure", - "required":["packId"], - "members":{ - "packId":{"shape":"SecurityRequirementPackId"} - } - }, - "GetSecurityRequirementPackOutput":{ - "type":"structure", - "required":[ - "packId", - "name", - "managementType", - "status", - "createdAt", - "updatedAt" - ], - "members":{ - "packId":{"shape":"SecurityRequirementPackId"}, - "name":{"shape":"SecurityRequirementPackName"}, - "description":{"shape":"String"}, - "vendorName":{"shape":"String"}, - "managementType":{"shape":"ManagementType"}, - "status":{"shape":"SecurityRequirementPackStatus"}, - "importStatus":{"shape":"SecurityRequirementPackImportStatus"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"}, - "kmsKeyId":{"shape":"KmsKeyId"} - } - }, - "GitHubIntegrationInput":{ - "type":"structure", - "required":[ - "code", - "state" - ], - "members":{ - "code":{"shape":"AuthCode"}, - "state":{"shape":"CsrfState"}, - "organizationName":{"shape":"String"}, - "targetUrl":{"shape":"TargetUrl"}, - "installationId":{"shape":"String"} - } - }, - "GitHubOwner":{"type":"string"}, - "GitHubRepositoryMetadata":{ - "type":"structure", - "required":[ - "name", - "providerResourceId", - "owner" - ], - "members":{ - "name":{"shape":"ProviderResourceName"}, - "providerResourceId":{"shape":"ProviderResourceId"}, - "owner":{"shape":"GitHubOwner"}, - "accessType":{"shape":"AccessType"} - } - }, - "GitHubRepositoryResource":{ - "type":"structure", - "required":[ - "name", - "owner" - ], - "members":{ - "name":{"shape":"ProviderResourceName"}, - "owner":{"shape":"GitHubOwner"} - } - }, - "GitHubResourceCapabilities":{ - "type":"structure", - "members":{ - "leaveComments":{"shape":"Boolean"}, - "remediateCode":{"shape":"Boolean"} - } - }, - "GitLabIntegrationInput":{ - "type":"structure", - "required":[ - "accessToken", - "tokenType" - ], - "members":{ - "accessToken":{"shape":"AccessToken"}, - "targetUrl":{"shape":"TargetUrl"}, - "tokenType":{"shape":"GitLabTokenType"}, - "groupId":{"shape":"String"} - } - }, - "GitLabNamespace":{"type":"string"}, - "GitLabRepositoryMetadata":{ - "type":"structure", - "required":[ - "name", - "providerResourceId", - "namespace" - ], - "members":{ - "name":{"shape":"ProviderResourceName"}, - "providerResourceId":{"shape":"ProviderResourceId"}, - "namespace":{"shape":"GitLabNamespace"}, - "accessType":{"shape":"AccessType"} - } - }, - "GitLabRepositoryResource":{ - "type":"structure", - "required":[ - "name", - "namespace" - ], - "members":{ - "name":{"shape":"ProviderResourceName"}, - "namespace":{"shape":"GitLabNamespace"} - } - }, - "GitLabResourceCapabilities":{ - "type":"structure", - "members":{ - "leaveComments":{"shape":"Boolean"}, - "remediateCode":{"shape":"Boolean"} - } - }, - "GitLabTokenType":{ - "type":"string", - "enum":[ - "PERSONAL", - "GROUP" - ] - }, - "HostAddress":{"type":"string"}, - "HttpVerification":{ - "type":"structure", - "members":{ - "token":{"shape":"String"}, - "routePath":{"shape":"String"} - } - }, - "IamRoles":{ - "type":"list", - "member":{"shape":"ServiceRole"} - }, - "IdCApplicationArn":{"type":"string"}, - "IdCConfiguration":{ - "type":"structure", - "members":{ - "idcApplicationArn":{"shape":"IdCApplicationArn"}, - "idcInstanceArn":{"shape":"IdCInstanceArn"} - } - }, - "IdCInstanceArn":{"type":"string"}, - "ImportSecurityRequirementsInput":{ - "type":"structure", - "required":[ - "packId", - "input" - ], - "members":{ - "packId":{"shape":"SecurityRequirementPackId"}, - "input":{"shape":"ImportSource"} - } - }, - "ImportSecurityRequirementsOutput":{ - "type":"structure", - "required":[ - "packId", - "importStatus" - ], - "members":{ - "packId":{"shape":"SecurityRequirementPackId"}, - "importStatus":{"shape":"SecurityRequirementPackImportStatus"} - } - }, - "ImportSource":{ - "type":"structure", - "members":{ - "documents":{"shape":"SecurityRequirementArtifactList"} - }, - "union":true - }, - "InitiateProviderRegistrationInput":{ - "type":"structure", - "required":["provider"], - "members":{ - "provider":{"shape":"Provider"} - } - }, - "InitiateProviderRegistrationOutput":{ - "type":"structure", - "required":[ - "redirectTo", - "csrfState" - ], - "members":{ - "redirectTo":{"shape":"Location"}, - "csrfState":{"shape":"CsrfState"} - } - }, - "Integer":{ - "type":"integer", - "box":true - }, - "IntegratedDocument":{ - "type":"structure", - "required":[ - "integrationId", - "resourceId" - ], - "members":{ - "integrationId":{"shape":"String"}, - "resourceId":{"shape":"String"} - } - }, - "IntegratedRepository":{ - "type":"structure", - "required":[ - "integrationId", - "providerResourceId" - ], - "members":{ - "integrationId":{"shape":"String"}, - "providerResourceId":{"shape":"String"}, - "branch":{"shape":"String"} - } - }, - "IntegratedRepositoryList":{ - "type":"list", - "member":{"shape":"IntegratedRepository"} - }, - "IntegratedResource":{ - "type":"structure", - "members":{ - "githubRepository":{"shape":"GitHubRepositoryResource"}, - "gitlabRepository":{"shape":"GitLabRepositoryResource"}, - "bitbucketRepository":{"shape":"BitbucketRepositoryResource"}, - "confluenceDocument":{"shape":"ConfluenceDocumentResource"} - }, - "union":true - }, - "IntegratedResourceInputItem":{ - "type":"structure", - "required":["resource"], - "members":{ - "resource":{"shape":"IntegratedResource"}, - "capabilities":{"shape":"ProviderResourceCapabilities"} - } - }, - "IntegratedResourceInputItemList":{ - "type":"list", - "member":{"shape":"IntegratedResourceInputItem"} - }, - "IntegratedResourceMetadata":{ - "type":"structure", - "members":{ - "githubRepository":{"shape":"GitHubRepositoryMetadata"}, - "gitlabRepository":{"shape":"GitLabRepositoryMetadata"}, - "bitbucketRepository":{"shape":"BitbucketRepositoryMetadata"}, - "confluenceDocument":{"shape":"ConfluenceDocumentMetadata"} - }, - "union":true - }, - "IntegratedResourceSummary":{ - "type":"structure", - "required":[ - "integrationId", - "resource" - ], - "members":{ - "integrationId":{"shape":"IntegrationId"}, - "resource":{"shape":"IntegratedResourceMetadata"}, - "capabilities":{"shape":"ProviderResourceCapabilities"} - } - }, - "IntegratedResourceSummaryList":{ - "type":"list", - "member":{"shape":"IntegratedResourceSummary"} - }, - "IntegrationFilter":{ - "type":"structure", - "members":{ - "provider":{"shape":"Provider"}, - "providerType":{"shape":"ProviderType"} - }, - "union":true - }, - "IntegrationId":{"type":"string"}, - "IntegrationSummary":{ - "type":"structure", - "required":[ - "integrationId", - "installationId", - "provider", - "providerType", - "displayName" - ], - "members":{ - "integrationId":{"shape":"String"}, - "installationId":{"shape":"String"}, - "provider":{"shape":"Provider"}, - "providerType":{"shape":"ProviderType"}, - "displayName":{"shape":"String"}, - "targetUrl":{"shape":"TargetUrl"}, - "privateConnectionName":{"shape":"PrivateConnectionName"} - } - }, - "IntegrationSummaryList":{ - "type":"list", - "member":{"shape":"IntegrationSummary"} - }, - "InternalServerException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"} - }, - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true - }, - "IpAddressType":{ - "type":"string", - "enum":[ - "IPV4", - "IPV6", - "DUAL_STACK" - ] - }, - "JobStatus":{ - "type":"string", - "enum":[ - "IN_PROGRESS", - "STOPPING", - "STOPPED", - "FAILED", - "COMPLETED" - ] - }, - "KmsKeyId":{"type":"string"}, - "LambdaFunctionArn":{"type":"string"}, - "LambdaFunctionArns":{ - "type":"list", - "member":{"shape":"LambdaFunctionArn"} - }, - "ListAgentSpacesInput":{ - "type":"structure", - "members":{ - "nextToken":{"shape":"NextToken"}, - "maxResults":{"shape":"MaxResults"} - } - }, - "ListAgentSpacesOutput":{ - "type":"structure", - "members":{ - "agentSpaceSummaries":{"shape":"AgentSpaceSummaryList"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListApplicationsRequest":{ - "type":"structure", - "members":{ - "nextToken":{"shape":"NextToken"}, - "maxResults":{"shape":"MaxResults"} - } - }, - "ListApplicationsResponse":{ - "type":"structure", - "required":["applicationSummaries"], - "members":{ - "applicationSummaries":{"shape":"ApplicationSummaryList"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListArtifactsInput":{ - "type":"structure", - "required":["agentSpaceId"], - "members":{ - "agentSpaceId":{"shape":"AgentSpaceId"}, - "nextToken":{"shape":"NextToken"}, - "maxResults":{"shape":"MaxResults"} - } - }, - "ListArtifactsOutput":{ - "type":"structure", - "required":["artifactSummaries"], - "members":{ - "artifactSummaries":{"shape":"ArtifactSummaryList"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListCodeReviewJobTasksInput":{ - "type":"structure", - "required":["agentSpaceId"], - "members":{ - "agentSpaceId":{"shape":"String"}, - "maxResults":{"shape":"MaxResults"}, - "codeReviewJobId":{"shape":"String"}, - "stepName":{"shape":"StepName"}, - "categoryName":{"shape":"String"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListCodeReviewJobTasksOutput":{ - "type":"structure", - "members":{ - "codeReviewJobTaskSummaries":{"shape":"CodeReviewJobTaskSummaryList"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListCodeReviewJobsForCodeReviewInput":{ - "type":"structure", - "required":[ - "codeReviewId", - "agentSpaceId" - ], - "members":{ - "maxResults":{"shape":"MaxResults"}, - "codeReviewId":{"shape":"String"}, - "agentSpaceId":{"shape":"String"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListCodeReviewJobsForCodeReviewOutput":{ - "type":"structure", - "members":{ - "codeReviewJobSummaries":{"shape":"CodeReviewJobSummaryList"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListCodeReviewsInput":{ - "type":"structure", - "required":["agentSpaceId"], - "members":{ - "maxResults":{"shape":"MaxResults"}, - "nextToken":{"shape":"NextToken"}, - "agentSpaceId":{"shape":"String"} - } - }, - "ListCodeReviewsOutput":{ - "type":"structure", - "members":{ - "codeReviewSummaries":{"shape":"CodeReviewSummaryList"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListDiscoveredEndpointsInput":{ - "type":"structure", - "required":[ - "pentestJobId", - "agentSpaceId" - ], - "members":{ - "maxResults":{"shape":"MaxResults"}, - "pentestJobId":{"shape":"String"}, - "agentSpaceId":{"shape":"String"}, - "prefix":{"shape":"String"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListDiscoveredEndpointsOutput":{ - "type":"structure", - "members":{ - "discoveredEndpoints":{"shape":"DiscoveredEndpointList"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListFindingsInput":{ - "type":"structure", - "required":["agentSpaceId"], - "members":{ - "maxResults":{"shape":"MaxResults"}, - "pentestJobId":{"shape":"String"}, - "codeReviewJobId":{"shape":"String"}, - "agentSpaceId":{"shape":"String"}, - "nextToken":{"shape":"NextToken"}, - "riskType":{"shape":"String"}, - "riskLevel":{"shape":"RiskLevel"}, - "status":{"shape":"FindingStatus"}, - "confidence":{"shape":"ConfidenceLevel"}, - "name":{"shape":"String"} - } - }, - "ListFindingsOutput":{ - "type":"structure", - "members":{ - "findingsSummaries":{"shape":"FindingSummaryList"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListIntegratedResourcesInput":{ - "type":"structure", - "required":["agentSpaceId"], - "members":{ - "agentSpaceId":{"shape":"AgentSpaceId"}, - "integrationId":{"shape":"IntegrationId"}, - "resourceType":{"shape":"ResourceType"}, - "nextToken":{"shape":"NextToken"}, - "maxResults":{"shape":"MaxResults"} - } - }, - "ListIntegratedResourcesOutput":{ - "type":"structure", - "required":["integratedResourceSummaries"], - "members":{ - "integratedResourceSummaries":{"shape":"IntegratedResourceSummaryList"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListIntegrationsInput":{ - "type":"structure", - "members":{ - "filter":{"shape":"IntegrationFilter"}, - "nextToken":{"shape":"NextToken"}, - "maxResults":{"shape":"MaxResults"} - } - }, - "ListIntegrationsOutput":{ - "type":"structure", - "required":["integrationSummaries"], - "members":{ - "integrationSummaries":{"shape":"IntegrationSummaryList"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListMembershipsRequest":{ - "type":"structure", - "required":[ - "applicationId", - "agentSpaceId" - ], - "members":{ - "applicationId":{"shape":"ApplicationId"}, - "agentSpaceId":{"shape":"AgentSpaceId"}, - "memberType":{"shape":"MembershipTypeFilter"}, - "maxResults":{"shape":"MaxResults"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListMembershipsResponse":{ - "type":"structure", - "required":["membershipSummaries"], - "members":{ - "membershipSummaries":{"shape":"MembershipSummaryList"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListPentestJobTasksInput":{ - "type":"structure", - "required":["agentSpaceId"], - "members":{ - "agentSpaceId":{"shape":"String"}, - "maxResults":{"shape":"MaxResults"}, - "pentestJobId":{"shape":"String"}, - "stepName":{"shape":"StepName"}, - "categoryName":{"shape":"String"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListPentestJobTasksOutput":{ - "type":"structure", - "members":{ - "taskSummaries":{"shape":"TaskSummaryList"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListPentestJobsForPentestInput":{ - "type":"structure", - "required":[ - "pentestId", - "agentSpaceId" - ], - "members":{ - "maxResults":{"shape":"MaxResults"}, - "pentestId":{"shape":"String"}, - "agentSpaceId":{"shape":"String"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListPentestJobsForPentestOutput":{ - "type":"structure", - "members":{ - "pentestJobSummaries":{"shape":"PentestJobSummaryList"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListPentestsInput":{ - "type":"structure", - "required":["agentSpaceId"], - "members":{ - "maxResults":{"shape":"MaxResults"}, - "nextToken":{"shape":"NextToken"}, - "agentSpaceId":{"shape":"String"} - } - }, - "ListPentestsOutput":{ - "type":"structure", - "members":{ - "pentestSummaries":{"shape":"PentestSummaryList"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListPrivateConnectionsInput":{ - "type":"structure", - "members":{ - "maxResults":{"shape":"MaxResults"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListPrivateConnectionsOutput":{ - "type":"structure", - "required":["privateConnections"], - "members":{ - "privateConnections":{"shape":"PrivateConnectionList"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListSecurityRequirementPackFilter":{ - "type":"structure", - "members":{ - "managementType":{"shape":"ManagementType"}, - "status":{"shape":"SecurityRequirementPackStatus"} - } - }, - "ListSecurityRequirementPacksInput":{ - "type":"structure", - "members":{ - "filter":{"shape":"ListSecurityRequirementPackFilter"}, - "nextToken":{"shape":"NextToken"}, - "maxResults":{"shape":"MaxResults"} - } - }, - "ListSecurityRequirementPacksOutput":{ - "type":"structure", - "required":["securityRequirementPackSummaries"], - "members":{ - "securityRequirementPackSummaries":{"shape":"SecurityRequirementPackSummaryList"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListSecurityRequirementsInput":{ - "type":"structure", - "required":["packId"], - "members":{ - "packId":{"shape":"SecurityRequirementPackId"}, - "nextToken":{"shape":"NextToken"}, - "maxResults":{"shape":"MaxResults"} - } - }, - "ListSecurityRequirementsOutput":{ - "type":"structure", - "required":["securityRequirementSummaries"], - "members":{ - "securityRequirementSummaries":{"shape":"SecurityRequirementSummaryList"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListTagsForResourceInput":{ - "type":"structure", - "required":["resourceArn"], - "members":{ - "resourceArn":{ - "shape":"ResourceArn", - "location":"uri", - "locationName":"resourceArn" - } - } - }, - "ListTagsForResourceOutput":{ - "type":"structure", - "members":{ - "tags":{"shape":"TagMap"} - } - }, - "ListTargetDomainsInput":{ - "type":"structure", - "members":{ - "nextToken":{"shape":"NextToken"}, - "maxResults":{"shape":"MaxResults"} - } - }, - "ListTargetDomainsOutput":{ - "type":"structure", - "members":{ - "targetDomainSummaries":{"shape":"TargetDomainSummaryList"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListThreatModelJobTasksInput":{ - "type":"structure", - "required":[ - "agentSpaceId", - "threatModelJobId" - ], - "members":{ - "agentSpaceId":{"shape":"String"}, - "maxResults":{"shape":"MaxResults"}, - "threatModelJobId":{"shape":"String"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListThreatModelJobTasksOutput":{ - "type":"structure", - "members":{ - "threatModelJobTaskSummaries":{"shape":"ThreatModelJobTaskSummaryList"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListThreatModelJobsInput":{ - "type":"structure", - "required":[ - "threatModelId", - "agentSpaceId" - ], - "members":{ - "maxResults":{"shape":"MaxResults"}, - "threatModelId":{"shape":"String"}, - "agentSpaceId":{"shape":"String"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListThreatModelJobsOutput":{ - "type":"structure", - "members":{ - "threatModelJobSummaries":{"shape":"ThreatModelJobSummaryList"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListThreatModelsInput":{ - "type":"structure", - "required":["agentSpaceId"], - "members":{ - "maxResults":{"shape":"MaxResults"}, - "nextToken":{"shape":"NextToken"}, - "agentSpaceId":{"shape":"String"} - } - }, - "ListThreatModelsOutput":{ - "type":"structure", - "members":{ - "threatModelSummaries":{"shape":"ThreatModelSummaryList"}, - "nextToken":{"shape":"NextToken"} - } - }, - "ListThreatsInput":{ - "type":"structure", - "required":[ - "threatJobId", - "agentSpaceId" - ], - "members":{ - "threatJobId":{"shape":"String"}, - "agentSpaceId":{"shape":"String"}, - "nextToken":{"shape":"NextToken"}, - "maxResults":{"shape":"MaxResults"} - } - }, - "ListThreatsOutput":{ - "type":"structure", - "members":{ - "threats":{"shape":"ThreatSummaryList"}, - "nextToken":{"shape":"NextToken"} - } - }, - "Location":{"type":"string"}, - "LogGroupArn":{"type":"string"}, - "LogGroupArns":{ - "type":"list", - "member":{"shape":"LogGroupArn"} - }, - "LogLocation":{ - "type":"structure", - "members":{ - "logType":{"shape":"LogType"}, - "cloudWatchLog":{"shape":"CloudWatchLog"} - } - }, - "LogType":{ - "type":"string", - "enum":["CLOUDWATCH"] - }, - "ManagementType":{ - "type":"string", - "enum":[ - "AWS_MANAGED", - "CUSTOMER_MANAGED" - ] - }, - "MaxIpv4AddressesPerEni":{ - "type":"integer", - "box":true - }, - "MaxResults":{ - "type":"integer", - "box":true - }, - "MemberMetadata":{ - "type":"structure", - "members":{ - "user":{"shape":"UserMetadata"} - }, - "union":true - }, - "MembershipConfig":{ - "type":"structure", - "members":{ - "user":{"shape":"UserConfig"} - }, - "union":true - }, - "MembershipId":{"type":"string"}, - "MembershipSummary":{ - "type":"structure", - "required":[ - "membershipId", - "applicationId", - "agentSpaceId", - "memberType", - "createdAt", - "updatedAt", - "createdBy", - "updatedBy" - ], - "members":{ - "membershipId":{"shape":"MembershipId"}, - "applicationId":{"shape":"ApplicationId"}, - "agentSpaceId":{"shape":"AgentSpaceId"}, - "memberType":{"shape":"MembershipType"}, - "config":{"shape":"MembershipConfig"}, - "metadata":{"shape":"MemberMetadata"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"}, - "createdBy":{"shape":"String"}, - "updatedBy":{"shape":"String"} - } - }, - "MembershipSummaryList":{ - "type":"list", - "member":{"shape":"MembershipSummary"} - }, - "MembershipType":{ - "type":"string", - "enum":["USER"] - }, - "MembershipTypeFilter":{ - "type":"string", - "enum":[ - "USER", - "ALL" - ] - }, - "NetworkTrafficConfig":{ - "type":"structure", - "members":{ - "rules":{"shape":"NetworkTrafficRuleList"}, - "customHeaders":{"shape":"CustomHeaderList"} - } - }, - "NetworkTrafficRule":{ - "type":"structure", - "members":{ - "effect":{"shape":"NetworkTrafficRuleEffect"}, - "pattern":{"shape":"String"}, - "networkTrafficRuleType":{"shape":"NetworkTrafficRuleType"} - } - }, - "NetworkTrafficRuleEffect":{ - "type":"string", - "enum":[ - "ALLOW", - "DENY" - ] - }, - "NetworkTrafficRuleList":{ - "type":"list", - "member":{"shape":"NetworkTrafficRule"} - }, - "NetworkTrafficRuleType":{ - "type":"string", - "enum":["URL"] - }, - "NextToken":{"type":"string"}, - "Pentest":{ - "type":"structure", - "required":[ - "pentestId", - "agentSpaceId", - "title", - "assets" - ], - "members":{ - "pentestId":{"shape":"String"}, - "agentSpaceId":{"shape":"String"}, - "title":{"shape":"String"}, - "assets":{"shape":"Assets"}, - "excludeRiskTypes":{"shape":"RiskTypeList"}, - "serviceRole":{"shape":"ServiceRole"}, - "logConfig":{"shape":"CloudWatchLog"}, - "vpcConfig":{"shape":"VpcConfig"}, - "networkTrafficConfig":{"shape":"NetworkTrafficConfig"}, - "codeRemediationStrategy":{"shape":"CodeRemediationStrategy"}, - "cleanUpStrategy":{"shape":"CleanUpStrategy"}, - "disableManagedSkills":{"shape":"SkillTypeList"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"} - } - }, - "PentestIdList":{ - "type":"list", - "member":{"shape":"String"} - }, - "PentestJob":{ - "type":"structure", - "members":{ - "pentestJobId":{"shape":"String"}, - "pentestId":{"shape":"String"}, - "title":{"shape":"String"}, - "overview":{"shape":"String"}, - "status":{"shape":"JobStatus"}, - "endpoints":{"shape":"EndpointList"}, - "actors":{"shape":"ActorList"}, - "documents":{"shape":"DocumentList"}, - "sourceCode":{"shape":"SourceCodeRepositoryList"}, - "excludePaths":{"shape":"EndpointList"}, - "allowedDomains":{"shape":"EndpointList"}, - "excludeRiskTypes":{"shape":"RiskTypeList"}, - "steps":{"shape":"StepList"}, - "executionContext":{"shape":"ExecutionContextList"}, - "serviceRole":{"shape":"ServiceRole"}, - "logConfig":{"shape":"CloudWatchLog"}, - "vpcConfig":{"shape":"VpcConfig"}, - "networkTrafficConfig":{"shape":"NetworkTrafficConfig"}, - "errorInformation":{"shape":"ErrorInformation"}, - "integratedRepositories":{"shape":"IntegratedRepositoryList"}, - "codeRemediationStrategy":{"shape":"CodeRemediationStrategy"}, - "cleanUpStrategy":{"shape":"CleanUpStrategy"}, - "disableManagedSkills":{"shape":"SkillTypeList"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"} - } - }, - "PentestJobIdList":{ - "type":"list", - "member":{"shape":"String"} - }, - "PentestJobList":{ - "type":"list", - "member":{"shape":"PentestJob"} - }, - "PentestJobSummary":{ - "type":"structure", - "required":[ - "pentestJobId", - "pentestId" - ], - "members":{ - "pentestJobId":{"shape":"String"}, - "pentestId":{"shape":"String"}, - "title":{"shape":"String"}, - "status":{"shape":"JobStatus"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"} - } - }, - "PentestJobSummaryList":{ - "type":"list", - "member":{"shape":"PentestJobSummary"} - }, - "PentestList":{ - "type":"list", - "member":{"shape":"Pentest"} - }, - "PentestSummary":{ - "type":"structure", - "required":[ - "pentestId", - "agentSpaceId", - "title" - ], - "members":{ - "pentestId":{"shape":"String"}, - "agentSpaceId":{"shape":"String"}, - "title":{"shape":"String"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"} - } - }, - "PentestSummaryList":{ - "type":"list", - "member":{"shape":"PentestSummary"} - }, - "PortRange":{"type":"string"}, - "PortRanges":{ - "type":"list", - "member":{"shape":"PortRange"} - }, - "PrivateConnectionList":{ - "type":"list", - "member":{"shape":"PrivateConnectionSummary"} - }, - "PrivateConnectionMode":{ - "type":"structure", - "members":{ - "serviceManaged":{"shape":"ServiceManagedInput"}, - "selfManaged":{"shape":"SelfManagedInput"} - }, - "union":true - }, - "PrivateConnectionName":{"type":"string"}, - "PrivateConnectionSecurityGroupId":{"type":"string"}, - "PrivateConnectionSecurityGroupIds":{ - "type":"list", - "member":{"shape":"PrivateConnectionSecurityGroupId"} - }, - "PrivateConnectionStatus":{ - "type":"string", - "enum":[ - "ACTIVE", - "CREATE_IN_PROGRESS", - "CREATE_FAILED", - "DELETE_IN_PROGRESS", - "DELETE_FAILED" - ] - }, - "PrivateConnectionSubnetId":{"type":"string"}, - "PrivateConnectionSubnetIds":{ - "type":"list", - "member":{"shape":"PrivateConnectionSubnetId"} - }, - "PrivateConnectionSummary":{ - "type":"structure", - "required":[ - "name", - "type", - "status" - ], - "members":{ - "name":{"shape":"PrivateConnectionName"}, - "type":{"shape":"PrivateConnectionType"}, - "status":{"shape":"PrivateConnectionStatus"}, - "resourceGatewayId":{"shape":"ResourceGatewayId"}, - "hostAddress":{"shape":"HostAddress"}, - "vpcId":{"shape":"PrivateConnectionVpcId"}, - "resourceConfigurationId":{"shape":"ResourceConfigurationId"}, - "certificateExpiryTime":{"shape":"SyntheticTimestamp_date_time"}, - "dnsResolution":{"shape":"ResourceConfigDnsResolution"}, - "failureMessage":{"shape":"String"}, - "tags":{"shape":"TagMap"} - } - }, - "PrivateConnectionType":{ - "type":"string", - "enum":[ - "SERVICE_MANAGED", - "SELF_MANAGED" - ] - }, - "PrivateConnectionVpcId":{"type":"string"}, - "Provider":{ - "type":"string", - "enum":[ - "GITHUB", - "GITLAB", - "BITBUCKET", - "CONFLUENCE" - ] - }, - "ProviderInput":{ - "type":"structure", - "members":{ - "github":{"shape":"GitHubIntegrationInput"}, - "gitlab":{"shape":"GitLabIntegrationInput"}, - "bitbucket":{"shape":"BitbucketIntegrationInput"}, - "confluence":{"shape":"ConfluenceIntegrationInput"} - }, - "union":true - }, - "ProviderResourceCapabilities":{ - "type":"structure", - "members":{ - "github":{"shape":"GitHubResourceCapabilities"}, - "gitlab":{"shape":"GitLabResourceCapabilities"}, - "bitbucket":{"shape":"BitbucketResourceCapabilities"}, - "confluence":{"shape":"ConfluenceResourceCapabilities"} - }, - "union":true - }, - "ProviderResourceId":{"type":"string"}, - "ProviderResourceName":{"type":"string"}, - "ProviderType":{ - "type":"string", - "enum":[ - "SOURCE_CODE", - "DOCUMENTATION" - ] - }, - "ReportDestination":{ - "type":"structure", - "required":[ - "integrationId", - "containerId" - ], - "members":{ - "integrationId":{"shape":"String"}, - "containerId":{"shape":"String"}, - "parentId":{"shape":"String"}, - "documentId":{"shape":"String"} - } - }, - "ResourceArn":{"type":"string"}, - "ResourceConfigDnsResolution":{ - "type":"string", - "enum":[ - "PUBLIC", - "IN_VPC" - ] - }, - "ResourceConfigurationId":{"type":"string"}, - "ResourceGatewayId":{"type":"string"}, - "ResourceNotFoundException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"} - }, - "error":{ - "httpStatusCode":404, - "senderFault":true - }, - "exception":true - }, - "ResourceType":{ - "type":"string", - "enum":[ - "CODE_REPOSITORY", - "DOCUMENT" - ] - }, - "RiskLevel":{ - "type":"string", - "enum":[ - "UNKNOWN", - "INFORMATIONAL", - "LOW", - "MEDIUM", - "HIGH", - "CRITICAL" - ] - }, - "RiskType":{ - "type":"string", - "enum":[ - "CROSS_SITE_SCRIPTING", - "DEFAULT_CREDENTIALS", - "INSECURE_DIRECT_OBJECT_REFERENCE", - "PRIVILEGE_ESCALATION", - "SERVER_SIDE_TEMPLATE_INJECTION", - "COMMAND_INJECTION", - "CODE_INJECTION", - "SQL_INJECTION", - "ARBITRARY_FILE_UPLOAD", - "INSECURE_DESERIALIZATION", - "LOCAL_FILE_INCLUSION", - "INFORMATION_DISCLOSURE", - "PATH_TRAVERSAL", - "SERVER_SIDE_REQUEST_FORGERY", - "JSON_WEB_TOKEN_VULNERABILITIES", - "XML_EXTERNAL_ENTITY", - "FILE_DELETION", - "OTHER", - "GRAPHQL_VULNERABILITIES", - "BUSINESS_LOGIC_VULNERABILITIES", - "CRYPTOGRAPHIC_VULNERABILITIES", - "DENIAL_OF_SERVICE", - "FILE_ACCESS", - "FILE_CREATION", - "DATABASE_MODIFICATION", - "DATABASE_ACCESS", - "OUTBOUND_SERVICE_REQUEST", - "UNKNOWN" - ] - }, - "RiskTypeList":{ - "type":"list", - "member":{"shape":"RiskType"} - }, - "RoleArn":{"type":"string"}, - "S3BucketArn":{"type":"string"}, - "S3BucketArns":{ - "type":"list", - "member":{"shape":"S3BucketArn"} - }, - "SecretArn":{"type":"string"}, - "SecretArns":{ - "type":"list", - "member":{"shape":"SecretArn"} - }, - "SecurityGroupArn":{"type":"string"}, - "SecurityGroupArns":{ - "type":"list", - "member":{"shape":"SecurityGroupArn"} - }, - "SecurityRequirementArtifact":{ - "type":"structure", - "required":[ - "name", - "format", - "content" - ], - "members":{ - "name":{"shape":"SecurityRequirementArtifactName"}, - "format":{"shape":"SecurityRequirementArtifactFormat"}, - "content":{"shape":"SecurityRequirementDocumentContent"} - } - }, - "SecurityRequirementArtifactFormat":{ - "type":"string", - "enum":[ - "MD", - "PDF", - "TXT", - "DOCX", - "DOC" - ] - }, - "SecurityRequirementArtifactList":{ - "type":"list", - "member":{"shape":"SecurityRequirementArtifact"} - }, - "SecurityRequirementArtifactName":{"type":"string"}, - "SecurityRequirementDocumentContent":{ - "type":"blob", - "sensitive":true - }, - "SecurityRequirementName":{"type":"string"}, - "SecurityRequirementNameList":{ - "type":"list", - "member":{"shape":"SecurityRequirementName"} - }, - "SecurityRequirementPackId":{"type":"string"}, - "SecurityRequirementPackImportStatus":{ - "type":"string", - "enum":[ - "PENDING", - "IN_PROGRESS", - "FAILED", - "COMPLETED" - ] - }, - "SecurityRequirementPackName":{"type":"string"}, - "SecurityRequirementPackStatus":{ - "type":"string", - "enum":[ - "ENABLED", - "DISABLED" - ] - }, - "SecurityRequirementPackSummary":{ - "type":"structure", - "required":[ - "packId", - "name", - "managementType", - "status", - "createdAt", - "updatedAt" - ], - "members":{ - "packId":{"shape":"SecurityRequirementPackId"}, - "name":{"shape":"SecurityRequirementPackName"}, - "description":{"shape":"String"}, - "vendorName":{"shape":"String"}, - "managementType":{"shape":"ManagementType"}, - "status":{"shape":"SecurityRequirementPackStatus"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"} - } - }, - "SecurityRequirementPackSummaryList":{ - "type":"list", - "member":{"shape":"SecurityRequirementPackSummary"} - }, - "SecurityRequirementSummary":{ - "type":"structure", - "required":[ - "packId", - "name", - "description", - "createdAt", - "updatedAt" - ], - "members":{ - "packId":{"shape":"SecurityRequirementPackId"}, - "name":{"shape":"SecurityRequirementName"}, - "description":{"shape":"String"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"} - } - }, - "SecurityRequirementSummaryList":{ - "type":"list", - "member":{"shape":"SecurityRequirementSummary"} - }, - "SelfManagedInput":{ - "type":"structure", - "required":["resourceConfigurationId"], - "members":{ - "resourceConfigurationId":{"shape":"ResourceConfigurationId"}, - "certificate":{"shape":"CertificateChain"} - } - }, - "SensitiveEmail":{"type":"string"}, - "ServiceManagedInput":{ - "type":"structure", - "required":[ - "hostAddress", - "vpcId", - "subnetIds" - ], - "members":{ - "hostAddress":{"shape":"HostAddress"}, - "vpcId":{"shape":"PrivateConnectionVpcId"}, - "subnetIds":{"shape":"PrivateConnectionSubnetIds"}, - "securityGroupIds":{"shape":"PrivateConnectionSecurityGroupIds"}, - "ipAddressType":{"shape":"IpAddressType"}, - "ipv4AddressesPerEni":{"shape":"MaxIpv4AddressesPerEni"}, - "portRanges":{"shape":"PortRanges"}, - "certificate":{"shape":"CertificateChain"}, - "dnsResolution":{"shape":"ResourceConfigDnsResolution"} - } - }, - "ServiceQuotaExceededException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"} - }, - "error":{ - "httpStatusCode":402, - "senderFault":true - }, - "exception":true - }, - "ServiceRole":{"type":"string"}, - "SkillType":{ - "type":"string", - "enum":[ - "FINDING_PERSONALIZATION", - "LOGIN_OPTIMIZATION" - ] - }, - "SkillTypeList":{ - "type":"list", - "member":{"shape":"SkillType"} - }, - "SourceCodeRepository":{ - "type":"structure", - "members":{ - "s3Location":{"shape":"String"} - } - }, - "SourceCodeRepositoryList":{ - "type":"list", - "member":{"shape":"SourceCodeRepository"} - }, - "StartCodeRemediationInput":{ - "type":"structure", - "required":[ - "agentSpaceId", - "findingIds" - ], - "members":{ - "agentSpaceId":{"shape":"String"}, - "pentestJobId":{"shape":"String"}, - "codeReviewJobId":{"shape":"String"}, - "findingIds":{"shape":"FindingIdList"} - } - }, - "StartCodeRemediationOutput":{ - "type":"structure", - "members":{} - }, - "StartCodeReviewJobInput":{ - "type":"structure", - "required":[ - "agentSpaceId", - "codeReviewId" - ], - "members":{ - "agentSpaceId":{"shape":"String"}, - "codeReviewId":{"shape":"String"}, - "diffSource":{"shape":"DiffSource"} - } - }, - "StartCodeReviewJobOutput":{ - "type":"structure", - "required":[ - "codeReviewId", - "codeReviewJobId" - ], - "members":{ - "title":{"shape":"String"}, - "status":{"shape":"JobStatus"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"}, - "codeReviewId":{"shape":"String"}, - "codeReviewJobId":{"shape":"String"}, - "agentSpaceId":{"shape":"String"} - } - }, - "StartPentestJobInput":{ - "type":"structure", - "required":[ - "agentSpaceId", - "pentestId" - ], - "members":{ - "agentSpaceId":{"shape":"String"}, - "pentestId":{"shape":"String"} - } - }, - "StartPentestJobOutput":{ - "type":"structure", - "members":{ - "title":{"shape":"String"}, - "status":{"shape":"JobStatus"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"}, - "pentestId":{"shape":"String"}, - "pentestJobId":{"shape":"String"}, - "agentSpaceId":{"shape":"String"} - } - }, - "StartThreatModelJobInput":{ - "type":"structure", - "required":[ - "agentSpaceId", - "threatModelId" - ], - "members":{ - "agentSpaceId":{"shape":"String"}, - "threatModelId":{"shape":"String"} - } - }, - "StartThreatModelJobOutput":{ - "type":"structure", - "required":["threatModelJobId"], - "members":{ - "title":{"shape":"String"}, - "status":{"shape":"JobStatus"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"}, - "threatModelId":{"shape":"String"}, - "threatModelJobId":{"shape":"String"}, - "agentSpaceId":{"shape":"String"} - } - }, - "Step":{ - "type":"structure", - "members":{ - "name":{"shape":"StepName"}, - "status":{"shape":"StepStatus"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"} - } - }, - "StepList":{ - "type":"list", - "member":{"shape":"Step"} - }, - "StepName":{ - "type":"string", - "enum":[ - "PREFLIGHT", - "STATIC_ANALYSIS", - "PENTEST", - "FINALIZING", - "VALIDATION" - ] - }, - "StepStatus":{ - "type":"string", - "enum":[ - "NOT_STARTED", - "IN_PROGRESS", - "COMPLETED", - "FAILED", - "STOPPED" - ] - }, - "StopCodeReviewJobInput":{ - "type":"structure", - "required":[ - "agentSpaceId", - "codeReviewJobId" - ], - "members":{ - "agentSpaceId":{"shape":"String"}, - "codeReviewJobId":{"shape":"String"} - } - }, - "StopCodeReviewJobOutput":{ - "type":"structure", - "members":{} - }, - "StopPentestJobInput":{ - "type":"structure", - "required":[ - "agentSpaceId", - "pentestJobId" - ], - "members":{ - "agentSpaceId":{"shape":"String"}, - "pentestJobId":{"shape":"String"} - } - }, - "StopPentestJobOutput":{ - "type":"structure", - "members":{} - }, - "StopThreatModelJobInput":{ - "type":"structure", - "required":[ - "agentSpaceId", - "threatModelJobId" - ], - "members":{ - "agentSpaceId":{"shape":"String"}, - "threatModelJobId":{"shape":"String"} - } - }, - "StopThreatModelJobOutput":{ - "type":"structure", - "members":{} - }, - "StrideCategory":{ - "type":"string", - "enum":[ - "SPOOFING", - "TAMPERING", - "REPUDIATION", - "INFORMATION_DISCLOSURE", - "DENIAL_OF_SERVICE", - "ELEVATION_OF_PRIVILEGE" - ] - }, - "StrideCategoryList":{ - "type":"list", - "member":{"shape":"StrideCategory"} - }, - "String":{"type":"string"}, - "StringList":{ - "type":"list", - "member":{"shape":"String"} - }, - "SubnetArn":{"type":"string"}, - "SubnetArns":{ - "type":"list", - "member":{"shape":"SubnetArn"} - }, - "SyntheticTimestamp_date_time":{ - "type":"timestamp", - "timestampFormat":"iso8601" - }, - "TagKey":{"type":"string"}, - "TagKeyList":{ - "type":"list", - "member":{"shape":"TagKey"} - }, - "TagMap":{ - "type":"map", - "key":{"shape":"TagKey"}, - "value":{"shape":"TagValue"} - }, - "TagResourceInput":{ - "type":"structure", - "required":[ - "resourceArn", - "tags" - ], - "members":{ - "resourceArn":{ - "shape":"ResourceArn", - "location":"uri", - "locationName":"resourceArn" - }, - "tags":{"shape":"TagMap"} - } - }, - "TagResourceOutput":{ - "type":"structure", - "members":{} - }, - "TagValue":{"type":"string"}, - "TargetDomain":{ - "type":"structure", - "required":[ - "targetDomainId", - "domainName" - ], - "members":{ - "targetDomainId":{"shape":"TargetDomainId"}, - "domainName":{"shape":"String"}, - "verificationStatus":{"shape":"TargetDomainStatus"}, - "verificationStatusReason":{"shape":"String"}, - "verificationDetails":{"shape":"VerificationDetails"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "verifiedAt":{"shape":"SyntheticTimestamp_date_time"} - } - }, - "TargetDomainId":{"type":"string"}, - "TargetDomainIdList":{ - "type":"list", - "member":{"shape":"String"} - }, - "TargetDomainList":{ - "type":"list", - "member":{"shape":"TargetDomain"} - }, - "TargetDomainStatus":{ - "type":"string", - "enum":[ - "PENDING", - "VERIFIED", - "FAILED", - "UNREACHABLE" - ] - }, - "TargetDomainSummary":{ - "type":"structure", - "required":[ - "targetDomainId", - "domainName" - ], - "members":{ - "targetDomainId":{"shape":"TargetDomainId"}, - "domainName":{"shape":"String"}, - "verificationStatus":{"shape":"TargetDomainStatus"} - } - }, - "TargetDomainSummaryList":{ - "type":"list", - "member":{"shape":"TargetDomainSummary"} - }, - "TargetUrl":{"type":"string"}, - "Task":{ - "type":"structure", - "required":["taskId"], - "members":{ - "taskId":{"shape":"String"}, - "pentestId":{"shape":"String"}, - "pentestJobId":{"shape":"String"}, - "agentSpaceId":{"shape":"String"}, - "title":{"shape":"String"}, - "description":{"shape":"String"}, - "categories":{"shape":"CategoryList"}, - "riskType":{"shape":"RiskType"}, - "targetEndpoint":{"shape":"Endpoint"}, - "executionStatus":{"shape":"TaskExecutionStatus"}, - "logsLocation":{"shape":"LogLocation"}, - "taskHours":{"shape":"Double"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"} - } - }, - "TaskExecutionStatus":{ - "type":"string", - "enum":[ - "IN_PROGRESS", - "ABORTED", - "COMPLETED", - "INTERNAL_ERROR", - "FAILED" - ] - }, - "TaskIdList":{ - "type":"list", - "member":{"shape":"String"} - }, - "TaskList":{ - "type":"list", - "member":{"shape":"Task"} - }, - "TaskSummary":{ - "type":"structure", - "required":["taskId"], - "members":{ - "taskId":{"shape":"String"}, - "pentestId":{"shape":"String"}, - "pentestJobId":{"shape":"String"}, - "agentSpaceId":{"shape":"String"}, - "title":{"shape":"String"}, - "riskType":{"shape":"RiskType"}, - "executionStatus":{"shape":"TaskExecutionStatus"}, - "taskHours":{"shape":"Double"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"} - } - }, - "TaskSummaryList":{ - "type":"list", - "member":{"shape":"TaskSummary"} - }, - "Threat":{ - "type":"structure", - "members":{ - "threatId":{"shape":"String"}, - "threatJobId":{"shape":"String"}, - "title":{"shape":"String"}, - "statement":{"shape":"String"}, - "severity":{"shape":"ThreatSeverity"}, - "status":{"shape":"ThreatStatus"}, - "comments":{"shape":"String"}, - "threatSource":{"shape":"String"}, - "prerequisites":{"shape":"String"}, - "threatAction":{"shape":"String"}, - "threatImpact":{"shape":"String"}, - "impactedGoal":{"shape":"StringList"}, - "impactedAssets":{"shape":"StringList"}, - "anchor":{"shape":"ThreatAnchorShape"}, - "evidence":{"shape":"ThreatEvidenceList"}, - "stride":{"shape":"StrideCategoryList"}, - "recommendation":{"shape":"String"}, - "createdBy":{"shape":"ThreatActor"}, - "updatedBy":{"shape":"ThreatActor"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"} - } - }, - "ThreatActor":{ - "type":"string", - "enum":[ - "CUSTOMER", - "AGENT" - ] - }, - "ThreatAnchorShape":{ - "type":"structure", - "members":{ - "kind":{"shape":"String"}, - "id":{"shape":"String"}, - "packageId":{"shape":"String"} - } - }, - "ThreatEvidenceList":{ - "type":"list", - "member":{"shape":"ThreatEvidenceShape"} - }, - "ThreatEvidenceShape":{ - "type":"structure", - "members":{ - "packageId":{"shape":"String"}, - "path":{"shape":"String"} - } - }, - "ThreatIdList":{ - "type":"list", - "member":{"shape":"String"} - }, - "ThreatList":{ - "type":"list", - "member":{"shape":"Threat"} - }, - "ThreatModel":{ - "type":"structure", - "required":[ - "threatModelId", - "agentSpaceId", - "title", - "assets" - ], - "members":{ - "threatModelId":{"shape":"String"}, - "agentSpaceId":{"shape":"String"}, - "title":{"shape":"String"}, - "description":{"shape":"String"}, - "assets":{"shape":"Assets"}, - "scopeDocs":{"shape":"DocumentList"}, - "serviceRole":{"shape":"ServiceRole"}, - "logConfig":{"shape":"CloudWatchLog"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"} - } - }, - "ThreatModelIdList":{ - "type":"list", - "member":{"shape":"String"} - }, - "ThreatModelJob":{ - "type":"structure", - "members":{ - "threatModelJobId":{"shape":"String"}, - "threatModelId":{"shape":"String"}, - "agentSpaceId":{"shape":"String"}, - "title":{"shape":"String"}, - "status":{"shape":"JobStatus"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"}, - "executionStartTime":{"shape":"SyntheticTimestamp_date_time"}, - "executionEndTime":{"shape":"SyntheticTimestamp_date_time"}, - "sourceCode":{"shape":"SourceCodeRepositoryList"}, - "integratedRepositories":{"shape":"IntegratedRepositoryList"}, - "documents":{"shape":"DocumentList"}, - "scopeDocs":{"shape":"DocumentList"}, - "errorInformation":{"shape":"ErrorInformation"}, - "systemOverview":{"shape":"String"} - } - }, - "ThreatModelJobIdList":{ - "type":"list", - "member":{"shape":"String"} - }, - "ThreatModelJobList":{ - "type":"list", - "member":{"shape":"ThreatModelJob"} - }, - "ThreatModelJobSummary":{ - "type":"structure", - "required":[ - "threatModelJobId", - "threatModelId" - ], - "members":{ - "threatModelJobId":{"shape":"String"}, - "threatModelId":{"shape":"String"}, - "agentSpaceId":{"shape":"String"}, - "title":{"shape":"String"}, - "status":{"shape":"JobStatus"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"} - } - }, - "ThreatModelJobSummaryList":{ - "type":"list", - "member":{"shape":"ThreatModelJobSummary"} - }, - "ThreatModelJobTask":{ - "type":"structure", - "required":["taskId"], - "members":{ - "taskId":{"shape":"String"}, - "threatModelId":{"shape":"String"}, - "threatModelJobId":{"shape":"String"}, - "agentSpaceId":{"shape":"String"}, - "title":{"shape":"String"}, - "description":{"shape":"String"}, - "executionStatus":{"shape":"TaskExecutionStatus"}, - "logsLocation":{"shape":"LogLocation"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"} - } - }, - "ThreatModelJobTaskList":{ - "type":"list", - "member":{"shape":"ThreatModelJobTask"} - }, - "ThreatModelJobTaskSummary":{ - "type":"structure", - "required":["taskId"], - "members":{ - "taskId":{"shape":"String"}, - "threatModelId":{"shape":"String"}, - "threatModelJobId":{"shape":"String"}, - "agentSpaceId":{"shape":"String"}, - "title":{"shape":"String"}, - "executionStatus":{"shape":"TaskExecutionStatus"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"} - } - }, - "ThreatModelJobTaskSummaryList":{ - "type":"list", - "member":{"shape":"ThreatModelJobTaskSummary"} - }, - "ThreatModelList":{ - "type":"list", - "member":{"shape":"ThreatModel"} - }, - "ThreatModelSummary":{ - "type":"structure", - "required":[ - "threatModelId", - "agentSpaceId", - "title" - ], - "members":{ - "threatModelId":{"shape":"String"}, - "agentSpaceId":{"shape":"String"}, - "title":{"shape":"String"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"} - } - }, - "ThreatModelSummaryList":{ - "type":"list", - "member":{"shape":"ThreatModelSummary"} - }, - "ThreatSeverity":{ - "type":"string", - "enum":[ - "CRITICAL", - "HIGH", - "MEDIUM", - "LOW", - "INFO" - ] - }, - "ThreatStatus":{ - "type":"string", - "enum":[ - "OPEN", - "RESOLVED", - "DISMISSED" - ] - }, - "ThreatSummary":{ - "type":"structure", - "members":{ - "threatId":{"shape":"String"}, - "threatJobId":{"shape":"String"}, - "title":{"shape":"String"}, - "statement":{"shape":"String"}, - "severity":{"shape":"ThreatSeverity"}, - "status":{"shape":"ThreatStatus"}, - "stride":{"shape":"StrideCategoryList"}, - "createdBy":{"shape":"ThreatActor"}, - "updatedBy":{"shape":"ThreatActor"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"} - } - }, - "ThreatSummaryList":{ - "type":"list", - "member":{"shape":"ThreatSummary"} - }, - "ThrottlingException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"}, - "serviceCode":{"shape":"String"}, - "quotaCode":{"shape":"String"} - }, - "error":{ - "httpStatusCode":429, - "senderFault":true - }, - "exception":true - }, - "UntagResourceInput":{ - "type":"structure", - "required":[ - "resourceArn", - "tagKeys" - ], - "members":{ - "resourceArn":{ - "shape":"ResourceArn", - "location":"uri", - "locationName":"resourceArn" - }, - "tagKeys":{ - "shape":"TagKeyList", - "location":"querystring", - "locationName":"tagKeys" - } - } - }, - "UntagResourceOutput":{ - "type":"structure", - "members":{} - }, - "UpdateAgentSpaceInput":{ - "type":"structure", - "required":["agentSpaceId"], - "members":{ - "agentSpaceId":{"shape":"AgentSpaceId"}, - "name":{"shape":"AgentName"}, - "description":{"shape":"String"}, - "awsResources":{"shape":"AWSResources"}, - "targetDomainIds":{"shape":"TargetDomainIdList"}, - "codeReviewSettings":{"shape":"CodeReviewSettings"} - } - }, - "UpdateAgentSpaceOutput":{ - "type":"structure", - "required":[ - "agentSpaceId", - "name" - ], - "members":{ - "agentSpaceId":{"shape":"AgentSpaceId"}, - "name":{"shape":"AgentName"}, - "description":{"shape":"String"}, - "awsResources":{"shape":"AWSResources"}, - "targetDomainIds":{"shape":"TargetDomainIdList"}, - "codeReviewSettings":{"shape":"CodeReviewSettings"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"} - } - }, - "UpdateApplicationRequest":{ - "type":"structure", - "required":["applicationId"], - "members":{ - "applicationId":{"shape":"ApplicationId"}, - "roleArn":{"shape":"RoleArn"}, - "defaultKmsKeyId":{"shape":"DefaultKmsKeyId"} - } - }, - "UpdateApplicationResponse":{ - "type":"structure", - "required":["applicationId"], - "members":{ - "applicationId":{"shape":"ApplicationId"} - } - }, - "UpdateCodeReviewInput":{ - "type":"structure", - "required":[ - "codeReviewId", - "agentSpaceId" - ], - "members":{ - "codeReviewId":{"shape":"String"}, - "agentSpaceId":{"shape":"String"}, - "title":{"shape":"String"}, - "assets":{"shape":"Assets"}, - "serviceRole":{"shape":"ServiceRole"}, - "logConfig":{"shape":"CloudWatchLog"}, - "codeRemediationStrategy":{"shape":"CodeRemediationStrategy"}, - "validationMode":{"shape":"ValidationMode"} - } - }, - "UpdateCodeReviewOutput":{ - "type":"structure", - "required":["codeReviewId"], - "members":{ - "codeReviewId":{"shape":"String"}, - "title":{"shape":"String"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"}, - "assets":{"shape":"Assets"}, - "serviceRole":{"shape":"ServiceRole"}, - "logConfig":{"shape":"CloudWatchLog"}, - "agentSpaceId":{"shape":"String"}, - "codeRemediationStrategy":{"shape":"CodeRemediationStrategy"}, - "validationMode":{"shape":"ValidationMode"} - } - }, - "UpdateFindingInput":{ - "type":"structure", - "required":[ - "findingId", - "agentSpaceId" - ], - "members":{ - "findingId":{"shape":"String"}, - "agentSpaceId":{"shape":"String"}, - "name":{"shape":"String"}, - "description":{"shape":"String"}, - "riskType":{"shape":"String"}, - "riskLevel":{"shape":"RiskLevel"}, - "riskScore":{"shape":"String"}, - "attackScript":{"shape":"String"}, - "reasoning":{"shape":"String"}, - "status":{"shape":"FindingStatus"}, - "customerNote":{"shape":"String"} - } - }, - "UpdateFindingOutput":{ - "type":"structure", - "members":{} - }, - "UpdateIntegratedResourcesInput":{ - "type":"structure", - "required":[ - "agentSpaceId", - "integrationId", - "items" - ], - "members":{ - "agentSpaceId":{"shape":"AgentSpaceId"}, - "integrationId":{"shape":"IntegrationId"}, - "items":{"shape":"IntegratedResourceInputItemList"} - } - }, - "UpdateIntegratedResourcesOutput":{ - "type":"structure", - "members":{} - }, - "UpdatePentestInput":{ - "type":"structure", - "required":[ - "pentestId", - "agentSpaceId" - ], - "members":{ - "pentestId":{"shape":"String"}, - "agentSpaceId":{"shape":"String"}, - "title":{"shape":"String"}, - "assets":{"shape":"Assets"}, - "excludeRiskTypes":{"shape":"RiskTypeList"}, - "serviceRole":{"shape":"ServiceRole"}, - "logConfig":{"shape":"CloudWatchLog"}, - "vpcConfig":{"shape":"VpcConfig"}, - "networkTrafficConfig":{"shape":"NetworkTrafficConfig"}, - "codeRemediationStrategy":{"shape":"CodeRemediationStrategy"}, - "disableManagedSkills":{"shape":"SkillTypeList"} - } - }, - "UpdatePentestOutput":{ - "type":"structure", - "members":{ - "pentestId":{"shape":"String"}, - "title":{"shape":"String"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"}, - "assets":{"shape":"Assets"}, - "excludeRiskTypes":{"shape":"RiskTypeList"}, - "serviceRole":{"shape":"ServiceRole"}, - "logConfig":{"shape":"CloudWatchLog"}, - "agentSpaceId":{"shape":"String"} - } - }, - "UpdatePrivateConnectionCertificateInput":{ - "type":"structure", - "required":[ - "privateConnectionName", - "certificate" - ], - "members":{ - "privateConnectionName":{"shape":"PrivateConnectionName"}, - "certificate":{"shape":"CertificateChain"} - } - }, - "UpdatePrivateConnectionCertificateOutput":{ - "type":"structure", - "required":[ - "name", - "type", - "status" - ], - "members":{ - "name":{"shape":"PrivateConnectionName"}, - "type":{"shape":"PrivateConnectionType"}, - "status":{"shape":"PrivateConnectionStatus"}, - "resourceGatewayId":{"shape":"ResourceGatewayId"}, - "hostAddress":{"shape":"HostAddress"}, - "vpcId":{"shape":"PrivateConnectionVpcId"}, - "resourceConfigurationId":{"shape":"ResourceConfigurationId"}, - "certificateExpiryTime":{"shape":"SyntheticTimestamp_date_time"}, - "dnsResolution":{"shape":"ResourceConfigDnsResolution"}, - "failureMessage":{"shape":"String"}, - "tags":{"shape":"TagMap"} - } - }, - "UpdateSecurityRequirementEntry":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{"shape":"SecurityRequirementName"}, - "description":{"shape":"String"}, - "domain":{"shape":"String"}, - "evaluation":{"shape":"String"}, - "remediation":{"shape":"String"} - } - }, - "UpdateSecurityRequirementEntryList":{ - "type":"list", - "member":{"shape":"UpdateSecurityRequirementEntry"} - }, - "UpdateSecurityRequirementPackInput":{ - "type":"structure", - "required":["packId"], - "members":{ - "packId":{"shape":"SecurityRequirementPackId"}, - "name":{"shape":"SecurityRequirementPackName"}, - "description":{"shape":"String"}, - "status":{"shape":"SecurityRequirementPackStatus"} - } - }, - "UpdateSecurityRequirementPackOutput":{ - "type":"structure", - "required":["packId"], - "members":{ - "packId":{"shape":"SecurityRequirementPackId"}, - "name":{"shape":"SecurityRequirementPackName"}, - "description":{"shape":"String"}, - "status":{"shape":"SecurityRequirementPackStatus"} - } - }, - "UpdateTargetDomainInput":{ - "type":"structure", - "required":[ - "targetDomainId", - "verificationMethod" - ], - "members":{ - "targetDomainId":{"shape":"TargetDomainId"}, - "verificationMethod":{"shape":"DomainVerificationMethod"} - } - }, - "UpdateTargetDomainOutput":{ - "type":"structure", - "required":[ - "targetDomainId", - "domainName", - "verificationStatus" - ], - "members":{ - "targetDomainId":{"shape":"TargetDomainId"}, - "domainName":{"shape":"String"}, - "verificationStatus":{"shape":"TargetDomainStatus"}, - "verificationStatusReason":{"shape":"String"}, - "verificationDetails":{"shape":"VerificationDetails"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "verifiedAt":{"shape":"SyntheticTimestamp_date_time"} - } - }, - "UpdateThreatInput":{ - "type":"structure", - "required":[ - "threatId", - "agentSpaceId" - ], - "members":{ - "threatId":{"shape":"String"}, - "agentSpaceId":{"shape":"String"}, - "title":{"shape":"String"}, - "status":{"shape":"ThreatStatus"}, - "comments":{"shape":"String"}, - "statement":{"shape":"String"}, - "severity":{"shape":"ThreatSeverity"}, - "threatSource":{"shape":"String"}, - "prerequisites":{"shape":"String"}, - "threatAction":{"shape":"String"}, - "threatImpact":{"shape":"String"}, - "impactedGoal":{"shape":"StringList"}, - "impactedAssets":{"shape":"StringList"}, - "anchor":{"shape":"ThreatAnchorShape"}, - "evidence":{"shape":"ThreatEvidenceList"}, - "recommendation":{"shape":"String"} - } - }, - "UpdateThreatModelInput":{ - "type":"structure", - "required":[ - "threatModelId", - "agentSpaceId" - ], - "members":{ - "threatModelId":{"shape":"String"}, - "agentSpaceId":{"shape":"String"}, - "title":{"shape":"String"}, - "description":{"shape":"String"}, - "assets":{"shape":"Assets"}, - "scopeDocs":{"shape":"DocumentList"}, - "serviceRole":{"shape":"ServiceRole"}, - "logConfig":{"shape":"CloudWatchLog"} - } - }, - "UpdateThreatModelOutput":{ - "type":"structure", - "required":["threatModelId"], - "members":{ - "threatModelId":{"shape":"String"}, - "title":{"shape":"String"}, - "agentSpaceId":{"shape":"String"}, - "description":{"shape":"String"}, - "assets":{"shape":"Assets"}, - "scopeDocs":{"shape":"DocumentList"}, - "serviceRole":{"shape":"ServiceRole"}, - "logConfig":{"shape":"CloudWatchLog"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"} - } - }, - "UpdateThreatOutput":{ - "type":"structure", - "required":[ - "threatId", - "threatJobId" - ], - "members":{ - "threatId":{"shape":"String"}, - "threatJobId":{"shape":"String"}, - "title":{"shape":"String"}, - "statement":{"shape":"String"}, - "severity":{"shape":"ThreatSeverity"}, - "status":{"shape":"ThreatStatus"}, - "comments":{"shape":"String"}, - "stride":{"shape":"StrideCategoryList"}, - "threatSource":{"shape":"String"}, - "prerequisites":{"shape":"String"}, - "threatAction":{"shape":"String"}, - "threatImpact":{"shape":"String"}, - "impactedGoal":{"shape":"StringList"}, - "impactedAssets":{"shape":"StringList"}, - "anchor":{"shape":"ThreatAnchorShape"}, - "evidence":{"shape":"ThreatEvidenceList"}, - "recommendation":{"shape":"String"}, - "createdBy":{"shape":"ThreatActor"}, - "updatedBy":{"shape":"ThreatActor"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"} - } - }, - "UriList":{ - "type":"list", - "member":{"shape":"String"} - }, - "UserConfig":{ - "type":"structure", - "members":{ - "role":{"shape":"UserRole"} - } - }, - "UserMetadata":{ - "type":"structure", - "required":[ - "username", - "email" - ], - "members":{ - "username":{"shape":"String"}, - "email":{"shape":"SensitiveEmail"} - } - }, - "UserRole":{ - "type":"string", - "enum":["MEMBER"] - }, - "ValidationException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"}, - "fieldList":{"shape":"ValidationExceptionFieldList"} - }, - "exception":true - }, - "ValidationExceptionField":{ - "type":"structure", - "required":[ - "path", - "message" - ], - "members":{ - "path":{"shape":"String"}, - "message":{"shape":"String"} - } - }, - "ValidationExceptionFieldList":{ - "type":"list", - "member":{"shape":"ValidationExceptionField"} - }, - "ValidationMode":{ - "type":"string", - "enum":[ - "DISABLED", - "SIMULATED" - ] - }, - "ValidationStatus":{ - "type":"string", - "enum":[ - "CONFIRMED", - "NOT_REPRODUCED", - "VALIDATION_FAILED", - "VALIDATING", - "NOT_VALIDATED" - ] - }, - "VerificationDetails":{ - "type":"structure", - "members":{ - "method":{"shape":"DomainVerificationMethod"}, - "dnsTxt":{"shape":"DnsVerification"}, - "httpRoute":{"shape":"HttpVerification"} - } - }, - "VerificationScript":{ - "type":"structure", - "members":{ - "scriptType":{"shape":"String"}, - "scriptUrl":{"shape":"String"}, - "instructions":{"shape":"String"}, - "envVars":{"shape":"VerificationScriptEnvVarList"} - } - }, - "VerificationScriptEnvVar":{ - "type":"structure", - "members":{ - "name":{"shape":"String"}, - "value":{"shape":"String"} - } - }, - "VerificationScriptEnvVarList":{ - "type":"list", - "member":{"shape":"VerificationScriptEnvVar"} - }, - "VerifyTargetDomainInput":{ - "type":"structure", - "required":["targetDomainId"], - "members":{ - "targetDomainId":{"shape":"TargetDomainId"} - } - }, - "VerifyTargetDomainOutput":{ - "type":"structure", - "members":{ - "targetDomainId":{"shape":"TargetDomainId"}, - "domainName":{"shape":"String"}, - "createdAt":{"shape":"SyntheticTimestamp_date_time"}, - "updatedAt":{"shape":"SyntheticTimestamp_date_time"}, - "verifiedAt":{"shape":"SyntheticTimestamp_date_time"}, - "status":{"shape":"TargetDomainStatus"}, - "verificationStatusReason":{"shape":"String"} - } - }, - "VpcArn":{"type":"string"}, - "VpcConfig":{ - "type":"structure", - "members":{ - "vpcArn":{"shape":"VpcArn"}, - "securityGroupArns":{"shape":"SecurityGroupArns"}, - "subnetArns":{"shape":"SubnetArns"} - } - }, - "VpcConfigs":{ - "type":"list", - "member":{"shape":"VpcConfig"} - } - } -} diff --git a/tools/code-generation/api-descriptions/securityagent/2025-09-06/docs-2.json b/tools/code-generation/api-descriptions/securityagent/2025-09-06/docs-2.json deleted file mode 100644 index 1a8567f02747..000000000000 --- a/tools/code-generation/api-descriptions/securityagent/2025-09-06/docs-2.json +++ /dev/null @@ -1,3731 +0,0 @@ -{ - "version": "2.0", - "service": "

AWS Security Agent is a frontier agent that proactively secures your applications throughout the development lifecycle. It conducts automated security reviews tailored to your organizational requirements and delivers context-aware penetration testing on demand. By continuously validating security from design to deployment, AWS Security Agent helps prevent vulnerabilities early across all your environments. Key capabilities include design security review for architecture documents, code security review for pull requests in connected repositories, and on-demand penetration testing that discovers, validates, and remediates security vulnerabilities through tailored multi-step attack scenarios. For more information, see the AWS Security Agent User Guide.

", - "operations": { - "AddArtifact": "

Uploads an artifact to an agent space. Artifacts provide additional context for security testing, such as architecture diagrams, API specifications, or configuration files.

", - "BatchCreateSecurityRequirements": "

Batch creates security requirements in a customer managed pack.

", - "BatchDeleteCodeReviews": "

Deletes one or more code reviews from an agent space.

", - "BatchDeletePentests": "

Deletes one or more pentests from an agent space.

", - "BatchDeleteSecurityRequirements": "

Batch deletes security requirements from a customer managed pack.

", - "BatchDeleteThreatModels": "

Deletes one or more threat models from an agent space.

", - "BatchGetAgentSpaces": "

Retrieves information about one or more agent spaces.

", - "BatchGetArtifactMetadata": "

Retrieves metadata for one or more artifacts in an agent space.

", - "BatchGetCodeReviewJobTasks": "

Retrieves information about one or more tasks within a code review job.

", - "BatchGetCodeReviewJobs": "

Retrieves information about one or more code review jobs in an agent space.

", - "BatchGetCodeReviews": "

Retrieves information about one or more code reviews in an agent space.

", - "BatchGetFindings": "

Retrieves information about one or more security findings in an agent space.

", - "BatchGetPentestJobTasks": "

Retrieves information about one or more tasks within a pentest job.

", - "BatchGetPentestJobs": "

Retrieves information about one or more pentest jobs in an agent space.

", - "BatchGetPentests": "

Retrieves information about one or more pentests in an agent space.

", - "BatchGetSecurityRequirements": "

Batch retrieves security requirements from a pack.

", - "BatchGetTargetDomains": "

Retrieves information about one or more target domains.

", - "BatchGetThreatModelJobTasks": "

Retrieves information about one or more tasks within a threat model job.

", - "BatchGetThreatModelJobs": "

Retrieves information about one or more threat model jobs in an agent space.

", - "BatchGetThreatModels": "

Retrieves information about one or more threat models in an agent space.

", - "BatchGetThreats": "

Retrieves information about one or more threats.

", - "BatchUpdateSecurityRequirements": "

Batch updates security requirements within a customer managed pack.

", - "CreateAgentSpace": "

Creates a new agent space. An agent space is a dedicated workspace for securing a specific application.

", - "CreateApplication": "

Creates a new application. An application is the top-level organizational unit that supports IAM Identity Center integration.

", - "CreateCodeReview": "

Creates a new code review configuration in an agent space. A code review defines the parameters for automated security-focused code analysis.

", - "CreateIntegration": "

Creates a new integration with a third-party provider, such as GitHub, for code review and remediation.

", - "CreateMembership": "

Creates a new membership, granting a user access to an agent space within an application.

", - "CreatePentest": "

Creates a new pentest configuration in an agent space. A pentest defines the security test parameters, including target assets, risk type exclusions, and logging configuration.

", - "CreatePrivateConnection": "

Creates a private connection for reaching a self-hosted provider instance over private networking using Amazon VPC Lattice.

", - "CreateSecurityRequirementPack": "

Creates a customer managed security requirement pack.

", - "CreateTargetDomain": "

Creates a new target domain for penetration testing. A target domain is a web domain that must be registered and verified before it can be tested.

", - "CreateThreat": "

Creates a new threat under a threat model job.

", - "CreateThreatModel": "

Creates a new threat model configuration in an agent space. A threat model defines the parameters for automated threat analysis.

", - "DeleteAgentSpace": "

Deletes an agent space and all of its associated resources, including pentests, findings, and artifacts.

", - "DeleteApplication": "

Deletes an application and its associated configuration, including IAM Identity Center settings.

", - "DeleteArtifact": "

Deletes an artifact from an agent space.

", - "DeleteIntegration": "

Deletes an integration with a third-party provider.

", - "DeleteMembership": "

Deletes a membership, revoking a user's access to an agent space.

", - "DeletePrivateConnection": "

Deletes a private connection.

", - "DeleteSecurityRequirementPack": "

Deletes a customer managed security requirement pack and all its associated security requirements.

", - "DeleteTargetDomain": "

Deletes a target domain registration. After deletion, the domain can no longer be used for penetration testing.

", - "DescribePrivateConnection": "

Retrieves the details of a private connection.

", - "GetApplication": "

Retrieves information about an application.

", - "GetArtifact": "

Retrieves an artifact from an agent space.

", - "GetIntegration": "

Retrieves information about an integration.

", - "GetSecurityRequirementPack": "

Retrieves information about a security requirement pack.

", - "ImportSecurityRequirements": "

Imports security requirements from uploaded documents into a customer managed security requirement pack. The import process asynchronously extracts and generates structured security requirements from the provided source files.

", - "InitiateProviderRegistration": "

Initiates the OAuth registration flow with a third-party provider. Returns a redirect URL and CSRF state token for completing the authorization.

", - "ListAgentSpaces": "

Returns a paginated list of agent space summaries in your account.

", - "ListApplications": "

Returns a paginated list of application summaries in your account.

", - "ListArtifacts": "

Returns a paginated list of artifact summaries for the specified agent space.

", - "ListCodeReviewJobTasks": "

Returns a paginated list of task summaries for the specified code review job, optionally filtered by step name or category.

", - "ListCodeReviewJobsForCodeReview": "

Returns a paginated list of code review job summaries for the specified code review configuration.

", - "ListCodeReviews": "

Returns a paginated list of code review summaries for the specified agent space.

", - "ListDiscoveredEndpoints": "

Returns a paginated list of endpoints discovered during a pentest job execution.

", - "ListFindings": "

Lists the security findings for a pentest job.

", - "ListIntegratedResources": "

Lists the integrated resources for an agent space, optionally filtered by integration or resource type.

", - "ListIntegrations": "

Lists the integrations in your account, optionally filtered by provider or provider type.

", - "ListMemberships": "

Returns a paginated list of membership summaries for the specified agent space within an application.

", - "ListPentestJobTasks": "

Returns a paginated list of task summaries for the specified pentest job, optionally filtered by step name or category.

", - "ListPentestJobsForPentest": "

Returns a paginated list of pentest job summaries for the specified pentest configuration.

", - "ListPentests": "

Returns a paginated list of pentest summaries for the specified agent space.

", - "ListPrivateConnections": "

Lists the private connections in your account.

", - "ListSecurityRequirementPacks": "

Lists all security requirement packs in the caller's account.

", - "ListSecurityRequirements": "

Lists security requirements within a pack.

", - "ListTagsForResource": "

Returns the tags associated with the specified resource.

", - "ListTargetDomains": "

Returns a paginated list of target domain summaries in your account.

", - "ListThreatModelJobTasks": "

Returns a paginated list of task summaries for the specified threat model job.

", - "ListThreatModelJobs": "

Returns a paginated list of threat model job summaries for the specified threat model.

", - "ListThreatModels": "

Returns a paginated list of threat model summaries for the specified agent space.

", - "ListThreats": "

Returns a paginated list of threats for a threat model job.

", - "StartCodeRemediation": "

Initiates code remediation for one or more security findings. This creates pull requests in integrated repositories to fix the identified vulnerabilities.

", - "StartCodeReviewJob": "

Starts a new code review job for a code review configuration. The job executes the security-focused code analysis defined in the code review.

", - "StartPentestJob": "

Starts a new pentest job for a pentest configuration. The job executes the security tests defined in the pentest.

", - "StartThreatModelJob": "

Starts a new threat model job for a threat model configuration.

", - "StopCodeReviewJob": "

Stops a running code review job. The job transitions to a stopping state and then to stopped after cleanup completes.

", - "StopPentestJob": "

Stops a running pentest job. The job transitions to a stopping state and then to stopped after cleanup completes.

", - "StopThreatModelJob": "

Stops a running threat model job.

", - "TagResource": "

Adds tags to a resource.

", - "UntagResource": "

Removes tags from a resource.

", - "UpdateAgentSpace": "

Updates the configuration of an existing agent space, including its name, description, AWS resources, target domains, and code review settings.

", - "UpdateApplication": "

Updates the configuration of an existing application, including the IAM role and default KMS key.

", - "UpdateCodeReview": "

Updates an existing code review configuration.

", - "UpdateFinding": "

Updates the status or risk level of a security finding.

", - "UpdateIntegratedResources": "

Updates the integrated resources for an agent space, including their capabilities.

", - "UpdatePentest": "

Updates an existing pentest configuration.

", - "UpdatePrivateConnectionCertificate": "

Updates the certificate associated with a private connection. Certificates can be added or replaced but not removed.

", - "UpdateSecurityRequirementPack": "

Updates a security requirement pack. For customer managed packs, both metadata and status can be updated. For AWS managed packs, only status can be updated.

", - "UpdateTargetDomain": "

Updates the verification method for a target domain.

", - "UpdateThreat": "

Updates a threat.

", - "UpdateThreatModel": "

Updates an existing threat model configuration.

", - "VerifyTargetDomain": "

Initiates verification of a target domain. This checks whether the domain ownership verification token has been properly configured.

" - }, - "shapes": { - "AWSResources": { - "base": "

The AWS resources associated with an agent space, including VPCs, log groups, S3 buckets, secrets, Lambda functions, and IAM roles.

", - "refs": { - "AgentSpace$awsResources": "

The AWS resources associated with the agent space.

", - "CreateAgentSpaceInput$awsResources": "

The AWS resources to associate with the agent space.

", - "CreateAgentSpaceOutput$awsResources": "

The AWS resources associated with the agent space.

", - "UpdateAgentSpaceInput$awsResources": "

The updated AWS resources to associate with the agent space.

", - "UpdateAgentSpaceOutput$awsResources": "

The AWS resources associated with the agent space.

" - } - }, - "AccessDeniedException": { - "base": "

You do not have sufficient access to perform this action.

", - "refs": {} - }, - "AccessToken": { - "base": "

A GitLab access token used to authenticate with the provider.

", - "refs": { - "GitLabIntegrationInput$accessToken": "

The GitLab access token used to authenticate. This can be a personal access token or a group access token.

" - } - }, - "AccessType": { - "base": "

Defines the visibility level of provider resources. PRIVATE indicates restricted access, while PUBLIC indicates open access.

", - "refs": { - "BitbucketRepositoryMetadata$accessType": null, - "GitHubRepositoryMetadata$accessType": "

The access type of the GitHub repository. Valid values are PRIVATE and PUBLIC.

", - "GitLabRepositoryMetadata$accessType": null - } - }, - "Actor": { - "base": "

Represents an actor used during penetration testing. An actor defines a user or entity that interacts with the target application, including authentication credentials and target URIs.

", - "refs": { - "ActorList$member": null - } - }, - "ActorList": { - "base": null, - "refs": { - "Assets$actors": "

The list of actors used during penetration testing.

", - "PentestJob$actors": "

The list of actors used during the pentest job.

" - } - }, - "AddArtifactInput": { - "base": null, - "refs": {} - }, - "AddArtifactOutput": { - "base": null, - "refs": {} - }, - "AgentName": { - "base": "

Name of an agent space.

", - "refs": { - "CreateAgentSpaceInput$name": "

The name of the agent space.

", - "CreateAgentSpaceOutput$name": "

The name of the agent space.

", - "UpdateAgentSpaceInput$name": "

The updated name of the agent space.

", - "UpdateAgentSpaceOutput$name": "

The name of the agent space.

" - } - }, - "AgentSpace": { - "base": "

Represents an agent space, which is a dedicated workspace for securing a specific application. An agent space contains the configuration, resources, and settings needed for security testing.

", - "refs": { - "AgentSpaceList$member": null - } - }, - "AgentSpaceId": { - "base": "

Unique identifier of the agent space.

", - "refs": { - "AddArtifactInput$agentSpaceId": "

The unique identifier of the agent space to add the artifact to.

", - "AgentSpace$agentSpaceId": "

The unique identifier of the agent space.

", - "AgentSpaceIdList$member": null, - "AgentSpaceSummary$agentSpaceId": "

The unique identifier of the agent space.

", - "ArtifactMetadataItem$agentSpaceId": "

The unique identifier of the agent space that contains the artifact.

", - "BatchGetArtifactMetadataInput$agentSpaceId": "

The unique identifier of the agent space that contains the artifacts.

", - "CreateAgentSpaceOutput$agentSpaceId": "

The unique identifier of the created agent space.

", - "CreateMembershipRequest$agentSpaceId": "

The unique identifier of the agent space to grant access to.

", - "DeleteAgentSpaceInput$agentSpaceId": "

The unique identifier of the agent space to delete.

", - "DeleteAgentSpaceOutput$agentSpaceId": "

The unique identifier of the deleted agent space.

", - "DeleteArtifactInput$agentSpaceId": "

The unique identifier of the agent space that contains the artifact.

", - "DeleteMembershipRequest$agentSpaceId": "

The unique identifier of the agent space to revoke access from.

", - "GetArtifactInput$agentSpaceId": "

The unique identifier of the agent space that contains the artifact.

", - "GetArtifactOutput$agentSpaceId": "

The unique identifier of the agent space that contains the artifact.

", - "ListArtifactsInput$agentSpaceId": "

The unique identifier of the agent space to list artifacts for.

", - "ListIntegratedResourcesInput$agentSpaceId": "

The unique identifier of the agent space to list integrated resources for.

", - "ListMembershipsRequest$agentSpaceId": "

The unique identifier of the agent space to list memberships for.

", - "MembershipSummary$agentSpaceId": "

The unique identifier of the agent space.

", - "UpdateAgentSpaceInput$agentSpaceId": "

The unique identifier of the agent space to update.

", - "UpdateAgentSpaceOutput$agentSpaceId": "

The unique identifier of the updated agent space.

", - "UpdateIntegratedResourcesInput$agentSpaceId": "

The unique identifier of the agent space.

" - } - }, - "AgentSpaceIdList": { - "base": null, - "refs": { - "BatchGetAgentSpacesInput$agentSpaceIds": "

The list of agent space identifiers to retrieve.

", - "BatchGetAgentSpacesOutput$notFound": "

The list of agent space identifiers that were not found.

" - } - }, - "AgentSpaceList": { - "base": null, - "refs": { - "BatchGetAgentSpacesOutput$agentSpaces": "

The list of agent spaces that were found.

" - } - }, - "AgentSpaceSummary": { - "base": "

Contains summary information about an agent space.

", - "refs": { - "AgentSpaceSummaryList$member": null - } - }, - "AgentSpaceSummaryList": { - "base": null, - "refs": { - "ListAgentSpacesOutput$agentSpaceSummaries": "

The list of agent space summaries.

" - } - }, - "ApplicationDomain": { - "base": "

Domain where the application is available.

", - "refs": { - "ApplicationSummary$domain": "

The domain associated with the application.

", - "GetApplicationResponse$domain": "

The domain associated with the application.

" - } - }, - "ApplicationId": { - "base": "

Application identifier.

", - "refs": { - "ApplicationSummary$applicationId": "

The unique identifier of the application.

", - "CreateApplicationResponse$applicationId": "

The unique identifier of the created application.

", - "CreateMembershipRequest$applicationId": "

The unique identifier of the application that contains the agent space.

", - "DeleteApplicationRequest$applicationId": "

The unique identifier of the application to delete.

", - "DeleteMembershipRequest$applicationId": "

The unique identifier of the application that contains the agent space.

", - "GetApplicationRequest$applicationId": "

The unique identifier of the application to retrieve.

", - "GetApplicationResponse$applicationId": "

The unique identifier of the application.

", - "ListMembershipsRequest$applicationId": "

The unique identifier of the application that contains the agent space.

", - "MembershipSummary$applicationId": "

The unique identifier of the application.

", - "UpdateApplicationRequest$applicationId": "

The unique identifier of the application to update.

", - "UpdateApplicationResponse$applicationId": "

The unique identifier of the updated application.

" - } - }, - "ApplicationSummary": { - "base": "

Contains summary information about an application.

", - "refs": { - "ApplicationSummaryList$member": null - } - }, - "ApplicationSummaryList": { - "base": "

List of application summaries.

", - "refs": { - "ListApplicationsResponse$applicationSummaries": "

The list of application summaries.

" - } - }, - "Artifact": { - "base": "

Represents an artifact that provides context for security testing, such as documentation, diagrams, or configuration files.

", - "refs": { - "GetArtifactOutput$artifact": "

The artifact content and type.

" - } - }, - "ArtifactId": { - "base": "

The id of the artifact.

", - "refs": { - "AddArtifactOutput$artifactId": "

The unique identifier assigned to the uploaded artifact.

", - "ArtifactIds$member": null, - "ArtifactMetadataItem$artifactId": "

The unique identifier of the artifact.

", - "ArtifactSummary$artifactId": "

The unique identifier of the artifact.

", - "DeleteArtifactInput$artifactId": "

The unique identifier of the artifact to delete.

", - "GetArtifactInput$artifactId": "

The unique identifier of the artifact to retrieve.

", - "GetArtifactOutput$artifactId": "

The unique identifier of the artifact.

" - } - }, - "ArtifactIds": { - "base": null, - "refs": { - "BatchGetArtifactMetadataInput$artifactIds": "

The list of artifact identifiers to retrieve metadata for.

" - } - }, - "ArtifactMetadataItem": { - "base": "

Contains metadata about an artifact.

", - "refs": { - "ArtifactMetadataList$member": null - } - }, - "ArtifactMetadataList": { - "base": "

List of metadata objects containing artifacts details.

", - "refs": { - "BatchGetArtifactMetadataOutput$artifactMetadataList": "

The list of artifact metadata items that were found.

" - } - }, - "ArtifactSummary": { - "base": "

Contains summary information about an artifact.

", - "refs": { - "ArtifactSummaryList$member": null - } - }, - "ArtifactSummaryList": { - "base": "

List of artifact summaries.

", - "refs": { - "ListArtifactsOutput$artifactSummaries": "

The list of artifact summaries.

" - } - }, - "ArtifactType": { - "base": "

Supported file extension types for artifacts.

", - "refs": { - "AddArtifactInput$artifactType": "

The file type of the artifact. Valid values include TXT, PNG, JPEG, MD, PDF, DOCX, DOC, JSON, and YAML.

", - "Artifact$type": "

The file type of the artifact.

", - "ArtifactSummary$artifactType": "

The file type of the artifact.

" - } - }, - "Assets": { - "base": "

The collection of assets used in a pentest configuration, including endpoints, actors, documents, source code repositories, and integrated repositories.

", - "refs": { - "CodeReview$assets": "

The assets included in the code review.

", - "CreateCodeReviewInput$assets": "

The assets to include in the code review, such as documents and source code.

", - "CreateCodeReviewOutput$assets": "

The assets included in the code review.

", - "CreatePentestInput$assets": "

The assets to include in the pentest, such as endpoints, actors, documents, and source code.

", - "CreatePentestOutput$assets": "

The assets included in the pentest.

", - "CreateThreatModelInput$assets": "

The assets to include in the threat model.

", - "CreateThreatModelOutput$assets": "

The assets included in the threat model.

", - "Pentest$assets": "

The assets included in the pentest.

", - "ThreatModel$assets": "

The assets included in the threat model.

", - "UpdateCodeReviewInput$assets": "

The updated assets for the code review.

", - "UpdateCodeReviewOutput$assets": "

The assets included in the code review.

", - "UpdatePentestInput$assets": "

The updated assets for the pentest.

", - "UpdatePentestOutput$assets": "

The assets included in the pentest.

", - "UpdateThreatModelInput$assets": "

The updated assets for the threat model.

", - "UpdateThreatModelOutput$assets": "

The assets included in the threat model.

" - } - }, - "AuthCode": { - "base": "

Authorization code from OAuth flow.

", - "refs": { - "BitbucketIntegrationInput$code": "

The OAuth 2.0 authorization code returned from the consent redirect.

", - "ConfluenceIntegrationInput$code": "

The OAuth 2.0 authorization code returned from the consent redirect.

", - "GitHubIntegrationInput$code": "

The OAuth authorization code received from GitHub.

" - } - }, - "Authentication": { - "base": "

The authentication configuration for an actor, specifying the provider type and credentials.

", - "refs": { - "Actor$authentication": "

The authentication configuration for the actor.

" - } - }, - "AuthenticationProviderType": { - "base": "

Type of authentication provider.

", - "refs": { - "Authentication$providerType": "

The type of authentication provider. Valid values include SECRETS_MANAGER, AWS_LAMBDA, AWS_IAM_ROLE, and AWS_INTERNAL.

" - } - }, - "BatchCreateSecurityRequirementResult": { - "base": "

Contains information about a successfully created security requirement.

", - "refs": { - "BatchCreateSecurityRequirementResultList$member": null - } - }, - "BatchCreateSecurityRequirementResultList": { - "base": "

List of successfully created security requirements.

", - "refs": { - "BatchCreateSecurityRequirementsOutput$securityRequirements": "

The list of security requirements that were successfully created.

" - } - }, - "BatchCreateSecurityRequirementsInput": { - "base": null, - "refs": {} - }, - "BatchCreateSecurityRequirementsOutput": { - "base": null, - "refs": {} - }, - "BatchDeleteCodeReviewsInput": { - "base": "

Input for deleting multiple code reviews.

", - "refs": {} - }, - "BatchDeleteCodeReviewsOutput": { - "base": "

Output for the BatchDeleteCodeReviews operation.

", - "refs": {} - }, - "BatchDeletePentestsInput": { - "base": "

Input for deleting multiple pentests.

", - "refs": {} - }, - "BatchDeletePentestsOutput": { - "base": "

Output for the BatchDeletePentests operation.

", - "refs": {} - }, - "BatchDeleteSecurityRequirementsInput": { - "base": null, - "refs": {} - }, - "BatchDeleteSecurityRequirementsOutput": { - "base": null, - "refs": {} - }, - "BatchDeleteThreatModelsInput": { - "base": "

Input for deleting multiple threat models.

", - "refs": {} - }, - "BatchDeleteThreatModelsOutput": { - "base": "

Output for the BatchDeleteThreatModels operation.

", - "refs": {} - }, - "BatchGetAgentSpacesInput": { - "base": "

Input for batch retrieving agent spaces.

", - "refs": {} - }, - "BatchGetAgentSpacesOutput": { - "base": "

Output for the BatchGetAgentSpaces operation.

", - "refs": {} - }, - "BatchGetArtifactMetadataInput": { - "base": null, - "refs": {} - }, - "BatchGetArtifactMetadataOutput": { - "base": null, - "refs": {} - }, - "BatchGetCodeReviewJobTasksInput": { - "base": "

Input for retrieving multiple tasks associated with a code review job.

", - "refs": {} - }, - "BatchGetCodeReviewJobTasksOutput": { - "base": "

Output for the BatchGetCodeReviewJobTasks operation.

", - "refs": {} - }, - "BatchGetCodeReviewJobsInput": { - "base": "

Input for BatchGetCodeReviewJobs operation.

", - "refs": {} - }, - "BatchGetCodeReviewJobsOutput": { - "base": "

Output for the BatchGetCodeReviewJobs operation.

", - "refs": {} - }, - "BatchGetCodeReviewsInput": { - "base": "

Input for retrieving multiple code reviews by their IDs.

", - "refs": {} - }, - "BatchGetCodeReviewsOutput": { - "base": "

Output for the BatchGetCodeReviews operation.

", - "refs": {} - }, - "BatchGetFindingsInput": { - "base": "

Input for BatchGetFindings operation.

", - "refs": {} - }, - "BatchGetFindingsOutput": { - "base": "

Output for the BatchGetFindings operation.

", - "refs": {} - }, - "BatchGetPentestJobTasksInput": { - "base": "

Input for retrieving multiple tasks associated with a pentest job.

", - "refs": {} - }, - "BatchGetPentestJobTasksOutput": { - "base": "

Output for the BatchGetPentestJobTasks operation.

", - "refs": {} - }, - "BatchGetPentestJobsInput": { - "base": "

Input for BatchGetPentestJobs operation.

", - "refs": {} - }, - "BatchGetPentestJobsOutput": { - "base": "

Output for the BatchGetPentestJobs operation.

", - "refs": {} - }, - "BatchGetPentestsInput": { - "base": "

Input for retrieving multiple pentests by their IDs.

", - "refs": {} - }, - "BatchGetPentestsOutput": { - "base": "

Output for the BatchGetPentests operation.

", - "refs": {} - }, - "BatchGetSecurityRequirementResult": { - "base": "

Contains information about a successfully retrieved security requirement.

", - "refs": { - "BatchGetSecurityRequirementResultList$member": null - } - }, - "BatchGetSecurityRequirementResultList": { - "base": "

List of successfully retrieved security requirements.

", - "refs": { - "BatchGetSecurityRequirementsOutput$securityRequirements": "

The list of security requirements that were successfully retrieved.

" - } - }, - "BatchGetSecurityRequirementsInput": { - "base": null, - "refs": {} - }, - "BatchGetSecurityRequirementsOutput": { - "base": null, - "refs": {} - }, - "BatchGetTargetDomainsInput": { - "base": "

Input for batch retrieving target domains.

", - "refs": {} - }, - "BatchGetTargetDomainsOutput": { - "base": "

Output for the BatchGetTargetDomains operation.

", - "refs": {} - }, - "BatchGetThreatModelJobTasksInput": { - "base": "

Input for retrieving multiple tasks associated with a threat model job.

", - "refs": {} - }, - "BatchGetThreatModelJobTasksOutput": { - "base": "

Output for the BatchGetThreatModelJobTasks operation.

", - "refs": {} - }, - "BatchGetThreatModelJobsInput": { - "base": "

Input for BatchGetThreatModelJobs operation.

", - "refs": {} - }, - "BatchGetThreatModelJobsOutput": { - "base": "

Output for the BatchGetThreatModelJobs operation.

", - "refs": {} - }, - "BatchGetThreatModelsInput": { - "base": "

Input for retrieving multiple threat models by their IDs.

", - "refs": {} - }, - "BatchGetThreatModelsOutput": { - "base": "

Output for the BatchGetThreatModels operation.

", - "refs": {} - }, - "BatchGetThreatsInput": { - "base": "

Input for retrieving multiple threats.

", - "refs": {} - }, - "BatchGetThreatsOutput": { - "base": "

Output for the BatchGetThreats operation.

", - "refs": {} - }, - "BatchSecurityRequirementError": { - "base": "

Contains information about an error that occurred for a specific security requirement during a batch operation.

", - "refs": { - "BatchSecurityRequirementErrors$member": null - } - }, - "BatchSecurityRequirementErrors": { - "base": "

List of errors from a batch security requirement operation.

", - "refs": { - "BatchCreateSecurityRequirementsOutput$errors": "

The list of errors for security requirements that failed to be created.

", - "BatchDeleteSecurityRequirementsOutput$errors": "

The list of errors for security requirements that failed to be deleted.

", - "BatchGetSecurityRequirementsOutput$errors": "

The list of errors for security requirements that failed to be retrieved.

", - "BatchUpdateSecurityRequirementsOutput$errors": "

The list of errors for security requirements that failed to be updated.

" - } - }, - "BatchUpdateSecurityRequirementsInput": { - "base": null, - "refs": {} - }, - "BatchUpdateSecurityRequirementsOutput": { - "base": null, - "refs": {} - }, - "BitbucketInstallationId": { - "base": "

An Atlassian installation identifier for a Bitbucket integration.

", - "refs": { - "BitbucketIntegrationInput$installationId": "

The Atlassian installation identifier, available from the Atlassian administration console.

" - } - }, - "BitbucketIntegrationInput": { - "base": "

The configuration for creating a Bitbucket integration.

", - "refs": { - "ProviderInput$bitbucket": "

The configuration for a Bitbucket integration.

" - } - }, - "BitbucketRepositoryMetadata": { - "base": "

Metadata for an integrated Bitbucket repository.

", - "refs": { - "IntegratedResourceMetadata$bitbucketRepository": null - } - }, - "BitbucketRepositoryResource": { - "base": "

A Bitbucket repository integrated as a resource.

", - "refs": { - "IntegratedResource$bitbucketRepository": null - } - }, - "BitbucketResourceCapabilities": { - "base": "

Capabilities for an integrated Bitbucket repository.

", - "refs": { - "ProviderResourceCapabilities$bitbucket": null - } - }, - "BitbucketWorkspace": { - "base": "

A Bitbucket workspace slug that identifies a workspace.

", - "refs": { - "BitbucketIntegrationInput$workspace": "

The Bitbucket workspace slug that identifies the workspace to integrate, for example acme-corp.

", - "BitbucketRepositoryMetadata$workspace": "

The workspace slug that owns the repository.

", - "BitbucketRepositoryResource$workspace": "

The workspace slug that owns the repository.

" - } - }, - "Blob": { - "base": null, - "refs": { - "AddArtifactInput$artifactContent": "

The binary content of the artifact to upload.

" - } - }, - "Boolean": { - "base": null, - "refs": { - "BitbucketResourceCapabilities$leaveComments": "

Whether to post code review comments on pull requests.

", - "BitbucketResourceCapabilities$remediateCode": "

Whether to create pull requests with automated fixes.

", - "Category$isPrimary": "

Indicates whether this is the primary category for the task.

", - "CodeReviewSettings$controlsScanning": "

Indicates whether controls scanning is enabled for code reviews.

", - "CodeReviewSettings$generalPurposeScanning": "

Indicates whether general-purpose scanning is enabled for code reviews.

", - "ConfluenceResourceCapabilities$fetchDocument": "

Whether to fetch documents from this space.

", - "ConfluenceResourceCapabilities$createDocument": "

Whether to create documents in this space.

", - "ConfluenceResourceCapabilities$updateDocument": "

Whether to update documents in this space.

", - "GitHubResourceCapabilities$leaveComments": "

Indicates whether the integration can leave comments on pull requests.

", - "GitHubResourceCapabilities$remediateCode": "

Indicates whether the integration can create code remediation pull requests.

", - "GitLabResourceCapabilities$leaveComments": "

Whether to post code review comments on merge request discussions.

", - "GitLabResourceCapabilities$remediateCode": "

Whether to create merge requests with automated fixes.

" - } - }, - "Category": { - "base": "

Represents a category assigned to a security testing task.

", - "refs": { - "CategoryList$member": null - } - }, - "CategoryList": { - "base": null, - "refs": { - "CodeReviewJobTask$categories": "

The list of categories assigned to the task.

", - "Task$categories": "

The list of categories assigned to the task.

" - } - }, - "CertificateChain": { - "base": "

A PEM-encoded certificate chain for a private connection.

", - "refs": { - "SelfManagedInput$certificate": "

The certificate for the private connection.

", - "ServiceManagedInput$certificate": "

The certificate for the private connection.

", - "UpdatePrivateConnectionCertificateInput$certificate": "

The PEM-encoded certificate chain for the private connection.

" - } - }, - "CleanUpStrategy": { - "base": "

Strategy for handling resources created during a pentest.

", - "refs": { - "Pentest$cleanUpStrategy": "

Strategy for cleaning up resources after pentest job completion.

", - "PentestJob$cleanUpStrategy": "

Strategy for cleaning up resources after pentest job completion.

" - } - }, - "CloudWatchLog": { - "base": "

The Amazon CloudWatch Logs configuration for pentest job logging.

", - "refs": { - "CodeReview$logConfig": "

The CloudWatch Logs configuration for the code review.

", - "CodeReviewJob$logConfig": "

The CloudWatch Logs configuration for the code review job.

", - "CreateCodeReviewInput$logConfig": "

The CloudWatch Logs configuration for the code review.

", - "CreateCodeReviewOutput$logConfig": "

The CloudWatch Logs configuration for the code review.

", - "CreatePentestInput$logConfig": "

The CloudWatch Logs configuration for the pentest.

", - "CreatePentestOutput$logConfig": "

The CloudWatch Logs configuration for the pentest.

", - "CreateThreatModelInput$logConfig": "

The CloudWatch Logs configuration for the threat model.

", - "CreateThreatModelOutput$logConfig": "

The CloudWatch Logs configuration for the threat model.

", - "LogLocation$cloudWatchLog": "

The CloudWatch Logs location for the task logs.

", - "Pentest$logConfig": "

The CloudWatch Logs configuration for the pentest.

", - "PentestJob$logConfig": "

The CloudWatch Logs configuration for the pentest job.

", - "ThreatModel$logConfig": "

The CloudWatch Logs configuration for the threat model.

", - "UpdateCodeReviewInput$logConfig": "

The updated CloudWatch Logs configuration for the code review.

", - "UpdateCodeReviewOutput$logConfig": "

The CloudWatch Logs configuration for the code review.

", - "UpdatePentestInput$logConfig": "

The updated CloudWatch Logs configuration for the pentest.

", - "UpdatePentestOutput$logConfig": "

The CloudWatch Logs configuration for the pentest.

", - "UpdateThreatModelInput$logConfig": "

The updated CloudWatch Logs configuration for the threat model.

", - "UpdateThreatModelOutput$logConfig": "

The CloudWatch Logs configuration for the threat model.

" - } - }, - "CodeLocation": { - "base": "

Represents a location in source code associated with a security finding.

", - "refs": { - "CodeLocationList$member": null - } - }, - "CodeLocationList": { - "base": "

List of code locations.

", - "refs": { - "Finding$codeLocations": "

The file locations involved in the vulnerability, as reported by the code scanner.

" - } - }, - "CodeRemediationStrategy": { - "base": "

Strategy for automated code remediation.

", - "refs": { - "CodeReview$codeRemediationStrategy": "

The code remediation strategy for the code review.

", - "CodeReviewJob$codeRemediationStrategy": "

The code remediation strategy for the code review job.

", - "CreateCodeReviewInput$codeRemediationStrategy": "

The code remediation strategy for the code review. Valid values are AUTOMATIC and DISABLED.

", - "CreateCodeReviewOutput$codeRemediationStrategy": "

The code remediation strategy for the code review.

", - "CreatePentestInput$codeRemediationStrategy": "

The code remediation strategy for the pentest. Valid values are AUTOMATIC and DISABLED.

", - "Pentest$codeRemediationStrategy": "

The code remediation strategy for the pentest.

", - "PentestJob$codeRemediationStrategy": "

The code remediation strategy for the pentest job.

", - "UpdateCodeReviewInput$codeRemediationStrategy": "

The updated code remediation strategy for the code review.

", - "UpdateCodeReviewOutput$codeRemediationStrategy": "

The code remediation strategy for the code review.

", - "UpdatePentestInput$codeRemediationStrategy": "

The updated code remediation strategy for the pentest.

" - } - }, - "CodeRemediationTask": { - "base": "

Represents a code remediation task that was initiated to fix a security finding.

", - "refs": { - "Finding$codeRemediationTask": "

The code remediation task associated with the finding, if code remediation was initiated.

" - } - }, - "CodeRemediationTaskDetails": { - "base": "

Contains details about a code remediation task, including links to the code diff and pull request.

", - "refs": { - "CodeRemediationTaskDetailsList$member": null - } - }, - "CodeRemediationTaskDetailsList": { - "base": null, - "refs": { - "CodeRemediationTask$taskDetails": "

The list of details for the code remediation task, including repository name, code diff link, and pull request link.

" - } - }, - "CodeRemediationTaskStatus": { - "base": "

Code remediation task status.

", - "refs": { - "CodeRemediationTask$status": "

The current status of the code remediation task.

" - } - }, - "CodeReview": { - "base": "

Represents a code review configuration that defines the parameters for automated security-focused code analysis, including target assets and logging configuration.

", - "refs": { - "CodeReviewList$member": null - } - }, - "CodeReviewIdList": { - "base": "

List of code review IDs.

", - "refs": { - "BatchDeleteCodeReviewsInput$codeReviewIds": "

The list of code review identifiers to delete.

", - "BatchDeleteCodeReviewsOutput$deleted": "

The list of identifiers of the code reviews that were successfully deleted.

", - "BatchGetCodeReviewsInput$codeReviewIds": "

The list of code review identifiers to retrieve.

", - "BatchGetCodeReviewsOutput$notFound": "

The list of code review identifiers that were not found.

" - } - }, - "CodeReviewJob": { - "base": "

Represents a code review job, which is an execution instance of a code review. A code review job progresses through preflight, static analysis, and finalizing steps.

", - "refs": { - "CodeReviewJobList$member": null - } - }, - "CodeReviewJobIdList": { - "base": "

List of code review job IDs.

", - "refs": { - "BatchGetCodeReviewJobsInput$codeReviewJobIds": "

The list of code review job identifiers to retrieve.

", - "BatchGetCodeReviewJobsOutput$notFound": "

The list of code review job identifiers that were not found.

" - } - }, - "CodeReviewJobList": { - "base": "

List of code review jobs.

", - "refs": { - "BatchGetCodeReviewJobsOutput$codeReviewJobs": "

The list of code review jobs that were found.

" - } - }, - "CodeReviewJobSummary": { - "base": "

Contains summary information about a code review job.

", - "refs": { - "CodeReviewJobSummaryList$member": null - } - }, - "CodeReviewJobSummaryList": { - "base": "

List of code review job summaries.

", - "refs": { - "ListCodeReviewJobsForCodeReviewOutput$codeReviewJobSummaries": "

The list of code review job summaries.

" - } - }, - "CodeReviewJobTask": { - "base": "

Represents an individual security test task within a code review job. Each task targets a specific risk type and executes independently.

", - "refs": { - "CodeReviewJobTaskList$member": null - } - }, - "CodeReviewJobTaskList": { - "base": "

List of code review job tasks.

", - "refs": { - "BatchGetCodeReviewJobTasksOutput$codeReviewJobTasks": "

The list of code review job tasks that were found.

" - } - }, - "CodeReviewJobTaskSummary": { - "base": "

Contains summary information about a code review job task.

", - "refs": { - "CodeReviewJobTaskSummaryList$member": null - } - }, - "CodeReviewJobTaskSummaryList": { - "base": "

List of code review job task summaries.

", - "refs": { - "ListCodeReviewJobTasksOutput$codeReviewJobTaskSummaries": "

The list of code review job task summaries.

" - } - }, - "CodeReviewList": { - "base": "

List of code reviews.

", - "refs": { - "BatchGetCodeReviewsOutput$codeReviews": "

The list of code reviews that were found.

" - } - }, - "CodeReviewSettings": { - "base": "

The code review settings for an agent space, controlling which types of scanning are enabled.

", - "refs": { - "AgentSpace$codeReviewSettings": "

The code review settings for the agent space.

", - "CreateAgentSpaceInput$codeReviewSettings": "

The code review settings for the agent space.

", - "CreateAgentSpaceOutput$codeReviewSettings": "

The code review settings for the agent space.

", - "UpdateAgentSpaceInput$codeReviewSettings": "

The updated code review settings for the agent space.

", - "UpdateAgentSpaceOutput$codeReviewSettings": "

The code review settings for the agent space.

" - } - }, - "CodeReviewSummary": { - "base": "

Contains summary information about a code review.

", - "refs": { - "CodeReviewSummaryList$member": null - } - }, - "CodeReviewSummaryList": { - "base": "

List of code review summaries.

", - "refs": { - "ListCodeReviewsOutput$codeReviewSummaries": "

The list of code review summaries.

" - } - }, - "ConfidenceLevel": { - "base": "

Finding confidence level.

", - "refs": { - "Finding$confidence": "

The confidence level of the finding. Valid values include FALSE_POSITIVE, UNCONFIRMED, LOW, MEDIUM, and HIGH.

", - "FindingSummary$confidence": "

The confidence level of the finding.

", - "ListFindingsInput$confidence": "

Filter findings by confidence level.

" - } - }, - "ConflictException": { - "base": "

The request could not be completed due to a conflict with the current state of the resource.

", - "refs": {} - }, - "ConfluenceDocumentMetadata": { - "base": "

Metadata for an integrated Confluence document.

", - "refs": { - "IntegratedResourceMetadata$confluenceDocument": null - } - }, - "ConfluenceDocumentResource": { - "base": "

A Confluence document (page) integrated as a resource.

", - "refs": { - "IntegratedResource$confluenceDocument": null - } - }, - "ConfluenceInstallationId": { - "base": "

An Atlassian installation identifier for a Confluence integration.

", - "refs": { - "ConfluenceIntegrationInput$installationId": "

The Atlassian installation identifier, available from the Atlassian administration console.

" - } - }, - "ConfluenceIntegrationInput": { - "base": "

The configuration for creating a Confluence integration.

", - "refs": { - "ProviderInput$confluence": "

The configuration for a Confluence integration.

" - } - }, - "ConfluenceResourceCapabilities": { - "base": "

Capabilities for an integrated Confluence space.

", - "refs": { - "ProviderResourceCapabilities$confluence": null - } - }, - "ConfluenceSiteUrl": { - "base": "

The URL of a Confluence Cloud site.

", - "refs": { - "ConfluenceIntegrationInput$siteUrl": "

The Confluence Cloud site URL, for example https://mysite.atlassian.net.

" - } - }, - "ContextType": { - "base": "

Category of execution context.

", - "refs": { - "ExecutionContext$contextType": "

The type of context. Valid values include ERROR, CLIENT_ERROR, WARNING, and INFO.

" - } - }, - "CreateAgentSpaceInput": { - "base": "

Input for creating a new agent space.

", - "refs": {} - }, - "CreateAgentSpaceOutput": { - "base": "

Output for the CreateAgentSpace operation.

", - "refs": {} - }, - "CreateApplicationRequest": { - "base": null, - "refs": {} - }, - "CreateApplicationResponse": { - "base": null, - "refs": {} - }, - "CreateCodeReviewInput": { - "base": "

Input for creating a new code review.

", - "refs": {} - }, - "CreateCodeReviewOutput": { - "base": "

Output for the CreateCodeReview operation.

", - "refs": {} - }, - "CreateIntegrationInput": { - "base": null, - "refs": {} - }, - "CreateIntegrationOutput": { - "base": null, - "refs": {} - }, - "CreateMembershipRequest": { - "base": "

Request structure for adding a single member to an agent space.

", - "refs": {} - }, - "CreateMembershipResponse": { - "base": "

Response structure for adding a single member to an agent space.

", - "refs": {} - }, - "CreatePentestInput": { - "base": "

Input for creating a new pentest.

", - "refs": {} - }, - "CreatePentestOutput": { - "base": "

Output for the CreatePentest operation.

", - "refs": {} - }, - "CreatePrivateConnectionInput": { - "base": null, - "refs": {} - }, - "CreatePrivateConnectionOutput": { - "base": null, - "refs": {} - }, - "CreateSecurityRequirementEntry": { - "base": "

Contains the details for a security requirement to create within a pack.

", - "refs": { - "CreateSecurityRequirementEntryList$member": null - } - }, - "CreateSecurityRequirementEntryList": { - "base": "

List of security requirements to create.

", - "refs": { - "BatchCreateSecurityRequirementsInput$securityRequirements": "

The list of security requirements to create.

" - } - }, - "CreateSecurityRequirementPackInput": { - "base": null, - "refs": {} - }, - "CreateSecurityRequirementPackOutput": { - "base": null, - "refs": {} - }, - "CreateTargetDomainInput": { - "base": "

Input for creating a new target domain.

", - "refs": {} - }, - "CreateTargetDomainOutput": { - "base": "

Output for the CreateTargetDomain operation.

", - "refs": {} - }, - "CreateThreatInput": { - "base": "

Input for creating a new threat.

", - "refs": {} - }, - "CreateThreatModelInput": { - "base": "

Input for creating a new threat model.

", - "refs": {} - }, - "CreateThreatModelOutput": { - "base": "

Output for the CreateThreatModel operation.

", - "refs": {} - }, - "CreateThreatOutput": { - "base": "

Output for the CreateThreat operation.

", - "refs": {} - }, - "CsrfState": { - "base": "

CSRF state token for OAuth security.

", - "refs": { - "BitbucketIntegrationInput$state": "

The CSRF state token echoed back from the OAuth redirect.

", - "ConfluenceIntegrationInput$state": "

The CSRF state token echoed back from the OAuth redirect.

", - "GitHubIntegrationInput$state": "

The CSRF state token for validating the OAuth flow.

", - "InitiateProviderRegistrationOutput$csrfState": "

The CSRF state token to use when completing the OAuth flow.

" - } - }, - "CustomHeader": { - "base": "

A custom HTTP header to include in network traffic during penetration testing.

", - "refs": { - "CustomHeaderList$member": null - } - }, - "CustomHeaderList": { - "base": "

List of custom headers.

", - "refs": { - "NetworkTrafficConfig$customHeaders": "

The list of custom HTTP headers to include in network traffic during testing.

" - } - }, - "DNSRecordType": { - "base": "

Type of DNS record.

", - "refs": { - "DnsVerification$dnsRecordType": "

The type of DNS record to create. Currently, only TXT is supported.

" - } - }, - "DefaultKmsKeyId": { - "base": "

Identifier of a KMS key. Can be a key ID, key ARN, alias name, or alias ARN.

", - "refs": { - "ApplicationSummary$defaultKmsKeyId": "

The identifier of the default AWS KMS key used to encrypt data for the application.

", - "CreateApplicationRequest$defaultKmsKeyId": "

The identifier of the default AWS KMS key to use for encrypting data in the application.

", - "GetApplicationResponse$defaultKmsKeyId": "

The identifier of the default AWS KMS key used to encrypt data for the application.

", - "UpdateApplicationRequest$defaultKmsKeyId": "

The updated identifier of the default AWS KMS key for the application.

" - } - }, - "DeleteAgentSpaceInput": { - "base": "

Input for deleting an agent space.

", - "refs": {} - }, - "DeleteAgentSpaceOutput": { - "base": "

Output for the DeleteAgentSpace operation.

", - "refs": {} - }, - "DeleteApplicationRequest": { - "base": null, - "refs": {} - }, - "DeleteArtifactInput": { - "base": null, - "refs": {} - }, - "DeleteArtifactOutput": { - "base": null, - "refs": {} - }, - "DeleteCodeReviewFailure": { - "base": "

Contains information about a code review that failed to delete.

", - "refs": { - "DeleteCodeReviewFailureList$member": null - } - }, - "DeleteCodeReviewFailureList": { - "base": "

List of code review deletion failures.

", - "refs": { - "BatchDeleteCodeReviewsOutput$failed": "

The list of code reviews that failed to delete, including the reason for each failure.

" - } - }, - "DeleteIntegrationInput": { - "base": null, - "refs": {} - }, - "DeleteIntegrationOutput": { - "base": null, - "refs": {} - }, - "DeleteMembershipRequest": { - "base": "

Request structure for removing a single member from an agent space.

", - "refs": {} - }, - "DeleteMembershipResponse": { - "base": "

Response structure for removing a single member from an agent space.

", - "refs": {} - }, - "DeletePentestFailure": { - "base": "

Contains information about a pentest that failed to delete.

", - "refs": { - "DeletePentestFailureList$member": null - } - }, - "DeletePentestFailureList": { - "base": null, - "refs": { - "BatchDeletePentestsOutput$failed": "

The list of pentests that failed to delete, including the reason for each failure.

" - } - }, - "DeletePrivateConnectionInput": { - "base": null, - "refs": {} - }, - "DeletePrivateConnectionOutput": { - "base": null, - "refs": {} - }, - "DeleteSecurityRequirementPackInput": { - "base": null, - "refs": {} - }, - "DeleteSecurityRequirementPackOutput": { - "base": null, - "refs": {} - }, - "DeleteTargetDomainInput": { - "base": "

Input for deleting a target domain.

", - "refs": {} - }, - "DeleteTargetDomainOutput": { - "base": "

Output for the DeleteTargetDomain operation.

", - "refs": {} - }, - "DeleteThreatModelFailure": { - "base": "

Contains information about a threat model that failed to delete.

", - "refs": { - "DeleteThreatModelFailureList$member": null - } - }, - "DeleteThreatModelFailureList": { - "base": "

List of threat model deletion failures.

", - "refs": { - "BatchDeleteThreatModelsOutput$failed": "

The list of threat models that failed to delete, including the reason for each failure.

" - } - }, - "DescribePrivateConnectionInput": { - "base": null, - "refs": {} - }, - "DescribePrivateConnectionOutput": { - "base": null, - "refs": {} - }, - "DiffSource": { - "base": "

Source of the diff for a differential code scan.

", - "refs": { - "StartCodeReviewJobInput$diffSource": "

Source of the diff for a differential scan. When present, the job analyzes only the changed lines instead of performing a full scan.

" - } - }, - "DiscoveredEndpoint": { - "base": "

Represents an endpoint discovered during a pentest job.

", - "refs": { - "DiscoveredEndpointList$member": null - } - }, - "DiscoveredEndpointList": { - "base": null, - "refs": { - "ListDiscoveredEndpointsOutput$discoveredEndpoints": "

The list of discovered endpoints.

" - } - }, - "DnsVerification": { - "base": "

Contains DNS verification details for a target domain, including the DNS record to create for domain ownership verification.

", - "refs": { - "VerificationDetails$dnsTxt": "

The DNS TXT verification details.

" - } - }, - "DocumentInfo": { - "base": "

Represents a document that provides context for security testing.

", - "refs": { - "DocumentList$member": null - } - }, - "DocumentList": { - "base": null, - "refs": { - "Assets$documents": "

The list of documents that provide context for the pentest.

", - "CodeReviewJob$documents": "

The list of documents providing context for the code review job.

", - "CreateThreatModelInput$scopeDocs": "

The scoped documents for the agent to focus on during threat modeling.

", - "CreateThreatModelOutput$scopeDocs": "

The scoped documents for the agent to focus on during threat modeling.

", - "PentestJob$documents": "

The list of documents providing context for the pentest job.

", - "ThreatModel$scopeDocs": "

The scoped documents for the agent to focus on during threat modeling.

", - "ThreatModelJob$documents": "

The list of documents used for threat modeling.

", - "ThreatModelJob$scopeDocs": "

The scoped documents for the agent to focus on during threat modeling.

", - "UpdateThreatModelInput$scopeDocs": "

The updated scoped documents for the agent to focus on during threat modeling.

", - "UpdateThreatModelOutput$scopeDocs": "

The scoped documents for the agent to focus on during threat modeling.

" - } - }, - "DomainVerificationMethod": { - "base": "

Method used to verify domain ownership.

", - "refs": { - "CreateTargetDomainInput$verificationMethod": "

The method to use for verifying domain ownership. Valid values are DNS_TXT, HTTP_ROUTE, and PRIVATE_VPC.

", - "UpdateTargetDomainInput$verificationMethod": "

The updated verification method for the target domain.

", - "VerificationDetails$method": "

The verification method used for the target domain.

" - } - }, - "Double": { - "base": null, - "refs": { - "Task$taskHours": "

The number of active work hours consumed by the task during execution.

", - "TaskSummary$taskHours": "

The number of active work hours consumed by the task during execution.

" - } - }, - "Endpoint": { - "base": "

Represents a target endpoint for penetration testing.

", - "refs": { - "EndpointList$member": null, - "Task$targetEndpoint": "

The target endpoint being tested by the task.

" - } - }, - "EndpointList": { - "base": null, - "refs": { - "Assets$endpoints": "

The list of endpoints to test during the pentest.

", - "PentestJob$endpoints": "

The list of endpoints being tested in the pentest job.

", - "PentestJob$excludePaths": "

The list of paths excluded from the pentest job.

", - "PentestJob$allowedDomains": "

The list of domains allowed during the pentest job.

" - } - }, - "ErrorCode": { - "base": "

Error code for pentest job failure.

", - "refs": { - "ErrorInformation$code": "

The error code. Valid values include CLIENT_ERROR, INTERNAL_ERROR, and STOPPED_BY_USER.

" - } - }, - "ErrorInformation": { - "base": "

Contains error information for a pentest job that encountered an error.

", - "refs": { - "CodeReviewJob$errorInformation": "

Error information if the code review job encountered an error.

", - "PentestJob$errorInformation": "

Error information if the pentest job encountered an error.

", - "ThreatModelJob$errorInformation": "

Error information if the threat model job encountered an error.

" - } - }, - "ExecutionContext": { - "base": "

Contains contextual information about the execution of a pentest job, such as errors, warnings, or informational messages.

", - "refs": { - "ExecutionContextList$member": null - } - }, - "ExecutionContextList": { - "base": null, - "refs": { - "CodeReviewJob$executionContext": "

The execution context messages for the code review job.

", - "PentestJob$executionContext": "

The execution context messages for the pentest job.

" - } - }, - "Finding": { - "base": "

Represents a security finding discovered during a pentest job. A finding contains details about a vulnerability, including its risk level, confidence, and remediation status.

", - "refs": { - "FindingList$member": null - } - }, - "FindingIdList": { - "base": null, - "refs": { - "BatchGetFindingsInput$findingIds": "

The list of finding identifiers to retrieve.

", - "BatchGetFindingsOutput$notFound": "

The list of finding identifiers that were not found.

", - "StartCodeRemediationInput$findingIds": "

The list of finding identifiers to initiate code remediation for.

" - } - }, - "FindingList": { - "base": "

List of findings.

", - "refs": { - "BatchGetFindingsOutput$findings": "

The list of findings that were found.

" - } - }, - "FindingStatus": { - "base": "

Finding status.

", - "refs": { - "Finding$status": "

The current status of the finding. Valid values include ACTIVE, RESOLVED, ACCEPTED, and FALSE_POSITIVE.

", - "FindingSummary$status": "

The current status of the finding.

", - "ListFindingsInput$status": "

Filter findings by status.

", - "UpdateFindingInput$status": "

The updated status for the finding.

" - } - }, - "FindingSummary": { - "base": "

Contains summary information about a security finding.

", - "refs": { - "FindingSummaryList$member": null - } - }, - "FindingSummaryList": { - "base": "

List of finding summaries.

", - "refs": { - "ListFindingsOutput$findingsSummaries": "

The list of finding summaries.

" - } - }, - "GetApplicationRequest": { - "base": null, - "refs": {} - }, - "GetApplicationResponse": { - "base": null, - "refs": {} - }, - "GetArtifactInput": { - "base": null, - "refs": {} - }, - "GetArtifactOutput": { - "base": null, - "refs": {} - }, - "GetIntegrationInput": { - "base": null, - "refs": {} - }, - "GetIntegrationOutput": { - "base": null, - "refs": {} - }, - "GetSecurityRequirementPackInput": { - "base": null, - "refs": {} - }, - "GetSecurityRequirementPackOutput": { - "base": null, - "refs": {} - }, - "GitHubIntegrationInput": { - "base": "

The input required to create a GitHub integration, including the OAuth authorization code and CSRF state.

", - "refs": { - "ProviderInput$github": "

The GitHub-specific input for creating an integration.

" - } - }, - "GitHubOwner": { - "base": "

Name of the GitHub Account or Organization.

", - "refs": { - "GitHubRepositoryMetadata$owner": "

The owner of the GitHub repository.

", - "GitHubRepositoryResource$owner": "

The owner of the GitHub repository.

" - } - }, - "GitHubRepositoryMetadata": { - "base": "

Contains metadata about a GitHub repository that is integrated with the service.

", - "refs": { - "IntegratedResourceMetadata$githubRepository": "

The GitHub repository metadata.

" - } - }, - "GitHubRepositoryResource": { - "base": "

Represents a GitHub repository resource used in an integration.

", - "refs": { - "IntegratedResource$githubRepository": "

The GitHub repository resource information.

" - } - }, - "GitHubResourceCapabilities": { - "base": "

The capabilities enabled for a GitHub resource integration.

", - "refs": { - "ProviderResourceCapabilities$github": "

The GitHub-specific resource capabilities.

" - } - }, - "GitLabIntegrationInput": { - "base": "

The configuration for creating a GitLab integration.

", - "refs": { - "ProviderInput$gitlab": "

The configuration for a GitLab integration.

" - } - }, - "GitLabNamespace": { - "base": "

A GitLab namespace (group or user path).

", - "refs": { - "GitLabRepositoryMetadata$namespace": "

The namespace (group or user path) that owns the project.

", - "GitLabRepositoryResource$namespace": "

The namespace (group or user path) that owns the project.

" - } - }, - "GitLabRepositoryMetadata": { - "base": "

Metadata for an integrated GitLab repository.

", - "refs": { - "IntegratedResourceMetadata$gitlabRepository": null - } - }, - "GitLabRepositoryResource": { - "base": "

A GitLab repository integrated as a resource.

", - "refs": { - "IntegratedResource$gitlabRepository": null - } - }, - "GitLabResourceCapabilities": { - "base": "

Capabilities for an integrated GitLab repository.

", - "refs": { - "ProviderResourceCapabilities$gitlab": null - } - }, - "GitLabTokenType": { - "base": "

The type of GitLab access token.

", - "refs": { - "GitLabIntegrationInput$tokenType": "

The type of GitLab access token provided in accessToken.

" - } - }, - "HostAddress": { - "base": "

The IP address or DNS name of a target resource.

", - "refs": { - "CreatePrivateConnectionOutput$hostAddress": "

The IP address or DNS name of the target resource.

", - "DeletePrivateConnectionOutput$hostAddress": "

The IP address or DNS name of the target resource.

", - "DescribePrivateConnectionOutput$hostAddress": "

The IP address or DNS name of the target resource.

", - "PrivateConnectionSummary$hostAddress": "

The IP address or DNS name of the target resource.

", - "ServiceManagedInput$hostAddress": "

The IP address or DNS name of the target resource.

", - "UpdatePrivateConnectionCertificateOutput$hostAddress": "

The IP address or DNS name of the target resource.

" - } - }, - "HttpVerification": { - "base": "

Contains HTTP route verification details for a target domain, including the route path and token to serve for domain ownership verification.

", - "refs": { - "VerificationDetails$httpRoute": "

The HTTP route verification details.

" - } - }, - "IamRoles": { - "base": null, - "refs": { - "AWSResources$iamRoles": "

The IAM roles associated with the agent space.

" - } - }, - "IdCApplicationArn": { - "base": "

ARN of the IAM Identity Center application associated with this application.

", - "refs": { - "IdCConfiguration$idcApplicationArn": "

The Amazon Resource Name (ARN) of the IAM Identity Center application.

" - } - }, - "IdCConfiguration": { - "base": "

The IAM Identity Center configuration for an application.

", - "refs": { - "GetApplicationResponse$idcConfiguration": "

The IAM Identity Center configuration for the application.

" - } - }, - "IdCInstanceArn": { - "base": "

ARN of the IAM Identity Center instance used for user authentication.

", - "refs": { - "CreateApplicationRequest$idcInstanceArn": "

The Amazon Resource Name (ARN) of the IAM Identity Center instance to associate with the application.

", - "IdCConfiguration$idcInstanceArn": "

The Amazon Resource Name (ARN) of the IAM Identity Center instance.

" - } - }, - "ImportSecurityRequirementsInput": { - "base": null, - "refs": {} - }, - "ImportSecurityRequirementsOutput": { - "base": null, - "refs": {} - }, - "ImportSource": { - "base": "

The source from which to import security requirements. Currently supports document uploads.

", - "refs": { - "ImportSecurityRequirementsInput$input": "

The import source containing the documents to extract security requirements from.

" - } - }, - "InitiateProviderRegistrationInput": { - "base": null, - "refs": {} - }, - "InitiateProviderRegistrationOutput": { - "base": null, - "refs": {} - }, - "Integer": { - "base": null, - "refs": { - "CodeLocation$lineStart": "

The starting line number of the code location.

", - "CodeLocation$lineEnd": "

The ending line number of the code location.

" - } - }, - "IntegratedDocument": { - "base": "

A reference to a document in a third-party provider, such as a Confluence page linked via an integration.

", - "refs": { - "DocumentInfo$integratedDocument": "

A reference to a document in an integrated third-party provider.

" - } - }, - "IntegratedRepository": { - "base": "

Represents a code repository that is integrated with the service through a third-party provider.

", - "refs": { - "IntegratedRepositoryList$member": null - } - }, - "IntegratedRepositoryList": { - "base": null, - "refs": { - "Assets$integratedRepositories": "

The list of integrated repositories associated with the pentest.

", - "CodeReviewJob$integratedRepositories": "

The list of integrated repositories associated with the code review job.

", - "PentestJob$integratedRepositories": "

The list of integrated repositories associated with the pentest job.

", - "ThreatModelJob$integratedRepositories": "

The list of integrated repositories used for threat modeling.

" - } - }, - "IntegratedResource": { - "base": "

Represents an integrated resource from a third-party provider. This is a union type that contains provider-specific resource information.

", - "refs": { - "IntegratedResourceInputItem$resource": "

The integrated resource to update.

" - } - }, - "IntegratedResourceInputItem": { - "base": "

Represents an input item for updating integrated resources, including the resource and its capabilities.

", - "refs": { - "IntegratedResourceInputItemList$member": null - } - }, - "IntegratedResourceInputItemList": { - "base": "

List of integrated resources.

", - "refs": { - "UpdateIntegratedResourcesInput$items": "

The list of integrated resource items to update.

" - } - }, - "IntegratedResourceMetadata": { - "base": "

Contains metadata about an integrated resource. This is a union type that contains provider-specific metadata.

", - "refs": { - "IntegratedResourceSummary$resource": "

The metadata for the integrated resource.

" - } - }, - "IntegratedResourceSummary": { - "base": "

Contains summary information about an integrated resource.

", - "refs": { - "IntegratedResourceSummaryList$member": null - } - }, - "IntegratedResourceSummaryList": { - "base": "

List of integrated resource items.

", - "refs": { - "ListIntegratedResourcesOutput$integratedResourceSummaries": "

The list of integrated resource summaries.

" - } - }, - "IntegrationFilter": { - "base": "

A filter for listing integrations. This is a union type where you can filter by provider or provider type.

", - "refs": { - "ListIntegrationsInput$filter": "

A filter to apply to the list of integrations.

" - } - }, - "IntegrationId": { - "base": "

Unique identifier for an integration.

", - "refs": { - "CreateIntegrationOutput$integrationId": "

The unique identifier of the created integration.

", - "DeleteIntegrationInput$integrationId": "

The unique identifier of the integration to delete.

", - "GetIntegrationInput$integrationId": "

The unique identifier of the integration to retrieve.

", - "GetIntegrationOutput$integrationId": "

The unique identifier of the integration.

", - "IntegratedResourceSummary$integrationId": "

The unique identifier of the integration that provides access to the resource.

", - "ListIntegratedResourcesInput$integrationId": "

The unique identifier of the integration to filter by.

", - "UpdateIntegratedResourcesInput$integrationId": "

The unique identifier of the integration.

" - } - }, - "IntegrationSummary": { - "base": "

Contains summary information about an integration.

", - "refs": { - "IntegrationSummaryList$member": null - } - }, - "IntegrationSummaryList": { - "base": "

List of integration summaries.

", - "refs": { - "ListIntegrationsOutput$integrationSummaries": "

The list of integration summaries.

" - } - }, - "InternalServerException": { - "base": "

An unexpected error occurred during the processing of your request.

", - "refs": {} - }, - "IpAddressType": { - "base": "

The IP address type of a resource gateway.

", - "refs": { - "ServiceManagedInput$ipAddressType": "

The IP address type of the service-managed resource gateway.

" - } - }, - "JobStatus": { - "base": "

Status of a pentest job.

", - "refs": { - "CodeReviewJob$status": "

The current status of the code review job.

", - "CodeReviewJobSummary$status": "

The current status of the code review job.

", - "PentestJob$status": "

The current status of the pentest job.

", - "PentestJobSummary$status": "

The current status of the pentest job.

", - "StartCodeReviewJobOutput$status": "

The current status of the code review job.

", - "StartPentestJobOutput$status": "

The current status of the pentest job.

", - "StartThreatModelJobOutput$status": "

The current status of the threat model job.

", - "ThreatModelJob$status": "

The current status of the threat model job.

", - "ThreatModelJobSummary$status": "

The current status of the threat model job.

" - } - }, - "KmsKeyId": { - "base": "

Identifier of a KMS key. Can be a key ID, key ARN, alias name, or alias ARN.

", - "refs": { - "AgentSpace$kmsKeyId": "

The identifier of the AWS KMS key used to encrypt data in the agent space.

", - "CreateAgentSpaceInput$kmsKeyId": "

The identifier of the AWS KMS key to use for encrypting data in the agent space.

", - "CreateAgentSpaceOutput$kmsKeyId": "

The identifier of the AWS KMS key used to encrypt data in the agent space.

", - "CreateIntegrationInput$kmsKeyId": "

The identifier of the AWS KMS key to use for encrypting data associated with the integration.

", - "CreateSecurityRequirementPackInput$kmsKeyId": "

The identifier of the AWS KMS key used to encrypt pack contents.

", - "CreateSecurityRequirementPackOutput$kmsKeyId": "

The identifier of the AWS KMS key used to encrypt pack contents.

", - "GetIntegrationOutput$kmsKeyId": "

The identifier of the AWS KMS key used to encrypt data associated with the integration.

", - "GetSecurityRequirementPackOutput$kmsKeyId": "

The identifier of the AWS KMS key used to encrypt pack contents.

" - } - }, - "LambdaFunctionArn": { - "base": "

Lambda function ARN or name for agent space AWS resources.

", - "refs": { - "LambdaFunctionArns$member": null - } - }, - "LambdaFunctionArns": { - "base": null, - "refs": { - "AWSResources$lambdaFunctionArns": "

The Amazon Resource Names (ARNs) of the Lambda functions associated with the agent space.

" - } - }, - "ListAgentSpacesInput": { - "base": "

Input for listing agent spaces.

", - "refs": {} - }, - "ListAgentSpacesOutput": { - "base": "

Output for the ListAgentSpaces operation.

", - "refs": {} - }, - "ListApplicationsRequest": { - "base": null, - "refs": {} - }, - "ListApplicationsResponse": { - "base": null, - "refs": {} - }, - "ListArtifactsInput": { - "base": null, - "refs": {} - }, - "ListArtifactsOutput": { - "base": null, - "refs": {} - }, - "ListCodeReviewJobTasksInput": { - "base": "

Input for listing tasks associated with a code review job.

", - "refs": {} - }, - "ListCodeReviewJobTasksOutput": { - "base": "

Output for the ListCodeReviewJobTasks operation.

", - "refs": {} - }, - "ListCodeReviewJobsForCodeReviewInput": { - "base": "

Input for ListCodeReviewJobsForCodeReview operation.

", - "refs": {} - }, - "ListCodeReviewJobsForCodeReviewOutput": { - "base": "

Output for the ListCodeReviewJobsForCodeReview operation.

", - "refs": {} - }, - "ListCodeReviewsInput": { - "base": "

Input for listing code reviews with optional filtering.

", - "refs": {} - }, - "ListCodeReviewsOutput": { - "base": "

Output for the ListCodeReviews operation.

", - "refs": {} - }, - "ListDiscoveredEndpointsInput": { - "base": "

Input for ListDiscoveredEndpoints operation.

", - "refs": {} - }, - "ListDiscoveredEndpointsOutput": { - "base": "

Output for the ListDiscoveredEndpoints operation.

", - "refs": {} - }, - "ListFindingsInput": { - "base": "

Input for ListFindings operation with filtering support.

", - "refs": {} - }, - "ListFindingsOutput": { - "base": "

Output for the ListFindings operation.

", - "refs": {} - }, - "ListIntegratedResourcesInput": { - "base": null, - "refs": {} - }, - "ListIntegratedResourcesOutput": { - "base": null, - "refs": {} - }, - "ListIntegrationsInput": { - "base": null, - "refs": {} - }, - "ListIntegrationsOutput": { - "base": null, - "refs": {} - }, - "ListMembershipsRequest": { - "base": "

Request structure for listing agent space members.

", - "refs": {} - }, - "ListMembershipsResponse": { - "base": "

Response structure for listing members associated to an agent space.

", - "refs": {} - }, - "ListPentestJobTasksInput": { - "base": "

Input for listing tasks associated with a pentest job.

", - "refs": {} - }, - "ListPentestJobTasksOutput": { - "base": "

Output for the ListPentestJobTasks operation.

", - "refs": {} - }, - "ListPentestJobsForPentestInput": { - "base": "

Input for ListPentestJobsForPentest operation.

", - "refs": {} - }, - "ListPentestJobsForPentestOutput": { - "base": "

Output for the ListPentestJobsForPentest operation.

", - "refs": {} - }, - "ListPentestsInput": { - "base": "

Input for listing pentests with optional filtering.

", - "refs": {} - }, - "ListPentestsOutput": { - "base": "

Output for the ListPentests operation.

", - "refs": {} - }, - "ListPrivateConnectionsInput": { - "base": null, - "refs": {} - }, - "ListPrivateConnectionsOutput": { - "base": null, - "refs": {} - }, - "ListSecurityRequirementPackFilter": { - "base": "

Filter criteria for listing security requirement packs.

", - "refs": { - "ListSecurityRequirementPacksInput$filter": "

The filter criteria for listing security requirement packs.

" - } - }, - "ListSecurityRequirementPacksInput": { - "base": null, - "refs": {} - }, - "ListSecurityRequirementPacksOutput": { - "base": null, - "refs": {} - }, - "ListSecurityRequirementsInput": { - "base": null, - "refs": {} - }, - "ListSecurityRequirementsOutput": { - "base": null, - "refs": {} - }, - "ListTagsForResourceInput": { - "base": "

Input for ListTagsForResource operation.

", - "refs": {} - }, - "ListTagsForResourceOutput": { - "base": "

Output for ListTagsForResource operation.

", - "refs": {} - }, - "ListTargetDomainsInput": { - "base": "

Input for listing target domains.

", - "refs": {} - }, - "ListTargetDomainsOutput": { - "base": "

Output for the ListTargetDomains operation.

", - "refs": {} - }, - "ListThreatModelJobTasksInput": { - "base": "

Input for listing tasks associated with a threat model job.

", - "refs": {} - }, - "ListThreatModelJobTasksOutput": { - "base": "

Output for the ListThreatModelJobTasks operation.

", - "refs": {} - }, - "ListThreatModelJobsInput": { - "base": "

Input for ListThreatModelJobs operation.

", - "refs": {} - }, - "ListThreatModelJobsOutput": { - "base": "

Output for the ListThreatModelJobs operation.

", - "refs": {} - }, - "ListThreatModelsInput": { - "base": "

Input for listing threat models.

", - "refs": {} - }, - "ListThreatModelsOutput": { - "base": "

Output for the ListThreatModels operation.

", - "refs": {} - }, - "ListThreatsInput": { - "base": "

Input for listing threats.

", - "refs": {} - }, - "ListThreatsOutput": { - "base": "

Output for the ListThreats operation.

", - "refs": {} - }, - "Location": { - "base": "

Location URL for OAuth redirect.

", - "refs": { - "InitiateProviderRegistrationOutput$redirectTo": "

The URL to redirect the user to for completing the OAuth authorization.

" - } - }, - "LogGroupArn": { - "base": "

Log group ARN or name for agent space AWS resources.

", - "refs": { - "LogGroupArns$member": null - } - }, - "LogGroupArns": { - "base": null, - "refs": { - "AWSResources$logGroups": "

The Amazon Resource Names (ARNs) of the CloudWatch log groups associated with the agent space.

" - } - }, - "LogLocation": { - "base": "

The log location for a task, specifying where task execution logs are stored.

", - "refs": { - "CodeReviewJobTask$logsLocation": "

The location of the task execution logs.

", - "Task$logsLocation": "

The location of the task execution logs.

", - "ThreatModelJobTask$logsLocation": "

The location of the task execution logs.

" - } - }, - "LogType": { - "base": "

Type of log storage.

", - "refs": { - "LogLocation$logType": "

The type of log storage. Currently, only CLOUDWATCH is supported.

" - } - }, - "ManagementType": { - "base": null, - "refs": { - "GetSecurityRequirementPackOutput$managementType": "

The management type of the pack. Valid values are AWS_MANAGED and CUSTOMER_MANAGED.

", - "ListSecurityRequirementPackFilter$managementType": "

Filter packs by management type. Valid values are AWS_MANAGED and CUSTOMER_MANAGED.

", - "SecurityRequirementPackSummary$managementType": "

The management type of the pack.

" - } - }, - "MaxIpv4AddressesPerEni": { - "base": "

The number of IPv4 addresses in each elastic network interface for the resource gateway.

", - "refs": { - "ServiceManagedInput$ipv4AddressesPerEni": "

The number of IPv4 addresses in each elastic network interface for the service-managed resource gateway.

" - } - }, - "MaxResults": { - "base": "

Maximum results for pagination.

", - "refs": { - "ListAgentSpacesInput$maxResults": "

The maximum number of results to return in a single call.

", - "ListApplicationsRequest$maxResults": "

The maximum number of results to return in a single call.

", - "ListArtifactsInput$maxResults": "

The maximum number of results to return in a single call.

", - "ListCodeReviewJobTasksInput$maxResults": "

The maximum number of results to return in a single call.

", - "ListCodeReviewJobsForCodeReviewInput$maxResults": "

The maximum number of results to return in a single call.

", - "ListCodeReviewsInput$maxResults": "

The maximum number of results to return in a single call.

", - "ListDiscoveredEndpointsInput$maxResults": "

The maximum number of results to return in a single call.

", - "ListFindingsInput$maxResults": "

The maximum number of results to return in a single call.

", - "ListIntegratedResourcesInput$maxResults": "

The maximum number of results to return in a single call.

", - "ListIntegrationsInput$maxResults": "

The maximum number of results to return in a single call.

", - "ListMembershipsRequest$maxResults": "

The maximum number of results to return in a single call.

", - "ListPentestJobTasksInput$maxResults": "

The maximum number of results to return in a single call.

", - "ListPentestJobsForPentestInput$maxResults": "

The maximum number of results to return in a single call.

", - "ListPentestsInput$maxResults": "

The maximum number of results to return in a single call.

", - "ListPrivateConnectionsInput$maxResults": "

The maximum number of private connections to return in a single response.

", - "ListSecurityRequirementPacksInput$maxResults": "

The maximum number of results to return in a single request.

", - "ListSecurityRequirementsInput$maxResults": "

The maximum number of results to return in a single request.

", - "ListTargetDomainsInput$maxResults": "

The maximum number of results to return in a single call.

", - "ListThreatModelJobTasksInput$maxResults": "

The maximum number of results to return in a single call.

", - "ListThreatModelJobsInput$maxResults": "

The maximum number of results to return in a single call.

", - "ListThreatModelsInput$maxResults": "

The maximum number of results to return in a single call.

", - "ListThreatsInput$maxResults": "

The maximum number of results to return in a single call.

" - } - }, - "MemberMetadata": { - "base": "

Contains metadata about a member. This is a union type that contains member-type-specific metadata.

", - "refs": { - "MembershipSummary$metadata": "

The metadata for the member.

" - } - }, - "MembershipConfig": { - "base": "

The configuration for a membership. This is a union type that contains member-type-specific configuration.

", - "refs": { - "CreateMembershipRequest$config": "

The configuration for the membership, such as the user role.

", - "MembershipSummary$config": "

The configuration for the membership.

" - } - }, - "MembershipId": { - "base": "

Member identifier.

", - "refs": { - "CreateMembershipRequest$membershipId": "

The unique identifier for the membership.

", - "DeleteMembershipRequest$membershipId": "

The unique identifier of the membership to delete.

", - "MembershipSummary$membershipId": "

The unique identifier of the membership.

" - } - }, - "MembershipSummary": { - "base": "

Contains summary information about a membership.

", - "refs": { - "MembershipSummaryList$member": null - } - }, - "MembershipSummaryList": { - "base": "

List of membership summaries.

", - "refs": { - "ListMembershipsResponse$membershipSummaries": "

The list of membership summaries.

" - } - }, - "MembershipType": { - "base": "

Type of membership.

", - "refs": { - "CreateMembershipRequest$memberType": "

The type of member. Currently, only USER is supported.

", - "DeleteMembershipRequest$memberType": "

The type of member to remove.

", - "MembershipSummary$memberType": "

The type of member.

" - } - }, - "MembershipTypeFilter": { - "base": "

Filter for member type in list operations.

", - "refs": { - "ListMembershipsRequest$memberType": "

Filter memberships by member type.

" - } - }, - "NetworkTrafficConfig": { - "base": "

The network traffic configuration for a pentest, including custom headers and traffic rules.

", - "refs": { - "CreatePentestInput$networkTrafficConfig": "

The network traffic configuration for the pentest, including custom headers and traffic rules.

", - "Pentest$networkTrafficConfig": "

The network traffic configuration for the pentest.

", - "PentestJob$networkTrafficConfig": "

The network traffic configuration for the pentest job.

", - "UpdatePentestInput$networkTrafficConfig": "

The updated network traffic configuration for the pentest.

" - } - }, - "NetworkTrafficRule": { - "base": "

A rule that controls network traffic during penetration testing by allowing or denying traffic to specific URL patterns.

", - "refs": { - "NetworkTrafficRuleList$member": null - } - }, - "NetworkTrafficRuleEffect": { - "base": "

Effect of a network traffic rule.

", - "refs": { - "NetworkTrafficRule$effect": "

The effect of the rule. Valid values are ALLOW and DENY.

" - } - }, - "NetworkTrafficRuleList": { - "base": "

List of network traffic rules.

", - "refs": { - "NetworkTrafficConfig$rules": "

The list of network traffic rules that control which URLs are allowed or denied during testing.

" - } - }, - "NetworkTrafficRuleType": { - "base": "

Type of network traffic rule.

", - "refs": { - "NetworkTrafficRule$networkTrafficRuleType": "

The type of the network traffic rule. Currently, only URL is supported.

" - } - }, - "NextToken": { - "base": "

Pagination token.

", - "refs": { - "ListAgentSpacesInput$nextToken": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

", - "ListAgentSpacesOutput$nextToken": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

", - "ListApplicationsRequest$nextToken": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

", - "ListApplicationsResponse$nextToken": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

", - "ListArtifactsInput$nextToken": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

", - "ListArtifactsOutput$nextToken": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

", - "ListCodeReviewJobTasksInput$nextToken": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

", - "ListCodeReviewJobTasksOutput$nextToken": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

", - "ListCodeReviewJobsForCodeReviewInput$nextToken": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

", - "ListCodeReviewJobsForCodeReviewOutput$nextToken": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

", - "ListCodeReviewsInput$nextToken": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

", - "ListCodeReviewsOutput$nextToken": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

", - "ListDiscoveredEndpointsInput$nextToken": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

", - "ListDiscoveredEndpointsOutput$nextToken": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

", - "ListFindingsInput$nextToken": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

", - "ListFindingsOutput$nextToken": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

", - "ListIntegratedResourcesInput$nextToken": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

", - "ListIntegratedResourcesOutput$nextToken": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

", - "ListIntegrationsInput$nextToken": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

", - "ListIntegrationsOutput$nextToken": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

", - "ListMembershipsRequest$nextToken": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

", - "ListMembershipsResponse$nextToken": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

", - "ListPentestJobTasksInput$nextToken": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

", - "ListPentestJobTasksOutput$nextToken": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

", - "ListPentestJobsForPentestInput$nextToken": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

", - "ListPentestJobsForPentestOutput$nextToken": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

", - "ListPentestsInput$nextToken": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

", - "ListPentestsOutput$nextToken": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

", - "ListPrivateConnectionsInput$nextToken": "

The token for the next page of results.

", - "ListPrivateConnectionsOutput$nextToken": "

The token to use to retrieve the next page of results, if more results are available.

", - "ListSecurityRequirementPacksInput$nextToken": "

The pagination token from a previous request to retrieve the next page of results.

", - "ListSecurityRequirementPacksOutput$nextToken": "

The pagination token to use in a subsequent request to retrieve the next page of results.

", - "ListSecurityRequirementsInput$nextToken": "

The pagination token from a previous request to retrieve the next page of results.

", - "ListSecurityRequirementsOutput$nextToken": "

The pagination token to use in a subsequent request to retrieve the next page of results.

", - "ListTargetDomainsInput$nextToken": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

", - "ListTargetDomainsOutput$nextToken": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

", - "ListThreatModelJobTasksInput$nextToken": "

A token to use for paginating results that are returned in the response.

", - "ListThreatModelJobTasksOutput$nextToken": "

A token to use for paginating results that are returned in the response.

", - "ListThreatModelJobsInput$nextToken": "

A token to use for paginating results that are returned in the response.

", - "ListThreatModelJobsOutput$nextToken": "

A token to use for paginating results that are returned in the response.

", - "ListThreatModelsInput$nextToken": "

A token to use for paginating results that are returned in the response.

", - "ListThreatModelsOutput$nextToken": "

A token to use for paginating results that are returned in the response.

", - "ListThreatsInput$nextToken": "

A token to use for paginating results that are returned in the response.

", - "ListThreatsOutput$nextToken": "

A token to use for paginating results that are returned in the response.

" - } - }, - "Pentest": { - "base": "

Represents a pentest configuration that defines the parameters for security testing, including target assets, risk type exclusions, and infrastructure settings.

", - "refs": { - "PentestList$member": null - } - }, - "PentestIdList": { - "base": null, - "refs": { - "BatchDeletePentestsInput$pentestIds": "

The list of pentest identifiers to delete.

", - "BatchGetPentestsInput$pentestIds": "

The list of pentest identifiers to retrieve.

", - "BatchGetPentestsOutput$notFound": "

The list of pentest identifiers that were not found.

" - } - }, - "PentestJob": { - "base": "

Represents a pentest job, which is an execution instance of a pentest. A pentest job progresses through preflight, static analysis, pentest, and finalizing steps.

", - "refs": { - "PentestJobList$member": null - } - }, - "PentestJobIdList": { - "base": null, - "refs": { - "BatchGetPentestJobsInput$pentestJobIds": "

The list of pentest job identifiers to retrieve.

", - "BatchGetPentestJobsOutput$notFound": "

The list of pentest job identifiers that were not found.

" - } - }, - "PentestJobList": { - "base": null, - "refs": { - "BatchGetPentestJobsOutput$pentestJobs": "

The list of pentest jobs that were found.

" - } - }, - "PentestJobSummary": { - "base": "

Contains summary information about a pentest job.

", - "refs": { - "PentestJobSummaryList$member": null - } - }, - "PentestJobSummaryList": { - "base": null, - "refs": { - "ListPentestJobsForPentestOutput$pentestJobSummaries": "

The list of pentest job summaries.

" - } - }, - "PentestList": { - "base": null, - "refs": { - "BatchDeletePentestsOutput$deleted": "

The list of pentests that were successfully deleted.

", - "BatchGetPentestsOutput$pentests": "

The list of pentests that were found.

" - } - }, - "PentestSummary": { - "base": "

Contains summary information about a pentest.

", - "refs": { - "PentestSummaryList$member": null - } - }, - "PentestSummaryList": { - "base": null, - "refs": { - "ListPentestsOutput$pentestSummaries": "

The list of pentest summaries.

" - } - }, - "PortRange": { - "base": "

A single TCP port or an inclusive range of TCP ports, for example 443 or 8000-8100.

", - "refs": { - "PortRanges$member": null - } - }, - "PortRanges": { - "base": "

The TCP port ranges that a consumer can use to access the resource.

", - "refs": { - "ServiceManagedInput$portRanges": "

The TCP port ranges that a consumer can use to access the resource.

" - } - }, - "PrivateConnectionList": { - "base": "

A list of private connection summaries.

", - "refs": { - "ListPrivateConnectionsOutput$privateConnections": "

The list of private connections.

" - } - }, - "PrivateConnectionMode": { - "base": "

The configuration for a private connection. Specify either a service-managed or a self-managed mode.

", - "refs": { - "CreatePrivateConnectionInput$mode": "

The configuration for the private connection. Specify either a service-managed or a self-managed mode.

" - } - }, - "PrivateConnectionName": { - "base": "

The unique name of a private connection within your account.

", - "refs": { - "CreateIntegrationInput$privateConnectionName": "

The name of an active private connection used to reach a self-hosted provider instance over private networking. Specify this when the instance is not publicly reachable.

", - "CreatePrivateConnectionInput$privateConnectionName": "

A unique name for the private connection within your account.

", - "CreatePrivateConnectionOutput$name": "

The name of the private connection.

", - "DeletePrivateConnectionInput$privateConnectionName": "

The name of the private connection to delete.

", - "DeletePrivateConnectionOutput$name": "

The name of the private connection.

", - "DescribePrivateConnectionInput$privateConnectionName": "

The name of the private connection to describe.

", - "DescribePrivateConnectionOutput$name": "

The name of the private connection.

", - "GetIntegrationOutput$privateConnectionName": "

The name of the private connection used to reach the integration's self-hosted instance over private networking, if one is configured.

", - "IntegrationSummary$privateConnectionName": "

The name of the private connection used to reach the integration's self-hosted instance over private networking, if one is configured.

", - "PrivateConnectionSummary$name": "

The name of the private connection.

", - "UpdatePrivateConnectionCertificateInput$privateConnectionName": "

The name of the private connection to update.

", - "UpdatePrivateConnectionCertificateOutput$name": "

The name of the private connection.

" - } - }, - "PrivateConnectionSecurityGroupId": { - "base": "

The identifier of a security group.

", - "refs": { - "PrivateConnectionSecurityGroupIds$member": null - } - }, - "PrivateConnectionSecurityGroupIds": { - "base": "

The security groups attached to the resource gateway.

", - "refs": { - "ServiceManagedInput$securityGroupIds": "

The security groups to attach to the service-managed resource gateway.

" - } - }, - "PrivateConnectionStatus": { - "base": "

The status of a private connection.

", - "refs": { - "CreatePrivateConnectionOutput$status": "

The current status of the private connection.

", - "DeletePrivateConnectionOutput$status": "

The current status of the private connection.

", - "DescribePrivateConnectionOutput$status": "

The current status of the private connection.

", - "PrivateConnectionSummary$status": "

The current status of the private connection.

", - "UpdatePrivateConnectionCertificateOutput$status": "

The current status of the private connection.

" - } - }, - "PrivateConnectionSubnetId": { - "base": "

The identifier of a subnet.

", - "refs": { - "PrivateConnectionSubnetIds$member": null - } - }, - "PrivateConnectionSubnetIds": { - "base": "

The subnets that the resource gateway spans.

", - "refs": { - "ServiceManagedInput$subnetIds": "

The subnets that the service-managed resource gateway spans.

" - } - }, - "PrivateConnectionSummary": { - "base": "

Summarizes a private connection.

", - "refs": { - "PrivateConnectionList$member": null - } - }, - "PrivateConnectionType": { - "base": "

The type of a private connection, indicating whether it is service-managed or self-managed.

", - "refs": { - "CreatePrivateConnectionOutput$type": "

The type of the private connection, indicating whether it is service-managed or self-managed.

", - "DeletePrivateConnectionOutput$type": "

The type of the private connection, indicating whether it is service-managed or self-managed.

", - "DescribePrivateConnectionOutput$type": "

The type of the private connection, indicating whether it is service-managed or self-managed.

", - "PrivateConnectionSummary$type": "

The type of the private connection, indicating whether it is service-managed or self-managed.

", - "UpdatePrivateConnectionCertificateOutput$type": "

The type of the private connection, indicating whether it is service-managed or self-managed.

" - } - }, - "PrivateConnectionVpcId": { - "base": "

The identifier of a VPC.

", - "refs": { - "CreatePrivateConnectionOutput$vpcId": "

The identifier of the VPC the resource gateway is created in.

", - "DeletePrivateConnectionOutput$vpcId": "

The identifier of the VPC the resource gateway is created in.

", - "DescribePrivateConnectionOutput$vpcId": "

The identifier of the VPC the resource gateway is created in.

", - "PrivateConnectionSummary$vpcId": "

The identifier of the VPC the resource gateway is created in.

", - "ServiceManagedInput$vpcId": "

The VPC to create the service-managed resource gateway in.

", - "UpdatePrivateConnectionCertificateOutput$vpcId": "

The identifier of the VPC the resource gateway is created in.

" - } - }, - "Provider": { - "base": "

Third-party provider type.

", - "refs": { - "CreateIntegrationInput$provider": "

The integration provider. Currently, only GITHUB is supported.

", - "GetIntegrationOutput$provider": "

The integration provider.

", - "InitiateProviderRegistrationInput$provider": "

The provider to initiate registration with. Currently, only GITHUB is supported.

", - "IntegrationFilter$provider": "

Filter integrations by provider.

", - "IntegrationSummary$provider": "

The integration provider.

" - } - }, - "ProviderInput": { - "base": "

The provider-specific input for creating an integration. This is a union type that contains provider-specific configuration.

", - "refs": { - "CreateIntegrationInput$input": "

The provider-specific input required to create the integration.

" - } - }, - "ProviderResourceCapabilities": { - "base": "

The capabilities for an integrated resource from a third-party provider. This is a union type that contains provider-specific capabilities.

", - "refs": { - "IntegratedResourceInputItem$capabilities": "

The capabilities to enable for the integrated resource.

", - "IntegratedResourceSummary$capabilities": "

The capabilities enabled for the integrated resource.

" - } - }, - "ProviderResourceId": { - "base": "

Provider Id of the resource e.g. GitHub repository id, etc.

", - "refs": { - "BitbucketRepositoryMetadata$providerResourceId": null, - "ConfluenceDocumentMetadata$providerResourceId": null, - "GitHubRepositoryMetadata$providerResourceId": "

The provider-specific resource identifier for the GitHub repository.

", - "GitLabRepositoryMetadata$providerResourceId": null - } - }, - "ProviderResourceName": { - "base": "

Name of the resource e.g. repository name, etc.

", - "refs": { - "BitbucketRepositoryMetadata$name": null, - "BitbucketRepositoryResource$name": null, - "ConfluenceDocumentMetadata$name": null, - "ConfluenceDocumentResource$name": null, - "GitHubRepositoryMetadata$name": "

The name of the GitHub repository.

", - "GitHubRepositoryResource$name": "

The name of the GitHub repository.

", - "GitLabRepositoryMetadata$name": null, - "GitLabRepositoryResource$name": null - } - }, - "ProviderType": { - "base": "

Type of provider integration.

", - "refs": { - "GetIntegrationOutput$providerType": "

The type of the integration provider.

", - "IntegrationFilter$providerType": "

Filter integrations by provider type.

", - "IntegrationSummary$providerType": "

The type of the integration provider.

" - } - }, - "ReportDestination": { - "base": "

Destination for publishing scan reports to an integrated document provider.

", - "refs": { - "CreateThreatModelInput$reportDestination": "

The destination for publishing scan reports to an integrated document provider.

" - } - }, - "ResourceArn": { - "base": "

ARN of a taggable resource.

", - "refs": { - "ListTagsForResourceInput$resourceArn": "

The Amazon Resource Name (ARN) of the resource to list tags for.

", - "TagResourceInput$resourceArn": "

The Amazon Resource Name (ARN) of the resource to tag.

", - "UntagResourceInput$resourceArn": "

The Amazon Resource Name (ARN) of the resource to remove tags from.

" - } - }, - "ResourceConfigDnsResolution": { - "base": "

The DNS resolution mode for a resource gateway.

", - "refs": { - "CreatePrivateConnectionOutput$dnsResolution": "

The DNS resolution mode for the resource gateway.

", - "DeletePrivateConnectionOutput$dnsResolution": "

The DNS resolution mode for the resource gateway.

", - "DescribePrivateConnectionOutput$dnsResolution": "

The DNS resolution mode for the resource gateway.

", - "PrivateConnectionSummary$dnsResolution": "

The DNS resolution mode for the resource gateway.

", - "ServiceManagedInput$dnsResolution": "

The DNS resolution mode for the resource gateway. Defaults to PUBLIC when not set.

", - "UpdatePrivateConnectionCertificateOutput$dnsResolution": "

The DNS resolution mode for the resource gateway.

" - } - }, - "ResourceConfigurationId": { - "base": "

The identifier or ARN of a VPC Lattice resource configuration.

", - "refs": { - "CreatePrivateConnectionOutput$resourceConfigurationId": "

The identifier or ARN of the VPC Lattice resource configuration.

", - "DeletePrivateConnectionOutput$resourceConfigurationId": "

The identifier or ARN of the VPC Lattice resource configuration.

", - "DescribePrivateConnectionOutput$resourceConfigurationId": "

The identifier or ARN of the VPC Lattice resource configuration.

", - "PrivateConnectionSummary$resourceConfigurationId": "

The identifier or ARN of the VPC Lattice resource configuration.

", - "SelfManagedInput$resourceConfigurationId": "

The identifier or ARN of the resource configuration.

", - "UpdatePrivateConnectionCertificateOutput$resourceConfigurationId": "

The identifier or ARN of the VPC Lattice resource configuration.

" - } - }, - "ResourceGatewayId": { - "base": "

The identifier or ARN of a VPC Lattice resource gateway.

", - "refs": { - "CreatePrivateConnectionOutput$resourceGatewayId": "

The identifier or ARN of the VPC Lattice resource gateway.

", - "DeletePrivateConnectionOutput$resourceGatewayId": "

The identifier or ARN of the VPC Lattice resource gateway.

", - "DescribePrivateConnectionOutput$resourceGatewayId": "

The identifier or ARN of the VPC Lattice resource gateway.

", - "PrivateConnectionSummary$resourceGatewayId": "

The identifier or ARN of the VPC Lattice resource gateway.

", - "UpdatePrivateConnectionCertificateOutput$resourceGatewayId": "

The identifier or ARN of the VPC Lattice resource gateway.

" - } - }, - "ResourceNotFoundException": { - "base": "

The specified resource was not found. Verify that the resource identifier is correct and that the resource exists in the specified agent space or account.

", - "refs": {} - }, - "ResourceType": { - "base": "

Type of resource.

", - "refs": { - "ListIntegratedResourcesInput$resourceType": "

The type of resource to filter by.

" - } - }, - "RiskLevel": { - "base": "

Risk severity level.

", - "refs": { - "Finding$riskLevel": "

The risk level of the finding. Valid values include UNKNOWN, INFORMATIONAL, LOW, MEDIUM, HIGH, and CRITICAL.

", - "FindingSummary$riskLevel": "

The risk level of the finding.

", - "ListFindingsInput$riskLevel": "

Filter findings by risk level.

", - "UpdateFindingInput$riskLevel": "

The updated risk level for the finding.

" - } - }, - "RiskType": { - "base": "

Type of security risk.

", - "refs": { - "CodeReviewJobTask$riskType": "

The type of security risk the task is testing for.

", - "CodeReviewJobTaskSummary$riskType": "

The type of security risk the task is testing for.

", - "RiskTypeList$member": null, - "Task$riskType": "

The type of security risk the task is testing for.

", - "TaskSummary$riskType": "

The type of security risk the task is testing for.

" - } - }, - "RiskTypeList": { - "base": null, - "refs": { - "CreatePentestInput$excludeRiskTypes": "

The list of risk types to exclude from the pentest.

", - "CreatePentestOutput$excludeRiskTypes": "

The list of risk types excluded from the pentest.

", - "Pentest$excludeRiskTypes": "

The list of risk types excluded from the pentest.

", - "PentestJob$excludeRiskTypes": "

The list of risk types excluded from the pentest job.

", - "UpdatePentestInput$excludeRiskTypes": "

The updated list of risk types to exclude from the pentest.

", - "UpdatePentestOutput$excludeRiskTypes": "

The list of risk types excluded from the pentest.

" - } - }, - "RoleArn": { - "base": "

ARN of the IAM role that the application uses to access AWS resources on your behalf.

", - "refs": { - "CreateApplicationRequest$roleArn": "

The Amazon Resource Name (ARN) of the IAM role to associate with the application.

", - "GetApplicationResponse$roleArn": "

The Amazon Resource Name (ARN) of the IAM role associated with the application.

", - "UpdateApplicationRequest$roleArn": "

The updated Amazon Resource Name (ARN) of the IAM role for the application.

" - } - }, - "S3BucketArn": { - "base": "

S3 bucket ARN or name for agent space AWS resources.

", - "refs": { - "S3BucketArns$member": null - } - }, - "S3BucketArns": { - "base": null, - "refs": { - "AWSResources$s3Buckets": "

The Amazon Resource Names (ARNs) of the S3 buckets associated with the agent space.

" - } - }, - "SecretArn": { - "base": "

Secret ARN or name for agent space AWS resources.

", - "refs": { - "SecretArns$member": null - } - }, - "SecretArns": { - "base": null, - "refs": { - "AWSResources$secretArns": "

The Amazon Resource Names (ARNs) of the Secrets Manager secrets associated with the agent space.

" - } - }, - "SecurityGroupArn": { - "base": "

ARN or ID of a security group.

", - "refs": { - "SecurityGroupArns$member": null - } - }, - "SecurityGroupArns": { - "base": "

A list of one or more security group ARNs or IDs in the customer VPC.

", - "refs": { - "VpcConfig$securityGroupArns": "

The Amazon Resource Names (ARNs) of the security groups for the VPC configuration.

" - } - }, - "SecurityRequirementArtifact": { - "base": "

A document used as source material for importing security requirements.

", - "refs": { - "SecurityRequirementArtifactList$member": null - } - }, - "SecurityRequirementArtifactFormat": { - "base": null, - "refs": { - "SecurityRequirementArtifact$format": "

The format of the document. Valid values are MD, PDF, TXT, DOCX, and DOC.

" - } - }, - "SecurityRequirementArtifactList": { - "base": "

List of documents used as source material for importing security requirements.

", - "refs": { - "ImportSource$documents": "

The list of documents to extract security requirements from.

" - } - }, - "SecurityRequirementArtifactName": { - "base": null, - "refs": { - "SecurityRequirementArtifact$name": "

The file name of the document.

" - } - }, - "SecurityRequirementDocumentContent": { - "base": null, - "refs": { - "SecurityRequirementArtifact$content": "

The binary content of the document.

" - } - }, - "SecurityRequirementName": { - "base": null, - "refs": { - "BatchCreateSecurityRequirementResult$name": "

The name of the security requirement.

", - "BatchGetSecurityRequirementResult$name": "

The name of the security requirement.

", - "BatchSecurityRequirementError$securityRequirementName": "

The name of the security requirement that caused the error.

", - "CreateSecurityRequirementEntry$name": "

The name of the security requirement.

", - "SecurityRequirementNameList$member": null, - "SecurityRequirementSummary$name": "

The name of the security requirement.

", - "UpdateSecurityRequirementEntry$name": "

The name of the security requirement to update. This is an immutable identifier and cannot be changed once the requirement is created.

" - } - }, - "SecurityRequirementNameList": { - "base": "

List of security requirement names.

", - "refs": { - "BatchDeleteSecurityRequirementsInput$securityRequirementNames": "

The list of security requirement names to delete.

", - "BatchDeleteSecurityRequirementsOutput$deletedSecurityRequirementNames": "

The list of security requirement names that were successfully deleted.

", - "BatchGetSecurityRequirementsInput$securityRequirementNames": "

The list of security requirement names to retrieve.

", - "BatchUpdateSecurityRequirementsOutput$updatedSecurityRequirementNames": "

The list of security requirement names that were successfully updated.

" - } - }, - "SecurityRequirementPackId": { - "base": null, - "refs": { - "BatchCreateSecurityRequirementResult$packId": "

The unique identifier of the pack containing the security requirement.

", - "BatchCreateSecurityRequirementsInput$packId": "

The unique identifier of the security requirement pack to add requirements to.

", - "BatchDeleteSecurityRequirementsInput$packId": "

The unique identifier of the security requirement pack to remove requirements from.

", - "BatchGetSecurityRequirementResult$packId": "

The unique identifier of the pack containing the security requirement.

", - "BatchGetSecurityRequirementsInput$packId": "

The unique identifier of the security requirement pack to retrieve requirements from.

", - "BatchUpdateSecurityRequirementsInput$packId": "

The unique identifier of the security requirement pack containing the requirements to update.

", - "CreateSecurityRequirementPackOutput$packId": "

The unique identifier of the created security requirement pack.

", - "DeleteSecurityRequirementPackInput$packId": "

The unique identifier of the security requirement pack to delete.

", - "GetSecurityRequirementPackInput$packId": "

The unique identifier of the security requirement pack to retrieve.

", - "GetSecurityRequirementPackOutput$packId": "

The unique identifier of the security requirement pack.

", - "ImportSecurityRequirementsInput$packId": "

The unique identifier of the security requirement pack to import requirements into.

", - "ImportSecurityRequirementsOutput$packId": "

The unique identifier of the security requirement pack.

", - "ListSecurityRequirementsInput$packId": "

The unique identifier of the security requirement pack to list requirements for.

", - "SecurityRequirementPackSummary$packId": "

The unique identifier of the security requirement pack.

", - "SecurityRequirementSummary$packId": "

The unique identifier of the pack containing the security requirement.

", - "UpdateSecurityRequirementPackInput$packId": "

The unique identifier of the security requirement pack to update.

", - "UpdateSecurityRequirementPackOutput$packId": "

The unique identifier of the security requirement pack.

" - } - }, - "SecurityRequirementPackImportStatus": { - "base": null, - "refs": { - "GetSecurityRequirementPackOutput$importStatus": "

The status of the security requirements import workflow for this pack.

", - "ImportSecurityRequirementsOutput$importStatus": "

The status of the import workflow.

" - } - }, - "SecurityRequirementPackName": { - "base": null, - "refs": { - "CreateSecurityRequirementPackInput$name": "

The name of the security requirement pack.

", - "GetSecurityRequirementPackOutput$name": "

The name of the security requirement pack.

", - "SecurityRequirementPackSummary$name": "

The name of the security requirement pack.

", - "UpdateSecurityRequirementPackInput$name": "

The updated name of the security requirement pack.

", - "UpdateSecurityRequirementPackOutput$name": "

The name of the security requirement pack.

" - } - }, - "SecurityRequirementPackStatus": { - "base": null, - "refs": { - "CreateSecurityRequirementPackInput$status": "

The status of the pack. Defaults to ENABLED if not provided.

", - "CreateSecurityRequirementPackOutput$status": "

The status of the created security requirement pack.

", - "GetSecurityRequirementPackOutput$status": "

The status of the security requirement pack.

", - "ListSecurityRequirementPackFilter$status": "

Filter packs by status. Valid values are ENABLED and DISABLED.

", - "SecurityRequirementPackSummary$status": "

The status of the security requirement pack.

", - "UpdateSecurityRequirementPackInput$status": "

The updated status of the security requirement pack.

", - "UpdateSecurityRequirementPackOutput$status": "

The status of the security requirement pack.

" - } - }, - "SecurityRequirementPackSummary": { - "base": "

Contains summary information about a security requirement pack.

", - "refs": { - "SecurityRequirementPackSummaryList$member": null - } - }, - "SecurityRequirementPackSummaryList": { - "base": "

List of security requirement pack summaries.

", - "refs": { - "ListSecurityRequirementPacksOutput$securityRequirementPackSummaries": "

The list of security requirement pack summaries.

" - } - }, - "SecurityRequirementSummary": { - "base": "

Contains summary information about a security requirement.

", - "refs": { - "SecurityRequirementSummaryList$member": null - } - }, - "SecurityRequirementSummaryList": { - "base": "

List of security requirement summaries.

", - "refs": { - "ListSecurityRequirementsOutput$securityRequirementSummaries": "

The list of security requirement summaries.

" - } - }, - "SelfManagedInput": { - "base": "

The configuration for a self-managed private connection.

", - "refs": { - "PrivateConnectionMode$selfManaged": "

The configuration for a self-managed private connection, where you manage your own resource configuration.

" - } - }, - "SensitiveEmail": { - "base": "

Sensitive email address.

", - "refs": { - "UserMetadata$email": "

The email address of the user.

" - } - }, - "ServiceManagedInput": { - "base": "

The configuration for a service-managed private connection.

", - "refs": { - "PrivateConnectionMode$serviceManaged": "

The configuration for a service-managed private connection, where the service manages the resource gateway lifecycle.

" - } - }, - "ServiceQuotaExceededException": { - "base": "

The request exceeds a service quota. Review your current usage and request a quota increase if needed.

", - "refs": {} - }, - "ServiceRole": { - "base": "

ARN of an IAM role that the service can assume to access customer resources.

", - "refs": { - "CodeReview$serviceRole": "

The IAM service role used for the code review.

", - "CodeReviewJob$serviceRole": "

The IAM service role used for the code review job.

", - "CreateCodeReviewInput$serviceRole": "

The IAM service role to use for the code review.

", - "CreateCodeReviewOutput$serviceRole": "

The IAM service role used for the code review.

", - "CreatePentestInput$serviceRole": "

The IAM service role to use for the pentest.

", - "CreatePentestOutput$serviceRole": "

The IAM service role used for the pentest.

", - "CreateThreatModelInput$serviceRole": "

The IAM service role to use for the threat model.

", - "CreateThreatModelOutput$serviceRole": "

The IAM service role used for the threat model.

", - "IamRoles$member": null, - "Pentest$serviceRole": "

The IAM service role used for the pentest.

", - "PentestJob$serviceRole": "

The IAM service role used for the pentest job.

", - "ThreatModel$serviceRole": "

The IAM service role used for the threat model.

", - "UpdateCodeReviewInput$serviceRole": "

The updated IAM service role for the code review.

", - "UpdateCodeReviewOutput$serviceRole": "

The IAM service role used for the code review.

", - "UpdatePentestInput$serviceRole": "

The updated IAM service role for the pentest.

", - "UpdatePentestOutput$serviceRole": "

The IAM service role used for the pentest.

", - "UpdateThreatModelInput$serviceRole": "

The updated IAM service role for the threat model.

", - "UpdateThreatModelOutput$serviceRole": "

The IAM service role used for the threat model.

" - } - }, - "SkillType": { - "base": "

Type of managed skill that can be enabled or disabled for a pentest.

", - "refs": { - "SkillTypeList$member": null - } - }, - "SkillTypeList": { - "base": "

A list of skill types.

", - "refs": { - "CreatePentestInput$disableManagedSkills": "

A list of managed skills to disable for this pentest. Valid values include FINDING_PERSONALIZATION and LOGIN_OPTIMIZATION.

", - "Pentest$disableManagedSkills": "

A list of managed skills to disable for this pentest. Valid values include FINDING_PERSONALIZATION and LOGIN_OPTIMIZATION.

", - "PentestJob$disableManagedSkills": "

A list of managed skills disabled for this pentest job. Valid values include FINDING_PERSONALIZATION and LOGIN_OPTIMIZATION.

", - "UpdatePentestInput$disableManagedSkills": "

The updated list of managed skills to disable for this pentest. Valid values include FINDING_PERSONALIZATION and LOGIN_OPTIMIZATION.

" - } - }, - "SourceCodeRepository": { - "base": "

Represents a source code repository used for security analysis during a pentest.

", - "refs": { - "SourceCodeRepositoryList$member": null - } - }, - "SourceCodeRepositoryList": { - "base": null, - "refs": { - "Assets$sourceCode": "

The list of source code repositories to analyze during the pentest.

", - "CodeReviewJob$sourceCode": "

The list of source code repositories analyzed during the code review job.

", - "PentestJob$sourceCode": "

The list of source code repositories analyzed during the pentest job.

", - "ThreatModelJob$sourceCode": "

The list of source code repositories used for threat modeling.

" - } - }, - "StartCodeRemediationInput": { - "base": "

Input for the StartCodeRemediation operation.

", - "refs": {} - }, - "StartCodeRemediationOutput": { - "base": "

Output for the StartCodeRemediation operation.

", - "refs": {} - }, - "StartCodeReviewJobInput": { - "base": "

Input for starting the execution of a code review.

", - "refs": {} - }, - "StartCodeReviewJobOutput": { - "base": "

Output for the StartCodeReviewJob operation.

", - "refs": {} - }, - "StartPentestJobInput": { - "base": "

Input for starting the execution of a pentest.

", - "refs": {} - }, - "StartPentestJobOutput": { - "base": "

Output for the StartPentestJob operation.

", - "refs": {} - }, - "StartThreatModelJobInput": { - "base": "

Input for starting a threat model job.

", - "refs": {} - }, - "StartThreatModelJobOutput": { - "base": "

Output for the StartThreatModelJob operation.

", - "refs": {} - }, - "Step": { - "base": "

Represents a step in the pentest job execution pipeline. Steps include preflight, static analysis, pentest, and finalizing.

", - "refs": { - "StepList$member": null - } - }, - "StepList": { - "base": "

List of pentest job steps.

", - "refs": { - "CodeReviewJob$steps": "

The list of steps in the code review job execution.

", - "PentestJob$steps": "

The list of steps in the pentest job execution.

" - } - }, - "StepName": { - "base": "

Pentest job step names.

", - "refs": { - "ListCodeReviewJobTasksInput$stepName": "

Filter tasks by step name.

", - "ListPentestJobTasksInput$stepName": "

Filter tasks by step name. Valid values include PREFLIGHT, STATIC_ANALYSIS, PENTEST, VALIDATION, and FINALIZING.

", - "Step$name": "

The name of the step. Valid values include PREFLIGHT, STATIC_ANALYSIS, PENTEST, VALIDATION, and FINALIZING.

" - } - }, - "StepStatus": { - "base": "

Pentest job step status.

", - "refs": { - "Step$status": "

The current status of the step.

" - } - }, - "StopCodeReviewJobInput": { - "base": "

Input for stopping the execution of a code review job.

", - "refs": {} - }, - "StopCodeReviewJobOutput": { - "base": "

Output for the StopCodeReviewJob operation.

", - "refs": {} - }, - "StopPentestJobInput": { - "base": "

Input for stopping the execution of a pentest.

", - "refs": {} - }, - "StopPentestJobOutput": { - "base": "

Output for the StopPentestJob operation.

", - "refs": {} - }, - "StopThreatModelJobInput": { - "base": "

Input for stopping a threat model job.

", - "refs": {} - }, - "StopThreatModelJobOutput": { - "base": "

Output for the StopThreatModelJob operation.

", - "refs": {} - }, - "StrideCategory": { - "base": "

STRIDE threat classification category.

", - "refs": { - "StrideCategoryList$member": null - } - }, - "StrideCategoryList": { - "base": "

List of STRIDE categories.

", - "refs": { - "CreateThreatInput$stride": "

The STRIDE categories applicable to this threat.

", - "CreateThreatOutput$stride": "

The STRIDE categories applicable to this threat.

", - "Threat$stride": "

The STRIDE categories applicable to this threat.

", - "ThreatSummary$stride": "

The STRIDE categories applicable to this threat.

", - "UpdateThreatOutput$stride": "

The STRIDE categories applicable to this threat.

" - } - }, - "String": { - "base": null, - "refs": { - "AccessDeniedException$message": "

Error description.

", - "Actor$identifier": "

The unique identifier for the actor.

", - "Actor$description": "

A description of the actor.

", - "AddArtifactInput$fileName": "

The file name of the artifact.

", - "AgentSpace$name": "

The name of the agent space.

", - "AgentSpace$description": "

A description of the agent space.

", - "AgentSpaceSummary$name": "

The name of the agent space.

", - "ApplicationSummary$applicationName": "

The name of the application.

", - "Artifact$contents": "

The content of the artifact.

", - "ArtifactMetadataItem$fileName": "

The file name of the artifact.

", - "ArtifactSummary$fileName": "

The file name of the artifact.

", - "Authentication$value": "

The authentication value, such as a secret ARN, Lambda function ARN, or IAM role ARN, depending on the provider type.

", - "BatchCreateSecurityRequirementResult$description": "

A description of the security requirement.

", - "BatchCreateSecurityRequirementResult$domain": "

The security domain the requirement belongs to.

", - "BatchCreateSecurityRequirementResult$evaluation": "

The evaluation criteria used to assess compliance with this requirement.

", - "BatchCreateSecurityRequirementResult$remediation": "

The recommended remediation steps when the requirement is not met.

", - "BatchDeleteCodeReviewsInput$agentSpaceId": "

The unique identifier of the agent space that contains the code reviews to delete.

", - "BatchDeletePentestsInput$agentSpaceId": "

The unique identifier of the agent space that contains the pentests to delete.

", - "BatchDeleteThreatModelsInput$agentSpaceId": "

The unique identifier of the agent space that contains the threat models to delete.

", - "BatchGetCodeReviewJobTasksInput$agentSpaceId": "

The unique identifier of the agent space that contains the tasks.

", - "BatchGetCodeReviewJobsInput$agentSpaceId": "

The unique identifier of the agent space that contains the code review jobs.

", - "BatchGetCodeReviewsInput$agentSpaceId": "

The unique identifier of the agent space that contains the code reviews.

", - "BatchGetFindingsInput$agentSpaceId": "

The unique identifier of the agent space that contains the findings.

", - "BatchGetPentestJobTasksInput$agentSpaceId": "

The unique identifier of the agent space that contains the tasks.

", - "BatchGetPentestJobsInput$agentSpaceId": "

The unique identifier of the agent space that contains the pentest jobs.

", - "BatchGetPentestsInput$agentSpaceId": "

The unique identifier of the agent space that contains the pentests.

", - "BatchGetSecurityRequirementResult$description": "

A description of the security requirement.

", - "BatchGetSecurityRequirementResult$domain": "

The security domain the requirement belongs to.

", - "BatchGetSecurityRequirementResult$evaluation": "

The evaluation criteria used to assess compliance with this requirement.

", - "BatchGetSecurityRequirementResult$remediation": "

The recommended remediation steps when the requirement is not met.

", - "BatchGetThreatModelJobTasksInput$agentSpaceId": "

The unique identifier of the agent space that contains the tasks.

", - "BatchGetThreatModelJobsInput$agentSpaceId": "

The unique identifier of the agent space that contains the threat model jobs.

", - "BatchGetThreatModelsInput$agentSpaceId": "

The unique identifier of the agent space that contains the threat models.

", - "BatchGetThreatsInput$agentSpaceId": "

The unique identifier of the agent space.

", - "BatchSecurityRequirementError$code": "

The error code.

", - "BatchSecurityRequirementError$message": "

The error message.

", - "Category$name": "

The name of the category.

", - "CloudWatchLog$logGroup": "

The name of the CloudWatch log group.

", - "CloudWatchLog$logStream": "

The name of the CloudWatch log stream.

", - "CodeLocation$filePath": "

The absolute path to the file containing the code location.

", - "CodeLocation$label": "

The role of this location in the vulnerability, such as source or sink.

", - "CodeRemediationTask$statusReason": "

The reason for the current status of the code remediation task.

", - "CodeRemediationTaskDetails$repoName": "

The name of the repository where the remediation was applied.

", - "CodeRemediationTaskDetails$codeDiffLink": "

The link to the code diff for the remediation.

", - "CodeRemediationTaskDetails$pullRequestLink": "

The link to the pull request created for the remediation.

", - "CodeReview$codeReviewId": "

The unique identifier of the code review.

", - "CodeReview$agentSpaceId": "

The unique identifier of the agent space that contains the code review.

", - "CodeReview$title": "

The title of the code review.

", - "CodeReviewIdList$member": null, - "CodeReviewJob$codeReviewJobId": "

The unique identifier of the code review job.

", - "CodeReviewJob$codeReviewId": "

The unique identifier of the code review associated with the job.

", - "CodeReviewJob$title": "

The title of the code review job.

", - "CodeReviewJob$overview": "

An overview of the code review job results.

", - "CodeReviewJobIdList$member": null, - "CodeReviewJobSummary$codeReviewJobId": "

The unique identifier of the code review job.

", - "CodeReviewJobSummary$codeReviewId": "

The unique identifier of the code review associated with the job.

", - "CodeReviewJobSummary$title": "

The title of the code review job.

", - "CodeReviewJobTask$taskId": "

The unique identifier of the task.

", - "CodeReviewJobTask$codeReviewId": "

The unique identifier of the code review associated with the task.

", - "CodeReviewJobTask$codeReviewJobId": "

The unique identifier of the code review job that contains the task.

", - "CodeReviewJobTask$agentSpaceId": "

The unique identifier of the agent space.

", - "CodeReviewJobTask$title": "

The title of the task.

", - "CodeReviewJobTask$description": "

A description of the task.

", - "CodeReviewJobTaskSummary$taskId": "

The unique identifier of the task.

", - "CodeReviewJobTaskSummary$codeReviewId": "

The unique identifier of the code review associated with the task.

", - "CodeReviewJobTaskSummary$codeReviewJobId": "

The unique identifier of the code review job that contains the task.

", - "CodeReviewJobTaskSummary$agentSpaceId": "

The unique identifier of the agent space.

", - "CodeReviewJobTaskSummary$title": "

The title of the task.

", - "CodeReviewSummary$codeReviewId": "

The unique identifier of the code review.

", - "CodeReviewSummary$agentSpaceId": "

The unique identifier of the agent space that contains the code review.

", - "CodeReviewSummary$title": "

The title of the code review.

", - "ConflictException$message": "

Error description.

", - "ConfluenceDocumentMetadata$spaceKey": "

The Confluence space key containing the document.

", - "ConfluenceDocumentMetadata$pageId": "

The Confluence page identifier.

", - "ConfluenceDocumentMetadata$title": "

The display title of the Confluence page.

", - "ConfluenceDocumentMetadata$spaceTitle": "

The display title of the Confluence space.

", - "ConfluenceDocumentResource$spaceKey": "

The Confluence space key containing the document.

", - "ConfluenceDocumentResource$pageId": "

The Confluence page identifier.

", - "ConfluenceDocumentResource$title": "

The display title of the Confluence page.

", - "ConfluenceDocumentResource$spaceTitle": "

The display title of the Confluence space.

", - "CreateAgentSpaceInput$description": "

A description of the agent space.

", - "CreateAgentSpaceOutput$description": "

The description of the agent space.

", - "CreateCodeReviewInput$title": "

The title of the code review.

", - "CreateCodeReviewInput$agentSpaceId": "

The unique identifier of the agent space to create the code review in.

", - "CreateCodeReviewOutput$codeReviewId": "

The unique identifier of the created code review.

", - "CreateCodeReviewOutput$title": "

The title of the code review.

", - "CreateCodeReviewOutput$agentSpaceId": "

The unique identifier of the agent space that contains the code review.

", - "CreateIntegrationInput$integrationDisplayName": "

The display name for the integration.

", - "CreatePentestInput$title": "

The title of the pentest.

", - "CreatePentestInput$agentSpaceId": "

The unique identifier of the agent space to create the pentest in.

", - "CreatePentestOutput$pentestId": "

The unique identifier of the created pentest.

", - "CreatePentestOutput$title": "

The title of the pentest.

", - "CreatePentestOutput$agentSpaceId": "

The unique identifier of the agent space that contains the pentest.

", - "CreatePrivateConnectionOutput$failureMessage": "

A message describing why the private connection entered a failed state, if applicable.

", - "CreateSecurityRequirementEntry$description": "

A description of the security requirement.

", - "CreateSecurityRequirementEntry$domain": "

The security domain the requirement belongs to.

", - "CreateSecurityRequirementEntry$evaluation": "

The evaluation criteria used to assess compliance with this requirement.

", - "CreateSecurityRequirementEntry$remediation": "

The recommended remediation steps when the requirement is not met.

", - "CreateSecurityRequirementPackInput$description": "

A description of the security requirement pack.

", - "CreateTargetDomainInput$targetDomainName": "

The domain name to register as a target domain.

", - "CreateTargetDomainOutput$domainName": "

The domain name of the target domain.

", - "CreateTargetDomainOutput$verificationStatusReason": "

The reason for the current target domain verification status.

", - "CreateThreatInput$agentSpaceId": "

The unique identifier of the agent space.

", - "CreateThreatInput$threatJobId": "

The unique identifier of the threat model job the threat belongs to.

", - "CreateThreatInput$title": "

A short title summarizing the threat.

", - "CreateThreatInput$statement": "

The natural-language threat statement.

", - "CreateThreatInput$comments": "

Optional customer comment on the threat.

", - "CreateThreatInput$threatSource": "

The actor or origin of the threat.

", - "CreateThreatInput$prerequisites": "

The conditions required for the threat to be exploitable.

", - "CreateThreatInput$threatAction": "

What the threat source can do.

", - "CreateThreatInput$threatImpact": "

The direct consequence of the threat action.

", - "CreateThreatInput$recommendation": "

The recommended mitigation guidance for this threat.

", - "CreateThreatModelInput$title": "

The title of the threat model.

", - "CreateThreatModelInput$agentSpaceId": "

The unique identifier of the agent space to create the threat model in.

", - "CreateThreatModelInput$description": "

A description of the application or system being threat modeled.

", - "CreateThreatModelOutput$threatModelId": "

The unique identifier of the created threat model.

", - "CreateThreatModelOutput$title": "

The title of the threat model.

", - "CreateThreatModelOutput$agentSpaceId": "

The unique identifier of the agent space that contains the threat model.

", - "CreateThreatModelOutput$description": "

A description of the application or system being threat modeled.

", - "CreateThreatOutput$threatId": "

The unique identifier of the created threat.

", - "CreateThreatOutput$threatJobId": "

The unique identifier of the threat model job the threat belongs to.

", - "CreateThreatOutput$title": "

A short title summarizing the threat.

", - "CreateThreatOutput$statement": "

The natural-language threat statement.

", - "CreateThreatOutput$comments": "

Optional customer comment on the threat.

", - "CreateThreatOutput$threatSource": "

The actor or origin of the threat.

", - "CreateThreatOutput$prerequisites": "

The conditions required for the threat to be exploitable.

", - "CreateThreatOutput$threatAction": "

What the threat source can do.

", - "CreateThreatOutput$threatImpact": "

The direct consequence of the threat action.

", - "CreateThreatOutput$recommendation": "

The recommended mitigation guidance for this threat.

", - "CustomHeader$name": "

The name of the custom header.

", - "CustomHeader$value": "

The value of the custom header.

", - "DeleteCodeReviewFailure$codeReviewId": "

The unique identifier of the code review that failed to delete.

", - "DeleteCodeReviewFailure$reason": "

The reason the code review failed to delete.

", - "DeletePentestFailure$pentestId": "

The unique identifier of the pentest that failed to delete.

", - "DeletePentestFailure$reason": "

The reason the pentest failed to delete.

", - "DeletePrivateConnectionOutput$failureMessage": "

A message describing why the private connection entered a failed state, if applicable.

", - "DeleteThreatModelFailure$threatModelId": "

The unique identifier of the threat model that failed to delete.

", - "DeleteThreatModelFailure$reason": "

The reason the threat model failed to delete.

", - "DescribePrivateConnectionOutput$failureMessage": "

A message describing why the private connection entered a failed state, if applicable.

", - "DiffSource$s3Uri": "

S3 URI pointing to a unified diff file. The file must be in standard unified diff format and stored in an S3 bucket connected to your Agent Space.

", - "DiscoveredEndpoint$uri": "

The URI of the discovered endpoint.

", - "DiscoveredEndpoint$pentestJobId": "

The unique identifier of the pentest job that discovered the endpoint.

", - "DiscoveredEndpoint$taskId": "

The unique identifier of the task that discovered the endpoint.

", - "DiscoveredEndpoint$agentSpaceId": "

The unique identifier of the agent space associated with the discovered endpoint.

", - "DiscoveredEndpoint$evidence": "

The evidence that led to the discovery of the endpoint.

", - "DiscoveredEndpoint$operation": "

The HTTP operation associated with the discovered endpoint.

", - "DiscoveredEndpoint$description": "

A description of the discovered endpoint.

", - "DnsVerification$token": "

The verification token to include in the DNS record value.

", - "DnsVerification$dnsRecordName": "

The name of the DNS record to create for verification.

", - "DocumentInfo$s3Location": "

The Amazon S3 location of the document.

", - "DocumentInfo$artifactId": "

The unique identifier of the artifact associated with the document.

", - "Endpoint$uri": "

The URI of the endpoint.

", - "ErrorInformation$message": "

A message describing the error.

", - "ExecutionContext$context": "

The context message.

", - "Finding$findingId": "

The unique identifier of the finding.

", - "Finding$agentSpaceId": "

The unique identifier of the agent space associated with the finding.

", - "Finding$pentestId": "

The unique identifier of the pentest associated with the finding.

", - "Finding$pentestJobId": "

The unique identifier of the pentest job that produced the finding.

", - "Finding$codeReviewId": "

The unique identifier of the code review associated with the finding.

", - "Finding$codeReviewJobId": "

The unique identifier of the code review job that produced the finding.

", - "Finding$taskId": "

The unique identifier of the task that produced the finding.

", - "Finding$name": "

The name of the finding.

", - "Finding$description": "

A description of the finding.

", - "Finding$riskType": "

The type of security risk identified by the finding.

", - "Finding$riskScore": "

The numerical risk score of the finding.

", - "Finding$reasoning": "

The reasoning behind the finding, explaining why it was identified as a vulnerability.

", - "Finding$attackScript": "

The attack script used to reproduce the finding.

", - "Finding$lastUpdatedBy": "

The identifier of the entity that last updated the finding.

", - "Finding$customerNote": "

A customer-provided note on the finding.

", - "Finding$alignmentRationale": "

The rationale provided by the alignment agent explaining how the finding was adjusted based on customer preferences.

", - "FindingIdList$member": null, - "FindingSummary$findingId": "

The unique identifier of the finding.

", - "FindingSummary$agentSpaceId": "

The unique identifier of the agent space associated with the finding.

", - "FindingSummary$pentestId": "

The unique identifier of the pentest associated with the finding.

", - "FindingSummary$pentestJobId": "

The unique identifier of the pentest job that produced the finding.

", - "FindingSummary$codeReviewId": "

The unique identifier of the code review associated with the finding.

", - "FindingSummary$codeReviewJobId": "

The unique identifier of the code review job that produced the finding.

", - "FindingSummary$name": "

The name of the finding.

", - "FindingSummary$riskType": "

The type of security risk identified by the finding.

", - "GetApplicationResponse$applicationName": "

The name of the application.

", - "GetArtifactOutput$fileName": "

The file name of the artifact.

", - "GetIntegrationOutput$installationId": "

The installation identifier from the integration provider.

", - "GetIntegrationOutput$displayName": "

The display name of the integration.

", - "GetSecurityRequirementPackOutput$description": "

A description of the security requirement pack.

", - "GetSecurityRequirementPackOutput$vendorName": "

The vendor name for AWS managed packs, such as ISO or NIST.

", - "GitHubIntegrationInput$organizationName": "

The name of the GitHub organization to integrate with.

", - "GitHubIntegrationInput$installationId": "

The installation identifier provided by GitHub Enterprise Server on the install callback. Required for GitHub Enterprise Server integrations and ignored for GitHub.com.

", - "GitLabIntegrationInput$groupId": "

The identifier of the GitLab group. Required when tokenType is group and ignored for personal tokens.

", - "HttpVerification$token": "

The verification token to serve at the specified route path.

", - "HttpVerification$routePath": "

The HTTP route path where the verification token must be served.

", - "IntegratedDocument$integrationId": "

The identifier of the integration that provides access to the document.

", - "IntegratedDocument$resourceId": "

The provider-specific resource identifier for the document.

", - "IntegratedRepository$integrationId": "

The unique identifier of the integration that provides access to the repository.

", - "IntegratedRepository$providerResourceId": "

The provider-specific resource identifier for the repository.

", - "IntegratedRepository$branch": "

An optional override for the repository branch.

", - "IntegrationSummary$integrationId": "

The unique identifier of the integration.

", - "IntegrationSummary$installationId": "

The installation identifier from the integration provider.

", - "IntegrationSummary$displayName": "

The display name of the integration.

", - "InternalServerException$message": "

Error description.

", - "ListCodeReviewJobTasksInput$agentSpaceId": "

The unique identifier of the agent space.

", - "ListCodeReviewJobTasksInput$codeReviewJobId": "

The unique identifier of the code review job to list tasks for.

", - "ListCodeReviewJobTasksInput$categoryName": "

Filter tasks by category name.

", - "ListCodeReviewJobsForCodeReviewInput$codeReviewId": "

The unique identifier of the code review to list jobs for.

", - "ListCodeReviewJobsForCodeReviewInput$agentSpaceId": "

The unique identifier of the agent space.

", - "ListCodeReviewsInput$agentSpaceId": "

The unique identifier of the agent space to list code reviews for.

", - "ListDiscoveredEndpointsInput$pentestJobId": "

The unique identifier of the pentest job to list discovered endpoints for.

", - "ListDiscoveredEndpointsInput$agentSpaceId": "

The unique identifier of the agent space.

", - "ListDiscoveredEndpointsInput$prefix": "

A prefix to filter discovered endpoints by URI.

", - "ListFindingsInput$pentestJobId": "

The unique identifier of the pentest job to list findings for.

", - "ListFindingsInput$codeReviewJobId": "

The unique identifier of the code review job to list findings for. Mutually exclusive with pentestJobId.

", - "ListFindingsInput$agentSpaceId": "

The unique identifier of the agent space.

", - "ListFindingsInput$riskType": "

Filter findings by risk type.

", - "ListFindingsInput$name": "

Filter findings by name.

", - "ListPentestJobTasksInput$agentSpaceId": "

The unique identifier of the agent space.

", - "ListPentestJobTasksInput$pentestJobId": "

The unique identifier of the pentest job to list tasks for.

", - "ListPentestJobTasksInput$categoryName": "

Filter tasks by category name.

", - "ListPentestJobsForPentestInput$pentestId": "

The unique identifier of the pentest to list jobs for.

", - "ListPentestJobsForPentestInput$agentSpaceId": "

The unique identifier of the agent space.

", - "ListPentestsInput$agentSpaceId": "

The unique identifier of the agent space to list pentests for.

", - "ListThreatModelJobTasksInput$agentSpaceId": "

The unique identifier of the agent space.

", - "ListThreatModelJobTasksInput$threatModelJobId": "

The unique identifier of the threat model job to list tasks for.

", - "ListThreatModelJobsInput$threatModelId": "

The unique identifier of the threat model to list jobs for.

", - "ListThreatModelJobsInput$agentSpaceId": "

The unique identifier of the agent space.

", - "ListThreatModelsInput$agentSpaceId": "

The unique identifier of the agent space to list threat models for.

", - "ListThreatsInput$threatJobId": "

The unique identifier of the threat model job to list threats for.

", - "ListThreatsInput$agentSpaceId": "

The unique identifier of the agent space.

", - "MembershipSummary$createdBy": "

The identifier of the entity that created the membership.

", - "MembershipSummary$updatedBy": "

The identifier of the entity that last updated the membership.

", - "NetworkTrafficRule$pattern": "

The URL pattern to match for the rule.

", - "Pentest$pentestId": "

The unique identifier of the pentest.

", - "Pentest$agentSpaceId": "

The unique identifier of the agent space that contains the pentest.

", - "Pentest$title": "

The title of the pentest.

", - "PentestIdList$member": null, - "PentestJob$pentestJobId": "

The unique identifier of the pentest job.

", - "PentestJob$pentestId": "

The unique identifier of the pentest associated with the job.

", - "PentestJob$title": "

The title of the pentest job.

", - "PentestJob$overview": "

An overview of the pentest job results.

", - "PentestJobIdList$member": null, - "PentestJobSummary$pentestJobId": "

The unique identifier of the pentest job.

", - "PentestJobSummary$pentestId": "

The unique identifier of the pentest associated with the job.

", - "PentestJobSummary$title": "

The title of the pentest job.

", - "PentestSummary$pentestId": "

The unique identifier of the pentest.

", - "PentestSummary$agentSpaceId": "

The unique identifier of the agent space that contains the pentest.

", - "PentestSummary$title": "

The title of the pentest.

", - "PrivateConnectionSummary$failureMessage": "

A message describing why the private connection entered a failed state, if applicable.

", - "ReportDestination$integrationId": "

The integration identifier for the document provider.

", - "ReportDestination$containerId": "

The container identifier where the report will be published.

", - "ReportDestination$parentId": "

The parent document identifier under which the report will be created.

", - "ReportDestination$documentId": "

The existing document identifier to update instead of creating a new document.

", - "ResourceNotFoundException$message": "

Error description.

", - "SecurityRequirementPackSummary$description": "

A description of the security requirement pack.

", - "SecurityRequirementPackSummary$vendorName": "

The vendor name for AWS managed packs.

", - "SecurityRequirementSummary$description": "

A description of the security requirement.

", - "ServiceQuotaExceededException$message": null, - "SourceCodeRepository$s3Location": "

The Amazon S3 location of the source code repository archive.

", - "StartCodeRemediationInput$agentSpaceId": "

The unique identifier of the agent space.

", - "StartCodeRemediationInput$pentestJobId": "

The unique identifier of the pentest job that produced the findings. Mutually exclusive with codeReviewJobId.

", - "StartCodeRemediationInput$codeReviewJobId": "

The unique identifier of the code review job that produced the findings. Mutually exclusive with pentestJobId.

", - "StartCodeReviewJobInput$agentSpaceId": "

The unique identifier of the agent space.

", - "StartCodeReviewJobInput$codeReviewId": "

The unique identifier of the code review to start a job for.

", - "StartCodeReviewJobOutput$title": "

The title of the code review job.

", - "StartCodeReviewJobOutput$codeReviewId": "

The unique identifier of the code review.

", - "StartCodeReviewJobOutput$codeReviewJobId": "

The unique identifier of the started code review job.

", - "StartCodeReviewJobOutput$agentSpaceId": "

The unique identifier of the agent space.

", - "StartPentestJobInput$agentSpaceId": "

The unique identifier of the agent space.

", - "StartPentestJobInput$pentestId": "

The unique identifier of the pentest to start a job for.

", - "StartPentestJobOutput$title": "

The title of the pentest job.

", - "StartPentestJobOutput$pentestId": "

The unique identifier of the pentest.

", - "StartPentestJobOutput$pentestJobId": "

The unique identifier of the started pentest job.

", - "StartPentestJobOutput$agentSpaceId": "

The unique identifier of the agent space.

", - "StartThreatModelJobInput$agentSpaceId": "

The unique identifier of the agent space.

", - "StartThreatModelJobInput$threatModelId": "

The unique identifier of the threat model to start a job for.

", - "StartThreatModelJobOutput$title": "

The title of the threat model job.

", - "StartThreatModelJobOutput$threatModelId": "

The unique identifier of the threat model.

", - "StartThreatModelJobOutput$threatModelJobId": "

The unique identifier of the started threat model job.

", - "StartThreatModelJobOutput$agentSpaceId": "

The unique identifier of the agent space.

", - "StopCodeReviewJobInput$agentSpaceId": "

The unique identifier of the agent space.

", - "StopCodeReviewJobInput$codeReviewJobId": "

The unique identifier of the code review job to stop.

", - "StopPentestJobInput$agentSpaceId": "

The unique identifier of the agent space.

", - "StopPentestJobInput$pentestJobId": "

The unique identifier of the pentest job to stop.

", - "StopThreatModelJobInput$agentSpaceId": "

The unique identifier of the agent space.

", - "StopThreatModelJobInput$threatModelJobId": "

The unique identifier of the threat model job to stop.

", - "StringList$member": null, - "TargetDomain$domainName": "

The domain name of the target domain.

", - "TargetDomain$verificationStatusReason": "

The reason for the current target domain verification status.

", - "TargetDomainIdList$member": null, - "TargetDomainSummary$domainName": "

The domain name of the target domain.

", - "Task$taskId": "

The unique identifier of the task.

", - "Task$pentestId": "

The unique identifier of the pentest associated with the task.

", - "Task$pentestJobId": "

The unique identifier of the pentest job that contains the task.

", - "Task$agentSpaceId": "

The unique identifier of the agent space.

", - "Task$title": "

The title of the task.

", - "Task$description": "

A description of the task.

", - "TaskIdList$member": null, - "TaskSummary$taskId": "

The unique identifier of the task.

", - "TaskSummary$pentestId": "

The unique identifier of the pentest associated with the task.

", - "TaskSummary$pentestJobId": "

The unique identifier of the pentest job that contains the task.

", - "TaskSummary$agentSpaceId": "

The unique identifier of the agent space.

", - "TaskSummary$title": "

The title of the task.

", - "Threat$threatId": "

The unique identifier of the threat.

", - "Threat$threatJobId": "

The unique identifier of the threat model job that produced the threat.

", - "Threat$title": "

A short title summarizing the threat.

", - "Threat$statement": "

The natural-language threat statement.

", - "Threat$comments": "

Optional customer comment on the threat.

", - "Threat$threatSource": "

The actor or origin of the threat.

", - "Threat$prerequisites": "

The conditions required for the threat to be exploitable.

", - "Threat$threatAction": "

What the threat source can do.

", - "Threat$threatImpact": "

The direct consequence of the threat action.

", - "Threat$recommendation": "

The recommended mitigation guidance for this threat.

", - "ThreatAnchorShape$kind": "

The kind of DFD element.

", - "ThreatAnchorShape$id": "

The identifier of the DFD element.

", - "ThreatAnchorShape$packageId": "

The package identifier containing the DFD element.

", - "ThreatEvidenceShape$packageId": "

The package identifier containing the evidence file.

", - "ThreatEvidenceShape$path": "

The file path of the evidence.

", - "ThreatIdList$member": null, - "ThreatModel$threatModelId": "

The unique identifier of the threat model.

", - "ThreatModel$agentSpaceId": "

The unique identifier of the agent space that contains the threat model.

", - "ThreatModel$title": "

The title of the threat model.

", - "ThreatModel$description": "

A description of the application or system being threat modeled.

", - "ThreatModelIdList$member": null, - "ThreatModelJob$threatModelJobId": "

The unique identifier of the threat model job.

", - "ThreatModelJob$threatModelId": "

The unique identifier of the threat model associated with the job.

", - "ThreatModelJob$agentSpaceId": "

The unique identifier of the agent space.

", - "ThreatModelJob$title": "

The title of the threat model job.

", - "ThreatModelJob$systemOverview": "

The system overview generated during threat modeling.

", - "ThreatModelJobIdList$member": null, - "ThreatModelJobSummary$threatModelJobId": "

The unique identifier of the threat model job.

", - "ThreatModelJobSummary$threatModelId": "

The unique identifier of the threat model associated with the job.

", - "ThreatModelJobSummary$agentSpaceId": "

The unique identifier of the agent space.

", - "ThreatModelJobSummary$title": "

The title of the threat model job.

", - "ThreatModelJobTask$taskId": "

The unique identifier of the task.

", - "ThreatModelJobTask$threatModelId": "

The unique identifier of the threat model associated with the task.

", - "ThreatModelJobTask$threatModelJobId": "

The unique identifier of the threat model job that contains the task.

", - "ThreatModelJobTask$agentSpaceId": "

The unique identifier of the agent space.

", - "ThreatModelJobTask$title": "

The title of the task.

", - "ThreatModelJobTask$description": "

A description of the task.

", - "ThreatModelJobTaskSummary$taskId": "

The unique identifier of the task.

", - "ThreatModelJobTaskSummary$threatModelId": "

The unique identifier of the threat model associated with the task.

", - "ThreatModelJobTaskSummary$threatModelJobId": "

The unique identifier of the threat model job that contains the task.

", - "ThreatModelJobTaskSummary$agentSpaceId": "

The unique identifier of the agent space.

", - "ThreatModelJobTaskSummary$title": "

The title of the task.

", - "ThreatModelSummary$threatModelId": "

The unique identifier of the threat model.

", - "ThreatModelSummary$agentSpaceId": "

The unique identifier of the agent space that contains the threat model.

", - "ThreatModelSummary$title": "

The title of the threat model.

", - "ThreatSummary$threatId": "

The unique identifier of the threat.

", - "ThreatSummary$threatJobId": "

The unique identifier of the threat model job that produced the threat.

", - "ThreatSummary$title": "

A short title summarizing the threat.

", - "ThreatSummary$statement": "

The natural-language threat statement.

", - "ThrottlingException$message": "

Error description.

", - "ThrottlingException$serviceCode": "

Service code for throttling limit.

", - "ThrottlingException$quotaCode": "

Quota code for throttling limit.

", - "UpdateAgentSpaceInput$description": "

The updated description of the agent space.

", - "UpdateAgentSpaceOutput$description": "

The description of the agent space.

", - "UpdateCodeReviewInput$codeReviewId": "

The unique identifier of the code review to update.

", - "UpdateCodeReviewInput$agentSpaceId": "

The unique identifier of the agent space that contains the code review.

", - "UpdateCodeReviewInput$title": "

The updated title of the code review.

", - "UpdateCodeReviewOutput$codeReviewId": "

The unique identifier of the code review.

", - "UpdateCodeReviewOutput$title": "

The title of the code review.

", - "UpdateCodeReviewOutput$agentSpaceId": "

The unique identifier of the agent space that contains the code review.

", - "UpdateFindingInput$findingId": "

The unique identifier of the finding to update.

", - "UpdateFindingInput$agentSpaceId": "

The unique identifier of the agent space that contains the finding.

", - "UpdateFindingInput$name": "

The updated name for the finding.

", - "UpdateFindingInput$description": "

The updated description for the finding.

", - "UpdateFindingInput$riskType": "

The updated risk type for the finding.

", - "UpdateFindingInput$riskScore": "

The updated numerical risk score for the finding.

", - "UpdateFindingInput$attackScript": "

The updated attack script for the finding.

", - "UpdateFindingInput$reasoning": "

The updated reasoning for the finding.

", - "UpdateFindingInput$customerNote": "

A customer-provided note on the finding.

", - "UpdatePentestInput$pentestId": "

The unique identifier of the pentest to update.

", - "UpdatePentestInput$agentSpaceId": "

The unique identifier of the agent space that contains the pentest.

", - "UpdatePentestInput$title": "

The updated title of the pentest.

", - "UpdatePentestOutput$pentestId": "

The unique identifier of the pentest.

", - "UpdatePentestOutput$title": "

The title of the pentest.

", - "UpdatePentestOutput$agentSpaceId": "

The unique identifier of the agent space that contains the pentest.

", - "UpdatePrivateConnectionCertificateOutput$failureMessage": "

A message describing why the private connection entered a failed state, if applicable.

", - "UpdateSecurityRequirementEntry$description": "

The updated description of the security requirement.

", - "UpdateSecurityRequirementEntry$domain": "

The updated security domain the requirement belongs to.

", - "UpdateSecurityRequirementEntry$evaluation": "

The updated evaluation criteria used to assess compliance with this requirement.

", - "UpdateSecurityRequirementEntry$remediation": "

The updated remediation steps when the requirement is not met.

", - "UpdateSecurityRequirementPackInput$description": "

The updated description of the security requirement pack.

", - "UpdateSecurityRequirementPackOutput$description": "

The description of the security requirement pack.

", - "UpdateTargetDomainOutput$domainName": "

The domain name of the target domain.

", - "UpdateTargetDomainOutput$verificationStatusReason": "

The reason for the current target domain verification status.

", - "UpdateThreatInput$threatId": "

The unique identifier of the threat to update.

", - "UpdateThreatInput$agentSpaceId": "

The unique identifier of the agent space.

", - "UpdateThreatInput$title": "

A short title summarizing the threat.

", - "UpdateThreatInput$comments": "

Optional customer comment.

", - "UpdateThreatInput$statement": "

The updated natural-language threat statement.

", - "UpdateThreatInput$threatSource": "

The updated actor or origin of the threat.

", - "UpdateThreatInput$prerequisites": "

The updated conditions required for the threat to be exploitable.

", - "UpdateThreatInput$threatAction": "

The updated description of what the threat source can do.

", - "UpdateThreatInput$threatImpact": "

The updated direct consequence of the threat action.

", - "UpdateThreatInput$recommendation": "

The updated recommended mitigation guidance for this threat.

", - "UpdateThreatModelInput$threatModelId": "

The unique identifier of the threat model to update.

", - "UpdateThreatModelInput$agentSpaceId": "

The unique identifier of the agent space that contains the threat model.

", - "UpdateThreatModelInput$title": "

The updated title of the threat model.

", - "UpdateThreatModelInput$description": "

The updated description of the application or system being threat modeled.

", - "UpdateThreatModelOutput$threatModelId": "

The unique identifier of the threat model.

", - "UpdateThreatModelOutput$title": "

The title of the threat model.

", - "UpdateThreatModelOutput$agentSpaceId": "

The unique identifier of the agent space that contains the threat model.

", - "UpdateThreatModelOutput$description": "

A description of the application or system being threat modeled.

", - "UpdateThreatOutput$threatId": "

The unique identifier of the threat.

", - "UpdateThreatOutput$threatJobId": "

The unique identifier of the threat model job the threat belongs to.

", - "UpdateThreatOutput$title": "

A short title summarizing the threat.

", - "UpdateThreatOutput$statement": "

The natural-language threat statement.

", - "UpdateThreatOutput$comments": "

Optional customer comment on the threat.

", - "UpdateThreatOutput$threatSource": "

The actor or origin of the threat.

", - "UpdateThreatOutput$prerequisites": "

The conditions required for the threat to be exploitable.

", - "UpdateThreatOutput$threatAction": "

What the threat source can do.

", - "UpdateThreatOutput$threatImpact": "

The direct consequence of the threat action.

", - "UpdateThreatOutput$recommendation": "

The recommended mitigation guidance for this threat.

", - "UriList$member": null, - "UserMetadata$username": "

The username of the user.

", - "ValidationException$message": "

A summary of the validation failure.

", - "ValidationExceptionField$path": "

A JSONPointer expression to the structure member whose value failed to satisfy the modeled constraint.

", - "ValidationExceptionField$message": "

A detailed description of the validation failure.

", - "VerificationScript$scriptType": "

The type of script. Valid values are python and bash.

", - "VerificationScript$scriptUrl": "

URL to download the verification script.

", - "VerificationScript$instructions": "

Instructions for running the verification script, including prerequisites and how to interpret results.

", - "VerificationScriptEnvVar$name": "

The name of the environment variable.

", - "VerificationScriptEnvVar$value": "

The value of the environment variable.

", - "VerifyTargetDomainOutput$domainName": "

The domain name of the target domain.

", - "VerifyTargetDomainOutput$verificationStatusReason": "

The reason for the current target domain verification status.

" - } - }, - "StringList": { - "base": null, - "refs": { - "CreateThreatInput$impactedGoal": "

The security goals affected by the threat.

", - "CreateThreatInput$impactedAssets": "

The specific assets affected by the threat.

", - "CreateThreatOutput$impactedGoal": "

The security goals affected by the threat.

", - "CreateThreatOutput$impactedAssets": "

The specific assets affected by the threat.

", - "Threat$impactedGoal": "

The security goals affected by the threat.

", - "Threat$impactedAssets": "

The specific assets affected by the threat.

", - "UpdateThreatInput$impactedGoal": "

The updated security goals affected by the threat.

", - "UpdateThreatInput$impactedAssets": "

The updated list of specific assets affected by the threat.

", - "UpdateThreatOutput$impactedGoal": "

The security goals affected by the threat.

", - "UpdateThreatOutput$impactedAssets": "

The specific assets affected by the threat.

" - } - }, - "SubnetArn": { - "base": "

ARN or ID of a subnet.

", - "refs": { - "SubnetArns$member": null - } - }, - "SubnetArns": { - "base": "

A list of one or more subnet ARNs or IDs in the customer VPC.

", - "refs": { - "VpcConfig$subnetArns": "

The Amazon Resource Names (ARNs) of the subnets for the VPC configuration.

" - } - }, - "SyntheticTimestamp_date_time": { - "base": null, - "refs": { - "AgentSpace$createdAt": "

The date and time the agent space was created, in UTC format.

", - "AgentSpace$updatedAt": "

The date and time the agent space was last updated, in UTC format.

", - "AgentSpaceSummary$createdAt": "

The date and time the agent space was created, in UTC format.

", - "AgentSpaceSummary$updatedAt": "

The date and time the agent space was last updated, in UTC format.

", - "ArtifactMetadataItem$updatedAt": "

The date and time the artifact was last updated, in UTC format.

", - "BatchCreateSecurityRequirementResult$createdAt": "

The date and time the security requirement was created, in UTC format.

", - "BatchCreateSecurityRequirementResult$updatedAt": "

The date and time the security requirement was last updated, in UTC format.

", - "BatchGetSecurityRequirementResult$createdAt": "

The date and time the security requirement was created, in UTC format.

", - "BatchGetSecurityRequirementResult$updatedAt": "

The date and time the security requirement was last updated, in UTC format.

", - "CodeReview$createdAt": "

The date and time the code review was created, in UTC format.

", - "CodeReview$updatedAt": "

The date and time the code review was last updated, in UTC format.

", - "CodeReviewJob$createdAt": "

The date and time the code review job was created, in UTC format.

", - "CodeReviewJob$updatedAt": "

The date and time the code review job was last updated, in UTC format.

", - "CodeReviewJobSummary$createdAt": "

The date and time the code review job was created, in UTC format.

", - "CodeReviewJobSummary$updatedAt": "

The date and time the code review job was last updated, in UTC format.

", - "CodeReviewJobTask$createdAt": "

The date and time the task was created, in UTC format.

", - "CodeReviewJobTask$updatedAt": "

The date and time the task was last updated, in UTC format.

", - "CodeReviewJobTaskSummary$createdAt": "

The date and time the task was created, in UTC format.

", - "CodeReviewJobTaskSummary$updatedAt": "

The date and time the task was last updated, in UTC format.

", - "CodeReviewSummary$createdAt": "

The date and time the code review was created, in UTC format.

", - "CodeReviewSummary$updatedAt": "

The date and time the code review was last updated, in UTC format.

", - "CreateAgentSpaceOutput$createdAt": "

The date and time the agent space was created, in UTC format.

", - "CreateAgentSpaceOutput$updatedAt": "

The date and time the agent space was last updated, in UTC format.

", - "CreateCodeReviewOutput$createdAt": "

The date and time the code review was created, in UTC format.

", - "CreateCodeReviewOutput$updatedAt": "

The date and time the code review was last updated, in UTC format.

", - "CreatePentestOutput$createdAt": "

The date and time the pentest was created, in UTC format.

", - "CreatePentestOutput$updatedAt": "

The date and time the pentest was last updated, in UTC format.

", - "CreatePrivateConnectionOutput$certificateExpiryTime": "

The date and time the connection's certificate expires, in UTC format.

", - "CreateTargetDomainOutput$createdAt": "

The date and time the target domain was created, in UTC format.

", - "CreateTargetDomainOutput$verifiedAt": "

The date and time the target domain was verified, in UTC format.

", - "CreateThreatModelOutput$createdAt": "

The date and time the threat model was created, in UTC format.

", - "CreateThreatModelOutput$updatedAt": "

The date and time the threat model was last updated, in UTC format.

", - "CreateThreatOutput$createdAt": "

The date and time the threat was created, in UTC format.

", - "CreateThreatOutput$updatedAt": "

The date and time the threat was last updated, in UTC format.

", - "DeletePrivateConnectionOutput$certificateExpiryTime": "

The date and time the connection's certificate expires, in UTC format.

", - "DescribePrivateConnectionOutput$certificateExpiryTime": "

The date and time the connection's certificate expires, in UTC format.

", - "ExecutionContext$timestamp": "

The date and time the context was recorded, in UTC format.

", - "Finding$createdAt": "

The date and time the finding was created, in UTC format.

", - "Finding$updatedAt": "

The date and time the finding was last updated, in UTC format.

", - "FindingSummary$createdAt": "

The date and time the finding was created, in UTC format.

", - "FindingSummary$updatedAt": "

The date and time the finding was last updated, in UTC format.

", - "GetArtifactOutput$updatedAt": "

The date and time the artifact was last updated, in UTC format.

", - "GetSecurityRequirementPackOutput$createdAt": "

The date and time the security requirement pack was created, in UTC format.

", - "GetSecurityRequirementPackOutput$updatedAt": "

The date and time the security requirement pack was last updated, in UTC format.

", - "MembershipSummary$createdAt": "

The date and time the membership was created, in UTC format.

", - "MembershipSummary$updatedAt": "

The date and time the membership was last updated, in UTC format.

", - "Pentest$createdAt": "

The date and time the pentest was created, in UTC format.

", - "Pentest$updatedAt": "

The date and time the pentest was last updated, in UTC format.

", - "PentestJob$createdAt": "

The date and time the pentest job was created, in UTC format.

", - "PentestJob$updatedAt": "

The date and time the pentest job was last updated, in UTC format.

", - "PentestJobSummary$createdAt": "

The date and time the pentest job was created, in UTC format.

", - "PentestJobSummary$updatedAt": "

The date and time the pentest job was last updated, in UTC format.

", - "PentestSummary$createdAt": "

The date and time the pentest was created, in UTC format.

", - "PentestSummary$updatedAt": "

The date and time the pentest was last updated, in UTC format.

", - "PrivateConnectionSummary$certificateExpiryTime": "

The date and time the connection's certificate expires, in UTC format.

", - "SecurityRequirementPackSummary$createdAt": "

The date and time the security requirement pack was created, in UTC format.

", - "SecurityRequirementPackSummary$updatedAt": "

The date and time the security requirement pack was last updated, in UTC format.

", - "SecurityRequirementSummary$createdAt": "

The date and time the security requirement was created, in UTC format.

", - "SecurityRequirementSummary$updatedAt": "

The date and time the security requirement was last updated, in UTC format.

", - "StartCodeReviewJobOutput$createdAt": "

The date and time the code review job was created, in UTC format.

", - "StartCodeReviewJobOutput$updatedAt": "

The date and time the code review job was last updated, in UTC format.

", - "StartPentestJobOutput$createdAt": "

The date and time the pentest job was created, in UTC format.

", - "StartPentestJobOutput$updatedAt": "

The date and time the pentest job was last updated, in UTC format.

", - "StartThreatModelJobOutput$createdAt": "

The date and time the threat model job was created, in UTC format.

", - "StartThreatModelJobOutput$updatedAt": "

The date and time the threat model job was last updated, in UTC format.

", - "Step$createdAt": "

The date and time the step was created, in UTC format.

", - "Step$updatedAt": "

The date and time the step was last updated, in UTC format.

", - "TargetDomain$createdAt": "

The date and time the target domain was created, in UTC format.

", - "TargetDomain$verifiedAt": "

The date and time the target domain was verified, in UTC format.

", - "Task$createdAt": "

The date and time the task was created, in UTC format.

", - "Task$updatedAt": "

The date and time the task was last updated, in UTC format.

", - "TaskSummary$createdAt": "

The date and time the task was created, in UTC format.

", - "TaskSummary$updatedAt": "

The date and time the task was last updated, in UTC format.

", - "Threat$createdAt": "

The date and time the threat was created, in UTC format.

", - "Threat$updatedAt": "

The date and time the threat was last updated, in UTC format.

", - "ThreatModel$createdAt": "

The date and time the threat model was created, in UTC format.

", - "ThreatModel$updatedAt": "

The date and time the threat model was last updated, in UTC format.

", - "ThreatModelJob$createdAt": "

The date and time the threat model job was created, in UTC format.

", - "ThreatModelJob$updatedAt": "

The date and time the threat model job was last updated, in UTC format.

", - "ThreatModelJob$executionStartTime": "

The date and time the threat model job execution started, in UTC format.

", - "ThreatModelJob$executionEndTime": "

The date and time the threat model job execution ended, in UTC format.

", - "ThreatModelJobSummary$createdAt": "

The date and time the threat model job was created, in UTC format.

", - "ThreatModelJobSummary$updatedAt": "

The date and time the threat model job was last updated, in UTC format.

", - "ThreatModelJobTask$createdAt": "

The date and time the task was created, in UTC format.

", - "ThreatModelJobTask$updatedAt": "

The date and time the task was last updated, in UTC format.

", - "ThreatModelJobTaskSummary$createdAt": "

The date and time the task was created, in UTC format.

", - "ThreatModelJobTaskSummary$updatedAt": "

The date and time the task was last updated, in UTC format.

", - "ThreatModelSummary$createdAt": "

The date and time the threat model was created, in UTC format.

", - "ThreatModelSummary$updatedAt": "

The date and time the threat model was last updated, in UTC format.

", - "ThreatSummary$createdAt": "

The date and time the threat was created, in UTC format.

", - "ThreatSummary$updatedAt": "

The date and time the threat was last updated, in UTC format.

", - "UpdateAgentSpaceOutput$createdAt": "

The date and time the agent space was created, in UTC format.

", - "UpdateAgentSpaceOutput$updatedAt": "

The date and time the agent space was last updated, in UTC format.

", - "UpdateCodeReviewOutput$createdAt": "

The date and time the code review was created, in UTC format.

", - "UpdateCodeReviewOutput$updatedAt": "

The date and time the code review was last updated, in UTC format.

", - "UpdatePentestOutput$createdAt": "

The date and time the pentest was created, in UTC format.

", - "UpdatePentestOutput$updatedAt": "

The date and time the pentest was last updated, in UTC format.

", - "UpdatePrivateConnectionCertificateOutput$certificateExpiryTime": "

The date and time the connection's certificate expires, in UTC format.

", - "UpdateTargetDomainOutput$createdAt": "

The date and time the target domain was created, in UTC format.

", - "UpdateTargetDomainOutput$verifiedAt": "

The date and time the target domain was verified, in UTC format.

", - "UpdateThreatModelOutput$createdAt": "

The date and time the threat model was created, in UTC format.

", - "UpdateThreatModelOutput$updatedAt": "

The date and time the threat model was last updated, in UTC format.

", - "UpdateThreatOutput$createdAt": "

The date and time the threat was created, in UTC format.

", - "UpdateThreatOutput$updatedAt": "

The date and time the threat was last updated, in UTC format.

", - "VerifyTargetDomainOutput$createdAt": "

The date and time the target domain was created, in UTC format.

", - "VerifyTargetDomainOutput$updatedAt": "

The date and time the target domain was last updated, in UTC format.

", - "VerifyTargetDomainOutput$verifiedAt": "

The date and time the target domain was verified, in UTC format.

" - } - }, - "TagKey": { - "base": "

Key for a resource tag.

", - "refs": { - "TagKeyList$member": null, - "TagMap$key": null - } - }, - "TagKeyList": { - "base": "

List of tag keys.

", - "refs": { - "UntagResourceInput$tagKeys": "

The list of tag keys to remove from the resource.

" - } - }, - "TagMap": { - "base": "

Map of tags for a resource.

", - "refs": { - "CreateAgentSpaceInput$tags": "

The tags to associate with the agent space.

", - "CreateApplicationRequest$tags": "

The tags to associate with the application.

", - "CreateIntegrationInput$tags": "

The tags to associate with the integration.

", - "CreatePrivateConnectionInput$tags": "

The tags to attach to the private connection.

", - "CreatePrivateConnectionOutput$tags": "

The tags attached to the private connection.

", - "CreateSecurityRequirementPackInput$tags": "

The tags to associate with the security requirement pack.

", - "CreateTargetDomainInput$tags": "

The tags to associate with the target domain.

", - "DeletePrivateConnectionOutput$tags": "

The tags attached to the private connection.

", - "DescribePrivateConnectionOutput$tags": "

The tags attached to the private connection.

", - "ListTagsForResourceOutput$tags": "

The tags associated with the resource.

", - "PrivateConnectionSummary$tags": "

The tags attached to the private connection.

", - "TagResourceInput$tags": "

The tags to add to the resource.

", - "UpdatePrivateConnectionCertificateOutput$tags": "

The tags attached to the private connection.

" - } - }, - "TagResourceInput": { - "base": "

Input for TagResource operation.

", - "refs": {} - }, - "TagResourceOutput": { - "base": "

Output for TagResource operation.

", - "refs": {} - }, - "TagValue": { - "base": "

Value for a resource tag.

", - "refs": { - "TagMap$value": null - } - }, - "TargetDomain": { - "base": "

Represents a target domain registered for penetration testing. A target domain must be verified through DNS TXT or HTTP route verification before it can be used in pentests.

", - "refs": { - "TargetDomainList$member": null - } - }, - "TargetDomainId": { - "base": "

Unique identifier of the target domain.

", - "refs": { - "CreateTargetDomainOutput$targetDomainId": "

The unique identifier of the created target domain.

", - "DeleteTargetDomainInput$targetDomainId": "

The unique identifier of the target domain to delete.

", - "DeleteTargetDomainOutput$targetDomainId": "

The unique identifier of the deleted target domain.

", - "TargetDomain$targetDomainId": "

The unique identifier of the target domain.

", - "TargetDomainSummary$targetDomainId": "

The unique identifier of the target domain.

", - "UpdateTargetDomainInput$targetDomainId": "

The unique identifier of the target domain to update.

", - "UpdateTargetDomainOutput$targetDomainId": "

The unique identifier of the target domain.

", - "VerifyTargetDomainInput$targetDomainId": "

The unique identifier of the target domain to verify.

", - "VerifyTargetDomainOutput$targetDomainId": "

The unique identifier of the target domain.

" - } - }, - "TargetDomainIdList": { - "base": "

List of target domain IDs.

", - "refs": { - "AgentSpace$targetDomainIds": "

The list of target domain identifiers associated with the agent space.

", - "BatchGetTargetDomainsInput$targetDomainIds": "

The list of target domain identifiers to retrieve.

", - "BatchGetTargetDomainsOutput$notFound": "

The list of target domain identifiers that were not found.

", - "CreateAgentSpaceInput$targetDomainIds": "

The list of target domain identifiers to associate with the agent space.

", - "CreateAgentSpaceOutput$targetDomainIds": "

The list of target domain identifiers associated with the agent space.

", - "UpdateAgentSpaceInput$targetDomainIds": "

The updated list of target domain identifiers to associate with the agent space.

", - "UpdateAgentSpaceOutput$targetDomainIds": "

The list of target domain identifiers associated with the agent space.

" - } - }, - "TargetDomainList": { - "base": "

List of target domains.

", - "refs": { - "BatchGetTargetDomainsOutput$targetDomains": "

The list of target domains that were found.

" - } - }, - "TargetDomainStatus": { - "base": "

Verification status of a target domain.

", - "refs": { - "CreateTargetDomainOutput$verificationStatus": "

The current verification status of the target domain.

", - "TargetDomain$verificationStatus": "

The current verification status of the target domain.

", - "TargetDomainSummary$verificationStatus": "

The current verification status of the target domain.

", - "UpdateTargetDomainOutput$verificationStatus": "

The current verification status of the target domain.

", - "VerifyTargetDomainOutput$status": "

The verification status of the target domain.

" - } - }, - "TargetDomainSummary": { - "base": "

Contains summary information about a target domain.

", - "refs": { - "TargetDomainSummaryList$member": null - } - }, - "TargetDomainSummaryList": { - "base": null, - "refs": { - "ListTargetDomainsOutput$targetDomainSummaries": "

The list of target domain summaries.

" - } - }, - "TargetUrl": { - "base": "

The HTTPS URL of a customer self-hosted instance.

", - "refs": { - "GetIntegrationOutput$targetUrl": "

The HTTPS URL of the customer self-hosted instance, such as a GitHub Enterprise Server or self-managed GitLab instance. This value is absent for SaaS integrations.

", - "GitHubIntegrationInput$targetUrl": "

The HTTPS URL of a self-hosted GitHub Enterprise Server instance. Omit this value for GitHub.com.

", - "GitLabIntegrationInput$targetUrl": "

The HTTPS URL of a self-managed GitLab instance. Omit this value for GitLab SaaS (gitlab.com).

", - "IntegrationSummary$targetUrl": "

The HTTPS URL of the customer self-hosted instance, such as a GitHub Enterprise Server or self-managed GitLab instance. This value is absent for SaaS integrations.

" - } - }, - "Task": { - "base": "

Represents an individual security test task within a pentest job. Each task targets a specific risk type or endpoint and executes independently.

", - "refs": { - "TaskList$member": null - } - }, - "TaskExecutionStatus": { - "base": "

Execution status of a task.

", - "refs": { - "CodeReviewJobTask$executionStatus": "

The current execution status of the task.

", - "CodeReviewJobTaskSummary$executionStatus": "

The current execution status of the task.

", - "Task$executionStatus": "

The current execution status of the task.

", - "TaskSummary$executionStatus": "

The current execution status of the task.

", - "ThreatModelJobTask$executionStatus": "

The current execution status of the task.

", - "ThreatModelJobTaskSummary$executionStatus": "

The current execution status of the task.

" - } - }, - "TaskIdList": { - "base": null, - "refs": { - "BatchGetCodeReviewJobTasksInput$codeReviewJobTaskIds": "

The list of task identifiers to retrieve.

", - "BatchGetCodeReviewJobTasksOutput$notFound": "

The list of task identifiers that were not found.

", - "BatchGetPentestJobTasksInput$taskIds": "

The list of task identifiers to retrieve.

", - "BatchGetPentestJobTasksOutput$notFound": "

The list of task identifiers that were not found.

", - "BatchGetThreatModelJobTasksInput$threatModelJobTaskIds": "

The list of task identifiers to retrieve.

", - "BatchGetThreatModelJobTasksOutput$notFound": "

The list of task identifiers that were not found.

" - } - }, - "TaskList": { - "base": null, - "refs": { - "BatchGetPentestJobTasksOutput$tasks": "

The list of tasks that were found.

" - } - }, - "TaskSummary": { - "base": "

Contains summary information about a task.

", - "refs": { - "TaskSummaryList$member": null - } - }, - "TaskSummaryList": { - "base": null, - "refs": { - "ListPentestJobTasksOutput$taskSummaries": "

The list of task summaries.

" - } - }, - "Threat": { - "base": "

Represents a threat identified during threat modeling.

", - "refs": { - "ThreatList$member": null - } - }, - "ThreatActor": { - "base": "

Indicates whether a threat was created or updated by a customer or an agent.

", - "refs": { - "CreateThreatOutput$createdBy": "

Who created this threat.

", - "CreateThreatOutput$updatedBy": "

Who last updated this threat.

", - "Threat$createdBy": "

Who created this threat.

", - "Threat$updatedBy": "

Who last updated this threat.

", - "ThreatSummary$createdBy": "

Who created this threat.

", - "ThreatSummary$updatedBy": "

Who last updated this threat.

", - "UpdateThreatOutput$createdBy": "

Who created this threat.

", - "UpdateThreatOutput$updatedBy": "

Who last updated this threat.

" - } - }, - "ThreatAnchorShape": { - "base": "

DFD element that a threat is anchored to.

", - "refs": { - "CreateThreatInput$anchor": "

The DFD element this threat is anchored to.

", - "CreateThreatOutput$anchor": "

The DFD element this threat is anchored to.

", - "Threat$anchor": "

The DFD element this threat is anchored to.

", - "UpdateThreatInput$anchor": "

The updated DFD element this threat is anchored to.

", - "UpdateThreatOutput$anchor": "

The DFD element this threat is anchored to.

" - } - }, - "ThreatEvidenceList": { - "base": "

List of threat evidence.

", - "refs": { - "CreateThreatInput$evidence": "

The source code files supporting the threat.

", - "CreateThreatOutput$evidence": "

The source code files supporting the threat.

", - "Threat$evidence": "

The source code files supporting the threat.

", - "UpdateThreatInput$evidence": "

The updated source code files supporting the threat.

", - "UpdateThreatOutput$evidence": "

The source code files supporting the threat.

" - } - }, - "ThreatEvidenceShape": { - "base": "

Source code file supporting a threat.

", - "refs": { - "ThreatEvidenceList$member": null - } - }, - "ThreatIdList": { - "base": "

List of threat IDs.

", - "refs": { - "BatchGetThreatsInput$threatIds": "

The list of threat identifiers to retrieve.

", - "BatchGetThreatsOutput$notFound": "

The list of threat identifiers that were not found.

" - } - }, - "ThreatList": { - "base": "

List of threats.

", - "refs": { - "BatchGetThreatsOutput$threats": "

The list of threats that were found.

" - } - }, - "ThreatModel": { - "base": "

Represents a threat model configuration that defines the parameters for automated threat analysis, including target assets and logging configuration.

", - "refs": { - "ThreatModelList$member": null - } - }, - "ThreatModelIdList": { - "base": "

List of threat model IDs.

", - "refs": { - "BatchDeleteThreatModelsInput$threatModelIds": "

The list of threat model identifiers to delete.

", - "BatchDeleteThreatModelsOutput$deleted": "

The list of threat model identifiers that were successfully deleted.

", - "BatchGetThreatModelsInput$threatModelIds": "

The list of threat model identifiers to retrieve.

", - "BatchGetThreatModelsOutput$notFound": "

The list of threat model identifiers that were not found.

" - } - }, - "ThreatModelJob": { - "base": "

Represents a threat model job, which is an execution instance of a threat model.

", - "refs": { - "ThreatModelJobList$member": null - } - }, - "ThreatModelJobIdList": { - "base": "

List of threat model job IDs.

", - "refs": { - "BatchGetThreatModelJobsInput$threatModelJobIds": "

The list of threat model job identifiers to retrieve.

", - "BatchGetThreatModelJobsOutput$notFound": "

The list of threat model job identifiers that were not found.

" - } - }, - "ThreatModelJobList": { - "base": "

List of threat model jobs.

", - "refs": { - "BatchGetThreatModelJobsOutput$threatModelJobs": "

The list of threat model jobs that were found.

" - } - }, - "ThreatModelJobSummary": { - "base": "

Contains summary information about a threat model job.

", - "refs": { - "ThreatModelJobSummaryList$member": null - } - }, - "ThreatModelJobSummaryList": { - "base": "

List of threat model job summaries.

", - "refs": { - "ListThreatModelJobsOutput$threatModelJobSummaries": "

The list of threat model job summaries.

" - } - }, - "ThreatModelJobTask": { - "base": "

Represents an individual task within a threat model job.

", - "refs": { - "ThreatModelJobTaskList$member": null - } - }, - "ThreatModelJobTaskList": { - "base": "

List of threat model job tasks.

", - "refs": { - "BatchGetThreatModelJobTasksOutput$threatModelJobTasks": "

The list of threat model job tasks that were found.

" - } - }, - "ThreatModelJobTaskSummary": { - "base": "

Contains summary information about a threat model job task.

", - "refs": { - "ThreatModelJobTaskSummaryList$member": null - } - }, - "ThreatModelJobTaskSummaryList": { - "base": "

List of threat model job task summaries.

", - "refs": { - "ListThreatModelJobTasksOutput$threatModelJobTaskSummaries": "

The list of threat model job task summaries.

" - } - }, - "ThreatModelList": { - "base": "

List of threat models.

", - "refs": { - "BatchGetThreatModelsOutput$threatModels": "

The list of threat models that were found.

" - } - }, - "ThreatModelSummary": { - "base": "

Contains summary information about a threat model.

", - "refs": { - "ThreatModelSummaryList$member": null - } - }, - "ThreatModelSummaryList": { - "base": "

List of threat model summaries.

", - "refs": { - "ListThreatModelsOutput$threatModelSummaries": "

The list of threat model summaries.

" - } - }, - "ThreatSeverity": { - "base": "

Severity level for a threat.

", - "refs": { - "CreateThreatInput$severity": "

The severity level of the threat.

", - "CreateThreatOutput$severity": "

The severity level of the threat.

", - "Threat$severity": "

The severity level of the threat.

", - "ThreatSummary$severity": "

The severity level of the threat.

", - "UpdateThreatInput$severity": "

The updated severity level of the threat.

", - "UpdateThreatOutput$severity": "

The severity level of the threat.

" - } - }, - "ThreatStatus": { - "base": "

Status of a threat.

", - "refs": { - "CreateThreatOutput$status": "

The current status of the threat.

", - "Threat$status": "

The current status of the threat.

", - "ThreatSummary$status": "

The current status of the threat.

", - "UpdateThreatInput$status": "

The updated status of the threat.

", - "UpdateThreatOutput$status": "

The current status of the threat.

" - } - }, - "ThreatSummary": { - "base": "

Contains summary information about a threat.

", - "refs": { - "ThreatSummaryList$member": null - } - }, - "ThreatSummaryList": { - "base": "

List of threat summaries.

", - "refs": { - "ListThreatsOutput$threats": "

The list of threat summaries.

" - } - }, - "ThrottlingException": { - "base": "

The request was denied due to request throttling.

", - "refs": {} - }, - "UntagResourceInput": { - "base": "

Input for UntagResource operation.

", - "refs": {} - }, - "UntagResourceOutput": { - "base": "

Output for UntagResource operation.

", - "refs": {} - }, - "UpdateAgentSpaceInput": { - "base": "

Input for updating an agent space.

", - "refs": {} - }, - "UpdateAgentSpaceOutput": { - "base": "

Output for the UpdateAgentSpace operation.

", - "refs": {} - }, - "UpdateApplicationRequest": { - "base": null, - "refs": {} - }, - "UpdateApplicationResponse": { - "base": null, - "refs": {} - }, - "UpdateCodeReviewInput": { - "base": "

Input for updating an existing code review.

", - "refs": {} - }, - "UpdateCodeReviewOutput": { - "base": "

Output for the UpdateCodeReview operation.

", - "refs": {} - }, - "UpdateFindingInput": { - "base": "

Input for updating an existing security finding.

", - "refs": {} - }, - "UpdateFindingOutput": { - "base": "

Output for the UpdateFinding operation.

", - "refs": {} - }, - "UpdateIntegratedResourcesInput": { - "base": null, - "refs": {} - }, - "UpdateIntegratedResourcesOutput": { - "base": null, - "refs": {} - }, - "UpdatePentestInput": { - "base": "

Input for updating an existing pentest.

", - "refs": {} - }, - "UpdatePentestOutput": { - "base": "

Output for the UpdatePentest operation.

", - "refs": {} - }, - "UpdatePrivateConnectionCertificateInput": { - "base": null, - "refs": {} - }, - "UpdatePrivateConnectionCertificateOutput": { - "base": null, - "refs": {} - }, - "UpdateSecurityRequirementEntry": { - "base": "

Contains the details for updating an existing security requirement within a pack. The name is an immutable identifier used to locate the requirement and cannot be modified.

", - "refs": { - "UpdateSecurityRequirementEntryList$member": null - } - }, - "UpdateSecurityRequirementEntryList": { - "base": "

List of security requirement updates to apply.

", - "refs": { - "BatchUpdateSecurityRequirementsInput$securityRequirements": "

The list of security requirement updates to apply.

" - } - }, - "UpdateSecurityRequirementPackInput": { - "base": null, - "refs": {} - }, - "UpdateSecurityRequirementPackOutput": { - "base": null, - "refs": {} - }, - "UpdateTargetDomainInput": { - "base": "

Input for updating a target domain.

", - "refs": {} - }, - "UpdateTargetDomainOutput": { - "base": "

Output for the UpdateTargetDomain operation.

", - "refs": {} - }, - "UpdateThreatInput": { - "base": "

Input for updating an existing threat.

", - "refs": {} - }, - "UpdateThreatModelInput": { - "base": "

Input for updating an existing threat model.

", - "refs": {} - }, - "UpdateThreatModelOutput": { - "base": "

Output for the UpdateThreatModel operation.

", - "refs": {} - }, - "UpdateThreatOutput": { - "base": "

Output for the UpdateThreat operation.

", - "refs": {} - }, - "UriList": { - "base": null, - "refs": { - "Actor$uris": "

The list of URIs that the actor targets during testing.

" - } - }, - "UserConfig": { - "base": "

The configuration for a user membership, including the role assigned to the user within the agent space.

", - "refs": { - "MembershipConfig$user": "

The user configuration for the membership.

" - } - }, - "UserMetadata": { - "base": "

Contains metadata about a user member, including the username and email address.

", - "refs": { - "MemberMetadata$user": "

The user metadata for the member.

" - } - }, - "UserRole": { - "base": "

Role of a user member associated to an agent space.

", - "refs": { - "UserConfig$role": "

The role assigned to the user. Currently, only MEMBER is supported.

" - } - }, - "ValidationException": { - "base": "

The input fails to satisfy the constraints specified by the service.

", - "refs": {} - }, - "ValidationExceptionField": { - "base": "

Describes one specific validation failure for an input member.

", - "refs": { - "ValidationExceptionFieldList$member": null - } - }, - "ValidationExceptionFieldList": { - "base": null, - "refs": { - "ValidationException$fieldList": "

A list of specific failures encountered during validation.

" - } - }, - "ValidationMode": { - "base": "

Mode of validation to perform on findings

", - "refs": { - "CodeReview$validationMode": "

The validation mode for the code review. Valid values are SIMULATED and DISABLED.

", - "CreateCodeReviewInput$validationMode": "

The validation mode for the code review. Valid values are SIMULATED and DISABLED.

", - "CreateCodeReviewOutput$validationMode": "

The validation mode for the code review.

", - "UpdateCodeReviewInput$validationMode": "

The updated validation mode for the code review. Valid values are SIMULATED and DISABLED.

", - "UpdateCodeReviewOutput$validationMode": "

The validation mode for the code review.

" - } - }, - "ValidationStatus": { - "base": "

Per-finding sandbox validation status

", - "refs": { - "Finding$validationStatus": "

The simulated validation status of the finding. Valid values are NOT_VALIDATED, VALIDATING, CONFIRMED, NOT_REPRODUCED, and VALIDATION_FAILED.

", - "FindingSummary$validationStatus": "

The simulated validation status of the finding.

" - } - }, - "VerificationDetails": { - "base": "

Contains the verification details for a target domain, including the verification method and provider-specific details.

", - "refs": { - "CreateTargetDomainOutput$verificationDetails": "

The verification details for the target domain, including the verification token and instructions.

", - "TargetDomain$verificationDetails": "

The verification details for the target domain.

", - "UpdateTargetDomainOutput$verificationDetails": "

The updated verification details for the target domain.

" - } - }, - "VerificationScript": { - "base": "

Contains metadata for a verification script that can be used to reproduce a security finding.

", - "refs": { - "Finding$verificationScript": "

The verification script metadata for reproducing the finding, including download URL, instructions, and required environment variables.

" - } - }, - "VerificationScriptEnvVar": { - "base": "

Represents an environment variable required to run a verification script.

", - "refs": { - "VerificationScriptEnvVarList$member": null - } - }, - "VerificationScriptEnvVarList": { - "base": "

List of environment variables required to run a verification script.

", - "refs": { - "VerificationScript$envVars": "

The list of environment variables required to run the verification script.

" - } - }, - "VerifyTargetDomainInput": { - "base": "

Input for verifying ownership for a registered target domain in an agent space.

", - "refs": {} - }, - "VerifyTargetDomainOutput": { - "base": "

Output for verifying ownership for a registered target domain in an agent space.

", - "refs": {} - }, - "VpcArn": { - "base": "

ARN or ID of a VPC.

", - "refs": { - "VpcConfig$vpcArn": "

The Amazon Resource Name (ARN) of the VPC.

" - } - }, - "VpcConfig": { - "base": "

The VPC configuration for a pentest, specifying the VPC, security groups, and subnets to use during testing.

", - "refs": { - "CreatePentestInput$vpcConfig": "

The VPC configuration for the pentest.

", - "Pentest$vpcConfig": "

The VPC configuration for the pentest.

", - "PentestJob$vpcConfig": "

The VPC configuration for the pentest job.

", - "UpdatePentestInput$vpcConfig": "

The updated VPC configuration for the pentest.

", - "VpcConfigs$member": null - } - }, - "VpcConfigs": { - "base": null, - "refs": { - "AWSResources$vpcs": "

The VPC configurations associated with the agent space.

" - } - } - } -} diff --git a/tools/code-generation/api-descriptions/securityagent/2025-09-06/endpoint-bdd-1.json b/tools/code-generation/api-descriptions/securityagent/2025-09-06/endpoint-bdd-1.json deleted file mode 100644 index 29544aefc902..000000000000 --- a/tools/code-generation/api-descriptions/securityagent/2025-09-06/endpoint-bdd-1.json +++ /dev/null @@ -1,104 +0,0 @@ -{ - "version": "1.1", - "parameters": { - "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" - }, - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "string" - } - }, - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - }, - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - }, - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "results": [ - { - "conditions": [], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://securityagent-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://securityagent.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ], - "root": 2, - "nodeCount": 6, - "nodes": "/////wAAAAH/////AAAAAAAAAAYAAAADAAAAAQAAAAQF9eEFAAAAAgAAAAUF9eEFAAAAAwX14QMF9eEEAAAAAwX14QEF9eEC" -} \ No newline at end of file diff --git a/tools/code-generation/api-descriptions/securityagent/2025-09-06/endpoint-rule-set-1.json b/tools/code-generation/api-descriptions/securityagent/2025-09-06/endpoint-rule-set-1.json deleted file mode 100644 index 1a8728f1e4a2..000000000000 --- a/tools/code-generation/api-descriptions/securityagent/2025-09-06/endpoint-rule-set-1.json +++ /dev/null @@ -1,137 +0,0 @@ -{ - "version": "1.0", - "parameters": { - "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" - }, - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the 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": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "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 - ] - } - ], - "endpoint": { - "url": "https://securityagent-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://securityagent.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ], - "type": "tree" - } - ] -} \ No newline at end of file diff --git a/tools/code-generation/api-descriptions/securityagent/2025-09-06/endpoint-tests-1.json b/tools/code-generation/api-descriptions/securityagent/2025-09-06/endpoint-tests-1.json deleted file mode 100644 index 3f8e8d902954..000000000000 --- a/tools/code-generation/api-descriptions/securityagent/2025-09-06/endpoint-tests-1.json +++ /dev/null @@ -1,105 +0,0 @@ -{ - "testCases": [ - { - "documentation": "For custom endpoint with region not set and fips disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Endpoint": "https://example.com", - "UseFIPS": false - } - }, - { - "documentation": "For custom endpoint with fips enabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Endpoint": "https://example.com", - "UseFIPS": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://securityagent-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://securityagent.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://securityagent-fips.cn-northwest-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-northwest-1", - "UseFIPS": true - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://securityagent.cn-northwest-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-northwest-1", - "UseFIPS": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://securityagent-fips.us-gov-west-1.api.aws" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": true - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://securityagent.us-gov-west-1.api.aws" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": false - } - }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } - } - ], - "version": "1.0" -} \ No newline at end of file diff --git a/tools/code-generation/api-descriptions/securityagent/2025-09-06/examples-1.json b/tools/code-generation/api-descriptions/securityagent/2025-09-06/examples-1.json deleted file mode 100644 index 2fb77604d1be..000000000000 --- a/tools/code-generation/api-descriptions/securityagent/2025-09-06/examples-1.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "version": "1.0", - "examples": {} -} diff --git a/tools/code-generation/api-descriptions/securityagent/2025-09-06/paginators-1.json b/tools/code-generation/api-descriptions/securityagent/2025-09-06/paginators-1.json deleted file mode 100644 index 9bd051509561..000000000000 --- a/tools/code-generation/api-descriptions/securityagent/2025-09-06/paginators-1.json +++ /dev/null @@ -1,136 +0,0 @@ -{ - "pagination": { - "ListAgentSpaces": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "agentSpaceSummaries" - }, - "ListApplications": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "applicationSummaries" - }, - "ListArtifacts": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "artifactSummaries" - }, - "ListCodeReviewJobTasks": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "codeReviewJobTaskSummaries" - }, - "ListCodeReviewJobsForCodeReview": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "codeReviewJobSummaries" - }, - "ListCodeReviews": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "codeReviewSummaries" - }, - "ListDiscoveredEndpoints": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "discoveredEndpoints" - }, - "ListFindings": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "findingsSummaries" - }, - "ListIntegratedResources": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "integratedResourceSummaries" - }, - "ListIntegrations": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "integrationSummaries" - }, - "ListMemberships": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "membershipSummaries" - }, - "ListPentestJobTasks": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "taskSummaries" - }, - "ListPentestJobsForPentest": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "pentestJobSummaries" - }, - "ListPentests": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "pentestSummaries" - }, - "ListPrivateConnections": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "privateConnections" - }, - "ListSecurityRequirementPacks": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "securityRequirementPackSummaries" - }, - "ListSecurityRequirements": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "securityRequirementSummaries" - }, - "ListTargetDomains": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "targetDomainSummaries" - }, - "ListThreatModelJobTasks": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "threatModelJobTaskSummaries" - }, - "ListThreatModelJobs": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "threatModelJobSummaries" - }, - "ListThreatModels": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "threatModelSummaries" - }, - "ListThreats": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "threats" - } - } -} diff --git a/tools/code-generation/api-descriptions/securityagent/2025-09-06/service-2.json b/tools/code-generation/api-descriptions/securityagent/2025-09-06/service-2.json deleted file mode 100644 index f15fc17b0a5d..000000000000 --- a/tools/code-generation/api-descriptions/securityagent/2025-09-06/service-2.json +++ /dev/null @@ -1,9667 +0,0 @@ -{ - "version":"2.0", - "metadata":{ - "apiVersion":"2025-09-06", - "auth":["aws.auth#sigv4"], - "endpointPrefix":"securityagent", - "protocol":"rest-json", - "protocols":["rest-json"], - "serviceFullName":"AWS Security Agent", - "serviceId":"SecurityAgent", - "signatureVersion":"v4", - "signingName":"securityagent", - "uid":"securityagent-2025-09-06" - }, - "operations":{ - "AddArtifact":{ - "name":"AddArtifact", - "http":{ - "method":"POST", - "requestUri":"/AddArtifact", - "responseCode":201 - }, - "input":{"shape":"AddArtifactInput"}, - "output":{"shape":"AddArtifactOutput"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ], - "documentation":"

Uploads an artifact to an agent space. Artifacts provide additional context for security testing, such as architecture diagrams, API specifications, or configuration files.

" - }, - "BatchCreateSecurityRequirements":{ - "name":"BatchCreateSecurityRequirements", - "http":{ - "method":"POST", - "requestUri":"/BatchCreateSecurityRequirements", - "responseCode":201 - }, - "input":{"shape":"BatchCreateSecurityRequirementsInput"}, - "output":{"shape":"BatchCreateSecurityRequirementsOutput"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ServiceQuotaExceededException"} - ], - "documentation":"

Batch creates security requirements in a customer managed pack.

" - }, - "BatchDeleteCodeReviews":{ - "name":"BatchDeleteCodeReviews", - "http":{ - "method":"POST", - "requestUri":"/BatchDeleteCodeReviews", - "responseCode":200 - }, - "input":{"shape":"BatchDeleteCodeReviewsInput"}, - "output":{"shape":"BatchDeleteCodeReviewsOutput"}, - "documentation":"

Deletes one or more code reviews from an agent space.

" - }, - "BatchDeletePentests":{ - "name":"BatchDeletePentests", - "http":{ - "method":"POST", - "requestUri":"/BatchDeletePentests", - "responseCode":200 - }, - "input":{"shape":"BatchDeletePentestsInput"}, - "output":{"shape":"BatchDeletePentestsOutput"}, - "documentation":"

Deletes one or more pentests from an agent space.

" - }, - "BatchDeleteSecurityRequirements":{ - "name":"BatchDeleteSecurityRequirements", - "http":{ - "method":"POST", - "requestUri":"/BatchDeleteSecurityRequirements", - "responseCode":200 - }, - "input":{"shape":"BatchDeleteSecurityRequirementsInput"}, - "output":{"shape":"BatchDeleteSecurityRequirementsOutput"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ], - "documentation":"

Batch deletes security requirements from a customer managed pack.

" - }, - "BatchDeleteThreatModels":{ - "name":"BatchDeleteThreatModels", - "http":{ - "method":"POST", - "requestUri":"/BatchDeleteThreatModels", - "responseCode":200 - }, - "input":{"shape":"BatchDeleteThreatModelsInput"}, - "output":{"shape":"BatchDeleteThreatModelsOutput"}, - "documentation":"

Deletes one or more threat models from an agent space.

" - }, - "BatchGetAgentSpaces":{ - "name":"BatchGetAgentSpaces", - "http":{ - "method":"POST", - "requestUri":"/BatchGetAgentSpaces", - "responseCode":200 - }, - "input":{"shape":"BatchGetAgentSpacesInput"}, - "output":{"shape":"BatchGetAgentSpacesOutput"}, - "documentation":"

Retrieves information about one or more agent spaces.

", - "readonly":true - }, - "BatchGetArtifactMetadata":{ - "name":"BatchGetArtifactMetadata", - "http":{ - "method":"POST", - "requestUri":"/BatchGetArtifactMetadata", - "responseCode":200 - }, - "input":{"shape":"BatchGetArtifactMetadataInput"}, - "output":{"shape":"BatchGetArtifactMetadataOutput"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ], - "documentation":"

Retrieves metadata for one or more artifacts in an agent space.

" - }, - "BatchGetCodeReviewJobTasks":{ - "name":"BatchGetCodeReviewJobTasks", - "http":{ - "method":"POST", - "requestUri":"/BatchGetCodeReviewJobTasks", - "responseCode":200 - }, - "input":{"shape":"BatchGetCodeReviewJobTasksInput"}, - "output":{"shape":"BatchGetCodeReviewJobTasksOutput"}, - "documentation":"

Retrieves information about one or more tasks within a code review job.

" - }, - "BatchGetCodeReviewJobs":{ - "name":"BatchGetCodeReviewJobs", - "http":{ - "method":"POST", - "requestUri":"/BatchGetCodeReviewJobs", - "responseCode":200 - }, - "input":{"shape":"BatchGetCodeReviewJobsInput"}, - "output":{"shape":"BatchGetCodeReviewJobsOutput"}, - "documentation":"

Retrieves information about one or more code review jobs in an agent space.

" - }, - "BatchGetCodeReviews":{ - "name":"BatchGetCodeReviews", - "http":{ - "method":"POST", - "requestUri":"/BatchGetCodeReviews", - "responseCode":200 - }, - "input":{"shape":"BatchGetCodeReviewsInput"}, - "output":{"shape":"BatchGetCodeReviewsOutput"}, - "documentation":"

Retrieves information about one or more code reviews in an agent space.

" - }, - "BatchGetFindings":{ - "name":"BatchGetFindings", - "http":{ - "method":"POST", - "requestUri":"/BatchGetFindings", - "responseCode":200 - }, - "input":{"shape":"BatchGetFindingsInput"}, - "output":{"shape":"BatchGetFindingsOutput"}, - "documentation":"

Retrieves information about one or more security findings in an agent space.

" - }, - "BatchGetPentestJobTasks":{ - "name":"BatchGetPentestJobTasks", - "http":{ - "method":"POST", - "requestUri":"/BatchGetPentestJobTasks", - "responseCode":200 - }, - "input":{"shape":"BatchGetPentestJobTasksInput"}, - "output":{"shape":"BatchGetPentestJobTasksOutput"}, - "documentation":"

Retrieves information about one or more tasks within a pentest job.

" - }, - "BatchGetPentestJobs":{ - "name":"BatchGetPentestJobs", - "http":{ - "method":"POST", - "requestUri":"/BatchGetPentestJobs", - "responseCode":200 - }, - "input":{"shape":"BatchGetPentestJobsInput"}, - "output":{"shape":"BatchGetPentestJobsOutput"}, - "documentation":"

Retrieves information about one or more pentest jobs in an agent space.

" - }, - "BatchGetPentests":{ - "name":"BatchGetPentests", - "http":{ - "method":"POST", - "requestUri":"/BatchGetPentests", - "responseCode":200 - }, - "input":{"shape":"BatchGetPentestsInput"}, - "output":{"shape":"BatchGetPentestsOutput"}, - "documentation":"

Retrieves information about one or more pentests in an agent space.

" - }, - "BatchGetSecurityRequirements":{ - "name":"BatchGetSecurityRequirements", - "http":{ - "method":"POST", - "requestUri":"/BatchGetSecurityRequirements", - "responseCode":200 - }, - "input":{"shape":"BatchGetSecurityRequirementsInput"}, - "output":{"shape":"BatchGetSecurityRequirementsOutput"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ], - "documentation":"

Batch retrieves security requirements from a pack.

", - "readonly":true - }, - "BatchGetTargetDomains":{ - "name":"BatchGetTargetDomains", - "http":{ - "method":"POST", - "requestUri":"/BatchGetTargetDomains", - "responseCode":200 - }, - "input":{"shape":"BatchGetTargetDomainsInput"}, - "output":{"shape":"BatchGetTargetDomainsOutput"}, - "documentation":"

Retrieves information about one or more target domains.

", - "readonly":true - }, - "BatchGetThreatModelJobTasks":{ - "name":"BatchGetThreatModelJobTasks", - "http":{ - "method":"POST", - "requestUri":"/BatchGetThreatModelJobTasks", - "responseCode":200 - }, - "input":{"shape":"BatchGetThreatModelJobTasksInput"}, - "output":{"shape":"BatchGetThreatModelJobTasksOutput"}, - "documentation":"

Retrieves information about one or more tasks within a threat model job.

", - "readonly":true - }, - "BatchGetThreatModelJobs":{ - "name":"BatchGetThreatModelJobs", - "http":{ - "method":"POST", - "requestUri":"/BatchGetThreatModelJobs", - "responseCode":200 - }, - "input":{"shape":"BatchGetThreatModelJobsInput"}, - "output":{"shape":"BatchGetThreatModelJobsOutput"}, - "documentation":"

Retrieves information about one or more threat model jobs in an agent space.

" - }, - "BatchGetThreatModels":{ - "name":"BatchGetThreatModels", - "http":{ - "method":"POST", - "requestUri":"/BatchGetThreatModels", - "responseCode":200 - }, - "input":{"shape":"BatchGetThreatModelsInput"}, - "output":{"shape":"BatchGetThreatModelsOutput"}, - "documentation":"

Retrieves information about one or more threat models in an agent space.

" - }, - "BatchGetThreats":{ - "name":"BatchGetThreats", - "http":{ - "method":"POST", - "requestUri":"/BatchGetThreats", - "responseCode":200 - }, - "input":{"shape":"BatchGetThreatsInput"}, - "output":{"shape":"BatchGetThreatsOutput"}, - "documentation":"

Retrieves information about one or more threats.

" - }, - "BatchUpdateSecurityRequirements":{ - "name":"BatchUpdateSecurityRequirements", - "http":{ - "method":"POST", - "requestUri":"/BatchUpdateSecurityRequirements", - "responseCode":200 - }, - "input":{"shape":"BatchUpdateSecurityRequirementsInput"}, - "output":{"shape":"BatchUpdateSecurityRequirementsOutput"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ], - "documentation":"

Batch updates security requirements within a customer managed pack.

" - }, - "CreateAgentSpace":{ - "name":"CreateAgentSpace", - "http":{ - "method":"POST", - "requestUri":"/CreateAgentSpace", - "responseCode":200 - }, - "input":{"shape":"CreateAgentSpaceInput"}, - "output":{"shape":"CreateAgentSpaceOutput"}, - "documentation":"

Creates a new agent space. An agent space is a dedicated workspace for securing a specific application.

" - }, - "CreateApplication":{ - "name":"CreateApplication", - "http":{ - "method":"POST", - "requestUri":"/CreateApplication", - "responseCode":200 - }, - "input":{"shape":"CreateApplicationRequest"}, - "output":{"shape":"CreateApplicationResponse"}, - "documentation":"

Creates a new application. An application is the top-level organizational unit that supports IAM Identity Center integration.

" - }, - "CreateCodeReview":{ - "name":"CreateCodeReview", - "http":{ - "method":"POST", - "requestUri":"/CreateCodeReview", - "responseCode":200 - }, - "input":{"shape":"CreateCodeReviewInput"}, - "output":{"shape":"CreateCodeReviewOutput"}, - "documentation":"

Creates a new code review configuration in an agent space. A code review defines the parameters for automated security-focused code analysis.

" - }, - "CreateIntegration":{ - "name":"CreateIntegration", - "http":{ - "method":"POST", - "requestUri":"/CreateIntegration", - "responseCode":201 - }, - "input":{"shape":"CreateIntegrationInput"}, - "output":{"shape":"CreateIntegrationOutput"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ], - "documentation":"

Creates a new integration with a third-party provider, such as GitHub, for code review and remediation.

" - }, - "CreateMembership":{ - "name":"CreateMembership", - "http":{ - "method":"POST", - "requestUri":"/CreateMembership", - "responseCode":200 - }, - "input":{"shape":"CreateMembershipRequest"}, - "output":{"shape":"CreateMembershipResponse"}, - "documentation":"

Creates a new membership, granting a user access to an agent space within an application.

" - }, - "CreatePentest":{ - "name":"CreatePentest", - "http":{ - "method":"POST", - "requestUri":"/CreatePentest", - "responseCode":200 - }, - "input":{"shape":"CreatePentestInput"}, - "output":{"shape":"CreatePentestOutput"}, - "documentation":"

Creates a new pentest configuration in an agent space. A pentest defines the security test parameters, including target assets, risk type exclusions, and logging configuration.

" - }, - "CreatePrivateConnection":{ - "name":"CreatePrivateConnection", - "http":{ - "method":"POST", - "requestUri":"/CreatePrivateConnection", - "responseCode":201 - }, - "input":{"shape":"CreatePrivateConnectionInput"}, - "output":{"shape":"CreatePrivateConnectionOutput"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ], - "documentation":"

Creates a private connection for reaching a self-hosted provider instance over private networking using Amazon VPC Lattice.

" - }, - "CreateSecurityRequirementPack":{ - "name":"CreateSecurityRequirementPack", - "http":{ - "method":"POST", - "requestUri":"/CreateSecurityRequirementPack", - "responseCode":201 - }, - "input":{"shape":"CreateSecurityRequirementPackInput"}, - "output":{"shape":"CreateSecurityRequirementPackOutput"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ServiceQuotaExceededException"} - ], - "documentation":"

Creates a customer managed security requirement pack.

" - }, - "CreateTargetDomain":{ - "name":"CreateTargetDomain", - "http":{ - "method":"POST", - "requestUri":"/CreateTargetDomain", - "responseCode":200 - }, - "input":{"shape":"CreateTargetDomainInput"}, - "output":{"shape":"CreateTargetDomainOutput"}, - "documentation":"

Creates a new target domain for penetration testing. A target domain is a web domain that must be registered and verified before it can be tested.

" - }, - "CreateThreat":{ - "name":"CreateThreat", - "http":{ - "method":"POST", - "requestUri":"/CreateThreat", - "responseCode":200 - }, - "input":{"shape":"CreateThreatInput"}, - "output":{"shape":"CreateThreatOutput"}, - "documentation":"

Creates a new threat under a threat model job.

" - }, - "CreateThreatModel":{ - "name":"CreateThreatModel", - "http":{ - "method":"POST", - "requestUri":"/CreateThreatModel", - "responseCode":200 - }, - "input":{"shape":"CreateThreatModelInput"}, - "output":{"shape":"CreateThreatModelOutput"}, - "documentation":"

Creates a new threat model configuration in an agent space. A threat model defines the parameters for automated threat analysis.

" - }, - "DeleteAgentSpace":{ - "name":"DeleteAgentSpace", - "http":{ - "method":"POST", - "requestUri":"/DeleteAgentSpace", - "responseCode":200 - }, - "input":{"shape":"DeleteAgentSpaceInput"}, - "output":{"shape":"DeleteAgentSpaceOutput"}, - "documentation":"

Deletes an agent space and all of its associated resources, including pentests, findings, and artifacts.

", - "idempotent":true - }, - "DeleteApplication":{ - "name":"DeleteApplication", - "http":{ - "method":"POST", - "requestUri":"/DeleteApplication", - "responseCode":200 - }, - "input":{"shape":"DeleteApplicationRequest"}, - "documentation":"

Deletes an application and its associated configuration, including IAM Identity Center settings.

", - "idempotent":true - }, - "DeleteArtifact":{ - "name":"DeleteArtifact", - "http":{ - "method":"POST", - "requestUri":"/DeleteArtifact", - "responseCode":200 - }, - "input":{"shape":"DeleteArtifactInput"}, - "output":{"shape":"DeleteArtifactOutput"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ], - "documentation":"

Deletes an artifact from an agent space.

" - }, - "DeleteIntegration":{ - "name":"DeleteIntegration", - "http":{ - "method":"POST", - "requestUri":"/DeleteIntegration", - "responseCode":200 - }, - "input":{"shape":"DeleteIntegrationInput"}, - "output":{"shape":"DeleteIntegrationOutput"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ], - "documentation":"

Deletes an integration with a third-party provider.

", - "idempotent":true - }, - "DeleteMembership":{ - "name":"DeleteMembership", - "http":{ - "method":"POST", - "requestUri":"/DeleteMembership", - "responseCode":200 - }, - "input":{"shape":"DeleteMembershipRequest"}, - "output":{"shape":"DeleteMembershipResponse"}, - "documentation":"

Deletes a membership, revoking a user's access to an agent space.

" - }, - "DeletePrivateConnection":{ - "name":"DeletePrivateConnection", - "http":{ - "method":"POST", - "requestUri":"/DeletePrivateConnection", - "responseCode":200 - }, - "input":{"shape":"DeletePrivateConnectionInput"}, - "output":{"shape":"DeletePrivateConnectionOutput"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ], - "documentation":"

Deletes a private connection.

", - "idempotent":true - }, - "DeleteSecurityRequirementPack":{ - "name":"DeleteSecurityRequirementPack", - "http":{ - "method":"POST", - "requestUri":"/DeleteSecurityRequirementPack", - "responseCode":200 - }, - "input":{"shape":"DeleteSecurityRequirementPackInput"}, - "output":{"shape":"DeleteSecurityRequirementPackOutput"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ], - "documentation":"

Deletes a customer managed security requirement pack and all its associated security requirements.

", - "idempotent":true - }, - "DeleteTargetDomain":{ - "name":"DeleteTargetDomain", - "http":{ - "method":"POST", - "requestUri":"/DeleteTargetDomain", - "responseCode":200 - }, - "input":{"shape":"DeleteTargetDomainInput"}, - "output":{"shape":"DeleteTargetDomainOutput"}, - "documentation":"

Deletes a target domain registration. After deletion, the domain can no longer be used for penetration testing.

", - "idempotent":true - }, - "DescribePrivateConnection":{ - "name":"DescribePrivateConnection", - "http":{ - "method":"POST", - "requestUri":"/DescribePrivateConnection", - "responseCode":200 - }, - "input":{"shape":"DescribePrivateConnectionInput"}, - "output":{"shape":"DescribePrivateConnectionOutput"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ], - "documentation":"

Retrieves the details of a private connection.

", - "readonly":true - }, - "GetApplication":{ - "name":"GetApplication", - "http":{ - "method":"POST", - "requestUri":"/GetApplication", - "responseCode":200 - }, - "input":{"shape":"GetApplicationRequest"}, - "output":{"shape":"GetApplicationResponse"}, - "documentation":"

Retrieves information about an application.

", - "readonly":true - }, - "GetArtifact":{ - "name":"GetArtifact", - "http":{ - "method":"POST", - "requestUri":"/GetArtifact", - "responseCode":200 - }, - "input":{"shape":"GetArtifactInput"}, - "output":{"shape":"GetArtifactOutput"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ], - "documentation":"

Retrieves an artifact from an agent space.

" - }, - "GetIntegration":{ - "name":"GetIntegration", - "http":{ - "method":"POST", - "requestUri":"/GetIntegration", - "responseCode":200 - }, - "input":{"shape":"GetIntegrationInput"}, - "output":{"shape":"GetIntegrationOutput"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ], - "documentation":"

Retrieves information about an integration.

", - "readonly":true - }, - "GetSecurityRequirementPack":{ - "name":"GetSecurityRequirementPack", - "http":{ - "method":"POST", - "requestUri":"/GetSecurityRequirementPack", - "responseCode":200 - }, - "input":{"shape":"GetSecurityRequirementPackInput"}, - "output":{"shape":"GetSecurityRequirementPackOutput"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ], - "documentation":"

Retrieves information about a security requirement pack.

", - "readonly":true - }, - "ImportSecurityRequirements":{ - "name":"ImportSecurityRequirements", - "http":{ - "method":"POST", - "requestUri":"/ImportSecurityRequirements", - "responseCode":201 - }, - "input":{"shape":"ImportSecurityRequirementsInput"}, - "output":{"shape":"ImportSecurityRequirementsOutput"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ServiceQuotaExceededException"} - ], - "documentation":"

Imports security requirements from uploaded documents into a customer managed security requirement pack. The import process asynchronously extracts and generates structured security requirements from the provided source files.

" - }, - "InitiateProviderRegistration":{ - "name":"InitiateProviderRegistration", - "http":{ - "method":"POST", - "requestUri":"/oauth2/provider/register", - "responseCode":200 - }, - "input":{"shape":"InitiateProviderRegistrationInput"}, - "output":{"shape":"InitiateProviderRegistrationOutput"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ], - "documentation":"

Initiates the OAuth registration flow with a third-party provider. Returns a redirect URL and CSRF state token for completing the authorization.

" - }, - "ListAgentSpaces":{ - "name":"ListAgentSpaces", - "http":{ - "method":"POST", - "requestUri":"/ListAgentSpaces", - "responseCode":200 - }, - "input":{"shape":"ListAgentSpacesInput"}, - "output":{"shape":"ListAgentSpacesOutput"}, - "documentation":"

Returns a paginated list of agent space summaries in your account.

", - "readonly":true - }, - "ListApplications":{ - "name":"ListApplications", - "http":{ - "method":"POST", - "requestUri":"/ListApplications", - "responseCode":200 - }, - "input":{"shape":"ListApplicationsRequest"}, - "output":{"shape":"ListApplicationsResponse"}, - "documentation":"

Returns a paginated list of application summaries in your account.

", - "readonly":true - }, - "ListArtifacts":{ - "name":"ListArtifacts", - "http":{ - "method":"POST", - "requestUri":"/ListArtifacts", - "responseCode":200 - }, - "input":{"shape":"ListArtifactsInput"}, - "output":{"shape":"ListArtifactsOutput"}, - "errors":[ - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ], - "documentation":"

Returns a paginated list of artifact summaries for the specified agent space.

", - "readonly":true - }, - "ListCodeReviewJobTasks":{ - "name":"ListCodeReviewJobTasks", - "http":{ - "method":"POST", - "requestUri":"/ListCodeReviewJobTasks", - "responseCode":200 - }, - "input":{"shape":"ListCodeReviewJobTasksInput"}, - "output":{"shape":"ListCodeReviewJobTasksOutput"}, - "documentation":"

Returns a paginated list of task summaries for the specified code review job, optionally filtered by step name or category.

" - }, - "ListCodeReviewJobsForCodeReview":{ - "name":"ListCodeReviewJobsForCodeReview", - "http":{ - "method":"POST", - "requestUri":"/ListCodeReviewJobsForCodeReview", - "responseCode":200 - }, - "input":{"shape":"ListCodeReviewJobsForCodeReviewInput"}, - "output":{"shape":"ListCodeReviewJobsForCodeReviewOutput"}, - "documentation":"

Returns a paginated list of code review job summaries for the specified code review configuration.

" - }, - "ListCodeReviews":{ - "name":"ListCodeReviews", - "http":{ - "method":"POST", - "requestUri":"/ListCodeReviews", - "responseCode":200 - }, - "input":{"shape":"ListCodeReviewsInput"}, - "output":{"shape":"ListCodeReviewsOutput"}, - "documentation":"

Returns a paginated list of code review summaries for the specified agent space.

" - }, - "ListDiscoveredEndpoints":{ - "name":"ListDiscoveredEndpoints", - "http":{ - "method":"POST", - "requestUri":"/ListDiscoveredEndpoints", - "responseCode":200 - }, - "input":{"shape":"ListDiscoveredEndpointsInput"}, - "output":{"shape":"ListDiscoveredEndpointsOutput"}, - "documentation":"

Returns a paginated list of endpoints discovered during a pentest job execution.

" - }, - "ListFindings":{ - "name":"ListFindings", - "http":{ - "method":"POST", - "requestUri":"/ListFindings", - "responseCode":200 - }, - "input":{"shape":"ListFindingsInput"}, - "output":{"shape":"ListFindingsOutput"}, - "documentation":"

Lists the security findings for a pentest job.

" - }, - "ListIntegratedResources":{ - "name":"ListIntegratedResources", - "http":{ - "method":"POST", - "requestUri":"/ListIntegratedResources", - "responseCode":200 - }, - "input":{"shape":"ListIntegratedResourcesInput"}, - "output":{"shape":"ListIntegratedResourcesOutput"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ], - "documentation":"

Lists the integrated resources for an agent space, optionally filtered by integration or resource type.

" - }, - "ListIntegrations":{ - "name":"ListIntegrations", - "http":{ - "method":"POST", - "requestUri":"/ListIntegrations", - "responseCode":200 - }, - "input":{"shape":"ListIntegrationsInput"}, - "output":{"shape":"ListIntegrationsOutput"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ], - "documentation":"

Lists the integrations in your account, optionally filtered by provider or provider type.

", - "readonly":true - }, - "ListMemberships":{ - "name":"ListMemberships", - "http":{ - "method":"POST", - "requestUri":"/ListMemberships", - "responseCode":200 - }, - "input":{"shape":"ListMembershipsRequest"}, - "output":{"shape":"ListMembershipsResponse"}, - "documentation":"

Returns a paginated list of membership summaries for the specified agent space within an application.

" - }, - "ListPentestJobTasks":{ - "name":"ListPentestJobTasks", - "http":{ - "method":"POST", - "requestUri":"/ListPentestJobTasks", - "responseCode":200 - }, - "input":{"shape":"ListPentestJobTasksInput"}, - "output":{"shape":"ListPentestJobTasksOutput"}, - "documentation":"

Returns a paginated list of task summaries for the specified pentest job, optionally filtered by step name or category.

" - }, - "ListPentestJobsForPentest":{ - "name":"ListPentestJobsForPentest", - "http":{ - "method":"POST", - "requestUri":"/ListPentestJobsForPentest", - "responseCode":200 - }, - "input":{"shape":"ListPentestJobsForPentestInput"}, - "output":{"shape":"ListPentestJobsForPentestOutput"}, - "documentation":"

Returns a paginated list of pentest job summaries for the specified pentest configuration.

" - }, - "ListPentests":{ - "name":"ListPentests", - "http":{ - "method":"POST", - "requestUri":"/ListPentests", - "responseCode":200 - }, - "input":{"shape":"ListPentestsInput"}, - "output":{"shape":"ListPentestsOutput"}, - "documentation":"

Returns a paginated list of pentest summaries for the specified agent space.

" - }, - "ListPrivateConnections":{ - "name":"ListPrivateConnections", - "http":{ - "method":"POST", - "requestUri":"/ListPrivateConnections", - "responseCode":200 - }, - "input":{"shape":"ListPrivateConnectionsInput"}, - "output":{"shape":"ListPrivateConnectionsOutput"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ], - "documentation":"

Lists the private connections in your account.

", - "readonly":true - }, - "ListSecurityRequirementPacks":{ - "name":"ListSecurityRequirementPacks", - "http":{ - "method":"POST", - "requestUri":"/ListSecurityRequirementPacks", - "responseCode":200 - }, - "input":{"shape":"ListSecurityRequirementPacksInput"}, - "output":{"shape":"ListSecurityRequirementPacksOutput"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ], - "documentation":"

Lists all security requirement packs in the caller's account.

", - "readonly":true - }, - "ListSecurityRequirements":{ - "name":"ListSecurityRequirements", - "http":{ - "method":"POST", - "requestUri":"/ListSecurityRequirements", - "responseCode":200 - }, - "input":{"shape":"ListSecurityRequirementsInput"}, - "output":{"shape":"ListSecurityRequirementsOutput"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ], - "documentation":"

Lists security requirements within a pack.

", - "readonly":true - }, - "ListTagsForResource":{ - "name":"ListTagsForResource", - "http":{ - "method":"GET", - "requestUri":"/tags/{resourceArn}", - "responseCode":200 - }, - "input":{"shape":"ListTagsForResourceInput"}, - "output":{"shape":"ListTagsForResourceOutput"}, - "documentation":"

Returns the tags associated with the specified resource.

", - "readonly":true - }, - "ListTargetDomains":{ - "name":"ListTargetDomains", - "http":{ - "method":"POST", - "requestUri":"/ListTargetDomains", - "responseCode":200 - }, - "input":{"shape":"ListTargetDomainsInput"}, - "output":{"shape":"ListTargetDomainsOutput"}, - "documentation":"

Returns a paginated list of target domain summaries in your account.

", - "readonly":true - }, - "ListThreatModelJobTasks":{ - "name":"ListThreatModelJobTasks", - "http":{ - "method":"POST", - "requestUri":"/ListThreatModelJobTasks", - "responseCode":200 - }, - "input":{"shape":"ListThreatModelJobTasksInput"}, - "output":{"shape":"ListThreatModelJobTasksOutput"}, - "documentation":"

Returns a paginated list of task summaries for the specified threat model job.

", - "readonly":true - }, - "ListThreatModelJobs":{ - "name":"ListThreatModelJobs", - "http":{ - "method":"POST", - "requestUri":"/ListThreatModelJobs", - "responseCode":200 - }, - "input":{"shape":"ListThreatModelJobsInput"}, - "output":{"shape":"ListThreatModelJobsOutput"}, - "documentation":"

Returns a paginated list of threat model job summaries for the specified threat model.

", - "readonly":true - }, - "ListThreatModels":{ - "name":"ListThreatModels", - "http":{ - "method":"POST", - "requestUri":"/ListThreatModels", - "responseCode":200 - }, - "input":{"shape":"ListThreatModelsInput"}, - "output":{"shape":"ListThreatModelsOutput"}, - "documentation":"

Returns a paginated list of threat model summaries for the specified agent space.

", - "readonly":true - }, - "ListThreats":{ - "name":"ListThreats", - "http":{ - "method":"POST", - "requestUri":"/ListThreats", - "responseCode":200 - }, - "input":{"shape":"ListThreatsInput"}, - "output":{"shape":"ListThreatsOutput"}, - "documentation":"

Returns a paginated list of threats for a threat model job.

", - "readonly":true - }, - "StartCodeRemediation":{ - "name":"StartCodeRemediation", - "http":{ - "method":"POST", - "requestUri":"/StartCodeRemediation", - "responseCode":200 - }, - "input":{"shape":"StartCodeRemediationInput"}, - "output":{"shape":"StartCodeRemediationOutput"}, - "documentation":"

Initiates code remediation for one or more security findings. This creates pull requests in integrated repositories to fix the identified vulnerabilities.

" - }, - "StartCodeReviewJob":{ - "name":"StartCodeReviewJob", - "http":{ - "method":"POST", - "requestUri":"/StartCodeReviewJob", - "responseCode":200 - }, - "input":{"shape":"StartCodeReviewJobInput"}, - "output":{"shape":"StartCodeReviewJobOutput"}, - "documentation":"

Starts a new code review job for a code review configuration. The job executes the security-focused code analysis defined in the code review.

" - }, - "StartPentestJob":{ - "name":"StartPentestJob", - "http":{ - "method":"POST", - "requestUri":"/StartPentestJob", - "responseCode":200 - }, - "input":{"shape":"StartPentestJobInput"}, - "output":{"shape":"StartPentestJobOutput"}, - "documentation":"

Starts a new pentest job for a pentest configuration. The job executes the security tests defined in the pentest.

" - }, - "StartThreatModelJob":{ - "name":"StartThreatModelJob", - "http":{ - "method":"POST", - "requestUri":"/StartThreatModelJob", - "responseCode":200 - }, - "input":{"shape":"StartThreatModelJobInput"}, - "output":{"shape":"StartThreatModelJobOutput"}, - "documentation":"

Starts a new threat model job for a threat model configuration.

" - }, - "StopCodeReviewJob":{ - "name":"StopCodeReviewJob", - "http":{ - "method":"POST", - "requestUri":"/StopCodeReviewJob", - "responseCode":200 - }, - "input":{"shape":"StopCodeReviewJobInput"}, - "output":{"shape":"StopCodeReviewJobOutput"}, - "documentation":"

Stops a running code review job. The job transitions to a stopping state and then to stopped after cleanup completes.

" - }, - "StopPentestJob":{ - "name":"StopPentestJob", - "http":{ - "method":"POST", - "requestUri":"/StopPentestJob", - "responseCode":200 - }, - "input":{"shape":"StopPentestJobInput"}, - "output":{"shape":"StopPentestJobOutput"}, - "documentation":"

Stops a running pentest job. The job transitions to a stopping state and then to stopped after cleanup completes.

" - }, - "StopThreatModelJob":{ - "name":"StopThreatModelJob", - "http":{ - "method":"POST", - "requestUri":"/StopThreatModelJob", - "responseCode":200 - }, - "input":{"shape":"StopThreatModelJobInput"}, - "output":{"shape":"StopThreatModelJobOutput"}, - "documentation":"

Stops a running threat model job.

" - }, - "TagResource":{ - "name":"TagResource", - "http":{ - "method":"POST", - "requestUri":"/tags/{resourceArn}", - "responseCode":204 - }, - "input":{"shape":"TagResourceInput"}, - "output":{"shape":"TagResourceOutput"}, - "documentation":"

Adds tags to a resource.

" - }, - "UntagResource":{ - "name":"UntagResource", - "http":{ - "method":"DELETE", - "requestUri":"/tags/{resourceArn}", - "responseCode":204 - }, - "input":{"shape":"UntagResourceInput"}, - "output":{"shape":"UntagResourceOutput"}, - "documentation":"

Removes tags from a resource.

", - "idempotent":true - }, - "UpdateAgentSpace":{ - "name":"UpdateAgentSpace", - "http":{ - "method":"POST", - "requestUri":"/UpdateAgentSpace", - "responseCode":200 - }, - "input":{"shape":"UpdateAgentSpaceInput"}, - "output":{"shape":"UpdateAgentSpaceOutput"}, - "documentation":"

Updates the configuration of an existing agent space, including its name, description, AWS resources, target domains, and code review settings.

" - }, - "UpdateApplication":{ - "name":"UpdateApplication", - "http":{ - "method":"POST", - "requestUri":"/UpdateApplication", - "responseCode":200 - }, - "input":{"shape":"UpdateApplicationRequest"}, - "output":{"shape":"UpdateApplicationResponse"}, - "documentation":"

Updates the configuration of an existing application, including the IAM role and default KMS key.

", - "idempotent":true - }, - "UpdateCodeReview":{ - "name":"UpdateCodeReview", - "http":{ - "method":"POST", - "requestUri":"/UpdateCodeReview", - "responseCode":200 - }, - "input":{"shape":"UpdateCodeReviewInput"}, - "output":{"shape":"UpdateCodeReviewOutput"}, - "documentation":"

Updates an existing code review configuration.

" - }, - "UpdateFinding":{ - "name":"UpdateFinding", - "http":{ - "method":"POST", - "requestUri":"/UpdateFinding", - "responseCode":200 - }, - "input":{"shape":"UpdateFindingInput"}, - "output":{"shape":"UpdateFindingOutput"}, - "documentation":"

Updates the status or risk level of a security finding.

" - }, - "UpdateIntegratedResources":{ - "name":"UpdateIntegratedResources", - "http":{ - "method":"POST", - "requestUri":"/UpdateIntegratedResources", - "responseCode":200 - }, - "input":{"shape":"UpdateIntegratedResourcesInput"}, - "output":{"shape":"UpdateIntegratedResourcesOutput"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ], - "documentation":"

Updates the integrated resources for an agent space, including their capabilities.

" - }, - "UpdatePentest":{ - "name":"UpdatePentest", - "http":{ - "method":"POST", - "requestUri":"/UpdatePentest", - "responseCode":200 - }, - "input":{"shape":"UpdatePentestInput"}, - "output":{"shape":"UpdatePentestOutput"}, - "documentation":"

Updates an existing pentest configuration.

" - }, - "UpdatePrivateConnectionCertificate":{ - "name":"UpdatePrivateConnectionCertificate", - "http":{ - "method":"POST", - "requestUri":"/UpdatePrivateConnectionCertificate", - "responseCode":200 - }, - "input":{"shape":"UpdatePrivateConnectionCertificateInput"}, - "output":{"shape":"UpdatePrivateConnectionCertificateOutput"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ], - "documentation":"

Updates the certificate associated with a private connection. Certificates can be added or replaced but not removed.

" - }, - "UpdateSecurityRequirementPack":{ - "name":"UpdateSecurityRequirementPack", - "http":{ - "method":"POST", - "requestUri":"/UpdateSecurityRequirementPack", - "responseCode":200 - }, - "input":{"shape":"UpdateSecurityRequirementPackInput"}, - "output":{"shape":"UpdateSecurityRequirementPackOutput"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} - ], - "documentation":"

Updates a security requirement pack. For customer managed packs, both metadata and status can be updated. For AWS managed packs, only status can be updated.

" - }, - "UpdateTargetDomain":{ - "name":"UpdateTargetDomain", - "http":{ - "method":"POST", - "requestUri":"/UpdateTargetDomain", - "responseCode":200 - }, - "input":{"shape":"UpdateTargetDomainInput"}, - "output":{"shape":"UpdateTargetDomainOutput"}, - "documentation":"

Updates the verification method for a target domain.

" - }, - "UpdateThreat":{ - "name":"UpdateThreat", - "http":{ - "method":"POST", - "requestUri":"/UpdateThreat", - "responseCode":200 - }, - "input":{"shape":"UpdateThreatInput"}, - "output":{"shape":"UpdateThreatOutput"}, - "documentation":"

Updates a threat.

" - }, - "UpdateThreatModel":{ - "name":"UpdateThreatModel", - "http":{ - "method":"POST", - "requestUri":"/UpdateThreatModel", - "responseCode":200 - }, - "input":{"shape":"UpdateThreatModelInput"}, - "output":{"shape":"UpdateThreatModelOutput"}, - "documentation":"

Updates an existing threat model configuration.

" - }, - "VerifyTargetDomain":{ - "name":"VerifyTargetDomain", - "http":{ - "method":"POST", - "requestUri":"/VerifyTargetDomain", - "responseCode":200 - }, - "input":{"shape":"VerifyTargetDomainInput"}, - "output":{"shape":"VerifyTargetDomainOutput"}, - "documentation":"

Initiates verification of a target domain. This checks whether the domain ownership verification token has been properly configured.

" - } - }, - "shapes":{ - "AWSResources":{ - "type":"structure", - "members":{ - "vpcs":{ - "shape":"VpcConfigs", - "documentation":"

The VPC configurations associated with the agent space.

" - }, - "logGroups":{ - "shape":"LogGroupArns", - "documentation":"

The Amazon Resource Names (ARNs) of the CloudWatch log groups associated with the agent space.

" - }, - "s3Buckets":{ - "shape":"S3BucketArns", - "documentation":"

The Amazon Resource Names (ARNs) of the S3 buckets associated with the agent space.

" - }, - "secretArns":{ - "shape":"SecretArns", - "documentation":"

The Amazon Resource Names (ARNs) of the Secrets Manager secrets associated with the agent space.

" - }, - "lambdaFunctionArns":{ - "shape":"LambdaFunctionArns", - "documentation":"

The Amazon Resource Names (ARNs) of the Lambda functions associated with the agent space.

" - }, - "iamRoles":{ - "shape":"IamRoles", - "documentation":"

The IAM roles associated with the agent space.

" - } - }, - "documentation":"

The AWS resources associated with an agent space, including VPCs, log groups, S3 buckets, secrets, Lambda functions, and IAM roles.

" - }, - "AccessDeniedException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{ - "shape":"String", - "documentation":"

Error description.

" - } - }, - "documentation":"

You do not have sufficient access to perform this action.

", - "error":{ - "httpStatusCode":403, - "senderFault":true - }, - "exception":true - }, - "AccessToken":{ - "type":"string", - "documentation":"

A GitLab access token used to authenticate with the provider.

", - "sensitive":true - }, - "AccessType":{ - "type":"string", - "documentation":"

Defines the visibility level of provider resources. PRIVATE indicates restricted access, while PUBLIC indicates open access.

", - "enum":[ - "PRIVATE", - "PUBLIC" - ] - }, - "Actor":{ - "type":"structure", - "members":{ - "identifier":{ - "shape":"String", - "documentation":"

The unique identifier for the actor.

" - }, - "uris":{ - "shape":"UriList", - "documentation":"

The list of URIs that the actor targets during testing.

" - }, - "authentication":{ - "shape":"Authentication", - "documentation":"

The authentication configuration for the actor.

" - }, - "description":{ - "shape":"String", - "documentation":"

A description of the actor.

" - } - }, - "documentation":"

Represents an actor used during penetration testing. An actor defines a user or entity that interacts with the target application, including authentication credentials and target URIs.

" - }, - "ActorList":{ - "type":"list", - "member":{"shape":"Actor"} - }, - "AddArtifactInput":{ - "type":"structure", - "required":[ - "agentSpaceId", - "artifactContent", - "artifactType", - "fileName" - ], - "members":{ - "agentSpaceId":{ - "shape":"AgentSpaceId", - "documentation":"

The unique identifier of the agent space to add the artifact to.

" - }, - "artifactContent":{ - "shape":"Blob", - "documentation":"

The binary content of the artifact to upload.

" - }, - "artifactType":{ - "shape":"ArtifactType", - "documentation":"

The file type of the artifact. Valid values include TXT, PNG, JPEG, MD, PDF, DOCX, DOC, JSON, and YAML.

" - }, - "fileName":{ - "shape":"String", - "documentation":"

The file name of the artifact.

" - } - } - }, - "AddArtifactOutput":{ - "type":"structure", - "required":["artifactId"], - "members":{ - "artifactId":{ - "shape":"ArtifactId", - "documentation":"

The unique identifier assigned to the uploaded artifact.

" - } - } - }, - "AgentName":{ - "type":"string", - "documentation":"

Name of an agent space.

" - }, - "AgentSpace":{ - "type":"structure", - "required":[ - "agentSpaceId", - "name" - ], - "members":{ - "agentSpaceId":{ - "shape":"AgentSpaceId", - "documentation":"

The unique identifier of the agent space.

" - }, - "name":{ - "shape":"String", - "documentation":"

The name of the agent space.

" - }, - "description":{ - "shape":"String", - "documentation":"

A description of the agent space.

" - }, - "awsResources":{ - "shape":"AWSResources", - "documentation":"

The AWS resources associated with the agent space.

" - }, - "targetDomainIds":{ - "shape":"TargetDomainIdList", - "documentation":"

The list of target domain identifiers associated with the agent space.

" - }, - "codeReviewSettings":{ - "shape":"CodeReviewSettings", - "documentation":"

The code review settings for the agent space.

" - }, - "kmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The identifier of the AWS KMS key used to encrypt data in the agent space.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the agent space was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the agent space was last updated, in UTC format.

" - } - }, - "documentation":"

Represents an agent space, which is a dedicated workspace for securing a specific application. An agent space contains the configuration, resources, and settings needed for security testing.

" - }, - "AgentSpaceId":{ - "type":"string", - "documentation":"

Unique identifier of the agent space.

" - }, - "AgentSpaceIdList":{ - "type":"list", - "member":{"shape":"AgentSpaceId"} - }, - "AgentSpaceList":{ - "type":"list", - "member":{"shape":"AgentSpace"} - }, - "AgentSpaceSummary":{ - "type":"structure", - "required":[ - "agentSpaceId", - "name" - ], - "members":{ - "agentSpaceId":{ - "shape":"AgentSpaceId", - "documentation":"

The unique identifier of the agent space.

" - }, - "name":{ - "shape":"String", - "documentation":"

The name of the agent space.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the agent space was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the agent space was last updated, in UTC format.

" - } - }, - "documentation":"

Contains summary information about an agent space.

" - }, - "AgentSpaceSummaryList":{ - "type":"list", - "member":{"shape":"AgentSpaceSummary"} - }, - "ApplicationDomain":{ - "type":"string", - "documentation":"

Domain where the application is available.

" - }, - "ApplicationId":{ - "type":"string", - "documentation":"

Application identifier.

" - }, - "ApplicationSummary":{ - "type":"structure", - "required":[ - "applicationId", - "applicationName", - "domain" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "documentation":"

The unique identifier of the application.

" - }, - "applicationName":{ - "shape":"String", - "documentation":"

The name of the application.

" - }, - "domain":{ - "shape":"ApplicationDomain", - "documentation":"

The domain associated with the application.

" - }, - "defaultKmsKeyId":{ - "shape":"DefaultKmsKeyId", - "documentation":"

The identifier of the default AWS KMS key used to encrypt data for the application.

" - } - }, - "documentation":"

Contains summary information about an application.

" - }, - "ApplicationSummaryList":{ - "type":"list", - "member":{"shape":"ApplicationSummary"}, - "documentation":"

List of application summaries.

" - }, - "Artifact":{ - "type":"structure", - "required":[ - "contents", - "type" - ], - "members":{ - "contents":{ - "shape":"String", - "documentation":"

The content of the artifact.

" - }, - "type":{ - "shape":"ArtifactType", - "documentation":"

The file type of the artifact.

" - } - }, - "documentation":"

Represents an artifact that provides context for security testing, such as documentation, diagrams, or configuration files.

" - }, - "ArtifactId":{ - "type":"string", - "documentation":"

The id of the artifact.

" - }, - "ArtifactIds":{ - "type":"list", - "member":{"shape":"ArtifactId"} - }, - "ArtifactMetadataItem":{ - "type":"structure", - "required":[ - "agentSpaceId", - "artifactId", - "fileName", - "updatedAt" - ], - "members":{ - "agentSpaceId":{ - "shape":"AgentSpaceId", - "documentation":"

The unique identifier of the agent space that contains the artifact.

" - }, - "artifactId":{ - "shape":"ArtifactId", - "documentation":"

The unique identifier of the artifact.

" - }, - "fileName":{ - "shape":"String", - "documentation":"

The file name of the artifact.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the artifact was last updated, in UTC format.

" - } - }, - "documentation":"

Contains metadata about an artifact.

" - }, - "ArtifactMetadataList":{ - "type":"list", - "member":{"shape":"ArtifactMetadataItem"}, - "documentation":"

List of metadata objects containing artifacts details.

" - }, - "ArtifactSummary":{ - "type":"structure", - "required":[ - "artifactId", - "fileName", - "artifactType" - ], - "members":{ - "artifactId":{ - "shape":"ArtifactId", - "documentation":"

The unique identifier of the artifact.

" - }, - "fileName":{ - "shape":"String", - "documentation":"

The file name of the artifact.

" - }, - "artifactType":{ - "shape":"ArtifactType", - "documentation":"

The file type of the artifact.

" - } - }, - "documentation":"

Contains summary information about an artifact.

" - }, - "ArtifactSummaryList":{ - "type":"list", - "member":{"shape":"ArtifactSummary"}, - "documentation":"

List of artifact summaries.

" - }, - "ArtifactType":{ - "type":"string", - "documentation":"

Supported file extension types for artifacts.

", - "enum":[ - "TXT", - "PNG", - "JPEG", - "MD", - "PDF", - "DOCX", - "DOC", - "JSON", - "YAML" - ] - }, - "Assets":{ - "type":"structure", - "members":{ - "endpoints":{ - "shape":"EndpointList", - "documentation":"

The list of endpoints to test during the pentest.

" - }, - "actors":{ - "shape":"ActorList", - "documentation":"

The list of actors used during penetration testing.

" - }, - "documents":{ - "shape":"DocumentList", - "documentation":"

The list of documents that provide context for the pentest.

" - }, - "sourceCode":{ - "shape":"SourceCodeRepositoryList", - "documentation":"

The list of source code repositories to analyze during the pentest.

" - }, - "integratedRepositories":{ - "shape":"IntegratedRepositoryList", - "documentation":"

The list of integrated repositories associated with the pentest.

" - } - }, - "documentation":"

The collection of assets used in a pentest configuration, including endpoints, actors, documents, source code repositories, and integrated repositories.

" - }, - "AuthCode":{ - "type":"string", - "documentation":"

Authorization code from OAuth flow.

" - }, - "Authentication":{ - "type":"structure", - "members":{ - "providerType":{ - "shape":"AuthenticationProviderType", - "documentation":"

The type of authentication provider. Valid values include SECRETS_MANAGER, AWS_LAMBDA, AWS_IAM_ROLE, and AWS_INTERNAL.

" - }, - "value":{ - "shape":"String", - "documentation":"

The authentication value, such as a secret ARN, Lambda function ARN, or IAM role ARN, depending on the provider type.

" - } - }, - "documentation":"

The authentication configuration for an actor, specifying the provider type and credentials.

" - }, - "AuthenticationProviderType":{ - "type":"string", - "documentation":"

Type of authentication provider.

", - "enum":[ - "SECRETS_MANAGER", - "AWS_LAMBDA", - "AWS_IAM_ROLE", - "AWS_INTERNAL" - ] - }, - "BatchCreateSecurityRequirementResult":{ - "type":"structure", - "required":[ - "packId", - "name", - "description", - "domain", - "evaluation", - "createdAt", - "updatedAt" - ], - "members":{ - "packId":{ - "shape":"SecurityRequirementPackId", - "documentation":"

The unique identifier of the pack containing the security requirement.

" - }, - "name":{ - "shape":"SecurityRequirementName", - "documentation":"

The name of the security requirement.

" - }, - "description":{ - "shape":"String", - "documentation":"

A description of the security requirement.

" - }, - "domain":{ - "shape":"String", - "documentation":"

The security domain the requirement belongs to.

" - }, - "evaluation":{ - "shape":"String", - "documentation":"

The evaluation criteria used to assess compliance with this requirement.

" - }, - "remediation":{ - "shape":"String", - "documentation":"

The recommended remediation steps when the requirement is not met.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the security requirement was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the security requirement was last updated, in UTC format.

" - } - }, - "documentation":"

Contains information about a successfully created security requirement.

" - }, - "BatchCreateSecurityRequirementResultList":{ - "type":"list", - "member":{"shape":"BatchCreateSecurityRequirementResult"}, - "documentation":"

List of successfully created security requirements.

" - }, - "BatchCreateSecurityRequirementsInput":{ - "type":"structure", - "required":[ - "packId", - "securityRequirements" - ], - "members":{ - "packId":{ - "shape":"SecurityRequirementPackId", - "documentation":"

The unique identifier of the security requirement pack to add requirements to.

" - }, - "securityRequirements":{ - "shape":"CreateSecurityRequirementEntryList", - "documentation":"

The list of security requirements to create.

" - } - } - }, - "BatchCreateSecurityRequirementsOutput":{ - "type":"structure", - "required":[ - "securityRequirements", - "errors" - ], - "members":{ - "securityRequirements":{ - "shape":"BatchCreateSecurityRequirementResultList", - "documentation":"

The list of security requirements that were successfully created.

" - }, - "errors":{ - "shape":"BatchSecurityRequirementErrors", - "documentation":"

The list of errors for security requirements that failed to be created.

" - } - } - }, - "BatchDeleteCodeReviewsInput":{ - "type":"structure", - "required":[ - "codeReviewIds", - "agentSpaceId" - ], - "members":{ - "codeReviewIds":{ - "shape":"CodeReviewIdList", - "documentation":"

The list of code review identifiers to delete.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space that contains the code reviews to delete.

" - } - }, - "documentation":"

Input for deleting multiple code reviews.

" - }, - "BatchDeleteCodeReviewsOutput":{ - "type":"structure", - "members":{ - "deleted":{ - "shape":"CodeReviewIdList", - "documentation":"

The list of identifiers of the code reviews that were successfully deleted.

" - }, - "failed":{ - "shape":"DeleteCodeReviewFailureList", - "documentation":"

The list of code reviews that failed to delete, including the reason for each failure.

" - } - }, - "documentation":"

Output for the BatchDeleteCodeReviews operation.

" - }, - "BatchDeletePentestsInput":{ - "type":"structure", - "required":[ - "pentestIds", - "agentSpaceId" - ], - "members":{ - "pentestIds":{ - "shape":"PentestIdList", - "documentation":"

The list of pentest identifiers to delete.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space that contains the pentests to delete.

" - } - }, - "documentation":"

Input for deleting multiple pentests.

" - }, - "BatchDeletePentestsOutput":{ - "type":"structure", - "members":{ - "deleted":{ - "shape":"PentestList", - "documentation":"

The list of pentests that were successfully deleted.

" - }, - "failed":{ - "shape":"DeletePentestFailureList", - "documentation":"

The list of pentests that failed to delete, including the reason for each failure.

" - } - }, - "documentation":"

Output for the BatchDeletePentests operation.

" - }, - "BatchDeleteSecurityRequirementsInput":{ - "type":"structure", - "required":[ - "packId", - "securityRequirementNames" - ], - "members":{ - "packId":{ - "shape":"SecurityRequirementPackId", - "documentation":"

The unique identifier of the security requirement pack to remove requirements from.

" - }, - "securityRequirementNames":{ - "shape":"SecurityRequirementNameList", - "documentation":"

The list of security requirement names to delete.

" - } - } - }, - "BatchDeleteSecurityRequirementsOutput":{ - "type":"structure", - "required":[ - "deletedSecurityRequirementNames", - "errors" - ], - "members":{ - "deletedSecurityRequirementNames":{ - "shape":"SecurityRequirementNameList", - "documentation":"

The list of security requirement names that were successfully deleted.

" - }, - "errors":{ - "shape":"BatchSecurityRequirementErrors", - "documentation":"

The list of errors for security requirements that failed to be deleted.

" - } - } - }, - "BatchDeleteThreatModelsInput":{ - "type":"structure", - "required":[ - "threatModelIds", - "agentSpaceId" - ], - "members":{ - "threatModelIds":{ - "shape":"ThreatModelIdList", - "documentation":"

The list of threat model identifiers to delete.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space that contains the threat models to delete.

" - } - }, - "documentation":"

Input for deleting multiple threat models.

" - }, - "BatchDeleteThreatModelsOutput":{ - "type":"structure", - "members":{ - "deleted":{ - "shape":"ThreatModelIdList", - "documentation":"

The list of threat model identifiers that were successfully deleted.

" - }, - "failed":{ - "shape":"DeleteThreatModelFailureList", - "documentation":"

The list of threat models that failed to delete, including the reason for each failure.

" - } - }, - "documentation":"

Output for the BatchDeleteThreatModels operation.

" - }, - "BatchGetAgentSpacesInput":{ - "type":"structure", - "required":["agentSpaceIds"], - "members":{ - "agentSpaceIds":{ - "shape":"AgentSpaceIdList", - "documentation":"

The list of agent space identifiers to retrieve.

" - } - }, - "documentation":"

Input for batch retrieving agent spaces.

" - }, - "BatchGetAgentSpacesOutput":{ - "type":"structure", - "members":{ - "agentSpaces":{ - "shape":"AgentSpaceList", - "documentation":"

The list of agent spaces that were found.

" - }, - "notFound":{ - "shape":"AgentSpaceIdList", - "documentation":"

The list of agent space identifiers that were not found.

" - } - }, - "documentation":"

Output for the BatchGetAgentSpaces operation.

" - }, - "BatchGetArtifactMetadataInput":{ - "type":"structure", - "required":[ - "agentSpaceId", - "artifactIds" - ], - "members":{ - "agentSpaceId":{ - "shape":"AgentSpaceId", - "documentation":"

The unique identifier of the agent space that contains the artifacts.

" - }, - "artifactIds":{ - "shape":"ArtifactIds", - "documentation":"

The list of artifact identifiers to retrieve metadata for.

" - } - } - }, - "BatchGetArtifactMetadataOutput":{ - "type":"structure", - "required":["artifactMetadataList"], - "members":{ - "artifactMetadataList":{ - "shape":"ArtifactMetadataList", - "documentation":"

The list of artifact metadata items that were found.

" - } - } - }, - "BatchGetCodeReviewJobTasksInput":{ - "type":"structure", - "required":[ - "agentSpaceId", - "codeReviewJobTaskIds" - ], - "members":{ - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space that contains the tasks.

" - }, - "codeReviewJobTaskIds":{ - "shape":"TaskIdList", - "documentation":"

The list of task identifiers to retrieve.

" - } - }, - "documentation":"

Input for retrieving multiple tasks associated with a code review job.

" - }, - "BatchGetCodeReviewJobTasksOutput":{ - "type":"structure", - "members":{ - "codeReviewJobTasks":{ - "shape":"CodeReviewJobTaskList", - "documentation":"

The list of code review job tasks that were found.

" - }, - "notFound":{ - "shape":"TaskIdList", - "documentation":"

The list of task identifiers that were not found.

" - } - }, - "documentation":"

Output for the BatchGetCodeReviewJobTasks operation.

" - }, - "BatchGetCodeReviewJobsInput":{ - "type":"structure", - "required":[ - "codeReviewJobIds", - "agentSpaceId" - ], - "members":{ - "codeReviewJobIds":{ - "shape":"CodeReviewJobIdList", - "documentation":"

The list of code review job identifiers to retrieve.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space that contains the code review jobs.

" - } - }, - "documentation":"

Input for BatchGetCodeReviewJobs operation.

" - }, - "BatchGetCodeReviewJobsOutput":{ - "type":"structure", - "members":{ - "codeReviewJobs":{ - "shape":"CodeReviewJobList", - "documentation":"

The list of code review jobs that were found.

" - }, - "notFound":{ - "shape":"CodeReviewJobIdList", - "documentation":"

The list of code review job identifiers that were not found.

" - } - }, - "documentation":"

Output for the BatchGetCodeReviewJobs operation.

" - }, - "BatchGetCodeReviewsInput":{ - "type":"structure", - "required":[ - "codeReviewIds", - "agentSpaceId" - ], - "members":{ - "codeReviewIds":{ - "shape":"CodeReviewIdList", - "documentation":"

The list of code review identifiers to retrieve.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space that contains the code reviews.

" - } - }, - "documentation":"

Input for retrieving multiple code reviews by their IDs.

" - }, - "BatchGetCodeReviewsOutput":{ - "type":"structure", - "members":{ - "codeReviews":{ - "shape":"CodeReviewList", - "documentation":"

The list of code reviews that were found.

" - }, - "notFound":{ - "shape":"CodeReviewIdList", - "documentation":"

The list of code review identifiers that were not found.

" - } - }, - "documentation":"

Output for the BatchGetCodeReviews operation.

" - }, - "BatchGetFindingsInput":{ - "type":"structure", - "required":[ - "findingIds", - "agentSpaceId" - ], - "members":{ - "findingIds":{ - "shape":"FindingIdList", - "documentation":"

The list of finding identifiers to retrieve.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space that contains the findings.

" - } - }, - "documentation":"

Input for BatchGetFindings operation.

" - }, - "BatchGetFindingsOutput":{ - "type":"structure", - "members":{ - "findings":{ - "shape":"FindingList", - "documentation":"

The list of findings that were found.

" - }, - "notFound":{ - "shape":"FindingIdList", - "documentation":"

The list of finding identifiers that were not found.

" - } - }, - "documentation":"

Output for the BatchGetFindings operation.

" - }, - "BatchGetPentestJobTasksInput":{ - "type":"structure", - "required":[ - "agentSpaceId", - "taskIds" - ], - "members":{ - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space that contains the tasks.

" - }, - "taskIds":{ - "shape":"TaskIdList", - "documentation":"

The list of task identifiers to retrieve.

" - } - }, - "documentation":"

Input for retrieving multiple tasks associated with a pentest job.

" - }, - "BatchGetPentestJobTasksOutput":{ - "type":"structure", - "members":{ - "tasks":{ - "shape":"TaskList", - "documentation":"

The list of tasks that were found.

" - }, - "notFound":{ - "shape":"TaskIdList", - "documentation":"

The list of task identifiers that were not found.

" - } - }, - "documentation":"

Output for the BatchGetPentestJobTasks operation.

" - }, - "BatchGetPentestJobsInput":{ - "type":"structure", - "required":[ - "pentestJobIds", - "agentSpaceId" - ], - "members":{ - "pentestJobIds":{ - "shape":"PentestJobIdList", - "documentation":"

The list of pentest job identifiers to retrieve.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space that contains the pentest jobs.

" - } - }, - "documentation":"

Input for BatchGetPentestJobs operation.

" - }, - "BatchGetPentestJobsOutput":{ - "type":"structure", - "members":{ - "pentestJobs":{ - "shape":"PentestJobList", - "documentation":"

The list of pentest jobs that were found.

" - }, - "notFound":{ - "shape":"PentestJobIdList", - "documentation":"

The list of pentest job identifiers that were not found.

" - } - }, - "documentation":"

Output for the BatchGetPentestJobs operation.

" - }, - "BatchGetPentestsInput":{ - "type":"structure", - "required":[ - "pentestIds", - "agentSpaceId" - ], - "members":{ - "pentestIds":{ - "shape":"PentestIdList", - "documentation":"

The list of pentest identifiers to retrieve.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space that contains the pentests.

" - } - }, - "documentation":"

Input for retrieving multiple pentests by their IDs.

" - }, - "BatchGetPentestsOutput":{ - "type":"structure", - "members":{ - "pentests":{ - "shape":"PentestList", - "documentation":"

The list of pentests that were found.

" - }, - "notFound":{ - "shape":"PentestIdList", - "documentation":"

The list of pentest identifiers that were not found.

" - } - }, - "documentation":"

Output for the BatchGetPentests operation.

" - }, - "BatchGetSecurityRequirementResult":{ - "type":"structure", - "required":[ - "packId", - "name", - "description", - "domain", - "evaluation", - "createdAt", - "updatedAt" - ], - "members":{ - "packId":{ - "shape":"SecurityRequirementPackId", - "documentation":"

The unique identifier of the pack containing the security requirement.

" - }, - "name":{ - "shape":"SecurityRequirementName", - "documentation":"

The name of the security requirement.

" - }, - "description":{ - "shape":"String", - "documentation":"

A description of the security requirement.

" - }, - "domain":{ - "shape":"String", - "documentation":"

The security domain the requirement belongs to.

" - }, - "evaluation":{ - "shape":"String", - "documentation":"

The evaluation criteria used to assess compliance with this requirement.

" - }, - "remediation":{ - "shape":"String", - "documentation":"

The recommended remediation steps when the requirement is not met.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the security requirement was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the security requirement was last updated, in UTC format.

" - } - }, - "documentation":"

Contains information about a successfully retrieved security requirement.

" - }, - "BatchGetSecurityRequirementResultList":{ - "type":"list", - "member":{"shape":"BatchGetSecurityRequirementResult"}, - "documentation":"

List of successfully retrieved security requirements.

" - }, - "BatchGetSecurityRequirementsInput":{ - "type":"structure", - "required":[ - "packId", - "securityRequirementNames" - ], - "members":{ - "packId":{ - "shape":"SecurityRequirementPackId", - "documentation":"

The unique identifier of the security requirement pack to retrieve requirements from.

" - }, - "securityRequirementNames":{ - "shape":"SecurityRequirementNameList", - "documentation":"

The list of security requirement names to retrieve.

" - } - } - }, - "BatchGetSecurityRequirementsOutput":{ - "type":"structure", - "required":[ - "securityRequirements", - "errors" - ], - "members":{ - "securityRequirements":{ - "shape":"BatchGetSecurityRequirementResultList", - "documentation":"

The list of security requirements that were successfully retrieved.

" - }, - "errors":{ - "shape":"BatchSecurityRequirementErrors", - "documentation":"

The list of errors for security requirements that failed to be retrieved.

" - } - } - }, - "BatchGetTargetDomainsInput":{ - "type":"structure", - "required":["targetDomainIds"], - "members":{ - "targetDomainIds":{ - "shape":"TargetDomainIdList", - "documentation":"

The list of target domain identifiers to retrieve.

" - } - }, - "documentation":"

Input for batch retrieving target domains.

" - }, - "BatchGetTargetDomainsOutput":{ - "type":"structure", - "members":{ - "targetDomains":{ - "shape":"TargetDomainList", - "documentation":"

The list of target domains that were found.

" - }, - "notFound":{ - "shape":"TargetDomainIdList", - "documentation":"

The list of target domain identifiers that were not found.

" - } - }, - "documentation":"

Output for the BatchGetTargetDomains operation.

" - }, - "BatchGetThreatModelJobTasksInput":{ - "type":"structure", - "required":[ - "agentSpaceId", - "threatModelJobTaskIds" - ], - "members":{ - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space that contains the tasks.

" - }, - "threatModelJobTaskIds":{ - "shape":"TaskIdList", - "documentation":"

The list of task identifiers to retrieve.

" - } - }, - "documentation":"

Input for retrieving multiple tasks associated with a threat model job.

" - }, - "BatchGetThreatModelJobTasksOutput":{ - "type":"structure", - "members":{ - "threatModelJobTasks":{ - "shape":"ThreatModelJobTaskList", - "documentation":"

The list of threat model job tasks that were found.

" - }, - "notFound":{ - "shape":"TaskIdList", - "documentation":"

The list of task identifiers that were not found.

" - } - }, - "documentation":"

Output for the BatchGetThreatModelJobTasks operation.

" - }, - "BatchGetThreatModelJobsInput":{ - "type":"structure", - "required":[ - "threatModelJobIds", - "agentSpaceId" - ], - "members":{ - "threatModelJobIds":{ - "shape":"ThreatModelJobIdList", - "documentation":"

The list of threat model job identifiers to retrieve.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space that contains the threat model jobs.

" - } - }, - "documentation":"

Input for BatchGetThreatModelJobs operation.

" - }, - "BatchGetThreatModelJobsOutput":{ - "type":"structure", - "members":{ - "threatModelJobs":{ - "shape":"ThreatModelJobList", - "documentation":"

The list of threat model jobs that were found.

" - }, - "notFound":{ - "shape":"ThreatModelJobIdList", - "documentation":"

The list of threat model job identifiers that were not found.

" - } - }, - "documentation":"

Output for the BatchGetThreatModelJobs operation.

" - }, - "BatchGetThreatModelsInput":{ - "type":"structure", - "required":[ - "threatModelIds", - "agentSpaceId" - ], - "members":{ - "threatModelIds":{ - "shape":"ThreatModelIdList", - "documentation":"

The list of threat model identifiers to retrieve.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space that contains the threat models.

" - } - }, - "documentation":"

Input for retrieving multiple threat models by their IDs.

" - }, - "BatchGetThreatModelsOutput":{ - "type":"structure", - "members":{ - "threatModels":{ - "shape":"ThreatModelList", - "documentation":"

The list of threat models that were found.

" - }, - "notFound":{ - "shape":"ThreatModelIdList", - "documentation":"

The list of threat model identifiers that were not found.

" - } - }, - "documentation":"

Output for the BatchGetThreatModels operation.

" - }, - "BatchGetThreatsInput":{ - "type":"structure", - "required":[ - "threatIds", - "agentSpaceId" - ], - "members":{ - "threatIds":{ - "shape":"ThreatIdList", - "documentation":"

The list of threat identifiers to retrieve.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space.

" - } - }, - "documentation":"

Input for retrieving multiple threats.

" - }, - "BatchGetThreatsOutput":{ - "type":"structure", - "members":{ - "threats":{ - "shape":"ThreatList", - "documentation":"

The list of threats that were found.

" - }, - "notFound":{ - "shape":"ThreatIdList", - "documentation":"

The list of threat identifiers that were not found.

" - } - }, - "documentation":"

Output for the BatchGetThreats operation.

" - }, - "BatchSecurityRequirementError":{ - "type":"structure", - "required":[ - "securityRequirementName", - "code", - "message" - ], - "members":{ - "securityRequirementName":{ - "shape":"SecurityRequirementName", - "documentation":"

The name of the security requirement that caused the error.

" - }, - "code":{ - "shape":"String", - "documentation":"

The error code.

" - }, - "message":{ - "shape":"String", - "documentation":"

The error message.

" - } - }, - "documentation":"

Contains information about an error that occurred for a specific security requirement during a batch operation.

" - }, - "BatchSecurityRequirementErrors":{ - "type":"list", - "member":{"shape":"BatchSecurityRequirementError"}, - "documentation":"

List of errors from a batch security requirement operation.

" - }, - "BatchUpdateSecurityRequirementsInput":{ - "type":"structure", - "required":[ - "packId", - "securityRequirements" - ], - "members":{ - "packId":{ - "shape":"SecurityRequirementPackId", - "documentation":"

The unique identifier of the security requirement pack containing the requirements to update.

" - }, - "securityRequirements":{ - "shape":"UpdateSecurityRequirementEntryList", - "documentation":"

The list of security requirement updates to apply.

" - } - } - }, - "BatchUpdateSecurityRequirementsOutput":{ - "type":"structure", - "required":[ - "updatedSecurityRequirementNames", - "errors" - ], - "members":{ - "updatedSecurityRequirementNames":{ - "shape":"SecurityRequirementNameList", - "documentation":"

The list of security requirement names that were successfully updated.

" - }, - "errors":{ - "shape":"BatchSecurityRequirementErrors", - "documentation":"

The list of errors for security requirements that failed to be updated.

" - } - } - }, - "BitbucketInstallationId":{ - "type":"string", - "documentation":"

An Atlassian installation identifier for a Bitbucket integration.

" - }, - "BitbucketIntegrationInput":{ - "type":"structure", - "required":[ - "installationId", - "workspace", - "code", - "state" - ], - "members":{ - "installationId":{ - "shape":"BitbucketInstallationId", - "documentation":"

The Atlassian installation identifier, available from the Atlassian administration console.

" - }, - "workspace":{ - "shape":"BitbucketWorkspace", - "documentation":"

The Bitbucket workspace slug that identifies the workspace to integrate, for example acme-corp.

" - }, - "code":{ - "shape":"AuthCode", - "documentation":"

The OAuth 2.0 authorization code returned from the consent redirect.

" - }, - "state":{ - "shape":"CsrfState", - "documentation":"

The CSRF state token echoed back from the OAuth redirect.

" - } - }, - "documentation":"

The configuration for creating a Bitbucket integration.

" - }, - "BitbucketRepositoryMetadata":{ - "type":"structure", - "required":[ - "name", - "providerResourceId", - "workspace" - ], - "members":{ - "name":{"shape":"ProviderResourceName"}, - "providerResourceId":{"shape":"ProviderResourceId"}, - "workspace":{ - "shape":"BitbucketWorkspace", - "documentation":"

The workspace slug that owns the repository.

" - }, - "accessType":{"shape":"AccessType"} - }, - "documentation":"

Metadata for an integrated Bitbucket repository.

" - }, - "BitbucketRepositoryResource":{ - "type":"structure", - "required":[ - "name", - "workspace" - ], - "members":{ - "name":{"shape":"ProviderResourceName"}, - "workspace":{ - "shape":"BitbucketWorkspace", - "documentation":"

The workspace slug that owns the repository.

" - } - }, - "documentation":"

A Bitbucket repository integrated as a resource.

" - }, - "BitbucketResourceCapabilities":{ - "type":"structure", - "members":{ - "leaveComments":{ - "shape":"Boolean", - "documentation":"

Whether to post code review comments on pull requests.

" - }, - "remediateCode":{ - "shape":"Boolean", - "documentation":"

Whether to create pull requests with automated fixes.

" - } - }, - "documentation":"

Capabilities for an integrated Bitbucket repository.

" - }, - "BitbucketWorkspace":{ - "type":"string", - "documentation":"

A Bitbucket workspace slug that identifies a workspace.

" - }, - "Blob":{"type":"blob"}, - "Boolean":{ - "type":"boolean", - "box":true - }, - "Category":{ - "type":"structure", - "members":{ - "name":{ - "shape":"String", - "documentation":"

The name of the category.

" - }, - "isPrimary":{ - "shape":"Boolean", - "documentation":"

Indicates whether this is the primary category for the task.

" - } - }, - "documentation":"

Represents a category assigned to a security testing task.

" - }, - "CategoryList":{ - "type":"list", - "member":{"shape":"Category"} - }, - "CertificateChain":{ - "type":"string", - "documentation":"

A PEM-encoded certificate chain for a private connection.

", - "sensitive":true - }, - "CleanUpStrategy":{ - "type":"string", - "documentation":"

Strategy for handling resources created during a pentest.

", - "enum":[ - "BEST_EFFORT_DELETE", - "RETAIN_ALL" - ] - }, - "CloudWatchLog":{ - "type":"structure", - "members":{ - "logGroup":{ - "shape":"String", - "documentation":"

The name of the CloudWatch log group.

" - }, - "logStream":{ - "shape":"String", - "documentation":"

The name of the CloudWatch log stream.

" - } - }, - "documentation":"

The Amazon CloudWatch Logs configuration for pentest job logging.

" - }, - "CodeLocation":{ - "type":"structure", - "required":["filePath"], - "members":{ - "filePath":{ - "shape":"String", - "documentation":"

The absolute path to the file containing the code location.

" - }, - "lineStart":{ - "shape":"Integer", - "documentation":"

The starting line number of the code location.

" - }, - "lineEnd":{ - "shape":"Integer", - "documentation":"

The ending line number of the code location.

" - }, - "label":{ - "shape":"String", - "documentation":"

The role of this location in the vulnerability, such as source or sink.

" - } - }, - "documentation":"

Represents a location in source code associated with a security finding.

" - }, - "CodeLocationList":{ - "type":"list", - "member":{"shape":"CodeLocation"}, - "documentation":"

List of code locations.

" - }, - "CodeRemediationStrategy":{ - "type":"string", - "documentation":"

Strategy for automated code remediation.

", - "enum":[ - "AUTOMATIC", - "DISABLED" - ] - }, - "CodeRemediationTask":{ - "type":"structure", - "required":["status"], - "members":{ - "status":{ - "shape":"CodeRemediationTaskStatus", - "documentation":"

The current status of the code remediation task.

" - }, - "statusReason":{ - "shape":"String", - "documentation":"

The reason for the current status of the code remediation task.

" - }, - "taskDetails":{ - "shape":"CodeRemediationTaskDetailsList", - "documentation":"

The list of details for the code remediation task, including repository name, code diff link, and pull request link.

" - } - }, - "documentation":"

Represents a code remediation task that was initiated to fix a security finding.

" - }, - "CodeRemediationTaskDetails":{ - "type":"structure", - "members":{ - "repoName":{ - "shape":"String", - "documentation":"

The name of the repository where the remediation was applied.

" - }, - "codeDiffLink":{ - "shape":"String", - "documentation":"

The link to the code diff for the remediation.

" - }, - "pullRequestLink":{ - "shape":"String", - "documentation":"

The link to the pull request created for the remediation.

" - } - }, - "documentation":"

Contains details about a code remediation task, including links to the code diff and pull request.

" - }, - "CodeRemediationTaskDetailsList":{ - "type":"list", - "member":{"shape":"CodeRemediationTaskDetails"} - }, - "CodeRemediationTaskStatus":{ - "type":"string", - "documentation":"

Code remediation task status.

", - "enum":[ - "IN_PROGRESS", - "COMPLETED", - "FAILED" - ] - }, - "CodeReview":{ - "type":"structure", - "required":[ - "codeReviewId", - "agentSpaceId", - "title", - "assets" - ], - "members":{ - "codeReviewId":{ - "shape":"String", - "documentation":"

The unique identifier of the code review.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space that contains the code review.

" - }, - "title":{ - "shape":"String", - "documentation":"

The title of the code review.

" - }, - "assets":{ - "shape":"Assets", - "documentation":"

The assets included in the code review.

" - }, - "serviceRole":{ - "shape":"ServiceRole", - "documentation":"

The IAM service role used for the code review.

" - }, - "logConfig":{ - "shape":"CloudWatchLog", - "documentation":"

The CloudWatch Logs configuration for the code review.

" - }, - "codeRemediationStrategy":{ - "shape":"CodeRemediationStrategy", - "documentation":"

The code remediation strategy for the code review.

" - }, - "validationMode":{ - "shape":"ValidationMode", - "documentation":"

The validation mode for the code review. Valid values are SIMULATED and DISABLED.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the code review was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the code review was last updated, in UTC format.

" - } - }, - "documentation":"

Represents a code review configuration that defines the parameters for automated security-focused code analysis, including target assets and logging configuration.

" - }, - "CodeReviewIdList":{ - "type":"list", - "member":{"shape":"String"}, - "documentation":"

List of code review IDs.

" - }, - "CodeReviewJob":{ - "type":"structure", - "members":{ - "codeReviewJobId":{ - "shape":"String", - "documentation":"

The unique identifier of the code review job.

" - }, - "codeReviewId":{ - "shape":"String", - "documentation":"

The unique identifier of the code review associated with the job.

" - }, - "title":{ - "shape":"String", - "documentation":"

The title of the code review job.

" - }, - "overview":{ - "shape":"String", - "documentation":"

An overview of the code review job results.

" - }, - "status":{ - "shape":"JobStatus", - "documentation":"

The current status of the code review job.

" - }, - "documents":{ - "shape":"DocumentList", - "documentation":"

The list of documents providing context for the code review job.

" - }, - "sourceCode":{ - "shape":"SourceCodeRepositoryList", - "documentation":"

The list of source code repositories analyzed during the code review job.

" - }, - "steps":{ - "shape":"StepList", - "documentation":"

The list of steps in the code review job execution.

" - }, - "executionContext":{ - "shape":"ExecutionContextList", - "documentation":"

The execution context messages for the code review job.

" - }, - "serviceRole":{ - "shape":"ServiceRole", - "documentation":"

The IAM service role used for the code review job.

" - }, - "logConfig":{ - "shape":"CloudWatchLog", - "documentation":"

The CloudWatch Logs configuration for the code review job.

" - }, - "errorInformation":{ - "shape":"ErrorInformation", - "documentation":"

Error information if the code review job encountered an error.

" - }, - "integratedRepositories":{ - "shape":"IntegratedRepositoryList", - "documentation":"

The list of integrated repositories associated with the code review job.

" - }, - "codeRemediationStrategy":{ - "shape":"CodeRemediationStrategy", - "documentation":"

The code remediation strategy for the code review job.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the code review job was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the code review job was last updated, in UTC format.

" - } - }, - "documentation":"

Represents a code review job, which is an execution instance of a code review. A code review job progresses through preflight, static analysis, and finalizing steps.

" - }, - "CodeReviewJobIdList":{ - "type":"list", - "member":{"shape":"String"}, - "documentation":"

List of code review job IDs.

" - }, - "CodeReviewJobList":{ - "type":"list", - "member":{"shape":"CodeReviewJob"}, - "documentation":"

List of code review jobs.

" - }, - "CodeReviewJobSummary":{ - "type":"structure", - "required":[ - "codeReviewJobId", - "codeReviewId" - ], - "members":{ - "codeReviewJobId":{ - "shape":"String", - "documentation":"

The unique identifier of the code review job.

" - }, - "codeReviewId":{ - "shape":"String", - "documentation":"

The unique identifier of the code review associated with the job.

" - }, - "title":{ - "shape":"String", - "documentation":"

The title of the code review job.

" - }, - "status":{ - "shape":"JobStatus", - "documentation":"

The current status of the code review job.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the code review job was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the code review job was last updated, in UTC format.

" - } - }, - "documentation":"

Contains summary information about a code review job.

" - }, - "CodeReviewJobSummaryList":{ - "type":"list", - "member":{"shape":"CodeReviewJobSummary"}, - "documentation":"

List of code review job summaries.

" - }, - "CodeReviewJobTask":{ - "type":"structure", - "required":["taskId"], - "members":{ - "taskId":{ - "shape":"String", - "documentation":"

The unique identifier of the task.

" - }, - "codeReviewId":{ - "shape":"String", - "documentation":"

The unique identifier of the code review associated with the task.

" - }, - "codeReviewJobId":{ - "shape":"String", - "documentation":"

The unique identifier of the code review job that contains the task.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space.

" - }, - "title":{ - "shape":"String", - "documentation":"

The title of the task.

" - }, - "description":{ - "shape":"String", - "documentation":"

A description of the task.

" - }, - "categories":{ - "shape":"CategoryList", - "documentation":"

The list of categories assigned to the task.

" - }, - "riskType":{ - "shape":"RiskType", - "documentation":"

The type of security risk the task is testing for.

" - }, - "executionStatus":{ - "shape":"TaskExecutionStatus", - "documentation":"

The current execution status of the task.

" - }, - "logsLocation":{ - "shape":"LogLocation", - "documentation":"

The location of the task execution logs.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the task was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the task was last updated, in UTC format.

" - } - }, - "documentation":"

Represents an individual security test task within a code review job. Each task targets a specific risk type and executes independently.

" - }, - "CodeReviewJobTaskList":{ - "type":"list", - "member":{"shape":"CodeReviewJobTask"}, - "documentation":"

List of code review job tasks.

" - }, - "CodeReviewJobTaskSummary":{ - "type":"structure", - "required":["taskId"], - "members":{ - "taskId":{ - "shape":"String", - "documentation":"

The unique identifier of the task.

" - }, - "codeReviewId":{ - "shape":"String", - "documentation":"

The unique identifier of the code review associated with the task.

" - }, - "codeReviewJobId":{ - "shape":"String", - "documentation":"

The unique identifier of the code review job that contains the task.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space.

" - }, - "title":{ - "shape":"String", - "documentation":"

The title of the task.

" - }, - "riskType":{ - "shape":"RiskType", - "documentation":"

The type of security risk the task is testing for.

" - }, - "executionStatus":{ - "shape":"TaskExecutionStatus", - "documentation":"

The current execution status of the task.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the task was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the task was last updated, in UTC format.

" - } - }, - "documentation":"

Contains summary information about a code review job task.

" - }, - "CodeReviewJobTaskSummaryList":{ - "type":"list", - "member":{"shape":"CodeReviewJobTaskSummary"}, - "documentation":"

List of code review job task summaries.

" - }, - "CodeReviewList":{ - "type":"list", - "member":{"shape":"CodeReview"}, - "documentation":"

List of code reviews.

" - }, - "CodeReviewSettings":{ - "type":"structure", - "required":[ - "controlsScanning", - "generalPurposeScanning" - ], - "members":{ - "controlsScanning":{ - "shape":"Boolean", - "documentation":"

Indicates whether controls scanning is enabled for code reviews.

" - }, - "generalPurposeScanning":{ - "shape":"Boolean", - "documentation":"

Indicates whether general-purpose scanning is enabled for code reviews.

" - } - }, - "documentation":"

The code review settings for an agent space, controlling which types of scanning are enabled.

" - }, - "CodeReviewSummary":{ - "type":"structure", - "required":[ - "codeReviewId", - "agentSpaceId", - "title" - ], - "members":{ - "codeReviewId":{ - "shape":"String", - "documentation":"

The unique identifier of the code review.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space that contains the code review.

" - }, - "title":{ - "shape":"String", - "documentation":"

The title of the code review.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the code review was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the code review was last updated, in UTC format.

" - } - }, - "documentation":"

Contains summary information about a code review.

" - }, - "CodeReviewSummaryList":{ - "type":"list", - "member":{"shape":"CodeReviewSummary"}, - "documentation":"

List of code review summaries.

" - }, - "ConfidenceLevel":{ - "type":"string", - "documentation":"

Finding confidence level.

", - "enum":[ - "FALSE_POSITIVE", - "UNCONFIRMED", - "LOW", - "MEDIUM", - "HIGH" - ] - }, - "ConflictException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{ - "shape":"String", - "documentation":"

Error description.

" - } - }, - "documentation":"

The request could not be completed due to a conflict with the current state of the resource.

", - "error":{ - "httpStatusCode":409, - "senderFault":true - }, - "exception":true - }, - "ConfluenceDocumentMetadata":{ - "type":"structure", - "required":[ - "name", - "providerResourceId", - "spaceKey", - "pageId" - ], - "members":{ - "name":{"shape":"ProviderResourceName"}, - "providerResourceId":{"shape":"ProviderResourceId"}, - "spaceKey":{ - "shape":"String", - "documentation":"

The Confluence space key containing the document.

" - }, - "pageId":{ - "shape":"String", - "documentation":"

The Confluence page identifier.

" - }, - "title":{ - "shape":"String", - "documentation":"

The display title of the Confluence page.

" - }, - "spaceTitle":{ - "shape":"String", - "documentation":"

The display title of the Confluence space.

" - } - }, - "documentation":"

Metadata for an integrated Confluence document.

" - }, - "ConfluenceDocumentResource":{ - "type":"structure", - "required":[ - "name", - "spaceKey", - "pageId" - ], - "members":{ - "name":{"shape":"ProviderResourceName"}, - "spaceKey":{ - "shape":"String", - "documentation":"

The Confluence space key containing the document.

" - }, - "pageId":{ - "shape":"String", - "documentation":"

The Confluence page identifier.

" - }, - "title":{ - "shape":"String", - "documentation":"

The display title of the Confluence page.

" - }, - "spaceTitle":{ - "shape":"String", - "documentation":"

The display title of the Confluence space.

" - } - }, - "documentation":"

A Confluence document (page) integrated as a resource.

" - }, - "ConfluenceInstallationId":{ - "type":"string", - "documentation":"

An Atlassian installation identifier for a Confluence integration.

" - }, - "ConfluenceIntegrationInput":{ - "type":"structure", - "required":[ - "installationId", - "code", - "state", - "siteUrl" - ], - "members":{ - "installationId":{ - "shape":"ConfluenceInstallationId", - "documentation":"

The Atlassian installation identifier, available from the Atlassian administration console.

" - }, - "code":{ - "shape":"AuthCode", - "documentation":"

The OAuth 2.0 authorization code returned from the consent redirect.

" - }, - "state":{ - "shape":"CsrfState", - "documentation":"

The CSRF state token echoed back from the OAuth redirect.

" - }, - "siteUrl":{ - "shape":"ConfluenceSiteUrl", - "documentation":"

The Confluence Cloud site URL, for example https://mysite.atlassian.net.

" - } - }, - "documentation":"

The configuration for creating a Confluence integration.

" - }, - "ConfluenceResourceCapabilities":{ - "type":"structure", - "members":{ - "fetchDocument":{ - "shape":"Boolean", - "documentation":"

Whether to fetch documents from this space.

" - }, - "createDocument":{ - "shape":"Boolean", - "documentation":"

Whether to create documents in this space.

" - }, - "updateDocument":{ - "shape":"Boolean", - "documentation":"

Whether to update documents in this space.

" - } - }, - "documentation":"

Capabilities for an integrated Confluence space.

" - }, - "ConfluenceSiteUrl":{ - "type":"string", - "documentation":"

The URL of a Confluence Cloud site.

" - }, - "ContextType":{ - "type":"string", - "documentation":"

Category of execution context.

", - "enum":[ - "ERROR", - "CLIENT_ERROR", - "WARNING", - "INFO" - ] - }, - "CreateAgentSpaceInput":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{ - "shape":"AgentName", - "documentation":"

The name of the agent space.

" - }, - "description":{ - "shape":"String", - "documentation":"

A description of the agent space.

" - }, - "awsResources":{ - "shape":"AWSResources", - "documentation":"

The AWS resources to associate with the agent space.

" - }, - "targetDomainIds":{ - "shape":"TargetDomainIdList", - "documentation":"

The list of target domain identifiers to associate with the agent space.

" - }, - "codeReviewSettings":{ - "shape":"CodeReviewSettings", - "documentation":"

The code review settings for the agent space.

" - }, - "kmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The identifier of the AWS KMS key to use for encrypting data in the agent space.

" - }, - "tags":{ - "shape":"TagMap", - "documentation":"

The tags to associate with the agent space.

" - } - }, - "documentation":"

Input for creating a new agent space.

" - }, - "CreateAgentSpaceOutput":{ - "type":"structure", - "required":[ - "agentSpaceId", - "name" - ], - "members":{ - "agentSpaceId":{ - "shape":"AgentSpaceId", - "documentation":"

The unique identifier of the created agent space.

" - }, - "name":{ - "shape":"AgentName", - "documentation":"

The name of the agent space.

" - }, - "description":{ - "shape":"String", - "documentation":"

The description of the agent space.

" - }, - "awsResources":{ - "shape":"AWSResources", - "documentation":"

The AWS resources associated with the agent space.

" - }, - "targetDomainIds":{ - "shape":"TargetDomainIdList", - "documentation":"

The list of target domain identifiers associated with the agent space.

" - }, - "codeReviewSettings":{ - "shape":"CodeReviewSettings", - "documentation":"

The code review settings for the agent space.

" - }, - "kmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The identifier of the AWS KMS key used to encrypt data in the agent space.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the agent space was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the agent space was last updated, in UTC format.

" - } - }, - "documentation":"

Output for the CreateAgentSpace operation.

" - }, - "CreateApplicationRequest":{ - "type":"structure", - "members":{ - "idcInstanceArn":{ - "shape":"IdCInstanceArn", - "documentation":"

The Amazon Resource Name (ARN) of the IAM Identity Center instance to associate with the application.

" - }, - "roleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the IAM role to associate with the application.

" - }, - "defaultKmsKeyId":{ - "shape":"DefaultKmsKeyId", - "documentation":"

The identifier of the default AWS KMS key to use for encrypting data in the application.

" - }, - "tags":{ - "shape":"TagMap", - "documentation":"

The tags to associate with the application.

" - } - } - }, - "CreateApplicationResponse":{ - "type":"structure", - "required":["applicationId"], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "documentation":"

The unique identifier of the created application.

" - } - } - }, - "CreateCodeReviewInput":{ - "type":"structure", - "required":[ - "title", - "agentSpaceId", - "assets" - ], - "members":{ - "title":{ - "shape":"String", - "documentation":"

The title of the code review.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space to create the code review in.

" - }, - "assets":{ - "shape":"Assets", - "documentation":"

The assets to include in the code review, such as documents and source code.

" - }, - "serviceRole":{ - "shape":"ServiceRole", - "documentation":"

The IAM service role to use for the code review.

" - }, - "logConfig":{ - "shape":"CloudWatchLog", - "documentation":"

The CloudWatch Logs configuration for the code review.

" - }, - "codeRemediationStrategy":{ - "shape":"CodeRemediationStrategy", - "documentation":"

The code remediation strategy for the code review. Valid values are AUTOMATIC and DISABLED.

" - }, - "validationMode":{ - "shape":"ValidationMode", - "documentation":"

The validation mode for the code review. Valid values are SIMULATED and DISABLED.

" - } - }, - "documentation":"

Input for creating a new code review.

" - }, - "CreateCodeReviewOutput":{ - "type":"structure", - "required":["codeReviewId"], - "members":{ - "codeReviewId":{ - "shape":"String", - "documentation":"

The unique identifier of the created code review.

" - }, - "title":{ - "shape":"String", - "documentation":"

The title of the code review.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the code review was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the code review was last updated, in UTC format.

" - }, - "assets":{ - "shape":"Assets", - "documentation":"

The assets included in the code review.

" - }, - "serviceRole":{ - "shape":"ServiceRole", - "documentation":"

The IAM service role used for the code review.

" - }, - "logConfig":{ - "shape":"CloudWatchLog", - "documentation":"

The CloudWatch Logs configuration for the code review.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space that contains the code review.

" - }, - "codeRemediationStrategy":{ - "shape":"CodeRemediationStrategy", - "documentation":"

The code remediation strategy for the code review.

" - }, - "validationMode":{ - "shape":"ValidationMode", - "documentation":"

The validation mode for the code review.

" - } - }, - "documentation":"

Output for the CreateCodeReview operation.

" - }, - "CreateIntegrationInput":{ - "type":"structure", - "required":[ - "provider", - "input", - "integrationDisplayName" - ], - "members":{ - "provider":{ - "shape":"Provider", - "documentation":"

The integration provider. Currently, only GITHUB is supported.

" - }, - "input":{ - "shape":"ProviderInput", - "documentation":"

The provider-specific input required to create the integration.

" - }, - "integrationDisplayName":{ - "shape":"String", - "documentation":"

The display name for the integration.

" - }, - "kmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The identifier of the AWS KMS key to use for encrypting data associated with the integration.

" - }, - "tags":{ - "shape":"TagMap", - "documentation":"

The tags to associate with the integration.

" - }, - "privateConnectionName":{ - "shape":"PrivateConnectionName", - "documentation":"

The name of an active private connection used to reach a self-hosted provider instance over private networking. Specify this when the instance is not publicly reachable.

" - } - } - }, - "CreateIntegrationOutput":{ - "type":"structure", - "required":["integrationId"], - "members":{ - "integrationId":{ - "shape":"IntegrationId", - "documentation":"

The unique identifier of the created integration.

" - } - } - }, - "CreateMembershipRequest":{ - "type":"structure", - "required":[ - "applicationId", - "agentSpaceId", - "membershipId", - "memberType" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "documentation":"

The unique identifier of the application that contains the agent space.

" - }, - "agentSpaceId":{ - "shape":"AgentSpaceId", - "documentation":"

The unique identifier of the agent space to grant access to.

" - }, - "membershipId":{ - "shape":"MembershipId", - "documentation":"

The unique identifier for the membership.

" - }, - "memberType":{ - "shape":"MembershipType", - "documentation":"

The type of member. Currently, only USER is supported.

" - }, - "config":{ - "shape":"MembershipConfig", - "documentation":"

The configuration for the membership, such as the user role.

" - } - }, - "documentation":"

Request structure for adding a single member to an agent space.

" - }, - "CreateMembershipResponse":{ - "type":"structure", - "members":{}, - "documentation":"

Response structure for adding a single member to an agent space.

" - }, - "CreatePentestInput":{ - "type":"structure", - "required":[ - "title", - "agentSpaceId" - ], - "members":{ - "title":{ - "shape":"String", - "documentation":"

The title of the pentest.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space to create the pentest in.

" - }, - "assets":{ - "shape":"Assets", - "documentation":"

The assets to include in the pentest, such as endpoints, actors, documents, and source code.

" - }, - "excludeRiskTypes":{ - "shape":"RiskTypeList", - "documentation":"

The list of risk types to exclude from the pentest.

" - }, - "serviceRole":{ - "shape":"ServiceRole", - "documentation":"

The IAM service role to use for the pentest.

" - }, - "logConfig":{ - "shape":"CloudWatchLog", - "documentation":"

The CloudWatch Logs configuration for the pentest.

" - }, - "vpcConfig":{ - "shape":"VpcConfig", - "documentation":"

The VPC configuration for the pentest.

" - }, - "networkTrafficConfig":{ - "shape":"NetworkTrafficConfig", - "documentation":"

The network traffic configuration for the pentest, including custom headers and traffic rules.

" - }, - "codeRemediationStrategy":{ - "shape":"CodeRemediationStrategy", - "documentation":"

The code remediation strategy for the pentest. Valid values are AUTOMATIC and DISABLED.

" - }, - "disableManagedSkills":{ - "shape":"SkillTypeList", - "documentation":"

A list of managed skills to disable for this pentest. Valid values include FINDING_PERSONALIZATION and LOGIN_OPTIMIZATION.

" - } - }, - "documentation":"

Input for creating a new pentest.

" - }, - "CreatePentestOutput":{ - "type":"structure", - "members":{ - "pentestId":{ - "shape":"String", - "documentation":"

The unique identifier of the created pentest.

" - }, - "title":{ - "shape":"String", - "documentation":"

The title of the pentest.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the pentest was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the pentest was last updated, in UTC format.

" - }, - "assets":{ - "shape":"Assets", - "documentation":"

The assets included in the pentest.

" - }, - "excludeRiskTypes":{ - "shape":"RiskTypeList", - "documentation":"

The list of risk types excluded from the pentest.

" - }, - "serviceRole":{ - "shape":"ServiceRole", - "documentation":"

The IAM service role used for the pentest.

" - }, - "logConfig":{ - "shape":"CloudWatchLog", - "documentation":"

The CloudWatch Logs configuration for the pentest.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space that contains the pentest.

" - } - }, - "documentation":"

Output for the CreatePentest operation.

" - }, - "CreatePrivateConnectionInput":{ - "type":"structure", - "required":[ - "privateConnectionName", - "mode" - ], - "members":{ - "privateConnectionName":{ - "shape":"PrivateConnectionName", - "documentation":"

A unique name for the private connection within your account.

" - }, - "mode":{ - "shape":"PrivateConnectionMode", - "documentation":"

The configuration for the private connection. Specify either a service-managed or a self-managed mode.

" - }, - "tags":{ - "shape":"TagMap", - "documentation":"

The tags to attach to the private connection.

" - } - } - }, - "CreatePrivateConnectionOutput":{ - "type":"structure", - "required":[ - "name", - "type", - "status" - ], - "members":{ - "name":{ - "shape":"PrivateConnectionName", - "documentation":"

The name of the private connection.

" - }, - "type":{ - "shape":"PrivateConnectionType", - "documentation":"

The type of the private connection, indicating whether it is service-managed or self-managed.

" - }, - "status":{ - "shape":"PrivateConnectionStatus", - "documentation":"

The current status of the private connection.

" - }, - "resourceGatewayId":{ - "shape":"ResourceGatewayId", - "documentation":"

The identifier or ARN of the VPC Lattice resource gateway.

" - }, - "hostAddress":{ - "shape":"HostAddress", - "documentation":"

The IP address or DNS name of the target resource.

" - }, - "vpcId":{ - "shape":"PrivateConnectionVpcId", - "documentation":"

The identifier of the VPC the resource gateway is created in.

" - }, - "resourceConfigurationId":{ - "shape":"ResourceConfigurationId", - "documentation":"

The identifier or ARN of the VPC Lattice resource configuration.

" - }, - "certificateExpiryTime":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the connection's certificate expires, in UTC format.

" - }, - "dnsResolution":{ - "shape":"ResourceConfigDnsResolution", - "documentation":"

The DNS resolution mode for the resource gateway.

" - }, - "failureMessage":{ - "shape":"String", - "documentation":"

A message describing why the private connection entered a failed state, if applicable.

" - }, - "tags":{ - "shape":"TagMap", - "documentation":"

The tags attached to the private connection.

" - } - } - }, - "CreateSecurityRequirementEntry":{ - "type":"structure", - "required":[ - "name", - "description", - "domain", - "evaluation" - ], - "members":{ - "name":{ - "shape":"SecurityRequirementName", - "documentation":"

The name of the security requirement.

" - }, - "description":{ - "shape":"String", - "documentation":"

A description of the security requirement.

" - }, - "domain":{ - "shape":"String", - "documentation":"

The security domain the requirement belongs to.

" - }, - "evaluation":{ - "shape":"String", - "documentation":"

The evaluation criteria used to assess compliance with this requirement.

" - }, - "remediation":{ - "shape":"String", - "documentation":"

The recommended remediation steps when the requirement is not met.

" - } - }, - "documentation":"

Contains the details for a security requirement to create within a pack.

" - }, - "CreateSecurityRequirementEntryList":{ - "type":"list", - "member":{"shape":"CreateSecurityRequirementEntry"}, - "documentation":"

List of security requirements to create.

" - }, - "CreateSecurityRequirementPackInput":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{ - "shape":"SecurityRequirementPackName", - "documentation":"

The name of the security requirement pack.

" - }, - "description":{ - "shape":"String", - "documentation":"

A description of the security requirement pack.

" - }, - "status":{ - "shape":"SecurityRequirementPackStatus", - "documentation":"

The status of the pack. Defaults to ENABLED if not provided.

" - }, - "kmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The identifier of the AWS KMS key used to encrypt pack contents.

" - }, - "tags":{ - "shape":"TagMap", - "documentation":"

The tags to associate with the security requirement pack.

" - } - } - }, - "CreateSecurityRequirementPackOutput":{ - "type":"structure", - "required":[ - "packId", - "status" - ], - "members":{ - "packId":{ - "shape":"SecurityRequirementPackId", - "documentation":"

The unique identifier of the created security requirement pack.

" - }, - "status":{ - "shape":"SecurityRequirementPackStatus", - "documentation":"

The status of the created security requirement pack.

" - }, - "kmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The identifier of the AWS KMS key used to encrypt pack contents.

" - } - } - }, - "CreateTargetDomainInput":{ - "type":"structure", - "required":[ - "targetDomainName", - "verificationMethod" - ], - "members":{ - "targetDomainName":{ - "shape":"String", - "documentation":"

The domain name to register as a target domain.

" - }, - "verificationMethod":{ - "shape":"DomainVerificationMethod", - "documentation":"

The method to use for verifying domain ownership. Valid values are DNS_TXT, HTTP_ROUTE, and PRIVATE_VPC.

" - }, - "tags":{ - "shape":"TagMap", - "documentation":"

The tags to associate with the target domain.

" - } - }, - "documentation":"

Input for creating a new target domain.

" - }, - "CreateTargetDomainOutput":{ - "type":"structure", - "required":[ - "targetDomainId", - "domainName", - "verificationStatus" - ], - "members":{ - "targetDomainId":{ - "shape":"TargetDomainId", - "documentation":"

The unique identifier of the created target domain.

" - }, - "domainName":{ - "shape":"String", - "documentation":"

The domain name of the target domain.

" - }, - "verificationStatus":{ - "shape":"TargetDomainStatus", - "documentation":"

The current verification status of the target domain.

" - }, - "verificationStatusReason":{ - "shape":"String", - "documentation":"

The reason for the current target domain verification status.

" - }, - "verificationDetails":{ - "shape":"VerificationDetails", - "documentation":"

The verification details for the target domain, including the verification token and instructions.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the target domain was created, in UTC format.

" - }, - "verifiedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the target domain was verified, in UTC format.

" - } - }, - "documentation":"

Output for the CreateTargetDomain operation.

" - }, - "CreateThreatInput":{ - "type":"structure", - "required":[ - "agentSpaceId", - "threatJobId" - ], - "members":{ - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space.

" - }, - "threatJobId":{ - "shape":"String", - "documentation":"

The unique identifier of the threat model job the threat belongs to.

" - }, - "title":{ - "shape":"String", - "documentation":"

A short title summarizing the threat.

" - }, - "statement":{ - "shape":"String", - "documentation":"

The natural-language threat statement.

" - }, - "severity":{ - "shape":"ThreatSeverity", - "documentation":"

The severity level of the threat.

" - }, - "comments":{ - "shape":"String", - "documentation":"

Optional customer comment on the threat.

" - }, - "stride":{ - "shape":"StrideCategoryList", - "documentation":"

The STRIDE categories applicable to this threat.

" - }, - "threatSource":{ - "shape":"String", - "documentation":"

The actor or origin of the threat.

" - }, - "prerequisites":{ - "shape":"String", - "documentation":"

The conditions required for the threat to be exploitable.

" - }, - "threatAction":{ - "shape":"String", - "documentation":"

What the threat source can do.

" - }, - "threatImpact":{ - "shape":"String", - "documentation":"

The direct consequence of the threat action.

" - }, - "impactedGoal":{ - "shape":"StringList", - "documentation":"

The security goals affected by the threat.

" - }, - "impactedAssets":{ - "shape":"StringList", - "documentation":"

The specific assets affected by the threat.

" - }, - "anchor":{ - "shape":"ThreatAnchorShape", - "documentation":"

The DFD element this threat is anchored to.

" - }, - "evidence":{ - "shape":"ThreatEvidenceList", - "documentation":"

The source code files supporting the threat.

" - }, - "recommendation":{ - "shape":"String", - "documentation":"

The recommended mitigation guidance for this threat.

" - } - }, - "documentation":"

Input for creating a new threat.

" - }, - "CreateThreatModelInput":{ - "type":"structure", - "required":[ - "title", - "agentSpaceId", - "serviceRole" - ], - "members":{ - "title":{ - "shape":"String", - "documentation":"

The title of the threat model.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space to create the threat model in.

" - }, - "description":{ - "shape":"String", - "documentation":"

A description of the application or system being threat modeled.

" - }, - "assets":{ - "shape":"Assets", - "documentation":"

The assets to include in the threat model.

" - }, - "scopeDocs":{ - "shape":"DocumentList", - "documentation":"

The scoped documents for the agent to focus on during threat modeling.

" - }, - "serviceRole":{ - "shape":"ServiceRole", - "documentation":"

The IAM service role to use for the threat model.

" - }, - "logConfig":{ - "shape":"CloudWatchLog", - "documentation":"

The CloudWatch Logs configuration for the threat model.

" - }, - "reportDestination":{ - "shape":"ReportDestination", - "documentation":"

The destination for publishing scan reports to an integrated document provider.

" - } - }, - "documentation":"

Input for creating a new threat model.

" - }, - "CreateThreatModelOutput":{ - "type":"structure", - "required":["threatModelId"], - "members":{ - "threatModelId":{ - "shape":"String", - "documentation":"

The unique identifier of the created threat model.

" - }, - "title":{ - "shape":"String", - "documentation":"

The title of the threat model.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space that contains the threat model.

" - }, - "description":{ - "shape":"String", - "documentation":"

A description of the application or system being threat modeled.

" - }, - "assets":{ - "shape":"Assets", - "documentation":"

The assets included in the threat model.

" - }, - "scopeDocs":{ - "shape":"DocumentList", - "documentation":"

The scoped documents for the agent to focus on during threat modeling.

" - }, - "serviceRole":{ - "shape":"ServiceRole", - "documentation":"

The IAM service role used for the threat model.

" - }, - "logConfig":{ - "shape":"CloudWatchLog", - "documentation":"

The CloudWatch Logs configuration for the threat model.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the threat model was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the threat model was last updated, in UTC format.

" - } - }, - "documentation":"

Output for the CreateThreatModel operation.

" - }, - "CreateThreatOutput":{ - "type":"structure", - "required":[ - "threatId", - "threatJobId" - ], - "members":{ - "threatId":{ - "shape":"String", - "documentation":"

The unique identifier of the created threat.

" - }, - "threatJobId":{ - "shape":"String", - "documentation":"

The unique identifier of the threat model job the threat belongs to.

" - }, - "title":{ - "shape":"String", - "documentation":"

A short title summarizing the threat.

" - }, - "statement":{ - "shape":"String", - "documentation":"

The natural-language threat statement.

" - }, - "severity":{ - "shape":"ThreatSeverity", - "documentation":"

The severity level of the threat.

" - }, - "status":{ - "shape":"ThreatStatus", - "documentation":"

The current status of the threat.

" - }, - "comments":{ - "shape":"String", - "documentation":"

Optional customer comment on the threat.

" - }, - "stride":{ - "shape":"StrideCategoryList", - "documentation":"

The STRIDE categories applicable to this threat.

" - }, - "threatSource":{ - "shape":"String", - "documentation":"

The actor or origin of the threat.

" - }, - "prerequisites":{ - "shape":"String", - "documentation":"

The conditions required for the threat to be exploitable.

" - }, - "threatAction":{ - "shape":"String", - "documentation":"

What the threat source can do.

" - }, - "threatImpact":{ - "shape":"String", - "documentation":"

The direct consequence of the threat action.

" - }, - "impactedGoal":{ - "shape":"StringList", - "documentation":"

The security goals affected by the threat.

" - }, - "impactedAssets":{ - "shape":"StringList", - "documentation":"

The specific assets affected by the threat.

" - }, - "anchor":{ - "shape":"ThreatAnchorShape", - "documentation":"

The DFD element this threat is anchored to.

" - }, - "evidence":{ - "shape":"ThreatEvidenceList", - "documentation":"

The source code files supporting the threat.

" - }, - "recommendation":{ - "shape":"String", - "documentation":"

The recommended mitigation guidance for this threat.

" - }, - "createdBy":{ - "shape":"ThreatActor", - "documentation":"

Who created this threat.

" - }, - "updatedBy":{ - "shape":"ThreatActor", - "documentation":"

Who last updated this threat.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the threat was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the threat was last updated, in UTC format.

" - } - }, - "documentation":"

Output for the CreateThreat operation.

" - }, - "CsrfState":{ - "type":"string", - "documentation":"

CSRF state token for OAuth security.

" - }, - "CustomHeader":{ - "type":"structure", - "members":{ - "name":{ - "shape":"String", - "documentation":"

The name of the custom header.

" - }, - "value":{ - "shape":"String", - "documentation":"

The value of the custom header.

" - } - }, - "documentation":"

A custom HTTP header to include in network traffic during penetration testing.

" - }, - "CustomHeaderList":{ - "type":"list", - "member":{"shape":"CustomHeader"}, - "documentation":"

List of custom headers.

" - }, - "DNSRecordType":{ - "type":"string", - "documentation":"

Type of DNS record.

", - "enum":["TXT"] - }, - "DefaultKmsKeyId":{ - "type":"string", - "documentation":"

Identifier of a KMS key. Can be a key ID, key ARN, alias name, or alias ARN.

" - }, - "DeleteAgentSpaceInput":{ - "type":"structure", - "required":["agentSpaceId"], - "members":{ - "agentSpaceId":{ - "shape":"AgentSpaceId", - "documentation":"

The unique identifier of the agent space to delete.

" - } - }, - "documentation":"

Input for deleting an agent space.

" - }, - "DeleteAgentSpaceOutput":{ - "type":"structure", - "members":{ - "agentSpaceId":{ - "shape":"AgentSpaceId", - "documentation":"

The unique identifier of the deleted agent space.

" - } - }, - "documentation":"

Output for the DeleteAgentSpace operation.

" - }, - "DeleteApplicationRequest":{ - "type":"structure", - "required":["applicationId"], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "documentation":"

The unique identifier of the application to delete.

" - } - } - }, - "DeleteArtifactInput":{ - "type":"structure", - "required":[ - "agentSpaceId", - "artifactId" - ], - "members":{ - "agentSpaceId":{ - "shape":"AgentSpaceId", - "documentation":"

The unique identifier of the agent space that contains the artifact.

" - }, - "artifactId":{ - "shape":"ArtifactId", - "documentation":"

The unique identifier of the artifact to delete.

" - } - } - }, - "DeleteArtifactOutput":{ - "type":"structure", - "members":{} - }, - "DeleteCodeReviewFailure":{ - "type":"structure", - "members":{ - "codeReviewId":{ - "shape":"String", - "documentation":"

The unique identifier of the code review that failed to delete.

" - }, - "reason":{ - "shape":"String", - "documentation":"

The reason the code review failed to delete.

" - } - }, - "documentation":"

Contains information about a code review that failed to delete.

" - }, - "DeleteCodeReviewFailureList":{ - "type":"list", - "member":{"shape":"DeleteCodeReviewFailure"}, - "documentation":"

List of code review deletion failures.

" - }, - "DeleteIntegrationInput":{ - "type":"structure", - "required":["integrationId"], - "members":{ - "integrationId":{ - "shape":"IntegrationId", - "documentation":"

The unique identifier of the integration to delete.

" - } - } - }, - "DeleteIntegrationOutput":{ - "type":"structure", - "members":{} - }, - "DeleteMembershipRequest":{ - "type":"structure", - "required":[ - "applicationId", - "agentSpaceId", - "membershipId" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "documentation":"

The unique identifier of the application that contains the agent space.

" - }, - "agentSpaceId":{ - "shape":"AgentSpaceId", - "documentation":"

The unique identifier of the agent space to revoke access from.

" - }, - "membershipId":{ - "shape":"MembershipId", - "documentation":"

The unique identifier of the membership to delete.

" - }, - "memberType":{ - "shape":"MembershipType", - "documentation":"

The type of member to remove.

" - } - }, - "documentation":"

Request structure for removing a single member from an agent space.

" - }, - "DeleteMembershipResponse":{ - "type":"structure", - "members":{}, - "documentation":"

Response structure for removing a single member from an agent space.

" - }, - "DeletePentestFailure":{ - "type":"structure", - "members":{ - "pentestId":{ - "shape":"String", - "documentation":"

The unique identifier of the pentest that failed to delete.

" - }, - "reason":{ - "shape":"String", - "documentation":"

The reason the pentest failed to delete.

" - } - }, - "documentation":"

Contains information about a pentest that failed to delete.

" - }, - "DeletePentestFailureList":{ - "type":"list", - "member":{"shape":"DeletePentestFailure"} - }, - "DeletePrivateConnectionInput":{ - "type":"structure", - "required":["privateConnectionName"], - "members":{ - "privateConnectionName":{ - "shape":"PrivateConnectionName", - "documentation":"

The name of the private connection to delete.

" - } - } - }, - "DeletePrivateConnectionOutput":{ - "type":"structure", - "required":[ - "name", - "type", - "status" - ], - "members":{ - "name":{ - "shape":"PrivateConnectionName", - "documentation":"

The name of the private connection.

" - }, - "type":{ - "shape":"PrivateConnectionType", - "documentation":"

The type of the private connection, indicating whether it is service-managed or self-managed.

" - }, - "status":{ - "shape":"PrivateConnectionStatus", - "documentation":"

The current status of the private connection.

" - }, - "resourceGatewayId":{ - "shape":"ResourceGatewayId", - "documentation":"

The identifier or ARN of the VPC Lattice resource gateway.

" - }, - "hostAddress":{ - "shape":"HostAddress", - "documentation":"

The IP address or DNS name of the target resource.

" - }, - "vpcId":{ - "shape":"PrivateConnectionVpcId", - "documentation":"

The identifier of the VPC the resource gateway is created in.

" - }, - "resourceConfigurationId":{ - "shape":"ResourceConfigurationId", - "documentation":"

The identifier or ARN of the VPC Lattice resource configuration.

" - }, - "certificateExpiryTime":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the connection's certificate expires, in UTC format.

" - }, - "dnsResolution":{ - "shape":"ResourceConfigDnsResolution", - "documentation":"

The DNS resolution mode for the resource gateway.

" - }, - "failureMessage":{ - "shape":"String", - "documentation":"

A message describing why the private connection entered a failed state, if applicable.

" - }, - "tags":{ - "shape":"TagMap", - "documentation":"

The tags attached to the private connection.

" - } - } - }, - "DeleteSecurityRequirementPackInput":{ - "type":"structure", - "required":["packId"], - "members":{ - "packId":{ - "shape":"SecurityRequirementPackId", - "documentation":"

The unique identifier of the security requirement pack to delete.

" - } - } - }, - "DeleteSecurityRequirementPackOutput":{ - "type":"structure", - "members":{} - }, - "DeleteTargetDomainInput":{ - "type":"structure", - "required":["targetDomainId"], - "members":{ - "targetDomainId":{ - "shape":"TargetDomainId", - "documentation":"

The unique identifier of the target domain to delete.

" - } - }, - "documentation":"

Input for deleting a target domain.

" - }, - "DeleteTargetDomainOutput":{ - "type":"structure", - "members":{ - "targetDomainId":{ - "shape":"TargetDomainId", - "documentation":"

The unique identifier of the deleted target domain.

" - } - }, - "documentation":"

Output for the DeleteTargetDomain operation.

" - }, - "DeleteThreatModelFailure":{ - "type":"structure", - "members":{ - "threatModelId":{ - "shape":"String", - "documentation":"

The unique identifier of the threat model that failed to delete.

" - }, - "reason":{ - "shape":"String", - "documentation":"

The reason the threat model failed to delete.

" - } - }, - "documentation":"

Contains information about a threat model that failed to delete.

" - }, - "DeleteThreatModelFailureList":{ - "type":"list", - "member":{"shape":"DeleteThreatModelFailure"}, - "documentation":"

List of threat model deletion failures.

" - }, - "DescribePrivateConnectionInput":{ - "type":"structure", - "required":["privateConnectionName"], - "members":{ - "privateConnectionName":{ - "shape":"PrivateConnectionName", - "documentation":"

The name of the private connection to describe.

" - } - } - }, - "DescribePrivateConnectionOutput":{ - "type":"structure", - "required":[ - "name", - "type", - "status" - ], - "members":{ - "name":{ - "shape":"PrivateConnectionName", - "documentation":"

The name of the private connection.

" - }, - "type":{ - "shape":"PrivateConnectionType", - "documentation":"

The type of the private connection, indicating whether it is service-managed or self-managed.

" - }, - "status":{ - "shape":"PrivateConnectionStatus", - "documentation":"

The current status of the private connection.

" - }, - "resourceGatewayId":{ - "shape":"ResourceGatewayId", - "documentation":"

The identifier or ARN of the VPC Lattice resource gateway.

" - }, - "hostAddress":{ - "shape":"HostAddress", - "documentation":"

The IP address or DNS name of the target resource.

" - }, - "vpcId":{ - "shape":"PrivateConnectionVpcId", - "documentation":"

The identifier of the VPC the resource gateway is created in.

" - }, - "resourceConfigurationId":{ - "shape":"ResourceConfigurationId", - "documentation":"

The identifier or ARN of the VPC Lattice resource configuration.

" - }, - "certificateExpiryTime":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the connection's certificate expires, in UTC format.

" - }, - "dnsResolution":{ - "shape":"ResourceConfigDnsResolution", - "documentation":"

The DNS resolution mode for the resource gateway.

" - }, - "failureMessage":{ - "shape":"String", - "documentation":"

A message describing why the private connection entered a failed state, if applicable.

" - }, - "tags":{ - "shape":"TagMap", - "documentation":"

The tags attached to the private connection.

" - } - } - }, - "DiffSource":{ - "type":"structure", - "members":{ - "s3Uri":{ - "shape":"String", - "documentation":"

S3 URI pointing to a unified diff file. The file must be in standard unified diff format and stored in an S3 bucket connected to your Agent Space.

" - } - }, - "documentation":"

Source of the diff for a differential code scan.

", - "union":true - }, - "DiscoveredEndpoint":{ - "type":"structure", - "required":[ - "uri", - "pentestJobId", - "taskId", - "agentSpaceId" - ], - "members":{ - "uri":{ - "shape":"String", - "documentation":"

The URI of the discovered endpoint.

" - }, - "pentestJobId":{ - "shape":"String", - "documentation":"

The unique identifier of the pentest job that discovered the endpoint.

" - }, - "taskId":{ - "shape":"String", - "documentation":"

The unique identifier of the task that discovered the endpoint.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space associated with the discovered endpoint.

" - }, - "evidence":{ - "shape":"String", - "documentation":"

The evidence that led to the discovery of the endpoint.

" - }, - "operation":{ - "shape":"String", - "documentation":"

The HTTP operation associated with the discovered endpoint.

" - }, - "description":{ - "shape":"String", - "documentation":"

A description of the discovered endpoint.

" - } - }, - "documentation":"

Represents an endpoint discovered during a pentest job.

" - }, - "DiscoveredEndpointList":{ - "type":"list", - "member":{"shape":"DiscoveredEndpoint"} - }, - "DnsVerification":{ - "type":"structure", - "members":{ - "token":{ - "shape":"String", - "documentation":"

The verification token to include in the DNS record value.

" - }, - "dnsRecordName":{ - "shape":"String", - "documentation":"

The name of the DNS record to create for verification.

" - }, - "dnsRecordType":{ - "shape":"DNSRecordType", - "documentation":"

The type of DNS record to create. Currently, only TXT is supported.

" - } - }, - "documentation":"

Contains DNS verification details for a target domain, including the DNS record to create for domain ownership verification.

" - }, - "DocumentInfo":{ - "type":"structure", - "members":{ - "s3Location":{ - "shape":"String", - "documentation":"

The Amazon S3 location of the document.

" - }, - "artifactId":{ - "shape":"String", - "documentation":"

The unique identifier of the artifact associated with the document.

" - }, - "integratedDocument":{ - "shape":"IntegratedDocument", - "documentation":"

A reference to a document in an integrated third-party provider.

" - } - }, - "documentation":"

Represents a document that provides context for security testing.

" - }, - "DocumentList":{ - "type":"list", - "member":{"shape":"DocumentInfo"} - }, - "DomainVerificationMethod":{ - "type":"string", - "documentation":"

Method used to verify domain ownership.

", - "enum":[ - "DNS_TXT", - "HTTP_ROUTE", - "PRIVATE_VPC" - ] - }, - "Double":{ - "type":"double", - "box":true - }, - "Endpoint":{ - "type":"structure", - "members":{ - "uri":{ - "shape":"String", - "documentation":"

The URI of the endpoint.

" - } - }, - "documentation":"

Represents a target endpoint for penetration testing.

" - }, - "EndpointList":{ - "type":"list", - "member":{"shape":"Endpoint"} - }, - "ErrorCode":{ - "type":"string", - "documentation":"

Error code for pentest job failure.

", - "enum":[ - "CLIENT_ERROR", - "INTERNAL_ERROR", - "STOPPED_BY_USER" - ] - }, - "ErrorInformation":{ - "type":"structure", - "members":{ - "code":{ - "shape":"ErrorCode", - "documentation":"

The error code. Valid values include CLIENT_ERROR, INTERNAL_ERROR, and STOPPED_BY_USER.

" - }, - "message":{ - "shape":"String", - "documentation":"

A message describing the error.

" - } - }, - "documentation":"

Contains error information for a pentest job that encountered an error.

" - }, - "ExecutionContext":{ - "type":"structure", - "members":{ - "contextType":{ - "shape":"ContextType", - "documentation":"

The type of context. Valid values include ERROR, CLIENT_ERROR, WARNING, and INFO.

" - }, - "context":{ - "shape":"String", - "documentation":"

The context message.

" - }, - "timestamp":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the context was recorded, in UTC format.

" - } - }, - "documentation":"

Contains contextual information about the execution of a pentest job, such as errors, warnings, or informational messages.

" - }, - "ExecutionContextList":{ - "type":"list", - "member":{"shape":"ExecutionContext"} - }, - "Finding":{ - "type":"structure", - "required":[ - "findingId", - "agentSpaceId" - ], - "members":{ - "findingId":{ - "shape":"String", - "documentation":"

The unique identifier of the finding.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space associated with the finding.

" - }, - "pentestId":{ - "shape":"String", - "documentation":"

The unique identifier of the pentest associated with the finding.

" - }, - "pentestJobId":{ - "shape":"String", - "documentation":"

The unique identifier of the pentest job that produced the finding.

" - }, - "codeReviewId":{ - "shape":"String", - "documentation":"

The unique identifier of the code review associated with the finding.

" - }, - "codeReviewJobId":{ - "shape":"String", - "documentation":"

The unique identifier of the code review job that produced the finding.

" - }, - "taskId":{ - "shape":"String", - "documentation":"

The unique identifier of the task that produced the finding.

" - }, - "name":{ - "shape":"String", - "documentation":"

The name of the finding.

" - }, - "description":{ - "shape":"String", - "documentation":"

A description of the finding.

" - }, - "status":{ - "shape":"FindingStatus", - "documentation":"

The current status of the finding. Valid values include ACTIVE, RESOLVED, ACCEPTED, and FALSE_POSITIVE.

" - }, - "riskType":{ - "shape":"String", - "documentation":"

The type of security risk identified by the finding.

" - }, - "riskLevel":{ - "shape":"RiskLevel", - "documentation":"

The risk level of the finding. Valid values include UNKNOWN, INFORMATIONAL, LOW, MEDIUM, HIGH, and CRITICAL.

" - }, - "riskScore":{ - "shape":"String", - "documentation":"

The numerical risk score of the finding.

" - }, - "reasoning":{ - "shape":"String", - "documentation":"

The reasoning behind the finding, explaining why it was identified as a vulnerability.

" - }, - "confidence":{ - "shape":"ConfidenceLevel", - "documentation":"

The confidence level of the finding. Valid values include FALSE_POSITIVE, UNCONFIRMED, LOW, MEDIUM, and HIGH.

" - }, - "validationStatus":{ - "shape":"ValidationStatus", - "documentation":"

The simulated validation status of the finding. Valid values are NOT_VALIDATED, VALIDATING, CONFIRMED, NOT_REPRODUCED, and VALIDATION_FAILED.

" - }, - "attackScript":{ - "shape":"String", - "documentation":"

The attack script used to reproduce the finding.

" - }, - "codeRemediationTask":{ - "shape":"CodeRemediationTask", - "documentation":"

The code remediation task associated with the finding, if code remediation was initiated.

" - }, - "lastUpdatedBy":{ - "shape":"String", - "documentation":"

The identifier of the entity that last updated the finding.

" - }, - "customerNote":{ - "shape":"String", - "documentation":"

A customer-provided note on the finding.

" - }, - "codeLocations":{ - "shape":"CodeLocationList", - "documentation":"

The file locations involved in the vulnerability, as reported by the code scanner.

" - }, - "verificationScript":{ - "shape":"VerificationScript", - "documentation":"

The verification script metadata for reproducing the finding, including download URL, instructions, and required environment variables.

" - }, - "alignmentRationale":{ - "shape":"String", - "documentation":"

The rationale provided by the alignment agent explaining how the finding was adjusted based on customer preferences.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the finding was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the finding was last updated, in UTC format.

" - } - }, - "documentation":"

Represents a security finding discovered during a pentest job. A finding contains details about a vulnerability, including its risk level, confidence, and remediation status.

" - }, - "FindingIdList":{ - "type":"list", - "member":{"shape":"String"} - }, - "FindingList":{ - "type":"list", - "member":{"shape":"Finding"}, - "documentation":"

List of findings.

" - }, - "FindingStatus":{ - "type":"string", - "documentation":"

Finding status.

", - "enum":[ - "ACTIVE", - "RESOLVED", - "ACCEPTED", - "FALSE_POSITIVE" - ] - }, - "FindingSummary":{ - "type":"structure", - "required":[ - "findingId", - "agentSpaceId" - ], - "members":{ - "findingId":{ - "shape":"String", - "documentation":"

The unique identifier of the finding.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space associated with the finding.

" - }, - "pentestId":{ - "shape":"String", - "documentation":"

The unique identifier of the pentest associated with the finding.

" - }, - "pentestJobId":{ - "shape":"String", - "documentation":"

The unique identifier of the pentest job that produced the finding.

" - }, - "codeReviewId":{ - "shape":"String", - "documentation":"

The unique identifier of the code review associated with the finding.

" - }, - "codeReviewJobId":{ - "shape":"String", - "documentation":"

The unique identifier of the code review job that produced the finding.

" - }, - "name":{ - "shape":"String", - "documentation":"

The name of the finding.

" - }, - "status":{ - "shape":"FindingStatus", - "documentation":"

The current status of the finding.

" - }, - "riskType":{ - "shape":"String", - "documentation":"

The type of security risk identified by the finding.

" - }, - "riskLevel":{ - "shape":"RiskLevel", - "documentation":"

The risk level of the finding.

" - }, - "confidence":{ - "shape":"ConfidenceLevel", - "documentation":"

The confidence level of the finding.

" - }, - "validationStatus":{ - "shape":"ValidationStatus", - "documentation":"

The simulated validation status of the finding.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the finding was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the finding was last updated, in UTC format.

" - } - }, - "documentation":"

Contains summary information about a security finding.

" - }, - "FindingSummaryList":{ - "type":"list", - "member":{"shape":"FindingSummary"}, - "documentation":"

List of finding summaries.

" - }, - "GetApplicationRequest":{ - "type":"structure", - "required":["applicationId"], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "documentation":"

The unique identifier of the application to retrieve.

" - } - } - }, - "GetApplicationResponse":{ - "type":"structure", - "required":[ - "applicationId", - "domain" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "documentation":"

The unique identifier of the application.

" - }, - "domain":{ - "shape":"ApplicationDomain", - "documentation":"

The domain associated with the application.

" - }, - "applicationName":{ - "shape":"String", - "documentation":"

The name of the application.

" - }, - "idcConfiguration":{ - "shape":"IdCConfiguration", - "documentation":"

The IAM Identity Center configuration for the application.

" - }, - "roleArn":{ - "shape":"RoleArn", - "documentation":"

The Amazon Resource Name (ARN) of the IAM role associated with the application.

" - }, - "defaultKmsKeyId":{ - "shape":"DefaultKmsKeyId", - "documentation":"

The identifier of the default AWS KMS key used to encrypt data for the application.

" - } - } - }, - "GetArtifactInput":{ - "type":"structure", - "required":[ - "agentSpaceId", - "artifactId" - ], - "members":{ - "agentSpaceId":{ - "shape":"AgentSpaceId", - "documentation":"

The unique identifier of the agent space that contains the artifact.

" - }, - "artifactId":{ - "shape":"ArtifactId", - "documentation":"

The unique identifier of the artifact to retrieve.

" - } - } - }, - "GetArtifactOutput":{ - "type":"structure", - "required":[ - "agentSpaceId", - "artifactId", - "artifact", - "fileName", - "updatedAt" - ], - "members":{ - "agentSpaceId":{ - "shape":"AgentSpaceId", - "documentation":"

The unique identifier of the agent space that contains the artifact.

" - }, - "artifactId":{ - "shape":"ArtifactId", - "documentation":"

The unique identifier of the artifact.

" - }, - "artifact":{ - "shape":"Artifact", - "documentation":"

The artifact content and type.

" - }, - "fileName":{ - "shape":"String", - "documentation":"

The file name of the artifact.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the artifact was last updated, in UTC format.

" - } - } - }, - "GetIntegrationInput":{ - "type":"structure", - "required":["integrationId"], - "members":{ - "integrationId":{ - "shape":"IntegrationId", - "documentation":"

The unique identifier of the integration to retrieve.

" - } - } - }, - "GetIntegrationOutput":{ - "type":"structure", - "required":[ - "integrationId", - "installationId", - "provider", - "providerType" - ], - "members":{ - "integrationId":{ - "shape":"IntegrationId", - "documentation":"

The unique identifier of the integration.

" - }, - "installationId":{ - "shape":"String", - "documentation":"

The installation identifier from the integration provider.

" - }, - "provider":{ - "shape":"Provider", - "documentation":"

The integration provider.

" - }, - "providerType":{ - "shape":"ProviderType", - "documentation":"

The type of the integration provider.

" - }, - "displayName":{ - "shape":"String", - "documentation":"

The display name of the integration.

" - }, - "kmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The identifier of the AWS KMS key used to encrypt data associated with the integration.

" - }, - "targetUrl":{ - "shape":"TargetUrl", - "documentation":"

The HTTPS URL of the customer self-hosted instance, such as a GitHub Enterprise Server or self-managed GitLab instance. This value is absent for SaaS integrations.

" - }, - "privateConnectionName":{ - "shape":"PrivateConnectionName", - "documentation":"

The name of the private connection used to reach the integration's self-hosted instance over private networking, if one is configured.

" - } - } - }, - "GetSecurityRequirementPackInput":{ - "type":"structure", - "required":["packId"], - "members":{ - "packId":{ - "shape":"SecurityRequirementPackId", - "documentation":"

The unique identifier of the security requirement pack to retrieve.

" - } - } - }, - "GetSecurityRequirementPackOutput":{ - "type":"structure", - "required":[ - "packId", - "name", - "managementType", - "status", - "createdAt", - "updatedAt" - ], - "members":{ - "packId":{ - "shape":"SecurityRequirementPackId", - "documentation":"

The unique identifier of the security requirement pack.

" - }, - "name":{ - "shape":"SecurityRequirementPackName", - "documentation":"

The name of the security requirement pack.

" - }, - "description":{ - "shape":"String", - "documentation":"

A description of the security requirement pack.

" - }, - "vendorName":{ - "shape":"String", - "documentation":"

The vendor name for AWS managed packs, such as ISO or NIST.

" - }, - "managementType":{ - "shape":"ManagementType", - "documentation":"

The management type of the pack. Valid values are AWS_MANAGED and CUSTOMER_MANAGED.

" - }, - "status":{ - "shape":"SecurityRequirementPackStatus", - "documentation":"

The status of the security requirement pack.

" - }, - "importStatus":{ - "shape":"SecurityRequirementPackImportStatus", - "documentation":"

The status of the security requirements import workflow for this pack.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the security requirement pack was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the security requirement pack was last updated, in UTC format.

" - }, - "kmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"

The identifier of the AWS KMS key used to encrypt pack contents.

" - } - } - }, - "GitHubIntegrationInput":{ - "type":"structure", - "required":[ - "code", - "state" - ], - "members":{ - "code":{ - "shape":"AuthCode", - "documentation":"

The OAuth authorization code received from GitHub.

" - }, - "state":{ - "shape":"CsrfState", - "documentation":"

The CSRF state token for validating the OAuth flow.

" - }, - "organizationName":{ - "shape":"String", - "documentation":"

The name of the GitHub organization to integrate with.

" - }, - "targetUrl":{ - "shape":"TargetUrl", - "documentation":"

The HTTPS URL of a self-hosted GitHub Enterprise Server instance. Omit this value for GitHub.com.

" - }, - "installationId":{ - "shape":"String", - "documentation":"

The installation identifier provided by GitHub Enterprise Server on the install callback. Required for GitHub Enterprise Server integrations and ignored for GitHub.com.

" - } - }, - "documentation":"

The input required to create a GitHub integration, including the OAuth authorization code and CSRF state.

" - }, - "GitHubOwner":{ - "type":"string", - "documentation":"

Name of the GitHub Account or Organization.

" - }, - "GitHubRepositoryMetadata":{ - "type":"structure", - "required":[ - "name", - "providerResourceId", - "owner" - ], - "members":{ - "name":{ - "shape":"ProviderResourceName", - "documentation":"

The name of the GitHub repository.

" - }, - "providerResourceId":{ - "shape":"ProviderResourceId", - "documentation":"

The provider-specific resource identifier for the GitHub repository.

" - }, - "owner":{ - "shape":"GitHubOwner", - "documentation":"

The owner of the GitHub repository.

" - }, - "accessType":{ - "shape":"AccessType", - "documentation":"

The access type of the GitHub repository. Valid values are PRIVATE and PUBLIC.

" - } - }, - "documentation":"

Contains metadata about a GitHub repository that is integrated with the service.

" - }, - "GitHubRepositoryResource":{ - "type":"structure", - "required":[ - "name", - "owner" - ], - "members":{ - "name":{ - "shape":"ProviderResourceName", - "documentation":"

The name of the GitHub repository.

" - }, - "owner":{ - "shape":"GitHubOwner", - "documentation":"

The owner of the GitHub repository.

" - } - }, - "documentation":"

Represents a GitHub repository resource used in an integration.

" - }, - "GitHubResourceCapabilities":{ - "type":"structure", - "members":{ - "leaveComments":{ - "shape":"Boolean", - "documentation":"

Indicates whether the integration can leave comments on pull requests.

" - }, - "remediateCode":{ - "shape":"Boolean", - "documentation":"

Indicates whether the integration can create code remediation pull requests.

" - } - }, - "documentation":"

The capabilities enabled for a GitHub resource integration.

" - }, - "GitLabIntegrationInput":{ - "type":"structure", - "required":[ - "accessToken", - "tokenType" - ], - "members":{ - "accessToken":{ - "shape":"AccessToken", - "documentation":"

The GitLab access token used to authenticate. This can be a personal access token or a group access token.

" - }, - "targetUrl":{ - "shape":"TargetUrl", - "documentation":"

The HTTPS URL of a self-managed GitLab instance. Omit this value for GitLab SaaS (gitlab.com).

" - }, - "tokenType":{ - "shape":"GitLabTokenType", - "documentation":"

The type of GitLab access token provided in accessToken.

" - }, - "groupId":{ - "shape":"String", - "documentation":"

The identifier of the GitLab group. Required when tokenType is group and ignored for personal tokens.

" - } - }, - "documentation":"

The configuration for creating a GitLab integration.

" - }, - "GitLabNamespace":{ - "type":"string", - "documentation":"

A GitLab namespace (group or user path).

" - }, - "GitLabRepositoryMetadata":{ - "type":"structure", - "required":[ - "name", - "providerResourceId", - "namespace" - ], - "members":{ - "name":{"shape":"ProviderResourceName"}, - "providerResourceId":{"shape":"ProviderResourceId"}, - "namespace":{ - "shape":"GitLabNamespace", - "documentation":"

The namespace (group or user path) that owns the project.

" - }, - "accessType":{"shape":"AccessType"} - }, - "documentation":"

Metadata for an integrated GitLab repository.

" - }, - "GitLabRepositoryResource":{ - "type":"structure", - "required":[ - "name", - "namespace" - ], - "members":{ - "name":{"shape":"ProviderResourceName"}, - "namespace":{ - "shape":"GitLabNamespace", - "documentation":"

The namespace (group or user path) that owns the project.

" - } - }, - "documentation":"

A GitLab repository integrated as a resource.

" - }, - "GitLabResourceCapabilities":{ - "type":"structure", - "members":{ - "leaveComments":{ - "shape":"Boolean", - "documentation":"

Whether to post code review comments on merge request discussions.

" - }, - "remediateCode":{ - "shape":"Boolean", - "documentation":"

Whether to create merge requests with automated fixes.

" - } - }, - "documentation":"

Capabilities for an integrated GitLab repository.

" - }, - "GitLabTokenType":{ - "type":"string", - "documentation":"

The type of GitLab access token.

", - "enum":[ - "PERSONAL", - "GROUP" - ] - }, - "HostAddress":{ - "type":"string", - "documentation":"

The IP address or DNS name of a target resource.

" - }, - "HttpVerification":{ - "type":"structure", - "members":{ - "token":{ - "shape":"String", - "documentation":"

The verification token to serve at the specified route path.

" - }, - "routePath":{ - "shape":"String", - "documentation":"

The HTTP route path where the verification token must be served.

" - } - }, - "documentation":"

Contains HTTP route verification details for a target domain, including the route path and token to serve for domain ownership verification.

" - }, - "IamRoles":{ - "type":"list", - "member":{"shape":"ServiceRole"} - }, - "IdCApplicationArn":{ - "type":"string", - "documentation":"

ARN of the IAM Identity Center application associated with this application.

" - }, - "IdCConfiguration":{ - "type":"structure", - "members":{ - "idcApplicationArn":{ - "shape":"IdCApplicationArn", - "documentation":"

The Amazon Resource Name (ARN) of the IAM Identity Center application.

" - }, - "idcInstanceArn":{ - "shape":"IdCInstanceArn", - "documentation":"

The Amazon Resource Name (ARN) of the IAM Identity Center instance.

" - } - }, - "documentation":"

The IAM Identity Center configuration for an application.

" - }, - "IdCInstanceArn":{ - "type":"string", - "documentation":"

ARN of the IAM Identity Center instance used for user authentication.

" - }, - "ImportSecurityRequirementsInput":{ - "type":"structure", - "required":[ - "packId", - "input" - ], - "members":{ - "packId":{ - "shape":"SecurityRequirementPackId", - "documentation":"

The unique identifier of the security requirement pack to import requirements into.

" - }, - "input":{ - "shape":"ImportSource", - "documentation":"

The import source containing the documents to extract security requirements from.

" - } - } - }, - "ImportSecurityRequirementsOutput":{ - "type":"structure", - "required":[ - "packId", - "importStatus" - ], - "members":{ - "packId":{ - "shape":"SecurityRequirementPackId", - "documentation":"

The unique identifier of the security requirement pack.

" - }, - "importStatus":{ - "shape":"SecurityRequirementPackImportStatus", - "documentation":"

The status of the import workflow.

" - } - } - }, - "ImportSource":{ - "type":"structure", - "members":{ - "documents":{ - "shape":"SecurityRequirementArtifactList", - "documentation":"

The list of documents to extract security requirements from.

" - } - }, - "documentation":"

The source from which to import security requirements. Currently supports document uploads.

", - "union":true - }, - "InitiateProviderRegistrationInput":{ - "type":"structure", - "required":["provider"], - "members":{ - "provider":{ - "shape":"Provider", - "documentation":"

The provider to initiate registration with. Currently, only GITHUB is supported.

" - } - } - }, - "InitiateProviderRegistrationOutput":{ - "type":"structure", - "required":[ - "redirectTo", - "csrfState" - ], - "members":{ - "redirectTo":{ - "shape":"Location", - "documentation":"

The URL to redirect the user to for completing the OAuth authorization.

" - }, - "csrfState":{ - "shape":"CsrfState", - "documentation":"

The CSRF state token to use when completing the OAuth flow.

" - } - } - }, - "Integer":{ - "type":"integer", - "box":true - }, - "IntegratedDocument":{ - "type":"structure", - "required":[ - "integrationId", - "resourceId" - ], - "members":{ - "integrationId":{ - "shape":"String", - "documentation":"

The identifier of the integration that provides access to the document.

" - }, - "resourceId":{ - "shape":"String", - "documentation":"

The provider-specific resource identifier for the document.

" - } - }, - "documentation":"

A reference to a document in a third-party provider, such as a Confluence page linked via an integration.

" - }, - "IntegratedRepository":{ - "type":"structure", - "required":[ - "integrationId", - "providerResourceId" - ], - "members":{ - "integrationId":{ - "shape":"String", - "documentation":"

The unique identifier of the integration that provides access to the repository.

" - }, - "providerResourceId":{ - "shape":"String", - "documentation":"

The provider-specific resource identifier for the repository.

" - }, - "branch":{ - "shape":"String", - "documentation":"

An optional override for the repository branch.

" - } - }, - "documentation":"

Represents a code repository that is integrated with the service through a third-party provider.

" - }, - "IntegratedRepositoryList":{ - "type":"list", - "member":{"shape":"IntegratedRepository"} - }, - "IntegratedResource":{ - "type":"structure", - "members":{ - "githubRepository":{ - "shape":"GitHubRepositoryResource", - "documentation":"

The GitHub repository resource information.

" - }, - "gitlabRepository":{"shape":"GitLabRepositoryResource"}, - "bitbucketRepository":{"shape":"BitbucketRepositoryResource"}, - "confluenceDocument":{"shape":"ConfluenceDocumentResource"} - }, - "documentation":"

Represents an integrated resource from a third-party provider. This is a union type that contains provider-specific resource information.

", - "union":true - }, - "IntegratedResourceInputItem":{ - "type":"structure", - "required":["resource"], - "members":{ - "resource":{ - "shape":"IntegratedResource", - "documentation":"

The integrated resource to update.

" - }, - "capabilities":{ - "shape":"ProviderResourceCapabilities", - "documentation":"

The capabilities to enable for the integrated resource.

" - } - }, - "documentation":"

Represents an input item for updating integrated resources, including the resource and its capabilities.

" - }, - "IntegratedResourceInputItemList":{ - "type":"list", - "member":{"shape":"IntegratedResourceInputItem"}, - "documentation":"

List of integrated resources.

" - }, - "IntegratedResourceMetadata":{ - "type":"structure", - "members":{ - "githubRepository":{ - "shape":"GitHubRepositoryMetadata", - "documentation":"

The GitHub repository metadata.

" - }, - "gitlabRepository":{"shape":"GitLabRepositoryMetadata"}, - "bitbucketRepository":{"shape":"BitbucketRepositoryMetadata"}, - "confluenceDocument":{"shape":"ConfluenceDocumentMetadata"} - }, - "documentation":"

Contains metadata about an integrated resource. This is a union type that contains provider-specific metadata.

", - "union":true - }, - "IntegratedResourceSummary":{ - "type":"structure", - "required":[ - "integrationId", - "resource" - ], - "members":{ - "integrationId":{ - "shape":"IntegrationId", - "documentation":"

The unique identifier of the integration that provides access to the resource.

" - }, - "resource":{ - "shape":"IntegratedResourceMetadata", - "documentation":"

The metadata for the integrated resource.

" - }, - "capabilities":{ - "shape":"ProviderResourceCapabilities", - "documentation":"

The capabilities enabled for the integrated resource.

" - } - }, - "documentation":"

Contains summary information about an integrated resource.

" - }, - "IntegratedResourceSummaryList":{ - "type":"list", - "member":{"shape":"IntegratedResourceSummary"}, - "documentation":"

List of integrated resource items.

" - }, - "IntegrationFilter":{ - "type":"structure", - "members":{ - "provider":{ - "shape":"Provider", - "documentation":"

Filter integrations by provider.

" - }, - "providerType":{ - "shape":"ProviderType", - "documentation":"

Filter integrations by provider type.

" - } - }, - "documentation":"

A filter for listing integrations. This is a union type where you can filter by provider or provider type.

", - "union":true - }, - "IntegrationId":{ - "type":"string", - "documentation":"

Unique identifier for an integration.

" - }, - "IntegrationSummary":{ - "type":"structure", - "required":[ - "integrationId", - "installationId", - "provider", - "providerType", - "displayName" - ], - "members":{ - "integrationId":{ - "shape":"String", - "documentation":"

The unique identifier of the integration.

" - }, - "installationId":{ - "shape":"String", - "documentation":"

The installation identifier from the integration provider.

" - }, - "provider":{ - "shape":"Provider", - "documentation":"

The integration provider.

" - }, - "providerType":{ - "shape":"ProviderType", - "documentation":"

The type of the integration provider.

" - }, - "displayName":{ - "shape":"String", - "documentation":"

The display name of the integration.

" - }, - "targetUrl":{ - "shape":"TargetUrl", - "documentation":"

The HTTPS URL of the customer self-hosted instance, such as a GitHub Enterprise Server or self-managed GitLab instance. This value is absent for SaaS integrations.

" - }, - "privateConnectionName":{ - "shape":"PrivateConnectionName", - "documentation":"

The name of the private connection used to reach the integration's self-hosted instance over private networking, if one is configured.

" - } - }, - "documentation":"

Contains summary information about an integration.

" - }, - "IntegrationSummaryList":{ - "type":"list", - "member":{"shape":"IntegrationSummary"}, - "documentation":"

List of integration summaries.

" - }, - "InternalServerException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{ - "shape":"String", - "documentation":"

Error description.

" - } - }, - "documentation":"

An unexpected error occurred during the processing of your request.

", - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true - }, - "IpAddressType":{ - "type":"string", - "documentation":"

The IP address type of a resource gateway.

", - "enum":[ - "IPV4", - "IPV6", - "DUAL_STACK" - ] - }, - "JobStatus":{ - "type":"string", - "documentation":"

Status of a pentest job.

", - "enum":[ - "IN_PROGRESS", - "STOPPING", - "STOPPED", - "FAILED", - "COMPLETED" - ] - }, - "KmsKeyId":{ - "type":"string", - "documentation":"

Identifier of a KMS key. Can be a key ID, key ARN, alias name, or alias ARN.

" - }, - "LambdaFunctionArn":{ - "type":"string", - "documentation":"

Lambda function ARN or name for agent space AWS resources.

" - }, - "LambdaFunctionArns":{ - "type":"list", - "member":{"shape":"LambdaFunctionArn"} - }, - "ListAgentSpacesInput":{ - "type":"structure", - "members":{ - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return in a single call.

" - } - }, - "documentation":"

Input for listing agent spaces.

" - }, - "ListAgentSpacesOutput":{ - "type":"structure", - "members":{ - "agentSpaceSummaries":{ - "shape":"AgentSpaceSummaryList", - "documentation":"

The list of agent space summaries.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

" - } - }, - "documentation":"

Output for the ListAgentSpaces operation.

" - }, - "ListApplicationsRequest":{ - "type":"structure", - "members":{ - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return in a single call.

" - } - } - }, - "ListApplicationsResponse":{ - "type":"structure", - "required":["applicationSummaries"], - "members":{ - "applicationSummaries":{ - "shape":"ApplicationSummaryList", - "documentation":"

The list of application summaries.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

" - } - } - }, - "ListArtifactsInput":{ - "type":"structure", - "required":["agentSpaceId"], - "members":{ - "agentSpaceId":{ - "shape":"AgentSpaceId", - "documentation":"

The unique identifier of the agent space to list artifacts for.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return in a single call.

" - } - } - }, - "ListArtifactsOutput":{ - "type":"structure", - "required":["artifactSummaries"], - "members":{ - "artifactSummaries":{ - "shape":"ArtifactSummaryList", - "documentation":"

The list of artifact summaries.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

" - } - } - }, - "ListCodeReviewJobTasksInput":{ - "type":"structure", - "required":["agentSpaceId"], - "members":{ - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space.

" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return in a single call.

" - }, - "codeReviewJobId":{ - "shape":"String", - "documentation":"

The unique identifier of the code review job to list tasks for.

" - }, - "stepName":{ - "shape":"StepName", - "documentation":"

Filter tasks by step name.

" - }, - "categoryName":{ - "shape":"String", - "documentation":"

Filter tasks by category name.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

" - } - }, - "documentation":"

Input for listing tasks associated with a code review job.

" - }, - "ListCodeReviewJobTasksOutput":{ - "type":"structure", - "members":{ - "codeReviewJobTaskSummaries":{ - "shape":"CodeReviewJobTaskSummaryList", - "documentation":"

The list of code review job task summaries.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

" - } - }, - "documentation":"

Output for the ListCodeReviewJobTasks operation.

" - }, - "ListCodeReviewJobsForCodeReviewInput":{ - "type":"structure", - "required":[ - "codeReviewId", - "agentSpaceId" - ], - "members":{ - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return in a single call.

" - }, - "codeReviewId":{ - "shape":"String", - "documentation":"

The unique identifier of the code review to list jobs for.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

" - } - }, - "documentation":"

Input for ListCodeReviewJobsForCodeReview operation.

" - }, - "ListCodeReviewJobsForCodeReviewOutput":{ - "type":"structure", - "members":{ - "codeReviewJobSummaries":{ - "shape":"CodeReviewJobSummaryList", - "documentation":"

The list of code review job summaries.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

" - } - }, - "documentation":"

Output for the ListCodeReviewJobsForCodeReview operation.

" - }, - "ListCodeReviewsInput":{ - "type":"structure", - "required":["agentSpaceId"], - "members":{ - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return in a single call.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space to list code reviews for.

" - } - }, - "documentation":"

Input for listing code reviews with optional filtering.

" - }, - "ListCodeReviewsOutput":{ - "type":"structure", - "members":{ - "codeReviewSummaries":{ - "shape":"CodeReviewSummaryList", - "documentation":"

The list of code review summaries.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

" - } - }, - "documentation":"

Output for the ListCodeReviews operation.

" - }, - "ListDiscoveredEndpointsInput":{ - "type":"structure", - "required":[ - "pentestJobId", - "agentSpaceId" - ], - "members":{ - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return in a single call.

" - }, - "pentestJobId":{ - "shape":"String", - "documentation":"

The unique identifier of the pentest job to list discovered endpoints for.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space.

" - }, - "prefix":{ - "shape":"String", - "documentation":"

A prefix to filter discovered endpoints by URI.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

" - } - }, - "documentation":"

Input for ListDiscoveredEndpoints operation.

" - }, - "ListDiscoveredEndpointsOutput":{ - "type":"structure", - "members":{ - "discoveredEndpoints":{ - "shape":"DiscoveredEndpointList", - "documentation":"

The list of discovered endpoints.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

" - } - }, - "documentation":"

Output for the ListDiscoveredEndpoints operation.

" - }, - "ListFindingsInput":{ - "type":"structure", - "required":["agentSpaceId"], - "members":{ - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return in a single call.

" - }, - "pentestJobId":{ - "shape":"String", - "documentation":"

The unique identifier of the pentest job to list findings for.

" - }, - "codeReviewJobId":{ - "shape":"String", - "documentation":"

The unique identifier of the code review job to list findings for. Mutually exclusive with pentestJobId.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

" - }, - "riskType":{ - "shape":"String", - "documentation":"

Filter findings by risk type.

" - }, - "riskLevel":{ - "shape":"RiskLevel", - "documentation":"

Filter findings by risk level.

" - }, - "status":{ - "shape":"FindingStatus", - "documentation":"

Filter findings by status.

" - }, - "confidence":{ - "shape":"ConfidenceLevel", - "documentation":"

Filter findings by confidence level.

" - }, - "name":{ - "shape":"String", - "documentation":"

Filter findings by name.

" - } - }, - "documentation":"

Input for ListFindings operation with filtering support.

" - }, - "ListFindingsOutput":{ - "type":"structure", - "members":{ - "findingsSummaries":{ - "shape":"FindingSummaryList", - "documentation":"

The list of finding summaries.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

" - } - }, - "documentation":"

Output for the ListFindings operation.

" - }, - "ListIntegratedResourcesInput":{ - "type":"structure", - "required":["agentSpaceId"], - "members":{ - "agentSpaceId":{ - "shape":"AgentSpaceId", - "documentation":"

The unique identifier of the agent space to list integrated resources for.

" - }, - "integrationId":{ - "shape":"IntegrationId", - "documentation":"

The unique identifier of the integration to filter by.

" - }, - "resourceType":{ - "shape":"ResourceType", - "documentation":"

The type of resource to filter by.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return in a single call.

" - } - } - }, - "ListIntegratedResourcesOutput":{ - "type":"structure", - "required":["integratedResourceSummaries"], - "members":{ - "integratedResourceSummaries":{ - "shape":"IntegratedResourceSummaryList", - "documentation":"

The list of integrated resource summaries.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

" - } - } - }, - "ListIntegrationsInput":{ - "type":"structure", - "members":{ - "filter":{ - "shape":"IntegrationFilter", - "documentation":"

A filter to apply to the list of integrations.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return in a single call.

" - } - } - }, - "ListIntegrationsOutput":{ - "type":"structure", - "required":["integrationSummaries"], - "members":{ - "integrationSummaries":{ - "shape":"IntegrationSummaryList", - "documentation":"

The list of integration summaries.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

" - } - } - }, - "ListMembershipsRequest":{ - "type":"structure", - "required":[ - "applicationId", - "agentSpaceId" - ], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "documentation":"

The unique identifier of the application that contains the agent space.

" - }, - "agentSpaceId":{ - "shape":"AgentSpaceId", - "documentation":"

The unique identifier of the agent space to list memberships for.

" - }, - "memberType":{ - "shape":"MembershipTypeFilter", - "documentation":"

Filter memberships by member type.

" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return in a single call.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

" - } - }, - "documentation":"

Request structure for listing agent space members.

" - }, - "ListMembershipsResponse":{ - "type":"structure", - "required":["membershipSummaries"], - "members":{ - "membershipSummaries":{ - "shape":"MembershipSummaryList", - "documentation":"

The list of membership summaries.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

" - } - }, - "documentation":"

Response structure for listing members associated to an agent space.

" - }, - "ListPentestJobTasksInput":{ - "type":"structure", - "required":["agentSpaceId"], - "members":{ - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space.

" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return in a single call.

" - }, - "pentestJobId":{ - "shape":"String", - "documentation":"

The unique identifier of the pentest job to list tasks for.

" - }, - "stepName":{ - "shape":"StepName", - "documentation":"

Filter tasks by step name. Valid values include PREFLIGHT, STATIC_ANALYSIS, PENTEST, VALIDATION, and FINALIZING.

" - }, - "categoryName":{ - "shape":"String", - "documentation":"

Filter tasks by category name.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

" - } - }, - "documentation":"

Input for listing tasks associated with a pentest job.

" - }, - "ListPentestJobTasksOutput":{ - "type":"structure", - "members":{ - "taskSummaries":{ - "shape":"TaskSummaryList", - "documentation":"

The list of task summaries.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

" - } - }, - "documentation":"

Output for the ListPentestJobTasks operation.

" - }, - "ListPentestJobsForPentestInput":{ - "type":"structure", - "required":[ - "pentestId", - "agentSpaceId" - ], - "members":{ - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return in a single call.

" - }, - "pentestId":{ - "shape":"String", - "documentation":"

The unique identifier of the pentest to list jobs for.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

" - } - }, - "documentation":"

Input for ListPentestJobsForPentest operation.

" - }, - "ListPentestJobsForPentestOutput":{ - "type":"structure", - "members":{ - "pentestJobSummaries":{ - "shape":"PentestJobSummaryList", - "documentation":"

The list of pentest job summaries.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

" - } - }, - "documentation":"

Output for the ListPentestJobsForPentest operation.

" - }, - "ListPentestsInput":{ - "type":"structure", - "required":["agentSpaceId"], - "members":{ - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return in a single call.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space to list pentests for.

" - } - }, - "documentation":"

Input for listing pentests with optional filtering.

" - }, - "ListPentestsOutput":{ - "type":"structure", - "members":{ - "pentestSummaries":{ - "shape":"PentestSummaryList", - "documentation":"

The list of pentest summaries.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

" - } - }, - "documentation":"

Output for the ListPentests operation.

" - }, - "ListPrivateConnectionsInput":{ - "type":"structure", - "members":{ - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of private connections to return in a single response.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

The token for the next page of results.

" - } - } - }, - "ListPrivateConnectionsOutput":{ - "type":"structure", - "required":["privateConnections"], - "members":{ - "privateConnections":{ - "shape":"PrivateConnectionList", - "documentation":"

The list of private connections.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

The token to use to retrieve the next page of results, if more results are available.

" - } - } - }, - "ListSecurityRequirementPackFilter":{ - "type":"structure", - "members":{ - "managementType":{ - "shape":"ManagementType", - "documentation":"

Filter packs by management type. Valid values are AWS_MANAGED and CUSTOMER_MANAGED.

" - }, - "status":{ - "shape":"SecurityRequirementPackStatus", - "documentation":"

Filter packs by status. Valid values are ENABLED and DISABLED.

" - } - }, - "documentation":"

Filter criteria for listing security requirement packs.

" - }, - "ListSecurityRequirementPacksInput":{ - "type":"structure", - "members":{ - "filter":{ - "shape":"ListSecurityRequirementPackFilter", - "documentation":"

The filter criteria for listing security requirement packs.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

The pagination token from a previous request to retrieve the next page of results.

" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return in a single request.

" - } - } - }, - "ListSecurityRequirementPacksOutput":{ - "type":"structure", - "required":["securityRequirementPackSummaries"], - "members":{ - "securityRequirementPackSummaries":{ - "shape":"SecurityRequirementPackSummaryList", - "documentation":"

The list of security requirement pack summaries.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

The pagination token to use in a subsequent request to retrieve the next page of results.

" - } - } - }, - "ListSecurityRequirementsInput":{ - "type":"structure", - "required":["packId"], - "members":{ - "packId":{ - "shape":"SecurityRequirementPackId", - "documentation":"

The unique identifier of the security requirement pack to list requirements for.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

The pagination token from a previous request to retrieve the next page of results.

" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return in a single request.

" - } - } - }, - "ListSecurityRequirementsOutput":{ - "type":"structure", - "required":["securityRequirementSummaries"], - "members":{ - "securityRequirementSummaries":{ - "shape":"SecurityRequirementSummaryList", - "documentation":"

The list of security requirement summaries.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

The pagination token to use in a subsequent request to retrieve the next page of results.

" - } - } - }, - "ListTagsForResourceInput":{ - "type":"structure", - "required":["resourceArn"], - "members":{ - "resourceArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the resource to list tags for.

", - "location":"uri", - "locationName":"resourceArn" - } - }, - "documentation":"

Input for ListTagsForResource operation.

" - }, - "ListTagsForResourceOutput":{ - "type":"structure", - "members":{ - "tags":{ - "shape":"TagMap", - "documentation":"

The tags associated with the resource.

" - } - }, - "documentation":"

Output for ListTagsForResource operation.

" - }, - "ListTargetDomainsInput":{ - "type":"structure", - "members":{ - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return in a single call.

" - } - }, - "documentation":"

Input for listing target domains.

" - }, - "ListTargetDomainsOutput":{ - "type":"structure", - "members":{ - "targetDomainSummaries":{ - "shape":"TargetDomainSummaryList", - "documentation":"

The list of target domain summaries.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

" - } - }, - "documentation":"

Output for the ListTargetDomains operation.

" - }, - "ListThreatModelJobTasksInput":{ - "type":"structure", - "required":[ - "agentSpaceId", - "threatModelJobId" - ], - "members":{ - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space.

" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return in a single call.

" - }, - "threatModelJobId":{ - "shape":"String", - "documentation":"

The unique identifier of the threat model job to list tasks for.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to use for paginating results that are returned in the response.

" - } - }, - "documentation":"

Input for listing tasks associated with a threat model job.

" - }, - "ListThreatModelJobTasksOutput":{ - "type":"structure", - "members":{ - "threatModelJobTaskSummaries":{ - "shape":"ThreatModelJobTaskSummaryList", - "documentation":"

The list of threat model job task summaries.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to use for paginating results that are returned in the response.

" - } - }, - "documentation":"

Output for the ListThreatModelJobTasks operation.

" - }, - "ListThreatModelJobsInput":{ - "type":"structure", - "required":[ - "threatModelId", - "agentSpaceId" - ], - "members":{ - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return in a single call.

" - }, - "threatModelId":{ - "shape":"String", - "documentation":"

The unique identifier of the threat model to list jobs for.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to use for paginating results that are returned in the response.

" - } - }, - "documentation":"

Input for ListThreatModelJobs operation.

" - }, - "ListThreatModelJobsOutput":{ - "type":"structure", - "members":{ - "threatModelJobSummaries":{ - "shape":"ThreatModelJobSummaryList", - "documentation":"

The list of threat model job summaries.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to use for paginating results that are returned in the response.

" - } - }, - "documentation":"

Output for the ListThreatModelJobs operation.

" - }, - "ListThreatModelsInput":{ - "type":"structure", - "required":["agentSpaceId"], - "members":{ - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return in a single call.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to use for paginating results that are returned in the response.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space to list threat models for.

" - } - }, - "documentation":"

Input for listing threat models.

" - }, - "ListThreatModelsOutput":{ - "type":"structure", - "members":{ - "threatModelSummaries":{ - "shape":"ThreatModelSummaryList", - "documentation":"

The list of threat model summaries.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to use for paginating results that are returned in the response.

" - } - }, - "documentation":"

Output for the ListThreatModels operation.

" - }, - "ListThreatsInput":{ - "type":"structure", - "required":[ - "threatJobId", - "agentSpaceId" - ], - "members":{ - "threatJobId":{ - "shape":"String", - "documentation":"

The unique identifier of the threat model job to list threats for.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to use for paginating results that are returned in the response.

" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"

The maximum number of results to return in a single call.

" - } - }, - "documentation":"

Input for listing threats.

" - }, - "ListThreatsOutput":{ - "type":"structure", - "members":{ - "threats":{ - "shape":"ThreatSummaryList", - "documentation":"

The list of threat summaries.

" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"

A token to use for paginating results that are returned in the response.

" - } - }, - "documentation":"

Output for the ListThreats operation.

" - }, - "Location":{ - "type":"string", - "documentation":"

Location URL for OAuth redirect.

" - }, - "LogGroupArn":{ - "type":"string", - "documentation":"

Log group ARN or name for agent space AWS resources.

" - }, - "LogGroupArns":{ - "type":"list", - "member":{"shape":"LogGroupArn"} - }, - "LogLocation":{ - "type":"structure", - "members":{ - "logType":{ - "shape":"LogType", - "documentation":"

The type of log storage. Currently, only CLOUDWATCH is supported.

" - }, - "cloudWatchLog":{ - "shape":"CloudWatchLog", - "documentation":"

The CloudWatch Logs location for the task logs.

" - } - }, - "documentation":"

The log location for a task, specifying where task execution logs are stored.

" - }, - "LogType":{ - "type":"string", - "documentation":"

Type of log storage.

", - "enum":["CLOUDWATCH"] - }, - "ManagementType":{ - "type":"string", - "enum":[ - "AWS_MANAGED", - "CUSTOMER_MANAGED" - ] - }, - "MaxIpv4AddressesPerEni":{ - "type":"integer", - "documentation":"

The number of IPv4 addresses in each elastic network interface for the resource gateway.

", - "box":true - }, - "MaxResults":{ - "type":"integer", - "documentation":"

Maximum results for pagination.

", - "box":true - }, - "MemberMetadata":{ - "type":"structure", - "members":{ - "user":{ - "shape":"UserMetadata", - "documentation":"

The user metadata for the member.

" - } - }, - "documentation":"

Contains metadata about a member. This is a union type that contains member-type-specific metadata.

", - "union":true - }, - "MembershipConfig":{ - "type":"structure", - "members":{ - "user":{ - "shape":"UserConfig", - "documentation":"

The user configuration for the membership.

" - } - }, - "documentation":"

The configuration for a membership. This is a union type that contains member-type-specific configuration.

", - "union":true - }, - "MembershipId":{ - "type":"string", - "documentation":"

Member identifier.

" - }, - "MembershipSummary":{ - "type":"structure", - "required":[ - "membershipId", - "applicationId", - "agentSpaceId", - "memberType", - "createdAt", - "updatedAt", - "createdBy", - "updatedBy" - ], - "members":{ - "membershipId":{ - "shape":"MembershipId", - "documentation":"

The unique identifier of the membership.

" - }, - "applicationId":{ - "shape":"ApplicationId", - "documentation":"

The unique identifier of the application.

" - }, - "agentSpaceId":{ - "shape":"AgentSpaceId", - "documentation":"

The unique identifier of the agent space.

" - }, - "memberType":{ - "shape":"MembershipType", - "documentation":"

The type of member.

" - }, - "config":{ - "shape":"MembershipConfig", - "documentation":"

The configuration for the membership.

" - }, - "metadata":{ - "shape":"MemberMetadata", - "documentation":"

The metadata for the member.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the membership was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the membership was last updated, in UTC format.

" - }, - "createdBy":{ - "shape":"String", - "documentation":"

The identifier of the entity that created the membership.

" - }, - "updatedBy":{ - "shape":"String", - "documentation":"

The identifier of the entity that last updated the membership.

" - } - }, - "documentation":"

Contains summary information about a membership.

" - }, - "MembershipSummaryList":{ - "type":"list", - "member":{"shape":"MembershipSummary"}, - "documentation":"

List of membership summaries.

" - }, - "MembershipType":{ - "type":"string", - "documentation":"

Type of membership.

", - "enum":["USER"] - }, - "MembershipTypeFilter":{ - "type":"string", - "documentation":"

Filter for member type in list operations.

", - "enum":[ - "USER", - "ALL" - ] - }, - "NetworkTrafficConfig":{ - "type":"structure", - "members":{ - "rules":{ - "shape":"NetworkTrafficRuleList", - "documentation":"

The list of network traffic rules that control which URLs are allowed or denied during testing.

" - }, - "customHeaders":{ - "shape":"CustomHeaderList", - "documentation":"

The list of custom HTTP headers to include in network traffic during testing.

" - } - }, - "documentation":"

The network traffic configuration for a pentest, including custom headers and traffic rules.

" - }, - "NetworkTrafficRule":{ - "type":"structure", - "members":{ - "effect":{ - "shape":"NetworkTrafficRuleEffect", - "documentation":"

The effect of the rule. Valid values are ALLOW and DENY.

" - }, - "pattern":{ - "shape":"String", - "documentation":"

The URL pattern to match for the rule.

" - }, - "networkTrafficRuleType":{ - "shape":"NetworkTrafficRuleType", - "documentation":"

The type of the network traffic rule. Currently, only URL is supported.

" - } - }, - "documentation":"

A rule that controls network traffic during penetration testing by allowing or denying traffic to specific URL patterns.

" - }, - "NetworkTrafficRuleEffect":{ - "type":"string", - "documentation":"

Effect of a network traffic rule.

", - "enum":[ - "ALLOW", - "DENY" - ] - }, - "NetworkTrafficRuleList":{ - "type":"list", - "member":{"shape":"NetworkTrafficRule"}, - "documentation":"

List of network traffic rules.

" - }, - "NetworkTrafficRuleType":{ - "type":"string", - "documentation":"

Type of network traffic rule.

", - "enum":["URL"] - }, - "NextToken":{ - "type":"string", - "documentation":"

Pagination token.

" - }, - "Pentest":{ - "type":"structure", - "required":[ - "pentestId", - "agentSpaceId", - "title", - "assets" - ], - "members":{ - "pentestId":{ - "shape":"String", - "documentation":"

The unique identifier of the pentest.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space that contains the pentest.

" - }, - "title":{ - "shape":"String", - "documentation":"

The title of the pentest.

" - }, - "assets":{ - "shape":"Assets", - "documentation":"

The assets included in the pentest.

" - }, - "excludeRiskTypes":{ - "shape":"RiskTypeList", - "documentation":"

The list of risk types excluded from the pentest.

" - }, - "serviceRole":{ - "shape":"ServiceRole", - "documentation":"

The IAM service role used for the pentest.

" - }, - "logConfig":{ - "shape":"CloudWatchLog", - "documentation":"

The CloudWatch Logs configuration for the pentest.

" - }, - "vpcConfig":{ - "shape":"VpcConfig", - "documentation":"

The VPC configuration for the pentest.

" - }, - "networkTrafficConfig":{ - "shape":"NetworkTrafficConfig", - "documentation":"

The network traffic configuration for the pentest.

" - }, - "codeRemediationStrategy":{ - "shape":"CodeRemediationStrategy", - "documentation":"

The code remediation strategy for the pentest.

" - }, - "cleanUpStrategy":{ - "shape":"CleanUpStrategy", - "documentation":"

Strategy for cleaning up resources after pentest job completion.

" - }, - "disableManagedSkills":{ - "shape":"SkillTypeList", - "documentation":"

A list of managed skills to disable for this pentest. Valid values include FINDING_PERSONALIZATION and LOGIN_OPTIMIZATION.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the pentest was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the pentest was last updated, in UTC format.

" - } - }, - "documentation":"

Represents a pentest configuration that defines the parameters for security testing, including target assets, risk type exclusions, and infrastructure settings.

" - }, - "PentestIdList":{ - "type":"list", - "member":{"shape":"String"} - }, - "PentestJob":{ - "type":"structure", - "members":{ - "pentestJobId":{ - "shape":"String", - "documentation":"

The unique identifier of the pentest job.

" - }, - "pentestId":{ - "shape":"String", - "documentation":"

The unique identifier of the pentest associated with the job.

" - }, - "title":{ - "shape":"String", - "documentation":"

The title of the pentest job.

" - }, - "overview":{ - "shape":"String", - "documentation":"

An overview of the pentest job results.

" - }, - "status":{ - "shape":"JobStatus", - "documentation":"

The current status of the pentest job.

" - }, - "endpoints":{ - "shape":"EndpointList", - "documentation":"

The list of endpoints being tested in the pentest job.

" - }, - "actors":{ - "shape":"ActorList", - "documentation":"

The list of actors used during the pentest job.

" - }, - "documents":{ - "shape":"DocumentList", - "documentation":"

The list of documents providing context for the pentest job.

" - }, - "sourceCode":{ - "shape":"SourceCodeRepositoryList", - "documentation":"

The list of source code repositories analyzed during the pentest job.

" - }, - "excludePaths":{ - "shape":"EndpointList", - "documentation":"

The list of paths excluded from the pentest job.

" - }, - "allowedDomains":{ - "shape":"EndpointList", - "documentation":"

The list of domains allowed during the pentest job.

" - }, - "excludeRiskTypes":{ - "shape":"RiskTypeList", - "documentation":"

The list of risk types excluded from the pentest job.

" - }, - "steps":{ - "shape":"StepList", - "documentation":"

The list of steps in the pentest job execution.

" - }, - "executionContext":{ - "shape":"ExecutionContextList", - "documentation":"

The execution context messages for the pentest job.

" - }, - "serviceRole":{ - "shape":"ServiceRole", - "documentation":"

The IAM service role used for the pentest job.

" - }, - "logConfig":{ - "shape":"CloudWatchLog", - "documentation":"

The CloudWatch Logs configuration for the pentest job.

" - }, - "vpcConfig":{ - "shape":"VpcConfig", - "documentation":"

The VPC configuration for the pentest job.

" - }, - "networkTrafficConfig":{ - "shape":"NetworkTrafficConfig", - "documentation":"

The network traffic configuration for the pentest job.

" - }, - "errorInformation":{ - "shape":"ErrorInformation", - "documentation":"

Error information if the pentest job encountered an error.

" - }, - "integratedRepositories":{ - "shape":"IntegratedRepositoryList", - "documentation":"

The list of integrated repositories associated with the pentest job.

" - }, - "codeRemediationStrategy":{ - "shape":"CodeRemediationStrategy", - "documentation":"

The code remediation strategy for the pentest job.

" - }, - "cleanUpStrategy":{ - "shape":"CleanUpStrategy", - "documentation":"

Strategy for cleaning up resources after pentest job completion.

" - }, - "disableManagedSkills":{ - "shape":"SkillTypeList", - "documentation":"

A list of managed skills disabled for this pentest job. Valid values include FINDING_PERSONALIZATION and LOGIN_OPTIMIZATION.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the pentest job was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the pentest job was last updated, in UTC format.

" - } - }, - "documentation":"

Represents a pentest job, which is an execution instance of a pentest. A pentest job progresses through preflight, static analysis, pentest, and finalizing steps.

" - }, - "PentestJobIdList":{ - "type":"list", - "member":{"shape":"String"} - }, - "PentestJobList":{ - "type":"list", - "member":{"shape":"PentestJob"} - }, - "PentestJobSummary":{ - "type":"structure", - "required":[ - "pentestJobId", - "pentestId" - ], - "members":{ - "pentestJobId":{ - "shape":"String", - "documentation":"

The unique identifier of the pentest job.

" - }, - "pentestId":{ - "shape":"String", - "documentation":"

The unique identifier of the pentest associated with the job.

" - }, - "title":{ - "shape":"String", - "documentation":"

The title of the pentest job.

" - }, - "status":{ - "shape":"JobStatus", - "documentation":"

The current status of the pentest job.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the pentest job was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the pentest job was last updated, in UTC format.

" - } - }, - "documentation":"

Contains summary information about a pentest job.

" - }, - "PentestJobSummaryList":{ - "type":"list", - "member":{"shape":"PentestJobSummary"} - }, - "PentestList":{ - "type":"list", - "member":{"shape":"Pentest"} - }, - "PentestSummary":{ - "type":"structure", - "required":[ - "pentestId", - "agentSpaceId", - "title" - ], - "members":{ - "pentestId":{ - "shape":"String", - "documentation":"

The unique identifier of the pentest.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space that contains the pentest.

" - }, - "title":{ - "shape":"String", - "documentation":"

The title of the pentest.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the pentest was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the pentest was last updated, in UTC format.

" - } - }, - "documentation":"

Contains summary information about a pentest.

" - }, - "PentestSummaryList":{ - "type":"list", - "member":{"shape":"PentestSummary"} - }, - "PortRange":{ - "type":"string", - "documentation":"

A single TCP port or an inclusive range of TCP ports, for example 443 or 8000-8100.

" - }, - "PortRanges":{ - "type":"list", - "member":{"shape":"PortRange"}, - "documentation":"

The TCP port ranges that a consumer can use to access the resource.

" - }, - "PrivateConnectionList":{ - "type":"list", - "member":{"shape":"PrivateConnectionSummary"}, - "documentation":"

A list of private connection summaries.

" - }, - "PrivateConnectionMode":{ - "type":"structure", - "members":{ - "serviceManaged":{ - "shape":"ServiceManagedInput", - "documentation":"

The configuration for a service-managed private connection, where the service manages the resource gateway lifecycle.

" - }, - "selfManaged":{ - "shape":"SelfManagedInput", - "documentation":"

The configuration for a self-managed private connection, where you manage your own resource configuration.

" - } - }, - "documentation":"

The configuration for a private connection. Specify either a service-managed or a self-managed mode.

", - "union":true - }, - "PrivateConnectionName":{ - "type":"string", - "documentation":"

The unique name of a private connection within your account.

" - }, - "PrivateConnectionSecurityGroupId":{ - "type":"string", - "documentation":"

The identifier of a security group.

" - }, - "PrivateConnectionSecurityGroupIds":{ - "type":"list", - "member":{"shape":"PrivateConnectionSecurityGroupId"}, - "documentation":"

The security groups attached to the resource gateway.

" - }, - "PrivateConnectionStatus":{ - "type":"string", - "documentation":"

The status of a private connection.

", - "enum":[ - "ACTIVE", - "CREATE_IN_PROGRESS", - "CREATE_FAILED", - "DELETE_IN_PROGRESS", - "DELETE_FAILED" - ] - }, - "PrivateConnectionSubnetId":{ - "type":"string", - "documentation":"

The identifier of a subnet.

" - }, - "PrivateConnectionSubnetIds":{ - "type":"list", - "member":{"shape":"PrivateConnectionSubnetId"}, - "documentation":"

The subnets that the resource gateway spans.

" - }, - "PrivateConnectionSummary":{ - "type":"structure", - "required":[ - "name", - "type", - "status" - ], - "members":{ - "name":{ - "shape":"PrivateConnectionName", - "documentation":"

The name of the private connection.

" - }, - "type":{ - "shape":"PrivateConnectionType", - "documentation":"

The type of the private connection, indicating whether it is service-managed or self-managed.

" - }, - "status":{ - "shape":"PrivateConnectionStatus", - "documentation":"

The current status of the private connection.

" - }, - "resourceGatewayId":{ - "shape":"ResourceGatewayId", - "documentation":"

The identifier or ARN of the VPC Lattice resource gateway.

" - }, - "hostAddress":{ - "shape":"HostAddress", - "documentation":"

The IP address or DNS name of the target resource.

" - }, - "vpcId":{ - "shape":"PrivateConnectionVpcId", - "documentation":"

The identifier of the VPC the resource gateway is created in.

" - }, - "resourceConfigurationId":{ - "shape":"ResourceConfigurationId", - "documentation":"

The identifier or ARN of the VPC Lattice resource configuration.

" - }, - "certificateExpiryTime":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the connection's certificate expires, in UTC format.

" - }, - "dnsResolution":{ - "shape":"ResourceConfigDnsResolution", - "documentation":"

The DNS resolution mode for the resource gateway.

" - }, - "failureMessage":{ - "shape":"String", - "documentation":"

A message describing why the private connection entered a failed state, if applicable.

" - }, - "tags":{ - "shape":"TagMap", - "documentation":"

The tags attached to the private connection.

" - } - }, - "documentation":"

Summarizes a private connection.

" - }, - "PrivateConnectionType":{ - "type":"string", - "documentation":"

The type of a private connection, indicating whether it is service-managed or self-managed.

", - "enum":[ - "SERVICE_MANAGED", - "SELF_MANAGED" - ] - }, - "PrivateConnectionVpcId":{ - "type":"string", - "documentation":"

The identifier of a VPC.

" - }, - "Provider":{ - "type":"string", - "documentation":"

Third-party provider type.

", - "enum":[ - "GITHUB", - "GITLAB", - "BITBUCKET", - "CONFLUENCE" - ] - }, - "ProviderInput":{ - "type":"structure", - "members":{ - "github":{ - "shape":"GitHubIntegrationInput", - "documentation":"

The GitHub-specific input for creating an integration.

" - }, - "gitlab":{ - "shape":"GitLabIntegrationInput", - "documentation":"

The configuration for a GitLab integration.

" - }, - "bitbucket":{ - "shape":"BitbucketIntegrationInput", - "documentation":"

The configuration for a Bitbucket integration.

" - }, - "confluence":{ - "shape":"ConfluenceIntegrationInput", - "documentation":"

The configuration for a Confluence integration.

" - } - }, - "documentation":"

The provider-specific input for creating an integration. This is a union type that contains provider-specific configuration.

", - "union":true - }, - "ProviderResourceCapabilities":{ - "type":"structure", - "members":{ - "github":{ - "shape":"GitHubResourceCapabilities", - "documentation":"

The GitHub-specific resource capabilities.

" - }, - "gitlab":{"shape":"GitLabResourceCapabilities"}, - "bitbucket":{"shape":"BitbucketResourceCapabilities"}, - "confluence":{"shape":"ConfluenceResourceCapabilities"} - }, - "documentation":"

The capabilities for an integrated resource from a third-party provider. This is a union type that contains provider-specific capabilities.

", - "union":true - }, - "ProviderResourceId":{ - "type":"string", - "documentation":"

Provider Id of the resource e.g. GitHub repository id, etc.

" - }, - "ProviderResourceName":{ - "type":"string", - "documentation":"

Name of the resource e.g. repository name, etc.

" - }, - "ProviderType":{ - "type":"string", - "documentation":"

Type of provider integration.

", - "enum":[ - "SOURCE_CODE", - "DOCUMENTATION" - ] - }, - "ReportDestination":{ - "type":"structure", - "required":[ - "integrationId", - "containerId" - ], - "members":{ - "integrationId":{ - "shape":"String", - "documentation":"

The integration identifier for the document provider.

" - }, - "containerId":{ - "shape":"String", - "documentation":"

The container identifier where the report will be published.

" - }, - "parentId":{ - "shape":"String", - "documentation":"

The parent document identifier under which the report will be created.

" - }, - "documentId":{ - "shape":"String", - "documentation":"

The existing document identifier to update instead of creating a new document.

" - } - }, - "documentation":"

Destination for publishing scan reports to an integrated document provider.

" - }, - "ResourceArn":{ - "type":"string", - "documentation":"

ARN of a taggable resource.

" - }, - "ResourceConfigDnsResolution":{ - "type":"string", - "documentation":"

The DNS resolution mode for a resource gateway.

", - "enum":[ - "PUBLIC", - "IN_VPC" - ] - }, - "ResourceConfigurationId":{ - "type":"string", - "documentation":"

The identifier or ARN of a VPC Lattice resource configuration.

" - }, - "ResourceGatewayId":{ - "type":"string", - "documentation":"

The identifier or ARN of a VPC Lattice resource gateway.

" - }, - "ResourceNotFoundException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{ - "shape":"String", - "documentation":"

Error description.

" - } - }, - "documentation":"

The specified resource was not found. Verify that the resource identifier is correct and that the resource exists in the specified agent space or account.

", - "error":{ - "httpStatusCode":404, - "senderFault":true - }, - "exception":true - }, - "ResourceType":{ - "type":"string", - "documentation":"

Type of resource.

", - "enum":[ - "CODE_REPOSITORY", - "DOCUMENT" - ] - }, - "RiskLevel":{ - "type":"string", - "documentation":"

Risk severity level.

", - "enum":[ - "UNKNOWN", - "INFORMATIONAL", - "LOW", - "MEDIUM", - "HIGH", - "CRITICAL" - ] - }, - "RiskType":{ - "type":"string", - "documentation":"

Type of security risk.

", - "enum":[ - "CROSS_SITE_SCRIPTING", - "DEFAULT_CREDENTIALS", - "INSECURE_DIRECT_OBJECT_REFERENCE", - "PRIVILEGE_ESCALATION", - "SERVER_SIDE_TEMPLATE_INJECTION", - "COMMAND_INJECTION", - "CODE_INJECTION", - "SQL_INJECTION", - "ARBITRARY_FILE_UPLOAD", - "INSECURE_DESERIALIZATION", - "LOCAL_FILE_INCLUSION", - "INFORMATION_DISCLOSURE", - "PATH_TRAVERSAL", - "SERVER_SIDE_REQUEST_FORGERY", - "JSON_WEB_TOKEN_VULNERABILITIES", - "XML_EXTERNAL_ENTITY", - "FILE_DELETION", - "OTHER", - "GRAPHQL_VULNERABILITIES", - "BUSINESS_LOGIC_VULNERABILITIES", - "CRYPTOGRAPHIC_VULNERABILITIES", - "DENIAL_OF_SERVICE", - "FILE_ACCESS", - "FILE_CREATION", - "DATABASE_MODIFICATION", - "DATABASE_ACCESS", - "OUTBOUND_SERVICE_REQUEST", - "UNKNOWN" - ] - }, - "RiskTypeList":{ - "type":"list", - "member":{"shape":"RiskType"} - }, - "RoleArn":{ - "type":"string", - "documentation":"

ARN of the IAM role that the application uses to access AWS resources on your behalf.

" - }, - "S3BucketArn":{ - "type":"string", - "documentation":"

S3 bucket ARN or name for agent space AWS resources.

" - }, - "S3BucketArns":{ - "type":"list", - "member":{"shape":"S3BucketArn"} - }, - "SecretArn":{ - "type":"string", - "documentation":"

Secret ARN or name for agent space AWS resources.

" - }, - "SecretArns":{ - "type":"list", - "member":{"shape":"SecretArn"} - }, - "SecurityGroupArn":{ - "type":"string", - "documentation":"

ARN or ID of a security group.

" - }, - "SecurityGroupArns":{ - "type":"list", - "member":{"shape":"SecurityGroupArn"}, - "documentation":"

A list of one or more security group ARNs or IDs in the customer VPC.

" - }, - "SecurityRequirementArtifact":{ - "type":"structure", - "required":[ - "name", - "format", - "content" - ], - "members":{ - "name":{ - "shape":"SecurityRequirementArtifactName", - "documentation":"

The file name of the document.

" - }, - "format":{ - "shape":"SecurityRequirementArtifactFormat", - "documentation":"

The format of the document. Valid values are MD, PDF, TXT, DOCX, and DOC.

" - }, - "content":{ - "shape":"SecurityRequirementDocumentContent", - "documentation":"

The binary content of the document.

" - } - }, - "documentation":"

A document used as source material for importing security requirements.

" - }, - "SecurityRequirementArtifactFormat":{ - "type":"string", - "enum":[ - "MD", - "PDF", - "TXT", - "DOCX", - "DOC" - ] - }, - "SecurityRequirementArtifactList":{ - "type":"list", - "member":{"shape":"SecurityRequirementArtifact"}, - "documentation":"

List of documents used as source material for importing security requirements.

" - }, - "SecurityRequirementArtifactName":{"type":"string"}, - "SecurityRequirementDocumentContent":{ - "type":"blob", - "sensitive":true - }, - "SecurityRequirementName":{"type":"string"}, - "SecurityRequirementNameList":{ - "type":"list", - "member":{"shape":"SecurityRequirementName"}, - "documentation":"

List of security requirement names.

" - }, - "SecurityRequirementPackId":{"type":"string"}, - "SecurityRequirementPackImportStatus":{ - "type":"string", - "enum":[ - "PENDING", - "IN_PROGRESS", - "FAILED", - "COMPLETED" - ] - }, - "SecurityRequirementPackName":{"type":"string"}, - "SecurityRequirementPackStatus":{ - "type":"string", - "enum":[ - "ENABLED", - "DISABLED" - ] - }, - "SecurityRequirementPackSummary":{ - "type":"structure", - "required":[ - "packId", - "name", - "managementType", - "status", - "createdAt", - "updatedAt" - ], - "members":{ - "packId":{ - "shape":"SecurityRequirementPackId", - "documentation":"

The unique identifier of the security requirement pack.

" - }, - "name":{ - "shape":"SecurityRequirementPackName", - "documentation":"

The name of the security requirement pack.

" - }, - "description":{ - "shape":"String", - "documentation":"

A description of the security requirement pack.

" - }, - "vendorName":{ - "shape":"String", - "documentation":"

The vendor name for AWS managed packs.

" - }, - "managementType":{ - "shape":"ManagementType", - "documentation":"

The management type of the pack.

" - }, - "status":{ - "shape":"SecurityRequirementPackStatus", - "documentation":"

The status of the security requirement pack.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the security requirement pack was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the security requirement pack was last updated, in UTC format.

" - } - }, - "documentation":"

Contains summary information about a security requirement pack.

" - }, - "SecurityRequirementPackSummaryList":{ - "type":"list", - "member":{"shape":"SecurityRequirementPackSummary"}, - "documentation":"

List of security requirement pack summaries.

" - }, - "SecurityRequirementSummary":{ - "type":"structure", - "required":[ - "packId", - "name", - "description", - "createdAt", - "updatedAt" - ], - "members":{ - "packId":{ - "shape":"SecurityRequirementPackId", - "documentation":"

The unique identifier of the pack containing the security requirement.

" - }, - "name":{ - "shape":"SecurityRequirementName", - "documentation":"

The name of the security requirement.

" - }, - "description":{ - "shape":"String", - "documentation":"

A description of the security requirement.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the security requirement was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the security requirement was last updated, in UTC format.

" - } - }, - "documentation":"

Contains summary information about a security requirement.

" - }, - "SecurityRequirementSummaryList":{ - "type":"list", - "member":{"shape":"SecurityRequirementSummary"}, - "documentation":"

List of security requirement summaries.

" - }, - "SelfManagedInput":{ - "type":"structure", - "required":["resourceConfigurationId"], - "members":{ - "resourceConfigurationId":{ - "shape":"ResourceConfigurationId", - "documentation":"

The identifier or ARN of the resource configuration.

" - }, - "certificate":{ - "shape":"CertificateChain", - "documentation":"

The certificate for the private connection.

" - } - }, - "documentation":"

The configuration for a self-managed private connection.

" - }, - "SensitiveEmail":{ - "type":"string", - "documentation":"

Sensitive email address.

" - }, - "ServiceManagedInput":{ - "type":"structure", - "required":[ - "hostAddress", - "vpcId", - "subnetIds" - ], - "members":{ - "hostAddress":{ - "shape":"HostAddress", - "documentation":"

The IP address or DNS name of the target resource.

" - }, - "vpcId":{ - "shape":"PrivateConnectionVpcId", - "documentation":"

The VPC to create the service-managed resource gateway in.

" - }, - "subnetIds":{ - "shape":"PrivateConnectionSubnetIds", - "documentation":"

The subnets that the service-managed resource gateway spans.

" - }, - "securityGroupIds":{ - "shape":"PrivateConnectionSecurityGroupIds", - "documentation":"

The security groups to attach to the service-managed resource gateway.

" - }, - "ipAddressType":{ - "shape":"IpAddressType", - "documentation":"

The IP address type of the service-managed resource gateway.

" - }, - "ipv4AddressesPerEni":{ - "shape":"MaxIpv4AddressesPerEni", - "documentation":"

The number of IPv4 addresses in each elastic network interface for the service-managed resource gateway.

" - }, - "portRanges":{ - "shape":"PortRanges", - "documentation":"

The TCP port ranges that a consumer can use to access the resource.

" - }, - "certificate":{ - "shape":"CertificateChain", - "documentation":"

The certificate for the private connection.

" - }, - "dnsResolution":{ - "shape":"ResourceConfigDnsResolution", - "documentation":"

The DNS resolution mode for the resource gateway. Defaults to PUBLIC when not set.

" - } - }, - "documentation":"

The configuration for a service-managed private connection.

" - }, - "ServiceQuotaExceededException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"} - }, - "documentation":"

The request exceeds a service quota. Review your current usage and request a quota increase if needed.

", - "error":{ - "httpStatusCode":402, - "senderFault":true - }, - "exception":true - }, - "ServiceRole":{ - "type":"string", - "documentation":"

ARN of an IAM role that the service can assume to access customer resources.

" - }, - "SkillType":{ - "type":"string", - "documentation":"

Type of managed skill that can be enabled or disabled for a pentest.

", - "enum":[ - "FINDING_PERSONALIZATION", - "LOGIN_OPTIMIZATION" - ] - }, - "SkillTypeList":{ - "type":"list", - "member":{"shape":"SkillType"}, - "documentation":"

A list of skill types.

" - }, - "SourceCodeRepository":{ - "type":"structure", - "members":{ - "s3Location":{ - "shape":"String", - "documentation":"

The Amazon S3 location of the source code repository archive.

" - } - }, - "documentation":"

Represents a source code repository used for security analysis during a pentest.

" - }, - "SourceCodeRepositoryList":{ - "type":"list", - "member":{"shape":"SourceCodeRepository"} - }, - "StartCodeRemediationInput":{ - "type":"structure", - "required":[ - "agentSpaceId", - "findingIds" - ], - "members":{ - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space.

" - }, - "pentestJobId":{ - "shape":"String", - "documentation":"

The unique identifier of the pentest job that produced the findings. Mutually exclusive with codeReviewJobId.

" - }, - "codeReviewJobId":{ - "shape":"String", - "documentation":"

The unique identifier of the code review job that produced the findings. Mutually exclusive with pentestJobId.

" - }, - "findingIds":{ - "shape":"FindingIdList", - "documentation":"

The list of finding identifiers to initiate code remediation for.

" - } - }, - "documentation":"

Input for the StartCodeRemediation operation.

" - }, - "StartCodeRemediationOutput":{ - "type":"structure", - "members":{}, - "documentation":"

Output for the StartCodeRemediation operation.

" - }, - "StartCodeReviewJobInput":{ - "type":"structure", - "required":[ - "agentSpaceId", - "codeReviewId" - ], - "members":{ - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space.

" - }, - "codeReviewId":{ - "shape":"String", - "documentation":"

The unique identifier of the code review to start a job for.

" - }, - "diffSource":{ - "shape":"DiffSource", - "documentation":"

Source of the diff for a differential scan. When present, the job analyzes only the changed lines instead of performing a full scan.

" - } - }, - "documentation":"

Input for starting the execution of a code review.

" - }, - "StartCodeReviewJobOutput":{ - "type":"structure", - "required":[ - "codeReviewId", - "codeReviewJobId" - ], - "members":{ - "title":{ - "shape":"String", - "documentation":"

The title of the code review job.

" - }, - "status":{ - "shape":"JobStatus", - "documentation":"

The current status of the code review job.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the code review job was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the code review job was last updated, in UTC format.

" - }, - "codeReviewId":{ - "shape":"String", - "documentation":"

The unique identifier of the code review.

" - }, - "codeReviewJobId":{ - "shape":"String", - "documentation":"

The unique identifier of the started code review job.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space.

" - } - }, - "documentation":"

Output for the StartCodeReviewJob operation.

" - }, - "StartPentestJobInput":{ - "type":"structure", - "required":[ - "agentSpaceId", - "pentestId" - ], - "members":{ - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space.

" - }, - "pentestId":{ - "shape":"String", - "documentation":"

The unique identifier of the pentest to start a job for.

" - } - }, - "documentation":"

Input for starting the execution of a pentest.

" - }, - "StartPentestJobOutput":{ - "type":"structure", - "members":{ - "title":{ - "shape":"String", - "documentation":"

The title of the pentest job.

" - }, - "status":{ - "shape":"JobStatus", - "documentation":"

The current status of the pentest job.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the pentest job was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the pentest job was last updated, in UTC format.

" - }, - "pentestId":{ - "shape":"String", - "documentation":"

The unique identifier of the pentest.

" - }, - "pentestJobId":{ - "shape":"String", - "documentation":"

The unique identifier of the started pentest job.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space.

" - } - }, - "documentation":"

Output for the StartPentestJob operation.

" - }, - "StartThreatModelJobInput":{ - "type":"structure", - "required":[ - "agentSpaceId", - "threatModelId" - ], - "members":{ - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space.

" - }, - "threatModelId":{ - "shape":"String", - "documentation":"

The unique identifier of the threat model to start a job for.

" - } - }, - "documentation":"

Input for starting a threat model job.

" - }, - "StartThreatModelJobOutput":{ - "type":"structure", - "required":["threatModelJobId"], - "members":{ - "title":{ - "shape":"String", - "documentation":"

The title of the threat model job.

" - }, - "status":{ - "shape":"JobStatus", - "documentation":"

The current status of the threat model job.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the threat model job was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the threat model job was last updated, in UTC format.

" - }, - "threatModelId":{ - "shape":"String", - "documentation":"

The unique identifier of the threat model.

" - }, - "threatModelJobId":{ - "shape":"String", - "documentation":"

The unique identifier of the started threat model job.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space.

" - } - }, - "documentation":"

Output for the StartThreatModelJob operation.

" - }, - "Step":{ - "type":"structure", - "members":{ - "name":{ - "shape":"StepName", - "documentation":"

The name of the step. Valid values include PREFLIGHT, STATIC_ANALYSIS, PENTEST, VALIDATION, and FINALIZING.

" - }, - "status":{ - "shape":"StepStatus", - "documentation":"

The current status of the step.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the step was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the step was last updated, in UTC format.

" - } - }, - "documentation":"

Represents a step in the pentest job execution pipeline. Steps include preflight, static analysis, pentest, and finalizing.

" - }, - "StepList":{ - "type":"list", - "member":{"shape":"Step"}, - "documentation":"

List of pentest job steps.

" - }, - "StepName":{ - "type":"string", - "documentation":"

Pentest job step names.

", - "enum":[ - "PREFLIGHT", - "STATIC_ANALYSIS", - "PENTEST", - "FINALIZING", - "VALIDATION" - ] - }, - "StepStatus":{ - "type":"string", - "documentation":"

Pentest job step status.

", - "enum":[ - "NOT_STARTED", - "IN_PROGRESS", - "COMPLETED", - "FAILED", - "STOPPED" - ] - }, - "StopCodeReviewJobInput":{ - "type":"structure", - "required":[ - "agentSpaceId", - "codeReviewJobId" - ], - "members":{ - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space.

" - }, - "codeReviewJobId":{ - "shape":"String", - "documentation":"

The unique identifier of the code review job to stop.

" - } - }, - "documentation":"

Input for stopping the execution of a code review job.

" - }, - "StopCodeReviewJobOutput":{ - "type":"structure", - "members":{}, - "documentation":"

Output for the StopCodeReviewJob operation.

" - }, - "StopPentestJobInput":{ - "type":"structure", - "required":[ - "agentSpaceId", - "pentestJobId" - ], - "members":{ - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space.

" - }, - "pentestJobId":{ - "shape":"String", - "documentation":"

The unique identifier of the pentest job to stop.

" - } - }, - "documentation":"

Input for stopping the execution of a pentest.

" - }, - "StopPentestJobOutput":{ - "type":"structure", - "members":{}, - "documentation":"

Output for the StopPentestJob operation.

" - }, - "StopThreatModelJobInput":{ - "type":"structure", - "required":[ - "agentSpaceId", - "threatModelJobId" - ], - "members":{ - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space.

" - }, - "threatModelJobId":{ - "shape":"String", - "documentation":"

The unique identifier of the threat model job to stop.

" - } - }, - "documentation":"

Input for stopping a threat model job.

" - }, - "StopThreatModelJobOutput":{ - "type":"structure", - "members":{}, - "documentation":"

Output for the StopThreatModelJob operation.

" - }, - "StrideCategory":{ - "type":"string", - "documentation":"

STRIDE threat classification category.

", - "enum":[ - "SPOOFING", - "TAMPERING", - "REPUDIATION", - "INFORMATION_DISCLOSURE", - "DENIAL_OF_SERVICE", - "ELEVATION_OF_PRIVILEGE" - ] - }, - "StrideCategoryList":{ - "type":"list", - "member":{"shape":"StrideCategory"}, - "documentation":"

List of STRIDE categories.

" - }, - "String":{"type":"string"}, - "StringList":{ - "type":"list", - "member":{"shape":"String"} - }, - "SubnetArn":{ - "type":"string", - "documentation":"

ARN or ID of a subnet.

" - }, - "SubnetArns":{ - "type":"list", - "member":{"shape":"SubnetArn"}, - "documentation":"

A list of one or more subnet ARNs or IDs in the customer VPC.

" - }, - "SyntheticTimestamp_date_time":{ - "type":"timestamp", - "timestampFormat":"iso8601" - }, - "TagKey":{ - "type":"string", - "documentation":"

Key for a resource tag.

" - }, - "TagKeyList":{ - "type":"list", - "member":{"shape":"TagKey"}, - "documentation":"

List of tag keys.

" - }, - "TagMap":{ - "type":"map", - "key":{"shape":"TagKey"}, - "value":{"shape":"TagValue"}, - "documentation":"

Map of tags for a resource.

" - }, - "TagResourceInput":{ - "type":"structure", - "required":[ - "resourceArn", - "tags" - ], - "members":{ - "resourceArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the resource to tag.

", - "location":"uri", - "locationName":"resourceArn" - }, - "tags":{ - "shape":"TagMap", - "documentation":"

The tags to add to the resource.

" - } - }, - "documentation":"

Input for TagResource operation.

" - }, - "TagResourceOutput":{ - "type":"structure", - "members":{}, - "documentation":"

Output for TagResource operation.

" - }, - "TagValue":{ - "type":"string", - "documentation":"

Value for a resource tag.

" - }, - "TargetDomain":{ - "type":"structure", - "required":[ - "targetDomainId", - "domainName" - ], - "members":{ - "targetDomainId":{ - "shape":"TargetDomainId", - "documentation":"

The unique identifier of the target domain.

" - }, - "domainName":{ - "shape":"String", - "documentation":"

The domain name of the target domain.

" - }, - "verificationStatus":{ - "shape":"TargetDomainStatus", - "documentation":"

The current verification status of the target domain.

" - }, - "verificationStatusReason":{ - "shape":"String", - "documentation":"

The reason for the current target domain verification status.

" - }, - "verificationDetails":{ - "shape":"VerificationDetails", - "documentation":"

The verification details for the target domain.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the target domain was created, in UTC format.

" - }, - "verifiedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the target domain was verified, in UTC format.

" - } - }, - "documentation":"

Represents a target domain registered for penetration testing. A target domain must be verified through DNS TXT or HTTP route verification before it can be used in pentests.

" - }, - "TargetDomainId":{ - "type":"string", - "documentation":"

Unique identifier of the target domain.

" - }, - "TargetDomainIdList":{ - "type":"list", - "member":{"shape":"String"}, - "documentation":"

List of target domain IDs.

" - }, - "TargetDomainList":{ - "type":"list", - "member":{"shape":"TargetDomain"}, - "documentation":"

List of target domains.

" - }, - "TargetDomainStatus":{ - "type":"string", - "documentation":"

Verification status of a target domain.

", - "enum":[ - "PENDING", - "VERIFIED", - "FAILED", - "UNREACHABLE" - ] - }, - "TargetDomainSummary":{ - "type":"structure", - "required":[ - "targetDomainId", - "domainName" - ], - "members":{ - "targetDomainId":{ - "shape":"TargetDomainId", - "documentation":"

The unique identifier of the target domain.

" - }, - "domainName":{ - "shape":"String", - "documentation":"

The domain name of the target domain.

" - }, - "verificationStatus":{ - "shape":"TargetDomainStatus", - "documentation":"

The current verification status of the target domain.

" - } - }, - "documentation":"

Contains summary information about a target domain.

" - }, - "TargetDomainSummaryList":{ - "type":"list", - "member":{"shape":"TargetDomainSummary"} - }, - "TargetUrl":{ - "type":"string", - "documentation":"

The HTTPS URL of a customer self-hosted instance.

" - }, - "Task":{ - "type":"structure", - "required":["taskId"], - "members":{ - "taskId":{ - "shape":"String", - "documentation":"

The unique identifier of the task.

" - }, - "pentestId":{ - "shape":"String", - "documentation":"

The unique identifier of the pentest associated with the task.

" - }, - "pentestJobId":{ - "shape":"String", - "documentation":"

The unique identifier of the pentest job that contains the task.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space.

" - }, - "title":{ - "shape":"String", - "documentation":"

The title of the task.

" - }, - "description":{ - "shape":"String", - "documentation":"

A description of the task.

" - }, - "categories":{ - "shape":"CategoryList", - "documentation":"

The list of categories assigned to the task.

" - }, - "riskType":{ - "shape":"RiskType", - "documentation":"

The type of security risk the task is testing for.

" - }, - "targetEndpoint":{ - "shape":"Endpoint", - "documentation":"

The target endpoint being tested by the task.

" - }, - "executionStatus":{ - "shape":"TaskExecutionStatus", - "documentation":"

The current execution status of the task.

" - }, - "logsLocation":{ - "shape":"LogLocation", - "documentation":"

The location of the task execution logs.

" - }, - "taskHours":{ - "shape":"Double", - "documentation":"

The number of active work hours consumed by the task during execution.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the task was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the task was last updated, in UTC format.

" - } - }, - "documentation":"

Represents an individual security test task within a pentest job. Each task targets a specific risk type or endpoint and executes independently.

" - }, - "TaskExecutionStatus":{ - "type":"string", - "documentation":"

Execution status of a task.

", - "enum":[ - "IN_PROGRESS", - "ABORTED", - "COMPLETED", - "INTERNAL_ERROR", - "FAILED" - ] - }, - "TaskIdList":{ - "type":"list", - "member":{"shape":"String"} - }, - "TaskList":{ - "type":"list", - "member":{"shape":"Task"} - }, - "TaskSummary":{ - "type":"structure", - "required":["taskId"], - "members":{ - "taskId":{ - "shape":"String", - "documentation":"

The unique identifier of the task.

" - }, - "pentestId":{ - "shape":"String", - "documentation":"

The unique identifier of the pentest associated with the task.

" - }, - "pentestJobId":{ - "shape":"String", - "documentation":"

The unique identifier of the pentest job that contains the task.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space.

" - }, - "title":{ - "shape":"String", - "documentation":"

The title of the task.

" - }, - "riskType":{ - "shape":"RiskType", - "documentation":"

The type of security risk the task is testing for.

" - }, - "executionStatus":{ - "shape":"TaskExecutionStatus", - "documentation":"

The current execution status of the task.

" - }, - "taskHours":{ - "shape":"Double", - "documentation":"

The number of active work hours consumed by the task during execution.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the task was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the task was last updated, in UTC format.

" - } - }, - "documentation":"

Contains summary information about a task.

" - }, - "TaskSummaryList":{ - "type":"list", - "member":{"shape":"TaskSummary"} - }, - "Threat":{ - "type":"structure", - "members":{ - "threatId":{ - "shape":"String", - "documentation":"

The unique identifier of the threat.

" - }, - "threatJobId":{ - "shape":"String", - "documentation":"

The unique identifier of the threat model job that produced the threat.

" - }, - "title":{ - "shape":"String", - "documentation":"

A short title summarizing the threat.

" - }, - "statement":{ - "shape":"String", - "documentation":"

The natural-language threat statement.

" - }, - "severity":{ - "shape":"ThreatSeverity", - "documentation":"

The severity level of the threat.

" - }, - "status":{ - "shape":"ThreatStatus", - "documentation":"

The current status of the threat.

" - }, - "comments":{ - "shape":"String", - "documentation":"

Optional customer comment on the threat.

" - }, - "threatSource":{ - "shape":"String", - "documentation":"

The actor or origin of the threat.

" - }, - "prerequisites":{ - "shape":"String", - "documentation":"

The conditions required for the threat to be exploitable.

" - }, - "threatAction":{ - "shape":"String", - "documentation":"

What the threat source can do.

" - }, - "threatImpact":{ - "shape":"String", - "documentation":"

The direct consequence of the threat action.

" - }, - "impactedGoal":{ - "shape":"StringList", - "documentation":"

The security goals affected by the threat.

" - }, - "impactedAssets":{ - "shape":"StringList", - "documentation":"

The specific assets affected by the threat.

" - }, - "anchor":{ - "shape":"ThreatAnchorShape", - "documentation":"

The DFD element this threat is anchored to.

" - }, - "evidence":{ - "shape":"ThreatEvidenceList", - "documentation":"

The source code files supporting the threat.

" - }, - "stride":{ - "shape":"StrideCategoryList", - "documentation":"

The STRIDE categories applicable to this threat.

" - }, - "recommendation":{ - "shape":"String", - "documentation":"

The recommended mitigation guidance for this threat.

" - }, - "createdBy":{ - "shape":"ThreatActor", - "documentation":"

Who created this threat.

" - }, - "updatedBy":{ - "shape":"ThreatActor", - "documentation":"

Who last updated this threat.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the threat was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the threat was last updated, in UTC format.

" - } - }, - "documentation":"

Represents a threat identified during threat modeling.

" - }, - "ThreatActor":{ - "type":"string", - "documentation":"

Indicates whether a threat was created or updated by a customer or an agent.

", - "enum":[ - "CUSTOMER", - "AGENT" - ] - }, - "ThreatAnchorShape":{ - "type":"structure", - "members":{ - "kind":{ - "shape":"String", - "documentation":"

The kind of DFD element.

" - }, - "id":{ - "shape":"String", - "documentation":"

The identifier of the DFD element.

" - }, - "packageId":{ - "shape":"String", - "documentation":"

The package identifier containing the DFD element.

" - } - }, - "documentation":"

DFD element that a threat is anchored to.

" - }, - "ThreatEvidenceList":{ - "type":"list", - "member":{"shape":"ThreatEvidenceShape"}, - "documentation":"

List of threat evidence.

" - }, - "ThreatEvidenceShape":{ - "type":"structure", - "members":{ - "packageId":{ - "shape":"String", - "documentation":"

The package identifier containing the evidence file.

" - }, - "path":{ - "shape":"String", - "documentation":"

The file path of the evidence.

" - } - }, - "documentation":"

Source code file supporting a threat.

" - }, - "ThreatIdList":{ - "type":"list", - "member":{"shape":"String"}, - "documentation":"

List of threat IDs.

" - }, - "ThreatList":{ - "type":"list", - "member":{"shape":"Threat"}, - "documentation":"

List of threats.

" - }, - "ThreatModel":{ - "type":"structure", - "required":[ - "threatModelId", - "agentSpaceId", - "title", - "assets" - ], - "members":{ - "threatModelId":{ - "shape":"String", - "documentation":"

The unique identifier of the threat model.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space that contains the threat model.

" - }, - "title":{ - "shape":"String", - "documentation":"

The title of the threat model.

" - }, - "description":{ - "shape":"String", - "documentation":"

A description of the application or system being threat modeled.

" - }, - "assets":{ - "shape":"Assets", - "documentation":"

The assets included in the threat model.

" - }, - "scopeDocs":{ - "shape":"DocumentList", - "documentation":"

The scoped documents for the agent to focus on during threat modeling.

" - }, - "serviceRole":{ - "shape":"ServiceRole", - "documentation":"

The IAM service role used for the threat model.

" - }, - "logConfig":{ - "shape":"CloudWatchLog", - "documentation":"

The CloudWatch Logs configuration for the threat model.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the threat model was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the threat model was last updated, in UTC format.

" - } - }, - "documentation":"

Represents a threat model configuration that defines the parameters for automated threat analysis, including target assets and logging configuration.

" - }, - "ThreatModelIdList":{ - "type":"list", - "member":{"shape":"String"}, - "documentation":"

List of threat model IDs.

" - }, - "ThreatModelJob":{ - "type":"structure", - "members":{ - "threatModelJobId":{ - "shape":"String", - "documentation":"

The unique identifier of the threat model job.

" - }, - "threatModelId":{ - "shape":"String", - "documentation":"

The unique identifier of the threat model associated with the job.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space.

" - }, - "title":{ - "shape":"String", - "documentation":"

The title of the threat model job.

" - }, - "status":{ - "shape":"JobStatus", - "documentation":"

The current status of the threat model job.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the threat model job was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the threat model job was last updated, in UTC format.

" - }, - "executionStartTime":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the threat model job execution started, in UTC format.

" - }, - "executionEndTime":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the threat model job execution ended, in UTC format.

" - }, - "sourceCode":{ - "shape":"SourceCodeRepositoryList", - "documentation":"

The list of source code repositories used for threat modeling.

" - }, - "integratedRepositories":{ - "shape":"IntegratedRepositoryList", - "documentation":"

The list of integrated repositories used for threat modeling.

" - }, - "documents":{ - "shape":"DocumentList", - "documentation":"

The list of documents used for threat modeling.

" - }, - "scopeDocs":{ - "shape":"DocumentList", - "documentation":"

The scoped documents for the agent to focus on during threat modeling.

" - }, - "errorInformation":{ - "shape":"ErrorInformation", - "documentation":"

Error information if the threat model job encountered an error.

" - }, - "systemOverview":{ - "shape":"String", - "documentation":"

The system overview generated during threat modeling.

" - } - }, - "documentation":"

Represents a threat model job, which is an execution instance of a threat model.

" - }, - "ThreatModelJobIdList":{ - "type":"list", - "member":{"shape":"String"}, - "documentation":"

List of threat model job IDs.

" - }, - "ThreatModelJobList":{ - "type":"list", - "member":{"shape":"ThreatModelJob"}, - "documentation":"

List of threat model jobs.

" - }, - "ThreatModelJobSummary":{ - "type":"structure", - "required":[ - "threatModelJobId", - "threatModelId" - ], - "members":{ - "threatModelJobId":{ - "shape":"String", - "documentation":"

The unique identifier of the threat model job.

" - }, - "threatModelId":{ - "shape":"String", - "documentation":"

The unique identifier of the threat model associated with the job.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space.

" - }, - "title":{ - "shape":"String", - "documentation":"

The title of the threat model job.

" - }, - "status":{ - "shape":"JobStatus", - "documentation":"

The current status of the threat model job.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the threat model job was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the threat model job was last updated, in UTC format.

" - } - }, - "documentation":"

Contains summary information about a threat model job.

" - }, - "ThreatModelJobSummaryList":{ - "type":"list", - "member":{"shape":"ThreatModelJobSummary"}, - "documentation":"

List of threat model job summaries.

" - }, - "ThreatModelJobTask":{ - "type":"structure", - "required":["taskId"], - "members":{ - "taskId":{ - "shape":"String", - "documentation":"

The unique identifier of the task.

" - }, - "threatModelId":{ - "shape":"String", - "documentation":"

The unique identifier of the threat model associated with the task.

" - }, - "threatModelJobId":{ - "shape":"String", - "documentation":"

The unique identifier of the threat model job that contains the task.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space.

" - }, - "title":{ - "shape":"String", - "documentation":"

The title of the task.

" - }, - "description":{ - "shape":"String", - "documentation":"

A description of the task.

" - }, - "executionStatus":{ - "shape":"TaskExecutionStatus", - "documentation":"

The current execution status of the task.

" - }, - "logsLocation":{ - "shape":"LogLocation", - "documentation":"

The location of the task execution logs.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the task was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the task was last updated, in UTC format.

" - } - }, - "documentation":"

Represents an individual task within a threat model job.

" - }, - "ThreatModelJobTaskList":{ - "type":"list", - "member":{"shape":"ThreatModelJobTask"}, - "documentation":"

List of threat model job tasks.

" - }, - "ThreatModelJobTaskSummary":{ - "type":"structure", - "required":["taskId"], - "members":{ - "taskId":{ - "shape":"String", - "documentation":"

The unique identifier of the task.

" - }, - "threatModelId":{ - "shape":"String", - "documentation":"

The unique identifier of the threat model associated with the task.

" - }, - "threatModelJobId":{ - "shape":"String", - "documentation":"

The unique identifier of the threat model job that contains the task.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space.

" - }, - "title":{ - "shape":"String", - "documentation":"

The title of the task.

" - }, - "executionStatus":{ - "shape":"TaskExecutionStatus", - "documentation":"

The current execution status of the task.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the task was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the task was last updated, in UTC format.

" - } - }, - "documentation":"

Contains summary information about a threat model job task.

" - }, - "ThreatModelJobTaskSummaryList":{ - "type":"list", - "member":{"shape":"ThreatModelJobTaskSummary"}, - "documentation":"

List of threat model job task summaries.

" - }, - "ThreatModelList":{ - "type":"list", - "member":{"shape":"ThreatModel"}, - "documentation":"

List of threat models.

" - }, - "ThreatModelSummary":{ - "type":"structure", - "required":[ - "threatModelId", - "agentSpaceId", - "title" - ], - "members":{ - "threatModelId":{ - "shape":"String", - "documentation":"

The unique identifier of the threat model.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space that contains the threat model.

" - }, - "title":{ - "shape":"String", - "documentation":"

The title of the threat model.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the threat model was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the threat model was last updated, in UTC format.

" - } - }, - "documentation":"

Contains summary information about a threat model.

" - }, - "ThreatModelSummaryList":{ - "type":"list", - "member":{"shape":"ThreatModelSummary"}, - "documentation":"

List of threat model summaries.

" - }, - "ThreatSeverity":{ - "type":"string", - "documentation":"

Severity level for a threat.

", - "enum":[ - "CRITICAL", - "HIGH", - "MEDIUM", - "LOW", - "INFO" - ] - }, - "ThreatStatus":{ - "type":"string", - "documentation":"

Status of a threat.

", - "enum":[ - "OPEN", - "RESOLVED", - "DISMISSED" - ] - }, - "ThreatSummary":{ - "type":"structure", - "members":{ - "threatId":{ - "shape":"String", - "documentation":"

The unique identifier of the threat.

" - }, - "threatJobId":{ - "shape":"String", - "documentation":"

The unique identifier of the threat model job that produced the threat.

" - }, - "title":{ - "shape":"String", - "documentation":"

A short title summarizing the threat.

" - }, - "statement":{ - "shape":"String", - "documentation":"

The natural-language threat statement.

" - }, - "severity":{ - "shape":"ThreatSeverity", - "documentation":"

The severity level of the threat.

" - }, - "status":{ - "shape":"ThreatStatus", - "documentation":"

The current status of the threat.

" - }, - "stride":{ - "shape":"StrideCategoryList", - "documentation":"

The STRIDE categories applicable to this threat.

" - }, - "createdBy":{ - "shape":"ThreatActor", - "documentation":"

Who created this threat.

" - }, - "updatedBy":{ - "shape":"ThreatActor", - "documentation":"

Who last updated this threat.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the threat was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the threat was last updated, in UTC format.

" - } - }, - "documentation":"

Contains summary information about a threat.

" - }, - "ThreatSummaryList":{ - "type":"list", - "member":{"shape":"ThreatSummary"}, - "documentation":"

List of threat summaries.

" - }, - "ThrottlingException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{ - "shape":"String", - "documentation":"

Error description.

" - }, - "serviceCode":{ - "shape":"String", - "documentation":"

Service code for throttling limit.

" - }, - "quotaCode":{ - "shape":"String", - "documentation":"

Quota code for throttling limit.

" - } - }, - "documentation":"

The request was denied due to request throttling.

", - "error":{ - "httpStatusCode":429, - "senderFault":true - }, - "exception":true - }, - "UntagResourceInput":{ - "type":"structure", - "required":[ - "resourceArn", - "tagKeys" - ], - "members":{ - "resourceArn":{ - "shape":"ResourceArn", - "documentation":"

The Amazon Resource Name (ARN) of the resource to remove tags from.

", - "location":"uri", - "locationName":"resourceArn" - }, - "tagKeys":{ - "shape":"TagKeyList", - "documentation":"

The list of tag keys to remove from the resource.

", - "location":"querystring", - "locationName":"tagKeys" - } - }, - "documentation":"

Input for UntagResource operation.

" - }, - "UntagResourceOutput":{ - "type":"structure", - "members":{}, - "documentation":"

Output for UntagResource operation.

" - }, - "UpdateAgentSpaceInput":{ - "type":"structure", - "required":["agentSpaceId"], - "members":{ - "agentSpaceId":{ - "shape":"AgentSpaceId", - "documentation":"

The unique identifier of the agent space to update.

" - }, - "name":{ - "shape":"AgentName", - "documentation":"

The updated name of the agent space.

" - }, - "description":{ - "shape":"String", - "documentation":"

The updated description of the agent space.

" - }, - "awsResources":{ - "shape":"AWSResources", - "documentation":"

The updated AWS resources to associate with the agent space.

" - }, - "targetDomainIds":{ - "shape":"TargetDomainIdList", - "documentation":"

The updated list of target domain identifiers to associate with the agent space.

" - }, - "codeReviewSettings":{ - "shape":"CodeReviewSettings", - "documentation":"

The updated code review settings for the agent space.

" - } - }, - "documentation":"

Input for updating an agent space.

" - }, - "UpdateAgentSpaceOutput":{ - "type":"structure", - "required":[ - "agentSpaceId", - "name" - ], - "members":{ - "agentSpaceId":{ - "shape":"AgentSpaceId", - "documentation":"

The unique identifier of the updated agent space.

" - }, - "name":{ - "shape":"AgentName", - "documentation":"

The name of the agent space.

" - }, - "description":{ - "shape":"String", - "documentation":"

The description of the agent space.

" - }, - "awsResources":{ - "shape":"AWSResources", - "documentation":"

The AWS resources associated with the agent space.

" - }, - "targetDomainIds":{ - "shape":"TargetDomainIdList", - "documentation":"

The list of target domain identifiers associated with the agent space.

" - }, - "codeReviewSettings":{ - "shape":"CodeReviewSettings", - "documentation":"

The code review settings for the agent space.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the agent space was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the agent space was last updated, in UTC format.

" - } - }, - "documentation":"

Output for the UpdateAgentSpace operation.

" - }, - "UpdateApplicationRequest":{ - "type":"structure", - "required":["applicationId"], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "documentation":"

The unique identifier of the application to update.

" - }, - "roleArn":{ - "shape":"RoleArn", - "documentation":"

The updated Amazon Resource Name (ARN) of the IAM role for the application.

" - }, - "defaultKmsKeyId":{ - "shape":"DefaultKmsKeyId", - "documentation":"

The updated identifier of the default AWS KMS key for the application.

" - } - } - }, - "UpdateApplicationResponse":{ - "type":"structure", - "required":["applicationId"], - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "documentation":"

The unique identifier of the updated application.

" - } - } - }, - "UpdateCodeReviewInput":{ - "type":"structure", - "required":[ - "codeReviewId", - "agentSpaceId" - ], - "members":{ - "codeReviewId":{ - "shape":"String", - "documentation":"

The unique identifier of the code review to update.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space that contains the code review.

" - }, - "title":{ - "shape":"String", - "documentation":"

The updated title of the code review.

" - }, - "assets":{ - "shape":"Assets", - "documentation":"

The updated assets for the code review.

" - }, - "serviceRole":{ - "shape":"ServiceRole", - "documentation":"

The updated IAM service role for the code review.

" - }, - "logConfig":{ - "shape":"CloudWatchLog", - "documentation":"

The updated CloudWatch Logs configuration for the code review.

" - }, - "codeRemediationStrategy":{ - "shape":"CodeRemediationStrategy", - "documentation":"

The updated code remediation strategy for the code review.

" - }, - "validationMode":{ - "shape":"ValidationMode", - "documentation":"

The updated validation mode for the code review. Valid values are SIMULATED and DISABLED.

" - } - }, - "documentation":"

Input for updating an existing code review.

" - }, - "UpdateCodeReviewOutput":{ - "type":"structure", - "required":["codeReviewId"], - "members":{ - "codeReviewId":{ - "shape":"String", - "documentation":"

The unique identifier of the code review.

" - }, - "title":{ - "shape":"String", - "documentation":"

The title of the code review.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the code review was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the code review was last updated, in UTC format.

" - }, - "assets":{ - "shape":"Assets", - "documentation":"

The assets included in the code review.

" - }, - "serviceRole":{ - "shape":"ServiceRole", - "documentation":"

The IAM service role used for the code review.

" - }, - "logConfig":{ - "shape":"CloudWatchLog", - "documentation":"

The CloudWatch Logs configuration for the code review.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space that contains the code review.

" - }, - "codeRemediationStrategy":{ - "shape":"CodeRemediationStrategy", - "documentation":"

The code remediation strategy for the code review.

" - }, - "validationMode":{ - "shape":"ValidationMode", - "documentation":"

The validation mode for the code review.

" - } - }, - "documentation":"

Output for the UpdateCodeReview operation.

" - }, - "UpdateFindingInput":{ - "type":"structure", - "required":[ - "findingId", - "agentSpaceId" - ], - "members":{ - "findingId":{ - "shape":"String", - "documentation":"

The unique identifier of the finding to update.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space that contains the finding.

" - }, - "name":{ - "shape":"String", - "documentation":"

The updated name for the finding.

" - }, - "description":{ - "shape":"String", - "documentation":"

The updated description for the finding.

" - }, - "riskType":{ - "shape":"String", - "documentation":"

The updated risk type for the finding.

" - }, - "riskLevel":{ - "shape":"RiskLevel", - "documentation":"

The updated risk level for the finding.

" - }, - "riskScore":{ - "shape":"String", - "documentation":"

The updated numerical risk score for the finding.

" - }, - "attackScript":{ - "shape":"String", - "documentation":"

The updated attack script for the finding.

" - }, - "reasoning":{ - "shape":"String", - "documentation":"

The updated reasoning for the finding.

" - }, - "status":{ - "shape":"FindingStatus", - "documentation":"

The updated status for the finding.

" - }, - "customerNote":{ - "shape":"String", - "documentation":"

A customer-provided note on the finding.

" - } - }, - "documentation":"

Input for updating an existing security finding.

" - }, - "UpdateFindingOutput":{ - "type":"structure", - "members":{}, - "documentation":"

Output for the UpdateFinding operation.

" - }, - "UpdateIntegratedResourcesInput":{ - "type":"structure", - "required":[ - "agentSpaceId", - "integrationId", - "items" - ], - "members":{ - "agentSpaceId":{ - "shape":"AgentSpaceId", - "documentation":"

The unique identifier of the agent space.

" - }, - "integrationId":{ - "shape":"IntegrationId", - "documentation":"

The unique identifier of the integration.

" - }, - "items":{ - "shape":"IntegratedResourceInputItemList", - "documentation":"

The list of integrated resource items to update.

" - } - } - }, - "UpdateIntegratedResourcesOutput":{ - "type":"structure", - "members":{} - }, - "UpdatePentestInput":{ - "type":"structure", - "required":[ - "pentestId", - "agentSpaceId" - ], - "members":{ - "pentestId":{ - "shape":"String", - "documentation":"

The unique identifier of the pentest to update.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space that contains the pentest.

" - }, - "title":{ - "shape":"String", - "documentation":"

The updated title of the pentest.

" - }, - "assets":{ - "shape":"Assets", - "documentation":"

The updated assets for the pentest.

" - }, - "excludeRiskTypes":{ - "shape":"RiskTypeList", - "documentation":"

The updated list of risk types to exclude from the pentest.

" - }, - "serviceRole":{ - "shape":"ServiceRole", - "documentation":"

The updated IAM service role for the pentest.

" - }, - "logConfig":{ - "shape":"CloudWatchLog", - "documentation":"

The updated CloudWatch Logs configuration for the pentest.

" - }, - "vpcConfig":{ - "shape":"VpcConfig", - "documentation":"

The updated VPC configuration for the pentest.

" - }, - "networkTrafficConfig":{ - "shape":"NetworkTrafficConfig", - "documentation":"

The updated network traffic configuration for the pentest.

" - }, - "codeRemediationStrategy":{ - "shape":"CodeRemediationStrategy", - "documentation":"

The updated code remediation strategy for the pentest.

" - }, - "disableManagedSkills":{ - "shape":"SkillTypeList", - "documentation":"

The updated list of managed skills to disable for this pentest. Valid values include FINDING_PERSONALIZATION and LOGIN_OPTIMIZATION.

" - } - }, - "documentation":"

Input for updating an existing pentest.

" - }, - "UpdatePentestOutput":{ - "type":"structure", - "members":{ - "pentestId":{ - "shape":"String", - "documentation":"

The unique identifier of the pentest.

" - }, - "title":{ - "shape":"String", - "documentation":"

The title of the pentest.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the pentest was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the pentest was last updated, in UTC format.

" - }, - "assets":{ - "shape":"Assets", - "documentation":"

The assets included in the pentest.

" - }, - "excludeRiskTypes":{ - "shape":"RiskTypeList", - "documentation":"

The list of risk types excluded from the pentest.

" - }, - "serviceRole":{ - "shape":"ServiceRole", - "documentation":"

The IAM service role used for the pentest.

" - }, - "logConfig":{ - "shape":"CloudWatchLog", - "documentation":"

The CloudWatch Logs configuration for the pentest.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space that contains the pentest.

" - } - }, - "documentation":"

Output for the UpdatePentest operation.

" - }, - "UpdatePrivateConnectionCertificateInput":{ - "type":"structure", - "required":[ - "privateConnectionName", - "certificate" - ], - "members":{ - "privateConnectionName":{ - "shape":"PrivateConnectionName", - "documentation":"

The name of the private connection to update.

" - }, - "certificate":{ - "shape":"CertificateChain", - "documentation":"

The PEM-encoded certificate chain for the private connection.

" - } - } - }, - "UpdatePrivateConnectionCertificateOutput":{ - "type":"structure", - "required":[ - "name", - "type", - "status" - ], - "members":{ - "name":{ - "shape":"PrivateConnectionName", - "documentation":"

The name of the private connection.

" - }, - "type":{ - "shape":"PrivateConnectionType", - "documentation":"

The type of the private connection, indicating whether it is service-managed or self-managed.

" - }, - "status":{ - "shape":"PrivateConnectionStatus", - "documentation":"

The current status of the private connection.

" - }, - "resourceGatewayId":{ - "shape":"ResourceGatewayId", - "documentation":"

The identifier or ARN of the VPC Lattice resource gateway.

" - }, - "hostAddress":{ - "shape":"HostAddress", - "documentation":"

The IP address or DNS name of the target resource.

" - }, - "vpcId":{ - "shape":"PrivateConnectionVpcId", - "documentation":"

The identifier of the VPC the resource gateway is created in.

" - }, - "resourceConfigurationId":{ - "shape":"ResourceConfigurationId", - "documentation":"

The identifier or ARN of the VPC Lattice resource configuration.

" - }, - "certificateExpiryTime":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the connection's certificate expires, in UTC format.

" - }, - "dnsResolution":{ - "shape":"ResourceConfigDnsResolution", - "documentation":"

The DNS resolution mode for the resource gateway.

" - }, - "failureMessage":{ - "shape":"String", - "documentation":"

A message describing why the private connection entered a failed state, if applicable.

" - }, - "tags":{ - "shape":"TagMap", - "documentation":"

The tags attached to the private connection.

" - } - } - }, - "UpdateSecurityRequirementEntry":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{ - "shape":"SecurityRequirementName", - "documentation":"

The name of the security requirement to update. This is an immutable identifier and cannot be changed once the requirement is created.

" - }, - "description":{ - "shape":"String", - "documentation":"

The updated description of the security requirement.

" - }, - "domain":{ - "shape":"String", - "documentation":"

The updated security domain the requirement belongs to.

" - }, - "evaluation":{ - "shape":"String", - "documentation":"

The updated evaluation criteria used to assess compliance with this requirement.

" - }, - "remediation":{ - "shape":"String", - "documentation":"

The updated remediation steps when the requirement is not met.

" - } - }, - "documentation":"

Contains the details for updating an existing security requirement within a pack. The name is an immutable identifier used to locate the requirement and cannot be modified.

" - }, - "UpdateSecurityRequirementEntryList":{ - "type":"list", - "member":{"shape":"UpdateSecurityRequirementEntry"}, - "documentation":"

List of security requirement updates to apply.

" - }, - "UpdateSecurityRequirementPackInput":{ - "type":"structure", - "required":["packId"], - "members":{ - "packId":{ - "shape":"SecurityRequirementPackId", - "documentation":"

The unique identifier of the security requirement pack to update.

" - }, - "name":{ - "shape":"SecurityRequirementPackName", - "documentation":"

The updated name of the security requirement pack.

" - }, - "description":{ - "shape":"String", - "documentation":"

The updated description of the security requirement pack.

" - }, - "status":{ - "shape":"SecurityRequirementPackStatus", - "documentation":"

The updated status of the security requirement pack.

" - } - } - }, - "UpdateSecurityRequirementPackOutput":{ - "type":"structure", - "required":["packId"], - "members":{ - "packId":{ - "shape":"SecurityRequirementPackId", - "documentation":"

The unique identifier of the security requirement pack.

" - }, - "name":{ - "shape":"SecurityRequirementPackName", - "documentation":"

The name of the security requirement pack.

" - }, - "description":{ - "shape":"String", - "documentation":"

The description of the security requirement pack.

" - }, - "status":{ - "shape":"SecurityRequirementPackStatus", - "documentation":"

The status of the security requirement pack.

" - } - } - }, - "UpdateTargetDomainInput":{ - "type":"structure", - "required":[ - "targetDomainId", - "verificationMethod" - ], - "members":{ - "targetDomainId":{ - "shape":"TargetDomainId", - "documentation":"

The unique identifier of the target domain to update.

" - }, - "verificationMethod":{ - "shape":"DomainVerificationMethod", - "documentation":"

The updated verification method for the target domain.

" - } - }, - "documentation":"

Input for updating a target domain.

" - }, - "UpdateTargetDomainOutput":{ - "type":"structure", - "required":[ - "targetDomainId", - "domainName", - "verificationStatus" - ], - "members":{ - "targetDomainId":{ - "shape":"TargetDomainId", - "documentation":"

The unique identifier of the target domain.

" - }, - "domainName":{ - "shape":"String", - "documentation":"

The domain name of the target domain.

" - }, - "verificationStatus":{ - "shape":"TargetDomainStatus", - "documentation":"

The current verification status of the target domain.

" - }, - "verificationStatusReason":{ - "shape":"String", - "documentation":"

The reason for the current target domain verification status.

" - }, - "verificationDetails":{ - "shape":"VerificationDetails", - "documentation":"

The updated verification details for the target domain.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the target domain was created, in UTC format.

" - }, - "verifiedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the target domain was verified, in UTC format.

" - } - }, - "documentation":"

Output for the UpdateTargetDomain operation.

" - }, - "UpdateThreatInput":{ - "type":"structure", - "required":[ - "threatId", - "agentSpaceId" - ], - "members":{ - "threatId":{ - "shape":"String", - "documentation":"

The unique identifier of the threat to update.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space.

" - }, - "title":{ - "shape":"String", - "documentation":"

A short title summarizing the threat.

" - }, - "status":{ - "shape":"ThreatStatus", - "documentation":"

The updated status of the threat.

" - }, - "comments":{ - "shape":"String", - "documentation":"

Optional customer comment.

" - }, - "statement":{ - "shape":"String", - "documentation":"

The updated natural-language threat statement.

" - }, - "severity":{ - "shape":"ThreatSeverity", - "documentation":"

The updated severity level of the threat.

" - }, - "threatSource":{ - "shape":"String", - "documentation":"

The updated actor or origin of the threat.

" - }, - "prerequisites":{ - "shape":"String", - "documentation":"

The updated conditions required for the threat to be exploitable.

" - }, - "threatAction":{ - "shape":"String", - "documentation":"

The updated description of what the threat source can do.

" - }, - "threatImpact":{ - "shape":"String", - "documentation":"

The updated direct consequence of the threat action.

" - }, - "impactedGoal":{ - "shape":"StringList", - "documentation":"

The updated security goals affected by the threat.

" - }, - "impactedAssets":{ - "shape":"StringList", - "documentation":"

The updated list of specific assets affected by the threat.

" - }, - "anchor":{ - "shape":"ThreatAnchorShape", - "documentation":"

The updated DFD element this threat is anchored to.

" - }, - "evidence":{ - "shape":"ThreatEvidenceList", - "documentation":"

The updated source code files supporting the threat.

" - }, - "recommendation":{ - "shape":"String", - "documentation":"

The updated recommended mitigation guidance for this threat.

" - } - }, - "documentation":"

Input for updating an existing threat.

" - }, - "UpdateThreatModelInput":{ - "type":"structure", - "required":[ - "threatModelId", - "agentSpaceId" - ], - "members":{ - "threatModelId":{ - "shape":"String", - "documentation":"

The unique identifier of the threat model to update.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space that contains the threat model.

" - }, - "title":{ - "shape":"String", - "documentation":"

The updated title of the threat model.

" - }, - "description":{ - "shape":"String", - "documentation":"

The updated description of the application or system being threat modeled.

" - }, - "assets":{ - "shape":"Assets", - "documentation":"

The updated assets for the threat model.

" - }, - "scopeDocs":{ - "shape":"DocumentList", - "documentation":"

The updated scoped documents for the agent to focus on during threat modeling.

" - }, - "serviceRole":{ - "shape":"ServiceRole", - "documentation":"

The updated IAM service role for the threat model.

" - }, - "logConfig":{ - "shape":"CloudWatchLog", - "documentation":"

The updated CloudWatch Logs configuration for the threat model.

" - } - }, - "documentation":"

Input for updating an existing threat model.

" - }, - "UpdateThreatModelOutput":{ - "type":"structure", - "required":["threatModelId"], - "members":{ - "threatModelId":{ - "shape":"String", - "documentation":"

The unique identifier of the threat model.

" - }, - "title":{ - "shape":"String", - "documentation":"

The title of the threat model.

" - }, - "agentSpaceId":{ - "shape":"String", - "documentation":"

The unique identifier of the agent space that contains the threat model.

" - }, - "description":{ - "shape":"String", - "documentation":"

A description of the application or system being threat modeled.

" - }, - "assets":{ - "shape":"Assets", - "documentation":"

The assets included in the threat model.

" - }, - "scopeDocs":{ - "shape":"DocumentList", - "documentation":"

The scoped documents for the agent to focus on during threat modeling.

" - }, - "serviceRole":{ - "shape":"ServiceRole", - "documentation":"

The IAM service role used for the threat model.

" - }, - "logConfig":{ - "shape":"CloudWatchLog", - "documentation":"

The CloudWatch Logs configuration for the threat model.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the threat model was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the threat model was last updated, in UTC format.

" - } - }, - "documentation":"

Output for the UpdateThreatModel operation.

" - }, - "UpdateThreatOutput":{ - "type":"structure", - "required":[ - "threatId", - "threatJobId" - ], - "members":{ - "threatId":{ - "shape":"String", - "documentation":"

The unique identifier of the threat.

" - }, - "threatJobId":{ - "shape":"String", - "documentation":"

The unique identifier of the threat model job the threat belongs to.

" - }, - "title":{ - "shape":"String", - "documentation":"

A short title summarizing the threat.

" - }, - "statement":{ - "shape":"String", - "documentation":"

The natural-language threat statement.

" - }, - "severity":{ - "shape":"ThreatSeverity", - "documentation":"

The severity level of the threat.

" - }, - "status":{ - "shape":"ThreatStatus", - "documentation":"

The current status of the threat.

" - }, - "comments":{ - "shape":"String", - "documentation":"

Optional customer comment on the threat.

" - }, - "stride":{ - "shape":"StrideCategoryList", - "documentation":"

The STRIDE categories applicable to this threat.

" - }, - "threatSource":{ - "shape":"String", - "documentation":"

The actor or origin of the threat.

" - }, - "prerequisites":{ - "shape":"String", - "documentation":"

The conditions required for the threat to be exploitable.

" - }, - "threatAction":{ - "shape":"String", - "documentation":"

What the threat source can do.

" - }, - "threatImpact":{ - "shape":"String", - "documentation":"

The direct consequence of the threat action.

" - }, - "impactedGoal":{ - "shape":"StringList", - "documentation":"

The security goals affected by the threat.

" - }, - "impactedAssets":{ - "shape":"StringList", - "documentation":"

The specific assets affected by the threat.

" - }, - "anchor":{ - "shape":"ThreatAnchorShape", - "documentation":"

The DFD element this threat is anchored to.

" - }, - "evidence":{ - "shape":"ThreatEvidenceList", - "documentation":"

The source code files supporting the threat.

" - }, - "recommendation":{ - "shape":"String", - "documentation":"

The recommended mitigation guidance for this threat.

" - }, - "createdBy":{ - "shape":"ThreatActor", - "documentation":"

Who created this threat.

" - }, - "updatedBy":{ - "shape":"ThreatActor", - "documentation":"

Who last updated this threat.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the threat was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the threat was last updated, in UTC format.

" - } - }, - "documentation":"

Output for the UpdateThreat operation.

" - }, - "UriList":{ - "type":"list", - "member":{"shape":"String"} - }, - "UserConfig":{ - "type":"structure", - "members":{ - "role":{ - "shape":"UserRole", - "documentation":"

The role assigned to the user. Currently, only MEMBER is supported.

" - } - }, - "documentation":"

The configuration for a user membership, including the role assigned to the user within the agent space.

" - }, - "UserMetadata":{ - "type":"structure", - "required":[ - "username", - "email" - ], - "members":{ - "username":{ - "shape":"String", - "documentation":"

The username of the user.

" - }, - "email":{ - "shape":"SensitiveEmail", - "documentation":"

The email address of the user.

" - } - }, - "documentation":"

Contains metadata about a user member, including the username and email address.

" - }, - "UserRole":{ - "type":"string", - "documentation":"

Role of a user member associated to an agent space.

", - "enum":["MEMBER"] - }, - "ValidationException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{ - "shape":"String", - "documentation":"

A summary of the validation failure.

" - }, - "fieldList":{ - "shape":"ValidationExceptionFieldList", - "documentation":"

A list of specific failures encountered during validation.

" - } - }, - "documentation":"

The input fails to satisfy the constraints specified by the service.

", - "exception":true - }, - "ValidationExceptionField":{ - "type":"structure", - "required":[ - "path", - "message" - ], - "members":{ - "path":{ - "shape":"String", - "documentation":"

A JSONPointer expression to the structure member whose value failed to satisfy the modeled constraint.

" - }, - "message":{ - "shape":"String", - "documentation":"

A detailed description of the validation failure.

" - } - }, - "documentation":"

Describes one specific validation failure for an input member.

" - }, - "ValidationExceptionFieldList":{ - "type":"list", - "member":{"shape":"ValidationExceptionField"} - }, - "ValidationMode":{ - "type":"string", - "documentation":"

Mode of validation to perform on findings

", - "enum":[ - "DISABLED", - "SIMULATED" - ] - }, - "ValidationStatus":{ - "type":"string", - "documentation":"

Per-finding sandbox validation status

", - "enum":[ - "CONFIRMED", - "NOT_REPRODUCED", - "VALIDATION_FAILED", - "VALIDATING", - "NOT_VALIDATED" - ] - }, - "VerificationDetails":{ - "type":"structure", - "members":{ - "method":{ - "shape":"DomainVerificationMethod", - "documentation":"

The verification method used for the target domain.

" - }, - "dnsTxt":{ - "shape":"DnsVerification", - "documentation":"

The DNS TXT verification details.

" - }, - "httpRoute":{ - "shape":"HttpVerification", - "documentation":"

The HTTP route verification details.

" - } - }, - "documentation":"

Contains the verification details for a target domain, including the verification method and provider-specific details.

" - }, - "VerificationScript":{ - "type":"structure", - "members":{ - "scriptType":{ - "shape":"String", - "documentation":"

The type of script. Valid values are python and bash.

" - }, - "scriptUrl":{ - "shape":"String", - "documentation":"

URL to download the verification script.

" - }, - "instructions":{ - "shape":"String", - "documentation":"

Instructions for running the verification script, including prerequisites and how to interpret results.

" - }, - "envVars":{ - "shape":"VerificationScriptEnvVarList", - "documentation":"

The list of environment variables required to run the verification script.

" - } - }, - "documentation":"

Contains metadata for a verification script that can be used to reproduce a security finding.

" - }, - "VerificationScriptEnvVar":{ - "type":"structure", - "members":{ - "name":{ - "shape":"String", - "documentation":"

The name of the environment variable.

" - }, - "value":{ - "shape":"String", - "documentation":"

The value of the environment variable.

" - } - }, - "documentation":"

Represents an environment variable required to run a verification script.

" - }, - "VerificationScriptEnvVarList":{ - "type":"list", - "member":{"shape":"VerificationScriptEnvVar"}, - "documentation":"

List of environment variables required to run a verification script.

" - }, - "VerifyTargetDomainInput":{ - "type":"structure", - "required":["targetDomainId"], - "members":{ - "targetDomainId":{ - "shape":"TargetDomainId", - "documentation":"

The unique identifier of the target domain to verify.

" - } - }, - "documentation":"

Input for verifying ownership for a registered target domain in an agent space.

" - }, - "VerifyTargetDomainOutput":{ - "type":"structure", - "members":{ - "targetDomainId":{ - "shape":"TargetDomainId", - "documentation":"

The unique identifier of the target domain.

" - }, - "domainName":{ - "shape":"String", - "documentation":"

The domain name of the target domain.

" - }, - "createdAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the target domain was created, in UTC format.

" - }, - "updatedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the target domain was last updated, in UTC format.

" - }, - "verifiedAt":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"

The date and time the target domain was verified, in UTC format.

" - }, - "status":{ - "shape":"TargetDomainStatus", - "documentation":"

The verification status of the target domain.

" - }, - "verificationStatusReason":{ - "shape":"String", - "documentation":"

The reason for the current target domain verification status.

" - } - }, - "documentation":"

Output for verifying ownership for a registered target domain in an agent space.

" - }, - "VpcArn":{ - "type":"string", - "documentation":"

ARN or ID of a VPC.

" - }, - "VpcConfig":{ - "type":"structure", - "members":{ - "vpcArn":{ - "shape":"VpcArn", - "documentation":"

The Amazon Resource Name (ARN) of the VPC.

" - }, - "securityGroupArns":{ - "shape":"SecurityGroupArns", - "documentation":"

The Amazon Resource Names (ARNs) of the security groups for the VPC configuration.

" - }, - "subnetArns":{ - "shape":"SubnetArns", - "documentation":"

The Amazon Resource Names (ARNs) of the subnets for the VPC configuration.

" - } - }, - "documentation":"

The VPC configuration for a pentest, specifying the VPC, security groups, and subnets to use during testing.

" - }, - "VpcConfigs":{ - "type":"list", - "member":{"shape":"VpcConfig"} - } - }, - "documentation":"

AWS Security Agent is a frontier agent that proactively secures your applications throughout the development lifecycle. It conducts automated security reviews tailored to your organizational requirements and delivers context-aware penetration testing on demand. By continuously validating security from design to deployment, AWS Security Agent helps prevent vulnerabilities early across all your environments. Key capabilities include design security review for architecture documents, code security review for pull requests in connected repositories, and on-demand penetration testing that discovers, validates, and remediates security vulnerabilities through tailored multi-step attack scenarios. For more information, see the AWS Security Agent User Guide.

" -} diff --git a/tools/code-generation/api-descriptions/securityagent/2025-09-06/smoke-2.json b/tools/code-generation/api-descriptions/securityagent/2025-09-06/smoke-2.json deleted file mode 100644 index ba19b6679238..000000000000 --- a/tools/code-generation/api-descriptions/securityagent/2025-09-06/smoke-2.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "version" : 2, - "testCases" : [ { - "id" : "ListAgentSpacesSuccess", - "operationName" : "ListAgentSpaces", - "input" : { }, - "expectation" : { - "success" : { } - }, - "config" : { - "region" : "us-east-1", - "useFips" : false, - "useDualstack" : false, - "useAccountIdRouting" : true - } - } ] -} \ No newline at end of file diff --git a/tools/code-generation/api-descriptions/securityagent/2025-09-06/smoke.json b/tools/code-generation/api-descriptions/securityagent/2025-09-06/smoke.json deleted file mode 100644 index 6c5018017905..000000000000 --- a/tools/code-generation/api-descriptions/securityagent/2025-09-06/smoke.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "version": 1, - "defaultRegion": "us-east-1", - "testCases": [ - ] -} diff --git a/tools/code-generation/api-descriptions/securityagent/2025-09-06/waiters-2.json b/tools/code-generation/api-descriptions/securityagent/2025-09-06/waiters-2.json deleted file mode 100644 index 13f60ee66be6..000000000000 --- a/tools/code-generation/api-descriptions/securityagent/2025-09-06/waiters-2.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "version": 2, - "waiters": { - } -} diff --git a/tools/code-generation/api-descriptions/pricing-plan-manager/2025-08-05/endpoint-rule-set-1.json b/tools/code-generation/endpoints/pricing-plan-manager-2025-08-05.endpoint-rule-set.json similarity index 100% rename from tools/code-generation/api-descriptions/pricing-plan-manager/2025-08-05/endpoint-rule-set-1.json rename to tools/code-generation/endpoints/pricing-plan-manager-2025-08-05.endpoint-rule-set.json diff --git a/tools/code-generation/api-descriptions/pricing-plan-manager/2025-08-05/endpoint-tests-1.json b/tools/code-generation/endpoints/pricing-plan-manager-2025-08-05.endpoint-tests.json similarity index 100% rename from tools/code-generation/api-descriptions/pricing-plan-manager/2025-08-05/endpoint-tests-1.json rename to tools/code-generation/endpoints/pricing-plan-manager-2025-08-05.endpoint-tests.json